# mulesoft DataWeave - Full Documentation

<!-- document id=35556395aecc2b962d999b3c1b9597c1bb48ce0640435092c527af734a93db2e url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-minusminus.md -->

---
product: DataWeave
version: 2.11
---

# \--

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## \--<S>(source: Array<S>, toRemove: Array<Any>): Array<S>

Removes specified values from an input value.

This version of `--` removes all instances of the specified items from an array. Other versions act
on objects, strings, and the various date and time formats that are supported by DataWeave.

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>source</p></td><td><p>The array containing items to remove.</p></td></tr><tr><td><p>toRemove</p></td><td><p>Items to remove from the source array.</p></td></tr></tbody></table>

### Example

This example removes specified items from an array. Specifically, it removes all instances of the
items listed in the array on the right side of `--` from the array on the left side of the function,
leaving `[0]` as the result.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "a" : [0, 1, 1, 2] -- [1,2] }
```

#### Output

```JSON
{ "a": [0] }
```

## \--<K, V>(source: { (K)?: V }, toRemove: Object): { (K)?: V }

Removes specified key-value pairs from an object.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The source object (an <code>Object</code> type).</p></td></tr><tr><td><p><code>toRemove</code></p></td><td><p>Object that contains the key-value pairs to remove from the source object.</p></td></tr></tbody></table>

### Example

This example removes a key-value pair from the source object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "hello" : "world", "name" : "DW" } -- { "hello" : "world"}
```

#### Output

```JSON
{ "name": "DW" }
```

## \--(source: Object, keys: Array<String>)

Removes all key-value pairs from the source object that match the specified search key.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The source object (an <code>Object</code> type).</p></td></tr><tr><td><p><code>toRemove</code></p></td><td><p>An array of keys to specify the key-value pairs to remove from the source object.</p></td></tr></tbody></table>

### Example

This example removes two key-value pairs from the source object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "yes" : "no", "good" : "bad", "old" : "new" } -- ["yes", "old"]
```

#### Output

```JSON
{ "good": "bad" }
```

## \--(source: Object, keys: Array<Key>)

Removes specified key-value pairs from an object.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The source object (an <code>Object</code> type).</p></td></tr><tr><td><p><code>keys</code></p></td><td><p>A keys for the key-value pairs to remove from the source object.</p></td></tr></tbody></table>

### Example

This example specifies the key-value pair to remove from the source object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "hello" : "world", "name" : "DW" } -- ["hello" as Key]
```

#### Output

```JSON
{ "name": "DW" }
```

## \--(source: Null, keys: Any)

Helper function that enables `--` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=d62c99b3bb0b870a0abd61d3f901379ba646c807491f780e21a78870cef7e63c url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-minusminus.md -->

---
product: DataWeave
version: 2.12
---

# \--

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## \--<S>(source: Array<S>, toRemove: Array<Any>): Array<S>

Removes specified values from an input value.

This version of `--` removes all instances of the specified items from an array. Other versions act
on objects, strings, and the various date and time formats that are supported by DataWeave.

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>source</p></td><td><p>The array containing items to remove.</p></td></tr><tr><td><p>toRemove</p></td><td><p>Items to remove from the source array.</p></td></tr></tbody></table>

### Example

This example removes specified items from an array. Specifically, it removes all instances of the
items listed in the array on the right side of `--` from the array on the left side of the function,
leaving `[0]` as the result.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "a" : [0, 1, 1, 2] -- [1,2] }
```

#### Output

```JSON
{ "a": [0] }
```

## \--<K, V>(source: { (K)?: V }, toRemove: Object): { (K)?: V }

Removes specified key-value pairs from an object.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The source object (an <code>Object</code> type).</p></td></tr><tr><td><p><code>toRemove</code></p></td><td><p>Object that contains the key-value pairs to remove from the source object.</p></td></tr></tbody></table>

### Example

This example removes a key-value pair from the source object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "hello" : "world", "name" : "DW" } -- { "hello" : "world"}
```

#### Output

```JSON
{ "name": "DW" }
```

## \--(source: Object, keys: Array<String>)

Removes all key-value pairs from the source object that match the specified search key.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The source object (an <code>Object</code> type).</p></td></tr><tr><td><p><code>toRemove</code></p></td><td><p>An array of keys to specify the key-value pairs to remove from the source object.</p></td></tr></tbody></table>

### Example

This example removes two key-value pairs from the source object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "yes" : "no", "good" : "bad", "old" : "new" } -- ["yes", "old"]
```

#### Output

```JSON
{ "good": "bad" }
```

## \--(source: Object, keys: Array<Key>)

Removes specified key-value pairs from an object.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The source object (an <code>Object</code> type).</p></td></tr><tr><td><p><code>keys</code></p></td><td><p>A keys for the key-value pairs to remove from the source object.</p></td></tr></tbody></table>

### Example

This example specifies the key-value pair to remove from the source object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "hello" : "world", "name" : "DW" } -- ["hello" as Key]
```

#### Output

```JSON
{ "name": "DW" }
```

## \--(source: Null, keys: Any)

Helper function that enables `--` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=a50f92a677f6e2e5f76f9c0d088d902ced0136d5ce8019d41712e53cc48af1a5 url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-minusminus.md -->

---
product: DataWeave
version: 2.3
---

# \--

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## \--(Array<S>, Array<Any>): Array<S>

Removes specified values from an input value.

This version of `--` removes all instances of the specified items from an array. Other versions act
on objects, strings, and the various date and time formats that are supported by DataWeave.

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Name</p></td><td><p>Description</p></td></tr><tr><td><p><code>source</code></p></td><td><p>The array containing items to remove.</p></td></tr><tr><td><p><code>toRemove</code></p></td><td><p>Items to remove from the source array.</p></td></tr></tbody></table>

### Example

This example removes specified items from an array. Specifically, it removes all instances of the
items listed in the array on the right side of `--` from the array on the left side of the function,
leaving `[0]` as the result.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "a" : [0, 1, 1, 2] -- [1,2] }
```

#### Output

```JSON
{ "a": [0] }
```

## \--({ (K)?: V }, Object): { (K)?: V }

Removes specified key-value pairs from an object.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The source object (an <code>Object</code> type).</p></td></tr><tr><td><p><code>toRemove</code></p></td><td><p>Object that contains the key-value pairs to remove from the source object.</p></td></tr></tbody></table>

### Example

This example removes a key-value pair from the source object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "hello" : "world", "name" : "DW" } -- { "hello" : "world"}
```

#### Output

```JSON
{ "name": "DW" }
```

## \--(Object, Array<String>)

Removes all key-value pairs from the source object that match the specified search key.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The source object (an <code>Object</code> type).</p></td></tr><tr><td><p><code>toRemove</code></p></td><td><p>An array of keys to specify the key-value pairs to remove from the source object.</p></td></tr></tbody></table>

### Example

This example removes two key-value pairs from the source object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "yes" : "no", "good" : "bad", "old" : "new" } -- ["yes", "old"]
```

#### Output

```JSON
{ "good": "bad" }
```

## \--(Object, Array<Key>)

Removes specified key-value pairs from an object.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The source object (an <code>Object</code> type).</p></td></tr><tr><td><p><code>keys</code></p></td><td><p>A keys for the key-value pairs to remove from the source object.</p></td></tr></tbody></table>

### Example

This example specifies the key-value pair to remove from the source object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "hello" : "world", "name" : "DW" } -- ["hello" as Key]
```

#### Output

```JSON
{ "name": "DW" }
```

<!-- document id=1b220cd1641322d4d4075f3a6e202707fe3d333be1d41bf359bab8dfe676eedb url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-minusminus.md -->

---
product: DataWeave
version: 2.4
---

# \--

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## \--<S>(source: Array<S>, toRemove: Array<Any>): Array<S>

Removes specified values from an input value.

This version of `--` removes all instances of the specified items from an array. Other versions act
on objects, strings, and the various date and time formats that are supported by DataWeave.

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The array containing items to remove.</p></td></tr><tr><td><p><code>toRemove</code></p></td><td><p>Items to remove from the source array.</p></td></tr></tbody></table>

### Example

This example removes specified items from an array. Specifically, it removes all instances of the
items listed in the array on the right side of `--` from the array on the left side of the function,
leaving `[0]` as the result.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "a" : [0, 1, 1, 2] -- [1,2] }
```

#### Output

```JSON
{ "a": [0] }
```

## \--<K, V>(source: { (K)?: V }, toRemove: Object): { (K)?: V }

Removes specified key-value pairs from an object.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The source object (an <code>Object</code> type).</p></td></tr><tr><td><p><code>toRemove</code></p></td><td><p>Object that contains the key-value pairs to remove from the source object.</p></td></tr></tbody></table>

### Example

This example removes a key-value pair from the source object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "hello" : "world", "name" : "DW" } -- { "hello" : "world"}
```

#### Output

```JSON
{ "name": "DW" }
```

## \--(source: Object, keys: Array<String>)

Removes all key-value pairs from the source object that match the specified search key.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The source object (an <code>Object</code> type).</p></td></tr><tr><td><p><code>toRemove</code></p></td><td><p>An array of keys to specify the key-value pairs to remove from the source object.</p></td></tr></tbody></table>

### Example

This example removes two key-value pairs from the source object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "yes" : "no", "good" : "bad", "old" : "new" } -- ["yes", "old"]
```

#### Output

```JSON
{ "good": "bad" }
```

## \--(source: Object, keys: Array<Key>)

Removes specified key-value pairs from an object.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The source object (an <code>Object</code> type).</p></td></tr><tr><td><p><code>keys</code></p></td><td><p>A keys for the key-value pairs to remove from the source object.</p></td></tr></tbody></table>

### Example

This example specifies the key-value pair to remove from the source object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "hello" : "world", "name" : "DW" } -- ["hello" as Key]
```

#### Output

```JSON
{ "name": "DW" }
```

## \--(source: Null, keys: Any)

Helper function that enables `--` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=b0ca10d46a89dd1b9bb7eb777150d2901742a3d04263ccdc2b96d10cb9c22a61 url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-minusminus.md -->

---
product: DataWeave
version: 2.6
---

# \--

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## \--<S>(source: Array<S>, toRemove: Array<Any>): Array<S>

Removes specified values from an input value.

This version of `--` removes all instances of the specified items from an array. Other versions act
on objects, strings, and the various date and time formats that are supported by DataWeave.

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>source</p></td><td><p>The array containing items to remove.</p></td></tr><tr><td><p>toRemove</p></td><td><p>Items to remove from the source array.</p></td></tr></tbody></table>

### Example

This example removes specified items from an array. Specifically, it removes all instances of the
items listed in the array on the right side of `--` from the array on the left side of the function,
leaving `[0]` as the result.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "a" : [0, 1, 1, 2] -- [1,2] }
```

#### Output

```JSON
{ "a": [0] }
```

## \--<K, V>(source: { (K)?: V }, toRemove: Object): { (K)?: V }

Removes specified key-value pairs from an object.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The source object (an <code>Object</code> type).</p></td></tr><tr><td><p><code>toRemove</code></p></td><td><p>Object that contains the key-value pairs to remove from the source object.</p></td></tr></tbody></table>

### Example

This example removes a key-value pair from the source object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "hello" : "world", "name" : "DW" } -- { "hello" : "world"}
```

#### Output

```JSON
{ "name": "DW" }
```

## \--(source: Object, keys: Array<String>)

Removes all key-value pairs from the source object that match the specified search key.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The source object (an <code>Object</code> type).</p></td></tr><tr><td><p><code>toRemove</code></p></td><td><p>An array of keys to specify the key-value pairs to remove from the source object.</p></td></tr></tbody></table>

### Example

This example removes two key-value pairs from the source object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "yes" : "no", "good" : "bad", "old" : "new" } -- ["yes", "old"]
```

#### Output

```JSON
{ "good": "bad" }
```

## \--(source: Object, keys: Array<Key>)

Removes specified key-value pairs from an object.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The source object (an <code>Object</code> type).</p></td></tr><tr><td><p><code>keys</code></p></td><td><p>A keys for the key-value pairs to remove from the source object.</p></td></tr></tbody></table>

### Example

This example specifies the key-value pair to remove from the source object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "hello" : "world", "name" : "DW" } -- ["hello" as Key]
```

#### Output

```JSON
{ "name": "DW" }
```

## \--(source: Null, keys: Any)

Helper function that enables `--` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=5ed303fb46be3bc0044cab73cc1e86713dfff1cb81bbf0c9ed5ff6c80999cf7c url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-minusminus.md -->

---
product: DataWeave
version: 2.9
---

# \--

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## \--<S>(source: Array<S>, toRemove: Array<Any>): Array<S>

Removes specified values from an input value.

This version of `--` removes all instances of the specified items from an array. Other versions act
on objects, strings, and the various date and time formats that are supported by DataWeave.

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>source</p></td><td><p>The array containing items to remove.</p></td></tr><tr><td><p>toRemove</p></td><td><p>Items to remove from the source array.</p></td></tr></tbody></table>

### Example

This example removes specified items from an array. Specifically, it removes all instances of the
items listed in the array on the right side of `--` from the array on the left side of the function,
leaving `[0]` as the result.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "a" : [0, 1, 1, 2] -- [1,2] }
```

#### Output

```JSON
{ "a": [0] }
```

## \--<K, V>(source: { (K)?: V }, toRemove: Object): { (K)?: V }

Removes specified key-value pairs from an object.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The source object (an <code>Object</code> type).</p></td></tr><tr><td><p><code>toRemove</code></p></td><td><p>Object that contains the key-value pairs to remove from the source object.</p></td></tr></tbody></table>

### Example

This example removes a key-value pair from the source object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "hello" : "world", "name" : "DW" } -- { "hello" : "world"}
```

#### Output

```JSON
{ "name": "DW" }
```

## \--(source: Object, keys: Array<String>)

Removes all key-value pairs from the source object that match the specified search key.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The source object (an <code>Object</code> type).</p></td></tr><tr><td><p><code>toRemove</code></p></td><td><p>An array of keys to specify the key-value pairs to remove from the source object.</p></td></tr></tbody></table>

### Example

This example removes two key-value pairs from the source object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "yes" : "no", "good" : "bad", "old" : "new" } -- ["yes", "old"]
```

#### Output

```JSON
{ "good": "bad" }
```

## \--(source: Object, keys: Array<Key>)

Removes specified key-value pairs from an object.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The source object (an <code>Object</code> type).</p></td></tr><tr><td><p><code>keys</code></p></td><td><p>A keys for the key-value pairs to remove from the source object.</p></td></tr></tbody></table>

### Example

This example specifies the key-value pair to remove from the source object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "hello" : "world", "name" : "DW" } -- ["hello" as Key]
```

#### Output

```JSON
{ "name": "DW" }
```

## \--(source: Null, keys: Any)

Helper function that enables `--` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=357202788679a55480d28d79907b441bac3f77f653121402abbc8b05c1b03035 url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-minusminus.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# \--

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## \--<S>(source: Array<S>, toRemove: Array<Any>): Array<S>

Removes specified values from an input value.

This version of `--` removes all instances of the specified items from an array. Other versions act
on objects, strings, and the various date and time formats that are supported by DataWeave.

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>source</p></td><td><p>The array containing items to remove.</p></td></tr><tr><td><p>toRemove</p></td><td><p>Items to remove from the source array.</p></td></tr></tbody></table>

### Example

This example removes specified items from an array. Specifically, it removes all instances of the
items listed in the array on the right side of `--` from the array on the left side of the function,
leaving `[0]` as the result.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "a" : [0, 1, 1, 2] -- [1,2] }
```

#### Output

```JSON
{ "a": [0] }
```

## \--<K, V>(source: { (K)?: V }, toRemove: Object): { (K)?: V }

Removes specified key-value pairs from an object.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The source object (an <code>Object</code> type).</p></td></tr><tr><td><p><code>toRemove</code></p></td><td><p>Object that contains the key-value pairs to remove from the source object.</p></td></tr></tbody></table>

### Example

This example removes a key-value pair from the source object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "hello" : "world", "name" : "DW" } -- { "hello" : "world"}
```

#### Output

```JSON
{ "name": "DW" }
```

## \--(source: Object, keys: Array<String>)

Removes all key-value pairs from the source object that match the specified search key.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The source object (an <code>Object</code> type).</p></td></tr><tr><td><p><code>toRemove</code></p></td><td><p>An array of keys to specify the key-value pairs to remove from the source object.</p></td></tr></tbody></table>

### Example

This example removes two key-value pairs from the source object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "yes" : "no", "good" : "bad", "old" : "new" } -- ["yes", "old"]
```

#### Output

```JSON
{ "good": "bad" }
```

## \--(source: Object, keys: Array<Key>)

Removes specified key-value pairs from an object.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The source object (an <code>Object</code> type).</p></td></tr><tr><td><p><code>keys</code></p></td><td><p>A keys for the key-value pairs to remove from the source object.</p></td></tr></tbody></table>

### Example

This example specifies the key-value pair to remove from the source object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "hello" : "world", "name" : "DW" } -- ["hello" as Key]
```

#### Output

```JSON
{ "name": "DW" }
```

## \--(source: Null, keys: Any)

Helper function that enables `--` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=4f6495a630c9af95ad6caf51cece716666cacdc9f0005c514f769edea3ca0c0a url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-plusplus.md -->

---
product: DataWeave
version: 2.11
---

# ++

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## ++<S, T>(source: Array<S>, with: Array<T>): Array<S | T>

Concatenates two values.

This version of `++` concatenates the elements of two arrays into a new array. Other versions act on
strings, objects, and the various date and time formats that DataWeave supports.

If the two arrays contain different types of elements, the resulting array is all of `S` type
elements of `Array<S>` followed by all the `T` type elements of `Array<T>`. Either of the arrays can
also have mixed-type elements. Also note that the arrays can contain any supported data type.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The source array.</p></td></tr><tr><td><p><code>with</code></p></td><td><p>The array to concatenate with the source array.</p></td></tr></tbody></table>

### Example

The example concatenates an `Array<Number>` with an `Array<String>`. Notice that it outputs the
result as the value of a JSON object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "result" : [0, 1, 2] ++ ["a", "b", "c"] }
```

#### Output

```JSON
{ "result": [0, 1, 2, "a", "b", "c"] }
```

### Example

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "a" : [0, 1, true, "my string"] ++ [2, [3,4,5], {"a": 6}] }
```

#### Output

```JSON
{ "a": [0, 1, true, "my string", 2, [3, 4, 5], { "a": 6}] }
```

## ++(source: String, with: String): String

Concatenates the characters of two strings.

Strings are treated as arrays of characters, so the `++` operator concatenates the characters of
each string as if they were arrays of single-character string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The source string.</p></td></tr><tr><td><p><code>with</code></p></td><td><p>The string to concatenate with the source string.</p></td></tr></tbody></table>

### Example

This example concatenates two strings. Here, `Mule` is treated as
`Array<String> ["M", "u", "l", "e"]`. Notice that the example outputs the result `MuleSoft` as the
value of a JSON object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "name" : "Mule" ++ "Soft" }
```

#### Output

```JSON
{ "name": "MuleSoft" }
```

## ++<T <: Object, Q <: Object>(source: T, with: Q): T & Q

Concatenates two objects and returns one flattened object.

The `++` operator extracts all the key-values pairs from each object, then combines them together
into one result object.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The source object.</p></td></tr><tr><td><p><code>with</code></p></td><td><p>The object to concatenate with the source object.</p></td></tr></tbody></table>

### Example

This example concatenates two objects and transforms them to XML. Notice that it flattens the array
of objects `{aa: "a", bb: "b"}` into separate XML elements and that the output uses the keys of the
specified JSON objects as XML elements and the values of those objects as XML values.

#### Source

```DataWeave
%dw 2.0
output application/xml
---
{ concat : {aa: "a", bb: "b"} ++ {cc: "c"} }
```

#### Output

```XML
<?xml version="1.0" encoding="UTF-8"?>
<concat>
  <aa>a</aa>
  <bb>b</bb>
  <cc>c</cc>
</concat>
```

## ++(date: Date, time: LocalTime): LocalDateTime

Appends a `LocalTime` with a `Date` to return a `LocalDateTime` value.

`Date` and `LocalTime` instances are written in standard Java notation, surrounded by pipe (`|`)
symbols. The result is a `LocalDateTime` object in the standard Java format. Note that the order in
which the two objects are concatenated is irrelevant, so logically,
``Date LocalTime` produces the same result as `LocalTime Date``.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><p>A <code>Date</code>.</p></td></tr><tr><td><p><code>time</code></p></td><td><p>A <code>LocalTime</code>, a time format without a time zone.</p></td></tr></tbody></table>

### Example

This example concatenates a `Date` and `LocalTime` object to return a `LocalDateTime`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "LocalDateTime" : (|2017-10-01| ++ |23:57:59|) }
```

#### Output

```JSON
{ "LocalDateTime": "2017-10-01T23:57:59" }
```

## ++(time: LocalTime, date: Date): LocalDateTime

Appends a `LocalTime` with a `Date` to return a `LocalDateTime`.

Note that the order in which the two objects are concatenated is irrelevant, so logically,
``LocalTime Date` produces the same result as `Date LocalTime``.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>time</code></p></td><td><p>A <code>LocalTime</code>, a time format without a time zone.</p></td></tr><tr><td><p><code>date</code></p></td><td><p>A <code>Date</code>.</p></td></tr></tbody></table>

### Example

This example concatenates `LocalTime` and `Date` objects to return a `LocalDateTime`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "LocalDateTime" : (|23:57:59| ++ |2003-10-01|) }
```

#### Output

```JSON
{ "LocalDateTime": "2017-10-01T23:57:59" }
```

## ++(date: Date, time: Time): DateTime

Appends a `Date` to a `Time` in order to return a `DateTime`.

Note that the order in which the two objects are concatenated is irrelevant, so logically, `Date` +
`Time` produces the same result as `Time` + `Date`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><p>A <code>Date</code>.</p></td></tr><tr><td><p><code>time</code></p></td><td><p>A <code>Time</code>, a time format that can include a time zone (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `Date` and `Time` objects to return a `DateTime`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ |2017-10-01| ++ |23:57:59-03:00|, |2017-10-01| ++ |23:57:59Z| ]
```

#### Output

```JSON
[ "2017-10-01T23:57:59-03:00", "2017-10-01T23:57:59Z" ]
```

## ++(time: Time, date: Date): DateTime

Appends a `Date` to a `Time` object to return a `DateTime`.

Note that the order in which the two objects are concatenated is irrelevant, so logically, `Date` +
`Time` produces the same result as a `Time` + `Date`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>time</code></p></td><td><p>A <code>Time</code>, a time format that can include a time zone (<code>Z</code> or <code>HH:mm</code>).</p></td></tr><tr><td><p><code>date</code></p></td><td><p>A <code>Date</code>.</p></td></tr></tbody></table>

### Example

This example concatenates a `Date` with a `Time` to output a `DateTime`. Notice that the inputs are
surrounded by pipes (`|`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
|2018-11-30| ++ |23:57:59+01:00|
```

#### Output

```JSON
"2018-11-30T23:57:59+01:00"
```

### Example

This example concatenates `Time` and `Date` objects to return `DateTime` objects. Note that the
first `LocalTime` ``object is coerced to a `Time``. Notice that the order of the date and time
inputs does not change the order of the output `DateTime`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  "DateTime1" : (|23:57:59| as Time) ++ |2017-10-01|,
  "DateTime2" : |23:57:59Z| ++ |2017-10-01|,
  "DateTime3" : |2017-10-01| ++ |23:57:59+02:00|
}
```

#### Output

```JSON
{
  "DateTime1": "2017-10-01T23:57:59Z",
  "DateTime2": "2017-10-01T23:57:59Z",
  "DateTime3": "2017-10-01T23:57:59+02:00"
}
```

## ++(date: Date, timezone: TimeZone): DateTime

Appends a `TimeZone` to a `Date` type value and returns a `DateTime` result.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><p>A <code>Date</code>.</p></td></tr><tr><td><p><code>timezone</code></p></td><td><p>A <code>TimeZone</code> (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `Date` and `TimeZone` (`-03:00`) to return a `DateTime`. Note the local
time in the `DateTime` is `00:00:00` (midnight).

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "DateTime" : (|2017-10-01| ++ |-03:00|) }
```

#### Output

```JSON
{ "DateTime": "2017-10-01T00:00:00-03:00" }
```

## ++(timezone: TimeZone, date: Date): DateTime

Appends a `Date` to a `TimeZone` in order to return a `DateTime`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><p>A <code>Date</code>.</p></td></tr><tr><td><p><code>timezone</code></p></td><td><p>A <code>TimeZone</code> (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `TimeZone` (`-03:00`) and `Date` to return a `DateTime`. Note the local
time in the `DateTime` is `00:00:00` (midnight).

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "DateTime" : |-03:00| ++ |2017-10-01| }
```

#### Output

```JSON
{ "DateTime": "2017-10-01T00:00:00-03:00" }
```

## ++(dateTime: LocalDateTime, timezone: TimeZone): DateTime

Appends a `TimeZone` to a `LocalDateTime` in order to return a `DateTime`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><p>A <code>LocalDateTime</code>, a date and time without a time zone.</p></td></tr><tr><td><p><code>timezone</code></p></td><td><p>A <code>TimeZone</code> (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `LocalDateTime` and `TimeZone` (`-03:00`) to return a `DateTime`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "DateTime" : (|2003-10-01T23:57:59| ++ |-03:00|) }
```

#### Output

```JSON
{ "DateTime": "2003-10-01T23:57:59-03:00 }
```

## ++(timezone: TimeZone, datetime: LocalDateTime): DateTime

Appends a `LocalDateTime` to a `TimeZone` in order to return a `DateTime`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><p>A <code>LocalDateTime</code>, a date and time without a time zone.</p></td></tr><tr><td><p><code>timezone</code></p></td><td><p>A <code>TimeZone</code> (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `TimeZone` (`-03:00`) and `LocalDateTime` to return a `DateTime`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "TimeZone" : (|-03:00| ++ |2003-10-01T23:57:59|) }
```

#### Output

```JSON
{ "TimeZone": "2003-10-01T23:57:59-03:00" }
```

## ++(time: LocalTime, timezone: TimeZone): Time

Appends a `TimeZone` to a `LocalTime` in order to return a `Time`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>time</code></p></td><td><p>A <code>LocalTime</code>, time format without a time zone.</p></td></tr><tr><td><p><code>timezone</code></p></td><td><p>A <code>TimeZone</code> (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `LocalTime` and `TimeZone` (`-03:00`) to return a `Time`. Note that the
output returns\`:00\` for the unspecified seconds.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "Time" : (|23:57| ++ |-03:00|) }
```

#### Output

```JSON
{ "Time": "23:57:00-03:00" }
```

## ++(timezone: TimeZone, time: LocalTime): Time

Appends a `LocalTime` to a `TimeZone` in order to return a `Time`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>time</code></p></td><td><p>A <code>LocalTime</code>, a time format without a time zone.</p></td></tr><tr><td><p><code>timezone</code></p></td><td><p>A <code>TimeZone</code> (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `TimeZone` (`-03:00`) and `LocalTime` to return a `Time`. Note that the
output returns\`:00\` for the unspecified seconds.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "Time" : (|-03:00| ++ |23:57|) }
```

#### Output

```JSON
{
  "Time": "23:57:00-03:00"
}
```

<!-- document id=7ea0a40ef9c649b4ec9edf0a2f7ef9c7ca3dec5973cd64c79da9932df485a1e3 url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-plusplus.md -->

---
product: DataWeave
version: 2.12
---

# ++

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## ++<S, T>(source: Array<S>, with: Array<T>): Array<S | T>

Concatenates two values.

This version of `++` concatenates the elements of two arrays into a new array. Other versions act on
strings, objects, and the various date and time formats that DataWeave supports.

If the two arrays contain different types of elements, the resulting array is all of `S` type
elements of `Array<S>` followed by all the `T` type elements of `Array<T>`. Either of the arrays can
also have mixed-type elements. Also note that the arrays can contain any supported data type.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The source array.</p></td></tr><tr><td><p><code>with</code></p></td><td><p>The array to concatenate with the source array.</p></td></tr></tbody></table>

### Example

The example concatenates an `Array<Number>` with an `Array<String>`. Notice that it outputs the
result as the value of a JSON object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "result" : [0, 1, 2] ++ ["a", "b", "c"] }
```

#### Output

```JSON
{ "result": [0, 1, 2, "a", "b", "c"] }
```

### Example

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "a" : [0, 1, true, "my string"] ++ [2, [3,4,5], {"a": 6}] }
```

#### Output

```JSON
{ "a": [0, 1, true, "my string", 2, [3, 4, 5], { "a": 6}] }
```

## ++(source: String, with: String): String

Concatenates the characters of two strings.

Strings are treated as arrays of characters, so the `++` operator concatenates the characters of
each string as if they were arrays of single-character string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The source string.</p></td></tr><tr><td><p><code>with</code></p></td><td><p>The string to concatenate with the source string.</p></td></tr></tbody></table>

### Example

This example concatenates two strings. Here, `Mule` is treated as
`Array<String> ["M", "u", "l", "e"]`. Notice that the example outputs the result `MuleSoft` as the
value of a JSON object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "name" : "Mule" ++ "Soft" }
```

#### Output

```JSON
{ "name": "MuleSoft" }
```

## ++<T <: Object, Q <: Object>(source: T, with: Q): T & Q

Concatenates two objects and returns one flattened object.

The `++` operator extracts all the key-values pairs from each object, then combines them together
into one result object.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The source object.</p></td></tr><tr><td><p><code>with</code></p></td><td><p>The object to concatenate with the source object.</p></td></tr></tbody></table>

### Example

This example concatenates two objects and transforms them to XML. Notice that it flattens the array
of objects `{aa: "a", bb: "b"}` into separate XML elements and that the output uses the keys of the
specified JSON objects as XML elements and the values of those objects as XML values.

#### Source

```DataWeave
%dw 2.0
output application/xml
---
{ concat : {aa: "a", bb: "b"} ++ {cc: "c"} }
```

#### Output

```XML
<?xml version="1.0" encoding="UTF-8"?>
<concat>
  <aa>a</aa>
  <bb>b</bb>
  <cc>c</cc>
</concat>
```

## ++(date: Date, time: LocalTime): LocalDateTime

Appends a `LocalTime` with a `Date` to return a `LocalDateTime` value.

`Date` and `LocalTime` instances are written in standard Java notation, surrounded by pipe (`|`)
symbols. The result is a `LocalDateTime` object in the standard Java format. Note that the order in
which the two objects are concatenated is irrelevant, so logically,
``Date LocalTime` produces the same result as `LocalTime Date``.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><p>A <code>Date</code>.</p></td></tr><tr><td><p><code>time</code></p></td><td><p>A <code>LocalTime</code>, a time format without a time zone.</p></td></tr></tbody></table>

### Example

This example concatenates a `Date` and `LocalTime` object to return a `LocalDateTime`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "LocalDateTime" : (|2017-10-01| ++ |23:57:59|) }
```

#### Output

```JSON
{ "LocalDateTime": "2017-10-01T23:57:59" }
```

## ++(time: LocalTime, date: Date): LocalDateTime

Appends a `LocalTime` with a `Date` to return a `LocalDateTime`.

Note that the order in which the two objects are concatenated is irrelevant, so logically,
``LocalTime Date` produces the same result as `Date LocalTime``.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>time</code></p></td><td><p>A <code>LocalTime</code>, a time format without a time zone.</p></td></tr><tr><td><p><code>date</code></p></td><td><p>A <code>Date</code>.</p></td></tr></tbody></table>

### Example

This example concatenates `LocalTime` and `Date` objects to return a `LocalDateTime`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "LocalDateTime" : (|23:57:59| ++ |2003-10-01|) }
```

#### Output

```JSON
{ "LocalDateTime": "2017-10-01T23:57:59" }
```

## ++(date: Date, time: Time): DateTime

Appends a `Date` to a `Time` in order to return a `DateTime`.

Note that the order in which the two objects are concatenated is irrelevant, so logically, `Date` +
`Time` produces the same result as `Time` + `Date`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><p>A <code>Date</code>.</p></td></tr><tr><td><p><code>time</code></p></td><td><p>A <code>Time</code>, a time format that can include a time zone (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `Date` and `Time` objects to return a `DateTime`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ |2017-10-01| ++ |23:57:59-03:00|, |2017-10-01| ++ |23:57:59Z| ]
```

#### Output

```JSON
[ "2017-10-01T23:57:59-03:00", "2017-10-01T23:57:59Z" ]
```

## ++(time: Time, date: Date): DateTime

Appends a `Date` to a `Time` object to return a `DateTime`.

Note that the order in which the two objects are concatenated is irrelevant, so logically, `Date` +
`Time` produces the same result as a `Time` + `Date`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>time</code></p></td><td><p>A <code>Time</code>, a time format that can include a time zone (<code>Z</code> or <code>HH:mm</code>).</p></td></tr><tr><td><p><code>date</code></p></td><td><p>A <code>Date</code>.</p></td></tr></tbody></table>

### Example

This example concatenates a `Date` with a `Time` to output a `DateTime`. Notice that the inputs are
surrounded by pipes (`|`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
|2018-11-30| ++ |23:57:59+01:00|
```

#### Output

```JSON
"2018-11-30T23:57:59+01:00"
```

### Example

This example concatenates `Time` and `Date` objects to return `DateTime` objects. Note that the
first `LocalTime` ``object is coerced to a `Time``. Notice that the order of the date and time
inputs does not change the order of the output `DateTime`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  "DateTime1" : (|23:57:59| as Time) ++ |2017-10-01|,
  "DateTime2" : |23:57:59Z| ++ |2017-10-01|,
  "DateTime3" : |2017-10-01| ++ |23:57:59+02:00|
}
```

#### Output

```JSON
{
  "DateTime1": "2017-10-01T23:57:59Z",
  "DateTime2": "2017-10-01T23:57:59Z",
  "DateTime3": "2017-10-01T23:57:59+02:00"
}
```

## ++(date: Date, timezone: TimeZone): DateTime

Appends a `TimeZone` to a `Date` type value and returns a `DateTime` result.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><p>A <code>Date</code>.</p></td></tr><tr><td><p><code>timezone</code></p></td><td><p>A <code>TimeZone</code> (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `Date` and `TimeZone` (`-03:00`) to return a `DateTime`. Note the local
time in the `DateTime` is `00:00:00` (midnight).

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "DateTime" : (|2017-10-01| ++ |-03:00|) }
```

#### Output

```JSON
{ "DateTime": "2017-10-01T00:00:00-03:00" }
```

## ++(timezone: TimeZone, date: Date): DateTime

Appends a `Date` to a `TimeZone` in order to return a `DateTime`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><p>A <code>Date</code>.</p></td></tr><tr><td><p><code>timezone</code></p></td><td><p>A <code>TimeZone</code> (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `TimeZone` (`-03:00`) and `Date` to return a `DateTime`. Note the local
time in the `DateTime` is `00:00:00` (midnight).

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "DateTime" : |-03:00| ++ |2017-10-01| }
```

#### Output

```JSON
{ "DateTime": "2017-10-01T00:00:00-03:00" }
```

## ++(dateTime: LocalDateTime, timezone: TimeZone): DateTime

Appends a `TimeZone` to a `LocalDateTime` in order to return a `DateTime`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><p>A <code>LocalDateTime</code>, a date and time without a time zone.</p></td></tr><tr><td><p><code>timezone</code></p></td><td><p>A <code>TimeZone</code> (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `LocalDateTime` and `TimeZone` (`-03:00`) to return a `DateTime`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "DateTime" : (|2003-10-01T23:57:59| ++ |-03:00|) }
```

#### Output

```JSON
{ "DateTime": "2003-10-01T23:57:59-03:00 }
```

## ++(timezone: TimeZone, datetime: LocalDateTime): DateTime

Appends a `LocalDateTime` to a `TimeZone` in order to return a `DateTime`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><p>A <code>LocalDateTime</code>, a date and time without a time zone.</p></td></tr><tr><td><p><code>timezone</code></p></td><td><p>A <code>TimeZone</code> (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `TimeZone` (`-03:00`) and `LocalDateTime` to return a `DateTime`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "TimeZone" : (|-03:00| ++ |2003-10-01T23:57:59|) }
```

#### Output

```JSON
{ "TimeZone": "2003-10-01T23:57:59-03:00" }
```

## ++(time: LocalTime, timezone: TimeZone): Time

Appends a `TimeZone` to a `LocalTime` in order to return a `Time`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>time</code></p></td><td><p>A <code>LocalTime</code>, time format without a time zone.</p></td></tr><tr><td><p><code>timezone</code></p></td><td><p>A <code>TimeZone</code> (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `LocalTime` and `TimeZone` (`-03:00`) to return a `Time`. Note that the
output returns\`:00\` for the unspecified seconds.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "Time" : (|23:57| ++ |-03:00|) }
```

#### Output

```JSON
{ "Time": "23:57:00-03:00" }
```

## ++(timezone: TimeZone, time: LocalTime): Time

Appends a `LocalTime` to a `TimeZone` in order to return a `Time`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>time</code></p></td><td><p>A <code>LocalTime</code>, a time format without a time zone.</p></td></tr><tr><td><p><code>timezone</code></p></td><td><p>A <code>TimeZone</code> (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `TimeZone` (`-03:00`) and `LocalTime` to return a `Time`. Note that the
output returns\`:00\` for the unspecified seconds.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "Time" : (|-03:00| ++ |23:57|) }
```

#### Output

```JSON
{
  "Time": "23:57:00-03:00"
}
```

<!-- document id=f9c84694bc4663f8aacc722d6f004571752e8601024f1774bffca17a2371de20 url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-plusplus.md -->

---
product: DataWeave
version: 2.3
---

# ++

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## ++(Array<S>, Array<T>): Array<S | T>

Concatenates two values.

This version of `++` concatenates the elements of two arrays into a new array. Other versions act on
strings, objects, and the various date and time formats that DataWeave supports.

If the two arrays contain different types of elements, the resulting array is all of `S` type
elements of `Array<S>` followed by all the `T` type elements of `Array<T>`. Either of the arrays can
also have mixed-type elements. Also note that the arrays can contain any supported data type.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The source array.</p></td></tr><tr><td><p><code>with</code></p></td><td><p>The array to concatenate with the source array.</p></td></tr></tbody></table>

### Example

The example concatenates an `Array<Number>` with an `Array<String>`. Notice that it outputs the
result as the value of a JSON object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "result" : [0, 1, 2] ++ ["a", "b", "c"] }
```

#### Output

```JSON
{ "result": [0, 1, 2, "a", "b", "c"] }
```

### Example

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "a" : [0, 1, true, "my string"] ++ [2, [3,4,5], {"a": 6}] }
```

#### Output

```JSON
{ "a": [0, 1, true, "my string", 2, [3, 4, 5], { "a": 6}] }
```

## ++(String, String): String

Concatenates the characters of two strings.

Strings are treated as arrays of characters, so the `++` operator concatenates the characters of
each string as if they were arrays of single-character string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The source string.</p></td></tr><tr><td><p><code>with</code></p></td><td><p>The string to concatenate with the source string.</p></td></tr></tbody></table>

### Example

This example concatenates two strings. Here, `Mule` is treated as
`Array<String> ["M", "u", "l", "e"]`. Notice that the example outputs the result `MuleSoft` as the
value of a JSON object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "name" : "Mule" ++ "Soft" }
```

#### Output

```JSON
{ "name": "MuleSoft" }
```

## ++(T, Q): T & Q

Concatenates two objects and returns one flattened object.

The `++` operator extracts all the key-values pairs from each object, then combines them together
into one result object.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The source object.</p></td></tr><tr><td><p><code>with</code></p></td><td><p>The object to concatenate with the source object.</p></td></tr></tbody></table>

### Example

This example concatenates two objects and transforms them to XML. Notice that it flattens the array
of objects `{aa: "a", bb: "b"}` into separate XML elements and that the output uses the keys of the
specified JSON objects as XML elements and the values of those objects as XML values.

#### Source

```DataWeave
%dw 2.0
output application/xml
---
{ concat : {aa: "a", bb: "b"} ++ {cc: "c"} }
```

#### Output

```XML
<?xml version="1.0" encoding="UTF-8"?>
<concat>
  <aa>a</aa>
  <bb>b</bb>
  <cc>c</cc>
</concat>
```

## ++(Date, LocalTime): LocalDateTime

Appends a `LocalTime` with a `Date` to return a `LocalDateTime` value.

`Date` and `LocalTime` instances are written in standard Java notation, surrounded by pipe (`|`)
symbols. The result is a `LocalDateTime` object in the standard Java format. Note that the order in
which the two objects are concatenated is irrelevant, so logically,
``Date LocalTime` produces the same result as `LocalTime Date``.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><p>A <code>Date</code>.</p></td></tr><tr><td><p><code>time</code></p></td><td><p>A <code>LocalTime</code>, a time format without a time zone.</p></td></tr></tbody></table>

### Example

This example concatenates a `Date` and `LocalTime` object to return a `LocalDateTime`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "LocalDateTime" : (|2017-10-01| ++ |23:57:59|) }
```

#### Output

```JSON
{ "LocalDateTime": "2017-10-01T23:57:59" }
```

## ++(LocalTime, Date): LocalDateTime

Appends a `LocalTime` with a `Date` to return a `LocalDateTime`.

Note that the order in which the two objects are concatenated is irrelevant, so logically,
``LocalTime Date` produces the same result as `Date LocalTime``.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>time</code></p></td><td><p>A <code>LocalTime</code>, a time format without a time zone.</p></td></tr><tr><td><p><code>date</code></p></td><td><p>A <code>Date</code>.</p></td></tr></tbody></table>

### Example

This example concatenates `LocalTime` and `Date` objects to return a `LocalDateTime`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "LocalDateTime" : (|23:57:59| ++ |2003-10-01|) }
```

#### Output

```JSON
{ "LocalDateTime": "2017-10-01T23:57:59" }
```

## ++(Date, Time): DateTime

Appends a `Date` to a `Time` in order to return a `DateTime`.

Note that the order in which the two objects are concatenated is irrelevant, so logically, `Date` +
`Time` produces the same result as `Time` + `Date`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><p>A <code>Date</code>.</p></td></tr><tr><td><p><code>time</code></p></td><td><p>A <code>Time</code>, a time format that can include a time zone (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `Date` and `Time` objects to return a `DateTime`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ |2017-10-01| ++ |23:57:59-03:00|, |2017-10-01| ++ |23:57:59Z| ]
```

#### Output

```JSON
[ "2017-10-01T23:57:59-03:00", "2017-10-01T23:57:59Z" ]
```

## ++(Time, Date): DateTime

Appends a `Date` to a `Time` object to return a `DateTime`.

Note that the order in which the two objects are concatenated is irrelevant, so logically, `Date` +
`Time` produces the same result as a `Time` + `Date`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>time</code></p></td><td><p>A <code>Time</code>, a time format that can include a time zone (<code>Z</code> or <code>HH:mm</code>).</p></td></tr><tr><td><p><code>date</code></p></td><td><p>A <code>Date</code>.</p></td></tr></tbody></table>

### Example

This example concatenates a `Date` with a `Time` to output a `DateTime`. Notice that the inputs are
surrounded by pipes (`|`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
|2018-11-30| ++ |23:57:59+01:00|
```

#### Output

```JSON
"2018-11-30T23:57:59+01:00"
```

### Example

This example concatenates `Time` and `Date` objects to return `DateTime` objects. Note that the
first `LocalTime` ``object is coerced to a `Time``. Notice that the order of the date and time
inputs does not change the order of the output `DateTime`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  "DateTime1" : (|23:57:59| as Time) ++ |2017-10-01|,
  "DateTime2" : |23:57:59Z| ++ |2017-10-01|,
  "DateTime3" : |2017-10-01| ++ |23:57:59+02:00|
}
```

#### Output

```JSON
{
  "DateTime1": "2017-10-01T23:57:59Z",
  "DateTime2": "2017-10-01T23:57:59Z",
  "DateTime3": "2017-10-01T23:57:59+02:00"
}
```

## ++(Date, TimeZone): DateTime

Appends a `TimeZone` to a `Date` type value and returns a `DateTime` result.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><p>A <code>Date</code>.</p></td></tr><tr><td><p><code>timezone</code></p></td><td><p>A <code>TimeZone</code> (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `Date` and `TimeZone` (`-03:00`) to return a `DateTime`. Note the local
time in the `DateTime` is `00:00:00` (midnight).

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "DateTime" : (|2017-10-01| ++ |-03:00|) }
```

#### Output

```JSON
{ "DateTime": "2017-10-01T00:00:00-03:00" }
```

## ++(TimeZone, Date): DateTime

Appends a `Date` to a `TimeZone` in order to return a `DateTime`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><p>A <code>Date</code>.</p></td></tr><tr><td><p><code>timezone</code></p></td><td><p>A <code>TimeZone</code> (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `TimeZone` (`-03:00`) and `Date` to return a `DateTime`. Note the local
time in the `DateTime` is `00:00:00` (midnight).

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "DateTime" : |-03:00| ++ |2017-10-01| }
```

#### Output

```JSON
{ "DateTime": "2017-10-01T00:00:00-03:00" }
```

## ++(LocalDateTime, TimeZone): DateTime

Appends a `TimeZone` to a `LocalDateTime` in order to return a `DateTime`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><p>A <code>LocalDateTime</code>, a date and time without a time zone.</p></td></tr><tr><td><p><code>timezone</code></p></td><td><p>A <code>TimeZone</code> (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `LocalDateTime` and `TimeZone` (`-03:00`) to return a `DateTime`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "DateTime" : (|2003-10-01T23:57:59| ++ |-03:00|) }
```

#### Output

```JSON
{ "DateTime": "2003-10-01T23:57:59-03:00 }
```

## ++(TimeZone, LocalDateTime): DateTime

Appends a `LocalDateTime` to a `TimeZone` in order to return a `DateTime`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><p>A <code>LocalDateTime</code>, a date and time without a time zone.</p></td></tr><tr><td><p><code>timezone</code></p></td><td><p>A <code>TimeZone</code> (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `TimeZone` (`-03:00`) and `LocalDateTime` to return a `DateTime`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "TimeZone" : (|-03:00| ++ |2003-10-01T23:57:59|) }
```

#### Output

```JSON
{ "TimeZone": "2003-10-01T23:57:59-03:00" }
```

## ++(LocalTime, TimeZone): Time

Appends a `TimeZone` to a `LocalTime` in order to return a `Time`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>time</code></p></td><td><p>A <code>LocalTime</code>, time format without a time zone.</p></td></tr><tr><td><p><code>timezone</code></p></td><td><p>A <code>TimeZone</code> (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `LocalTime` and `TimeZone` (`-03:00`) to return a `Time`. Note that the
output returns\`:00\` for the unspecified seconds.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "Time" : (|23:57| ++ |-03:00|) }
```

#### Output

```JSON
{ "Time": "23:57:00-03:00" }
```

## ++(TimeZone, LocalTime): Time

Appends a `LocalTime` to a `TimeZone` in order to return a `Time`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>time</code></p></td><td><p>A <code>LocalTime</code>, a time format without a time zone.</p></td></tr><tr><td><p><code>timezone</code></p></td><td><p>A <code>TimeZone</code> (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `TimeZone` (`-03:00`) and `LocalTime` to return a `Time`. Note that the
output returns\`:00\` for the unspecified seconds.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "Time" : (|-03:00| ++ |23:57|) }
```

#### Output

```JSON
{
  "Time": "23:57:00-03:00"
}
```

<!-- document id=4840a404545f52ada3312bbedad01451504445a3f73dd8f50621e6e82d78647c url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-plusplus.md -->

---
product: DataWeave
version: 2.4
---

# ++

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## ++<S, T>(source: Array<S>, with: Array<T>): Array<S | T>

Concatenates two values.

This version of `++` concatenates the elements of two arrays into a new array. Other versions act on
strings, objects, and the various date and time formats that DataWeave supports.

If the two arrays contain different types of elements, the resulting array is all of `S` type
elements of `Array<S>` followed by all the `T` type elements of `Array<T>`. Either of the arrays can
also have mixed-type elements. Also note that the arrays can contain any supported data type.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The source array.</p></td></tr><tr><td><p><code>with</code></p></td><td><p>The array to concatenate with the source array.</p></td></tr></tbody></table>

### Example

The example concatenates an `Array<Number>` with an `Array<String>`. Notice that it outputs the
result as the value of a JSON object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "result" : [0, 1, 2] ++ ["a", "b", "c"] }
```

#### Output

```JSON
{ "result": [0, 1, 2, "a", "b", "c"] }
```

### Example

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "a" : [0, 1, true, "my string"] ++ [2, [3,4,5], {"a": 6}] }
```

#### Output

```JSON
{ "a": [0, 1, true, "my string", 2, [3, 4, 5], { "a": 6}] }
```

## ++(source: String, with: String): String

Concatenates the characters of two strings.

Strings are treated as arrays of characters, so the `++` operator concatenates the characters of
each string as if they were arrays of single-character string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The source string.</p></td></tr><tr><td><p><code>with</code></p></td><td><p>The string to concatenate with the source string.</p></td></tr></tbody></table>

### Example

This example concatenates two strings. Here, `Mule` is treated as
`Array<String> ["M", "u", "l", "e"]`. Notice that the example outputs the result `MuleSoft` as the
value of a JSON object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "name" : "Mule" ++ "Soft" }
```

#### Output

```JSON
{ "name": "MuleSoft" }
```

## ++<T <: Object, Q <: Object>(source: T, with: Q): T & Q

Concatenates two objects and returns one flattened object.

The `++` operator extracts all the key-values pairs from each object, then combines them together
into one result object.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The source object.</p></td></tr><tr><td><p><code>with</code></p></td><td><p>The object to concatenate with the source object.</p></td></tr></tbody></table>

### Example

This example concatenates two objects and transforms them to XML. Notice that it flattens the array
of objects `{aa: "a", bb: "b"}` into separate XML elements and that the output uses the keys of the
specified JSON objects as XML elements and the values of those objects as XML values.

#### Source

```DataWeave
%dw 2.0
output application/xml
---
{ concat : {aa: "a", bb: "b"} ++ {cc: "c"} }
```

#### Output

```XML
<?xml version="1.0" encoding="UTF-8"?>
<concat>
  <aa>a</aa>
  <bb>b</bb>
  <cc>c</cc>
</concat>
```

## ++(date: Date, time: LocalTime): LocalDateTime

Appends a `LocalTime` with a `Date` to return a `LocalDateTime` value.

`Date` and `LocalTime` instances are written in standard Java notation, surrounded by pipe (`|`)
symbols. The result is a `LocalDateTime` object in the standard Java format. Note that the order in
which the two objects are concatenated is irrelevant, so logically,
``Date LocalTime` produces the same result as `LocalTime Date``.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><p>A <code>Date</code>.</p></td></tr><tr><td><p><code>time</code></p></td><td><p>A <code>LocalTime</code>, a time format without a time zone.</p></td></tr></tbody></table>

### Example

This example concatenates a `Date` and `LocalTime` object to return a `LocalDateTime`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "LocalDateTime" : (|2017-10-01| ++ |23:57:59|) }
```

#### Output

```JSON
{ "LocalDateTime": "2017-10-01T23:57:59" }
```

## ++(time: LocalTime, date: Date): LocalDateTime

Appends a `LocalTime` with a `Date` to return a `LocalDateTime`.

Note that the order in which the two objects are concatenated is irrelevant, so logically,
``LocalTime Date` produces the same result as `Date LocalTime``.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>time</code></p></td><td><p>A <code>LocalTime</code>, a time format without a time zone.</p></td></tr><tr><td><p><code>date</code></p></td><td><p>A <code>Date</code>.</p></td></tr></tbody></table>

### Example

This example concatenates `LocalTime` and `Date` objects to return a `LocalDateTime`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "LocalDateTime" : (|23:57:59| ++ |2003-10-01|) }
```

#### Output

```JSON
{ "LocalDateTime": "2017-10-01T23:57:59" }
```

## ++(date: Date, time: Time): DateTime

Appends a `Date` to a `Time` in order to return a `DateTime`.

Note that the order in which the two objects are concatenated is irrelevant, so logically, `Date` +
`Time` produces the same result as `Time` + `Date`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><p>A <code>Date</code>.</p></td></tr><tr><td><p><code>time</code></p></td><td><p>A <code>Time</code>, a time format that can include a time zone (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `Date` and `Time` objects to return a `DateTime`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ |2017-10-01| ++ |23:57:59-03:00|, |2017-10-01| ++ |23:57:59Z| ]
```

#### Output

```JSON
[ "2017-10-01T23:57:59-03:00", "2017-10-01T23:57:59Z" ]
```

## ++(time: Time, date: Date): DateTime

Appends a `Date` to a `Time` object to return a `DateTime`.

Note that the order in which the two objects are concatenated is irrelevant, so logically, `Date` +
`Time` produces the same result as a `Time` + `Date`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>time</code></p></td><td><p>A <code>Time</code>, a time format that can include a time zone (<code>Z</code> or <code>HH:mm</code>).</p></td></tr><tr><td><p><code>date</code></p></td><td><p>A <code>Date</code>.</p></td></tr></tbody></table>

### Example

This example concatenates a `Date` with a `Time` to output a `DateTime`. Notice that the inputs are
surrounded by pipes (`|`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
|2018-11-30| ++ |23:57:59+01:00|
```

#### Output

```JSON
"2018-11-30T23:57:59+01:00"
```

### Example

This example concatenates `Time` and `Date` objects to return `DateTime` objects. Note that the
first `LocalTime` ``object is coerced to a `Time``. Notice that the order of the date and time
inputs does not change the order of the output `DateTime`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  "DateTime1" : (|23:57:59| as Time) ++ |2017-10-01|,
  "DateTime2" : |23:57:59Z| ++ |2017-10-01|,
  "DateTime3" : |2017-10-01| ++ |23:57:59+02:00|
}
```

#### Output

```JSON
{
  "DateTime1": "2017-10-01T23:57:59Z",
  "DateTime2": "2017-10-01T23:57:59Z",
  "DateTime3": "2017-10-01T23:57:59+02:00"
}
```

## ++(date: Date, timezone: TimeZone): DateTime

Appends a `TimeZone` to a `Date` type value and returns a `DateTime` result.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><p>A <code>Date</code>.</p></td></tr><tr><td><p><code>timezone</code></p></td><td><p>A <code>TimeZone</code> (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `Date` and `TimeZone` (`-03:00`) to return a `DateTime`. Note the local
time in the `DateTime` is `00:00:00` (midnight).

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "DateTime" : (|2017-10-01| ++ |-03:00|) }
```

#### Output

```JSON
{ "DateTime": "2017-10-01T00:00:00-03:00" }
```

## ++(timezone: TimeZone, date: Date): DateTime

Appends a `Date` to a `TimeZone` in order to return a `DateTime`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><p>A <code>Date</code>.</p></td></tr><tr><td><p><code>timezone</code></p></td><td><p>A <code>TimeZone</code> (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `TimeZone` (`-03:00`) and `Date` to return a `DateTime`. Note the local
time in the `DateTime` is `00:00:00` (midnight).

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "DateTime" : |-03:00| ++ |2017-10-01| }
```

#### Output

```JSON
{ "DateTime": "2017-10-01T00:00:00-03:00" }
```

## ++(dateTime: LocalDateTime, timezone: TimeZone): DateTime

Appends a `TimeZone` to a `LocalDateTime` in order to return a `DateTime`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><p>A <code>LocalDateTime</code>, a date and time without a time zone.</p></td></tr><tr><td><p><code>timezone</code></p></td><td><p>A <code>TimeZone</code> (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `LocalDateTime` and `TimeZone` (`-03:00`) to return a `DateTime`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "DateTime" : (|2003-10-01T23:57:59| ++ |-03:00|) }
```

#### Output

```JSON
{ "DateTime": "2003-10-01T23:57:59-03:00 }
```

## ++(timezone: TimeZone, datetime: LocalDateTime): DateTime

Appends a `LocalDateTime` to a `TimeZone` in order to return a `DateTime`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><p>A <code>LocalDateTime</code>, a date and time without a time zone.</p></td></tr><tr><td><p><code>timezone</code></p></td><td><p>A <code>TimeZone</code> (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `TimeZone` (`-03:00`) and `LocalDateTime` to return a `DateTime`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "TimeZone" : (|-03:00| ++ |2003-10-01T23:57:59|) }
```

#### Output

```JSON
{ "TimeZone": "2003-10-01T23:57:59-03:00" }
```

## ++(time: LocalTime, timezone: TimeZone): Time

Appends a `TimeZone` to a `LocalTime` in order to return a `Time`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>time</code></p></td><td><p>A <code>LocalTime</code>, time format without a time zone.</p></td></tr><tr><td><p><code>timezone</code></p></td><td><p>A <code>TimeZone</code> (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `LocalTime` and `TimeZone` (`-03:00`) to return a `Time`. Note that the
output returns\`:00\` for the unspecified seconds.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "Time" : (|23:57| ++ |-03:00|) }
```

#### Output

```JSON
{ "Time": "23:57:00-03:00" }
```

## ++(timezone: TimeZone, time: LocalTime): Time

Appends a `LocalTime` to a `TimeZone` in order to return a `Time`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>time</code></p></td><td><p>A <code>LocalTime</code>, a time format without a time zone.</p></td></tr><tr><td><p><code>timezone</code></p></td><td><p>A <code>TimeZone</code> (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `TimeZone` (`-03:00`) and `LocalTime` to return a `Time`. Note that the
output returns\`:00\` for the unspecified seconds.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "Time" : (|-03:00| ++ |23:57|) }
```

#### Output

```JSON
{
  "Time": "23:57:00-03:00"
}
```

<!-- document id=f519746c51f7c12303e555b44586258dc1c1805ce58d193190c8dc4b12313851 url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-plusplus.md -->

---
product: DataWeave
version: 2.6
---

# ++

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## ++<S, T>(source: Array<S>, with: Array<T>): Array<S | T>

Concatenates two values.

This version of `++` concatenates the elements of two arrays into a new array. Other versions act on
strings, objects, and the various date and time formats that DataWeave supports.

If the two arrays contain different types of elements, the resulting array is all of `S` type
elements of `Array<S>` followed by all the `T` type elements of `Array<T>`. Either of the arrays can
also have mixed-type elements. Also note that the arrays can contain any supported data type.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The source array.</p></td></tr><tr><td><p><code>with</code></p></td><td><p>The array to concatenate with the source array.</p></td></tr></tbody></table>

### Example

The example concatenates an `Array<Number>` with an `Array<String>`. Notice that it outputs the
result as the value of a JSON object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "result" : [0, 1, 2] ++ ["a", "b", "c"] }
```

#### Output

```JSON
{ "result": [0, 1, 2, "a", "b", "c"] }
```

### Example

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "a" : [0, 1, true, "my string"] ++ [2, [3,4,5], {"a": 6}] }
```

#### Output

```JSON
{ "a": [0, 1, true, "my string", 2, [3, 4, 5], { "a": 6}] }
```

## ++(source: String, with: String): String

Concatenates the characters of two strings.

Strings are treated as arrays of characters, so the `++` operator concatenates the characters of
each string as if they were arrays of single-character string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The source string.</p></td></tr><tr><td><p><code>with</code></p></td><td><p>The string to concatenate with the source string.</p></td></tr></tbody></table>

### Example

This example concatenates two strings. Here, `Mule` is treated as
`Array<String> ["M", "u", "l", "e"]`. Notice that the example outputs the result `MuleSoft` as the
value of a JSON object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "name" : "Mule" ++ "Soft" }
```

#### Output

```JSON
{ "name": "MuleSoft" }
```

## ++<T <: Object, Q <: Object>(source: T, with: Q): T & Q

Concatenates two objects and returns one flattened object.

The `++` operator extracts all the key-values pairs from each object, then combines them together
into one result object.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The source object.</p></td></tr><tr><td><p><code>with</code></p></td><td><p>The object to concatenate with the source object.</p></td></tr></tbody></table>

### Example

This example concatenates two objects and transforms them to XML. Notice that it flattens the array
of objects `{aa: "a", bb: "b"}` into separate XML elements and that the output uses the keys of the
specified JSON objects as XML elements and the values of those objects as XML values.

#### Source

```DataWeave
%dw 2.0
output application/xml
---
{ concat : {aa: "a", bb: "b"} ++ {cc: "c"} }
```

#### Output

```XML
<?xml version="1.0" encoding="UTF-8"?>
<concat>
  <aa>a</aa>
  <bb>b</bb>
  <cc>c</cc>
</concat>
```

## ++(date: Date, time: LocalTime): LocalDateTime

Appends a `LocalTime` with a `Date` to return a `LocalDateTime` value.

`Date` and `LocalTime` instances are written in standard Java notation, surrounded by pipe (`|`)
symbols. The result is a `LocalDateTime` object in the standard Java format. Note that the order in
which the two objects are concatenated is irrelevant, so logically,
``Date LocalTime` produces the same result as `LocalTime Date``.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><p>A <code>Date</code>.</p></td></tr><tr><td><p><code>time</code></p></td><td><p>A <code>LocalTime</code>, a time format without a time zone.</p></td></tr></tbody></table>

### Example

This example concatenates a `Date` and `LocalTime` object to return a `LocalDateTime`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "LocalDateTime" : (|2017-10-01| ++ |23:57:59|) }
```

#### Output

```JSON
{ "LocalDateTime": "2017-10-01T23:57:59" }
```

## ++(time: LocalTime, date: Date): LocalDateTime

Appends a `LocalTime` with a `Date` to return a `LocalDateTime`.

Note that the order in which the two objects are concatenated is irrelevant, so logically,
``LocalTime Date` produces the same result as `Date LocalTime``.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>time</code></p></td><td><p>A <code>LocalTime</code>, a time format without a time zone.</p></td></tr><tr><td><p><code>date</code></p></td><td><p>A <code>Date</code>.</p></td></tr></tbody></table>

### Example

This example concatenates `LocalTime` and `Date` objects to return a `LocalDateTime`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "LocalDateTime" : (|23:57:59| ++ |2003-10-01|) }
```

#### Output

```JSON
{ "LocalDateTime": "2017-10-01T23:57:59" }
```

## ++(date: Date, time: Time): DateTime

Appends a `Date` to a `Time` in order to return a `DateTime`.

Note that the order in which the two objects are concatenated is irrelevant, so logically, `Date` +
`Time` produces the same result as `Time` + `Date`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><p>A <code>Date</code>.</p></td></tr><tr><td><p><code>time</code></p></td><td><p>A <code>Time</code>, a time format that can include a time zone (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `Date` and `Time` objects to return a `DateTime`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ |2017-10-01| ++ |23:57:59-03:00|, |2017-10-01| ++ |23:57:59Z| ]
```

#### Output

```JSON
[ "2017-10-01T23:57:59-03:00", "2017-10-01T23:57:59Z" ]
```

## ++(time: Time, date: Date): DateTime

Appends a `Date` to a `Time` object to return a `DateTime`.

Note that the order in which the two objects are concatenated is irrelevant, so logically, `Date` +
`Time` produces the same result as a `Time` + `Date`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>time</code></p></td><td><p>A <code>Time</code>, a time format that can include a time zone (<code>Z</code> or <code>HH:mm</code>).</p></td></tr><tr><td><p><code>date</code></p></td><td><p>A <code>Date</code>.</p></td></tr></tbody></table>

### Example

This example concatenates a `Date` with a `Time` to output a `DateTime`. Notice that the inputs are
surrounded by pipes (`|`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
|2018-11-30| ++ |23:57:59+01:00|
```

#### Output

```JSON
"2018-11-30T23:57:59+01:00"
```

### Example

This example concatenates `Time` and `Date` objects to return `DateTime` objects. Note that the
first `LocalTime` ``object is coerced to a `Time``. Notice that the order of the date and time
inputs does not change the order of the output `DateTime`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  "DateTime1" : (|23:57:59| as Time) ++ |2017-10-01|,
  "DateTime2" : |23:57:59Z| ++ |2017-10-01|,
  "DateTime3" : |2017-10-01| ++ |23:57:59+02:00|
}
```

#### Output

```JSON
{
  "DateTime1": "2017-10-01T23:57:59Z",
  "DateTime2": "2017-10-01T23:57:59Z",
  "DateTime3": "2017-10-01T23:57:59+02:00"
}
```

## ++(date: Date, timezone: TimeZone): DateTime

Appends a `TimeZone` to a `Date` type value and returns a `DateTime` result.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><p>A <code>Date</code>.</p></td></tr><tr><td><p><code>timezone</code></p></td><td><p>A <code>TimeZone</code> (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `Date` and `TimeZone` (`-03:00`) to return a `DateTime`. Note the local
time in the `DateTime` is `00:00:00` (midnight).

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "DateTime" : (|2017-10-01| ++ |-03:00|) }
```

#### Output

```JSON
{ "DateTime": "2017-10-01T00:00:00-03:00" }
```

## ++(timezone: TimeZone, date: Date): DateTime

Appends a `Date` to a `TimeZone` in order to return a `DateTime`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><p>A <code>Date</code>.</p></td></tr><tr><td><p><code>timezone</code></p></td><td><p>A <code>TimeZone</code> (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `TimeZone` (`-03:00`) and `Date` to return a `DateTime`. Note the local
time in the `DateTime` is `00:00:00` (midnight).

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "DateTime" : |-03:00| ++ |2017-10-01| }
```

#### Output

```JSON
{ "DateTime": "2017-10-01T00:00:00-03:00" }
```

## ++(dateTime: LocalDateTime, timezone: TimeZone): DateTime

Appends a `TimeZone` to a `LocalDateTime` in order to return a `DateTime`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><p>A <code>LocalDateTime</code>, a date and time without a time zone.</p></td></tr><tr><td><p><code>timezone</code></p></td><td><p>A <code>TimeZone</code> (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `LocalDateTime` and `TimeZone` (`-03:00`) to return a `DateTime`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "DateTime" : (|2003-10-01T23:57:59| ++ |-03:00|) }
```

#### Output

```JSON
{ "DateTime": "2003-10-01T23:57:59-03:00 }
```

## ++(timezone: TimeZone, datetime: LocalDateTime): DateTime

Appends a `LocalDateTime` to a `TimeZone` in order to return a `DateTime`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><p>A <code>LocalDateTime</code>, a date and time without a time zone.</p></td></tr><tr><td><p><code>timezone</code></p></td><td><p>A <code>TimeZone</code> (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `TimeZone` (`-03:00`) and `LocalDateTime` to return a `DateTime`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "TimeZone" : (|-03:00| ++ |2003-10-01T23:57:59|) }
```

#### Output

```JSON
{ "TimeZone": "2003-10-01T23:57:59-03:00" }
```

## ++(time: LocalTime, timezone: TimeZone): Time

Appends a `TimeZone` to a `LocalTime` in order to return a `Time`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>time</code></p></td><td><p>A <code>LocalTime</code>, time format without a time zone.</p></td></tr><tr><td><p><code>timezone</code></p></td><td><p>A <code>TimeZone</code> (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `LocalTime` and `TimeZone` (`-03:00`) to return a `Time`. Note that the
output returns\`:00\` for the unspecified seconds.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "Time" : (|23:57| ++ |-03:00|) }
```

#### Output

```JSON
{ "Time": "23:57:00-03:00" }
```

## ++(timezone: TimeZone, time: LocalTime): Time

Appends a `LocalTime` to a `TimeZone` in order to return a `Time`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>time</code></p></td><td><p>A <code>LocalTime</code>, a time format without a time zone.</p></td></tr><tr><td><p><code>timezone</code></p></td><td><p>A <code>TimeZone</code> (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `TimeZone` (`-03:00`) and `LocalTime` to return a `Time`. Note that the
output returns\`:00\` for the unspecified seconds.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "Time" : (|-03:00| ++ |23:57|) }
```

#### Output

```JSON
{
  "Time": "23:57:00-03:00"
}
```

<!-- document id=391dea0bcead38b7ffd77fbbb7f065ec6529b5543eddd3aa86c9a4acfcca3e34 url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-plusplus.md -->

---
product: DataWeave
version: 2.9
---

# ++

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## ++<S, T>(source: Array<S>, with: Array<T>): Array<S | T>

Concatenates two values.

This version of `++` concatenates the elements of two arrays into a new array. Other versions act on
strings, objects, and the various date and time formats that DataWeave supports.

If the two arrays contain different types of elements, the resulting array is all of `S` type
elements of `Array<S>` followed by all the `T` type elements of `Array<T>`. Either of the arrays can
also have mixed-type elements. Also note that the arrays can contain any supported data type.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The source array.</p></td></tr><tr><td><p><code>with</code></p></td><td><p>The array to concatenate with the source array.</p></td></tr></tbody></table>

### Example

The example concatenates an `Array<Number>` with an `Array<String>`. Notice that it outputs the
result as the value of a JSON object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "result" : [0, 1, 2] ++ ["a", "b", "c"] }
```

#### Output

```JSON
{ "result": [0, 1, 2, "a", "b", "c"] }
```

### Example

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "a" : [0, 1, true, "my string"] ++ [2, [3,4,5], {"a": 6}] }
```

#### Output

```JSON
{ "a": [0, 1, true, "my string", 2, [3, 4, 5], { "a": 6}] }
```

## ++(source: String, with: String): String

Concatenates the characters of two strings.

Strings are treated as arrays of characters, so the `++` operator concatenates the characters of
each string as if they were arrays of single-character string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The source string.</p></td></tr><tr><td><p><code>with</code></p></td><td><p>The string to concatenate with the source string.</p></td></tr></tbody></table>

### Example

This example concatenates two strings. Here, `Mule` is treated as
`Array<String> ["M", "u", "l", "e"]`. Notice that the example outputs the result `MuleSoft` as the
value of a JSON object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "name" : "Mule" ++ "Soft" }
```

#### Output

```JSON
{ "name": "MuleSoft" }
```

## ++<T <: Object, Q <: Object>(source: T, with: Q): T & Q

Concatenates two objects and returns one flattened object.

The `++` operator extracts all the key-values pairs from each object, then combines them together
into one result object.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The source object.</p></td></tr><tr><td><p><code>with</code></p></td><td><p>The object to concatenate with the source object.</p></td></tr></tbody></table>

### Example

This example concatenates two objects and transforms them to XML. Notice that it flattens the array
of objects `{aa: "a", bb: "b"}` into separate XML elements and that the output uses the keys of the
specified JSON objects as XML elements and the values of those objects as XML values.

#### Source

```DataWeave
%dw 2.0
output application/xml
---
{ concat : {aa: "a", bb: "b"} ++ {cc: "c"} }
```

#### Output

```XML
<?xml version="1.0" encoding="UTF-8"?>
<concat>
  <aa>a</aa>
  <bb>b</bb>
  <cc>c</cc>
</concat>
```

## ++(date: Date, time: LocalTime): LocalDateTime

Appends a `LocalTime` with a `Date` to return a `LocalDateTime` value.

`Date` and `LocalTime` instances are written in standard Java notation, surrounded by pipe (`|`)
symbols. The result is a `LocalDateTime` object in the standard Java format. Note that the order in
which the two objects are concatenated is irrelevant, so logically,
``Date LocalTime` produces the same result as `LocalTime Date``.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><p>A <code>Date</code>.</p></td></tr><tr><td><p><code>time</code></p></td><td><p>A <code>LocalTime</code>, a time format without a time zone.</p></td></tr></tbody></table>

### Example

This example concatenates a `Date` and `LocalTime` object to return a `LocalDateTime`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "LocalDateTime" : (|2017-10-01| ++ |23:57:59|) }
```

#### Output

```JSON
{ "LocalDateTime": "2017-10-01T23:57:59" }
```

## ++(time: LocalTime, date: Date): LocalDateTime

Appends a `LocalTime` with a `Date` to return a `LocalDateTime`.

Note that the order in which the two objects are concatenated is irrelevant, so logically,
``LocalTime Date` produces the same result as `Date LocalTime``.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>time</code></p></td><td><p>A <code>LocalTime</code>, a time format without a time zone.</p></td></tr><tr><td><p><code>date</code></p></td><td><p>A <code>Date</code>.</p></td></tr></tbody></table>

### Example

This example concatenates `LocalTime` and `Date` objects to return a `LocalDateTime`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "LocalDateTime" : (|23:57:59| ++ |2003-10-01|) }
```

#### Output

```JSON
{ "LocalDateTime": "2017-10-01T23:57:59" }
```

## ++(date: Date, time: Time): DateTime

Appends a `Date` to a `Time` in order to return a `DateTime`.

Note that the order in which the two objects are concatenated is irrelevant, so logically, `Date` +
`Time` produces the same result as `Time` + `Date`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><p>A <code>Date</code>.</p></td></tr><tr><td><p><code>time</code></p></td><td><p>A <code>Time</code>, a time format that can include a time zone (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `Date` and `Time` objects to return a `DateTime`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ |2017-10-01| ++ |23:57:59-03:00|, |2017-10-01| ++ |23:57:59Z| ]
```

#### Output

```JSON
[ "2017-10-01T23:57:59-03:00", "2017-10-01T23:57:59Z" ]
```

## ++(time: Time, date: Date): DateTime

Appends a `Date` to a `Time` object to return a `DateTime`.

Note that the order in which the two objects are concatenated is irrelevant, so logically, `Date` +
`Time` produces the same result as a `Time` + `Date`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>time</code></p></td><td><p>A <code>Time</code>, a time format that can include a time zone (<code>Z</code> or <code>HH:mm</code>).</p></td></tr><tr><td><p><code>date</code></p></td><td><p>A <code>Date</code>.</p></td></tr></tbody></table>

### Example

This example concatenates a `Date` with a `Time` to output a `DateTime`. Notice that the inputs are
surrounded by pipes (`|`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
|2018-11-30| ++ |23:57:59+01:00|
```

#### Output

```JSON
"2018-11-30T23:57:59+01:00"
```

### Example

This example concatenates `Time` and `Date` objects to return `DateTime` objects. Note that the
first `LocalTime` ``object is coerced to a `Time``. Notice that the order of the date and time
inputs does not change the order of the output `DateTime`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  "DateTime1" : (|23:57:59| as Time) ++ |2017-10-01|,
  "DateTime2" : |23:57:59Z| ++ |2017-10-01|,
  "DateTime3" : |2017-10-01| ++ |23:57:59+02:00|
}
```

#### Output

```JSON
{
  "DateTime1": "2017-10-01T23:57:59Z",
  "DateTime2": "2017-10-01T23:57:59Z",
  "DateTime3": "2017-10-01T23:57:59+02:00"
}
```

## ++(date: Date, timezone: TimeZone): DateTime

Appends a `TimeZone` to a `Date` type value and returns a `DateTime` result.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><p>A <code>Date</code>.</p></td></tr><tr><td><p><code>timezone</code></p></td><td><p>A <code>TimeZone</code> (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `Date` and `TimeZone` (`-03:00`) to return a `DateTime`. Note the local
time in the `DateTime` is `00:00:00` (midnight).

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "DateTime" : (|2017-10-01| ++ |-03:00|) }
```

#### Output

```JSON
{ "DateTime": "2017-10-01T00:00:00-03:00" }
```

## ++(timezone: TimeZone, date: Date): DateTime

Appends a `Date` to a `TimeZone` in order to return a `DateTime`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><p>A <code>Date</code>.</p></td></tr><tr><td><p><code>timezone</code></p></td><td><p>A <code>TimeZone</code> (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `TimeZone` (`-03:00`) and `Date` to return a `DateTime`. Note the local
time in the `DateTime` is `00:00:00` (midnight).

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "DateTime" : |-03:00| ++ |2017-10-01| }
```

#### Output

```JSON
{ "DateTime": "2017-10-01T00:00:00-03:00" }
```

## ++(dateTime: LocalDateTime, timezone: TimeZone): DateTime

Appends a `TimeZone` to a `LocalDateTime` in order to return a `DateTime`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><p>A <code>LocalDateTime</code>, a date and time without a time zone.</p></td></tr><tr><td><p><code>timezone</code></p></td><td><p>A <code>TimeZone</code> (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `LocalDateTime` and `TimeZone` (`-03:00`) to return a `DateTime`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "DateTime" : (|2003-10-01T23:57:59| ++ |-03:00|) }
```

#### Output

```JSON
{ "DateTime": "2003-10-01T23:57:59-03:00 }
```

## ++(timezone: TimeZone, datetime: LocalDateTime): DateTime

Appends a `LocalDateTime` to a `TimeZone` in order to return a `DateTime`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><p>A <code>LocalDateTime</code>, a date and time without a time zone.</p></td></tr><tr><td><p><code>timezone</code></p></td><td><p>A <code>TimeZone</code> (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `TimeZone` (`-03:00`) and `LocalDateTime` to return a `DateTime`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "TimeZone" : (|-03:00| ++ |2003-10-01T23:57:59|) }
```

#### Output

```JSON
{ "TimeZone": "2003-10-01T23:57:59-03:00" }
```

## ++(time: LocalTime, timezone: TimeZone): Time

Appends a `TimeZone` to a `LocalTime` in order to return a `Time`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>time</code></p></td><td><p>A <code>LocalTime</code>, time format without a time zone.</p></td></tr><tr><td><p><code>timezone</code></p></td><td><p>A <code>TimeZone</code> (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `LocalTime` and `TimeZone` (`-03:00`) to return a `Time`. Note that the
output returns\`:00\` for the unspecified seconds.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "Time" : (|23:57| ++ |-03:00|) }
```

#### Output

```JSON
{ "Time": "23:57:00-03:00" }
```

## ++(timezone: TimeZone, time: LocalTime): Time

Appends a `LocalTime` to a `TimeZone` in order to return a `Time`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>time</code></p></td><td><p>A <code>LocalTime</code>, a time format without a time zone.</p></td></tr><tr><td><p><code>timezone</code></p></td><td><p>A <code>TimeZone</code> (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `TimeZone` (`-03:00`) and `LocalTime` to return a `Time`. Note that the
output returns\`:00\` for the unspecified seconds.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "Time" : (|-03:00| ++ |23:57|) }
```

#### Output

```JSON
{
  "Time": "23:57:00-03:00"
}
```

<!-- document id=e95fb682cd3b3325d490c90ec526d9e03daeb898e400803a5108d26608f18890 url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-plusplus.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# ++

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## ++<S, T>(source: Array<S>, with: Array<T>): Array<S | T>

Concatenates two values.

This version of `++` concatenates the elements of two arrays into a new array. Other versions act on
strings, objects, and the various date and time formats that DataWeave supports.

If the two arrays contain different types of elements, the resulting array is all of `S` type
elements of `Array<S>` followed by all the `T` type elements of `Array<T>`. Either of the arrays can
also have mixed-type elements. Also note that the arrays can contain any supported data type.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The source array.</p></td></tr><tr><td><p><code>with</code></p></td><td><p>The array to concatenate with the source array.</p></td></tr></tbody></table>

### Example

The example concatenates an `Array<Number>` with an `Array<String>`. Notice that it outputs the
result as the value of a JSON object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "result" : [0, 1, 2] ++ ["a", "b", "c"] }
```

#### Output

```JSON
{ "result": [0, 1, 2, "a", "b", "c"] }
```

### Example

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "a" : [0, 1, true, "my string"] ++ [2, [3,4,5], {"a": 6}] }
```

#### Output

```JSON
{ "a": [0, 1, true, "my string", 2, [3, 4, 5], { "a": 6}] }
```

## ++(source: String, with: String): String

Concatenates the characters of two strings.

Strings are treated as arrays of characters, so the `++` operator concatenates the characters of
each string as if they were arrays of single-character string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The source string.</p></td></tr><tr><td><p><code>with</code></p></td><td><p>The string to concatenate with the source string.</p></td></tr></tbody></table>

### Example

This example concatenates two strings. Here, `Mule` is treated as
`Array<String> ["M", "u", "l", "e"]`. Notice that the example outputs the result `MuleSoft` as the
value of a JSON object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "name" : "Mule" ++ "Soft" }
```

#### Output

```JSON
{ "name": "MuleSoft" }
```

## ++<T <: Object, Q <: Object>(source: T, with: Q): T & Q

Concatenates two objects and returns one flattened object.

The `++` operator extracts all the key-values pairs from each object, then combines them together
into one result object.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The source object.</p></td></tr><tr><td><p><code>with</code></p></td><td><p>The object to concatenate with the source object.</p></td></tr></tbody></table>

### Example

This example concatenates two objects and transforms them to XML. Notice that it flattens the array
of objects `{aa: "a", bb: "b"}` into separate XML elements and that the output uses the keys of the
specified JSON objects as XML elements and the values of those objects as XML values.

#### Source

```DataWeave
%dw 2.0
output application/xml
---
{ concat : {aa: "a", bb: "b"} ++ {cc: "c"} }
```

#### Output

```XML
<?xml version="1.0" encoding="UTF-8"?>
<concat>
  <aa>a</aa>
  <bb>b</bb>
  <cc>c</cc>
</concat>
```

## ++(date: Date, time: LocalTime): LocalDateTime

Appends a `LocalTime` with a `Date` to return a `LocalDateTime` value.

`Date` and `LocalTime` instances are written in standard Java notation, surrounded by pipe (`|`)
symbols. The result is a `LocalDateTime` object in the standard Java format. Note that the order in
which the two objects are concatenated is irrelevant, so logically,
``Date LocalTime` produces the same result as `LocalTime Date``.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><p>A <code>Date</code>.</p></td></tr><tr><td><p><code>time</code></p></td><td><p>A <code>LocalTime</code>, a time format without a time zone.</p></td></tr></tbody></table>

### Example

This example concatenates a `Date` and `LocalTime` object to return a `LocalDateTime`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "LocalDateTime" : (|2017-10-01| ++ |23:57:59|) }
```

#### Output

```JSON
{ "LocalDateTime": "2017-10-01T23:57:59" }
```

## ++(time: LocalTime, date: Date): LocalDateTime

Appends a `LocalTime` with a `Date` to return a `LocalDateTime`.

Note that the order in which the two objects are concatenated is irrelevant, so logically,
``LocalTime Date` produces the same result as `Date LocalTime``.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>time</code></p></td><td><p>A <code>LocalTime</code>, a time format without a time zone.</p></td></tr><tr><td><p><code>date</code></p></td><td><p>A <code>Date</code>.</p></td></tr></tbody></table>

### Example

This example concatenates `LocalTime` and `Date` objects to return a `LocalDateTime`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "LocalDateTime" : (|23:57:59| ++ |2003-10-01|) }
```

#### Output

```JSON
{ "LocalDateTime": "2017-10-01T23:57:59" }
```

## ++(date: Date, time: Time): DateTime

Appends a `Date` to a `Time` in order to return a `DateTime`.

Note that the order in which the two objects are concatenated is irrelevant, so logically, `Date` +
`Time` produces the same result as `Time` + `Date`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><p>A <code>Date</code>.</p></td></tr><tr><td><p><code>time</code></p></td><td><p>A <code>Time</code>, a time format that can include a time zone (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `Date` and `Time` objects to return a `DateTime`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ |2017-10-01| ++ |23:57:59-03:00|, |2017-10-01| ++ |23:57:59Z| ]
```

#### Output

```JSON
[ "2017-10-01T23:57:59-03:00", "2017-10-01T23:57:59Z" ]
```

## ++(time: Time, date: Date): DateTime

Appends a `Date` to a `Time` object to return a `DateTime`.

Note that the order in which the two objects are concatenated is irrelevant, so logically, `Date` +
`Time` produces the same result as a `Time` + `Date`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>time</code></p></td><td><p>A <code>Time</code>, a time format that can include a time zone (<code>Z</code> or <code>HH:mm</code>).</p></td></tr><tr><td><p><code>date</code></p></td><td><p>A <code>Date</code>.</p></td></tr></tbody></table>

### Example

This example concatenates a `Date` with a `Time` to output a `DateTime`. Notice that the inputs are
surrounded by pipes (`|`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
|2018-11-30| ++ |23:57:59+01:00|
```

#### Output

```JSON
"2018-11-30T23:57:59+01:00"
```

### Example

This example concatenates `Time` and `Date` objects to return `DateTime` objects. Note that the
first `LocalTime` ``object is coerced to a `Time``. Notice that the order of the date and time
inputs does not change the order of the output `DateTime`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  "DateTime1" : (|23:57:59| as Time) ++ |2017-10-01|,
  "DateTime2" : |23:57:59Z| ++ |2017-10-01|,
  "DateTime3" : |2017-10-01| ++ |23:57:59+02:00|
}
```

#### Output

```JSON
{
  "DateTime1": "2017-10-01T23:57:59Z",
  "DateTime2": "2017-10-01T23:57:59Z",
  "DateTime3": "2017-10-01T23:57:59+02:00"
}
```

## ++(date: Date, timezone: TimeZone): DateTime

Appends a `TimeZone` to a `Date` type value and returns a `DateTime` result.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><p>A <code>Date</code>.</p></td></tr><tr><td><p><code>timezone</code></p></td><td><p>A <code>TimeZone</code> (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `Date` and `TimeZone` (`-03:00`) to return a `DateTime`. Note the local
time in the `DateTime` is `00:00:00` (midnight).

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "DateTime" : (|2017-10-01| ++ |-03:00|) }
```

#### Output

```JSON
{ "DateTime": "2017-10-01T00:00:00-03:00" }
```

## ++(timezone: TimeZone, date: Date): DateTime

Appends a `Date` to a `TimeZone` in order to return a `DateTime`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><p>A <code>Date</code>.</p></td></tr><tr><td><p><code>timezone</code></p></td><td><p>A <code>TimeZone</code> (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `TimeZone` (`-03:00`) and `Date` to return a `DateTime`. Note the local
time in the `DateTime` is `00:00:00` (midnight).

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "DateTime" : |-03:00| ++ |2017-10-01| }
```

#### Output

```JSON
{ "DateTime": "2017-10-01T00:00:00-03:00" }
```

## ++(dateTime: LocalDateTime, timezone: TimeZone): DateTime

Appends a `TimeZone` to a `LocalDateTime` in order to return a `DateTime`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><p>A <code>LocalDateTime</code>, a date and time without a time zone.</p></td></tr><tr><td><p><code>timezone</code></p></td><td><p>A <code>TimeZone</code> (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `LocalDateTime` and `TimeZone` (`-03:00`) to return a `DateTime`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "DateTime" : (|2003-10-01T23:57:59| ++ |-03:00|) }
```

#### Output

```JSON
{ "DateTime": "2003-10-01T23:57:59-03:00 }
```

## ++(timezone: TimeZone, datetime: LocalDateTime): DateTime

Appends a `LocalDateTime` to a `TimeZone` in order to return a `DateTime`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><p>A <code>LocalDateTime</code>, a date and time without a time zone.</p></td></tr><tr><td><p><code>timezone</code></p></td><td><p>A <code>TimeZone</code> (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `TimeZone` (`-03:00`) and `LocalDateTime` to return a `DateTime`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "TimeZone" : (|-03:00| ++ |2003-10-01T23:57:59|) }
```

#### Output

```JSON
{ "TimeZone": "2003-10-01T23:57:59-03:00" }
```

## ++(time: LocalTime, timezone: TimeZone): Time

Appends a `TimeZone` to a `LocalTime` in order to return a `Time`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>time</code></p></td><td><p>A <code>LocalTime</code>, time format without a time zone.</p></td></tr><tr><td><p><code>timezone</code></p></td><td><p>A <code>TimeZone</code> (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `LocalTime` and `TimeZone` (`-03:00`) to return a `Time`. Note that the
output returns\`:00\` for the unspecified seconds.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "Time" : (|23:57| ++ |-03:00|) }
```

#### Output

```JSON
{ "Time": "23:57:00-03:00" }
```

## ++(timezone: TimeZone, time: LocalTime): Time

Appends a `LocalTime` to a `TimeZone` in order to return a `Time`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>time</code></p></td><td><p>A <code>LocalTime</code>, a time format without a time zone.</p></td></tr><tr><td><p><code>timezone</code></p></td><td><p>A <code>TimeZone</code> (<code>Z</code> or <code>HH:mm</code>).</p></td></tr></tbody></table>

### Example

This example concatenates `TimeZone` (`-03:00`) and `LocalTime` to return a `Time`. Note that the
output returns\`:00\` for the unspecified seconds.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "Time" : (|-03:00| ++ |23:57|) }
```

#### Output

```JSON
{
  "Time": "23:57:00-03:00"
}
```

<!-- document id=7de49e463d578a7dc2a244e319c63d39fd92842a5aee5ccef457eae181f5a8fb url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-abs.md -->

---
product: DataWeave
version: 2.11
---

# abs

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## abs(number: Number): Number

Returns the absolute value of a number.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the absolute value of the specified numbers.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ abs(-2), abs(2.5), abs(-3.4), abs(3) ]
```

#### Output

```JSON
[ 2, 2.5, 3.4, 3 ]
```

<!-- document id=5d7a4d6f6e543dcbf3a61ad948a46e2ccee57f1bfdd8eeaa36295957769dbbad url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-abs.md -->

---
product: DataWeave
version: 2.12
---

# abs

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## abs(number: Number): Number

Returns the absolute value of a number.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the absolute value of the specified numbers.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ abs(-2), abs(2.5), abs(-3.4), abs(3) ]
```

#### Output

```JSON
[ 2, 2.5, 3.4, 3 ]
```

<!-- document id=2e09c35de3325365dc4fccd9c3ae61aa24e15c98743a2d8733379558b2998ebd url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-abs.md -->

---
product: DataWeave
version: 2.3
---

# abs

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## abs(Number): Number

Returns the absolute value of a number.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to apply the operation to.</p></td></tr></tbody></table>

### Example

This example returns the absolute value of the specified numbers.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ abs(-2), abs(2.5), abs(-3.4), abs(3) ]
```

#### Output

```JSON
[ 2, 2.5, 3.4, 3 ]
```

<!-- document id=af8b0a32c6da5c5a26d768c671c763da8095c0aa17e27f78d3085dc69486bed0 url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-abs.md -->

---
product: DataWeave
version: 2.4
---

# abs

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## abs(number: Number): Number

Returns the absolute value of a number.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the absolute value of the specified numbers.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ abs(-2), abs(2.5), abs(-3.4), abs(3) ]
```

#### Output

```JSON
[ 2, 2.5, 3.4, 3 ]
```

<!-- document id=990170e318a1d9b7ff31daa2ebb0e2f51f993d1138a9d0fddcece74f80dc9a9f url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-abs.md -->

---
product: DataWeave
version: 2.6
---

# abs

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## abs(number: Number): Number

Returns the absolute value of a number.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the absolute value of the specified numbers.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ abs(-2), abs(2.5), abs(-3.4), abs(3) ]
```

#### Output

```JSON
[ 2, 2.5, 3.4, 3 ]
```

<!-- document id=cadb7f51c3dd12af8dde6140c872ab4bb9c8e7c974430b5f474ef472efc189d7 url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-abs.md -->

---
product: DataWeave
version: 2.9
---

# abs

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## abs(number: Number): Number

Returns the absolute value of a number.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the absolute value of the specified numbers.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ abs(-2), abs(2.5), abs(-3.4), abs(3) ]
```

#### Output

```JSON
[ 2, 2.5, 3.4, 3 ]
```

<!-- document id=e4940183810383d2f1e790817985c209da56986b4066fc20379e3688c659d5bc url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-abs.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# abs

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## abs(number: Number): Number

Returns the absolute value of a number.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the absolute value of the specified numbers.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ abs(-2), abs(2.5), abs(-3.4), abs(3) ]
```

#### Output

```JSON
[ 2, 2.5, 3.4, 3 ]
```

<!-- document id=2b0eb5ee819a3d893d2997f1062156f3593ea4de68a643afe6c500f858ec67b7 url=/mulesoft/current/en-us/dataweave/2.11/dw-math-functions-acos.md -->

---
product: DataWeave
version: 2.11
---

# acos

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## acos(angle: Number): Number | NaN

Returns an arc cosine value that can range from `0.0` through pi.

If the absolute value of the input is greater than `1`, the result is `null`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>angle</code></p></td><td><div><div><p>Number to convert into it arc cosine value.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `acos` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
  "acos0": acos(0),
  "acos13": acos(0.13),
  "acos-1": acos(-1),
  "acos1": acos(1),
  "acos1.1": acos(1.1)
}
```

#### Output

```Json
{
   "acos0": 1.5707963267948966,
   "acos13": 1.440427347091751,
   "acos-1": 3.141592653589793,
   "acos1": 0.0,
   "acos1.1": null
 }
```

<!-- document id=c7e7127d297c24fa1912dba55fed0f571e57efb87c968eedfb723f88db58fd39 url=/mulesoft/current/en-us/dataweave/2.12/dw-math-functions-acos.md -->

---
product: DataWeave
version: 2.12
---

# acos

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## acos(angle: Number): Number | NaN

Returns an arc cosine value that can range from `0.0` through pi.

If the absolute value of the input is greater than `1`, the result is `null`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>angle</code></p></td><td><div><div><p>Number to convert into it arc cosine value.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `acos` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
  "acos0": acos(0),
  "acos13": acos(0.13),
  "acos-1": acos(-1),
  "acos1": acos(1),
  "acos1.1": acos(1.1)
}
```

#### Output

```Json
{
   "acos0": 1.5707963267948966,
   "acos13": 1.440427347091751,
   "acos-1": 3.141592653589793,
   "acos1": 0.0,
   "acos1.1": null
 }
```

<!-- document id=def2f3f22e23cfa8022040550db1f4db0e7d665520e783a562d95567aae26dce url=/mulesoft/current/en-us/dataweave/2.4/dw-math-functions-acos.md -->

---
product: DataWeave
version: 2.4
---

# acos

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## acos(angle: Number): Number | NaN

Returns an arc cosine value that can range from `0.0` through pi.

If the absolute value of the input is greater than `1`, the result is `null`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>angle</code></p></td><td><div><div><p>Number to convert into it arc cosine value.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `acos` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
  "acos0": acos(0),
  "acos13": acos(0.13),
  "acos-1": acos(-1),
  "acos1": acos(1),
  "acos1.1": acos(1.1)
}
```

#### Output

```Json
{
   "acos0": 1.5707963267948966,
   "acos13": 1.440427347091751,
   "acos-1": 3.141592653589793,
   "acos1": 0.0,
   "acos1.1": null
 }
```

<!-- document id=f97dbba06c4e0129bc6dfbedaf786bbd7d8f9328d5397b6ff8a8928498365a05 url=/mulesoft/current/en-us/dataweave/2.6/dw-math-functions-acos.md -->

---
product: DataWeave
version: 2.6
---

# acos

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## acos(angle: Number): Number | NaN

Returns an arc cosine value that can range from `0.0` through pi.

If the absolute value of the input is greater than `1`, the result is `null`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>angle</code></p></td><td><div><div><p>Number to convert into it arc cosine value.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `acos` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
  "acos0": acos(0),
  "acos13": acos(0.13),
  "acos-1": acos(-1),
  "acos1": acos(1),
  "acos1.1": acos(1.1)
}
```

#### Output

```Json
{
   "acos0": 1.5707963267948966,
   "acos13": 1.440427347091751,
   "acos-1": 3.141592653589793,
   "acos1": 0.0,
   "acos1.1": null
 }
```

<!-- document id=9c74d57982198b8cde6b422dbd86a3c6f58eeddf2505ddfe878ce64fdbb013dc url=/mulesoft/current/en-us/dataweave/2.9/dw-math-functions-acos.md -->

---
product: DataWeave
version: 2.9
---

# acos

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## acos(angle: Number): Number | NaN

Returns an arc cosine value that can range from `0.0` through pi.

If the absolute value of the input is greater than `1`, the result is `null`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>angle</code></p></td><td><div><div><p>Number to convert into it arc cosine value.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `acos` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
  "acos0": acos(0),
  "acos13": acos(0.13),
  "acos-1": acos(-1),
  "acos1": acos(1),
  "acos1.1": acos(1.1)
}
```

#### Output

```Json
{
   "acos0": 1.5707963267948966,
   "acos13": 1.440427347091751,
   "acos-1": 3.141592653589793,
   "acos1": 0.0,
   "acos1.1": null
 }
```

<!-- document id=43197759d9f90f89e821a9ce45af8ff5086815e8ffa603aecf038c24191325a3 url=/mulesoft/current/en-us/dataweave/latest/dw-math-functions-acos.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# acos

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## acos(angle: Number): Number | NaN

Returns an arc cosine value that can range from `0.0` through pi.

If the absolute value of the input is greater than `1`, the result is `null`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>angle</code></p></td><td><div><div><p>Number to convert into it arc cosine value.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `acos` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
  "acos0": acos(0),
  "acos13": acos(0.13),
  "acos-1": acos(-1),
  "acos1": acos(1),
  "acos1.1": acos(1.1)
}
```

#### Output

```Json
{
   "acos0": 1.5707963267948966,
   "acos13": 1.440427347091751,
   "acos-1": 3.141592653589793,
   "acos1": 0.0,
   "acos1.1": null
 }
```

<!-- document id=9bc0d0e7de34f98aac4c1590577dd02b76d87eed74e836be03ee73fa1249787c url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook-add-and-subtract-time.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, transform, transformer, format, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Add and Subtract Time

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example shows multiple addition and subtraction operations that deal with date and
time types.

The examples use:

- `as` function to coerce a String to Period type

- `P<date>T<time>` for the Period data type, which provides designators for years, months, days,
  hours, minutes, and seconds  
  For example, `|P2Y9M1D|` refers to a period of two years, nine months, and one day, and
  `|PT5H4M3S|` indicates a time period of five hours, four minutes, and three seconds.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
var numberOfDays = 3
---
{
  oneDayBefore: |2019-10-01T23:57:59Z| - |P1D|,
  threeDaysBefore: |2019-10-01T23:57:59Z| - ("P$(numberOfDays)D" as Period),
  a: |2019-10-01| - |P1Y|,
  b: |P1Y| - |2019-10-01|,
  c: |2019-10-01T23:57:59Z| - |P1Y|,
  d: |2019-10-01T23:57:59Z| + |P1Y|,
  e: |2019-10-01T23:57:59| - |P1Y|,
  f: |PT9M| - |23:59:56|,
  g: |23:59:56| + |PT9M|,
  h: |23:59:56-03:00| - |PT9M|,
  u: |23:59:56-03:00| - |22:59:56-03:00|,
  j: |23:59:56-03:00| - |22:59:56-00:00|,
  k: |2019-10-01T23:57:59| - |P2Y9M1D| - |PT57M59S| + |PT2H|,
  l: |23:59:56| - |22:59:56|,
  o: |2019-10-01| - |2018-09-23|,
  p: |2019-10-01T23:57:59Z| - |2018-10-01T23:57:59Z|,
  q: |2019-10-01T23:57:59| - |2018-10-01T23:57:59|
}
```

Output JSON:

```json
{
  "oneDayBefore": "2019-09-30T23:57:59Z",
  "threeDaysBefore": "2019-09-28T23:57:59Z",
  "a": "2018-10-01",
  "b": "2018-10-01",
  "c": "2018-10-01T23:57:59Z",
  "d": "2020-10-01T23:57:59Z",
  "e": "2018-10-01T23:57:59",
  "f": "23:50:56",
  "g": "00:08:56",
  "h": "23:50:56-03:00",
  "u": "PT1H",
  "j": "PT4H",
  "k": "2017-01-01T01:00:00",
  "l": "PT1H",
  "o": "PT8952H",
  "p": "PT8760H",
  "q": "PT8760H"
}
```

Note that the behavior of `o: |2019-10-01| - |2018-09-23|` changed in Mule 4.3.0. DataWeave 2.3.0,
which is supported by Mule 4.3.0, returns `"o": "PT8952H"`. DataWeave 2.2.0, which is supported by
Mule 4.2.0, returns `"o": "P1Y8D"`. To restore the 2.2.0 behavior, you can set the
`-M-Dcom.mulesoft.dw.date_minus_back_compatibility=true`. However, the setting does not affect the
Preview window in Studio. For guidance with this setting in Studio and on-prem deployments, see
[System Properties](https://docs.mulesoft.com/mule-runtime/latest/mule-app-properties-system). For CloudHub deployments,
see [Manage Properties for Applications on CloudHub](https://docs.mulesoft.com/cloudhub/cloudhub-manage-props).

## See Also

- [Period](https://docs.mulesoft.com/dataweave/2.11/dataweave-types#dw_type_dates_period)

- [Parse Dates](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-parse-dates)

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.11/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.11/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook)

<!-- document id=c0cbacef7e1c41f3e00f7fcf9a21e38ebd85b412719fadf18176d0d7856857e0 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook-add-and-subtract-time.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, transform, transformer, format, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Add and Subtract Time

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example shows multiple addition and subtraction operations that deal with date and
time types.

The examples use:

- `as` function to coerce a String to Period type

- `P<date>T<time>` for the Period data type, which provides designators for years, months, days,
  hours, minutes, and seconds  
  For example, `|P2Y9M1D|` refers to a period of two years, nine months, and one day, and
  `|PT5H4M3S|` indicates a time period of five hours, four minutes, and three seconds.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
var numberOfDays = 3
---
{
  oneDayBefore: |2019-10-01T23:57:59Z| - |P1D|,
  threeDaysBefore: |2019-10-01T23:57:59Z| - ("P$(numberOfDays)D" as Period),
  a: |2019-10-01| - |P1Y|,
  b: |P1Y| - |2019-10-01|,
  c: |2019-10-01T23:57:59Z| - |P1Y|,
  d: |2019-10-01T23:57:59Z| + |P1Y|,
  e: |2019-10-01T23:57:59| - |P1Y|,
  f: |PT9M| - |23:59:56|,
  g: |23:59:56| + |PT9M|,
  h: |23:59:56-03:00| - |PT9M|,
  u: |23:59:56-03:00| - |22:59:56-03:00|,
  j: |23:59:56-03:00| - |22:59:56-00:00|,
  k: |2019-10-01T23:57:59| - |P2Y9M1D| - |PT57M59S| + |PT2H|,
  l: |23:59:56| - |22:59:56|,
  o: |2019-10-01| - |2018-09-23|,
  p: |2019-10-01T23:57:59Z| - |2018-10-01T23:57:59Z|,
  q: |2019-10-01T23:57:59| - |2018-10-01T23:57:59|
}
```

Output JSON:

```json
{
  "oneDayBefore": "2019-09-30T23:57:59Z",
  "threeDaysBefore": "2019-09-28T23:57:59Z",
  "a": "2018-10-01",
  "b": "2018-10-01",
  "c": "2018-10-01T23:57:59Z",
  "d": "2020-10-01T23:57:59Z",
  "e": "2018-10-01T23:57:59",
  "f": "23:50:56",
  "g": "00:08:56",
  "h": "23:50:56-03:00",
  "u": "PT1H",
  "j": "PT4H",
  "k": "2017-01-01T01:00:00",
  "l": "PT1H",
  "o": "PT8952H",
  "p": "PT8760H",
  "q": "PT8760H"
}
```

Note that the behavior of `o: |2019-10-01| - |2018-09-23|` changed in Mule 4.3.0. DataWeave 2.3.0,
which is supported by Mule 4.3.0, returns `"o": "PT8952H"`. DataWeave 2.2.0, which is supported by
Mule 4.2.0, returns `"o": "P1Y8D"`. To restore the 2.2.0 behavior, you can set the
`-M-Dcom.mulesoft.dw.date_minus_back_compatibility=true`. However, the setting does not affect the
Preview window in Studio. For guidance with this setting in Studio and on-prem deployments, see
[System Properties](https://docs.mulesoft.com/mule-runtime/latest/mule-app-properties-system). For CloudHub deployments,
see [Manage Properties for Applications on CloudHub](https://docs.mulesoft.com/cloudhub/cloudhub-manage-props).

## See Also

- [Period](https://docs.mulesoft.com/dataweave/2.12/dataweave-types#dw_type_dates_period)

- [Parse Dates](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-parse-dates)

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.12/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.12/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook)

<!-- document id=76d9217f9311590fef7a0fe77f74bbab3be5cb73742f7b3b6b10874c798d770e url=/mulesoft/current/en-us/dataweave/2.3/dataweave-cookbook-add-and-subtract-time.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, transform, transformer, format, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Add and Subtract Time

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example shows multiple addition and subtraction operations that deal with date and
time types.

The examples use:

- `as` function to coerce a String to Period type

- `P<date>T<time>` for the Period data type, which provides designators for years, months, days,
  hours, minutes, and seconds  
  For example, `|P2Y9M1D|` refers to a period of two years, nine months, and one day, and
  `|PT5H4M3S|` indicates a time period of five hours, four minutes, and three seconds.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
var numberOfDays = 3
---
{
  oneDayBefore: |2019-10-01T23:57:59Z| - |P1D|,
  threeDaysBefore: |2019-10-01T23:57:59Z| - ("P$(numberOfDays)D" as Period),
  a: |2019-10-01| - |P1Y|,
  b: |P1Y| - |2019-10-01|,
  c: |2019-10-01T23:57:59Z| - |P1Y|,
  d: |2019-10-01T23:57:59Z| + |P1Y|,
  e: |2019-10-01T23:57:59| - |P1Y|,
  f: |PT9M| - |23:59:56|,
  g: |23:59:56| + |PT9M|,
  h: |23:59:56-03:00| - |PT9M|,
  u: |23:59:56-03:00| - |22:59:56-03:00|,
  j: |23:59:56-03:00| - |22:59:56-00:00|,
  k: |2019-10-01T23:57:59| - |P2Y9M1D| - |PT57M59S| + |PT2H|,
  l: |23:59:56| - |22:59:56|,
  o: |2019-10-01| - |2018-09-23|,
  p: |2019-10-01T23:57:59Z| - |2018-10-01T23:57:59Z|,
  q: |2019-10-01T23:57:59| - |2018-10-01T23:57:59|
}
```

Output JSON:

```json
{
  "oneDayBefore": "2019-09-30T23:57:59Z",
  "threeDaysBefore": "2019-09-28T23:57:59Z",
  "a": "2018-10-01",
  "b": "2018-10-01",
  "c": "2018-10-01T23:57:59Z",
  "d": "2020-10-01T23:57:59Z",
  "e": "2018-10-01T23:57:59",
  "f": "23:50:56",
  "g": "00:08:56",
  "h": "23:50:56-03:00",
  "u": "PT1H",
  "j": "PT4H",
  "k": "2017-01-01T01:00:00",
  "l": "PT1H",
  "o": "PT8952H",
  "p": "PT8760H",
  "q": "PT8760H"
}
```

Note that the behavior of `o: |2019-10-01| - |2018-09-23|` changed in Mule 4.3.0. DataWeave 2.3.0,
which is supported by Mule 4.3.0, returns `"o": "PT8952H"`. DataWeave 2.2.0, which is supported by
Mule 4.2.0, returns `"o": "P1Y8D"`. To restore the 2.2.0 behavior, you can set the
`-M-Dcom.mulesoft.dw.date_minus_back_compatibility=true`. However, the setting does not affect the
Preview window in Studio. For guidance with this setting in Studio and on-prem deployments, see
[System Properties](https://docs.mulesoft.com/mule-runtime/4.3/mule-app-properties-system). For CloudHub deployments,
see [Manage Properties for Applications on CloudHub](https://docs.mulesoft.com/cloudhub/cloudhub-manage-props).

## See Also

- [Period](https://docs.mulesoft.com/dataweave/2.3/dataweave-types#dw_type_dates_period)

- [Parse Dates](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-parse-dates)

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.3/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.3/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook)

<!-- document id=906d012ad650c2820be37e79ddabc2755b09e9cd387d7f898cdf0b0f28e5569e url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook-add-and-subtract-time.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, transform, transformer, format, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Add and Subtract Time

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example shows multiple addition and subtraction operations that deal with date and
time types.

The examples use:

- `as` function to coerce a String to Period type

- `P<date>T<time>` for the Period data type, which provides designators for years, months, days,
  hours, minutes, and seconds  
  For example, `|P2Y9M1D|` refers to a period of two years, nine months, and one day, and
  `|PT5H4M3S|` indicates a time period of five hours, four minutes, and three seconds.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
var numberOfDays = 3
---
{
  oneDayBefore: |2019-10-01T23:57:59Z| - |P1D|,
  threeDaysBefore: |2019-10-01T23:57:59Z| - ("P$(numberOfDays)D" as Period),
  a: |2019-10-01| - |P1Y|,
  b: |P1Y| - |2019-10-01|,
  c: |2019-10-01T23:57:59Z| - |P1Y|,
  d: |2019-10-01T23:57:59Z| + |P1Y|,
  e: |2019-10-01T23:57:59| - |P1Y|,
  f: |PT9M| - |23:59:56|,
  g: |23:59:56| + |PT9M|,
  h: |23:59:56-03:00| - |PT9M|,
  u: |23:59:56-03:00| - |22:59:56-03:00|,
  j: |23:59:56-03:00| - |22:59:56-00:00|,
  k: |2019-10-01T23:57:59| - |P2Y9M1D| - |PT57M59S| + |PT2H|,
  l: |23:59:56| - |22:59:56|,
  o: |2019-10-01| - |2018-09-23|,
  p: |2019-10-01T23:57:59Z| - |2018-10-01T23:57:59Z|,
  q: |2019-10-01T23:57:59| - |2018-10-01T23:57:59|
}
```

Output JSON:

```json
{
  "oneDayBefore": "2019-09-30T23:57:59Z",
  "threeDaysBefore": "2019-09-28T23:57:59Z",
  "a": "2018-10-01",
  "b": "2018-10-01",
  "c": "2018-10-01T23:57:59Z",
  "d": "2020-10-01T23:57:59Z",
  "e": "2018-10-01T23:57:59",
  "f": "23:50:56",
  "g": "00:08:56",
  "h": "23:50:56-03:00",
  "u": "PT1H",
  "j": "PT4H",
  "k": "2017-01-01T01:00:00",
  "l": "PT1H",
  "o": "PT8952H",
  "p": "PT8760H",
  "q": "PT8760H"
}
```

Note that the behavior of `o: |2019-10-01| - |2018-09-23|` changed in Mule 4.3.0. DataWeave 2.3.0,
which is supported by Mule 4.3.0, returns `"o": "PT8952H"`. DataWeave 2.2.0, which is supported by
Mule 4.2.0, returns `"o": "P1Y8D"`. To restore the 2.2.0 behavior, you can set the
`-M-Dcom.mulesoft.dw.date_minus_back_compatibility=true`. However, the setting does not affect the
Preview window in Studio. For guidance with this setting in Studio and on-prem deployments, see
[System Properties](https://docs.mulesoft.com/mule-runtime/latest/mule-app-properties-system). For CloudHub deployments,
see [Manage Properties for Applications on CloudHub](https://docs.mulesoft.com/cloudhub/cloudhub-manage-props).

## See Also

- [Period](https://docs.mulesoft.com/dataweave/2.4/dataweave-types#dw_type_dates_period)

- [Parse Dates](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-parse-dates)

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.4/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.4/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook)

<!-- document id=596e54b54092bb4d660d12333604eed8099a46741e0df68b9f6a664f526b44f6 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook-add-and-subtract-time.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, transform, transformer, format, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Add and Subtract Time

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example shows multiple addition and subtraction operations that deal with date and
time types.

The examples use:

- `as` function to coerce a String to Period type

- `P<date>T<time>` for the Period data type, which provides designators for years, months, days,
  hours, minutes, and seconds  
  For example, `|P2Y9M1D|` refers to a period of two years, nine months, and one day, and
  `|PT5H4M3S|` indicates a time period of five hours, four minutes, and three seconds.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
var numberOfDays = 3
---
{
  oneDayBefore: |2019-10-01T23:57:59Z| - |P1D|,
  threeDaysBefore: |2019-10-01T23:57:59Z| - ("P$(numberOfDays)D" as Period),
  a: |2019-10-01| - |P1Y|,
  b: |P1Y| - |2019-10-01|,
  c: |2019-10-01T23:57:59Z| - |P1Y|,
  d: |2019-10-01T23:57:59Z| + |P1Y|,
  e: |2019-10-01T23:57:59| - |P1Y|,
  f: |PT9M| - |23:59:56|,
  g: |23:59:56| + |PT9M|,
  h: |23:59:56-03:00| - |PT9M|,
  u: |23:59:56-03:00| - |22:59:56-03:00|,
  j: |23:59:56-03:00| - |22:59:56-00:00|,
  k: |2019-10-01T23:57:59| - |P2Y9M1D| - |PT57M59S| + |PT2H|,
  l: |23:59:56| - |22:59:56|,
  o: |2019-10-01| - |2018-09-23|,
  p: |2019-10-01T23:57:59Z| - |2018-10-01T23:57:59Z|,
  q: |2019-10-01T23:57:59| - |2018-10-01T23:57:59|
}
```

Output JSON:

```json
{
  "oneDayBefore": "2019-09-30T23:57:59Z",
  "threeDaysBefore": "2019-09-28T23:57:59Z",
  "a": "2018-10-01",
  "b": "2018-10-01",
  "c": "2018-10-01T23:57:59Z",
  "d": "2020-10-01T23:57:59Z",
  "e": "2018-10-01T23:57:59",
  "f": "23:50:56",
  "g": "00:08:56",
  "h": "23:50:56-03:00",
  "u": "PT1H",
  "j": "PT4H",
  "k": "2017-01-01T01:00:00",
  "l": "PT1H",
  "o": "PT8952H",
  "p": "PT8760H",
  "q": "PT8760H"
}
```

Note that the behavior of `o: |2019-10-01| - |2018-09-23|` changed in Mule 4.3.0. DataWeave 2.3.0,
which is supported by Mule 4.3.0, returns `"o": "PT8952H"`. DataWeave 2.2.0, which is supported by
Mule 4.2.0, returns `"o": "P1Y8D"`. To restore the 2.2.0 behavior, you can set the
`-M-Dcom.mulesoft.dw.date_minus_back_compatibility=true`. However, the setting does not affect the
Preview window in Studio. For guidance with this setting in Studio and on-prem deployments, see
[System Properties](https://docs.mulesoft.com/mule-runtime/latest/mule-app-properties-system). For CloudHub deployments,
see [Manage Properties for Applications on CloudHub](https://docs.mulesoft.com/cloudhub/cloudhub-manage-props).

## See Also

- [Period](https://docs.mulesoft.com/dataweave/2.6/dataweave-types#dw_type_dates_period)

- [Parse Dates](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-parse-dates)

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.6/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.6/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook)

<!-- document id=4742c10b68bf26abc42c224a5f2a77a6ecfbdd5f238bd3076388a83f6dca5661 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook-add-and-subtract-time.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, transform, transformer, format, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Add and Subtract Time

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example shows multiple addition and subtraction operations that deal with date and
time types.

The examples use:

- `as` function to coerce a String to Period type

- `P<date>T<time>` for the Period data type, which provides designators for years, months, days,
  hours, minutes, and seconds  
  For example, `|P2Y9M1D|` refers to a period of two years, nine months, and one day, and
  `|PT5H4M3S|` indicates a time period of five hours, four minutes, and three seconds.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
var numberOfDays = 3
---
{
  oneDayBefore: |2019-10-01T23:57:59Z| - |P1D|,
  threeDaysBefore: |2019-10-01T23:57:59Z| - ("P$(numberOfDays)D" as Period),
  a: |2019-10-01| - |P1Y|,
  b: |P1Y| - |2019-10-01|,
  c: |2019-10-01T23:57:59Z| - |P1Y|,
  d: |2019-10-01T23:57:59Z| + |P1Y|,
  e: |2019-10-01T23:57:59| - |P1Y|,
  f: |PT9M| - |23:59:56|,
  g: |23:59:56| + |PT9M|,
  h: |23:59:56-03:00| - |PT9M|,
  u: |23:59:56-03:00| - |22:59:56-03:00|,
  j: |23:59:56-03:00| - |22:59:56-00:00|,
  k: |2019-10-01T23:57:59| - |P2Y9M1D| - |PT57M59S| + |PT2H|,
  l: |23:59:56| - |22:59:56|,
  o: |2019-10-01| - |2018-09-23|,
  p: |2019-10-01T23:57:59Z| - |2018-10-01T23:57:59Z|,
  q: |2019-10-01T23:57:59| - |2018-10-01T23:57:59|
}
```

Output JSON:

```json
{
  "oneDayBefore": "2019-09-30T23:57:59Z",
  "threeDaysBefore": "2019-09-28T23:57:59Z",
  "a": "2018-10-01",
  "b": "2018-10-01",
  "c": "2018-10-01T23:57:59Z",
  "d": "2020-10-01T23:57:59Z",
  "e": "2018-10-01T23:57:59",
  "f": "23:50:56",
  "g": "00:08:56",
  "h": "23:50:56-03:00",
  "u": "PT1H",
  "j": "PT4H",
  "k": "2017-01-01T01:00:00",
  "l": "PT1H",
  "o": "PT8952H",
  "p": "PT8760H",
  "q": "PT8760H"
}
```

Note that the behavior of `o: |2019-10-01| - |2018-09-23|` changed in Mule 4.3.0. DataWeave 2.3.0,
which is supported by Mule 4.3.0, returns `"o": "PT8952H"`. DataWeave 2.2.0, which is supported by
Mule 4.2.0, returns `"o": "P1Y8D"`. To restore the 2.2.0 behavior, you can set the
`-M-Dcom.mulesoft.dw.date_minus_back_compatibility=true`. However, the setting does not affect the
Preview window in Studio. For guidance with this setting in Studio and on-prem deployments, see
[System Properties](https://docs.mulesoft.com/mule-runtime/latest/mule-app-properties-system). For CloudHub deployments,
see [Manage Properties for Applications on CloudHub](https://docs.mulesoft.com/cloudhub/cloudhub-manage-props).

## See Also

- [Period](https://docs.mulesoft.com/dataweave/2.9/dataweave-types#dw_type_dates_period)

- [Parse Dates](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-parse-dates)

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.9/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.9/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook)

<!-- document id=9326b1f378ae85ec73ff0f155ce911f8f6429903c5909b90bef4da6268a9ee65 url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook-add-and-subtract-time.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, transform, transformer, format, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Add and Subtract Time

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example shows multiple addition and subtraction operations that deal with date and
time types.

The examples use:

- `as` function to coerce a String to Period type

- `P<date>T<time>` for the Period data type, which provides designators for years, months, days,
  hours, minutes, and seconds  
  For example, `|P2Y9M1D|` refers to a period of two years, nine months, and one day, and
  `|PT5H4M3S|` indicates a time period of five hours, four minutes, and three seconds.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
var numberOfDays = 3
---
{
  oneDayBefore: |2019-10-01T23:57:59Z| - |P1D|,
  threeDaysBefore: |2019-10-01T23:57:59Z| - ("P$(numberOfDays)D" as Period),
  a: |2019-10-01| - |P1Y|,
  b: |P1Y| - |2019-10-01|,
  c: |2019-10-01T23:57:59Z| - |P1Y|,
  d: |2019-10-01T23:57:59Z| + |P1Y|,
  e: |2019-10-01T23:57:59| - |P1Y|,
  f: |PT9M| - |23:59:56|,
  g: |23:59:56| + |PT9M|,
  h: |23:59:56-03:00| - |PT9M|,
  u: |23:59:56-03:00| - |22:59:56-03:00|,
  j: |23:59:56-03:00| - |22:59:56-00:00|,
  k: |2019-10-01T23:57:59| - |P2Y9M1D| - |PT57M59S| + |PT2H|,
  l: |23:59:56| - |22:59:56|,
  o: |2019-10-01| - |2018-09-23|,
  p: |2019-10-01T23:57:59Z| - |2018-10-01T23:57:59Z|,
  q: |2019-10-01T23:57:59| - |2018-10-01T23:57:59|
}
```

Output JSON:

```json
{
  "oneDayBefore": "2019-09-30T23:57:59Z",
  "threeDaysBefore": "2019-09-28T23:57:59Z",
  "a": "2018-10-01",
  "b": "2018-10-01",
  "c": "2018-10-01T23:57:59Z",
  "d": "2020-10-01T23:57:59Z",
  "e": "2018-10-01T23:57:59",
  "f": "23:50:56",
  "g": "00:08:56",
  "h": "23:50:56-03:00",
  "u": "PT1H",
  "j": "PT4H",
  "k": "2017-01-01T01:00:00",
  "l": "PT1H",
  "o": "PT8952H",
  "p": "PT8760H",
  "q": "PT8760H"
}
```

Note that the behavior of `o: |2019-10-01| - |2018-09-23|` changed in Mule 4.3.0. DataWeave 2.3.0,
which is supported by Mule 4.3.0, returns `"o": "PT8952H"`. DataWeave 2.2.0, which is supported by
Mule 4.2.0, returns `"o": "P1Y8D"`. To restore the 2.2.0 behavior, you can set the
`-M-Dcom.mulesoft.dw.date_minus_back_compatibility=true`. However, the setting does not affect the
Preview window in Studio. For guidance with this setting in Studio and on-prem deployments, see
[System Properties](https://docs.mulesoft.com/mule-runtime/latest/mule-app-properties-system). For CloudHub deployments,
see [Manage Properties for Applications on CloudHub](https://docs.mulesoft.com/cloudhub/cloudhub-manage-props).

## See Also

- [Period](https://docs.mulesoft.com/dataweave/latest/dataweave-types#dw_type_dates_period)

- [Parse Dates](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-parse-dates)

- [DataWeave Types](https://docs.mulesoft.com/dataweave/latest/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook)

<!-- document id=fe67fc247c9d26d0f7e18c690f90bf6db80e850fb5114c07cf274b61debf604b url=/mulesoft/current/en-us/dataweave/2.11/dw-strings-functions-appendifmissing.md -->

---
product: DataWeave
version: 2.11
---

# appendIfMissing

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## appendIfMissing(text: String, suffix: String): String

Appends the `suffix` to the end of the `text` if the `text` does not already ends with the `suffix`.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>suffix</code></p></td><td><p>The text used as the suffix.</p></td></tr></tbody></table>

### Example

This example shows how `appendIfMissing` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import appendIfMissing from dw::core::Strings
output application/json
---
{
  "a": appendIfMissing(null, ""),
  "b": appendIfMissing("abc", ""),
  "c": appendIfMissing("", "xyz") ,
  "d": appendIfMissing("abc", "xyz") ,
  "e": appendIfMissing("abcxyz", "xyz")
}
```

#### Output

```JSON
{
  "a": null,
  "b": "abc",
  "c": "xyz",
  "d": "abcxyz",
  "e": "abcxyz"
}
```

## appendIfMissing(text: Null, suffix: String): Null

Helper function that enables `appendIfMissing` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=241807a48de556874b36e0024ae7d25dd14ac6b6a9ab233de42cd316059fe649 url=/mulesoft/current/en-us/dataweave/2.12/dw-strings-functions-appendifmissing.md -->

---
product: DataWeave
version: 2.12
---

# appendIfMissing

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## appendIfMissing(text: String, suffix: String): String

Appends the `suffix` to the end of the `text` if the `text` does not already ends with the `suffix`.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>suffix</code></p></td><td><p>The text used as the suffix.</p></td></tr></tbody></table>

### Example

This example shows how `appendIfMissing` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import appendIfMissing from dw::core::Strings
output application/json
---
{
  "a": appendIfMissing(null, ""),
  "b": appendIfMissing("abc", ""),
  "c": appendIfMissing("", "xyz") ,
  "d": appendIfMissing("abc", "xyz") ,
  "e": appendIfMissing("abcxyz", "xyz")
}
```

#### Output

```JSON
{
  "a": null,
  "b": "abc",
  "c": "xyz",
  "d": "abcxyz",
  "e": "abcxyz"
}
```

## appendIfMissing(text: Null, suffix: String): Null

Helper function that enables `appendIfMissing` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=20cfed35c9654939cb8effbf92b71ca15f93e9ae09f08ed66c040db74bf20ec7 url=/mulesoft/current/en-us/dataweave/2.3/dw-strings-functions-appendifmissing.md -->

---
product: DataWeave
version: 2.3
---

# appendIfMissing

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## appendIfMissing(String, String): String

Appends the `suffix` to the end of the `text` if the `text` does not already ends with the `suffix`.

_Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>suffix</code></p></td><td><p>The text used as the suffix.</p></td></tr></tbody></table>

### Example

This example shows how `appendIfMissing` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import appendIfMissing from dw::core::Strings
output application/json
---
{
  "a": appendIfMissing(null, ""),
  "b": appendIfMissing("abc", ""),
  "c": appendIfMissing("", "xyz") ,
  "d": appendIfMissing("abc", "xyz") ,
  "e": appendIfMissing("abcxyz", "xyz")
}
```

#### Output

```JSON
{
  "a": null,
  "b": "abc",
  "c": "xyz",
  "d": "abcxyz",
  "e": "abcxyz"
}
```

## appendIfMissing(Null, String): Null

Helper function that enables `appendIfMissing` to work with a `null` value.

<!-- document id=c192e1ba66fca8fe4e3ec1644ba39f51c7d5ae41da3ecc4452175ab79c8d5781 url=/mulesoft/current/en-us/dataweave/2.4/dw-strings-functions-appendifmissing.md -->

---
product: DataWeave
version: 2.4
---

# appendIfMissing

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## appendIfMissing(text: String, suffix: String): String

Appends the `suffix` to the end of the `text` if the `text` does not already ends with the `suffix`.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>suffix</code></p></td><td><p>The text used as the suffix.</p></td></tr></tbody></table>

### Example

This example shows how `appendIfMissing` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import appendIfMissing from dw::core::Strings
output application/json
---
{
  "a": appendIfMissing(null, ""),
  "b": appendIfMissing("abc", ""),
  "c": appendIfMissing("", "xyz") ,
  "d": appendIfMissing("abc", "xyz") ,
  "e": appendIfMissing("abcxyz", "xyz")
}
```

#### Output

```JSON
{
  "a": null,
  "b": "abc",
  "c": "xyz",
  "d": "abcxyz",
  "e": "abcxyz"
}
```

## appendIfMissing(text: Null, suffix: String): Null

Helper function that enables `appendIfMissing` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=1a6e02ff990803a222b68f34dcf54beaff76c184318c88d0dc9eb1a66a903301 url=/mulesoft/current/en-us/dataweave/2.6/dw-strings-functions-appendifmissing.md -->

---
product: DataWeave
version: 2.6
---

# appendIfMissing

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## appendIfMissing(text: String, suffix: String): String

Appends the `suffix` to the end of the `text` if the `text` does not already ends with the `suffix`.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>suffix</code></p></td><td><p>The text used as the suffix.</p></td></tr></tbody></table>

### Example

This example shows how `appendIfMissing` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import appendIfMissing from dw::core::Strings
output application/json
---
{
  "a": appendIfMissing(null, ""),
  "b": appendIfMissing("abc", ""),
  "c": appendIfMissing("", "xyz") ,
  "d": appendIfMissing("abc", "xyz") ,
  "e": appendIfMissing("abcxyz", "xyz")
}
```

#### Output

```JSON
{
  "a": null,
  "b": "abc",
  "c": "xyz",
  "d": "abcxyz",
  "e": "abcxyz"
}
```

## appendIfMissing(text: Null, suffix: String): Null

Helper function that enables `appendIfMissing` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=e46ed51ae4585726759891ff59317e4c86f351e033d5228e8d5175ec55a46b2e url=/mulesoft/current/en-us/dataweave/2.9/dw-strings-functions-appendifmissing.md -->

---
product: DataWeave
version: 2.9
---

# appendIfMissing

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## appendIfMissing(text: String, suffix: String): String

Appends the `suffix` to the end of the `text` if the `text` does not already ends with the `suffix`.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>suffix</code></p></td><td><p>The text used as the suffix.</p></td></tr></tbody></table>

### Example

This example shows how `appendIfMissing` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import appendIfMissing from dw::core::Strings
output application/json
---
{
  "a": appendIfMissing(null, ""),
  "b": appendIfMissing("abc", ""),
  "c": appendIfMissing("", "xyz") ,
  "d": appendIfMissing("abc", "xyz") ,
  "e": appendIfMissing("abcxyz", "xyz")
}
```

#### Output

```JSON
{
  "a": null,
  "b": "abc",
  "c": "xyz",
  "d": "abcxyz",
  "e": "abcxyz"
}
```

## appendIfMissing(text: Null, suffix: String): Null

Helper function that enables `appendIfMissing` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=a73c699d53e345cf8ba1acd31bf38e7ebf81521237520e97c7cec688aa73e87d url=/mulesoft/current/en-us/dataweave/latest/dw-strings-functions-appendifmissing.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# appendIfMissing

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## appendIfMissing(text: String, suffix: String): String

Appends the `suffix` to the end of the `text` if the `text` does not already ends with the `suffix`.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>suffix</code></p></td><td><p>The text used as the suffix.</p></td></tr></tbody></table>

### Example

This example shows how `appendIfMissing` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import appendIfMissing from dw::core::Strings
output application/json
---
{
  "a": appendIfMissing(null, ""),
  "b": appendIfMissing("abc", ""),
  "c": appendIfMissing("", "xyz") ,
  "d": appendIfMissing("abc", "xyz") ,
  "e": appendIfMissing("abcxyz", "xyz")
}
```

#### Output

```JSON
{
  "a": null,
  "b": "abc",
  "c": "xyz",
  "d": "abcxyz",
  "e": "abcxyz"
}
```

## appendIfMissing(text: Null, suffix: String): Null

Helper function that enables `appendIfMissing` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=d476c6ad2390fe23013a0e5fa7f40c10c5cc1ecd68dac72c42582fd55cdf614a url=/mulesoft/current/en-us/dataweave/2.11/dw-types-functions-arrayitem.md -->

---
product: DataWeave
version: 2.11
---

# arrayItem

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## arrayItem(t: Type): Type

Returns the type of the given array. This function fails if the input is not an Array type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `arrayItem` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ArrayOfString = Array<String>
type ArrayOfNumber = Array<Number>
type ArrayOfAny = Array<Any>
type ArrayOfAnyDefault = Array
output application/json
---
{
   a: arrayItem(ArrayOfString),
   b: arrayItem(ArrayOfNumber),
   c: arrayItem(ArrayOfAny),
   d: arrayItem(ArrayOfAnyDefault)
}
```

#### Output

```Json
{
  "a": "String",
  "b": "Number",
  "c": "Any",
  "d": "Any"
}
```

<!-- document id=53465f1fbd9786d93d01dac81387fec53a28887a40bdfe3c430d946595188820 url=/mulesoft/current/en-us/dataweave/2.12/dw-types-functions-arrayitem.md -->

---
product: DataWeave
version: 2.12
---

# arrayItem

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## arrayItem(t: Type): Type

Returns the type of the given array. This function fails if the input is not an Array type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `arrayItem` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ArrayOfString = Array<String>
type ArrayOfNumber = Array<Number>
type ArrayOfAny = Array<Any>
type ArrayOfAnyDefault = Array
output application/json
---
{
   a: arrayItem(ArrayOfString),
   b: arrayItem(ArrayOfNumber),
   c: arrayItem(ArrayOfAny),
   d: arrayItem(ArrayOfAnyDefault)
}
```

#### Output

```Json
{
  "a": "String",
  "b": "Number",
  "c": "Any",
  "d": "Any"
}
```

<!-- document id=2e8e3203abf9262de9484a6143e8c700ebdddbab74114f3f197792dcdc6679bd url=/mulesoft/current/en-us/dataweave/2.3/dw-types-functions-arrayitem.md -->

---
product: DataWeave
version: 2.3
---

# arrayItem

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## arrayItem(Type): Type

Returns the type of the given array. This function fails if the input is not an Array type.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>t</p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `arrayItem` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ArrayOfString = Array<String>
type ArrayOfNumber = Array<Number>
type ArrayOfAny = Array<Any>
type ArrayOfAnyDefault = Array
output application/json
---
{
   a: arrayItem(ArrayOfString),
   b: arrayItem(ArrayOfNumber),
   c: arrayItem(ArrayOfAny),
   d: arrayItem(ArrayOfAnyDefault)
}
```

#### Output

```Json
{
  "a": "String",
  "b": "Number",
  "c": "Any",
  "d": "Any"
}
```

<!-- document id=247314eda5a609448fbc136b835de71bad54004217df1d73f45b0fee7bafcd3f url=/mulesoft/current/en-us/dataweave/2.4/dw-types-functions-arrayitem.md -->

---
product: DataWeave
version: 2.4
---

# arrayItem

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## arrayItem(t: Type): Type

Returns the type of the given array. This function fails if the input is not an Array type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `arrayItem` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ArrayOfString = Array<String>
type ArrayOfNumber = Array<Number>
type ArrayOfAny = Array<Any>
type ArrayOfAnyDefault = Array
output application/json
---
{
   a: arrayItem(ArrayOfString),
   b: arrayItem(ArrayOfNumber),
   c: arrayItem(ArrayOfAny),
   d: arrayItem(ArrayOfAnyDefault)
}
```

#### Output

```Json
{
  "a": "String",
  "b": "Number",
  "c": "Any",
  "d": "Any"
}
```

<!-- document id=a06c7349e6fdabd408ac5701406dadb4c6a8b6eed0f8ccd6885c1ae4c7911bea url=/mulesoft/current/en-us/dataweave/2.6/dw-types-functions-arrayitem.md -->

---
product: DataWeave
version: 2.6
---

# arrayItem

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## arrayItem(t: Type): Type

Returns the type of the given array. This function fails if the input is not an Array type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `arrayItem` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ArrayOfString = Array<String>
type ArrayOfNumber = Array<Number>
type ArrayOfAny = Array<Any>
type ArrayOfAnyDefault = Array
output application/json
---
{
   a: arrayItem(ArrayOfString),
   b: arrayItem(ArrayOfNumber),
   c: arrayItem(ArrayOfAny),
   d: arrayItem(ArrayOfAnyDefault)
}
```

#### Output

```Json
{
  "a": "String",
  "b": "Number",
  "c": "Any",
  "d": "Any"
}
```

<!-- document id=fb2ea5689493f7222d2432785e79f916d7659143ea1de6048a20a8da78af12a7 url=/mulesoft/current/en-us/dataweave/2.9/dw-types-functions-arrayitem.md -->

---
product: DataWeave
version: 2.9
---

# arrayItem

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## arrayItem(t: Type): Type

Returns the type of the given array. This function fails if the input is not an Array type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `arrayItem` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ArrayOfString = Array<String>
type ArrayOfNumber = Array<Number>
type ArrayOfAny = Array<Any>
type ArrayOfAnyDefault = Array
output application/json
---
{
   a: arrayItem(ArrayOfString),
   b: arrayItem(ArrayOfNumber),
   c: arrayItem(ArrayOfAny),
   d: arrayItem(ArrayOfAnyDefault)
}
```

#### Output

```Json
{
  "a": "String",
  "b": "Number",
  "c": "Any",
  "d": "Any"
}
```

<!-- document id=b6221ba7e15a519ee313bb0e09e11fcc58ead2ddc490f210dadb4248ab4f1abf url=/mulesoft/current/en-us/dataweave/latest/dw-types-functions-arrayitem.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# arrayItem

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## arrayItem(t: Type): Type

Returns the type of the given array. This function fails if the input is not an Array type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `arrayItem` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ArrayOfString = Array<String>
type ArrayOfNumber = Array<Number>
type ArrayOfAny = Array<Any>
type ArrayOfAnyDefault = Array
output application/json
---
{
   a: arrayItem(ArrayOfString),
   b: arrayItem(ArrayOfNumber),
   c: arrayItem(ArrayOfAny),
   d: arrayItem(ArrayOfAnyDefault)
}
```

#### Output

```Json
{
  "a": "String",
  "b": "Number",
  "c": "Any",
  "d": "Any"
}
```

<!-- document id=26ae09f1c9ad28bc4355931780769cde9976b2d042ec1386850c6a07a8d0d246 url=/mulesoft/current/en-us/dataweave/2.11/dw-arrays.md -->

---
product: DataWeave
version: 2.11
---

# Arrays (dw::core::Arrays)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions for working with arrays.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Arrays` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-arrays-functions-countby">countBy</a></p></td><td><p>Counts the elements in an array that return <code>true</code> when the matching function is applied to the value of each element.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-arrays-functions-divideby">divideBy</a></p></td><td><p>Breaks up an array into sub-arrays that contain the specified number of elements.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-arrays-functions-drop">drop</a></p></td><td><p>Drops the first <code>n</code> elements. It returns the original array when <code>n &lt;= 0</code> and an empty array when <code>n &gt; sizeOf(array)</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-arrays-functions-dropwhile">dropWhile</a></p></td><td><p>Drops elements from the array while the condition is met but stops the selection process when it reaches an element that fails to satisfy the condition.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-arrays-functions-every">every</a></p></td><td><p>Returns <code>true</code> if every element in the array matches the condition.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-arrays-functions-firstwith">firstWith</a></p></td><td><p>Returns the first element that satisfies the condition, or returns <code>null</code> if no element meets the condition.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-arrays-functions-indexof">indexOf</a></p></td><td><p>Returns the index of the first occurrence of an element within the array. If the value is not found, the function returns <code>-1</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-arrays-functions-indexwhere">indexWhere</a></p></td><td><p>Returns the index of the first occurrence of an element that matches a condition within the array. If no element matches the condition, the function returns <code>-1</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-arrays-functions-join">join</a></p></td><td><p>Joins two arrays of objects by a given ID criteria.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-arrays-functions-leftjoin">leftJoin</a></p></td><td><p>Joins two arrays of objects by a given ID criteria.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-arrays-functions-outerjoin">outerJoin</a></p></td><td><p>Joins two array of objects by a given <code>ID</code> criteria.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-arrays-functions-partition">partition</a></p></td><td><p>Separates the array into the elements that satisfy the condition from those that do not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-arrays-functions-slice">slice</a></p></td><td><p>Selects the interval of elements that satisfy the condition: <code>from &lt;= indexOf(array) &lt; until</code></p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-arrays-functions-some">some</a></p></td><td><p>Returns <code>true</code> if at least one element in the array matches the specified condition.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-arrays-functions-splitat">splitAt</a></p></td><td><p>Splits an array into two at a given position.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-arrays-functions-splitwhere">splitWhere</a></p></td><td><p>Splits an array into two at the first position where the condition is met.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-arrays-functions-sumby">sumBy</a></p></td><td><p>Returns the sum of the values of the elements in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-arrays-functions-take">take</a></p></td><td><p>Selects the first <code>n</code> elements. It returns an empty array when <code>n &lt;= 0</code> and the original array when <code>n &gt; sizeOf(array)</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-arrays-functions-takewhile">takeWhile</a></p></td><td><p>Selects elements from the array while the condition is met but stops the selection process when it reaches an element that fails to satisfy the condition.</p></td></tr></tbody></table>

<!-- document id=f052fdae72133084b78d374156fa653a81213d9e80062932022fbcaa1d29319c url=/mulesoft/current/en-us/dataweave/2.12/dw-arrays.md -->

---
product: DataWeave
version: 2.12
---

# Arrays (dw::core::Arrays)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions for working with arrays.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Arrays` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-arrays-functions-countby">countBy</a></p></td><td><p>Counts the elements in an array that return <code>true</code> when the matching function is applied to the value of each element.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-arrays-functions-divideby">divideBy</a></p></td><td><p>Breaks up an array into sub-arrays that contain the specified number of elements.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-arrays-functions-drop">drop</a></p></td><td><p>Drops the first <code>n</code> elements. It returns the original array when <code>n &lt;= 0</code> and an empty array when <code>n &gt; sizeOf(array)</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-arrays-functions-dropwhile">dropWhile</a></p></td><td><p>Drops elements from the array while the condition is met but stops the selection process when it reaches an element that fails to satisfy the condition.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-arrays-functions-every">every</a></p></td><td><p>Returns <code>true</code> if every element in the array matches the condition.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-arrays-functions-firstwith">firstWith</a></p></td><td><p>Returns the first element that satisfies the condition, or returns <code>null</code> if no element meets the condition.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-arrays-functions-indexof">indexOf</a></p></td><td><p>Returns the index of the first occurrence of an element within the array. If the value is not found, the function returns <code>-1</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-arrays-functions-indexwhere">indexWhere</a></p></td><td><p>Returns the index of the first occurrence of an element that matches a condition within the array. If no element matches the condition, the function returns <code>-1</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-arrays-functions-join">join</a></p></td><td><p>Joins two arrays of objects by a given ID criteria.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-arrays-functions-leftjoin">leftJoin</a></p></td><td><p>Joins two arrays of objects by a given ID criteria.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-arrays-functions-outerjoin">outerJoin</a></p></td><td><p>Joins two array of objects by a given <code>ID</code> criteria.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-arrays-functions-partition">partition</a></p></td><td><p>Separates the array into the elements that satisfy the condition from those that do not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-arrays-functions-slice">slice</a></p></td><td><p>Selects the interval of elements that satisfy the condition: <code>from &lt;= indexOf(array) &lt; until</code></p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-arrays-functions-some">some</a></p></td><td><p>Returns <code>true</code> if at least one element in the array matches the specified condition.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-arrays-functions-splitat">splitAt</a></p></td><td><p>Splits an array into two at a given position.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-arrays-functions-splitwhere">splitWhere</a></p></td><td><p>Splits an array into two at the first position where the condition is met.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-arrays-functions-sumby">sumBy</a></p></td><td><p>Returns the sum of the values of the elements in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-arrays-functions-take">take</a></p></td><td><p>Selects the first <code>n</code> elements. It returns an empty array when <code>n &lt;= 0</code> and the original array when <code>n &gt; sizeOf(array)</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-arrays-functions-takewhile">takeWhile</a></p></td><td><p>Selects elements from the array while the condition is met but stops the selection process when it reaches an element that fails to satisfy the condition.</p></td></tr></tbody></table>

<!-- document id=21936c18c3a17381d18683c3c45ec91f94ec7097018e44e88c76b33189813464 url=/mulesoft/current/en-us/dataweave/2.3/dw-arrays.md -->

---
product: DataWeave
version: 2.3
---

# Arrays (dw::core::Arrays)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions for working with arrays.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Arrays` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-arrays-functions-countby">countBy</a></p></td><td><p>Counts the elements in an array that match the results of a function.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-arrays-functions-divideby">divideBy</a></p></td><td><p>Breaks up an array into sub-arrays that contain the specified number of elements.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-arrays-functions-drop">drop</a></p></td><td><p>Drops the first <code>n</code> elements. It returns the original array when <code>n &lt;= 0</code> and an empty array when <code>n &gt; sizeOf(array)</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-arrays-functions-dropwhile">dropWhile</a></p></td><td><p>Drops elements from the array while the condition is met but stops the selection process when it reaches an element that fails to satisfy the condition.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-arrays-functions-every">every</a></p></td><td><p>Returns <code>true</code> if every element in the array matches the condition.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-arrays-functions-firstwith">firstWith</a></p></td><td><p>Returns the first element that satisfies the condition, or returns <code>null</code> if no element meets the condition.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-arrays-functions-indexof">indexOf</a></p></td><td><p>Returns the index of the first occurrence of an element within the array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-arrays-functions-indexwhere">indexWhere</a></p></td><td><p>Returns the index of the first occurrence of an element that matches a condition within the array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-arrays-functions-join">join</a></p></td><td><p>Joins two arrays of objects by a given ID criteria.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-arrays-functions-leftjoin">leftJoin</a></p></td><td><p>Joins two arrays of objects by a given ID criteria.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-arrays-functions-outerjoin">outerJoin</a></p></td><td><p>Joins two array of objects by a given <code>ID</code> criteria.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-arrays-functions-partition">partition</a></p></td><td><p>Separates the array into the elements that satisfy the condition from those that do not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-arrays-functions-slice">slice</a></p></td><td><p>Selects the interval of elements that satisfy the condition: <code>from &lt;= indexOf(array) &lt; until</code></p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-arrays-functions-some">some</a></p></td><td><p>Returns <code>true</code> if at least one element in the array matches the specified condition.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-arrays-functions-splitat">splitAt</a></p></td><td><p>Splits an array into two at a given position.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-arrays-functions-splitwhere">splitWhere</a></p></td><td><p>Splits an array into two at the first position where the condition is met.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-arrays-functions-sumby">sumBy</a></p></td><td><p>Returns the sum of the values of the elements in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-arrays-functions-take">take</a></p></td><td><p>Selects the first <code>n</code> elements. It returns an empty array when <code>n &lt;= 0</code> and the original array when <code>n &gt; sizeOf(array)</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-arrays-functions-takewhile">takeWhile</a></p></td><td><p>Selects elements from the array while the condition is met but stops the selection process when it reaches an element that fails to satisfy the condition.</p></td></tr></tbody></table>

<!-- document id=7583d8237c64fa5161fcc964b953e21a52d5a2378374e0b2ad8b6af23caae60a url=/mulesoft/current/en-us/dataweave/2.4/dw-arrays.md -->

---
product: DataWeave
version: 2.4
---

# Arrays (dw::core::Arrays)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions for working with arrays.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Arrays` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-arrays-functions-countby">countBy</a></p></td><td><p>Counts the elements in an array that return <code>true</code> when the matching function is applied to the value of each element.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-arrays-functions-divideby">divideBy</a></p></td><td><p>Breaks up an array into sub-arrays that contain the specified number of elements.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-arrays-functions-drop">drop</a></p></td><td><p>Drops the first <code>n</code> elements. It returns the original array when <code>n &lt;= 0</code> and an empty array when <code>n &gt; sizeOf(array)</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-arrays-functions-dropwhile">dropWhile</a></p></td><td><p>Drops elements from the array while the condition is met but stops the selection process when it reaches an element that fails to satisfy the condition.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-arrays-functions-every">every</a></p></td><td><p>Returns <code>true</code> if every element in the array matches the condition.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-arrays-functions-firstwith">firstWith</a></p></td><td><p>Returns the first element that satisfies the condition, or returns <code>null</code> if no element meets the condition.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-arrays-functions-indexof">indexOf</a></p></td><td><p>Returns the index of the first occurrence of an element within the array. If the value is not found, the function returns <code>-1</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-arrays-functions-indexwhere">indexWhere</a></p></td><td><p>Returns the index of the first occurrence of an element that matches a condition within the array. If no element matches the condition, the function returns <code>-1</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-arrays-functions-join">join</a></p></td><td><p>Joins two arrays of objects by a given ID criteria.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-arrays-functions-leftjoin">leftJoin</a></p></td><td><p>Joins two arrays of objects by a given ID criteria.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-arrays-functions-outerjoin">outerJoin</a></p></td><td><p>Joins two array of objects by a given <code>ID</code> criteria.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-arrays-functions-partition">partition</a></p></td><td><p>Separates the array into the elements that satisfy the condition from those that do not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-arrays-functions-slice">slice</a></p></td><td><p>Selects the interval of elements that satisfy the condition: <code>from &lt;= indexOf(array) &lt; until</code></p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-arrays-functions-some">some</a></p></td><td><p>Returns <code>true</code> if at least one element in the array matches the specified condition.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-arrays-functions-splitat">splitAt</a></p></td><td><p>Splits an array into two at a given position.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-arrays-functions-splitwhere">splitWhere</a></p></td><td><p>Splits an array into two at the first position where the condition is met.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-arrays-functions-sumby">sumBy</a></p></td><td><p>Returns the sum of the values of the elements in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-arrays-functions-take">take</a></p></td><td><p>Selects the first <code>n</code> elements. It returns an empty array when <code>n &lt;= 0</code> and the original array when <code>n &gt; sizeOf(array)</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-arrays-functions-takewhile">takeWhile</a></p></td><td><p>Selects elements from the array while the condition is met but stops the selection process when it reaches an element that fails to satisfy the condition.</p></td></tr></tbody></table>

<!-- document id=e772185f9de970223e28d4306c32272743119e12a55e69fae857dfcffc8e67e5 url=/mulesoft/current/en-us/dataweave/2.6/dw-arrays.md -->

---
product: DataWeave
version: 2.6
---

# Arrays (dw::core::Arrays)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions for working with arrays.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Arrays` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-arrays-functions-countby">countBy</a></p></td><td><p>Counts the elements in an array that return <code>true</code> when the matching function is applied to the value of each element.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-arrays-functions-divideby">divideBy</a></p></td><td><p>Breaks up an array into sub-arrays that contain the specified number of elements.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-arrays-functions-drop">drop</a></p></td><td><p>Drops the first <code>n</code> elements. It returns the original array when <code>n &lt;= 0</code> and an empty array when <code>n &gt; sizeOf(array)</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-arrays-functions-dropwhile">dropWhile</a></p></td><td><p>Drops elements from the array while the condition is met but stops the selection process when it reaches an element that fails to satisfy the condition.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-arrays-functions-every">every</a></p></td><td><p>Returns <code>true</code> if every element in the array matches the condition.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-arrays-functions-firstwith">firstWith</a></p></td><td><p>Returns the first element that satisfies the condition, or returns <code>null</code> if no element meets the condition.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-arrays-functions-indexof">indexOf</a></p></td><td><p>Returns the index of the first occurrence of an element within the array. If the value is not found, the function returns <code>-1</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-arrays-functions-indexwhere">indexWhere</a></p></td><td><p>Returns the index of the first occurrence of an element that matches a condition within the array. If no element matches the condition, the function returns <code>-1</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-arrays-functions-join">join</a></p></td><td><p>Joins two arrays of objects by a given ID criteria.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-arrays-functions-leftjoin">leftJoin</a></p></td><td><p>Joins two arrays of objects by a given ID criteria.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-arrays-functions-outerjoin">outerJoin</a></p></td><td><p>Joins two array of objects by a given <code>ID</code> criteria.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-arrays-functions-partition">partition</a></p></td><td><p>Separates the array into the elements that satisfy the condition from those that do not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-arrays-functions-slice">slice</a></p></td><td><p>Selects the interval of elements that satisfy the condition: <code>from &lt;= indexOf(array) &lt; until</code></p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-arrays-functions-some">some</a></p></td><td><p>Returns <code>true</code> if at least one element in the array matches the specified condition.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-arrays-functions-splitat">splitAt</a></p></td><td><p>Splits an array into two at a given position.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-arrays-functions-splitwhere">splitWhere</a></p></td><td><p>Splits an array into two at the first position where the condition is met.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-arrays-functions-sumby">sumBy</a></p></td><td><p>Returns the sum of the values of the elements in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-arrays-functions-take">take</a></p></td><td><p>Selects the first <code>n</code> elements. It returns an empty array when <code>n &lt;= 0</code> and the original array when <code>n &gt; sizeOf(array)</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-arrays-functions-takewhile">takeWhile</a></p></td><td><p>Selects elements from the array while the condition is met but stops the selection process when it reaches an element that fails to satisfy the condition.</p></td></tr></tbody></table>

<!-- document id=429eb035acba22259d89976d686bc491432cb6b13bb63f07a450818d581ad494 url=/mulesoft/current/en-us/dataweave/2.9/dw-arrays.md -->

---
product: DataWeave
version: 2.9
---

# Arrays (dw::core::Arrays)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions for working with arrays.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Arrays` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-arrays-functions-countby">countBy</a></p></td><td><p>Counts the elements in an array that return <code>true</code> when the matching function is applied to the value of each element.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-arrays-functions-divideby">divideBy</a></p></td><td><p>Breaks up an array into sub-arrays that contain the specified number of elements.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-arrays-functions-drop">drop</a></p></td><td><p>Drops the first <code>n</code> elements. It returns the original array when <code>n &lt;= 0</code> and an empty array when <code>n &gt; sizeOf(array)</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-arrays-functions-dropwhile">dropWhile</a></p></td><td><p>Drops elements from the array while the condition is met but stops the selection process when it reaches an element that fails to satisfy the condition.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-arrays-functions-every">every</a></p></td><td><p>Returns <code>true</code> if every element in the array matches the condition.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-arrays-functions-firstwith">firstWith</a></p></td><td><p>Returns the first element that satisfies the condition, or returns <code>null</code> if no element meets the condition.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-arrays-functions-indexof">indexOf</a></p></td><td><p>Returns the index of the first occurrence of an element within the array. If the value is not found, the function returns <code>-1</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-arrays-functions-indexwhere">indexWhere</a></p></td><td><p>Returns the index of the first occurrence of an element that matches a condition within the array. If no element matches the condition, the function returns <code>-1</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-arrays-functions-join">join</a></p></td><td><p>Joins two arrays of objects by a given ID criteria.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-arrays-functions-leftjoin">leftJoin</a></p></td><td><p>Joins two arrays of objects by a given ID criteria.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-arrays-functions-outerjoin">outerJoin</a></p></td><td><p>Joins two array of objects by a given <code>ID</code> criteria.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-arrays-functions-partition">partition</a></p></td><td><p>Separates the array into the elements that satisfy the condition from those that do not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-arrays-functions-slice">slice</a></p></td><td><p>Selects the interval of elements that satisfy the condition: <code>from &lt;= indexOf(array) &lt; until</code></p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-arrays-functions-some">some</a></p></td><td><p>Returns <code>true</code> if at least one element in the array matches the specified condition.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-arrays-functions-splitat">splitAt</a></p></td><td><p>Splits an array into two at a given position.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-arrays-functions-splitwhere">splitWhere</a></p></td><td><p>Splits an array into two at the first position where the condition is met.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-arrays-functions-sumby">sumBy</a></p></td><td><p>Returns the sum of the values of the elements in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-arrays-functions-take">take</a></p></td><td><p>Selects the first <code>n</code> elements. It returns an empty array when <code>n &lt;= 0</code> and the original array when <code>n &gt; sizeOf(array)</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-arrays-functions-takewhile">takeWhile</a></p></td><td><p>Selects elements from the array while the condition is met but stops the selection process when it reaches an element that fails to satisfy the condition.</p></td></tr></tbody></table>

<!-- document id=5070909b8eee18f7c323b14236848f65da4c7e27eb04246cc301c6fd26ff38a2 url=/mulesoft/current/en-us/dataweave/latest/dw-arrays.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Arrays (dw::core::Arrays)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions for working with arrays.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Arrays` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-arrays-functions-countby">countBy</a></p></td><td><p>Counts the elements in an array that return <code>true</code> when the matching function is applied to the value of each element.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-arrays-functions-divideby">divideBy</a></p></td><td><p>Breaks up an array into sub-arrays that contain the specified number of elements.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-arrays-functions-drop">drop</a></p></td><td><p>Drops the first <code>n</code> elements. It returns the original array when <code>n &lt;= 0</code> and an empty array when <code>n &gt; sizeOf(array)</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-arrays-functions-dropwhile">dropWhile</a></p></td><td><p>Drops elements from the array while the condition is met but stops the selection process when it reaches an element that fails to satisfy the condition.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-arrays-functions-every">every</a></p></td><td><p>Returns <code>true</code> if every element in the array matches the condition.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-arrays-functions-firstwith">firstWith</a></p></td><td><p>Returns the first element that satisfies the condition, or returns <code>null</code> if no element meets the condition.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-arrays-functions-indexof">indexOf</a></p></td><td><p>Returns the index of the first occurrence of an element within the array. If the value is not found, the function returns <code>-1</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-arrays-functions-indexwhere">indexWhere</a></p></td><td><p>Returns the index of the first occurrence of an element that matches a condition within the array. If no element matches the condition, the function returns <code>-1</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-arrays-functions-join">join</a></p></td><td><p>Joins two arrays of objects by a given ID criteria.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-arrays-functions-leftjoin">leftJoin</a></p></td><td><p>Joins two arrays of objects by a given ID criteria.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-arrays-functions-outerjoin">outerJoin</a></p></td><td><p>Joins two array of objects by a given <code>ID</code> criteria.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-arrays-functions-partition">partition</a></p></td><td><p>Separates the array into the elements that satisfy the condition from those that do not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-arrays-functions-slice">slice</a></p></td><td><p>Selects the interval of elements that satisfy the condition: <code>from &lt;= indexOf(array) &lt; until</code></p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-arrays-functions-some">some</a></p></td><td><p>Returns <code>true</code> if at least one element in the array matches the specified condition.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-arrays-functions-splitat">splitAt</a></p></td><td><p>Splits an array into two at a given position.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-arrays-functions-splitwhere">splitWhere</a></p></td><td><p>Splits an array into two at the first position where the condition is met.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-arrays-functions-sumby">sumBy</a></p></td><td><p>Returns the sum of the values of the elements in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-arrays-functions-take">take</a></p></td><td><p>Selects the first <code>n</code> elements. It returns an empty array when <code>n &lt;= 0</code> and the original array when <code>n &gt; sizeOf(array)</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-arrays-functions-takewhile">takeWhile</a></p></td><td><p>Selects elements from the array while the condition is met but stops the selection process when it reaches an element that fails to satisfy the condition.</p></td></tr></tbody></table>

<!-- document id=90492bef91385fc8ca7fef9504638f432fd045945bf9438684cd5979b5587dc6 url=/mulesoft/current/en-us/dataweave/2.11/dw-tree-functions-asexpressionstring.md -->

---
product: DataWeave
version: 2.11
---

# asExpressionString

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## asExpressionString(path: Path): String

Transforms a `Path` value into a string representation of the path.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>path</code></p></td><td><p>The <code>Path</code> value to transform into a <code>String</code> value.</p></td></tr></tbody></table>

### Example

This example transforms a `Path` value into a `String` representation of a selector for an attribute
of an object.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
output application/json
---
asExpressionString([
        {kind: OBJECT_TYPE, selector: "user", namespace: null},
        {kind: ATTRIBUTE_TYPE, selector: "name", namespace: null}
    ])
```

#### Output

```Json
".user.@name"
```

<!-- document id=eacfa4a26286d4f1db719253befc764aa912f47c463c0a578e482a6b2ff121fa url=/mulesoft/current/en-us/dataweave/2.12/dw-tree-functions-asexpressionstring.md -->

---
product: DataWeave
version: 2.12
---

# asExpressionString

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## asExpressionString(path: Path): String

Transforms a `Path` value into a string representation of the path.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>path</code></p></td><td><p>The <code>Path</code> value to transform into a <code>String</code> value.</p></td></tr></tbody></table>

### Example

This example transforms a `Path` value into a `String` representation of a selector for an attribute
of an object.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
output application/json
---
asExpressionString([
        {kind: OBJECT_TYPE, selector: "user", namespace: null},
        {kind: ATTRIBUTE_TYPE, selector: "name", namespace: null}
    ])
```

#### Output

```Json
".user.@name"
```

<!-- document id=311705726b410d71856fdded48e586c3d5cb672bbb2a957f381d03c0b3a191b9 url=/mulesoft/current/en-us/dataweave/2.3/dw-tree-functions-asexpressionstring.md -->

---
product: DataWeave
version: 2.3
---

# asExpressionString

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## asExpressionString(Path): String

Transforms a path to a string representation.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>path</p></td><td><p>The path to transform to a string.</p></td></tr></tbody></table>

### Example

This example transforms a path to a string representation.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
output application/json
---
asExpressionString([{kind: OBJECT_TYPE, selector: "user", namespace: null}, {kind: ATTRIBUTE_TYPE, selector: "name", namespace: null}])
```

#### Output

```Json
".user.@name"
```

<!-- document id=e2a1efbe41992452ad22ea0446d2490650b9ba557dea9cf68cf34c35b2564c71 url=/mulesoft/current/en-us/dataweave/2.4/dw-tree-functions-asexpressionstring.md -->

---
product: DataWeave
version: 2.4
---

# asExpressionString

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## asExpressionString(path: Path): String

Transforms a `Path` value into a string representation of the path.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>path</code></p></td><td><p>The <code>Path</code> value to transform into a <code>String</code> value.</p></td></tr></tbody></table>

### Example

This example transforms a `Path` value into a `String` representation of a selector for an attribute
of an object.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
output application/json
---
asExpressionString([
        {kind: OBJECT_TYPE, selector: "user", namespace: null},
        {kind: ATTRIBUTE_TYPE, selector: "name", namespace: null}
    ])
```

#### Output

```Json
".user.@name"
```

<!-- document id=ff372ce569b6ab7a07f4cc886b873b2d5986db2584bb717b8e485e3f31001828 url=/mulesoft/current/en-us/dataweave/2.6/dw-tree-functions-asexpressionstring.md -->

---
product: DataWeave
version: 2.6
---

# asExpressionString

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## asExpressionString(path: Path): String

Transforms a `Path` value into a string representation of the path.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>path</code></p></td><td><p>The <code>Path</code> value to transform into a <code>String</code> value.</p></td></tr></tbody></table>

### Example

This example transforms a `Path` value into a `String` representation of a selector for an attribute
of an object.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
output application/json
---
asExpressionString([
        {kind: OBJECT_TYPE, selector: "user", namespace: null},
        {kind: ATTRIBUTE_TYPE, selector: "name", namespace: null}
    ])
```

#### Output

```Json
".user.@name"
```

<!-- document id=e7ce6870e5282dccb9ee8ad83a0b7b5c61e1d2e897acf454477493ae9f23d9df url=/mulesoft/current/en-us/dataweave/2.9/dw-tree-functions-asexpressionstring.md -->

---
product: DataWeave
version: 2.9
---

# asExpressionString

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## asExpressionString(path: Path): String

Transforms a `Path` value into a string representation of the path.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>path</code></p></td><td><p>The <code>Path</code> value to transform into a <code>String</code> value.</p></td></tr></tbody></table>

### Example

This example transforms a `Path` value into a `String` representation of a selector for an attribute
of an object.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
output application/json
---
asExpressionString([
        {kind: OBJECT_TYPE, selector: "user", namespace: null},
        {kind: ATTRIBUTE_TYPE, selector: "name", namespace: null}
    ])
```

#### Output

```Json
".user.@name"
```

<!-- document id=a44109ad4b42d5313089b109015d82b62ca817e0e3d57c0042565410dbc12131 url=/mulesoft/current/en-us/dataweave/latest/dw-tree-functions-asexpressionstring.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# asExpressionString

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## asExpressionString(path: Path): String

Transforms a `Path` value into a string representation of the path.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>path</code></p></td><td><p>The <code>Path</code> value to transform into a <code>String</code> value.</p></td></tr></tbody></table>

### Example

This example transforms a `Path` value into a `String` representation of a selector for an attribute
of an object.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
output application/json
---
asExpressionString([
        {kind: OBJECT_TYPE, selector: "user", namespace: null},
        {kind: ATTRIBUTE_TYPE, selector: "name", namespace: null}
    ])
```

#### Output

```Json
".user.@name"
```

<!-- document id=b23a715b240ddd17fdcb70c47a07d094fb0da0face16c4a3b397be7bde866a71 url=/mulesoft/current/en-us/dataweave/2.11/dw-math-functions-asin.md -->

---
product: DataWeave
version: 2.11
---

# asin

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## asin(angle: Number): Number | NaN

Returns an arc sine value that can range from `-pi/2` through `pi/2`.

If the absolute value of the input is greater than 1, the result is `null`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>angle</code></p></td><td><div><div><p>Number to convert into its arc sine value.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `asin` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
  "asin0": asin(0),
  "asin13": asin(0.13),
  "asin-1": asin(-1),
  "asin1.1": asin(1.1)
}
```

#### Output

```Json
{
   "asin0": 0.0,
   "asin13": 0.1303689797031455,
   "asin-1": -1.5707963267948966,
   "asin1.1": null
 }
```

<!-- document id=d594a90490dc6f7ccf3f32e58f5adec322c187ad1ad9092d3784310a06f5637a url=/mulesoft/current/en-us/dataweave/2.12/dw-math-functions-asin.md -->

---
product: DataWeave
version: 2.12
---

# asin

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## asin(angle: Number): Number | NaN

Returns an arc sine value that can range from `-pi/2` through `pi/2`.

If the absolute value of the input is greater than 1, the result is `null`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>angle</code></p></td><td><div><div><p>Number to convert into its arc sine value.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `asin` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
  "asin0": asin(0),
  "asin13": asin(0.13),
  "asin-1": asin(-1),
  "asin1.1": asin(1.1)
}
```

#### Output

```Json
{
   "asin0": 0.0,
   "asin13": 0.1303689797031455,
   "asin-1": -1.5707963267948966,
   "asin1.1": null
 }
```

<!-- document id=6fdd15bac26f1bcaf296405a5be8faecfdfc0c55a4513e911e8f3096ccd74299 url=/mulesoft/current/en-us/dataweave/2.4/dw-math-functions-asin.md -->

---
product: DataWeave
version: 2.4
---

# asin

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## asin(angle: Number): Number | NaN

Returns an arc sine value that can range from `-pi/2` through `pi/2`.

If the absolute value of the input is greater than 1, the result is `null`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>angle</code></p></td><td><div><div><p>Number to convert into its arc sine value.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `asin` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
  "asin0": asin(0),
  "asin13": asin(0.13),
  "asin-1": asin(-1),
  "asin1.1": asin(1.1)
}
```

#### Output

```Json
{
   "asin0": 0.0,
   "asin13": 0.1303689797031455,
   "asin-1": -1.5707963267948966,
   "asin1.1": null
 }
```

<!-- document id=f59e95d83fca806052e44c5b665567f38a4667872fd778d7d41ef1ede89ba0cf url=/mulesoft/current/en-us/dataweave/2.6/dw-math-functions-asin.md -->

---
product: DataWeave
version: 2.6
---

# asin

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## asin(angle: Number): Number | NaN

Returns an arc sine value that can range from `-pi/2` through `pi/2`.

If the absolute value of the input is greater than 1, the result is `null`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>angle</code></p></td><td><div><div><p>Number to convert into its arc sine value.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `asin` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
  "asin0": asin(0),
  "asin13": asin(0.13),
  "asin-1": asin(-1),
  "asin1.1": asin(1.1)
}
```

#### Output

```Json
{
   "asin0": 0.0,
   "asin13": 0.1303689797031455,
   "asin-1": -1.5707963267948966,
   "asin1.1": null
 }
```

<!-- document id=16d4d92427a50418a52141511d2ef6de0ea0bbdee0b02b2b60222e06a930f0d0 url=/mulesoft/current/en-us/dataweave/2.9/dw-math-functions-asin.md -->

---
product: DataWeave
version: 2.9
---

# asin

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## asin(angle: Number): Number | NaN

Returns an arc sine value that can range from `-pi/2` through `pi/2`.

If the absolute value of the input is greater than 1, the result is `null`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>angle</code></p></td><td><div><div><p>Number to convert into its arc sine value.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `asin` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
  "asin0": asin(0),
  "asin13": asin(0.13),
  "asin-1": asin(-1),
  "asin1.1": asin(1.1)
}
```

#### Output

```Json
{
   "asin0": 0.0,
   "asin13": 0.1303689797031455,
   "asin-1": -1.5707963267948966,
   "asin1.1": null
 }
```

<!-- document id=94967b01f8c8cb4cff18ab3bf77bc618b3bbae9cd9deb1c15bbaefc44e1b3563 url=/mulesoft/current/en-us/dataweave/latest/dw-math-functions-asin.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# asin

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## asin(angle: Number): Number | NaN

Returns an arc sine value that can range from `-pi/2` through `pi/2`.

If the absolute value of the input is greater than 1, the result is `null`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>angle</code></p></td><td><div><div><p>Number to convert into its arc sine value.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `asin` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
  "asin0": asin(0),
  "asin13": asin(0.13),
  "asin-1": asin(-1),
  "asin1.1": asin(1.1)
}
```

#### Output

```Json
{
   "asin0": 0.0,
   "asin13": 0.1303689797031455,
   "asin-1": -1.5707963267948966,
   "asin1.1": null
 }
```

<!-- document id=49abec5f6e7ec6b24621549e44a768d2aee99727061822cfbe1af6d64ae2cc49 url=/mulesoft/current/en-us/dataweave/2.11/dw-math-functions-atan.md -->

---
product: DataWeave
version: 2.11
---

# atan

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## atan(angle: Number): Number

Returns an arc tangent value that can range from `-pi/2` through `pi/2`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>angle</code></p></td><td><div><div><p>Number to convert into its arc tangent value.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `atan` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
  "atan0":  atan(0),
  "atan13": atan(0.13),
  "atan-1": atan(-1)
}
```

#### Output

```Json
{
   "atan0": 0.0,
   "atan13": 0.12927500404814307,
   "atan-1": -0.7853981633974483
}
```

<!-- document id=a0a6e0f12283da483ba8c0955388efd56287d6d5490c0e20899ac49213495986 url=/mulesoft/current/en-us/dataweave/2.12/dw-math-functions-atan.md -->

---
product: DataWeave
version: 2.12
---

# atan

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## atan(angle: Number): Number

Returns an arc tangent value that can range from `-pi/2` through `pi/2`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>angle</code></p></td><td><div><div><p>Number to convert into its arc tangent value.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `atan` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
  "atan0":  atan(0),
  "atan13": atan(0.13),
  "atan-1": atan(-1)
}
```

#### Output

```Json
{
   "atan0": 0.0,
   "atan13": 0.12927500404814307,
   "atan-1": -0.7853981633974483
}
```

<!-- document id=a37cc6fb5d5e82f54ab04c4d72e3c17bc165103cb1166efb9811d362974ef52f url=/mulesoft/current/en-us/dataweave/2.4/dw-math-functions-atan.md -->

---
product: DataWeave
version: 2.4
---

# atan

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## atan(angle: Number): Number

Returns an arc tangent value that can range from `-pi/2` through `pi/2`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>angle</code></p></td><td><div><div><p>Number to convert into its arc tangent value.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `atan` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
  "atan0":  atan(0),
  "atan13": atan(0.13),
  "atan-1": atan(-1)
}
```

#### Output

```Json
{
   "atan0": 0.0,
   "atan13": 0.12927500404814307,
   "atan-1": -0.7853981633974483
}
```

<!-- document id=440d7a2bfc4b21147468d406e753660ea2a0899acaf4bfb64ad469cb8b01a991 url=/mulesoft/current/en-us/dataweave/2.6/dw-math-functions-atan.md -->

---
product: DataWeave
version: 2.6
---

# atan

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## atan(angle: Number): Number

Returns an arc tangent value that can range from `-pi/2` through `pi/2`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>angle</code></p></td><td><div><div><p>Number to convert into its arc tangent value.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `atan` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
  "atan0":  atan(0),
  "atan13": atan(0.13),
  "atan-1": atan(-1)
}
```

#### Output

```Json
{
   "atan0": 0.0,
   "atan13": 0.12927500404814307,
   "atan-1": -0.7853981633974483
}
```

<!-- document id=675c76b1f7a8b0cc743200fa6d2a40d19103bd39ff9d2221281a5476500c811b url=/mulesoft/current/en-us/dataweave/2.9/dw-math-functions-atan.md -->

---
product: DataWeave
version: 2.9
---

# atan

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## atan(angle: Number): Number

Returns an arc tangent value that can range from `-pi/2` through `pi/2`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>angle</code></p></td><td><div><div><p>Number to convert into its arc tangent value.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `atan` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
  "atan0":  atan(0),
  "atan13": atan(0.13),
  "atan-1": atan(-1)
}
```

#### Output

```Json
{
   "atan0": 0.0,
   "atan13": 0.12927500404814307,
   "atan-1": -0.7853981633974483
}
```

<!-- document id=3b5e328fc122394dc577050bb2d8b1cb314fbaf750f40645158ff30f0600935f url=/mulesoft/current/en-us/dataweave/latest/dw-math-functions-atan.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# atan

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## atan(angle: Number): Number

Returns an arc tangent value that can range from `-pi/2` through `pi/2`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>angle</code></p></td><td><div><div><p>Number to convert into its arc tangent value.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `atan` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
  "atan0":  atan(0),
  "atan13": atan(0.13),
  "atan-1": atan(-1)
}
```

#### Output

```Json
{
   "atan0": 0.0,
   "atan13": 0.12927500404814307,
   "atan-1": -0.7853981633974483
}
```

<!-- document id=aba293deb2f6a8201388aea08ac80e3b68ccbd162abb0dc70f7c05397d9ab409 url=/mulesoft/current/en-us/dataweave/2.11/dw-dates-functions-atbeginningofday.md -->

---
product: DataWeave
version: 2.11
---

# atBeginningOfDay

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## atBeginningOfDay(dateTime: DateTime): DateTime

Returns a new `DateTime` value that changes the `Time` value in the input to the beginning of the
specified _day_.

The hours, minutes, and seconds in the input change to `00:00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><div><div><p>The <code>DateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Time` value within the `DateTime` input to the beginning of the specified
day.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  "atBeginningOfDayDateTime": atBeginningOfDay(|2020-10-06T18:23:20.351-03:00|)
}
```

#### Output

```Json
{
  "atBeginningOfDayDateTime": "2020-10-06T00:00:00-03:00"
}
```

## atBeginningOfDay(localDateTime: LocalDateTime): LocalDateTime

Returns a new `LocalDateTime` value that changes the `Time` value within the input to the start of
the specified _day_.

The hours, minutes, and seconds in the input change to `00:00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>localDateTime</code></p></td><td><div><div><p>The <code>LocalDateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Time` value within the `LocalDateTime` input to the beginning of the
specified day.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  "atBeginningOfDayLocalDateTime": atBeginningOfDay(|2020-10-06T18:23:20.351|)
}
```

#### Output

```Json
{
  "atBeginningOfDayLocalDateTime": "2020-10-06T00:00:00"
}
```

<!-- document id=63cd485775a4307e6719029a2b6214e7d361ae7f6406b22463fedbbc4e62ea34 url=/mulesoft/current/en-us/dataweave/2.12/dw-dates-functions-atbeginningofday.md -->

---
product: DataWeave
version: 2.12
---

# atBeginningOfDay

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## atBeginningOfDay(dateTime: DateTime): DateTime

Returns a new `DateTime` value that changes the `Time` value in the input to the beginning of the
specified _day_.

The hours, minutes, and seconds in the input change to `00:00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><div><div><p>The <code>DateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Time` value within the `DateTime` input to the beginning of the specified
day.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  "atBeginningOfDayDateTime": atBeginningOfDay(|2020-10-06T18:23:20.351-03:00|)
}
```

#### Output

```Json
{
  "atBeginningOfDayDateTime": "2020-10-06T00:00:00-03:00"
}
```

## atBeginningOfDay(localDateTime: LocalDateTime): LocalDateTime

Returns a new `LocalDateTime` value that changes the `Time` value within the input to the start of
the specified _day_.

The hours, minutes, and seconds in the input change to `00:00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>localDateTime</code></p></td><td><div><div><p>The <code>LocalDateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Time` value within the `LocalDateTime` input to the beginning of the
specified day.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  "atBeginningOfDayLocalDateTime": atBeginningOfDay(|2020-10-06T18:23:20.351|)
}
```

#### Output

```Json
{
  "atBeginningOfDayLocalDateTime": "2020-10-06T00:00:00"
}
```

<!-- document id=54c2a8851b8328e5e91b891e12da317e8542f238ddc269292cbfa7a8651d2ecc url=/mulesoft/current/en-us/dataweave/2.4/dw-dates-functions-atbeginningofday.md -->

---
product: DataWeave
version: 2.4
---

# atBeginningOfDay

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## atBeginningOfDay(dateTime: DateTime): DateTime

Returns a new `DateTime` value that changes the `Time` value in the input to the beginning of the
specified _day_.

The hours, minutes, and seconds in the input change to `00:00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><div><div><p>The <code>DateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Time` value within the `DateTime` input to the beginning of the specified
day.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  "atBeginningOfDayDateTime": atBeginningOfDay(|2020-10-06T18:23:20.351-03:00|)
}
```

#### Output

```Json
{
  "atBeginningOfDayDateTime": "2020-10-06T00:00:00-03:00"
}
```

## atBeginningOfDay(localDateTime: LocalDateTime): LocalDateTime

Returns a new `LocalDateTime` value that changes the `Time` value within the input to the start of
the specified _day_.

The hours, minutes, and seconds in the input change to `00:00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>localDateTime</code></p></td><td><div><div><p>The <code>LocalDateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Time` value within the `LocalDateTime` input to the beginning of the
specified day.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  "atBeginningOfDayLocalDateTime": atBeginningOfDay(|2020-10-06T18:23:20.351|)
}
```

#### Output

```Json
{
  "atBeginningOfDayLocalDateTime": "2020-10-06T00:00:00"
}
```

<!-- document id=f43a05014e0c5a3f81e7b472493c957df317dd0bead2fb2a1300faef2e71df6a url=/mulesoft/current/en-us/dataweave/2.6/dw-dates-functions-atbeginningofday.md -->

---
product: DataWeave
version: 2.6
---

# atBeginningOfDay

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## atBeginningOfDay(dateTime: DateTime): DateTime

Returns a new `DateTime` value that changes the `Time` value in the input to the beginning of the
specified _day_.

The hours, minutes, and seconds in the input change to `00:00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><div><div><p>The <code>DateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Time` value within the `DateTime` input to the beginning of the specified
day.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  "atBeginningOfDayDateTime": atBeginningOfDay(|2020-10-06T18:23:20.351-03:00|)
}
```

#### Output

```Json
{
  "atBeginningOfDayDateTime": "2020-10-06T00:00:00-03:00"
}
```

## atBeginningOfDay(localDateTime: LocalDateTime): LocalDateTime

Returns a new `LocalDateTime` value that changes the `Time` value within the input to the start of
the specified _day_.

The hours, minutes, and seconds in the input change to `00:00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>localDateTime</code></p></td><td><div><div><p>The <code>LocalDateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Time` value within the `LocalDateTime` input to the beginning of the
specified day.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  "atBeginningOfDayLocalDateTime": atBeginningOfDay(|2020-10-06T18:23:20.351|)
}
```

#### Output

```Json
{
  "atBeginningOfDayLocalDateTime": "2020-10-06T00:00:00"
}
```

<!-- document id=f1fbcec99af2ade6016eb2b7cd8b1e55322401dad53728892adbdc9ce4bf0b9c url=/mulesoft/current/en-us/dataweave/2.9/dw-dates-functions-atbeginningofday.md -->

---
product: DataWeave
version: 2.9
---

# atBeginningOfDay

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## atBeginningOfDay(dateTime: DateTime): DateTime

Returns a new `DateTime` value that changes the `Time` value in the input to the beginning of the
specified _day_.

The hours, minutes, and seconds in the input change to `00:00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><div><div><p>The <code>DateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Time` value within the `DateTime` input to the beginning of the specified
day.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  "atBeginningOfDayDateTime": atBeginningOfDay(|2020-10-06T18:23:20.351-03:00|)
}
```

#### Output

```Json
{
  "atBeginningOfDayDateTime": "2020-10-06T00:00:00-03:00"
}
```

## atBeginningOfDay(localDateTime: LocalDateTime): LocalDateTime

Returns a new `LocalDateTime` value that changes the `Time` value within the input to the start of
the specified _day_.

The hours, minutes, and seconds in the input change to `00:00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>localDateTime</code></p></td><td><div><div><p>The <code>LocalDateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Time` value within the `LocalDateTime` input to the beginning of the
specified day.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  "atBeginningOfDayLocalDateTime": atBeginningOfDay(|2020-10-06T18:23:20.351|)
}
```

#### Output

```Json
{
  "atBeginningOfDayLocalDateTime": "2020-10-06T00:00:00"
}
```

<!-- document id=905101f6a3b65c5aec3ac85dc32e2c28cc11ee1f575422a75b8b4958311a3bd9 url=/mulesoft/current/en-us/dataweave/latest/dw-dates-functions-atbeginningofday.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# atBeginningOfDay

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## atBeginningOfDay(dateTime: DateTime): DateTime

Returns a new `DateTime` value that changes the `Time` value in the input to the beginning of the
specified _day_.

The hours, minutes, and seconds in the input change to `00:00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><div><div><p>The <code>DateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Time` value within the `DateTime` input to the beginning of the specified
day.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  "atBeginningOfDayDateTime": atBeginningOfDay(|2020-10-06T18:23:20.351-03:00|)
}
```

#### Output

```Json
{
  "atBeginningOfDayDateTime": "2020-10-06T00:00:00-03:00"
}
```

## atBeginningOfDay(localDateTime: LocalDateTime): LocalDateTime

Returns a new `LocalDateTime` value that changes the `Time` value within the input to the start of
the specified _day_.

The hours, minutes, and seconds in the input change to `00:00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>localDateTime</code></p></td><td><div><div><p>The <code>LocalDateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Time` value within the `LocalDateTime` input to the beginning of the
specified day.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  "atBeginningOfDayLocalDateTime": atBeginningOfDay(|2020-10-06T18:23:20.351|)
}
```

#### Output

```Json
{
  "atBeginningOfDayLocalDateTime": "2020-10-06T00:00:00"
}
```

<!-- document id=2e595995f2eb1d6d006d057992e2257f293e3b1a2383c2086d78f2b408f44e40 url=/mulesoft/current/en-us/dataweave/2.11/dw-dates-functions-atbeginningofhour.md -->

---
product: DataWeave
version: 2.11
---

# atBeginningOfHour

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## atBeginningOfHour(dateTime: DateTime): DateTime

Returns a new `DateTime` value that changes the `Time` value in the input to the beginning of the
specified _hour_.

The minutes and seconds in the input change to `00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><div><div><p>The <code>DateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Time` value within the `DateTime` input to the beginning of the specified
_hour_.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
   "atBeginningOfHourDateTime": atBeginningOfHour(|2020-10-06T18:23:20.351-03:00|)
}
```

#### Output

```Json
{
 "atBeginningOfHourDateTime": "2020-10-06T18:00:00-03:00"
}
```

## atBeginningOfHour(localDateTime: LocalDateTime): LocalDateTime

Returns a new `LocalDateTime` value that changes the `Time` value in the input to the beginning of
the specified _hour_.

The minutes and seconds in the input change to `00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>localDateTime</code></p></td><td><div><div><p>The <code>LocalDateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Time` value within the `LocalDateTime` input to the beginning of the
specified hour.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
   "atBeginningOfHourLocalDateTime": atBeginningOfHour(|2020-10-06T18:23:20.351|)
}
```

#### Output

```Json
{
 "atBeginningOfHourLocalDateTime": "2020-10-06T18:00:00"
}
```

## atBeginningOfHour(localTime: LocalTime): LocalTime

Returns a new `LocalTime` value that changes its value in the input to the beginning of the
specified _hour_.

The minutes and seconds in the input change to `00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>localTime</code></p></td><td><div><div><p>The <code>LocalTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `LocalTime` value to the beginning of the specified hour.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
   "atBeginningOfHourLocalTime": atBeginningOfHour(|18:23:20.351|)
}
```

#### Output

```Json
{
 "atBeginningOfHourLocalTime": "18:00:00"
}
```

## atBeginningOfHour(time: Time): Time

Returns a new `Time` value that changes the input value to the beginning of the specified _hour_.

The minutes and seconds in the input change to `00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>time</code></p></td><td><div><div><p>The <code>Time</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Time` value to the beginning of the specified hour.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
   "atBeginningOfHourTime": atBeginningOfHour(|18:23:20.351-03:00|)
}
```

#### Output

```Json
{
 "atBeginningOfHourTime":  "18:00:00-03:00"
}
```

<!-- document id=dff6ebfec609148cfaf5be280b1dc5e47ffb720707be6c0f3cee4410557bea80 url=/mulesoft/current/en-us/dataweave/2.12/dw-dates-functions-atbeginningofhour.md -->

---
product: DataWeave
version: 2.12
---

# atBeginningOfHour

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## atBeginningOfHour(dateTime: DateTime): DateTime

Returns a new `DateTime` value that changes the `Time` value in the input to the beginning of the
specified _hour_.

The minutes and seconds in the input change to `00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><div><div><p>The <code>DateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Time` value within the `DateTime` input to the beginning of the specified
_hour_.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
   "atBeginningOfHourDateTime": atBeginningOfHour(|2020-10-06T18:23:20.351-03:00|)
}
```

#### Output

```Json
{
 "atBeginningOfHourDateTime": "2020-10-06T18:00:00-03:00"
}
```

## atBeginningOfHour(localDateTime: LocalDateTime): LocalDateTime

Returns a new `LocalDateTime` value that changes the `Time` value in the input to the beginning of
the specified _hour_.

The minutes and seconds in the input change to `00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>localDateTime</code></p></td><td><div><div><p>The <code>LocalDateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Time` value within the `LocalDateTime` input to the beginning of the
specified hour.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
   "atBeginningOfHourLocalDateTime": atBeginningOfHour(|2020-10-06T18:23:20.351|)
}
```

#### Output

```Json
{
 "atBeginningOfHourLocalDateTime": "2020-10-06T18:00:00"
}
```

## atBeginningOfHour(localTime: LocalTime): LocalTime

Returns a new `LocalTime` value that changes its value in the input to the beginning of the
specified _hour_.

The minutes and seconds in the input change to `00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>localTime</code></p></td><td><div><div><p>The <code>LocalTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `LocalTime` value to the beginning of the specified hour.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
   "atBeginningOfHourLocalTime": atBeginningOfHour(|18:23:20.351|)
}
```

#### Output

```Json
{
 "atBeginningOfHourLocalTime": "18:00:00"
}
```

## atBeginningOfHour(time: Time): Time

Returns a new `Time` value that changes the input value to the beginning of the specified _hour_.

The minutes and seconds in the input change to `00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>time</code></p></td><td><div><div><p>The <code>Time</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Time` value to the beginning of the specified hour.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
   "atBeginningOfHourTime": atBeginningOfHour(|18:23:20.351-03:00|)
}
```

#### Output

```Json
{
 "atBeginningOfHourTime":  "18:00:00-03:00"
}
```

<!-- document id=cd87739e1ea42538c69a06c8f79769e061247eb2d8e5edd7c3423e56bbf02be3 url=/mulesoft/current/en-us/dataweave/2.4/dw-dates-functions-atbeginningofhour.md -->

---
product: DataWeave
version: 2.4
---

# atBeginningOfHour

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## atBeginningOfHour(dateTime: DateTime): DateTime

Returns a new `DateTime` value that changes the `Time` value in the input to the beginning of the
specified _hour_.

The minutes and seconds in the input change to `00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><div><div><p>The <code>DateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Time` value within the `DateTime` input to the beginning of the specified
_hour_.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
   "atBeginningOfHourDateTime": atBeginningOfHour(|2020-10-06T18:23:20.351-03:00|)
}
```

#### Output

```Json
{
 "atBeginningOfHourDateTime": "2020-10-06T18:00:00-03:00"
}
```

## atBeginningOfHour(localDateTime: LocalDateTime): LocalDateTime

Returns a new `LocalDateTime` value that changes the `Time` value in the input to the beginning of
the specified _hour_.

The minutes and seconds in the input change to `00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>localDateTime</code></p></td><td><div><div><p>The <code>LocalDateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Time` value within the `LocalDateTime` input to the beginning of the
specified hour.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
   "atBeginningOfHourLocalDateTime": atBeginningOfHour(|2020-10-06T18:23:20.351|)
}
```

#### Output

```Json
{
 "atBeginningOfHourLocalDateTime": "2020-10-06T18:00:00"
}
```

## atBeginningOfHour(localTime: LocalTime): LocalTime

Returns a new `LocalTime` value that changes its value in the input to the beginning of the
specified _hour_.

The minutes and seconds in the input change to `00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>localTime</code></p></td><td><div><div><p>The <code>LocalTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `LocalTime` value to the beginning of the specified hour.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
   "atBeginningOfHourLocalTime": atBeginningOfHour(|18:23:20.351|)
}
```

#### Output

```Json
{
 "atBeginningOfHourLocalTime": "18:00:00"
}
```

## atBeginningOfHour(time: Time): Time

Returns a new `Time` value that changes the input value to the beginning of the specified _hour_.

The minutes and seconds in the input change to `00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>time</code></p></td><td><div><div><p>The <code>Time</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Time` value to the beginning of the specified hour.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
   "atBeginningOfHourTime": atBeginningOfHour(|18:23:20.351-03:00|)
}
```

#### Output

```Json
{
 "atBeginningOfHourTime":  "18:00:00-03:00"
}
```

<!-- document id=544a3b93831922e8edafe1ae5ff989284c0978f136754bf814b3a910412d29aa url=/mulesoft/current/en-us/dataweave/2.6/dw-dates-functions-atbeginningofhour.md -->

---
product: DataWeave
version: 2.6
---

# atBeginningOfHour

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## atBeginningOfHour(dateTime: DateTime): DateTime

Returns a new `DateTime` value that changes the `Time` value in the input to the beginning of the
specified _hour_.

The minutes and seconds in the input change to `00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><div><div><p>The <code>DateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Time` value within the `DateTime` input to the beginning of the specified
_hour_.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
   "atBeginningOfHourDateTime": atBeginningOfHour(|2020-10-06T18:23:20.351-03:00|)
}
```

#### Output

```Json
{
 "atBeginningOfHourDateTime": "2020-10-06T18:00:00-03:00"
}
```

## atBeginningOfHour(localDateTime: LocalDateTime): LocalDateTime

Returns a new `LocalDateTime` value that changes the `Time` value in the input to the beginning of
the specified _hour_.

The minutes and seconds in the input change to `00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>localDateTime</code></p></td><td><div><div><p>The <code>LocalDateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Time` value within the `LocalDateTime` input to the beginning of the
specified hour.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
   "atBeginningOfHourLocalDateTime": atBeginningOfHour(|2020-10-06T18:23:20.351|)
}
```

#### Output

```Json
{
 "atBeginningOfHourLocalDateTime": "2020-10-06T18:00:00"
}
```

## atBeginningOfHour(localTime: LocalTime): LocalTime

Returns a new `LocalTime` value that changes its value in the input to the beginning of the
specified _hour_.

The minutes and seconds in the input change to `00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>localTime</code></p></td><td><div><div><p>The <code>LocalTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `LocalTime` value to the beginning of the specified hour.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
   "atBeginningOfHourLocalTime": atBeginningOfHour(|18:23:20.351|)
}
```

#### Output

```Json
{
 "atBeginningOfHourLocalTime": "18:00:00"
}
```

## atBeginningOfHour(time: Time): Time

Returns a new `Time` value that changes the input value to the beginning of the specified _hour_.

The minutes and seconds in the input change to `00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>time</code></p></td><td><div><div><p>The <code>Time</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Time` value to the beginning of the specified hour.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
   "atBeginningOfHourTime": atBeginningOfHour(|18:23:20.351-03:00|)
}
```

#### Output

```Json
{
 "atBeginningOfHourTime":  "18:00:00-03:00"
}
```

<!-- document id=04d963d507835e34cf98b23d8e89d9b43f61f7dfc8cb85349065203a358d3722 url=/mulesoft/current/en-us/dataweave/2.9/dw-dates-functions-atbeginningofhour.md -->

---
product: DataWeave
version: 2.9
---

# atBeginningOfHour

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## atBeginningOfHour(dateTime: DateTime): DateTime

Returns a new `DateTime` value that changes the `Time` value in the input to the beginning of the
specified _hour_.

The minutes and seconds in the input change to `00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><div><div><p>The <code>DateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Time` value within the `DateTime` input to the beginning of the specified
_hour_.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
   "atBeginningOfHourDateTime": atBeginningOfHour(|2020-10-06T18:23:20.351-03:00|)
}
```

#### Output

```Json
{
 "atBeginningOfHourDateTime": "2020-10-06T18:00:00-03:00"
}
```

## atBeginningOfHour(localDateTime: LocalDateTime): LocalDateTime

Returns a new `LocalDateTime` value that changes the `Time` value in the input to the beginning of
the specified _hour_.

The minutes and seconds in the input change to `00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>localDateTime</code></p></td><td><div><div><p>The <code>LocalDateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Time` value within the `LocalDateTime` input to the beginning of the
specified hour.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
   "atBeginningOfHourLocalDateTime": atBeginningOfHour(|2020-10-06T18:23:20.351|)
}
```

#### Output

```Json
{
 "atBeginningOfHourLocalDateTime": "2020-10-06T18:00:00"
}
```

## atBeginningOfHour(localTime: LocalTime): LocalTime

Returns a new `LocalTime` value that changes its value in the input to the beginning of the
specified _hour_.

The minutes and seconds in the input change to `00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>localTime</code></p></td><td><div><div><p>The <code>LocalTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `LocalTime` value to the beginning of the specified hour.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
   "atBeginningOfHourLocalTime": atBeginningOfHour(|18:23:20.351|)
}
```

#### Output

```Json
{
 "atBeginningOfHourLocalTime": "18:00:00"
}
```

## atBeginningOfHour(time: Time): Time

Returns a new `Time` value that changes the input value to the beginning of the specified _hour_.

The minutes and seconds in the input change to `00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>time</code></p></td><td><div><div><p>The <code>Time</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Time` value to the beginning of the specified hour.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
   "atBeginningOfHourTime": atBeginningOfHour(|18:23:20.351-03:00|)
}
```

#### Output

```Json
{
 "atBeginningOfHourTime":  "18:00:00-03:00"
}
```

<!-- document id=f979e373e4af3564b7d195d958f7fee8ccbd6c33d3943de032f786d91c25ddc1 url=/mulesoft/current/en-us/dataweave/latest/dw-dates-functions-atbeginningofhour.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# atBeginningOfHour

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## atBeginningOfHour(dateTime: DateTime): DateTime

Returns a new `DateTime` value that changes the `Time` value in the input to the beginning of the
specified _hour_.

The minutes and seconds in the input change to `00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><div><div><p>The <code>DateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Time` value within the `DateTime` input to the beginning of the specified
_hour_.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
   "atBeginningOfHourDateTime": atBeginningOfHour(|2020-10-06T18:23:20.351-03:00|)
}
```

#### Output

```Json
{
 "atBeginningOfHourDateTime": "2020-10-06T18:00:00-03:00"
}
```

## atBeginningOfHour(localDateTime: LocalDateTime): LocalDateTime

Returns a new `LocalDateTime` value that changes the `Time` value in the input to the beginning of
the specified _hour_.

The minutes and seconds in the input change to `00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>localDateTime</code></p></td><td><div><div><p>The <code>LocalDateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Time` value within the `LocalDateTime` input to the beginning of the
specified hour.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
   "atBeginningOfHourLocalDateTime": atBeginningOfHour(|2020-10-06T18:23:20.351|)
}
```

#### Output

```Json
{
 "atBeginningOfHourLocalDateTime": "2020-10-06T18:00:00"
}
```

## atBeginningOfHour(localTime: LocalTime): LocalTime

Returns a new `LocalTime` value that changes its value in the input to the beginning of the
specified _hour_.

The minutes and seconds in the input change to `00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>localTime</code></p></td><td><div><div><p>The <code>LocalTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `LocalTime` value to the beginning of the specified hour.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
   "atBeginningOfHourLocalTime": atBeginningOfHour(|18:23:20.351|)
}
```

#### Output

```Json
{
 "atBeginningOfHourLocalTime": "18:00:00"
}
```

## atBeginningOfHour(time: Time): Time

Returns a new `Time` value that changes the input value to the beginning of the specified _hour_.

The minutes and seconds in the input change to `00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>time</code></p></td><td><div><div><p>The <code>Time</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Time` value to the beginning of the specified hour.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
   "atBeginningOfHourTime": atBeginningOfHour(|18:23:20.351-03:00|)
}
```

#### Output

```Json
{
 "atBeginningOfHourTime":  "18:00:00-03:00"
}
```

<!-- document id=b4e58df38f3c410ca5dfdc6a4a2f294d2733ca6ca7e6a183d1285b2e4ab491a3 url=/mulesoft/current/en-us/dataweave/2.11/dw-dates-functions-atbeginningofmonth.md -->

---
product: DataWeave
version: 2.11
---

# atBeginningOfMonth

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## atBeginningOfMonth(dateTime: DateTime): DateTime

Returns a new `DateTime` value that changes the `Day` value from the input to the first day of the
specified _month_. It also sets the `Time` value to `00:00:00`.

The day and time in the input changes to `01T00:00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><div><div><p>The <code>DateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Day` value within the `DateTime` input to the first day of the specified
month and sets the `Time` value to `00:00:00`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  "atBeginningOfMonthDateTime": atBeginningOfMonth(|2020-10-06T18:23:20.351-03:00|)
}
```

#### Output

```Json
{
  "atBeginningOfMonthDateTime": "2020-10-01T00:00:00-03:00"
}
```

## atBeginningOfMonth(localDateTime: LocalDateTime): LocalDateTime

Returns a new `LocalDateTime` value that changes the `Day` and `LocalTime` values from the input to
the beginning of the specified _month_.

The day and time in the input changes to `01T00:00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>localDateTime</code></p></td><td><div><div><p>The <code>LocalDateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Day` and `LocalTime` values within the `LocalDateTime` input to the
beginning of the specified month.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
 "atBeginningOfMonthLocalDateTime": atBeginningOfMonth(|2020-10-06T18:23:20.351|)
}
```

#### Output

```Json
{
  "atBeginningOfMonthLocalDateTime": "2020-10-01T00:00:00"
}
```

## atBeginningOfMonth(date: Date): Date

Returns a new `Date` value that changes the `Day` value from the input to the first day of the
specified _month_.

The day in the input changes to `01`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><div><div><p>The <code>Date</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Day` value within the `Date` input to the first day of the specified
month.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  atBeginningOfMonthDate: atBeginningOfMonth(|2020-10-06|)
}
```

#### Output

```Json
{
  "atBeginningOfMonthDate": "2020-10-01"
}
```

<!-- document id=d17fea6e5f015e6173f755179a514d2fb07195b6ce9a5ff39533e018a6349e81 url=/mulesoft/current/en-us/dataweave/2.12/dw-dates-functions-atbeginningofmonth.md -->

---
product: DataWeave
version: 2.12
---

# atBeginningOfMonth

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## atBeginningOfMonth(dateTime: DateTime): DateTime

Returns a new `DateTime` value that changes the `Day` value from the input to the first day of the
specified _month_. It also sets the `Time` value to `00:00:00`.

The day and time in the input changes to `01T00:00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><div><div><p>The <code>DateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Day` value within the `DateTime` input to the first day of the specified
month and sets the `Time` value to `00:00:00`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  "atBeginningOfMonthDateTime": atBeginningOfMonth(|2020-10-06T18:23:20.351-03:00|)
}
```

#### Output

```Json
{
  "atBeginningOfMonthDateTime": "2020-10-01T00:00:00-03:00"
}
```

## atBeginningOfMonth(localDateTime: LocalDateTime): LocalDateTime

Returns a new `LocalDateTime` value that changes the `Day` and `LocalTime` values from the input to
the beginning of the specified _month_.

The day and time in the input changes to `01T00:00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>localDateTime</code></p></td><td><div><div><p>The <code>LocalDateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Day` and `LocalTime` values within the `LocalDateTime` input to the
beginning of the specified month.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
 "atBeginningOfMonthLocalDateTime": atBeginningOfMonth(|2020-10-06T18:23:20.351|)
}
```

#### Output

```Json
{
  "atBeginningOfMonthLocalDateTime": "2020-10-01T00:00:00"
}
```

## atBeginningOfMonth(date: Date): Date

Returns a new `Date` value that changes the `Day` value from the input to the first day of the
specified _month_.

The day in the input changes to `01`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><div><div><p>The <code>Date</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Day` value within the `Date` input to the first day of the specified
month.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  atBeginningOfMonthDate: atBeginningOfMonth(|2020-10-06|)
}
```

#### Output

```Json
{
  "atBeginningOfMonthDate": "2020-10-01"
}
```

<!-- document id=ebccdf49473ba847263a0065520b70c7cda84b0c4762d7894d9fcab6ff75efc8 url=/mulesoft/current/en-us/dataweave/2.4/dw-dates-functions-atbeginningofmonth.md -->

---
product: DataWeave
version: 2.4
---

# atBeginningOfMonth

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## atBeginningOfMonth(dateTime: DateTime): DateTime

Returns a new `DateTime` value that changes the `Day` value from the input to the first day of the
specified _month_. It also sets the `Time` value to `00:00:00`.

The day and time in the input changes to `01T00:00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><div><div><p>The <code>DateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Day` value within the `DateTime` input to the first day of the specified
month and sets the `Time` value to `00:00:00`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  "atBeginningOfMonthDateTime": atBeginningOfMonth(|2020-10-06T18:23:20.351-03:00|)
}
```

#### Output

```Json
{
  "atBeginningOfMonthDateTime": "2020-10-01T00:00:00-03:00"
}
```

## atBeginningOfMonth(localDateTime: LocalDateTime): LocalDateTime

Returns a new `LocalDateTime` value that changes the `Day` and `LocalTime` values from the input to
the beginning of the specified _month_.

The day and time in the input changes to `01T00:00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>localDateTime</code></p></td><td><div><div><p>The <code>LocalDateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Day` and `LocalTime` values within the `LocalDateTime` input to the
beginning of the specified month.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
 "atBeginningOfMonthLocalDateTime": atBeginningOfMonth(|2020-10-06T18:23:20.351|)
}
```

#### Output

```Json
{
  "atBeginningOfMonthLocalDateTime": "2020-10-01T00:00:00"
}
```

## atBeginningOfMonth(date: Date): Date

Returns a new `Date` value that changes the `Day` value from the input to the first day of the
specified _month_.

The day in the input changes to `01`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><div><div><p>The <code>Date</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Day` value within the `Date` input to the first day of the specified
month.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  atBeginningOfMonthDate: atBeginningOfMonth(|2020-10-06|)
}
```

#### Output

```Json
{
  "atBeginningOfMonthDate": "2020-10-01"
}
```

<!-- document id=0809382553aeb885c837d0681fcea29e9d8c283acc3ae5a240ef0e3d241acd1e url=/mulesoft/current/en-us/dataweave/2.6/dw-dates-functions-atbeginningofmonth.md -->

---
product: DataWeave
version: 2.6
---

# atBeginningOfMonth

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## atBeginningOfMonth(dateTime: DateTime): DateTime

Returns a new `DateTime` value that changes the `Day` value from the input to the first day of the
specified _month_. It also sets the `Time` value to `00:00:00`.

The day and time in the input changes to `01T00:00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><div><div><p>The <code>DateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Day` value within the `DateTime` input to the first day of the specified
month and sets the `Time` value to `00:00:00`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  "atBeginningOfMonthDateTime": atBeginningOfMonth(|2020-10-06T18:23:20.351-03:00|)
}
```

#### Output

```Json
{
  "atBeginningOfMonthDateTime": "2020-10-01T00:00:00-03:00"
}
```

## atBeginningOfMonth(localDateTime: LocalDateTime): LocalDateTime

Returns a new `LocalDateTime` value that changes the `Day` and `LocalTime` values from the input to
the beginning of the specified _month_.

The day and time in the input changes to `01T00:00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>localDateTime</code></p></td><td><div><div><p>The <code>LocalDateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Day` and `LocalTime` values within the `LocalDateTime` input to the
beginning of the specified month.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
 "atBeginningOfMonthLocalDateTime": atBeginningOfMonth(|2020-10-06T18:23:20.351|)
}
```

#### Output

```Json
{
  "atBeginningOfMonthLocalDateTime": "2020-10-01T00:00:00"
}
```

## atBeginningOfMonth(date: Date): Date

Returns a new `Date` value that changes the `Day` value from the input to the first day of the
specified _month_.

The day in the input changes to `01`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><div><div><p>The <code>Date</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Day` value within the `Date` input to the first day of the specified
month.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  atBeginningOfMonthDate: atBeginningOfMonth(|2020-10-06|)
}
```

#### Output

```Json
{
  "atBeginningOfMonthDate": "2020-10-01"
}
```

<!-- document id=038be76e9abbfe6828074eb2f3a564b08a753cd2ebe38aa13d01eed8014231a0 url=/mulesoft/current/en-us/dataweave/2.9/dw-dates-functions-atbeginningofmonth.md -->

---
product: DataWeave
version: 2.9
---

# atBeginningOfMonth

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## atBeginningOfMonth(dateTime: DateTime): DateTime

Returns a new `DateTime` value that changes the `Day` value from the input to the first day of the
specified _month_. It also sets the `Time` value to `00:00:00`.

The day and time in the input changes to `01T00:00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><div><div><p>The <code>DateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Day` value within the `DateTime` input to the first day of the specified
month and sets the `Time` value to `00:00:00`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  "atBeginningOfMonthDateTime": atBeginningOfMonth(|2020-10-06T18:23:20.351-03:00|)
}
```

#### Output

```Json
{
  "atBeginningOfMonthDateTime": "2020-10-01T00:00:00-03:00"
}
```

## atBeginningOfMonth(localDateTime: LocalDateTime): LocalDateTime

Returns a new `LocalDateTime` value that changes the `Day` and `LocalTime` values from the input to
the beginning of the specified _month_.

The day and time in the input changes to `01T00:00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>localDateTime</code></p></td><td><div><div><p>The <code>LocalDateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Day` and `LocalTime` values within the `LocalDateTime` input to the
beginning of the specified month.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
 "atBeginningOfMonthLocalDateTime": atBeginningOfMonth(|2020-10-06T18:23:20.351|)
}
```

#### Output

```Json
{
  "atBeginningOfMonthLocalDateTime": "2020-10-01T00:00:00"
}
```

## atBeginningOfMonth(date: Date): Date

Returns a new `Date` value that changes the `Day` value from the input to the first day of the
specified _month_.

The day in the input changes to `01`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><div><div><p>The <code>Date</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Day` value within the `Date` input to the first day of the specified
month.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  atBeginningOfMonthDate: atBeginningOfMonth(|2020-10-06|)
}
```

#### Output

```Json
{
  "atBeginningOfMonthDate": "2020-10-01"
}
```

<!-- document id=72d2bd5d892fdb864aae7fd813337dea215d40a96135783f190ac40fda5c9fff url=/mulesoft/current/en-us/dataweave/latest/dw-dates-functions-atbeginningofmonth.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# atBeginningOfMonth

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## atBeginningOfMonth(dateTime: DateTime): DateTime

Returns a new `DateTime` value that changes the `Day` value from the input to the first day of the
specified _month_. It also sets the `Time` value to `00:00:00`.

The day and time in the input changes to `01T00:00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><div><div><p>The <code>DateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Day` value within the `DateTime` input to the first day of the specified
month and sets the `Time` value to `00:00:00`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  "atBeginningOfMonthDateTime": atBeginningOfMonth(|2020-10-06T18:23:20.351-03:00|)
}
```

#### Output

```Json
{
  "atBeginningOfMonthDateTime": "2020-10-01T00:00:00-03:00"
}
```

## atBeginningOfMonth(localDateTime: LocalDateTime): LocalDateTime

Returns a new `LocalDateTime` value that changes the `Day` and `LocalTime` values from the input to
the beginning of the specified _month_.

The day and time in the input changes to `01T00:00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>localDateTime</code></p></td><td><div><div><p>The <code>LocalDateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Day` and `LocalTime` values within the `LocalDateTime` input to the
beginning of the specified month.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
 "atBeginningOfMonthLocalDateTime": atBeginningOfMonth(|2020-10-06T18:23:20.351|)
}
```

#### Output

```Json
{
  "atBeginningOfMonthLocalDateTime": "2020-10-01T00:00:00"
}
```

## atBeginningOfMonth(date: Date): Date

Returns a new `Date` value that changes the `Day` value from the input to the first day of the
specified _month_.

The day in the input changes to `01`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><div><div><p>The <code>Date</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Day` value within the `Date` input to the first day of the specified
month.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  atBeginningOfMonthDate: atBeginningOfMonth(|2020-10-06|)
}
```

#### Output

```Json
{
  "atBeginningOfMonthDate": "2020-10-01"
}
```

<!-- document id=aba8fa0e58aae5df8735467d0b87cd4a2530d499b95533b6edaba406b219b138 url=/mulesoft/current/en-us/dataweave/2.11/dw-dates-functions-atbeginningofweek.md -->

---
product: DataWeave
version: 2.11
---

# atBeginningOfWeek

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## atBeginningOfWeek(dateTime: DateTime): DateTime

Returns a new `DateTime` value that changes the `Day` and `Time` values from the input to the
beginning of the first day of the specified _week_.

The function treats Sunday as the first day of the week.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><div><div><p>The <code>DateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Day` and `Time` values (`06T18:23:20.351`) within the `DateTime` input to
the beginning of the first day of the specified _week_ (`04T00:00:00`).

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  atBeginningOfWeekDateTime: atBeginningOfWeek(|2020-10-06T18:23:20.351-03:00|)
}
```

#### Output

```Json
{
  "atBeginningOfWeekDateTime": "2020-10-04T00:00:00-03:00"
}
```

## atBeginningOfWeek(localDateTime: LocalDateTime): LocalDateTime

Returns a new `LocalDateTime` value that changes the `Day` and `Time` values from the input to the
beginning of the first day of the specified _week_.

The function treats Sunday as the first day of the week.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>localDateTime</code></p></td><td><div><div><p>The <code>LocalDateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Day` and `Time` values (`06T18:23:20.351`) within the `LocalDateTime`
input to the beginning of the first day of the specified _week_ (`04T00:00:00`).

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  atBeginningOfWeekLocalDateTime: atBeginningOfWeek(|2020-10-06T18:23:20.351|)
}
```

#### Output

```Json
{
  "atBeginningOfWeekLocalDateTime": "2020-10-04T00:00:00"
}
```

## atBeginningOfWeek(date: Date): Date

Returns a new `Date` value that changes the `Date` input input to the first day of the specified
_week_.

The function treats Sunday as the first day of the week.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><div><div><p>The <code>Date</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Day` value (`06`) within the `Date` input to the first day of the week
that contains `2020-10-06` (a Tuesday), which is `2020-10-04` (a Sunday). The `Day` value changes
from `06` to `04`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  atBeginningOfWeekDate: atBeginningOfWeek(|2020-10-06|)
}
```

#### Output

```Json
{
  "atBeginningOfWeekDate": "2020-10-04"
}
```

<!-- document id=17234599ec5aa53e91cc9299660c00050e534e9339276e95983dc066d6c74e5a url=/mulesoft/current/en-us/dataweave/2.12/dw-dates-functions-atbeginningofweek.md -->

---
product: DataWeave
version: 2.12
---

# atBeginningOfWeek

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## atBeginningOfWeek(dateTime: DateTime): DateTime

Returns a new `DateTime` value that changes the `Day` and `Time` values from the input to the
beginning of the first day of the specified _week_.

The function treats Sunday as the first day of the week.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><div><div><p>The <code>DateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Day` and `Time` values (`06T18:23:20.351`) within the `DateTime` input to
the beginning of the first day of the specified _week_ (`04T00:00:00`).

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  atBeginningOfWeekDateTime: atBeginningOfWeek(|2020-10-06T18:23:20.351-03:00|)
}
```

#### Output

```Json
{
  "atBeginningOfWeekDateTime": "2020-10-04T00:00:00-03:00"
}
```

## atBeginningOfWeek(localDateTime: LocalDateTime): LocalDateTime

Returns a new `LocalDateTime` value that changes the `Day` and `Time` values from the input to the
beginning of the first day of the specified _week_.

The function treats Sunday as the first day of the week.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>localDateTime</code></p></td><td><div><div><p>The <code>LocalDateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Day` and `Time` values (`06T18:23:20.351`) within the `LocalDateTime`
input to the beginning of the first day of the specified _week_ (`04T00:00:00`).

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  atBeginningOfWeekLocalDateTime: atBeginningOfWeek(|2020-10-06T18:23:20.351|)
}
```

#### Output

```Json
{
  "atBeginningOfWeekLocalDateTime": "2020-10-04T00:00:00"
}
```

## atBeginningOfWeek(date: Date): Date

Returns a new `Date` value that changes the `Date` input input to the first day of the specified
_week_.

The function treats Sunday as the first day of the week.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><div><div><p>The <code>Date</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Day` value (`06`) within the `Date` input to the first day of the week
that contains `2020-10-06` (a Tuesday), which is `2020-10-04` (a Sunday). The `Day` value changes
from `06` to `04`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  atBeginningOfWeekDate: atBeginningOfWeek(|2020-10-06|)
}
```

#### Output

```Json
{
  "atBeginningOfWeekDate": "2020-10-04"
}
```

<!-- document id=0d40da021ba7f9613f4c79f29ec8487a8f41bdbd708b6eead04bdcd4729a8c42 url=/mulesoft/current/en-us/dataweave/2.4/dw-dates-functions-atbeginningofweek.md -->

---
product: DataWeave
version: 2.4
---

# atBeginningOfWeek

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## atBeginningOfWeek(dateTime: DateTime): DateTime

Returns a new `DateTime` value that changes the `Day` and `Time` values from the input to the
beginning of the first day of the specified _week_.

The function treats Sunday as the first day of the week.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><div><div><p>The <code>DateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Day` and `Time` values (`06T18:23:20.351`) within the `DateTime` input to
the beginning of the first day of the specified _week_ (`04T00:00:00`).

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  atBeginningOfWeekDateTime: atBeginningOfWeek(|2020-10-06T18:23:20.351-03:00|)
}
```

#### Output

```Json
{
  "atBeginningOfWeekDateTime": "2020-10-04T00:00:00-03:00"
}
```

## atBeginningOfWeek(localDateTime: LocalDateTime): LocalDateTime

Returns a new `LocalDateTime` value that changes the `Day` and `Time` values from the input to the
beginning of the first day of the specified _week_.

The function treats Sunday as the first day of the week.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>localDateTime</code></p></td><td><div><div><p>The <code>LocalDateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Day` and `Time` values (`06T18:23:20.351`) within the `LocalDateTime`
input to the beginning of the first day of the specified _week_ (`04T00:00:00`).

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  atBeginningOfWeekLocalDateTime: atBeginningOfWeek(|2020-10-06T18:23:20.351|)
}
```

#### Output

```Json
{
  "atBeginningOfWeekLocalDateTime": "2020-10-04T00:00:00"
}
```

## atBeginningOfWeek(date: Date): Date

Returns a new `Date` value that changes the `Date` input input to the first day of the specified
_week_.

The function treats Sunday as the first day of the week.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><div><div><p>The <code>Date</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Day` value (`06`) within the `Date` input to the first day of the week
that contains `2020-10-06` (a Tuesday), which is `2020-10-04` (a Sunday). The `Day` value changes
from `06` to `04`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  atBeginningOfWeekDate: atBeginningOfWeek(|2020-10-06|)
}
```

#### Output

```Json
{
  "atBeginningOfWeekDate": "2020-10-04"
}
```

<!-- document id=fbe86af2b2376675acade85661b2d6d7270c5292be6e432767c8d74a902684d3 url=/mulesoft/current/en-us/dataweave/2.6/dw-dates-functions-atbeginningofweek.md -->

---
product: DataWeave
version: 2.6
---

# atBeginningOfWeek

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## atBeginningOfWeek(dateTime: DateTime): DateTime

Returns a new `DateTime` value that changes the `Day` and `Time` values from the input to the
beginning of the first day of the specified _week_.

The function treats Sunday as the first day of the week.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><div><div><p>The <code>DateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Day` and `Time` values (`06T18:23:20.351`) within the `DateTime` input to
the beginning of the first day of the specified _week_ (`04T00:00:00`).

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  atBeginningOfWeekDateTime: atBeginningOfWeek(|2020-10-06T18:23:20.351-03:00|)
}
```

#### Output

```Json
{
  "atBeginningOfWeekDateTime": "2020-10-04T00:00:00-03:00"
}
```

## atBeginningOfWeek(localDateTime: LocalDateTime): LocalDateTime

Returns a new `LocalDateTime` value that changes the `Day` and `Time` values from the input to the
beginning of the first day of the specified _week_.

The function treats Sunday as the first day of the week.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>localDateTime</code></p></td><td><div><div><p>The <code>LocalDateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Day` and `Time` values (`06T18:23:20.351`) within the `LocalDateTime`
input to the beginning of the first day of the specified _week_ (`04T00:00:00`).

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  atBeginningOfWeekLocalDateTime: atBeginningOfWeek(|2020-10-06T18:23:20.351|)
}
```

#### Output

```Json
{
  "atBeginningOfWeekLocalDateTime": "2020-10-04T00:00:00"
}
```

## atBeginningOfWeek(date: Date): Date

Returns a new `Date` value that changes the `Date` input input to the first day of the specified
_week_.

The function treats Sunday as the first day of the week.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><div><div><p>The <code>Date</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Day` value (`06`) within the `Date` input to the first day of the week
that contains `2020-10-06` (a Tuesday), which is `2020-10-04` (a Sunday). The `Day` value changes
from `06` to `04`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  atBeginningOfWeekDate: atBeginningOfWeek(|2020-10-06|)
}
```

#### Output

```Json
{
  "atBeginningOfWeekDate": "2020-10-04"
}
```

<!-- document id=48ab314fb0793b1e8fc5a6ee44e8d5f518e0eed1d4c03312b34c4dac129d72fa url=/mulesoft/current/en-us/dataweave/2.9/dw-dates-functions-atbeginningofweek.md -->

---
product: DataWeave
version: 2.9
---

# atBeginningOfWeek

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## atBeginningOfWeek(dateTime: DateTime): DateTime

Returns a new `DateTime` value that changes the `Day` and `Time` values from the input to the
beginning of the first day of the specified _week_.

The function treats Sunday as the first day of the week.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><div><div><p>The <code>DateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Day` and `Time` values (`06T18:23:20.351`) within the `DateTime` input to
the beginning of the first day of the specified _week_ (`04T00:00:00`).

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  atBeginningOfWeekDateTime: atBeginningOfWeek(|2020-10-06T18:23:20.351-03:00|)
}
```

#### Output

```Json
{
  "atBeginningOfWeekDateTime": "2020-10-04T00:00:00-03:00"
}
```

## atBeginningOfWeek(localDateTime: LocalDateTime): LocalDateTime

Returns a new `LocalDateTime` value that changes the `Day` and `Time` values from the input to the
beginning of the first day of the specified _week_.

The function treats Sunday as the first day of the week.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>localDateTime</code></p></td><td><div><div><p>The <code>LocalDateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Day` and `Time` values (`06T18:23:20.351`) within the `LocalDateTime`
input to the beginning of the first day of the specified _week_ (`04T00:00:00`).

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  atBeginningOfWeekLocalDateTime: atBeginningOfWeek(|2020-10-06T18:23:20.351|)
}
```

#### Output

```Json
{
  "atBeginningOfWeekLocalDateTime": "2020-10-04T00:00:00"
}
```

## atBeginningOfWeek(date: Date): Date

Returns a new `Date` value that changes the `Date` input input to the first day of the specified
_week_.

The function treats Sunday as the first day of the week.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><div><div><p>The <code>Date</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Day` value (`06`) within the `Date` input to the first day of the week
that contains `2020-10-06` (a Tuesday), which is `2020-10-04` (a Sunday). The `Day` value changes
from `06` to `04`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  atBeginningOfWeekDate: atBeginningOfWeek(|2020-10-06|)
}
```

#### Output

```Json
{
  "atBeginningOfWeekDate": "2020-10-04"
}
```

<!-- document id=bdc6a7b39da64d03ae909d89ec0b9b926d4449db7774562ead1b666a7dd33876 url=/mulesoft/current/en-us/dataweave/latest/dw-dates-functions-atbeginningofweek.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# atBeginningOfWeek

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## atBeginningOfWeek(dateTime: DateTime): DateTime

Returns a new `DateTime` value that changes the `Day` and `Time` values from the input to the
beginning of the first day of the specified _week_.

The function treats Sunday as the first day of the week.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><div><div><p>The <code>DateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Day` and `Time` values (`06T18:23:20.351`) within the `DateTime` input to
the beginning of the first day of the specified _week_ (`04T00:00:00`).

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  atBeginningOfWeekDateTime: atBeginningOfWeek(|2020-10-06T18:23:20.351-03:00|)
}
```

#### Output

```Json
{
  "atBeginningOfWeekDateTime": "2020-10-04T00:00:00-03:00"
}
```

## atBeginningOfWeek(localDateTime: LocalDateTime): LocalDateTime

Returns a new `LocalDateTime` value that changes the `Day` and `Time` values from the input to the
beginning of the first day of the specified _week_.

The function treats Sunday as the first day of the week.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>localDateTime</code></p></td><td><div><div><p>The <code>LocalDateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Day` and `Time` values (`06T18:23:20.351`) within the `LocalDateTime`
input to the beginning of the first day of the specified _week_ (`04T00:00:00`).

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  atBeginningOfWeekLocalDateTime: atBeginningOfWeek(|2020-10-06T18:23:20.351|)
}
```

#### Output

```Json
{
  "atBeginningOfWeekLocalDateTime": "2020-10-04T00:00:00"
}
```

## atBeginningOfWeek(date: Date): Date

Returns a new `Date` value that changes the `Date` input input to the first day of the specified
_week_.

The function treats Sunday as the first day of the week.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><div><div><p>The <code>Date</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example changes the `Day` value (`06`) within the `Date` input to the first day of the week
that contains `2020-10-06` (a Tuesday), which is `2020-10-04` (a Sunday). The `Day` value changes
from `06` to `04`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  atBeginningOfWeekDate: atBeginningOfWeek(|2020-10-06|)
}
```

#### Output

```Json
{
  "atBeginningOfWeekDate": "2020-10-04"
}
```

<!-- document id=9d394950723b50975ba80779c7d343f689c773e7f944deccd2e67ad9fd8343ba url=/mulesoft/current/en-us/dataweave/2.11/dw-dates-functions-atbeginningofyear.md -->

---
product: DataWeave
version: 2.11
---

# atBeginningOfYear

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## atBeginningOfYear(dateTime: DateTime): DateTime

Takes a `DateTime` value as input and returns a `DateTime` value for the first day of the _year_
specified in the input. It also sets the `Time` value to `00:00:00`.

The month, day, and time in the input changes to `01-01T00:00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><div><div><p>The <code>DateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example transforms the `DateTime` input (`|2020-10-06T18:23:20.351-03:00|`) to the date of the
first day of the `Year` value (`2020`) in the input.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  atBeginningOfYearDateTime: atBeginningOfYear(|2020-10-06T18:23:20.351-03:00|)
}
```

#### Output

```Json
{
  "atBeginningOfYearDateTime": "2020-01-01T00:00:00.000-03:00"
}
```

## atBeginningOfYear(localDateTime: LocalDateTime): LocalDateTime

Takes a `LocalDateTime` value as input and returns a `LocalDateTime` value for the first day of the
_year_ specified in the input. It also sets the `Time` value to `00:00:00`.

The month, day, and time in the input changes to `01-01T00:00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>localDateTime</code></p></td><td><div><div><p>The <code>LocalDateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example transforms the `LocalDateTime` input (`|2020-10-06T18:23:20.351|`) to the date of the
first day of the `Year` value (`2020`) in the input.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  atBeginningOfYearLocalDateTime: atBeginningOfYear(|2020-10-06T18:23:20.351|)
}
```

#### Output

```Json
{
  "atBeginningOfYearLocalDateTime": "2020-01-01T00:00:00"
}
```

## atBeginningOfYear(date: Date): Date

Takes a `Date` value as input and returns a `Date` value for the first day of the _year_ specified
in the input.

The month and day in the input changes to `01-01`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><div><div><p>The <code>Date</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example transforms `Date` input (`|2020-10-06|`) to the date of the first day of the `Year`
value (`2020`) in the input.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  atBeginningOfYearDate: atBeginningOfYear(|2020-10-06|)
}
```

#### Output

```Json
{
  "atBeginningOfYearDate": "2020-01-01"
}
```

<!-- document id=dc17d5632aaa057187dae12250de87cfc01f082a85c52b01898ac144d14fe603 url=/mulesoft/current/en-us/dataweave/2.12/dw-dates-functions-atbeginningofyear.md -->

---
product: DataWeave
version: 2.12
---

# atBeginningOfYear

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## atBeginningOfYear(dateTime: DateTime): DateTime

Takes a `DateTime` value as input and returns a `DateTime` value for the first day of the _year_
specified in the input. It also sets the `Time` value to `00:00:00`.

The month, day, and time in the input changes to `01-01T00:00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><div><div><p>The <code>DateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example transforms the `DateTime` input (`|2020-10-06T18:23:20.351-03:00|`) to the date of the
first day of the `Year` value (`2020`) in the input.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  atBeginningOfYearDateTime: atBeginningOfYear(|2020-10-06T18:23:20.351-03:00|)
}
```

#### Output

```Json
{
  "atBeginningOfYearDateTime": "2020-01-01T00:00:00.000-03:00"
}
```

## atBeginningOfYear(localDateTime: LocalDateTime): LocalDateTime

Takes a `LocalDateTime` value as input and returns a `LocalDateTime` value for the first day of the
_year_ specified in the input. It also sets the `Time` value to `00:00:00`.

The month, day, and time in the input changes to `01-01T00:00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>localDateTime</code></p></td><td><div><div><p>The <code>LocalDateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example transforms the `LocalDateTime` input (`|2020-10-06T18:23:20.351|`) to the date of the
first day of the `Year` value (`2020`) in the input.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  atBeginningOfYearLocalDateTime: atBeginningOfYear(|2020-10-06T18:23:20.351|)
}
```

#### Output

```Json
{
  "atBeginningOfYearLocalDateTime": "2020-01-01T00:00:00"
}
```

## atBeginningOfYear(date: Date): Date

Takes a `Date` value as input and returns a `Date` value for the first day of the _year_ specified
in the input.

The month and day in the input changes to `01-01`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><div><div><p>The <code>Date</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example transforms `Date` input (`|2020-10-06|`) to the date of the first day of the `Year`
value (`2020`) in the input.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  atBeginningOfYearDate: atBeginningOfYear(|2020-10-06|)
}
```

#### Output

```Json
{
  "atBeginningOfYearDate": "2020-01-01"
}
```

<!-- document id=0f8646efd2b99448eae5301a88f2deb7782ef48eadfbab89fa36bd9976232f6a url=/mulesoft/current/en-us/dataweave/2.4/dw-dates-functions-atbeginningofyear.md -->

---
product: DataWeave
version: 2.4
---

# atBeginningOfYear

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## atBeginningOfYear(dateTime: DateTime): DateTime

Takes a `DateTime` value as input and returns a `DateTime` value for the first day of the _year_
specified in the input. It also sets the `Time` value to `00:00:00`.

The month, day, and time in the input changes to `01-01T00:00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><div><div><p>The <code>DateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example transforms the `DateTime` input (`|2020-10-06T18:23:20.351-03:00|`) to the date of the
first day of the `Year` value (`2020`) in the input.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  atBeginningOfYearDateTime: atBeginningOfYear(|2020-10-06T18:23:20.351-03:00|)
}
```

#### Output

```Json
{
  "atBeginningOfYearDateTime": "2020-01-01T00:00:00.000-03:00"
}
```

## atBeginningOfYear(localDateTime: LocalDateTime): LocalDateTime

Takes a `LocalDateTime` value as input and returns a `LocalDateTime` value for the first day of the
_year_ specified in the input. It also sets the `Time` value to `00:00:00`.

The month, day, and time in the input changes to `01-01T00:00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>localDateTime</code></p></td><td><div><div><p>The <code>LocalDateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example transforms the `LocalDateTime` input (`|2020-10-06T18:23:20.351|`) to the date of the
first day of the `Year` value (`2020`) in the input.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  atBeginningOfYearLocalDateTime: atBeginningOfYear(|2020-10-06T18:23:20.351|)
}
```

#### Output

```Json
{
  "atBeginningOfYearLocalDateTime": "2020-01-01T00:00:00"
}
```

## atBeginningOfYear(date: Date): Date

Takes a `Date` value as input and returns a `Date` value for the first day of the _year_ specified
in the input.

The month and day in the input changes to `01-01`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><div><div><p>The <code>Date</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example transforms `Date` input (`|2020-10-06|`) to the date of the first day of the `Year`
value (`2020`) in the input.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  atBeginningOfYearDate: atBeginningOfYear(|2020-10-06|)
}
```

#### Output

```Json
{
  "atBeginningOfYearDate": "2020-01-01"
}
```

<!-- document id=1d077ff7c781d8e359242377e6af2d677ff70f83cc9455c578929972a9c666db url=/mulesoft/current/en-us/dataweave/2.6/dw-dates-functions-atbeginningofyear.md -->

---
product: DataWeave
version: 2.6
---

# atBeginningOfYear

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## atBeginningOfYear(dateTime: DateTime): DateTime

Takes a `DateTime` value as input and returns a `DateTime` value for the first day of the _year_
specified in the input. It also sets the `Time` value to `00:00:00`.

The month, day, and time in the input changes to `01-01T00:00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><div><div><p>The <code>DateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example transforms the `DateTime` input (`|2020-10-06T18:23:20.351-03:00|`) to the date of the
first day of the `Year` value (`2020`) in the input.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  atBeginningOfYearDateTime: atBeginningOfYear(|2020-10-06T18:23:20.351-03:00|)
}
```

#### Output

```Json
{
  "atBeginningOfYearDateTime": "2020-01-01T00:00:00.000-03:00"
}
```

## atBeginningOfYear(localDateTime: LocalDateTime): LocalDateTime

Takes a `LocalDateTime` value as input and returns a `LocalDateTime` value for the first day of the
_year_ specified in the input. It also sets the `Time` value to `00:00:00`.

The month, day, and time in the input changes to `01-01T00:00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>localDateTime</code></p></td><td><div><div><p>The <code>LocalDateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example transforms the `LocalDateTime` input (`|2020-10-06T18:23:20.351|`) to the date of the
first day of the `Year` value (`2020`) in the input.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  atBeginningOfYearLocalDateTime: atBeginningOfYear(|2020-10-06T18:23:20.351|)
}
```

#### Output

```Json
{
  "atBeginningOfYearLocalDateTime": "2020-01-01T00:00:00"
}
```

## atBeginningOfYear(date: Date): Date

Takes a `Date` value as input and returns a `Date` value for the first day of the _year_ specified
in the input.

The month and day in the input changes to `01-01`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><div><div><p>The <code>Date</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example transforms `Date` input (`|2020-10-06|`) to the date of the first day of the `Year`
value (`2020`) in the input.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  atBeginningOfYearDate: atBeginningOfYear(|2020-10-06|)
}
```

#### Output

```Json
{
  "atBeginningOfYearDate": "2020-01-01"
}
```

<!-- document id=2aa45157485b230a21d7623a692726318a9569f559fcfa468ff8b1ae2532837a url=/mulesoft/current/en-us/dataweave/2.9/dw-dates-functions-atbeginningofyear.md -->

---
product: DataWeave
version: 2.9
---

# atBeginningOfYear

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## atBeginningOfYear(dateTime: DateTime): DateTime

Takes a `DateTime` value as input and returns a `DateTime` value for the first day of the _year_
specified in the input. It also sets the `Time` value to `00:00:00`.

The month, day, and time in the input changes to `01-01T00:00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><div><div><p>The <code>DateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example transforms the `DateTime` input (`|2020-10-06T18:23:20.351-03:00|`) to the date of the
first day of the `Year` value (`2020`) in the input.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  atBeginningOfYearDateTime: atBeginningOfYear(|2020-10-06T18:23:20.351-03:00|)
}
```

#### Output

```Json
{
  "atBeginningOfYearDateTime": "2020-01-01T00:00:00.000-03:00"
}
```

## atBeginningOfYear(localDateTime: LocalDateTime): LocalDateTime

Takes a `LocalDateTime` value as input and returns a `LocalDateTime` value for the first day of the
_year_ specified in the input. It also sets the `Time` value to `00:00:00`.

The month, day, and time in the input changes to `01-01T00:00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>localDateTime</code></p></td><td><div><div><p>The <code>LocalDateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example transforms the `LocalDateTime` input (`|2020-10-06T18:23:20.351|`) to the date of the
first day of the `Year` value (`2020`) in the input.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  atBeginningOfYearLocalDateTime: atBeginningOfYear(|2020-10-06T18:23:20.351|)
}
```

#### Output

```Json
{
  "atBeginningOfYearLocalDateTime": "2020-01-01T00:00:00"
}
```

## atBeginningOfYear(date: Date): Date

Takes a `Date` value as input and returns a `Date` value for the first day of the _year_ specified
in the input.

The month and day in the input changes to `01-01`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><div><div><p>The <code>Date</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example transforms `Date` input (`|2020-10-06|`) to the date of the first day of the `Year`
value (`2020`) in the input.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  atBeginningOfYearDate: atBeginningOfYear(|2020-10-06|)
}
```

#### Output

```Json
{
  "atBeginningOfYearDate": "2020-01-01"
}
```

<!-- document id=db763c786fd017025faccc1ffff02d89264931717f7c44a86bba7025b72b4729 url=/mulesoft/current/en-us/dataweave/latest/dw-dates-functions-atbeginningofyear.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# atBeginningOfYear

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## atBeginningOfYear(dateTime: DateTime): DateTime

Takes a `DateTime` value as input and returns a `DateTime` value for the first day of the _year_
specified in the input. It also sets the `Time` value to `00:00:00`.

The month, day, and time in the input changes to `01-01T00:00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><div><div><p>The <code>DateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example transforms the `DateTime` input (`|2020-10-06T18:23:20.351-03:00|`) to the date of the
first day of the `Year` value (`2020`) in the input.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  atBeginningOfYearDateTime: atBeginningOfYear(|2020-10-06T18:23:20.351-03:00|)
}
```

#### Output

```Json
{
  "atBeginningOfYearDateTime": "2020-01-01T00:00:00.000-03:00"
}
```

## atBeginningOfYear(localDateTime: LocalDateTime): LocalDateTime

Takes a `LocalDateTime` value as input and returns a `LocalDateTime` value for the first day of the
_year_ specified in the input. It also sets the `Time` value to `00:00:00`.

The month, day, and time in the input changes to `01-01T00:00:00`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>localDateTime</code></p></td><td><div><div><p>The <code>LocalDateTime</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example transforms the `LocalDateTime` input (`|2020-10-06T18:23:20.351|`) to the date of the
first day of the `Year` value (`2020`) in the input.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  atBeginningOfYearLocalDateTime: atBeginningOfYear(|2020-10-06T18:23:20.351|)
}
```

#### Output

```Json
{
  "atBeginningOfYearLocalDateTime": "2020-01-01T00:00:00"
}
```

## atBeginningOfYear(date: Date): Date

Takes a `Date` value as input and returns a `Date` value for the first day of the _year_ specified
in the input.

The month and day in the input changes to `01-01`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><div><div><p>The <code>Date</code> value to reference.</p></div></div></td></tr></tbody></table>

### Example

This example transforms `Date` input (`|2020-10-06|`) to the date of the first day of the `Year`
value (`2020`) in the input.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  atBeginningOfYearDate: atBeginningOfYear(|2020-10-06|)
}
```

#### Output

```Json
{
  "atBeginningOfYearDate": "2020-01-01"
}
```

<!-- document id=990405624a70c13239c75be831723e20c34e2a1bb8fb0bfadc35cf60e7ec75af url=/mulesoft/current/en-us/dataweave/2.11/dw-values-functions-attr.md -->

---
product: DataWeave
version: 2.11
---

# attr

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## attr(namespace: Namespace | Null = null, name: String): PathElement

This function creates a `PathElement` to use for selecting an XML attribute and populates the type’s
`selector` field with the given string.

Some versions of the `update` and `mask` functions accept a `PathElement` as an argument.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>namespace</code></p></td><td><p>The namespace of the attribute to select. If not specified, a null value is set.</p></td></tr><tr><td><p><code>name</code></p></td><td><p>The string that names the attribute to select.</p></td></tr></tbody></table>

### Example

This example creates an attribute selector for a specified namespace (`ns0`) and sets the selector’s
value to `"myAttr"`. In the output, also note that the value of the `"kind"` key is `"Attribute"`.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::util::Values
ns ns0 http://acme.com/fo
---
attr(ns0 , "myAttr")
```

#### Output

```Json
{
   "kind": "Attribute",
   "namespace": "http://acme.com/foo",
   "selector": "myAttr"
 }
```

<!-- document id=73536f6db0eaf48b1c1012229a13c0b379395df2c23e2c6c42a842f7e5f801d7 url=/mulesoft/current/en-us/dataweave/2.12/dw-values-functions-attr.md -->

---
product: DataWeave
version: 2.12
---

# attr

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## attr(namespace: Namespace | Null = null, name: String): PathElement

This function creates a `PathElement` to use for selecting an XML attribute and populates the type’s
`selector` field with the given string.

Some versions of the `update` and `mask` functions accept a `PathElement` as an argument.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>namespace</code></p></td><td><p>The namespace of the attribute to select. If not specified, a null value is set.</p></td></tr><tr><td><p><code>name</code></p></td><td><p>The string that names the attribute to select.</p></td></tr></tbody></table>

### Example

This example creates an attribute selector for a specified namespace (`ns0`) and sets the selector’s
value to `"myAttr"`. In the output, also note that the value of the `"kind"` key is `"Attribute"`.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::util::Values
ns ns0 http://acme.com/fo
---
attr(ns0 , "myAttr")
```

#### Output

```Json
{
   "kind": "Attribute",
   "namespace": "http://acme.com/foo",
   "selector": "myAttr"
 }
```

<!-- document id=3cad1897edf12289335af63e8468a9016fc15afc586eaea5d1abc3de2686044c url=/mulesoft/current/en-us/dataweave/2.3/dw-values-functions-attr.md -->

---
product: DataWeave
version: 2.3
---

# attr

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## attr(Namespace | Null, String): PathElement

This function creates a `PathElement` to use for selecting an XML attribute and populates the type’s
`selector` field with the given string.

Some versions of the `update` and `mask` functions accept a `PathElement` as an argument.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>namespace</code></p></td><td><p>The namespace of the attribute to select. If not specified, a null value is set.</p></td></tr><tr><td><p><code>name</code></p></td><td><p>The string that names the attribute to select.</p></td></tr></tbody></table>

### Example

This example creates an attribute selector for a specified namespace (`ns0`) and sets the selector’s
value to `"myAttr"`. In the output, also note that the value of the `"kind"` key is `"Attribute"`.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::util::Values
ns ns0 http://acme.com/fo
---
attr(ns0 , "myAttr")
```

#### Output

```Json
{
   "kind": "Attribute",
   "namespace": "http://acme.com/foo",
   "selector": "myAttr"
 }
```

<!-- document id=797c4e2cc28dae78e2b19ddfa0c0336d79feba91f508d1a55743be969a3d9788 url=/mulesoft/current/en-us/dataweave/2.4/dw-values-functions-attr.md -->

---
product: DataWeave
version: 2.4
---

# attr

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## attr(namespace: Namespace | Null = null, name: String): PathElement

This function creates a `PathElement` to use for selecting an XML attribute and populates the type’s
`selector` field with the given string.

Some versions of the `update` and `mask` functions accept a `PathElement` as an argument.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>namespace</code></p></td><td><p>The namespace of the attribute to select. If not specified, a null value is set.</p></td></tr><tr><td><p><code>name</code></p></td><td><p>The string that names the attribute to select.</p></td></tr></tbody></table>

### Example

This example creates an attribute selector for a specified namespace (`ns0`) and sets the selector’s
value to `"myAttr"`. In the output, also note that the value of the `"kind"` key is `"Attribute"`.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::util::Values
ns ns0 http://acme.com/fo
---
attr(ns0 , "myAttr")
```

#### Output

```Json
{
   "kind": "Attribute",
   "namespace": "http://acme.com/foo",
   "selector": "myAttr"
 }
```

<!-- document id=af7fca19ed40729dcc7469a6c2386cfe6431e0a22cb4b5ec6320b4bec7377c72 url=/mulesoft/current/en-us/dataweave/2.6/dw-values-functions-attr.md -->

---
product: DataWeave
version: 2.6
---

# attr

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## attr(namespace: Namespace | Null = null, name: String): PathElement

This function creates a `PathElement` to use for selecting an XML attribute and populates the type’s
`selector` field with the given string.

Some versions of the `update` and `mask` functions accept a `PathElement` as an argument.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>namespace</code></p></td><td><p>The namespace of the attribute to select. If not specified, a null value is set.</p></td></tr><tr><td><p><code>name</code></p></td><td><p>The string that names the attribute to select.</p></td></tr></tbody></table>

### Example

This example creates an attribute selector for a specified namespace (`ns0`) and sets the selector’s
value to `"myAttr"`. In the output, also note that the value of the `"kind"` key is `"Attribute"`.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::util::Values
ns ns0 http://acme.com/fo
---
attr(ns0 , "myAttr")
```

#### Output

```Json
{
   "kind": "Attribute",
   "namespace": "http://acme.com/foo",
   "selector": "myAttr"
 }
```

<!-- document id=af8cd0825d75120d635d6b4629e441bd1d3e7b82e87a760daaeab9f4bd12950d url=/mulesoft/current/en-us/dataweave/2.9/dw-values-functions-attr.md -->

---
product: DataWeave
version: 2.9
---

# attr

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## attr(namespace: Namespace | Null = null, name: String): PathElement

This function creates a `PathElement` to use for selecting an XML attribute and populates the type’s
`selector` field with the given string.

Some versions of the `update` and `mask` functions accept a `PathElement` as an argument.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>namespace</code></p></td><td><p>The namespace of the attribute to select. If not specified, a null value is set.</p></td></tr><tr><td><p><code>name</code></p></td><td><p>The string that names the attribute to select.</p></td></tr></tbody></table>

### Example

This example creates an attribute selector for a specified namespace (`ns0`) and sets the selector’s
value to `"myAttr"`. In the output, also note that the value of the `"kind"` key is `"Attribute"`.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::util::Values
ns ns0 http://acme.com/fo
---
attr(ns0 , "myAttr")
```

#### Output

```Json
{
   "kind": "Attribute",
   "namespace": "http://acme.com/foo",
   "selector": "myAttr"
 }
```

<!-- document id=e7ddfd83368ae8c77947914e808735b7e519879375301e5d120e646b5ae20c8e url=/mulesoft/current/en-us/dataweave/latest/dw-values-functions-attr.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# attr

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## attr(namespace: Namespace | Null = null, name: String): PathElement

This function creates a `PathElement` to use for selecting an XML attribute and populates the type’s
`selector` field with the given string.

Some versions of the `update` and `mask` functions accept a `PathElement` as an argument.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>namespace</code></p></td><td><p>The namespace of the attribute to select. If not specified, a null value is set.</p></td></tr><tr><td><p><code>name</code></p></td><td><p>The string that names the attribute to select.</p></td></tr></tbody></table>

### Example

This example creates an attribute selector for a specified namespace (`ns0`) and sets the selector’s
value to `"myAttr"`. In the output, also note that the value of the `"kind"` key is `"Attribute"`.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::util::Values
ns ns0 http://acme.com/fo
---
attr(ns0 , "myAttr")
```

#### Output

```Json
{
   "kind": "Attribute",
   "namespace": "http://acme.com/foo",
   "selector": "myAttr"
 }
```

<!-- document id=8d734cb2241e9399df960b9610ee74b75ab6755005ebc6c68fe3844d5137f28c url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-avg.md -->

---
product: DataWeave
version: 2.11
---

# avg

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## avg(values: Array<Number>): Number

Returns the average of numbers listed in an array.

An array that is empty or that contains a non-numeric value results in an error.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>values</code></p></td><td><p>The input array of numbers.</p></td></tr></tbody></table>

### Example

This example returns the average of multiple arrays.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ a: avg([1, 1000]), b: avg([1, 2, 3]) }
```

#### Output

```JSON
{ "a": 500.5, "b": 2 }
```

<!-- document id=9d6d180a64d38fa69f06b7aa45178f33f9dd78745af09cd8205c495aa7b5eb71 url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-avg.md -->

---
product: DataWeave
version: 2.12
---

# avg

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## avg(values: Array<Number>): Number

Returns the average of numbers listed in an array.

An array that is empty or that contains a non-numeric value results in an error.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>values</code></p></td><td><p>The input array of numbers.</p></td></tr></tbody></table>

### Example

This example returns the average of multiple arrays.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ a: avg([1, 1000]), b: avg([1, 2, 3]) }
```

#### Output

```JSON
{ "a": 500.5, "b": 2 }
```

<!-- document id=549af5cf245288dc92002c784830a331d722dfd82e90c8bba8da292253bd8257 url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-avg.md -->

---
product: DataWeave
version: 2.3
---

# avg

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## avg(Array<Number>): Number

Returns the average of numbers listed in an array.

An array that is empty or that contains a non-numeric value results in an error.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>values</code></p></td><td><p>The input array of numbers.</p></td></tr></tbody></table>

### Example

This example returns the average of multiple arrays.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ a: avg([1, 1000]), b: avg([1, 2, 3]) }
```

#### Output

```JSON
{ "a": 500.5, "b": 2.0 }
```

<!-- document id=52f289c4481b723d64d91a2e5a09a49b7dfbcbdec8256abb2b3b4db36be90843 url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-avg.md -->

---
product: DataWeave
version: 2.4
---

# avg

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## avg(values: Array<Number>): Number

Returns the average of numbers listed in an array.

An array that is empty or that contains a non-numeric value results in an error.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>values</code></p></td><td><p>The input array of numbers.</p></td></tr></tbody></table>

### Example

This example returns the average of multiple arrays.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ a: avg([1, 1000]), b: avg([1, 2, 3]) }
```

#### Output

```JSON
{ "a": 500.5, "b": 2 }
```

<!-- document id=31f6421be63cc1114a8bbad6a4caeb117f03ff28e5cd6c7e1af0e48255cf1eea url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-avg.md -->

---
product: DataWeave
version: 2.6
---

# avg

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## avg(values: Array<Number>): Number

Returns the average of numbers listed in an array.

An array that is empty or that contains a non-numeric value results in an error.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>values</code></p></td><td><p>The input array of numbers.</p></td></tr></tbody></table>

### Example

This example returns the average of multiple arrays.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ a: avg([1, 1000]), b: avg([1, 2, 3]) }
```

#### Output

```JSON
{ "a": 500.5, "b": 2 }
```

<!-- document id=94b29d4c6ec0f44d503906fddad643d5f6abaa9f4d3e7082c8ba84debf50233a url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-avg.md -->

---
product: DataWeave
version: 2.9
---

# avg

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## avg(values: Array<Number>): Number

Returns the average of numbers listed in an array.

An array that is empty or that contains a non-numeric value results in an error.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>values</code></p></td><td><p>The input array of numbers.</p></td></tr></tbody></table>

### Example

This example returns the average of multiple arrays.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ a: avg([1, 1000]), b: avg([1, 2, 3]) }
```

#### Output

```JSON
{ "a": 500.5, "b": 2 }
```

<!-- document id=4ed2f9aeeb9591a1c7d38abbd5f2cc0c6b343b28016ca2182e565d845e23f97a url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-avg.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# avg

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## avg(values: Array<Number>): Number

Returns the average of numbers listed in an array.

An array that is empty or that contains a non-numeric value results in an error.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>values</code></p></td><td><p>The input array of numbers.</p></td></tr></tbody></table>

### Example

This example returns the average of multiple arrays.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ a: avg([1, 1000]), b: avg([1, 2, 3]) }
```

#### Output

```JSON
{ "a": 500.5, "b": 2 }
```

<!-- document id=b104d031852db0d30e364e864e05dda2dfe29c1a8f2ec7d8bb858917f65f6040 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-formats-avro.md -->

---
product: DataWeave
version: 2.11
keywords: format, avro, application/avro, application/avro
---

# Avro Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/avro`

ID: `avro`

Avro is a binary data format that uses a schema to structure its data. DataWeave relies on the
schema to parse the data. Avro data structures are mapped to DataWeave data structures.

## Java Value Mapping

This table shows how Avro types map to DataWeave types:

<table><colgroup><col> <col></colgroup><thead><tr><th>Avro Type</th><th>DataWeave Type</th></tr></thead><tbody><tr><td><p><code>long</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>int</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>double</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>boolean</code></p></td><td><p><code>Boolean</code></p></td></tr><tr><td><p><code>string</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>fixed</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>bytes</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>enum</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>map</code></p></td><td><p><code>Object</code></p></td></tr><tr><td><p><code>array</code></p></td><td><p><code>Array</code></p></td></tr><tr><td><p><code>null</code></p></td><td><p><code>Null</code></p></td></tr></tbody></table>

## Example: Use an Avro Schema

This example shows how to specify a schema that the writer uses to output an Avro data structure.

### Input

An Avro schema looks something like this.

schema.json:

```json
{
  "type": "record",
  "name": "userInfo",
  "namespace": "my.example",
  "fields": [
    {
      "name": "username",
      "type": "string",
      "default": "NONE"
    },
    {
      "name": "age",
      "type": "int",
      "default": -1
    },
    {
      "name": "phone",
      "type": "string",
      "default": "NONE"
    },
    {
      "name": "housenum",
      "type": "string",
      "default": "NONE"
    }
  ]
}
```

### Source

The `schemaUrl` property in the header of this DataWeave script passes a schema (`schema.json`) to
the DataWeave writer. The writer uses the schema to structure content from the body of the script
and output the results in Avro format.

```weave
%dw 2.0
output application/avro schemaUrl="classpath://schema.json"
---
[{
    username: "Mariano",
    age: 35,
    phone: "213",
    housenum: "123"
},
{
    username: "Leandro",
    age: 29,
    phone: "213",
    housenum: "123"
},
{
    username: "Christian",
    age: 25,
    phone: "213",
    housenum: "123"
}]
```

## Configuration Properties

DataWeave supports these configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>schemaUrl</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>''</code></p></td><td><div><div><p>The URL for the Avro schema. Valid URL schemes are <code>classpath://</code>, <code>file://</code>, or <code>http://</code>. For the reader, this property is optional but defaults to the schema embedded in the input Avro file. The reader requires an embedded schema. For the writer, DataWeave requires a schema value.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>schemaUrl</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>''</code></p></td><td><div><div><p>The URL for the Avro schema. Valid URL schemes are <code>classpath://</code>, <code>file://</code>, or <code>http://</code>. For the reader, this property is optional but defaults to the schema embedded in the input Avro file. The reader requires an embedded schema. For the writer, DataWeave requires a schema value.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports this MIME type:

- `application/avro`

## Supported Top-Level Schema Types

This format supports these Avro types as the top-level element in the schema:

- `record`

- `array`

- `int`

- `long`

- `float`

- `double`

- `boolean`

- `string`

- `bytes`

- `null`

<!-- document id=970167bf3a5ae3bd8f4cedb404edf1867e0b927fd7becb0320398865a31795ea url=/mulesoft/current/en-us/dataweave/2.12/dataweave-formats-avro.md -->

---
product: DataWeave
version: 2.12
keywords: format, avro, application/avro, application/avro
---

# Avro Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/avro`

ID: `avro`

Avro is a binary data format that uses a schema to structure its data. DataWeave relies on the
schema to parse the data. Avro data structures are mapped to DataWeave data structures.

## Java Value Mapping

This table shows how Avro types map to DataWeave types:

<table><colgroup><col> <col></colgroup><thead><tr><th>Avro Type</th><th>DataWeave Type</th></tr></thead><tbody><tr><td><p><code>long</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>int</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>double</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>boolean</code></p></td><td><p><code>Boolean</code></p></td></tr><tr><td><p><code>string</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>fixed</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>bytes</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>enum</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>map</code></p></td><td><p><code>Object</code></p></td></tr><tr><td><p><code>array</code></p></td><td><p><code>Array</code></p></td></tr><tr><td><p><code>null</code></p></td><td><p><code>Null</code></p></td></tr></tbody></table>

## Example: Use an Avro Schema

This example shows how to specify a schema that the writer uses to output an Avro data structure.

### Input

An Avro schema looks something like this.

schema.json:

```json
{
  "type": "record",
  "name": "userInfo",
  "namespace": "my.example",
  "fields": [
    {
      "name": "username",
      "type": "string",
      "default": "NONE"
    },
    {
      "name": "age",
      "type": "int",
      "default": -1
    },
    {
      "name": "phone",
      "type": "string",
      "default": "NONE"
    },
    {
      "name": "housenum",
      "type": "string",
      "default": "NONE"
    }
  ]
}
```

### Source

The `schemaUrl` property in the header of this DataWeave script passes a schema (`schema.json`) to
the DataWeave writer. The writer uses the schema to structure content from the body of the script
and output the results in Avro format.

```weave
%dw 2.0
output application/avro schemaUrl="classpath://schema.json"
---
[{
    username: "Mariano",
    age: 35,
    phone: "213",
    housenum: "123"
},
{
    username: "Leandro",
    age: 29,
    phone: "213",
    housenum: "123"
},
{
    username: "Christian",
    age: 25,
    phone: "213",
    housenum: "123"
}]
```

## Configuration Properties

DataWeave supports these configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>schemaUrl</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>''</code></p></td><td><div><div><p>The URL for the Avro schema. Valid URL schemes are <code>classpath://</code>, <code>file://</code>, or <code>http://</code>. For the reader, this property is optional but defaults to the schema embedded in the input Avro file. The reader requires an embedded schema. For the writer, DataWeave requires a schema value.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>schemaUrl</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>''</code></p></td><td><div><div><p>The URL for the Avro schema. Valid URL schemes are <code>classpath://</code>, <code>file://</code>, or <code>http://</code>. For the reader, this property is optional but defaults to the schema embedded in the input Avro file. The reader requires an embedded schema. For the writer, DataWeave requires a schema value.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports this MIME type:

- `application/avro`

## Supported Top-Level Schema Types

This format supports these Avro types as the top-level element in the schema:

- `record`

- `array`

- `int`

- `long`

- `float`

- `double`

- `boolean`

- `string`

- `bytes`

- `null`

<!-- document id=3687cfb84e9da326c4c557f44dd42064f6689ab2c2a5962bfb132cde815b9715 url=/mulesoft/current/en-us/dataweave/2.3/dataweave-formats-avro.md -->

---
product: DataWeave
version: 2.3
---

# Avro Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/avro`

ID: `avro`

Avro is a binary data format that uses a schema to structure its data. DataWeave relies on the
schema to parse the data. Avro data structures are mapped to DataWeave data structures.

## Java Value Mapping

The following table shows how Avro types map to DataWeave types.

<table><colgroup><col> <col></colgroup><thead><tr><th>Avro Type</th><th>DataWeave Type</th></tr></thead><tbody><tr><td><p><code>long</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>int</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>double</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>boolean</code></p></td><td><p><code>Boolean</code></p></td></tr><tr><td><p><code>string</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>fixed</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>bytes</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>enum</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>map</code></p></td><td><p><code>Object</code></p></td></tr><tr><td><p><code>array</code></p></td><td><p><code>Array</code></p></td></tr><tr><td><p><code>null</code></p></td><td><p><code>Null</code></p></td></tr></tbody></table>

## Example: Use an Avro Schema

The following example shows how to specify a schema that the writer uses to output an Avro data
structure.

### Input

An Avro schema looks something like this.

schema.json:

```json
{
  "type": "record",
  "name": "userInfo",
  "namespace": "my.example",
  "fields": [
    {
      "name": "username",
      "type": "string",
      "default": "NONE"
    },
    {
      "name": "age",
      "type": "int",
      "default": -1
    },
    {
      "name": "phone",
      "type": "string",
      "default": "NONE"
    },
    {
      "name": "housenum",
      "type": "string",
      "default": "NONE"
    }
  ]
}
```

### Source

The `schemaUrl` property in the header of this DataWeave script passes a schema (`schema.json`) to
the DataWeave writer. The writer uses the schema to structure content from the body of the script
and output the results in Avro format.

```weave
%dw 2.0
output application/avro schemaUrl="classpath://schema.json"
---
[{
    username: "Mariano",
    age: 35,
    phone: "213",
    housenum: "123"
},
{
    username: "Leandro",
    age: 29,
    phone: "213",
    housenum: "123"
},
{
    username: "Christian",
    age: 25,
    phone: "213",
    housenum: "123"
}]
```

## Configuration Properties

DataWeave supports the following configuration properties for Avro.

### Reader Properties (for Avro)

The Avro format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>schemaUrl</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The URL for the Avro schema. Valid values are <code>classpath://</code>, <code>file://</code>, or <code>http://</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties (for Avro)

The Avro format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>When set to <code>true</code>, DataWeave generates the output as a data stream, and the script’s execution is deferred until it is consumed. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>schemaUrl</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The URL for Avro schema. Valid values are <code>classpath://</code>, <code>file://</code>, or <code>http://</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

The Avro format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>application/avro</code></p></td></tr></tbody></table>

## Supported Top-Level Schema Types

DataWeave supports the following Avro types as the top-level element in the schema.

<table><colgroup><col></colgroup><thead><tr><th>Avro Types</th></tr></thead><tbody><tr><td><p><code>record</code></p></td></tr></tbody></table>

<!-- document id=14abe344a8e9039145258bf881babaecf753bb44b08687986100eca236e58f22 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-formats-avro.md -->

---
product: DataWeave
version: 2.4
keywords: format, avro, application/avro, application/avro
---

# Avro Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/avro`

ID: `avro`

Avro is a binary data format that uses a schema to structure its data. DataWeave relies on the
schema to parse the data. Avro data structures are mapped to DataWeave data structures.

## Java Value Mapping

The following table shows how Avro types map to DataWeave types.

<table><colgroup><col> <col></colgroup><thead><tr><th>Avro Type</th><th>DataWeave Type</th></tr></thead><tbody><tr><td><p><code>long</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>int</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>double</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>boolean</code></p></td><td><p><code>Boolean</code></p></td></tr><tr><td><p><code>string</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>fixed</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>bytes</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>enum</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>map</code></p></td><td><p><code>Object</code></p></td></tr><tr><td><p><code>array</code></p></td><td><p><code>Array</code></p></td></tr><tr><td><p><code>null</code></p></td><td><p><code>Null</code></p></td></tr></tbody></table>

## Example: Use an Avro Schema

The following example shows how to specify a schema that the writer uses to output an Avro data
structure.

### Input

An Avro schema looks something like this.

schema.json:

```json
{
  "type": "record",
  "name": "userInfo",
  "namespace": "my.example",
  "fields": [
    {
      "name": "username",
      "type": "string",
      "default": "NONE"
    },
    {
      "name": "age",
      "type": "int",
      "default": -1
    },
    {
      "name": "phone",
      "type": "string",
      "default": "NONE"
    },
    {
      "name": "housenum",
      "type": "string",
      "default": "NONE"
    }
  ]
}
```

### Source

The `schemaUrl` property in the header of this DataWeave script passes a schema (`schema.json`) to
the DataWeave writer. The writer uses the schema to structure content from the body of the script
and output the results in Avro format.

```weave
%dw 2.0
output application/avro schemaUrl="classpath://schema.json"
---
[{
    username: "Mariano",
    age: 35,
    phone: "213",
    housenum: "123"
},
{
    username: "Leandro",
    age: 29,
    phone: "213",
    housenum: "123"
},
{
    username: "Christian",
    age: 25,
    phone: "213",
    housenum: "123"
}]
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>schemaUrl</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The URL for the Avro schema. Valid URI schemes are <code>classpath://</code>, <code>file://</code>, or <code>http://</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>schemaUrl</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The URL for the Avro schema. Valid URI schemes are <code>classpath://</code>, <code>file://</code>, or <code>http://</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>application/avro</code></p></td></tr></tbody></table>

## Supported Top-Level Schema Types

DataWeave supports the following Avro types as the top-level element in the schema.

<table><colgroup><col></colgroup><thead><tr><th>Avro Types</th></tr></thead><tbody><tr><td><p><code>record</code></p></td></tr></tbody></table>

<!-- document id=161cdc8ec31347d551a39c7c0d311e0ac8077a93a907cd87bec75dccc35686f7 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-formats-avro.md -->

---
product: DataWeave
version: 2.6
keywords: format, avro, application/avro, application/avro
---

# Avro Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/avro`

ID: `avro`

Avro is a binary data format that uses a schema to structure its data. DataWeave relies on the
schema to parse the data. Avro data structures are mapped to DataWeave data structures.

## Java Value Mapping

The following table shows how Avro types map to DataWeave types.

<table><colgroup><col> <col></colgroup><thead><tr><th>Avro Type</th><th>DataWeave Type</th></tr></thead><tbody><tr><td><p><code>long</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>int</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>double</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>boolean</code></p></td><td><p><code>Boolean</code></p></td></tr><tr><td><p><code>string</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>fixed</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>bytes</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>enum</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>map</code></p></td><td><p><code>Object</code></p></td></tr><tr><td><p><code>array</code></p></td><td><p><code>Array</code></p></td></tr><tr><td><p><code>null</code></p></td><td><p><code>Null</code></p></td></tr></tbody></table>

## Example: Use an Avro Schema

The following example shows how to specify a schema that the writer uses to output an Avro data
structure.

### Input

An Avro schema looks something like this.

schema.json:

```json
{
  "type": "record",
  "name": "userInfo",
  "namespace": "my.example",
  "fields": [
    {
      "name": "username",
      "type": "string",
      "default": "NONE"
    },
    {
      "name": "age",
      "type": "int",
      "default": -1
    },
    {
      "name": "phone",
      "type": "string",
      "default": "NONE"
    },
    {
      "name": "housenum",
      "type": "string",
      "default": "NONE"
    }
  ]
}
```

### Source

The `schemaUrl` property in the header of this DataWeave script passes a schema (`schema.json`) to
the DataWeave writer. The writer uses the schema to structure content from the body of the script
and output the results in Avro format.

```weave
%dw 2.0
output application/avro schemaUrl="classpath://schema.json"
---
[{
    username: "Mariano",
    age: 35,
    phone: "213",
    housenum: "123"
},
{
    username: "Leandro",
    age: 29,
    phone: "213",
    housenum: "123"
},
{
    username: "Christian",
    age: 25,
    phone: "213",
    housenum: "123"
}]
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>schemaUrl</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>''</code></p></td><td><div><div><p>The URL for the Avro schema. Valid URL schemes are <code>classpath://</code>, <code>file://</code>, or <code>http://</code>. For the reader, this property is optional but defaults to the schema embedded in the input Avro file. The reader requires an embedded schema. For the writer, DataWeave requires a schema value.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>schemaUrl</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>''</code></p></td><td><div><div><p>The URL for the Avro schema. Valid URL schemes are <code>classpath://</code>, <code>file://</code>, or <code>http://</code>. For the reader, this property is optional but defaults to the schema embedded in the input Avro file. The reader requires an embedded schema. For the writer, DataWeave requires a schema value.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>application/avro</code></p></td></tr></tbody></table>

## Supported Top-Level Schema Types

DataWeave supports the following Avro types as the top-level element in the schema.

<table><colgroup><col></colgroup><thead><tr><th>Avro Types</th></tr></thead><tbody><tr><td><p><code>record</code></p></td></tr></tbody></table>

<!-- document id=03c2a2a81ec29355cfd8638af4df46d827bdace69bd363b018bc4797b6aee453 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-formats-avro.md -->

---
product: DataWeave
version: 2.9
keywords: format, avro, application/avro, application/avro
---

# Avro Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/avro`

ID: `avro`

Avro is a binary data format that uses a schema to structure its data. DataWeave relies on the
schema to parse the data. Avro data structures are mapped to DataWeave data structures.

## Java Value Mapping

The following table shows how Avro types map to DataWeave types.

<table><colgroup><col> <col></colgroup><thead><tr><th>Avro Type</th><th>DataWeave Type</th></tr></thead><tbody><tr><td><p><code>long</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>int</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>double</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>boolean</code></p></td><td><p><code>Boolean</code></p></td></tr><tr><td><p><code>string</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>fixed</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>bytes</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>enum</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>map</code></p></td><td><p><code>Object</code></p></td></tr><tr><td><p><code>array</code></p></td><td><p><code>Array</code></p></td></tr><tr><td><p><code>null</code></p></td><td><p><code>Null</code></p></td></tr></tbody></table>

## Example: Use an Avro Schema

The following example shows how to specify a schema that the writer uses to output an Avro data
structure.

### Input

An Avro schema looks something like this.

schema.json:

```json
{
  "type": "record",
  "name": "userInfo",
  "namespace": "my.example",
  "fields": [
    {
      "name": "username",
      "type": "string",
      "default": "NONE"
    },
    {
      "name": "age",
      "type": "int",
      "default": -1
    },
    {
      "name": "phone",
      "type": "string",
      "default": "NONE"
    },
    {
      "name": "housenum",
      "type": "string",
      "default": "NONE"
    }
  ]
}
```

### Source

The `schemaUrl` property in the header of this DataWeave script passes a schema (`schema.json`) to
the DataWeave writer. The writer uses the schema to structure content from the body of the script
and output the results in Avro format.

```weave
%dw 2.0
output application/avro schemaUrl="classpath://schema.json"
---
[{
    username: "Mariano",
    age: 35,
    phone: "213",
    housenum: "123"
},
{
    username: "Leandro",
    age: 29,
    phone: "213",
    housenum: "123"
},
{
    username: "Christian",
    age: 25,
    phone: "213",
    housenum: "123"
}]
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>schemaUrl</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>''</code></p></td><td><div><div><p>The URL for the Avro schema. Valid URL schemes are <code>classpath://</code>, <code>file://</code>, or <code>http://</code>. For the reader, this property is optional but defaults to the schema embedded in the input Avro file. The reader requires an embedded schema. For the writer, DataWeave requires a schema value.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>schemaUrl</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>''</code></p></td><td><div><div><p>The URL for the Avro schema. Valid URL schemes are <code>classpath://</code>, <code>file://</code>, or <code>http://</code>. For the reader, this property is optional but defaults to the schema embedded in the input Avro file. The reader requires an embedded schema. For the writer, DataWeave requires a schema value.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>application/avro</code></p></td></tr></tbody></table>

## Supported Top-Level Schema Types

DataWeave supports the following Avro types as the top-level element in the schema.

<table><colgroup><col></colgroup><thead><tr><th>Avro Types</th></tr></thead><tbody><tr><td><p><code>record</code></p></td></tr></tbody></table>

<!-- document id=f3f96296ee574e9bbb923a4da6618cda3594c704b7b2757cfa1a62489973363b url=/mulesoft/current/en-us/dataweave/latest/dataweave-formats-avro.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: format, avro, application/avro, application/avro
---

# Avro Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/avro`

ID: `avro`

Avro is a binary data format that uses a schema to structure its data. DataWeave relies on the
schema to parse the data. Avro data structures are mapped to DataWeave data structures.

## Java Value Mapping

This table shows how Avro types map to DataWeave types:

<table><colgroup><col> <col></colgroup><thead><tr><th>Avro Type</th><th>DataWeave Type</th></tr></thead><tbody><tr><td><p><code>long</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>int</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>double</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>boolean</code></p></td><td><p><code>Boolean</code></p></td></tr><tr><td><p><code>string</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>fixed</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>bytes</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>enum</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>map</code></p></td><td><p><code>Object</code></p></td></tr><tr><td><p><code>array</code></p></td><td><p><code>Array</code></p></td></tr><tr><td><p><code>null</code></p></td><td><p><code>Null</code></p></td></tr></tbody></table>

## Example: Use an Avro Schema

This example shows how to specify a schema that the writer uses to output an Avro data structure.

### Input

An Avro schema looks something like this.

schema.json:

```json
{
  "type": "record",
  "name": "userInfo",
  "namespace": "my.example",
  "fields": [
    {
      "name": "username",
      "type": "string",
      "default": "NONE"
    },
    {
      "name": "age",
      "type": "int",
      "default": -1
    },
    {
      "name": "phone",
      "type": "string",
      "default": "NONE"
    },
    {
      "name": "housenum",
      "type": "string",
      "default": "NONE"
    }
  ]
}
```

### Source

The `schemaUrl` property in the header of this DataWeave script passes a schema (`schema.json`) to
the DataWeave writer. The writer uses the schema to structure content from the body of the script
and output the results in Avro format.

```weave
%dw 2.0
output application/avro schemaUrl="classpath://schema.json"
---
[{
    username: "Mariano",
    age: 35,
    phone: "213",
    housenum: "123"
},
{
    username: "Leandro",
    age: 29,
    phone: "213",
    housenum: "123"
},
{
    username: "Christian",
    age: 25,
    phone: "213",
    housenum: "123"
}]
```

## Configuration Properties

DataWeave supports these configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>schemaUrl</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>''</code></p></td><td><div><div><p>The URL for the Avro schema. Valid URL schemes are <code>classpath://</code>, <code>file://</code>, or <code>http://</code>. For the reader, this property is optional but defaults to the schema embedded in the input Avro file. The reader requires an embedded schema. For the writer, DataWeave requires a schema value.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>schemaUrl</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>''</code></p></td><td><div><div><p>The URL for the Avro schema. Valid URL schemes are <code>classpath://</code>, <code>file://</code>, or <code>http://</code>. For the reader, this property is optional but defaults to the schema embedded in the input Avro file. The reader requires an embedded schema. For the writer, DataWeave requires a schema value.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports this MIME type:

- `application/avro`

## Supported Top-Level Schema Types

This format supports these Avro types as the top-level element in the schema:

- `record`

- `array`

- `int`

- `long`

- `float`

- `double`

- `boolean`

- `string`

- `bytes`

- `null`

<!-- document id=2f2793df4a761221768a46a6a0eb43d168cfeb0ffd2cf448a970496ec43c1619 url=/mulesoft/current/en-us/dataweave/2.11/dw-types-functions-basetypeof.md -->

---
product: DataWeave
version: 2.11
---

# baseTypeOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## baseTypeOf(t: Type): Type

Returns an the base type of the given type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `baseTypeOf` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = String {format: "YYYY-MM-dd"}
output application/json
---
{
   a: baseTypeOf(AType)
}
```

#### Output

```Json
{
  "a": "String"
}
```

<!-- document id=42db12b29674937b73d7885d351af6b0d239890ab4d793bbdc3a21663b4ccc04 url=/mulesoft/current/en-us/dataweave/2.12/dw-types-functions-basetypeof.md -->

---
product: DataWeave
version: 2.12
---

# baseTypeOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## baseTypeOf(t: Type): Type

Returns an the base type of the given type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `baseTypeOf` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = String {format: "YYYY-MM-dd"}
output application/json
---
{
   a: baseTypeOf(AType)
}
```

#### Output

```Json
{
  "a": "String"
}
```

<!-- document id=84650bd1f5e1c2d08ec1ea60293459ce8c1028906aee01bee46910ce94a16e9a url=/mulesoft/current/en-us/dataweave/2.3/dw-types-functions-basetypeof.md -->

---
product: DataWeave
version: 2.3
---

# baseTypeOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## baseTypeOf(Type): Type

Returns an the base type of the given type.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>t</p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `baseTypeOf` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = String {format: "YYYY-MM-dd"}
output application/json
---
{
   a: baseTypeOf(AType)
}
```

#### Output

```Json
{
  "a": "String"
}
```

<!-- document id=26a47c3e0b5326bc620406aa79f72bd9bb18007bbb17fc597b30e341580b4948 url=/mulesoft/current/en-us/dataweave/2.4/dw-types-functions-basetypeof.md -->

---
product: DataWeave
version: 2.4
---

# baseTypeOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## baseTypeOf(t: Type): Type

Returns an the base type of the given type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `baseTypeOf` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = String {format: "YYYY-MM-dd"}
output application/json
---
{
   a: baseTypeOf(AType)
}
```

#### Output

```Json
{
  "a": "String"
}
```

<!-- document id=1cbfbaab3b0d08f57dcdc8ef9e6d5f16ccfc32850d0b6cea567faf1f62b5d6d7 url=/mulesoft/current/en-us/dataweave/2.6/dw-types-functions-basetypeof.md -->

---
product: DataWeave
version: 2.6
---

# baseTypeOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## baseTypeOf(t: Type): Type

Returns an the base type of the given type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `baseTypeOf` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = String {format: "YYYY-MM-dd"}
output application/json
---
{
   a: baseTypeOf(AType)
}
```

#### Output

```Json
{
  "a": "String"
}
```

<!-- document id=20fe37cc3496fae77ba45b16f17be4d7d80a0a5d455759930b6cd05a7a4292da url=/mulesoft/current/en-us/dataweave/2.9/dw-types-functions-basetypeof.md -->

---
product: DataWeave
version: 2.9
---

# baseTypeOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## baseTypeOf(t: Type): Type

Returns an the base type of the given type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `baseTypeOf` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = String {format: "YYYY-MM-dd"}
output application/json
---
{
   a: baseTypeOf(AType)
}
```

#### Output

```Json
{
  "a": "String"
}
```

<!-- document id=804faccfeceff33b7f444ceab105e5ea4b73c00b57eb94a1d3bb73ea5380e6b8 url=/mulesoft/current/en-us/dataweave/latest/dw-types-functions-basetypeof.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# baseTypeOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## baseTypeOf(t: Type): Type

Returns an the base type of the given type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `baseTypeOf` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = String {format: "YYYY-MM-dd"}
output application/json
---
{
   a: baseTypeOf(AType)
}
```

#### Output

```Json
{
  "a": "String"
}
```

<!-- document id=ea5cc3131da34d3b5c2a949755a4c7bddab46c874bbe181d0629435b67fc0be5 url=/mulesoft/current/en-us/dataweave/2.11/dw-periods-functions-between.md -->

---
product: DataWeave
version: 2.11
---

# between

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## between(endDateExclusive: Date, startDateInclusive: Date): Period

Returns a Period (P) value consisting of the number of years, months, and days between two Date
values.

The start date is included, but the end date is not. The result of this method can be a negative
period if the end date (`endDateExclusive`) is before the start date (`startDateInclusive`).

Note that the first parameter of the function is the `endDateExclusive` and the second one is the
`startDateInclusive`.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>endDateExclusive</code></p></td><td><p>The end date, exclusive.</p></td></tr><tr><td><p><code>startDateInclusive</code></p></td><td><p>The start date, inclusive.</p></td></tr></tbody></table>

### Example

This example shows how `between` behaves with different inputs.

#### Source

```DataWeave
import * from dw::core::Periods
output application/json
---
{
   a: between(|2010-12-12|,|2010-12-10|),
   b: between(|2011-12-11|,|2010-11-10|),
   c: between(|2020-02-29|,|2020-03-30|)
}
```

#### Output

```Json
{
   "a": "P2D",
   "b": "P1Y1M1D",
   "c": "P-1M-1D"
 }
```

<!-- document id=f586254dbc19390702bd36c6a5dc23db741d4eedbe45864020a450691fd7e420 url=/mulesoft/current/en-us/dataweave/2.12/dw-periods-functions-between.md -->

---
product: DataWeave
version: 2.12
---

# between

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## between(endDateExclusive: Date, startDateInclusive: Date): Period

Returns a Period (P) value consisting of the number of years, months, and days between two Date
values.

The start date is included, but the end date is not. The result of this method can be a negative
period if the end date (`endDateExclusive`) is before the start date (`startDateInclusive`).

Note that the first parameter of the function is the `endDateExclusive` and the second one is the
`startDateInclusive`.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>endDateExclusive</code></p></td><td><p>The end date, exclusive.</p></td></tr><tr><td><p><code>startDateInclusive</code></p></td><td><p>The start date, inclusive.</p></td></tr></tbody></table>

### Example

This example shows how `between` behaves with different inputs.

#### Source

```DataWeave
import * from dw::core::Periods
output application/json
---
{
   a: between(|2010-12-12|,|2010-12-10|),
   b: between(|2011-12-11|,|2010-11-10|),
   c: between(|2020-02-29|,|2020-03-30|)
}
```

#### Output

```Json
{
   "a": "P2D",
   "b": "P1Y1M1D",
   "c": "P-1M-1D"
 }
```

<!-- document id=a6707d6d3f065bff72733310f862c7833282d7fcc000ce8e72acd4b0dfa778fb url=/mulesoft/current/en-us/dataweave/2.4/dw-periods-functions-between.md -->

---
product: DataWeave
version: 2.4
---

# between

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## between(endDateExclusive: Date, startDateInclusive: Date): Period

Returns a Period (P) value consisting of the number of years, months, and days between two Date
values.

The start date is included, but the end date is not. The result of this method can be a negative
period if the end date (`endDateExclusive`) is before the start date (`startDateInclusive`).

Note that the first parameter of the function is the `endDateExclusive` and the second one is the
`startDateInclusive`.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>endDateExclusive</code></p></td><td><p>The end date, exclusive.</p></td></tr><tr><td><p><code>startDateInclusive</code></p></td><td><p>The start date, inclusive.</p></td></tr></tbody></table>

### Example

This example shows how `between` behaves with different inputs.

#### Source

```DataWeave
import * from dw::core::Periods
output application/json
---
{
   a: between(|2010-12-12|,|2010-12-10|),
   b: between(|2011-12-11|,|2010-11-10|),
   c: between(|2020-02-29|,|2020-03-30|)
}
```

#### Output

```Json
{
   "a": "P2D",
   "b": "P1Y1M1D",
   "c": "P-1M-1D"
 }
```

<!-- document id=25b3dc61dc80e20403e6b0cc8f256164973af595e16ac30d2799168c779b7143 url=/mulesoft/current/en-us/dataweave/2.6/dw-periods-functions-between.md -->

---
product: DataWeave
version: 2.6
---

# between

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## between(endDateExclusive: Date, startDateInclusive: Date): Period

Returns a Period (P) value consisting of the number of years, months, and days between two Date
values.

The start date is included, but the end date is not. The result of this method can be a negative
period if the end date (`endDateExclusive`) is before the start date (`startDateInclusive`).

Note that the first parameter of the function is the `endDateExclusive` and the second one is the
`startDateInclusive`.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>endDateExclusive</code></p></td><td><p>The end date, exclusive.</p></td></tr><tr><td><p><code>startDateInclusive</code></p></td><td><p>The start date, inclusive.</p></td></tr></tbody></table>

### Example

This example shows how `between` behaves with different inputs.

#### Source

```DataWeave
import * from dw::core::Periods
output application/json
---
{
   a: between(|2010-12-12|,|2010-12-10|),
   b: between(|2011-12-11|,|2010-11-10|),
   c: between(|2020-02-29|,|2020-03-30|)
}
```

#### Output

```Json
{
   "a": "P2D",
   "b": "P1Y1M1D",
   "c": "P-1M-1D"
 }
```

<!-- document id=aa31c279b2b6ea7c5a1fed9cbe50aa37d39b7142ff870c392450f53e5560c92e url=/mulesoft/current/en-us/dataweave/2.9/dw-periods-functions-between.md -->

---
product: DataWeave
version: 2.9
---

# between

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## between(endDateExclusive: Date, startDateInclusive: Date): Period

Returns a Period (P) value consisting of the number of years, months, and days between two Date
values.

The start date is included, but the end date is not. The result of this method can be a negative
period if the end date (`endDateExclusive`) is before the start date (`startDateInclusive`).

Note that the first parameter of the function is the `endDateExclusive` and the second one is the
`startDateInclusive`.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>endDateExclusive</code></p></td><td><p>The end date, exclusive.</p></td></tr><tr><td><p><code>startDateInclusive</code></p></td><td><p>The start date, inclusive.</p></td></tr></tbody></table>

### Example

This example shows how `between` behaves with different inputs.

#### Source

```DataWeave
import * from dw::core::Periods
output application/json
---
{
   a: between(|2010-12-12|,|2010-12-10|),
   b: between(|2011-12-11|,|2010-11-10|),
   c: between(|2020-02-29|,|2020-03-30|)
}
```

#### Output

```Json
{
   "a": "P2D",
   "b": "P1Y1M1D",
   "c": "P-1M-1D"
 }
```

<!-- document id=0566106b13c7161237c46b04863954f493c8c4711cc1f8a5b81ffb2fce1f43d4 url=/mulesoft/current/en-us/dataweave/latest/dw-periods-functions-between.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# between

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## between(endDateExclusive: Date, startDateInclusive: Date): Period

Returns a Period (P) value consisting of the number of years, months, and days between two Date
values.

The start date is included, but the end date is not. The result of this method can be a negative
period if the end date (`endDateExclusive`) is before the start date (`startDateInclusive`).

Note that the first parameter of the function is the `endDateExclusive` and the second one is the
`startDateInclusive`.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>endDateExclusive</code></p></td><td><p>The end date, exclusive.</p></td></tr><tr><td><p><code>startDateInclusive</code></p></td><td><p>The start date, inclusive.</p></td></tr></tbody></table>

### Example

This example shows how `between` behaves with different inputs.

#### Source

```DataWeave
import * from dw::core::Periods
output application/json
---
{
   a: between(|2010-12-12|,|2010-12-10|),
   b: between(|2011-12-11|,|2010-11-10|),
   c: between(|2020-02-29|,|2020-03-30|)
}
```

#### Output

```Json
{
   "a": "P2D",
   "b": "P1Y1M1D",
   "c": "P-1M-1D"
 }
```

<!-- document id=1eb1ef436329ed396baa1b141a6174ffc1b9458363313a5c406e03c12a58a8a8 url=/mulesoft/current/en-us/dataweave/2.11/dw-binaries.md -->

---
product: DataWeave
version: 2.11
---

# Binaries (dw::core::Binaries)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions for working with binaries.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Binaries` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-binaries-functions-concatwith">concatWith</a></p></td><td><p>Concatenates the content of two binaries.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-binaries-functions-frombase64">fromBase64</a></p></td><td><p>Transforms a Base64 string into a binary value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-binaries-functions-fromhex">fromHex</a></p></td><td><p>Transforms a hexadecimal string into a binary.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-binaries-functions-readlineswith">readLinesWith</a></p></td><td><p>Splits the specified binary content into lines and returns the results in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-binaries-functions-tobase64">toBase64</a></p></td><td><p>Transforms a binary value into a Base64 string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-binaries-functions-tohex">toHex</a></p></td><td><p>Transforms a binary value into a hexadecimal string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-binaries-functions-writelineswith">writeLinesWith</a></p></td><td><p>Writes the specified lines and returns the binary content.</p></td></tr></tbody></table>

<!-- document id=39de80aa59615506c6a6cbfe32aeed109c3b6ea8514b329f95d44b27ba487e7a url=/mulesoft/current/en-us/dataweave/2.12/dw-binaries.md -->

---
product: DataWeave
version: 2.12
---

# Binaries (dw::core::Binaries)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions for working with binaries.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Binaries` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-binaries-functions-concatwith">concatWith</a></p></td><td><p>Concatenates the content of two binaries.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-binaries-functions-frombase64">fromBase64</a></p></td><td><p>Transforms a Base64 string into a binary value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-binaries-functions-fromhex">fromHex</a></p></td><td><p>Transforms a hexadecimal string into a binary.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-binaries-functions-readlineswith">readLinesWith</a></p></td><td><p>Splits the specified binary content into lines and returns the results in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-binaries-functions-tobase64">toBase64</a></p></td><td><p>Transforms a binary value into a Base64 string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-binaries-functions-tohex">toHex</a></p></td><td><p>Transforms a binary value into a hexadecimal string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-binaries-functions-writelineswith">writeLinesWith</a></p></td><td><p>Writes the specified lines and returns the binary content.</p></td></tr></tbody></table>

<!-- document id=97f0ffc0b4322b39babe9cb9d5351126c06d89dcf111a9c5e7817d8413ee0d75 url=/mulesoft/current/en-us/dataweave/2.3/dw-binaries.md -->

---
product: DataWeave
version: 2.3
---

# Binaries (dw::core::Binaries)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions for working with binaries.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Binaries` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-binaries-functions-frombase64">fromBase64</a></p></td><td><p>Transforms a Base64 string into a binary value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-binaries-functions-fromhex">fromHex</a></p></td><td><p>Transforms a hexadecimal string into a binary.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-binaries-functions-readlineswith">readLinesWith</a></p></td><td><p>Splits the specified binary content into lines and returns the results in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-binaries-functions-tobase64">toBase64</a></p></td><td><p>Transforms a binary value into a Base64 string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-binaries-functions-tohex">toHex</a></p></td><td><p>Transforms a binary value into a hexadecimal string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-binaries-functions-writelineswith">writeLinesWith</a></p></td><td><p>Writes the specified lines and returns the binary content.</p></td></tr></tbody></table>

<!-- document id=4784b0e5f0ceb3fc57dbc8d9dd3795a20f48f27969b4cdae042f4c05bcc48a83 url=/mulesoft/current/en-us/dataweave/2.4/dw-binaries.md -->

---
product: DataWeave
version: 2.4
---

# Binaries (dw::core::Binaries)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions for working with binaries.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Binaries` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-binaries-functions-frombase64">fromBase64</a></p></td><td><p>Transforms a Base64 string into a binary value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-binaries-functions-fromhex">fromHex</a></p></td><td><p>Transforms a hexadecimal string into a binary.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-binaries-functions-readlineswith">readLinesWith</a></p></td><td><p>Splits the specified binary content into lines and returns the results in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-binaries-functions-tobase64">toBase64</a></p></td><td><p>Transforms a binary value into a Base64 string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-binaries-functions-tohex">toHex</a></p></td><td><p>Transforms a binary value into a hexadecimal string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-binaries-functions-writelineswith">writeLinesWith</a></p></td><td><p>Writes the specified lines and returns the binary content.</p></td></tr></tbody></table>

<!-- document id=64f16f2ac72f33bc41985874cbeff12e8f72b5f14d616a302ede3a0047802787 url=/mulesoft/current/en-us/dataweave/2.6/dw-binaries.md -->

---
product: DataWeave
version: 2.6
---

# Binaries (dw::core::Binaries)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions for working with binaries.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Binaries` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-binaries-functions-concatwith">concatWith</a></p></td><td><p>Concatenates the content of two binaries.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-binaries-functions-frombase64">fromBase64</a></p></td><td><p>Transforms a Base64 string into a binary value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-binaries-functions-fromhex">fromHex</a></p></td><td><p>Transforms a hexadecimal string into a binary.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-binaries-functions-readlineswith">readLinesWith</a></p></td><td><p>Splits the specified binary content into lines and returns the results in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-binaries-functions-tobase64">toBase64</a></p></td><td><p>Transforms a binary value into a Base64 string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-binaries-functions-tohex">toHex</a></p></td><td><p>Transforms a binary value into a hexadecimal string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-binaries-functions-writelineswith">writeLinesWith</a></p></td><td><p>Writes the specified lines and returns the binary content.</p></td></tr></tbody></table>

<!-- document id=f9d8f6e8e90fa3f9fdf9b8023979b32ffff70d7e576e2060b5a9eafa2b7df9be url=/mulesoft/current/en-us/dataweave/2.9/dw-binaries.md -->

---
product: DataWeave
version: 2.9
---

# Binaries (dw::core::Binaries)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions for working with binaries.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Binaries` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-binaries-functions-concatwith">concatWith</a></p></td><td><p>Concatenates the content of two binaries.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-binaries-functions-frombase64">fromBase64</a></p></td><td><p>Transforms a Base64 string into a binary value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-binaries-functions-fromhex">fromHex</a></p></td><td><p>Transforms a hexadecimal string into a binary.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-binaries-functions-readlineswith">readLinesWith</a></p></td><td><p>Splits the specified binary content into lines and returns the results in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-binaries-functions-tobase64">toBase64</a></p></td><td><p>Transforms a binary value into a Base64 string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-binaries-functions-tohex">toHex</a></p></td><td><p>Transforms a binary value into a hexadecimal string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-binaries-functions-writelineswith">writeLinesWith</a></p></td><td><p>Writes the specified lines and returns the binary content.</p></td></tr></tbody></table>

<!-- document id=6842210f57ae64da2eb4efa04c36dfcbc2e839f5808294ead1d7143a69ea83d2 url=/mulesoft/current/en-us/dataweave/latest/dw-binaries.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Binaries (dw::core::Binaries)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions for working with binaries.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Binaries` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-binaries-functions-concatwith">concatWith</a></p></td><td><p>Concatenates the content of two binaries.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-binaries-functions-frombase64">fromBase64</a></p></td><td><p>Transforms a Base64 string into a binary value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-binaries-functions-fromhex">fromHex</a></p></td><td><p>Transforms a hexadecimal string into a binary.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-binaries-functions-readlineswith">readLinesWith</a></p></td><td><p>Splits the specified binary content into lines and returns the results in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-binaries-functions-tobase64">toBase64</a></p></td><td><p>Transforms a binary value into a Base64 string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-binaries-functions-tohex">toHex</a></p></td><td><p>Transforms a binary value into a hexadecimal string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-binaries-functions-writelineswith">writeLinesWith</a></p></td><td><p>Writes the specified lines and returns the binary content.</p></td></tr></tbody></table>

<!-- document id=7da46f65376ca0711ea469e314598d7b2678dedb659b8852dd215e1827a78847 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-formats-binary.md -->

---
product: DataWeave
version: 2.11
keywords: format, binary, application/octet-stream, application/x-binary, application/octet-stream
---

# Binary Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/octet-stream`

ID: `binary`

The Binary data format handles binary content, such as an image or PDF. Such content is represented
as a `Binary` type.

Note that Binary content is stored into RAM memory.

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

There are no reader properties for this format.

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>application/octet-stream</code></p></td></tr><tr><td><p><code>application/x-binary</code></p></td></tr></tbody></table>

<!-- document id=fa995eeafb87a2c17b2f4399d31f36db743cc966396c21ec8e17864fb1762691 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-formats-binary.md -->

---
product: DataWeave
version: 2.12
keywords: format, binary, application/octet-stream, application/x-binary, application/octet-stream
---

# Binary Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/octet-stream`

ID: `binary`

The Binary data format handles binary content, such as an image or PDF. Such content is represented
as a `Binary` type.

Note that Binary content is stored into RAM memory.

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

There are no reader properties for this format.

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>application/octet-stream</code></p></td></tr><tr><td><p><code>application/x-binary</code></p></td></tr></tbody></table>

<!-- document id=e95cc14e7c5443ffaf811f626d1b99e70a84299a7d5129fd679735e3377049b3 url=/mulesoft/current/en-us/dataweave/2.3/dataweave-formats-binary.md -->

---
product: DataWeave
version: 2.3
---

# Binary Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME Type: `application/octet-stream`

ID: `binary`

The Binary data format handles binary content, such as an image or PDF. Such content is represented
as a `Binary` type.

Note that Binary content is stored into RAM memory.

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

There are no reader properties for Binary data.

### Writer Properties

The Binary format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the writer buffer.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>When set to <code>true</code>, DataWeave generates the output as a data stream, and the script’s execution is deferred until it is consumed. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

The Binary format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>application/octet-stream</code></p></td></tr><tr><td><p><code>application/x-binary</code></p></td></tr></tbody></table>

<!-- document id=2fa4f02f81f58c70faff69e299202b9dc1e707d736f29afc9983f233138ddd57 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-formats-binary.md -->

---
product: DataWeave
version: 2.4
keywords: format, binary, application/octet-stream, application/x-binary, application/octet-stream
---

# Binary Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/octet-stream`

ID: `binary`

The Binary data format handles binary content, such as an image or PDF. Such content is represented
as a `Binary` type.

Note that Binary content is stored into RAM memory.

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

There are no reader properties for this format.

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>application/octet-stream</code></p></td></tr><tr><td><p><code>application/x-binary</code></p></td></tr></tbody></table>

<!-- document id=b58ade46c7019c39d82c5abd4e3629c4a3da096e4ac88c23cd58f702417749ea url=/mulesoft/current/en-us/dataweave/2.6/dataweave-formats-binary.md -->

---
product: DataWeave
version: 2.6
keywords: format, binary, application/octet-stream, application/x-binary, application/octet-stream
---

# Binary Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/octet-stream`

ID: `binary`

The Binary data format handles binary content, such as an image or PDF. Such content is represented
as a `Binary` type.

Note that Binary content is stored into RAM memory.

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

There are no reader properties for this format.

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>application/octet-stream</code></p></td></tr><tr><td><p><code>application/x-binary</code></p></td></tr></tbody></table>

<!-- document id=4e8f4d2532ed4ba12b52c4ffe30cebda81d1d18c5ea69b078e4e06553b946896 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-formats-binary.md -->

---
product: DataWeave
version: 2.9
keywords: format, binary, application/octet-stream, application/x-binary, application/octet-stream
---

# Binary Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/octet-stream`

ID: `binary`

The Binary data format handles binary content, such as an image or PDF. Such content is represented
as a `Binary` type.

Note that Binary content is stored into RAM memory.

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

There are no reader properties for this format.

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>application/octet-stream</code></p></td></tr><tr><td><p><code>application/x-binary</code></p></td></tr></tbody></table>

<!-- document id=17e3ecaa1255553353ba0256e215c0bd6e2596bebc831fb0c383c89cd66c175d url=/mulesoft/current/en-us/dataweave/latest/dataweave-formats-binary.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: format, binary, application/octet-stream, application/x-binary, application/octet-stream
---

# Binary Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/octet-stream`

ID: `binary`

The Binary data format handles binary content, such as an image or PDF. Such content is represented
as a `Binary` type.

Note that Binary content is stored into RAM memory.

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

There are no reader properties for this format.

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>application/octet-stream</code></p></td></tr><tr><td><p><code>application/x-binary</code></p></td></tr></tbody></table>

<!-- document id=f65cb7cebcca415f9191e75ba264405e3d4868150554fd9846d92bb8ce51a110 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook-java-methods.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Call Java Methods with DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

From a DataWeave statement, you can call Java methods from any Java class that’s in your Mule
project. Note that you can only call Static methods via DataWeave (methods that belong to a Java
class, not methods that belong to a specific instance of a class).

## Call a Java Method

Before you can call a method, you must first import the class it belongs to into your DataWeave
code. You can import Java classes just as you import DataWeave modules by including `java!` into the
statement.

For example, below is a simple Java class with a single method that appends a random number at the
end of a string. Assume that you created this class as part of a Java package named
`org.mycompany.utils` in your Mule project’s `src/main/java` folder.

```java
package org.mycompany.utils;

import java.util.Random;

public class MyUtils {

	public static String appendRandom(String base) {
		return base + new Random().nextInt();
	}

}
```

You can call the method `appendRandom()` from DataWeave code, in any of the following ways.

- Import the class and then refer to the method:

%dw 2.0 import java!org::mycompany::utils::MyUtils output application/json
---

{ a: MyUtils::appendRandom("myString") }

- Import one or more methods instead of the whole class:

%dw 2.0 import java!org::mycompany::utils::MyUtils::appendRandom output application/json
---

{ a: appendRandom("myString") }

- If the method is a static method, import and call it in a single line:

%dw 2.0 output application/json
---

{ a: java!org::mycompany::utils::MyUtils::appendRandom(vars.myString) }

All three methods return the variable value with a random string appended:

```json
{
  "a": "myString969858409"
}
```

## Instantiate a Java Class

Through DataWeave code, you can instantiate a new object of any class. Note that after creating an
instance, you can’t call its instance methods through DataWeave. However, you can reference its
variables.

This simple Java class has a method and a variable.

```java
package org.mycompany.utils;
public class MyClass {

	private String foo;
	 public MyClass(String foo) {
		 this.foo = foo;
	}

	 public String getFoo() {
		return foo;
	}

}
```

To create the `MyClass` example in a Studio project:

1.  Create a project for the class in Studio by clicking **New** → **Mule Project** and providing a
    name, such as **my-app**, and clicking **Finish**.

2.  From **my-app**, create the `org.mycompany.utils` package by right-clicking **src/main/java**
    from Studio’s **Package Explorer**, selecting **New** → **Package**, and naming the package
    `org.mycompany.utils`.

3.  Create the `MyClass` class in the your new `org.mycompany.utils` package by right-clicking
    **org.mycompany.utils**, selecting **New** → **Class**, naming that class `MyClass`, and
    clicking **Finish**.

4.  In the **MyClass.java** tab that opens in Studio, copy, paste, and save the contents `MyClass`.

The following DataWeave example imports `MyClass`, creates a new instance of the class, and calls
its instance variable `foo`. (Note that it is not possible for DataWeave to call the object’s
private `getFoo()` method.)

```dataweave
%dw 2.0
import java!org::mycompany::utils::MyClass
output application/json
---
{
	a: MyClass::new("myString").foo
}
```

To add this DataWeave example to your Studio project:

1.  Returning to `my-app.xml` in **src/main/mule**, drag a Transform Message component into the
    project’s canvas, and click to open it.

2.  In the component’s **Transform Message** tab, replace the entire script in the source code area
    (on the right) with the DataWeave script (above).

3.  Save your changes and click **Preview** (located farthest right on the tab) to view the
    following output:

{ "a":"myString" }

Note that the XML for the Transform Message configuration in the Mule flow looks something like
this:

```xml
<flow name="my-appFlow" >
	<ee:transform doc:name="Transform Message" >
		<ee:message >
			<ee:set-payload ><![CDATA[%dw 2.0
import java!org::mycompany::utils::MyClass
output application/json
---
{
a: MyClass::new("myString").foo
}]]></ee:set-payload>
		</ee:message>
	</ee:transform>
</flow>
```

## Use a Java Bridge

DataWeave enables you to call any Java static function or constructor by using the Java bridge. This
feature is useful when you need to reuse business logic written in Java or to instantiate any Java
object that does not have an empty public constructor.

To use a Java bridge, transform a fully qualified Java name to a DataWeave name:

1.  Add the prefix `!java`.

2.  Replace the dots in the fully qualified name with `::`.

When invoking the Java function, DataWeave transforms each argument to the expected type in the
function parameter.

The following example shows how to create a new instance of a `java.lang.NullPointerException`:

```dataweave
%dw 2.0
output application/json
---
java!java::lang::NullPointerException::new("foo")
```

The following example invokes the function `java.lang.String.valueOf`:

```dataweave
%dw 2.0
output text/plain
import valueOf from java!java::lang::String
---
valueOf(true)
```

## Java Bridge Example

The following example shows an API that returns a greeting message based on the input `uriParam`.
The Java bridge calls a static method within the `my.class.org.Greeter` class that builds the
response message.

```dataweave
%dw 2.0
output application/json
import java!my::class::org::Greeter
---
{
response: Greeter::greet(attributes.uriParams."name"
}
```

### XML for Java Bridge Example

Paste this code into your Studio XML editor to quickly load the flow for this example into your Mule
app:

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core" xmlns:http="http://www.mulesoft.org/schema/mule/http"
	xmlns="http://www.mulesoft.org/schema/mule/core"
	xmlns:doc="http://www.mulesoft.org/schema/mule/documentation" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/http http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
http://www.mulesoft.org/schema/mule/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd">
	<http:listener-config name="HTTP_Listener_config" doc:name="HTTP Listener config" doc:id="addcdb50-cdfa-400d-992f-495ab6dd373d" >
		<http:listener-connection host="0.0.0.0" port="8081" />
	</http:listener-config>
	<flow name="data-weave-java-bridge-example-flow" >
		<http:listener doc:name="Listener" config-ref="HTTP_Listener_config" path="/greet/{name}"/>
		<ee:transform doc:name="Transform Message" >
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/json
import java!my::class::org::Greeter
---
{
	response: Greeter::greet(attributes.uriParams."name")

}]]></ee:set-payload>
			</ee:message>
		</ee:transform>
	</flow>
</mule>
```

### Test the App

To test your app, follow these steps:

1.  Save and run your Mule app.

2.  Run the following curl command: `http://localhost:8081/greet/Username`.

The Mule app returns the following response message:

```xml
{
 "response": "Greetings, Username!"
}
```

## See Also

- [Java Format](https://docs.mulesoft.com/dataweave/2.11/dataweave-formats-java)

- [Supported Data Formats](https://docs.mulesoft.com/dataweave/2.11/dataweave-formats)

<!-- document id=60dc66b7900abd923cb1a535bcde1dc5368435ea5943e737f0de3b5b18dfa46e url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook-java-methods.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Call Java Methods with DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

From a DataWeave statement, you can call Java methods from any Java class that’s in your Mule
project. Note that you can only call Static methods via DataWeave (methods that belong to a Java
class, not methods that belong to a specific instance of a class).

## Call a Java Method

Before you can call a method, you must first import the class it belongs to into your DataWeave
code. You can import Java classes just as you import DataWeave modules by including `java!` into the
statement.

For example, below is a simple Java class with a single method that appends a random number at the
end of a string. Assume that you created this class as part of a Java package named
`org.mycompany.utils` in your Mule project’s `src/main/java` folder.

```java
package org.mycompany.utils;

import java.util.Random;

public class MyUtils {

	public static String appendRandom(String base) {
		return base + new Random().nextInt();
	}

}
```

You can call the method `appendRandom()` from DataWeave code, in any of the following ways.

- Import the class and then refer to the method:

%dw 2.0 import java!org::mycompany::utils::MyUtils output application/json
---

{ a: MyUtils::appendRandom("myString") }

- Import one or more methods instead of the whole class:

%dw 2.0 import java!org::mycompany::utils::MyUtils::appendRandom output application/json
---

{ a: appendRandom("myString") }

- If the method is a static method, import and call it in a single line:

%dw 2.0 output application/json
---

{ a: java!org::mycompany::utils::MyUtils::appendRandom(vars.myString) }

All three methods return the variable value with a random string appended:

```json
{
  "a": "myString969858409"
}
```

## Instantiate a Java Class

Through DataWeave code, you can instantiate a new object of any class. Note that after creating an
instance, you can’t call its instance methods through DataWeave. However, you can reference its
variables.

This simple Java class has a method and a variable.

```java
package org.mycompany.utils;
public class MyClass {

	private String foo;
	 public MyClass(String foo) {
		 this.foo = foo;
	}

	 public String getFoo() {
		return foo;
	}

}
```

To create the `MyClass` example in a Studio project:

1.  Create a project for the class in Studio by clicking **New** → **Mule Project** and providing a
    name, such as **my-app**, and clicking **Finish**.

2.  From **my-app**, create the `org.mycompany.utils` package by right-clicking **src/main/java**
    from Studio’s **Package Explorer**, selecting **New** → **Package**, and naming the package
    `org.mycompany.utils`.

3.  Create the `MyClass` class in the your new `org.mycompany.utils` package by right-clicking
    **org.mycompany.utils**, selecting **New** → **Class**, naming that class `MyClass`, and
    clicking **Finish**.

4.  In the **MyClass.java** tab that opens in Studio, copy, paste, and save the contents `MyClass`.

The following DataWeave example imports `MyClass`, creates a new instance of the class, and calls
its instance variable `foo`. (Note that it is not possible for DataWeave to call the object’s
private `getFoo()` method.)

```dataweave
%dw 2.0
import java!org::mycompany::utils::MyClass
output application/json
---
{
	a: MyClass::new("myString").foo
}
```

To add this DataWeave example to your Studio project:

1.  Returning to `my-app.xml` in **src/main/mule**, drag a Transform Message component into the
    project’s canvas, and click to open it.

2.  In the component’s **Transform Message** tab, replace the entire script in the source code area
    (on the right) with the DataWeave script (above).

3.  Save your changes and click **Preview** (located farthest right on the tab) to view the
    following output:

{ "a":"myString" }

Note that the XML for the Transform Message configuration in the Mule flow looks something like
this:

```xml
<flow name="my-appFlow" >
	<ee:transform doc:name="Transform Message" >
		<ee:message >
			<ee:set-payload ><![CDATA[%dw 2.0
import java!org::mycompany::utils::MyClass
output application/json
---
{
a: MyClass::new("myString").foo
}]]></ee:set-payload>
		</ee:message>
	</ee:transform>
</flow>
```

## Use a Java Bridge

DataWeave enables you to call any Java static function or constructor by using the Java bridge. This
feature is useful when you need to reuse business logic written in Java or to instantiate any Java
object that does not have an empty public constructor.

To use a Java bridge, transform a fully qualified Java name to a DataWeave name:

1.  Add the prefix `!java`.

2.  Replace the dots in the fully qualified name with `::`.

When invoking the Java function, DataWeave transforms each argument to the expected type in the
function parameter.

The following example shows how to create a new instance of a `java.lang.NullPointerException`:

```dataweave
%dw 2.0
output application/json
---
java!java::lang::NullPointerException::new("foo")
```

The following example invokes the function `java.lang.String.valueOf`:

```dataweave
%dw 2.0
output text/plain
import valueOf from java!java::lang::String
---
valueOf(true)
```

## Java Bridge Example

The following example shows an API that returns a greeting message based on the input `uriParam`.
The Java bridge calls a static method within the `my.class.org.Greeter` class that builds the
response message.

```dataweave
%dw 2.0
output application/json
import java!my::class::org::Greeter
---
{
response: Greeter::greet(attributes.uriParams."name"
}
```

### XML for Java Bridge Example

Paste this code into your Studio XML editor to quickly load the flow for this example into your Mule
app:

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core" xmlns:http="http://www.mulesoft.org/schema/mule/http"
	xmlns="http://www.mulesoft.org/schema/mule/core"
	xmlns:doc="http://www.mulesoft.org/schema/mule/documentation" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/http http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
http://www.mulesoft.org/schema/mule/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd">
	<http:listener-config name="HTTP_Listener_config" doc:name="HTTP Listener config" doc:id="addcdb50-cdfa-400d-992f-495ab6dd373d" >
		<http:listener-connection host="0.0.0.0" port="8081" />
	</http:listener-config>
	<flow name="data-weave-java-bridge-example-flow" >
		<http:listener doc:name="Listener" config-ref="HTTP_Listener_config" path="/greet/{name}"/>
		<ee:transform doc:name="Transform Message" >
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/json
import java!my::class::org::Greeter
---
{
	response: Greeter::greet(attributes.uriParams."name")

}]]></ee:set-payload>
			</ee:message>
		</ee:transform>
	</flow>
</mule>
```

### Test the App

To test your app, follow these steps:

1.  Save and run your Mule app.

2.  Run the following curl command: `http://localhost:8081/greet/Username`.

The Mule app returns the following response message:

```xml
{
 "response": "Greetings, Username!"
}
```

## See Also

- [Java Format](https://docs.mulesoft.com/dataweave/2.12/dataweave-formats-java)

- [Supported Data Formats](https://docs.mulesoft.com/dataweave/2.12/dataweave-formats)

<!-- document id=1a96a29440738f0b6f37d2c751b9fa11c595663e8ab5878eae90997dc1cccb8e url=/mulesoft/current/en-us/dataweave/2.3/dataweave-cookbook-java-methods.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Call Java Methods with DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

From a DataWeave statement, you can call Java methods from any Java class that’s in your Mule
project. Note that you can only call Static methods via DataWeave (methods that belong to a Java
class, not methods that belong to a specific instance of a class).

## Call a Java Method

Before you can call a method, you must first import the class it belongs to into your DataWeave
code. You can import Java classes just as you import DataWeave modules by including `java!` into the
statement.

For example, below is a simple Java class with a single method that appends a random number at the
end of a string. Assume that you created this class as part of a Java package named
`org.mycompany.utils` in your Mule project’s `src/main/java` folder.

```java
package org.mycompany.utils;

import java.util.Random;

public class MyUtils {

	public static String appendRandom(String base) {
		return base + new Random().nextInt();
	}

}
```

You can call the method `appendRandom()` from DataWeave code, in any of the following ways.

- Import the class and then refer to the method:

%dw 2.0 import java!org::mycompany::utils::MyUtils output application/json
---

{ a: MyUtils::appendRandom("myString") }

- Import one or more methods instead of the whole class:

%dw 2.0 import java!org::mycompany::utils::MyUtils::appendRandom output application/json
---

{ a: appendRandom("myString") }

- If the method is a static method, import and call it in a single line:

%dw 2.0 output application/json
---

{ a: java!org::mycompany::utils::MyUtils::appendRandom(vars.myString) }

All three methods return the variable value with a random string appended:

```json
{
  "a": "myString969858409"
}
```

## Instantiate a Java Class

Through DataWeave code, you can instantiate a new object of any class. Note that after creating an
instance, you can’t call its instance methods through DataWeave. However, you can reference its
variables.

This simple Java class has a method and a variable.

```java
package org.mycompany.utils;
public class MyClass {

	private String foo;
	 public MyClass(String foo) {
		 this.foo = foo;
	}

	 public String getFoo() {
		return foo;
	}

}
```

To create the `MyClass` example in a Studio project:

1.  Create a project for the class in Studio by clicking **New** → **Mule Project** and providing a
    name, such as **my-app**, and clicking **Finish**.

2.  From **my-app**, create the `org.mycompany.utils` package by right-clicking **src/main/java**
    from Studio’s **Package Explorer**, selecting **New** → **Package**, and naming the package
    `org.mycompany.utils`.

3.  Create the `MyClass` class in the your new `org.mycompany.utils` package by right-clicking
    **org.mycompany.utils**, selecting **New** → **Class**, naming that class `MyClass`, and
    clicking **Finish**.

4.  In the **MyClass.java** tab that opens in Studio, copy, paste, and save the contents `MyClass`.

The following DataWeave example imports `MyClass`, creates a new instance of the class, and calls
its instance variable `foo`. (Note that it is not possible for DataWeave to call the object’s
private `getFoo()` method.)

```dataweave
%dw 2.0
import java!org::mycompany::utils::MyClass
output application/json
---
{
	a: MyClass::new("myString").foo
}
```

To add this DataWeave example to your Studio project:

1.  Returning to `my-app.xml` in **src/main/mule**, drag a Transform Message component into the
    project’s canvas, and click to open it.

2.  In the component’s **Transform Message** tab, replace the entire script in the source code area
    (on the right) with the DataWeave script (above).

3.  Save your changes and click **Preview** (located farthest right on the tab) to view the
    following output:

{ "a":"myString" }

Note that the XML for the Transform Message configuration in the Mule flow looks something like
this:

```xml
<flow name="my-appFlow" >
	<ee:transform doc:name="Transform Message" >
		<ee:message >
			<ee:set-payload ><![CDATA[%dw 2.0
import java!org::mycompany::utils::MyClass
output application/json
---
{
a: MyClass::new("myString").foo
}]]></ee:set-payload>
		</ee:message>
	</ee:transform>
</flow>
```

## Use a Java Bridge

DataWeave enables you to call any Java static function or constructor by using the Java bridge. This
feature is useful when you need to reuse business logic written in Java or to instantiate any Java
object that does not have an empty public constructor.

To use a Java bridge, transform a fully qualified Java name to a DataWeave name:

1.  Add the prefix `!java`.

2.  Replace the dots in the fully qualified name with `::`.

When invoking the Java function, DataWeave transforms each argument to the expected type in the
function parameter.

The following example shows how to create a new instance of a `java.lang.NullPointerException`:

```dataweave
%dw 2.0
output application/json
---
java!java::lang::NullPointerException::new("foo")
```

The following example invokes the function `java.lang.String.valueOf`:

```dataweave
%dw 2.0
output text/plain
import valueOf from java!java::lang::String
---
valueOf(true)
```

## See Also

- [Java Format](https://docs.mulesoft.com/dataweave/2.3/dataweave-formats-java)

- [Supported Data Formats](https://docs.mulesoft.com/dataweave/2.3/dataweave-formats)

<!-- document id=8ba6afe28a9a6cb26ace8b6ac48d8a84fbf69ff28ef04040bb276e357c4bbda3 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook-java-methods.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Call Java Methods with DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

From a DataWeave statement, you can call Java methods from any Java class that’s in your Mule
project. Note that you can only call Static methods via DataWeave (methods that belong to a Java
class, not methods that belong to a specific instance of a class).

## Call a Java Method

Before you can call a method, you must first import the class it belongs to into your DataWeave
code. You can import Java classes just as you import DataWeave modules by including `java!` into the
statement.

For example, below is a simple Java class with a single method that appends a random number at the
end of a string. Assume that you created this class as part of a Java package named
`org.mycompany.utils` in your Mule project’s `src/main/java` folder.

```java
package org.mycompany.utils;

import java.util.Random;

public class MyUtils {

	public static String appendRandom(String base) {
		return base + new Random().nextInt();
	}

}
```

You can call the method `appendRandom()` from DataWeave code, in any of the following ways.

- Import the class and then refer to the method:

%dw 2.0 import java!org::mycompany::utils::MyUtils output application/json
---

{ a: MyUtils::appendRandom("myString") }

- Import one or more methods instead of the whole class:

%dw 2.0 import java!org::mycompany::utils::MyUtils::appendRandom output application/json
---

{ a: appendRandom("myString") }

- If the method is a static method, import and call it in a single line:

%dw 2.0 output application/json
---

{ a: java!org::mycompany::utils::MyUtils::appendRandom(vars.myString) }

All three methods return the variable value with a random string appended:

```json
{
  "a": "myString969858409"
}
```

## Instantiate a Java Class

Through DataWeave code, you can instantiate a new object of any class. Note that after creating an
instance, you can’t call its instance methods through DataWeave. However, you can reference its
variables.

This simple Java class has a method and a variable.

```java
package org.mycompany.utils;
public class MyClass {

	private String foo;
	 public MyClass(String foo) {
		 this.foo = foo;
	}

	 public String getFoo() {
		return foo;
	}

}
```

To create the `MyClass` example in a Studio project:

1.  Create a project for the class in Studio by clicking **New** → **Mule Project** and providing a
    name, such as **my-app**, and clicking **Finish**.

2.  From **my-app**, create the `org.mycompany.utils` package by right-clicking **src/main/java**
    from Studio’s **Package Explorer**, selecting **New** → **Package**, and naming the package
    `org.mycompany.utils`.

3.  Create the `MyClass` class in the your new `org.mycompany.utils` package by right-clicking
    **org.mycompany.utils**, selecting **New** → **Class**, naming that class `MyClass`, and
    clicking **Finish**.

4.  In the **MyClass.java** tab that opens in Studio, copy, paste, and save the contents `MyClass`.

The following DataWeave example imports `MyClass`, creates a new instance of the class, and calls
its instance variable `foo`. (Note that it is not possible for DataWeave to call the object’s
private `getFoo()` method.)

```dataweave
%dw 2.0
import java!org::mycompany::utils::MyClass
output application/json
---
{
	a: MyClass::new("myString").foo
}
```

To add this DataWeave example to your Studio project:

1.  Returning to `my-app.xml` in **src/main/mule**, drag a Transform Message component into the
    project’s canvas, and click to open it.

2.  In the component’s **Transform Message** tab, replace the entire script in the source code area
    (on the right) with the DataWeave script (above).

3.  Save your changes and click **Preview** (located farthest right on the tab) to view the
    following output:

{ "a":"myString" }

Note that the XML for the Transform Message configuration in the Mule flow looks something like
this:

```xml
<flow name="my-appFlow" >
	<ee:transform doc:name="Transform Message" >
		<ee:message >
			<ee:set-payload ><![CDATA[%dw 2.0
import java!org::mycompany::utils::MyClass
output application/json
---
{
a: MyClass::new("myString").foo
}]]></ee:set-payload>
		</ee:message>
	</ee:transform>
</flow>
```

## Use a Java Bridge

DataWeave enables you to call any Java static function or constructor by using the Java bridge. This
feature is useful when you need to reuse business logic written in Java or to instantiate any Java
object that does not have an empty public constructor.

To use a Java bridge, transform a fully qualified Java name to a DataWeave name:

1.  Add the prefix `!java`.

2.  Replace the dots in the fully qualified name with `::`.

When invoking the Java function, DataWeave transforms each argument to the expected type in the
function parameter.

The following example shows how to create a new instance of a `java.lang.NullPointerException`:

```dataweave
%dw 2.0
output application/json
---
java!java::lang::NullPointerException::new("foo")
```

The following example invokes the function `java.lang.String.valueOf`:

```dataweave
%dw 2.0
output text/plain
import valueOf from java!java::lang::String
---
valueOf(true)
```

## Java Bridge Example

The following example shows an API that returns a greeting message based on the input `uriParam`.
The Java bridge calls a static method within the `my.class.org.Greeter` class that builds the
response message.

```dataweave
%dw 2.0
output application/json
import java!my::class::org::Greeter
---
{
response: Greeter::greet(attributes.uriParams."name"
}
```

### XML for Java Bridge Example

Paste this code into your Studio XML editor to quickly load the flow for this example into your Mule
app:

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core" xmlns:http="http://www.mulesoft.org/schema/mule/http"
	xmlns="http://www.mulesoft.org/schema/mule/core"
	xmlns:doc="http://www.mulesoft.org/schema/mule/documentation" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/http http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
http://www.mulesoft.org/schema/mule/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd">
	<http:listener-config name="HTTP_Listener_config" doc:name="HTTP Listener config" doc:id="addcdb50-cdfa-400d-992f-495ab6dd373d" >
		<http:listener-connection host="0.0.0.0" port="8081" />
	</http:listener-config>
	<flow name="data-weave-java-bridge-example-flow" >
		<http:listener doc:name="Listener" config-ref="HTTP_Listener_config" path="/greet/{name}"/>
		<ee:transform doc:name="Transform Message" >
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/json
import java!my::class::org::Greeter
---
{
	response: Greeter::greet(attributes.uriParams."name")

}]]></ee:set-payload>
			</ee:message>
		</ee:transform>
	</flow>
</mule>
```

### Test the App

To test your app, follow these steps:

1.  Save and run your Mule app.

2.  Run the following curl command: `http://localhost:8081/greet/Username`.

The Mule app returns the following response message:

```xml
{
 "response": "Greetings, Username!"
}
```

## See Also

- [Java Format](https://docs.mulesoft.com/dataweave/2.4/dataweave-formats-java)

- [Supported Data Formats](https://docs.mulesoft.com/dataweave/2.4/dataweave-formats)

<!-- document id=ec7d2940d37ee529fd067eb5af2296bc64f820a4fcf1bf9b72e0a3015c28b837 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook-java-methods.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Call Java Methods with DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

From a DataWeave statement, you can call Java methods from any Java class that’s in your Mule
project. Note that you can only call Static methods via DataWeave (methods that belong to a Java
class, not methods that belong to a specific instance of a class).

## Call a Java Method

Before you can call a method, you must first import the class it belongs to into your DataWeave
code. You can import Java classes just as you import DataWeave modules by including `java!` into the
statement.

For example, below is a simple Java class with a single method that appends a random number at the
end of a string. Assume that you created this class as part of a Java package named
`org.mycompany.utils` in your Mule project’s `src/main/java` folder.

```java
package org.mycompany.utils;

import java.util.Random;

public class MyUtils {

	public static String appendRandom(String base) {
		return base + new Random().nextInt();
	}

}
```

You can call the method `appendRandom()` from DataWeave code, in any of the following ways.

- Import the class and then refer to the method:

%dw 2.0 import java!org::mycompany::utils::MyUtils output application/json
---

{ a: MyUtils::appendRandom("myString") }

- Import one or more methods instead of the whole class:

%dw 2.0 import java!org::mycompany::utils::MyUtils::appendRandom output application/json
---

{ a: appendRandom("myString") }

- If the method is a static method, import and call it in a single line:

%dw 2.0 output application/json
---

{ a: java!org::mycompany::utils::MyUtils::appendRandom(vars.myString) }

All three methods return the variable value with a random string appended:

```json
{
  "a": "myString969858409"
}
```

## Instantiate a Java Class

Through DataWeave code, you can instantiate a new object of any class. Note that after creating an
instance, you can’t call its instance methods through DataWeave. However, you can reference its
variables.

This simple Java class has a method and a variable.

```java
package org.mycompany.utils;
public class MyClass {

	private String foo;
	 public MyClass(String foo) {
		 this.foo = foo;
	}

	 public String getFoo() {
		return foo;
	}

}
```

To create the `MyClass` example in a Studio project:

1.  Create a project for the class in Studio by clicking **New** → **Mule Project** and providing a
    name, such as **my-app**, and clicking **Finish**.

2.  From **my-app**, create the `org.mycompany.utils` package by right-clicking **src/main/java**
    from Studio’s **Package Explorer**, selecting **New** → **Package**, and naming the package
    `org.mycompany.utils`.

3.  Create the `MyClass` class in the your new `org.mycompany.utils` package by right-clicking
    **org.mycompany.utils**, selecting **New** → **Class**, naming that class `MyClass`, and
    clicking **Finish**.

4.  In the **MyClass.java** tab that opens in Studio, copy, paste, and save the contents `MyClass`.

The following DataWeave example imports `MyClass`, creates a new instance of the class, and calls
its instance variable `foo`. (Note that it is not possible for DataWeave to call the object’s
private `getFoo()` method.)

```dataweave
%dw 2.0
import java!org::mycompany::utils::MyClass
output application/json
---
{
	a: MyClass::new("myString").foo
}
```

To add this DataWeave example to your Studio project:

1.  Returning to `my-app.xml` in **src/main/mule**, drag a Transform Message component into the
    project’s canvas, and click to open it.

2.  In the component’s **Transform Message** tab, replace the entire script in the source code area
    (on the right) with the DataWeave script (above).

3.  Save your changes and click **Preview** (located farthest right on the tab) to view the
    following output:

{ "a":"myString" }

Note that the XML for the Transform Message configuration in the Mule flow looks something like
this:

```xml
<flow name="my-appFlow" >
	<ee:transform doc:name="Transform Message" >
		<ee:message >
			<ee:set-payload ><![CDATA[%dw 2.0
import java!org::mycompany::utils::MyClass
output application/json
---
{
a: MyClass::new("myString").foo
}]]></ee:set-payload>
		</ee:message>
	</ee:transform>
</flow>
```

## Use a Java Bridge

DataWeave enables you to call any Java static function or constructor by using the Java bridge. This
feature is useful when you need to reuse business logic written in Java or to instantiate any Java
object that does not have an empty public constructor.

To use a Java bridge, transform a fully qualified Java name to a DataWeave name:

1.  Add the prefix `!java`.

2.  Replace the dots in the fully qualified name with `::`.

When invoking the Java function, DataWeave transforms each argument to the expected type in the
function parameter.

The following example shows how to create a new instance of a `java.lang.NullPointerException`:

```dataweave
%dw 2.0
output application/json
---
java!java::lang::NullPointerException::new("foo")
```

The following example invokes the function `java.lang.String.valueOf`:

```dataweave
%dw 2.0
output text/plain
import valueOf from java!java::lang::String
---
valueOf(true)
```

## Java Bridge Example

The following example shows an API that returns a greeting message based on the input `uriParam`.
The Java bridge calls a static method within the `my.class.org.Greeter` class that builds the
response message.

```dataweave
%dw 2.0
output application/json
import java!my::class::org::Greeter
---
{
response: Greeter::greet(attributes.uriParams."name"
}
```

### XML for Java Bridge Example

Paste this code into your Studio XML editor to quickly load the flow for this example into your Mule
app:

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core" xmlns:http="http://www.mulesoft.org/schema/mule/http"
	xmlns="http://www.mulesoft.org/schema/mule/core"
	xmlns:doc="http://www.mulesoft.org/schema/mule/documentation" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/http http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
http://www.mulesoft.org/schema/mule/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd">
	<http:listener-config name="HTTP_Listener_config" doc:name="HTTP Listener config" doc:id="addcdb50-cdfa-400d-992f-495ab6dd373d" >
		<http:listener-connection host="0.0.0.0" port="8081" />
	</http:listener-config>
	<flow name="data-weave-java-bridge-example-flow" >
		<http:listener doc:name="Listener" config-ref="HTTP_Listener_config" path="/greet/{name}"/>
		<ee:transform doc:name="Transform Message" >
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/json
import java!my::class::org::Greeter
---
{
	response: Greeter::greet(attributes.uriParams."name")

}]]></ee:set-payload>
			</ee:message>
		</ee:transform>
	</flow>
</mule>
```

### Test the App

To test your app, follow these steps:

1.  Save and run your Mule app.

2.  Run the following curl command: `http://localhost:8081/greet/Username`.

The Mule app returns the following response message:

```xml
{
 "response": "Greetings, Username!"
}
```

## See Also

- [Java Format](https://docs.mulesoft.com/dataweave/2.6/dataweave-formats-java)

- [Supported Data Formats](https://docs.mulesoft.com/dataweave/2.6/dataweave-formats)

<!-- document id=500a771f3562aa6e1fcd529938940b8d0ab7f3112442afd4ba35e5a4579cdf78 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook-java-methods.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Call Java Methods with DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

From a DataWeave statement, you can call Java methods from any Java class that’s in your Mule
project. Note that you can only call Static methods via DataWeave (methods that belong to a Java
class, not methods that belong to a specific instance of a class).

## Call a Java Method

Before you can call a method, you must first import the class it belongs to into your DataWeave
code. You can import Java classes just as you import DataWeave modules by including `java!` into the
statement.

For example, below is a simple Java class with a single method that appends a random number at the
end of a string. Assume that you created this class as part of a Java package named
`org.mycompany.utils` in your Mule project’s `src/main/java` folder.

```java
package org.mycompany.utils;

import java.util.Random;

public class MyUtils {

	public static String appendRandom(String base) {
		return base + new Random().nextInt();
	}

}
```

You can call the method `appendRandom()` from DataWeave code, in any of the following ways.

- Import the class and then refer to the method:

%dw 2.0 import java!org::mycompany::utils::MyUtils output application/json
---

{ a: MyUtils::appendRandom("myString") }

- Import one or more methods instead of the whole class:

%dw 2.0 import java!org::mycompany::utils::MyUtils::appendRandom output application/json
---

{ a: appendRandom("myString") }

- If the method is a static method, import and call it in a single line:

%dw 2.0 output application/json
---

{ a: java!org::mycompany::utils::MyUtils::appendRandom(vars.myString) }

All three methods return the variable value with a random string appended:

```json
{
  "a": "myString969858409"
}
```

## Instantiate a Java Class

Through DataWeave code, you can instantiate a new object of any class. Note that after creating an
instance, you can’t call its instance methods through DataWeave. However, you can reference its
variables.

This simple Java class has a method and a variable.

```java
package org.mycompany.utils;
public class MyClass {

	private String foo;
	 public MyClass(String foo) {
		 this.foo = foo;
	}

	 public String getFoo() {
		return foo;
	}

}
```

To create the `MyClass` example in a Studio project:

1.  Create a project for the class in Studio by clicking **New** → **Mule Project** and providing a
    name, such as **my-app**, and clicking **Finish**.

2.  From **my-app**, create the `org.mycompany.utils` package by right-clicking **src/main/java**
    from Studio’s **Package Explorer**, selecting **New** → **Package**, and naming the package
    `org.mycompany.utils`.

3.  Create the `MyClass` class in the your new `org.mycompany.utils` package by right-clicking
    **org.mycompany.utils**, selecting **New** → **Class**, naming that class `MyClass`, and
    clicking **Finish**.

4.  In the **MyClass.java** tab that opens in Studio, copy, paste, and save the contents `MyClass`.

The following DataWeave example imports `MyClass`, creates a new instance of the class, and calls
its instance variable `foo`. (Note that it is not possible for DataWeave to call the object’s
private `getFoo()` method.)

```dataweave
%dw 2.0
import java!org::mycompany::utils::MyClass
output application/json
---
{
	a: MyClass::new("myString").foo
}
```

To add this DataWeave example to your Studio project:

1.  Returning to `my-app.xml` in **src/main/mule**, drag a Transform Message component into the
    project’s canvas, and click to open it.

2.  In the component’s **Transform Message** tab, replace the entire script in the source code area
    (on the right) with the DataWeave script (above).

3.  Save your changes and click **Preview** (located farthest right on the tab) to view the
    following output:

{ "a":"myString" }

Note that the XML for the Transform Message configuration in the Mule flow looks something like
this:

```xml
<flow name="my-appFlow" >
	<ee:transform doc:name="Transform Message" >
		<ee:message >
			<ee:set-payload ><![CDATA[%dw 2.0
import java!org::mycompany::utils::MyClass
output application/json
---
{
a: MyClass::new("myString").foo
}]]></ee:set-payload>
		</ee:message>
	</ee:transform>
</flow>
```

## Use a Java Bridge

DataWeave enables you to call any Java static function or constructor by using the Java bridge. This
feature is useful when you need to reuse business logic written in Java or to instantiate any Java
object that does not have an empty public constructor.

To use a Java bridge, transform a fully qualified Java name to a DataWeave name:

1.  Add the prefix `!java`.

2.  Replace the dots in the fully qualified name with `::`.

When invoking the Java function, DataWeave transforms each argument to the expected type in the
function parameter.

The following example shows how to create a new instance of a `java.lang.NullPointerException`:

```dataweave
%dw 2.0
output application/json
---
java!java::lang::NullPointerException::new("foo")
```

The following example invokes the function `java.lang.String.valueOf`:

```dataweave
%dw 2.0
output text/plain
import valueOf from java!java::lang::String
---
valueOf(true)
```

## Java Bridge Example

The following example shows an API that returns a greeting message based on the input `uriParam`.
The Java bridge calls a static method within the `my.class.org.Greeter` class that builds the
response message.

```dataweave
%dw 2.0
output application/json
import java!my::class::org::Greeter
---
{
response: Greeter::greet(attributes.uriParams."name"
}
```

### XML for Java Bridge Example

Paste this code into your Studio XML editor to quickly load the flow for this example into your Mule
app:

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core" xmlns:http="http://www.mulesoft.org/schema/mule/http"
	xmlns="http://www.mulesoft.org/schema/mule/core"
	xmlns:doc="http://www.mulesoft.org/schema/mule/documentation" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/http http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
http://www.mulesoft.org/schema/mule/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd">
	<http:listener-config name="HTTP_Listener_config" doc:name="HTTP Listener config" doc:id="addcdb50-cdfa-400d-992f-495ab6dd373d" >
		<http:listener-connection host="0.0.0.0" port="8081" />
	</http:listener-config>
	<flow name="data-weave-java-bridge-example-flow" >
		<http:listener doc:name="Listener" config-ref="HTTP_Listener_config" path="/greet/{name}"/>
		<ee:transform doc:name="Transform Message" >
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/json
import java!my::class::org::Greeter
---
{
	response: Greeter::greet(attributes.uriParams."name")

}]]></ee:set-payload>
			</ee:message>
		</ee:transform>
	</flow>
</mule>
```

### Test the App

To test your app, follow these steps:

1.  Save and run your Mule app.

2.  Run the following curl command: `http://localhost:8081/greet/Username`.

The Mule app returns the following response message:

```xml
{
 "response": "Greetings, Username!"
}
```

## See Also

- [Java Format](https://docs.mulesoft.com/dataweave/2.9/dataweave-formats-java)

- [Supported Data Formats](https://docs.mulesoft.com/dataweave/2.9/dataweave-formats)

<!-- document id=7ffafe7aa2db0c5e62c960cbf58fc1e19183f5ac8a300eb2ce9672995fee9c4f url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook-java-methods.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Call Java Methods with DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

From a DataWeave statement, you can call Java methods from any Java class that’s in your Mule
project. Note that you can only call Static methods via DataWeave (methods that belong to a Java
class, not methods that belong to a specific instance of a class).

## Call a Java Method

Before you can call a method, you must first import the class it belongs to into your DataWeave
code. You can import Java classes just as you import DataWeave modules by including `java!` into the
statement.

For example, below is a simple Java class with a single method that appends a random number at the
end of a string. Assume that you created this class as part of a Java package named
`org.mycompany.utils` in your Mule project’s `src/main/java` folder.

```java
package org.mycompany.utils;

import java.util.Random;

public class MyUtils {

	public static String appendRandom(String base) {
		return base + new Random().nextInt();
	}

}
```

You can call the method `appendRandom()` from DataWeave code, in any of the following ways.

- Import the class and then refer to the method:

%dw 2.0 import java!org::mycompany::utils::MyUtils output application/json
---

{ a: MyUtils::appendRandom("myString") }

- Import one or more methods instead of the whole class:

%dw 2.0 import java!org::mycompany::utils::MyUtils::appendRandom output application/json
---

{ a: appendRandom("myString") }

- If the method is a static method, import and call it in a single line:

%dw 2.0 output application/json
---

{ a: java!org::mycompany::utils::MyUtils::appendRandom(vars.myString) }

All three methods return the variable value with a random string appended:

```json
{
  "a": "myString969858409"
}
```

## Instantiate a Java Class

Through DataWeave code, you can instantiate a new object of any class. Note that after creating an
instance, you can’t call its instance methods through DataWeave. However, you can reference its
variables.

This simple Java class has a method and a variable.

```java
package org.mycompany.utils;
public class MyClass {

	private String foo;
	 public MyClass(String foo) {
		 this.foo = foo;
	}

	 public String getFoo() {
		return foo;
	}

}
```

To create the `MyClass` example in a Studio project:

1.  Create a project for the class in Studio by clicking **New** → **Mule Project** and providing a
    name, such as **my-app**, and clicking **Finish**.

2.  From **my-app**, create the `org.mycompany.utils` package by right-clicking **src/main/java**
    from Studio’s **Package Explorer**, selecting **New** → **Package**, and naming the package
    `org.mycompany.utils`.

3.  Create the `MyClass` class in the your new `org.mycompany.utils` package by right-clicking
    **org.mycompany.utils**, selecting **New** → **Class**, naming that class `MyClass`, and
    clicking **Finish**.

4.  In the **MyClass.java** tab that opens in Studio, copy, paste, and save the contents `MyClass`.

The following DataWeave example imports `MyClass`, creates a new instance of the class, and calls
its instance variable `foo`. (Note that it is not possible for DataWeave to call the object’s
private `getFoo()` method.)

```dataweave
%dw 2.0
import java!org::mycompany::utils::MyClass
output application/json
---
{
	a: MyClass::new("myString").foo
}
```

To add this DataWeave example to your Studio project:

1.  Returning to `my-app.xml` in **src/main/mule**, drag a Transform Message component into the
    project’s canvas, and click to open it.

2.  In the component’s **Transform Message** tab, replace the entire script in the source code area
    (on the right) with the DataWeave script (above).

3.  Save your changes and click **Preview** (located farthest right on the tab) to view the
    following output:

{ "a":"myString" }

Note that the XML for the Transform Message configuration in the Mule flow looks something like
this:

```xml
<flow name="my-appFlow" >
	<ee:transform doc:name="Transform Message" >
		<ee:message >
			<ee:set-payload ><![CDATA[%dw 2.0
import java!org::mycompany::utils::MyClass
output application/json
---
{
a: MyClass::new("myString").foo
}]]></ee:set-payload>
		</ee:message>
	</ee:transform>
</flow>
```

## Use a Java Bridge

DataWeave enables you to call any Java static function or constructor by using the Java bridge. This
feature is useful when you need to reuse business logic written in Java or to instantiate any Java
object that does not have an empty public constructor.

To use a Java bridge, transform a fully qualified Java name to a DataWeave name:

1.  Add the prefix `!java`.

2.  Replace the dots in the fully qualified name with `::`.

When invoking the Java function, DataWeave transforms each argument to the expected type in the
function parameter.

The following example shows how to create a new instance of a `java.lang.NullPointerException`:

```dataweave
%dw 2.0
output application/json
---
java!java::lang::NullPointerException::new("foo")
```

The following example invokes the function `java.lang.String.valueOf`:

```dataweave
%dw 2.0
output text/plain
import valueOf from java!java::lang::String
---
valueOf(true)
```

## Java Bridge Example

The following example shows an API that returns a greeting message based on the input `uriParam`.
The Java bridge calls a static method within the `my.class.org.Greeter` class that builds the
response message.

```dataweave
%dw 2.0
output application/json
import java!my::class::org::Greeter
---
{
response: Greeter::greet(attributes.uriParams."name"
}
```

### XML for Java Bridge Example

Paste this code into your Studio XML editor to quickly load the flow for this example into your Mule
app:

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core" xmlns:http="http://www.mulesoft.org/schema/mule/http"
	xmlns="http://www.mulesoft.org/schema/mule/core"
	xmlns:doc="http://www.mulesoft.org/schema/mule/documentation" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/http http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
http://www.mulesoft.org/schema/mule/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd">
	<http:listener-config name="HTTP_Listener_config" doc:name="HTTP Listener config" doc:id="addcdb50-cdfa-400d-992f-495ab6dd373d" >
		<http:listener-connection host="0.0.0.0" port="8081" />
	</http:listener-config>
	<flow name="data-weave-java-bridge-example-flow" >
		<http:listener doc:name="Listener" config-ref="HTTP_Listener_config" path="/greet/{name}"/>
		<ee:transform doc:name="Transform Message" >
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/json
import java!my::class::org::Greeter
---
{
	response: Greeter::greet(attributes.uriParams."name")

}]]></ee:set-payload>
			</ee:message>
		</ee:transform>
	</flow>
</mule>
```

### Test the App

To test your app, follow these steps:

1.  Save and run your Mule app.

2.  Run the following curl command: `http://localhost:8081/greet/Username`.

The Mule app returns the following response message:

```xml
{
 "response": "Greetings, Username!"
}
```

## See Also

- [Java Format](https://docs.mulesoft.com/dataweave/latest/dataweave-formats-java)

- [Supported Data Formats](https://docs.mulesoft.com/dataweave/latest/dataweave-formats)

<!-- document id=5f519fdcdbaf2117f48dcf4dd6943928a456752880f28569fcfb887918c9e662 url=/mulesoft/current/en-us/dataweave/2.11/dw-strings-functions-camelize.md -->

---
product: DataWeave
version: 2.11
---

# camelize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## camelize(text: String): String

Returns a string in camel case based on underscores in the string.

All underscores are deleted, including any underscores at the beginning of the string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to convert to camel case.</p></td></tr></tbody></table>

### Example

This example converts a string that contains underscores to camel case.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a" : camelize("customer_first_name"),
  "b" : camelize("_name_starts_with_underscore")
}
```

#### Output

```JSON
{
   "a": "customerFirstName",
   "b": "nameStartsWithUnderscore"
 }
```

## camelize(text: Null): Null

Helper function that enables `camelize` to work with a `null` value.

<!-- document id=b8bace0960c1bb77bb3df928ce2245f103b4148dd8ed4b675ee9eb11f120e02c url=/mulesoft/current/en-us/dataweave/2.12/dw-strings-functions-camelize.md -->

---
product: DataWeave
version: 2.12
---

# camelize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## camelize(text: String): String

Returns a string in camel case based on underscores in the string.

All underscores are deleted, including any underscores at the beginning of the string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to convert to camel case.</p></td></tr></tbody></table>

### Example

This example converts a string that contains underscores to camel case.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a" : camelize("customer_first_name"),
  "b" : camelize("_name_starts_with_underscore")
}
```

#### Output

```JSON
{
   "a": "customerFirstName",
   "b": "nameStartsWithUnderscore"
 }
```

## camelize(text: Null): Null

Helper function that enables `camelize` to work with a `null` value.

<!-- document id=e3e2f6fd197ce64b25a79ea217f8f81048d2b2c2e74b9c38221c730b426fedda url=/mulesoft/current/en-us/dataweave/2.3/dw-strings-functions-camelize.md -->

---
product: DataWeave
version: 2.3
---

# camelize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## camelize(String): String

Returns a string in camel case based on underscores in the string.

All underscores are deleted, including any underscores at the beginning of the string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to convert to camel case.</p></td></tr></tbody></table>

### Example

This example converts a string that contains underscores to camel case.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a" : camelize("customer_first_name"),
  "b" : camelize("_name_starts_with_underscore")
}
```

#### Output

```JSON
{
   "a": "customerFirstName",
   "b": "nameStartsWithUnderscore"
 }
```

## camelize(Null): Null

Helper function that enables `camelize` to work with a `null` value.

<!-- document id=c20ca0d7619dbdabeff5df2d6617842a66ff7ebc040526fe2c9279ed69dff58d url=/mulesoft/current/en-us/dataweave/2.4/dw-strings-functions-camelize.md -->

---
product: DataWeave
version: 2.4
---

# camelize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## camelize(text: String): String

Returns a string in camel case based on underscores in the string.

All underscores are deleted, including any underscores at the beginning of the string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to convert to camel case.</p></td></tr></tbody></table>

### Example

This example converts a string that contains underscores to camel case.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a" : camelize("customer_first_name"),
  "b" : camelize("_name_starts_with_underscore")
}
```

#### Output

```JSON
{
   "a": "customerFirstName",
   "b": "nameStartsWithUnderscore"
 }
```

## camelize(text: Null): Null

Helper function that enables `camelize` to work with a `null` value.

<!-- document id=1289765519c3e34dba2b15a453dfb3a809fa33e8cfde03fb5672151751108bed url=/mulesoft/current/en-us/dataweave/2.6/dw-strings-functions-camelize.md -->

---
product: DataWeave
version: 2.6
---

# camelize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## camelize(text: String): String

Returns a string in camel case based on underscores in the string.

All underscores are deleted, including any underscores at the beginning of the string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to convert to camel case.</p></td></tr></tbody></table>

### Example

This example converts a string that contains underscores to camel case.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a" : camelize("customer_first_name"),
  "b" : camelize("_name_starts_with_underscore")
}
```

#### Output

```JSON
{
   "a": "customerFirstName",
   "b": "nameStartsWithUnderscore"
 }
```

## camelize(text: Null): Null

Helper function that enables `camelize` to work with a `null` value.

<!-- document id=ca46c9332fd4116e0439081325c380129df8cb3fbc1284a3b8888a7953b8064f url=/mulesoft/current/en-us/dataweave/2.9/dw-strings-functions-camelize.md -->

---
product: DataWeave
version: 2.9
---

# camelize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## camelize(text: String): String

Returns a string in camel case based on underscores in the string.

All underscores are deleted, including any underscores at the beginning of the string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to convert to camel case.</p></td></tr></tbody></table>

### Example

This example converts a string that contains underscores to camel case.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a" : camelize("customer_first_name"),
  "b" : camelize("_name_starts_with_underscore")
}
```

#### Output

```JSON
{
   "a": "customerFirstName",
   "b": "nameStartsWithUnderscore"
 }
```

## camelize(text: Null): Null

Helper function that enables `camelize` to work with a `null` value.

<!-- document id=40735b882c02f6cdf15e42592fcca69505618163d68237d5bfee1a778f56a881 url=/mulesoft/current/en-us/dataweave/latest/dw-strings-functions-camelize.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# camelize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## camelize(text: String): String

Returns a string in camel case based on underscores in the string.

All underscores are deleted, including any underscores at the beginning of the string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to convert to camel case.</p></td></tr></tbody></table>

### Example

This example converts a string that contains underscores to camel case.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a" : camelize("customer_first_name"),
  "b" : camelize("_name_starts_with_underscore")
}
```

#### Output

```JSON
{
   "a": "customerFirstName",
   "b": "nameStartsWithUnderscore"
 }
```

## camelize(text: Null): Null

Helper function that enables `camelize` to work with a `null` value.

<!-- document id=f524303a39c56ee10d74ce9fd7c6fd0808972912ec277ad9f21e435a9691e59a url=/mulesoft/current/en-us/dataweave/2.11/dw-strings-functions-capitalize.md -->

---
product: DataWeave
version: 2.11
---

# capitalize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## capitalize(text: String): String

Capitalizes the first letter of each word in a string.

The function treats every non-alphabetic character as a separator and replaces underscores with
spaces. For example, `capitalize("a*s_b’s")` results in `"A*S B’S"`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to capitalize.</p></td></tr></tbody></table>

### Example

This example capitalizes a set of strings.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a" : capitalize("customer"),
  "b" : capitalize("customer_first_name"),
  "c" : capitalize("customer NAME"),
  "d" : capitalize("customerName"),
  "e" : capitalize("a*s_b’s")
}
```

#### Output

```JSON
{
  "a": "Customer",
  "b": "Customer First Name",
  "c": "Customer Name",
  "d": "Customer Name",
  "e": "A*S B’S"
}
```

## capitalize(text: Null): Null

Helper function that enables `capitalize` to work with a `null` value.

<!-- document id=5561583db6bedf193382885c34d45bbc937f4e4440334576c2e8e1c218e0c43f url=/mulesoft/current/en-us/dataweave/2.12/dw-strings-functions-capitalize.md -->

---
product: DataWeave
version: 2.12
---

# capitalize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## capitalize(text: String): String

Capitalizes the first letter of each word in a string.

The function treats every non-alphabetic character as a separator and replaces underscores with
spaces. For example, `capitalize("a*s_b’s")` results in `"A*S B’S"`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to capitalize.</p></td></tr></tbody></table>

### Example

This example capitalizes a set of strings.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a" : capitalize("customer"),
  "b" : capitalize("customer_first_name"),
  "c" : capitalize("customer NAME"),
  "d" : capitalize("customerName"),
  "e" : capitalize("a*s_b’s")
}
```

#### Output

```JSON
{
  "a": "Customer",
  "b": "Customer First Name",
  "c": "Customer Name",
  "d": "Customer Name",
  "e": "A*S B’S"
}
```

## capitalize(text: Null): Null

Helper function that enables `capitalize` to work with a `null` value.

<!-- document id=22114d2d574f4c29f51f76a9ba61c74ca01e38e15b045155bc7cd1c90ddc6061 url=/mulesoft/current/en-us/dataweave/2.3/dw-strings-functions-capitalize.md -->

---
product: DataWeave
version: 2.3
---

# capitalize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## capitalize(String): String

Capitalizes the first letter of each word in a string.

The function treats every non-alphabetic character as a separator and replaces underscores with
spaces. For example, `capitalize("a*s_b’s")` results in `"A*S B’S"`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to capitalize.</p></td></tr></tbody></table>

### Example

This example capitalizes a set of strings.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a" : capitalize("customer"),
  "b" : capitalize("customer_first_name"),
  "c" : capitalize("customer NAME"),
  "d" : capitalize("customerName"),
  "e" : capitalize("a*s_b’s")
}
```

#### Output

```JSON
{
  "a": "Customer",
  "b": "Customer First Name",
  "c": "Customer Name",
  "d": "Customer Name",
  "e": "A*S B’S"
}
```

## capitalize(Null): Null

Helper function that enables `capitalize` to work with a `null` value.

<!-- document id=958ec4f2047c2efa32eab5a35e90f38ccf358b5b6d701789961e9bdd90024cfb url=/mulesoft/current/en-us/dataweave/2.4/dw-strings-functions-capitalize.md -->

---
product: DataWeave
version: 2.4
---

# capitalize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## capitalize(text: String): String

Capitalizes the first letter of each word in a string.

The function treats every non-alphabetic character as a separator and replaces underscores with
spaces. For example, `capitalize("a*s_b’s")` results in `"A*S B’S"`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to capitalize.</p></td></tr></tbody></table>

### Example

This example capitalizes a set of strings.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a" : capitalize("customer"),
  "b" : capitalize("customer_first_name"),
  "c" : capitalize("customer NAME"),
  "d" : capitalize("customerName"),
  "e" : capitalize("a*s_b’s")
}
```

#### Output

```JSON
{
  "a": "Customer",
  "b": "Customer First Name",
  "c": "Customer Name",
  "d": "Customer Name",
  "e": "A*S B’S"
}
```

## capitalize(text: Null): Null

Helper function that enables `capitalize` to work with a `null` value.

<!-- document id=28f55b863b03f0e06fba2ff9ae7e3a13724c79e15922532aae2cf30d64ff23c7 url=/mulesoft/current/en-us/dataweave/2.6/dw-strings-functions-capitalize.md -->

---
product: DataWeave
version: 2.6
---

# capitalize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## capitalize(text: String): String

Capitalizes the first letter of each word in a string.

The function treats every non-alphabetic character as a separator and replaces underscores with
spaces. For example, `capitalize("a*s_b’s")` results in `"A*S B’S"`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to capitalize.</p></td></tr></tbody></table>

### Example

This example capitalizes a set of strings.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a" : capitalize("customer"),
  "b" : capitalize("customer_first_name"),
  "c" : capitalize("customer NAME"),
  "d" : capitalize("customerName"),
  "e" : capitalize("a*s_b’s")
}
```

#### Output

```JSON
{
  "a": "Customer",
  "b": "Customer First Name",
  "c": "Customer Name",
  "d": "Customer Name",
  "e": "A*S B’S"
}
```

## capitalize(text: Null): Null

Helper function that enables `capitalize` to work with a `null` value.

<!-- document id=1636401082bd5b8eab72d025bab62daaec25d6637112810bdf3bd1fe8637e63b url=/mulesoft/current/en-us/dataweave/2.9/dw-strings-functions-capitalize.md -->

---
product: DataWeave
version: 2.9
---

# capitalize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## capitalize(text: String): String

Capitalizes the first letter of each word in a string.

The function treats every non-alphabetic character as a separator and replaces underscores with
spaces. For example, `capitalize("a*s_b’s")` results in `"A*S B’S"`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to capitalize.</p></td></tr></tbody></table>

### Example

This example capitalizes a set of strings.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a" : capitalize("customer"),
  "b" : capitalize("customer_first_name"),
  "c" : capitalize("customer NAME"),
  "d" : capitalize("customerName"),
  "e" : capitalize("a*s_b’s")
}
```

#### Output

```JSON
{
  "a": "Customer",
  "b": "Customer First Name",
  "c": "Customer Name",
  "d": "Customer Name",
  "e": "A*S B’S"
}
```

## capitalize(text: Null): Null

Helper function that enables `capitalize` to work with a `null` value.

<!-- document id=192d831b547004cd0e24402ae19d73ce221ecc87b93bce5fc7a772aca4982ba9 url=/mulesoft/current/en-us/dataweave/latest/dw-strings-functions-capitalize.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# capitalize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## capitalize(text: String): String

Capitalizes the first letter of each word in a string.

The function treats every non-alphabetic character as a separator and replaces underscores with
spaces. For example, `capitalize("a*s_b’s")` results in `"A*S B’S"`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to capitalize.</p></td></tr></tbody></table>

### Example

This example capitalizes a set of strings.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a" : capitalize("customer"),
  "b" : capitalize("customer_first_name"),
  "c" : capitalize("customer NAME"),
  "d" : capitalize("customerName"),
  "e" : capitalize("a*s_b’s")
}
```

#### Output

```JSON
{
  "a": "Customer",
  "b": "Customer First Name",
  "c": "Customer Name",
  "d": "Customer Name",
  "e": "A*S B’S"
}
```

## capitalize(text: Null): Null

Helper function that enables `capitalize` to work with a `null` value.

<!-- document id=52619ed1b8cfd8da992fb67317a1cb2fc6ad6581f1224eeac9599cbac9acade0 url=/mulesoft/current/en-us/dataweave/2.11/dw-mule-functions-causedby.md -->

---
product: DataWeave
version: 2.11
---

# causedBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## causedBy(@DesignOnlyType error: Error, errorType: String): Boolean

This function matches an error by its type, like an error handler does.

`causedBy` is useful when you need to match by a super type, but the specific sub-type logic is also
needed. It can also useful when handling a COMPOSITE\_ROUTING error that contains child errors of
different types.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>error</code></p></td><td><p>Optional. An <code>Error</code> type.</p></td></tr><tr><td><p><code>errorType</code></p></td><td><p>A string that identifies the error, such as HTTP:UNAUTHORIZED.</p></td></tr></tbody></table>

### Example

This XML example calls `causedBy` from a `when` expression in a Mule error handling component to
handle a SECURITY error differently depending on whether it was caused by an HTTP:UNAUTHORIZED or
HTTP:FORBIDDEN error. Notice that the first expression passes in the `error` (an `Error` type)
explicitly, while the second one passes it implicitly, without specifying the value of the
parameter. Note that `error` is the variable that DataWeave uses for errors associated with a Mule
message object (see
[DataWeave Variables for Mule Runtime](https://docs.mulesoft.com/dataweave/latest/dataweave-variables-context)).

#### Source

```XML
<error-handler name="securityHandler">
  <on-error-continue type="SECURITY">
    <!-- general error handling for all SECURITY errors -->
    <choice>
      <when expression="#[Mule::causedBy(error, 'HTTP:UNAUTHORIZED')]">
        <!-- specific error handling only for HTTP:UNAUTHORIZED errors -->
      </when>
      <when expression="#[Mule::causedBy('HTTP:FORBIDDEN')]">
        <!-- specific error handling only for HTTP:FORBIDDEN errors -->
      </when>
    </choice>
  </on-error-continue>
</error-handler>
```

<!-- document id=508f5d11bebc20e0d72207530541968117182aa0fd5e8cb98139721a98603fe5 url=/mulesoft/current/en-us/dataweave/2.12/dw-mule-functions-causedby.md -->

---
product: DataWeave
version: 2.12
---

# causedBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## causedBy(@DesignOnlyType error: Error, errorType: String): Boolean

This function matches an error by its type, like an error handler does.

`causedBy` is useful when you need to match by a super type, but the specific sub-type logic is also
needed. It can also useful when handling a COMPOSITE\_ROUTING error that contains child errors of
different types.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>error</code></p></td><td><p>Optional. An <code>Error</code> type.</p></td></tr><tr><td><p><code>errorType</code></p></td><td><p>A string that identifies the error, such as HTTP:UNAUTHORIZED.</p></td></tr></tbody></table>

### Example

This XML example calls `causedBy` from a `when` expression in a Mule error handling component to
handle a SECURITY error differently depending on whether it was caused by an HTTP:UNAUTHORIZED or
HTTP:FORBIDDEN error. Notice that the first expression passes in the `error` (an `Error` type)
explicitly, while the second one passes it implicitly, without specifying the value of the
parameter. Note that `error` is the variable that DataWeave uses for errors associated with a Mule
message object (see
[DataWeave Variables for Mule Runtime](https://docs.mulesoft.com/dataweave/latest/dataweave-variables-context)).

#### Source

```XML
<error-handler name="securityHandler">
  <on-error-continue type="SECURITY">
    <!-- general error handling for all SECURITY errors -->
    <choice>
      <when expression="#[Mule::causedBy(error, 'HTTP:UNAUTHORIZED')]">
        <!-- specific error handling only for HTTP:UNAUTHORIZED errors -->
      </when>
      <when expression="#[Mule::causedBy('HTTP:FORBIDDEN')]">
        <!-- specific error handling only for HTTP:FORBIDDEN errors -->
      </when>
    </choice>
  </on-error-continue>
</error-handler>
```

<!-- document id=a30292be98395883d0b9c3dd2781a71d2b06cafa50f59c4067005d37f68127cb url=/mulesoft/current/en-us/dataweave/2.3/dw-mule-functions-causedby.md -->

---
product: DataWeave
version: 2.3
---

# causedBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## causedBy(Error, String): Boolean

This function matches an error by its type, like an error handler does.

`causedBy` is useful when you need to match by a super type, but the specific sub-type logic is also
needed. It can also useful when handling a COMPOSITE\_ROUTING error that contains child errors of
different types.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>error</code></p></td><td><p>Optional. An <code>Error</code> type.</p></td></tr><tr><td><p><code>errorType</code></p></td><td><p>A string that identifies the error, such as HTTP:UNAUTHORIZED.</p></td></tr></tbody></table>

### Example

This XML example calls `causedBy` from a `when` expression in a Mule error handling component to
handle a SECURITY error differently depending on whether it was caused by an HTTP:UNAUTHORIZED or
HTTP:FORBIDDEN error. Notice that the first expression passes in the `error` (an `Error` type)
explicitly, while the second one passes it implicitly, without specifying the value of the
parameter. Note that `error` is the variable that DataWeave uses for errors associated with a Mule
message object. See
[DataWeave Variables for Mule Runtime](https://docs.mulesoft.com/dataweave/latest/dataweave-variables-context)
for more details.

#### Source

```XML
<error-handler name="securityHandler">
  <on-error-continue type="SECURITY">
    <!-- general error handling for all SECURITY errors -->
    <choice>
      <when expression="#[Mule::causedBy(error, 'HTTP:UNAUTHORIZED')]">
        <!-- specific error handling only for HTTP:UNAUTHORIZED errors -->
      </when>
      <when expression="#[Mule::causedBy('HTTP:FORBIDDEN')]">
        <!-- specific error handling only for HTTP:FORBIDDEN errors -->
      </when>
    </choice>
  </on-error-continue>
</error-handler>
```

<!-- document id=f991bc542c1b662e07f4144d774b9b86ae65ecaccdbef8b131b65e099256e11e url=/mulesoft/current/en-us/dataweave/2.4/dw-mule-functions-causedby.md -->

---
product: DataWeave
version: 2.4
---

# causedBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## causedBy(@DesignOnlyType error: Error, errorType: String): Boolean

This function matches an error by its type, like an error handler does.

`causedBy` is useful when you need to match by a super type, but the specific sub-type logic is also
needed. It can also useful when handling a COMPOSITE\_ROUTING error that contains child errors of
different types.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>error</code></p></td><td><p>Optional. An <code>Error</code> type.</p></td></tr><tr><td><p><code>errorType</code></p></td><td><p>A string that identifies the error, such as HTTP:UNAUTHORIZED.</p></td></tr></tbody></table>

### Example

This XML example calls `causedBy` from a `when` expression in a Mule error handling component to
handle a SECURITY error differently depending on whether it was caused by an HTTP:UNAUTHORIZED or
HTTP:FORBIDDEN error. Notice that the first expression passes in the `error` (an `Error` type)
explicitly, while the second one passes it implicitly, without specifying the value of the
parameter. Note that `error` is the variable that DataWeave uses for errors associated with a Mule
message object (see
[DataWeave Variables for Mule Runtime](https://docs.mulesoft.com/dataweave/latest/dataweave-variables-context)).

#### Source

```XML
<error-handler name="securityHandler">
  <on-error-continue type="SECURITY">
    <!-- general error handling for all SECURITY errors -->
    <choice>
      <when expression="#[Mule::causedBy(error, 'HTTP:UNAUTHORIZED')]">
        <!-- specific error handling only for HTTP:UNAUTHORIZED errors -->
      </when>
      <when expression="#[Mule::causedBy('HTTP:FORBIDDEN')]">
        <!-- specific error handling only for HTTP:FORBIDDEN errors -->
      </when>
    </choice>
  </on-error-continue>
</error-handler>
```

<!-- document id=3ebabe7203d3a8213fe3a03bd5c06e5c59e0c56e2ccb7bd838040b28c17ddece url=/mulesoft/current/en-us/dataweave/2.6/dw-mule-functions-causedby.md -->

---
product: DataWeave
version: 2.6
---

# causedBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## causedBy(@DesignOnlyType error: Error, errorType: String): Boolean

This function matches an error by its type, like an error handler does.

`causedBy` is useful when you need to match by a super type, but the specific sub-type logic is also
needed. It can also useful when handling a COMPOSITE\_ROUTING error that contains child errors of
different types.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>error</code></p></td><td><p>Optional. An <code>Error</code> type.</p></td></tr><tr><td><p><code>errorType</code></p></td><td><p>A string that identifies the error, such as HTTP:UNAUTHORIZED.</p></td></tr></tbody></table>

### Example

This XML example calls `causedBy` from a `when` expression in a Mule error handling component to
handle a SECURITY error differently depending on whether it was caused by an HTTP:UNAUTHORIZED or
HTTP:FORBIDDEN error. Notice that the first expression passes in the `error` (an `Error` type)
explicitly, while the second one passes it implicitly, without specifying the value of the
parameter. Note that `error` is the variable that DataWeave uses for errors associated with a Mule
message object (see
[DataWeave Variables for Mule Runtime](https://docs.mulesoft.com/dataweave/latest/dataweave-variables-context)).

#### Source

```XML
<error-handler name="securityHandler">
  <on-error-continue type="SECURITY">
    <!-- general error handling for all SECURITY errors -->
    <choice>
      <when expression="#[Mule::causedBy(error, 'HTTP:UNAUTHORIZED')]">
        <!-- specific error handling only for HTTP:UNAUTHORIZED errors -->
      </when>
      <when expression="#[Mule::causedBy('HTTP:FORBIDDEN')]">
        <!-- specific error handling only for HTTP:FORBIDDEN errors -->
      </when>
    </choice>
  </on-error-continue>
</error-handler>
```

<!-- document id=e6c2b06704060e679f77afc1b8f332b36c8ea95f56c38b8bd59e1e5d1e94dd2d url=/mulesoft/current/en-us/dataweave/2.9/dw-mule-functions-causedby.md -->

---
product: DataWeave
version: 2.9
---

# causedBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## causedBy(@DesignOnlyType error: Error, errorType: String): Boolean

This function matches an error by its type, like an error handler does.

`causedBy` is useful when you need to match by a super type, but the specific sub-type logic is also
needed. It can also useful when handling a COMPOSITE\_ROUTING error that contains child errors of
different types.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>error</code></p></td><td><p>Optional. An <code>Error</code> type.</p></td></tr><tr><td><p><code>errorType</code></p></td><td><p>A string that identifies the error, such as HTTP:UNAUTHORIZED.</p></td></tr></tbody></table>

### Example

This XML example calls `causedBy` from a `when` expression in a Mule error handling component to
handle a SECURITY error differently depending on whether it was caused by an HTTP:UNAUTHORIZED or
HTTP:FORBIDDEN error. Notice that the first expression passes in the `error` (an `Error` type)
explicitly, while the second one passes it implicitly, without specifying the value of the
parameter. Note that `error` is the variable that DataWeave uses for errors associated with a Mule
message object (see
[DataWeave Variables for Mule Runtime](https://docs.mulesoft.com/dataweave/latest/dataweave-variables-context)).

#### Source

```XML
<error-handler name="securityHandler">
  <on-error-continue type="SECURITY">
    <!-- general error handling for all SECURITY errors -->
    <choice>
      <when expression="#[Mule::causedBy(error, 'HTTP:UNAUTHORIZED')]">
        <!-- specific error handling only for HTTP:UNAUTHORIZED errors -->
      </when>
      <when expression="#[Mule::causedBy('HTTP:FORBIDDEN')]">
        <!-- specific error handling only for HTTP:FORBIDDEN errors -->
      </when>
    </choice>
  </on-error-continue>
</error-handler>
```

<!-- document id=e9b16925845900166cce43c33f8c9be0fffb4e9d0ab274d79364dcd3ace6a0be url=/mulesoft/current/en-us/dataweave/latest/dw-mule-functions-causedby.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# causedBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## causedBy(@DesignOnlyType error: Error, errorType: String): Boolean

This function matches an error by its type, like an error handler does.

`causedBy` is useful when you need to match by a super type, but the specific sub-type logic is also
needed. It can also useful when handling a COMPOSITE\_ROUTING error that contains child errors of
different types.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>error</code></p></td><td><p>Optional. An <code>Error</code> type.</p></td></tr><tr><td><p><code>errorType</code></p></td><td><p>A string that identifies the error, such as HTTP:UNAUTHORIZED.</p></td></tr></tbody></table>

### Example

This XML example calls `causedBy` from a `when` expression in a Mule error handling component to
handle a SECURITY error differently depending on whether it was caused by an HTTP:UNAUTHORIZED or
HTTP:FORBIDDEN error. Notice that the first expression passes in the `error` (an `Error` type)
explicitly, while the second one passes it implicitly, without specifying the value of the
parameter. Note that `error` is the variable that DataWeave uses for errors associated with a Mule
message object (see
[DataWeave Variables for Mule Runtime](https://docs.mulesoft.com/dataweave/latest/dataweave-variables-context)).

#### Source

```XML
<error-handler name="securityHandler">
  <on-error-continue type="SECURITY">
    <!-- general error handling for all SECURITY errors -->
    <choice>
      <when expression="#[Mule::causedBy(error, 'HTTP:UNAUTHORIZED')]">
        <!-- specific error handling only for HTTP:UNAUTHORIZED errors -->
      </when>
      <when expression="#[Mule::causedBy('HTTP:FORBIDDEN')]">
        <!-- specific error handling only for HTTP:FORBIDDEN errors -->
      </when>
    </choice>
  </on-error-continue>
</error-handler>
```

<!-- document id=18f074d4ddb73964fc45257cc1a48037f202df0fb5438c2643738fff6366838e url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-ceil.md -->

---
product: DataWeave
version: 2.11
---

# ceil

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## ceil(number: Number): Number

Rounds a number up to the nearest whole number.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to round.</p></td></tr></tbody></table>

### Example

This example rounds numbers up to the nearest whole numbers. Notice that `2.1` rounds up to `3`.

#### Source

```DataWeave
%dw 2.0
output application/json
---

[ ceil(1.5), ceil(2.1), ceil(3) ]
```

#### Output

```JSON
[ 2, 3, 3 ]
```

<!-- document id=ccebdedbee7f71af2ffe5ee73f4f7480502cdee36cd410433e6f2c74a65cbca1 url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-ceil.md -->

---
product: DataWeave
version: 2.12
---

# ceil

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## ceil(number: Number): Number

Rounds a number up to the nearest whole number.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to round.</p></td></tr></tbody></table>

### Example

This example rounds numbers up to the nearest whole numbers. Notice that `2.1` rounds up to `3`.

#### Source

```DataWeave
%dw 2.0
output application/json
---

[ ceil(1.5), ceil(2.1), ceil(3) ]
```

#### Output

```JSON
[ 2, 3, 3 ]
```

<!-- document id=924c16b6dd2ac00677a0a1ae4ebee089c8aa702b4f68c8d6c4555d84340bb5d9 url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-ceil.md -->

---
product: DataWeave
version: 2.3
---

# ceil

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## ceil(Number): Number

Rounds a number up to the nearest whole number.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to round.</p></td></tr></tbody></table>

### Example

This example rounds numbers up to the nearest whole numbers. Notice that `2.1` rounds up to `3`.

#### Source

```DataWeave
%dw 2.0
output application/json
---

[ ceil(1.5), ceil(2.1), ceil(3) ]
```

#### Output

```JSON
[ 2, 3, 3 ]
```

<!-- document id=cdcc2964c81dab50a67a75689f8717f08331acc3ecd820f27989af530d5f037a url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-ceil.md -->

---
product: DataWeave
version: 2.4
---

# ceil

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## ceil(number: Number): Number

Rounds a number up to the nearest whole number.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to round.</p></td></tr></tbody></table>

### Example

This example rounds numbers up to the nearest whole numbers. Notice that `2.1` rounds up to `3`.

#### Source

```DataWeave
%dw 2.0
output application/json
---

[ ceil(1.5), ceil(2.1), ceil(3) ]
```

#### Output

```JSON
[ 2, 3, 3 ]
```

<!-- document id=4d0d03faee3f2f218ce86ccd2446dfc54a3e6a015d2ec742ad550d5babaca26c url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-ceil.md -->

---
product: DataWeave
version: 2.6
---

# ceil

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## ceil(number: Number): Number

Rounds a number up to the nearest whole number.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to round.</p></td></tr></tbody></table>

### Example

This example rounds numbers up to the nearest whole numbers. Notice that `2.1` rounds up to `3`.

#### Source

```DataWeave
%dw 2.0
output application/json
---

[ ceil(1.5), ceil(2.1), ceil(3) ]
```

#### Output

```JSON
[ 2, 3, 3 ]
```

<!-- document id=7fa37d2ca4456a89be37981bf0661e486bea13bda71b795a74227f6ee8231e0c url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-ceil.md -->

---
product: DataWeave
version: 2.9
---

# ceil

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## ceil(number: Number): Number

Rounds a number up to the nearest whole number.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to round.</p></td></tr></tbody></table>

### Example

This example rounds numbers up to the nearest whole numbers. Notice that `2.1` rounds up to `3`.

#### Source

```DataWeave
%dw 2.0
output application/json
---

[ ceil(1.5), ceil(2.1), ceil(3) ]
```

#### Output

```JSON
[ 2, 3, 3 ]
```

<!-- document id=d8d6e2b8f7d694f7279ca3612cec5423159a0b6b0318fe5791e593592aac89d0 url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-ceil.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# ceil

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## ceil(number: Number): Number

Rounds a number up to the nearest whole number.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to round.</p></td></tr></tbody></table>

### Example

This example rounds numbers up to the nearest whole numbers. Notice that `2.1` rounds up to `3`.

#### Source

```DataWeave
%dw 2.0
output application/json
---

[ ceil(1.5), ceil(2.1), ceil(3) ]
```

#### Output

```JSON
[ 2, 3, 3 ]
```

<!-- document id=d93e972a2875580c0057328efed3dcbefdb9b6aedffded3a91eac6a0d02fe134 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook-change-script-output-mime.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, transform, transformer, format, dataweave, data weave, output structure, mime type, mime
---

# Change a Script’s MIME Type Output

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The DataWeave examples show how to differentiate the output MIME type from the MIME type in which
the output data is formatted. Such differentiation enables a Mule application to output a MIME type
that clients can use to determine how to render the application’s output data. An example is HTTP,
which uses the MIME type to generate its `Content-Type` header.

The first example uses the "problem details" standard for APIs. The standard requires the
`application/problem+json` content type in the response header and a JSON-formatted response body
that contains specific keys.

The example is a Mule flow that handles HTTP requests but always fails. The failure triggers the
error handler, which sets the status code to 400 and uses a DataWeave script to produce a response
that conforms to the standard.

The DataWeave output directive `output application/problem+json with json` instructs the script to
produce a response with the `application/problem+json` MIME type and a JSON-formatted body.

A client that receives the 400 error uses the `Content-Type: application/problem+json` in the
response to determine that it can handle the response data in the standard way, for example, using
the `title` key it expects. By contrast, the MIME type `Content-Type: application/json`, without
`problem+`, fails to indicate whether the client can handle the error in that way.

Mule Flow:

```xml
<flow name="problemDetailFlow">
		<http:listener config-ref="HTTP_Listener_config" path="/test">
			<http:error-response statusCode="#[vars.statusCode]" >
				<http:body ><![CDATA[#[payload]]]></http:body>
			</http:error-response>
		</http:listener>
		<raise-error doc:name="Raise error" type="CUSTOM:FORCED" description="This is a manual error to force the execution of the error handler."/>
		<error-handler >
			<on-error-propagate>
				<set-variable value="#[400]" variableName="statusCode"/>
				<ee:transform>
					<ee:message>
						<ee:set-payload><![CDATA[%dw 2.0
output application/problem+json with json
---
{
  "type": "https://example.org/out-of-stock",
  title: "Out of Stock",
  status: vars.statusCode,
  detail: "Item B00027Y5QG is no longer available",
  product: "B00027Y5QG"
}]]></ee:set-payload>
					</ee:message>
				</ee:transform>
			</on-error-propagate>
		</error-handler>
	</flow>
```

Response:

```text
HTTP/1.1 400 Bad Request
Content-Type: application/problem+json; charset=UTF-8
Content-Length: 173
Date: Thu, 02 Apr 2020 19:48:23 GMT
Connection: close

[data-source-url=modules/ROOT/pages/_partials/cookbook-dw/change-script-output-mime-ex1-partial-solution]
{
  "type": "https://example.org/out-of-stock",
  "title": "Out of Stock",
  "status": 400,
  "detail": "Item B00027Y5QG is no longer available",
  "product": "B00027Y5QG"
}
```

In the next example, the Mule flow returns `text/markdown` content generated by DataWeave as simple
text. A browser that supports Markdown might render the input as bulleted content according to the
rules of Markdown instead of rendering it in plain text with asterisks.

Mule Flow:

```xml
<flow name="listFlow">
  <http:listener config-ref="HTTP_Listener_config" path="/some.md"/>
  <ee:transform>
    <ee:message>
      <ee:set-payload ><![CDATA[%dw 2.0
output text/markdown with text
---
"* idea 1
* some other idea"]]></ee:set-payload>
    </ee:message>
  </ee:transform>
</flow>
```

Response:

```text
HTTP/1.1 200
Content-Type: text/markdown; charset=UTF-8
Content-Length: 26
Date: Thu, 02 Apr 2020 21:28:36 GMT

* idea 1
* some other idea
```

## See Also

- [DataWeave Formats](https://docs.mulesoft.com/dataweave/2.11/dataweave-formats)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook)

<!-- document id=db7d6ab7d4b0feec7bb804e5d82a289db00ccb31b72ffeaf9a4a131b83f8847b url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook-change-script-output-mime.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, transform, transformer, format, dataweave, data weave, output structure, mime type, mime
---

# Change a Script’s MIME Type Output

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The DataWeave examples show how to differentiate the output MIME type from the MIME type in which
the output data is formatted. Such differentiation enables a Mule application to output a MIME type
that clients can use to determine how to render the application’s output data. An example is HTTP,
which uses the MIME type to generate its `Content-Type` header.

The first example uses the "problem details" standard for APIs. The standard requires the
`application/problem+json` content type in the response header and a JSON-formatted response body
that contains specific keys.

The example is a Mule flow that handles HTTP requests but always fails. The failure triggers the
error handler, which sets the status code to 400 and uses a DataWeave script to produce a response
that conforms to the standard.

The DataWeave output directive `output application/problem+json with json` instructs the script to
produce a response with the `application/problem+json` MIME type and a JSON-formatted body.

A client that receives the 400 error uses the `Content-Type: application/problem+json` in the
response to determine that it can handle the response data in the standard way, for example, using
the `title` key it expects. By contrast, the MIME type `Content-Type: application/json`, without
`problem+`, fails to indicate whether the client can handle the error in that way.

Mule Flow:

```xml
<flow name="problemDetailFlow">
		<http:listener config-ref="HTTP_Listener_config" path="/test">
			<http:error-response statusCode="#[vars.statusCode]" >
				<http:body ><![CDATA[#[payload]]]></http:body>
			</http:error-response>
		</http:listener>
		<raise-error doc:name="Raise error" type="CUSTOM:FORCED" description="This is a manual error to force the execution of the error handler."/>
		<error-handler >
			<on-error-propagate>
				<set-variable value="#[400]" variableName="statusCode"/>
				<ee:transform>
					<ee:message>
						<ee:set-payload><![CDATA[%dw 2.0
output application/problem+json with json
---
{
  "type": "https://example.org/out-of-stock",
  title: "Out of Stock",
  status: vars.statusCode,
  detail: "Item B00027Y5QG is no longer available",
  product: "B00027Y5QG"
}]]></ee:set-payload>
					</ee:message>
				</ee:transform>
			</on-error-propagate>
		</error-handler>
	</flow>
```

Response:

```text
HTTP/1.1 400 Bad Request
Content-Type: application/problem+json; charset=UTF-8
Content-Length: 173
Date: Thu, 02 Apr 2020 19:48:23 GMT
Connection: close

[data-source-url=modules/ROOT/pages/_partials/cookbook-dw/change-script-output-mime-ex1-partial-solution]
{
  "type": "https://example.org/out-of-stock",
  "title": "Out of Stock",
  "status": 400,
  "detail": "Item B00027Y5QG is no longer available",
  "product": "B00027Y5QG"
}
```

In the next example, the Mule flow returns `text/markdown` content generated by DataWeave as simple
text. A browser that supports Markdown might render the input as bulleted content according to the
rules of Markdown instead of rendering it in plain text with asterisks.

Mule Flow:

```xml
<flow name="listFlow">
  <http:listener config-ref="HTTP_Listener_config" path="/some.md"/>
  <ee:transform>
    <ee:message>
      <ee:set-payload ><![CDATA[%dw 2.0
output text/markdown with text
---
"* idea 1
* some other idea"]]></ee:set-payload>
    </ee:message>
  </ee:transform>
</flow>
```

Response:

```text
HTTP/1.1 200
Content-Type: text/markdown; charset=UTF-8
Content-Length: 26
Date: Thu, 02 Apr 2020 21:28:36 GMT

* idea 1
* some other idea
```

## See Also

- [DataWeave Formats](https://docs.mulesoft.com/dataweave/2.12/dataweave-formats)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook)

<!-- document id=5f6a7113eac45e899842d844fbd76256b157f002c3551eba8191d1b4eb448bf9 url=/mulesoft/current/en-us/dataweave/2.3/dataweave-cookbook-change-script-output-mime.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, transform, transformer, format, dataweave, data weave, output structure, mime type, mime
---

# Change a Script’s MIME Type Output

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The DataWeave examples show how to differentiate the output MIME type from the MIME type in which
the output data is formatted. Such differentiation enables a Mule application to output a MIME type
that clients can use to determine how to render the application’s output data. An example is HTTP,
which uses the MIME type to generate its `Content-Type` header.

The first example uses the "problem details" standard for APIs. The standard requires the
`application/problem+json` content type in the response header and a JSON-formatted response body
that contains specific keys.

The example is a Mule flow that handles HTTP requests but always fails. The failure triggers the
error handler, which sets the status code to 400 and uses a DataWeave script to produce a response
that conforms to the standard.

The DataWeave output directive `output application/problem+json with json` instructs the script to
produce a response with the `application/problem+json` MIME type and a JSON-formatted body.

A client that receives the 400 error uses the `Content-Type: application/problem+json` in the
response to determine that it can handle the response data in the standard way, for example, using
the `title` key it expects. By contrast, the MIME type `Content-Type: application/json`, without
`problem+`, fails to indicate whether the client can handle the error in that way.

Mule Flow:

```xml
<flow name="problemDetailFlow">
		<http:listener config-ref="HTTP_Listener_config" path="/test">
			<http:error-response statusCode="#[vars.statusCode]" >
				<http:body ><![CDATA[#[payload]]]></http:body>
			</http:error-response>
		</http:listener>
		<raise-error doc:name="Raise error" type="CUSTOM:FORCED" description="This is a manual error to force the execution of the error handler."/>
		<error-handler >
			<on-error-propagate>
				<set-variable value="#[400]" variableName="statusCode"/>
				<ee:transform>
					<ee:message>
						<ee:set-payload><![CDATA[%dw 2.0
output application/problem+json with json
---
{
  "type": "https://example.org/out-of-stock",
  title: "Out of Stock",
  status: vars.statusCode,
  detail: "Item B00027Y5QG is no longer available",
  product: "B00027Y5QG"
}]]></ee:set-payload>
					</ee:message>
				</ee:transform>
			</on-error-propagate>
		</error-handler>
	</flow>
```

Response:

```text
HTTP/1.1 400 Bad Request
Content-Type: application/problem+json; charset=UTF-8
Content-Length: 173
Date: Thu, 02 Apr 2020 19:48:23 GMT
Connection: close

[data-source-url=modules/ROOT/pages/_partials/cookbook-dw/change-script-output-mime-ex1-partial-solution]
{
  "type": "https://example.org/out-of-stock",
  "title": "Out of Stock",
  "status": 400,
  "detail": "Item B00027Y5QG is no longer available",
  "product": "B00027Y5QG"
}
```

In the next example, the Mule flow returns `text/markdown` content generated by DataWeave as simple
text. A browser that supports Markdown might render the input as bulleted content according to the
rules of Markdown instead of rendering it in plain text with asterisks.

Mule Flow:

```xml
<flow name="listFlow">
  <http:listener config-ref="HTTP_Listener_config" path="/some.md"/>
  <ee:transform>
    <ee:message>
      <ee:set-payload ><![CDATA[%dw 2.0
output text/markdown with text
---
"* idea 1
* some other idea"]]></ee:set-payload>
    </ee:message>
  </ee:transform>
</flow>
```

Response:

```text
HTTP/1.1 200
Content-Type: text/markdown; charset=UTF-8
Content-Length: 26
Date: Thu, 02 Apr 2020 21:28:36 GMT

* idea 1
* some other idea
```

## See Also

- [DataWeave Formats](https://docs.mulesoft.com/dataweave/2.3/dataweave-formats)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook)

<!-- document id=13a36703f705087b5eadbe17d132becc5be748068b7f85567748159833e92a8e url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook-change-script-output-mime.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, transform, transformer, format, dataweave, data weave, output structure, mime type, mime
---

# Change a Script’s MIME Type Output

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The DataWeave examples show how to differentiate the output MIME type from the MIME type in which
the output data is formatted. Such differentiation enables a Mule application to output a MIME type
that clients can use to determine how to render the application’s output data. An example is HTTP,
which uses the MIME type to generate its `Content-Type` header.

The first example uses the "problem details" standard for APIs. The standard requires the
`application/problem+json` content type in the response header and a JSON-formatted response body
that contains specific keys.

The example is a Mule flow that handles HTTP requests but always fails. The failure triggers the
error handler, which sets the status code to 400 and uses a DataWeave script to produce a response
that conforms to the standard.

The DataWeave output directive `output application/problem+json with json` instructs the script to
produce a response with the `application/problem+json` MIME type and a JSON-formatted body.

A client that receives the 400 error uses the `Content-Type: application/problem+json` in the
response to determine that it can handle the response data in the standard way, for example, using
the `title` key it expects. By contrast, the MIME type `Content-Type: application/json`, without
`problem+`, fails to indicate whether the client can handle the error in that way.

Mule Flow:

```xml
<flow name="problemDetailFlow">
		<http:listener config-ref="HTTP_Listener_config" path="/test">
			<http:error-response statusCode="#[vars.statusCode]" >
				<http:body ><![CDATA[#[payload]]]></http:body>
			</http:error-response>
		</http:listener>
		<raise-error doc:name="Raise error" type="CUSTOM:FORCED" description="This is a manual error to force the execution of the error handler."/>
		<error-handler >
			<on-error-propagate>
				<set-variable value="#[400]" variableName="statusCode"/>
				<ee:transform>
					<ee:message>
						<ee:set-payload><![CDATA[%dw 2.0
output application/problem+json with json
---
{
  "type": "https://example.org/out-of-stock",
  title: "Out of Stock",
  status: vars.statusCode,
  detail: "Item B00027Y5QG is no longer available",
  product: "B00027Y5QG"
}]]></ee:set-payload>
					</ee:message>
				</ee:transform>
			</on-error-propagate>
		</error-handler>
	</flow>
```

Response:

```text
HTTP/1.1 400 Bad Request
Content-Type: application/problem+json; charset=UTF-8
Content-Length: 173
Date: Thu, 02 Apr 2020 19:48:23 GMT
Connection: close

[data-source-url=modules/ROOT/pages/_partials/cookbook-dw/change-script-output-mime-ex1-partial-solution]
{
  "type": "https://example.org/out-of-stock",
  "title": "Out of Stock",
  "status": 400,
  "detail": "Item B00027Y5QG is no longer available",
  "product": "B00027Y5QG"
}
```

In the next example, the Mule flow returns `text/markdown` content generated by DataWeave as simple
text. A browser that supports Markdown might render the input as bulleted content according to the
rules of Markdown instead of rendering it in plain text with asterisks.

Mule Flow:

```xml
<flow name="listFlow">
  <http:listener config-ref="HTTP_Listener_config" path="/some.md"/>
  <ee:transform>
    <ee:message>
      <ee:set-payload ><![CDATA[%dw 2.0
output text/markdown with text
---
"* idea 1
* some other idea"]]></ee:set-payload>
    </ee:message>
  </ee:transform>
</flow>
```

Response:

```text
HTTP/1.1 200
Content-Type: text/markdown; charset=UTF-8
Content-Length: 26
Date: Thu, 02 Apr 2020 21:28:36 GMT

* idea 1
* some other idea
```

## See Also

- [DataWeave Formats](https://docs.mulesoft.com/dataweave/2.4/dataweave-formats)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook)

<!-- document id=cf62908d32729eb909dfe1e1c49121100ef8fdcfb5ec19f093e286ed2d96dddc url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook-change-script-output-mime.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, transform, transformer, format, dataweave, data weave, output structure, mime type, mime
---

# Change a Script’s MIME Type Output

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The DataWeave examples show how to differentiate the output MIME type from the MIME type in which
the output data is formatted. Such differentiation enables a Mule application to output a MIME type
that clients can use to determine how to render the application’s output data. An example is HTTP,
which uses the MIME type to generate its `Content-Type` header.

The first example uses the "problem details" standard for APIs. The standard requires the
`application/problem+json` content type in the response header and a JSON-formatted response body
that contains specific keys.

The example is a Mule flow that handles HTTP requests but always fails. The failure triggers the
error handler, which sets the status code to 400 and uses a DataWeave script to produce a response
that conforms to the standard.

The DataWeave output directive `output application/problem+json with json` instructs the script to
produce a response with the `application/problem+json` MIME type and a JSON-formatted body.

A client that receives the 400 error uses the `Content-Type: application/problem+json` in the
response to determine that it can handle the response data in the standard way, for example, using
the `title` key it expects. By contrast, the MIME type `Content-Type: application/json`, without
`problem+`, fails to indicate whether the client can handle the error in that way.

Mule Flow:

```xml
<flow name="problemDetailFlow">
		<http:listener config-ref="HTTP_Listener_config" path="/test">
			<http:error-response statusCode="#[vars.statusCode]" >
				<http:body ><![CDATA[#[payload]]]></http:body>
			</http:error-response>
		</http:listener>
		<raise-error doc:name="Raise error" type="CUSTOM:FORCED" description="This is a manual error to force the execution of the error handler."/>
		<error-handler >
			<on-error-propagate>
				<set-variable value="#[400]" variableName="statusCode"/>
				<ee:transform>
					<ee:message>
						<ee:set-payload><![CDATA[%dw 2.0
output application/problem+json with json
---
{
  "type": "https://example.org/out-of-stock",
  title: "Out of Stock",
  status: vars.statusCode,
  detail: "Item B00027Y5QG is no longer available",
  product: "B00027Y5QG"
}]]></ee:set-payload>
					</ee:message>
				</ee:transform>
			</on-error-propagate>
		</error-handler>
	</flow>
```

Response:

```text
HTTP/1.1 400 Bad Request
Content-Type: application/problem+json; charset=UTF-8
Content-Length: 173
Date: Thu, 02 Apr 2020 19:48:23 GMT
Connection: close

[data-source-url=modules/ROOT/pages/_partials/cookbook-dw/change-script-output-mime-ex1-partial-solution]
{
  "type": "https://example.org/out-of-stock",
  "title": "Out of Stock",
  "status": 400,
  "detail": "Item B00027Y5QG is no longer available",
  "product": "B00027Y5QG"
}
```

In the next example, the Mule flow returns `text/markdown` content generated by DataWeave as simple
text. A browser that supports Markdown might render the input as bulleted content according to the
rules of Markdown instead of rendering it in plain text with asterisks.

Mule Flow:

```xml
<flow name="listFlow">
  <http:listener config-ref="HTTP_Listener_config" path="/some.md"/>
  <ee:transform>
    <ee:message>
      <ee:set-payload ><![CDATA[%dw 2.0
output text/markdown with text
---
"* idea 1
* some other idea"]]></ee:set-payload>
    </ee:message>
  </ee:transform>
</flow>
```

Response:

```text
HTTP/1.1 200
Content-Type: text/markdown; charset=UTF-8
Content-Length: 26
Date: Thu, 02 Apr 2020 21:28:36 GMT

* idea 1
* some other idea
```

## See Also

- [DataWeave Formats](https://docs.mulesoft.com/dataweave/2.6/dataweave-formats)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook)

<!-- document id=f0ea624352d44d7e51187e16700fa2b7c1baf6021fd688f32e422572f91bbcef url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook-change-script-output-mime.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, transform, transformer, format, dataweave, data weave, output structure, mime type, mime
---

# Change a Script’s MIME Type Output

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The DataWeave examples show how to differentiate the output MIME type from the MIME type in which
the output data is formatted. Such differentiation enables a Mule application to output a MIME type
that clients can use to determine how to render the application’s output data. An example is HTTP,
which uses the MIME type to generate its `Content-Type` header.

The first example uses the "problem details" standard for APIs. The standard requires the
`application/problem+json` content type in the response header and a JSON-formatted response body
that contains specific keys.

The example is a Mule flow that handles HTTP requests but always fails. The failure triggers the
error handler, which sets the status code to 400 and uses a DataWeave script to produce a response
that conforms to the standard.

The DataWeave output directive `output application/problem+json with json` instructs the script to
produce a response with the `application/problem+json` MIME type and a JSON-formatted body.

A client that receives the 400 error uses the `Content-Type: application/problem+json` in the
response to determine that it can handle the response data in the standard way, for example, using
the `title` key it expects. By contrast, the MIME type `Content-Type: application/json`, without
`problem+`, fails to indicate whether the client can handle the error in that way.

Mule Flow:

```xml
<flow name="problemDetailFlow">
		<http:listener config-ref="HTTP_Listener_config" path="/test">
			<http:error-response statusCode="#[vars.statusCode]" >
				<http:body ><![CDATA[#[payload]]]></http:body>
			</http:error-response>
		</http:listener>
		<raise-error doc:name="Raise error" type="CUSTOM:FORCED" description="This is a manual error to force the execution of the error handler."/>
		<error-handler >
			<on-error-propagate>
				<set-variable value="#[400]" variableName="statusCode"/>
				<ee:transform>
					<ee:message>
						<ee:set-payload><![CDATA[%dw 2.0
output application/problem+json with json
---
{
  "type": "https://example.org/out-of-stock",
  title: "Out of Stock",
  status: vars.statusCode,
  detail: "Item B00027Y5QG is no longer available",
  product: "B00027Y5QG"
}]]></ee:set-payload>
					</ee:message>
				</ee:transform>
			</on-error-propagate>
		</error-handler>
	</flow>
```

Response:

```text
HTTP/1.1 400 Bad Request
Content-Type: application/problem+json; charset=UTF-8
Content-Length: 173
Date: Thu, 02 Apr 2020 19:48:23 GMT
Connection: close

[data-source-url=modules/ROOT/pages/_partials/cookbook-dw/change-script-output-mime-ex1-partial-solution]
{
  "type": "https://example.org/out-of-stock",
  "title": "Out of Stock",
  "status": 400,
  "detail": "Item B00027Y5QG is no longer available",
  "product": "B00027Y5QG"
}
```

In the next example, the Mule flow returns `text/markdown` content generated by DataWeave as simple
text. A browser that supports Markdown might render the input as bulleted content according to the
rules of Markdown instead of rendering it in plain text with asterisks.

Mule Flow:

```xml
<flow name="listFlow">
  <http:listener config-ref="HTTP_Listener_config" path="/some.md"/>
  <ee:transform>
    <ee:message>
      <ee:set-payload ><![CDATA[%dw 2.0
output text/markdown with text
---
"* idea 1
* some other idea"]]></ee:set-payload>
    </ee:message>
  </ee:transform>
</flow>
```

Response:

```text
HTTP/1.1 200
Content-Type: text/markdown; charset=UTF-8
Content-Length: 26
Date: Thu, 02 Apr 2020 21:28:36 GMT

* idea 1
* some other idea
```

## See Also

- [DataWeave Formats](https://docs.mulesoft.com/dataweave/2.9/dataweave-formats)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook)

<!-- document id=5e6149fab57dee7fc8add70ff2214393e525930216a1aa79d03458f2028ea6c1 url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook-change-script-output-mime.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, transform, transformer, format, dataweave, data weave, output structure, mime type, mime
---

# Change a Script’s MIME Type Output

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The DataWeave examples show how to differentiate the output MIME type from the MIME type in which
the output data is formatted. Such differentiation enables a Mule application to output a MIME type
that clients can use to determine how to render the application’s output data. An example is HTTP,
which uses the MIME type to generate its `Content-Type` header.

The first example uses the "problem details" standard for APIs. The standard requires the
`application/problem+json` content type in the response header and a JSON-formatted response body
that contains specific keys.

The example is a Mule flow that handles HTTP requests but always fails. The failure triggers the
error handler, which sets the status code to 400 and uses a DataWeave script to produce a response
that conforms to the standard.

The DataWeave output directive `output application/problem+json with json` instructs the script to
produce a response with the `application/problem+json` MIME type and a JSON-formatted body.

A client that receives the 400 error uses the `Content-Type: application/problem+json` in the
response to determine that it can handle the response data in the standard way, for example, using
the `title` key it expects. By contrast, the MIME type `Content-Type: application/json`, without
`problem+`, fails to indicate whether the client can handle the error in that way.

Mule Flow:

```xml
<flow name="problemDetailFlow">
		<http:listener config-ref="HTTP_Listener_config" path="/test">
			<http:error-response statusCode="#[vars.statusCode]" >
				<http:body ><![CDATA[#[payload]]]></http:body>
			</http:error-response>
		</http:listener>
		<raise-error doc:name="Raise error" type="CUSTOM:FORCED" description="This is a manual error to force the execution of the error handler."/>
		<error-handler >
			<on-error-propagate>
				<set-variable value="#[400]" variableName="statusCode"/>
				<ee:transform>
					<ee:message>
						<ee:set-payload><![CDATA[%dw 2.0
output application/problem+json with json
---
{
  "type": "https://example.org/out-of-stock",
  title: "Out of Stock",
  status: vars.statusCode,
  detail: "Item B00027Y5QG is no longer available",
  product: "B00027Y5QG"
}]]></ee:set-payload>
					</ee:message>
				</ee:transform>
			</on-error-propagate>
		</error-handler>
	</flow>
```

Response:

```text
HTTP/1.1 400 Bad Request
Content-Type: application/problem+json; charset=UTF-8
Content-Length: 173
Date: Thu, 02 Apr 2020 19:48:23 GMT
Connection: close

[data-source-url=modules/ROOT/pages/_partials/cookbook-dw/change-script-output-mime-ex1-partial-solution]
{
  "type": "https://example.org/out-of-stock",
  "title": "Out of Stock",
  "status": 400,
  "detail": "Item B00027Y5QG is no longer available",
  "product": "B00027Y5QG"
}
```

In the next example, the Mule flow returns `text/markdown` content generated by DataWeave as simple
text. A browser that supports Markdown might render the input as bulleted content according to the
rules of Markdown instead of rendering it in plain text with asterisks.

Mule Flow:

```xml
<flow name="listFlow">
  <http:listener config-ref="HTTP_Listener_config" path="/some.md"/>
  <ee:transform>
    <ee:message>
      <ee:set-payload ><![CDATA[%dw 2.0
output text/markdown with text
---
"* idea 1
* some other idea"]]></ee:set-payload>
    </ee:message>
  </ee:transform>
</flow>
```

Response:

```text
HTTP/1.1 200
Content-Type: text/markdown; charset=UTF-8
Content-Length: 26
Date: Thu, 02 Apr 2020 21:28:36 GMT

* idea 1
* some other idea
```

## See Also

- [DataWeave Formats](https://docs.mulesoft.com/dataweave/latest/dataweave-formats)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook)

<!-- document id=dbc3ccef2cf0e80e70df2b90ac8b1eed68b424932a478bb9a5726e96fe420235 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook-change-time-zone.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, date, time
---

# Change a Time Zone

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following example uses the `>>` operator and a [time zone ID](#timezone-ids) to change the time
zone. It also uses the formatting characters `uuuu-MM-dd'T'HH:mm:ss.SSS` to modify the format. The
`uuuu` characters represent the year.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
fun format(d: DateTime) = d as String {format: "yyyy-MM-dd'T'HH:mm:ss.SSS"}
---
{
    CreatedDateTime: format(|2019-02-13T13:23:00.120Z| >> "CET"),
}
```

Output JSON:

```JSON
{
    "CreatedDateTime": "2019-02-13T14:23:00.120"
}
```

## Time Zone IDs

In addition to accepting time zone values such as `-07:00`, DataWeave accepts Java 8 `TimeZone` ID
values, which are available through a Java method call to `ZoneId.getAvailableZoneIds()`.

To see all available values in the following table, scroll right.

<table><colgroup><col> <col> <col> <col> <col> <col> <col> <col></colgroup><thead><tr><th></th><th></th><th></th><th></th><th></th><th></th><th></th><th></th></tr></thead><tbody><tr><td><div><div><p>Africa:</p></div><div><ul><li><p>Africa/Abidjan</p></li><li><p>Africa/Accra</p></li><li><p>Africa/Addis_Ababa</p></li><li><p>Africa/Algiers</p></li><li><p>Africa/Asmara</p></li><li><p>Africa/Asmera</p></li><li><p>Africa/Bamako</p></li><li><p>Africa/Bangui</p></li><li><p>Africa/Banjul</p></li><li><p>Africa/Bissau</p></li><li><p>Africa/Blantyre</p></li><li><p>Africa/Brazzaville</p></li><li><p>Africa/Bujumbura</p></li><li><p>Africa/Cairo</p></li><li><p>Africa/Casablanca</p></li><li><p>Africa/Ceuta</p></li><li><p>Africa/Conakry</p></li><li><p>Africa/Dakar</p></li><li><p>Africa/Dar_es_Salaam</p></li><li><p>Africa/Djibouti</p></li><li><p>Africa/Douala</p></li><li><p>Africa/El_Aaiun</p></li><li><p>Africa/Freetown</p></li><li><p>Africa/Gaborone</p></li><li><p>Africa/Harare</p></li><li><p>Africa/Johannesburg</p></li><li><p>Africa/Juba</p></li><li><p>Africa/Kampala</p></li><li><p>Africa/Khartoum</p></li><li><p>Africa/Kigali</p></li><li><p>Africa/Kinshasa</p></li><li><p>Africa/Lagos</p></li><li><p>Africa/Libreville</p></li><li><p>Africa/Lome</p></li><li><p>Africa/Luanda</p></li><li><p>Africa/Lubumbashi</p></li><li><p>Africa/Lusaka</p></li><li><p>Africa/Malabo</p></li><li><p>Africa/Maputo</p></li><li><p>Africa/Maseru</p></li><li><p>Africa/Mbabane</p></li><li><p>Africa/Mogadishu</p></li><li><p>Africa/Monrovia</p></li><li><p>Africa/Nairobi</p></li><li><p>Africa/Ndjamena</p></li><li><p>Africa/Niamey</p></li><li><p>Africa/Nouakchott</p></li><li><p>Africa/Ouagadougou</p></li><li><p>Africa/Porto-Novo</p></li><li><p>Africa/Sao_Tome</p></li><li><p>Africa/Timbuktu</p></li><li><p>Africa/Tripoli</p></li><li><p>Africa/Tunis</p></li><li><p>Africa/Windhoek</p></li></ul></div><div><p>America:</p></div><div><ul><li><p>America/Adak</p></li><li><p>America/Anchorage</p></li><li><p>America/Anguilla</p></li><li><p>America/Antigua</p></li><li><p>America/Araguaina</p></li><li><p>America/Argentina/Buenos_Aires</p></li><li><p>America/Argentina/Catamarca</p></li><li><p>America/Argentina/ComodRivadavia</p></li><li><p>America/Argentina/Cordoba</p></li><li><p>America/Argentina/Jujuy</p></li><li><p>America/Argentina/La_Rioja</p></li><li><p>America/Argentina/Mendoza</p></li><li><p>America/Argentina/Rio_Gallegos</p></li><li><p>America/Argentina/Salta</p></li><li><p>America/Argentina/San_Juan</p></li><li><p>America/Argentina/San_Luis</p></li><li><p>America/Argentina/Tucuman</p></li><li><p>America/Argentina/Ushuaia</p></li><li><p>America/Aruba</p></li><li><p>America/Asuncion</p></li><li><p>America/Atikokan</p></li><li><p>America/Atka</p></li><li><p>America/Bahia</p></li><li><p>America/Bahia_Banderas</p></li><li><p>America/Barbados</p></li><li><p>America/Belem</p></li><li><p>America/Belize</p></li><li><p>America/Blanc-Sablon</p></li><li><p>America/Boa_Vista</p></li><li><p>America/Bogota</p></li><li><p>America/Boise</p></li><li><p>America/Buenos_Aires</p></li></ul></div></div></td><td><div><div><p>America (continued):</p></div><div><ul><li><p>America/Cambridge_Bay</p></li><li><p>America/Campo_Grande</p></li><li><p>America/Cancun</p></li><li><p>America/Caracas</p></li><li><p>America/Catamarca</p></li><li><p>America/Cayenne</p></li><li><p>America/Cayman</p></li><li><p>America/Chicago</p></li><li><p>America/Chihuahua</p></li><li><p>America/Coral_Harbour</p></li><li><p>America/Cordoba</p></li><li><p>America/Costa_Rica</p></li><li><p>America/Creston</p></li><li><p>America/Cuiaba</p></li><li><p>America/Curacao</p></li><li><p>America/Danmarkshavn</p></li><li><p>America/Dawson</p></li><li><p>America/Dawson_Creek</p></li><li><p>America/Denver</p></li><li><p>America/Detroit</p></li><li><p>America/Dominica</p></li><li><p>America/Edmonton</p></li><li><p>America/Eirunepe</p></li><li><p>America/El_Salvador</p></li><li><p>America/Ensenada</p></li><li><p>America/Fort_Nelson</p></li><li><p>America/Fort_Wayne</p></li><li><p>America/Fortaleza</p></li><li><p>America/Glace_Bay</p></li><li><p>America/Godthab</p></li><li><p>America/Goose_Bay</p></li><li><p>America/Grand_Turk</p></li><li><p>America/Grenada</p></li><li><p>America/Guadeloupe</p></li><li><p>America/Guatemala</p></li><li><p>America/Guayaquil</p></li><li><p>America/Guyana</p></li><li><p>America/Halifax</p></li><li><p>America/Havana</p></li><li><p>America/Hermosillo</p></li><li><p>America/Indiana/Indianapolis</p></li><li><p>America/Indiana/Knox</p></li><li><p>America/Indiana/Marengo</p></li><li><p>America/Indiana/Petersburg</p></li><li><p>America/Indiana/Tell_City</p></li><li><p>America/Indiana/Vevay</p></li><li><p>America/Indiana/Vincennes</p></li><li><p>America/Indiana/Winamac</p></li><li><p>America/Indianapolis</p></li><li><p>America/Inuvik</p></li><li><p>America/Iqaluit</p></li><li><p>America/Jamaica</p></li><li><p>America/Jujuy</p></li><li><p>America/Juneau</p></li><li><p>America/Kentucky/Louisville</p></li><li><p>America/Kentucky/Monticello</p></li><li><p>America/Knox_IN</p></li><li><p>America/Kralendijk</p></li><li><p>America/La_Paz</p></li><li><p>America/Lima</p></li><li><p>America/Los_Angeles</p></li><li><p>America/Louisville</p></li><li><p>America/Lower_Princes</p></li><li><p>America/Maceio</p></li><li><p>America/Managua</p></li><li><p>America/Manaus</p></li><li><p>America/Marigot</p></li><li><p>America/Martinique</p></li><li><p>America/Matamoros</p></li><li><p>America/Mazatlan</p></li><li><p>America/Mendoza</p></li><li><p>America/Menominee</p></li><li><p>America/Merida</p></li><li><p>America/Metlakatla</p></li><li><p>America/Mexico_City</p></li><li><p>America/Miquelon</p></li><li><p>America/Moncton</p></li><li><p>America/Monterrey</p></li><li><p>America/Montevideo</p></li><li><p>America/Montreal</p></li><li><p>America/Montserrat</p></li><li><p>America/Nassau</p></li><li><p>America/New_York</p></li><li><p>America/Nipigon</p></li><li><p>America/Nome</p></li><li><p>America/Noronha</p></li></ul></div></div></td><td><div><div><p>America (continued):</p></div><div><ul><li><p>America/North_Dakota/Beulah</p></li><li><p>America/North_Dakota/Center</p></li><li><p>America/North_Dakota/New_Salem</p></li><li><p>America/Ojinaga</p></li><li><p>America/Panama</p></li><li><p>America/Pangnirtung</p></li><li><p>America/Paramaribo</p></li><li><p>America/Phoenix</p></li><li><p>America/Port-au-Prince</p></li><li><p>America/Port_of_Spain</p></li><li><p>America/Porto_Acre</p></li><li><p>America/Porto_Velho</p></li><li><p>America/Puerto_Rico</p></li><li><p>America/Punta_Arenas</p></li><li><p>America/Rainy_River</p></li><li><p>America/Rankin_Inlet</p></li><li><p>America/Recife</p></li><li><p>America/Regina</p></li><li><p>America/Resolute</p></li><li><p>America/Rio_Branco</p></li><li><p>America/Rosario</p></li><li><p>America/Santa_Isabel</p></li><li><p>America/Santarem</p></li><li><p>America/Santiago</p></li><li><p>America/Santo_Domingo</p></li><li><p>America/Sao_Paulo</p></li><li><p>America/Scoresbysund</p></li><li><p>America/Shiprock</p></li><li><p>America/Sitka</p></li><li><p>America/St_Barthelemy</p></li><li><p>America/St_Johns</p></li><li><p>America/St_Kitts</p></li><li><p>America/St_Lucia</p></li><li><p>America/St_Thomas</p></li><li><p>America/St_Vincent</p></li><li><p>America/Swift_Current</p></li><li><p>America/Tegucigalpa</p></li><li><p>America/Thule</p></li><li><p>America/Thunder_Bay</p></li><li><p>America/Tijuana</p></li><li><p>America/Toronto</p></li><li><p>America/Tortola</p></li><li><p>America/Vancouver</p></li><li><p>America/Virgin</p></li><li><p>America/Whitehorse</p></li><li><p>America/Winnipeg</p></li><li><p>America/Yakutat</p></li><li><p>America/Yellowknife</p></li></ul></div><div><p>Antarctica:</p></div><div><ul><li><p>Antarctica/Casey</p></li><li><p>Antarctica/Davis</p></li><li><p>Antarctica/DumontDUrville</p></li><li><p>Antarctica/Macquarie</p></li><li><p>Antarctica/Mawson</p></li><li><p>Antarctica/McMurdo</p></li><li><p>Antarctica/Palmer</p></li><li><p>Antarctica/Rothera</p></li><li><p>Antarctica/South_Pole</p></li><li><p>Antarctica/Syowa</p></li><li><p>Antarctica/Troll</p></li><li><p>Antarctica/Vostok</p></li><li><p>Arctic/Longyearbyen</p></li></ul></div><div><p>Asia:</p></div><div><ul><li><p>Asia/Aden</p></li><li><p>Asia/Almaty</p></li><li><p>Asia/Amman</p></li><li><p>Asia/Anadyr</p></li><li><p>Asia/Aqtau</p></li><li><p>Asia/Aqtobe</p></li><li><p>Asia/Ashgabat</p></li><li><p>Asia/Ashkhabad</p></li><li><p>Asia/Atyrau</p></li><li><p>Asia/Baghdad</p></li><li><p>Asia/Bahrain</p></li><li><p>Asia/Baku</p></li><li><p>Asia/Bangkok</p></li><li><p>Asia/Barnaul</p></li><li><p>Asia/Beirut</p></li><li><p>Asia/Bishkek</p></li><li><p>Asia/Brunei</p></li><li><p>Asia/Calcutta</p></li><li><p>Asia/Chita</p></li><li><p>Asia/Choibalsan</p></li><li><p>Asia/Chongqing</p></li><li><p>Asia/Chungking</p></li><li><p>Asia/Colombo</p></li></ul></div></div></td><td><div><div><p>Asia (continued):</p></div><div><ul><li><p>Asia/Dacca</p></li><li><p>Asia/Damascus</p></li><li><p>Asia/Dhaka</p></li><li><p>Asia/Dili</p></li><li><p>Asia/Dubai</p></li><li><p>Asia/Dushanbe</p></li><li><p>Asia/Famagusta</p></li><li><p>Asia/Gaza</p></li><li><p>Asia/Harbin</p></li><li><p>Asia/Hebron</p></li><li><p>Asia/Ho_Chi_Minh</p></li><li><p>Asia/Hong_Kong</p></li><li><p>Asia/Hovd</p></li><li><p>Asia/Irkutsk</p></li><li><p>Asia/Istanbul</p></li><li><p>Asia/Jakarta</p></li><li><p>Asia/Jayapura</p></li><li><p>Asia/Jerusalem</p></li><li><p>Asia/Kabul</p></li><li><p>Asia/Kamchatka</p></li><li><p>Asia/Karachi</p></li><li><p>Asia/Kashgar</p></li><li><p>Asia/Kathmandu</p></li><li><p>Asia/Katmandu</p></li><li><p>Asia/Khandyga</p></li><li><p>Asia/Kolkata</p></li><li><p>Asia/Krasnoyarsk</p></li><li><p>Asia/Kuala_Lumpur</p></li><li><p>Asia/Kuching</p></li><li><p>Asia/Kuwait</p></li><li><p>Asia/Macao</p></li><li><p>Asia/Macau</p></li><li><p>Asia/Magadan</p></li><li><p>Asia/Makassar</p></li><li><p>Asia/Manila</p></li><li><p>Asia/Muscat</p></li><li><p>Asia/Nicosia</p></li><li><p>Asia/Novokuznetsk</p></li><li><p>Asia/Novosibirsk</p></li><li><p>Asia/Omsk</p></li><li><p>Asia/Oral</p></li><li><p>Asia/Phnom_Penh</p></li><li><p>Asia/Pontianak</p></li><li><p>Asia/Pyongyang</p></li><li><p>Asia/Qatar</p></li><li><p>Asia/Qostanay</p></li><li><p>Asia/Qyzylorda</p></li><li><p>Asia/Rangoon</p></li><li><p>Asia/Riyadh</p></li><li><p>Asia/Saigon</p></li><li><p>Asia/Sakhalin</p></li><li><p>Asia/Samarkand</p></li><li><p>Asia/Seoul</p></li><li><p>Asia/Shanghai</p></li><li><p>Asia/Singapore</p></li><li><p>Asia/Srednekolymsk</p></li><li><p>Asia/Taipei</p></li><li><p>Asia/Tashkent</p></li><li><p>Asia/Tbilisi</p></li><li><p>Asia/Tehran</p></li><li><p>Asia/Tel_Aviv</p></li><li><p>Asia/Thimbu</p></li><li><p>Asia/Thimphu</p></li><li><p>Asia/Tokyo</p></li><li><p>Asia/Tomsk</p></li><li><p>Asia/Ujung_Pandang</p></li><li><p>Asia/Ulaanbaatar</p></li><li><p>Asia/Ulan_Bator</p></li><li><p>Asia/Urumqi</p></li><li><p>Asia/Ust-Nera</p></li><li><p>Asia/Vientiane</p></li><li><p>Asia/Vladivostok</p></li><li><p>Asia/Yakutsk</p></li><li><p>Asia/Yangon</p></li><li><p>Asia/Yekaterinburg</p></li><li><p>Asia/Yerevan</p></li></ul></div><div><p>Atlantic:</p></div><div><ul><li><p>Atlantic/Azores</p></li><li><p>Atlantic/Bermuda</p></li><li><p>Atlantic/Canary</p></li><li><p>Atlantic/Cape_Verde</p></li><li><p>Atlantic/Faeroe</p></li><li><p>Atlantic/Faroe</p></li><li><p>Atlantic/Jan_Mayen</p></li><li><p>Atlantic/Madeira</p></li><li><p>Atlantic/Reykjavik</p></li><li><p>Atlantic/South_Georgia</p></li><li><p>Atlantic/St_Helena</p></li><li><p>Atlantic/Stanley</p></li></ul></div></div></td><td><div><div><p>Australia:</p></div><div><ul><li><p>Australia/ACT</p></li><li><p>Australia/Adelaide</p></li><li><p>Australia/Brisbane</p></li><li><p>Australia/Broken_Hill</p></li><li><p>Australia/Canberra</p></li><li><p>Australia/Currie</p></li><li><p>Australia/Darwin</p></li><li><p>Australia/Eucla</p></li><li><p>Australia/Hobart</p></li><li><p>Australia/LHI</p></li><li><p>Australia/Lindeman</p></li><li><p>Australia/Lord_Howe</p></li><li><p>Australia/Melbourne</p></li><li><p>Australia/NSW</p></li><li><p>Australia/North</p></li><li><p>Australia/Perth</p></li><li><p>Australia/Queensland</p></li><li><p>Australia/South</p></li><li><p>Australia/Sydney</p></li><li><p>Australia/Tasmania</p></li><li><p>Australia/Victoria</p></li><li><p>Australia/West</p></li><li><p>Australia/Yancowinna</p></li></ul></div><div><p>B:</p></div><div><ul><li><p>Brazil/Acre</p></li><li><p>Brazil/DeNoronha</p></li><li><p>Brazil/East</p></li><li><p>Brazil/West</p></li></ul></div><div><p>C:</p></div><div><ul><li><p>CET</p></li><li><p>CST6CDT</p></li><li><p>Canada/Atlantic</p></li><li><p>Canada/Central</p></li><li><p>Canada/Eastern</p></li><li><p>Canada/Mountain</p></li><li><p>Canada/Newfoundland</p></li><li><p>Canada/Pacific</p></li><li><p>Canada/Saskatchewan</p></li><li><p>Canada/Yukon</p></li><li><p>Chile/Continental</p></li><li><p>Chile/EasterIsland</p></li><li><p>Cuba</p></li></ul></div><div><p>E:</p></div><div><ul><li><p>EET</p></li><li><p>EST5EDT</p></li><li><p>Egypt</p></li><li><p>Eire</p></li><li><p>Etc/GMT</p></li><li><p>Etc/GMT+0</p></li><li><p>Etc/GMT+1</p></li><li><p>Etc/GMT+10</p></li><li><p>Etc/GMT+11</p></li><li><p>Etc/GMT+12</p></li><li><p>Etc/GMT+2</p></li><li><p>Etc/GMT+3</p></li><li><p>Etc/GMT+4</p></li><li><p>Etc/GMT+5</p></li><li><p>Etc/GMT+6</p></li><li><p>Etc/GMT+7</p></li><li><p>Etc/GMT+8</p></li><li><p>Etc/GMT+9</p></li><li><p>Etc/GMT-0</p></li><li><p>Etc/GMT-1</p></li><li><p>Etc/GMT-10</p></li><li><p>Etc/GMT-11</p></li><li><p>Etc/GMT-12</p></li><li><p>Etc/GMT-13</p></li><li><p>Etc/GMT-14</p></li><li><p>Etc/GMT-2</p></li><li><p>Etc/GMT-3</p></li><li><p>Etc/GMT-4</p></li><li><p>Etc/GMT-5</p></li><li><p>Etc/GMT-6</p></li><li><p>Etc/GMT-7</p></li><li><p>Etc/GMT-8</p></li><li><p>Etc/GMT-9</p></li><li><p>Etc/GMT0</p></li><li><p>Etc/Greenwich</p></li><li><p>Etc/UCT</p></li><li><p>Etc/UTC</p></li><li><p>Etc/Universal</p></li><li><p>Etc/Zulu</p></li></ul></div></div></td><td><div><div><p>E (continued):</p></div><div><ul><li><p>Europe/Amsterdam</p></li><li><p>Europe/Andorra</p></li><li><p>Europe/Astrakhan</p></li><li><p>Europe/Athens</p></li><li><p>Europe/Belfast</p></li><li><p>Europe/Belgrade</p></li><li><p>Europe/Berlin</p></li><li><p>Europe/Bratislava</p></li><li><p>Europe/Brussels</p></li><li><p>Europe/Bucharest</p></li><li><p>Europe/Budapest</p></li><li><p>Europe/Busingen</p></li><li><p>Europe/Chisinau</p></li><li><p>Europe/Copenhagen</p></li><li><p>Europe/Dublin</p></li><li><p>Europe/Gibraltar</p></li><li><p>Europe/Guernsey</p></li><li><p>Europe/Helsinki</p></li><li><p>Europe/Isle_of_Man</p></li><li><p>Europe/Istanbul</p></li><li><p>Europe/Jersey</p></li><li><p>Europe/Kaliningrad</p></li><li><p>Europe/Kiev</p></li><li><p>Europe/Kirov</p></li><li><p>Europe/Lisbon</p></li><li><p>Europe/Ljubljana</p></li><li><p>Europe/London</p></li><li><p>Europe/Luxembourg</p></li><li><p>Europe/Madrid</p></li><li><p>Europe/Malta</p></li><li><p>Europe/Mariehamn</p></li><li><p>Europe/Minsk</p></li><li><p>Europe/Monaco</p></li><li><p>Europe/Moscow</p></li><li><p>Europe/Nicosia</p></li><li><p>Europe/Oslo</p></li><li><p>Europe/Paris</p></li><li><p>Europe/Podgorica</p></li><li><p>Europe/Prague</p></li><li><p>Europe/Riga</p></li><li><p>Europe/Rome</p></li><li><p>Europe/Samara</p></li><li><p>Europe/San_Marino</p></li><li><p>Europe/Sarajevo</p></li><li><p>Europe/Saratov</p></li><li><p>Europe/Skopje</p></li><li><p>Europe/Sofia</p></li><li><p>Europe/Stockholm</p></li><li><p>Europe/Tallinn</p></li><li><p>Europe/Tirane</p></li><li><p>Europe/Tiraspol</p></li><li><p>Europe/Ulyanovsk</p></li><li><p>Europe/Uzhgorod</p></li><li><p>Europe/Vaduz</p></li><li><p>Europe/Vatican</p></li><li><p>Europe/Vienna</p></li><li><p>Europe/Vilnius</p></li><li><p>Europe/Volgograd</p></li><li><p>Europe/Warsaw</p></li><li><p>Europe/Zagreb</p></li><li><p>Europe/Zaporozhye</p></li><li><p>Europe/Zurich</p></li></ul></div><div><p>G:</p></div><div><ul><li><p>GB</p></li><li><p>GB-Eire</p></li><li><p>GMT</p></li><li><p>GMT0</p></li><li><p>Greenwich</p></li></ul></div><div><p>H:</p></div><div><ul><li><p>Hongkong</p></li></ul></div><div><p>I:</p></div><div><ul><li><p>Iceland</p></li><li><p>Indian/Antananarivo</p></li><li><p>Indian/Chagos</p></li><li><p>Indian/Christmas</p></li><li><p>Indian/Cocos</p></li><li><p>Indian/Comoro</p></li><li><p>Indian/Kerguelen</p></li><li><p>Indian/Mahe</p></li><li><p>Indian/Maldives</p></li><li><p>Indian/Mauritius</p></li><li><p>Indian/Mayotte</p></li><li><p>Indian/Reunion</p></li><li><p>Iran</p></li><li><p>Israel</p></li></ul></div></div></td><td><div><div><p>J:</p></div><div><ul><li><p>Jamaica</p></li><li><p>Japan</p></li></ul></div><div><p>K:</p></div><div><ul><li><p>Kwajalein</p></li></ul></div><div><p>L:</p></div><div><ul><li><p>Libya</p></li></ul></div><div><p>M:</p></div><div><ul><li><p>MET</p></li><li><p>MST7MDT</p></li><li><p>Mexico/BajaNorte</p></li><li><p>Mexico/BajaSur</p></li><li><p>Mexico/General</p></li></ul></div><div><p>N:</p></div><div><ul><li><p>NZ</p></li><li><p>NZ-CHAT</p></li><li><p>Navajo</p></li></ul></div><div><p>P:</p></div><div><ul><li><p>PRC</p></li><li><p>PST8PDT</p></li><li><p>Pacific/Apia</p></li><li><p>Pacific/Auckland</p></li><li><p>Pacific/Bougainville</p></li><li><p>Pacific/Chatham</p></li><li><p>Pacific/Chuuk</p></li><li><p>Pacific/Easter</p></li><li><p>Pacific/Efate</p></li><li><p>Pacific/Enderbury</p></li><li><p>Pacific/Fakaofo</p></li><li><p>Pacific/Fiji</p></li><li><p>Pacific/Funafuti</p></li><li><p>Pacific/Galapagos</p></li><li><p>Pacific/Gambier</p></li><li><p>Pacific/Guadalcanal</p></li><li><p>Pacific/Guam</p></li><li><p>Pacific/Honolulu</p></li><li><p>Pacific/Johnston</p></li><li><p>Pacific/Kiritimati</p></li><li><p>Pacific/Kosrae</p></li><li><p>Pacific/Kwajalein</p></li><li><p>Pacific/Majuro</p></li><li><p>Pacific/Marquesas</p></li><li><p>Pacific/Midway</p></li><li><p>Pacific/Nauru</p></li><li><p>Pacific/Niue</p></li><li><p>Pacific/Norfolk</p></li><li><p>Pacific/Noumea</p></li><li><p>Pacific/Pago_Pago</p></li><li><p>Pacific/Palau</p></li><li><p>Pacific/Pitcairn</p></li><li><p>Pacific/Pohnpei</p></li><li><p>Pacific/Ponape</p></li><li><p>Pacific/Port_Moresby</p></li><li><p>Pacific/Rarotonga</p></li><li><p>Pacific/Saipan</p></li><li><p>Pacific/Samoa</p></li><li><p>Pacific/Tahiti</p></li><li><p>Pacific/Tarawa</p></li><li><p>Pacific/Tongatapu</p></li><li><p>Pacific/Truk</p></li><li><p>Pacific/Wake</p></li><li><p>Pacific/Wallis</p></li><li><p>Pacific/Yap</p></li><li><p>Poland</p></li><li><p>Portugal</p></li></ul></div><div><p>R:</p></div><div><ul><li><p>ROK</p></li></ul></div><div><p>S:</p></div><div><ul><li><p>Singapore</p></li><li><p>SystemV/AST4</p></li><li><p>SystemV/AST4ADT</p></li><li><p>SystemV/CST6</p></li><li><p>SystemV/CST6CDT</p></li><li><p>SystemV/EST5</p></li><li><p>SystemV/EST5EDT</p></li><li><p>SystemV/HST10</p></li><li><p>SystemV/MST7</p></li><li><p>SystemV/MST7MDT</p></li><li><p>SystemV/PST8</p></li><li><p>SystemV/PST8PDT</p></li><li><p>SystemV/YST9</p></li><li><p>SystemV/YST9YDT</p></li></ul></div></div></td><td><div><div><p>T:</p></div><div><ul><li><p>Turkey</p></li></ul></div><div><p>U:</p></div><div><ul><li><p>UCT</p></li><li><p>US/Alaska</p></li><li><p>US/Aleutian</p></li><li><p>US/Arizona</p></li><li><p>US/Central</p></li><li><p>US/East-Indiana</p></li><li><p>US/Eastern</p></li><li><p>US/Hawaii</p></li><li><p>US/Indiana-Starke</p></li><li><p>US/Michigan</p></li><li><p>US/Mountain</p></li><li><p>US/Pacific</p></li><li><p>US/Pacific-New</p></li><li><p>US/Samoa</p></li><li><p>UTC</p></li><li><p>Universal</p></li></ul></div><div><p>W:</p></div><div><ul><li><p>W-SU</p></li><li><p>WET</p></li></ul></div><div><p>Z:</p></div><div><ul><li><p>Zulu</p></li></ul></div></div></td></tr></tbody></table>

## Related Examples

- [Format Dates and Times](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-format-dates)

- [Parse Dates with DataWeave](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-parse-dates)

- [Add and Subtract Time](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-add-and-subtract-time)

## See Also

- [Date and Time (dw::Core Types)](https://docs.mulesoft.com/dataweave/2.11/dataweave-types#dw_type_dates)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.11/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook)

<!-- document id=328628eedbdb069606d1b179e71addaffb7a392200437b47790ca0c1149fd1dc url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook-change-time-zone.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, date, time
---

# Change a Time Zone

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following example uses the `>>` operator and a [time zone ID](#timezone-ids) to change the time
zone. It also uses the formatting characters `uuuu-MM-dd'T'HH:mm:ss.SSS` to modify the format. The
`uuuu` characters represent the year.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
fun format(d: DateTime) = d as String {format: "yyyy-MM-dd'T'HH:mm:ss.SSS"}
---
{
    CreatedDateTime: format(|2019-02-13T13:23:00.120Z| >> "CET"),
}
```

Output JSON:

```JSON
{
    "CreatedDateTime": "2019-02-13T14:23:00.120"
}
```

## Time Zone IDs

In addition to accepting time zone values such as `-07:00`, DataWeave accepts Java 8 `TimeZone` ID
values, which are available through a Java method call to `ZoneId.getAvailableZoneIds()`.

To see all available values in the following table, scroll right.

<table><colgroup><col> <col> <col> <col> <col> <col> <col> <col></colgroup><thead><tr><th></th><th></th><th></th><th></th><th></th><th></th><th></th><th></th></tr></thead><tbody><tr><td><div><div><p>Africa:</p></div><div><ul><li><p>Africa/Abidjan</p></li><li><p>Africa/Accra</p></li><li><p>Africa/Addis_Ababa</p></li><li><p>Africa/Algiers</p></li><li><p>Africa/Asmara</p></li><li><p>Africa/Asmera</p></li><li><p>Africa/Bamako</p></li><li><p>Africa/Bangui</p></li><li><p>Africa/Banjul</p></li><li><p>Africa/Bissau</p></li><li><p>Africa/Blantyre</p></li><li><p>Africa/Brazzaville</p></li><li><p>Africa/Bujumbura</p></li><li><p>Africa/Cairo</p></li><li><p>Africa/Casablanca</p></li><li><p>Africa/Ceuta</p></li><li><p>Africa/Conakry</p></li><li><p>Africa/Dakar</p></li><li><p>Africa/Dar_es_Salaam</p></li><li><p>Africa/Djibouti</p></li><li><p>Africa/Douala</p></li><li><p>Africa/El_Aaiun</p></li><li><p>Africa/Freetown</p></li><li><p>Africa/Gaborone</p></li><li><p>Africa/Harare</p></li><li><p>Africa/Johannesburg</p></li><li><p>Africa/Juba</p></li><li><p>Africa/Kampala</p></li><li><p>Africa/Khartoum</p></li><li><p>Africa/Kigali</p></li><li><p>Africa/Kinshasa</p></li><li><p>Africa/Lagos</p></li><li><p>Africa/Libreville</p></li><li><p>Africa/Lome</p></li><li><p>Africa/Luanda</p></li><li><p>Africa/Lubumbashi</p></li><li><p>Africa/Lusaka</p></li><li><p>Africa/Malabo</p></li><li><p>Africa/Maputo</p></li><li><p>Africa/Maseru</p></li><li><p>Africa/Mbabane</p></li><li><p>Africa/Mogadishu</p></li><li><p>Africa/Monrovia</p></li><li><p>Africa/Nairobi</p></li><li><p>Africa/Ndjamena</p></li><li><p>Africa/Niamey</p></li><li><p>Africa/Nouakchott</p></li><li><p>Africa/Ouagadougou</p></li><li><p>Africa/Porto-Novo</p></li><li><p>Africa/Sao_Tome</p></li><li><p>Africa/Timbuktu</p></li><li><p>Africa/Tripoli</p></li><li><p>Africa/Tunis</p></li><li><p>Africa/Windhoek</p></li></ul></div><div><p>America:</p></div><div><ul><li><p>America/Adak</p></li><li><p>America/Anchorage</p></li><li><p>America/Anguilla</p></li><li><p>America/Antigua</p></li><li><p>America/Araguaina</p></li><li><p>America/Argentina/Buenos_Aires</p></li><li><p>America/Argentina/Catamarca</p></li><li><p>America/Argentina/ComodRivadavia</p></li><li><p>America/Argentina/Cordoba</p></li><li><p>America/Argentina/Jujuy</p></li><li><p>America/Argentina/La_Rioja</p></li><li><p>America/Argentina/Mendoza</p></li><li><p>America/Argentina/Rio_Gallegos</p></li><li><p>America/Argentina/Salta</p></li><li><p>America/Argentina/San_Juan</p></li><li><p>America/Argentina/San_Luis</p></li><li><p>America/Argentina/Tucuman</p></li><li><p>America/Argentina/Ushuaia</p></li><li><p>America/Aruba</p></li><li><p>America/Asuncion</p></li><li><p>America/Atikokan</p></li><li><p>America/Atka</p></li><li><p>America/Bahia</p></li><li><p>America/Bahia_Banderas</p></li><li><p>America/Barbados</p></li><li><p>America/Belem</p></li><li><p>America/Belize</p></li><li><p>America/Blanc-Sablon</p></li><li><p>America/Boa_Vista</p></li><li><p>America/Bogota</p></li><li><p>America/Boise</p></li><li><p>America/Buenos_Aires</p></li></ul></div></div></td><td><div><div><p>America (continued):</p></div><div><ul><li><p>America/Cambridge_Bay</p></li><li><p>America/Campo_Grande</p></li><li><p>America/Cancun</p></li><li><p>America/Caracas</p></li><li><p>America/Catamarca</p></li><li><p>America/Cayenne</p></li><li><p>America/Cayman</p></li><li><p>America/Chicago</p></li><li><p>America/Chihuahua</p></li><li><p>America/Coral_Harbour</p></li><li><p>America/Cordoba</p></li><li><p>America/Costa_Rica</p></li><li><p>America/Creston</p></li><li><p>America/Cuiaba</p></li><li><p>America/Curacao</p></li><li><p>America/Danmarkshavn</p></li><li><p>America/Dawson</p></li><li><p>America/Dawson_Creek</p></li><li><p>America/Denver</p></li><li><p>America/Detroit</p></li><li><p>America/Dominica</p></li><li><p>America/Edmonton</p></li><li><p>America/Eirunepe</p></li><li><p>America/El_Salvador</p></li><li><p>America/Ensenada</p></li><li><p>America/Fort_Nelson</p></li><li><p>America/Fort_Wayne</p></li><li><p>America/Fortaleza</p></li><li><p>America/Glace_Bay</p></li><li><p>America/Godthab</p></li><li><p>America/Goose_Bay</p></li><li><p>America/Grand_Turk</p></li><li><p>America/Grenada</p></li><li><p>America/Guadeloupe</p></li><li><p>America/Guatemala</p></li><li><p>America/Guayaquil</p></li><li><p>America/Guyana</p></li><li><p>America/Halifax</p></li><li><p>America/Havana</p></li><li><p>America/Hermosillo</p></li><li><p>America/Indiana/Indianapolis</p></li><li><p>America/Indiana/Knox</p></li><li><p>America/Indiana/Marengo</p></li><li><p>America/Indiana/Petersburg</p></li><li><p>America/Indiana/Tell_City</p></li><li><p>America/Indiana/Vevay</p></li><li><p>America/Indiana/Vincennes</p></li><li><p>America/Indiana/Winamac</p></li><li><p>America/Indianapolis</p></li><li><p>America/Inuvik</p></li><li><p>America/Iqaluit</p></li><li><p>America/Jamaica</p></li><li><p>America/Jujuy</p></li><li><p>America/Juneau</p></li><li><p>America/Kentucky/Louisville</p></li><li><p>America/Kentucky/Monticello</p></li><li><p>America/Knox_IN</p></li><li><p>America/Kralendijk</p></li><li><p>America/La_Paz</p></li><li><p>America/Lima</p></li><li><p>America/Los_Angeles</p></li><li><p>America/Louisville</p></li><li><p>America/Lower_Princes</p></li><li><p>America/Maceio</p></li><li><p>America/Managua</p></li><li><p>America/Manaus</p></li><li><p>America/Marigot</p></li><li><p>America/Martinique</p></li><li><p>America/Matamoros</p></li><li><p>America/Mazatlan</p></li><li><p>America/Mendoza</p></li><li><p>America/Menominee</p></li><li><p>America/Merida</p></li><li><p>America/Metlakatla</p></li><li><p>America/Mexico_City</p></li><li><p>America/Miquelon</p></li><li><p>America/Moncton</p></li><li><p>America/Monterrey</p></li><li><p>America/Montevideo</p></li><li><p>America/Montreal</p></li><li><p>America/Montserrat</p></li><li><p>America/Nassau</p></li><li><p>America/New_York</p></li><li><p>America/Nipigon</p></li><li><p>America/Nome</p></li><li><p>America/Noronha</p></li></ul></div></div></td><td><div><div><p>America (continued):</p></div><div><ul><li><p>America/North_Dakota/Beulah</p></li><li><p>America/North_Dakota/Center</p></li><li><p>America/North_Dakota/New_Salem</p></li><li><p>America/Ojinaga</p></li><li><p>America/Panama</p></li><li><p>America/Pangnirtung</p></li><li><p>America/Paramaribo</p></li><li><p>America/Phoenix</p></li><li><p>America/Port-au-Prince</p></li><li><p>America/Port_of_Spain</p></li><li><p>America/Porto_Acre</p></li><li><p>America/Porto_Velho</p></li><li><p>America/Puerto_Rico</p></li><li><p>America/Punta_Arenas</p></li><li><p>America/Rainy_River</p></li><li><p>America/Rankin_Inlet</p></li><li><p>America/Recife</p></li><li><p>America/Regina</p></li><li><p>America/Resolute</p></li><li><p>America/Rio_Branco</p></li><li><p>America/Rosario</p></li><li><p>America/Santa_Isabel</p></li><li><p>America/Santarem</p></li><li><p>America/Santiago</p></li><li><p>America/Santo_Domingo</p></li><li><p>America/Sao_Paulo</p></li><li><p>America/Scoresbysund</p></li><li><p>America/Shiprock</p></li><li><p>America/Sitka</p></li><li><p>America/St_Barthelemy</p></li><li><p>America/St_Johns</p></li><li><p>America/St_Kitts</p></li><li><p>America/St_Lucia</p></li><li><p>America/St_Thomas</p></li><li><p>America/St_Vincent</p></li><li><p>America/Swift_Current</p></li><li><p>America/Tegucigalpa</p></li><li><p>America/Thule</p></li><li><p>America/Thunder_Bay</p></li><li><p>America/Tijuana</p></li><li><p>America/Toronto</p></li><li><p>America/Tortola</p></li><li><p>America/Vancouver</p></li><li><p>America/Virgin</p></li><li><p>America/Whitehorse</p></li><li><p>America/Winnipeg</p></li><li><p>America/Yakutat</p></li><li><p>America/Yellowknife</p></li></ul></div><div><p>Antarctica:</p></div><div><ul><li><p>Antarctica/Casey</p></li><li><p>Antarctica/Davis</p></li><li><p>Antarctica/DumontDUrville</p></li><li><p>Antarctica/Macquarie</p></li><li><p>Antarctica/Mawson</p></li><li><p>Antarctica/McMurdo</p></li><li><p>Antarctica/Palmer</p></li><li><p>Antarctica/Rothera</p></li><li><p>Antarctica/South_Pole</p></li><li><p>Antarctica/Syowa</p></li><li><p>Antarctica/Troll</p></li><li><p>Antarctica/Vostok</p></li><li><p>Arctic/Longyearbyen</p></li></ul></div><div><p>Asia:</p></div><div><ul><li><p>Asia/Aden</p></li><li><p>Asia/Almaty</p></li><li><p>Asia/Amman</p></li><li><p>Asia/Anadyr</p></li><li><p>Asia/Aqtau</p></li><li><p>Asia/Aqtobe</p></li><li><p>Asia/Ashgabat</p></li><li><p>Asia/Ashkhabad</p></li><li><p>Asia/Atyrau</p></li><li><p>Asia/Baghdad</p></li><li><p>Asia/Bahrain</p></li><li><p>Asia/Baku</p></li><li><p>Asia/Bangkok</p></li><li><p>Asia/Barnaul</p></li><li><p>Asia/Beirut</p></li><li><p>Asia/Bishkek</p></li><li><p>Asia/Brunei</p></li><li><p>Asia/Calcutta</p></li><li><p>Asia/Chita</p></li><li><p>Asia/Choibalsan</p></li><li><p>Asia/Chongqing</p></li><li><p>Asia/Chungking</p></li><li><p>Asia/Colombo</p></li></ul></div></div></td><td><div><div><p>Asia (continued):</p></div><div><ul><li><p>Asia/Dacca</p></li><li><p>Asia/Damascus</p></li><li><p>Asia/Dhaka</p></li><li><p>Asia/Dili</p></li><li><p>Asia/Dubai</p></li><li><p>Asia/Dushanbe</p></li><li><p>Asia/Famagusta</p></li><li><p>Asia/Gaza</p></li><li><p>Asia/Harbin</p></li><li><p>Asia/Hebron</p></li><li><p>Asia/Ho_Chi_Minh</p></li><li><p>Asia/Hong_Kong</p></li><li><p>Asia/Hovd</p></li><li><p>Asia/Irkutsk</p></li><li><p>Asia/Istanbul</p></li><li><p>Asia/Jakarta</p></li><li><p>Asia/Jayapura</p></li><li><p>Asia/Jerusalem</p></li><li><p>Asia/Kabul</p></li><li><p>Asia/Kamchatka</p></li><li><p>Asia/Karachi</p></li><li><p>Asia/Kashgar</p></li><li><p>Asia/Kathmandu</p></li><li><p>Asia/Katmandu</p></li><li><p>Asia/Khandyga</p></li><li><p>Asia/Kolkata</p></li><li><p>Asia/Krasnoyarsk</p></li><li><p>Asia/Kuala_Lumpur</p></li><li><p>Asia/Kuching</p></li><li><p>Asia/Kuwait</p></li><li><p>Asia/Macao</p></li><li><p>Asia/Macau</p></li><li><p>Asia/Magadan</p></li><li><p>Asia/Makassar</p></li><li><p>Asia/Manila</p></li><li><p>Asia/Muscat</p></li><li><p>Asia/Nicosia</p></li><li><p>Asia/Novokuznetsk</p></li><li><p>Asia/Novosibirsk</p></li><li><p>Asia/Omsk</p></li><li><p>Asia/Oral</p></li><li><p>Asia/Phnom_Penh</p></li><li><p>Asia/Pontianak</p></li><li><p>Asia/Pyongyang</p></li><li><p>Asia/Qatar</p></li><li><p>Asia/Qostanay</p></li><li><p>Asia/Qyzylorda</p></li><li><p>Asia/Rangoon</p></li><li><p>Asia/Riyadh</p></li><li><p>Asia/Saigon</p></li><li><p>Asia/Sakhalin</p></li><li><p>Asia/Samarkand</p></li><li><p>Asia/Seoul</p></li><li><p>Asia/Shanghai</p></li><li><p>Asia/Singapore</p></li><li><p>Asia/Srednekolymsk</p></li><li><p>Asia/Taipei</p></li><li><p>Asia/Tashkent</p></li><li><p>Asia/Tbilisi</p></li><li><p>Asia/Tehran</p></li><li><p>Asia/Tel_Aviv</p></li><li><p>Asia/Thimbu</p></li><li><p>Asia/Thimphu</p></li><li><p>Asia/Tokyo</p></li><li><p>Asia/Tomsk</p></li><li><p>Asia/Ujung_Pandang</p></li><li><p>Asia/Ulaanbaatar</p></li><li><p>Asia/Ulan_Bator</p></li><li><p>Asia/Urumqi</p></li><li><p>Asia/Ust-Nera</p></li><li><p>Asia/Vientiane</p></li><li><p>Asia/Vladivostok</p></li><li><p>Asia/Yakutsk</p></li><li><p>Asia/Yangon</p></li><li><p>Asia/Yekaterinburg</p></li><li><p>Asia/Yerevan</p></li></ul></div><div><p>Atlantic:</p></div><div><ul><li><p>Atlantic/Azores</p></li><li><p>Atlantic/Bermuda</p></li><li><p>Atlantic/Canary</p></li><li><p>Atlantic/Cape_Verde</p></li><li><p>Atlantic/Faeroe</p></li><li><p>Atlantic/Faroe</p></li><li><p>Atlantic/Jan_Mayen</p></li><li><p>Atlantic/Madeira</p></li><li><p>Atlantic/Reykjavik</p></li><li><p>Atlantic/South_Georgia</p></li><li><p>Atlantic/St_Helena</p></li><li><p>Atlantic/Stanley</p></li></ul></div></div></td><td><div><div><p>Australia:</p></div><div><ul><li><p>Australia/ACT</p></li><li><p>Australia/Adelaide</p></li><li><p>Australia/Brisbane</p></li><li><p>Australia/Broken_Hill</p></li><li><p>Australia/Canberra</p></li><li><p>Australia/Currie</p></li><li><p>Australia/Darwin</p></li><li><p>Australia/Eucla</p></li><li><p>Australia/Hobart</p></li><li><p>Australia/LHI</p></li><li><p>Australia/Lindeman</p></li><li><p>Australia/Lord_Howe</p></li><li><p>Australia/Melbourne</p></li><li><p>Australia/NSW</p></li><li><p>Australia/North</p></li><li><p>Australia/Perth</p></li><li><p>Australia/Queensland</p></li><li><p>Australia/South</p></li><li><p>Australia/Sydney</p></li><li><p>Australia/Tasmania</p></li><li><p>Australia/Victoria</p></li><li><p>Australia/West</p></li><li><p>Australia/Yancowinna</p></li></ul></div><div><p>B:</p></div><div><ul><li><p>Brazil/Acre</p></li><li><p>Brazil/DeNoronha</p></li><li><p>Brazil/East</p></li><li><p>Brazil/West</p></li></ul></div><div><p>C:</p></div><div><ul><li><p>CET</p></li><li><p>CST6CDT</p></li><li><p>Canada/Atlantic</p></li><li><p>Canada/Central</p></li><li><p>Canada/Eastern</p></li><li><p>Canada/Mountain</p></li><li><p>Canada/Newfoundland</p></li><li><p>Canada/Pacific</p></li><li><p>Canada/Saskatchewan</p></li><li><p>Canada/Yukon</p></li><li><p>Chile/Continental</p></li><li><p>Chile/EasterIsland</p></li><li><p>Cuba</p></li></ul></div><div><p>E:</p></div><div><ul><li><p>EET</p></li><li><p>EST5EDT</p></li><li><p>Egypt</p></li><li><p>Eire</p></li><li><p>Etc/GMT</p></li><li><p>Etc/GMT+0</p></li><li><p>Etc/GMT+1</p></li><li><p>Etc/GMT+10</p></li><li><p>Etc/GMT+11</p></li><li><p>Etc/GMT+12</p></li><li><p>Etc/GMT+2</p></li><li><p>Etc/GMT+3</p></li><li><p>Etc/GMT+4</p></li><li><p>Etc/GMT+5</p></li><li><p>Etc/GMT+6</p></li><li><p>Etc/GMT+7</p></li><li><p>Etc/GMT+8</p></li><li><p>Etc/GMT+9</p></li><li><p>Etc/GMT-0</p></li><li><p>Etc/GMT-1</p></li><li><p>Etc/GMT-10</p></li><li><p>Etc/GMT-11</p></li><li><p>Etc/GMT-12</p></li><li><p>Etc/GMT-13</p></li><li><p>Etc/GMT-14</p></li><li><p>Etc/GMT-2</p></li><li><p>Etc/GMT-3</p></li><li><p>Etc/GMT-4</p></li><li><p>Etc/GMT-5</p></li><li><p>Etc/GMT-6</p></li><li><p>Etc/GMT-7</p></li><li><p>Etc/GMT-8</p></li><li><p>Etc/GMT-9</p></li><li><p>Etc/GMT0</p></li><li><p>Etc/Greenwich</p></li><li><p>Etc/UCT</p></li><li><p>Etc/UTC</p></li><li><p>Etc/Universal</p></li><li><p>Etc/Zulu</p></li></ul></div></div></td><td><div><div><p>E (continued):</p></div><div><ul><li><p>Europe/Amsterdam</p></li><li><p>Europe/Andorra</p></li><li><p>Europe/Astrakhan</p></li><li><p>Europe/Athens</p></li><li><p>Europe/Belfast</p></li><li><p>Europe/Belgrade</p></li><li><p>Europe/Berlin</p></li><li><p>Europe/Bratislava</p></li><li><p>Europe/Brussels</p></li><li><p>Europe/Bucharest</p></li><li><p>Europe/Budapest</p></li><li><p>Europe/Busingen</p></li><li><p>Europe/Chisinau</p></li><li><p>Europe/Copenhagen</p></li><li><p>Europe/Dublin</p></li><li><p>Europe/Gibraltar</p></li><li><p>Europe/Guernsey</p></li><li><p>Europe/Helsinki</p></li><li><p>Europe/Isle_of_Man</p></li><li><p>Europe/Istanbul</p></li><li><p>Europe/Jersey</p></li><li><p>Europe/Kaliningrad</p></li><li><p>Europe/Kiev</p></li><li><p>Europe/Kirov</p></li><li><p>Europe/Lisbon</p></li><li><p>Europe/Ljubljana</p></li><li><p>Europe/London</p></li><li><p>Europe/Luxembourg</p></li><li><p>Europe/Madrid</p></li><li><p>Europe/Malta</p></li><li><p>Europe/Mariehamn</p></li><li><p>Europe/Minsk</p></li><li><p>Europe/Monaco</p></li><li><p>Europe/Moscow</p></li><li><p>Europe/Nicosia</p></li><li><p>Europe/Oslo</p></li><li><p>Europe/Paris</p></li><li><p>Europe/Podgorica</p></li><li><p>Europe/Prague</p></li><li><p>Europe/Riga</p></li><li><p>Europe/Rome</p></li><li><p>Europe/Samara</p></li><li><p>Europe/San_Marino</p></li><li><p>Europe/Sarajevo</p></li><li><p>Europe/Saratov</p></li><li><p>Europe/Skopje</p></li><li><p>Europe/Sofia</p></li><li><p>Europe/Stockholm</p></li><li><p>Europe/Tallinn</p></li><li><p>Europe/Tirane</p></li><li><p>Europe/Tiraspol</p></li><li><p>Europe/Ulyanovsk</p></li><li><p>Europe/Uzhgorod</p></li><li><p>Europe/Vaduz</p></li><li><p>Europe/Vatican</p></li><li><p>Europe/Vienna</p></li><li><p>Europe/Vilnius</p></li><li><p>Europe/Volgograd</p></li><li><p>Europe/Warsaw</p></li><li><p>Europe/Zagreb</p></li><li><p>Europe/Zaporozhye</p></li><li><p>Europe/Zurich</p></li></ul></div><div><p>G:</p></div><div><ul><li><p>GB</p></li><li><p>GB-Eire</p></li><li><p>GMT</p></li><li><p>GMT0</p></li><li><p>Greenwich</p></li></ul></div><div><p>H:</p></div><div><ul><li><p>Hongkong</p></li></ul></div><div><p>I:</p></div><div><ul><li><p>Iceland</p></li><li><p>Indian/Antananarivo</p></li><li><p>Indian/Chagos</p></li><li><p>Indian/Christmas</p></li><li><p>Indian/Cocos</p></li><li><p>Indian/Comoro</p></li><li><p>Indian/Kerguelen</p></li><li><p>Indian/Mahe</p></li><li><p>Indian/Maldives</p></li><li><p>Indian/Mauritius</p></li><li><p>Indian/Mayotte</p></li><li><p>Indian/Reunion</p></li><li><p>Iran</p></li><li><p>Israel</p></li></ul></div></div></td><td><div><div><p>J:</p></div><div><ul><li><p>Jamaica</p></li><li><p>Japan</p></li></ul></div><div><p>K:</p></div><div><ul><li><p>Kwajalein</p></li></ul></div><div><p>L:</p></div><div><ul><li><p>Libya</p></li></ul></div><div><p>M:</p></div><div><ul><li><p>MET</p></li><li><p>MST7MDT</p></li><li><p>Mexico/BajaNorte</p></li><li><p>Mexico/BajaSur</p></li><li><p>Mexico/General</p></li></ul></div><div><p>N:</p></div><div><ul><li><p>NZ</p></li><li><p>NZ-CHAT</p></li><li><p>Navajo</p></li></ul></div><div><p>P:</p></div><div><ul><li><p>PRC</p></li><li><p>PST8PDT</p></li><li><p>Pacific/Apia</p></li><li><p>Pacific/Auckland</p></li><li><p>Pacific/Bougainville</p></li><li><p>Pacific/Chatham</p></li><li><p>Pacific/Chuuk</p></li><li><p>Pacific/Easter</p></li><li><p>Pacific/Efate</p></li><li><p>Pacific/Enderbury</p></li><li><p>Pacific/Fakaofo</p></li><li><p>Pacific/Fiji</p></li><li><p>Pacific/Funafuti</p></li><li><p>Pacific/Galapagos</p></li><li><p>Pacific/Gambier</p></li><li><p>Pacific/Guadalcanal</p></li><li><p>Pacific/Guam</p></li><li><p>Pacific/Honolulu</p></li><li><p>Pacific/Johnston</p></li><li><p>Pacific/Kiritimati</p></li><li><p>Pacific/Kosrae</p></li><li><p>Pacific/Kwajalein</p></li><li><p>Pacific/Majuro</p></li><li><p>Pacific/Marquesas</p></li><li><p>Pacific/Midway</p></li><li><p>Pacific/Nauru</p></li><li><p>Pacific/Niue</p></li><li><p>Pacific/Norfolk</p></li><li><p>Pacific/Noumea</p></li><li><p>Pacific/Pago_Pago</p></li><li><p>Pacific/Palau</p></li><li><p>Pacific/Pitcairn</p></li><li><p>Pacific/Pohnpei</p></li><li><p>Pacific/Ponape</p></li><li><p>Pacific/Port_Moresby</p></li><li><p>Pacific/Rarotonga</p></li><li><p>Pacific/Saipan</p></li><li><p>Pacific/Samoa</p></li><li><p>Pacific/Tahiti</p></li><li><p>Pacific/Tarawa</p></li><li><p>Pacific/Tongatapu</p></li><li><p>Pacific/Truk</p></li><li><p>Pacific/Wake</p></li><li><p>Pacific/Wallis</p></li><li><p>Pacific/Yap</p></li><li><p>Poland</p></li><li><p>Portugal</p></li></ul></div><div><p>R:</p></div><div><ul><li><p>ROK</p></li></ul></div><div><p>S:</p></div><div><ul><li><p>Singapore</p></li><li><p>SystemV/AST4</p></li><li><p>SystemV/AST4ADT</p></li><li><p>SystemV/CST6</p></li><li><p>SystemV/CST6CDT</p></li><li><p>SystemV/EST5</p></li><li><p>SystemV/EST5EDT</p></li><li><p>SystemV/HST10</p></li><li><p>SystemV/MST7</p></li><li><p>SystemV/MST7MDT</p></li><li><p>SystemV/PST8</p></li><li><p>SystemV/PST8PDT</p></li><li><p>SystemV/YST9</p></li><li><p>SystemV/YST9YDT</p></li></ul></div></div></td><td><div><div><p>T:</p></div><div><ul><li><p>Turkey</p></li></ul></div><div><p>U:</p></div><div><ul><li><p>UCT</p></li><li><p>US/Alaska</p></li><li><p>US/Aleutian</p></li><li><p>US/Arizona</p></li><li><p>US/Central</p></li><li><p>US/East-Indiana</p></li><li><p>US/Eastern</p></li><li><p>US/Hawaii</p></li><li><p>US/Indiana-Starke</p></li><li><p>US/Michigan</p></li><li><p>US/Mountain</p></li><li><p>US/Pacific</p></li><li><p>US/Pacific-New</p></li><li><p>US/Samoa</p></li><li><p>UTC</p></li><li><p>Universal</p></li></ul></div><div><p>W:</p></div><div><ul><li><p>W-SU</p></li><li><p>WET</p></li></ul></div><div><p>Z:</p></div><div><ul><li><p>Zulu</p></li></ul></div></div></td></tr></tbody></table>

## Related Examples

- [Format Dates and Times](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-format-dates)

- [Parse Dates with DataWeave](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-parse-dates)

- [Add and Subtract Time](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-add-and-subtract-time)

## See Also

- [Date and Time (dw::Core Types)](https://docs.mulesoft.com/dataweave/2.12/dataweave-types#dw_type_dates)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.12/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook)

<!-- document id=eb3f06b1d133ccab7642bdb69a011ca04a04f29a0da4d8ee0dd9846c03860b75 url=/mulesoft/current/en-us/dataweave/2.3/dataweave-cookbook-change-time-zone.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, date, time
---

# Change a Time Zone

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following example uses the `>>` operator and a [time zone ID](#timezone-ids) to change the time
zone. It also uses the formatting characters `uuuu-MM-dd'T'HH:mm:ss.SSS` to modify the format. The
`uuuu` characters represent the year.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
fun format(d: DateTime) = d as String {format: "yyyy-MM-dd'T'HH:mm:ss.SSS"}
---
{
    CreatedDateTime: format(|2019-02-13T13:23:00.120Z| >> "CET"),
}
```

Output XML:

```xml
{
    "CreatedDateTime": "2019-02-13T14:23:00.120"
}
```

## Time Zone IDs

In addition to accepting time zone values such as `-07:00`, DataWeave accepts Java 8 `TimeZone` ID
values, which are available through a Java method call to `TimeZone.getAvailableIds()`.

To see all available values in the following table, scroll right.

<table><colgroup><col> <col> <col> <col> <col> <col> <col> <col></colgroup><thead><tr><th></th><th></th><th></th><th></th><th></th><th></th><th></th><th></th></tr></thead><tbody><tr><td><div><div><p>Africa:</p></div><div><ul><li><p>Africa/Abidjan</p></li><li><p>Africa/Accra</p></li><li><p>Africa/Addis_Ababa</p></li><li><p>Africa/Algiers</p></li><li><p>Africa/Asmara</p></li><li><p>Africa/Asmera</p></li><li><p>Africa/Bamako</p></li><li><p>Africa/Bangui</p></li><li><p>Africa/Banjul</p></li><li><p>Africa/Bissau</p></li><li><p>Africa/Blantyre</p></li><li><p>Africa/Brazzaville</p></li><li><p>Africa/Bujumbura</p></li><li><p>Africa/Cairo</p></li><li><p>Africa/Casablanca</p></li><li><p>Africa/Ceuta</p></li><li><p>Africa/Conakry</p></li><li><p>Africa/Dakar</p></li><li><p>Africa/Dar_es_Salaam</p></li><li><p>Africa/Djibouti</p></li><li><p>Africa/Douala</p></li><li><p>Africa/El_Aaiun</p></li><li><p>Africa/Freetown</p></li><li><p>Africa/Gaborone</p></li><li><p>Africa/Harare</p></li><li><p>Africa/Johannesburg</p></li><li><p>Africa/Juba</p></li><li><p>Africa/Kampala</p></li><li><p>Africa/Khartoum</p></li><li><p>Africa/Kigali</p></li><li><p>Africa/Kinshasa</p></li><li><p>Africa/Lagos</p></li><li><p>Africa/Libreville</p></li><li><p>Africa/Lome</p></li><li><p>Africa/Luanda</p></li><li><p>Africa/Lubumbashi</p></li><li><p>Africa/Lusaka</p></li><li><p>Africa/Malabo</p></li><li><p>Africa/Maputo</p></li><li><p>Africa/Maseru</p></li><li><p>Africa/Mbabane</p></li><li><p>Africa/Mogadishu</p></li><li><p>Africa/Monrovia</p></li><li><p>Africa/Nairobi</p></li><li><p>Africa/Ndjamena</p></li><li><p>Africa/Niamey</p></li><li><p>Africa/Nouakchott</p></li><li><p>Africa/Ouagadougou</p></li><li><p>Africa/Porto-Novo</p></li><li><p>Africa/Sao_Tome</p></li><li><p>Africa/Timbuktu</p></li><li><p>Africa/Tripoli</p></li><li><p>Africa/Tunis</p></li><li><p>Africa/Windhoek</p></li></ul></div><div><p>America:</p></div><div><ul><li><p>America/Adak</p></li><li><p>America/Anchorage</p></li><li><p>America/Anguilla</p></li><li><p>America/Antigua</p></li><li><p>America/Araguaina</p></li><li><p>America/Argentina/Buenos_Aires</p></li><li><p>America/Argentina/Catamarca</p></li><li><p>America/Argentina/ComodRivadavia</p></li><li><p>America/Argentina/Cordoba</p></li><li><p>America/Argentina/Jujuy</p></li><li><p>America/Argentina/La_Rioja</p></li><li><p>America/Argentina/Mendoza</p></li><li><p>America/Argentina/Rio_Gallegos</p></li><li><p>America/Argentina/Salta</p></li><li><p>America/Argentina/San_Juan</p></li><li><p>America/Argentina/San_Luis</p></li><li><p>America/Argentina/Tucuman</p></li><li><p>America/Argentina/Ushuaia</p></li><li><p>America/Aruba</p></li><li><p>America/Asuncion</p></li><li><p>America/Atikokan</p></li><li><p>America/Atka</p></li><li><p>America/Bahia</p></li><li><p>America/Bahia_Banderas</p></li><li><p>America/Barbados</p></li><li><p>America/Belem</p></li><li><p>America/Belize</p></li><li><p>America/Blanc-Sablon</p></li><li><p>America/Boa_Vista</p></li><li><p>America/Bogota</p></li><li><p>America/Boise</p></li><li><p>America/Buenos_Aires</p></li></ul></div></div></td><td><div><div><p>America (continued):</p></div><div><ul><li><p>America/Cambridge_Bay</p></li><li><p>America/Campo_Grande</p></li><li><p>America/Cancun</p></li><li><p>America/Caracas</p></li><li><p>America/Catamarca</p></li><li><p>America/Cayenne</p></li><li><p>America/Cayman</p></li><li><p>America/Chicago</p></li><li><p>America/Chihuahua</p></li><li><p>America/Coral_Harbour</p></li><li><p>America/Cordoba</p></li><li><p>America/Costa_Rica</p></li><li><p>America/Creston</p></li><li><p>America/Cuiaba</p></li><li><p>America/Curacao</p></li><li><p>America/Danmarkshavn</p></li><li><p>America/Dawson</p></li><li><p>America/Dawson_Creek</p></li><li><p>America/Denver</p></li><li><p>America/Detroit</p></li><li><p>America/Dominica</p></li><li><p>America/Edmonton</p></li><li><p>America/Eirunepe</p></li><li><p>America/El_Salvador</p></li><li><p>America/Ensenada</p></li><li><p>America/Fort_Nelson</p></li><li><p>America/Fort_Wayne</p></li><li><p>America/Fortaleza</p></li><li><p>America/Glace_Bay</p></li><li><p>America/Godthab</p></li><li><p>America/Goose_Bay</p></li><li><p>America/Grand_Turk</p></li><li><p>America/Grenada</p></li><li><p>America/Guadeloupe</p></li><li><p>America/Guatemala</p></li><li><p>America/Guayaquil</p></li><li><p>America/Guyana</p></li><li><p>America/Halifax</p></li><li><p>America/Havana</p></li><li><p>America/Hermosillo</p></li><li><p>America/Indiana/Indianapolis</p></li><li><p>America/Indiana/Knox</p></li><li><p>America/Indiana/Marengo</p></li><li><p>America/Indiana/Petersburg</p></li><li><p>America/Indiana/Tell_City</p></li><li><p>America/Indiana/Vevay</p></li><li><p>America/Indiana/Vincennes</p></li><li><p>America/Indiana/Winamac</p></li><li><p>America/Indianapolis</p></li><li><p>America/Inuvik</p></li><li><p>America/Iqaluit</p></li><li><p>America/Jamaica</p></li><li><p>America/Jujuy</p></li><li><p>America/Juneau</p></li><li><p>America/Kentucky/Louisville</p></li><li><p>America/Kentucky/Monticello</p></li><li><p>America/Knox_IN</p></li><li><p>America/Kralendijk</p></li><li><p>America/La_Paz</p></li><li><p>America/Lima</p></li><li><p>America/Los_Angeles</p></li><li><p>America/Louisville</p></li><li><p>America/Lower_Princes</p></li><li><p>America/Maceio</p></li><li><p>America/Managua</p></li><li><p>America/Manaus</p></li><li><p>America/Marigot</p></li><li><p>America/Martinique</p></li><li><p>America/Matamoros</p></li><li><p>America/Mazatlan</p></li><li><p>America/Mendoza</p></li><li><p>America/Menominee</p></li><li><p>America/Merida</p></li><li><p>America/Metlakatla</p></li><li><p>America/Mexico_City</p></li><li><p>America/Miquelon</p></li><li><p>America/Moncton</p></li><li><p>America/Monterrey</p></li><li><p>America/Montevideo</p></li><li><p>America/Montreal</p></li><li><p>America/Montserrat</p></li><li><p>America/Nassau</p></li><li><p>America/New_York</p></li><li><p>America/Nipigon</p></li><li><p>America/Nome</p></li><li><p>America/Noronha</p></li></ul></div></div></td><td><div><div><p>America (continued):</p></div><div><ul><li><p>America/North_Dakota/Beulah</p></li><li><p>America/North_Dakota/Center</p></li><li><p>America/North_Dakota/New_Salem</p></li><li><p>America/Ojinaga</p></li><li><p>America/Panama</p></li><li><p>America/Pangnirtung</p></li><li><p>America/Paramaribo</p></li><li><p>America/Phoenix</p></li><li><p>America/Port-au-Prince</p></li><li><p>America/Port_of_Spain</p></li><li><p>America/Porto_Acre</p></li><li><p>America/Porto_Velho</p></li><li><p>America/Puerto_Rico</p></li><li><p>America/Punta_Arenas</p></li><li><p>America/Rainy_River</p></li><li><p>America/Rankin_Inlet</p></li><li><p>America/Recife</p></li><li><p>America/Regina</p></li><li><p>America/Resolute</p></li><li><p>America/Rio_Branco</p></li><li><p>America/Rosario</p></li><li><p>America/Santa_Isabel</p></li><li><p>America/Santarem</p></li><li><p>America/Santiago</p></li><li><p>America/Santo_Domingo</p></li><li><p>America/Sao_Paulo</p></li><li><p>America/Scoresbysund</p></li><li><p>America/Shiprock</p></li><li><p>America/Sitka</p></li><li><p>America/St_Barthelemy</p></li><li><p>America/St_Johns</p></li><li><p>America/St_Kitts</p></li><li><p>America/St_Lucia</p></li><li><p>America/St_Thomas</p></li><li><p>America/St_Vincent</p></li><li><p>America/Swift_Current</p></li><li><p>America/Tegucigalpa</p></li><li><p>America/Thule</p></li><li><p>America/Thunder_Bay</p></li><li><p>America/Tijuana</p></li><li><p>America/Toronto</p></li><li><p>America/Tortola</p></li><li><p>America/Vancouver</p></li><li><p>America/Virgin</p></li><li><p>America/Whitehorse</p></li><li><p>America/Winnipeg</p></li><li><p>America/Yakutat</p></li><li><p>America/Yellowknife</p></li></ul></div><div><p>Antarctica:</p></div><div><ul><li><p>Antarctica/Casey</p></li><li><p>Antarctica/Davis</p></li><li><p>Antarctica/DumontDUrville</p></li><li><p>Antarctica/Macquarie</p></li><li><p>Antarctica/Mawson</p></li><li><p>Antarctica/McMurdo</p></li><li><p>Antarctica/Palmer</p></li><li><p>Antarctica/Rothera</p></li><li><p>Antarctica/South_Pole</p></li><li><p>Antarctica/Syowa</p></li><li><p>Antarctica/Troll</p></li><li><p>Antarctica/Vostok</p></li><li><p>Arctic/Longyearbyen</p></li></ul></div><div><p>Asia:</p></div><div><ul><li><p>Asia/Aden</p></li><li><p>Asia/Almaty</p></li><li><p>Asia/Amman</p></li><li><p>Asia/Anadyr</p></li><li><p>Asia/Aqtau</p></li><li><p>Asia/Aqtobe</p></li><li><p>Asia/Ashgabat</p></li><li><p>Asia/Ashkhabad</p></li><li><p>Asia/Atyrau</p></li><li><p>Asia/Baghdad</p></li><li><p>Asia/Bahrain</p></li><li><p>Asia/Baku</p></li><li><p>Asia/Bangkok</p></li><li><p>Asia/Barnaul</p></li><li><p>Asia/Beirut</p></li><li><p>Asia/Bishkek</p></li><li><p>Asia/Brunei</p></li><li><p>Asia/Calcutta</p></li><li><p>Asia/Chita</p></li><li><p>Asia/Choibalsan</p></li><li><p>Asia/Chongqing</p></li><li><p>Asia/Chungking</p></li><li><p>Asia/Colombo</p></li></ul></div></div></td><td><div><div><p>Asia (continued):</p></div><div><ul><li><p>Asia/Dacca</p></li><li><p>Asia/Damascus</p></li><li><p>Asia/Dhaka</p></li><li><p>Asia/Dili</p></li><li><p>Asia/Dubai</p></li><li><p>Asia/Dushanbe</p></li><li><p>Asia/Famagusta</p></li><li><p>Asia/Gaza</p></li><li><p>Asia/Harbin</p></li><li><p>Asia/Hebron</p></li><li><p>Asia/Ho_Chi_Minh</p></li><li><p>Asia/Hong_Kong</p></li><li><p>Asia/Hovd</p></li><li><p>Asia/Irkutsk</p></li><li><p>Asia/Istanbul</p></li><li><p>Asia/Jakarta</p></li><li><p>Asia/Jayapura</p></li><li><p>Asia/Jerusalem</p></li><li><p>Asia/Kabul</p></li><li><p>Asia/Kamchatka</p></li><li><p>Asia/Karachi</p></li><li><p>Asia/Kashgar</p></li><li><p>Asia/Kathmandu</p></li><li><p>Asia/Katmandu</p></li><li><p>Asia/Khandyga</p></li><li><p>Asia/Kolkata</p></li><li><p>Asia/Krasnoyarsk</p></li><li><p>Asia/Kuala_Lumpur</p></li><li><p>Asia/Kuching</p></li><li><p>Asia/Kuwait</p></li><li><p>Asia/Macao</p></li><li><p>Asia/Macau</p></li><li><p>Asia/Magadan</p></li><li><p>Asia/Makassar</p></li><li><p>Asia/Manila</p></li><li><p>Asia/Muscat</p></li><li><p>Asia/Nicosia</p></li><li><p>Asia/Novokuznetsk</p></li><li><p>Asia/Novosibirsk</p></li><li><p>Asia/Omsk</p></li><li><p>Asia/Oral</p></li><li><p>Asia/Phnom_Penh</p></li><li><p>Asia/Pontianak</p></li><li><p>Asia/Pyongyang</p></li><li><p>Asia/Qatar</p></li><li><p>Asia/Qostanay</p></li><li><p>Asia/Qyzylorda</p></li><li><p>Asia/Rangoon</p></li><li><p>Asia/Riyadh</p></li><li><p>Asia/Saigon</p></li><li><p>Asia/Sakhalin</p></li><li><p>Asia/Samarkand</p></li><li><p>Asia/Seoul</p></li><li><p>Asia/Shanghai</p></li><li><p>Asia/Singapore</p></li><li><p>Asia/Srednekolymsk</p></li><li><p>Asia/Taipei</p></li><li><p>Asia/Tashkent</p></li><li><p>Asia/Tbilisi</p></li><li><p>Asia/Tehran</p></li><li><p>Asia/Tel_Aviv</p></li><li><p>Asia/Thimbu</p></li><li><p>Asia/Thimphu</p></li><li><p>Asia/Tokyo</p></li><li><p>Asia/Tomsk</p></li><li><p>Asia/Ujung_Pandang</p></li><li><p>Asia/Ulaanbaatar</p></li><li><p>Asia/Ulan_Bator</p></li><li><p>Asia/Urumqi</p></li><li><p>Asia/Ust-Nera</p></li><li><p>Asia/Vientiane</p></li><li><p>Asia/Vladivostok</p></li><li><p>Asia/Yakutsk</p></li><li><p>Asia/Yangon</p></li><li><p>Asia/Yekaterinburg</p></li><li><p>Asia/Yerevan</p></li></ul></div><div><p>Atlantic:</p></div><div><ul><li><p>Atlantic/Azores</p></li><li><p>Atlantic/Bermuda</p></li><li><p>Atlantic/Canary</p></li><li><p>Atlantic/Cape_Verde</p></li><li><p>Atlantic/Faeroe</p></li><li><p>Atlantic/Faroe</p></li><li><p>Atlantic/Jan_Mayen</p></li><li><p>Atlantic/Madeira</p></li><li><p>Atlantic/Reykjavik</p></li><li><p>Atlantic/South_Georgia</p></li><li><p>Atlantic/St_Helena</p></li><li><p>Atlantic/Stanley</p></li></ul></div></div></td><td><div><div><p>Australia:</p></div><div><ul><li><p>Australia/ACT</p></li><li><p>Australia/Adelaide</p></li><li><p>Australia/Brisbane</p></li><li><p>Australia/Broken_Hill</p></li><li><p>Australia/Canberra</p></li><li><p>Australia/Currie</p></li><li><p>Australia/Darwin</p></li><li><p>Australia/Eucla</p></li><li><p>Australia/Hobart</p></li><li><p>Australia/LHI</p></li><li><p>Australia/Lindeman</p></li><li><p>Australia/Lord_Howe</p></li><li><p>Australia/Melbourne</p></li><li><p>Australia/NSW</p></li><li><p>Australia/North</p></li><li><p>Australia/Perth</p></li><li><p>Australia/Queensland</p></li><li><p>Australia/South</p></li><li><p>Australia/Sydney</p></li><li><p>Australia/Tasmania</p></li><li><p>Australia/Victoria</p></li><li><p>Australia/West</p></li><li><p>Australia/Yancowinna</p></li></ul></div><div><p>B:</p></div><div><ul><li><p>Brazil/Acre</p></li><li><p>Brazil/DeNoronha</p></li><li><p>Brazil/East</p></li><li><p>Brazil/West</p></li></ul></div><div><p>C:</p></div><div><ul><li><p>CET</p></li><li><p>CST6CDT</p></li><li><p>Canada/Atlantic</p></li><li><p>Canada/Central</p></li><li><p>Canada/Eastern</p></li><li><p>Canada/Mountain</p></li><li><p>Canada/Newfoundland</p></li><li><p>Canada/Pacific</p></li><li><p>Canada/Saskatchewan</p></li><li><p>Canada/Yukon</p></li><li><p>Chile/Continental</p></li><li><p>Chile/EasterIsland</p></li><li><p>Cuba</p></li></ul></div><div><p>E:</p></div><div><ul><li><p>EET</p></li><li><p>EST5EDT</p></li><li><p>Egypt</p></li><li><p>Eire</p></li><li><p>Etc/GMT</p></li><li><p>Etc/GMT+0</p></li><li><p>Etc/GMT+1</p></li><li><p>Etc/GMT+10</p></li><li><p>Etc/GMT+11</p></li><li><p>Etc/GMT+12</p></li><li><p>Etc/GMT+2</p></li><li><p>Etc/GMT+3</p></li><li><p>Etc/GMT+4</p></li><li><p>Etc/GMT+5</p></li><li><p>Etc/GMT+6</p></li><li><p>Etc/GMT+7</p></li><li><p>Etc/GMT+8</p></li><li><p>Etc/GMT+9</p></li><li><p>Etc/GMT-0</p></li><li><p>Etc/GMT-1</p></li><li><p>Etc/GMT-10</p></li><li><p>Etc/GMT-11</p></li><li><p>Etc/GMT-12</p></li><li><p>Etc/GMT-13</p></li><li><p>Etc/GMT-14</p></li><li><p>Etc/GMT-2</p></li><li><p>Etc/GMT-3</p></li><li><p>Etc/GMT-4</p></li><li><p>Etc/GMT-5</p></li><li><p>Etc/GMT-6</p></li><li><p>Etc/GMT-7</p></li><li><p>Etc/GMT-8</p></li><li><p>Etc/GMT-9</p></li><li><p>Etc/GMT0</p></li><li><p>Etc/Greenwich</p></li><li><p>Etc/UCT</p></li><li><p>Etc/UTC</p></li><li><p>Etc/Universal</p></li><li><p>Etc/Zulu</p></li></ul></div></div></td><td><div><div><p>E (continued):</p></div><div><ul><li><p>Europe/Amsterdam</p></li><li><p>Europe/Andorra</p></li><li><p>Europe/Astrakhan</p></li><li><p>Europe/Athens</p></li><li><p>Europe/Belfast</p></li><li><p>Europe/Belgrade</p></li><li><p>Europe/Berlin</p></li><li><p>Europe/Bratislava</p></li><li><p>Europe/Brussels</p></li><li><p>Europe/Bucharest</p></li><li><p>Europe/Budapest</p></li><li><p>Europe/Busingen</p></li><li><p>Europe/Chisinau</p></li><li><p>Europe/Copenhagen</p></li><li><p>Europe/Dublin</p></li><li><p>Europe/Gibraltar</p></li><li><p>Europe/Guernsey</p></li><li><p>Europe/Helsinki</p></li><li><p>Europe/Isle_of_Man</p></li><li><p>Europe/Istanbul</p></li><li><p>Europe/Jersey</p></li><li><p>Europe/Kaliningrad</p></li><li><p>Europe/Kiev</p></li><li><p>Europe/Kirov</p></li><li><p>Europe/Lisbon</p></li><li><p>Europe/Ljubljana</p></li><li><p>Europe/London</p></li><li><p>Europe/Luxembourg</p></li><li><p>Europe/Madrid</p></li><li><p>Europe/Malta</p></li><li><p>Europe/Mariehamn</p></li><li><p>Europe/Minsk</p></li><li><p>Europe/Monaco</p></li><li><p>Europe/Moscow</p></li><li><p>Europe/Nicosia</p></li><li><p>Europe/Oslo</p></li><li><p>Europe/Paris</p></li><li><p>Europe/Podgorica</p></li><li><p>Europe/Prague</p></li><li><p>Europe/Riga</p></li><li><p>Europe/Rome</p></li><li><p>Europe/Samara</p></li><li><p>Europe/San_Marino</p></li><li><p>Europe/Sarajevo</p></li><li><p>Europe/Saratov</p></li><li><p>Europe/Simferopol</p></li><li><p>Europe/Skopje</p></li><li><p>Europe/Sofia</p></li><li><p>Europe/Stockholm</p></li><li><p>Europe/Tallinn</p></li><li><p>Europe/Tirane</p></li><li><p>Europe/Tiraspol</p></li><li><p>Europe/Ulyanovsk</p></li><li><p>Europe/Uzhgorod</p></li><li><p>Europe/Vaduz</p></li><li><p>Europe/Vatican</p></li><li><p>Europe/Vienna</p></li><li><p>Europe/Vilnius</p></li><li><p>Europe/Volgograd</p></li><li><p>Europe/Warsaw</p></li><li><p>Europe/Zagreb</p></li><li><p>Europe/Zaporozhye</p></li><li><p>Europe/Zurich</p></li></ul></div><div><p>G:</p></div><div><ul><li><p>GB</p></li><li><p>GB-Eire</p></li><li><p>GMT</p></li><li><p>GMT0</p></li><li><p>Greenwich</p></li></ul></div><div><p>H:</p></div><div><ul><li><p>Hongkong</p></li></ul></div><div><p>I:</p></div><div><ul><li><p>Iceland</p></li><li><p>Indian/Antananarivo</p></li><li><p>Indian/Chagos</p></li><li><p>Indian/Christmas</p></li><li><p>Indian/Cocos</p></li><li><p>Indian/Comoro</p></li><li><p>Indian/Kerguelen</p></li><li><p>Indian/Mahe</p></li><li><p>Indian/Maldives</p></li><li><p>Indian/Mauritius</p></li><li><p>Indian/Mayotte</p></li><li><p>Indian/Reunion</p></li><li><p>Iran</p></li><li><p>Israel</p></li></ul></div></div></td><td><div><div><p>J:</p></div><div><ul><li><p>Jamaica</p></li><li><p>Japan</p></li></ul></div><div><p>K:</p></div><div><ul><li><p>Kwajalein</p></li></ul></div><div><p>L:</p></div><div><ul><li><p>Libya</p></li></ul></div><div><p>M:</p></div><div><ul><li><p>MET</p></li><li><p>MST7MDT</p></li><li><p>Mexico/BajaNorte</p></li><li><p>Mexico/BajaSur</p></li><li><p>Mexico/General</p></li></ul></div><div><p>N:</p></div><div><ul><li><p>NZ</p></li><li><p>NZ-CHAT</p></li><li><p>Navajo</p></li></ul></div><div><p>P:</p></div><div><ul><li><p>PRC</p></li><li><p>PST8PDT</p></li><li><p>Pacific/Apia</p></li><li><p>Pacific/Auckland</p></li><li><p>Pacific/Bougainville</p></li><li><p>Pacific/Chatham</p></li><li><p>Pacific/Chuuk</p></li><li><p>Pacific/Easter</p></li><li><p>Pacific/Efate</p></li><li><p>Pacific/Enderbury</p></li><li><p>Pacific/Fakaofo</p></li><li><p>Pacific/Fiji</p></li><li><p>Pacific/Funafuti</p></li><li><p>Pacific/Galapagos</p></li><li><p>Pacific/Gambier</p></li><li><p>Pacific/Guadalcanal</p></li><li><p>Pacific/Guam</p></li><li><p>Pacific/Honolulu</p></li><li><p>Pacific/Johnston</p></li><li><p>Pacific/Kiritimati</p></li><li><p>Pacific/Kosrae</p></li><li><p>Pacific/Kwajalein</p></li><li><p>Pacific/Majuro</p></li><li><p>Pacific/Marquesas</p></li><li><p>Pacific/Midway</p></li><li><p>Pacific/Nauru</p></li><li><p>Pacific/Niue</p></li><li><p>Pacific/Norfolk</p></li><li><p>Pacific/Noumea</p></li><li><p>Pacific/Pago_Pago</p></li><li><p>Pacific/Palau</p></li><li><p>Pacific/Pitcairn</p></li><li><p>Pacific/Pohnpei</p></li><li><p>Pacific/Ponape</p></li><li><p>Pacific/Port_Moresby</p></li><li><p>Pacific/Rarotonga</p></li><li><p>Pacific/Saipan</p></li><li><p>Pacific/Samoa</p></li><li><p>Pacific/Tahiti</p></li><li><p>Pacific/Tarawa</p></li><li><p>Pacific/Tongatapu</p></li><li><p>Pacific/Truk</p></li><li><p>Pacific/Wake</p></li><li><p>Pacific/Wallis</p></li><li><p>Pacific/Yap</p></li><li><p>Poland</p></li><li><p>Portugal</p></li></ul></div><div><p>R:</p></div><div><ul><li><p>ROK</p></li></ul></div><div><p>S:</p></div><div><ul><li><p>Singapore</p></li><li><p>SystemV/AST4</p></li><li><p>SystemV/AST4ADT</p></li><li><p>SystemV/CST6</p></li><li><p>SystemV/CST6CDT</p></li><li><p>SystemV/EST5</p></li><li><p>SystemV/EST5EDT</p></li><li><p>SystemV/HST10</p></li><li><p>SystemV/MST7</p></li><li><p>SystemV/MST7MDT</p></li><li><p>SystemV/PST8</p></li><li><p>SystemV/PST8PDT</p></li><li><p>SystemV/YST9</p></li><li><p>SystemV/YST9YDT</p></li></ul></div></div></td><td><div><div><p>T:</p></div><div><ul><li><p>Turkey</p></li></ul></div><div><p>U:</p></div><div><ul><li><p>UCT</p></li><li><p>US/Alaska</p></li><li><p>US/Aleutian</p></li><li><p>US/Arizona</p></li><li><p>US/Central</p></li><li><p>US/East-Indiana</p></li><li><p>US/Eastern</p></li><li><p>US/Hawaii</p></li><li><p>US/Indiana-Starke</p></li><li><p>US/Michigan</p></li><li><p>US/Mountain</p></li><li><p>US/Pacific</p></li><li><p>US/Pacific-New</p></li><li><p>US/Samoa</p></li><li><p>UTC</p></li><li><p>Universal</p></li></ul></div><div><p>W:</p></div><div><ul><li><p>W-SU</p></li><li><p>WET</p></li></ul></div><div><p>Z:</p></div><div><ul><li><p>Zulu</p></li></ul></div></div></td></tr></tbody></table>

## Related Examples

- [Format Dates and Times](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-format-dates)

- [Parse Dates with DataWeave](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-parse-dates)

- [Add and Subtract Time](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-add-and-subtract-time)

## See Also

- [Date and Time (dw::Core Types)](https://docs.mulesoft.com/dataweave/2.3/dataweave-types#dw_type_dates)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.3/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook)

<!-- document id=6aeddb368bff849ca99005e45270c15b3915a0de96883834e70005c97bcb767f url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook-change-time-zone.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, date, time
---

# Change a Time Zone

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following example uses the `>>` operator and a [time zone ID](#timezone-ids) to change the time
zone. It also uses the formatting characters `uuuu-MM-dd'T'HH:mm:ss.SSS` to modify the format. The
`uuuu` characters represent the year.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
fun format(d: DateTime) = d as String {format: "yyyy-MM-dd'T'HH:mm:ss.SSS"}
---
{
    CreatedDateTime: format(|2019-02-13T13:23:00.120Z| >> "CET"),
}
```

Output JSON:

```JSON
{
    "CreatedDateTime": "2019-02-13T14:23:00.120"
}
```

## Time Zone IDs

In addition to accepting time zone values such as `-07:00`, DataWeave accepts Java 8 `TimeZone` ID
values, which are available through a Java method call to `ZoneId.getAvailableZoneIds()`.

To see all available values in the following table, scroll right.

<table><colgroup><col> <col> <col> <col> <col> <col> <col> <col></colgroup><thead><tr><th></th><th></th><th></th><th></th><th></th><th></th><th></th><th></th></tr></thead><tbody><tr><td><div><div><p>Africa:</p></div><div><ul><li><p>Africa/Abidjan</p></li><li><p>Africa/Accra</p></li><li><p>Africa/Addis_Ababa</p></li><li><p>Africa/Algiers</p></li><li><p>Africa/Asmara</p></li><li><p>Africa/Asmera</p></li><li><p>Africa/Bamako</p></li><li><p>Africa/Bangui</p></li><li><p>Africa/Banjul</p></li><li><p>Africa/Bissau</p></li><li><p>Africa/Blantyre</p></li><li><p>Africa/Brazzaville</p></li><li><p>Africa/Bujumbura</p></li><li><p>Africa/Cairo</p></li><li><p>Africa/Casablanca</p></li><li><p>Africa/Ceuta</p></li><li><p>Africa/Conakry</p></li><li><p>Africa/Dakar</p></li><li><p>Africa/Dar_es_Salaam</p></li><li><p>Africa/Djibouti</p></li><li><p>Africa/Douala</p></li><li><p>Africa/El_Aaiun</p></li><li><p>Africa/Freetown</p></li><li><p>Africa/Gaborone</p></li><li><p>Africa/Harare</p></li><li><p>Africa/Johannesburg</p></li><li><p>Africa/Juba</p></li><li><p>Africa/Kampala</p></li><li><p>Africa/Khartoum</p></li><li><p>Africa/Kigali</p></li><li><p>Africa/Kinshasa</p></li><li><p>Africa/Lagos</p></li><li><p>Africa/Libreville</p></li><li><p>Africa/Lome</p></li><li><p>Africa/Luanda</p></li><li><p>Africa/Lubumbashi</p></li><li><p>Africa/Lusaka</p></li><li><p>Africa/Malabo</p></li><li><p>Africa/Maputo</p></li><li><p>Africa/Maseru</p></li><li><p>Africa/Mbabane</p></li><li><p>Africa/Mogadishu</p></li><li><p>Africa/Monrovia</p></li><li><p>Africa/Nairobi</p></li><li><p>Africa/Ndjamena</p></li><li><p>Africa/Niamey</p></li><li><p>Africa/Nouakchott</p></li><li><p>Africa/Ouagadougou</p></li><li><p>Africa/Porto-Novo</p></li><li><p>Africa/Sao_Tome</p></li><li><p>Africa/Timbuktu</p></li><li><p>Africa/Tripoli</p></li><li><p>Africa/Tunis</p></li><li><p>Africa/Windhoek</p></li></ul></div><div><p>America:</p></div><div><ul><li><p>America/Adak</p></li><li><p>America/Anchorage</p></li><li><p>America/Anguilla</p></li><li><p>America/Antigua</p></li><li><p>America/Araguaina</p></li><li><p>America/Argentina/Buenos_Aires</p></li><li><p>America/Argentina/Catamarca</p></li><li><p>America/Argentina/ComodRivadavia</p></li><li><p>America/Argentina/Cordoba</p></li><li><p>America/Argentina/Jujuy</p></li><li><p>America/Argentina/La_Rioja</p></li><li><p>America/Argentina/Mendoza</p></li><li><p>America/Argentina/Rio_Gallegos</p></li><li><p>America/Argentina/Salta</p></li><li><p>America/Argentina/San_Juan</p></li><li><p>America/Argentina/San_Luis</p></li><li><p>America/Argentina/Tucuman</p></li><li><p>America/Argentina/Ushuaia</p></li><li><p>America/Aruba</p></li><li><p>America/Asuncion</p></li><li><p>America/Atikokan</p></li><li><p>America/Atka</p></li><li><p>America/Bahia</p></li><li><p>America/Bahia_Banderas</p></li><li><p>America/Barbados</p></li><li><p>America/Belem</p></li><li><p>America/Belize</p></li><li><p>America/Blanc-Sablon</p></li><li><p>America/Boa_Vista</p></li><li><p>America/Bogota</p></li><li><p>America/Boise</p></li><li><p>America/Buenos_Aires</p></li></ul></div></div></td><td><div><div><p>America (continued):</p></div><div><ul><li><p>America/Cambridge_Bay</p></li><li><p>America/Campo_Grande</p></li><li><p>America/Cancun</p></li><li><p>America/Caracas</p></li><li><p>America/Catamarca</p></li><li><p>America/Cayenne</p></li><li><p>America/Cayman</p></li><li><p>America/Chicago</p></li><li><p>America/Chihuahua</p></li><li><p>America/Coral_Harbour</p></li><li><p>America/Cordoba</p></li><li><p>America/Costa_Rica</p></li><li><p>America/Creston</p></li><li><p>America/Cuiaba</p></li><li><p>America/Curacao</p></li><li><p>America/Danmarkshavn</p></li><li><p>America/Dawson</p></li><li><p>America/Dawson_Creek</p></li><li><p>America/Denver</p></li><li><p>America/Detroit</p></li><li><p>America/Dominica</p></li><li><p>America/Edmonton</p></li><li><p>America/Eirunepe</p></li><li><p>America/El_Salvador</p></li><li><p>America/Ensenada</p></li><li><p>America/Fort_Nelson</p></li><li><p>America/Fort_Wayne</p></li><li><p>America/Fortaleza</p></li><li><p>America/Glace_Bay</p></li><li><p>America/Godthab</p></li><li><p>America/Goose_Bay</p></li><li><p>America/Grand_Turk</p></li><li><p>America/Grenada</p></li><li><p>America/Guadeloupe</p></li><li><p>America/Guatemala</p></li><li><p>America/Guayaquil</p></li><li><p>America/Guyana</p></li><li><p>America/Halifax</p></li><li><p>America/Havana</p></li><li><p>America/Hermosillo</p></li><li><p>America/Indiana/Indianapolis</p></li><li><p>America/Indiana/Knox</p></li><li><p>America/Indiana/Marengo</p></li><li><p>America/Indiana/Petersburg</p></li><li><p>America/Indiana/Tell_City</p></li><li><p>America/Indiana/Vevay</p></li><li><p>America/Indiana/Vincennes</p></li><li><p>America/Indiana/Winamac</p></li><li><p>America/Indianapolis</p></li><li><p>America/Inuvik</p></li><li><p>America/Iqaluit</p></li><li><p>America/Jamaica</p></li><li><p>America/Jujuy</p></li><li><p>America/Juneau</p></li><li><p>America/Kentucky/Louisville</p></li><li><p>America/Kentucky/Monticello</p></li><li><p>America/Knox_IN</p></li><li><p>America/Kralendijk</p></li><li><p>America/La_Paz</p></li><li><p>America/Lima</p></li><li><p>America/Los_Angeles</p></li><li><p>America/Louisville</p></li><li><p>America/Lower_Princes</p></li><li><p>America/Maceio</p></li><li><p>America/Managua</p></li><li><p>America/Manaus</p></li><li><p>America/Marigot</p></li><li><p>America/Martinique</p></li><li><p>America/Matamoros</p></li><li><p>America/Mazatlan</p></li><li><p>America/Mendoza</p></li><li><p>America/Menominee</p></li><li><p>America/Merida</p></li><li><p>America/Metlakatla</p></li><li><p>America/Mexico_City</p></li><li><p>America/Miquelon</p></li><li><p>America/Moncton</p></li><li><p>America/Monterrey</p></li><li><p>America/Montevideo</p></li><li><p>America/Montreal</p></li><li><p>America/Montserrat</p></li><li><p>America/Nassau</p></li><li><p>America/New_York</p></li><li><p>America/Nipigon</p></li><li><p>America/Nome</p></li><li><p>America/Noronha</p></li></ul></div></div></td><td><div><div><p>America (continued):</p></div><div><ul><li><p>America/North_Dakota/Beulah</p></li><li><p>America/North_Dakota/Center</p></li><li><p>America/North_Dakota/New_Salem</p></li><li><p>America/Ojinaga</p></li><li><p>America/Panama</p></li><li><p>America/Pangnirtung</p></li><li><p>America/Paramaribo</p></li><li><p>America/Phoenix</p></li><li><p>America/Port-au-Prince</p></li><li><p>America/Port_of_Spain</p></li><li><p>America/Porto_Acre</p></li><li><p>America/Porto_Velho</p></li><li><p>America/Puerto_Rico</p></li><li><p>America/Punta_Arenas</p></li><li><p>America/Rainy_River</p></li><li><p>America/Rankin_Inlet</p></li><li><p>America/Recife</p></li><li><p>America/Regina</p></li><li><p>America/Resolute</p></li><li><p>America/Rio_Branco</p></li><li><p>America/Rosario</p></li><li><p>America/Santa_Isabel</p></li><li><p>America/Santarem</p></li><li><p>America/Santiago</p></li><li><p>America/Santo_Domingo</p></li><li><p>America/Sao_Paulo</p></li><li><p>America/Scoresbysund</p></li><li><p>America/Shiprock</p></li><li><p>America/Sitka</p></li><li><p>America/St_Barthelemy</p></li><li><p>America/St_Johns</p></li><li><p>America/St_Kitts</p></li><li><p>America/St_Lucia</p></li><li><p>America/St_Thomas</p></li><li><p>America/St_Vincent</p></li><li><p>America/Swift_Current</p></li><li><p>America/Tegucigalpa</p></li><li><p>America/Thule</p></li><li><p>America/Thunder_Bay</p></li><li><p>America/Tijuana</p></li><li><p>America/Toronto</p></li><li><p>America/Tortola</p></li><li><p>America/Vancouver</p></li><li><p>America/Virgin</p></li><li><p>America/Whitehorse</p></li><li><p>America/Winnipeg</p></li><li><p>America/Yakutat</p></li><li><p>America/Yellowknife</p></li></ul></div><div><p>Antarctica:</p></div><div><ul><li><p>Antarctica/Casey</p></li><li><p>Antarctica/Davis</p></li><li><p>Antarctica/DumontDUrville</p></li><li><p>Antarctica/Macquarie</p></li><li><p>Antarctica/Mawson</p></li><li><p>Antarctica/McMurdo</p></li><li><p>Antarctica/Palmer</p></li><li><p>Antarctica/Rothera</p></li><li><p>Antarctica/South_Pole</p></li><li><p>Antarctica/Syowa</p></li><li><p>Antarctica/Troll</p></li><li><p>Antarctica/Vostok</p></li><li><p>Arctic/Longyearbyen</p></li></ul></div><div><p>Asia:</p></div><div><ul><li><p>Asia/Aden</p></li><li><p>Asia/Almaty</p></li><li><p>Asia/Amman</p></li><li><p>Asia/Anadyr</p></li><li><p>Asia/Aqtau</p></li><li><p>Asia/Aqtobe</p></li><li><p>Asia/Ashgabat</p></li><li><p>Asia/Ashkhabad</p></li><li><p>Asia/Atyrau</p></li><li><p>Asia/Baghdad</p></li><li><p>Asia/Bahrain</p></li><li><p>Asia/Baku</p></li><li><p>Asia/Bangkok</p></li><li><p>Asia/Barnaul</p></li><li><p>Asia/Beirut</p></li><li><p>Asia/Bishkek</p></li><li><p>Asia/Brunei</p></li><li><p>Asia/Calcutta</p></li><li><p>Asia/Chita</p></li><li><p>Asia/Choibalsan</p></li><li><p>Asia/Chongqing</p></li><li><p>Asia/Chungking</p></li><li><p>Asia/Colombo</p></li></ul></div></div></td><td><div><div><p>Asia (continued):</p></div><div><ul><li><p>Asia/Dacca</p></li><li><p>Asia/Damascus</p></li><li><p>Asia/Dhaka</p></li><li><p>Asia/Dili</p></li><li><p>Asia/Dubai</p></li><li><p>Asia/Dushanbe</p></li><li><p>Asia/Famagusta</p></li><li><p>Asia/Gaza</p></li><li><p>Asia/Harbin</p></li><li><p>Asia/Hebron</p></li><li><p>Asia/Ho_Chi_Minh</p></li><li><p>Asia/Hong_Kong</p></li><li><p>Asia/Hovd</p></li><li><p>Asia/Irkutsk</p></li><li><p>Asia/Istanbul</p></li><li><p>Asia/Jakarta</p></li><li><p>Asia/Jayapura</p></li><li><p>Asia/Jerusalem</p></li><li><p>Asia/Kabul</p></li><li><p>Asia/Kamchatka</p></li><li><p>Asia/Karachi</p></li><li><p>Asia/Kashgar</p></li><li><p>Asia/Kathmandu</p></li><li><p>Asia/Katmandu</p></li><li><p>Asia/Khandyga</p></li><li><p>Asia/Kolkata</p></li><li><p>Asia/Krasnoyarsk</p></li><li><p>Asia/Kuala_Lumpur</p></li><li><p>Asia/Kuching</p></li><li><p>Asia/Kuwait</p></li><li><p>Asia/Macao</p></li><li><p>Asia/Macau</p></li><li><p>Asia/Magadan</p></li><li><p>Asia/Makassar</p></li><li><p>Asia/Manila</p></li><li><p>Asia/Muscat</p></li><li><p>Asia/Nicosia</p></li><li><p>Asia/Novokuznetsk</p></li><li><p>Asia/Novosibirsk</p></li><li><p>Asia/Omsk</p></li><li><p>Asia/Oral</p></li><li><p>Asia/Phnom_Penh</p></li><li><p>Asia/Pontianak</p></li><li><p>Asia/Pyongyang</p></li><li><p>Asia/Qatar</p></li><li><p>Asia/Qostanay</p></li><li><p>Asia/Qyzylorda</p></li><li><p>Asia/Rangoon</p></li><li><p>Asia/Riyadh</p></li><li><p>Asia/Saigon</p></li><li><p>Asia/Sakhalin</p></li><li><p>Asia/Samarkand</p></li><li><p>Asia/Seoul</p></li><li><p>Asia/Shanghai</p></li><li><p>Asia/Singapore</p></li><li><p>Asia/Srednekolymsk</p></li><li><p>Asia/Taipei</p></li><li><p>Asia/Tashkent</p></li><li><p>Asia/Tbilisi</p></li><li><p>Asia/Tehran</p></li><li><p>Asia/Tel_Aviv</p></li><li><p>Asia/Thimbu</p></li><li><p>Asia/Thimphu</p></li><li><p>Asia/Tokyo</p></li><li><p>Asia/Tomsk</p></li><li><p>Asia/Ujung_Pandang</p></li><li><p>Asia/Ulaanbaatar</p></li><li><p>Asia/Ulan_Bator</p></li><li><p>Asia/Urumqi</p></li><li><p>Asia/Ust-Nera</p></li><li><p>Asia/Vientiane</p></li><li><p>Asia/Vladivostok</p></li><li><p>Asia/Yakutsk</p></li><li><p>Asia/Yangon</p></li><li><p>Asia/Yekaterinburg</p></li><li><p>Asia/Yerevan</p></li></ul></div><div><p>Atlantic:</p></div><div><ul><li><p>Atlantic/Azores</p></li><li><p>Atlantic/Bermuda</p></li><li><p>Atlantic/Canary</p></li><li><p>Atlantic/Cape_Verde</p></li><li><p>Atlantic/Faeroe</p></li><li><p>Atlantic/Faroe</p></li><li><p>Atlantic/Jan_Mayen</p></li><li><p>Atlantic/Madeira</p></li><li><p>Atlantic/Reykjavik</p></li><li><p>Atlantic/South_Georgia</p></li><li><p>Atlantic/St_Helena</p></li><li><p>Atlantic/Stanley</p></li></ul></div></div></td><td><div><div><p>Australia:</p></div><div><ul><li><p>Australia/ACT</p></li><li><p>Australia/Adelaide</p></li><li><p>Australia/Brisbane</p></li><li><p>Australia/Broken_Hill</p></li><li><p>Australia/Canberra</p></li><li><p>Australia/Currie</p></li><li><p>Australia/Darwin</p></li><li><p>Australia/Eucla</p></li><li><p>Australia/Hobart</p></li><li><p>Australia/LHI</p></li><li><p>Australia/Lindeman</p></li><li><p>Australia/Lord_Howe</p></li><li><p>Australia/Melbourne</p></li><li><p>Australia/NSW</p></li><li><p>Australia/North</p></li><li><p>Australia/Perth</p></li><li><p>Australia/Queensland</p></li><li><p>Australia/South</p></li><li><p>Australia/Sydney</p></li><li><p>Australia/Tasmania</p></li><li><p>Australia/Victoria</p></li><li><p>Australia/West</p></li><li><p>Australia/Yancowinna</p></li></ul></div><div><p>B:</p></div><div><ul><li><p>Brazil/Acre</p></li><li><p>Brazil/DeNoronha</p></li><li><p>Brazil/East</p></li><li><p>Brazil/West</p></li></ul></div><div><p>C:</p></div><div><ul><li><p>CET</p></li><li><p>CST6CDT</p></li><li><p>Canada/Atlantic</p></li><li><p>Canada/Central</p></li><li><p>Canada/Eastern</p></li><li><p>Canada/Mountain</p></li><li><p>Canada/Newfoundland</p></li><li><p>Canada/Pacific</p></li><li><p>Canada/Saskatchewan</p></li><li><p>Canada/Yukon</p></li><li><p>Chile/Continental</p></li><li><p>Chile/EasterIsland</p></li><li><p>Cuba</p></li></ul></div><div><p>E:</p></div><div><ul><li><p>EET</p></li><li><p>EST5EDT</p></li><li><p>Egypt</p></li><li><p>Eire</p></li><li><p>Etc/GMT</p></li><li><p>Etc/GMT+0</p></li><li><p>Etc/GMT+1</p></li><li><p>Etc/GMT+10</p></li><li><p>Etc/GMT+11</p></li><li><p>Etc/GMT+12</p></li><li><p>Etc/GMT+2</p></li><li><p>Etc/GMT+3</p></li><li><p>Etc/GMT+4</p></li><li><p>Etc/GMT+5</p></li><li><p>Etc/GMT+6</p></li><li><p>Etc/GMT+7</p></li><li><p>Etc/GMT+8</p></li><li><p>Etc/GMT+9</p></li><li><p>Etc/GMT-0</p></li><li><p>Etc/GMT-1</p></li><li><p>Etc/GMT-10</p></li><li><p>Etc/GMT-11</p></li><li><p>Etc/GMT-12</p></li><li><p>Etc/GMT-13</p></li><li><p>Etc/GMT-14</p></li><li><p>Etc/GMT-2</p></li><li><p>Etc/GMT-3</p></li><li><p>Etc/GMT-4</p></li><li><p>Etc/GMT-5</p></li><li><p>Etc/GMT-6</p></li><li><p>Etc/GMT-7</p></li><li><p>Etc/GMT-8</p></li><li><p>Etc/GMT-9</p></li><li><p>Etc/GMT0</p></li><li><p>Etc/Greenwich</p></li><li><p>Etc/UCT</p></li><li><p>Etc/UTC</p></li><li><p>Etc/Universal</p></li><li><p>Etc/Zulu</p></li></ul></div></div></td><td><div><div><p>E (continued):</p></div><div><ul><li><p>Europe/Amsterdam</p></li><li><p>Europe/Andorra</p></li><li><p>Europe/Astrakhan</p></li><li><p>Europe/Athens</p></li><li><p>Europe/Belfast</p></li><li><p>Europe/Belgrade</p></li><li><p>Europe/Berlin</p></li><li><p>Europe/Bratislava</p></li><li><p>Europe/Brussels</p></li><li><p>Europe/Bucharest</p></li><li><p>Europe/Budapest</p></li><li><p>Europe/Busingen</p></li><li><p>Europe/Chisinau</p></li><li><p>Europe/Copenhagen</p></li><li><p>Europe/Dublin</p></li><li><p>Europe/Gibraltar</p></li><li><p>Europe/Guernsey</p></li><li><p>Europe/Helsinki</p></li><li><p>Europe/Isle_of_Man</p></li><li><p>Europe/Istanbul</p></li><li><p>Europe/Jersey</p></li><li><p>Europe/Kaliningrad</p></li><li><p>Europe/Kiev</p></li><li><p>Europe/Kirov</p></li><li><p>Europe/Lisbon</p></li><li><p>Europe/Ljubljana</p></li><li><p>Europe/London</p></li><li><p>Europe/Luxembourg</p></li><li><p>Europe/Madrid</p></li><li><p>Europe/Malta</p></li><li><p>Europe/Mariehamn</p></li><li><p>Europe/Minsk</p></li><li><p>Europe/Monaco</p></li><li><p>Europe/Moscow</p></li><li><p>Europe/Nicosia</p></li><li><p>Europe/Oslo</p></li><li><p>Europe/Paris</p></li><li><p>Europe/Podgorica</p></li><li><p>Europe/Prague</p></li><li><p>Europe/Riga</p></li><li><p>Europe/Rome</p></li><li><p>Europe/Samara</p></li><li><p>Europe/San_Marino</p></li><li><p>Europe/Sarajevo</p></li><li><p>Europe/Saratov</p></li><li><p>Europe/Skopje</p></li><li><p>Europe/Sofia</p></li><li><p>Europe/Stockholm</p></li><li><p>Europe/Tallinn</p></li><li><p>Europe/Tirane</p></li><li><p>Europe/Tiraspol</p></li><li><p>Europe/Ulyanovsk</p></li><li><p>Europe/Uzhgorod</p></li><li><p>Europe/Vaduz</p></li><li><p>Europe/Vatican</p></li><li><p>Europe/Vienna</p></li><li><p>Europe/Vilnius</p></li><li><p>Europe/Volgograd</p></li><li><p>Europe/Warsaw</p></li><li><p>Europe/Zagreb</p></li><li><p>Europe/Zaporozhye</p></li><li><p>Europe/Zurich</p></li></ul></div><div><p>G:</p></div><div><ul><li><p>GB</p></li><li><p>GB-Eire</p></li><li><p>GMT</p></li><li><p>GMT0</p></li><li><p>Greenwich</p></li></ul></div><div><p>H:</p></div><div><ul><li><p>Hongkong</p></li></ul></div><div><p>I:</p></div><div><ul><li><p>Iceland</p></li><li><p>Indian/Antananarivo</p></li><li><p>Indian/Chagos</p></li><li><p>Indian/Christmas</p></li><li><p>Indian/Cocos</p></li><li><p>Indian/Comoro</p></li><li><p>Indian/Kerguelen</p></li><li><p>Indian/Mahe</p></li><li><p>Indian/Maldives</p></li><li><p>Indian/Mauritius</p></li><li><p>Indian/Mayotte</p></li><li><p>Indian/Reunion</p></li><li><p>Iran</p></li><li><p>Israel</p></li></ul></div></div></td><td><div><div><p>J:</p></div><div><ul><li><p>Jamaica</p></li><li><p>Japan</p></li></ul></div><div><p>K:</p></div><div><ul><li><p>Kwajalein</p></li></ul></div><div><p>L:</p></div><div><ul><li><p>Libya</p></li></ul></div><div><p>M:</p></div><div><ul><li><p>MET</p></li><li><p>MST7MDT</p></li><li><p>Mexico/BajaNorte</p></li><li><p>Mexico/BajaSur</p></li><li><p>Mexico/General</p></li></ul></div><div><p>N:</p></div><div><ul><li><p>NZ</p></li><li><p>NZ-CHAT</p></li><li><p>Navajo</p></li></ul></div><div><p>P:</p></div><div><ul><li><p>PRC</p></li><li><p>PST8PDT</p></li><li><p>Pacific/Apia</p></li><li><p>Pacific/Auckland</p></li><li><p>Pacific/Bougainville</p></li><li><p>Pacific/Chatham</p></li><li><p>Pacific/Chuuk</p></li><li><p>Pacific/Easter</p></li><li><p>Pacific/Efate</p></li><li><p>Pacific/Enderbury</p></li><li><p>Pacific/Fakaofo</p></li><li><p>Pacific/Fiji</p></li><li><p>Pacific/Funafuti</p></li><li><p>Pacific/Galapagos</p></li><li><p>Pacific/Gambier</p></li><li><p>Pacific/Guadalcanal</p></li><li><p>Pacific/Guam</p></li><li><p>Pacific/Honolulu</p></li><li><p>Pacific/Johnston</p></li><li><p>Pacific/Kiritimati</p></li><li><p>Pacific/Kosrae</p></li><li><p>Pacific/Kwajalein</p></li><li><p>Pacific/Majuro</p></li><li><p>Pacific/Marquesas</p></li><li><p>Pacific/Midway</p></li><li><p>Pacific/Nauru</p></li><li><p>Pacific/Niue</p></li><li><p>Pacific/Norfolk</p></li><li><p>Pacific/Noumea</p></li><li><p>Pacific/Pago_Pago</p></li><li><p>Pacific/Palau</p></li><li><p>Pacific/Pitcairn</p></li><li><p>Pacific/Pohnpei</p></li><li><p>Pacific/Ponape</p></li><li><p>Pacific/Port_Moresby</p></li><li><p>Pacific/Rarotonga</p></li><li><p>Pacific/Saipan</p></li><li><p>Pacific/Samoa</p></li><li><p>Pacific/Tahiti</p></li><li><p>Pacific/Tarawa</p></li><li><p>Pacific/Tongatapu</p></li><li><p>Pacific/Truk</p></li><li><p>Pacific/Wake</p></li><li><p>Pacific/Wallis</p></li><li><p>Pacific/Yap</p></li><li><p>Poland</p></li><li><p>Portugal</p></li></ul></div><div><p>R:</p></div><div><ul><li><p>ROK</p></li></ul></div><div><p>S:</p></div><div><ul><li><p>Singapore</p></li><li><p>SystemV/AST4</p></li><li><p>SystemV/AST4ADT</p></li><li><p>SystemV/CST6</p></li><li><p>SystemV/CST6CDT</p></li><li><p>SystemV/EST5</p></li><li><p>SystemV/EST5EDT</p></li><li><p>SystemV/HST10</p></li><li><p>SystemV/MST7</p></li><li><p>SystemV/MST7MDT</p></li><li><p>SystemV/PST8</p></li><li><p>SystemV/PST8PDT</p></li><li><p>SystemV/YST9</p></li><li><p>SystemV/YST9YDT</p></li></ul></div></div></td><td><div><div><p>T:</p></div><div><ul><li><p>Turkey</p></li></ul></div><div><p>U:</p></div><div><ul><li><p>UCT</p></li><li><p>US/Alaska</p></li><li><p>US/Aleutian</p></li><li><p>US/Arizona</p></li><li><p>US/Central</p></li><li><p>US/East-Indiana</p></li><li><p>US/Eastern</p></li><li><p>US/Hawaii</p></li><li><p>US/Indiana-Starke</p></li><li><p>US/Michigan</p></li><li><p>US/Mountain</p></li><li><p>US/Pacific</p></li><li><p>US/Pacific-New</p></li><li><p>US/Samoa</p></li><li><p>UTC</p></li><li><p>Universal</p></li></ul></div><div><p>W:</p></div><div><ul><li><p>W-SU</p></li><li><p>WET</p></li></ul></div><div><p>Z:</p></div><div><ul><li><p>Zulu</p></li></ul></div></div></td></tr></tbody></table>

## Related Examples

- [Format Dates and Times](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-format-dates)

- [Parse Dates with DataWeave](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-parse-dates)

- [Add and Subtract Time](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-add-and-subtract-time)

## See Also

- [Date and Time (dw::Core Types)](https://docs.mulesoft.com/dataweave/2.4/dataweave-types#dw_type_dates)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.4/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook)

<!-- document id=f8e9e901d072165ff0eb8285cd04ecec4a17f60368e8220f4e8c6735f4d463fc url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook-change-time-zone.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, date, time
---

# Change a Time Zone

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following example uses the `>>` operator and a [time zone ID](#timezone-ids) to change the time
zone. It also uses the formatting characters `uuuu-MM-dd'T'HH:mm:ss.SSS` to modify the format. The
`uuuu` characters represent the year.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
fun format(d: DateTime) = d as String {format: "yyyy-MM-dd'T'HH:mm:ss.SSS"}
---
{
    CreatedDateTime: format(|2019-02-13T13:23:00.120Z| >> "CET"),
}
```

Output JSON:

```JSON
{
    "CreatedDateTime": "2019-02-13T14:23:00.120"
}
```

## Time Zone IDs

In addition to accepting time zone values such as `-07:00`, DataWeave accepts Java 8 `TimeZone` ID
values, which are available through a Java method call to `ZoneId.getAvailableZoneIds()`.

To see all available values in the following table, scroll right.

<table><colgroup><col> <col> <col> <col> <col> <col> <col> <col></colgroup><thead><tr><th></th><th></th><th></th><th></th><th></th><th></th><th></th><th></th></tr></thead><tbody><tr><td><div><div><p>Africa:</p></div><div><ul><li><p>Africa/Abidjan</p></li><li><p>Africa/Accra</p></li><li><p>Africa/Addis_Ababa</p></li><li><p>Africa/Algiers</p></li><li><p>Africa/Asmara</p></li><li><p>Africa/Asmera</p></li><li><p>Africa/Bamako</p></li><li><p>Africa/Bangui</p></li><li><p>Africa/Banjul</p></li><li><p>Africa/Bissau</p></li><li><p>Africa/Blantyre</p></li><li><p>Africa/Brazzaville</p></li><li><p>Africa/Bujumbura</p></li><li><p>Africa/Cairo</p></li><li><p>Africa/Casablanca</p></li><li><p>Africa/Ceuta</p></li><li><p>Africa/Conakry</p></li><li><p>Africa/Dakar</p></li><li><p>Africa/Dar_es_Salaam</p></li><li><p>Africa/Djibouti</p></li><li><p>Africa/Douala</p></li><li><p>Africa/El_Aaiun</p></li><li><p>Africa/Freetown</p></li><li><p>Africa/Gaborone</p></li><li><p>Africa/Harare</p></li><li><p>Africa/Johannesburg</p></li><li><p>Africa/Juba</p></li><li><p>Africa/Kampala</p></li><li><p>Africa/Khartoum</p></li><li><p>Africa/Kigali</p></li><li><p>Africa/Kinshasa</p></li><li><p>Africa/Lagos</p></li><li><p>Africa/Libreville</p></li><li><p>Africa/Lome</p></li><li><p>Africa/Luanda</p></li><li><p>Africa/Lubumbashi</p></li><li><p>Africa/Lusaka</p></li><li><p>Africa/Malabo</p></li><li><p>Africa/Maputo</p></li><li><p>Africa/Maseru</p></li><li><p>Africa/Mbabane</p></li><li><p>Africa/Mogadishu</p></li><li><p>Africa/Monrovia</p></li><li><p>Africa/Nairobi</p></li><li><p>Africa/Ndjamena</p></li><li><p>Africa/Niamey</p></li><li><p>Africa/Nouakchott</p></li><li><p>Africa/Ouagadougou</p></li><li><p>Africa/Porto-Novo</p></li><li><p>Africa/Sao_Tome</p></li><li><p>Africa/Timbuktu</p></li><li><p>Africa/Tripoli</p></li><li><p>Africa/Tunis</p></li><li><p>Africa/Windhoek</p></li></ul></div><div><p>America:</p></div><div><ul><li><p>America/Adak</p></li><li><p>America/Anchorage</p></li><li><p>America/Anguilla</p></li><li><p>America/Antigua</p></li><li><p>America/Araguaina</p></li><li><p>America/Argentina/Buenos_Aires</p></li><li><p>America/Argentina/Catamarca</p></li><li><p>America/Argentina/ComodRivadavia</p></li><li><p>America/Argentina/Cordoba</p></li><li><p>America/Argentina/Jujuy</p></li><li><p>America/Argentina/La_Rioja</p></li><li><p>America/Argentina/Mendoza</p></li><li><p>America/Argentina/Rio_Gallegos</p></li><li><p>America/Argentina/Salta</p></li><li><p>America/Argentina/San_Juan</p></li><li><p>America/Argentina/San_Luis</p></li><li><p>America/Argentina/Tucuman</p></li><li><p>America/Argentina/Ushuaia</p></li><li><p>America/Aruba</p></li><li><p>America/Asuncion</p></li><li><p>America/Atikokan</p></li><li><p>America/Atka</p></li><li><p>America/Bahia</p></li><li><p>America/Bahia_Banderas</p></li><li><p>America/Barbados</p></li><li><p>America/Belem</p></li><li><p>America/Belize</p></li><li><p>America/Blanc-Sablon</p></li><li><p>America/Boa_Vista</p></li><li><p>America/Bogota</p></li><li><p>America/Boise</p></li><li><p>America/Buenos_Aires</p></li></ul></div></div></td><td><div><div><p>America (continued):</p></div><div><ul><li><p>America/Cambridge_Bay</p></li><li><p>America/Campo_Grande</p></li><li><p>America/Cancun</p></li><li><p>America/Caracas</p></li><li><p>America/Catamarca</p></li><li><p>America/Cayenne</p></li><li><p>America/Cayman</p></li><li><p>America/Chicago</p></li><li><p>America/Chihuahua</p></li><li><p>America/Coral_Harbour</p></li><li><p>America/Cordoba</p></li><li><p>America/Costa_Rica</p></li><li><p>America/Creston</p></li><li><p>America/Cuiaba</p></li><li><p>America/Curacao</p></li><li><p>America/Danmarkshavn</p></li><li><p>America/Dawson</p></li><li><p>America/Dawson_Creek</p></li><li><p>America/Denver</p></li><li><p>America/Detroit</p></li><li><p>America/Dominica</p></li><li><p>America/Edmonton</p></li><li><p>America/Eirunepe</p></li><li><p>America/El_Salvador</p></li><li><p>America/Ensenada</p></li><li><p>America/Fort_Nelson</p></li><li><p>America/Fort_Wayne</p></li><li><p>America/Fortaleza</p></li><li><p>America/Glace_Bay</p></li><li><p>America/Godthab</p></li><li><p>America/Goose_Bay</p></li><li><p>America/Grand_Turk</p></li><li><p>America/Grenada</p></li><li><p>America/Guadeloupe</p></li><li><p>America/Guatemala</p></li><li><p>America/Guayaquil</p></li><li><p>America/Guyana</p></li><li><p>America/Halifax</p></li><li><p>America/Havana</p></li><li><p>America/Hermosillo</p></li><li><p>America/Indiana/Indianapolis</p></li><li><p>America/Indiana/Knox</p></li><li><p>America/Indiana/Marengo</p></li><li><p>America/Indiana/Petersburg</p></li><li><p>America/Indiana/Tell_City</p></li><li><p>America/Indiana/Vevay</p></li><li><p>America/Indiana/Vincennes</p></li><li><p>America/Indiana/Winamac</p></li><li><p>America/Indianapolis</p></li><li><p>America/Inuvik</p></li><li><p>America/Iqaluit</p></li><li><p>America/Jamaica</p></li><li><p>America/Jujuy</p></li><li><p>America/Juneau</p></li><li><p>America/Kentucky/Louisville</p></li><li><p>America/Kentucky/Monticello</p></li><li><p>America/Knox_IN</p></li><li><p>America/Kralendijk</p></li><li><p>America/La_Paz</p></li><li><p>America/Lima</p></li><li><p>America/Los_Angeles</p></li><li><p>America/Louisville</p></li><li><p>America/Lower_Princes</p></li><li><p>America/Maceio</p></li><li><p>America/Managua</p></li><li><p>America/Manaus</p></li><li><p>America/Marigot</p></li><li><p>America/Martinique</p></li><li><p>America/Matamoros</p></li><li><p>America/Mazatlan</p></li><li><p>America/Mendoza</p></li><li><p>America/Menominee</p></li><li><p>America/Merida</p></li><li><p>America/Metlakatla</p></li><li><p>America/Mexico_City</p></li><li><p>America/Miquelon</p></li><li><p>America/Moncton</p></li><li><p>America/Monterrey</p></li><li><p>America/Montevideo</p></li><li><p>America/Montreal</p></li><li><p>America/Montserrat</p></li><li><p>America/Nassau</p></li><li><p>America/New_York</p></li><li><p>America/Nipigon</p></li><li><p>America/Nome</p></li><li><p>America/Noronha</p></li></ul></div></div></td><td><div><div><p>America (continued):</p></div><div><ul><li><p>America/North_Dakota/Beulah</p></li><li><p>America/North_Dakota/Center</p></li><li><p>America/North_Dakota/New_Salem</p></li><li><p>America/Ojinaga</p></li><li><p>America/Panama</p></li><li><p>America/Pangnirtung</p></li><li><p>America/Paramaribo</p></li><li><p>America/Phoenix</p></li><li><p>America/Port-au-Prince</p></li><li><p>America/Port_of_Spain</p></li><li><p>America/Porto_Acre</p></li><li><p>America/Porto_Velho</p></li><li><p>America/Puerto_Rico</p></li><li><p>America/Punta_Arenas</p></li><li><p>America/Rainy_River</p></li><li><p>America/Rankin_Inlet</p></li><li><p>America/Recife</p></li><li><p>America/Regina</p></li><li><p>America/Resolute</p></li><li><p>America/Rio_Branco</p></li><li><p>America/Rosario</p></li><li><p>America/Santa_Isabel</p></li><li><p>America/Santarem</p></li><li><p>America/Santiago</p></li><li><p>America/Santo_Domingo</p></li><li><p>America/Sao_Paulo</p></li><li><p>America/Scoresbysund</p></li><li><p>America/Shiprock</p></li><li><p>America/Sitka</p></li><li><p>America/St_Barthelemy</p></li><li><p>America/St_Johns</p></li><li><p>America/St_Kitts</p></li><li><p>America/St_Lucia</p></li><li><p>America/St_Thomas</p></li><li><p>America/St_Vincent</p></li><li><p>America/Swift_Current</p></li><li><p>America/Tegucigalpa</p></li><li><p>America/Thule</p></li><li><p>America/Thunder_Bay</p></li><li><p>America/Tijuana</p></li><li><p>America/Toronto</p></li><li><p>America/Tortola</p></li><li><p>America/Vancouver</p></li><li><p>America/Virgin</p></li><li><p>America/Whitehorse</p></li><li><p>America/Winnipeg</p></li><li><p>America/Yakutat</p></li><li><p>America/Yellowknife</p></li></ul></div><div><p>Antarctica:</p></div><div><ul><li><p>Antarctica/Casey</p></li><li><p>Antarctica/Davis</p></li><li><p>Antarctica/DumontDUrville</p></li><li><p>Antarctica/Macquarie</p></li><li><p>Antarctica/Mawson</p></li><li><p>Antarctica/McMurdo</p></li><li><p>Antarctica/Palmer</p></li><li><p>Antarctica/Rothera</p></li><li><p>Antarctica/South_Pole</p></li><li><p>Antarctica/Syowa</p></li><li><p>Antarctica/Troll</p></li><li><p>Antarctica/Vostok</p></li><li><p>Arctic/Longyearbyen</p></li></ul></div><div><p>Asia:</p></div><div><ul><li><p>Asia/Aden</p></li><li><p>Asia/Almaty</p></li><li><p>Asia/Amman</p></li><li><p>Asia/Anadyr</p></li><li><p>Asia/Aqtau</p></li><li><p>Asia/Aqtobe</p></li><li><p>Asia/Ashgabat</p></li><li><p>Asia/Ashkhabad</p></li><li><p>Asia/Atyrau</p></li><li><p>Asia/Baghdad</p></li><li><p>Asia/Bahrain</p></li><li><p>Asia/Baku</p></li><li><p>Asia/Bangkok</p></li><li><p>Asia/Barnaul</p></li><li><p>Asia/Beirut</p></li><li><p>Asia/Bishkek</p></li><li><p>Asia/Brunei</p></li><li><p>Asia/Calcutta</p></li><li><p>Asia/Chita</p></li><li><p>Asia/Choibalsan</p></li><li><p>Asia/Chongqing</p></li><li><p>Asia/Chungking</p></li><li><p>Asia/Colombo</p></li></ul></div></div></td><td><div><div><p>Asia (continued):</p></div><div><ul><li><p>Asia/Dacca</p></li><li><p>Asia/Damascus</p></li><li><p>Asia/Dhaka</p></li><li><p>Asia/Dili</p></li><li><p>Asia/Dubai</p></li><li><p>Asia/Dushanbe</p></li><li><p>Asia/Famagusta</p></li><li><p>Asia/Gaza</p></li><li><p>Asia/Harbin</p></li><li><p>Asia/Hebron</p></li><li><p>Asia/Ho_Chi_Minh</p></li><li><p>Asia/Hong_Kong</p></li><li><p>Asia/Hovd</p></li><li><p>Asia/Irkutsk</p></li><li><p>Asia/Istanbul</p></li><li><p>Asia/Jakarta</p></li><li><p>Asia/Jayapura</p></li><li><p>Asia/Jerusalem</p></li><li><p>Asia/Kabul</p></li><li><p>Asia/Kamchatka</p></li><li><p>Asia/Karachi</p></li><li><p>Asia/Kashgar</p></li><li><p>Asia/Kathmandu</p></li><li><p>Asia/Katmandu</p></li><li><p>Asia/Khandyga</p></li><li><p>Asia/Kolkata</p></li><li><p>Asia/Krasnoyarsk</p></li><li><p>Asia/Kuala_Lumpur</p></li><li><p>Asia/Kuching</p></li><li><p>Asia/Kuwait</p></li><li><p>Asia/Macao</p></li><li><p>Asia/Macau</p></li><li><p>Asia/Magadan</p></li><li><p>Asia/Makassar</p></li><li><p>Asia/Manila</p></li><li><p>Asia/Muscat</p></li><li><p>Asia/Nicosia</p></li><li><p>Asia/Novokuznetsk</p></li><li><p>Asia/Novosibirsk</p></li><li><p>Asia/Omsk</p></li><li><p>Asia/Oral</p></li><li><p>Asia/Phnom_Penh</p></li><li><p>Asia/Pontianak</p></li><li><p>Asia/Pyongyang</p></li><li><p>Asia/Qatar</p></li><li><p>Asia/Qostanay</p></li><li><p>Asia/Qyzylorda</p></li><li><p>Asia/Rangoon</p></li><li><p>Asia/Riyadh</p></li><li><p>Asia/Saigon</p></li><li><p>Asia/Sakhalin</p></li><li><p>Asia/Samarkand</p></li><li><p>Asia/Seoul</p></li><li><p>Asia/Shanghai</p></li><li><p>Asia/Singapore</p></li><li><p>Asia/Srednekolymsk</p></li><li><p>Asia/Taipei</p></li><li><p>Asia/Tashkent</p></li><li><p>Asia/Tbilisi</p></li><li><p>Asia/Tehran</p></li><li><p>Asia/Tel_Aviv</p></li><li><p>Asia/Thimbu</p></li><li><p>Asia/Thimphu</p></li><li><p>Asia/Tokyo</p></li><li><p>Asia/Tomsk</p></li><li><p>Asia/Ujung_Pandang</p></li><li><p>Asia/Ulaanbaatar</p></li><li><p>Asia/Ulan_Bator</p></li><li><p>Asia/Urumqi</p></li><li><p>Asia/Ust-Nera</p></li><li><p>Asia/Vientiane</p></li><li><p>Asia/Vladivostok</p></li><li><p>Asia/Yakutsk</p></li><li><p>Asia/Yangon</p></li><li><p>Asia/Yekaterinburg</p></li><li><p>Asia/Yerevan</p></li></ul></div><div><p>Atlantic:</p></div><div><ul><li><p>Atlantic/Azores</p></li><li><p>Atlantic/Bermuda</p></li><li><p>Atlantic/Canary</p></li><li><p>Atlantic/Cape_Verde</p></li><li><p>Atlantic/Faeroe</p></li><li><p>Atlantic/Faroe</p></li><li><p>Atlantic/Jan_Mayen</p></li><li><p>Atlantic/Madeira</p></li><li><p>Atlantic/Reykjavik</p></li><li><p>Atlantic/South_Georgia</p></li><li><p>Atlantic/St_Helena</p></li><li><p>Atlantic/Stanley</p></li></ul></div></div></td><td><div><div><p>Australia:</p></div><div><ul><li><p>Australia/ACT</p></li><li><p>Australia/Adelaide</p></li><li><p>Australia/Brisbane</p></li><li><p>Australia/Broken_Hill</p></li><li><p>Australia/Canberra</p></li><li><p>Australia/Currie</p></li><li><p>Australia/Darwin</p></li><li><p>Australia/Eucla</p></li><li><p>Australia/Hobart</p></li><li><p>Australia/LHI</p></li><li><p>Australia/Lindeman</p></li><li><p>Australia/Lord_Howe</p></li><li><p>Australia/Melbourne</p></li><li><p>Australia/NSW</p></li><li><p>Australia/North</p></li><li><p>Australia/Perth</p></li><li><p>Australia/Queensland</p></li><li><p>Australia/South</p></li><li><p>Australia/Sydney</p></li><li><p>Australia/Tasmania</p></li><li><p>Australia/Victoria</p></li><li><p>Australia/West</p></li><li><p>Australia/Yancowinna</p></li></ul></div><div><p>B:</p></div><div><ul><li><p>Brazil/Acre</p></li><li><p>Brazil/DeNoronha</p></li><li><p>Brazil/East</p></li><li><p>Brazil/West</p></li></ul></div><div><p>C:</p></div><div><ul><li><p>CET</p></li><li><p>CST6CDT</p></li><li><p>Canada/Atlantic</p></li><li><p>Canada/Central</p></li><li><p>Canada/Eastern</p></li><li><p>Canada/Mountain</p></li><li><p>Canada/Newfoundland</p></li><li><p>Canada/Pacific</p></li><li><p>Canada/Saskatchewan</p></li><li><p>Canada/Yukon</p></li><li><p>Chile/Continental</p></li><li><p>Chile/EasterIsland</p></li><li><p>Cuba</p></li></ul></div><div><p>E:</p></div><div><ul><li><p>EET</p></li><li><p>EST5EDT</p></li><li><p>Egypt</p></li><li><p>Eire</p></li><li><p>Etc/GMT</p></li><li><p>Etc/GMT+0</p></li><li><p>Etc/GMT+1</p></li><li><p>Etc/GMT+10</p></li><li><p>Etc/GMT+11</p></li><li><p>Etc/GMT+12</p></li><li><p>Etc/GMT+2</p></li><li><p>Etc/GMT+3</p></li><li><p>Etc/GMT+4</p></li><li><p>Etc/GMT+5</p></li><li><p>Etc/GMT+6</p></li><li><p>Etc/GMT+7</p></li><li><p>Etc/GMT+8</p></li><li><p>Etc/GMT+9</p></li><li><p>Etc/GMT-0</p></li><li><p>Etc/GMT-1</p></li><li><p>Etc/GMT-10</p></li><li><p>Etc/GMT-11</p></li><li><p>Etc/GMT-12</p></li><li><p>Etc/GMT-13</p></li><li><p>Etc/GMT-14</p></li><li><p>Etc/GMT-2</p></li><li><p>Etc/GMT-3</p></li><li><p>Etc/GMT-4</p></li><li><p>Etc/GMT-5</p></li><li><p>Etc/GMT-6</p></li><li><p>Etc/GMT-7</p></li><li><p>Etc/GMT-8</p></li><li><p>Etc/GMT-9</p></li><li><p>Etc/GMT0</p></li><li><p>Etc/Greenwich</p></li><li><p>Etc/UCT</p></li><li><p>Etc/UTC</p></li><li><p>Etc/Universal</p></li><li><p>Etc/Zulu</p></li></ul></div></div></td><td><div><div><p>E (continued):</p></div><div><ul><li><p>Europe/Amsterdam</p></li><li><p>Europe/Andorra</p></li><li><p>Europe/Astrakhan</p></li><li><p>Europe/Athens</p></li><li><p>Europe/Belfast</p></li><li><p>Europe/Belgrade</p></li><li><p>Europe/Berlin</p></li><li><p>Europe/Bratislava</p></li><li><p>Europe/Brussels</p></li><li><p>Europe/Bucharest</p></li><li><p>Europe/Budapest</p></li><li><p>Europe/Busingen</p></li><li><p>Europe/Chisinau</p></li><li><p>Europe/Copenhagen</p></li><li><p>Europe/Dublin</p></li><li><p>Europe/Gibraltar</p></li><li><p>Europe/Guernsey</p></li><li><p>Europe/Helsinki</p></li><li><p>Europe/Isle_of_Man</p></li><li><p>Europe/Istanbul</p></li><li><p>Europe/Jersey</p></li><li><p>Europe/Kaliningrad</p></li><li><p>Europe/Kiev</p></li><li><p>Europe/Kirov</p></li><li><p>Europe/Lisbon</p></li><li><p>Europe/Ljubljana</p></li><li><p>Europe/London</p></li><li><p>Europe/Luxembourg</p></li><li><p>Europe/Madrid</p></li><li><p>Europe/Malta</p></li><li><p>Europe/Mariehamn</p></li><li><p>Europe/Minsk</p></li><li><p>Europe/Monaco</p></li><li><p>Europe/Moscow</p></li><li><p>Europe/Nicosia</p></li><li><p>Europe/Oslo</p></li><li><p>Europe/Paris</p></li><li><p>Europe/Podgorica</p></li><li><p>Europe/Prague</p></li><li><p>Europe/Riga</p></li><li><p>Europe/Rome</p></li><li><p>Europe/Samara</p></li><li><p>Europe/San_Marino</p></li><li><p>Europe/Sarajevo</p></li><li><p>Europe/Saratov</p></li><li><p>Europe/Skopje</p></li><li><p>Europe/Sofia</p></li><li><p>Europe/Stockholm</p></li><li><p>Europe/Tallinn</p></li><li><p>Europe/Tirane</p></li><li><p>Europe/Tiraspol</p></li><li><p>Europe/Ulyanovsk</p></li><li><p>Europe/Uzhgorod</p></li><li><p>Europe/Vaduz</p></li><li><p>Europe/Vatican</p></li><li><p>Europe/Vienna</p></li><li><p>Europe/Vilnius</p></li><li><p>Europe/Volgograd</p></li><li><p>Europe/Warsaw</p></li><li><p>Europe/Zagreb</p></li><li><p>Europe/Zaporozhye</p></li><li><p>Europe/Zurich</p></li></ul></div><div><p>G:</p></div><div><ul><li><p>GB</p></li><li><p>GB-Eire</p></li><li><p>GMT</p></li><li><p>GMT0</p></li><li><p>Greenwich</p></li></ul></div><div><p>H:</p></div><div><ul><li><p>Hongkong</p></li></ul></div><div><p>I:</p></div><div><ul><li><p>Iceland</p></li><li><p>Indian/Antananarivo</p></li><li><p>Indian/Chagos</p></li><li><p>Indian/Christmas</p></li><li><p>Indian/Cocos</p></li><li><p>Indian/Comoro</p></li><li><p>Indian/Kerguelen</p></li><li><p>Indian/Mahe</p></li><li><p>Indian/Maldives</p></li><li><p>Indian/Mauritius</p></li><li><p>Indian/Mayotte</p></li><li><p>Indian/Reunion</p></li><li><p>Iran</p></li><li><p>Israel</p></li></ul></div></div></td><td><div><div><p>J:</p></div><div><ul><li><p>Jamaica</p></li><li><p>Japan</p></li></ul></div><div><p>K:</p></div><div><ul><li><p>Kwajalein</p></li></ul></div><div><p>L:</p></div><div><ul><li><p>Libya</p></li></ul></div><div><p>M:</p></div><div><ul><li><p>MET</p></li><li><p>MST7MDT</p></li><li><p>Mexico/BajaNorte</p></li><li><p>Mexico/BajaSur</p></li><li><p>Mexico/General</p></li></ul></div><div><p>N:</p></div><div><ul><li><p>NZ</p></li><li><p>NZ-CHAT</p></li><li><p>Navajo</p></li></ul></div><div><p>P:</p></div><div><ul><li><p>PRC</p></li><li><p>PST8PDT</p></li><li><p>Pacific/Apia</p></li><li><p>Pacific/Auckland</p></li><li><p>Pacific/Bougainville</p></li><li><p>Pacific/Chatham</p></li><li><p>Pacific/Chuuk</p></li><li><p>Pacific/Easter</p></li><li><p>Pacific/Efate</p></li><li><p>Pacific/Enderbury</p></li><li><p>Pacific/Fakaofo</p></li><li><p>Pacific/Fiji</p></li><li><p>Pacific/Funafuti</p></li><li><p>Pacific/Galapagos</p></li><li><p>Pacific/Gambier</p></li><li><p>Pacific/Guadalcanal</p></li><li><p>Pacific/Guam</p></li><li><p>Pacific/Honolulu</p></li><li><p>Pacific/Johnston</p></li><li><p>Pacific/Kiritimati</p></li><li><p>Pacific/Kosrae</p></li><li><p>Pacific/Kwajalein</p></li><li><p>Pacific/Majuro</p></li><li><p>Pacific/Marquesas</p></li><li><p>Pacific/Midway</p></li><li><p>Pacific/Nauru</p></li><li><p>Pacific/Niue</p></li><li><p>Pacific/Norfolk</p></li><li><p>Pacific/Noumea</p></li><li><p>Pacific/Pago_Pago</p></li><li><p>Pacific/Palau</p></li><li><p>Pacific/Pitcairn</p></li><li><p>Pacific/Pohnpei</p></li><li><p>Pacific/Ponape</p></li><li><p>Pacific/Port_Moresby</p></li><li><p>Pacific/Rarotonga</p></li><li><p>Pacific/Saipan</p></li><li><p>Pacific/Samoa</p></li><li><p>Pacific/Tahiti</p></li><li><p>Pacific/Tarawa</p></li><li><p>Pacific/Tongatapu</p></li><li><p>Pacific/Truk</p></li><li><p>Pacific/Wake</p></li><li><p>Pacific/Wallis</p></li><li><p>Pacific/Yap</p></li><li><p>Poland</p></li><li><p>Portugal</p></li></ul></div><div><p>R:</p></div><div><ul><li><p>ROK</p></li></ul></div><div><p>S:</p></div><div><ul><li><p>Singapore</p></li><li><p>SystemV/AST4</p></li><li><p>SystemV/AST4ADT</p></li><li><p>SystemV/CST6</p></li><li><p>SystemV/CST6CDT</p></li><li><p>SystemV/EST5</p></li><li><p>SystemV/EST5EDT</p></li><li><p>SystemV/HST10</p></li><li><p>SystemV/MST7</p></li><li><p>SystemV/MST7MDT</p></li><li><p>SystemV/PST8</p></li><li><p>SystemV/PST8PDT</p></li><li><p>SystemV/YST9</p></li><li><p>SystemV/YST9YDT</p></li></ul></div></div></td><td><div><div><p>T:</p></div><div><ul><li><p>Turkey</p></li></ul></div><div><p>U:</p></div><div><ul><li><p>UCT</p></li><li><p>US/Alaska</p></li><li><p>US/Aleutian</p></li><li><p>US/Arizona</p></li><li><p>US/Central</p></li><li><p>US/East-Indiana</p></li><li><p>US/Eastern</p></li><li><p>US/Hawaii</p></li><li><p>US/Indiana-Starke</p></li><li><p>US/Michigan</p></li><li><p>US/Mountain</p></li><li><p>US/Pacific</p></li><li><p>US/Pacific-New</p></li><li><p>US/Samoa</p></li><li><p>UTC</p></li><li><p>Universal</p></li></ul></div><div><p>W:</p></div><div><ul><li><p>W-SU</p></li><li><p>WET</p></li></ul></div><div><p>Z:</p></div><div><ul><li><p>Zulu</p></li></ul></div></div></td></tr></tbody></table>

## Related Examples

- [Format Dates and Times](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-format-dates)

- [Parse Dates with DataWeave](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-parse-dates)

- [Add and Subtract Time](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-add-and-subtract-time)

## See Also

- [Date and Time (dw::Core Types)](https://docs.mulesoft.com/dataweave/2.6/dataweave-types#dw_type_dates)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.6/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook)

<!-- document id=c7d94091b4912e5ff438137a5624f9bd739d0c6a85c87b60904fab668c02bc5c url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook-change-time-zone.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, date, time
---

# Change a Time Zone

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following example uses the `>>` operator and a [time zone ID](#timezone-ids) to change the time
zone. It also uses the formatting characters `uuuu-MM-dd'T'HH:mm:ss.SSS` to modify the format. The
`uuuu` characters represent the year.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
fun format(d: DateTime) = d as String {format: "yyyy-MM-dd'T'HH:mm:ss.SSS"}
---
{
    CreatedDateTime: format(|2019-02-13T13:23:00.120Z| >> "CET"),
}
```

Output JSON:

```JSON
{
    "CreatedDateTime": "2019-02-13T14:23:00.120"
}
```

## Time Zone IDs

In addition to accepting time zone values such as `-07:00`, DataWeave accepts Java 8 `TimeZone` ID
values, which are available through a Java method call to `ZoneId.getAvailableZoneIds()`.

To see all available values in the following table, scroll right.

<table><colgroup><col> <col> <col> <col> <col> <col> <col> <col></colgroup><thead><tr><th></th><th></th><th></th><th></th><th></th><th></th><th></th><th></th></tr></thead><tbody><tr><td><div><div><p>Africa:</p></div><div><ul><li><p>Africa/Abidjan</p></li><li><p>Africa/Accra</p></li><li><p>Africa/Addis_Ababa</p></li><li><p>Africa/Algiers</p></li><li><p>Africa/Asmara</p></li><li><p>Africa/Asmera</p></li><li><p>Africa/Bamako</p></li><li><p>Africa/Bangui</p></li><li><p>Africa/Banjul</p></li><li><p>Africa/Bissau</p></li><li><p>Africa/Blantyre</p></li><li><p>Africa/Brazzaville</p></li><li><p>Africa/Bujumbura</p></li><li><p>Africa/Cairo</p></li><li><p>Africa/Casablanca</p></li><li><p>Africa/Ceuta</p></li><li><p>Africa/Conakry</p></li><li><p>Africa/Dakar</p></li><li><p>Africa/Dar_es_Salaam</p></li><li><p>Africa/Djibouti</p></li><li><p>Africa/Douala</p></li><li><p>Africa/El_Aaiun</p></li><li><p>Africa/Freetown</p></li><li><p>Africa/Gaborone</p></li><li><p>Africa/Harare</p></li><li><p>Africa/Johannesburg</p></li><li><p>Africa/Juba</p></li><li><p>Africa/Kampala</p></li><li><p>Africa/Khartoum</p></li><li><p>Africa/Kigali</p></li><li><p>Africa/Kinshasa</p></li><li><p>Africa/Lagos</p></li><li><p>Africa/Libreville</p></li><li><p>Africa/Lome</p></li><li><p>Africa/Luanda</p></li><li><p>Africa/Lubumbashi</p></li><li><p>Africa/Lusaka</p></li><li><p>Africa/Malabo</p></li><li><p>Africa/Maputo</p></li><li><p>Africa/Maseru</p></li><li><p>Africa/Mbabane</p></li><li><p>Africa/Mogadishu</p></li><li><p>Africa/Monrovia</p></li><li><p>Africa/Nairobi</p></li><li><p>Africa/Ndjamena</p></li><li><p>Africa/Niamey</p></li><li><p>Africa/Nouakchott</p></li><li><p>Africa/Ouagadougou</p></li><li><p>Africa/Porto-Novo</p></li><li><p>Africa/Sao_Tome</p></li><li><p>Africa/Timbuktu</p></li><li><p>Africa/Tripoli</p></li><li><p>Africa/Tunis</p></li><li><p>Africa/Windhoek</p></li></ul></div><div><p>America:</p></div><div><ul><li><p>America/Adak</p></li><li><p>America/Anchorage</p></li><li><p>America/Anguilla</p></li><li><p>America/Antigua</p></li><li><p>America/Araguaina</p></li><li><p>America/Argentina/Buenos_Aires</p></li><li><p>America/Argentina/Catamarca</p></li><li><p>America/Argentina/ComodRivadavia</p></li><li><p>America/Argentina/Cordoba</p></li><li><p>America/Argentina/Jujuy</p></li><li><p>America/Argentina/La_Rioja</p></li><li><p>America/Argentina/Mendoza</p></li><li><p>America/Argentina/Rio_Gallegos</p></li><li><p>America/Argentina/Salta</p></li><li><p>America/Argentina/San_Juan</p></li><li><p>America/Argentina/San_Luis</p></li><li><p>America/Argentina/Tucuman</p></li><li><p>America/Argentina/Ushuaia</p></li><li><p>America/Aruba</p></li><li><p>America/Asuncion</p></li><li><p>America/Atikokan</p></li><li><p>America/Atka</p></li><li><p>America/Bahia</p></li><li><p>America/Bahia_Banderas</p></li><li><p>America/Barbados</p></li><li><p>America/Belem</p></li><li><p>America/Belize</p></li><li><p>America/Blanc-Sablon</p></li><li><p>America/Boa_Vista</p></li><li><p>America/Bogota</p></li><li><p>America/Boise</p></li><li><p>America/Buenos_Aires</p></li></ul></div></div></td><td><div><div><p>America (continued):</p></div><div><ul><li><p>America/Cambridge_Bay</p></li><li><p>America/Campo_Grande</p></li><li><p>America/Cancun</p></li><li><p>America/Caracas</p></li><li><p>America/Catamarca</p></li><li><p>America/Cayenne</p></li><li><p>America/Cayman</p></li><li><p>America/Chicago</p></li><li><p>America/Chihuahua</p></li><li><p>America/Coral_Harbour</p></li><li><p>America/Cordoba</p></li><li><p>America/Costa_Rica</p></li><li><p>America/Creston</p></li><li><p>America/Cuiaba</p></li><li><p>America/Curacao</p></li><li><p>America/Danmarkshavn</p></li><li><p>America/Dawson</p></li><li><p>America/Dawson_Creek</p></li><li><p>America/Denver</p></li><li><p>America/Detroit</p></li><li><p>America/Dominica</p></li><li><p>America/Edmonton</p></li><li><p>America/Eirunepe</p></li><li><p>America/El_Salvador</p></li><li><p>America/Ensenada</p></li><li><p>America/Fort_Nelson</p></li><li><p>America/Fort_Wayne</p></li><li><p>America/Fortaleza</p></li><li><p>America/Glace_Bay</p></li><li><p>America/Godthab</p></li><li><p>America/Goose_Bay</p></li><li><p>America/Grand_Turk</p></li><li><p>America/Grenada</p></li><li><p>America/Guadeloupe</p></li><li><p>America/Guatemala</p></li><li><p>America/Guayaquil</p></li><li><p>America/Guyana</p></li><li><p>America/Halifax</p></li><li><p>America/Havana</p></li><li><p>America/Hermosillo</p></li><li><p>America/Indiana/Indianapolis</p></li><li><p>America/Indiana/Knox</p></li><li><p>America/Indiana/Marengo</p></li><li><p>America/Indiana/Petersburg</p></li><li><p>America/Indiana/Tell_City</p></li><li><p>America/Indiana/Vevay</p></li><li><p>America/Indiana/Vincennes</p></li><li><p>America/Indiana/Winamac</p></li><li><p>America/Indianapolis</p></li><li><p>America/Inuvik</p></li><li><p>America/Iqaluit</p></li><li><p>America/Jamaica</p></li><li><p>America/Jujuy</p></li><li><p>America/Juneau</p></li><li><p>America/Kentucky/Louisville</p></li><li><p>America/Kentucky/Monticello</p></li><li><p>America/Knox_IN</p></li><li><p>America/Kralendijk</p></li><li><p>America/La_Paz</p></li><li><p>America/Lima</p></li><li><p>America/Los_Angeles</p></li><li><p>America/Louisville</p></li><li><p>America/Lower_Princes</p></li><li><p>America/Maceio</p></li><li><p>America/Managua</p></li><li><p>America/Manaus</p></li><li><p>America/Marigot</p></li><li><p>America/Martinique</p></li><li><p>America/Matamoros</p></li><li><p>America/Mazatlan</p></li><li><p>America/Mendoza</p></li><li><p>America/Menominee</p></li><li><p>America/Merida</p></li><li><p>America/Metlakatla</p></li><li><p>America/Mexico_City</p></li><li><p>America/Miquelon</p></li><li><p>America/Moncton</p></li><li><p>America/Monterrey</p></li><li><p>America/Montevideo</p></li><li><p>America/Montreal</p></li><li><p>America/Montserrat</p></li><li><p>America/Nassau</p></li><li><p>America/New_York</p></li><li><p>America/Nipigon</p></li><li><p>America/Nome</p></li><li><p>America/Noronha</p></li></ul></div></div></td><td><div><div><p>America (continued):</p></div><div><ul><li><p>America/North_Dakota/Beulah</p></li><li><p>America/North_Dakota/Center</p></li><li><p>America/North_Dakota/New_Salem</p></li><li><p>America/Ojinaga</p></li><li><p>America/Panama</p></li><li><p>America/Pangnirtung</p></li><li><p>America/Paramaribo</p></li><li><p>America/Phoenix</p></li><li><p>America/Port-au-Prince</p></li><li><p>America/Port_of_Spain</p></li><li><p>America/Porto_Acre</p></li><li><p>America/Porto_Velho</p></li><li><p>America/Puerto_Rico</p></li><li><p>America/Punta_Arenas</p></li><li><p>America/Rainy_River</p></li><li><p>America/Rankin_Inlet</p></li><li><p>America/Recife</p></li><li><p>America/Regina</p></li><li><p>America/Resolute</p></li><li><p>America/Rio_Branco</p></li><li><p>America/Rosario</p></li><li><p>America/Santa_Isabel</p></li><li><p>America/Santarem</p></li><li><p>America/Santiago</p></li><li><p>America/Santo_Domingo</p></li><li><p>America/Sao_Paulo</p></li><li><p>America/Scoresbysund</p></li><li><p>America/Shiprock</p></li><li><p>America/Sitka</p></li><li><p>America/St_Barthelemy</p></li><li><p>America/St_Johns</p></li><li><p>America/St_Kitts</p></li><li><p>America/St_Lucia</p></li><li><p>America/St_Thomas</p></li><li><p>America/St_Vincent</p></li><li><p>America/Swift_Current</p></li><li><p>America/Tegucigalpa</p></li><li><p>America/Thule</p></li><li><p>America/Thunder_Bay</p></li><li><p>America/Tijuana</p></li><li><p>America/Toronto</p></li><li><p>America/Tortola</p></li><li><p>America/Vancouver</p></li><li><p>America/Virgin</p></li><li><p>America/Whitehorse</p></li><li><p>America/Winnipeg</p></li><li><p>America/Yakutat</p></li><li><p>America/Yellowknife</p></li></ul></div><div><p>Antarctica:</p></div><div><ul><li><p>Antarctica/Casey</p></li><li><p>Antarctica/Davis</p></li><li><p>Antarctica/DumontDUrville</p></li><li><p>Antarctica/Macquarie</p></li><li><p>Antarctica/Mawson</p></li><li><p>Antarctica/McMurdo</p></li><li><p>Antarctica/Palmer</p></li><li><p>Antarctica/Rothera</p></li><li><p>Antarctica/South_Pole</p></li><li><p>Antarctica/Syowa</p></li><li><p>Antarctica/Troll</p></li><li><p>Antarctica/Vostok</p></li><li><p>Arctic/Longyearbyen</p></li></ul></div><div><p>Asia:</p></div><div><ul><li><p>Asia/Aden</p></li><li><p>Asia/Almaty</p></li><li><p>Asia/Amman</p></li><li><p>Asia/Anadyr</p></li><li><p>Asia/Aqtau</p></li><li><p>Asia/Aqtobe</p></li><li><p>Asia/Ashgabat</p></li><li><p>Asia/Ashkhabad</p></li><li><p>Asia/Atyrau</p></li><li><p>Asia/Baghdad</p></li><li><p>Asia/Bahrain</p></li><li><p>Asia/Baku</p></li><li><p>Asia/Bangkok</p></li><li><p>Asia/Barnaul</p></li><li><p>Asia/Beirut</p></li><li><p>Asia/Bishkek</p></li><li><p>Asia/Brunei</p></li><li><p>Asia/Calcutta</p></li><li><p>Asia/Chita</p></li><li><p>Asia/Choibalsan</p></li><li><p>Asia/Chongqing</p></li><li><p>Asia/Chungking</p></li><li><p>Asia/Colombo</p></li></ul></div></div></td><td><div><div><p>Asia (continued):</p></div><div><ul><li><p>Asia/Dacca</p></li><li><p>Asia/Damascus</p></li><li><p>Asia/Dhaka</p></li><li><p>Asia/Dili</p></li><li><p>Asia/Dubai</p></li><li><p>Asia/Dushanbe</p></li><li><p>Asia/Famagusta</p></li><li><p>Asia/Gaza</p></li><li><p>Asia/Harbin</p></li><li><p>Asia/Hebron</p></li><li><p>Asia/Ho_Chi_Minh</p></li><li><p>Asia/Hong_Kong</p></li><li><p>Asia/Hovd</p></li><li><p>Asia/Irkutsk</p></li><li><p>Asia/Istanbul</p></li><li><p>Asia/Jakarta</p></li><li><p>Asia/Jayapura</p></li><li><p>Asia/Jerusalem</p></li><li><p>Asia/Kabul</p></li><li><p>Asia/Kamchatka</p></li><li><p>Asia/Karachi</p></li><li><p>Asia/Kashgar</p></li><li><p>Asia/Kathmandu</p></li><li><p>Asia/Katmandu</p></li><li><p>Asia/Khandyga</p></li><li><p>Asia/Kolkata</p></li><li><p>Asia/Krasnoyarsk</p></li><li><p>Asia/Kuala_Lumpur</p></li><li><p>Asia/Kuching</p></li><li><p>Asia/Kuwait</p></li><li><p>Asia/Macao</p></li><li><p>Asia/Macau</p></li><li><p>Asia/Magadan</p></li><li><p>Asia/Makassar</p></li><li><p>Asia/Manila</p></li><li><p>Asia/Muscat</p></li><li><p>Asia/Nicosia</p></li><li><p>Asia/Novokuznetsk</p></li><li><p>Asia/Novosibirsk</p></li><li><p>Asia/Omsk</p></li><li><p>Asia/Oral</p></li><li><p>Asia/Phnom_Penh</p></li><li><p>Asia/Pontianak</p></li><li><p>Asia/Pyongyang</p></li><li><p>Asia/Qatar</p></li><li><p>Asia/Qostanay</p></li><li><p>Asia/Qyzylorda</p></li><li><p>Asia/Rangoon</p></li><li><p>Asia/Riyadh</p></li><li><p>Asia/Saigon</p></li><li><p>Asia/Sakhalin</p></li><li><p>Asia/Samarkand</p></li><li><p>Asia/Seoul</p></li><li><p>Asia/Shanghai</p></li><li><p>Asia/Singapore</p></li><li><p>Asia/Srednekolymsk</p></li><li><p>Asia/Taipei</p></li><li><p>Asia/Tashkent</p></li><li><p>Asia/Tbilisi</p></li><li><p>Asia/Tehran</p></li><li><p>Asia/Tel_Aviv</p></li><li><p>Asia/Thimbu</p></li><li><p>Asia/Thimphu</p></li><li><p>Asia/Tokyo</p></li><li><p>Asia/Tomsk</p></li><li><p>Asia/Ujung_Pandang</p></li><li><p>Asia/Ulaanbaatar</p></li><li><p>Asia/Ulan_Bator</p></li><li><p>Asia/Urumqi</p></li><li><p>Asia/Ust-Nera</p></li><li><p>Asia/Vientiane</p></li><li><p>Asia/Vladivostok</p></li><li><p>Asia/Yakutsk</p></li><li><p>Asia/Yangon</p></li><li><p>Asia/Yekaterinburg</p></li><li><p>Asia/Yerevan</p></li></ul></div><div><p>Atlantic:</p></div><div><ul><li><p>Atlantic/Azores</p></li><li><p>Atlantic/Bermuda</p></li><li><p>Atlantic/Canary</p></li><li><p>Atlantic/Cape_Verde</p></li><li><p>Atlantic/Faeroe</p></li><li><p>Atlantic/Faroe</p></li><li><p>Atlantic/Jan_Mayen</p></li><li><p>Atlantic/Madeira</p></li><li><p>Atlantic/Reykjavik</p></li><li><p>Atlantic/South_Georgia</p></li><li><p>Atlantic/St_Helena</p></li><li><p>Atlantic/Stanley</p></li></ul></div></div></td><td><div><div><p>Australia:</p></div><div><ul><li><p>Australia/ACT</p></li><li><p>Australia/Adelaide</p></li><li><p>Australia/Brisbane</p></li><li><p>Australia/Broken_Hill</p></li><li><p>Australia/Canberra</p></li><li><p>Australia/Currie</p></li><li><p>Australia/Darwin</p></li><li><p>Australia/Eucla</p></li><li><p>Australia/Hobart</p></li><li><p>Australia/LHI</p></li><li><p>Australia/Lindeman</p></li><li><p>Australia/Lord_Howe</p></li><li><p>Australia/Melbourne</p></li><li><p>Australia/NSW</p></li><li><p>Australia/North</p></li><li><p>Australia/Perth</p></li><li><p>Australia/Queensland</p></li><li><p>Australia/South</p></li><li><p>Australia/Sydney</p></li><li><p>Australia/Tasmania</p></li><li><p>Australia/Victoria</p></li><li><p>Australia/West</p></li><li><p>Australia/Yancowinna</p></li></ul></div><div><p>B:</p></div><div><ul><li><p>Brazil/Acre</p></li><li><p>Brazil/DeNoronha</p></li><li><p>Brazil/East</p></li><li><p>Brazil/West</p></li></ul></div><div><p>C:</p></div><div><ul><li><p>CET</p></li><li><p>CST6CDT</p></li><li><p>Canada/Atlantic</p></li><li><p>Canada/Central</p></li><li><p>Canada/Eastern</p></li><li><p>Canada/Mountain</p></li><li><p>Canada/Newfoundland</p></li><li><p>Canada/Pacific</p></li><li><p>Canada/Saskatchewan</p></li><li><p>Canada/Yukon</p></li><li><p>Chile/Continental</p></li><li><p>Chile/EasterIsland</p></li><li><p>Cuba</p></li></ul></div><div><p>E:</p></div><div><ul><li><p>EET</p></li><li><p>EST5EDT</p></li><li><p>Egypt</p></li><li><p>Eire</p></li><li><p>Etc/GMT</p></li><li><p>Etc/GMT+0</p></li><li><p>Etc/GMT+1</p></li><li><p>Etc/GMT+10</p></li><li><p>Etc/GMT+11</p></li><li><p>Etc/GMT+12</p></li><li><p>Etc/GMT+2</p></li><li><p>Etc/GMT+3</p></li><li><p>Etc/GMT+4</p></li><li><p>Etc/GMT+5</p></li><li><p>Etc/GMT+6</p></li><li><p>Etc/GMT+7</p></li><li><p>Etc/GMT+8</p></li><li><p>Etc/GMT+9</p></li><li><p>Etc/GMT-0</p></li><li><p>Etc/GMT-1</p></li><li><p>Etc/GMT-10</p></li><li><p>Etc/GMT-11</p></li><li><p>Etc/GMT-12</p></li><li><p>Etc/GMT-13</p></li><li><p>Etc/GMT-14</p></li><li><p>Etc/GMT-2</p></li><li><p>Etc/GMT-3</p></li><li><p>Etc/GMT-4</p></li><li><p>Etc/GMT-5</p></li><li><p>Etc/GMT-6</p></li><li><p>Etc/GMT-7</p></li><li><p>Etc/GMT-8</p></li><li><p>Etc/GMT-9</p></li><li><p>Etc/GMT0</p></li><li><p>Etc/Greenwich</p></li><li><p>Etc/UCT</p></li><li><p>Etc/UTC</p></li><li><p>Etc/Universal</p></li><li><p>Etc/Zulu</p></li></ul></div></div></td><td><div><div><p>E (continued):</p></div><div><ul><li><p>Europe/Amsterdam</p></li><li><p>Europe/Andorra</p></li><li><p>Europe/Astrakhan</p></li><li><p>Europe/Athens</p></li><li><p>Europe/Belfast</p></li><li><p>Europe/Belgrade</p></li><li><p>Europe/Berlin</p></li><li><p>Europe/Bratislava</p></li><li><p>Europe/Brussels</p></li><li><p>Europe/Bucharest</p></li><li><p>Europe/Budapest</p></li><li><p>Europe/Busingen</p></li><li><p>Europe/Chisinau</p></li><li><p>Europe/Copenhagen</p></li><li><p>Europe/Dublin</p></li><li><p>Europe/Gibraltar</p></li><li><p>Europe/Guernsey</p></li><li><p>Europe/Helsinki</p></li><li><p>Europe/Isle_of_Man</p></li><li><p>Europe/Istanbul</p></li><li><p>Europe/Jersey</p></li><li><p>Europe/Kaliningrad</p></li><li><p>Europe/Kiev</p></li><li><p>Europe/Kirov</p></li><li><p>Europe/Lisbon</p></li><li><p>Europe/Ljubljana</p></li><li><p>Europe/London</p></li><li><p>Europe/Luxembourg</p></li><li><p>Europe/Madrid</p></li><li><p>Europe/Malta</p></li><li><p>Europe/Mariehamn</p></li><li><p>Europe/Minsk</p></li><li><p>Europe/Monaco</p></li><li><p>Europe/Moscow</p></li><li><p>Europe/Nicosia</p></li><li><p>Europe/Oslo</p></li><li><p>Europe/Paris</p></li><li><p>Europe/Podgorica</p></li><li><p>Europe/Prague</p></li><li><p>Europe/Riga</p></li><li><p>Europe/Rome</p></li><li><p>Europe/Samara</p></li><li><p>Europe/San_Marino</p></li><li><p>Europe/Sarajevo</p></li><li><p>Europe/Saratov</p></li><li><p>Europe/Skopje</p></li><li><p>Europe/Sofia</p></li><li><p>Europe/Stockholm</p></li><li><p>Europe/Tallinn</p></li><li><p>Europe/Tirane</p></li><li><p>Europe/Tiraspol</p></li><li><p>Europe/Ulyanovsk</p></li><li><p>Europe/Uzhgorod</p></li><li><p>Europe/Vaduz</p></li><li><p>Europe/Vatican</p></li><li><p>Europe/Vienna</p></li><li><p>Europe/Vilnius</p></li><li><p>Europe/Volgograd</p></li><li><p>Europe/Warsaw</p></li><li><p>Europe/Zagreb</p></li><li><p>Europe/Zaporozhye</p></li><li><p>Europe/Zurich</p></li></ul></div><div><p>G:</p></div><div><ul><li><p>GB</p></li><li><p>GB-Eire</p></li><li><p>GMT</p></li><li><p>GMT0</p></li><li><p>Greenwich</p></li></ul></div><div><p>H:</p></div><div><ul><li><p>Hongkong</p></li></ul></div><div><p>I:</p></div><div><ul><li><p>Iceland</p></li><li><p>Indian/Antananarivo</p></li><li><p>Indian/Chagos</p></li><li><p>Indian/Christmas</p></li><li><p>Indian/Cocos</p></li><li><p>Indian/Comoro</p></li><li><p>Indian/Kerguelen</p></li><li><p>Indian/Mahe</p></li><li><p>Indian/Maldives</p></li><li><p>Indian/Mauritius</p></li><li><p>Indian/Mayotte</p></li><li><p>Indian/Reunion</p></li><li><p>Iran</p></li><li><p>Israel</p></li></ul></div></div></td><td><div><div><p>J:</p></div><div><ul><li><p>Jamaica</p></li><li><p>Japan</p></li></ul></div><div><p>K:</p></div><div><ul><li><p>Kwajalein</p></li></ul></div><div><p>L:</p></div><div><ul><li><p>Libya</p></li></ul></div><div><p>M:</p></div><div><ul><li><p>MET</p></li><li><p>MST7MDT</p></li><li><p>Mexico/BajaNorte</p></li><li><p>Mexico/BajaSur</p></li><li><p>Mexico/General</p></li></ul></div><div><p>N:</p></div><div><ul><li><p>NZ</p></li><li><p>NZ-CHAT</p></li><li><p>Navajo</p></li></ul></div><div><p>P:</p></div><div><ul><li><p>PRC</p></li><li><p>PST8PDT</p></li><li><p>Pacific/Apia</p></li><li><p>Pacific/Auckland</p></li><li><p>Pacific/Bougainville</p></li><li><p>Pacific/Chatham</p></li><li><p>Pacific/Chuuk</p></li><li><p>Pacific/Easter</p></li><li><p>Pacific/Efate</p></li><li><p>Pacific/Enderbury</p></li><li><p>Pacific/Fakaofo</p></li><li><p>Pacific/Fiji</p></li><li><p>Pacific/Funafuti</p></li><li><p>Pacific/Galapagos</p></li><li><p>Pacific/Gambier</p></li><li><p>Pacific/Guadalcanal</p></li><li><p>Pacific/Guam</p></li><li><p>Pacific/Honolulu</p></li><li><p>Pacific/Johnston</p></li><li><p>Pacific/Kiritimati</p></li><li><p>Pacific/Kosrae</p></li><li><p>Pacific/Kwajalein</p></li><li><p>Pacific/Majuro</p></li><li><p>Pacific/Marquesas</p></li><li><p>Pacific/Midway</p></li><li><p>Pacific/Nauru</p></li><li><p>Pacific/Niue</p></li><li><p>Pacific/Norfolk</p></li><li><p>Pacific/Noumea</p></li><li><p>Pacific/Pago_Pago</p></li><li><p>Pacific/Palau</p></li><li><p>Pacific/Pitcairn</p></li><li><p>Pacific/Pohnpei</p></li><li><p>Pacific/Ponape</p></li><li><p>Pacific/Port_Moresby</p></li><li><p>Pacific/Rarotonga</p></li><li><p>Pacific/Saipan</p></li><li><p>Pacific/Samoa</p></li><li><p>Pacific/Tahiti</p></li><li><p>Pacific/Tarawa</p></li><li><p>Pacific/Tongatapu</p></li><li><p>Pacific/Truk</p></li><li><p>Pacific/Wake</p></li><li><p>Pacific/Wallis</p></li><li><p>Pacific/Yap</p></li><li><p>Poland</p></li><li><p>Portugal</p></li></ul></div><div><p>R:</p></div><div><ul><li><p>ROK</p></li></ul></div><div><p>S:</p></div><div><ul><li><p>Singapore</p></li><li><p>SystemV/AST4</p></li><li><p>SystemV/AST4ADT</p></li><li><p>SystemV/CST6</p></li><li><p>SystemV/CST6CDT</p></li><li><p>SystemV/EST5</p></li><li><p>SystemV/EST5EDT</p></li><li><p>SystemV/HST10</p></li><li><p>SystemV/MST7</p></li><li><p>SystemV/MST7MDT</p></li><li><p>SystemV/PST8</p></li><li><p>SystemV/PST8PDT</p></li><li><p>SystemV/YST9</p></li><li><p>SystemV/YST9YDT</p></li></ul></div></div></td><td><div><div><p>T:</p></div><div><ul><li><p>Turkey</p></li></ul></div><div><p>U:</p></div><div><ul><li><p>UCT</p></li><li><p>US/Alaska</p></li><li><p>US/Aleutian</p></li><li><p>US/Arizona</p></li><li><p>US/Central</p></li><li><p>US/East-Indiana</p></li><li><p>US/Eastern</p></li><li><p>US/Hawaii</p></li><li><p>US/Indiana-Starke</p></li><li><p>US/Michigan</p></li><li><p>US/Mountain</p></li><li><p>US/Pacific</p></li><li><p>US/Pacific-New</p></li><li><p>US/Samoa</p></li><li><p>UTC</p></li><li><p>Universal</p></li></ul></div><div><p>W:</p></div><div><ul><li><p>W-SU</p></li><li><p>WET</p></li></ul></div><div><p>Z:</p></div><div><ul><li><p>Zulu</p></li></ul></div></div></td></tr></tbody></table>

## Related Examples

- [Format Dates and Times](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-format-dates)

- [Parse Dates with DataWeave](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-parse-dates)

- [Add and Subtract Time](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-add-and-subtract-time)

## See Also

- [Date and Time (dw::Core Types)](https://docs.mulesoft.com/dataweave/2.9/dataweave-types#dw_type_dates)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.9/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook)

<!-- document id=ded69669647b0a690cf5ce8fd196b4c2ed890154fe009dc6772894b921769827 url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook-change-time-zone.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, date, time
---

# Change a Time Zone

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following example uses the `>>` operator and a [time zone ID](#timezone-ids) to change the time
zone. It also uses the formatting characters `uuuu-MM-dd'T'HH:mm:ss.SSS` to modify the format. The
`uuuu` characters represent the year.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
fun format(d: DateTime) = d as String {format: "yyyy-MM-dd'T'HH:mm:ss.SSS"}
---
{
    CreatedDateTime: format(|2019-02-13T13:23:00.120Z| >> "CET"),
}
```

Output JSON:

```JSON
{
    "CreatedDateTime": "2019-02-13T14:23:00.120"
}
```

## Time Zone IDs

In addition to accepting time zone values such as `-07:00`, DataWeave accepts Java 8 `TimeZone` ID
values, which are available through a Java method call to `ZoneId.getAvailableZoneIds()`.

To see all available values in the following table, scroll right.

<table><colgroup><col> <col> <col> <col> <col> <col> <col> <col></colgroup><thead><tr><th></th><th></th><th></th><th></th><th></th><th></th><th></th><th></th></tr></thead><tbody><tr><td><div><div><p>Africa:</p></div><div><ul><li><p>Africa/Abidjan</p></li><li><p>Africa/Accra</p></li><li><p>Africa/Addis_Ababa</p></li><li><p>Africa/Algiers</p></li><li><p>Africa/Asmara</p></li><li><p>Africa/Asmera</p></li><li><p>Africa/Bamako</p></li><li><p>Africa/Bangui</p></li><li><p>Africa/Banjul</p></li><li><p>Africa/Bissau</p></li><li><p>Africa/Blantyre</p></li><li><p>Africa/Brazzaville</p></li><li><p>Africa/Bujumbura</p></li><li><p>Africa/Cairo</p></li><li><p>Africa/Casablanca</p></li><li><p>Africa/Ceuta</p></li><li><p>Africa/Conakry</p></li><li><p>Africa/Dakar</p></li><li><p>Africa/Dar_es_Salaam</p></li><li><p>Africa/Djibouti</p></li><li><p>Africa/Douala</p></li><li><p>Africa/El_Aaiun</p></li><li><p>Africa/Freetown</p></li><li><p>Africa/Gaborone</p></li><li><p>Africa/Harare</p></li><li><p>Africa/Johannesburg</p></li><li><p>Africa/Juba</p></li><li><p>Africa/Kampala</p></li><li><p>Africa/Khartoum</p></li><li><p>Africa/Kigali</p></li><li><p>Africa/Kinshasa</p></li><li><p>Africa/Lagos</p></li><li><p>Africa/Libreville</p></li><li><p>Africa/Lome</p></li><li><p>Africa/Luanda</p></li><li><p>Africa/Lubumbashi</p></li><li><p>Africa/Lusaka</p></li><li><p>Africa/Malabo</p></li><li><p>Africa/Maputo</p></li><li><p>Africa/Maseru</p></li><li><p>Africa/Mbabane</p></li><li><p>Africa/Mogadishu</p></li><li><p>Africa/Monrovia</p></li><li><p>Africa/Nairobi</p></li><li><p>Africa/Ndjamena</p></li><li><p>Africa/Niamey</p></li><li><p>Africa/Nouakchott</p></li><li><p>Africa/Ouagadougou</p></li><li><p>Africa/Porto-Novo</p></li><li><p>Africa/Sao_Tome</p></li><li><p>Africa/Timbuktu</p></li><li><p>Africa/Tripoli</p></li><li><p>Africa/Tunis</p></li><li><p>Africa/Windhoek</p></li></ul></div><div><p>America:</p></div><div><ul><li><p>America/Adak</p></li><li><p>America/Anchorage</p></li><li><p>America/Anguilla</p></li><li><p>America/Antigua</p></li><li><p>America/Araguaina</p></li><li><p>America/Argentina/Buenos_Aires</p></li><li><p>America/Argentina/Catamarca</p></li><li><p>America/Argentina/ComodRivadavia</p></li><li><p>America/Argentina/Cordoba</p></li><li><p>America/Argentina/Jujuy</p></li><li><p>America/Argentina/La_Rioja</p></li><li><p>America/Argentina/Mendoza</p></li><li><p>America/Argentina/Rio_Gallegos</p></li><li><p>America/Argentina/Salta</p></li><li><p>America/Argentina/San_Juan</p></li><li><p>America/Argentina/San_Luis</p></li><li><p>America/Argentina/Tucuman</p></li><li><p>America/Argentina/Ushuaia</p></li><li><p>America/Aruba</p></li><li><p>America/Asuncion</p></li><li><p>America/Atikokan</p></li><li><p>America/Atka</p></li><li><p>America/Bahia</p></li><li><p>America/Bahia_Banderas</p></li><li><p>America/Barbados</p></li><li><p>America/Belem</p></li><li><p>America/Belize</p></li><li><p>America/Blanc-Sablon</p></li><li><p>America/Boa_Vista</p></li><li><p>America/Bogota</p></li><li><p>America/Boise</p></li><li><p>America/Buenos_Aires</p></li></ul></div></div></td><td><div><div><p>America (continued):</p></div><div><ul><li><p>America/Cambridge_Bay</p></li><li><p>America/Campo_Grande</p></li><li><p>America/Cancun</p></li><li><p>America/Caracas</p></li><li><p>America/Catamarca</p></li><li><p>America/Cayenne</p></li><li><p>America/Cayman</p></li><li><p>America/Chicago</p></li><li><p>America/Chihuahua</p></li><li><p>America/Coral_Harbour</p></li><li><p>America/Cordoba</p></li><li><p>America/Costa_Rica</p></li><li><p>America/Creston</p></li><li><p>America/Cuiaba</p></li><li><p>America/Curacao</p></li><li><p>America/Danmarkshavn</p></li><li><p>America/Dawson</p></li><li><p>America/Dawson_Creek</p></li><li><p>America/Denver</p></li><li><p>America/Detroit</p></li><li><p>America/Dominica</p></li><li><p>America/Edmonton</p></li><li><p>America/Eirunepe</p></li><li><p>America/El_Salvador</p></li><li><p>America/Ensenada</p></li><li><p>America/Fort_Nelson</p></li><li><p>America/Fort_Wayne</p></li><li><p>America/Fortaleza</p></li><li><p>America/Glace_Bay</p></li><li><p>America/Godthab</p></li><li><p>America/Goose_Bay</p></li><li><p>America/Grand_Turk</p></li><li><p>America/Grenada</p></li><li><p>America/Guadeloupe</p></li><li><p>America/Guatemala</p></li><li><p>America/Guayaquil</p></li><li><p>America/Guyana</p></li><li><p>America/Halifax</p></li><li><p>America/Havana</p></li><li><p>America/Hermosillo</p></li><li><p>America/Indiana/Indianapolis</p></li><li><p>America/Indiana/Knox</p></li><li><p>America/Indiana/Marengo</p></li><li><p>America/Indiana/Petersburg</p></li><li><p>America/Indiana/Tell_City</p></li><li><p>America/Indiana/Vevay</p></li><li><p>America/Indiana/Vincennes</p></li><li><p>America/Indiana/Winamac</p></li><li><p>America/Indianapolis</p></li><li><p>America/Inuvik</p></li><li><p>America/Iqaluit</p></li><li><p>America/Jamaica</p></li><li><p>America/Jujuy</p></li><li><p>America/Juneau</p></li><li><p>America/Kentucky/Louisville</p></li><li><p>America/Kentucky/Monticello</p></li><li><p>America/Knox_IN</p></li><li><p>America/Kralendijk</p></li><li><p>America/La_Paz</p></li><li><p>America/Lima</p></li><li><p>America/Los_Angeles</p></li><li><p>America/Louisville</p></li><li><p>America/Lower_Princes</p></li><li><p>America/Maceio</p></li><li><p>America/Managua</p></li><li><p>America/Manaus</p></li><li><p>America/Marigot</p></li><li><p>America/Martinique</p></li><li><p>America/Matamoros</p></li><li><p>America/Mazatlan</p></li><li><p>America/Mendoza</p></li><li><p>America/Menominee</p></li><li><p>America/Merida</p></li><li><p>America/Metlakatla</p></li><li><p>America/Mexico_City</p></li><li><p>America/Miquelon</p></li><li><p>America/Moncton</p></li><li><p>America/Monterrey</p></li><li><p>America/Montevideo</p></li><li><p>America/Montreal</p></li><li><p>America/Montserrat</p></li><li><p>America/Nassau</p></li><li><p>America/New_York</p></li><li><p>America/Nipigon</p></li><li><p>America/Nome</p></li><li><p>America/Noronha</p></li></ul></div></div></td><td><div><div><p>America (continued):</p></div><div><ul><li><p>America/North_Dakota/Beulah</p></li><li><p>America/North_Dakota/Center</p></li><li><p>America/North_Dakota/New_Salem</p></li><li><p>America/Ojinaga</p></li><li><p>America/Panama</p></li><li><p>America/Pangnirtung</p></li><li><p>America/Paramaribo</p></li><li><p>America/Phoenix</p></li><li><p>America/Port-au-Prince</p></li><li><p>America/Port_of_Spain</p></li><li><p>America/Porto_Acre</p></li><li><p>America/Porto_Velho</p></li><li><p>America/Puerto_Rico</p></li><li><p>America/Punta_Arenas</p></li><li><p>America/Rainy_River</p></li><li><p>America/Rankin_Inlet</p></li><li><p>America/Recife</p></li><li><p>America/Regina</p></li><li><p>America/Resolute</p></li><li><p>America/Rio_Branco</p></li><li><p>America/Rosario</p></li><li><p>America/Santa_Isabel</p></li><li><p>America/Santarem</p></li><li><p>America/Santiago</p></li><li><p>America/Santo_Domingo</p></li><li><p>America/Sao_Paulo</p></li><li><p>America/Scoresbysund</p></li><li><p>America/Shiprock</p></li><li><p>America/Sitka</p></li><li><p>America/St_Barthelemy</p></li><li><p>America/St_Johns</p></li><li><p>America/St_Kitts</p></li><li><p>America/St_Lucia</p></li><li><p>America/St_Thomas</p></li><li><p>America/St_Vincent</p></li><li><p>America/Swift_Current</p></li><li><p>America/Tegucigalpa</p></li><li><p>America/Thule</p></li><li><p>America/Thunder_Bay</p></li><li><p>America/Tijuana</p></li><li><p>America/Toronto</p></li><li><p>America/Tortola</p></li><li><p>America/Vancouver</p></li><li><p>America/Virgin</p></li><li><p>America/Whitehorse</p></li><li><p>America/Winnipeg</p></li><li><p>America/Yakutat</p></li><li><p>America/Yellowknife</p></li></ul></div><div><p>Antarctica:</p></div><div><ul><li><p>Antarctica/Casey</p></li><li><p>Antarctica/Davis</p></li><li><p>Antarctica/DumontDUrville</p></li><li><p>Antarctica/Macquarie</p></li><li><p>Antarctica/Mawson</p></li><li><p>Antarctica/McMurdo</p></li><li><p>Antarctica/Palmer</p></li><li><p>Antarctica/Rothera</p></li><li><p>Antarctica/South_Pole</p></li><li><p>Antarctica/Syowa</p></li><li><p>Antarctica/Troll</p></li><li><p>Antarctica/Vostok</p></li><li><p>Arctic/Longyearbyen</p></li></ul></div><div><p>Asia:</p></div><div><ul><li><p>Asia/Aden</p></li><li><p>Asia/Almaty</p></li><li><p>Asia/Amman</p></li><li><p>Asia/Anadyr</p></li><li><p>Asia/Aqtau</p></li><li><p>Asia/Aqtobe</p></li><li><p>Asia/Ashgabat</p></li><li><p>Asia/Ashkhabad</p></li><li><p>Asia/Atyrau</p></li><li><p>Asia/Baghdad</p></li><li><p>Asia/Bahrain</p></li><li><p>Asia/Baku</p></li><li><p>Asia/Bangkok</p></li><li><p>Asia/Barnaul</p></li><li><p>Asia/Beirut</p></li><li><p>Asia/Bishkek</p></li><li><p>Asia/Brunei</p></li><li><p>Asia/Calcutta</p></li><li><p>Asia/Chita</p></li><li><p>Asia/Choibalsan</p></li><li><p>Asia/Chongqing</p></li><li><p>Asia/Chungking</p></li><li><p>Asia/Colombo</p></li></ul></div></div></td><td><div><div><p>Asia (continued):</p></div><div><ul><li><p>Asia/Dacca</p></li><li><p>Asia/Damascus</p></li><li><p>Asia/Dhaka</p></li><li><p>Asia/Dili</p></li><li><p>Asia/Dubai</p></li><li><p>Asia/Dushanbe</p></li><li><p>Asia/Famagusta</p></li><li><p>Asia/Gaza</p></li><li><p>Asia/Harbin</p></li><li><p>Asia/Hebron</p></li><li><p>Asia/Ho_Chi_Minh</p></li><li><p>Asia/Hong_Kong</p></li><li><p>Asia/Hovd</p></li><li><p>Asia/Irkutsk</p></li><li><p>Asia/Istanbul</p></li><li><p>Asia/Jakarta</p></li><li><p>Asia/Jayapura</p></li><li><p>Asia/Jerusalem</p></li><li><p>Asia/Kabul</p></li><li><p>Asia/Kamchatka</p></li><li><p>Asia/Karachi</p></li><li><p>Asia/Kashgar</p></li><li><p>Asia/Kathmandu</p></li><li><p>Asia/Katmandu</p></li><li><p>Asia/Khandyga</p></li><li><p>Asia/Kolkata</p></li><li><p>Asia/Krasnoyarsk</p></li><li><p>Asia/Kuala_Lumpur</p></li><li><p>Asia/Kuching</p></li><li><p>Asia/Kuwait</p></li><li><p>Asia/Macao</p></li><li><p>Asia/Macau</p></li><li><p>Asia/Magadan</p></li><li><p>Asia/Makassar</p></li><li><p>Asia/Manila</p></li><li><p>Asia/Muscat</p></li><li><p>Asia/Nicosia</p></li><li><p>Asia/Novokuznetsk</p></li><li><p>Asia/Novosibirsk</p></li><li><p>Asia/Omsk</p></li><li><p>Asia/Oral</p></li><li><p>Asia/Phnom_Penh</p></li><li><p>Asia/Pontianak</p></li><li><p>Asia/Pyongyang</p></li><li><p>Asia/Qatar</p></li><li><p>Asia/Qostanay</p></li><li><p>Asia/Qyzylorda</p></li><li><p>Asia/Rangoon</p></li><li><p>Asia/Riyadh</p></li><li><p>Asia/Saigon</p></li><li><p>Asia/Sakhalin</p></li><li><p>Asia/Samarkand</p></li><li><p>Asia/Seoul</p></li><li><p>Asia/Shanghai</p></li><li><p>Asia/Singapore</p></li><li><p>Asia/Srednekolymsk</p></li><li><p>Asia/Taipei</p></li><li><p>Asia/Tashkent</p></li><li><p>Asia/Tbilisi</p></li><li><p>Asia/Tehran</p></li><li><p>Asia/Tel_Aviv</p></li><li><p>Asia/Thimbu</p></li><li><p>Asia/Thimphu</p></li><li><p>Asia/Tokyo</p></li><li><p>Asia/Tomsk</p></li><li><p>Asia/Ujung_Pandang</p></li><li><p>Asia/Ulaanbaatar</p></li><li><p>Asia/Ulan_Bator</p></li><li><p>Asia/Urumqi</p></li><li><p>Asia/Ust-Nera</p></li><li><p>Asia/Vientiane</p></li><li><p>Asia/Vladivostok</p></li><li><p>Asia/Yakutsk</p></li><li><p>Asia/Yangon</p></li><li><p>Asia/Yekaterinburg</p></li><li><p>Asia/Yerevan</p></li></ul></div><div><p>Atlantic:</p></div><div><ul><li><p>Atlantic/Azores</p></li><li><p>Atlantic/Bermuda</p></li><li><p>Atlantic/Canary</p></li><li><p>Atlantic/Cape_Verde</p></li><li><p>Atlantic/Faeroe</p></li><li><p>Atlantic/Faroe</p></li><li><p>Atlantic/Jan_Mayen</p></li><li><p>Atlantic/Madeira</p></li><li><p>Atlantic/Reykjavik</p></li><li><p>Atlantic/South_Georgia</p></li><li><p>Atlantic/St_Helena</p></li><li><p>Atlantic/Stanley</p></li></ul></div></div></td><td><div><div><p>Australia:</p></div><div><ul><li><p>Australia/ACT</p></li><li><p>Australia/Adelaide</p></li><li><p>Australia/Brisbane</p></li><li><p>Australia/Broken_Hill</p></li><li><p>Australia/Canberra</p></li><li><p>Australia/Currie</p></li><li><p>Australia/Darwin</p></li><li><p>Australia/Eucla</p></li><li><p>Australia/Hobart</p></li><li><p>Australia/LHI</p></li><li><p>Australia/Lindeman</p></li><li><p>Australia/Lord_Howe</p></li><li><p>Australia/Melbourne</p></li><li><p>Australia/NSW</p></li><li><p>Australia/North</p></li><li><p>Australia/Perth</p></li><li><p>Australia/Queensland</p></li><li><p>Australia/South</p></li><li><p>Australia/Sydney</p></li><li><p>Australia/Tasmania</p></li><li><p>Australia/Victoria</p></li><li><p>Australia/West</p></li><li><p>Australia/Yancowinna</p></li></ul></div><div><p>B:</p></div><div><ul><li><p>Brazil/Acre</p></li><li><p>Brazil/DeNoronha</p></li><li><p>Brazil/East</p></li><li><p>Brazil/West</p></li></ul></div><div><p>C:</p></div><div><ul><li><p>CET</p></li><li><p>CST6CDT</p></li><li><p>Canada/Atlantic</p></li><li><p>Canada/Central</p></li><li><p>Canada/Eastern</p></li><li><p>Canada/Mountain</p></li><li><p>Canada/Newfoundland</p></li><li><p>Canada/Pacific</p></li><li><p>Canada/Saskatchewan</p></li><li><p>Canada/Yukon</p></li><li><p>Chile/Continental</p></li><li><p>Chile/EasterIsland</p></li><li><p>Cuba</p></li></ul></div><div><p>E:</p></div><div><ul><li><p>EET</p></li><li><p>EST5EDT</p></li><li><p>Egypt</p></li><li><p>Eire</p></li><li><p>Etc/GMT</p></li><li><p>Etc/GMT+0</p></li><li><p>Etc/GMT+1</p></li><li><p>Etc/GMT+10</p></li><li><p>Etc/GMT+11</p></li><li><p>Etc/GMT+12</p></li><li><p>Etc/GMT+2</p></li><li><p>Etc/GMT+3</p></li><li><p>Etc/GMT+4</p></li><li><p>Etc/GMT+5</p></li><li><p>Etc/GMT+6</p></li><li><p>Etc/GMT+7</p></li><li><p>Etc/GMT+8</p></li><li><p>Etc/GMT+9</p></li><li><p>Etc/GMT-0</p></li><li><p>Etc/GMT-1</p></li><li><p>Etc/GMT-10</p></li><li><p>Etc/GMT-11</p></li><li><p>Etc/GMT-12</p></li><li><p>Etc/GMT-13</p></li><li><p>Etc/GMT-14</p></li><li><p>Etc/GMT-2</p></li><li><p>Etc/GMT-3</p></li><li><p>Etc/GMT-4</p></li><li><p>Etc/GMT-5</p></li><li><p>Etc/GMT-6</p></li><li><p>Etc/GMT-7</p></li><li><p>Etc/GMT-8</p></li><li><p>Etc/GMT-9</p></li><li><p>Etc/GMT0</p></li><li><p>Etc/Greenwich</p></li><li><p>Etc/UCT</p></li><li><p>Etc/UTC</p></li><li><p>Etc/Universal</p></li><li><p>Etc/Zulu</p></li></ul></div></div></td><td><div><div><p>E (continued):</p></div><div><ul><li><p>Europe/Amsterdam</p></li><li><p>Europe/Andorra</p></li><li><p>Europe/Astrakhan</p></li><li><p>Europe/Athens</p></li><li><p>Europe/Belfast</p></li><li><p>Europe/Belgrade</p></li><li><p>Europe/Berlin</p></li><li><p>Europe/Bratislava</p></li><li><p>Europe/Brussels</p></li><li><p>Europe/Bucharest</p></li><li><p>Europe/Budapest</p></li><li><p>Europe/Busingen</p></li><li><p>Europe/Chisinau</p></li><li><p>Europe/Copenhagen</p></li><li><p>Europe/Dublin</p></li><li><p>Europe/Gibraltar</p></li><li><p>Europe/Guernsey</p></li><li><p>Europe/Helsinki</p></li><li><p>Europe/Isle_of_Man</p></li><li><p>Europe/Istanbul</p></li><li><p>Europe/Jersey</p></li><li><p>Europe/Kaliningrad</p></li><li><p>Europe/Kiev</p></li><li><p>Europe/Kirov</p></li><li><p>Europe/Lisbon</p></li><li><p>Europe/Ljubljana</p></li><li><p>Europe/London</p></li><li><p>Europe/Luxembourg</p></li><li><p>Europe/Madrid</p></li><li><p>Europe/Malta</p></li><li><p>Europe/Mariehamn</p></li><li><p>Europe/Minsk</p></li><li><p>Europe/Monaco</p></li><li><p>Europe/Moscow</p></li><li><p>Europe/Nicosia</p></li><li><p>Europe/Oslo</p></li><li><p>Europe/Paris</p></li><li><p>Europe/Podgorica</p></li><li><p>Europe/Prague</p></li><li><p>Europe/Riga</p></li><li><p>Europe/Rome</p></li><li><p>Europe/Samara</p></li><li><p>Europe/San_Marino</p></li><li><p>Europe/Sarajevo</p></li><li><p>Europe/Saratov</p></li><li><p>Europe/Skopje</p></li><li><p>Europe/Sofia</p></li><li><p>Europe/Stockholm</p></li><li><p>Europe/Tallinn</p></li><li><p>Europe/Tirane</p></li><li><p>Europe/Tiraspol</p></li><li><p>Europe/Ulyanovsk</p></li><li><p>Europe/Uzhgorod</p></li><li><p>Europe/Vaduz</p></li><li><p>Europe/Vatican</p></li><li><p>Europe/Vienna</p></li><li><p>Europe/Vilnius</p></li><li><p>Europe/Volgograd</p></li><li><p>Europe/Warsaw</p></li><li><p>Europe/Zagreb</p></li><li><p>Europe/Zaporozhye</p></li><li><p>Europe/Zurich</p></li></ul></div><div><p>G:</p></div><div><ul><li><p>GB</p></li><li><p>GB-Eire</p></li><li><p>GMT</p></li><li><p>GMT0</p></li><li><p>Greenwich</p></li></ul></div><div><p>H:</p></div><div><ul><li><p>Hongkong</p></li></ul></div><div><p>I:</p></div><div><ul><li><p>Iceland</p></li><li><p>Indian/Antananarivo</p></li><li><p>Indian/Chagos</p></li><li><p>Indian/Christmas</p></li><li><p>Indian/Cocos</p></li><li><p>Indian/Comoro</p></li><li><p>Indian/Kerguelen</p></li><li><p>Indian/Mahe</p></li><li><p>Indian/Maldives</p></li><li><p>Indian/Mauritius</p></li><li><p>Indian/Mayotte</p></li><li><p>Indian/Reunion</p></li><li><p>Iran</p></li><li><p>Israel</p></li></ul></div></div></td><td><div><div><p>J:</p></div><div><ul><li><p>Jamaica</p></li><li><p>Japan</p></li></ul></div><div><p>K:</p></div><div><ul><li><p>Kwajalein</p></li></ul></div><div><p>L:</p></div><div><ul><li><p>Libya</p></li></ul></div><div><p>M:</p></div><div><ul><li><p>MET</p></li><li><p>MST7MDT</p></li><li><p>Mexico/BajaNorte</p></li><li><p>Mexico/BajaSur</p></li><li><p>Mexico/General</p></li></ul></div><div><p>N:</p></div><div><ul><li><p>NZ</p></li><li><p>NZ-CHAT</p></li><li><p>Navajo</p></li></ul></div><div><p>P:</p></div><div><ul><li><p>PRC</p></li><li><p>PST8PDT</p></li><li><p>Pacific/Apia</p></li><li><p>Pacific/Auckland</p></li><li><p>Pacific/Bougainville</p></li><li><p>Pacific/Chatham</p></li><li><p>Pacific/Chuuk</p></li><li><p>Pacific/Easter</p></li><li><p>Pacific/Efate</p></li><li><p>Pacific/Enderbury</p></li><li><p>Pacific/Fakaofo</p></li><li><p>Pacific/Fiji</p></li><li><p>Pacific/Funafuti</p></li><li><p>Pacific/Galapagos</p></li><li><p>Pacific/Gambier</p></li><li><p>Pacific/Guadalcanal</p></li><li><p>Pacific/Guam</p></li><li><p>Pacific/Honolulu</p></li><li><p>Pacific/Johnston</p></li><li><p>Pacific/Kiritimati</p></li><li><p>Pacific/Kosrae</p></li><li><p>Pacific/Kwajalein</p></li><li><p>Pacific/Majuro</p></li><li><p>Pacific/Marquesas</p></li><li><p>Pacific/Midway</p></li><li><p>Pacific/Nauru</p></li><li><p>Pacific/Niue</p></li><li><p>Pacific/Norfolk</p></li><li><p>Pacific/Noumea</p></li><li><p>Pacific/Pago_Pago</p></li><li><p>Pacific/Palau</p></li><li><p>Pacific/Pitcairn</p></li><li><p>Pacific/Pohnpei</p></li><li><p>Pacific/Ponape</p></li><li><p>Pacific/Port_Moresby</p></li><li><p>Pacific/Rarotonga</p></li><li><p>Pacific/Saipan</p></li><li><p>Pacific/Samoa</p></li><li><p>Pacific/Tahiti</p></li><li><p>Pacific/Tarawa</p></li><li><p>Pacific/Tongatapu</p></li><li><p>Pacific/Truk</p></li><li><p>Pacific/Wake</p></li><li><p>Pacific/Wallis</p></li><li><p>Pacific/Yap</p></li><li><p>Poland</p></li><li><p>Portugal</p></li></ul></div><div><p>R:</p></div><div><ul><li><p>ROK</p></li></ul></div><div><p>S:</p></div><div><ul><li><p>Singapore</p></li><li><p>SystemV/AST4</p></li><li><p>SystemV/AST4ADT</p></li><li><p>SystemV/CST6</p></li><li><p>SystemV/CST6CDT</p></li><li><p>SystemV/EST5</p></li><li><p>SystemV/EST5EDT</p></li><li><p>SystemV/HST10</p></li><li><p>SystemV/MST7</p></li><li><p>SystemV/MST7MDT</p></li><li><p>SystemV/PST8</p></li><li><p>SystemV/PST8PDT</p></li><li><p>SystemV/YST9</p></li><li><p>SystemV/YST9YDT</p></li></ul></div></div></td><td><div><div><p>T:</p></div><div><ul><li><p>Turkey</p></li></ul></div><div><p>U:</p></div><div><ul><li><p>UCT</p></li><li><p>US/Alaska</p></li><li><p>US/Aleutian</p></li><li><p>US/Arizona</p></li><li><p>US/Central</p></li><li><p>US/East-Indiana</p></li><li><p>US/Eastern</p></li><li><p>US/Hawaii</p></li><li><p>US/Indiana-Starke</p></li><li><p>US/Michigan</p></li><li><p>US/Mountain</p></li><li><p>US/Pacific</p></li><li><p>US/Pacific-New</p></li><li><p>US/Samoa</p></li><li><p>UTC</p></li><li><p>Universal</p></li></ul></div><div><p>W:</p></div><div><ul><li><p>W-SU</p></li><li><p>WET</p></li></ul></div><div><p>Z:</p></div><div><ul><li><p>Zulu</p></li></ul></div></div></td></tr></tbody></table>

## Related Examples

- [Format Dates and Times](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-format-dates)

- [Parse Dates with DataWeave](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-parse-dates)

- [Add and Subtract Time](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-add-and-subtract-time)

## See Also

- [Date and Time (dw::Core Types)](https://docs.mulesoft.com/dataweave/latest/dataweave-types#dw_type_dates)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook)

<!-- document id=ee5ecd29299ec9f1aa439035fa56150cce92e5f095fb4594cd45fd5517c86773 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook-change-value-of-a-field.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, transform, transformer, format, rename, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, update
---

# Change the Value of a Field

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following DataWeave examples show how to use `update` and `mask` to change the values of some
XML elements.

## Example: Using Update to Change Values

This example uses:

- `update` to update specified fields of the payload with new values

- single-value (`.`) and multi-value (`.*`) selectors to navigate the payload and select the fields
  to update

The following script shows how the `update` operator works. The example creates a new `users` list
by updating each `user` in the payload with a new `user`. The transformation converts `first_name`,
`middle_name` and `last_name` to uppercase values:

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
payload update {
  case user at .users.*user -> user update {
    case .personal_information.first_name -> upper(user.personal_information.first_name)
    case .personal_information.middle_name -> upper(user.personal_information.middle_name)
    case .personal_information.last_name -> upper(user.personal_information.last_name)
  }
}
```

Input XML Payload:

```xml
<users>
    <user>
        <personal_information>
            <first_name>Emiliano</first_name>
            <middle_name>Romoaldo</middle_name>
            <last_name>Lesende</last_name>
            <ssn>001-08-84382</ssn>
        </personal_information>
        <login_information>
            <username>3miliano</username>
            <password>mypassword1234</password>
        </login_information>
    </user>
    <user>
        <personal_information>
            <first_name>Mariano</first_name>
            <middle_name>Toribio</middle_name>
            <last_name>de Achaval</last_name>
            <ssn>002-05-34738</ssn>
        </personal_information>
        <login_information>
            <username>machaval</username>
            <password>mypassword4321</password>
        </login_information>
    </user>
</users>
```

Output XML:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<users>
  <user>
    <personal_information>
      <first_name>EMILIANO</first_name>
      <middle_name>ROMOALDO</middle_name>
      <last_name>LESENDE</last_name>
      <ssn>001-08-84382</ssn>
    </personal_information>
    <login_information>
      <username>3miliano</username>
      <password>mypassword1234</password>
    </login_information>
  </user>
  <user>
    <personal_information>
      <first_name>MARIANO</first_name>
      <middle_name>TORIBIO</middle_name>
      <last_name>DE ACHAVAL</last_name>
      <ssn>002-05-34738</ssn>
    </personal_information>
    <login_information>
      <username>machaval</username>
      <password>mypassword4321</password>
    </login_information>
  </user>
</users>
```

## Example: Using Mask to Change Values

DataWeave provides a simple way to mask values, without specifying the path to each field:

- `mask` updates all simple elements that match the selected name throughout the input with the
  specified mask.

The following example masks the `ssn` and `password` values with a set of asterisks (`****`):

DataWeave Script:

```dataweave
%dw 2.0
import * from dw::util::Values
output application/xml
---
(payload mask "ssn" with "****") mask "password" with "****"
```

Input XML Payload:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<users>
  <user>
    <personal_information>
      <first_name>EMILIANO</first_name>
      <middle_name>ROMOALDO</middle_name>
      <last_name>LESENDE</last_name>
      <ssn>001-08-84382</ssn>
    </personal_information>
    <login_information>
      <username>3miliano</username>
      <password>mypassword1234</password>
    </login_information>
  </user>
  <user>
    <personal_information>
      <first_name>MARIANO</first_name>
      <middle_name>TORIBIO</middle_name>
      <last_name>DE ACHAVAL</last_name>
      <ssn>002-05-34738</ssn>
    </personal_information>
    <login_information>
      <username>machaval</username>
      <password>mypassword4321</password>
    </login_information>
  </user>
</users>
```

Output XML:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<users>
  <user>
    <personal_information>
      <first_name>EMILIANO</first_name>
      <middle_name>ROMOALDO</middle_name>
      <last_name>LESENDE</last_name>
      <ssn>****</ssn>
    </personal_information>
    <login_information>
      <username>3miliano</username>
      <password>****</password>
    </login_information>
  </user>
  <user>
    <personal_information>
      <first_name>MARIANO</first_name>
      <middle_name>TORIBIO</middle_name>
      <last_name>DE ACHAVAL</last_name>
      <ssn>****</ssn>
    </personal_information>
    <login_information>
      <username>machaval</username>
      <password>****</password>
    </login_information>
  </user>
</users>
```

## Related Examples

- [Transform XML to JSON](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-perform-basic-transformation)

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-output-a-field-when-present)

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-insert-attribute)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.11/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.11/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook)

<!-- document id=9cf173f0ce7f126b828695fc8f7f770ec00ff2c7271fd7b4d8e6378e2d3392a9 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook-change-value-of-a-field.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, transform, transformer, format, rename, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, update
---

# Change the Value of a Field

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following DataWeave examples show how to use `update` and `mask` to change the values of some
XML elements.

## Example: Using Update to Change Values

This example uses:

- `update` to update specified fields of the payload with new values

- single-value (`.`) and multi-value (`.*`) selectors to navigate the payload and select the fields
  to update

The following script shows how the `update` operator works. The example creates a new `users` list
by updating each `user` in the payload with a new `user`. The transformation converts `first_name`,
`middle_name` and `last_name` to uppercase values:

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
payload update {
  case user at .users.*user -> user update {
    case .personal_information.first_name -> upper(user.personal_information.first_name)
    case .personal_information.middle_name -> upper(user.personal_information.middle_name)
    case .personal_information.last_name -> upper(user.personal_information.last_name)
  }
}
```

Input XML Payload:

```xml
<users>
    <user>
        <personal_information>
            <first_name>Emiliano</first_name>
            <middle_name>Romoaldo</middle_name>
            <last_name>Lesende</last_name>
            <ssn>001-08-84382</ssn>
        </personal_information>
        <login_information>
            <username>3miliano</username>
            <password>mypassword1234</password>
        </login_information>
    </user>
    <user>
        <personal_information>
            <first_name>Mariano</first_name>
            <middle_name>Toribio</middle_name>
            <last_name>de Achaval</last_name>
            <ssn>002-05-34738</ssn>
        </personal_information>
        <login_information>
            <username>machaval</username>
            <password>mypassword4321</password>
        </login_information>
    </user>
</users>
```

Output XML:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<users>
  <user>
    <personal_information>
      <first_name>EMILIANO</first_name>
      <middle_name>ROMOALDO</middle_name>
      <last_name>LESENDE</last_name>
      <ssn>001-08-84382</ssn>
    </personal_information>
    <login_information>
      <username>3miliano</username>
      <password>mypassword1234</password>
    </login_information>
  </user>
  <user>
    <personal_information>
      <first_name>MARIANO</first_name>
      <middle_name>TORIBIO</middle_name>
      <last_name>DE ACHAVAL</last_name>
      <ssn>002-05-34738</ssn>
    </personal_information>
    <login_information>
      <username>machaval</username>
      <password>mypassword4321</password>
    </login_information>
  </user>
</users>
```

## Example: Using Mask to Change Values

DataWeave provides a simple way to mask values, without specifying the path to each field:

- `mask` updates all simple elements that match the selected name throughout the input with the
  specified mask.

The following example masks the `ssn` and `password` values with a set of asterisks (`****`):

DataWeave Script:

```dataweave
%dw 2.0
import * from dw::util::Values
output application/xml
---
(payload mask "ssn" with "****") mask "password" with "****"
```

Input XML Payload:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<users>
  <user>
    <personal_information>
      <first_name>EMILIANO</first_name>
      <middle_name>ROMOALDO</middle_name>
      <last_name>LESENDE</last_name>
      <ssn>001-08-84382</ssn>
    </personal_information>
    <login_information>
      <username>3miliano</username>
      <password>mypassword1234</password>
    </login_information>
  </user>
  <user>
    <personal_information>
      <first_name>MARIANO</first_name>
      <middle_name>TORIBIO</middle_name>
      <last_name>DE ACHAVAL</last_name>
      <ssn>002-05-34738</ssn>
    </personal_information>
    <login_information>
      <username>machaval</username>
      <password>mypassword4321</password>
    </login_information>
  </user>
</users>
```

Output XML:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<users>
  <user>
    <personal_information>
      <first_name>EMILIANO</first_name>
      <middle_name>ROMOALDO</middle_name>
      <last_name>LESENDE</last_name>
      <ssn>****</ssn>
    </personal_information>
    <login_information>
      <username>3miliano</username>
      <password>****</password>
    </login_information>
  </user>
  <user>
    <personal_information>
      <first_name>MARIANO</first_name>
      <middle_name>TORIBIO</middle_name>
      <last_name>DE ACHAVAL</last_name>
      <ssn>****</ssn>
    </personal_information>
    <login_information>
      <username>machaval</username>
      <password>****</password>
    </login_information>
  </user>
</users>
```

## Related Examples

- [Transform XML to JSON](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-perform-basic-transformation)

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-output-a-field-when-present)

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-insert-attribute)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.12/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.12/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook)

<!-- document id=93b8874af9aaed469fe9970018a841517ab5125199a45bfd3a0a6f6ad202d43f url=/mulesoft/current/en-us/dataweave/2.3/dataweave-cookbook-change-value-of-a-field.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, transform, transformer, format, rename, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, update
---

# Change the Value of a Field

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following DataWeave examples show how to use `update` and `mask` to change the values of some
XML elements.

## Example: Using Update to Change Values

This example uses:

- `update` to update specified fields of the payload with new values

- single-value (`.`) and multi-value (`.*`) selectors to navigate the payload and select the fields
  to update

The following script shows how the `update` operator works. The example creates a new `users` list
by updating each `user` in the payload with a new `user`. The transformation converts `first_name`,
`middle_name` and `last_name` to uppercase values:

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
payload update {
  case user at .users.*user -> user update {
    case .personal_information.first_name -> upper(user.personal_information.first_name)
    case .personal_information.middle_name -> upper(user.personal_information.middle_name)
    case .personal_information.last_name -> upper(user.personal_information.last_name)
  }
}
```

Input XML Payload:

```xml
<users>
    <user>
        <personal_information>
            <first_name>Emiliano</first_name>
            <middle_name>Romoaldo</middle_name>
            <last_name>Lesende</last_name>
            <ssn>001-08-84382</ssn>
        </personal_information>
        <login_information>
            <username>3miliano</username>
            <password>mypassword1234</password>
        </login_information>
    </user>
    <user>
        <personal_information>
            <first_name>Mariano</first_name>
            <middle_name>Toribio</middle_name>
            <last_name>de Achaval</last_name>
            <ssn>002-05-34738</ssn>
        </personal_information>
        <login_information>
            <username>machaval</username>
            <password>mypassword4321</password>
        </login_information>
    </user>
</users>
```

Output XML:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<users>
  <user>
    <personal_information>
      <first_name>EMILIANO</first_name>
      <middle_name>ROMOALDO</middle_name>
      <last_name>LESENDE</last_name>
      <ssn>001-08-84382</ssn>
    </personal_information>
    <login_information>
      <username>3miliano</username>
      <password>mypassword1234</password>
    </login_information>
  </user>
  <user>
    <personal_information>
      <first_name>MARIANO</first_name>
      <middle_name>TORIBIO</middle_name>
      <last_name>DE ACHAVAL</last_name>
      <ssn>002-05-34738</ssn>
    </personal_information>
    <login_information>
      <username>machaval</username>
      <password>mypassword4321</password>
    </login_information>
  </user>
</users>
```

## Example: Using Mask to Change Values

DataWeave provides a simple way to mask values, without specifying the path to each field:

- `mask` updates all simple elements that match the selected name throughout the input with the
  specified mask.

The following example masks the `ssn` and `password` values with a set of asterisks (`****`):

DataWeave Script:

```dataweave
%dw 2.0
import * from dw::util::Values
output application/xml
---
(payload mask "ssn" with "****") mask "password" with "****"
```

Input XML Payload:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<users>
  <user>
    <personal_information>
      <first_name>EMILIANO</first_name>
      <middle_name>ROMOALDO</middle_name>
      <last_name>LESENDE</last_name>
      <ssn>001-08-84382</ssn>
    </personal_information>
    <login_information>
      <username>3miliano</username>
      <password>mypassword1234</password>
    </login_information>
  </user>
  <user>
    <personal_information>
      <first_name>MARIANO</first_name>
      <middle_name>TORIBIO</middle_name>
      <last_name>DE ACHAVAL</last_name>
      <ssn>002-05-34738</ssn>
    </personal_information>
    <login_information>
      <username>machaval</username>
      <password>mypassword4321</password>
    </login_information>
  </user>
</users>
```

Output XML:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<users>
  <user>
    <personal_information>
      <first_name>EMILIANO</first_name>
      <middle_name>ROMOALDO</middle_name>
      <last_name>LESENDE</last_name>
      <ssn>****</ssn>
    </personal_information>
    <login_information>
      <username>3miliano</username>
      <password>****</password>
    </login_information>
  </user>
  <user>
    <personal_information>
      <first_name>MARIANO</first_name>
      <middle_name>TORIBIO</middle_name>
      <last_name>DE ACHAVAL</last_name>
      <ssn>****</ssn>
    </personal_information>
    <login_information>
      <username>machaval</username>
      <password>****</password>
    </login_information>
  </user>
</users>
```

## Related Examples

- [Transform XML to JSON](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-perform-basic-transformation)

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-output-a-field-when-present)

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-insert-attribute)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.3/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.3/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook)

<!-- document id=f102e1a0fc58a13e9afdd79622b3dad6aca23a317de1405dd3b5b4a7af69a086 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook-change-value-of-a-field.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, transform, transformer, format, rename, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, update
---

# Change the Value of a Field

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following DataWeave examples show how to use `update` and `mask` to change the values of some
XML elements.

## Example: Using Update to Change Values

This example uses:

- `update` to update specified fields of the payload with new values

- single-value (`.`) and multi-value (`.*`) selectors to navigate the payload and select the fields
  to update

The following script shows how the `update` operator works. The example creates a new `users` list
by updating each `user` in the payload with a new `user`. The transformation converts `first_name`,
`middle_name` and `last_name` to uppercase values:

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
payload update {
  case user at .users.*user -> user update {
    case .personal_information.first_name -> upper(user.personal_information.first_name)
    case .personal_information.middle_name -> upper(user.personal_information.middle_name)
    case .personal_information.last_name -> upper(user.personal_information.last_name)
  }
}
```

Input XML Payload:

```xml
<users>
    <user>
        <personal_information>
            <first_name>Emiliano</first_name>
            <middle_name>Romoaldo</middle_name>
            <last_name>Lesende</last_name>
            <ssn>001-08-84382</ssn>
        </personal_information>
        <login_information>
            <username>3miliano</username>
            <password>mypassword1234</password>
        </login_information>
    </user>
    <user>
        <personal_information>
            <first_name>Mariano</first_name>
            <middle_name>Toribio</middle_name>
            <last_name>de Achaval</last_name>
            <ssn>002-05-34738</ssn>
        </personal_information>
        <login_information>
            <username>machaval</username>
            <password>mypassword4321</password>
        </login_information>
    </user>
</users>
```

Output XML:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<users>
  <user>
    <personal_information>
      <first_name>EMILIANO</first_name>
      <middle_name>ROMOALDO</middle_name>
      <last_name>LESENDE</last_name>
      <ssn>001-08-84382</ssn>
    </personal_information>
    <login_information>
      <username>3miliano</username>
      <password>mypassword1234</password>
    </login_information>
  </user>
  <user>
    <personal_information>
      <first_name>MARIANO</first_name>
      <middle_name>TORIBIO</middle_name>
      <last_name>DE ACHAVAL</last_name>
      <ssn>002-05-34738</ssn>
    </personal_information>
    <login_information>
      <username>machaval</username>
      <password>mypassword4321</password>
    </login_information>
  </user>
</users>
```

## Example: Using Mask to Change Values

DataWeave provides a simple way to mask values, without specifying the path to each field:

- `mask` updates all simple elements that match the selected name throughout the input with the
  specified mask.

The following example masks the `ssn` and `password` values with a set of asterisks (`****`):

DataWeave Script:

```dataweave
%dw 2.0
import * from dw::util::Values
output application/xml
---
(payload mask "ssn" with "****") mask "password" with "****"
```

Input XML Payload:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<users>
  <user>
    <personal_information>
      <first_name>EMILIANO</first_name>
      <middle_name>ROMOALDO</middle_name>
      <last_name>LESENDE</last_name>
      <ssn>001-08-84382</ssn>
    </personal_information>
    <login_information>
      <username>3miliano</username>
      <password>mypassword1234</password>
    </login_information>
  </user>
  <user>
    <personal_information>
      <first_name>MARIANO</first_name>
      <middle_name>TORIBIO</middle_name>
      <last_name>DE ACHAVAL</last_name>
      <ssn>002-05-34738</ssn>
    </personal_information>
    <login_information>
      <username>machaval</username>
      <password>mypassword4321</password>
    </login_information>
  </user>
</users>
```

Output XML:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<users>
  <user>
    <personal_information>
      <first_name>EMILIANO</first_name>
      <middle_name>ROMOALDO</middle_name>
      <last_name>LESENDE</last_name>
      <ssn>****</ssn>
    </personal_information>
    <login_information>
      <username>3miliano</username>
      <password>****</password>
    </login_information>
  </user>
  <user>
    <personal_information>
      <first_name>MARIANO</first_name>
      <middle_name>TORIBIO</middle_name>
      <last_name>DE ACHAVAL</last_name>
      <ssn>****</ssn>
    </personal_information>
    <login_information>
      <username>machaval</username>
      <password>****</password>
    </login_information>
  </user>
</users>
```

## Related Examples

- [Transform XML to JSON](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-perform-basic-transformation)

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-output-a-field-when-present)

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-insert-attribute)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.4/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.4/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook)

<!-- document id=9b45467ae68d2d01da48c7f6a11c046ab72e30dd742d3548ab31db441a9a6292 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook-change-value-of-a-field.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, transform, transformer, format, rename, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, update
---

# Change the Value of a Field

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following DataWeave examples show how to use `update` and `mask` to change the values of some
XML elements.

## Example: Using Update to Change Values

This example uses:

- `update` to update specified fields of the payload with new values

- single-value (`.`) and multi-value (`.*`) selectors to navigate the payload and select the fields
  to update

The following script shows how the `update` operator works. The example creates a new `users` list
by updating each `user` in the payload with a new `user`. The transformation converts `first_name`,
`middle_name` and `last_name` to uppercase values:

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
payload update {
  case user at .users.*user -> user update {
    case .personal_information.first_name -> upper(user.personal_information.first_name)
    case .personal_information.middle_name -> upper(user.personal_information.middle_name)
    case .personal_information.last_name -> upper(user.personal_information.last_name)
  }
}
```

Input XML Payload:

```xml
<users>
    <user>
        <personal_information>
            <first_name>Emiliano</first_name>
            <middle_name>Romoaldo</middle_name>
            <last_name>Lesende</last_name>
            <ssn>001-08-84382</ssn>
        </personal_information>
        <login_information>
            <username>3miliano</username>
            <password>mypassword1234</password>
        </login_information>
    </user>
    <user>
        <personal_information>
            <first_name>Mariano</first_name>
            <middle_name>Toribio</middle_name>
            <last_name>de Achaval</last_name>
            <ssn>002-05-34738</ssn>
        </personal_information>
        <login_information>
            <username>machaval</username>
            <password>mypassword4321</password>
        </login_information>
    </user>
</users>
```

Output XML:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<users>
  <user>
    <personal_information>
      <first_name>EMILIANO</first_name>
      <middle_name>ROMOALDO</middle_name>
      <last_name>LESENDE</last_name>
      <ssn>001-08-84382</ssn>
    </personal_information>
    <login_information>
      <username>3miliano</username>
      <password>mypassword1234</password>
    </login_information>
  </user>
  <user>
    <personal_information>
      <first_name>MARIANO</first_name>
      <middle_name>TORIBIO</middle_name>
      <last_name>DE ACHAVAL</last_name>
      <ssn>002-05-34738</ssn>
    </personal_information>
    <login_information>
      <username>machaval</username>
      <password>mypassword4321</password>
    </login_information>
  </user>
</users>
```

## Example: Using Mask to Change Values

DataWeave provides a simple way to mask values, without specifying the path to each field:

- `mask` updates all simple elements that match the selected name throughout the input with the
  specified mask.

The following example masks the `ssn` and `password` values with a set of asterisks (`****`):

DataWeave Script:

```dataweave
%dw 2.0
import * from dw::util::Values
output application/xml
---
(payload mask "ssn" with "****") mask "password" with "****"
```

Input XML Payload:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<users>
  <user>
    <personal_information>
      <first_name>EMILIANO</first_name>
      <middle_name>ROMOALDO</middle_name>
      <last_name>LESENDE</last_name>
      <ssn>001-08-84382</ssn>
    </personal_information>
    <login_information>
      <username>3miliano</username>
      <password>mypassword1234</password>
    </login_information>
  </user>
  <user>
    <personal_information>
      <first_name>MARIANO</first_name>
      <middle_name>TORIBIO</middle_name>
      <last_name>DE ACHAVAL</last_name>
      <ssn>002-05-34738</ssn>
    </personal_information>
    <login_information>
      <username>machaval</username>
      <password>mypassword4321</password>
    </login_information>
  </user>
</users>
```

Output XML:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<users>
  <user>
    <personal_information>
      <first_name>EMILIANO</first_name>
      <middle_name>ROMOALDO</middle_name>
      <last_name>LESENDE</last_name>
      <ssn>****</ssn>
    </personal_information>
    <login_information>
      <username>3miliano</username>
      <password>****</password>
    </login_information>
  </user>
  <user>
    <personal_information>
      <first_name>MARIANO</first_name>
      <middle_name>TORIBIO</middle_name>
      <last_name>DE ACHAVAL</last_name>
      <ssn>****</ssn>
    </personal_information>
    <login_information>
      <username>machaval</username>
      <password>****</password>
    </login_information>
  </user>
</users>
```

## Related Examples

- [Transform XML to JSON](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-perform-basic-transformation)

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-output-a-field-when-present)

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-insert-attribute)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.6/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.6/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook)

<!-- document id=3ed05ebf2291258212325756639fe8164b11f9db08074ed967ef061b82677ec4 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook-change-value-of-a-field.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, transform, transformer, format, rename, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, update
---

# Change the Value of a Field

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following DataWeave examples show how to use `update` and `mask` to change the values of some
XML elements.

## Example: Using Update to Change Values

This example uses:

- `update` to update specified fields of the payload with new values

- single-value (`.`) and multi-value (`.*`) selectors to navigate the payload and select the fields
  to update

The following script shows how the `update` operator works. The example creates a new `users` list
by updating each `user` in the payload with a new `user`. The transformation converts `first_name`,
`middle_name` and `last_name` to uppercase values:

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
payload update {
  case user at .users.*user -> user update {
    case .personal_information.first_name -> upper(user.personal_information.first_name)
    case .personal_information.middle_name -> upper(user.personal_information.middle_name)
    case .personal_information.last_name -> upper(user.personal_information.last_name)
  }
}
```

Input XML Payload:

```xml
<users>
    <user>
        <personal_information>
            <first_name>Emiliano</first_name>
            <middle_name>Romoaldo</middle_name>
            <last_name>Lesende</last_name>
            <ssn>001-08-84382</ssn>
        </personal_information>
        <login_information>
            <username>3miliano</username>
            <password>mypassword1234</password>
        </login_information>
    </user>
    <user>
        <personal_information>
            <first_name>Mariano</first_name>
            <middle_name>Toribio</middle_name>
            <last_name>de Achaval</last_name>
            <ssn>002-05-34738</ssn>
        </personal_information>
        <login_information>
            <username>machaval</username>
            <password>mypassword4321</password>
        </login_information>
    </user>
</users>
```

Output XML:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<users>
  <user>
    <personal_information>
      <first_name>EMILIANO</first_name>
      <middle_name>ROMOALDO</middle_name>
      <last_name>LESENDE</last_name>
      <ssn>001-08-84382</ssn>
    </personal_information>
    <login_information>
      <username>3miliano</username>
      <password>mypassword1234</password>
    </login_information>
  </user>
  <user>
    <personal_information>
      <first_name>MARIANO</first_name>
      <middle_name>TORIBIO</middle_name>
      <last_name>DE ACHAVAL</last_name>
      <ssn>002-05-34738</ssn>
    </personal_information>
    <login_information>
      <username>machaval</username>
      <password>mypassword4321</password>
    </login_information>
  </user>
</users>
```

## Example: Using Mask to Change Values

DataWeave provides a simple way to mask values, without specifying the path to each field:

- `mask` updates all simple elements that match the selected name throughout the input with the
  specified mask.

The following example masks the `ssn` and `password` values with a set of asterisks (`****`):

DataWeave Script:

```dataweave
%dw 2.0
import * from dw::util::Values
output application/xml
---
(payload mask "ssn" with "****") mask "password" with "****"
```

Input XML Payload:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<users>
  <user>
    <personal_information>
      <first_name>EMILIANO</first_name>
      <middle_name>ROMOALDO</middle_name>
      <last_name>LESENDE</last_name>
      <ssn>001-08-84382</ssn>
    </personal_information>
    <login_information>
      <username>3miliano</username>
      <password>mypassword1234</password>
    </login_information>
  </user>
  <user>
    <personal_information>
      <first_name>MARIANO</first_name>
      <middle_name>TORIBIO</middle_name>
      <last_name>DE ACHAVAL</last_name>
      <ssn>002-05-34738</ssn>
    </personal_information>
    <login_information>
      <username>machaval</username>
      <password>mypassword4321</password>
    </login_information>
  </user>
</users>
```

Output XML:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<users>
  <user>
    <personal_information>
      <first_name>EMILIANO</first_name>
      <middle_name>ROMOALDO</middle_name>
      <last_name>LESENDE</last_name>
      <ssn>****</ssn>
    </personal_information>
    <login_information>
      <username>3miliano</username>
      <password>****</password>
    </login_information>
  </user>
  <user>
    <personal_information>
      <first_name>MARIANO</first_name>
      <middle_name>TORIBIO</middle_name>
      <last_name>DE ACHAVAL</last_name>
      <ssn>****</ssn>
    </personal_information>
    <login_information>
      <username>machaval</username>
      <password>****</password>
    </login_information>
  </user>
</users>
```

## Related Examples

- [Transform XML to JSON](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-perform-basic-transformation)

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-output-a-field-when-present)

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-insert-attribute)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.9/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.9/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook)

<!-- document id=9a9fd6d5d0f24d841ae6b6c557972f087245b3869d9066d360b244456469b58c url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook-change-value-of-a-field.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, transform, transformer, format, rename, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, update
---

# Change the Value of a Field

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following DataWeave examples show how to use `update` and `mask` to change the values of some
XML elements.

## Example: Using Update to Change Values

This example uses:

- `update` to update specified fields of the payload with new values

- single-value (`.`) and multi-value (`.*`) selectors to navigate the payload and select the fields
  to update

The following script shows how the `update` operator works. The example creates a new `users` list
by updating each `user` in the payload with a new `user`. The transformation converts `first_name`,
`middle_name` and `last_name` to uppercase values:

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
payload update {
  case user at .users.*user -> user update {
    case .personal_information.first_name -> upper(user.personal_information.first_name)
    case .personal_information.middle_name -> upper(user.personal_information.middle_name)
    case .personal_information.last_name -> upper(user.personal_information.last_name)
  }
}
```

Input XML Payload:

```xml
<users>
    <user>
        <personal_information>
            <first_name>Emiliano</first_name>
            <middle_name>Romoaldo</middle_name>
            <last_name>Lesende</last_name>
            <ssn>001-08-84382</ssn>
        </personal_information>
        <login_information>
            <username>3miliano</username>
            <password>mypassword1234</password>
        </login_information>
    </user>
    <user>
        <personal_information>
            <first_name>Mariano</first_name>
            <middle_name>Toribio</middle_name>
            <last_name>de Achaval</last_name>
            <ssn>002-05-34738</ssn>
        </personal_information>
        <login_information>
            <username>machaval</username>
            <password>mypassword4321</password>
        </login_information>
    </user>
</users>
```

Output XML:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<users>
  <user>
    <personal_information>
      <first_name>EMILIANO</first_name>
      <middle_name>ROMOALDO</middle_name>
      <last_name>LESENDE</last_name>
      <ssn>001-08-84382</ssn>
    </personal_information>
    <login_information>
      <username>3miliano</username>
      <password>mypassword1234</password>
    </login_information>
  </user>
  <user>
    <personal_information>
      <first_name>MARIANO</first_name>
      <middle_name>TORIBIO</middle_name>
      <last_name>DE ACHAVAL</last_name>
      <ssn>002-05-34738</ssn>
    </personal_information>
    <login_information>
      <username>machaval</username>
      <password>mypassword4321</password>
    </login_information>
  </user>
</users>
```

## Example: Using Mask to Change Values

DataWeave provides a simple way to mask values, without specifying the path to each field:

- `mask` updates all simple elements that match the selected name throughout the input with the
  specified mask.

The following example masks the `ssn` and `password` values with a set of asterisks (`****`):

DataWeave Script:

```dataweave
%dw 2.0
import * from dw::util::Values
output application/xml
---
(payload mask "ssn" with "****") mask "password" with "****"
```

Input XML Payload:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<users>
  <user>
    <personal_information>
      <first_name>EMILIANO</first_name>
      <middle_name>ROMOALDO</middle_name>
      <last_name>LESENDE</last_name>
      <ssn>001-08-84382</ssn>
    </personal_information>
    <login_information>
      <username>3miliano</username>
      <password>mypassword1234</password>
    </login_information>
  </user>
  <user>
    <personal_information>
      <first_name>MARIANO</first_name>
      <middle_name>TORIBIO</middle_name>
      <last_name>DE ACHAVAL</last_name>
      <ssn>002-05-34738</ssn>
    </personal_information>
    <login_information>
      <username>machaval</username>
      <password>mypassword4321</password>
    </login_information>
  </user>
</users>
```

Output XML:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<users>
  <user>
    <personal_information>
      <first_name>EMILIANO</first_name>
      <middle_name>ROMOALDO</middle_name>
      <last_name>LESENDE</last_name>
      <ssn>****</ssn>
    </personal_information>
    <login_information>
      <username>3miliano</username>
      <password>****</password>
    </login_information>
  </user>
  <user>
    <personal_information>
      <first_name>MARIANO</first_name>
      <middle_name>TORIBIO</middle_name>
      <last_name>DE ACHAVAL</last_name>
      <ssn>****</ssn>
    </personal_information>
    <login_information>
      <username>machaval</username>
      <password>****</password>
    </login_information>
  </user>
</users>
```

## Related Examples

- [Transform XML to JSON](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-perform-basic-transformation)

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-output-a-field-when-present)

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-insert-attribute)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/latest/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook)

<!-- document id=d5ec1d10e5d0d401bcd693929b86a676cc328e01b71c720e301643fa327ce57f url=/mulesoft/current/en-us/dataweave/2.11/dw-strings-functions-charcode.md -->

---
product: DataWeave
version: 2.11
---

# charCode

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## charCode(text: String): Number

Returns the Unicode for the first character in an input string.

For an empty string, the function fails and returns `Unexpected empty string`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example returns Unicode for the "M" in "Mule".

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "charCode" : charCode("Mule")
}
```

#### Output

```XML
{ "charCode" : 77 }
```

## charCode(text: Null): Null

Helper function that enables `charCode` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=83df6ab687c68a63520c374a1ad58cfb2da9367610f1c91b78406242e7a0e2e8 url=/mulesoft/current/en-us/dataweave/2.12/dw-strings-functions-charcode.md -->

---
product: DataWeave
version: 2.12
---

# charCode

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## charCode(text: String): Number

Returns the Unicode for the first character in an input string.

For an empty string, the function fails and returns `Unexpected empty string`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example returns Unicode for the "M" in "Mule".

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "charCode" : charCode("Mule")
}
```

#### Output

```XML
{ "charCode" : 77 }
```

## charCode(text: Null): Null

Helper function that enables `charCode` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=88299dd9b4d966eaafaec8f2d1699965731631056aa7ae97f9dca876c0652631 url=/mulesoft/current/en-us/dataweave/2.3/dw-strings-functions-charcode.md -->

---
product: DataWeave
version: 2.3
---

# charCode

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## charCode(String): Number

Returns the Unicode for the first character in an input string.

For an empty string, the function fails and returns `Unexpected empty string`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example returns Unicode for the "M" in "Mule".

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "charCode" : charCode("Mule")
}
```

#### Output

```XML
{ "charCode" : 77 }
```

<!-- document id=4c12a825b17ec6ebe581c87498405915aff2c57551fb4bf1414b8092b6d7737b url=/mulesoft/current/en-us/dataweave/2.4/dw-strings-functions-charcode.md -->

---
product: DataWeave
version: 2.4
---

# charCode

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## charCode(text: String): Number

Returns the Unicode for the first character in an input string.

For an empty string, the function fails and returns `Unexpected empty string`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example returns Unicode for the "M" in "Mule".

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "charCode" : charCode("Mule")
}
```

#### Output

```XML
{ "charCode" : 77 }
```

## charCode(text: Null): Null

Helper function that enables `charCode` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=098cf99a0a3861cb8194996892b7047228db732cb3f6c8af3851b3a6176b0c7e url=/mulesoft/current/en-us/dataweave/2.6/dw-strings-functions-charcode.md -->

---
product: DataWeave
version: 2.6
---

# charCode

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## charCode(text: String): Number

Returns the Unicode for the first character in an input string.

For an empty string, the function fails and returns `Unexpected empty string`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example returns Unicode for the "M" in "Mule".

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "charCode" : charCode("Mule")
}
```

#### Output

```XML
{ "charCode" : 77 }
```

## charCode(text: Null): Null

Helper function that enables `charCode` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=26d6acf43dad1cc800b99087fddc25933b2d33224f80c4242e69d4539c5f4b95 url=/mulesoft/current/en-us/dataweave/2.9/dw-strings-functions-charcode.md -->

---
product: DataWeave
version: 2.9
---

# charCode

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## charCode(text: String): Number

Returns the Unicode for the first character in an input string.

For an empty string, the function fails and returns `Unexpected empty string`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example returns Unicode for the "M" in "Mule".

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "charCode" : charCode("Mule")
}
```

#### Output

```XML
{ "charCode" : 77 }
```

## charCode(text: Null): Null

Helper function that enables `charCode` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=d03f4bda91eae96aa40e20fcdc36c545cfb17d94f7e8aa9e75ec02124062d4c1 url=/mulesoft/current/en-us/dataweave/latest/dw-strings-functions-charcode.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# charCode

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## charCode(text: String): Number

Returns the Unicode for the first character in an input string.

For an empty string, the function fails and returns `Unexpected empty string`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example returns Unicode for the "M" in "Mule".

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "charCode" : charCode("Mule")
}
```

#### Output

```XML
{ "charCode" : 77 }
```

## charCode(text: Null): Null

Helper function that enables `charCode` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=f84364b081b1ac2005473b326e25b214edeeec958c5c71d38bb72e1b2bdb57f4 url=/mulesoft/current/en-us/dataweave/2.11/dw-strings-functions-charcodeat.md -->

---
product: DataWeave
version: 2.11
---

# charCodeAt

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## charCodeAt(content: String, position: Number): Number

Returns the Unicode for a character at the specified index.

This function fails if the index is invalid.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>position</code></p></td><td><p>The index (a <code>Number</code> type) of a character in the string (as a string array). Note that the index of the first character is <code>0</code>.</p></td></tr></tbody></table>

### Example

This example returns Unicode for the "u" at index `1` in "MuleSoft".

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "charCodeAt" : charCodeAt("MuleSoft", 1)
}
```

#### Output

```JSON
{ "charCodeAt": 117 }
```

## charCodeAt(content: Null, position: Any): Null

Helper function that enables `charCodeAt` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=87cfb72ceb58b3addfebac669c0a4be146a972361564e9ae9c7f19f1af68528a url=/mulesoft/current/en-us/dataweave/2.12/dw-strings-functions-charcodeat.md -->

---
product: DataWeave
version: 2.12
---

# charCodeAt

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## charCodeAt(content: String, position: Number): Number

Returns the Unicode for a character at the specified index.

This function fails if the index is invalid.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>position</code></p></td><td><p>The index (a <code>Number</code> type) of a character in the string (as a string array). Note that the index of the first character is <code>0</code>.</p></td></tr></tbody></table>

### Example

This example returns Unicode for the "u" at index `1` in "MuleSoft".

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "charCodeAt" : charCodeAt("MuleSoft", 1)
}
```

#### Output

```JSON
{ "charCodeAt": 117 }
```

## charCodeAt(content: Null, position: Any): Null

Helper function that enables `charCodeAt` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=0138425c9320b35c3ac8b67d4a88205739f5a6f749284365449b7de9b42add3a url=/mulesoft/current/en-us/dataweave/2.3/dw-strings-functions-charcodeat.md -->

---
product: DataWeave
version: 2.3
---

# charCodeAt

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## charCodeAt(String, Number): Number

Returns the Unicode for a character at the specified index.

This function fails if the index is invalid.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>position</code></p></td><td><p>The index (a <code>Number</code> type) of a character in the string (as a string array). Note that the index of the first character is <code>0</code>.</p></td></tr></tbody></table>

### Example

This example returns Unicode for the "u" at index `1` in "MuleSoft".

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "charCodeAt" : charCodeAt("MuleSoft", 1)
}
```

#### Output

```JSON
{ "charCodeAt": 117 }
```

<!-- document id=8b6063a4108e7a377e3091cfc580d9ee4c8e7798985140826defe00d11e0a2b5 url=/mulesoft/current/en-us/dataweave/2.4/dw-strings-functions-charcodeat.md -->

---
product: DataWeave
version: 2.4
---

# charCodeAt

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## charCodeAt(content: String, position: Number): Number

Returns the Unicode for a character at the specified index.

This function fails if the index is invalid.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>position</code></p></td><td><p>The index (a <code>Number</code> type) of a character in the string (as a string array). Note that the index of the first character is <code>0</code>.</p></td></tr></tbody></table>

### Example

This example returns Unicode for the "u" at index `1` in "MuleSoft".

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "charCodeAt" : charCodeAt("MuleSoft", 1)
}
```

#### Output

```JSON
{ "charCodeAt": 117 }
```

## charCodeAt(content: Null, position: Any): Null

Helper function that enables `charCodeAt` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=8172f967293531472839292570b1752cd268a764a09651800ca335dfffa919dd url=/mulesoft/current/en-us/dataweave/2.6/dw-strings-functions-charcodeat.md -->

---
product: DataWeave
version: 2.6
---

# charCodeAt

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## charCodeAt(content: String, position: Number): Number

Returns the Unicode for a character at the specified index.

This function fails if the index is invalid.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>position</code></p></td><td><p>The index (a <code>Number</code> type) of a character in the string (as a string array). Note that the index of the first character is <code>0</code>.</p></td></tr></tbody></table>

### Example

This example returns Unicode for the "u" at index `1` in "MuleSoft".

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "charCodeAt" : charCodeAt("MuleSoft", 1)
}
```

#### Output

```JSON
{ "charCodeAt": 117 }
```

## charCodeAt(content: Null, position: Any): Null

Helper function that enables `charCodeAt` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=89ae526d59ef153bc40667c4a7ec28270170dcec2cceb44791ab9cb94931da7d url=/mulesoft/current/en-us/dataweave/2.9/dw-strings-functions-charcodeat.md -->

---
product: DataWeave
version: 2.9
---

# charCodeAt

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## charCodeAt(content: String, position: Number): Number

Returns the Unicode for a character at the specified index.

This function fails if the index is invalid.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>position</code></p></td><td><p>The index (a <code>Number</code> type) of a character in the string (as a string array). Note that the index of the first character is <code>0</code>.</p></td></tr></tbody></table>

### Example

This example returns Unicode for the "u" at index `1` in "MuleSoft".

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "charCodeAt" : charCodeAt("MuleSoft", 1)
}
```

#### Output

```JSON
{ "charCodeAt": 117 }
```

## charCodeAt(content: Null, position: Any): Null

Helper function that enables `charCodeAt` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=1fa9d22dbaebd83e8257f5708c5ea39018fe1b6c8f9ca0c46e05c74349c5f1a9 url=/mulesoft/current/en-us/dataweave/latest/dw-strings-functions-charcodeat.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# charCodeAt

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## charCodeAt(content: String, position: Number): Number

Returns the Unicode for a character at the specified index.

This function fails if the index is invalid.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>position</code></p></td><td><p>The index (a <code>Number</code> type) of a character in the string (as a string array). Note that the index of the first character is <code>0</code>.</p></td></tr></tbody></table>

### Example

This example returns Unicode for the "u" at index `1` in "MuleSoft".

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "charCodeAt" : charCodeAt("MuleSoft", 1)
}
```

#### Output

```JSON
{ "charCodeAt": 117 }
```

## charCodeAt(content: Null, position: Any): Null

Helper function that enables `charCodeAt` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=96bbcd1b8c4cf2a69af77270b4fa3e7b16ca479c2bf36722db35a1f07773b6c9 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-formats-copybook.md -->

---
product: DataWeave
version: 2.11
---

# COBOL Copybook Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME Type: `application/flatfile`

ID: `flatfile`

A COBOL copybook is a type of flat file that describes the layout of records and fields in a COBOL
data file.

The Transform Message component provides settings for handling the COBOL copybook format. For
example, you can import a COBOL definition into the Transform Message component and use it for your
Copybook transformations.

> [!NOTE] COBOL copybook in DataWeave supports files of up to 15 MB, and the memory requirement is
> roughly 40 to 1. For example, a 1-MB file requires up to 40 MB of memory to process, so it’s
> important to consider this memory requirement in conjunction with your TPS needs for large
> copybook files. This is not an exact figure; the value might vary according to the complexity of
> the mapping instructions.

## Importing a Copybook Definition

When you import a Copybook definition, the Transform Message component converts the definition to a
flat file schema that you can reference with `schemaPath` property.

To import a copybook definition:

1.  Right-click the input payload in the Transform component in Studio, and select **Set Metadata**
    to open the Set Metadata Type dialog.

    Note that you need to create a metadata type before you can import a copybook definition.

2.  Provide a name for your copybook metadata, such as `copybook`.

3.  Select the Copybook type from the **Type** drop-down menu.

4.  Import your copybook definition file.

5.  Click Select.

    ![A selecting metadata type interface for importing a copybook definition file](/mulesoft/current/en-us/dataweave/2.11/_images/copybook-import.png)

    Figure 1. Importing a Copybook Definition File

For example, assume that you have a copybook definition file (`mailing-record.cpy`) that looks like
this:

       01  MAILING-RECORD.
           05  COMPANY-NAME            PIC X(30).
           05  CONTACTS.
               10  PRESIDENT.
                   15  LAST-NAME       PIC X(15).
                   15  FIRST-NAME      PIC X(8).
               10  VP-MARKETING.
                   15  LAST-NAME       PIC X(15).
                   15  FIRST-NAME      PIC X(8).
               10  ALTERNATE-CONTACT.
                   15  TITLE           PIC X(10).
                   15  LAST-NAME       PIC X(15).
                   15  FIRST-NAME      PIC X(8).
           05  ADDRESS                 PIC X(15).
           05  CITY                    PIC X(15).
           05  STATE                   PIC XX.
           05  ZIP                     PIC 9(5).

- Copybook definitions must always begin with a `01` entry. A separate record type is generated for
  each `01` definition in your copybook (there must be at least one `01` definition for the copybook
  to be usable, so add one using an arbitrary name at the start of the copybook if none is present).
  If there are multiple `01` definitions in the copybook file, you can select which definition to
  use in the transform from the dropdown list.

- COBOL format requires definitions to only use columns 7-72 of each line. Data in columns 1-5 and
  past column 72 is ignored by the import process. Column 6 is a line continuation marker.

When you import the schema, the Transform component converts the copybook file to a flat file schema
that it stores in the `src/main/resources/schema` folder of your Mule project. In flat file format,
the copybook definition above looks like this:

form: COPYBOOK id: 'MAILING-RECORD' values:

- { name: 'COMPANY-NAME', type: String, length: 30 }
- name: 'CONTACTS' values:
  - name: 'PRESIDENT' values:
    - { name: 'LAST-NAME', type: String, length: 15 }
    - { name: 'FIRST-NAME', type: String, length: 8 }
  - name: 'VP-MARKETING' values:
    - { name: 'LAST-NAME', type: String, length: 15 }
    - { name: 'FIRST-NAME', type: String, length: 8 }
  - name: 'ALTERNATE-CONTACT' values:
    - { name: 'TITLE', type: String, length: 10 }
    - { name: 'LAST-NAME', type: String, length: 15 }
    - { name: 'FIRST-NAME', type: String, length: 8 }
- { name: 'ADDRESS', type: String, length: 15 }
- { name: 'CITY', type: String, length: 15 }
- { name: 'STATE', type: String, length: 2 }
- { name: 'ZIP', type: Integer, length: 5, format: { justify: ZEROES, sign: UNSIGNED } }

After importing the copybook, you can use the `schemaPath` property to reference the associated flat
file through the `output` directive. For example:
`output application/flatfile schemaPath="src/main/resources/schemas/mailing-record.ffd"`

## Supported Copybook Features

Not all copybook features are supported by the COBOL Copybook format in DataWeave. In general, the
format supports most common usages and simple patterns, including:

- USAGE of DISPLAY, BINARY (COMP), COMP-5, and PACKED-DECIMAL (COMP-3). For character encoding
  restrictions, see [Character Encodings](#character_encoding).

- PICTURE clauses for numeric values consisting only of:

  - '9' - One or more numeric character positions

  - 'S' - One optional sign character position, leading or trailing

  - 'V' - One optional decimal point

  - 'P' - One or more decimal scaling positions

- PICTURE clauses for alphanumeric values consisting only of 'X' character positions

- Repetition counts for '9', 'P', and 'X' characters in PICTURE clauses (as in `9(5)` for a 5-digit
  numeric value)

- OCCURS DEPENDING ON with `controlVal` property in schema. Note that if the control value is nested
  inside a containing structure, you need to manually modify the generated schema to specify the
  full path for the value in the form "container.value".

- REDEFINES clause (used to provide different views of the same portion of record data - see details
  in section below)

_Unsupported_ features include:

- Alphanumeric-edited PICTURE clauses

- Numeric-edited PICTURE clauses, including all forms of insertion, replacement, and zero
  suppression

- Special level-numbers:

  - Level 66 - Alternate name for field or group

  - Level 77 - Independent data item

  - Level 88 - Condition names (equivalent to an enumeration of values)

- SIGN clause at group level (only supported on elementary items with PICTURE clause)

- USAGE of COMP-1 or COMP-2 and of clause at group level (only supported on elementary items with
  PICTURE clause)

- VALUE clause (used to define a value of a data item or conditional name from a literal or another
  data item)

- SYNC clause (used to align values within a record)

## REDEFINES Support

REDEFINES facilitates dynamic interpretation of data in a record. When you import a copybook with
REDEFINES present, the generated schema uses a special grouping with the name '\*' (or '\*1', '\*2',
and so on, if multiple REDEFINES groupings are present at the same level) to combine all the
different interpretations. You use this special grouping name in your DataWeave expressions just as
you use any other grouping name.

Use of REDEFINES groupings has higher overhead than normal copybook groupings, so MuleSoft
recommends that you remove REDEFINES from your copybooks where possible before you import them into
Studio.

## Character Encodings

BINARY (COMP), COMP-5, or PACKED-DECIMAL (COMP-3) usages are only supported with single-byte
character encodings, which use the entire range of 256 potential character codes. UTF-8 and other
variable-length encodings are not supported for these usages (because they’re not single-byte), and
ASCII is also not supported (because it doesn’t use the entire range). Supported character encodings
include ISO-8859-1 (an extension of ASCII to full 8 bits) and other 8859 variations and EBCDIC
(IBM037).

REDEFINES requires you to use a single-byte-per-character character encoding for the data, but any
single-byte-per-character encoding can be used unless BINARY (COMP), COMP-5, or PACKED-DECIMAL
(COMP-3) usages are included in the data.

## Common Copybook Import Issues

The most common issue with copybook imports is a failure to follow the COBOL standard for input line
regions. The copybook import parsing ignores the contents of columns 1-6 of each line, and ignores
all lines with an '\*' (asterisk) in column 7. It also ignores everything beyond column 72 in each
line. This means that all your actual data definitions need to be within columns 8 through 72 of
input lines.

Tabs in the input are not expanded because there is no defined standard for tab positions. Each tab
character is treated as a single space character when counting copybook input columns.

Indentation is ignored when processing the copybook, with only level-numbers treated as significant.
This is not normally a problem, but it means that copybooks might be accepted for import even though
they are not accepted by COBOL compilers.

Both warnings and errors might be reported as a result of a copybook import. Warnings generally tell
of unsupported or unrecognized features, which might or might not be significant. Errors are
notifications of a problem that means the generated schema (if any) will not be a completely
accurate representation of the copybook. You should review any warnings or errors reported and
decide on the appropriate handling, which might be simply accepting the schema as generated,
modifying the input copybook, or modifying the generated schema.

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>allowLenientWithBinaryNotEndElement</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>When the schema contains elements of type Binary or Packed, the <code>lenient</code> option does not allow short records, regardless of the last element’s format type. When you set this property to <code>true</code>, the validation applies only to cases in which the record ends with type Binary or Packed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>enforceRequires</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Produces an error when set to <code>true</code> if a required value is missing.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>missingValues</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Fill character used to represent missing values. To activate a non-default setting, set the <code>useMissCharAsDefaultForFill</code> property to <code>true</code>, and use one of the following values to <code>missingValues</code>:</p></div><div><ul><li><p><code>none</code> (for the reader) or <code>NONE</code> (for the writer): Treats all data as values.</p></li><li><p><code>spaces</code> (for the reader) or <code>SPACES</code> (for the writer): Interprets a field consisting of only spaces as a missing value. Default for flat file and fixed-width formats.</p></li><li><p><code>zeroes</code> (for the reader) or <code>ZEROES</code> (for the writer): Interprets numeric fields consisting of only <code>0</code> characters <em>and</em> character fields consisting of only spaces as missing values.</p></li><li><p><code>nulls</code> (for the reader) or <code>NULLS</code> (for the writer): Interprets a field consisting only of <code>0</code> bytes as a missing value. Default for COBOL copybook schema.</p></li></ul></div></div></td></tr><tr><td><p><code>notTruncateDependingOnSubjectNotPresent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Fills the entire group when the DEPENDING ON subject is not present.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>recordParsing</code></p></td><td><p><code>String</code></p></td><td><p><code>'strict'</code></p></td><td><div><div><p>Specifies the expected type of separation between lines or records:</p></div><div><ul><li><p><code>strict</code>: Line break is expected at exact end of each record. <code>strict</code> is the default.</p></li><li><p><code>lenient</code>: Line break is used, but records can be shorter or longer than the schema specifies. Do not use <code>lenient</code> if your payload lacks line breaks. The other options to <code>recordParsing</code> support records that lack line breaks.</p></li><li><p><code>noTerminator</code>: Records follow one another with no separation. This option is preferred for fixed-length records that lack a line break.</p></li><li><p><code>singleRecord</code>: The entire input is a single record.</p></li></ul></div><div><p>Note that schemas with type <code>Binary</code> or <code>Packed</code> don’t allow for line break detection, so setting <code>recordParsing</code> to <code>lenient</code> only allows long records to be handled, not short ones. These schemas also currently only work with certain single-byte character encodings (so not with UTF-8 or any multibyte format).</p></div></div></td></tr><tr><td><p><code>retainEmptyStringFieldsOnParsing</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Allow parsing behavior to keep missing string value fields with a default value in the output map</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>schemaPath</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Path to the schema definition. Specifies the location in your local disk of the schema file that parses your input.</p></div></div></td></tr><tr><td><p><code>segmentIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Segment identifier in the schema for fixed-width or COBOL copybook schemas. Required when parsing a single segment or record definition if the schema includes multiple segment definitions.</p></div></div></td></tr><tr><td><p><code>structureIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Structure identifier in the schema for flat file schemas. Required when parsing a structure definition if the schema includes multiple structure definitions.</p></div></div></td></tr><tr><td><p><code>truncateDependingOn</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, truncates DEPENDING ON values to the length used.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>useMissCharAsDefaultForFill</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>By default, the flat file reader and writer use spaces for missing characters and ignore the setting of the <code>missingValues</code> property. When you set this property to <code>true</code>, DataWeave honors the setting of the <code>missingValues property</code>. Introduced in DataWeave 2.3 (2.3.0-20210823) for the September 2021 release of Mule 4.3.0-20210823.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>zonedDecimalStrict</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, uses the 'strict' ASCII form of sign encoding for zoned decimal values.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr><tr><td><p><code>enforceRequires</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Produces an error when set to <code>true</code> if a required value is missing.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>missingValues</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Fill character used to represent missing values. To activate a non-default setting, set the <code>useMissCharAsDefaultForFill</code> property to <code>true</code>, and use one of the following values to <code>missingValues</code>:</p></div><div><ul><li><p><code>none</code> (for the reader) or <code>NONE</code> (for the writer): Treats all data as values.</p></li><li><p><code>spaces</code> (for the reader) or <code>SPACES</code> (for the writer): Interprets a field consisting of only spaces as a missing value. Default for flat file and fixed-width formats.</p></li><li><p><code>zeroes</code> (for the reader) or <code>ZEROES</code> (for the writer): Interprets numeric fields consisting of only <code>0</code> characters <em>and</em> character fields consisting of only spaces as missing values.</p></li><li><p><code>nulls</code> (for the reader) or <code>NULLS</code> (for the writer): Interprets a field consisting only of <code>0</code> bytes as a missing value. Default for COBOL copybook schema.</p></li></ul></div></div></td></tr><tr><td><p><code>notTruncateDependingOnSubjectNotPresent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Fills the entire group when the DEPENDING ON subject is not present.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>recordTerminator</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Line break for a record separator. Valid values: <code>lf</code>, <code>cr</code>, <code>crlf</code>, <code>none</code>. Note that in Mule versions 4.0.4 and later, this is only used as a separator when there are multiple records. Values translate directly to character codes (<code>none</code> leaves no termination on each record).</p></div></div></td></tr><tr><td><p><code>schemaPath</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Path to the schema definition. Specifies the location in your local disk of the schema file that parses your input.</p></div></div></td></tr><tr><td><p><code>segmentIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Segment identifier in the schema for fixed-width or COBOL copybook schemas. Required when parsing a single segment or record definition if the schema includes multiple segment definitions.</p></div></div></td></tr><tr><td><p><code>structureIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Structure identifier in the schema for flat file schemas. Required when parsing a structure definition if the schema includes multiple structure definitions.</p></div></div></td></tr><tr><td><p><code>trimValues</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Trim values that are longer than the width of a field.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>truncateDependingOn</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, truncates DEPENDING ON values to the length used.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>useMissCharAsDefaultForFill</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>By default, the flat file reader and writer use spaces for missing characters and ignore the setting of the <code>missingValues</code> property. When you set this property to <code>true</code>, DataWeave honors the setting of the <code>missingValues property</code>. Introduced in DataWeave 2.3 (2.3.0-20210823) for the September 2021 release of Mule 4.3.0-20210823.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>zonedDecimalStrict</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, uses the 'strict' ASCII form of sign encoding for zoned decimal values.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

The COBOL Copybook format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/flatfile</code></p></td></tr></tbody></table>

<!-- document id=886c8f7257144e53235e482ddadb68cc442069813095879ba02bb087519d745f url=/mulesoft/current/en-us/dataweave/2.12/dataweave-formats-copybook.md -->

---
product: DataWeave
version: 2.12
---

# COBOL Copybook Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME Type: `application/flatfile`

ID: `flatfile`

A COBOL copybook is a type of flat file that describes the layout of records and fields in a COBOL
data file.

The Transform Message component provides settings for handling the COBOL copybook format. For
example, you can import a COBOL definition into the Transform Message component and use it for your
Copybook transformations.

> [!NOTE] COBOL copybook in DataWeave supports files of up to 15 MB, and the memory requirement is
> roughly 40 to 1. For example, a 1-MB file requires up to 40 MB of memory to process, so it’s
> important to consider this memory requirement in conjunction with your TPS needs for large
> copybook files. This is not an exact figure; the value might vary according to the complexity of
> the mapping instructions.

## Importing a Copybook Definition

When you import a Copybook definition, the Transform Message component converts the definition to a
flat file schema that you can reference with `schemaPath` property.

To import a copybook definition:

1.  Right-click the input payload in the Transform component in Studio, and select **Set Metadata**
    to open the Set Metadata Type dialog.

    Note that you need to create a metadata type before you can import a copybook definition.

2.  Provide a name for your copybook metadata, such as `copybook`.

3.  Select the Copybook type from the **Type** drop-down menu.

4.  Import your copybook definition file.

5.  Click Select.

    ![A selecting metadata type interface for importing a copybook definition file](/mulesoft/current/en-us/dataweave/2.12/_images/copybook-import.png)

    Figure 1. Importing a Copybook Definition File

For example, assume that you have a copybook definition file (`mailing-record.cpy`) that looks like
this:

       01  MAILING-RECORD.
           05  COMPANY-NAME            PIC X(30).
           05  CONTACTS.
               10  PRESIDENT.
                   15  LAST-NAME       PIC X(15).
                   15  FIRST-NAME      PIC X(8).
               10  VP-MARKETING.
                   15  LAST-NAME       PIC X(15).
                   15  FIRST-NAME      PIC X(8).
               10  ALTERNATE-CONTACT.
                   15  TITLE           PIC X(10).
                   15  LAST-NAME       PIC X(15).
                   15  FIRST-NAME      PIC X(8).
           05  ADDRESS                 PIC X(15).
           05  CITY                    PIC X(15).
           05  STATE                   PIC XX.
           05  ZIP                     PIC 9(5).

- Copybook definitions must always begin with a `01` entry. A separate record type is generated for
  each `01` definition in your copybook (there must be at least one `01` definition for the copybook
  to be usable, so add one using an arbitrary name at the start of the copybook if none is present).
  If there are multiple `01` definitions in the copybook file, you can select which definition to
  use in the transform from the dropdown list.

- COBOL format requires definitions to only use columns 7-72 of each line. Data in columns 1-5 and
  past column 72 is ignored by the import process. Column 6 is a line continuation marker.

When you import the schema, the Transform component converts the copybook file to a flat file schema
that it stores in the `src/main/resources/schema` folder of your Mule project. In flat file format,
the copybook definition above looks like this:

form: COPYBOOK id: 'MAILING-RECORD' values:

- { name: 'COMPANY-NAME', type: String, length: 30 }
- name: 'CONTACTS' values:
  - name: 'PRESIDENT' values:
    - { name: 'LAST-NAME', type: String, length: 15 }
    - { name: 'FIRST-NAME', type: String, length: 8 }
  - name: 'VP-MARKETING' values:
    - { name: 'LAST-NAME', type: String, length: 15 }
    - { name: 'FIRST-NAME', type: String, length: 8 }
  - name: 'ALTERNATE-CONTACT' values:
    - { name: 'TITLE', type: String, length: 10 }
    - { name: 'LAST-NAME', type: String, length: 15 }
    - { name: 'FIRST-NAME', type: String, length: 8 }
- { name: 'ADDRESS', type: String, length: 15 }
- { name: 'CITY', type: String, length: 15 }
- { name: 'STATE', type: String, length: 2 }
- { name: 'ZIP', type: Integer, length: 5, format: { justify: ZEROES, sign: UNSIGNED } }

After importing the copybook, you can use the `schemaPath` property to reference the associated flat
file through the `output` directive. For example:
`output application/flatfile schemaPath="src/main/resources/schemas/mailing-record.ffd"`

## Supported Copybook Features

Not all copybook features are supported by the COBOL Copybook format in DataWeave. In general, the
format supports most common usages and simple patterns, including:

- USAGE of DISPLAY, BINARY (COMP), COMP-5, and PACKED-DECIMAL (COMP-3). For character encoding
  restrictions, see [Character Encodings](#character_encoding).

- PICTURE clauses for numeric values consisting only of:

  - '9' - One or more numeric character positions

  - 'S' - One optional sign character position, leading or trailing

  - 'V' - One optional decimal point

  - 'P' - One or more decimal scaling positions

- PICTURE clauses for alphanumeric values consisting only of 'X' character positions

- Repetition counts for '9', 'P', and 'X' characters in PICTURE clauses (as in `9(5)` for a 5-digit
  numeric value)

- OCCURS DEPENDING ON with `controlVal` property in schema. Note that if the control value is nested
  inside a containing structure, you need to manually modify the generated schema to specify the
  full path for the value in the form "container.value".

- REDEFINES clause (used to provide different views of the same portion of record data - see details
  in section below)

_Unsupported_ features include:

- Alphanumeric-edited PICTURE clauses

- Numeric-edited PICTURE clauses, including all forms of insertion, replacement, and zero
  suppression

- Special level-numbers:

  - Level 66 - Alternate name for field or group

  - Level 77 - Independent data item

  - Level 88 - Condition names (equivalent to an enumeration of values)

- SIGN clause at group level (only supported on elementary items with PICTURE clause)

- USAGE of COMP-1 or COMP-2 and of clause at group level (only supported on elementary items with
  PICTURE clause)

- VALUE clause (used to define a value of a data item or conditional name from a literal or another
  data item)

- SYNC clause (used to align values within a record)

## REDEFINES Support

REDEFINES facilitates dynamic interpretation of data in a record. When you import a copybook with
REDEFINES present, the generated schema uses a special grouping with the name '\*' (or '\*1', '\*2',
and so on, if multiple REDEFINES groupings are present at the same level) to combine all the
different interpretations. You use this special grouping name in your DataWeave expressions just as
you use any other grouping name.

Use of REDEFINES groupings has higher overhead than normal copybook groupings, so MuleSoft
recommends that you remove REDEFINES from your copybooks where possible before you import them into
Studio.

## Character Encodings

BINARY (COMP), COMP-5, or PACKED-DECIMAL (COMP-3) usages are only supported with single-byte
character encodings, which use the entire range of 256 potential character codes. UTF-8 and other
variable-length encodings are not supported for these usages (because they’re not single-byte), and
ASCII is also not supported (because it doesn’t use the entire range). Supported character encodings
include ISO-8859-1 (an extension of ASCII to full 8 bits) and other 8859 variations and EBCDIC
(IBM037).

REDEFINES requires you to use a single-byte-per-character character encoding for the data, but any
single-byte-per-character encoding can be used unless BINARY (COMP), COMP-5, or PACKED-DECIMAL
(COMP-3) usages are included in the data.

## Common Copybook Import Issues

The most common issue with copybook imports is a failure to follow the COBOL standard for input line
regions. The copybook import parsing ignores the contents of columns 1-6 of each line, and ignores
all lines with an '\*' (asterisk) in column 7. It also ignores everything beyond column 72 in each
line. This means that all your actual data definitions need to be within columns 8 through 72 of
input lines.

Tabs in the input are not expanded because there is no defined standard for tab positions. Each tab
character is treated as a single space character when counting copybook input columns.

Indentation is ignored when processing the copybook, with only level-numbers treated as significant.
This is not normally a problem, but it means that copybooks might be accepted for import even though
they are not accepted by COBOL compilers.

Both warnings and errors might be reported as a result of a copybook import. Warnings generally tell
of unsupported or unrecognized features, which might or might not be significant. Errors are
notifications of a problem that means the generated schema (if any) will not be a completely
accurate representation of the copybook. You should review any warnings or errors reported and
decide on the appropriate handling, which might be simply accepting the schema as generated,
modifying the input copybook, or modifying the generated schema.

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>allowLenientWithBinaryNotEndElement</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>When the schema contains elements of type Binary or Packed, the <code>lenient</code> option does not allow short records, regardless of the last element’s format type. When you set this property to <code>true</code>, the validation applies only to cases in which the record ends with type Binary or Packed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>enforceRequires</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Produces an error when set to <code>true</code> if a required value is missing.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>missingValues</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Fill character used to represent missing values. To activate a non-default setting, set the <code>useMissCharAsDefaultForFill</code> property to <code>true</code>, and use one of the following values to <code>missingValues</code>:</p></div><div><ul><li><p><code>none</code> (for the reader) or <code>NONE</code> (for the writer): Treats all data as values.</p></li><li><p><code>spaces</code> (for the reader) or <code>SPACES</code> (for the writer): Interprets a field consisting of only spaces as a missing value. Default for flat file and fixed-width formats.</p></li><li><p><code>zeroes</code> (for the reader) or <code>ZEROES</code> (for the writer): Interprets numeric fields consisting of only <code>0</code> characters <em>and</em> character fields consisting of only spaces as missing values.</p></li><li><p><code>nulls</code> (for the reader) or <code>NULLS</code> (for the writer): Interprets a field consisting only of <code>0</code> bytes as a missing value. Default for COBOL copybook schema.</p></li></ul></div></div></td></tr><tr><td><p><code>notTruncateDependingOnSubjectNotPresent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Fills the entire group when the DEPENDING ON subject is not present.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>recordParsing</code></p></td><td><p><code>String</code></p></td><td><p><code>'strict'</code></p></td><td><div><div><p>Specifies the expected type of separation between lines or records:</p></div><div><ul><li><p><code>strict</code>: Line break is expected at exact end of each record. <code>strict</code> is the default.</p></li><li><p><code>lenient</code>: Line break is used, but records can be shorter or longer than the schema specifies. Do not use <code>lenient</code> if your payload lacks line breaks. The other options to <code>recordParsing</code> support records that lack line breaks.</p></li><li><p><code>noTerminator</code>: Records follow one another with no separation. This option is preferred for fixed-length records that lack a line break.</p></li><li><p><code>singleRecord</code>: The entire input is a single record.</p></li></ul></div><div><p>Note that schemas with type <code>Binary</code> or <code>Packed</code> don’t allow for line break detection, so setting <code>recordParsing</code> to <code>lenient</code> only allows long records to be handled, not short ones. These schemas also currently only work with certain single-byte character encodings (so not with UTF-8 or any multibyte format).</p></div></div></td></tr><tr><td><p><code>retainEmptyStringFieldsOnParsing</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Allow parsing behavior to keep missing string value fields with a default value in the output map</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>schemaPath</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Path to the schema definition. Specifies the location in your local disk of the schema file that parses your input.</p></div></div></td></tr><tr><td><p><code>segmentIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Segment identifier in the schema for fixed-width or COBOL copybook schemas. Required when parsing a single segment or record definition if the schema includes multiple segment definitions.</p></div></div></td></tr><tr><td><p><code>structureIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Structure identifier in the schema for flat file schemas. Required when parsing a structure definition if the schema includes multiple structure definitions.</p></div></div></td></tr><tr><td><p><code>truncateDependingOn</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, truncates DEPENDING ON values to the length used.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>useMissCharAsDefaultForFill</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>By default, the flat file reader and writer use spaces for missing characters and ignore the setting of the <code>missingValues</code> property. When you set this property to <code>true</code>, DataWeave honors the setting of the <code>missingValues property</code>. Introduced in DataWeave 2.3 (2.3.0-20210823) for the September 2021 release of Mule 4.3.0-20210823.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>zonedDecimalStrict</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, uses the 'strict' ASCII form of sign encoding for zoned decimal values.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr><tr><td><p><code>enforceRequires</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Produces an error when set to <code>true</code> if a required value is missing.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>missingValues</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Fill character used to represent missing values. To activate a non-default setting, set the <code>useMissCharAsDefaultForFill</code> property to <code>true</code>, and use one of the following values to <code>missingValues</code>:</p></div><div><ul><li><p><code>none</code> (for the reader) or <code>NONE</code> (for the writer): Treats all data as values.</p></li><li><p><code>spaces</code> (for the reader) or <code>SPACES</code> (for the writer): Interprets a field consisting of only spaces as a missing value. Default for flat file and fixed-width formats.</p></li><li><p><code>zeroes</code> (for the reader) or <code>ZEROES</code> (for the writer): Interprets numeric fields consisting of only <code>0</code> characters <em>and</em> character fields consisting of only spaces as missing values.</p></li><li><p><code>nulls</code> (for the reader) or <code>NULLS</code> (for the writer): Interprets a field consisting only of <code>0</code> bytes as a missing value. Default for COBOL copybook schema.</p></li></ul></div></div></td></tr><tr><td><p><code>notTruncateDependingOnSubjectNotPresent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Fills the entire group when the DEPENDING ON subject is not present.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>recordTerminator</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Line break for a record separator. Valid values: <code>lf</code>, <code>cr</code>, <code>crlf</code>, <code>none</code>. Note that in Mule versions 4.0.4 and later, this is only used as a separator when there are multiple records. Values translate directly to character codes (<code>none</code> leaves no termination on each record).</p></div></div></td></tr><tr><td><p><code>schemaPath</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Path to the schema definition. Specifies the location in your local disk of the schema file that parses your input.</p></div></div></td></tr><tr><td><p><code>segmentIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Segment identifier in the schema for fixed-width or COBOL copybook schemas. Required when parsing a single segment or record definition if the schema includes multiple segment definitions.</p></div></div></td></tr><tr><td><p><code>structureIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Structure identifier in the schema for flat file schemas. Required when parsing a structure definition if the schema includes multiple structure definitions.</p></div></div></td></tr><tr><td><p><code>trimValues</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Trim values that are longer than the width of a field.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>truncateDependingOn</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, truncates DEPENDING ON values to the length used.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>useMissCharAsDefaultForFill</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>By default, the flat file reader and writer use spaces for missing characters and ignore the setting of the <code>missingValues</code> property. When you set this property to <code>true</code>, DataWeave honors the setting of the <code>missingValues property</code>. Introduced in DataWeave 2.3 (2.3.0-20210823) for the September 2021 release of Mule 4.3.0-20210823.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>zonedDecimalStrict</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, uses the 'strict' ASCII form of sign encoding for zoned decimal values.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

The COBOL Copybook format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/flatfile</code></p></td></tr></tbody></table>

<!-- document id=554a5d10a613ac8c1c84f1808d1fa77e7286942edf953b3a58779993be85edd4 url=/mulesoft/current/en-us/dataweave/2.3/dataweave-formats-copybook.md -->

---
product: DataWeave
version: 2.3
---

# COBOL Copybook Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME Type: `application/flatfile`

ID: `flatfile`

A COBOL copybook is a type of flat file that describes the layout of records and fields in a COBOL
data file.

The Transform Message component provides settings for handling the COBOL copybook format. For
example, you can import a COBOL definition into the Transform Message component and use it for your
Copybook transformations.

> [!NOTE] COBOL copybook in DataWeave supports files of up to 15 MB, and the memory requirement is
> roughly 40 to 1. For example, a 1-MB file requires up to 40 MB of memory to process, so it’s
> important to consider this memory requirement in conjunction with your TPS needs for large
> copybook files. This is not an exact figure; the value might vary according to the complexity of
> the mapping instructions.

## Importing a Copybook Definition

When you import a Copybook definition, the Transform Message component converts the definition to a
flat file schema that you can reference with `schemaPath` property.

To import a copybook definition:

1.  Right-click the input payload in the Transform component in Studio, and select **Set Metadata**
    to open the Set Metadata Type dialog.

    Note that you need to create a metadata type before you can import a copybook definition.

2.  Provide a name for your copybook metadata, such as `copybook`.

3.  Select the Copybook type from the **Type** drop-down menu.

4.  Import your copybook definition file.

5.  Click Select.

    ![A selecting metadata type interface for importing a copybook definition file](/mulesoft/current/en-us/dataweave/2.3/_images/copybook-import.png)

    Figure 1. Importing a Copybook Definition File

For example, assume that you have a copybook definition file (`mailing-record.cpy`) that looks like
this:

       01  MAILING-RECORD.
           05  COMPANY-NAME            PIC X(30).
           05  CONTACTS.
               10  PRESIDENT.
                   15  LAST-NAME       PIC X(15).
                   15  FIRST-NAME      PIC X(8).
               10  VP-MARKETING.
                   15  LAST-NAME       PIC X(15).
                   15  FIRST-NAME      PIC X(8).
               10  ALTERNATE-CONTACT.
                   15  TITLE           PIC X(10).
                   15  LAST-NAME       PIC X(15).
                   15  FIRST-NAME      PIC X(8).
           05  ADDRESS                 PIC X(15).
           05  CITY                    PIC X(15).
           05  STATE                   PIC XX.
           05  ZIP                     PIC 9(5).

- Copybook definitions must always begin with a `01` entry. A separate record type is generated for
  each `01` definition in your copybook (there must be at least one `01` definition for the copybook
  to be usable, so add one using an arbitrary name at the start of the copybook if none is present).
  If there are multiple `01` definitions in the copybook file, you can select which definition to
  use in the transform from the dropdown list.

- COBOL format requires definitions to only use columns 7-72 of each line. Data in columns 1-5 and
  past column 72 is ignored by the import process. Column 6 is a line continuation marker.

When you import the schema, the Transform component converts the copybook file to a flat file schema
that it stores in the `src/main/resources/schema` folder of your Mule project. In flat file format,
the copybook definition above looks like this:

form: COPYBOOK id: 'MAILING-RECORD' values:

- { name: 'COMPANY-NAME', type: String, length: 30 }
- name: 'CONTACTS' values:
  - name: 'PRESIDENT' values:
    - { name: 'LAST-NAME', type: String, length: 15 }
    - { name: 'FIRST-NAME', type: String, length: 8 }
  - name: 'VP-MARKETING' values:
    - { name: 'LAST-NAME', type: String, length: 15 }
    - { name: 'FIRST-NAME', type: String, length: 8 }
  - name: 'ALTERNATE-CONTACT' values:
    - { name: 'TITLE', type: String, length: 10 }
    - { name: 'LAST-NAME', type: String, length: 15 }
    - { name: 'FIRST-NAME', type: String, length: 8 }
- { name: 'ADDRESS', type: String, length: 15 }
- { name: 'CITY', type: String, length: 15 }
- { name: 'STATE', type: String, length: 2 }
- { name: 'ZIP', type: Integer, length: 5, format: { justify: ZEROES, sign: UNSIGNED } }

After importing the copybook, you can use the `schemaPath` property to reference the associated flat
file through the `output` directive. For example:
`output application/flatfile schemaPath="src/main/resources/schemas/mailing-record.ffd"`

## Supported Copybook Features

Not all copybook features are supported by the COBOL Copybook format in DataWeave. In general, the
format supports most common usages and simple patterns, including:

- USAGE of DISPLAY, BINARY (COMP), COMP-5, and PACKED-DECIMAL (COMP-3). For character encoding
  restrictions, see [Character Encodings](#character_encoding).

- PICTURE clauses for numeric values consisting only of:

  - '9' - One or more numeric character positions

  - 'S' - One optional sign character position, leading or trailing

  - 'V' - One optional decimal point

  - 'P' - One or more decimal scaling positions

- PICTURE clauses for alphanumeric values consisting only of 'X' character positions

- Repetition counts for '9', 'P', and 'X' characters in PICTURE clauses (as in `9(5)` for a 5-digit
  numeric value)

- OCCURS DEPENDING ON with `controlVal` property in schema. Note that if the control value is nested
  inside a containing structure, you need to manually modify the generated schema to specify the
  full path for the value in the form "container.value".

- REDEFINES clause (used to provide different views of the same portion of record data - see details
  in section below)

_Unsupported_ features include:

- Alphanumeric-edited PICTURE clauses

- Numeric-edited PICTURE clauses, including all forms of insertion, replacement, and zero
  suppression

- Special level-numbers:

  - Level 66 - Alternate name for field or group

  - Level 77 - Independent data item

  - Level 88 - Condition names (equivalent to an enumeration of values)

- SIGN clause at group level (only supported on elementary items with PICTURE clause)

- USAGE of COMP-1 or COMP-2 and of clause at group level (only supported on elementary items with
  PICTURE clause)

- VALUE clause (used to define a value of a data item or conditional name from a literal or another
  data item)

- SYNC clause (used to align values within a record)

## REDEFINES Support

REDEFINES facilitates dynamic interpretation of data in a record. When you import a copybook with
REDEFINES present, the generated schema uses a special grouping with the name '\*' (or '\*1', '\*2',
and so on, if multiple REDEFINES groupings are present at the same level) to combine all the
different interpretations. You use this special grouping name in your DataWeave expressions just as
you use any other grouping name.

Use of REDEFINES groupings has higher overhead than normal copybook groupings, so MuleSoft
recommends that you remove REDEFINES from your copybooks where possible before you import them into
Studio.

## Character Encodings

BINARY (COMP), COMP-5, or PACKED-DECIMAL (COMP-3) usages are only supported with single-byte
character encodings, which use the entire range of 256 potential character codes. UTF-8 and other
variable-length encodings are not supported for these usages (because they’re not single-byte), and
ASCII is also not supported (because it doesn’t use the entire range). Supported character encodings
include ISO-8859-1 (an extension of ASCII to full 8 bits) and other 8859 variations and EBCDIC
(IBM037).

REDEFINES requires you to use a single-byte-per-character character encoding for the data, but any
single-byte-per-character encoding can be used unless BINARY (COMP), COMP-5, or PACKED-DECIMAL
(COMP-3) usages are included in the data.

## Common Copybook Import Issues

The most common issue with copybook imports is a failure to follow the COBOL standard for input line
regions. The copybook import parsing ignores the contents of columns 1-6 of each line, and ignores
all lines with an '\*' (asterisk) in column 7. It also ignores everything beyond column 72 in each
line. This means that all your actual data definitions need to be within columns 8 through 72 of
input lines.

Tabs in the input are not expanded because there is no defined standard for tab positions. Each tab
character is treated as a single space character when counting copybook input columns.

Indentation is ignored when processing the copybook, with only level-numbers treated as significant.
This is not normally a problem, but it means that copybooks might be accepted for import even though
they are not accepted by COBOL compilers.

Both warnings and errors might be reported as a result of a copybook import. Warnings generally tell
of unsupported or unrecognized features, which might or might not be significant. Errors are
notifications of a problem that means the generated schema (if any) will not be a completely
accurate representation of the copybook. You should review any warnings or errors reported and
decide on the appropriate handling, which might be simply accepting the schema as generated,
modifying the input copybook, or modifying the generated schema.

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

DataWeave accepts properties that provide instructions for reading input data in this format.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>allowLenientWithBinaryNotEndElement</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>When the schema contains elements of type Binary or Packed, the <code>lenient</code> option does not allow short records, regardless of the last element’s format type. When you set this property to <code>true</code>, the validation applies only to cases in which the record ends with type Binary or Packed.</p></div></div></td></tr><tr><td><p><code>enforceRequires</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Error if required value missing. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>missingValues</code></p></td><td><p><code>String</code></p></td><td><p><code>nulls</code> for copybook schema, <code>spaces</code> otherwise</p></td><td><div><div><p>Fill character used to represent missing values. To activate a non-default setting, set the <code>useMissCharAsDefaultForFill</code> property to <code>true</code>, and use one of the following values to <code>missingValues</code>:</p></div><div><ul><li><p><code>none</code>: Treat all data as actual values</p></li><li><p><code>spaces</code>: Interpret a field consisting of only spaces as a missing value</p></li><li><p><code>zeroes</code>: Interpret numeric fields consisting of only '0' characters and character fields consisting of only spaces as missing values</p></li><li><p><code>nulls</code>: Interpret a field consisting only of 0 bytes as a missing value</p></li></ul></div></div></td></tr><tr><td><p><code>notTruncateDependingOnSubjectNotPresent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Fills the entire group when the DEPENDING ON subject is not present. <em>Introduced in DataWeave 2.3 with the August 2021 release of Mule 4.3.0-20210622.</em></p></div></div></td></tr><tr><td><p><code>recordParsing</code></p></td><td><p><code>String</code></p></td><td><p><code>strict</code></p></td><td><div><div><p>Expected separation between lines/records:</p></div><div><ul><li><p><code>strict</code>: Line break expected at exact end of each record.</p></li><li><p><code>lenient</code>: Line break is used, but records can be shorter or longer than the schema specifies. Do not use <code>lenient</code> if your payload lacks line breaks. The other options to <code>recordParsing</code> support records that lack line breaks.</p></li><li><p><code>noTerminator</code>: Records follow one another with no separation. This option is preferred for fixed-length records that lack a line break.</p></li><li><p><code>singleRecord</code>: Entire input is a single record.</p></li></ul></div><div><p>Note that schemas with type <code>Binary</code> or <code>Packed</code> don’t allow for line break detection, so setting <code>recordParsing</code> to <code>lenient</code> only allows long records to be handled, not short ones. These schemas also currently only work with certain single-byte character encodings (so not with UTF-8 or any multibyte format).</p></div></div></td></tr><tr><td><p><code>schemaPath</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Schema definition. Location in your local disk of the schema file used to parse your input.</p></div></div></td></tr><tr><td><p><code>segmentIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Segment identifier in the schema for fixed width or copybook schemas (only needed when parsing a single segment/record definition and if the schema includes multiple segment definitions).</p></div></div></td></tr><tr><td><p><code>structureIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Structure identifier in schema for flatfile schemas (only needed when parsing a structure definition, and if the schema includes multiple structure definitions)</p></div></div></td></tr><tr><td><p><code>truncateDependingOn</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Truncate COBOL copybook DEPENDING ON values to the length used. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>useMissCharAsDefaultForFill</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>By default, the flat file reader and writer use spaces for missing characters and ignore the setting of the <code>missingValues</code> property. When you set this property to <code>true</code>, the reader honors the setting of the <code>missingValues</code> property. <em>Introduced in DataWeave 2.3 (2.3.0-20210823) for the September 2021 release of Mule 4.3.0-20210823.</em> Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>zonedDecimalStrict</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Use the <code>strict</code> ASCII form of sign encoding for COBOL copybook zoned decimal values. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

DataWeave accepts properties that provide instructions for writing output data in this format.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>When set to <code>true</code>, DataWeave generates the output as a data stream, and the script’s execution is deferred until it is consumed. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Encoding to be used by this writer, such as <code>UTF-8</code>.</p></div></div></td></tr><tr><td><p><code>enforceRequires</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Error if a required value is missing. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>missingValues</code></p></td><td><p><code>String</code></p></td><td><p><code>NULLS</code> for copybook schema, <code>SPACES</code> otherwise</p></td><td><div><div><p>Fill character used to represent missing values. To activate a non-default setting, use <code>useMissCharAsDefaultForFill</code>, and use one of the following values to <code>missingValues</code>:</p></div><div><ul><li><p><code>NONE</code>: Write nothing for missing values.</p></li><li><p><code>SPACES</code>: Fill the field with spaces.</p></li><li><p><code>ZEROES</code>: Fill numeric fields with <code>0</code> characters and character fields with space characters.</p></li><li><p><code>NULLS</code>: Fill the field with 0 bytes.</p></li></ul></div></div></td></tr><tr><td><p><code>notTruncateDependingOnSubjectNotPresent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Fills the entire group when the DEPENDING ON subject is not present. <em>Introduced in DataWeave 2.3 with the August 2021 release of Mule 4.3.0-20210622.</em></p></div></div></td></tr><tr><td><p><code>recordTerminator</code></p></td><td><p><code>String</code></p></td><td><p>System property <code>line.separator</code></p></td><td><div><div><p>Record separator line break. Valid values:</p></div><div><ul><li><p><code>lf</code></p></li><li><p><code>cr</code></p></li><li><p><code>crlf</code></p></li><li><p><code>none</code></p></li></ul></div><div><p>Note that in Mule versions 4.0.4 and later, this is only used as a separator when there are multiple records. Values translate directly to character codes (<code>none</code> leaves no termination on each record).</p></div></div></td></tr><tr><td><p><code>retainEmptyStringFieldsOnParsing</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>When set to <code>true</code>, this property makes the reader retain fields that lack values and set their values to an empty string. <em>Introduced in the January 2023 version of DataWeave 2.3 for Mule version 4.3.0-20221212.</em></p></div></div></td></tr><tr><td><p><code>schemaPath</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Schema definition. Path where the schema file to be used is located.</p></div></div></td></tr><tr><td><p><code>segmentIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Segment identifier in the schema for fixed width or copybook schemas (only needed when writing a single segment/record definition, and if the schema includes multiple segment definitions).</p></div></div></td></tr><tr><td><p><code>structureIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Structure identifier in schema for flatfile schemas (only needed when writing a structure definition and if the schema includes multiple structure definitions).</p></div></div></td></tr><tr><td><p><code>trimValues</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Trim string values that are longer than the field width by truncating trailing characters. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>truncateDependingOn</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Truncate COBOL copybook DEPENDING ON values to the length used. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>useMissCharAsDefaultForFill</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>By default, the flat file reader and writer use spaces for missing characters and ignore the setting of the <code>missingValues</code> property. When you set this property to <code>true</code>, the writer honors the setting of the <code>missingValues</code> property. <em>Introduced in DataWeave 2.3 (2.3.0-20210823) for the September 2021 release of Mule 4.3.0-20210823.</em></p></div></div></td></tr><tr><td><p><code>zonedDecimalStrict</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Use the <code>strict</code> ASCII form of sign encoding for COBOL copybook zoned decimal values. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

The COBOL Copybook format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/flatfile</code></p></td></tr></tbody></table>

<!-- document id=81c3bee731a3e7517b151f2c386b531cdb639415f85887fd2531383e320aaaf3 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-formats-copybook.md -->

---
product: DataWeave
version: 2.4
---

# COBOL Copybook Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME Type: `application/flatfile`

ID: `flatfile`

A COBOL copybook is a type of flat file that describes the layout of records and fields in a COBOL
data file.

The Transform Message component provides settings for handling the COBOL copybook format. For
example, you can import a COBOL definition into the Transform Message component and use it for your
Copybook transformations.

> [!NOTE] COBOL copybook in DataWeave supports files of up to 15 MB, and the memory requirement is
> roughly 40 to 1. For example, a 1-MB file requires up to 40 MB of memory to process, so it’s
> important to consider this memory requirement in conjunction with your TPS needs for large
> copybook files. This is not an exact figure; the value might vary according to the complexity of
> the mapping instructions.

## Importing a Copybook Definition

When you import a Copybook definition, the Transform Message component converts the definition to a
flat file schema that you can reference with `schemaPath` property.

To import a copybook definition:

1.  Right-click the input payload in the Transform component in Studio, and select **Set Metadata**
    to open the Set Metadata Type dialog.

    Note that you need to create a metadata type before you can import a copybook definition.

2.  Provide a name for your copybook metadata, such as `copybook`.

3.  Select the Copybook type from the **Type** drop-down menu.

4.  Import your copybook definition file.

5.  Click Select.

    ![A selecting metadata type interface for importing a copybook definition file](/mulesoft/current/en-us/dataweave/2.4/_images/copybook-import.png)

    Figure 1. Importing a Copybook Definition File

For example, assume that you have a copybook definition file (`mailing-record.cpy`) that looks like
this:

       01  MAILING-RECORD.
           05  COMPANY-NAME            PIC X(30).
           05  CONTACTS.
               10  PRESIDENT.
                   15  LAST-NAME       PIC X(15).
                   15  FIRST-NAME      PIC X(8).
               10  VP-MARKETING.
                   15  LAST-NAME       PIC X(15).
                   15  FIRST-NAME      PIC X(8).
               10  ALTERNATE-CONTACT.
                   15  TITLE           PIC X(10).
                   15  LAST-NAME       PIC X(15).
                   15  FIRST-NAME      PIC X(8).
           05  ADDRESS                 PIC X(15).
           05  CITY                    PIC X(15).
           05  STATE                   PIC XX.
           05  ZIP                     PIC 9(5).

- Copybook definitions must always begin with a `01` entry. A separate record type is generated for
  each `01` definition in your copybook (there must be at least one `01` definition for the copybook
  to be usable, so add one using an arbitrary name at the start of the copybook if none is present).
  If there are multiple `01` definitions in the copybook file, you can select which definition to
  use in the transform from the dropdown list.

- COBOL format requires definitions to only use columns 7-72 of each line. Data in columns 1-5 and
  past column 72 is ignored by the import process. Column 6 is a line continuation marker.

When you import the schema, the Transform component converts the copybook file to a flat file schema
that it stores in the `src/main/resources/schema` folder of your Mule project. In flat file format,
the copybook definition above looks like this:

form: COPYBOOK id: 'MAILING-RECORD' values:

- { name: 'COMPANY-NAME', type: String, length: 30 }
- name: 'CONTACTS' values:
  - name: 'PRESIDENT' values:
    - { name: 'LAST-NAME', type: String, length: 15 }
    - { name: 'FIRST-NAME', type: String, length: 8 }
  - name: 'VP-MARKETING' values:
    - { name: 'LAST-NAME', type: String, length: 15 }
    - { name: 'FIRST-NAME', type: String, length: 8 }
  - name: 'ALTERNATE-CONTACT' values:
    - { name: 'TITLE', type: String, length: 10 }
    - { name: 'LAST-NAME', type: String, length: 15 }
    - { name: 'FIRST-NAME', type: String, length: 8 }
- { name: 'ADDRESS', type: String, length: 15 }
- { name: 'CITY', type: String, length: 15 }
- { name: 'STATE', type: String, length: 2 }
- { name: 'ZIP', type: Integer, length: 5, format: { justify: ZEROES, sign: UNSIGNED } }

After importing the copybook, you can use the `schemaPath` property to reference the associated flat
file through the `output` directive. For example:
`output application/flatfile schemaPath="src/main/resources/schemas/mailing-record.ffd"`

## Supported Copybook Features

Not all copybook features are supported by the COBOL Copybook format in DataWeave. In general, the
format supports most common usages and simple patterns, including:

- USAGE of DISPLAY, BINARY (COMP), COMP-5, and PACKED-DECIMAL (COMP-3). For character encoding
  restrictions, see [Character Encodings](#character_encoding).

- PICTURE clauses for numeric values consisting only of:

  - '9' - One or more numeric character positions

  - 'S' - One optional sign character position, leading or trailing

  - 'V' - One optional decimal point

  - 'P' - One or more decimal scaling positions

- PICTURE clauses for alphanumeric values consisting only of 'X' character positions

- Repetition counts for '9', 'P', and 'X' characters in PICTURE clauses (as in `9(5)` for a 5-digit
  numeric value)

- OCCURS DEPENDING ON with `controlVal` property in schema. Note that if the control value is nested
  inside a containing structure, you need to manually modify the generated schema to specify the
  full path for the value in the form "container.value".

- REDEFINES clause (used to provide different views of the same portion of record data - see details
  in section below)

_Unsupported_ features include:

- Alphanumeric-edited PICTURE clauses

- Numeric-edited PICTURE clauses, including all forms of insertion, replacement, and zero
  suppression

- Special level-numbers:

  - Level 66 - Alternate name for field or group

  - Level 77 - Independent data item

  - Level 88 - Condition names (equivalent to an enumeration of values)

- SIGN clause at group level (only supported on elementary items with PICTURE clause)

- USAGE of COMP-1 or COMP-2 and of clause at group level (only supported on elementary items with
  PICTURE clause)

- VALUE clause (used to define a value of a data item or conditional name from a literal or another
  data item)

- SYNC clause (used to align values within a record)

## REDEFINES Support

REDEFINES facilitates dynamic interpretation of data in a record. When you import a copybook with
REDEFINES present, the generated schema uses a special grouping with the name '\*' (or '\*1', '\*2',
and so on, if multiple REDEFINES groupings are present at the same level) to combine all the
different interpretations. You use this special grouping name in your DataWeave expressions just as
you use any other grouping name.

Use of REDEFINES groupings has higher overhead than normal copybook groupings, so MuleSoft
recommends that you remove REDEFINES from your copybooks where possible before you import them into
Studio.

## Character Encodings

BINARY (COMP), COMP-5, or PACKED-DECIMAL (COMP-3) usages are only supported with single-byte
character encodings, which use the entire range of 256 potential character codes. UTF-8 and other
variable-length encodings are not supported for these usages (because they’re not single-byte), and
ASCII is also not supported (because it doesn’t use the entire range). Supported character encodings
include ISO-8859-1 (an extension of ASCII to full 8 bits) and other 8859 variations and EBCDIC
(IBM037).

REDEFINES requires you to use a single-byte-per-character character encoding for the data, but any
single-byte-per-character encoding can be used unless BINARY (COMP), COMP-5, or PACKED-DECIMAL
(COMP-3) usages are included in the data.

## Common Copybook Import Issues

The most common issue with copybook imports is a failure to follow the COBOL standard for input line
regions. The copybook import parsing ignores the contents of columns 1-6 of each line, and ignores
all lines with an '\*' (asterisk) in column 7. It also ignores everything beyond column 72 in each
line. This means that all your actual data definitions need to be within columns 8 through 72 of
input lines.

Tabs in the input are not expanded because there is no defined standard for tab positions. Each tab
character is treated as a single space character when counting copybook input columns.

Indentation is ignored when processing the copybook, with only level-numbers treated as significant.
This is not normally a problem, but it means that copybooks might be accepted for import even though
they are not accepted by COBOL compilers.

Both warnings and errors might be reported as a result of a copybook import. Warnings generally tell
of unsupported or unrecognized features, which might or might not be significant. Errors are
notifications of a problem that means the generated schema (if any) will not be a completely
accurate representation of the copybook. You should review any warnings or errors reported and
decide on the appropriate handling, which might be simply accepting the schema as generated,
modifying the input copybook, or modifying the generated schema.

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

DataWeave accepts properties that provide instructions for reading input data in this format.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>allowLenientWithBinaryNotEndElement</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>When the schema contains elements of type Binary or Packed, the <code>lenient</code> option does not allow short records, regardless of the last element’s format type. When you set this property to <code>true</code>, the validation applies only to cases in which the record ends with type Binary or Packed.</p></div></div></td></tr><tr><td><p><code>enforceRequires</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Error if required value missing. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>missingValues</code></p></td><td><p><code>String</code></p></td><td><p><code>nulls</code> for copybook schema, <code>spaces</code> otherwise</p></td><td><div><div><p>Fill character used to represent missing values. To activate a non-default setting, set the <code>useMissCharAsDefaultForFill</code> property to <code>true</code>, and use one of the following values to <code>missingValues</code>:</p></div><div><ul><li><p><code>none</code>: Treat all data as actual values</p></li><li><p><code>spaces</code>: Interpret a field consisting of only spaces as a missing value</p></li><li><p><code>zeroes</code>: Interpret numeric fields consisting of only '0' characters and character fields consisting of only spaces as missing values</p></li><li><p><code>nulls</code>: Interpret a field consisting only of 0 bytes as a missing value</p></li></ul></div></div></td></tr><tr><td><p><code>notTruncateDependingOnSubjectNotPresent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Fills the entire group when the DEPENDING ON subject is not present. <em>Introduced in DataWeave 2.3 with the August 2021 release of Mule 4.3.0-20210622.</em></p></div></div></td></tr><tr><td><p><code>recordParsing</code></p></td><td><p><code>String</code></p></td><td><p><code>strict</code></p></td><td><div><div><p>Expected separation between lines/records:</p></div><div><ul><li><p><code>strict</code>: Line break expected at exact end of each record.</p></li><li><p><code>lenient</code>: Line break is used, but records can be shorter or longer than the schema specifies. Do not use <code>lenient</code> if your payload lacks line breaks. The other options to <code>recordParsing</code> support records that lack line breaks.</p></li><li><p><code>noTerminator</code>: Records follow one another with no separation. This option is preferred for fixed-length records that lack a line break.</p></li><li><p><code>singleRecord</code>: Entire input is a single record.</p></li></ul></div><div><p>Note that schemas with type <code>Binary</code> or <code>Packed</code> don’t allow for line break detection, so setting <code>recordParsing</code> to <code>lenient</code> only allows long records to be handled, not short ones. These schemas also currently only work with certain single-byte character encodings (so not with UTF-8 or any multibyte format).</p></div></div></td></tr><tr><td><p><code>schemaPath</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Schema definition. Location in your local disk of the schema file used to parse your input.</p></div></div></td></tr><tr><td><p><code>segmentIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Segment identifier in the schema for fixed width or copybook schemas (only needed when parsing a single segment/record definition and if the schema includes multiple segment definitions).</p></div></div></td></tr><tr><td><p><code>structureIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Structure identifier in schema for flatfile schemas (only needed when parsing a structure definition, and if the schema includes multiple structure definitions)</p></div></div></td></tr><tr><td><p><code>truncateDependingOn</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Truncate COBOL copybook DEPENDING ON values to the length used. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>useMissCharAsDefaultForFill</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>By default, the flat file reader and writer use spaces for missing characters and ignore the setting of the <code>missingValues</code> property. When you set this property to <code>true</code>, the reader honors the setting of the <code>missingValues</code> property. <em>Introduced in DataWeave 2.3 (2.3.0-20210823) for the September 2021 release of Mule 4.3.0-20210823.</em> Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>zonedDecimalStrict</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Use the <code>strict</code> ASCII form of sign encoding for COBOL copybook zoned decimal values. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

DataWeave accepts properties that provide instructions for writing output data in this format.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>When set to <code>true</code>, DataWeave generates the output as a data stream, and the script’s execution is deferred until it is consumed. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Encoding to be used by this writer, such as <code>UTF-8</code>.</p></div></div></td></tr><tr><td><p><code>enforceRequires</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Error if a required value is missing. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>missingValues</code></p></td><td><p><code>String</code></p></td><td><p><code>NULLS</code> for copybook schema, <code>SPACES</code> otherwise</p></td><td><div><div><p>Fill character used to represent missing values. To activate a non-default setting, use <code>useMissCharAsDefaultForFill</code>, and use one of the following values to <code>missingValues</code>:</p></div><div><ul><li><p><code>NONE</code>: Write nothing for missing values.</p></li><li><p><code>SPACES</code>: Fill the field with spaces.</p></li><li><p><code>ZEROES</code>: Fill numeric fields with <code>0</code> characters and character fields with space characters.</p></li><li><p><code>NULLS</code>: Fill the field with 0 bytes.</p></li></ul></div></div></td></tr><tr><td><p><code>notTruncateDependingOnSubjectNotPresent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Fills the entire group when the DEPENDING ON subject is not present. <em>Introduced in DataWeave 2.3 with the August 2021 release of Mule 4.3.0-20210622.</em></p></div></div></td></tr><tr><td><p><code>recordTerminator</code></p></td><td><p><code>String</code></p></td><td><p>System property <code>line.separator</code></p></td><td><div><div><p>Record separator line break. Valid values:</p></div><div><ul><li><p><code>lf</code></p></li><li><p><code>cr</code></p></li><li><p><code>crlf</code></p></li><li><p><code>none</code></p></li></ul></div><div><p>Note that in Mule versions 4.0.4 and later, this is only used as a separator when there are multiple records. Values translate directly to character codes. (<code>none</code> leaves no termination on each record).</p></div></div></td></tr><tr><td><p><code>retainEmptyStringFieldsOnParsing</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>When set to <code>true</code>, this property makes the reader retain fields that lack values and set their values to an empty string. The default behavior of the reader is to remove those fields. <em>Introduced in the January 2023 version of DataWeave 2.4 for Mule version 4.4.0-20230102.</em></p></div></div></td></tr><tr><td><p><code>schemaPath</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Schema definition. Path where the schema file to be used is located.</p></div></div></td></tr><tr><td><p><code>segmentIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Segment identifier in the schema for fixed width or copybook schemas (only needed when writing a single segment/record definition, and if the schema includes multiple segment definitions).</p></div></div></td></tr><tr><td><p><code>structureIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Structure identifier in schema for flatfile schemas (only needed when writing a structure definition and if the schema includes multiple structure definitions)</p></div></div></td></tr><tr><td><p><code>trimValues</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Trim string values longer than the field length by truncating trailing characters. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>trimValues</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Indicates whether trim values are longer than the field width. Valid Options are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>truncateDependingOn</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Truncate COBOL copybook DEPENDING ON values to the length used. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>useMissCharAsDefaultForFill</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>By default, the flat file reader and writer use spaces for missing characters and ignore the setting of the <code>missingValues</code> property. When you set this property to <code>true</code>, the writer honors the setting of the <code>missingValues</code> property. <em>Introduced in DataWeave 2.3 (2.3.0-20210823) for the September 2021 release of Mule 4.3.0-20210823.</em></p></div></div></td></tr><tr><td><p><code>zonedDecimalStrict</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Use the <code>strict</code> ASCII form of sign encoding for COBOL copybook zoned decimal values. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

The COBOL Copybook format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/flatfile</code></p></td></tr></tbody></table>

<!-- document id=0ed8e5a37c85c94c415de8182f90120cc73dbb4c5b62ea80e20cf977bbb7fc96 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-formats-copybook.md -->

---
product: DataWeave
version: 2.6
---

# COBOL Copybook Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME Type: `application/flatfile`

ID: `flatfile`

A COBOL copybook is a type of flat file that describes the layout of records and fields in a COBOL
data file.

The Transform Message component provides settings for handling the COBOL copybook format. For
example, you can import a COBOL definition into the Transform Message component and use it for your
Copybook transformations.

> [!NOTE] COBOL copybook in DataWeave supports files of up to 15 MB, and the memory requirement is
> roughly 40 to 1. For example, a 1-MB file requires up to 40 MB of memory to process, so it’s
> important to consider this memory requirement in conjunction with your TPS needs for large
> copybook files. This is not an exact figure; the value might vary according to the complexity of
> the mapping instructions.

## Importing a Copybook Definition

When you import a Copybook definition, the Transform Message component converts the definition to a
flat file schema that you can reference with `schemaPath` property.

To import a copybook definition:

1.  Right-click the input payload in the Transform component in Studio, and select **Set Metadata**
    to open the Set Metadata Type dialog.

    Note that you need to create a metadata type before you can import a copybook definition.

2.  Provide a name for your copybook metadata, such as `copybook`.

3.  Select the Copybook type from the **Type** drop-down menu.

4.  Import your copybook definition file.

5.  Click Select.

    ![A selecting metadata type interface for importing a copybook definition file](/mulesoft/current/en-us/dataweave/2.6/_images/copybook-import.png)

    Figure 1. Importing a Copybook Definition File

For example, assume that you have a copybook definition file (`mailing-record.cpy`) that looks like
this:

       01  MAILING-RECORD.
           05  COMPANY-NAME            PIC X(30).
           05  CONTACTS.
               10  PRESIDENT.
                   15  LAST-NAME       PIC X(15).
                   15  FIRST-NAME      PIC X(8).
               10  VP-MARKETING.
                   15  LAST-NAME       PIC X(15).
                   15  FIRST-NAME      PIC X(8).
               10  ALTERNATE-CONTACT.
                   15  TITLE           PIC X(10).
                   15  LAST-NAME       PIC X(15).
                   15  FIRST-NAME      PIC X(8).
           05  ADDRESS                 PIC X(15).
           05  CITY                    PIC X(15).
           05  STATE                   PIC XX.
           05  ZIP                     PIC 9(5).

- Copybook definitions must always begin with a `01` entry. A separate record type is generated for
  each `01` definition in your copybook (there must be at least one `01` definition for the copybook
  to be usable, so add one using an arbitrary name at the start of the copybook if none is present).
  If there are multiple `01` definitions in the copybook file, you can select which definition to
  use in the transform from the dropdown list.

- COBOL format requires definitions to only use columns 7-72 of each line. Data in columns 1-5 and
  past column 72 is ignored by the import process. Column 6 is a line continuation marker.

When you import the schema, the Transform component converts the copybook file to a flat file schema
that it stores in the `src/main/resources/schema` folder of your Mule project. In flat file format,
the copybook definition above looks like this:

form: COPYBOOK id: 'MAILING-RECORD' values:

- { name: 'COMPANY-NAME', type: String, length: 30 }
- name: 'CONTACTS' values:
  - name: 'PRESIDENT' values:
    - { name: 'LAST-NAME', type: String, length: 15 }
    - { name: 'FIRST-NAME', type: String, length: 8 }
  - name: 'VP-MARKETING' values:
    - { name: 'LAST-NAME', type: String, length: 15 }
    - { name: 'FIRST-NAME', type: String, length: 8 }
  - name: 'ALTERNATE-CONTACT' values:
    - { name: 'TITLE', type: String, length: 10 }
    - { name: 'LAST-NAME', type: String, length: 15 }
    - { name: 'FIRST-NAME', type: String, length: 8 }
- { name: 'ADDRESS', type: String, length: 15 }
- { name: 'CITY', type: String, length: 15 }
- { name: 'STATE', type: String, length: 2 }
- { name: 'ZIP', type: Integer, length: 5, format: { justify: ZEROES, sign: UNSIGNED } }

After importing the copybook, you can use the `schemaPath` property to reference the associated flat
file through the `output` directive. For example:
`output application/flatfile schemaPath="src/main/resources/schemas/mailing-record.ffd"`

## Supported Copybook Features

Not all copybook features are supported by the COBOL Copybook format in DataWeave. In general, the
format supports most common usages and simple patterns, including:

- USAGE of DISPLAY, BINARY (COMP), COMP-5, and PACKED-DECIMAL (COMP-3). For character encoding
  restrictions, see [Character Encodings](#character_encoding).

- PICTURE clauses for numeric values consisting only of:

  - '9' - One or more numeric character positions

  - 'S' - One optional sign character position, leading or trailing

  - 'V' - One optional decimal point

  - 'P' - One or more decimal scaling positions

- PICTURE clauses for alphanumeric values consisting only of 'X' character positions

- Repetition counts for '9', 'P', and 'X' characters in PICTURE clauses (as in `9(5)` for a 5-digit
  numeric value)

- OCCURS DEPENDING ON with `controlVal` property in schema. Note that if the control value is nested
  inside a containing structure, you need to manually modify the generated schema to specify the
  full path for the value in the form "container.value".

- REDEFINES clause (used to provide different views of the same portion of record data - see details
  in section below)

_Unsupported_ features include:

- Alphanumeric-edited PICTURE clauses

- Numeric-edited PICTURE clauses, including all forms of insertion, replacement, and zero
  suppression

- Special level-numbers:

  - Level 66 - Alternate name for field or group

  - Level 77 - Independent data item

  - Level 88 - Condition names (equivalent to an enumeration of values)

- SIGN clause at group level (only supported on elementary items with PICTURE clause)

- USAGE of COMP-1 or COMP-2 and of clause at group level (only supported on elementary items with
  PICTURE clause)

- VALUE clause (used to define a value of a data item or conditional name from a literal or another
  data item)

- SYNC clause (used to align values within a record)

## REDEFINES Support

REDEFINES facilitates dynamic interpretation of data in a record. When you import a copybook with
REDEFINES present, the generated schema uses a special grouping with the name '\*' (or '\*1', '\*2',
and so on, if multiple REDEFINES groupings are present at the same level) to combine all the
different interpretations. You use this special grouping name in your DataWeave expressions just as
you use any other grouping name.

Use of REDEFINES groupings has higher overhead than normal copybook groupings, so MuleSoft
recommends that you remove REDEFINES from your copybooks where possible before you import them into
Studio.

## Character Encodings

BINARY (COMP), COMP-5, or PACKED-DECIMAL (COMP-3) usages are only supported with single-byte
character encodings, which use the entire range of 256 potential character codes. UTF-8 and other
variable-length encodings are not supported for these usages (because they’re not single-byte), and
ASCII is also not supported (because it doesn’t use the entire range). Supported character encodings
include ISO-8859-1 (an extension of ASCII to full 8 bits) and other 8859 variations and EBCDIC
(IBM037).

REDEFINES requires you to use a single-byte-per-character character encoding for the data, but any
single-byte-per-character encoding can be used unless BINARY (COMP), COMP-5, or PACKED-DECIMAL
(COMP-3) usages are included in the data.

## Common Copybook Import Issues

The most common issue with copybook imports is a failure to follow the COBOL standard for input line
regions. The copybook import parsing ignores the contents of columns 1-6 of each line, and ignores
all lines with an '\*' (asterisk) in column 7. It also ignores everything beyond column 72 in each
line. This means that all your actual data definitions need to be within columns 8 through 72 of
input lines.

Tabs in the input are not expanded because there is no defined standard for tab positions. Each tab
character is treated as a single space character when counting copybook input columns.

Indentation is ignored when processing the copybook, with only level-numbers treated as significant.
This is not normally a problem, but it means that copybooks might be accepted for import even though
they are not accepted by COBOL compilers.

Both warnings and errors might be reported as a result of a copybook import. Warnings generally tell
of unsupported or unrecognized features, which might or might not be significant. Errors are
notifications of a problem that means the generated schema (if any) will not be a completely
accurate representation of the copybook. You should review any warnings or errors reported and
decide on the appropriate handling, which might be simply accepting the schema as generated,
modifying the input copybook, or modifying the generated schema.

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>allowLenientWithBinaryNotEndElement</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>When the schema contains elements of type Binary or Packed, the <code>lenient</code> option does not allow short records, regardless of the last element’s format type. When you set this property to <code>true</code>, the validation applies only to cases in which the record ends with type Binary or Packed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>enforceRequires</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Produces an error when set to <code>true</code> if a required value is missing.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>missingValues</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Fill character used to represent missing values. To activate a non-default setting, set the <code>useMissCharAsDefaultForFill</code> property to <code>true</code>, and use one of the following values to <code>missingValues</code>:</p></div><div><ul><li><p><code>none</code> (for the reader) or <code>NONE</code> (for the writer): Treats all data as values.</p></li><li><p><code>spaces</code> (for the reader) or <code>SPACES</code> (for the writer): Interprets a field consisting of only spaces as a missing value. Default for flat file and fixed-width formats.</p></li><li><p><code>zeroes</code> (for the reader) or <code>ZEROES</code> (for the writer): Interprets numeric fields consisting of only <code>0</code> characters <em>and</em> character fields consisting of only spaces as missing values.</p></li><li><p><code>nulls</code> (for the reader) or <code>NULLS</code> (for the writer): Interprets a field consisting only of <code>0</code> bytes as a missing value. Default for COBOL copybook schema.</p></li></ul></div></div></td></tr><tr><td><p><code>notTruncateDependingOnSubjectNotPresent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Fills the entire group when the DEPENDING ON subject is not present.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>recordParsing</code></p></td><td><p><code>String</code></p></td><td><p><code>'strict'</code></p></td><td><div><div><p>Specifies the expected type of separation between lines or records:</p></div><div><ul><li><p><code>strict</code>: Line break is expected at exact end of each record. <code>strict</code> is the default.</p></li><li><p><code>lenient</code>: Line break is used, but records can be shorter or longer than the schema specifies. Do not use <code>lenient</code> if your payload lacks line breaks. The other options to <code>recordParsing</code> support records that lack line breaks.</p></li><li><p><code>noTerminator</code>: Records follow one another with no separation. This option is preferred for fixed-length records that lack a line break.</p></li><li><p><code>singleRecord</code>: The entire input is a single record.</p></li></ul></div><div><p>Note that schemas with type <code>Binary</code> or <code>Packed</code> don’t allow for line break detection, so setting <code>recordParsing</code> to <code>lenient</code> only allows long records to be handled, not short ones. These schemas also currently only work with certain single-byte character encodings (so not with UTF-8 or any multibyte format).</p></div></div></td></tr><tr><td><p><code>retainEmptyStringFieldsOnParsing</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Allow parsing behavior to keep missing string value fields with a default value in the output map</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>schemaPath</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Path to the schema definition. Specifies the location in your local disk of the schema file that parses your input.</p></div></div></td></tr><tr><td><p><code>segmentIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Segment identifier in the schema for fixed-width or COBOL copybook schemas. Required when parsing a single segment or record definition if the schema includes multiple segment definitions.</p></div></div></td></tr><tr><td><p><code>structureIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Structure identifier in the schema for flat file schemas. Required when parsing a structure definition if the schema includes multiple structure definitions.</p></div></div></td></tr><tr><td><p><code>truncateDependingOn</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, truncates DEPENDING ON values to the length used.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>useMissCharAsDefaultForFill</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>By default, the flat file reader and writer use spaces for missing characters and ignore the setting of the <code>missingValues</code> property. When you set this property to <code>true</code>, DataWeave honors the setting of the <code>missingValues property</code>. Introduced in DataWeave 2.3 (2.3.0-20210823) for the September 2021 release of Mule 4.3.0-20210823.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>zonedDecimalStrict</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, uses the 'strict' ASCII form of sign encoding for zoned decimal values.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr><tr><td><p><code>enforceRequires</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Produces an error when set to <code>true</code> if a required value is missing.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>missingValues</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Fill character used to represent missing values. To activate a non-default setting, set the <code>useMissCharAsDefaultForFill</code> property to <code>true</code>, and use one of the following values to <code>missingValues</code>:</p></div><div><ul><li><p><code>none</code> (for the reader) or <code>NONE</code> (for the writer): Treats all data as values.</p></li><li><p><code>spaces</code> (for the reader) or <code>SPACES</code> (for the writer): Interprets a field consisting of only spaces as a missing value. Default for flat file and fixed-width formats.</p></li><li><p><code>zeroes</code> (for the reader) or <code>ZEROES</code> (for the writer): Interprets numeric fields consisting of only <code>0</code> characters <em>and</em> character fields consisting of only spaces as missing values.</p></li><li><p><code>nulls</code> (for the reader) or <code>NULLS</code> (for the writer): Interprets a field consisting only of <code>0</code> bytes as a missing value. Default for COBOL copybook schema.</p></li></ul></div></div></td></tr><tr><td><p><code>notTruncateDependingOnSubjectNotPresent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Fills the entire group when the DEPENDING ON subject is not present.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>recordTerminator</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Line break for a record separator. Valid values: <code>lf</code>, <code>cr</code>, <code>crlf</code>, <code>none</code>. Note that in Mule versions 4.0.4 and later, this is only used as a separator when there are multiple records. Values translate directly to character codes (<code>none</code> leaves no termination on each record).</p></div></div></td></tr><tr><td><p><code>schemaPath</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Path to the schema definition. Specifies the location in your local disk of the schema file that parses your input.</p></div></div></td></tr><tr><td><p><code>segmentIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Segment identifier in the schema for fixed-width or COBOL copybook schemas. Required when parsing a single segment or record definition if the schema includes multiple segment definitions.</p></div></div></td></tr><tr><td><p><code>structureIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Structure identifier in the schema for flat file schemas. Required when parsing a structure definition if the schema includes multiple structure definitions.</p></div></div></td></tr><tr><td><p><code>trimValues</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Trim values that are longer than the width of a field.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>truncateDependingOn</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, truncates DEPENDING ON values to the length used.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>useMissCharAsDefaultForFill</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>By default, the flat file reader and writer use spaces for missing characters and ignore the setting of the <code>missingValues</code> property. When you set this property to <code>true</code>, DataWeave honors the setting of the <code>missingValues property</code>. Introduced in DataWeave 2.3 (2.3.0-20210823) for the September 2021 release of Mule 4.3.0-20210823.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>zonedDecimalStrict</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, uses the 'strict' ASCII form of sign encoding for zoned decimal values.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

The COBOL Copybook format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/flatfile</code></p></td></tr></tbody></table>

<!-- document id=0d2ca92cde5437e75a5ea769b30722c724cf9424e209ba3763aedb7890c978c3 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-formats-copybook.md -->

---
product: DataWeave
version: 2.9
---

# COBOL Copybook Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME Type: `application/flatfile`

ID: `flatfile`

A COBOL copybook is a type of flat file that describes the layout of records and fields in a COBOL
data file.

The Transform Message component provides settings for handling the COBOL copybook format. For
example, you can import a COBOL definition into the Transform Message component and use it for your
Copybook transformations.

> [!NOTE] COBOL copybook in DataWeave supports files of up to 15 MB, and the memory requirement is
> roughly 40 to 1. For example, a 1-MB file requires up to 40 MB of memory to process, so it’s
> important to consider this memory requirement in conjunction with your TPS needs for large
> copybook files. This is not an exact figure; the value might vary according to the complexity of
> the mapping instructions.

## Importing a Copybook Definition

When you import a Copybook definition, the Transform Message component converts the definition to a
flat file schema that you can reference with `schemaPath` property.

To import a copybook definition:

1.  Right-click the input payload in the Transform component in Studio, and select **Set Metadata**
    to open the Set Metadata Type dialog.

    Note that you need to create a metadata type before you can import a copybook definition.

2.  Provide a name for your copybook metadata, such as `copybook`.

3.  Select the Copybook type from the **Type** drop-down menu.

4.  Import your copybook definition file.

5.  Click Select.

    ![A selecting metadata type interface for importing a copybook definition file](/mulesoft/current/en-us/dataweave/2.9/_images/copybook-import.png)

    Figure 1. Importing a Copybook Definition File

For example, assume that you have a copybook definition file (`mailing-record.cpy`) that looks like
this:

       01  MAILING-RECORD.
           05  COMPANY-NAME            PIC X(30).
           05  CONTACTS.
               10  PRESIDENT.
                   15  LAST-NAME       PIC X(15).
                   15  FIRST-NAME      PIC X(8).
               10  VP-MARKETING.
                   15  LAST-NAME       PIC X(15).
                   15  FIRST-NAME      PIC X(8).
               10  ALTERNATE-CONTACT.
                   15  TITLE           PIC X(10).
                   15  LAST-NAME       PIC X(15).
                   15  FIRST-NAME      PIC X(8).
           05  ADDRESS                 PIC X(15).
           05  CITY                    PIC X(15).
           05  STATE                   PIC XX.
           05  ZIP                     PIC 9(5).

- Copybook definitions must always begin with a `01` entry. A separate record type is generated for
  each `01` definition in your copybook (there must be at least one `01` definition for the copybook
  to be usable, so add one using an arbitrary name at the start of the copybook if none is present).
  If there are multiple `01` definitions in the copybook file, you can select which definition to
  use in the transform from the dropdown list.

- COBOL format requires definitions to only use columns 7-72 of each line. Data in columns 1-5 and
  past column 72 is ignored by the import process. Column 6 is a line continuation marker.

When you import the schema, the Transform component converts the copybook file to a flat file schema
that it stores in the `src/main/resources/schema` folder of your Mule project. In flat file format,
the copybook definition above looks like this:

form: COPYBOOK id: 'MAILING-RECORD' values:

- { name: 'COMPANY-NAME', type: String, length: 30 }
- name: 'CONTACTS' values:
  - name: 'PRESIDENT' values:
    - { name: 'LAST-NAME', type: String, length: 15 }
    - { name: 'FIRST-NAME', type: String, length: 8 }
  - name: 'VP-MARKETING' values:
    - { name: 'LAST-NAME', type: String, length: 15 }
    - { name: 'FIRST-NAME', type: String, length: 8 }
  - name: 'ALTERNATE-CONTACT' values:
    - { name: 'TITLE', type: String, length: 10 }
    - { name: 'LAST-NAME', type: String, length: 15 }
    - { name: 'FIRST-NAME', type: String, length: 8 }
- { name: 'ADDRESS', type: String, length: 15 }
- { name: 'CITY', type: String, length: 15 }
- { name: 'STATE', type: String, length: 2 }
- { name: 'ZIP', type: Integer, length: 5, format: { justify: ZEROES, sign: UNSIGNED } }

After importing the copybook, you can use the `schemaPath` property to reference the associated flat
file through the `output` directive. For example:
`output application/flatfile schemaPath="src/main/resources/schemas/mailing-record.ffd"`

## Supported Copybook Features

Not all copybook features are supported by the COBOL Copybook format in DataWeave. In general, the
format supports most common usages and simple patterns, including:

- USAGE of DISPLAY, BINARY (COMP), COMP-5, and PACKED-DECIMAL (COMP-3). For character encoding
  restrictions, see [Character Encodings](#character_encoding).

- PICTURE clauses for numeric values consisting only of:

  - '9' - One or more numeric character positions

  - 'S' - One optional sign character position, leading or trailing

  - 'V' - One optional decimal point

  - 'P' - One or more decimal scaling positions

- PICTURE clauses for alphanumeric values consisting only of 'X' character positions

- Repetition counts for '9', 'P', and 'X' characters in PICTURE clauses (as in `9(5)` for a 5-digit
  numeric value)

- OCCURS DEPENDING ON with `controlVal` property in schema. Note that if the control value is nested
  inside a containing structure, you need to manually modify the generated schema to specify the
  full path for the value in the form "container.value".

- REDEFINES clause (used to provide different views of the same portion of record data - see details
  in section below)

_Unsupported_ features include:

- Alphanumeric-edited PICTURE clauses

- Numeric-edited PICTURE clauses, including all forms of insertion, replacement, and zero
  suppression

- Special level-numbers:

  - Level 66 - Alternate name for field or group

  - Level 77 - Independent data item

  - Level 88 - Condition names (equivalent to an enumeration of values)

- SIGN clause at group level (only supported on elementary items with PICTURE clause)

- USAGE of COMP-1 or COMP-2 and of clause at group level (only supported on elementary items with
  PICTURE clause)

- VALUE clause (used to define a value of a data item or conditional name from a literal or another
  data item)

- SYNC clause (used to align values within a record)

## REDEFINES Support

REDEFINES facilitates dynamic interpretation of data in a record. When you import a copybook with
REDEFINES present, the generated schema uses a special grouping with the name '\*' (or '\*1', '\*2',
and so on, if multiple REDEFINES groupings are present at the same level) to combine all the
different interpretations. You use this special grouping name in your DataWeave expressions just as
you use any other grouping name.

Use of REDEFINES groupings has higher overhead than normal copybook groupings, so MuleSoft
recommends that you remove REDEFINES from your copybooks where possible before you import them into
Studio.

## Character Encodings

BINARY (COMP), COMP-5, or PACKED-DECIMAL (COMP-3) usages are only supported with single-byte
character encodings, which use the entire range of 256 potential character codes. UTF-8 and other
variable-length encodings are not supported for these usages (because they’re not single-byte), and
ASCII is also not supported (because it doesn’t use the entire range). Supported character encodings
include ISO-8859-1 (an extension of ASCII to full 8 bits) and other 8859 variations and EBCDIC
(IBM037).

REDEFINES requires you to use a single-byte-per-character character encoding for the data, but any
single-byte-per-character encoding can be used unless BINARY (COMP), COMP-5, or PACKED-DECIMAL
(COMP-3) usages are included in the data.

## Common Copybook Import Issues

The most common issue with copybook imports is a failure to follow the COBOL standard for input line
regions. The copybook import parsing ignores the contents of columns 1-6 of each line, and ignores
all lines with an '\*' (asterisk) in column 7. It also ignores everything beyond column 72 in each
line. This means that all your actual data definitions need to be within columns 8 through 72 of
input lines.

Tabs in the input are not expanded because there is no defined standard for tab positions. Each tab
character is treated as a single space character when counting copybook input columns.

Indentation is ignored when processing the copybook, with only level-numbers treated as significant.
This is not normally a problem, but it means that copybooks might be accepted for import even though
they are not accepted by COBOL compilers.

Both warnings and errors might be reported as a result of a copybook import. Warnings generally tell
of unsupported or unrecognized features, which might or might not be significant. Errors are
notifications of a problem that means the generated schema (if any) will not be a completely
accurate representation of the copybook. You should review any warnings or errors reported and
decide on the appropriate handling, which might be simply accepting the schema as generated,
modifying the input copybook, or modifying the generated schema.

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>allowLenientWithBinaryNotEndElement</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>When the schema contains elements of type Binary or Packed, the <code>lenient</code> option does not allow short records, regardless of the last element’s format type. When you set this property to <code>true</code>, the validation applies only to cases in which the record ends with type Binary or Packed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>enforceRequires</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Produces an error when set to <code>true</code> if a required value is missing.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>missingValues</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Fill character used to represent missing values. To activate a non-default setting, set the <code>useMissCharAsDefaultForFill</code> property to <code>true</code>, and use one of the following values to <code>missingValues</code>:</p></div><div><ul><li><p><code>none</code> (for the reader) or <code>NONE</code> (for the writer): Treats all data as values.</p></li><li><p><code>spaces</code> (for the reader) or <code>SPACES</code> (for the writer): Interprets a field consisting of only spaces as a missing value. Default for flat file and fixed-width formats.</p></li><li><p><code>zeroes</code> (for the reader) or <code>ZEROES</code> (for the writer): Interprets numeric fields consisting of only <code>0</code> characters <em>and</em> character fields consisting of only spaces as missing values.</p></li><li><p><code>nulls</code> (for the reader) or <code>NULLS</code> (for the writer): Interprets a field consisting only of <code>0</code> bytes as a missing value. Default for COBOL copybook schema.</p></li></ul></div></div></td></tr><tr><td><p><code>notTruncateDependingOnSubjectNotPresent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Fills the entire group when the DEPENDING ON subject is not present.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>recordParsing</code></p></td><td><p><code>String</code></p></td><td><p><code>'strict'</code></p></td><td><div><div><p>Specifies the expected type of separation between lines or records:</p></div><div><ul><li><p><code>strict</code>: Line break is expected at exact end of each record. <code>strict</code> is the default.</p></li><li><p><code>lenient</code>: Line break is used, but records can be shorter or longer than the schema specifies. Do not use <code>lenient</code> if your payload lacks line breaks. The other options to <code>recordParsing</code> support records that lack line breaks.</p></li><li><p><code>noTerminator</code>: Records follow one another with no separation. This option is preferred for fixed-length records that lack a line break.</p></li><li><p><code>singleRecord</code>: The entire input is a single record.</p></li></ul></div><div><p>Note that schemas with type <code>Binary</code> or <code>Packed</code> don’t allow for line break detection, so setting <code>recordParsing</code> to <code>lenient</code> only allows long records to be handled, not short ones. These schemas also currently only work with certain single-byte character encodings (so not with UTF-8 or any multibyte format).</p></div></div></td></tr><tr><td><p><code>retainEmptyStringFieldsOnParsing</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Allow parsing behavior to keep missing string value fields with a default value in the output map</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>schemaPath</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Path to the schema definition. Specifies the location in your local disk of the schema file that parses your input.</p></div></div></td></tr><tr><td><p><code>segmentIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Segment identifier in the schema for fixed-width or COBOL copybook schemas. Required when parsing a single segment or record definition if the schema includes multiple segment definitions.</p></div></div></td></tr><tr><td><p><code>structureIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Structure identifier in the schema for flat file schemas. Required when parsing a structure definition if the schema includes multiple structure definitions.</p></div></div></td></tr><tr><td><p><code>truncateDependingOn</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, truncates DEPENDING ON values to the length used.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>useMissCharAsDefaultForFill</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>By default, the flat file reader and writer use spaces for missing characters and ignore the setting of the <code>missingValues</code> property. When you set this property to <code>true</code>, DataWeave honors the setting of the <code>missingValues property</code>. Introduced in DataWeave 2.3 (2.3.0-20210823) for the September 2021 release of Mule 4.3.0-20210823.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>zonedDecimalStrict</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, uses the 'strict' ASCII form of sign encoding for zoned decimal values.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr><tr><td><p><code>enforceRequires</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Produces an error when set to <code>true</code> if a required value is missing.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>missingValues</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Fill character used to represent missing values. To activate a non-default setting, set the <code>useMissCharAsDefaultForFill</code> property to <code>true</code>, and use one of the following values to <code>missingValues</code>:</p></div><div><ul><li><p><code>none</code> (for the reader) or <code>NONE</code> (for the writer): Treats all data as values.</p></li><li><p><code>spaces</code> (for the reader) or <code>SPACES</code> (for the writer): Interprets a field consisting of only spaces as a missing value. Default for flat file and fixed-width formats.</p></li><li><p><code>zeroes</code> (for the reader) or <code>ZEROES</code> (for the writer): Interprets numeric fields consisting of only <code>0</code> characters <em>and</em> character fields consisting of only spaces as missing values.</p></li><li><p><code>nulls</code> (for the reader) or <code>NULLS</code> (for the writer): Interprets a field consisting only of <code>0</code> bytes as a missing value. Default for COBOL copybook schema.</p></li></ul></div></div></td></tr><tr><td><p><code>notTruncateDependingOnSubjectNotPresent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Fills the entire group when the DEPENDING ON subject is not present.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>recordTerminator</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Line break for a record separator. Valid values: <code>lf</code>, <code>cr</code>, <code>crlf</code>, <code>none</code>. Note that in Mule versions 4.0.4 and later, this is only used as a separator when there are multiple records. Values translate directly to character codes (<code>none</code> leaves no termination on each record).</p></div></div></td></tr><tr><td><p><code>schemaPath</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Path to the schema definition. Specifies the location in your local disk of the schema file that parses your input.</p></div></div></td></tr><tr><td><p><code>segmentIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Segment identifier in the schema for fixed-width or COBOL copybook schemas. Required when parsing a single segment or record definition if the schema includes multiple segment definitions.</p></div></div></td></tr><tr><td><p><code>structureIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Structure identifier in the schema for flat file schemas. Required when parsing a structure definition if the schema includes multiple structure definitions.</p></div></div></td></tr><tr><td><p><code>trimValues</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Trim values that are longer than the width of a field.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>truncateDependingOn</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, truncates DEPENDING ON values to the length used.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>useMissCharAsDefaultForFill</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>By default, the flat file reader and writer use spaces for missing characters and ignore the setting of the <code>missingValues</code> property. When you set this property to <code>true</code>, DataWeave honors the setting of the <code>missingValues property</code>. Introduced in DataWeave 2.3 (2.3.0-20210823) for the September 2021 release of Mule 4.3.0-20210823.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>zonedDecimalStrict</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, uses the 'strict' ASCII form of sign encoding for zoned decimal values.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

The COBOL Copybook format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/flatfile</code></p></td></tr></tbody></table>

<!-- document id=01ca6a63dbb4f9b7fae6f1f926ba97ff2df58667d08e11913c2f23db1196d12f url=/mulesoft/current/en-us/dataweave/latest/dataweave-formats-copybook.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# COBOL Copybook Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME Type: `application/flatfile`

ID: `flatfile`

A COBOL copybook is a type of flat file that describes the layout of records and fields in a COBOL
data file.

The Transform Message component provides settings for handling the COBOL copybook format. For
example, you can import a COBOL definition into the Transform Message component and use it for your
Copybook transformations.

> [!NOTE] COBOL copybook in DataWeave supports files of up to 15 MB, and the memory requirement is
> roughly 40 to 1. For example, a 1-MB file requires up to 40 MB of memory to process, so it’s
> important to consider this memory requirement in conjunction with your TPS needs for large
> copybook files. This is not an exact figure; the value might vary according to the complexity of
> the mapping instructions.

## Importing a Copybook Definition

When you import a Copybook definition, the Transform Message component converts the definition to a
flat file schema that you can reference with `schemaPath` property.

To import a copybook definition:

1.  Right-click the input payload in the Transform component in Studio, and select **Set Metadata**
    to open the Set Metadata Type dialog.

    Note that you need to create a metadata type before you can import a copybook definition.

2.  Provide a name for your copybook metadata, such as `copybook`.

3.  Select the Copybook type from the **Type** drop-down menu.

4.  Import your copybook definition file.

5.  Click Select.

    ![A selecting metadata type interface for importing a copybook definition file](/mulesoft/current/en-us/dataweave/latest/_images/copybook-import.png)

    Figure 1. Importing a Copybook Definition File

For example, assume that you have a copybook definition file (`mailing-record.cpy`) that looks like
this:

       01  MAILING-RECORD.
           05  COMPANY-NAME            PIC X(30).
           05  CONTACTS.
               10  PRESIDENT.
                   15  LAST-NAME       PIC X(15).
                   15  FIRST-NAME      PIC X(8).
               10  VP-MARKETING.
                   15  LAST-NAME       PIC X(15).
                   15  FIRST-NAME      PIC X(8).
               10  ALTERNATE-CONTACT.
                   15  TITLE           PIC X(10).
                   15  LAST-NAME       PIC X(15).
                   15  FIRST-NAME      PIC X(8).
           05  ADDRESS                 PIC X(15).
           05  CITY                    PIC X(15).
           05  STATE                   PIC XX.
           05  ZIP                     PIC 9(5).

- Copybook definitions must always begin with a `01` entry. A separate record type is generated for
  each `01` definition in your copybook (there must be at least one `01` definition for the copybook
  to be usable, so add one using an arbitrary name at the start of the copybook if none is present).
  If there are multiple `01` definitions in the copybook file, you can select which definition to
  use in the transform from the dropdown list.

- COBOL format requires definitions to only use columns 7-72 of each line. Data in columns 1-5 and
  past column 72 is ignored by the import process. Column 6 is a line continuation marker.

When you import the schema, the Transform component converts the copybook file to a flat file schema
that it stores in the `src/main/resources/schema` folder of your Mule project. In flat file format,
the copybook definition above looks like this:

form: COPYBOOK id: 'MAILING-RECORD' values:

- { name: 'COMPANY-NAME', type: String, length: 30 }
- name: 'CONTACTS' values:
  - name: 'PRESIDENT' values:
    - { name: 'LAST-NAME', type: String, length: 15 }
    - { name: 'FIRST-NAME', type: String, length: 8 }
  - name: 'VP-MARKETING' values:
    - { name: 'LAST-NAME', type: String, length: 15 }
    - { name: 'FIRST-NAME', type: String, length: 8 }
  - name: 'ALTERNATE-CONTACT' values:
    - { name: 'TITLE', type: String, length: 10 }
    - { name: 'LAST-NAME', type: String, length: 15 }
    - { name: 'FIRST-NAME', type: String, length: 8 }
- { name: 'ADDRESS', type: String, length: 15 }
- { name: 'CITY', type: String, length: 15 }
- { name: 'STATE', type: String, length: 2 }
- { name: 'ZIP', type: Integer, length: 5, format: { justify: ZEROES, sign: UNSIGNED } }

After importing the copybook, you can use the `schemaPath` property to reference the associated flat
file through the `output` directive. For example:
`output application/flatfile schemaPath="src/main/resources/schemas/mailing-record.ffd"`

## Supported Copybook Features

Not all copybook features are supported by the COBOL Copybook format in DataWeave. In general, the
format supports most common usages and simple patterns, including:

- USAGE of DISPLAY, BINARY (COMP), COMP-5, and PACKED-DECIMAL (COMP-3). For character encoding
  restrictions, see [Character Encodings](#character_encoding).

- PICTURE clauses for numeric values consisting only of:

  - '9' - One or more numeric character positions

  - 'S' - One optional sign character position, leading or trailing

  - 'V' - One optional decimal point

  - 'P' - One or more decimal scaling positions

- PICTURE clauses for alphanumeric values consisting only of 'X' character positions

- Repetition counts for '9', 'P', and 'X' characters in PICTURE clauses (as in `9(5)` for a 5-digit
  numeric value)

- OCCURS DEPENDING ON with `controlVal` property in schema. Note that if the control value is nested
  inside a containing structure, you need to manually modify the generated schema to specify the
  full path for the value in the form "container.value".

- REDEFINES clause (used to provide different views of the same portion of record data - see details
  in section below)

_Unsupported_ features include:

- Alphanumeric-edited PICTURE clauses

- Numeric-edited PICTURE clauses, including all forms of insertion, replacement, and zero
  suppression

- Special level-numbers:

  - Level 66 - Alternate name for field or group

  - Level 77 - Independent data item

  - Level 88 - Condition names (equivalent to an enumeration of values)

- SIGN clause at group level (only supported on elementary items with PICTURE clause)

- USAGE of COMP-1 or COMP-2 and of clause at group level (only supported on elementary items with
  PICTURE clause)

- VALUE clause (used to define a value of a data item or conditional name from a literal or another
  data item)

- SYNC clause (used to align values within a record)

## REDEFINES Support

REDEFINES facilitates dynamic interpretation of data in a record. When you import a copybook with
REDEFINES present, the generated schema uses a special grouping with the name '\*' (or '\*1', '\*2',
and so on, if multiple REDEFINES groupings are present at the same level) to combine all the
different interpretations. You use this special grouping name in your DataWeave expressions just as
you use any other grouping name.

Use of REDEFINES groupings has higher overhead than normal copybook groupings, so MuleSoft
recommends that you remove REDEFINES from your copybooks where possible before you import them into
Studio.

## Character Encodings

BINARY (COMP), COMP-5, or PACKED-DECIMAL (COMP-3) usages are only supported with single-byte
character encodings, which use the entire range of 256 potential character codes. UTF-8 and other
variable-length encodings are not supported for these usages (because they’re not single-byte), and
ASCII is also not supported (because it doesn’t use the entire range). Supported character encodings
include ISO-8859-1 (an extension of ASCII to full 8 bits) and other 8859 variations and EBCDIC
(IBM037).

REDEFINES requires you to use a single-byte-per-character character encoding for the data, but any
single-byte-per-character encoding can be used unless BINARY (COMP), COMP-5, or PACKED-DECIMAL
(COMP-3) usages are included in the data.

## Common Copybook Import Issues

The most common issue with copybook imports is a failure to follow the COBOL standard for input line
regions. The copybook import parsing ignores the contents of columns 1-6 of each line, and ignores
all lines with an '\*' (asterisk) in column 7. It also ignores everything beyond column 72 in each
line. This means that all your actual data definitions need to be within columns 8 through 72 of
input lines.

Tabs in the input are not expanded because there is no defined standard for tab positions. Each tab
character is treated as a single space character when counting copybook input columns.

Indentation is ignored when processing the copybook, with only level-numbers treated as significant.
This is not normally a problem, but it means that copybooks might be accepted for import even though
they are not accepted by COBOL compilers.

Both warnings and errors might be reported as a result of a copybook import. Warnings generally tell
of unsupported or unrecognized features, which might or might not be significant. Errors are
notifications of a problem that means the generated schema (if any) will not be a completely
accurate representation of the copybook. You should review any warnings or errors reported and
decide on the appropriate handling, which might be simply accepting the schema as generated,
modifying the input copybook, or modifying the generated schema.

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>allowLenientWithBinaryNotEndElement</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>When the schema contains elements of type Binary or Packed, the <code>lenient</code> option does not allow short records, regardless of the last element’s format type. When you set this property to <code>true</code>, the validation applies only to cases in which the record ends with type Binary or Packed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>enforceRequires</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Produces an error when set to <code>true</code> if a required value is missing.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>missingValues</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Fill character used to represent missing values. To activate a non-default setting, set the <code>useMissCharAsDefaultForFill</code> property to <code>true</code>, and use one of the following values to <code>missingValues</code>:</p></div><div><ul><li><p><code>none</code> (for the reader) or <code>NONE</code> (for the writer): Treats all data as values.</p></li><li><p><code>spaces</code> (for the reader) or <code>SPACES</code> (for the writer): Interprets a field consisting of only spaces as a missing value. Default for flat file and fixed-width formats.</p></li><li><p><code>zeroes</code> (for the reader) or <code>ZEROES</code> (for the writer): Interprets numeric fields consisting of only <code>0</code> characters <em>and</em> character fields consisting of only spaces as missing values.</p></li><li><p><code>nulls</code> (for the reader) or <code>NULLS</code> (for the writer): Interprets a field consisting only of <code>0</code> bytes as a missing value. Default for COBOL copybook schema.</p></li></ul></div></div></td></tr><tr><td><p><code>notTruncateDependingOnSubjectNotPresent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Fills the entire group when the DEPENDING ON subject is not present.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>recordParsing</code></p></td><td><p><code>String</code></p></td><td><p><code>'strict'</code></p></td><td><div><div><p>Specifies the expected type of separation between lines or records:</p></div><div><ul><li><p><code>strict</code>: Line break is expected at exact end of each record. <code>strict</code> is the default.</p></li><li><p><code>lenient</code>: Line break is used, but records can be shorter or longer than the schema specifies. Do not use <code>lenient</code> if your payload lacks line breaks. The other options to <code>recordParsing</code> support records that lack line breaks.</p></li><li><p><code>noTerminator</code>: Records follow one another with no separation. This option is preferred for fixed-length records that lack a line break.</p></li><li><p><code>singleRecord</code>: The entire input is a single record.</p></li></ul></div><div><p>Note that schemas with type <code>Binary</code> or <code>Packed</code> don’t allow for line break detection, so setting <code>recordParsing</code> to <code>lenient</code> only allows long records to be handled, not short ones. These schemas also currently only work with certain single-byte character encodings (so not with UTF-8 or any multibyte format).</p></div></div></td></tr><tr><td><p><code>retainEmptyStringFieldsOnParsing</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Allow parsing behavior to keep missing string value fields with a default value in the output map</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>schemaPath</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Path to the schema definition. Specifies the location in your local disk of the schema file that parses your input.</p></div></div></td></tr><tr><td><p><code>segmentIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Segment identifier in the schema for fixed-width or COBOL copybook schemas. Required when parsing a single segment or record definition if the schema includes multiple segment definitions.</p></div></div></td></tr><tr><td><p><code>structureIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Structure identifier in the schema for flat file schemas. Required when parsing a structure definition if the schema includes multiple structure definitions.</p></div></div></td></tr><tr><td><p><code>truncateDependingOn</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, truncates DEPENDING ON values to the length used.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>useMissCharAsDefaultForFill</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>By default, the flat file reader and writer use spaces for missing characters and ignore the setting of the <code>missingValues</code> property. When you set this property to <code>true</code>, DataWeave honors the setting of the <code>missingValues property</code>. Introduced in DataWeave 2.3 (2.3.0-20210823) for the September 2021 release of Mule 4.3.0-20210823.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>zonedDecimalStrict</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, uses the 'strict' ASCII form of sign encoding for zoned decimal values.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr><tr><td><p><code>enforceRequires</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Produces an error when set to <code>true</code> if a required value is missing.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>missingValues</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Fill character used to represent missing values. To activate a non-default setting, set the <code>useMissCharAsDefaultForFill</code> property to <code>true</code>, and use one of the following values to <code>missingValues</code>:</p></div><div><ul><li><p><code>none</code> (for the reader) or <code>NONE</code> (for the writer): Treats all data as values.</p></li><li><p><code>spaces</code> (for the reader) or <code>SPACES</code> (for the writer): Interprets a field consisting of only spaces as a missing value. Default for flat file and fixed-width formats.</p></li><li><p><code>zeroes</code> (for the reader) or <code>ZEROES</code> (for the writer): Interprets numeric fields consisting of only <code>0</code> characters <em>and</em> character fields consisting of only spaces as missing values.</p></li><li><p><code>nulls</code> (for the reader) or <code>NULLS</code> (for the writer): Interprets a field consisting only of <code>0</code> bytes as a missing value. Default for COBOL copybook schema.</p></li></ul></div></div></td></tr><tr><td><p><code>notTruncateDependingOnSubjectNotPresent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Fills the entire group when the DEPENDING ON subject is not present.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>recordTerminator</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Line break for a record separator. Valid values: <code>lf</code>, <code>cr</code>, <code>crlf</code>, <code>none</code>. Note that in Mule versions 4.0.4 and later, this is only used as a separator when there are multiple records. Values translate directly to character codes (<code>none</code> leaves no termination on each record).</p></div></div></td></tr><tr><td><p><code>schemaPath</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Path to the schema definition. Specifies the location in your local disk of the schema file that parses your input.</p></div></div></td></tr><tr><td><p><code>segmentIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Segment identifier in the schema for fixed-width or COBOL copybook schemas. Required when parsing a single segment or record definition if the schema includes multiple segment definitions.</p></div></div></td></tr><tr><td><p><code>structureIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Structure identifier in the schema for flat file schemas. Required when parsing a structure definition if the schema includes multiple structure definitions.</p></div></div></td></tr><tr><td><p><code>trimValues</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Trim values that are longer than the width of a field.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>truncateDependingOn</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, truncates DEPENDING ON values to the length used.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>useMissCharAsDefaultForFill</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>By default, the flat file reader and writer use spaces for missing characters and ignore the setting of the <code>missingValues</code> property. When you set this property to <code>true</code>, DataWeave honors the setting of the <code>missingValues property</code>. Introduced in DataWeave 2.3 (2.3.0-20210823) for the September 2021 release of Mule 4.3.0-20210823.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>zonedDecimalStrict</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, uses the 'strict' ASCII form of sign encoding for zoned decimal values.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

The COBOL Copybook format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/flatfile</code></p></td></tr></tbody></table>

<!-- document id=7ee0159139bbb8144f8d0c6326d23565b99108dbddba799493abf6780a1cea63 url=/mulesoft/current/en-us/dataweave/2.11/dw-coercions.md -->

---
product: DataWeave
version: 2.11
---

# Coercions (dw::util::Coercions)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This utility module assists with type coercions.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::util::Coercions` to the header of your DataWeave script.

_Introduced in DataWeave version 2.4.0._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-coercions-functions-toarray">toArray</a></p></td><td><p>Splits a <code>String</code> value into an <code>Array</code> of characters.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-coercions-functions-tobinary">toBinary</a></p></td><td><p>Transform a <code>String</code> value into a <code>Binary</code> value using the specified encoding.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-coercions-functions-toboolean">toBoolean</a></p></td><td><p>Transform a <code>String</code> value into a <code>Boolean</code> value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-coercions-functions-todate">toDate</a></p></td><td><p>Transforms a <code>String</code> value into a <code>Date</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-coercions-functions-todateornull">toDateOrNull</a></p></td><td><p>Transforms a <code>String</code> value into a <code>Date</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-coercions-functions-todatetime">toDateTime</a></p></td><td><p>Transforms a <code>String</code> value into a <code>DateTime</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-coercions-functions-todatetimeornull">toDateTimeOrNull</a></p></td><td><p>Transforms a <code>String</code> value into a <code>DateTime</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-coercions-functions-tolocaldatetime">toLocalDateTime</a></p></td><td><p>Transforms a <code>String</code> value into a <code>LocalDateTime</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-coercions-functions-tolocaldatetimeornull">toLocalDateTimeOrNull</a></p></td><td><p>Transforms a <code>String</code> value into a <code>LocalDateTime</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-coercions-functions-tolocaltime">toLocalTime</a></p></td><td><p>Transforms a <code>String</code> value into a <code>LocalTime</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-coercions-functions-tolocaltimeornull">toLocalTimeOrNull</a></p></td><td><p>Transforms a <code>String</code> value into a <code>LocalTime</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-coercions-functions-tonumber">toNumber</a></p></td><td><p>Transforms a <code>String</code> value into a <code>Number</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-coercions-functions-tonumberornull">toNumberOrNull</a></p></td><td><p>Transforms a <code>String</code> value into a <code>Number</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-coercions-functions-toperiod">toPeriod</a></p></td><td><p>Transform a <code>String</code> value into a <code>Period</code> value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-coercions-functions-toregex">toRegex</a></p></td><td><p>Transforms a <code>String</code> value into a <code>Regex</code> value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-coercions-functions-tostring">toString</a></p></td><td><p>A variant of <code>toString</code> that transforms a <code>Number</code> value (whole or decimal) into a <code>String</code> value and accepts a format, locale, and rounding mode value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-coercions-functions-totime">toTime</a></p></td><td><p>Transforms a <code>String</code> value into a <code>Time</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-coercions-functions-totimeornull">toTimeOrNull</a></p></td><td><p>Transforms a <code>String</code> value into a <code>Time</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-coercions-functions-totimezone">toTimeZone</a></p></td><td><p>Transform a <code>String</code> value into a <code>TimeZone</code> value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-coercions-functions-touri">toUri</a></p></td><td><p>Transforms a <code>String</code> value into a <code>Uri</code> value.</p></td></tr></tbody></table>

## Types

- [Coercions Types](https://docs.mulesoft.com/dataweave/2.11/dw-coercions-types)

<!-- document id=54b02a799988c7920d8135cc91386bf9aa8d3ac6ad949a4dc5fdd3f684c13508 url=/mulesoft/current/en-us/dataweave/2.12/dw-coercions.md -->

---
product: DataWeave
version: 2.12
---

# Coercions (dw::util::Coercions)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This utility module assists with type coercions.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::util::Coercions` to the header of your DataWeave script.

_Introduced in DataWeave version 2.4.0._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-coercions-functions-toarray">toArray</a></p></td><td><p>Splits a <code>String</code> value into an <code>Array</code> of characters.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-coercions-functions-tobinary">toBinary</a></p></td><td><p>Transform a <code>String</code> value into a <code>Binary</code> value using the specified encoding.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-coercions-functions-toboolean">toBoolean</a></p></td><td><p>Transform a <code>String</code> value into a <code>Boolean</code> value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-coercions-functions-todate">toDate</a></p></td><td><p>Transforms a <code>String</code> value into a <code>Date</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-coercions-functions-todateornull">toDateOrNull</a></p></td><td><p>Transforms a <code>String</code> value into a <code>Date</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-coercions-functions-todatetime">toDateTime</a></p></td><td><p>Transforms a <code>String</code> value into a <code>DateTime</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-coercions-functions-todatetimeornull">toDateTimeOrNull</a></p></td><td><p>Transforms a <code>String</code> value into a <code>DateTime</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-coercions-functions-tolocaldatetime">toLocalDateTime</a></p></td><td><p>Transforms a <code>String</code> value into a <code>LocalDateTime</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-coercions-functions-tolocaldatetimeornull">toLocalDateTimeOrNull</a></p></td><td><p>Transforms a <code>String</code> value into a <code>LocalDateTime</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-coercions-functions-tolocaltime">toLocalTime</a></p></td><td><p>Transforms a <code>String</code> value into a <code>LocalTime</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-coercions-functions-tolocaltimeornull">toLocalTimeOrNull</a></p></td><td><p>Transforms a <code>String</code> value into a <code>LocalTime</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-coercions-functions-tonumber">toNumber</a></p></td><td><p>Transforms a <code>String</code> value into a <code>Number</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-coercions-functions-tonumberornull">toNumberOrNull</a></p></td><td><p>Transforms a <code>String</code> value into a <code>Number</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-coercions-functions-toperiod">toPeriod</a></p></td><td><p>Transform a <code>String</code> value into a <code>Period</code> value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-coercions-functions-toregex">toRegex</a></p></td><td><p>Transforms a <code>String</code> value into a <code>Regex</code> value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-coercions-functions-tostring">toString</a></p></td><td><p>A variant of <code>toString</code> that transforms a <code>Number</code> value (whole or decimal) into a <code>String</code> value and accepts a format, locale, and rounding mode value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-coercions-functions-totime">toTime</a></p></td><td><p>Transforms a <code>String</code> value into a <code>Time</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-coercions-functions-totimeornull">toTimeOrNull</a></p></td><td><p>Transforms a <code>String</code> value into a <code>Time</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-coercions-functions-totimezone">toTimeZone</a></p></td><td><p>Transform a <code>String</code> value into a <code>TimeZone</code> value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-coercions-functions-touri">toUri</a></p></td><td><p>Transforms a <code>String</code> value into a <code>Uri</code> value.</p></td></tr></tbody></table>

## Types

- [Coercions Types](https://docs.mulesoft.com/dataweave/2.12/dw-coercions-types)

<!-- document id=fc8c6ed074da4a6d117ecc28c9acc3dd834cd3ff58aab192b80a81d67a724304 url=/mulesoft/current/en-us/dataweave/2.4/dw-coercions.md -->

---
product: DataWeave
version: 2.4
---

# Coercions (dw::util::Coercions)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This utility module assists with type coercions.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::util::Coercions` to the header of your DataWeave script.

_Introduced in DataWeave version 2.4.0._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-coercions-functions-toarray">toArray</a></p></td><td><p>Splits a <code>String</code> value into an <code>Array</code> of characters.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-coercions-functions-tobinary">toBinary</a></p></td><td><p>Transform a <code>String</code> value into a <code>Binary</code> value using the specified encoding.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-coercions-functions-toboolean">toBoolean</a></p></td><td><p>Transform a <code>String</code> value into a <code>Boolean</code> value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-coercions-functions-todate">toDate</a></p></td><td><p>Transforms a <code>String</code> value into a <code>Date</code> value and accepts a format and locale.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-coercions-functions-todatetime">toDateTime</a></p></td><td><p>Transforms a <code>Number</code> value into a <code>DateTime</code> value using <code>milliseconds</code> or <code>seconds</code> as the unit.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-coercions-functions-tolocaldatetime">toLocalDateTime</a></p></td><td><p>Transforms a <code>String</code> value into a <code>LocalDateTime</code> value and accepts a format and locale.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-coercions-functions-tolocaltime">toLocalTime</a></p></td><td><p>Transforms a <code>String</code> value into a <code>LocalTime</code> value and accepts a format and locale.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-coercions-functions-tonumber">toNumber</a></p></td><td><p>A variant of <code>toNumber</code> that transforms a <code>DateTime</code> value into a number of seconds or milliseconds, depending on the selected unit.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-coercions-functions-toperiod">toPeriod</a></p></td><td><p>Transform a <code>String</code> value into a <code>Period</code> value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-coercions-functions-toregex">toRegex</a></p></td><td><p>Transforms a <code>String</code> value into a <code>Regex</code> value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-coercions-functions-tostring">toString</a></p></td><td><p>A variant of <code>toString</code> that transforms a <code>Number</code> value (whole or decimal) into a <code>String</code> value and accepts a format, locale, and rounding mode value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-coercions-functions-totime">toTime</a></p></td><td><p>Transforms a <code>String</code> value into a <code>Time</code> value and accepts a format and locale.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-coercions-functions-totimezone">toTimeZone</a></p></td><td><p>Transform a <code>String</code> value into a <code>TimeZone</code> value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-coercions-functions-touri">toUri</a></p></td><td><p>Transforms a <code>String</code> value into a <code>Uri</code> value.</p></td></tr></tbody></table>

## Types

- [Coercions Types](https://docs.mulesoft.com/dataweave/2.4/dw-coercions-types)

<!-- document id=45f55c0618dcb420ebc418476d2192ec43bc1252713d173af978ad874c69447d url=/mulesoft/current/en-us/dataweave/2.6/dw-coercions.md -->

---
product: DataWeave
version: 2.6
---

# Coercions (dw::util::Coercions)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This utility module assists with type coercions.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::util::Coercions` to the header of your DataWeave script.

_Introduced in DataWeave version 2.4.0._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-coercions-functions-toarray">toArray</a></p></td><td><p>Splits a <code>String</code> value into an <code>Array</code> of characters.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-coercions-functions-tobinary">toBinary</a></p></td><td><p>Transform a <code>String</code> value into a <code>Binary</code> value using the specified encoding.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-coercions-functions-toboolean">toBoolean</a></p></td><td><p>Transform a <code>String</code> value into a <code>Boolean</code> value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-coercions-functions-todate">toDate</a></p></td><td><p>Transforms a <code>String</code> value into a <code>Date</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-coercions-functions-todateornull">toDateOrNull</a></p></td><td><p>Transforms a <code>String</code> value into a <code>Date</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-coercions-functions-todatetime">toDateTime</a></p></td><td><p>Transforms a <code>String</code> value into a <code>DateTime</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-coercions-functions-todatetimeornull">toDateTimeOrNull</a></p></td><td><p>Transforms a <code>String</code> value into a <code>DateTime</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-coercions-functions-tolocaldatetime">toLocalDateTime</a></p></td><td><p>Transforms a <code>String</code> value into a <code>LocalDateTime</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-coercions-functions-tolocaldatetimeornull">toLocalDateTimeOrNull</a></p></td><td><p>Transforms a <code>String</code> value into a <code>LocalDateTime</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-coercions-functions-tolocaltime">toLocalTime</a></p></td><td><p>Transforms a <code>String</code> value into a <code>LocalTime</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-coercions-functions-tolocaltimeornull">toLocalTimeOrNull</a></p></td><td><p>Transforms a <code>String</code> value into a <code>LocalTime</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-coercions-functions-tonumber">toNumber</a></p></td><td><p>Transforms a <code>String</code> value into a <code>Number</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-coercions-functions-tonumberornull">toNumberOrNull</a></p></td><td><p>Transforms a <code>String</code> value into a <code>Number</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-coercions-functions-toperiod">toPeriod</a></p></td><td><p>Transform a <code>String</code> value into a <code>Period</code> value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-coercions-functions-toregex">toRegex</a></p></td><td><p>Transforms a <code>String</code> value into a <code>Regex</code> value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-coercions-functions-tostring">toString</a></p></td><td><p>A variant of <code>toString</code> that transforms a <code>Number</code> value (whole or decimal) into a <code>String</code> value and accepts a format, locale, and rounding mode value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-coercions-functions-totime">toTime</a></p></td><td><p>Transforms a <code>String</code> value into a <code>Time</code> value and accepts a format and locale.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-coercions-functions-totimezone">toTimeZone</a></p></td><td><p>Transform a <code>String</code> value into a <code>TimeZone</code> value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-coercions-functions-touri">toUri</a></p></td><td><p>Transforms a <code>String</code> value into a <code>Uri</code> value.</p></td></tr></tbody></table>

## Types

- [Coercions Types](https://docs.mulesoft.com/dataweave/2.6/dw-coercions-types)

<!-- document id=f30f994b1d3c4b9a0fc9db3069b7dd862b1ce99cc7d1a03120d28d16ed4ee1ae url=/mulesoft/current/en-us/dataweave/2.9/dw-coercions.md -->

---
product: DataWeave
version: 2.9
---

# Coercions (dw::util::Coercions)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This utility module assists with type coercions.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::util::Coercions` to the header of your DataWeave script.

_Introduced in DataWeave version 2.4.0._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-coercions-functions-toarray">toArray</a></p></td><td><p>Splits a <code>String</code> value into an <code>Array</code> of characters.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-coercions-functions-tobinary">toBinary</a></p></td><td><p>Transform a <code>String</code> value into a <code>Binary</code> value using the specified encoding.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-coercions-functions-toboolean">toBoolean</a></p></td><td><p>Transform a <code>String</code> value into a <code>Boolean</code> value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-coercions-functions-todate">toDate</a></p></td><td><p>Transforms a <code>String</code> value into a <code>Date</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-coercions-functions-todateornull">toDateOrNull</a></p></td><td><p>Transforms a <code>String</code> value into a <code>Date</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-coercions-functions-todatetime">toDateTime</a></p></td><td><p>Transforms a <code>String</code> value into a <code>DateTime</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-coercions-functions-todatetimeornull">toDateTimeOrNull</a></p></td><td><p>Transforms a <code>String</code> value into a <code>DateTime</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-coercions-functions-tolocaldatetime">toLocalDateTime</a></p></td><td><p>Transforms a <code>String</code> value into a <code>LocalDateTime</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-coercions-functions-tolocaldatetimeornull">toLocalDateTimeOrNull</a></p></td><td><p>Transforms a <code>String</code> value into a <code>LocalDateTime</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-coercions-functions-tolocaltime">toLocalTime</a></p></td><td><p>Transforms a <code>String</code> value into a <code>LocalTime</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-coercions-functions-tolocaltimeornull">toLocalTimeOrNull</a></p></td><td><p>Transforms a <code>String</code> value into a <code>LocalTime</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-coercions-functions-tonumber">toNumber</a></p></td><td><p>Transforms a <code>String</code> value into a <code>Number</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-coercions-functions-tonumberornull">toNumberOrNull</a></p></td><td><p>Transforms a <code>String</code> value into a <code>Number</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-coercions-functions-toperiod">toPeriod</a></p></td><td><p>Transform a <code>String</code> value into a <code>Period</code> value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-coercions-functions-toregex">toRegex</a></p></td><td><p>Transforms a <code>String</code> value into a <code>Regex</code> value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-coercions-functions-tostring">toString</a></p></td><td><p>A variant of <code>toString</code> that transforms a <code>Number</code> value (whole or decimal) into a <code>String</code> value and accepts a format, locale, and rounding mode value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-coercions-functions-totime">toTime</a></p></td><td><p>Transforms a <code>String</code> value into a <code>Time</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-coercions-functions-totimeornull">toTimeOrNull</a></p></td><td><p>Transforms a <code>String</code> value into a <code>Time</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-coercions-functions-totimezone">toTimeZone</a></p></td><td><p>Transform a <code>String</code> value into a <code>TimeZone</code> value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-coercions-functions-touri">toUri</a></p></td><td><p>Transforms a <code>String</code> value into a <code>Uri</code> value.</p></td></tr></tbody></table>

## Types

- [Coercions Types](https://docs.mulesoft.com/dataweave/2.9/dw-coercions-types)

<!-- document id=d793ed4215375cbe23ca87524af5d24b87734d385bb4ae10ea22e33531378c68 url=/mulesoft/current/en-us/dataweave/latest/dw-coercions.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Coercions (dw::util::Coercions)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This utility module assists with type coercions.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::util::Coercions` to the header of your DataWeave script.

_Introduced in DataWeave version 2.4.0._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-coercions-functions-toarray">toArray</a></p></td><td><p>Splits a <code>String</code> value into an <code>Array</code> of characters.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-coercions-functions-tobinary">toBinary</a></p></td><td><p>Transform a <code>String</code> value into a <code>Binary</code> value using the specified encoding.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-coercions-functions-toboolean">toBoolean</a></p></td><td><p>Transform a <code>String</code> value into a <code>Boolean</code> value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-coercions-functions-todate">toDate</a></p></td><td><p>Transforms a <code>String</code> value into a <code>Date</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-coercions-functions-todateornull">toDateOrNull</a></p></td><td><p>Transforms a <code>String</code> value into a <code>Date</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-coercions-functions-todatetime">toDateTime</a></p></td><td><p>Transforms a <code>String</code> value into a <code>DateTime</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-coercions-functions-todatetimeornull">toDateTimeOrNull</a></p></td><td><p>Transforms a <code>String</code> value into a <code>DateTime</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-coercions-functions-tolocaldatetime">toLocalDateTime</a></p></td><td><p>Transforms a <code>String</code> value into a <code>LocalDateTime</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-coercions-functions-tolocaldatetimeornull">toLocalDateTimeOrNull</a></p></td><td><p>Transforms a <code>String</code> value into a <code>LocalDateTime</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-coercions-functions-tolocaltime">toLocalTime</a></p></td><td><p>Transforms a <code>String</code> value into a <code>LocalTime</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-coercions-functions-tolocaltimeornull">toLocalTimeOrNull</a></p></td><td><p>Transforms a <code>String</code> value into a <code>LocalTime</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-coercions-functions-tonumber">toNumber</a></p></td><td><p>Transforms a <code>String</code> value into a <code>Number</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-coercions-functions-tonumberornull">toNumberOrNull</a></p></td><td><p>Transforms a <code>String</code> value into a <code>Number</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-coercions-functions-toperiod">toPeriod</a></p></td><td><p>Transform a <code>String</code> value into a <code>Period</code> value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-coercions-functions-toregex">toRegex</a></p></td><td><p>Transforms a <code>String</code> value into a <code>Regex</code> value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-coercions-functions-tostring">toString</a></p></td><td><p>A variant of <code>toString</code> that transforms a <code>Number</code> value (whole or decimal) into a <code>String</code> value and accepts a format, locale, and rounding mode value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-coercions-functions-totime">toTime</a></p></td><td><p>Transforms a <code>String</code> value into a <code>Time</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-coercions-functions-totimeornull">toTimeOrNull</a></p></td><td><p>Transforms a <code>String</code> value into a <code>Time</code> value using the first <code>Formatter</code> that matches with the given value to transform.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-coercions-functions-totimezone">toTimeZone</a></p></td><td><p>Transform a <code>String</code> value into a <code>TimeZone</code> value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-coercions-functions-touri">toUri</a></p></td><td><p>Transforms a <code>String</code> value into a <code>Uri</code> value.</p></td></tr></tbody></table>

## Types

- [Coercions Types](https://docs.mulesoft.com/dataweave/latest/dw-coercions-types)

<!-- document id=e8a4d9a047e221a0380de130cb83f6d7eaedb67edf13fa985a3a19e3dc704027 url=/mulesoft/current/en-us/dataweave/2.11/dw-coercions-types.md -->

---
product: DataWeave
version: 2.11
---

# Coercions Types (dw::util::Coercions)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>Formatter</p></td><td><div><div><p><code>type Formatter = { format?: String, locale?: String }</code></p></div></div></td><td><div><div><p>Type used for formatting <code>Dates</code> types and <code>Number</code>. Supports the following fields:</p></div><div><ul><li><p><code>format</code>: (optional) The ISO-8601 formatting to use on the date or time. For example, this parameter accepts character patterns based on the Java 8 <code>java.time.format</code>. A <code>null</code> value has no effect on the value.</p></li><li><p><code>locale</code>: (optional) ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default. When you pass a translatable format, such as <code>eeee</code> and <code>MMMM</code>, a <code>locale</code> (such as <code>ES</code>) transforms the corresponding numeric values to a localized string.</p></li></ul></div></div></td></tr><tr><td><p>MillisOrSecs</p></td><td><div><div><p><code>type MillisOrSecs = "milliseconds" | "seconds"</code></p></div></div></td><td><div><div><p>Type used for setting units to <code>"milliseconds"</code> or <code>"seconds"</code>.</p></div></div></td></tr><tr><td><p>PeriodUnits</p></td><td><div><div><p><code>type PeriodUnits = "hours" | "minutes" | "seconds" | "milliseconds" | "nanos"</code></p></div></div></td><td><div><div><p>Type used for setting units of a <code>Period</code> value to <code>"hours"</code>, <code>"minutes"</code>, <code>"seconds"</code>, <code>"milliseconds"</code>, or <code>"nanos"</code>.</p></div></div></td></tr><tr><td><p>RoundingMode</p></td><td><div><div><p><code>type RoundingMode = "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN"</code></p></div></div></td><td><div><div><p>Type used when rounding decimal values up or down.</p></div></div></td></tr></tbody></table>

<!-- document id=cc40cfec5fa9034b4b3b4e3f47b884319473be1158cb8dcee0df84a3e9c3c141 url=/mulesoft/current/en-us/dataweave/2.12/dw-coercions-types.md -->

---
product: DataWeave
version: 2.12
---

# Coercions Types (dw::util::Coercions)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>Formatter</p></td><td><div><div><p><code>type Formatter = { format?: String, locale?: String }</code></p></div></div></td><td><div><div><p>Type used for formatting <code>Dates</code> types and <code>Number</code>. Supports the following fields:</p></div><div><ul><li><p><code>format</code>: (optional) The ISO-8601 formatting to use on the date or time. For example, this parameter accepts character patterns based on the Java 8 <code>java.time.format</code>. A <code>null</code> value has no effect on the value.</p></li><li><p><code>locale</code>: (optional) ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default. When you pass a translatable format, such as <code>eeee</code> and <code>MMMM</code>, a <code>locale</code> (such as <code>ES</code>) transforms the corresponding numeric values to a localized string.</p></li></ul></div></div></td></tr><tr><td><p>MillisOrSecs</p></td><td><div><div><p><code>type MillisOrSecs = "milliseconds" | "seconds"</code></p></div></div></td><td><div><div><p>Type used for setting units to <code>"milliseconds"</code> or <code>"seconds"</code>.</p></div></div></td></tr><tr><td><p>PeriodUnits</p></td><td><div><div><p><code>type PeriodUnits = "hours" | "minutes" | "seconds" | "milliseconds" | "nanos"</code></p></div></div></td><td><div><div><p>Type used for setting units of a <code>Period</code> value to <code>"hours"</code>, <code>"minutes"</code>, <code>"seconds"</code>, <code>"milliseconds"</code>, or <code>"nanos"</code>.</p></div></div></td></tr><tr><td><p>RoundingMode</p></td><td><div><div><p><code>type RoundingMode = "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN"</code></p></div></div></td><td><div><div><p>Type used when rounding decimal values up or down.</p></div></div></td></tr></tbody></table>

<!-- document id=d1fdf3ea0c327b98aca71ba8381bb8870fdf2c1eb31206254ad281d2c5bcfd2c url=/mulesoft/current/en-us/dataweave/2.4/dw-coercions-types.md -->

---
product: DataWeave
version: 2.4
---

# Coercions Types (dw::util::Coercions)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>MillisOrSecs</p></td><td><div><div><p><code>type MillisOrSecs = "milliseconds" | "seconds"</code></p></div></div></td><td><div><div><p>Type used for setting units to <code>"milliseconds"</code> or <code>"seconds"</code>.</p></div></div></td></tr><tr><td><p>PeriodUnits</p></td><td><div><div><p><code>type PeriodUnits = "hours" | "minutes" | "seconds" | "milliseconds" | "nanos"</code></p></div></div></td><td><div><div><p>Type used for setting units of a <code>Period</code> value to <code>"hours"</code>, <code>"minutes"</code>, <code>"seconds"</code>, <code>"milliseconds"</code>, or <code>"nanos"</code>.</p></div></div></td></tr><tr><td><p>RoundingMode</p></td><td><div><div><p><code>type RoundingMode = "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN"</code></p></div></div></td><td><div><div><p>Type used when rounding decimal values up or down.</p></div></div></td></tr></tbody></table>

<!-- document id=4c356cd52e08d8355907806aa3968dc2d981290c15ff84c1bcaf8bc73ae629db url=/mulesoft/current/en-us/dataweave/2.6/dw-coercions-types.md -->

---
product: DataWeave
version: 2.6
---

# Coercions Types (dw::util::Coercions)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>Formatter</p></td><td><div><div><p><code>type Formatter = { format?: String, locale?: String }</code></p></div></div></td><td><div><div><p>Type used for formatting <code>Dates</code> types and <code>Number</code>. Supports the following fields:</p></div><div><ul><li><p><code>format</code>: (optional) The ISO-8601 formatting to use on the date or time. For example, this parameter accepts character patterns based on the Java 8 <code>java.time.format</code>. A <code>null</code> value has no effect on the value.</p></li><li><p><code>locale</code>: (optional) ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default. When you pass a translatable format, such as <code>eeee</code> and <code>MMMM</code>, a <code>locale</code> (such as <code>"ES</code>) transforms the corresponding numeric values to a localized string.</p></li></ul></div></div></td></tr><tr><td><p>MillisOrSecs</p></td><td><div><div><p><code>type MillisOrSecs = "milliseconds" | "seconds"</code></p></div></div></td><td><div><div><p>Type used for setting units to <code>"milliseconds"</code> or <code>"seconds"</code>.</p></div></div></td></tr><tr><td><p>PeriodUnits</p></td><td><div><div><p><code>type PeriodUnits = "hours" | "minutes" | "seconds" | "milliseconds" | "nanos"</code></p></div></div></td><td><div><div><p>Type used for setting units of a <code>Period</code> value to <code>"hours"</code>, <code>"minutes"</code>, <code>"seconds"</code>, <code>"milliseconds"</code>, or <code>"nanos"</code>.</p></div></div></td></tr><tr><td><p>RoundingMode</p></td><td><div><div><p><code>type RoundingMode = "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN"</code></p></div></div></td><td><div><div><p>Type used when rounding decimal values up or down.</p></div></div></td></tr></tbody></table>

<!-- document id=93dcd4d9770ba2ca54ea2ef7ebff6085cbd7464da738adad9259a9e0a629c018 url=/mulesoft/current/en-us/dataweave/2.9/dw-coercions-types.md -->

---
product: DataWeave
version: 2.9
---

# Coercions Types (dw::util::Coercions)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>Formatter</p></td><td><div><div><p><code>type Formatter = { format?: String, locale?: String }</code></p></div></div></td><td><div><div><p>Type used for formatting <code>Dates</code> types and <code>Number</code>. Supports the following fields:</p></div><div><ul><li><p><code>format</code>: (optional) The ISO-8601 formatting to use on the date or time. For example, this parameter accepts character patterns based on the Java 8 <code>java.time.format</code>. A <code>null</code> value has no effect on the value.</p></li><li><p><code>locale</code>: (optional) ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default. When you pass a translatable format, such as <code>eeee</code> and <code>MMMM</code>, a <code>locale</code> (such as <code>ES</code>) transforms the corresponding numeric values to a localized string.</p></li></ul></div></div></td></tr><tr><td><p>MillisOrSecs</p></td><td><div><div><p><code>type MillisOrSecs = "milliseconds" | "seconds"</code></p></div></div></td><td><div><div><p>Type used for setting units to <code>"milliseconds"</code> or <code>"seconds"</code>.</p></div></div></td></tr><tr><td><p>PeriodUnits</p></td><td><div><div><p><code>type PeriodUnits = "hours" | "minutes" | "seconds" | "milliseconds" | "nanos"</code></p></div></div></td><td><div><div><p>Type used for setting units of a <code>Period</code> value to <code>"hours"</code>, <code>"minutes"</code>, <code>"seconds"</code>, <code>"milliseconds"</code>, or <code>"nanos"</code>.</p></div></div></td></tr><tr><td><p>RoundingMode</p></td><td><div><div><p><code>type RoundingMode = "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN"</code></p></div></div></td><td><div><div><p>Type used when rounding decimal values up or down.</p></div></div></td></tr></tbody></table>

<!-- document id=8468b3b972846e75721692cc5dbe1ba64ac2f64a5da98187772c3f71bc0745c6 url=/mulesoft/current/en-us/dataweave/latest/dw-coercions-types.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Coercions Types (dw::util::Coercions)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>Formatter</p></td><td><div><div><p><code>type Formatter = { format?: String, locale?: String }</code></p></div></div></td><td><div><div><p>Type used for formatting <code>Dates</code> types and <code>Number</code>. Supports the following fields:</p></div><div><ul><li><p><code>format</code>: (optional) The ISO-8601 formatting to use on the date or time. For example, this parameter accepts character patterns based on the Java 8 <code>java.time.format</code>. A <code>null</code> value has no effect on the value.</p></li><li><p><code>locale</code>: (optional) ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default. When you pass a translatable format, such as <code>eeee</code> and <code>MMMM</code>, a <code>locale</code> (such as <code>ES</code>) transforms the corresponding numeric values to a localized string.</p></li></ul></div></div></td></tr><tr><td><p>MillisOrSecs</p></td><td><div><div><p><code>type MillisOrSecs = "milliseconds" | "seconds"</code></p></div></div></td><td><div><div><p>Type used for setting units to <code>"milliseconds"</code> or <code>"seconds"</code>.</p></div></div></td></tr><tr><td><p>PeriodUnits</p></td><td><div><div><p><code>type PeriodUnits = "hours" | "minutes" | "seconds" | "milliseconds" | "nanos"</code></p></div></div></td><td><div><div><p>Type used for setting units of a <code>Period</code> value to <code>"hours"</code>, <code>"minutes"</code>, <code>"seconds"</code>, <code>"milliseconds"</code>, or <code>"nanos"</code>.</p></div></div></td></tr><tr><td><p>RoundingMode</p></td><td><div><div><p><code>type RoundingMode = "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN"</code></p></div></div></td><td><div><div><p>Type used when rounding decimal values up or down.</p></div></div></td></tr></tbody></table>

<!-- document id=49d8ff484c61e4360d153e15d3b25d85c52e6437a64015b3ca0ffaf92fd0e9ad url=/mulesoft/current/en-us/dataweave/2.11/dw-strings-functions-collapse.md -->

---
product: DataWeave
version: 2.11
---

# collapse

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## collapse(text: String): Array<String>

Collapses the string into substrings of equal characters.

Each substring contains a single character or identical characters that are adjacent to one another
in the input string. Empty spaces are treated as characters.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to collapse.</p></td></tr></tbody></table>

### Example

This example shows how the function collapses characters. Notice that the empty space (" ") is
treated as a character.

#### Source

```DataWeave
%dw 2.0
import collapse from dw::core::Strings
output application/json
---
collapse("a  b babb a")
```

#### Output

```Json
["a", "  ", "b", " ", "b", "a", "bb", " ", "a"]
```

## collapse(text: Null): Null

Helper function that enables `collapse` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=16b681368574233fa2a4324a373de0fefaa3eafd2dddbaaa3d6d063383d69c80 url=/mulesoft/current/en-us/dataweave/2.12/dw-strings-functions-collapse.md -->

---
product: DataWeave
version: 2.12
---

# collapse

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## collapse(text: String): Array<String>

Collapses the string into substrings of equal characters.

Each substring contains a single character or identical characters that are adjacent to one another
in the input string. Empty spaces are treated as characters.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to collapse.</p></td></tr></tbody></table>

### Example

This example shows how the function collapses characters. Notice that the empty space (" ") is
treated as a character.

#### Source

```DataWeave
%dw 2.0
import collapse from dw::core::Strings
output application/json
---
collapse("a  b babb a")
```

#### Output

```Json
["a", "  ", "b", " ", "b", "a", "bb", " ", "a"]
```

## collapse(text: Null): Null

Helper function that enables `collapse` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=35d2693dcaf77c983f6f9d57f0c157cc7d35d4585feb59e2dbb2a2f2bea273b5 url=/mulesoft/current/en-us/dataweave/2.4/dw-strings-functions-collapse.md -->

---
product: DataWeave
version: 2.4
---

# collapse

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## collapse(text: String): Array<String>

Collapses the string into substrings of equal characters.

Each substring contains a single character or identical characters that are adjacent to one another
in the input string. Empty spaces are treated as characters.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to collapse.</p></td></tr></tbody></table>

### Example

This example shows how the function collapses characters. Notice that the empty space (" ") is
treated as a character.

#### Source

```DataWeave
%dw 2.0
import collapse from dw::core::Strings
output application/json
---
collapse("a  b babb a")
```

#### Output

```Json
["a", "  ", "b", " ", "b", "a", "bb", " ", "a"]
```

## collapse(text: Null): Null

Helper function that enables `collapse` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=d0c0884bb4fced6b7d2a55830e0d5dde209aa004ef38325bb24f53bfbca88767 url=/mulesoft/current/en-us/dataweave/2.6/dw-strings-functions-collapse.md -->

---
product: DataWeave
version: 2.6
---

# collapse

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## collapse(text: String): Array<String>

Collapses the string into substrings of equal characters.

Each substring contains a single character or identical characters that are adjacent to one another
in the input string. Empty spaces are treated as characters.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to collapse.</p></td></tr></tbody></table>

### Example

This example shows how the function collapses characters. Notice that the empty space (" ") is
treated as a character.

#### Source

```DataWeave
%dw 2.0
import collapse from dw::core::Strings
output application/json
---
collapse("a  b babb a")
```

#### Output

```Json
["a", "  ", "b", " ", "b", "a", "bb", " ", "a"]
```

## collapse(text: Null): Null

Helper function that enables `collapse` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=da5efe10270d9876abc69fa2623b447fc84daebb43abe031682ba7e92480f802 url=/mulesoft/current/en-us/dataweave/2.9/dw-strings-functions-collapse.md -->

---
product: DataWeave
version: 2.9
---

# collapse

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## collapse(text: String): Array<String>

Collapses the string into substrings of equal characters.

Each substring contains a single character or identical characters that are adjacent to one another
in the input string. Empty spaces are treated as characters.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to collapse.</p></td></tr></tbody></table>

### Example

This example shows how the function collapses characters. Notice that the empty space (" ") is
treated as a character.

#### Source

```DataWeave
%dw 2.0
import collapse from dw::core::Strings
output application/json
---
collapse("a  b babb a")
```

#### Output

```Json
["a", "  ", "b", " ", "b", "a", "bb", " ", "a"]
```

## collapse(text: Null): Null

Helper function that enables `collapse` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=140a2d34d6ea229fc7054152d2fa1b2861a82cdfb228e29d39a72b8523cfaf96 url=/mulesoft/current/en-us/dataweave/latest/dw-strings-functions-collapse.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# collapse

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## collapse(text: String): Array<String>

Collapses the string into substrings of equal characters.

Each substring contains a single character or identical characters that are adjacent to one another
in the input string. Empty spaces are treated as characters.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to collapse.</p></td></tr></tbody></table>

### Example

This example shows how the function collapses characters. Notice that the empty space (" ") is
treated as a character.

#### Source

```DataWeave
%dw 2.0
import collapse from dw::core::Strings
output application/json
---
collapse("a  b babb a")
```

#### Output

```Json
["a", "  ", "b", " ", "b", "a", "bb", " ", "a"]
```

## collapse(text: Null): Null

Helper function that enables `collapse` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=7ea235ffea6e8d586fb1873e1204bda70248a7ff6dfcd549ed3772857e6565de url=/mulesoft/current/en-us/dataweave/2.12/dw-component.md -->

---
product: DataWeave
version: 2.12
---

# Component (dw::meta::Component)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Use this module to understand the schema of the DataWeave component descriptor. The descriptor is
stored at `/META-INF/dw-components.dwl` inside a `.jar`.

The descriptor value is an `Array<ComponentDescriptor>`. The Maven plugin for DataWeave generates
this file automatically when you package a `dw-library` artifact.

## Types

- [Component Types](https://docs.mulesoft.com/dataweave/2.12/dw-component-types)

<!-- document id=e478de3edbf902831b6a6a66b9b1f097304eca7325936315dfb988f74c3404b8 url=/mulesoft/current/en-us/dataweave/latest/dw-component.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Component (dw::meta::Component)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Use this module to understand the schema of the DataWeave component descriptor. The descriptor is
stored at `/META-INF/dw-components.dwl` inside a `.jar`.

The descriptor value is an `Array<ComponentDescriptor>`. The Maven plugin for DataWeave generates
this file automatically when you package a `dw-library` artifact.

## Types

- [Component Types](https://docs.mulesoft.com/dataweave/latest/dw-component-types)

<!-- document id=243b728c202a3bd1dbaa124c27f769e3f580c0f3f9defd8a5d61387fd869ba95 url=/mulesoft/current/en-us/dataweave/2.12/dw-component-types.md -->

---
product: DataWeave
version: 2.12
---

# Component Types (dw::meta::Component)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Use this topic to understand the DataWeave types in a component descriptor. These types define how
DataWeave represents components and their owned modules in `dw-components.dwl`.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>ComponentDescriptor</p></td><td><div><div><p><code>type ComponentDescriptor = { name: ComponentName, resources: { (NameIdentifier): ModuleDescriptor } }</code></p></div></div></td><td><div><div><p>Describes a single component. Contains the following fields:</p></div><div><ul><li><p><code>name</code>: Component identifier referenced from <code>@VisibleTo</code>.</p></li><li><p><code>resources</code>: Modules owned by the component, keyed by <code>NameIdentifier</code>.</p></li></ul></div><div><p><em>Introduced in DataWeave version 2.12.0.</em></p></div></div></td></tr><tr><td><p>ComponentName</p></td><td><div><div><p><code>type ComponentName = String</code></p></div></div></td><td><div><div><p>Identifier of a component that matches the <code>name</code> field of a <code>ComponentDescriptor</code>.</p></div><div><p><em>Introduced in DataWeave version 2.12.0.</em></p></div></div></td></tr><tr><td><p>ComponentsDescriptor</p></td><td><div><div><p><code>type ComponentsDescriptor = Array&lt;ComponentDescriptor&gt;</code></p></div></div></td><td><div><div><p>Top-level type of a <code>dw-components.dwl</code> file: an array of components.</p></div><div><p><em>Introduced in DataWeave version 2.12.0.</em></p></div></div></td></tr><tr><td><p>ModuleDescriptor</p></td><td><div><div><p><code>type ModuleDescriptor = {}</code></p></div></div></td><td><div><div><p>Per-resource metadata. Reserved for future fields; emit <code>{}</code> for every entry.</p></div><div><p><em>Introduced in DataWeave version 2.12.0.</em></p></div></div></td></tr><tr><td><p>NameIdentifier</p></td><td><div><div><p><code>type NameIdentifier = String</code></p></div></div></td><td><div><div><p>Fully qualified DataWeave module name written with the <code>::</code> separator, such as <code>"dw::core::Strings"</code>.</p></div><div><p><em>Introduced in DataWeave version 2.12.0.</em></p></div></div></td></tr></tbody></table>

<!-- document id=beed25b00034a8d4a5fb2a380abbc27a7c1e19ba3379cccaf12fced8b5cee7cf url=/mulesoft/current/en-us/dataweave/latest/dw-component-types.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Component Types (dw::meta::Component)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Use this topic to understand the DataWeave types in a component descriptor. These types define how
DataWeave represents components and their owned modules in `dw-components.dwl`.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>ComponentDescriptor</p></td><td><div><div><p><code>type ComponentDescriptor = { name: ComponentName, resources: { (NameIdentifier): ModuleDescriptor } }</code></p></div></div></td><td><div><div><p>Describes a single component. Contains these fields:</p></div><div><ul><li><p><code>name</code>: Component identifier referenced from <code>@VisibleTo</code>.</p></li><li><p><code>resources</code>: Modules owned by the component, keyed by <code>NameIdentifier</code>.</p></li></ul></div><div><p><em>Introduced in DataWeave version 2.12.0.</em></p></div></div></td></tr><tr><td><p>ComponentName</p></td><td><div><div><p><code>type ComponentName = String</code></p></div></div></td><td><div><div><p>Identifier of a component that matches the <code>name</code> field of a <code>ComponentDescriptor</code>.</p></div><div><p><em>Introduced in DataWeave version 2.12.0.</em></p></div></div></td></tr><tr><td><p>ComponentsDescriptor</p></td><td><div><div><p><code>type ComponentsDescriptor = Array&lt;ComponentDescriptor&gt;</code></p></div></div></td><td><div><div><p>Top-level type of a <code>dw-components.dwl</code> file: an array of components.</p></div><div><p><em>Introduced in DataWeave version 2.12.0.</em></p></div></div></td></tr><tr><td><p>ModuleDescriptor</p></td><td><div><div><p><code>type ModuleDescriptor = Object</code></p></div></div></td><td><div><div><p>Per-resource metadata. Reserved for future fields; emit <code>{}</code> for every entry.</p></div><div><p><em>Introduced in DataWeave version 2.12.0.</em></p></div></div></td></tr><tr><td><p>NameIdentifier</p></td><td><div><div><p><code>type NameIdentifier = String</code></p></div></div></td><td><div><div><p>Fully qualified DataWeave module name written with the <code>::</code> separator, such as <code>"dw::core::Strings"</code>.</p></div><div><p><em>Introduced in DataWeave version 2.12.0.</em></p></div></div></td></tr></tbody></table>

<!-- document id=0b5b195d75dc61937dc472b5459eeeafec439ec69be751177dfe44862a3ff01a url=/mulesoft/current/en-us/dataweave/2.11/dw-url-functions-compose.md -->

---
product: DataWeave
version: 2.11
---

# compose

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## compose(parts: Array<String>, interpolation: Array<String>): String

Uses a custom string interpolator to replace URL components with a `encodeURIComponent` result. You
can call this function using the standard call, or a simplified version.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>baseStringArray</code></p></td><td><p>A string array that contains the URL parts to interpolate using the strings in the <code>interpolationStringArray</code> parameter.</p></td></tr><tr><td><p><code>interpolationStringArray</code></p></td><td><p>A string array that contains the strings used to interpolate the <code>baseStringArray</code>.</p></td></tr></tbody></table>

### Example

The following example uses the compose function to form an encoded URL, the first parameter is an
array of two strings that are part of the URL and the second parameter is the `urlPath` variable
that is used to interpolate the strings in the first parameter. Notice that the spaces in the input
are encoded in the output URL as `%20`.

#### Source

```DataWeave
%dw 2.0
output application/json
var urlPath = "content folder"
import * from dw::core::URL
---
 { "encodedURL" : compose(["http://examplewebsite.com/", "/page.html"], ["$(urlPath)"]) }
```

#### Output

```JSON
{ "encodedURL" : "http://examplewebsite.com/content%20folder/page.html" }
```

### Example

You can also call this function using the simplified syntax, which uses backticks (`` ` ``) to
enclose the string that includes the variable to encode. This example shows how to use the
simplified syntax to obtain the same result as in the previous example.

#### Source

```DataWeave
%dw 2.0
output application/json
var urlPath = "content folder"
import * from dw::core::URL
---
{ "encodedURL" : compose `http://examplewebsite.com/$(urlPath)/page.html`}
```

#### Output

```JSON
{ "encodedURL" : "http://examplewebsite.com/content%20folder/page.html" }
```

<!-- document id=c20b459af158e2dd9d4501218c99957b16069bacd88e845c647cbc4de4937a9f url=/mulesoft/current/en-us/dataweave/2.12/dw-url-functions-compose.md -->

---
product: DataWeave
version: 2.12
---

# compose

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## compose(parts: Array<String>, interpolation: Array<String>): String

Uses a custom string interpolator to replace URL components with a `encodeURIComponent` result. You
can call this function using the standard call, or a simplified version.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>baseStringArray</code></p></td><td><p>A string array that contains the URL parts to interpolate using the strings in the <code>interpolationStringArray</code> parameter.</p></td></tr><tr><td><p><code>interpolationStringArray</code></p></td><td><p>A string array that contains the strings used to interpolate the <code>baseStringArray</code>.</p></td></tr></tbody></table>

### Example

The following example uses the compose function to form an encoded URL, the first parameter is an
array of two strings that are part of the URL and the second parameter is the `urlPath` variable
that is used to interpolate the strings in the first parameter. Notice that the spaces in the input
are encoded in the output URL as `%20`.

#### Source

```DataWeave
%dw 2.0
output application/json
var urlPath = "content folder"
import * from dw::core::URL
---
 { "encodedURL" : compose(["http://examplewebsite.com/", "/page.html"], ["$(urlPath)"]) }
```

#### Output

```JSON
{ "encodedURL" : "http://examplewebsite.com/content%20folder/page.html" }
```

### Example

You can also call this function using the simplified syntax, which uses backticks (`` ` ``) to
enclose the string that includes the variable to encode. This example shows how to use the
simplified syntax to obtain the same result as in the previous example.

#### Source

```DataWeave
%dw 2.0
output application/json
var urlPath = "content folder"
import * from dw::core::URL
---
{ "encodedURL" : compose `http://examplewebsite.com/$(urlPath)/page.html`}
```

#### Output

```JSON
{ "encodedURL" : "http://examplewebsite.com/content%20folder/page.html" }
```

<!-- document id=26ef36d7c119c40cb21aca05647f3febf1701dd42e03a11a6175c474bd836ef8 url=/mulesoft/current/en-us/dataweave/2.3/dw-url-functions-compose.md -->

---
product: DataWeave
version: 2.3
---

# compose

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## compose(Array<String>, Array<String>): String

Uses a custom string interpolator to replace URL components with a `encodeURIComponent` result. You
can call this function using the standard call, or a simplified version.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>baseStringArray</code></p></td><td><p>A string array that contains the URL parts to interpolate using the strings in the <code>interpolationStringArray</code> parameter.</p></td></tr><tr><td><p><code>interpolationStringArray</code></p></td><td><p>A string array that contains the strings used to interpolate the <code>baseStringArray</code>.</p></td></tr></tbody></table>

### Example

The following example uses the compose function to form an encoded URL, the first parameter is an
array of two strings that are part of the URL and the second parameter is the `urlPath` variable
that is used to interpolate the strings in the first parameter. Notice that the spaces in the input
are encoded in the output URL as `%20`.

#### Source

```DataWeave
%dw 2.0
output application/json
var urlPath = "content folder"
import * from dw::core::URL
---
{ "encodedURL" : compose(["http://examplewebsite.com/", "/page.html"], ["$(urlPath)"]) }
```

#### Output

```JSON
{ "encodedURL" : "http://examplewebsite.com/content%20folder/page.html" }
```

## Simplified Syntax

You can also call this function using the simplified syntax, which uses backticks (`` ` ``) to
enclose the string that includes the variable to encode.

### Example

This example shows how to use the simplified syntax to obtain the same result as in the previous
example.

#### Source

```DataWeave
%dw 2.0
output application/json
var urlPath = "content folder"
import * from dw::core::URL
---
{ "encodedURL" : compose `http://examplewebsite.com/$(urlPath)/page.html` }
```

#### Output

```JSON
{ "encodedURL" : "http://examplewebsite.com/content%20folder/page.html" }
```

<!-- document id=361ef52403c61521d0580261ffa3d06217b84052d7c29d7e4ddfd9464aa3ab29 url=/mulesoft/current/en-us/dataweave/2.4/dw-url-functions-compose.md -->

---
product: DataWeave
version: 2.4
---

# compose

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## compose(parts: Array<String>, interpolation: Array<String>): String

Uses a custom string interpolator to replace URL components with a `encodeURIComponent` result. You
can call this function using the standard call, or a simplified version.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>baseStringArray</code></p></td><td><p>A string array that contains the URL parts to interpolate using the strings in the <code>interpolationStringArray</code> parameter.</p></td></tr><tr><td><p><code>interpolationStringArray</code></p></td><td><p>A string array that contains the strings used to interpolate the <code>baseStringArray</code>.</p></td></tr></tbody></table>

### Example

The following example uses the compose function to form an encoded URL, the first parameter is an
array of two strings that are part of the URL and the second parameter is the `urlPath` variable
that is used to interpolate the strings in the first parameter. Notice that the spaces in the input
are encoded in the output URL as `%20`.

#### Source

```DataWeave
%dw 2.0
output application/json
var urlPath = "content folder"
import * from dw::core::URL
---
 { "encodedURL" : compose(["http://examplewebsite.com/", "/page.html"], ["$(urlPath)"]) }
```

#### Output

```JSON
{ "encodedURL" : "http://examplewebsite.com/content%20folder/page.html" }
```

### Example

You can also call this function using the simplified syntax, which uses backticks (`` ` ``) to
enclose the string that includes the variable to encode. This example shows how to use the
simplified syntax to obtain the same result as in the previous example.

#### Source

```DataWeave
%dw 2.0
output application/json
var urlPath = "content folder"
import * from dw::core::URL
---
{ "encodedURL" : compose `http://examplewebsite.com/$(urlPath)/page.html`}
```

#### Output

```JSON
{ "encodedURL" : "http://examplewebsite.com/content%20folder/page.html" }
```

<!-- document id=7bb23a5a6c7a365ed79d2f797df1396e8aa3d63849ecec5347c3002a83f7c395 url=/mulesoft/current/en-us/dataweave/2.6/dw-url-functions-compose.md -->

---
product: DataWeave
version: 2.6
---

# compose

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## compose(parts: Array<String>, interpolation: Array<String>): String

Uses a custom string interpolator to replace URL components with a `encodeURIComponent` result. You
can call this function using the standard call, or a simplified version.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>baseStringArray</code></p></td><td><p>A string array that contains the URL parts to interpolate using the strings in the <code>interpolationStringArray</code> parameter.</p></td></tr><tr><td><p><code>interpolationStringArray</code></p></td><td><p>A string array that contains the strings used to interpolate the <code>baseStringArray</code>.</p></td></tr></tbody></table>

### Example

The following example uses the compose function to form an encoded URL, the first parameter is an
array of two strings that are part of the URL and the second parameter is the `urlPath` variable
that is used to interpolate the strings in the first parameter. Notice that the spaces in the input
are encoded in the output URL as `%20`.

#### Source

```DataWeave
%dw 2.0
output application/json
var urlPath = "content folder"
import * from dw::core::URL
---
 { "encodedURL" : compose(["http://examplewebsite.com/", "/page.html"], ["$(urlPath)"]) }
```

#### Output

```JSON
{ "encodedURL" : "http://examplewebsite.com/content%20folder/page.html" }
```

### Example

You can also call this function using the simplified syntax, which uses backticks (`` ` ``) to
enclose the string that includes the variable to encode. This example shows how to use the
simplified syntax to obtain the same result as in the previous example.

#### Source

```DataWeave
%dw 2.0
output application/json
var urlPath = "content folder"
import * from dw::core::URL
---
{ "encodedURL" : compose `http://examplewebsite.com/$(urlPath)/page.html`}
```

#### Output

```JSON
{ "encodedURL" : "http://examplewebsite.com/content%20folder/page.html" }
```

<!-- document id=615edccf5a5ec53bba6f2cb0d1504d1121a500c6a58b014bbd52dce0defa4a27 url=/mulesoft/current/en-us/dataweave/2.9/dw-url-functions-compose.md -->

---
product: DataWeave
version: 2.9
---

# compose

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## compose(parts: Array<String>, interpolation: Array<String>): String

Uses a custom string interpolator to replace URL components with a `encodeURIComponent` result. You
can call this function using the standard call, or a simplified version.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>baseStringArray</code></p></td><td><p>A string array that contains the URL parts to interpolate using the strings in the <code>interpolationStringArray</code> parameter.</p></td></tr><tr><td><p><code>interpolationStringArray</code></p></td><td><p>A string array that contains the strings used to interpolate the <code>baseStringArray</code>.</p></td></tr></tbody></table>

### Example

The following example uses the compose function to form an encoded URL, the first parameter is an
array of two strings that are part of the URL and the second parameter is the `urlPath` variable
that is used to interpolate the strings in the first parameter. Notice that the spaces in the input
are encoded in the output URL as `%20`.

#### Source

```DataWeave
%dw 2.0
output application/json
var urlPath = "content folder"
import * from dw::core::URL
---
 { "encodedURL" : compose(["http://examplewebsite.com/", "/page.html"], ["$(urlPath)"]) }
```

#### Output

```JSON
{ "encodedURL" : "http://examplewebsite.com/content%20folder/page.html" }
```

### Example

You can also call this function using the simplified syntax, which uses backticks (`` ` ``) to
enclose the string that includes the variable to encode. This example shows how to use the
simplified syntax to obtain the same result as in the previous example.

#### Source

```DataWeave
%dw 2.0
output application/json
var urlPath = "content folder"
import * from dw::core::URL
---
{ "encodedURL" : compose `http://examplewebsite.com/$(urlPath)/page.html`}
```

#### Output

```JSON
{ "encodedURL" : "http://examplewebsite.com/content%20folder/page.html" }
```

<!-- document id=60e25ad36268e907e5fe5a3692e2ea4a4f4015a34b98cc73642a9a90d9be82bd url=/mulesoft/current/en-us/dataweave/latest/dw-url-functions-compose.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# compose

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## compose(parts: Array<String>, interpolation: Array<String>): String

Uses a custom string interpolator to replace URL components with a `encodeURIComponent` result. You
can call this function using the standard call, or a simplified version.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>baseStringArray</code></p></td><td><p>A string array that contains the URL parts to interpolate using the strings in the <code>interpolationStringArray</code> parameter.</p></td></tr><tr><td><p><code>interpolationStringArray</code></p></td><td><p>A string array that contains the strings used to interpolate the <code>baseStringArray</code>.</p></td></tr></tbody></table>

### Example

The following example uses the compose function to form an encoded URL, the first parameter is an
array of two strings that are part of the URL and the second parameter is the `urlPath` variable
that is used to interpolate the strings in the first parameter. Notice that the spaces in the input
are encoded in the output URL as `%20`.

#### Source

```DataWeave
%dw 2.0
output application/json
var urlPath = "content folder"
import * from dw::core::URL
---
 { "encodedURL" : compose(["http://examplewebsite.com/", "/page.html"], ["$(urlPath)"]) }
```

#### Output

```JSON
{ "encodedURL" : "http://examplewebsite.com/content%20folder/page.html" }
```

### Example

You can also call this function using the simplified syntax, which uses backticks (`` ` ``) to
enclose the string that includes the variable to encode. This example shows how to use the
simplified syntax to obtain the same result as in the previous example.

#### Source

```DataWeave
%dw 2.0
output application/json
var urlPath = "content folder"
import * from dw::core::URL
---
{ "encodedURL" : compose `http://examplewebsite.com/$(urlPath)/page.html`}
```

#### Output

```JSON
{ "encodedURL" : "http://examplewebsite.com/content%20folder/page.html" }
```

<!-- document id=10c9967e6b6992c225e813934da188bd955d02b791108b0df45d635472406f58 url=/mulesoft/current/en-us/dataweave/2.11/dw-binaries-functions-concatwith.md -->

---
product: DataWeave
version: 2.11
---

# concatWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## concatWith(source: Binary, with: Binary): Binary

Concatenates the content of two binaries.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>Binary</p></td><td><p>The source binary content.</p></td></tr><tr><td><p><code>with</code></p></td><td><p>Binary</p></td><td><p>The binary to append.</p></td></tr></tbody></table>

### Example

This example concatenates two base-16 values into one binary value.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Binaries
output application/dw
---
"CAFE" as Binary {base: "16"} concatWith "ABCD" as Binary {base: "16"}
```

#### Output

```Json
"yv6rzQ==" as Binary {base: "64"}
```

## concatWith(source: Binary, with: Null): Binary

Helper function that enables `concatWith` to work with a `null` value.

## concatWith(source: Null, with: Binary): Binary

Helper function that enables `concatWith` to work with a `null` value.

<!-- document id=2c647683f4bf8f075f41b81a7182f6242a4076167341bb28a2215dc0ef272b61 url=/mulesoft/current/en-us/dataweave/2.12/dw-binaries-functions-concatwith.md -->

---
product: DataWeave
version: 2.12
---

# concatWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## concatWith(source: Binary, with: Binary): Binary

Concatenates the content of two binaries.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>Binary</p></td><td><p>The source binary content.</p></td></tr><tr><td><p><code>with</code></p></td><td><p>Binary</p></td><td><p>The binary to append.</p></td></tr></tbody></table>

### Example

This example concatenates two base-16 values into one binary value.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Binaries
output application/dw
---
"CAFE" as Binary {base: "16"} concatWith "ABCD" as Binary {base: "16"}
```

#### Output

```Json
"yv6rzQ==" as Binary {base: "64"}
```

## concatWith(source: Binary, with: Null): Binary

Helper function that enables `concatWith` to work with a `null` value.

## concatWith(source: Null, with: Binary): Binary

Helper function that enables `concatWith` to work with a `null` value.

<!-- document id=f3dad6876e8d32109c9213cc31aaec7b89258285c10f8189d6e037eee4205b60 url=/mulesoft/current/en-us/dataweave/2.6/dw-binaries-functions-concatwith.md -->

---
product: DataWeave
version: 2.6
---

# concatWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## concatWith(source: Binary, with: Binary): Binary

Concatenates the content of two binaries.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>Binary</p></td><td><p>The source binary content.</p></td></tr><tr><td><p><code>with</code></p></td><td><p>Binary</p></td><td><p>The binary to append.</p></td></tr></tbody></table>

### Example

This example concatenates two base-16 values into one binary value.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Binaries
output application/dw
---
"CAFE" as Binary {base: "16"} concatWith "ABCD" as Binary {base: "16"}
```

#### Output

```Json
"yv6rzQ==" as Binary {base: "64"}
```

## concatWith(source: Binary, with: Null): Binary

Helper function that enables `concatWith` to work with a `null` value.

## concatWith(source: Null, with: Binary): Binary

Helper function that enables `concatWith` to work with a `null` value.

<!-- document id=ccc560dc9e496cbadf17ea69681b061d1c500df7c9fbf7ce9bb1295987391fd1 url=/mulesoft/current/en-us/dataweave/2.9/dw-binaries-functions-concatwith.md -->

---
product: DataWeave
version: 2.9
---

# concatWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## concatWith(source: Binary, with: Binary): Binary

Concatenates the content of two binaries.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>Binary</p></td><td><p>The source binary content.</p></td></tr><tr><td><p><code>with</code></p></td><td><p>Binary</p></td><td><p>The binary to append.</p></td></tr></tbody></table>

### Example

This example concatenates two base-16 values into one binary value.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Binaries
output application/dw
---
"CAFE" as Binary {base: "16"} concatWith "ABCD" as Binary {base: "16"}
```

#### Output

```Json
"yv6rzQ==" as Binary {base: "64"}
```

## concatWith(source: Binary, with: Null): Binary

Helper function that enables `concatWith` to work with a `null` value.

## concatWith(source: Null, with: Binary): Binary

Helper function that enables `concatWith` to work with a `null` value.

<!-- document id=344248319a4b8f061cb8f20b1ed41f483f14de3aa659d7f8898a1631f4d47c6c url=/mulesoft/current/en-us/dataweave/latest/dw-binaries-functions-concatwith.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# concatWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## concatWith(source: Binary, with: Binary): Binary

Concatenates the content of two binaries.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>Binary</p></td><td><p>The source binary content.</p></td></tr><tr><td><p><code>with</code></p></td><td><p>Binary</p></td><td><p>The binary to append.</p></td></tr></tbody></table>

### Example

This example concatenates two base-16 values into one binary value.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Binaries
output application/dw
---
"CAFE" as Binary {base: "16"} concatWith "ABCD" as Binary {base: "16"}
```

#### Output

```Json
"yv6rzQ==" as Binary {base: "64"}
```

## concatWith(source: Binary, with: Null): Binary

Helper function that enables `concatWith` to work with a `null` value.

## concatWith(source: Null, with: Binary): Binary

Helper function that enables `concatWith` to work with a `null` value.

<!-- document id=88353d4b76efaa1cb8c8c0c7f356fd229207bfe94a87caddfd5625ef796baa0e url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook-conditional-list-reduction-via-function.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Conditionally Reduce a List through a Function

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example flattens the input to something simpler. For each element in the input, it
conditionally includes a `contentTypes` field only in case it has any values. It then rearranges
this content into a more readable shape.

The examples use these functions:

- `map` to go through every element in the input array.

- `reduce` to aggregate the multiple elements in the `tags` array into one field.

- `splitBy` to parse the values in the "tags" array, so as to only select the first part of each
  string (through `[0]`) and discard the second.

- `++` to concatenate these elements into one single string, with commas as separators.

- `if` include the last field only if the `contentTypes` array is bigger than 0.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
fun reduceMapFor(data) = data reduce(($$ splitBy ":")[0] ++ "," ++ ($ splitBy ":")[0])
---
payload.results map
    {
        email: $.profile.email,
        name: $.profile.firstName,
        tags: reduceMapFor($.data.interests.tags[0]),
        (contenttypes: reduceMapFor($.data.interests.contenttypes[0])) if (sizeOf($.data.interests.contenttypes[0]) > 0)
    }
```

Input JSON Payload:

```json
{
  "results": [
    {
      "profile": {
        "firstName": "john",
        "lastName": "doe",
        "email": "johndoe@demo.com"
      },
      "data": {
        "interests": [
          {
            "language": "English",
            "tags": ["digital-strategy:Digital Strategy", "innovation:Innovation"],
            "contenttypes": []
          }
        ]
      }
    },
    {
      "profile": {
        "firstName": "jane",
        "lastName": "doe",
        "email": "janedoe@demo.com"
      },
      "data": {
        "interests": [
          {
            "language": "English",
            "tags": ["tax-reform:Tax Reform", "retail-health:Retail Health"],
            "contenttypes": ["News", "Analysis", "Case studies", "Press releases"]
          }
        ]
      }
    }
  ],
  "objectsCount": 2,
  "totalCount": 2,
  "statusCode": 200,
  "errorCode": 0,
  "statusReason": "OK"
}
```

Output JSON:

```json
[
  {
    "email": "johndoe@demo.com",
    "name": "john",
    "tags": "digital-strategy,innovation"
  },
  {
    "email": "janedoe@demo.com",
    "name": "jane",
    "tags": "tax-reform,retail-health",
    "contenttypes": "News,Analysis,Case studies,Press releases"
  }
]
```

## Related Examples

- [Exclude Fields from the Output](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-exclude-field)

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-output-a-field-when-present)

- [Use Constant Directives](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-use-constant-directives)

- [Define a Function that Flattens Data in a List](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-define-function-to-flatten-list)

- [Pass Functions as Arguments](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-pass-functions-as-arguments)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.11/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook)

<!-- document id=11554057205e354b72561b91e91f4e231984f9e0a435e5c63871554eac15a160 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook-conditional-list-reduction-via-function.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Conditionally Reduce a List through a Function

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example flattens the input to something simpler. For each element in the input, it
conditionally includes a `contentTypes` field only in case it has any values. It then rearranges
this content into a more readable shape.

The examples use these functions:

- `map` to go through every element in the input array.

- `reduce` to aggregate the multiple elements in the `tags` array into one field.

- `splitBy` to parse the values in the "tags" array, so as to only select the first part of each
  string (through `[0]`) and discard the second.

- `++` to concatenate these elements into one single string, with commas as separators.

- `if` include the last field only if the `contentTypes` array is bigger than 0.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
fun reduceMapFor(data) = data reduce(($$ splitBy ":")[0] ++ "," ++ ($ splitBy ":")[0])
---
payload.results map
    {
        email: $.profile.email,
        name: $.profile.firstName,
        tags: reduceMapFor($.data.interests.tags[0]),
        (contenttypes: reduceMapFor($.data.interests.contenttypes[0])) if (sizeOf($.data.interests.contenttypes[0]) > 0)
    }
```

Input JSON Payload:

```json
{
  "results": [
    {
      "profile": {
        "firstName": "john",
        "lastName": "doe",
        "email": "johndoe@demo.com"
      },
      "data": {
        "interests": [
          {
            "language": "English",
            "tags": ["digital-strategy:Digital Strategy", "innovation:Innovation"],
            "contenttypes": []
          }
        ]
      }
    },
    {
      "profile": {
        "firstName": "jane",
        "lastName": "doe",
        "email": "janedoe@demo.com"
      },
      "data": {
        "interests": [
          {
            "language": "English",
            "tags": ["tax-reform:Tax Reform", "retail-health:Retail Health"],
            "contenttypes": ["News", "Analysis", "Case studies", "Press releases"]
          }
        ]
      }
    }
  ],
  "objectsCount": 2,
  "totalCount": 2,
  "statusCode": 200,
  "errorCode": 0,
  "statusReason": "OK"
}
```

Output JSON:

```json
[
  {
    "email": "johndoe@demo.com",
    "name": "john",
    "tags": "digital-strategy,innovation"
  },
  {
    "email": "janedoe@demo.com",
    "name": "jane",
    "tags": "tax-reform,retail-health",
    "contenttypes": "News,Analysis,Case studies,Press releases"
  }
]
```

## Related Examples

- [Exclude Fields from the Output](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-exclude-field)

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-output-a-field-when-present)

- [Use Constant Directives](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-use-constant-directives)

- [Define a Function that Flattens Data in a List](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-define-function-to-flatten-list)

- [Pass Functions as Arguments](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-pass-functions-as-arguments)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.12/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook)

<!-- document id=66f07bf4480acadfa241b8f224319340692b92683c513c123ec958522e1eba48 url=/mulesoft/current/en-us/dataweave/2.3/dataweave-cookbook-conditional-list-reduction-via-function.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Conditionally Reduce a List through a Function

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example flattens the input to something simpler. For each element in the input, it
conditionally includes a `contentTypes` field only in case it has any values. It then rearranges
this content into a more readable shape.

The examples use these functions:

- `map` to go through every element in the input array.

- `reduce` to aggregate the multiple elements in the `tags` array into one field.

- `splitBy` to parse the values in the "tags" array, so as to only select the first part of each
  string (through `[0]`) and discard the second.

- `++` to concatenate these elements into one single string, with commas as separators.

- `if` include the last field only if the `contentTypes` array is bigger than 0.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
fun reduceMapFor(data) = data reduce(($$ splitBy ":")[0] ++ "," ++ ($ splitBy ":")[0])
---
payload.results map
    {
        email: $.profile.email,
        name: $.profile.firstName,
        tags: reduceMapFor($.data.interests.tags[0]),
        (contenttypes: reduceMapFor($.data.interests.contenttypes[0])) if (sizeOf($.data.interests.contenttypes[0]) > 0)
    }
```

Input JSON Payload:

```json
{
  "results": [
    {
      "profile": {
        "firstName": "john",
        "lastName": "doe",
        "email": "johndoe@demo.com"
      },
      "data": {
        "interests": [
          {
            "language": "English",
            "tags": ["digital-strategy:Digital Strategy", "innovation:Innovation"],
            "contenttypes": []
          }
        ]
      }
    },
    {
      "profile": {
        "firstName": "jane",
        "lastName": "doe",
        "email": "janedoe@demo.com"
      },
      "data": {
        "interests": [
          {
            "language": "English",
            "tags": ["tax-reform:Tax Reform", "retail-health:Retail Health"],
            "contenttypes": ["News", "Analysis", "Case studies", "Press releases"]
          }
        ]
      }
    }
  ],
  "objectsCount": 2,
  "totalCount": 2,
  "statusCode": 200,
  "errorCode": 0,
  "statusReason": "OK"
}
```

Output JSON:

```json
[
  {
    "email": "johndoe@demo.com",
    "name": "john",
    "tags": "digital-strategy,innovation"
  },
  {
    "email": "janedoe@demo.com",
    "name": "jane",
    "tags": "tax-reform,retail-health",
    "contenttypes": "News,Analysis,Case studies,Press releases"
  }
]
```

## Related Examples

- [Exclude Fields from the Output](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-exclude-field)

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-output-a-field-when-present)

- [Use Constant Directives](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-use-constant-directives)

- [Define a Function that Flattens Data in a List](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-define-function-to-flatten-list)

- [Pass Functions as Arguments](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-pass-functions-as-arguments)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.3/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook)

<!-- document id=0f619a2a2988f610af5718b712dd8304c950de8d0c65c532e8fb3927e3b14581 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook-conditional-list-reduction-via-function.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Conditionally Reduce a List through a Function

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example flattens the input to something simpler. For each element in the input, it
conditionally includes a `contentTypes` field only in case it has any values. It then rearranges
this content into a more readable shape.

The examples use these functions:

- `map` to go through every element in the input array.

- `reduce` to aggregate the multiple elements in the `tags` array into one field.

- `splitBy` to parse the values in the "tags" array, so as to only select the first part of each
  string (through `[0]`) and discard the second.

- `++` to concatenate these elements into one single string, with commas as separators.

- `if` include the last field only if the `contentTypes` array is bigger than 0.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
fun reduceMapFor(data) = data reduce(($$ splitBy ":")[0] ++ "," ++ ($ splitBy ":")[0])
---
payload.results map
    {
        email: $.profile.email,
        name: $.profile.firstName,
        tags: reduceMapFor($.data.interests.tags[0]),
        (contenttypes: reduceMapFor($.data.interests.contenttypes[0])) if (sizeOf($.data.interests.contenttypes[0]) > 0)
    }
```

Input JSON Payload:

```json
{
  "results": [
    {
      "profile": {
        "firstName": "john",
        "lastName": "doe",
        "email": "johndoe@demo.com"
      },
      "data": {
        "interests": [
          {
            "language": "English",
            "tags": ["digital-strategy:Digital Strategy", "innovation:Innovation"],
            "contenttypes": []
          }
        ]
      }
    },
    {
      "profile": {
        "firstName": "jane",
        "lastName": "doe",
        "email": "janedoe@demo.com"
      },
      "data": {
        "interests": [
          {
            "language": "English",
            "tags": ["tax-reform:Tax Reform", "retail-health:Retail Health"],
            "contenttypes": ["News", "Analysis", "Case studies", "Press releases"]
          }
        ]
      }
    }
  ],
  "objectsCount": 2,
  "totalCount": 2,
  "statusCode": 200,
  "errorCode": 0,
  "statusReason": "OK"
}
```

Output JSON:

```json
[
  {
    "email": "johndoe@demo.com",
    "name": "john",
    "tags": "digital-strategy,innovation"
  },
  {
    "email": "janedoe@demo.com",
    "name": "jane",
    "tags": "tax-reform,retail-health",
    "contenttypes": "News,Analysis,Case studies,Press releases"
  }
]
```

## Related Examples

- [Exclude Fields from the Output](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-exclude-field)

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-output-a-field-when-present)

- [Use Constant Directives](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-use-constant-directives)

- [Define a Function that Flattens Data in a List](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-define-function-to-flatten-list)

- [Pass Functions as Arguments](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-pass-functions-as-arguments)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.4/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook)

<!-- document id=11f1929d493b35ee77d057fbf6c30ce2787853871e1dfe65cb87a83b83d1afae url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook-conditional-list-reduction-via-function.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Conditionally Reduce a List through a Function

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example flattens the input to something simpler. For each element in the input, it
conditionally includes a `contentTypes` field only in case it has any values. It then rearranges
this content into a more readable shape.

The examples use these functions:

- `map` to go through every element in the input array.

- `reduce` to aggregate the multiple elements in the `tags` array into one field.

- `splitBy` to parse the values in the "tags" array, so as to only select the first part of each
  string (through `[0]`) and discard the second.

- `++` to concatenate these elements into one single string, with commas as separators.

- `if` include the last field only if the `contentTypes` array is bigger than 0.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
fun reduceMapFor(data) = data reduce(($$ splitBy ":")[0] ++ "," ++ ($ splitBy ":")[0])
---
payload.results map
    {
        email: $.profile.email,
        name: $.profile.firstName,
        tags: reduceMapFor($.data.interests.tags[0]),
        (contenttypes: reduceMapFor($.data.interests.contenttypes[0])) if (sizeOf($.data.interests.contenttypes[0]) > 0)
    }
```

Input JSON Payload:

```json
{
  "results": [
    {
      "profile": {
        "firstName": "john",
        "lastName": "doe",
        "email": "johndoe@demo.com"
      },
      "data": {
        "interests": [
          {
            "language": "English",
            "tags": ["digital-strategy:Digital Strategy", "innovation:Innovation"],
            "contenttypes": []
          }
        ]
      }
    },
    {
      "profile": {
        "firstName": "jane",
        "lastName": "doe",
        "email": "janedoe@demo.com"
      },
      "data": {
        "interests": [
          {
            "language": "English",
            "tags": ["tax-reform:Tax Reform", "retail-health:Retail Health"],
            "contenttypes": ["News", "Analysis", "Case studies", "Press releases"]
          }
        ]
      }
    }
  ],
  "objectsCount": 2,
  "totalCount": 2,
  "statusCode": 200,
  "errorCode": 0,
  "statusReason": "OK"
}
```

Output JSON:

```json
[
  {
    "email": "johndoe@demo.com",
    "name": "john",
    "tags": "digital-strategy,innovation"
  },
  {
    "email": "janedoe@demo.com",
    "name": "jane",
    "tags": "tax-reform,retail-health",
    "contenttypes": "News,Analysis,Case studies,Press releases"
  }
]
```

## Related Examples

- [Exclude Fields from the Output](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-exclude-field)

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-output-a-field-when-present)

- [Use Constant Directives](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-use-constant-directives)

- [Define a Function that Flattens Data in a List](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-define-function-to-flatten-list)

- [Pass Functions as Arguments](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-pass-functions-as-arguments)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.6/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook)

<!-- document id=d774a76f3c3631fe354b434b484f1c15a2d8934e1cbc99f7a5756e1156eba05a url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook-conditional-list-reduction-via-function.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Conditionally Reduce a List through a Function

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example flattens the input to something simpler. For each element in the input, it
conditionally includes a `contentTypes` field only in case it has any values. It then rearranges
this content into a more readable shape.

The examples use these functions:

- `map` to go through every element in the input array.

- `reduce` to aggregate the multiple elements in the `tags` array into one field.

- `splitBy` to parse the values in the "tags" array, so as to only select the first part of each
  string (through `[0]`) and discard the second.

- `++` to concatenate these elements into one single string, with commas as separators.

- `if` include the last field only if the `contentTypes` array is bigger than 0.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
fun reduceMapFor(data) = data reduce(($$ splitBy ":")[0] ++ "," ++ ($ splitBy ":")[0])
---
payload.results map
    {
        email: $.profile.email,
        name: $.profile.firstName,
        tags: reduceMapFor($.data.interests.tags[0]),
        (contenttypes: reduceMapFor($.data.interests.contenttypes[0])) if (sizeOf($.data.interests.contenttypes[0]) > 0)
    }
```

Input JSON Payload:

```json
{
  "results": [
    {
      "profile": {
        "firstName": "john",
        "lastName": "doe",
        "email": "johndoe@demo.com"
      },
      "data": {
        "interests": [
          {
            "language": "English",
            "tags": ["digital-strategy:Digital Strategy", "innovation:Innovation"],
            "contenttypes": []
          }
        ]
      }
    },
    {
      "profile": {
        "firstName": "jane",
        "lastName": "doe",
        "email": "janedoe@demo.com"
      },
      "data": {
        "interests": [
          {
            "language": "English",
            "tags": ["tax-reform:Tax Reform", "retail-health:Retail Health"],
            "contenttypes": ["News", "Analysis", "Case studies", "Press releases"]
          }
        ]
      }
    }
  ],
  "objectsCount": 2,
  "totalCount": 2,
  "statusCode": 200,
  "errorCode": 0,
  "statusReason": "OK"
}
```

Output JSON:

```json
[
  {
    "email": "johndoe@demo.com",
    "name": "john",
    "tags": "digital-strategy,innovation"
  },
  {
    "email": "janedoe@demo.com",
    "name": "jane",
    "tags": "tax-reform,retail-health",
    "contenttypes": "News,Analysis,Case studies,Press releases"
  }
]
```

## Related Examples

- [Exclude Fields from the Output](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-exclude-field)

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-output-a-field-when-present)

- [Use Constant Directives](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-use-constant-directives)

- [Define a Function that Flattens Data in a List](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-define-function-to-flatten-list)

- [Pass Functions as Arguments](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-pass-functions-as-arguments)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.9/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook)

<!-- document id=5dafbadd89edb2217aced3bc66a2d5c90631d338ce5c154174370a3d708026fc url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook-conditional-list-reduction-via-function.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Conditionally Reduce a List through a Function

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example flattens the input to something simpler. For each element in the input, it
conditionally includes a `contentTypes` field only in case it has any values. It then rearranges
this content into a more readable shape.

The examples use these functions:

- `map` to go through every element in the input array.

- `reduce` to aggregate the multiple elements in the `tags` array into one field.

- `splitBy` to parse the values in the "tags" array, so as to only select the first part of each
  string (through `[0]`) and discard the second.

- `++` to concatenate these elements into one single string, with commas as separators.

- `if` include the last field only if the `contentTypes` array is bigger than 0.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
fun reduceMapFor(data) = data reduce(($$ splitBy ":")[0] ++ "," ++ ($ splitBy ":")[0])
---
payload.results map
    {
        email: $.profile.email,
        name: $.profile.firstName,
        tags: reduceMapFor($.data.interests.tags[0]),
        (contenttypes: reduceMapFor($.data.interests.contenttypes[0])) if (sizeOf($.data.interests.contenttypes[0]) > 0)
    }
```

Input JSON Payload:

```json
{
  "results": [
    {
      "profile": {
        "firstName": "john",
        "lastName": "doe",
        "email": "johndoe@demo.com"
      },
      "data": {
        "interests": [
          {
            "language": "English",
            "tags": ["digital-strategy:Digital Strategy", "innovation:Innovation"],
            "contenttypes": []
          }
        ]
      }
    },
    {
      "profile": {
        "firstName": "jane",
        "lastName": "doe",
        "email": "janedoe@demo.com"
      },
      "data": {
        "interests": [
          {
            "language": "English",
            "tags": ["tax-reform:Tax Reform", "retail-health:Retail Health"],
            "contenttypes": ["News", "Analysis", "Case studies", "Press releases"]
          }
        ]
      }
    }
  ],
  "objectsCount": 2,
  "totalCount": 2,
  "statusCode": 200,
  "errorCode": 0,
  "statusReason": "OK"
}
```

Output JSON:

```json
[
  {
    "email": "johndoe@demo.com",
    "name": "john",
    "tags": "digital-strategy,innovation"
  },
  {
    "email": "janedoe@demo.com",
    "name": "jane",
    "tags": "tax-reform,retail-health",
    "contenttypes": "News,Analysis,Case studies,Press releases"
  }
]
```

## Related Examples

- [Exclude Fields from the Output](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-exclude-field)

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-output-a-field-when-present)

- [Use Constant Directives](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-use-constant-directives)

- [Define a Function that Flattens Data in a List](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-define-function-to-flatten-list)

- [Pass Functions as Arguments](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-pass-functions-as-arguments)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook)

<!-- document id=7c744de9d6d5b42577996e4c73d1281bcf9cfabd2a5dfc40dcd3cad9d5f0cb23 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-contains.md -->

---
product: DataWeave
version: 2.11
---

# contains

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## contains<T>(@StreamCapable items: Array<T>, element: Any): Boolean

Returns `true` if an input contains a given value, `false` if not.

This version of `contains` accepts an array as input. Other versions accept a string and can use
another string or regular expression to determine whether there is a match.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The input array.</p></td></tr><tr><td><p><code>elements</code></p></td><td><p>Element to find in the array. Can be any supported data type.</p></td></tr></tbody></table>

### Example

This example finds that `2` is in the input array, so it returns `true`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ 1, 2, 3, 4 ] contains(2)
```

#### Output

```JSON
true
```

### Example

This example indicates whether the input array contains '"3"'.

#### Source

```DataWeave
%dw 2.0
output application/json
---
ContainsRequestedItem: payload.root.*order.*items contains "3"
```

#### Input

```XML
<?xml version="1.0" encoding="UTF-8"?>
<root>
    <order>
      <items>155</items>
    </order>
    <order>
      <items>30</items>
    </order>
    <order>
      <items>15</items>
    </order>
    <order>
      <items>5</items>
    </order>
    <order>
      <items>4</items>
      <items>7</items>
    </order>
    <order>
      <items>1</items>
      <items>3</items>
    </order>
    <order>
        null
    </order>
</root>
```

#### Output

```JSON
{ "ContainsRequestedItem": true }
```

## contains(text: String, toSearch: String): Boolean

Indicates whether a string contains a given substring. Returns `true` or `false`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>An input string (a <code>String</code>).</p></td></tr><tr><td><p><code>toSearch</code></p></td><td><p>The substring (a <code>String</code>) to find in the input string.</p></td></tr></tbody></table>

### Example

This example finds "mule" in the input string "mulesoft", so it returns `true`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
"mulesoft" contains("mule")
```

#### Output

```JSON
true
```

### Example

This example finds that the substring `"me"` is in `"some string"`, so it returns `true`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ ContainsString : payload.root.mystring contains("me") }
```

#### Input

```XML
<?xml version="1.0" encoding="UTF-8"?>
<root><mystring>some string</mystring></root>
```

#### Output

```JSON
{ "ContainsString": true }
```

## contains(text: String, matcher: Regex): Boolean

Returns `true` if a string contains a match to a regular expression, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>An input string.</p></td></tr><tr><td><p><code>matcher</code></p></td><td><p>A Java regular expression for matching characters in the input <code>text</code>.</p></td></tr></tbody></table>

### Example

This example checks for any of the letters `e` through `g` in the input `mulesoft`, so it returns
`true`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
contains("mulesoft", /[e-g]/)
```

#### Output

```JSON
true
```

### Example

This example finds a match to `/s[t|p]rin/` within `"A very long string"`, so it returns `true`. The
`[t|p]` in the regex means `t` or `p`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
ContainsString: payload.root.mystring contains /s[t|p]rin/
```

#### Input

```XML
<?xml version="1.0" encoding="UTF-8"?>
<root><mystring>A very long string</mystring></root>
```

#### Output

```JSON
{ "ContainsString": true }
```

## contains(text: Null, matcher: Any): false

Helper function that enables `contains` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=3921fee7355268db19943f36787769d62b0dea207a7b12aa80f0ad754a053a00 url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-contains.md -->

---
product: DataWeave
version: 2.12
---

# contains

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## contains<T>(@StreamCapable items: Array<T>, element: Any): Boolean

Returns `true` if an input contains a given value, `false` if not.

This version of `contains` accepts an array as input. Other versions accept a string and can use
another string or regular expression to determine whether there is a match.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The input array.</p></td></tr><tr><td><p><code>elements</code></p></td><td><p>Element to find in the array. Can be any supported data type.</p></td></tr></tbody></table>

### Example

This example finds that `2` is in the input array, so it returns `true`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ 1, 2, 3, 4 ] contains(2)
```

#### Output

```JSON
true
```

### Example

This example indicates whether the input array contains '"3"'.

#### Source

```DataWeave
%dw 2.0
output application/json
---
ContainsRequestedItem: payload.root.*order.*items contains "3"
```

#### Input

```XML
<?xml version="1.0" encoding="UTF-8"?>
<root>
    <order>
      <items>155</items>
    </order>
    <order>
      <items>30</items>
    </order>
    <order>
      <items>15</items>
    </order>
    <order>
      <items>5</items>
    </order>
    <order>
      <items>4</items>
      <items>7</items>
    </order>
    <order>
      <items>1</items>
      <items>3</items>
    </order>
    <order>
        null
    </order>
</root>
```

#### Output

```JSON
{ "ContainsRequestedItem": true }
```

## contains(text: String, toSearch: String): Boolean

Indicates whether a string contains a given substring. Returns `true` or `false`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>An input string (a <code>String</code>).</p></td></tr><tr><td><p><code>toSearch</code></p></td><td><p>The substring (a <code>String</code>) to find in the input string.</p></td></tr></tbody></table>

### Example

This example finds "mule" in the input string "mulesoft", so it returns `true`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
"mulesoft" contains("mule")
```

#### Output

```JSON
true
```

### Example

This example finds that the substring `"me"` is in `"some string"`, so it returns `true`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ ContainsString : payload.root.mystring contains("me") }
```

#### Input

```XML
<?xml version="1.0" encoding="UTF-8"?>
<root><mystring>some string</mystring></root>
```

#### Output

```JSON
{ "ContainsString": true }
```

## contains(text: String, matcher: Regex): Boolean

Returns `true` if a string contains a match to a regular expression, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>An input string.</p></td></tr><tr><td><p><code>matcher</code></p></td><td><p>A Java regular expression for matching characters in the input <code>text</code>.</p></td></tr></tbody></table>

### Example

This example checks for any of the letters `e` through `g` in the input `mulesoft`, so it returns
`true`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
contains("mulesoft", /[e-g]/)
```

#### Output

```JSON
true
```

### Example

This example finds a match to `/s[t|p]rin/` within `"A very long string"`, so it returns `true`. The
`[t|p]` in the regex means `t` or `p`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
ContainsString: payload.root.mystring contains /s[t|p]rin/
```

#### Input

```XML
<?xml version="1.0" encoding="UTF-8"?>
<root><mystring>A very long string</mystring></root>
```

#### Output

```JSON
{ "ContainsString": true }
```

## contains(text: Null, matcher: Any): false

Helper function that enables `contains` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=b1d37f148821eed5d7965c7ccd717304c500cb085523922709e5daf1e0cdab6f url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-contains.md -->

---
product: DataWeave
version: 2.3
---

# contains

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## contains(Array<T>, Any): Boolean

Returns `true` if an input contains a given value, `false` if not.

This version of `contains` accepts an array as input. Other versions accept a string and can use
another string or regular expression to determine whether there is a match.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The input array.</p></td></tr><tr><td><p><code>elements</code></p></td><td><p>Element to find in the array. Can be any supported data type.</p></td></tr></tbody></table>

### Example

This example finds that `2` is in the input array, so it returns `true`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ 1, 2, 3, 4 ] contains(2)
```

#### Output

```JSON
true
```

### Example

This example indicates whether the input array contains '"3"'.

#### Source

```DataWeave
%dw 2.0
output application/json
---
ContainsRequestedItem: payload.root.*order.*items contains "3"
```

#### Input

```XML
<?xml version="1.0" encoding="UTF-8"?>
<root>
    <order>
      <items>155</items>
    </order>
    <order>
      <items>30</items>
    </order>
    <order>
      <items>15</items>
    </order>
    <order>
      <items>5</items>
    </order>
    <order>
      <items>4</items>
      <items>7</items>
    </order>
    <order>
      <items>1</items>
      <items>3</items>
    </order>
    <order>
        null
    </order>
</root>
```

#### Output

```JSON
{ "ContainsRequestedItem": true }
```

## contains(String, String): Boolean

Indicates whether a string contains a given substring. Returns `true` or `false`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>An input string (a <code>String</code>).</p></td></tr><tr><td><p><code>toSearch</code></p></td><td><p>The substring (a <code>String</code>) to find in the input string.</p></td></tr></tbody></table>

### Example

This example finds "mule" in the input string "mulesoft", so it returns `true`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
"mulesoft" contains("mule")
```

#### Output

```JSON
true
```

### Example

This example finds that the substring `"me"` is in `"some string"`, so it returns `true`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ ContainsString : payload.root.mystring contains("me") }
```

#### Input

```XML
<?xml version="1.0" encoding="UTF-8"?>
<root><mystring>some string</mystring></root>
```

#### Output

```JSON
{ "ContainsString": true }
```

## contains(String, Regex): Boolean

Returns `true` if a string contains a match to a regular expression, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>An input string.</p></td></tr><tr><td><p><code>matcher</code></p></td><td><p>A Java regular expression for matching characters in the input <code>text</code>.</p></td></tr></tbody></table>

### Example

This example checks for any of the letters `e` through `g` in the input `mulesoft`, so it returns
`true`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
contains("mulesoft", /[e-g]/)
```

#### Output

```JSON
true
```

### Example

This example finds a match to `/s[t|p]rin/` within `"A very long string"`, so it returns `true`. The
`[t|p]` in the regex means `t` or `p`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
ContainsString: payload.root.mystring contains /s[t|p]rin/
```

#### Input

```XML
<?xml version="1.0" encoding="UTF-8"?>
<root><mystring>A very long string</mystring></root>
```

#### Output

```JSON
{ "ContainsString": true }
```

<!-- document id=87d86bc9db1ef9e2c42b897fe5eb30c02cf94e49869dcdb16e1e90c4a006bd40 url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-contains.md -->

---
product: DataWeave
version: 2.4
---

# contains

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## contains<T>(@StreamCapable items: Array<T>, element: Any): Boolean

Returns `true` if an input contains a given value, `false` if not.

This version of `contains` accepts an array as input. Other versions accept a string and can use
another string or regular expression to determine whether there is a match.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The input array.</p></td></tr><tr><td><p><code>elements</code></p></td><td><p>Element to find in the array. Can be any supported data type.</p></td></tr></tbody></table>

### Example

This example finds that `2` is in the input array, so it returns `true`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ 1, 2, 3, 4 ] contains(2)
```

#### Output

```JSON
true
```

### Example

This example indicates whether the input array contains '"3"'.

#### Source

```DataWeave
%dw 2.0
output application/json
---
ContainsRequestedItem: payload.root.*order.*items contains "3"
```

#### Input

```XML
<?xml version="1.0" encoding="UTF-8"?>
<root>
    <order>
      <items>155</items>
    </order>
    <order>
      <items>30</items>
    </order>
    <order>
      <items>15</items>
    </order>
    <order>
      <items>5</items>
    </order>
    <order>
      <items>4</items>
      <items>7</items>
    </order>
    <order>
      <items>1</items>
      <items>3</items>
    </order>
    <order>
        null
    </order>
</root>
```

#### Output

```JSON
{ "ContainsRequestedItem": true }
```

## contains(text: String, toSearch: String): Boolean

Indicates whether a string contains a given substring. Returns `true` or `false`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>An input string (a <code>String</code>).</p></td></tr><tr><td><p><code>toSearch</code></p></td><td><p>The substring (a <code>String</code>) to find in the input string.</p></td></tr></tbody></table>

### Example

This example finds "mule" in the input string "mulesoft", so it returns `true`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
"mulesoft" contains("mule")
```

#### Output

```JSON
true
```

### Example

This example finds that the substring `"me"` is in `"some string"`, so it returns `true`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ ContainsString : payload.root.mystring contains("me") }
```

#### Input

```XML
<?xml version="1.0" encoding="UTF-8"?>
<root><mystring>some string</mystring></root>
```

#### Output

```JSON
{ "ContainsString": true }
```

## contains(text: String, matcher: Regex): Boolean

Returns `true` if a string contains a match to a regular expression, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>An input string.</p></td></tr><tr><td><p><code>matcher</code></p></td><td><p>A Java regular expression for matching characters in the input <code>text</code>.</p></td></tr></tbody></table>

### Example

This example checks for any of the letters `e` through `g` in the input `mulesoft`, so it returns
`true`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
contains("mulesoft", /[e-g]/)
```

#### Output

```JSON
true
```

### Example

This example finds a match to `/s[t|p]rin/` within `"A very long string"`, so it returns `true`. The
`[t|p]` in the regex means `t` or `p`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
ContainsString: payload.root.mystring contains /s[t|p]rin/
```

#### Input

```XML
<?xml version="1.0" encoding="UTF-8"?>
<root><mystring>A very long string</mystring></root>
```

#### Output

```JSON
{ "ContainsString": true }
```

## contains(text: Null, matcher: Any): false

Helper function that enables `contains` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=23c2a87b1c49813a424e18770f06ca6dbe9a31c415517a723e14aa3d27403024 url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-contains.md -->

---
product: DataWeave
version: 2.6
---

# contains

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## contains<T>(@StreamCapable items: Array<T>, element: Any): Boolean

Returns `true` if an input contains a given value, `false` if not.

This version of `contains` accepts an array as input. Other versions accept a string and can use
another string or regular expression to determine whether there is a match.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The input array.</p></td></tr><tr><td><p><code>elements</code></p></td><td><p>Element to find in the array. Can be any supported data type.</p></td></tr></tbody></table>

### Example

This example finds that `2` is in the input array, so it returns `true`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ 1, 2, 3, 4 ] contains(2)
```

#### Output

```JSON
true
```

### Example

This example indicates whether the input array contains '"3"'.

#### Source

```DataWeave
%dw 2.0
output application/json
---
ContainsRequestedItem: payload.root.*order.*items contains "3"
```

#### Input

```XML
<?xml version="1.0" encoding="UTF-8"?>
<root>
    <order>
      <items>155</items>
    </order>
    <order>
      <items>30</items>
    </order>
    <order>
      <items>15</items>
    </order>
    <order>
      <items>5</items>
    </order>
    <order>
      <items>4</items>
      <items>7</items>
    </order>
    <order>
      <items>1</items>
      <items>3</items>
    </order>
    <order>
        null
    </order>
</root>
```

#### Output

```JSON
{ "ContainsRequestedItem": true }
```

## contains(text: String, toSearch: String): Boolean

Indicates whether a string contains a given substring. Returns `true` or `false`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>An input string (a <code>String</code>).</p></td></tr><tr><td><p><code>toSearch</code></p></td><td><p>The substring (a <code>String</code>) to find in the input string.</p></td></tr></tbody></table>

### Example

This example finds "mule" in the input string "mulesoft", so it returns `true`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
"mulesoft" contains("mule")
```

#### Output

```JSON
true
```

### Example

This example finds that the substring `"me"` is in `"some string"`, so it returns `true`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ ContainsString : payload.root.mystring contains("me") }
```

#### Input

```XML
<?xml version="1.0" encoding="UTF-8"?>
<root><mystring>some string</mystring></root>
```

#### Output

```JSON
{ "ContainsString": true }
```

## contains(text: String, matcher: Regex): Boolean

Returns `true` if a string contains a match to a regular expression, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>An input string.</p></td></tr><tr><td><p><code>matcher</code></p></td><td><p>A Java regular expression for matching characters in the input <code>text</code>.</p></td></tr></tbody></table>

### Example

This example checks for any of the letters `e` through `g` in the input `mulesoft`, so it returns
`true`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
contains("mulesoft", /[e-g]/)
```

#### Output

```JSON
true
```

### Example

This example finds a match to `/s[t|p]rin/` within `"A very long string"`, so it returns `true`. The
`[t|p]` in the regex means `t` or `p`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
ContainsString: payload.root.mystring contains /s[t|p]rin/
```

#### Input

```XML
<?xml version="1.0" encoding="UTF-8"?>
<root><mystring>A very long string</mystring></root>
```

#### Output

```JSON
{ "ContainsString": true }
```

## contains(text: Null, matcher: Any): false

Helper function that enables `contains` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=8359e2ac5f14756d8ef38b6eeb3086bc0d95e0fde472df3aaedba143696e653b url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-contains.md -->

---
product: DataWeave
version: 2.9
---

# contains

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## contains<T>(@StreamCapable items: Array<T>, element: Any): Boolean

Returns `true` if an input contains a given value, `false` if not.

This version of `contains` accepts an array as input. Other versions accept a string and can use
another string or regular expression to determine whether there is a match.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The input array.</p></td></tr><tr><td><p><code>elements</code></p></td><td><p>Element to find in the array. Can be any supported data type.</p></td></tr></tbody></table>

### Example

This example finds that `2` is in the input array, so it returns `true`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ 1, 2, 3, 4 ] contains(2)
```

#### Output

```JSON
true
```

### Example

This example indicates whether the input array contains '"3"'.

#### Source

```DataWeave
%dw 2.0
output application/json
---
ContainsRequestedItem: payload.root.*order.*items contains "3"
```

#### Input

```XML
<?xml version="1.0" encoding="UTF-8"?>
<root>
    <order>
      <items>155</items>
    </order>
    <order>
      <items>30</items>
    </order>
    <order>
      <items>15</items>
    </order>
    <order>
      <items>5</items>
    </order>
    <order>
      <items>4</items>
      <items>7</items>
    </order>
    <order>
      <items>1</items>
      <items>3</items>
    </order>
    <order>
        null
    </order>
</root>
```

#### Output

```JSON
{ "ContainsRequestedItem": true }
```

## contains(text: String, toSearch: String): Boolean

Indicates whether a string contains a given substring. Returns `true` or `false`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>An input string (a <code>String</code>).</p></td></tr><tr><td><p><code>toSearch</code></p></td><td><p>The substring (a <code>String</code>) to find in the input string.</p></td></tr></tbody></table>

### Example

This example finds "mule" in the input string "mulesoft", so it returns `true`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
"mulesoft" contains("mule")
```

#### Output

```JSON
true
```

### Example

This example finds that the substring `"me"` is in `"some string"`, so it returns `true`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ ContainsString : payload.root.mystring contains("me") }
```

#### Input

```XML
<?xml version="1.0" encoding="UTF-8"?>
<root><mystring>some string</mystring></root>
```

#### Output

```JSON
{ "ContainsString": true }
```

## contains(text: String, matcher: Regex): Boolean

Returns `true` if a string contains a match to a regular expression, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>An input string.</p></td></tr><tr><td><p><code>matcher</code></p></td><td><p>A Java regular expression for matching characters in the input <code>text</code>.</p></td></tr></tbody></table>

### Example

This example checks for any of the letters `e` through `g` in the input `mulesoft`, so it returns
`true`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
contains("mulesoft", /[e-g]/)
```

#### Output

```JSON
true
```

### Example

This example finds a match to `/s[t|p]rin/` within `"A very long string"`, so it returns `true`. The
`[t|p]` in the regex means `t` or `p`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
ContainsString: payload.root.mystring contains /s[t|p]rin/
```

#### Input

```XML
<?xml version="1.0" encoding="UTF-8"?>
<root><mystring>A very long string</mystring></root>
```

#### Output

```JSON
{ "ContainsString": true }
```

## contains(text: Null, matcher: Any): false

Helper function that enables `contains` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=7baf7e0346f9ba300811b7a89d8a395379a640aeebf444e14caa3a0536cad95b url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-contains.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# contains

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## contains<T>(@StreamCapable items: Array<T>, element: Any): Boolean

Returns `true` if an input contains a given value, `false` if not.

This version of `contains` accepts an array as input. Other versions accept a string and can use
another string or regular expression to determine whether there is a match.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The input array.</p></td></tr><tr><td><p><code>elements</code></p></td><td><p>Element to find in the array. Can be any supported data type.</p></td></tr></tbody></table>

### Example

This example finds that `2` is in the input array, so it returns `true`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ 1, 2, 3, 4 ] contains(2)
```

#### Output

```JSON
true
```

### Example

This example indicates whether the input array contains '"3"'.

#### Source

```DataWeave
%dw 2.0
output application/json
---
ContainsRequestedItem: payload.root.*order.*items contains "3"
```

#### Input

```XML
<?xml version="1.0" encoding="UTF-8"?>
<root>
    <order>
      <items>155</items>
    </order>
    <order>
      <items>30</items>
    </order>
    <order>
      <items>15</items>
    </order>
    <order>
      <items>5</items>
    </order>
    <order>
      <items>4</items>
      <items>7</items>
    </order>
    <order>
      <items>1</items>
      <items>3</items>
    </order>
    <order>
        null
    </order>
</root>
```

#### Output

```JSON
{ "ContainsRequestedItem": true }
```

## contains(text: String, toSearch: String): Boolean

Indicates whether a string contains a given substring. Returns `true` or `false`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>An input string (a <code>String</code>).</p></td></tr><tr><td><p><code>toSearch</code></p></td><td><p>The substring (a <code>String</code>) to find in the input string.</p></td></tr></tbody></table>

### Example

This example finds "mule" in the input string "mulesoft", so it returns `true`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
"mulesoft" contains("mule")
```

#### Output

```JSON
true
```

### Example

This example finds that the substring `"me"` is in `"some string"`, so it returns `true`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ ContainsString : payload.root.mystring contains("me") }
```

#### Input

```XML
<?xml version="1.0" encoding="UTF-8"?>
<root><mystring>some string</mystring></root>
```

#### Output

```JSON
{ "ContainsString": true }
```

## contains(text: String, matcher: Regex): Boolean

Returns `true` if a string contains a match to a regular expression, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>An input string.</p></td></tr><tr><td><p><code>matcher</code></p></td><td><p>A Java regular expression for matching characters in the input <code>text</code>.</p></td></tr></tbody></table>

### Example

This example checks for any of the letters `e` through `g` in the input `mulesoft`, so it returns
`true`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
contains("mulesoft", /[e-g]/)
```

#### Output

```JSON
true
```

### Example

This example finds a match to `/s[t|p]rin/` within `"A very long string"`, so it returns `true`. The
`[t|p]` in the regex means `t` or `p`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
ContainsString: payload.root.mystring contains /s[t|p]rin/
```

#### Input

```XML
<?xml version="1.0" encoding="UTF-8"?>
<root><mystring>A very long string</mystring></root>
```

#### Output

```JSON
{ "ContainsString": true }
```

## contains(text: Null, matcher: Any): false

Helper function that enables `contains` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=90d43c28a227ba518b82263619abeb634dec10e873748f45ae5a80aa8533a020 url=/mulesoft/current/en-us/dataweave/2.11/dw-core.md -->

---
product: DataWeave
version: 2.11
---

# Core (dw::Core)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains core DataWeave functions for data transformations. It is automatically imported
into any DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-plusplus">++</a></p></td><td><p>Concatenates two values.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-minusminus">--</a></p></td><td><p>Removes specified values from an input value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-abs">abs</a></p></td><td><p>Returns the absolute value of a number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-avg">avg</a></p></td><td><p>Returns the average of numbers listed in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-ceil">ceil</a></p></td><td><p>Rounds a number up to the nearest whole number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-contains">contains</a></p></td><td><p>Returns <code>true</code> if an input contains a given value, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-daysbetween">daysBetween</a></p></td><td><p>Returns the number of days between two dates.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-distinctby">distinctBy</a></p></td><td><p>Iterates over the input and returns the unique elements in it.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-endswith">endsWith</a></p></td><td><p>Returns <code>true</code> if a string ends with a provided substring, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-entriesof">entriesOf</a></p></td><td><p>Returns an array of key-value pairs that describe the key, value, and any attributes in the input object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-evaluatecompatibilityflag">evaluateCompatibilityFlag</a></p></td><td><p>Returns the value of the compatibility flag with the specified name.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-filter">filter</a></p></td><td><p>Iterates over an array and applies an expression that returns matching values.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-filterobject">filterObject</a></p></td><td><p>Iterates a list of key-value pairs in an object and applies an expression that returns only matching objects, filtering out the rest from the output.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-find">find</a></p></td><td><p>Returns indices of an input that match a specified value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-flatmap">flatMap</a></p></td><td><p>Iterates over each item in an array and flattens the results.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-flatten">flatten</a></p></td><td><p>Turns a set of subarrays (such as <code>[ [1,2,3], [4,5,[6]], [], [null] ]</code>) into a single, flattened array (such as <code>[ 1, 2, 3, 4, 5, [6], null ]</code>).</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-floor">floor</a></p></td><td><p>Rounds a number down to the nearest whole number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-groupby">groupBy</a></p></td><td><p>Returns an object that groups items from an array based on specified criteria, such as an expression or matching selector.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-indexof">indexOf</a></p></td><td><p>Returns the index of the <em>first</em> occurrence of the specified element in this array, or <code>-1</code> if this list does not contain the element.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-isblank">isBlank</a></p></td><td><p>Returns <code>true</code> if the given string is empty (<code>""</code>), completely composed of whitespaces, or <code>null</code>. Otherwise, the function returns <code>false</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-isdecimal">isDecimal</a></p></td><td><p>Returns <code>true</code> if the given number contains a decimal, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-isempty">isEmpty</a></p></td><td><p>Returns <code>true</code> if the given input value is empty, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-iseven">isEven</a></p></td><td><p>Returns <code>true</code> if the number or numeric result of a mathematical operation is even, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-isinteger">isInteger</a></p></td><td><p>Returns <code>true</code> if the given number is an integer (which lacks decimals), <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-isleapyear">isLeapYear</a></p></td><td><p>Returns <code>true</code> if it receives a date for a leap year, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-isodd">isOdd</a></p></td><td><p>Returns <code>true</code> if the number or numeric result of a mathematical operation is odd, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-joinby">joinBy</a></p></td><td><p>Merges an array into a single string value and uses the provided string as a separator between each item in the list.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-keysof">keysOf</a></p></td><td><p>Returns an array of keys from key-value pairs within the input object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-lastindexof">lastIndexOf</a></p></td><td><p>Returns the index of the <em>last</em> occurrence of the specified element in a given array or <code>-1</code> if the array does not contain the element.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-log">log</a></p></td><td><p>Without changing the value of the input, <code>log</code> returns the input as a system log. So this makes it very simple to debug your code, because any expression or subexpression can be wrapped with <strong>log</strong> and the result will be printed out without modifying the result of the expression. The output is going to be printed in application/dw format.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-logdebug">logDebug</a></p></td><td><p>Helper function that logs messages at <code>Debug</code> level.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-logerror">logError</a></p></td><td><p>Helper function that logs messages at <code>Error</code> level.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-loginfo">logInfo</a></p></td><td><p>Helper function that logs messages at <code>Info</code> level.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-logwarn">logWarn</a></p></td><td><p>Helper function that logs messages at <code>Warn</code> level.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-logwith">logWith</a></p></td><td><p>Without changing the value of the input, <code>logWith</code> returns the input as a system log at the specified level. This makes it simple to debug your code, because any expression or subexpression can be wrapped with <strong>log</strong> and the result is printed out without modifying the result of the expression. The output is printed in application/dw format.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-lower">lower</a></p></td><td><p>Returns the provided string in lowercase characters.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-map">map</a></p></td><td><p>Iterates over items in an array and outputs the results into a new array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-mapobject">mapObject</a></p></td><td><p>Iterates over an object using a mapper that acts on keys, values, or indices of that object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-match">match</a></p></td><td><p>Uses a Java regular expression (regex) to match a string and then separates it into capture groups. Returns the results in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-matches">matches</a></p></td><td><p>Checks if an expression matches the entire input string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-max">max</a></p></td><td><p>Returns the highest <code>Comparable</code> value in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-maxby">maxBy</a></p></td><td><p>Iterates over an array and returns the highest value of <code>Comparable</code> elements from it.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-min">min</a></p></td><td><p>Returns the lowest <code>Comparable</code> value in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-minby">minBy</a></p></td><td><p>Iterates over an array to return the lowest value of comparable elements from it.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-mod">mod</a></p></td><td><p>Returns the modulo (the remainder after dividing the <code>dividend</code> by the <code>divisor</code>).</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-namesof">namesOf</a></p></td><td><p>Returns an array of strings with the names of all the keys within the given object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-now">now</a></p></td><td><p>Returns a <code>DateTime</code> value for the current date and time.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-onnull">onNull</a></p></td><td><p>Executes a callback function if the preceding expression returns a <code>null</code> value and then replaces the <code>null</code> value with the result of the callback.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-orderby">orderBy</a></p></td><td><p>Reorders the elements of an input using criteria that acts on selected elements of that input.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-pluck">pluck</a></p></td><td><p>Useful for mapping an object into an array, <code>pluck</code> iterates over an object and returns an array of keys, values, or indices from the object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-pow">pow</a></p></td><td><p>Raises the value of a <code>base</code> number to the specified <code>power</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-random">random</a></p></td><td><p>Returns a pseudo-random number greater than or equal to <code>0.0</code> and less than <code>1.0</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-randomint">randomInt</a></p></td><td><p>Returns a pseudo-random whole number from <code>0</code> to the specified number (exclusive).</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-read">read</a></p></td><td><p>Reads a string or binary and returns parsed content.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-readurl">readUrl</a></p></td><td><p>Reads a URL, including a classpath-based URL, and returns parsed content. This function works similar to the <code>read</code> function.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-reduce">reduce</a></p></td><td><p>Applies a reduction expression to the elements in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-replace">replace</a></p></td><td><p>Performs string replacement.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-round">round</a></p></td><td><p>Rounds a number up or down to the nearest whole number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-scan">scan</a></p></td><td><p>Returns an array with all of the matches found in an input string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-sizeof">sizeOf</a></p></td><td><p>Returns the number of elements in an array. It returns <code>0</code> if the array is empty.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-splitby">splitBy</a></p></td><td><p>Splits a string into a string array based on a value that matches part of that string. It filters out the matching part from the returned array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-sqrt">sqrt</a></p></td><td><p>Returns the square root of a number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-startswith">startsWith</a></p></td><td><p>Returns <code>true</code> or <code>false</code> depending on whether the input string starts with a matching prefix.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-sum">sum</a></p></td><td><p>Returns the sum of numeric values in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-then">then</a></p></td><td><p>This function works as a pipe that passes the value returned from the preceding expression to the next (a callback) only if the value returned by the preceding expression is not <code>null</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-to">to</a></p></td><td><p>Returns a range with the specified boundaries.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-trim">trim</a></p></td><td><p>Removes any blank spaces from the beginning and end of a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-typeof">typeOf</a></p></td><td><p>Returns the primitive data type of a value, such as <code>String</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-unzip">unzip</a></p></td><td><p>Performs the opposite of <code>zip</code>. It takes an array of arrays as input.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-upper">upper</a></p></td><td><p>Returns the provided string in uppercase characters.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-uuid">uuid</a></p></td><td><p>Returns a v4 UUID using random numbers as the source.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-valuesof">valuesOf</a></p></td><td><p>Returns an array of the values from key-value pairs in an object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-with">with</a></p></td><td><p>Helper function that specifies a replacement element. This function is used with <code>replace</code>, <code>update</code> or <code>mask</code> to perform data substitutions.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-write">write</a></p></td><td><p>Writes a value as a string or binary in a supported format.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-xsitype">xsiType</a></p></td><td><p>Creates a <code>xsi:type</code> type attribute. This method returns an object, so it must be used with dynamic attributes.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-zip">zip</a></p></td><td><p>Merges elements from two arrays into an array of arrays.</p></td></tr></tbody></table>

## Types

- [Core Types](https://docs.mulesoft.com/dataweave/2.11/dw-core-types)

## Namespaces

- [Core Namespaces](https://docs.mulesoft.com/dataweave/2.11/dw-core-namespaces)

## Annotations

- [Core Annotations](https://docs.mulesoft.com/dataweave/2.11/dw-core-annotations)

<!-- document id=e91c5443e081ef97c56417a5ce37948a5bac99e0f1161dfe01ad099a29dbfa69 url=/mulesoft/current/en-us/dataweave/2.12/dw-core.md -->

---
product: DataWeave
version: 2.12
---

# Core (dw::Core)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains core DataWeave functions for data transformations. It is automatically imported
into any DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-plusplus">++</a></p></td><td><p>Concatenates two values.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-minusminus">--</a></p></td><td><p>Removes specified values from an input value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-abs">abs</a></p></td><td><p>Returns the absolute value of a number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-avg">avg</a></p></td><td><p>Returns the average of numbers listed in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-ceil">ceil</a></p></td><td><p>Rounds a number up to the nearest whole number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-contains">contains</a></p></td><td><p>Returns <code>true</code> if an input contains a given value, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-daysbetween">daysBetween</a></p></td><td><p>Returns the number of days between two dates.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-distinctby">distinctBy</a></p></td><td><p>Iterates over the input and returns the unique elements in it.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-endswith">endsWith</a></p></td><td><p>Returns <code>true</code> if a string ends with a provided substring, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-entriesof">entriesOf</a></p></td><td><p>Returns an array of key-value pairs that describe the key, value, and any attributes in the input object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-evaluatecompatibilityflag">evaluateCompatibilityFlag</a></p></td><td><p>Returns the value of the compatibility flag with the specified name.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-filter">filter</a></p></td><td><p>Iterates over an array and applies an expression that returns matching values.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-filterobject">filterObject</a></p></td><td><p>Iterates a list of key-value pairs in an object and applies an expression that returns only matching objects, filtering out the rest from the output.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-find">find</a></p></td><td><p>Returns indices of an input that match a specified value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-flatmap">flatMap</a></p></td><td><p>Iterates over each item in an array and flattens the results.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-flatten">flatten</a></p></td><td><p>Turns a set of subarrays (such as <code>[ [1,2,3], [4,5,[6]], [], [null] ]</code>) into a single, flattened array (such as <code>[ 1, 2, 3, 4, 5, [6], null ]</code>).</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-floor">floor</a></p></td><td><p>Rounds a number down to the nearest whole number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-groupby">groupBy</a></p></td><td><p>Returns an object that groups items from an array based on specified criteria, such as an expression or matching selector.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-indexof">indexOf</a></p></td><td><p>Returns the index of the <em>first</em> occurrence of the specified element in this array, or <code>-1</code> if this list does not contain the element.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-isblank">isBlank</a></p></td><td><p>Returns <code>true</code> if the given string is empty (<code>""</code>), completely composed of whitespaces, or <code>null</code>. Otherwise, the function returns <code>false</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-isdecimal">isDecimal</a></p></td><td><p>Returns <code>true</code> if the given number contains a decimal, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-isempty">isEmpty</a></p></td><td><p>Returns <code>true</code> if the given input value is empty, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-iseven">isEven</a></p></td><td><p>Returns <code>true</code> if the number or numeric result of a mathematical operation is even, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-isinteger">isInteger</a></p></td><td><p>Returns <code>true</code> if the given number is an integer (which lacks decimals), <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-isleapyear">isLeapYear</a></p></td><td><p>Returns <code>true</code> if it receives a date for a leap year, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-isodd">isOdd</a></p></td><td><p>Returns <code>true</code> if the number or numeric result of a mathematical operation is odd, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-joinby">joinBy</a></p></td><td><p>Merges an array into a single string value and uses the provided string as a separator between each item in the list.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-keysof">keysOf</a></p></td><td><p>Returns an array of keys from key-value pairs within the input object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-lastindexof">lastIndexOf</a></p></td><td><p>Returns the index of the <em>last</em> occurrence of the specified element in a given array or <code>-1</code> if the array does not contain the element.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-log">log</a></p></td><td><p>Without changing the value of the input, <code>log</code> returns the input as a system log. So this makes it very simple to debug your code, because any expression or subexpression can be wrapped with <strong>log</strong> and the result will be printed out without modifying the result of the expression. The output is going to be printed in application/dw format.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-logdebug">logDebug</a></p></td><td><p>Helper function that logs messages at <code>Debug</code> level.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-logerror">logError</a></p></td><td><p>Helper function that logs messages at <code>Error</code> level.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-loginfo">logInfo</a></p></td><td><p>Helper function that logs messages at <code>Info</code> level.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-logwarn">logWarn</a></p></td><td><p>Helper function that logs messages at <code>Warn</code> level.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-logwith">logWith</a></p></td><td><p>Without changing the value of the input, <code>logWith</code> returns the input as a system log at the specified level. This makes it simple to debug your code, because any expression or subexpression can be wrapped with <strong>log</strong> and the result is printed out without modifying the result of the expression. The output is printed in application/dw format.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-lower">lower</a></p></td><td><p>Returns the provided string in lowercase characters.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-map">map</a></p></td><td><p>Iterates over items in an array and outputs the results into a new array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-mapobject">mapObject</a></p></td><td><p>Iterates over an object using a mapper that acts on keys, values, or indices of that object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-match">match</a></p></td><td><p>Uses a Java regular expression (regex) to match a string and then separates it into capture groups. Returns the results in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-matches">matches</a></p></td><td><p>Checks if an expression matches the entire input string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-max">max</a></p></td><td><p>Returns the highest <code>Comparable</code> value in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-maxby">maxBy</a></p></td><td><p>Iterates over an array and returns the highest value of <code>Comparable</code> elements from it.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-min">min</a></p></td><td><p>Returns the lowest <code>Comparable</code> value in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-minby">minBy</a></p></td><td><p>Iterates over an array to return the lowest value of comparable elements from it.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-mod">mod</a></p></td><td><p>Returns the modulo (the remainder after dividing the <code>dividend</code> by the <code>divisor</code>).</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-namesof">namesOf</a></p></td><td><p>Returns an array of strings with the names of all the keys within the given object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-now">now</a></p></td><td><p>Returns a <code>DateTime</code> value for the current date and time.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-onnull">onNull</a></p></td><td><p>Executes a callback function if the preceding expression returns a <code>null</code> value and then replaces the <code>null</code> value with the result of the callback.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-orderby">orderBy</a></p></td><td><p>Reorders the elements of an input using criteria that acts on selected elements of that input.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-pluck">pluck</a></p></td><td><p>Useful for mapping an object into an array, <code>pluck</code> iterates over an object and returns an array of keys, values, or indices from the object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-pow">pow</a></p></td><td><p>Raises the value of a <code>base</code> number to the specified <code>power</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-random">random</a></p></td><td><p>Returns a pseudo-random number greater than or equal to <code>0.0</code> and less than <code>1.0</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-randomint">randomInt</a></p></td><td><p>Returns a pseudo-random whole number from <code>0</code> to the specified number (exclusive).</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-read">read</a></p></td><td><p>Reads a string or binary and returns parsed content.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-readurl">readUrl</a></p></td><td><p>Reads a URL, including a classpath-based URL, and returns parsed content. This function works similar to the <code>read</code> function.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-reduce">reduce</a></p></td><td><p>Applies a reduction expression to the elements in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-replace">replace</a></p></td><td><p>Performs string replacement.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-round">round</a></p></td><td><p>Rounds a number up or down to the nearest whole number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-scan">scan</a></p></td><td><p>Returns an array with all of the matches found in an input string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-sizeof">sizeOf</a></p></td><td><p>Returns the number of elements in an array. It returns <code>0</code> if the array is empty.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-splitby">splitBy</a></p></td><td><p>Splits a string into a string array based on a value that matches part of that string. It filters out the matching part from the returned array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-sqrt">sqrt</a></p></td><td><p>Returns the square root of a number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-startswith">startsWith</a></p></td><td><p>Returns <code>true</code> or <code>false</code> depending on whether the input string starts with a matching prefix.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-sum">sum</a></p></td><td><p>Returns the sum of numeric values in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-then">then</a></p></td><td><p>This function works as a pipe that passes the value returned from the preceding expression to the next (a callback) only if the value returned by the preceding expression is not <code>null</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-to">to</a></p></td><td><p>Returns a range with the specified boundaries.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-trim">trim</a></p></td><td><p>Removes any blank spaces from the beginning and end of a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-typeof">typeOf</a></p></td><td><p>Returns the primitive data type of a value, such as <code>String</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-unzip">unzip</a></p></td><td><p>Performs the opposite of <code>zip</code>. It takes an array of arrays as input.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-upper">upper</a></p></td><td><p>Returns the provided string in uppercase characters.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-uuid">uuid</a></p></td><td><p>Returns a v4 UUID using random numbers as the source.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-valuesof">valuesOf</a></p></td><td><p>Returns an array of the values from key-value pairs in an object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-with">with</a></p></td><td><p>Helper function that specifies a replacement element. This function is used with <code>replace</code>, <code>update</code> or <code>mask</code> to perform data substitutions.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-write">write</a></p></td><td><p>Writes a value as a string or binary in a supported format.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-xsitype">xsiType</a></p></td><td><p>Creates a <code>xsi:type</code> type attribute. This method returns an object, so it must be used with dynamic attributes.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-zip">zip</a></p></td><td><p>Merges elements from two arrays into an array of arrays.</p></td></tr></tbody></table>

## Types

- [Core Types](https://docs.mulesoft.com/dataweave/2.12/dw-core-types)

## Namespaces

- [Core Namespaces](https://docs.mulesoft.com/dataweave/2.12/dw-core-namespaces)

## Annotations

- [Core Annotations](https://docs.mulesoft.com/dataweave/2.12/dw-core-annotations)

<!-- document id=a940b91adbbbc7216d5bee1b95e0ab2dc374327738ec485757f6a6710d1302e0 url=/mulesoft/current/en-us/dataweave/2.3/dw-core.md -->

---
product: DataWeave
version: 2.3
---

# Core (dw::Core)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains core DataWeave functions for data transformations. It is automatically imported
into any DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-plusplus">++</a></p></td><td><p>Concatenates two values.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-minusminus">--</a></p></td><td><p>Removes specified values from an input value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-abs">abs</a></p></td><td><p>Returns the absolute value of a number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-avg">avg</a></p></td><td><p>Returns the average of numbers listed in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-ceil">ceil</a></p></td><td><p>Rounds a number up to the nearest whole number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-contains">contains</a></p></td><td><p>Returns <code>true</code> if an input contains a given value, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-daysbetween">daysBetween</a></p></td><td><p>Returns the number of days between two dates.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-distinctby">distinctBy</a></p></td><td><p>Iterates over an array and returns the unique elements in it.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-endswith">endsWith</a></p></td><td><p>Returns <code>true</code> if a string ends with a provided substring, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-entriesof">entriesOf</a></p></td><td><p>Returns an array of key-value pairs that describe the key, value, and any attributes in the input object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-filter">filter</a></p></td><td><p>Iterates over an array and applies an expression that returns matching values.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-filterobject">filterObject</a></p></td><td><p>Iterates a list of key-value pairs in an object and applies an expression that returns only matching objects, filtering out the rest from the output.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-find">find</a></p></td><td><p>Returns indices of an input that match a specified value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-flatmap">flatMap</a></p></td><td><p>Iterates over each item in an array and flattens the results.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-flatten">flatten</a></p></td><td><p>Turns a set of subarrays (such as [ <code>[1,2,3], [4,5,[6]], [], [null] ]</code>) into a single, flattened array (such as <code>[ 1, 2, 3, 4, 5, [6], null ]</code>).</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-floor">floor</a></p></td><td><p>Rounds a number down to the nearest whole number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-groupby">groupBy</a></p></td><td><p>Returns an object that groups items from an array based on specified criteria, such as an expression or matching selector.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-isblank">isBlank</a></p></td><td><p>Returns <code>true</code> if the given string is empty or completely composed of whitespace, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-isdecimal">isDecimal</a></p></td><td><p>Returns <code>true</code> if the given number contains a decimal, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-isempty">isEmpty</a></p></td><td><p>Returns <code>true</code> if the given input value is empty, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-iseven">isEven</a></p></td><td><p>Returns <code>true</code> if the number or numeric result of a mathematical operation is even, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-isinteger">isInteger</a></p></td><td><p>Returns <code>true</code> if the given number is an integer (which lacks decimals), <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-isleapyear">isLeapYear</a></p></td><td><p>Returns <code>true</code> if it receives a date for a leap year, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-isodd">isOdd</a></p></td><td><p>Returns <code>true</code> if the number or numeric result of a mathematical operation is odd, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-joinby">joinBy</a></p></td><td><p>Merges an array into a single string value and uses the provided string as a separator between each item in the list.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-keysof">keysOf</a></p></td><td><p>Returns an array of keys from key-value pairs within the input object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-log">log</a></p></td><td><p>Without changing the value of the input, <code>log</code> returns the input as a system log.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-lower">lower</a></p></td><td><p>Returns the provided string in lowercase characters.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-map">map</a></p></td><td><p>Iterates over items in an array and outputs the results into a new array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-mapobject">mapObject</a></p></td><td><p>Iterates over an object using a mapper that acts on keys, values, or indices of that object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-match">match</a></p></td><td><p>Uses a Java regular expression (regex) to match a string and then separates it into capture groups. Returns the results in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-matches">matches</a></p></td><td><p>Checks if an expression matches the entire input string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-max">max</a></p></td><td><p>Returns the highest <code>Comparable</code> value in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-maxby">maxBy</a></p></td><td><p>Iterates over an array and returns the highest value of <code>Comparable</code> elements from it.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-min">min</a></p></td><td><p>Returns the lowest <code>Comparable</code> value in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-minby">minBy</a></p></td><td><p>Iterates over an array to return the lowest value of comparable elements from it.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-mod">mod</a></p></td><td><p>Returns the modulo (the remainder after dividing the <code>dividend</code> by the <code>divisor</code>).</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-namesof">namesOf</a></p></td><td><p>Returns an array of strings with the names of all the keys within the given object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-native">native</a></p></td><td><p>Internal method used to indicate that a function implementation is not written in DataWeave but in Scala.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-now">now</a></p></td><td><p>Returns a <code>DateTime</code> value for the current date and time.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-orderby">orderBy</a></p></td><td><p>Reorders the elements of an input using criteria that acts on selected elements of that input.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-pluck">pluck</a></p></td><td><p>Useful for mapping an object into an array, <code>pluck</code> iterates over an object and returns an array of keys, values, or indices from the object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-pow">pow</a></p></td><td><p>Raises the value of a <code>base</code> number to the specified <code>power</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-random">random</a></p></td><td><p>Returns a pseudo-random number greater than or equal to <code>0.0</code> and less than <code>1.0</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-randomint">randomInt</a></p></td><td><p>Returns a pseudo-random whole number from <code>0</code> to the specified number (exclusive).</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-read">read</a></p></td><td><p>Reads a string or binary and returns parsed content.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-readurl">readUrl</a></p></td><td><p>Similar to the <code>read</code> function. However, <code>readURL</code> accepts a URL, including a classpath-based URL.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-reduce">reduce</a></p></td><td><p>Applies a reduction expression to the elements in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-replace">replace</a></p></td><td><p>Performs string replacement.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-round">round</a></p></td><td><p>Rounds a number up or down to the nearest whole number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-scan">scan</a></p></td><td><p>Returns an array with all of the matches found in an input string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-sizeof">sizeOf</a></p></td><td><p>Returns the number of elements in an array. It returns <code>0</code> if the array is empty.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-splitby">splitBy</a></p></td><td><p>Splits a string into a string array based on a value that matches part of that string. It filters out the matching part from the returned array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-sqrt">sqrt</a></p></td><td><p>Returns the square root of a number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-startswith">startsWith</a></p></td><td><p>Returns <code>true</code> or <code>false</code> depending on whether the input string starts with a matching prefix.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-sum">sum</a></p></td><td><p>Returns the sum of numeric values in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-to">to</a></p></td><td><p>Returns a range with the specified boundaries.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-trim">trim</a></p></td><td><p>Removes any blank spaces from the beginning and end of a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-typeof">typeOf</a></p></td><td><p>Returns the type of a value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-unzip">unzip</a></p></td><td><p>Performs the opposite of <code>zip</code>. It takes an array of arrays as input.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-upper">upper</a></p></td><td><p>Returns the provided string in uppercase characters.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-uuid">uuid</a></p></td><td><p>Returns a v4 UUID using random numbers as the source.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-valuesof">valuesOf</a></p></td><td><p>Returns an array of the values from key-value pairs in an object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-with">with</a></p></td><td><p>When used with <code>replace</code>, <code>with</code> passes a replacement string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-write">write</a></p></td><td><p>Writes a value as a string or binary in a supported format.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-xsitype">xsiType</a></p></td><td><p>Creates a <code>xsi:type</code> type attribute. This method returns an object, so it must be used with dynamic attributes.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-zip">zip</a></p></td><td><p>Merges elements from two arrays into an array of arrays.</p></td></tr></tbody></table>

## Types

- [Core Types](https://docs.mulesoft.com/dataweave/2.3/dw-core-types)

## Namespaces

- [Core Namespaces](https://docs.mulesoft.com/dataweave/2.3/dw-core-namespaces)

## Annotations

- [Core Annotations](https://docs.mulesoft.com/dataweave/2.3/dw-core-annotations)

<!-- document id=6f68f1ec859af971dfa915b4c3ffa725777d8966ce7775245406ee2484a7536d url=/mulesoft/current/en-us/dataweave/2.4/dw-core.md -->

---
product: DataWeave
version: 2.4
---

# Core (dw::Core)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains core DataWeave functions for data transformations. It is automatically imported
into any DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-plusplus">++</a></p></td><td><p>Concatenates two values.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-minusminus">--</a></p></td><td><p>Removes specified values from an input value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-abs">abs</a></p></td><td><p>Returns the absolute value of a number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-avg">avg</a></p></td><td><p>Returns the average of numbers listed in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-ceil">ceil</a></p></td><td><p>Rounds a number up to the nearest whole number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-contains">contains</a></p></td><td><p>Returns <code>true</code> if an input contains a given value, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-daysbetween">daysBetween</a></p></td><td><p>Returns the number of days between two dates.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-distinctby">distinctBy</a></p></td><td><p>Iterates over the input and returns the unique elements in it.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-endswith">endsWith</a></p></td><td><p>Returns <code>true</code> if a string ends with a provided substring, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-entriesof">entriesOf</a></p></td><td><p>Returns an array of key-value pairs that describe the key, value, and any attributes in the input object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-filter">filter</a></p></td><td><p>Iterates over an array and applies an expression that returns matching values.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-filterobject">filterObject</a></p></td><td><p>Iterates a list of key-value pairs in an object and applies an expression that returns only matching objects, filtering out the rest from the output.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-find">find</a></p></td><td><p>Returns indices of an input that match a specified value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-flatmap">flatMap</a></p></td><td><p>Iterates over each item in an array and flattens the results.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-flatten">flatten</a></p></td><td><p>Turns a set of subarrays (such as <code>[ [1,2,3], [4,5,[6]], [], [null] ]</code>) into a single, flattened array (such as <code>[ 1, 2, 3, 4, 5, [6], null ]</code>).</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-floor">floor</a></p></td><td><p>Rounds a number down to the nearest whole number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-groupby">groupBy</a></p></td><td><p>Returns an object that groups items from an array based on specified criteria, such as an expression or matching selector.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-indexof">indexOf</a></p></td><td><p>Returns the index of the <em>first</em> occurrence of the specified element in this array, or <code>-1</code> if this list does not contain the element.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-isblank">isBlank</a></p></td><td><p>Returns <code>true</code> if the given string is empty (<code>""</code>), completely composed of whitespaces, or <code>null</code>. Otherwise, the function returns <code>false</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-isdecimal">isDecimal</a></p></td><td><p>Returns <code>true</code> if the given number contains a decimal, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-isempty">isEmpty</a></p></td><td><p>Returns <code>true</code> if the given input value is empty, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-iseven">isEven</a></p></td><td><p>Returns <code>true</code> if the number or numeric result of a mathematical operation is even, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-isinteger">isInteger</a></p></td><td><p>Returns <code>true</code> if the given number is an integer (which lacks decimals), <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-isleapyear">isLeapYear</a></p></td><td><p>Returns <code>true</code> if it receives a date for a leap year, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-isodd">isOdd</a></p></td><td><p>Returns <code>true</code> if the number or numeric result of a mathematical operation is odd, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-joinby">joinBy</a></p></td><td><p>Merges an array into a single string value and uses the provided string as a separator between each item in the list.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-keysof">keysOf</a></p></td><td><p>Returns an array of keys from key-value pairs within the input object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-lastindexof">lastIndexOf</a></p></td><td><p>Returns the index of the <em>last</em> occurrence of the specified element in a given array or <code>-1</code> if the array does not contain the element.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-log">log</a></p></td><td><p>Without changing the value of the input, <code>log</code> returns the input as a system log. So this makes it very simple to debug your code, because any expression or subexpression can be wrapped with <strong>log</strong> and the result will be printed out without modifying the result of the expression. The output is going to be printed in application/dw format.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-lower">lower</a></p></td><td><p>Returns the provided string in lowercase characters.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-map">map</a></p></td><td><p>Iterates over items in an array and outputs the results into a new array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-mapobject">mapObject</a></p></td><td><p>Iterates over an object using a mapper that acts on keys, values, or indices of that object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-match">match</a></p></td><td><p>Uses a Java regular expression (regex) to match a string and then separates it into capture groups. Returns the results in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-matches">matches</a></p></td><td><p>Checks if an expression matches the entire input string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-max">max</a></p></td><td><p>Returns the highest <code>Comparable</code> value in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-maxby">maxBy</a></p></td><td><p>Iterates over an array and returns the highest value of <code>Comparable</code> elements from it.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-min">min</a></p></td><td><p>Returns the lowest <code>Comparable</code> value in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-minby">minBy</a></p></td><td><p>Iterates over an array to return the lowest value of comparable elements from it.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-mod">mod</a></p></td><td><p>Returns the modulo (the remainder after dividing the <code>dividend</code> by the <code>divisor</code>).</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-namesof">namesOf</a></p></td><td><p>Returns an array of strings with the names of all the keys within the given object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-now">now</a></p></td><td><p>Returns a <code>DateTime</code> value for the current date and time.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-onnull">onNull</a></p></td><td><p>Executes a callback function if the preceding expression returns a <code>null</code> value and then replaces the <code>null</code> value with the result of the callback.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-orderby">orderBy</a></p></td><td><p>Reorders the elements of an input using criteria that acts on selected elements of that input.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-pluck">pluck</a></p></td><td><p>Useful for mapping an object into an array, <code>pluck</code> iterates over an object and returns an array of keys, values, or indices from the object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-pow">pow</a></p></td><td><p>Raises the value of a <code>base</code> number to the specified <code>power</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-random">random</a></p></td><td><p>Returns a pseudo-random number greater than or equal to <code>0.0</code> and less than <code>1.0</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-randomint">randomInt</a></p></td><td><p>Returns a pseudo-random whole number from <code>0</code> to the specified number (exclusive).</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-read">read</a></p></td><td><p>Reads a string or binary and returns parsed content.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-readurl">readUrl</a></p></td><td><p>Reads a URL, including a classpath-based URL, and returns parsed content. This function works similar to the <code>read</code> function.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-reduce">reduce</a></p></td><td><p>Applies a reduction expression to the elements in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-replace">replace</a></p></td><td><p>Performs string replacement.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-round">round</a></p></td><td><p>Rounds a number up or down to the nearest whole number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-scan">scan</a></p></td><td><p>Returns an array with all of the matches found in an input string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-sizeof">sizeOf</a></p></td><td><p>Returns the number of elements in an array. It returns <code>0</code> if the array is empty.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-splitby">splitBy</a></p></td><td><p>Splits a string into a string array based on a value that matches part of that string. It filters out the matching part from the returned array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-sqrt">sqrt</a></p></td><td><p>Returns the square root of a number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-startswith">startsWith</a></p></td><td><p>Returns <code>true</code> or <code>false</code> depending on whether the input string starts with a matching prefix.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-sum">sum</a></p></td><td><p>Returns the sum of numeric values in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-then">then</a></p></td><td><p>This function works as a pipe that passes the value returned from the preceding expression to the next (a callback) only if the value returned by the preceding expression is not <code>null</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-to">to</a></p></td><td><p>Returns a range with the specified boundaries.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-trim">trim</a></p></td><td><p>Removes any blank spaces from the beginning and end of a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-typeof">typeOf</a></p></td><td><p>Returns the type of a value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-unzip">unzip</a></p></td><td><p>Performs the opposite of <code>zip</code>. It takes an array of arrays as input.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-upper">upper</a></p></td><td><p>Returns the provided string in uppercase characters.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-uuid">uuid</a></p></td><td><p>Returns a v4 UUID using random numbers as the source.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-valuesof">valuesOf</a></p></td><td><p>Returns an array of the values from key-value pairs in an object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-with">with</a></p></td><td><p>Helper function that specifies a replacement element. This function is used with <code>replace</code>, <code>update</code> or <code>mask</code> to perform data substitutions.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-write">write</a></p></td><td><p>Writes a value as a string or binary in a supported format.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-xsitype">xsiType</a></p></td><td><p>Creates a <code>xsi:type</code> type attribute. This method returns an object, so it must be used with dynamic attributes.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-zip">zip</a></p></td><td><p>Merges elements from two arrays into an array of arrays.</p></td></tr></tbody></table>

## Types

- [Core Types](https://docs.mulesoft.com/dataweave/2.4/dw-core-types)

## Namespaces

- [Core Namespaces](https://docs.mulesoft.com/dataweave/2.4/dw-core-namespaces)

## Annotations

- [Core Annotations](https://docs.mulesoft.com/dataweave/2.4/dw-core-annotations)

<!-- document id=6110fb7ba319300e52df760582d0e685ae3e8c9260e2a0d73bff20516177355d url=/mulesoft/current/en-us/dataweave/2.6/dw-core.md -->

---
product: DataWeave
version: 2.6
---

# Core (dw::Core)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains core DataWeave functions for data transformations. It is automatically imported
into any DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-plusplus">++</a></p></td><td><p>Concatenates two values.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-minusminus">--</a></p></td><td><p>Removes specified values from an input value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-abs">abs</a></p></td><td><p>Returns the absolute value of a number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-avg">avg</a></p></td><td><p>Returns the average of numbers listed in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-ceil">ceil</a></p></td><td><p>Rounds a number up to the nearest whole number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-contains">contains</a></p></td><td><p>Returns <code>true</code> if an input contains a given value, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-daysbetween">daysBetween</a></p></td><td><p>Returns the number of days between two dates.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-distinctby">distinctBy</a></p></td><td><p>Iterates over the input and returns the unique elements in it.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-endswith">endsWith</a></p></td><td><p>Returns <code>true</code> if a string ends with a provided substring, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-entriesof">entriesOf</a></p></td><td><p>Returns an array of key-value pairs that describe the key, value, and any attributes in the input object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-evaluatecompatibilityflag">evaluateCompatibilityFlag</a></p></td><td><p>Returns the value of the compatibility flag with the specified name.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-filter">filter</a></p></td><td><p>Iterates over an array and applies an expression that returns matching values.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-filterobject">filterObject</a></p></td><td><p>Iterates a list of key-value pairs in an object and applies an expression that returns only matching objects, filtering out the rest from the output.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-find">find</a></p></td><td><p>Returns indices of an input that match a specified value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-flatmap">flatMap</a></p></td><td><p>Iterates over each item in an array and flattens the results.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-flatten">flatten</a></p></td><td><p>Turns a set of subarrays (such as <code>[ [1,2,3], [4,5,[6]], [], [null] ]</code>) into a single, flattened array (such as <code>[ 1, 2, 3, 4, 5, [6], null ]</code>).</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-floor">floor</a></p></td><td><p>Rounds a number down to the nearest whole number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-groupby">groupBy</a></p></td><td><p>Returns an object that groups items from an array based on specified criteria, such as an expression or matching selector.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-indexof">indexOf</a></p></td><td><p>Returns the index of the <em>first</em> occurrence of the specified element in this array, or <code>-1</code> if this list does not contain the element.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-isblank">isBlank</a></p></td><td><p>Returns <code>true</code> if the given string is empty (<code>""</code>), completely composed of whitespaces, or <code>null</code>. Otherwise, the function returns <code>false</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-isdecimal">isDecimal</a></p></td><td><p>Returns <code>true</code> if the given number contains a decimal, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-isempty">isEmpty</a></p></td><td><p>Returns <code>true</code> if the given input value is empty, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-iseven">isEven</a></p></td><td><p>Returns <code>true</code> if the number or numeric result of a mathematical operation is even, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-isinteger">isInteger</a></p></td><td><p>Returns <code>true</code> if the given number is an integer (which lacks decimals), <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-isleapyear">isLeapYear</a></p></td><td><p>Returns <code>true</code> if it receives a date for a leap year, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-isodd">isOdd</a></p></td><td><p>Returns <code>true</code> if the number or numeric result of a mathematical operation is odd, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-joinby">joinBy</a></p></td><td><p>Merges an array into a single string value and uses the provided string as a separator between each item in the list.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-keysof">keysOf</a></p></td><td><p>Returns an array of keys from key-value pairs within the input object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-lastindexof">lastIndexOf</a></p></td><td><p>Returns the index of the <em>last</em> occurrence of the specified element in a given array or <code>-1</code> if the array does not contain the element.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-log">log</a></p></td><td><p>Without changing the value of the input, <code>log</code> returns the input as a system log. So this makes it very simple to debug your code, because any expression or subexpression can be wrapped with <strong>log</strong> and the result will be printed out without modifying the result of the expression. The output is going to be printed in application/dw format.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-lower">lower</a></p></td><td><p>Returns the provided string in lowercase characters.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-map">map</a></p></td><td><p>Iterates over items in an array and outputs the results into a new array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-mapobject">mapObject</a></p></td><td><p>Iterates over an object using a mapper that acts on keys, values, or indices of that object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-match">match</a></p></td><td><p>Uses a Java regular expression (regex) to match a string and then separates it into capture groups. Returns the results in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-matches">matches</a></p></td><td><p>Checks if an expression matches the entire input string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-max">max</a></p></td><td><p>Returns the highest <code>Comparable</code> value in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-maxby">maxBy</a></p></td><td><p>Iterates over an array and returns the highest value of <code>Comparable</code> elements from it.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-min">min</a></p></td><td><p>Returns the lowest <code>Comparable</code> value in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-minby">minBy</a></p></td><td><p>Iterates over an array to return the lowest value of comparable elements from it.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-mod">mod</a></p></td><td><p>Returns the modulo (the remainder after dividing the <code>dividend</code> by the <code>divisor</code>).</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-namesof">namesOf</a></p></td><td><p>Returns an array of strings with the names of all the keys within the given object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-now">now</a></p></td><td><p>Returns a <code>DateTime</code> value for the current date and time.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-onnull">onNull</a></p></td><td><p>Executes a callback function if the preceding expression returns a <code>null</code> value and then replaces the <code>null</code> value with the result of the callback.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-orderby">orderBy</a></p></td><td><p>Reorders the elements of an input using criteria that acts on selected elements of that input.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-pluck">pluck</a></p></td><td><p>Useful for mapping an object into an array, <code>pluck</code> iterates over an object and returns an array of keys, values, or indices from the object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-pow">pow</a></p></td><td><p>Raises the value of a <code>base</code> number to the specified <code>power</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-random">random</a></p></td><td><p>Returns a pseudo-random number greater than or equal to <code>0.0</code> and less than <code>1.0</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-randomint">randomInt</a></p></td><td><p>Returns a pseudo-random whole number from <code>0</code> to the specified number (exclusive).</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-read">read</a></p></td><td><p>Reads a string or binary and returns parsed content.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-readurl">readUrl</a></p></td><td><p>Reads a URL, including a classpath-based URL, and returns parsed content. This function works similar to the <code>read</code> function.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-reduce">reduce</a></p></td><td><p>Applies a reduction expression to the elements in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-replace">replace</a></p></td><td><p>Performs string replacement.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-round">round</a></p></td><td><p>Rounds a number up or down to the nearest whole number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-scan">scan</a></p></td><td><p>Returns an array with all of the matches found in an input string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-sizeof">sizeOf</a></p></td><td><p>Returns the number of elements in an array. It returns <code>0</code> if the array is empty.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-splitby">splitBy</a></p></td><td><p>Splits a string into a string array based on a value that matches part of that string. It filters out the matching part from the returned array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-sqrt">sqrt</a></p></td><td><p>Returns the square root of a number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-startswith">startsWith</a></p></td><td><p>Returns <code>true</code> or <code>false</code> depending on whether the input string starts with a matching prefix.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-sum">sum</a></p></td><td><p>Returns the sum of numeric values in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-then">then</a></p></td><td><p>This function works as a pipe that passes the value returned from the preceding expression to the next (a callback) only if the value returned by the preceding expression is not <code>null</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-to">to</a></p></td><td><p>Returns a range with the specified boundaries.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-trim">trim</a></p></td><td><p>Removes any blank spaces from the beginning and end of a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-typeof">typeOf</a></p></td><td><p>Returns the primitive data type of a value, such as <code>String</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-unzip">unzip</a></p></td><td><p>Performs the opposite of <code>zip</code>. It takes an array of arrays as input.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-upper">upper</a></p></td><td><p>Returns the provided string in uppercase characters.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-uuid">uuid</a></p></td><td><p>Returns a v4 UUID using random numbers as the source.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-valuesof">valuesOf</a></p></td><td><p>Returns an array of the values from key-value pairs in an object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-with">with</a></p></td><td><p>Helper function that specifies a replacement element. This function is used with <code>replace</code>, <code>update</code> or <code>mask</code> to perform data substitutions.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-write">write</a></p></td><td><p>Writes a value as a string or binary in a supported format.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-xsitype">xsiType</a></p></td><td><p>Creates a <code>xsi:type</code> type attribute. This method returns an object, so it must be used with dynamic attributes.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-zip">zip</a></p></td><td><p>Merges elements from two arrays into an array of arrays.</p></td></tr></tbody></table>

## Types

- [Core Types](https://docs.mulesoft.com/dataweave/2.6/dw-core-types)

## Namespaces

- [Core Namespaces](https://docs.mulesoft.com/dataweave/2.6/dw-core-namespaces)

## Annotations

- [Core Annotations](https://docs.mulesoft.com/dataweave/2.6/dw-core-annotations)

<!-- document id=e29bec0f6b4732e71957fd0fda67f130017252592b0b9f4e83ab24731ce5e213 url=/mulesoft/current/en-us/dataweave/2.9/dw-core.md -->

---
product: DataWeave
version: 2.9
---

# Core (dw::Core)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains core DataWeave functions for data transformations. It is automatically imported
into any DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-plusplus">++</a></p></td><td><p>Concatenates two values.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-minusminus">--</a></p></td><td><p>Removes specified values from an input value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-abs">abs</a></p></td><td><p>Returns the absolute value of a number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-avg">avg</a></p></td><td><p>Returns the average of numbers listed in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-ceil">ceil</a></p></td><td><p>Rounds a number up to the nearest whole number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-contains">contains</a></p></td><td><p>Returns <code>true</code> if an input contains a given value, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-daysbetween">daysBetween</a></p></td><td><p>Returns the number of days between two dates.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-distinctby">distinctBy</a></p></td><td><p>Iterates over the input and returns the unique elements in it.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-endswith">endsWith</a></p></td><td><p>Returns <code>true</code> if a string ends with a provided substring, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-entriesof">entriesOf</a></p></td><td><p>Returns an array of key-value pairs that describe the key, value, and any attributes in the input object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-evaluatecompatibilityflag">evaluateCompatibilityFlag</a></p></td><td><p>Returns the value of the compatibility flag with the specified name.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-filter">filter</a></p></td><td><p>Iterates over an array and applies an expression that returns matching values.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-filterobject">filterObject</a></p></td><td><p>Iterates a list of key-value pairs in an object and applies an expression that returns only matching objects, filtering out the rest from the output.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-find">find</a></p></td><td><p>Returns indices of an input that match a specified value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-flatmap">flatMap</a></p></td><td><p>Iterates over each item in an array and flattens the results.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-flatten">flatten</a></p></td><td><p>Turns a set of subarrays (such as <code>[ [1,2,3], [4,5,[6]], [], [null] ]</code>) into a single, flattened array (such as <code>[ 1, 2, 3, 4, 5, [6], null ]</code>).</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-floor">floor</a></p></td><td><p>Rounds a number down to the nearest whole number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-groupby">groupBy</a></p></td><td><p>Returns an object that groups items from an array based on specified criteria, such as an expression or matching selector.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-indexof">indexOf</a></p></td><td><p>Returns the index of the <em>first</em> occurrence of the specified element in this array, or <code>-1</code> if this list does not contain the element.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-isblank">isBlank</a></p></td><td><p>Returns <code>true</code> if the given string is empty (<code>""</code>), completely composed of whitespaces, or <code>null</code>. Otherwise, the function returns <code>false</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-isdecimal">isDecimal</a></p></td><td><p>Returns <code>true</code> if the given number contains a decimal, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-isempty">isEmpty</a></p></td><td><p>Returns <code>true</code> if the given input value is empty, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-iseven">isEven</a></p></td><td><p>Returns <code>true</code> if the number or numeric result of a mathematical operation is even, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-isinteger">isInteger</a></p></td><td><p>Returns <code>true</code> if the given number is an integer (which lacks decimals), <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-isleapyear">isLeapYear</a></p></td><td><p>Returns <code>true</code> if it receives a date for a leap year, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-isodd">isOdd</a></p></td><td><p>Returns <code>true</code> if the number or numeric result of a mathematical operation is odd, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-joinby">joinBy</a></p></td><td><p>Merges an array into a single string value and uses the provided string as a separator between each item in the list.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-keysof">keysOf</a></p></td><td><p>Returns an array of keys from key-value pairs within the input object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-lastindexof">lastIndexOf</a></p></td><td><p>Returns the index of the <em>last</em> occurrence of the specified element in a given array or <code>-1</code> if the array does not contain the element.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-log">log</a></p></td><td><p>Without changing the value of the input, <code>log</code> returns the input as a system log. So this makes it very simple to debug your code, because any expression or subexpression can be wrapped with <strong>log</strong> and the result will be printed out without modifying the result of the expression. The output is going to be printed in application/dw format.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-lower">lower</a></p></td><td><p>Returns the provided string in lowercase characters.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-map">map</a></p></td><td><p>Iterates over items in an array and outputs the results into a new array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-mapobject">mapObject</a></p></td><td><p>Iterates over an object using a mapper that acts on keys, values, or indices of that object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-match">match</a></p></td><td><p>Uses a Java regular expression (regex) to match a string and then separates it into capture groups. Returns the results in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-matches">matches</a></p></td><td><p>Checks if an expression matches the entire input string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-max">max</a></p></td><td><p>Returns the highest <code>Comparable</code> value in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-maxby">maxBy</a></p></td><td><p>Iterates over an array and returns the highest value of <code>Comparable</code> elements from it.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-min">min</a></p></td><td><p>Returns the lowest <code>Comparable</code> value in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-minby">minBy</a></p></td><td><p>Iterates over an array to return the lowest value of comparable elements from it.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-mod">mod</a></p></td><td><p>Returns the modulo (the remainder after dividing the <code>dividend</code> by the <code>divisor</code>).</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-namesof">namesOf</a></p></td><td><p>Returns an array of strings with the names of all the keys within the given object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-now">now</a></p></td><td><p>Returns a <code>DateTime</code> value for the current date and time.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-onnull">onNull</a></p></td><td><p>Executes a callback function if the preceding expression returns a <code>null</code> value and then replaces the <code>null</code> value with the result of the callback.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-orderby">orderBy</a></p></td><td><p>Reorders the elements of an input using criteria that acts on selected elements of that input.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-pluck">pluck</a></p></td><td><p>Useful for mapping an object into an array, <code>pluck</code> iterates over an object and returns an array of keys, values, or indices from the object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-pow">pow</a></p></td><td><p>Raises the value of a <code>base</code> number to the specified <code>power</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-random">random</a></p></td><td><p>Returns a pseudo-random number greater than or equal to <code>0.0</code> and less than <code>1.0</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-randomint">randomInt</a></p></td><td><p>Returns a pseudo-random whole number from <code>0</code> to the specified number (exclusive).</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-read">read</a></p></td><td><p>Reads a string or binary and returns parsed content.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-readurl">readUrl</a></p></td><td><p>Reads a URL, including a classpath-based URL, and returns parsed content. This function works similar to the <code>read</code> function.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-reduce">reduce</a></p></td><td><p>Applies a reduction expression to the elements in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-replace">replace</a></p></td><td><p>Performs string replacement.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-round">round</a></p></td><td><p>Rounds a number up or down to the nearest whole number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-scan">scan</a></p></td><td><p>Returns an array with all of the matches found in an input string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-sizeof">sizeOf</a></p></td><td><p>Returns the number of elements in an array. It returns <code>0</code> if the array is empty.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-splitby">splitBy</a></p></td><td><p>Splits a string into a string array based on a value that matches part of that string. It filters out the matching part from the returned array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-sqrt">sqrt</a></p></td><td><p>Returns the square root of a number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-startswith">startsWith</a></p></td><td><p>Returns <code>true</code> or <code>false</code> depending on whether the input string starts with a matching prefix.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-sum">sum</a></p></td><td><p>Returns the sum of numeric values in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-then">then</a></p></td><td><p>This function works as a pipe that passes the value returned from the preceding expression to the next (a callback) only if the value returned by the preceding expression is not <code>null</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-to">to</a></p></td><td><p>Returns a range with the specified boundaries.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-trim">trim</a></p></td><td><p>Removes any blank spaces from the beginning and end of a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-typeof">typeOf</a></p></td><td><p>Returns the primitive data type of a value, such as <code>String</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-unzip">unzip</a></p></td><td><p>Performs the opposite of <code>zip</code>. It takes an array of arrays as input.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-upper">upper</a></p></td><td><p>Returns the provided string in uppercase characters.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-uuid">uuid</a></p></td><td><p>Returns a v4 UUID using random numbers as the source.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-valuesof">valuesOf</a></p></td><td><p>Returns an array of the values from key-value pairs in an object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-with">with</a></p></td><td><p>Helper function that specifies a replacement element. This function is used with <code>replace</code>, <code>update</code> or <code>mask</code> to perform data substitutions.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-write">write</a></p></td><td><p>Writes a value as a string or binary in a supported format.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-xsitype">xsiType</a></p></td><td><p>Creates a <code>xsi:type</code> type attribute. This method returns an object, so it must be used with dynamic attributes.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-zip">zip</a></p></td><td><p>Merges elements from two arrays into an array of arrays.</p></td></tr></tbody></table>

## Types

- [Core Types](https://docs.mulesoft.com/dataweave/2.9/dw-core-types)

## Namespaces

- [Core Namespaces](https://docs.mulesoft.com/dataweave/2.9/dw-core-namespaces)

## Annotations

- [Core Annotations](https://docs.mulesoft.com/dataweave/2.9/dw-core-annotations)

<!-- document id=4735c70ab4dfc3a6b36e046110ebd116ac531447a8414afc017e9185bdd89427 url=/mulesoft/current/en-us/dataweave/latest/dw-core.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Core (dw::Core)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains core DataWeave functions for data transformations. It is automatically imported
into any DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-plusplus">++</a></p></td><td><p>Concatenates two values.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-minusminus">--</a></p></td><td><p>Removes specified values from an input value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-abs">abs</a></p></td><td><p>Returns the absolute value of a number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-avg">avg</a></p></td><td><p>Returns the average of numbers listed in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-ceil">ceil</a></p></td><td><p>Rounds a number up to the nearest whole number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-contains">contains</a></p></td><td><p>Returns <code>true</code> if an input contains a given value, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-daysbetween">daysBetween</a></p></td><td><p>Returns the number of days between two dates.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-distinctby">distinctBy</a></p></td><td><p>Iterates over the input and returns the unique elements in it.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-endswith">endsWith</a></p></td><td><p>Returns <code>true</code> if a string ends with a provided substring, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-entriesof">entriesOf</a></p></td><td><p>Returns an array of key-value pairs that describe the key, value, and any attributes in the input object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-evaluatecompatibilityflag">evaluateCompatibilityFlag</a></p></td><td><p>Returns the value of the compatibility flag with the specified name.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-filter">filter</a></p></td><td><p>Iterates over an array and applies an expression that returns matching values.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-filterobject">filterObject</a></p></td><td><p>Iterates a list of key-value pairs in an object and applies an expression that returns only matching objects, filtering out the rest from the output.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-find">find</a></p></td><td><p>Returns indices of an input that match a specified value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-flatmap">flatMap</a></p></td><td><p>Iterates over each item in an array and flattens the results.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-flatten">flatten</a></p></td><td><p>Turns a set of subarrays (such as <code>[ [1,2,3], [4,5,[6]], [], [null] ]</code>) into a single, flattened array (such as <code>[ 1, 2, 3, 4, 5, [6], null ]</code>).</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-floor">floor</a></p></td><td><p>Rounds a number down to the nearest whole number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-groupby">groupBy</a></p></td><td><p>Returns an object that groups items from an array based on specified criteria, such as an expression or matching selector.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-indexof">indexOf</a></p></td><td><p>Returns the index of the <em>first</em> occurrence of the specified element in this array, or <code>-1</code> if this list does not contain the element.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-isblank">isBlank</a></p></td><td><p>Returns <code>true</code> if the given string is empty (<code>""</code>), completely composed of whitespaces, or <code>null</code>. Otherwise, the function returns <code>false</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-isdecimal">isDecimal</a></p></td><td><p>Returns <code>true</code> if the given number contains a decimal, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-isempty">isEmpty</a></p></td><td><p>Returns <code>true</code> if the given input value is empty, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-iseven">isEven</a></p></td><td><p>Returns <code>true</code> if the number or numeric result of a mathematical operation is even, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-isinteger">isInteger</a></p></td><td><p>Returns <code>true</code> if the given number is an integer (which lacks decimals), <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-isleapyear">isLeapYear</a></p></td><td><p>Returns <code>true</code> if it receives a date for a leap year, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-isodd">isOdd</a></p></td><td><p>Returns <code>true</code> if the number or numeric result of a mathematical operation is odd, <code>false</code> if not.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-joinby">joinBy</a></p></td><td><p>Merges an array into a single string value and uses the provided string as a separator between each item in the list.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-keysof">keysOf</a></p></td><td><p>Returns an array of keys from key-value pairs within the input object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-lastindexof">lastIndexOf</a></p></td><td><p>Returns the index of the <em>last</em> occurrence of the specified element in a given array or <code>-1</code> if the array does not contain the element.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-log">log</a></p></td><td><p>Without changing the value of the input, <code>log</code> returns the input as a system log. So this makes it very simple to debug your code, because any expression or subexpression can be wrapped with <strong>log</strong> and the result will be printed out without modifying the result of the expression. The output is going to be printed in application/dw format.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-logdebug">logDebug</a></p></td><td><p>Helper function that logs messages at <code>Debug</code> level.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-logerror">logError</a></p></td><td><p>Helper function that logs messages at <code>Error</code> level.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-loginfo">logInfo</a></p></td><td><p>Helper function that logs messages at <code>Info</code> level.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-logwarn">logWarn</a></p></td><td><p>Helper function that logs messages at <code>Warn</code> level.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-logwith">logWith</a></p></td><td><p>Without changing the value of the input, <code>logWith</code> returns the input as a system log at the specified level. This makes it simple to debug your code, because any expression or subexpression can be wrapped with <strong>log</strong> and the result is printed out without modifying the result of the expression. The output is printed in application/dw format.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-lower">lower</a></p></td><td><p>Returns the provided string in lowercase characters.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-map">map</a></p></td><td><p>Iterates over items in an array and outputs the results into a new array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-mapobject">mapObject</a></p></td><td><p>Iterates over an object using a mapper that acts on keys, values, or indices of that object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-match">match</a></p></td><td><p>Uses a Java regular expression (regex) to match a string and then separates it into capture groups. Returns the results in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-matches">matches</a></p></td><td><p>Checks if an expression matches the entire input string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-max">max</a></p></td><td><p>Returns the highest <code>Comparable</code> value in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-maxby">maxBy</a></p></td><td><p>Iterates over an array and returns the highest value of <code>Comparable</code> elements from it.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-min">min</a></p></td><td><p>Returns the lowest <code>Comparable</code> value in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-minby">minBy</a></p></td><td><p>Iterates over an array to return the lowest value of comparable elements from it.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-mod">mod</a></p></td><td><p>Returns the modulo (the remainder after dividing the <code>dividend</code> by the <code>divisor</code>).</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-namesof">namesOf</a></p></td><td><p>Returns an array of strings with the names of all the keys within the given object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-now">now</a></p></td><td><p>Returns a <code>DateTime</code> value for the current date and time.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-onnull">onNull</a></p></td><td><p>Executes a callback function if the preceding expression returns a <code>null</code> value and then replaces the <code>null</code> value with the result of the callback.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-orderby">orderBy</a></p></td><td><p>Reorders the elements of an input using criteria that acts on selected elements of that input.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-pluck">pluck</a></p></td><td><p>Useful for mapping an object into an array, <code>pluck</code> iterates over an object and returns an array of keys, values, or indices from the object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-pow">pow</a></p></td><td><p>Raises the value of a <code>base</code> number to the specified <code>power</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-random">random</a></p></td><td><p>Returns a pseudo-random number greater than or equal to <code>0.0</code> and less than <code>1.0</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-randomint">randomInt</a></p></td><td><p>Returns a pseudo-random whole number from <code>0</code> to the specified number (exclusive).</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-read">read</a></p></td><td><p>Reads a string or binary and returns parsed content.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-readurl">readUrl</a></p></td><td><p>Reads a URL, including a classpath-based URL, and returns parsed content. This function works similar to the <code>read</code> function.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-reduce">reduce</a></p></td><td><p>Applies a reduction expression to the elements in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-replace">replace</a></p></td><td><p>Performs string replacement.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-round">round</a></p></td><td><p>Rounds a number up or down to the nearest whole number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-scan">scan</a></p></td><td><p>Returns an array with all of the matches found in an input string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-sizeof">sizeOf</a></p></td><td><p>Returns the number of elements in an array. It returns <code>0</code> if the array is empty.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-splitby">splitBy</a></p></td><td><p>Splits a string into a string array based on a value that matches part of that string. It filters out the matching part from the returned array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-sqrt">sqrt</a></p></td><td><p>Returns the square root of a number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-startswith">startsWith</a></p></td><td><p>Returns <code>true</code> or <code>false</code> depending on whether the input string starts with a matching prefix.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-sum">sum</a></p></td><td><p>Returns the sum of numeric values in an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-then">then</a></p></td><td><p>This function works as a pipe that passes the value returned from the preceding expression to the next (a callback) only if the value returned by the preceding expression is not <code>null</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-to">to</a></p></td><td><p>Returns a range with the specified boundaries.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-trim">trim</a></p></td><td><p>Removes any blank spaces from the beginning and end of a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-typeof">typeOf</a></p></td><td><p>Returns the primitive data type of a value, such as <code>String</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-unzip">unzip</a></p></td><td><p>Performs the opposite of <code>zip</code>. It takes an array of arrays as input.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-upper">upper</a></p></td><td><p>Returns the provided string in uppercase characters.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-uuid">uuid</a></p></td><td><p>Returns a v4 UUID using random numbers as the source.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-valuesof">valuesOf</a></p></td><td><p>Returns an array of the values from key-value pairs in an object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-with">with</a></p></td><td><p>Helper function that specifies a replacement element. This function is used with <code>replace</code>, <code>update</code> or <code>mask</code> to perform data substitutions.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-write">write</a></p></td><td><p>Writes a value as a string or binary in a supported format.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-xsitype">xsiType</a></p></td><td><p>Creates a <code>xsi:type</code> type attribute. This method returns an object, so it must be used with dynamic attributes.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-core-functions-zip">zip</a></p></td><td><p>Merges elements from two arrays into an array of arrays.</p></td></tr></tbody></table>

## Types

- [Core Types](https://docs.mulesoft.com/dataweave/latest/dw-core-types)

## Namespaces

- [Core Namespaces](https://docs.mulesoft.com/dataweave/latest/dw-core-namespaces)

## Annotations

- [Core Annotations](https://docs.mulesoft.com/dataweave/latest/dw-core-annotations)

<!-- document id=5e00552c93ed9b9c885871df96ce73a7d09e6b28fa93d4a08d2ddbaabb9b1c7e url=/mulesoft/current/en-us/dataweave/2.11/dw-core-annotations.md -->

---
product: DataWeave
version: 2.11
---

# Core Annotations (dw::Core)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Annotation</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>AnnotationTarget</p></td><td><div><div><p><code>@AnnotationTarget(targets: Array&lt;"Function" | "Parameter" | "Variable" | "Import" | "Type" | "Version" | "Namespace" | "KeyType" | "TypeExpression" | "Expression" | "Annotation"&gt;)</code></p></div></div></td><td><div><div><p>Annotation that limits the application of an annotation. An example is <code>@AnnotationTarget(targets = ["Function", "Variable"])</code>, which limits the scope of the annotation <code>annotation TailRec()</code> to functions and variables. If no <code>AnnotationTarget</code> is specified, an annotation can apply to any valid target.</p></div><div><p>Annotation Targets:</p></div><div><ul><li><p><code>Parameter</code>: For function parameters.</p></li><li><p><code>Function</code>: For function definitions.</p></li><li><p><code>Variable</code>: For variable definitions.</p></li><li><p><code>Import</code>: For import definitions.</p></li></ul></div></div></td></tr><tr><td><p>Deprecated</p></td><td><div><div><p><code>@Deprecated(since: String, replacement: String)</code></p></div></div></td><td><div><div><p>Annotation that marks a function as deprecated.</p></div><div><p><em>Introduced in DataWeave version 2.4.0.</em></p></div></div></td></tr><tr><td><p>DesignOnlyType</p></td><td><div><div><p><code>@DesignOnlyType()</code></p></div></div></td><td><div><div><p>Annotation that marks a parameter type as <em>design only</em> to indicate that the field type is validated only at design time. At runtime, only minimal type validation takes place. This annotation is useful for performance, especially with complex Object types.</p></div></div></td></tr><tr><td><p>Experimental</p></td><td><div><div><p><code>@Experimental()</code></p></div></div></td><td><div><div><p>Annotation that identifies a feature as experimental and subject to change or removal in the future.</p></div><div><p><em>Introduced in DataWeave version 2.4.0.</em></p></div></div></td></tr><tr><td><p>GlobalDescription</p></td><td><div><div><p><code>@GlobalDescription()</code></p></div></div></td><td><div><div><p>Annotation used to identify the function description to use for the function’s documentation. This annotation is useful for selecting the correct function description when the function is overloaded.</p></div><div><p><em>Introduced in DataWeave version 2.4.0.</em></p></div></div></td></tr><tr><td><p>Interceptor</p></td><td><div><div><p><code>@Interceptor(interceptorFunction: String | (annotationArgs: Object, targetFunctionName: String, args: Array&lt;Any&gt;, callback: (args: Array&lt;Any&gt;) -&gt; Any) -&gt; Any)</code></p></div></div></td><td><div><div><p>Annotation that marks another annotation as an Interceptor so that the marked annotation will wrap an annotated function with an <code>interceptorFunction</code>. An example is the <code>RuntimePrivilege</code> annotation, which is annotated by <code>@Interceptor(interceptorFunction = "@native system::SecurityManagerCheckFunctionValue")</code>. The <code>readUrl</code> function definition is annotated by <code>@RuntimePrivilege(requires = "Resource")</code>.</p></div><div><p><em>Experimental:</em> This experimental feature is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>Internal</p></td><td><div><div><p><code>@Internal(permits: Array&lt;String&gt;)</code></p></div></div></td><td><div><div><p>Annotation that marks a function as <em>internal</em> and not to be used.</p></div><div><div><pre>_Introduced in DataWeave 2.4.0. Supported by Mule 4.4.0 and later._</pre></div></div><div><p><em>Experimental:</em> This experimental feature is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>Labels</p></td><td><div><div><p><code>@Labels(labels: Array&lt;String&gt;)</code></p></div></div></td><td><div><div><p>Annotation for labeling a function or variable definition so that it becomes more easy to discover. An example is <code>@Labels(labels =["append", "concat"])</code>.</p></div><div><p><em>Introduced in DataWeave version 2.4.0.</em></p></div></div></td></tr><tr><td><p>Lazy</p></td><td><div><div><p><code>@Lazy()</code></p></div></div></td><td><div><div><p>Annotation that marks a variable declaration for lazy initialization.</p></div><div><p><em>Introduced in DataWeave version 2.3.0.</em></p></div></div></td></tr><tr><td><p>Metadata</p></td><td><div><div><p><code>@Metadata(key: String)</code></p></div></div></td><td><div><div><p>Annotation used to mark annotations that represent metadata.</p></div><div><p><em>Introduced in DataWeave version 2.8.0.</em></p></div></div></td></tr><tr><td><p>RuntimePrivilege</p></td><td><div><div><p><code>@RuntimePrivilege(requires: String)</code></p></div></div></td><td><div><div><p>Annotation used to indicate that a function requires runtime privileges to execute. An example is <code>@RuntimePrivilege(requires = "Resource")</code>, which annotates the <code>readUrl</code> function definition.</p></div></div></td></tr><tr><td><p>Since</p></td><td><div><div><p><code>@Since(version: String)</code></p></div></div></td><td><div><div><p>Annotation that identifies the DataWeave version in which the annotated functionality was introduced. An example is <code>@Since(version = "2.4.0")</code>.</p></div><div><p><em>Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later.</em></p></div></div></td></tr><tr><td><p>StreamCapable</p></td><td><div><div><p><code>@StreamCapable()</code></p></div></div></td><td><div><div><p>Annotation that marks a parameter as stream capable, which means that this field will consume an array of objects in a forward-only manner. Examples of functions with <code>@StreamCapable</code> fields are <code>map</code>, <code>mapObject</code>, and <code>pluck</code>.</p></div></div></td></tr><tr><td><p>TailRec</p></td><td><div><div><p><code>@TailRec()</code></p></div></div></td><td><div><div><p>Annotation that marks a function as tail recursive. If a function with this annotation is not tail recursive, the function will fail.</p></div></div></td></tr><tr><td><p>UntrustedCode</p></td><td><div><div><p><code>@UntrustedCode(privileges: Array&lt;String&gt;)</code></p></div></div></td><td><div><div><p>Annotation that marks a script as untrusted, which means that the script has no privileges. For example, such a script cannot gain access to environment variables or read a resource from a URL.</p></div><div><p><em>Experimental:</em> This experimental feature is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr></tbody></table>

<!-- document id=d59599a6e957a6935e651d69c1fc0a98897e2c36b8e1bf9f5cf20c731d93bfbe url=/mulesoft/current/en-us/dataweave/2.12/dw-core-annotations.md -->

---
product: DataWeave
version: 2.12
---

# Core Annotations (dw::Core)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Annotation</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>AnnotationTarget</p></td><td><div><div><p><code>@AnnotationTarget(targets: Array&lt;"Function" | "Parameter" | "Variable" | "Import" | "Type" | "Version" | "Namespace" | "KeyType" | "TypeExpression" | "Expression" | "Annotation"&gt;)</code></p></div></div></td><td><div><div><p>Annotation that limits the application of an annotation. An example is <code>@AnnotationTarget(targets = ["Function", "Variable"])</code>, which limits the scope of the annotation <code>annotation TailRec()</code> to functions and variables. If no <code>AnnotationTarget</code> is specified, an annotation can apply to any valid target.</p></div><div><p>Annotation Targets:</p></div><div><ul><li><p><code>Parameter</code>: For function parameters.</p></li><li><p><code>Function</code>: For function definitions.</p></li><li><p><code>Variable</code>: For variable definitions.</p></li><li><p><code>Import</code>: For import definitions.</p></li></ul></div></div></td></tr><tr><td><p>Deprecated</p></td><td><div><div><p><code>@Deprecated(since: String, replacement: String)</code></p></div></div></td><td><div><div><p>Annotation that marks a function as deprecated.</p></div><div><p><em>Introduced in DataWeave version 2.4.0.</em></p></div></div></td></tr><tr><td><p>DesignOnlyType</p></td><td><div><div><p><code>@DesignOnlyType()</code></p></div></div></td><td><div><div><p>Annotation that marks a parameter type as <em>design only</em> to indicate that the field type is validated only at design time. At runtime, only minimal type validation takes place. This annotation is useful for performance, especially with complex Object types.</p></div></div></td></tr><tr><td><p>Experimental</p></td><td><div><div><p><code>@Experimental()</code></p></div></div></td><td><div><div><p>Annotation that identifies a feature as experimental and subject to change or removal in the future.</p></div><div><p><em>Introduced in DataWeave version 2.4.0.</em></p></div></div></td></tr><tr><td><p>GlobalDescription</p></td><td><div><div><p><code>@GlobalDescription()</code></p></div></div></td><td><div><div><p>Annotation used to identify the function description to use for the function’s documentation. This annotation is useful for selecting the correct function description when the function is overloaded.</p></div><div><p><em>Introduced in DataWeave version 2.4.0.</em></p></div></div></td></tr><tr><td><p>Interceptor</p></td><td><div><div><p><code>@Interceptor(interceptorFunction: String | (annotationArgs: Object, targetFunctionName: String, args: Array&lt;Any&gt;, callback: (args: Array&lt;Any&gt;) -&gt; Any) -&gt; Any)</code></p></div></div></td><td><div><div><p>Annotation that marks another annotation as an Interceptor so that the marked annotation will wrap an annotated function with an <code>interceptorFunction</code>. An example is the <code>RuntimePrivilege</code> annotation, which is annotated by <code>@Interceptor(interceptorFunction = "@native system::SecurityManagerCheckFunctionValue")</code>. The <code>readUrl</code> function definition is annotated by <code>@RuntimePrivilege(requires = "Resource")</code>.</p></div><div><p><em>Experimental:</em> This experimental feature is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>Internal</p></td><td><div><div><p><code>@Internal(permits: Array&lt;String&gt;)</code></p></div></div></td><td><div><div><p>Annotation that marks a function as <em>internal</em> and not to be used.</p></div><div><div><pre>_Introduced in DataWeave 2.4.0. Supported by Mule 4.4.0 and later._</pre></div></div><div><p><em>Experimental:</em> This experimental feature is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>Labels</p></td><td><div><div><p><code>@Labels(labels: Array&lt;String&gt;)</code></p></div></div></td><td><div><div><p>Annotation for labeling a function or variable definition so that it becomes more easy to discover. An example is <code>@Labels(labels =["append", "concat"])</code>.</p></div><div><p><em>Introduced in DataWeave version 2.4.0.</em></p></div></div></td></tr><tr><td><p>Lazy</p></td><td><div><div><p><code>@Lazy()</code></p></div></div></td><td><div><div><p>Annotation that marks a variable declaration for lazy initialization.</p></div><div><p><em>Introduced in DataWeave version 2.3.0.</em></p></div></div></td></tr><tr><td><p>Metadata</p></td><td><div><div><p><code>@Metadata(key: String)</code></p></div></div></td><td><div><div><p>Annotation used to mark annotations that represent metadata.</p></div><div><p><em>Introduced in DataWeave version 2.8.0.</em></p></div></div></td></tr><tr><td><p>RuntimePrivilege</p></td><td><div><div><p><code>@RuntimePrivilege(requires: String)</code></p></div></div></td><td><div><div><p>Annotation used to indicate that a function requires runtime privileges to execute. An example is <code>@RuntimePrivilege(requires = "Resource")</code>, which annotates the <code>readUrl</code> function definition.</p></div></div></td></tr><tr><td><p>Since</p></td><td><div><div><p><code>@Since(version: String)</code></p></div></div></td><td><div><div><p>Annotation that identifies the DataWeave version in which the annotated functionality was introduced. An example is <code>@Since(version = "2.4.0")</code>.</p></div><div><p><em>Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later.</em></p></div></div></td></tr><tr><td><p>StreamCapable</p></td><td><div><div><p><code>@StreamCapable()</code></p></div></div></td><td><div><div><p>Annotation that marks a parameter as stream capable, which means that this field will consume an array of objects in a forward-only manner. Examples of functions with <code>@StreamCapable</code> fields are <code>map</code>, <code>mapObject</code>, and <code>pluck</code>.</p></div></div></td></tr><tr><td><p>TailRec</p></td><td><div><div><p><code>@TailRec()</code></p></div></div></td><td><div><div><p>Annotation that marks a function as tail recursive. If a function with this annotation is not tail recursive, the function will fail.</p></div></div></td></tr><tr><td><p>UntrustedCode</p></td><td><div><div><p><code>@UntrustedCode(privileges: Array&lt;String&gt;)</code></p></div></div></td><td><div><div><p>Annotation that marks a script as untrusted, which means that the script has no privileges. For example, such a script cannot gain access to environment variables or read a resource from a URL.</p></div><div><p><em>Experimental:</em> This experimental feature is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>VisibleTo</p></td><td><div><div><p><code>@VisibleTo(components: Array&lt;String&gt;)</code></p></div></div></td><td><div><div><p>Annotation that marks an <code>internal</code> directive (<code>fun</code>, <code>var</code>, <code>type</code>, and <code>ns</code>) as visible to listed components in addition to its own component. Use it to share helpers across libraries you own without making them public. Component names must match the <code>name</code> field in the <code>META-INF/dw-components.dwl</code> descriptor.</p></div><div><p><code>@VisibleTo</code> is valid only on <code>internal</code> directives. Applying it to a <code>private</code> directive, or to a directive without a visibility keyword, produces a compile-time error.</p></div><div><p>Example:</p></div><div><div><pre><code>@VisibleTo(components = ["bat", "dataweave-io"])
internal fun nativeImpl() = ...</code></pre></div></div><div><p>For the full visibility model, see <a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-scope-visibility">Scope Visibility in DataWeave</a>.</p></div><div><p><em>Introduced in DataWeave version 2.12.0.</em></p></div><div><p><em>Experimental:</em> This experimental feature is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr></tbody></table>

<!-- document id=6872c90ab78d569365e40deede9d62118a51169d288f713d054a53086bcbe39e url=/mulesoft/current/en-us/dataweave/2.3/dw-core-annotations.md -->

---
product: DataWeave
version: 2.3
---

# Core Annotations (dw::Core)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Annotation</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>AnnotationTarget</p></td><td><p><code>@AnnotationTarget(targets: Array&lt;String&gt;)</code></p></td><td><div><div><p>Defines where the Annotation can be used. If not defined, it can be used in any possible target.</p></div><div><p>Options are:</p></div><div><ul><li><p>Parameter: For function parameters.</p></li><li><p>Function: For function definitions.</p></li><li><p>Variable: For variable definitions.</p></li><li><p>Import: For import definitions.</p></li></ul></div></div></td></tr><tr><td><p>DesignOnlyType</p></td><td><p><code>@DesignOnlyType()</code></p></td><td><div><div><p>Annotation that marks a parameter type as Design Only. This means that this field type is only validated at design time. At runtime, only minimal type validation takes place. This is useful for performance reasons, especially with complex Object types.</p></div></div></td></tr><tr><td><p>Lazy</p></td><td><p><code>@Lazy()</code></p></td><td><div><div><p>Annotation that marks a Variable declaration to be Lazily initialized.</p></div><div><p><em>Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later.</em></p></div></div></td></tr><tr><td><p>RuntimePermissions</p></td><td><p><code>@RuntimePermissions(permissions: Array&lt;String&gt;)</code></p></td><td><div><div><p>Annotation to specify that a function needs a given set of Runtime Permissions to be executed</p></div></div></td></tr><tr><td><p>Since</p></td><td><p><code>@Since(version: String)</code></p></td><td><div><div><p>Annotation used to define the version from which this functionality is available.</p></div><div><p><em>Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later.</em></p></div></div></td></tr><tr><td><p>StreamCapable</p></td><td><p><code>@StreamCapable()</code></p></td><td><div><div><p>Annotation that marks a parameter as Stream capable. This means that this field is going to consume the Array of Object in a forward only manner.</p></div></div></td></tr><tr><td><p>TailRec</p></td><td><p><code>@TailRec()</code></p></td><td><div><div><p>Annotation that marks a function to be Tail Recursive. If the function is not tail recursive, it will start failing.</p></div></div></td></tr></tbody></table>

<!-- document id=175c68ef7bbcdf8185c8b8d04c385da3c8561f90f108a9ecbed8c2fe1a939f3b url=/mulesoft/current/en-us/dataweave/2.4/dw-core-annotations.md -->

---
product: DataWeave
version: 2.4
---

# Core Annotations (dw::Core)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Annotation</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>AnnotationTarget</p></td><td><div><div><p><code>@AnnotationTarget(targets: Array&lt;"Function" | "Parameter" | "Variable" | "Import"&gt;)</code></p></div></div></td><td><div><div><p>Annotation that limits the scope of an annotation. For example, the <code>Lazy</code> annotation applies only to variables, and the <code>StreamCapable</code> annotation applies only to parameters and variables. If no <code>AnnotationTarget</code> is specified, an annotation can apply to any valid target. An example is <code>@AnnotationTarget(targets = ["Function", "Variable"])</code> to limit the scope of the annotation <code>annotation TailRec()</code>.</p></div><div><p>Annotation Targets:</p></div><div><ul><li><p><code>Parameter</code>: For function parameters.</p></li><li><p><code>Function</code>: For function definitions.</p></li><li><p><code>Variable</code>: For variable definitions.</p></li><li><p><code>Import</code>: For import definitions.</p></li></ul></div></div></td></tr><tr><td><p>Deprecated</p></td><td><div><div><p><code>@Deprecated(since: String, replacement: String)</code></p></div></div></td><td><div><div><p>Annotation that marks a function as deprecated.</p></div><div><p><em>Introduced in DataWeave version 2.4.0.</em></p></div></div></td></tr><tr><td><p>DesignOnlyType</p></td><td><div><div><p><code>@DesignOnlyType()</code></p></div></div></td><td><div><div><p>Annotation that marks a parameter type as <em>design only</em> to indicate that the field type is validated only at design time. At runtime, only minimal type validation takes place. This annotation is useful for performance, especially with complex Object types.</p></div></div></td></tr><tr><td><p>Experimental</p></td><td><div><div><p><code>@Experimental()</code></p></div></div></td><td><div><div><p>Annotation that marks a function as experimental and subject to change or removal in the future.</p></div><div><p><em>Introduced in DataWeave version 2.4.0.</em></p></div></div></td></tr><tr><td><p>GlobalDescription</p></td><td><div><div><p><code>@GlobalDescription()</code></p></div></div></td><td><div><div><p>Annotation used to identify which functions gets the function description from the function’s documentation section. This annotation is useful for selecting the correct function description when the function is overloaded.</p></div><div><p><em>Introduced in DataWeave version 2.4.0.</em></p></div></div></td></tr><tr><td><p>Interceptor</p></td><td><div><div><p><code>@Interceptor(interceptorFunction: String | (annotationArgs: Object, targetFunctionName: String, args: Array&lt;Any&gt;, callback: (args: Array&lt;Any&gt;) -&gt; Any) -&gt; Any)</code></p></div></div></td><td><div><div><p>Annotation that marks another annotation as an Interceptor so that the marked annotation will wrap an annotated function with an <code>interceptorFunction</code>. An example is the <code>RuntimePrivilege</code> annotation, which is annotated by <code>@Interceptor(interceptorFunction = "@native system::SecurityManagerCheckFunctionValue")</code>. The <code>readUrl</code> function definition is annotated by <code>@RuntimePrivilege(requires = "Resource")</code>.</p></div><div><p><em>Experimental:</em> This experimental feature is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>Internal</p></td><td><div><div><p><code>@Internal(permits: Array&lt;String&gt;)</code></p></div></div></td><td><div><div><p>Annotation that marks a function as <em>internal</em> and not to be used.</p></div><div><p><em>Introduced in DataWeave 2.4.0.</em></p></div><div><p><em>Experimental:</em> This experimental feature is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>Labels</p></td><td><div><div><p><code>@Labels(labels: Array&lt;String&gt;)</code></p></div></div></td><td><div><div><p>Annotation for labeling a function or variable so that the labelled target becomes more easy to discover. An example is <code>@Labels(labels = ["foreach", "transform"])</code>, which annotates definitions of <code>map</code> and <code>mapObject</code> functions.</p></div><div><p><em>Introduced in DataWeave version 2.4.0.</em></p></div></div></td></tr><tr><td><p>Lazy</p></td><td><div><div><p><code>@Lazy()</code></p></div></div></td><td><div><div><p>Annotation that marks a variable declaration for lazy initialization.</p></div><div><p><em>Introduced in DataWeave version 2.3.0.</em></p></div></div></td></tr><tr><td><p>RuntimePrivilege</p></td><td><div><div><p><code>@RuntimePrivilege(requires: String)</code></p></div></div></td><td><div><div><p>Annotation used to indicate that a function requires runtime privileges to execute. An example is <code>@RuntimePrivilege(requires = "Resource")</code>, which annotates the <code>readUrl</code> function definition.</p></div></div></td></tr><tr><td><p>Since</p></td><td><div><div><p><code>@Since(version: String)</code></p></div></div></td><td><div><div><p>Annotation that identifies the DataWeave version in which the annotated functionality was introduced. An example is <code>@Since(version = "2.4.0")</code>.</p></div><div><p><em>Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later.</em></p></div></div></td></tr><tr><td><p>StreamCapable</p></td><td><div><div><p><code>@StreamCapable()</code></p></div></div></td><td><div><div><p>Annotation that marks a parameter as stream capable, which means that the annotated field consumes an array of objects in a forward-only manner. Examples of functions with <code>@StreamCapable</code> fields are <code>map</code>, <code>mapObject</code>, and <code>pluck</code>.</p></div></div></td></tr><tr><td><p>TailRec</p></td><td><div><div><p><code>@TailRec()</code></p></div></div></td><td><div><div><p>Annotation that marks a function as tail recursive. If a function with this annotation is not tail recursive, the function will fail.</p></div></div></td></tr><tr><td><p>UntrustedCode</p></td><td><div><div><p><code>@UntrustedCode()</code></p></div></div></td><td><div><div><p>Annotation that marks a script as untrusted, which means that the script has no privileges. For example, the script cannot gain access to environment variables or read a resource from a URL.</p></div><div><p><em>Experimental:</em> This experimental feature is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr></tbody></table>

<!-- document id=8fd738e3e0d1362ea0f8a27481cfb40516019c06dd18adc088fa970869e7ca3e url=/mulesoft/current/en-us/dataweave/2.6/dw-core-annotations.md -->

---
product: DataWeave
version: 2.6
---

# Core Annotations (dw::Core)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Annotation</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>AnnotationTarget</p></td><td><div><div><p><code>@AnnotationTarget(targets: Array&lt;"Function" | "Parameter" | "Variable" | "Import" | "Type" | "Version" | "Namespace"&gt;)</code></p></div></div></td><td><div><div><p>Annotation that limits the application of an annotation. An example is <code>@AnnotationTarget(targets = ["Function", "Variable"])</code>, which limits the scope of the annotation <code>annotation TailRec()</code> to functions and variables. If no <code>AnnotationTarget</code> is specified, an annotation can apply to any valid target.</p></div><div><p>Annotation Targets:</p></div><div><ul><li><p><code>Parameter</code>: For function parameters.</p></li><li><p><code>Function</code>: For function definitions.</p></li><li><p><code>Variable</code>: For variable definitions.</p></li><li><p><code>Import</code>: For import definitions.</p></li></ul></div></div></td></tr><tr><td><p>Deprecated</p></td><td><div><div><p><code>@Deprecated(since: String, replacement: String)</code></p></div></div></td><td><div><div><p>Annotation that marks a function as deprecated.</p></div><div><p><em>Introduced in DataWeave version 2.4.0.</em></p></div></div></td></tr><tr><td><p>DesignOnlyType</p></td><td><div><div><p><code>@DesignOnlyType()</code></p></div></div></td><td><div><div><p>Annotation that marks a parameter type as <em>design only</em> to indicate that the field type is validated only at design time. At runtime, only minimal type validation takes place. This annotation is useful for performance, especially with complex Object types.</p></div></div></td></tr><tr><td><p>Experimental</p></td><td><div><div><p><code>@Experimental()</code></p></div></div></td><td><div><div><p>Annotation that identifies a feature as experimental and subject to change or removal in the future.</p></div><div><p><em>Introduced in DataWeave version 2.4.0.</em></p></div></div></td></tr><tr><td><p>GlobalDescription</p></td><td><div><div><p><code>@GlobalDescription()</code></p></div></div></td><td><div><div><p>Annotation used to identify the function description to use for the function’s documentation. This annotation is useful for selecting the correct function description when the function is overloaded.</p></div><div><p><em>Introduced in DataWeave version 2.4.0.</em></p></div></div></td></tr><tr><td><p>Interceptor</p></td><td><div><div><p><code>@Interceptor(interceptorFunction: String | (annotationArgs: Object, targetFunctionName: String, args: Array&lt;Any&gt;, callback: (args: Array&lt;Any&gt;) -&gt; Any) -&gt; Any)</code></p></div></div></td><td><div><div><p>Annotation that marks another annotation as an Interceptor so that the marked annotation will wrap an annotated function with an <code>interceptorFunction</code>. An example is the <code>RuntimePrivilege</code> annotation, which is annotated by <code>@Interceptor(interceptorFunction = "@native system::SecurityManagerCheckFunctionValue")</code>. The <code>readUrl</code> function definition is annotated by <code>@RuntimePrivilege(requires = "Resource")</code>.</p></div><div><p><em>Experimental:</em> This experimental feature is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>Internal</p></td><td><div><div><p><code>@Internal(permits: Array&lt;String&gt;)</code></p></div></div></td><td><div><div><p>Annotation that marks a function as <em>internal</em> and not to be used.</p></div><div><div><pre>_Introduced in DataWeave 2.4.0. Supported by Mule 4.4.0 and later._</pre></div></div><div><p><em>Experimental:</em> This experimental feature is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>Labels</p></td><td><div><div><p><code>@Labels(labels: Array&lt;String&gt;)</code></p></div></div></td><td><div><div><p>Annotation for labeling a function or variable definition so that it becomes more easy to discover. An example is <code>@Labels(labels =["append", "concat"])</code>.</p></div><div><p><em>Introduced in DataWeave version 2.4.0.</em></p></div></div></td></tr><tr><td><p>Lazy</p></td><td><div><div><p><code>@Lazy()</code></p></div></div></td><td><div><div><p>Annotation that marks a variable declaration for lazy initialization.</p></div><div><p><em>Introduced in DataWeave version 2.3.0.</em></p></div></div></td></tr><tr><td><p>RuntimePrivilege</p></td><td><div><div><p><code>@RuntimePrivilege(requires: String)</code></p></div></div></td><td><div><div><p>Annotation used to indicate that a function requires runtime privileges to execute. An example is <code>@RuntimePrivilege(requires = "Resource")</code>, which annotates the <code>readUrl</code> function definition.</p></div></div></td></tr><tr><td><p>Since</p></td><td><div><div><p><code>@Since(version: String)</code></p></div></div></td><td><div><div><p>Annotation that identifies the DataWeave version in which the annotated functionality was introduced. An example is <code>@Since(version = "2.4.0")</code>.</p></div><div><p><em>Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later.</em></p></div></div></td></tr><tr><td><p>StreamCapable</p></td><td><div><div><p><code>@StreamCapable()</code></p></div></div></td><td><div><div><p>Annotation that marks a parameter as stream capable, which means that this field will consume an array of objects in a forward-only manner. Examples of functions with <code>@StreamCapable</code> fields are <code>map</code>, <code>mapObject</code>, and <code>pluck</code>.</p></div></div></td></tr><tr><td><p>TailRec</p></td><td><div><div><p><code>@TailRec()</code></p></div></div></td><td><div><div><p>Annotation that marks a function as tail recursive. If a function with this annotation is not tail recursive, the function will fail.</p></div></div></td></tr><tr><td><p>UntrustedCode</p></td><td><div><div><p><code>@UntrustedCode(privileges: Array&lt;String&gt;)</code></p></div></div></td><td><div><div><p>Annotation that marks a script as untrusted, which means that the script has no privileges. For example, such a script cannot gain access to environment variables or read a resource from a URL.</p></div><div><p><em>Experimental:</em> This experimental feature is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr></tbody></table>

<!-- document id=96991e1542aa9465dbd1db668344c17b9069821a2d78a39ecafb68fa17345a38 url=/mulesoft/current/en-us/dataweave/2.9/dw-core-annotations.md -->

---
product: DataWeave
version: 2.9
---

# Core Annotations (dw::Core)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Annotation</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>AnnotationTarget</p></td><td><div><div><p><code>@AnnotationTarget(targets: Array&lt;"Function" | "Parameter" | "Variable" | "Import" | "Type" | "Version" | "Namespace" | "KeyType" | "TypeExpression" | "Expression" | "Annotation"&gt;)</code></p></div></div></td><td><div><div><p>Annotation that limits the application of an annotation. An example is <code>@AnnotationTarget(targets = ["Function", "Variable"])</code>, which limits the scope of the annotation <code>annotation TailRec()</code> to functions and variables. If no <code>AnnotationTarget</code> is specified, an annotation can apply to any valid target.</p></div><div><p>Annotation Targets:</p></div><div><ul><li><p><code>Parameter</code>: For function parameters.</p></li><li><p><code>Function</code>: For function definitions.</p></li><li><p><code>Variable</code>: For variable definitions.</p></li><li><p><code>Import</code>: For import definitions.</p></li></ul></div></div></td></tr><tr><td><p>Deprecated</p></td><td><div><div><p><code>@Deprecated(since: String, replacement: String)</code></p></div></div></td><td><div><div><p>Annotation that marks a function as deprecated.</p></div><div><p><em>Introduced in DataWeave version 2.4.0.</em></p></div></div></td></tr><tr><td><p>DesignOnlyType</p></td><td><div><div><p><code>@DesignOnlyType()</code></p></div></div></td><td><div><div><p>Annotation that marks a parameter type as <em>design only</em> to indicate that the field type is validated only at design time. At runtime, only minimal type validation takes place. This annotation is useful for performance, especially with complex Object types.</p></div></div></td></tr><tr><td><p>Experimental</p></td><td><div><div><p><code>@Experimental()</code></p></div></div></td><td><div><div><p>Annotation that identifies a feature as experimental and subject to change or removal in the future.</p></div><div><p><em>Introduced in DataWeave version 2.4.0.</em></p></div></div></td></tr><tr><td><p>GlobalDescription</p></td><td><div><div><p><code>@GlobalDescription()</code></p></div></div></td><td><div><div><p>Annotation used to identify the function description to use for the function’s documentation. This annotation is useful for selecting the correct function description when the function is overloaded.</p></div><div><p><em>Introduced in DataWeave version 2.4.0.</em></p></div></div></td></tr><tr><td><p>Interceptor</p></td><td><div><div><p><code>@Interceptor(interceptorFunction: String | (annotationArgs: Object, targetFunctionName: String, args: Array&lt;Any&gt;, callback: (args: Array&lt;Any&gt;) -&gt; Any) -&gt; Any)</code></p></div></div></td><td><div><div><p>Annotation that marks another annotation as an Interceptor so that the marked annotation will wrap an annotated function with an <code>interceptorFunction</code>. An example is the <code>RuntimePrivilege</code> annotation, which is annotated by <code>@Interceptor(interceptorFunction = "@native system::SecurityManagerCheckFunctionValue")</code>. The <code>readUrl</code> function definition is annotated by <code>@RuntimePrivilege(requires = "Resource")</code>.</p></div><div><p><em>Experimental:</em> This experimental feature is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>Internal</p></td><td><div><div><p><code>@Internal(permits: Array&lt;String&gt;)</code></p></div></div></td><td><div><div><p>Annotation that marks a function as <em>internal</em> and not to be used.</p></div><div><div><pre>_Introduced in DataWeave 2.4.0. Supported by Mule 4.4.0 and later._</pre></div></div><div><p><em>Experimental:</em> This experimental feature is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>Labels</p></td><td><div><div><p><code>@Labels(labels: Array&lt;String&gt;)</code></p></div></div></td><td><div><div><p>Annotation for labeling a function or variable definition so that it becomes more easy to discover. An example is <code>@Labels(labels =["append", "concat"])</code>.</p></div><div><p><em>Introduced in DataWeave version 2.4.0.</em></p></div></div></td></tr><tr><td><p>Lazy</p></td><td><div><div><p><code>@Lazy()</code></p></div></div></td><td><div><div><p>Annotation that marks a variable declaration for lazy initialization.</p></div><div><p><em>Introduced in DataWeave version 2.3.0.</em></p></div></div></td></tr><tr><td><p>Metadata</p></td><td><div><div><p><code>@Metadata(key: String)</code></p></div></div></td><td><div><div><p>Annotation used to mark annotations that represent metadata.</p></div><div><p><em>Introduced in DataWeave version 2.8.0.</em></p></div></div></td></tr><tr><td><p>RuntimePrivilege</p></td><td><div><div><p><code>@RuntimePrivilege(requires: String)</code></p></div></div></td><td><div><div><p>Annotation used to indicate that a function requires runtime privileges to execute. An example is <code>@RuntimePrivilege(requires = "Resource")</code>, which annotates the <code>readUrl</code> function definition.</p></div></div></td></tr><tr><td><p>Since</p></td><td><div><div><p><code>@Since(version: String)</code></p></div></div></td><td><div><div><p>Annotation that identifies the DataWeave version in which the annotated functionality was introduced. An example is <code>@Since(version = "2.4.0")</code>.</p></div><div><p><em>Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later.</em></p></div></div></td></tr><tr><td><p>StreamCapable</p></td><td><div><div><p><code>@StreamCapable()</code></p></div></div></td><td><div><div><p>Annotation that marks a parameter as stream capable, which means that this field will consume an array of objects in a forward-only manner. Examples of functions with <code>@StreamCapable</code> fields are <code>map</code>, <code>mapObject</code>, and <code>pluck</code>.</p></div></div></td></tr><tr><td><p>TailRec</p></td><td><div><div><p><code>@TailRec()</code></p></div></div></td><td><div><div><p>Annotation that marks a function as tail recursive. If a function with this annotation is not tail recursive, the function will fail.</p></div></div></td></tr><tr><td><p>UntrustedCode</p></td><td><div><div><p><code>@UntrustedCode(privileges: Array&lt;String&gt;)</code></p></div></div></td><td><div><div><p>Annotation that marks a script as untrusted, which means that the script has no privileges. For example, such a script cannot gain access to environment variables or read a resource from a URL.</p></div><div><p><em>Experimental:</em> This experimental feature is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr></tbody></table>

<!-- document id=9ccdd997946c4fe560022ff5257de51461ac5e5b13d009fa48852c36dd16369e url=/mulesoft/current/en-us/dataweave/latest/dw-core-annotations.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Core Annotations (dw::Core)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Annotation</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>AnnotationTarget</p></td><td><div><div><p><code>@AnnotationTarget(targets: Array&lt;"Function" | "Parameter" | "Variable" | "Import" | "Type" | "Version" | "Namespace" | "KeyType" | "TypeExpression" | "Expression" | "Annotation"&gt;)</code></p></div></div></td><td><div><div><p>Annotation that limits the application of an annotation. An example is <code>@AnnotationTarget(targets = ["Function", "Variable"])</code>, which limits the scope of the annotation <code>annotation TailRec()</code> to functions and variables. If no <code>AnnotationTarget</code> is specified, an annotation can apply to any valid target.</p></div><div><p>Annotation Targets:</p></div><div><ul><li><p><code>Parameter</code>: For function parameters.</p></li><li><p><code>Function</code>: For function definitions.</p></li><li><p><code>Variable</code>: For variable definitions.</p></li><li><p><code>Import</code>: For import definitions.</p></li></ul></div></div></td></tr><tr><td><p>Deprecated</p></td><td><div><div><p><code>@Deprecated(since: String, replacement: String)</code></p></div></div></td><td><div><div><p>Annotation that marks a function as deprecated.</p></div><div><p><em>Introduced in DataWeave version 2.4.0.</em></p></div></div></td></tr><tr><td><p>DesignOnlyType</p></td><td><div><div><p><code>@DesignOnlyType()</code></p></div></div></td><td><div><div><p>Annotation that marks a parameter type as <em>design only</em> to indicate that the field type is validated only at design time. At runtime, only minimal type validation takes place. This annotation is useful for performance, especially with complex Object types.</p></div></div></td></tr><tr><td><p>Experimental</p></td><td><div><div><p><code>@Experimental()</code></p></div></div></td><td><div><div><p>Annotation that identifies a feature as experimental and subject to change or removal in the future.</p></div><div><p><em>Introduced in DataWeave version 2.4.0.</em></p></div></div></td></tr><tr><td><p>GlobalDescription</p></td><td><div><div><p><code>@GlobalDescription()</code></p></div></div></td><td><div><div><p>Annotation used to identify the function description to use for the function’s documentation. This annotation is useful for selecting the correct function description when the function is overloaded.</p></div><div><p><em>Introduced in DataWeave version 2.4.0.</em></p></div></div></td></tr><tr><td><p>Interceptor</p></td><td><div><div><p><code>@Interceptor(interceptorFunction: String | (annotationArgs: Object, targetFunctionName: String, args: Array&lt;Any&gt;, callback: (args: Array&lt;Any&gt;) -&gt; Any) -&gt; Any)</code></p></div></div></td><td><div><div><p>Annotation that marks another annotation as an Interceptor so that the marked annotation will wrap an annotated function with an <code>interceptorFunction</code>. An example is the <code>RuntimePrivilege</code> annotation, which is annotated by <code>@Interceptor(interceptorFunction = "@native system::SecurityManagerCheckFunctionValue")</code>. The <code>readUrl</code> function definition is annotated by <code>@RuntimePrivilege(requires = "Resource")</code>.</p></div><div><p><em>Experimental:</em> This experimental feature is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>Internal</p></td><td><div><div><p><code>@Internal(permits: Array&lt;String&gt;)</code></p></div></div></td><td><div><div><p>Annotation that marks a function as <em>internal</em> and not to be used.</p></div><div><div><pre>_Introduced in DataWeave 2.4.0. Supported by Mule 4.4.0 and later._</pre></div></div><div><p><em>Experimental:</em> This experimental feature is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>Labels</p></td><td><div><div><p><code>@Labels(labels: Array&lt;String&gt;)</code></p></div></div></td><td><div><div><p>Annotation for labeling a function or variable definition so that it becomes more easy to discover. An example is <code>@Labels(labels =["append", "concat"])</code>.</p></div><div><p><em>Introduced in DataWeave version 2.4.0.</em></p></div></div></td></tr><tr><td><p>Lazy</p></td><td><div><div><p><code>@Lazy()</code></p></div></div></td><td><div><div><p>Annotation that marks a variable declaration for lazy initialization.</p></div><div><p><em>Introduced in DataWeave version 2.3.0.</em></p></div></div></td></tr><tr><td><p>Metadata</p></td><td><div><div><p><code>@Metadata(key: String)</code></p></div></div></td><td><div><div><p>Annotation used to mark annotations that represent metadata.</p></div><div><p><em>Introduced in DataWeave version 2.8.0.</em></p></div></div></td></tr><tr><td><p>RuntimePrivilege</p></td><td><div><div><p><code>@RuntimePrivilege(requires: String)</code></p></div></div></td><td><div><div><p>Annotation used to indicate that a function requires runtime privileges to execute. An example is <code>@RuntimePrivilege(requires = "Resource")</code>, which annotates the <code>readUrl</code> function definition.</p></div></div></td></tr><tr><td><p>Since</p></td><td><div><div><p><code>@Since(version: String)</code></p></div></div></td><td><div><div><p>Annotation that identifies the DataWeave version in which the annotated functionality was introduced. An example is <code>@Since(version = "2.4.0")</code>.</p></div><div><p><em>Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later.</em></p></div></div></td></tr><tr><td><p>StreamCapable</p></td><td><div><div><p><code>@StreamCapable()</code></p></div></div></td><td><div><div><p>Annotation that marks a parameter as stream capable, which means that this field will consume an array of objects in a forward-only manner. Examples of functions with <code>@StreamCapable</code> fields are <code>map</code>, <code>mapObject</code>, and <code>pluck</code>.</p></div></div></td></tr><tr><td><p>TailRec</p></td><td><div><div><p><code>@TailRec()</code></p></div></div></td><td><div><div><p>Annotation that marks a function as tail recursive. If a function with this annotation is not tail recursive, the function will fail.</p></div></div></td></tr><tr><td><p>UntrustedCode</p></td><td><div><div><p><code>@UntrustedCode(privileges: Array&lt;String&gt;)</code></p></div></div></td><td><div><div><p>Annotation that marks a script as untrusted, which means that the script has no privileges. For example, such a script cannot gain access to environment variables or read a resource from a URL.</p></div><div><p><em>Experimental:</em> This experimental feature is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>VisibleTo</p></td><td><div><div><p><code>@VisibleTo(components: Array&lt;String&gt;)</code></p></div></div></td><td><div><div><p>Annotation that marks an <code>internal</code> directive (<code>fun</code>, <code>var</code>, <code>type</code>, and <code>ns</code>) as visible to listed components in addition to its own component. Use it to share helpers across libraries you own without making them public. Component names must match the <code>name</code> field in the <code>META-INF/dw-components.dwl</code> descriptor.</p></div><div><p><code>@VisibleTo</code> is valid only on <code>internal</code> directives. Applying it to a <code>private</code> directive, or to a directive without a visibility keyword, produces a compile-time error.</p></div><div><p>Example:</p></div><div><div><pre><code>@VisibleTo(components = ["bat", "dataweave-io"])
internal fun nativeImpl() = ...</code></pre></div></div><div><p>For the full visibility model, see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-scope-visibility">Scope Visibility in DataWeave</a>.</p></div><div><p><em>Introduced in DataWeave version 2.12.0.</em></p></div><div><p><em>Experimental:</em> This experimental feature is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr></tbody></table>

<!-- document id=9c55da119098f522e3ce004134c8ffacf71eed0f27c2994e42e38a4cda664d11 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-namespaces.md -->

---
product: DataWeave
version: 2.11
---

# Core Namespaces (dw::Core)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Namespace</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>xsi</p></td><td><div><div><p><code>xsi = http://www.w3.org/2001/XMLSchema-instance</code></p></div></div></td><td><div><div><p>Namespace declaration of XMLSchema.</p></div></div></td></tr></tbody></table>

<!-- document id=af4dbac4197bfbbf0ce214796be2c77a8543787bc6b9ba451f118fa7a2c9207c url=/mulesoft/current/en-us/dataweave/2.12/dw-core-namespaces.md -->

---
product: DataWeave
version: 2.12
---

# Core Namespaces (dw::Core)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Namespace</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>xsi</p></td><td><div><div><p><code>xsi = http://www.w3.org/2001/XMLSchema-instance</code></p></div></div></td><td><div><div><p>Namespace declaration of XMLSchema.</p></div></div></td></tr></tbody></table>

<!-- document id=0ca64b19b38c52682d881ff50817aea54519fb13c2f35197cb337bb36a6a0421 url=/mulesoft/current/en-us/dataweave/2.3/dw-core-namespaces.md -->

---
product: DataWeave
version: 2.3
---

# Core Namespaces (dw::Core)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Namespace</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>xsi</p></td><td><p><code>xsi =</code> <code>http://www.w3.org/2001/XMLSchema-instance</code></p></td><td><p>Namespace declaration of XMLSchema.</p></td></tr></tbody></table>

<!-- document id=e07ddf803536ea38e5ded6970564ca2310316cee2d336ee040ff88df60294cd9 url=/mulesoft/current/en-us/dataweave/2.4/dw-core-namespaces.md -->

---
product: DataWeave
version: 2.4
---

# Core Namespaces (dw::Core)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Namespace</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>xsi</p></td><td><div><div><p><code>xsi = http://www.w3.org/2001/XMLSchema-instance</code></p></div></div></td><td><div><div><p>Namespace declaration of XMLSchema.</p></div></div></td></tr></tbody></table>

<!-- document id=cab61e0eacd55033561f4d80fd2742073a6a3919e71098e8655937d8dcb205f4 url=/mulesoft/current/en-us/dataweave/2.6/dw-core-namespaces.md -->

---
product: DataWeave
version: 2.6
---

# Core Namespaces (dw::Core)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Namespace</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>xsi</p></td><td><div><div><p><code>xsi = http://www.w3.org/2001/XMLSchema-instance</code></p></div></div></td><td><div><div><p>Namespace declaration of XMLSchema.</p></div></div></td></tr></tbody></table>

<!-- document id=cff784b1ade4edb19ff02983cd793401f6d341cb1e8a72cb0cbd79797ededa47 url=/mulesoft/current/en-us/dataweave/2.9/dw-core-namespaces.md -->

---
product: DataWeave
version: 2.9
---

# Core Namespaces (dw::Core)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Namespace</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>xsi</p></td><td><div><div><p><code>xsi = http://www.w3.org/2001/XMLSchema-instance</code></p></div></div></td><td><div><div><p>Namespace declaration of XMLSchema.</p></div></div></td></tr></tbody></table>

<!-- document id=3cb110913b361ba0c90baadaec3342c9ae6fa2acaf0aa912720063767afad992 url=/mulesoft/current/en-us/dataweave/latest/dw-core-namespaces.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Core Namespaces (dw::Core)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Namespace</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>xsi</p></td><td><div><div><p><code>xsi = http://www.w3.org/2001/XMLSchema-instance</code></p></div></div></td><td><div><div><p>Namespace declaration of XMLSchema.</p></div></div></td></tr></tbody></table>

<!-- document id=5c28eff35ede097e91cd84c64bcfe4d1c070ef3c6f4ee5560b35a5786ef65f21 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-types.md -->

---
product: DataWeave
version: 2.11
---

# Core Types (dw::Core)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>Any</p></td><td><div><div><p><code>type Any = Any</code></p></div></div></td><td><div><div><p>The top-level type. <code>Any</code> extends all of the system types, which means that anything can be assigned to a <code>Any</code> typed variable.</p></div></div></td></tr><tr><td><p>Array</p></td><td><div><div><p><code>type Array = Array</code></p></div></div></td><td><div><div><p>Array type that requires a <code>Type(T)</code> to represent the elements of the list. Example: <code>Array&lt;Number&gt;</code> represents an array of numbers, and <code>Array&lt;Any&gt;</code> represents an array of any type.</p></div><div><p>Example: <code>[1, 2, "a", "b", true, false, { a : "b"}, [1, 2, 3] ]</code></p></div></div></td></tr><tr><td><p>Binary</p></td><td><div><div><p><code>type Binary = Binary</code></p></div></div></td><td><div><div><p>A blob.</p></div></div></td></tr><tr><td><p>Boolean</p></td><td><div><div><p><code>type Boolean = Boolean</code></p></div></div></td><td><div><div><p>A <code>Boolean</code> type of <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p>CData</p></td><td><div><div><p><code>type CData = String {cdata: true}</code></p></div></div></td><td><div><div><p>XML defines a <code>CData</code> custom type that extends from <code>String</code> and is used to identify a CDATA XML block.</p></div><div><p>It can be used to tell the writer to wrap the content inside CDATA or to check if the string arrives inside a CDATA block. <code>CData</code> inherits from the type <code>String</code>.</p></div><div><p><strong>Source</strong>:</p></div><div><p><code>output application/xml --- { "user" : "Shoki" as CData }</code></p></div><div><p><strong>Output</strong>:</p></div><div><p><code>&lt;?xml version="1.0" encoding="UTF-8"?&gt;&lt;user&gt;&lt;![CDATA[Shoki]]&gt;&lt;/user&gt;</code></p></div></div></td></tr><tr><td><p>Comparable</p></td><td><div><div><p><code>type Comparable = String | Number | Boolean | DateTime | LocalDateTime | Date | LocalTime | Time | TimeZone</code></p></div></div></td><td><div><div><p>A union type that represents all the types that can be compared to each other.</p></div></div></td></tr><tr><td><p>Date</p></td><td><div><div><p><code>type Date = Date</code></p></div></div></td><td><div><div><p>A date represented by a year, month, and day. For example: <code>|2018-09-17|</code></p></div></div></td></tr><tr><td><p>DateTime</p></td><td><div><div><p><code>type DateTime = DateTime</code></p></div></div></td><td><div><div><p>A <code>Date</code> and <code>Time</code> within a <code>TimeZone</code>. For example: <code>|2018-09-17T22:13:00Z|</code></p></div></div></td></tr><tr><td><p>Dictionary</p></td><td><div><div><p><code>type Dictionary = { _?: T }</code></p></div></div></td><td><div><div><p>Generic dictionary interface.</p></div></div></td></tr><tr><td><p>Enum</p></td><td><div><div><p><code>type Enum = String {enumeration: true}</code></p></div></div></td><td><div><div><p>This type is based on the <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html">Enum Java class</a>.</p></div><div><p>It must always be used with the <code>class</code> property, specifying the full Java class name of the class, as shown in the example below.</p></div><div><p><strong>Source:</strong></p></div><div><p><code>"Max" as Enum {class: "com.acme.MuleyEnum"}</code></p></div></div></td></tr><tr><td><p>Iterator</p></td><td><div><div><p><code>type Iterator = Array {iterator: true}</code></p></div></div></td><td><div><div><p>This type is based on the <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html">iterator Java class</a>. The iterator contains a collection and includes methods to iterate through and filter it.</p></div><div><p>Just like the Java class, <code>Iterator</code> is designed to be consumed only once. For example, if you pass it to a <a href="https://docs.mulesoft.com/mule-runtime/latest/logger-component-reference">Logger component</a>, the Logger consumes it, so it becomes unreadable by further elements in the flow.</p></div></div></td></tr><tr><td><p>Key</p></td><td><div><div><p><code>type Key = Key</code></p></div></div></td><td><div><div><p>A key of an <code>Object</code>.</p></div><div><p>Examples: <code>{ myKey : "a value" }</code>, <code>{ myKey : { a : 1, b : 2} }</code>, <code>{ myKey : [1,2,3,4] }</code></p></div></div></td></tr><tr><td><p>LocalDateTime</p></td><td><div><div><p><code>type LocalDateTime = LocalDateTime</code></p></div></div></td><td><div><div><p>A <code>DateTime</code> in the current <code>TimeZone</code>. For example: <code>|2018-09-17T22:13:00|</code></p></div></div></td></tr><tr><td><p>LocalTime</p></td><td><div><div><p><code>type LocalTime = LocalTime</code></p></div></div></td><td><div><div><p>A <code>Time</code> in the current <code>TimeZone</code>. For example: <code>|22:10:18|</code></p></div></div></td></tr><tr><td><p>LogLevel</p></td><td><div><div><p><code>type LogLevel = "Debug" | "Info" | "Warn" | "Error"</code></p></div></div></td><td><div><div><p>A type that represents the severity level of logging operations. For example: <code>Debug</code>, <code>Info</code>, <code>Warn</code>, <code>Error</code>.</p></div></div></td></tr><tr><td><p>NaN</p></td><td><div><div><p><code>type NaN = Null {NaN: true}</code></p></div></div></td><td><div><div><p><code>java.lang.Float</code> and <code>java.lang.Double</code> have special cases for <code>NaN</code> and <code>Infinit</code>. DataWeave does not have these concepts for its number multi-precision nature. So when it is mapped to DataWeave values, it is wrapped in a Null with a Schema marker.</p></div></div></td></tr><tr><td><p>Namespace</p></td><td><div><div><p><code>type Namespace = Namespace</code></p></div></div></td><td><div><div><p>A <code>Namespace</code> type represented by a <code>URI</code> and a prefix.</p></div></div></td></tr><tr><td><p>Nothing</p></td><td><div><div><p><code>type Nothing = Nothing</code></p></div></div></td><td><div><div><p>Bottom type. This type can be assigned to all the types.</p></div></div></td></tr><tr><td><p>Null</p></td><td><div><div><p><code>type Null = Null</code></p></div></div></td><td><div><div><p>A Null type, which represents the <code>null</code> value.</p></div></div></td></tr><tr><td><p>Number</p></td><td><div><div><p><code>type Number = Number</code></p></div></div></td><td><div><div><p>A number type: Any number, decimal, or integer is represented by the Number` type.</p></div></div></td></tr><tr><td><p>Object</p></td><td><div><div><p><code>type Object = Object</code></p></div></div></td><td><div><div><p>Type that represents any object, which is a collection of <code>Key</code> and value pairs.</p></div><div><p>Examples: <code>{ myKey : "a value" }</code>, <code>{ myKey : { a : 1, b : 2} }</code>, <code>{ myKey : [1,2,3,4] }</code></p></div></div></td></tr><tr><td><p>Pair</p></td><td><div><div><p><code>type Pair = { l: LEFT, r: RIGHT }</code></p></div></div></td><td><div><div><p>A type used to represent a pair of values.</p></div><div><p><em>Introduced in DataWeave version 2.2.0.</em></p></div></div></td></tr><tr><td><p>Period</p></td><td><div><div><p><code>type Period = Period</code></p></div></div></td><td><div><div><p>A period.</p></div></div></td></tr><tr><td><p>Range</p></td><td><div><div><p><code>type Range = Range</code></p></div></div></td><td><div><div><p>A <code>Range</code> type represents a sequence of numbers.</p></div></div></td></tr><tr><td><p>Regex</p></td><td><div><div><p><code>type Regex = Regex</code></p></div></div></td><td><div><div><p>A Java regular expression (regex) type.</p></div></div></td></tr><tr><td><p>Result</p></td><td><div><div><p><code>type Result = { success: true, result: T } | { success: false, error: E }</code></p></div></div></td><td><div><div><p>A type for representing an execution result.</p></div><div><p>Supports the following fields:</p></div><div><ul><li><p><code>success</code>: Determine if the execution ends successfully. If <code>true</code>, the data type provides the <code>result</code>. If <code>false</code>, the data type provides the <code>error</code>.</p></li><li><p><code>result</code>: The success result data.</p></li><li><p><code>error</code>: The error data.</p></li></ul></div><div><p><em>Introduced in DataWeave version 2.7.0.</em></p></div></div></td></tr><tr><td><p>SimpleType</p></td><td><div><div><p><code>type SimpleType = String | Boolean | Number | DateTime | LocalDateTime | Date | LocalTime | Time | TimeZone | Period</code></p></div></div></td><td><div><div><p>A union type that represents all the simple types.</p></div></div></td></tr><tr><td><p>String</p></td><td><div><div><p><code>type String = String</code></p></div></div></td><td><div><div><p><code>String</code> type</p></div></div></td></tr><tr><td><p>StringCoerceable</p></td><td><div><div><p><code>type StringCoerceable = String | Boolean | Number | DateTime | LocalDateTime | Date | LocalTime | Time | TimeZone | Period | Key | Binary | Uri | Type&lt;Any&gt; | Regex | Namespace</code></p></div></div></td><td><div><div><p>A union type of all the types that can be coerced to String type.</p></div><div><p><em>Introduced in DataWeave version 2.3.0.</em></p></div></div></td></tr><tr><td><p>Time</p></td><td><div><div><p><code>type Time = Time</code></p></div></div></td><td><div><div><p>A time in a specific <code>TimeZone</code>. For example: <code>|22:10:18Z|</code></p></div></div></td></tr><tr><td><p>TimeZone</p></td><td><div><div><p><code>type TimeZone = TimeZone</code></p></div></div></td><td><div><div><p>A time zone.</p></div></div></td></tr><tr><td><p>Type</p></td><td><div><div><p><code>type Type = Type</code></p></div></div></td><td><div><div><p>A type in the DataWeave type system.</p></div></div></td></tr><tr><td><p>Uri</p></td><td><div><div><p><code>type Uri = Uri</code></p></div></div></td><td><div><div><p>A URI.</p></div></div></td></tr></tbody></table>

<!-- document id=379da10ecb2aaca6d371bcf2ce9297dd21901337ae7c09533b352d9f70ada4f7 url=/mulesoft/current/en-us/dataweave/2.12/dw-core-types.md -->

---
product: DataWeave
version: 2.12
---

# Core Types (dw::Core)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>Any</p></td><td><div><div><p><code>type Any = Any</code></p></div></div></td><td><div><div><p>The top-level type. <code>Any</code> extends all of the system types, which means that anything can be assigned to a <code>Any</code> typed variable.</p></div></div></td></tr><tr><td><p>Array</p></td><td><div><div><p><code>type Array = Array</code></p></div></div></td><td><div><div><p>Array type that requires a <code>Type(T)</code> to represent the elements of the list. Example: <code>Array&lt;Number&gt;</code> represents an array of numbers, and <code>Array&lt;Any&gt;</code> represents an array of any type.</p></div><div><p>Example: <code>[1, 2, "a", "b", true, false, { a : "b"}, [1, 2, 3] ]</code></p></div></div></td></tr><tr><td><p>Binary</p></td><td><div><div><p><code>type Binary = Binary</code></p></div></div></td><td><div><div><p>A blob.</p></div></div></td></tr><tr><td><p>Boolean</p></td><td><div><div><p><code>type Boolean = Boolean</code></p></div></div></td><td><div><div><p>A <code>Boolean</code> type of <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p>CData</p></td><td><div><div><p><code>type CData = String {cdata: true}</code></p></div></div></td><td><div><div><p>XML defines a <code>CData</code> custom type that extends from <code>String</code> and is used to identify a CDATA XML block.</p></div><div><p>It can be used to tell the writer to wrap the content inside CDATA or to check if the string arrives inside a CDATA block. <code>CData</code> inherits from the type <code>String</code>.</p></div><div><p><strong>Source</strong>:</p></div><div><p><code>output application/xml --- { "user" : "Shoki" as CData }</code></p></div><div><p><strong>Output</strong>:</p></div><div><p><code>&lt;?xml version="1.0" encoding="UTF-8"?&gt;&lt;user&gt;&lt;![CDATA[Shoki]]&gt;&lt;/user&gt;</code></p></div></div></td></tr><tr><td><p>Comparable</p></td><td><div><div><p><code>type Comparable = String | Number | Boolean | DateTime | LocalDateTime | Date | LocalTime | Time | TimeZone</code></p></div></div></td><td><div><div><p>A union type that represents all the types that can be compared to each other.</p></div></div></td></tr><tr><td><p>Date</p></td><td><div><div><p><code>type Date = Date</code></p></div></div></td><td><div><div><p>A date represented by a year, month, and day. For example: <code>|2018-09-17|</code></p></div></div></td></tr><tr><td><p>DateTime</p></td><td><div><div><p><code>type DateTime = DateTime</code></p></div></div></td><td><div><div><p>A <code>Date</code> and <code>Time</code> within a <code>TimeZone</code>. For example: <code>|2018-09-17T22:13:00Z|</code></p></div></div></td></tr><tr><td><p>Dictionary</p></td><td><div><div><p><code>type Dictionary = { _?: T }</code></p></div></div></td><td><div><div><p>Generic dictionary interface.</p></div></div></td></tr><tr><td><p>Enum</p></td><td><div><div><p><code>type Enum = String {enumeration: true}</code></p></div></div></td><td><div><div><p>This type is based on the <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html">Enum Java class</a>.</p></div><div><p>It must always be used with the <code>class</code> property, specifying the full Java class name of the class, as shown in the example below.</p></div><div><p><strong>Source:</strong></p></div><div><p><code>"Max" as Enum {class: "com.acme.MuleyEnum"}</code></p></div></div></td></tr><tr><td><p>Iterator</p></td><td><div><div><p><code>type Iterator = Array {iterator: true}</code></p></div></div></td><td><div><div><p>This type is based on the <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html">iterator Java class</a>. The iterator contains a collection and includes methods to iterate through and filter it.</p></div><div><p>Just like the Java class, <code>Iterator</code> is designed to be consumed only once. For example, if you pass it to a <a href="https://docs.mulesoft.com/mule-runtime/latest/logger-component-reference">Logger component</a>, the Logger consumes it, so it becomes unreadable by further elements in the flow.</p></div></div></td></tr><tr><td><p>Key</p></td><td><div><div><p><code>type Key = Key</code></p></div></div></td><td><div><div><p>A key of an <code>Object</code>.</p></div><div><p>Examples: <code>{ myKey : "a value" }</code>, <code>{ myKey : { a : 1, b : 2} }</code>, <code>{ myKey : [1,2,3,4] }</code></p></div></div></td></tr><tr><td><p>LocalDateTime</p></td><td><div><div><p><code>type LocalDateTime = LocalDateTime</code></p></div></div></td><td><div><div><p>A <code>DateTime</code> in the current <code>TimeZone</code>. For example: <code>|2018-09-17T22:13:00|</code></p></div></div></td></tr><tr><td><p>LocalTime</p></td><td><div><div><p><code>type LocalTime = LocalTime</code></p></div></div></td><td><div><div><p>A <code>Time</code> in the current <code>TimeZone</code>. For example: <code>|22:10:18|</code></p></div></div></td></tr><tr><td><p>LogLevel</p></td><td><div><div><p><code>type LogLevel = "Debug" | "Info" | "Warn" | "Error"</code></p></div></div></td><td><div><div><p>A type that represents the severity level of logging operations. For example: <code>Debug</code>, <code>Info</code>, <code>Warn</code>, <code>Error</code>.</p></div></div></td></tr><tr><td><p>NaN</p></td><td><div><div><p><code>type NaN = Null {NaN: true}</code></p></div></div></td><td><div><div><p><code>java.lang.Float</code> and <code>java.lang.Double</code> have special cases for <code>NaN</code> and <code>Infinit</code>. DataWeave does not have these concepts for its number multi-precision nature. So when it is mapped to DataWeave values, it is wrapped in a Null with a Schema marker.</p></div></div></td></tr><tr><td><p>Namespace</p></td><td><div><div><p><code>type Namespace = Namespace</code></p></div></div></td><td><div><div><p>A <code>Namespace</code> type represented by a <code>URI</code> and a prefix.</p></div></div></td></tr><tr><td><p>Nothing</p></td><td><div><div><p><code>type Nothing = Nothing</code></p></div></div></td><td><div><div><p>Bottom type. This type can be assigned to all the types.</p></div></div></td></tr><tr><td><p>Null</p></td><td><div><div><p><code>type Null = Null</code></p></div></div></td><td><div><div><p>A Null type, which represents the <code>null</code> value.</p></div></div></td></tr><tr><td><p>Number</p></td><td><div><div><p><code>type Number = Number</code></p></div></div></td><td><div><div><p>A number type: Any number, decimal, or integer is represented by the Number` type.</p></div></div></td></tr><tr><td><p>Object</p></td><td><div><div><p><code>type Object = Object</code></p></div></div></td><td><div><div><p>Type that represents any object, which is a collection of <code>Key</code> and value pairs.</p></div><div><p>Examples: <code>{ myKey : "a value" }</code>, <code>{ myKey : { a : 1, b : 2} }</code>, <code>{ myKey : [1,2,3,4] }</code></p></div></div></td></tr><tr><td><p>Pair</p></td><td><div><div><p><code>type Pair = { l: LEFT, r: RIGHT }</code></p></div></div></td><td><div><div><p>A type used to represent a pair of values.</p></div><div><p><em>Introduced in DataWeave version 2.2.0.</em></p></div></div></td></tr><tr><td><p>Period</p></td><td><div><div><p><code>type Period = Period</code></p></div></div></td><td><div><div><p>A period.</p></div></div></td></tr><tr><td><p>Range</p></td><td><div><div><p><code>type Range = Range</code></p></div></div></td><td><div><div><p>A <code>Range</code> type represents a sequence of numbers.</p></div></div></td></tr><tr><td><p>Regex</p></td><td><div><div><p><code>type Regex = Regex</code></p></div></div></td><td><div><div><p>A Java regular expression (regex) type.</p></div></div></td></tr><tr><td><p>Result</p></td><td><div><div><p><code>type Result = { success: true, result: T } | { success: false, error: E }</code></p></div></div></td><td><div><div><p>A type for representing an execution result.</p></div><div><p>Supports the following fields:</p></div><div><ul><li><p><code>success</code>: Determine if the execution ends successfully. If <code>true</code>, the data type provides the <code>result</code>. If <code>false</code>, the data type provides the <code>error</code>.</p></li><li><p><code>result</code>: The success result data.</p></li><li><p><code>error</code>: The error data.</p></li></ul></div><div><p><em>Introduced in DataWeave version 2.7.0.</em></p></div></div></td></tr><tr><td><p>SimpleType</p></td><td><div><div><p><code>type SimpleType = String | Boolean | Number | DateTime | LocalDateTime | Date | LocalTime | Time | TimeZone | Period</code></p></div></div></td><td><div><div><p>A union type that represents all the simple types.</p></div></div></td></tr><tr><td><p>String</p></td><td><div><div><p><code>type String = String</code></p></div></div></td><td><div><div><p><code>String</code> type</p></div></div></td></tr><tr><td><p>StringCoerceable</p></td><td><div><div><p><code>type StringCoerceable = String | Boolean | Number | DateTime | LocalDateTime | Date | LocalTime | Time | TimeZone | Period | Key | Binary | Uri | Type&lt;Any&gt; | Regex | Namespace</code></p></div></div></td><td><div><div><p>A union type of all the types that can be coerced to String type.</p></div><div><p><em>Introduced in DataWeave version 2.3.0.</em></p></div></div></td></tr><tr><td><p>Time</p></td><td><div><div><p><code>type Time = Time</code></p></div></div></td><td><div><div><p>A time in a specific <code>TimeZone</code>. For example: <code>|22:10:18Z|</code></p></div></div></td></tr><tr><td><p>TimeZone</p></td><td><div><div><p><code>type TimeZone = TimeZone</code></p></div></div></td><td><div><div><p>A time zone.</p></div></div></td></tr><tr><td><p>Type</p></td><td><div><div><p><code>type Type = Type</code></p></div></div></td><td><div><div><p>A type in the DataWeave type system.</p></div></div></td></tr><tr><td><p>Uri</p></td><td><div><div><p><code>type Uri = Uri</code></p></div></div></td><td><div><div><p>A URI.</p></div></div></td></tr></tbody></table>

<!-- document id=6976366ca8c82ac801eacf4aa6bf24607c13c1918daab0c17f48eacc8070596f url=/mulesoft/current/en-us/dataweave/2.3/dw-core-types.md -->

---
product: DataWeave
version: 2.3
---

# Core Types (dw::Core)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>Any</p></td><td><p><code>type Any = Any</code></p></td><td><p>The top-level type. <code>Any</code> extends all of the system types, which means that anything can be assigned to a <code>Any</code> typed variable.</p></td></tr><tr><td><p>Array</p></td><td><p><code>type Array = Array</code></p></td><td><p>Array type that requires a <code>Type(T)</code> to represent the elements of the list. Example: <code>Array&lt;Number&gt;</code> represents an array of numbers, and <code>Array&lt;Any&gt;</code> represents an array of any type.</p><p>Example: <code>[1, 2, "a", "b", true, false, { a : "b"}, [1, 2, 3] ]</code></p></td></tr><tr><td><p>Binary</p></td><td><p><code>type Binary = Binary</code></p></td><td><p>A blob.</p></td></tr><tr><td><p>Boolean</p></td><td><p><code>type Boolean = Boolean</code></p></td><td><p>A <code>Boolean</code> type of <code>true</code> or <code>false</code>.</p></td></tr><tr><td><p>CData</p></td><td><p><code>type CData = String {cdata: true}</code></p></td><td><p>XML defines a <code>CData</code> custom type that extends from <code>String</code> and is used to identify a CDATA XML block.</p><p>It can be used to tell the writer to wrap the content inside CDATA or to check if the string arrives inside a CDATA block. <code>CData</code> inherits from the type <code>String</code>.</p><p><strong>Source</strong>:</p><p><code>output application/xml --- { "user" : "Shoki" as CData }</code></p><p><strong>Output</strong>:</p><p><code>&lt;?xml version="1.0" encoding="UTF-8"?&gt;&lt;user&gt;&lt;![CDATA[Shoki]]&gt;&lt;/user&gt;</code></p></td></tr><tr><td><p>Comparable</p></td><td><p><code>type Comparable = String | Number | Boolean | DateTime | LocalDateTime | Date | LocalTime | Time | TimeZone</code></p></td><td><p>A union type that represents all the types that can be compared to each other.</p></td></tr><tr><td><p>Date</p></td><td><p><code>type Date = Date</code></p></td><td><p>A date represented by a year, month, and day. For example: <code>|2018-09-17|</code></p></td></tr><tr><td><p>DateTime</p></td><td><p><code>type DateTime = DateTime</code></p></td><td><p>A <code>Date</code> and <code>Time</code> within a <code>TimeZone</code>. For example: <code>|2018-09-17T22:13:00Z|</code></p></td></tr><tr><td><p>Dictionary</p></td><td><p><code>type Dictionary = { _?: T }</code></p></td><td><p>Generic dictionary interface.</p></td></tr><tr><td><p>Enum</p></td><td><p><code>type Enum = String {enumeration: true}</code></p></td><td><p>This type is based on the <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html">Enum Java class</a>.</p><p>It must always be used with the <code>class</code> property, specifying the full Java class name of the class, as shown in the example below.</p><p><strong>Source:</strong></p><p><code>"Max" as Enum {class: "com.acme.MuleyEnum"}</code></p></td></tr><tr><td><p>Iterator</p></td><td><p><code>type Iterator = Array {iterator: true}</code></p></td><td><p>This type is based on the <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html">iterator Java class</a>. The iterator contains a collection and includes methods to iterate through and filter it.</p><p>Just like the Java class, <code>Iterator</code> is designed to be consumed only once. For example, if you pass it to a <a href="https://docs.mulesoft.com/mule-runtime/4.3/logger-component-reference">Logger component</a>, the Logger consumes it, so it becomes unreadable by further elements in the flow.</p></td></tr><tr><td><p>Key</p></td><td><p><code>type Key = Key</code></p></td><td><p>A key of an <code>Object</code>.</p><p>Examples: <code>{ myKey : "a value" }</code>, <code>{ myKey : { a : 1, b : 2} }</code>, <code>{ myKey : [1,2,3,4] }</code></p></td></tr><tr><td><p>LocalDateTime</p></td><td><p><code>type LocalDateTime = LocalDateTime</code></p></td><td><p>A <code>DateTime</code> in the current <code>TimeZone</code>. For example: <code>|2018-09-17T22:13:00|</code></p></td></tr><tr><td><p>LocalTime</p></td><td><p><code>type LocalTime = LocalTime</code></p></td><td><p>A <code>Time</code> in the current <code>TimeZone</code>. For example: <code>|22:10:18|</code></p></td></tr><tr><td><p>NaN</p></td><td><p><code>type NaN = Null {NaN: true}</code></p></td><td><p><code>java.lang.Float</code> and <code>java.lang.Double</code> have special cases for <code>NaN</code> and <code>Infinit</code>. DataWeave does not have these concepts for its number multi-precision nature. So when it is mapped to DataWeave values, it is wrapped in a Null with a Schema marker.</p></td></tr><tr><td><p>Namespace</p></td><td><p><code>type Namespace = Namespace</code></p></td><td><p>A <code>Namespace</code> type represented by a <code>URI</code> and a prefix.</p></td></tr><tr><td><p>Nothing</p></td><td><p><code>type Nothing = Nothing</code></p></td><td><p>Bottom type. This type can be assigned to all the types.</p></td></tr><tr><td><p>Null</p></td><td><p><code>type Null = Null</code></p></td><td><p>A Null type.</p></td></tr><tr><td><p>Number</p></td><td><p><code>type Number = Number</code></p></td><td><p>A number type: Any number, decimal, or integer is represented by the Number` type.</p></td></tr><tr><td><p>Object</p></td><td><p><code>type Object = Object</code></p></td><td><p>Type that represents any object, which is a collection of <code>Key</code> and value pairs.</p><p>Examples: <code>{ myKey : "a value" }</code>, <code>{ myKey : { a : 1, b : 2} }</code>, <code>{ myKey : [1,2,3,4] }</code></p></td></tr><tr><td><p>Pair</p></td><td><p><code>type Pair = { l: LEFT, r: RIGHT }</code></p></td><td><p>A type used to represent a pair of values.</p><p><em>Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later.</em></p></td></tr><tr><td><p>Period</p></td><td><p><code>type Period = Period</code></p></td><td><p>A period.</p></td></tr><tr><td><p>Range</p></td><td><p><code>type Range = Range</code></p></td><td><p>A <code>Range</code> type represents a sequence of numbers.</p></td></tr><tr><td><p>Regex</p></td><td><p><code>type Regex = Regex</code></p></td><td><p>A Java regular expression (regex) type.</p></td></tr><tr><td><p>SimpleType</p></td><td><p><code>type SimpleType = String | Boolean | Number | DateTime | LocalDateTime | Date | LocalTime | Time | TimeZone | Period</code></p></td><td><p>A union type that represents all the simple types.</p></td></tr><tr><td><p>String</p></td><td><p><code>type String = String</code></p></td><td><p><code>String</code> type</p></td></tr><tr><td><p>StringCoerceable</p></td><td><p><code>type StringCoerceable = String | Boolean | Number | DateTime | LocalDateTime | Date | LocalTime | Time | TimeZone | Period | Key | Binary | Uri | Type&lt;Any&gt; | Regex | Namespace</code></p></td><td><p>A union type of all the types that can be coerced to String type.</p><p><em>Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later.</em></p></td></tr><tr><td><p>Time</p></td><td><p><code>type Time = Time</code></p></td><td><p>A time in a specific <code>TimeZone</code>. For example: <code>|22:10:18Z|</code></p></td></tr><tr><td><p>TimeZone</p></td><td><p><code>type TimeZone = TimeZone</code></p></td><td><p>A time zone.</p></td></tr><tr><td><p>Type</p></td><td><p><code>type Type = Type</code></p></td><td><p>A type in the DataWeave type system.</p></td></tr><tr><td><p>Uri</p></td><td><p><code>type Uri = Uri</code></p></td><td><p>A URI.</p></td></tr></tbody></table>

<!-- document id=27db37095480f1f7ccbc344e935d1d4a177d108d88aee59532bb9fe5a9a50786 url=/mulesoft/current/en-us/dataweave/2.4/dw-core-types.md -->

---
product: DataWeave
version: 2.4
---

# Core Types (dw::Core)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>Any</p></td><td><div><div><p><code>type Any = Any</code></p></div></div></td><td><div><div><p>The top-level type. <code>Any</code> extends all of the system types, which means that anything can be assigned to a <code>Any</code> typed variable.</p></div></div></td></tr><tr><td><p>Array</p></td><td><div><div><p><code>type Array = Array</code></p></div></div></td><td><div><div><p>Array type that requires a <code>Type(T)</code> to represent the elements of the list. Example: <code>Array&lt;Number&gt;</code> represents an array of numbers, and <code>Array&lt;Any&gt;</code> represents an array of any type.</p></div><div><p>Example: <code>[1, 2, "a", "b", true, false, { a : "b"}, [1, 2, 3] ]</code></p></div></div></td></tr><tr><td><p>Binary</p></td><td><div><div><p><code>type Binary = Binary</code></p></div></div></td><td><div><div><p>A blob.</p></div></div></td></tr><tr><td><p>Boolean</p></td><td><div><div><p><code>type Boolean = Boolean</code></p></div></div></td><td><div><div><p>A <code>Boolean</code> type of <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p>CData</p></td><td><div><div><p><code>type CData = String {cdata: true}</code></p></div></div></td><td><div><div><p>XML defines a <code>CData</code> custom type that extends from <code>String</code> and is used to identify a CDATA XML block.</p></div><div><p>It can be used to tell the writer to wrap the content inside CDATA or to check if the string arrives inside a CDATA block. <code>CData</code> inherits from the type <code>String</code>.</p></div><div><p><strong>Source</strong>:</p></div><div><p><code>output application/xml --- { "user" : "Shoki" as CData }</code></p></div><div><p><strong>Output</strong>:</p></div><div><p><code>&lt;?xml version="1.0" encoding="UTF-8"?&gt;&lt;user&gt;&lt;![CDATA[Shoki]]&gt;&lt;/user&gt;</code></p></div></div></td></tr><tr><td><p>Comparable</p></td><td><div><div><p><code>type Comparable = String | Number | Boolean | DateTime | LocalDateTime | Date | LocalTime | Time | TimeZone</code></p></div></div></td><td><div><div><p>A union type that represents all the types that can be compared to each other.</p></div></div></td></tr><tr><td><p>Date</p></td><td><div><div><p><code>type Date = Date</code></p></div></div></td><td><div><div><p>A date represented by a year, month, and day. For example: <code>|2018-09-17|</code></p></div></div></td></tr><tr><td><p>DateTime</p></td><td><div><div><p><code>type DateTime = DateTime</code></p></div></div></td><td><div><div><p>A <code>Date</code> and <code>Time</code> within a <code>TimeZone</code>. For example: <code>|2018-09-17T22:13:00Z|</code></p></div></div></td></tr><tr><td><p>Dictionary</p></td><td><div><div><p><code>type Dictionary = { _?: T }</code></p></div></div></td><td><div><div><p>Generic dictionary interface.</p></div></div></td></tr><tr><td><p>Enum</p></td><td><div><div><p><code>type Enum = String {enumeration: true}</code></p></div></div></td><td><div><div><p>This type is based on the <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html">Enum Java class</a>.</p></div><div><p>It must always be used with the <code>class</code> property, specifying the full Java class name of the class, as shown in the example below.</p></div><div><p><strong>Source:</strong></p></div><div><p><code>"Max" as Enum {class: "com.acme.MuleyEnum"}</code></p></div></div></td></tr><tr><td><p>Iterator</p></td><td><div><div><p><code>type Iterator = Array {iterator: true}</code></p></div></div></td><td><div><div><p>This type is based on the <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html">iterator Java class</a>. The iterator contains a collection and includes methods to iterate through and filter it.</p></div><div><p>Just like the Java class, <code>Iterator</code> is designed to be consumed only once. For example, if you pass it to a <a href="https://docs.mulesoft.com/mule-runtime/latest/logger-component-reference">Logger component</a>, the Logger consumes it, so it becomes unreadable by further elements in the flow.</p></div></div></td></tr><tr><td><p>Key</p></td><td><div><div><p><code>type Key = Key</code></p></div></div></td><td><div><div><p>A key of an <code>Object</code>.</p></div><div><p>Examples: <code>{ myKey : "a value" }</code>, <code>{ myKey : { a : 1, b : 2} }</code>, <code>{ myKey : [1,2,3,4] }</code></p></div></div></td></tr><tr><td><p>LocalDateTime</p></td><td><div><div><p><code>type LocalDateTime = LocalDateTime</code></p></div></div></td><td><div><div><p>A <code>DateTime</code> in the current <code>TimeZone</code>. For example: <code>|2018-09-17T22:13:00|</code></p></div></div></td></tr><tr><td><p>LocalTime</p></td><td><div><div><p><code>type LocalTime = LocalTime</code></p></div></div></td><td><div><div><p>A <code>Time</code> in the current <code>TimeZone</code>. For example: <code>|22:10:18|</code></p></div></div></td></tr><tr><td><p>NaN</p></td><td><div><div><p><code>type NaN = Null {NaN: true}</code></p></div></div></td><td><div><div><p><code>java.lang.Float</code> and <code>java.lang.Double</code> have special cases for <code>NaN</code> and <code>Infinit</code>. DataWeave does not have these concepts for its number multi-precision nature. So when it is mapped to DataWeave values, it is wrapped in a Null with a Schema marker.</p></div></div></td></tr><tr><td><p>Namespace</p></td><td><div><div><p><code>type Namespace = Namespace</code></p></div></div></td><td><div><div><p>A <code>Namespace</code> type represented by a <code>URI</code> and a prefix.</p></div></div></td></tr><tr><td><p>Nothing</p></td><td><div><div><p><code>type Nothing = Nothing</code></p></div></div></td><td><div><div><p>Bottom type. This type can be assigned to all the types.</p></div></div></td></tr><tr><td><p>Null</p></td><td><div><div><p><code>type Null = Null</code></p></div></div></td><td><div><div><p>A Null type, which represents the <code>null</code> value.</p></div></div></td></tr><tr><td><p>Number</p></td><td><div><div><p><code>type Number = Number</code></p></div></div></td><td><div><div><p>A number type: Any number, decimal, or integer is represented by the Number` type.</p></div></div></td></tr><tr><td><p>Object</p></td><td><div><div><p><code>type Object = Object</code></p></div></div></td><td><div><div><p>Type that represents any object, which is a collection of <code>Key</code> and value pairs.</p></div><div><p>Examples: <code>{ myKey : "a value" }</code>, <code>{ myKey : { a : 1, b : 2} }</code>, <code>{ myKey : [1,2,3,4] }</code></p></div></div></td></tr><tr><td><p>Pair</p></td><td><div><div><p><code>type Pair = { l: LEFT, r: RIGHT }</code></p></div></div></td><td><div><div><p>A type used to represent a pair of values.</p></div><div><p><em>Introduced in DataWeave version 2.2.0.</em></p></div></div></td></tr><tr><td><p>Period</p></td><td><div><div><p><code>type Period = Period</code></p></div></div></td><td><div><div><p>A period.</p></div></div></td></tr><tr><td><p>Range</p></td><td><div><div><p><code>type Range = Range</code></p></div></div></td><td><div><div><p>A <code>Range</code> type represents a sequence of numbers.</p></div></div></td></tr><tr><td><p>Regex</p></td><td><div><div><p><code>type Regex = Regex</code></p></div></div></td><td><div><div><p>A Java regular expression (regex) type.</p></div></div></td></tr><tr><td><p>SimpleType</p></td><td><div><div><p><code>type SimpleType = String | Boolean | Number | DateTime | LocalDateTime | Date | LocalTime | Time | TimeZone | Period</code></p></div></div></td><td><div><div><p>A union type that represents all the simple types.</p></div></div></td></tr><tr><td><p>String</p></td><td><div><div><p><code>type String = String</code></p></div></div></td><td><div><div><p><code>String</code> type</p></div></div></td></tr><tr><td><p>StringCoerceable</p></td><td><div><div><p><code>type StringCoerceable = String | Boolean | Number | DateTime | LocalDateTime | Date | LocalTime | Time | TimeZone | Period | Key | Binary | Uri | Type&lt;Any&gt; | Regex | Namespace</code></p></div></div></td><td><div><div><p>A union type of all the types that can be coerced to String type.</p></div><div><p><em>Introduced in DataWeave version 2.3.0.</em></p></div></div></td></tr><tr><td><p>Time</p></td><td><div><div><p><code>type Time = Time</code></p></div></div></td><td><div><div><p>A time in a specific <code>TimeZone</code>. For example: <code>|22:10:18Z|</code></p></div></div></td></tr><tr><td><p>TimeZone</p></td><td><div><div><p><code>type TimeZone = TimeZone</code></p></div></div></td><td><div><div><p>A time zone.</p></div></div></td></tr><tr><td><p>Type</p></td><td><div><div><p><code>type Type = Type</code></p></div></div></td><td><div><div><p>A type in the DataWeave type system.</p></div></div></td></tr><tr><td><p>Uri</p></td><td><div><div><p><code>type Uri = Uri</code></p></div></div></td><td><div><div><p>A URI.</p></div></div></td></tr></tbody></table>

<!-- document id=ea6e178948487acf75835853685d8682cea4da0ffcd27ac0d103b93ae6ab5c83 url=/mulesoft/current/en-us/dataweave/2.6/dw-core-types.md -->

---
product: DataWeave
version: 2.6
---

# Core Types (dw::Core)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>Any</p></td><td><div><div><p><code>type Any = Any</code></p></div></div></td><td><div><div><p>The top-level type. <code>Any</code> extends all of the system types, which means that anything can be assigned to a <code>Any</code> typed variable.</p></div></div></td></tr><tr><td><p>Array</p></td><td><div><div><p><code>type Array = Array</code></p></div></div></td><td><div><div><p>Array type that requires a <code>Type(T)</code> to represent the elements of the list. Example: <code>Array&lt;Number&gt;</code> represents an array of numbers, and <code>Array&lt;Any&gt;</code> represents an array of any type.</p></div><div><p>Example: <code>[1, 2, "a", "b", true, false, { a : "b"}, [1, 2, 3] ]</code></p></div></div></td></tr><tr><td><p>Binary</p></td><td><div><div><p><code>type Binary = Binary</code></p></div></div></td><td><div><div><p>A blob.</p></div></div></td></tr><tr><td><p>Boolean</p></td><td><div><div><p><code>type Boolean = Boolean</code></p></div></div></td><td><div><div><p>A <code>Boolean</code> type of <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p>CData</p></td><td><div><div><p><code>type CData = String {cdata: true}</code></p></div></div></td><td><div><div><p>XML defines a <code>CData</code> custom type that extends from <code>String</code> and is used to identify a CDATA XML block.</p></div><div><p>It can be used to tell the writer to wrap the content inside CDATA or to check if the string arrives inside a CDATA block. <code>CData</code> inherits from the type <code>String</code>.</p></div><div><p><strong>Source</strong>:</p></div><div><p><code>output application/xml --- { "user" : "Shoki" as CData }</code></p></div><div><p><strong>Output</strong>:</p></div><div><p><code>&lt;?xml version="1.0" encoding="UTF-8"?&gt;&lt;user&gt;&lt;![CDATA[Shoki]]&gt;&lt;/user&gt;</code></p></div></div></td></tr><tr><td><p>Comparable</p></td><td><div><div><p><code>type Comparable = String | Number | Boolean | DateTime | LocalDateTime | Date | LocalTime | Time | TimeZone</code></p></div></div></td><td><div><div><p>A union type that represents all the types that can be compared to each other.</p></div></div></td></tr><tr><td><p>Date</p></td><td><div><div><p><code>type Date = Date</code></p></div></div></td><td><div><div><p>A date represented by a year, month, and day. For example: <code>|2018-09-17|</code></p></div></div></td></tr><tr><td><p>DateTime</p></td><td><div><div><p><code>type DateTime = DateTime</code></p></div></div></td><td><div><div><p>A <code>Date</code> and <code>Time</code> within a <code>TimeZone</code>. For example: <code>|2018-09-17T22:13:00Z|</code></p></div></div></td></tr><tr><td><p>Dictionary</p></td><td><div><div><p><code>type Dictionary = { _?: T }</code></p></div></div></td><td><div><div><p>Generic dictionary interface.</p></div></div></td></tr><tr><td><p>Enum</p></td><td><div><div><p><code>type Enum = String {enumeration: true}</code></p></div></div></td><td><div><div><p>This type is based on the <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html">Enum Java class</a>.</p></div><div><p>It must always be used with the <code>class</code> property, specifying the full Java class name of the class, as shown in the example below.</p></div><div><p><strong>Source:</strong></p></div><div><p><code>"Max" as Enum {class: "com.acme.MuleyEnum"}</code></p></div></div></td></tr><tr><td><p>Iterator</p></td><td><div><div><p><code>type Iterator = Array {iterator: true}</code></p></div></div></td><td><div><div><p>This type is based on the <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html">iterator Java class</a>. The iterator contains a collection and includes methods to iterate through and filter it.</p></div><div><p>Just like the Java class, <code>Iterator</code> is designed to be consumed only once. For example, if you pass it to a <a href="https://docs.mulesoft.com/mule-runtime/latest/logger-component-reference">Logger component</a>, the Logger consumes it, so it becomes unreadable by further elements in the flow.</p></div></div></td></tr><tr><td><p>Key</p></td><td><div><div><p><code>type Key = Key</code></p></div></div></td><td><div><div><p>A key of an <code>Object</code>.</p></div><div><p>Examples: <code>{ myKey : "a value" }</code>, <code>{ myKey : { a : 1, b : 2} }</code>, <code>{ myKey : [1,2,3,4] }</code></p></div></div></td></tr><tr><td><p>LocalDateTime</p></td><td><div><div><p><code>type LocalDateTime = LocalDateTime</code></p></div></div></td><td><div><div><p>A <code>DateTime</code> in the current <code>TimeZone</code>. For example: <code>|2018-09-17T22:13:00|</code></p></div></div></td></tr><tr><td><p>LocalTime</p></td><td><div><div><p><code>type LocalTime = LocalTime</code></p></div></div></td><td><div><div><p>A <code>Time</code> in the current <code>TimeZone</code>. For example: <code>|22:10:18|</code></p></div></div></td></tr><tr><td><p>NaN</p></td><td><div><div><p><code>type NaN = Null {NaN: true}</code></p></div></div></td><td><div><div><p><code>java.lang.Float</code> and <code>java.lang.Double</code> have special cases for <code>NaN</code> and <code>Infinit</code>. DataWeave does not have these concepts for its number multi-precision nature. So when it is mapped to DataWeave values, it is wrapped in a Null with a Schema marker.</p></div></div></td></tr><tr><td><p>Namespace</p></td><td><div><div><p><code>type Namespace = Namespace</code></p></div></div></td><td><div><div><p>A <code>Namespace</code> type represented by a <code>URI</code> and a prefix.</p></div></div></td></tr><tr><td><p>Nothing</p></td><td><div><div><p><code>type Nothing = Nothing</code></p></div></div></td><td><div><div><p>Bottom type. This type can be assigned to all the types.</p></div></div></td></tr><tr><td><p>Null</p></td><td><div><div><p><code>type Null = Null</code></p></div></div></td><td><div><div><p>A Null type, which represents the <code>null</code> value.</p></div></div></td></tr><tr><td><p>Number</p></td><td><div><div><p><code>type Number = Number</code></p></div></div></td><td><div><div><p>A number type: Any number, decimal, or integer is represented by the Number` type.</p></div></div></td></tr><tr><td><p>Object</p></td><td><div><div><p><code>type Object = Object</code></p></div></div></td><td><div><div><p>Type that represents any object, which is a collection of <code>Key</code> and value pairs.</p></div><div><p>Examples: <code>{ myKey : "a value" }</code>, <code>{ myKey : { a : 1, b : 2} }</code>, <code>{ myKey : [1,2,3,4] }</code></p></div></div></td></tr><tr><td><p>Pair</p></td><td><div><div><p><code>type Pair = { l: LEFT, r: RIGHT }</code></p></div></div></td><td><div><div><p>A type used to represent a pair of values.</p></div><div><p><em>Introduced in DataWeave version 2.2.0.</em></p></div></div></td></tr><tr><td><p>Period</p></td><td><div><div><p><code>type Period = Period</code></p></div></div></td><td><div><div><p>A period.</p></div></div></td></tr><tr><td><p>Range</p></td><td><div><div><p><code>type Range = Range</code></p></div></div></td><td><div><div><p>A <code>Range</code> type represents a sequence of numbers.</p></div></div></td></tr><tr><td><p>Regex</p></td><td><div><div><p><code>type Regex = Regex</code></p></div></div></td><td><div><div><p>A Java regular expression (regex) type.</p></div></div></td></tr><tr><td><p>SimpleType</p></td><td><div><div><p><code>type SimpleType = String | Boolean | Number | DateTime | LocalDateTime | Date | LocalTime | Time | TimeZone | Period</code></p></div></div></td><td><div><div><p>A union type that represents all the simple types.</p></div></div></td></tr><tr><td><p>String</p></td><td><div><div><p><code>type String = String</code></p></div></div></td><td><div><div><p><code>String</code> type</p></div></div></td></tr><tr><td><p>StringCoerceable</p></td><td><div><div><p><code>type StringCoerceable = String | Boolean | Number | DateTime | LocalDateTime | Date | LocalTime | Time | TimeZone | Period | Key | Binary | Uri | Type&lt;Any&gt; | Regex | Namespace</code></p></div></div></td><td><div><div><p>A union type of all the types that can be coerced to String type.</p></div><div><p><em>Introduced in DataWeave version 2.3.0.</em></p></div></div></td></tr><tr><td><p>Time</p></td><td><div><div><p><code>type Time = Time</code></p></div></div></td><td><div><div><p>A time in a specific <code>TimeZone</code>. For example: <code>|22:10:18Z|</code></p></div></div></td></tr><tr><td><p>TimeZone</p></td><td><div><div><p><code>type TimeZone = TimeZone</code></p></div></div></td><td><div><div><p>A time zone.</p></div></div></td></tr><tr><td><p>Type</p></td><td><div><div><p><code>type Type = Type</code></p></div></div></td><td><div><div><p>A type in the DataWeave type system.</p></div></div></td></tr><tr><td><p>Uri</p></td><td><div><div><p><code>type Uri = Uri</code></p></div></div></td><td><div><div><p>A URI.</p></div></div></td></tr></tbody></table>

<!-- document id=542acf8b82cc29853467e9e9e3bf23742feafccb51b1946298e9bcf85c26cb81 url=/mulesoft/current/en-us/dataweave/2.9/dw-core-types.md -->

---
product: DataWeave
version: 2.9
---

# Core Types (dw::Core)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>Any</p></td><td><div><div><p><code>type Any = Any</code></p></div></div></td><td><div><div><p>The top-level type. <code>Any</code> extends all of the system types, which means that anything can be assigned to a <code>Any</code> typed variable.</p></div></div></td></tr><tr><td><p>Array</p></td><td><div><div><p><code>type Array = Array</code></p></div></div></td><td><div><div><p>Array type that requires a <code>Type(T)</code> to represent the elements of the list. Example: <code>Array&lt;Number&gt;</code> represents an array of numbers, and <code>Array&lt;Any&gt;</code> represents an array of any type.</p></div><div><p>Example: <code>[1, 2, "a", "b", true, false, { a : "b"}, [1, 2, 3] ]</code></p></div></div></td></tr><tr><td><p>Binary</p></td><td><div><div><p><code>type Binary = Binary</code></p></div></div></td><td><div><div><p>A blob.</p></div></div></td></tr><tr><td><p>Boolean</p></td><td><div><div><p><code>type Boolean = Boolean</code></p></div></div></td><td><div><div><p>A <code>Boolean</code> type of <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p>CData</p></td><td><div><div><p><code>type CData = String {cdata: true}</code></p></div></div></td><td><div><div><p>XML defines a <code>CData</code> custom type that extends from <code>String</code> and is used to identify a CDATA XML block.</p></div><div><p>It can be used to tell the writer to wrap the content inside CDATA or to check if the string arrives inside a CDATA block. <code>CData</code> inherits from the type <code>String</code>.</p></div><div><p><strong>Source</strong>:</p></div><div><p><code>output application/xml --- { "user" : "Shoki" as CData }</code></p></div><div><p><strong>Output</strong>:</p></div><div><p><code>&lt;?xml version="1.0" encoding="UTF-8"?&gt;&lt;user&gt;&lt;![CDATA[Shoki]]&gt;&lt;/user&gt;</code></p></div></div></td></tr><tr><td><p>Comparable</p></td><td><div><div><p><code>type Comparable = String | Number | Boolean | DateTime | LocalDateTime | Date | LocalTime | Time | TimeZone</code></p></div></div></td><td><div><div><p>A union type that represents all the types that can be compared to each other.</p></div></div></td></tr><tr><td><p>Date</p></td><td><div><div><p><code>type Date = Date</code></p></div></div></td><td><div><div><p>A date represented by a year, month, and day. For example: <code>|2018-09-17|</code></p></div></div></td></tr><tr><td><p>DateTime</p></td><td><div><div><p><code>type DateTime = DateTime</code></p></div></div></td><td><div><div><p>A <code>Date</code> and <code>Time</code> within a <code>TimeZone</code>. For example: <code>|2018-09-17T22:13:00Z|</code></p></div></div></td></tr><tr><td><p>Dictionary</p></td><td><div><div><p><code>type Dictionary = { _?: T }</code></p></div></div></td><td><div><div><p>Generic dictionary interface.</p></div></div></td></tr><tr><td><p>Enum</p></td><td><div><div><p><code>type Enum = String {enumeration: true}</code></p></div></div></td><td><div><div><p>This type is based on the <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html">Enum Java class</a>.</p></div><div><p>It must always be used with the <code>class</code> property, specifying the full Java class name of the class, as shown in the example below.</p></div><div><p><strong>Source:</strong></p></div><div><p><code>"Max" as Enum {class: "com.acme.MuleyEnum"}</code></p></div></div></td></tr><tr><td><p>Iterator</p></td><td><div><div><p><code>type Iterator = Array {iterator: true}</code></p></div></div></td><td><div><div><p>This type is based on the <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html">iterator Java class</a>. The iterator contains a collection and includes methods to iterate through and filter it.</p></div><div><p>Just like the Java class, <code>Iterator</code> is designed to be consumed only once. For example, if you pass it to a <a href="https://docs.mulesoft.com/mule-runtime/latest/logger-component-reference">Logger component</a>, the Logger consumes it, so it becomes unreadable by further elements in the flow.</p></div></div></td></tr><tr><td><p>Key</p></td><td><div><div><p><code>type Key = Key</code></p></div></div></td><td><div><div><p>A key of an <code>Object</code>.</p></div><div><p>Examples: <code>{ myKey : "a value" }</code>, <code>{ myKey : { a : 1, b : 2} }</code>, <code>{ myKey : [1,2,3,4] }</code></p></div></div></td></tr><tr><td><p>LocalDateTime</p></td><td><div><div><p><code>type LocalDateTime = LocalDateTime</code></p></div></div></td><td><div><div><p>A <code>DateTime</code> in the current <code>TimeZone</code>. For example: <code>|2018-09-17T22:13:00|</code></p></div></div></td></tr><tr><td><p>LocalTime</p></td><td><div><div><p><code>type LocalTime = LocalTime</code></p></div></div></td><td><div><div><p>A <code>Time</code> in the current <code>TimeZone</code>. For example: <code>|22:10:18|</code></p></div></div></td></tr><tr><td><p>NaN</p></td><td><div><div><p><code>type NaN = Null {NaN: true}</code></p></div></div></td><td><div><div><p><code>java.lang.Float</code> and <code>java.lang.Double</code> have special cases for <code>NaN</code> and <code>Infinit</code>. DataWeave does not have these concepts for its number multi-precision nature. So when it is mapped to DataWeave values, it is wrapped in a Null with a Schema marker.</p></div></div></td></tr><tr><td><p>Namespace</p></td><td><div><div><p><code>type Namespace = Namespace</code></p></div></div></td><td><div><div><p>A <code>Namespace</code> type represented by a <code>URI</code> and a prefix.</p></div></div></td></tr><tr><td><p>Nothing</p></td><td><div><div><p><code>type Nothing = Nothing</code></p></div></div></td><td><div><div><p>Bottom type. This type can be assigned to all the types.</p></div></div></td></tr><tr><td><p>Null</p></td><td><div><div><p><code>type Null = Null</code></p></div></div></td><td><div><div><p>A Null type, which represents the <code>null</code> value.</p></div></div></td></tr><tr><td><p>Number</p></td><td><div><div><p><code>type Number = Number</code></p></div></div></td><td><div><div><p>A number type: Any number, decimal, or integer is represented by the Number` type.</p></div></div></td></tr><tr><td><p>Object</p></td><td><div><div><p><code>type Object = Object</code></p></div></div></td><td><div><div><p>Type that represents any object, which is a collection of <code>Key</code> and value pairs.</p></div><div><p>Examples: <code>{ myKey : "a value" }</code>, <code>{ myKey : { a : 1, b : 2} }</code>, <code>{ myKey : [1,2,3,4] }</code></p></div></div></td></tr><tr><td><p>Pair</p></td><td><div><div><p><code>type Pair = { l: LEFT, r: RIGHT }</code></p></div></div></td><td><div><div><p>A type used to represent a pair of values.</p></div><div><p><em>Introduced in DataWeave version 2.2.0.</em></p></div></div></td></tr><tr><td><p>Period</p></td><td><div><div><p><code>type Period = Period</code></p></div></div></td><td><div><div><p>A period.</p></div></div></td></tr><tr><td><p>Range</p></td><td><div><div><p><code>type Range = Range</code></p></div></div></td><td><div><div><p>A <code>Range</code> type represents a sequence of numbers.</p></div></div></td></tr><tr><td><p>Regex</p></td><td><div><div><p><code>type Regex = Regex</code></p></div></div></td><td><div><div><p>A Java regular expression (regex) type.</p></div></div></td></tr><tr><td><p>Result</p></td><td><div><div><p><code>type Result = { success: true, result: T } | { success: false, error: E }</code></p></div></div></td><td><div><div><p>A type for representing an execution result.</p></div><div><p>Supports the following fields:</p></div><div><ul><li><p><code>success</code>: Determine if the execution ends successfully. If <code>true</code>, the data type provides the <code>result</code>. If <code>false</code>, the data type provides the <code>error</code>.</p></li><li><p><code>result</code>: The success result data.</p></li><li><p><code>error</code>: The error data.</p></li></ul></div><div><p><em>Introduced in DataWeave version 2.7.0.</em></p></div></div></td></tr><tr><td><p>SimpleType</p></td><td><div><div><p><code>type SimpleType = String | Boolean | Number | DateTime | LocalDateTime | Date | LocalTime | Time | TimeZone | Period</code></p></div></div></td><td><div><div><p>A union type that represents all the simple types.</p></div></div></td></tr><tr><td><p>String</p></td><td><div><div><p><code>type String = String</code></p></div></div></td><td><div><div><p><code>String</code> type</p></div></div></td></tr><tr><td><p>StringCoerceable</p></td><td><div><div><p><code>type StringCoerceable = String | Boolean | Number | DateTime | LocalDateTime | Date | LocalTime | Time | TimeZone | Period | Key | Binary | Uri | Type&lt;Any&gt; | Regex | Namespace</code></p></div></div></td><td><div><div><p>A union type of all the types that can be coerced to String type.</p></div><div><p><em>Introduced in DataWeave version 2.3.0.</em></p></div></div></td></tr><tr><td><p>Time</p></td><td><div><div><p><code>type Time = Time</code></p></div></div></td><td><div><div><p>A time in a specific <code>TimeZone</code>. For example: <code>|22:10:18Z|</code></p></div></div></td></tr><tr><td><p>TimeZone</p></td><td><div><div><p><code>type TimeZone = TimeZone</code></p></div></div></td><td><div><div><p>A time zone.</p></div></div></td></tr><tr><td><p>Type</p></td><td><div><div><p><code>type Type = Type</code></p></div></div></td><td><div><div><p>A type in the DataWeave type system.</p></div></div></td></tr><tr><td><p>Uri</p></td><td><div><div><p><code>type Uri = Uri</code></p></div></div></td><td><div><div><p>A URI.</p></div></div></td></tr></tbody></table>

<!-- document id=1a89013852336ec43cf9e3ed77d7ef128d0c7e5436c2a716299e181533096a56 url=/mulesoft/current/en-us/dataweave/latest/dw-core-types.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Core Types (dw::Core)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>Any</p></td><td><div><div><p><code>type Any = Any</code></p></div></div></td><td><div><div><p>The top-level type. <code>Any</code> extends all of the system types, which means that anything can be assigned to a <code>Any</code> typed variable.</p></div></div></td></tr><tr><td><p>Array</p></td><td><div><div><p><code>type Array = Array</code></p></div></div></td><td><div><div><p>Array type that requires a <code>Type(T)</code> to represent the elements of the list. Example: <code>Array&lt;Number&gt;</code> represents an array of numbers, and <code>Array&lt;Any&gt;</code> represents an array of any type.</p></div><div><p>Example: <code>[1, 2, "a", "b", true, false, { a : "b"}, [1, 2, 3] ]</code></p></div></div></td></tr><tr><td><p>Binary</p></td><td><div><div><p><code>type Binary = Binary</code></p></div></div></td><td><div><div><p>A blob.</p></div></div></td></tr><tr><td><p>Boolean</p></td><td><div><div><p><code>type Boolean = Boolean</code></p></div></div></td><td><div><div><p>A <code>Boolean</code> type of <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p>CData</p></td><td><div><div><p><code>type CData = String {cdata: true}</code></p></div></div></td><td><div><div><p>XML defines a <code>CData</code> custom type that extends from <code>String</code> and is used to identify a CDATA XML block.</p></div><div><p>It can be used to tell the writer to wrap the content inside CDATA or to check if the string arrives inside a CDATA block. <code>CData</code> inherits from the type <code>String</code>.</p></div><div><p><strong>Source</strong>:</p></div><div><p><code>output application/xml --- { "user" : "Shoki" as CData }</code></p></div><div><p><strong>Output</strong>:</p></div><div><p><code>&lt;?xml version="1.0" encoding="UTF-8"?&gt;&lt;user&gt;&lt;![CDATA[Shoki]]&gt;&lt;/user&gt;</code></p></div></div></td></tr><tr><td><p>Comparable</p></td><td><div><div><p><code>type Comparable = String | Number | Boolean | DateTime | LocalDateTime | Date | LocalTime | Time | TimeZone</code></p></div></div></td><td><div><div><p>A union type that represents all the types that can be compared to each other.</p></div></div></td></tr><tr><td><p>Date</p></td><td><div><div><p><code>type Date = Date</code></p></div></div></td><td><div><div><p>A date represented by a year, month, and day. For example: <code>|2018-09-17|</code></p></div></div></td></tr><tr><td><p>DateTime</p></td><td><div><div><p><code>type DateTime = DateTime</code></p></div></div></td><td><div><div><p>A <code>Date</code> and <code>Time</code> within a <code>TimeZone</code>. For example: <code>|2018-09-17T22:13:00Z|</code></p></div></div></td></tr><tr><td><p>Dictionary</p></td><td><div><div><p><code>type Dictionary = { _?: T }</code></p></div></div></td><td><div><div><p>Generic dictionary interface.</p></div></div></td></tr><tr><td><p>Enum</p></td><td><div><div><p><code>type Enum = String {enumeration: true}</code></p></div></div></td><td><div><div><p>This type is based on the <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html">Enum Java class</a>.</p></div><div><p>It must always be used with the <code>class</code> property, specifying the full Java class name of the class, as shown in the example below.</p></div><div><p><strong>Source:</strong></p></div><div><p><code>"Max" as Enum {class: "com.acme.MuleyEnum"}</code></p></div></div></td></tr><tr><td><p>Iterator</p></td><td><div><div><p><code>type Iterator = Array {iterator: true}</code></p></div></div></td><td><div><div><p>This type is based on the <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html">iterator Java class</a>. The iterator contains a collection and includes methods to iterate through and filter it.</p></div><div><p>Just like the Java class, <code>Iterator</code> is designed to be consumed only once. For example, if you pass it to a <a href="https://docs.mulesoft.com/mule-runtime/latest/logger-component-reference">Logger component</a>, the Logger consumes it, so it becomes unreadable by further elements in the flow.</p></div></div></td></tr><tr><td><p>Key</p></td><td><div><div><p><code>type Key = Key</code></p></div></div></td><td><div><div><p>A key of an <code>Object</code>.</p></div><div><p>Examples: <code>{ myKey : "a value" }</code>, <code>{ myKey : { a : 1, b : 2} }</code>, <code>{ myKey : [1,2,3,4] }</code></p></div></div></td></tr><tr><td><p>LocalDateTime</p></td><td><div><div><p><code>type LocalDateTime = LocalDateTime</code></p></div></div></td><td><div><div><p>A <code>DateTime</code> in the current <code>TimeZone</code>. For example: <code>|2018-09-17T22:13:00|</code></p></div></div></td></tr><tr><td><p>LocalTime</p></td><td><div><div><p><code>type LocalTime = LocalTime</code></p></div></div></td><td><div><div><p>A <code>Time</code> in the current <code>TimeZone</code>. For example: <code>|22:10:18|</code></p></div></div></td></tr><tr><td><p>LogLevel</p></td><td><div><div><p><code>type LogLevel = "Debug" | "Info" | "Warn" | "Error"</code></p></div></div></td><td><div><div><p>A type that represents the severity level of logging operations. For example: <code>Debug</code>, <code>Info</code>, <code>Warn</code>, <code>Error</code>.</p></div></div></td></tr><tr><td><p>NaN</p></td><td><div><div><p><code>type NaN = Null {NaN: true}</code></p></div></div></td><td><div><div><p><code>java.lang.Float</code> and <code>java.lang.Double</code> have special cases for <code>NaN</code> and <code>Infinit</code>. DataWeave does not have these concepts for its number multi-precision nature. So when it is mapped to DataWeave values, it is wrapped in a Null with a Schema marker.</p></div></div></td></tr><tr><td><p>Namespace</p></td><td><div><div><p><code>type Namespace = Namespace</code></p></div></div></td><td><div><div><p>A <code>Namespace</code> type represented by a <code>URI</code> and a prefix.</p></div></div></td></tr><tr><td><p>Nothing</p></td><td><div><div><p><code>type Nothing = Nothing</code></p></div></div></td><td><div><div><p>Bottom type. This type can be assigned to all the types.</p></div></div></td></tr><tr><td><p>Null</p></td><td><div><div><p><code>type Null = Null</code></p></div></div></td><td><div><div><p>A Null type, which represents the <code>null</code> value.</p></div></div></td></tr><tr><td><p>Number</p></td><td><div><div><p><code>type Number = Number</code></p></div></div></td><td><div><div><p>A number type: Any number, decimal, or integer is represented by the Number` type.</p></div></div></td></tr><tr><td><p>Object</p></td><td><div><div><p><code>type Object = Object</code></p></div></div></td><td><div><div><p>Type that represents any object, which is a collection of <code>Key</code> and value pairs.</p></div><div><p>Examples: <code>{ myKey : "a value" }</code>, <code>{ myKey : { a : 1, b : 2} }</code>, <code>{ myKey : [1,2,3,4] }</code></p></div></div></td></tr><tr><td><p>Pair</p></td><td><div><div><p><code>type Pair = { l: LEFT, r: RIGHT }</code></p></div></div></td><td><div><div><p>A type used to represent a pair of values.</p></div><div><p><em>Introduced in DataWeave version 2.2.0.</em></p></div></div></td></tr><tr><td><p>Period</p></td><td><div><div><p><code>type Period = Period</code></p></div></div></td><td><div><div><p>A period.</p></div></div></td></tr><tr><td><p>Range</p></td><td><div><div><p><code>type Range = Range</code></p></div></div></td><td><div><div><p>A <code>Range</code> type represents a sequence of numbers.</p></div></div></td></tr><tr><td><p>Regex</p></td><td><div><div><p><code>type Regex = Regex</code></p></div></div></td><td><div><div><p>A Java regular expression (regex) type.</p></div></div></td></tr><tr><td><p>Result</p></td><td><div><div><p><code>type Result = { success: true, result: T } | { success: false, error: E }</code></p></div></div></td><td><div><div><p>A type for representing an execution result.</p></div><div><p>Supports the following fields:</p></div><div><ul><li><p><code>success</code>: Determine if the execution ends successfully. If <code>true</code>, the data type provides the <code>result</code>. If <code>false</code>, the data type provides the <code>error</code>.</p></li><li><p><code>result</code>: The success result data.</p></li><li><p><code>error</code>: The error data.</p></li></ul></div><div><p><em>Introduced in DataWeave version 2.7.0.</em></p></div></div></td></tr><tr><td><p>SimpleType</p></td><td><div><div><p><code>type SimpleType = String | Boolean | Number | DateTime | LocalDateTime | Date | LocalTime | Time | TimeZone | Period</code></p></div></div></td><td><div><div><p>A union type that represents all the simple types.</p></div></div></td></tr><tr><td><p>String</p></td><td><div><div><p><code>type String = String</code></p></div></div></td><td><div><div><p><code>String</code> type</p></div></div></td></tr><tr><td><p>StringCoerceable</p></td><td><div><div><p><code>type StringCoerceable = String | Boolean | Number | DateTime | LocalDateTime | Date | LocalTime | Time | TimeZone | Period | Key | Binary | Uri | Type&lt;Any&gt; | Regex | Namespace</code></p></div></div></td><td><div><div><p>A union type of all the types that can be coerced to String type.</p></div><div><p><em>Introduced in DataWeave version 2.3.0.</em></p></div></div></td></tr><tr><td><p>Time</p></td><td><div><div><p><code>type Time = Time</code></p></div></div></td><td><div><div><p>A time in a specific <code>TimeZone</code>. For example: <code>|22:10:18Z|</code></p></div></div></td></tr><tr><td><p>TimeZone</p></td><td><div><div><p><code>type TimeZone = TimeZone</code></p></div></div></td><td><div><div><p>A time zone.</p></div></div></td></tr><tr><td><p>Type</p></td><td><div><div><p><code>type Type = Type</code></p></div></div></td><td><div><div><p>A type in the DataWeave type system.</p></div></div></td></tr><tr><td><p>Uri</p></td><td><div><div><p><code>type Uri = Uri</code></p></div></div></td><td><div><div><p>A URI.</p></div></div></td></tr></tbody></table>

<!-- document id=be129866f53b5a00201d518f2398e04e35a27ff8c587953f78a100b0eb75f02b url=/mulesoft/current/en-us/dataweave/2.11/dw-math-functions-cos.md -->

---
product: DataWeave
version: 2.11
---

# cos

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## cos(angle: Number): Number

Returns the trigonometric cosine of an angle from a given number of radians.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>angle</code></p></td><td><div><div><p>Number of radians in an angle.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `cos` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
  "cos0": cos(0),
  "cos13": cos(0.13),
  "cos-1": cos(-1)
}
```

#### Output

```Json
{
  "cos0": 1.0,
  "cos13": 0.9915618937147881,
  "cos-1": 0.5403023058681398
}
```

<!-- document id=01db567beb66258058487e8af8155178d6d132bfe76133c0e49a3b34a722050b url=/mulesoft/current/en-us/dataweave/2.12/dw-math-functions-cos.md -->

---
product: DataWeave
version: 2.12
---

# cos

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## cos(angle: Number): Number

Returns the trigonometric cosine of an angle from a given number of radians.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>angle</code></p></td><td><div><div><p>Number of radians in an angle.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `cos` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
  "cos0": cos(0),
  "cos13": cos(0.13),
  "cos-1": cos(-1)
}
```

#### Output

```Json
{
  "cos0": 1.0,
  "cos13": 0.9915618937147881,
  "cos-1": 0.5403023058681398
}
```

<!-- document id=69afe1c378889c9990b8d599af36aafca5ff7618ded7e1bbfd034e2cbf4d404c url=/mulesoft/current/en-us/dataweave/2.4/dw-math-functions-cos.md -->

---
product: DataWeave
version: 2.4
---

# cos

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## cos(angle: Number): Number

Returns the trigonometric cosine of an angle from a given number of radians.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>angle</code></p></td><td><div><div><p>Number of radians in an angle.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `cos` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
  "cos0": cos(0),
  "cos13": cos(0.13),
  "cos-1": cos(-1)
}
```

#### Output

```Json
{
  "cos0": 1.0,
  "cos13": 0.9915618937147881,
  "cos-1": 0.5403023058681398
}
```

<!-- document id=b35c16cd372253eb9712caae6ab58a843ea822356f537cff8c60b73abdd830d1 url=/mulesoft/current/en-us/dataweave/2.6/dw-math-functions-cos.md -->

---
product: DataWeave
version: 2.6
---

# cos

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## cos(angle: Number): Number

Returns the trigonometric cosine of an angle from a given number of radians.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>angle</code></p></td><td><div><div><p>Number of radians in an angle.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `cos` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
  "cos0": cos(0),
  "cos13": cos(0.13),
  "cos-1": cos(-1)
}
```

#### Output

```Json
{
  "cos0": 1.0,
  "cos13": 0.9915618937147881,
  "cos-1": 0.5403023058681398
}
```

<!-- document id=6302497e833944f99ec92571902c1794377ec2062d2acebbe47f50a2a84c7759 url=/mulesoft/current/en-us/dataweave/2.9/dw-math-functions-cos.md -->

---
product: DataWeave
version: 2.9
---

# cos

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## cos(angle: Number): Number

Returns the trigonometric cosine of an angle from a given number of radians.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>angle</code></p></td><td><div><div><p>Number of radians in an angle.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `cos` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
  "cos0": cos(0),
  "cos13": cos(0.13),
  "cos-1": cos(-1)
}
```

#### Output

```Json
{
  "cos0": 1.0,
  "cos13": 0.9915618937147881,
  "cos-1": 0.5403023058681398
}
```

<!-- document id=38bac80fad942e3595407bbee92d66658b12fe088ab7f746e510751a0fa720e3 url=/mulesoft/current/en-us/dataweave/latest/dw-math-functions-cos.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# cos

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## cos(angle: Number): Number

Returns the trigonometric cosine of an angle from a given number of radians.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>angle</code></p></td><td><div><div><p>Number of radians in an angle.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `cos` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
  "cos0": cos(0),
  "cos13": cos(0.13),
  "cos-1": cos(-1)
}
```

#### Output

```Json
{
  "cos0": 1.0,
  "cos13": 0.9915618937147881,
  "cos-1": 0.5403023058681398
}
```

<!-- document id=970277097640887495e3765387637a9c829fcffe5e06a2192796a07ac5a0d90d url=/mulesoft/current/en-us/dataweave/2.11/dw-arrays-functions-countby.md -->

---
product: DataWeave
version: 2.11
---

# countBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## countBy<T>(@StreamCapable array: Array<T>, matchingFunction: (T) -> Boolean): Number

Counts the elements in an array that return `true` when the matching function is applied to the
value of each element.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The input array that contains elements to match.</p></td></tr><tr><td><p><code>matchingFunction</code></p></td><td><p>A function to apply to elements in the input array.</p></td></tr></tbody></table>

### Example

This example counts the number of elements in the input array (\[1, 2, 3, 4\]) that return `true`
when the function `(($ mod 2) == 0)` is applied their values. In this case, the values of _two_ of
the elements, both `2` and `4`, match because `2 mod 2 == 0` and `4 mod 2 == 0`. As a consequence,
the `countBy` function returns `2`. Note that `mod` returns the modulus of the operands.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
---
{ "countBy" : [1, 2, 3, 4] countBy (($ mod 2) == 0) }
```

#### Output

```JSON
{ "countBy": 2 }
```

## countBy(array: Null, matchingFunction: (Nothing) -> Any): Null

Helper function that enables `countBy` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=8c9a00a0822fe8f30fa5a909fe67b257c55eec367ed264a341ac9695b57c1e76 url=/mulesoft/current/en-us/dataweave/2.12/dw-arrays-functions-countby.md -->

---
product: DataWeave
version: 2.12
---

# countBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## countBy<T>(@StreamCapable array: Array<T>, matchingFunction: (T) -> Boolean): Number

Counts the elements in an array that return `true` when the matching function is applied to the
value of each element.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The input array that contains elements to match.</p></td></tr><tr><td><p><code>matchingFunction</code></p></td><td><p>A function to apply to elements in the input array.</p></td></tr></tbody></table>

### Example

This example counts the number of elements in the input array (\[1, 2, 3, 4\]) that return `true`
when the function `(($ mod 2) == 0)` is applied their values. In this case, the values of _two_ of
the elements, both `2` and `4`, match because `2 mod 2 == 0` and `4 mod 2 == 0`. As a consequence,
the `countBy` function returns `2`. Note that `mod` returns the modulus of the operands.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
---
{ "countBy" : [1, 2, 3, 4] countBy (($ mod 2) == 0) }
```

#### Output

```JSON
{ "countBy": 2 }
```

## countBy(array: Null, matchingFunction: (Nothing) -> Any): Null

Helper function that enables `countBy` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=40763f0db7bcea7f7e5fb413bc9d1a4bd259cbd99337a544e3f5c8830ac34d05 url=/mulesoft/current/en-us/dataweave/2.3/dw-arrays-functions-countby.md -->

---
product: DataWeave
version: 2.3
---

# countBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## countBy(Array<T>, (T) -> Boolean): Number

Counts the elements in an array that return `true` when the matching function is applied to the
value of each element.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The input array that contains elements to match.</p></td></tr><tr><td><p><code>matchingFunction</code></p></td><td><p>A function to apply to elements in the input array.</p></td></tr></tbody></table>

### Example

This example counts the number of elements in the input array (\[1, 2, 3, 4\]) that return `true`
when the function `(($ mod 2) == 0)` is applied their values. In this case, the values of _two_ of
the elements, both `2` and `4`, match because `2 mod 2 == 0` and `4 mod 2 == 0`. As a consequence,
the `countBy` function returns `2`. Note that `mod` returns the modulus of the operands.

#### Source

```DataWeave
 %dw 2.0
 import * from dw::core::Arrays
 output application/json
 ---
{ "countBy" : [1, 2, 3, 4] countBy (($ mod 2) == 0) }
```

#### Output

```JSON
{ "countBy": 2 }
```

<!-- document id=9ac45c574dbe46127b75c0973c3d7b5f4836d4ff409e5f9528b9dfa11896fc70 url=/mulesoft/current/en-us/dataweave/2.4/dw-arrays-functions-countby.md -->

---
product: DataWeave
version: 2.4
---

# countBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## countBy<T>(array: Array<T>, matchingFunction: (T) -> Boolean): Number

Counts the elements in an array that return `true` when the matching function is applied to the
value of each element.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The input array that contains elements to match.</p></td></tr><tr><td><p><code>matchingFunction</code></p></td><td><p>A function to apply to elements in the input array.</p></td></tr></tbody></table>

### Example

This example counts the number of elements in the input array (\[1, 2, 3, 4\]) that return `true`
when the function `(($ mod 2) == 0)` is applied their values. In this case, the values of _two_ of
the elements, both `2` and `4`, match because `2 mod 2 == 0` and `4 mod 2 == 0`. As a consequence,
the `countBy` function returns `2`. Note that `mod` returns the modulus of the operands.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
---
{ "countBy" : [1, 2, 3, 4] countBy (($ mod 2) == 0) }
```

#### Output

```JSON
{ "countBy": 2 }
```

## countBy(array: Null, matchingFunction: (Nothing) -> Any): Null

Helper function that enables `countBy` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=46b451d3c2b74a87f75392157d0a2dcd05e33f9f612b20ba39f005dad80c20f7 url=/mulesoft/current/en-us/dataweave/2.6/dw-arrays-functions-countby.md -->

---
product: DataWeave
version: 2.6
---

# countBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## countBy<T>(array: Array<T>, matchingFunction: (T) -> Boolean): Number

Counts the elements in an array that return `true` when the matching function is applied to the
value of each element.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The input array that contains elements to match.</p></td></tr><tr><td><p><code>matchingFunction</code></p></td><td><p>A function to apply to elements in the input array.</p></td></tr></tbody></table>

### Example

This example counts the number of elements in the input array (\[1, 2, 3, 4\]) that return `true`
when the function `(($ mod 2) == 0)` is applied their values. In this case, the values of _two_ of
the elements, both `2` and `4`, match because `2 mod 2 == 0` and `4 mod 2 == 0`. As a consequence,
the `countBy` function returns `2`. Note that `mod` returns the modulus of the operands.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
---
{ "countBy" : [1, 2, 3, 4] countBy (($ mod 2) == 0) }
```

#### Output

```JSON
{ "countBy": 2 }
```

## countBy(array: Null, matchingFunction: (Nothing) -> Any): Null

Helper function that enables `countBy` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=0e2929cfa556892b3d94c3889395b2c5d57cea0399cd18f1650085e53e82402b url=/mulesoft/current/en-us/dataweave/2.9/dw-arrays-functions-countby.md -->

---
product: DataWeave
version: 2.9
---

# countBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## countBy<T>(@StreamCapable array: Array<T>, matchingFunction: (T) -> Boolean): Number

Counts the elements in an array that return `true` when the matching function is applied to the
value of each element.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The input array that contains elements to match.</p></td></tr><tr><td><p><code>matchingFunction</code></p></td><td><p>A function to apply to elements in the input array.</p></td></tr></tbody></table>

### Example

This example counts the number of elements in the input array (\[1, 2, 3, 4\]) that return `true`
when the function `(($ mod 2) == 0)` is applied their values. In this case, the values of _two_ of
the elements, both `2` and `4`, match because `2 mod 2 == 0` and `4 mod 2 == 0`. As a consequence,
the `countBy` function returns `2`. Note that `mod` returns the modulus of the operands.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
---
{ "countBy" : [1, 2, 3, 4] countBy (($ mod 2) == 0) }
```

#### Output

```JSON
{ "countBy": 2 }
```

## countBy(array: Null, matchingFunction: (Nothing) -> Any): Null

Helper function that enables `countBy` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=b939d5b9ab507297c9631092e0bb178161ba05d8b6b3323490109a8d2ce6f83c url=/mulesoft/current/en-us/dataweave/latest/dw-arrays-functions-countby.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# countBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## countBy<T>(@StreamCapable array: Array<T>, matchingFunction: (T) -> Boolean): Number

Counts the elements in an array that return `true` when the matching function is applied to the
value of each element.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The input array that contains elements to match.</p></td></tr><tr><td><p><code>matchingFunction</code></p></td><td><p>A function to apply to elements in the input array.</p></td></tr></tbody></table>

### Example

This example counts the number of elements in the input array (\[1, 2, 3, 4\]) that return `true`
when the function `(($ mod 2) == 0)` is applied their values. In this case, the values of _two_ of
the elements, both `2` and `4`, match because `2 mod 2 == 0` and `4 mod 2 == 0`. As a consequence,
the `countBy` function returns `2`. Note that `mod` returns the modulus of the operands.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
---
{ "countBy" : [1, 2, 3, 4] countBy (($ mod 2) == 0) }
```

#### Output

```JSON
{ "countBy": 2 }
```

## countBy(array: Null, matchingFunction: (Nothing) -> Any): Null

Helper function that enables `countBy` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=268fef1590e7bc98cf2adcbb80752be4542c8347b2d72fb3b3c0230e9442bb12 url=/mulesoft/current/en-us/dataweave/2.11/dw-strings-functions-countcharactersby.md -->

---
product: DataWeave
version: 2.11
---

# countCharactersBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## countCharactersBy(text: String, predicate: (character: String) -> Boolean): Number

Counts the number of times an expression that iterates through each character in a string returns
`true`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to which the <code>predicate</code> applies.</p></td></tr><tr><td><p><code>predicate</code></p></td><td><p>Expression to apply to each character in the <code>text</code> string. The expression must return a Boolean value.</p></td></tr></tbody></table>

### Example

This example counts the digits in a string.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
"42 = 11 * 2 + 20" countCharactersBy isNumeric($)
```

#### Output

```Json
7
```

## countCharactersBy(text: Null, predicate: (character: Nothing) -> Any): Null

Helper function to make `countCharactersBy` work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=4cf2fc39457e154c6698a6c46ef56c0fe1a9358cefc50d1d5ac86985a4c01897 url=/mulesoft/current/en-us/dataweave/2.12/dw-strings-functions-countcharactersby.md -->

---
product: DataWeave
version: 2.12
---

# countCharactersBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## countCharactersBy(text: String, predicate: (character: String) -> Boolean): Number

Counts the number of times an expression that iterates through each character in a string returns
`true`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to which the <code>predicate</code> applies.</p></td></tr><tr><td><p><code>predicate</code></p></td><td><p>Expression to apply to each character in the <code>text</code> string. The expression must return a Boolean value.</p></td></tr></tbody></table>

### Example

This example counts the digits in a string.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
"42 = 11 * 2 + 20" countCharactersBy isNumeric($)
```

#### Output

```Json
7
```

## countCharactersBy(text: Null, predicate: (character: Nothing) -> Any): Null

Helper function to make `countCharactersBy` work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=40c09a541f16cddb5897772813f51bb4594b3d993272b1808a0f4ac1e5e9d5b6 url=/mulesoft/current/en-us/dataweave/2.4/dw-strings-functions-countcharactersby.md -->

---
product: DataWeave
version: 2.4
---

# countCharactersBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## countCharactersBy(text: String, predicate: (character: String) -> Boolean): Number

Counts the number of times an expression that iterates through each character in a string returns
`true`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to which the <code>predicate</code> applies.</p></td></tr><tr><td><p><code>predicate</code></p></td><td><p>Expression to apply to each character in the <code>text</code> string. The expression must return a Boolean value.</p></td></tr></tbody></table>

### Example

This example counts the digits in a string.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
"42 = 11 * 2 + 20" countCharactersBy isNumeric($)
```

#### Output

```Json
7
```

## countCharactersBy(text: Null, predicate: (character: Nothing) -> Any): Null

Helper function to make `countCharactersBy` work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=8a1c2b0a36a90a38e51da2bdc7d53046ec36f993dfa5c7de46ab86d691b3e13e url=/mulesoft/current/en-us/dataweave/2.6/dw-strings-functions-countcharactersby.md -->

---
product: DataWeave
version: 2.6
---

# countCharactersBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## countCharactersBy(text: String, predicate: (character: String) -> Boolean): Number

Counts the number of times an expression that iterates through each character in a string returns
`true`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to which the <code>predicate</code> applies.</p></td></tr><tr><td><p><code>predicate</code></p></td><td><p>Expression to apply to each character in the <code>text</code> string. The expression must return a Boolean value.</p></td></tr></tbody></table>

### Example

This example counts the digits in a string.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
"42 = 11 * 2 + 20" countCharactersBy isNumeric($)
```

#### Output

```Json
7
```

## countCharactersBy(text: Null, predicate: (character: Nothing) -> Any): Null

Helper function to make `countCharactersBy` work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=ee1307a0a82d2f761970ff8bfba8e90fd8b78448103333f2c010b0e2afd4ca1b url=/mulesoft/current/en-us/dataweave/2.9/dw-strings-functions-countcharactersby.md -->

---
product: DataWeave
version: 2.9
---

# countCharactersBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## countCharactersBy(text: String, predicate: (character: String) -> Boolean): Number

Counts the number of times an expression that iterates through each character in a string returns
`true`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to which the <code>predicate</code> applies.</p></td></tr><tr><td><p><code>predicate</code></p></td><td><p>Expression to apply to each character in the <code>text</code> string. The expression must return a Boolean value.</p></td></tr></tbody></table>

### Example

This example counts the digits in a string.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
"42 = 11 * 2 + 20" countCharactersBy isNumeric($)
```

#### Output

```Json
7
```

## countCharactersBy(text: Null, predicate: (character: Nothing) -> Any): Null

Helper function to make `countCharactersBy` work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=4a9497a53b2c87ecdbe1d37a09087a08b83fd92b0611373c8d29a5d3a9e8d57e url=/mulesoft/current/en-us/dataweave/latest/dw-strings-functions-countcharactersby.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# countCharactersBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## countCharactersBy(text: String, predicate: (character: String) -> Boolean): Number

Counts the number of times an expression that iterates through each character in a string returns
`true`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to which the <code>predicate</code> applies.</p></td></tr><tr><td><p><code>predicate</code></p></td><td><p>Expression to apply to each character in the <code>text</code> string. The expression must return a Boolean value.</p></td></tr></tbody></table>

### Example

This example counts the digits in a string.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
"42 = 11 * 2 + 20" countCharactersBy isNumeric($)
```

#### Output

```Json
7
```

## countCharactersBy(text: Null, predicate: (character: Nothing) -> Any): Null

Helper function to make `countCharactersBy` work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=56dddf3aafe9afa5d775a009a897fcba1710f11c561a463b221a889d6ad241cc url=/mulesoft/current/en-us/dataweave/2.11/dw-strings-functions-countmatches.md -->

---
product: DataWeave
version: 2.11
---

# countMatches

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## countMatches(text: String, pattern: String): Number

Counts the number of matches in a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to search for matches.</p></td></tr><tr><td><p><code>pattern</code></p></td><td><p>A substring to find in the text.</p></td></tr></tbody></table>

### Example

This example counts matches in a string.

#### Source

```DataWeave
%dw 2.0
import countMatches from dw::core::Strings
output application/json
---
"hello worlo!" countMatches "lo"
```

#### Output

```Json
2
```

## countMatches(text: String, pattern: Regex): Number

Counts the number of times a regular expression matches text in a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to search for matches.</p></td></tr><tr><td><p><code>pattern</code></p></td><td><p>The regex pattern to use in the search.</p></td></tr></tbody></table>

### Example

This example counts the vowels in a string.

#### Source

```DataWeave
%dw 2.0
import countMatches from dw::core::Strings
output application/json
---
"hello, ciao!" countMatches /[aeiou]/
```

#### Output

```Json
5
```

## countMatches(text: Null, pattern: Any): Null

Helper function that enables `countMatches` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=d96a5b0ff8530ddde731dc7d25725bd38d18de11d4b90f797949bd2e0b12c33f url=/mulesoft/current/en-us/dataweave/2.12/dw-strings-functions-countmatches.md -->

---
product: DataWeave
version: 2.12
---

# countMatches

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## countMatches(text: String, pattern: String): Number

Counts the number of matches in a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to search for matches.</p></td></tr><tr><td><p><code>pattern</code></p></td><td><p>A substring to find in the text.</p></td></tr></tbody></table>

### Example

This example counts matches in a string.

#### Source

```DataWeave
%dw 2.0
import countMatches from dw::core::Strings
output application/json
---
"hello worlo!" countMatches "lo"
```

#### Output

```Json
2
```

## countMatches(text: String, pattern: Regex): Number

Counts the number of times a regular expression matches text in a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to search for matches.</p></td></tr><tr><td><p><code>pattern</code></p></td><td><p>The regex pattern to use in the search.</p></td></tr></tbody></table>

### Example

This example counts the vowels in a string.

#### Source

```DataWeave
%dw 2.0
import countMatches from dw::core::Strings
output application/json
---
"hello, ciao!" countMatches /[aeiou]/
```

#### Output

```Json
5
```

## countMatches(text: Null, pattern: Any): Null

Helper function that enables `countMatches` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=64f605d896542e0eb500638faa78e75b4c84079d92d6319dd3a9adc3e53836fa url=/mulesoft/current/en-us/dataweave/2.4/dw-strings-functions-countmatches.md -->

---
product: DataWeave
version: 2.4
---

# countMatches

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## countMatches(text: String, pattern: String): Number

Counts the number of matches in a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to search for matches.</p></td></tr><tr><td><p><code>pattern</code></p></td><td><p>A substring to find in the text.</p></td></tr></tbody></table>

### Example

This example counts matches in a string.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
"hello worlo!" countMatches "lo"
```

#### Output

```Json
2
```

## countMatches(text: String, pattern: Regex): Number

Counts the number of times a regular expression matches text in a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to search for matches.</p></td></tr><tr><td><p><code>pattern</code></p></td><td><p>The regex pattern to use in the search.</p></td></tr></tbody></table>

### Example

This example counts the vowels in a string.

#### Source

```DataWeave
%dw 2.0
import countMatches from dw::core::Strings
output application/json
---
"hello, ciao!" countMatches /[aeiou]/
```

#### Output

```Json
5
```

## countMatches(text: Null, pattern: Any): Null

Helper function that enables `countMatches` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=98bf705308d4237ba8f33618cd214a7709dee3f1aa3b96dfe5aa4e6cbc91bb96 url=/mulesoft/current/en-us/dataweave/2.6/dw-strings-functions-countmatches.md -->

---
product: DataWeave
version: 2.6
---

# countMatches

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## countMatches(text: String, pattern: String): Number

Counts the number of matches in a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to search for matches.</p></td></tr><tr><td><p><code>pattern</code></p></td><td><p>A substring to find in the text.</p></td></tr></tbody></table>

### Example

This example counts matches in a string.

#### Source

```DataWeave
%dw 2.0
import countMatches from dw::core::Strings
output application/json
---
"hello worlo!" countMatches "lo"
```

#### Output

```Json
2
```

## countMatches(text: String, pattern: Regex): Number

Counts the number of times a regular expression matches text in a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to search for matches.</p></td></tr><tr><td><p><code>pattern</code></p></td><td><p>The regex pattern to use in the search.</p></td></tr></tbody></table>

### Example

This example counts the vowels in a string.

#### Source

```DataWeave
%dw 2.0
import countMatches from dw::core::Strings
output application/json
---
"hello, ciao!" countMatches /[aeiou]/
```

#### Output

```Json
5
```

## countMatches(text: Null, pattern: Any): Null

Helper function that enables `countMatches` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=72cb0ff9acfdc3bf353d2ae6723b42a35767528c2430daf41c6213daf28b99cc url=/mulesoft/current/en-us/dataweave/2.9/dw-strings-functions-countmatches.md -->

---
product: DataWeave
version: 2.9
---

# countMatches

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## countMatches(text: String, pattern: String): Number

Counts the number of matches in a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to search for matches.</p></td></tr><tr><td><p><code>pattern</code></p></td><td><p>A substring to find in the text.</p></td></tr></tbody></table>

### Example

This example counts matches in a string.

#### Source

```DataWeave
%dw 2.0
import countMatches from dw::core::Strings
output application/json
---
"hello worlo!" countMatches "lo"
```

#### Output

```Json
2
```

## countMatches(text: String, pattern: Regex): Number

Counts the number of times a regular expression matches text in a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to search for matches.</p></td></tr><tr><td><p><code>pattern</code></p></td><td><p>The regex pattern to use in the search.</p></td></tr></tbody></table>

### Example

This example counts the vowels in a string.

#### Source

```DataWeave
%dw 2.0
import countMatches from dw::core::Strings
output application/json
---
"hello, ciao!" countMatches /[aeiou]/
```

#### Output

```Json
5
```

## countMatches(text: Null, pattern: Any): Null

Helper function that enables `countMatches` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=b707ab099da4d034582241291cf8ee75c4997e4db2608b1a5f48d65dca5f0777 url=/mulesoft/current/en-us/dataweave/latest/dw-strings-functions-countmatches.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# countMatches

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## countMatches(text: String, pattern: String): Number

Counts the number of matches in a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to search for matches.</p></td></tr><tr><td><p><code>pattern</code></p></td><td><p>A substring to find in the text.</p></td></tr></tbody></table>

### Example

This example counts matches in a string.

#### Source

```DataWeave
%dw 2.0
import countMatches from dw::core::Strings
output application/json
---
"hello worlo!" countMatches "lo"
```

#### Output

```Json
2
```

## countMatches(text: String, pattern: Regex): Number

Counts the number of times a regular expression matches text in a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to search for matches.</p></td></tr><tr><td><p><code>pattern</code></p></td><td><p>The regex pattern to use in the search.</p></td></tr></tbody></table>

### Example

This example counts the vowels in a string.

#### Source

```DataWeave
%dw 2.0
import countMatches from dw::core::Strings
output application/json
---
"hello, ciao!" countMatches /[aeiou]/
```

#### Output

```Json
5
```

## countMatches(text: Null, pattern: Any): Null

Helper function that enables `countMatches` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=fcf2ebc7742896392769dc94c5f085d79410a5ce09c7ad2ff78d21c7cad38fdd url=/mulesoft/current/en-us/dataweave/2.11/dataweave-create-module.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Create Custom Modules and Mappings

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

In addition to using the built-in DataWeave function modules (such as [dw::Core](https://docs.mulesoft.com/dataweave/2.11/dw-core) and
[dw::Crypto](https://docs.mulesoft.com/dataweave/2.11/dw-crypto)), you can also create and use custom modules and mapping files. The examples
demonstrate common data extraction and transformation approaches.

You write modules and mapping files in a DataWeave Language (`.dwl`) file and import into your Mule
app through DataWeave scripts in Mule components. Both modules and mapping files are useful when you
need to reuse the same functionality or feature over and over again.

- Custom modules can define functions, variables, types, and namespaces. You can import these
  modules into a DataWeave script to use the features.

- Custom mapping files are a type of module that contains a complete DataWeave script that you can
  import and use in another DataWeave script or reference in a Mule component.

Fields in many Mule connectors and components accept DataWeave expressions and scripts.

Note that if you want to import and use a built-in DataWeave function module, and not a custom one,
see [DataWeave Function Reference](https://docs.mulesoft.com/dataweave/2.11/dw-functions).

## Creating and Using DataWeave Mapping Files

You can store a DataWeave transformation in a `.dwl` mapping file (mapping module), then import the
file into another DataWeave script. Mapping files can be executed through the Transform Message
component, or you can import them into another mapping and execute them through the `main` function.

![Text editor showing a DataWeave mapping file in a Studio project](/mulesoft/current/en-us/dataweave/2.11/_images/dataweave-mapping-file.png)

Figure 1. Example: DataWeave Mapping File in a Studio Project

1.  In your Studio project, set up a subfolder and file for your mapping module:

    - You can create a subfolder in `src/main/resources` by navigating to New → Folder →
      \[your\_project\] → `src/main/resources`, then adding a folder named `modules`.

    - You can create a new file for your module in that folder by navigating to New → File →
      \[your\_project\] → `src/main/resources/modules`, then adding a DWL (DataWeave language) file
      such as `MyMapping.dwl`.

      Saving the module within `src/main/resources` makes it accessible for use in any DataWeave
      script within the Mule app in that project.

2.  Create your function in your mapping file, for example:

    Example: Mapping File Content

    ```dataweave
    %dw 2.0
    import dw::core::Strings
    fun capitalizeKey(value:String) = Strings::capitalize(value) ++ "Key"
    ---
    payload mapObject ((value, key) ->
        {
          (capitalizeKey(key as String)) : value
        }
      )
    ```

3.  Save your DWL function module file.

### Using a Mapping File in a DataWeave Script

To use a mapping file, you need to import it into a DataWeave script and use the `main` function to
access the body of the script in the mapping file.

Assume that you have created the [MyMapping.dwl](#mapping_file) file in
`/src/main/resources/modules` that contains this script.

To import and use the body expression from the `MyMapping.dwl` file (above) in DataWeave Mapping
file, you need to do this:

- Specify the `import` directive in the header.

- Invoke the `MyMapping::main` function. The function expects an input that follows the structure of
  the input that the mapping file uses. For example, the body of `MyMapping.dwl` expects an object
  of the form `{"key" : "value"}`.

Example: Importing and Using the Mapping in a DataWeave Script

```dataweave
%dw 2.0
import modules::MyMapping
output application/json
---
MyMapping::main(payload: { "user" : "bar" })
```

Here is the result:

Output

```json
{
  "UserKey": "bar"
}
```

Even though the [capitalizeKey](#mapping_file) function is private, it is still used through the
`main` function call, and the DataWeave mapping file is also able to import and reuse the
`dw::core::Strings` module.

## Creating and Using a Custom Module

The steps for creating a custom DataWeave module are almost identical to the steps for creating a
custom mapping file. The only difference is the contents of the `.dwl` file. Unlike a typical
DataWeave script or mapping file, a custom DataWeave module cannot contain an `output` directive,
body expression, or the separator (`---`) between header and body sections. (For guidance with
mappings, see [Creating and Using DataWeave Mapping Files](#create_dw_mapping).)

![A DataWeave script with a custom function module](/mulesoft/current/en-us/dataweave/2.11/_images/dataweave-function-custom.png)

Figure 2. Example: Custom Module in a Studio Project

A custom module file can only contain `var`, `fun`, `type`, and `ns` declarations, for example:

Example: Custom DataWeave Module

```dataweave
%dw 2.0
var name = "MyData"
fun myFunc(myInput: String) = myInput ++ "_"
type User = {
    name: String,
    lastname: String
}
ns mynamespace http://acme.com/bar
```

When you import a custom module into another DataWeave script, any functions, variables, types, and
namespaces defined in the module become available for use in the DataWeave body. In the next
example, a DataWeave script:

- Imports the module `MyModule` through the `import` directive in the header. In this case, the
  imported module is stored in a Studio project path `src/main/resources/modules/MyModule.dwl`

- Calls a function in `MyModule` by using `MyModule::myFunc("dataweave")`.

Example: Importing and Using a Custom DataWeave Module

```dataweave
%dw 2.0
import modules::MyModule
output application/json
---
MyModule::myFunc("dataweave") ++ "name"
```

There are several ways to import a module or elements in it:

- Import the module, for example: `import modules::MyModule`. In this case, you must include the
  name of the module when you call the element (here, a function) in it, for example:
  `MyModule::myFunc`.

- Import all elements from the module, for example: `import * from modules::MyModule`. In this case,
  you do not need to include the name of the module when you call the element. For example:
  `myFunc("dataweave") ++ "name"` works.

- Import specific elements from a module, for example: `import myFunc from modules::MyModule`. In
  this case, you do not need to include the name of the module when you call the element. For
  example: `myFunc("dataweave") ++ "name"` works. You can import multiple elements from the module
  like this, for example: `import myFunc someOtherFunction from modules::MyModule` (assuming both
  `myFunc` and `someOtherFunction` are defined in the module).

Output

```json
"dataweave_name"
```

## Assigning a Local Alias for an Imported Element

To avoid name clashes, you can use `as` to assign an alias for a custom module or its elements when
you import the module into a DataWeave script.

Assume that you define a custom module like this one in the file `MyModule.dwl`:

Example: Custom Module

```dataweave
%dw 2.0
fun myFunc(name:String) = name ++ "_"
var myVar = "Test"
```

When you import the custom module into a DataWeave script, you can create aliases to elements in the
custom module, for example:

Example: Applying an Alias to Imported Elements

```dataweave
%dw 2.0
import myFunc as appendDash, myVar as weaveName from modules::MyModule
var myVar = "Mapping"
output application/json
---
appendDash("dataweave") ++ weaveName ++ "_" ++ myVar
```

The script returns `"dataweave_Test_Mapping"`.

You can create an alias to the imported module, for example:

Example: Applying an Alias to an Imported Module

```dataweave
%dw 2.0
import modules::MyModule as WeaveMod
output application/json
---
WeaveMod::myFunc("dataweave")
```

## Referencing a DWL File

You can use DWL files directly in Mule connectors and components.

See [dwl File](https://docs.mulesoft.com/dataweave/2.11/dataweave-language-introduction#dwl_file) for details.

## Writing Documentation for Custom DataWeave Modules

DataWeave supports use of the AsciiDoc text format for documenting your functions, types,
annotations, and the modules that contain them.

### Documenting Your DataWeave Functions

DataWeave defines a multi-section template for documenting function code. The template provides
sections for the following:

- A description of the function.

- Parameter descriptions in an AsciiDoc table format.

- Example code that includes sections for any input, the DataWeave script, and the resulting output.

To define parameter and example sections below the function description, the template uses AsciiDoc
heading grammar:

- `=== Parameters`

- `=== Example`

  - `==== Source`

  - `==== Input`

  - `==== Output`

The following function template provides guidance on documenting the function. As the template
notes, some sections are optional.

```DataWeave
/**
* %Replace with your function description%
*
*
* %Add additional information to your function description% (optional section)
*
* === Parameters (optional section)
*
* [%header, cols="1,1,3"]
* |===
* | Name | Type | Description
* | %`The parameter name`% | %`The parameter type`% | %The parameter description%  (one row per param)
* |===
*
* === Example (optional section)
*
* %The example description% (optional)
*
* ==== Source (optional section)
*
* [source,%The language%,linenums] (optional)
* ----
* YOUR CODE
* ----
*
* ==== Input (optional section)
*
* The input description (optional)
*
* [source,%The language%,linenums] (optional)
* ----
* YOUR CODE
* ----
*
* ==== Output (optional section)
*
* %The output description% (optional)
*
* [source,%The language%,linenums] (optional)
* ----
* YOUR CODE
* ----
*/
```

#### Description Section

This section provides a description of the function. The section starts at the top of the comments
and extends to the line before the first section heading. If there is no section header, the
description extends to the end of the comments for the function.

A description consists of the following parts:

- Short description: The first paragraph, which provides the primary description of the function.

- Long description: Any additional information about the function. This optional description begins
  two line breaks below the short description.

See the [example](#example-documentation) that includes a description with sections for the
parameters and examples.

Each part is useful for auto-generated documentation.

#### Parameters Section

The optional `=== Parameters` section describes parameters of the function.

The template uses AsciiDoc table format to document each parameter in a table row.

\[%header, cols="1,1,3"\] |=== | Name | Type | Description | yourParameter1 | The parameter type |
Your description here. | yourParameter2 | The parameter type | Your description here. |===

#### Example Section

You can use zero or more `=== Example` sections to provide any examples needed to illustrate how
your function works.

This section contains the following optional subsections:

- `==== Input` for input to the DataWeave script.

- `==== Source` for the DataWeave script.

- `==== Output` for output generated by the script.

All subsections follow the same template, which includes an optional description and an optional
code section:

Your section description

\[source,%The language%,linenums\]
----

YOUR CODE
----

The following example shows the [log](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-log)
function documentation.

/\*\* \* Without changing the value of the input, \`log\` returns the input as a system \* log. So
this makes it very simple to debug your code, because any expression or subexpression can be wrapped
\* with \*log\* and the result will be printed out without modifying the result of the expression.
\* The output is going to be printed in application/dw format. \* (1) \* \* The prefix parameter is
optional and allows to easily find the log output. \* \* \* Use this function to help with debugging
DataWeave scripts. A Mule app \* outputs the results through the \`DefaultLoggingService\`, which
you can see \* in the Studio console. \* \* === Parameters \* \* \[%header, cols="1,13"\] \* |=== \*
| Name | Type | Description \* | \`prefix\` | \`String\` | An optional string that typically
describes the log. \* | \`value\` | \`T\` | The value to log. \* |=== \* \* === Example \* \* This
example logs the specified message. Note that the \`DefaultLoggingService\` \* in a Mule app that is
running in Studio returns the message \* \`WARNING - "Houston, we have a problem,"\` adding the dash
\`-\` between the \* prefix and value. The Logger component's \`LoggerMessageProcessor\` returns \*
the input string \`"Houston, we have a problem."\`, without the \`WARNING\` prefix. \* \* ====
Source \* \* \[source,DataWeave,linenums\] \* ---- \* %dw 2.0 \* output application/json \* --- \*
log("WARNING", "Houston, we have a problem") \* ---- \* \* ==== Output \* \* \`Console Output\` \*
\* \[source,XML,linenums\] \* ---- \* "WARNING - Houston, we have a problem" \* ---- \* \*
\`Expression Output\` \* \* \[source,XML,linenums\] \* ---- \* "Houston, we have a problem" \* ----
\* \* === Example \* \* This example shows how to log the result of expression \`myUser.user\`
without modifying the \* original expression \`myUser.user.friend.name\`. \* \* ==== Source \* \*
\[source,DataWeave,linenums\] \* ---- \* %dw 2.0 \* output application/json \* \* var myUser =
{user: {friend: {name: "Shoki"}, id: 1, name: "Tomo"}, accountId: "leansh" } \* --- \* log("User",
myUser.user).friend.name \* ---- \* \* ==== Output \* \* \`Console output\` \* \*
\[source,console,linenums\] \* ---- \* User - { \* friend: { \* name: "Shoki" \* }, \* id: 1, \*
name: "Tomo" \* } \* ---- \* \* \`Expression Output\` \* \* \[source,DataWeave,linenums\] \* ---- \*
"Shoki" \* ---- \*/

### Documenting Your DataWeave Modules

The DataWeave module description does not follow a structured template.

The only requirement is to place the documentation above the DataWeave version tag.

The following example documents the [dw::Core](https://docs.mulesoft.com/dataweave/2.4/dw-core)
module:

```dataweave
/**
 * This module contains core DataWeave functions for data transformations.
 * It is automatically imported into any DataWeave script. For documentation
 * on DataWeave _1.0_ functions, see
 * https://docs.mulesoft.com/dataweave/latest/dataweave-operators[DataWeave Operators].
 */
%dw 2.0
```

### Documenting Your Annotation and Types

Annotation and Types documentation do not follow a structured template.

The only requirement is to write the descriptions above the Annotation or Type definition.

The following example documents the `@StreamCapable` annotation.

```dataweave
/**
* Annotation that marks a parameter as stream capable, which means that this
* field will consume an array of objects in a forward-only manner.
*/
@AnnotationTarget(targets = ["Parameter", "Variable"])
annotation StreamCapable()
```

The following example documents the `EncodingSettings` type found in the
[dw::extension::DataFormat](https://docs.mulesoft.com/dataweave/2.4/dw-dataformat) module.

```dataweave
/**
 * Represents encoding settings.
 */
@Since(version = "2.2.0")
type EncodingSettings = {
    /**
    * Encoding that the writer uses for output. Defaults to "UTF-8".
    */
    encoding?: String {defaultValue: "UTF-8"}
}
```

## See Also

- [Reusing Types from DataWeave Modules](https://docs.mulesoft.com/dataweave/2.11/dataweave-type-reuse-modules)

<!-- document id=e5b966ba566a72c3c01c0cc73a6256b8af4ca4f29b89c551b55dfad1782ee5f2 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-create-module.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Create Custom Modules and Mappings

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

In addition to using the built-in DataWeave function modules (such as [dw::Core](https://docs.mulesoft.com/dataweave/2.12/dw-core) and
[dw::Crypto](https://docs.mulesoft.com/dataweave/2.12/dw-crypto)), you can also create and use custom modules and mapping files. The examples
demonstrate common data extraction and transformation approaches.

You write modules and mapping files in a DataWeave Language (`.dwl`) file and import into your Mule
app through DataWeave scripts in Mule components. Both modules and mapping files are useful when you
need to reuse the same functionality or feature over and over again.

- Custom modules can define functions, variables, types, and namespaces. You can import these
  modules into a DataWeave script to use the features.

- Custom mapping files are a type of module that contains a complete DataWeave script that you can
  import and use in another DataWeave script or reference in a Mule component.

Fields in many Mule connectors and components accept DataWeave expressions and scripts.

Note that if you want to import and use a built-in DataWeave function module, and not a custom one,
see [DataWeave Function Reference](https://docs.mulesoft.com/dataweave/2.12/dw-functions).

## Creating and Using DataWeave Mapping Files

You can store a DataWeave transformation in a `.dwl` mapping file (mapping module), then import the
file into another DataWeave script. Mapping files can be executed through the Transform Message
component, or you can import them into another mapping and execute them through the `main` function.

![Text editor showing a DataWeave mapping file in a Studio project](/mulesoft/current/en-us/dataweave/2.12/_images/dataweave-mapping-file.png)

Figure 1. Example: DataWeave Mapping File in a Studio Project

1.  In your Studio project, set up a subfolder and file for your mapping module:

    - You can create a subfolder in `src/main/resources` by navigating to New → Folder →
      \[your\_project\] → `src/main/resources`, then adding a folder named `modules`.

    - You can create a new file for your module in that folder by navigating to New → File →
      \[your\_project\] → `src/main/resources/modules`, then adding a DWL (DataWeave language) file
      such as `MyMapping.dwl`.

      Saving the module within `src/main/resources` makes it accessible for use in any DataWeave
      script within the Mule app in that project.

2.  Create your function in your mapping file, for example:

    Example: Mapping File Content

    ```dataweave
    %dw 2.0
    import dw::core::Strings
    fun capitalizeKey(value:String) = Strings::capitalize(value) ++ "Key"
    ---
    payload mapObject ((value, key) ->
        {
          (capitalizeKey(key as String)) : value
        }
      )
    ```

3.  Save your DWL function module file.

### Using a Mapping File in a DataWeave Script

To use a mapping file, you need to import it into a DataWeave script and use the `main` function to
access the body of the script in the mapping file.

Assume that you have created the [MyMapping.dwl](#mapping_file) file in
`/src/main/resources/modules` that contains this script.

To import and use the body expression from the `MyMapping.dwl` file (above) in DataWeave Mapping
file, you need to do this:

- Specify the `import` directive in the header.

- Invoke the `MyMapping::main` function. The function expects an input that follows the structure of
  the input that the mapping file uses. For example, the body of `MyMapping.dwl` expects an object
  of the form `{"key" : "value"}`.

Example: Importing and Using the Mapping in a DataWeave Script

```dataweave
%dw 2.0
import modules::MyMapping
output application/json
---
MyMapping::main(payload: { "user" : "bar" })
```

Here is the result:

Output

```json
{
  "UserKey": "bar"
}
```

Even though the [capitalizeKey](#mapping_file) function is private, it is still used through the
`main` function call, and the DataWeave mapping file is also able to import and reuse the
`dw::core::Strings` module.

## Creating and Using a Custom Module

The steps for creating a custom DataWeave module are almost identical to the steps for creating a
custom mapping file. The only difference is the contents of the `.dwl` file. Unlike a typical
DataWeave script or mapping file, a custom DataWeave module cannot contain an `output` directive,
body expression, or the separator (`---`) between header and body sections. (For guidance with
mappings, see [Creating and Using DataWeave Mapping Files](#create_dw_mapping).)

![A DataWeave script with a custom function module](/mulesoft/current/en-us/dataweave/2.12/_images/dataweave-function-custom.png)

Figure 2. Example: Custom Module in a Studio Project

A custom module file can only contain `var`, `fun`, `type`, and `ns` declarations, for example:

Example: Custom DataWeave Module

```dataweave
%dw 2.0
var name = "MyData"
fun myFunc(myInput: String) = myInput ++ "_"
type User = {
    name: String,
    lastname: String
}
ns mynamespace http://acme.com/bar
```

When you import a custom module into another DataWeave script, any functions, variables, types, and
namespaces defined in the module become available for use in the DataWeave body. In the next
example, a DataWeave script:

- Imports the module `MyModule` through the `import` directive in the header. In this case, the
  imported module is stored in a Studio project path `src/main/resources/modules/MyModule.dwl`

- Calls a function in `MyModule` by using `MyModule::myFunc("dataweave")`.

Example: Importing and Using a Custom DataWeave Module

```dataweave
%dw 2.0
import modules::MyModule
output application/json
---
MyModule::myFunc("dataweave") ++ "name"
```

There are several ways to import a module or elements in it:

- Import the module, for example: `import modules::MyModule`. In this case, you must include the
  name of the module when you call the element (here, a function) in it, for example:
  `MyModule::myFunc`.

- Import all elements from the module, for example: `import * from modules::MyModule`. In this case,
  you do not need to include the name of the module when you call the element. For example:
  `myFunc("dataweave") ++ "name"` works.

- Import specific elements from a module, for example: `import myFunc from modules::MyModule`. In
  this case, you do not need to include the name of the module when you call the element. For
  example: `myFunc("dataweave") ++ "name"` works. You can import multiple elements from the module
  like this, for example: `import myFunc someOtherFunction from modules::MyModule` (assuming both
  `myFunc` and `someOtherFunction` are defined in the module).

Output

```json
"dataweave_name"
```

## Assigning a Local Alias for an Imported Element

To avoid name clashes, you can use `as` to assign an alias for a custom module or its elements when
you import the module into a DataWeave script.

Assume that you define a custom module like this one in the file `MyModule.dwl`:

Example: Custom Module

```dataweave
%dw 2.0
fun myFunc(name:String) = name ++ "_"
var myVar = "Test"
```

When you import the custom module into a DataWeave script, you can create aliases to elements in the
custom module, for example:

Example: Applying an Alias to Imported Elements

```dataweave
%dw 2.0
import myFunc as appendDash, myVar as weaveName from modules::MyModule
var myVar = "Mapping"
output application/json
---
appendDash("dataweave") ++ weaveName ++ "_" ++ myVar
```

The script returns `"dataweave_Test_Mapping"`.

You can create an alias to the imported module, for example:

Example: Applying an Alias to an Imported Module

```dataweave
%dw 2.0
import modules::MyModule as WeaveMod
output application/json
---
WeaveMod::myFunc("dataweave")
```

## Referencing a DWL File

You can use DWL files directly in Mule connectors and components.

See [dwl File](https://docs.mulesoft.com/dataweave/2.12/dataweave-language-introduction#dwl_file) for details.

## Writing Documentation for Custom DataWeave Modules

DataWeave supports use of the AsciiDoc text format for documenting your functions, types,
annotations, and the modules that contain them.

### Documenting Your DataWeave Functions

DataWeave defines a multi-section template for documenting function code. The template provides
sections for the following:

- A description of the function.

- Parameter descriptions in an AsciiDoc table format.

- Example code that includes sections for any input, the DataWeave script, and the resulting output.

To define parameter and example sections below the function description, the template uses AsciiDoc
heading grammar:

- `=== Parameters`

- `=== Example`

  - `==== Source`

  - `==== Input`

  - `==== Output`

The following function template provides guidance on documenting the function. As the template
notes, some sections are optional.

```DataWeave
/**
* %Replace with your function description%
*
*
* %Add additional information to your function description% (optional section)
*
* === Parameters (optional section)
*
* [%header, cols="1,1,3"]
* |===
* | Name | Type | Description
* | %`The parameter name`% | %`The parameter type`% | %The parameter description%  (one row per param)
* |===
*
* === Example (optional section)
*
* %The example description% (optional)
*
* ==== Source (optional section)
*
* [source,%The language%,linenums] (optional)
* ----
* YOUR CODE
* ----
*
* ==== Input (optional section)
*
* The input description (optional)
*
* [source,%The language%,linenums] (optional)
* ----
* YOUR CODE
* ----
*
* ==== Output (optional section)
*
* %The output description% (optional)
*
* [source,%The language%,linenums] (optional)
* ----
* YOUR CODE
* ----
*/
```

#### Description Section

This section provides a description of the function. The section starts at the top of the comments
and extends to the line before the first section heading. If there is no section header, the
description extends to the end of the comments for the function.

A description consists of the following parts:

- Short description: The first paragraph, which provides the primary description of the function.

- Long description: Any additional information about the function. This optional description begins
  two line breaks below the short description.

See the [example](#example-documentation) that includes a description with sections for the
parameters and examples.

Each part is useful for auto-generated documentation.

#### Parameters Section

The optional `=== Parameters` section describes parameters of the function.

The template uses AsciiDoc table format to document each parameter in a table row.

\[%header, cols="1,1,3"\] |=== | Name | Type | Description | yourParameter1 | The parameter type |
Your description here. | yourParameter2 | The parameter type | Your description here. |===

#### Example Section

You can use zero or more `=== Example` sections to provide any examples needed to illustrate how
your function works.

This section contains the following optional subsections:

- `==== Input` for input to the DataWeave script.

- `==== Source` for the DataWeave script.

- `==== Output` for output generated by the script.

All subsections follow the same template, which includes an optional description and an optional
code section:

Your section description

\[source,%The language%,linenums\]
----

YOUR CODE
----

The following example shows the [log](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-log)
function documentation.

/\*\* \* Without changing the value of the input, \`log\` returns the input as a system \* log. So
this makes it very simple to debug your code, because any expression or subexpression can be wrapped
\* with \*log\* and the result will be printed out without modifying the result of the expression.
\* The output is going to be printed in application/dw format. \* (1) \* \* The prefix parameter is
optional and allows to easily find the log output. \* \* \* Use this function to help with debugging
DataWeave scripts. A Mule app \* outputs the results through the \`DefaultLoggingService\`, which
you can see \* in the Studio console. \* \* === Parameters \* \* \[%header, cols="1,13"\] \* |=== \*
| Name | Type | Description \* | \`prefix\` | \`String\` | An optional string that typically
describes the log. \* | \`value\` | \`T\` | The value to log. \* |=== \* \* === Example \* \* This
example logs the specified message. Note that the \`DefaultLoggingService\` \* in a Mule app that is
running in Studio returns the message \* \`WARNING - "Houston, we have a problem,"\` adding the dash
\`-\` between the \* prefix and value. The Logger component's \`LoggerMessageProcessor\` returns \*
the input string \`"Houston, we have a problem."\`, without the \`WARNING\` prefix. \* \* ====
Source \* \* \[source,DataWeave,linenums\] \* ---- \* %dw 2.0 \* output application/json \* --- \*
log("WARNING", "Houston, we have a problem") \* ---- \* \* ==== Output \* \* \`Console Output\` \*
\* \[source,XML,linenums\] \* ---- \* "WARNING - Houston, we have a problem" \* ---- \* \*
\`Expression Output\` \* \* \[source,XML,linenums\] \* ---- \* "Houston, we have a problem" \* ----
\* \* === Example \* \* This example shows how to log the result of expression \`myUser.user\`
without modifying the \* original expression \`myUser.user.friend.name\`. \* \* ==== Source \* \*
\[source,DataWeave,linenums\] \* ---- \* %dw 2.0 \* output application/json \* \* var myUser =
{user: {friend: {name: "Shoki"}, id: 1, name: "Tomo"}, accountId: "leansh" } \* --- \* log("User",
myUser.user).friend.name \* ---- \* \* ==== Output \* \* \`Console output\` \* \*
\[source,console,linenums\] \* ---- \* User - { \* friend: { \* name: "Shoki" \* }, \* id: 1, \*
name: "Tomo" \* } \* ---- \* \* \`Expression Output\` \* \* \[source,DataWeave,linenums\] \* ---- \*
"Shoki" \* ---- \*/

### Documenting Your DataWeave Modules

The DataWeave module description does not follow a structured template.

The only requirement is to place the documentation above the DataWeave version tag.

The following example documents the [dw::Core](https://docs.mulesoft.com/dataweave/2.4/dw-core)
module:

```dataweave
/**
 * This module contains core DataWeave functions for data transformations.
 * It is automatically imported into any DataWeave script.
 */
%dw 2.0
```

### Documenting Your Annotation and Types

Annotation and Types documentation do not follow a structured template.

The only requirement is to write the descriptions above the Annotation or Type definition.

The following example documents the `@StreamCapable` annotation.

```dataweave
/**
* Annotation that marks a parameter as stream capable, which means that this
* field will consume an array of objects in a forward-only manner.
*/
@AnnotationTarget(targets = ["Parameter", "Variable"])
annotation StreamCapable()
```

The following example documents the `EncodingSettings` type found in the
[dw::extension::DataFormat](https://docs.mulesoft.com/dataweave/2.4/dw-dataformat) module.

```dataweave
/**
 * Represents encoding settings.
 */
@Since(version = "2.2.0")
type EncodingSettings = {
    /**
    * Encoding that the writer uses for output. Defaults to "UTF-8".
    */
    encoding?: String {defaultValue: "UTF-8"}
}
```

## See Also

- [Reusing Types from DataWeave Modules](https://docs.mulesoft.com/dataweave/2.12/dataweave-type-reuse-modules)

<!-- document id=b9c46ecb8c96a678fdcbb21a510c50f7b05d61a2917f4f2f456d85a8c92ec351 url=/mulesoft/current/en-us/dataweave/2.3/dataweave-create-module.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Create Custom Modules and Mappings

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

In addition to using the built-in DataWeave function modules (such as [dw::Core](https://docs.mulesoft.com/dataweave/2.3/dw-core) and
[dw::Crypto](https://docs.mulesoft.com/dataweave/2.3/dw-crypto)), you can also create and use custom modules and mapping files. The examples
demonstrate common data extraction and transformation approaches.

You write modules and mapping files in a DataWeave Language (`.dwl`) file and import into your Mule
app through DataWeave scripts in Mule components. Both modules and mapping files are useful when you
need to reuse the same functionality or feature over and over again.

- Custom modules can define functions, variables, types, and namespaces. You can import these
  modules into a DataWeave script to use the features.

- Custom mapping files are a type of module that contains a complete DataWeave script that you can
  import and use in another DataWeave script or reference in a Mule component.

Fields in many Mule connectors and components accept DataWeave expressions and scripts.

Note that if you want to import and use a built-in DataWeave function module, and not a custom one,
see [DataWeave Function Reference](https://docs.mulesoft.com/dataweave/2.3/dw-functions).

## Creating and Using DataWeave Mapping Files

You can store a DataWeave transformation in a `.dwl` mapping file (mapping module), then import the
file into another DataWeave script. Mapping files can be executed through the Transform Message
component, or you can import them into another mapping and execute them through the `main` function.

![A DataWeave script with a function to capitalize keys and map payload values](/mulesoft/current/en-us/dataweave/2.3/_images/dataweave-mapping-file.png)

Figure 1. Example: DataWeave Mapping File in a Studio Project

1.  In your Studio project, set up a subfolder and file for your mapping module:

    - You can create a subfolder in `src/main/resources` by navigating to New → Folder →
      \[your\_project\] → `src/main/resources`, then adding a folder named `modules`.

    - You can create a new file for your module in that folder by navigating to New → File →
      \[your\_project\] → `src/main/resources/modules`, then adding a DWL (DataWeave language) file
      such as `MyMapping.dwl`.

      Saving the module within `src/main/resources` makes it accessible for use in a DataWeave
      script. component in a Mule app in that project.

2.  Create your function in your mapping file, for example:

    Example: Mapping File Content

    ```dataweave
    %dw 2.0
    import dw::core::Strings
    fun capitalizeKey(value:String) = Strings::capitalize(value) ++ "Key"
    ---
    payload mapObject ((value, key) ->
        {
          (capitalizeKey(key as String)) : value
        }
      )
    ```

3.  Save your DWL function module file.

### Using a Mapping File in a DataWeave Script

To use a mapping file, you need to import it into a DataWeave script and use the `main` function to
access the body of the script in the mapping file.

Assume that you have created the [MyMapping.dwl](#mapping_file) file in
`/src/main/resources/modules` that contains this script.

To import and use the body expression from the `MyMapping.dwl` file (above) in DataWeave Mapping
file, you need to do this:

- Specify the `import` directive in the header.

- Invoke the `MyMapping::main` function. The function expects an input that follows the structure of
  the input that the mapping file uses. For example, the body of `MyMapping.dwl` expects an object
  of the form `{"key" : "value"}`.

Example: Importing and Using the Mapping in a DataWeave Script

```dataweave
%dw 2.0
import modules::MyMapping
output application/json
---
MyMapping::main(payload: { "user" : "bar" })
```

Here is the result:

Output

```json
{
  "UserKey": "bar"
}
```

Even though the [capitalizeKey](#mapping_file) function is private, it is still used through the
`main` function call, and the DataWeave mapping file is also able to import and reuse the
`dw::core::Strings` module.

## Creating and Using a Custom Module

The steps for creating a custom DataWeave module are almost identical to the steps for creating a
custom mapping file. The only difference is the contents of the `.dwl` file. Unlike a typical
DataWeave script or mapping file, a custom DataWeave module cannot contain an `output` directive,
body expression, or the separator (`---`) between header and body sections. (For guidance with
mappings, see [Creating and Using DataWeave Mapping Files](#create_dw_mapping).)

![A DataWeave script with a custom function module](/mulesoft/current/en-us/dataweave/2.3/_images/dataweave-function-custom.png)

Figure 2. Example: Custom Module in a Studio Project

A custom module file can only contain `var`, `fun`, `type`, and `ns` declarations, for example:

Example: Custom DataWeave Module

```dataweave
%dw 2.0
fun myFunc(myInput: String) = myInput ++ "_"
var name = "MyData"
ns mynamespace http://acme.com/bar
```

When you import a custom module into another DataWeave script, any functions, variables, types, and
namespaces defined in the module become available for use in the DataWeave body. In the next
example, a DataWeave script:

- Imports the module `MyModule` through the `import` directive in the header. In this case, the
  imported module is stored in a Studio project path `src/main/resources/modules/MyModule.dwl`

- Calls a function in `MyModule` by using `MyModule::myFunc("dataweave")`.

Example: Importing and Using a Custom DataWeave Module

```dataweave
%dw 2.0
import modules::MyModule
output application/json
---
MyModule::myFunc("dataweave") ++ "name"
```

There are several ways to import a module or elements in it:

- Import the module, for example: `import modules::MyModule`. In this case, you must include the
  name of the module when you call the element (here, a function) in it, for example:
  `MyModule::myFunc`.

- Import all elements from the module, for example: `import * from modules::MyModule`. In this case,
  you do not need to include the name of the module when you call the element. For example:
  `myFunc("dataweave") ++ "name"` works.

- Import specific elements from a module, for example: `import myFunc from modules::MyModule`. In
  this case, you do not need to include the name of the module when you call the element. For
  example: `myFunc("dataweave") ++ "name"` works. You can import multiple elements from the module
  like this, for example: `import myFunc someOtherFunction from modules::MyModule` (assuming both
  `myFunc` and `someOtherFunction` are defined in the module).

Output

```json
"dataweave_name"
```

## Assigning a Local Alias for an Imported Element

To avoid name clashes, you can use `as` to assign an alias for a custom module or its elements when
you import the module into a DataWeave script.

Assume that you define a custom module like this one in the file `MyModule.dwl`:

Example: Custom Module

```dataweave
%dw 2.0
fun myFunc(name:String) = name ++ "_"
var myVar = "Test"
```

When you import the custom module into a DataWeave script, you can create aliases to elements in the
custom module, for example:

Example: Applying an Alias to Imported Elements

```dataweave
%dw 2.0
import myFunc as appendDash, myVar as weaveName from modules::MyModule
var myVar = "Mapping"
output application/json
---
appendDash("dataweave") ++ weaveName ++ "_" ++ myVar
```

The script returns `"dataweave_Test_Mapping"`.

You can create an alias to the imported module, for example:

Example: Applying an Alias to an Imported Module

```dataweave
%dw 2.0
import modules::MyModule as WeaveMod
output application/json
---
WeaveMod::myFunc("dataweave")
```

## Referencing a DWL File

You can use DWL files directly in Mule connectors and components.

See [dwl File](https://docs.mulesoft.com/dataweave/2.3/dataweave-language-introduction#dwl_file) for details.

<!-- document id=40474a9b68e6a5307d7ccfd23565f651bcb5fffbf56cff9927b76b542dc3bf12 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-create-module.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Create Custom Modules and Mappings

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

In addition to using the built-in DataWeave function modules (such as [dw::Core](https://docs.mulesoft.com/dataweave/2.4/dw-core) and
[dw::Crypto](https://docs.mulesoft.com/dataweave/2.4/dw-crypto)), you can also create and use custom modules and mapping files. The examples
demonstrate common data extraction and transformation approaches.

You write modules and mapping files in a DataWeave Language (`.dwl`) file and import into your Mule
app through DataWeave scripts in Mule components. Both modules and mapping files are useful when you
need to reuse the same functionality or feature over and over again.

- Custom modules can define functions, variables, types, and namespaces. You can import these
  modules into a DataWeave script to use the features.

- Custom mapping files are a type of module that contains a complete DataWeave script that you can
  import and use in another DataWeave script or reference in a Mule component.

Fields in many Mule connectors and components accept DataWeave expressions and scripts.

Note that if you want to import and use a built-in DataWeave function module, and not a custom one,
see [DataWeave Function Reference](https://docs.mulesoft.com/dataweave/2.4/dw-functions).

## Creating and Using DataWeave Mapping Files

You can store a DataWeave transformation in a `.dwl` mapping file (mapping module), then import the
file into another DataWeave script. Mapping files can be executed through the Transform Message
component, or you can import them into another mapping and execute them through the `main` function.

![A DataWeave script with a function to capitalize keys and map payload values](/mulesoft/current/en-us/dataweave/2.4/_images/dataweave-mapping-file.png)

Figure 1. Example: DataWeave Mapping File in a Studio Project

1.  In your Studio project, set up a subfolder and file for your mapping module:

    - You can create a subfolder in `src/main/resources` by navigating to New → Folder →
      \[your\_project\] → `src/main/resources`, then adding a folder named `modules`.

    - You can create a new file for your module in that folder by navigating to New → File →
      \[your\_project\] → `src/main/resources/modules`, then adding a DWL (DataWeave language) file
      such as `MyMapping.dwl`.

      Saving the module within `src/main/resources` makes it accessible for use in any DataWeave
      script within the Mule app in that project.

2.  Create your function in your mapping file, for example:

    Example: Mapping File Content

    ```dataweave
    %dw 2.0
    import dw::core::Strings
    fun capitalizeKey(value:String) = Strings::capitalize(value) ++ "Key"
    ---
    payload mapObject ((value, key) ->
        {
          (capitalizeKey(key as String)) : value
        }
      )
    ```

3.  Save your DWL function module file.

### Using a Mapping File in a DataWeave Script

To use a mapping file, you need to import it into a DataWeave script and use the `main` function to
access the body of the script in the mapping file.

Assume that you have created the [MyMapping.dwl](#mapping_file) file in
`/src/main/resources/modules` that contains this script.

To import and use the body expression from the `MyMapping.dwl` file (above) in DataWeave Mapping
file, you need to do this:

- Specify the `import` directive in the header.

- Invoke the `MyMapping::main` function. The function expects an input that follows the structure of
  the input that the mapping file uses. For example, the body of `MyMapping.dwl` expects an object
  of the form `{"key" : "value"}`.

Example: Importing and Using the Mapping in a DataWeave Script

```dataweave
%dw 2.0
import modules::MyMapping
output application/json
---
MyMapping::main(payload: { "user" : "bar" })
```

Here is the result:

Output

```json
{
  "UserKey": "bar"
}
```

Even though the [capitalizeKey](#mapping_file) function is private, it is still used through the
`main` function call, and the DataWeave mapping file is also able to import and reuse the
`dw::core::Strings` module.

## Creating and Using a Custom Module

The steps for creating a custom DataWeave module are almost identical to the steps for creating a
custom mapping file. The only difference is the contents of the `.dwl` file. Unlike a typical
DataWeave script or mapping file, a custom DataWeave module cannot contain an `output` directive,
body expression, or the separator (`---`) between header and body sections. (For guidance with
mappings, see [Creating and Using DataWeave Mapping Files](#create_dw_mapping).)

![A DataWeave script with a custom function module](/mulesoft/current/en-us/dataweave/2.4/_images/dataweave-function-custom.png)

Figure 2. Example: Custom Module in a Studio Project

A custom module file can only contain `var`, `fun`, `type`, and `ns` declarations, for example:

Example: Custom DataWeave Module

```dataweave
%dw 2.0
var name = "MyData"
fun myFunc(myInput: String) = myInput ++ "_"
type User = {
    name: String,
    lastname: String
}
ns mynamespace http://acme.com/bar
```

When you import a custom module into another DataWeave script, any functions, variables, types, and
namespaces defined in the module become available for use in the DataWeave body. In the next
example, a DataWeave script:

- Imports the module `MyModule` through the `import` directive in the header. In this case, the
  imported module is stored in a Studio project path `src/main/resources/modules/MyModule.dwl`

- Calls a function in `MyModule` by using `MyModule::myFunc("dataweave")`.

Example: Importing and Using a Custom DataWeave Module

```dataweave
%dw 2.0
import modules::MyModule
output application/json
---
MyModule::myFunc("dataweave") ++ "name"
```

There are several ways to import a module or elements in it:

- Import the module, for example: `import modules::MyModule`. In this case, you must include the
  name of the module when you call the element (here, a function) in it, for example:
  `MyModule::myFunc`.

- Import all elements from the module, for example: `import * from modules::MyModule`. In this case,
  you do not need to include the name of the module when you call the element. For example:
  `myFunc("dataweave") ++ "name"` works.

- Import specific elements from a module, for example: `import myFunc from modules::MyModule`. In
  this case, you do not need to include the name of the module when you call the element. For
  example: `myFunc("dataweave") ++ "name"` works. You can import multiple elements from the module
  like this, for example: `import myFunc someOtherFunction from modules::MyModule` (assuming both
  `myFunc` and `someOtherFunction` are defined in the module).

Output

```json
"dataweave_name"
```

## Assigning a Local Alias for an Imported Element

To avoid name clashes, you can use `as` to assign an alias for a custom module or its elements when
you import the module into a DataWeave script.

Assume that you define a custom module like this one in the file `MyModule.dwl`:

Example: Custom Module

```dataweave
%dw 2.0
fun myFunc(name:String) = name ++ "_"
var myVar = "Test"
```

When you import the custom module into a DataWeave script, you can create aliases to elements in the
custom module, for example:

Example: Applying an Alias to Imported Elements

```dataweave
%dw 2.0
import myFunc as appendDash, myVar as weaveName from modules::MyModule
var myVar = "Mapping"
output application/json
---
appendDash("dataweave") ++ weaveName ++ "_" ++ myVar
```

The script returns `"dataweave_Test_Mapping"`.

You can create an alias to the imported module, for example:

Example: Applying an Alias to an Imported Module

```dataweave
%dw 2.0
import modules::MyModule as WeaveMod
output application/json
---
WeaveMod::myFunc("dataweave")
```

## Referencing a DWL File

You can use DWL files directly in Mule connectors and components.

See [dwl File](https://docs.mulesoft.com/dataweave/2.4/dataweave-language-introduction#dwl_file) for details.

## Writing Documentation for Custom DataWeave Modules

DataWeave supports use of the AsciiDoc text format for documenting your functions, types,
annotations, and the modules that contain them.

### Documenting Your DataWeave Functions

DataWeave defines a multi-section template for documenting function code. The template provides
sections for the following:

- A description of the function.

- Parameter descriptions in an AsciiDoc table format.

- Example code that includes sections for any input, the DataWeave script, and the resulting output.

To define parameter and example sections below the function description, the template uses AsciiDoc
heading grammar:

- `=== Parameters`

- `=== Example`

  - `==== Source`

  - `==== Input`

  - `==== Output`

The following function template provides guidance on documenting the function. As the template
notes, some sections are optional.

```DataWeave
/**
* %Replace with your function description%
*
*
* %Add additional information to your function description% (optional section)
*
* === Parameters (optional section)
*
* [%header, cols="1,1,3"]
* |===
* | Name | Type | Description
* | %`The parameter name`% | %`The parameter type`% | %The parameter description%  (one row per param)
* |===
*
* === Example (optional section)
*
* %The example description% (optional)
*
* ==== Source (optional section)
*
* [source,%The language%,linenums] (optional)
* ----
* YOUR CODE
* ----
*
* ==== Input (optional section)
*
* The input description (optional)
*
* [source,%The language%,linenums] (optional)
* ----
* YOUR CODE
* ----
*
* ==== Output (optional section)
*
* %The output description% (optional)
*
* [source,%The language%,linenums] (optional)
* ----
* YOUR CODE
* ----
*/
```

#### Description Section

This section provides a description of the function. The section starts at the top of the comments
and extends to the line before the first section heading. If there is no section header, the
description extends to the end of the comments for the function.

A description consists of the following parts:

- Short description: The first paragraph, which provides the primary description of the function.

- Long description: Any additional information about the function. This optional description begins
  two line breaks below the short description.

See the [example](#example-documentation) that includes a description with sections for the
parameters and examples.

Each part is useful for auto-generated documentation.

#### Parameters Section

The optional `=== Parameters` section describes parameters of the function.

The template uses AsciiDoc table format to document each parameter in a table row.

\[%header, cols="1,1,3"\] |=== | Name | Type | Description | yourParameter1 | The parameter type |
Your description here. | yourParameter2 | The parameter type | Your description here. |===

#### Example Section

You can use zero or more `=== Example` sections to provide any examples needed to illustrate how
your function works.

This section contains the following optional subsections:

- `==== Input` for input to the DataWeave script.

- `==== Source` for the DataWeave script.

- `==== Output` for output generated by the script.

All subsections follow the same template, which includes an optional description and an optional
code section:

Your section description

\[source,%The language%,linenums\]
----

YOUR CODE
----

The following example shows the [log](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-log)
function documentation.

/\*\* \* Without changing the value of the input, \`log\` returns the input as a system \* log. So
this makes it very simple to debug your code, because any expression or subexpression can be wrapped
\* with \*log\* and the result will be printed out without modifying the result of the expression.
\* The output is going to be printed in application/dw format. \* (1) \* \* The prefix parameter is
optional and allows to easily find the log output. \* \* \* Use this function to help with debugging
DataWeave scripts. A Mule app \* outputs the results through the \`DefaultLoggingService\`, which
you can see \* in the Studio console. \* \* === Parameters \* \* \[%header, cols="1,13"\] \* |=== \*
| Name | Type | Description \* | \`prefix\` | \`String\` | An optional string that typically
describes the log. \* | \`value\` | \`T\` | The value to log. \* |=== \* \* === Example \* \* This
example logs the specified message. Note that the \`DefaultLoggingService\` \* in a Mule app that is
running in Studio returns the message \* \`WARNING - "Houston, we have a problem,"\` adding the dash
\`-\` between the \* prefix and value. The Logger component's \`LoggerMessageProcessor\` returns \*
the input string \`"Houston, we have a problem."\`, without the \`WARNING\` prefix. \* \* ====
Source \* \* \[source,DataWeave,linenums\] \* ---- \* %dw 2.0 \* output application/json \* --- \*
log("WARNING", "Houston, we have a problem") \* ---- \* \* ==== Output \* \* \`Console Output\` \*
\* \[source,XML,linenums\] \* ---- \* "WARNING - Houston, we have a problem" \* ---- \* \*
\`Expression Output\` \* \* \[source,XML,linenums\] \* ---- \* "Houston, we have a problem" \* ----
\* \* === Example \* \* This example shows how to log the result of expression \`myUser.user\`
without modifying the \* original expression \`myUser.user.friend.name\`. \* \* ==== Source \* \*
\[source,DataWeave,linenums\] \* ---- \* %dw 2.0 \* output application/json \* \* var myUser =
{user: {friend: {name: "Shoki"}, id: 1, name: "Tomo"}, accountId: "leansh" } \* --- \* log("User",
myUser.user).friend.name \* ---- \* \* ==== Output \* \* \`Console output\` \* \*
\[source,console,linenums\] \* ---- \* User - { \* friend: { \* name: "Shoki" \* }, \* id: 1, \*
name: "Tomo" \* } \* ---- \* \* \`Expression Output\` \* \* \[source,DataWeave,linenums\] \* ---- \*
"Shoki" \* ---- \*/

### Documenting Your DataWeave Modules

The DataWeave module description does not follow a structured template.

The only requirement is to place the documentation above the DataWeave version tag.

The following example documents the [dw::Core](https://docs.mulesoft.com/dataweave/2.4/dw-core)
module:

```dataweave
/**
 * This module contains core DataWeave functions for data transformations.
 * It is automatically imported into any DataWeave script. For documentation
 * on DataWeave _1.0_ functions, see
 * https://docs.mulesoft.com/dataweave/1.2/dataweave-operators[DataWeave Operators].
 */
%dw 2.0
```

### Documenting Your Annotation and Types

Annotation and Types documentation do not follow a structured template.

The only requirement is to write the descriptions above the Annotation or Type definition.

The following example documents the `@StreamCapable` annotation.

```dataweave
/**
* Annotation that marks a parameter as stream capable, which means that this
* field will consume an array of objects in a forward-only manner.
*/
@AnnotationTarget(targets = ["Parameter", "Variable"])
annotation StreamCapable()
```

The following example documents the `EncodingSettings` type found in the
[dw::extension::DataFormat](https://docs.mulesoft.com/dataweave/2.4/dw-dataformat) module.

```dataweave
/**
 * Represents encoding settings.
 */
@Since(version = "2.2.0")
type EncodingSettings = {
    /**
    * Encoding that the writer uses for output. Defaults to "UTF-8".
    */
    encoding?: String {defaultValue: "UTF-8"}
}
```

<!-- document id=9a40e65717af74414e9b1f64c87e618044e81275a593fb999549a17c0ac06535 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-create-module.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Create Custom Modules and Mappings

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

In addition to using the built-in DataWeave function modules (such as [dw::Core](https://docs.mulesoft.com/dataweave/2.6/dw-core) and
[dw::Crypto](https://docs.mulesoft.com/dataweave/2.6/dw-crypto)), you can also create and use custom modules and mapping files. The examples
demonstrate common data extraction and transformation approaches.

You write modules and mapping files in a DataWeave Language (`.dwl`) file and import into your Mule
app through DataWeave scripts in Mule components. Both modules and mapping files are useful when you
need to reuse the same functionality or feature over and over again.

- Custom modules can define functions, variables, types, and namespaces. You can import these
  modules into a DataWeave script to use the features.

- Custom mapping files are a type of module that contains a complete DataWeave script that you can
  import and use in another DataWeave script or reference in a Mule component.

Fields in many Mule connectors and components accept DataWeave expressions and scripts.

Note that if you want to import and use a built-in DataWeave function module, and not a custom one,
see [DataWeave Function Reference](https://docs.mulesoft.com/dataweave/2.6/dw-functions).

## Creating and Using DataWeave Mapping Files

You can store a DataWeave transformation in a `.dwl` mapping file (mapping module), then import the
file into another DataWeave script. Mapping files can be executed through the Transform Message
component, or you can import them into another mapping and execute them through the `main` function.

![A DataWeave script with a function to capitalize keys and map payload values](/mulesoft/current/en-us/dataweave/2.6/_images/dataweave-mapping-file.png)

Figure 1. Example: DataWeave Mapping File in a Studio Project

1.  In your Studio project, set up a subfolder and file for your mapping module:

    - You can create a subfolder in `src/main/resources` by navigating to New → Folder →
      \[your\_project\] → `src/main/resources`, then adding a folder named `modules`.

    - You can create a new file for your module in that folder by navigating to New → File →
      \[your\_project\] → `src/main/resources/modules`, then adding a DWL (DataWeave language) file
      such as `MyMapping.dwl`.

      Saving the module within `src/main/resources` makes it accessible for use in any DataWeave
      script within the Mule app in that project.

2.  Create your function in your mapping file, for example:

    Example: Mapping File Content

    ```dataweave
    %dw 2.0
    import dw::core::Strings
    fun capitalizeKey(value:String) = Strings::capitalize(value) ++ "Key"
    ---
    payload mapObject ((value, key) ->
        {
          (capitalizeKey(key as String)) : value
        }
      )
    ```

3.  Save your DWL function module file.

### Using a Mapping File in a DataWeave Script

To use a mapping file, you need to import it into a DataWeave script and use the `main` function to
access the body of the script in the mapping file.

Assume that you have created the [MyMapping.dwl](#mapping_file) file in
`/src/main/resources/modules` that contains this script.

To import and use the body expression from the `MyMapping.dwl` file (above) in DataWeave Mapping
file, you need to do this:

- Specify the `import` directive in the header.

- Invoke the `MyMapping::main` function. The function expects an input that follows the structure of
  the input that the mapping file uses. For example, the body of `MyMapping.dwl` expects an object
  of the form `{"key" : "value"}`.

Example: Importing and Using the Mapping in a DataWeave Script

```dataweave
%dw 2.0
import modules::MyMapping
output application/json
---
MyMapping::main(payload: { "user" : "bar" })
```

Here is the result:

Output

```json
{
  "UserKey": "bar"
}
```

Even though the [capitalizeKey](#mapping_file) function is private, it is still used through the
`main` function call, and the DataWeave mapping file is also able to import and reuse the
`dw::core::Strings` module.

## Creating and Using a Custom Module

The steps for creating a custom DataWeave module are almost identical to the steps for creating a
custom mapping file. The only difference is the contents of the `.dwl` file. Unlike a typical
DataWeave script or mapping file, a custom DataWeave module cannot contain an `output` directive,
body expression, or the separator (`---`) between header and body sections. (For guidance with
mappings, see [Creating and Using DataWeave Mapping Files](#create_dw_mapping).)

![A DataWeave script with a custom function module](/mulesoft/current/en-us/dataweave/2.6/_images/dataweave-function-custom.png)

Figure 2. Example: Custom Module in a Studio Project

A custom module file can only contain `var`, `fun`, `type`, and `ns` declarations, for example:

Example: Custom DataWeave Module

```dataweave
%dw 2.0
var name = "MyData"
fun myFunc(myInput: String) = myInput ++ "_"
type User = {
    name: String,
    lastname: String
}
ns mynamespace http://acme.com/bar
```

When you import a custom module into another DataWeave script, any functions, variables, types, and
namespaces defined in the module become available for use in the DataWeave body. In the next
example, a DataWeave script:

- Imports the module `MyModule` through the `import` directive in the header. In this case, the
  imported module is stored in a Studio project path `src/main/resources/modules/MyModule.dwl`

- Calls a function in `MyModule` by using `MyModule::myFunc("dataweave")`.

Example: Importing and Using a Custom DataWeave Module

```dataweave
%dw 2.0
import modules::MyModule
output application/json
---
MyModule::myFunc("dataweave") ++ "name"
```

There are several ways to import a module or elements in it:

- Import the module, for example: `import modules::MyModule`. In this case, you must include the
  name of the module when you call the element (here, a function) in it, for example:
  `MyModule::myFunc`.

- Import all elements from the module, for example: `import * from modules::MyModule`. In this case,
  you do not need to include the name of the module when you call the element. For example:
  `myFunc("dataweave") ++ "name"` works.

- Import specific elements from a module, for example: `import myFunc from modules::MyModule`. In
  this case, you do not need to include the name of the module when you call the element. For
  example: `myFunc("dataweave") ++ "name"` works. You can import multiple elements from the module
  like this, for example: `import myFunc someOtherFunction from modules::MyModule` (assuming both
  `myFunc` and `someOtherFunction` are defined in the module).

Output

```json
"dataweave_name"
```

## Assigning a Local Alias for an Imported Element

To avoid name clashes, you can use `as` to assign an alias for a custom module or its elements when
you import the module into a DataWeave script.

Assume that you define a custom module like this one in the file `MyModule.dwl`:

Example: Custom Module

```dataweave
%dw 2.0
fun myFunc(name:String) = name ++ "_"
var myVar = "Test"
```

When you import the custom module into a DataWeave script, you can create aliases to elements in the
custom module, for example:

Example: Applying an Alias to Imported Elements

```dataweave
%dw 2.0
import myFunc as appendDash, myVar as weaveName from modules::MyModule
var myVar = "Mapping"
output application/json
---
appendDash("dataweave") ++ weaveName ++ "_" ++ myVar
```

The script returns `"dataweave_Test_Mapping"`.

You can create an alias to the imported module, for example:

Example: Applying an Alias to an Imported Module

```dataweave
%dw 2.0
import modules::MyModule as WeaveMod
output application/json
---
WeaveMod::myFunc("dataweave")
```

## Referencing a DWL File

You can use DWL files directly in Mule connectors and components.

See [dwl File](https://docs.mulesoft.com/dataweave/2.6/dataweave-language-introduction#dwl_file) for details.

## Writing Documentation for Custom DataWeave Modules

DataWeave supports use of the AsciiDoc text format for documenting your functions, types,
annotations, and the modules that contain them.

### Documenting Your DataWeave Functions

DataWeave defines a multi-section template for documenting function code. The template provides
sections for the following:

- A description of the function.

- Parameter descriptions in an AsciiDoc table format.

- Example code that includes sections for any input, the DataWeave script, and the resulting output.

To define parameter and example sections below the function description, the template uses AsciiDoc
heading grammar:

- `=== Parameters`

- `=== Example`

  - `==== Source`

  - `==== Input`

  - `==== Output`

The following function template provides guidance on documenting the function. As the template
notes, some sections are optional.

```DataWeave
/**
* %Replace with your function description%
*
*
* %Add additional information to your function description% (optional section)
*
* === Parameters (optional section)
*
* [%header, cols="1,1,3"]
* |===
* | Name | Type | Description
* | %`The parameter name`% | %`The parameter type`% | %The parameter description%  (one row per param)
* |===
*
* === Example (optional section)
*
* %The example description% (optional)
*
* ==== Source (optional section)
*
* [source,%The language%,linenums] (optional)
* ----
* YOUR CODE
* ----
*
* ==== Input (optional section)
*
* The input description (optional)
*
* [source,%The language%,linenums] (optional)
* ----
* YOUR CODE
* ----
*
* ==== Output (optional section)
*
* %The output description% (optional)
*
* [source,%The language%,linenums] (optional)
* ----
* YOUR CODE
* ----
*/
```

#### Description Section

This section provides a description of the function. The section starts at the top of the comments
and extends to the line before the first section heading. If there is no section header, the
description extends to the end of the comments for the function.

A description consists of the following parts:

- Short description: The first paragraph, which provides the primary description of the function.

- Long description: Any additional information about the function. This optional description begins
  two line breaks below the short description.

See the [example](#example-documentation) that includes a description with sections for the
parameters and examples.

Each part is useful for auto-generated documentation.

#### Parameters Section

The optional `=== Parameters` section describes parameters of the function.

The template uses AsciiDoc table format to document each parameter in a table row.

\[%header, cols="1,1,3"\] |=== | Name | Type | Description | yourParameter1 | The parameter type |
Your description here. | yourParameter2 | The parameter type | Your description here. |===

#### Example Section

You can use zero or more `=== Example` sections to provide any examples needed to illustrate how
your function works.

This section contains the following optional subsections:

- `==== Input` for input to the DataWeave script.

- `==== Source` for the DataWeave script.

- `==== Output` for output generated by the script.

All subsections follow the same template, which includes an optional description and an optional
code section:

Your section description

\[source,%The language%,linenums\]
----

YOUR CODE
----

The following example shows the [log](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-log)
function documentation.

/\*\* \* Without changing the value of the input, \`log\` returns the input as a system \* log. So
this makes it very simple to debug your code, because any expression or subexpression can be wrapped
\* with \*log\* and the result will be printed out without modifying the result of the expression.
\* The output is going to be printed in application/dw format. \* (1) \* \* The prefix parameter is
optional and allows to easily find the log output. \* \* \* Use this function to help with debugging
DataWeave scripts. A Mule app \* outputs the results through the \`DefaultLoggingService\`, which
you can see \* in the Studio console. \* \* === Parameters \* \* \[%header, cols="1,13"\] \* |=== \*
| Name | Type | Description \* | \`prefix\` | \`String\` | An optional string that typically
describes the log. \* | \`value\` | \`T\` | The value to log. \* |=== \* \* === Example \* \* This
example logs the specified message. Note that the \`DefaultLoggingService\` \* in a Mule app that is
running in Studio returns the message \* \`WARNING - "Houston, we have a problem,"\` adding the dash
\`-\` between the \* prefix and value. The Logger component's \`LoggerMessageProcessor\` returns \*
the input string \`"Houston, we have a problem."\`, without the \`WARNING\` prefix. \* \* ====
Source \* \* \[source,DataWeave,linenums\] \* ---- \* %dw 2.0 \* output application/json \* --- \*
log("WARNING", "Houston, we have a problem") \* ---- \* \* ==== Output \* \* \`Console Output\` \*
\* \[source,XML,linenums\] \* ---- \* "WARNING - Houston, we have a problem" \* ---- \* \*
\`Expression Output\` \* \* \[source,XML,linenums\] \* ---- \* "Houston, we have a problem" \* ----
\* \* === Example \* \* This example shows how to log the result of expression \`myUser.user\`
without modifying the \* original expression \`myUser.user.friend.name\`. \* \* ==== Source \* \*
\[source,DataWeave,linenums\] \* ---- \* %dw 2.0 \* output application/json \* \* var myUser =
{user: {friend: {name: "Shoki"}, id: 1, name: "Tomo"}, accountId: "leansh" } \* --- \* log("User",
myUser.user).friend.name \* ---- \* \* ==== Output \* \* \`Console output\` \* \*
\[source,console,linenums\] \* ---- \* User - { \* friend: { \* name: "Shoki" \* }, \* id: 1, \*
name: "Tomo" \* } \* ---- \* \* \`Expression Output\` \* \* \[source,DataWeave,linenums\] \* ---- \*
"Shoki" \* ---- \*/

### Documenting Your DataWeave Modules

The DataWeave module description does not follow a structured template.

The only requirement is to place the documentation above the DataWeave version tag.

The following example documents the [dw::Core](https://docs.mulesoft.com/dataweave/2.4/dw-core)
module:

```dataweave
/**
 * This module contains core DataWeave functions for data transformations.
 * It is automatically imported into any DataWeave script. For documentation
 * on DataWeave _1.0_ functions, see
 * https://docs.mulesoft.com/dataweave/latest/dataweave-operators[DataWeave Operators].
 */
%dw 2.0
```

### Documenting Your Annotation and Types

Annotation and Types documentation do not follow a structured template.

The only requirement is to write the descriptions above the Annotation or Type definition.

The following example documents the `@StreamCapable` annotation.

```dataweave
/**
* Annotation that marks a parameter as stream capable, which means that this
* field will consume an array of objects in a forward-only manner.
*/
@AnnotationTarget(targets = ["Parameter", "Variable"])
annotation StreamCapable()
```

The following example documents the `EncodingSettings` type found in the
[dw::extension::DataFormat](https://docs.mulesoft.com/dataweave/2.4/dw-dataformat) module.

```dataweave
/**
 * Represents encoding settings.
 */
@Since(version = "2.2.0")
type EncodingSettings = {
    /**
    * Encoding that the writer uses for output. Defaults to "UTF-8".
    */
    encoding?: String {defaultValue: "UTF-8"}
}
```

## See Also

- [Reusing Types from DataWeave Modules](https://docs.mulesoft.com/dataweave/2.6/dataweave-type-reuse-modules)

<!-- document id=7c3477b3ec29d56d68c0f91d993440ad886da980a2557fb5eb983ce36dc24c11 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-create-module.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Create Custom Modules and Mappings

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

In addition to using the built-in DataWeave function modules (such as [dw::Core](https://docs.mulesoft.com/dataweave/2.9/dw-core) and
[dw::Crypto](https://docs.mulesoft.com/dataweave/2.9/dw-crypto)), you can also create and use custom modules and mapping files. The examples
demonstrate common data extraction and transformation approaches.

You write modules and mapping files in a DataWeave Language (`.dwl`) file and import into your Mule
app through DataWeave scripts in Mule components. Both modules and mapping files are useful when you
need to reuse the same functionality or feature over and over again.

- Custom modules can define functions, variables, types, and namespaces. You can import these
  modules into a DataWeave script to use the features.

- Custom mapping files are a type of module that contains a complete DataWeave script that you can
  import and use in another DataWeave script or reference in a Mule component.

Fields in many Mule connectors and components accept DataWeave expressions and scripts.

Note that if you want to import and use a built-in DataWeave function module, and not a custom one,
see [DataWeave Function Reference](https://docs.mulesoft.com/dataweave/2.9/dw-functions).

## Creating and Using DataWeave Mapping Files

You can store a DataWeave transformation in a `.dwl` mapping file (mapping module), then import the
file into another DataWeave script. Mapping files can be executed through the Transform Message
component, or you can import them into another mapping and execute them through the `main` function.

![Text editor showing a DataWeave mapping file in a Studio project](/mulesoft/current/en-us/dataweave/2.9/_images/dataweave-mapping-file.png)

Figure 1. Example: DataWeave Mapping File in a Studio Project

1.  In your Studio project, set up a subfolder and file for your mapping module:

    - You can create a subfolder in `src/main/resources` by navigating to New → Folder →
      \[your\_project\] → `src/main/resources`, then adding a folder named `modules`.

    - You can create a new file for your module in that folder by navigating to New → File →
      \[your\_project\] → `src/main/resources/modules`, then adding a DWL (DataWeave language) file
      such as `MyMapping.dwl`.

      Saving the module within `src/main/resources` makes it accessible for use in any DataWeave
      script within the Mule app in that project.

2.  Create your function in your mapping file, for example:

    Example: Mapping File Content

    ```dataweave
    %dw 2.0
    import dw::core::Strings
    fun capitalizeKey(value:String) = Strings::capitalize(value) ++ "Key"
    ---
    payload mapObject ((value, key) ->
        {
          (capitalizeKey(key as String)) : value
        }
      )
    ```

3.  Save your DWL function module file.

### Using a Mapping File in a DataWeave Script

To use a mapping file, you need to import it into a DataWeave script and use the `main` function to
access the body of the script in the mapping file.

Assume that you have created the [MyMapping.dwl](#mapping_file) file in
`/src/main/resources/modules` that contains this script.

To import and use the body expression from the `MyMapping.dwl` file (above) in DataWeave Mapping
file, you need to do this:

- Specify the `import` directive in the header.

- Invoke the `MyMapping::main` function. The function expects an input that follows the structure of
  the input that the mapping file uses. For example, the body of `MyMapping.dwl` expects an object
  of the form `{"key" : "value"}`.

Example: Importing and Using the Mapping in a DataWeave Script

```dataweave
%dw 2.0
import modules::MyMapping
output application/json
---
MyMapping::main(payload: { "user" : "bar" })
```

Here is the result:

Output

```json
{
  "UserKey": "bar"
}
```

Even though the [capitalizeKey](#mapping_file) function is private, it is still used through the
`main` function call, and the DataWeave mapping file is also able to import and reuse the
`dw::core::Strings` module.

## Creating and Using a Custom Module

The steps for creating a custom DataWeave module are almost identical to the steps for creating a
custom mapping file. The only difference is the contents of the `.dwl` file. Unlike a typical
DataWeave script or mapping file, a custom DataWeave module cannot contain an `output` directive,
body expression, or the separator (`---`) between header and body sections. (For guidance with
mappings, see [Creating and Using DataWeave Mapping Files](#create_dw_mapping).)

![A DataWeave script with a custom function module](/mulesoft/current/en-us/dataweave/2.9/_images/dataweave-function-custom.png)

Figure 2. Example: Custom Module in a Studio Project

A custom module file can only contain `var`, `fun`, `type`, and `ns` declarations, for example:

Example: Custom DataWeave Module

```dataweave
%dw 2.0
var name = "MyData"
fun myFunc(myInput: String) = myInput ++ "_"
type User = {
    name: String,
    lastname: String
}
ns mynamespace http://acme.com/bar
```

When you import a custom module into another DataWeave script, any functions, variables, types, and
namespaces defined in the module become available for use in the DataWeave body. In the next
example, a DataWeave script:

- Imports the module `MyModule` through the `import` directive in the header. In this case, the
  imported module is stored in a Studio project path `src/main/resources/modules/MyModule.dwl`

- Calls a function in `MyModule` by using `MyModule::myFunc("dataweave")`.

Example: Importing and Using a Custom DataWeave Module

```dataweave
%dw 2.0
import modules::MyModule
output application/json
---
MyModule::myFunc("dataweave") ++ "name"
```

There are several ways to import a module or elements in it:

- Import the module, for example: `import modules::MyModule`. In this case, you must include the
  name of the module when you call the element (here, a function) in it, for example:
  `MyModule::myFunc`.

- Import all elements from the module, for example: `import * from modules::MyModule`. In this case,
  you do not need to include the name of the module when you call the element. For example:
  `myFunc("dataweave") ++ "name"` works.

- Import specific elements from a module, for example: `import myFunc from modules::MyModule`. In
  this case, you do not need to include the name of the module when you call the element. For
  example: `myFunc("dataweave") ++ "name"` works. You can import multiple elements from the module
  like this, for example: `import myFunc someOtherFunction from modules::MyModule` (assuming both
  `myFunc` and `someOtherFunction` are defined in the module).

Output

```json
"dataweave_name"
```

## Assigning a Local Alias for an Imported Element

To avoid name clashes, you can use `as` to assign an alias for a custom module or its elements when
you import the module into a DataWeave script.

Assume that you define a custom module like this one in the file `MyModule.dwl`:

Example: Custom Module

```dataweave
%dw 2.0
fun myFunc(name:String) = name ++ "_"
var myVar = "Test"
```

When you import the custom module into a DataWeave script, you can create aliases to elements in the
custom module, for example:

Example: Applying an Alias to Imported Elements

```dataweave
%dw 2.0
import myFunc as appendDash, myVar as weaveName from modules::MyModule
var myVar = "Mapping"
output application/json
---
appendDash("dataweave") ++ weaveName ++ "_" ++ myVar
```

The script returns `"dataweave_Test_Mapping"`.

You can create an alias to the imported module, for example:

Example: Applying an Alias to an Imported Module

```dataweave
%dw 2.0
import modules::MyModule as WeaveMod
output application/json
---
WeaveMod::myFunc("dataweave")
```

## Referencing a DWL File

You can use DWL files directly in Mule connectors and components.

See [dwl File](https://docs.mulesoft.com/dataweave/2.9/dataweave-language-introduction#dwl_file) for details.

## Writing Documentation for Custom DataWeave Modules

DataWeave supports use of the AsciiDoc text format for documenting your functions, types,
annotations, and the modules that contain them.

### Documenting Your DataWeave Functions

DataWeave defines a multi-section template for documenting function code. The template provides
sections for the following:

- A description of the function.

- Parameter descriptions in an AsciiDoc table format.

- Example code that includes sections for any input, the DataWeave script, and the resulting output.

To define parameter and example sections below the function description, the template uses AsciiDoc
heading grammar:

- `=== Parameters`

- `=== Example`

  - `==== Source`

  - `==== Input`

  - `==== Output`

The following function template provides guidance on documenting the function. As the template
notes, some sections are optional.

```DataWeave
/**
* %Replace with your function description%
*
*
* %Add additional information to your function description% (optional section)
*
* === Parameters (optional section)
*
* [%header, cols="1,1,3"]
* |===
* | Name | Type | Description
* | %`The parameter name`% | %`The parameter type`% | %The parameter description%  (one row per param)
* |===
*
* === Example (optional section)
*
* %The example description% (optional)
*
* ==== Source (optional section)
*
* [source,%The language%,linenums] (optional)
* ----
* YOUR CODE
* ----
*
* ==== Input (optional section)
*
* The input description (optional)
*
* [source,%The language%,linenums] (optional)
* ----
* YOUR CODE
* ----
*
* ==== Output (optional section)
*
* %The output description% (optional)
*
* [source,%The language%,linenums] (optional)
* ----
* YOUR CODE
* ----
*/
```

#### Description Section

This section provides a description of the function. The section starts at the top of the comments
and extends to the line before the first section heading. If there is no section header, the
description extends to the end of the comments for the function.

A description consists of the following parts:

- Short description: The first paragraph, which provides the primary description of the function.

- Long description: Any additional information about the function. This optional description begins
  two line breaks below the short description.

See the [example](#example-documentation) that includes a description with sections for the
parameters and examples.

Each part is useful for auto-generated documentation.

#### Parameters Section

The optional `=== Parameters` section describes parameters of the function.

The template uses AsciiDoc table format to document each parameter in a table row.

\[%header, cols="1,1,3"\] |=== | Name | Type | Description | yourParameter1 | The parameter type |
Your description here. | yourParameter2 | The parameter type | Your description here. |===

#### Example Section

You can use zero or more `=== Example` sections to provide any examples needed to illustrate how
your function works.

This section contains the following optional subsections:

- `==== Input` for input to the DataWeave script.

- `==== Source` for the DataWeave script.

- `==== Output` for output generated by the script.

All subsections follow the same template, which includes an optional description and an optional
code section:

Your section description

\[source,%The language%,linenums\]
----

YOUR CODE
----

The following example shows the [log](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-log)
function documentation.

/\*\* \* Without changing the value of the input, \`log\` returns the input as a system \* log. So
this makes it very simple to debug your code, because any expression or subexpression can be wrapped
\* with \*log\* and the result will be printed out without modifying the result of the expression.
\* The output is going to be printed in application/dw format. \* (1) \* \* The prefix parameter is
optional and allows to easily find the log output. \* \* \* Use this function to help with debugging
DataWeave scripts. A Mule app \* outputs the results through the \`DefaultLoggingService\`, which
you can see \* in the Studio console. \* \* === Parameters \* \* \[%header, cols="1,13"\] \* |=== \*
| Name | Type | Description \* | \`prefix\` | \`String\` | An optional string that typically
describes the log. \* | \`value\` | \`T\` | The value to log. \* |=== \* \* === Example \* \* This
example logs the specified message. Note that the \`DefaultLoggingService\` \* in a Mule app that is
running in Studio returns the message \* \`WARNING - "Houston, we have a problem,"\` adding the dash
\`-\` between the \* prefix and value. The Logger component's \`LoggerMessageProcessor\` returns \*
the input string \`"Houston, we have a problem."\`, without the \`WARNING\` prefix. \* \* ====
Source \* \* \[source,DataWeave,linenums\] \* ---- \* %dw 2.0 \* output application/json \* --- \*
log("WARNING", "Houston, we have a problem") \* ---- \* \* ==== Output \* \* \`Console Output\` \*
\* \[source,XML,linenums\] \* ---- \* "WARNING - Houston, we have a problem" \* ---- \* \*
\`Expression Output\` \* \* \[source,XML,linenums\] \* ---- \* "Houston, we have a problem" \* ----
\* \* === Example \* \* This example shows how to log the result of expression \`myUser.user\`
without modifying the \* original expression \`myUser.user.friend.name\`. \* \* ==== Source \* \*
\[source,DataWeave,linenums\] \* ---- \* %dw 2.0 \* output application/json \* \* var myUser =
{user: {friend: {name: "Shoki"}, id: 1, name: "Tomo"}, accountId: "leansh" } \* --- \* log("User",
myUser.user).friend.name \* ---- \* \* ==== Output \* \* \`Console output\` \* \*
\[source,console,linenums\] \* ---- \* User - { \* friend: { \* name: "Shoki" \* }, \* id: 1, \*
name: "Tomo" \* } \* ---- \* \* \`Expression Output\` \* \* \[source,DataWeave,linenums\] \* ---- \*
"Shoki" \* ---- \*/

### Documenting Your DataWeave Modules

The DataWeave module description does not follow a structured template.

The only requirement is to place the documentation above the DataWeave version tag.

The following example documents the [dw::Core](https://docs.mulesoft.com/dataweave/2.4/dw-core)
module:

```dataweave
/**
 * This module contains core DataWeave functions for data transformations.
 * It is automatically imported into any DataWeave script. For documentation
 * on DataWeave _1.0_ functions, see
 * https://docs.mulesoft.com/dataweave/latest/dataweave-operators[DataWeave Operators].
 */
%dw 2.0
```

### Documenting Your Annotation and Types

Annotation and Types documentation do not follow a structured template.

The only requirement is to write the descriptions above the Annotation or Type definition.

The following example documents the `@StreamCapable` annotation.

```dataweave
/**
* Annotation that marks a parameter as stream capable, which means that this
* field will consume an array of objects in a forward-only manner.
*/
@AnnotationTarget(targets = ["Parameter", "Variable"])
annotation StreamCapable()
```

The following example documents the `EncodingSettings` type found in the
[dw::extension::DataFormat](https://docs.mulesoft.com/dataweave/2.4/dw-dataformat) module.

```dataweave
/**
 * Represents encoding settings.
 */
@Since(version = "2.2.0")
type EncodingSettings = {
    /**
    * Encoding that the writer uses for output. Defaults to "UTF-8".
    */
    encoding?: String {defaultValue: "UTF-8"}
}
```

## See Also

- [Reusing Types from DataWeave Modules](https://docs.mulesoft.com/dataweave/2.9/dataweave-type-reuse-modules)

<!-- document id=db241fec9124ef84424f9912c1aba86bbe78ac14556d0696a2f51848a42cb818 url=/mulesoft/current/en-us/dataweave/latest/dataweave-create-module.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Create Custom Modules and Mappings

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

In addition to using the built-in DataWeave function modules (such as [dw::Core](https://docs.mulesoft.com/dataweave/latest/dw-core) and
[dw::Crypto](https://docs.mulesoft.com/dataweave/latest/dw-crypto)), you can also create and use custom modules and mapping files. The examples
demonstrate common data extraction and transformation approaches.

You write modules and mapping files in a DataWeave Language (`.dwl`) file and import into your Mule
app through DataWeave scripts in Mule components. Both modules and mapping files are useful when you
need to reuse the same functionality or feature over and over again.

- Custom modules can define functions, variables, types, and namespaces. You can import these
  modules into a DataWeave script to use the features.

- Custom mapping files are a type of module that contains a complete DataWeave script that you can
  import and use in another DataWeave script or reference in a Mule component.

Fields in many Mule connectors and components accept DataWeave expressions and scripts.

Note that if you want to import and use a built-in DataWeave function module, and not a custom one,
see [DataWeave Function Reference](https://docs.mulesoft.com/dataweave/latest/dw-functions).

## Creating and Using DataWeave Mapping Files

You can store a DataWeave transformation in a `.dwl` mapping file (mapping module), then import the
file into another DataWeave script. Mapping files can be executed through the Transform Message
component, or you can import them into another mapping and execute them through the `main` function.

![Text editor showing a DataWeave mapping file in a Studio project](/mulesoft/current/en-us/dataweave/latest/_images/dataweave-mapping-file.png)

Figure 1. Example: DataWeave Mapping File in a Studio Project

1.  In your Studio project, set up a subfolder and file for your mapping module:

    - You can create a subfolder in `src/main/resources` by navigating to New → Folder →
      \[your\_project\] → `src/main/resources`, then adding a folder named `modules`.

    - You can create a new file for your module in that folder by navigating to New → File →
      \[your\_project\] → `src/main/resources/modules`, then adding a DWL (DataWeave language) file
      such as `MyMapping.dwl`.

      Saving the module within `src/main/resources` makes it accessible for use in any DataWeave
      script within the Mule app in that project.

2.  Create your function in your mapping file, for example:

    Example: Mapping File Content

    ```dataweave
    %dw 2.0
    import dw::core::Strings
    fun capitalizeKey(value:String) = Strings::capitalize(value) ++ "Key"
    ---
    payload mapObject ((value, key) ->
        {
          (capitalizeKey(key as String)) : value
        }
      )
    ```

3.  Save your DWL function module file.

### Using a Mapping File in a DataWeave Script

To use a mapping file, you need to import it into a DataWeave script and use the `main` function to
access the body of the script in the mapping file.

Assume that you have created the [MyMapping.dwl](#mapping_file) file in
`/src/main/resources/modules` that contains this script.

To import and use the body expression from the `MyMapping.dwl` file (above) in DataWeave Mapping
file, you need to do this:

- Specify the `import` directive in the header.

- Invoke the `MyMapping::main` function. The function expects an input that follows the structure of
  the input that the mapping file uses. For example, the body of `MyMapping.dwl` expects an object
  of the form `{"key" : "value"}`.

Example: Importing and Using the Mapping in a DataWeave Script

```dataweave
%dw 2.0
import modules::MyMapping
output application/json
---
MyMapping::main(payload: { "user" : "bar" })
```

Here is the result:

Output

```json
{
  "UserKey": "bar"
}
```

Even though the [capitalizeKey](#mapping_file) function is private, it is still used through the
`main` function call, and the DataWeave mapping file is also able to import and reuse the
`dw::core::Strings` module.

## Creating and Using a Custom Module

The steps for creating a custom DataWeave module are almost identical to the steps for creating a
custom mapping file. The only difference is the contents of the `.dwl` file. Unlike a typical
DataWeave script or mapping file, a custom DataWeave module cannot contain an `output` directive,
body expression, or the separator (`---`) between header and body sections. (For guidance with
mappings, see [Creating and Using DataWeave Mapping Files](#create_dw_mapping).)

![A DataWeave script with a custom function module](/mulesoft/current/en-us/dataweave/latest/_images/dataweave-function-custom.png)

Figure 2. Example: Custom Module in a Studio Project

A custom module file can only contain `var`, `fun`, `type`, and `ns` declarations, for example:

Example: Custom DataWeave Module

```dataweave
%dw 2.0
var name = "MyData"
fun myFunc(myInput: String) = myInput ++ "_"
type User = {
    name: String,
    lastname: String
}
ns mynamespace http://acme.com/bar
```

When you import a custom module into another DataWeave script, any functions, variables, types, and
namespaces defined in the module become available for use in the DataWeave body. In the next
example, a DataWeave script:

- Imports the module `MyModule` through the `import` directive in the header. In this case, the
  imported module is stored in a Studio project path `src/main/resources/modules/MyModule.dwl`

- Calls a function in `MyModule` by using `MyModule::myFunc("dataweave")`.

Example: Importing and Using a Custom DataWeave Module

```dataweave
%dw 2.0
import modules::MyModule
output application/json
---
MyModule::myFunc("dataweave") ++ "name"
```

There are several ways to import a module or elements in it:

- Import the module, for example: `import modules::MyModule`. In this case, you must include the
  name of the module when you call the element (here, a function) in it, for example:
  `MyModule::myFunc`.

- Import all elements from the module, for example: `import * from modules::MyModule`. In this case,
  you do not need to include the name of the module when you call the element. For example:
  `myFunc("dataweave") ++ "name"` works.

- Import specific elements from a module, for example: `import myFunc from modules::MyModule`. In
  this case, you do not need to include the name of the module when you call the element. For
  example: `myFunc("dataweave") ++ "name"` works. You can import multiple elements from the module
  like this, for example: `import myFunc someOtherFunction from modules::MyModule` (assuming both
  `myFunc` and `someOtherFunction` are defined in the module).

Output

```json
"dataweave_name"
```

## Assigning a Local Alias for an Imported Element

To avoid name clashes, you can use `as` to assign an alias for a custom module or its elements when
you import the module into a DataWeave script.

Assume that you define a custom module like this one in the file `MyModule.dwl`:

Example: Custom Module

```dataweave
%dw 2.0
fun myFunc(name:String) = name ++ "_"
var myVar = "Test"
```

When you import the custom module into a DataWeave script, you can create aliases to elements in the
custom module, for example:

Example: Applying an Alias to Imported Elements

```dataweave
%dw 2.0
import myFunc as appendDash, myVar as weaveName from modules::MyModule
var myVar = "Mapping"
output application/json
---
appendDash("dataweave") ++ weaveName ++ "_" ++ myVar
```

The script returns `"dataweave_Test_Mapping"`.

You can create an alias to the imported module, for example:

Example: Applying an Alias to an Imported Module

```dataweave
%dw 2.0
import modules::MyModule as WeaveMod
output application/json
---
WeaveMod::myFunc("dataweave")
```

## Referencing a DWL File

You can use DWL files directly in Mule connectors and components.

See [dwl File](https://docs.mulesoft.com/dataweave/latest/dataweave-language-introduction#dwl_file) for details.

## Writing Documentation for Custom DataWeave Modules

DataWeave supports use of the AsciiDoc text format for documenting your functions, types,
annotations, and the modules that contain them.

### Documenting Your DataWeave Functions

DataWeave defines a multi-section template for documenting function code. The template provides
sections for the following:

- A description of the function.

- Parameter descriptions in an AsciiDoc table format.

- Example code that includes sections for any input, the DataWeave script, and the resulting output.

To define parameter and example sections below the function description, the template uses AsciiDoc
heading grammar:

- `=== Parameters`

- `=== Example`

  - `==== Source`

  - `==== Input`

  - `==== Output`

The following function template provides guidance on documenting the function. As the template
notes, some sections are optional.

```DataWeave
/**
* %Replace with your function description%
*
*
* %Add additional information to your function description% (optional section)
*
* === Parameters (optional section)
*
* [%header, cols="1,1,3"]
* |===
* | Name | Type | Description
* | %`The parameter name`% | %`The parameter type`% | %The parameter description%  (one row per param)
* |===
*
* === Example (optional section)
*
* %The example description% (optional)
*
* ==== Source (optional section)
*
* [source,%The language%,linenums] (optional)
* ----
* YOUR CODE
* ----
*
* ==== Input (optional section)
*
* The input description (optional)
*
* [source,%The language%,linenums] (optional)
* ----
* YOUR CODE
* ----
*
* ==== Output (optional section)
*
* %The output description% (optional)
*
* [source,%The language%,linenums] (optional)
* ----
* YOUR CODE
* ----
*/
```

#### Description Section

This section provides a description of the function. The section starts at the top of the comments
and extends to the line before the first section heading. If there is no section header, the
description extends to the end of the comments for the function.

A description consists of the following parts:

- Short description: The first paragraph, which provides the primary description of the function.

- Long description: Any additional information about the function. This optional description begins
  two line breaks below the short description.

See the [example](#example-documentation) that includes a description with sections for the
parameters and examples.

Each part is useful for auto-generated documentation.

#### Parameters Section

The optional `=== Parameters` section describes parameters of the function.

The template uses AsciiDoc table format to document each parameter in a table row.

\[%header, cols="1,1,3"\] |=== | Name | Type | Description | yourParameter1 | The parameter type |
Your description here. | yourParameter2 | The parameter type | Your description here. |===

#### Example Section

You can use zero or more `=== Example` sections to provide any examples needed to illustrate how
your function works.

This section contains the following optional subsections:

- `==== Input` for input to the DataWeave script.

- `==== Source` for the DataWeave script.

- `==== Output` for output generated by the script.

All subsections follow the same template, which includes an optional description and an optional
code section:

Your section description

\[source,%The language%,linenums\]
----

YOUR CODE
----

The following example shows the [log](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-log)
function documentation.

/\*\* \* Without changing the value of the input, \`log\` returns the input as a system \* log. So
this makes it very simple to debug your code, because any expression or subexpression can be wrapped
\* with \*log\* and the result will be printed out without modifying the result of the expression.
\* The output is going to be printed in application/dw format. \* (1) \* \* The prefix parameter is
optional and allows to easily find the log output. \* \* \* Use this function to help with debugging
DataWeave scripts. A Mule app \* outputs the results through the \`DefaultLoggingService\`, which
you can see \* in the Studio console. \* \* === Parameters \* \* \[%header, cols="1,13"\] \* |=== \*
| Name | Type | Description \* | \`prefix\` | \`String\` | An optional string that typically
describes the log. \* | \`value\` | \`T\` | The value to log. \* |=== \* \* === Example \* \* This
example logs the specified message. Note that the \`DefaultLoggingService\` \* in a Mule app that is
running in Studio returns the message \* \`WARNING - "Houston, we have a problem,"\` adding the dash
\`-\` between the \* prefix and value. The Logger component's \`LoggerMessageProcessor\` returns \*
the input string \`"Houston, we have a problem."\`, without the \`WARNING\` prefix. \* \* ====
Source \* \* \[source,DataWeave,linenums\] \* ---- \* %dw 2.0 \* output application/json \* --- \*
log("WARNING", "Houston, we have a problem") \* ---- \* \* ==== Output \* \* \`Console Output\` \*
\* \[source,XML,linenums\] \* ---- \* "WARNING - Houston, we have a problem" \* ---- \* \*
\`Expression Output\` \* \* \[source,XML,linenums\] \* ---- \* "Houston, we have a problem" \* ----
\* \* === Example \* \* This example shows how to log the result of expression \`myUser.user\`
without modifying the \* original expression \`myUser.user.friend.name\`. \* \* ==== Source \* \*
\[source,DataWeave,linenums\] \* ---- \* %dw 2.0 \* output application/json \* \* var myUser =
{user: {friend: {name: "Shoki"}, id: 1, name: "Tomo"}, accountId: "leansh" } \* --- \* log("User",
myUser.user).friend.name \* ---- \* \* ==== Output \* \* \`Console output\` \* \*
\[source,console,linenums\] \* ---- \* User - { \* friend: { \* name: "Shoki" \* }, \* id: 1, \*
name: "Tomo" \* } \* ---- \* \* \`Expression Output\` \* \* \[source,DataWeave,linenums\] \* ---- \*
"Shoki" \* ---- \*/

### Documenting Your DataWeave Modules

The DataWeave module description does not follow a structured template.

The only requirement is to place the documentation above the DataWeave version tag.

The following example documents the [dw::Core](https://docs.mulesoft.com/dataweave/2.4/dw-core)
module:

```dataweave
/**
 * This module contains core DataWeave functions for data transformations.
 * It is automatically imported into any DataWeave script.
 */
%dw 2.0
```

### Documenting Your Annotation and Types

Annotation and Types documentation do not follow a structured template.

The only requirement is to write the descriptions above the Annotation or Type definition.

The following example documents the `@StreamCapable` annotation.

```dataweave
/**
* Annotation that marks a parameter as stream capable, which means that this
* field will consume an array of objects in a forward-only manner.
*/
@AnnotationTarget(targets = ["Parameter", "Variable"])
annotation StreamCapable()
```

The following example documents the `EncodingSettings` type found in the
[dw::extension::DataFormat](https://docs.mulesoft.com/dataweave/2.4/dw-dataformat) module.

```dataweave
/**
 * Represents encoding settings.
 */
@Since(version = "2.2.0")
type EncodingSettings = {
    /**
    * Encoding that the writer uses for output. Defaults to "UTF-8".
    */
    encoding?: String {defaultValue: "UTF-8"}
}
```

## See Also

- [Reusing Types from DataWeave Modules](https://docs.mulesoft.com/dataweave/latest/dataweave-type-reuse-modules)

<!-- document id=5bde31153ff0d5ede7cdf995fe4778bd928943f66a55a0165cecda4961f77515 url=/mulesoft/current/en-us/dataweave/2.11/dw-crypto.md -->

---
product: DataWeave
version: 2.11
---

# Crypto (dw::Crypto)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module provide functions that perform encryptions through common algorithms, such as MD5, SHA1,
and so on.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::Crypto` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-crypto-functions-hmacbinary">HMACBinary</a></p></td><td><p>Computes an HMAC hash (with a secret cryptographic key) on input content.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-crypto-functions-hmacwith">HMACWith</a></p></td><td><p>Computes an HMAC hash (with a secret cryptographic key) on input content, then transforms the result into a lowercase, hexadecimal string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-crypto-functions-md5">MD5</a></p></td><td><p>Computes the MD5 hash and transforms the binary result into a hexadecimal lower case string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-crypto-functions-sha1">SHA1</a></p></td><td><p>Computes the SHA1 hash and transforms the result into a hexadecimal, lowercase string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-crypto-functions-hashwith">hashWith</a></p></td><td><p>Computes the hash value of binary content using a specified algorithm.</p></td></tr></tbody></table>

<!-- document id=09c30699fa7654d8052cd57f2e2816d7653cf61c4b7a952cb43536f840032554 url=/mulesoft/current/en-us/dataweave/2.12/dw-crypto.md -->

---
product: DataWeave
version: 2.12
---

# Crypto (dw::Crypto)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module provide functions that perform encryptions through common algorithms, such as MD5, SHA1,
and so on.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::Crypto` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-crypto-functions-hmacbinary">HMACBinary</a></p></td><td><p>Computes an HMAC hash (with a secret cryptographic key) on input content.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-crypto-functions-hmacwith">HMACWith</a></p></td><td><p>Computes an HMAC hash (with a secret cryptographic key) on input content, then transforms the result into a lowercase, hexadecimal string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-crypto-functions-md5">MD5</a></p></td><td><p>Computes the MD5 hash and transforms the binary result into a hexadecimal lower case string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-crypto-functions-sha1">SHA1</a></p></td><td><p>Computes the SHA1 hash and transforms the result into a hexadecimal, lowercase string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-crypto-functions-hashwith">hashWith</a></p></td><td><p>Computes the hash value of binary content using a specified algorithm.</p></td></tr></tbody></table>

## Annotations

- [Crypto Annotations](https://docs.mulesoft.com/dataweave/2.12/dw-crypto-annotations)

<!-- document id=fe14ea0f89b86402bc760f71a770d4805482b1af2ebf21940bfc83b799a5d117 url=/mulesoft/current/en-us/dataweave/2.3/dw-crypto.md -->

---
product: DataWeave
version: 2.3
---

# Crypto (dw::Crypto)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module provide functions that perform encryptions through common algorithms, such as MD5, SHA1,
and so on.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::Crypto` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-crypto-functions-hmacbinary">HMACBinary</a></p></td><td><p>Computes an HMAC hash (with a secret cryptographic key) on input content.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-crypto-functions-hmacwith">HMACWith</a></p></td><td><p>Computes an HMAC hash (with a secret cryptographic key) on input content, then transforms the result into a lowercase, hexadecimal string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-crypto-functions-md5">MD5</a></p></td><td><p>Computes the MD5 hash and transforms the binary result into a hexadecimal lower case string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-crypto-functions-sha1">SHA1</a></p></td><td><p>Computes the SHA1 hash and transforms the result into a hexadecimal, lowercase string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-crypto-functions-hashwith">hashWith</a></p></td><td><p>Computes the hash value of binary content using a specified algorithm.</p></td></tr></tbody></table>

<!-- document id=5382e839874e5aba007a344f0c472bf89216c5a845f54eef937424b58621bf90 url=/mulesoft/current/en-us/dataweave/2.4/dw-crypto.md -->

---
product: DataWeave
version: 2.4
---

# Crypto (dw::Crypto)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module provide functions that perform encryptions through common algorithms, such as MD5, SHA1,
and so on.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::Crypto` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-crypto-functions-hmacbinary">HMACBinary</a></p></td><td><p>Computes an HMAC hash (with a secret cryptographic key) on input content.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-crypto-functions-hmacwith">HMACWith</a></p></td><td><p>Computes an HMAC hash (with a secret cryptographic key) on input content, then transforms the result into a lowercase, hexadecimal string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-crypto-functions-md5">MD5</a></p></td><td><p>Computes the MD5 hash and transforms the binary result into a hexadecimal lower case string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-crypto-functions-sha1">SHA1</a></p></td><td><p>Computes the SHA1 hash and transforms the result into a hexadecimal, lowercase string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-crypto-functions-hashwith">hashWith</a></p></td><td><p>Computes the hash value of binary content using a specified algorithm.</p></td></tr></tbody></table>

<!-- document id=3e675ff17a4843ae052fa689993d71ade0a4a9548497c4e8fde07ea14968a65c url=/mulesoft/current/en-us/dataweave/2.6/dw-crypto.md -->

---
product: DataWeave
version: 2.6
---

# Crypto (dw::Crypto)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module provide functions that perform encryptions through common algorithms, such as MD5, SHA1,
and so on.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::Crypto` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-crypto-functions-hmacbinary">HMACBinary</a></p></td><td><p>Computes an HMAC hash (with a secret cryptographic key) on input content.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-crypto-functions-hmacwith">HMACWith</a></p></td><td><p>Computes an HMAC hash (with a secret cryptographic key) on input content, then transforms the result into a lowercase, hexadecimal string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-crypto-functions-md5">MD5</a></p></td><td><p>Computes the MD5 hash and transforms the binary result into a hexadecimal lower case string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-crypto-functions-sha1">SHA1</a></p></td><td><p>Computes the SHA1 hash and transforms the result into a hexadecimal, lowercase string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-crypto-functions-hashwith">hashWith</a></p></td><td><p>Computes the hash value of binary content using a specified algorithm.</p></td></tr></tbody></table>

<!-- document id=bfd56747c6f1e42c1d8f2106ae811fed9b25c51565367a0c2cb3b316a5b80b11 url=/mulesoft/current/en-us/dataweave/2.9/dw-crypto.md -->

---
product: DataWeave
version: 2.9
---

# Crypto (dw::Crypto)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module provide functions that perform encryptions through common algorithms, such as MD5, SHA1,
and so on.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::Crypto` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-crypto-functions-hmacbinary">HMACBinary</a></p></td><td><p>Computes an HMAC hash (with a secret cryptographic key) on input content.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-crypto-functions-hmacwith">HMACWith</a></p></td><td><p>Computes an HMAC hash (with a secret cryptographic key) on input content, then transforms the result into a lowercase, hexadecimal string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-crypto-functions-md5">MD5</a></p></td><td><p>Computes the MD5 hash and transforms the binary result into a hexadecimal lower case string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-crypto-functions-sha1">SHA1</a></p></td><td><p>Computes the SHA1 hash and transforms the result into a hexadecimal, lowercase string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-crypto-functions-hashwith">hashWith</a></p></td><td><p>Computes the hash value of binary content using a specified algorithm.</p></td></tr></tbody></table>

<!-- document id=66abe3a190b35eead935fd9939443750e9cd0dd3f5ef1b1d0c4984a2b11a321a url=/mulesoft/current/en-us/dataweave/latest/dw-crypto.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Crypto (dw::Crypto)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module provide functions that perform encryptions through common algorithms, such as MD5, SHA1,
and so on.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::Crypto` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-crypto-functions-hmacbinary">HMACBinary</a></p></td><td><p>Computes an HMAC hash (with a secret cryptographic key) on input content.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-crypto-functions-hmacwith">HMACWith</a></p></td><td><p>Computes an HMAC hash (with a secret cryptographic key) on input content, then transforms the result into a lowercase, hexadecimal string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-crypto-functions-md5">MD5</a></p></td><td><p>Computes the MD5 hash and transforms the binary result into a hexadecimal lower case string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-crypto-functions-sha1">SHA1</a></p></td><td><p>Computes the SHA1 hash and transforms the result into a hexadecimal, lowercase string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-crypto-functions-hashwith">hashWith</a></p></td><td><p>Computes the hash value of binary content using a specified algorithm.</p></td></tr></tbody></table>

## Annotations

- [Crypto Annotations](https://docs.mulesoft.com/dataweave/latest/dw-crypto-annotations)

<!-- document id=8f4a7fc1a3a9480f0a5f8b0008d461248a3ad937e9be22143b702db2303d9030 url=/mulesoft/current/en-us/dataweave/2.12/dw-crypto-annotations.md -->

---
product: DataWeave
version: 2.12
---

# Crypto Annotations (dw::Crypto)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Parameters annotated with `@CryptographicSink` are subject to taint analysis during type checking.
When a literal algorithm value is passed to a parameter marked with this annotation, the type
checker validates whether the algorithm is permitted. If the algorithm matches a forbidden or
insecure algorithm (such as MD5 or SHA-1 in FIPS-compliant environments), a compilation error is
raised.

This annotation can only be applied to function parameters.

## Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Annotation</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>CryptographicSink</p></td><td><div><div><p><code>@CryptographicSink()</code></p></div></div></td><td><div><div><p>Marks a function parameter as a cryptographic algorithm sink for security validation.</p></div><div><h2 id="error"><a href="#error"></a>Error</h2><div><div><p>When an insecure algorithm is detected, DataWeave produces this error:</p></div><div><div><pre>Cryptographic violation: Forbidden use of algorithm &lt;algorithm&gt; in &lt;module&gt;.</pre></div></div><div><h3 id="example"><a href="#example"></a>Example</h3><div><p>This function declares an algorithm parameter as a cryptographic sink.</p></div><div><h4 id="source"><a href="#source"></a>Source</h4><div><div><pre><code data-lang="DataWeave">fun hashWith(content: Binary, @CryptographicSink algorithm: String = "SHA-1"): Binary = native("system::HashFunctionValue")</code></pre></div></div><div><p>When called with a forbidden algorithm in a security-restricted environment, DataWeave produces this error. For example, this error occurs when MD5 is configured as a forbidden algorithm.</p></div><div><div><pre><code data-lang="DataWeave">hashWith("data" as Binary, "MD5")</code></pre></div></div></div></div></div></div></div></td></tr></tbody></table>

<!-- document id=fd1611ae99d171df8cd68322d92a00a2027049e1bb327e2aec3527a948c2cc8b url=/mulesoft/current/en-us/dataweave/latest/dw-crypto-annotations.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Crypto Annotations (dw::Crypto)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Parameters annotated with `@CryptographicSink` are subject to taint analysis during type checking.
When a literal algorithm value is passed to a parameter marked with this annotation, the type
checker validates whether the algorithm is permitted. If the algorithm matches a forbidden or
insecure algorithm (such as MD5 or SHA-1 in FIPS-compliant environments), a compilation error is
raised.

This annotation can only be applied to function parameters.

## Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Annotation</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>CryptographicSink</p></td><td><div><div><p><code>@CryptographicSink()</code></p></div></div></td><td><div><div><p>Marks a function parameter as a cryptographic algorithm sink for security validation.</p></div></div></td></tr></tbody></table>

## Error

When an insecure algorithm is detected, DataWeave produces this error:

Cryptographic violation: Forbidden use of algorithm <algorithm> in <module>.

### Example

This function declares an algorithm parameter as a cryptographic sink.

#### Source

```DataWeave
fun hashWith(content: Binary, @CryptographicSink algorithm: String = "SHA-1"): Binary = native("system::HashFunctionValue")
```

When called with a forbidden algorithm in a security-restricted environment, DataWeave produces this
error. For example, this error occurs when MD5 is configured as a forbidden algorithm.

```DataWeave
hashWith("data" as Binary, "MD5")
```

<!-- document id=372119650ed2c05bc385f6c7fc6e9d1f3a6c69860f278f2a9cfac895d5c8a285 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-formats-csv.md -->

---
product: DataWeave
version: 2.11
keywords: format, csv, */csv, application/csv
---

# CSV Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/csv`

ID: `csv`

The CSV data format is represented as a DataWeave array of objects in which each object represents a
row. All simple values are represented as strings.

The DataWeave reader for CSV input supports the following parsing strategies:

- Indexed

- In-Memory

- Streaming

By default, the CSV reader stores input data from an entire file in-memory if the file is 1.5MB or
less. If the file is larger than 1.5 MB, the process writes the data to disk. For very large files,
you can improve the performance of the reader by setting a streaming property to true.

For additional details, see [DataWeave Readers](https://docs.mulesoft.com/dataweave/2.11/dataweave-formats#dw_readers_writers).

## Examples

The following examples show uses of the CSV format.

- [Example: Represent CSV Data](#example1)

- [Example: Stream CSV Data](#example2)

### Example: Represent CSV Data

The following example shows how DataWeave represents CSV data.

#### Input

The following sample data serves as input for the DataWeave source.

```csv
name,lastname,age,gender
Mariano,de Achaval,37,male
Paula,de Estrada,37,female
```

#### Source

The DataWeave script transforms the CSV input payload to the DataWeave (dw) format and MIME type.

```dataweave
%dw 2.0
output application/dw
---
payload
```

#### Output

The DataWeave script produces the following output.

```dataweave
[
  {
    name: "Mariano",
    lastname: "de Achaval",
    age: "37",
    gender: "male"
  },
  {
    name: "Paula",
    lastname: "de Estrada",
    age: "37",
    gender: "female"
  }
]
```

### Example: Stream CSV Data

By default, the CSV reader stores input data from an entire file in-memory if the file is 1.5MB or
less. If the file is larger than 1.5 MB, the process writes the data to disk. For very large files,
you can improve the performance of the reader by setting a `streaming` property to `true`. To
demonstrate the use of this property, the next example streams a CSV file and transforms it to JSON.

#### Input

The structure of the CSV input looks something like the following. Note that a streamed file is
typically much longer.

CSV File Input for Streaming Example (truncated):

```csv
street,city,zip,state,beds,baths,sale_date
3526 HIGH ST,SACRAMENTO,95838,CA,2,1,Wed May 21 00:00:00 EDT 2018
51 OMAHA CT,SACRAMENTO,95823,CA,3,1,Wed May 21 00:00:00 EDT 2018
2796 BRANCH ST,SACRAMENTO,95815,CA,2,1,Wed May 21 00:00:00 EDT 2018
2805 JANETTE WAY,SACRAMENTO,95815,CA,2,1,Wed May 21 00:00:00 EDT 2018
6001 MCMAHON DR,SACRAMENTO,95824,CA,2,1,,Wed May 21 00:00:00 EDT 2018
5828 PEPPERMILL CT,SACRAMENTO,95841,CA,3,1,Wed May 21 00:00:00 EDT 2018
```

#### XML Configuration

To demonstrate a use of the `streaming` property, the following Mule flow streams a CSV file and
transforms it to JSON.

```xml
<flow name="dw-streamingFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="1" timeUnit="MINUTES"/>
    </scheduling-strategy>
  </scheduler>
  <file:read
     path="${app.home}/input.csv"
     config-ref="File_Config"
     outputMimeType="application/csv; streaming=true; header=true"/>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
payload map ((row) -> {
zipcode: row.zip
})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
  <file:write doc:name="Write"
    config-ref="File_Config1"
    path="/path/to/output/file/output.json"/>
  <logger level="INFO" doc:name="Logger" message="#[payload]"/>
</flow>
```

- The example configures the Read operation (`<file:read/>`) to stream the CSV input by setting
  `outputMimeType="application/csv; streaming=true"`. The input CSV file is located in the project
  directory, `src/main/resources`, which is the location of `${app.home}`.

- The DataWeave script in the **Transform Message** component uses the `map` function to iterate
  over each row in the CSV payload and select the value of each field in the `zip` column.

- The Write operation returns a file, `output.json`, which contains the result of the
  transformation.

- The Logger prints the same output payload that you see in `output.json`.

#### Output

The CSV streaming example produces the following output.

```json
[
  {
    "zipcode": "95838"
  },
  {
    "zipcode": "95823"
  },
  {
    "zipcode": "95815"
  },
  {
    "zipcode": "95815"
  },
  {
    "zipcode": "95824"
  },
  {
    "zipcode": "95841"
  }
]
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bodyStartLineNumber</code></p></td><td><p><code>Number</code></p></td><td><p><code>0</code></p></td><td><div><div><p>Line number on which the body starts.</p></div></div></td></tr><tr><td><p><code>escape</code></p></td><td><p><code>String</code></p></td><td><p><code>\</code></p></td><td><div><div><p>Character to use for escaping special characters, such as separators or quotes.</p></div></div></td></tr><tr><td><p><code>header</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether a CSV header is present.</p></div><div><ul><li><p>If <code>header=true</code>, you can access the fields within the input by name, for example, <code>payload.userName</code>.</p></li><li><p>If <code>header=false</code>, you must access the fields by index, referencing the entry first and the field next, for example, <code>payload[107][2]</code>.</p></li></ul></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>headerLineNumber</code></p></td><td><p><code>Number</code></p></td><td><p><code>0</code></p></td><td><div><div><p>Line number on which the CSV header is located.</p></div></div></td></tr><tr><td><p><code>ignoreEmptyLine</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether to ignore an empty line.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>quote</code></p></td><td><p><code>String</code></p></td><td><p><code>"</code></p></td><td><div><div><p>Character to use for quotes.</p></div></div></td></tr><tr><td><p><code>separator</code></p></td><td><p><code>String</code></p></td><td><p><code>,</code></p></td><td><div><div><p>Character that separates one field from another field.</p></div></div></td></tr><tr><td><p><code>streaming</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Streams input when set to <code>true</code>. Use only if entries are accessed sequentially. The input must be a top-level array. See the <a href="#example2">streaming example</a>, and see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats#dw_readers_writers">DataWeave Readers</a>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bodyStartLineNumber</code></p></td><td><p><code>Number</code></p></td><td><p><code>0</code></p></td><td><div><div><p>Line number on which the body starts.</p></div></div></td></tr><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr><tr><td><p><code>escape</code></p></td><td><p><code>String</code></p></td><td><p><code>\</code></p></td><td><div><div><p>Character to use for escaping special characters, such as separators or quotes.</p></div></div></td></tr><tr><td><p><code>header</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether a CSV header is present.</p></div><div><ul><li><p>If <code>header=true</code>, you can access the fields within the input by name, for example, <code>payload.userName</code>.</p></li><li><p>If <code>header=false</code>, you must access the fields by index, referencing the entry first and the field next, for example, <code>payload[107][2]</code>.</p></li></ul></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>headerLineNumber</code></p></td><td><p><code>Number</code></p></td><td><p><code>0</code></p></td><td><div><div><p>Line number on which the CSV header is located.</p></div></div></td></tr><tr><td><p><code>ignoreEmptyLine</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether to ignore an empty line.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>lineSeparator</code></p></td><td><p><code>String</code></p></td><td><p><code>New Line</code></p></td><td><div><div><p>Line separator to use when writing CSV, for example, <code>"\r\n"</code>. By default, DataWeave uses the system line separator.</p></div></div></td></tr><tr><td><p><code>quote</code></p></td><td><p><code>String</code></p></td><td><p><code>"</code></p></td><td><div><div><p>Character to use for quotes.</p></div></div></td></tr><tr><td><p><code>quoteHeader</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Quotes header values when set to <code>true</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>quoteValues</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Quotes every value when set to <code>true</code>, including values that contain special characters.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>separator</code></p></td><td><p><code>String</code></p></td><td><p><code>,</code></p></td><td><div><div><p>Character that separates one field from another field.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/csv</code></p></td></tr></tbody></table>

<!-- document id=8c3abee4acf4fb4996f3c3f829e069895d293a1c275871ffe0954df8ac264dc3 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-formats-csv.md -->

---
product: DataWeave
version: 2.12
keywords: format, csv, */csv, application/csv
---

# CSV Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/csv`

ID: `csv`

The CSV data format is represented as a DataWeave array of objects in which each object represents a
row. All simple values are represented as strings.

The DataWeave reader for CSV input supports the following parsing strategies:

- Indexed

- In-Memory

- Streaming

By default, the CSV reader stores input data from an entire file in-memory if the file is 1.5MB or
less. If the file is larger than 1.5 MB, the process writes the data to disk. For very large files,
you can improve the performance of the reader by setting a streaming property to true.

For additional details, see [DataWeave Readers](https://docs.mulesoft.com/dataweave/2.12/dataweave-formats#dw_readers_writers).

## Examples

The following examples show uses of the CSV format.

- [Example: Represent CSV Data](#example1)

- [Example: Stream CSV Data](#example2)

### Example: Represent CSV Data

The following example shows how DataWeave represents CSV data.

#### Input

The following sample data serves as input for the DataWeave source.

```csv
name,lastname,age,gender
Mariano,de Achaval,37,male
Paula,de Estrada,37,female
```

#### Source

The DataWeave script transforms the CSV input payload to the DataWeave (dw) format and MIME type.

```dataweave
%dw 2.0
output application/dw
---
payload
```

#### Output

The DataWeave script produces the following output.

```dataweave
[
  {
    name: "Mariano",
    lastname: "de Achaval",
    age: "37",
    gender: "male"
  },
  {
    name: "Paula",
    lastname: "de Estrada",
    age: "37",
    gender: "female"
  }
]
```

### Example: Stream CSV Data

By default, the CSV reader stores input data from an entire file in-memory if the file is 1.5MB or
less. If the file is larger than 1.5 MB, the process writes the data to disk. For very large files,
you can improve the performance of the reader by setting a `streaming` property to `true`. To
demonstrate the use of this property, the next example streams a CSV file and transforms it to JSON.

#### Input

The structure of the CSV input looks something like the following. Note that a streamed file is
typically much longer.

CSV File Input for Streaming Example (truncated):

```csv
street,city,zip,state,beds,baths,sale_date
3526 HIGH ST,SACRAMENTO,95838,CA,2,1,Wed May 21 00:00:00 EDT 2018
51 OMAHA CT,SACRAMENTO,95823,CA,3,1,Wed May 21 00:00:00 EDT 2018
2796 BRANCH ST,SACRAMENTO,95815,CA,2,1,Wed May 21 00:00:00 EDT 2018
2805 JANETTE WAY,SACRAMENTO,95815,CA,2,1,Wed May 21 00:00:00 EDT 2018
6001 MCMAHON DR,SACRAMENTO,95824,CA,2,1,,Wed May 21 00:00:00 EDT 2018
5828 PEPPERMILL CT,SACRAMENTO,95841,CA,3,1,Wed May 21 00:00:00 EDT 2018
```

#### XML Configuration

To demonstrate a use of the `streaming` property, the following Mule flow streams a CSV file and
transforms it to JSON.

```xml
<flow name="dw-streamingFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="1" timeUnit="MINUTES"/>
    </scheduling-strategy>
  </scheduler>
  <file:read
     path="${app.home}/input.csv"
     config-ref="File_Config"
     outputMimeType="application/csv; streaming=true; header=true"/>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
payload map ((row) -> {
zipcode: row.zip
})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
  <file:write doc:name="Write"
    config-ref="File_Config1"
    path="/path/to/output/file/output.json"/>
  <logger level="INFO" doc:name="Logger" message="#[payload]"/>
</flow>
```

- The example configures the Read operation (`<file:read/>`) to stream the CSV input by setting
  `outputMimeType="application/csv; streaming=true"`. The input CSV file is located in the project
  directory, `src/main/resources`, which is the location of `${app.home}`.

- The DataWeave script in the **Transform Message** component uses the `map` function to iterate
  over each row in the CSV payload and select the value of each field in the `zip` column.

- The Write operation returns a file, `output.json`, which contains the result of the
  transformation.

- The Logger prints the same output payload that you see in `output.json`.

#### Output

The CSV streaming example produces the following output.

```json
[
  {
    "zipcode": "95838"
  },
  {
    "zipcode": "95823"
  },
  {
    "zipcode": "95815"
  },
  {
    "zipcode": "95815"
  },
  {
    "zipcode": "95824"
  },
  {
    "zipcode": "95841"
  }
]
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bodyStartLineNumber</code></p></td><td><p><code>Number</code></p></td><td><p><code>0</code></p></td><td><div><div><p>Line number on which the body starts.</p></div></div></td></tr><tr><td><p><code>escape</code></p></td><td><p><code>String</code></p></td><td><p><code>\</code></p></td><td><div><div><p>Character to use for escaping special characters, such as separators or quotes.</p></div></div></td></tr><tr><td><p><code>header</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether a CSV header is present.</p></div><div><ul><li><p>If <code>header=true</code>, you can access the fields within the input by name, for example, <code>payload.userName</code>.</p></li><li><p>If <code>header=false</code>, you must access the fields by index, referencing the entry first and the field next, for example, <code>payload[107][2]</code>.</p></li></ul></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>headerLineNumber</code></p></td><td><p><code>Number</code></p></td><td><p><code>0</code></p></td><td><div><div><p>Line number on which the CSV header is located.</p></div></div></td></tr><tr><td><p><code>ignoreEmptyLine</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether to ignore an empty line.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>quote</code></p></td><td><p><code>String</code></p></td><td><p><code>"</code></p></td><td><div><div><p>Character to use for quotes.</p></div></div></td></tr><tr><td><p><code>separator</code></p></td><td><p><code>String</code></p></td><td><p><code>,</code></p></td><td><div><div><p>Character that separates one field from another field.</p></div></div></td></tr><tr><td><p><code>streaming</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Streams input when set to <code>true</code>. Use only if entries are accessed sequentially. The input must be a top-level array. See the <a href="#example2">streaming example</a>, and see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats#dw_readers_writers">DataWeave Readers</a>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bodyStartLineNumber</code></p></td><td><p><code>Number</code></p></td><td><p><code>0</code></p></td><td><div><div><p>Line number on which the body starts.</p></div></div></td></tr><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr><tr><td><p><code>escape</code></p></td><td><p><code>String</code></p></td><td><p><code>\</code></p></td><td><div><div><p>Character to use for escaping special characters, such as separators or quotes.</p></div></div></td></tr><tr><td><p><code>header</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether a CSV header is present.</p></div><div><ul><li><p>If <code>header=true</code>, you can access the fields within the input by name, for example, <code>payload.userName</code>.</p></li><li><p>If <code>header=false</code>, you must access the fields by index, referencing the entry first and the field next, for example, <code>payload[107][2]</code>.</p></li></ul></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>headerLineNumber</code></p></td><td><p><code>Number</code></p></td><td><p><code>0</code></p></td><td><div><div><p>Line number on which the CSV header is located.</p></div></div></td></tr><tr><td><p><code>ignoreEmptyLine</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether to ignore an empty line.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>lineSeparator</code></p></td><td><p><code>String</code></p></td><td><p><code>New Line</code></p></td><td><div><div><p>Line separator to use when writing CSV, for example, <code>"\r\n"</code>. By default, DataWeave uses the system line separator.</p></div></div></td></tr><tr><td><p><code>quote</code></p></td><td><p><code>String</code></p></td><td><p><code>"</code></p></td><td><div><div><p>Character to use for quotes.</p></div></div></td></tr><tr><td><p><code>quoteHeader</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Quotes header values when set to <code>true</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>quoteValues</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Quotes every value when set to <code>true</code>, including values that contain special characters.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>separator</code></p></td><td><p><code>String</code></p></td><td><p><code>,</code></p></td><td><div><div><p>Character that separates one field from another field.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/csv</code></p></td></tr></tbody></table>

<!-- document id=a7f9eb5d9bce64e45805def070837880adc1f41b9e4e6aad56774cbd7a3b375c url=/mulesoft/current/en-us/dataweave/2.3/dataweave-formats-csv.md -->

---
product: DataWeave
version: 2.3
---

# CSV Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME Type: `application/csv`

ID: `csv`

The CSV data format is represented as a DataWeave array of objects in which each object represents a
row. All simple values are represented as strings.

The DataWeave reader for CSV input supports the following parsing strategies:

- Indexed

- In-Memory

- Streaming

By default, the CSV reader stores input data from an entire file in-memory if the file is 1.5MB or
less. If the file is larger than 1.5 MB, the process writes the data to disk. For very large files,
you can improve the performance of the reader by setting a streaming property to true.

For additional details, see [DataWeave Readers](https://docs.mulesoft.com/dataweave/2.3/dataweave-formats#dw_readers_writers).

## Examples

The following examples show uses of the CSV format.

- [Example: Represent CSV Data](#example1)

- [Example: Stream CSV Data](#example2)

### Example: Represent CSV Data

The following example shows how DataWeave represents CSV data.

#### Input

The following sample data serves as input for the DataWeave source.

```csv
name,lastname,age,gender
Mariano,de Achaval,37,male
Paula,de Estrada,37,female
```

#### Source

The DataWeave script transforms the CSV input payload to the DataWeave (dw) format and MIME type.

```dataweave
%dw 2.0
output application/dw
---
payload
```

#### Output

The DataWeave script produces the following output.

```dataweave
[
  {
    name: "Mariano",
    lastname: "de Achaval",
    age: "37",
    gender: "male"
  },
  {
    name: "Paula",
    lastname: "de Estrada",
    age: "37",
    gender: "female"
  }
]
```

### Example: Stream CSV Data

By default, the CSV reader stores input data from an entire file in-memory if the file is 1.5MB or
less. If the file is larger than 1.5 MB, the process writes the data to disk. For very large files,
you can improve the performance of the reader by setting a `streaming` property to `true`. To
demonstrate the use of this property, the next example streams a CSV file and transforms it to JSON.

#### Input

The structure of the CSV input looks something like the following. Note that a streamed file is
typically much longer.

CSV File Input for Streaming Example (truncated):

```csv
street,city,zip,state,beds,baths,sale_date
3526 HIGH ST,SACRAMENTO,95838,CA,2,1,Wed May 21 00:00:00 EDT 2018
51 OMAHA CT,SACRAMENTO,95823,CA,3,1,Wed May 21 00:00:00 EDT 2018
2796 BRANCH ST,SACRAMENTO,95815,CA,2,1,Wed May 21 00:00:00 EDT 2018
2805 JANETTE WAY,SACRAMENTO,95815,CA,2,1,Wed May 21 00:00:00 EDT 2018
6001 MCMAHON DR,SACRAMENTO,95824,CA,2,1,,Wed May 21 00:00:00 EDT 2018
5828 PEPPERMILL CT,SACRAMENTO,95841,CA,3,1,Wed May 21 00:00:00 EDT 2018
```

#### XML Configuration

To demonstrate a use of the `streaming` property, the following Mule flow streams a CSV file and
transforms it to JSON.

```xml
<flow name="dw-streamingFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="1" timeUnit="MINUTES"/>
    </scheduling-strategy>
  </scheduler>
  <file:read
     path="${app.home}/input.csv"
     config-ref="File_Config"
     outputMimeType="application/csv; streaming=true; header=true"/>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
payload map ((row) -> {
zipcode: row.zip
})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
  <file:write doc:name="Write"
    config-ref="File_Config1"
    path="/path/to/output/file/output.json"/>
  <logger level="INFO" doc:name="Logger" message="#[payload]"/>
</flow>
```

- The example configures the Read operation (`<file:read/>`) to stream the CSV input by setting
  `outputMimeType="application/csv; streaming=true"`. The input CSV file is located in the project
  directory, `src/main/resources`, which is the location of `${app.home}`.

- The DataWeave script in the **Transform Message** component uses the `map` function to iterate
  over each row in the CSV payload and select the value of each field in the `zip` column.

- The Write operation returns a file, `output.json`, which contains the result of the
  transformation.

- The Logger prints the same output payload that you see in `output.json`.

#### Output

The CSV streaming example produces the following output.

```json
[
  {
    "zipcode": "95838"
  },
  {
    "zipcode": "95823"
  },
  {
    "zipcode": "95815"
  },
  {
    "zipcode": "95815"
  },
  {
    "zipcode": "95824"
  },
  {
    "zipcode": "95841"
  }
]
```

## Configuration Properties

DataWeave supports the following configuration properties for CSV.

### Reader Properties

The CSV format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bodyStartLineNumber</code></p></td><td><p><code>Number</code></p></td><td><p><code>0</code></p></td><td><div><div><p>The line number on which the body starts.</p></div></div></td></tr><tr><td><p><code>escape</code></p></td><td><p><code>String</code></p></td><td><p><code>\</code></p></td><td><div><div><p>Character used to escape invalid characters, such as separators or quotes within field values.</p></div></div></td></tr><tr><td><p><code>header</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether a CSV header is present. Valid values are <code>true</code> or <code>false</code>.</p></div><div><ul><li><p>If <code>header=true</code>, you can access the fields within the input by name, for example, <code>payload.userName</code>.</p></li><li><p>If <code>header=false</code>, you must access the fields by index, referencing the entry first and the field next, for example, <code>payload[107][2]</code>.</p></li></ul></div></div></td></tr><tr><td><p><code>headerLineNumber</code></p></td><td><p><code>Number</code></p></td><td><p><code>0</code></p></td><td><div><div><p>The line number on which the CSV header is located.</p></div></div></td></tr><tr><td><p><code>ignoreEmptyLine</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Ignores any empty line. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>quote</code></p></td><td><p><code>String</code></p></td><td><p><code>"</code></p></td><td><div><div><p>Character to use for quotes.</p></div></div></td></tr><tr><td><p><code>separator</code></p></td><td><p><code>String</code></p></td><td><p><code>,</code></p></td><td><div><div><p>Character that separates one field from another field.</p></div></div></td></tr><tr><td><p><code>streaming</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Property for streaming CSV input. Use only if entries are accessed sequentially. Valid values are <code>true</code> or <code>false</code>. See the <a href="#example2">streaming example</a>, and see <a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-formats#dw_readers_writers">DataWeave Readers</a>.</p></div></div></td></tr></tbody></table>

### Writer Properties

The CSV format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bodyStartLineNumber</code></p></td><td><p><code>Number</code></p></td><td><p><code>0</code></p></td><td><div><div><p>Line number on which the body starts.</p></div></div></td></tr><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the writer buffer.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>When set to <code>true</code>, DataWeave generates the output as a data stream, and the script’s execution is deferred until it is consumed. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Encoding for the writer to use, such as <code>UTF-8</code>.</p></div></div></td></tr><tr><td><p><code>escape</code></p></td><td><p><code>String</code></p></td><td><p><code>\</code></p></td><td><div><div><p>Character to use for escaping an invalid character, such as occurrences of the separator or quotes within field values.</p></div></div></td></tr><tr><td><p><code>header</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether to write a CSV header. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>headerLineNumber</code></p></td><td><p><code>Number</code></p></td><td><p><code>0</code></p></td><td><div><div><p>Identifies the line number on which the header is located.</p></div></div></td></tr><tr><td><p><code>ignoreEmptyLine</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Ignores any empty line. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>lineSeparator</code></p></td><td><p><code>String</code></p></td><td><p>New Line</p></td><td><div><div><p>Line separator to use when writing the CSV, for example, <code>\r\n</code>.</p></div></div></td></tr><tr><td><p><code>quote</code></p></td><td><p><code>String</code></p></td><td><p><code>"</code></p></td><td><div><div><p>The character to be used for quotes.</p></div></div></td></tr><tr><td><p><code>quoteHeader</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Indicates whether to quote header values. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>quoteValues</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Indicates whether to quote every value (even if the value contains special characters). Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>separator</code></p></td><td><p><code>String</code></p></td><td><p><code>,</code></p></td><td><div><div><p>Character that separates one field from another field.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

The CSV format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/csv</code></p></td></tr></tbody></table>

<!-- document id=829cd6bc7efedd24e3e49ba2e7f88d4b3f6d3a907feb385b2d31de5be551851b url=/mulesoft/current/en-us/dataweave/2.4/dataweave-formats-csv.md -->

---
product: DataWeave
version: 2.4
keywords: format, csv, */csv, application/csv
---

# CSV Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/csv`

ID: `csv`

The CSV data format is represented as a DataWeave array of objects in which each object represents a
row. All simple values are represented as strings.

The DataWeave reader for CSV input supports the following parsing strategies:

- Indexed

- In-Memory

- Streaming

By default, the CSV reader stores input data from an entire file in-memory if the file is 1.5MB or
less. If the file is larger than 1.5 MB, the process writes the data to disk. For very large files,
you can improve the performance of the reader by setting a streaming property to true.

For additional details, see [DataWeave Readers](https://docs.mulesoft.com/dataweave/2.4/dataweave-formats#dw_readers_writers).

## Examples

The following examples show uses of the CSV format.

- [Example: Represent CSV Data](#example1)

- [Example: Stream CSV Data](#example2)

### Example: Represent CSV Data

The following example shows how DataWeave represents CSV data.

#### Input

The following sample data serves as input for the DataWeave source.

```csv
name,lastname,age,gender
Mariano,de Achaval,37,male
Paula,de Estrada,37,female
```

#### Source

The DataWeave script transforms the CSV input payload to the DataWeave (dw) format and MIME type.

```dataweave
%dw 2.0
output application/dw
---
payload
```

#### Output

The DataWeave script produces the following output.

```dataweave
[
  {
    name: "Mariano",
    lastname: "de Achaval",
    age: "37",
    gender: "male"
  },
  {
    name: "Paula",
    lastname: "de Estrada",
    age: "37",
    gender: "female"
  }
]
```

### Example: Stream CSV Data

By default, the CSV reader stores input data from an entire file in-memory if the file is 1.5MB or
less. If the file is larger than 1.5 MB, the process writes the data to disk. For very large files,
you can improve the performance of the reader by setting a `streaming` property to `true`. To
demonstrate the use of this property, the next example streams a CSV file and transforms it to JSON.

#### Input

The structure of the CSV input looks something like the following. Note that a streamed file is
typically much longer.

CSV File Input for Streaming Example (truncated):

```csv
street,city,zip,state,beds,baths,sale_date
3526 HIGH ST,SACRAMENTO,95838,CA,2,1,Wed May 21 00:00:00 EDT 2018
51 OMAHA CT,SACRAMENTO,95823,CA,3,1,Wed May 21 00:00:00 EDT 2018
2796 BRANCH ST,SACRAMENTO,95815,CA,2,1,Wed May 21 00:00:00 EDT 2018
2805 JANETTE WAY,SACRAMENTO,95815,CA,2,1,Wed May 21 00:00:00 EDT 2018
6001 MCMAHON DR,SACRAMENTO,95824,CA,2,1,,Wed May 21 00:00:00 EDT 2018
5828 PEPPERMILL CT,SACRAMENTO,95841,CA,3,1,Wed May 21 00:00:00 EDT 2018
```

#### XML Configuration

To demonstrate a use of the `streaming` property, the following Mule flow streams a CSV file and
transforms it to JSON.

```xml
<flow name="dw-streamingFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="1" timeUnit="MINUTES"/>
    </scheduling-strategy>
  </scheduler>
  <file:read
     path="${app.home}/input.csv"
     config-ref="File_Config"
     outputMimeType="application/csv; streaming=true; header=true"/>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
payload map ((row) -> {
zipcode: row.zip
})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
  <file:write doc:name="Write"
    config-ref="File_Config1"
    path="/path/to/output/file/output.json"/>
  <logger level="INFO" doc:name="Logger" message="#[payload]"/>
</flow>
```

- The example configures the Read operation (`<file:read/>`) to stream the CSV input by setting
  `outputMimeType="application/csv; streaming=true"`. The input CSV file is located in the project
  directory, `src/main/resources`, which is the location of `${app.home}`.

- The DataWeave script in the **Transform Message** component uses the `map` function to iterate
  over each row in the CSV payload and select the value of each field in the `zip` column.

- The Write operation returns a file, `output.json`, which contains the result of the
  transformation.

- The Logger prints the same output payload that you see in `output.json`.

#### Output

The CSV streaming example produces the following output.

```json
[
  {
    "zipcode": "95838"
  },
  {
    "zipcode": "95823"
  },
  {
    "zipcode": "95815"
  },
  {
    "zipcode": "95815"
  },
  {
    "zipcode": "95824"
  },
  {
    "zipcode": "95841"
  }
]
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bodyStartLineNumber</code></p></td><td><p><code>Number</code></p></td><td><p><code>0</code></p></td><td><div><div><p>Line number on which the body starts.</p></div></div></td></tr><tr><td><p><code>escape</code></p></td><td><p><code>String</code></p></td><td><p><code>\</code></p></td><td><div><div><p>Character to use for escaping special characters, such as separators or quotes.</p></div></div></td></tr><tr><td><p><code>header</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether a CSV header is present.</p></div><div><ul><li><p>If <code>header=true</code>, you can access the fields within the input by name, for example, <code>payload.userName</code>.</p></li><li><p>If <code>header=false</code>, you must access the fields by index, referencing the entry first and the field next, for example, <code>payload[107][2]</code>.</p></li></ul></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>headerLineNumber</code></p></td><td><p><code>Number</code></p></td><td><p><code>0</code></p></td><td><div><div><p>Line number on which the CSV header is located.</p></div></div></td></tr><tr><td><p><code>ignoreEmptyLine</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether to ignore an empty line.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>quote</code></p></td><td><p><code>String</code></p></td><td><p><code>"</code></p></td><td><div><div><p>Character to use for quotes.</p></div></div></td></tr><tr><td><p><code>separator</code></p></td><td><p><code>String</code></p></td><td><p><code>,</code></p></td><td><div><div><p>Character that separates one field from another field.</p></div></div></td></tr><tr><td><p><code>streaming</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Streams input when set to <code>true</code>. Use only if entries are accessed sequentially and do not require random access. The input must be a top-level array. See the <a href="#example2">streaming example</a>, and see <a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-formats#dw_readers_writers">DataWeave Readers</a>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bodyStartLineNumber</code></p></td><td><p><code>Number</code></p></td><td><p><code>0</code></p></td><td><div><div><p>Line number on which the body starts.</p></div></div></td></tr><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The character set to use for the output, such as UTF-8.</p></div></div></td></tr><tr><td><p><code>escape</code></p></td><td><p><code>String</code></p></td><td><p><code>\</code></p></td><td><div><div><p>Character to use for escaping special characters, such as separators or quotes.</p></div></div></td></tr><tr><td><p><code>header</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether a CSV header is present.</p></div><div><ul><li><p>If <code>header=true</code>, you can access the fields within the input by name, for example, <code>payload.userName</code>.</p></li><li><p>If <code>header=false</code>, you must access the fields by index, referencing the entry first and the field next, for example, <code>payload[107][2]</code>.</p></li></ul></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>headerLineNumber</code></p></td><td><p><code>Number</code></p></td><td><p><code>0</code></p></td><td><div><div><p>Line number on which the CSV header is located.</p></div></div></td></tr><tr><td><p><code>ignoreEmptyLine</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether to ignore an empty line.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>lineSeparator</code></p></td><td><p><code>String</code></p></td><td><p><code>New Line</code></p></td><td><div><div><p>Line separator to use when writing CSV, for example, <code>"\r\n"</code>. By default, DataWeave uses the system line separator.</p></div></div></td></tr><tr><td><p><code>quote</code></p></td><td><p><code>String</code></p></td><td><p><code>"</code></p></td><td><div><div><p>Character to use for quotes.</p></div></div></td></tr><tr><td><p><code>quoteHeader</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Quotes header values when set to <code>true</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>quoteValues</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Quotes every value when set to <code>true</code>, including values that contain special characters.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>separator</code></p></td><td><p><code>String</code></p></td><td><p><code>,</code></p></td><td><div><div><p>Character that separates one field from another field.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/csv</code></p></td></tr></tbody></table>

<!-- document id=14a63a19a81b0ebefa9e3893dbe113cef2b3b62da2341479fbd06b5a8e7691d3 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-formats-csv.md -->

---
product: DataWeave
version: 2.6
keywords: format, csv, */csv, application/csv
---

# CSV Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/csv`

ID: `csv`

The CSV data format is represented as a DataWeave array of objects in which each object represents a
row. All simple values are represented as strings.

The DataWeave reader for CSV input supports the following parsing strategies:

- Indexed

- In-Memory

- Streaming

By default, the CSV reader stores input data from an entire file in-memory if the file is 1.5MB or
less. If the file is larger than 1.5 MB, the process writes the data to disk. For very large files,
you can improve the performance of the reader by setting a streaming property to true.

For additional details, see [DataWeave Readers](https://docs.mulesoft.com/dataweave/2.6/dataweave-formats#dw_readers_writers).

## Examples

The following examples show uses of the CSV format.

- [Example: Represent CSV Data](#example1)

- [Example: Stream CSV Data](#example2)

### Example: Represent CSV Data

The following example shows how DataWeave represents CSV data.

#### Input

The following sample data serves as input for the DataWeave source.

```csv
name,lastname,age,gender
Mariano,de Achaval,37,male
Paula,de Estrada,37,female
```

#### Source

The DataWeave script transforms the CSV input payload to the DataWeave (dw) format and MIME type.

```dataweave
%dw 2.0
output application/dw
---
payload
```

#### Output

The DataWeave script produces the following output.

```dataweave
[
  {
    name: "Mariano",
    lastname: "de Achaval",
    age: "37",
    gender: "male"
  },
  {
    name: "Paula",
    lastname: "de Estrada",
    age: "37",
    gender: "female"
  }
]
```

### Example: Stream CSV Data

By default, the CSV reader stores input data from an entire file in-memory if the file is 1.5MB or
less. If the file is larger than 1.5 MB, the process writes the data to disk. For very large files,
you can improve the performance of the reader by setting a `streaming` property to `true`. To
demonstrate the use of this property, the next example streams a CSV file and transforms it to JSON.

#### Input

The structure of the CSV input looks something like the following. Note that a streamed file is
typically much longer.

CSV File Input for Streaming Example (truncated):

```csv
street,city,zip,state,beds,baths,sale_date
3526 HIGH ST,SACRAMENTO,95838,CA,2,1,Wed May 21 00:00:00 EDT 2018
51 OMAHA CT,SACRAMENTO,95823,CA,3,1,Wed May 21 00:00:00 EDT 2018
2796 BRANCH ST,SACRAMENTO,95815,CA,2,1,Wed May 21 00:00:00 EDT 2018
2805 JANETTE WAY,SACRAMENTO,95815,CA,2,1,Wed May 21 00:00:00 EDT 2018
6001 MCMAHON DR,SACRAMENTO,95824,CA,2,1,,Wed May 21 00:00:00 EDT 2018
5828 PEPPERMILL CT,SACRAMENTO,95841,CA,3,1,Wed May 21 00:00:00 EDT 2018
```

#### XML Configuration

To demonstrate a use of the `streaming` property, the following Mule flow streams a CSV file and
transforms it to JSON.

```xml
<flow name="dw-streamingFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="1" timeUnit="MINUTES"/>
    </scheduling-strategy>
  </scheduler>
  <file:read
     path="${app.home}/input.csv"
     config-ref="File_Config"
     outputMimeType="application/csv; streaming=true; header=true"/>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
payload map ((row) -> {
zipcode: row.zip
})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
  <file:write doc:name="Write"
    config-ref="File_Config1"
    path="/path/to/output/file/output.json"/>
  <logger level="INFO" doc:name="Logger" message="#[payload]"/>
</flow>
```

- The example configures the Read operation (`<file:read/>`) to stream the CSV input by setting
  `outputMimeType="application/csv; streaming=true"`. The input CSV file is located in the project
  directory, `src/main/resources`, which is the location of `${app.home}`.

- The DataWeave script in the **Transform Message** component uses the `map` function to iterate
  over each row in the CSV payload and select the value of each field in the `zip` column.

- The Write operation returns a file, `output.json`, which contains the result of the
  transformation.

- The Logger prints the same output payload that you see in `output.json`.

#### Output

The CSV streaming example produces the following output.

```json
[
  {
    "zipcode": "95838"
  },
  {
    "zipcode": "95823"
  },
  {
    "zipcode": "95815"
  },
  {
    "zipcode": "95815"
  },
  {
    "zipcode": "95824"
  },
  {
    "zipcode": "95841"
  }
]
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bodyStartLineNumber</code></p></td><td><p><code>Number</code></p></td><td><p><code>0</code></p></td><td><div><div><p>Line number on which the body starts.</p></div></div></td></tr><tr><td><p><code>escape</code></p></td><td><p><code>String</code></p></td><td><p><code>\</code></p></td><td><div><div><p>Character to use for escaping special characters, such as separators or quotes.</p></div></div></td></tr><tr><td><p><code>header</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether a CSV header is present.</p></div><div><ul><li><p>If <code>header=true</code>, you can access the fields within the input by name, for example, <code>payload.userName</code>.</p></li><li><p>If <code>header=false</code>, you must access the fields by index, referencing the entry first and the field next, for example, <code>payload[107][2]</code>.</p></li></ul></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>headerLineNumber</code></p></td><td><p><code>Number</code></p></td><td><p><code>0</code></p></td><td><div><div><p>Line number on which the CSV header is located.</p></div></div></td></tr><tr><td><p><code>ignoreEmptyLine</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether to ignore an empty line.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>quote</code></p></td><td><p><code>String</code></p></td><td><p><code>"</code></p></td><td><div><div><p>Character to use for quotes.</p></div></div></td></tr><tr><td><p><code>separator</code></p></td><td><p><code>String</code></p></td><td><p><code>,</code></p></td><td><div><div><p>Character that separates one field from another field.</p></div></div></td></tr><tr><td><p><code>streaming</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Streams input when set to <code>true</code>. Use only if entries are accessed sequentially. The input must be a top-level array. See the <a href="#example2">streaming example</a>, and see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats#dw_readers_writers">DataWeave Readers</a>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bodyStartLineNumber</code></p></td><td><p><code>Number</code></p></td><td><p><code>0</code></p></td><td><div><div><p>Line number on which the body starts.</p></div></div></td></tr><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr><tr><td><p><code>escape</code></p></td><td><p><code>String</code></p></td><td><p><code>\</code></p></td><td><div><div><p>Character to use for escaping special characters, such as separators or quotes.</p></div></div></td></tr><tr><td><p><code>header</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether a CSV header is present.</p></div><div><ul><li><p>If <code>header=true</code>, you can access the fields within the input by name, for example, <code>payload.userName</code>.</p></li><li><p>If <code>header=false</code>, you must access the fields by index, referencing the entry first and the field next, for example, <code>payload[107][2]</code>.</p></li></ul></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>headerLineNumber</code></p></td><td><p><code>Number</code></p></td><td><p><code>0</code></p></td><td><div><div><p>Line number on which the CSV header is located.</p></div></div></td></tr><tr><td><p><code>ignoreEmptyLine</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether to ignore an empty line.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>lineSeparator</code></p></td><td><p><code>String</code></p></td><td><p><code>New Line</code></p></td><td><div><div><p>Line separator to use when writing CSV, for example, <code>"\r\n"</code>. By default, DataWeave uses the system line separator.</p></div></div></td></tr><tr><td><p><code>quote</code></p></td><td><p><code>String</code></p></td><td><p><code>"</code></p></td><td><div><div><p>Character to use for quotes.</p></div></div></td></tr><tr><td><p><code>quoteHeader</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Quotes header values when set to <code>true</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>quoteValues</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Quotes every value when set to <code>true</code>, including values that contain special characters.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>separator</code></p></td><td><p><code>String</code></p></td><td><p><code>,</code></p></td><td><div><div><p>Character that separates one field from another field.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/csv</code></p></td></tr></tbody></table>

<!-- document id=0c8574cc46908069c84153e2a98598be3216cd676e6044e16296792551958874 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-formats-csv.md -->

---
product: DataWeave
version: 2.9
keywords: format, csv, */csv, application/csv
---

# CSV Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/csv`

ID: `csv`

The CSV data format is represented as a DataWeave array of objects in which each object represents a
row. All simple values are represented as strings.

The DataWeave reader for CSV input supports the following parsing strategies:

- Indexed

- In-Memory

- Streaming

By default, the CSV reader stores input data from an entire file in-memory if the file is 1.5MB or
less. If the file is larger than 1.5 MB, the process writes the data to disk. For very large files,
you can improve the performance of the reader by setting a streaming property to true.

For additional details, see [DataWeave Readers](https://docs.mulesoft.com/dataweave/2.9/dataweave-formats#dw_readers_writers).

## Examples

The following examples show uses of the CSV format.

- [Example: Represent CSV Data](#example1)

- [Example: Stream CSV Data](#example2)

### Example: Represent CSV Data

The following example shows how DataWeave represents CSV data.

#### Input

The following sample data serves as input for the DataWeave source.

```csv
name,lastname,age,gender
Mariano,de Achaval,37,male
Paula,de Estrada,37,female
```

#### Source

The DataWeave script transforms the CSV input payload to the DataWeave (dw) format and MIME type.

```dataweave
%dw 2.0
output application/dw
---
payload
```

#### Output

The DataWeave script produces the following output.

```dataweave
[
  {
    name: "Mariano",
    lastname: "de Achaval",
    age: "37",
    gender: "male"
  },
  {
    name: "Paula",
    lastname: "de Estrada",
    age: "37",
    gender: "female"
  }
]
```

### Example: Stream CSV Data

By default, the CSV reader stores input data from an entire file in-memory if the file is 1.5MB or
less. If the file is larger than 1.5 MB, the process writes the data to disk. For very large files,
you can improve the performance of the reader by setting a `streaming` property to `true`. To
demonstrate the use of this property, the next example streams a CSV file and transforms it to JSON.

#### Input

The structure of the CSV input looks something like the following. Note that a streamed file is
typically much longer.

CSV File Input for Streaming Example (truncated):

```csv
street,city,zip,state,beds,baths,sale_date
3526 HIGH ST,SACRAMENTO,95838,CA,2,1,Wed May 21 00:00:00 EDT 2018
51 OMAHA CT,SACRAMENTO,95823,CA,3,1,Wed May 21 00:00:00 EDT 2018
2796 BRANCH ST,SACRAMENTO,95815,CA,2,1,Wed May 21 00:00:00 EDT 2018
2805 JANETTE WAY,SACRAMENTO,95815,CA,2,1,Wed May 21 00:00:00 EDT 2018
6001 MCMAHON DR,SACRAMENTO,95824,CA,2,1,,Wed May 21 00:00:00 EDT 2018
5828 PEPPERMILL CT,SACRAMENTO,95841,CA,3,1,Wed May 21 00:00:00 EDT 2018
```

#### XML Configuration

To demonstrate a use of the `streaming` property, the following Mule flow streams a CSV file and
transforms it to JSON.

```xml
<flow name="dw-streamingFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="1" timeUnit="MINUTES"/>
    </scheduling-strategy>
  </scheduler>
  <file:read
     path="${app.home}/input.csv"
     config-ref="File_Config"
     outputMimeType="application/csv; streaming=true; header=true"/>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
payload map ((row) -> {
zipcode: row.zip
})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
  <file:write doc:name="Write"
    config-ref="File_Config1"
    path="/path/to/output/file/output.json"/>
  <logger level="INFO" doc:name="Logger" message="#[payload]"/>
</flow>
```

- The example configures the Read operation (`<file:read/>`) to stream the CSV input by setting
  `outputMimeType="application/csv; streaming=true"`. The input CSV file is located in the project
  directory, `src/main/resources`, which is the location of `${app.home}`.

- The DataWeave script in the **Transform Message** component uses the `map` function to iterate
  over each row in the CSV payload and select the value of each field in the `zip` column.

- The Write operation returns a file, `output.json`, which contains the result of the
  transformation.

- The Logger prints the same output payload that you see in `output.json`.

#### Output

The CSV streaming example produces the following output.

```json
[
  {
    "zipcode": "95838"
  },
  {
    "zipcode": "95823"
  },
  {
    "zipcode": "95815"
  },
  {
    "zipcode": "95815"
  },
  {
    "zipcode": "95824"
  },
  {
    "zipcode": "95841"
  }
]
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bodyStartLineNumber</code></p></td><td><p><code>Number</code></p></td><td><p><code>0</code></p></td><td><div><div><p>Line number on which the body starts.</p></div></div></td></tr><tr><td><p><code>escape</code></p></td><td><p><code>String</code></p></td><td><p><code>\</code></p></td><td><div><div><p>Character to use for escaping special characters, such as separators or quotes.</p></div></div></td></tr><tr><td><p><code>header</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether a CSV header is present.</p></div><div><ul><li><p>If <code>header=true</code>, you can access the fields within the input by name, for example, <code>payload.userName</code>.</p></li><li><p>If <code>header=false</code>, you must access the fields by index, referencing the entry first and the field next, for example, <code>payload[107][2]</code>.</p></li></ul></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>headerLineNumber</code></p></td><td><p><code>Number</code></p></td><td><p><code>0</code></p></td><td><div><div><p>Line number on which the CSV header is located.</p></div></div></td></tr><tr><td><p><code>ignoreEmptyLine</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether to ignore an empty line.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>quote</code></p></td><td><p><code>String</code></p></td><td><p><code>"</code></p></td><td><div><div><p>Character to use for quotes.</p></div></div></td></tr><tr><td><p><code>separator</code></p></td><td><p><code>String</code></p></td><td><p><code>,</code></p></td><td><div><div><p>Character that separates one field from another field.</p></div></div></td></tr><tr><td><p><code>streaming</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Streams input when set to <code>true</code>. Use only if entries are accessed sequentially. The input must be a top-level array. See the <a href="#example2">streaming example</a>, and see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats#dw_readers_writers">DataWeave Readers</a>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bodyStartLineNumber</code></p></td><td><p><code>Number</code></p></td><td><p><code>0</code></p></td><td><div><div><p>Line number on which the body starts.</p></div></div></td></tr><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr><tr><td><p><code>escape</code></p></td><td><p><code>String</code></p></td><td><p><code>\</code></p></td><td><div><div><p>Character to use for escaping special characters, such as separators or quotes.</p></div></div></td></tr><tr><td><p><code>header</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether a CSV header is present.</p></div><div><ul><li><p>If <code>header=true</code>, you can access the fields within the input by name, for example, <code>payload.userName</code>.</p></li><li><p>If <code>header=false</code>, you must access the fields by index, referencing the entry first and the field next, for example, <code>payload[107][2]</code>.</p></li></ul></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>headerLineNumber</code></p></td><td><p><code>Number</code></p></td><td><p><code>0</code></p></td><td><div><div><p>Line number on which the CSV header is located.</p></div></div></td></tr><tr><td><p><code>ignoreEmptyLine</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether to ignore an empty line.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>lineSeparator</code></p></td><td><p><code>String</code></p></td><td><p><code>New Line</code></p></td><td><div><div><p>Line separator to use when writing CSV, for example, <code>"\r\n"</code>. By default, DataWeave uses the system line separator.</p></div></div></td></tr><tr><td><p><code>quote</code></p></td><td><p><code>String</code></p></td><td><p><code>"</code></p></td><td><div><div><p>Character to use for quotes.</p></div></div></td></tr><tr><td><p><code>quoteHeader</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Quotes header values when set to <code>true</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>quoteValues</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Quotes every value when set to <code>true</code>, including values that contain special characters.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>separator</code></p></td><td><p><code>String</code></p></td><td><p><code>,</code></p></td><td><div><div><p>Character that separates one field from another field.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/csv</code></p></td></tr></tbody></table>

<!-- document id=f7c7de1fefbbf8355a853f4ece2e06de977c352ab6032555ea88f8e42b8def76 url=/mulesoft/current/en-us/dataweave/latest/dataweave-formats-csv.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: format, csv, */csv, application/csv
---

# CSV Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/csv`

ID: `csv`

The CSV data format is represented as a DataWeave array of objects in which each object represents a
row. All simple values are represented as strings.

The DataWeave reader for CSV input supports the following parsing strategies:

- Indexed

- In-Memory

- Streaming

By default, the CSV reader stores input data from an entire file in-memory if the file is 1.5MB or
less. If the file is larger than 1.5 MB, the process writes the data to disk. For very large files,
you can improve the performance of the reader by setting a streaming property to true.

For additional details, see [DataWeave Readers](https://docs.mulesoft.com/dataweave/latest/dataweave-formats#dw_readers_writers).

## Examples

The following examples show uses of the CSV format.

- [Example: Represent CSV Data](#example1)

- [Example: Stream CSV Data](#example2)

### Example: Represent CSV Data

The following example shows how DataWeave represents CSV data.

#### Input

The following sample data serves as input for the DataWeave source.

```csv
name,lastname,age,gender
Mariano,de Achaval,37,male
Paula,de Estrada,37,female
```

#### Source

The DataWeave script transforms the CSV input payload to the DataWeave (dw) format and MIME type.

```dataweave
%dw 2.0
output application/dw
---
payload
```

#### Output

The DataWeave script produces the following output.

```dataweave
[
  {
    name: "Mariano",
    lastname: "de Achaval",
    age: "37",
    gender: "male"
  },
  {
    name: "Paula",
    lastname: "de Estrada",
    age: "37",
    gender: "female"
  }
]
```

### Example: Stream CSV Data

By default, the CSV reader stores input data from an entire file in-memory if the file is 1.5MB or
less. If the file is larger than 1.5 MB, the process writes the data to disk. For very large files,
you can improve the performance of the reader by setting a `streaming` property to `true`. To
demonstrate the use of this property, the next example streams a CSV file and transforms it to JSON.

#### Input

The structure of the CSV input looks something like the following. Note that a streamed file is
typically much longer.

CSV File Input for Streaming Example (truncated):

```csv
street,city,zip,state,beds,baths,sale_date
3526 HIGH ST,SACRAMENTO,95838,CA,2,1,Wed May 21 00:00:00 EDT 2018
51 OMAHA CT,SACRAMENTO,95823,CA,3,1,Wed May 21 00:00:00 EDT 2018
2796 BRANCH ST,SACRAMENTO,95815,CA,2,1,Wed May 21 00:00:00 EDT 2018
2805 JANETTE WAY,SACRAMENTO,95815,CA,2,1,Wed May 21 00:00:00 EDT 2018
6001 MCMAHON DR,SACRAMENTO,95824,CA,2,1,,Wed May 21 00:00:00 EDT 2018
5828 PEPPERMILL CT,SACRAMENTO,95841,CA,3,1,Wed May 21 00:00:00 EDT 2018
```

#### XML Configuration

To demonstrate a use of the `streaming` property, the following Mule flow streams a CSV file and
transforms it to JSON.

```xml
<flow name="dw-streamingFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="1" timeUnit="MINUTES"/>
    </scheduling-strategy>
  </scheduler>
  <file:read
     path="${app.home}/input.csv"
     config-ref="File_Config"
     outputMimeType="application/csv; streaming=true; header=true"/>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
payload map ((row) -> {
zipcode: row.zip
})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
  <file:write doc:name="Write"
    config-ref="File_Config1"
    path="/path/to/output/file/output.json"/>
  <logger level="INFO" doc:name="Logger" message="#[payload]"/>
</flow>
```

- The example configures the Read operation (`<file:read/>`) to stream the CSV input by setting
  `outputMimeType="application/csv; streaming=true"`. The input CSV file is located in the project
  directory, `src/main/resources`, which is the location of `${app.home}`.

- The DataWeave script in the **Transform Message** component uses the `map` function to iterate
  over each row in the CSV payload and select the value of each field in the `zip` column.

- The Write operation returns a file, `output.json`, which contains the result of the
  transformation.

- The Logger prints the same output payload that you see in `output.json`.

#### Output

The CSV streaming example produces the following output.

```json
[
  {
    "zipcode": "95838"
  },
  {
    "zipcode": "95823"
  },
  {
    "zipcode": "95815"
  },
  {
    "zipcode": "95815"
  },
  {
    "zipcode": "95824"
  },
  {
    "zipcode": "95841"
  }
]
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bodyStartLineNumber</code></p></td><td><p><code>Number</code></p></td><td><p><code>0</code></p></td><td><div><div><p>Line number on which the body starts.</p></div></div></td></tr><tr><td><p><code>escape</code></p></td><td><p><code>String</code></p></td><td><p><code>\</code></p></td><td><div><div><p>Character to use for escaping special characters, such as separators or quotes.</p></div></div></td></tr><tr><td><p><code>header</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether a CSV header is present.</p></div><div><ul><li><p>If <code>header=true</code>, you can access the fields within the input by name, for example, <code>payload.userName</code>.</p></li><li><p>If <code>header=false</code>, you must access the fields by index, referencing the entry first and the field next, for example, <code>payload[107][2]</code>.</p></li></ul></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>headerLineNumber</code></p></td><td><p><code>Number</code></p></td><td><p><code>0</code></p></td><td><div><div><p>Line number on which the CSV header is located.</p></div></div></td></tr><tr><td><p><code>ignoreEmptyLine</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether to ignore an empty line.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>quote</code></p></td><td><p><code>String</code></p></td><td><p><code>"</code></p></td><td><div><div><p>Character to use for quotes.</p></div></div></td></tr><tr><td><p><code>separator</code></p></td><td><p><code>String</code></p></td><td><p><code>,</code></p></td><td><div><div><p>Character that separates one field from another field.</p></div></div></td></tr><tr><td><p><code>streaming</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Streams input when set to <code>true</code>. Use only if entries are accessed sequentially. The input must be a top-level array. See the <a href="#example2">streaming example</a>, and see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats#dw_readers_writers">DataWeave Readers</a>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bodyStartLineNumber</code></p></td><td><p><code>Number</code></p></td><td><p><code>0</code></p></td><td><div><div><p>Line number on which the body starts.</p></div></div></td></tr><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr><tr><td><p><code>escape</code></p></td><td><p><code>String</code></p></td><td><p><code>\</code></p></td><td><div><div><p>Character to use for escaping special characters, such as separators or quotes.</p></div></div></td></tr><tr><td><p><code>header</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether a CSV header is present.</p></div><div><ul><li><p>If <code>header=true</code>, you can access the fields within the input by name, for example, <code>payload.userName</code>.</p></li><li><p>If <code>header=false</code>, you must access the fields by index, referencing the entry first and the field next, for example, <code>payload[107][2]</code>.</p></li></ul></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>headerLineNumber</code></p></td><td><p><code>Number</code></p></td><td><p><code>0</code></p></td><td><div><div><p>Line number on which the CSV header is located.</p></div></div></td></tr><tr><td><p><code>ignoreEmptyLine</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether to ignore an empty line.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>lineSeparator</code></p></td><td><p><code>String</code></p></td><td><p><code>New Line</code></p></td><td><div><div><p>Line separator to use when writing CSV, for example, <code>"\r\n"</code>. By default, DataWeave uses the system line separator.</p></div></div></td></tr><tr><td><p><code>quote</code></p></td><td><p><code>String</code></p></td><td><p><code>"</code></p></td><td><div><div><p>Character to use for quotes.</p></div></div></td></tr><tr><td><p><code>quoteHeader</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Quotes header values when set to <code>true</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>quoteValues</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Quotes every value when set to <code>true</code>, including values that contain special characters.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>separator</code></p></td><td><p><code>String</code></p></td><td><p><code>,</code></p></td><td><div><div><p>Character that separates one field from another field.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/csv</code></p></td></tr></tbody></table>

<!-- document id=e9b0522b43031c07f7a5e2f81af4344f0f8bc6d7cbc607bb4995438fcf8693c4 url=/mulesoft/current/en-us/dataweave/2.11/dw-timer-functions-currentmilliseconds.md -->

---
product: DataWeave
version: 2.11
---

# currentMilliseconds

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## currentMilliseconds(): Number

Returns the current time in milliseconds.

### Example

This example shows the time in milliseconds when the function executed.

#### Source

```Dataweave
%dw 2.0
import * from dw::util::Timer
output application/json
---
{ "currentMilliseconds" : currentMilliseconds() }
```

#### Output

```XML
{ "currentMilliseconds": 1532923168900 }
```

<!-- document id=fd86eb42921aeaa783efc262fca58e8822c7d7cff7e4331bff9b4f1abfce60dc url=/mulesoft/current/en-us/dataweave/2.12/dw-timer-functions-currentmilliseconds.md -->

---
product: DataWeave
version: 2.12
---

# currentMilliseconds

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## currentMilliseconds(): Number

Returns the current time in milliseconds.

### Example

This example shows the time in milliseconds when the function executed.

#### Source

```Dataweave
%dw 2.0
import * from dw::util::Timer
output application/json
---
{ "currentMilliseconds" : currentMilliseconds() }
```

#### Output

```XML
{ "currentMilliseconds": 1532923168900 }
```

<!-- document id=88c483efa07c0dfc07bfecdd005d218014081bad48af05bd84a7c1928663ae46 url=/mulesoft/current/en-us/dataweave/2.3/dw-timer-functions-currentmilliseconds.md -->

---
product: DataWeave
version: 2.3
---

# currentMilliseconds

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## currentMilliseconds(): Number

Returns the current time in milliseconds.

### Example

This example shows the time in milliseconds when the function executed.

#### Source

```Dataweave
%dw 2.0
import * from dw::util::Timer
output application/json
---
{ "currentMilliseconds" : currentMilliseconds() }
```

#### Output

```XML
{ "currentMilliseconds": 1532923168900 }
```

<!-- document id=71b57949fa66d4e0a57d0eb4a140a5fb461f57d5af1b292d04089e701384a286 url=/mulesoft/current/en-us/dataweave/2.4/dw-timer-functions-currentmilliseconds.md -->

---
product: DataWeave
version: 2.4
---

# currentMilliseconds

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## currentMilliseconds(): Number

Returns the current time in milliseconds.

### Example

This example shows the time in milliseconds when the function executed.

#### Source

```Dataweave
%dw 2.0
import * from dw::util::Timer
output application/json
---
{ "currentMilliseconds" : currentMilliseconds() }
```

#### Output

```XML
{ "currentMilliseconds": 1532923168900 }
```

<!-- document id=058c9b14e804cb321eb02cdb0ce1104812c70b5b83159b41acc4dd3dee71e0c6 url=/mulesoft/current/en-us/dataweave/2.6/dw-timer-functions-currentmilliseconds.md -->

---
product: DataWeave
version: 2.6
---

# currentMilliseconds

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## currentMilliseconds(): Number

Returns the current time in milliseconds.

### Example

This example shows the time in milliseconds when the function executed.

#### Source

```Dataweave
%dw 2.0
import * from dw::util::Timer
output application/json
---
{ "currentMilliseconds" : currentMilliseconds() }
```

#### Output

```XML
{ "currentMilliseconds": 1532923168900 }
```

<!-- document id=515f3cbf69b48998fa67bc4bf2f574cf3fe3fd8b8c34b7ad71b5a9da8dd48f00 url=/mulesoft/current/en-us/dataweave/2.9/dw-timer-functions-currentmilliseconds.md -->

---
product: DataWeave
version: 2.9
---

# currentMilliseconds

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## currentMilliseconds(): Number

Returns the current time in milliseconds.

### Example

This example shows the time in milliseconds when the function executed.

#### Source

```Dataweave
%dw 2.0
import * from dw::util::Timer
output application/json
---
{ "currentMilliseconds" : currentMilliseconds() }
```

#### Output

```XML
{ "currentMilliseconds": 1532923168900 }
```

<!-- document id=5e0359d5c3d1dba3d13a80f54839f402837ba97e7d01e8a22a40f11215c04880 url=/mulesoft/current/en-us/dataweave/latest/dw-timer-functions-currentmilliseconds.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# currentMilliseconds

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## currentMilliseconds(): Number

Returns the current time in milliseconds.

### Example

This example shows the time in milliseconds when the function executed.

#### Source

```Dataweave
%dw 2.0
import * from dw::util::Timer
output application/json
---
{ "currentMilliseconds" : currentMilliseconds() }
```

#### Output

```XML
{ "currentMilliseconds": 1532923168900 }
```

<!-- document id=5aa4eb3bfbba08a95c5426f2ece6d01ccd99396e0e6db58f25753e4c75cac687 url=/mulesoft/current/en-us/dataweave/2.11/dw-strings-functions-dasherize.md -->

---
product: DataWeave
version: 2.11
---

# dasherize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## dasherize(text: String): String

Replaces spaces, underscores, and camel-casing in a string with dashes (hyphens).

If no spaces, underscores, and camel-casing are present, the output will match the input.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example replaces the spaces, underscores, and camel-casing in the input. Notice that the input
"customer" is not modified in the output.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a" : dasherize("customer"),
  "b" : dasherize("customer_first_name"),
  "c" : dasherize("customer NAME"),
  "d" : dasherize("customerName")
}
```

#### Output

```JSON
{
  "a": "customer",
  "b": "customer-first-name",
  "c": "customer-name",
  "d": "customer-name"
}
```

## dasherize(text: Null): Null

Helper function that enables `dasherize` to work with a `null` value.

<!-- document id=10129301aa0a2db2cd29e0f6059f9b10d6f4103e0244cdd2196d54635d9c4c2b url=/mulesoft/current/en-us/dataweave/2.12/dw-strings-functions-dasherize.md -->

---
product: DataWeave
version: 2.12
---

# dasherize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## dasherize(text: String): String

Replaces spaces, underscores, and camel-casing in a string with dashes (hyphens).

If no spaces, underscores, and camel-casing are present, the output will match the input.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example replaces the spaces, underscores, and camel-casing in the input. Notice that the input
"customer" is not modified in the output.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a" : dasherize("customer"),
  "b" : dasherize("customer_first_name"),
  "c" : dasherize("customer NAME"),
  "d" : dasherize("customerName")
}
```

#### Output

```JSON
{
  "a": "customer",
  "b": "customer-first-name",
  "c": "customer-name",
  "d": "customer-name"
}
```

## dasherize(text: Null): Null

Helper function that enables `dasherize` to work with a `null` value.

<!-- document id=aadcbac03e11b62ee72a3280689060c995a2ed7f10202333e88d66467432faed url=/mulesoft/current/en-us/dataweave/2.3/dw-strings-functions-dasherize.md -->

---
product: DataWeave
version: 2.3
---

# dasherize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## dasherize(String): String

Replaces spaces, underscores, and camel-casing in a string with dashes (hyphens).

If no spaces, underscores, and camel-casing are present, the output will match the input.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example replaces the spaces, underscores, and camel-casing in the input. Notice that the input
"customer" is not modified in the output.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a" : dasherize("customer"),
  "b" : dasherize("customer_first_name"),
  "c" : dasherize("customer NAME"),
  "d" : dasherize("customerName")
}
```

#### Output

```JSON
{
  "a": "customer",
  "b": "customer-first-name",
  "c": "customer-name",
  "d": "customer-name"
}
```

## dasherize(Null): Null

Helper function that enables `dasherize` to work with a `null` value.

<!-- document id=46c89ecda5848dc08c1b2ca15ece46492c169779b0f949aafce85006acf49d52 url=/mulesoft/current/en-us/dataweave/2.4/dw-strings-functions-dasherize.md -->

---
product: DataWeave
version: 2.4
---

# dasherize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## dasherize(text: String): String

Replaces spaces, underscores, and camel-casing in a string with dashes (hyphens).

If no spaces, underscores, and camel-casing are present, the output will match the input.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example replaces the spaces, underscores, and camel-casing in the input. Notice that the input
"customer" is not modified in the output.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a" : dasherize("customer"),
  "b" : dasherize("customer_first_name"),
  "c" : dasherize("customer NAME"),
  "d" : dasherize("customerName")
}
```

#### Output

```JSON
{
  "a": "customer",
  "b": "customer-first-name",
  "c": "customer-name",
  "d": "customer-name"
}
```

## dasherize(text: Null): Null

Helper function that enables `dasherize` to work with a `null` value.

<!-- document id=12af0258d4ef8dda6cdda614c902d8131063185232cd50ca5ab6fcab3c8b818f url=/mulesoft/current/en-us/dataweave/2.6/dw-strings-functions-dasherize.md -->

---
product: DataWeave
version: 2.6
---

# dasherize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## dasherize(text: String): String

Replaces spaces, underscores, and camel-casing in a string with dashes (hyphens).

If no spaces, underscores, and camel-casing are present, the output will match the input.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example replaces the spaces, underscores, and camel-casing in the input. Notice that the input
"customer" is not modified in the output.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a" : dasherize("customer"),
  "b" : dasherize("customer_first_name"),
  "c" : dasherize("customer NAME"),
  "d" : dasherize("customerName")
}
```

#### Output

```JSON
{
  "a": "customer",
  "b": "customer-first-name",
  "c": "customer-name",
  "d": "customer-name"
}
```

## dasherize(text: Null): Null

Helper function that enables `dasherize` to work with a `null` value.

<!-- document id=1ef7548e4ebd2efa0a8ee45393c52ac5036f86f0340a84c06de04b3276e53d38 url=/mulesoft/current/en-us/dataweave/2.9/dw-strings-functions-dasherize.md -->

---
product: DataWeave
version: 2.9
---

# dasherize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## dasherize(text: String): String

Replaces spaces, underscores, and camel-casing in a string with dashes (hyphens).

If no spaces, underscores, and camel-casing are present, the output will match the input.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example replaces the spaces, underscores, and camel-casing in the input. Notice that the input
"customer" is not modified in the output.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a" : dasherize("customer"),
  "b" : dasherize("customer_first_name"),
  "c" : dasherize("customer NAME"),
  "d" : dasherize("customerName")
}
```

#### Output

```JSON
{
  "a": "customer",
  "b": "customer-first-name",
  "c": "customer-name",
  "d": "customer-name"
}
```

## dasherize(text: Null): Null

Helper function that enables `dasherize` to work with a `null` value.

<!-- document id=c3eef30d89294d1ada20fb543603b261202372f61dd3a664869536e2139785a0 url=/mulesoft/current/en-us/dataweave/latest/dw-strings-functions-dasherize.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# dasherize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## dasherize(text: String): String

Replaces spaces, underscores, and camel-casing in a string with dashes (hyphens).

If no spaces, underscores, and camel-casing are present, the output will match the input.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example replaces the spaces, underscores, and camel-casing in the input. Notice that the input
"customer" is not modified in the output.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a" : dasherize("customer"),
  "b" : dasherize("customer_first_name"),
  "c" : dasherize("customer NAME"),
  "d" : dasherize("customerName")
}
```

#### Output

```JSON
{
  "a": "customer",
  "b": "customer-first-name",
  "c": "customer-name",
  "d": "customer-name"
}
```

## dasherize(text: Null): Null

Helper function that enables `dasherize` to work with a `null` value.

<!-- document id=9907580ff98717be21857bff0e2946e2f3fd95b0e0241776794dba0741dc2ccf url=/mulesoft/current/en-us/dataweave/2.11/dw-dataformat.md -->

---
product: DataWeave
version: 2.11
---

# DataFormat (dw::extension::DataFormat)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module provides resources for registering a new data format for the DataWeave language.

For an example, see
[Custom Data Formats Example](https://github.com/mulesoft-labs/data-weave-custom-data-format).

## Types

- [DataFormat Types](https://docs.mulesoft.com/dataweave/2.11/dw-dataformat-types)

## Annotations

- [DataFormat Annotations](https://docs.mulesoft.com/dataweave/2.11/dw-dataformat-annotations)

<!-- document id=9a39609a90fa81c898a4445baaa4e9afc6db64a47651df5483e030664c2756f0 url=/mulesoft/current/en-us/dataweave/2.12/dw-dataformat.md -->

---
product: DataWeave
version: 2.12
---

# DataFormat (dw::extension::DataFormat)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module provides resources for registering a new data format for the DataWeave language.

For an example, see
[Custom Data Formats Example](https://github.com/mulesoft-labs/data-weave-custom-data-format).

## Types

- [DataFormat Types](https://docs.mulesoft.com/dataweave/2.12/dw-dataformat-types)

## Annotations

- [DataFormat Annotations](https://docs.mulesoft.com/dataweave/2.12/dw-dataformat-annotations)

<!-- document id=460eb39222a8bd0785d4a59cf1b6615ea4018f22a6b0725992fccf78a0de2271 url=/mulesoft/current/en-us/dataweave/2.3/dw-dataformat.md -->

---
product: DataWeave
version: 2.3
---

# DataFormat (dw::extension::DataFormat)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains what is required for registering a new data format for the DataWeave language.

For an example, see
[Custom Data Formats Example](https://github.com/mulesoft-labs/data-weave-custom-data-format).

## Types

- [DataFormat Types](https://docs.mulesoft.com/dataweave/2.3/dw-dataformat-types)

## Annotations

- [DataFormat Annotations](https://docs.mulesoft.com/dataweave/2.3/dw-dataformat-annotations)

<!-- document id=32738eecfa441218ea96882423bc169140327aa23a7c032e2914ef592e9eba41 url=/mulesoft/current/en-us/dataweave/2.4/dw-dataformat.md -->

---
product: DataWeave
version: 2.4
---

# DataFormat (dw::extension::DataFormat)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module provides resources for registering a new data format for the DataWeave language.

For an example, see
[Custom Data Formats Example](https://github.com/mulesoft-labs/data-weave-custom-data-format).

## Types

- [DataFormat Types](https://docs.mulesoft.com/dataweave/2.4/dw-dataformat-types)

## Annotations

- [DataFormat Annotations](https://docs.mulesoft.com/dataweave/2.4/dw-dataformat-annotations)

<!-- document id=389ab937bb85ddbc326f2996fe92e643a5fd35512c7b0f60c089cbfffe23744b url=/mulesoft/current/en-us/dataweave/2.6/dw-dataformat.md -->

---
product: DataWeave
version: 2.6
---

# DataFormat (dw::extension::DataFormat)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module provides resources for registering a new data format for the DataWeave language.

For an example, see
[Custom Data Formats Example](https://github.com/mulesoft-labs/data-weave-custom-data-format).

## Types

- [DataFormat Types](https://docs.mulesoft.com/dataweave/2.6/dw-dataformat-types)

## Annotations

- [DataFormat Annotations](https://docs.mulesoft.com/dataweave/2.6/dw-dataformat-annotations)

<!-- document id=8eb693402448af97fc6ee640e3167c5ad19fab17c9245b2846a9298f954634ba url=/mulesoft/current/en-us/dataweave/2.9/dw-dataformat.md -->

---
product: DataWeave
version: 2.9
---

# DataFormat (dw::extension::DataFormat)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module provides resources for registering a new data format for the DataWeave language.

For an example, see
[Custom Data Formats Example](https://github.com/mulesoft-labs/data-weave-custom-data-format).

## Types

- [DataFormat Types](https://docs.mulesoft.com/dataweave/2.9/dw-dataformat-types)

## Annotations

- [DataFormat Annotations](https://docs.mulesoft.com/dataweave/2.9/dw-dataformat-annotations)

<!-- document id=9a4561b1961257b8f780ccf06d2fe1fe036ac911b971bc7335de1dd9e6436b95 url=/mulesoft/current/en-us/dataweave/latest/dw-dataformat.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# DataFormat (dw::extension::DataFormat)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module provides resources for registering a new data format for the DataWeave language.

For an example, see
[Custom Data Formats Example](https://github.com/mulesoft-labs/data-weave-custom-data-format).

## Types

- [DataFormat Types](https://docs.mulesoft.com/dataweave/latest/dw-dataformat-types)

## Annotations

- [DataFormat Annotations](https://docs.mulesoft.com/dataweave/latest/dw-dataformat-annotations)

<!-- document id=ee9cbdb85b31ea6e817088aa091489a9058e5256964033c49e4c1497d3581069 url=/mulesoft/current/en-us/dataweave/2.11/dw-dataformat-annotations.md -->

---
product: DataWeave
version: 2.11
---

# DataFormat Annotations (dw::extension::DataFormat)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Annotation</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>DataFormatExtension</p></td><td><div><div><p><code>@DataFormatExtension()</code></p></div></div></td><td><div><div><p>Registration hook that the DataWeave engine uses to discover the variable that represents the custom data format. For an example, see the <a href="https://github.com/mulesoft-labs/data-weave-custom-data-format/blob/master/README.md">Custom Data Formats Example README</a>.</p></div></div></td></tr></tbody></table>

<!-- document id=f18fadb38187deead34dd30867d52521ffcf5a12219e3aceb5cd56210192979c url=/mulesoft/current/en-us/dataweave/2.12/dw-dataformat-annotations.md -->

---
product: DataWeave
version: 2.12
---

# DataFormat Annotations (dw::extension::DataFormat)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Annotation</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>DataFormatExtension</p></td><td><div><div><p><code>@DataFormatExtension()</code></p></div></div></td><td><div><div><p>Registration hook that the DataWeave engine uses to discover the variable that represents the custom data format. For an example, see the <a href="https://github.com/mulesoft-labs/data-weave-custom-data-format/blob/master/README.md">Custom Data Formats Example README</a>.</p></div></div></td></tr></tbody></table>

<!-- document id=9609d022a4bc19a9457d9953e15f38a1fac7b01186d472a245a42e1f827e64d9 url=/mulesoft/current/en-us/dataweave/2.3/dw-dataformat-annotations.md -->

---
product: DataWeave
version: 2.3
---

# DataFormat Annotations (dw::extension::DataFormat)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Annotation</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>DataFormatExtension</p></td><td><p><code>@DataFormatExtension()</code></p></td><td><p>Registration hook used by the DataWeave engine to discover the variable that represents the custom data format. For an example, see the <a href="https://github.com/mulesoft-labs/data-weave-custom-data-format/blob/master/README.md">Custom Data Formats Example README</a>.</p></td></tr></tbody></table>

<!-- document id=b02dec694a83212080e07bcb4504bb79b69691cac240fbcf0942e959c5f3927b url=/mulesoft/current/en-us/dataweave/2.4/dw-dataformat-annotations.md -->

---
product: DataWeave
version: 2.4
---

# DataFormat Annotations (dw::extension::DataFormat)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Annotation</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>DataFormatExtension</p></td><td><div><div><p><code>@DataFormatExtension()</code></p></div></div></td><td><div><div><p>Registration hook that the DataWeave engine uses to discover the variable that represents the custom data format. For an example, see the <a href="https://github.com/mulesoft-labs/data-weave-custom-data-format/blob/master/README.md">Custom Data Formats Example README</a>.</p></div></div></td></tr></tbody></table>

<!-- document id=7ba01c6264a01ae69dd8051a9bceec0121305003b320cc0d03c4c8cc0c21ab87 url=/mulesoft/current/en-us/dataweave/2.6/dw-dataformat-annotations.md -->

---
product: DataWeave
version: 2.6
---

# DataFormat Annotations (dw::extension::DataFormat)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Annotation</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>DataFormatExtension</p></td><td><div><div><p><code>@DataFormatExtension()</code></p></div></div></td><td><div><div><p>Registration hook that the DataWeave engine uses to discover the variable that represents the custom data format. For an example, see the <a href="https://github.com/mulesoft-labs/data-weave-custom-data-format/blob/master/README.md">Custom Data Formats Example README</a>.</p></div></div></td></tr></tbody></table>

<!-- document id=72d3cd1134f422fc48255f3f7f4634a69e669084395f1e78051c8efba5186e87 url=/mulesoft/current/en-us/dataweave/2.9/dw-dataformat-annotations.md -->

---
product: DataWeave
version: 2.9
---

# DataFormat Annotations (dw::extension::DataFormat)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Annotation</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>DataFormatExtension</p></td><td><div><div><p><code>@DataFormatExtension()</code></p></div></div></td><td><div><div><p>Registration hook that the DataWeave engine uses to discover the variable that represents the custom data format. For an example, see the <a href="https://github.com/mulesoft-labs/data-weave-custom-data-format/blob/master/README.md">Custom Data Formats Example README</a>.</p></div></div></td></tr></tbody></table>

<!-- document id=81aca37d0f7e7c576749ce358b6869e4a2b49a117800f21803e770ebe8638720 url=/mulesoft/current/en-us/dataweave/latest/dw-dataformat-annotations.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# DataFormat Annotations (dw::extension::DataFormat)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Annotation</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>DataFormatExtension</p></td><td><div><div><p><code>@DataFormatExtension()</code></p></div></div></td><td><div><div><p>Registration hook that the DataWeave engine uses to discover the variable that represents the custom data format. For an example, see the <a href="https://github.com/mulesoft-labs/data-weave-custom-data-format/blob/master/README.md">Custom Data Formats Example README</a>.</p></div></div></td></tr></tbody></table>

<!-- document id=3abcbd778037d2a45eb129ff0384fe07055a01b26c2eeef2ce6ef5debb92fa01 url=/mulesoft/current/en-us/dataweave/2.11/dw-dataformat-types.md -->

---
product: DataWeave
version: 2.11
---

# DataFormat Types (dw::extension::DataFormat)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>DataFormat</p></td><td><div><div><p><code>type DataFormat = { binaryFormat?: Boolean, defaultCharset?: String, fileExtensions?: Array&lt;String&gt;, acceptedMimeTypes: Array&lt;MimeType&gt;, reader: (content: Binary, charset: String, settings: ReaderSettings) -&gt; Any, writer: (value: Any, settings: WriterSettings) -&gt; Binary }</code></p></div></div></td><td><div><div><p>Represents the <code>DataFormat</code> definition and contains the following fields:</p></div><div><ul><li><p><code>binaryFormat</code>: True if this is data format is represented as binary representation instead of text. False if not present.</p></li><li><p><code>defaultCharset</code>: Default character set of this format, if any.</p></li><li><p><code>fileExtensions</code>: Returns the list of file extensions with the <code>.</code> (for example, <code>.json</code>, <code>.xml</code>) to assign to this data format.</p></li><li><p><code>acceptedMimeTypes</code>: The list of MIME types to accept.</p></li><li><p><code>reader</code>: Function that reads raw content and transforms it into the canonical DataWeave model.</p></li><li><p><code>writer</code>: Function that writes the canonical DataWeave model into binary content.</p></li></ul></div><div><p><em>Introduced in DataWeave version 2.2.0.</em></p></div></div></td></tr><tr><td><p>EmptySettings</p></td><td><div><div><p><code>type EmptySettings = Object</code></p></div></div></td><td><div><div><p>Represents a configuration with no settings.</p></div><div><p><em>Introduced in DataWeave version 2.2.0.</em></p></div></div></td></tr><tr><td><p>EncodingSettings</p></td><td><div><div><p><code>type EncodingSettings = { encoding?: String {defaultValue: "UTF-8"} }</code></p></div></div></td><td><div><div><p>Represents encoding settings and contains the following field:</p></div><div><ul><li><p><code>encoding</code>: Encoding that the writer uses for output. Defaults to "UTF-8".</p></li></ul></div><div><p><em>Introduced in DataWeave version 2.2.0.</em></p></div></div></td></tr><tr><td><p>MimeType</p></td><td><div><div><p><code>type MimeType = String</code></p></div></div></td><td><div><div><p>Represents a MIME type, such as <code>application/json</code>.</p></div><div><p><em>Introduced in DataWeave version 2.2.0.</em></p></div></div></td></tr><tr><td><p>Settings</p></td><td><div><div><p><code>type Settings = Object</code></p></div></div></td><td><div><div><p>Reader or writer configuration settings.</p></div><div><p><em>Introduced in DataWeave version 2.2.0.</em></p></div></div></td></tr></tbody></table>

<!-- document id=5423b2a6a84fccf2dfd337eb5a0c2857d1a8d8dca1215e10e2a6d344a7abd9d5 url=/mulesoft/current/en-us/dataweave/2.12/dw-dataformat-types.md -->

---
product: DataWeave
version: 2.12
---

# DataFormat Types (dw::extension::DataFormat)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>DataFormat</p></td><td><div><div><p><code>type DataFormat = { binaryFormat?: Boolean, defaultCharset?: String, fileExtensions?: Array&lt;String&gt;, acceptedMimeTypes: Array&lt;MimeType&gt;, reader: (content: Binary, charset: String, settings: ReaderSettings) -&gt; Any, writer: (value: Any, settings: WriterSettings) -&gt; Binary }</code></p></div></div></td><td><div><div><p>Represents the <code>DataFormat</code> definition and contains the following fields:</p></div><div><ul><li><p><code>binaryFormat</code>: True if this is data format is represented as binary representation instead of text. False if not present.</p></li><li><p><code>defaultCharset</code>: Default character set of this format, if any.</p></li><li><p><code>fileExtensions</code>: Returns the list of file extensions with the <code>.</code> (for example, <code>.json</code>, <code>.xml</code>) to assign to this data format.</p></li><li><p><code>acceptedMimeTypes</code>: The list of MIME types to accept.</p></li><li><p><code>reader</code>: Function that reads raw content and transforms it into the canonical DataWeave model.</p></li><li><p><code>writer</code>: Function that writes the canonical DataWeave model into binary content.</p></li></ul></div><div><p><em>Introduced in DataWeave version 2.2.0.</em></p></div></div></td></tr><tr><td><p>EmptySettings</p></td><td><div><div><p><code>type EmptySettings = Object</code></p></div></div></td><td><div><div><p>Represents a configuration with no settings.</p></div><div><p><em>Introduced in DataWeave version 2.2.0.</em></p></div></div></td></tr><tr><td><p>EncodingSettings</p></td><td><div><div><p><code>type EncodingSettings = { encoding?: String {defaultValue: "UTF-8"} }</code></p></div></div></td><td><div><div><p>Represents encoding settings and contains the following field:</p></div><div><ul><li><p><code>encoding</code>: Encoding that the writer uses for output. Defaults to "UTF-8".</p></li></ul></div><div><p><em>Introduced in DataWeave version 2.2.0.</em></p></div></div></td></tr><tr><td><p>MimeType</p></td><td><div><div><p><code>type MimeType = String</code></p></div></div></td><td><div><div><p>Represents a MIME type, such as <code>application/json</code>.</p></div><div><p><em>Introduced in DataWeave version 2.2.0.</em></p></div></div></td></tr><tr><td><p>Settings</p></td><td><div><div><p><code>type Settings = Object</code></p></div></div></td><td><div><div><p>Reader or writer configuration settings.</p></div><div><p><em>Introduced in DataWeave version 2.2.0.</em></p></div></div></td></tr></tbody></table>

<!-- document id=965145fbebeeb8af395c34060af5951ac21e6fefe593ddf75593c47ad6b3fd65 url=/mulesoft/current/en-us/dataweave/2.3/dw-dataformat-types.md -->

---
product: DataWeave
version: 2.3
---

# DataFormat Types (dw::extension::DataFormat)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The DataFormat module contains what you need to register a new data format for the DataWeave
language. For an example, see
[Custom Data Formats Example](https://github.com/mulesoft-labs/data-weave-custom-data-format).

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>DataFormat</p></td><td><p><code>type DataFormat = { binaryFormat?: Boolean, defaultCharset?: String, fileExtensions?: Array&lt;String&gt;, acceptedMimeTypes: Array&lt;MimeType&gt;, reader: (content: Binary, charset: String, settings: ReaderSettings) -&gt; Any, writer: (value: Any, settings: WriterSettings) -&gt; Binary }</code></p></td><td><div><div><p>Represents the DataFormat definition.</p></div><div><ul><li><p><code>binaryFormat?: Boolean</code>: True if this is data format is represented in a binary representation instead of text. If not present, false.</p></li><li><p><code>defaultCharset?: String</code>: The default charset of this format, if any.</p></li><li><p><code>fileExtensions?: Array&lt;String&gt;</code>: Returns the list of file extensions with the . (".json", ".xml", etc…​) that should be assigned to this Data Format</p></li><li><p><code>acceptedMimeTypes: Array&lt;MimeType&gt;</code> The list of MimeTypes that are accepted.</p></li><li><p><code>reader: (content: Binary, charset: String, settings: ReaderSettings) → Any</code>: This function will be in charge of reading the raw content and transform it into the DataWeave canonical model.</p></li><li><p><code>writer: (value:Any, settings:WriterSettings) → Binary</code>: This function will be in charge of writing the DataWeave canonical model into Binary content.</p></li></ul></div></div></td></tr><tr><td><p>EmptySettings</p></td><td><p><code>type EmptySettings = Object</code></p></td><td><p>Represents a configuration with no Settings.</p></td></tr><tr><td><p>EncodingSettings</p></td><td><p><code>type EncodingSettings = { encoding?: String }</code></p></td><td><div><div><p>Represents an Encoding Settings:</p></div><div><ul><li><p><code>encoding?: String</code>: Encoding to be used by this writer.</p></li></ul></div></div></td></tr><tr><td><p>MimeType</p></td><td><p><code>type MimeType = String</code></p></td><td><p>Represents a MimeType, such as <code>application/json</code>.</p></td></tr><tr><td><p>Settings</p></td><td><p><code>type Settings = Object</code></p></td><td><p>Represents reader or writer configuration Settings.</p></td></tr></tbody></table>

<!-- document id=6141bddc2a2a1034807d56505fb2eae7515948df5d373408630baa342ab564c4 url=/mulesoft/current/en-us/dataweave/2.4/dw-dataformat-types.md -->

---
product: DataWeave
version: 2.4
---

# DataFormat Types (dw::extension::DataFormat)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The DataFormat module provides resources for registering a new data format for the DataWeave
language. For an example, see
[Custom Data Formats Example](https://github.com/mulesoft-labs/data-weave-custom-data-format).

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>DataFormat</p></td><td><div><div><p><code>type DataFormat = { binaryFormat?: Boolean, defaultCharset?: String, fileExtensions?: Array&lt;String&gt;, acceptedMimeTypes: Array&lt;MimeType&gt;, reader: (content: Binary, charset: String, settings: ReaderSettings) -&gt; Any, writer: (value: Any, settings: WriterSettings) -&gt; Binary }</code></p></div></div></td><td><div><div><p>Represents the DataFormat definition.</p></div><div><ul><li><p><code>binaryFormat?: Boolean</code>: True if this is data format is represented as binary instead of text. False if not present.</p></li><li><p><code>defaultCharset?: String</code>: Default character set of this format, if any.</p></li><li><p><code>fileExtensions?: Array&lt;String&gt;</code>: Returns the list of file extensions with the <code>.</code> (for example, <code>.json</code>, <code>`.xml</code>) to assign to this data format.</p></li><li><p><code>acceptedMimeTypes: Array&lt;MimeType&gt;</code> The list of MIME types to accept.</p></li><li><p><code>reader: (content: Binary, charset: String, settings: ReaderSettings) → Any</code>: Function that reads raw content and transforms it into the canonical DataWeave model.</p></li><li><p><code>writer: (value:Any, settings:WriterSettings) → Binary</code>: Function that writes the canonical DataWeave model into binary content.</p></li></ul></div></div></td></tr><tr><td><p>EmptySettings</p></td><td><div><div><p><code>type EmptySettings = Object</code></p></div></div></td><td><div><div><p>Represents a configuration with no settings.</p></div></div></td></tr><tr><td><p>EncodingSettings</p></td><td><div><div><p><code>type EncodingSettings = { encoding?: String }</code></p></div></div></td><td><div><div><p>Represents encoding settings:</p></div><div><ul><li><p><code>encoding?: String</code>: Encoding that the writer uses for output. Defaults to "UTF-8".</p></li></ul></div></div></td></tr><tr><td><p>MimeType</p></td><td><div><div><p><code>type MimeType = String</code></p></div></div></td><td><div><div><p>Represents a MIME type, such as <code>application/json</code>.</p></div><div><p><em>Introduced in DataWeave version 2.2.0.</em></p></div></div></td></tr><tr><td><p>Settings</p></td><td><div><div><p><code>type Settings = Object</code></p></div></div></td><td><div><div><p>Reader or writer configuration settings.</p></div><div><p><em>Introduced in DataWeave version 2.2.0.</em></p></div></div></td></tr></tbody></table>

<!-- document id=7774d92ea8123d3400375d6d73cfc543b81e23d3d10337010c663c30c71b1ab9 url=/mulesoft/current/en-us/dataweave/2.6/dw-dataformat-types.md -->

---
product: DataWeave
version: 2.6
---

# DataFormat Types (dw::extension::DataFormat)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>DataFormat</p></td><td><div><div><p><code>type DataFormat = { binaryFormat?: Boolean, defaultCharset?: String, fileExtensions?: Array&lt;String&gt;, acceptedMimeTypes: Array&lt;MimeType&gt;, reader: (content: Binary, charset: String, settings: ReaderSettings) -&gt; Any, writer: (value: Any, settings: WriterSettings) -&gt; Binary }</code></p></div></div></td><td><div><div><p>Represents the <code>DataFormat</code> definition and contains the following fields:</p></div><div><ul><li><p><code>binaryFormat</code>: True if this is data format is represented as binary representation instead of text. False if not present.</p></li><li><p><code>defaultCharset</code>: Default character set of this format, if any.</p></li><li><p><code>fileExtensions</code>: Returns the list of file extensions with the <code>.</code> (for example, <code>.json</code>, <code>.xml</code>) to assign to this data format.</p></li><li><p><code>acceptedMimeTypes</code>: The list of MIME types to accept.</p></li><li><p><code>reader</code>: Function that reads raw content and transforms it into the canonical DataWeave model.</p></li><li><p><code>writer</code>: Function that writes the canonical DataWeave model into binary content.</p></li></ul></div><div><p><em>Introduced in DataWeave version 2.2.0.</em></p></div></div></td></tr><tr><td><p>EmptySettings</p></td><td><div><div><p><code>type EmptySettings = Object</code></p></div></div></td><td><div><div><p>Represents a configuration with no settings.</p></div><div><p><em>Introduced in DataWeave version 2.2.0.</em></p></div></div></td></tr><tr><td><p>EncodingSettings</p></td><td><div><div><p><code>type EncodingSettings = { encoding?: String {defaultValue: "UTF-8"} }</code></p></div></div></td><td><div><div><p>Represents encoding settings and contains the following field:</p></div><div><ul><li><p><code>encoding</code>: Encoding that the writer uses for output. Defaults to "UTF-8".</p></li></ul></div><div><p><em>Introduced in DataWeave version 2.2.0.</em></p></div></div></td></tr><tr><td><p>MimeType</p></td><td><div><div><p><code>type MimeType = String</code></p></div></div></td><td><div><div><p>Represents a MIME type, such as <code>application/json</code>.</p></div><div><p><em>Introduced in DataWeave version 2.2.0.</em></p></div></div></td></tr><tr><td><p>Settings</p></td><td><div><div><p><code>type Settings = Object</code></p></div></div></td><td><div><div><p>Reader or writer configuration settings.</p></div><div><p><em>Introduced in DataWeave version 2.2.0.</em></p></div></div></td></tr></tbody></table>

<!-- document id=e0c62d79948ec052cf6cf779718a0b8089d0083138e3365a1e8c5824fb636a72 url=/mulesoft/current/en-us/dataweave/2.9/dw-dataformat-types.md -->

---
product: DataWeave
version: 2.9
---

# DataFormat Types (dw::extension::DataFormat)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>DataFormat</p></td><td><div><div><p><code>type DataFormat = { binaryFormat?: Boolean, defaultCharset?: String, fileExtensions?: Array&lt;String&gt;, acceptedMimeTypes: Array&lt;MimeType&gt;, reader: (content: Binary, charset: String, settings: ReaderSettings) -&gt; Any, writer: (value: Any, settings: WriterSettings) -&gt; Binary }</code></p></div></div></td><td><div><div><p>Represents the <code>DataFormat</code> definition and contains the following fields:</p></div><div><ul><li><p><code>binaryFormat</code>: True if this is data format is represented as binary representation instead of text. False if not present.</p></li><li><p><code>defaultCharset</code>: Default character set of this format, if any.</p></li><li><p><code>fileExtensions</code>: Returns the list of file extensions with the <code>.</code> (for example, <code>.json</code>, <code>.xml</code>) to assign to this data format.</p></li><li><p><code>acceptedMimeTypes</code>: The list of MIME types to accept.</p></li><li><p><code>reader</code>: Function that reads raw content and transforms it into the canonical DataWeave model.</p></li><li><p><code>writer</code>: Function that writes the canonical DataWeave model into binary content.</p></li></ul></div><div><p><em>Introduced in DataWeave version 2.2.0.</em></p></div></div></td></tr><tr><td><p>EmptySettings</p></td><td><div><div><p><code>type EmptySettings = Object</code></p></div></div></td><td><div><div><p>Represents a configuration with no settings.</p></div><div><p><em>Introduced in DataWeave version 2.2.0.</em></p></div></div></td></tr><tr><td><p>EncodingSettings</p></td><td><div><div><p><code>type EncodingSettings = { encoding?: String {defaultValue: "UTF-8"} }</code></p></div></div></td><td><div><div><p>Represents encoding settings and contains the following field:</p></div><div><ul><li><p><code>encoding</code>: Encoding that the writer uses for output. Defaults to "UTF-8".</p></li></ul></div><div><p><em>Introduced in DataWeave version 2.2.0.</em></p></div></div></td></tr><tr><td><p>MimeType</p></td><td><div><div><p><code>type MimeType = String</code></p></div></div></td><td><div><div><p>Represents a MIME type, such as <code>application/json</code>.</p></div><div><p><em>Introduced in DataWeave version 2.2.0.</em></p></div></div></td></tr><tr><td><p>Settings</p></td><td><div><div><p><code>type Settings = Object</code></p></div></div></td><td><div><div><p>Reader or writer configuration settings.</p></div><div><p><em>Introduced in DataWeave version 2.2.0.</em></p></div></div></td></tr></tbody></table>

<!-- document id=c7aabaf3a4b064f021636e307296f51d1308da2e614a9b1230b39fd15ffd02cd url=/mulesoft/current/en-us/dataweave/latest/dw-dataformat-types.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# DataFormat Types (dw::extension::DataFormat)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>DataFormat</p></td><td><div><div><p><code>type DataFormat = { binaryFormat?: Boolean, defaultCharset?: String, fileExtensions?: Array&lt;String&gt;, acceptedMimeTypes: Array&lt;MimeType&gt;, reader: (content: Binary, charset: String, settings: ReaderSettings) -&gt; Any, writer: (value: Any, settings: WriterSettings) -&gt; Binary }</code></p></div></div></td><td><div><div><p>Represents the <code>DataFormat</code> definition and contains the following fields:</p></div><div><ul><li><p><code>binaryFormat</code>: True if this is data format is represented as binary representation instead of text. False if not present.</p></li><li><p><code>defaultCharset</code>: Default character set of this format, if any.</p></li><li><p><code>fileExtensions</code>: Returns the list of file extensions with the <code>.</code> (for example, <code>.json</code>, <code>.xml</code>) to assign to this data format.</p></li><li><p><code>acceptedMimeTypes</code>: The list of MIME types to accept.</p></li><li><p><code>reader</code>: Function that reads raw content and transforms it into the canonical DataWeave model.</p></li><li><p><code>writer</code>: Function that writes the canonical DataWeave model into binary content.</p></li></ul></div><div><p><em>Introduced in DataWeave version 2.2.0.</em></p></div></div></td></tr><tr><td><p>EmptySettings</p></td><td><div><div><p><code>type EmptySettings = Object</code></p></div></div></td><td><div><div><p>Represents a configuration with no settings.</p></div><div><p><em>Introduced in DataWeave version 2.2.0.</em></p></div></div></td></tr><tr><td><p>EncodingSettings</p></td><td><div><div><p><code>type EncodingSettings = { encoding?: String {defaultValue: "UTF-8"} }</code></p></div></div></td><td><div><div><p>Represents encoding settings and contains the following field:</p></div><div><ul><li><p><code>encoding</code>: Encoding that the writer uses for output. Defaults to "UTF-8".</p></li></ul></div><div><p><em>Introduced in DataWeave version 2.2.0.</em></p></div></div></td></tr><tr><td><p>MimeType</p></td><td><div><div><p><code>type MimeType = String</code></p></div></div></td><td><div><div><p>Represents a MIME type, such as <code>application/json</code>.</p></div><div><p><em>Introduced in DataWeave version 2.2.0.</em></p></div></div></td></tr><tr><td><p>Settings</p></td><td><div><div><p><code>type Settings = Object</code></p></div></div></td><td><div><div><p>Reader or writer configuration settings.</p></div><div><p><em>Introduced in DataWeave version 2.2.0.</em></p></div></div></td></tr></tbody></table>

<!-- document id=6f9aec3d1155109af06dea93572e1a66b9c16fdc9eb34192f1b1ef29ef45bb46 url=/mulesoft/current/en-us/dataweave/2.11/dw-runtime-functions-dataformatsdescriptor.md -->

---
product: DataWeave
version: 2.11
---

# dataFormatsDescriptor

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## dataFormatsDescriptor(): Array<DataFormatDescriptor>

Returns an array of all `DataFormatDescriptor` values that are installed in the current instance of
DataWeave.

_Experimental:_ This function is an experimental feature that is subject to change or removal from
future versions of DataWeave.

### Example

This example shows how `dataFormatsDescriptor` behaves with different inputs.

#### Source

```DataWeave
import * from dw::Runtime
---
dataFormatsDescriptor()
```

#### Output

```Json
[
      {
           "id": "json",
           "binary": false,
           "defaultEncoding": "UTF-8",
           "extensions": [
             ".json"
           ],
           "defaultMimeType": "application/json",
           "acceptedMimeTypes": [
             "application/json"
           ],
           "readerProperties": [
             {
               "name": "streaming",
               "optional": true,
               "defaultValue": false,
               "description": "Used for streaming input (use only if entries are accessed sequentially).",
               "possibleValues": [
                 true,
                 false
               ]
             }
           ],
           "writerProperties": [
             {
               "name": "writeAttributes",
               "optional": true,
               "defaultValue": false,
               "description": "Indicates that if a key has attributes, they are going to be added as children key-value pairs of the key that contains them. The attribute new key name will start with @.",
               "possibleValues": [
                 true,
                 false
               ]
             },
             {
              "name": "skipNullOn",
                 "optional": true,
                 "defaultValue": "None",
                 "description": "Indicates where is should skips null values if any or not. By default it doesn't skip.",
                 "possibleValues": [
                   "arrays",
                   "objects",
                   "everywhere"
                 ]
               }
             ]
           },
           {
             "id": "xml",
             "binary": false,
             "extensions": [
               ".xml"
             ],
             "defaultMimeType": "application/xml",
             "acceptedMimeTypes": [
               "application/xml"
             ],
             "readerProperties": [
               {
               "name": "supportDtd",
               "optional": true,
               "defaultValue": true,
               "description": "Whether DTD handling is enabled or disabled; disabling means both internal and external subsets will just be skipped unprocessed.",
               "possibleValues": [
                 true,
                 false
               ]
             },
             {
               "name": "streaming",
               "optional": true,
               "defaultValue": false,
               "description": "Used for streaming input (use only if entries are accessed sequentially).",
               "possibleValues": [
                 true,
                 false
               ]
             },
             {
               "name": "maxEntityCount",
               "optional": true,
               "defaultValue": 1,
               "description": "The maximum number of entity expansions. The limit is in place to avoid Billion Laughs attacks.",
               "possibleValues": [

               ]
             }
           ],
           "writerProperties": [
             {
               "name": "writeDeclaration",
               "optional": true,
               "defaultValue": true,
               "description": "Indicates whether to write the XML header declaration or not.",
               "possibleValues": [
                 true,
                 false
               ]
             },
             {
               "name": "indent",
               "optional": true,
               "defaultValue": true,
               "description": "Indicates whether to indent the code for better readability or to compress it into a single line.",
               "possibleValues": [
                 true,
                 false
               ]
             }
           ]
         }
]
```

<!-- document id=3e4e0c24c42c0438fcd6b44b3cebd487590bd49dc215628e4ed17c46f4a70de3 url=/mulesoft/current/en-us/dataweave/2.12/dw-runtime-functions-dataformatsdescriptor.md -->

---
product: DataWeave
version: 2.12
---

# dataFormatsDescriptor

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## dataFormatsDescriptor(): Array<DataFormatDescriptor>

Returns an array of all `DataFormatDescriptor` values that are installed in the current instance of
DataWeave.

_Experimental:_ This function is an experimental feature that is subject to change or removal from
future versions of DataWeave.

### Example

This example shows how `dataFormatsDescriptor` behaves with different inputs.

#### Source

```DataWeave
import * from dw::Runtime
---
dataFormatsDescriptor()
```

#### Output

```Json
[
      {
           "id": "json",
           "binary": false,
           "defaultEncoding": "UTF-8",
           "extensions": [
             ".json"
           ],
           "defaultMimeType": "application/json",
           "acceptedMimeTypes": [
             "application/json"
           ],
           "readerProperties": [
             {
               "name": "streaming",
               "optional": true,
               "defaultValue": false,
               "description": "Used for streaming input (use only if entries are accessed sequentially).",
               "possibleValues": [
                 true,
                 false
               ]
             }
           ],
           "writerProperties": [
             {
               "name": "writeAttributes",
               "optional": true,
               "defaultValue": false,
               "description": "Indicates that if a key has attributes, they are going to be added as children key-value pairs of the key that contains them. The attribute new key name will start with @.",
               "possibleValues": [
                 true,
                 false
               ]
             },
             {
              "name": "skipNullOn",
                 "optional": true,
                 "defaultValue": "None",
                 "description": "Indicates where is should skips null values if any or not. By default it doesn't skip.",
                 "possibleValues": [
                   "arrays",
                   "objects",
                   "everywhere"
                 ]
               }
             ]
           },
           {
             "id": "xml",
             "binary": false,
             "extensions": [
               ".xml"
             ],
             "defaultMimeType": "application/xml",
             "acceptedMimeTypes": [
               "application/xml"
             ],
             "readerProperties": [
               {
               "name": "supportDtd",
               "optional": true,
               "defaultValue": true,
               "description": "Whether DTD handling is enabled or disabled; disabling means both internal and external subsets will just be skipped unprocessed.",
               "possibleValues": [
                 true,
                 false
               ]
             },
             {
               "name": "streaming",
               "optional": true,
               "defaultValue": false,
               "description": "Used for streaming input (use only if entries are accessed sequentially).",
               "possibleValues": [
                 true,
                 false
               ]
             },
             {
               "name": "maxEntityCount",
               "optional": true,
               "defaultValue": 1,
               "description": "The maximum number of entity expansions. The limit is in place to avoid Billion Laughs attacks.",
               "possibleValues": [

               ]
             }
           ],
           "writerProperties": [
             {
               "name": "writeDeclaration",
               "optional": true,
               "defaultValue": true,
               "description": "Indicates whether to write the XML header declaration or not.",
               "possibleValues": [
                 true,
                 false
               ]
             },
             {
               "name": "indent",
               "optional": true,
               "defaultValue": true,
               "description": "Indicates whether to indent the code for better readability or to compress it into a single line.",
               "possibleValues": [
                 true,
                 false
               ]
             }
           ]
         }
]
```

<!-- document id=3660a6cd92084ec52b8d3886fb398b379c0e41fec9db89d0ac6ebd3d5172b243 url=/mulesoft/current/en-us/dataweave/2.4/dw-runtime-functions-dataformatsdescriptor.md -->

---
product: DataWeave
version: 2.4
---

# dataFormatsDescriptor

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## dataFormatsDescriptor(): Array<DataFormatDescriptor>

Returns an array of all `DataFormatDescriptor` values that are installed in the current instance of
DataWeave.

_Experimental:_ This function is an experimental feature that is subject to change or removal from
future versions of DataWeave.

### Example

This example shows how `dataFormatsDescriptor` behaves with different inputs.

#### Source

```DataWeave
import * from dw::Runtime
---
dataFormatsDescriptor()
```

#### Output

```Json
[
      {
           "id": "json",
           "binary": false,
           "defaultEncoding": "UTF-8",
           "extensions": [
             ".json"
           ],
           "defaultMimeType": "application/json",
           "acceptedMimeTypes": [
             "application/json"
           ],
           "readerProperties": [
             {
               "name": "streaming",
               "optional": true,
               "defaultValue": false,
               "description": "Used for streaming input (use only if entries are accessed sequentially).",
               "possibleValues": [
                 true,
                 false
               ]
             }
           ],
           "writerProperties": [
             {
               "name": "writeAttributes",
               "optional": true,
               "defaultValue": false,
               "description": "Indicates that if a key has attributes, they are going to be added as children key-value pairs of the key that contains them. The attribute new key name will start with @.",
               "possibleValues": [
                 true,
                 false
               ]
             },
             {
              "name": "skipNullOn",
                 "optional": true,
                 "defaultValue": "None",
                 "description": "Indicates where is should skips null values if any or not. By default it doesn't skip.",
                 "possibleValues": [
                   "arrays",
                   "objects",
                   "everywhere"
                 ]
               }
             ]
           },
           {
             "id": "xml",
             "binary": false,
             "extensions": [
               ".xml"
             ],
             "defaultMimeType": "application/xml",
             "acceptedMimeTypes": [
               "application/xml"
             ],
             "readerProperties": [
               {
               "name": "supportDtd",
               "optional": true,
               "defaultValue": true,
               "description": "Whether DTD handling is enabled or disabled; disabling means both internal and external subsets will just be skipped unprocessed.",
               "possibleValues": [
                 true,
                 false
               ]
             },
             {
               "name": "streaming",
               "optional": true,
               "defaultValue": false,
               "description": "Used for streaming input (use only if entries are accessed sequentially).",
               "possibleValues": [
                 true,
                 false
               ]
             },
             {
               "name": "maxEntityCount",
               "optional": true,
               "defaultValue": 1,
               "description": "The maximum number of entity expansions. The limit is in place to avoid Billion Laughs attacks.",
               "possibleValues": [

               ]
             }
           ],
           "writerProperties": [
             {
               "name": "writeDeclaration",
               "optional": true,
               "defaultValue": true,
               "description": "Indicates whether to write the XML header declaration or not.",
               "possibleValues": [
                 true,
                 false
               ]
             },
             {
               "name": "indent",
               "optional": true,
               "defaultValue": true,
               "description": "Indicates whether to indent the code for better readability or to compress it into a single line.",
               "possibleValues": [
                 true,
                 false
               ]
             }
           ]
         }
]
```

<!-- document id=9b4a862b500de0eb8528b810af0e212c487e7393cd28d56811a8831cc03e3bec url=/mulesoft/current/en-us/dataweave/2.6/dw-runtime-functions-dataformatsdescriptor.md -->

---
product: DataWeave
version: 2.6
---

# dataFormatsDescriptor

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## dataFormatsDescriptor(): Array<DataFormatDescriptor>

Returns an array of all `DataFormatDescriptor` values that are installed in the current instance of
DataWeave.

_Experimental:_ This function is an experimental feature that is subject to change or removal from
future versions of DataWeave.

### Example

This example shows how `dataFormatsDescriptor` behaves with different inputs.

#### Source

```DataWeave
import * from dw::Runtime
---
dataFormatsDescriptor()
```

#### Output

```Json
[
      {
           "id": "json",
           "binary": false,
           "defaultEncoding": "UTF-8",
           "extensions": [
             ".json"
           ],
           "defaultMimeType": "application/json",
           "acceptedMimeTypes": [
             "application/json"
           ],
           "readerProperties": [
             {
               "name": "streaming",
               "optional": true,
               "defaultValue": false,
               "description": "Used for streaming input (use only if entries are accessed sequentially).",
               "possibleValues": [
                 true,
                 false
               ]
             }
           ],
           "writerProperties": [
             {
               "name": "writeAttributes",
               "optional": true,
               "defaultValue": false,
               "description": "Indicates that if a key has attributes, they are going to be added as children key-value pairs of the key that contains them. The attribute new key name will start with @.",
               "possibleValues": [
                 true,
                 false
               ]
             },
             {
              "name": "skipNullOn",
                 "optional": true,
                 "defaultValue": "None",
                 "description": "Indicates where is should skips null values if any or not. By default it doesn't skip.",
                 "possibleValues": [
                   "arrays",
                   "objects",
                   "everywhere"
                 ]
               }
             ]
           },
           {
             "id": "xml",
             "binary": false,
             "extensions": [
               ".xml"
             ],
             "defaultMimeType": "application/xml",
             "acceptedMimeTypes": [
               "application/xml"
             ],
             "readerProperties": [
               {
               "name": "supportDtd",
               "optional": true,
               "defaultValue": true,
               "description": "Whether DTD handling is enabled or disabled; disabling means both internal and external subsets will just be skipped unprocessed.",
               "possibleValues": [
                 true,
                 false
               ]
             },
             {
               "name": "streaming",
               "optional": true,
               "defaultValue": false,
               "description": "Used for streaming input (use only if entries are accessed sequentially).",
               "possibleValues": [
                 true,
                 false
               ]
             },
             {
               "name": "maxEntityCount",
               "optional": true,
               "defaultValue": 1,
               "description": "The maximum number of entity expansions. The limit is in place to avoid Billion Laughs attacks.",
               "possibleValues": [

               ]
             }
           ],
           "writerProperties": [
             {
               "name": "writeDeclaration",
               "optional": true,
               "defaultValue": true,
               "description": "Indicates whether to write the XML header declaration or not.",
               "possibleValues": [
                 true,
                 false
               ]
             },
             {
               "name": "indent",
               "optional": true,
               "defaultValue": true,
               "description": "Indicates whether to indent the code for better readability or to compress it into a single line.",
               "possibleValues": [
                 true,
                 false
               ]
             }
           ]
         }
]
```

<!-- document id=5b292009b0eea8a9897ee383592073e311daf41781e07109d663cd3cddf81344 url=/mulesoft/current/en-us/dataweave/2.9/dw-runtime-functions-dataformatsdescriptor.md -->

---
product: DataWeave
version: 2.9
---

# dataFormatsDescriptor

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## dataFormatsDescriptor(): Array<DataFormatDescriptor>

Returns an array of all `DataFormatDescriptor` values that are installed in the current instance of
DataWeave.

_Experimental:_ This function is an experimental feature that is subject to change or removal from
future versions of DataWeave.

### Example

This example shows how `dataFormatsDescriptor` behaves with different inputs.

#### Source

```DataWeave
import * from dw::Runtime
---
dataFormatsDescriptor()
```

#### Output

```Json
[
      {
           "id": "json",
           "binary": false,
           "defaultEncoding": "UTF-8",
           "extensions": [
             ".json"
           ],
           "defaultMimeType": "application/json",
           "acceptedMimeTypes": [
             "application/json"
           ],
           "readerProperties": [
             {
               "name": "streaming",
               "optional": true,
               "defaultValue": false,
               "description": "Used for streaming input (use only if entries are accessed sequentially).",
               "possibleValues": [
                 true,
                 false
               ]
             }
           ],
           "writerProperties": [
             {
               "name": "writeAttributes",
               "optional": true,
               "defaultValue": false,
               "description": "Indicates that if a key has attributes, they are going to be added as children key-value pairs of the key that contains them. The attribute new key name will start with @.",
               "possibleValues": [
                 true,
                 false
               ]
             },
             {
              "name": "skipNullOn",
                 "optional": true,
                 "defaultValue": "None",
                 "description": "Indicates where is should skips null values if any or not. By default it doesn't skip.",
                 "possibleValues": [
                   "arrays",
                   "objects",
                   "everywhere"
                 ]
               }
             ]
           },
           {
             "id": "xml",
             "binary": false,
             "extensions": [
               ".xml"
             ],
             "defaultMimeType": "application/xml",
             "acceptedMimeTypes": [
               "application/xml"
             ],
             "readerProperties": [
               {
               "name": "supportDtd",
               "optional": true,
               "defaultValue": true,
               "description": "Whether DTD handling is enabled or disabled; disabling means both internal and external subsets will just be skipped unprocessed.",
               "possibleValues": [
                 true,
                 false
               ]
             },
             {
               "name": "streaming",
               "optional": true,
               "defaultValue": false,
               "description": "Used for streaming input (use only if entries are accessed sequentially).",
               "possibleValues": [
                 true,
                 false
               ]
             },
             {
               "name": "maxEntityCount",
               "optional": true,
               "defaultValue": 1,
               "description": "The maximum number of entity expansions. The limit is in place to avoid Billion Laughs attacks.",
               "possibleValues": [

               ]
             }
           ],
           "writerProperties": [
             {
               "name": "writeDeclaration",
               "optional": true,
               "defaultValue": true,
               "description": "Indicates whether to write the XML header declaration or not.",
               "possibleValues": [
                 true,
                 false
               ]
             },
             {
               "name": "indent",
               "optional": true,
               "defaultValue": true,
               "description": "Indicates whether to indent the code for better readability or to compress it into a single line.",
               "possibleValues": [
                 true,
                 false
               ]
             }
           ]
         }
]
```

<!-- document id=47254a3ee03f03f3eca3b6f09e95c68e0c4c550348f1c93b387185a0aa0f41f0 url=/mulesoft/current/en-us/dataweave/latest/dw-runtime-functions-dataformatsdescriptor.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# dataFormatsDescriptor

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## dataFormatsDescriptor(): Array<DataFormatDescriptor>

Returns an array of all `DataFormatDescriptor` values that are installed in the current instance of
DataWeave.

_Experimental:_ This function is an experimental feature that is subject to change or removal from
future versions of DataWeave.

### Example

This example shows how `dataFormatsDescriptor` behaves with different inputs.

#### Source

```DataWeave
import * from dw::Runtime
---
dataFormatsDescriptor()
```

#### Output

```Json
[
      {
           "id": "json",
           "binary": false,
           "defaultEncoding": "UTF-8",
           "extensions": [
             ".json"
           ],
           "defaultMimeType": "application/json",
           "acceptedMimeTypes": [
             "application/json"
           ],
           "readerProperties": [
             {
               "name": "streaming",
               "optional": true,
               "defaultValue": false,
               "description": "Used for streaming input (use only if entries are accessed sequentially).",
               "possibleValues": [
                 true,
                 false
               ]
             }
           ],
           "writerProperties": [
             {
               "name": "writeAttributes",
               "optional": true,
               "defaultValue": false,
               "description": "Indicates that if a key has attributes, they are going to be added as children key-value pairs of the key that contains them. The attribute new key name will start with @.",
               "possibleValues": [
                 true,
                 false
               ]
             },
             {
              "name": "skipNullOn",
                 "optional": true,
                 "defaultValue": "None",
                 "description": "Indicates where is should skips null values if any or not. By default it doesn't skip.",
                 "possibleValues": [
                   "arrays",
                   "objects",
                   "everywhere"
                 ]
               }
             ]
           },
           {
             "id": "xml",
             "binary": false,
             "extensions": [
               ".xml"
             ],
             "defaultMimeType": "application/xml",
             "acceptedMimeTypes": [
               "application/xml"
             ],
             "readerProperties": [
               {
               "name": "supportDtd",
               "optional": true,
               "defaultValue": true,
               "description": "Whether DTD handling is enabled or disabled; disabling means both internal and external subsets will just be skipped unprocessed.",
               "possibleValues": [
                 true,
                 false
               ]
             },
             {
               "name": "streaming",
               "optional": true,
               "defaultValue": false,
               "description": "Used for streaming input (use only if entries are accessed sequentially).",
               "possibleValues": [
                 true,
                 false
               ]
             },
             {
               "name": "maxEntityCount",
               "optional": true,
               "defaultValue": 1,
               "description": "The maximum number of entity expansions. The limit is in place to avoid Billion Laughs attacks.",
               "possibleValues": [

               ]
             }
           ],
           "writerProperties": [
             {
               "name": "writeDeclaration",
               "optional": true,
               "defaultValue": true,
               "description": "Indicates whether to write the XML header declaration or not.",
               "possibleValues": [
                 true,
                 false
               ]
             },
             {
               "name": "indent",
               "optional": true,
               "defaultValue": true,
               "description": "Indicates whether to indent the code for better readability or to compress it into a single line.",
               "possibleValues": [
                 true,
                 false
               ]
             }
           ]
         }
]
```

<!-- document id=3ef5468a3d4d251d32d0191f9f564486c148486c9e8d683e50fee396963511f5 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-formats-dw.md -->

---
product: DataWeave
version: 2.11
keywords: format, dw, */dw, application/dw
---

# DataWeave (dw) Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/dw`

ID: `dw`

The DataWeave (dw) format is the canonical format for all transformations. This format can help you
understand how input data is interpreted before it is transformed to a new format.

> [!NOTE] This format is intended to help you debug the results of DataWeave transformations. It is
> significantly slower than other formats. It is not recommended to be used in production
> applications because it can impact the performance.

## Example: Express XML in the DataWeave (dw) Format

The following example shows how to transform XML input to the DataWeave (dw) format.

### Input

The example uses the following XML snippet as input.

```xml
<employees>
  <employee>
    <firstname>Mariano</firstname>
    <lastname>DeAchaval</lastname>
  </employee>
  <employee>
    <firstname>Leandro</firstname>
    <lastname>Shokida</lastname>
  </employee>
</employees>
```

#### Output

Output: in DataWeave Format

```dataweave
{
  employees: {
    employee: {
      firstname: "Mariano",
      lastname: "DeAchaval"
    },
    employee: {
      firstname: "Leandro",
      lastname: "Shokida"
    }
  }
} as Object {encoding: "UTF-8", mimeType: "text/xml"}
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>externalResources</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Enables the <code>readUrl</code> to read external entities.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>javaModule</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Enables Java module functions to load.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>onlyData</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Handles only data and not other types of content, such as functions, when set to <code>true</code>. The DataWeave parser runs faster in the <code>onlyData</code> mode.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>privileges</code></p></td><td><p><code>String</code></p></td><td><p><code>''</code></p></td><td><div><div><p>Accepts a comma-separated list of privileges to use in the format, such as <code>'Resources,Properties'</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>ignoreSchema</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Ignores the schema when set to <code>true</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>indent</code></p></td><td><p><code>String</code></p></td><td><p><code>' '</code></p></td><td><div><div><p>String to use for indenting.</p></div></div></td></tr><tr><td><p><code>maxCollectionSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>-1</code></p></td><td><div><div><p>Maximum number of elements allowed in an array or an object. <code>-1</code> indicates no limitation.</p></div></div></td></tr><tr><td><p><code>onlyData</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Handles only data and not other types of content, such as functions, when set to <code>true</code>. The DataWeave parser runs faster in the <code>onlyData</code> mode.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/dw</code></p></td></tr></tbody></table>

<!-- document id=555327135e2c9eb0bc53052761d25bf529f5fa9453bbe7cf778c71d61fc0e604 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-formats-dw.md -->

---
product: DataWeave
version: 2.12
keywords: format, dw, */dw, application/dw
---

# DataWeave (dw) Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/dw`

ID: `dw`

The DataWeave (dw) format is the canonical format for all transformations. This format can help you
understand how input data is interpreted before it is transformed to a new format.

> [!NOTE] This format is intended to help you debug the results of DataWeave transformations. It is
> significantly slower than other formats. It is not recommended to be used in production
> applications because it can impact the performance.

## Example: Express XML in the DataWeave (dw) Format

The following example shows how to transform XML input to the DataWeave (dw) format.

### Input

The example uses the following XML snippet as input.

```xml
<employees>
  <employee>
    <firstname>Mariano</firstname>
    <lastname>DeAchaval</lastname>
  </employee>
  <employee>
    <firstname>Leandro</firstname>
    <lastname>Shokida</lastname>
  </employee>
</employees>
```

#### Output

Output: in DataWeave Format

```dataweave
{
  employees: {
    employee: {
      firstname: "Mariano",
      lastname: "DeAchaval"
    },
    employee: {
      firstname: "Leandro",
      lastname: "Shokida"
    }
  }
} as Object {encoding: "UTF-8", mimeType: "text/xml"}
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>externalResources</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Enables the <code>readUrl</code> to read external entities.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>javaModule</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Enables Java module functions to load.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>onlyData</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Handles only data and not other types of content, such as functions, when set to <code>true</code>. The DataWeave parser runs faster in the <code>onlyData</code> mode.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>privileges</code></p></td><td><p><code>String</code></p></td><td><p><code>''</code></p></td><td><div><div><p>Accepts a comma-separated list of privileges to use in the format, such as <code>'Resources,Properties'</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>ignoreSchema</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Ignores the schema when set to <code>true</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>indent</code></p></td><td><p><code>String</code></p></td><td><p><code>' '</code></p></td><td><div><div><p>String to use for indenting.</p></div></div></td></tr><tr><td><p><code>maxCollectionSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>-1</code></p></td><td><div><div><p>Maximum number of elements allowed in an array or an object. <code>-1</code> indicates no limitation.</p></div></div></td></tr><tr><td><p><code>onlyData</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Handles only data and not other types of content, such as functions, when set to <code>true</code>. The DataWeave parser runs faster in the <code>onlyData</code> mode.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/dw</code></p></td></tr></tbody></table>

<!-- document id=2b31a84f1aac026ba00ca75a698ab9bdc9a674ebbdbc39f91c2f8de9216501ec url=/mulesoft/current/en-us/dataweave/2.4/dataweave-formats-dw.md -->

---
product: DataWeave
version: 2.4
keywords: format, dw, */dw, application/dw
---

# DataWeave (dw) Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/dw`

ID: `dw`

The DataWeave (dw) format is the canonical format for all transformations. This format can help you
understand how input data is interpreted before it is transformed to a new format.

> [!NOTE] This format is intended to help you debug the results of DataWeave transformations. It is
> significantly slower than other formats. It is not recommended to be used in production
> applications because it can impact the performance.

## Example: Express XML in the DataWeave (dw) Format

The following example shows how to transform XML input to the DataWeave (dw) format.

### Input

The example uses the following XML snippet as input.

```xml
<employees>
  <employee>
    <firstname>Mariano</firstname>
    <lastname>DeAchaval</lastname>
  </employee>
  <employee>
    <firstname>Leandro</firstname>
    <lastname>Shokida</lastname>
  </employee>
</employees>
```

#### Output

Output: in DataWeave Format

```dataweave
{
  employees: {
    employee: {
      firstname: "Mariano",
      lastname: "DeAchaval"
    },
    employee: {
      firstname: "Leandro",
      lastname: "Shokida"
    }
  }
} as Object {encoding: "UTF-8", mimeType: "text/xml"}
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>externalResources</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Enables the <code>readUrl</code> to read external entities.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>javaModule</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Enables Java module functions to load.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>onlyData</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Handles only data and not other types of content, such as functions, when set to <code>true</code>. The DataWeave parser runs faster in the <code>onlyData</code> mode.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>privileges</code></p></td><td><p><code>String</code></p></td><td><p><code>''</code></p></td><td><div><div><p>Accepts a comma-separated list of privileges to use in the format, such as <code>'Resources,Properties'</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>ignoreSchema</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Ignores the schema when set to <code>true</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>indent</code></p></td><td><p><code>String</code></p></td><td><p><code>' '</code></p></td><td><div><div><p>String to use for indenting.</p></div></div></td></tr><tr><td><p><code>maxCollectionSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>-1</code></p></td><td><div><div><p>Maximum number of elements allowed in an array or an object. <code>-1</code> indicates no limitation.</p></div></div></td></tr><tr><td><p><code>onlyData</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Handles only data and not other types of content, such as functions, when set to <code>true</code>. The DataWeave parser runs faster in the <code>onlyData</code> mode.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/dw</code></p></td></tr></tbody></table>

<!-- document id=980027e880fcafb3d52b78037a87035dfbab8813fb61be008708849f489af184 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-formats-dw.md -->

---
product: DataWeave
version: 2.6
keywords: format, dw, */dw, application/dw
---

# DataWeave (dw) Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/dw`

ID: `dw`

The DataWeave (dw) format is the canonical format for all transformations. This format can help you
understand how input data is interpreted before it is transformed to a new format.

> [!NOTE] This format is intended to help you debug the results of DataWeave transformations. It is
> significantly slower than other formats. It is not recommended to be used in production
> applications because it can impact the performance.

## Example: Express XML in the DataWeave (dw) Format

The following example shows how to transform XML input to the DataWeave (dw) format.

### Input

The example uses the following XML snippet as input.

```xml
<employees>
  <employee>
    <firstname>Mariano</firstname>
    <lastname>DeAchaval</lastname>
  </employee>
  <employee>
    <firstname>Leandro</firstname>
    <lastname>Shokida</lastname>
  </employee>
</employees>
```

#### Output

Output: in DataWeave Format

```dataweave
{
  employees: {
    employee: {
      firstname: "Mariano",
      lastname: "DeAchaval"
    },
    employee: {
      firstname: "Leandro",
      lastname: "Shokida"
    }
  }
} as Object {encoding: "UTF-8", mimeType: "text/xml"}
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>externalResources</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Enables the <code>readUrl</code> to read external entities.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>javaModule</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Enables Java module functions to load.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>onlyData</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Handles only data and not other types of content, such as functions, when set to <code>true</code>. The DataWeave parser runs faster in the <code>onlyData</code> mode.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>privileges</code></p></td><td><p><code>String</code></p></td><td><p><code>''</code></p></td><td><div><div><p>Accepts a comma-separated list of privileges to use in the format, such as <code>'Resources,Properties'</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>ignoreSchema</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Ignores the schema when set to <code>true</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>indent</code></p></td><td><p><code>String</code></p></td><td><p><code>' '</code></p></td><td><div><div><p>String to use for indenting.</p></div></div></td></tr><tr><td><p><code>maxCollectionSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>-1</code></p></td><td><div><div><p>Maximum number of elements allowed in an array or an object. <code>-1</code> indicates no limitation.</p></div></div></td></tr><tr><td><p><code>onlyData</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Handles only data and not other types of content, such as functions, when set to <code>true</code>. The DataWeave parser runs faster in the <code>onlyData</code> mode.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/dw</code></p></td></tr></tbody></table>

<!-- document id=cf3936fb6a13e997a93f71ef14120281897d5a17923d145d3006cabe3af7e295 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-formats-dw.md -->

---
product: DataWeave
version: 2.9
keywords: format, dw, */dw, application/dw
---

# DataWeave (dw) Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/dw`

ID: `dw`

The DataWeave (dw) format is the canonical format for all transformations. This format can help you
understand how input data is interpreted before it is transformed to a new format.

> [!NOTE] This format is intended to help you debug the results of DataWeave transformations. It is
> significantly slower than other formats. It is not recommended to be used in production
> applications because it can impact the performance.

## Example: Express XML in the DataWeave (dw) Format

The following example shows how to transform XML input to the DataWeave (dw) format.

### Input

The example uses the following XML snippet as input.

```xml
<employees>
  <employee>
    <firstname>Mariano</firstname>
    <lastname>DeAchaval</lastname>
  </employee>
  <employee>
    <firstname>Leandro</firstname>
    <lastname>Shokida</lastname>
  </employee>
</employees>
```

#### Output

Output: in DataWeave Format

```dataweave
{
  employees: {
    employee: {
      firstname: "Mariano",
      lastname: "DeAchaval"
    },
    employee: {
      firstname: "Leandro",
      lastname: "Shokida"
    }
  }
} as Object {encoding: "UTF-8", mimeType: "text/xml"}
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>externalResources</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Enables the <code>readUrl</code> to read external entities.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>javaModule</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Enables Java module functions to load.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>onlyData</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Handles only data and not other types of content, such as functions, when set to <code>true</code>. The DataWeave parser runs faster in the <code>onlyData</code> mode.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>privileges</code></p></td><td><p><code>String</code></p></td><td><p><code>''</code></p></td><td><div><div><p>Accepts a comma-separated list of privileges to use in the format, such as <code>'Resources,Properties'</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>ignoreSchema</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Ignores the schema when set to <code>true</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>indent</code></p></td><td><p><code>String</code></p></td><td><p><code>' '</code></p></td><td><div><div><p>String to use for indenting.</p></div></div></td></tr><tr><td><p><code>maxCollectionSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>-1</code></p></td><td><div><div><p>Maximum number of elements allowed in an array or an object. <code>-1</code> indicates no limitation.</p></div></div></td></tr><tr><td><p><code>onlyData</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Handles only data and not other types of content, such as functions, when set to <code>true</code>. The DataWeave parser runs faster in the <code>onlyData</code> mode.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/dw</code></p></td></tr></tbody></table>

<!-- document id=0ba85f96dc93f5d12533bdf507233e0253842e3089f28bc08c3771a0391106e4 url=/mulesoft/current/en-us/dataweave/latest/dataweave-formats-dw.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: format, dw, */dw, application/dw
---

# DataWeave (dw) Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/dw`

ID: `dw`

The DataWeave (dw) format is the canonical format for all transformations. This format can help you
understand how input data is interpreted before it is transformed to a new format.

> [!NOTE] This format is intended to help you debug the results of DataWeave transformations. It is
> significantly slower than other formats. It is not recommended to be used in production
> applications because it can impact the performance.

## Example: Express XML in the DataWeave (dw) Format

The following example shows how to transform XML input to the DataWeave (dw) format.

### Input

The example uses the following XML snippet as input.

```xml
<employees>
  <employee>
    <firstname>Mariano</firstname>
    <lastname>DeAchaval</lastname>
  </employee>
  <employee>
    <firstname>Leandro</firstname>
    <lastname>Shokida</lastname>
  </employee>
</employees>
```

#### Output

Output: in DataWeave Format

```dataweave
{
  employees: {
    employee: {
      firstname: "Mariano",
      lastname: "DeAchaval"
    },
    employee: {
      firstname: "Leandro",
      lastname: "Shokida"
    }
  }
} as Object {encoding: "UTF-8", mimeType: "text/xml"}
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>externalResources</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Enables the <code>readUrl</code> to read external entities.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>javaModule</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Enables Java module functions to load.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>onlyData</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Handles only data and not other types of content, such as functions, when set to <code>true</code>. The DataWeave parser runs faster in the <code>onlyData</code> mode.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>privileges</code></p></td><td><p><code>String</code></p></td><td><p><code>''</code></p></td><td><div><div><p>Accepts a comma-separated list of privileges to use in the format, such as <code>'Resources,Properties'</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>ignoreSchema</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Ignores the schema when set to <code>true</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>indent</code></p></td><td><p><code>String</code></p></td><td><p><code>' '</code></p></td><td><div><div><p>String to use for indenting.</p></div></div></td></tr><tr><td><p><code>maxCollectionSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>-1</code></p></td><td><div><div><p>Maximum number of elements allowed in an array or an object. <code>-1</code> indicates no limitation.</p></div></div></td></tr><tr><td><p><code>onlyData</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Handles only data and not other types of content, such as functions, when set to <code>true</code>. The DataWeave parser runs faster in the <code>onlyData</code> mode.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/dw</code></p></td></tr></tbody></table>

<!-- document id=59efe8f12da01fa794c72261bbf9e861b1f3d641e060ea0d1510c9dc01bcfe1f url=/mulesoft/current/en-us/dataweave/2.11/dataweave-formats-dwb.md -->

---
product: DataWeave
version: 2.11
keywords: format, dwb, application/dwb, application/dwb
---

# DataWeave Binary (dwb) Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/dwb`

ID: `dwb`

TODO FOR 2.4?

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>indexedReader</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Uses the indexed reader by default when reaching the threshold. Supports US-ASCII, UTF-8 and ISO-8859-1 encodings only. For other encodings, DataWeave uses the in-memory reader.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>writeIndex</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>If it should add the token and hierarchical index at the end to avoid parsing again when this is read</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>application/dwb</code></p></td></tr></tbody></table>

<!-- document id=7c97b3267f9779a2976e42b5957d1bfe25a58c5ca82f2224ba8670efce32b8c9 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-formats-dwb.md -->

---
product: DataWeave
version: 2.12
keywords: format, dwb, application/dwb, application/dwb
---

# DataWeave Binary (dwb) Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/dwb`

ID: `dwb`

TODO FOR 2.4?

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>indexedReader</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Uses the indexed reader by default when reaching the threshold. Supports US-ASCII, UTF-8 and ISO-8859-1 encodings only. For other encodings, DataWeave uses the in-memory reader.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>writeIndex</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>If it should add the token and hierarchical index at the end to avoid parsing again when this is read</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>application/dwb</code></p></td></tr></tbody></table>

<!-- document id=a21ac39b12fb8d3a3d82fb905ef65f163387a847d7610b98197c40fc66668286 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-formats-dwb.md -->

---
product: DataWeave
version: 2.4
keywords: format, dwb, application/dwb, application/dwb
---

# DataWeave Binary (dwb) Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/dwb`

ID: `dwb`

TODO FOR 2.4?

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>indexedReader</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Uses the indexed reader by default when reaching the threshold. Supports US-ASCII, UTF-8 and ISO-8859-1 encodings only. For other encodings, DataWeave uses the in-memory reader.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>writeIndex</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>If it should add the token and hierarchical index at the end to avoid parsing again when this is read</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>application/dwb</code></p></td></tr></tbody></table>

<!-- document id=bbc66bfa8dec4651afdc7b8ecf135df9e8a81a8a299138ea23b1af0be4c6221d url=/mulesoft/current/en-us/dataweave/2.6/dataweave-formats-dwb.md -->

---
product: DataWeave
version: 2.6
keywords: format, dwb, application/dwb, application/dwb
---

# DataWeave Binary (dwb) Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/dwb`

ID: `dwb`

TODO FOR 2.4?

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>indexedReader</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Uses the indexed reader by default when reaching the threshold. Supports US-ASCII, UTF-8 and ISO-8859-1 encodings only. For other encodings, DataWeave uses the in-memory reader.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>writeIndex</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>If it should add the token and hierarchical index at the end to avoid parsing again when this is read</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>application/dwb</code></p></td></tr></tbody></table>

<!-- document id=4052c6263b3e8dc7347b980bdc012b5248da19fabfcf4a50fd45c8075f44cb91 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-formats-dwb.md -->

---
product: DataWeave
version: 2.9
keywords: format, dwb, application/dwb, application/dwb
---

# DataWeave Binary (dwb) Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/dwb`

ID: `dwb`

TODO FOR 2.4?

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>indexedReader</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Uses the indexed reader by default when reaching the threshold. Supports US-ASCII, UTF-8 and ISO-8859-1 encodings only. For other encodings, DataWeave uses the in-memory reader.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>writeIndex</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>If it should add the token and hierarchical index at the end to avoid parsing again when this is read</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>application/dwb</code></p></td></tr></tbody></table>

<!-- document id=a622ee4469341bcb7dce937b7979ed150b5c1c0015fe8a83523442b18d01271e url=/mulesoft/current/en-us/dataweave/latest/dataweave-formats-dwb.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: format, dwb, application/dwb, application/dwb
---

# DataWeave Binary (dwb) Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/dwb`

ID: `dwb`

TODO FOR 2.4?

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>indexedReader</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Uses the indexed reader by default when reaching the threshold. Supports US-ASCII, UTF-8 and ISO-8859-1 encodings only. For other encodings, DataWeave uses the in-memory reader.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>writeIndex</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>If it should add the token and hierarchical index at the end to avoid parsing again when this is read</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>application/dwb</code></p></td></tr></tbody></table>

<!-- document id=f12b43bcd3594775f42177f28b5cc3e3d39056a549471add434b1a90dfac3a51 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, examples
---

# DataWeave Examples

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following DataWeave examples demonstrate common data extraction and transformation approaches.
There are DataWeave code examples of how to transform data, and also examples of Mule applications
that implement DataWeave transformations.

## DataWeave Code Examples

These examples show how to use standalone DataWeave to extract and transform data.

<table><colgroup><col> <col></colgroup><thead><tr><th>Example</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-extract-data">Extract Data</a></p></td><td><div><div><p>Shows common selector expressions for extracting values from a data source, such as a Mule message.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-select-xml-elements">Select XML Elements</a></p></td><td><div><div><p>Uses a single-value DataWeave selector (<code>.</code>) to extract data from XML elements.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-defaults">Set a Default Value</a></p></td><td><div><div><p>Shows some common ways to set default values.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-set-reader-writer-props">Set Reader and Writer Configuration Properties</a></p></td><td><div><div><p>Shows how to use and change the settings for reading and writing data formats, such as <code>application/csv</code>.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-perform-basic-transformation">Transform XML to JSON</a></p></td><td><div><div><p>Uses selectors to perform a basic format transformation. It does not use any functions.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-map">Map Data</a></p></td><td><div><div><p>Uses <code>map</code> to reorganize fields in a JSON array. It uses <code>as</code> to coerce a String into a Number.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-map-and-flatten">Map and Flatten an Array</a></p></td><td><div><div><p>Uses <code>flatMap</code> to map objects in an array and flatten the resulting array.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-map-an-object">Map Objects</a></p></td><td><div><div><p>Uses <code>mapObject</code> to go through the keys and values in each object, and set all the keys to upper case.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-map-an-object-key">Map Objects Key</a></p></td><td><div><div><p>Uses the <code>mapObject</code> function to iterate through an array of objects and appends a new object that matches the value of the specified criteria.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-map-object-elements-as-an-array">Map the Objects within an Array</a></p></td><td><div><div><p>Uses the multi-value selector to pick out the keys in an object that are named "book", these are returned as an array. It then uses <code>map</code> to iterate through the array this creates.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-map-based-on-an-external-definition">Dynamic Map Based on a Definition</a></p></td><td><div><div><p>Transforms the payload according to definitions sent in a variable. It defines a function that applies the logic defined in the variable, using <code>map</code> and <code>default</code>.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-rename-keys">Rename Keys</a></p></td><td><div><div><p>Renames some keys in a JSON object while retaining the names of all other keys in the output. Uses <code>mapObject</code>, <code>if</code>, <code>as</code>, and <code>and</code>.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-output-a-field-when-present">Output a Field When Present</a></p></td><td><div><div><p>Uses <code>if</code> with <code>map</code> to determine whether to include a field in the output. You might use it to exclude fields that contain sensitive data.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-format-according-to-type">Format According to Type</a></p></td><td><div><div><p>Uses <code>mapObject</code> to apply changes to the keys in an object, depending on the type of their corresponding values. Uses <code>camelize</code>, <code>capitalize</code>, and <code>pluralize</code> depending on the <code>if</code> and <code>else if</code> statement.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-regroup-fields">Regroup Fields</a></p></td><td><div><div><p>Uses <code>groupBy</code>, <code>mapObject</code>, and <code>map</code> to reorganize JSON and XML fields.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-zip-arrays-together">Zip Arrays Together</a></p></td><td><div><div><p>Uses <code>zip</code> to rearrange pairs of similar arrays so that they form a series of tuples with the matching values from each.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-pick-top-elements">Pick Top Elements</a></p></td><td><div><div><p>Uses <code>groupBy</code> and <code>map</code> to sort a list of candidates according to their score at a test, then it splits the array to select only the top candidates.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-change-value-of-a-field">Change the Value of a Field</a></p></td><td><div><div><p>Masks sensitive data by changing values of some keys to asterisks (<code>****`</code>). Uses <code>mapObject</code>, <code>if</code>, and <code>else</code>.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-exclude-field">Exclude Fields from the Output</a></p></td><td><div><div><p>Shows how to exclude unwanted elements from the output. Uses the <code>-</code> (remove) and <code>mapObject</code> functions.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-use-constant-directives">Use Constant Directives</a></p></td><td><div><div><p>Defines a series of constant strings and numbers in the header, these are used to filter input and to concatenate into URLs. Uses <code>map</code>, <code>if</code> and <code>++</code> to concatenate strings.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-define-a-custom-addition-function">Define a Custom Addition Function</a></p></td><td><div><div><p>Defines a function that obtains totals and subtotals through the <code>accumulator</code> function. Also performs additions, subtractions, and multiplications of numeric values.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-define-function-to-flatten-list">Define a Function That Flattens Data in a List</a></p></td><td><div><div><p>Uses <code>reduce</code>, <code>map</code>, <code>if</code>, and <code>splitBy</code> to modify and conditionally output fields from a list.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-flatten-arrays">Flatten Elements of Arrays</a></p></td><td><div><div><p>Uses <code>flatten</code>, the object constructor braces (<code>{}</code>), and selectors to flatten subarrays and nested elements in arrays. Uses concatenation (<code>++</code>) to combine arrays before flattening them and uses the <code>..*</code> descendants selector on a key to select values from a flattened list.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-use-regex">Use Regular Expressions</a></p></td><td><div><div><p>Shows uses of regular expressions in arguments to several DataWeave functions.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-output-self-closing-xml-tags">Output Self-closing XML Tags</a></p></td><td><div><div><p>Uses <code>inlineCloseOn="empty"</code> to close empty tags (for example, <code>&lt;element2/&gt;</code>).</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-insert-attribute">Insert an Attribute into an XML Tag</a></p></td><td><div><div><p>Uses the <code>@(key:value)</code> syntax to create an XML attribute.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-remove-certain-xml-attributes">Remove Specified XML Attributes</a></p></td><td><div><div><p>Defines a function that recursively checks an element and all of its children for a specific XML attribute and removes it with <code>-</code>. It also uses <code>mapObject</code>, <code>if</code> and <code>is</code> (to match types).</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-pass-xml-attributes">Pass XML Attributes</a></p></td><td><div><div><p>Pass XML attributes from the input source payload to the output XML. It uses the dynamic attribute expression <code>@dynamicAttributes</code> to create the attributes of the new output tag by selecting the attributes dynamically from the input.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-include-xml-namespaces">Include XML Namespaces</a></p></td><td><div><div><p>Defines multiple XML namespaces and references these in each tag.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-remove-objects">Remove Objects Containing Specified Key-Value Pairs</a></p></td><td><div><div><p>Removes all objects that contain a set of key-value pairs from an array of objects. Uses <code>filter</code> with <code>contains</code> and a <code>not</code> operator.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-reference-multiple-inputs">Reference Multiple Inputs</a></p></td><td><div><div><p>References data on the payload, a message attribute and a variable. It then processes these through <code>map</code>, <code>filter</code> and multiplications.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-merge-multiple-payloads">Merge Fields from Separate Objects</a></p></td><td><div><div><p>Reference data that arrives in multiple separate payloads from one single Mule event. Filters the output based on a unique identifier. Uses <code>map</code>, <code>using</code>, <code>as</code>, and <code>filter</code> functions.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-parse-dates">Parse Dates</a></p></td><td><div><div><p>Defines a function that normalizes conflicting date formats into a single, common format. Uses <code>mapObject</code>, <code>replace</code> and <code>as</code> to coerce a data type.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-add-and-subtract-time">Add and Subtract Dates</a></p></td><td><div><div><p>Performs multiple math operations combining different types related to date and time.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-change-time-zone">Change a Time Zone</a></p></td><td><div><div><p>Uses <code>&gt;&gt;</code> with a time zone ID to change a time zone and provides a list of available time zone IDs.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-format-dates">Format Dates and Times</a></p></td><td><div><div><p>Uses formatting characters such as <code>uuuu/MM/dd</code> to change the format of dates and times. Creates a date-time format using a custom DataWeave type.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-work-with-multipart-data">Work with Multipart Data</a></p></td><td><div><div><p>Uses <code>mapObject</code> to iterate over a multipart payload and extract data from each part. It also uses <code>read</code> with a <code>boundary</code> value to read the multipart content.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-conditional-list-reduction-via-function">Conditionally Reduce a List through a Function</a></p></td><td><div><div><p>Defines a function that reduces a list of elements into one field. It then calls this function only when a certain field has values. Uses <code>map</code>, <code>reduce</code>, <code>splitBy</code>, <code>if</code> and <code>++</code> to append to an array.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-pass-functions-as-arguments">Pass Functions as Arguments</a></p></td><td><div><div><p>Defines a function that expects to receive two inputs: a function to apply and an element to apply it on. The function is also recursively applied to the element’s children. It uses <code>mapObject</code> <code>lower</code> <code>is</code> <code>if/else</code>.</p></div></div></td></tr></tbody></table>

## DataWeave Code in MuleSoft Applications Examples

These examples show how to use DataWeave to extract and transform data in MuleSoft applications.

<table><colgroup><col> <col></colgroup><thead><tr><th>Example</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-change-script-output-mime">Change a Script’s Output Mime Type</a></p></td><td><div><div><p>Shows how to customize the MIME type of a given format output, including an example of a JSON output with <code>application/problem+json</code> MIME type.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-xlsx-lookup">Look Up Data in an Excel (XLSX) File</a></p></td><td><div><div><p>Uses <code>filter</code> to return rows that contain a specified value.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-csv-lookup">Look Up Data in CSV File</a></p></td><td><div><div><p>Uses <code>filter</code> with <code>map</code> to look up data in a CSV file and return a country code for each calling code found within an input array of phone numbers.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-decode-encode">Decode and Encode Base64</a></p></td><td><div><div><p>Converts a file stream into Base64 and converts a Base64 string into a file stream. Uses a PDF file as the input and output.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-java-methods">Call Java Methods with DataWeave</a></p></td><td><div><div><p>Calls Java methods from a Java class in a Mule project.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-flat-file-read-and-write">Read and Write a Flat File</a></p></td><td><div><div><p>Use DataWeave to read and write flat files in a Mule application.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-reader-prop-connector">Use a Reader Property through a Connector</a></p></td><td><div><div><p>Use a reader property through a Connector operation.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-writer-prop-mule">Use Dynamic Writer Properties</a></p></td><td><div><div><p>Use a Mule variable as a configuration value.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-pluck">Extract Key/Value Pairs with Pluck Function</a></p></td><td><div><div><p>Use the DataWeave <code>pluck</code> function to extract key-value pairs from a JSON payload and store them into Mule event variables.</p></div></div></td></tr></tbody></table>

## See Also

- [DataWeave Language](https://docs.mulesoft.com/dataweave/2.11/)

- [DataWeave Scripts](https://docs.mulesoft.com/dataweave/2.11/dataweave-language-introduction)

- [DataWeave Reference](https://docs.mulesoft.com/dataweave/2.11/dw-functions)

<!-- document id=1083767b856376da19c59b640a1bda45384c89a86f927a31dc9028384ba83962 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, examples
---

# DataWeave Examples

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following DataWeave examples demonstrate common data extraction and transformation approaches.
There are DataWeave code examples of how to transform data, and also examples of Mule applications
that implement DataWeave transformations.

## DataWeave Code Examples

These examples show how to use standalone DataWeave to extract and transform data.

<table><colgroup><col> <col></colgroup><thead><tr><th>Example</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-extract-data">Extract Data</a></p></td><td><div><div><p>Shows common selector expressions for extracting values from a data source, such as a Mule message.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-select-xml-elements">Select XML Elements</a></p></td><td><div><div><p>Uses a single-value DataWeave selector (<code>.</code>) to extract data from XML elements.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-defaults">Set a Default Value</a></p></td><td><div><div><p>Shows some common ways to set default values.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-set-reader-writer-props">Set Reader and Writer Configuration Properties</a></p></td><td><div><div><p>Shows how to use and change the settings for reading and writing data formats, such as <code>application/csv</code>.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-perform-basic-transformation">Transform XML to JSON</a></p></td><td><div><div><p>Uses selectors to perform a basic format transformation. It does not use any functions.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-map">Map Data</a></p></td><td><div><div><p>Uses <code>map</code> to reorganize fields in a JSON array. It uses <code>as</code> to coerce a String into a Number.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-map-and-flatten">Map and Flatten an Array</a></p></td><td><div><div><p>Uses <code>flatMap</code> to map objects in an array and flatten the resulting array.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-map-an-object">Map Objects</a></p></td><td><div><div><p>Uses <code>mapObject</code> to go through the keys and values in each object, and set all the keys to upper case.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-map-an-object-key">Map Objects Key</a></p></td><td><div><div><p>Uses the <code>mapObject</code> function to iterate through an array of objects and appends a new object that matches the value of the specified criteria.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-map-object-elements-as-an-array">Map the Objects within an Array</a></p></td><td><div><div><p>Uses the multi-value selector to pick out the keys in an object that are named "book", these are returned as an array. It then uses <code>map</code> to iterate through the array this creates.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-map-based-on-an-external-definition">Dynamic Map Based on a Definition</a></p></td><td><div><div><p>Transforms the payload according to definitions sent in a variable. It defines a function that applies the logic defined in the variable, using <code>map</code> and <code>default</code>.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-rename-keys">Rename Keys</a></p></td><td><div><div><p>Renames some keys in a JSON object while retaining the names of all other keys in the output. Uses <code>mapObject</code>, <code>if</code>, <code>as</code>, and <code>and</code>.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-output-a-field-when-present">Output a Field When Present</a></p></td><td><div><div><p>Uses <code>if</code> with <code>map</code> to determine whether to include a field in the output. You might use it to exclude fields that contain sensitive data.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-format-according-to-type">Format According to Type</a></p></td><td><div><div><p>Uses <code>mapObject</code> to apply changes to the keys in an object, depending on the type of their corresponding values. Uses <code>camelize</code>, <code>capitalize</code>, and <code>pluralize</code> depending on the <code>if</code> and <code>else if</code> statement.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-regroup-fields">Regroup Fields</a></p></td><td><div><div><p>Uses <code>groupBy</code>, <code>mapObject</code>, and <code>map</code> to reorganize JSON and XML fields.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-zip-arrays-together">Zip Arrays Together</a></p></td><td><div><div><p>Uses <code>zip</code> to rearrange pairs of similar arrays so that they form a series of tuples with the matching values from each.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-pick-top-elements">Pick Top Elements</a></p></td><td><div><div><p>Uses <code>groupBy</code> and <code>map</code> to sort a list of candidates according to their score at a test, then it splits the array to select only the top candidates.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-change-value-of-a-field">Change the Value of a Field</a></p></td><td><div><div><p>Masks sensitive data by changing values of some keys to asterisks (<code>****`</code>). Uses <code>mapObject</code>, <code>if</code>, and <code>else</code>.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-exclude-field">Exclude Fields from the Output</a></p></td><td><div><div><p>Shows how to exclude unwanted elements from the output. Uses the <code>-</code> (remove) and <code>mapObject</code> functions.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-use-constant-directives">Use Constant Directives</a></p></td><td><div><div><p>Defines a series of constant strings and numbers in the header, these are used to filter input and to concatenate into URLs. Uses <code>map</code>, <code>if</code> and <code>++</code> to concatenate strings.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-define-a-custom-addition-function">Define a Custom Addition Function</a></p></td><td><div><div><p>Defines a function that obtains totals and subtotals through the <code>accumulator</code> function. Also performs additions, subtractions, and multiplications of numeric values.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-define-function-to-flatten-list">Define a Function That Flattens Data in a List</a></p></td><td><div><div><p>Uses <code>reduce</code>, <code>map</code>, <code>if</code>, and <code>splitBy</code> to modify and conditionally output fields from a list.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-flatten-arrays">Flatten Elements of Arrays</a></p></td><td><div><div><p>Uses <code>flatten</code>, the object constructor braces (<code>{}</code>), and selectors to flatten subarrays and nested elements in arrays. Uses concatenation (<code>++</code>) to combine arrays before flattening them and uses the <code>..*</code> descendants selector on a key to select values from a flattened list.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-use-regex">Use Regular Expressions</a></p></td><td><div><div><p>Shows uses of regular expressions in arguments to several DataWeave functions.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-output-self-closing-xml-tags">Output Self-closing XML Tags</a></p></td><td><div><div><p>Uses <code>inlineCloseOn="empty"</code> to close empty tags (for example, <code>&lt;element2/&gt;</code>).</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-insert-attribute">Insert an Attribute into an XML Tag</a></p></td><td><div><div><p>Uses the <code>@(key:value)</code> syntax to create an XML attribute.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-remove-certain-xml-attributes">Remove Specified XML Attributes</a></p></td><td><div><div><p>Defines a function that recursively checks an element and all of its children for a specific XML attribute and removes it with <code>-</code>. It also uses <code>mapObject</code>, <code>if</code> and <code>is</code> (to match types).</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-pass-xml-attributes">Pass XML Attributes</a></p></td><td><div><div><p>Pass XML attributes from the input source payload to the output XML. It uses the dynamic attribute expression <code>@dynamicAttributes</code> to create the attributes of the new output tag by selecting the attributes dynamically from the input.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-include-xml-namespaces">Include XML Namespaces</a></p></td><td><div><div><p>Defines multiple XML namespaces and references these in each tag.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-remove-objects">Remove Objects Containing Specified Key-Value Pairs</a></p></td><td><div><div><p>Removes all objects that contain a set of key-value pairs from an array of objects. Uses <code>filter</code> with <code>contains</code> and a <code>not</code> operator.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-reference-multiple-inputs">Reference Multiple Inputs</a></p></td><td><div><div><p>References data on the payload, a message attribute and a variable. It then processes these through <code>map</code>, <code>filter</code> and multiplications.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-merge-multiple-payloads">Merge Fields from Separate Objects</a></p></td><td><div><div><p>Reference data that arrives in multiple separate payloads from one single Mule event. Filters the output based on a unique identifier. Uses <code>map</code>, <code>using</code>, <code>as</code>, and <code>filter</code> functions.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-parse-dates">Parse Dates</a></p></td><td><div><div><p>Defines a function that normalizes conflicting date formats into a single, common format. Uses <code>mapObject</code>, <code>replace</code> and <code>as</code> to coerce a data type.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-add-and-subtract-time">Add and Subtract Dates</a></p></td><td><div><div><p>Performs multiple math operations combining different types related to date and time.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-change-time-zone">Change a Time Zone</a></p></td><td><div><div><p>Uses <code>&gt;&gt;</code> with a time zone ID to change a time zone and provides a list of available time zone IDs.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-format-dates">Format Dates and Times</a></p></td><td><div><div><p>Uses formatting characters such as <code>uuuu/MM/dd</code> to change the format of dates and times. Creates a date-time format using a custom DataWeave type.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-work-with-multipart-data">Work with Multipart Data</a></p></td><td><div><div><p>Uses <code>mapObject</code> to iterate over a multipart payload and extract data from each part. It also uses <code>read</code> with a <code>boundary</code> value to read the multipart content.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-conditional-list-reduction-via-function">Conditionally Reduce a List through a Function</a></p></td><td><div><div><p>Defines a function that reduces a list of elements into one field. It then calls this function only when a certain field has values. Uses <code>map</code>, <code>reduce</code>, <code>splitBy</code>, <code>if</code> and <code>++</code> to append to an array.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-pass-functions-as-arguments">Pass Functions as Arguments</a></p></td><td><div><div><p>Defines a function that expects to receive two inputs: a function to apply and an element to apply it on. The function is also recursively applied to the element’s children. It uses <code>mapObject</code> <code>lower</code> <code>is</code> <code>if/else</code>.</p></div></div></td></tr></tbody></table>

## DataWeave Code in MuleSoft Applications Examples

These examples show how to use DataWeave to extract and transform data in MuleSoft applications.

<table><colgroup><col> <col></colgroup><thead><tr><th>Example</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-change-script-output-mime">Change a Script’s Output Mime Type</a></p></td><td><div><div><p>Shows how to customize the MIME type of a given format output, including an example of a JSON output with <code>application/problem+json</code> MIME type.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-xlsx-lookup">Look Up Data in an Excel (XLSX) File</a></p></td><td><div><div><p>Uses <code>filter</code> to return rows that contain a specified value.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-csv-lookup">Look Up Data in CSV File</a></p></td><td><div><div><p>Uses <code>filter</code> with <code>map</code> to look up data in a CSV file and return a country code for each calling code found within an input array of phone numbers.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-decode-encode">Decode and Encode Base64</a></p></td><td><div><div><p>Converts a file stream into Base64 and converts a Base64 string into a file stream. Uses a PDF file as the input and output.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-java-methods">Call Java Methods with DataWeave</a></p></td><td><div><div><p>Calls Java methods from a Java class in a Mule project.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-flat-file-read-and-write">Read and Write a Flat File</a></p></td><td><div><div><p>Use DataWeave to read and write flat files in a Mule application.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-reader-prop-connector">Use a Reader Property through a Connector</a></p></td><td><div><div><p>Use a reader property through a Connector operation.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-writer-prop-mule">Use Dynamic Writer Properties</a></p></td><td><div><div><p>Use a Mule variable as a configuration value.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-pluck">Extract Key/Value Pairs with Pluck Function</a></p></td><td><div><div><p>Use the DataWeave <code>pluck</code> function to extract key-value pairs from a JSON payload and store them into Mule event variables.</p></div></div></td></tr></tbody></table>

## See Also

- [DataWeave Language](https://docs.mulesoft.com/dataweave/2.12/)

- [DataWeave Scripts](https://docs.mulesoft.com/dataweave/2.12/dataweave-language-introduction)

- [DataWeave Reference](https://docs.mulesoft.com/dataweave/2.12/dw-functions)

<!-- document id=fdaf4aaf9fb86ea9657ee8a5c1427deb77e0cd951d9fcf87b7f7a36bb62a160f url=/mulesoft/current/en-us/dataweave/2.3/dataweave-cookbook.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, examples
---

# DataWeave Examples

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The examples demonstrate common data extraction and transformation approaches.

<table><colgroup><col> <col></colgroup><thead><tr><th>Example</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-extract-data">Extract Data</a></p></td><td><div><div><p>Shows common selector expressions for extracting values from a data source, such as a Mule message.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-select-xml-elements">Select XML Elements</a></p></td><td><div><div><p>Uses a single-value DataWeave selector (<code>.</code>) to extract data from XML elements.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-defaults">Set a Default Value</a></p></td><td><div><div><p>Shows some common ways to set default values.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-set-reader-writer-props">Set Reader and Writer Configuration Properties</a></p></td><td><div><div><p>Shows how to use and change the settings for reading and writing data formats, such as <code>application/csv</code>.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-perform-basic-transformation">Transform XML to JSON</a></p></td><td><div><div><p>Uses selectors to perform a basic format transformation. It does not use any functions.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-change-script-output-mime">Change a Script’s Output Mime Type</a></p></td><td><div><div><p>Shows how to customize the MIME type of a given format output, including an example of a JSON output with <code>application/problem+json</code> MIME type.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-map">Map Data</a></p></td><td><div><div><p>Uses <code>map</code> to reorganize fields in a JSON array. It uses <code>as</code> to coerce a String into a Number.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-map-and-flatten">Map and Flatten an Array</a></p></td><td><div><div><p>Uses <code>flatMap</code> to map objects in an array and flatten the resulting array.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-map-an-object">Map Objects</a></p></td><td><div><div><p>Uses <code>mapObject</code> to go through the keys and values in each object, and set all the keys to upper case.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-map-an-object-key">Map Objects Key</a></p></td><td><div><div><p>Uses the <code>mapObject</code> function to iterate through an array of objects and appends a new object that matches the value of the specified criteria.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-map-object-elements-as-an-array">Map the Objects within an Array</a></p></td><td><div><div><p>Uses the multi-value selector to pick out the keys in an object that are named "book", these are returned as an array. It then uses <code>map</code> to iterate through the array this creates.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-map-based-on-an-external-definition">Dynamic Map Based on a Definition</a></p></td><td><div><div><p>Transforms the payload according to definitions sent in a variable. It defines a function that applies the logic defined in the variable, using <code>map</code> and <code>default</code>.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-xlsx-lookup">Look Up Data in an Excel (XLSX) File</a></p></td><td><div><div><p>Uses <code>filter</code> to return rows that contain a specified value.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-csv-lookup">Look Up Data in CSV File</a></p></td><td><div><div><p>Uses <code>filter</code> with <code>map</code> to look up data in a CSV file and return a country code for each calling code found within an input array of phone numbers.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-decode-encode">Decode and Encode Base64</a></p></td><td><div><div><p>Converts a file stream into Base64 and converts a Base64 string into a file stream. Uses a PDF file as the input and output.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-java-methods">Call Java Methods with DataWeave</a></p></td><td><div><div><p>Calls Java methods from a Java class in a Mule project.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-rename-keys">Rename Keys</a></p></td><td><div><div><p>Renames some keys in a JSON object while retaining the names of all other keys in the output. Uses <code>mapObject</code>, <code>if</code>, <code>as</code>, and <code>and</code>.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-output-a-field-when-present">Output a Field When Present</a></p></td><td><div><div><p>Uses <code>if</code> with <code>map</code> to determine whether to include a field in the output. You might use it to exclude fields that contain sensitive data.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-format-according-to-type">Format According to Type</a></p></td><td><div><div><p>Uses <code>mapObject</code> to apply changes to the keys in an object, depending on the type of their corresponding values. Uses <code>camelize</code>, <code>capitalize</code>, and <code>pluralize</code> depending on the <code>if</code> and <code>else if</code> statement.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-regroup-fields">Regroup Fields</a></p></td><td><div><div><p>Uses <code>groupBy</code>, <code>mapObject</code>, and <code>map</code> to reorganize JSON and XML fields.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-zip-arrays-together">Zip Arrays Together</a></p></td><td><div><div><p>Uses <code>zip</code> to rearrange pairs of similar arrays so that they form a series of touples with the matching values from each.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-pick-top-elements">Pick Top Elements</a></p></td><td><div><div><p>Uses <code>groupBy</code> and <code>map</code> to sort a list of candidates according to their score at a test, then it splits the array to select only the top candidates.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-change-value-of-a-field">Change the Value of a Field</a></p></td><td><div><div><p>Masks sensitive data by changing values of some keys to asterisks (<code>****`</code>). Uses <code>mapObject</code>, <code>if</code>, and <code>else</code>.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-exclude-field">Exclude Fields from the Output</a></p></td><td><div><div><p>Shows how to exclude unwanted elements from the output. Uses the <code>-</code> (remove) and <code>mapObject</code> functions.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-use-constant-directives">Use Constant Directives</a></p></td><td><div><div><p>Defines a series of constant strings and numbers in the header, these are used to filter input and to concatenate into URLs. Uses <code>map</code>, <code>if</code> and <code>++</code> to concatenate strings.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-define-a-custom-addition-function">Define a Custom Addition Function</a></p></td><td><div><div><p>Defines a function that obtains totals and subtotals through the <code>accumulator</code> function. Also performs additions, subtractions, and multiplications of numeric values.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-define-function-to-flatten-list">Define a Function That Flattens Data in a List</a></p></td><td><div><div><p>Uses <code>reduce</code>, <code>map</code>, <code>if</code>, and <code>splitBy</code> to modify and conditionally output fields from a list.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-flatten-arrays">Flatten Elements of Arrays</a></p></td><td><div><div><p>Uses <code>flatten</code>, the object constructor braces (<code>{}</code>), and selectors to flatten subarrays and nested elements in arrays. Uses concatenation (<code>++</code>) to combine arrays before flattening them and uses the <code>..*</code> descendants selector on a key to select values from a flattened list.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-use-regex">Use Regular Expressions</a></p></td><td><div><div><p>Shows uses of regular expressions in arguments to several DataWeave functions.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-output-self-closing-xml-tags">Output Self-closing XML Tags</a></p></td><td><div><div><p>Uses <code>inlineCloseOn="empty"</code> to close empty tags (for example, <code>&lt;element2/&gt;</code>).</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-insert-attribute">Insert an Attribute into an XML Tag</a></p></td><td><div><div><p>Uses the <code>@(key:value)</code> syntax to create an XML attribute.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-remove-certain-xml-attributes">Remove Specified XML Attributes</a></p></td><td><div><div><p>Defines a function that recursively checks an element and all of its children for a specific XML attribute and removes it with <code>-</code>. It also uses <code>mapObject</code>, <code>if</code> and <code>is</code> (to match types).</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-pass-xml-attributes">Pass XML Attributes</a></p></td><td><div><div><p>Pass XML attributes from the input source payload to the output XML. It uses the dynamic attribute expression <code>@dynamicAttributes</code> to create the attributes of the new output tag by selecting the attributes dynamically from the input.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-include-xml-namespaces">Include XML Namespaces</a></p></td><td><div><div><p>Defines multiple XML namespaces and references these in each tag.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-remove-objects">Remove Objects Containing Specified Key-Value Pairs</a></p></td><td><div><div><p>Removes all objects that contain a set of key-value pairs from an array of objects. Uses <code>filter</code> with <code>contains</code> and a <code>not</code> operator.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-reference-multiple-inputs">Reference Multiple Inputs</a></p></td><td><div><div><p>References data on the payload, a message attribute and a variable. It then processes these through <code>map</code>, <code>filter</code> and multiplications.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-merge-multiple-payloads">Merge Fields from Separate Objects</a></p></td><td><div><div><p>Reference data that arrives in multiple separate payloads from one single Mule event. Filters the output based on a unique identifier. Uses <code>map</code>, <code>using</code>, <code>as</code>, and <code>filter</code> functions.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-parse-dates">Parse Dates</a></p></td><td><div><div><p>Defines a function that normalizes conflicting date formats into a single, common format. Uses <code>mapObject</code>, <code>replace</code> and <code>as</code> to coerce a data type.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-add-and-subtract-time">Add and Subtract Dates</a></p></td><td><div><div><p>Performs multiple math operations combining different types related to date and time.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-change-time-zone">Change a Time Zone</a></p></td><td><div><div><p>Uses <code>&gt;&gt;</code> with a time zone ID to change a time zone and provides a list of available time zone IDs.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-format-dates">Format Dates and Times</a></p></td><td><div><div><p>Uses formatting characters such as <code>uuuu/MM/dd</code> to change the format of dates and times. Creates a date-time format using a custom DataWeave type.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-work-with-multipart-data">Work with Multipart Data</a></p></td><td><div><div><p>Uses <code>mapObject</code> to iterate over a multipart payload and extract data from each part. It also uses <code>read</code> with a <code>boundary</code> value to read the multipart content.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-conditional-list-reduction-via-function">Conditionally Reduce a List through a Function</a></p></td><td><div><div><p>Defines a function that reduces a list of elements into one field. It then calls this function only when a certain field has values. Uses <code>map</code>, <code>reduce</code>, <code>splitBy</code>, <code>if</code> and <code>++</code> to append to an array.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-pass-functions-as-arguments">Pass Functions as Arguments</a></p></td><td><div><div><p>Defines a function that expects to receive two inputs: a function to apply and an element to apply it on. The function is also recursively applied to the element’s children. It uses <code>mapObject</code> <code>lower</code> <code>is</code> <code>if/else</code>.</p></div></div></td></tr></tbody></table>

## See Also

- [DataWeave Language](https://docs.mulesoft.com/dataweave/2.3/)

- [DataWeave Scripts](https://docs.mulesoft.com/dataweave/2.3/dataweave-language-introduction)

- [DataWeave Reference](https://docs.mulesoft.com/dataweave/2.3/dw-functions)

<!-- document id=581bddfed457e012af59fcc5d73aafaebf9ce62ae4e80cfc995264cecd53b5c1 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, examples
---

# DataWeave Examples

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following DataWeave examples demonstrate common data extraction and transformation approaches.
There are DataWeave code examples of how to transform data, and also examples of Mule applications
that implement DataWeave transformations.

## DataWeave Code Examples

These examples show how to use standalone DataWeave to extract and transform data.

<table><colgroup><col> <col></colgroup><thead><tr><th>Example</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-extract-data">Extract Data</a></p></td><td><div><div><p>Shows common selector expressions for extracting values from a data source, such as a Mule message.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-select-xml-elements">Select XML Elements</a></p></td><td><div><div><p>Uses a single-value DataWeave selector (<code>.</code>) to extract data from XML elements.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-defaults">Set a Default Value</a></p></td><td><div><div><p>Shows some common ways to set default values.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-set-reader-writer-props">Set Reader and Writer Configuration Properties</a></p></td><td><div><div><p>Shows how to use and change the settings for reading and writing data formats, such as <code>application/csv</code>.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-perform-basic-transformation">Transform XML to JSON</a></p></td><td><div><div><p>Uses selectors to perform a basic format transformation. It does not use any functions.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-map">Map Data</a></p></td><td><div><div><p>Uses <code>map</code> to reorganize fields in a JSON array. It uses <code>as</code> to coerce a String into a Number.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-map-and-flatten">Map and Flatten an Array</a></p></td><td><div><div><p>Uses <code>flatMap</code> to map objects in an array and flatten the resulting array.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-map-an-object">Map Objects</a></p></td><td><div><div><p>Uses <code>mapObject</code> to go through the keys and values in each object, and set all the keys to upper case.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-map-an-object-key">Map Objects Key</a></p></td><td><div><div><p>Uses the <code>mapObject</code> function to iterate through an array of objects and appends a new object that matches the value of the specified criteria.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-map-object-elements-as-an-array">Map the Objects within an Array</a></p></td><td><div><div><p>Uses the multi-value selector to pick out the keys in an object that are named "book", these are returned as an array. It then uses <code>map</code> to iterate through the array this creates.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-map-based-on-an-external-definition">Dynamic Map Based on a Definition</a></p></td><td><div><div><p>Transforms the payload according to definitions sent in a variable. It defines a function that applies the logic defined in the variable, using <code>map</code> and <code>default</code>.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-rename-keys">Rename Keys</a></p></td><td><div><div><p>Renames some keys in a JSON object while retaining the names of all other keys in the output. Uses <code>mapObject</code>, <code>if</code>, <code>as</code>, and <code>and</code>.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-output-a-field-when-present">Output a Field When Present</a></p></td><td><div><div><p>Uses <code>if</code> with <code>map</code> to determine whether to include a field in the output. You might use it to exclude fields that contain sensitive data.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-format-according-to-type">Format According to Type</a></p></td><td><div><div><p>Uses <code>mapObject</code> to apply changes to the keys in an object, depending on the type of their corresponding values. Uses <code>camelize</code>, <code>capitalize</code>, and <code>pluralize</code> depending on the <code>if</code> and <code>else if</code> statement.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-regroup-fields">Regroup Fields</a></p></td><td><div><div><p>Uses <code>groupBy</code>, <code>mapObject</code>, and <code>map</code> to reorganize JSON and XML fields.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-zip-arrays-together">Zip Arrays Together</a></p></td><td><div><div><p>Uses <code>zip</code> to rearrange pairs of similar arrays so that they form a series of tuples with the matching values from each.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-pick-top-elements">Pick Top Elements</a></p></td><td><div><div><p>Uses <code>groupBy</code> and <code>map</code> to sort a list of candidates according to their score at a test, then it splits the array to select only the top candidates.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-change-value-of-a-field">Change the Value of a Field</a></p></td><td><div><div><p>Masks sensitive data by changing values of some keys to asterisks (<code>****`</code>). Uses <code>mapObject</code>, <code>if</code>, and <code>else</code>.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-exclude-field">Exclude Fields from the Output</a></p></td><td><div><div><p>Shows how to exclude unwanted elements from the output. Uses the <code>-</code> (remove) and <code>mapObject</code> functions.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-use-constant-directives">Use Constant Directives</a></p></td><td><div><div><p>Defines a series of constant strings and numbers in the header, these are used to filter input and to concatenate into URLs. Uses <code>map</code>, <code>if</code> and <code>++</code> to concatenate strings.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-define-a-custom-addition-function">Define a Custom Addition Function</a></p></td><td><div><div><p>Defines a function that obtains totals and subtotals through the <code>accumulator</code> function. Also performs additions, subtractions, and multiplications of numeric values.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-define-function-to-flatten-list">Define a Function That Flattens Data in a List</a></p></td><td><div><div><p>Uses <code>reduce</code>, <code>map</code>, <code>if</code>, and <code>splitBy</code> to modify and conditionally output fields from a list.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-flatten-arrays">Flatten Elements of Arrays</a></p></td><td><div><div><p>Uses <code>flatten</code>, the object constructor braces (<code>{}</code>), and selectors to flatten subarrays and nested elements in arrays. Uses concatenation (<code>++</code>) to combine arrays before flattening them and uses the <code>..*</code> descendants selector on a key to select values from a flattened list.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-use-regex">Use Regular Expressions</a></p></td><td><div><div><p>Shows uses of regular expressions in arguments to several DataWeave functions.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-output-self-closing-xml-tags">Output Self-closing XML Tags</a></p></td><td><div><div><p>Uses <code>inlineCloseOn="empty"</code> to close empty tags (for example, <code>&lt;element2/&gt;</code>).</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-insert-attribute">Insert an Attribute into an XML Tag</a></p></td><td><div><div><p>Uses the <code>@(key:value)</code> syntax to create an XML attribute.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-remove-certain-xml-attributes">Remove Specified XML Attributes</a></p></td><td><div><div><p>Defines a function that recursively checks an element and all of its children for a specific XML attribute and removes it with <code>-</code>. It also uses <code>mapObject</code>, <code>if</code> and <code>is</code> (to match types).</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-pass-xml-attributes">Pass XML Attributes</a></p></td><td><div><div><p>Pass XML attributes from the input source payload to the output XML. It uses the dynamic attribute expression <code>@dynamicAttributes</code> to create the attributes of the new output tag by selecting the attributes dynamically from the input.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-include-xml-namespaces">Include XML Namespaces</a></p></td><td><div><div><p>Defines multiple XML namespaces and references these in each tag.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-remove-objects">Remove Objects Containing Specified Key-Value Pairs</a></p></td><td><div><div><p>Removes all objects that contain a set of key-value pairs from an array of objects. Uses <code>filter</code> with <code>contains</code> and a <code>not</code> operator.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-reference-multiple-inputs">Reference Multiple Inputs</a></p></td><td><div><div><p>References data on the payload, a message attribute and a variable. It then processes these through <code>map</code>, <code>filter</code> and multiplications.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-merge-multiple-payloads">Merge Fields from Separate Objects</a></p></td><td><div><div><p>Reference data that arrives in multiple separate payloads from one single Mule event. Filters the output based on a unique identifier. Uses <code>map</code>, <code>using</code>, <code>as</code>, and <code>filter</code> functions.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-parse-dates">Parse Dates</a></p></td><td><div><div><p>Defines a function that normalizes conflicting date formats into a single, common format. Uses <code>mapObject</code>, <code>replace</code> and <code>as</code> to coerce a data type.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-add-and-subtract-time">Add and Subtract Dates</a></p></td><td><div><div><p>Performs multiple math operations combining different types related to date and time.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-change-time-zone">Change a Time Zone</a></p></td><td><div><div><p>Uses <code>&gt;&gt;</code> with a time zone ID to change a time zone and provides a list of available time zone IDs.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-format-dates">Format Dates and Times</a></p></td><td><div><div><p>Uses formatting characters such as <code>uuuu/MM/dd</code> to change the format of dates and times. Creates a date-time format using a custom DataWeave type.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-work-with-multipart-data">Work with Multipart Data</a></p></td><td><div><div><p>Uses <code>mapObject</code> to iterate over a multipart payload and extract data from each part. It also uses <code>read</code> with a <code>boundary</code> value to read the multipart content.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-conditional-list-reduction-via-function">Conditionally Reduce a List through a Function</a></p></td><td><div><div><p>Defines a function that reduces a list of elements into one field. It then calls this function only when a certain field has values. Uses <code>map</code>, <code>reduce</code>, <code>splitBy</code>, <code>if</code> and <code>++</code> to append to an array.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-pass-functions-as-arguments">Pass Functions as Arguments</a></p></td><td><div><div><p>Defines a function that expects to receive two inputs: a function to apply and an element to apply it on. The function is also recursively applied to the element’s children. It uses <code>mapObject</code> <code>lower</code> <code>is</code> <code>if/else</code>.</p></div></div></td></tr></tbody></table>

## DataWeave Code in MuleSoft Applications Examples

These examples show how to use DataWeave to extract and transform data in MuleSoft applications.

<table><colgroup><col> <col></colgroup><thead><tr><th>Example</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-change-script-output-mime">Change a Script’s Output Mime Type</a></p></td><td><div><div><p>Shows how to customize the MIME type of a given format output, including an example of a JSON output with <code>application/problem+json</code> MIME type.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-xlsx-lookup">Look Up Data in an Excel (XLSX) File</a></p></td><td><div><div><p>Uses <code>filter</code> to return rows that contain a specified value.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-csv-lookup">Look Up Data in CSV File</a></p></td><td><div><div><p>Uses <code>filter</code> with <code>map</code> to look up data in a CSV file and return a country code for each calling code found within an input array of phone numbers.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-decode-encode">Decode and Encode Base64</a></p></td><td><div><div><p>Converts a file stream into Base64 and converts a Base64 string into a file stream. Uses a PDF file as the input and output.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-java-methods">Call Java Methods with DataWeave</a></p></td><td><div><div><p>Calls Java methods from a Java class in a Mule project.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-flat-file-read-and-write">Read and Write a Flat File</a></p></td><td><div><div><p>Use DataWeave to read and write flat files in a Mule application.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-reader-prop-connector">Use a Reader Property through a Connector</a></p></td><td><div><div><p>Use a reader property through a Connector operation.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-writer-prop-mule">Use Dynamic Writer Properties</a></p></td><td><div><div><p>Use a Mule variable as a configuration value.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-pluck">Extract Key/Value Pairs with Pluck Function</a></p></td><td><div><div><p>Use the DataWeave <code>pluck</code> function to extract key-value pairs from a JSON payload and store them into Mule event variables.</p></div></div></td></tr></tbody></table>

## See Also

- [DataWeave Language](https://docs.mulesoft.com/dataweave/2.4/)

- [DataWeave Scripts](https://docs.mulesoft.com/dataweave/2.4/dataweave-language-introduction)

- [DataWeave Reference](https://docs.mulesoft.com/dataweave/2.4/dw-functions)

<!-- document id=be5509ba9742762e32074a02200869fff7d79c892be098f83950237815655e19 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, examples
---

# DataWeave Examples

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following DataWeave examples demonstrate common data extraction and transformation approaches.
There are DataWeave code examples of how to transform data, and also examples of Mule applications
that implement DataWeave transformations.

## DataWeave Code Examples

These examples show how to use standalone DataWeave to extract and transform data.

<table><colgroup><col> <col></colgroup><thead><tr><th>Example</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-extract-data">Extract Data</a></p></td><td><div><div><p>Shows common selector expressions for extracting values from a data source, such as a Mule message.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-select-xml-elements">Select XML Elements</a></p></td><td><div><div><p>Uses a single-value DataWeave selector (<code>.</code>) to extract data from XML elements.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-defaults">Set a Default Value</a></p></td><td><div><div><p>Shows some common ways to set default values.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-set-reader-writer-props">Set Reader and Writer Configuration Properties</a></p></td><td><div><div><p>Shows how to use and change the settings for reading and writing data formats, such as <code>application/csv</code>.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-perform-basic-transformation">Transform XML to JSON</a></p></td><td><div><div><p>Uses selectors to perform a basic format transformation. It does not use any functions.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-map">Map Data</a></p></td><td><div><div><p>Uses <code>map</code> to reorganize fields in a JSON array. It uses <code>as</code> to coerce a String into a Number.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-map-and-flatten">Map and Flatten an Array</a></p></td><td><div><div><p>Uses <code>flatMap</code> to map objects in an array and flatten the resulting array.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-map-an-object">Map Objects</a></p></td><td><div><div><p>Uses <code>mapObject</code> to go through the keys and values in each object, and set all the keys to upper case.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-map-an-object-key">Map Objects Key</a></p></td><td><div><div><p>Uses the <code>mapObject</code> function to iterate through an array of objects and appends a new object that matches the value of the specified criteria.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-map-object-elements-as-an-array">Map the Objects within an Array</a></p></td><td><div><div><p>Uses the multi-value selector to pick out the keys in an object that are named "book", these are returned as an array. It then uses <code>map</code> to iterate through the array this creates.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-map-based-on-an-external-definition">Dynamic Map Based on a Definition</a></p></td><td><div><div><p>Transforms the payload according to definitions sent in a variable. It defines a function that applies the logic defined in the variable, using <code>map</code> and <code>default</code>.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-rename-keys">Rename Keys</a></p></td><td><div><div><p>Renames some keys in a JSON object while retaining the names of all other keys in the output. Uses <code>mapObject</code>, <code>if</code>, <code>as</code>, and <code>and</code>.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-output-a-field-when-present">Output a Field When Present</a></p></td><td><div><div><p>Uses <code>if</code> with <code>map</code> to determine whether to include a field in the output. You might use it to exclude fields that contain sensitive data.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-format-according-to-type">Format According to Type</a></p></td><td><div><div><p>Uses <code>mapObject</code> to apply changes to the keys in an object, depending on the type of their corresponding values. Uses <code>camelize</code>, <code>capitalize</code>, and <code>pluralize</code> depending on the <code>if</code> and <code>else if</code> statement.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-regroup-fields">Regroup Fields</a></p></td><td><div><div><p>Uses <code>groupBy</code>, <code>mapObject</code>, and <code>map</code> to reorganize JSON and XML fields.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-zip-arrays-together">Zip Arrays Together</a></p></td><td><div><div><p>Uses <code>zip</code> to rearrange pairs of similar arrays so that they form a series of tuples with the matching values from each.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-pick-top-elements">Pick Top Elements</a></p></td><td><div><div><p>Uses <code>groupBy</code> and <code>map</code> to sort a list of candidates according to their score at a test, then it splits the array to select only the top candidates.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-change-value-of-a-field">Change the Value of a Field</a></p></td><td><div><div><p>Masks sensitive data by changing values of some keys to asterisks (<code>****`</code>). Uses <code>mapObject</code>, <code>if</code>, and <code>else</code>.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-exclude-field">Exclude Fields from the Output</a></p></td><td><div><div><p>Shows how to exclude unwanted elements from the output. Uses the <code>-</code> (remove) and <code>mapObject</code> functions.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-use-constant-directives">Use Constant Directives</a></p></td><td><div><div><p>Defines a series of constant strings and numbers in the header, these are used to filter input and to concatenate into URLs. Uses <code>map</code>, <code>if</code> and <code>++</code> to concatenate strings.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-define-a-custom-addition-function">Define a Custom Addition Function</a></p></td><td><div><div><p>Defines a function that obtains totals and subtotals through the <code>accumulator</code> function. Also performs additions, subtractions, and multiplications of numeric values.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-define-function-to-flatten-list">Define a Function That Flattens Data in a List</a></p></td><td><div><div><p>Uses <code>reduce</code>, <code>map</code>, <code>if</code>, and <code>splitBy</code> to modify and conditionally output fields from a list.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-flatten-arrays">Flatten Elements of Arrays</a></p></td><td><div><div><p>Uses <code>flatten</code>, the object constructor braces (<code>{}</code>), and selectors to flatten subarrays and nested elements in arrays. Uses concatenation (<code>++</code>) to combine arrays before flattening them and uses the <code>..*</code> descendants selector on a key to select values from a flattened list.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-use-regex">Use Regular Expressions</a></p></td><td><div><div><p>Shows uses of regular expressions in arguments to several DataWeave functions.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-output-self-closing-xml-tags">Output Self-closing XML Tags</a></p></td><td><div><div><p>Uses <code>inlineCloseOn="empty"</code> to close empty tags (for example, <code>&lt;element2/&gt;</code>).</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-insert-attribute">Insert an Attribute into an XML Tag</a></p></td><td><div><div><p>Uses the <code>@(key:value)</code> syntax to create an XML attribute.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-remove-certain-xml-attributes">Remove Specified XML Attributes</a></p></td><td><div><div><p>Defines a function that recursively checks an element and all of its children for a specific XML attribute and removes it with <code>-</code>. It also uses <code>mapObject</code>, <code>if</code> and <code>is</code> (to match types).</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-pass-xml-attributes">Pass XML Attributes</a></p></td><td><div><div><p>Pass XML attributes from the input source payload to the output XML. It uses the dynamic attribute expression <code>@dynamicAttributes</code> to create the attributes of the new output tag by selecting the attributes dynamically from the input.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-include-xml-namespaces">Include XML Namespaces</a></p></td><td><div><div><p>Defines multiple XML namespaces and references these in each tag.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-remove-objects">Remove Objects Containing Specified Key-Value Pairs</a></p></td><td><div><div><p>Removes all objects that contain a set of key-value pairs from an array of objects. Uses <code>filter</code> with <code>contains</code> and a <code>not</code> operator.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-reference-multiple-inputs">Reference Multiple Inputs</a></p></td><td><div><div><p>References data on the payload, a message attribute and a variable. It then processes these through <code>map</code>, <code>filter</code> and multiplications.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-merge-multiple-payloads">Merge Fields from Separate Objects</a></p></td><td><div><div><p>Reference data that arrives in multiple separate payloads from one single Mule event. Filters the output based on a unique identifier. Uses <code>map</code>, <code>using</code>, <code>as</code>, and <code>filter</code> functions.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-parse-dates">Parse Dates</a></p></td><td><div><div><p>Defines a function that normalizes conflicting date formats into a single, common format. Uses <code>mapObject</code>, <code>replace</code> and <code>as</code> to coerce a data type.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-add-and-subtract-time">Add and Subtract Dates</a></p></td><td><div><div><p>Performs multiple math operations combining different types related to date and time.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-change-time-zone">Change a Time Zone</a></p></td><td><div><div><p>Uses <code>&gt;&gt;</code> with a time zone ID to change a time zone and provides a list of available time zone IDs.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-format-dates">Format Dates and Times</a></p></td><td><div><div><p>Uses formatting characters such as <code>uuuu/MM/dd</code> to change the format of dates and times. Creates a date-time format using a custom DataWeave type.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-work-with-multipart-data">Work with Multipart Data</a></p></td><td><div><div><p>Uses <code>mapObject</code> to iterate over a multipart payload and extract data from each part. It also uses <code>read</code> with a <code>boundary</code> value to read the multipart content.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-conditional-list-reduction-via-function">Conditionally Reduce a List through a Function</a></p></td><td><div><div><p>Defines a function that reduces a list of elements into one field. It then calls this function only when a certain field has values. Uses <code>map</code>, <code>reduce</code>, <code>splitBy</code>, <code>if</code> and <code>++</code> to append to an array.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-pass-functions-as-arguments">Pass Functions as Arguments</a></p></td><td><div><div><p>Defines a function that expects to receive two inputs: a function to apply and an element to apply it on. The function is also recursively applied to the element’s children. It uses <code>mapObject</code> <code>lower</code> <code>is</code> <code>if/else</code>.</p></div></div></td></tr></tbody></table>

## DataWeave Code in MuleSoft Applications Examples

These examples show how to use DataWeave to extract and transform data in MuleSoft applications.

<table><colgroup><col> <col></colgroup><thead><tr><th>Example</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-change-script-output-mime">Change a Script’s Output Mime Type</a></p></td><td><div><div><p>Shows how to customize the MIME type of a given format output, including an example of a JSON output with <code>application/problem+json</code> MIME type.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-xlsx-lookup">Look Up Data in an Excel (XLSX) File</a></p></td><td><div><div><p>Uses <code>filter</code> to return rows that contain a specified value.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-csv-lookup">Look Up Data in CSV File</a></p></td><td><div><div><p>Uses <code>filter</code> with <code>map</code> to look up data in a CSV file and return a country code for each calling code found within an input array of phone numbers.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-decode-encode">Decode and Encode Base64</a></p></td><td><div><div><p>Converts a file stream into Base64 and converts a Base64 string into a file stream. Uses a PDF file as the input and output.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-java-methods">Call Java Methods with DataWeave</a></p></td><td><div><div><p>Calls Java methods from a Java class in a Mule project.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-flat-file-read-and-write">Read and Write a Flat File</a></p></td><td><div><div><p>Use DataWeave to read and write flat files in a Mule application.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-reader-prop-connector">Use a Reader Property through a Connector</a></p></td><td><div><div><p>Use a reader property through a Connector operation.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-writer-prop-mule">Use Dynamic Writer Properties</a></p></td><td><div><div><p>Use a Mule variable as a configuration value.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-pluck">Extract Key/Value Pairs with Pluck Function</a></p></td><td><div><div><p>Use the DataWeave <code>pluck</code> function to extract key-value pairs from a JSON payload and store them into Mule event variables.</p></div></div></td></tr></tbody></table>

## See Also

- [DataWeave Language](https://docs.mulesoft.com/dataweave/2.6/)

- [DataWeave Scripts](https://docs.mulesoft.com/dataweave/2.6/dataweave-language-introduction)

- [DataWeave Reference](https://docs.mulesoft.com/dataweave/2.6/dw-functions)

<!-- document id=06a97dcc3495e36d89ed397830606372fd25ad4970da7f680b61ca218eed76b7 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, examples
---

# DataWeave Examples

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following DataWeave examples demonstrate common data extraction and transformation approaches.
There are DataWeave code examples of how to transform data, and also examples of Mule applications
that implement DataWeave transformations.

## DataWeave Code Examples

These examples show how to use standalone DataWeave to extract and transform data.

<table><colgroup><col> <col></colgroup><thead><tr><th>Example</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-extract-data">Extract Data</a></p></td><td><div><div><p>Shows common selector expressions for extracting values from a data source, such as a Mule message.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-select-xml-elements">Select XML Elements</a></p></td><td><div><div><p>Uses a single-value DataWeave selector (<code>.</code>) to extract data from XML elements.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-defaults">Set a Default Value</a></p></td><td><div><div><p>Shows some common ways to set default values.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-set-reader-writer-props">Set Reader and Writer Configuration Properties</a></p></td><td><div><div><p>Shows how to use and change the settings for reading and writing data formats, such as <code>application/csv</code>.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-perform-basic-transformation">Transform XML to JSON</a></p></td><td><div><div><p>Uses selectors to perform a basic format transformation. It does not use any functions.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-map">Map Data</a></p></td><td><div><div><p>Uses <code>map</code> to reorganize fields in a JSON array. It uses <code>as</code> to coerce a String into a Number.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-map-and-flatten">Map and Flatten an Array</a></p></td><td><div><div><p>Uses <code>flatMap</code> to map objects in an array and flatten the resulting array.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-map-an-object">Map Objects</a></p></td><td><div><div><p>Uses <code>mapObject</code> to go through the keys and values in each object, and set all the keys to upper case.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-map-an-object-key">Map Objects Key</a></p></td><td><div><div><p>Uses the <code>mapObject</code> function to iterate through an array of objects and appends a new object that matches the value of the specified criteria.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-map-object-elements-as-an-array">Map the Objects within an Array</a></p></td><td><div><div><p>Uses the multi-value selector to pick out the keys in an object that are named "book", these are returned as an array. It then uses <code>map</code> to iterate through the array this creates.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-map-based-on-an-external-definition">Dynamic Map Based on a Definition</a></p></td><td><div><div><p>Transforms the payload according to definitions sent in a variable. It defines a function that applies the logic defined in the variable, using <code>map</code> and <code>default</code>.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-rename-keys">Rename Keys</a></p></td><td><div><div><p>Renames some keys in a JSON object while retaining the names of all other keys in the output. Uses <code>mapObject</code>, <code>if</code>, <code>as</code>, and <code>and</code>.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-output-a-field-when-present">Output a Field When Present</a></p></td><td><div><div><p>Uses <code>if</code> with <code>map</code> to determine whether to include a field in the output. You might use it to exclude fields that contain sensitive data.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-format-according-to-type">Format According to Type</a></p></td><td><div><div><p>Uses <code>mapObject</code> to apply changes to the keys in an object, depending on the type of their corresponding values. Uses <code>camelize</code>, <code>capitalize</code>, and <code>pluralize</code> depending on the <code>if</code> and <code>else if</code> statement.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-regroup-fields">Regroup Fields</a></p></td><td><div><div><p>Uses <code>groupBy</code>, <code>mapObject</code>, and <code>map</code> to reorganize JSON and XML fields.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-zip-arrays-together">Zip Arrays Together</a></p></td><td><div><div><p>Uses <code>zip</code> to rearrange pairs of similar arrays so that they form a series of tuples with the matching values from each.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-pick-top-elements">Pick Top Elements</a></p></td><td><div><div><p>Uses <code>groupBy</code> and <code>map</code> to sort a list of candidates according to their score at a test, then it splits the array to select only the top candidates.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-change-value-of-a-field">Change the Value of a Field</a></p></td><td><div><div><p>Masks sensitive data by changing values of some keys to asterisks (<code>****`</code>). Uses <code>mapObject</code>, <code>if</code>, and <code>else</code>.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-exclude-field">Exclude Fields from the Output</a></p></td><td><div><div><p>Shows how to exclude unwanted elements from the output. Uses the <code>-</code> (remove) and <code>mapObject</code> functions.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-use-constant-directives">Use Constant Directives</a></p></td><td><div><div><p>Defines a series of constant strings and numbers in the header, these are used to filter input and to concatenate into URLs. Uses <code>map</code>, <code>if</code> and <code>++</code> to concatenate strings.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-define-a-custom-addition-function">Define a Custom Addition Function</a></p></td><td><div><div><p>Defines a function that obtains totals and subtotals through the <code>accumulator</code> function. Also performs additions, subtractions, and multiplications of numeric values.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-define-function-to-flatten-list">Define a Function That Flattens Data in a List</a></p></td><td><div><div><p>Uses <code>reduce</code>, <code>map</code>, <code>if</code>, and <code>splitBy</code> to modify and conditionally output fields from a list.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-flatten-arrays">Flatten Elements of Arrays</a></p></td><td><div><div><p>Uses <code>flatten</code>, the object constructor braces (<code>{}</code>), and selectors to flatten subarrays and nested elements in arrays. Uses concatenation (<code>++</code>) to combine arrays before flattening them and uses the <code>..*</code> descendants selector on a key to select values from a flattened list.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-use-regex">Use Regular Expressions</a></p></td><td><div><div><p>Shows uses of regular expressions in arguments to several DataWeave functions.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-output-self-closing-xml-tags">Output Self-closing XML Tags</a></p></td><td><div><div><p>Uses <code>inlineCloseOn="empty"</code> to close empty tags (for example, <code>&lt;element2/&gt;</code>).</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-insert-attribute">Insert an Attribute into an XML Tag</a></p></td><td><div><div><p>Uses the <code>@(key:value)</code> syntax to create an XML attribute.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-remove-certain-xml-attributes">Remove Specified XML Attributes</a></p></td><td><div><div><p>Defines a function that recursively checks an element and all of its children for a specific XML attribute and removes it with <code>-</code>. It also uses <code>mapObject</code>, <code>if</code> and <code>is</code> (to match types).</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-pass-xml-attributes">Pass XML Attributes</a></p></td><td><div><div><p>Pass XML attributes from the input source payload to the output XML. It uses the dynamic attribute expression <code>@dynamicAttributes</code> to create the attributes of the new output tag by selecting the attributes dynamically from the input.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-include-xml-namespaces">Include XML Namespaces</a></p></td><td><div><div><p>Defines multiple XML namespaces and references these in each tag.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-remove-objects">Remove Objects Containing Specified Key-Value Pairs</a></p></td><td><div><div><p>Removes all objects that contain a set of key-value pairs from an array of objects. Uses <code>filter</code> with <code>contains</code> and a <code>not</code> operator.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-reference-multiple-inputs">Reference Multiple Inputs</a></p></td><td><div><div><p>References data on the payload, a message attribute and a variable. It then processes these through <code>map</code>, <code>filter</code> and multiplications.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-merge-multiple-payloads">Merge Fields from Separate Objects</a></p></td><td><div><div><p>Reference data that arrives in multiple separate payloads from one single Mule event. Filters the output based on a unique identifier. Uses <code>map</code>, <code>using</code>, <code>as</code>, and <code>filter</code> functions.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-parse-dates">Parse Dates</a></p></td><td><div><div><p>Defines a function that normalizes conflicting date formats into a single, common format. Uses <code>mapObject</code>, <code>replace</code> and <code>as</code> to coerce a data type.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-add-and-subtract-time">Add and Subtract Dates</a></p></td><td><div><div><p>Performs multiple math operations combining different types related to date and time.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-change-time-zone">Change a Time Zone</a></p></td><td><div><div><p>Uses <code>&gt;&gt;</code> with a time zone ID to change a time zone and provides a list of available time zone IDs.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-format-dates">Format Dates and Times</a></p></td><td><div><div><p>Uses formatting characters such as <code>uuuu/MM/dd</code> to change the format of dates and times. Creates a date-time format using a custom DataWeave type.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-work-with-multipart-data">Work with Multipart Data</a></p></td><td><div><div><p>Uses <code>mapObject</code> to iterate over a multipart payload and extract data from each part. It also uses <code>read</code> with a <code>boundary</code> value to read the multipart content.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-conditional-list-reduction-via-function">Conditionally Reduce a List through a Function</a></p></td><td><div><div><p>Defines a function that reduces a list of elements into one field. It then calls this function only when a certain field has values. Uses <code>map</code>, <code>reduce</code>, <code>splitBy</code>, <code>if</code> and <code>++</code> to append to an array.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-pass-functions-as-arguments">Pass Functions as Arguments</a></p></td><td><div><div><p>Defines a function that expects to receive two inputs: a function to apply and an element to apply it on. The function is also recursively applied to the element’s children. It uses <code>mapObject</code> <code>lower</code> <code>is</code> <code>if/else</code>.</p></div></div></td></tr></tbody></table>

## DataWeave Code in MuleSoft Applications Examples

These examples show how to use DataWeave to extract and transform data in MuleSoft applications.

<table><colgroup><col> <col></colgroup><thead><tr><th>Example</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-change-script-output-mime">Change a Script’s Output Mime Type</a></p></td><td><div><div><p>Shows how to customize the MIME type of a given format output, including an example of a JSON output with <code>application/problem+json</code> MIME type.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-xlsx-lookup">Look Up Data in an Excel (XLSX) File</a></p></td><td><div><div><p>Uses <code>filter</code> to return rows that contain a specified value.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-csv-lookup">Look Up Data in CSV File</a></p></td><td><div><div><p>Uses <code>filter</code> with <code>map</code> to look up data in a CSV file and return a country code for each calling code found within an input array of phone numbers.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-decode-encode">Decode and Encode Base64</a></p></td><td><div><div><p>Converts a file stream into Base64 and converts a Base64 string into a file stream. Uses a PDF file as the input and output.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-java-methods">Call Java Methods with DataWeave</a></p></td><td><div><div><p>Calls Java methods from a Java class in a Mule project.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-flat-file-read-and-write">Read and Write a Flat File</a></p></td><td><div><div><p>Use DataWeave to read and write flat files in a Mule application.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-reader-prop-connector">Use a Reader Property through a Connector</a></p></td><td><div><div><p>Use a reader property through a Connector operation.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-writer-prop-mule">Use Dynamic Writer Properties</a></p></td><td><div><div><p>Use a Mule variable as a configuration value.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-pluck">Extract Key/Value Pairs with Pluck Function</a></p></td><td><div><div><p>Use the DataWeave <code>pluck</code> function to extract key-value pairs from a JSON payload and store them into Mule event variables.</p></div></div></td></tr></tbody></table>

## See Also

- [DataWeave Language](https://docs.mulesoft.com/dataweave/2.9/)

- [DataWeave Scripts](https://docs.mulesoft.com/dataweave/2.9/dataweave-language-introduction)

- [DataWeave Reference](https://docs.mulesoft.com/dataweave/2.9/dw-functions)

<!-- document id=cb58b869184eb0de2a8c3f6364a88638e3ef5b80450f3980aeb3b0f418a62b6e url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, examples
---

# DataWeave Examples

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following DataWeave examples demonstrate common data extraction and transformation approaches.
There are DataWeave code examples of how to transform data, and also examples of Mule applications
that implement DataWeave transformations.

## DataWeave Code Examples

These examples show how to use standalone DataWeave to extract and transform data.

<table><colgroup><col> <col></colgroup><thead><tr><th>Example</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-extract-data">Extract Data</a></p></td><td><div><div><p>Shows common selector expressions for extracting values from a data source, such as a Mule message.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-select-xml-elements">Select XML Elements</a></p></td><td><div><div><p>Uses a single-value DataWeave selector (<code>.</code>) to extract data from XML elements.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-defaults">Set a Default Value</a></p></td><td><div><div><p>Shows some common ways to set default values.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-set-reader-writer-props">Set Reader and Writer Configuration Properties</a></p></td><td><div><div><p>Shows how to use and change the settings for reading and writing data formats, such as <code>application/csv</code>.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-perform-basic-transformation">Transform XML to JSON</a></p></td><td><div><div><p>Uses selectors to perform a basic format transformation. It does not use any functions.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-map">Map Data</a></p></td><td><div><div><p>Uses <code>map</code> to reorganize fields in a JSON array. It uses <code>as</code> to coerce a String into a Number.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-map-and-flatten">Map and Flatten an Array</a></p></td><td><div><div><p>Uses <code>flatMap</code> to map objects in an array and flatten the resulting array.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-map-an-object">Map Objects</a></p></td><td><div><div><p>Uses <code>mapObject</code> to go through the keys and values in each object, and set all the keys to upper case.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-map-an-object-key">Map Objects Key</a></p></td><td><div><div><p>Uses the <code>mapObject</code> function to iterate through an array of objects and appends a new object that matches the value of the specified criteria.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-map-object-elements-as-an-array">Map the Objects within an Array</a></p></td><td><div><div><p>Uses the multi-value selector to pick out the keys in an object that are named "book", these are returned as an array. It then uses <code>map</code> to iterate through the array this creates.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-map-based-on-an-external-definition">Dynamic Map Based on a Definition</a></p></td><td><div><div><p>Transforms the payload according to definitions sent in a variable. It defines a function that applies the logic defined in the variable, using <code>map</code> and <code>default</code>.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-rename-keys">Rename Keys</a></p></td><td><div><div><p>Renames some keys in a JSON object while retaining the names of all other keys in the output. Uses <code>mapObject</code>, <code>if</code>, <code>as</code>, and <code>and</code>.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-output-a-field-when-present">Output a Field When Present</a></p></td><td><div><div><p>Uses <code>if</code> with <code>map</code> to determine whether to include a field in the output. You might use it to exclude fields that contain sensitive data.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-format-according-to-type">Format According to Type</a></p></td><td><div><div><p>Uses <code>mapObject</code> to apply changes to the keys in an object, depending on the type of their corresponding values. Uses <code>camelize</code>, <code>capitalize</code>, and <code>pluralize</code> depending on the <code>if</code> and <code>else if</code> statement.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-regroup-fields">Regroup Fields</a></p></td><td><div><div><p>Uses <code>groupBy</code>, <code>mapObject</code>, and <code>map</code> to reorganize JSON and XML fields.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-zip-arrays-together">Zip Arrays Together</a></p></td><td><div><div><p>Uses <code>zip</code> to rearrange pairs of similar arrays so that they form a series of tuples with the matching values from each.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-pick-top-elements">Pick Top Elements</a></p></td><td><div><div><p>Uses <code>groupBy</code> and <code>map</code> to sort a list of candidates according to their score at a test, then it splits the array to select only the top candidates.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-change-value-of-a-field">Change the Value of a Field</a></p></td><td><div><div><p>Masks sensitive data by changing values of some keys to asterisks (<code>****`</code>). Uses <code>mapObject</code>, <code>if</code>, and <code>else</code>.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-exclude-field">Exclude Fields from the Output</a></p></td><td><div><div><p>Shows how to exclude unwanted elements from the output. Uses the <code>-</code> (remove) and <code>mapObject</code> functions.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-use-constant-directives">Use Constant Directives</a></p></td><td><div><div><p>Defines a series of constant strings and numbers in the header, these are used to filter input and to concatenate into URLs. Uses <code>map</code>, <code>if</code> and <code>++</code> to concatenate strings.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-define-a-custom-addition-function">Define a Custom Addition Function</a></p></td><td><div><div><p>Defines a function that obtains totals and subtotals through the <code>accumulator</code> function. Also performs additions, subtractions, and multiplications of numeric values.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-define-function-to-flatten-list">Define a Function That Flattens Data in a List</a></p></td><td><div><div><p>Uses <code>reduce</code>, <code>map</code>, <code>if</code>, and <code>splitBy</code> to modify and conditionally output fields from a list.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-flatten-arrays">Flatten Elements of Arrays</a></p></td><td><div><div><p>Uses <code>flatten</code>, the object constructor braces (<code>{}</code>), and selectors to flatten subarrays and nested elements in arrays. Uses concatenation (<code>++</code>) to combine arrays before flattening them and uses the <code>..*</code> descendants selector on a key to select values from a flattened list.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-use-regex">Use Regular Expressions</a></p></td><td><div><div><p>Shows uses of regular expressions in arguments to several DataWeave functions.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-output-self-closing-xml-tags">Output Self-closing XML Tags</a></p></td><td><div><div><p>Uses <code>inlineCloseOn="empty"</code> to close empty tags (for example, <code>&lt;element2/&gt;</code>).</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-insert-attribute">Insert an Attribute into an XML Tag</a></p></td><td><div><div><p>Uses the <code>@(key:value)</code> syntax to create an XML attribute.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-remove-certain-xml-attributes">Remove Specified XML Attributes</a></p></td><td><div><div><p>Defines a function that recursively checks an element and all of its children for a specific XML attribute and removes it with <code>-</code>. It also uses <code>mapObject</code>, <code>if</code> and <code>is</code> (to match types).</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-pass-xml-attributes">Pass XML Attributes</a></p></td><td><div><div><p>Pass XML attributes from the input source payload to the output XML. It uses the dynamic attribute expression <code>@dynamicAttributes</code> to create the attributes of the new output tag by selecting the attributes dynamically from the input.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-include-xml-namespaces">Include XML Namespaces</a></p></td><td><div><div><p>Defines multiple XML namespaces and references these in each tag.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-remove-objects">Remove Objects Containing Specified Key-Value Pairs</a></p></td><td><div><div><p>Removes all objects that contain a set of key-value pairs from an array of objects. Uses <code>filter</code> with <code>contains</code> and a <code>not</code> operator.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-reference-multiple-inputs">Reference Multiple Inputs</a></p></td><td><div><div><p>References data on the payload, a message attribute and a variable. It then processes these through <code>map</code>, <code>filter</code> and multiplications.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-merge-multiple-payloads">Merge Fields from Separate Objects</a></p></td><td><div><div><p>Reference data that arrives in multiple separate payloads from one single Mule event. Filters the output based on a unique identifier. Uses <code>map</code>, <code>using</code>, <code>as</code>, and <code>filter</code> functions.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-parse-dates">Parse Dates</a></p></td><td><div><div><p>Defines a function that normalizes conflicting date formats into a single, common format. Uses <code>mapObject</code>, <code>replace</code> and <code>as</code> to coerce a data type.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-add-and-subtract-time">Add and Subtract Dates</a></p></td><td><div><div><p>Performs multiple math operations combining different types related to date and time.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-change-time-zone">Change a Time Zone</a></p></td><td><div><div><p>Uses <code>&gt;&gt;</code> with a time zone ID to change a time zone and provides a list of available time zone IDs.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-format-dates">Format Dates and Times</a></p></td><td><div><div><p>Uses formatting characters such as <code>uuuu/MM/dd</code> to change the format of dates and times. Creates a date-time format using a custom DataWeave type.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-work-with-multipart-data">Work with Multipart Data</a></p></td><td><div><div><p>Uses <code>mapObject</code> to iterate over a multipart payload and extract data from each part. It also uses <code>read</code> with a <code>boundary</code> value to read the multipart content.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-conditional-list-reduction-via-function">Conditionally Reduce a List through a Function</a></p></td><td><div><div><p>Defines a function that reduces a list of elements into one field. It then calls this function only when a certain field has values. Uses <code>map</code>, <code>reduce</code>, <code>splitBy</code>, <code>if</code> and <code>++</code> to append to an array.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-pass-functions-as-arguments">Pass Functions as Arguments</a></p></td><td><div><div><p>Defines a function that expects to receive two inputs: a function to apply and an element to apply it on. The function is also recursively applied to the element’s children. It uses <code>mapObject</code> <code>lower</code> <code>is</code> <code>if/else</code>.</p></div></div></td></tr></tbody></table>

## DataWeave Code in MuleSoft Applications Examples

These examples show how to use DataWeave to extract and transform data in MuleSoft applications.

<table><colgroup><col> <col></colgroup><thead><tr><th>Example</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-change-script-output-mime">Change a Script’s Output Mime Type</a></p></td><td><div><div><p>Shows how to customize the MIME type of a given format output, including an example of a JSON output with <code>application/problem+json</code> MIME type.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-xlsx-lookup">Look Up Data in an Excel (XLSX) File</a></p></td><td><div><div><p>Uses <code>filter</code> to return rows that contain a specified value.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-csv-lookup">Look Up Data in CSV File</a></p></td><td><div><div><p>Uses <code>filter</code> with <code>map</code> to look up data in a CSV file and return a country code for each calling code found within an input array of phone numbers.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-decode-encode">Decode and Encode Base64</a></p></td><td><div><div><p>Converts a file stream into Base64 and converts a Base64 string into a file stream. Uses a PDF file as the input and output.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-java-methods">Call Java Methods with DataWeave</a></p></td><td><div><div><p>Calls Java methods from a Java class in a Mule project.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-flat-file-read-and-write">Read and Write a Flat File</a></p></td><td><div><div><p>Use DataWeave to read and write flat files in a Mule application.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-reader-prop-connector">Use a Reader Property through a Connector</a></p></td><td><div><div><p>Use a reader property through a Connector operation.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-writer-prop-mule">Use Dynamic Writer Properties</a></p></td><td><div><div><p>Use a Mule variable as a configuration value.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-pluck">Extract Key/Value Pairs with Pluck Function</a></p></td><td><div><div><p>Use the DataWeave <code>pluck</code> function to extract key-value pairs from a JSON payload and store them into Mule event variables.</p></div></div></td></tr></tbody></table>

## See Also

- [DataWeave Language](https://docs.mulesoft.com/dataweave/latest/)

- [DataWeave Scripts](https://docs.mulesoft.com/dataweave/latest/dataweave-language-introduction)

- [DataWeave Reference](https://docs.mulesoft.com/dataweave/latest/dw-functions)

<!-- document id=97f43883721849ac502f0fe3921eccacd75b8b87f04dc4b49f943b6d85f40f1e url=/mulesoft/current/en-us/dataweave/2.11/dataweave-extension.md -->

---
product: DataWeave
version: 2.11
---

# DataWeave Extension

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave enables you to implement and test your custom DataWeave modules and mappings and package
them into libraries that you can share and reuse through Anypoint Exchange.

The [DataWeave extension to Visual Studio Code](https://docs.mulesoft.com/dataweave/2.11/dataweave-extension-plugin) enhances productivity
when you’re building DataWeave libraries. The extension provides the following capabilities:

- Ability to work on your DataWeave modules and mappings in a standalone manner, outside of a Mule
  application.

- Instant execution of your DataWeave mappings, including live preview of data transformations.

- Language support, including autocompletion, navigation, refactoring, formatting, quick fixes, and
  syntax highlighting.

- Debugging support for DataWeave mappings.

- Automatic generation of a documentation template that you can use to provide your own
  [DataWeave library documentation](https://docs.mulesoft.com/dataweave/2.11/dataweave-create-module#docs-dw-lib) in Exchange.

- An embedded [DataWeave Maven plugin](https://docs.mulesoft.com/dataweave/2.11/dataweave-maven-plugin) with the following features:

  - Integration of packaging and deployment of your DataWeave libraries with your Maven lifecycle.

  - Integration with Exchange to share and consume DataWeave libraries.

- An embedded [DataWeave testing framework](https://docs.mulesoft.com/dataweave/2.11/dataweave-testing-framework) that enables you to build
  automated unit and integration tests easily.

## See Also

[Create Custom Modules and Mappings](https://docs.mulesoft.com/dataweave/2.11/dataweave-create-module)

<!-- document id=cf451a6fbdf2ea392f6226c0c818d0020ef2f7b9af45a806c32d653b8cfccc5f url=/mulesoft/current/en-us/dataweave/2.12/dataweave-extension.md -->

---
product: DataWeave
version: 2.12
---

# DataWeave Extension

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave enables you to implement and test your custom DataWeave modules and mappings and package
them into libraries that you can share and reuse through Anypoint Exchange.

The [DataWeave extension to Visual Studio Code](https://docs.mulesoft.com/dataweave/2.12/dataweave-extension-plugin) enhances productivity
when you’re building DataWeave libraries. The extension provides the following capabilities:

- Ability to work on your DataWeave modules and mappings in a standalone manner, outside of a Mule
  application.

- Instant execution of your DataWeave mappings, including live preview of data transformations.

- Language support, including autocompletion, navigation, refactoring, formatting, quick fixes, and
  syntax highlighting.

- Debugging support for DataWeave mappings.

- Automatic generation of a documentation template that you can use to provide your own
  [DataWeave library documentation](https://docs.mulesoft.com/dataweave/2.12/dataweave-create-module#docs-dw-lib) in Exchange.

- An embedded [DataWeave Maven plugin](https://docs.mulesoft.com/dataweave/2.12/dataweave-maven-plugin) with the following features:

  - Integration of packaging and deployment of your DataWeave libraries with your Maven lifecycle.

  - Integration with Exchange to share and consume DataWeave libraries.

- An embedded [DataWeave testing framework](https://docs.mulesoft.com/dataweave/2.12/dataweave-testing-framework) that enables you to build
  automated unit and integration tests easily.

## See Also

[Create Custom Modules and Mappings](https://docs.mulesoft.com/dataweave/2.12/dataweave-create-module)

<!-- document id=f92c0bb3170d27c22ba7756b013a43c5c17096aa9d6d33872e337d47672233e9 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-extension.md -->

---
product: DataWeave
version: 2.4
---

# DataWeave Extension

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave enables you to implement and test your custom DataWeave modules and mappings and package
them into libraries that you can share and reuse through Anypoint Exchange.

The [DataWeave extension to Visual Studio Code](https://docs.mulesoft.com/dataweave/2.4/dataweave-extension-plugin) enhances productivity
when you’re building DataWeave libraries. The extension provides the following capabilities:

- Ability to work on your DataWeave modules and mappings in a standalone manner, outside of a Mule
  application.

- Instant execution of your DataWeave mappings, including live preview of data transformations.

- Language support, including autocompletion, navigation, refactoring, formatting, quick fixes, and
  syntax highlighting.

- Debugging support for DataWeave mappings.

- Automatic generation of a documentation template that you can use to provide your own
  [DataWeave library documentation](https://docs.mulesoft.com/dataweave/2.4/dataweave-create-module#docs-dw-lib) in Exchange.

- An embedded [DataWeave Maven plugin](https://docs.mulesoft.com/dataweave/2.4/dataweave-maven-plugin) with the following features:

  - Integration of packaging and deployment of your DataWeave libraries with your Maven lifecycle.

  - Integration with Exchange to share and consume DataWeave libraries.

- An embedded [DataWeave testing framework](https://docs.mulesoft.com/dataweave/2.4/dataweave-testing-framework) that enables you to build
  automated unit and integration tests easily.

## See Also

[Create Custom Modules and Mappings](https://docs.mulesoft.com/dataweave/2.4/dataweave-create-module)

<!-- document id=9f59a40260e19c1ec8e252789a3e4cd4fc50d2049ad2cf3e928d70cb9c7374d7 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-extension.md -->

---
product: DataWeave
version: 2.6
---

# DataWeave Extension

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave enables you to implement and test your custom DataWeave modules and mappings and package
them into libraries that you can share and reuse through Anypoint Exchange.

The [DataWeave extension to Visual Studio Code](https://docs.mulesoft.com/dataweave/2.6/dataweave-extension-plugin) enhances productivity
when you’re building DataWeave libraries. The extension provides the following capabilities:

- Ability to work on your DataWeave modules and mappings in a standalone manner, outside of a Mule
  application.

- Instant execution of your DataWeave mappings, including live preview of data transformations.

- Language support, including autocompletion, navigation, refactoring, formatting, quick fixes, and
  syntax highlighting.

- Debugging support for DataWeave mappings.

- Automatic generation of a documentation template that you can use to provide your own
  [DataWeave library documentation](https://docs.mulesoft.com/dataweave/2.6/dataweave-create-module#docs-dw-lib) in Exchange.

- An embedded [DataWeave Maven plugin](https://docs.mulesoft.com/dataweave/2.6/dataweave-maven-plugin) with the following features:

  - Integration of packaging and deployment of your DataWeave libraries with your Maven lifecycle.

  - Integration with Exchange to share and consume DataWeave libraries.

- An embedded [DataWeave testing framework](https://docs.mulesoft.com/dataweave/2.6/dataweave-testing-framework) that enables you to build
  automated unit and integration tests easily.

## See Also

[Create Custom Modules and Mappings](https://docs.mulesoft.com/dataweave/2.6/dataweave-create-module)

<!-- document id=a7b3a0f769ef6a793c9e86f67ca96da3cbb2e72868d01a4c47e3cfaf5fe746a8 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-extension.md -->

---
product: DataWeave
version: 2.9
---

# DataWeave Extension

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave enables you to implement and test your custom DataWeave modules and mappings and package
them into libraries that you can share and reuse through Anypoint Exchange.

The [DataWeave extension to Visual Studio Code](https://docs.mulesoft.com/dataweave/2.9/dataweave-extension-plugin) enhances productivity
when you’re building DataWeave libraries. The extension provides the following capabilities:

- Ability to work on your DataWeave modules and mappings in a standalone manner, outside of a Mule
  application.

- Instant execution of your DataWeave mappings, including live preview of data transformations.

- Language support, including autocompletion, navigation, refactoring, formatting, quick fixes, and
  syntax highlighting.

- Debugging support for DataWeave mappings.

- Automatic generation of a documentation template that you can use to provide your own
  [DataWeave library documentation](https://docs.mulesoft.com/dataweave/2.9/dataweave-create-module#docs-dw-lib) in Exchange.

- An embedded [DataWeave Maven plugin](https://docs.mulesoft.com/dataweave/2.9/dataweave-maven-plugin) with the following features:

  - Integration of packaging and deployment of your DataWeave libraries with your Maven lifecycle.

  - Integration with Exchange to share and consume DataWeave libraries.

- An embedded [DataWeave testing framework](https://docs.mulesoft.com/dataweave/2.9/dataweave-testing-framework) that enables you to build
  automated unit and integration tests easily.

## See Also

[Create Custom Modules and Mappings](https://docs.mulesoft.com/dataweave/2.9/dataweave-create-module)

<!-- document id=2b4441bcb6b5dd588b11aef86ffb240f40e80ff145ce706f07f9848ee4267eb6 url=/mulesoft/current/en-us/dataweave/latest/dataweave-extension.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# DataWeave Extension

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave enables you to implement and test your custom DataWeave modules and mappings and package
them into libraries that you can share and reuse through Anypoint Exchange.

The [DataWeave extension to Visual Studio Code](https://docs.mulesoft.com/dataweave/latest/dataweave-extension-plugin) enhances productivity
when you’re building DataWeave libraries. The extension provides the following capabilities:

- Ability to work on your DataWeave modules and mappings in a standalone manner, outside of a Mule
  application.

- Instant execution of your DataWeave mappings, including live preview of data transformations.

- Language support, including autocompletion, navigation, refactoring, formatting, quick fixes, and
  syntax highlighting.

- Debugging support for DataWeave mappings.

- Automatic generation of a documentation template that you can use to provide your own
  [DataWeave library documentation](https://docs.mulesoft.com/dataweave/latest/dataweave-create-module#docs-dw-lib) in Exchange.

- An embedded [DataWeave Maven plugin](https://docs.mulesoft.com/dataweave/latest/dataweave-maven-plugin) with the following features:

  - Integration of packaging and deployment of your DataWeave libraries with your Maven lifecycle.

  - Integration with Exchange to share and consume DataWeave libraries.

- An embedded [DataWeave testing framework](https://docs.mulesoft.com/dataweave/latest/dataweave-testing-framework) that enables you to build
  automated unit and integration tests easily.

## See Also

[Create Custom Modules and Mappings](https://docs.mulesoft.com/dataweave/latest/dataweave-create-module)

<!-- document id=0c5ec4cb956471a8a97c6a33e48e95556090765a83be3ca1e5cc2a8f8827593c url=/mulesoft/current/en-us/dataweave/2.3/dataweave-formats-dw.md -->

---
product: DataWeave
version: 2.3
---

# DataWeave Format (dw)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME Type: `application/dw`

ID: `dw`

The DataWeave (dw) format is the canonical format for all transformations. This format can help you
understand how input data is interpreted before it is transformed to a new format.

> [!NOTE] This format is intended to help you debug the results of DataWeave transformations. It is
> significantly slower than other formats. It is not recommended to be used in production
> applications because it can impact the performance.

## Example: Express XML in the DataWeave (dw) Format

The following example shows how to transform XML input to the DataWeave (dw) format.

### Input

The example uses the following XML snippet as input.

```xml
<employees>
  <employee>
    <firstname>Mariano</firstname>
    <lastname>DeAchaval</lastname>
  </employee>
  <employee>
    <firstname>Leandro</firstname>
    <lastname>Shokida</lastname>
  </employee>
</employees>
```

#### Output

Output: in DataWeave Format

```dataweave
{
  employees: {
    employee: {
      firstname: "Mariano",
      lastname: "DeAchaval"
    },
    employee: {
      firstname: "Leandro",
      lastname: "Shokida"
    }
  }
} as Object {encoding: "UTF-8", mimeType: "text/xml"}
```

## Configuration Properties

DataWeave supports the following configuration properties for the DataWeave (dw) format.

### Reader Properties (for dw)

The DataWeave (dw) format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>externalResources</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><p>Enables reading external entities on <code>readUrl</code>. Valid options are <code>true</code> or <code>false</code>.</p></td></tr><tr><td><p><code>javaModule</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><p>Enables you to load Java module functions. Valid options are <code>true</code> or <code>false</code>.</p></td></tr><tr><td><p><code>onlyData</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><p>Indicates whether to handle data only and not other types of content, such as functions. Valid options are <code>true</code> or <code>false</code>. Note that the parser runs faster in the <code>onlyData</code> mode.</p></td></tr></tbody></table>

### Writer Properties (for dw)

The DataWeave (dw) format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the writer buffer.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>When set to <code>true</code>, DataWeave generates the output as a data stream, and the script’s execution is deferred until it is consumed. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>ignoreSchema</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Flag that indicates whether the DataWeave writer ignores the schema. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>indent</code></p></td><td><p><code>String</code></p></td><td><p><code>' '</code></p></td><td><div><div><p>The string to use for indentation.</p></div></div></td></tr><tr><td><p><code>maxCollectionSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>-1</code></p></td><td><div><div><p>The maximum number of elements allowed in an array or object. <code>-1</code> indicates that no limitation is set.</p></div></div></td></tr><tr><td><p><code>onlyData</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether to handle data only and not other types of content, such as functions. Valid options are <code>true</code> or <code>false</code>. Note that the parser runs faster in the <code>onlyData</code> mode.</p></div></div></td></tr></tbody></table>

## Supported MIME Types (for dw)

The DataWeave (dw) format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/dw</code></p></td></tr></tbody></table>

<!-- document id=54adb491c837c78befcd905fdaeeba0e8e9453f1faf183b0452cb3b82e120ecd url=/mulesoft/current/en-us/dataweave/2.11/dataweave-language-guide.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datawave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# DataWeave Language Guide

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave is a functional language used in Mule applications to perform data transformations. Before
you begin to use DataWeave to code your own powerful and complex data transformations, you must
understand the basic concepts of programming and the core features of functional programming
languages.

DataWeave enables you to take advantage of the benefits of functional programming, including:

- Pure functions that always produce the same output given the same input, making them easier for
  you to debug.

- Immutable variables that do not change their value during the execution, adding stability to your
  code.

- Function signatures that provide additional transparency about what affects a function’s
  execution, because pure functions depend on only their input parameters to produce a result.

- Functional languages produce code that’s easier to maintain because the code is concise and clear.

- A call-by-need strategy (also known as _lazy evaluation_) that improves performance, because
  expressions are evaluated only when they are needed and their result is stored to avoid evaluating
  an expression multiple times if the input parameters are the same.

## DataWeave Language Basic Concepts

DataWeave incorporates concepts that are common to most programming languages. All DataWeave scripts
consist of a _header_ that contains important directives, including the output format of the
transformation, and a _body_ that contains the expression to generate a result.

DataWeave supports different _data structures_, including _simple_, _complex_, and _composite_
types. In most of your DataWeave transformations, you use _data selectors_, _data operators_, and
_functions_ alongside _arrays_ and _objects_ to perform data mappings or transformations.

You can also import prebuilt DataWeave _modules_ to extend the set of functions available to use in
your scripts.

### Architecture of a DataWeave Script

A DataWeave script consists of a _header_ and a _body_, separated by three dashes (`---`). The
header contains language directives (`import`, for example), defines the output format of the
transformation, and can also contain variable and function declarations. The body contains the
expression that produces the resulting output, usually a data mapping or a transformation.

Here is an example of a basic DataWeave transformation:

```dataweave
%dw 2.0
output application/json
---
payload
```

### Data Types

DataWeave represents data using values, each of which has a data type associated with it. The type
system enables you to apply constraints to variables and function parameters. The supported data
types include simple types such as `String`, `Boolean`, `Number`, and `Date`, as well as composite
and complex types such as `Array`, `Object`, and `Any`.

For a complete list of all supported data types, see [Type System](https://docs.mulesoft.com/dataweave/2.11/dataweave-type-system).

### Data Selectors

Data selectors enable you to access fields within a data structure so that you can retrieve data
from the payload or any other variable created during the DataWeave script execution. Different
types of selectors provide you with a variety of options that you can use to extract data from
structures.

For example, you can use the _single-value selector_ `payload.userName` to retrieve the single value
`userName`, where `userName` represents an actual key in the input message.

See [Selectors](https://docs.mulesoft.com/dataweave/2.11/dataweave-selectors) for a complete list of data selectors and their usage.

### Functions

A function is a code block that contains a group of operations that are executed when the function
is called in your application. Functions can accept different parameters as input that can then be
used by the operations defined in the function. Additionally, every function returns a value after
it finishes processing, and this value can then be used as input for a different function.

Each DataWeave script that you write in any component (like a Transform Message component or Set
Payload component) works as an independent program, meaning that all function definitions and calls
are unique to the script defined in the component.

See [Define DataWeave Functions](https://docs.mulesoft.com/dataweave/2.11/dataweave-functions) for additional function definition details.

#### Function Definition vs. Function Call

DataWeave enables you to [define your own functions](https://docs.mulesoft.com/dataweave/2.11/dataweave-functions) in the header of the
script, creating a blueprint for the process that defines the operations that are executed upon the
function call. You can also define them in
[DataWeave mapping and module files](https://docs.mulesoft.com/dataweave/2.11/dataweave-create-module).

When you _call_ a function from a DataWeave expression, you are instructing DataWeave to run all the
operations defined in that function at that exact point of the script’s execution.

For example, `upper` is a built-in function defined in the String module. You can call this function
to convert a text value to uppercase. Also, you can use a selector to retrieve a value from the
payload, and then execute the `upper()` function call with this value as the input parameter
`upper(payload.someKey)`.

DataWeave supports both _prefix_ notation (`function (param1, param2)`) and _infix_ notation
(`param1 function param2`) for function calls. Note that you can use infix notation only with
functions that accept only two parameters.

See also, [Function Signatures](https://docs.mulesoft.com/dataweave/2.11/dw-functions#function_signatures).

### Data Operators

Data operators are symbols that enable you to perform operations on data to produce a result.
DataWeave supports operators that are common in most programming languages like mathematical
(`` `, `-`, `/`, `*`), relational (`<`, `>`, `⇐+ ``, `>=`, `==`, `~=`), and logical (`not`, `!`,
`and`, `or`) operators.

DataWeave also supports the following operators:

- Append (`<<`, `+`), Prepend (`>>`), and Remove (`-`), which enable you to manage data in an array.

- Scope and Flow control operators (`do`, `using`, `if`, `else`) that enable you to create a scope
  where new variables and functions can be declared, or to execute an expression based on a
  condition.

- Update (`update`), which enables you to update specific fields of a data structure.

See [DataWeave Operators](https://docs.mulesoft.com/dataweave/2.11/dw-operators) for a complete list of supported operators, their usage, and
examples.

#### Import Function Modules

By default, DataWeave scripts import the `dw::Core` function module. To use functions from different
modules, import the modules to your script by adding the `import` directive.

See [DataWeave Reference](https://docs.mulesoft.com/dataweave/2.11/dw-functions) for instructions on using the `import` directive.

### Arrays

An array is a data structure that can contain any number of elements of the supported DataWeave
types. To declare an array, use brackets (`[` and `]`) to enclose a comma-separated list of
elements, for example: `[1,2,3]`.

Arrays also support the application of conditional logic to define conditional elements
(`[(value1) if condition]`). For example, the expression
`[(1) if true, (2) if false, (3) if payload != null]` defines the array `[1,3]` (assuming that
`payload` is not `null`).

### Objects

An object is a collection of zero or more `Key` and `value` pairs:

- `Key`, which is formed by:

  - `Name`, composed of a `String` value as the local name and an optional `Namespace`.

  - `Attributes`, a collection of zero or more `Name:value` pairs, where `value` can be any possible
    value.

- `Value`, comprising any supported type, including another object, a function call, or an array.

To declare an object, use braces (`{` and `}`) to enclose a comma-separated list of `Key:value`
pairs:

```dataweave
{
  keyName @(keyAttributeName :"keyAttributeValue"): "value",
  User @(role:"admin"): upper("max the mule"),
  myArray: [1,2,3]
}
```

Objects also support the definition of conditional elements:

```dataweave
{
 (userName: name) if !isBlank(name),
 (userRole: role) if !isBlank(role)
}
```

## Functional Programming Principles

The functional programming paradigm enables developers to build applications by using pure function
composition and immutable data. Because functional programming is declarative, functions in
DataWeave are just expressions that return a value, instead of imperative statements that change
program states.

DataWeave follows the core principles of functional programming, including pure functions,
first-class functions, high-order functions, function composition, lambda expressions, and immutable
data.

### Pure Functions

Pure functions in programming are similar to pure functions in mathematics in that, given a certain
input, they always return the same output. Also, executing a function has no impact on other parts
of a program, other than producing a result. All functions in DataWeave are pure; they are not
affected by external values that could change the result of the execution.

### First-Class Functions

The pure functions in DataWeave are also “first-class citizens” in that they support operations that
are available to any other data type, including being stored in variables, passed as parameters, and
returned as results.

### High-Order Functions

High-order functions in programming also have the same concept as in mathematics. These functions
take one or more functions as parameters and return a function as a result. The result of a
high-order function can then be used as an input parameter in another function, enabling the concept
of _function composition_.

### Function Composition

Function composition is the process by which functions are combined to build complex operations. In
this case, the result of executing one function serves as an input parameter for the next function.
In DataWeave, all data transformations are a chain of expressions, functions composed to obtain a
final result that outputs the data as needed.

#### Example of Function Composition

The following example uses the function `pluck` to map an object into an array. Then the resulting
array serves as input for the function `filter`, which selects the elements in the array that have a
`Role` equal to `ADMIN`. During the mapping process, the function `upper` transforms the `role`
value:

```dataweave
%dw 2.0
output application/json
var collaborators =
{
    Max: {role: "admin", id: "01"},
    Einstein: {role: "dev", id: "02"},
    Astro: {role: "admin", id: "03"},
    Blaze: {role: "user", id: "04"}
}
---
collaborators pluck ((value,key,index)->  {
        "Name": key,
        "Role": upper(value.role),
        "ID": value.id
    })
    filter ((item, index) -> item.Role == "ADMIN")
```

The following example shows the same expression, but it uses prefix notation. This syntax helps
visualize how `filter` takes as the first parameter the result of `pluck`.

```dataweave
%dw 2.0
output application/json
var collaborators =
{
    Max: {role: "admin", id: "01"},
    Einstein: {role: "dev", id: "02"},
    Astro: {role: "admin", id: "03"},
    Blaze: {role: "user", id: "04"}
}
---
filter(
   pluck(
       collaborators, (value,key,index)->
       {
           "Name": key,
           "Role": upper(value.role),
           "ID": value.id
       }),
   (item, index) -> item.Role == "ADMIN")
```

The output of both expressions is:

```dataweave
[
  {
    "Name": "Max",
    "Role": "ADMIN",
    "ID": "01"
  },
  {
    "Name": "Astro",
    "Role": "ADMIN",
    "ID": "03"
  }
]
```

### Lambda Expressions

Lambda expressions, also known as _anonymous functions_ or _function literals_, are function
definitions that do not have an identifier name and can be passed as parameters to high-order
functions. Lambda syntax is expressed in the form `(a,b) → c`, which can be read as “Given a certain
input (`a` and `b`), execute the following (`c`).”

For example, the `map` function in DataWeave accepts a lambda expression as one of its parameters:
`map(Array<T>, (item: T, index: Number) → R): Array<R>`. `map` iterates over the items in an array
and executes the lambda expression that is passed as a parameter. This lambda expression consists of
two parameters that represent the value (`item`) and index (`index`) of each array element during
the execution, and a function definition to execute during the iteration `R`.

The following code example shows a `map` function that receives a lambda expression to concatenate
the index and the value of each element in the array it iterates on, and then returns these values
as a new array:

Source

```dataweave
%dw 2.0
output application/json
---
["Max", "the", "Mule"] map (item, index) -> index ++ " - " ++ item
```

Output

```dataweave
[
    "0 - Max",
    "1 - the",
    "2 - Mule"
]
```

See [Work with Functions and Lambdas in DataWeave](https://docs.mulesoft.com/dataweave/2.11/dataweave-functions-lambdas) for additional
information about Lambda expressions.

### Immutable Data

In DataWeave, variables cannot change their assigned value after they are defined. This ensures that
there are no unexpected results from executing functions. If you want to store a new value that is
the result of an operation, you must declare a new data structure.

## Differences with Imperative Programming

If you have a development background in working with object-oriented programming languages, it is
important to understand that functional programming separates data from functions and does not use
loop control statements.

### Separation of Data and Functions

DataWeave does not use assignment statements, which ensures that data remains immutable. Because
there are no getter and setter methods, nor classes containing data structures and behavior, each
function works only with the data you provide as input. If you need to modify any existing data
structure, you create a new copy and apply functions to modify its values.

### Control Flow Statements

There are no loop control statements like `for` or `while` in DataWeave. In DataWeave, instead of
defining how to execute a procedure using iteration, you focus on your current requirements when you
write the expressions.

For example, to make changes to a list, you use the `map` function to apply changes to the elements
in the collection. Additionally, you can use the `filter` function to remove specific elements from
a list, or the `reduce` function to collapse all values from an array into one single value.

However, you can use `if-else` statements to apply a condition when executing an expression:

```dataweave
%dw 2.0
var myVar = { country : "FRANCE" }
output application/json
---
if (myVar.country == "USA")
  { currency: "USD" }
else { currency: "EUR" }
```

#### DataWeave Examples

For usage examples of `map`, `reduce`, and `filter`, see:

- [Map Data with DataWeave](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-map)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-conditional-list-reduction-via-function)

- [Merge Fields from Separate Objects](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-merge-multiple-payloads)

## See Also

- [Mule Message Structure](https://docs.mulesoft.com/mule-runtime/latest/about-mule-message)

- [Mule Events](https://docs.mulesoft.com/mule-runtime/latest/about-mule-event)

- [Core Components](https://docs.mulesoft.com/mule-runtime/latest/about-components)

- [Connectors and Modules](https://docs.mulesoft.com/connectors/)

- [Transform Message Component](https://docs.mulesoft.com/mule-runtime/latest/transform-component-about)

<!-- document id=1e12b6ecd77a49c5ecf2b56ef80ffaf9a72daf97785110824cb70dead92121d2 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-language-guide.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datawave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# DataWeave Language Guide

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave is a functional language used in Mule applications to perform data transformations. Before
you begin to use DataWeave to code your own powerful and complex data transformations, you must
understand the basic concepts of programming and the core features of functional programming
languages.

DataWeave enables you to take advantage of the benefits of functional programming, including:

- Pure functions that always produce the same output given the same input, making them easier for
  you to debug.

- Immutable variables that do not change their value during the execution, adding stability to your
  code.

- Function signatures that provide additional transparency about what affects a function’s
  execution, because pure functions depend on only their input parameters to produce a result.

- Functional languages produce code that’s easier to maintain because the code is concise and clear.

- A call-by-need strategy (also known as _lazy evaluation_) that improves performance, because
  expressions are evaluated only when they are needed and their result is stored to avoid evaluating
  an expression multiple times if the input parameters are the same.

## DataWeave Language Basic Concepts

DataWeave incorporates concepts that are common to most programming languages. All DataWeave scripts
consist of a _header_ that contains important directives, including the output format of the
transformation, and a _body_ that contains the expression to generate a result.

DataWeave supports different _data structures_, including _simple_, _complex_, and _composite_
types. In most of your DataWeave transformations, you use _data selectors_, _data operators_, and
_functions_ alongside _arrays_ and _objects_ to perform data mappings or transformations.

You can also import prebuilt DataWeave _modules_ to extend the set of functions available to use in
your scripts.

### Architecture of a DataWeave Script

A DataWeave script consists of a _header_ and a _body_, separated by three dashes (`---`). The
header contains language directives (`import`, for example), defines the output format of the
transformation, and can also contain variable and function declarations. The body contains the
expression that produces the resulting output, usually a data mapping or a transformation.

Here is an example of a basic DataWeave transformation:

```dataweave
%dw 2.0
output application/json
---
payload
```

### Data Types

DataWeave represents data using values, each of which has a data type associated with it. The type
system enables you to apply constraints to variables and function parameters. The supported data
types include simple types such as `String`, `Boolean`, `Number`, and `Date`, as well as composite
and complex types such as `Array`, `Object`, and `Any`.

For a complete list of all supported data types, see [Type System](https://docs.mulesoft.com/dataweave/2.12/dataweave-type-system).

### Data Selectors

Data selectors enable you to access fields within a data structure so that you can retrieve data
from the payload or any other variable created during the DataWeave script execution. Different
types of selectors provide you with a variety of options that you can use to extract data from
structures.

For example, you can use the _single-value selector_ `payload.userName` to retrieve the single value
`userName`, where `userName` represents an actual key in the input message.

See [Selectors](https://docs.mulesoft.com/dataweave/2.12/dataweave-selectors) for a complete list of data selectors and their usage.

### Functions

A function is a code block that contains a group of operations that are executed when the function
is called in your application. Functions can accept different parameters as input that can then be
used by the operations defined in the function. Additionally, every function returns a value after
it finishes processing, and this value can then be used as input for a different function.

Each DataWeave script that you write in any component (like a Transform Message component or Set
Payload component) works as an independent program, meaning that all function definitions and calls
are unique to the script defined in the component.

See [Define DataWeave Functions](https://docs.mulesoft.com/dataweave/2.12/dataweave-functions) for additional function definition details.

#### Function Definition vs. Function Call

DataWeave enables you to [define your own functions](https://docs.mulesoft.com/dataweave/2.12/dataweave-functions) in the header of the
script, creating a blueprint for the process that defines the operations that are executed upon the
function call. You can also define them in
[DataWeave mapping and module files](https://docs.mulesoft.com/dataweave/2.12/dataweave-create-module).

When you _call_ a function from a DataWeave expression, you are instructing DataWeave to run all the
operations defined in that function at that exact point of the script’s execution.

For example, `upper` is a built-in function defined in the String module. You can call this function
to convert a text value to uppercase. Also, you can use a selector to retrieve a value from the
payload, and then execute the `upper()` function call with this value as the input parameter
`upper(payload.someKey)`.

DataWeave supports both _prefix_ notation (`function (param1, param2)`) and _infix_ notation
(`param1 function param2`) for function calls. Note that you can use infix notation only with
functions that accept only two parameters.

See also, [Function Signatures](https://docs.mulesoft.com/dataweave/2.12/dw-functions#function_signatures).

### Data Operators

Data operators are symbols that enable you to perform operations on data to produce a result.
DataWeave supports operators that are common in most programming languages like mathematical
(`` `, `-`, `/`, `*`), relational (`<`, `>`, `⇐+ ``, `>=`, `==`, `~=`), and logical (`not`, `!`,
`and`, `or`) operators.

DataWeave also supports the following operators:

- Append (`<<`, `+`), Prepend (`>>`), and Remove (`-`), which enable you to manage data in an array.

- Scope and Flow control operators (`do`, `using`, `if`, `else`) that enable you to create a scope
  where new variables and functions can be declared, or to execute an expression based on a
  condition.

- Update (`update`), which enables you to update specific fields of a data structure.

See [DataWeave Operators](https://docs.mulesoft.com/dataweave/2.12/dw-operators) for a complete list of supported operators, their usage, and
examples.

#### Import Function Modules

By default, DataWeave scripts import the `dw::Core` function module. To use functions from different
modules, import the modules to your script by adding the `import` directive.

See [DataWeave Reference](https://docs.mulesoft.com/dataweave/2.12/dw-functions) for instructions on using the `import` directive.

### Arrays

An array is a data structure that can contain any number of elements of the supported DataWeave
types. To declare an array, use brackets (`[` and `]`) to enclose a comma-separated list of
elements, for example: `[1,2,3]`.

Arrays also support the application of conditional logic to define conditional elements
(`[(value1) if condition]`). For example, the expression
`[(1) if true, (2) if false, (3) if payload != null]` defines the array `[1,3]` (assuming that
`payload` is not `null`).

### Objects

An object is a collection of zero or more `Key` and `value` pairs:

- `Key`, which is formed by:

  - `Name`, composed of a `String` value as the local name and an optional `Namespace`.

  - `Attributes`, a collection of zero or more `Name:value` pairs, where `value` can be any possible
    value.

- `Value`, comprising any supported type, including another object, a function call, or an array.

To declare an object, use braces (`{` and `}`) to enclose a comma-separated list of `Key:value`
pairs:

```dataweave
{
  keyName @(keyAttributeName :"keyAttributeValue"): "value",
  User @(role:"admin"): upper("max the mule"),
  myArray: [1,2,3]
}
```

Objects also support the definition of conditional elements:

```dataweave
{
 (userName: name) if !isBlank(name),
 (userRole: role) if !isBlank(role)
}
```

## Functional Programming Principles

The functional programming paradigm enables developers to build applications by using pure function
composition and immutable data. Because functional programming is declarative, functions in
DataWeave are just expressions that return a value, instead of imperative statements that change
program states.

DataWeave follows the core principles of functional programming, including pure functions,
first-class functions, high-order functions, function composition, lambda expressions, and immutable
data.

### Pure Functions

Pure functions in programming are similar to pure functions in mathematics in that, given a certain
input, they always return the same output. Also, executing a function has no impact on other parts
of a program, other than producing a result. All functions in DataWeave are pure; they are not
affected by external values that could change the result of the execution.

### First-Class Functions

The pure functions in DataWeave are also “first-class citizens” in that they support operations that
are available to any other data type, including being stored in variables, passed as parameters, and
returned as results.

### High-Order Functions

High-order functions in programming also have the same concept as in mathematics. These functions
take one or more functions as parameters and return a function as a result. The result of a
high-order function can then be used as an input parameter in another function, enabling the concept
of _function composition_.

### Function Composition

Function composition is the process by which functions are combined to build complex operations. In
this case, the result of executing one function serves as an input parameter for the next function.
In DataWeave, all data transformations are a chain of expressions, functions composed to obtain a
final result that outputs the data as needed.

#### Example of Function Composition

The following example uses the function `pluck` to map an object into an array. Then the resulting
array serves as input for the function `filter`, which selects the elements in the array that have a
`Role` equal to `ADMIN`. During the mapping process, the function `upper` transforms the `role`
value:

```dataweave
%dw 2.0
output application/json
var collaborators =
{
    Max: {role: "admin", id: "01"},
    Einstein: {role: "dev", id: "02"},
    Astro: {role: "admin", id: "03"},
    Blaze: {role: "user", id: "04"}
}
---
collaborators pluck ((value,key,index)->  {
        "Name": key,
        "Role": upper(value.role),
        "ID": value.id
    })
    filter ((item, index) -> item.Role == "ADMIN")
```

The following example shows the same expression, but it uses prefix notation. This syntax helps
visualize how `filter` takes as the first parameter the result of `pluck`.

```dataweave
%dw 2.0
output application/json
var collaborators =
{
    Max: {role: "admin", id: "01"},
    Einstein: {role: "dev", id: "02"},
    Astro: {role: "admin", id: "03"},
    Blaze: {role: "user", id: "04"}
}
---
filter(
   pluck(
       collaborators, (value,key,index)->
       {
           "Name": key,
           "Role": upper(value.role),
           "ID": value.id
       }),
   (item, index) -> item.Role == "ADMIN")
```

The output of both expressions is:

```dataweave
[
  {
    "Name": "Max",
    "Role": "ADMIN",
    "ID": "01"
  },
  {
    "Name": "Astro",
    "Role": "ADMIN",
    "ID": "03"
  }
]
```

### Lambda Expressions

Lambda expressions, also known as _anonymous functions_ or _function literals_, are function
definitions that do not have an identifier name and can be passed as parameters to high-order
functions. Lambda syntax is expressed in the form `(a,b) → c`, which can be read as “Given a certain
input (`a` and `b`), execute the following (`c`).”

For example, the `map` function in DataWeave accepts a lambda expression as one of its parameters:
`map(Array<T>, (item: T, index: Number) → R): Array<R>`. `map` iterates over the items in an array
and executes the lambda expression that is passed as a parameter. This lambda expression consists of
two parameters that represent the value (`item`) and index (`index`) of each array element during
the execution, and a function definition to execute during the iteration `R`.

The following code example shows a `map` function that receives a lambda expression to concatenate
the index and the value of each element in the array it iterates on, and then returns these values
as a new array:

Source

```dataweave
%dw 2.0
output application/json
---
["Max", "the", "Mule"] map (item, index) -> index ++ " - " ++ item
```

Output

```dataweave
[
    "0 - Max",
    "1 - the",
    "2 - Mule"
]
```

See [Work with Functions and Lambdas in DataWeave](https://docs.mulesoft.com/dataweave/2.12/dataweave-functions-lambdas) for additional
information about Lambda expressions.

### Immutable Data

In DataWeave, variables cannot change their assigned value after they are defined. This ensures that
there are no unexpected results from executing functions. If you want to store a new value that is
the result of an operation, you must declare a new data structure.

## Differences with Imperative Programming

If you have a development background in working with object-oriented programming languages, it is
important to understand that functional programming separates data from functions and does not use
loop control statements.

### Separation of Data and Functions

DataWeave does not use assignment statements, which ensures that data remains immutable. Because
there are no getter and setter methods, nor classes containing data structures and behavior, each
function works only with the data you provide as input. If you need to modify any existing data
structure, you create a new copy and apply functions to modify its values.

### Control Flow Statements

There are no loop control statements like `for` or `while` in DataWeave. In DataWeave, instead of
defining how to execute a procedure using iteration, you focus on your current requirements when you
write the expressions.

For example, to make changes to a list, you use the `map` function to apply changes to the elements
in the collection. Additionally, you can use the `filter` function to remove specific elements from
a list, or the `reduce` function to collapse all values from an array into one single value.

However, you can use `if-else` statements to apply a condition when executing an expression:

```dataweave
%dw 2.0
var myVar = { country : "FRANCE" }
output application/json
---
if (myVar.country == "USA")
  { currency: "USD" }
else { currency: "EUR" }
```

#### DataWeave Examples

For usage examples of `map`, `reduce`, and `filter`, see:

- [Map Data with DataWeave](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-map)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-conditional-list-reduction-via-function)

- [Merge Fields from Separate Objects](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-merge-multiple-payloads)

## See Also

- [Mule Message Structure](https://docs.mulesoft.com/mule-runtime/latest/about-mule-message)

- [Mule Events](https://docs.mulesoft.com/mule-runtime/latest/about-mule-event)

- [Core Components](https://docs.mulesoft.com/mule-runtime/latest/about-components)

- [Connectors and Modules](https://docs.mulesoft.com/connectors/)

- [Transform Message Component](https://docs.mulesoft.com/mule-runtime/latest/transform-component-about)

<!-- document id=03b55e587b2eca0130a922f307d4867370ccad214fc8e41e9b5d888a360dc64f url=/mulesoft/current/en-us/dataweave/2.3/dataweave-language-guide.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datawave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# DataWeave Language Guide

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave is a functional language used in Mule applications to perform data transformations. Before
you begin to use DataWeave to code your own powerful and complex data transformations, you must
understand the basic concepts of programming and the core features of functional programming
languages.

DataWeave enables you to take advantage of the benefits of functional programming, including:

- Pure functions that always produce the same output given the same input, making them easier for
  you to debug.

- Immutable variables that do not change their value during the execution, adding stability to your
  code.

- Function signatures that provide additional transparency about what affects a function’s
  execution, because pure functions depend on only their input parameters to produce a result.

- Functional languages produce code that’s easier to maintain because the code is concise and clear.

- A call-by-need strategy (also known as _lazy evaluation_) that improves performance, because
  expressions are evaluated only when they are needed and their result is stored to avoid evaluating
  an expression multiple times if the input parameters are the same.

## DataWeave Language Basic Concepts

DataWeave incorporates concepts that are common to most programming languages. All DataWeave scripts
consist of a _header_ that contains important directives, including the output format of the
transformation, and a _body_ that contains the expression to generate a result.

DataWeave supports different _data structures_, including _simple_, _complex_, and _composite_
types. In most of your DataWeave transformations, you use _data selectors_, _data operators_, and
_functions_ alongside _arrays_ and _objects_ to perform data mappings or transformations.

You can also import prebuilt DataWeave _modules_ to extend the set of functions available to use in
your scripts.

### Architecture of a DataWeave Script

A DataWeave script consists of a _header_ and a _body_, separated by three dashes (`---`). The
header contains language directives (`import`, for example), defines the output format of the
transformation, and can also contain variable and function declarations. The body contains the
expression that produces the resulting output, usually a data mapping or a transformation.

Here is an example of a basic DataWeave transformation:

```dataweave
%dw 2.0
output application/json
---
payload
```

### Data Types

DataWeave represents data using values, each of which has a data type associated with it. The type
system enables you to apply constraints to variables and function parameters. The supported data
types include simple types such as `String`, `Boolean`, `Number`, and `Date`, as well as composite
and complex types such as `Array`, `Object`, and `Any`.

For a complete list of all supported data types, see [Type System](https://docs.mulesoft.com/dataweave/2.3/dataweave-type-system).

### Data Selectors

Data selectors enable you to access fields within a data structure so that you can retrieve data
from the payload or any other variable created during the DataWeave script execution. Different
types of selectors provide you with a variety of options that you can use to extract data from
structures.

For example, you can use the _single-value selector_ `payload.userName` to retrieve the single value
`userName`, where `userName` represents an actual key in the input message.

See [Selectors](https://docs.mulesoft.com/dataweave/2.3/dataweave-selectors) for a complete list of data selectors and their usage.

### Functions

A function is a code block that contains a group of operations that are executed when the function
is called in your application. Functions can accept different parameters as input that can then be
used by the operations defined in the function. Additionally, every function returns a value after
it finishes processing, and this value can then be used as input for a different function.

Each DataWeave script that you write in any component (like a Transform Message component or Set
Payload component) works as an independent program, meaning that all function definitions and calls
are unique to the script defined in the component.

See [Define DataWeave Functions](https://docs.mulesoft.com/dataweave/2.3/dataweave-functions) for additional function definition details.

#### Function Definition vs. Function Call

In DataWeave, you _define_ functions in the header of the script, creating a blueprint for the
process that defines the operations that are executed upon the function call.

When you _call_ a function from a DataWeave expression, you are instructing DataWeave to run all the
operations defined in that function at that exact point of the script’s execution.

For example, `upper` is a built-in function defined in the String module. You can call this function
to convert a text value to uppercase. Also, you can use a selector to retrieve a value from the
payload, and then execute the `upper()` function call with this value as the input parameter
`upper(payload.someKey)`.

DataWeave supports both _prefix_ notation (`function (param1, param2)`) and _infix_ notation
(`param1 function param2`) for function calls. Note that you can use infix notation only with
functions that accept only two parameters.

See also, [Function Signatures](https://docs.mulesoft.com/dataweave/2.3/dw-functions#function_signatures).

### Data Operators

Data operators are symbols that enable you to perform operations on data to produce a result.
DataWeave supports operators that are common in most programming languages like mathematical
(`` `, `-`, `/`, `*`), relational (`<`, `>`, `⇐+ ``, `>=`, `==`, `~=`), and logical (`not`, `!`,
`and`, `or`) operators.

DataWeave also supports the following operators:

- Append (`<<`, `+`), Prepend (`>>`), and Remove (`-`), which enable you to manage data in an array.

- Scope and Flow control operators (`do`, `using`, `if`, `else`) that enable you to create a scope
  where new variables and functions can be declared, or to execute an expression based on a
  condition.

- Update (`update`), which enables you to update specific fields of a data structure.

See [DataWeave Operators](https://docs.mulesoft.com/dataweave/2.3/dw-operators) for a complete list of supported operators, their usage, and
examples.

#### Import Function Modules

By default, DataWeave scripts import the `dw::Core` function module. To use functions from different
modules, import the modules to your script by adding the `import` directive.

See [DataWeave Reference](https://docs.mulesoft.com/dataweave/2.3/dw-functions) for instructions on using the `import` directive.

### Arrays

An array is a data structure that can contain any number of elements of the supported DataWeave
types. To declare an array, use brackets (`[` and `]`) to enclose a comma-separated list of
elements, for example: `[1,2,3]`.

Arrays also support the application of conditional logic to define conditional elements
(`[(value1) if condition]`). For example, the expression
`[(1) if true, (2) if false, (3) if payload != null]` defines the array `[1,3]` (assuming that
`payload` is not `null`).

### Objects

An object is a collection of zero or more `Key` and `value` pairs:

- `Key`, which is formed by:

  - `Name`, composed of a `String` value as the local name and an optional `Namespace`.

  - `Attributes`, a collection of zero or more `Name:value` pairs, where `value` can be any possible
    value.

- `Value`, comprising any supported type, including another object, a function call, or an array.

To declare an object, use braces (`{` and `}`) to enclose a comma-separated list of `Key:value`
pairs:

```dataweave
{
  keyName @(keyAttributeName :"keyAttributeValue"): "value",
  User @(role:"admin"): upper("max the mule"),
  myArray: [1,2,3]
}
```

Objects also support the definition of conditional elements:

```dataweave
{
 (userName: name) if !isBlank(name),
 (userRole: role) if !isBlank(role)
}
```

## Functional Programming Principles

The functional programming paradigm enables developers to build applications by using pure function
composition and immutable data. Because functional programming is declarative, functions in
DataWeave are just expressions that return a value, instead of imperative statements that change
program states.

DataWeave follows the core principles of functional programming, including pure functions,
first-class functions, high-order functions, function composition, lambda expressions, and immutable
data.

### Pure Functions

Pure functions in programming are similar to pure functions in mathematics in that, given a certain
input, they always return the same output. Also, executing a function has no impact on other parts
of a program, other than producing a result. All functions in DataWeave are pure; they are not
affected by external values that could change the result of the execution.

### First-Class Functions

The pure functions in DataWeave are also “first-class citizens” in that they support operations that
are available to any other data type, including being stored in variables, passed as parameters, and
returned as results.

### High-Order Functions

High-order functions in programming also have the same concept as in mathematics. These functions
take one or more functions as parameters and return a function as a result. The result of a
high-order function can then be used as an input parameter in another function, enabling the concept
of _function composition_.

### Function Composition

Function composition is the process by which functions are combined to build complex operations. In
this case, the result of executing one function serves as an input parameter for the next function.
In DataWeave, all data transformations are a chain of expressions, functions composed to obtain a
final result that outputs the data as needed.

#### Example of Function Composition

The following example uses the function `pluck` to map an object into an array. Then the resulting
array serves as input for the function `filter`, which selects the elements in the array that have a
`Role` equal to `ADMIN`. During the mapping process, the function `upper` transforms the `role`
value:

```dataweave
%dw 2.0
output application/json
var collaborators =
{
    Max: {role: "admin", id: "01"},
    Einstein: {role: "dev", id: "02"},
    Astro: {role: "admin", id: "03"},
    Blaze: {role: "user", id: "04"}
}
---
collaborators pluck ((value,key,index)->  {
        "Name": key,
        "Role": upper(value.role),
        "ID": value.id
    })
    filter ((item, index) -> item.Role == "ADMIN")
```

The following example shows the same expression, but it uses prefix notation. This syntax helps
visualize how `filter` takes as the first parameter the result of `pluck`.

```dataweave
%dw 2.0
output application/json
var collaborators =
{
    Max: {role: "admin", id: "01"},
    Einstein: {role: "dev", id: "02"},
    Astro: {role: "admin", id: "03"},
    Blaze: {role: "user", id: "04"}
}
---
filter(
   pluck(
       collaborators, (value,key,index)->
       {
           "Name": key,
           "Role": upper(value.role),
           "ID": value.id
       }),
   (item, index) -> item.Role == "ADMIN")
```

The output of both expressions is:

```dataweave
[
  {
    "Name": "Max",
    "Role": "ADMIN",
    "ID": "01"
  },
  {
    "Name": "Astro",
    "Role": "ADMIN",
    "ID": "03"
  }
]
```

### Lambda Expressions

Lambda expressions, also known as _anonymous functions_ or _function literals_, are function
definitions that do not have an identifier name and can be passed as parameters to high-order
functions. Lambda syntax is expressed in the form `(a,b) → c`, which can be read as “Given a certain
input (`a` and `b`), execute the following (`c`).”

For example, the `map` function in DataWeave accepts a lambda expression as one of its parameters:
`map(Array<T>, (item: T, index: Number) → R): Array<R>`. `map` iterates over the items in an array
and executes the lambda expression that is passed as a parameter. This lambda expression consists of
two parameters that represent the value (`item`) and index (`index`) of each array element during
the execution, and a function definition to execute during the iteration `R`.

The following code example shows a `map` function that receives a lambda expression to concatenate
the index and the value of each element in the array it iterates on, and then returns these values
as a new array:

Source

```dataweave
%dw 2.0
output application/json
---
["Max", "the", "Mule"] map (item, index) -> index ++ " - " ++ item
```

Output

```dataweave
[
    "0 - Max",
    "1 - the",
    "2 - Mule"
]
```

See [Work with Functions and Lambdas in DataWeave](https://docs.mulesoft.com/dataweave/2.3/dataweave-functions-lambdas) for additional
information about Lambda expressions.

### Immutable Data

In DataWeave, variables cannot change their assigned value after they are defined. This ensures that
there are no unexpected results from executing functions. If you want to store a new value that is
the result of an operation, you must declare a new data structure.

## Differences with Imperative Programming

If you have a development background in working with object-oriented programming languages, it is
important to understand that functional programming separates data from functions and does not use
loop control statements.

### Separation of Data and Functions

DataWeave does not use assignment statements, which ensures that data remains immutable. Because
there are no getter and setter methods, nor classes containing data structures and behavior, each
function works only with the data you provide as input. If you need to modify any existing data
structure, you create a new copy and apply functions to modify its values.

### Control Flow Statements

There are no loop control statements like `for` or `while` in DataWeave. In DataWeave, instead of
defining how to execute a procedure using iteration, you focus on your current requirements when you
write the expressions.

For example, to make changes to a list, you use the `map` function to apply changes to the elements
in the collection. Additionally, you can use the `filter` function to remove specific elements from
a list, or the `reduce` function to collapse all values from an array into one single value.

However, you can use `if-else` statements to apply a condition when executing an expression:

```dataweave
%dw 2.0
var myVar = { country : "FRANCE" }
output application/json
---
if (myVar.country == "USA")
  { currency: "USD" }
else { currency: "EUR" }
```

#### DataWeave Examples

For usage examples of `map`, `reduce`, and `filter`, see:

- [Map Data with DataWeave](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-map)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-conditional-list-reduction-via-function)

- [Merge Fields from Separate Objects](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-merge-multiple-payloads)

## See Also

- [Mule Message Structure](https://docs.mulesoft.com/mule-runtime/4.3/about-mule-message)

- [Mule Events](https://docs.mulesoft.com/mule-runtime/4.3/about-mule-event)

- [Core Components](https://docs.mulesoft.com/mule-runtime/4.3/about-components)

- [Connectors and Modules](https://docs.mulesoft.com/connectors/)

- [Transform Message Component](https://docs.mulesoft.com/mule-runtime/4.3/transform-component-about)

<!-- document id=54a8095fba0653b07a6d1e48dddc1345b0e810522ecf7263a3bfdb6aa8666d36 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-language-guide.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datawave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# DataWeave Language Guide

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave is a functional language used in Mule applications to perform data transformations. Before
you begin to use DataWeave to code your own powerful and complex data transformations, you must
understand the basic concepts of programming and the core features of functional programming
languages.

DataWeave enables you to take advantage of the benefits of functional programming, including:

- Pure functions that always produce the same output given the same input, making them easier for
  you to debug.

- Immutable variables that do not change their value during the execution, adding stability to your
  code.

- Function signatures that provide additional transparency about what affects a function’s
  execution, because pure functions depend on only their input parameters to produce a result.

- Functional languages produce code that’s easier to maintain because the code is concise and clear.

- A call-by-need strategy (also known as _lazy evaluation_) that improves performance, because
  expressions are evaluated only when they are needed and their result is stored to avoid evaluating
  an expression multiple times if the input parameters are the same.

## DataWeave Language Basic Concepts

DataWeave incorporates concepts that are common to most programming languages. All DataWeave scripts
consist of a _header_ that contains important directives, including the output format of the
transformation, and a _body_ that contains the expression to generate a result.

DataWeave supports different _data structures_, including _simple_, _complex_, and _composite_
types. In most of your DataWeave transformations, you use _data selectors_, _data operators_, and
_functions_ alongside _arrays_ and _objects_ to perform data mappings or transformations.

You can also import prebuilt DataWeave _modules_ to extend the set of functions available to use in
your scripts.

### Architecture of a DataWeave Script

A DataWeave script consists of a _header_ and a _body_, separated by three dashes (`---`). The
header contains language directives (`import`, for example), defines the output format of the
transformation, and can also contain variable and function declarations. The body contains the
expression that produces the resulting output, usually a data mapping or a transformation.

Here is an example of a basic DataWeave transformation:

```dataweave
%dw 2.0
output application/json
---
payload
```

### Data Types

DataWeave represents data using values, each of which has a data type associated with it. The type
system enables you to apply constraints to variables and function parameters. The supported data
types include simple types such as `String`, `Boolean`, `Number`, and `Date`, as well as composite
and complex types such as `Array`, `Object`, and `Any`.

For a complete list of all supported data types, see [Type System](https://docs.mulesoft.com/dataweave/2.4/dataweave-type-system).

### Data Selectors

Data selectors enable you to access fields within a data structure so that you can retrieve data
from the payload or any other variable created during the DataWeave script execution. Different
types of selectors provide you with a variety of options that you can use to extract data from
structures.

For example, you can use the _single-value selector_ `payload.userName` to retrieve the single value
`userName`, where `userName` represents an actual key in the input message.

See [Selectors](https://docs.mulesoft.com/dataweave/2.4/dataweave-selectors) for a complete list of data selectors and their usage.

### Functions

A function is a code block that contains a group of operations that are executed when the function
is called in your application. Functions can accept different parameters as input that can then be
used by the operations defined in the function. Additionally, every function returns a value after
it finishes processing, and this value can then be used as input for a different function.

Each DataWeave script that you write in any component (like a Transform Message component or Set
Payload component) works as an independent program, meaning that all function definitions and calls
are unique to the script defined in the component.

See [Define DataWeave Functions](https://docs.mulesoft.com/dataweave/2.4/dataweave-functions) for additional function definition details.

#### Function Definition vs. Function Call

DataWeave enables you to [define your own functions](https://docs.mulesoft.com/dataweave/2.4/dataweave-functions) in the header of the
script, creating a blueprint for the process that defines the operations that are executed upon the
function call. You can also define them in
[DataWeave mapping and module files](https://docs.mulesoft.com/dataweave/2.4/dataweave-create-module).

When you _call_ a function from a DataWeave expression, you are instructing DataWeave to run all the
operations defined in that function at that exact point of the script’s execution.

For example, `upper` is a built-in function defined in the String module. You can call this function
to convert a text value to uppercase. Also, you can use a selector to retrieve a value from the
payload, and then execute the `upper()` function call with this value as the input parameter
`upper(payload.someKey)`.

DataWeave supports both _prefix_ notation (`function (param1, param2)`) and _infix_ notation
(`param1 function param2`) for function calls. Note that you can use infix notation only with
functions that accept only two parameters.

See also, [Function Signatures](https://docs.mulesoft.com/dataweave/2.4/dw-functions#function_signatures).

### Data Operators

Data operators are symbols that enable you to perform operations on data to produce a result.
DataWeave supports operators that are common in most programming languages like mathematical
(`` `, `-`, `/`, `*`), relational (`<`, `>`, `⇐+ ``, `>=`, `==`, `~=`), and logical (`not`, `!`,
`and`, `or`) operators.

DataWeave also supports the following operators:

- Append (`<<`, `+`), Prepend (`>>`), and Remove (`-`), which enable you to manage data in an array.

- Scope and Flow control operators (`do`, `using`, `if`, `else`) that enable you to create a scope
  where new variables and functions can be declared, or to execute an expression based on a
  condition.

- Update (`update`), which enables you to update specific fields of a data structure.

See [DataWeave Operators](https://docs.mulesoft.com/dataweave/2.4/dw-operators) for a complete list of supported operators, their usage, and
examples.

#### Import Function Modules

By default, DataWeave scripts import the `dw::Core` function module. To use functions from different
modules, import the modules to your script by adding the `import` directive.

See [DataWeave Reference](https://docs.mulesoft.com/dataweave/2.4/dw-functions) for instructions on using the `import` directive.

### Arrays

An array is a data structure that can contain any number of elements of the supported DataWeave
types. To declare an array, use brackets (`[` and `]`) to enclose a comma-separated list of
elements, for example: `[1,2,3]`.

Arrays also support the application of conditional logic to define conditional elements
(`[(value1) if condition]`). For example, the expression
`[(1) if true, (2) if false, (3) if payload != null]` defines the array `[1,3]` (assuming that
`payload` is not `null`).

### Objects

An object is a collection of zero or more `Key` and `value` pairs:

- `Key`, which is formed by:

  - `Name`, composed of a `String` value as the local name and an optional `Namespace`.

  - `Attributes`, a collection of zero or more `Name:value` pairs, where `value` can be any possible
    value.

- `Value`, comprising any supported type, including another object, a function call, or an array.

To declare an object, use braces (`{` and `}`) to enclose a comma-separated list of `Key:value`
pairs:

```dataweave
{
  keyName @(keyAttributeName :"keyAttributeValue"): "value",
  User @(role:"admin"): upper("max the mule"),
  myArray: [1,2,3]
}
```

Objects also support the definition of conditional elements:

```dataweave
{
 (userName: name) if !isBlank(name),
 (userRole: role) if !isBlank(role)
}
```

## Functional Programming Principles

The functional programming paradigm enables developers to build applications by using pure function
composition and immutable data. Because functional programming is declarative, functions in
DataWeave are just expressions that return a value, instead of imperative statements that change
program states.

DataWeave follows the core principles of functional programming, including pure functions,
first-class functions, high-order functions, function composition, lambda expressions, and immutable
data.

### Pure Functions

Pure functions in programming are similar to pure functions in mathematics in that, given a certain
input, they always return the same output. Also, executing a function has no impact on other parts
of a program, other than producing a result. All functions in DataWeave are pure; they are not
affected by external values that could change the result of the execution.

### First-Class Functions

The pure functions in DataWeave are also “first-class citizens” in that they support operations that
are available to any other data type, including being stored in variables, passed as parameters, and
returned as results.

### High-Order Functions

High-order functions in programming also have the same concept as in mathematics. These functions
take one or more functions as parameters and return a function as a result. The result of a
high-order function can then be used as an input parameter in another function, enabling the concept
of _function composition_.

### Function Composition

Function composition is the process by which functions are combined to build complex operations. In
this case, the result of executing one function serves as an input parameter for the next function.
In DataWeave, all data transformations are a chain of expressions, functions composed to obtain a
final result that outputs the data as needed.

#### Example of Function Composition

The following example uses the function `pluck` to map an object into an array. Then the resulting
array serves as input for the function `filter`, which selects the elements in the array that have a
`Role` equal to `ADMIN`. During the mapping process, the function `upper` transforms the `role`
value:

```dataweave
%dw 2.0
output application/json
var collaborators =
{
    Max: {role: "admin", id: "01"},
    Einstein: {role: "dev", id: "02"},
    Astro: {role: "admin", id: "03"},
    Blaze: {role: "user", id: "04"}
}
---
collaborators pluck ((value,key,index)->  {
        "Name": key,
        "Role": upper(value.role),
        "ID": value.id
    })
    filter ((item, index) -> item.Role == "ADMIN")
```

The following example shows the same expression, but it uses prefix notation. This syntax helps
visualize how `filter` takes as the first parameter the result of `pluck`.

```dataweave
%dw 2.0
output application/json
var collaborators =
{
    Max: {role: "admin", id: "01"},
    Einstein: {role: "dev", id: "02"},
    Astro: {role: "admin", id: "03"},
    Blaze: {role: "user", id: "04"}
}
---
filter(
   pluck(
       collaborators, (value,key,index)->
       {
           "Name": key,
           "Role": upper(value.role),
           "ID": value.id
       }),
   (item, index) -> item.Role == "ADMIN")
```

The output of both expressions is:

```dataweave
[
  {
    "Name": "Max",
    "Role": "ADMIN",
    "ID": "01"
  },
  {
    "Name": "Astro",
    "Role": "ADMIN",
    "ID": "03"
  }
]
```

### Lambda Expressions

Lambda expressions, also known as _anonymous functions_ or _function literals_, are function
definitions that do not have an identifier name and can be passed as parameters to high-order
functions. Lambda syntax is expressed in the form `(a,b) → c`, which can be read as “Given a certain
input (`a` and `b`), execute the following (`c`).”

For example, the `map` function in DataWeave accepts a lambda expression as one of its parameters:
`map(Array<T>, (item: T, index: Number) → R): Array<R>`. `map` iterates over the items in an array
and executes the lambda expression that is passed as a parameter. This lambda expression consists of
two parameters that represent the value (`item`) and index (`index`) of each array element during
the execution, and a function definition to execute during the iteration `R`.

The following code example shows a `map` function that receives a lambda expression to concatenate
the index and the value of each element in the array it iterates on, and then returns these values
as a new array:

Source

```dataweave
%dw 2.0
output application/json
---
["Max", "the", "Mule"] map (item, index) -> index ++ " - " ++ item
```

Output

```dataweave
[
    "0 - Max",
    "1 - the",
    "2 - Mule"
]
```

See [Work with Functions and Lambdas in DataWeave](https://docs.mulesoft.com/dataweave/2.4/dataweave-functions-lambdas) for additional
information about Lambda expressions.

### Immutable Data

In DataWeave, variables cannot change their assigned value after they are defined. This ensures that
there are no unexpected results from executing functions. If you want to store a new value that is
the result of an operation, you must declare a new data structure.

## Differences with Imperative Programming

If you have a development background in working with object-oriented programming languages, it is
important to understand that functional programming separates data from functions and does not use
loop control statements.

### Separation of Data and Functions

DataWeave does not use assignment statements, which ensures that data remains immutable. Because
there are no getter and setter methods, nor classes containing data structures and behavior, each
function works only with the data you provide as input. If you need to modify any existing data
structure, you create a new copy and apply functions to modify its values.

### Control Flow Statements

There are no loop control statements like `for` or `while` in DataWeave. In DataWeave, instead of
defining how to execute a procedure using iteration, you focus on your current requirements when you
write the expressions.

For example, to make changes to a list, you use the `map` function to apply changes to the elements
in the collection. Additionally, you can use the `filter` function to remove specific elements from
a list, or the `reduce` function to collapse all values from an array into one single value.

However, you can use `if-else` statements to apply a condition when executing an expression:

```dataweave
%dw 2.0
var myVar = { country : "FRANCE" }
output application/json
---
if (myVar.country == "USA")
  { currency: "USD" }
else { currency: "EUR" }
```

#### DataWeave Examples

For usage examples of `map`, `reduce`, and `filter`, see:

- [Map Data with DataWeave](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-map)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-conditional-list-reduction-via-function)

- [Merge Fields from Separate Objects](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-merge-multiple-payloads)

## See Also

- [Mule Message Structure](https://docs.mulesoft.com/mule-runtime/latest/about-mule-message)

- [Mule Events](https://docs.mulesoft.com/mule-runtime/latest/about-mule-event)

- [Core Components](https://docs.mulesoft.com/mule-runtime/latest/about-components)

- [Connectors and Modules](https://docs.mulesoft.com/connectors/)

- [Transform Message Component](https://docs.mulesoft.com/mule-runtime/latest/transform-component-about)

<!-- document id=e95aa33da79d438da8d700f774752dfb5387cd04ae8373992acb0754e650d008 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-language-guide.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datawave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# DataWeave Language Guide

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave is a functional language used in Mule applications to perform data transformations. Before
you begin to use DataWeave to code your own powerful and complex data transformations, you must
understand the basic concepts of programming and the core features of functional programming
languages.

DataWeave enables you to take advantage of the benefits of functional programming, including:

- Pure functions that always produce the same output given the same input, making them easier for
  you to debug.

- Immutable variables that do not change their value during the execution, adding stability to your
  code.

- Function signatures that provide additional transparency about what affects a function’s
  execution, because pure functions depend on only their input parameters to produce a result.

- Functional languages produce code that’s easier to maintain because the code is concise and clear.

- A call-by-need strategy (also known as _lazy evaluation_) that improves performance, because
  expressions are evaluated only when they are needed and their result is stored to avoid evaluating
  an expression multiple times if the input parameters are the same.

## DataWeave Language Basic Concepts

DataWeave incorporates concepts that are common to most programming languages. All DataWeave scripts
consist of a _header_ that contains important directives, including the output format of the
transformation, and a _body_ that contains the expression to generate a result.

DataWeave supports different _data structures_, including _simple_, _complex_, and _composite_
types. In most of your DataWeave transformations, you use _data selectors_, _data operators_, and
_functions_ alongside _arrays_ and _objects_ to perform data mappings or transformations.

You can also import prebuilt DataWeave _modules_ to extend the set of functions available to use in
your scripts.

### Architecture of a DataWeave Script

A DataWeave script consists of a _header_ and a _body_, separated by three dashes (`---`). The
header contains language directives (`import`, for example), defines the output format of the
transformation, and can also contain variable and function declarations. The body contains the
expression that produces the resulting output, usually a data mapping or a transformation.

Here is an example of a basic DataWeave transformation:

```dataweave
%dw 2.0
output application/json
---
payload
```

### Data Types

DataWeave represents data using values, each of which has a data type associated with it. The type
system enables you to apply constraints to variables and function parameters. The supported data
types include simple types such as `String`, `Boolean`, `Number`, and `Date`, as well as composite
and complex types such as `Array`, `Object`, and `Any`.

For a complete list of all supported data types, see [Type System](https://docs.mulesoft.com/dataweave/2.6/dataweave-type-system).

### Data Selectors

Data selectors enable you to access fields within a data structure so that you can retrieve data
from the payload or any other variable created during the DataWeave script execution. Different
types of selectors provide you with a variety of options that you can use to extract data from
structures.

For example, you can use the _single-value selector_ `payload.userName` to retrieve the single value
`userName`, where `userName` represents an actual key in the input message.

See [Selectors](https://docs.mulesoft.com/dataweave/2.6/dataweave-selectors) for a complete list of data selectors and their usage.

### Functions

A function is a code block that contains a group of operations that are executed when the function
is called in your application. Functions can accept different parameters as input that can then be
used by the operations defined in the function. Additionally, every function returns a value after
it finishes processing, and this value can then be used as input for a different function.

Each DataWeave script that you write in any component (like a Transform Message component or Set
Payload component) works as an independent program, meaning that all function definitions and calls
are unique to the script defined in the component.

See [Define DataWeave Functions](https://docs.mulesoft.com/dataweave/2.6/dataweave-functions) for additional function definition details.

#### Function Definition vs. Function Call

DataWeave enables you to [define your own functions](https://docs.mulesoft.com/dataweave/2.6/dataweave-functions) in the header of the
script, creating a blueprint for the process that defines the operations that are executed upon the
function call. You can also define them in
[DataWeave mapping and module files](https://docs.mulesoft.com/dataweave/2.6/dataweave-create-module).

When you _call_ a function from a DataWeave expression, you are instructing DataWeave to run all the
operations defined in that function at that exact point of the script’s execution.

For example, `upper` is a built-in function defined in the String module. You can call this function
to convert a text value to uppercase. Also, you can use a selector to retrieve a value from the
payload, and then execute the `upper()` function call with this value as the input parameter
`upper(payload.someKey)`.

DataWeave supports both _prefix_ notation (`function (param1, param2)`) and _infix_ notation
(`param1 function param2`) for function calls. Note that you can use infix notation only with
functions that accept only two parameters.

See also, [Function Signatures](https://docs.mulesoft.com/dataweave/2.6/dw-functions#function_signatures).

### Data Operators

Data operators are symbols that enable you to perform operations on data to produce a result.
DataWeave supports operators that are common in most programming languages like mathematical
(`` `, `-`, `/`, `*`), relational (`<`, `>`, `⇐+ ``, `>=`, `==`, `~=`), and logical (`not`, `!`,
`and`, `or`) operators.

DataWeave also supports the following operators:

- Append (`<<`, `+`), Prepend (`>>`), and Remove (`-`), which enable you to manage data in an array.

- Scope and Flow control operators (`do`, `using`, `if`, `else`) that enable you to create a scope
  where new variables and functions can be declared, or to execute an expression based on a
  condition.

- Update (`update`), which enables you to update specific fields of a data structure.

See [DataWeave Operators](https://docs.mulesoft.com/dataweave/2.6/dw-operators) for a complete list of supported operators, their usage, and
examples.

#### Import Function Modules

By default, DataWeave scripts import the `dw::Core` function module. To use functions from different
modules, import the modules to your script by adding the `import` directive.

See [DataWeave Reference](https://docs.mulesoft.com/dataweave/2.6/dw-functions) for instructions on using the `import` directive.

### Arrays

An array is a data structure that can contain any number of elements of the supported DataWeave
types. To declare an array, use brackets (`[` and `]`) to enclose a comma-separated list of
elements, for example: `[1,2,3]`.

Arrays also support the application of conditional logic to define conditional elements
(`[(value1) if condition]`). For example, the expression
`[(1) if true, (2) if false, (3) if payload != null]` defines the array `[1,3]` (assuming that
`payload` is not `null`).

### Objects

An object is a collection of zero or more `Key` and `value` pairs:

- `Key`, which is formed by:

  - `Name`, composed of a `String` value as the local name and an optional `Namespace`.

  - `Attributes`, a collection of zero or more `Name:value` pairs, where `value` can be any possible
    value.

- `Value`, comprising any supported type, including another object, a function call, or an array.

To declare an object, use braces (`{` and `}`) to enclose a comma-separated list of `Key:value`
pairs:

```dataweave
{
  keyName @(keyAttributeName :"keyAttributeValue"): "value",
  User @(role:"admin"): upper("max the mule"),
  myArray: [1,2,3]
}
```

Objects also support the definition of conditional elements:

```dataweave
{
 (userName: name) if !isBlank(name),
 (userRole: role) if !isBlank(role)
}
```

## Functional Programming Principles

The functional programming paradigm enables developers to build applications by using pure function
composition and immutable data. Because functional programming is declarative, functions in
DataWeave are just expressions that return a value, instead of imperative statements that change
program states.

DataWeave follows the core principles of functional programming, including pure functions,
first-class functions, high-order functions, function composition, lambda expressions, and immutable
data.

### Pure Functions

Pure functions in programming are similar to pure functions in mathematics in that, given a certain
input, they always return the same output. Also, executing a function has no impact on other parts
of a program, other than producing a result. All functions in DataWeave are pure; they are not
affected by external values that could change the result of the execution.

### First-Class Functions

The pure functions in DataWeave are also “first-class citizens” in that they support operations that
are available to any other data type, including being stored in variables, passed as parameters, and
returned as results.

### High-Order Functions

High-order functions in programming also have the same concept as in mathematics. These functions
take one or more functions as parameters and return a function as a result. The result of a
high-order function can then be used as an input parameter in another function, enabling the concept
of _function composition_.

### Function Composition

Function composition is the process by which functions are combined to build complex operations. In
this case, the result of executing one function serves as an input parameter for the next function.
In DataWeave, all data transformations are a chain of expressions, functions composed to obtain a
final result that outputs the data as needed.

#### Example of Function Composition

The following example uses the function `pluck` to map an object into an array. Then the resulting
array serves as input for the function `filter`, which selects the elements in the array that have a
`Role` equal to `ADMIN`. During the mapping process, the function `upper` transforms the `role`
value:

```dataweave
%dw 2.0
output application/json
var collaborators =
{
    Max: {role: "admin", id: "01"},
    Einstein: {role: "dev", id: "02"},
    Astro: {role: "admin", id: "03"},
    Blaze: {role: "user", id: "04"}
}
---
collaborators pluck ((value,key,index)->  {
        "Name": key,
        "Role": upper(value.role),
        "ID": value.id
    })
    filter ((item, index) -> item.Role == "ADMIN")
```

The following example shows the same expression, but it uses prefix notation. This syntax helps
visualize how `filter` takes as the first parameter the result of `pluck`.

```dataweave
%dw 2.0
output application/json
var collaborators =
{
    Max: {role: "admin", id: "01"},
    Einstein: {role: "dev", id: "02"},
    Astro: {role: "admin", id: "03"},
    Blaze: {role: "user", id: "04"}
}
---
filter(
   pluck(
       collaborators, (value,key,index)->
       {
           "Name": key,
           "Role": upper(value.role),
           "ID": value.id
       }),
   (item, index) -> item.Role == "ADMIN")
```

The output of both expressions is:

```dataweave
[
  {
    "Name": "Max",
    "Role": "ADMIN",
    "ID": "01"
  },
  {
    "Name": "Astro",
    "Role": "ADMIN",
    "ID": "03"
  }
]
```

### Lambda Expressions

Lambda expressions, also known as _anonymous functions_ or _function literals_, are function
definitions that do not have an identifier name and can be passed as parameters to high-order
functions. Lambda syntax is expressed in the form `(a,b) → c`, which can be read as “Given a certain
input (`a` and `b`), execute the following (`c`).”

For example, the `map` function in DataWeave accepts a lambda expression as one of its parameters:
`map(Array<T>, (item: T, index: Number) → R): Array<R>`. `map` iterates over the items in an array
and executes the lambda expression that is passed as a parameter. This lambda expression consists of
two parameters that represent the value (`item`) and index (`index`) of each array element during
the execution, and a function definition to execute during the iteration `R`.

The following code example shows a `map` function that receives a lambda expression to concatenate
the index and the value of each element in the array it iterates on, and then returns these values
as a new array:

Source

```dataweave
%dw 2.0
output application/json
---
["Max", "the", "Mule"] map (item, index) -> index ++ " - " ++ item
```

Output

```dataweave
[
    "0 - Max",
    "1 - the",
    "2 - Mule"
]
```

See [Work with Functions and Lambdas in DataWeave](https://docs.mulesoft.com/dataweave/2.6/dataweave-functions-lambdas) for additional
information about Lambda expressions.

### Immutable Data

In DataWeave, variables cannot change their assigned value after they are defined. This ensures that
there are no unexpected results from executing functions. If you want to store a new value that is
the result of an operation, you must declare a new data structure.

## Differences with Imperative Programming

If you have a development background in working with object-oriented programming languages, it is
important to understand that functional programming separates data from functions and does not use
loop control statements.

### Separation of Data and Functions

DataWeave does not use assignment statements, which ensures that data remains immutable. Because
there are no getter and setter methods, nor classes containing data structures and behavior, each
function works only with the data you provide as input. If you need to modify any existing data
structure, you create a new copy and apply functions to modify its values.

### Control Flow Statements

There are no loop control statements like `for` or `while` in DataWeave. In DataWeave, instead of
defining how to execute a procedure using iteration, you focus on your current requirements when you
write the expressions.

For example, to make changes to a list, you use the `map` function to apply changes to the elements
in the collection. Additionally, you can use the `filter` function to remove specific elements from
a list, or the `reduce` function to collapse all values from an array into one single value.

However, you can use `if-else` statements to apply a condition when executing an expression:

```dataweave
%dw 2.0
var myVar = { country : "FRANCE" }
output application/json
---
if (myVar.country == "USA")
  { currency: "USD" }
else { currency: "EUR" }
```

#### DataWeave Examples

For usage examples of `map`, `reduce`, and `filter`, see:

- [Map Data with DataWeave](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-map)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-conditional-list-reduction-via-function)

- [Merge Fields from Separate Objects](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-merge-multiple-payloads)

## See Also

- [Mule Message Structure](https://docs.mulesoft.com/mule-runtime/latest/about-mule-message)

- [Mule Events](https://docs.mulesoft.com/mule-runtime/latest/about-mule-event)

- [Core Components](https://docs.mulesoft.com/mule-runtime/latest/about-components)

- [Connectors and Modules](https://docs.mulesoft.com/connectors/)

- [Transform Message Component](https://docs.mulesoft.com/mule-runtime/latest/transform-component-about)

<!-- document id=8d38b35c7c026e920b84fac67068bc41baa0b506f5f77942269b30ca5902c774 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-language-guide.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datawave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# DataWeave Language Guide

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave is a functional language used in Mule applications to perform data transformations. Before
you begin to use DataWeave to code your own powerful and complex data transformations, you must
understand the basic concepts of programming and the core features of functional programming
languages.

DataWeave enables you to take advantage of the benefits of functional programming, including:

- Pure functions that always produce the same output given the same input, making them easier for
  you to debug.

- Immutable variables that do not change their value during the execution, adding stability to your
  code.

- Function signatures that provide additional transparency about what affects a function’s
  execution, because pure functions depend on only their input parameters to produce a result.

- Functional languages produce code that’s easier to maintain because the code is concise and clear.

- A call-by-need strategy (also known as _lazy evaluation_) that improves performance, because
  expressions are evaluated only when they are needed and their result is stored to avoid evaluating
  an expression multiple times if the input parameters are the same.

## DataWeave Language Basic Concepts

DataWeave incorporates concepts that are common to most programming languages. All DataWeave scripts
consist of a _header_ that contains important directives, including the output format of the
transformation, and a _body_ that contains the expression to generate a result.

DataWeave supports different _data structures_, including _simple_, _complex_, and _composite_
types. In most of your DataWeave transformations, you use _data selectors_, _data operators_, and
_functions_ alongside _arrays_ and _objects_ to perform data mappings or transformations.

You can also import prebuilt DataWeave _modules_ to extend the set of functions available to use in
your scripts.

### Architecture of a DataWeave Script

A DataWeave script consists of a _header_ and a _body_, separated by three dashes (`---`). The
header contains language directives (`import`, for example), defines the output format of the
transformation, and can also contain variable and function declarations. The body contains the
expression that produces the resulting output, usually a data mapping or a transformation.

Here is an example of a basic DataWeave transformation:

```dataweave
%dw 2.0
output application/json
---
payload
```

### Data Types

DataWeave represents data using values, each of which has a data type associated with it. The type
system enables you to apply constraints to variables and function parameters. The supported data
types include simple types such as `String`, `Boolean`, `Number`, and `Date`, as well as composite
and complex types such as `Array`, `Object`, and `Any`.

For a complete list of all supported data types, see [Type System](https://docs.mulesoft.com/dataweave/2.9/dataweave-type-system).

### Data Selectors

Data selectors enable you to access fields within a data structure so that you can retrieve data
from the payload or any other variable created during the DataWeave script execution. Different
types of selectors provide you with a variety of options that you can use to extract data from
structures.

For example, you can use the _single-value selector_ `payload.userName` to retrieve the single value
`userName`, where `userName` represents an actual key in the input message.

See [Selectors](https://docs.mulesoft.com/dataweave/2.9/dataweave-selectors) for a complete list of data selectors and their usage.

### Functions

A function is a code block that contains a group of operations that are executed when the function
is called in your application. Functions can accept different parameters as input that can then be
used by the operations defined in the function. Additionally, every function returns a value after
it finishes processing, and this value can then be used as input for a different function.

Each DataWeave script that you write in any component (like a Transform Message component or Set
Payload component) works as an independent program, meaning that all function definitions and calls
are unique to the script defined in the component.

See [Define DataWeave Functions](https://docs.mulesoft.com/dataweave/2.9/dataweave-functions) for additional function definition details.

#### Function Definition vs. Function Call

DataWeave enables you to [define your own functions](https://docs.mulesoft.com/dataweave/2.9/dataweave-functions) in the header of the
script, creating a blueprint for the process that defines the operations that are executed upon the
function call. You can also define them in
[DataWeave mapping and module files](https://docs.mulesoft.com/dataweave/2.9/dataweave-create-module).

When you _call_ a function from a DataWeave expression, you are instructing DataWeave to run all the
operations defined in that function at that exact point of the script’s execution.

For example, `upper` is a built-in function defined in the String module. You can call this function
to convert a text value to uppercase. Also, you can use a selector to retrieve a value from the
payload, and then execute the `upper()` function call with this value as the input parameter
`upper(payload.someKey)`.

DataWeave supports both _prefix_ notation (`function (param1, param2)`) and _infix_ notation
(`param1 function param2`) for function calls. Note that you can use infix notation only with
functions that accept only two parameters.

See also, [Function Signatures](https://docs.mulesoft.com/dataweave/2.9/dw-functions#function_signatures).

### Data Operators

Data operators are symbols that enable you to perform operations on data to produce a result.
DataWeave supports operators that are common in most programming languages like mathematical
(`` `, `-`, `/`, `*`), relational (`<`, `>`, `⇐+ ``, `>=`, `==`, `~=`), and logical (`not`, `!`,
`and`, `or`) operators.

DataWeave also supports the following operators:

- Append (`<<`, `+`), Prepend (`>>`), and Remove (`-`), which enable you to manage data in an array.

- Scope and Flow control operators (`do`, `using`, `if`, `else`) that enable you to create a scope
  where new variables and functions can be declared, or to execute an expression based on a
  condition.

- Update (`update`), which enables you to update specific fields of a data structure.

See [DataWeave Operators](https://docs.mulesoft.com/dataweave/2.9/dw-operators) for a complete list of supported operators, their usage, and
examples.

#### Import Function Modules

By default, DataWeave scripts import the `dw::Core` function module. To use functions from different
modules, import the modules to your script by adding the `import` directive.

See [DataWeave Reference](https://docs.mulesoft.com/dataweave/2.9/dw-functions) for instructions on using the `import` directive.

### Arrays

An array is a data structure that can contain any number of elements of the supported DataWeave
types. To declare an array, use brackets (`[` and `]`) to enclose a comma-separated list of
elements, for example: `[1,2,3]`.

Arrays also support the application of conditional logic to define conditional elements
(`[(value1) if condition]`). For example, the expression
`[(1) if true, (2) if false, (3) if payload != null]` defines the array `[1,3]` (assuming that
`payload` is not `null`).

### Objects

An object is a collection of zero or more `Key` and `value` pairs:

- `Key`, which is formed by:

  - `Name`, composed of a `String` value as the local name and an optional `Namespace`.

  - `Attributes`, a collection of zero or more `Name:value` pairs, where `value` can be any possible
    value.

- `Value`, comprising any supported type, including another object, a function call, or an array.

To declare an object, use braces (`{` and `}`) to enclose a comma-separated list of `Key:value`
pairs:

```dataweave
{
  keyName @(keyAttributeName :"keyAttributeValue"): "value",
  User @(role:"admin"): upper("max the mule"),
  myArray: [1,2,3]
}
```

Objects also support the definition of conditional elements:

```dataweave
{
 (userName: name) if !isBlank(name),
 (userRole: role) if !isBlank(role)
}
```

## Functional Programming Principles

The functional programming paradigm enables developers to build applications by using pure function
composition and immutable data. Because functional programming is declarative, functions in
DataWeave are just expressions that return a value, instead of imperative statements that change
program states.

DataWeave follows the core principles of functional programming, including pure functions,
first-class functions, high-order functions, function composition, lambda expressions, and immutable
data.

### Pure Functions

Pure functions in programming are similar to pure functions in mathematics in that, given a certain
input, they always return the same output. Also, executing a function has no impact on other parts
of a program, other than producing a result. All functions in DataWeave are pure; they are not
affected by external values that could change the result of the execution.

### First-Class Functions

The pure functions in DataWeave are also “first-class citizens” in that they support operations that
are available to any other data type, including being stored in variables, passed as parameters, and
returned as results.

### High-Order Functions

High-order functions in programming also have the same concept as in mathematics. These functions
take one or more functions as parameters and return a function as a result. The result of a
high-order function can then be used as an input parameter in another function, enabling the concept
of _function composition_.

### Function Composition

Function composition is the process by which functions are combined to build complex operations. In
this case, the result of executing one function serves as an input parameter for the next function.
In DataWeave, all data transformations are a chain of expressions, functions composed to obtain a
final result that outputs the data as needed.

#### Example of Function Composition

The following example uses the function `pluck` to map an object into an array. Then the resulting
array serves as input for the function `filter`, which selects the elements in the array that have a
`Role` equal to `ADMIN`. During the mapping process, the function `upper` transforms the `role`
value:

```dataweave
%dw 2.0
output application/json
var collaborators =
{
    Max: {role: "admin", id: "01"},
    Einstein: {role: "dev", id: "02"},
    Astro: {role: "admin", id: "03"},
    Blaze: {role: "user", id: "04"}
}
---
collaborators pluck ((value,key,index)->  {
        "Name": key,
        "Role": upper(value.role),
        "ID": value.id
    })
    filter ((item, index) -> item.Role == "ADMIN")
```

The following example shows the same expression, but it uses prefix notation. This syntax helps
visualize how `filter` takes as the first parameter the result of `pluck`.

```dataweave
%dw 2.0
output application/json
var collaborators =
{
    Max: {role: "admin", id: "01"},
    Einstein: {role: "dev", id: "02"},
    Astro: {role: "admin", id: "03"},
    Blaze: {role: "user", id: "04"}
}
---
filter(
   pluck(
       collaborators, (value,key,index)->
       {
           "Name": key,
           "Role": upper(value.role),
           "ID": value.id
       }),
   (item, index) -> item.Role == "ADMIN")
```

The output of both expressions is:

```dataweave
[
  {
    "Name": "Max",
    "Role": "ADMIN",
    "ID": "01"
  },
  {
    "Name": "Astro",
    "Role": "ADMIN",
    "ID": "03"
  }
]
```

### Lambda Expressions

Lambda expressions, also known as _anonymous functions_ or _function literals_, are function
definitions that do not have an identifier name and can be passed as parameters to high-order
functions. Lambda syntax is expressed in the form `(a,b) → c`, which can be read as “Given a certain
input (`a` and `b`), execute the following (`c`).”

For example, the `map` function in DataWeave accepts a lambda expression as one of its parameters:
`map(Array<T>, (item: T, index: Number) → R): Array<R>`. `map` iterates over the items in an array
and executes the lambda expression that is passed as a parameter. This lambda expression consists of
two parameters that represent the value (`item`) and index (`index`) of each array element during
the execution, and a function definition to execute during the iteration `R`.

The following code example shows a `map` function that receives a lambda expression to concatenate
the index and the value of each element in the array it iterates on, and then returns these values
as a new array:

Source

```dataweave
%dw 2.0
output application/json
---
["Max", "the", "Mule"] map (item, index) -> index ++ " - " ++ item
```

Output

```dataweave
[
    "0 - Max",
    "1 - the",
    "2 - Mule"
]
```

See [Work with Functions and Lambdas in DataWeave](https://docs.mulesoft.com/dataweave/2.9/dataweave-functions-lambdas) for additional
information about Lambda expressions.

### Immutable Data

In DataWeave, variables cannot change their assigned value after they are defined. This ensures that
there are no unexpected results from executing functions. If you want to store a new value that is
the result of an operation, you must declare a new data structure.

## Differences with Imperative Programming

If you have a development background in working with object-oriented programming languages, it is
important to understand that functional programming separates data from functions and does not use
loop control statements.

### Separation of Data and Functions

DataWeave does not use assignment statements, which ensures that data remains immutable. Because
there are no getter and setter methods, nor classes containing data structures and behavior, each
function works only with the data you provide as input. If you need to modify any existing data
structure, you create a new copy and apply functions to modify its values.

### Control Flow Statements

There are no loop control statements like `for` or `while` in DataWeave. In DataWeave, instead of
defining how to execute a procedure using iteration, you focus on your current requirements when you
write the expressions.

For example, to make changes to a list, you use the `map` function to apply changes to the elements
in the collection. Additionally, you can use the `filter` function to remove specific elements from
a list, or the `reduce` function to collapse all values from an array into one single value.

However, you can use `if-else` statements to apply a condition when executing an expression:

```dataweave
%dw 2.0
var myVar = { country : "FRANCE" }
output application/json
---
if (myVar.country == "USA")
  { currency: "USD" }
else { currency: "EUR" }
```

#### DataWeave Examples

For usage examples of `map`, `reduce`, and `filter`, see:

- [Map Data with DataWeave](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-map)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-conditional-list-reduction-via-function)

- [Merge Fields from Separate Objects](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-merge-multiple-payloads)

## See Also

- [Mule Message Structure](https://docs.mulesoft.com/mule-runtime/latest/about-mule-message)

- [Mule Events](https://docs.mulesoft.com/mule-runtime/latest/about-mule-event)

- [Core Components](https://docs.mulesoft.com/mule-runtime/latest/about-components)

- [Connectors and Modules](https://docs.mulesoft.com/connectors/)

- [Transform Message Component](https://docs.mulesoft.com/mule-runtime/latest/transform-component-about)

<!-- document id=7ced44c883b3a97095741a6547a722816126a904d36ee36eeabe43dbb1ec204b url=/mulesoft/current/en-us/dataweave/latest/dataweave-language-guide.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datawave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# DataWeave Language Guide

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave is a functional language used in Mule applications to perform data transformations. Before
you begin to use DataWeave to code your own powerful and complex data transformations, you must
understand the basic concepts of programming and the core features of functional programming
languages.

DataWeave enables you to take advantage of the benefits of functional programming, including:

- Pure functions that always produce the same output given the same input, making them easier for
  you to debug.

- Immutable variables that do not change their value during the execution, adding stability to your
  code.

- Function signatures that provide additional transparency about what affects a function’s
  execution, because pure functions depend on only their input parameters to produce a result.

- Functional languages produce code that’s easier to maintain because the code is concise and clear.

- A call-by-need strategy (also known as _lazy evaluation_) that improves performance, because
  expressions are evaluated only when they are needed and their result is stored to avoid evaluating
  an expression multiple times if the input parameters are the same.

## DataWeave Language Basic Concepts

DataWeave incorporates concepts that are common to most programming languages. All DataWeave scripts
consist of a _header_ that contains important directives, including the output format of the
transformation, and a _body_ that contains the expression to generate a result.

DataWeave supports different _data structures_, including _simple_, _complex_, and _composite_
types. In most of your DataWeave transformations, you use _data selectors_, _data operators_, and
_functions_ alongside _arrays_ and _objects_ to perform data mappings or transformations.

You can also import prebuilt DataWeave _modules_ to extend the set of functions available to use in
your scripts.

### Architecture of a DataWeave Script

A DataWeave script consists of a _header_ and a _body_, separated by three dashes (`---`). The
header contains language directives (`import`, for example), defines the output format of the
transformation, and can also contain variable and function declarations. The body contains the
expression that produces the resulting output, usually a data mapping or a transformation.

Here is an example of a basic DataWeave transformation:

```dataweave
%dw 2.0
output application/json
---
payload
```

### Data Types

DataWeave represents data using values, each of which has a data type associated with it. The type
system enables you to apply constraints to variables and function parameters. The supported data
types include simple types such as `String`, `Boolean`, `Number`, and `Date`, as well as composite
and complex types such as `Array`, `Object`, and `Any`.

For a complete list of all supported data types, see [Type System](https://docs.mulesoft.com/dataweave/latest/dataweave-type-system).

### Data Selectors

Data selectors enable you to access fields within a data structure so that you can retrieve data
from the payload or any other variable created during the DataWeave script execution. Different
types of selectors provide you with a variety of options that you can use to extract data from
structures.

For example, you can use the _single-value selector_ `payload.userName` to retrieve the single value
`userName`, where `userName` represents an actual key in the input message.

See [Selectors](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors) for a complete list of data selectors and their usage.

### Functions

A function is a code block that contains a group of operations that are executed when the function
is called in your application. Functions can accept different parameters as input that can then be
used by the operations defined in the function. Additionally, every function returns a value after
it finishes processing, and this value can then be used as input for a different function.

Each DataWeave script that you write in any component (like a Transform Message component or Set
Payload component) works as an independent program, meaning that all function definitions and calls
are unique to the script defined in the component.

See [Define DataWeave Functions](https://docs.mulesoft.com/dataweave/latest/dataweave-functions) for additional function definition details.

#### Function Definition vs. Function Call

DataWeave enables you to [define your own functions](https://docs.mulesoft.com/dataweave/latest/dataweave-functions) in the header of the
script, creating a blueprint for the process that defines the operations that are executed upon the
function call. You can also define them in
[DataWeave mapping and module files](https://docs.mulesoft.com/dataweave/latest/dataweave-create-module).

When you _call_ a function from a DataWeave expression, you are instructing DataWeave to run all the
operations defined in that function at that exact point of the script’s execution.

For example, `upper` is a built-in function defined in the String module. You can call this function
to convert a text value to uppercase. Also, you can use a selector to retrieve a value from the
payload, and then execute the `upper()` function call with this value as the input parameter
`upper(payload.someKey)`.

DataWeave supports both _prefix_ notation (`function (param1, param2)`) and _infix_ notation
(`param1 function param2`) for function calls. Note that you can use infix notation only with
functions that accept only two parameters.

See also, [Function Signatures](https://docs.mulesoft.com/dataweave/latest/dw-functions#function_signatures).

### Data Operators

Data operators are symbols that enable you to perform operations on data to produce a result.
DataWeave supports operators that are common in most programming languages like mathematical
(`` `, `-`, `/`, `*`), relational (`<`, `>`, `⇐+ ``, `>=`, `==`, `~=`), and logical (`not`, `!`,
`and`, `or`) operators.

DataWeave also supports the following operators:

- Append (`<<`, `+`), Prepend (`>>`), and Remove (`-`), which enable you to manage data in an array.

- Scope and Flow control operators (`do`, `using`, `if`, `else`) that enable you to create a scope
  where new variables and functions can be declared, or to execute an expression based on a
  condition.

- Update (`update`), which enables you to update specific fields of a data structure.

See [DataWeave Operators](https://docs.mulesoft.com/dataweave/latest/dw-operators) for a complete list of supported operators, their usage, and
examples.

#### Import Function Modules

By default, DataWeave scripts import the `dw::Core` function module. To use functions from different
modules, import the modules to your script by adding the `import` directive.

See [DataWeave Reference](https://docs.mulesoft.com/dataweave/latest/dw-functions) for instructions on using the `import` directive.

### Arrays

An array is a data structure that can contain any number of elements of the supported DataWeave
types. To declare an array, use brackets (`[` and `]`) to enclose a comma-separated list of
elements, for example: `[1,2,3]`.

Arrays also support the application of conditional logic to define conditional elements
(`[(value1) if condition]`). For example, the expression
`[(1) if true, (2) if false, (3) if payload != null]` defines the array `[1,3]` (assuming that
`payload` is not `null`).

### Objects

An object is a collection of zero or more `Key` and `value` pairs:

- `Key`, which is formed by:

  - `Name`, composed of a `String` value as the local name and an optional `Namespace`.

  - `Attributes`, a collection of zero or more `Name:value` pairs, where `value` can be any possible
    value.

- `Value`, comprising any supported type, including another object, a function call, or an array.

To declare an object, use braces (`{` and `}`) to enclose a comma-separated list of `Key:value`
pairs:

```dataweave
{
  keyName @(keyAttributeName :"keyAttributeValue"): "value",
  User @(role:"admin"): upper("max the mule"),
  myArray: [1,2,3]
}
```

Objects also support the definition of conditional elements:

```dataweave
{
 (userName: name) if !isBlank(name),
 (userRole: role) if !isBlank(role)
}
```

## Functional Programming Principles

The functional programming paradigm enables developers to build applications by using pure function
composition and immutable data. Because functional programming is declarative, functions in
DataWeave are just expressions that return a value, instead of imperative statements that change
program states.

DataWeave follows the core principles of functional programming, including pure functions,
first-class functions, high-order functions, function composition, lambda expressions, and immutable
data.

### Pure Functions

Pure functions in programming are similar to pure functions in mathematics in that, given a certain
input, they always return the same output. Also, executing a function has no impact on other parts
of a program, other than producing a result. All functions in DataWeave are pure; they are not
affected by external values that could change the result of the execution.

### First-Class Functions

The pure functions in DataWeave are also “first-class citizens” in that they support operations that
are available to any other data type, including being stored in variables, passed as parameters, and
returned as results.

### High-Order Functions

High-order functions in programming also have the same concept as in mathematics. These functions
take one or more functions as parameters and return a function as a result. The result of a
high-order function can then be used as an input parameter in another function, enabling the concept
of _function composition_.

### Function Composition

Function composition is the process by which functions are combined to build complex operations. In
this case, the result of executing one function serves as an input parameter for the next function.
In DataWeave, all data transformations are a chain of expressions, functions composed to obtain a
final result that outputs the data as needed.

#### Example of Function Composition

The following example uses the function `pluck` to map an object into an array. Then the resulting
array serves as input for the function `filter`, which selects the elements in the array that have a
`Role` equal to `ADMIN`. During the mapping process, the function `upper` transforms the `role`
value:

```dataweave
%dw 2.0
output application/json
var collaborators =
{
    Max: {role: "admin", id: "01"},
    Einstein: {role: "dev", id: "02"},
    Astro: {role: "admin", id: "03"},
    Blaze: {role: "user", id: "04"}
}
---
collaborators pluck ((value,key,index)->  {
        "Name": key,
        "Role": upper(value.role),
        "ID": value.id
    })
    filter ((item, index) -> item.Role == "ADMIN")
```

The following example shows the same expression, but it uses prefix notation. This syntax helps
visualize how `filter` takes as the first parameter the result of `pluck`.

```dataweave
%dw 2.0
output application/json
var collaborators =
{
    Max: {role: "admin", id: "01"},
    Einstein: {role: "dev", id: "02"},
    Astro: {role: "admin", id: "03"},
    Blaze: {role: "user", id: "04"}
}
---
filter(
   pluck(
       collaborators, (value,key,index)->
       {
           "Name": key,
           "Role": upper(value.role),
           "ID": value.id
       }),
   (item, index) -> item.Role == "ADMIN")
```

The output of both expressions is:

```dataweave
[
  {
    "Name": "Max",
    "Role": "ADMIN",
    "ID": "01"
  },
  {
    "Name": "Astro",
    "Role": "ADMIN",
    "ID": "03"
  }
]
```

### Lambda Expressions

Lambda expressions, also known as _anonymous functions_ or _function literals_, are function
definitions that do not have an identifier name and can be passed as parameters to high-order
functions. Lambda syntax is expressed in the form `(a,b) → c`, which can be read as “Given a certain
input (`a` and `b`), execute the following (`c`).”

For example, the `map` function in DataWeave accepts a lambda expression as one of its parameters:
`map(Array<T>, (item: T, index: Number) → R): Array<R>`. `map` iterates over the items in an array
and executes the lambda expression that is passed as a parameter. This lambda expression consists of
two parameters that represent the value (`item`) and index (`index`) of each array element during
the execution, and a function definition to execute during the iteration `R`.

The following code example shows a `map` function that receives a lambda expression to concatenate
the index and the value of each element in the array it iterates on, and then returns these values
as a new array:

Source

```dataweave
%dw 2.0
output application/json
---
["Max", "the", "Mule"] map (item, index) -> index ++ " - " ++ item
```

Output

```dataweave
[
    "0 - Max",
    "1 - the",
    "2 - Mule"
]
```

See [Work with Functions and Lambdas in DataWeave](https://docs.mulesoft.com/dataweave/latest/dataweave-functions-lambdas) for additional
information about Lambda expressions.

### Immutable Data

In DataWeave, variables cannot change their assigned value after they are defined. This ensures that
there are no unexpected results from executing functions. If you want to store a new value that is
the result of an operation, you must declare a new data structure.

## Differences with Imperative Programming

If you have a development background in working with object-oriented programming languages, it is
important to understand that functional programming separates data from functions and does not use
loop control statements.

### Separation of Data and Functions

DataWeave does not use assignment statements, which ensures that data remains immutable. Because
there are no getter and setter methods, nor classes containing data structures and behavior, each
function works only with the data you provide as input. If you need to modify any existing data
structure, you create a new copy and apply functions to modify its values.

### Control Flow Statements

There are no loop control statements like `for` or `while` in DataWeave. In DataWeave, instead of
defining how to execute a procedure using iteration, you focus on your current requirements when you
write the expressions.

For example, to make changes to a list, you use the `map` function to apply changes to the elements
in the collection. Additionally, you can use the `filter` function to remove specific elements from
a list, or the `reduce` function to collapse all values from an array into one single value.

However, you can use `if-else` statements to apply a condition when executing an expression:

```dataweave
%dw 2.0
var myVar = { country : "FRANCE" }
output application/json
---
if (myVar.country == "USA")
  { currency: "USD" }
else { currency: "EUR" }
```

#### DataWeave Examples

For usage examples of `map`, `reduce`, and `filter`, see:

- [Map Data with DataWeave](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-map)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-conditional-list-reduction-via-function)

- [Merge Fields from Separate Objects](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-merge-multiple-payloads)

## See Also

- [Mule Message Structure](https://docs.mulesoft.com/mule-runtime/latest/about-mule-message)

- [Mule Events](https://docs.mulesoft.com/mule-runtime/latest/about-mule-event)

- [Core Components](https://docs.mulesoft.com/mule-runtime/latest/about-components)

- [Connectors and Modules](https://docs.mulesoft.com/connectors/)

- [Transform Message Component](https://docs.mulesoft.com/mule-runtime/latest/transform-component-about)

<!-- document id=b9a105351e19556d472134f1d12ecc44bb4ef2f2459d913300ce6350d64a1e4e url=/mulesoft/current/en-us/dataweave/2.11/dataweave-logging-configuration.md -->

---
product: DataWeave
version: 2.11
---

# DataWeave Logging Configuration

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Get granular control over DataWeave logging to debug and monitor your data transformations with
precision.

Starting with DataWeave 2.10, you can configure logging to control the verbosity of log messages
using standard log levels: `Debug`, `Info`, `Warn`, and `Error`. You can filter log messages by
severity and scope, which makes it easier to troubleshoot and monitor your DataWeave code.

## Configuration Location

Define the logging configuration in a DataWeave language file named `log-config.dwl`. Place this
file in the classpath at the root level.

Use the `DataWeaveScriptingEngine` API to customize the name, location, and format of the
configuration file by either implementing the `LoggingConfigurationSourceProvider` interface or by
using the `DefaultLoggingConfigurationSourceProvider` helper class.

> [!NOTE] The `DataWeaveScriptingEngine` API is available only when running DataWeave outside of
> Mule runtime. If you’re using Mule runtime, configure logging only with the `log-config.dwl` file
> and, if needed, the `log4j2.xml` configuration file.

The DataWeave code in this example retrieves the logging configuration in JSON format from a custom
classpath location.

```java
DataWeaveScriptingEngine engine = new DataWeaveScriptingEngine();
engine.withLoggingConfigurationSourceProvider(
  new DefaultLoggingConfigurationSourceProvider("classpath://org/acme/my-log-config.json")
);
```

## Configuration Structure

The `log-config.dwl` file contains an array of objects. Each object defines a logging rule with
these properties:

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Property</th><th>Description</th><th>Required for Scope</th><th>Possible Values</th></tr></thead><tbody><tr><td><div><div><p><code>scope</code></p></div></div></td><td><div><div><p>Specifies the scope of the logging rule.</p></div></div></td><td><div><div><p>Always required</p></div></div></td><td><div><div><p><code>Runtime</code> (applies to all DataWeave executions), <code>Module</code> (applies to all code within a specific module), and <code>Function</code> (applies to a specific function within a module)</p></div></div></td></tr><tr><td><div><div><p><code>level</code></p></div></div></td><td><div><div><p>Specifies the log level.</p></div></div></td><td><div><div><p>Always required</p></div></div></td><td><div><div><p><code>Debug</code>, <code>Info</code>, <code>Warn</code>, and <code>Error</code></p></div></div></td></tr><tr><td><div><div><p><code>module</code></p></div></div></td><td><div><div><p>Specifies the name of the DataWeave module.</p></div></div></td><td><div><div><p>Optional but required for <code>Module</code> and <code>Function</code></p></div></div></td><td><div><div><p>Any valid DataWeave module name</p></div></div></td></tr><tr><td><div><div><p><code>function</code></p></div></div></td><td><div><div><p>Specifies the name of the DataWeave function within the specified module.</p></div></div></td><td><div><div><p>Optional but required for <code>Function</code></p></div></div></td><td><div><div><p>Any valid DataWeave function name</p></div></div></td></tr></tbody></table>

## Example: Configuring Log Levels

This configuration sets three logging rules. The first rule sets the default log level for the
entire runtime to `Warn`, so only `Warn` and `Error` messages are logged unless a more specific rule
overrides it. The second rule sets the log level for the module `MyModule` to `Info`, which
overrides the runtime level and logs `Info`, `Warn`, and `Error` messages for all functions in
`MyModule`. The third rule sets the log level for the function `test` in `MyModule` to `Debug`,
which overrides both the module and runtime levels and logs all messages for this function.

```json
[
  {
    "scope": "Runtime",
    "level": "Warn"
  },
  {
    "scope": "Module",
    "module": "MyModule",
    "level": "Info"
  },
  {
    "scope": "Function",
    "module": "MyModule",
    "function": "test",
    "level": "Debug"
  }
]
```

## DataWeave Logging Functions

The DataWeave Core library provides these functions for logging messages:

<table><colgroup><col> <col></colgroup><thead><tr><th>Function</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>logWith&lt;T&gt;(level: LogLevel, prefix: String, value: T): T</code></p></div></div></td><td><div><div><p>Base function that provides the most flexibility. It takes a log level, an optional prefix, and a value to log, and returns the value.</p></div></div></td></tr><tr><td><div><div><p><code>logDebug&lt;T&gt;(prefix: String = "", value: T): T</code></p></div></div></td><td><div><div><p>Logs a message with the <code>Debug</code> level.</p></div></div></td></tr><tr><td><div><div><p><code>logInfo&lt;T&gt;(prefix: String = "", value: T): T</code></p></div></div></td><td><div><div><p>Logs a message with the <code>Info</code> level.</p></div></div></td></tr><tr><td><div><div><p><code>logWarn&lt;T&gt;(prefix: String = "", value: T): T</code></p></div></div></td><td><div><div><p>Logs a message with the <code>Warn</code> level.</p></div></div></td></tr><tr><td><div><div><p><code>logError&lt;T&gt;(prefix: String = "", value: T): T</code></p></div></div></td><td><div><div><p>Logs a message with the <code>Error</code> level.</p></div></div></td></tr><tr><td><div><div><p><code>log&lt;T&gt;(prefix: String = "", value: T): T</code></p></div></div></td><td><div><div><p>Logs a message with the <code>Info</code> level (shorthand for <code>logInfo</code>).</p></div></div></td></tr></tbody></table>

## Considerations

- Place the `log-config.dwl` file in the classpath for the configuration to take effect.

- Log levels are hierarchical. `Error` is the highest level, followed by `Warn`, `Info`, and
  `Debug`.

- More specific rules (for example, function-level rules) override less specific ones (for example,
  runtime-level rules).

- Use the `prefix` parameter in log functions to add context to your log messages.

- In Mule runtime, the default logging level shows only `Warn` and `Error` messages.

  To enable more detailed messages (`Info` or `Debug`), add a custom logger entry to your
  `log4j2.xml` configuration file in the `$MULE_HOME/conf/` directory.

  To enable `Debug` logging for DataWeave messages, add a custom logger entry to your `log4j2.xml`
  configuration file:

  ```xml
  <AsyncLogger name="org.mule.weave.v2.model.service.DefaultLoggingService$" level="DEBUG"/>
  ```

## See Also

- [Core (dw::Core)](https://docs.mulesoft.com/dataweave/2.11/dw-core)

<!-- document id=4b8984a1e5c32a23e057f012aebb46cb45027e7fa1638c70502e065329b475f1 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-logging-configuration.md -->

---
product: DataWeave
version: 2.12
---

# DataWeave Logging Configuration

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Get granular control over DataWeave logging to debug and monitor your data transformations with
precision.

Starting with DataWeave 2.10, you can configure logging to control the verbosity of log messages
using standard log levels: `Debug`, `Info`, `Warn`, and `Error`. You can filter log messages by
severity and scope, which makes it easier to troubleshoot and monitor your DataWeave code.

## Configuration Location

Define the logging configuration in a DataWeave language file named `log-config.dwl`. Place this
file in the classpath at the root level.

Use the `DataWeaveScriptingEngine` API to customize the name, location, and format of the
configuration file by either implementing the `LoggingConfigurationSourceProvider` interface or by
using the `DefaultLoggingConfigurationSourceProvider` helper class.

> [!NOTE] The `DataWeaveScriptingEngine` API is available only when running DataWeave outside of
> Mule runtime. If you’re using Mule runtime, configure logging only with the `log-config.dwl` file
> and, if needed, the `log4j2.xml` configuration file.

The DataWeave code in this example retrieves the logging configuration in JSON format from a custom
classpath location.

```java
DataWeaveScriptingEngine engine = new DataWeaveScriptingEngine();
engine.withLoggingConfigurationSourceProvider(
  new DefaultLoggingConfigurationSourceProvider("classpath://org/acme/my-log-config.json")
);
```

## Configuration Structure

The `log-config.dwl` file contains an array of objects. Each object defines a logging rule with
these properties:

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Property</th><th>Description</th><th>Required for Scope</th><th>Possible Values</th></tr></thead><tbody><tr><td><div><div><p><code>scope</code></p></div></div></td><td><div><div><p>Specifies the scope of the logging rule.</p></div></div></td><td><div><div><p>Always required</p></div></div></td><td><div><div><p><code>Runtime</code> (applies to all DataWeave executions), <code>Module</code> (applies to all code within a specific module), and <code>Function</code> (applies to a specific function within a module)</p></div></div></td></tr><tr><td><div><div><p><code>level</code></p></div></div></td><td><div><div><p>Specifies the log level.</p></div></div></td><td><div><div><p>Always required</p></div></div></td><td><div><div><p><code>Debug</code>, <code>Info</code>, <code>Warn</code>, and <code>Error</code></p></div></div></td></tr><tr><td><div><div><p><code>module</code></p></div></div></td><td><div><div><p>Specifies the name of the DataWeave module.</p></div></div></td><td><div><div><p>Optional but required for <code>Module</code> and <code>Function</code></p></div></div></td><td><div><div><p>Any valid DataWeave module name</p></div></div></td></tr><tr><td><div><div><p><code>function</code></p></div></div></td><td><div><div><p>Specifies the name of the DataWeave function within the specified module.</p></div></div></td><td><div><div><p>Optional but required for <code>Function</code></p></div></div></td><td><div><div><p>Any valid DataWeave function name</p></div></div></td></tr></tbody></table>

## Example: Configuring Log Levels

This configuration sets three logging rules. The first rule sets the default log level for the
entire runtime to `Warn`, so only `Warn` and `Error` messages are logged unless a more specific rule
overrides it. The second rule sets the log level for the module `MyModule` to `Info`, which
overrides the runtime level and logs `Info`, `Warn`, and `Error` messages for all functions in
`MyModule`. The third rule sets the log level for the function `test` in `MyModule` to `Debug`,
which overrides both the module and runtime levels and logs all messages for this function.

```json
[
  {
    "scope": "Runtime",
    "level": "Warn"
  },
  {
    "scope": "Module",
    "module": "MyModule",
    "level": "Info"
  },
  {
    "scope": "Function",
    "module": "MyModule",
    "function": "test",
    "level": "Debug"
  }
]
```

## DataWeave Logging Functions

The DataWeave Core library provides these functions for logging messages:

<table><colgroup><col> <col></colgroup><thead><tr><th>Function</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>logWith&lt;T&gt;(level: LogLevel, prefix: String, value: T): T</code></p></div></div></td><td><div><div><p>Base function that provides the most flexibility. It takes a log level, an optional prefix, and a value to log, and returns the value.</p></div></div></td></tr><tr><td><div><div><p><code>logDebug&lt;T&gt;(prefix: String = "", value: T): T</code></p></div></div></td><td><div><div><p>Logs a message with the <code>Debug</code> level.</p></div></div></td></tr><tr><td><div><div><p><code>logInfo&lt;T&gt;(prefix: String = "", value: T): T</code></p></div></div></td><td><div><div><p>Logs a message with the <code>Info</code> level.</p></div></div></td></tr><tr><td><div><div><p><code>logWarn&lt;T&gt;(prefix: String = "", value: T): T</code></p></div></div></td><td><div><div><p>Logs a message with the <code>Warn</code> level.</p></div></div></td></tr><tr><td><div><div><p><code>logError&lt;T&gt;(prefix: String = "", value: T): T</code></p></div></div></td><td><div><div><p>Logs a message with the <code>Error</code> level.</p></div></div></td></tr><tr><td><div><div><p><code>log&lt;T&gt;(prefix: String = "", value: T): T</code></p></div></div></td><td><div><div><p>Logs a message with the <code>Info</code> level (shorthand for <code>logInfo</code>).</p></div></div></td></tr></tbody></table>

## Considerations

- Place the `log-config.dwl` file in the classpath for the configuration to take effect.

- Log levels are hierarchical. `Error` is the highest level, followed by `Warn`, `Info`, and
  `Debug`.

- More specific rules (for example, function-level rules) override less specific ones (for example,
  runtime-level rules).

- Use the `prefix` parameter in log functions to add context to your log messages.

- In Mule runtime, the default logging level shows only `Warn` and `Error` messages.

  To enable more detailed messages (`Info` or `Debug`), add a custom logger entry to your
  `log4j2.xml` configuration file in the `$MULE_HOME/conf/` directory.

  To enable `Debug` logging for DataWeave messages, add a custom logger entry to your `log4j2.xml`
  configuration file:

  ```xml
  <AsyncLogger name="org.mule.weave.v2.model.service.DefaultLoggingService$" level="DEBUG"/>
  ```

## See Also

- [Core (dw::Core)](https://docs.mulesoft.com/dataweave/2.12/dw-core)

<!-- document id=508cebd2e92537678134c07d5da2ab5d7c81d1ad80a9893085cff686089fd692 url=/mulesoft/current/en-us/dataweave/latest/dataweave-logging-configuration.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# DataWeave Logging Configuration

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Get granular control over DataWeave logging to debug and monitor your data transformations with
precision.

Starting with DataWeave 2.10, you can configure logging to control the verbosity of log messages
using standard log levels: `Debug`, `Info`, `Warn`, and `Error`. You can filter log messages by
severity and scope, which makes it easier to troubleshoot and monitor your DataWeave code.

## Configuration Location

Define the logging configuration in a DataWeave language file named `log-config.dwl`. Place this
file in the classpath at the root level.

Use the `DataWeaveScriptingEngine` API to customize the name, location, and format of the
configuration file by either implementing the `LoggingConfigurationSourceProvider` interface or by
using the `DefaultLoggingConfigurationSourceProvider` helper class.

> [!NOTE] The `DataWeaveScriptingEngine` API is available only when running DataWeave outside of
> Mule runtime. If you’re using Mule runtime, configure logging only with the `log-config.dwl` file
> and, if needed, the `log4j2.xml` configuration file.

The DataWeave code in this example retrieves the logging configuration in JSON format from a custom
classpath location.

```java
DataWeaveScriptingEngine engine = new DataWeaveScriptingEngine();
engine.withLoggingConfigurationSourceProvider(
  new DefaultLoggingConfigurationSourceProvider("classpath://org/acme/my-log-config.json")
);
```

## Configuration Structure

The `log-config.dwl` file contains an array of objects. Each object defines a logging rule with
these properties:

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Property</th><th>Description</th><th>Required for Scope</th><th>Possible Values</th></tr></thead><tbody><tr><td><div><div><p><code>scope</code></p></div></div></td><td><div><div><p>Specifies the scope of the logging rule.</p></div></div></td><td><div><div><p>Always required</p></div></div></td><td><div><div><p><code>Runtime</code> (applies to all DataWeave executions), <code>Module</code> (applies to all code within a specific module), and <code>Function</code> (applies to a specific function within a module)</p></div></div></td></tr><tr><td><div><div><p><code>level</code></p></div></div></td><td><div><div><p>Specifies the log level.</p></div></div></td><td><div><div><p>Always required</p></div></div></td><td><div><div><p><code>Debug</code>, <code>Info</code>, <code>Warn</code>, and <code>Error</code></p></div></div></td></tr><tr><td><div><div><p><code>module</code></p></div></div></td><td><div><div><p>Specifies the name of the DataWeave module.</p></div></div></td><td><div><div><p>Optional but required for <code>Module</code> and <code>Function</code></p></div></div></td><td><div><div><p>Any valid DataWeave module name</p></div></div></td></tr><tr><td><div><div><p><code>function</code></p></div></div></td><td><div><div><p>Specifies the name of the DataWeave function within the specified module.</p></div></div></td><td><div><div><p>Optional but required for <code>Function</code></p></div></div></td><td><div><div><p>Any valid DataWeave function name</p></div></div></td></tr></tbody></table>

## Example: Configuring Log Levels

This configuration sets three logging rules. The first rule sets the default log level for the
entire runtime to `Warn`, so only `Warn` and `Error` messages are logged unless a more specific rule
overrides it. The second rule sets the log level for the module `MyModule` to `Info`, which
overrides the runtime level and logs `Info`, `Warn`, and `Error` messages for all functions in
`MyModule`. The third rule sets the log level for the function `test` in `MyModule` to `Debug`,
which overrides both the module and runtime levels and logs all messages for this function.

```json
[
  {
    "scope": "Runtime",
    "level": "Warn"
  },
  {
    "scope": "Module",
    "module": "MyModule",
    "level": "Info"
  },
  {
    "scope": "Function",
    "module": "MyModule",
    "function": "test",
    "level": "Debug"
  }
]
```

## DataWeave Logging Functions

The DataWeave Core library provides these functions for logging messages:

<table><colgroup><col> <col></colgroup><thead><tr><th>Function</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>logWith&lt;T&gt;(level: LogLevel, prefix: String, value: T): T</code></p></div></div></td><td><div><div><p>Base function that provides the most flexibility. It takes a log level, an optional prefix, and a value to log, and returns the value.</p></div></div></td></tr><tr><td><div><div><p><code>logDebug&lt;T&gt;(prefix: String = "", value: T): T</code></p></div></div></td><td><div><div><p>Logs a message with the <code>Debug</code> level.</p></div></div></td></tr><tr><td><div><div><p><code>logInfo&lt;T&gt;(prefix: String = "", value: T): T</code></p></div></div></td><td><div><div><p>Logs a message with the <code>Info</code> level.</p></div></div></td></tr><tr><td><div><div><p><code>logWarn&lt;T&gt;(prefix: String = "", value: T): T</code></p></div></div></td><td><div><div><p>Logs a message with the <code>Warn</code> level.</p></div></div></td></tr><tr><td><div><div><p><code>logError&lt;T&gt;(prefix: String = "", value: T): T</code></p></div></div></td><td><div><div><p>Logs a message with the <code>Error</code> level.</p></div></div></td></tr><tr><td><div><div><p><code>log&lt;T&gt;(prefix: String = "", value: T): T</code></p></div></div></td><td><div><div><p>Logs a message with the <code>Info</code> level (shorthand for <code>logInfo</code>).</p></div></div></td></tr></tbody></table>

## Considerations

- Place the `log-config.dwl` file in the classpath for the configuration to take effect.

- Log levels are hierarchical. `Error` is the highest level, followed by `Warn`, `Info`, and
  `Debug`.

- More specific rules (for example, function-level rules) override less specific ones (for example,
  runtime-level rules).

- Use the `prefix` parameter in log functions to add context to your log messages.

- In Mule runtime, the default logging level shows only `Warn` and `Error` messages.

  To enable more detailed messages (`Info` or `Debug`), add a custom logger entry to your
  `log4j2.xml` configuration file in the `$MULE_HOME/conf/` directory.

  To enable `Debug` logging for DataWeave messages, add a custom logger entry to your `log4j2.xml`
  configuration file:

  ```xml
  <AsyncLogger name="org.mule.weave.v2.model.service.DefaultLoggingService$" level="DEBUG"/>
  ```

## See Also

- [Core (dw::Core)](https://docs.mulesoft.com/dataweave/latest/dw-core)

<!-- document id=fef311906f05f36b6fee0d0f3d5a9414e42664a0f1ce055662298d8188749133 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-memory-management.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, streaming, weaveoutputhandler
---

# DataWeave Memory Management

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

When processing large files through DataWeave in Mule runtime engine, there are a few things you can
set up to fine-tune how much memory will be used and when.

## RAM vs Disk Usage

DataWeave keeps small files in memory, but after a configurable threshold uses disk space to avoid
running out of memory. The created buffer files are placed in a default temporary directory. If you
want to store those files in a custom directory instead, you can specify the directory by using the
`java.io.tmpdir` property.

The buffer files remain in the temporary directory until the streams that reference the files are
closed. Closure normally occurs when flows complete their execution, so many buffer files in the
temporary folder can remain in use during long-running and concurrent executions.

Three types of DataWeave buffer files are generated:

- `dw-buffer-output-${count}.tmp`  
  Used to store the output of a transformation when the result is bigger than the threshold
  **1572864 bytes**. To change this threshold value, add the system property
  `com.mulesoft.dw.max_memory_allocation` and assign it the number of bytes you want as your new
  threshold. Mule runtime engine deletes the file when the value is no longer referenced, JVM GC
  collects it or when the Mule Event finishes executing.

- `dw-buffer-input-${count}.tmp`  
  Used to store the input of a transformation when it is bigger than the in-memory buffer, which is
  **1572864 bytes** by default. This is analogous to the `dw-buffer-output-${count}.tmp` file, but
  for input data.

- `dw-buffer-index-${count}.tmp`  
  Used to store index information of a value being read. This file helps DataWeave access data
  quickly. Mule runtime engine deletes the file when the execution of the transformation ends or, in
  a streaming use case like the foreach loop, when the stream ends (when foreach finishes its
  execution).

System properties:  
Because you can define system properties in several ways, see
[system properties](https://docs.mulesoft.com/mule-runtime/latest/configuring-properties#system-properties) for further
details.

- `com.mulesoft.dw.buffersize`  
  This system property determines the size in bytes of the in-memory input and output buffers used
  in DataWeave to keep the processed inputs and outputs. The default buffer size is 8192 bytes (8
  KB). This property receives a number (size in bytes), for example:
  `-Dcom.mulesoft.dw.buffersize=8192`.

- `com.mulesoft.dw.directbuffer.disable`  
  Introduced in Mule 4.2.2, this option controls whether DataWeave uses off-heap memory (the
  default) or heap memory. DataWeave uses off-heap memory for internal buffering. However, this
  setting can cause problems on machines that have only a small amount of memory. This property
  receives a boolean, for example: `-Dcom.mulesoft.dw.directbuffer.disable=true`.

- `com.mulesoft.dw.memory_pool_size`  
  Since Mule 4.3.0, DataWeave buffers use off-heap memory from a pool up to a defined size and
  allocates the rest using heap memory. This property determines the number of slots in the pool.
  The default number of slots is 60. This property receives a number (slots in the pool), for
  example: `-Dcom.mulesoft.dw.memory_pool_size=60`.

- `com.mulesoft.dw.max_memory_allocation`  
  Introduced in Mule 4.3.0, this property determines the maximum amount of memory to be used before
  it switches to disk. If a payload exceeds this size, it is stored in
  `dw-buffer-input-${count}.tmp` and `dw-buffer-output-${count}.tmp` temporary files. It also
  determines the size in bytes of each slot in the pool of off-heap memory. The default size is
  1572864 bytes (1.5 MB). This property receives a number (size in bytes), for example:
  `-Dcom.mulesoft.dw.max_memory_allocation=1572864`.

- `com.mulesoft.dw.buffer.memory.monitoring` (experimental)  
  Introduced in Mule 4.3.0, when this property is enabled, a message is logged each time a slot from
  the memory pool is taken or released. Note that it may be removed or change its behavior in future
  versions. This property receives a boolean, for example:
  `-Dcom.mulesoft.dw.buffer.memory.monitoring=true`.

- `mule.weave.script.parser.cache.size`  
  This system property determines the maximum size of compiled scripts that are being cached. The
  default value is 10.000.

- `com.mulesoft.dw.charbuffersize`  
  This system property determines the size (in bytes) of the buffer used by the writter. The default
  value is 4.096.

## See Also

- [DataWeave Scripts](https://docs.mulesoft.com/dataweave/2.11/dataweave-language-introduction)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.11/dataweave-selectors)

<!-- document id=1533ce4689402f3fe4ba7412631ab3e5ee29b46a977962246acc1c29409ada69 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-memory-management.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, streaming, weaveoutputhandler
---

# DataWeave Memory Management

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

When processing large files through DataWeave in Mule runtime engine, there are a few things you can
set up to fine-tune how much memory will be used and when.

## RAM vs Disk Usage

DataWeave keeps small files in memory, but after a configurable threshold uses disk space to avoid
running out of memory. The created buffer files are placed in a default temporary directory. If you
want to store those files in a custom directory instead, you can specify the directory by using the
`java.io.tmpdir` property.

The buffer files remain in the temporary directory until the streams that reference the files are
closed. Closure normally occurs when flows complete their execution, so many buffer files in the
temporary folder can remain in use during long-running and concurrent executions.

Three types of DataWeave buffer files are generated:

- `dw-buffer-output-${count}.tmp`  
  Used to store the output of a transformation when the result is bigger than the threshold
  **1572864 bytes**. To change this threshold value, add the system property
  `com.mulesoft.dw.max_memory_allocation` and assign it the number of bytes you want as your new
  threshold. Mule runtime engine deletes the file when the value is no longer referenced, JVM GC
  collects it or when the Mule Event finishes executing.

- `dw-buffer-input-${count}.tmp`  
  Used to store the input of a transformation when it is bigger than the in-memory buffer, which is
  **1572864 bytes** by default. This is analogous to the `dw-buffer-output-${count}.tmp` file, but
  for input data.

- `dw-buffer-index-${count}.tmp`  
  Used to store index information of a value being read. This file helps DataWeave access data
  quickly. Mule runtime engine deletes the file when the execution of the transformation ends or, in
  a streaming use case like the foreach loop, when the stream ends (when foreach finishes its
  execution).

System properties:  
Because you can define system properties in several ways, see
[system properties](https://docs.mulesoft.com/mule-runtime/latest/configuring-properties#system-properties) for further
details.

- `com.mulesoft.dw.buffersize`  
  This system property determines the size in bytes of the in-memory input and output buffers used
  in DataWeave to keep the processed inputs and outputs. The default buffer size is 8192 bytes (8
  KB). This property receives a number (size in bytes), for example:
  `-Dcom.mulesoft.dw.buffersize=8192`.

- `com.mulesoft.dw.directbuffer.disable`  
  Introduced in Mule 4.2.2, this option controls whether DataWeave uses off-heap memory (the
  default) or heap memory. DataWeave uses off-heap memory for internal buffering. However, this
  setting can cause problems on machines that have only a small amount of memory. This property
  receives a boolean, for example: `-Dcom.mulesoft.dw.directbuffer.disable=true`.

- `com.mulesoft.dw.memory_pool_size`  
  Since Mule 4.3.0, DataWeave buffers use off-heap memory from a pool up to a defined size and
  allocates the rest using heap memory. This property determines the number of slots in the pool.
  The default number of slots is 60. This property receives a number (slots in the pool), for
  example: `-Dcom.mulesoft.dw.memory_pool_size=60`.

- `com.mulesoft.dw.max_memory_allocation`  
  Introduced in Mule 4.3.0, this property determines the maximum amount of memory to be used before
  it switches to disk. If a payload exceeds this size, it is stored in
  `dw-buffer-input-${count}.tmp` and `dw-buffer-output-${count}.tmp` temporary files. It also
  determines the size in bytes of each slot in the pool of off-heap memory. The default size is
  1572864 bytes (1.5 MB). This property receives a number (size in bytes), for example:
  `-Dcom.mulesoft.dw.max_memory_allocation=1572864`.

- `com.mulesoft.dw.buffer.memory.monitoring` (experimental)  
  Introduced in Mule 4.3.0, when this property is enabled, a message is logged each time a slot from
  the memory pool is taken or released. Note that it may be removed or change its behavior in future
  versions. This property receives a boolean, for example:
  `-Dcom.mulesoft.dw.buffer.memory.monitoring=true`.

- `mule.weave.script.parser.cache.size`  
  This system property determines the maximum size of compiled scripts that are being cached. The
  default value is 10.000.

- `com.mulesoft.dw.charbuffersize`  
  This system property determines the size (in bytes) of the buffer used by the writter. The default
  value is 4.096.

## See Also

- [DataWeave Scripts](https://docs.mulesoft.com/dataweave/2.12/dataweave-language-introduction)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.12/dataweave-selectors)

<!-- document id=1fe66f6fd5e3366822e71324484886c956d13aa2410ce7b8462eba266bbecacb url=/mulesoft/current/en-us/dataweave/2.3/dataweave-memory-management.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, streaming, weaveoutputhandler
---

# DataWeave Memory Management

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

When processing large files through DataWeave in Mule runtime engine, there are a few things you can
set up to fine-tune how much memory will be used and when.

## RAM vs Disk Usage

DataWeave keeps small files in memory, but after a configurable threshold uses disk space to avoid
running out of memory. The created buffer files are placed in a default temporary directory. If you
want to store those files in a custom directory instead, you can specify the directory by using the
`java.io.tmpdir` property.

Three types of DataWeave buffer files are generated:

- `dw-buffer-output-${count}.tmp`  
  Used to store the output of a transformation when the result is bigger than the threshold
  **1572864 bytes**. To change this threshold value, add the system property
  `com.mulesoft.dw.max_memory_allocation` and assign it the number of bytes you want as your new
  threshold. Mule runtime engine deletes the file when the value is no longer referenced, JVM GC
  collects it or when the Mule Event finishes executing.

- `dw-buffer-input-${count}.tmp`  
  Used to store the input of a transformation when it is bigger than the in-memory buffer, which is
  **1572864 bytes** by default. This is analogous to the `dw-buffer-output-${count}.tmp` file, but
  for input data.

- `dw-buffer-index-${count}.tmp`  
  Used to store index information of a value being read. This file helps DataWeave access data
  quickly. Mule runtime engine deletes the file when the execution of the transformation ends or, in
  a streaming use case like the foreach loop, when the stream ends (when foreach finishes its
  execution).

System properties:  
Because you can define system properties in several ways, see
[system properties](https://docs.mulesoft.com/mule-runtime/4.3/configuring-properties#system-properties) for further
details.

- `com.mulesoft.dw.buffersize`  
  This system property determines the size in bytes of the in-memory input and output buffers used
  in DataWeave to keep the processed inputs and outputs. The default buffer size is 8192 bytes (8
  KB). This property receives a number (size in bytes), for example:
  `-Dcom.mulesoft.dw.buffersize=8192`.

- `com.mulesoft.dw.directbuffer.disable`  
  Introduced in Mule 4.2.2, this option controls whether DataWeave uses off-heap memory (the
  default) or heap memory. DataWeave uses off-heap memory for internal buffering. However, this
  setting can cause problems on machines that have only a small amount of memory. This property
  receives a boolean, for example: `-Dcom.mulesoft.dw.directbuffer.disable=true`.

- `com.mulesoft.dw.memory_pool_size`  
  Since Mule 4.3.0, DataWeave buffers use off-heap memory from a pool up to a defined size and
  allocates the rest using heap memory. This property determines the number of slots in the pool.
  The default number of slots is 60. This property receives a number (slots in the pool), for
  example: `-Dcom.mulesoft.dw.memory_pool_size=60`.

- `com.mulesoft.dw.max_memory_allocation`  
  Introduced in Mule 4.3.0, this property determines the maximum amount of memory to be used before
  it switches to disk. If a payload exceeds this size, it is stored in
  `dw-buffer-input-${count}.tmp` and `dw-buffer-output-${count}.tmp` temporary files. It also
  determines the size in bytes of each slot in the pool of off-heap memory. The default size is
  1572864 bytes (1.5 MB).

- `com.mulesoft.dw.buffer.memory.monitoring` (experimental)  
  Introduced in Mule 4.3.0, when this property is enabled, a message is logged each time a slot from
  the memory pool is taken or released. Note that it may be removed or change its behavior in future
  versions. This property receives a boolean, for example:
  `-Dcom.mulesoft.dw.buffer.memory.monitoring=true`.

## See Also

- [DataWeave Scripts](https://docs.mulesoft.com/dataweave/2.3/dataweave-language-introduction)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.3/dataweave-selectors)

<!-- document id=6a7da8d66ffb8ab696760ada9891ef344b5ccebbc89a701e4d78b6cc7d43241a url=/mulesoft/current/en-us/dataweave/2.4/dataweave-memory-management.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, streaming, weaveoutputhandler
---

# DataWeave Memory Management

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

When processing large files through DataWeave in Mule runtime engine, there are a few things you can
set up to fine-tune how much memory will be used and when.

## RAM vs Disk Usage

DataWeave keeps small files in memory, but after a configurable threshold uses disk space to avoid
running out of memory. The created buffer files are placed in a default temporary directory. If you
want to store those files in a custom directory instead, you can specify the directory by using the
`java.io.tmpdir` property.

The buffer files remain in the temporary directory until the streams that reference the files are
closed. Closure normally occurs when flows complete their execution, so many buffer files in the
temporary folder can remain in use during long-running and concurrent executions.

Three types of DataWeave buffer files are generated:

- `dw-buffer-output-${count}.tmp`  
  Used to store the output of a transformation when the result is bigger than the threshold
  **1572864 bytes**. To change this threshold value, add the system property
  `com.mulesoft.dw.max_memory_allocation` and assign it the number of bytes you want as your new
  threshold. Mule runtime engine deletes the file when the value is no longer referenced, JVM GC
  collects it or when the Mule Event finishes executing.

- `dw-buffer-input-${count}.tmp`  
  Used to store the input of a transformation when it is bigger than the in-memory buffer, which is
  **1572864 bytes** by default. This is analogous to the `dw-buffer-output-${count}.tmp` file, but
  for input data.

- `dw-buffer-index-${count}.tmp`  
  Used to store index information of a value being read. This file helps DataWeave access data
  quickly. Mule runtime engine deletes the file when the execution of the transformation ends or, in
  a streaming use case like the foreach loop, when the stream ends (when foreach finishes its
  execution).

System properties:  
Because you can define system properties in several ways, see
[system properties](https://docs.mulesoft.com/mule-runtime/latest/configuring-properties#system-properties) for further
details.

- `com.mulesoft.dw.buffersize`  
  This system property determines the size in bytes of the in-memory input and output buffers used
  in DataWeave to keep the processed inputs and outputs. The default buffer size is 8192 bytes (8
  KB). This property receives a number (size in bytes), for example:
  `-Dcom.mulesoft.dw.buffersize=8192`.

- `com.mulesoft.dw.directbuffer.disable`  
  Introduced in Mule 4.2.2, this option controls whether DataWeave uses off-heap memory (the
  default) or heap memory. DataWeave uses off-heap memory for internal buffering. However, this
  setting can cause problems on machines that have only a small amount of memory. This property
  receives a boolean, for example: `-Dcom.mulesoft.dw.directbuffer.disable=true`.

- `com.mulesoft.dw.memory_pool_size`  
  Since Mule 4.3.0, DataWeave buffers use off-heap memory from a pool up to a defined size and
  allocates the rest using heap memory. This property determines the number of slots in the pool.
  The default number of slots is 60. This property receives a number (slots in the pool), for
  example: `-Dcom.mulesoft.dw.memory_pool_size=60`.

- `com.mulesoft.dw.max_memory_allocation`  
  Introduced in Mule 4.3.0, this property determines the maximum amount of memory to be used before
  it switches to disk. If a payload exceeds this size, it is stored in
  `dw-buffer-input-${count}.tmp` and `dw-buffer-output-${count}.tmp` temporary files. It also
  determines the size in bytes of each slot in the pool of off-heap memory. The default size is
  1572864 bytes (1.5 MB). This property receives a number (size in bytes), for example:
  `-Dcom.mulesoft.dw.max_memory_allocation=1572864`.

- `com.mulesoft.dw.buffer.memory.monitoring` (experimental)  
  Introduced in Mule 4.3.0, when this property is enabled, a message is logged each time a slot from
  the memory pool is taken or released. Note that it may be removed or change its behavior in future
  versions. This property receives a boolean, for example:
  `-Dcom.mulesoft.dw.buffer.memory.monitoring=true`.

- `mule.weave.script.parser.cache.size`  
  This system property determines the maximum size of compiled scripts that are being cached. The
  default value is 10.000.

- `com.mulesoft.dw.charbuffersize`  
  This system property determines the size (in bytes) of the buffer used by the writter. The default
  value is 4.096.

## See Also

- [DataWeave Scripts](https://docs.mulesoft.com/dataweave/2.4/dataweave-language-introduction)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.4/dataweave-selectors)

<!-- document id=c2fec23711320e679e0955ced5938b42fad6589b351b4309c3ee4d82e2253956 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-memory-management.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, streaming, weaveoutputhandler
---

# DataWeave Memory Management

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

When processing large files through DataWeave in Mule runtime engine, there are a few things you can
set up to fine-tune how much memory will be used and when.

## RAM vs Disk Usage

DataWeave keeps small files in memory, but after a configurable threshold uses disk space to avoid
running out of memory. The created buffer files are placed in a default temporary directory. If you
want to store those files in a custom directory instead, you can specify the directory by using the
`java.io.tmpdir` property.

The buffer files remain in the temporary directory until the streams that reference the files are
closed. Closure normally occurs when flows complete their execution, so many buffer files in the
temporary folder can remain in use during long-running and concurrent executions.

Three types of DataWeave buffer files are generated:

- `dw-buffer-output-${count}.tmp`  
  Used to store the output of a transformation when the result is bigger than the threshold
  **1572864 bytes**. To change this threshold value, add the system property
  `com.mulesoft.dw.max_memory_allocation` and assign it the number of bytes you want as your new
  threshold. Mule runtime engine deletes the file when the value is no longer referenced, JVM GC
  collects it or when the Mule Event finishes executing.

- `dw-buffer-input-${count}.tmp`  
  Used to store the input of a transformation when it is bigger than the in-memory buffer, which is
  **1572864 bytes** by default. This is analogous to the `dw-buffer-output-${count}.tmp` file, but
  for input data.

- `dw-buffer-index-${count}.tmp`  
  Used to store index information of a value being read. This file helps DataWeave access data
  quickly. Mule runtime engine deletes the file when the execution of the transformation ends or, in
  a streaming use case like the foreach loop, when the stream ends (when foreach finishes its
  execution).

System properties:  
Because you can define system properties in several ways, see
[system properties](https://docs.mulesoft.com/mule-runtime/latest/configuring-properties#system-properties) for further
details.

- `com.mulesoft.dw.buffersize`  
  This system property determines the size in bytes of the in-memory input and output buffers used
  in DataWeave to keep the processed inputs and outputs. The default buffer size is 8192 bytes (8
  KB). This property receives a number (size in bytes), for example:
  `-Dcom.mulesoft.dw.buffersize=8192`.

- `com.mulesoft.dw.directbuffer.disable`  
  Introduced in Mule 4.2.2, this option controls whether DataWeave uses off-heap memory (the
  default) or heap memory. DataWeave uses off-heap memory for internal buffering. However, this
  setting can cause problems on machines that have only a small amount of memory. This property
  receives a boolean, for example: `-Dcom.mulesoft.dw.directbuffer.disable=true`.

- `com.mulesoft.dw.memory_pool_size`  
  Since Mule 4.3.0, DataWeave buffers use off-heap memory from a pool up to a defined size and
  allocates the rest using heap memory. This property determines the number of slots in the pool.
  The default number of slots is 60. This property receives a number (slots in the pool), for
  example: `-Dcom.mulesoft.dw.memory_pool_size=60`.

- `com.mulesoft.dw.max_memory_allocation`  
  Introduced in Mule 4.3.0, this property determines the maximum amount of memory to be used before
  it switches to disk. If a payload exceeds this size, it is stored in
  `dw-buffer-input-${count}.tmp` and `dw-buffer-output-${count}.tmp` temporary files. It also
  determines the size in bytes of each slot in the pool of off-heap memory. The default size is
  1572864 bytes (1.5 MB). This property receives a number (size in bytes), for example:
  `-Dcom.mulesoft.dw.max_memory_allocation=1572864`.

- `com.mulesoft.dw.buffer.memory.monitoring` (experimental)  
  Introduced in Mule 4.3.0, when this property is enabled, a message is logged each time a slot from
  the memory pool is taken or released. Note that it may be removed or change its behavior in future
  versions. This property receives a boolean, for example:
  `-Dcom.mulesoft.dw.buffer.memory.monitoring=true`.

- `mule.weave.script.parser.cache.size`  
  This system property determines the maximum size of compiled scripts that are being cached. The
  default value is 10.000.

- `com.mulesoft.dw.charbuffersize`  
  This system property determines the size (in bytes) of the buffer used by the writter. The default
  value is 4.096.

## See Also

- [DataWeave Scripts](https://docs.mulesoft.com/dataweave/2.6/dataweave-language-introduction)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.6/dataweave-selectors)

<!-- document id=8eb919708fc5914ebff2d5fe37503a436149fb9dd10a219e97fadb7d20572dc0 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-memory-management.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, streaming, weaveoutputhandler
---

# DataWeave Memory Management

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

When processing large files through DataWeave in Mule runtime engine, there are a few things you can
set up to fine-tune how much memory will be used and when.

## RAM vs Disk Usage

DataWeave keeps small files in memory, but after a configurable threshold uses disk space to avoid
running out of memory. The created buffer files are placed in a default temporary directory. If you
want to store those files in a custom directory instead, you can specify the directory by using the
`java.io.tmpdir` property.

The buffer files remain in the temporary directory until the streams that reference the files are
closed. Closure normally occurs when flows complete their execution, so many buffer files in the
temporary folder can remain in use during long-running and concurrent executions.

Three types of DataWeave buffer files are generated:

- `dw-buffer-output-${count}.tmp`  
  Used to store the output of a transformation when the result is bigger than the threshold
  **1572864 bytes**. To change this threshold value, add the system property
  `com.mulesoft.dw.max_memory_allocation` and assign it the number of bytes you want as your new
  threshold. Mule runtime engine deletes the file when the value is no longer referenced, JVM GC
  collects it or when the Mule Event finishes executing.

- `dw-buffer-input-${count}.tmp`  
  Used to store the input of a transformation when it is bigger than the in-memory buffer, which is
  **1572864 bytes** by default. This is analogous to the `dw-buffer-output-${count}.tmp` file, but
  for input data.

- `dw-buffer-index-${count}.tmp`  
  Used to store index information of a value being read. This file helps DataWeave access data
  quickly. Mule runtime engine deletes the file when the execution of the transformation ends or, in
  a streaming use case like the foreach loop, when the stream ends (when foreach finishes its
  execution).

System properties:  
Because you can define system properties in several ways, see
[system properties](https://docs.mulesoft.com/mule-runtime/latest/configuring-properties#system-properties) for further
details.

- `com.mulesoft.dw.buffersize`  
  This system property determines the size in bytes of the in-memory input and output buffers used
  in DataWeave to keep the processed inputs and outputs. The default buffer size is 8192 bytes (8
  KB). This property receives a number (size in bytes), for example:
  `-Dcom.mulesoft.dw.buffersize=8192`.

- `com.mulesoft.dw.directbuffer.disable`  
  Introduced in Mule 4.2.2, this option controls whether DataWeave uses off-heap memory (the
  default) or heap memory. DataWeave uses off-heap memory for internal buffering. However, this
  setting can cause problems on machines that have only a small amount of memory. This property
  receives a boolean, for example: `-Dcom.mulesoft.dw.directbuffer.disable=true`.

- `com.mulesoft.dw.memory_pool_size`  
  Since Mule 4.3.0, DataWeave buffers use off-heap memory from a pool up to a defined size and
  allocates the rest using heap memory. This property determines the number of slots in the pool.
  The default number of slots is 60. This property receives a number (slots in the pool), for
  example: `-Dcom.mulesoft.dw.memory_pool_size=60`.

- `com.mulesoft.dw.max_memory_allocation`  
  Introduced in Mule 4.3.0, this property determines the maximum amount of memory to be used before
  it switches to disk. If a payload exceeds this size, it is stored in
  `dw-buffer-input-${count}.tmp` and `dw-buffer-output-${count}.tmp` temporary files. It also
  determines the size in bytes of each slot in the pool of off-heap memory. The default size is
  1572864 bytes (1.5 MB). This property receives a number (size in bytes), for example:
  `-Dcom.mulesoft.dw.max_memory_allocation=1572864`.

- `com.mulesoft.dw.buffer.memory.monitoring` (experimental)  
  Introduced in Mule 4.3.0, when this property is enabled, a message is logged each time a slot from
  the memory pool is taken or released. Note that it may be removed or change its behavior in future
  versions. This property receives a boolean, for example:
  `-Dcom.mulesoft.dw.buffer.memory.monitoring=true`.

- `mule.weave.script.parser.cache.size`  
  This system property determines the maximum size of compiled scripts that are being cached. The
  default value is 10.000.

- `com.mulesoft.dw.charbuffersize`  
  This system property determines the size (in bytes) of the buffer used by the writter. The default
  value is 4.096.

## See Also

- [DataWeave Scripts](https://docs.mulesoft.com/dataweave/2.9/dataweave-language-introduction)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.9/dataweave-selectors)

<!-- document id=b995142e4ed8b8a60ade5591ea22d101c509ab4584c387c5c34c34ffb6dd7f17 url=/mulesoft/current/en-us/dataweave/latest/dataweave-memory-management.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, streaming, weaveoutputhandler
---

# DataWeave Memory Management

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

When processing large files through DataWeave in Mule runtime engine, there are a few things you can
set up to fine-tune how much memory will be used and when.

## RAM vs Disk Usage

DataWeave keeps small files in memory, but after a configurable threshold uses disk space to avoid
running out of memory. The created buffer files are placed in a default temporary directory. If you
want to store those files in a custom directory instead, you can specify the directory by using the
`java.io.tmpdir` property.

The buffer files remain in the temporary directory until the streams that reference the files are
closed. Closure normally occurs when flows complete their execution, so many buffer files in the
temporary folder can remain in use during long-running and concurrent executions.

Three types of DataWeave buffer files are generated:

- `dw-buffer-output-${count}.tmp`  
  Used to store the output of a transformation when the result is bigger than the threshold
  **1572864 bytes**. To change this threshold value, add the system property
  `com.mulesoft.dw.max_memory_allocation` and assign it the number of bytes you want as your new
  threshold. Mule runtime engine deletes the file when the value is no longer referenced, JVM GC
  collects it or when the Mule Event finishes executing.

- `dw-buffer-input-${count}.tmp`  
  Used to store the input of a transformation when it is bigger than the in-memory buffer, which is
  **1572864 bytes** by default. This is analogous to the `dw-buffer-output-${count}.tmp` file, but
  for input data.

- `dw-buffer-index-${count}.tmp`  
  Used to store index information of a value being read. This file helps DataWeave access data
  quickly. Mule runtime engine deletes the file when the execution of the transformation ends or, in
  a streaming use case like the foreach loop, when the stream ends (when foreach finishes its
  execution).

System properties:  
Because you can define system properties in several ways, see
[system properties](https://docs.mulesoft.com/mule-runtime/latest/configuring-properties#system-properties) for further
details.

- `com.mulesoft.dw.buffersize`  
  This system property determines the size in bytes of the in-memory input and output buffers used
  in DataWeave to keep the processed inputs and outputs. The default buffer size is 8192 bytes (8
  KB). This property receives a number (size in bytes), for example:
  `-Dcom.mulesoft.dw.buffersize=8192`.

- `com.mulesoft.dw.directbuffer.disable`  
  Introduced in Mule 4.2.2, this option controls whether DataWeave uses off-heap memory (the
  default) or heap memory. DataWeave uses off-heap memory for internal buffering. However, this
  setting can cause problems on machines that have only a small amount of memory. This property
  receives a boolean, for example: `-Dcom.mulesoft.dw.directbuffer.disable=true`.

- `com.mulesoft.dw.memory_pool_size`  
  Since Mule 4.3.0, DataWeave buffers use off-heap memory from a pool up to a defined size and
  allocates the rest using heap memory. This property determines the number of slots in the pool.
  The default number of slots is 60. This property receives a number (slots in the pool), for
  example: `-Dcom.mulesoft.dw.memory_pool_size=60`.

- `com.mulesoft.dw.max_memory_allocation`  
  Introduced in Mule 4.3.0, this property determines the maximum amount of memory to be used before
  it switches to disk. If a payload exceeds this size, it is stored in
  `dw-buffer-input-${count}.tmp` and `dw-buffer-output-${count}.tmp` temporary files. It also
  determines the size in bytes of each slot in the pool of off-heap memory. The default size is
  1572864 bytes (1.5 MB). This property receives a number (size in bytes), for example:
  `-Dcom.mulesoft.dw.max_memory_allocation=1572864`.

- `com.mulesoft.dw.buffer.memory.monitoring` (experimental)  
  Introduced in Mule 4.3.0, when this property is enabled, a message is logged each time a slot from
  the memory pool is taken or released. Note that it may be removed or change its behavior in future
  versions. This property receives a boolean, for example:
  `-Dcom.mulesoft.dw.buffer.memory.monitoring=true`.

- `mule.weave.script.parser.cache.size`  
  This system property determines the maximum size of compiled scripts that are being cached. The
  default value is 10.000.

- `com.mulesoft.dw.charbuffersize`  
  This system property determines the size (in bytes) of the buffer used by the writter. The default
  value is 4.096.

## See Also

- [DataWeave Scripts](https://docs.mulesoft.com/dataweave/latest/dataweave-language-introduction)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors)

<!-- document id=d65cf3c8473b6c4febac43ed51555a2424e3c8be36a642d755fe2604cbf8d6fa url=/mulesoft/current/en-us/dataweave/2.11/dw-operators.md -->

---
product: DataWeave
version: 2.11
---

# DataWeave Operators

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave supports several operators, including mathematical operators, equality operators, and
operators such as prepend, append and update.

## Mathematical Operators

DataWeave supports the most common mathematical operators:

<table><colgroup><col> <col></colgroup><thead><tr><th>Operator</th><th>Description</th></tr></thead><tbody><tr><td><p><code>+</code></p></td><td><p>For addition.</p></td></tr><tr><td><p><code>-</code></p></td><td><p>For subtraction.</p></td></tr><tr><td><p><code>*</code></p></td><td><p>For multiplication.</p></td></tr><tr><td><p><code>/</code></p></td><td><p>For division.</p></td></tr></tbody></table>

In addition to operating with numbers, the `(-)` and `(+)` operators can also operate with complex
data structures like arrays, objects, and dates.

The following example uses mathematical operators with different data types:

Source

```dataweave
%dw 2.0
output application/json
---
{ "mathOperators" : [
    { "2 + 2" : (2 + 2) },
    { "2 - 2" : (2 - 2) },
    { "2 * 2" : (2 * 2) },
    { "2 / 2" : (2 / 2) },
    { "[1,2,3] - 1 + 4" : [1,2,3] - 1 + 4},
    { "{a:1, b:2, c:3} - 'a' " : {a:1, b:2, c:3} - "a"},
    { "|2021-03-02T10:39:59| - |P1D| + |PT3H|" : |2021-03-02T10:39:59| - |P1D| + |PT3H|}
  ]
}
```

Output

```json
{
  "mathOperators": [
    { "2 + 2": 4 },
    { "2 - 2": 0 },
    { "2 * 2": 4 },
    { "2 / 2": 1 },
    { "[1,2,3] - 1 + 4": [2, 3, 4] },
    { "{a:1, b:2, c:3} - 'a' ": { "b": 2, "c": 3 } },
    { "|2021-03-02T10:39:59| - |P1D| + |PT3H|": "2021-03-01T13:39:59" }
  ]
}
```

Several DataWeave functions operate on numbers, for example: [sum](https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-sum),
[mod](https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-mod) (for modulo), and [avg](https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-abs) (for average).

## Equality and Relational Operators

DataWeave supports the following equality and relational operators:

<table><colgroup><col> <col></colgroup><thead><tr><th>Operator</th><th>Description</th></tr></thead><tbody><tr><td><p><code>&lt;</code></p></td><td><p>For less than.</p></td></tr><tr><td><p><code>&gt;</code></p></td><td><p>For greater than.</p></td></tr><tr><td><p><code>&lt;=</code></p></td><td><p>For less than or equal to.</p></td></tr><tr><td><p><code>&gt;=</code></p></td><td><p>For greater than or equal to.</p></td></tr><tr><td><p><code>==</code></p></td><td><p>For equal to.</p></td></tr><tr><td><p><code>~=</code></p></td><td><p>Equality operator that tries to coerce one value to the type of the other when the types are different.</p></td></tr></tbody></table>

Note that you can negate these operators by using the [logical operator](#logical_operators), `not`.

The following example uses relational operators:

Source

```dataweave
%dw 2.0
output application/json
---
{ "relational" : [
    { "1 < 1" : (1 < 1) },
    { "1 > 2" : (1 > 2) },
    { "1 <= 1" : (1 <= 1) },
    { "1 >= 1" : (1 >= 1) }
  ]
}
```

Output

```json
{
  "relational": [
    { "(1 < 1)": false },
    { "(1 > 2)": false },
    { "(1 <= 1)": true },
    { "(1 >= 1)": true }
  ]
}
```

Note that if the operands of the relational operator belong to different types, DataWeave coerces
the right-side operand to the type of the left-side operand. For example, in the expression
`"123" > 12` DataWeave coerces `12` (a Number type) to `"12"` (a String type) and compares each
String value lexicographically. In the expression `123 > "12"`, DataWeave coerces the String value
`"12"` to the Number value `12` and compares the numbers.

These examples use equality operators:

Source

```dataweave
%dw 2.0
output application/dw
---
{ "equality" :
  [
    (1 == 1),
    (1 == 2),
    ("true" == true),
    ("true" ~= true),
    (['true'] ~= [true]),
    ('1' ~= 1)
  ]
}
```

Output

```text
{
  equality: [ true, false, false, true, true, true ]
}
```

## Logical Operators

DataWeave supports the following logical operators:

<table><colgroup><col> <col></colgroup><thead><tr><th>Operator</th><th>Description</th></tr></thead><tbody><tr><td><p><code>not</code></p></td><td><p>Negates the result of the input. See also, <code>!</code>.</p></td></tr><tr><td><p><code>!</code></p></td><td><p>Negates the result of the input. See also, <code>not</code>. <em>Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later.</em></p></td></tr><tr><td><p><code>and</code></p></td><td><p>Returns <code>true</code> if the result of all inputs is true, <code>false</code> if not.</p></td></tr><tr><td><p><code>or</code></p></td><td><p>Returns <code>true</code> if the result of any input is true, <code>false</code> if not.</p></td></tr></tbody></table>

> [!NOTE] Though the semantics of `not` and `!` are the same, their precedence differs.
> `not true or true` is executed as `not (true or true)`, so it returns `false`, whereas
> `!true or true` returns `true` because the `!` only applies to the first `true`. `!(true or true)`
> returns `false`.

The following examples use logical operators:

Source

```dataweave
%dw 2.0
var myArray = [1,2,3,4,5]
var myMap = myArray map not (($ mod 2) == 0)
output application/json
---
{
  "not" : [
    "notTrue" : not true,
    "notFalse" : not false,
    "myMapWithNot" : myMap
  ],
  "and" : [
    "andTrueFalse" : true and false,
    "andIsTrue" : (1 + 1 == 2) and (2 + 2 == 4),
    "andIsFalse" : (1 + 1 == 2) and (2 + 2 == 2)
  ],
  "or" : [
    "orTrueFalse" : true or false,
    "orIsTrue" : (1 + 1 == 2) or (2 + 2 == 2),
    "orIsFalse" : (1 + 1 == 1) or (2 + 2 == 2)
  ],
  "!-vs-not" : [
	  "example-!" : (! true or true),
	  "example-not" : (not true or true)
  ]
}
```

Note that `myMap` iterates through the items in a list (`myArray`) and determines whether the modulo
(`mod`) expression _does not_ evaluate to `0` when applied to each given item.

Output

```json
{
  "not": [
    { "notTrue": false },
    { "notFalse": true },
    { "myMapWithNot": [true, false, true, false, true] }
  ],
  "and": [{ "andTrueFalse": false }, { "andIsTrue": true }, { "andIsFalse": false }],
  "or": [{ "orTrueFalse": true }, { "orIsTrue": true }, { "orIsFalse": false }],
  "!-vs-not": [{ "example-!": true }, { "example-not": false }]
}
```

Note that `not` works in expressions such as `not (true)`, but `not(true)` (without the space) does
not work.

You can use logical operators together. The following example uses:

- `or not` as defined in the `orNot` expression.

- `and not` in `andNot`.

- `not` and `and not` in `notWithAndNot`.

```dataweave
%dw 2.0
var orNot = if (1 + 1 == 4 or not 1 == 2) {"answer": "orNot - Condition met"}
             else {"answer": "nope"}
var andNot = if (1 + 1 == 2 and not 1 == 2) {"answer": "andNot - Condition met"}
             else {"answer": "nope"}
var notWithAndNot = if (not (1 + 1 == 2 and not 1 == 1)) {"answer": "notWithAndNot - Condition met"}
              else {"answer": "nope"}
output application/json
---
{ "answers" :
  [
    orNot,
    andNot,
    notWithAndNot
  ]
}
```

Output

```json
{
  "answers": [
    { "answer": "orNot - Condition met" },
    { "answer": "andNot - Condition met" },
    { "answer": "notWithAndNot - Condition met" }
  ]
}
```

DataWeave executes the code inside each `if` block because all conditional expressions in the
example evaluate to `true`.

## Prepend, Append, and Remove Operators for Arrays

DataWeave supports operators for appending and prepending items within an array:

<table><colgroup><col> <col></colgroup><thead><tr><th>Operator</th><th>Description</th></tr></thead><tbody><tr><td><p><code>&gt;&gt;</code></p></td><td><p>Prepends data on the left-hand side of the operator to items in the array on the right-hand side. For example, <code>1 &gt;&gt; [2]</code> results in <code>[ 1, 2 ]</code>, prepending <code>1</code> to <code>2</code> in the array.</p></td></tr><tr><td><p><code>&lt;&lt;</code></p></td><td><p>Appends data on the right-hand side of the operator to items in the array on the left-hand side. For example, <code>[1] &lt;&lt; 2</code> results in <code>[ 1, 2 ]</code>, appending <code>2</code> to <code>1</code> in the array.</p></td></tr><tr><td><p><code>+</code></p></td><td><p>Appends data on the right-hand side of the operator to items in the array on the left-hand side. For example, <code>[1] + 2</code> results in <code>[ 1, 2 ]</code>, appending <code>2</code> to <code>1</code> in the array. The array is always on the left-hand side of the operator.</p></td></tr><tr><td><p><code>-</code></p></td><td><p>Removes a specified element of any supported type from an array.</p></td></tr></tbody></table>

The following examples show uses of prepend, append, and remove operators on arrays:

```dataweave
%dw 2.0
output application/json
---
{
  "prepend-append" : [
  	 // Array on right side when prepending.
     { "prepend" : 1 >> [2] },
     { "prepend-number" : 1 >> [1] },
     { "prepend-string" : "a" >> [1] },
     { "prepend-object" : { "a" : "b"} >> [1] },
     { "prepend-array" : [1] >> [2, 3] },
     { "prepend-binary" : (1 as Binary) >> [1] },
     { "prepend-date-time" : |23:57:59Z| >> [ |2017-10-01| ] },
  	 // Array is on left side when appending.
     { "append-number" : [1] << 2 },
     { "append-string" : [1] << "a" },
     { "append-object" : [1] << { "a" : "b"} },
     { "append-array" : [1,2] << [1, 2, 3] },
     { "append-binary" : [1] << (1 as Binary) },
     { "append-date-time" : [ |2017-10-01| ] << |23:57:59Z| },
     { "append-object-to-array" : [1,2] << {"a" : "b"} },
     { "append-array-to-array1" : ["a","b"] << ["c","d"] },
     { "append-array-to-array2" : [["a","b"],["c","d"]] << ["e","f"] },
     // + always appends within the array
     { "append-with-+" : [1] + 2 },
     { "append-with-+" : [2] + 1 },
     { "removeNumberFromArray" : ( [1,2,3] - 2 ) },
     { "removeObjectFromArray" : ( [ {a : "b"}, {c : "d"} , { e : "f"} ] - { c : "d"} ) }
  ]
}
```

Output

```json
{
  "prepend-append": [
    { "prepend": [1, 2] },
    { "prepend-number": [1, 1] },
    { "prepend-string": ["a", 1] },
    { "prepend-array": [[1], 2, 3] },
    { "prepend-object": [{ "a": "b" }, 1] },
    { "prepend-binary": ["\u0001", 1] },
    { "prepend-date-time": ["23:57:59Z", "2017-10-01"] },
    { "append-number": [1, 2] },
    { "append-string": [1, "a"] },
    { "append-object": [1, { "a": "b" }] },
    { "append-array": [1, 2, [1, 2, 3]] },
    { "append-binary": [1, "\u0001"] },
    { "append-date-time": ["2017-10-01", "23:57:59Z"] },
    { "append-object-to-array": [1, 2, { "a": "b" }] },
    { "append-array-to-array1": ["a", "b", ["c", "d"]] },
    {
      "append-array-to-array2": [
        ["a", "b"],
        ["c", "d"],
        ["e", "f"]
      ]
    },
    { "append-with-+": [1, 2] },
    { "append-with-+": [2, 1] },
    { "removeNumberFromArray": [1, 3] },
    { "removeObjectFromArray": [{ "a": "b" }, { "e": "f" }] }
  ]
}
```

## Scope and Flow Control Operators

DataWeave supports operators that control the flow and scope of expressions:

- [`do` and `using`](#control_flow_do)

- [`if else` and `else if`](#control_flow_if)

<table id="control_flow_do"><caption>Table 1. Scope Operators:</caption> <colgroup><col> <col></colgroup><thead><tr><th>Operator</th><th>Description</th></tr></thead><tbody><tr><td><p><code>do</code></p></td><td><p>Creates a scope in which new variables, functions, annotations, or namespaces can be declared and used. The syntax is similar to a mapping in that it is composed of a header and body separated by <code>---</code>. Its header is where all the declarations are defined, and its body is the result of the expression. See <a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-flow-control#control_flow_do">do</a> and <a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-variables#example_local_variable">Examples: Local DataWeave Variables</a> for examples.</p></td></tr><tr><td><p><code>using</code></p></td><td><p>Replaced by <code>do</code>. Supported for backwards compatibility only.</p></td></tr></tbody></table>

<table id="control_flow_if"><caption>Table 2. Flow Control Operators:</caption> <colgroup><col> <col></colgroup><thead><tr><th>Operator</th><th>Description</th></tr></thead><tbody><tr><td><p><code>if else</code></p></td><td><div><div><p>An <code>if</code> operator evaluates a conditional expression and returns the value under the <code>if</code> only if the conditional expression is true. Otherwise, it returns the expression under <code>else</code>. Every <code>if</code> expression must have a matching <code>else</code> expression. See <a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-flow-control#control_flow_if_else">if else</a> for an example.</p></div></div></td></tr><tr><td><p><code>else if</code></p></td><td><p>An <code>else</code> operator chains expressions together within an if-else construct by incorporating <code>else if</code>. See <a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-flow-control#control_flow_else_if">else if</a> for an example.</p></td></tr></tbody></table>

## Update Operator

DataWeave supports the `update` operator, which enables you to update specified fields of a data
structure with new values.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

Versions prior to Mule 4.3 require the following syntax to increase the `age` value in `myInput` by
one without recreating the entire object:

```weave
%dw 2.0
var myInput = {
    "name": "Ken",
    "lastName":"Shokida",
    "age": 30
}
output application/json
---
myInput mapObject ((value,key) ->
    if(key as String == "age")
       {(key): value as Number + 1}
    else
       {(key): value} )
```

In Mule 4.3, the `update` operator simplifies the syntax:

```weave
%dw 2.0
var myInput = {
    "name": "Ken",
    "lastName":"Shokida",
    "age": 30
}
output application/json
---
myInput update {
    case age at .age -> age + 1
}
```

Both DataWeave scripts return the same result:

```JSON
{
  "name": "Ken",
  "lastName": "Shokida",
  "age": 31
}
```

With `update`, casting or iterating through all the key-value pairs is not necessary.

The `update` syntax is as follows:

```weave
<value_to_update> update {
    case <variable_name> at <update_expression>[!]? [if(<conditional_expression>)]? -> <new value>
    ...
}
```

- `value_to_update` represents the original value to update.

- `update_expression` is the selector expression that matches a value in `value_to_update`.

- `variable_name` is the name of the variable to bind to the matched `update_expression` value.

- `new_value` is the expression with the new value.

- `[if(<conditional_expression>)]?` If `conditional_expression` returns `true`, the script updates
  the value. Use of a conditional expression is optional.

- `[!]` marks the selector as an upsert. If the expression doesn’t find a match, the `!` makes the
  `update` operator create all the required elements and insert the new value.

- `update_expression` supports multiple `case` expressions.

> [!NOTE] The `update` operator doesn’t mutate the existing value. Instead, the operator creates a
> new value with the updated expressions.

### Selector Expressions

Use selector expressions with the `update` operator to specify the fields to update.

#### Value Selector

This matching selector can check for matches to any value within an object.

The following example updates a field at the root level and a field in a nested level using the
value selector:

Source

```weave
%dw 2.0
var myInput = {
    "name": "Ken",
    "lastName":"Shokida",
    "age": 30,
    "address": {
        "street": "Amenabar",
        "zipCode": "AB1234"
    }
}
output application/json
---
myInput update {
    case age at .age -> age + 1
    case s at .address.street -> "First Street"
}
```

Output

```json
{
  "name": "Ken",
  "lastName": "Shokida",
  "age": 31,
  "address": {
    "street": "First Street",
    "zipCode": "AB1234"
  }
}
```

#### Index Selector

This matching selector enables you to match any array by its index.

The following example updates an element that is at the first location of the array:

Input

```json
{
  "name": "Ken",
  "lastName": "Shokida",
  "age": 30,
  "addresses": [
    {
      "street": "Amenabar",
      "zipCode": "AB1234"
    }
  ]
}
```

Source

```weave
%dw 2.0
output application/json
---
payload update {
    case s at .addresses[0] -> {
        "street": "Second Street",
        "zipCode": "ZZ123"
    }
}
```

Output

```json
{
  "name": "Ken",
  "lastName": "Shokida",
  "age": 30,
  "addresses": [
    {
      "street": "Second Street",
      "zipCode": "ZZ123"
    }
  ]
}
```

#### Attribute Selector

This matching selector enables you to match any attribute value.

The following example updates an attribute value and changes it to upper case:

Input

```xml
<user name="leandro"/>
```

Source

```weave
%dw 2.0
output application/xml
---
payload update {
    case name at .user.@name -> upper(name)
}
```

Output

```xml
<?xml version='1.0' encoding='UTF-8'?>
<user name="LEANDRO"/>
```

#### Dynamic Selector

Any selector can incorporate an expression to make the selection dynamic.

The following example dynamically selects and updates the value of a field that is not hardcoded.
Such a field can change at runtime. The example uses the variable `theFieldName` to obtain the field
with key `name`, and it changes the value of that field to `Shoki`.

Input

```json
{
  "name": "Ken",
  "lastName": "Shokida"
}
```

Source

```weave
%dw 2.0
var theFieldName = "name"
output application/json
---
payload update {
    case s at ."$(theFieldName)" -> "Shoki"
}
```

Output

```json
{
  "name": "Shoki",
  "lastName": "Shokida"
}
```

### Conditional Update

The `update` operator has syntax for writing a conditional update if you want to modify a field
under a given condition.

The following example updates the category based on the name of the user:

Input

```json
[
  { "name": "Ken", "age": 30 },
  { "name": "Tomo", "age": 70 },
  { "name": "Kajika", "age": 10 }
]
```

Source

```weave
%dw 2.0
output application/json
---
payload map ((user) ->
    user update {
        case name at .name if(name == "Ken") -> name ++ " (Leandro)"
        case name at .name if(name == "Tomo") -> name ++ " (Christian)"
    }
)
```

Output

```json
[
  {
    "name": "Ken (Leandro)",
    "age": 30
  },
  {
    "name": "Tomo (Christian)",
    "age": 70
  },
  {
    "name": "Kajika",
    "age": 10
  }
]
```

### Upserting

The `update` operator enables you to insert a field that is not present already by using the `!`
symbol at the end of the selector expression. When the field is not present, the operator binds a
`null` value to the variable.

The following example updates each object in the array `myInput`. If the field `name` is present in
the object, the example applies the `upper` function to the value of `name`. If the field `name` is
not present in the object, the example appends the key-value pair `"name": "JOHN"` to the object.

Source

```weave
%dw 2.0
var myInput = [{"lastName": "Doe"}, {"lastName": "Parker", "name": "Peter" }]
output application/json
---
myInput  map ((value) ->
    value update {
        case name at .name! -> if(name == null) "JOHN" else upper(name)
    }
)
```

Output

```json
[
  {
    "lastName": "Doe",
    "name": "JOHN"
  },
  {
    "lastName": "Parker",
    "name": "PETER"
  }
]
```

### Sugar Syntax

The `update` operator accepts a default variable named `$` in place of the longer
`<variable_name> at` syntax.

The following example binds the value of the expression `.age` to the default variable name `$`,
which is used to express the new value. The longer equivalent is shown in comments.

Input

```json
{
  "name": "Ken",
  "lastName": "Shokida",
  "age": 30,
  "address": {
    "street": "Amenabar",
    "zipCode": "AB1234"
  }
}
```

Source

```weave
%dw 2.0
output application/json
---
payload update {
    //equivalent expression:
    //case age at .age -> age + 1
    case .age -> $ + 1
    case .address.street -> "First Street"
}
```

Output

```json
{
  "name": "Ken",
  "lastName": "Shokida",
  "age": 31,
  "address": {
    "street": "First Street",
    "zipCode": "AB1234"
  }
}
```

## Metadata Assignment Operator

DataWeave supports the metadata assignment operator `<~`, which enables you to set the metadata of
any value without using the `as` operator. This operator is useful when you want to set the metadata
and retain the current value type. If you are coercing the value to a new type, use
[as](https://docs.mulesoft.com/dataweave/2.11/dataweave-types-coercion).

_Introduced in DataWeave 2.5.0. Supported by Mule 4.5 and later._

The operator syntax is as follows:

```none
<valueB> <~ <objectA>
```

The operator assigns `objectA` as metadata to `valueB`. The arrow points to the value to which the
metadata is assigned.

Versions prior to Mule 4.5 require the following syntax, for example, to add the `class` metadata
field to an object:

```weave
%dw 2.0
---
{name: "Ken"} as Object {class: "Person"}
```

In Mule 4.5, the metadata assignment operator `<~` simplifies the syntax:

```weave
%dw 2.0
---
{name: "Ken"} <~ {class: "Person"}
```

### Metadata Assignment Using Metadata Annotations

DataWeave adds support for metadata annotations. These special annotations, marked with `@Metadata`,
attach a key-value pair metadata to any value where they are used.

_Introduced in DataWeave 2.8.0._

The following example achieves the same result as the previous one, but by defining an annotation,
which is a class that binds the metadata key `class` to the value provided where it is used.

```weave
%dw 2.8

@Metadata(key="class")
annotation Class(value: String)
---
@Class(value="Person")
{name: "Ken"}
```

Defining metadata using annotations provides the following benefits:

- You can define annotations once and reuse them as metadata throughout your code.

- Annotations are additive, and using more than one annotation attaches all the key-value pairs
  together.

- You get type checking, enabling you to force the value of the annotation to be of a certain type,
  ensuring consistency.

However, there are certain restrictions when defining metadata annotations:

- Annotations marked with `@Metadata` can only have one parameter.

- The parameter must be called `value`.

- The metadata key is the value set to the key argument of the metadata annotation, not the name of
  the annotation itself (In the previous example, the metadata value is associated to the `class`
  key).

- Metadata annotations are additive, so if they are used on a reference that already has metadata,
  the new metadata is appended.

The following is an example of a metadata annotation that marks a value as CData for the XML
writter.

Source

```weave
%dw 2.8
output application/xml

@Metadata(key="cdata")
annotation CData(value: true)
---
root: {
 test: @CData(value = true) "testCData"
}
```

Output

```xml
<?xml version='1.0' encoding='UTF-8'?>
<root>
  <test><![CDATA[testCData]]></test>
</root>
```

### Metadata

Metadata is any additional information attached to a value that doesn’t affect its identity. Given
any two values `A` and `B` that are equal, if you attach metadata to `A` and call it `A'`, then
`A == A' == B`. So you can define a value that is formed by the value and the metadata attached to
it.

<!-- document id=63a0187e03b26f921fdf7e5d14d603195ced5a1c5156e530c54e84756e740bb6 url=/mulesoft/current/en-us/dataweave/2.12/dw-operators.md -->

---
product: DataWeave
version: 2.12
---

# DataWeave Operators

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave supports several operators, including mathematical operators, equality operators, and
operators such as prepend, append, and update.

## Mathematical Operators

DataWeave supports the most common mathematical operators:

<table><colgroup><col> <col></colgroup><thead><tr><th>Operator</th><th>Description</th></tr></thead><tbody><tr><td><p><code>+</code></p></td><td><p>For addition.</p></td></tr><tr><td><p><code>-</code></p></td><td><p>For subtraction.</p></td></tr><tr><td><p><code>*</code></p></td><td><p>For multiplication.</p></td></tr><tr><td><p><code>/</code></p></td><td><p>For division.</p></td></tr></tbody></table>

In addition to operating with numbers, the `(-)` and `(+)` operators can also operate with complex
data structures like arrays, objects, and dates.

The following example uses mathematical operators with different data types:

Source

```dataweave
%dw 2.0
output application/json
---
{ "mathOperators" : [
    { "2 + 2" : (2 + 2) },
    { "2 - 2" : (2 - 2) },
    { "2 * 2" : (2 * 2) },
    { "2 / 2" : (2 / 2) },
    { "[1,2,3] - 1 + 4" : [1,2,3] - 1 + 4},
    { "{a:1, b:2, c:3} - 'a' " : {a:1, b:2, c:3} - "a"},
    { "|2021-03-02T10:39:59| - |P1D| + |PT3H|" : |2021-03-02T10:39:59| - |P1D| + |PT3H|}
  ]
}
```

Output

```json
{
  "mathOperators": [
    { "2 + 2": 4 },
    { "2 - 2": 0 },
    { "2 * 2": 4 },
    { "2 / 2": 1 },
    { "[1,2,3] - 1 + 4": [2, 3, 4] },
    { "{a:1, b:2, c:3} - 'a' ": { "b": 2, "c": 3 } },
    { "|2021-03-02T10:39:59| - |P1D| + |PT3H|": "2021-03-01T13:39:59" }
  ]
}
```

Several DataWeave functions operate on numbers, for example: [sum](https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-sum),
[mod](https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-mod) (for modulo), and [avg](https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-abs) (for average).

## Equality and Relational Operators

DataWeave supports the following equality and relational operators:

<table><colgroup><col> <col></colgroup><thead><tr><th>Operator</th><th>Description</th></tr></thead><tbody><tr><td><p><code>&lt;</code></p></td><td><p>For less than.</p></td></tr><tr><td><p><code>&gt;</code></p></td><td><p>For greater than.</p></td></tr><tr><td><p><code>&lt;=</code></p></td><td><p>For less than or equal to.</p></td></tr><tr><td><p><code>&gt;=</code></p></td><td><p>For greater than or equal to.</p></td></tr><tr><td><p><code>==</code></p></td><td><p>For equal to.</p></td></tr><tr><td><p><code>~=</code></p></td><td><p>Equality operator that tries to coerce one value to the type of the other when the types are different.</p></td></tr></tbody></table>

Note that you can negate these operators by using the [logical operator](#logical_operators), `not`.

The following example uses relational operators:

Source

```dataweave
%dw 2.0
output application/json
---
{ "relational" : [
    { "1 < 1" : (1 < 1) },
    { "1 > 2" : (1 > 2) },
    { "1 <= 1" : (1 <= 1) },
    { "1 >= 1" : (1 >= 1) }
  ]
}
```

Output

```json
{
  "relational": [
    { "(1 < 1)": false },
    { "(1 > 2)": false },
    { "(1 <= 1)": true },
    { "(1 >= 1)": true }
  ]
}
```

Note that if the operands of the relational operator belong to different types, DataWeave coerces
the right-side operand to the type of the left-side operand. For example, in the expression
`"123" > 12` DataWeave coerces `12` (a Number type) to `"12"` (a String type) and compares each
String value lexicographically. In the expression `123 > "12"`, DataWeave coerces the String value
`"12"` to the Number value `12` and compares the numbers.

These examples use equality operators:

Source

```dataweave
%dw 2.0
output application/dw
---
{ "equality" :
  [
    (1 == 1),
    (1 == 2),
    ("true" == true),
    ("true" ~= true),
    (['true'] ~= [true]),
    ('1' ~= 1)
  ]
}
```

Output

```text
{
  equality: [ true, false, false, true, true, true ]
}
```

## Logical Operators

DataWeave supports the following logical operators:

<table><colgroup><col> <col></colgroup><thead><tr><th>Operator</th><th>Description</th></tr></thead><tbody><tr><td><p><code>not</code></p></td><td><p>Negates the result of the input. See also, <code>!</code>.</p></td></tr><tr><td><p><code>!</code></p></td><td><p>Negates the result of the input. See also, <code>not</code>. <em>Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later.</em></p></td></tr><tr><td><p><code>and</code></p></td><td><p>Returns <code>true</code> if the result of all inputs is true, <code>false</code> if not.</p></td></tr><tr><td><p><code>or</code></p></td><td><p>Returns <code>true</code> if the result of any input is true, <code>false</code> if not.</p></td></tr></tbody></table>

> [!NOTE] Though the semantics of `not` and `!` are the same, their precedence differs.
> `not true or true` is executed as `not (true or true)`, so it returns `false`, whereas
> `!true or true` returns `true` because the `!` only applies to the first `true`. `!(true or true)`
> returns `false`.

The following examples use logical operators:

Source

```dataweave
%dw 2.0
var myArray = [1,2,3,4,5]
var myMap = myArray map not (($ mod 2) == 0)
output application/json
---
{
  "not" : [
    "notTrue" : not true,
    "notFalse" : not false,
    "myMapWithNot" : myMap
  ],
  "and" : [
    "andTrueFalse" : true and false,
    "andIsTrue" : (1 + 1 == 2) and (2 + 2 == 4),
    "andIsFalse" : (1 + 1 == 2) and (2 + 2 == 2)
  ],
  "or" : [
    "orTrueFalse" : true or false,
    "orIsTrue" : (1 + 1 == 2) or (2 + 2 == 2),
    "orIsFalse" : (1 + 1 == 1) or (2 + 2 == 2)
  ],
  "!-vs-not" : [
	  "example-!" : (! true or true),
	  "example-not" : (not true or true)
  ]
}
```

Note that `myMap` iterates through the items in a list (`myArray`) and determines whether the modulo
(`mod`) expression _does not_ evaluate to `0` when applied to each given item.

Output

```json
{
  "not": [
    { "notTrue": false },
    { "notFalse": true },
    { "myMapWithNot": [true, false, true, false, true] }
  ],
  "and": [{ "andTrueFalse": false }, { "andIsTrue": true }, { "andIsFalse": false }],
  "or": [{ "orTrueFalse": true }, { "orIsTrue": true }, { "orIsFalse": false }],
  "!-vs-not": [{ "example-!": true }, { "example-not": false }]
}
```

Note that `not` works in expressions such as `not (true)`, but `not(true)` (without the space) does
not work.

You can use logical operators together. The following example uses:

- `or not` as defined in the `orNot` expression.

- `and not` in `andNot`.

- `not` and `and not` in `notWithAndNot`.

```dataweave
%dw 2.0
var orNot = if (1 + 1 == 4 or not 1 == 2) {"answer": "orNot - Condition met"}
             else {"answer": "nope"}
var andNot = if (1 + 1 == 2 and not 1 == 2) {"answer": "andNot - Condition met"}
             else {"answer": "nope"}
var notWithAndNot = if (not (1 + 1 == 2 and not 1 == 1)) {"answer": "notWithAndNot - Condition met"}
              else {"answer": "nope"}
output application/json
---
{ "answers" :
  [
    orNot,
    andNot,
    notWithAndNot
  ]
}
```

Output

```json
{
  "answers": [
    { "answer": "orNot - Condition met" },
    { "answer": "andNot - Condition met" },
    { "answer": "notWithAndNot - Condition met" }
  ]
}
```

DataWeave executes the code inside each `if` block because all conditional expressions in the
example evaluate to `true`.

## Prepend, Append, and Remove Operators for Arrays

DataWeave supports operators for appending and prepending items within an array:

<table><colgroup><col> <col></colgroup><thead><tr><th>Operator</th><th>Description</th></tr></thead><tbody><tr><td><p><code>&gt;&gt;</code></p></td><td><p>Prepends data on the left-hand side of the operator to items in the array on the right-hand side. For example, <code>1 &gt;&gt; [2]</code> results in <code>[ 1, 2 ]</code>, prepending <code>1</code> to <code>2</code> in the array.</p></td></tr><tr><td><p><code>&lt;&lt;</code></p></td><td><p>Appends data on the right-hand side of the operator to items in the array on the left-hand side. For example, <code>[1] &lt;&lt; 2</code> results in <code>[ 1, 2 ]</code>, appending <code>2</code> to <code>1</code> in the array.</p></td></tr><tr><td><p><code>+</code></p></td><td><p>Appends data on the right-hand side of the operator to items in the array on the left-hand side. For example, <code>[1] + 2</code> results in <code>[ 1, 2 ]</code>, appending <code>2</code> to <code>1</code> in the array. The array is always on the left-hand side of the operator.</p></td></tr><tr><td><p><code>-</code></p></td><td><p>Removes a specified element of any supported type from an array.</p></td></tr></tbody></table>

The following examples show uses of prepend, append, and remove operators on arrays:

```dataweave
%dw 2.0
output application/json
---
{
  "prepend-append" : [
  	 // Array on right side when prepending.
     { "prepend" : 1 >> [2] },
     { "prepend-number" : 1 >> [1] },
     { "prepend-string" : "a" >> [1] },
     { "prepend-object" : { "a" : "b"} >> [1] },
     { "prepend-array" : [1] >> [2, 3] },
     { "prepend-binary" : (1 as Binary) >> [1] },
     { "prepend-date-time" : |23:57:59Z| >> [ |2017-10-01| ] },
  	 // Array is on left side when appending.
     { "append-number" : [1] << 2 },
     { "append-string" : [1] << "a" },
     { "append-object" : [1] << { "a" : "b"} },
     { "append-array" : [1,2] << [1, 2, 3] },
     { "append-binary" : [1] << (1 as Binary) },
     { "append-date-time" : [ |2017-10-01| ] << |23:57:59Z| },
     { "append-object-to-array" : [1,2] << {"a" : "b"} },
     { "append-array-to-array1" : ["a","b"] << ["c","d"] },
     { "append-array-to-array2" : [["a","b"],["c","d"]] << ["e","f"] },
     // + always appends within the array
     { "append-with-+" : [1] + 2 },
     { "append-with-+" : [2] + 1 },
     { "removeNumberFromArray" : ( [1,2,3] - 2 ) },
     { "removeObjectFromArray" : ( [ {a : "b"}, {c : "d"} , { e : "f"} ] - { c : "d"} ) }
  ]
}
```

Output

```json
{
  "prepend-append": [
    { "prepend": [1, 2] },
    { "prepend-number": [1, 1] },
    { "prepend-string": ["a", 1] },
    { "prepend-array": [[1], 2, 3] },
    { "prepend-object": [{ "a": "b" }, 1] },
    { "prepend-binary": ["\u0001", 1] },
    { "prepend-date-time": ["23:57:59Z", "2017-10-01"] },
    { "append-number": [1, 2] },
    { "append-string": [1, "a"] },
    { "append-object": [1, { "a": "b" }] },
    { "append-array": [1, 2, [1, 2, 3]] },
    { "append-binary": [1, "\u0001"] },
    { "append-date-time": ["2017-10-01", "23:57:59Z"] },
    { "append-object-to-array": [1, 2, { "a": "b" }] },
    { "append-array-to-array1": ["a", "b", ["c", "d"]] },
    {
      "append-array-to-array2": [
        ["a", "b"],
        ["c", "d"],
        ["e", "f"]
      ]
    },
    { "append-with-+": [1, 2] },
    { "append-with-+": [2, 1] },
    { "removeNumberFromArray": [1, 3] },
    { "removeObjectFromArray": [{ "a": "b" }, { "e": "f" }] }
  ]
}
```

## Scope and Flow Control Operators

DataWeave supports operators that control the flow and scope of expressions:

- [`do` and `using`](#control_flow_do)

- [`if else` and `else if`](#control_flow_if)

<table id="control_flow_do"><caption>Table 1. Scope Operators:</caption> <colgroup><col> <col></colgroup><thead><tr><th>Operator</th><th>Description</th></tr></thead><tbody><tr><td><p><code>do</code></p></td><td><p>Creates a scope in which new variables, functions, annotations, or namespaces can be declared and used. The syntax is similar to a mapping in that it is composed of a header and body separated by <code>---</code>. Its header is where all the declarations are defined, and its body is the result of the expression. See <a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-flow-control#control_flow_do">do</a> and <a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-variables#example_local_variable">Examples: Local DataWeave Variables</a> for examples.</p></td></tr><tr><td><p><code>using</code></p></td><td><p>Replaced by <code>do</code>. Supported for backwards compatibility only.</p></td></tr></tbody></table>

<table id="control_flow_if"><caption>Table 2. Flow Control Operators:</caption> <colgroup><col> <col></colgroup><thead><tr><th>Operator</th><th>Description</th></tr></thead><tbody><tr><td><p><code>if else</code></p></td><td><div><div><p>An <code>if</code> operator evaluates a conditional expression and returns the value under the <code>if</code> only if the conditional expression is true. Otherwise, it returns the expression under <code>else</code>. Every <code>if</code> expression must have a matching <code>else</code> expression. See <a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-flow-control#control_flow_if_else">if else</a> for an example.</p></div></div></td></tr><tr><td><p><code>else if</code></p></td><td><p>An <code>else</code> operator chains expressions together within an if-else construct by incorporating <code>else if</code>. See <a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-flow-control#control_flow_else_if">else if</a> for an example.</p></td></tr></tbody></table>

## Update Operator

DataWeave supports the `update` operator, which enables you to update specified fields of a data
structure with new values.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

Versions prior to Mule 4.3 require the following syntax to increase the `age` value in `myInput` by
one without recreating the entire object:

```weave
%dw 2.0
var myInput = {
    "name": "Ken",
    "lastName":"Shokida",
    "age": 30
}
output application/json
---
myInput mapObject ((value,key) ->
    if(key as String == "age")
       {(key): value as Number + 1}
    else
       {(key): value} )
```

In Mule 4.3, the `update` operator simplifies the syntax:

```weave
%dw 2.0
var myInput = {
    "name": "Ken",
    "lastName":"Shokida",
    "age": 30
}
output application/json
---
myInput update {
    case age at .age -> age + 1
}
```

Both DataWeave scripts return the same result:

```JSON
{
  "name": "Ken",
  "lastName": "Shokida",
  "age": 31
}
```

With `update`, casting or iterating through all the key-value pairs is not necessary.

The `update` syntax is as follows:

```weave
<value_to_update> update {
    case <variable_name> at <update_expression>[!]? [if(<conditional_expression>)]? -> <new value>
    ...
}
```

- `value_to_update` represents the original value to update.

- `update_expression` is the selector expression that matches a value in `value_to_update`.

- `variable_name` is the name of the variable to bind to the matched `update_expression` value.

- `new_value` is the expression with the new value.

- `[if(<conditional_expression>)]?` If `conditional_expression` returns `true`, the script updates
  the value. Use of a conditional expression is optional.

- `[!]` marks the selector as an upsert. If the expression doesn’t find a match, the `!` makes the
  `update` operator create all the required elements and insert the new value.

- `update_expression` supports multiple `case` expressions.

> [!NOTE] The `update` operator doesn’t mutate the existing value. Instead, the operator creates a
> new value with the updated expressions.

### Selector Expressions

Use selector expressions with the `update` operator to specify the fields to update.

#### Value Selector

This matching selector can check for matches to any value within an object.

The following example updates a field at the root level and a field in a nested level using the
value selector:

Source

```weave
%dw 2.0
var myInput = {
    "name": "Ken",
    "lastName":"Shokida",
    "age": 30,
    "address": {
        "street": "Amenabar",
        "zipCode": "AB1234"
    }
}
output application/json
---
myInput update {
    case age at .age -> age + 1
    case s at .address.street -> "First Street"
}
```

Output

```json
{
  "name": "Ken",
  "lastName": "Shokida",
  "age": 31,
  "address": {
    "street": "First Street",
    "zipCode": "AB1234"
  }
}
```

#### Index Selector

This matching selector enables you to match any array by its index.

The following example updates an element that is at the first location of the array:

Input

```json
{
  "name": "Ken",
  "lastName": "Shokida",
  "age": 30,
  "addresses": [
    {
      "street": "Amenabar",
      "zipCode": "AB1234"
    }
  ]
}
```

Source

```weave
%dw 2.0
output application/json
---
payload update {
    case s at .addresses[0] -> {
        "street": "Second Street",
        "zipCode": "ZZ123"
    }
}
```

Output

```json
{
  "name": "Ken",
  "lastName": "Shokida",
  "age": 30,
  "addresses": [
    {
      "street": "Second Street",
      "zipCode": "ZZ123"
    }
  ]
}
```

#### Attribute Selector

This matching selector enables you to match any attribute value.

The following example updates an attribute value and changes it to upper case:

Input

```xml
<user name="leandro"/>
```

Source

```weave
%dw 2.0
output application/xml
---
payload update {
    case name at .user.@name -> upper(name)
}
```

Output

```xml
<?xml version='1.0' encoding='UTF-8'?>
<user name="LEANDRO"/>
```

#### Dynamic Selector

Any selector can incorporate an expression to make the selection dynamic.

The following example dynamically selects and updates the value of a field that is not hardcoded.
Such a field can change at runtime. The example uses the variable `theFieldName` to obtain the field
with key `name`, and it changes the value of that field to `Shoki`.

Input

```json
{
  "name": "Ken",
  "lastName": "Shokida"
}
```

Source

```weave
%dw 2.0
var theFieldName = "name"
output application/json
---
payload update {
    case s at ."$(theFieldName)" -> "Shoki"
}
```

Output

```json
{
  "name": "Shoki",
  "lastName": "Shokida"
}
```

### Conditional Update

The `update` operator has syntax for writing a conditional update if you want to modify a field
under a given condition.

The following example updates the category based on the name of the user:

Input

```json
[
  { "name": "Ken", "age": 30 },
  { "name": "Tomo", "age": 70 },
  { "name": "Kajika", "age": 10 }
]
```

Source

```weave
%dw 2.0
output application/json
---
payload map ((user) ->
    user update {
        case name at .name if(name == "Ken") -> name ++ " (Leandro)"
        case name at .name if(name == "Tomo") -> name ++ " (Christian)"
    }
)
```

Output

```json
[
  {
    "name": "Ken (Leandro)",
    "age": 30
  },
  {
    "name": "Tomo (Christian)",
    "age": 70
  },
  {
    "name": "Kajika",
    "age": 10
  }
]
```

### Upserting

The `update` operator enables you to insert a field that is not present already by using the `!`
symbol at the end of the selector expression. When the field is not present, the operator binds a
`null` value to the variable.

The following example updates each object in the array `myInput`. If the field `name` is present in
the object, the example applies the `upper` function to the value of `name`. If the field `name` is
not present in the object, the example appends the key-value pair `"name": "JOHN"` to the object.

Source

```weave
%dw 2.0
var myInput = [{"lastName": "Doe"}, {"lastName": "Parker", "name": "Peter" }]
output application/json
---
myInput  map ((value) ->
    value update {
        case name at .name! -> if(name == null) "JOHN" else upper(name)
    }
)
```

Output

```json
[
  {
    "lastName": "Doe",
    "name": "JOHN"
  },
  {
    "lastName": "Parker",
    "name": "PETER"
  }
]
```

### Sugar Syntax

The `update` operator accepts a default variable named `$` in place of the longer
`<variable_name> at` syntax.

The following example binds the value of the expression `.age` to the default variable name `$`,
which is used to express the new value. The longer equivalent is shown in comments.

Input

```json
{
  "name": "Ken",
  "lastName": "Shokida",
  "age": 30,
  "address": {
    "street": "Amenabar",
    "zipCode": "AB1234"
  }
}
```

Source

```weave
%dw 2.0
output application/json
---
payload update {
    //equivalent expression:
    //case age at .age -> age + 1
    case .age -> $ + 1
    case .address.street -> "First Street"
}
```

Output

```json
{
  "name": "Ken",
  "lastName": "Shokida",
  "age": 31,
  "address": {
    "street": "First Street",
    "zipCode": "AB1234"
  }
}
```

## Metadata Assignment Operator

DataWeave supports the metadata assignment operator `<~`, which enables you to set the metadata of
any value without using the `as` operator. This operator is useful when you want to set the metadata
and retain the current value type. If you are coercing the value to a new type, use
[as](https://docs.mulesoft.com/dataweave/2.12/dataweave-types-coercion).

_Introduced in DataWeave 2.5.0. Supported by Mule 4.5 and later._

The operator syntax is as follows:

```none
<valueB> <~ <objectA>
```

The operator assigns `objectA` as metadata to `valueB`. The arrow points to the value to which the
metadata is assigned.

Versions prior to Mule 4.5 require the following syntax, for example, to add the `class` metadata
field to an object:

```weave
%dw 2.0
---
{name: "Ken"} as Object {class: "Person"}
```

In Mule 4.5, the metadata assignment operator `<~` simplifies the syntax:

```weave
%dw 2.0
---
{name: "Ken"} <~ {class: "Person"}
```

### Metadata Assignment Using Metadata Annotations

DataWeave adds support for metadata annotations. These special annotations, marked with `@Metadata`,
attach a key-value pair metadata to any value where they are used.

_Introduced in DataWeave 2.8.0._

The following example achieves the same result as the previous one, but by defining an annotation,
which is a class that binds the metadata key `class` to the value provided where it is used.

```weave
%dw 2.8

@Metadata(key="class")
annotation Class(value: String)
---
@Class(value="Person")
{name: "Ken"}
```

Defining metadata using annotations provides the following benefits:

- You can define annotations once and reuse them as metadata throughout your code.

- Annotations are additive, and using more than one annotation attaches all the key-value pairs
  together.

- You get type checking, enabling you to force the value of the annotation to be of a certain type,
  ensuring consistency.

However, there are certain restrictions when defining metadata annotations:

- Annotations marked with `@Metadata` can only have one parameter.

- The parameter must be called `value`.

- The metadata key is the value set to the key argument of the metadata annotation, not the name of
  the annotation itself (In the previous example, the metadata value is associated to the `class`
  key).

- Metadata annotations are additive, so if they are used on a reference that already has metadata,
  the new metadata is appended.

The following is an example of a metadata annotation that marks a value as CData for the XML
writter.

Source

```weave
%dw 2.8
output application/xml

@Metadata(key="cdata")
annotation CData(value: true)
---
root: {
 test: @CData(value = true) "testCData"
}
```

Output

```xml
<?xml version='1.0' encoding='UTF-8'?>
<root>
  <test><![CDATA[testCData]]></test>
</root>
```

### Metadata

Metadata is any additional information attached to a value that doesn’t affect its identity. Given
any two values `A` and `B` that are equal, if you attach metadata to `A` and call it `A'`, then
`A == A' == B`. So you can define a value that is formed by the value and the metadata attached to
it.

<!-- document id=cf4631fda18fd0d84da01dacce7466ee43008e6b8e32d6acb9d2537759b42f68 url=/mulesoft/current/en-us/dataweave/2.3/dw-operators.md -->

---
product: DataWeave
version: 2.3
---

# DataWeave Operators

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave version 2 supports several operators, including mathematical operators, equality
operators, and operators such as prepend, append and update.

## Mathematical Operators

DataWeave version 2 supports the most common mathematical operators:

<table><colgroup><col> <col></colgroup><thead><tr><th>Operator</th><th>Description</th></tr></thead><tbody><tr><td><p><code>+</code></p></td><td><p>For addition.</p></td></tr><tr><td><p><code>-</code></p></td><td><p>For subtraction.</p></td></tr><tr><td><p><code>*</code></p></td><td><p>For multiplication.</p></td></tr><tr><td><p><code>/</code></p></td><td><p>For division.</p></td></tr></tbody></table>

In addition to operating with numbers, the `(-)` and `(+)` operators can also operate with complex
data structures like arrays, objects, and dates.

The following example uses mathematical operators with different data types:

Source

```dataweave
%dw 2.0
output application/json
---
{ "mathOperators" : [
    { "2 + 2" : (2 + 2) },
    { "2 - 2" : (2 - 2) },
    { "2 * 2" : (2 * 2) },
    { "2 / 2" : (2 / 2) },
    { "[1,2,3] - 1 + 4" : [1,2,3] - 1 + 4},
    { "{a:1, b:2, c:3} - 'a' " : {a:1, b:2, c:3} - "a"},
    { "|2021-03-02T10:39:59| - |P1D| + |PT3H|" : |2021-03-02T10:39:59| - |P1D| + |PT3H|}
  ]
}
```

Output

```json
{
  "mathOperators": [
    { "2 + 2": 4 },
    { "2 - 2": 0 },
    { "2 * 2": 4 },
    { "2 / 2": 1 },
    { "[1,2,3] - 1 + 4": [2, 3, 4] },
    { "{a:1, b:2, c:3} - 'a' ": { "b": 2, "c": 3 } },
    { "|2021-03-02T10:39:59| - |P1D| + |PT3H|": "2021-03-01T13:39:59" }
  ]
}
```

Several DataWeave functions operate on numbers, for example: [sum](https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-sum),
[mod](https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-mod) (for modulo), and [avg](https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-abs) (for average).

## Equality and Relational Operators

DataWeave version 2 supports the following equality and relational operators:

<table><colgroup><col> <col></colgroup><thead><tr><th>Operator</th><th>Description</th></tr></thead><tbody><tr><td><p><code>&lt;</code></p></td><td><p>For less than.</p></td></tr><tr><td><p><code>&gt;</code></p></td><td><p>For greater than.</p></td></tr><tr><td><p><code>&lt;=</code></p></td><td><p>For less than or equal to.</p></td></tr><tr><td><p><code>&gt;=</code></p></td><td><p>For greater than or equal to.</p></td></tr><tr><td><p><code>==</code></p></td><td><p>For equal to.</p></td></tr><tr><td><p><code>~=</code></p></td><td><p>Equality operator that tries to coerce one value to the type of the other when the types are different.</p></td></tr></tbody></table>

Note that you can negate these operators by using the [logical operator](#logical_operators), `not`.

The following example uses relational operators:

Source

```dataweave
%dw 2.0
output application/json
---
{ "relational" : [
    { "1 < 1" : (1 < 1) },
    { "1 > 2" : (1 > 2) },
    { "1 <= 1" : (1 <= 1) },
    { "1 >= 1" : (1 >= 1) }
  ]
}
```

Output

```json
{
  "relational": [
    { "(1 < 1)": false },
    { "(1 > 2)": false },
    { "(1 <= 1)": true },
    { "(1 >= 1)": true }
  ]
}
```

Note that if the operands of the relational operator belong to different types, DataWeave coerces
the right-side operand to the type of the left-side operand. For example, in the expression
`"123" > 12` DataWeave coerces `12` (a Number type) to `"12"` (a String type) and compares each
String value lexicographically. In the expression `123 > "12"`, DataWeave coerces the String value
`"12"` to the Number value `12` and compares the numbers.

These examples use equality operators:

Source

```dataweave
%dw 2.0
output application/dw
---
{ "equality" :
  [
    (1 == 1),
    (1 == 2),
    ("true" == true),
    ("true" ~= true),
    (['true'] ~= [true]),
    ('1' ~= 1)
  ]
}
```

Output

```text
{
  equality: [ true, false, false, true, true, true ]
}
```

## Logical Operators

DataWeave version 2 supports the following logical operators:

<table><colgroup><col> <col></colgroup><thead><tr><th>Operator</th><th>Description</th></tr></thead><tbody><tr><td><p><code>not</code></p></td><td><p>Negates the result of the input. See also, <code>!</code>.</p></td></tr><tr><td><p><code>!</code></p></td><td><p>Negates the result of the input. See also, <code>not</code>. <em>Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later.</em></p></td></tr><tr><td><p><code>and</code></p></td><td><p>Returns <code>true</code> if the result of all inputs is true, <code>false</code> if not.</p></td></tr><tr><td><p><code>or</code></p></td><td><p>Returns <code>true</code> if the result of any input is true, <code>false</code> if not.</p></td></tr></tbody></table>

> [!NOTE] Though the semantics of `not` and `!` are the same, their precedence differs.
> `not true or true` is executed as `not (true or true)`, so it returns `false`, whereas
> `!true or true` returns `true` because the `!` only applies to the first `true`. `!(true or true)`
> returns `false`.

The following examples use logical operators:

Source

```dataweave
%dw 2.0
var myArray = [1,2,3,4,5]
var myMap = myArray map not (($ mod 2) == 0)
output application/json
---
{
  "not" : [
    "notTrue" : not true,
    "notFalse" : not false,
    "myMapWithNot" : myMap
  ],
  "and" : [
    "andTrueFalse" : true and false,
    "andIsTrue" : (1 + 1 == 2) and (2 + 2 == 4),
    "andIsFalse" : (1 + 1 == 2) and (2 + 2 == 2)
  ],
  "or" : [
    "orTrueFalse" : true or false,
    "orIsTrue" : (1 + 1 == 2) or (2 + 2 == 2),
    "orIsFalse" : (1 + 1 == 1) or (2 + 2 == 2)
  ],
  "!-vs-not" : [
	  "example-!" : (! true or true),
	  "example-not" : (not true or true)
  ]
}
```

Note that `myMap` iterates through the items in a list (`myArray`) and determines whether the modulo
(`mod`) expression _does not_ evaluate to `0` when applied to each given item.

Output

```json
{
  "not": [
    { "notTrue": false },
    { "notFalse": true },
    { "myMapWithNot": [true, false, true, false, true] }
  ],
  "and": [{ "andTrueFalse": false }, { "andIsTrue": true }, { "andIsFalse": false }],
  "or": [{ "orTrueFalse": true }, { "orIsTrue": true }, { "orIsFalse": false }],
  "!-vs-not": [{ "example-!": true }, { "example-not": false }]
}
```

Note that `not` works in expressions such as `not (true)`, but `not(true)` (without the space) does
not work.

You can use logical operators together. The following example uses:

- `or not` as defined in the `orNot` expression.

- `and not` in `andNot`.

- `not` and `and not` in `notWithAndNot`.

```dataweave
%dw 2.0
var orNot = if (1 + 1 == 4 or not 1 == 2) {"answer": "orNot - Condition met"}
             else {"answer": "nope"}
var andNot = if (1 + 1 == 2 and not 1 == 2) {"answer": "andNot - Condition met"}
             else {"answer": "nope"}
var notWithAndNot = if (not (1 + 1 == 2 and not 1 == 1)) {"answer": "notWithAndNot - Condition met"}
              else {"answer": "nope"}
output application/json
---
{ "answers" :
  [
    orNot,
    andNot,
    notWithAndNot
  ]
}
```

Output

```json
{
  "answers": [
    { "answer": "orNot - Condition met" },
    { "answer": "andNot - Condition met" },
    { "answer": "notWithAndNot - Condition met" }
  ]
}
```

DataWeave executes the code inside each `if` block because all conditional expressions in the
example evaluate to `true`.

## Prepend, Append, and Remove Operators for Arrays

DataWeave version 2 supports operators for appending and prepending items within an array:

<table><colgroup><col> <col></colgroup><thead><tr><th>Operator</th><th>Description</th></tr></thead><tbody><tr><td><p><code>&gt;&gt;</code></p></td><td><p>Prepends data on the left-hand side of the operator to items in the array on the right-hand side. For example, <code>1 &gt;&gt; [2]</code> results in <code>[ 1, 2 ]</code>, prepending <code>1</code> to <code>2</code> in the array.</p></td></tr><tr><td><p><code>&lt;&lt;</code></p></td><td><p>Appends data on the right-hand side of the operator to items in the array on the left-hand side. For example, <code>[1] &lt;&lt; 2</code> results in <code>[ 1, 2 ]</code>, appending <code>2</code> to <code>1</code> in the array.</p></td></tr><tr><td><p><code>+</code></p></td><td><p>Appends data on the right-hand side of the operator to items in the array on the left-hand side. For example, <code>[1] + 2</code> results in <code>[ 1, 2 ]</code>, appending <code>2</code> to <code>1</code> in the array. The array is always on the left-hand side of the operator.</p></td></tr><tr><td><p><code>-</code></p></td><td><p>Removes a specified element of any supported type from an array.</p></td></tr></tbody></table>

The following examples show uses of prepend, append, and remove operators on arrays:

```dataweave
%dw 2.0
output application/json
---
{
  "prepend-append" : [
  	 // Array on right side when prepending.
     { "prepend" : 1 >> [2] },
     { "prepend-number" : 1 >> [1] },
     { "prepend-string" : "a" >> [1] },
     { "prepend-object" : { "a" : "b"} >> [1] },
     { "prepend-array" : [1] >> [2, 3] },
     { "prepend-binary" : (1 as Binary) >> [1] },
     { "prepend-date-time" : |23:57:59Z| >> [ |2017-10-01| ] },
  	 // Array is on left side when appending.
     { "append-number" : [1] << 2 },
     { "append-string" : [1] << "a" },
     { "append-object" : [1] << { "a" : "b"} },
     { "append-array" : [1,2] << [1, 2, 3] },
     { "append-binary" : [1] << (1 as Binary) },
     { "append-date-time" : [ |2017-10-01| ] << |23:57:59Z| },
     { "append-object-to-array" : [1,2] << {"a" : "b"} },
     { "append-array-to-array1" : ["a","b"] << ["c","d"] },
     { "append-array-to-array2" : [["a","b"],["c","d"]] << ["e","f"] },
     // + always appends within the array
     { "append-with-+" : [1] + 2 },
     { "append-with-+" : [2] + 1 },
     { "removeNumberFromArray" : ( [1,2,3] - 2 ) },
     { "removeObjectFromArray" : ( [ {a : "b"}, {c : "d"} , { e : "f"} ] - { c : "d"} ) }
  ]
}
```

Output

```json
{
  "prepend-append": [
    { "prepend": [1, 2] },
    { "prepend-number": [1, 1] },
    { "prepend-string": ["a", 1] },
    { "prepend-array": [[1], 2, 3] },
    { "prepend-object": [{ "a": "b" }, 1] },
    { "prepend-binary": ["\u0001", 1] },
    { "prepend-date-time": ["23:57:59Z", "2017-10-01"] },
    { "append-number": [1, 2] },
    { "append-string": [1, "a"] },
    { "append-object": [1, { "a": "b" }] },
    { "append-array": [1, 2, [1, 2, 3]] },
    { "append-binary": [1, "\u0001"] },
    { "append-date-time": ["2017-10-01", "23:57:59Z"] },
    { "append-object-to-array": [1, 2, { "a": "b" }] },
    { "append-array-to-array1": ["a", "b", ["c", "d"]] },
    {
      "append-array-to-array2": [
        ["a", "b"],
        ["c", "d"],
        ["e", "f"]
      ]
    },
    { "append-with-+": [1, 2] },
    { "append-with-+": [2, 1] },
    { "removeNumberFromArray": [1, 3] },
    { "removeObjectFromArray": [{ "a": "b" }, { "e": "f" }] }
  ]
}
```

## Scope and Flow Control Operators

DataWeave version 2 supports operators that control the flow and scope of expressions:

- [`do` and `using`](#control_flow_do)

- [`if else` and `else if`](#control_flow_if)

<table id="control_flow_do"><caption>Table 1. Scope Operators:</caption> <colgroup><col> <col></colgroup><thead><tr><th>Operator</th><th>Description</th></tr></thead><tbody><tr><td><p><code>do</code></p></td><td><p>Creates a scope in which new variables, functions, annotations, or namespaces can be declared and used. The syntax is similar to a mapping in that it is composed of a header and body separated by <code>---</code>. Its header is where all the declarations are defined, and its body is the result of the expression. See <a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-flow-control#control_flow_do">do</a> and <a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-variables#example_local_variable">Examples: Local DataWeave Variables</a> for examples.</p></td></tr><tr><td><p><code>using</code></p></td><td><p>Replaced by <code>do</code>. Supported for backwards compatibility only.</p></td></tr></tbody></table>

<table id="control_flow_if"><caption>Table 2. Flow Control Operators:</caption> <colgroup><col> <col></colgroup><thead><tr><th>Operator</th><th>Description</th></tr></thead><tbody><tr><td><p><code>if else</code></p></td><td><div><div><p>An <code>if</code> operator evaluates a conditional expression and returns the value under the <code>if</code> only if the conditional expression is true. Otherwise, it returns the expression under <code>else</code>. Every <code>if</code> expression must have a matching <code>else</code> expression. See <a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-flow-control#control_flow_if_else">if else</a> for an example.</p></div></div></td></tr><tr><td><p><code>else if</code></p></td><td><p>An <code>else</code> operator chains expressions together within an if-else construct by incorporating <code>else if</code>. See <a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-flow-control#control_flow_else_if">else if</a> for an example.</p></td></tr></tbody></table>

## Update Operator

DataWeave supports the `update` operator, which enables you to update specified fields of a data
structure with new values.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

Versions prior to Mule 4.3 require the following syntax to increase the `age` value in `myInput` by
one without recreating the entire object:

```weave
%dw 2.0
var myInput = {
    "name": "Ken",
    "lastName":"Shokida",
    "age": 30
}
output application/json
---
myInput mapObject ((value,key) ->
    if(key as String == "age")
       {(key): value as Number + 1}
    else
       {(key): value} )
```

In Mule 4.3, the `update` operator simplifies the syntax:

```weave
%dw 2.0
var myInput = {
    "name": "Ken",
    "lastName":"Shokida",
    "age": 30
}
output application/json
---
myInput update {
    case age at .age -> age + 1
}
```

Both DataWeave scripts return the same result:

```JSON
{
  "name": "Ken",
  "lastName": "Shokida",
  "age": 31
}
```

With `update`, casting or iterating through all the key-value pairs is not necessary.

The `update` syntax is as follows:

```weave
<value_to_update> update {
    case <variable_name> at <update_expression>[!]? [if(<conditional_expression>)]? -> <new value>
    ...
}
```

- `value_to_update` represents the original value to update.

- `update_expression` is the selector expression that matches a value in `value_to_update`.

- `variable_name` is the name of the variable to bind to the matched `update_expression` value.

- `new_value` is the expression with the new value.

- `[if(<conditional_expression>)]?` If `conditional_expression` returns `true`, the script updates
  the value. Use of a conditional expression is optional.

- `[!]` marks the selector as an upsert. If the expression doesn’t find a match, the `!` makes the
  `update` operator create all the required elements and insert the new value.

- `update_expression` supports multiple `case` expressions.

> [!NOTE] The `update` operator doesn’t mutate the existing value. Instead, the operator creates a
> new value with the updated expressions.

### Selector Expressions

Use selector expressions with the `update` operator to specify the fields to update.

#### Value Selector

This matching selector can check for matches to any value within an object.

The following example updates a field at the root level and a field in a nested level using the
value selector:

Source

```weave
%dw 2.0
var myInput = {
    "name": "Ken",
    "lastName":"Shokida",
    "age": 30,
    "address": {
        "street": "Amenabar",
        "zipCode": "AB1234"
    }
}
output application/json
---
myInput update {
    case age at .age -> age + 1
    case s at .address.street -> "First Street"
}
```

Output

```json
{
  "name": "Ken",
  "lastName": "Shokida",
  "age": 31,
  "address": {
    "street": "First Street",
    "zipCode": "AB1234"
  }
}
```

#### Index Selector

This matching selector enables you to match any array by its index.

The following example updates an element that is at the first location of the array:

Input

```json
{
  "name": "Ken",
  "lastName": "Shokida",
  "age": 30,
  "addresses": [
    {
      "street": "Amenabar",
      "zipCode": "AB1234"
    }
  ]
}
```

Source

```weave
%dw 2.0
output application/json
---
payload update {
    case s at .addresses[0] -> {
        "street": "Second Street",
        "zipCode": "ZZ123"
    }
}
```

Output

```json
{
  "name": "Ken",
  "lastName": "Shokida",
  "age": 30,
  "addresses": [
    {
      "street": "Second Street",
      "zipCode": "ZZ123"
    }
  ]
}
```

#### Attribute Selector

This matching selector enables you to match any attribute value.

The following example updates an attribute value and changes it to upper case:

Input

```xml
<user name="leandro"/>
```

Source

```weave
%dw 2.0
output application/xml
---
payload update {
    case name at .user.@name -> upper(name)
}
```

Output

```xml
<?xml version='1.0' encoding='UTF-8'?>
<user name="LEANDRO"/>
```

#### Dynamic Selector

Any selector can incorporate an expression to make the selection dynamic.

The following example dynamically selects and updates the value of a field that is not hardcoded.
Such a field can change at runtime. The example uses the variable `theFieldName` to obtain the field
with key `name`, and it changes the value of that field to `Shoki`.

Input

```json
{
  "name": "Ken",
  "lastName": "Shokida"
}
```

Source

```weave
%dw 2.0
var theFieldName = "name"
output application/json
---
payload update {
    case s at ."$(theFieldName)" -> "Shoki"
}
```

Output

```json
{
  "name": "Shoki",
  "lastName": "Shokida"
}
```

### Conditional Update

The `update` operator has syntax for writing a conditional update if you want to modify a field
under a given condition.

The following example updates the category based on the name of the user:

Input

```json
[
  { "name": "Ken", "age": 30 },
  { "name": "Tomo", "age": 70 },
  { "name": "Kajika", "age": 10 }
]
```

Source

```weave
%dw 2.0
output application/json
---
payload map ((user) ->
    user update {
        case name at .name if(name == "Ken") -> name ++ " (Leandro)"
        case name at .name if(name == "Tomo") -> name ++ " (Christian)"
    }
)
```

Output

```json
[
  {
    "name": "Ken (Leandro)",
    "age": 30
  },
  {
    "name": "Tomo (Christian)",
    "age": 70
  },
  {
    "name": "Kajika",
    "age": 10
  }
]
```

### Upserting

The `update` operator enables you to insert a field that is not present already by using the `!`
symbol at the end of the selector expression. When the field is not present, the operator binds a
`null` value to the variable.

The following example updates each object in the array `myInput`. If the field `name` is present in
the object, the example applies the `upper` function to the value of `name`. If the field `name` is
not present in the object, the example appends the key-value pair `"name": "JOHN"` to the object.

Source

```weave
%dw 2.0
var myInput = [{"lastName": "Doe"}, {"lastName": "Parker", "name": "Peter" }]
output application/json
---
myInput  map ((value) ->
    value update {
        case name at .name! -> if(name == null) "JOHN" else upper(name)
    }
)
```

Output

```json
[
  {
    "lastName": "Doe",
    "name": "JOHN"
  },
  {
    "lastName": "Parker",
    "name": "PETER"
  }
]
```

### Sugar Syntax

The `update` operator accepts a default variable named `$` in place of the longer
`<variable_name> at` syntax.

The following example binds the value of the expression `.age` to the default variable name `$`,
which is used to express the new value. The longer equivalent is shown in comments.

Input

```json
{
  "name": "Ken",
  "lastName": "Shokida",
  "age": 30,
  "address": {
    "street": "Amenabar",
    "zipCode": "AB1234"
  }
}
```

Source

```weave
%dw 2.0
output application/json
---
payload update {
    //equivalent expression:
    //case age at .age -> age + 1
    case .age -> $ + 1
    case .address.street -> "First Street"
}
```

Output

```json
{
  "name": "Ken",
  "lastName": "Shokida",
  "age": 31,
  "address": {
    "street": "First Street",
    "zipCode": "AB1234"
  }
}
```

<!-- document id=37696e7c8542ddbb987872454cc5e9df02e38864e4bdb66d975261ec14f692f0 url=/mulesoft/current/en-us/dataweave/2.4/dw-operators.md -->

---
product: DataWeave
version: 2.4
---

# DataWeave Operators

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave supports several operators, including mathematical operators, equality operators, and
operators such as prepend, append and update.

## Mathematical Operators

DataWeave supports the most common mathematical operators:

<table><colgroup><col> <col></colgroup><thead><tr><th>Operator</th><th>Description</th></tr></thead><tbody><tr><td><p><code>+</code></p></td><td><p>For addition.</p></td></tr><tr><td><p><code>-</code></p></td><td><p>For subtraction.</p></td></tr><tr><td><p><code>*</code></p></td><td><p>For multiplication.</p></td></tr><tr><td><p><code>/</code></p></td><td><p>For division.</p></td></tr></tbody></table>

In addition to operating with numbers, the `(-)` and `(+)` operators can also operate with complex
data structures like arrays, objects, and dates.

The following example uses mathematical operators with different data types:

Source

```dataweave
%dw 2.0
output application/json
---
{ "mathOperators" : [
    { "2 + 2" : (2 + 2) },
    { "2 - 2" : (2 - 2) },
    { "2 * 2" : (2 * 2) },
    { "2 / 2" : (2 / 2) },
    { "[1,2,3] - 1 + 4" : [1,2,3] - 1 + 4},
    { "{a:1, b:2, c:3} - 'a' " : {a:1, b:2, c:3} - "a"},
    { "|2021-03-02T10:39:59| - |P1D| + |PT3H|" : |2021-03-02T10:39:59| - |P1D| + |PT3H|}
  ]
}
```

Output

```json
{
  "mathOperators": [
    { "2 + 2": 4 },
    { "2 - 2": 0 },
    { "2 * 2": 4 },
    { "2 / 2": 1 },
    { "[1,2,3] - 1 + 4": [2, 3, 4] },
    { "{a:1, b:2, c:3} - 'a' ": { "b": 2, "c": 3 } },
    { "|2021-03-02T10:39:59| - |P1D| + |PT3H|": "2021-03-01T13:39:59" }
  ]
}
```

Several DataWeave functions operate on numbers, for example: [sum](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-sum),
[mod](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-mod) (for modulo), and [avg](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-abs) (for average).

## Equality and Relational Operators

DataWeave supports the following equality and relational operators:

<table><colgroup><col> <col></colgroup><thead><tr><th>Operator</th><th>Description</th></tr></thead><tbody><tr><td><p><code>&lt;</code></p></td><td><p>For less than.</p></td></tr><tr><td><p><code>&gt;</code></p></td><td><p>For greater than.</p></td></tr><tr><td><p><code>&lt;=</code></p></td><td><p>For less than or equal to.</p></td></tr><tr><td><p><code>&gt;=</code></p></td><td><p>For greater than or equal to.</p></td></tr><tr><td><p><code>==</code></p></td><td><p>For equal to.</p></td></tr><tr><td><p><code>~=</code></p></td><td><p>Equality operator that tries to coerce one value to the type of the other when the types are different.</p></td></tr></tbody></table>

Note that you can negate these operators by using the [logical operator](#logical_operators), `not`.

The following example uses relational operators:

Source

```dataweave
%dw 2.0
output application/json
---
{ "relational" : [
    { "1 < 1" : (1 < 1) },
    { "1 > 2" : (1 > 2) },
    { "1 <= 1" : (1 <= 1) },
    { "1 >= 1" : (1 >= 1) }
  ]
}
```

Output

```json
{
  "relational": [
    { "(1 < 1)": false },
    { "(1 > 2)": false },
    { "(1 <= 1)": true },
    { "(1 >= 1)": true }
  ]
}
```

Note that if the operands of the relational operator belong to different types, DataWeave coerces
the right-side operand to the type of the left-side operand. For example, in the expression
`"123" > 12` DataWeave coerces `12` (a Number type) to `"12"` (a String type) and compares each
String value lexicographically. In the expression `123 > "12"`, DataWeave coerces the String value
`"12"` to the Number value `12` and compares the numbers.

These examples use equality operators:

Source

```dataweave
%dw 2.0
output application/dw
---
{ "equality" :
  [
    (1 == 1),
    (1 == 2),
    ("true" == true),
    ("true" ~= true),
    (['true'] ~= [true]),
    ('1' ~= 1)
  ]
}
```

Output

```text
{
  equality: [ true, false, false, true, true, true ]
}
```

## Logical Operators

DataWeave supports the following logical operators:

<table><colgroup><col> <col></colgroup><thead><tr><th>Operator</th><th>Description</th></tr></thead><tbody><tr><td><p><code>not</code></p></td><td><p>Negates the result of the input. See also, <code>!</code>.</p></td></tr><tr><td><p><code>!</code></p></td><td><p>Negates the result of the input. See also, <code>not</code>. <em>Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later.</em></p></td></tr><tr><td><p><code>and</code></p></td><td><p>Returns <code>true</code> if the result of all inputs is true, <code>false</code> if not.</p></td></tr><tr><td><p><code>or</code></p></td><td><p>Returns <code>true</code> if the result of any input is true, <code>false</code> if not.</p></td></tr></tbody></table>

> [!NOTE] Though the semantics of `not` and `!` are the same, their precedence differs.
> `not true or true` is executed as `not (true or true)`, so it returns `false`, whereas
> `!true or true` returns `true` because the `!` only applies to the first `true`. `!(true or true)`
> returns `false`.

The following examples use logical operators:

Source

```dataweave
%dw 2.0
var myArray = [1,2,3,4,5]
var myMap = myArray map not (($ mod 2) == 0)
output application/json
---
{
  "not" : [
    "notTrue" : not true,
    "notFalse" : not false,
    "myMapWithNot" : myMap
  ],
  "and" : [
    "andTrueFalse" : true and false,
    "andIsTrue" : (1 + 1 == 2) and (2 + 2 == 4),
    "andIsFalse" : (1 + 1 == 2) and (2 + 2 == 2)
  ],
  "or" : [
    "orTrueFalse" : true or false,
    "orIsTrue" : (1 + 1 == 2) or (2 + 2 == 2),
    "orIsFalse" : (1 + 1 == 1) or (2 + 2 == 2)
  ],
  "!-vs-not" : [
	  "example-!" : (! true or true),
	  "example-not" : (not true or true)
  ]
}
```

Note that `myMap` iterates through the items in a list (`myArray`) and determines whether the modulo
(`mod`) expression _does not_ evaluate to `0` when applied to each given item.

Output

```json
{
  "not": [
    { "notTrue": false },
    { "notFalse": true },
    { "myMapWithNot": [true, false, true, false, true] }
  ],
  "and": [{ "andTrueFalse": false }, { "andIsTrue": true }, { "andIsFalse": false }],
  "or": [{ "orTrueFalse": true }, { "orIsTrue": true }, { "orIsFalse": false }],
  "!-vs-not": [{ "example-!": true }, { "example-not": false }]
}
```

Note that `not` works in expressions such as `not (true)`, but `not(true)` (without the space) does
not work.

You can use logical operators together. The following example uses:

- `or not` as defined in the `orNot` expression.

- `and not` in `andNot`.

- `not` and `and not` in `notWithAndNot`.

```dataweave
%dw 2.0
var orNot = if (1 + 1 == 4 or not 1 == 2) {"answer": "orNot - Condition met"}
             else {"answer": "nope"}
var andNot = if (1 + 1 == 2 and not 1 == 2) {"answer": "andNot - Condition met"}
             else {"answer": "nope"}
var notWithAndNot = if (not (1 + 1 == 2 and not 1 == 1)) {"answer": "notWithAndNot - Condition met"}
              else {"answer": "nope"}
output application/json
---
{ "answers" :
  [
    orNot,
    andNot,
    notWithAndNot
  ]
}
```

Output

```json
{
  "answers": [
    { "answer": "orNot - Condition met" },
    { "answer": "andNot - Condition met" },
    { "answer": "notWithAndNot - Condition met" }
  ]
}
```

DataWeave executes the code inside each `if` block because all conditional expressions in the
example evaluate to `true`.

## Prepend, Append, and Remove Operators for Arrays

DataWeave supports operators for appending and prepending items within an array:

<table><colgroup><col> <col></colgroup><thead><tr><th>Operator</th><th>Description</th></tr></thead><tbody><tr><td><p><code>&gt;&gt;</code></p></td><td><p>Prepends data on the left-hand side of the operator to items in the array on the right-hand side. For example, <code>1 &gt;&gt; [2]</code> results in <code>[ 1, 2 ]</code>, prepending <code>1</code> to <code>2</code> in the array.</p></td></tr><tr><td><p><code>&lt;&lt;</code></p></td><td><p>Appends data on the right-hand side of the operator to items in the array on the left-hand side. For example, <code>[1] &lt;&lt; 2</code> results in <code>[ 1, 2 ]</code>, appending <code>2</code> to <code>1</code> in the array.</p></td></tr><tr><td><p><code>+</code></p></td><td><p>Appends data on the right-hand side of the operator to items in the array on the left-hand side. For example, <code>[1] + 2</code> results in <code>[ 1, 2 ]</code>, appending <code>2</code> to <code>1</code> in the array. The array is always on the left-hand side of the operator.</p></td></tr><tr><td><p><code>-</code></p></td><td><p>Removes a specified element of any supported type from an array.</p></td></tr></tbody></table>

The following examples show uses of prepend, append, and remove operators on arrays:

```dataweave
%dw 2.0
output application/json
---
{
  "prepend-append" : [
  	 // Array on right side when prepending.
     { "prepend" : 1 >> [2] },
     { "prepend-number" : 1 >> [1] },
     { "prepend-string" : "a" >> [1] },
     { "prepend-object" : { "a" : "b"} >> [1] },
     { "prepend-array" : [1] >> [2, 3] },
     { "prepend-binary" : (1 as Binary) >> [1] },
     { "prepend-date-time" : |23:57:59Z| >> [ |2017-10-01| ] },
  	 // Array is on left side when appending.
     { "append-number" : [1] << 2 },
     { "append-string" : [1] << "a" },
     { "append-object" : [1] << { "a" : "b"} },
     { "append-array" : [1,2] << [1, 2, 3] },
     { "append-binary" : [1] << (1 as Binary) },
     { "append-date-time" : [ |2017-10-01| ] << |23:57:59Z| },
     { "append-object-to-array" : [1,2] << {"a" : "b"} },
     { "append-array-to-array1" : ["a","b"] << ["c","d"] },
     { "append-array-to-array2" : [["a","b"],["c","d"]] << ["e","f"] },
     // + always appends within the array
     { "append-with-+" : [1] + 2 },
     { "append-with-+" : [2] + 1 },
     { "removeNumberFromArray" : ( [1,2,3] - 2 ) },
     { "removeObjectFromArray" : ( [ {a : "b"}, {c : "d"} , { e : "f"} ] - { c : "d"} ) }
  ]
}
```

Output

```json
{
  "prepend-append": [
    { "prepend": [1, 2] },
    { "prepend-number": [1, 1] },
    { "prepend-string": ["a", 1] },
    { "prepend-array": [[1], 2, 3] },
    { "prepend-object": [{ "a": "b" }, 1] },
    { "prepend-binary": ["\u0001", 1] },
    { "prepend-date-time": ["23:57:59Z", "2017-10-01"] },
    { "append-number": [1, 2] },
    { "append-string": [1, "a"] },
    { "append-object": [1, { "a": "b" }] },
    { "append-array": [1, 2, [1, 2, 3]] },
    { "append-binary": [1, "\u0001"] },
    { "append-date-time": ["2017-10-01", "23:57:59Z"] },
    { "append-object-to-array": [1, 2, { "a": "b" }] },
    { "append-array-to-array1": ["a", "b", ["c", "d"]] },
    {
      "append-array-to-array2": [
        ["a", "b"],
        ["c", "d"],
        ["e", "f"]
      ]
    },
    { "append-with-+": [1, 2] },
    { "append-with-+": [2, 1] },
    { "removeNumberFromArray": [1, 3] },
    { "removeObjectFromArray": [{ "a": "b" }, { "e": "f" }] }
  ]
}
```

## Scope and Flow Control Operators

DataWeave supports operators that control the flow and scope of expressions:

- [`do` and `using`](#control_flow_do)

- [`if else` and `else if`](#control_flow_if)

<table id="control_flow_do"><caption>Table 1. Scope Operators:</caption> <colgroup><col> <col></colgroup><thead><tr><th>Operator</th><th>Description</th></tr></thead><tbody><tr><td><p><code>do</code></p></td><td><p>Creates a scope in which new variables, functions, annotations, or namespaces can be declared and used. The syntax is similar to a mapping in that it is composed of a header and body separated by <code>---</code>. Its header is where all the declarations are defined, and its body is the result of the expression. See <a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-flow-control#control_flow_do">do</a> and <a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-variables#example_local_variable">Examples: Local DataWeave Variables</a> for examples.</p></td></tr><tr><td><p><code>using</code></p></td><td><p>Replaced by <code>do</code>. Supported for backwards compatibility only.</p></td></tr></tbody></table>

<table id="control_flow_if"><caption>Table 2. Flow Control Operators:</caption> <colgroup><col> <col></colgroup><thead><tr><th>Operator</th><th>Description</th></tr></thead><tbody><tr><td><p><code>if else</code></p></td><td><div><div><p>An <code>if</code> operator evaluates a conditional expression and returns the value under the <code>if</code> only if the conditional expression is true. Otherwise, it returns the expression under <code>else</code>. Every <code>if</code> expression must have a matching <code>else</code> expression. See <a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-flow-control#control_flow_if_else">if else</a> for an example.</p></div></div></td></tr><tr><td><p><code>else if</code></p></td><td><p>An <code>else</code> operator chains expressions together within an if-else construct by incorporating <code>else if</code>. See <a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-flow-control#control_flow_else_if">else if</a> for an example.</p></td></tr></tbody></table>

## Update Operator

DataWeave supports the `update` operator, which enables you to update specified fields of a data
structure with new values.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

Versions prior to Mule 4.3 require the following syntax to increase the `age` value in `myInput` by
one without recreating the entire object:

```weave
%dw 2.0
var myInput = {
    "name": "Ken",
    "lastName":"Shokida",
    "age": 30
}
output application/json
---
myInput mapObject ((value,key) ->
    if(key as String == "age")
       {(key): value as Number + 1}
    else
       {(key): value} )
```

In Mule 4.3, the `update` operator simplifies the syntax:

```weave
%dw 2.0
var myInput = {
    "name": "Ken",
    "lastName":"Shokida",
    "age": 30
}
output application/json
---
myInput update {
    case age at .age -> age + 1
}
```

Both DataWeave scripts return the same result:

```JSON
{
  "name": "Ken",
  "lastName": "Shokida",
  "age": 31
}
```

With `update`, casting or iterating through all the key-value pairs is not necessary.

The `update` syntax is as follows:

```weave
<value_to_update> update {
    case <variable_name> at <update_expression>[!]? [if(<conditional_expression>)]? -> <new value>
    ...
}
```

- `value_to_update` represents the original value to update.

- `update_expression` is the selector expression that matches a value in `value_to_update`.

- `variable_name` is the name of the variable to bind to the matched `update_expression` value.

- `new_value` is the expression with the new value.

- `[if(<conditional_expression>)]?` If `conditional_expression` returns `true`, the script updates
  the value. Use of a conditional expression is optional.

- `[!]` marks the selector as an upsert. If the expression doesn’t find a match, the `!` makes the
  `update` operator create all the required elements and insert the new value.

- `update_expression` supports multiple `case` expressions.

> [!NOTE] The `update` operator doesn’t mutate the existing value. Instead, the operator creates a
> new value with the updated expressions.

### Selector Expressions

Use selector expressions with the `update` operator to specify the fields to update.

#### Value Selector

This matching selector can check for matches to any value within an object.

The following example updates a field at the root level and a field in a nested level using the
value selector:

Source

```weave
%dw 2.0
var myInput = {
    "name": "Ken",
    "lastName":"Shokida",
    "age": 30,
    "address": {
        "street": "Amenabar",
        "zipCode": "AB1234"
    }
}
output application/json
---
myInput update {
    case age at .age -> age + 1
    case s at .address.street -> "First Street"
}
```

Output

```json
{
  "name": "Ken",
  "lastName": "Shokida",
  "age": 31,
  "address": {
    "street": "First Street",
    "zipCode": "AB1234"
  }
}
```

#### Index Selector

This matching selector enables you to match any array by its index.

The following example updates an element that is at the first location of the array:

Input

```json
{
  "name": "Ken",
  "lastName": "Shokida",
  "age": 30,
  "addresses": [
    {
      "street": "Amenabar",
      "zipCode": "AB1234"
    }
  ]
}
```

Source

```weave
%dw 2.0
output application/json
---
payload update {
    case s at .addresses[0] -> {
        "street": "Second Street",
        "zipCode": "ZZ123"
    }
}
```

Output

```json
{
  "name": "Ken",
  "lastName": "Shokida",
  "age": 30,
  "addresses": [
    {
      "street": "Second Street",
      "zipCode": "ZZ123"
    }
  ]
}
```

#### Attribute Selector

This matching selector enables you to match any attribute value.

The following example updates an attribute value and changes it to upper case:

Input

```xml
<user name="leandro"/>
```

Source

```weave
%dw 2.0
output application/xml
---
payload update {
    case name at .user.@name -> upper(name)
}
```

Output

```xml
<?xml version='1.0' encoding='UTF-8'?>
<user name="LEANDRO"/>
```

#### Dynamic Selector

Any selector can incorporate an expression to make the selection dynamic.

The following example dynamically selects and updates the value of a field that is not hardcoded.
Such a field can change at runtime. The example uses the variable `theFieldName` to obtain the field
with key `name`, and it changes the value of that field to `Shoki`.

Input

```json
{
  "name": "Ken",
  "lastName": "Shokida"
}
```

Source

```weave
%dw 2.0
var theFieldName = "name"
output application/json
---
payload update {
    case s at ."$(theFieldName)" -> "Shoki"
}
```

Output

```json
{
  "name": "Shoki",
  "lastName": "Shokida"
}
```

### Conditional Update

The `update` operator has syntax for writing a conditional update if you want to modify a field
under a given condition.

The following example updates the category based on the name of the user:

Input

```json
[
  { "name": "Ken", "age": 30 },
  { "name": "Tomo", "age": 70 },
  { "name": "Kajika", "age": 10 }
]
```

Source

```weave
%dw 2.0
output application/json
---
payload map ((user) ->
    user update {
        case name at .name if(name == "Ken") -> name ++ " (Leandro)"
        case name at .name if(name == "Tomo") -> name ++ " (Christian)"
    }
)
```

Output

```json
[
  {
    "name": "Ken (Leandro)",
    "age": 30
  },
  {
    "name": "Tomo (Christian)",
    "age": 70
  },
  {
    "name": "Kajika",
    "age": 10
  }
]
```

### Upserting

The `update` operator enables you to insert a field that is not present already by using the `!`
symbol at the end of the selector expression. When the field is not present, the operator binds a
`null` value to the variable.

The following example updates each object in the array `myInput`. If the field `name` is present in
the object, the example applies the `upper` function to the value of `name`. If the field `name` is
not present in the object, the example appends the key-value pair `"name": "JOHN"` to the object.

Source

```weave
%dw 2.0
var myInput = [{"lastName": "Doe"}, {"lastName": "Parker", "name": "Peter" }]
output application/json
---
myInput  map ((value) ->
    value update {
        case name at .name! -> if(name == null) "JOHN" else upper(name)
    }
)
```

Output

```json
[
  {
    "lastName": "Doe",
    "name": "JOHN"
  },
  {
    "lastName": "Parker",
    "name": "PETER"
  }
]
```

### Sugar Syntax

The `update` operator accepts a default variable named `$` in place of the longer
`<variable_name> at` syntax.

The following example binds the value of the expression `.age` to the default variable name `$`,
which is used to express the new value. The longer equivalent is shown in comments.

Input

```json
{
  "name": "Ken",
  "lastName": "Shokida",
  "age": 30,
  "address": {
    "street": "Amenabar",
    "zipCode": "AB1234"
  }
}
```

Source

```weave
%dw 2.0
output application/json
---
payload update {
    //equivalent expression:
    //case age at .age -> age + 1
    case .age -> $ + 1
    case .address.street -> "First Street"
}
```

Output

```json
{
  "name": "Ken",
  "lastName": "Shokida",
  "age": 31,
  "address": {
    "street": "First Street",
    "zipCode": "AB1234"
  }
}
```

<!-- document id=1910c5aed967178ec02c005e6f50cb75fe6cfd09eb13bd8fe9ef91d5b5d44192 url=/mulesoft/current/en-us/dataweave/2.6/dw-operators.md -->

---
product: DataWeave
version: 2.6
---

# DataWeave Operators

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave supports several operators, including mathematical operators, equality operators, and
operators such as prepend, append and update.

## Mathematical Operators

DataWeave supports the most common mathematical operators:

<table><colgroup><col> <col></colgroup><thead><tr><th>Operator</th><th>Description</th></tr></thead><tbody><tr><td><p><code>+</code></p></td><td><p>For addition.</p></td></tr><tr><td><p><code>-</code></p></td><td><p>For subtraction.</p></td></tr><tr><td><p><code>*</code></p></td><td><p>For multiplication.</p></td></tr><tr><td><p><code>/</code></p></td><td><p>For division.</p></td></tr></tbody></table>

In addition to operating with numbers, the `(-)` and `(+)` operators can also operate with complex
data structures like arrays, objects, and dates.

The following example uses mathematical operators with different data types:

Source

```dataweave
%dw 2.0
output application/json
---
{ "mathOperators" : [
    { "2 + 2" : (2 + 2) },
    { "2 - 2" : (2 - 2) },
    { "2 * 2" : (2 * 2) },
    { "2 / 2" : (2 / 2) },
    { "[1,2,3] - 1 + 4" : [1,2,3] - 1 + 4},
    { "{a:1, b:2, c:3} - 'a' " : {a:1, b:2, c:3} - "a"},
    { "|2021-03-02T10:39:59| - |P1D| + |PT3H|" : |2021-03-02T10:39:59| - |P1D| + |PT3H|}
  ]
}
```

Output

```json
{
  "mathOperators": [
    { "2 + 2": 4 },
    { "2 - 2": 0 },
    { "2 * 2": 4 },
    { "2 / 2": 1 },
    { "[1,2,3] - 1 + 4": [2, 3, 4] },
    { "{a:1, b:2, c:3} - 'a' ": { "b": 2, "c": 3 } },
    { "|2021-03-02T10:39:59| - |P1D| + |PT3H|": "2021-03-01T13:39:59" }
  ]
}
```

Several DataWeave functions operate on numbers, for example: [sum](https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-sum),
[mod](https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-mod) (for modulo), and [avg](https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-abs) (for average).

## Equality and Relational Operators

DataWeave supports the following equality and relational operators:

<table><colgroup><col> <col></colgroup><thead><tr><th>Operator</th><th>Description</th></tr></thead><tbody><tr><td><p><code>&lt;</code></p></td><td><p>For less than.</p></td></tr><tr><td><p><code>&gt;</code></p></td><td><p>For greater than.</p></td></tr><tr><td><p><code>&lt;=</code></p></td><td><p>For less than or equal to.</p></td></tr><tr><td><p><code>&gt;=</code></p></td><td><p>For greater than or equal to.</p></td></tr><tr><td><p><code>==</code></p></td><td><p>For equal to.</p></td></tr><tr><td><p><code>~=</code></p></td><td><p>Equality operator that tries to coerce one value to the type of the other when the types are different.</p></td></tr></tbody></table>

Note that you can negate these operators by using the [logical operator](#logical_operators), `not`.

The following example uses relational operators:

Source

```dataweave
%dw 2.0
output application/json
---
{ "relational" : [
    { "1 < 1" : (1 < 1) },
    { "1 > 2" : (1 > 2) },
    { "1 <= 1" : (1 <= 1) },
    { "1 >= 1" : (1 >= 1) }
  ]
}
```

Output

```json
{
  "relational": [
    { "(1 < 1)": false },
    { "(1 > 2)": false },
    { "(1 <= 1)": true },
    { "(1 >= 1)": true }
  ]
}
```

Note that if the operands of the relational operator belong to different types, DataWeave coerces
the right-side operand to the type of the left-side operand. For example, in the expression
`"123" > 12` DataWeave coerces `12` (a Number type) to `"12"` (a String type) and compares each
String value lexicographically. In the expression `123 > "12"`, DataWeave coerces the String value
`"12"` to the Number value `12` and compares the numbers.

These examples use equality operators:

Source

```dataweave
%dw 2.0
output application/dw
---
{ "equality" :
  [
    (1 == 1),
    (1 == 2),
    ("true" == true),
    ("true" ~= true),
    (['true'] ~= [true]),
    ('1' ~= 1)
  ]
}
```

Output

```text
{
  equality: [ true, false, false, true, true, true ]
}
```

## Logical Operators

DataWeave supports the following logical operators:

<table><colgroup><col> <col></colgroup><thead><tr><th>Operator</th><th>Description</th></tr></thead><tbody><tr><td><p><code>not</code></p></td><td><p>Negates the result of the input. See also, <code>!</code>.</p></td></tr><tr><td><p><code>!</code></p></td><td><p>Negates the result of the input. See also, <code>not</code>. <em>Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later.</em></p></td></tr><tr><td><p><code>and</code></p></td><td><p>Returns <code>true</code> if the result of all inputs is true, <code>false</code> if not.</p></td></tr><tr><td><p><code>or</code></p></td><td><p>Returns <code>true</code> if the result of any input is true, <code>false</code> if not.</p></td></tr></tbody></table>

> [!NOTE] Though the semantics of `not` and `!` are the same, their precedence differs.
> `not true or true` is executed as `not (true or true)`, so it returns `false`, whereas
> `!true or true` returns `true` because the `!` only applies to the first `true`. `!(true or true)`
> returns `false`.

The following examples use logical operators:

Source

```dataweave
%dw 2.0
var myArray = [1,2,3,4,5]
var myMap = myArray map not (($ mod 2) == 0)
output application/json
---
{
  "not" : [
    "notTrue" : not true,
    "notFalse" : not false,
    "myMapWithNot" : myMap
  ],
  "and" : [
    "andTrueFalse" : true and false,
    "andIsTrue" : (1 + 1 == 2) and (2 + 2 == 4),
    "andIsFalse" : (1 + 1 == 2) and (2 + 2 == 2)
  ],
  "or" : [
    "orTrueFalse" : true or false,
    "orIsTrue" : (1 + 1 == 2) or (2 + 2 == 2),
    "orIsFalse" : (1 + 1 == 1) or (2 + 2 == 2)
  ],
  "!-vs-not" : [
	  "example-!" : (! true or true),
	  "example-not" : (not true or true)
  ]
}
```

Note that `myMap` iterates through the items in a list (`myArray`) and determines whether the modulo
(`mod`) expression _does not_ evaluate to `0` when applied to each given item.

Output

```json
{
  "not": [
    { "notTrue": false },
    { "notFalse": true },
    { "myMapWithNot": [true, false, true, false, true] }
  ],
  "and": [{ "andTrueFalse": false }, { "andIsTrue": true }, { "andIsFalse": false }],
  "or": [{ "orTrueFalse": true }, { "orIsTrue": true }, { "orIsFalse": false }],
  "!-vs-not": [{ "example-!": true }, { "example-not": false }]
}
```

Note that `not` works in expressions such as `not (true)`, but `not(true)` (without the space) does
not work.

You can use logical operators together. The following example uses:

- `or not` as defined in the `orNot` expression.

- `and not` in `andNot`.

- `not` and `and not` in `notWithAndNot`.

```dataweave
%dw 2.0
var orNot = if (1 + 1 == 4 or not 1 == 2) {"answer": "orNot - Condition met"}
             else {"answer": "nope"}
var andNot = if (1 + 1 == 2 and not 1 == 2) {"answer": "andNot - Condition met"}
             else {"answer": "nope"}
var notWithAndNot = if (not (1 + 1 == 2 and not 1 == 1)) {"answer": "notWithAndNot - Condition met"}
              else {"answer": "nope"}
output application/json
---
{ "answers" :
  [
    orNot,
    andNot,
    notWithAndNot
  ]
}
```

Output

```json
{
  "answers": [
    { "answer": "orNot - Condition met" },
    { "answer": "andNot - Condition met" },
    { "answer": "notWithAndNot - Condition met" }
  ]
}
```

DataWeave executes the code inside each `if` block because all conditional expressions in the
example evaluate to `true`.

## Prepend, Append, and Remove Operators for Arrays

DataWeave supports operators for appending and prepending items within an array:

<table><colgroup><col> <col></colgroup><thead><tr><th>Operator</th><th>Description</th></tr></thead><tbody><tr><td><p><code>&gt;&gt;</code></p></td><td><p>Prepends data on the left-hand side of the operator to items in the array on the right-hand side. For example, <code>1 &gt;&gt; [2]</code> results in <code>[ 1, 2 ]</code>, prepending <code>1</code> to <code>2</code> in the array.</p></td></tr><tr><td><p><code>&lt;&lt;</code></p></td><td><p>Appends data on the right-hand side of the operator to items in the array on the left-hand side. For example, <code>[1] &lt;&lt; 2</code> results in <code>[ 1, 2 ]</code>, appending <code>2</code> to <code>1</code> in the array.</p></td></tr><tr><td><p><code>+</code></p></td><td><p>Appends data on the right-hand side of the operator to items in the array on the left-hand side. For example, <code>[1] + 2</code> results in <code>[ 1, 2 ]</code>, appending <code>2</code> to <code>1</code> in the array. The array is always on the left-hand side of the operator.</p></td></tr><tr><td><p><code>-</code></p></td><td><p>Removes a specified element of any supported type from an array.</p></td></tr></tbody></table>

The following examples show uses of prepend, append, and remove operators on arrays:

```dataweave
%dw 2.0
output application/json
---
{
  "prepend-append" : [
  	 // Array on right side when prepending.
     { "prepend" : 1 >> [2] },
     { "prepend-number" : 1 >> [1] },
     { "prepend-string" : "a" >> [1] },
     { "prepend-object" : { "a" : "b"} >> [1] },
     { "prepend-array" : [1] >> [2, 3] },
     { "prepend-binary" : (1 as Binary) >> [1] },
     { "prepend-date-time" : |23:57:59Z| >> [ |2017-10-01| ] },
  	 // Array is on left side when appending.
     { "append-number" : [1] << 2 },
     { "append-string" : [1] << "a" },
     { "append-object" : [1] << { "a" : "b"} },
     { "append-array" : [1,2] << [1, 2, 3] },
     { "append-binary" : [1] << (1 as Binary) },
     { "append-date-time" : [ |2017-10-01| ] << |23:57:59Z| },
     { "append-object-to-array" : [1,2] << {"a" : "b"} },
     { "append-array-to-array1" : ["a","b"] << ["c","d"] },
     { "append-array-to-array2" : [["a","b"],["c","d"]] << ["e","f"] },
     // + always appends within the array
     { "append-with-+" : [1] + 2 },
     { "append-with-+" : [2] + 1 },
     { "removeNumberFromArray" : ( [1,2,3] - 2 ) },
     { "removeObjectFromArray" : ( [ {a : "b"}, {c : "d"} , { e : "f"} ] - { c : "d"} ) }
  ]
}
```

Output

```json
{
  "prepend-append": [
    { "prepend": [1, 2] },
    { "prepend-number": [1, 1] },
    { "prepend-string": ["a", 1] },
    { "prepend-array": [[1], 2, 3] },
    { "prepend-object": [{ "a": "b" }, 1] },
    { "prepend-binary": ["\u0001", 1] },
    { "prepend-date-time": ["23:57:59Z", "2017-10-01"] },
    { "append-number": [1, 2] },
    { "append-string": [1, "a"] },
    { "append-object": [1, { "a": "b" }] },
    { "append-array": [1, 2, [1, 2, 3]] },
    { "append-binary": [1, "\u0001"] },
    { "append-date-time": ["2017-10-01", "23:57:59Z"] },
    { "append-object-to-array": [1, 2, { "a": "b" }] },
    { "append-array-to-array1": ["a", "b", ["c", "d"]] },
    {
      "append-array-to-array2": [
        ["a", "b"],
        ["c", "d"],
        ["e", "f"]
      ]
    },
    { "append-with-+": [1, 2] },
    { "append-with-+": [2, 1] },
    { "removeNumberFromArray": [1, 3] },
    { "removeObjectFromArray": [{ "a": "b" }, { "e": "f" }] }
  ]
}
```

## Scope and Flow Control Operators

DataWeave supports operators that control the flow and scope of expressions:

- [`do` and `using`](#control_flow_do)

- [`if else` and `else if`](#control_flow_if)

<table id="control_flow_do"><caption>Table 1. Scope Operators:</caption> <colgroup><col> <col></colgroup><thead><tr><th>Operator</th><th>Description</th></tr></thead><tbody><tr><td><p><code>do</code></p></td><td><p>Creates a scope in which new variables, functions, annotations, or namespaces can be declared and used. The syntax is similar to a mapping in that it is composed of a header and body separated by <code>---</code>. Its header is where all the declarations are defined, and its body is the result of the expression. See <a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-flow-control#control_flow_do">do</a> and <a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-variables#example_local_variable">Examples: Local DataWeave Variables</a> for examples.</p></td></tr><tr><td><p><code>using</code></p></td><td><p>Replaced by <code>do</code>. Supported for backwards compatibility only.</p></td></tr></tbody></table>

<table id="control_flow_if"><caption>Table 2. Flow Control Operators:</caption> <colgroup><col> <col></colgroup><thead><tr><th>Operator</th><th>Description</th></tr></thead><tbody><tr><td><p><code>if else</code></p></td><td><div><div><p>An <code>if</code> operator evaluates a conditional expression and returns the value under the <code>if</code> only if the conditional expression is true. Otherwise, it returns the expression under <code>else</code>. Every <code>if</code> expression must have a matching <code>else</code> expression. See <a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-flow-control#control_flow_if_else">if else</a> for an example.</p></div></div></td></tr><tr><td><p><code>else if</code></p></td><td><p>An <code>else</code> operator chains expressions together within an if-else construct by incorporating <code>else if</code>. See <a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-flow-control#control_flow_else_if">else if</a> for an example.</p></td></tr></tbody></table>

## Update Operator

DataWeave supports the `update` operator, which enables you to update specified fields of a data
structure with new values.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

Versions prior to Mule 4.3 require the following syntax to increase the `age` value in `myInput` by
one without recreating the entire object:

```weave
%dw 2.0
var myInput = {
    "name": "Ken",
    "lastName":"Shokida",
    "age": 30
}
output application/json
---
myInput mapObject ((value,key) ->
    if(key as String == "age")
       {(key): value as Number + 1}
    else
       {(key): value} )
```

In Mule 4.3, the `update` operator simplifies the syntax:

```weave
%dw 2.0
var myInput = {
    "name": "Ken",
    "lastName":"Shokida",
    "age": 30
}
output application/json
---
myInput update {
    case age at .age -> age + 1
}
```

Both DataWeave scripts return the same result:

```JSON
{
  "name": "Ken",
  "lastName": "Shokida",
  "age": 31
}
```

With `update`, casting or iterating through all the key-value pairs is not necessary.

The `update` syntax is as follows:

```weave
<value_to_update> update {
    case <variable_name> at <update_expression>[!]? [if(<conditional_expression>)]? -> <new value>
    ...
}
```

- `value_to_update` represents the original value to update.

- `update_expression` is the selector expression that matches a value in `value_to_update`.

- `variable_name` is the name of the variable to bind to the matched `update_expression` value.

- `new_value` is the expression with the new value.

- `[if(<conditional_expression>)]?` If `conditional_expression` returns `true`, the script updates
  the value. Use of a conditional expression is optional.

- `[!]` marks the selector as an upsert. If the expression doesn’t find a match, the `!` makes the
  `update` operator create all the required elements and insert the new value.

- `update_expression` supports multiple `case` expressions.

> [!NOTE] The `update` operator doesn’t mutate the existing value. Instead, the operator creates a
> new value with the updated expressions.

### Selector Expressions

Use selector expressions with the `update` operator to specify the fields to update.

#### Value Selector

This matching selector can check for matches to any value within an object.

The following example updates a field at the root level and a field in a nested level using the
value selector:

Source

```weave
%dw 2.0
var myInput = {
    "name": "Ken",
    "lastName":"Shokida",
    "age": 30,
    "address": {
        "street": "Amenabar",
        "zipCode": "AB1234"
    }
}
output application/json
---
myInput update {
    case age at .age -> age + 1
    case s at .address.street -> "First Street"
}
```

Output

```json
{
  "name": "Ken",
  "lastName": "Shokida",
  "age": 31,
  "address": {
    "street": "First Street",
    "zipCode": "AB1234"
  }
}
```

#### Index Selector

This matching selector enables you to match any array by its index.

The following example updates an element that is at the first location of the array:

Input

```json
{
  "name": "Ken",
  "lastName": "Shokida",
  "age": 30,
  "addresses": [
    {
      "street": "Amenabar",
      "zipCode": "AB1234"
    }
  ]
}
```

Source

```weave
%dw 2.0
output application/json
---
payload update {
    case s at .addresses[0] -> {
        "street": "Second Street",
        "zipCode": "ZZ123"
    }
}
```

Output

```json
{
  "name": "Ken",
  "lastName": "Shokida",
  "age": 30,
  "addresses": [
    {
      "street": "Second Street",
      "zipCode": "ZZ123"
    }
  ]
}
```

#### Attribute Selector

This matching selector enables you to match any attribute value.

The following example updates an attribute value and changes it to upper case:

Input

```xml
<user name="leandro"/>
```

Source

```weave
%dw 2.0
output application/xml
---
payload update {
    case name at .user.@name -> upper(name)
}
```

Output

```xml
<?xml version='1.0' encoding='UTF-8'?>
<user name="LEANDRO"/>
```

#### Dynamic Selector

Any selector can incorporate an expression to make the selection dynamic.

The following example dynamically selects and updates the value of a field that is not hardcoded.
Such a field can change at runtime. The example uses the variable `theFieldName` to obtain the field
with key `name`, and it changes the value of that field to `Shoki`.

Input

```json
{
  "name": "Ken",
  "lastName": "Shokida"
}
```

Source

```weave
%dw 2.0
var theFieldName = "name"
output application/json
---
payload update {
    case s at ."$(theFieldName)" -> "Shoki"
}
```

Output

```json
{
  "name": "Shoki",
  "lastName": "Shokida"
}
```

### Conditional Update

The `update` operator has syntax for writing a conditional update if you want to modify a field
under a given condition.

The following example updates the category based on the name of the user:

Input

```json
[
  { "name": "Ken", "age": 30 },
  { "name": "Tomo", "age": 70 },
  { "name": "Kajika", "age": 10 }
]
```

Source

```weave
%dw 2.0
output application/json
---
payload map ((user) ->
    user update {
        case name at .name if(name == "Ken") -> name ++ " (Leandro)"
        case name at .name if(name == "Tomo") -> name ++ " (Christian)"
    }
)
```

Output

```json
[
  {
    "name": "Ken (Leandro)",
    "age": 30
  },
  {
    "name": "Tomo (Christian)",
    "age": 70
  },
  {
    "name": "Kajika",
    "age": 10
  }
]
```

### Upserting

The `update` operator enables you to insert a field that is not present already by using the `!`
symbol at the end of the selector expression. When the field is not present, the operator binds a
`null` value to the variable.

The following example updates each object in the array `myInput`. If the field `name` is present in
the object, the example applies the `upper` function to the value of `name`. If the field `name` is
not present in the object, the example appends the key-value pair `"name": "JOHN"` to the object.

Source

```weave
%dw 2.0
var myInput = [{"lastName": "Doe"}, {"lastName": "Parker", "name": "Peter" }]
output application/json
---
myInput  map ((value) ->
    value update {
        case name at .name! -> if(name == null) "JOHN" else upper(name)
    }
)
```

Output

```json
[
  {
    "lastName": "Doe",
    "name": "JOHN"
  },
  {
    "lastName": "Parker",
    "name": "PETER"
  }
]
```

### Sugar Syntax

The `update` operator accepts a default variable named `$` in place of the longer
`<variable_name> at` syntax.

The following example binds the value of the expression `.age` to the default variable name `$`,
which is used to express the new value. The longer equivalent is shown in comments.

Input

```json
{
  "name": "Ken",
  "lastName": "Shokida",
  "age": 30,
  "address": {
    "street": "Amenabar",
    "zipCode": "AB1234"
  }
}
```

Source

```weave
%dw 2.0
output application/json
---
payload update {
    //equivalent expression:
    //case age at .age -> age + 1
    case .age -> $ + 1
    case .address.street -> "First Street"
}
```

Output

```json
{
  "name": "Ken",
  "lastName": "Shokida",
  "age": 31,
  "address": {
    "street": "First Street",
    "zipCode": "AB1234"
  }
}
```

## Metadata Assignment Operator

DataWeave supports the metadata assignment operator `<~`, which enables you to set the metadata of
any value without using the `as` operator. This operator is useful when you want to set the metadata
and retain the current value type. If you are coercing the value to a new type, use
[as](https://docs.mulesoft.com/dataweave/2.6/dataweave-types-coercion).

_Introduced in DataWeave 2.5.0. Supported by Mule 4.5 and later._

The operator syntax is as follows:

```none
<valueB> <~ <objectA>
```

The operator assigns `objectA` as metadata to `valueB`. The arrow points to the value to which the
metadata is assigned.

Versions prior to Mule 4.5 require the following syntax, for example, to add the `class` metadata
field to an object:

```weave
%dw 2.0
---
{name: "Ken"} as Object {class: "Person"}
```

In Mule 4.5, the metadata assignment operator `<~` simplifies the syntax:

```weave
%dw 2.0
---
{name: "Ken"} <~ {class: "Person"}
```

### Metadata

Metadata is any additional information attached to a value that doesn’t affect its identity. Given
any two values `A` and `B` that are equal, if you attach metadata to `A` and call it `A'`, then
`A == A' == B`. So you can define a value that is formed by the value and the metadata attached to
it.

<!-- document id=017e4b9646ac72a83ef6e8f89593aca2d079efa9fe47b45967199f7de22de0cf url=/mulesoft/current/en-us/dataweave/2.9/dw-operators.md -->

---
product: DataWeave
version: 2.9
---

# DataWeave Operators

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave supports several operators, including mathematical operators, equality operators, and
operators such as prepend, append and update.

## Mathematical Operators

DataWeave supports the most common mathematical operators:

<table><colgroup><col> <col></colgroup><thead><tr><th>Operator</th><th>Description</th></tr></thead><tbody><tr><td><p><code>+</code></p></td><td><p>For addition.</p></td></tr><tr><td><p><code>-</code></p></td><td><p>For subtraction.</p></td></tr><tr><td><p><code>*</code></p></td><td><p>For multiplication.</p></td></tr><tr><td><p><code>/</code></p></td><td><p>For division.</p></td></tr></tbody></table>

In addition to operating with numbers, the `(-)` and `(+)` operators can also operate with complex
data structures like arrays, objects, and dates.

The following example uses mathematical operators with different data types:

Source

```dataweave
%dw 2.0
output application/json
---
{ "mathOperators" : [
    { "2 + 2" : (2 + 2) },
    { "2 - 2" : (2 - 2) },
    { "2 * 2" : (2 * 2) },
    { "2 / 2" : (2 / 2) },
    { "[1,2,3] - 1 + 4" : [1,2,3] - 1 + 4},
    { "{a:1, b:2, c:3} - 'a' " : {a:1, b:2, c:3} - "a"},
    { "|2021-03-02T10:39:59| - |P1D| + |PT3H|" : |2021-03-02T10:39:59| - |P1D| + |PT3H|}
  ]
}
```

Output

```json
{
  "mathOperators": [
    { "2 + 2": 4 },
    { "2 - 2": 0 },
    { "2 * 2": 4 },
    { "2 / 2": 1 },
    { "[1,2,3] - 1 + 4": [2, 3, 4] },
    { "{a:1, b:2, c:3} - 'a' ": { "b": 2, "c": 3 } },
    { "|2021-03-02T10:39:59| - |P1D| + |PT3H|": "2021-03-01T13:39:59" }
  ]
}
```

Several DataWeave functions operate on numbers, for example: [sum](https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-sum),
[mod](https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-mod) (for modulo), and [avg](https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-abs) (for average).

## Equality and Relational Operators

DataWeave supports the following equality and relational operators:

<table><colgroup><col> <col></colgroup><thead><tr><th>Operator</th><th>Description</th></tr></thead><tbody><tr><td><p><code>&lt;</code></p></td><td><p>For less than.</p></td></tr><tr><td><p><code>&gt;</code></p></td><td><p>For greater than.</p></td></tr><tr><td><p><code>&lt;=</code></p></td><td><p>For less than or equal to.</p></td></tr><tr><td><p><code>&gt;=</code></p></td><td><p>For greater than or equal to.</p></td></tr><tr><td><p><code>==</code></p></td><td><p>For equal to.</p></td></tr><tr><td><p><code>~=</code></p></td><td><p>Equality operator that tries to coerce one value to the type of the other when the types are different.</p></td></tr></tbody></table>

Note that you can negate these operators by using the [logical operator](#logical_operators), `not`.

The following example uses relational operators:

Source

```dataweave
%dw 2.0
output application/json
---
{ "relational" : [
    { "1 < 1" : (1 < 1) },
    { "1 > 2" : (1 > 2) },
    { "1 <= 1" : (1 <= 1) },
    { "1 >= 1" : (1 >= 1) }
  ]
}
```

Output

```json
{
  "relational": [
    { "(1 < 1)": false },
    { "(1 > 2)": false },
    { "(1 <= 1)": true },
    { "(1 >= 1)": true }
  ]
}
```

Note that if the operands of the relational operator belong to different types, DataWeave coerces
the right-side operand to the type of the left-side operand. For example, in the expression
`"123" > 12` DataWeave coerces `12` (a Number type) to `"12"` (a String type) and compares each
String value lexicographically. In the expression `123 > "12"`, DataWeave coerces the String value
`"12"` to the Number value `12` and compares the numbers.

These examples use equality operators:

Source

```dataweave
%dw 2.0
output application/dw
---
{ "equality" :
  [
    (1 == 1),
    (1 == 2),
    ("true" == true),
    ("true" ~= true),
    (['true'] ~= [true]),
    ('1' ~= 1)
  ]
}
```

Output

```text
{
  equality: [ true, false, false, true, true, true ]
}
```

## Logical Operators

DataWeave supports the following logical operators:

<table><colgroup><col> <col></colgroup><thead><tr><th>Operator</th><th>Description</th></tr></thead><tbody><tr><td><p><code>not</code></p></td><td><p>Negates the result of the input. See also, <code>!</code>.</p></td></tr><tr><td><p><code>!</code></p></td><td><p>Negates the result of the input. See also, <code>not</code>. <em>Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later.</em></p></td></tr><tr><td><p><code>and</code></p></td><td><p>Returns <code>true</code> if the result of all inputs is true, <code>false</code> if not.</p></td></tr><tr><td><p><code>or</code></p></td><td><p>Returns <code>true</code> if the result of any input is true, <code>false</code> if not.</p></td></tr></tbody></table>

> [!NOTE] Though the semantics of `not` and `!` are the same, their precedence differs.
> `not true or true` is executed as `not (true or true)`, so it returns `false`, whereas
> `!true or true` returns `true` because the `!` only applies to the first `true`. `!(true or true)`
> returns `false`.

The following examples use logical operators:

Source

```dataweave
%dw 2.0
var myArray = [1,2,3,4,5]
var myMap = myArray map not (($ mod 2) == 0)
output application/json
---
{
  "not" : [
    "notTrue" : not true,
    "notFalse" : not false,
    "myMapWithNot" : myMap
  ],
  "and" : [
    "andTrueFalse" : true and false,
    "andIsTrue" : (1 + 1 == 2) and (2 + 2 == 4),
    "andIsFalse" : (1 + 1 == 2) and (2 + 2 == 2)
  ],
  "or" : [
    "orTrueFalse" : true or false,
    "orIsTrue" : (1 + 1 == 2) or (2 + 2 == 2),
    "orIsFalse" : (1 + 1 == 1) or (2 + 2 == 2)
  ],
  "!-vs-not" : [
	  "example-!" : (! true or true),
	  "example-not" : (not true or true)
  ]
}
```

Note that `myMap` iterates through the items in a list (`myArray`) and determines whether the modulo
(`mod`) expression _does not_ evaluate to `0` when applied to each given item.

Output

```json
{
  "not": [
    { "notTrue": false },
    { "notFalse": true },
    { "myMapWithNot": [true, false, true, false, true] }
  ],
  "and": [{ "andTrueFalse": false }, { "andIsTrue": true }, { "andIsFalse": false }],
  "or": [{ "orTrueFalse": true }, { "orIsTrue": true }, { "orIsFalse": false }],
  "!-vs-not": [{ "example-!": true }, { "example-not": false }]
}
```

Note that `not` works in expressions such as `not (true)`, but `not(true)` (without the space) does
not work.

You can use logical operators together. The following example uses:

- `or not` as defined in the `orNot` expression.

- `and not` in `andNot`.

- `not` and `and not` in `notWithAndNot`.

```dataweave
%dw 2.0
var orNot = if (1 + 1 == 4 or not 1 == 2) {"answer": "orNot - Condition met"}
             else {"answer": "nope"}
var andNot = if (1 + 1 == 2 and not 1 == 2) {"answer": "andNot - Condition met"}
             else {"answer": "nope"}
var notWithAndNot = if (not (1 + 1 == 2 and not 1 == 1)) {"answer": "notWithAndNot - Condition met"}
              else {"answer": "nope"}
output application/json
---
{ "answers" :
  [
    orNot,
    andNot,
    notWithAndNot
  ]
}
```

Output

```json
{
  "answers": [
    { "answer": "orNot - Condition met" },
    { "answer": "andNot - Condition met" },
    { "answer": "notWithAndNot - Condition met" }
  ]
}
```

DataWeave executes the code inside each `if` block because all conditional expressions in the
example evaluate to `true`.

## Prepend, Append, and Remove Operators for Arrays

DataWeave supports operators for appending and prepending items within an array:

<table><colgroup><col> <col></colgroup><thead><tr><th>Operator</th><th>Description</th></tr></thead><tbody><tr><td><p><code>&gt;&gt;</code></p></td><td><p>Prepends data on the left-hand side of the operator to items in the array on the right-hand side. For example, <code>1 &gt;&gt; [2]</code> results in <code>[ 1, 2 ]</code>, prepending <code>1</code> to <code>2</code> in the array.</p></td></tr><tr><td><p><code>&lt;&lt;</code></p></td><td><p>Appends data on the right-hand side of the operator to items in the array on the left-hand side. For example, <code>[1] &lt;&lt; 2</code> results in <code>[ 1, 2 ]</code>, appending <code>2</code> to <code>1</code> in the array.</p></td></tr><tr><td><p><code>+</code></p></td><td><p>Appends data on the right-hand side of the operator to items in the array on the left-hand side. For example, <code>[1] + 2</code> results in <code>[ 1, 2 ]</code>, appending <code>2</code> to <code>1</code> in the array. The array is always on the left-hand side of the operator.</p></td></tr><tr><td><p><code>-</code></p></td><td><p>Removes a specified element of any supported type from an array.</p></td></tr></tbody></table>

The following examples show uses of prepend, append, and remove operators on arrays:

```dataweave
%dw 2.0
output application/json
---
{
  "prepend-append" : [
  	 // Array on right side when prepending.
     { "prepend" : 1 >> [2] },
     { "prepend-number" : 1 >> [1] },
     { "prepend-string" : "a" >> [1] },
     { "prepend-object" : { "a" : "b"} >> [1] },
     { "prepend-array" : [1] >> [2, 3] },
     { "prepend-binary" : (1 as Binary) >> [1] },
     { "prepend-date-time" : |23:57:59Z| >> [ |2017-10-01| ] },
  	 // Array is on left side when appending.
     { "append-number" : [1] << 2 },
     { "append-string" : [1] << "a" },
     { "append-object" : [1] << { "a" : "b"} },
     { "append-array" : [1,2] << [1, 2, 3] },
     { "append-binary" : [1] << (1 as Binary) },
     { "append-date-time" : [ |2017-10-01| ] << |23:57:59Z| },
     { "append-object-to-array" : [1,2] << {"a" : "b"} },
     { "append-array-to-array1" : ["a","b"] << ["c","d"] },
     { "append-array-to-array2" : [["a","b"],["c","d"]] << ["e","f"] },
     // + always appends within the array
     { "append-with-+" : [1] + 2 },
     { "append-with-+" : [2] + 1 },
     { "removeNumberFromArray" : ( [1,2,3] - 2 ) },
     { "removeObjectFromArray" : ( [ {a : "b"}, {c : "d"} , { e : "f"} ] - { c : "d"} ) }
  ]
}
```

Output

```json
{
  "prepend-append": [
    { "prepend": [1, 2] },
    { "prepend-number": [1, 1] },
    { "prepend-string": ["a", 1] },
    { "prepend-array": [[1], 2, 3] },
    { "prepend-object": [{ "a": "b" }, 1] },
    { "prepend-binary": ["\u0001", 1] },
    { "prepend-date-time": ["23:57:59Z", "2017-10-01"] },
    { "append-number": [1, 2] },
    { "append-string": [1, "a"] },
    { "append-object": [1, { "a": "b" }] },
    { "append-array": [1, 2, [1, 2, 3]] },
    { "append-binary": [1, "\u0001"] },
    { "append-date-time": ["2017-10-01", "23:57:59Z"] },
    { "append-object-to-array": [1, 2, { "a": "b" }] },
    { "append-array-to-array1": ["a", "b", ["c", "d"]] },
    {
      "append-array-to-array2": [
        ["a", "b"],
        ["c", "d"],
        ["e", "f"]
      ]
    },
    { "append-with-+": [1, 2] },
    { "append-with-+": [2, 1] },
    { "removeNumberFromArray": [1, 3] },
    { "removeObjectFromArray": [{ "a": "b" }, { "e": "f" }] }
  ]
}
```

## Scope and Flow Control Operators

DataWeave supports operators that control the flow and scope of expressions:

- [`do` and `using`](#control_flow_do)

- [`if else` and `else if`](#control_flow_if)

<table id="control_flow_do"><caption>Table 1. Scope Operators:</caption> <colgroup><col> <col></colgroup><thead><tr><th>Operator</th><th>Description</th></tr></thead><tbody><tr><td><p><code>do</code></p></td><td><p>Creates a scope in which new variables, functions, annotations, or namespaces can be declared and used. The syntax is similar to a mapping in that it is composed of a header and body separated by <code>---</code>. Its header is where all the declarations are defined, and its body is the result of the expression. See <a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-flow-control#control_flow_do">do</a> and <a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-variables#example_local_variable">Examples: Local DataWeave Variables</a> for examples.</p></td></tr><tr><td><p><code>using</code></p></td><td><p>Replaced by <code>do</code>. Supported for backwards compatibility only.</p></td></tr></tbody></table>

<table id="control_flow_if"><caption>Table 2. Flow Control Operators:</caption> <colgroup><col> <col></colgroup><thead><tr><th>Operator</th><th>Description</th></tr></thead><tbody><tr><td><p><code>if else</code></p></td><td><div><div><p>An <code>if</code> operator evaluates a conditional expression and returns the value under the <code>if</code> only if the conditional expression is true. Otherwise, it returns the expression under <code>else</code>. Every <code>if</code> expression must have a matching <code>else</code> expression. See <a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-flow-control#control_flow_if_else">if else</a> for an example.</p></div></div></td></tr><tr><td><p><code>else if</code></p></td><td><p>An <code>else</code> operator chains expressions together within an if-else construct by incorporating <code>else if</code>. See <a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-flow-control#control_flow_else_if">else if</a> for an example.</p></td></tr></tbody></table>

## Update Operator

DataWeave supports the `update` operator, which enables you to update specified fields of a data
structure with new values.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

Versions prior to Mule 4.3 require the following syntax to increase the `age` value in `myInput` by
one without recreating the entire object:

```weave
%dw 2.0
var myInput = {
    "name": "Ken",
    "lastName":"Shokida",
    "age": 30
}
output application/json
---
myInput mapObject ((value,key) ->
    if(key as String == "age")
       {(key): value as Number + 1}
    else
       {(key): value} )
```

In Mule 4.3, the `update` operator simplifies the syntax:

```weave
%dw 2.0
var myInput = {
    "name": "Ken",
    "lastName":"Shokida",
    "age": 30
}
output application/json
---
myInput update {
    case age at .age -> age + 1
}
```

Both DataWeave scripts return the same result:

```JSON
{
  "name": "Ken",
  "lastName": "Shokida",
  "age": 31
}
```

With `update`, casting or iterating through all the key-value pairs is not necessary.

The `update` syntax is as follows:

```weave
<value_to_update> update {
    case <variable_name> at <update_expression>[!]? [if(<conditional_expression>)]? -> <new value>
    ...
}
```

- `value_to_update` represents the original value to update.

- `update_expression` is the selector expression that matches a value in `value_to_update`.

- `variable_name` is the name of the variable to bind to the matched `update_expression` value.

- `new_value` is the expression with the new value.

- `[if(<conditional_expression>)]?` If `conditional_expression` returns `true`, the script updates
  the value. Use of a conditional expression is optional.

- `[!]` marks the selector as an upsert. If the expression doesn’t find a match, the `!` makes the
  `update` operator create all the required elements and insert the new value.

- `update_expression` supports multiple `case` expressions.

> [!NOTE] The `update` operator doesn’t mutate the existing value. Instead, the operator creates a
> new value with the updated expressions.

### Selector Expressions

Use selector expressions with the `update` operator to specify the fields to update.

#### Value Selector

This matching selector can check for matches to any value within an object.

The following example updates a field at the root level and a field in a nested level using the
value selector:

Source

```weave
%dw 2.0
var myInput = {
    "name": "Ken",
    "lastName":"Shokida",
    "age": 30,
    "address": {
        "street": "Amenabar",
        "zipCode": "AB1234"
    }
}
output application/json
---
myInput update {
    case age at .age -> age + 1
    case s at .address.street -> "First Street"
}
```

Output

```json
{
  "name": "Ken",
  "lastName": "Shokida",
  "age": 31,
  "address": {
    "street": "First Street",
    "zipCode": "AB1234"
  }
}
```

#### Index Selector

This matching selector enables you to match any array by its index.

The following example updates an element that is at the first location of the array:

Input

```json
{
  "name": "Ken",
  "lastName": "Shokida",
  "age": 30,
  "addresses": [
    {
      "street": "Amenabar",
      "zipCode": "AB1234"
    }
  ]
}
```

Source

```weave
%dw 2.0
output application/json
---
payload update {
    case s at .addresses[0] -> {
        "street": "Second Street",
        "zipCode": "ZZ123"
    }
}
```

Output

```json
{
  "name": "Ken",
  "lastName": "Shokida",
  "age": 30,
  "addresses": [
    {
      "street": "Second Street",
      "zipCode": "ZZ123"
    }
  ]
}
```

#### Attribute Selector

This matching selector enables you to match any attribute value.

The following example updates an attribute value and changes it to upper case:

Input

```xml
<user name="leandro"/>
```

Source

```weave
%dw 2.0
output application/xml
---
payload update {
    case name at .user.@name -> upper(name)
}
```

Output

```xml
<?xml version='1.0' encoding='UTF-8'?>
<user name="LEANDRO"/>
```

#### Dynamic Selector

Any selector can incorporate an expression to make the selection dynamic.

The following example dynamically selects and updates the value of a field that is not hardcoded.
Such a field can change at runtime. The example uses the variable `theFieldName` to obtain the field
with key `name`, and it changes the value of that field to `Shoki`.

Input

```json
{
  "name": "Ken",
  "lastName": "Shokida"
}
```

Source

```weave
%dw 2.0
var theFieldName = "name"
output application/json
---
payload update {
    case s at ."$(theFieldName)" -> "Shoki"
}
```

Output

```json
{
  "name": "Shoki",
  "lastName": "Shokida"
}
```

### Conditional Update

The `update` operator has syntax for writing a conditional update if you want to modify a field
under a given condition.

The following example updates the category based on the name of the user:

Input

```json
[
  { "name": "Ken", "age": 30 },
  { "name": "Tomo", "age": 70 },
  { "name": "Kajika", "age": 10 }
]
```

Source

```weave
%dw 2.0
output application/json
---
payload map ((user) ->
    user update {
        case name at .name if(name == "Ken") -> name ++ " (Leandro)"
        case name at .name if(name == "Tomo") -> name ++ " (Christian)"
    }
)
```

Output

```json
[
  {
    "name": "Ken (Leandro)",
    "age": 30
  },
  {
    "name": "Tomo (Christian)",
    "age": 70
  },
  {
    "name": "Kajika",
    "age": 10
  }
]
```

### Upserting

The `update` operator enables you to insert a field that is not present already by using the `!`
symbol at the end of the selector expression. When the field is not present, the operator binds a
`null` value to the variable.

The following example updates each object in the array `myInput`. If the field `name` is present in
the object, the example applies the `upper` function to the value of `name`. If the field `name` is
not present in the object, the example appends the key-value pair `"name": "JOHN"` to the object.

Source

```weave
%dw 2.0
var myInput = [{"lastName": "Doe"}, {"lastName": "Parker", "name": "Peter" }]
output application/json
---
myInput  map ((value) ->
    value update {
        case name at .name! -> if(name == null) "JOHN" else upper(name)
    }
)
```

Output

```json
[
  {
    "lastName": "Doe",
    "name": "JOHN"
  },
  {
    "lastName": "Parker",
    "name": "PETER"
  }
]
```

### Sugar Syntax

The `update` operator accepts a default variable named `$` in place of the longer
`<variable_name> at` syntax.

The following example binds the value of the expression `.age` to the default variable name `$`,
which is used to express the new value. The longer equivalent is shown in comments.

Input

```json
{
  "name": "Ken",
  "lastName": "Shokida",
  "age": 30,
  "address": {
    "street": "Amenabar",
    "zipCode": "AB1234"
  }
}
```

Source

```weave
%dw 2.0
output application/json
---
payload update {
    //equivalent expression:
    //case age at .age -> age + 1
    case .age -> $ + 1
    case .address.street -> "First Street"
}
```

Output

```json
{
  "name": "Ken",
  "lastName": "Shokida",
  "age": 31,
  "address": {
    "street": "First Street",
    "zipCode": "AB1234"
  }
}
```

## Metadata Assignment Operator

DataWeave supports the metadata assignment operator `<~`, which enables you to set the metadata of
any value without using the `as` operator. This operator is useful when you want to set the metadata
and retain the current value type. If you are coercing the value to a new type, use
[as](https://docs.mulesoft.com/dataweave/2.9/dataweave-types-coercion).

_Introduced in DataWeave 2.5.0. Supported by Mule 4.5 and later._

The operator syntax is as follows:

```none
<valueB> <~ <objectA>
```

The operator assigns `objectA` as metadata to `valueB`. The arrow points to the value to which the
metadata is assigned.

Versions prior to Mule 4.5 require the following syntax, for example, to add the `class` metadata
field to an object:

```weave
%dw 2.0
---
{name: "Ken"} as Object {class: "Person"}
```

In Mule 4.5, the metadata assignment operator `<~` simplifies the syntax:

```weave
%dw 2.0
---
{name: "Ken"} <~ {class: "Person"}
```

### Metadata Assignment Using Metadata Annotations

DataWeave adds support for metadata annotations. These special annotations, marked with `@Metadata`,
attach a key-value pair metadata to any value where they are used.

_Introduced in DataWeave 2.8.0._

The following example achieves the same result as the previous one, but by defining an annotation,
which is a class that binds the metadata key `class` to the value provided where it is used.

```weave
%dw 2.8

@Metadata(key="class")
annotation Class(value: String)
---
@Class(value="Person")
{name: "Ken"}
```

Defining metadata using annotations provides the following benefits:

- You can define annotations once and reuse them as metadata throughout your code.

- Annotations are additive, and using more than one annotation attaches all the key-value pairs
  together.

- You get type checking, enabling you to force the value of the annotation to be of a certain type,
  ensuring consistency.

However, there are certain restrictions when defining metadata annotations:

- Annotations marked with `@Metadata` can only have one parameter.

- The parameter must be called `value`.

- The metadata key is the value set to the key argument of the metadata annotation, not the name of
  the annotation itself (In the previous example, the metadata value is associated to the `class`
  key).

- Metadata annotations are additive, so if they are used on a reference that already has metadata,
  the new metadata is appended.

The following is an example of a metadata annotation that marks a value as CData for the XML
writter.

Source

```weave
%dw 2.8
output application/xml

@Metadata(key="cdata")
annotation CData(value: true)
---
root: {
 test: @CData(value = true) "testCData"
}
```

Output

```xml
<?xml version='1.0' encoding='UTF-8'?>
<root>
  <test><![CDATA[testCData]]></test>
</root>
```

### Metadata

Metadata is any additional information attached to a value that doesn’t affect its identity. Given
any two values `A` and `B` that are equal, if you attach metadata to `A` and call it `A'`, then
`A == A' == B`. So you can define a value that is formed by the value and the metadata attached to
it.

<!-- document id=5b6a371e6c611db1c56ca1a3e6925de98ddbd67aba641e65cc92c934d9edcc42 url=/mulesoft/current/en-us/dataweave/latest/dw-operators.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# DataWeave Operators

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave supports several operators, including mathematical operators, equality operators, and
operators such as prepend, append, and update.

## Mathematical Operators

DataWeave supports the most common mathematical operators:

<table><colgroup><col> <col></colgroup><thead><tr><th>Operator</th><th>Description</th></tr></thead><tbody><tr><td><p><code>+</code></p></td><td><p>For addition.</p></td></tr><tr><td><p><code>-</code></p></td><td><p>For subtraction.</p></td></tr><tr><td><p><code>*</code></p></td><td><p>For multiplication.</p></td></tr><tr><td><p><code>/</code></p></td><td><p>For division.</p></td></tr></tbody></table>

In addition to operating with numbers, the `(-)` and `(+)` operators can also operate with complex
data structures like arrays, objects, and dates.

The following example uses mathematical operators with different data types:

Source

```dataweave
%dw 2.0
output application/json
---
{ "mathOperators" : [
    { "2 + 2" : (2 + 2) },
    { "2 - 2" : (2 - 2) },
    { "2 * 2" : (2 * 2) },
    { "2 / 2" : (2 / 2) },
    { "[1,2,3] - 1 + 4" : [1,2,3] - 1 + 4},
    { "{a:1, b:2, c:3} - 'a' " : {a:1, b:2, c:3} - "a"},
    { "|2021-03-02T10:39:59| - |P1D| + |PT3H|" : |2021-03-02T10:39:59| - |P1D| + |PT3H|}
  ]
}
```

Output

```json
{
  "mathOperators": [
    { "2 + 2": 4 },
    { "2 - 2": 0 },
    { "2 * 2": 4 },
    { "2 / 2": 1 },
    { "[1,2,3] - 1 + 4": [2, 3, 4] },
    { "{a:1, b:2, c:3} - 'a' ": { "b": 2, "c": 3 } },
    { "|2021-03-02T10:39:59| - |P1D| + |PT3H|": "2021-03-01T13:39:59" }
  ]
}
```

Several DataWeave functions operate on numbers, for example: [sum](https://docs.mulesoft.com/dataweave/latest/dw-core-functions-sum),
[mod](https://docs.mulesoft.com/dataweave/latest/dw-core-functions-mod) (for modulo), and [avg](https://docs.mulesoft.com/dataweave/latest/dw-core-functions-abs) (for average).

## Equality and Relational Operators

DataWeave supports the following equality and relational operators:

<table><colgroup><col> <col></colgroup><thead><tr><th>Operator</th><th>Description</th></tr></thead><tbody><tr><td><p><code>&lt;</code></p></td><td><p>For less than.</p></td></tr><tr><td><p><code>&gt;</code></p></td><td><p>For greater than.</p></td></tr><tr><td><p><code>&lt;=</code></p></td><td><p>For less than or equal to.</p></td></tr><tr><td><p><code>&gt;=</code></p></td><td><p>For greater than or equal to.</p></td></tr><tr><td><p><code>==</code></p></td><td><p>For equal to.</p></td></tr><tr><td><p><code>~=</code></p></td><td><p>Equality operator that tries to coerce one value to the type of the other when the types are different.</p></td></tr></tbody></table>

Note that you can negate these operators by using the [logical operator](#logical_operators), `not`.

The following example uses relational operators:

Source

```dataweave
%dw 2.0
output application/json
---
{ "relational" : [
    { "1 < 1" : (1 < 1) },
    { "1 > 2" : (1 > 2) },
    { "1 <= 1" : (1 <= 1) },
    { "1 >= 1" : (1 >= 1) }
  ]
}
```

Output

```json
{
  "relational": [
    { "(1 < 1)": false },
    { "(1 > 2)": false },
    { "(1 <= 1)": true },
    { "(1 >= 1)": true }
  ]
}
```

Note that if the operands of the relational operator belong to different types, DataWeave coerces
the right-side operand to the type of the left-side operand. For example, in the expression
`"123" > 12` DataWeave coerces `12` (a Number type) to `"12"` (a String type) and compares each
String value lexicographically. In the expression `123 > "12"`, DataWeave coerces the String value
`"12"` to the Number value `12` and compares the numbers.

These examples use equality operators:

Source

```dataweave
%dw 2.0
output application/dw
---
{ "equality" :
  [
    (1 == 1),
    (1 == 2),
    ("true" == true),
    ("true" ~= true),
    (['true'] ~= [true]),
    ('1' ~= 1)
  ]
}
```

Output

```text
{
  equality: [ true, false, false, true, true, true ]
}
```

## Logical Operators

DataWeave supports the following logical operators:

<table><colgroup><col> <col></colgroup><thead><tr><th>Operator</th><th>Description</th></tr></thead><tbody><tr><td><p><code>not</code></p></td><td><p>Negates the result of the input. See also, <code>!</code>.</p></td></tr><tr><td><p><code>!</code></p></td><td><p>Negates the result of the input. See also, <code>not</code>. <em>Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later.</em></p></td></tr><tr><td><p><code>and</code></p></td><td><p>Returns <code>true</code> if the result of all inputs is true, <code>false</code> if not.</p></td></tr><tr><td><p><code>or</code></p></td><td><p>Returns <code>true</code> if the result of any input is true, <code>false</code> if not.</p></td></tr></tbody></table>

> [!NOTE] Though the semantics of `not` and `!` are the same, their precedence differs.
> `not true or true` is executed as `not (true or true)`, so it returns `false`, whereas
> `!true or true` returns `true` because the `!` only applies to the first `true`. `!(true or true)`
> returns `false`.

The following examples use logical operators:

Source

```dataweave
%dw 2.0
var myArray = [1,2,3,4,5]
var myMap = myArray map not (($ mod 2) == 0)
output application/json
---
{
  "not" : [
    "notTrue" : not true,
    "notFalse" : not false,
    "myMapWithNot" : myMap
  ],
  "and" : [
    "andTrueFalse" : true and false,
    "andIsTrue" : (1 + 1 == 2) and (2 + 2 == 4),
    "andIsFalse" : (1 + 1 == 2) and (2 + 2 == 2)
  ],
  "or" : [
    "orTrueFalse" : true or false,
    "orIsTrue" : (1 + 1 == 2) or (2 + 2 == 2),
    "orIsFalse" : (1 + 1 == 1) or (2 + 2 == 2)
  ],
  "!-vs-not" : [
	  "example-!" : (! true or true),
	  "example-not" : (not true or true)
  ]
}
```

Note that `myMap` iterates through the items in a list (`myArray`) and determines whether the modulo
(`mod`) expression _does not_ evaluate to `0` when applied to each given item.

Output

```json
{
  "not": [
    { "notTrue": false },
    { "notFalse": true },
    { "myMapWithNot": [true, false, true, false, true] }
  ],
  "and": [{ "andTrueFalse": false }, { "andIsTrue": true }, { "andIsFalse": false }],
  "or": [{ "orTrueFalse": true }, { "orIsTrue": true }, { "orIsFalse": false }],
  "!-vs-not": [{ "example-!": true }, { "example-not": false }]
}
```

Note that `not` works in expressions such as `not (true)`, but `not(true)` (without the space) does
not work.

You can use logical operators together. The following example uses:

- `or not` as defined in the `orNot` expression.

- `and not` in `andNot`.

- `not` and `and not` in `notWithAndNot`.

```dataweave
%dw 2.0
var orNot = if (1 + 1 == 4 or not 1 == 2) {"answer": "orNot - Condition met"}
             else {"answer": "nope"}
var andNot = if (1 + 1 == 2 and not 1 == 2) {"answer": "andNot - Condition met"}
             else {"answer": "nope"}
var notWithAndNot = if (not (1 + 1 == 2 and not 1 == 1)) {"answer": "notWithAndNot - Condition met"}
              else {"answer": "nope"}
output application/json
---
{ "answers" :
  [
    orNot,
    andNot,
    notWithAndNot
  ]
}
```

Output

```json
{
  "answers": [
    { "answer": "orNot - Condition met" },
    { "answer": "andNot - Condition met" },
    { "answer": "notWithAndNot - Condition met" }
  ]
}
```

DataWeave executes the code inside each `if` block because all conditional expressions in the
example evaluate to `true`.

## Prepend, Append, and Remove Operators for Arrays

DataWeave supports operators for appending and prepending items within an array:

<table><colgroup><col> <col></colgroup><thead><tr><th>Operator</th><th>Description</th></tr></thead><tbody><tr><td><p><code>&gt;&gt;</code></p></td><td><p>Prepends data on the left-hand side of the operator to items in the array on the right-hand side. For example, <code>1 &gt;&gt; [2]</code> results in <code>[ 1, 2 ]</code>, prepending <code>1</code> to <code>2</code> in the array.</p></td></tr><tr><td><p><code>&lt;&lt;</code></p></td><td><p>Appends data on the right-hand side of the operator to items in the array on the left-hand side. For example, <code>[1] &lt;&lt; 2</code> results in <code>[ 1, 2 ]</code>, appending <code>2</code> to <code>1</code> in the array.</p></td></tr><tr><td><p><code>+</code></p></td><td><p>Appends data on the right-hand side of the operator to items in the array on the left-hand side. For example, <code>[1] + 2</code> results in <code>[ 1, 2 ]</code>, appending <code>2</code> to <code>1</code> in the array. The array is always on the left-hand side of the operator.</p></td></tr><tr><td><p><code>-</code></p></td><td><p>Removes a specified element of any supported type from an array.</p></td></tr></tbody></table>

The following examples show uses of prepend, append, and remove operators on arrays:

```dataweave
%dw 2.0
output application/json
---
{
  "prepend-append" : [
  	 // Array on right side when prepending.
     { "prepend" : 1 >> [2] },
     { "prepend-number" : 1 >> [1] },
     { "prepend-string" : "a" >> [1] },
     { "prepend-object" : { "a" : "b"} >> [1] },
     { "prepend-array" : [1] >> [2, 3] },
     { "prepend-binary" : (1 as Binary) >> [1] },
     { "prepend-date-time" : |23:57:59Z| >> [ |2017-10-01| ] },
  	 // Array is on left side when appending.
     { "append-number" : [1] << 2 },
     { "append-string" : [1] << "a" },
     { "append-object" : [1] << { "a" : "b"} },
     { "append-array" : [1,2] << [1, 2, 3] },
     { "append-binary" : [1] << (1 as Binary) },
     { "append-date-time" : [ |2017-10-01| ] << |23:57:59Z| },
     { "append-object-to-array" : [1,2] << {"a" : "b"} },
     { "append-array-to-array1" : ["a","b"] << ["c","d"] },
     { "append-array-to-array2" : [["a","b"],["c","d"]] << ["e","f"] },
     // + always appends within the array
     { "append-with-+" : [1] + 2 },
     { "append-with-+" : [2] + 1 },
     { "removeNumberFromArray" : ( [1,2,3] - 2 ) },
     { "removeObjectFromArray" : ( [ {a : "b"}, {c : "d"} , { e : "f"} ] - { c : "d"} ) }
  ]
}
```

Output

```json
{
  "prepend-append": [
    { "prepend": [1, 2] },
    { "prepend-number": [1, 1] },
    { "prepend-string": ["a", 1] },
    { "prepend-array": [[1], 2, 3] },
    { "prepend-object": [{ "a": "b" }, 1] },
    { "prepend-binary": ["\u0001", 1] },
    { "prepend-date-time": ["23:57:59Z", "2017-10-01"] },
    { "append-number": [1, 2] },
    { "append-string": [1, "a"] },
    { "append-object": [1, { "a": "b" }] },
    { "append-array": [1, 2, [1, 2, 3]] },
    { "append-binary": [1, "\u0001"] },
    { "append-date-time": ["2017-10-01", "23:57:59Z"] },
    { "append-object-to-array": [1, 2, { "a": "b" }] },
    { "append-array-to-array1": ["a", "b", ["c", "d"]] },
    {
      "append-array-to-array2": [
        ["a", "b"],
        ["c", "d"],
        ["e", "f"]
      ]
    },
    { "append-with-+": [1, 2] },
    { "append-with-+": [2, 1] },
    { "removeNumberFromArray": [1, 3] },
    { "removeObjectFromArray": [{ "a": "b" }, { "e": "f" }] }
  ]
}
```

## Scope and Flow Control Operators

DataWeave supports operators that control the flow and scope of expressions:

- [`do` and `using`](#control_flow_do)

- [`if else` and `else if`](#control_flow_if)

<table id="control_flow_do"><caption>Table 1. Scope Operators:</caption> <colgroup><col> <col></colgroup><thead><tr><th>Operator</th><th>Description</th></tr></thead><tbody><tr><td><p><code>do</code></p></td><td><p>Creates a scope in which new variables, functions, annotations, or namespaces can be declared and used. The syntax is similar to a mapping in that it is composed of a header and body separated by <code>---</code>. Its header is where all the declarations are defined, and its body is the result of the expression. See <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-flow-control#control_flow_do">do</a> and <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-variables#example_local_variable">Examples: Local DataWeave Variables</a> for examples.</p></td></tr><tr><td><p><code>using</code></p></td><td><p>Replaced by <code>do</code>. Supported for backwards compatibility only.</p></td></tr></tbody></table>

<table id="control_flow_if"><caption>Table 2. Flow Control Operators:</caption> <colgroup><col> <col></colgroup><thead><tr><th>Operator</th><th>Description</th></tr></thead><tbody><tr><td><p><code>if else</code></p></td><td><div><div><p>An <code>if</code> operator evaluates a conditional expression and returns the value under the <code>if</code> only if the conditional expression is true. Otherwise, it returns the expression under <code>else</code>. Every <code>if</code> expression must have a matching <code>else</code> expression. See <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-flow-control#control_flow_if_else">if else</a> for an example.</p></div></div></td></tr><tr><td><p><code>else if</code></p></td><td><p>An <code>else</code> operator chains expressions together within an if-else construct by incorporating <code>else if</code>. See <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-flow-control#control_flow_else_if">else if</a> for an example.</p></td></tr></tbody></table>

## Update Operator

DataWeave supports the `update` operator, which enables you to update specified fields of a data
structure with new values.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

Versions prior to Mule 4.3 require the following syntax to increase the `age` value in `myInput` by
one without recreating the entire object:

```weave
%dw 2.0
var myInput = {
    "name": "Ken",
    "lastName":"Shokida",
    "age": 30
}
output application/json
---
myInput mapObject ((value,key) ->
    if(key as String == "age")
       {(key): value as Number + 1}
    else
       {(key): value} )
```

In Mule 4.3, the `update` operator simplifies the syntax:

```weave
%dw 2.0
var myInput = {
    "name": "Ken",
    "lastName":"Shokida",
    "age": 30
}
output application/json
---
myInput update {
    case age at .age -> age + 1
}
```

Both DataWeave scripts return the same result:

```JSON
{
  "name": "Ken",
  "lastName": "Shokida",
  "age": 31
}
```

With `update`, casting or iterating through all the key-value pairs is not necessary.

The `update` syntax is as follows:

```weave
<value_to_update> update {
    case <variable_name> at <update_expression>[!]? [if(<conditional_expression>)]? -> <new value>
    ...
}
```

- `value_to_update` represents the original value to update.

- `update_expression` is the selector expression that matches a value in `value_to_update`.

- `variable_name` is the name of the variable to bind to the matched `update_expression` value.

- `new_value` is the expression with the new value.

- `[if(<conditional_expression>)]?` If `conditional_expression` returns `true`, the script updates
  the value. Use of a conditional expression is optional.

- `[!]` marks the selector as an upsert. If the expression doesn’t find a match, the `!` makes the
  `update` operator create all the required elements and insert the new value.

- `update_expression` supports multiple `case` expressions.

> [!NOTE] The `update` operator doesn’t mutate the existing value. Instead, the operator creates a
> new value with the updated expressions.

### Selector Expressions

Use selector expressions with the `update` operator to specify the fields to update.

#### Value Selector

This matching selector can check for matches to any value within an object.

The following example updates a field at the root level and a field in a nested level using the
value selector:

Source

```weave
%dw 2.0
var myInput = {
    "name": "Ken",
    "lastName":"Shokida",
    "age": 30,
    "address": {
        "street": "Amenabar",
        "zipCode": "AB1234"
    }
}
output application/json
---
myInput update {
    case age at .age -> age + 1
    case s at .address.street -> "First Street"
}
```

Output

```json
{
  "name": "Ken",
  "lastName": "Shokida",
  "age": 31,
  "address": {
    "street": "First Street",
    "zipCode": "AB1234"
  }
}
```

#### Index Selector

This matching selector enables you to match any array by its index.

The following example updates an element that is at the first location of the array:

Input

```json
{
  "name": "Ken",
  "lastName": "Shokida",
  "age": 30,
  "addresses": [
    {
      "street": "Amenabar",
      "zipCode": "AB1234"
    }
  ]
}
```

Source

```weave
%dw 2.0
output application/json
---
payload update {
    case s at .addresses[0] -> {
        "street": "Second Street",
        "zipCode": "ZZ123"
    }
}
```

Output

```json
{
  "name": "Ken",
  "lastName": "Shokida",
  "age": 30,
  "addresses": [
    {
      "street": "Second Street",
      "zipCode": "ZZ123"
    }
  ]
}
```

#### Attribute Selector

This matching selector enables you to match any attribute value.

The following example updates an attribute value and changes it to upper case:

Input

```xml
<user name="leandro"/>
```

Source

```weave
%dw 2.0
output application/xml
---
payload update {
    case name at .user.@name -> upper(name)
}
```

Output

```xml
<?xml version='1.0' encoding='UTF-8'?>
<user name="LEANDRO"/>
```

#### Dynamic Selector

Any selector can incorporate an expression to make the selection dynamic.

The following example dynamically selects and updates the value of a field that is not hardcoded.
Such a field can change at runtime. The example uses the variable `theFieldName` to obtain the field
with key `name`, and it changes the value of that field to `Shoki`.

Input

```json
{
  "name": "Ken",
  "lastName": "Shokida"
}
```

Source

```weave
%dw 2.0
var theFieldName = "name"
output application/json
---
payload update {
    case s at ."$(theFieldName)" -> "Shoki"
}
```

Output

```json
{
  "name": "Shoki",
  "lastName": "Shokida"
}
```

### Conditional Update

The `update` operator has syntax for writing a conditional update if you want to modify a field
under a given condition.

The following example updates the category based on the name of the user:

Input

```json
[
  { "name": "Ken", "age": 30 },
  { "name": "Tomo", "age": 70 },
  { "name": "Kajika", "age": 10 }
]
```

Source

```weave
%dw 2.0
output application/json
---
payload map ((user) ->
    user update {
        case name at .name if(name == "Ken") -> name ++ " (Leandro)"
        case name at .name if(name == "Tomo") -> name ++ " (Christian)"
    }
)
```

Output

```json
[
  {
    "name": "Ken (Leandro)",
    "age": 30
  },
  {
    "name": "Tomo (Christian)",
    "age": 70
  },
  {
    "name": "Kajika",
    "age": 10
  }
]
```

### Upserting

The `update` operator enables you to insert a field that is not present already by using the `!`
symbol at the end of the selector expression. When the field is not present, the operator binds a
`null` value to the variable.

The following example updates each object in the array `myInput`. If the field `name` is present in
the object, the example applies the `upper` function to the value of `name`. If the field `name` is
not present in the object, the example appends the key-value pair `"name": "JOHN"` to the object.

Source

```weave
%dw 2.0
var myInput = [{"lastName": "Doe"}, {"lastName": "Parker", "name": "Peter" }]
output application/json
---
myInput  map ((value) ->
    value update {
        case name at .name! -> if(name == null) "JOHN" else upper(name)
    }
)
```

Output

```json
[
  {
    "lastName": "Doe",
    "name": "JOHN"
  },
  {
    "lastName": "Parker",
    "name": "PETER"
  }
]
```

### Sugar Syntax

The `update` operator accepts a default variable named `$` in place of the longer
`<variable_name> at` syntax.

The following example binds the value of the expression `.age` to the default variable name `$`,
which is used to express the new value. The longer equivalent is shown in comments.

Input

```json
{
  "name": "Ken",
  "lastName": "Shokida",
  "age": 30,
  "address": {
    "street": "Amenabar",
    "zipCode": "AB1234"
  }
}
```

Source

```weave
%dw 2.0
output application/json
---
payload update {
    //equivalent expression:
    //case age at .age -> age + 1
    case .age -> $ + 1
    case .address.street -> "First Street"
}
```

Output

```json
{
  "name": "Ken",
  "lastName": "Shokida",
  "age": 31,
  "address": {
    "street": "First Street",
    "zipCode": "AB1234"
  }
}
```

## Metadata Assignment Operator

DataWeave supports the metadata assignment operator `<~`, which enables you to set the metadata of
any value without using the `as` operator. This operator is useful when you want to set the metadata
and retain the current value type. If you are coercing the value to a new type, use
[as](https://docs.mulesoft.com/dataweave/latest/dataweave-types-coercion).

_Introduced in DataWeave 2.5.0. Supported by Mule 4.5 and later._

The operator syntax is as follows:

```none
<valueB> <~ <objectA>
```

The operator assigns `objectA` as metadata to `valueB`. The arrow points to the value to which the
metadata is assigned.

Versions prior to Mule 4.5 require the following syntax, for example, to add the `class` metadata
field to an object:

```weave
%dw 2.0
---
{name: "Ken"} as Object {class: "Person"}
```

In Mule 4.5, the metadata assignment operator `<~` simplifies the syntax:

```weave
%dw 2.0
---
{name: "Ken"} <~ {class: "Person"}
```

### Metadata Assignment Using Metadata Annotations

DataWeave adds support for metadata annotations. These special annotations, marked with `@Metadata`,
attach a key-value pair metadata to any value where they are used.

_Introduced in DataWeave 2.8.0._

The following example achieves the same result as the previous one, but by defining an annotation,
which is a class that binds the metadata key `class` to the value provided where it is used.

```weave
%dw 2.8

@Metadata(key="class")
annotation Class(value: String)
---
@Class(value="Person")
{name: "Ken"}
```

Defining metadata using annotations provides the following benefits:

- You can define annotations once and reuse them as metadata throughout your code.

- Annotations are additive, and using more than one annotation attaches all the key-value pairs
  together.

- You get type checking, enabling you to force the value of the annotation to be of a certain type,
  ensuring consistency.

However, there are certain restrictions when defining metadata annotations:

- Annotations marked with `@Metadata` can only have one parameter.

- The parameter must be called `value`.

- The metadata key is the value set to the key argument of the metadata annotation, not the name of
  the annotation itself (In the previous example, the metadata value is associated to the `class`
  key).

- Metadata annotations are additive, so if they are used on a reference that already has metadata,
  the new metadata is appended.

The following is an example of a metadata annotation that marks a value as CData for the XML
writter.

Source

```weave
%dw 2.8
output application/xml

@Metadata(key="cdata")
annotation CData(value: true)
---
root: {
 test: @CData(value = true) "testCData"
}
```

Output

```xml
<?xml version='1.0' encoding='UTF-8'?>
<root>
  <test><![CDATA[testCData]]></test>
</root>
```

### Metadata

Metadata is any additional information attached to a value that doesn’t affect its identity. Given
any two values `A` and `B` that are equal, if you attach metadata to `A` and call it `A'`, then
`A == A' == B`. So you can define a value that is formed by the value and the metadata attached to
it.

<!-- document id=0dba79723c0c89b13ef93dfaafd7b9942f9707f93bd1435ec079b7bab296abb2 url=/mulesoft/current/en-us/dataweave/2.11/index.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datawave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# DataWeave Overview

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This MuleSoft programming language simplifies data transformation tasks and serves as Mule runtime’s
expression language for configuring components and connectors. Build powerful integration solutions
with intuitive scripting capabilities.

DataWeave enables you to build a simple solution for a common use case for integration developers:
read and parse data from one format, transform the data, and write it out as a different format. For
example, a DataWeave script can receive a CSV file as input and transform it into an array of
complex JSON objects, or receive an XML input and write the data out to a flat file format.
DataWeave enables developers to focus on the transformation logic instead of thinking about the
specifics of reading, parsing, and writing specific data formats in a performant way.

- To learn more about DataWeave, visit [the language guide](https://docs.mulesoft.com/dataweave/2.11/dataweave-language-guide).

- To look up reference information about DataWeave operators and functions, visit
  [the reference guide](https://docs.mulesoft.com/dataweave/2.11/dw-functions).

- To see sample scripts to solve common transformation scenarios, visit
  [DataWeave examples](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook).

- To try DataWeave scripts interactively, visit
  [DataWeave Playground](https://dataweave.mulesoft.com/learn/).

- To get started with DataWeave for Mule runtime engine (Mule) version 4.4 and later, visit
  [the quickstart](https://docs.mulesoft.com/dataweave/2.11/dataweave-quickstart).

## Compatibility

This table specifies which version of DataWeave is bundled with each Mule runtime engine release:

<table><colgroup><col> <col></colgroup><thead><tr><th>Mule Version</th><th>DataWeave Version</th></tr></thead><tbody><tr><td><p>4.13</p></td><td><p>2.13</p></td></tr><tr><td><p>4.12</p></td><td><p>2.12</p></td></tr><tr><td><p>4.11</p></td><td><p>2.11</p></td></tr><tr><td><p>4.10</p></td><td><p>2.10</p></td></tr><tr><td><p>4.9</p></td><td><p>2.9</p></td></tr><tr><td><p>4.8</p></td><td><p>2.8</p></td></tr><tr><td><p>4.7</p></td><td><p>2.7</p></td></tr><tr><td><p>4.6</p></td><td><p>2.6</p></td></tr><tr><td><p>4.5</p></td><td><p>2.5</p></td></tr><tr><td><p>4.4</p></td><td><p>2.4</p></td></tr><tr><td><p>4.3</p></td><td><p>2.3</p></td></tr><tr><td><p>4.2</p></td><td><p>2.2</p></td></tr><tr><td><p>4.1</p></td><td><p>2.1</p></td></tr><tr><td><p>3.9</p></td><td><p>1.2</p></td></tr><tr><td><p>3.8</p></td><td><p>1.1</p></td></tr><tr><td><p>3.7</p></td><td><p>1.0</p></td></tr></tbody></table>

<!-- document id=2be6148e24d7d28d22ba86b9dd06b4fdb6cd069b561dd6e5e9b300adec3970b4 url=/mulesoft/current/en-us/dataweave/2.12/index.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datawave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# DataWeave Overview

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This MuleSoft programming language simplifies data transformation tasks and serves as Mule runtime’s
expression language for configuring components and connectors. Build powerful integration solutions
with intuitive scripting capabilities.

DataWeave enables you to build a simple solution for a common use case for integration developers:
read and parse data from one format, transform the data, and write it out as a different format. For
example, a DataWeave script can receive a CSV file as input and transform it into an array of
complex JSON objects, or receive an XML input and write the data out to a flat file format.
DataWeave enables developers to focus on the transformation logic instead of thinking about the
specifics of reading, parsing, and writing specific data formats in a performant way.

- To learn more about DataWeave, visit [the language guide](https://docs.mulesoft.com/dataweave/2.12/dataweave-language-guide).

- To look up reference information about DataWeave operators and functions, visit
  [the reference guide](https://docs.mulesoft.com/dataweave/2.12/dw-functions).

- To see sample scripts to solve common transformation scenarios, visit
  [DataWeave examples](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook).

- To try DataWeave scripts interactively, visit
  [DataWeave Playground](https://dataweave.mulesoft.com/learn/).

- To get started with DataWeave for Mule runtime engine (Mule) version 4.4 and later, visit
  [the quickstart](https://docs.mulesoft.com/dataweave/2.12/dataweave-quickstart).

## Compatibility

This table specifies which version of DataWeave is bundled with each Mule runtime engine release:

<table><colgroup><col> <col></colgroup><thead><tr><th>Mule Version</th><th>DataWeave Version</th></tr></thead><tbody><tr><td><p>4.13</p></td><td><p>2.13</p></td></tr><tr><td><p>4.12</p></td><td><p>2.12</p></td></tr><tr><td><p>4.11</p></td><td><p>2.11</p></td></tr><tr><td><p>4.10</p></td><td><p>2.10</p></td></tr><tr><td><p>4.9</p></td><td><p>2.9</p></td></tr><tr><td><p>4.8</p></td><td><p>2.8</p></td></tr><tr><td><p>4.7</p></td><td><p>2.7</p></td></tr><tr><td><p>4.6</p></td><td><p>2.6</p></td></tr><tr><td><p>4.5</p></td><td><p>2.5</p></td></tr><tr><td><p>4.4</p></td><td><p>2.4</p></td></tr><tr><td><p>4.3</p></td><td><p>2.3</p></td></tr><tr><td><p>4.2</p></td><td><p>2.2</p></td></tr><tr><td><p>4.1</p></td><td><p>2.1</p></td></tr><tr><td><p>3.9</p></td><td><p>1.2</p></td></tr><tr><td><p>3.8</p></td><td><p>1.1</p></td></tr><tr><td><p>3.7</p></td><td><p>1.0</p></td></tr></tbody></table>

<!-- document id=d306dc7fe2c8d7dee683807e1aeec1f7a2b79cec09737b2f14eef930c8fa78cc url=/mulesoft/current/en-us/dataweave/2.3/index.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datawave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# DataWeave Overview

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This MuleSoft programming language simplifies data transformation tasks and serves as Mule runtime’s
expression language for configuring components and connectors. Build powerful integration solutions
with intuitive scripting capabilities.

DataWeave enables you to build a simple solution for a common use case for integration developers:
read and parse data from one format, transform the data, and write it out as a different format. For
example, a DataWeave script can receive a CSV file as input and transform it into an array of
complex JSON objects, or receive an XML input and write the data out to a flat file format.
DataWeave enables developers to focus on the transformation logic instead of thinking about the
specifics of reading, parsing, and writing specific data formats in a performant way.

- To learn more about DataWeave, visit [the language guide](https://docs.mulesoft.com/dataweave/2.3/dataweave-language-guide).

- To look up reference information about DataWeave 2.3.0 operators and functions, visit
  [the reference guide](https://docs.mulesoft.com/dataweave/2.3/dw-functions).

- To see sample scripts to solve common transformation scenarios, visit
  [DataWeave examples](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook).

- To get started with DataWeave 2.3.0 for Mule runtime engine (Mule) version 4.3 and later, visit
  [the quickstart](https://docs.mulesoft.com/dataweave/2.3/dataweave-quickstart).

## Compatibility

This table specifies which version of DataWeave is bundled with each Mule runtime engine release:

<table><colgroup><col> <col></colgroup><thead><tr><th>Mule Version</th><th>DataWeave Version</th></tr></thead><tbody><tr><td><p>4.13</p></td><td><p>2.13</p></td></tr><tr><td><p>4.12</p></td><td><p>2.12</p></td></tr><tr><td><p>4.11</p></td><td><p>2.11</p></td></tr><tr><td><p>4.10</p></td><td><p>2.10</p></td></tr><tr><td><p>4.9</p></td><td><p>2.9</p></td></tr><tr><td><p>4.8</p></td><td><p>2.8</p></td></tr><tr><td><p>4.7</p></td><td><p>2.7</p></td></tr><tr><td><p>4.6</p></td><td><p>2.6</p></td></tr><tr><td><p>4.5</p></td><td><p>2.5</p></td></tr><tr><td><p>4.4</p></td><td><p>2.4</p></td></tr><tr><td><p>4.3</p></td><td><p>2.3</p></td></tr><tr><td><p>4.2</p></td><td><p>2.2</p></td></tr><tr><td><p>4.1</p></td><td><p>2.1</p></td></tr><tr><td><p>3.9</p></td><td><p>1.2</p></td></tr><tr><td><p>3.8</p></td><td><p>1.1</p></td></tr><tr><td><p>3.7</p></td><td><p>1.0</p></td></tr></tbody></table>

<!-- document id=c88c353fbc5a5d65fb6c95229354deba0e63bbb93838e3a6b4503b1a96ec6b15 url=/mulesoft/current/en-us/dataweave/2.4/index.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datawave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# DataWeave Overview

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This MuleSoft programming language simplifies data transformation tasks and serves as Mule runtime’s
expression language for configuring components and connectors. Build powerful integration solutions
with intuitive scripting capabilities.

DataWeave enables you to build a simple solution for a common use case for integration developers:
read and parse data from one format, transform the data, and write it out as a different format. For
example, a DataWeave script can receive a CSV file as input and transform it into an array of
complex JSON objects, or receive an XML input and write the data out to a flat file format.
DataWeave enables developers to focus on the transformation logic instead of thinking about the
specifics of reading, parsing, and writing specific data formats in a performant way.

- To learn more about DataWeave, visit [the language guide](https://docs.mulesoft.com/dataweave/2.4/dataweave-language-guide).

- To look up reference information about DataWeave 2.4.0 operators and functions, visit
  [the reference guide](https://docs.mulesoft.com/dataweave/2.4/dw-functions).

- To see sample scripts to solve common transformation scenarios, visit
  [DataWeave examples](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook).

- To try DataWeave scripts interactively, visit
  [DataWeave Playground](https://dataweave.mulesoft.com/learn/).

- To get started with DataWeave 2.4.0 for Mule runtime engine (Mule) version 4.4 and later, visit
  [the quickstart](https://docs.mulesoft.com/dataweave/2.4/dataweave-quickstart).

## Compatibility

This table specifies which version of DataWeave is bundled with each Mule runtime engine release:

<table><colgroup><col> <col></colgroup><thead><tr><th>Mule Version</th><th>DataWeave Version</th></tr></thead><tbody><tr><td><p>4.13</p></td><td><p>2.13</p></td></tr><tr><td><p>4.12</p></td><td><p>2.12</p></td></tr><tr><td><p>4.11</p></td><td><p>2.11</p></td></tr><tr><td><p>4.10</p></td><td><p>2.10</p></td></tr><tr><td><p>4.9</p></td><td><p>2.9</p></td></tr><tr><td><p>4.8</p></td><td><p>2.8</p></td></tr><tr><td><p>4.7</p></td><td><p>2.7</p></td></tr><tr><td><p>4.6</p></td><td><p>2.6</p></td></tr><tr><td><p>4.5</p></td><td><p>2.5</p></td></tr><tr><td><p>4.4</p></td><td><p>2.4</p></td></tr><tr><td><p>4.3</p></td><td><p>2.3</p></td></tr><tr><td><p>4.2</p></td><td><p>2.2</p></td></tr><tr><td><p>4.1</p></td><td><p>2.1</p></td></tr><tr><td><p>3.9</p></td><td><p>1.2</p></td></tr><tr><td><p>3.8</p></td><td><p>1.1</p></td></tr><tr><td><p>3.7</p></td><td><p>1.0</p></td></tr></tbody></table>

<!-- document id=38cb936500f97fea4720f0c5d34063c66603d554b14919e6fce4b26eeb2f49bc url=/mulesoft/current/en-us/dataweave/2.6/index.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datawave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# DataWeave Overview

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This MuleSoft programming language simplifies data transformation tasks and serves as Mule runtime’s
expression language for configuring components and connectors. Build powerful integration solutions
with intuitive scripting capabilities.

DataWeave enables you to build a simple solution for a common use case for integration developers:
read and parse data from one format, transform the data, and write it out as a different format. For
example, a DataWeave script can receive a CSV file as input and transform it into an array of
complex JSON objects, or receive an XML input and write the data out to a flat file format.
DataWeave enables developers to focus on the transformation logic instead of thinking about the
specifics of reading, parsing, and writing specific data formats in a performant way.

- To learn more about DataWeave, visit [the language guide](https://docs.mulesoft.com/dataweave/2.6/dataweave-language-guide).

- To look up reference information about DataWeave 2.4.0 operators and functions, visit
  [the reference guide](https://docs.mulesoft.com/dataweave/2.6/dw-functions).

- To see sample scripts to solve common transformation scenarios, visit
  [DataWeave examples](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook).

- To try DataWeave scripts interactively, visit
  [DataWeave Playground](https://dataweave.mulesoft.com/learn/).

- To get started with DataWeave 2.4.0 for Mule runtime engine (Mule) version 4.4 and later, visit
  [the quickstart](https://docs.mulesoft.com/dataweave/2.6/dataweave-quickstart).

## Compatibility

This table specifies which version of DataWeave is bundled with each Mule runtime engine release:

<table><colgroup><col> <col></colgroup><thead><tr><th>Mule Version</th><th>DataWeave Version</th></tr></thead><tbody><tr><td><p>4.13</p></td><td><p>2.13</p></td></tr><tr><td><p>4.12</p></td><td><p>2.12</p></td></tr><tr><td><p>4.11</p></td><td><p>2.11</p></td></tr><tr><td><p>4.10</p></td><td><p>2.10</p></td></tr><tr><td><p>4.9</p></td><td><p>2.9</p></td></tr><tr><td><p>4.8</p></td><td><p>2.8</p></td></tr><tr><td><p>4.7</p></td><td><p>2.7</p></td></tr><tr><td><p>4.6</p></td><td><p>2.6</p></td></tr><tr><td><p>4.5</p></td><td><p>2.5</p></td></tr><tr><td><p>4.4</p></td><td><p>2.4</p></td></tr><tr><td><p>4.3</p></td><td><p>2.3</p></td></tr><tr><td><p>4.2</p></td><td><p>2.2</p></td></tr><tr><td><p>4.1</p></td><td><p>2.1</p></td></tr><tr><td><p>3.9</p></td><td><p>1.2</p></td></tr><tr><td><p>3.8</p></td><td><p>1.1</p></td></tr><tr><td><p>3.7</p></td><td><p>1.0</p></td></tr></tbody></table>

<!-- document id=beb8e22d34630b8a6193588843228cd35bb9e2d7b5c99c3dbb0d3c2d11123c79 url=/mulesoft/current/en-us/dataweave/2.9/index.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datawave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# DataWeave Overview

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This MuleSoft programming language simplifies data transformation tasks and serves as Mule runtime’s
expression language for configuring components and connectors. Build powerful integration solutions
with intuitive scripting capabilities.

DataWeave enables you to build a simple solution for a common use case for integration developers:
read and parse data from one format, transform the data, and write it out as a different format. For
example, a DataWeave script can receive a CSV file as input and transform it into an array of
complex JSON objects, or receive an XML input and write the data out to a flat file format.
DataWeave enables developers to focus on the transformation logic instead of thinking about the
specifics of reading, parsing, and writing specific data formats in a performant way.

- To learn more about DataWeave, visit [the language guide](https://docs.mulesoft.com/dataweave/2.9/dataweave-language-guide).

- To look up reference information about DataWeave operators and functions, visit
  [the reference guide](https://docs.mulesoft.com/dataweave/2.9/dw-functions).

- To see sample scripts to solve common transformation scenarios, visit
  [DataWeave examples](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook).

- To try DataWeave scripts interactively, visit
  [DataWeave Playground](https://dataweave.mulesoft.com/learn/).

- To get started with DataWeave for Mule runtime engine (Mule) version 4.4 and later, visit
  [the quickstart](https://docs.mulesoft.com/dataweave/2.9/dataweave-quickstart).

## Compatibility

This table specifies which version of DataWeave is bundled with each Mule runtime engine release:

<table><colgroup><col> <col></colgroup><thead><tr><th>Mule Version</th><th>DataWeave Version</th></tr></thead><tbody><tr><td><p>4.13</p></td><td><p>2.13</p></td></tr><tr><td><p>4.12</p></td><td><p>2.12</p></td></tr><tr><td><p>4.11</p></td><td><p>2.11</p></td></tr><tr><td><p>4.10</p></td><td><p>2.10</p></td></tr><tr><td><p>4.9</p></td><td><p>2.9</p></td></tr><tr><td><p>4.8</p></td><td><p>2.8</p></td></tr><tr><td><p>4.7</p></td><td><p>2.7</p></td></tr><tr><td><p>4.6</p></td><td><p>2.6</p></td></tr><tr><td><p>4.5</p></td><td><p>2.5</p></td></tr><tr><td><p>4.4</p></td><td><p>2.4</p></td></tr><tr><td><p>4.3</p></td><td><p>2.3</p></td></tr><tr><td><p>4.2</p></td><td><p>2.2</p></td></tr><tr><td><p>4.1</p></td><td><p>2.1</p></td></tr><tr><td><p>3.9</p></td><td><p>1.2</p></td></tr><tr><td><p>3.8</p></td><td><p>1.1</p></td></tr><tr><td><p>3.7</p></td><td><p>1.0</p></td></tr></tbody></table>

<!-- document id=fdb0fd0cb680fb2b9222416517d69c0b3351911e585a99ef9e075a1f426504b4 url=/mulesoft/current/en-us/dataweave/latest/index.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datawave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# DataWeave Overview

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This MuleSoft programming language simplifies data transformation tasks and serves as Mule runtime’s
expression language for configuring components and connectors. Build powerful integration solutions
with intuitive scripting capabilities.

DataWeave enables you to build a simple solution for a common use case for integration developers:
read and parse data from one format, transform the data, and write it out as a different format. For
example, a DataWeave script can receive a CSV file as input and transform it into an array of
complex JSON objects, or receive an XML input and write the data out to a flat file format.
DataWeave enables developers to focus on the transformation logic instead of thinking about the
specifics of reading, parsing, and writing specific data formats in a performant way.

- To learn more about DataWeave, visit [the language guide](https://docs.mulesoft.com/dataweave/latest/dataweave-language-guide).

- To look up reference information about DataWeave operators and functions, visit
  [the reference guide](https://docs.mulesoft.com/dataweave/latest/dw-functions).

- To see sample scripts to solve common transformation scenarios, visit
  [DataWeave examples](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook).

- To try DataWeave scripts interactively, visit
  [DataWeave Playground](https://dataweave.mulesoft.com/learn/).

- To get started with DataWeave for Mule runtime engine (Mule) version 4.4 and later, visit
  [the quickstart](https://docs.mulesoft.com/dataweave/latest/dataweave-quickstart).

## Compatibility

This table specifies which version of DataWeave is bundled with each Mule runtime engine release:

<table><colgroup><col> <col></colgroup><thead><tr><th>Mule Version</th><th>DataWeave Version</th></tr></thead><tbody><tr><td><p>4.13</p></td><td><p>2.13</p></td></tr><tr><td><p>4.12</p></td><td><p>2.12</p></td></tr><tr><td><p>4.11</p></td><td><p>2.11</p></td></tr><tr><td><p>4.10</p></td><td><p>2.10</p></td></tr><tr><td><p>4.9</p></td><td><p>2.9</p></td></tr><tr><td><p>4.8</p></td><td><p>2.8</p></td></tr><tr><td><p>4.7</p></td><td><p>2.7</p></td></tr><tr><td><p>4.6</p></td><td><p>2.6</p></td></tr><tr><td><p>4.5</p></td><td><p>2.5</p></td></tr><tr><td><p>4.4</p></td><td><p>2.4</p></td></tr><tr><td><p>4.3</p></td><td><p>2.3</p></td></tr><tr><td><p>4.2</p></td><td><p>2.2</p></td></tr><tr><td><p>4.1</p></td><td><p>2.1</p></td></tr><tr><td><p>3.9</p></td><td><p>1.2</p></td></tr><tr><td><p>3.8</p></td><td><p>1.1</p></td></tr><tr><td><p>3.7</p></td><td><p>1.0</p></td></tr></tbody></table>

<!-- document id=fbf1839a4c02dfeffd96c181e5e839dab39df7f46f037588dae592cee18debab url=/mulesoft/current/en-us/dataweave/2.11/dataweave-quickstart.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, transform, transformer, format, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# DataWeave Quickstart

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

In this guide, you run DataWeave 2.0 scripts on sample data, without relying on external data
sources.

The examples introduce some key DataWeave concepts that you can explore further whenever you are
ready, and they show how to turn the Transform Message component into a DataWeave playground.

To run the scripts, you copy them into the source code area of a Transform Message component in
[Studio](https://docs.mulesoft.com/studio/), then view the results in the component’s **Preview** pane. You also load
content from files so that your DataWeave script can act on it. Once you feel comfortable with
DataWeave examples here and elsewhere in the docs, you can use the DataWeave playground to practice
writing your own DataWeave scripts on sample data.

![A script in Anypoint Studio showing a basic JSON output](/mulesoft/current/en-us/dataweave/2.11/_images/dw-tut-script-studio-basic.png)

The figure shows a Transform Message component in the center canvas, within **testingscriptFlow**.
Below the Studio canvas, the **Transform Message** tab includes a DataWeave script in the source
code area with output in the **Preview** pane.

## Prerequisites

[Studio 7](https://docs.mulesoft.com/studio/to-download-and-install-studio) is required. Versions 7.3 or 7.2.3 are
recommended. Other Studio 7 versions are untested with this guide.

Once Studio is installed, you need to set up a project with a Transform Message component. See
[Set Up a Project in Studio](#setup).

## Set Up a Project in Studio

Set up a Mule project that serves as a DataWeave playground:

1.  In Studio, click **File** → **New** → **Mule Project** to create a Mule project.

2.  Provide the name `testscript` for the project, and click **Finish**.

3.  From the **Mule Palette** tab of your new project, click **Core**, and then drag the **Transform
    Message** component into the Studio canvas.

    ![A Transform Message component in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.11/_images/dw-tut-script-studio.png)

    (A) **Mule Palette** tab

    (B) Studio canvas with Transform Message component

    (C) **Transform Message** tab

4.  In the **Transform Message** tab, click **Preview** (on the far right) to open the Preview pane,
    and click the _empty_ rectangle next to **Preview** to expand the source code area.

    ![A Transform Message tab showing an output payload in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.11/_images/studio-transform-msg-tab.png)

    The source code area on the left is the place where you are going to add DataWeave scripts, and
    the Preview pane on the right is where you view the output of the scripts.

5.  Proceed to [Start Scripting](#start_scripting).

## Start Scripting

1.  [Concatenate Two Strings into a Single String](#step_1)

2.  [Transform JSON Input to XML Output](#step_2)

3.  [Learn About Supported Data Types](#step_3)

4.  [Define and Use a DataWeave Variable as Input](#step_4)

5.  [Use a DataWeave Function in a DataWeave Variable](#step_5)

6.  [Read, Transform, and Select Content from an Input](#step_6)

7.  [Read File Contents with a DataWeave Function](#step_7)

8.  [Map Elements from an Array into an Object](#step_8)

9.  [Pluck Values from an Object into an Array](#step_9)

10. [Map and Merge Fields](#step_10)

### Concatenate Two Strings into a Single String

Begin with a simple DataWeave script that concatenates two strings ("hello" and "World") together
into a single string ("helloWorld").

![A DataWeave script that outputs 'helloWorld' in JSON format](/mulesoft/current/en-us/dataweave/2.11/_images/dw-tut-helloWorld.png)

1.  Replace the current script in the source code area of the **Transform Message** tab with this
    one:

    ```dw
    %dw 2.0
    output application/json
    ---
    { myString: ("hello" ++ "World") }
    ```

    - The body of the DataWeave script contains a key-value pair
      (`{ myString: ("hello" ++ "World") }`). The value of this input object is a DataWeave
      expression (`("hello" ++ "World")`) for concatenating the strings "hello" and "World" into a
      single string, "helloWorld".

      When you are ready, you can learn about the DataWeave [++](https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-plusplus)
      function used to concatenate the strings.

    - The header of the script is all the content above the three dashes, `---`. It includes
      important directives, including one for specifying the output format `application/json`. You
      can learn more about [DataWeave Scripts](https://docs.mulesoft.com/dataweave/2.11/dataweave-language-introduction) when you are ready.

2.  See the JSON output in the **Preview** pane:

    ```json
    { "myString": "helloWorld" }
    ```

3.  Proceed to [Transform JSON Input to XML Output](#step_2).

### Transform JSON Input to XML Output

Many integrations require transformations from one format to another. This procedure uses the
`output` directive to produce XML output from JSON input.

![A DataWeave script that outputs 'helloWorld' in XML format](/mulesoft/current/en-us/dataweave/2.11/_images/dw-tut-helloWorld-xml.png)

1.  Replace the body of the current script in the source code area with JSON output from
    [Concatenate Two Strings into a Single String](#step_1), and change the
    `output application/json` directive to `output application/xml`:

    ```dw
    %dw 2.0
    output application/xml
    ---
    { "myString" : ("helloWorld") }
    ```

2.  See the XML output in the **Preview** pane:

    ```xml
    <?xml version='1.0' encoding='UTF-8'?>
    <myString>helloWorld</myString>
    ```

    Notice that the `"myString"` key of the input JSON object `{ "myString" : ("helloWorld") }` is
    converted to the root element of the XML output and that the concatenated string becomes the
    value of that XML object. So the XML output is `<myString>helloWorld</myString>`. That output is
    preceded by a standard XML declaration that specifies the XML version and encoding.

    > [!NOTE] Without a _single_ key to serve as a root node for XML output (for example, if the
    > input is simply `("helloWorld")`), the transformation to XML will fail with a yellow warning
    > (**!**) in the source code area. The warning message is
    > `Trying to output non-whitespace characters outside main element tree`. If you like, you can
    > try to produce this warning on your own.

    DataWeave supports many output and input formats. You can learn more about
    [Supported Data Formats](https://docs.mulesoft.com/dataweave/2.11/dataweave-formats) when you are ready.

3.  Proceed to [Learn About Supported Data Types](#step_3)

### Learn About Supported Data Types

Now provide a DataWeave script that simply introduces you to a variety of supported data types and
shows how to add comments to a script.

1.  Replace the current script in the source code area of the **Transform Message** tab with this
    one:

    ```dw
    %dw 2.0
    output application/json
    ---
    {
      /*
       * A multi-line
       * comment here.
       */
      myString: "hello world",
      myNumber: 123,
      myFloatingPointNumber: 123.456,
      myVeryBigNumber: 12341234134123412341234123,
      myDate: |2018-12-07|,
      myTime: |11:55:56|,
      myDateTime: |2018-10-01T23:57:59-03:00|,
      myBoolean: true,
      myArray: [ 1, 2, 3, 5, 8],
      myMixedArray: [ 1, 2, "blah", { hello: "there" } ],
      myObjectKeyValuePair: { innerKey: "innerValue" },
      myObjectWithConditionalField: { a : { b : 1, ( c : 2 ) if true, (d : 4) if false } },
      myNull: null,
      myBinary: "abcd1234123" as Binary
      //A one-line comment here.
    }
    ```

    DataWeave supports multi-line comments within `/* */` markup and single-line comments after
    forward slashes (`//`). It also supports many data types, shown after the colon (`:`) in
    key-value pairs, such as `myString: "hello world"` and `myNumber: 123`. These types include
    strings (surrounded by quotation marks, `""`), numbers, date and time structures (within pipes,
    `||`), Booleans (`true` and `false`), arrays (within square brackets, `[]`), JSON-like objects
    (key-value structures within curly braces, `{}`), `null`, and binaries. When you are ready for
    more on this topic, you can review [DataWeave types](https://docs.mulesoft.com/dataweave/2.11/dataweave-types).

2.  See the JSON output in the **Preview** pane:

    ```json
    {
      "myString": "hello world",
      "myNumber": 123,
      "myFloatingPointNumber": 123.456,
      "myVeryBigNumber": 12341234134123412341234123,
      "myDate": "2018-12-07",
      "myTime": "11:55:56",
      "myDateTime": "2018-10-01T23:57:59-03:00",
      "myBoolean": true,
      "myArray": [1, 2, 3, 5, 8],
      "myMixedArray": [1, 2, "blah", { "hello": "there" }],
      "myObjectKeyValuePair": { "innerKey": "innerValue" },
      "myObjectWithConditionalField": { "a": { "b": 1, "c": 2 } },
      "myNull": null,
      "myBinary": "abcd1234123"
    }
    ```

3.  Proceed to [Define and Use a DataWeave Variable as Input](#step_4)

### Define and Use a DataWeave Variable as Input

Now try a simple DataWeave script that outputs the value of the DataWeave variable `myJson`. You set
the variable using the `var` directive in the script’s header.

1.  Replace the current script in the source code area of the **Transform Message** tab with this
    one:

    ```dw
    %dw 2.0
    var myJson = { "hello" : "world" }
    output application/json
    ---
    myJson
    ```

    A JSON object (`{ "hello" : "world" }`) is defined as the `myJson` variable in the script’s
    header. You can learn more about [DataWeave Variables](https://docs.mulesoft.com/dataweave/2.11/dataweave-variables) when you are ready.

2.  See the output in the **Preview** pane:

    ```json
    {
      "hello": "world"
    }
    ```

3.  Proceed to [Use a DataWeave Function in a DataWeave Variable](#step_5)

### Use a DataWeave Function in a DataWeave Variable

Now try a script that uses the DataWeave `avg` function in a DataWeave variable (`myJson`) to get
averages of two sets of numbers.

![A DataWeave script using a variable in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.11/_images/dw-tut-script-studio-var.png)

1.  Replace the current script in the source code area with this one:

    ```dw
    %dw 2.0
    var myJson = {
      a: avg([1, 1000]),
      b: avg([1, 2, 3])
    }
    output application/json
    ---
    myJson
    ```

    The `avg` functions here get invoked when you add `myJson` to the body of the script, producing
    the calculated averages within the JSON object you can see in the **Preview** pane. The
    structures `[1, 1000]` and `[1, 2, 3]` are [arrays](https://docs.mulesoft.com/dataweave/2.11/dataweave-types#dw_type_array). You can
    learn more about [avg](https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-avg) when you are ready.

2.  Preview the output:

    ```json
    {
      "a": 500.5,
      "b": 2.0
    }
    ```

3.  Proceed to [Read, Transform, and Select Content from an Input](#step_6)

### Read, Transform, and Select Content from an Input

Now try a more complicated script that reads XML input, transforms it to JSON, and only selects the
contents of the `car` element.

1.  Replace the current script in the source code area with this one:

    ```dw
    %dw 2.0
    var myRead = read("<car><color>red</color></car>",
                    "application/xml")
    output application/json
    ---
    {
      mySelection : myRead.car
    }
    ```

    If you encounter an issue previewing this example, try changing `myRead.car` to `myRead."car"`.
    Learn more about the [read](https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-read) function,
    [Supported Data Formats](https://docs.mulesoft.com/dataweave/2.11/dataweave-formats), and [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.11/dataweave-selectors) when
    you are ready.

2.  Preview the output:

    ```json
    {
      "mySelection": {
        "color": "red"
      }
    }
    ```

3.  Proceed to [Read File Contents with a DataWeave Function](#step_7)

### Read File Contents with a DataWeave Function

Now use `readUrl` to read the contents of a file in the Studio `src/main/resources` folder so you
can use that content as sample data for a DataWeave script.

1.  Add a file by right-clicking the `src/main/resources` folder in the **Package Explorer** tab,
    then navigating to **New** → **File**, providing the file name `myJson.json` for that file, and
    clicking **Finish**.

2.  From `src/main/resources`, provide and save the following sample content in the **myJson.json**
    tab (or within the **Source** sub-tab of the **myJson.json** tab, if it is present):

    ```json
    {
      "hello": "world"
    }
    ```

    ![A Package Explorer tab showing a sample content in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.11/_images/dw-tut-sample-file.png)

    Figure 1. myJson.json in Studio

3.  Returning to the Transform Message component within the **testscript** tab, replace the current
    script with one that uses `readUrl` to read the JSON contents from your file:

    ```dw
    %dw 2.0
    output application/json
    ---
    readUrl("classpath://myJson.json", "application/json")
    ```

    Learn more about the [readUrl](https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-readurl) function when you are ready.

4.  View the matching output in the **Preview** pane.

    ```json
    {
      "hello": "world"
    }
    ```

    Note that you can also load the contents of a file through a metadata type in the Transform
    Message component. That procedure is covered later, in
    [Run Examples with Longer Payloads](#med_large_payload). It uses the `myJson.json` file you just
    created.

5.  Proceed to [Map Elements from an Array into an Object](#step_8)

### Map Elements from an Array into an Object

Almost all integrations require data mappings. Here, you map elements within an array to keys and
values of a JSON object:

1.  Replace the current script in the source code area with this one:

    ```dw
    %dw 2.0
    output application/json
    ---
    {
      (
        ["a", "b", "c"] map ((value, index) -> {
            (index): value
        })
      )
    }
    ```

    The `map` function iterates over the array on the left to apply the lambda (anonymous function)
    on the right (`((value, index) → { (index): value })`) to elements in that array. The lambda
    uses [named parameters](https://docs.mulesoft.com/dataweave/2.11/dataweave-functions-lambdas#_use_named_parameters_in_a_lambda) (`value`
    and `index`) to select the values and indices from the array and populate a JSON object with
    key-value pairs. Learn about [map](https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-map), and when you are ready, compare `map`
    with [mapObject](https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-mapobject), which takes an object as input.

2.  Preview the output:

    ```json
    {
      "0": "a",
      "1": "b",
      "2": "c"
    }
    ```

3.  Proceed to [Pluck Values from an Object into an Array](#step_9)

### Pluck Values from an Object into an Array

Now use the DataWeave `pluck` function to iterate over values in a JSON object and output those
values into an array.

1.  Replace the contents of the source code area with a script that uses `pluck` on a JSON object:

    ```dw
    %dw 2.0
    output application/json
    ---
    {
      "0": "a",
      "1": "b",
      "2": "c"
    } pluck ((value) -> value)
    ```

    Notice that the input object matches the [output](#output_map) of the `map` example and that the
    output array matches the [input](#input_map) from the `map` example. Learn more about
    [pluck](https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-pluck) when you are ready.

2.  Preview the output:

    ```json
    ["a", "b", "c"]
    ```

3.  Proceed to [Map and Merge Fields](#step_10).

### Map and Merge Fields

Now try a more complex example that maps and merges fields from items in separate arrays. The point
here is simply to provide a taste of DataWeave’s ability to handle more complex mappings and
transformations needed for some integrations.

1.  Replace the current script in the source code area with this one:

    ```dw
    %dw 2.0
    var myVar = [
      { bookId: 101,
        title: "world history",
        price: "19.99"
      },
      {
        bookId: 202,
        title: 'the great outdoors',
        price: "15.99"
      }
    ]
    var myVar2 = [
      {
        bookId: 101,
        author: "john doe"
      },
      {
        bookId: 202,
        author: "jane doe"
      }
    ]
    output application/json
    ---
    myVar map (item, index) -> using (id = item.bookId) {
    	"id" : id,
    	"topic" : item.title,
    	"cost" : item.price as Number,
    	(myVar2 filter ($.*bookId contains id) map (item) -> {
    		author : item.author
    	})
    }
    ```

    When you are ready to explore the language further, you can learn how the
    [filter](https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-filter) function used near the end returns `author` values from the
    array in the `myVar2` variable. You can read about
    [type coercion with DataWeave](https://docs.mulesoft.com/dataweave/2.11/dataweave-types-coercion) to see how `as` works with the data
    type in the line `"cost" : item.price as Number,` to coerce input strings like `"19.99"` into
    numbers like `19.99`. You can see how `using` (shown in `using (id = item.bookId)`) enables you
    to create [local DataWeave variables](https://docs.mulesoft.com/dataweave/2.11/dataweave-variables#example_local_variable) in a script.

2.  Preview the output:

    ```json
    [
      {
        "id": "101",
        "topic": "world history",
        "cost": 19.99,
        "author": "john doe"
      },
      {
        "id": "202",
        "topic": "the great outdoors",
        "cost": 15.99,
        "author": "jane doe"
      }
    ]
    ```

3.  Proceed to [Try Out More DataWeave Examples](#more_examples).

## Try Out More DataWeave Examples

Now you are ready to run DataWeave examples on your own. In your DataWeave playground, you can run
examples from the docs whenever you want to discover more about the DataWeave language. You can play
with the examples and use them to start your own scripts.

> [!NOTE] For examples that use `payload` to reference input data (such as the
> [contains](https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-contains#contains1) or [mapObject](https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-mapobject)
> function examples), you can avoid payload-related issues by using techniques described in
> [Run Examples that Act on a Payload](#provide_payload).

1.  Find many more examples to try out in Studio here:

    - [DataWeave Operators](https://docs.mulesoft.com/dataweave/2.11/dw-operators)

    - [DataWeave Reference](https://docs.mulesoft.com/dataweave/2.11/dw-functions): Docs on the DataWeave function modules provide many
      examples that use DataWeave functions.

    - [Flow Control in DataWeave](https://docs.mulesoft.com/dataweave/2.11/dataweave-flow-control)

    - [Pattern Matching in DataWeave](https://docs.mulesoft.com/dataweave/2.11/dataweave-pattern-matching)

    - [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook)

    - [Define DataWeave Functions](https://docs.mulesoft.com/dataweave/2.11/dataweave-functions)

2.  Proceed to [Next Steps](#next_steps).

### Run Examples that Act on a Payload

In DataWeave, `payload` is a built-in Mule Runtime variable that holds the contents of a
[Mule message](https://docs.mulesoft.com/mule-runtime/latest/about-mule-message#_message_payload). It enables you to
retrieve the body of a message simply by typing `payload` into the DataWeave script. The docs often
refer to this content as "the payload."

To try out DataWeave examples that use `payload` to get the contents of a Mule message, you have
some options:

- [Run Examples with Short Payloads](#small_payload): You can use a DataWeave variable.

- [Run Examples with Longer Payloads](#med_large_payload): Add the payload content through a file.
  This technique also works for short payloads.

Alternatives that require a running Mule app (such as using
[Set Payload](https://docs.mulesoft.com/mule-runtime/latest/set-payload-transformer-reference)) are not covered here but
are introduced in [Next Steps](#next_steps).

#### Run Examples with Short Payloads

For short examples with a few lines of sample data, you can convert the input payload to a variable.
You simply copy the payload’s content into a DataWeave variable (`var`) in the header of a DataWeave
script. Then, in the body of the script, you replace `payload` with the name of the new variable to
reference that variable.

1.  Start with this script in the source code area:

    ```DataWeave
    %dw 2.0
    output application/json
    ---
    ContainsRequestedItem: payload.root.*order.*items contains "3"
    ```

    Notice that you cannot preview it yet:

    ![A DataWeave script that checks if a payload contains a specific item in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.11/_images/dw-tut-payload-example.png)

2.  Now modify this example so that it uses some sample input instead of attempting to use `payload`
    to input content of a Mule message that does not exist:

    1.  Add a `myInput` DataWeave variable supplying some input data the script can read, and change
        the Mule `payload` variable in the body of the script to the DataWeave `myInput` variable.

        ```DataWeave
        %dw 2.0
        var myInput = read("<root>
            <order>
              <items>1</items>
              <items>3</items>
            </order>
            <order>
              <items>2</items>
            </order>
        </root>",
        "application/xml")
        output application/json
        ---
        ContainsRequestedItem: myInput.root.*order.*items contains "3"
        ```

    2.  Preview the results:

        ```json
        {
          "ContainsRequestedItem": true
        }
        ```

        When you are ready, learn more about the [contains](https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-contains) function and
        about the built-in `payload` variable, in
        [Predefined Variables](https://docs.mulesoft.com/dataweave/2.11/dataweave-variables-context).

#### Run Examples with Longer Payloads

For DataWeave examples with many lines of sample data, consider creating a metadata type through
Transform Message. Metadata types can accept a local file that contains sample data.

1.  Use the [readUrl](#readurl_ex) example to create `src/main/resources/myJson.json` in Studio.

    You can skip this step if you still have the file in Studio. The next steps show how to use the
    contents of this file as your payload.

2.  Now replace the current script from the source code area of the Transform Message with one that
    selects the payload of the input:

    ```dw
    %dw 2.0
    output application/json
    ---
    payload
    ```

3.  Notice that you cannot preview a payload now because it does not exist yet.

    ![A DataWeave script that checks if a payload contains a specific item in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.11/_images/dw-tut-payload-example2.png)

4.  Now provide a simple JSON object as the payload of the Transform Message:

    1.  In the **Transform Message** tab, click the _left-most_ rectangle from the **Preview**
        button to open the columned, graphical view next to the source code area:

        ![A Transform Message component to define metadata in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.11/_images/studio-define-payload.png)

        If you mouse over that rectangle, you can see the label **Show Graphic**.

    2.  In the left-most column of the **Transform Message** tab, find **Payload: Unknown**, and
        click **Define metadata**.

        If you do not see the **Define metadata** link, simply right-click the **Payload:** entry in
        the left-most column, and then click **Set Metadata** to open the **Select metadata type**
        dialog.

5.  Now load the contents of `myJson.json` (created in the [readUrl](#readurl_ex) example) into the
    Transform Message component:

    1.  Click **+Add** to open the **Create new type** dialog.

    2.  In the dialog, provide the **Type id** `myJsonType`, and click **Create type**.

        ![A dialog for creating a new type](/mulesoft/current/en-us/dataweave/2.11/_images/studio-create-type.png)

    3.  Back in the **Select metadata type** dialog that opens, select **JSON** from the **Type**
        drop-down menu.

        ![A Select metadata type dialog to select Type](/mulesoft/current/en-us/dataweave/2.11/_images/studio_select_metadata_type.png)

    4.  Below the new type, change **Schema** to **Example** (as shown above).

    5.  Use the navigation button with the ellipsis (**…​**) to find
        `src/main/resources/myJson.json`, and click **Open**, which displays the structure of the
        file contents (`hello: _String_`) in the **Select metadata type** window.

    6.  Now click **Select** to load the contents of the file into the message payload.

    7.  Notice that the JSON object from `myJson.json` is now in the Preview pane.

        If necessary, you can click **Preview** to open the Preview pane.

    8.  Now click the _empty_ rectangle next to the **Preview** button to open the source code area,
        and change the body of the script to `payload.hello`, retaining the existing DataWeave
        header content.

        Notice that the Preview pane now contains only the value of the payload: `"world"`.

        Here is what this example looks like in Studio:

        ![A DataWeave script that outputs the word 'world' in JSON format in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.11/_images/dw-tut-world.png)

        Learn more about [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.11/dataweave-selectors) when you are ready.

## Next Steps

- To get started with Mule app development and data mapping through the Studio UI, see
  [Tutorial: Create a Mule app that uses the Database Connector and DataWeave](https://docs.mulesoft.com/mule-runtime/latest/mule-app-tutorial).

- Beyond the Transform Message component, many Mule connectors, modules, and Core components accept
  DataWeave selectors and short DataWeave expressions in their **fx** fields.

  To learn about the components, you can start from
  [Mule Components](https://docs.mulesoft.com/mule-runtime/latest/mule-components).

  To try out sample data in a running Mule app, without relying on external data sources, you can
  use these Core components with or without Transform Message:

  - [Set Payload](https://docs.mulesoft.com/mule-runtime/latest/set-payload-transformer-reference) to provide content
    for the payload of a Mule event.

  - [Set Variable](https://docs.mulesoft.com/mule-runtime/latest/variable-transformer-reference) to create content in a
    Mule event [variable](https://docs.mulesoft.com/mule-runtime/latest/about-mule-variables).

  - [Scheduler](https://docs.mulesoft.com/mule-runtime/latest/scheduler-concept) to trigger the regular generation of
    Mule events.

  - [Logger](https://docs.mulesoft.com/mule-runtime/latest/logger-component-reference) to view output and issues logged
    in the Studio console.

Here is an example that uses some of these components:

![A flow that outputs 'helloWorld' in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.11/_images/studio-hello-world.png)

- The **fx** value of Set Payload is set to `output application/json --- { hello : "world"}`.

- The **fx** value of the Logger is set to `payload`, which looks like `#[payload]` in the UI and
  the XML configuration file for the project.

- The **Console** tab of the _running_ Mule app (`testscript`) displays the payload from Set
  Payload.

<!-- document id=ba5ec90dfac695623f666de8e816a8870e5822d2f3cfcea74ce902fc5e0a561f url=/mulesoft/current/en-us/dataweave/2.12/dataweave-quickstart.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, transform, transformer, format, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# DataWeave Quickstart

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

In this guide, you run DataWeave 2.0 scripts on sample data, without relying on external data
sources.

The examples introduce some key DataWeave concepts that you can explore further whenever you are
ready, and they show how to turn the Transform Message component into a DataWeave playground.

To run the scripts, you copy them into the source code area of a Transform Message component in
[Studio](https://docs.mulesoft.com/studio/), then view the results in the component’s **Preview** pane. You also load
content from files so that your DataWeave script can act on it. Once you feel comfortable with
DataWeave examples here and elsewhere in the docs, you can use the DataWeave playground to practice
writing your own DataWeave scripts on sample data.

![A script in Anypoint Studio showing a basic JSON output](/mulesoft/current/en-us/dataweave/2.12/_images/dw-tut-script-studio-basic.png)

The figure shows a Transform Message component in the center canvas, within **testingscriptFlow**.
Below the Studio canvas, the **Transform Message** tab includes a DataWeave script in the source
code area with output in the **Preview** pane.

## Prerequisites

[Studio 7](https://docs.mulesoft.com/studio/to-download-and-install-studio) is required. Versions 7.3 or 7.2.3 are
recommended. Other Studio 7 versions are untested with this guide.

Once Studio is installed, you need to set up a project with a Transform Message component. See
[Set Up a Project in Studio](#setup).

## Set Up a Project in Studio

Set up a Mule project that serves as a DataWeave playground:

1.  In Studio, click **File** → **New** → **Mule Project** to create a Mule project.

2.  Provide the name `testscript` for the project, and click **Finish**.

3.  From the **Mule Palette** tab of your new project, click **Core**, and then drag the **Transform
    Message** component into the Studio canvas.

    ![A Transform Message component in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.12/_images/dw-tut-script-studio.png)

    (A) **Mule Palette** tab

    (B) Studio canvas with Transform Message component

    (C) **Transform Message** tab

4.  In the **Transform Message** tab, click **Preview** (on the far right) to open the Preview pane,
    and click the _empty_ rectangle next to **Preview** to expand the source code area.

    ![A Transform Message tab showing an output payload in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.12/_images/studio-transform-msg-tab.png)

    The source code area on the left is the place where you are going to add DataWeave scripts, and
    the Preview pane on the right is where you view the output of the scripts.

5.  Proceed to [Start Scripting](#start_scripting).

## Start Scripting

1.  [Concatenate Two Strings into a Single String](#step_1)

2.  [Transform JSON Input to XML Output](#step_2)

3.  [Learn About Supported Data Types](#step_3)

4.  [Define and Use a DataWeave Variable as Input](#step_4)

5.  [Use a DataWeave Function in a DataWeave Variable](#step_5)

6.  [Read, Transform, and Select Content from an Input](#step_6)

7.  [Read File Contents with a DataWeave Function](#step_7)

8.  [Map Elements from an Array into an Object](#step_8)

9.  [Pluck Values from an Object into an Array](#step_9)

10. [Map and Merge Fields](#step_10)

### Concatenate Two Strings into a Single String

Begin with a simple DataWeave script that concatenates two strings ("hello" and "World") together
into a single string ("helloWorld").

![A DataWeave script that outputs 'helloWorld' in JSON format](/mulesoft/current/en-us/dataweave/2.12/_images/dw-tut-helloWorld.png)

1.  Replace the current script in the source code area of the **Transform Message** tab with this
    one:

    ```dw
    %dw 2.0
    output application/json
    ---
    { myString: ("hello" ++ "World") }
    ```

    - The body of the DataWeave script contains a key-value pair
      (`{ myString: ("hello" ++ "World") }`). The value of this input object is a DataWeave
      expression (`("hello" ++ "World")`) for concatenating the strings "hello" and "World" into a
      single string, "helloWorld".

      When you are ready, you can learn about the DataWeave [++](https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-plusplus)
      function used to concatenate the strings.

    - The header of the script is all the content above the three dashes, `---`. It includes
      important directives, including one for specifying the output format `application/json`. You
      can learn more about [DataWeave Scripts](https://docs.mulesoft.com/dataweave/2.12/dataweave-language-introduction) when you are ready.

2.  See the JSON output in the **Preview** pane:

    ```json
    { "myString": "helloWorld" }
    ```

3.  Proceed to [Transform JSON Input to XML Output](#step_2).

### Transform JSON Input to XML Output

Many integrations require transformations from one format to another. This procedure uses the
`output` directive to produce XML output from JSON input.

![A DataWeave script that outputs 'helloWorld' in XML format](/mulesoft/current/en-us/dataweave/2.12/_images/dw-tut-helloWorld-xml.png)

1.  Replace the body of the current script in the source code area with JSON output from
    [Concatenate Two Strings into a Single String](#step_1), and change the
    `output application/json` directive to `output application/xml`:

    ```dw
    %dw 2.0
    output application/xml
    ---
    { "myString" : ("helloWorld") }
    ```

2.  See the XML output in the **Preview** pane:

    ```xml
    <?xml version='1.0' encoding='UTF-8'?>
    <myString>helloWorld</myString>
    ```

    Notice that the `"myString"` key of the input JSON object `{ "myString" : ("helloWorld") }` is
    converted to the root element of the XML output and that the concatenated string becomes the
    value of that XML object. So the XML output is `<myString>helloWorld</myString>`. That output is
    preceded by a standard XML declaration that specifies the XML version and encoding.

    > [!NOTE] Without a _single_ key to serve as a root node for XML output (for example, if the
    > input is simply `("helloWorld")`), the transformation to XML will fail with a yellow warning
    > (**!**) in the source code area. The warning message is
    > `Trying to output non-whitespace characters outside main element tree`. If you like, you can
    > try to produce this warning on your own.

    DataWeave supports many output and input formats. You can learn more about
    [Supported Data Formats](https://docs.mulesoft.com/dataweave/2.12/dataweave-formats) when you are ready.

3.  Proceed to [Learn About Supported Data Types](#step_3)

### Learn About Supported Data Types

Now provide a DataWeave script that simply introduces you to a variety of supported data types and
shows how to add comments to a script.

1.  Replace the current script in the source code area of the **Transform Message** tab with this
    one:

    ```dw
    %dw 2.0
    output application/json
    ---
    {
      /*
       * A multi-line
       * comment here.
       */
      myString: "hello world",
      myNumber: 123,
      myFloatingPointNumber: 123.456,
      myVeryBigNumber: 12341234134123412341234123,
      myDate: |2018-12-07|,
      myTime: |11:55:56|,
      myDateTime: |2018-10-01T23:57:59-03:00|,
      myBoolean: true,
      myArray: [ 1, 2, 3, 5, 8],
      myMixedArray: [ 1, 2, "blah", { hello: "there" } ],
      myObjectKeyValuePair: { innerKey: "innerValue" },
      myObjectWithConditionalField: { a : { b : 1, ( c : 2 ) if true, (d : 4) if false } },
      myNull: null,
      myBinary: "abcd1234123" as Binary
      //A one-line comment here.
    }
    ```

    DataWeave supports multi-line comments within `/* */` markup and single-line comments after
    forward slashes (`//`). It also supports many data types, shown after the colon (`:`) in
    key-value pairs, such as `myString: "hello world"` and `myNumber: 123`. These types include
    strings (surrounded by quotation marks, `""`), numbers, date and time structures (within pipes,
    `||`), Booleans (`true` and `false`), arrays (within square brackets, `[]`), JSON-like objects
    (key-value structures within curly braces, `{}`), `null`, and binaries. When you are ready for
    more on this topic, you can review [DataWeave types](https://docs.mulesoft.com/dataweave/2.12/dataweave-types).

2.  See the JSON output in the **Preview** pane:

    ```json
    {
      "myString": "hello world",
      "myNumber": 123,
      "myFloatingPointNumber": 123.456,
      "myVeryBigNumber": 12341234134123412341234123,
      "myDate": "2018-12-07",
      "myTime": "11:55:56",
      "myDateTime": "2018-10-01T23:57:59-03:00",
      "myBoolean": true,
      "myArray": [1, 2, 3, 5, 8],
      "myMixedArray": [1, 2, "blah", { "hello": "there" }],
      "myObjectKeyValuePair": { "innerKey": "innerValue" },
      "myObjectWithConditionalField": { "a": { "b": 1, "c": 2 } },
      "myNull": null,
      "myBinary": "abcd1234123"
    }
    ```

3.  Proceed to [Define and Use a DataWeave Variable as Input](#step_4)

### Define and Use a DataWeave Variable as Input

Now try a simple DataWeave script that outputs the value of the DataWeave variable `myJson`. You set
the variable using the `var` directive in the script’s header.

1.  Replace the current script in the source code area of the **Transform Message** tab with this
    one:

    ```dw
    %dw 2.0
    var myJson = { "hello" : "world" }
    output application/json
    ---
    myJson
    ```

    A JSON object (`{ "hello" : "world" }`) is defined as the `myJson` variable in the script’s
    header. You can learn more about [DataWeave Variables](https://docs.mulesoft.com/dataweave/2.12/dataweave-variables) when you are ready.

2.  See the output in the **Preview** pane:

    ```json
    {
      "hello": "world"
    }
    ```

3.  Proceed to [Use a DataWeave Function in a DataWeave Variable](#step_5)

### Use a DataWeave Function in a DataWeave Variable

Now try a script that uses the DataWeave `avg` function in a DataWeave variable (`myJson`) to get
averages of two sets of numbers.

![A DataWeave script using a variable in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.12/_images/dw-tut-script-studio-var.png)

1.  Replace the current script in the source code area with this one:

    ```dw
    %dw 2.0
    var myJson = {
      a: avg([1, 1000]),
      b: avg([1, 2, 3])
    }
    output application/json
    ---
    myJson
    ```

    The `avg` functions here get invoked when you add `myJson` to the body of the script, producing
    the calculated averages within the JSON object you can see in the **Preview** pane. The
    structures `[1, 1000]` and `[1, 2, 3]` are [arrays](https://docs.mulesoft.com/dataweave/2.12/dataweave-types#dw_type_array). You can
    learn more about [avg](https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-avg) when you are ready.

2.  Preview the output:

    ```json
    {
      "a": 500.5,
      "b": 2.0
    }
    ```

3.  Proceed to [Read, Transform, and Select Content from an Input](#step_6)

### Read, Transform, and Select Content from an Input

Now try a more complicated script that reads XML input, transforms it to JSON, and only selects the
contents of the `car` element.

1.  Replace the current script in the source code area with this one:

    ```dw
    %dw 2.0
    var myRead = read("<car><color>red</color></car>",
                    "application/xml")
    output application/json
    ---
    {
      mySelection : myRead.car
    }
    ```

    If you encounter an issue previewing this example, try changing `myRead.car` to `myRead."car"`.
    Learn more about the [read](https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-read) function,
    [Supported Data Formats](https://docs.mulesoft.com/dataweave/2.12/dataweave-formats), and [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.12/dataweave-selectors) when
    you are ready.

2.  Preview the output:

    ```json
    {
      "mySelection": {
        "color": "red"
      }
    }
    ```

3.  Proceed to [Read File Contents with a DataWeave Function](#step_7)

### Read File Contents with a DataWeave Function

Now use `readUrl` to read the contents of a file in the Studio `src/main/resources` folder so you
can use that content as sample data for a DataWeave script.

1.  Add a file by right-clicking the `src/main/resources` folder in the **Package Explorer** tab,
    then navigating to **New** → **File**, providing the file name `myJson.json` for that file, and
    clicking **Finish**.

2.  From `src/main/resources`, provide and save the following sample content in the **myJson.json**
    tab (or within the **Source** sub-tab of the **myJson.json** tab, if it is present):

    ```json
    {
      "hello": "world"
    }
    ```

    ![A Package Explorer tab showing a sample content in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.12/_images/dw-tut-sample-file.png)

    Figure 1. myJson.json in Studio

3.  Returning to the Transform Message component within the **testscript** tab, replace the current
    script with one that uses `readUrl` to read the JSON contents from your file:

    ```dw
    %dw 2.0
    output application/json
    ---
    readUrl("classpath://myJson.json", "application/json")
    ```

    Learn more about the [readUrl](https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-readurl) function when you are ready.

4.  View the matching output in the **Preview** pane.

    ```json
    {
      "hello": "world"
    }
    ```

    Note that you can also load the contents of a file through a metadata type in the Transform
    Message component. That procedure is covered later, in
    [Run Examples with Longer Payloads](#med_large_payload). It uses the `myJson.json` file you just
    created.

5.  Proceed to [Map Elements from an Array into an Object](#step_8)

### Map Elements from an Array into an Object

Almost all integrations require data mappings. Here, you map elements within an array to keys and
values of a JSON object:

1.  Replace the current script in the source code area with this one:

    ```dw
    %dw 2.0
    output application/json
    ---
    {
      (
        ["a", "b", "c"] map ((value, index) -> {
            (index): value
        })
      )
    }
    ```

    The `map` function iterates over the array on the left to apply the lambda (anonymous function)
    on the right (`((value, index) → { (index): value })`) to elements in that array. The lambda
    uses [named parameters](https://docs.mulesoft.com/dataweave/2.12/dataweave-functions-lambdas#_use_named_parameters_in_a_lambda) (`value`
    and `index`) to select the values and indices from the array and populate a JSON object with
    key-value pairs. Learn about [map](https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-map), and when you are ready, compare `map`
    with [mapObject](https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-mapobject), which takes an object as input.

2.  Preview the output:

    ```json
    {
      "0": "a",
      "1": "b",
      "2": "c"
    }
    ```

3.  Proceed to [Pluck Values from an Object into an Array](#step_9)

### Pluck Values from an Object into an Array

Now use the DataWeave `pluck` function to iterate over values in a JSON object and output those
values into an array.

1.  Replace the contents of the source code area with a script that uses `pluck` on a JSON object:

    ```dw
    %dw 2.0
    output application/json
    ---
    {
      "0": "a",
      "1": "b",
      "2": "c"
    } pluck ((value) -> value)
    ```

    Notice that the input object matches the [output](#output_map) of the `map` example and that the
    output array matches the [input](#input_map) from the `map` example. Learn more about
    [pluck](https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-pluck) when you are ready.

2.  Preview the output:

    ```json
    ["a", "b", "c"]
    ```

3.  Proceed to [Map and Merge Fields](#step_10).

### Map and Merge Fields

Now try a more complex example that maps and merges fields from items in separate arrays. The point
here is simply to provide a taste of DataWeave’s ability to handle more complex mappings and
transformations needed for some integrations.

1.  Replace the current script in the source code area with this one:

    ```dw
    %dw 2.0
    var myVar = [
      { bookId: 101,
        title: "world history",
        price: "19.99"
      },
      {
        bookId: 202,
        title: 'the great outdoors',
        price: "15.99"
      }
    ]
    var myVar2 = [
      {
        bookId: 101,
        author: "john doe"
      },
      {
        bookId: 202,
        author: "jane doe"
      }
    ]
    output application/json
    ---
    myVar map (item, index) -> using (id = item.bookId) {
    	"id" : id,
    	"topic" : item.title,
    	"cost" : item.price as Number,
    	(myVar2 filter ($.*bookId contains id) map (item) -> {
    		author : item.author
    	})
    }
    ```

    When you are ready to explore the language further, you can learn how the
    [filter](https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-filter) function used near the end returns `author` values from the
    array in the `myVar2` variable. You can read about
    [type coercion with DataWeave](https://docs.mulesoft.com/dataweave/2.12/dataweave-types-coercion) to see how `as` works with the data
    type in the line `"cost" : item.price as Number,` to coerce input strings like `"19.99"` into
    numbers like `19.99`. You can see how `using` (shown in `using (id = item.bookId)`) enables you
    to create [local DataWeave variables](https://docs.mulesoft.com/dataweave/2.12/dataweave-variables#example_local_variable) in a script.

2.  Preview the output:

    ```json
    [
      {
        "id": "101",
        "topic": "world history",
        "cost": 19.99,
        "author": "john doe"
      },
      {
        "id": "202",
        "topic": "the great outdoors",
        "cost": 15.99,
        "author": "jane doe"
      }
    ]
    ```

3.  Proceed to [Try Out More DataWeave Examples](#more_examples).

## Try Out More DataWeave Examples

Now you are ready to run DataWeave examples on your own. In your DataWeave playground, you can run
examples from the docs whenever you want to discover more about the DataWeave language. You can play
with the examples and use them to start your own scripts.

> [!NOTE] For examples that use `payload` to reference input data (such as the
> [contains](https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-contains#contains1) or [mapObject](https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-mapobject)
> function examples), you can avoid payload-related issues by using techniques described in
> [Run Examples that Act on a Payload](#provide_payload).

1.  Find many more examples to try out in Studio here:

    - [DataWeave Operators](https://docs.mulesoft.com/dataweave/2.12/dw-operators)

    - [DataWeave Reference](https://docs.mulesoft.com/dataweave/2.12/dw-functions): Docs on the DataWeave function modules provide many
      examples that use DataWeave functions.

    - [Flow Control in DataWeave](https://docs.mulesoft.com/dataweave/2.12/dataweave-flow-control)

    - [Pattern Matching in DataWeave](https://docs.mulesoft.com/dataweave/2.12/dataweave-pattern-matching)

    - [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook)

    - [Define DataWeave Functions](https://docs.mulesoft.com/dataweave/2.12/dataweave-functions)

2.  Proceed to [Next Steps](#next_steps).

### Run Examples that Act on a Payload

In DataWeave, `payload` is a built-in Mule Runtime variable that holds the contents of a
[Mule message](https://docs.mulesoft.com/mule-runtime/latest/about-mule-message#_message_payload). It enables you to
retrieve the body of a message simply by typing `payload` into the DataWeave script. The docs often
refer to this content as "the payload."

To try out DataWeave examples that use `payload` to get the contents of a Mule message, you have
some options:

- [Run Examples with Short Payloads](#small_payload): You can use a DataWeave variable.

- [Run Examples with Longer Payloads](#med_large_payload): Add the payload content through a file.
  This technique also works for short payloads.

Alternatives that require a running Mule app (such as using
[Set Payload](https://docs.mulesoft.com/mule-runtime/latest/set-payload-transformer-reference)) are not covered here but
are introduced in [Next Steps](#next_steps).

#### Run Examples with Short Payloads

For short examples with a few lines of sample data, you can convert the input payload to a variable.
You simply copy the payload’s content into a DataWeave variable (`var`) in the header of a DataWeave
script. Then, in the body of the script, you replace `payload` with the name of the new variable to
reference that variable.

1.  Start with this script in the source code area:

    ```DataWeave
    %dw 2.0
    output application/json
    ---
    ContainsRequestedItem: payload.root.*order.*items contains "3"
    ```

    Notice that you cannot preview it yet:

    ![A DataWeave script that checks if a payload contains a specific item in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.12/_images/dw-tut-payload-example.png)

2.  Now modify this example so that it uses some sample input instead of attempting to use `payload`
    to input content of a Mule message that does not exist:

    1.  Add a `myInput` DataWeave variable supplying some input data the script can read, and change
        the Mule `payload` variable in the body of the script to the DataWeave `myInput` variable.

        ```DataWeave
        %dw 2.0
        var myInput = read("<root>
            <order>
              <items>1</items>
              <items>3</items>
            </order>
            <order>
              <items>2</items>
            </order>
        </root>",
        "application/xml")
        output application/json
        ---
        ContainsRequestedItem: myInput.root.*order.*items contains "3"
        ```

    2.  Preview the results:

        ```json
        {
          "ContainsRequestedItem": true
        }
        ```

        When you are ready, learn more about the [contains](https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-contains) function and
        about the built-in `payload` variable, in
        [Predefined Variables](https://docs.mulesoft.com/dataweave/2.12/dataweave-variables-context).

#### Run Examples with Longer Payloads

For DataWeave examples with many lines of sample data, consider creating a metadata type through
Transform Message. Metadata types can accept a local file that contains sample data.

1.  Use the [readUrl](#readurl_ex) example to create `src/main/resources/myJson.json` in Studio.

    You can skip this step if you still have the file in Studio. The next steps show how to use the
    contents of this file as your payload.

2.  Now replace the current script from the source code area of the Transform Message with one that
    selects the payload of the input:

    ```dw
    %dw 2.0
    output application/json
    ---
    payload
    ```

3.  Notice that you cannot preview a payload now because it does not exist yet.

    ![A DataWeave script that checks if a payload contains a specific item in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.12/_images/dw-tut-payload-example2.png)

4.  Now provide a simple JSON object as the payload of the Transform Message:

    1.  In the **Transform Message** tab, click the _left-most_ rectangle from the **Preview**
        button to open the columned, graphical view next to the source code area:

        ![A Transform Message component to define metadata in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.12/_images/studio-define-payload.png)

        If you mouse over that rectangle, you can see the label **Show Graphic**.

    2.  In the left-most column of the **Transform Message** tab, find **Payload: Unknown**, and
        click **Define metadata**.

        If you do not see the **Define metadata** link, simply right-click the **Payload:** entry in
        the left-most column, and then click **Set Metadata** to open the **Select metadata type**
        dialog.

5.  Now load the contents of `myJson.json` (created in the [readUrl](#readurl_ex) example) into the
    Transform Message component:

    1.  Click **+Add** to open the **Create new type** dialog.

    2.  In the dialog, provide the **Type id** `myJsonType`, and click **Create type**.

        ![A dialog for creating a new type](/mulesoft/current/en-us/dataweave/2.12/_images/studio-create-type.png)

    3.  Back in the **Select metadata type** dialog that opens, select **JSON** from the **Type**
        drop-down menu.

        ![A Select metadata type dialog to select Type](/mulesoft/current/en-us/dataweave/2.12/_images/studio_select_metadata_type.png)

    4.  Below the new type, change **Schema** to **Example** (as shown above).

    5.  Use the navigation button with the ellipsis (**…​**) to find
        `src/main/resources/myJson.json`, and click **Open**, which displays the structure of the
        file contents (`hello: _String_`) in the **Select metadata type** window.

    6.  Now click **Select** to load the contents of the file into the message payload.

    7.  Notice that the JSON object from `myJson.json` is now in the Preview pane.

        If necessary, you can click **Preview** to open the Preview pane.

    8.  Now click the _empty_ rectangle next to the **Preview** button to open the source code area,
        and change the body of the script to `payload.hello`, retaining the existing DataWeave
        header content.

        Notice that the Preview pane now contains only the value of the payload: `"world"`.

        Here is what this example looks like in Studio:

        ![A DataWeave script that outputs the word 'world' in JSON format in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.12/_images/dw-tut-world.png)

        Learn more about [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.12/dataweave-selectors) when you are ready.

## Next Steps

- To get started with Mule app development and data mapping through the Studio UI, see
  [Tutorial: Create a Mule app that uses the Database Connector and DataWeave](https://docs.mulesoft.com/mule-runtime/latest/mule-app-tutorial).

- Beyond the Transform Message component, many Mule connectors, modules, and Core components accept
  DataWeave selectors and short DataWeave expressions in their **fx** fields.

  To learn about the components, you can start from
  [Mule Components](https://docs.mulesoft.com/mule-runtime/latest/mule-components).

  To try out sample data in a running Mule app, without relying on external data sources, you can
  use these Core components with or without Transform Message:

  - [Set Payload](https://docs.mulesoft.com/mule-runtime/latest/set-payload-transformer-reference) to provide content
    for the payload of a Mule event.

  - [Set Variable](https://docs.mulesoft.com/mule-runtime/latest/variable-transformer-reference) to create content in a
    Mule event [variable](https://docs.mulesoft.com/mule-runtime/latest/about-mule-variables).

  - [Scheduler](https://docs.mulesoft.com/mule-runtime/latest/scheduler-concept) to trigger the regular generation of
    Mule events.

  - [Logger](https://docs.mulesoft.com/mule-runtime/latest/logger-component-reference) to view output and issues logged
    in the Studio console.

Here is an example that uses some of these components:

![A flow that outputs 'helloWorld' in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.12/_images/studio-hello-world.png)

- The **fx** value of Set Payload is set to `output application/json --- { hello : "world"}`.

- The **fx** value of the Logger is set to `payload`, which looks like `#[payload]` in the UI and
  the XML configuration file for the project.

- The **Console** tab of the _running_ Mule app (`testscript`) displays the payload from Set
  Payload.

<!-- document id=e83df2411684e3aa155b89381ccf9d14c43376f39c8832bea08d9d5eb8ca2e55 url=/mulesoft/current/en-us/dataweave/2.3/dataweave-quickstart.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, transform, transformer, format, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# DataWeave Quickstart

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

In this guide, you run DataWeave version 2 scripts on sample data, without relying on external data
sources.

The examples introduce some key DataWeave concepts that you can explore further whenever you are
ready, and they show how to turn the Transform Message component into a DataWeave playground.

To run the scripts, you copy them into the source code area of a Transform Message component in
[Studio](https://docs.mulesoft.com/studio/), then view the results in the component’s **Preview** pane. You also load
content from files so that your DataWeave script can act on it. Once you feel comfortable with
DataWeave examples here and elsewhere in the docs, you can use the DataWeave playground to practice
writing your own DataWeave scripts on sample data.

![A script in Anypoint Studio showing a basic JSON output](/mulesoft/current/en-us/dataweave/2.3/_images/dw-tut-script-studio-basic.png)

The figure shows a Transform Message component in the center canvas, within **testingscriptFlow**.
Below the Studio canvas, the **Transform Message** tab includes a DataWeave script in the source
code area with output in the **Preview** pane.

## Prerequisites

[Studio 7](https://docs.mulesoft.com/studio/to-download-and-install-studio) is required. Versions 7.3 or 7.2.3 are
recommended. Other Studio 7 versions are untested with this guide.

Once Studio is installed, you need to set up a project with a Transform Message component. See
[Set Up a Project in Studio](#setup).

## Set Up a Project in Studio

Set up a Mule project that serves as a DataWeave playground:

1.  In Studio, click **File** → **New** → **Mule Project** to create a Mule project.

2.  Provide the name `testscript` for the project, and click **Finish**.

3.  From the **Mule Palette** tab of your new project, click **Core**, and then drag the **Transform
    Message** component into the Studio canvas.

    ![A Transform Message component in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.3/_images/dw-tut-script-studio.png)

    (A) **Mule Palette** tab

    (B) Studio canvas with Transform Message component

    (C) **Transform Message** tab

4.  In the **Transform Message** tab, click **Preview** (on the far right) to open the Preview pane,
    and click the _empty_ rectangle next to **Preview** to expand the source code area.

    ![A Transform Message tab showing an output payload in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.3/_images/studio-transform-msg-tab.png)

    The source code area on the left is the place where you are going to add DataWeave scripts, and
    the Preview pane on the right is where you view the output of the scripts.

5.  Proceed to [Start Scripting](#start_scripting).

## Start Scripting

1.  [Concatenate Two Strings into a Single String](#step_1)

2.  [Transform JSON Input to XML Output](#step_2)

3.  [Learn About Supported Data Types](#step_3)

4.  [Define and Use a DataWeave Variable as Input](#step_4)

5.  [Use a DataWeave Function in a DataWeave Variable](#step_5)

6.  [Read, Transform, and Select Content from an Input](#step_6)

7.  [Read File Contents with a DataWeave Function](#step_7)

8.  [Map Elements from an Array into an Object](#step_8)

9.  [Pluck Values from an Object into an Array](#step_9)

10. [Map and Merge Fields](#step_10)

### Concatenate Two Strings into a Single String

Begin with a simple DataWeave script that concatenates two strings ("hello" and "World") together
into a single string ("helloWorld").

![A DataWeave script that outputs 'helloWorld' in JSON format](/mulesoft/current/en-us/dataweave/2.3/_images/dw-tut-helloWorld.png)

1.  Replace the current script in the source code area of the **Transform Message** tab with this
    one:

    ```dw
    %dw 2.0
    output application/json
    ---
    { myString: ("hello" ++ "World") }
    ```

    - The body of the DataWeave script contains a key-value pair
      (`{ myString: ("hello" ++ "World") }`). The value of this input object is a DataWeave
      expression (`("hello" ++ "World")`) for concatenating the strings "hello" and "World" into a
      single string, "helloWorld".

      When you are ready, you can learn about the DataWeave [++](https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-plusplus)
      function used to concatenate the strings.

    - The header of the script is all the content above the three dashes, `---`. It includes
      important directives, including one for specifying the output format `application/json`. You
      can learn more about [DataWeave Scripts](https://docs.mulesoft.com/dataweave/2.3/dataweave-language-introduction) when you are ready.

2.  See the JSON output in the **Preview** pane:

    ```json
    { "myString": "helloWorld" }
    ```

3.  Proceed to [Transform JSON Input to XML Output](#step_2).

### Transform JSON Input to XML Output

Many integrations require transformations from one format to another. This procedure uses the
`output` directive to produce XML output from JSON input.

![A DataWeave script that outputs 'helloWorld' in XML format](/mulesoft/current/en-us/dataweave/2.3/_images/dw-tut-helloWorld-xml.png)

1.  Replace the body of the current script in the source code area with JSON output from
    [Concatenate Two Strings into a Single String](#step_1), and change the
    `output application/json` directive to `output application/xml`:

    ```dw
    %dw 2.0
    output application/xml
    ---
    { "myString" : ("helloWorld") }
    ```

2.  See the XML output in the **Preview** pane:

    ```xml
    <?xml version='1.0' encoding='UTF-8'?>
    <myString>helloWorld</myString>
    ```

    Notice that the `"myString"` key of the input JSON object `{ "myString" : ("helloWorld") }` is
    converted to the root element of the XML output and that the concatenated string becomes the
    value of that XML object. So the XML output is `<myString>helloWorld</myString>`. That output is
    preceded by a standard XML declaration that specifies the XML version and encoding.

    > [!NOTE] Without a _single_ key to serve as a root node for XML output (for example, if the
    > input is simply `("helloWorld")`), the transformation to XML will fail with a yellow warning
    > (**!**) in the source code area. The warning message is
    > `Trying to output non-whitespace characters outside main element tree`. If you like, you can
    > try to produce this warning on your own.

    DataWeave supports many output and input formats. You can learn more about
    [Supported Data Formats](https://docs.mulesoft.com/dataweave/2.3/dataweave-formats) when you are ready.

3.  Proceed to [Learn About Supported Data Types](#step_3)

### Learn About Supported Data Types

Now provide a DataWeave script that simply introduces you to a variety of supported data types and
shows how to add comments to a script.

1.  Replace the current script in the source code area of the **Transform Message** tab with this
    one:

    ```dw
    %dw 2.0
    output application/json
    ---
    {
      /*
       * A multi-line
       * comment here.
       */
      myString: "hello world",
      myNumber: 123,
      myFloatingPointNumber: 123.456,
      myVeryBigNumber: 12341234134123412341234123,
      myDate: |2018-12-07|,
      myTime: |11:55:56|,
      myDateTime: |2018-10-01T23:57:59-03:00|,
      myBoolean: true,
      myArray: [ 1, 2, 3, 5, 8],
      myMixedArray: [ 1, 2, "blah", { hello: "there" } ],
      myObjectKeyValuePair: { innerKey: "innerValue" },
      myObjectWithConditionalField: { a : { b : 1, ( c : 2 ) if true, (d : 4) if false } },
      myNull: null,
      myBinary: "abcd1234123" as Binary
      //A one-line comment here.
    }
    ```

    DataWeave supports multi-line comments within `/* */` markup and single-line comments after
    forward slashes (`//`). It also supports many data types, shown after the colon (`:`) in
    key-value pairs, such as `myString: "hello world"` and `myNumber: 123`. These types include
    strings (surrounded by quotation marks, `""`), numbers, date and time structures (within pipes,
    `||`), Booleans (`true` and `false`), arrays (within square brackets, `[]`), JSON-like objects
    (key-value structures within curly braces, `{}`), `null`, and binaries. When you are ready for
    more on this topic, you can review [DataWeave types](https://docs.mulesoft.com/dataweave/2.3/dataweave-types).

2.  See the JSON output in the **Preview** pane:

    ```json
    {
      "myString": "hello world",
      "myNumber": 123,
      "myFloatingPointNumber": 123.456,
      "myVeryBigNumber": 12341234134123412341234123,
      "myDate": "2018-12-07",
      "myTime": "11:55:56",
      "myDateTime": "2018-10-01T23:57:59-03:00",
      "myBoolean": true,
      "myArray": [1, 2, 3, 5, 8],
      "myMixedArray": [1, 2, "blah", { "hello": "there" }],
      "myObjectKeyValuePair": { "innerKey": "innerValue" },
      "myObjectWithConditionalField": { "a": { "b": 1, "c": 2 } },
      "myNull": null,
      "myBinary": "abcd1234123"
    }
    ```

3.  Proceed to [Define and Use a DataWeave Variable as Input](#step_4)

### Define and Use a DataWeave Variable as Input

Now try a simple DataWeave script that outputs the value of the DataWeave variable `myJson`. You set
the variable using the `var` directive in the script’s header.

1.  Replace the current script in the source code area of the **Transform Message** tab with this
    one:

    ```dw
    %dw 2.0
    var myJson = { "hello" : "world" }
    output application/json
    ---
    myJson
    ```

    A JSON object (`{ "hello" : "world" }`) is defined as the `myJson` variable in the script’s
    header. You can learn more about [DataWeave Variables](https://docs.mulesoft.com/dataweave/2.3/dataweave-variables) when you are ready.

2.  See the output in the **Preview** pane:

    ```json
    {
      "hello": "world"
    }
    ```

3.  Proceed to [Use a DataWeave Function in a DataWeave Variable](#step_5)

### Use a DataWeave Function in a DataWeave Variable

Now try a script that uses the DataWeave `avg` function in a DataWeave variable (`myJson`) to get
averages of two sets of numbers.

![A DataWeave script using a variable in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.3/_images/dw-tut-script-studio-var.png)

1.  Replace the current script in the source code area with this one:

    ```dw
    %dw 2.0
    var myJson = {
      a: avg([1, 1000]),
      b: avg([1, 2, 3])
    }
    output application/json
    ---
    myJson
    ```

    The `avg` functions here get invoked when you add `myJson` to the body of the script, producing
    the calculated averages within the JSON object you can see in the **Preview** pane. The
    structures `[1, 1000]` and `[1, 2, 3]` are [arrays](https://docs.mulesoft.com/dataweave/2.3/dataweave-types#dw_type_array). You can
    learn more about [avg](https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-avg) when you are ready.

2.  Preview the output:

    ```json
    {
      "a": 500.5,
      "b": 2.0
    }
    ```

3.  Proceed to [Read, Transform, and Select Content from an Input](#step_6)

### Read, Transform, and Select Content from an Input

Now try a more complicated script that reads XML input, transforms it to JSON, and only selects the
contents of the `car` element.

1.  Replace the current script in the source code area with this one:

    ```dw
    %dw 2.0
    var myRead = read("<car><color>red</color></car>",
                    "application/xml")
    output application/json
    ---
    {
      mySelection : myRead.car
    }
    ```

    If you encounter an issue previewing this example, try changing `myRead.car` to `myRead."car"`.
    Learn more about the [read](https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-read) function,
    [Supported Data Formats](https://docs.mulesoft.com/dataweave/2.3/dataweave-formats), and [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.3/dataweave-selectors) when
    you are ready.

2.  Preview the output:

    ```json
    {
      "mySelection": {
        "color": "red"
      }
    }
    ```

3.  Proceed to [Read File Contents with a DataWeave Function](#step_7)

### Read File Contents with a DataWeave Function

Now use `readUrl` to read the contents of a file in the Studio `src/main/resources` folder so you
can use that content as sample data for a DataWeave script.

1.  Add a file by right-clicking the `src/main/resources` folder in the **Package Explorer** tab,
    then navigating to **New** → **File**, providing the file name `myJson.json` for that file, and
    clicking **Finish**.

2.  From `src/main/resources`, provide and save the following sample content in the **myJson.json**
    tab (or within the **Source** sub-tab of the **myJson.json** tab, if it is present):

    ```json
    {
      "hello": "world"
    }
    ```

    ![A Package Explorer tab showing a sample content in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.3/_images/dw-tut-sample-file.png)

    Figure 1. myJson.json in Studio

3.  Returning to the Transform Message component within the **testscript** tab, replace the current
    script with one that uses `readUrl` to read the JSON contents from your file:

    ```dw
    %dw 2.0
    output application/json
    ---
    readUrl("classpath://myJson.json", "application/json")
    ```

    Learn more about the [readUrl](https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-readurl) function when you are ready.

4.  View the matching output in the **Preview** pane.

    ```json
    {
      "hello": "world"
    }
    ```

    Note that you can also load the contents of a file through a metadata type in the Transform
    Message component. That procedure is covered later, in
    [Run Examples with Longer Payloads](#med_large_payload). It uses the `myJson.json` file you just
    created.

5.  Proceed to [Map Elements from an Array into an Object](#step_8)

### Map Elements from an Array into an Object

Almost all integrations require data mappings. Here, you map elements within an array to keys and
values of a JSON object:

1.  Replace the current script in the source code area with this one:

    ```dw
    %dw 2.0
    output application/json
    ---
    {
      (
        ["a", "b", "c"] map ((value, index) -> {
            (index): value
        })
      )
    }
    ```

    The `map` function iterates over the array on the left to apply the lambda (anonymous function)
    on the right (`((value, index) → { (index): value })`) to elements in that array. The lambda
    uses [named parameters](https://docs.mulesoft.com/dataweave/2.3/dataweave-functions-lambdas#_use_named_parameters_in_a_lambda) (`value`
    and `index`) to select the values and indices from the array and populate a JSON object with
    key-value pairs. Learn about [map](https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-map), and when you are ready, compare `map`
    with [mapObject](https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-mapobject), which takes an object as input.

2.  Preview the output:

    ```json
    {
      "0": "a",
      "1": "b",
      "2": "c"
    }
    ```

3.  Proceed to [Pluck Values from an Object into an Array](#step_9)

### Pluck Values from an Object into an Array

Now use the DataWeave `pluck` function to iterate over values in a JSON object and output those
values into an array.

1.  Replace the contents of the source code area with a script that uses `pluck` on a JSON object:

    ```dw
    %dw 2.0
    output application/json
    ---
    {
      "0": "a",
      "1": "b",
      "2": "c"
    } pluck ((value) -> value)
    ```

    Notice that the input object matches the [output](#output_map) of the `map` example and that the
    output array matches the [input](#input_map) from the `map` example. Learn more about
    [pluck](https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-pluck) when you are ready.

2.  Preview the output:

    ```json
    ["a", "b", "c"]
    ```

3.  Proceed to [Map and Merge Fields](#step_10).

### Map and Merge Fields

Now try a more complex example that maps and merges fields from items in separate arrays. The point
here is simply to provide a taste of DataWeave’s ability to handle more complex mappings and
transformations needed for some integrations.

1.  Replace the current script in the source code area with this one:

    ```dw
    %dw 2.0
    var myVar = [
      { bookId: 101,
        title: "world history",
        price: "19.99"
      },
      {
        bookId: 202,
        title: 'the great outdoors',
        price: "15.99"
      }
    ]
    var myVar2 = [
      {
        bookId: 101,
        author: "john doe"
      },
      {
        bookId: 202,
        author: "jane doe"
      }
    ]
    output application/json
    ---
    myVar map (item, index) -> using (id = item.bookId) {
    	"id" : id,
    	"topic" : item.title,
    	"cost" : item.price as Number,
    	(myVar2 filter ($.*bookId contains id) map (item) -> {
    		author : item.author
    	})
    }
    ```

    When you are ready to explore the language further, you can learn how the
    [filter](https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-filter) function used near the end returns `author` values from the
    array in the `myVar2` variable. You can read about
    [type coercion with DataWeave](https://docs.mulesoft.com/dataweave/2.3/dataweave-types-coercion) to see how `as` works with the data
    type in the line `"cost" : item.price as Number,` to coerce input strings like `"19.99"` into
    numbers like `19.99`. You can see how `using` (shown in `using (id = item.bookId)`) enables you
    to create [local DataWeave variables](https://docs.mulesoft.com/dataweave/2.3/dataweave-variables#example_local_variable) in a script.

2.  Preview the output:

    ```json
    [
      {
        "id": "101",
        "topic": "world history",
        "cost": 19.99,
        "author": "john doe"
      },
      {
        "id": "202",
        "topic": "the great outdoors",
        "cost": 15.99,
        "author": "jane doe"
      }
    ]
    ```

3.  Proceed to [Try Out More DataWeave Examples](#more_examples).

## Try Out More DataWeave Examples

Now you are ready to run DataWeave examples on your own. In your DataWeave playground, you can run
examples from the docs whenever you want to discover more about the DataWeave language. You can play
with the examples and use them to start your own scripts.

> [!NOTE] For examples that use `payload` to reference input data (such as the
> [contains](https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-contains#contains1) or [mapObject](https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-mapobject)
> function examples), you can avoid payload-related issues by using techniques described in
> [Run Examples that Act on a Payload](#provide_payload).

1.  Find many more examples to try out in Studio here:

    - [DataWeave Operators](https://docs.mulesoft.com/dataweave/2.3/dw-operators)

    - [DataWeave Reference](https://docs.mulesoft.com/dataweave/2.3/dw-functions): Docs on the DataWeave function modules provide many
      examples that use DataWeave functions.

    - [Flow Control in DataWeave](https://docs.mulesoft.com/dataweave/2.3/dataweave-flow-control)

    - [Pattern Matching in DataWeave](https://docs.mulesoft.com/dataweave/2.3/dataweave-pattern-matching)

    - [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook)

    - [Define DataWeave Functions](https://docs.mulesoft.com/dataweave/2.3/dataweave-functions)

2.  Proceed to [Next Steps](#next_steps).

### Run Examples that Act on a Payload

In DataWeave, `payload` is a built-in Mule Runtime variable that holds the contents of a
[Mule message](https://docs.mulesoft.com/mule-runtime/4.3/about-mule-message#_message_payload). It enables you to
retrieve the body of a message simply by typing `payload` into the DataWeave script. The docs often
refer to this content as "the payload."

To try out DataWeave examples that use `payload` to get the contents of a Mule message, you have
some options:

- [Run Examples with Short Payloads](#small_payload): You can use a DataWeave variable.

- [Run Examples with Longer Payloads](#med_large_payload): Add the payload content through a file.
  This technique also works for short payloads.

Alternatives that require a running Mule app (such as using
[Set Payload](https://docs.mulesoft.com/mule-runtime/4.3/set-payload-transformer-reference)) are not covered here but
are introduced in [Next Steps](#next_steps).

#### Run Examples with Short Payloads

For short examples with a few lines of sample data, you can convert the input payload to a variable.
You simply copy the payload’s content into a DataWeave variable (`var`) in the header of a DataWeave
script. Then, in the body of the script, you replace `payload` with the name of the new variable to
reference that variable.

1.  Start with this script in the source code area:

    ```DataWeave
    %dw 2.0
    output application/json
    ---
    ContainsRequestedItem: payload.root.*order.*items contains "3"
    ```

    Notice that you cannot preview it yet:

    ![A DataWeave script that checks if a payload contains a specific item in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.3/_images/dw-tut-payload-example.png)

2.  Now modify this example so that it uses some sample input instead of attempting to use `payload`
    to input content of a Mule message that does not exist:

    1.  Add a `myInput` DataWeave variable supplying some input data the script can read, and change
        the Mule `payload` variable in the body of the script to the DataWeave `myInput` variable.

        ```DataWeave
        %dw 2.0
        var myInput = read("<root>
            <order>
              <items>1</items>
              <items>3</items>
            </order>
            <order>
              <items>2</items>
            </order>
        </root>",
        "application/xml")
        output application/json
        ---
        ContainsRequestedItem: myInput.root.*order.*items contains "3"
        ```

    2.  Preview the results:

        ```json
        {
          "ContainsRequestedItem": true
        }
        ```

        When you are ready, learn more about the [contains](https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-contains) function and
        about the built-in `payload` variable, in
        [Predefined Variables](https://docs.mulesoft.com/dataweave/2.3/dataweave-variables-context).

#### Run Examples with Longer Payloads

For DataWeave examples with many lines of sample data, consider creating a metadata type through
Transform Message. Metadata types can accept a local file that contains sample data.

1.  Use the [readUrl](#readurl_ex) example to create `src/main/resources/myJson.json` in Studio.

    You can skip this step if you still have the file in Studio. The next steps show how to use the
    contents of this file as your payload.

2.  Now replace the current script from the source code area of the Transform Message with one that
    selects the payload of the input:

    ```dw
    %dw 2.0
    output application/json
    ---
    payload
    ```

3.  Notice that you cannot preview a payload now because it does not exist yet.

    ![A DataWeave script that checks if a payload contains a specific item in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.3/_images/dw-tut-payload-example2.png)

4.  Now provide a simple JSON object as the payload of the Transform Message:

    1.  In the **Transform Message** tab, click the _left-most_ rectangle from the **Preview**
        button to open the columned, graphical view next to the source code area:

        ![A Transform Message component to define metadata in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.3/_images/studio-define-payload.png)

        If you mouse over that rectangle, you can see the label **Show Graphic**.

    2.  In the left-most column of the **Transform Message** tab, find **Payload: Unknown**, and
        click **Define metadata**.

        If you do not see the **Define metadata** link, simply right-click the **Payload:** entry in
        the left-most column, and then click **Set Metadata** to open the **Select metadata type**
        dialog.

5.  Now load the contents of `myJson.json` (created in the [readUrl](#readurl_ex) example) into the
    Transform Message component:

    1.  Click **+Add** to open the **Create new type** dialog.

    2.  In the dialog, provide the **Type id** `myJsonType`, and click **Create type**.

        ![A dialog for creating a new type](/mulesoft/current/en-us/dataweave/2.3/_images/studio-create-type.png)

    3.  Back in the **Select metadata type** dialog that opens, select **JSON** from the **Type**
        drop-down menu.

        ![A Select metadata type dialog to select Type](/mulesoft/current/en-us/dataweave/2.3/_images/studio_select_metadata_type.png)

    4.  Below the new type, change **Schema** to **Example** (as shown above).

    5.  Use the navigation button with the ellipsis (**…​**) to find
        `src/main/resources/myJson.json`, and click **Open**, which displays the structure of the
        file contents (`hello: _String_`) in the **Select metadata type** window.

    6.  Now click **Select** to load the contents of the file into the message payload.

    7.  Notice that the JSON object from `myJson.json` is now in the Preview pane.

        If necessary, you can click **Preview** to open the Preview pane.

    8.  Now click the _empty_ rectangle next to the **Preview** button to open the source code area,
        and change the body of the script to `payload.hello`, retaining the existing DataWeave
        header content.

        Notice that the Preview pane now contains only the value of the payload: `"world"`.

        Here is what this example looks like in Studio:

        ![A DataWeave script that outputs the word 'world' in JSON format in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.3/_images/dw-tut-world.png)

        Learn more about [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.3/dataweave-selectors) when you are ready.

## Next Steps

- To get started with Mule app development and data mapping through the Studio UI, see
  [Tutorial: Create a Mule app that uses the Database Connector and DataWeave](https://docs.mulesoft.com/mule-runtime/4.3/mule-app-tutorial).

- Beyond the Transform Message component, many Mule connectors, modules, and Core components accept
  DataWeave selectors and short DataWeave expressions in their **fx** fields.

  To learn about the components, you can start from
  [Mule Components](https://docs.mulesoft.com/mule-runtime/4.3/mule-components).

  To try out sample data in a running Mule app, without relying on external data sources, you can
  use these Core components with or without Transform Message:

  - [Set Payload](https://docs.mulesoft.com/mule-runtime/4.3/set-payload-transformer-reference) to provide content for
    the payload of a Mule event.

  - [Set Variable](https://docs.mulesoft.com/mule-runtime/4.3/variable-transformer-reference) to create content in a
    Mule event [variable](https://docs.mulesoft.com/mule-runtime/4.3/about-mule-variables).

  - [Scheduler](https://docs.mulesoft.com/mule-runtime/4.3/scheduler-concept) to trigger the regular generation of Mule
    events.

  - [Logger](https://docs.mulesoft.com/mule-runtime/4.3/logger-component-reference) to view output and issues logged in
    the Studio console.

Here is an example that uses some of these components:

![A flow that outputs 'helloWorld' in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.3/_images/studio-hello-world.png)

- The **fx** value of Set Payload is set to `output application/json --- { hello : "world"}`.

- The **fx** value of the Logger is set to `payload`, which looks like `#[payload]` in the UI and
  the XML configuration file for the project.

- The **Console** tab of the _running_ Mule app (`testscript`) displays the payload from Set
  Payload.

<!-- document id=fc949c13e55c26e470daa12a93bd21b4a58572c8ab95ea30adf1371bc88b1072 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-quickstart.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, transform, transformer, format, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# DataWeave Quickstart

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

In this guide, you run DataWeave 2.0 scripts on sample data, without relying on external data
sources.

The examples introduce some key DataWeave concepts that you can explore further whenever you are
ready, and they show how to turn the Transform Message component into a DataWeave playground.

To run the scripts, you copy them into the source code area of a Transform Message component in
[Studio](https://docs.mulesoft.com/studio/), then view the results in the component’s **Preview** pane. You also load
content from files so that your DataWeave script can act on it. Once you feel comfortable with
DataWeave examples here and elsewhere in the docs, you can use the DataWeave playground to practice
writing your own DataWeave scripts on sample data.

![A script in Anypoint Studio showing a basic JSON output](/mulesoft/current/en-us/dataweave/2.4/_images/dw-tut-script-studio-basic.png)

The figure shows a Transform Message component in the center canvas, within **testingscriptFlow**.
Below the Studio canvas, the **Transform Message** tab includes a DataWeave script in the source
code area with output in the **Preview** pane.

## Prerequisites

[Studio 7](https://docs.mulesoft.com/studio/to-download-and-install-studio) is required. Versions 7.3 or 7.2.3 are
recommended. Other Studio 7 versions are untested with this guide.

Once Studio is installed, you need to set up a project with a Transform Message component. See
[Set Up a Project in Studio](#setup).

## Set Up a Project in Studio

Set up a Mule project that serves as a DataWeave playground:

1.  In Studio, click **File** → **New** → **Mule Project** to create a Mule project.

2.  Provide the name `testscript` for the project, and click **Finish**.

3.  From the **Mule Palette** tab of your new project, click **Core**, and then drag the **Transform
    Message** component into the Studio canvas.

    ![A Transform Message component in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.4/_images/dw-tut-script-studio.png)

    (A) **Mule Palette** tab

    (B) Studio canvas with Transform Message component

    (C) **Transform Message** tab

4.  In the **Transform Message** tab, click **Preview** (on the far right) to open the Preview pane,
    and click the _empty_ rectangle next to **Preview** to expand the source code area.

    ![A Transform Message tab showing an output payload in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.4/_images/studio-transform-msg-tab.png)

    The source code area on the left is the place where you are going to add DataWeave scripts, and
    the Preview pane on the right is where you view the output of the scripts.

5.  Proceed to [Start Scripting](#start_scripting).

## Start Scripting

1.  [Concatenate Two Strings into a Single String](#step_1)

2.  [Transform JSON Input to XML Output](#step_2)

3.  [Learn About Supported Data Types](#step_3)

4.  [Define and Use a DataWeave Variable as Input](#step_4)

5.  [Use a DataWeave Function in a DataWeave Variable](#step_5)

6.  [Read, Transform, and Select Content from an Input](#step_6)

7.  [Read File Contents with a DataWeave Function](#step_7)

8.  [Map Elements from an Array into an Object](#step_8)

9.  [Pluck Values from an Object into an Array](#step_9)

10. [Map and Merge Fields](#step_10)

### Concatenate Two Strings into a Single String

Begin with a simple DataWeave script that concatenates two strings ("hello" and "World") together
into a single string ("helloWorld").

![A DataWeave script that outputs 'helloWorld' in JSON format](/mulesoft/current/en-us/dataweave/2.4/_images/dw-tut-helloWorld.png)

1.  Replace the current script in the source code area of the **Transform Message** tab with this
    one:

    ```dw
    %dw 2.0
    output application/json
    ---
    { myString: ("hello" ++ "World") }
    ```

    - The body of the DataWeave script contains a key-value pair
      (`{ myString: ("hello" ++ "World") }`). The value of this input object is a DataWeave
      expression (`("hello" ++ "World")`) for concatenating the strings "hello" and "World" into a
      single string, "helloWorld".

      When you are ready, you can learn about the DataWeave [++](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-plusplus)
      function used to concatenate the strings.

    - The header of the script is all the content above the three dashes, `---`. It includes
      important directives, including one for specifying the output format `application/json`. You
      can learn more about [DataWeave Scripts](https://docs.mulesoft.com/dataweave/2.4/dataweave-language-introduction) when you are ready.

2.  See the JSON output in the **Preview** pane:

    ```json
    { "myString": "helloWorld" }
    ```

3.  Proceed to [Transform JSON Input to XML Output](#step_2).

### Transform JSON Input to XML Output

Many integrations require transformations from one format to another. This procedure uses the
`output` directive to produce XML output from JSON input.

![A DataWeave script that outputs 'helloWorld' in XML format](/mulesoft/current/en-us/dataweave/2.4/_images/dw-tut-helloWorld-xml.png)

1.  Replace the body of the current script in the source code area with JSON output from
    [Concatenate Two Strings into a Single String](#step_1), and change the
    `output application/json` directive to `output application/xml`:

    ```dw
    %dw 2.0
    output application/xml
    ---
    { "myString" : ("helloWorld") }
    ```

2.  See the XML output in the **Preview** pane:

    ```xml
    <?xml version='1.0' encoding='UTF-8'?>
    <myString>helloWorld</myString>
    ```

    Notice that the `"myString"` key of the input JSON object `{ "myString" : ("helloWorld") }` is
    converted to the root element of the XML output and that the concatenated string becomes the
    value of that XML object. So the XML output is `<myString>helloWorld</myString>`. That output is
    preceded by a standard XML declaration that specifies the XML version and encoding.

    > [!NOTE] Without a _single_ key to serve as a root node for XML output (for example, if the
    > input is simply `("helloWorld")`), the transformation to XML will fail with a yellow warning
    > (**!**) in the source code area. The warning message is
    > `Trying to output non-whitespace characters outside main element tree`. If you like, you can
    > try to produce this warning on your own.

    DataWeave supports many output and input formats. You can learn more about
    [Supported Data Formats](https://docs.mulesoft.com/dataweave/2.4/dataweave-formats) when you are ready.

3.  Proceed to [Learn About Supported Data Types](#step_3)

### Learn About Supported Data Types

Now provide a DataWeave script that simply introduces you to a variety of supported data types and
shows how to add comments to a script.

1.  Replace the current script in the source code area of the **Transform Message** tab with this
    one:

    ```dw
    %dw 2.0
    output application/json
    ---
    {
      /*
       * A multi-line
       * comment here.
       */
      myString: "hello world",
      myNumber: 123,
      myFloatingPointNumber: 123.456,
      myVeryBigNumber: 12341234134123412341234123,
      myDate: |2018-12-07|,
      myTime: |11:55:56|,
      myDateTime: |2018-10-01T23:57:59-03:00|,
      myBoolean: true,
      myArray: [ 1, 2, 3, 5, 8],
      myMixedArray: [ 1, 2, "blah", { hello: "there" } ],
      myObjectKeyValuePair: { innerKey: "innerValue" },
      myObjectWithConditionalField: { a : { b : 1, ( c : 2 ) if true, (d : 4) if false } },
      myNull: null,
      myBinary: "abcd1234123" as Binary
      //A one-line comment here.
    }
    ```

    DataWeave supports multi-line comments within `/* */` markup and single-line comments after
    forward slashes (`//`). It also supports many data types, shown after the colon (`:`) in
    key-value pairs, such as `myString: "hello world"` and `myNumber: 123`. These types include
    strings (surrounded by quotation marks, `""`), numbers, date and time structures (within pipes,
    `||`), Booleans (`true` and `false`), arrays (within square brackets, `[]`), JSON-like objects
    (key-value structures within curly braces, `{}`), `null`, and binaries. When you are ready for
    more on this topic, you can review [DataWeave types](https://docs.mulesoft.com/dataweave/2.4/dataweave-types).

2.  See the JSON output in the **Preview** pane:

    ```json
    {
      "myString": "hello world",
      "myNumber": 123,
      "myFloatingPointNumber": 123.456,
      "myVeryBigNumber": 12341234134123412341234123,
      "myDate": "2018-12-07",
      "myTime": "11:55:56",
      "myDateTime": "2018-10-01T23:57:59-03:00",
      "myBoolean": true,
      "myArray": [1, 2, 3, 5, 8],
      "myMixedArray": [1, 2, "blah", { "hello": "there" }],
      "myObjectKeyValuePair": { "innerKey": "innerValue" },
      "myObjectWithConditionalField": { "a": { "b": 1, "c": 2 } },
      "myNull": null,
      "myBinary": "abcd1234123"
    }
    ```

3.  Proceed to [Define and Use a DataWeave Variable as Input](#step_4)

### Define and Use a DataWeave Variable as Input

Now try a simple DataWeave script that outputs the value of the DataWeave variable `myJson`. You set
the variable using the `var` directive in the script’s header.

1.  Replace the current script in the source code area of the **Transform Message** tab with this
    one:

    ```dw
    %dw 2.0
    var myJson = { "hello" : "world" }
    output application/json
    ---
    myJson
    ```

    A JSON object (`{ "hello" : "world" }`) is defined as the `myJson` variable in the script’s
    header. You can learn more about [DataWeave Variables](https://docs.mulesoft.com/dataweave/2.4/dataweave-variables) when you are ready.

2.  See the output in the **Preview** pane:

    ```json
    {
      "hello": "world"
    }
    ```

3.  Proceed to [Use a DataWeave Function in a DataWeave Variable](#step_5)

### Use a DataWeave Function in a DataWeave Variable

Now try a script that uses the DataWeave `avg` function in a DataWeave variable (`myJson`) to get
averages of two sets of numbers.

![A DataWeave script using a variable in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.4/_images/dw-tut-script-studio-var.png)

1.  Replace the current script in the source code area with this one:

    ```dw
    %dw 2.0
    var myJson = {
      a: avg([1, 1000]),
      b: avg([1, 2, 3])
    }
    output application/json
    ---
    myJson
    ```

    The `avg` functions here get invoked when you add `myJson` to the body of the script, producing
    the calculated averages within the JSON object you can see in the **Preview** pane. The
    structures `[1, 1000]` and `[1, 2, 3]` are [arrays](https://docs.mulesoft.com/dataweave/2.4/dataweave-types#dw_type_array). You can
    learn more about [avg](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-avg) when you are ready.

2.  Preview the output:

    ```json
    {
      "a": 500.5,
      "b": 2.0
    }
    ```

3.  Proceed to [Read, Transform, and Select Content from an Input](#step_6)

### Read, Transform, and Select Content from an Input

Now try a more complicated script that reads XML input, transforms it to JSON, and only selects the
contents of the `car` element.

1.  Replace the current script in the source code area with this one:

    ```dw
    %dw 2.0
    var myRead = read("<car><color>red</color></car>",
                    "application/xml")
    output application/json
    ---
    {
      mySelection : myRead.car
    }
    ```

    If you encounter an issue previewing this example, try changing `myRead.car` to `myRead."car"`.
    Learn more about the [read](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-read) function,
    [Supported Data Formats](https://docs.mulesoft.com/dataweave/2.4/dataweave-formats), and [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.4/dataweave-selectors) when
    you are ready.

2.  Preview the output:

    ```json
    {
      "mySelection": {
        "color": "red"
      }
    }
    ```

3.  Proceed to [Read File Contents with a DataWeave Function](#step_7)

### Read File Contents with a DataWeave Function

Now use `readUrl` to read the contents of a file in the Studio `src/main/resources` folder so you
can use that content as sample data for a DataWeave script.

1.  Add a file by right-clicking the `src/main/resources` folder in the **Package Explorer** tab,
    then navigating to **New** → **File**, providing the file name `myJson.json` for that file, and
    clicking **Finish**.

2.  From `src/main/resources`, provide and save the following sample content in the **myJson.json**
    tab (or within the **Source** sub-tab of the **myJson.json** tab, if it is present):

    ```json
    {
      "hello": "world"
    }
    ```

    ![A Package Explorer tab showing a sample content in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.4/_images/dw-tut-sample-file.png)

    Figure 1. myJson.json in Studio

3.  Returning to the Transform Message component within the **testscript** tab, replace the current
    script with one that uses `readUrl` to read the JSON contents from your file:

    ```dw
    %dw 2.0
    output application/json
    ---
    readUrl("classpath://myJson.json", "application/json")
    ```

    Learn more about the [readUrl](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-readurl) function when you are ready.

4.  View the matching output in the **Preview** pane.

    ```json
    {
      "hello": "world"
    }
    ```

    Note that you can also load the contents of a file through a metadata type in the Transform
    Message component. That procedure is covered later, in
    [Run Examples with Longer Payloads](#med_large_payload). It uses the `myJson.json` file you just
    created.

5.  Proceed to [Map Elements from an Array into an Object](#step_8)

### Map Elements from an Array into an Object

Almost all integrations require data mappings. Here, you map elements within an array to keys and
values of a JSON object:

1.  Replace the current script in the source code area with this one:

    ```dw
    %dw 2.0
    output application/json
    ---
    {
      (
        ["a", "b", "c"] map ((value, index) -> {
            (index): value
        })
      )
    }
    ```

    The `map` function iterates over the array on the left to apply the lambda (anonymous function)
    on the right (`((value, index) → { (index): value })`) to elements in that array. The lambda
    uses [named parameters](https://docs.mulesoft.com/dataweave/2.4/dataweave-functions-lambdas#_use_named_parameters_in_a_lambda) (`value`
    and `index`) to select the values and indices from the array and populate a JSON object with
    key-value pairs. Learn about [map](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-map), and when you are ready, compare `map`
    with [mapObject](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-mapobject), which takes an object as input.

2.  Preview the output:

    ```json
    {
      "0": "a",
      "1": "b",
      "2": "c"
    }
    ```

3.  Proceed to [Pluck Values from an Object into an Array](#step_9)

### Pluck Values from an Object into an Array

Now use the DataWeave `pluck` function to iterate over values in a JSON object and output those
values into an array.

1.  Replace the contents of the source code area with a script that uses `pluck` on a JSON object:

    ```dw
    %dw 2.0
    output application/json
    ---
    {
      "0": "a",
      "1": "b",
      "2": "c"
    } pluck ((value) -> value)
    ```

    Notice that the input object matches the [output](#output_map) of the `map` example and that the
    output array matches the [input](#input_map) from the `map` example. Learn more about
    [pluck](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-pluck) when you are ready.

2.  Preview the output:

    ```json
    ["a", "b", "c"]
    ```

3.  Proceed to [Map and Merge Fields](#step_10).

### Map and Merge Fields

Now try a more complex example that maps and merges fields from items in separate arrays. The point
here is simply to provide a taste of DataWeave’s ability to handle more complex mappings and
transformations needed for some integrations.

1.  Replace the current script in the source code area with this one:

    ```dw
    %dw 2.0
    var myVar = [
      { bookId: 101,
        title: "world history",
        price: "19.99"
      },
      {
        bookId: 202,
        title: 'the great outdoors',
        price: "15.99"
      }
    ]
    var myVar2 = [
      {
        bookId: 101,
        author: "john doe"
      },
      {
        bookId: 202,
        author: "jane doe"
      }
    ]
    output application/json
    ---
    myVar map (item, index) -> using (id = item.bookId) {
    	"id" : id,
    	"topic" : item.title,
    	"cost" : item.price as Number,
    	(myVar2 filter ($.*bookId contains id) map (item) -> {
    		author : item.author
    	})
    }
    ```

    When you are ready to explore the language further, you can learn how the
    [filter](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-filter) function used near the end returns `author` values from the
    array in the `myVar2` variable. You can read about
    [type coercion with DataWeave](https://docs.mulesoft.com/dataweave/2.4/dataweave-types-coercion) to see how `as` works with the data
    type in the line `"cost" : item.price as Number,` to coerce input strings like `"19.99"` into
    numbers like `19.99`. You can see how `using` (shown in `using (id = item.bookId)`) enables you
    to create [local DataWeave variables](https://docs.mulesoft.com/dataweave/2.4/dataweave-variables#example_local_variable) in a script.

2.  Preview the output:

    ```json
    [
      {
        "id": "101",
        "topic": "world history",
        "cost": 19.99,
        "author": "john doe"
      },
      {
        "id": "202",
        "topic": "the great outdoors",
        "cost": 15.99,
        "author": "jane doe"
      }
    ]
    ```

3.  Proceed to [Try Out More DataWeave Examples](#more_examples).

## Try Out More DataWeave Examples

Now you are ready to run DataWeave examples on your own. In your DataWeave playground, you can run
examples from the docs whenever you want to discover more about the DataWeave language. You can play
with the examples and use them to start your own scripts.

> [!NOTE] For examples that use `payload` to reference input data (such as the
> [contains](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-contains#contains1) or [mapObject](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-mapobject)
> function examples), you can avoid payload-related issues by using techniques described in
> [Run Examples that Act on a Payload](#provide_payload).

1.  Find many more examples to try out in Studio here:

    - [DataWeave Operators](https://docs.mulesoft.com/dataweave/2.4/dw-operators)

    - [DataWeave Reference](https://docs.mulesoft.com/dataweave/2.4/dw-functions): Docs on the DataWeave function modules provide many
      examples that use DataWeave functions.

    - [Flow Control in DataWeave](https://docs.mulesoft.com/dataweave/2.4/dataweave-flow-control)

    - [Pattern Matching in DataWeave](https://docs.mulesoft.com/dataweave/2.4/dataweave-pattern-matching)

    - [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook)

    - [Define DataWeave Functions](https://docs.mulesoft.com/dataweave/2.4/dataweave-functions)

2.  Proceed to [Next Steps](#next_steps).

### Run Examples that Act on a Payload

In DataWeave, `payload` is a built-in Mule Runtime variable that holds the contents of a
[Mule message](https://docs.mulesoft.com/mule-runtime/latest/about-mule-message#_message_payload). It enables you to
retrieve the body of a message simply by typing `payload` into the DataWeave script. The docs often
refer to this content as "the payload."

To try out DataWeave examples that use `payload` to get the contents of a Mule message, you have
some options:

- [Run Examples with Short Payloads](#small_payload): You can use a DataWeave variable.

- [Run Examples with Longer Payloads](#med_large_payload): Add the payload content through a file.
  This technique also works for short payloads.

Alternatives that require a running Mule app (such as using
[Set Payload](https://docs.mulesoft.com/mule-runtime/latest/set-payload-transformer-reference)) are not covered here but
are introduced in [Next Steps](#next_steps).

#### Run Examples with Short Payloads

For short examples with a few lines of sample data, you can convert the input payload to a variable.
You simply copy the payload’s content into a DataWeave variable (`var`) in the header of a DataWeave
script. Then, in the body of the script, you replace `payload` with the name of the new variable to
reference that variable.

1.  Start with this script in the source code area:

    ```DataWeave
    %dw 2.0
    output application/json
    ---
    ContainsRequestedItem: payload.root.*order.*items contains "3"
    ```

    Notice that you cannot preview it yet:

    ![A DataWeave script that checks if a payload contains a specific item in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.4/_images/dw-tut-payload-example.png)

2.  Now modify this example so that it uses some sample input instead of attempting to use `payload`
    to input content of a Mule message that does not exist:

    1.  Add a `myInput` DataWeave variable supplying some input data the script can read, and change
        the Mule `payload` variable in the body of the script to the DataWeave `myInput` variable.

        ```DataWeave
        %dw 2.0
        var myInput = read("<root>
            <order>
              <items>1</items>
              <items>3</items>
            </order>
            <order>
              <items>2</items>
            </order>
        </root>",
        "application/xml")
        output application/json
        ---
        ContainsRequestedItem: myInput.root.*order.*items contains "3"
        ```

    2.  Preview the results:

        ```json
        {
          "ContainsRequestedItem": true
        }
        ```

        When you are ready, learn more about the [contains](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-contains) function and
        about the built-in `payload` variable, in
        [Predefined Variables](https://docs.mulesoft.com/dataweave/2.4/dataweave-variables-context).

#### Run Examples with Longer Payloads

For DataWeave examples with many lines of sample data, consider creating a metadata type through
Transform Message. Metadata types can accept a local file that contains sample data.

1.  Use the [readUrl](#readurl_ex) example to create `src/main/resources/myJson.json` in Studio.

    You can skip this step if you still have the file in Studio. The next steps show how to use the
    contents of this file as your payload.

2.  Now replace the current script from the source code area of the Transform Message with one that
    selects the payload of the input:

    ```dw
    %dw 2.0
    output application/json
    ---
    payload
    ```

3.  Notice that you cannot preview a payload now because it does not exist yet.

    ![A DataWeave script that checks if a payload contains a specific item in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.4/_images/dw-tut-payload-example2.png)

4.  Now provide a simple JSON object as the payload of the Transform Message:

    1.  In the **Transform Message** tab, click the _left-most_ rectangle from the **Preview**
        button to open the columned, graphical view next to the source code area:

        ![A Transform Message component to define metadata in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.4/_images/studio-define-payload.png)

        If you mouse over that rectangle, you can see the label **Show Graphic**.

    2.  In the left-most column of the **Transform Message** tab, find **Payload: Unknown**, and
        click **Define metadata**.

        If you do not see the **Define metadata** link, simply right-click the **Payload:** entry in
        the left-most column, and then click **Set Metadata** to open the **Select metadata type**
        dialog.

5.  Now load the contents of `myJson.json` (created in the [readUrl](#readurl_ex) example) into the
    Transform Message component:

    1.  Click **+Add** to open the **Create new type** dialog.

    2.  In the dialog, provide the **Type id** `myJsonType`, and click **Create type**.

        ![A dialog for creating a new type](/mulesoft/current/en-us/dataweave/2.4/_images/studio-create-type.png)

    3.  Back in the **Select metadata type** dialog that opens, select **JSON** from the **Type**
        drop-down menu.

        ![A Select metadata type dialog to select Type](/mulesoft/current/en-us/dataweave/2.4/_images/studio_select_metadata_type.png)

    4.  Below the new type, change **Schema** to **Example** (as shown above).

    5.  Use the navigation button with the ellipsis (**…​**) to find
        `src/main/resources/myJson.json`, and click **Open**, which displays the structure of the
        file contents (`hello: _String_`) in the **Select metadata type** window.

    6.  Now click **Select** to load the contents of the file into the message payload.

    7.  Notice that the JSON object from `myJson.json` is now in the Preview pane.

        If necessary, you can click **Preview** to open the Preview pane.

    8.  Now click the _empty_ rectangle next to the **Preview** button to open the source code area,
        and change the body of the script to `payload.hello`, retaining the existing DataWeave
        header content.

        Notice that the Preview pane now contains only the value of the payload: `"world"`.

        Here is what this example looks like in Studio:

        ![A DataWeave script that outputs the word 'world' in JSON format in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.4/_images/dw-tut-world.png)

        Learn more about [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.4/dataweave-selectors) when you are ready.

## Next Steps

- To get started with Mule app development and data mapping through the Studio UI, see
  [Tutorial: Create a Mule app that uses the Database Connector and DataWeave](https://docs.mulesoft.com/mule-runtime/latest/mule-app-tutorial).

- Beyond the Transform Message component, many Mule connectors, modules, and Core components accept
  DataWeave selectors and short DataWeave expressions in their **fx** fields.

  To learn about the components, you can start from
  [Mule Components](https://docs.mulesoft.com/mule-runtime/latest/mule-components).

  To try out sample data in a running Mule app, without relying on external data sources, you can
  use these Core components with or without Transform Message:

  - [Set Payload](https://docs.mulesoft.com/mule-runtime/latest/set-payload-transformer-reference) to provide content
    for the payload of a Mule event.

  - [Set Variable](https://docs.mulesoft.com/mule-runtime/latest/variable-transformer-reference) to create content in a
    Mule event [variable](https://docs.mulesoft.com/mule-runtime/latest/about-mule-variables).

  - [Scheduler](https://docs.mulesoft.com/mule-runtime/latest/scheduler-concept) to trigger the regular generation of
    Mule events.

  - [Logger](https://docs.mulesoft.com/mule-runtime/latest/logger-component-reference) to view output and issues logged
    in the Studio console.

Here is an example that uses some of these components:

![A flow that outputs 'helloWorld' in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.4/_images/studio-hello-world.png)

- The **fx** value of Set Payload is set to `output application/json --- { hello : "world"}`.

- The **fx** value of the Logger is set to `payload`, which looks like `#[payload]` in the UI and
  the XML configuration file for the project.

- The **Console** tab of the _running_ Mule app (`testscript`) displays the payload from Set
  Payload.

<!-- document id=0b15f1850664f751e6c5024988ec3795ee964ff73e4bccf6bba8d4880273b2e7 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-quickstart.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, transform, transformer, format, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# DataWeave Quickstart

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

In this guide, you run DataWeave 2.0 scripts on sample data, without relying on external data
sources.

The examples introduce some key DataWeave concepts that you can explore further whenever you are
ready, and they show how to turn the Transform Message component into a DataWeave playground.

To run the scripts, you copy them into the source code area of a Transform Message component in
[Studio](https://docs.mulesoft.com/studio/), then view the results in the component’s **Preview** pane. You also load
content from files so that your DataWeave script can act on it. Once you feel comfortable with
DataWeave examples here and elsewhere in the docs, you can use the DataWeave playground to practice
writing your own DataWeave scripts on sample data.

![A script in Anypoint Studio showing a basic JSON output](/mulesoft/current/en-us/dataweave/2.6/_images/dw-tut-script-studio-basic.png)

The figure shows a Transform Message component in the center canvas, within **testingscriptFlow**.
Below the Studio canvas, the **Transform Message** tab includes a DataWeave script in the source
code area with output in the **Preview** pane.

## Prerequisites

[Studio 7](https://docs.mulesoft.com/studio/to-download-and-install-studio) is required. Versions 7.3 or 7.2.3 are
recommended. Other Studio 7 versions are untested with this guide.

Once Studio is installed, you need to set up a project with a Transform Message component. See
[Set Up a Project in Studio](#setup).

## Set Up a Project in Studio

Set up a Mule project that serves as a DataWeave playground:

1.  In Studio, click **File** → **New** → **Mule Project** to create a Mule project.

2.  Provide the name `testscript` for the project, and click **Finish**.

3.  From the **Mule Palette** tab of your new project, click **Core**, and then drag the **Transform
    Message** component into the Studio canvas.

    ![A Transform Message component in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.6/_images/dw-tut-script-studio.png)

    (A) **Mule Palette** tab

    (B) Studio canvas with Transform Message component

    (C) **Transform Message** tab

4.  In the **Transform Message** tab, click **Preview** (on the far right) to open the Preview pane,
    and click the _empty_ rectangle next to **Preview** to expand the source code area.

    ![A Transform Message tab showing an output payload in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.6/_images/studio-transform-msg-tab.png)

    The source code area on the left is the place where you are going to add DataWeave scripts, and
    the Preview pane on the right is where you view the output of the scripts.

5.  Proceed to [Start Scripting](#start_scripting).

## Start Scripting

1.  [Concatenate Two Strings into a Single String](#step_1)

2.  [Transform JSON Input to XML Output](#step_2)

3.  [Learn About Supported Data Types](#step_3)

4.  [Define and Use a DataWeave Variable as Input](#step_4)

5.  [Use a DataWeave Function in a DataWeave Variable](#step_5)

6.  [Read, Transform, and Select Content from an Input](#step_6)

7.  [Read File Contents with a DataWeave Function](#step_7)

8.  [Map Elements from an Array into an Object](#step_8)

9.  [Pluck Values from an Object into an Array](#step_9)

10. [Map and Merge Fields](#step_10)

### Concatenate Two Strings into a Single String

Begin with a simple DataWeave script that concatenates two strings ("hello" and "World") together
into a single string ("helloWorld").

![A DataWeave script that outputs 'helloWorld' in JSON format](/mulesoft/current/en-us/dataweave/2.6/_images/dw-tut-helloWorld.png)

1.  Replace the current script in the source code area of the **Transform Message** tab with this
    one:

    ```dw
    %dw 2.0
    output application/json
    ---
    { myString: ("hello" ++ "World") }
    ```

    - The body of the DataWeave script contains a key-value pair
      (`{ myString: ("hello" ++ "World") }`). The value of this input object is a DataWeave
      expression (`("hello" ++ "World")`) for concatenating the strings "hello" and "World" into a
      single string, "helloWorld".

      When you are ready, you can learn about the DataWeave [++](https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-plusplus)
      function used to concatenate the strings.

    - The header of the script is all the content above the three dashes, `---`. It includes
      important directives, including one for specifying the output format `application/json`. You
      can learn more about [DataWeave Scripts](https://docs.mulesoft.com/dataweave/2.6/dataweave-language-introduction) when you are ready.

2.  See the JSON output in the **Preview** pane:

    ```json
    { "myString": "helloWorld" }
    ```

3.  Proceed to [Transform JSON Input to XML Output](#step_2).

### Transform JSON Input to XML Output

Many integrations require transformations from one format to another. This procedure uses the
`output` directive to produce XML output from JSON input.

![A DataWeave script that outputs 'helloWorld' in XML format](/mulesoft/current/en-us/dataweave/2.6/_images/dw-tut-helloWorld-xml.png)

1.  Replace the body of the current script in the source code area with JSON output from
    [Concatenate Two Strings into a Single String](#step_1), and change the
    `output application/json` directive to `output application/xml`:

    ```dw
    %dw 2.0
    output application/xml
    ---
    { "myString" : ("helloWorld") }
    ```

2.  See the XML output in the **Preview** pane:

    ```xml
    <?xml version='1.0' encoding='UTF-8'?>
    <myString>helloWorld</myString>
    ```

    Notice that the `"myString"` key of the input JSON object `{ "myString" : ("helloWorld") }` is
    converted to the root element of the XML output and that the concatenated string becomes the
    value of that XML object. So the XML output is `<myString>helloWorld</myString>`. That output is
    preceded by a standard XML declaration that specifies the XML version and encoding.

    > [!NOTE] Without a _single_ key to serve as a root node for XML output (for example, if the
    > input is simply `("helloWorld")`), the transformation to XML will fail with a yellow warning
    > (**!**) in the source code area. The warning message is
    > `Trying to output non-whitespace characters outside main element tree`. If you like, you can
    > try to produce this warning on your own.

    DataWeave supports many output and input formats. You can learn more about
    [Supported Data Formats](https://docs.mulesoft.com/dataweave/2.6/dataweave-formats) when you are ready.

3.  Proceed to [Learn About Supported Data Types](#step_3)

### Learn About Supported Data Types

Now provide a DataWeave script that simply introduces you to a variety of supported data types and
shows how to add comments to a script.

1.  Replace the current script in the source code area of the **Transform Message** tab with this
    one:

    ```dw
    %dw 2.0
    output application/json
    ---
    {
      /*
       * A multi-line
       * comment here.
       */
      myString: "hello world",
      myNumber: 123,
      myFloatingPointNumber: 123.456,
      myVeryBigNumber: 12341234134123412341234123,
      myDate: |2018-12-07|,
      myTime: |11:55:56|,
      myDateTime: |2018-10-01T23:57:59-03:00|,
      myBoolean: true,
      myArray: [ 1, 2, 3, 5, 8],
      myMixedArray: [ 1, 2, "blah", { hello: "there" } ],
      myObjectKeyValuePair: { innerKey: "innerValue" },
      myObjectWithConditionalField: { a : { b : 1, ( c : 2 ) if true, (d : 4) if false } },
      myNull: null,
      myBinary: "abcd1234123" as Binary
      //A one-line comment here.
    }
    ```

    DataWeave supports multi-line comments within `/* */` markup and single-line comments after
    forward slashes (`//`). It also supports many data types, shown after the colon (`:`) in
    key-value pairs, such as `myString: "hello world"` and `myNumber: 123`. These types include
    strings (surrounded by quotation marks, `""`), numbers, date and time structures (within pipes,
    `||`), Booleans (`true` and `false`), arrays (within square brackets, `[]`), JSON-like objects
    (key-value structures within curly braces, `{}`), `null`, and binaries. When you are ready for
    more on this topic, you can review [DataWeave types](https://docs.mulesoft.com/dataweave/2.6/dataweave-types).

2.  See the JSON output in the **Preview** pane:

    ```json
    {
      "myString": "hello world",
      "myNumber": 123,
      "myFloatingPointNumber": 123.456,
      "myVeryBigNumber": 12341234134123412341234123,
      "myDate": "2018-12-07",
      "myTime": "11:55:56",
      "myDateTime": "2018-10-01T23:57:59-03:00",
      "myBoolean": true,
      "myArray": [1, 2, 3, 5, 8],
      "myMixedArray": [1, 2, "blah", { "hello": "there" }],
      "myObjectKeyValuePair": { "innerKey": "innerValue" },
      "myObjectWithConditionalField": { "a": { "b": 1, "c": 2 } },
      "myNull": null,
      "myBinary": "abcd1234123"
    }
    ```

3.  Proceed to [Define and Use a DataWeave Variable as Input](#step_4)

### Define and Use a DataWeave Variable as Input

Now try a simple DataWeave script that outputs the value of the DataWeave variable `myJson`. You set
the variable using the `var` directive in the script’s header.

1.  Replace the current script in the source code area of the **Transform Message** tab with this
    one:

    ```dw
    %dw 2.0
    var myJson = { "hello" : "world" }
    output application/json
    ---
    myJson
    ```

    A JSON object (`{ "hello" : "world" }`) is defined as the `myJson` variable in the script’s
    header. You can learn more about [DataWeave Variables](https://docs.mulesoft.com/dataweave/2.6/dataweave-variables) when you are ready.

2.  See the output in the **Preview** pane:

    ```json
    {
      "hello": "world"
    }
    ```

3.  Proceed to [Use a DataWeave Function in a DataWeave Variable](#step_5)

### Use a DataWeave Function in a DataWeave Variable

Now try a script that uses the DataWeave `avg` function in a DataWeave variable (`myJson`) to get
averages of two sets of numbers.

![A DataWeave script using a variable in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.6/_images/dw-tut-script-studio-var.png)

1.  Replace the current script in the source code area with this one:

    ```dw
    %dw 2.0
    var myJson = {
      a: avg([1, 1000]),
      b: avg([1, 2, 3])
    }
    output application/json
    ---
    myJson
    ```

    The `avg` functions here get invoked when you add `myJson` to the body of the script, producing
    the calculated averages within the JSON object you can see in the **Preview** pane. The
    structures `[1, 1000]` and `[1, 2, 3]` are [arrays](https://docs.mulesoft.com/dataweave/2.6/dataweave-types#dw_type_array). You can
    learn more about [avg](https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-avg) when you are ready.

2.  Preview the output:

    ```json
    {
      "a": 500.5,
      "b": 2.0
    }
    ```

3.  Proceed to [Read, Transform, and Select Content from an Input](#step_6)

### Read, Transform, and Select Content from an Input

Now try a more complicated script that reads XML input, transforms it to JSON, and only selects the
contents of the `car` element.

1.  Replace the current script in the source code area with this one:

    ```dw
    %dw 2.0
    var myRead = read("<car><color>red</color></car>",
                    "application/xml")
    output application/json
    ---
    {
      mySelection : myRead.car
    }
    ```

    If you encounter an issue previewing this example, try changing `myRead.car` to `myRead."car"`.
    Learn more about the [read](https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-read) function,
    [Supported Data Formats](https://docs.mulesoft.com/dataweave/2.6/dataweave-formats), and [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.6/dataweave-selectors) when
    you are ready.

2.  Preview the output:

    ```json
    {
      "mySelection": {
        "color": "red"
      }
    }
    ```

3.  Proceed to [Read File Contents with a DataWeave Function](#step_7)

### Read File Contents with a DataWeave Function

Now use `readUrl` to read the contents of a file in the Studio `src/main/resources` folder so you
can use that content as sample data for a DataWeave script.

1.  Add a file by right-clicking the `src/main/resources` folder in the **Package Explorer** tab,
    then navigating to **New** → **File**, providing the file name `myJson.json` for that file, and
    clicking **Finish**.

2.  From `src/main/resources`, provide and save the following sample content in the **myJson.json**
    tab (or within the **Source** sub-tab of the **myJson.json** tab, if it is present):

    ```json
    {
      "hello": "world"
    }
    ```

    ![A Package Explorer tab showing a sample content in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.6/_images/dw-tut-sample-file.png)

    Figure 1. myJson.json in Studio

3.  Returning to the Transform Message component within the **testscript** tab, replace the current
    script with one that uses `readUrl` to read the JSON contents from your file:

    ```dw
    %dw 2.0
    output application/json
    ---
    readUrl("classpath://myJson.json", "application/json")
    ```

    Learn more about the [readUrl](https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-readurl) function when you are ready.

4.  View the matching output in the **Preview** pane.

    ```json
    {
      "hello": "world"
    }
    ```

    Note that you can also load the contents of a file through a metadata type in the Transform
    Message component. That procedure is covered later, in
    [Run Examples with Longer Payloads](#med_large_payload). It uses the `myJson.json` file you just
    created.

5.  Proceed to [Map Elements from an Array into an Object](#step_8)

### Map Elements from an Array into an Object

Almost all integrations require data mappings. Here, you map elements within an array to keys and
values of a JSON object:

1.  Replace the current script in the source code area with this one:

    ```dw
    %dw 2.0
    output application/json
    ---
    {
      (
        ["a", "b", "c"] map ((value, index) -> {
            (index): value
        })
      )
    }
    ```

    The `map` function iterates over the array on the left to apply the lambda (anonymous function)
    on the right (`((value, index) → { (index): value })`) to elements in that array. The lambda
    uses [named parameters](https://docs.mulesoft.com/dataweave/2.6/dataweave-functions-lambdas#_use_named_parameters_in_a_lambda) (`value`
    and `index`) to select the values and indices from the array and populate a JSON object with
    key-value pairs. Learn about [map](https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-map), and when you are ready, compare `map`
    with [mapObject](https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-mapobject), which takes an object as input.

2.  Preview the output:

    ```json
    {
      "0": "a",
      "1": "b",
      "2": "c"
    }
    ```

3.  Proceed to [Pluck Values from an Object into an Array](#step_9)

### Pluck Values from an Object into an Array

Now use the DataWeave `pluck` function to iterate over values in a JSON object and output those
values into an array.

1.  Replace the contents of the source code area with a script that uses `pluck` on a JSON object:

    ```dw
    %dw 2.0
    output application/json
    ---
    {
      "0": "a",
      "1": "b",
      "2": "c"
    } pluck ((value) -> value)
    ```

    Notice that the input object matches the [output](#output_map) of the `map` example and that the
    output array matches the [input](#input_map) from the `map` example. Learn more about
    [pluck](https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-pluck) when you are ready.

2.  Preview the output:

    ```json
    ["a", "b", "c"]
    ```

3.  Proceed to [Map and Merge Fields](#step_10).

### Map and Merge Fields

Now try a more complex example that maps and merges fields from items in separate arrays. The point
here is simply to provide a taste of DataWeave’s ability to handle more complex mappings and
transformations needed for some integrations.

1.  Replace the current script in the source code area with this one:

    ```dw
    %dw 2.0
    var myVar = [
      { bookId: 101,
        title: "world history",
        price: "19.99"
      },
      {
        bookId: 202,
        title: 'the great outdoors',
        price: "15.99"
      }
    ]
    var myVar2 = [
      {
        bookId: 101,
        author: "john doe"
      },
      {
        bookId: 202,
        author: "jane doe"
      }
    ]
    output application/json
    ---
    myVar map (item, index) -> using (id = item.bookId) {
    	"id" : id,
    	"topic" : item.title,
    	"cost" : item.price as Number,
    	(myVar2 filter ($.*bookId contains id) map (item) -> {
    		author : item.author
    	})
    }
    ```

    When you are ready to explore the language further, you can learn how the
    [filter](https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-filter) function used near the end returns `author` values from the
    array in the `myVar2` variable. You can read about
    [type coercion with DataWeave](https://docs.mulesoft.com/dataweave/2.6/dataweave-types-coercion) to see how `as` works with the data
    type in the line `"cost" : item.price as Number,` to coerce input strings like `"19.99"` into
    numbers like `19.99`. You can see how `using` (shown in `using (id = item.bookId)`) enables you
    to create [local DataWeave variables](https://docs.mulesoft.com/dataweave/2.6/dataweave-variables#example_local_variable) in a script.

2.  Preview the output:

    ```json
    [
      {
        "id": "101",
        "topic": "world history",
        "cost": 19.99,
        "author": "john doe"
      },
      {
        "id": "202",
        "topic": "the great outdoors",
        "cost": 15.99,
        "author": "jane doe"
      }
    ]
    ```

3.  Proceed to [Try Out More DataWeave Examples](#more_examples).

## Try Out More DataWeave Examples

Now you are ready to run DataWeave examples on your own. In your DataWeave playground, you can run
examples from the docs whenever you want to discover more about the DataWeave language. You can play
with the examples and use them to start your own scripts.

> [!NOTE] For examples that use `payload` to reference input data (such as the
> [contains](https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-contains#contains1) or [mapObject](https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-mapobject)
> function examples), you can avoid payload-related issues by using techniques described in
> [Run Examples that Act on a Payload](#provide_payload).

1.  Find many more examples to try out in Studio here:

    - [DataWeave Operators](https://docs.mulesoft.com/dataweave/2.6/dw-operators)

    - [DataWeave Reference](https://docs.mulesoft.com/dataweave/2.6/dw-functions): Docs on the DataWeave function modules provide many
      examples that use DataWeave functions.

    - [Flow Control in DataWeave](https://docs.mulesoft.com/dataweave/2.6/dataweave-flow-control)

    - [Pattern Matching in DataWeave](https://docs.mulesoft.com/dataweave/2.6/dataweave-pattern-matching)

    - [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook)

    - [Define DataWeave Functions](https://docs.mulesoft.com/dataweave/2.6/dataweave-functions)

2.  Proceed to [Next Steps](#next_steps).

### Run Examples that Act on a Payload

In DataWeave, `payload` is a built-in Mule Runtime variable that holds the contents of a
[Mule message](https://docs.mulesoft.com/mule-runtime/latest/about-mule-message#_message_payload). It enables you to
retrieve the body of a message simply by typing `payload` into the DataWeave script. The docs often
refer to this content as "the payload."

To try out DataWeave examples that use `payload` to get the contents of a Mule message, you have
some options:

- [Run Examples with Short Payloads](#small_payload): You can use a DataWeave variable.

- [Run Examples with Longer Payloads](#med_large_payload): Add the payload content through a file.
  This technique also works for short payloads.

Alternatives that require a running Mule app (such as using
[Set Payload](https://docs.mulesoft.com/mule-runtime/latest/set-payload-transformer-reference)) are not covered here but
are introduced in [Next Steps](#next_steps).

#### Run Examples with Short Payloads

For short examples with a few lines of sample data, you can convert the input payload to a variable.
You simply copy the payload’s content into a DataWeave variable (`var`) in the header of a DataWeave
script. Then, in the body of the script, you replace `payload` with the name of the new variable to
reference that variable.

1.  Start with this script in the source code area:

    ```DataWeave
    %dw 2.0
    output application/json
    ---
    ContainsRequestedItem: payload.root.*order.*items contains "3"
    ```

    Notice that you cannot preview it yet:

    ![A DataWeave script that checks if a payload contains a specific item in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.6/_images/dw-tut-payload-example.png)

2.  Now modify this example so that it uses some sample input instead of attempting to use `payload`
    to input content of a Mule message that does not exist:

    1.  Add a `myInput` DataWeave variable supplying some input data the script can read, and change
        the Mule `payload` variable in the body of the script to the DataWeave `myInput` variable.

        ```DataWeave
        %dw 2.0
        var myInput = read("<root>
            <order>
              <items>1</items>
              <items>3</items>
            </order>
            <order>
              <items>2</items>
            </order>
        </root>",
        "application/xml")
        output application/json
        ---
        ContainsRequestedItem: myInput.root.*order.*items contains "3"
        ```

    2.  Preview the results:

        ```json
        {
          "ContainsRequestedItem": true
        }
        ```

        When you are ready, learn more about the [contains](https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-contains) function and
        about the built-in `payload` variable, in
        [Predefined Variables](https://docs.mulesoft.com/dataweave/2.6/dataweave-variables-context).

#### Run Examples with Longer Payloads

For DataWeave examples with many lines of sample data, consider creating a metadata type through
Transform Message. Metadata types can accept a local file that contains sample data.

1.  Use the [readUrl](#readurl_ex) example to create `src/main/resources/myJson.json` in Studio.

    You can skip this step if you still have the file in Studio. The next steps show how to use the
    contents of this file as your payload.

2.  Now replace the current script from the source code area of the Transform Message with one that
    selects the payload of the input:

    ```dw
    %dw 2.0
    output application/json
    ---
    payload
    ```

3.  Notice that you cannot preview a payload now because it does not exist yet.

    ![A DataWeave script that checks if a payload contains a specific item in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.6/_images/dw-tut-payload-example2.png)

4.  Now provide a simple JSON object as the payload of the Transform Message:

    1.  In the **Transform Message** tab, click the _left-most_ rectangle from the **Preview**
        button to open the columned, graphical view next to the source code area:

        ![A Transform Message component to define metadata in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.6/_images/studio-define-payload.png)

        If you mouse over that rectangle, you can see the label **Show Graphic**.

    2.  In the left-most column of the **Transform Message** tab, find **Payload: Unknown**, and
        click **Define metadata**.

        If you do not see the **Define metadata** link, simply right-click the **Payload:** entry in
        the left-most column, and then click **Set Metadata** to open the **Select metadata type**
        dialog.

5.  Now load the contents of `myJson.json` (created in the [readUrl](#readurl_ex) example) into the
    Transform Message component:

    1.  Click **+Add** to open the **Create new type** dialog.

    2.  In the dialog, provide the **Type id** `myJsonType`, and click **Create type**.

        ![A dialog for creating a new type](/mulesoft/current/en-us/dataweave/2.6/_images/studio-create-type.png)

    3.  Back in the **Select metadata type** dialog that opens, select **JSON** from the **Type**
        drop-down menu.

        ![A Select metadata type dialog to select Type](/mulesoft/current/en-us/dataweave/2.6/_images/studio_select_metadata_type.png)

    4.  Below the new type, change **Schema** to **Example** (as shown above).

    5.  Use the navigation button with the ellipsis (**…​**) to find
        `src/main/resources/myJson.json`, and click **Open**, which displays the structure of the
        file contents (`hello: _String_`) in the **Select metadata type** window.

    6.  Now click **Select** to load the contents of the file into the message payload.

    7.  Notice that the JSON object from `myJson.json` is now in the Preview pane.

        If necessary, you can click **Preview** to open the Preview pane.

    8.  Now click the _empty_ rectangle next to the **Preview** button to open the source code area,
        and change the body of the script to `payload.hello`, retaining the existing DataWeave
        header content.

        Notice that the Preview pane now contains only the value of the payload: `"world"`.

        Here is what this example looks like in Studio:

        ![A DataWeave script that outputs the word 'world' in JSON format in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.6/_images/dw-tut-world.png)

        Learn more about [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.6/dataweave-selectors) when you are ready.

## Next Steps

- To get started with Mule app development and data mapping through the Studio UI, see
  [Tutorial: Create a Mule app that uses the Database Connector and DataWeave](https://docs.mulesoft.com/mule-runtime/latest/mule-app-tutorial).

- Beyond the Transform Message component, many Mule connectors, modules, and Core components accept
  DataWeave selectors and short DataWeave expressions in their **fx** fields.

  To learn about the components, you can start from
  [Mule Components](https://docs.mulesoft.com/mule-runtime/latest/mule-components).

  To try out sample data in a running Mule app, without relying on external data sources, you can
  use these Core components with or without Transform Message:

  - [Set Payload](https://docs.mulesoft.com/mule-runtime/latest/set-payload-transformer-reference) to provide content
    for the payload of a Mule event.

  - [Set Variable](https://docs.mulesoft.com/mule-runtime/latest/variable-transformer-reference) to create content in a
    Mule event [variable](https://docs.mulesoft.com/mule-runtime/latest/about-mule-variables).

  - [Scheduler](https://docs.mulesoft.com/mule-runtime/latest/scheduler-concept) to trigger the regular generation of
    Mule events.

  - [Logger](https://docs.mulesoft.com/mule-runtime/latest/logger-component-reference) to view output and issues logged
    in the Studio console.

Here is an example that uses some of these components:

![A flow that outputs 'helloWorld' in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.6/_images/studio-hello-world.png)

- The **fx** value of Set Payload is set to `output application/json --- { hello : "world"}`.

- The **fx** value of the Logger is set to `payload`, which looks like `#[payload]` in the UI and
  the XML configuration file for the project.

- The **Console** tab of the _running_ Mule app (`testscript`) displays the payload from Set
  Payload.

<!-- document id=135b79d2ab1856ab9125be94d427d16e1d6e7785498f7625fb36358c1d54769b url=/mulesoft/current/en-us/dataweave/2.9/dataweave-quickstart.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, transform, transformer, format, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# DataWeave Quickstart

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

In this guide, you run DataWeave 2.0 scripts on sample data, without relying on external data
sources.

The examples introduce some key DataWeave concepts that you can explore further whenever you are
ready, and they show how to turn the Transform Message component into a DataWeave playground.

To run the scripts, you copy them into the source code area of a Transform Message component in
[Studio](https://docs.mulesoft.com/studio/), then view the results in the component’s **Preview** pane. You also load
content from files so that your DataWeave script can act on it. Once you feel comfortable with
DataWeave examples here and elsewhere in the docs, you can use the DataWeave playground to practice
writing your own DataWeave scripts on sample data.

![A script in Anypoint Studio showing a basic JSON output](/mulesoft/current/en-us/dataweave/2.9/_images/dw-tut-script-studio-basic.png)

The figure shows a Transform Message component in the center canvas, within **testingscriptFlow**.
Below the Studio canvas, the **Transform Message** tab includes a DataWeave script in the source
code area with output in the **Preview** pane.

## Prerequisites

[Studio 7](https://docs.mulesoft.com/studio/to-download-and-install-studio) is required. Versions 7.3 or 7.2.3 are
recommended. Other Studio 7 versions are untested with this guide.

Once Studio is installed, you need to set up a project with a Transform Message component. See
[Set Up a Project in Studio](#setup).

## Set Up a Project in Studio

Set up a Mule project that serves as a DataWeave playground:

1.  In Studio, click **File** → **New** → **Mule Project** to create a Mule project.

2.  Provide the name `testscript` for the project, and click **Finish**.

3.  From the **Mule Palette** tab of your new project, click **Core**, and then drag the **Transform
    Message** component into the Studio canvas.

    ![A Transform Message component in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.9/_images/dw-tut-script-studio.png)

    (A) **Mule Palette** tab

    (B) Studio canvas with Transform Message component

    (C) **Transform Message** tab

4.  In the **Transform Message** tab, click **Preview** (on the far right) to open the Preview pane,
    and click the _empty_ rectangle next to **Preview** to expand the source code area.

    ![A Transform Message tab showing an output payload in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.9/_images/studio-transform-msg-tab.png)

    The source code area on the left is the place where you are going to add DataWeave scripts, and
    the Preview pane on the right is where you view the output of the scripts.

5.  Proceed to [Start Scripting](#start_scripting).

## Start Scripting

1.  [Concatenate Two Strings into a Single String](#step_1)

2.  [Transform JSON Input to XML Output](#step_2)

3.  [Learn About Supported Data Types](#step_3)

4.  [Define and Use a DataWeave Variable as Input](#step_4)

5.  [Use a DataWeave Function in a DataWeave Variable](#step_5)

6.  [Read, Transform, and Select Content from an Input](#step_6)

7.  [Read File Contents with a DataWeave Function](#step_7)

8.  [Map Elements from an Array into an Object](#step_8)

9.  [Pluck Values from an Object into an Array](#step_9)

10. [Map and Merge Fields](#step_10)

### Concatenate Two Strings into a Single String

Begin with a simple DataWeave script that concatenates two strings ("hello" and "World") together
into a single string ("helloWorld").

![A DataWeave script that outputs 'helloWorld' in JSON format](/mulesoft/current/en-us/dataweave/2.9/_images/dw-tut-helloWorld.png)

1.  Replace the current script in the source code area of the **Transform Message** tab with this
    one:

    ```dw
    %dw 2.0
    output application/json
    ---
    { myString: ("hello" ++ "World") }
    ```

    - The body of the DataWeave script contains a key-value pair
      (`{ myString: ("hello" ++ "World") }`). The value of this input object is a DataWeave
      expression (`("hello" ++ "World")`) for concatenating the strings "hello" and "World" into a
      single string, "helloWorld".

      When you are ready, you can learn about the DataWeave [++](https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-plusplus)
      function used to concatenate the strings.

    - The header of the script is all the content above the three dashes, `---`. It includes
      important directives, including one for specifying the output format `application/json`. You
      can learn more about [DataWeave Scripts](https://docs.mulesoft.com/dataweave/2.9/dataweave-language-introduction) when you are ready.

2.  See the JSON output in the **Preview** pane:

    ```json
    { "myString": "helloWorld" }
    ```

3.  Proceed to [Transform JSON Input to XML Output](#step_2).

### Transform JSON Input to XML Output

Many integrations require transformations from one format to another. This procedure uses the
`output` directive to produce XML output from JSON input.

![A DataWeave script that outputs 'helloWorld' in XML format](/mulesoft/current/en-us/dataweave/2.9/_images/dw-tut-helloWorld-xml.png)

1.  Replace the body of the current script in the source code area with JSON output from
    [Concatenate Two Strings into a Single String](#step_1), and change the
    `output application/json` directive to `output application/xml`:

    ```dw
    %dw 2.0
    output application/xml
    ---
    { "myString" : ("helloWorld") }
    ```

2.  See the XML output in the **Preview** pane:

    ```xml
    <?xml version='1.0' encoding='UTF-8'?>
    <myString>helloWorld</myString>
    ```

    Notice that the `"myString"` key of the input JSON object `{ "myString" : ("helloWorld") }` is
    converted to the root element of the XML output and that the concatenated string becomes the
    value of that XML object. So the XML output is `<myString>helloWorld</myString>`. That output is
    preceded by a standard XML declaration that specifies the XML version and encoding.

    > [!NOTE] Without a _single_ key to serve as a root node for XML output (for example, if the
    > input is simply `("helloWorld")`), the transformation to XML will fail with a yellow warning
    > (**!**) in the source code area. The warning message is
    > `Trying to output non-whitespace characters outside main element tree`. If you like, you can
    > try to produce this warning on your own.

    DataWeave supports many output and input formats. You can learn more about
    [Supported Data Formats](https://docs.mulesoft.com/dataweave/2.9/dataweave-formats) when you are ready.

3.  Proceed to [Learn About Supported Data Types](#step_3)

### Learn About Supported Data Types

Now provide a DataWeave script that simply introduces you to a variety of supported data types and
shows how to add comments to a script.

1.  Replace the current script in the source code area of the **Transform Message** tab with this
    one:

    ```dw
    %dw 2.0
    output application/json
    ---
    {
      /*
       * A multi-line
       * comment here.
       */
      myString: "hello world",
      myNumber: 123,
      myFloatingPointNumber: 123.456,
      myVeryBigNumber: 12341234134123412341234123,
      myDate: |2018-12-07|,
      myTime: |11:55:56|,
      myDateTime: |2018-10-01T23:57:59-03:00|,
      myBoolean: true,
      myArray: [ 1, 2, 3, 5, 8],
      myMixedArray: [ 1, 2, "blah", { hello: "there" } ],
      myObjectKeyValuePair: { innerKey: "innerValue" },
      myObjectWithConditionalField: { a : { b : 1, ( c : 2 ) if true, (d : 4) if false } },
      myNull: null,
      myBinary: "abcd1234123" as Binary
      //A one-line comment here.
    }
    ```

    DataWeave supports multi-line comments within `/* */` markup and single-line comments after
    forward slashes (`//`). It also supports many data types, shown after the colon (`:`) in
    key-value pairs, such as `myString: "hello world"` and `myNumber: 123`. These types include
    strings (surrounded by quotation marks, `""`), numbers, date and time structures (within pipes,
    `||`), Booleans (`true` and `false`), arrays (within square brackets, `[]`), JSON-like objects
    (key-value structures within curly braces, `{}`), `null`, and binaries. When you are ready for
    more on this topic, you can review [DataWeave types](https://docs.mulesoft.com/dataweave/2.9/dataweave-types).

2.  See the JSON output in the **Preview** pane:

    ```json
    {
      "myString": "hello world",
      "myNumber": 123,
      "myFloatingPointNumber": 123.456,
      "myVeryBigNumber": 12341234134123412341234123,
      "myDate": "2018-12-07",
      "myTime": "11:55:56",
      "myDateTime": "2018-10-01T23:57:59-03:00",
      "myBoolean": true,
      "myArray": [1, 2, 3, 5, 8],
      "myMixedArray": [1, 2, "blah", { "hello": "there" }],
      "myObjectKeyValuePair": { "innerKey": "innerValue" },
      "myObjectWithConditionalField": { "a": { "b": 1, "c": 2 } },
      "myNull": null,
      "myBinary": "abcd1234123"
    }
    ```

3.  Proceed to [Define and Use a DataWeave Variable as Input](#step_4)

### Define and Use a DataWeave Variable as Input

Now try a simple DataWeave script that outputs the value of the DataWeave variable `myJson`. You set
the variable using the `var` directive in the script’s header.

1.  Replace the current script in the source code area of the **Transform Message** tab with this
    one:

    ```dw
    %dw 2.0
    var myJson = { "hello" : "world" }
    output application/json
    ---
    myJson
    ```

    A JSON object (`{ "hello" : "world" }`) is defined as the `myJson` variable in the script’s
    header. You can learn more about [DataWeave Variables](https://docs.mulesoft.com/dataweave/2.9/dataweave-variables) when you are ready.

2.  See the output in the **Preview** pane:

    ```json
    {
      "hello": "world"
    }
    ```

3.  Proceed to [Use a DataWeave Function in a DataWeave Variable](#step_5)

### Use a DataWeave Function in a DataWeave Variable

Now try a script that uses the DataWeave `avg` function in a DataWeave variable (`myJson`) to get
averages of two sets of numbers.

![A DataWeave script using a variable in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.9/_images/dw-tut-script-studio-var.png)

1.  Replace the current script in the source code area with this one:

    ```dw
    %dw 2.0
    var myJson = {
      a: avg([1, 1000]),
      b: avg([1, 2, 3])
    }
    output application/json
    ---
    myJson
    ```

    The `avg` functions here get invoked when you add `myJson` to the body of the script, producing
    the calculated averages within the JSON object you can see in the **Preview** pane. The
    structures `[1, 1000]` and `[1, 2, 3]` are [arrays](https://docs.mulesoft.com/dataweave/2.9/dataweave-types#dw_type_array). You can
    learn more about [avg](https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-avg) when you are ready.

2.  Preview the output:

    ```json
    {
      "a": 500.5,
      "b": 2.0
    }
    ```

3.  Proceed to [Read, Transform, and Select Content from an Input](#step_6)

### Read, Transform, and Select Content from an Input

Now try a more complicated script that reads XML input, transforms it to JSON, and only selects the
contents of the `car` element.

1.  Replace the current script in the source code area with this one:

    ```dw
    %dw 2.0
    var myRead = read("<car><color>red</color></car>",
                    "application/xml")
    output application/json
    ---
    {
      mySelection : myRead.car
    }
    ```

    If you encounter an issue previewing this example, try changing `myRead.car` to `myRead."car"`.
    Learn more about the [read](https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-read) function,
    [Supported Data Formats](https://docs.mulesoft.com/dataweave/2.9/dataweave-formats), and [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.9/dataweave-selectors) when
    you are ready.

2.  Preview the output:

    ```json
    {
      "mySelection": {
        "color": "red"
      }
    }
    ```

3.  Proceed to [Read File Contents with a DataWeave Function](#step_7)

### Read File Contents with a DataWeave Function

Now use `readUrl` to read the contents of a file in the Studio `src/main/resources` folder so you
can use that content as sample data for a DataWeave script.

1.  Add a file by right-clicking the `src/main/resources` folder in the **Package Explorer** tab,
    then navigating to **New** → **File**, providing the file name `myJson.json` for that file, and
    clicking **Finish**.

2.  From `src/main/resources`, provide and save the following sample content in the **myJson.json**
    tab (or within the **Source** sub-tab of the **myJson.json** tab, if it is present):

    ```json
    {
      "hello": "world"
    }
    ```

    ![A Package Explorer tab showing a sample content in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.9/_images/dw-tut-sample-file.png)

    Figure 1. myJson.json in Studio

3.  Returning to the Transform Message component within the **testscript** tab, replace the current
    script with one that uses `readUrl` to read the JSON contents from your file:

    ```dw
    %dw 2.0
    output application/json
    ---
    readUrl("classpath://myJson.json", "application/json")
    ```

    Learn more about the [readUrl](https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-readurl) function when you are ready.

4.  View the matching output in the **Preview** pane.

    ```json
    {
      "hello": "world"
    }
    ```

    Note that you can also load the contents of a file through a metadata type in the Transform
    Message component. That procedure is covered later, in
    [Run Examples with Longer Payloads](#med_large_payload). It uses the `myJson.json` file you just
    created.

5.  Proceed to [Map Elements from an Array into an Object](#step_8)

### Map Elements from an Array into an Object

Almost all integrations require data mappings. Here, you map elements within an array to keys and
values of a JSON object:

1.  Replace the current script in the source code area with this one:

    ```dw
    %dw 2.0
    output application/json
    ---
    {
      (
        ["a", "b", "c"] map ((value, index) -> {
            (index): value
        })
      )
    }
    ```

    The `map` function iterates over the array on the left to apply the lambda (anonymous function)
    on the right (`((value, index) → { (index): value })`) to elements in that array. The lambda
    uses [named parameters](https://docs.mulesoft.com/dataweave/2.9/dataweave-functions-lambdas#_use_named_parameters_in_a_lambda) (`value`
    and `index`) to select the values and indices from the array and populate a JSON object with
    key-value pairs. Learn about [map](https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-map), and when you are ready, compare `map`
    with [mapObject](https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-mapobject), which takes an object as input.

2.  Preview the output:

    ```json
    {
      "0": "a",
      "1": "b",
      "2": "c"
    }
    ```

3.  Proceed to [Pluck Values from an Object into an Array](#step_9)

### Pluck Values from an Object into an Array

Now use the DataWeave `pluck` function to iterate over values in a JSON object and output those
values into an array.

1.  Replace the contents of the source code area with a script that uses `pluck` on a JSON object:

    ```dw
    %dw 2.0
    output application/json
    ---
    {
      "0": "a",
      "1": "b",
      "2": "c"
    } pluck ((value) -> value)
    ```

    Notice that the input object matches the [output](#output_map) of the `map` example and that the
    output array matches the [input](#input_map) from the `map` example. Learn more about
    [pluck](https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-pluck) when you are ready.

2.  Preview the output:

    ```json
    ["a", "b", "c"]
    ```

3.  Proceed to [Map and Merge Fields](#step_10).

### Map and Merge Fields

Now try a more complex example that maps and merges fields from items in separate arrays. The point
here is simply to provide a taste of DataWeave’s ability to handle more complex mappings and
transformations needed for some integrations.

1.  Replace the current script in the source code area with this one:

    ```dw
    %dw 2.0
    var myVar = [
      { bookId: 101,
        title: "world history",
        price: "19.99"
      },
      {
        bookId: 202,
        title: 'the great outdoors',
        price: "15.99"
      }
    ]
    var myVar2 = [
      {
        bookId: 101,
        author: "john doe"
      },
      {
        bookId: 202,
        author: "jane doe"
      }
    ]
    output application/json
    ---
    myVar map (item, index) -> using (id = item.bookId) {
    	"id" : id,
    	"topic" : item.title,
    	"cost" : item.price as Number,
    	(myVar2 filter ($.*bookId contains id) map (item) -> {
    		author : item.author
    	})
    }
    ```

    When you are ready to explore the language further, you can learn how the
    [filter](https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-filter) function used near the end returns `author` values from the
    array in the `myVar2` variable. You can read about
    [type coercion with DataWeave](https://docs.mulesoft.com/dataweave/2.9/dataweave-types-coercion) to see how `as` works with the data
    type in the line `"cost" : item.price as Number,` to coerce input strings like `"19.99"` into
    numbers like `19.99`. You can see how `using` (shown in `using (id = item.bookId)`) enables you
    to create [local DataWeave variables](https://docs.mulesoft.com/dataweave/2.9/dataweave-variables#example_local_variable) in a script.

2.  Preview the output:

    ```json
    [
      {
        "id": "101",
        "topic": "world history",
        "cost": 19.99,
        "author": "john doe"
      },
      {
        "id": "202",
        "topic": "the great outdoors",
        "cost": 15.99,
        "author": "jane doe"
      }
    ]
    ```

3.  Proceed to [Try Out More DataWeave Examples](#more_examples).

## Try Out More DataWeave Examples

Now you are ready to run DataWeave examples on your own. In your DataWeave playground, you can run
examples from the docs whenever you want to discover more about the DataWeave language. You can play
with the examples and use them to start your own scripts.

> [!NOTE] For examples that use `payload` to reference input data (such as the
> [contains](https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-contains#contains1) or [mapObject](https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-mapobject)
> function examples), you can avoid payload-related issues by using techniques described in
> [Run Examples that Act on a Payload](#provide_payload).

1.  Find many more examples to try out in Studio here:

    - [DataWeave Operators](https://docs.mulesoft.com/dataweave/2.9/dw-operators)

    - [DataWeave Reference](https://docs.mulesoft.com/dataweave/2.9/dw-functions): Docs on the DataWeave function modules provide many
      examples that use DataWeave functions.

    - [Flow Control in DataWeave](https://docs.mulesoft.com/dataweave/2.9/dataweave-flow-control)

    - [Pattern Matching in DataWeave](https://docs.mulesoft.com/dataweave/2.9/dataweave-pattern-matching)

    - [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook)

    - [Define DataWeave Functions](https://docs.mulesoft.com/dataweave/2.9/dataweave-functions)

2.  Proceed to [Next Steps](#next_steps).

### Run Examples that Act on a Payload

In DataWeave, `payload` is a built-in Mule Runtime variable that holds the contents of a
[Mule message](https://docs.mulesoft.com/mule-runtime/latest/about-mule-message#_message_payload). It enables you to
retrieve the body of a message simply by typing `payload` into the DataWeave script. The docs often
refer to this content as "the payload."

To try out DataWeave examples that use `payload` to get the contents of a Mule message, you have
some options:

- [Run Examples with Short Payloads](#small_payload): You can use a DataWeave variable.

- [Run Examples with Longer Payloads](#med_large_payload): Add the payload content through a file.
  This technique also works for short payloads.

Alternatives that require a running Mule app (such as using
[Set Payload](https://docs.mulesoft.com/mule-runtime/latest/set-payload-transformer-reference)) are not covered here but
are introduced in [Next Steps](#next_steps).

#### Run Examples with Short Payloads

For short examples with a few lines of sample data, you can convert the input payload to a variable.
You simply copy the payload’s content into a DataWeave variable (`var`) in the header of a DataWeave
script. Then, in the body of the script, you replace `payload` with the name of the new variable to
reference that variable.

1.  Start with this script in the source code area:

    ```DataWeave
    %dw 2.0
    output application/json
    ---
    ContainsRequestedItem: payload.root.*order.*items contains "3"
    ```

    Notice that you cannot preview it yet:

    ![A DataWeave script that checks if a payload contains a specific item in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.9/_images/dw-tut-payload-example.png)

2.  Now modify this example so that it uses some sample input instead of attempting to use `payload`
    to input content of a Mule message that does not exist:

    1.  Add a `myInput` DataWeave variable supplying some input data the script can read, and change
        the Mule `payload` variable in the body of the script to the DataWeave `myInput` variable.

        ```DataWeave
        %dw 2.0
        var myInput = read("<root>
            <order>
              <items>1</items>
              <items>3</items>
            </order>
            <order>
              <items>2</items>
            </order>
        </root>",
        "application/xml")
        output application/json
        ---
        ContainsRequestedItem: myInput.root.*order.*items contains "3"
        ```

    2.  Preview the results:

        ```json
        {
          "ContainsRequestedItem": true
        }
        ```

        When you are ready, learn more about the [contains](https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-contains) function and
        about the built-in `payload` variable, in
        [Predefined Variables](https://docs.mulesoft.com/dataweave/2.9/dataweave-variables-context).

#### Run Examples with Longer Payloads

For DataWeave examples with many lines of sample data, consider creating a metadata type through
Transform Message. Metadata types can accept a local file that contains sample data.

1.  Use the [readUrl](#readurl_ex) example to create `src/main/resources/myJson.json` in Studio.

    You can skip this step if you still have the file in Studio. The next steps show how to use the
    contents of this file as your payload.

2.  Now replace the current script from the source code area of the Transform Message with one that
    selects the payload of the input:

    ```dw
    %dw 2.0
    output application/json
    ---
    payload
    ```

3.  Notice that you cannot preview a payload now because it does not exist yet.

    ![A DataWeave script that checks if a payload contains a specific item in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.9/_images/dw-tut-payload-example2.png)

4.  Now provide a simple JSON object as the payload of the Transform Message:

    1.  In the **Transform Message** tab, click the _left-most_ rectangle from the **Preview**
        button to open the columned, graphical view next to the source code area:

        ![A Transform Message component to define metadata in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.9/_images/studio-define-payload.png)

        If you mouse over that rectangle, you can see the label **Show Graphic**.

    2.  In the left-most column of the **Transform Message** tab, find **Payload: Unknown**, and
        click **Define metadata**.

        If you do not see the **Define metadata** link, simply right-click the **Payload:** entry in
        the left-most column, and then click **Set Metadata** to open the **Select metadata type**
        dialog.

5.  Now load the contents of `myJson.json` (created in the [readUrl](#readurl_ex) example) into the
    Transform Message component:

    1.  Click **+Add** to open the **Create new type** dialog.

    2.  In the dialog, provide the **Type id** `myJsonType`, and click **Create type**.

        ![A dialog for creating a new type](/mulesoft/current/en-us/dataweave/2.9/_images/studio-create-type.png)

    3.  Back in the **Select metadata type** dialog that opens, select **JSON** from the **Type**
        drop-down menu.

        ![A Select metadata type dialog to select Type](/mulesoft/current/en-us/dataweave/2.9/_images/studio_select_metadata_type.png)

    4.  Below the new type, change **Schema** to **Example** (as shown above).

    5.  Use the navigation button with the ellipsis (**…​**) to find
        `src/main/resources/myJson.json`, and click **Open**, which displays the structure of the
        file contents (`hello: _String_`) in the **Select metadata type** window.

    6.  Now click **Select** to load the contents of the file into the message payload.

    7.  Notice that the JSON object from `myJson.json` is now in the Preview pane.

        If necessary, you can click **Preview** to open the Preview pane.

    8.  Now click the _empty_ rectangle next to the **Preview** button to open the source code area,
        and change the body of the script to `payload.hello`, retaining the existing DataWeave
        header content.

        Notice that the Preview pane now contains only the value of the payload: `"world"`.

        Here is what this example looks like in Studio:

        ![A DataWeave script that outputs the word 'world' in JSON format in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.9/_images/dw-tut-world.png)

        Learn more about [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.9/dataweave-selectors) when you are ready.

## Next Steps

- To get started with Mule app development and data mapping through the Studio UI, see
  [Tutorial: Create a Mule app that uses the Database Connector and DataWeave](https://docs.mulesoft.com/mule-runtime/latest/mule-app-tutorial).

- Beyond the Transform Message component, many Mule connectors, modules, and Core components accept
  DataWeave selectors and short DataWeave expressions in their **fx** fields.

  To learn about the components, you can start from
  [Mule Components](https://docs.mulesoft.com/mule-runtime/latest/mule-components).

  To try out sample data in a running Mule app, without relying on external data sources, you can
  use these Core components with or without Transform Message:

  - [Set Payload](https://docs.mulesoft.com/mule-runtime/latest/set-payload-transformer-reference) to provide content
    for the payload of a Mule event.

  - [Set Variable](https://docs.mulesoft.com/mule-runtime/latest/variable-transformer-reference) to create content in a
    Mule event [variable](https://docs.mulesoft.com/mule-runtime/latest/about-mule-variables).

  - [Scheduler](https://docs.mulesoft.com/mule-runtime/latest/scheduler-concept) to trigger the regular generation of
    Mule events.

  - [Logger](https://docs.mulesoft.com/mule-runtime/latest/logger-component-reference) to view output and issues logged
    in the Studio console.

Here is an example that uses some of these components:

![A flow that outputs 'helloWorld' in Anypoint Studio](/mulesoft/current/en-us/dataweave/2.9/_images/studio-hello-world.png)

- The **fx** value of Set Payload is set to `output application/json --- { hello : "world"}`.

- The **fx** value of the Logger is set to `payload`, which looks like `#[payload]` in the UI and
  the XML configuration file for the project.

- The **Console** tab of the _running_ Mule app (`testscript`) displays the payload from Set
  Payload.

<!-- document id=47d4b3a7a987f22392001c1d577a7acf77885122d49e8854ccca4e27afedb8a4 url=/mulesoft/current/en-us/dataweave/latest/dataweave-quickstart.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, transform, transformer, format, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# DataWeave Quickstart

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

In this guide, you run DataWeave 2.0 scripts on sample data, without relying on external data
sources.

The examples introduce some key DataWeave concepts that you can explore further whenever you are
ready, and they show how to turn the Transform Message component into a DataWeave playground.

To run the scripts, you copy them into the source code area of a Transform Message component in
[Studio](https://docs.mulesoft.com/studio/), then view the results in the component’s **Preview** pane. You also load
content from files so that your DataWeave script can act on it. Once you feel comfortable with
DataWeave examples here and elsewhere in the docs, you can use the DataWeave playground to practice
writing your own DataWeave scripts on sample data.

![A script in Anypoint Studio showing a basic JSON output](/mulesoft/current/en-us/dataweave/latest/_images/dw-tut-script-studio-basic.png)

The figure shows a Transform Message component in the center canvas, within **testingscriptFlow**.
Below the Studio canvas, the **Transform Message** tab includes a DataWeave script in the source
code area with output in the **Preview** pane.

## Prerequisites

[Studio 7](https://docs.mulesoft.com/studio/to-download-and-install-studio) is required. Versions 7.3 or 7.2.3 are
recommended. Other Studio 7 versions are untested with this guide.

Once Studio is installed, you need to set up a project with a Transform Message component. See
[Set Up a Project in Studio](#setup).

## Set Up a Project in Studio

Set up a Mule project that serves as a DataWeave playground:

1.  In Studio, click **File** → **New** → **Mule Project** to create a Mule project.

2.  Provide the name `testscript` for the project, and click **Finish**.

3.  From the **Mule Palette** tab of your new project, click **Core**, and then drag the **Transform
    Message** component into the Studio canvas.

    ![A Transform Message component in Anypoint Studio](/mulesoft/current/en-us/dataweave/latest/_images/dw-tut-script-studio.png)

    (A) **Mule Palette** tab

    (B) Studio canvas with Transform Message component

    (C) **Transform Message** tab

4.  In the **Transform Message** tab, click **Preview** (on the far right) to open the Preview pane,
    and click the _empty_ rectangle next to **Preview** to expand the source code area.

    ![A Transform Message tab showing an output payload in Anypoint Studio](/mulesoft/current/en-us/dataweave/latest/_images/studio-transform-msg-tab.png)

    The source code area on the left is the place where you are going to add DataWeave scripts, and
    the Preview pane on the right is where you view the output of the scripts.

5.  Proceed to [Start Scripting](#start_scripting).

## Start Scripting

1.  [Concatenate Two Strings into a Single String](#step_1)

2.  [Transform JSON Input to XML Output](#step_2)

3.  [Learn About Supported Data Types](#step_3)

4.  [Define and Use a DataWeave Variable as Input](#step_4)

5.  [Use a DataWeave Function in a DataWeave Variable](#step_5)

6.  [Read, Transform, and Select Content from an Input](#step_6)

7.  [Read File Contents with a DataWeave Function](#step_7)

8.  [Map Elements from an Array into an Object](#step_8)

9.  [Pluck Values from an Object into an Array](#step_9)

10. [Map and Merge Fields](#step_10)

### Concatenate Two Strings into a Single String

Begin with a simple DataWeave script that concatenates two strings ("hello" and "World") together
into a single string ("helloWorld").

![A DataWeave script that outputs 'helloWorld' in JSON format](/mulesoft/current/en-us/dataweave/latest/_images/dw-tut-helloWorld.png)

1.  Replace the current script in the source code area of the **Transform Message** tab with this
    one:

    ```dw
    %dw 2.0
    output application/json
    ---
    { myString: ("hello" ++ "World") }
    ```

    - The body of the DataWeave script contains a key-value pair
      (`{ myString: ("hello" ++ "World") }`). The value of this input object is a DataWeave
      expression (`("hello" ++ "World")`) for concatenating the strings "hello" and "World" into a
      single string, "helloWorld".

      When you are ready, you can learn about the DataWeave [++](https://docs.mulesoft.com/dataweave/latest/dw-core-functions-plusplus)
      function used to concatenate the strings.

    - The header of the script is all the content above the three dashes, `---`. It includes
      important directives, including one for specifying the output format `application/json`. You
      can learn more about [DataWeave Scripts](https://docs.mulesoft.com/dataweave/latest/dataweave-language-introduction) when you are ready.

2.  See the JSON output in the **Preview** pane:

    ```json
    { "myString": "helloWorld" }
    ```

3.  Proceed to [Transform JSON Input to XML Output](#step_2).

### Transform JSON Input to XML Output

Many integrations require transformations from one format to another. This procedure uses the
`output` directive to produce XML output from JSON input.

![A DataWeave script that outputs 'helloWorld' in XML format](/mulesoft/current/en-us/dataweave/latest/_images/dw-tut-helloWorld-xml.png)

1.  Replace the body of the current script in the source code area with JSON output from
    [Concatenate Two Strings into a Single String](#step_1), and change the
    `output application/json` directive to `output application/xml`:

    ```dw
    %dw 2.0
    output application/xml
    ---
    { "myString" : ("helloWorld") }
    ```

2.  See the XML output in the **Preview** pane:

    ```xml
    <?xml version='1.0' encoding='UTF-8'?>
    <myString>helloWorld</myString>
    ```

    Notice that the `"myString"` key of the input JSON object `{ "myString" : ("helloWorld") }` is
    converted to the root element of the XML output and that the concatenated string becomes the
    value of that XML object. So the XML output is `<myString>helloWorld</myString>`. That output is
    preceded by a standard XML declaration that specifies the XML version and encoding.

    > [!NOTE] Without a _single_ key to serve as a root node for XML output (for example, if the
    > input is simply `("helloWorld")`), the transformation to XML will fail with a yellow warning
    > (**!**) in the source code area. The warning message is
    > `Trying to output non-whitespace characters outside main element tree`. If you like, you can
    > try to produce this warning on your own.

    DataWeave supports many output and input formats. You can learn more about
    [Supported Data Formats](https://docs.mulesoft.com/dataweave/latest/dataweave-formats) when you are ready.

3.  Proceed to [Learn About Supported Data Types](#step_3)

### Learn About Supported Data Types

Now provide a DataWeave script that simply introduces you to a variety of supported data types and
shows how to add comments to a script.

1.  Replace the current script in the source code area of the **Transform Message** tab with this
    one:

    ```dw
    %dw 2.0
    output application/json
    ---
    {
      /*
       * A multi-line
       * comment here.
       */
      myString: "hello world",
      myNumber: 123,
      myFloatingPointNumber: 123.456,
      myVeryBigNumber: 12341234134123412341234123,
      myDate: |2018-12-07|,
      myTime: |11:55:56|,
      myDateTime: |2018-10-01T23:57:59-03:00|,
      myBoolean: true,
      myArray: [ 1, 2, 3, 5, 8],
      myMixedArray: [ 1, 2, "blah", { hello: "there" } ],
      myObjectKeyValuePair: { innerKey: "innerValue" },
      myObjectWithConditionalField: { a : { b : 1, ( c : 2 ) if true, (d : 4) if false } },
      myNull: null,
      myBinary: "abcd1234123" as Binary
      //A one-line comment here.
    }
    ```

    DataWeave supports multi-line comments within `/* */` markup and single-line comments after
    forward slashes (`//`). It also supports many data types, shown after the colon (`:`) in
    key-value pairs, such as `myString: "hello world"` and `myNumber: 123`. These types include
    strings (surrounded by quotation marks, `""`), numbers, date and time structures (within pipes,
    `||`), Booleans (`true` and `false`), arrays (within square brackets, `[]`), JSON-like objects
    (key-value structures within curly braces, `{}`), `null`, and binaries. When you are ready for
    more on this topic, you can review [DataWeave types](https://docs.mulesoft.com/dataweave/latest/dataweave-types).

2.  See the JSON output in the **Preview** pane:

    ```json
    {
      "myString": "hello world",
      "myNumber": 123,
      "myFloatingPointNumber": 123.456,
      "myVeryBigNumber": 12341234134123412341234123,
      "myDate": "2018-12-07",
      "myTime": "11:55:56",
      "myDateTime": "2018-10-01T23:57:59-03:00",
      "myBoolean": true,
      "myArray": [1, 2, 3, 5, 8],
      "myMixedArray": [1, 2, "blah", { "hello": "there" }],
      "myObjectKeyValuePair": { "innerKey": "innerValue" },
      "myObjectWithConditionalField": { "a": { "b": 1, "c": 2 } },
      "myNull": null,
      "myBinary": "abcd1234123"
    }
    ```

3.  Proceed to [Define and Use a DataWeave Variable as Input](#step_4)

### Define and Use a DataWeave Variable as Input

Now try a simple DataWeave script that outputs the value of the DataWeave variable `myJson`. You set
the variable using the `var` directive in the script’s header.

1.  Replace the current script in the source code area of the **Transform Message** tab with this
    one:

    ```dw
    %dw 2.0
    var myJson = { "hello" : "world" }
    output application/json
    ---
    myJson
    ```

    A JSON object (`{ "hello" : "world" }`) is defined as the `myJson` variable in the script’s
    header. You can learn more about [DataWeave Variables](https://docs.mulesoft.com/dataweave/latest/dataweave-variables) when you are ready.

2.  See the output in the **Preview** pane:

    ```json
    {
      "hello": "world"
    }
    ```

3.  Proceed to [Use a DataWeave Function in a DataWeave Variable](#step_5)

### Use a DataWeave Function in a DataWeave Variable

Now try a script that uses the DataWeave `avg` function in a DataWeave variable (`myJson`) to get
averages of two sets of numbers.

![A DataWeave script using a variable in Anypoint Studio](/mulesoft/current/en-us/dataweave/latest/_images/dw-tut-script-studio-var.png)

1.  Replace the current script in the source code area with this one:

    ```dw
    %dw 2.0
    var myJson = {
      a: avg([1, 1000]),
      b: avg([1, 2, 3])
    }
    output application/json
    ---
    myJson
    ```

    The `avg` functions here get invoked when you add `myJson` to the body of the script, producing
    the calculated averages within the JSON object you can see in the **Preview** pane. The
    structures `[1, 1000]` and `[1, 2, 3]` are [arrays](https://docs.mulesoft.com/dataweave/latest/dataweave-types#dw_type_array). You can
    learn more about [avg](https://docs.mulesoft.com/dataweave/latest/dw-core-functions-avg) when you are ready.

2.  Preview the output:

    ```json
    {
      "a": 500.5,
      "b": 2.0
    }
    ```

3.  Proceed to [Read, Transform, and Select Content from an Input](#step_6)

### Read, Transform, and Select Content from an Input

Now try a more complicated script that reads XML input, transforms it to JSON, and only selects the
contents of the `car` element.

1.  Replace the current script in the source code area with this one:

    ```dw
    %dw 2.0
    var myRead = read("<car><color>red</color></car>",
                    "application/xml")
    output application/json
    ---
    {
      mySelection : myRead.car
    }
    ```

    If you encounter an issue previewing this example, try changing `myRead.car` to `myRead."car"`.
    Learn more about the [read](https://docs.mulesoft.com/dataweave/latest/dw-core-functions-read) function,
    [Supported Data Formats](https://docs.mulesoft.com/dataweave/latest/dataweave-formats), and [DataWeave Selectors](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors) when
    you are ready.

2.  Preview the output:

    ```json
    {
      "mySelection": {
        "color": "red"
      }
    }
    ```

3.  Proceed to [Read File Contents with a DataWeave Function](#step_7)

### Read File Contents with a DataWeave Function

Now use `readUrl` to read the contents of a file in the Studio `src/main/resources` folder so you
can use that content as sample data for a DataWeave script.

1.  Add a file by right-clicking the `src/main/resources` folder in the **Package Explorer** tab,
    then navigating to **New** → **File**, providing the file name `myJson.json` for that file, and
    clicking **Finish**.

2.  From `src/main/resources`, provide and save the following sample content in the **myJson.json**
    tab (or within the **Source** sub-tab of the **myJson.json** tab, if it is present):

    ```json
    {
      "hello": "world"
    }
    ```

    ![A Package Explorer tab showing a sample content in Anypoint Studio](/mulesoft/current/en-us/dataweave/latest/_images/dw-tut-sample-file.png)

    Figure 1. myJson.json in Studio

3.  Returning to the Transform Message component within the **testscript** tab, replace the current
    script with one that uses `readUrl` to read the JSON contents from your file:

    ```dw
    %dw 2.0
    output application/json
    ---
    readUrl("classpath://myJson.json", "application/json")
    ```

    Learn more about the [readUrl](https://docs.mulesoft.com/dataweave/latest/dw-core-functions-readurl) function when you are ready.

4.  View the matching output in the **Preview** pane.

    ```json
    {
      "hello": "world"
    }
    ```

    Note that you can also load the contents of a file through a metadata type in the Transform
    Message component. That procedure is covered later, in
    [Run Examples with Longer Payloads](#med_large_payload). It uses the `myJson.json` file you just
    created.

5.  Proceed to [Map Elements from an Array into an Object](#step_8)

### Map Elements from an Array into an Object

Almost all integrations require data mappings. Here, you map elements within an array to keys and
values of a JSON object:

1.  Replace the current script in the source code area with this one:

    ```dw
    %dw 2.0
    output application/json
    ---
    {
      (
        ["a", "b", "c"] map ((value, index) -> {
            (index): value
        })
      )
    }
    ```

    The `map` function iterates over the array on the left to apply the lambda (anonymous function)
    on the right (`((value, index) → { (index): value })`) to elements in that array. The lambda
    uses [named parameters](https://docs.mulesoft.com/dataweave/latest/dataweave-functions-lambdas#_use_named_parameters_in_a_lambda) (`value`
    and `index`) to select the values and indices from the array and populate a JSON object with
    key-value pairs. Learn about [map](https://docs.mulesoft.com/dataweave/latest/dw-core-functions-map), and when you are ready, compare `map`
    with [mapObject](https://docs.mulesoft.com/dataweave/latest/dw-core-functions-mapobject), which takes an object as input.

2.  Preview the output:

    ```json
    {
      "0": "a",
      "1": "b",
      "2": "c"
    }
    ```

3.  Proceed to [Pluck Values from an Object into an Array](#step_9)

### Pluck Values from an Object into an Array

Now use the DataWeave `pluck` function to iterate over values in a JSON object and output those
values into an array.

1.  Replace the contents of the source code area with a script that uses `pluck` on a JSON object:

    ```dw
    %dw 2.0
    output application/json
    ---
    {
      "0": "a",
      "1": "b",
      "2": "c"
    } pluck ((value) -> value)
    ```

    Notice that the input object matches the [output](#output_map) of the `map` example and that the
    output array matches the [input](#input_map) from the `map` example. Learn more about
    [pluck](https://docs.mulesoft.com/dataweave/latest/dw-core-functions-pluck) when you are ready.

2.  Preview the output:

    ```json
    ["a", "b", "c"]
    ```

3.  Proceed to [Map and Merge Fields](#step_10).

### Map and Merge Fields

Now try a more complex example that maps and merges fields from items in separate arrays. The point
here is simply to provide a taste of DataWeave’s ability to handle more complex mappings and
transformations needed for some integrations.

1.  Replace the current script in the source code area with this one:

    ```dw
    %dw 2.0
    var myVar = [
      { bookId: 101,
        title: "world history",
        price: "19.99"
      },
      {
        bookId: 202,
        title: 'the great outdoors',
        price: "15.99"
      }
    ]
    var myVar2 = [
      {
        bookId: 101,
        author: "john doe"
      },
      {
        bookId: 202,
        author: "jane doe"
      }
    ]
    output application/json
    ---
    myVar map (item, index) -> using (id = item.bookId) {
    	"id" : id,
    	"topic" : item.title,
    	"cost" : item.price as Number,
    	(myVar2 filter ($.*bookId contains id) map (item) -> {
    		author : item.author
    	})
    }
    ```

    When you are ready to explore the language further, you can learn how the
    [filter](https://docs.mulesoft.com/dataweave/latest/dw-core-functions-filter) function used near the end returns `author` values from the
    array in the `myVar2` variable. You can read about
    [type coercion with DataWeave](https://docs.mulesoft.com/dataweave/latest/dataweave-types-coercion) to see how `as` works with the data
    type in the line `"cost" : item.price as Number,` to coerce input strings like `"19.99"` into
    numbers like `19.99`. You can see how `using` (shown in `using (id = item.bookId)`) enables you
    to create [local DataWeave variables](https://docs.mulesoft.com/dataweave/latest/dataweave-variables#example_local_variable) in a script.

2.  Preview the output:

    ```json
    [
      {
        "id": "101",
        "topic": "world history",
        "cost": 19.99,
        "author": "john doe"
      },
      {
        "id": "202",
        "topic": "the great outdoors",
        "cost": 15.99,
        "author": "jane doe"
      }
    ]
    ```

3.  Proceed to [Try Out More DataWeave Examples](#more_examples).

## Try Out More DataWeave Examples

Now you are ready to run DataWeave examples on your own. In your DataWeave playground, you can run
examples from the docs whenever you want to discover more about the DataWeave language. You can play
with the examples and use them to start your own scripts.

> [!NOTE] For examples that use `payload` to reference input data (such as the
> [contains](https://docs.mulesoft.com/dataweave/latest/dw-core-functions-contains#contains1) or [mapObject](https://docs.mulesoft.com/dataweave/latest/dw-core-functions-mapobject)
> function examples), you can avoid payload-related issues by using techniques described in
> [Run Examples that Act on a Payload](#provide_payload).

1.  Find many more examples to try out in Studio here:

    - [DataWeave Operators](https://docs.mulesoft.com/dataweave/latest/dw-operators)

    - [DataWeave Reference](https://docs.mulesoft.com/dataweave/latest/dw-functions): Docs on the DataWeave function modules provide many
      examples that use DataWeave functions.

    - [Flow Control in DataWeave](https://docs.mulesoft.com/dataweave/latest/dataweave-flow-control)

    - [Pattern Matching in DataWeave](https://docs.mulesoft.com/dataweave/latest/dataweave-pattern-matching)

    - [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook)

    - [Define DataWeave Functions](https://docs.mulesoft.com/dataweave/latest/dataweave-functions)

2.  Proceed to [Next Steps](#next_steps).

### Run Examples that Act on a Payload

In DataWeave, `payload` is a built-in Mule Runtime variable that holds the contents of a
[Mule message](https://docs.mulesoft.com/mule-runtime/latest/about-mule-message#_message_payload). It enables you to
retrieve the body of a message simply by typing `payload` into the DataWeave script. The docs often
refer to this content as "the payload."

To try out DataWeave examples that use `payload` to get the contents of a Mule message, you have
some options:

- [Run Examples with Short Payloads](#small_payload): You can use a DataWeave variable.

- [Run Examples with Longer Payloads](#med_large_payload): Add the payload content through a file.
  This technique also works for short payloads.

Alternatives that require a running Mule app (such as using
[Set Payload](https://docs.mulesoft.com/mule-runtime/latest/set-payload-transformer-reference)) are not covered here but
are introduced in [Next Steps](#next_steps).

#### Run Examples with Short Payloads

For short examples with a few lines of sample data, you can convert the input payload to a variable.
You simply copy the payload’s content into a DataWeave variable (`var`) in the header of a DataWeave
script. Then, in the body of the script, you replace `payload` with the name of the new variable to
reference that variable.

1.  Start with this script in the source code area:

    ```DataWeave
    %dw 2.0
    output application/json
    ---
    ContainsRequestedItem: payload.root.*order.*items contains "3"
    ```

    Notice that you cannot preview it yet:

    ![A DataWeave script that checks if a payload contains a specific item in Anypoint Studio](/mulesoft/current/en-us/dataweave/latest/_images/dw-tut-payload-example.png)

2.  Now modify this example so that it uses some sample input instead of attempting to use `payload`
    to input content of a Mule message that does not exist:

    1.  Add a `myInput` DataWeave variable supplying some input data the script can read, and change
        the Mule `payload` variable in the body of the script to the DataWeave `myInput` variable.

        ```DataWeave
        %dw 2.0
        var myInput = read("<root>
            <order>
              <items>1</items>
              <items>3</items>
            </order>
            <order>
              <items>2</items>
            </order>
        </root>",
        "application/xml")
        output application/json
        ---
        ContainsRequestedItem: myInput.root.*order.*items contains "3"
        ```

    2.  Preview the results:

        ```json
        {
          "ContainsRequestedItem": true
        }
        ```

        When you are ready, learn more about the [contains](https://docs.mulesoft.com/dataweave/latest/dw-core-functions-contains) function and
        about the built-in `payload` variable, in
        [Predefined Variables](https://docs.mulesoft.com/dataweave/latest/dataweave-variables-context).

#### Run Examples with Longer Payloads

For DataWeave examples with many lines of sample data, consider creating a metadata type through
Transform Message. Metadata types can accept a local file that contains sample data.

1.  Use the [readUrl](#readurl_ex) example to create `src/main/resources/myJson.json` in Studio.

    You can skip this step if you still have the file in Studio. The next steps show how to use the
    contents of this file as your payload.

2.  Now replace the current script from the source code area of the Transform Message with one that
    selects the payload of the input:

    ```dw
    %dw 2.0
    output application/json
    ---
    payload
    ```

3.  Notice that you cannot preview a payload now because it does not exist yet.

    ![A DataWeave script that checks if a payload contains a specific item in Anypoint Studio](/mulesoft/current/en-us/dataweave/latest/_images/dw-tut-payload-example2.png)

4.  Now provide a simple JSON object as the payload of the Transform Message:

    1.  In the **Transform Message** tab, click the _left-most_ rectangle from the **Preview**
        button to open the columned, graphical view next to the source code area:

        ![A Transform Message component to define metadata in Anypoint Studio](/mulesoft/current/en-us/dataweave/latest/_images/studio-define-payload.png)

        If you mouse over that rectangle, you can see the label **Show Graphic**.

    2.  In the left-most column of the **Transform Message** tab, find **Payload: Unknown**, and
        click **Define metadata**.

        If you do not see the **Define metadata** link, simply right-click the **Payload:** entry in
        the left-most column, and then click **Set Metadata** to open the **Select metadata type**
        dialog.

5.  Now load the contents of `myJson.json` (created in the [readUrl](#readurl_ex) example) into the
    Transform Message component:

    1.  Click **+Add** to open the **Create new type** dialog.

    2.  In the dialog, provide the **Type id** `myJsonType`, and click **Create type**.

        ![A dialog for creating a new type](/mulesoft/current/en-us/dataweave/latest/_images/studio-create-type.png)

    3.  Back in the **Select metadata type** dialog that opens, select **JSON** from the **Type**
        drop-down menu.

        ![A Select metadata type dialog to select Type](/mulesoft/current/en-us/dataweave/latest/_images/studio_select_metadata_type.png)

    4.  Below the new type, change **Schema** to **Example** (as shown above).

    5.  Use the navigation button with the ellipsis (**…​**) to find
        `src/main/resources/myJson.json`, and click **Open**, which displays the structure of the
        file contents (`hello: _String_`) in the **Select metadata type** window.

    6.  Now click **Select** to load the contents of the file into the message payload.

    7.  Notice that the JSON object from `myJson.json` is now in the Preview pane.

        If necessary, you can click **Preview** to open the Preview pane.

    8.  Now click the _empty_ rectangle next to the **Preview** button to open the source code area,
        and change the body of the script to `payload.hello`, retaining the existing DataWeave
        header content.

        Notice that the Preview pane now contains only the value of the payload: `"world"`.

        Here is what this example looks like in Studio:

        ![A DataWeave script that outputs the word 'world' in JSON format in Anypoint Studio](/mulesoft/current/en-us/dataweave/latest/_images/dw-tut-world.png)

        Learn more about [DataWeave Selectors](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors) when you are ready.

## Next Steps

- To get started with Mule app development and data mapping through the Studio UI, see
  [Tutorial: Create a Mule app that uses the Database Connector and DataWeave](https://docs.mulesoft.com/mule-runtime/latest/mule-app-tutorial).

- Beyond the Transform Message component, many Mule connectors, modules, and Core components accept
  DataWeave selectors and short DataWeave expressions in their **fx** fields.

  To learn about the components, you can start from
  [Mule Components](https://docs.mulesoft.com/mule-runtime/latest/mule-components).

  To try out sample data in a running Mule app, without relying on external data sources, you can
  use these Core components with or without Transform Message:

  - [Set Payload](https://docs.mulesoft.com/mule-runtime/latest/set-payload-transformer-reference) to provide content
    for the payload of a Mule event.

  - [Set Variable](https://docs.mulesoft.com/mule-runtime/latest/variable-transformer-reference) to create content in a
    Mule event [variable](https://docs.mulesoft.com/mule-runtime/latest/about-mule-variables).

  - [Scheduler](https://docs.mulesoft.com/mule-runtime/latest/scheduler-concept) to trigger the regular generation of
    Mule events.

  - [Logger](https://docs.mulesoft.com/mule-runtime/latest/logger-component-reference) to view output and issues logged
    in the Studio console.

Here is an example that uses some of these components:

![A flow that outputs 'helloWorld' in Anypoint Studio](/mulesoft/current/en-us/dataweave/latest/_images/studio-hello-world.png)

- The **fx** value of Set Payload is set to `output application/json --- { hello : "world"}`.

- The **fx** value of the Logger is set to `payload`, which looks like `#[payload]` in the UI and
  the XML configuration file for the project.

- The **Console** tab of the _running_ Mule app (`testscript`) displays the payload from Set
  Payload.

<!-- document id=2e5c052633880c62079ac8584d1a4fac212f0097e69b73c8a5e844b3fc4f937e url=/mulesoft/current/en-us/dataweave/2.11/dw-functions.md -->

---
product: DataWeave
version: 2.11
---

# DataWeave Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave functions are packaged in modules.

Functions in the Core (`dw::Core`) module are imported automatically into your DataWeave scripts. To
use other modules, you need to import the module or functions you want to use by adding the import
directive to the head of your DataWeave script, for example:

- `import dw::core::Strings`

- `import camelize, capitalize from dw::core::Strings`

- `import * from dw::core::Strings`

The way you import a module impacts the way you need to call its functions from a DataWeave script.
If the directive does not list specific functions to import or use `* from` to import all functions
from a function module, you need to specify the module when you call the function from your script.
For example, this import directive does not identify any functions to import from the String module,
so it calls the `pluralize` function like this: `Strings::pluralize("box")`.

Transform

```dataweave
%dw 2.0
import dw::core::Strings
output application/json
---
{ 'plural': Strings::pluralize("box") }
```

The next example identifies a specific function to import from the String module, so it can call the
method like this: `pluralize("box")`.

Transform

```dataweave
%dw 2.0
import pluralize from dw::core::Strings
output application/json
---
{ 'plural': pluralize("box") }
```

The next example imports all functions from the String module, so it can call the method like this:
`pluralize("box")`.

Transform

```dataweave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{ 'plural': pluralize("box") }
```

## DataWeave Modules

- [Arrays (dw::core::Arrays)](https://docs.mulesoft.com/dataweave/2.11/dw-arrays)

- [Binaries (dw::core::Binaries)](https://docs.mulesoft.com/dataweave/2.11/dw-binaries)

- [Coercions (dw::util::Coercions)](https://docs.mulesoft.com/dataweave/2.11/dw-coercions)

- [Core (dw::Core)](https://docs.mulesoft.com/dataweave/2.11/dw-core)

- [DataFormat (dw::extension::DataFormat)](https://docs.mulesoft.com/dataweave/2.11/dw-dataformat)

- [Dates (dw::core::Dates)](https://docs.mulesoft.com/dataweave/2.11/dw-dates)

- [Diff (dw::util::Diff)](https://docs.mulesoft.com/dataweave/2.11/dw-diff)

- [Dtd (dw::xml::Dtd)](https://docs.mulesoft.com/dataweave/2.11/dw-dtd)

- [Encryption (dw::Crypto)](https://docs.mulesoft.com/dataweave/2.11/dw-crypto)

- [Math (dw::util::Math)](https://docs.mulesoft.com/dataweave/2.11/dw-math)

- [Mime (dw::module::Mime)](https://docs.mulesoft.com/dataweave/2.11/dw-mime)

- [Mule (dw::Mule)](https://docs.mulesoft.com/dataweave/2.11/dw-mule)

- [Multipart (dw::module::Multipart)](https://docs.mulesoft.com/dataweave/2.11/dw-multipart)

- [Numbers (dw::core::Numbers)](https://docs.mulesoft.com/dataweave/2.11/dw-numbers)

- [Objects (dw::core::Objects)](https://docs.mulesoft.com/dataweave/2.11/dw-objects)

- [Periods (dw::core::Periods)](https://docs.mulesoft.com/dataweave/2.11/dw-periods)

- [Runtime (dw::Runtime)](https://docs.mulesoft.com/dataweave/2.11/dw-runtime)

- [Strings (dw::core::Strings)](https://docs.mulesoft.com/dataweave/2.11/dw-strings)

- [System (dw::System)](https://docs.mulesoft.com/dataweave/2.11/dw-system)

- [Timer (dw::util::Timer)](https://docs.mulesoft.com/dataweave/2.11/dw-timer)

- [Tree (dw::util::Tree)](https://docs.mulesoft.com/dataweave/2.11/dw-tree)

- [Types (dw::core::Types)](https://docs.mulesoft.com/dataweave/2.11/dw-types)

- [URL (dw::core::URL)](https://docs.mulesoft.com/dataweave/2.11/dw-url)

- [Values (dw::util::Values)](https://docs.mulesoft.com/dataweave/2.11/dw-values)

## Function Signatures

Each DataWeave function in the DataWeave Reference is identified by its function signature. A
function specifies a function name, zero or more parameters, and a return type.

Basic syntax of a two-parameter function signature:

`function(parameterType,parameterType): returnType`

For example, the signature `contains(String, String): Boolean` for the `contains` function has two
parameters, each of which accepts a value of the String type. The function returns a Boolean value.

Parameters in the function signature correspond, _in order_, to their named parameters, which are
described in Parameters tables for each signature. For example, in
[contains(String, String): Boolean](https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-contains#contains2), the Parameters table
indicates that `text` is the first parameter and `toSearch` is the second.

Many DataWeave functions are overloaded to handle different data types. There is a unique function
signature for each variant of the function. For example, [isEmpty](https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-isempty) is
overloaded to support an input value of an Array, String, Object, or Null type.

For more information on the data types, see [Type System](https://docs.mulesoft.com/dataweave/2.11/dataweave-type-system).

### Type Parameters in Function Signatures

Function signatures can contain type parameters, which are similar to generics in some programming
languages. For example, the `Array<T>` in `contains(Array<T>, Any): Boolean` indicates that the
array can contain elements of any type (`T`) that DataWeave supports. By contrast, an array of a
specific type or types specifies the type, for example, `Array<String>`, `Array<Number>`, or for
both types `Array<String|Number>`.

### Function Types in Function Signatures

Functions can be passed as arguments. Some parameters within function signatures are function types
that take one or more parameters of the form `parameterName:Type` and have a return type
(`→ ReturnType`). For example, the function type `(item: T, index: Number) → R)` is a parameter type
of the [map](https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-map) function
(`map(Array<T>, (item: T, index: Number) → R): Array<R>`). The function type accepts a value of any
type `T` and a value of type Number, which serve as parameters to return a value of type `R`.

## See Also

[Functions](https://docs.mulesoft.com/dataweave/2.11/dataweave-language-guide#functions)

[About DataWeave](https://docs.mulesoft.com/dataweave/2.11/)

[DataWeave Quickstart](https://docs.mulesoft.com/dataweave/2.11/dataweave-quickstart)

<!-- document id=6e24af8a1f685285592fab3bc9e0d6dc58b4ccfdd75f1902838e74885f9dc3be url=/mulesoft/current/en-us/dataweave/2.12/dw-functions.md -->

---
product: DataWeave
version: 2.12
---

# DataWeave Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave functions are packaged in modules.

Functions in the Core (`dw::Core`) module are imported automatically into your DataWeave scripts. To
use other modules, you need to import the module or functions you want to use by adding the import
directive to the head of your DataWeave script, for example:

- `import dw::core::Strings`

- `import camelize, capitalize from dw::core::Strings`

- `import * from dw::core::Strings`

The way you import a module impacts the way you need to call its functions from a DataWeave script.
If the directive does not list specific functions to import or use `* from` to import all functions
from a function module, you need to specify the module when you call the function from your script.
For example, this import directive does not identify any functions to import from the String module,
so it calls the `pluralize` function like this: `Strings::pluralize("box")`.

Transform

```dataweave
%dw 2.0
import dw::core::Strings
output application/json
---
{ 'plural': Strings::pluralize("box") }
```

The next example identifies a specific function to import from the String module, so it can call the
method like this: `pluralize("box")`.

Transform

```dataweave
%dw 2.0
import pluralize from dw::core::Strings
output application/json
---
{ 'plural': pluralize("box") }
```

The next example imports all functions from the String module, so it can call the method like this:
`pluralize("box")`.

Transform

```dataweave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{ 'plural': pluralize("box") }
```

## DataWeave Modules

- [Arrays (dw::core::Arrays)](https://docs.mulesoft.com/dataweave/2.12/dw-arrays)

- [Binaries (dw::core::Binaries)](https://docs.mulesoft.com/dataweave/2.12/dw-binaries)

- [Coercions (dw::util::Coercions)](https://docs.mulesoft.com/dataweave/2.12/dw-coercions)

- [Core (dw::Core)](https://docs.mulesoft.com/dataweave/2.12/dw-core)

- [DataFormat (dw::extension::DataFormat)](https://docs.mulesoft.com/dataweave/2.12/dw-dataformat)

- [Dates (dw::core::Dates)](https://docs.mulesoft.com/dataweave/2.12/dw-dates)

- [Diff (dw::util::Diff)](https://docs.mulesoft.com/dataweave/2.12/dw-diff)

- [Dtd (dw::xml::Dtd)](https://docs.mulesoft.com/dataweave/2.12/dw-dtd)

- [Encryption (dw::Crypto)](https://docs.mulesoft.com/dataweave/2.12/dw-crypto)

- [Math (dw::util::Math)](https://docs.mulesoft.com/dataweave/2.12/dw-math)

- [Mime (dw::module::Mime)](https://docs.mulesoft.com/dataweave/2.12/dw-mime)

- [Mule (dw::Mule)](https://docs.mulesoft.com/dataweave/2.12/dw-mule)

- [Multipart (dw::module::Multipart)](https://docs.mulesoft.com/dataweave/2.12/dw-multipart)

- [Numbers (dw::core::Numbers)](https://docs.mulesoft.com/dataweave/2.12/dw-numbers)

- [Objects (dw::core::Objects)](https://docs.mulesoft.com/dataweave/2.12/dw-objects)

- [Periods (dw::core::Periods)](https://docs.mulesoft.com/dataweave/2.12/dw-periods)

- [Runtime (dw::Runtime)](https://docs.mulesoft.com/dataweave/2.12/dw-runtime)

- [Strings (dw::core::Strings)](https://docs.mulesoft.com/dataweave/2.12/dw-strings)

- [System (dw::System)](https://docs.mulesoft.com/dataweave/2.12/dw-system)

- [Timer (dw::util::Timer)](https://docs.mulesoft.com/dataweave/2.12/dw-timer)

- [Tree (dw::util::Tree)](https://docs.mulesoft.com/dataweave/2.12/dw-tree)

- [Types (dw::core::Types)](https://docs.mulesoft.com/dataweave/2.12/dw-types)

- [URL (dw::core::URL)](https://docs.mulesoft.com/dataweave/2.12/dw-url)

- [Values (dw::util::Values)](https://docs.mulesoft.com/dataweave/2.12/dw-values)

## Function Signatures

Each DataWeave function in the DataWeave Reference is identified by its function signature. A
function specifies a function name, zero or more parameters, and a return type.

Basic syntax of a two-parameter function signature:

`function(parameterType,parameterType): returnType`

For example, the signature `contains(String, String): Boolean` for the `contains` function has two
parameters, each of which accepts a value of the String type. The function returns a Boolean value.

Parameters in the function signature correspond, _in order_, to their named parameters, which are
described in Parameters tables for each signature. For example, in
[contains(String, String): Boolean](https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-contains#contains2), the Parameters table
indicates that `text` is the first parameter and `toSearch` is the second.

Many DataWeave functions are overloaded to handle different data types. There is a unique function
signature for each variant of the function. For example, [isEmpty](https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-isempty) is
overloaded to support an input value of an Array, String, Object, or Null type.

For more information on the data types, see [Type System](https://docs.mulesoft.com/dataweave/2.12/dataweave-type-system).

### Type Parameters in Function Signatures

Function signatures can contain type parameters, which are similar to generics in some programming
languages. For example, the `Array<T>` in `contains(Array<T>, Any): Boolean` indicates that the
array can contain elements of any type (`T`) that DataWeave supports. By contrast, an array of a
specific type or types specifies the type, for example, `Array<String>`, `Array<Number>`, or for
both types `Array<String|Number>`.

### Function Types in Function Signatures

Functions can be passed as arguments. Some parameters within function signatures are function types
that take one or more parameters of the form `parameterName:Type` and have a return type
(`→ ReturnType`). For example, the function type `(item: T, index: Number) → R)` is a parameter type
of the [map](https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-map) function
(`map(Array<T>, (item: T, index: Number) → R): Array<R>`). The function type accepts a value of any
type `T` and a value of type Number, which serve as parameters to return a value of type `R`.

## See Also

[Functions](https://docs.mulesoft.com/dataweave/2.12/dataweave-language-guide#functions)

[About DataWeave](https://docs.mulesoft.com/dataweave/2.12/)

[DataWeave Quickstart](https://docs.mulesoft.com/dataweave/2.12/dataweave-quickstart)

<!-- document id=cbff9050f0b9317015918e77c5d8362defa75fbfc8a389f0fedf14982803b2aa url=/mulesoft/current/en-us/dataweave/2.3/dw-functions.md -->

---
product: DataWeave
version: 2.3
---

# DataWeave Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave version 2 functions are packaged in modules.

Functions in the Core (`dw::Core`) module are imported automatically into your DataWeave scripts. To
use other modules, you need to import the module or functions you want to use by adding the import
directive to the head of your DataWeave script, for example:

- `import dw::core::Strings`

- `import camelize, capitalize from dw::core::Strings`

- `import * from dw::core::Strings`

The way you import a module impacts the way you need to call its functions from a DataWeave script.
If the directive does not list specific functions to import or use `* from` to import all functions
from a function module, you need to specify the module when you call the function from your script.
For example, this import directive does not identify any functions to import from the String module,
so it calls the `pluralize` function like this: `Strings::pluralize("box")`.

Transform

```dataweave
%dw 2.0
import dw::core::Strings
output application/json
---
{ 'plural': Strings::pluralize("box") }
```

The next example identifies a specific function to import from the String module, so it can call the
method like this: `pluralize("box")`.

Transform

```dataweave
%dw 2.0
import pluralize from dw::core::Strings
output application/json
---
{ 'plural': pluralize("box") }
```

The next example imports all functions from the String module, so it can call the method like this:
`pluralize("box")`.

Transform

```dataweave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{ 'plural': pluralize("box") }
```

## DataWeave Modules

- [Arrays (dw::core::Arrays)](https://docs.mulesoft.com/dataweave/2.3/dw-arrays)

- [Binaries (dw::core::Binaries)](https://docs.mulesoft.com/dataweave/2.3/dw-binaries)

- [Core (dw::Core)](https://docs.mulesoft.com/dataweave/2.3/dw-core)

- [Encryption (dw::Crypto)](https://docs.mulesoft.com/dataweave/2.3/dw-crypto)

- [Diff (dw::util::Diff)](https://docs.mulesoft.com/dataweave/2.3/dw-diff)

- [Objects (dw::core::Objects)](https://docs.mulesoft.com/dataweave/2.3/dw-objects)

- [Runtime (dw::Runtime)](https://docs.mulesoft.com/dataweave/2.3/dw-runtime)

- [Strings (dw::core::Strings)](https://docs.mulesoft.com/dataweave/2.3/dw-strings)

- [System (dw::System)](https://docs.mulesoft.com/dataweave/2.3/dw-system)

- [URL (dw::core::URL)](https://docs.mulesoft.com/dataweave/2.3/dw-url)

## Function Signatures

Each DataWeave function in the DataWeave Reference is identified by its function signature. A
function specifies a function name, zero or more parameters, and a return type.

Basic syntax of a two-parameter function signature:

`function(parameterType,parameterType): returnType`

For example, the signature `contains(String, String): Boolean` for the `contains` function has two
parameters, each of which accepts a value of the String type. The function returns a Boolean value.

Parameters in the function signature correspond, _in order_, to their named parameters, which are
described in Parameters tables for each signature. For example, in
[contains(String, String): Boolean](https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-contains#contains2), the Parameters table
indicates that `text` is the first parameter and `toSearch` is the second.

Many DataWeave functions are overloaded to handle different data types. There is a unique function
signature for each variant of the function. For example, [isEmpty](https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-isempty) is
overloaded to support an input value of an Array, String, Object, or Null type.

For more information on the data types, see [Type System](https://docs.mulesoft.com/dataweave/2.3/dataweave-type-system).

### Type Parameters in Function Signatures

Function signatures can contain type parameters, which are similar to generics in some programming
languages. For example, the `Array<T>` in `contains(Array<T>, Any): Boolean` indicates that the
array can contain elements of any type (`T`) that DataWeave supports. By contrast, an array of a
specific type or types specifies the type, for example, `Array<String>`, `Array<Number>`, or for
both types `Array<String|Number>`.

### Function Types in Function Signatures

Functions can be passed as arguments. Some parameters within function signatures are function types
that take one or more parameters of the form `parameterName:Type` and have a return type
(`→ ReturnType`). For example, the function type `(item: T, index: Number) → R)` is a parameter type
of the [map](https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-map) function
(`map(Array<T>, (item: T, index: Number) → R): Array<R>`). The function type accepts a value of any
type `T` and a value of type Number, which serve as parameters to return a value of type `R`.

## See Also

[Functions](https://docs.mulesoft.com/dataweave/2.3/dataweave-language-guide#functions)

[DataWeave Language](https://docs.mulesoft.com/dataweave/2.3/)

[DataWeave Quickstart](https://docs.mulesoft.com/dataweave/2.3/dataweave-quickstart)

<!-- document id=02f217cbfea251b30239d1ca5406962c52da0cfd3751a4ed4f67b701d1fe2283 url=/mulesoft/current/en-us/dataweave/2.4/dw-functions.md -->

---
product: DataWeave
version: 2.4
---

# DataWeave Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave functions are packaged in modules.

Functions in the Core (`dw::Core`) module are imported automatically into your DataWeave scripts. To
use other modules, you need to import the module or functions you want to use by adding the import
directive to the head of your DataWeave script, for example:

- `import dw::core::Strings`

- `import camelize, capitalize from dw::core::Strings`

- `import * from dw::core::Strings`

The way you import a module impacts the way you need to call its functions from a DataWeave script.
If the directive does not list specific functions to import or use `* from` to import all functions
from a function module, you need to specify the module when you call the function from your script.
For example, this import directive does not identify any functions to import from the String module,
so it calls the `pluralize` function like this: `Strings::pluralize("box")`.

Transform

```dataweave
%dw 2.0
import dw::core::Strings
output application/json
---
{ 'plural': Strings::pluralize("box") }
```

The next example identifies a specific function to import from the String module, so it can call the
method like this: `pluralize("box")`.

Transform

```dataweave
%dw 2.0
import pluralize from dw::core::Strings
output application/json
---
{ 'plural': pluralize("box") }
```

The next example imports all functions from the String module, so it can call the method like this:
`pluralize("box")`.

Transform

```dataweave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{ 'plural': pluralize("box") }
```

## DataWeave Modules

- [Arrays (dw::core::Arrays)](https://docs.mulesoft.com/dataweave/2.4/dw-arrays)

- [Binaries (dw::core::Binaries)](https://docs.mulesoft.com/dataweave/2.4/dw-binaries)

- [Coercions (dw::util::Coercions)](https://docs.mulesoft.com/dataweave/2.4/dw-coercions)

- [Core (dw::Core)](https://docs.mulesoft.com/dataweave/2.4/dw-core)

- [DataFormat (dw::extension::DataFormat)](https://docs.mulesoft.com/dataweave/2.4/dw-dataformat)

- [Dates (dw::core::Dates)](https://docs.mulesoft.com/dataweave/2.4/dw-dates)

- [Diff (dw::util::Diff)](https://docs.mulesoft.com/dataweave/2.4/dw-diff)

- [Encryption (dw::Crypto)](https://docs.mulesoft.com/dataweave/2.4/dw-crypto)

- [Math (dw::util::Math)](https://docs.mulesoft.com/dataweave/2.4/dw-math)

- [Mule (dw::Mule)](https://docs.mulesoft.com/dataweave/2.4/dw-mule)

- [Multipart (dw::module::Multipart)](https://docs.mulesoft.com/dataweave/2.4/dw-multipart)

- [Numbers (dw::core::Numbers)](https://docs.mulesoft.com/dataweave/2.4/dw-numbers)

- [Objects (dw::core::Objects)](https://docs.mulesoft.com/dataweave/2.4/dw-objects)

- [Periods (dw::core::Periods)](https://docs.mulesoft.com/dataweave/2.4/dw-periods)

- [Runtime (dw::Runtime)](https://docs.mulesoft.com/dataweave/2.4/dw-runtime)

- [Strings (dw::core::Strings)](https://docs.mulesoft.com/dataweave/2.4/dw-strings)

- [System (dw::System)](https://docs.mulesoft.com/dataweave/2.4/dw-system)

- [Timer (dw::util::Timer)](https://docs.mulesoft.com/dataweave/2.4/dw-timer)

- [Tree (dw::util::Tree)](https://docs.mulesoft.com/dataweave/2.4/dw-tree)

- [Types (dw::core::Types)](https://docs.mulesoft.com/dataweave/2.4/dw-types)

- [URL (dw::core::URL)](https://docs.mulesoft.com/dataweave/2.4/dw-url)

- [Values (dw::util::Values)](https://docs.mulesoft.com/dataweave/2.4/dw-values)

## Function Signatures

Each DataWeave function in the DataWeave Reference is identified by its function signature. A
function specifies a function name, zero or more parameters, and a return type.

Basic syntax of a two-parameter function signature:

`function(parameterType,parameterType): returnType`

For example, the signature `contains(String, String): Boolean` for the `contains` function has two
parameters, each of which accepts a value of the String type. The function returns a Boolean value.

Parameters in the function signature correspond, _in order_, to their named parameters, which are
described in Parameters tables for each signature. For example, in
[contains(String, String): Boolean](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-contains#contains2), the Parameters table
indicates that `text` is the first parameter and `toSearch` is the second.

Many DataWeave functions are overloaded to handle different data types. There is a unique function
signature for each variant of the function. For example, [isEmpty](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-isempty) is
overloaded to support an input value of an Array, String, Object, or Null type.

For more information on the data types, see [Type System](https://docs.mulesoft.com/dataweave/2.4/dataweave-type-system).

### Type Parameters in Function Signatures

Function signatures can contain type parameters, which are similar to generics in some programming
languages. For example, the `Array<T>` in `contains(Array<T>, Any): Boolean` indicates that the
array can contain elements of any type (`T`) that DataWeave supports. By contrast, an array of a
specific type or types specifies the type, for example, `Array<String>`, `Array<Number>`, or for
both types `Array<String|Number>`.

### Function Types in Function Signatures

Functions can be passed as arguments. Some parameters within function signatures are function types
that take one or more parameters of the form `parameterName:Type` and have a return type
(`→ ReturnType`). For example, the function type `(item: T, index: Number) → R)` is a parameter type
of the [map](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-map) function
(`map(Array<T>, (item: T, index: Number) → R): Array<R>`). The function type accepts a value of any
type `T` and a value of type Number, which serve as parameters to return a value of type `R`.

## See Also

[Functions](https://docs.mulesoft.com/dataweave/2.4/dataweave-language-guide#functions)

[About DataWeave](https://docs.mulesoft.com/dataweave/2.4/)

[DataWeave Quickstart](https://docs.mulesoft.com/dataweave/2.4/dataweave-quickstart)

<!-- document id=d463e02ce05e2f09b42225f7a62198549df43ae9da8e101373d99c6d1e7da798 url=/mulesoft/current/en-us/dataweave/2.6/dw-functions.md -->

---
product: DataWeave
version: 2.6
---

# DataWeave Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave functions are packaged in modules.

Functions in the Core (`dw::Core`) module are imported automatically into your DataWeave scripts. To
use other modules, you need to import the module or functions you want to use by adding the import
directive to the head of your DataWeave script, for example:

- `import dw::core::Strings`

- `import camelize, capitalize from dw::core::Strings`

- `import * from dw::core::Strings`

The way you import a module impacts the way you need to call its functions from a DataWeave script.
If the directive does not list specific functions to import or use `* from` to import all functions
from a function module, you need to specify the module when you call the function from your script.
For example, this import directive does not identify any functions to import from the String module,
so it calls the `pluralize` function like this: `Strings::pluralize("box")`.

Transform

```dataweave
%dw 2.0
import dw::core::Strings
output application/json
---
{ 'plural': Strings::pluralize("box") }
```

The next example identifies a specific function to import from the String module, so it can call the
method like this: `pluralize("box")`.

Transform

```dataweave
%dw 2.0
import pluralize from dw::core::Strings
output application/json
---
{ 'plural': pluralize("box") }
```

The next example imports all functions from the String module, so it can call the method like this:
`pluralize("box")`.

Transform

```dataweave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{ 'plural': pluralize("box") }
```

## DataWeave Modules

- [Arrays (dw::core::Arrays)](https://docs.mulesoft.com/dataweave/2.6/dw-arrays)

- [Binaries (dw::core::Binaries)](https://docs.mulesoft.com/dataweave/2.6/dw-binaries)

- [Coercions (dw::util::Coercions)](https://docs.mulesoft.com/dataweave/2.6/dw-coercions)

- [Core (dw::Core)](https://docs.mulesoft.com/dataweave/2.6/dw-core)

- [DataFormat (dw::extension::DataFormat)](https://docs.mulesoft.com/dataweave/2.6/dw-dataformat)

- [Dates (dw::core::Dates)](https://docs.mulesoft.com/dataweave/2.6/dw-dates)

- [Diff (dw::util::Diff)](https://docs.mulesoft.com/dataweave/2.6/dw-diff)

- [Dtd (dw::xml::Dtd)](https://docs.mulesoft.com/dataweave/2.6/dw-dtd)

- [Encryption (dw::Crypto)](https://docs.mulesoft.com/dataweave/2.6/dw-crypto)

- [Math (dw::util::Math)](https://docs.mulesoft.com/dataweave/2.6/dw-math)

- [Mule (dw::Mule)](https://docs.mulesoft.com/dataweave/2.6/dw-mule)

- [Multipart (dw::module::Multipart)](https://docs.mulesoft.com/dataweave/2.6/dw-multipart)

- [Numbers (dw::core::Numbers)](https://docs.mulesoft.com/dataweave/2.6/dw-numbers)

- [Objects (dw::core::Objects)](https://docs.mulesoft.com/dataweave/2.6/dw-objects)

- [Periods (dw::core::Periods)](https://docs.mulesoft.com/dataweave/2.6/dw-periods)

- [Runtime (dw::Runtime)](https://docs.mulesoft.com/dataweave/2.6/dw-runtime)

- [Strings (dw::core::Strings)](https://docs.mulesoft.com/dataweave/2.6/dw-strings)

- [System (dw::System)](https://docs.mulesoft.com/dataweave/2.6/dw-system)

- [Timer (dw::util::Timer)](https://docs.mulesoft.com/dataweave/2.6/dw-timer)

- [Tree (dw::util::Tree)](https://docs.mulesoft.com/dataweave/2.6/dw-tree)

- [Types (dw::core::Types)](https://docs.mulesoft.com/dataweave/2.6/dw-types)

- [URL (dw::core::URL)](https://docs.mulesoft.com/dataweave/2.6/dw-url)

- [Values (dw::util::Values)](https://docs.mulesoft.com/dataweave/2.6/dw-values)

## Function Signatures

Each DataWeave function in the DataWeave Reference is identified by its function signature. A
function specifies a function name, zero or more parameters, and a return type.

Basic syntax of a two-parameter function signature:

`function(parameterType,parameterType): returnType`

For example, the signature `contains(String, String): Boolean` for the `contains` function has two
parameters, each of which accepts a value of the String type. The function returns a Boolean value.

Parameters in the function signature correspond, _in order_, to their named parameters, which are
described in Parameters tables for each signature. For example, in
[contains(String, String): Boolean](https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-contains#contains2), the Parameters table
indicates that `text` is the first parameter and `toSearch` is the second.

Many DataWeave functions are overloaded to handle different data types. There is a unique function
signature for each variant of the function. For example, [isEmpty](https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-isempty) is
overloaded to support an input value of an Array, String, Object, or Null type.

For more information on the data types, see [Type System](https://docs.mulesoft.com/dataweave/2.6/dataweave-type-system).

### Type Parameters in Function Signatures

Function signatures can contain type parameters, which are similar to generics in some programming
languages. For example, the `Array<T>` in `contains(Array<T>, Any): Boolean` indicates that the
array can contain elements of any type (`T`) that DataWeave supports. By contrast, an array of a
specific type or types specifies the type, for example, `Array<String>`, `Array<Number>`, or for
both types `Array<String|Number>`.

### Function Types in Function Signatures

Functions can be passed as arguments. Some parameters within function signatures are function types
that take one or more parameters of the form `parameterName:Type` and have a return type
(`→ ReturnType`). For example, the function type `(item: T, index: Number) → R)` is a parameter type
of the [map](https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-map) function
(`map(Array<T>, (item: T, index: Number) → R): Array<R>`). The function type accepts a value of any
type `T` and a value of type Number, which serve as parameters to return a value of type `R`.

## See Also

[Functions](https://docs.mulesoft.com/dataweave/2.6/dataweave-language-guide#functions)

[About DataWeave](https://docs.mulesoft.com/dataweave/2.6/)

[DataWeave Quickstart](https://docs.mulesoft.com/dataweave/2.6/dataweave-quickstart)

<!-- document id=d5d2ba1537f222c490b15f2c2f033e022b4a2c07bad17e3fd6077cd270f86e44 url=/mulesoft/current/en-us/dataweave/2.9/dw-functions.md -->

---
product: DataWeave
version: 2.9
---

# DataWeave Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave functions are packaged in modules.

Functions in the Core (`dw::Core`) module are imported automatically into your DataWeave scripts. To
use other modules, you need to import the module or functions you want to use by adding the import
directive to the head of your DataWeave script, for example:

- `import dw::core::Strings`

- `import camelize, capitalize from dw::core::Strings`

- `import * from dw::core::Strings`

The way you import a module impacts the way you need to call its functions from a DataWeave script.
If the directive does not list specific functions to import or use `* from` to import all functions
from a function module, you need to specify the module when you call the function from your script.
For example, this import directive does not identify any functions to import from the String module,
so it calls the `pluralize` function like this: `Strings::pluralize("box")`.

Transform

```dataweave
%dw 2.0
import dw::core::Strings
output application/json
---
{ 'plural': Strings::pluralize("box") }
```

The next example identifies a specific function to import from the String module, so it can call the
method like this: `pluralize("box")`.

Transform

```dataweave
%dw 2.0
import pluralize from dw::core::Strings
output application/json
---
{ 'plural': pluralize("box") }
```

The next example imports all functions from the String module, so it can call the method like this:
`pluralize("box")`.

Transform

```dataweave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{ 'plural': pluralize("box") }
```

## DataWeave Modules

- [Arrays (dw::core::Arrays)](https://docs.mulesoft.com/dataweave/2.9/dw-arrays)

- [Binaries (dw::core::Binaries)](https://docs.mulesoft.com/dataweave/2.9/dw-binaries)

- [Coercions (dw::util::Coercions)](https://docs.mulesoft.com/dataweave/2.9/dw-coercions)

- [Core (dw::Core)](https://docs.mulesoft.com/dataweave/2.9/dw-core)

- [DataFormat (dw::extension::DataFormat)](https://docs.mulesoft.com/dataweave/2.9/dw-dataformat)

- [Dates (dw::core::Dates)](https://docs.mulesoft.com/dataweave/2.9/dw-dates)

- [Diff (dw::util::Diff)](https://docs.mulesoft.com/dataweave/2.9/dw-diff)

- [Dtd (dw::xml::Dtd)](https://docs.mulesoft.com/dataweave/2.9/dw-dtd)

- [Encryption (dw::Crypto)](https://docs.mulesoft.com/dataweave/2.9/dw-crypto)

- [Math (dw::util::Math)](https://docs.mulesoft.com/dataweave/2.9/dw-math)

- [Mime (dw::module::Mime)](https://docs.mulesoft.com/dataweave/2.9/dw-mime)

- [Mule (dw::Mule)](https://docs.mulesoft.com/dataweave/2.9/dw-mule)

- [Multipart (dw::module::Multipart)](https://docs.mulesoft.com/dataweave/2.9/dw-multipart)

- [Numbers (dw::core::Numbers)](https://docs.mulesoft.com/dataweave/2.9/dw-numbers)

- [Objects (dw::core::Objects)](https://docs.mulesoft.com/dataweave/2.9/dw-objects)

- [Periods (dw::core::Periods)](https://docs.mulesoft.com/dataweave/2.9/dw-periods)

- [Runtime (dw::Runtime)](https://docs.mulesoft.com/dataweave/2.9/dw-runtime)

- [Strings (dw::core::Strings)](https://docs.mulesoft.com/dataweave/2.9/dw-strings)

- [System (dw::System)](https://docs.mulesoft.com/dataweave/2.9/dw-system)

- [Timer (dw::util::Timer)](https://docs.mulesoft.com/dataweave/2.9/dw-timer)

- [Tree (dw::util::Tree)](https://docs.mulesoft.com/dataweave/2.9/dw-tree)

- [Types (dw::core::Types)](https://docs.mulesoft.com/dataweave/2.9/dw-types)

- [URL (dw::core::URL)](https://docs.mulesoft.com/dataweave/2.9/dw-url)

- [Values (dw::util::Values)](https://docs.mulesoft.com/dataweave/2.9/dw-values)

## Function Signatures

Each DataWeave function in the DataWeave Reference is identified by its function signature. A
function specifies a function name, zero or more parameters, and a return type.

Basic syntax of a two-parameter function signature:

`function(parameterType,parameterType): returnType`

For example, the signature `contains(String, String): Boolean` for the `contains` function has two
parameters, each of which accepts a value of the String type. The function returns a Boolean value.

Parameters in the function signature correspond, _in order_, to their named parameters, which are
described in Parameters tables for each signature. For example, in
[contains(String, String): Boolean](https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-contains#contains2), the Parameters table
indicates that `text` is the first parameter and `toSearch` is the second.

Many DataWeave functions are overloaded to handle different data types. There is a unique function
signature for each variant of the function. For example, [isEmpty](https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-isempty) is
overloaded to support an input value of an Array, String, Object, or Null type.

For more information on the data types, see [Type System](https://docs.mulesoft.com/dataweave/2.9/dataweave-type-system).

### Type Parameters in Function Signatures

Function signatures can contain type parameters, which are similar to generics in some programming
languages. For example, the `Array<T>` in `contains(Array<T>, Any): Boolean` indicates that the
array can contain elements of any type (`T`) that DataWeave supports. By contrast, an array of a
specific type or types specifies the type, for example, `Array<String>`, `Array<Number>`, or for
both types `Array<String|Number>`.

### Function Types in Function Signatures

Functions can be passed as arguments. Some parameters within function signatures are function types
that take one or more parameters of the form `parameterName:Type` and have a return type
(`→ ReturnType`). For example, the function type `(item: T, index: Number) → R)` is a parameter type
of the [map](https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-map) function
(`map(Array<T>, (item: T, index: Number) → R): Array<R>`). The function type accepts a value of any
type `T` and a value of type Number, which serve as parameters to return a value of type `R`.

## See Also

[Functions](https://docs.mulesoft.com/dataweave/2.9/dataweave-language-guide#functions)

[About DataWeave](https://docs.mulesoft.com/dataweave/2.9/)

[DataWeave Quickstart](https://docs.mulesoft.com/dataweave/2.9/dataweave-quickstart)

<!-- document id=0d5cbdcfd0c36766b169869614ef3d7c63d0b3c911b0e890d3d01393ed52f681 url=/mulesoft/current/en-us/dataweave/latest/dw-functions.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# DataWeave Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave functions are packaged in modules.

Functions in the Core (`dw::Core`) module are imported automatically into your DataWeave scripts. To
use other modules, you need to import the module or functions you want to use by adding the import
directive to the head of your DataWeave script, for example:

- `import dw::core::Strings`

- `import camelize, capitalize from dw::core::Strings`

- `import * from dw::core::Strings`

The way you import a module impacts the way you need to call its functions from a DataWeave script.
If the directive does not list specific functions to import or use `* from` to import all functions
from a function module, you need to specify the module when you call the function from your script.
For example, this import directive does not identify any functions to import from the String module,
so it calls the `pluralize` function like this: `Strings::pluralize("box")`.

Transform

```dataweave
%dw 2.0
import dw::core::Strings
output application/json
---
{ 'plural': Strings::pluralize("box") }
```

The next example identifies a specific function to import from the String module, so it can call the
method like this: `pluralize("box")`.

Transform

```dataweave
%dw 2.0
import pluralize from dw::core::Strings
output application/json
---
{ 'plural': pluralize("box") }
```

The next example imports all functions from the String module, so it can call the method like this:
`pluralize("box")`.

Transform

```dataweave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{ 'plural': pluralize("box") }
```

## DataWeave Modules

- [Arrays (dw::core::Arrays)](https://docs.mulesoft.com/dataweave/latest/dw-arrays)

- [Binaries (dw::core::Binaries)](https://docs.mulesoft.com/dataweave/latest/dw-binaries)

- [Coercions (dw::util::Coercions)](https://docs.mulesoft.com/dataweave/latest/dw-coercions)

- [Core (dw::Core)](https://docs.mulesoft.com/dataweave/latest/dw-core)

- [DataFormat (dw::extension::DataFormat)](https://docs.mulesoft.com/dataweave/latest/dw-dataformat)

- [Dates (dw::core::Dates)](https://docs.mulesoft.com/dataweave/latest/dw-dates)

- [Diff (dw::util::Diff)](https://docs.mulesoft.com/dataweave/latest/dw-diff)

- [Dtd (dw::xml::Dtd)](https://docs.mulesoft.com/dataweave/latest/dw-dtd)

- [Encryption (dw::Crypto)](https://docs.mulesoft.com/dataweave/latest/dw-crypto)

- [Math (dw::util::Math)](https://docs.mulesoft.com/dataweave/latest/dw-math)

- [Mime (dw::module::Mime)](https://docs.mulesoft.com/dataweave/latest/dw-mime)

- [Mule (dw::Mule)](https://docs.mulesoft.com/dataweave/latest/dw-mule)

- [Multipart (dw::module::Multipart)](https://docs.mulesoft.com/dataweave/latest/dw-multipart)

- [Numbers (dw::core::Numbers)](https://docs.mulesoft.com/dataweave/latest/dw-numbers)

- [Objects (dw::core::Objects)](https://docs.mulesoft.com/dataweave/latest/dw-objects)

- [Periods (dw::core::Periods)](https://docs.mulesoft.com/dataweave/latest/dw-periods)

- [Runtime (dw::Runtime)](https://docs.mulesoft.com/dataweave/latest/dw-runtime)

- [Strings (dw::core::Strings)](https://docs.mulesoft.com/dataweave/latest/dw-strings)

- [System (dw::System)](https://docs.mulesoft.com/dataweave/latest/dw-system)

- [Timer (dw::util::Timer)](https://docs.mulesoft.com/dataweave/latest/dw-timer)

- [Tree (dw::util::Tree)](https://docs.mulesoft.com/dataweave/latest/dw-tree)

- [Types (dw::core::Types)](https://docs.mulesoft.com/dataweave/latest/dw-types)

- [URL (dw::core::URL)](https://docs.mulesoft.com/dataweave/latest/dw-url)

- [Values (dw::util::Values)](https://docs.mulesoft.com/dataweave/latest/dw-values)

## Function Signatures

Each DataWeave function in the DataWeave Reference is identified by its function signature. A
function specifies a function name, zero or more parameters, and a return type.

Basic syntax of a two-parameter function signature:

`function(parameterType,parameterType): returnType`

For example, the signature `contains(String, String): Boolean` for the `contains` function has two
parameters, each of which accepts a value of the String type. The function returns a Boolean value.

Parameters in the function signature correspond, _in order_, to their named parameters, which are
described in Parameters tables for each signature. For example, in
[contains(String, String): Boolean](https://docs.mulesoft.com/dataweave/latest/dw-core-functions-contains#contains2), the Parameters table
indicates that `text` is the first parameter and `toSearch` is the second.

Many DataWeave functions are overloaded to handle different data types. There is a unique function
signature for each variant of the function. For example, [isEmpty](https://docs.mulesoft.com/dataweave/latest/dw-core-functions-isempty) is
overloaded to support an input value of an Array, String, Object, or Null type.

For more information on the data types, see [Type System](https://docs.mulesoft.com/dataweave/latest/dataweave-type-system).

### Type Parameters in Function Signatures

Function signatures can contain type parameters, which are similar to generics in some programming
languages. For example, the `Array<T>` in `contains(Array<T>, Any): Boolean` indicates that the
array can contain elements of any type (`T`) that DataWeave supports. By contrast, an array of a
specific type or types specifies the type, for example, `Array<String>`, `Array<Number>`, or for
both types `Array<String|Number>`.

### Function Types in Function Signatures

Functions can be passed as arguments. Some parameters within function signatures are function types
that take one or more parameters of the form `parameterName:Type` and have a return type
(`→ ReturnType`). For example, the function type `(item: T, index: Number) → R)` is a parameter type
of the [map](https://docs.mulesoft.com/dataweave/latest/dw-core-functions-map) function
(`map(Array<T>, (item: T, index: Number) → R): Array<R>`). The function type accepts a value of any
type `T` and a value of type Number, which serve as parameters to return a value of type `R`.

## See Also

[Functions](https://docs.mulesoft.com/dataweave/latest/dataweave-language-guide#functions)

[About DataWeave](https://docs.mulesoft.com/dataweave/latest/)

[DataWeave Quickstart](https://docs.mulesoft.com/dataweave/latest/dataweave-quickstart)

<!-- document id=8cb8056fea826d87183647f8bf124302442ad8dee4d9be698ccb854869ef3e33 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-release-notes.md -->

---
product: DataWeave
version: 2.11
---

# DataWeave Release Notes

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This MuleSoft programming language simplifies data transformation tasks and serves as Mule runtime’s
expression language for configuring components and connectors. Build powerful integration solutions
with intuitive scripting capabilities.

Release notes for each DataWeave version include bug fixes, compatibility information, and patch
update release details, in addition to new features and other information about DataWeave releases:

- [DataWeave 2.13.0](https://docs.mulesoft.com/release-notes/dataweave/dataweave-2.13.0-release-notes)

- [DataWeave 2.12.0](https://docs.mulesoft.com/release-notes/dataweave/dataweave-2.12.0-release-notes)

- [DataWeave 2.11.0](https://docs.mulesoft.com/release-notes/dataweave/dataweave-2.11.0-release-notes)

- [DataWeave 2.9.0](https://docs.mulesoft.com/release-notes/dataweave/dataweave-2.9.0-release-notes)

- [DataWeave 2.6.0](https://docs.mulesoft.com/release-notes/dataweave/dataweave-2.6.0-release-notes)

- [DataWeave 2.4.0](https://docs.mulesoft.com/release-notes/dataweave/dataweave-2.4.0-release-notes) (This version of
  the product has reached
  [End of Life](https://www.salesforce.com/en-us/wp-content/uploads/sites/4/documents/legal/Agreements/versioning-back-support-policy.pdf).)

## DataWeave and Mule

DataWeave 2.9.0 is bundled with the Mule 4.9.0 release. For details about the Mule release, see
[Mule Runtime Engine 4.9.0 Release Notes](https://docs.mulesoft.com/release-notes/mule-runtime/mule-4.9.0-release-notes).

## DataWeave Extension Release Notes

DataWeave enables you to implement and test your custom DataWeave modules and mappings and package
them into libraries that you can share and reuse through Anypoint Exchange.

The [DataWeave extension to Visual Studio Code](https://docs.mulesoft.com/dataweave/latest/dataweave-extension-plugin) enhances
productivity when you’re building DataWeave libraries.

- [DataWeave Extension](https://docs.mulesoft.com/release-notes/dataweave/dataweave-extension-release-notes)

<!-- document id=2c2bc274de23e8fc19edefe4c9cea3bbdceb7e538336ea1745f7aa3f07e2fbf7 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-release-notes.md -->

---
product: DataWeave
version: 2.12
---

# DataWeave Release Notes

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This MuleSoft programming language simplifies data transformation tasks and serves as Mule runtime’s
expression language for configuring components and connectors. Build powerful integration solutions
with intuitive scripting capabilities.

Release notes for each DataWeave version include bug fixes, compatibility information, and patch
update release details, in addition to new features and other information about DataWeave releases:

- [DataWeave 2.13.0](https://docs.mulesoft.com/release-notes/dataweave/dataweave-2.13.0-release-notes)

- [DataWeave 2.12.0](https://docs.mulesoft.com/release-notes/dataweave/dataweave-2.12.0-release-notes)

- [DataWeave 2.11.0](https://docs.mulesoft.com/release-notes/dataweave/dataweave-2.11.0-release-notes)

- [DataWeave 2.9.0](https://docs.mulesoft.com/release-notes/dataweave/dataweave-2.9.0-release-notes)

- [DataWeave 2.6.0](https://docs.mulesoft.com/release-notes/dataweave/dataweave-2.6.0-release-notes)

- [DataWeave 2.4.0](https://docs.mulesoft.com/release-notes/dataweave/dataweave-2.4.0-release-notes) (This version of
  the product has reached
  [End of Life](https://www.salesforce.com/en-us/wp-content/uploads/sites/4/documents/legal/Agreements/versioning-back-support-policy.pdf).)

## DataWeave and Mule

DataWeave 2.9.0 is bundled with the Mule 4.9.0 release. For details about the Mule release, see
[Mule Runtime Engine 4.9.0 Release Notes](https://docs.mulesoft.com/release-notes/mule-runtime/mule-4.9.0-release-notes).

## DataWeave Extension Release Notes

DataWeave enables you to implement and test your custom DataWeave modules and mappings and package
them into libraries that you can share and reuse through Anypoint Exchange.

The [DataWeave extension to Visual Studio Code](https://docs.mulesoft.com/dataweave/latest/dataweave-extension-plugin) enhances
productivity when you’re building DataWeave libraries.

- [DataWeave Extension](https://docs.mulesoft.com/release-notes/dataweave/dataweave-extension-release-notes)

<!-- document id=3bd0d33df6b8c295fcac1d0495d69ee68247d62039a0a5643c46cdb0e1719105 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-release-notes.md -->

---
product: DataWeave
version: 2.6
---

# DataWeave Release Notes

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This MuleSoft programming language simplifies data transformation tasks and serves as Mule runtime’s
expression language for configuring components and connectors. Build powerful integration solutions
with intuitive scripting capabilities.

Release notes for each DataWeave version include bug fixes, compatibility information, and patch
update release details, in addition to new features and other information about DataWeave releases:

- [DataWeave 2.13.0](https://docs.mulesoft.com/release-notes/dataweave/dataweave-2.13.0-release-notes)

- [DataWeave 2.12.0](https://docs.mulesoft.com/release-notes/dataweave/dataweave-2.12.0-release-notes)

- [DataWeave 2.11.0](https://docs.mulesoft.com/release-notes/dataweave/dataweave-2.11.0-release-notes)

- [DataWeave 2.9.0](https://docs.mulesoft.com/release-notes/dataweave/dataweave-2.9.0-release-notes)

- [DataWeave 2.6.0](https://docs.mulesoft.com/release-notes/dataweave/dataweave-2.6.0-release-notes)

- [DataWeave 2.4.0](https://docs.mulesoft.com/release-notes/dataweave/dataweave-2.4.0-release-notes) (This version of
  the product has reached
  [End of Life](https://www.salesforce.com/en-us/wp-content/uploads/sites/4/documents/legal/Agreements/versioning-back-support-policy.pdf).)

## DataWeave and Mule

DataWeave 2.6.0 is bundled with the Mule 4.6.0 release. For details about the Mule release, see
[Mule Runtime Engine 4.6.0 Release Notes](https://docs.mulesoft.com/release-notes/mule-runtime/mule-4.6.0-release-notes).

## DataWeave Extension Release Notes

DataWeave enables you to implement and test your custom DataWeave modules and mappings and package
them into libraries that you can share and reuse through Anypoint Exchange.

The [DataWeave extension to Visual Studio Code](https://docs.mulesoft.com/dataweave/latest/dataweave-extension-plugin) enhances
productivity when you’re building DataWeave libraries.

- [DataWeave Extension](https://docs.mulesoft.com/release-notes/dataweave/dataweave-extension-release-notes)

<!-- document id=66661668b222d370c52aa7cecb87a7188ab3eb81a89418884b09561f53729e31 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-release-notes.md -->

---
product: DataWeave
version: 2.9
---

# DataWeave Release Notes

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This MuleSoft programming language simplifies data transformation tasks and serves as Mule runtime’s
expression language for configuring components and connectors. Build powerful integration solutions
with intuitive scripting capabilities.

Release notes for each DataWeave version include bug fixes, compatibility information, and patch
update release details, in addition to new features and other information about DataWeave releases:

- [DataWeave 2.13.0](https://docs.mulesoft.com/release-notes/dataweave/dataweave-2.13.0-release-notes)

- [DataWeave 2.12.0](https://docs.mulesoft.com/release-notes/dataweave/dataweave-2.12.0-release-notes)

- [DataWeave 2.11.0](https://docs.mulesoft.com/release-notes/dataweave/dataweave-2.11.0-release-notes)

- [DataWeave 2.9.0](https://docs.mulesoft.com/release-notes/dataweave/dataweave-2.9.0-release-notes)

- [DataWeave 2.6.0](https://docs.mulesoft.com/release-notes/dataweave/dataweave-2.6.0-release-notes)

- [DataWeave 2.4.0](https://docs.mulesoft.com/release-notes/dataweave/dataweave-2.4.0-release-notes) (This version of
  the product has reached
  [End of Life](https://www.salesforce.com/en-us/wp-content/uploads/sites/4/documents/legal/Agreements/versioning-back-support-policy.pdf).)

## DataWeave and Mule

DataWeave 2.9.0 is bundled with the Mule 4.9.0 release. For details about the Mule release, see
[Mule Runtime Engine 4.9.0 Release Notes](https://docs.mulesoft.com/release-notes/mule-runtime/mule-4.9.0-release-notes).

## DataWeave Extension Release Notes

DataWeave enables you to implement and test your custom DataWeave modules and mappings and package
them into libraries that you can share and reuse through Anypoint Exchange.

The [DataWeave extension to Visual Studio Code](https://docs.mulesoft.com/dataweave/latest/dataweave-extension-plugin) enhances
productivity when you’re building DataWeave libraries.

- [DataWeave Extension](https://docs.mulesoft.com/release-notes/dataweave/dataweave-extension-release-notes)

<!-- document id=1a8374672cd10daf6e5d411a1c4b6ef449e26ef996037cfd63ce3dc285f8fc5d url=/mulesoft/current/en-us/dataweave/latest/dataweave-release-notes.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# DataWeave Release Notes

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This MuleSoft programming language simplifies data transformation tasks and serves as Mule runtime’s
expression language for configuring components and connectors. Build powerful integration solutions
with intuitive scripting capabilities.

Release notes for each DataWeave version include bug fixes, compatibility information, and patch
update release details, in addition to new features and other information about DataWeave releases:

- [DataWeave 2.13.0](https://docs.mulesoft.com/release-notes/dataweave/dataweave-2.13.0-release-notes)

- [DataWeave 2.12.0](https://docs.mulesoft.com/release-notes/dataweave/dataweave-2.12.0-release-notes)

- [DataWeave 2.11.0](https://docs.mulesoft.com/release-notes/dataweave/dataweave-2.11.0-release-notes)

- [DataWeave 2.9.0](https://docs.mulesoft.com/release-notes/dataweave/dataweave-2.9.0-release-notes)

- [DataWeave 2.6.0](https://docs.mulesoft.com/release-notes/dataweave/dataweave-2.6.0-release-notes)

- [DataWeave 2.4.0](https://docs.mulesoft.com/release-notes/dataweave/dataweave-2.4.0-release-notes) (This version of
  the product has reached
  [End of Life](https://www.salesforce.com/en-us/wp-content/uploads/sites/4/documents/legal/Agreements/versioning-back-support-policy.pdf).)

## DataWeave and Mule

DataWeave 2.9.0 is bundled with the Mule 4.9.0 release. For details about the Mule release, see
[Mule Runtime Engine 4.9.0 Release Notes](https://docs.mulesoft.com/release-notes/mule-runtime/mule-4.9.0-release-notes).

## DataWeave Extension Release Notes

DataWeave enables you to implement and test your custom DataWeave modules and mappings and package
them into libraries that you can share and reuse through Anypoint Exchange.

The [DataWeave extension to Visual Studio Code](https://docs.mulesoft.com/dataweave/latest/dataweave-extension-plugin) enhances productivity
when you’re building DataWeave libraries.

- [DataWeave Extension](https://docs.mulesoft.com/release-notes/dataweave/dataweave-extension-release-notes)

<!-- document id=55f1bbb7141078f6431df819b81eee13b4251518c360a73d3045831a9a8d04de url=/mulesoft/current/en-us/dataweave/2.11/dataweave-language-introduction.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# DataWeave Scripts

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave is the primary data transformation language for use in Mule flows.

You can write standalone DataWeave scripts in Transform Message components, or you can write inline
DataWeave expressions to transform data _in-place_ and dynamically set the value of various
properties, such as configuration fields in an event processor or global configuration element.
Inline DataWeave expressions are enclosed in `#[ ]` code blocks. For example, you can use a
DataWeave expression to set conditions in a Choice router or to set the value of a Set Payload or
Set Variable component.

The DataWeave code in this example sets a timestamp variable to the current time using the DataWeave
`now()` function:

Example: Simple Inline DataWeave Script

```xml
<set-variable value="#[now()]" variableName="timestamp" doc:name="Set timestamp" />
```

You can also store DataWeave code in [external files](#dwl_file) and read them into other DataWeave
scripts, or you can factor DataWeave code into modules (libraries) of reusable DataWeave functions
that can be shared by all the components in a Mule app.

## The Structure of DataWeave Scripts

DataWeave scripts and files are divided into two main sections:

- The Header, which defines directives that apply to the body expression (optional).

- The Body, which contains the expression to generate the output structure.

When you include a header, the header appears above the body separated by a delimiter consisting of
three dashes: `---`.

Here is an example of a DataWeave file with an output directive declared in the header, followed by
a DataWeave expression to create a user object that contains two child key/value pairs:

Example: Simple DataWeave Script

```dataweave
%dw 2.0
output application/xml
---
{
  user: {
    firstName: payload.user_firstname,
    lastName: payload.user_lastName
  }
}
```

## DataWeave Header

This example shows keywords (such as `import` and `var`) you can use for header directives.

DataWeave Script

```dataweave
%dw 2.0
import * from dw::core::Arrays
var myVar=13.15
fun toUser(obj) = {
  firstName: obj.field1,
  lastName: obj.field2
}
type Currency = String { format: "##"}
ns ns0 http://www.abc.com
output application/xml
---
/*
 * Body here.
 * /
```

- `%dw`: To maintain backward compatibility with a previous version of DataWeave and avoid
  introducing syntax-breaking changes from the current version, the `%dw` directive supports the
  specification of a previous DataWeave version on a per script basis. Use of this directive is
  optional. The default version is 2.0 if the directive is not present. DataWeave versions from 2.0
  to 2.4 are identical because no syntax changes occurred in those versions.

  Example: `%dw 2.0`

- `output`: Commonly used directive that specifies the mime type that the script outputs.

  Example: `output application/xml`

  Valid values: [Supported Data Formats](https://docs.mulesoft.com/dataweave/2.11/dataweave-formats).

  Default: If no output is specified, the default output is determined by an algorithm that examines
  the inputs (payload, variables, and so on) used in the script:

  1.  If there is no input, the default is `output application/java`.

  2.  If all inputs are the same mime type, the script outputs to the same mime type. For example,
      if all input is `application/json`, then it outputs `output application/json`.

  3.  If the mime types of the inputs differ, and no output is specified, the script throws an
      exception so that you know to specify an output mime type.

      Note that only one output type can be specified.

- `import`: For importing a DataWeave function module. See [DataWeave Functions](https://docs.mulesoft.com/dataweave/2.11/dw-functions).

- `var`: Global variables for defining constants that you can reference throughout the body of the
  DataWeave script:

  Example

  ```dataweave
  %dw 2.0
  var conversionRate=13.15
  output application/json
  ---
  {
   price_dollars: payload.price,
   price_localCurrency: payload.price * conversionRate
  }
  ```

  For details, see [DataWeave Variables](https://docs.mulesoft.com/dataweave/2.11/dataweave-variables).

- `type`: For specifying a custom type that you can use in the expression.

  For a more complete example, see [Type Coercion with DataWeave](https://docs.mulesoft.com/dataweave/2.11/dataweave-types-coercion).

- `ns`: Namespaces, used to import a namespace.

  Example

  ```dataweave
  %dw 2.0
  output application/xml

  ns ns0 http://www.abc.com
  ns ns1 http://www.123.com
  ---
  {
      ns0#myroot: {
           ns1#secondroot: "hello world"
      }
  }
  ```

- `fun`: For creating custom functions that can be called from within the body of the script.

  Example

  ```dataweave
  %dw 2.0
  output application/json
  fun toUser(user) = {firstName: user.name, lastName: user.lastName}
  ---
  {
    user: toUser(payload)
  }
  ```

### Including Headers in Inline DataWeave Scripts

You can include header directives when you write inline DataWeave scripts by flattening all the
lines in the DataWeave script into a single line. For smaller DataWeave scripts, this allows you to
quickly apply header directives (without having to add a separate Transform Message component to set
a variable), then substitute the variable in the next Event processor.

For example, here is the Mule configuration XML to create the same valid XML output as the previous
Transform Message component:

Example: Simple Inline DataWeave Script

```xml
<set-payload value="#[output application/xml --- { myroot: payload } ]" doc:name="Set Payload" />
```

Note that the DataWeave documentation provides numerous [transformation examples](#see_also).

## DataWeave Body

The DataWeave body contains an expression that generates the output structure. Note that MuleSoft
provides a canonical way for you to work on data with the DataWeave model: a query, transform, build
process.

Here is simple example that provides JSON input for a DataWeave script:

Example: JSON Input

```json
{
  "message": "Hello world!"
}
```

This DataWeave script takes the entire payload of the JSON input above and transforms it to the
`application/xml` format.

Example: Script that Outputs application/xml

```dataweave
%dw 2.0
output application/xml
---
payload
```

The next example shows the XML output produced from the DataWeave script:

Example: XML Output

```xml
<?xml version='1.0' encoding='UTF-8'?>
<message>Hello world!</message>
```

The script above successfully transforms the JSON input to XML output.

## Errors (Scripting versus Formatting Errors)

A DataWeave script can throw errors due to DataWeave coding errors and due to formatting errors. So
when transforming one data format to another, it is important to keep in mind the constraints of
both the language and the formats. For example, XML requires a single root node. If you use the
[DataWeave script above](#script_output_xml) in the attempt to transform this JSON input to XML, you
will receive an error (`Unexpected internal error`) because the JSON input lacks a single root:

Example: JSON Input

```json
{
  "size": 1,
  "person": {
    "name": "Yoda"
  }
}
```

A good approach to the creation of a script is to normalize the input to the JSON-like
[application/dw](https://docs.mulesoft.com/dataweave/2.11/dataweave-formats#format_dataweave) format. In fact, if you get an error, you can
simply transform your input to `application/dw`. If the transformation is successful, then the error
is likely a formatting error. If it is unsuccessful, then the error is a coding error.

This example changes the output format to `application/dw`:

Example: DataWeave Script that Outputs application/dw

```dataweave
%dw 2.0
output application/dw
---
payload
```

You can see that the script successfully produces `application/dw` output from the
[JSON input example](#json_input) above:

Example: application/dw Output

```dataweave
{
  size: 1,
  person: {
    name: "Yoda"
  }
}
```

So you know that the previous error (`Unexpected internal error`) is specific to the format, not the
coding. You can see that the `application/dw` output above does not provide a single root element,
as required by the XML format. So, to fix the script for _XML_ output, you need to provide a single
root element to your script, for example:

Example: Script that Outputs application/xml

```dataweave
%dw 2.0
output application/xml
---
{
    "myroot" : payload
}
```

Now the output meets the requirements of XML, so when you change the output directive back to
`application/xml`, the result produces valid XML output.

Example: XML Output Containing a Single XML Root

```xml
<?xml version='1.0' encoding='UTF-8'?>
<myroot>
  <size>1</size>
  <person>
    <name>Yoda</name>
  </person>
</myroot>
```

## DataWeave Comments

Comments that use a Java-like syntax are also accepted by DataWeave.

```dataweave
%dw 2.0
output application/json
---
/* Multi-line
 * comment syntax */
payload
// Single-line comment syntax
```

> [!WARNING] To avoid possible errors in Anypoint Studio, use the multi-line comment
> syntax(`/*comment here*/`) if the first line in the body of your DataWeave script is a comment.
> Subsequent script comments can use any syntax (`//comment` or `/*comment*/`)

## Escape Special Characters

In DataWeave, you use the backslash (`\`) to escape special characters that you are using in an
input string.

See [Escaping Special Characters](https://docs.mulesoft.com/dataweave/2.11/dataweave-types#escape-chars-string) for more details.

The _input_ strings in the DataWeave scripts escape special characters, while the _output_ escapes
in accordance with the requirements of the output format, which can vary depending on whether it is
`application/json`, `application/xml`, `application/csv`, or some other format.

This example escapes the internal double quotation mark that is surrounded by double quotation
marks.

DataWeave Example

```txt
%dw 2.0
output application/json
---
{
    "a": "something",
    "b": "dollar sign (\$)",
    "c": 'single quote (\')',
    "c": "double quote (\")",
    "e": `backtick (\`)`
}
```

Notice that the JSON output also escapes the double quotation marks to make the output valid JSON
but does not escape the other characters:

JSON Output

```json
{
  "a": "something",
  "b": "dollar sign ($)",
  "c": "single quote (')",
  "c": "double quote (\")",
  "e": "backtick (`)"
}
```

The following example escapes the same characters but outputs to XML.

DataWeave Example

```txt
%dw 2.0
output application/xml
---
{
  xmlExample:
  {
     "a": "something",
     "b": "dollar sign (\$)",
     "c": 'single quote (\')',
     "d": "double quote (\")",
     "e": `backtick (\`)`
   }
}
```

The XML output (unlike JSON output) is valid without escaping the double quotation marks:

XML Output

```xml
<?xml version='1.0' encoding='UTF-8'?>
<xmlExample>
  <a>something</a>
  <b>dollar sign ($)</b>
  <c>single quote (')</c>
  <d>double quote (")</d>
  <e>backtick (`)</e>
</xmlExample>
```

## Rules for Declaring Valid Identifiers

To declare a valid identifier, its name must meet the following requirements:

- It must begin with a letter of the alphabet (a-z), either lowercase or uppercase.

- After the first letter, the name can contain any combination of letters, numbers, and underscores
  (`_`).

- The name cannot match any DataWeave reserved keyword (see [Reserved Keywords](#reserved-keywords)
  for a complete list).

Here are some examples of valid identifiers:

- `myType`

- `abc123`

- `a1_3BC_22`

- `Z_____4`

- `F`

The following table provides examples of invalid identifiers and a description of what makes them
invalid:

<table><colgroup><col> <col></colgroup><thead><tr><th>Identifier</th><th>Issue</th></tr></thead><tbody><tr><td><div><div><p><code>123456</code></p></div></div></td><td><div><div><p>Cannot start with a number.</p></div></div></td></tr><tr><td><div><div><p><code>value$</code></p></div></div></td><td><div><div><p>Cannot contain special characters.</p></div></div></td></tr><tr><td><div><div><p><code>_number</code></p></div></div></td><td><div><div><p>Cannot start with an underscore.</p></div></div></td></tr><tr><td><div><div><p><code>type</code></p></div></div></td><td><div><div><p>Cannot be a reserved keyword.</p></div></div></td></tr></tbody></table>

### Reserved Keywords

Valid identifiers cannot match any of the reserved DataWeave keywords:

- `and`  
  Reserved as a [logical operator](https://docs.mulesoft.com/dataweave/2.11/dw-operators#logical_operators)

- `as`  
  Reserved for [type coercion](https://docs.mulesoft.com/dataweave/2.11/dataweave-types-coercion)

- `async`  
  Reserved

- `case`  
  Reserved for `case` statements, for example, to perform
  [pattern matching](https://docs.mulesoft.com/dataweave/2.11/dataweave-pattern-matching) or for use with the
  [`update` operator](https://docs.mulesoft.com/dataweave/2.11/dw-operators#update-operator)

- `default`  
  Reserved for assigning [default values](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-defaults) for parameters

- `do`  
  Reserved for [`do`](https://docs.mulesoft.com/dataweave/2.11/dataweave-flow-control) statements

- `else`  
  Reserved for use in if-else and else-if statements

  See [Flow Control in DataWeave](https://docs.mulesoft.com/dataweave/2.11/dataweave-flow-control).

- `enum`  
  Reserved

- `false`  
  Reserved as a Boolean value

- `for`  
  Reserved

- `fun`  
  Reserved for function definitions in [DataWeave Header](#dw_header)

- `if`  
  Reserved for if-else and else-if statements

  See [Flow Control in DataWeave](https://docs.mulesoft.com/dataweave/2.11/dataweave-flow-control).

- `import`  
  Reserved for the `import` directive in [DataWeave Header](#dw_header)

- `input`  
  Reserved

- `is`  
  Reserved

- `ns`  
  Reserved for namespace definitions in [DataWeave Header](#dw_header)

- `null`  
  Reserved as the value `null`

  See [Null (dw::Core Type)](https://docs.mulesoft.com/dataweave/2.11/dataweave-types#dw_type_null).

- `or`  
  Reserved as a [logical operator](https://docs.mulesoft.com/dataweave/2.11/dw-operators#logical_operators)

- `output`  
  Reserved for the `output` directive in [DataWeave Header](#dw_header)

- `private`  
  Reserved

- `throw`  
  Reserved

- `true`  
  Reserved as a Boolean value

- `type`  
  Reserved for type definitions in [DataWeave Header](#dw_header)

- `unless`  
  Reserved

- `using`  
  Reserved for backward compability and replaced by `do`

  See [Scope and Flow Control Operators](https://docs.mulesoft.com/dataweave/2.11/dw-operators#scope-and-flow-control-operators).

- `var`  
  Reserved for variable definitions in the [DataWeave Header](#dw_header)

- `yield`  
  Reserved

## dwl File

In addition to specifying DataWeave scripts in the Transform and other components, you can also
specify the scripts in a `.dwl` file. In Studio projects, your script files are stored in
`src/main/resources`.

In the Mule app XML, you can use the `${file::filename}` syntax to send a script in a `dwl` file
through any XML tag that expects an expression. For example, see the
`when expression="${file::someFile.dwl}"` in the Choice router here:

```xml
<http:listener doc:name="Listener" config-ref="HTTP_Listener_config" path="/test">
  <http:response >
    <http:body ><![CDATA[#[${file::transform.dwl}]]]></http:body>
  </http:response>
</http:listener>
<choice doc:name="Choice"  >
  <when expression="${file::someFile.dwl}" >
    <set-payload value="It's greater than 4!" doc:name="Set Payload"  />
  </when>
  <otherwise >
    <set-payload value="It's less than 4!" doc:name="Set Payload" />
  </otherwise>
</choice>
```

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.11/dataweave-selectors)

- [DataWeave Functions](https://docs.mulesoft.com/dataweave/2.11/dw-functions)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook)

- [Supported Data Formats](https://docs.mulesoft.com/dataweave/2.11/dataweave-formats)

- [Functions and Lambdas](https://docs.mulesoft.com/dataweave/2.11/dataweave-types#functions-and-lambdas)

<!-- document id=878700f3253e67c7cf7342e66c6d0ffb7b8668bd47dd308262b103414a073d83 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-language-introduction.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# DataWeave Scripts

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave is the primary data transformation language for use in Mule flows.

You can write standalone DataWeave scripts in Transform Message components, or you can write inline
DataWeave expressions to transform data _in-place_ and dynamically set the value of various
properties, such as configuration fields in an event processor or global configuration element.
Inline DataWeave expressions are enclosed in `#[ ]` code blocks. For example, you can use a
DataWeave expression to set conditions in a Choice router or to set the value of a Set Payload or
Set Variable component.

The DataWeave code in this example sets a timestamp variable to the current time using the DataWeave
`now()` function:

Example: Simple Inline DataWeave Script

```xml
<set-variable value="#[now()]" variableName="timestamp" doc:name="Set timestamp" />
```

You can also store DataWeave code in [external files](#dwl_file) and read them into other DataWeave
scripts, or you can factor DataWeave code into modules (libraries) of reusable DataWeave functions
that can be shared by all the components in a Mule app.

## The Structure of DataWeave Scripts

DataWeave scripts and files are divided into two main sections:

- The Header, which defines directives that apply to the body expression (optional).

- The Body, which contains the expression to generate the output structure.

When you include a header, the header appears above the body separated by a delimiter consisting of
three dashes: `---`.

Here is an example of a DataWeave file with an output directive declared in the header, followed by
a DataWeave expression to create a user object that contains two child key/value pairs:

Example: Simple DataWeave Script

```dataweave
%dw 2.0
output application/xml
---
{
  user: {
    firstName: payload.user_firstname,
    lastName: payload.user_lastName
  }
}
```

## DataWeave Header

This example shows keywords (such as `import` and `var`) you can use for header directives.

DataWeave Script

```dataweave
%dw 2.0
import * from dw::core::Arrays
var myVar=13.15
fun toUser(obj) = {
  firstName: obj.field1,
  lastName: obj.field2
}
type Currency = String { format: "##"}
ns ns0 http://www.abc.com
output application/xml
---
/*
 * Body here.
 * /
```

- `%dw`: To maintain backward compatibility with a previous version of DataWeave and avoid
  introducing syntax-breaking changes from the current version, the `%dw` directive supports the
  specification of a previous DataWeave version on a per script basis. Use of this directive is
  optional. The default version is 2.0 if the directive is not present. DataWeave versions from 2.0
  to 2.4 are identical because no syntax changes occurred in those versions.

  Example: `%dw 2.0`

- `output`: Commonly used directive that specifies the mime type that the script outputs.

  Example: `output application/xml`

  Valid values: [Supported Data Formats](https://docs.mulesoft.com/dataweave/2.12/dataweave-formats).

  Default: If no output is specified, the default output is determined by an algorithm that examines
  the inputs (payload, variables, and so on) used in the script:

  1.  If there is no input, the default is `output application/java`.

  2.  If all inputs are the same mime type, the script outputs to the same mime type. For example,
      if all input is `application/json`, then it outputs `output application/json`.

  3.  If the mime types of the inputs differ, and no output is specified, the script throws an
      exception so that you know to specify an output mime type.

      Note that only one output type can be specified.

- `import`: For importing a DataWeave function module. See [DataWeave Functions](https://docs.mulesoft.com/dataweave/2.12/dw-functions).

- `var`: Global variables for defining constants that you can reference throughout the body of the
  DataWeave script:

  Example

  ```dataweave
  %dw 2.0
  var conversionRate=13.15
  output application/json
  ---
  {
   price_dollars: payload.price,
   price_localCurrency: payload.price * conversionRate
  }
  ```

  For details, see [DataWeave Variables](https://docs.mulesoft.com/dataweave/2.12/dataweave-variables).

- `type`: For specifying a custom type that you can use in the expression.

  For a more complete example, see [Type Coercion with DataWeave](https://docs.mulesoft.com/dataweave/2.12/dataweave-types-coercion).

- `ns`: Namespaces, used to import a namespace.

  Example

  ```dataweave
  %dw 2.0
  output application/xml

  ns ns0 http://www.abc.com
  ns ns1 http://www.123.com
  ---
  {
      ns0#myroot: {
           ns1#secondroot: "hello world"
      }
  }
  ```

- `fun`: For creating custom functions that can be called from within the body of the script.

  Example

  ```dataweave
  %dw 2.0
  output application/json
  fun toUser(user) = {firstName: user.name, lastName: user.lastName}
  ---
  {
    user: toUser(payload)
  }
  ```

### Including Headers in Inline DataWeave Scripts

You can include header directives when you write inline DataWeave scripts by flattening all the
lines in the DataWeave script into a single line. For smaller DataWeave scripts, this allows you to
quickly apply header directives (without having to add a separate Transform Message component to set
a variable), then substitute the variable in the next Event processor.

For example, here is the Mule configuration XML to create the same valid XML output as the previous
Transform Message component:

Example: Simple Inline DataWeave Script

```xml
<set-payload value="#[output application/xml --- { myroot: payload } ]" doc:name="Set Payload" />
```

Note that the DataWeave documentation provides numerous [transformation examples](#see_also).

## DataWeave Body

The DataWeave body contains an expression that generates the output structure. Note that MuleSoft
provides a canonical way for you to work on data with the DataWeave model: a query, transform, build
process.

Here is simple example that provides JSON input for a DataWeave script:

Example: JSON Input

```json
{
  "message": "Hello world!"
}
```

This DataWeave script takes the entire payload of the JSON input above and transforms it to the
`application/xml` format.

Example: Script that Outputs application/xml

```dataweave
%dw 2.0
output application/xml
---
payload
```

The next example shows the XML output produced from the DataWeave script:

Example: XML Output

```xml
<?xml version='1.0' encoding='UTF-8'?>
<message>Hello world!</message>
```

The script above successfully transforms the JSON input to XML output.

## Errors (Scripting versus Formatting Errors)

A DataWeave script can throw errors due to DataWeave coding errors and due to formatting errors. So
when transforming one data format to another, it is important to keep in mind the constraints of
both the language and the formats. For example, XML requires a single root node. If you use the
[DataWeave script above](#script_output_xml) in the attempt to transform this JSON input to XML, you
will receive an error (`Unexpected internal error`) because the JSON input lacks a single root:

Example: JSON Input

```json
{
  "size": 1,
  "person": {
    "name": "Yoda"
  }
}
```

A good approach to the creation of a script is to normalize the input to the JSON-like
[application/dw](https://docs.mulesoft.com/dataweave/2.12/dataweave-formats#format_dataweave) format. In fact, if you get an error, you can
simply transform your input to `application/dw`. If the transformation is successful, then the error
is likely a formatting error. If it is unsuccessful, then the error is a coding error.

This example changes the output format to `application/dw`:

Example: DataWeave Script that Outputs application/dw

```dataweave
%dw 2.0
output application/dw
---
payload
```

You can see that the script successfully produces `application/dw` output from the
[JSON input example](#json_input) above:

Example: application/dw Output

```dataweave
{
  size: 1,
  person: {
    name: "Yoda"
  }
}
```

So you know that the previous error (`Unexpected internal error`) is specific to the format, not the
coding. You can see that the `application/dw` output above does not provide a single root element,
as required by the XML format. So, to fix the script for _XML_ output, you need to provide a single
root element to your script, for example:

Example: Script that Outputs application/xml

```dataweave
%dw 2.0
output application/xml
---
{
    "myroot" : payload
}
```

Now the output meets the requirements of XML, so when you change the output directive back to
`application/xml`, the result produces valid XML output.

Example: XML Output Containing a Single XML Root

```xml
<?xml version='1.0' encoding='UTF-8'?>
<myroot>
  <size>1</size>
  <person>
    <name>Yoda</name>
  </person>
</myroot>
```

## DataWeave Comments

Comments that use a Java-like syntax are also accepted by DataWeave.

```dataweave
%dw 2.0
output application/json
---
/* Multi-line
 * comment syntax */
payload
// Single-line comment syntax
```

> [!WARNING] To avoid possible errors in Anypoint Studio, use the multi-line comment
> syntax(`/*comment here*/`) if the first line in the body of your DataWeave script is a comment.
> Subsequent script comments can use any syntax (`//comment` or `/*comment*/`)

## Escape Special Characters

In DataWeave, you use the backslash (`\`) to escape special characters that you are using in an
input string.

See [Escaping Special Characters](https://docs.mulesoft.com/dataweave/2.12/dataweave-types#escape-chars-string) for more details.

The _input_ strings in the DataWeave scripts escape special characters, while the _output_ escapes
in accordance with the requirements of the output format, which can vary depending on whether it is
`application/json`, `application/xml`, `application/csv`, or some other format.

This example escapes the internal double quotation mark that is surrounded by double quotation
marks.

DataWeave Example

```txt
%dw 2.0
output application/json
---
{
    "a": "something",
    "b": "dollar sign (\$)",
    "c": 'single quote (\')',
    "c": "double quote (\")",
    "e": `backtick (\`)`
}
```

Notice that the JSON output also escapes the double quotation marks to make the output valid JSON
but does not escape the other characters:

JSON Output

```json
{
  "a": "something",
  "b": "dollar sign ($)",
  "c": "single quote (')",
  "c": "double quote (\")",
  "e": "backtick (`)"
}
```

The following example escapes the same characters but outputs to XML.

DataWeave Example

```txt
%dw 2.0
output application/xml
---
{
  xmlExample:
  {
     "a": "something",
     "b": "dollar sign (\$)",
     "c": 'single quote (\')',
     "d": "double quote (\")",
     "e": `backtick (\`)`
   }
}
```

The XML output (unlike JSON output) is valid without escaping the double quotation marks:

XML Output

```xml
<?xml version='1.0' encoding='UTF-8'?>
<xmlExample>
  <a>something</a>
  <b>dollar sign ($)</b>
  <c>single quote (')</c>
  <d>double quote (")</d>
  <e>backtick (`)</e>
</xmlExample>
```

## Rules for Declaring Valid Identifiers

To declare a valid identifier, its name must meet the following requirements:

- It must begin with a letter of the alphabet (a-z), either lowercase or uppercase.

- After the first letter, the name can contain any combination of letters, numbers, and underscores
  (`_`).

- The name cannot match any DataWeave reserved keyword (see [Reserved Keywords](#reserved-keywords)
  for a complete list).

Here are some examples of valid identifiers:

- `myType`

- `abc123`

- `a1_3BC_22`

- `Z_____4`

- `F`

The following table provides examples of invalid identifiers and a description of what makes them
invalid:

<table><colgroup><col> <col></colgroup><thead><tr><th>Identifier</th><th>Issue</th></tr></thead><tbody><tr><td><div><div><p><code>123456</code></p></div></div></td><td><div><div><p>Cannot start with a number.</p></div></div></td></tr><tr><td><div><div><p><code>value$</code></p></div></div></td><td><div><div><p>Cannot contain special characters.</p></div></div></td></tr><tr><td><div><div><p><code>_number</code></p></div></div></td><td><div><div><p>Cannot start with an underscore.</p></div></div></td></tr><tr><td><div><div><p><code>type</code></p></div></div></td><td><div><div><p>Cannot be a reserved keyword.</p></div></div></td></tr></tbody></table>

### Reserved Keywords

Valid identifiers cannot match any of the reserved DataWeave keywords:

- `and`  
  Reserved as a [logical operator](https://docs.mulesoft.com/dataweave/2.12/dw-operators#logical_operators)

- `as`  
  Reserved for [type coercion](https://docs.mulesoft.com/dataweave/2.12/dataweave-types-coercion)

- `async`  
  Reserved

- `case`  
  Reserved for `case` statements, for example, to perform
  [pattern matching](https://docs.mulesoft.com/dataweave/2.12/dataweave-pattern-matching) or for use with the
  [`update` operator](https://docs.mulesoft.com/dataweave/2.12/dw-operators#update-operator)

- `default`  
  Reserved for assigning [default values](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-defaults) for parameters

- `do`  
  Reserved for [`do`](https://docs.mulesoft.com/dataweave/2.12/dataweave-flow-control) statements

- `else`  
  Reserved for use in if-else and else-if statements

  See [Flow Control in DataWeave](https://docs.mulesoft.com/dataweave/2.12/dataweave-flow-control).

- `enum`  
  Reserved

- `false`  
  Reserved as a Boolean value

- `for`  
  Reserved

- `fun`  
  Reserved for function definitions in [DataWeave Header](#dw_header)

- `if`  
  Reserved for if-else and else-if statements

  See [Flow Control in DataWeave](https://docs.mulesoft.com/dataweave/2.12/dataweave-flow-control).

- `import`  
  Reserved for the `import` directive in [DataWeave Header](#dw_header)

- `input`  
  Reserved

- `is`  
  Reserved

- `ns`  
  Reserved for namespace definitions in [DataWeave Header](#dw_header)

- `null`  
  Reserved as the value `null`

  See [Null (dw::Core Type)](https://docs.mulesoft.com/dataweave/2.12/dataweave-types#dw_type_null).

- `or`  
  Reserved as a [logical operator](https://docs.mulesoft.com/dataweave/2.12/dw-operators#logical_operators)

- `output`  
  Reserved for the `output` directive in [DataWeave Header](#dw_header)

- `private`  
  Reserved

- `throw`  
  Reserved

- `true`  
  Reserved as a Boolean value

- `type`  
  Reserved for type definitions in [DataWeave Header](#dw_header)

- `unless`  
  Reserved

- `using`  
  Reserved for backward compability and replaced by `do`

  See [Scope and Flow Control Operators](https://docs.mulesoft.com/dataweave/2.12/dw-operators#scope-and-flow-control-operators).

- `var`  
  Reserved for variable definitions in the [DataWeave Header](#dw_header)

- `yield`  
  Reserved

## dwl File

In addition to specifying DataWeave scripts in the Transform and other components, you can also
specify the scripts in a `.dwl` file. In Studio projects, your script files are stored in
`src/main/resources`.

In the Mule app XML, you can use the `${file::filename}` syntax to send a script in a `dwl` file
through any XML tag that expects an expression. For example, see the
`when expression="${file::someFile.dwl}"` in the Choice router here:

```xml
<http:listener doc:name="Listener" config-ref="HTTP_Listener_config" path="/test">
  <http:response >
    <http:body ><![CDATA[#[${file::transform.dwl}]]]></http:body>
  </http:response>
</http:listener>
<choice doc:name="Choice"  >
  <when expression="${file::someFile.dwl}" >
    <set-payload value="It's greater than 4!" doc:name="Set Payload"  />
  </when>
  <otherwise >
    <set-payload value="It's less than 4!" doc:name="Set Payload" />
  </otherwise>
</choice>
```

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.12/dataweave-selectors)

- [DataWeave Functions](https://docs.mulesoft.com/dataweave/2.12/dw-functions)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook)

- [Supported Data Formats](https://docs.mulesoft.com/dataweave/2.12/dataweave-formats)

- [Functions and Lambdas](https://docs.mulesoft.com/dataweave/2.12/dataweave-types#functions-and-lambdas)

<!-- document id=f880c74bac6ae20396a935c2693e44c9ab836cc9686f721d1df3f5a24f394c2a url=/mulesoft/current/en-us/dataweave/2.3/dataweave-language-introduction.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# DataWeave Scripts

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave is the primary data transformation language for use in Mule flows.

You can write standalone DataWeave scripts in Transform Message components, or you can write inline
DataWeave expressions to transform data _in-place_ and dynamically set the value of various
properties, such as configuration fields in an event processor or global configuration element.
Inline DataWeave expressions are enclosed in `#[ ]` code blocks. For example, you can use a
DataWeave expression to set conditions in a Choice router or to set the value of a Set Payload or
Set Variable component.

The DataWeave code in this example sets a timestamp variable to the current time using the DataWeave
`now()` function:

Example: Simple Inline DataWeave Script

```xml
<set-variable value="#[now()]" variableName="timestamp" doc:name="Set timestamp" />
```

You can also store DataWeave code in [external files](#dwl_file) and read them into other DataWeave
scripts, or you can factor DataWeave code into modules (libraries) of reusable DataWeave functions
that can be shared by all the components in a Mule app.

## The Structure of DataWeave Scripts

DataWeave scripts and files are divided into two main sections:

- The Header, which defines directives that apply to the body expression (optional).

- The Body, which contains the expression to generate the output structure.

When you include a header, the header appears above the body separated by a delimiter consisting of
three dashes: `---`.

Here is an example of a DataWeave file with an output directive declared in the header, followed by
a DataWeave expression to create a user object that contains two child key/value pairs:

Example: Simple DataWeave Script

```dataweave
%dw 2.0
output application/xml
---
{
  user: {
    firstName: payload.user_firstname,
    lastName: payload.user_lastName
  }
}
```

## DataWeave Header

This example shows keywords (such as `import` and `var`) you can use for header directives.

DataWeave Script

```dataweave
%dw 2.0
import * from dw::core::Arrays
var myVar=13.15
fun toUser(obj) = {
  firstName: obj.field1,
  lastName: obj.field2
}
type Currency = String { format: "##"}
ns ns0 http://www.abc.com
output application/xml
---
/*
 * Body here.
 * /
```

- `%dw`: DataWeave version is optional. Default is `2.0`.

  Example: `%dw 2.0`

- `output`: Commonly used directive that specifies the mime type that the script outputs.

  Example: `output application/xml`

  Valid values: [Supported Data Formats](https://docs.mulesoft.com/dataweave/2.3/dataweave-formats).

  Default: If no output is specified, the default output is determined by an algorithm that examines
  the inputs (payload, variables, and so on) used in the script:

  1.  If there is no input, the default is `output application/java`.

  2.  If all inputs are the same mime type, the script outputs to the same mime type. For example,
      if all input is `application/json`, then it outputs `output application/json`.

  3.  If the mime types of the inputs differ, and no output is specified, the script throws an
      exception so that you know to specify an output mime type.

      Note that only one output type can be specified.

- `import`: For importing a DataWeave function module. See [DataWeave Functions](https://docs.mulesoft.com/dataweave/2.3/dw-functions).

- `var`: Global variables for defining constants that you can reference throughout the body of the
  DataWeave script:

  Example

  ```dataweave
  %dw 2.0
  var conversionRate=13.15
  output application/json
  ---
  {
   price_dollars: payload.price,
   price_localCurrency: payload.price * conversionRate
  }
  ```

  For details, see [DataWeave Variables](https://docs.mulesoft.com/dataweave/2.3/dataweave-variables).

- `type`: For specifying a custom type that you can use in the expression.

  For a more complete example, see [Type Coercion with DataWeave](https://docs.mulesoft.com/dataweave/2.3/dataweave-types-coercion).

- `ns`: Namespaces, used to import a namespace.

  Example

  ```dataweave
  %dw 2.0
  output application/xml

  ns ns0 http://www.abc.com
  ns ns1 http://www.123.com
  ---
  {
      ns0#myroot: {
           ns1#secondroot: "hello world"
      }
  }
  ```

- `fun`: For creating custom functions that can be called from within the body of the script.

  Example

  ```dataweave
  %dw 2.0
  output application/json
  fun toUser(user) = {firstName: user.name, lastName: user.lastName}
  ---
  {
    user: toUser(payload)
  }
  ```

### Including Headers in Inline DataWeave Scripts

You can include header directives when you write inline DataWeave scripts by flattening all the
lines in the DataWeave script into a single line. For smaller DataWeave scripts, this allows you to
quickly apply header directives (without having to add a separate Transform Message component to set
a variable), then substitute the variable in the next Event processor.

For example, here is the Mule configuration XML to create the same valid XML output as the previous
Transform Message component:

Example: Simple Inline DataWeave Script

```xml
<set-payload value="#[output application/xml --- { myroot: payload } ]" doc:name="Set Payload" />
```

Note that the DataWeave documentation provides numerous [transformation examples](#see_also).

## DataWeave Body

The DataWeave body contains an expression that generates the output structure. Note that MuleSoft
provides a canonical way for you to work on data with the DataWeave model: a query, transform, build
process.

Here is simple example that provides JSON input for a DataWeave script:

Example: JSON Input

```json
{
  "message": "Hello world!"
}
```

This DataWeave script takes the entire payload of the JSON input above and transforms it to the
`application/xml` format.

Example: Script that Outputs application/xml

```dataweave
%dw 2.0
output application/xml
---
payload
```

The next example shows the XML output produced from the DataWeave script:

Example: XML Output

```xml
<?xml version='1.0' encoding='UTF-8'?>
<message>Hello world!</message>
```

The script above successfully transforms the JSON input to XML output.

## Errors (Scripting versus Formatting Errors)

A DataWeave script can throw errors due to DataWeave coding errors and due to formatting errors. So
when transforming one data format to another, it is important to keep in mind the constraints of
both the language and the formats. For example, XML requires a single root node. If you use the
[DataWeave script above](#script_output_xml) in the attempt to transform this JSON input to XML, you
will receive an error (`Unexpected internal error`) because the JSON input lacks a single root:

Example: JSON Input

```json
{
  "size": 1,
  "person": {
    "name": "Yoda"
  }
}
```

A good approach to the creation of a script is to normalize the input to the JSON-like
[application/dw](https://docs.mulesoft.com/dataweave/2.3/dataweave-formats#format_dataweave) format. In fact, if you get an error, you can
simply transform your input to `application/dw`. If the transformation is successful, then the error
is likely a formatting error. If it is unsuccessful, then the error is a coding error.

This example changes the output format to `application/dw`:

Example: DataWeave Script that Outputs application/dw

```dataweave
%dw 2.0
output application/dw
---
payload
```

You can see that the script successfully produces `application/dw` output from the
[JSON input example](#json_input) above:

Example: application/dw Output

```dataweave
{
  size: 1,
  person: {
    name: "Yoda"
  }
}
```

So you know that the previous error (`Unexpected internal error`) is specific to the format, not the
coding. You can see that the `application/dw` output above does not provide a single root element,
as required by the XML format. So, to fix the script for _XML_ output, you need to provide a single
root element to your script, for example:

Example: Script that Outputs application/xml

```dataweave
%dw 2.0
output application/xml
---
{
    "myroot" : payload
}
```

Now the output meets the requirements of XML, so when you change the output directive back to
`application/xml`, the result produces valid XML output.

Example: XML Output Containing a Single XML Root

```xml
<?xml version='1.0' encoding='UTF-8'?>
<myroot>
  <size>1</size>
  <person>
    <name>Yoda</name>
  </person>
</myroot>
```

## DataWeave Comments

Comments that use a Java-like syntax are also accepted by DataWeave.

```dataweave
%dw 2.0
output application/json
---
/* Multi-line
 * comment syntax */
payload
// Single-line comment syntax
```

> [!WARNING] To avoid possible errors in Anypoint Studio, use the multi-line comment
> syntax(`/*comment here*/`) if the first line in the body of your DataWeave script is a comment.
> Subsequent script comments can use any syntax (`//comment` or `/*comment*/`)

## Escape Special Characters

In DataWeave, you use the backslash (`\`) to escape special characters that you are using in an
input string.

See [Escaping Special Characters](https://docs.mulesoft.com/dataweave/2.3/dataweave-types#escape-chars-string) for more details.

The _input_ strings in the DataWeave scripts escape special characters, while the _output_ escapes
in accordance with the requirements of the output format, which can vary depending on whether it is
`application/json`, `application/xml`, `application/csv`, or some other format.

This example escapes the internal double quotation mark that is surrounded by double quotation
marks.

DataWeave Example

```txt
%dw 2.0
output application/json
---
{
    "a": "something",
    "b": "dollar sign (\$)",
    "c": 'single quote (\')',
    "c": "double quote (\")",
    "e": `backtick (\`)`
}
```

Notice that the JSON output also escapes the double quotation marks to make the output valid JSON
but does not escape the other characters:

JSON Output

```json
{
  "a": "something",
  "b": "dollar sign ($)",
  "c": "single quote (')",
  "c": "double quote (\")",
  "e": "backtick (`)"
}
```

The following example escapes the same characters but outputs to XML.

DataWeave Example

```txt
%dw 2.0
output application/xml
---
{
  xmlExample:
  {
     "a": "something",
     "b": "dollar sign (\$)",
     "c": 'single quote (\')',
     "d": "double quote (\")",
     "e": `backtick (\`)`
   }
}
```

The XML output (unlike JSON output) is valid without escaping the double quotation marks:

XML Output

```xml
<?xml version='1.0' encoding='UTF-8'?>
<xmlExample>
  <a>something</a>
  <b>dollar sign ($)</b>
  <c>single quote (')</c>
  <d>double quote (")</d>
  <e>backtick (`)</e>
</xmlExample>
```

## Rules for Declaring Valid Identifiers

To declare a valid identifier, its name must meet the following requirements:

- It must begin with a letter of the alphabet (a-z), either lowercase or uppercase.

- After the first letter, the name can contain any combination of letters, numbers, and underscores
  (`_`).

- The name cannot match any DataWeave reserved keyword (see [Reserved Keywords](#reserved-keywords)
  for a complete list).

Here are some examples of valid identifiers:

- `myType`

- `abc123`

- `a1_3BC_22`

- `Z_____4`

- `F`

The following table provides examples of invalid identifiers and a description of what makes them
invalid:

<table><colgroup><col> <col></colgroup><thead><tr><th>Identifier</th><th>Issue</th></tr></thead><tbody><tr><td><div><div><p><code>123456</code></p></div></div></td><td><div><div><p>Cannot start with a number.</p></div></div></td></tr><tr><td><div><div><p><code>value$</code></p></div></div></td><td><div><div><p>Cannot contain special characters.</p></div></div></td></tr><tr><td><div><div><p><code>_number</code></p></div></div></td><td><div><div><p>Cannot start with an underscore.</p></div></div></td></tr><tr><td><div><div><p><code>type</code></p></div></div></td><td><div><div><p>Cannot be a reserved keyword.</p></div></div></td></tr></tbody></table>

### Reserved Keywords

Valid identifiers cannot match any of the reserved DataWeave keywords:

- `and`  
  Reserved as a [logical operator](https://docs.mulesoft.com/dataweave/2.3/dw-operators#logical_operators)

- `as`  
  Reserved for [type coercion](https://docs.mulesoft.com/dataweave/2.3/dataweave-types-coercion)

- `async`  
  Reserved

- `case`  
  Reserved for `case` statements, for example, to perform
  [pattern matching](https://docs.mulesoft.com/dataweave/2.3/dataweave-pattern-matching) or for use with the
  [`update` operator](https://docs.mulesoft.com/dataweave/2.3/dw-operators#update-operator)

- `default`  
  Reserved for assigning [default values](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-defaults) for parameters

- `do`  
  Reserved for [`do`](https://docs.mulesoft.com/dataweave/2.3/dataweave-flow-control) statements

- `else`  
  Reserved for use in if-else and else-if statements

  See [Flow Control in DataWeave](https://docs.mulesoft.com/dataweave/2.3/dataweave-flow-control).

- `enum`  
  Reserved

- `false`  
  Reserved as a Boolean value

- `for`  
  Reserved

- `fun`  
  Reserved for function definitions in [DataWeave Header](#dw_header)

- `if`  
  Reserved for if-else and else-if statements

  See [Flow Control in DataWeave](https://docs.mulesoft.com/dataweave/2.3/dataweave-flow-control).

- `import`  
  Reserved for the `import` directive in [DataWeave Header](#dw_header)

- `input`  
  Reserved

- `is`  
  Reserved

- `ns`  
  Reserved for namespace definitions in [DataWeave Header](#dw_header)

- `null`  
  Reserved as the value `null`

  See [Null (dw::Core Type)](https://docs.mulesoft.com/dataweave/2.3/dataweave-types#dw_type_null).

- `or`  
  Reserved as a [logical operator](https://docs.mulesoft.com/dataweave/2.3/dw-operators#logical_operators)

- `output`  
  Reserved for the `output` directive in [DataWeave Header](#dw_header)

- `private`  
  Reserved

- `throw`  
  Reserved

- `true`  
  Reserved as a Boolean value

- `type`  
  Reserved for type definitions in [DataWeave Header](#dw_header)

- `unless`  
  Reserved

- `using`  
  Reserved for backward compability and replaced by `do`

  See [Scope and Flow Control Operators](https://docs.mulesoft.com/dataweave/2.3/dw-operators#scope-and-flow-control-operators).

- `var`  
  Reserved for variable definitions in the [DataWeave Header](#dw_header)

- `yield`  
  Reserved

## dwl File

In addition to specifying DataWeave scripts in the Transform and other components, you can also
specify the scripts in a `.dwl` file. In Studio projects, your script files are stored in
`src/main/resources`.

In the Mule app XML, you can use the `${file::filename}` syntax to send a script in a `dwl` file
through any XML tag that expects an expression. For example, see the
`when expression="${file::someFile.dwl}"` in the Choice router here:

```xml
<http:listener doc:name="Listener" config-ref="HTTP_Listener_config" path="/test">
  <http:response >
    <http:body ><![CDATA[#[${file::transform.dwl}]]]></http:body>
  </http:response>
</http:listener>
<choice doc:name="Choice"  >
  <when expression="${file::someFile.dwl}" >
    <set-payload value="It's greater than 4!" doc:name="Set Payload"  />
  </when>
  <otherwise >
    <set-payload value="It's less than 4!" doc:name="Set Payload" />
  </otherwise>
</choice>
```

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.3/dataweave-selectors)

- [DataWeave Functions](https://docs.mulesoft.com/dataweave/2.3/dw-functions)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook)

- [Supported Data Formats](https://docs.mulesoft.com/dataweave/2.3/dataweave-formats)

- [Functions and Lambdas](https://docs.mulesoft.com/dataweave/2.3/dataweave-types#functions-and-lambdas)

<!-- document id=a012c933a677aa0d9c0fbf015e17dbcb29b6e182d98827d0b1c5ead3ac0b74cc url=/mulesoft/current/en-us/dataweave/2.4/dataweave-language-introduction.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# DataWeave Scripts

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave is the primary data transformation language for use in Mule flows.

You can write standalone DataWeave scripts in Transform Message components, or you can write inline
DataWeave expressions to transform data _in-place_ and dynamically set the value of various
properties, such as configuration fields in an event processor or global configuration element.
Inline DataWeave expressions are enclosed in `#[ ]` code blocks. For example, you can use a
DataWeave expression to set conditions in a Choice router or to set the value of a Set Payload or
Set Variable component.

The DataWeave code in this example sets a timestamp variable to the current time using the DataWeave
`now()` function:

Example: Simple Inline DataWeave Script

```xml
<set-variable value="#[now()]" variableName="timestamp" doc:name="Set timestamp" />
```

You can also store DataWeave code in [external files](#dwl_file) and read them into other DataWeave
scripts, or you can factor DataWeave code into modules (libraries) of reusable DataWeave functions
that can be shared by all the components in a Mule app.

## The Structure of DataWeave Scripts

DataWeave scripts and files are divided into two main sections:

- The Header, which defines directives that apply to the body expression (optional).

- The Body, which contains the expression to generate the output structure.

When you include a header, the header appears above the body separated by a delimiter consisting of
three dashes: `---`.

Here is an example of a DataWeave file with an output directive declared in the header, followed by
a DataWeave expression to create a user object that contains two child key/value pairs:

Example: Simple DataWeave Script

```dataweave
%dw 2.0
output application/xml
---
{
  user: {
    firstName: payload.user_firstname,
    lastName: payload.user_lastName
  }
}
```

## DataWeave Header

This example shows keywords (such as `import` and `var`) you can use for header directives.

DataWeave Script

```dataweave
%dw 2.0
import * from dw::core::Arrays
var myVar=13.15
fun toUser(obj) = {
  firstName: obj.field1,
  lastName: obj.field2
}
type Currency = String { format: "##"}
ns ns0 http://www.abc.com
output application/xml
---
/*
 * Body here.
 * /
```

- `%dw`: DataWeave version is optional. Default is `2.0`, which is for _all_ 2.x versions of
  DataWeave.

  Example: `%dw 2.0`

- `output`: Commonly used directive that specifies the mime type that the script outputs.

  Example: `output application/xml`

  Valid values: [Supported Data Formats](https://docs.mulesoft.com/dataweave/2.4/dataweave-formats).

  Default: If no output is specified, the default output is determined by an algorithm that examines
  the inputs (payload, variables, and so on) used in the script:

  1.  If there is no input, the default is `output application/java`.

  2.  If all inputs are the same mime type, the script outputs to the same mime type. For example,
      if all input is `application/json`, then it outputs `output application/json`.

  3.  If the mime types of the inputs differ, and no output is specified, the script throws an
      exception so that you know to specify an output mime type.

      Note that only one output type can be specified.

- `import`: For importing a DataWeave function module. See [DataWeave Functions](https://docs.mulesoft.com/dataweave/2.4/dw-functions).

- `var`: Global variables for defining constants that you can reference throughout the body of the
  DataWeave script:

  Example

  ```dataweave
  %dw 2.0
  var conversionRate=13.15
  output application/json
  ---
  {
   price_dollars: payload.price,
   price_localCurrency: payload.price * conversionRate
  }
  ```

  For details, see [DataWeave Variables](https://docs.mulesoft.com/dataweave/2.4/dataweave-variables).

- `type`: For specifying a custom type that you can use in the expression.

  For a more complete example, see [Type Coercion with DataWeave](https://docs.mulesoft.com/dataweave/2.4/dataweave-types-coercion).

- `ns`: Namespaces, used to import a namespace.

  Example

  ```dataweave
  %dw 2.0
  output application/xml

  ns ns0 http://www.abc.com
  ns ns1 http://www.123.com
  ---
  {
      ns0#myroot: {
           ns1#secondroot: "hello world"
      }
  }
  ```

- `fun`: For creating custom functions that can be called from within the body of the script.

  Example

  ```dataweave
  %dw 2.0
  output application/json
  fun toUser(user) = {firstName: user.name, lastName: user.lastName}
  ---
  {
    user: toUser(payload)
  }
  ```

### Including Headers in Inline DataWeave Scripts

You can include header directives when you write inline DataWeave scripts by flattening all the
lines in the DataWeave script into a single line. For smaller DataWeave scripts, this allows you to
quickly apply header directives (without having to add a separate Transform Message component to set
a variable), then substitute the variable in the next Event processor.

For example, here is the Mule configuration XML to create the same valid XML output as the previous
Transform Message component:

Example: Simple Inline DataWeave Script

```xml
<set-payload value="#[output application/xml --- { myroot: payload } ]" doc:name="Set Payload" />
```

Note that the DataWeave documentation provides numerous [transformation examples](#see_also).

## DataWeave Body

The DataWeave body contains an expression that generates the output structure. Note that MuleSoft
provides a canonical way for you to work on data with the DataWeave model: a query, transform, build
process.

Here is simple example that provides JSON input for a DataWeave script:

Example: JSON Input

```json
{
  "message": "Hello world!"
}
```

This DataWeave script takes the entire payload of the JSON input above and transforms it to the
`application/xml` format.

Example: Script that Outputs application/xml

```dataweave
%dw 2.0
output application/xml
---
payload
```

The next example shows the XML output produced from the DataWeave script:

Example: XML Output

```xml
<?xml version='1.0' encoding='UTF-8'?>
<message>Hello world!</message>
```

The script above successfully transforms the JSON input to XML output.

## Errors (Scripting versus Formatting Errors)

A DataWeave script can throw errors due to DataWeave coding errors and due to formatting errors. So
when transforming one data format to another, it is important to keep in mind the constraints of
both the language and the formats. For example, XML requires a single root node. If you use the
[DataWeave script above](#script_output_xml) in the attempt to transform this JSON input to XML, you
will receive an error (`Unexpected internal error`) because the JSON input lacks a single root:

Example: JSON Input

```json
{
  "size": 1,
  "person": {
    "name": "Yoda"
  }
}
```

A good approach to the creation of a script is to normalize the input to the JSON-like
[application/dw](https://docs.mulesoft.com/dataweave/2.4/dataweave-formats#format_dataweave) format. In fact, if you get an error, you can
simply transform your input to `application/dw`. If the transformation is successful, then the error
is likely a formatting error. If it is unsuccessful, then the error is a coding error.

This example changes the output format to `application/dw`:

Example: DataWeave Script that Outputs application/dw

```dataweave
%dw 2.0
output application/dw
---
payload
```

You can see that the script successfully produces `application/dw` output from the
[JSON input example](#json_input) above:

Example: application/dw Output

```dataweave
{
  size: 1,
  person: {
    name: "Yoda"
  }
}
```

So you know that the previous error (`Unexpected internal error`) is specific to the format, not the
coding. You can see that the `application/dw` output above does not provide a single root element,
as required by the XML format. So, to fix the script for _XML_ output, you need to provide a single
root element to your script, for example:

Example: Script that Outputs application/xml

```dataweave
%dw 2.0
output application/xml
---
{
    "myroot" : payload
}
```

Now the output meets the requirements of XML, so when you change the output directive back to
`application/xml`, the result produces valid XML output.

Example: XML Output Containing a Single XML Root

```xml
<?xml version='1.0' encoding='UTF-8'?>
<myroot>
  <size>1</size>
  <person>
    <name>Yoda</name>
  </person>
</myroot>
```

## DataWeave Comments

Comments that use a Java-like syntax are also accepted by DataWeave.

```dataweave
%dw 2.0
output application/json
---
/* Multi-line
 * comment syntax */
payload
// Single-line comment syntax
```

> [!WARNING] To avoid possible errors in Anypoint Studio, use the multi-line comment
> syntax(`/*comment here*/`) if the first line in the body of your DataWeave script is a comment.
> Subsequent script comments can use any syntax (`//comment` or `/*comment*/`)

## Escape Special Characters

In DataWeave, you use the backslash (`\`) to escape special characters that you are using in an
input string.

See [Escaping Special Characters](https://docs.mulesoft.com/dataweave/2.4/dataweave-types#escape-chars-string) for more details.

The _input_ strings in the DataWeave scripts escape special characters, while the _output_ escapes
in accordance with the requirements of the output format, which can vary depending on whether it is
`application/json`, `application/xml`, `application/csv`, or some other format.

This example escapes the internal double quotation mark that is surrounded by double quotation
marks.

DataWeave Example

```txt
%dw 2.0
output application/json
---
{
    "a": "something",
    "b": "dollar sign (\$)",
    "c": 'single quote (\')',
    "c": "double quote (\")",
    "e": `backtick (\`)`
}
```

Notice that the JSON output also escapes the double quotation marks to make the output valid JSON
but does not escape the other characters:

JSON Output

```json
{
  "a": "something",
  "b": "dollar sign ($)",
  "c": "single quote (')",
  "c": "double quote (\")",
  "e": "backtick (`)"
}
```

The following example escapes the same characters but outputs to XML.

DataWeave Example

```txt
%dw 2.0
output application/xml
---
{
  xmlExample:
  {
     "a": "something",
     "b": "dollar sign (\$)",
     "c": 'single quote (\')',
     "d": "double quote (\")",
     "e": `backtick (\`)`
   }
}
```

The XML output (unlike JSON output) is valid without escaping the double quotation marks:

XML Output

```xml
<?xml version='1.0' encoding='UTF-8'?>
<xmlExample>
  <a>something</a>
  <b>dollar sign ($)</b>
  <c>single quote (')</c>
  <d>double quote (")</d>
  <e>backtick (`)</e>
</xmlExample>
```

## Rules for Declaring Valid Identifiers

To declare a valid identifier, its name must meet the following requirements:

- It must begin with a letter of the alphabet (a-z), either lowercase or uppercase.

- After the first letter, the name can contain any combination of letters, numbers, and underscores
  (`_`).

- The name cannot match any DataWeave reserved keyword (see [Reserved Keywords](#reserved-keywords)
  for a complete list).

Here are some examples of valid identifiers:

- `myType`

- `abc123`

- `a1_3BC_22`

- `Z_____4`

- `F`

The following table provides examples of invalid identifiers and a description of what makes them
invalid:

<table><colgroup><col> <col></colgroup><thead><tr><th>Identifier</th><th>Issue</th></tr></thead><tbody><tr><td><div><div><p><code>123456</code></p></div></div></td><td><div><div><p>Cannot start with a number.</p></div></div></td></tr><tr><td><div><div><p><code>value$</code></p></div></div></td><td><div><div><p>Cannot contain special characters.</p></div></div></td></tr><tr><td><div><div><p><code>_number</code></p></div></div></td><td><div><div><p>Cannot start with an underscore.</p></div></div></td></tr><tr><td><div><div><p><code>type</code></p></div></div></td><td><div><div><p>Cannot be a reserved keyword.</p></div></div></td></tr></tbody></table>

### Reserved Keywords

Valid identifiers cannot match any of the reserved DataWeave keywords:

- `and`  
  Reserved as a [logical operator](https://docs.mulesoft.com/dataweave/2.4/dw-operators#logical_operators)

- `as`  
  Reserved for [type coercion](https://docs.mulesoft.com/dataweave/2.4/dataweave-types-coercion)

- `async`  
  Reserved

- `case`  
  Reserved for `case` statements, for example, to perform
  [pattern matching](https://docs.mulesoft.com/dataweave/2.4/dataweave-pattern-matching) or for use with the
  [`update` operator](https://docs.mulesoft.com/dataweave/2.4/dw-operators#update-operator)

- `default`  
  Reserved for assigning [default values](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-defaults) for parameters

- `do`  
  Reserved for [`do`](https://docs.mulesoft.com/dataweave/2.4/dataweave-flow-control) statements

- `else`  
  Reserved for use in if-else and else-if statements

  See [Flow Control in DataWeave](https://docs.mulesoft.com/dataweave/2.4/dataweave-flow-control).

- `enum`  
  Reserved

- `false`  
  Reserved as a Boolean value

- `for`  
  Reserved

- `fun`  
  Reserved for function definitions in [DataWeave Header](#dw_header)

- `if`  
  Reserved for if-else and else-if statements

  See [Flow Control in DataWeave](https://docs.mulesoft.com/dataweave/2.4/dataweave-flow-control).

- `import`  
  Reserved for the `import` directive in [DataWeave Header](#dw_header)

- `input`  
  Reserved

- `is`  
  Reserved

- `ns`  
  Reserved for namespace definitions in [DataWeave Header](#dw_header)

- `null`  
  Reserved as the value `null`

  See [Null (dw::Core Type)](https://docs.mulesoft.com/dataweave/2.4/dataweave-types#dw_type_null).

- `or`  
  Reserved as a [logical operator](https://docs.mulesoft.com/dataweave/2.4/dw-operators#logical_operators)

- `output`  
  Reserved for the `output` directive in [DataWeave Header](#dw_header)

- `private`  
  Reserved

- `throw`  
  Reserved

- `true`  
  Reserved as a Boolean value

- `type`  
  Reserved for type definitions in [DataWeave Header](#dw_header)

- `unless`  
  Reserved

- `using`  
  Reserved for backward compability and replaced by `do`

  See [Scope and Flow Control Operators](https://docs.mulesoft.com/dataweave/2.4/dw-operators#scope-and-flow-control-operators).

- `var`  
  Reserved for variable definitions in the [DataWeave Header](#dw_header)

- `yield`  
  Reserved

## dwl File

In addition to specifying DataWeave scripts in the Transform and other components, you can also
specify the scripts in a `.dwl` file. In Studio projects, your script files are stored in
`src/main/resources`.

In the Mule app XML, you can use the `${file::filename}` syntax to send a script in a `dwl` file
through any XML tag that expects an expression. For example, see the
`when expression="${file::someFile.dwl}"` in the Choice router here:

```xml
<http:listener doc:name="Listener" config-ref="HTTP_Listener_config" path="/test">
  <http:response >
    <http:body ><![CDATA[#[${file::transform.dwl}]]]></http:body>
  </http:response>
</http:listener>
<choice doc:name="Choice"  >
  <when expression="${file::someFile.dwl}" >
    <set-payload value="It's greater than 4!" doc:name="Set Payload"  />
  </when>
  <otherwise >
    <set-payload value="It's less than 4!" doc:name="Set Payload" />
  </otherwise>
</choice>
```

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.4/dataweave-selectors)

- [DataWeave Functions](https://docs.mulesoft.com/dataweave/2.4/dw-functions)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook)

- [Supported Data Formats](https://docs.mulesoft.com/dataweave/2.4/dataweave-formats)

- [Functions and Lambdas](https://docs.mulesoft.com/dataweave/2.4/dataweave-types#functions-and-lambdas)

<!-- document id=7177e9699600fc91a0426d0dd41ca364db6d43575b84139da989a07c2745fb65 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-language-introduction.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# DataWeave Scripts

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave is the primary data transformation language for use in Mule flows.

You can write standalone DataWeave scripts in Transform Message components, or you can write inline
DataWeave expressions to transform data _in-place_ and dynamically set the value of various
properties, such as configuration fields in an event processor or global configuration element.
Inline DataWeave expressions are enclosed in `#[ ]` code blocks. For example, you can use a
DataWeave expression to set conditions in a Choice router or to set the value of a Set Payload or
Set Variable component.

The DataWeave code in this example sets a timestamp variable to the current time using the DataWeave
`now()` function:

Example: Simple Inline DataWeave Script

```xml
<set-variable value="#[now()]" variableName="timestamp" doc:name="Set timestamp" />
```

You can also store DataWeave code in [external files](#dwl_file) and read them into other DataWeave
scripts, or you can factor DataWeave code into modules (libraries) of reusable DataWeave functions
that can be shared by all the components in a Mule app.

## The Structure of DataWeave Scripts

DataWeave scripts and files are divided into two main sections:

- The Header, which defines directives that apply to the body expression (optional).

- The Body, which contains the expression to generate the output structure.

When you include a header, the header appears above the body separated by a delimiter consisting of
three dashes: `---`.

Here is an example of a DataWeave file with an output directive declared in the header, followed by
a DataWeave expression to create a user object that contains two child key/value pairs:

Example: Simple DataWeave Script

```dataweave
%dw 2.0
output application/xml
---
{
  user: {
    firstName: payload.user_firstname,
    lastName: payload.user_lastName
  }
}
```

## DataWeave Header

This example shows keywords (such as `import` and `var`) you can use for header directives.

DataWeave Script

```dataweave
%dw 2.0
import * from dw::core::Arrays
var myVar=13.15
fun toUser(obj) = {
  firstName: obj.field1,
  lastName: obj.field2
}
type Currency = String { format: "##"}
ns ns0 http://www.abc.com
output application/xml
---
/*
 * Body here.
 * /
```

- `%dw`: To maintain backward compatibility with a previous version of DataWeave and avoid
  introducing syntax-breaking changes from the current version, the `%dw` directive supports the
  specification of a previous DataWeave version on a per script basis. Use of this directive is
  optional. The default version is 2.0 if the directive is not present. DataWeave versions from 2.0
  to 2.4 are identical because no syntax changes occurred in those versions.

  Example: `%dw 2.0`

- `output`: Commonly used directive that specifies the mime type that the script outputs.

  Example: `output application/xml`

  Valid values: [Supported Data Formats](https://docs.mulesoft.com/dataweave/2.6/dataweave-formats).

  Default: If no output is specified, the default output is determined by an algorithm that examines
  the inputs (payload, variables, and so on) used in the script:

  1.  If there is no input, the default is `output application/java`.

  2.  If all inputs are the same mime type, the script outputs to the same mime type. For example,
      if all input is `application/json`, then it outputs `output application/json`.

  3.  If the mime types of the inputs differ, and no output is specified, the script throws an
      exception so that you know to specify an output mime type.

      Note that only one output type can be specified.

- `import`: For importing a DataWeave function module. See [DataWeave Functions](https://docs.mulesoft.com/dataweave/2.6/dw-functions).

- `var`: Global variables for defining constants that you can reference throughout the body of the
  DataWeave script:

  Example

  ```dataweave
  %dw 2.0
  var conversionRate=13.15
  output application/json
  ---
  {
   price_dollars: payload.price,
   price_localCurrency: payload.price * conversionRate
  }
  ```

  For details, see [DataWeave Variables](https://docs.mulesoft.com/dataweave/2.6/dataweave-variables).

- `type`: For specifying a custom type that you can use in the expression.

  For a more complete example, see [Type Coercion with DataWeave](https://docs.mulesoft.com/dataweave/2.6/dataweave-types-coercion).

- `ns`: Namespaces, used to import a namespace.

  Example

  ```dataweave
  %dw 2.0
  output application/xml

  ns ns0 http://www.abc.com
  ns ns1 http://www.123.com
  ---
  {
      ns0#myroot: {
           ns1#secondroot: "hello world"
      }
  }
  ```

- `fun`: For creating custom functions that can be called from within the body of the script.

  Example

  ```dataweave
  %dw 2.0
  output application/json
  fun toUser(user) = {firstName: user.name, lastName: user.lastName}
  ---
  {
    user: toUser(payload)
  }
  ```

### Including Headers in Inline DataWeave Scripts

You can include header directives when you write inline DataWeave scripts by flattening all the
lines in the DataWeave script into a single line. For smaller DataWeave scripts, this allows you to
quickly apply header directives (without having to add a separate Transform Message component to set
a variable), then substitute the variable in the next Event processor.

For example, here is the Mule configuration XML to create the same valid XML output as the previous
Transform Message component:

Example: Simple Inline DataWeave Script

```xml
<set-payload value="#[output application/xml --- { myroot: payload } ]" doc:name="Set Payload" />
```

Note that the DataWeave documentation provides numerous [transformation examples](#see_also).

## DataWeave Body

The DataWeave body contains an expression that generates the output structure. Note that MuleSoft
provides a canonical way for you to work on data with the DataWeave model: a query, transform, build
process.

Here is simple example that provides JSON input for a DataWeave script:

Example: JSON Input

```json
{
  "message": "Hello world!"
}
```

This DataWeave script takes the entire payload of the JSON input above and transforms it to the
`application/xml` format.

Example: Script that Outputs application/xml

```dataweave
%dw 2.0
output application/xml
---
payload
```

The next example shows the XML output produced from the DataWeave script:

Example: XML Output

```xml
<?xml version='1.0' encoding='UTF-8'?>
<message>Hello world!</message>
```

The script above successfully transforms the JSON input to XML output.

## Errors (Scripting versus Formatting Errors)

A DataWeave script can throw errors due to DataWeave coding errors and due to formatting errors. So
when transforming one data format to another, it is important to keep in mind the constraints of
both the language and the formats. For example, XML requires a single root node. If you use the
[DataWeave script above](#script_output_xml) in the attempt to transform this JSON input to XML, you
will receive an error (`Unexpected internal error`) because the JSON input lacks a single root:

Example: JSON Input

```json
{
  "size": 1,
  "person": {
    "name": "Yoda"
  }
}
```

A good approach to the creation of a script is to normalize the input to the JSON-like
[application/dw](https://docs.mulesoft.com/dataweave/2.6/dataweave-formats#format_dataweave) format. In fact, if you get an error, you can
simply transform your input to `application/dw`. If the transformation is successful, then the error
is likely a formatting error. If it is unsuccessful, then the error is a coding error.

This example changes the output format to `application/dw`:

Example: DataWeave Script that Outputs application/dw

```dataweave
%dw 2.0
output application/dw
---
payload
```

You can see that the script successfully produces `application/dw` output from the
[JSON input example](#json_input) above:

Example: application/dw Output

```dataweave
{
  size: 1,
  person: {
    name: "Yoda"
  }
}
```

So you know that the previous error (`Unexpected internal error`) is specific to the format, not the
coding. You can see that the `application/dw` output above does not provide a single root element,
as required by the XML format. So, to fix the script for _XML_ output, you need to provide a single
root element to your script, for example:

Example: Script that Outputs application/xml

```dataweave
%dw 2.0
output application/xml
---
{
    "myroot" : payload
}
```

Now the output meets the requirements of XML, so when you change the output directive back to
`application/xml`, the result produces valid XML output.

Example: XML Output Containing a Single XML Root

```xml
<?xml version='1.0' encoding='UTF-8'?>
<myroot>
  <size>1</size>
  <person>
    <name>Yoda</name>
  </person>
</myroot>
```

## DataWeave Comments

Comments that use a Java-like syntax are also accepted by DataWeave.

```dataweave
%dw 2.0
output application/json
---
/* Multi-line
 * comment syntax */
payload
// Single-line comment syntax
```

> [!WARNING] To avoid possible errors in Anypoint Studio, use the multi-line comment
> syntax(`/*comment here*/`) if the first line in the body of your DataWeave script is a comment.
> Subsequent script comments can use any syntax (`//comment` or `/*comment*/`)

## Escape Special Characters

In DataWeave, you use the backslash (`\`) to escape special characters that you are using in an
input string.

See [Escaping Special Characters](https://docs.mulesoft.com/dataweave/2.6/dataweave-types#escape-chars-string) for more details.

The _input_ strings in the DataWeave scripts escape special characters, while the _output_ escapes
in accordance with the requirements of the output format, which can vary depending on whether it is
`application/json`, `application/xml`, `application/csv`, or some other format.

This example escapes the internal double quotation mark that is surrounded by double quotation
marks.

DataWeave Example

```txt
%dw 2.0
output application/json
---
{
    "a": "something",
    "b": "dollar sign (\$)",
    "c": 'single quote (\')',
    "c": "double quote (\")",
    "e": `backtick (\`)`
}
```

Notice that the JSON output also escapes the double quotation marks to make the output valid JSON
but does not escape the other characters:

JSON Output

```json
{
  "a": "something",
  "b": "dollar sign ($)",
  "c": "single quote (')",
  "c": "double quote (\")",
  "e": "backtick (`)"
}
```

The following example escapes the same characters but outputs to XML.

DataWeave Example

```txt
%dw 2.0
output application/xml
---
{
  xmlExample:
  {
     "a": "something",
     "b": "dollar sign (\$)",
     "c": 'single quote (\')',
     "d": "double quote (\")",
     "e": `backtick (\`)`
   }
}
```

The XML output (unlike JSON output) is valid without escaping the double quotation marks:

XML Output

```xml
<?xml version='1.0' encoding='UTF-8'?>
<xmlExample>
  <a>something</a>
  <b>dollar sign ($)</b>
  <c>single quote (')</c>
  <d>double quote (")</d>
  <e>backtick (`)</e>
</xmlExample>
```

## Rules for Declaring Valid Identifiers

To declare a valid identifier, its name must meet the following requirements:

- It must begin with a letter of the alphabet (a-z), either lowercase or uppercase.

- After the first letter, the name can contain any combination of letters, numbers, and underscores
  (`_`).

- The name cannot match any DataWeave reserved keyword (see [Reserved Keywords](#reserved-keywords)
  for a complete list).

Here are some examples of valid identifiers:

- `myType`

- `abc123`

- `a1_3BC_22`

- `Z_____4`

- `F`

The following table provides examples of invalid identifiers and a description of what makes them
invalid:

<table><colgroup><col> <col></colgroup><thead><tr><th>Identifier</th><th>Issue</th></tr></thead><tbody><tr><td><div><div><p><code>123456</code></p></div></div></td><td><div><div><p>Cannot start with a number.</p></div></div></td></tr><tr><td><div><div><p><code>value$</code></p></div></div></td><td><div><div><p>Cannot contain special characters.</p></div></div></td></tr><tr><td><div><div><p><code>_number</code></p></div></div></td><td><div><div><p>Cannot start with an underscore.</p></div></div></td></tr><tr><td><div><div><p><code>type</code></p></div></div></td><td><div><div><p>Cannot be a reserved keyword.</p></div></div></td></tr></tbody></table>

### Reserved Keywords

Valid identifiers cannot match any of the reserved DataWeave keywords:

- `and`  
  Reserved as a [logical operator](https://docs.mulesoft.com/dataweave/2.6/dw-operators#logical_operators)

- `as`  
  Reserved for [type coercion](https://docs.mulesoft.com/dataweave/2.6/dataweave-types-coercion)

- `async`  
  Reserved

- `case`  
  Reserved for `case` statements, for example, to perform
  [pattern matching](https://docs.mulesoft.com/dataweave/2.6/dataweave-pattern-matching) or for use with the
  [`update` operator](https://docs.mulesoft.com/dataweave/2.6/dw-operators#update-operator)

- `default`  
  Reserved for assigning [default values](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-defaults) for parameters

- `do`  
  Reserved for [`do`](https://docs.mulesoft.com/dataweave/2.6/dataweave-flow-control) statements

- `else`  
  Reserved for use in if-else and else-if statements

  See [Flow Control in DataWeave](https://docs.mulesoft.com/dataweave/2.6/dataweave-flow-control).

- `enum`  
  Reserved

- `false`  
  Reserved as a Boolean value

- `for`  
  Reserved

- `fun`  
  Reserved for function definitions in [DataWeave Header](#dw_header)

- `if`  
  Reserved for if-else and else-if statements

  See [Flow Control in DataWeave](https://docs.mulesoft.com/dataweave/2.6/dataweave-flow-control).

- `import`  
  Reserved for the `import` directive in [DataWeave Header](#dw_header)

- `input`  
  Reserved

- `is`  
  Reserved

- `ns`  
  Reserved for namespace definitions in [DataWeave Header](#dw_header)

- `null`  
  Reserved as the value `null`

  See [Null (dw::Core Type)](https://docs.mulesoft.com/dataweave/2.6/dataweave-types#dw_type_null).

- `or`  
  Reserved as a [logical operator](https://docs.mulesoft.com/dataweave/2.6/dw-operators#logical_operators)

- `output`  
  Reserved for the `output` directive in [DataWeave Header](#dw_header)

- `private`  
  Reserved

- `throw`  
  Reserved

- `true`  
  Reserved as a Boolean value

- `type`  
  Reserved for type definitions in [DataWeave Header](#dw_header)

- `unless`  
  Reserved

- `using`  
  Reserved for backward compability and replaced by `do`

  See [Scope and Flow Control Operators](https://docs.mulesoft.com/dataweave/2.6/dw-operators#scope-and-flow-control-operators).

- `var`  
  Reserved for variable definitions in the [DataWeave Header](#dw_header)

- `yield`  
  Reserved

## dwl File

In addition to specifying DataWeave scripts in the Transform and other components, you can also
specify the scripts in a `.dwl` file. In Studio projects, your script files are stored in
`src/main/resources`.

In the Mule app XML, you can use the `${file::filename}` syntax to send a script in a `dwl` file
through any XML tag that expects an expression. For example, see the
`when expression="${file::someFile.dwl}"` in the Choice router here:

```xml
<http:listener doc:name="Listener" config-ref="HTTP_Listener_config" path="/test">
  <http:response >
    <http:body ><![CDATA[#[${file::transform.dwl}]]]></http:body>
  </http:response>
</http:listener>
<choice doc:name="Choice"  >
  <when expression="${file::someFile.dwl}" >
    <set-payload value="It's greater than 4!" doc:name="Set Payload"  />
  </when>
  <otherwise >
    <set-payload value="It's less than 4!" doc:name="Set Payload" />
  </otherwise>
</choice>
```

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.6/dataweave-selectors)

- [DataWeave Functions](https://docs.mulesoft.com/dataweave/2.6/dw-functions)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook)

- [Supported Data Formats](https://docs.mulesoft.com/dataweave/2.6/dataweave-formats)

- [Functions and Lambdas](https://docs.mulesoft.com/dataweave/2.6/dataweave-types#functions-and-lambdas)

<!-- document id=c70b8609e99652661b34483fb24e9d58578a7a92ff0f5a3b2838040966e64fd2 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-language-introduction.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# DataWeave Scripts

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave is the primary data transformation language for use in Mule flows.

You can write standalone DataWeave scripts in Transform Message components, or you can write inline
DataWeave expressions to transform data _in-place_ and dynamically set the value of various
properties, such as configuration fields in an event processor or global configuration element.
Inline DataWeave expressions are enclosed in `#[ ]` code blocks. For example, you can use a
DataWeave expression to set conditions in a Choice router or to set the value of a Set Payload or
Set Variable component.

The DataWeave code in this example sets a timestamp variable to the current time using the DataWeave
`now()` function:

Example: Simple Inline DataWeave Script

```xml
<set-variable value="#[now()]" variableName="timestamp" doc:name="Set timestamp" />
```

You can also store DataWeave code in [external files](#dwl_file) and read them into other DataWeave
scripts, or you can factor DataWeave code into modules (libraries) of reusable DataWeave functions
that can be shared by all the components in a Mule app.

## The Structure of DataWeave Scripts

DataWeave scripts and files are divided into two main sections:

- The Header, which defines directives that apply to the body expression (optional).

- The Body, which contains the expression to generate the output structure.

When you include a header, the header appears above the body separated by a delimiter consisting of
three dashes: `---`.

Here is an example of a DataWeave file with an output directive declared in the header, followed by
a DataWeave expression to create a user object that contains two child key/value pairs:

Example: Simple DataWeave Script

```dataweave
%dw 2.0
output application/xml
---
{
  user: {
    firstName: payload.user_firstname,
    lastName: payload.user_lastName
  }
}
```

## DataWeave Header

This example shows keywords (such as `import` and `var`) you can use for header directives.

DataWeave Script

```dataweave
%dw 2.0
import * from dw::core::Arrays
var myVar=13.15
fun toUser(obj) = {
  firstName: obj.field1,
  lastName: obj.field2
}
type Currency = String { format: "##"}
ns ns0 http://www.abc.com
output application/xml
---
/*
 * Body here.
 * /
```

- `%dw`: To maintain backward compatibility with a previous version of DataWeave and avoid
  introducing syntax-breaking changes from the current version, the `%dw` directive supports the
  specification of a previous DataWeave version on a per script basis. Use of this directive is
  optional. The default version is 2.0 if the directive is not present. DataWeave versions from 2.0
  to 2.4 are identical because no syntax changes occurred in those versions.

  Example: `%dw 2.0`

- `output`: Commonly used directive that specifies the mime type that the script outputs.

  Example: `output application/xml`

  Valid values: [Supported Data Formats](https://docs.mulesoft.com/dataweave/2.9/dataweave-formats).

  Default: If no output is specified, the default output is determined by an algorithm that examines
  the inputs (payload, variables, and so on) used in the script:

  1.  If there is no input, the default is `output application/java`.

  2.  If all inputs are the same mime type, the script outputs to the same mime type. For example,
      if all input is `application/json`, then it outputs `output application/json`.

  3.  If the mime types of the inputs differ, and no output is specified, the script throws an
      exception so that you know to specify an output mime type.

      Note that only one output type can be specified.

- `import`: For importing a DataWeave function module. See [DataWeave Functions](https://docs.mulesoft.com/dataweave/2.9/dw-functions).

- `var`: Global variables for defining constants that you can reference throughout the body of the
  DataWeave script:

  Example

  ```dataweave
  %dw 2.0
  var conversionRate=13.15
  output application/json
  ---
  {
   price_dollars: payload.price,
   price_localCurrency: payload.price * conversionRate
  }
  ```

  For details, see [DataWeave Variables](https://docs.mulesoft.com/dataweave/2.9/dataweave-variables).

- `type`: For specifying a custom type that you can use in the expression.

  For a more complete example, see [Type Coercion with DataWeave](https://docs.mulesoft.com/dataweave/2.9/dataweave-types-coercion).

- `ns`: Namespaces, used to import a namespace.

  Example

  ```dataweave
  %dw 2.0
  output application/xml

  ns ns0 http://www.abc.com
  ns ns1 http://www.123.com
  ---
  {
      ns0#myroot: {
           ns1#secondroot: "hello world"
      }
  }
  ```

- `fun`: For creating custom functions that can be called from within the body of the script.

  Example

  ```dataweave
  %dw 2.0
  output application/json
  fun toUser(user) = {firstName: user.name, lastName: user.lastName}
  ---
  {
    user: toUser(payload)
  }
  ```

### Including Headers in Inline DataWeave Scripts

You can include header directives when you write inline DataWeave scripts by flattening all the
lines in the DataWeave script into a single line. For smaller DataWeave scripts, this allows you to
quickly apply header directives (without having to add a separate Transform Message component to set
a variable), then substitute the variable in the next Event processor.

For example, here is the Mule configuration XML to create the same valid XML output as the previous
Transform Message component:

Example: Simple Inline DataWeave Script

```xml
<set-payload value="#[output application/xml --- { myroot: payload } ]" doc:name="Set Payload" />
```

Note that the DataWeave documentation provides numerous [transformation examples](#see_also).

## DataWeave Body

The DataWeave body contains an expression that generates the output structure. Note that MuleSoft
provides a canonical way for you to work on data with the DataWeave model: a query, transform, build
process.

Here is simple example that provides JSON input for a DataWeave script:

Example: JSON Input

```json
{
  "message": "Hello world!"
}
```

This DataWeave script takes the entire payload of the JSON input above and transforms it to the
`application/xml` format.

Example: Script that Outputs application/xml

```dataweave
%dw 2.0
output application/xml
---
payload
```

The next example shows the XML output produced from the DataWeave script:

Example: XML Output

```xml
<?xml version='1.0' encoding='UTF-8'?>
<message>Hello world!</message>
```

The script above successfully transforms the JSON input to XML output.

## Errors (Scripting versus Formatting Errors)

A DataWeave script can throw errors due to DataWeave coding errors and due to formatting errors. So
when transforming one data format to another, it is important to keep in mind the constraints of
both the language and the formats. For example, XML requires a single root node. If you use the
[DataWeave script above](#script_output_xml) in the attempt to transform this JSON input to XML, you
will receive an error (`Unexpected internal error`) because the JSON input lacks a single root:

Example: JSON Input

```json
{
  "size": 1,
  "person": {
    "name": "Yoda"
  }
}
```

A good approach to the creation of a script is to normalize the input to the JSON-like
[application/dw](https://docs.mulesoft.com/dataweave/2.9/dataweave-formats#format_dataweave) format. In fact, if you get an error, you can
simply transform your input to `application/dw`. If the transformation is successful, then the error
is likely a formatting error. If it is unsuccessful, then the error is a coding error.

This example changes the output format to `application/dw`:

Example: DataWeave Script that Outputs application/dw

```dataweave
%dw 2.0
output application/dw
---
payload
```

You can see that the script successfully produces `application/dw` output from the
[JSON input example](#json_input) above:

Example: application/dw Output

```dataweave
{
  size: 1,
  person: {
    name: "Yoda"
  }
}
```

So you know that the previous error (`Unexpected internal error`) is specific to the format, not the
coding. You can see that the `application/dw` output above does not provide a single root element,
as required by the XML format. So, to fix the script for _XML_ output, you need to provide a single
root element to your script, for example:

Example: Script that Outputs application/xml

```dataweave
%dw 2.0
output application/xml
---
{
    "myroot" : payload
}
```

Now the output meets the requirements of XML, so when you change the output directive back to
`application/xml`, the result produces valid XML output.

Example: XML Output Containing a Single XML Root

```xml
<?xml version='1.0' encoding='UTF-8'?>
<myroot>
  <size>1</size>
  <person>
    <name>Yoda</name>
  </person>
</myroot>
```

## DataWeave Comments

Comments that use a Java-like syntax are also accepted by DataWeave.

```dataweave
%dw 2.0
output application/json
---
/* Multi-line
 * comment syntax */
payload
// Single-line comment syntax
```

> [!WARNING] To avoid possible errors in Anypoint Studio, use the multi-line comment
> syntax(`/*comment here*/`) if the first line in the body of your DataWeave script is a comment.
> Subsequent script comments can use any syntax (`//comment` or `/*comment*/`)

## Escape Special Characters

In DataWeave, you use the backslash (`\`) to escape special characters that you are using in an
input string.

See [Escaping Special Characters](https://docs.mulesoft.com/dataweave/2.9/dataweave-types#escape-chars-string) for more details.

The _input_ strings in the DataWeave scripts escape special characters, while the _output_ escapes
in accordance with the requirements of the output format, which can vary depending on whether it is
`application/json`, `application/xml`, `application/csv`, or some other format.

This example escapes the internal double quotation mark that is surrounded by double quotation
marks.

DataWeave Example

```txt
%dw 2.0
output application/json
---
{
    "a": "something",
    "b": "dollar sign (\$)",
    "c": 'single quote (\')',
    "c": "double quote (\")",
    "e": `backtick (\`)`
}
```

Notice that the JSON output also escapes the double quotation marks to make the output valid JSON
but does not escape the other characters:

JSON Output

```json
{
  "a": "something",
  "b": "dollar sign ($)",
  "c": "single quote (')",
  "c": "double quote (\")",
  "e": "backtick (`)"
}
```

The following example escapes the same characters but outputs to XML.

DataWeave Example

```txt
%dw 2.0
output application/xml
---
{
  xmlExample:
  {
     "a": "something",
     "b": "dollar sign (\$)",
     "c": 'single quote (\')',
     "d": "double quote (\")",
     "e": `backtick (\`)`
   }
}
```

The XML output (unlike JSON output) is valid without escaping the double quotation marks:

XML Output

```xml
<?xml version='1.0' encoding='UTF-8'?>
<xmlExample>
  <a>something</a>
  <b>dollar sign ($)</b>
  <c>single quote (')</c>
  <d>double quote (")</d>
  <e>backtick (`)</e>
</xmlExample>
```

## Rules for Declaring Valid Identifiers

To declare a valid identifier, its name must meet the following requirements:

- It must begin with a letter of the alphabet (a-z), either lowercase or uppercase.

- After the first letter, the name can contain any combination of letters, numbers, and underscores
  (`_`).

- The name cannot match any DataWeave reserved keyword (see [Reserved Keywords](#reserved-keywords)
  for a complete list).

Here are some examples of valid identifiers:

- `myType`

- `abc123`

- `a1_3BC_22`

- `Z_____4`

- `F`

The following table provides examples of invalid identifiers and a description of what makes them
invalid:

<table><colgroup><col> <col></colgroup><thead><tr><th>Identifier</th><th>Issue</th></tr></thead><tbody><tr><td><div><div><p><code>123456</code></p></div></div></td><td><div><div><p>Cannot start with a number.</p></div></div></td></tr><tr><td><div><div><p><code>value$</code></p></div></div></td><td><div><div><p>Cannot contain special characters.</p></div></div></td></tr><tr><td><div><div><p><code>_number</code></p></div></div></td><td><div><div><p>Cannot start with an underscore.</p></div></div></td></tr><tr><td><div><div><p><code>type</code></p></div></div></td><td><div><div><p>Cannot be a reserved keyword.</p></div></div></td></tr></tbody></table>

### Reserved Keywords

Valid identifiers cannot match any of the reserved DataWeave keywords:

- `and`  
  Reserved as a [logical operator](https://docs.mulesoft.com/dataweave/2.9/dw-operators#logical_operators)

- `as`  
  Reserved for [type coercion](https://docs.mulesoft.com/dataweave/2.9/dataweave-types-coercion)

- `async`  
  Reserved

- `case`  
  Reserved for `case` statements, for example, to perform
  [pattern matching](https://docs.mulesoft.com/dataweave/2.9/dataweave-pattern-matching) or for use with the
  [`update` operator](https://docs.mulesoft.com/dataweave/2.9/dw-operators#update-operator)

- `default`  
  Reserved for assigning [default values](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-defaults) for parameters

- `do`  
  Reserved for [`do`](https://docs.mulesoft.com/dataweave/2.9/dataweave-flow-control) statements

- `else`  
  Reserved for use in if-else and else-if statements

  See [Flow Control in DataWeave](https://docs.mulesoft.com/dataweave/2.9/dataweave-flow-control).

- `enum`  
  Reserved

- `false`  
  Reserved as a Boolean value

- `for`  
  Reserved

- `fun`  
  Reserved for function definitions in [DataWeave Header](#dw_header)

- `if`  
  Reserved for if-else and else-if statements

  See [Flow Control in DataWeave](https://docs.mulesoft.com/dataweave/2.9/dataweave-flow-control).

- `import`  
  Reserved for the `import` directive in [DataWeave Header](#dw_header)

- `input`  
  Reserved

- `is`  
  Reserved

- `ns`  
  Reserved for namespace definitions in [DataWeave Header](#dw_header)

- `null`  
  Reserved as the value `null`

  See [Null (dw::Core Type)](https://docs.mulesoft.com/dataweave/2.9/dataweave-types#dw_type_null).

- `or`  
  Reserved as a [logical operator](https://docs.mulesoft.com/dataweave/2.9/dw-operators#logical_operators)

- `output`  
  Reserved for the `output` directive in [DataWeave Header](#dw_header)

- `private`  
  Reserved

- `throw`  
  Reserved

- `true`  
  Reserved as a Boolean value

- `type`  
  Reserved for type definitions in [DataWeave Header](#dw_header)

- `unless`  
  Reserved

- `using`  
  Reserved for backward compability and replaced by `do`

  See [Scope and Flow Control Operators](https://docs.mulesoft.com/dataweave/2.9/dw-operators#scope-and-flow-control-operators).

- `var`  
  Reserved for variable definitions in the [DataWeave Header](#dw_header)

- `yield`  
  Reserved

## dwl File

In addition to specifying DataWeave scripts in the Transform and other components, you can also
specify the scripts in a `.dwl` file. In Studio projects, your script files are stored in
`src/main/resources`.

In the Mule app XML, you can use the `${file::filename}` syntax to send a script in a `dwl` file
through any XML tag that expects an expression. For example, see the
`when expression="${file::someFile.dwl}"` in the Choice router here:

```xml
<http:listener doc:name="Listener" config-ref="HTTP_Listener_config" path="/test">
  <http:response >
    <http:body ><![CDATA[#[${file::transform.dwl}]]]></http:body>
  </http:response>
</http:listener>
<choice doc:name="Choice"  >
  <when expression="${file::someFile.dwl}" >
    <set-payload value="It's greater than 4!" doc:name="Set Payload"  />
  </when>
  <otherwise >
    <set-payload value="It's less than 4!" doc:name="Set Payload" />
  </otherwise>
</choice>
```

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.9/dataweave-selectors)

- [DataWeave Functions](https://docs.mulesoft.com/dataweave/2.9/dw-functions)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook)

- [Supported Data Formats](https://docs.mulesoft.com/dataweave/2.9/dataweave-formats)

- [Functions and Lambdas](https://docs.mulesoft.com/dataweave/2.9/dataweave-types#functions-and-lambdas)

<!-- document id=e18e99fea090827eb61e2bbade3e995b42be5997a34a7be91bd4856cf0f388ea url=/mulesoft/current/en-us/dataweave/latest/dataweave-language-introduction.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# DataWeave Scripts

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave is the primary data transformation language for use in Mule flows.

You can write standalone DataWeave scripts in Transform Message components, or you can write inline
DataWeave expressions to transform data _in-place_ and dynamically set the value of various
properties, such as configuration fields in an event processor or global configuration element.
Inline DataWeave expressions are enclosed in `#[ ]` code blocks. For example, you can use a
DataWeave expression to set conditions in a Choice router or to set the value of a Set Payload or
Set Variable component.

The DataWeave code in this example sets a timestamp variable to the current time using the DataWeave
`now()` function:

Example: Simple Inline DataWeave Script

```xml
<set-variable value="#[now()]" variableName="timestamp" doc:name="Set timestamp" />
```

You can also store DataWeave code in [external files](#dwl_file) and read them into other DataWeave
scripts, or you can factor DataWeave code into modules (libraries) of reusable DataWeave functions
that can be shared by all the components in a Mule app.

## The Structure of DataWeave Scripts

DataWeave scripts and files are divided into two main sections:

- The Header, which defines directives that apply to the body expression (optional).

- The Body, which contains the expression to generate the output structure.

When you include a header, the header appears above the body separated by a delimiter consisting of
three dashes: `---`.

Here is an example of a DataWeave file with an output directive declared in the header, followed by
a DataWeave expression to create a user object that contains two child key/value pairs:

Example: Simple DataWeave Script

```dataweave
%dw 2.0
output application/xml
---
{
  user: {
    firstName: payload.user_firstname,
    lastName: payload.user_lastName
  }
}
```

## DataWeave Header

This example shows keywords (such as `import` and `var`) you can use for header directives.

DataWeave Script

```dataweave
%dw 2.0
import * from dw::core::Arrays
var myVar=13.15
fun toUser(obj) = {
  firstName: obj.field1,
  lastName: obj.field2
}
type Currency = String { format: "##"}
ns ns0 http://www.abc.com
output application/xml
---
/*
 * Body here.
 * /
```

- `%dw`: To maintain backward compatibility with a previous version of DataWeave and avoid
  introducing syntax-breaking changes from the current version, the `%dw` directive supports the
  specification of a previous DataWeave version on a per script basis. Use of this directive is
  optional. The default version is 2.0 if the directive is not present. DataWeave versions from 2.0
  to 2.4 are identical because no syntax changes occurred in those versions.

  Example: `%dw 2.0`

- `output`: Commonly used directive that specifies the mime type that the script outputs.

  Example: `output application/xml`

  Valid values: [Supported Data Formats](https://docs.mulesoft.com/dataweave/latest/dataweave-formats).

  Default: If no output is specified, the default output is determined by an algorithm that examines
  the inputs (payload, variables, and so on) used in the script:

  1.  If there is no input, the default is `output application/java`.

  2.  If all inputs are the same mime type, the script outputs to the same mime type. For example,
      if all input is `application/json`, then it outputs `output application/json`.

  3.  If the mime types of the inputs differ, and no output is specified, the script throws an
      exception so that you know to specify an output mime type.

      Note that only one output type can be specified.

- `import`: For importing a DataWeave function module. See [DataWeave Functions](https://docs.mulesoft.com/dataweave/latest/dw-functions).

- `var`: Global variables for defining constants that you can reference throughout the body of the
  DataWeave script:

  Example

  ```dataweave
  %dw 2.0
  var conversionRate=13.15
  output application/json
  ---
  {
   price_dollars: payload.price,
   price_localCurrency: payload.price * conversionRate
  }
  ```

  For details, see [DataWeave Variables](https://docs.mulesoft.com/dataweave/latest/dataweave-variables).

- `type`: For specifying a custom type that you can use in the expression.

  For a more complete example, see [Type Coercion with DataWeave](https://docs.mulesoft.com/dataweave/latest/dataweave-types-coercion).

- `ns`: Namespaces, used to import a namespace.

  Example

  ```dataweave
  %dw 2.0
  output application/xml

  ns ns0 http://www.abc.com
  ns ns1 http://www.123.com
  ---
  {
      ns0#myroot: {
           ns1#secondroot: "hello world"
      }
  }
  ```

- `fun`: For creating custom functions that can be called from within the body of the script.

  Example

  ```dataweave
  %dw 2.0
  output application/json
  fun toUser(user) = {firstName: user.name, lastName: user.lastName}
  ---
  {
    user: toUser(payload)
  }
  ```

### Including Headers in Inline DataWeave Scripts

You can include header directives when you write inline DataWeave scripts by flattening all the
lines in the DataWeave script into a single line. For smaller DataWeave scripts, this allows you to
quickly apply header directives (without having to add a separate Transform Message component to set
a variable), then substitute the variable in the next Event processor.

For example, here is the Mule configuration XML to create the same valid XML output as the previous
Transform Message component:

Example: Simple Inline DataWeave Script

```xml
<set-payload value="#[output application/xml --- { myroot: payload } ]" doc:name="Set Payload" />
```

Note that the DataWeave documentation provides numerous [transformation examples](#see_also).

## DataWeave Body

The DataWeave body contains an expression that generates the output structure. Note that MuleSoft
provides a canonical way for you to work on data with the DataWeave model: a query, transform, build
process.

Here is simple example that provides JSON input for a DataWeave script:

Example: JSON Input

```json
{
  "message": "Hello world!"
}
```

This DataWeave script takes the entire payload of the JSON input above and transforms it to the
`application/xml` format.

Example: Script that Outputs application/xml

```dataweave
%dw 2.0
output application/xml
---
payload
```

The next example shows the XML output produced from the DataWeave script:

Example: XML Output

```xml
<?xml version='1.0' encoding='UTF-8'?>
<message>Hello world!</message>
```

The script above successfully transforms the JSON input to XML output.

## Errors (Scripting versus Formatting Errors)

A DataWeave script can throw errors due to DataWeave coding errors and due to formatting errors. So
when transforming one data format to another, it is important to keep in mind the constraints of
both the language and the formats. For example, XML requires a single root node. If you use the
[DataWeave script above](#script_output_xml) in the attempt to transform this JSON input to XML, you
will receive an error (`Unexpected internal error`) because the JSON input lacks a single root:

Example: JSON Input

```json
{
  "size": 1,
  "person": {
    "name": "Yoda"
  }
}
```

A good approach to the creation of a script is to normalize the input to the JSON-like
[application/dw](https://docs.mulesoft.com/dataweave/latest/dataweave-formats#format_dataweave) format. In fact, if you get an error, you can
simply transform your input to `application/dw`. If the transformation is successful, then the error
is likely a formatting error. If it is unsuccessful, then the error is a coding error.

This example changes the output format to `application/dw`:

Example: DataWeave Script that Outputs application/dw

```dataweave
%dw 2.0
output application/dw
---
payload
```

You can see that the script successfully produces `application/dw` output from the
[JSON input example](#json_input) above:

Example: application/dw Output

```dataweave
{
  size: 1,
  person: {
    name: "Yoda"
  }
}
```

So you know that the previous error (`Unexpected internal error`) is specific to the format, not the
coding. You can see that the `application/dw` output above does not provide a single root element,
as required by the XML format. So, to fix the script for _XML_ output, you need to provide a single
root element to your script, for example:

Example: Script that Outputs application/xml

```dataweave
%dw 2.0
output application/xml
---
{
    "myroot" : payload
}
```

Now the output meets the requirements of XML, so when you change the output directive back to
`application/xml`, the result produces valid XML output.

Example: XML Output Containing a Single XML Root

```xml
<?xml version='1.0' encoding='UTF-8'?>
<myroot>
  <size>1</size>
  <person>
    <name>Yoda</name>
  </person>
</myroot>
```

## DataWeave Comments

Comments that use a Java-like syntax are also accepted by DataWeave.

```dataweave
%dw 2.0
output application/json
---
/* Multi-line
 * comment syntax */
payload
// Single-line comment syntax
```

> [!WARNING] To avoid possible errors in Anypoint Studio, use the multi-line comment
> syntax(`/*comment here*/`) if the first line in the body of your DataWeave script is a comment.
> Subsequent script comments can use any syntax (`//comment` or `/*comment*/`)

## Escape Special Characters

In DataWeave, you use the backslash (`\`) to escape special characters that you are using in an
input string.

See [Escaping Special Characters](https://docs.mulesoft.com/dataweave/latest/dataweave-types#escape-chars-string) for more details.

The _input_ strings in the DataWeave scripts escape special characters, while the _output_ escapes
in accordance with the requirements of the output format, which can vary depending on whether it is
`application/json`, `application/xml`, `application/csv`, or some other format.

This example escapes the internal double quotation mark that is surrounded by double quotation
marks.

DataWeave Example

```txt
%dw 2.0
output application/json
---
{
    "a": "something",
    "b": "dollar sign (\$)",
    "c": 'single quote (\')',
    "c": "double quote (\")",
    "e": `backtick (\`)`
}
```

Notice that the JSON output also escapes the double quotation marks to make the output valid JSON
but does not escape the other characters:

JSON Output

```json
{
  "a": "something",
  "b": "dollar sign ($)",
  "c": "single quote (')",
  "c": "double quote (\")",
  "e": "backtick (`)"
}
```

The following example escapes the same characters but outputs to XML.

DataWeave Example

```txt
%dw 2.0
output application/xml
---
{
  xmlExample:
  {
     "a": "something",
     "b": "dollar sign (\$)",
     "c": 'single quote (\')',
     "d": "double quote (\")",
     "e": `backtick (\`)`
   }
}
```

The XML output (unlike JSON output) is valid without escaping the double quotation marks:

XML Output

```xml
<?xml version='1.0' encoding='UTF-8'?>
<xmlExample>
  <a>something</a>
  <b>dollar sign ($)</b>
  <c>single quote (')</c>
  <d>double quote (")</d>
  <e>backtick (`)</e>
</xmlExample>
```

## Rules for Declaring Valid Identifiers

To declare a valid identifier, its name must meet the following requirements:

- It must begin with a letter of the alphabet (a-z), either lowercase or uppercase.

- After the first letter, the name can contain any combination of letters, numbers, and underscores
  (`_`).

- The name cannot match any DataWeave reserved keyword (see [Reserved Keywords](#reserved-keywords)
  for a complete list).

Here are some examples of valid identifiers:

- `myType`

- `abc123`

- `a1_3BC_22`

- `Z_____4`

- `F`

The following table provides examples of invalid identifiers and a description of what makes them
invalid:

<table><colgroup><col> <col></colgroup><thead><tr><th>Identifier</th><th>Issue</th></tr></thead><tbody><tr><td><div><div><p><code>123456</code></p></div></div></td><td><div><div><p>Cannot start with a number.</p></div></div></td></tr><tr><td><div><div><p><code>value$</code></p></div></div></td><td><div><div><p>Cannot contain special characters.</p></div></div></td></tr><tr><td><div><div><p><code>_number</code></p></div></div></td><td><div><div><p>Cannot start with an underscore.</p></div></div></td></tr><tr><td><div><div><p><code>type</code></p></div></div></td><td><div><div><p>Cannot be a reserved keyword.</p></div></div></td></tr></tbody></table>

### Reserved Keywords

Valid identifiers cannot match any of the reserved DataWeave keywords:

- `and`  
  Reserved as a [logical operator](https://docs.mulesoft.com/dataweave/latest/dw-operators#logical_operators)

- `as`  
  Reserved for [type coercion](https://docs.mulesoft.com/dataweave/latest/dataweave-types-coercion)

- `async`  
  Reserved

- `case`  
  Reserved for `case` statements, for example, to perform
  [pattern matching](https://docs.mulesoft.com/dataweave/latest/dataweave-pattern-matching) or for use with the
  [`update` operator](https://docs.mulesoft.com/dataweave/latest/dw-operators#update-operator)

- `default`  
  Reserved for assigning [default values](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-defaults) for parameters

- `do`  
  Reserved for [`do`](https://docs.mulesoft.com/dataweave/latest/dataweave-flow-control) statements

- `else`  
  Reserved for use in if-else and else-if statements

  See [Flow Control in DataWeave](https://docs.mulesoft.com/dataweave/latest/dataweave-flow-control).

- `enum`  
  Reserved

- `false`  
  Reserved as a Boolean value

- `for`  
  Reserved

- `fun`  
  Reserved for function definitions in [DataWeave Header](#dw_header)

- `if`  
  Reserved for if-else and else-if statements

  See [Flow Control in DataWeave](https://docs.mulesoft.com/dataweave/latest/dataweave-flow-control).

- `import`  
  Reserved for the `import` directive in [DataWeave Header](#dw_header)

- `input`  
  Reserved

- `is`  
  Reserved

- `ns`  
  Reserved for namespace definitions in [DataWeave Header](#dw_header)

- `null`  
  Reserved as the value `null`

  See [Null (dw::Core Type)](https://docs.mulesoft.com/dataweave/latest/dataweave-types#dw_type_null).

- `or`  
  Reserved as a [logical operator](https://docs.mulesoft.com/dataweave/latest/dw-operators#logical_operators)

- `output`  
  Reserved for the `output` directive in [DataWeave Header](#dw_header)

- `private`  
  Reserved

- `throw`  
  Reserved

- `true`  
  Reserved as a Boolean value

- `type`  
  Reserved for type definitions in [DataWeave Header](#dw_header)

- `unless`  
  Reserved

- `using`  
  Reserved for backward compability and replaced by `do`

  See [Scope and Flow Control Operators](https://docs.mulesoft.com/dataweave/latest/dw-operators#scope-and-flow-control-operators).

- `var`  
  Reserved for variable definitions in the [DataWeave Header](#dw_header)

- `yield`  
  Reserved

## dwl File

In addition to specifying DataWeave scripts in the Transform and other components, you can also
specify the scripts in a `.dwl` file. In Studio projects, your script files are stored in
`src/main/resources`.

In the Mule app XML, you can use the `${file::filename}` syntax to send a script in a `dwl` file
through any XML tag that expects an expression. For example, see the
`when expression="${file::someFile.dwl}"` in the Choice router here:

```xml
<http:listener doc:name="Listener" config-ref="HTTP_Listener_config" path="/test">
  <http:response >
    <http:body ><![CDATA[#[${file::transform.dwl}]]]></http:body>
  </http:response>
</http:listener>
<choice doc:name="Choice"  >
  <when expression="${file::someFile.dwl}" >
    <set-payload value="It's greater than 4!" doc:name="Set Payload"  />
  </when>
  <otherwise >
    <set-payload value="It's less than 4!" doc:name="Set Payload" />
  </otherwise>
</choice>
```

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors)

- [DataWeave Functions](https://docs.mulesoft.com/dataweave/latest/dw-functions)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook)

- [Supported Data Formats](https://docs.mulesoft.com/dataweave/latest/dataweave-formats)

- [Functions and Lambdas](https://docs.mulesoft.com/dataweave/latest/dataweave-types#functions-and-lambdas)

<!-- document id=89691ee923f1d2f9af990893ed4eedaf88e7f63412fe4e25a54aaab56dad71a4 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-selectors.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# DataWeave Selectors

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave selectors traverse the structures of objects and arrays and return matching values.

A selector always operates within a context, which can be a reference to a variable, an object
literal, an array literal, or the invocation of a DataWeave function.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Selector Type</th><th>Syntax</th><th>Return Type</th></tr></thead><tbody><tr><td><p>Single-value</p></td><td><p><code>.keyName</code></p></td><td><p>Any type of value that belongs to a matching key</p></td></tr><tr><td><p>Multi-value</p></td><td><p><code>.*keyName</code></p></td><td><p>Array of values of any matching keys</p></td></tr><tr><td><p>Descendants</p></td><td><p><code>..keyName</code></p></td><td><p>Array of values of any matching descendant keys</p></td></tr><tr><td><p>Dynamic</p></td><td><p>See <a href="#dynamic_selector">Dynamic Selector</a>.</p></td><td><p>&nbsp;</p></td></tr><tr><td><p>Key-value pair</p></td><td><p><code>.&amp;keyName</code></p></td><td><p>Object with the matching key</p></td></tr><tr><td><p>Index</p></td><td><p><code>[&lt;index&gt;]</code></p></td><td><p>Value of any type at selected array index. Use negative numbers to index from the end of an array, for example, <code>-1</code> for the last element in the array. Use of numbers beyond the array size returns <code>null</code>.</p></td></tr><tr><td><p>Range</p></td><td><p><code>[&lt;index&gt; to &lt;index&gt;]</code></p></td><td><p>Array with values from selected indexes</p></td></tr><tr><td><p>XML attribute</p></td><td><p><code>@</code>, <code>.@keyName</code></p></td><td><p>String value of the selected attribute</p></td></tr><tr><td><p>Namespace</p></td><td><p><code>keyName.#</code></p></td><td><p>String value of the namespace for the selected key</p></td></tr><tr><td><p>Key present</p></td><td><p><code>keyName?</code>, <code>keyName.@type?</code></p></td><td><p>Boolean (<code>true</code> if the selected key of an object or XML attribute is present, <code>false</code> if not)</p></td></tr><tr><td><p>Assert present</p></td><td><p><code>keyName!</code></p></td><td><p>String: Exception message if the key is not present</p></td></tr><tr><td><p>Filter</p></td><td><p><code>[?(boolean_expression)]</code></p></td><td><p>Array or object containing key-value pairs <em>if</em> the DataWeave expression returns <code>true</code>. Otherwise, returns the value <code>null</code>.</p></td></tr><tr><td><p>Metadata</p></td><td><p><code>.^someMetadata</code></p></td><td><div><div><p>Returns the value of specified metadata for a Mule payload, variable, or attribute. The selector can return the value of class (<code>.^class</code>), content length (<code>.^contentLength</code>), encoding (<code>.^encoding</code>), mime type (<code>.^mimeType</code>), media type (<code>.^mediaType</code>), raw (<code>.^raw</code>), and custom (<code>.^myCustomMetadata</code>) metadata. For details, see <a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-extract-data#selector_metadata">Extract Data</a>.</p></div></div></td></tr></tbody></table>

> [!NOTE] The following examples use these selectors. For additional examples of selectors, see
> [Extract Data](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-extract-data).

## Rules for Matching

In DataWeave, a name that matches the key of an object (such as the key `"someName"` in the JSON
object `{ "someName" : "Data Weave" }`) can select data from that object. For a simple example, see
[Single-Value Selector](#single_value_selector).

## Single-Value Selector

This selector matches the value of the first key-value pair in which the key matches the given
selector name. The selector can be applied to an Object or to an array. On an array, the selector
applies to all Object values inside the array and ignores all values that are not Object values. If
no key matches, the value `null` is returned.

> [!NOTE] For information about the dot selector (`.`) and how to use it on DataWeave types, refer
> to [Selecting Types](https://docs.mulesoft.com/dataweave/2.11/dataweave-selecting-types).

### Example: Using a Single-Value Selector on an Object

This example shows how the selector works on a simple JSON object.

#### Input Payload

The input payload is an object with the key `"name"` and the value `"DataWeave"`:

```JSON
{ "name": "Data Weave" }
```

#### DataWeave Source

The DataWeave script uses `payload.name` to select the value of the object that has the key
`"name"`. Note that `payload.name` and `payload."name"` are both valid ways to perform the
selection.

```DataWeave
%dw 2.0
output application/json
---
payload.name
```

#### Output

The script outputs the String value of the input object, "Data Weave":

```JSON
"Data Weave"
```

### Example: Using a Single-Value Selector on an Array

On an array, the selector applies to every element.

#### Input Payload

The input payload is an array that contains two objects with the same key, "name":

```JSON
[
  {
    "name": "Arg"
  },
  {
    "name": "Japan"
  }
]
```

#### DataWeave Source

The DataWeave script uses `payload.name` to select the value of any objects in input payload that
have the key "name":

```DataWeave
%dw 2.0
output application/json
---
payload.name
```

#### Output

The script outputs an array that contains the values of the input objects with the key `"name"`:
`"Arg"` and `"Japan"`:

```json
["Arg", "Japan"]
```

## Namespace Selector

The DataWeave namespace selector supports the use of a name that matches a namespace or a local
part. To match a namespace, the name must match the namespace and the local part. If the name only
matches the local part, the selector matches all namespaces with that local part, regardless of the
namespace.

Note that XML namespaces and their prefixes are defined in the `xmlns` attribute of an XML element.
For example, the element `<h:table xmlns:h="http://www.w3.org/TR/html4/"/>` defines a namespace that
assigns the prefix `h` to the namespace
`[http://www.w3.org/TR/html4/](http://www.w3.org/TR/html4/)`. All elements in that namespace contain
the `h` prefix. For example, in the element `<h:table/>`, `h` is the prefix for the namespace, and
`table` is the local part.

### Example: Using a Namespace Selector

This example selects values from XML elements using the namespace and local part.

#### Input Payload

The input payload contains XML elements, `h:table` and `f:table`, that have different namespaces but
the same local names (`table`):

```xml
<root>

  <h:table xmlns:h="http://www.w3.org/TR/html4/">
    <h:tr>
      <h:td>Apples</h:td>
      <h:td>Bananas</h:td>
    </h:tr>
  </h:table>

  <f:table xmlns:f="https://www.w3schools.com/furniture">
    <f:tr>
      <f:name>African Coffee Table</f:name>
      <f:width>80</f:width>
      <f:length>120</f:length>
    </f:tr>
  </f:table>

</root>
```

#### DataWeave Source

The DataWeave script selects XML content from specified namespaces. The script’s header creates
namespace (`ns`) variables `html` and `furniture` to store namespaces from the input payload. To
select the children of `h:table` into element `a` and the children of `f:table` elements into
element `b`, the script uses the `html` and `furniture` namespace variables with a namespace
selector (`#`) and local part (`table`):

```DataWeave
%dw 2.0
output application/xml
ns html http://www.w3.org/TR/html4/
ns furniture https://www.w3schools.com/furniture
---
root: {
     a: payload.root.html#table,
     b: payload.root.furniture#table
 }
```

#### Output

The script outputs children of the `h:table` element under element `a` and the children of the
`f:table` under element `b`:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<root>
  <a>
    <h:tr xmlns:h="http://www.w3.org/TR/html4/">
      <h:td>Apples</h:td>
      <h:td>Bananas</h:td>
    </h:tr>
  </a>
  <b>
    <f:tr xmlns:f="https://www.w3schools.com/furniture">
      <f:name>African Coffee Table</f:name>
      <f:width>80</f:width>
      <f:length>120</f:length>
    </f:tr>
  </b>
</root>
```

### Example: Using a Local Name to Select XML Values

This example selects XML values using a local name `table` from the `h:table` element.

#### Input Payload

The input payload contains XML with a `table` element that contains the namespace
`"http://www.w3.org/TR/html4/"`:

```xml
<root>
  <h:table xmlns:h="http://www.w3.org/TR/html4/">
    <h:tr>
      <h:td>Apples</h:td>
      <h:td>Bananas</h:td>
    </h:tr>
  </h:table>
</root>
```

#### DataWeave Source

The DataWeave script selects values of children in the `table` element by using a local name of the
XML element `table` instead of its namespace:

```DataWeave
%dw 2.0
output application/xml
---
root: { a: payload.root.table }
```

#### Output

The script outputs XML that contains the values of children in the `table` element:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<root>
  <a>
    <h:tr xmlns:h="http://www.w3.org/TR/html4/">
      <h:td>Apples</h:td>
      <h:td>Bananas</h:td>
    </h:tr>
  </a>
</root>
```

## Attribute Selector

The attribute selector returns the first attribute value that matches the selected name expression.
If no key matches, the selection returns the value `null`.

The following example selects the value of an XML attribute.

### Input Payload

The input payload is an XML `user` element that contains the attribute `name="Weave"`:

```xml
<user name="Weave"/>
```

### DataWeave Source

The DataWeave script selects the value of the `name` attribute from the input payload
(`<user name="Weave"/>`). Notice that the `@` indicates an attribute selection.

```DataWeave
%dw 2.0
output application/json
---
payload.user.@name
```

### Output

The DataWeave script outputs the value of `name` attribute.

```json
"Weave"
```

## Multi-Value Selector

Instead of returning the value of the first matching key in an array of objects, the multi-value
selector (`*`) returns an array containing values to the matching key (for example, `*user` where
`user` is the key). The selector does not return the values of descendants, only those at the
specified level. If no key matches, the selection returns the value `null`.

### Input Payload

The input payload contains an XML array of `user` elements.

```xml
<users>
  <user>Weave</user>
  <user>BAT</user>
  <user>TF</user>
</users>
```

### DataWeave Source

The DataWeave script uses `*user` to select the values of all `user` elements from the input
payload.

```DataWeave
%dw 2.0
output application/json
---
payload.users.*user
```

### Output

The script outputs an array of `user` values.

```json
["Weave", "BAT", "TF"]
```

## Descendant Selector

The descendant selector returns a list of all children and their descendants. You can directly chain
this selector to any other selector without using a single `.`. For example, `payload..` recursively
returns an array of all the child values, the values of _their_ children, and so on. You can also
chain the selector to another element (for example, with `payload..user`) to select the values of
each `user` key and its descendants, or you can use `payload..*name` to select the values of all
`name` descendants.

### Example: Selecting Each Descendant

This example selects each descendant of the input payload.

#### Input Payload

The input payload contains a set of elements that are nested at different levels.

```xml
<users>
  <user>
    <name>Weave</name>
    <user>
      <name>BAT</name>
      <user>
        <name>BDD</name>
      </user>
    </user>
  </user>
</users>
```

#### DataWeave Source

The DataWeave script uses `..` to recursively select all elements in the input payload and return
them in a JSON array.

```DataWeave
%dw 2.0
output application/json
---
payload..
```

#### Output

```json
[
  {
    "user": {
      "name": "Weave",
      "user": {
        "name": "BAT",
        "user": {
          "name": "BDD"
        }
      }
    }
  },
  {
    "name": "Weave",
    "user": {
      "name": "BAT",
      "user": {
        "name": "BDD"
      }
    }
  },
  "Weave",
  {
    "name": "BAT",
    "user": {
      "name": "BDD"
    }
  },
  "BAT",
  {
    "name": "BDD"
  },
  "BDD"
]
```

### Example: Selecting Descending Values

This example selects the descending `name` values.

#### Input Payload

The input payload contains a set of `name` elements that are nested at different levels.

```xml
<users>
  <user>
    <name>Weave</name>
    <user>
      <name>BAT</name>
      <name>Munit</name>
      <user>
        <name>BDD</name>
      </user>
    </user>
  </user>
</users>
```

#### DataWeave Source

The DataWeave script uses `..` to select the values of all first `name` elements from the input
payload and output those values into a JSON array.

```DataWeave
%dw 2.0
output application/json
---
payload..name
```

#### Output

The script outputs a JSON array with all `name` values.

```json
["Weave", "BAT", "BDD"]
```

### Example

This example selects the descending `name` values.

#### Input Payload

The input payload contains a set of `name` elements that are nested at different levels.

```xml
<users>
  <user>
    <name>Weave</name>
    <user>
      <name>BAT</name>
      <name>Munit</name>
      <user>
        <name>BDD</name>
      </user>
    </user>
  </user>
</users>
```

#### DataWeave Source

The DataWeave script uses `..*` to select the values of all `name` elements from the input payload
and output those values into a JSON array, including the `BAT` and `Munit` values of the repeated
`name` keys that are at the same level in the XML hierarchy.

```DataWeave
%dw 2.0
output application/json
---
payload..*name
```

#### Output

The script outputs a JSON array with all `name` values.

```json
["Weave", "BAT", "Munit", "BDD"]
```

### Example: Selecting Descending Values

This example selects the descending `Name` values of the `Item` elements.

#### Input Payload

The input payload contains a set of `Name` elements that are nested at different levels.

```xml
<Example>
    <Brand>
        <Id>32345</Id>
        <logo>circle</logo>
        <Item>
            <Name>Perfume</Name>
            <Item>
                <Name>Bosque</Name>
            </Item>
        </Item>
        <Item>
            <Name>t-Shirt</Name>
        </Item>
    </Brand>
    <Brand>
        <Id>435678C</Id>
        <logo>circle</logo>
        <Item>
            <Name>t-Shirt2</Name>
            <Item>
                <Name>t-Shirt red</Name>
                <Item>
                    <Name>t-Shirt red with logo</Name>
                </Item>
            </Item>
        </Item>
    </Brand>
</Example>
```

#### DataWeave Source

The DataWeave script uses `..*` to select the values of all `Name` elements nested in the `Item`
elements from the input payload and output those values into a XML array.

```DataWeave
%dw 2.0
output application/xml
---
{
    Supermarket: {
        Item: {
            Value: payload..*Item.Name
        }
    }
}
```

#### Output

The script outputs a XML array with all `name` values.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<Supermarket>
  <Item>
    <Value>Perfume</Value>
    <Value>t-Shirt</Value>
    <Value>Bosque</Value>
    <Value>t-Shirt2</Value>
    <Value>t-Shirt red</Value>
    <Value>t-Shirt red with logo</Value>
  </Item>
</Supermarket>
```

## Dynamic Selector

The syntax for dynamic selection depends on what you are selecting:

- Single Value: `payload[(nameExpression)]`

- Multi Value: `payload[*(nameExpression)]`

- Attribute: `payload[@(nameExpression)]`

- Key Value: `payload[&(nameExpression)]`

- Single Value with a Namespace: `payload.ns0#"$(nameExpression)"`

### Example: Dynamically Selecting a Single Value

This example shows how to dynamically select a single value.

#### Input Payload

The input payload is an array of objects. The first object has the key `"ref"` and the value
`"name"`. The second has the key `"name"` and the value `"Data Weave"`:

```JSON
{ "ref": "name", "name": "Data Weave" }
```

#### DataWeave Source

The DataWeave script dynamically selects the value of the `"name"` key:

```DataWeave
%dw 2.0
output application/json
---
payload[(payload.ref)]
```

Notice that it passes `payload.ref` within the parentheses of dynamic selector `[()]`. The script
works because the value of `"ref"` is `"name"`, which matches the key `"name"`.

#### Output

The script outputs the value of the object that has the `"name"` key:

```JSON
"Data Weave"
```

### Example: Dynamically Selecting a Single Value with a Namespace

This example shows how to dynamically select a single value that contains a namespace.

#### Input Payload

The input payload contains a `<root/>` element with two child elements, one of which has the
namespace `http://www.w3.org/TR/html4/`. Both child elements (`<f:table/>` and `<h:table>`) have the
local name `table`:

```xml
<root ref="table">
    <f:table xmlns:f="https://www.w3schools.com/furniture">Manzana</f:table>
    <h:table xmlns:h="http://www.w3.org/TR/html4/">Banana</h:table>
</root>
```

#### DataWeave Source

The DataWeave script dynamically selects the value of the element that has the namespace
`http://www.w3.org/TR/html4/`:

```DataWeave
%dw 2.0
output application/json
ns h http://www.w3.org/TR/html4/
---
payload.root.h#"$(payload.root.@ref)"
```

Notice that the expression `payload.root.@ref` uses the attribute selector (`@`) on the `ref`
attribute of the `root` element to select the value `table`, which matches local name `table` in the
element `<h:table xmlns:h="http://www.w3.org/TR/html4/">Banana</h:table>`.

#### Output

The script outputs the value of the element that has the namespace `http://www.w3.org/TR/html4/`:

```JSON
"Banana"
```

## Use of Selectors on Content Stored in Variables

All selectors work with the [predefined Mule Runtime variables](https://docs.mulesoft.com/dataweave/2.11/dataweave-variables-context) and
with [DataWeave variables](https://docs.mulesoft.com/dataweave/2.11/dataweave-variables).

To select [Mule event](https://docs.mulesoft.com/mule-runtime/latest/about-mule-event) data, such as the payload, an
attribute, or variable data within the Mule event, use predefined Mule Runtime variables, such as
`payload`, `attributes`, and `vars`.

Extracted values are handled as literal values of one of the supported DataWeave value types.

<table><colgroup><col> <col></colgroup><thead><tr><th>Data to extract</th><th>Syntax</th></tr></thead><tbody><tr><td><p><strong>Payload</strong></p></td><td><div><div><p><code>payload</code>, for example: <code>payload.name</code></p></div><div><p>If the <code>payload</code> is <code>{"name" : "somebody"}</code>, <code>payload.name</code> returns <code>"somebody"</code>.</p></div><div><p>For more on the Mule payload, see <a href="https://docs.mulesoft.com/mule-runtime/latest/about-mule-message#_message_payload">Message Payload</a>.</p></div></div></td></tr><tr><td><p><strong>Attribute</strong></p></td><td><div><div><p><code>attributes.&lt;myAttributeName&gt;</code></p></div><div><p>For examples, see <a href="https://docs.mulesoft.com/mule-runtime/latest/about-mule-message#_attributes">Attributes</a>.</p></div></div></td></tr><tr><td><p><strong>Variable</strong></p></td><td><div><div><p><code>&lt;myVariableName&gt;</code></p></div><div><p>To avoid name collisions, you must prepend <code>vars</code> to the variable name:</p></div><div><p><code>vars.&lt;myVariableName&gt;</code></p></div><div><p>For more on Mule variables, see <a href="https://docs.mulesoft.com/mule-runtime/latest/about-mule-variables">Variables in Mule Apps</a>.</p></div></div></td></tr><tr><td><p><strong>Error object</strong></p></td><td><div><div><p><code>error</code></p></div><div><p>For information on errors in the flow, you can use <code>#[error.cause]</code>.</p></div></div></td></tr><tr><td><p><strong>Flow</strong></p></td><td><div><div><p><code>flow</code></p></div><div><p>For the flow name in the Logger: <code>#[flow.name]</code></p></div><div><p>Note that <code>flow.name</code> does not work in some Core components, such as Set Payload and Transform Message.</p></div><div><p>For more on flows, see <a href="https://docs.mulesoft.com/mule-runtime/latest/about-flows">Flows and Subflows</a>.</p></div></div></td></tr></tbody></table>

<!-- document id=660a91ae6cae2a4dcbfa58c9c3fd2a5f37349d5b82096613cab7bdfa643ad36a url=/mulesoft/current/en-us/dataweave/2.12/dataweave-selectors.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# DataWeave Selectors

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave selectors traverse the structures of objects and arrays and return matching values.

A selector always operates within a context, which can be a reference to a variable, an object
literal, an array literal, or the invocation of a DataWeave function.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Selector Type</th><th>Syntax</th><th>Return Type</th></tr></thead><tbody><tr><td><p>Single-value</p></td><td><p><code>.keyName</code></p></td><td><p>Any type of value that belongs to a matching key</p></td></tr><tr><td><p>Multi-value</p></td><td><p><code>.*keyName</code></p></td><td><p>Array of values of any matching keys</p></td></tr><tr><td><p>Descendants</p></td><td><p><code>..keyName</code></p></td><td><p>Array of values of any matching descendant keys</p></td></tr><tr><td><p>Dynamic</p></td><td><p>See <a href="#dynamic_selector">Dynamic Selector</a>.</p></td><td><p>&nbsp;</p></td></tr><tr><td><p>Key-value pair</p></td><td><p><code>.&amp;keyName</code></p></td><td><p>Object with the matching key</p></td></tr><tr><td><p>Index</p></td><td><p><code>[&lt;index&gt;]</code></p></td><td><p>Value of any type at selected array index. Use negative numbers to index from the end of an array, for example, <code>-1</code> for the last element in the array. Use of numbers beyond the array size returns <code>null</code>.</p></td></tr><tr><td><p>Range</p></td><td><p><code>[&lt;index&gt; to &lt;index&gt;]</code></p></td><td><p>Array with values from selected indexes</p></td></tr><tr><td><p>XML attribute</p></td><td><p><code>@</code>, <code>.@keyName</code></p></td><td><p>String value of the selected attribute</p></td></tr><tr><td><p>Namespace</p></td><td><p><code>keyName.#</code></p></td><td><p>String value of the namespace for the selected key</p></td></tr><tr><td><p>Key present</p></td><td><p><code>keyName?</code>, <code>keyName.@type?</code></p></td><td><p>Boolean (<code>true</code> if the selected key of an object or XML attribute is present, <code>false</code> if not)</p></td></tr><tr><td><p>Assert present</p></td><td><p><code>keyName!</code></p></td><td><p>String: Exception message if the key is not present</p></td></tr><tr><td><p>Filter</p></td><td><p><code>[?(boolean_expression)]</code></p></td><td><p>Array or object containing key-value pairs <em>if</em> the DataWeave expression returns <code>true</code>. Otherwise, returns the value <code>null</code>.</p></td></tr><tr><td><p>Metadata</p></td><td><p><code>.^someMetadata</code></p></td><td><div><div><p>Returns the value of specified metadata for a Mule payload, variable, or attribute. The selector can return the value of class (<code>.^class</code>), content length (<code>.^contentLength</code>), encoding (<code>.^encoding</code>), mime type (<code>.^mimeType</code>), media type (<code>.^mediaType</code>), raw (<code>.^raw</code>), and custom (<code>.^myCustomMetadata</code>) metadata. For details, see <a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-extract-data#selector_metadata">Extract Data</a>.</p></div></div></td></tr></tbody></table>

> [!NOTE] The following examples use these selectors. For additional examples of selectors, see
> [Extract Data](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-extract-data).

## Rules for Matching

In DataWeave, a name that matches the key of an object (such as the key `"someName"` in the JSON
object `{ "someName" : "Data Weave" }`) can select data from that object. For a simple example, see
[Single-Value Selector](#single_value_selector).

## Single-Value Selector

This selector matches the value of the first key-value pair in which the key matches the given
selector name. The selector can be applied to an Object or to an array. On an array, the selector
applies to all Object values inside the array and ignores all values that are not Object values. If
no key matches, the value `null` is returned.

> [!NOTE] For information about the dot selector (`.`) and how to use it on DataWeave types, refer
> to [Selecting Types](https://docs.mulesoft.com/dataweave/2.12/dataweave-selecting-types).

### Example: Using a Single-Value Selector on an Object

This example shows how the selector works on a simple JSON object.

#### Input Payload

The input payload is an object with the key `"name"` and the value `"DataWeave"`:

```JSON
{ "name": "Data Weave" }
```

#### DataWeave Source

The DataWeave script uses `payload.name` to select the value of the object that has the key
`"name"`. Note that `payload.name` and `payload."name"` are both valid ways to perform the
selection.

```DataWeave
%dw 2.0
output application/json
---
payload.name
```

#### Output

The script outputs the String value of the input object, "Data Weave":

```JSON
"Data Weave"
```

### Example: Using a Single-Value Selector on an Array

On an array, the selector applies to every element.

#### Input Payload

The input payload is an array that contains two objects with the same key, "name":

```JSON
[
  {
    "name": "Arg"
  },
  {
    "name": "Japan"
  }
]
```

#### DataWeave Source

The DataWeave script uses `payload.name` to select the value of any objects in input payload that
have the key "name":

```DataWeave
%dw 2.0
output application/json
---
payload.name
```

#### Output

The script outputs an array that contains the values of the input objects with the key `"name"`:
`"Arg"` and `"Japan"`:

```json
["Arg", "Japan"]
```

## Namespace Selector

The DataWeave namespace selector supports the use of a name that matches a namespace or a local
part. To match a namespace, the name must match the namespace and the local part. If the name only
matches the local part, the selector matches all namespaces with that local part, regardless of the
namespace.

Note that XML namespaces and their prefixes are defined in the `xmlns` attribute of an XML element.
For example, the element `<h:table xmlns:h="http://www.w3.org/TR/html4/"/>` defines a namespace that
assigns the prefix `h` to the namespace
`[http://www.w3.org/TR/html4/](http://www.w3.org/TR/html4/)`. All elements in that namespace contain
the `h` prefix. For example, in the element `<h:table/>`, `h` is the prefix for the namespace, and
`table` is the local part.

### Example: Using a Namespace Selector

This example selects values from XML elements using the namespace and local part.

#### Input Payload

The input payload contains XML elements, `h:table` and `f:table`, that have different namespaces but
the same local names (`table`):

```xml
<root>

  <h:table xmlns:h="http://www.w3.org/TR/html4/">
    <h:tr>
      <h:td>Apples</h:td>
      <h:td>Bananas</h:td>
    </h:tr>
  </h:table>

  <f:table xmlns:f="https://www.w3schools.com/furniture">
    <f:tr>
      <f:name>African Coffee Table</f:name>
      <f:width>80</f:width>
      <f:length>120</f:length>
    </f:tr>
  </f:table>

</root>
```

#### DataWeave Source

The DataWeave script selects XML content from specified namespaces. The script’s header creates
namespace (`ns`) variables `html` and `furniture` to store namespaces from the input payload. To
select the children of `h:table` into element `a` and the children of `f:table` elements into
element `b`, the script uses the `html` and `furniture` namespace variables with a namespace
selector (`#`) and local part (`table`):

```DataWeave
%dw 2.0
output application/xml
ns html http://www.w3.org/TR/html4/
ns furniture https://www.w3schools.com/furniture
---
root: {
     a: payload.root.html#table,
     b: payload.root.furniture#table
 }
```

#### Output

The script outputs children of the `h:table` element under element `a` and the children of the
`f:table` under element `b`:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<root>
  <a>
    <h:tr xmlns:h="http://www.w3.org/TR/html4/">
      <h:td>Apples</h:td>
      <h:td>Bananas</h:td>
    </h:tr>
  </a>
  <b>
    <f:tr xmlns:f="https://www.w3schools.com/furniture">
      <f:name>African Coffee Table</f:name>
      <f:width>80</f:width>
      <f:length>120</f:length>
    </f:tr>
  </b>
</root>
```

### Example: Using a Local Name to Select XML Values

This example selects XML values using a local name `table` from the `h:table` element.

#### Input Payload

The input payload contains XML with a `table` element that contains the namespace
`"http://www.w3.org/TR/html4/"`:

```xml
<root>
  <h:table xmlns:h="http://www.w3.org/TR/html4/">
    <h:tr>
      <h:td>Apples</h:td>
      <h:td>Bananas</h:td>
    </h:tr>
  </h:table>
</root>
```

#### DataWeave Source

The DataWeave script selects values of children in the `table` element by using a local name of the
XML element `table` instead of its namespace:

```DataWeave
%dw 2.0
output application/xml
---
root: { a: payload.root.table }
```

#### Output

The script outputs XML that contains the values of children in the `table` element:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<root>
  <a>
    <h:tr xmlns:h="http://www.w3.org/TR/html4/">
      <h:td>Apples</h:td>
      <h:td>Bananas</h:td>
    </h:tr>
  </a>
</root>
```

## Attribute Selector

The attribute selector returns the first attribute value that matches the selected name expression.
If no key matches, the selection returns the value `null`.

The following example selects the value of an XML attribute.

### Input Payload

The input payload is an XML `user` element that contains the attribute `name="Weave"`:

```xml
<user name="Weave"/>
```

### DataWeave Source

The DataWeave script selects the value of the `name` attribute from the input payload
(`<user name="Weave"/>`). Notice that the `@` indicates an attribute selection.

```DataWeave
%dw 2.0
output application/json
---
payload.user.@name
```

### Output

The DataWeave script outputs the value of `name` attribute.

```json
"Weave"
```

## Multi-Value Selector

Instead of returning the value of the first matching key in an array of objects, the multi-value
selector (`*`) returns an array containing values to the matching key (for example, `*user` where
`user` is the key). The selector does not return the values of descendants, only those at the
specified level. If no key matches, the selection returns the value `null`.

### Input Payload

The input payload contains an XML array of `user` elements.

```xml
<users>
  <user>Weave</user>
  <user>BAT</user>
  <user>TF</user>
</users>
```

### DataWeave Source

The DataWeave script uses `*user` to select the values of all `user` elements from the input
payload.

```DataWeave
%dw 2.0
output application/json
---
payload.users.*user
```

### Output

The script outputs an array of `user` values.

```json
["Weave", "BAT", "TF"]
```

## Descendant Selector

The descendant selector returns a list of all children and their descendants. You can directly chain
this selector to any other selector without using a single `.`. For example, `payload..` recursively
returns an array of all the child values, the values of _their_ children, and so on. You can also
chain the selector to another element (for example, with `payload..user`) to select the values of
each `user` key and its descendants, or you can use `payload..*name` to select the values of all
`name` descendants.

### Example: Selecting Each Descendant

This example selects each descendant of the input payload.

#### Input Payload

The input payload contains a set of elements that are nested at different levels.

```xml
<users>
  <user>
    <name>Weave</name>
    <user>
      <name>BAT</name>
      <user>
        <name>BDD</name>
      </user>
    </user>
  </user>
</users>
```

#### DataWeave Source

The DataWeave script uses `..` to recursively select all elements in the input payload and return
them in a JSON array.

```DataWeave
%dw 2.0
output application/json
---
payload..
```

#### Output

```json
[
  {
    "user": {
      "name": "Weave",
      "user": {
        "name": "BAT",
        "user": {
          "name": "BDD"
        }
      }
    }
  },
  {
    "name": "Weave",
    "user": {
      "name": "BAT",
      "user": {
        "name": "BDD"
      }
    }
  },
  "Weave",
  {
    "name": "BAT",
    "user": {
      "name": "BDD"
    }
  },
  "BAT",
  {
    "name": "BDD"
  },
  "BDD"
]
```

### Example: Selecting Descending Values

This example selects the descending `name` values.

#### Input Payload

The input payload contains a set of `name` elements that are nested at different levels.

```xml
<users>
  <user>
    <name>Weave</name>
    <user>
      <name>BAT</name>
      <name>Munit</name>
      <user>
        <name>BDD</name>
      </user>
    </user>
  </user>
</users>
```

#### DataWeave Source

The DataWeave script uses `..` to select the values of all first `name` elements from the input
payload and output those values into a JSON array.

```DataWeave
%dw 2.0
output application/json
---
payload..name
```

#### Output

The script outputs a JSON array with all `name` values.

```json
["Weave", "BAT", "BDD"]
```

### Example

This example selects the descending `name` values.

#### Input Payload

The input payload contains a set of `name` elements that are nested at different levels.

```xml
<users>
  <user>
    <name>Weave</name>
    <user>
      <name>BAT</name>
      <name>Munit</name>
      <user>
        <name>BDD</name>
      </user>
    </user>
  </user>
</users>
```

#### DataWeave Source

The DataWeave script uses `..*` to select the values of all `name` elements from the input payload
and output those values into a JSON array, including the `BAT` and `Munit` values of the repeated
`name` keys that are at the same level in the XML hierarchy.

```DataWeave
%dw 2.0
output application/json
---
payload..*name
```

#### Output

The script outputs a JSON array with all `name` values.

```json
["Weave", "BAT", "Munit", "BDD"]
```

### Example: Selecting Descending Values

This example selects the descending `Name` values of the `Item` elements.

#### Input Payload

The input payload contains a set of `Name` elements that are nested at different levels.

```xml
<Example>
    <Brand>
        <Id>32345</Id>
        <logo>circle</logo>
        <Item>
            <Name>Perfume</Name>
            <Item>
                <Name>Bosque</Name>
            </Item>
        </Item>
        <Item>
            <Name>t-Shirt</Name>
        </Item>
    </Brand>
    <Brand>
        <Id>435678C</Id>
        <logo>circle</logo>
        <Item>
            <Name>t-Shirt2</Name>
            <Item>
                <Name>t-Shirt red</Name>
                <Item>
                    <Name>t-Shirt red with logo</Name>
                </Item>
            </Item>
        </Item>
    </Brand>
</Example>
```

#### DataWeave Source

The DataWeave script uses `..*` to select the values of all `Name` elements nested in the `Item`
elements from the input payload and output those values into a XML array.

```DataWeave
%dw 2.0
output application/xml
---
{
    Supermarket: {
        Item: {
            Value: payload..*Item.Name
        }
    }
}
```

#### Output

The script outputs a XML array with all `name` values.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<Supermarket>
  <Item>
    <Value>Perfume</Value>
    <Value>t-Shirt</Value>
    <Value>Bosque</Value>
    <Value>t-Shirt2</Value>
    <Value>t-Shirt red</Value>
    <Value>t-Shirt red with logo</Value>
  </Item>
</Supermarket>
```

## Dynamic Selector

The syntax for dynamic selection depends on what you are selecting:

- Single Value: `payload[(nameExpression)]`

- Multi Value: `payload[*(nameExpression)]`

- Attribute: `payload[@(nameExpression)]`

- Key Value: `payload[&(nameExpression)]`

- Single Value with a Namespace: `payload.ns0#"$(nameExpression)"`

### Example: Dynamically Selecting a Single Value

This example shows how to dynamically select a single value.

#### Input Payload

The input payload is an array of objects. The first object has the key `"ref"` and the value
`"name"`. The second has the key `"name"` and the value `"Data Weave"`:

```JSON
{ "ref": "name", "name": "Data Weave" }
```

#### DataWeave Source

The DataWeave script dynamically selects the value of the `"name"` key:

```DataWeave
%dw 2.0
output application/json
---
payload[(payload.ref)]
```

Notice that it passes `payload.ref` within the parentheses of dynamic selector `[()]`. The script
works because the value of `"ref"` is `"name"`, which matches the key `"name"`.

#### Output

The script outputs the value of the object that has the `"name"` key:

```JSON
"Data Weave"
```

### Example: Dynamically Selecting a Single Value with a Namespace

This example shows how to dynamically select a single value that contains a namespace.

#### Input Payload

The input payload contains a `<root/>` element with two child elements, one of which has the
namespace `http://www.w3.org/TR/html4/`. Both child elements (`<f:table/>` and `<h:table>`) have the
local name `table`:

```xml
<root ref="table">
    <f:table xmlns:f="https://www.w3schools.com/furniture">Manzana</f:table>
    <h:table xmlns:h="http://www.w3.org/TR/html4/">Banana</h:table>
</root>
```

#### DataWeave Source

The DataWeave script dynamically selects the value of the element that has the namespace
`http://www.w3.org/TR/html4/`:

```DataWeave
%dw 2.0
output application/json
ns h http://www.w3.org/TR/html4/
---
payload.root.h#"$(payload.root.@ref)"
```

Notice that the expression `payload.root.@ref` uses the attribute selector (`@`) on the `ref`
attribute of the `root` element to select the value `table`, which matches local name `table` in the
element `<h:table xmlns:h="http://www.w3.org/TR/html4/">Banana</h:table>`.

#### Output

The script outputs the value of the element that has the namespace `http://www.w3.org/TR/html4/`:

```JSON
"Banana"
```

## Use of Selectors on Content Stored in Variables

All selectors work with the [predefined Mule Runtime variables](https://docs.mulesoft.com/dataweave/2.12/dataweave-variables-context) and
with [DataWeave variables](https://docs.mulesoft.com/dataweave/2.12/dataweave-variables).

To select [Mule event](https://docs.mulesoft.com/mule-runtime/latest/about-mule-event) data, such as the payload, an
attribute, or variable data within the Mule event, use predefined Mule Runtime variables, such as
`payload`, `attributes`, and `vars`.

Extracted values are handled as literal values of one of the supported DataWeave value types.

<table><colgroup><col> <col></colgroup><thead><tr><th>Data to extract</th><th>Syntax</th></tr></thead><tbody><tr><td><p><strong>Payload</strong></p></td><td><div><div><p><code>payload</code>, for example: <code>payload.name</code></p></div><div><p>If the <code>payload</code> is <code>{"name" : "somebody"}</code>, <code>payload.name</code> returns <code>"somebody"</code>.</p></div><div><p>For more on the Mule payload, see <a href="https://docs.mulesoft.com/mule-runtime/latest/about-mule-message#_message_payload">Message Payload</a>.</p></div></div></td></tr><tr><td><p><strong>Attribute</strong></p></td><td><div><div><p><code>attributes.&lt;myAttributeName&gt;</code></p></div><div><p>For examples, see <a href="https://docs.mulesoft.com/mule-runtime/latest/about-mule-message#_attributes">Attributes</a>.</p></div></div></td></tr><tr><td><p><strong>Variable</strong></p></td><td><div><div><p><code>&lt;myVariableName&gt;</code></p></div><div><p>To avoid name collisions, you must prepend <code>vars</code> to the variable name:</p></div><div><p><code>vars.&lt;myVariableName&gt;</code></p></div><div><p>For more on Mule variables, see <a href="https://docs.mulesoft.com/mule-runtime/latest/about-mule-variables">Variables in Mule Apps</a>.</p></div></div></td></tr><tr><td><p><strong>Error object</strong></p></td><td><div><div><p><code>error</code></p></div><div><p>For information on errors in the flow, you can use <code>#[error.cause]</code>.</p></div></div></td></tr><tr><td><p><strong>Flow</strong></p></td><td><div><div><p><code>flow</code></p></div><div><p>For the flow name in the Logger: <code>#[flow.name]</code></p></div><div><p>Note that <code>flow.name</code> does not work in some Core components, such as Set Payload and Transform Message.</p></div><div><p>For more on flows, see <a href="https://docs.mulesoft.com/mule-runtime/latest/about-flows">Flows and Subflows</a>.</p></div></div></td></tr></tbody></table>

<!-- document id=3fe825ade623516bc48fb8c247277c41dbadf9437a9a7c050d851b9453093e57 url=/mulesoft/current/en-us/dataweave/2.3/dataweave-selectors.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# DataWeave Selectors

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave version 2 selectors traverse the structures of objects and arrays and return matching
values.

A selector always operates within a context, which can be a reference to a variable, an object
literal, an array literal, or the invocation of a DataWeave function.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Selector Type</th><th>Syntax</th><th>Return Type</th></tr></thead><tbody><tr><td><p>Single-value</p></td><td><p><code>.keyName</code></p></td><td><p>Any type of value that belongs to a matching key</p></td></tr><tr><td><p>Multi-value</p></td><td><p><code>.*keyName</code></p></td><td><p>Array of values of any matching keys</p></td></tr><tr><td><p>Descendants</p></td><td><p><code>..keyName</code></p></td><td><p>Array of values of any matching descendant keys</p></td></tr><tr><td><p>Dynamic</p></td><td><p>See <a href="#dynamic_selector">Dynamic Selector</a>.</p></td><td><p>&nbsp;</p></td></tr><tr><td><p>Key-value pair</p></td><td><p><code>.&amp;keyName</code></p></td><td><p>Object with the matching key</p></td></tr><tr><td><p>Index</p></td><td><p><code>[&lt;index&gt;]</code></p></td><td><p>Value of any type at selected array index. Use negative numbers to index from the end of an array, for example, <code>-1</code> for the last element in the array. Use of numbers beyond the array size returns <code>null</code>.</p></td></tr><tr><td><p>Range</p></td><td><p><code>[&lt;index&gt; to &lt;index&gt;]</code></p></td><td><p>Array with values from selected indexes</p></td></tr><tr><td><p>XML attribute</p></td><td><p><code>@</code>, <code>.@keyName</code></p></td><td><p>String value of the selected attribute</p></td></tr><tr><td><p>Namespace</p></td><td><p><code>keyName.#</code></p></td><td><p>String value of the namespace for the selected key</p></td></tr><tr><td><p>Key present</p></td><td><p><code>keyName?</code>, <code>keyName.@type?</code></p></td><td><p>Boolean (<code>true</code> if the selected key of an object or XML attribute is present, <code>false</code> if not)</p></td></tr><tr><td><p>Assert present</p></td><td><p><code>keyName!</code></p></td><td><p>String: Exception message if the key is not present</p></td></tr><tr><td><p>Filter</p></td><td><p><code>[?(boolean_expression)]</code></p></td><td><p>Array or object containing key-value pairs <em>if</em> the DataWeave expression returns <code>true</code>. Otherwise, returns the value <code>null</code>.</p></td></tr><tr><td><p>Metadata</p></td><td><p><code>.^someMetadata</code></p></td><td><div><div><p>Returns the value of specified metadata for a Mule payload, variable, or attribute. The selector can return the value of class (<code>.^class</code>), content length (<code>.^contentLength</code>), encoding (<code>.^encoding</code>), mime type (<code>.^mimeType</code>), media type (<code>.^mediaType</code>), raw (<code>.^raw</code>), and custom (<code>.^myCustomMetadata</code>) metadata. For details, see <a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-extract-data#selector_metadata">Extract Data</a>.</p></div></div></td></tr></tbody></table>

> [!NOTE] The following examples use these selectors. For additional examples, see
> [Extract Data](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-extract-data).

## Rules for Matching

In DataWeave, a name that matches the key of an object (such as the key `"someName"` in the JSON
object `{ "someName" : "Data Weave" }`) can select data from that object. For a simple example, see
[Single-Value Selector](#single_value_selector).

## Single-Value Selector

This selector matches the value of the first key-value pair in which the key matches the given
selector name. The selector can be applied to an Object or to an array. On an array, the selector
applies to all Object values inside the array and ignores all values that are not Object values. If
no key matches, the value `null` is returned.

### Example: Using a Single-Value Selector on an Object

This example shows how the selector works on a simple JSON object.

#### Input Payload

The input payload is an object with the key `"name"` and the value `"DataWeave"`:

```JSON
{ "name": "Data Weave" }
```

#### DataWeave Source

The DataWeave script uses `payload.name` to select the value of the object that has the key
`"name"`. Note that `payload.name` and `payload."name"` are both valid ways to perform the
selection.

```DataWeave
%dw 2.0
output application/json
---
payload.name
```

#### Output

The script outputs the String value of the input object, "Data Weave":

```JSON
"Data Weave"
```

### Example: Using a Single-Value Selector on an Array

On an array, the selector applies to every element.

#### Input Payload

The input payload is an array that contains two objects with the same key, "name":

```JSON
[
  {
    "name": "Arg"
  },
  {
    "name": "Japan"
  }
]
```

#### DataWeave Source

The DataWeave script uses `payload.name` to select the value of any objects in input payload that
have the key "name":

```DataWeave
%dw 2.0
output application/json
---
payload.name
```

#### Output

The script outputs an array that contains the values of the input objects with the key `"name"`:
`"Arg"` and `"Japan"`:

```json
["Arg", "Japan"]
```

## Namespace Selector

The DataWeave namespace selector supports the use of a name that matches a namespace or a local
part. To match a namespace, the name must match the namespace and the local part. If the name only
matches the local part, the selector matches all namespaces with that local part, regardless of the
namespace.

Note that XML namespaces and their prefixes are defined in the `xmlns` attribute of an XML element.
For example, the element `<h:table xmlns:h="http://www.w3.org/TR/html4/"/>` defines a namespace that
assigns the prefix `h` to the namespace
`[http://www.w3.org/TR/html4/](http://www.w3.org/TR/html4/)`. All elements in that namespace contain
the `h` prefix. For example, in the element `<h:table/>`, `h` is the prefix for the namespace, and
`table` is the local part.

### Example: Using a Namespace Selector

This example selects values from XML elements using the namespace and local part.

#### Input Payload

The input payload contains XML elements, `h:table` and `f:table`, that have different namespaces but
the same local names (`table`):

```xml
<root>

  <h:table xmlns:h="http://www.w3.org/TR/html4/">
    <h:tr>
      <h:td>Apples</h:td>
      <h:td>Bananas</h:td>
    </h:tr>
  </h:table>

  <f:table xmlns:f="https://www.w3schools.com/furniture">
    <f:tr>
      <f:name>African Coffee Table</f:name>
      <f:width>80</f:width>
      <f:length>120</f:length>
    </f:tr>
  </f:table>

</root>
```

#### DataWeave Source

The DataWeave script selects XML content from specified namespaces. The script’s header creates
namespace (`ns`) variables `html` and `furniture` to store namespaces from the input payload. To
select the children of `h:table` into element `a` and the children of `f:table` elements into
element `b`, the script uses the `html` and `furniture` namespace variables with a namespace
selector (`#`) and local part (`table`):

```DataWeave
%dw 2.0
output application/xml
ns html http://www.w3.org/TR/html4/
ns furniture https://www.w3schools.com/furniture
---
root: {
     a: payload.root.html#table,
     b: payload.root.furniture#table
 }
```

#### Output

The script outputs children of the `h:table` element under element `a` and the children of the
`f:table` under element `b`:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<root>
  <a>
    <h:tr xmlns:h="http://www.w3.org/TR/html4/">
      <h:td>Apples</h:td>
      <h:td>Bananas</h:td>
    </h:tr>
  </a>
  <b>
    <f:tr xmlns:f="https://www.w3schools.com/furniture">
      <f:name>African Coffee Table</f:name>
      <f:width>80</f:width>
      <f:length>120</f:length>
    </f:tr>
  </b>
</root>
```

### Example: Using a Local Name to Select XML Values

This example selects XML values using a local name `table` from the `h:table` element.

#### Input Payload

The input payload contains XML with a `table` element that contains the namespace
`"http://www.w3.org/TR/html4/"`:

```xml
<root>
  <h:table xmlns:h="http://www.w3.org/TR/html4/">
    <h:tr>
      <h:td>Apples</h:td>
      <h:td>Bananas</h:td>
    </h:tr>
  </h:table>
</root>
```

#### DataWeave Source

The DataWeave script selects values of children in the `table` element by using a local name of the
XML element `table` instead of its namespace:

```DataWeave
%dw 2.0
output application/xml
---
root: { a: payload.root.table }
```

#### Output

The script outputs XML that contains the values of children in the `table` element:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<root>
  <a>
    <h:tr xmlns:h="http://www.w3.org/TR/html4/">
      <h:td>Apples</h:td>
      <h:td>Bananas</h:td>
    </h:tr>
  </a>
</root>
```

## Attribute Selector

The attribute selector returns the first attribute value that matches the selected name expression.
If no key matches, the selection returns the value `null`.

The following example selects the value of an XML attribute.

### Input Payload

The input payload is an XML `user` element that contains the attribute `name="Weave"`:

```xml
<user name="Weave"/>
```

### DataWeave Source

The DataWeave script selects the value of the `name` attribute from the input payload
(`<user name="Weave"/>`). Notice that the `@` indicates an attribute selection.

```DataWeave
%dw 2.0
output application/json
---
payload.user.@name
```

### Output

The DataWeave script outputs the value of `name` attribute.

```json
"Weave"
```

## Multi-Value Selector

Instead of returning the value of the first matching key in an array of objects, the multi-value
selector (`*`) returns an array containing values to the matching key (for example, `*user` where
`user` is the key). The selector does not return the values of descendants, only those at the
specified level. If no key matches, the selection returns the value `null`.

### Input Payload

The input payload contains an XML array of `user` elements.

```xml
<users>
  <user>Weave</user>
  <user>BAT</user>
  <user>TF</user>
</users>
```

### DataWeave Source

The DataWeave script uses `*user` to select the values of all `user` elements from the input
payload.

```DataWeave
%dw 2.0
output application/json
---
payload.users.*user
```

### Output

The script outputs an array of `user` values.

```json
["Weave", "BAT", "TF"]
```

## Descendant Selector

The descendant selector returns a list of all children and their descendants. You can directly chain
this selector to any other selector without using a single `.`. For example, `payload..` recursively
returns an array of all the child values, the values of _their_ children, and so on. You can also
chain the selector to another element (for example, with `payload..user`) to select the values of
each `user` key and its descendants, or you can use `payload..*name` to select the values of all
`name` descendants.

### Example: Selecting Each Descendant

This example selects each descendant of the input payload.

#### Input Payload

The input payload contains a set of elements that are nested at different levels.

```xml
<users>
  <user>
    <name>Weave</name>
    <user>
      <name>BAT</name>
      <user>
        <name>BDD</name>
      </user>
    </user>
  </user>
</users>
```

#### DataWeave Source

The DataWeave script uses `..` to recursively select all elements in the input payload and return
them in a JSON array.

```DataWeave
%dw 2.0
output application/json
---
payload..
```

#### Output

```json
[
  {
    "user": {
      "name": "Weave",
      "user": {
        "name": "BAT",
        "user": {
          "name": "BDD"
        }
      }
    }
  },
  {
    "name": "Weave",
    "user": {
      "name": "BAT",
      "user": {
        "name": "BDD"
      }
    }
  },
  "Weave",
  {
    "name": "BAT",
    "user": {
      "name": "BDD"
    }
  },
  "BAT",
  {
    "name": "BDD"
  },
  "BDD"
]
```

### Example: Selecting Descending Values

This example selects the descending `name` values.

#### Input Payload

The input payload contains a set of `name` elements that are nested at different levels.

```xml
<users>
  <user>
    <name>Weave</name>
    <user>
      <name>BAT</name>
      <name>Munit</name>
      <user>
        <name>BDD</name>
      </user>
    </user>
  </user>
</users>
```

#### DataWeave Source

The DataWeave script uses `..` to select the values of all first `name` elements from the input
payload and output those values into a JSON array.

```DataWeave
%dw 2.0
output application/json
---
payload..name
```

#### Output

The script outputs a JSON array with all `name` values.

```json
["Weave", "BAT", "BDD"]
```

### Example

This example selects the descending `name` values.

#### Input Payload

The input payload contains a set of `name` elements that are nested at different levels.

```xml
<users>
  <user>
    <name>Weave</name>
    <user>
      <name>BAT</name>
      <name>Munit</name>
      <user>
        <name>BDD</name>
      </user>
    </user>
  </user>
</users>
```

#### DataWeave Source

The DataWeave script uses `..*` to select the values of all `name` elements from the input payload
and output those values into a JSON array, including the `BAT` and `Munit` values of the repeated
`name` keys that are at the same level in the XML hierarchy.

```DataWeave
%dw 2.0
output application/json
---
payload..*name
```

#### Output

The script outputs a JSON array with all `name` values.

```json
["Weave", "BAT", "Munit", "BDD"]
```

### Example: Selecting Descending Values

This example selects the descending `Name` values of the `Item` elements.

#### Input Payload

The input payload contains a set of `Name` elements that are nested at different levels.

```xml
<Example>
    <Brand>
        <Id>32345</Id>
        <logo>circle</logo>
        <Item>
            <Name>Perfume</Name>
            <Item>
                <Name>Bosque</Name>
            </Item>
        </Item>
        <Item>
            <Name>t-Shirt</Name>
        </Item>
    </Brand>
    <Brand>
        <Id>435678C</Id>
        <logo>circle</logo>
        <Item>
            <Name>t-Shirt2</Name>
            <Item>
                <Name>t-Shirt red</Name>
                <Item>
                    <Name>t-Shirt red with logo</Name>
                </Item>
            </Item>
        </Item>
    </Brand>
</Example>
```

#### DataWeave Source

The DataWeave script uses `..*` to select the values of all `Name` elements nested in the `Item`
elements from the input payload and output those values into a XML array.

```DataWeave
%dw 2.0
output application/xml
---
{
    Supermarket: {
        Item: {
            Value: payload..*Item.Name
        }
    }
}
```

#### Output

The script outputs a XML array with all `name` values.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<Supermarket>
  <Item>
    <Value>Perfume</Value>
    <Value>t-Shirt</Value>
    <Value>Bosque</Value>
    <Value>t-Shirt2</Value>
    <Value>t-Shirt red</Value>
    <Value>t-Shirt red with logo</Value>
  </Item>
</Supermarket>
```

## Dynamic Selector

The syntax for dynamic selection depends on what you are selecting:

- Single Value: `payload[(nameExpression)]`

- Multi Value: `payload[*(nameExpression)]`

- Attribute: `payload[@(nameExpression)]`

- Key Value: `payload[&(nameExpression)]`

- Single Value with a Namespace: `payload.ns0#"$(nameExpression)"`

### Example: Dynamically Selecting a Single Value

This example shows how to dynamically select a single value.

#### Input Payload

The input payload is an array of objects. The first object has the key `"ref"` and the value
`"name"`. The second has the key `"name"` and the value `"Data Weave"`:

```JSON
{ "ref": "name", "name": "Data Weave" }
```

#### DataWeave Source

The DataWeave script dynamically selects the value of the `"name"` key:

```DataWeave
%dw 2.0
output application/json
---
payload[(payload.ref)]
```

Notice that it passes `payload.ref` within the parentheses of dynamic selector `[()]`. The script
works because the value of `"ref"` is `"name"`, which matches the key `"name"`.

#### Output

The script outputs the value of the object that has the `"name"` key:

```JSON
"Data Weave"
```

### Example: Dynamically Selecting a Single Value with a Namespace

This example shows how to dynamically select a single value that contains a namespace.

#### Input Payload

The input payload contains a `<root/>` element with two child elements, one of which has the
namespace `http://www.w3.org/TR/html4/`. Both child elements (`<f:table/>` and `<h:table>`) have the
local name `table`:

```xml
<root ref="table">
    <f:table xmlns:f="https://www.w3schools.com/furniture">Manzana</f:table>
    <h:table xmlns:h="http://www.w3.org/TR/html4/">Banana</h:table>
</root>
```

#### DataWeave Source

The DataWeave script dynamically selects the value of the element that has the namespace
`http://www.w3.org/TR/html4/`:

```DataWeave
%dw 2.0
output application/json
ns h http://www.w3.org/TR/html4/
---
payload.root.h#"$(payload.root.@ref)"
```

Notice that the expression `payload.root.@ref` uses the attribute selector (`@`) on the `ref`
attribute of the `root` element to select the value `table`, which matches local name `table` in the
element `<h:table xmlns:h="http://www.w3.org/TR/html4/">Banana</h:table>`.

#### Output

The script outputs the value of the element that has the namespace `http://www.w3.org/TR/html4/`:

```JSON
"Banana"
```

## Use of Selectors on Content Stored in Variables

All selectors work with the [predefined Mule Runtime variables](https://docs.mulesoft.com/dataweave/2.3/dataweave-variables-context), such
as `payload` and `attributes`, and with [DataWeave variables](https://docs.mulesoft.com/dataweave/2.3/dataweave-variables). For example,
assuming a DataWeave variable defined as `var myVar = { "id" : "1234", "name" : "somebody" }`, the
DataWeave expression `myVar.name` returns the value of `"name"`, which is `"somebody"`.

You can select [Mule event](https://docs.mulesoft.com/mule-runtime/4.3/about-mule-event) data by using Mule Runtime
variables.

Extracted values are handled as a literal values (as opposed to variables, for example) of one of
the supported DataWeave value types.

<table><colgroup><col> <col></colgroup><thead><tr><th>Data to extract</th><th>Syntax</th></tr></thead><tbody><tr><td><p><strong>Payload</strong></p></td><td><div><div><p><code>payload</code>, for example: <code>payload.name</code></p></div><div><p>If the <code>payload</code> is <code>{"name" : "somebody"}</code>, <code>payload.name</code> returns <code>"somebody"</code>.</p></div><div><p>For more on the Mule payload, see <a href="https://docs.mulesoft.com/mule-runtime/4.3/about-mule-message#_message_payload">Message Payload</a>.</p></div></div></td></tr><tr><td><p><strong>Attribute</strong></p></td><td><div><div><p><code>attributes.&lt;myAttributeName&gt;</code></p></div><div><p>For examples, see <a href="https://docs.mulesoft.com/mule-runtime/4.3/about-mule-message#_attributes">Attributes</a>.</p></div></div></td></tr><tr><td><p><strong>Variable</strong></p></td><td><div><div><p><code>&lt;myVariableName&gt;</code></p></div><div><p>To avoid name collisions, you can prepend <code>variables</code>:</p></div><div><p><code>variables.&lt;myVariableName&gt;</code></p></div><div><p>For more on Mule variables, see <a href="https://docs.mulesoft.com/mule-runtime/4.3/about-mule-variables">Variables in Mule Apps</a>.</p></div></div></td></tr><tr><td><p><strong>Error object</strong></p></td><td><div><div><p><code>error</code></p></div><div><p>For information on errors in the flow, you can use <code>#[error.cause]</code>.</p></div></div></td></tr><tr><td><p><strong>Flow</strong></p></td><td><div><div><p><code>flow</code></p></div><div><p>For the flow name in the Logger: <code>#[flow.name]</code></p></div><div><p>Note that <code>flow.name</code> does not work in some Core components, such as Set Payload and Transform Message.</p></div><div><p>For more on flows, see <a href="https://docs.mulesoft.com/mule-runtime/4.3/about-flows">Flows and Subflows</a>.</p></div></div></td></tr></tbody></table>

<!-- document id=3cb7f03919efd7b3140b6c59f77ec48e8ac50ad409d49e2567fdaefde2488267 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-selectors.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# DataWeave Selectors

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave selectors traverse the structures of objects and arrays and return matching values.

A selector always operates within a context, which can be a reference to a variable, an object
literal, an array literal, or the invocation of a DataWeave function.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Selector Type</th><th>Syntax</th><th>Return Type</th></tr></thead><tbody><tr><td><p>Single-value</p></td><td><p><code>.keyName</code></p></td><td><p>Any type of value that belongs to a matching key</p></td></tr><tr><td><p>Multi-value</p></td><td><p><code>.*keyName</code></p></td><td><p>Array of values of any matching keys</p></td></tr><tr><td><p>Descendants</p></td><td><p><code>..keyName</code></p></td><td><p>Array of values of any matching descendant keys</p></td></tr><tr><td><p>Dynamic</p></td><td><p>See <a href="#dynamic_selector">Dynamic Selector</a>.</p></td><td><p>&nbsp;</p></td></tr><tr><td><p>Key-value pair</p></td><td><p><code>.&amp;keyName</code></p></td><td><p>Object with the matching key</p></td></tr><tr><td><p>Index</p></td><td><p><code>[&lt;index&gt;]</code></p></td><td><p>Value of any type at selected array index. Use negative numbers to index from the end of an array, for example, <code>-1</code> for the last element in the array. Use of numbers beyond the array size returns <code>null</code>.</p></td></tr><tr><td><p>Range</p></td><td><p><code>[&lt;index&gt; to &lt;index&gt;]</code></p></td><td><p>Array with values from selected indexes</p></td></tr><tr><td><p>XML attribute</p></td><td><p><code>@</code>, <code>.@keyName</code></p></td><td><p>String value of the selected attribute</p></td></tr><tr><td><p>Namespace</p></td><td><p><code>keyName.#</code></p></td><td><p>String value of the namespace for the selected key</p></td></tr><tr><td><p>Key present</p></td><td><p><code>keyName?</code>, <code>keyName.@type?</code></p></td><td><p>Boolean (<code>true</code> if the selected key of an object or XML attribute is present, <code>false</code> if not)</p></td></tr><tr><td><p>Assert present</p></td><td><p><code>keyName!</code></p></td><td><p>String: Exception message if the key is not present</p></td></tr><tr><td><p>Filter</p></td><td><p><code>[?(boolean_expression)]</code></p></td><td><p>Array or object containing key-value pairs <em>if</em> the DataWeave expression returns <code>true</code>. Otherwise, returns the value <code>null</code>.</p></td></tr><tr><td><p>Metadata</p></td><td><p><code>.^someMetadata</code></p></td><td><div><div><p>Returns the value of specified metadata for a Mule payload, variable, or attribute. The selector can return the value of class (<code>.^class</code>), content length (<code>.^contentLength</code>), encoding (<code>.^encoding</code>), mime type (<code>.^mimeType</code>), media type (<code>.^mediaType</code>), raw (<code>.^raw</code>), and custom (<code>.^myCustomMetadata</code>) metadata. For details, see <a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-extract-data#selector_metadata">Extract Data</a>.</p></div></div></td></tr></tbody></table>

> [!NOTE] The following examples use these selectors. For additional examples of selectors, see
> [Extract Data](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-extract-data).

## Rules for Matching

In DataWeave, a name that matches the key of an object (such as the key `"someName"` in the JSON
object `{ "someName" : "Data Weave" }`) can select data from that object. For a simple example, see
[Single-Value Selector](#single_value_selector).

## Single-Value Selector

This selector matches the value of the first key-value pair in which the key matches the given
selector name. The selector can be applied to an Object or to an array. On an array, the selector
applies to all Object values inside the array and ignores all values that are not Object values. If
no key matches, the value `null` is returned.

### Example: Using a Single-Value Selector on an Object

This example shows how the selector works on a simple JSON object.

#### Input Payload

The input payload is an object with the key `"name"` and the value `"DataWeave"`:

```JSON
{ "name": "Data Weave" }
```

#### DataWeave Source

The DataWeave script uses `payload.name` to select the value of the object that has the key
`"name"`. Note that `payload.name` and `payload."name"` are both valid ways to perform the
selection.

```DataWeave
%dw 2.0
output application/json
---
payload.name
```

#### Output

The script outputs the String value of the input object, "Data Weave":

```JSON
"Data Weave"
```

### Example: Using a Single-Value Selector on an Array

On an array, the selector applies to every element.

#### Input Payload

The input payload is an array that contains two objects with the same key, "name":

```JSON
[
  {
    "name": "Arg"
  },
  {
    "name": "Japan"
  }
]
```

#### DataWeave Source

The DataWeave script uses `payload.name` to select the value of any objects in input payload that
have the key "name":

```DataWeave
%dw 2.0
output application/json
---
payload.name
```

#### Output

The script outputs an array that contains the values of the input objects with the key `"name"`:
`"Arg"` and `"Japan"`:

```json
["Arg", "Japan"]
```

## Namespace Selector

The DataWeave namespace selector supports the use of a name that matches a namespace or a local
part. To match a namespace, the name must match the namespace and the local part. If the name only
matches the local part, the selector matches all namespaces with that local part, regardless of the
namespace.

Note that XML namespaces and their prefixes are defined in the `xmlns` attribute of an XML element.
For example, the element `<h:table xmlns:h="http://www.w3.org/TR/html4/"/>` defines a namespace that
assigns the prefix `h` to the namespace
`[http://www.w3.org/TR/html4/](http://www.w3.org/TR/html4/)`. All elements in that namespace contain
the `h` prefix. For example, in the element `<h:table/>`, `h` is the prefix for the namespace, and
`table` is the local part.

### Example: Using a Namespace Selector

This example selects values from XML elements using the namespace and local part.

#### Input Payload

The input payload contains XML elements, `h:table` and `f:table`, that have different namespaces but
the same local names (`table`):

```xml
<root>

  <h:table xmlns:h="http://www.w3.org/TR/html4/">
    <h:tr>
      <h:td>Apples</h:td>
      <h:td>Bananas</h:td>
    </h:tr>
  </h:table>

  <f:table xmlns:f="https://www.w3schools.com/furniture">
    <f:tr>
      <f:name>African Coffee Table</f:name>
      <f:width>80</f:width>
      <f:length>120</f:length>
    </f:tr>
  </f:table>

</root>
```

#### DataWeave Source

The DataWeave script selects XML content from specified namespaces. The script’s header creates
namespace (`ns`) variables `html` and `furniture` to store namespaces from the input payload. To
select the children of `h:table` into element `a` and the children of `f:table` elements into
element `b`, the script uses the `html` and `furniture` namespace variables with a namespace
selector (`#`) and local part (`table`):

```DataWeave
%dw 2.0
output application/xml
ns html http://www.w3.org/TR/html4/
ns furniture https://www.w3schools.com/furniture
---
root: {
     a: payload.root.html#table,
     b: payload.root.furniture#table
 }
```

#### Output

The script outputs children of the `h:table` element under element `a` and the children of the
`f:table` under element `b`:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<root>
  <a>
    <h:tr xmlns:h="http://www.w3.org/TR/html4/">
      <h:td>Apples</h:td>
      <h:td>Bananas</h:td>
    </h:tr>
  </a>
  <b>
    <f:tr xmlns:f="https://www.w3schools.com/furniture">
      <f:name>African Coffee Table</f:name>
      <f:width>80</f:width>
      <f:length>120</f:length>
    </f:tr>
  </b>
</root>
```

### Example: Using a Local Name to Select XML Values

This example selects XML values using a local name `table` from the `h:table` element.

#### Input Payload

The input payload contains XML with a `table` element that contains the namespace
`"http://www.w3.org/TR/html4/"`:

```xml
<root>
  <h:table xmlns:h="http://www.w3.org/TR/html4/">
    <h:tr>
      <h:td>Apples</h:td>
      <h:td>Bananas</h:td>
    </h:tr>
  </h:table>
</root>
```

#### DataWeave Source

The DataWeave script selects values of children in the `table` element by using a local name of the
XML element `table` instead of its namespace:

```DataWeave
%dw 2.0
output application/xml
---
root: { a: payload.root.table }
```

#### Output

The script outputs XML that contains the values of children in the `table` element:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<root>
  <a>
    <h:tr xmlns:h="http://www.w3.org/TR/html4/">
      <h:td>Apples</h:td>
      <h:td>Bananas</h:td>
    </h:tr>
  </a>
</root>
```

## Attribute Selector

The attribute selector returns the first attribute value that matches the selected name expression.
If no key matches, the selection returns the value `null`.

The following example selects the value of an XML attribute.

### Input Payload

The input payload is an XML `user` element that contains the attribute `name="Weave"`:

```xml
<user name="Weave"/>
```

### DataWeave Source

The DataWeave script selects the value of the `name` attribute from the input payload
(`<user name="Weave"/>`). Notice that the `@` indicates an attribute selection.

```DataWeave
%dw 2.0
output application/json
---
payload.user.@name
```

### Output

The DataWeave script outputs the value of `name` attribute.

```json
"Weave"
```

## Multi-Value Selector

Instead of returning the value of the first matching key in an array of objects, the multi-value
selector (`*`) returns an array containing values to the matching key (for example, `*user` where
`user` is the key). The selector does not return the values of descendants, only those at the
specified level. If no key matches, the selection returns the value `null`.

### Input Payload

The input payload contains an XML array of `user` elements.

```xml
<users>
  <user>Weave</user>
  <user>BAT</user>
  <user>TF</user>
</users>
```

### DataWeave Source

The DataWeave script uses `*user` to select the values of all `user` elements from the input
payload.

```DataWeave
%dw 2.0
output application/json
---
payload.users.*user
```

### Output

The script outputs an array of `user` values.

```json
["Weave", "BAT", "TF"]
```

## Descendant Selector

The descendant selector returns a list of all children and their descendants. You can directly chain
this selector to any other selector without using a single `.`. For example, `payload..` recursively
returns an array of all the child values, the values of _their_ children, and so on. You can also
chain the selector to another element (for example, with `payload..user`) to select the values of
each `user` key and its descendants, or you can use `payload..*name` to select the values of all
`name` descendants.

### Example: Selecting Each Descendant

This example selects each descendant of the input payload.

#### Input Payload

The input payload contains a set of elements that are nested at different levels.

```xml
<users>
  <user>
    <name>Weave</name>
    <user>
      <name>BAT</name>
      <user>
        <name>BDD</name>
      </user>
    </user>
  </user>
</users>
```

#### DataWeave Source

The DataWeave script uses `..` to recursively select all elements in the input payload and return
them in a JSON array.

```DataWeave
%dw 2.0
output application/json
---
payload..
```

#### Output

```json
[
  {
    "user": {
      "name": "Weave",
      "user": {
        "name": "BAT",
        "user": {
          "name": "BDD"
        }
      }
    }
  },
  {
    "name": "Weave",
    "user": {
      "name": "BAT",
      "user": {
        "name": "BDD"
      }
    }
  },
  "Weave",
  {
    "name": "BAT",
    "user": {
      "name": "BDD"
    }
  },
  "BAT",
  {
    "name": "BDD"
  },
  "BDD"
]
```

### Example: Selecting Descending Values

This example selects the descending `name` values.

#### Input Payload

The input payload contains a set of `name` elements that are nested at different levels.

```xml
<users>
  <user>
    <name>Weave</name>
    <user>
      <name>BAT</name>
      <name>Munit</name>
      <user>
        <name>BDD</name>
      </user>
    </user>
  </user>
</users>
```

#### DataWeave Source

The DataWeave script uses `..` to select the values of all first `name` elements from the input
payload and output those values into a JSON array.

```DataWeave
%dw 2.0
output application/json
---
payload..name
```

#### Output

The script outputs a JSON array with all `name` values.

```json
["Weave", "BAT", "BDD"]
```

### Example

This example selects the descending `name` values.

#### Input Payload

The input payload contains a set of `name` elements that are nested at different levels.

```xml
<users>
  <user>
    <name>Weave</name>
    <user>
      <name>BAT</name>
      <name>Munit</name>
      <user>
        <name>BDD</name>
      </user>
    </user>
  </user>
</users>
```

#### DataWeave Source

The DataWeave script uses `..*` to select the values of all `name` elements from the input payload
and output those values into a JSON array, including the `BAT` and `Munit` values of the repeated
`name` keys that are at the same level in the XML hierarchy.

```DataWeave
%dw 2.0
output application/json
---
payload..*name
```

#### Output

The script outputs a JSON array with all `name` values.

```json
["Weave", "BAT", "Munit", "BDD"]
```

### Example: Selecting Descending Values

This example selects the descending `Name` values of the `Item` elements.

#### Input Payload

The input payload contains a set of `Name` elements that are nested at different levels.

```xml
<Example>
    <Brand>
        <Id>32345</Id>
        <logo>circle</logo>
        <Item>
            <Name>Perfume</Name>
            <Item>
                <Name>Bosque</Name>
            </Item>
        </Item>
        <Item>
            <Name>t-Shirt</Name>
        </Item>
    </Brand>
    <Brand>
        <Id>435678C</Id>
        <logo>circle</logo>
        <Item>
            <Name>t-Shirt2</Name>
            <Item>
                <Name>t-Shirt red</Name>
                <Item>
                    <Name>t-Shirt red with logo</Name>
                </Item>
            </Item>
        </Item>
    </Brand>
</Example>
```

#### DataWeave Source

The DataWeave script uses `..*` to select the values of all `Name` elements nested in the `Item`
elements from the input payload and output those values into a XML array.

```DataWeave
%dw 2.0
output application/xml
---
{
    Supermarket: {
        Item: {
            Value: payload..*Item.Name
        }
    }
}
```

#### Output

The script outputs a XML array with all `name` values.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<Supermarket>
  <Item>
    <Value>Perfume</Value>
    <Value>t-Shirt</Value>
    <Value>Bosque</Value>
    <Value>t-Shirt2</Value>
    <Value>t-Shirt red</Value>
    <Value>t-Shirt red with logo</Value>
  </Item>
</Supermarket>
```

## Dynamic Selector

The syntax for dynamic selection depends on what you are selecting:

- Single Value: `payload[(nameExpression)]`

- Multi Value: `payload[*(nameExpression)]`

- Attribute: `payload[@(nameExpression)]`

- Key Value: `payload[&(nameExpression)]`

- Single Value with a Namespace: `payload.ns0#"$(nameExpression)"`

### Example: Dynamically Selecting a Single Value

This example shows how to dynamically select a single value.

#### Input Payload

The input payload is an array of objects. The first object has the key `"ref"` and the value
`"name"`. The second has the key `"name"` and the value `"Data Weave"`:

```JSON
{ "ref": "name", "name": "Data Weave" }
```

#### DataWeave Source

The DataWeave script dynamically selects the value of the `"name"` key:

```DataWeave
%dw 2.0
output application/json
---
payload[(payload.ref)]
```

Notice that it passes `payload.ref` within the parentheses of dynamic selector `[()]`. The script
works because the value of `"ref"` is `"name"`, which matches the key `"name"`.

#### Output

The script outputs the value of the object that has the `"name"` key:

```JSON
"Data Weave"
```

### Example: Dynamically Selecting a Single Value with a Namespace

This example shows how to dynamically select a single value that contains a namespace.

#### Input Payload

The input payload contains a `<root/>` element with two child elements, one of which has the
namespace `http://www.w3.org/TR/html4/`. Both child elements (`<f:table/>` and `<h:table>`) have the
local name `table`:

```xml
<root ref="table">
    <f:table xmlns:f="https://www.w3schools.com/furniture">Manzana</f:table>
    <h:table xmlns:h="http://www.w3.org/TR/html4/">Banana</h:table>
</root>
```

#### DataWeave Source

The DataWeave script dynamically selects the value of the element that has the namespace
`http://www.w3.org/TR/html4/`:

```DataWeave
%dw 2.0
output application/json
ns h http://www.w3.org/TR/html4/
---
payload.root.h#"$(payload.root.@ref)"
```

Notice that the expression `payload.root.@ref` uses the attribute selector (`@`) on the `ref`
attribute of the `root` element to select the value `table`, which matches local name `table` in the
element `<h:table xmlns:h="http://www.w3.org/TR/html4/">Banana</h:table>`.

#### Output

The script outputs the value of the element that has the namespace `http://www.w3.org/TR/html4/`:

```JSON
"Banana"
```

## Use of Selectors on Content Stored in Variables

All selectors work with the [predefined Mule Runtime variables](https://docs.mulesoft.com/dataweave/2.4/dataweave-variables-context) and
with [DataWeave variables](https://docs.mulesoft.com/dataweave/2.4/dataweave-variables).

To select [Mule event](https://docs.mulesoft.com/mule-runtime/latest/about-mule-event) data, such as the payload, an
attribute, or variable data within the Mule event, use predefined Mule Runtime variables, such as
`payload`, `attributes`, and `vars`.

Extracted values are handled as literal values of one of the supported DataWeave value types.

<table><colgroup><col> <col></colgroup><thead><tr><th>Data to extract</th><th>Syntax</th></tr></thead><tbody><tr><td><p><strong>Payload</strong></p></td><td><div><div><p><code>payload</code>, for example: <code>payload.name</code></p></div><div><p>If the <code>payload</code> is <code>{"name" : "somebody"}</code>, <code>payload.name</code> returns <code>"somebody"</code>.</p></div><div><p>For more on the Mule payload, see <a href="https://docs.mulesoft.com/mule-runtime/latest/about-mule-message#_message_payload">Message Payload</a>.</p></div></div></td></tr><tr><td><p><strong>Attribute</strong></p></td><td><div><div><p><code>attributes.&lt;myAttributeName&gt;</code></p></div><div><p>For examples, see <a href="https://docs.mulesoft.com/mule-runtime/latest/about-mule-message#_attributes">Attributes</a>.</p></div></div></td></tr><tr><td><p><strong>Variable</strong></p></td><td><div><div><p><code>&lt;myVariableName&gt;</code></p></div><div><p>To avoid name collisions, you must prepend <code>vars</code> to the variable name:</p></div><div><p><code>vars.&lt;myVariableName&gt;</code></p></div><div><p>For more on Mule variables, see <a href="https://docs.mulesoft.com/mule-runtime/latest/about-mule-variables">Variables in Mule Apps</a>.</p></div></div></td></tr><tr><td><p><strong>Error object</strong></p></td><td><div><div><p><code>error</code></p></div><div><p>For information on errors in the flow, you can use <code>#[error.cause]</code>.</p></div></div></td></tr><tr><td><p><strong>Flow</strong></p></td><td><div><div><p><code>flow</code></p></div><div><p>For the flow name in the Logger: <code>#[flow.name]</code></p></div><div><p>Note that <code>flow.name</code> does not work in some Core components, such as Set Payload and Transform Message.</p></div><div><p>For more on flows, see <a href="https://docs.mulesoft.com/mule-runtime/latest/about-flows">Flows and Subflows</a>.</p></div></div></td></tr></tbody></table>

<!-- document id=d9256cafd82d092c2340776abdc068c1f854abf8379ad3edc973d936fd229cb6 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-selectors.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# DataWeave Selectors

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave selectors traverse the structures of objects and arrays and return matching values.

A selector always operates within a context, which can be a reference to a variable, an object
literal, an array literal, or the invocation of a DataWeave function.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Selector Type</th><th>Syntax</th><th>Return Type</th></tr></thead><tbody><tr><td><p>Single-value</p></td><td><p><code>.keyName</code></p></td><td><p>Any type of value that belongs to a matching key</p></td></tr><tr><td><p>Multi-value</p></td><td><p><code>.*keyName</code></p></td><td><p>Array of values of any matching keys</p></td></tr><tr><td><p>Descendants</p></td><td><p><code>..keyName</code></p></td><td><p>Array of values of any matching descendant keys</p></td></tr><tr><td><p>Dynamic</p></td><td><p>See <a href="#dynamic_selector">Dynamic Selector</a>.</p></td><td><p>&nbsp;</p></td></tr><tr><td><p>Key-value pair</p></td><td><p><code>.&amp;keyName</code></p></td><td><p>Object with the matching key</p></td></tr><tr><td><p>Index</p></td><td><p><code>[&lt;index&gt;]</code></p></td><td><p>Value of any type at selected array index. Use negative numbers to index from the end of an array, for example, <code>-1</code> for the last element in the array. Use of numbers beyond the array size returns <code>null</code>.</p></td></tr><tr><td><p>Range</p></td><td><p><code>[&lt;index&gt; to &lt;index&gt;]</code></p></td><td><p>Array with values from selected indexes</p></td></tr><tr><td><p>XML attribute</p></td><td><p><code>@</code>, <code>.@keyName</code></p></td><td><p>String value of the selected attribute</p></td></tr><tr><td><p>Namespace</p></td><td><p><code>keyName.#</code></p></td><td><p>String value of the namespace for the selected key</p></td></tr><tr><td><p>Key present</p></td><td><p><code>keyName?</code>, <code>keyName.@type?</code></p></td><td><p>Boolean (<code>true</code> if the selected key of an object or XML attribute is present, <code>false</code> if not)</p></td></tr><tr><td><p>Assert present</p></td><td><p><code>keyName!</code></p></td><td><p>String: Exception message if the key is not present</p></td></tr><tr><td><p>Filter</p></td><td><p><code>[?(boolean_expression)]</code></p></td><td><p>Array or object containing key-value pairs <em>if</em> the DataWeave expression returns <code>true</code>. Otherwise, returns the value <code>null</code>.</p></td></tr><tr><td><p>Metadata</p></td><td><p><code>.^someMetadata</code></p></td><td><div><div><p>Returns the value of specified metadata for a Mule payload, variable, or attribute. The selector can return the value of class (<code>.^class</code>), content length (<code>.^contentLength</code>), encoding (<code>.^encoding</code>), mime type (<code>.^mimeType</code>), media type (<code>.^mediaType</code>), raw (<code>.^raw</code>), and custom (<code>.^myCustomMetadata</code>) metadata. For details, see <a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-extract-data#selector_metadata">Extract Data</a>.</p></div></div></td></tr></tbody></table>

> [!NOTE] The following examples use these selectors. For additional examples of selectors, see
> [Extract Data](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-extract-data).

## Rules for Matching

In DataWeave, a name that matches the key of an object (such as the key `"someName"` in the JSON
object `{ "someName" : "Data Weave" }`) can select data from that object. For a simple example, see
[Single-Value Selector](#single_value_selector).

## Single-Value Selector

This selector matches the value of the first key-value pair in which the key matches the given
selector name. The selector can be applied to an Object or to an array. On an array, the selector
applies to all Object values inside the array and ignores all values that are not Object values. If
no key matches, the value `null` is returned.

> [!NOTE] For information about the dot selector (`.`) and how to use it on DataWeave types, refer
> to [Selecting Types](https://docs.mulesoft.com/dataweave/2.6/dataweave-selecting-types).

### Example: Using a Single-Value Selector on an Object

This example shows how the selector works on a simple JSON object.

#### Input Payload

The input payload is an object with the key `"name"` and the value `"DataWeave"`:

```JSON
{ "name": "Data Weave" }
```

#### DataWeave Source

The DataWeave script uses `payload.name` to select the value of the object that has the key
`"name"`. Note that `payload.name` and `payload."name"` are both valid ways to perform the
selection.

```DataWeave
%dw 2.0
output application/json
---
payload.name
```

#### Output

The script outputs the String value of the input object, "Data Weave":

```JSON
"Data Weave"
```

### Example: Using a Single-Value Selector on an Array

On an array, the selector applies to every element.

#### Input Payload

The input payload is an array that contains two objects with the same key, "name":

```JSON
[
  {
    "name": "Arg"
  },
  {
    "name": "Japan"
  }
]
```

#### DataWeave Source

The DataWeave script uses `payload.name` to select the value of any objects in input payload that
have the key "name":

```DataWeave
%dw 2.0
output application/json
---
payload.name
```

#### Output

The script outputs an array that contains the values of the input objects with the key `"name"`:
`"Arg"` and `"Japan"`:

```json
["Arg", "Japan"]
```

## Namespace Selector

The DataWeave namespace selector supports the use of a name that matches a namespace or a local
part. To match a namespace, the name must match the namespace and the local part. If the name only
matches the local part, the selector matches all namespaces with that local part, regardless of the
namespace.

Note that XML namespaces and their prefixes are defined in the `xmlns` attribute of an XML element.
For example, the element `<h:table xmlns:h="http://www.w3.org/TR/html4/"/>` defines a namespace that
assigns the prefix `h` to the namespace
`[http://www.w3.org/TR/html4/](http://www.w3.org/TR/html4/)`. All elements in that namespace contain
the `h` prefix. For example, in the element `<h:table/>`, `h` is the prefix for the namespace, and
`table` is the local part.

### Example: Using a Namespace Selector

This example selects values from XML elements using the namespace and local part.

#### Input Payload

The input payload contains XML elements, `h:table` and `f:table`, that have different namespaces but
the same local names (`table`):

```xml
<root>

  <h:table xmlns:h="http://www.w3.org/TR/html4/">
    <h:tr>
      <h:td>Apples</h:td>
      <h:td>Bananas</h:td>
    </h:tr>
  </h:table>

  <f:table xmlns:f="https://www.w3schools.com/furniture">
    <f:tr>
      <f:name>African Coffee Table</f:name>
      <f:width>80</f:width>
      <f:length>120</f:length>
    </f:tr>
  </f:table>

</root>
```

#### DataWeave Source

The DataWeave script selects XML content from specified namespaces. The script’s header creates
namespace (`ns`) variables `html` and `furniture` to store namespaces from the input payload. To
select the children of `h:table` into element `a` and the children of `f:table` elements into
element `b`, the script uses the `html` and `furniture` namespace variables with a namespace
selector (`#`) and local part (`table`):

```DataWeave
%dw 2.0
output application/xml
ns html http://www.w3.org/TR/html4/
ns furniture https://www.w3schools.com/furniture
---
root: {
     a: payload.root.html#table,
     b: payload.root.furniture#table
 }
```

#### Output

The script outputs children of the `h:table` element under element `a` and the children of the
`f:table` under element `b`:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<root>
  <a>
    <h:tr xmlns:h="http://www.w3.org/TR/html4/">
      <h:td>Apples</h:td>
      <h:td>Bananas</h:td>
    </h:tr>
  </a>
  <b>
    <f:tr xmlns:f="https://www.w3schools.com/furniture">
      <f:name>African Coffee Table</f:name>
      <f:width>80</f:width>
      <f:length>120</f:length>
    </f:tr>
  </b>
</root>
```

### Example: Using a Local Name to Select XML Values

This example selects XML values using a local name `table` from the `h:table` element.

#### Input Payload

The input payload contains XML with a `table` element that contains the namespace
`"http://www.w3.org/TR/html4/"`:

```xml
<root>
  <h:table xmlns:h="http://www.w3.org/TR/html4/">
    <h:tr>
      <h:td>Apples</h:td>
      <h:td>Bananas</h:td>
    </h:tr>
  </h:table>
</root>
```

#### DataWeave Source

The DataWeave script selects values of children in the `table` element by using a local name of the
XML element `table` instead of its namespace:

```DataWeave
%dw 2.0
output application/xml
---
root: { a: payload.root.table }
```

#### Output

The script outputs XML that contains the values of children in the `table` element:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<root>
  <a>
    <h:tr xmlns:h="http://www.w3.org/TR/html4/">
      <h:td>Apples</h:td>
      <h:td>Bananas</h:td>
    </h:tr>
  </a>
</root>
```

## Attribute Selector

The attribute selector returns the first attribute value that matches the selected name expression.
If no key matches, the selection returns the value `null`.

The following example selects the value of an XML attribute.

### Input Payload

The input payload is an XML `user` element that contains the attribute `name="Weave"`:

```xml
<user name="Weave"/>
```

### DataWeave Source

The DataWeave script selects the value of the `name` attribute from the input payload
(`<user name="Weave"/>`). Notice that the `@` indicates an attribute selection.

```DataWeave
%dw 2.0
output application/json
---
payload.user.@name
```

### Output

The DataWeave script outputs the value of `name` attribute.

```json
"Weave"
```

## Multi-Value Selector

Instead of returning the value of the first matching key in an array of objects, the multi-value
selector (`*`) returns an array containing values to the matching key (for example, `*user` where
`user` is the key). The selector does not return the values of descendants, only those at the
specified level. If no key matches, the selection returns the value `null`.

### Input Payload

The input payload contains an XML array of `user` elements.

```xml
<users>
  <user>Weave</user>
  <user>BAT</user>
  <user>TF</user>
</users>
```

### DataWeave Source

The DataWeave script uses `*user` to select the values of all `user` elements from the input
payload.

```DataWeave
%dw 2.0
output application/json
---
payload.users.*user
```

### Output

The script outputs an array of `user` values.

```json
["Weave", "BAT", "TF"]
```

## Descendant Selector

The descendant selector returns a list of all children and their descendants. You can directly chain
this selector to any other selector without using a single `.`. For example, `payload..` recursively
returns an array of all the child values, the values of _their_ children, and so on. You can also
chain the selector to another element (for example, with `payload..user`) to select the values of
each `user` key and its descendants, or you can use `payload..*name` to select the values of all
`name` descendants.

### Example: Selecting Each Descendant

This example selects each descendant of the input payload.

#### Input Payload

The input payload contains a set of elements that are nested at different levels.

```xml
<users>
  <user>
    <name>Weave</name>
    <user>
      <name>BAT</name>
      <user>
        <name>BDD</name>
      </user>
    </user>
  </user>
</users>
```

#### DataWeave Source

The DataWeave script uses `..` to recursively select all elements in the input payload and return
them in a JSON array.

```DataWeave
%dw 2.0
output application/json
---
payload..
```

#### Output

```json
[
  {
    "user": {
      "name": "Weave",
      "user": {
        "name": "BAT",
        "user": {
          "name": "BDD"
        }
      }
    }
  },
  {
    "name": "Weave",
    "user": {
      "name": "BAT",
      "user": {
        "name": "BDD"
      }
    }
  },
  "Weave",
  {
    "name": "BAT",
    "user": {
      "name": "BDD"
    }
  },
  "BAT",
  {
    "name": "BDD"
  },
  "BDD"
]
```

### Example: Selecting Descending Values

This example selects the descending `name` values.

#### Input Payload

The input payload contains a set of `name` elements that are nested at different levels.

```xml
<users>
  <user>
    <name>Weave</name>
    <user>
      <name>BAT</name>
      <name>Munit</name>
      <user>
        <name>BDD</name>
      </user>
    </user>
  </user>
</users>
```

#### DataWeave Source

The DataWeave script uses `..` to select the values of all first `name` elements from the input
payload and output those values into a JSON array.

```DataWeave
%dw 2.0
output application/json
---
payload..name
```

#### Output

The script outputs a JSON array with all `name` values.

```json
["Weave", "BAT", "BDD"]
```

### Example

This example selects the descending `name` values.

#### Input Payload

The input payload contains a set of `name` elements that are nested at different levels.

```xml
<users>
  <user>
    <name>Weave</name>
    <user>
      <name>BAT</name>
      <name>Munit</name>
      <user>
        <name>BDD</name>
      </user>
    </user>
  </user>
</users>
```

#### DataWeave Source

The DataWeave script uses `..*` to select the values of all `name` elements from the input payload
and output those values into a JSON array, including the `BAT` and `Munit` values of the repeated
`name` keys that are at the same level in the XML hierarchy.

```DataWeave
%dw 2.0
output application/json
---
payload..*name
```

#### Output

The script outputs a JSON array with all `name` values.

```json
["Weave", "BAT", "Munit", "BDD"]
```

### Example: Selecting Descending Values

This example selects the descending `Name` values of the `Item` elements.

#### Input Payload

The input payload contains a set of `Name` elements that are nested at different levels.

```xml
<Example>
    <Brand>
        <Id>32345</Id>
        <logo>circle</logo>
        <Item>
            <Name>Perfume</Name>
            <Item>
                <Name>Bosque</Name>
            </Item>
        </Item>
        <Item>
            <Name>t-Shirt</Name>
        </Item>
    </Brand>
    <Brand>
        <Id>435678C</Id>
        <logo>circle</logo>
        <Item>
            <Name>t-Shirt2</Name>
            <Item>
                <Name>t-Shirt red</Name>
                <Item>
                    <Name>t-Shirt red with logo</Name>
                </Item>
            </Item>
        </Item>
    </Brand>
</Example>
```

#### DataWeave Source

The DataWeave script uses `..*` to select the values of all `Name` elements nested in the `Item`
elements from the input payload and output those values into a XML array.

```DataWeave
%dw 2.0
output application/xml
---
{
    Supermarket: {
        Item: {
            Value: payload..*Item.Name
        }
    }
}
```

#### Output

The script outputs a XML array with all `name` values.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<Supermarket>
  <Item>
    <Value>Perfume</Value>
    <Value>t-Shirt</Value>
    <Value>Bosque</Value>
    <Value>t-Shirt2</Value>
    <Value>t-Shirt red</Value>
    <Value>t-Shirt red with logo</Value>
  </Item>
</Supermarket>
```

## Dynamic Selector

The syntax for dynamic selection depends on what you are selecting:

- Single Value: `payload[(nameExpression)]`

- Multi Value: `payload[*(nameExpression)]`

- Attribute: `payload[@(nameExpression)]`

- Key Value: `payload[&(nameExpression)]`

- Single Value with a Namespace: `payload.ns0#"$(nameExpression)"`

### Example: Dynamically Selecting a Single Value

This example shows how to dynamically select a single value.

#### Input Payload

The input payload is an array of objects. The first object has the key `"ref"` and the value
`"name"`. The second has the key `"name"` and the value `"Data Weave"`:

```JSON
{ "ref": "name", "name": "Data Weave" }
```

#### DataWeave Source

The DataWeave script dynamically selects the value of the `"name"` key:

```DataWeave
%dw 2.0
output application/json
---
payload[(payload.ref)]
```

Notice that it passes `payload.ref` within the parentheses of dynamic selector `[()]`. The script
works because the value of `"ref"` is `"name"`, which matches the key `"name"`.

#### Output

The script outputs the value of the object that has the `"name"` key:

```JSON
"Data Weave"
```

### Example: Dynamically Selecting a Single Value with a Namespace

This example shows how to dynamically select a single value that contains a namespace.

#### Input Payload

The input payload contains a `<root/>` element with two child elements, one of which has the
namespace `http://www.w3.org/TR/html4/`. Both child elements (`<f:table/>` and `<h:table>`) have the
local name `table`:

```xml
<root ref="table">
    <f:table xmlns:f="https://www.w3schools.com/furniture">Manzana</f:table>
    <h:table xmlns:h="http://www.w3.org/TR/html4/">Banana</h:table>
</root>
```

#### DataWeave Source

The DataWeave script dynamically selects the value of the element that has the namespace
`http://www.w3.org/TR/html4/`:

```DataWeave
%dw 2.0
output application/json
ns h http://www.w3.org/TR/html4/
---
payload.root.h#"$(payload.root.@ref)"
```

Notice that the expression `payload.root.@ref` uses the attribute selector (`@`) on the `ref`
attribute of the `root` element to select the value `table`, which matches local name `table` in the
element `<h:table xmlns:h="http://www.w3.org/TR/html4/">Banana</h:table>`.

#### Output

The script outputs the value of the element that has the namespace `http://www.w3.org/TR/html4/`:

```JSON
"Banana"
```

## Use of Selectors on Content Stored in Variables

All selectors work with the [predefined Mule Runtime variables](https://docs.mulesoft.com/dataweave/2.6/dataweave-variables-context) and
with [DataWeave variables](https://docs.mulesoft.com/dataweave/2.6/dataweave-variables).

To select [Mule event](https://docs.mulesoft.com/mule-runtime/latest/about-mule-event) data, such as the payload, an
attribute, or variable data within the Mule event, use predefined Mule Runtime variables, such as
`payload`, `attributes`, and `vars`.

Extracted values are handled as literal values of one of the supported DataWeave value types.

<table><colgroup><col> <col></colgroup><thead><tr><th>Data to extract</th><th>Syntax</th></tr></thead><tbody><tr><td><p><strong>Payload</strong></p></td><td><div><div><p><code>payload</code>, for example: <code>payload.name</code></p></div><div><p>If the <code>payload</code> is <code>{"name" : "somebody"}</code>, <code>payload.name</code> returns <code>"somebody"</code>.</p></div><div><p>For more on the Mule payload, see <a href="https://docs.mulesoft.com/mule-runtime/latest/about-mule-message#_message_payload">Message Payload</a>.</p></div></div></td></tr><tr><td><p><strong>Attribute</strong></p></td><td><div><div><p><code>attributes.&lt;myAttributeName&gt;</code></p></div><div><p>For examples, see <a href="https://docs.mulesoft.com/mule-runtime/latest/about-mule-message#_attributes">Attributes</a>.</p></div></div></td></tr><tr><td><p><strong>Variable</strong></p></td><td><div><div><p><code>&lt;myVariableName&gt;</code></p></div><div><p>To avoid name collisions, you must prepend <code>vars</code> to the variable name:</p></div><div><p><code>vars.&lt;myVariableName&gt;</code></p></div><div><p>For more on Mule variables, see <a href="https://docs.mulesoft.com/mule-runtime/latest/about-mule-variables">Variables in Mule Apps</a>.</p></div></div></td></tr><tr><td><p><strong>Error object</strong></p></td><td><div><div><p><code>error</code></p></div><div><p>For information on errors in the flow, you can use <code>#[error.cause]</code>.</p></div></div></td></tr><tr><td><p><strong>Flow</strong></p></td><td><div><div><p><code>flow</code></p></div><div><p>For the flow name in the Logger: <code>#[flow.name]</code></p></div><div><p>Note that <code>flow.name</code> does not work in some Core components, such as Set Payload and Transform Message.</p></div><div><p>For more on flows, see <a href="https://docs.mulesoft.com/mule-runtime/latest/about-flows">Flows and Subflows</a>.</p></div></div></td></tr></tbody></table>

<!-- document id=8d0a570158e866ae5de4397bcb99cd9408888e49902a14771fed9b5db0791f66 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-selectors.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# DataWeave Selectors

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave selectors traverse the structures of objects and arrays and return matching values.

A selector always operates within a context, which can be a reference to a variable, an object
literal, an array literal, or the invocation of a DataWeave function.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Selector Type</th><th>Syntax</th><th>Return Type</th></tr></thead><tbody><tr><td><p>Single-value</p></td><td><p><code>.keyName</code></p></td><td><p>Any type of value that belongs to a matching key</p></td></tr><tr><td><p>Multi-value</p></td><td><p><code>.*keyName</code></p></td><td><p>Array of values of any matching keys</p></td></tr><tr><td><p>Descendants</p></td><td><p><code>..keyName</code></p></td><td><p>Array of values of any matching descendant keys</p></td></tr><tr><td><p>Dynamic</p></td><td><p>See <a href="#dynamic_selector">Dynamic Selector</a>.</p></td><td><p>&nbsp;</p></td></tr><tr><td><p>Key-value pair</p></td><td><p><code>.&amp;keyName</code></p></td><td><p>Object with the matching key</p></td></tr><tr><td><p>Index</p></td><td><p><code>[&lt;index&gt;]</code></p></td><td><p>Value of any type at selected array index. Use negative numbers to index from the end of an array, for example, <code>-1</code> for the last element in the array. Use of numbers beyond the array size returns <code>null</code>.</p></td></tr><tr><td><p>Range</p></td><td><p><code>[&lt;index&gt; to &lt;index&gt;]</code></p></td><td><p>Array with values from selected indexes</p></td></tr><tr><td><p>XML attribute</p></td><td><p><code>@</code>, <code>.@keyName</code></p></td><td><p>String value of the selected attribute</p></td></tr><tr><td><p>Namespace</p></td><td><p><code>keyName.#</code></p></td><td><p>String value of the namespace for the selected key</p></td></tr><tr><td><p>Key present</p></td><td><p><code>keyName?</code>, <code>keyName.@type?</code></p></td><td><p>Boolean (<code>true</code> if the selected key of an object or XML attribute is present, <code>false</code> if not)</p></td></tr><tr><td><p>Assert present</p></td><td><p><code>keyName!</code></p></td><td><p>String: Exception message if the key is not present</p></td></tr><tr><td><p>Filter</p></td><td><p><code>[?(boolean_expression)]</code></p></td><td><p>Array or object containing key-value pairs <em>if</em> the DataWeave expression returns <code>true</code>. Otherwise, returns the value <code>null</code>.</p></td></tr><tr><td><p>Metadata</p></td><td><p><code>.^someMetadata</code></p></td><td><div><div><p>Returns the value of specified metadata for a Mule payload, variable, or attribute. The selector can return the value of class (<code>.^class</code>), content length (<code>.^contentLength</code>), encoding (<code>.^encoding</code>), mime type (<code>.^mimeType</code>), media type (<code>.^mediaType</code>), raw (<code>.^raw</code>), and custom (<code>.^myCustomMetadata</code>) metadata. For details, see <a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-extract-data#selector_metadata">Extract Data</a>.</p></div></div></td></tr></tbody></table>

> [!NOTE] The following examples use these selectors. For additional examples of selectors, see
> [Extract Data](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-extract-data).

## Rules for Matching

In DataWeave, a name that matches the key of an object (such as the key `"someName"` in the JSON
object `{ "someName" : "Data Weave" }`) can select data from that object. For a simple example, see
[Single-Value Selector](#single_value_selector).

## Single-Value Selector

This selector matches the value of the first key-value pair in which the key matches the given
selector name. The selector can be applied to an Object or to an array. On an array, the selector
applies to all Object values inside the array and ignores all values that are not Object values. If
no key matches, the value `null` is returned.

> [!NOTE] For information about the dot selector (`.`) and how to use it on DataWeave types, refer
> to [Selecting Types](https://docs.mulesoft.com/dataweave/2.9/dataweave-selecting-types).

### Example: Using a Single-Value Selector on an Object

This example shows how the selector works on a simple JSON object.

#### Input Payload

The input payload is an object with the key `"name"` and the value `"DataWeave"`:

```JSON
{ "name": "Data Weave" }
```

#### DataWeave Source

The DataWeave script uses `payload.name` to select the value of the object that has the key
`"name"`. Note that `payload.name` and `payload."name"` are both valid ways to perform the
selection.

```DataWeave
%dw 2.0
output application/json
---
payload.name
```

#### Output

The script outputs the String value of the input object, "Data Weave":

```JSON
"Data Weave"
```

### Example: Using a Single-Value Selector on an Array

On an array, the selector applies to every element.

#### Input Payload

The input payload is an array that contains two objects with the same key, "name":

```JSON
[
  {
    "name": "Arg"
  },
  {
    "name": "Japan"
  }
]
```

#### DataWeave Source

The DataWeave script uses `payload.name` to select the value of any objects in input payload that
have the key "name":

```DataWeave
%dw 2.0
output application/json
---
payload.name
```

#### Output

The script outputs an array that contains the values of the input objects with the key `"name"`:
`"Arg"` and `"Japan"`:

```json
["Arg", "Japan"]
```

## Namespace Selector

The DataWeave namespace selector supports the use of a name that matches a namespace or a local
part. To match a namespace, the name must match the namespace and the local part. If the name only
matches the local part, the selector matches all namespaces with that local part, regardless of the
namespace.

Note that XML namespaces and their prefixes are defined in the `xmlns` attribute of an XML element.
For example, the element `<h:table xmlns:h="http://www.w3.org/TR/html4/"/>` defines a namespace that
assigns the prefix `h` to the namespace
`[http://www.w3.org/TR/html4/](http://www.w3.org/TR/html4/)`. All elements in that namespace contain
the `h` prefix. For example, in the element `<h:table/>`, `h` is the prefix for the namespace, and
`table` is the local part.

### Example: Using a Namespace Selector

This example selects values from XML elements using the namespace and local part.

#### Input Payload

The input payload contains XML elements, `h:table` and `f:table`, that have different namespaces but
the same local names (`table`):

```xml
<root>

  <h:table xmlns:h="http://www.w3.org/TR/html4/">
    <h:tr>
      <h:td>Apples</h:td>
      <h:td>Bananas</h:td>
    </h:tr>
  </h:table>

  <f:table xmlns:f="https://www.w3schools.com/furniture">
    <f:tr>
      <f:name>African Coffee Table</f:name>
      <f:width>80</f:width>
      <f:length>120</f:length>
    </f:tr>
  </f:table>

</root>
```

#### DataWeave Source

The DataWeave script selects XML content from specified namespaces. The script’s header creates
namespace (`ns`) variables `html` and `furniture` to store namespaces from the input payload. To
select the children of `h:table` into element `a` and the children of `f:table` elements into
element `b`, the script uses the `html` and `furniture` namespace variables with a namespace
selector (`#`) and local part (`table`):

```DataWeave
%dw 2.0
output application/xml
ns html http://www.w3.org/TR/html4/
ns furniture https://www.w3schools.com/furniture
---
root: {
     a: payload.root.html#table,
     b: payload.root.furniture#table
 }
```

#### Output

The script outputs children of the `h:table` element under element `a` and the children of the
`f:table` under element `b`:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<root>
  <a>
    <h:tr xmlns:h="http://www.w3.org/TR/html4/">
      <h:td>Apples</h:td>
      <h:td>Bananas</h:td>
    </h:tr>
  </a>
  <b>
    <f:tr xmlns:f="https://www.w3schools.com/furniture">
      <f:name>African Coffee Table</f:name>
      <f:width>80</f:width>
      <f:length>120</f:length>
    </f:tr>
  </b>
</root>
```

### Example: Using a Local Name to Select XML Values

This example selects XML values using a local name `table` from the `h:table` element.

#### Input Payload

The input payload contains XML with a `table` element that contains the namespace
`"http://www.w3.org/TR/html4/"`:

```xml
<root>
  <h:table xmlns:h="http://www.w3.org/TR/html4/">
    <h:tr>
      <h:td>Apples</h:td>
      <h:td>Bananas</h:td>
    </h:tr>
  </h:table>
</root>
```

#### DataWeave Source

The DataWeave script selects values of children in the `table` element by using a local name of the
XML element `table` instead of its namespace:

```DataWeave
%dw 2.0
output application/xml
---
root: { a: payload.root.table }
```

#### Output

The script outputs XML that contains the values of children in the `table` element:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<root>
  <a>
    <h:tr xmlns:h="http://www.w3.org/TR/html4/">
      <h:td>Apples</h:td>
      <h:td>Bananas</h:td>
    </h:tr>
  </a>
</root>
```

## Attribute Selector

The attribute selector returns the first attribute value that matches the selected name expression.
If no key matches, the selection returns the value `null`.

The following example selects the value of an XML attribute.

### Input Payload

The input payload is an XML `user` element that contains the attribute `name="Weave"`:

```xml
<user name="Weave"/>
```

### DataWeave Source

The DataWeave script selects the value of the `name` attribute from the input payload
(`<user name="Weave"/>`). Notice that the `@` indicates an attribute selection.

```DataWeave
%dw 2.0
output application/json
---
payload.user.@name
```

### Output

The DataWeave script outputs the value of `name` attribute.

```json
"Weave"
```

## Multi-Value Selector

Instead of returning the value of the first matching key in an array of objects, the multi-value
selector (`*`) returns an array containing values to the matching key (for example, `*user` where
`user` is the key). The selector does not return the values of descendants, only those at the
specified level. If no key matches, the selection returns the value `null`.

### Input Payload

The input payload contains an XML array of `user` elements.

```xml
<users>
  <user>Weave</user>
  <user>BAT</user>
  <user>TF</user>
</users>
```

### DataWeave Source

The DataWeave script uses `*user` to select the values of all `user` elements from the input
payload.

```DataWeave
%dw 2.0
output application/json
---
payload.users.*user
```

### Output

The script outputs an array of `user` values.

```json
["Weave", "BAT", "TF"]
```

## Descendant Selector

The descendant selector returns a list of all children and their descendants. You can directly chain
this selector to any other selector without using a single `.`. For example, `payload..` recursively
returns an array of all the child values, the values of _their_ children, and so on. You can also
chain the selector to another element (for example, with `payload..user`) to select the values of
each `user` key and its descendants, or you can use `payload..*name` to select the values of all
`name` descendants.

### Example: Selecting Each Descendant

This example selects each descendant of the input payload.

#### Input Payload

The input payload contains a set of elements that are nested at different levels.

```xml
<users>
  <user>
    <name>Weave</name>
    <user>
      <name>BAT</name>
      <user>
        <name>BDD</name>
      </user>
    </user>
  </user>
</users>
```

#### DataWeave Source

The DataWeave script uses `..` to recursively select all elements in the input payload and return
them in a JSON array.

```DataWeave
%dw 2.0
output application/json
---
payload..
```

#### Output

```json
[
  {
    "user": {
      "name": "Weave",
      "user": {
        "name": "BAT",
        "user": {
          "name": "BDD"
        }
      }
    }
  },
  {
    "name": "Weave",
    "user": {
      "name": "BAT",
      "user": {
        "name": "BDD"
      }
    }
  },
  "Weave",
  {
    "name": "BAT",
    "user": {
      "name": "BDD"
    }
  },
  "BAT",
  {
    "name": "BDD"
  },
  "BDD"
]
```

### Example: Selecting Descending Values

This example selects the descending `name` values.

#### Input Payload

The input payload contains a set of `name` elements that are nested at different levels.

```xml
<users>
  <user>
    <name>Weave</name>
    <user>
      <name>BAT</name>
      <name>Munit</name>
      <user>
        <name>BDD</name>
      </user>
    </user>
  </user>
</users>
```

#### DataWeave Source

The DataWeave script uses `..` to select the values of all first `name` elements from the input
payload and output those values into a JSON array.

```DataWeave
%dw 2.0
output application/json
---
payload..name
```

#### Output

The script outputs a JSON array with all `name` values.

```json
["Weave", "BAT", "BDD"]
```

### Example

This example selects the descending `name` values.

#### Input Payload

The input payload contains a set of `name` elements that are nested at different levels.

```xml
<users>
  <user>
    <name>Weave</name>
    <user>
      <name>BAT</name>
      <name>Munit</name>
      <user>
        <name>BDD</name>
      </user>
    </user>
  </user>
</users>
```

#### DataWeave Source

The DataWeave script uses `..*` to select the values of all `name` elements from the input payload
and output those values into a JSON array, including the `BAT` and `Munit` values of the repeated
`name` keys that are at the same level in the XML hierarchy.

```DataWeave
%dw 2.0
output application/json
---
payload..*name
```

#### Output

The script outputs a JSON array with all `name` values.

```json
["Weave", "BAT", "Munit", "BDD"]
```

### Example: Selecting Descending Values

This example selects the descending `Name` values of the `Item` elements.

#### Input Payload

The input payload contains a set of `Name` elements that are nested at different levels.

```xml
<Example>
    <Brand>
        <Id>32345</Id>
        <logo>circle</logo>
        <Item>
            <Name>Perfume</Name>
            <Item>
                <Name>Bosque</Name>
            </Item>
        </Item>
        <Item>
            <Name>t-Shirt</Name>
        </Item>
    </Brand>
    <Brand>
        <Id>435678C</Id>
        <logo>circle</logo>
        <Item>
            <Name>t-Shirt2</Name>
            <Item>
                <Name>t-Shirt red</Name>
                <Item>
                    <Name>t-Shirt red with logo</Name>
                </Item>
            </Item>
        </Item>
    </Brand>
</Example>
```

#### DataWeave Source

The DataWeave script uses `..*` to select the values of all `Name` elements nested in the `Item`
elements from the input payload and output those values into a XML array.

```DataWeave
%dw 2.0
output application/xml
---
{
    Supermarket: {
        Item: {
            Value: payload..*Item.Name
        }
    }
}
```

#### Output

The script outputs a XML array with all `name` values.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<Supermarket>
  <Item>
    <Value>Perfume</Value>
    <Value>t-Shirt</Value>
    <Value>Bosque</Value>
    <Value>t-Shirt2</Value>
    <Value>t-Shirt red</Value>
    <Value>t-Shirt red with logo</Value>
  </Item>
</Supermarket>
```

## Dynamic Selector

The syntax for dynamic selection depends on what you are selecting:

- Single Value: `payload[(nameExpression)]`

- Multi Value: `payload[*(nameExpression)]`

- Attribute: `payload[@(nameExpression)]`

- Key Value: `payload[&(nameExpression)]`

- Single Value with a Namespace: `payload.ns0#"$(nameExpression)"`

### Example: Dynamically Selecting a Single Value

This example shows how to dynamically select a single value.

#### Input Payload

The input payload is an array of objects. The first object has the key `"ref"` and the value
`"name"`. The second has the key `"name"` and the value `"Data Weave"`:

```JSON
{ "ref": "name", "name": "Data Weave" }
```

#### DataWeave Source

The DataWeave script dynamically selects the value of the `"name"` key:

```DataWeave
%dw 2.0
output application/json
---
payload[(payload.ref)]
```

Notice that it passes `payload.ref` within the parentheses of dynamic selector `[()]`. The script
works because the value of `"ref"` is `"name"`, which matches the key `"name"`.

#### Output

The script outputs the value of the object that has the `"name"` key:

```JSON
"Data Weave"
```

### Example: Dynamically Selecting a Single Value with a Namespace

This example shows how to dynamically select a single value that contains a namespace.

#### Input Payload

The input payload contains a `<root/>` element with two child elements, one of which has the
namespace `http://www.w3.org/TR/html4/`. Both child elements (`<f:table/>` and `<h:table>`) have the
local name `table`:

```xml
<root ref="table">
    <f:table xmlns:f="https://www.w3schools.com/furniture">Manzana</f:table>
    <h:table xmlns:h="http://www.w3.org/TR/html4/">Banana</h:table>
</root>
```

#### DataWeave Source

The DataWeave script dynamically selects the value of the element that has the namespace
`http://www.w3.org/TR/html4/`:

```DataWeave
%dw 2.0
output application/json
ns h http://www.w3.org/TR/html4/
---
payload.root.h#"$(payload.root.@ref)"
```

Notice that the expression `payload.root.@ref` uses the attribute selector (`@`) on the `ref`
attribute of the `root` element to select the value `table`, which matches local name `table` in the
element `<h:table xmlns:h="http://www.w3.org/TR/html4/">Banana</h:table>`.

#### Output

The script outputs the value of the element that has the namespace `http://www.w3.org/TR/html4/`:

```JSON
"Banana"
```

## Use of Selectors on Content Stored in Variables

All selectors work with the [predefined Mule Runtime variables](https://docs.mulesoft.com/dataweave/2.9/dataweave-variables-context) and
with [DataWeave variables](https://docs.mulesoft.com/dataweave/2.9/dataweave-variables).

To select [Mule event](https://docs.mulesoft.com/mule-runtime/latest/about-mule-event) data, such as the payload, an
attribute, or variable data within the Mule event, use predefined Mule Runtime variables, such as
`payload`, `attributes`, and `vars`.

Extracted values are handled as literal values of one of the supported DataWeave value types.

<table><colgroup><col> <col></colgroup><thead><tr><th>Data to extract</th><th>Syntax</th></tr></thead><tbody><tr><td><p><strong>Payload</strong></p></td><td><div><div><p><code>payload</code>, for example: <code>payload.name</code></p></div><div><p>If the <code>payload</code> is <code>{"name" : "somebody"}</code>, <code>payload.name</code> returns <code>"somebody"</code>.</p></div><div><p>For more on the Mule payload, see <a href="https://docs.mulesoft.com/mule-runtime/latest/about-mule-message#_message_payload">Message Payload</a>.</p></div></div></td></tr><tr><td><p><strong>Attribute</strong></p></td><td><div><div><p><code>attributes.&lt;myAttributeName&gt;</code></p></div><div><p>For examples, see <a href="https://docs.mulesoft.com/mule-runtime/latest/about-mule-message#_attributes">Attributes</a>.</p></div></div></td></tr><tr><td><p><strong>Variable</strong></p></td><td><div><div><p><code>&lt;myVariableName&gt;</code></p></div><div><p>To avoid name collisions, you must prepend <code>vars</code> to the variable name:</p></div><div><p><code>vars.&lt;myVariableName&gt;</code></p></div><div><p>For more on Mule variables, see <a href="https://docs.mulesoft.com/mule-runtime/latest/about-mule-variables">Variables in Mule Apps</a>.</p></div></div></td></tr><tr><td><p><strong>Error object</strong></p></td><td><div><div><p><code>error</code></p></div><div><p>For information on errors in the flow, you can use <code>#[error.cause]</code>.</p></div></div></td></tr><tr><td><p><strong>Flow</strong></p></td><td><div><div><p><code>flow</code></p></div><div><p>For the flow name in the Logger: <code>#[flow.name]</code></p></div><div><p>Note that <code>flow.name</code> does not work in some Core components, such as Set Payload and Transform Message.</p></div><div><p>For more on flows, see <a href="https://docs.mulesoft.com/mule-runtime/latest/about-flows">Flows and Subflows</a>.</p></div></div></td></tr></tbody></table>

<!-- document id=dd020c00b3df56ba865e127e9c9b6e4c5e5da7ad8429d5f6b7be5afd24bc46a2 url=/mulesoft/current/en-us/dataweave/latest/dataweave-selectors.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# DataWeave Selectors

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave selectors traverse the structures of objects and arrays and return matching values.

A selector always operates within a context, which can be a reference to a variable, an object
literal, an array literal, or the invocation of a DataWeave function.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Selector Type</th><th>Syntax</th><th>Return Type</th></tr></thead><tbody><tr><td><p>Single-value</p></td><td><p><code>.keyName</code></p></td><td><p>Any type of value that belongs to a matching key</p></td></tr><tr><td><p>Multi-value</p></td><td><p><code>.*keyName</code></p></td><td><p>Array of values of any matching keys</p></td></tr><tr><td><p>Descendants</p></td><td><p><code>..keyName</code></p></td><td><p>Array of values of any matching descendant keys</p></td></tr><tr><td><p>Dynamic</p></td><td><p>See <a href="#dynamic_selector">Dynamic Selector</a>.</p></td><td><p>&nbsp;</p></td></tr><tr><td><p>Key-value pair</p></td><td><p><code>.&amp;keyName</code></p></td><td><p>Object with the matching key</p></td></tr><tr><td><p>Index</p></td><td><p><code>[&lt;index&gt;]</code></p></td><td><p>Value of any type at selected array index. Use negative numbers to index from the end of an array, for example, <code>-1</code> for the last element in the array. Use of numbers beyond the array size returns <code>null</code>.</p></td></tr><tr><td><p>Range</p></td><td><p><code>[&lt;index&gt; to &lt;index&gt;]</code></p></td><td><p>Array with values from selected indexes</p></td></tr><tr><td><p>XML attribute</p></td><td><p><code>@</code>, <code>.@keyName</code></p></td><td><p>String value of the selected attribute</p></td></tr><tr><td><p>Namespace</p></td><td><p><code>keyName.#</code></p></td><td><p>String value of the namespace for the selected key</p></td></tr><tr><td><p>Key present</p></td><td><p><code>keyName?</code>, <code>keyName.@type?</code></p></td><td><p>Boolean (<code>true</code> if the selected key of an object or XML attribute is present, <code>false</code> if not)</p></td></tr><tr><td><p>Assert present</p></td><td><p><code>keyName!</code></p></td><td><p>String: Exception message if the key is not present</p></td></tr><tr><td><p>Filter</p></td><td><p><code>[?(boolean_expression)]</code></p></td><td><p>Array or object containing key-value pairs <em>if</em> the DataWeave expression returns <code>true</code>. Otherwise, returns the value <code>null</code>.</p></td></tr><tr><td><p>Metadata</p></td><td><p><code>.^someMetadata</code></p></td><td><div><div><p>Returns the value of specified metadata for a Mule payload, variable, or attribute. The selector can return the value of class (<code>.^class</code>), content length (<code>.^contentLength</code>), encoding (<code>.^encoding</code>), mime type (<code>.^mimeType</code>), media type (<code>.^mediaType</code>), raw (<code>.^raw</code>), and custom (<code>.^myCustomMetadata</code>) metadata. For details, see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-extract-data#selector_metadata">Extract Data</a>.</p></div></div></td></tr></tbody></table>

> [!NOTE] The following examples use these selectors. For additional examples of selectors, see
> [Extract Data](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-extract-data).

## Rules for Matching

In DataWeave, a name that matches the key of an object (such as the key `"someName"` in the JSON
object `{ "someName" : "Data Weave" }`) can select data from that object. For a simple example, see
[Single-Value Selector](#single_value_selector).

## Single-Value Selector

This selector matches the value of the first key-value pair in which the key matches the given
selector name. The selector can be applied to an Object or to an array. On an array, the selector
applies to all Object values inside the array and ignores all values that are not Object values. If
no key matches, the value `null` is returned.

> [!NOTE] For information about the dot selector (`.`) and how to use it on DataWeave types, refer
> to [Selecting Types](https://docs.mulesoft.com/dataweave/latest/dataweave-selecting-types).

### Example: Using a Single-Value Selector on an Object

This example shows how the selector works on a simple JSON object.

#### Input Payload

The input payload is an object with the key `"name"` and the value `"DataWeave"`:

```JSON
{ "name": "Data Weave" }
```

#### DataWeave Source

The DataWeave script uses `payload.name` to select the value of the object that has the key
`"name"`. Note that `payload.name` and `payload."name"` are both valid ways to perform the
selection.

```DataWeave
%dw 2.0
output application/json
---
payload.name
```

#### Output

The script outputs the String value of the input object, "Data Weave":

```JSON
"Data Weave"
```

### Example: Using a Single-Value Selector on an Array

On an array, the selector applies to every element.

#### Input Payload

The input payload is an array that contains two objects with the same key, "name":

```JSON
[
  {
    "name": "Arg"
  },
  {
    "name": "Japan"
  }
]
```

#### DataWeave Source

The DataWeave script uses `payload.name` to select the value of any objects in input payload that
have the key "name":

```DataWeave
%dw 2.0
output application/json
---
payload.name
```

#### Output

The script outputs an array that contains the values of the input objects with the key `"name"`:
`"Arg"` and `"Japan"`:

```json
["Arg", "Japan"]
```

## Namespace Selector

The DataWeave namespace selector supports the use of a name that matches a namespace or a local
part. To match a namespace, the name must match the namespace and the local part. If the name only
matches the local part, the selector matches all namespaces with that local part, regardless of the
namespace.

Note that XML namespaces and their prefixes are defined in the `xmlns` attribute of an XML element.
For example, the element `<h:table xmlns:h="http://www.w3.org/TR/html4/"/>` defines a namespace that
assigns the prefix `h` to the namespace
`[http://www.w3.org/TR/html4/](http://www.w3.org/TR/html4/)`. All elements in that namespace contain
the `h` prefix. For example, in the element `<h:table/>`, `h` is the prefix for the namespace, and
`table` is the local part.

### Example: Using a Namespace Selector

This example selects values from XML elements using the namespace and local part.

#### Input Payload

The input payload contains XML elements, `h:table` and `f:table`, that have different namespaces but
the same local names (`table`):

```xml
<root>

  <h:table xmlns:h="http://www.w3.org/TR/html4/">
    <h:tr>
      <h:td>Apples</h:td>
      <h:td>Bananas</h:td>
    </h:tr>
  </h:table>

  <f:table xmlns:f="https://www.w3schools.com/furniture">
    <f:tr>
      <f:name>African Coffee Table</f:name>
      <f:width>80</f:width>
      <f:length>120</f:length>
    </f:tr>
  </f:table>

</root>
```

#### DataWeave Source

The DataWeave script selects XML content from specified namespaces. The script’s header creates
namespace (`ns`) variables `html` and `furniture` to store namespaces from the input payload. To
select the children of `h:table` into element `a` and the children of `f:table` elements into
element `b`, the script uses the `html` and `furniture` namespace variables with a namespace
selector (`#`) and local part (`table`):

```DataWeave
%dw 2.0
output application/xml
ns html http://www.w3.org/TR/html4/
ns furniture https://www.w3schools.com/furniture
---
root: {
     a: payload.root.html#table,
     b: payload.root.furniture#table
 }
```

#### Output

The script outputs children of the `h:table` element under element `a` and the children of the
`f:table` under element `b`:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<root>
  <a>
    <h:tr xmlns:h="http://www.w3.org/TR/html4/">
      <h:td>Apples</h:td>
      <h:td>Bananas</h:td>
    </h:tr>
  </a>
  <b>
    <f:tr xmlns:f="https://www.w3schools.com/furniture">
      <f:name>African Coffee Table</f:name>
      <f:width>80</f:width>
      <f:length>120</f:length>
    </f:tr>
  </b>
</root>
```

### Example: Using a Local Name to Select XML Values

This example selects XML values using a local name `table` from the `h:table` element.

#### Input Payload

The input payload contains XML with a `table` element that contains the namespace
`"http://www.w3.org/TR/html4/"`:

```xml
<root>
  <h:table xmlns:h="http://www.w3.org/TR/html4/">
    <h:tr>
      <h:td>Apples</h:td>
      <h:td>Bananas</h:td>
    </h:tr>
  </h:table>
</root>
```

#### DataWeave Source

The DataWeave script selects values of children in the `table` element by using a local name of the
XML element `table` instead of its namespace:

```DataWeave
%dw 2.0
output application/xml
---
root: { a: payload.root.table }
```

#### Output

The script outputs XML that contains the values of children in the `table` element:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<root>
  <a>
    <h:tr xmlns:h="http://www.w3.org/TR/html4/">
      <h:td>Apples</h:td>
      <h:td>Bananas</h:td>
    </h:tr>
  </a>
</root>
```

## Attribute Selector

The attribute selector returns the first attribute value that matches the selected name expression.
If no key matches, the selection returns the value `null`.

The following example selects the value of an XML attribute.

### Input Payload

The input payload is an XML `user` element that contains the attribute `name="Weave"`:

```xml
<user name="Weave"/>
```

### DataWeave Source

The DataWeave script selects the value of the `name` attribute from the input payload
(`<user name="Weave"/>`). Notice that the `@` indicates an attribute selection.

```DataWeave
%dw 2.0
output application/json
---
payload.user.@name
```

### Output

The DataWeave script outputs the value of `name` attribute.

```json
"Weave"
```

## Multi-Value Selector

Instead of returning the value of the first matching key in an array of objects, the multi-value
selector (`*`) returns an array containing values to the matching key (for example, `*user` where
`user` is the key). The selector does not return the values of descendants, only those at the
specified level. If no key matches, the selection returns the value `null`.

### Input Payload

The input payload contains an XML array of `user` elements.

```xml
<users>
  <user>Weave</user>
  <user>BAT</user>
  <user>TF</user>
</users>
```

### DataWeave Source

The DataWeave script uses `*user` to select the values of all `user` elements from the input
payload.

```DataWeave
%dw 2.0
output application/json
---
payload.users.*user
```

### Output

The script outputs an array of `user` values.

```json
["Weave", "BAT", "TF"]
```

## Descendant Selector

The descendant selector returns a list of all children and their descendants. You can directly chain
this selector to any other selector without using a single `.`. For example, `payload..` recursively
returns an array of all the child values, the values of _their_ children, and so on. You can also
chain the selector to another element (for example, with `payload..user`) to select the values of
each `user` key and its descendants, or you can use `payload..*name` to select the values of all
`name` descendants.

### Example: Selecting Each Descendant

This example selects each descendant of the input payload.

#### Input Payload

The input payload contains a set of elements that are nested at different levels.

```xml
<users>
  <user>
    <name>Weave</name>
    <user>
      <name>BAT</name>
      <user>
        <name>BDD</name>
      </user>
    </user>
  </user>
</users>
```

#### DataWeave Source

The DataWeave script uses `..` to recursively select all elements in the input payload and return
them in a JSON array.

```DataWeave
%dw 2.0
output application/json
---
payload..
```

#### Output

```json
[
  {
    "user": {
      "name": "Weave",
      "user": {
        "name": "BAT",
        "user": {
          "name": "BDD"
        }
      }
    }
  },
  {
    "name": "Weave",
    "user": {
      "name": "BAT",
      "user": {
        "name": "BDD"
      }
    }
  },
  "Weave",
  {
    "name": "BAT",
    "user": {
      "name": "BDD"
    }
  },
  "BAT",
  {
    "name": "BDD"
  },
  "BDD"
]
```

### Example: Selecting Descending Values

This example selects the descending `name` values.

#### Input Payload

The input payload contains a set of `name` elements that are nested at different levels.

```xml
<users>
  <user>
    <name>Weave</name>
    <user>
      <name>BAT</name>
      <name>Munit</name>
      <user>
        <name>BDD</name>
      </user>
    </user>
  </user>
</users>
```

#### DataWeave Source

The DataWeave script uses `..` to select the values of all first `name` elements from the input
payload and output those values into a JSON array.

```DataWeave
%dw 2.0
output application/json
---
payload..name
```

#### Output

The script outputs a JSON array with all `name` values.

```json
["Weave", "BAT", "BDD"]
```

### Example

This example selects the descending `name` values.

#### Input Payload

The input payload contains a set of `name` elements that are nested at different levels.

```xml
<users>
  <user>
    <name>Weave</name>
    <user>
      <name>BAT</name>
      <name>Munit</name>
      <user>
        <name>BDD</name>
      </user>
    </user>
  </user>
</users>
```

#### DataWeave Source

The DataWeave script uses `..*` to select the values of all `name` elements from the input payload
and output those values into a JSON array, including the `BAT` and `Munit` values of the repeated
`name` keys that are at the same level in the XML hierarchy.

```DataWeave
%dw 2.0
output application/json
---
payload..*name
```

#### Output

The script outputs a JSON array with all `name` values.

```json
["Weave", "BAT", "Munit", "BDD"]
```

### Example: Selecting Descending Values

This example selects the descending `Name` values of the `Item` elements.

#### Input Payload

The input payload contains a set of `Name` elements that are nested at different levels.

```xml
<Example>
    <Brand>
        <Id>32345</Id>
        <logo>circle</logo>
        <Item>
            <Name>Perfume</Name>
            <Item>
                <Name>Bosque</Name>
            </Item>
        </Item>
        <Item>
            <Name>t-Shirt</Name>
        </Item>
    </Brand>
    <Brand>
        <Id>435678C</Id>
        <logo>circle</logo>
        <Item>
            <Name>t-Shirt2</Name>
            <Item>
                <Name>t-Shirt red</Name>
                <Item>
                    <Name>t-Shirt red with logo</Name>
                </Item>
            </Item>
        </Item>
    </Brand>
</Example>
```

#### DataWeave Source

The DataWeave script uses `..*` to select the values of all `Name` elements nested in the `Item`
elements from the input payload and output those values into a XML array.

```DataWeave
%dw 2.0
output application/xml
---
{
    Supermarket: {
        Item: {
            Value: payload..*Item.Name
        }
    }
}
```

#### Output

The script outputs a XML array with all `name` values.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<Supermarket>
  <Item>
    <Value>Perfume</Value>
    <Value>t-Shirt</Value>
    <Value>Bosque</Value>
    <Value>t-Shirt2</Value>
    <Value>t-Shirt red</Value>
    <Value>t-Shirt red with logo</Value>
  </Item>
</Supermarket>
```

## Dynamic Selector

The syntax for dynamic selection depends on what you are selecting:

- Single Value: `payload[(nameExpression)]`

- Multi Value: `payload[*(nameExpression)]`

- Attribute: `payload[@(nameExpression)]`

- Key Value: `payload[&(nameExpression)]`

- Single Value with a Namespace: `payload.ns0#"$(nameExpression)"`

### Example: Dynamically Selecting a Single Value

This example shows how to dynamically select a single value.

#### Input Payload

The input payload is an array of objects. The first object has the key `"ref"` and the value
`"name"`. The second has the key `"name"` and the value `"Data Weave"`:

```JSON
{ "ref": "name", "name": "Data Weave" }
```

#### DataWeave Source

The DataWeave script dynamically selects the value of the `"name"` key:

```DataWeave
%dw 2.0
output application/json
---
payload[(payload.ref)]
```

Notice that it passes `payload.ref` within the parentheses of dynamic selector `[()]`. The script
works because the value of `"ref"` is `"name"`, which matches the key `"name"`.

#### Output

The script outputs the value of the object that has the `"name"` key:

```JSON
"Data Weave"
```

### Example: Dynamically Selecting a Single Value with a Namespace

This example shows how to dynamically select a single value that contains a namespace.

#### Input Payload

The input payload contains a `<root/>` element with two child elements, one of which has the
namespace `http://www.w3.org/TR/html4/`. Both child elements (`<f:table/>` and `<h:table>`) have the
local name `table`:

```xml
<root ref="table">
    <f:table xmlns:f="https://www.w3schools.com/furniture">Manzana</f:table>
    <h:table xmlns:h="http://www.w3.org/TR/html4/">Banana</h:table>
</root>
```

#### DataWeave Source

The DataWeave script dynamically selects the value of the element that has the namespace
`http://www.w3.org/TR/html4/`:

```DataWeave
%dw 2.0
output application/json
ns h http://www.w3.org/TR/html4/
---
payload.root.h#"$(payload.root.@ref)"
```

Notice that the expression `payload.root.@ref` uses the attribute selector (`@`) on the `ref`
attribute of the `root` element to select the value `table`, which matches local name `table` in the
element `<h:table xmlns:h="http://www.w3.org/TR/html4/">Banana</h:table>`.

#### Output

The script outputs the value of the element that has the namespace `http://www.w3.org/TR/html4/`:

```JSON
"Banana"
```

## Use of Selectors on Content Stored in Variables

All selectors work with the [predefined Mule Runtime variables](https://docs.mulesoft.com/dataweave/latest/dataweave-variables-context) and
with [DataWeave variables](https://docs.mulesoft.com/dataweave/latest/dataweave-variables).

To select [Mule event](https://docs.mulesoft.com/mule-runtime/latest/about-mule-event) data, such as the payload, an
attribute, or variable data within the Mule event, use predefined Mule Runtime variables, such as
`payload`, `attributes`, and `vars`.

Extracted values are handled as literal values of one of the supported DataWeave value types.

<table><colgroup><col> <col></colgroup><thead><tr><th>Data to extract</th><th>Syntax</th></tr></thead><tbody><tr><td><p><strong>Payload</strong></p></td><td><div><div><p><code>payload</code>, for example: <code>payload.name</code></p></div><div><p>If the <code>payload</code> is <code>{"name" : "somebody"}</code>, <code>payload.name</code> returns <code>"somebody"</code>.</p></div><div><p>For more on the Mule payload, see <a href="https://docs.mulesoft.com/mule-runtime/latest/about-mule-message#_message_payload">Message Payload</a>.</p></div></div></td></tr><tr><td><p><strong>Attribute</strong></p></td><td><div><div><p><code>attributes.&lt;myAttributeName&gt;</code></p></div><div><p>For examples, see <a href="https://docs.mulesoft.com/mule-runtime/latest/about-mule-message#_attributes">Attributes</a>.</p></div></div></td></tr><tr><td><p><strong>Variable</strong></p></td><td><div><div><p><code>&lt;myVariableName&gt;</code></p></div><div><p>To avoid name collisions, you must prepend <code>vars</code> to the variable name:</p></div><div><p><code>vars.&lt;myVariableName&gt;</code></p></div><div><p>For more on Mule variables, see <a href="https://docs.mulesoft.com/mule-runtime/latest/about-mule-variables">Variables in Mule Apps</a>.</p></div></div></td></tr><tr><td><p><strong>Error object</strong></p></td><td><div><div><p><code>error</code></p></div><div><p>For information on errors in the flow, you can use <code>#[error.cause]</code>.</p></div></div></td></tr><tr><td><p><strong>Flow</strong></p></td><td><div><div><p><code>flow</code></p></div><div><p>For the flow name in the Logger: <code>#[flow.name]</code></p></div><div><p>Note that <code>flow.name</code> does not work in some Core components, such as Set Payload and Transform Message.</p></div><div><p>For more on flows, see <a href="https://docs.mulesoft.com/mule-runtime/latest/about-flows">Flows and Subflows</a>.</p></div></div></td></tr></tbody></table>

<!-- document id=abec702ff17164e910c07136c6707960eddfa180e01868d5d53c1f3ee6b1d9ab url=/mulesoft/current/en-us/dataweave/2.11/dataweave-system-properties.md -->

---
product: DataWeave
version: 2.11
---

# DataWeave System Properties

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave supports several system properties. To use these properties in application development and
deployments, see [System Properties](https://docs.mulesoft.com/mule-runtime/latest/mule-app-properties-system).

Whether a property in this reference applies depends on the DataWeave language level configured for
the application, not only on the Mule runtime version where the application runs. For how language
level is determined in Mule applications (including its relationship to `minMuleVersion`), see
[Versioning Behavior in DataWeave](https://docs.mulesoft.com/dataweave/2.11/dataweave-versioning-behavior).

If a property is listed as available only for specific language levels, it applies only when the
application uses one of those levels. In newer DataWeave versions, some of these properties remain
supported only for backward compatibility when the application targets a compatible earlier language
level, even if it runson a newer Mule runtime.

<table><colgroup><col> <col></colgroup><thead><tr><th>Property</th><th>Description</th></tr></thead><tbody><tr><td><p><code>com.mulesoft.dw.base64ChunksEnabled</code></p></td><td><div><div><p>When set to <code>true</code>, <code>dw::core::Binaries::fromBase64</code> and <code>dw::core::Binaries::toBase64</code> functions don’t load the entire function argument (<code>String</code> or <code>Binary</code>) into memory. DataWeave loads the function argument (<code>String</code> or <code>Binary</code>) by chunk. This feature prevents an out-of-memory error.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>true</code> for language level: 2.11</p></li></ul></div></li></ul></div><div><p>Available for language level: 2.11</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.buffered_char_sequence.enabled</code></p></td><td><div><div><p>Controls whether an internal <code>BufferedCharSequence</code> improvement is enabled or disabled. When this property is set to <code>true</code>, DataWeave does not load large fields (greater than 1.5M) into memory. DataWeave reads these fields by chunk. This feature reduces performance to prevent an out-of-memory error.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>true</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.buffersize</code></p></td><td><div><div><p>Sets the size (in bytes) of in-memory input and output buffers that DataWeave uses to retain processed inputs and outputs. DataWeave stores payloads that exceed this size in temporary files <code>dw-buffer-index-${count}.tmp</code> and <code>dw-buffer-output-${count}.tmp</code>. See <a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-memory-management">DataWeave Memory Management</a>.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>8192</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.charbuffersize</code></p></td><td><div><div><p>Determines the size (in bytes) of the buffer used by the writer.</p></div><div><ul><li><p>Type: <code>Number</code> (in bytes)</p></li><li><p>Default: <code>4096</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.coercionexception.verbose</code></p></td><td><div><div><p>By default, adds to coercion exceptions more information about data that fails to coerce. When this property is set to <code>false</code>, DataWeave does not display the additional metadata.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>true</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.cpulimit.watchdog</code></p></td><td><div><div><p>Monitors and limits script execution time when set to <code>true</code>.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>true</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.csv_reader.indexed.retainStringValueInMemory</code></p></td><td><div><div><p>When set to <code>false</code>, this property prevents DataWeave indexed readers for CSV from keeping string value references in memory. While this can reduce performance, it helps prevent out-of-memory errors.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>true</code> for language levels: 2.6, 2.7, 2.8, 2.9</p></li><li><p><code>false</code> for language levels: 2.10, 2.11</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.6, 2.7, 2.8, 2.9, 2.10, 2.11</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.csv_writer.alwaysEscapeQuotesInCSV</code></p></td><td><div><div><p>When set to <code>true</code>, DataWeave escapes quotes in CSV.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.4</p></li><li><p><code>true</code> for language levels: 2.5</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.4, 2.5</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.date_minus_back_compatibility</code></p></td><td><div><div><p>Restores the <a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-add-and-subtract-time">Add and Subtract Time</a> behaviors that changed in 2.3.0 when this property is set to <code>true</code>.</p></div><div><p>For example, consider the following DataWeave script:</p></div><div><div><pre><code data-lang="dataweave">%dw 2.0
output application/dw
---
|2019-10-01| - |2018-09-23|</code></pre></div></div><div><ul><li><p>In DataWeave 2.3.0, the expression returns <code>PT8952H</code>.</p></li><li><p>In DataWeave 2.2.0, the expression returns <code>P1Y8D</code>.</p></li><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.3, 2.4, 2.5</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.3, 2.4, 2.5</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.decode_binaries_with_writer_encoding</code></p></td><td><div><div><p>When set to <code>true</code>, binary values in JSON are written using JsonWriter encoding. Otherwise, the property uses either the encoding defined in the value schema or the default one.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.defaultOperator.disableExceptionHandling</code></p></td><td><div><div><p>When set to <code>true</code>, DataWeave disables the <code>default</code> operator that catches runtime exceptions. Enabling the <code>default</code> operator doesn’t return the <code>default value</code> when a runtime exception occurs. When set to <code>false</code>, the <code>default</code> operator catches the runtime exceptions and returns the <code>default value</code>.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>true</code> for language levels: 2.5, 2.6, 2.7, 2.8, 2.9</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.5, 2.6, 2.7, 2.8, 2.9</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.directbuffer.disable</code></p></td><td><div><div><p>Controls whether DataWeave uses off-heap memory (the default) or heap memory. DataWeave uses off-heap memory for internal buffering, which can cause issues on systems that have only a small amount of memory. See <a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-memory-management">DataWeave Memory Management</a>.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.dump_files</code></p></td><td><div><div><p><em>Experimental:</em> Dumps the input context and the failing script into a folder when this property is set to <code>true</code>. This behavior enables you to track the failing script and the data that makes the script fail, which is particularly useful for verifying that the received input data is valid. Incorrect scripts often fail when an upstream component generates invalid data.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div><div><p><code>com.mulesoft.dw.dump_files</code> is an <em>experimental feature</em> that is subject to change or removal from future versions of DataWeave. See <a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-troubleshoot">Troubleshooting a Failing DataWeave Script</a>.</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.dump_folder</code></p></td><td><div><div><p><em>Experimental:</em> Specifies the path in which to dump files when <code>com.mulesoft.dw.dump_files</code> is set to <code>true</code>.</p></div><div><ul><li><p>Type: <code>String</code></p></li><li><p>Default: <code>java.io.tempdir (system property value)</code></p></li></ul></div><div><p><code>com.mulesoft.dw.dump_folder</code> is an <em>experimental feature</em> that is subject to change or removal from future versions of DataWeave. See <a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-troubleshoot">Troubleshooting a Failing DataWeave Script</a>.</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.dumper_fill_stacktrace</code></p></td><td><div><div><p><em>Experimental:</em> Adds the StackTrace for dumper exceptions when <code>com.mulesoft.dw.dump_files</code> is set to <code>true</code>.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div><div><p><code>com.mulesoft.dw.dumper_fill_stacktrace</code> is an <em>experimental feature</em> that is subject to change or removal from future versions of DataWeave. See <a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-troubleshoot">Troubleshooting a Failing DataWeave Script</a>.</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.error_value_length</code></p></td><td><div><div><p>Sets the maximum length of exception messages to display to the user. The message is truncated to the maximum length. This setting is useful for avoiding long exception messages.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>80</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.indexsize</code></p></td><td><div><div><p>Sets the maximum size (in bytes) of the page in memory that indexed readers use.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>1572864</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.java.disable_set_accessible</code></p></td><td><div><div><p>When set to <code>true</code>, the JavaModuleLoader doesn’t change the accessible flag for fields or methods used via reflection. The default value evaluates the current JDK version used and the language level. The value is <code>true</code> when the used JDK is 17 or later and the language version is 2.6 or later.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.5</p></li><li><p><code>true</code> for language levels: 2.6, 2.7, 2.8, 2.9</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.5, 2.6, 2.7, 2.8, 2.9</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.java.enabled_class_definition_lookup</code></p></td><td><div><div><p>When set to <code>true</code>, the JavaModuleLoader honors the public interface definition of the given bean instance to access properties via reflection. The default value evaluates the current JDK version used and the language level. The value is <code>true</code> when the used JDK is 17+ and the language version is greater than 2.10. If set to <code>false</code>, the JavaModuleLoader uses the specific bean’s class definition to access properties via reflection, which could end in accessibility issues.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.5, 2.6, 2.7, 2.8, 2.9</p></li><li><p><code>true</code> for language levels: 2.10, 2.11</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.5, 2.6, 2.7, 2.8, 2.9, 2.10, 2.11</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.java.honour_bean_definition_accessor</code></p></td><td><div><div><p>When set to <code>true</code>, the JavaModuleLoader honors the bean definition by using the getter and setter methods to access properties via reflection at object value selectors. If set to <code>false</code>, the JavaModuleLoader uses the getter and setter methods to access existing properties or the property uses the field accessor as default.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.8</p></li><li><p><code>true</code> for language levels: 2.9, 2.10, 2.11</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.8, 2.9, 2.10, 2.11</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.java.output_types_as_string</code></p></td><td><div><div><p>When set to <code>true</code>, DataWeave scripts with Java output <code>mimetype</code> return the string representation of that type. If set to <code>false</code>, the scripts return a Java class constructed from the corresponding DataWeave type class.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>true</code> for language levels: 2.0, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7, 2.8, 2.9, 2.10, 2.11</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.0, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7, 2.8, 2.9, 2.10, 2.11</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.java.stacktrace</code></p></td><td><div><div><p>Specifies the depth of the Java stack trace.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>6</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.javaSqlDateToDate</code></p></td><td><div><div><p>When set, <code>java.sql.Date</code> maps to the DataWeave <code>Date</code> type. If <code>false</code>, it maps to <code>DateTime</code>.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.4</p></li><li><p><code>true</code> for language levels: 2.5</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.4, 2.5</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.legacySizeOfNumber</code></p></td><td><div><div><p>When set to <code>true</code>, DataWeave returns <code>1</code> when calling <code>sizeOf()</code> function for any <code>Number</code> value.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.6, 2.7, 2.8, 2.9, 2.10</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.6, 2.7, 2.8, 2.9, 2.10</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.max_memory_allocation</code></p></td><td><div><div><p>Sets the size (in bytes) of each slot in the off-heap memory pool. DataWeave stores payloads that exceed this size in temporary files <code>dw-buffer-input-${count}.tmp</code> and <code>dw-buffer-output-${count}.tmp</code>.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>1572864</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.memory_pool_size</code></p></td><td><div><div><p>Sets the number of slots in the memory pool. DataWeave buffers use off-heap memory from a pool, up to a defined size (<code>com.mulesoft.dw.memory_pool_size</code> * <code>com.mulesoft.dw.max_memory_allocation</code>). DataWeave allocates the remainder using heap memory. See <a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-memory-management">DataWeave Memory Management</a>.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>60</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.messageLogging.debounceDuration</code></p></td><td><div><div><p>Sets the number of milliseconds to wait before logging the same message again when using <code>MessageLoggingService.logXXXXDebounce</code> methods.</p></div><div><ul><li><p>Type: <code>Long</code></p></li><li><p>Default: <code>3000</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.multipart.defaultContentType</code></p></td><td><div><div><p>Sets the default Content-Type to use on parts of the <code>multipart/*</code> format when a <code>Content-Type</code> is not specified. See also, the multipart reader property <a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-formats-multipart#properties">defaultContentType</a>. <em>Introduced in DataWeave 2.3 (2.3.0-20210720) for the August 2021 release of Mule 4.3.0-20210719.</em></p></div><div><ul><li><p>Type: <code>String</code></p></li><li><p>Default: <code>application/octet-stream</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.scheduler.size</code></p></td><td><div><div><p>Specifies the size of DataWeave scheduler thread pool.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>100</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.stableOrderBy</code></p></td><td><div><div><p>When set to <code>true</code>, DataWeave throws <code>InvalidComparisonException</code> if the <code>orderBy</code> function attempts to compare values of different types. If set to <code>false</code>, coercions are used when comparing values of different types, which can cause the resulting order to be different from the expected one as in:</p></div><div><div>DataWeave script:</div><div><pre><code data-lang="xml">%dw 2.4
output application/json
---
[5, 1, "10"] orderBy $</code></pre></div></div><div><ul><li><p>If <code>com.mulesoft.dw.stableOrderBy</code> is set to <code>false</code>, the script returns the following output: <code>[1, "10", 5]</code></p></li><li><p>If <code>com.mulesoft.dw.stableOrderBy</code> is set to <code>true</code>, the script throws <code>InvalidComparisonException</code>.</p></li><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.9</p></li><li><p><code>true</code> for language levels: 2.10, 2.11</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.9, 2.10, 2.11</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.stacksize</code></p></td><td><div><div><p>Sets the maximum size of the stack. When a function recurses too deeply, DataWeave throws an error, such as Stack Overflow. The maximum size limit is 256.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>256</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.stripTrailingZeroes</code></p></td><td><div><div><p>When set to <code>false</code>, DataWeave restores the behavior of preserving trailing zeroes for some formats (such as DataWeave, JSON, and YAML) present in 2.4.0. Starting with 2.5.0, trailing zeroes are removed by default.</p></div><div><div>DataWeave script:</div><div><pre><code data-lang="xml">%dw 2.4
output application/json
---
1.00</code></pre></div></div><div><ul><li><p>If <code>com.mulesoft.dw.stripTrailingZeroes</code> is set to <code>false</code>, the script returns the following output: <code>1.00</code></p></li><li><p>If <code>com.mulesoft.dw.stripTrailingZeroes</code> is set to <code>true</code>, the script returns the following output: <code>1</code></p></li><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>true</code> for language levels: 2.5, 2.6, 2.7, 2.8, 2.9</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.5, 2.6, 2.7, 2.8, 2.9</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.surrogateCharCodeSupport</code></p></td><td><div><div><p>When set to <code>true</code>, the <code>fromCharCode</code> function supports surrogate characters and throws an exception if the code point isn’t a valid Unicode character.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.6, 2.7, 2.8, 2.9</p></li><li><p><code>true</code> for language levels: 2.10</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.6, 2.7, 2.8, 2.9, 2.10</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.telemetry.bufferSize</code></p></td><td><div><div><p>Determines the size in bytes of the telemetry event buffer.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>1048576</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.telemetry.enabled</code></p></td><td><div><div><p>Enables DataWeave telemetry service.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.telemetry.memory</code></p></td><td><div><div><p>When set to <code>true</code>, the telemetry service collects memory usage statistics.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.telemetry.sync</code></p></td><td><div><div><p>When set to <code>true</code>, telemetry events are published synchronously.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.track.cursor.close</code></p></td><td><div><div><p>When set to <code>true</code>, tracks the stack trace from which the {CursorProvider#close()} method is called. Use this property for troubleshooting, for example, if {CursorProvider#openCursor()} is called on a cursor that is already closed.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.valueSelector.selectsAlwaysFirst</code></p></td><td><div><div><p>When set to <code>true</code>, returns the first occurrence of an element (even if the element appears more than once). Enabling this behavior degrades performance.</p></div><div><p>This example illustrates the behavior that is controlled by this property. (Assume that the DataWeave script acts on the XML input.)</p></div><div><div>XML input:</div><div><pre><code data-lang="xml">&lt;root&gt;
  &lt;users&gt;
     &lt;user&gt;
       &lt;lname&gt;chibana&lt;/lname&gt;
       &lt;name&gt;Shoki&lt;/name&gt;
     &lt;/user&gt;
     &lt;user&gt;
       &lt;name&gt;Shoki&lt;/name&gt;
       &lt;name&gt;Tomo&lt;/name&gt;
     &lt;/user&gt;
  &lt;/users&gt;
&lt;/root&gt;</code></pre></div></div><div><div>DataWeave script:</div><div><pre><code data-lang="xml">%dw 2.0
output application/json
---
{
    shokis: payload.root.users.*user map $.name
}</code></pre></div></div><div><ul><li><p>If <code>com.mulesoft.dw.valueSelector.selectsAlwaysFirst</code> is set to <code>true</code>, the script returns the following output:</p><div><div><pre><code data-lang="json">{
  "shokis": [
    "Shoki",
    "Shoki"
  ]
}</code></pre></div></div></li><li><p>If <code>com.mulesoft.dw.valueSelector.selectsAlwaysFirst</code> is set to <code>false</code>, the script returns the following output:</p><div><div><pre><code data-lang="json">{
  "shokis": [
    "Shoki",
    "Tomo"
  ]
}</code></pre></div></div></li><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.3, 2.4, 2.5</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.3, 2.4, 2.5</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.workingdirectory.base</code></p></td><td><div><div><p>Specifies the base directory in which temporary files are written.</p></div><div><ul><li><p>Type: <code>String</code></p></li><li><p>Default: <code>java.io.tmpdir (system property value)</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.workingdirectory.delete_sync</code></p></td><td><div><div><p>File deletion occurs synchronously when this property is set to <code>true</code>.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.workingdirectory.max_output_buffer_size</code></p></td><td><div><div><p>Specifies the maximum size of a file written in bytes.</p></div><div><ul><li><p>Type: <code>Long</code></p></li><li><p>Default: <code>-1</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.workingdirectory.tracking</code></p></td><td><div><div><p>Each script generates temporary files in their own directory when this property is set to <code>true</code>.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.xml.supportDTD</code></p></td><td><div><div><p>Controls whether DTD handling is enabled or disabled. When this property is set to <code>false</code>, DataWeave skips processing of both internal and external subsets.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.xml_reader.allowIndexedLatin1</code></p></td><td><div><div><p>When set to <code>true</code>, DataWeave lets you use the indexed reader for Latin1(ISO-8859-1) encoding. Use this for backward compatibility only, as Latin1 isn’t fully supported.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>true</code> for language levels: 2.6, 2.7, 2.8, 2.9</p></li><li><p><code>false</code> for language levels: 2.10, 2.11</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.6, 2.7, 2.8, 2.9, 2.10, 2.11</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.xml_reader.honourMixedContentStructure</code></p></td><td><div><div><p>When this property is set to <code>true</code>, DataWeave retains a mixed-content structure instead of grouping text with mixed content into a single text field.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.4</p></li><li><p><code>true</code> for language levels: 2.5</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.4, 2.5</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.xml_reader.honourXmlDeclarationEncoding</code></p></td><td><div><div><p>When this property is set to <code>true</code>, DataWeave uses the encoding declared in the XML if present.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.4, 2.5</p></li><li><p><code>true</code> for language levels: 2.6, 2.7, 2.8, 2.9, 2.10, 2.11</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.4, 2.5, 2.6, 2.7, 2.8, 2.9, 2.10, 2.11</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.xml_writer.declareXmlNamespace</code></p></td><td><div><div><p>When this property is set to <code>false</code>, DataWeave doesn’t declare the <code>xml</code> implicit namespace.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>true</code> for language levels: 2.4, 2.5</p></li><li><p><code>false</code> for language levels: 2.6</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.4, 2.5, 2.6</p></div></div></td></tr><tr><td><p><code>mule.dw.enable_vars_materialization_pass</code></p></td><td><div><div><p>Enables a pass of the DataWeave compiler that extracts usages of values in Mule <code>vars</code> special variable into variable declarations. This forces materialization of values inside <code>vars</code>, and is useful for fixing issues where repeated reads of <code>vars</code> yield a <code>null</code> value.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.6, 2.7, 2.8, 2.9, 2.10</p></li><li><p><code>true</code> for language levels: 2.11</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.6, 2.7, 2.8, 2.9, 2.10, 2.11</p></div></div></td></tr><tr><td><p><code>mule.dw.java_module_loader_deterministic_functions_ordering</code></p></td><td><div><div><p>When set to <code>true</code>, the JavaModuleLoader loads the methods for Java Classes in deterministic order. DataWeave considers the method name, the parameters count, and finally, the parameter type name.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>true</code> for language levels: 2.5, 2.6</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.5, 2.6</p></div></div></td></tr><tr><td><p><code>mule.dw.remove_shadowed_implicit_inputs</code></p></td><td><div><div><p>If a variable with the same name is declared at the root level and this property is set to <code>true</code>, DataWeave removes implicit inputs.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>true</code></p></li></ul></div></div></td></tr></tbody></table>

<!-- document id=582d667c13603cf794b07eeacf1eb1f475aebeea48899a43a4deab32686b0752 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-system-properties.md -->

---
product: DataWeave
version: 2.12
---

# DataWeave System Properties

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave supports several system properties. To use these properties in application development and
deployments, see [System Properties](https://docs.mulesoft.com/mule-runtime/latest/mule-app-properties-system).

Whether a property in this reference applies depends on the DataWeave language level configured for
the application, not only on the Mule runtime version where the application runs. For how language
level is determined in Mule applications (including its relationship to `minMuleVersion`), see
[Versioning Behavior in DataWeave](https://docs.mulesoft.com/dataweave/2.12/dataweave-versioning-behavior).

If a property is listed as available only for specific language levels, it applies only when the
application uses one of those levels. In newer DataWeave versions, some of these properties remain
supported only for backward compatibility when the application targets a compatible earlier language
level, even if it runs on a newer Mule runtime.

<table><colgroup><col> <col></colgroup><thead><tr><th>Property</th><th>Description</th></tr></thead><tbody><tr><td><p><code>com.mulesoft.dw.base64ChunksEnabled</code></p></td><td><div><div><p>When set to <code>true</code>, <code>dw::core::Binaries::fromBase64</code> and <code>dw::core::Binaries::toBase64</code> functions don’t load the entire function argument (<code>String</code> or <code>Binary</code>) into memory. DataWeave loads the function argument (<code>String</code> or <code>Binary</code>) by chunk. This feature prevents an out-of-memory error.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>true</code> for language levels: 2.11, 2.12</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.11, 2.12</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.buffered_char_sequence.enabled</code></p></td><td><div><div><p>Controls whether an internal <code>BufferedCharSequence</code> improvement is enabled or disabled. When this property is set to <code>true</code>, DataWeave does not load large fields (greater than 1.5M) into memory. DataWeave reads these fields by chunk. This feature reduces performance to prevent an out-of-memory error.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>true</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.buffersize</code></p></td><td><div><div><p>Sets the size (in bytes) of in-memory input and output buffers that DataWeave uses to retain processed inputs and outputs. DataWeave stores payloads that exceed this size in temporary files <code>dw-buffer-index-${count}.tmp</code> and <code>dw-buffer-output-${count}.tmp</code>. See <a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-memory-management">DataWeave Memory Management</a>.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>8192</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.charbuffersize</code></p></td><td><div><div><p>Determines the size (in bytes) of the buffer used by the writer.</p></div><div><ul><li><p>Type: <code>Number</code> (in bytes)</p></li><li><p>Default: <code>4096</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.coercionexception.verbose</code></p></td><td><div><div><p>By default, adds to coercion exceptions more information about data that fails to coerce. When this property is set to <code>false</code>, DataWeave does not display the additional metadata.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>true</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.cpulimit.watchdog</code></p></td><td><div><div><p>Monitors and limits script execution time when set to <code>true</code>.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>true</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.csv_reader.indexed.retainStringValueInMemory</code></p></td><td><div><div><p>When set to <code>false</code>, this property prevents DataWeave indexed readers for CSV from keeping string value references in memory. While this can reduce performance, it helps prevent out-of-memory errors.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>true</code> for language levels: 2.6, 2.7, 2.8, 2.9</p></li><li><p><code>false</code> for language levels: 2.10, 2.11, 2.12</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.6, 2.7, 2.8, 2.9, 2.10, 2.11, 2.12</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.csv_writer.alwaysEscapeQuotesInCSV</code></p></td><td><div><div><p>When set to <code>true</code>, DataWeave escapes quotes in CSV.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.4</p></li><li><p><code>true</code> for language levels: 2.5</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.4, 2.5</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.date_minus_back_compatibility</code></p></td><td><div><div><p>Restores the <a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-add-and-subtract-time">Add and Subtract Time</a> behaviors that changed in 2.3.0 when this property is set to <code>true</code>.</p></div><div><p>For example, consider the following DataWeave script:</p></div><div><div><pre><code data-lang="dataweave">%dw 2.0
output application/dw
---
|2019-10-01| - |2018-09-23|</code></pre></div></div><div><ul><li><p>In DataWeave 2.3.0, the expression returns <code>PT8952H</code>.</p></li><li><p>In DataWeave 2.2.0, the expression returns <code>P1Y8D</code>.</p></li><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.3, 2.4, 2.5</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.3, 2.4, 2.5</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.decode_binaries_with_writer_encoding</code></p></td><td><div><div><p>When set to <code>true</code>, binary values in JSON are written using JsonWriter encoding. Otherwise, the property uses either the encoding defined in the value schema or the default one.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.defaultOperator.disableExceptionHandling</code></p></td><td><div><div><p>When set to <code>true</code>, DataWeave disables the <code>default</code> operator that catches runtime exceptions. Enabling the <code>default</code> operator doesn’t return the <code>default value</code> when a runtime exception occurs. When set to <code>false</code>, the <code>default</code> operator catches the runtime exceptions and returns the <code>default value</code>.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>true</code> for language levels: 2.5, 2.6, 2.7, 2.8, 2.9</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.5, 2.6, 2.7, 2.8, 2.9</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.directbuffer.disable</code></p></td><td><div><div><p>Controls whether DataWeave uses off-heap memory (the default) or heap memory. DataWeave uses off-heap memory for internal buffering, which can cause issues on systems that have only a small amount of memory. See <a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-memory-management">DataWeave Memory Management</a>.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.dump_files</code></p></td><td><div><div><p><em>Experimental:</em> Dumps the input context and the failing script into a folder when this property is set to <code>true</code>. This behavior enables you to track the failing script and the data that makes the script fail, which is particularly useful for verifying that the received input data is valid. Incorrect scripts often fail when an upstream component generates invalid data.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div><div><p><code>com.mulesoft.dw.dump_files</code> is an <em>experimental feature</em> that is subject to change or removal from future versions of DataWeave. See <a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-troubleshoot">Troubleshooting a Failing DataWeave Script</a>.</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.dump_folder</code></p></td><td><div><div><p><em>Experimental:</em> Specifies the path in which to dump files when <code>com.mulesoft.dw.dump_files</code> is set to <code>true</code>.</p></div><div><ul><li><p>Type: <code>String</code></p></li><li><p>Default: <code>java.io.tempdir (system property value)</code></p></li></ul></div><div><p><code>com.mulesoft.dw.dump_folder</code> is an <em>experimental feature</em> that is subject to change or removal from future versions of DataWeave. See <a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-troubleshoot">Troubleshooting a Failing DataWeave Script</a>.</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.dumper_fill_stacktrace</code></p></td><td><div><div><p><em>Experimental:</em> Adds the StackTrace for dumper exceptions when <code>com.mulesoft.dw.dump_files</code> is set to <code>true</code>.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div><div><p><code>com.mulesoft.dw.dumper_fill_stacktrace</code> is an <em>experimental feature</em> that is subject to change or removal from future versions of DataWeave. See <a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-troubleshoot">Troubleshooting a Failing DataWeave Script</a>.</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.error_value_length</code></p></td><td><div><div><p>Sets the maximum length of exception messages to display to the user. The message is truncated to the maximum length. This setting is useful for avoiding long exception messages.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>80</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.indexsize</code></p></td><td><div><div><p>Sets the maximum size (in bytes) of the page in memory that indexed readers use.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>1572864</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.java.disable_set_accessible</code></p></td><td><div><div><p>When set to <code>true</code>, the JavaModuleLoader doesn’t change the accessible flag for fields or methods used via reflection. The default value evaluates the current JDK version used and the language level. The value is <code>true</code> when the used JDK is 17 or later and the language version is 2.6 or later.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.5</p></li><li><p><code>true</code> for language levels: 2.6, 2.7, 2.8, 2.9</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.5, 2.6, 2.7, 2.8, 2.9</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.java.enabled_class_definition_lookup</code></p></td><td><div><div><p>When set to <code>true</code>, the JavaModuleLoader honors the public interface definition of the given bean instance to access properties via reflection. The default value evaluates the current JDK version used and the language level. The value is <code>true</code> when the used JDK is 17+ and the language version is greater than 2.10. If set to <code>false</code>, the JavaModuleLoader uses the specific bean’s class definition to access properties via reflection, which could end in accessibility issues.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.5, 2.6, 2.7, 2.8, 2.9</p></li><li><p><code>true</code> for language levels: 2.10, 2.11</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.5, 2.6, 2.7, 2.8, 2.9, 2.10, 2.11</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.java.honour_bean_definition_accessor</code></p></td><td><div><div><p>When set to <code>true</code>, the JavaModuleLoader honors the bean definition by using the getter and setter methods to access properties via reflection at object value selectors. If set to <code>false</code>, the JavaModuleLoader uses the getter and setter methods to access existing properties or the property uses the field accessor as default.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.8</p></li><li><p><code>true</code> for language levels: 2.9, 2.10, 2.11, 2.12</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.8, 2.9, 2.10, 2.11, 2.12</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.java.output_types_as_string</code></p></td><td><div><div><p>When set to <code>true</code>, DataWeave scripts with Java output <code>mimetype</code> return the string representation of that type. If set to <code>false</code>, the scripts return a Java class constructed from the corresponding DataWeave type class.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>true</code> for language levels: 2.0, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7, 2.8, 2.9, 2.10, 2.11, 2.12</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.0, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7, 2.8, 2.9, 2.10, 2.11, 2.12</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.java.per_app_java_bean_cache</code></p></td><td><div><div><p>When set to <code>true</code>, the <code>JavaBeanHelper</code> uses a per-app cache owned by <code>WeaveExpressionLanguage</code> instead of the global singleton. This eliminates the weak-value eviction events that can orphan Caffeine’s <code>evictionLock</code> under stack exhaustion.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>true</code> for language levels: 2.12</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.12</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.java.stacktrace</code></p></td><td><div><div><p>Specifies the depth of the Java stack trace.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>6</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.javaSqlDateToDate</code></p></td><td><div><div><p>When set, <code>java.sql.Date</code> maps to the DataWeave <code>Date</code> type. If <code>false</code>, it maps to <code>DateTime</code>.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.4</p></li><li><p><code>true</code> for language levels: 2.5</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.4, 2.5</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.legacySizeOfNumber</code></p></td><td><div><div><p>When set to <code>true</code>, DataWeave returns <code>1</code> when calling <code>sizeOf()</code> function for any <code>Number</code> value.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.6, 2.7, 2.8, 2.9, 2.10</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.6, 2.7, 2.8, 2.9, 2.10</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.max_memory_allocation</code></p></td><td><div><div><p>Sets the size (in bytes) of each slot in the off-heap memory pool. DataWeave stores payloads that exceed this size in temporary files <code>dw-buffer-input-${count}.tmp</code> and <code>dw-buffer-output-${count}.tmp</code>.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>1572864</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.memory_pool_size</code></p></td><td><div><div><p>Sets the number of slots in the memory pool. DataWeave buffers use off-heap memory from a pool, up to a defined size (<code>com.mulesoft.dw.memory_pool_size</code> * <code>com.mulesoft.dw.max_memory_allocation</code>). DataWeave allocates the remainder using heap memory. See <a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-memory-management">DataWeave Memory Management</a>.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>60</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.messageLogging.debounceDuration</code></p></td><td><div><div><p>Sets the number of milliseconds to wait before logging the same message again when using <code>MessageLoggingService.logXXXXDebounce</code> methods.</p></div><div><ul><li><p>Type: <code>Long</code></p></li><li><p>Default: <code>3000</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.multipart.defaultContentType</code></p></td><td><div><div><p>Sets the default Content-Type to use on parts of the <code>multipart/*</code> format when a <code>Content-Type</code> is not specified. See also, the multipart reader property <a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-formats-multipart#properties">defaultContentType</a>. <em>Introduced in DataWeave 2.3 (2.3.0-20210720) for the August 2021 release of Mule 4.3.0-20210719.</em></p></div><div><ul><li><p>Type: <code>String</code></p></li><li><p>Default: <code>application/octet-stream</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.scheduler.size</code></p></td><td><div><div><p>Specifies the size of DataWeave scheduler thread pool.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>100</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.stableOrderBy</code></p></td><td><div><div><p>When set to <code>true</code>, DataWeave throws <code>InvalidComparisonException</code> if the <code>orderBy</code> function attempts to compare values of different types. If set to <code>false</code>, coercions are used when comparing values of different types, which can cause the resulting order to be different from the expected one as in: .DataWeave script:</p></div><div><div><pre><code data-lang="xml">%dw 2.4
output application/json
---
[5, 1, "10"] orderBy $</code></pre></div></div><div><ul><li><p>If <code>com.mulesoft.dw.stableOrderBy</code> is set to <code>false</code>, the script returns the following output: <code>[1, "10", 5]</code></p></li><li><p>If <code>com.mulesoft.dw.stableOrderBy</code> is set to <code>true</code>, the script throws <code>InvalidComparisonException</code>.</p></li><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.9</p></li><li><p><code>true</code> for language levels: 2.10, 2.11, 2.12</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.9, 2.10, 2.11, 2.12</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.stacksize</code></p></td><td><div><div><p>Sets the maximum size of the stack. When a function recurses too deeply, DataWeave throws an error, such as Stack Overflow. The maximum size limit is 256.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>256</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.stripTrailingZeroes</code></p></td><td><div><div><p>When set to <code>false</code>, DataWeave restores the behavior of preserving trailing zeroes for some formats (such as DataWeave, JSON, and YAML) present in 2.4.0. Starting with 2.5.0, trailing zeroes are removed by default. .DataWeave script:</p></div><div><div><pre><code data-lang="xml">%dw 2.4
output application/json
---
1.00</code></pre></div></div><div><ul><li><p>If <code>com.mulesoft.dw.stripTrailingZeroes</code> is set to <code>false</code>, the script returns the following output: <code>1.00</code></p></li><li><p>If <code>com.mulesoft.dw.stripTrailingZeroes</code> is set to <code>true</code>, the script returns the following output: <code>1</code></p></li><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>true</code> for language levels: 2.5, 2.6, 2.7, 2.8, 2.9</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.5, 2.6, 2.7, 2.8, 2.9</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.surrogateCharCodeSupport</code></p></td><td><div><div><p>When set to <code>true</code>, the <code>fromCharCode</code> function supports surrogate characters and throws an exception if the code point isn’t a valid Unicode character.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.6, 2.7, 2.8, 2.9</p></li><li><p><code>true</code> for language levels: 2.10</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.6, 2.7, 2.8, 2.9, 2.10</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.telemetry.bufferSize</code></p></td><td><div><div><p>Determines the size in bytes of the telemetry event buffer.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>1048576</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.telemetry.enabled</code></p></td><td><div><div><p>Enables DataWeave telemetry service.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.telemetry.memory</code></p></td><td><div><div><p>When set to <code>true</code>, the telemetry service collects memory usage statistics.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.telemetry.sync</code></p></td><td><div><div><p>When set to <code>true</code>, telemetry events are published synchronously.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.track.cursor.close</code></p></td><td><div><div><p>When set to <code>true</code>, tracks the stack trace from which the {CursorProvider#close()} method is called. Use this property for troubleshooting, for example, if {CursorProvider#openCursor()} is called on a cursor that is already closed.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.valueSelector.selectsAlwaysFirst</code></p></td><td><div><div><p>When set to <code>true</code>, returns the first occurrence of an element (even if the element appears more than once). Enabling this behavior degrades performance.</p></div><div><p>This example illustrates the behavior that is controlled by this property. (Assume that the DataWeave script acts on the XML input.)</p></div><div><div>XML input:</div><div><pre><code data-lang="xml">&lt;root&gt;
  &lt;users&gt;
     &lt;user&gt;
       &lt;lname&gt;chibana&lt;/lname&gt;
       &lt;name&gt;Shoki&lt;/name&gt;
     &lt;/user&gt;
     &lt;user&gt;
       &lt;name&gt;Shoki&lt;/name&gt;
       &lt;name&gt;Tomo&lt;/name&gt;
     &lt;/user&gt;
  &lt;/users&gt;
&lt;/root&gt;</code></pre></div></div><div><div>DataWeave script:</div><div><pre><code data-lang="xml">%dw 2.0
output application/json
---
{
    shokis: payload.root.users.*user map $.name
}</code></pre></div></div><div><ul><li><p>If <code>com.mulesoft.dw.valueSelector.selectsAlwaysFirst</code> is set to <code>true</code>, the script returns the following output:</p><div><div><pre><code data-lang="json">{
  "shokis": [
    "Shoki",
    "Shoki"
  ]
}</code></pre></div></div></li><li><p>If <code>com.mulesoft.dw.valueSelector.selectsAlwaysFirst</code> is set to <code>false</code>, the script returns the following output:</p><div><div><pre><code data-lang="json">{
  "shokis": [
    "Shoki",
    "Tomo"
  ]
}</code></pre></div></div></li><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.3, 2.4, 2.5</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.3, 2.4, 2.5</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.workingdirectory.base</code></p></td><td><div><div><p>Specifies the base directory in which temporary files are written.</p></div><div><ul><li><p>Type: <code>String</code></p></li><li><p>Default: <code>java.io.tmpdir (system property value)</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.workingdirectory.delete_sync</code></p></td><td><div><div><p>File deletion occurs synchronously when this property is set to <code>true</code>.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.workingdirectory.max_output_buffer_size</code></p></td><td><div><div><p>Specifies the maximum size of a file written in bytes.</p></div><div><ul><li><p>Type: <code>Long</code></p></li><li><p>Default: <code>-1</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.workingdirectory.tracking</code></p></td><td><div><div><p>Each script generates temporary files in their own directory when this property is set to <code>true</code>.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.xml.supportDTD</code></p></td><td><div><div><p>Controls whether DTD handling is enabled or disabled. When this property is set to <code>false</code>, DataWeave skips processing of both internal and external subsets.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.xml_reader.allowIndexedLatin1</code></p></td><td><div><div><p>When set to <code>true</code>, DataWeave lets you use the indexed reader for Latin1(ISO-8859-1) encoding. Use this for backward compatibility only, as Latin1 isn’t fully supported.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>true</code> for language levels: 2.6, 2.7, 2.8, 2.9</p></li><li><p><code>false</code> for language levels: 2.10, 2.11, 2.12</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.6, 2.7, 2.8, 2.9, 2.10, 2.11, 2.12</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.xml_reader.honourMixedContentStructure</code></p></td><td><div><div><p>When this property is set to <code>true</code>, DataWeave retains a mixed-content structure instead of grouping text with mixed content into a single text field.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.4</p></li><li><p><code>true</code> for language levels: 2.5</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.4, 2.5</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.xml_reader.honourXmlDeclarationEncoding</code></p></td><td><div><div><p>When this property is set to <code>true</code>, DataWeave uses the encoding declared in the XML if present.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.4, 2.5</p></li><li><p><code>true</code> for language levels: 2.6, 2.7, 2.8, 2.9, 2.10, 2.11, 2.12</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.4, 2.5, 2.6, 2.7, 2.8, 2.9, 2.10, 2.11, 2.12</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.xml_writer.declareXmlNamespace</code></p></td><td><div><div><p>When this property is set to <code>false</code>, DataWeave doesn’t declare the <code>xml</code> implicit namespace.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>true</code> for language levels: 2.4, 2.5</p></li><li><p><code>false</code> for language levels: 2.6</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.4, 2.5, 2.6</p></div></div></td></tr><tr><td><p><code>mule.dw.enable_vars_materialization_pass</code></p></td><td><div><div><p>Enables a pass of the DataWeave compiler that extracts usages of values in Mule <code>vars</code> special variable into variable declarations. This forces materialization of values inside <code>vars</code>, and is useful for fixing issues where repeated reads of <code>vars</code> yield a <code>null</code> value.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.6, 2.7, 2.8, 2.9, 2.10</p></li><li><p><code>true</code> for language levels: 2.11, 2.12</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.6, 2.7, 2.8, 2.9, 2.10, 2.11, 2.12</p></div></div></td></tr><tr><td><p><code>mule.dw.java_module_loader_deterministic_functions_ordering</code></p></td><td><div><div><p>When set to <code>true</code>, the JavaModuleLoader loads the methods for Java Classes in deterministic order. DataWeave considers the method name, the parameters count, and finally, the parameter type name.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>true</code> for language levels: 2.5, 2.6</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.5, 2.6</p></div></div></td></tr><tr><td><p><code>mule.dw.remove_shadowed_implicit_inputs</code></p></td><td><div><div><p>If a variable with the same name is declared at the root level and this property is set to <code>true</code>, DataWeave removes implicit inputs.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>true</code></p></li></ul></div></div></td></tr></tbody></table>

<!-- document id=7de74c998fbdf3134187a00d2eb59672d121e102264483b13e2bff7403cff047 url=/mulesoft/current/en-us/dataweave/2.3/dataweave-system-properties.md -->

---
product: DataWeave
version: 2.3
---

# DataWeave System Properties

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave supports several system properties. To use these properties in application development and
deployments, see [System Properties](https://docs.mulesoft.com/mule-runtime/4.3/mule-app-properties-system).

<table><colgroup><col> <col></colgroup><thead><tr><th>Property</th><th>Description</th></tr></thead><tbody><tr><td><p><code>com.mulesoft.dw.buffer.memory.monitoring</code></p></td><td><div><div><p><em>Experimental:</em> When set to <code>true</code>, logs a message each time a slot from the memory pool is taken or released. The behavior is useful for troubleshooting. <code>com.mulesoft.dw.buffer.memory.monitoring</code> supports an <em>experimental feature</em> that is subject to change or removal from future versions of DataWeave.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.buffersize</code></p></td><td><div><div><p>Sets the size (in bytes) of in-memory input and output buffers that DataWeave uses to retain processed inputs and outputs. DataWeave stores payloads that exceed this size in temporary files <code>dw-buffer-index-${count}.tmp</code> and <code>dw-buffer-output-${count}.tmp</code>. See <a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-memory-management">DataWeave Memory Management</a>.</p></div><div><ul><li><p>Type: <code>Number</code> (in bytes)</p></li><li><p>Default: <code>8192</code> bytes (8 KB)</p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.coercionexception.verbose</code></p></td><td><div><div><p>By default, adds to coercion exceptions more information about data that fails to coerce. When this property is set to <code>false</code>, DataWeave does not display the additional metadata.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>true</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.date_minus_back_compatibility</code></p></td><td><div><div><p>Restores the <a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-add-and-subtract-time">Add and Subtract Time</a> behaviors that changed in 2.3.0 when this property is set to <code>true</code>.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div><div><p>For example, consider the following DataWeave script:</p></div><div><div><pre><code data-lang="dataweave">%dw 2.0
output application/dw
---
|2019-10-01| - |2018-09-23|</code></pre></div></div><div><ul><li><p>In DataWeave 2.3.0, the expression returns <code>PT8952H</code>.</p></li><li><p>In DataWeave 2.2.0, the expression returns <code>P1Y8D</code>.</p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.directbuffer.disable</code></p></td><td><div><div><p>Controls whether DataWeave uses off-heap memory (the default) or heap memory. DataWeave uses off-heap memory for internal buffering, which can cause issues on systems that have only a small amount of memory. See <a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-memory-management">DataWeave Memory Management</a>.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.dump_files</code></p></td><td><div><div><p><em>Experimental:</em> Dumps the input context and the failing script into a folder when this property is set to <code>true</code>. This behavior enables you to track the failing script and the data that makes the script fail, which is particularly useful for verifying that the received input data is valid. Incorrect scripts often fail when an upstream component generates invalid data.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div><div><p><code>com.mulesoft.dw.dump_files</code> is an <em>experimental feature</em> that is subject to change or removal from future versions of DataWeave. See <a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-troubleshoot">Troubleshooting a Failing DataWeave Script</a>.</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.dump_folder</code></p></td><td><div><div><p><em>Experimental:</em> Specifies the path in which to dump files when <code>com.mulesoft.dw.dump_files</code> is set to <code>true</code>.</p></div><div><ul><li><p>Type: <code>String</code></p></li><li><p>Default: <code>java.io.tmpdir</code> (system property value)</p></li></ul></div><div><p><code>com.mulesoft.dw.dump_folder</code> is an <em>experimental feature</em> that is subject to change or removal from future versions of DataWeave. See <a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-troubleshoot">Troubleshooting a Failing DataWeave Script</a>.</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.error_value_length</code></p></td><td><div><div><p>Sets the maximum length of exception messages to display to the user. The message is truncated to the maximum length. This setting is useful for avoiding long exception messages.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>80</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.indexsize</code></p></td><td><div><div><p>Sets the maximum size (in bytes) of the page in memory that indexed readers use.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>1572864</code> (1.5 MB)</p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.max_memory_allocation</code></p></td><td><div><div><p>Sets the size (in bytes) of each slot in the off-heap memory pool.</p></div><div><ul><li><p>Type: <code>Number</code> (in bytes)</p></li><li><p>Default: <code>1572864</code> (1.5 MB)</p></li></ul></div><div><p>See <a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-memory-management">DataWeave Memory Management</a>.</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.memory_pool_size</code></p></td><td><div><div><p>Sets the number of slots in the memory pool. DataWeave buffers use off-heap memory from a pool, up to a defined size (<code>com.mulesoft.dw.memory_pool_size</code> * <code>com.mulesoft.dw.max_memory_allocation</code>). DataWeave allocates the remainder using heap memory. See <a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-memory-management">DataWeave Memory Management</a>.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>60</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.multipart.defaultContentType</code></p></td><td><div><div><p>Sets the default Content-Type to use on parts of the <code>multipart/*</code> format when a <code>Content-Type</code> is not specified. See also, the multipart reader property <a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-formats-multipart#properties">defaultContentType</a>. <em>Introduced in DataWeave 2.3 (2.3.0-20210720) for the August 2021 release of Mule 4.3.0-20210719.</em></p></div><div><ul><li><p>Type: <code>String</code></p></li><li><p>Default: <code>application/octet-stream</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.valueSelector.selectsAlwaysFirst</code></p></td><td><div><div><p>When set to set to <code>true</code>, returns the first occurrence of an element (even if the element appears more than once). Enabling this behavior degrades performance.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div><div><p>The following example illustrates the behavior that is controlled by this property. (Assume that the DataWeave script acts on the XML input.)</p></div><div><div>XML input:</div><div><pre><code data-lang="xml">&lt;root&gt;
  &lt;users&gt;
     &lt;user&gt;
       &lt;lname&gt;chibana&lt;/lname&gt;
       &lt;name&gt;Shoki&lt;/name&gt;
     &lt;/user&gt;
     &lt;user&gt;
       &lt;name&gt;Shoki&lt;/name&gt;
       &lt;name&gt;Tomo&lt;/name&gt;
     &lt;/user&gt;
  &lt;/users&gt;
&lt;/root&gt;</code></pre></div></div><div><div>DataWeave script:</div><div><pre><code data-lang="xml">%dw 2.0
output application/json
---
{
    shokis: payload.root.users.*user map $.name
}</code></pre></div></div><div><ul><li><p>If <code>com.mulesoft.dw.valueSelector.selectsAlwaysFirst</code> is set to <code>true</code>, the script returns the following output:</p><div><div><pre><code data-lang="json">{
  "shokis": [
    "Shoki",
    "Shoki"
  ]
}</code></pre></div></div></li><li><p>If <code>com.mulesoft.dw.valueSelector.selectsAlwaysFirst</code> is set to <code>false</code>, the script returns the following output:</p><div><div><pre><code data-lang="json">{
  "shokis": [
    "Shoki",
    "Tomo"
  ]
}</code></pre></div></div></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.stacksize</code></p></td><td><div><div><p>Sets the maximum size of the stack. When a function recurses too deeply, DataWeave throws an error, such as <code>Stack Overflow. Max stack is 256.</code></p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>256</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.xml.supportDTD</code></p></td><td><div><div><p>Controls whether DTD handling is enabled or disabled. When this property is set to <code>false</code>, DataWeaves skips processing of both internal and external subsets. Note that the default for this property changed from <code>true</code> to <code>false</code> in Mule version 4.3.0-20210427, which includes the May, 2021 patch of DataWeave version 2.3.0.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.track.cursor.close</code></p></td><td><div><div><p>When set to <code>true</code>, tracks the stack trace from which the <code>CursorProvider#close()</code> method is called. Use this property for troubleshooting, for example, if <code>CursorProvider#openCursor()</code> is called on a cursor that is already closed.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.verbose</code></p></td><td><div><div><p>Displays filtered stack traces when this property is set to <code>true</code>. Does not display stack traces when set to <code>false</code>.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr></tbody></table>

<!-- document id=5fcfd52e6da3ebfa8b371b917938ce88f36c0628e01ea84c73034ae88253aced url=/mulesoft/current/en-us/dataweave/2.4/dataweave-system-properties.md -->

---
product: DataWeave
version: 2.4
---

# DataWeave System Properties

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave supports several system properties. To use these properties in application development and
deployments, see [System Properties](https://docs.mulesoft.com/mule-runtime/latest/mule-app-properties-system).

<table><colgroup><col> <col></colgroup><thead><tr><th>Property</th><th>Description</th></tr></thead><tbody><tr><td><p><code>com.mulesoft.dw.buffered_char_sequence.enabled</code></p></td><td><div><div><p>Controls whether an internal <code>BufferedCharSequence</code> improvement is enabled or disabled. When this property is set to <code>true</code>, DataWeave avoids loading large fields (greater than 1.5M) into memory. These fields are read in chunks. This feature reduces performance to prevent an out-of-memory error.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>true</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.buffersize</code></p></td><td><div><div><p>Sets the size (in bytes) of in-memory input and output buffers that DataWeave uses to retain processed inputs and outputs. DataWeave stores payloads that exceed this size in temporary files <code>dw-buffer-index-${count}.tmp</code> and <code>dw-buffer-output-${count}.tmp</code>. See <a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-memory-management">DataWeave Memory Management</a>.</p></div><div><ul><li><p>Type: <code>Number</code> (in bytes)</p></li><li><p>Default: <code>8192</code> bytes (8 KB)</p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.coercionexception.verbose</code></p></td><td><div><div><p>By default, adds to coercion exceptions more information about data that fails to coerce. When this property is set to <code>false</code>, DataWeave does not display the additional metadata.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>true</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.date_minus_back_compatibility</code></p></td><td><div><div><p>Restores the <a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-add-and-subtract-time">Add and Subtract Time</a> behaviors that changed in 2.3.0 when this property is set to <code>true</code>.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div><div><p>For example, consider the following DataWeave script:</p></div><div><div><pre><code data-lang="dataweave">%dw 2.0
output application/dw
---
|2019-10-01| - |2018-09-23|</code></pre></div></div><div><ul><li><p>In DataWeave 2.3.0, the expression returns <code>PT8952H</code>.</p></li><li><p>In DataWeave 2.2.0, the expression returns <code>P1Y8D</code>.</p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.directbuffer.disable</code></p></td><td><div><div><p>Controls whether DataWeave uses off-heap memory (the default) or heap memory. DataWeave uses off-heap memory for internal buffering, which can cause issues on systems that have only a small amount of memory. See <a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-memory-management">DataWeave Memory Management</a>.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.dump_files</code></p></td><td><div><div><p><em>Experimental:</em> Dumps the input context and the failing script into a folder when this property is set to <code>true</code>. This behavior enables you to track the failing script and the data that makes the script fail, which is particularly useful for verifying that the received input data is valid. Incorrect scripts often fail when an upstream component generates invalid data.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div><div><p><code>com.mulesoft.dw.dump_files</code> is an <em>experimental feature</em> that is subject to change or removal from future versions of DataWeave. See <a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-troubleshoot">Troubleshooting a Failing DataWeave Script</a>.</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.dump_folder</code></p></td><td><div><div><p><em>Experimental:</em> Specifies the path in which to dump files when <code>com.mulesoft.dw.dump_files</code> is set to <code>true</code>.</p></div><div><ul><li><p>Type: <code>String</code></p></li><li><p>Default: <code>java.io.tmpdir</code> (system property value)</p></li></ul></div><div><p><code>com.mulesoft.dw.dump_folder</code> is an <em>experimental feature</em> that is subject to change or removal from future versions of DataWeave. See <a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-troubleshoot">Troubleshooting a Failing DataWeave Script</a>.</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.dumper_fill_stacktrace</code></p></td><td><div><div><p><em>Experimental:</em> Adds the StackTrace for dumper exceptions when <code>com.mulesoft.dw.dump_files</code> is set to <code>true</code>.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div><div><p><code>com.mulesoft.dw.dumper_fill_stacktrace</code> is an <em>experimental feature</em> that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.error_value_length</code></p></td><td><div><div><p>Sets the maximum length of exception messages to display to the user. The message is truncated to the maximum length. This setting is useful for avoiding long exception messages.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>80</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.indexsize</code></p></td><td><div><div><p>Sets the maximum size (in bytes) of the page in memory that indexed readers use.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>1572864</code> (1.5 MB)</p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.max_memory_allocation</code></p></td><td><div><div><p>Sets the size (in bytes) of each slot in the off-heap memory pool.</p></div><div><ul><li><p>Type: <code>Number</code> (in bytes)</p></li><li><p>Default: <code>1572864</code> (1.5 MB)</p></li></ul></div><div><p>See <a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-memory-management">DataWeave Memory Management</a>.</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.memory_pool_size</code></p></td><td><div><div><p>Sets the number of slots in the memory pool. DataWeave buffers use off-heap memory from a pool, up to a defined size (<code>com.mulesoft.dw.memory_pool_size</code> * <code>com.mulesoft.dw.max_memory_allocation</code>). DataWeave allocates the remainder using heap memory. See <a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-memory-management">DataWeave Memory Management</a>.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>60</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.multipart.defaultContentType</code></p></td><td><div><div><p>Sets the default Content-Type to use on parts of the <code>multipart/*</code> format when a <code>Content-Type</code> is not specified. See also, the multipart reader property <a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-formats-multipart#properties">defaultContentType</a>. <em>Introduced in DataWeave 2.3 (2.3.0-20210720) for the August 2021 release of Mule 4.3.0-20210719.</em></p></div><div><ul><li><p>Type: <code>String</code></p></li><li><p>Default: <code>application/octet-stream</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.valueSelector.selectsAlwaysFirst</code></p></td><td><div><div><p>When set to set to <code>true</code>, returns the first occurrence of an element (even if the element appears more than once). Enabling this behavior degrades performance.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div><div><p>The following example illustrates the behavior that is controlled by this property. (Assume that the DataWeave script acts on the XML input.)</p></div><div><div>XML input:</div><div><pre><code data-lang="xml">&lt;root&gt;
  &lt;users&gt;
     &lt;user&gt;
       &lt;lname&gt;chibana&lt;/lname&gt;
       &lt;name&gt;Shoki&lt;/name&gt;
     &lt;/user&gt;
     &lt;user&gt;
       &lt;name&gt;Shoki&lt;/name&gt;
       &lt;name&gt;Tomo&lt;/name&gt;
     &lt;/user&gt;
  &lt;/users&gt;
&lt;/root&gt;</code></pre></div></div><div><div>DataWeave script:</div><div><pre><code data-lang="xml">%dw 2.0
output application/json
---
{
    shokis: payload.root.users.*user map $.name
}</code></pre></div></div><div><ul><li><p>If <code>com.mulesoft.dw.valueSelector.selectsAlwaysFirst</code> is set to <code>true</code>, the script returns the following output:</p><div><div><pre><code data-lang="json">{
  "shokis": [
    "Shoki",
    "Shoki"
  ]
}</code></pre></div></div></li><li><p>If <code>com.mulesoft.dw.valueSelector.selectsAlwaysFirst</code> is set to <code>false</code>, the script returns the following output:</p><div><div><pre><code data-lang="json">{
  "shokis": [
    "Shoki",
    "Tomo"
  ]
}</code></pre></div></div></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.stacksize</code></p></td><td><div><div><p>Sets the maximum size of the stack. When a function recurses too deeply, DataWeave throws an error, such as <code>Stack Overflow. Max stack is 256.</code></p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>256</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.xml.supportDTD</code></p></td><td><div><div><p>Controls whether DTD handling is enabled or disabled. When this property is set to <code>false</code>, DataWeaves skips processing of both internal and external subsets. Note that the default for this property changed from <code>true</code> to <code>false</code> in Mule version 4.3.0-20210427, which includes the May, 2021 patch of DataWeave version 2.3.0.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.track.cursor.close</code></p></td><td><div><div><p>When set to <code>true</code>, tracks the stack trace from which the <code>CursorProvider#close()</code> method is called. Use this property for troubleshooting, for example, if <code>CursorProvider#openCursor()</code> is called on a cursor that is already closed.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.xml_reader.honourMixedContentStructure</code></p></td><td><div><div><p>When this property is set to <code>true</code>, DataWeave retains a mixed-content structure instead of grouping text with mixed content into a single text field.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.charbuffersize</code></p></td><td><div><div><p>Determines the size (in bytes) of the buffer used by the writer.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>4096</code></p></li></ul></div></div></td></tr><tr><td><p><code>mule.weave.script.parser.cache.size</code></p></td><td><div><div><p>Determines the maximum size of compiled scripts that are being cached.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>10000</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.xml_reader.honourXmlDeclarationEncoding</code></p></td><td><div><div><p>When this property is set to <code>true</code>, DataWeave uses the encoding declared in the XML if present.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.4, 2.5</p></li><li><p><code>true</code> for language levels: 2.6, 2.7, 2.8, 2.9 Available for language levels: 2.4, 2.5, 2.6, 2.7, 2.8, 2.9</p></li></ul></div></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.csv_writer.alwaysEscapeQuotesInCSV</code></p></td><td><div><div><p>When set to <code>true</code>, DataWeave escapes quotes in CSV.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.4</p></li><li><p><code>true</code> for language levels: 2.5 Available for language levels: 2.4, 2.5</p></li></ul></div></li></ul></div></div></td></tr></tbody></table>

<!-- document id=12803cfc93e3d11db40406970156208cd8826f2c6ab116e5e526367c79acde2d url=/mulesoft/current/en-us/dataweave/2.6/dataweave-system-properties.md -->

---
product: DataWeave
version: 2.6
---

# DataWeave System Properties

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave supports several system properties. To use these properties in application development and
deployments, see [System Properties](https://docs.mulesoft.com/mule-runtime/latest/mule-app-properties-system).

<table><colgroup><col> <col></colgroup><thead><tr><th>Property</th><th>Description</th></tr></thead><tbody><tr><td><p><code>com.mulesoft.dw.buffered_char_sequence.enabled</code></p></td><td><div><div><p>Controls whether an internal <code>BufferedCharSequence</code> improvement is enabled or disabled. When this property is set to <code>true</code>, DataWeave does not load large fields (greater than 1.5M) into memory. DataWeave reads these fields by chunk. This feature reduces performance to prevent an out-of-memory error.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>true</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.buffersize</code></p></td><td><div><div><p>Sets the size (in bytes) of in-memory input and output buffers that DataWeave uses to retain processed inputs and outputs. DataWeave stores payloads that exceed this size in temporary files <code>dw-buffer-index-${count}.tmp</code> and <code>dw-buffer-output-${count}.tmp</code>. See <a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-memory-management">DataWeave Memory Management</a>.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>8192</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.charbuffersize</code></p></td><td><div><div><p>Determines the size (in bytes) of the buffer used by the writer.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>4096</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.coercionexception.verbose</code></p></td><td><div><div><p>By default, adds to coercion exceptions more information about data that fails to coerce. When this property is set to <code>false</code>, DataWeave does not display the additional metadata.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>true</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.cpulimit.watchdog</code></p></td><td><div><div><p>Monitors and limits script execution time when set to <code>true</code>.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>true</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.date_minus_back_compatibility</code></p></td><td><div><div><p>Restores the <a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-add-and-subtract-time">Add and Subtract Time</a> behaviors that changed in 2.3.0 when this property is set to <code>true</code>.</p></div><div><p>For example, consider the following DataWeave script:</p></div><div><div><pre><code data-lang="dataweave">%dw 2.0
output application/dw
---
|2019-10-01| - |2018-09-23|</code></pre></div></div><div><ul><li><p>In DataWeave 2.3.0, the expression returns <code>PT8952H</code>.</p></li><li><p>In DataWeave 2.2.0, the expression returns <code>P1Y8D</code>.</p></li><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div><div><p>Available for language levels: 2.3, 2.4, 2.5</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.decode_binaries_with_writer_encoding</code></p></td><td><div><div><p>When set to <code>true</code>, binary values in JSON are written using JsonWriter encoding. Otherwise, the property uses either the encoding defined in the value schema or the default one.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.defaultOperator.disableExceptionHandling</code></p></td><td><div><div><p>When set to <code>true</code>, DataWeave disables the <code>default</code> operator that catches runtime exceptions. Enabling the <code>default</code> operator doesn’t return the <code>default value</code> when a runtime exception occurs. When set to <code>false</code>, the <code>default</code> operator catches the runtime exceptions and returns the <code>default value</code>.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>true</code></p></li></ul></div><div><p>Available for language levels: 2.5, 2.6, 2.7, 2.8, 2.9</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.directbuffer.disable</code></p></td><td><div><div><p>Controls whether DataWeave uses off-heap memory (the default) or heap memory. DataWeave uses off-heap memory for internal buffering, which can cause issues on systems that have only a small amount of memory. See <a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-memory-management">DataWeave Memory Management</a>.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.dump_files</code></p></td><td><div><div><p><em>Experimental:</em> Dumps the input context and the failing script into a folder when this property is set to <code>true</code>. This behavior enables you to track the failing script and the data that makes the script fail, which is particularly useful for verifying that the received input data is valid. Incorrect scripts often fail when an upstream component generates invalid data.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code> <code>com.mulesoft.dw.dump_files</code> is an <em>experimental feature</em> that is subject to change or removal from future versions of DataWeave. See <a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-troubleshoot">Troubleshooting a Failing DataWeave Script</a>.</p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.dump_folder</code></p></td><td><div><div><p><em>Experimental:</em> Specifies the path in which to dump files when <code>com.mulesoft.dw.dump_files</code> is set to <code>true</code>.</p></div><div><ul><li><p>Type: <code>String</code></p></li><li><p>Default: <code>java.io.tempdir (system property value)</code> <code>com.mulesoft.dw.dump_folder</code> is an <em>experimental feature</em> that is subject to change or removal from future versions of DataWeave. See <a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-troubleshoot">Troubleshooting a Failing DataWeave Script</a>.</p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.dumper_fill_stacktrace</code></p></td><td><div><div><p><em>Experimental:</em> Adds the StackTrace for dumper exceptions when <code>com.mulesoft.dw.dump_files</code> is set to <code>true</code>.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code> <code>com.mulesoft.dw.dumper_fill_stacktrace</code> is an <em>experimental feature</em> that is subject to change or removal from future versions of DataWeave. See <a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-troubleshoot">Troubleshooting a Failing DataWeave Script</a>.</p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.error_value_length</code></p></td><td><div><div><p>Sets the maximum length of exception messages to display to the user. The message is truncated to the maximum length. This setting is useful for avoiding long exception messages.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>80</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.indexsize</code></p></td><td><div><div><p>Sets the maximum size (in bytes) of the page in memory that indexed readers use.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>1572864</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.java.disable_set_accessible</code></p></td><td><div><div><p>When set to <code>true</code>, the JavaModuleLoader doesn’t change the accessible flag for fields or methods used via reflection. The default value evaluates the current JDK version used and the language level. The value is <code>true</code> when the used JDK is 17 or later and the language version is 2.6 or later.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.5</p></li><li><p><code>true</code> for language levels: 2.6, 2.7, 2.8, 2.9</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.5, 2.6, 2.7, 2.8, 2.9</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.java.enabled_class_definition_lookup</code></p></td><td><div><div><p>When set to <code>true</code>, the JavaModuleLoader honors the public interface definition of the given bean instance to access properties via reflection. The default value evaluates the current JDK version used and the language level. The value is <code>true</code> when the used JDK is 17 or later and the language version is 2.10 or later. If set to <code>false</code>, the JavaModuleLoader uses the specific bean’s class definition to access properties via reflection, which can cause accessibility issues.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.5, 2.6</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.5, 2.6</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.java.stacktrace</code></p></td><td><div><div><p>Specifies the depth of the Java stack trace.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>6</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.javaSqlDateToDate</code></p></td><td><div><div><p>When set, <code>java.sql.Date</code> maps to the DataWeave <code>Date</code> type. If <code>false</code>, it maps to <code>DateTime</code>.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.4</p></li><li><p><code>true</code> for language levels: 2.5</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.4, 2.5</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.legacySizeOfNumber</code></p></td><td><div><div><p>When set to <code>true</code>, DataWeave returns <code>1</code> when calling <code>sizeOf()</code> function for any <code>Number</code> value.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.6, 2.7, 2.8, 2.9 Available for language levels: 2.6, 2.7, 2.8, 2.9</p></li></ul></div></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.max_memory_allocation</code></p></td><td><div><div><p>Sets the size (in bytes) of each slot in the off-heap memory pool. DataWeave stores payloads that exceed this size in temporary files <code>dw-buffer-input-${count}.tmp</code> and <code>dw-buffer-output-${count}.tmp</code>.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>1572864</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.memory_pool_size</code></p></td><td><div><div><p>Sets the number of slots in the memory pool. DataWeave buffers use off-heap memory from a pool, up to a defined size (<code>com.mulesoft.dw.memory_pool_size</code> * <code>com.mulesoft.dw.max_memory_allocation</code>). DataWeave allocates the remainder using heap memory. See <a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-memory-management">DataWeave Memory Management</a>.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>60</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.multipart.defaultContentType</code></p></td><td><div><div><p>Sets the default Content-Type to use on parts of the <code>multipart/*</code> format when a <code>Content-Type</code> is not specified. See also, the multipart reader property <a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-formats-multipart#properties">defaultContentType</a>. <em>Introduced in DataWeave 2.3 (2.3.0-20210720) for the August 2021 release of Mule 4.3.0-20210719.</em></p></div><div><ul><li><p>Type: <code>String</code></p></li><li><p>Default: <code>application/octet-stream</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.scheduler.size</code></p></td><td><div><div><p>Specifies the size of DataWeave scheduler thread pool.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>100</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.stacksize</code></p></td><td><div><div><p>Sets the maximum size of the stack. When a function recurses too deeply, DataWeave throws an error, such as Stack Overflow. The maximum size limit is 256.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>256</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.stripTrailingZeroes</code></p></td><td><div><div><p>When set to <code>false</code>, DataWeave restores the behavior of preserving trailing zeroes for some formats (such as DataWeave, JSON, and YAML) present in 2.4.0. Starting with 2.5.0, trailing zeroes are removed by default. .DataWeave script:</p></div><div><div><pre><code data-lang="xml">%dw 2.4
output application/json
---
1.00</code></pre></div></div><div><ul><li><p>If <code>com.mulesoft.dw.stripTrailingZeroes</code> is set to <code>false</code>, the script returns the following output: <code>1.00</code></p></li><li><p>If <code>com.mulesoft.dw.stripTrailingZeroes</code> is set to <code>true</code>, the script returns the following output: <code>1</code></p></li><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels:</p></li><li><p><code>true</code> for language levels: 2.5, 2.6, 2.7, 2.8, 2.9</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.5, 2.6, 2.7, 2.8, 2.9</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.telemetry.bufferSize</code></p></td><td><div><div><p>Determines the size in bytes of the telemetry event buffer.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>1048576</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.telemetry.enabled</code></p></td><td><div><div><p>Enables Dataweave telemetry service.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.telemetry.memory</code></p></td><td><div><div><p>When set to <code>true</code>, the telemetry service collects memory usage statistics.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.telemetry.sync</code></p></td><td><div><div><p>When set to <code>true</code>, telemetry events are published synchronously.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.track.cursor.close</code></p></td><td><div><div><p>When set to <code>true</code>, tracks the stack trace from which the {CursorProvider#close()} method is called. Use this property for troubleshooting, for example, if {CursorProvider#openCursor()} is called on a cursor that is already closed.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.valueSelector.selectsAlwaysFirst</code></p></td><td><div><div><p>When set to <code>true</code>, returns the first occurrence of an element (even if the element appears more than once). Enabling this behavior degrades performance.</p></div><div><p>The following example illustrates the behavior that is controlled by this property. (Assume that the DataWeave script acts on the XML input.)</p></div><div><div>XML input:</div><div><pre><code data-lang="xml">&lt;root&gt;
  &lt;users&gt;
     &lt;user&gt;
       &lt;lname&gt;chibana&lt;/lname&gt;
       &lt;name&gt;Shoki&lt;/name&gt;
     &lt;/user&gt;
     &lt;user&gt;
       &lt;name&gt;Shoki&lt;/name&gt;
       &lt;name&gt;Tomo&lt;/name&gt;
     &lt;/user&gt;
  &lt;/users&gt;
&lt;/root&gt;</code></pre></div></div><div><div>DataWeave script:</div><div><pre><code data-lang="xml">%dw 2.0
output application/json
---
{
    shokis: payload.root.users.*user map $.name
}</code></pre></div></div><div><ul><li><p>If <code>com.mulesoft.dw.valueSelector.selectsAlwaysFirst</code> is set to <code>true</code>, the script returns the following output:</p><div><div><pre><code data-lang="json">{
  "shokis": [
    "Shoki",
    "Shoki"
  ]
}</code></pre></div></div></li><li><p>If <code>com.mulesoft.dw.valueSelector.selectsAlwaysFirst</code> is set to <code>false</code>, the script returns the following output:</p><div><div><pre><code data-lang="json">{
  "shokis": [
    "Shoki",
    "Tomo"
  ]
}</code></pre></div></div></li><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div><div><p>Available for language levels: 2.3, 2.4, 2.5</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.workingdirectory.base</code></p></td><td><div><div><p>Specifies the base directory in which temporary files are written.</p></div><div><ul><li><p>Type: <code>String</code></p></li><li><p>Default: <code>java.io.tmpdir (system property value)</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.workingdirectory.delete_sync</code></p></td><td><div><div><p>File deletion occurs synchronously when this property is set to <code>true</code>.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.workingdirectory.max_output_buffer_size</code></p></td><td><div><div><p>Specifies the maximum size of a file written in bytes.</p></div><div><ul><li><p>Type: <code>Long</code></p></li><li><p>Default: <code>-1</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.workingdirectory.tracking</code></p></td><td><div><div><p>Each script generates temporary files in their own directory when this property is set to <code>true</code>.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.xml.supportDTD</code></p></td><td><div><div><p>Controls whether DTD handling is enabled or disabled. When this property is set to <code>false</code>, DataWeave skips processing of both internal and external subsets.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.xml_reader.honourMixedContentStructure</code></p></td><td><div><div><p>When set to <code>true</code>, DataWeave retains a mixed-content structure instead of grouping text with mixed content into a single text field.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.4</p></li><li><p><code>true</code> for language levels: 2.5</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.4, 2.5</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.xml_reader.honourXmlDeclarationEncoding</code></p></td><td><div><div><p>When this property is set to <code>true</code>, DataWeave uses the encoding declared in the XML if present.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.4, 2.5</p></li><li><p><code>true</code> for language levels: 2.6, 2.7, 2.8, 2.9 Available for language levels: 2.4, 2.5, 2.6, 2.7, 2.8, 2.9</p></li></ul></div></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.xml_writer.declareXmlNamespace</code></p></td><td><div><div><p>When set to <code>false</code>, DataWeave doesn’t declare the <code>xml</code> implicit namespace.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>true</code> for language levels: 2.4, 2.5</p></li><li><p><code>false</code> for language levels: 2.6</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.4, 2.5, 2.6</p></div></div></td></tr><tr><td><p><code>mule.dw.java_module_loader_deterministic_functions_ordering</code></p></td><td><div><div><p>When set to <code>true</code>, the JavaModuleLoader loads the methods for Java Classes in deterministic order. DataWeave considers the method name, the parameters count, and finally, the parameter type name.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>true</code> for language levels: 2.5, 2.6</p></li></ul></div><div><p>Available for language levels: 2.5, 2.6</p></div></div></td></tr><tr><td><p><code>mule.dw.remove_shadowed_implicit_inputs</code></p></td><td><div><div><p>If a variable with the same name is declared at the root level and this property is set to <code>true</code>, DataWeave removes implicit inputs.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>true</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.csv_reader.indexed.retainStringValueInMemory</code></p></td><td><div><div><p>When set to <code>false</code>, this property prevents DataWeave indexed readers for CSV from keeping string value references in memory. While this can reduce performance, it helps prevent out-of-memory errors.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>true</code> for language levels: 2.6, 2.7, 2.8, 2.9 Available for language levels: 2.6, 2.7, 2.8, 2.9</p></li></ul></div></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.csv_writer.alwaysEscapeQuotesInCSV</code></p></td><td><div><div><p>When set to <code>true</code>, DataWeave escapes quotes in CSV.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.4</p></li><li><p><code>true</code> for language levels: 2.5 Available for language levels: 2.4, 2.5</p></li></ul></div></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.surrogateCharCodeSupport</code></p></td><td><div><div><p>When set to <code>true</code>, the <code>fromCharCode</code> function supports surrogate characters and throws an exception if the code point isn’t a valid Unicode character.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.6, 2.7, 2.8, 2.9 Available for language levels: 2.6, 2.7, 2.8, 2.9</p></li></ul></div></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.xml_reader.allowIndexedLatin1</code></p></td><td><div><div><p>When set to <code>true</code>, DataWeave lets you use the indexed reader for Latin1(ISO-8859-1) encoding. Use this for backward compatibility only, as Latin1 isn’t fully supported.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>true</code> for language levels: 2.6, 2.7, 2.8, 2.9 Available for language levels: 2.6, 2.7, 2.8, 2.9</p></li></ul></div></li></ul></div></div></td></tr></tbody></table>

<!-- document id=a856160761f3f03221cd0e82da08b006aa6b2200a1e484fd5055120fe5dce470 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-system-properties.md -->

---
product: DataWeave
version: 2.9
---

# DataWeave System Properties

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave supports several system properties. To use these properties in application development and
deployments, see [System Properties](https://docs.mulesoft.com/mule-runtime/latest/mule-app-properties-system).

<table><colgroup><col> <col></colgroup><thead><tr><th>Property</th><th>Description</th></tr></thead><tbody><tr><td><p><code>com.mulesoft.dw.buffered_char_sequence.enabled</code></p></td><td><div><div><p>Controls whether an internal <code>BufferedCharSequence</code> improvement is enabled or disabled. When this property is set to <code>true</code>, DataWeave does not load large fields (greater than 1.5M) into memory. DataWeave reads these fields by chunk. This feature reduces performance to prevent an out-of-memory error.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>true</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.buffersize</code></p></td><td><div><div><p>Sets the size (in bytes) of in-memory input and output buffers that DataWeave uses to retain processed inputs and outputs. DataWeave stores payloads that exceed this size in temporary files <code>dw-buffer-index-${count}.tmp</code> and <code>dw-buffer-output-${count}.tmp</code>. See <a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-memory-management">DataWeave Memory Management</a>.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>8192</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.charbuffersize</code></p></td><td><div><div><p>Determines the size (in bytes) of the buffer used by the writer.</p></div><div><ul><li><p>Type: <code>Number</code> (in bytes)</p></li><li><p>Default: <code>4096</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.coercionexception.verbose</code></p></td><td><div><div><p>By default, adds to coercion exceptions more information about data that fails to coerce. When this property is set to <code>false</code>, DataWeave does not display the additional metadata.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>true</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.cpulimit.watchdog</code></p></td><td><div><div><p>Monitors and limits script execution time when set to <code>true</code>.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>true</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.csv_reader.indexed.retainStringValueInMemory</code></p></td><td><div><div><p>When set to <code>false</code>, this property prevents DataWeave indexed readers for CSV from keeping string value references in memory. While this can reduce performance, it helps prevent out-of-memory errors.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>true</code> for language levels: 2.6, 2.7, 2.8, 2.9</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.6, 2.7, 2.8, 2.9</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.csv_writer.alwaysEscapeQuotesInCSV</code></p></td><td><div><div><p>When set to <code>true</code>, DataWeave escapes quotes in CSV.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.4</p></li><li><p><code>true</code> for language levels: 2.5</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.4, 2.5</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.date_minus_back_compatibility</code></p></td><td><div><div><p>Restores the <a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-add-and-subtract-time">Add and Subtract Time</a> behaviors that changed in 2.3.0 when this property is set to <code>true</code>.</p></div><div><p>For example, consider the following DataWeave script:</p></div><div><div><pre><code data-lang="dataweave">%dw 2.0
output application/dw
---
|2019-10-01| - |2018-09-23|</code></pre></div></div><div><ul><li><p>In DataWeave 2.3.0, the expression returns <code>PT8952H</code>.</p></li><li><p>In DataWeave 2.2.0, the expression returns <code>P1Y8D</code>.</p></li><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.3, 2.4, 2.5</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.3, 2.4, 2.5</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.decode_binaries_with_writer_encoding</code></p></td><td><div><div><p>When set to <code>true</code>, binary values in JSON are written using JsonWriter encoding. Otherwise, the property uses either the encoding defined in the value schema or the default one.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.defaultOperator.disableExceptionHandling</code></p></td><td><div><div><p>When set to <code>true</code>, DataWeave disables the <code>default</code> operator that catches runtime exceptions. Enabling the <code>default</code> operator doesn’t return the <code>default value</code> when a runtime exception occurs. When set to <code>false</code>, the <code>default</code> operator catches the runtime exceptions and returns the <code>default value</code>.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>true</code> for language levels: 2.5, 2.6, 2.7, 2.8, 2.9</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.5, 2.6, 2.7, 2.8, 2.9</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.directbuffer.disable</code></p></td><td><div><div><p>Controls whether DataWeave uses off-heap memory (the default) or heap memory. DataWeave uses off-heap memory for internal buffering, which can cause issues on systems that have only a small amount of memory. See <a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-memory-management">DataWeave Memory Management</a>.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.dump_files</code></p></td><td><div><div><p><em>Experimental:</em> Dumps the input context and the failing script into a folder when this property is set to <code>true</code>. This behavior enables you to track the failing script and the data that makes the script fail, which is particularly useful for verifying that the received input data is valid. Incorrect scripts often fail when an upstream component generates invalid data.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div><div><p><code>com.mulesoft.dw.dump_files</code> is an <em>experimental feature</em> that is subject to change or removal from future versions of DataWeave. See <a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-troubleshoot">Troubleshooting a Failing DataWeave Script</a>.</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.dump_folder</code></p></td><td><div><div><p><em>Experimental:</em> Specifies the path in which to dump files when <code>com.mulesoft.dw.dump_files</code> is set to <code>true</code>.</p></div><div><ul><li><p>Type: <code>String</code></p></li><li><p>Default: <code>java.io.tempdir (system property value)</code></p></li></ul></div><div><p><code>com.mulesoft.dw.dump_folder</code> is an <em>experimental feature</em> that is subject to change or removal from future versions of DataWeave. See <a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-troubleshoot">Troubleshooting a Failing DataWeave Script</a>.</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.dumper_fill_stacktrace</code></p></td><td><div><div><p><em>Experimental:</em> Adds the StackTrace for dumper exceptions when <code>com.mulesoft.dw.dump_files</code> is set to <code>true</code>.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div><div><p><code>com.mulesoft.dw.dumper_fill_stacktrace</code> is an <em>experimental feature</em> that is subject to change or removal from future versions of DataWeave. See <a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-troubleshoot">Troubleshooting a Failing DataWeave Script</a>.</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.error_value_length</code></p></td><td><div><div><p>Sets the maximum length of exception messages to display to the user. The message is truncated to the maximum length. This setting is useful for avoiding long exception messages.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>80</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.indexsize</code></p></td><td><div><div><p>Sets the maximum size (in bytes) of the page in memory that indexed readers use.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>1572864</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.java.disable_set_accessible</code></p></td><td><div><div><p>When set to <code>true</code>, the JavaModuleLoader doesn’t change the accessible flag for fields or methods used via reflection. The default value evaluates the current JDK version used and the language level. The value is <code>true</code> when the used JDK is 17 or later and the language version is 2.6 or later.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.5</p></li><li><p><code>true</code> for language levels: 2.6, 2.7, 2.8, 2.9</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.5, 2.6, 2.7, 2.8, 2.9</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.java.enabled_class_definition_lookup</code></p></td><td><div><div><p>When set to <code>true</code>, the JavaModuleLoader honors the public interface definition of the given bean instance to access properties via reflection. The default value evaluates the current JDK version used and the language level. The value is <code>true</code> when the used JDK is 17 or later and the language version is 2.10 or later. If set to <code>false</code>, the JavaModuleLoader uses the specific bean’s class definition to access properties via reflection, which can cause accessibility issues.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.5, 2.6, 2.7, 2.8, 2.9</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.5, 2.6, 2.7, 2.8, 2.9</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.java.honour_bean_definition_accessor</code></p></td><td><div><div><p>When set to <code>true</code>, the JavaModuleLoader honors the bean definition by using the getter and setter methods to access properties via reflection at object value selectors. If set to <code>false</code>, the JavaModuleLoader uses the getter and setter methods to access existing properties or the property uses the field accessor as default.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.8</p></li><li><p><code>true</code> for language levels: 2.9</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.8, 2.9</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.java.stacktrace</code></p></td><td><div><div><p>Specifies the depth of the Java stack trace.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>6</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.javaSqlDateToDate</code></p></td><td><div><div><p>When set, <code>java.sql.Date</code> maps to the DataWeave <code>Date</code> type. If <code>false</code>, it maps to <code>DateTime</code>.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.4</p></li><li><p><code>true</code> for language levels: 2.5</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.4, 2.5</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.legacySizeOfNumber</code></p></td><td><div><div><p>When set to <code>true</code>, DataWeave returns <code>1</code> when calling <code>sizeOf()</code> function for any <code>Number</code> value.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.6, 2.7, 2.8, 2.9</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.6, 2.7, 2.8, 2.9</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.max_memory_allocation</code></p></td><td><div><div><p>Sets the size (in bytes) of each slot in the off-heap memory pool. DataWeave stores payloads that exceed this size in temporary files <code>dw-buffer-input-${count}.tmp</code> and <code>dw-buffer-output-${count}.tmp</code>.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>1572864</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.memory_pool_size</code></p></td><td><div><div><p>Sets the number of slots in the memory pool. DataWeave buffers use off-heap memory from a pool, up to a defined size (<code>com.mulesoft.dw.memory_pool_size</code> * <code>com.mulesoft.dw.max_memory_allocation</code>). DataWeave allocates the remainder using heap memory. See <a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-memory-management">DataWeave Memory Management</a>.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>60</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.messageLogging.debounceDuration</code></p></td><td><div><div><p>Sets the number of milliseconds to wait before logging the same message again when using <code>MessageLoggingService.logXXXXDebounce</code> methods.</p></div><div><ul><li><p>Type: <code>Long</code></p></li><li><p>Default: <code>3000</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.multipart.defaultContentType</code></p></td><td><div><div><p>Sets the default Content-Type to use on parts of the <code>multipart/*</code> format when a <code>Content-Type</code> is not specified. See also, the multipart reader property <a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-formats-multipart#properties">defaultContentType</a>. <em>Introduced in DataWeave 2.3 (2.3.0-20210720) for the August 2021 release of Mule 4.3.0-20210719.</em></p></div><div><ul><li><p>Type: <code>String</code></p></li><li><p>Default: <code>application/octet-stream</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.scheduler.size</code></p></td><td><div><div><p>Specifies the size of DataWeave scheduler thread pool.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>100</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.stableOrderBy</code></p></td><td><div><div><p>When set to <code>true</code>, DataWeave throws <code>InvalidComparisonException</code> if the <code>orderBy</code> function attempts to compare values of different types. If set to <code>false</code>, coercions are used when comparing values of different types, which can cause that the resulting order isn’t the expected one as in: .DataWeave script:</p></div><div><div><pre><code data-lang="xml">%dw 2.4
output application/json
---
[5, 1, "10"] orderBy $</code></pre></div></div><div><ul><li><p>If <code>com.mulesoft.dw.stableOrderBy</code> is set to <code>false</code>, the script returns the following output: <code>[1, "10", 5]</code></p></li><li><p>If <code>com.mulesoft.dw.stableOrderBy</code> is set to <code>true</code>, the script throws <code>InvalidComparisonException</code>.</p></li><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.9</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.9</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.stacksize</code></p></td><td><div><div><p>Sets the maximum size of the stack. When a function recurses too deeply, DataWeave throws an error, such as Stack Overflow. The maximum size limit is 256.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>256</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.stripTrailingZeroes</code></p></td><td><div><div><p>When set to <code>false</code>, DataWeave restores the behavior of preserving trailing zeroes for some formats (such as DataWeave, JSON, and YAML) present in 2.4.0. Starting with 2.5.0, trailing zeroes are removed by default. .DataWeave script:</p></div><div><div><pre><code data-lang="xml">%dw 2.4
output application/json
---
1.00</code></pre></div></div><div><ul><li><p>If <code>com.mulesoft.dw.stripTrailingZeroes</code> is set to <code>false</code>, the script returns the following output: <code>1.00</code></p></li><li><p>If <code>com.mulesoft.dw.stripTrailingZeroes</code> is set to <code>true</code>, the script returns the following output: <code>1</code></p></li><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>true</code> for language levels: 2.5, 2.6, 2.7, 2.8, 2.9</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.5, 2.6, 2.7, 2.8, 2.9</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.surrogateCharCodeSupport</code></p></td><td><div><div><p>When set to <code>true</code>, the <code>fromCharCode</code> function supports surrogate characters and throws an exception if the code point isn’t a valid Unicode character.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.6, 2.7, 2.8, 2.9</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.6, 2.7, 2.8, 2.9</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.telemetry.bufferSize</code></p></td><td><div><div><p>Determines the size in bytes of the telemetry event buffer.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>1048576</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.telemetry.enabled</code></p></td><td><div><div><p>Enables DataWeave telemetry service.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.telemetry.memory</code></p></td><td><div><div><p>When set to <code>true</code>, the telemetry service collects memory usage statistics.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.telemetry.sync</code></p></td><td><div><div><p>When set to <code>true</code>, telemetry events are published synchronously.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.track.cursor.close</code></p></td><td><div><div><p>When set to <code>true</code>, tracks the stack trace from which the {CursorProvider#close()} method is called. Use this property for troubleshooting, for example, if {CursorProvider#openCursor()} is called on a cursor that is already closed.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.valueSelector.selectsAlwaysFirst</code></p></td><td><div><div><p>When set to <code>true</code>, returns the first occurrence of an element (even if the element appears more than once). Enabling this behavior degrades performance.</p></div><div><p>The following example illustrates the behavior that is controlled by this property. (Assume that the DataWeave script acts on the XML input.)</p></div><div><div>XML input:</div><div><pre><code data-lang="xml">&lt;root&gt;
  &lt;users&gt;
     &lt;user&gt;
       &lt;lname&gt;chibana&lt;/lname&gt;
       &lt;name&gt;Shoki&lt;/name&gt;
     &lt;/user&gt;
     &lt;user&gt;
       &lt;name&gt;Shoki&lt;/name&gt;
       &lt;name&gt;Tomo&lt;/name&gt;
     &lt;/user&gt;
  &lt;/users&gt;
&lt;/root&gt;</code></pre></div></div><div><div>DataWeave script:</div><div><pre><code data-lang="xml">%dw 2.0
output application/json
---
{
    shokis: payload.root.users.*user map $.name
}</code></pre></div></div><div><ul><li><p>If <code>com.mulesoft.dw.valueSelector.selectsAlwaysFirst</code> is set to <code>true</code>, the script returns the following output:</p><div><div><pre><code data-lang="json">{
  "shokis": [
    "Shoki",
    "Shoki"
  ]
}</code></pre></div></div></li><li><p>If <code>com.mulesoft.dw.valueSelector.selectsAlwaysFirst</code> is set to <code>false</code>, the script returns the following output:</p><div><div><pre><code data-lang="json">{
  "shokis": [
    "Shoki",
    "Tomo"
  ]
}</code></pre></div></div></li><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.3, 2.4, 2.5</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.3, 2.4, 2.5</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.workingdirectory.base</code></p></td><td><div><div><p>Specifies the base directory in which temporary files are written.</p></div><div><ul><li><p>Type: <code>String</code></p></li><li><p>Default: <code>java.io.tmpdir (system property value)</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.workingdirectory.delete_sync</code></p></td><td><div><div><p>File deletion occurs synchronously when this property is set to <code>true</code>.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.workingdirectory.max_output_buffer_size</code></p></td><td><div><div><p>Specifies the maximum size of a file written in bytes.</p></div><div><ul><li><p>Type: <code>Number</code> (in bytes)</p></li><li><p>Default: <code>-1</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.workingdirectory.tracking</code></p></td><td><div><div><p>Each script generates temporary files in their own directory when this property is set to <code>true</code>.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.xml.supportDTD</code></p></td><td><div><div><p>Controls whether DTD handling is enabled or disabled. When this property is set to <code>false</code>, DataWeave skips processing of both internal and external subsets.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.xml_reader.allowIndexedLatin1</code></p></td><td><div><div><p>When set to <code>true</code>, DataWeave lets you use the indexed reader for Latin1(ISO-8859-1) encoding. Use this for backward compatibility only, as Latin1 isn’t fully supported.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>true</code> for language levels: 2.6, 2.7, 2.8, 2.9</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.6, 2.7, 2.8, 2.9</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.xml_reader.honourMixedContentStructure</code></p></td><td><div><div><p>When this property is set to <code>true</code>, DataWeave retains a mixed-content structure instead of grouping text with mixed content into a single text field.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.4</p></li><li><p><code>true</code> for language levels: 2.5</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.4, 2.5</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.xml_reader.honourXmlDeclarationEncoding</code></p></td><td><div><div><p>When this property is set to <code>true</code>, DataWeave uses the encoding declared in the XML if present.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.4, 2.5</p></li><li><p><code>true</code> for language levels: 2.6, 2.7, 2.8, 2.9</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.4, 2.5, 2.6, 2.7, 2.8, 2.9</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.xml_writer.declareXmlNamespace</code></p></td><td><div><div><p>When this property is set to <code>false</code>, DataWeave doesn’t declare the <code>xml</code> implicit namespace.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>true</code> for language levels: 2.4, 2.5</p></li><li><p><code>false</code> for language levels: 2.6</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.4, 2.5, 2.6</p></div></div></td></tr><tr><td><p><code>mule.dw.java_module_loader_deterministic_functions_ordering</code></p></td><td><div><div><p>When set to <code>true</code>, the JavaModuleLoader loads the methods for Java Classes in deterministic order. DataWeave considers the method name, the parameters count, and finally, the parameter type name.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>true</code> for language levels: 2.5, 2.6</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.5, 2.6</p></div></div></td></tr><tr><td><p><code>mule.dw.remove_shadowed_implicit_inputs</code></p></td><td><div><div><p>If a variable with the same name is declared at the root level and this property is set to <code>true</code>, DataWeave removes implicit inputs.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>true</code></p></li></ul></div></div></td></tr></tbody></table>

<!-- document id=e1b12a9af712e477a7631067dda8ca5b8fc51ffcee44c79e97490d716f2d51a8 url=/mulesoft/current/en-us/dataweave/latest/dataweave-system-properties.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# DataWeave System Properties

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave supports several system properties. To use these properties in application development and
deployments, see [System Properties](https://docs.mulesoft.com/mule-runtime/latest/mule-app-properties-system).

Whether a property in this reference applies depends on the DataWeave language level configured for
the application, not only on the Mule runtime version where the application runs. For how language
level is determined in Mule applications (including its relationship to `minMuleVersion`), see
[Versioning Behavior in DataWeave](https://docs.mulesoft.com/dataweave/latest/dataweave-versioning-behavior).

If a property is listed as available only for specific language levels, it applies only when the
application uses one of those levels. In newer DataWeave versions, some of these properties remain
supported only for backward compatibility when the application targets a compatible earlier language
level, even if it runs on a newer Mule runtime.

<table><colgroup><col> <col></colgroup><thead><tr><th>Property</th><th>Description</th></tr></thead><tbody><tr><td><p><code>com.mulesoft.dw.base64ChunksEnabled</code></p></td><td><div><div><p>When set to <code>true</code>, <code>dw::core::Binaries::fromBase64</code> and <code>dw::core::Binaries::toBase64</code> functions don’t load the entire function argument (<code>String</code> or <code>Binary</code>) into memory. DataWeave loads the function argument (<code>String</code> or <code>Binary</code>) by chunk. This feature prevents an out-of-memory error.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>true</code> for language levels: 2.11, 2.12</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.11, 2.12</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.buffered_char_sequence.enabled</code></p></td><td><div><div><p>Controls whether an internal <code>BufferedCharSequence</code> improvement is enabled or disabled. When this property is set to <code>true</code>, DataWeave does not load large fields (greater than 1.5M) into memory. DataWeave reads these fields by chunk. This feature reduces performance to prevent an out-of-memory error.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>true</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.buffersize</code></p></td><td><div><div><p>Sets the size (in bytes) of in-memory input and output buffers that DataWeave uses to retain processed inputs and outputs. DataWeave stores payloads that exceed this size in temporary files <code>dw-buffer-index-${count}.tmp</code> and <code>dw-buffer-output-${count}.tmp</code>. See <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-memory-management">DataWeave Memory Management</a>.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>8192</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.charbuffersize</code></p></td><td><div><div><p>Determines the size (in bytes) of the buffer used by the writer.</p></div><div><ul><li><p>Type: <code>Number</code> (in bytes)</p></li><li><p>Default: <code>4096</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.coercionexception.verbose</code></p></td><td><div><div><p>By default, adds to coercion exceptions more information about data that fails to coerce. When this property is set to <code>false</code>, DataWeave does not display the additional metadata.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>true</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.cpulimit.watchdog</code></p></td><td><div><div><p>Monitors and limits script execution time when set to <code>true</code>.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>true</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.csv_reader.indexed.retainStringValueInMemory</code></p></td><td><div><div><p>When set to <code>false</code>, this property prevents DataWeave indexed readers for CSV from keeping string value references in memory. While this can reduce performance, it helps prevent out-of-memory errors.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>true</code> for language levels: 2.6, 2.7, 2.8, 2.9</p></li><li><p><code>false</code> for language levels: 2.10, 2.11, 2.12</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.6, 2.7, 2.8, 2.9, 2.10, 2.11, 2.12</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.csv_writer.alwaysEscapeQuotesInCSV</code></p></td><td><div><div><p>When set to <code>true</code>, DataWeave escapes quotes in CSV.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.4</p></li><li><p><code>true</code> for language levels: 2.5</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.4, 2.5</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.date_minus_back_compatibility</code></p></td><td><div><div><p>Restores the <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-add-and-subtract-time">Add and Subtract Time</a> behaviors that changed in 2.3.0 when this property is set to <code>true</code>.</p></div><div><p>For example, consider the following DataWeave script:</p></div><div><div><pre><code data-lang="dataweave">%dw 2.0
output application/dw
---
|2019-10-01| - |2018-09-23|</code></pre></div></div><div><ul><li><p>In DataWeave 2.3.0, the expression returns <code>PT8952H</code>.</p></li><li><p>In DataWeave 2.2.0, the expression returns <code>P1Y8D</code>.</p></li><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.3, 2.4, 2.5</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.3, 2.4, 2.5</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.decode_binaries_with_writer_encoding</code></p></td><td><div><div><p>When set to <code>true</code>, binary values in JSON are written using JsonWriter encoding. Otherwise, the property uses either the encoding defined in the value schema or the default one.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.defaultOperator.disableExceptionHandling</code></p></td><td><div><div><p>When set to <code>true</code>, DataWeave disables the <code>default</code> operator that catches runtime exceptions. Enabling the <code>default</code> operator doesn’t return the <code>default value</code> when a runtime exception occurs. When set to <code>false</code>, the <code>default</code> operator catches the runtime exceptions and returns the <code>default value</code>.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>true</code> for language levels: 2.5, 2.6, 2.7, 2.8, 2.9</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.5, 2.6, 2.7, 2.8, 2.9</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.directbuffer.disable</code></p></td><td><div><div><p>Controls whether DataWeave uses off-heap memory (the default) or heap memory. DataWeave uses off-heap memory for internal buffering, which can cause issues on systems that have only a small amount of memory. See <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-memory-management">DataWeave Memory Management</a>.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.dump_files</code></p></td><td><div><div><p><em>Experimental:</em> Dumps the input context and the failing script into a folder when this property is set to <code>true</code>. This behavior enables you to track the failing script and the data that makes the script fail, which is particularly useful for verifying that the received input data is valid. Incorrect scripts often fail when an upstream component generates invalid data.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div><div><p><code>com.mulesoft.dw.dump_files</code> is an <em>experimental feature</em> that is subject to change or removal from future versions of DataWeave. See <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-troubleshoot">Troubleshooting a Failing DataWeave Script</a>.</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.dump_folder</code></p></td><td><div><div><p><em>Experimental:</em> Specifies the path in which to dump files when <code>com.mulesoft.dw.dump_files</code> is set to <code>true</code>.</p></div><div><ul><li><p>Type: <code>String</code></p></li><li><p>Default: <code>java.io.tempdir (system property value)</code></p></li></ul></div><div><p><code>com.mulesoft.dw.dump_folder</code> is an <em>experimental feature</em> that is subject to change or removal from future versions of DataWeave. See <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-troubleshoot">Troubleshooting a Failing DataWeave Script</a>.</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.dumper_fill_stacktrace</code></p></td><td><div><div><p><em>Experimental:</em> Adds the StackTrace for dumper exceptions when <code>com.mulesoft.dw.dump_files</code> is set to <code>true</code>.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div><div><p><code>com.mulesoft.dw.dumper_fill_stacktrace</code> is an <em>experimental feature</em> that is subject to change or removal from future versions of DataWeave. See <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-troubleshoot">Troubleshooting a Failing DataWeave Script</a>.</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.error_value_length</code></p></td><td><div><div><p>Sets the maximum length of exception messages to display to the user. The message is truncated to the maximum length. This setting is useful for avoiding long exception messages.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>80</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.indexsize</code></p></td><td><div><div><p>Sets the maximum size (in bytes) of the page in memory that indexed readers use.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>1572864</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.java.disable_set_accessible</code></p></td><td><div><div><p>When set to <code>true</code>, the JavaModuleLoader doesn’t change the accessible flag for fields or methods used via reflection. The default value evaluates the current JDK version used and the language level. The value is <code>true</code> when the used JDK is 17 or later and the language version is 2.6 or later.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.5</p></li><li><p><code>true</code> for language levels: 2.6, 2.7, 2.8, 2.9</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.5, 2.6, 2.7, 2.8, 2.9</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.java.enabled_class_definition_lookup</code></p></td><td><div><div><p>When set to <code>true</code>, the JavaModuleLoader honors the public interface definition of the given bean instance to access properties via reflection. The default value evaluates the current JDK version used and the language level. The value is <code>true</code> when the used JDK is 17+ and the language version is greater than 2.10. If set to <code>false</code>, the JavaModuleLoader uses the specific bean’s class definition to access properties via reflection, which could end in accessibility issues.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.5, 2.6, 2.7, 2.8, 2.9</p></li><li><p><code>true</code> for language levels: 2.10, 2.11</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.5, 2.6, 2.7, 2.8, 2.9, 2.10, 2.11</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.java.honour_bean_definition_accessor</code></p></td><td><div><div><p>When set to <code>true</code>, the JavaModuleLoader honors the bean definition by using the getter and setter methods to access properties via reflection at object value selectors. If set to <code>false</code>, the JavaModuleLoader uses the getter and setter methods to access existing properties or the property uses the field accessor as default.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.8</p></li><li><p><code>true</code> for language levels: 2.9, 2.10, 2.11, 2.12</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.8, 2.9, 2.10, 2.11, 2.12</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.java.output_types_as_string</code></p></td><td><div><div><p>When set to <code>true</code>, DataWeave scripts with Java output <code>mimetype</code> return the string representation of that type. If set to <code>false</code>, the scripts return a Java class constructed from the corresponding DataWeave type class.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>true</code> for language levels: 2.0, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7, 2.8, 2.9, 2.10, 2.11, 2.12</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.0, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7, 2.8, 2.9, 2.10, 2.11, 2.12</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.java.per_app_java_bean_cache</code></p></td><td><div><div><p>When set to <code>true</code>, the <code>JavaBeanHelper</code> uses a per-app cache owned by <code>WeaveExpressionLanguage</code> instead of the global singleton. This eliminates the weak-value eviction events that can orphan Caffeine’s <code>evictionLock</code> under stack exhaustion.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>true</code> for language levels: 2.12</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.12</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.java.stacktrace</code></p></td><td><div><div><p>Specifies the depth of the Java stack trace.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>6</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.javaSqlDateToDate</code></p></td><td><div><div><p>When set, <code>java.sql.Date</code> maps to the DataWeave <code>Date</code> type. If <code>false</code>, it maps to <code>DateTime</code>.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.4</p></li><li><p><code>true</code> for language levels: 2.5</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.4, 2.5</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.legacySizeOfNumber</code></p></td><td><div><div><p>When set to <code>true</code>, DataWeave returns <code>1</code> when calling <code>sizeOf()</code> function for any <code>Number</code> value.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.6, 2.7, 2.8, 2.9, 2.10</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.6, 2.7, 2.8, 2.9, 2.10</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.max_memory_allocation</code></p></td><td><div><div><p>Sets the size (in bytes) of each slot in the off-heap memory pool. DataWeave stores payloads that exceed this size in temporary files <code>dw-buffer-input-${count}.tmp</code> and <code>dw-buffer-output-${count}.tmp</code>.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>1572864</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.memory_pool_size</code></p></td><td><div><div><p>Sets the number of slots in the memory pool. DataWeave buffers use off-heap memory from a pool, up to a defined size (<code>com.mulesoft.dw.memory_pool_size</code> * <code>com.mulesoft.dw.max_memory_allocation</code>). DataWeave allocates the remainder using heap memory. See <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-memory-management">DataWeave Memory Management</a>.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>60</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.messageLogging.debounceDuration</code></p></td><td><div><div><p>Sets the number of milliseconds to wait before logging the same message again when using <code>MessageLoggingService.logXXXXDebounce</code> methods.</p></div><div><ul><li><p>Type: <code>Long</code></p></li><li><p>Default: <code>3000</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.multipart.defaultContentType</code></p></td><td><div><div><p>Sets the default Content-Type to use on parts of the <code>multipart/*</code> format when a <code>Content-Type</code> is not specified. See also, the multipart reader property <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats-multipart#properties">defaultContentType</a>. <em>Introduced in DataWeave 2.3 (2.3.0-20210720) for the August 2021 release of Mule 4.3.0-20210719.</em></p></div><div><ul><li><p>Type: <code>String</code></p></li><li><p>Default: <code>application/octet-stream</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.scheduler.size</code></p></td><td><div><div><p>Specifies the size of DataWeave scheduler thread pool.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>100</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.stableOrderBy</code></p></td><td><div><div><p>When set to <code>true</code>, DataWeave throws <code>InvalidComparisonException</code> if the <code>orderBy</code> function attempts to compare values of different types. If set to <code>false</code>, coercions are used when comparing values of different types, which can cause the resulting order to be different from the expected one as in: .DataWeave script:</p></div><div><div><pre><code data-lang="xml">%dw 2.4
output application/json
---
[5, 1, "10"] orderBy $</code></pre></div></div><div><ul><li><p>If <code>com.mulesoft.dw.stableOrderBy</code> is set to <code>false</code>, the script returns the following output: <code>[1, "10", 5]</code></p></li><li><p>If <code>com.mulesoft.dw.stableOrderBy</code> is set to <code>true</code>, the script throws <code>InvalidComparisonException</code>.</p></li><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.9</p></li><li><p><code>true</code> for language levels: 2.10, 2.11, 2.12</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.9, 2.10, 2.11, 2.12</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.stacksize</code></p></td><td><div><div><p>Sets the maximum size of the stack. When a function recurses too deeply, DataWeave throws an error, such as Stack Overflow. The maximum size limit is 256.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>256</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.stripTrailingZeroes</code></p></td><td><div><div><p>When set to <code>false</code>, DataWeave restores the behavior of preserving trailing zeroes for some formats (such as DataWeave, JSON, and YAML) present in 2.4.0. Starting with 2.5.0, trailing zeroes are removed by default. .DataWeave script:</p></div><div><div><pre><code data-lang="xml">%dw 2.4
output application/json
---
1.00</code></pre></div></div><div><ul><li><p>If <code>com.mulesoft.dw.stripTrailingZeroes</code> is set to <code>false</code>, the script returns the following output: <code>1.00</code></p></li><li><p>If <code>com.mulesoft.dw.stripTrailingZeroes</code> is set to <code>true</code>, the script returns the following output: <code>1</code></p></li><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>true</code> for language levels: 2.5, 2.6, 2.7, 2.8, 2.9</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.5, 2.6, 2.7, 2.8, 2.9</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.surrogateCharCodeSupport</code></p></td><td><div><div><p>When set to <code>true</code>, the <code>fromCharCode</code> function supports surrogate characters and throws an exception if the code point isn’t a valid Unicode character.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.6, 2.7, 2.8, 2.9</p></li><li><p><code>true</code> for language levels: 2.10</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.6, 2.7, 2.8, 2.9, 2.10</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.telemetry.bufferSize</code></p></td><td><div><div><p>Determines the size in bytes of the telemetry event buffer.</p></div><div><ul><li><p>Type: <code>Number</code></p></li><li><p>Default: <code>1048576</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.telemetry.enabled</code></p></td><td><div><div><p>Enables DataWeave telemetry service.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.telemetry.memory</code></p></td><td><div><div><p>When set to <code>true</code>, the telemetry service collects memory usage statistics.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.telemetry.sync</code></p></td><td><div><div><p>When set to <code>true</code>, telemetry events are published synchronously.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.track.cursor.close</code></p></td><td><div><div><p>When set to <code>true</code>, tracks the stack trace from which the {CursorProvider#close()} method is called. Use this property for troubleshooting, for example, if {CursorProvider#openCursor()} is called on a cursor that is already closed.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.valueSelector.selectsAlwaysFirst</code></p></td><td><div><div><p>When set to <code>true</code>, returns the first occurrence of an element (even if the element appears more than once). Enabling this behavior degrades performance.</p></div><div><p>This example illustrates the behavior that is controlled by this property. (Assume that the DataWeave script acts on the XML input.)</p></div><div><div>XML input:</div><div><pre><code data-lang="xml">&lt;root&gt;
  &lt;users&gt;
     &lt;user&gt;
       &lt;lname&gt;chibana&lt;/lname&gt;
       &lt;name&gt;Shoki&lt;/name&gt;
     &lt;/user&gt;
     &lt;user&gt;
       &lt;name&gt;Shoki&lt;/name&gt;
       &lt;name&gt;Tomo&lt;/name&gt;
     &lt;/user&gt;
  &lt;/users&gt;
&lt;/root&gt;</code></pre></div></div><div><div>DataWeave script:</div><div><pre><code data-lang="xml">%dw 2.0
output application/json
---
{
    shokis: payload.root.users.*user map $.name
}</code></pre></div></div><div><ul><li><p>If <code>com.mulesoft.dw.valueSelector.selectsAlwaysFirst</code> is set to <code>true</code>, the script returns the following output:</p><div><div><pre><code data-lang="json">{
  "shokis": [
    "Shoki",
    "Shoki"
  ]
}</code></pre></div></div></li><li><p>If <code>com.mulesoft.dw.valueSelector.selectsAlwaysFirst</code> is set to <code>false</code>, the script returns the following output:</p><div><div><pre><code data-lang="json">{
  "shokis": [
    "Shoki",
    "Tomo"
  ]
}</code></pre></div></div></li><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.3, 2.4, 2.5</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.3, 2.4, 2.5</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.workingdirectory.base</code></p></td><td><div><div><p>Specifies the base directory in which temporary files are written.</p></div><div><ul><li><p>Type: <code>String</code></p></li><li><p>Default: <code>java.io.tmpdir (system property value)</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.workingdirectory.delete_sync</code></p></td><td><div><div><p>File deletion occurs synchronously when this property is set to <code>true</code>.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.workingdirectory.max_output_buffer_size</code></p></td><td><div><div><p>Specifies the maximum size of a file written in bytes.</p></div><div><ul><li><p>Type: <code>Long</code></p></li><li><p>Default: <code>-1</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.workingdirectory.tracking</code></p></td><td><div><div><p>Each script generates temporary files in their own directory when this property is set to <code>true</code>.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.xml.supportDTD</code></p></td><td><div><div><p>Controls whether DTD handling is enabled or disabled. When this property is set to <code>false</code>, DataWeave skips processing of both internal and external subsets.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>false</code></p></li></ul></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.xml_reader.allowIndexedLatin1</code></p></td><td><div><div><p>When set to <code>true</code>, DataWeave lets you use the indexed reader for Latin1(ISO-8859-1) encoding. Use this for backward compatibility only, as Latin1 isn’t fully supported.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>true</code> for language levels: 2.6, 2.7, 2.8, 2.9</p></li><li><p><code>false</code> for language levels: 2.10, 2.11, 2.12</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.6, 2.7, 2.8, 2.9, 2.10, 2.11, 2.12</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.xml_reader.honourMixedContentStructure</code></p></td><td><div><div><p>When this property is set to <code>true</code>, DataWeave retains a mixed-content structure instead of grouping text with mixed content into a single text field.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.4</p></li><li><p><code>true</code> for language levels: 2.5</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.4, 2.5</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.xml_reader.honourXmlDeclarationEncoding</code></p></td><td><div><div><p>When this property is set to <code>true</code>, DataWeave uses the encoding declared in the XML if present.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.4, 2.5</p></li><li><p><code>true</code> for language levels: 2.6, 2.7, 2.8, 2.9, 2.10, 2.11, 2.12</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.4, 2.5, 2.6, 2.7, 2.8, 2.9, 2.10, 2.11, 2.12</p></div></div></td></tr><tr><td><p><code>com.mulesoft.dw.xml_writer.declareXmlNamespace</code></p></td><td><div><div><p>When this property is set to <code>false</code>, DataWeave doesn’t declare the <code>xml</code> implicit namespace.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>true</code> for language levels: 2.4, 2.5</p></li><li><p><code>false</code> for language levels: 2.6</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.4, 2.5, 2.6</p></div></div></td></tr><tr><td><p><code>mule.dw.enable_vars_materialization_pass</code></p></td><td><div><div><p>Enables a pass of the DataWeave compiler that extracts usages of values in Mule <code>vars</code> special variable into variable declarations. This forces materialization of values inside <code>vars</code>, and is useful for fixing issues where repeated reads of <code>vars</code> yield a <code>null</code> value.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>false</code> for language levels: 2.4, 2.5, 2.6, 2.7, 2.8, 2.9, 2.10</p></li><li><p><code>true</code> for language levels: 2.11, 2.12, 2.13</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.4, 2.5, 2.6, 2.7, 2.8, 2.9, 2.10, 2.11, 2.12, 2.13</p></div></div></td></tr><tr><td><p><code>mule.dw.java_module_loader_deterministic_functions_ordering</code></p></td><td><div><div><p>When set to <code>true</code>, the JavaModuleLoader loads the methods for Java Classes in deterministic order. DataWeave considers the method name, the parameters count, and finally, the parameter type name.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default:</p><div><ul><li><p><code>true</code> for language levels: 2.5, 2.6</p></li></ul></div></li></ul></div><div><p>Available for language levels: 2.5, 2.6</p></div></div></td></tr><tr><td><p><code>mule.dw.remove_shadowed_implicit_inputs</code></p></td><td><div><div><p>If a variable with the same name is declared at the root level and this property is set to <code>true</code>, DataWeave removes implicit inputs.</p></div><div><ul><li><p>Type: <code>Boolean</code></p></li><li><p>Default: <code>true</code></p></li></ul></div></div></td></tr></tbody></table>

<!-- document id=433bc25adb0ba1c11daa9dbf9bb670cfdc36e9081388d6c4b0fbfe06a15953c4 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-variables.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# DataWeave Variables

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave is a functional programming language in which variables behave just like functions.
DataWeave uses eager evaluation for variables and function parameters. In addition, DataWeave
variables are immutable.

A variable is assigned a value, which is either a constant (such as `var msg = "hello"`) or a lambda
expression such as `() → "hello"`.

## DataWeave Variable Assignment

Here are some examples of DataWeave 2.0 variable assignments:

Example: Variable Assignment in a DataWeave Script

```dataweave
%dw 2.0
output application/json
var msg = "Hello"

var msg2 = (x = "ignore") -> "hello"

var toUpper = (aString) -> upper(aString)

var combined = (function, msg="universe") -> function(msg ++ " WORLD")
---
[
   msg: msg,
   msg2: msg2(),
   toUpper: toUpper(msg),
   combined: combined(toUpper, "hello"),
   combined2: combined(((x) -> lower(x) ++ " Today"), msg)
]
```

The previous script results in this output:

Example: Output

```json
[
  {
    "msg": "Hello"
  },
  {
    "msg2": "hello"
  },
  {
    "toUpper": "HELLO"
  },
  {
    "combined": "HELLO WORLD"
  },
  {
    "combined2": "hello world Today"
  }
]
```

In these examples:

- The `msg` var is assigned to a constant.

- `msg2` is assigned to an expression that maps to a constant, so `msg2()` behaves the same way as
  `msg`, without the `()`.

- The `toUpper` variable maps an input parameter to the DataWeave `upper` function. So it is used
  like a more traditional function in other languages as `toUpper(aString)`.

- The `combined` variable accepts a function as an input parameter, then applies that function name
  to the second `msg` argument. The second `msg` argument is optional because a default value
  `universe` is specified.

The result of the expression `combined(toUpper, " world")` is to apply the `toUpper` function
defined earlier in the header to the `msg` parameter value `world`. The supplied second argument
`world` overrides the `msg="universe"` default value, so the result is `HELLO WORLD`. The expression
`combined(toUpper)`, which omits the second argument, uses the default `msg` value to return
`"combined": "UNIVERSE WORLD"`.

The `combined2: combined(x) → lower(x) ++ " Today", msg)` defines the lambda expression that you can
reuse in different contexts. In the example, `combined2` key defines the expression “in place” at
the time the function is called.

Note that these types of “in place” expressions are called closures in languages like JavaScript.

DataWeave includes syntactic sugar to make it easier to access lambda expressions that are assigned
to a variable as functions. To do this, you replace the `var` directive with the `fun` directive,
and replace the arrow `→` in the lambda expression with an equal sign (`=`). You also move the
lambda expression arguments next to the function name so the syntax looks like a function
declaration in other procedural programming languages. This enables you to use variables as if they
were functions. So the previous example can be equivalently written as:

```dataweave
%dw 2.0
output application/json
var msg = "Hello"

var toUpper = (aString) -> upper(aString)
var toLower = (aString) -> lower(aString)

fun msg2(optParm = "ignore") = "hello"

fun toTitle(text: String) = toLower(text[0]) ++ toUpper(text[1 to -1])

fun combined(function, msg="universe") = function(msg ++ " world")
---
[
   msg: msg,
   msg2: msg2(),
   toUpper: toTitle(msg),
   combined: combined(toUpper, msg),
   combined2: combined((x) -> lower(x) ++ " today", msg)
]
```

This example produces the same result:

```json
[
  {
    "msg": "Hello"
  },
  {
    "msg2": "hello"
  },
  {
    "toUpper": "hELLO"
  },
  {
    "combined": "HELLO WORLD"
  },
  {
    "combined2": "hello world today"
  }
]
```

The important distinction in DataWeave is that functions are variables, and every function is just a
syntactical renaming of the underlying `var` syntax, which allows you to pass function names or
lambda expressions as arguments to other functions. The `fun` syntax allows you to access the
powerful functional programming aspects of DataWeave while also being able to write simpler
expressions as function calls you might be more familiar with.

Also notice that DataWeave variables (and functions) can specify any number of optional arguments by
providing default values, so long as all those optional arguments are last in the argument list.

## Example: Declare an Array Variable and Transform its Elements

Variables are immutable in DataWeave, however you can iterate over an array variable and apply a
transformation to its elements, which can then be assigned to new variables. The following example
declares two array variables, iterates over them to transform their elements, and then declares an
object containing two new arrays with the transformed elements:

DataWeave Source:

```dataweave
%dw 2.0
import * from dw::core::Strings
output application/json
var numberArray = [1,2,3,4,5,6]
var stringArray = ["max", "astro", "einstein"]
---
{
  "numberArrayUpdated" : numberArray map ((value, index) -> value * value),
  "stringArrayUpdated" : stringArray map ((value, index) -> index ++ " - " ++ capitalize(value))
}
```

Output:

```json
{
  "numberArrayUpdated": [1, 4, 9, 16, 25, 36],
  "stringArrayUpdated": ["0 - Max", "1 - Astro", "2 - Einstein"]
}
```

## Naming Rules for Variables

You can declare any variable name that is a valid identifier. See
[Rules for Declaring Valid Identifiers](https://docs.mulesoft.com/dataweave/2.11/dataweave-language-introduction#valid-identifiers) for more
details.

## Variable Scopes

You can initialize and use both global and local variables in DataWeave scripts.

- Global variables are initialized in the header of the DataWeave script and can be referenced by
  name from anywhere in the body of a DataWeave script.

  The header of a DataWeave script accepts a `var` directive that initializes a variable, for
  example: `var language='Español'`. You can declare multiple global variables on separate lines in
  the header.

- Local variables are initialized in the body of the DataWeave script and can be referenced by name
  only from within the scope of the expression where they are initialized.

  The syntax for initializing a local variable looks like this:

  ```dataweave
  do {
        [type <name> = <type expression>]*
        [var <name> = <expression>]*
        [fun <name>(<params>*) = <expression>]*
        [ns <name> <nsUri>]*
        ---
        <body>
  }
  ```

Note that DataWeave variables cannot be reassigned. They are also distinct from variables that are
part of the Mule message (such as target variables). DataWeave variables do not persist beyond the
scope of the script in which they are initialized.

## Example: Global DataWeave Variables

This example defines a `do` operation that initializes a `language` variable with the constant value
`Español` and returns that constant value. The body of the DataWeave script calls the `do` operation
using the variable `myVar`, which populates the `<language/>` element in the XML output with the
value `Español`.

Transform

```dataweave
%dw 2.0
output application/xml
var myVar = do {
    var language = "Español"
    ---
    language
}
---
{
  document: {
    language: myVar,
    text: "Hola mundo"
  }
}
```

Output

```xml
<?xml version='1.0' encoding='UTF-8'?>
<document>
  <language>Español</language>
  <text>Hola mundo</text>
</document>
```

## Example: Local DataWeave Variables

To initialize local variables, you can use either literal expressions, variable reference
expressions, or functional expressions. These expressions can reference any other local variables
within their scope or any input or global variables.

As a best practice, declare local variables within `do` scopes (see
[Flow Control in DataWeave](https://docs.mulesoft.com/dataweave/2.11/dataweave-flow-control#control_flow_do)). The alternative method of
declaring a scope with the `using` keyword is no longer recommended and available only to provide
compatibility.

You can only reference a local variable by name from within the scope of the expression that
initializes it. The declaration can be prepended to any literal expression. The literal delimits the
scope of the variable, so you cannot reference any variable outside of its scope.

The examples that follow show initialization of local variables.

Example: Scoped to a Simple Value

The following example sets the local variable `myVar` in a `do` scope. It calls `do` from the body
of the DataWeave script:

```dataweave
%dw 2.0
output application/json
---
do {
      var myVar = 2
      ---
      3 + myVar
}
```

The result is `5`.

Example: Scoped to an Array Literal

The following example sets the local variable `myVar` in a `do` scope and uses it to set the value
of the second element in the array to `2`:

```dataweave
%dw 2.0
output application/json
---
do {
      var myVar = 2
      ---
      [1, myVar, 3]
}
```

The result is `[ 1, 2, 3]`

Example: Scoped to the Object literal

In the following example, references to all the variables are valid. `fn` and `ln` are defined and
called within the `do` scope. The global `myVar` variable is also accessible from that scope.

```dataweave
%dw 2.0
var myVar = 1234
var myDo =  do {
    var fn = "Annie"
    var ln = "Point"
    ---
    {
      id : myVar,
      firstname : fn,
      lastname : ln
    }
}
output application/xml
---
{ person : myDo }
```

```xml
<?xml version='1.0' encoding='UTF-8'?>
<person>
  <id>1234</id>
  <firstname>Annie</firstname>
  <lastname>Point</lastname>
</person>
```

Example: **Invalid Reference** That Is Outside the Scope

The following example produces an error because `fromDoScope` is referenced from outside the scope
of `do`. As a consequence, the concatenation operation (`++`) cannot append the name-value pair to
the collection.

```dataweave
%dw 2.0
var myVar = 1234
var myDo =  do {
    var fn = "Annie"
    var ln = "Point"
    var fromDoScope = "Platform"
    ---
    {
      id : myVar,
      firstname : fn,
      lastname : ln
    }
}
output application/xml
---
{
    person : myDo ++ { "outsideDoScope" : fromDoScope }
}
```

The invalid example returns this error: `Unable to resolve reference of fromDoScope.`

Example: Reference That Is Inside a Function

The following example passes the string `HELLO` to the `test` function defined in the header. The
`do` scope accepts the string, converts it to lowercase, and then concatenates that string to the
`suffix` variable, which is also defined in the header of the scope.

```dataweave
%dw 2.0
fun test(param1: String) = do {
    var suffix = "123"
    fun innerTest(str: String) = lower(str)
   ---
   innerTest(param1 ++ suffix)
}
output application/json
---
test("HELLO")
```

The result is `"hello123"`.

## Variables Assigned as Lambda Expressions

When a variable is assigned a lambda expression, it behaves just like a function. Like a function,
the lambda expression for a variable assignment can include parameters that can be used in the
right-hand side expression, such as `(string) → upper(string)`, which will convert any string to
uppercase.

Other variables can also be passed as arguments to another variable’s lambda expression. This
example shows how the `toUpper` variable’s lambda expression can be passed by name into the
`addSuffix` variable’s lambda expression.

```dataweave
%dw 2.0
output application/json
var toUpper = (aString) -> upper(aString)

var addSuffix = (msg, aFunction, suffix) -> aFunction(msg ++ suffix)
---
addSuffix("hello", toUpper, " world") //result is "HELLO WORLD"
```

## @Lazy() Annotation

When you are writing a DataWeave script in Studio, you might see the internal annotation `@Lazy()`
in autocompletion suggestions. This annotation is not intended for general use and does not improve
the performance of your scripts.

<!-- document id=a41f4d33636b7c639737a8914315159990cd5f1ded2bac70d1abe46d83235069 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-variables.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# DataWeave Variables

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave is a functional programming language in which variables behave just like functions.
DataWeave uses eager evaluation for variables and function parameters. In addition, DataWeave
variables are immutable. A variable is assigned a value, which is either a constant (such as
`var msg = "hello"`) or a lambda expression such as `() → "hello"`.

## DataWeave Variable Assignment

Here are some examples of DataWeave 2.0 variable assignments:

Example: Variable Assignment in a DataWeave Script

```dataweave
%dw 2.0
output application/json
var msg = "Hello"

var msg2 = (x = "ignore") -> "hello"

var toUpper = (aString) -> upper(aString)

var combined = (function, msg="universe") -> function(msg ++ " WORLD")
---
[
   msg: msg,
   msg2: msg2(),
   toUpper: toUpper(msg),
   combined: combined(toUpper, "hello"),
   combined2: combined(((x) -> lower(x) ++ " Today"), msg)
]
```

The previous script results in this output:

Example: Output

```json
[
  {
    "msg": "Hello"
  },
  {
    "msg2": "hello"
  },
  {
    "toUpper": "HELLO"
  },
  {
    "combined": "HELLO WORLD"
  },
  {
    "combined2": "hello world Today"
  }
]
```

In these examples:

- The `msg` var is assigned to a constant.

- `msg2` is assigned to an expression that maps to a constant, so `msg2()` behaves the same way as
  `msg`, without the `()`.

- The `toUpper` variable maps an input parameter to the DataWeave `upper` function. So it is used
  like a more traditional function in other languages as `toUpper(aString)`.

- The `combined` variable accepts a function as an input parameter, then applies that function name
  to the second `msg` argument. The second `msg` argument is optional because a default value
  `universe` is specified.

The result of the expression `combined(toUpper, " world")` is to apply the `toUpper` function
defined earlier in the header to the `msg` parameter value `world`. The supplied second argument
`world` overrides the `msg="universe"` default value, so the result is `HELLO WORLD`. The expression
`combined(toUpper)`, which omits the second argument, uses the default `msg` value to return
`"combined": "UNIVERSE WORLD"`.

The `combined2: combined(x) → lower(x) ++ " Today", msg)` defines the lambda expression that you can
reuse in different contexts. In the example, `combined2` key defines the expression “in place” at
the time the function is called.

Note that these types of “in place” expressions are called closures in languages like JavaScript.

DataWeave includes syntactic sugar to make it easier to access lambda expressions that are assigned
to a variable as functions. To do this, you replace the `var` directive with the `fun` directive,
and replace the arrow `→` in the lambda expression with an equal sign (`=`). You also move the
lambda expression arguments next to the function name so the syntax looks like a function
declaration in other procedural programming languages. This enables you to use variables as if they
were functions. So the previous example can be equivalently written as:

```dataweave
%dw 2.0
output application/json
var msg = "Hello"

var toUpper = (aString) -> upper(aString)
var toLower = (aString) -> lower(aString)

fun msg2(optParm = "ignore") = "hello"

fun toTitle(text: String) = toLower(text[0]) ++ toUpper(text[1 to -1])

fun combined(function, msg="universe") = function(msg ++ " world")
---
[
   msg: msg,
   msg2: msg2(),
   toUpper: toTitle(msg),
   combined: combined(toUpper, msg),
   combined2: combined((x) -> lower(x) ++ " today", msg)
]
```

This example produces the same result:

```json
[
  {
    "msg": "Hello"
  },
  {
    "msg2": "hello"
  },
  {
    "toUpper": "hELLO"
  },
  {
    "combined": "HELLO WORLD"
  },
  {
    "combined2": "hello world today"
  }
]
```

The important distinction in DataWeave is that functions are variables, and every function is just a
syntactical renaming of the underlying `var` syntax, which allows you to pass function names or
lambda expressions as arguments to other functions. The `fun` syntax allows you to access the
powerful functional programming aspects of DataWeave while also being able to write simpler
expressions as function calls you might be more familiar with.

Also notice that DataWeave variables (and functions) can specify any number of optional arguments by
providing default values, so long as all those optional arguments are last in the argument list.

## Example: Declare an Array Variable and Transform its Elements

Variables are immutable in DataWeave, however you can iterate over an array variable and apply a
transformation to its elements, which can then be assigned to new variables. The following example
declares two array variables, iterates over them to transform their elements, and then declares an
object containing two new arrays with the transformed elements:

DataWeave Source:

```dataweave
%dw 2.0
import * from dw::core::Strings
output application/json
var numberArray = [1,2,3,4,5,6]
var stringArray = ["max", "astro", "einstein"]
---
{
  "numberArrayUpdated" : numberArray map ((value, index) -> value * value),
  "stringArrayUpdated" : stringArray map ((value, index) -> index ++ " - " ++ capitalize(value))
}
```

Output:

```json
{
  "numberArrayUpdated": [1, 4, 9, 16, 25, 36],
  "stringArrayUpdated": ["0 - Max", "1 - Astro", "2 - Einstein"]
}
```

## Naming Rules for Variables

You can declare any variable name that is a valid identifier. See
[Rules for Declaring Valid Identifiers](https://docs.mulesoft.com/dataweave/2.12/dataweave-language-introduction#valid-identifiers) for more
details.

## Variable Scopes

You can initialize and use both global and local variables in DataWeave scripts.

- Global variables are initialized in the header of the DataWeave script and can be referenced by
  name from anywhere in the body of a DataWeave script.

  The header of a DataWeave script accepts a `var` directive that initializes a variable, for
  example: `var language='Español'`. You can declare multiple global variables on separate lines in
  the header.

- Local variables are initialized in the body of the DataWeave script and can be referenced by name
  only from within the scope of the expression where they are initialized.

  The syntax for initializing a local variable looks like this:

  ```dataweave
  do {
        [type <name> = <type expression>]*
        [var <name> = <expression>]*
        [fun <name>(<params>*) = <expression>]*
        [ns <name> <nsUri>]*
        ---
        <body>
  }
  ```

Note that DataWeave variables cannot be reassigned. They are also distinct from variables that are
part of the Mule message (such as target variables). DataWeave variables do not persist beyond the
scope of the script in which they are initialized.

## Example: Global DataWeave Variables

This example defines a `do` operation that initializes a `language` variable with the constant value
`Español` and returns that constant value. The body of the DataWeave script calls the `do` operation
using the variable `myVar`, which populates the `<language/>` element in the XML output with the
value `Español`.

Transform

```dataweave
%dw 2.0
output application/xml
var myVar = do {
    var language = "Español"
    ---
    language
}
---
{
  document: {
    language: myVar,
    text: "Hola mundo"
  }
}
```

Output

```xml
<?xml version='1.0' encoding='UTF-8'?>
<document>
  <language>Español</language>
  <text>Hola mundo</text>
</document>
```

## Example: Local DataWeave Variables

To initialize local variables, you can use either literal expressions, variable reference
expressions, or functional expressions. These expressions can reference any other local variables
within their scope or any input or global variables.

As a best practice, declare local variables within `do` scopes (see
[Flow Control in DataWeave](https://docs.mulesoft.com/dataweave/2.12/dataweave-flow-control#control_flow_do)). The alternative method of
declaring a scope with the `using` keyword is no longer recommended and available only to provide
compatibility.

You can only reference a local variable by name from within the scope of the expression that
initializes it. The declaration can be prepended to any literal expression. The literal delimits the
scope of the variable, so you cannot reference any variable outside of its scope.

The examples that follow show initialization of local variables.

Example: Scoped to a Simple Value

The following example sets the local variable `myVar` in a `do` scope. It calls `do` from the body
of the DataWeave script:

```dataweave
%dw 2.0
output application/json
---
do {
      var myVar = 2
      ---
      3 + myVar
}
```

The result is `5`.

Example: Scoped to an Array Literal

The following example sets the local variable `myVar` in a `do` scope and uses it to set the value
of the second element in the array to `2`:

```dataweave
%dw 2.0
output application/json
---
do {
      var myVar = 2
      ---
      [1, myVar, 3]
}
```

The result is `[ 1, 2, 3]`

Example: Scoped to the Object literal

In the following example, references to all the variables are valid. `fn` and `ln` are defined and
called within the `do` scope. The global `myVar` variable is also accessible from that scope.

```dataweave
%dw 2.0
var myVar = 1234
var myDo =  do {
    var fn = "Annie"
    var ln = "Point"
    ---
    {
      id : myVar,
      firstname : fn,
      lastname : ln
    }
}
output application/xml
---
{ person : myDo }
```

```xml
<?xml version='1.0' encoding='UTF-8'?>
<person>
  <id>1234</id>
  <firstname>Annie</firstname>
  <lastname>Point</lastname>
</person>
```

Example: **Invalid Reference** That Is Outside the Scope

The following example produces an error because `fromDoScope` is referenced from outside the scope
of `do`. As a consequence, the concatenation operation (`++`) cannot append the name-value pair to
the collection.

```dataweave
%dw 2.0
var myVar = 1234
var myDo =  do {
    var fn = "Annie"
    var ln = "Point"
    var fromDoScope = "Platform"
    ---
    {
      id : myVar,
      firstname : fn,
      lastname : ln
    }
}
output application/xml
---
{
    person : myDo ++ { "outsideDoScope" : fromDoScope }
}
```

The invalid example returns this error: `Unable to resolve reference of fromDoScope.`

Example: Reference That Is Inside a Function

The following example passes the string `HELLO` to the `test` function defined in the header. The
`do` scope accepts the string, converts it to lowercase, and then concatenates that string to the
`suffix` variable, which is also defined in the header of the scope.

```dataweave
%dw 2.0
fun test(param1: String) = do {
    var suffix = "123"
    fun innerTest(str: String) = lower(str)
   ---
   innerTest(param1 ++ suffix)
}
output application/json
---
test("HELLO")
```

The result is `"hello123"`.

## Variables Assigned as Lambda Expressions

When a variable is assigned a lambda expression, it behaves just like a function. Like a function,
the lambda expression for a variable assignment can include parameters that can be used in the
right-hand side expression, such as `(string) → upper(string)`, which will convert any string to
uppercase.

Other variables can also be passed as arguments to another variable’s lambda expression. This
example shows how the `toUpper` variable’s lambda expression can be passed by name into the
`addSuffix` variable’s lambda expression.

```dataweave
%dw 2.0
output application/json
var toUpper = (aString) -> upper(aString)

var addSuffix = (msg, aFunction, suffix) -> aFunction(msg ++ suffix)
---
addSuffix("hello", toUpper, " world") //result is "HELLO WORLD"
```

## @Lazy() Annotation

When you are writing a DataWeave script in Studio, you might see the internal annotation `@Lazy()`
in autocompletion suggestions. This annotation is not intended for general use and does not improve
the performance of your scripts.

<!-- document id=d2139d619c01451ad333c8d6730db2b56690251ad68b05fdd5e0b32261e3c954 url=/mulesoft/current/en-us/dataweave/2.3/dataweave-variables.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# DataWeave Variables

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave is a functional programming language in which variables behave just like functions.
DataWeave uses eager evaluation for variables and function parameters. In addition, DataWeave
variables are immutable.

A variable is assigned a value, which is either a constant (such as `var msg = "hello"`) or a lambda
expression such as `() → "hello"`.

## DataWeave Variable Assignment

Here are some examples of DataWeave version 2 variable assignments:

Example: Variable Assignment in a DataWeave Script

```dataweave
%dw 2.0
output application/json
var msg = "Hello"

var msg2 = (x = "ignore") -> "hello"

var toUpper = (aString) -> upper(aString)

var combined = (function, msg="universe") -> function(msg ++ " WORLD")
---
[
   msg: msg,
   msg2: msg2(),
   toUpper: toUpper(msg),
   combined: combined(toUpper, "hello"),
   combined2: combined(((x) -> lower(x) ++ " Today"), msg)
]
```

The previous script results in this output:

Example: Output

```json
[
  {
    "msg": "Hello"
  },
  {
    "msg2": "hello"
  },
  {
    "toUpper": "HELLO"
  },
  {
    "combined": "HELLO WORLD"
  },
  {
    "combined2": "hello world Today"
  }
]
```

In these examples:

- The `msg` var is assigned to a constant.

- `msg2` is assigned to an expression that maps to a constant, so `msg2()` behaves the same way as
  `msg`, without the `()`.

- The `toUpper` variable maps an input parameter to the DataWeave `upper` function. So it is used
  like a more traditional function in other languages as `toUpper(aString)`.

- The `combined` variable accepts a function as an input parameter, then applies that function name
  to the second `msg` argument. The second `msg` argument is optional because a default value
  `universe` is specified.

The result of the expression `combined(toUpper, " world")` is to apply the `toUpper` function
defined earlier in the header to the `msg` parameter value `world`. The supplied second argument
`world` overrides the `msg="universe"` default value, so the result is `HELLO WORLD`. The expression
`combined(toUpper)`, which omits the second argument, uses the default `msg` value to return
`"combined": "UNIVERSE WORLD"`.

The `combined2: combined(x) → lower(x) ++ " Today", msg)` defines the lambda expression that you can
reuse in different contexts. In the example, `combined2` key defines the expression “in place” at
the time the function is called.

Note that these types of “in place” expressions are called closures in languages like JavaScript.

DataWeave includes syntactic sugar to make it easier to access lambda expressions that are assigned
to a variable as functions. To do this, you replace the `var` directive with the `fun` directive,
and replace the arrow `→` in the lambda expression with an equal sign (`=`). You also move the
lambda expression arguments next to the function name so the syntax looks like a function
declaration in other procedural programming languages. This enables you to use variables as if they
were functions. So the previous example can be equivalently written as:

```dataweave
%dw 2.0
output application/json
var msg = "Hello"

var toUpper = (aString) -> upper(aString)
var toLower = (aString) -> lower(aString)

fun msg2(optParm = "ignore") = "hello"

fun toTitle(text: String) = toLower(text[0]) ++ toUpper(text[1 to -1])

fun combined(function, msg="universe") = function(msg ++ " world")
---
[
   msg: msg,
   msg2: msg2(),
   toUpper: toTitle(msg),
   combined: combined(toUpper, msg),
   combined2: combined((x) -> lower(x) ++ " today", msg)
]
```

This example produces the same result:

```json
[
  {
    "msg": "Hello"
  },
  {
    "msg2": "hello"
  },
  {
    "toUpper": "hELLO"
  },
  {
    "combined": "HELLO WORLD"
  },
  {
    "combined2": "hello world today"
  }
]
```

The important distinction in DataWeave is that functions are variables, and every function is just a
syntactical renaming of the underlying `var` syntax, which allows you to pass function names or
lambda expressions as arguments to other functions. The `fun` syntax allows you to access the
powerful functional programming aspects of DataWeave while also being able to write simpler
expressions as function calls you might be more familiar with.

Also notice that DataWeave variables (and functions) can specify any number of optional arguments by
providing default values, so long as all those optional arguments are last in the argument list.

## Example: Declare an Array Variable and Transform its Elements

Variables are immutable in DataWeave, however you can iterate over an array variable and apply a
transformation to its elements, which can then be assigned to new variables. The following example
declares two array variables, iterates over them to transform their elements, and then declares an
object containing two new arrays with the transformed elements:

DataWeave Source:

```dataweave
%dw 2.0
import * from dw::core::Strings
output application/json
var numberArray = [1,2,3,4,5,6]
var stringArray = ["max", "astro", "einstein"]
---
{
  "numberArrayUpdated" : numberArray map ((value, index) -> value * value),
  "stringArrayUpdated" : stringArray map ((value, index) -> index ++ " - " ++ capitalize(value))
}
```

Output:

```json
{
  "numberArrayUpdated": [1, 4, 9, 16, 25, 36],
  "stringArrayUpdated": ["0 - Max", "1 - Astro", "2 - Einstein"]
}
```

## Naming Rules for Variables

You can declare any variable name that is a valid identifier. See
[Rules for Declaring Valid Identifiers](https://docs.mulesoft.com/dataweave/2.3/dataweave-language-introduction#valid-identifiers) for more
details.

## Variable Scopes

You can initialize and use both global and local variables in DataWeave scripts.

- Global variables are initialized in the header of the DataWeave script and can be referenced by
  name from anywhere in the body of a DataWeave script.

  The header of a DataWeave script accepts a `var` directive that initializes a variable, for
  example: `var language='Español'`. You can declare multiple global variables on separate lines in
  the header.

- Local variables are initialized in the body of the DataWeave script and can be referenced by name
  only from within the scope of the expression where they are initialized.

  The syntax for initializing a local variable looks like this:

  ```dataweave
  do {
        [type <name> = <type expression>]*
        [var <name> = <expression>]*
        [fun <name>(<params>*) = <expression>]*
        [ns <name> <nsUri>]*
        ---
        <body>
  }
  ```

Note that DataWeave variables cannot be reassigned. They are also distinct from variables that are
part of the Mule message (such as target variables). DataWeave variables do not persist beyond the
scope of the script in which they are initialized.

## Example: Global DataWeave Variables

This example defines a `do` operation that initializes a `language` variable with the constant value
`Español` and returns that constant value. The body of the DataWeave script calls the `do` operation
using the variable `myVar`, which populates the `<language/>` element in the XML output with the
value `Español`.

Transform

```dataweave
%dw 2.0
output application/xml
var myVar = do {
    var language = "Español"
    ---
    language
}
---
{
  document: {
    language: myVar,
    text: "Hola mundo"
  }
}
```

Output

```xml
<?xml version='1.0' encoding='UTF-8'?>
<document>
  <language>Español</language>
  <text>Hola mundo</text>
</document>
```

## Example: Local DataWeave Variables

To initialize local variables, you can use either literal expressions, variable reference
expressions, or functional expressions. These expressions can reference any other local variables
within their scope or any input or global variables.

As a best practice, declare local variables within `do` scopes (see
[Flow Control in DataWeave](https://docs.mulesoft.com/dataweave/2.3/dataweave-flow-control#control_flow_do)). The alternative method of
declaring a scope with the `using` keyword is no longer recommended and available only to provide
compatibility.

You can only reference a local variable by name from within the scope of the expression that
initializes it. The declaration can be prepended to any literal expression. The literal delimits the
scope of the variable, so you cannot reference any variable outside of its scope.

The examples that follow show initialization of local variables.

Example: Scoped to a Simple Value

The following example sets the local variable `myVar` in a `do` scope. It calls `do` from the body
of the DataWeave script:

```dataweave
%dw 2.0
output application/json
---
do {
      var myVar = 2
      ---
      3 + myVar
}
```

The result is `5`.

Example: Scoped to an Array Literal

The following example sets the local variable `myVar` in a `do` scope and uses it to set the value
of the second element in the array to `2`:

```dataweave
%dw 2.0
output application/json
---
do {
      var myVar = 2
      ---
      [1, myVar, 3]
}
```

The result is `[ 1, 2, 3]`

Example: Scoped to the Object literal

In the following example, references to all the variables are valid. `fn` and `ln` are defined and
called within the `do` scope. The global `myVar` variable is also accessible from that scope.

```dataweave
%dw 2.0
var myVar = 1234
var myDo =  do {
    var fn = "Annie"
    var ln = "Point"
    ---
    {
      id : myVar,
      firstname : fn,
      lastname : ln
    }
}
output application/xml
---
{ person : myDo }
```

```xml
<?xml version='1.0' encoding='UTF-8'?>
<person>
  <id>1234</id>
  <firstname>Annie</firstname>
  <lastname>Point</lastname>
</person>
```

Example: **Invalid Reference** That Is Outside the Scope

The following example produces an error because `fromDoScope` is referenced from outside the scope
of `do`. As a consequence, the concatenation operation (`++`) cannot append the name-value pair to
the collection.

```dataweave
%dw 2.0
var myVar = 1234
var myDo =  do {
    var fn = "Annie"
    var ln = "Point"
    var fromDoScope = "Platform"
    ---
    {
      id : myVar,
      firstname : fn,
      lastname : ln
    }
}
output application/xml
---
{
    person : myDo ++ { "outsideDoScope" : fromDoScope }
}
```

The invalid example returns this error: `Unable to resolve reference of fromDoScope.`

Example: Reference That Is Inside a Function

The following example passes the string `HELLO` to the `test` function defined in the header. The
`do` scope accepts the string, converts it to lowercase, and then concatenates that string to the
`suffix` variable, which is also defined in the header of the scope.

```dataweave
%dw 2.0
fun test(param1: String) = do {
    var suffix = "123"
    fun innerTest(str: String) = lower(str)
   ---
   innerTest(param1 ++ suffix)
}
output application/json
---
test("HELLO")
```

The result is `"hello123"`.

## Variables Assigned as Lambda Expressions

When a variable is assigned a lambda expression, it behaves just like a function. Like a function,
the lambda expression for a variable assignment can include parameters that can be used in the
right-hand side expression, such as `(string) → upper(string)`, which will convert any string to
uppercase.

Other variables can also be passed as arguments to another variable’s lambda expression. This
example shows how the `toUpper` variable’s lambda expression can be passed by name into the
`addSuffix` variable’s lambda expression.

```dataweave
%dw 2.0
output application/json
var toUpper = (aString) -> upper(aString)

var addSuffix = (msg, aFunction, suffix) -> aFunction(msg ++ suffix)
---
addSuffix("hello", toUpper, " world") //result is "HELLO WORLD"
```

## @Lazy() Annotation

When you are writing a DataWeave script in Studio, you might see the internal annotation `@Lazy()`
in autocompletion suggestions. This annotation is not intended for general use and does not improve
the performance of your scripts.

<!-- document id=3bfc0d7bce5b24e531b27e10b38eabf3af8f26a176e0b7e349df4a89ec47a9a3 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-variables.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# DataWeave Variables

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave is a functional programming language in which variables behave just like functions.
DataWeave uses eager evaluation for variables and function parameters. In addition, DataWeave
variables are immutable.

A variable is assigned a value, which is either a constant (such as `var msg = "hello"`) or a lambda
expression such as `() → "hello"`.

## DataWeave Variable Assignment

Here are some examples of DataWeave 2.0 variable assignments:

Example: Variable Assignment in a DataWeave Script

```dataweave
%dw 2.0
output application/json
var msg = "Hello"

var msg2 = (x = "ignore") -> "hello"

var toUpper = (aString) -> upper(aString)

var combined = (function, msg="universe") -> function(msg ++ " WORLD")
---
[
   msg: msg,
   msg2: msg2(),
   toUpper: toUpper(msg),
   combined: combined(toUpper, "hello"),
   combined2: combined(((x) -> lower(x) ++ " Today"), msg)
]
```

The previous script results in this output:

Example: Output

```json
[
  {
    "msg": "Hello"
  },
  {
    "msg2": "hello"
  },
  {
    "toUpper": "HELLO"
  },
  {
    "combined": "HELLO WORLD"
  },
  {
    "combined2": "hello world Today"
  }
]
```

In these examples:

- The `msg` var is assigned to a constant.

- `msg2` is assigned to an expression that maps to a constant, so `msg2()` behaves the same way as
  `msg`, without the `()`.

- The `toUpper` variable maps an input parameter to the DataWeave `upper` function. So it is used
  like a more traditional function in other languages as `toUpper(aString)`.

- The `combined` variable accepts a function as an input parameter, then applies that function name
  to the second `msg` argument. The second `msg` argument is optional because a default value
  `universe` is specified.

The result of the expression `combined(toUpper, " world")` is to apply the `toUpper` function
defined earlier in the header to the `msg` parameter value `world`. The supplied second argument
`world` overrides the `msg="universe"` default value, so the result is `HELLO WORLD`. The expression
`combined(toUpper)`, which omits the second argument, uses the default `msg` value to return
`"combined": "UNIVERSE WORLD"`.

The `combined2: combined(x) → lower(x) ++ " Today", msg)` defines the lambda expression that you can
reuse in different contexts. In the example, `combined2` key defines the expression “in place” at
the time the function is called.

Note that these types of “in place” expressions are called closures in languages like JavaScript.

DataWeave includes syntactic sugar to make it easier to access lambda expressions that are assigned
to a variable as functions. To do this, you replace the `var` directive with the `fun` directive,
and replace the arrow `→` in the lambda expression with an equal sign (`=`). You also move the
lambda expression arguments next to the function name so the syntax looks like a function
declaration in other procedural programming languages. This enables you to use variables as if they
were functions. So the previous example can be equivalently written as:

```dataweave
%dw 2.0
output application/json
var msg = "Hello"

var toUpper = (aString) -> upper(aString)
var toLower = (aString) -> lower(aString)

fun msg2(optParm = "ignore") = "hello"

fun toTitle(text: String) = toLower(text[0]) ++ toUpper(text[1 to -1])

fun combined(function, msg="universe") = function(msg ++ " world")
---
[
   msg: msg,
   msg2: msg2(),
   toUpper: toTitle(msg),
   combined: combined(toUpper, msg),
   combined2: combined((x) -> lower(x) ++ " today", msg)
]
```

This example produces the same result:

```json
[
  {
    "msg": "Hello"
  },
  {
    "msg2": "hello"
  },
  {
    "toUpper": "hELLO"
  },
  {
    "combined": "HELLO WORLD"
  },
  {
    "combined2": "hello world today"
  }
]
```

The important distinction in DataWeave is that functions are variables, and every function is just a
syntactical renaming of the underlying `var` syntax, which allows you to pass function names or
lambda expressions as arguments to other functions. The `fun` syntax allows you to access the
powerful functional programming aspects of DataWeave while also being able to write simpler
expressions as function calls you might be more familiar with.

Also notice that DataWeave variables (and functions) can specify any number of optional arguments by
providing default values, so long as all those optional arguments are last in the argument list.

## Example: Declare an Array Variable and Transform its Elements

Variables are immutable in DataWeave, however you can iterate over an array variable and apply a
transformation to its elements, which can then be assigned to new variables. The following example
declares two array variables, iterates over them to transform their elements, and then declares an
object containing two new arrays with the transformed elements:

DataWeave Source:

```dataweave
%dw 2.0
import * from dw::core::Strings
output application/json
var numberArray = [1,2,3,4,5,6]
var stringArray = ["max", "astro", "einstein"]
---
{
  "numberArrayUpdated" : numberArray map ((value, index) -> value * value),
  "stringArrayUpdated" : stringArray map ((value, index) -> index ++ " - " ++ capitalize(value))
}
```

Output:

```json
{
  "numberArrayUpdated": [1, 4, 9, 16, 25, 36],
  "stringArrayUpdated": ["0 - Max", "1 - Astro", "2 - Einstein"]
}
```

## Naming Rules for Variables

You can declare any variable name that is a valid identifier. See
[Rules for Declaring Valid Identifiers](https://docs.mulesoft.com/dataweave/2.4/dataweave-language-introduction#valid-identifiers) for more
details.

## Variable Scopes

You can initialize and use both global and local variables in DataWeave scripts.

- Global variables are initialized in the header of the DataWeave script and can be referenced by
  name from anywhere in the body of a DataWeave script.

  The header of a DataWeave script accepts a `var` directive that initializes a variable, for
  example: `var language='Español'`. You can declare multiple global variables on separate lines in
  the header.

- Local variables are initialized in the body of the DataWeave script and can be referenced by name
  only from within the scope of the expression where they are initialized.

  The syntax for initializing a local variable looks like this:

  ```dataweave
  do {
        [type <name> = <type expression>]*
        [var <name> = <expression>]*
        [fun <name>(<params>*) = <expression>]*
        [ns <name> <nsUri>]*
        ---
        <body>
  }
  ```

Note that DataWeave variables cannot be reassigned. They are also distinct from variables that are
part of the Mule message (such as target variables). DataWeave variables do not persist beyond the
scope of the script in which they are initialized.

## Example: Global DataWeave Variables

This example defines a `do` operation that initializes a `language` variable with the constant value
`Español` and returns that constant value. The body of the DataWeave script calls the `do` operation
using the variable `myVar`, which populates the `<language/>` element in the XML output with the
value `Español`.

Transform

```dataweave
%dw 2.0
output application/xml
var myVar = do {
    var language = "Español"
    ---
    language
}
---
{
  document: {
    language: myVar,
    text: "Hola mundo"
  }
}
```

Output

```xml
<?xml version='1.0' encoding='UTF-8'?>
<document>
  <language>Español</language>
  <text>Hola mundo</text>
</document>
```

## Example: Local DataWeave Variables

To initialize local variables, you can use either literal expressions, variable reference
expressions, or functional expressions. These expressions can reference any other local variables
within their scope or any input or global variables.

As a best practice, declare local variables within `do` scopes (see
[Flow Control in DataWeave](https://docs.mulesoft.com/dataweave/2.4/dataweave-flow-control#control_flow_do)). The alternative method of
declaring a scope with the `using` keyword is no longer recommended and available only to provide
compatibility.

You can only reference a local variable by name from within the scope of the expression that
initializes it. The declaration can be prepended to any literal expression. The literal delimits the
scope of the variable, so you cannot reference any variable outside of its scope.

The examples that follow show initialization of local variables.

Example: Scoped to a Simple Value

The following example sets the local variable `myVar` in a `do` scope. It calls `do` from the body
of the DataWeave script:

```dataweave
%dw 2.0
output application/json
---
do {
      var myVar = 2
      ---
      3 + myVar
}
```

The result is `5`.

Example: Scoped to an Array Literal

The following example sets the local variable `myVar` in a `do` scope and uses it to set the value
of the second element in the array to `2`:

```dataweave
%dw 2.0
output application/json
---
do {
      var myVar = 2
      ---
      [1, myVar, 3]
}
```

The result is `[ 1, 2, 3]`

Example: Scoped to the Object literal

In the following example, references to all the variables are valid. `fn` and `ln` are defined and
called within the `do` scope. The global `myVar` variable is also accessible from that scope.

```dataweave
%dw 2.0
var myVar = 1234
var myDo =  do {
    var fn = "Annie"
    var ln = "Point"
    ---
    {
      id : myVar,
      firstname : fn,
      lastname : ln
    }
}
output application/xml
---
{ person : myDo }
```

```xml
<?xml version='1.0' encoding='UTF-8'?>
<person>
  <id>1234</id>
  <firstname>Annie</firstname>
  <lastname>Point</lastname>
</person>
```

Example: **Invalid Reference** That Is Outside the Scope

The following example produces an error because `fromDoScope` is referenced from outside the scope
of `do`. As a consequence, the concatenation operation (`++`) cannot append the name-value pair to
the collection.

```dataweave
%dw 2.0
var myVar = 1234
var myDo =  do {
    var fn = "Annie"
    var ln = "Point"
    var fromDoScope = "Platform"
    ---
    {
      id : myVar,
      firstname : fn,
      lastname : ln
    }
}
output application/xml
---
{
    person : myDo ++ { "outsideDoScope" : fromDoScope }
}
```

The invalid example returns this error: `Unable to resolve reference of fromDoScope.`

Example: Reference That Is Inside a Function

The following example passes the string `HELLO` to the `test` function defined in the header. The
`do` scope accepts the string, converts it to lowercase, and then concatenates that string to the
`suffix` variable, which is also defined in the header of the scope.

```dataweave
%dw 2.0
fun test(param1: String) = do {
    var suffix = "123"
    fun innerTest(str: String) = lower(str)
   ---
   innerTest(param1 ++ suffix)
}
output application/json
---
test("HELLO")
```

The result is `"hello123"`.

## Variables Assigned as Lambda Expressions

When a variable is assigned a lambda expression, it behaves just like a function. Like a function,
the lambda expression for a variable assignment can include parameters that can be used in the
right-hand side expression, such as `(string) → upper(string)`, which will convert any string to
uppercase.

Other variables can also be passed as arguments to another variable’s lambda expression. This
example shows how the `toUpper` variable’s lambda expression can be passed by name into the
`addSuffix` variable’s lambda expression.

```dataweave
%dw 2.0
output application/json
var toUpper = (aString) -> upper(aString)

var addSuffix = (msg, aFunction, suffix) -> aFunction(msg ++ suffix)
---
addSuffix("hello", toUpper, " world") //result is "HELLO WORLD"
```

## @Lazy() Annotation

When you are writing a DataWeave script in Studio, you might see the internal annotation `@Lazy()`
in autocompletion suggestions. This annotation is not intended for general use and does not improve
the performance of your scripts.

<!-- document id=f338d4ac5bfa1ab3fe97bf406b40f824bc060d69bb243a1712c7d753d7918d0d url=/mulesoft/current/en-us/dataweave/2.6/dataweave-variables.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# DataWeave Variables

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave is a functional programming language in which variables behave just like functions.
DataWeave uses eager evaluation for variables and function parameters. In addition, DataWeave
variables are immutable.

A variable is assigned a value, which is either a constant (such as `var msg = "hello"`) or a lambda
expression such as `() → "hello"`.

## DataWeave Variable Assignment

Here are some examples of DataWeave 2.0 variable assignments:

Example: Variable Assignment in a DataWeave Script

```dataweave
%dw 2.0
output application/json
var msg = "Hello"

var msg2 = (x = "ignore") -> "hello"

var toUpper = (aString) -> upper(aString)

var combined = (function, msg="universe") -> function(msg ++ " WORLD")
---
[
   msg: msg,
   msg2: msg2(),
   toUpper: toUpper(msg),
   combined: combined(toUpper, "hello"),
   combined2: combined(((x) -> lower(x) ++ " Today"), msg)
]
```

The previous script results in this output:

Example: Output

```json
[
  {
    "msg": "Hello"
  },
  {
    "msg2": "hello"
  },
  {
    "toUpper": "HELLO"
  },
  {
    "combined": "HELLO WORLD"
  },
  {
    "combined2": "hello world Today"
  }
]
```

In these examples:

- The `msg` var is assigned to a constant.

- `msg2` is assigned to an expression that maps to a constant, so `msg2()` behaves the same way as
  `msg`, without the `()`.

- The `toUpper` variable maps an input parameter to the DataWeave `upper` function. So it is used
  like a more traditional function in other languages as `toUpper(aString)`.

- The `combined` variable accepts a function as an input parameter, then applies that function name
  to the second `msg` argument. The second `msg` argument is optional because a default value
  `universe` is specified.

The result of the expression `combined(toUpper, " world")` is to apply the `toUpper` function
defined earlier in the header to the `msg` parameter value `world`. The supplied second argument
`world` overrides the `msg="universe"` default value, so the result is `HELLO WORLD`. The expression
`combined(toUpper)`, which omits the second argument, uses the default `msg` value to return
`"combined": "UNIVERSE WORLD"`.

The `combined2: combined(x) → lower(x) ++ " Today", msg)` defines the lambda expression that you can
reuse in different contexts. In the example, `combined2` key defines the expression “in place” at
the time the function is called.

Note that these types of “in place” expressions are called closures in languages like JavaScript.

DataWeave includes syntactic sugar to make it easier to access lambda expressions that are assigned
to a variable as functions. To do this, you replace the `var` directive with the `fun` directive,
and replace the arrow `→` in the lambda expression with an equal sign (`=`). You also move the
lambda expression arguments next to the function name so the syntax looks like a function
declaration in other procedural programming languages. This enables you to use variables as if they
were functions. So the previous example can be equivalently written as:

```dataweave
%dw 2.0
output application/json
var msg = "Hello"

var toUpper = (aString) -> upper(aString)
var toLower = (aString) -> lower(aString)

fun msg2(optParm = "ignore") = "hello"

fun toTitle(text: String) = toLower(text[0]) ++ toUpper(text[1 to -1])

fun combined(function, msg="universe") = function(msg ++ " world")
---
[
   msg: msg,
   msg2: msg2(),
   toUpper: toTitle(msg),
   combined: combined(toUpper, msg),
   combined2: combined((x) -> lower(x) ++ " today", msg)
]
```

This example produces the same result:

```json
[
  {
    "msg": "Hello"
  },
  {
    "msg2": "hello"
  },
  {
    "toUpper": "hELLO"
  },
  {
    "combined": "HELLO WORLD"
  },
  {
    "combined2": "hello world today"
  }
]
```

The important distinction in DataWeave is that functions are variables, and every function is just a
syntactical renaming of the underlying `var` syntax, which allows you to pass function names or
lambda expressions as arguments to other functions. The `fun` syntax allows you to access the
powerful functional programming aspects of DataWeave while also being able to write simpler
expressions as function calls you might be more familiar with.

Also notice that DataWeave variables (and functions) can specify any number of optional arguments by
providing default values, so long as all those optional arguments are last in the argument list.

## Example: Declare an Array Variable and Transform its Elements

Variables are immutable in DataWeave, however you can iterate over an array variable and apply a
transformation to its elements, which can then be assigned to new variables. The following example
declares two array variables, iterates over them to transform their elements, and then declares an
object containing two new arrays with the transformed elements:

DataWeave Source:

```dataweave
%dw 2.0
import * from dw::core::Strings
output application/json
var numberArray = [1,2,3,4,5,6]
var stringArray = ["max", "astro", "einstein"]
---
{
  "numberArrayUpdated" : numberArray map ((value, index) -> value * value),
  "stringArrayUpdated" : stringArray map ((value, index) -> index ++ " - " ++ capitalize(value))
}
```

Output:

```json
{
  "numberArrayUpdated": [1, 4, 9, 16, 25, 36],
  "stringArrayUpdated": ["0 - Max", "1 - Astro", "2 - Einstein"]
}
```

## Naming Rules for Variables

You can declare any variable name that is a valid identifier. See
[Rules for Declaring Valid Identifiers](https://docs.mulesoft.com/dataweave/2.6/dataweave-language-introduction#valid-identifiers) for more
details.

## Variable Scopes

You can initialize and use both global and local variables in DataWeave scripts.

- Global variables are initialized in the header of the DataWeave script and can be referenced by
  name from anywhere in the body of a DataWeave script.

  The header of a DataWeave script accepts a `var` directive that initializes a variable, for
  example: `var language='Español'`. You can declare multiple global variables on separate lines in
  the header.

- Local variables are initialized in the body of the DataWeave script and can be referenced by name
  only from within the scope of the expression where they are initialized.

  The syntax for initializing a local variable looks like this:

  ```dataweave
  do {
        [type <name> = <type expression>]*
        [var <name> = <expression>]*
        [fun <name>(<params>*) = <expression>]*
        [ns <name> <nsUri>]*
        ---
        <body>
  }
  ```

Note that DataWeave variables cannot be reassigned. They are also distinct from variables that are
part of the Mule message (such as target variables). DataWeave variables do not persist beyond the
scope of the script in which they are initialized.

## Example: Global DataWeave Variables

This example defines a `do` operation that initializes a `language` variable with the constant value
`Español` and returns that constant value. The body of the DataWeave script calls the `do` operation
using the variable `myVar`, which populates the `<language/>` element in the XML output with the
value `Español`.

Transform

```dataweave
%dw 2.0
output application/xml
var myVar = do {
    var language = "Español"
    ---
    language
}
---
{
  document: {
    language: myVar,
    text: "Hola mundo"
  }
}
```

Output

```xml
<?xml version='1.0' encoding='UTF-8'?>
<document>
  <language>Español</language>
  <text>Hola mundo</text>
</document>
```

## Example: Local DataWeave Variables

To initialize local variables, you can use either literal expressions, variable reference
expressions, or functional expressions. These expressions can reference any other local variables
within their scope or any input or global variables.

As a best practice, declare local variables within `do` scopes (see
[Flow Control in DataWeave](https://docs.mulesoft.com/dataweave/2.6/dataweave-flow-control#control_flow_do)). The alternative method of
declaring a scope with the `using` keyword is no longer recommended and available only to provide
compatibility.

You can only reference a local variable by name from within the scope of the expression that
initializes it. The declaration can be prepended to any literal expression. The literal delimits the
scope of the variable, so you cannot reference any variable outside of its scope.

The examples that follow show initialization of local variables.

Example: Scoped to a Simple Value

The following example sets the local variable `myVar` in a `do` scope. It calls `do` from the body
of the DataWeave script:

```dataweave
%dw 2.0
output application/json
---
do {
      var myVar = 2
      ---
      3 + myVar
}
```

The result is `5`.

Example: Scoped to an Array Literal

The following example sets the local variable `myVar` in a `do` scope and uses it to set the value
of the second element in the array to `2`:

```dataweave
%dw 2.0
output application/json
---
do {
      var myVar = 2
      ---
      [1, myVar, 3]
}
```

The result is `[ 1, 2, 3]`

Example: Scoped to the Object literal

In the following example, references to all the variables are valid. `fn` and `ln` are defined and
called within the `do` scope. The global `myVar` variable is also accessible from that scope.

```dataweave
%dw 2.0
var myVar = 1234
var myDo =  do {
    var fn = "Annie"
    var ln = "Point"
    ---
    {
      id : myVar,
      firstname : fn,
      lastname : ln
    }
}
output application/xml
---
{ person : myDo }
```

```xml
<?xml version='1.0' encoding='UTF-8'?>
<person>
  <id>1234</id>
  <firstname>Annie</firstname>
  <lastname>Point</lastname>
</person>
```

Example: **Invalid Reference** That Is Outside the Scope

The following example produces an error because `fromDoScope` is referenced from outside the scope
of `do`. As a consequence, the concatenation operation (`++`) cannot append the name-value pair to
the collection.

```dataweave
%dw 2.0
var myVar = 1234
var myDo =  do {
    var fn = "Annie"
    var ln = "Point"
    var fromDoScope = "Platform"
    ---
    {
      id : myVar,
      firstname : fn,
      lastname : ln
    }
}
output application/xml
---
{
    person : myDo ++ { "outsideDoScope" : fromDoScope }
}
```

The invalid example returns this error: `Unable to resolve reference of fromDoScope.`

Example: Reference That Is Inside a Function

The following example passes the string `HELLO` to the `test` function defined in the header. The
`do` scope accepts the string, converts it to lowercase, and then concatenates that string to the
`suffix` variable, which is also defined in the header of the scope.

```dataweave
%dw 2.0
fun test(param1: String) = do {
    var suffix = "123"
    fun innerTest(str: String) = lower(str)
   ---
   innerTest(param1 ++ suffix)
}
output application/json
---
test("HELLO")
```

The result is `"hello123"`.

## Variables Assigned as Lambda Expressions

When a variable is assigned a lambda expression, it behaves just like a function. Like a function,
the lambda expression for a variable assignment can include parameters that can be used in the
right-hand side expression, such as `(string) → upper(string)`, which will convert any string to
uppercase.

Other variables can also be passed as arguments to another variable’s lambda expression. This
example shows how the `toUpper` variable’s lambda expression can be passed by name into the
`addSuffix` variable’s lambda expression.

```dataweave
%dw 2.0
output application/json
var toUpper = (aString) -> upper(aString)

var addSuffix = (msg, aFunction, suffix) -> aFunction(msg ++ suffix)
---
addSuffix("hello", toUpper, " world") //result is "HELLO WORLD"
```

## @Lazy() Annotation

When you are writing a DataWeave script in Studio, you might see the internal annotation `@Lazy()`
in autocompletion suggestions. This annotation is not intended for general use and does not improve
the performance of your scripts.

<!-- document id=3106b850dab43593f3d82bf53fbb4728355de28402c43020d0df81b2113552ee url=/mulesoft/current/en-us/dataweave/2.9/dataweave-variables.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# DataWeave Variables

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave is a functional programming language in which variables behave just like functions.
DataWeave uses eager evaluation for variables and function parameters. In addition, DataWeave
variables are immutable.

A variable is assigned a value, which is either a constant (such as `var msg = "hello"`) or a lambda
expression such as `() → "hello"`.

## DataWeave Variable Assignment

Here are some examples of DataWeave 2.0 variable assignments:

Example: Variable Assignment in a DataWeave Script

```dataweave
%dw 2.0
output application/json
var msg = "Hello"

var msg2 = (x = "ignore") -> "hello"

var toUpper = (aString) -> upper(aString)

var combined = (function, msg="universe") -> function(msg ++ " WORLD")
---
[
   msg: msg,
   msg2: msg2(),
   toUpper: toUpper(msg),
   combined: combined(toUpper, "hello"),
   combined2: combined(((x) -> lower(x) ++ " Today"), msg)
]
```

The previous script results in this output:

Example: Output

```json
[
  {
    "msg": "Hello"
  },
  {
    "msg2": "hello"
  },
  {
    "toUpper": "HELLO"
  },
  {
    "combined": "HELLO WORLD"
  },
  {
    "combined2": "hello world Today"
  }
]
```

In these examples:

- The `msg` var is assigned to a constant.

- `msg2` is assigned to an expression that maps to a constant, so `msg2()` behaves the same way as
  `msg`, without the `()`.

- The `toUpper` variable maps an input parameter to the DataWeave `upper` function. So it is used
  like a more traditional function in other languages as `toUpper(aString)`.

- The `combined` variable accepts a function as an input parameter, then applies that function name
  to the second `msg` argument. The second `msg` argument is optional because a default value
  `universe` is specified.

The result of the expression `combined(toUpper, " world")` is to apply the `toUpper` function
defined earlier in the header to the `msg` parameter value `world`. The supplied second argument
`world` overrides the `msg="universe"` default value, so the result is `HELLO WORLD`. The expression
`combined(toUpper)`, which omits the second argument, uses the default `msg` value to return
`"combined": "UNIVERSE WORLD"`.

The `combined2: combined(x) → lower(x) ++ " Today", msg)` defines the lambda expression that you can
reuse in different contexts. In the example, `combined2` key defines the expression “in place” at
the time the function is called.

Note that these types of “in place” expressions are called closures in languages like JavaScript.

DataWeave includes syntactic sugar to make it easier to access lambda expressions that are assigned
to a variable as functions. To do this, you replace the `var` directive with the `fun` directive,
and replace the arrow `→` in the lambda expression with an equal sign (`=`). You also move the
lambda expression arguments next to the function name so the syntax looks like a function
declaration in other procedural programming languages. This enables you to use variables as if they
were functions. So the previous example can be equivalently written as:

```dataweave
%dw 2.0
output application/json
var msg = "Hello"

var toUpper = (aString) -> upper(aString)
var toLower = (aString) -> lower(aString)

fun msg2(optParm = "ignore") = "hello"

fun toTitle(text: String) = toLower(text[0]) ++ toUpper(text[1 to -1])

fun combined(function, msg="universe") = function(msg ++ " world")
---
[
   msg: msg,
   msg2: msg2(),
   toUpper: toTitle(msg),
   combined: combined(toUpper, msg),
   combined2: combined((x) -> lower(x) ++ " today", msg)
]
```

This example produces the same result:

```json
[
  {
    "msg": "Hello"
  },
  {
    "msg2": "hello"
  },
  {
    "toUpper": "hELLO"
  },
  {
    "combined": "HELLO WORLD"
  },
  {
    "combined2": "hello world today"
  }
]
```

The important distinction in DataWeave is that functions are variables, and every function is just a
syntactical renaming of the underlying `var` syntax, which allows you to pass function names or
lambda expressions as arguments to other functions. The `fun` syntax allows you to access the
powerful functional programming aspects of DataWeave while also being able to write simpler
expressions as function calls you might be more familiar with.

Also notice that DataWeave variables (and functions) can specify any number of optional arguments by
providing default values, so long as all those optional arguments are last in the argument list.

## Example: Declare an Array Variable and Transform its Elements

Variables are immutable in DataWeave, however you can iterate over an array variable and apply a
transformation to its elements, which can then be assigned to new variables. The following example
declares two array variables, iterates over them to transform their elements, and then declares an
object containing two new arrays with the transformed elements:

DataWeave Source:

```dataweave
%dw 2.0
import * from dw::core::Strings
output application/json
var numberArray = [1,2,3,4,5,6]
var stringArray = ["max", "astro", "einstein"]
---
{
  "numberArrayUpdated" : numberArray map ((value, index) -> value * value),
  "stringArrayUpdated" : stringArray map ((value, index) -> index ++ " - " ++ capitalize(value))
}
```

Output:

```json
{
  "numberArrayUpdated": [1, 4, 9, 16, 25, 36],
  "stringArrayUpdated": ["0 - Max", "1 - Astro", "2 - Einstein"]
}
```

## Naming Rules for Variables

You can declare any variable name that is a valid identifier. See
[Rules for Declaring Valid Identifiers](https://docs.mulesoft.com/dataweave/2.9/dataweave-language-introduction#valid-identifiers) for more
details.

## Variable Scopes

You can initialize and use both global and local variables in DataWeave scripts.

- Global variables are initialized in the header of the DataWeave script and can be referenced by
  name from anywhere in the body of a DataWeave script.

  The header of a DataWeave script accepts a `var` directive that initializes a variable, for
  example: `var language='Español'`. You can declare multiple global variables on separate lines in
  the header.

- Local variables are initialized in the body of the DataWeave script and can be referenced by name
  only from within the scope of the expression where they are initialized.

  The syntax for initializing a local variable looks like this:

  ```dataweave
  do {
        [type <name> = <type expression>]*
        [var <name> = <expression>]*
        [fun <name>(<params>*) = <expression>]*
        [ns <name> <nsUri>]*
        ---
        <body>
  }
  ```

Note that DataWeave variables cannot be reassigned. They are also distinct from variables that are
part of the Mule message (such as target variables). DataWeave variables do not persist beyond the
scope of the script in which they are initialized.

## Example: Global DataWeave Variables

This example defines a `do` operation that initializes a `language` variable with the constant value
`Español` and returns that constant value. The body of the DataWeave script calls the `do` operation
using the variable `myVar`, which populates the `<language/>` element in the XML output with the
value `Español`.

Transform

```dataweave
%dw 2.0
output application/xml
var myVar = do {
    var language = "Español"
    ---
    language
}
---
{
  document: {
    language: myVar,
    text: "Hola mundo"
  }
}
```

Output

```xml
<?xml version='1.0' encoding='UTF-8'?>
<document>
  <language>Español</language>
  <text>Hola mundo</text>
</document>
```

## Example: Local DataWeave Variables

To initialize local variables, you can use either literal expressions, variable reference
expressions, or functional expressions. These expressions can reference any other local variables
within their scope or any input or global variables.

As a best practice, declare local variables within `do` scopes (see
[Flow Control in DataWeave](https://docs.mulesoft.com/dataweave/2.9/dataweave-flow-control#control_flow_do)). The alternative method of
declaring a scope with the `using` keyword is no longer recommended and available only to provide
compatibility.

You can only reference a local variable by name from within the scope of the expression that
initializes it. The declaration can be prepended to any literal expression. The literal delimits the
scope of the variable, so you cannot reference any variable outside of its scope.

The examples that follow show initialization of local variables.

Example: Scoped to a Simple Value

The following example sets the local variable `myVar` in a `do` scope. It calls `do` from the body
of the DataWeave script:

```dataweave
%dw 2.0
output application/json
---
do {
      var myVar = 2
      ---
      3 + myVar
}
```

The result is `5`.

Example: Scoped to an Array Literal

The following example sets the local variable `myVar` in a `do` scope and uses it to set the value
of the second element in the array to `2`:

```dataweave
%dw 2.0
output application/json
---
do {
      var myVar = 2
      ---
      [1, myVar, 3]
}
```

The result is `[ 1, 2, 3]`

Example: Scoped to the Object literal

In the following example, references to all the variables are valid. `fn` and `ln` are defined and
called within the `do` scope. The global `myVar` variable is also accessible from that scope.

```dataweave
%dw 2.0
var myVar = 1234
var myDo =  do {
    var fn = "Annie"
    var ln = "Point"
    ---
    {
      id : myVar,
      firstname : fn,
      lastname : ln
    }
}
output application/xml
---
{ person : myDo }
```

```xml
<?xml version='1.0' encoding='UTF-8'?>
<person>
  <id>1234</id>
  <firstname>Annie</firstname>
  <lastname>Point</lastname>
</person>
```

Example: **Invalid Reference** That Is Outside the Scope

The following example produces an error because `fromDoScope` is referenced from outside the scope
of `do`. As a consequence, the concatenation operation (`++`) cannot append the name-value pair to
the collection.

```dataweave
%dw 2.0
var myVar = 1234
var myDo =  do {
    var fn = "Annie"
    var ln = "Point"
    var fromDoScope = "Platform"
    ---
    {
      id : myVar,
      firstname : fn,
      lastname : ln
    }
}
output application/xml
---
{
    person : myDo ++ { "outsideDoScope" : fromDoScope }
}
```

The invalid example returns this error: `Unable to resolve reference of fromDoScope.`

Example: Reference That Is Inside a Function

The following example passes the string `HELLO` to the `test` function defined in the header. The
`do` scope accepts the string, converts it to lowercase, and then concatenates that string to the
`suffix` variable, which is also defined in the header of the scope.

```dataweave
%dw 2.0
fun test(param1: String) = do {
    var suffix = "123"
    fun innerTest(str: String) = lower(str)
   ---
   innerTest(param1 ++ suffix)
}
output application/json
---
test("HELLO")
```

The result is `"hello123"`.

## Variables Assigned as Lambda Expressions

When a variable is assigned a lambda expression, it behaves just like a function. Like a function,
the lambda expression for a variable assignment can include parameters that can be used in the
right-hand side expression, such as `(string) → upper(string)`, which will convert any string to
uppercase.

Other variables can also be passed as arguments to another variable’s lambda expression. This
example shows how the `toUpper` variable’s lambda expression can be passed by name into the
`addSuffix` variable’s lambda expression.

```dataweave
%dw 2.0
output application/json
var toUpper = (aString) -> upper(aString)

var addSuffix = (msg, aFunction, suffix) -> aFunction(msg ++ suffix)
---
addSuffix("hello", toUpper, " world") //result is "HELLO WORLD"
```

## @Lazy() Annotation

When you are writing a DataWeave script in Studio, you might see the internal annotation `@Lazy()`
in autocompletion suggestions. This annotation is not intended for general use and does not improve
the performance of your scripts.

<!-- document id=b8fefbf86e1940473e3772888b103308e1eec052d5d59e1cfae5e12b9f9cf8f0 url=/mulesoft/current/en-us/dataweave/latest/dataweave-variables.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# DataWeave Variables

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave is a functional programming language in which variables behave just like functions.
DataWeave uses eager evaluation for variables and function parameters. In addition, DataWeave
variables are immutable. A variable is assigned a value, which is either a constant (such as
`var msg = "hello"`) or a lambda expression such as `() → "hello"`.

## DataWeave Variable Assignment

Here are some examples of DataWeave 2.0 variable assignments:

Example: Variable Assignment in a DataWeave Script

```dataweave
%dw 2.0
output application/json
var msg = "Hello"

var msg2 = (x = "ignore") -> "hello"

var toUpper = (aString) -> upper(aString)

var combined = (function, msg="universe") -> function(msg ++ " WORLD")
---
[
   msg: msg,
   msg2: msg2(),
   toUpper: toUpper(msg),
   combined: combined(toUpper, "hello"),
   combined2: combined(((x) -> lower(x) ++ " Today"), msg)
]
```

The previous script results in this output:

Example: Output

```json
[
  {
    "msg": "Hello"
  },
  {
    "msg2": "hello"
  },
  {
    "toUpper": "HELLO"
  },
  {
    "combined": "HELLO WORLD"
  },
  {
    "combined2": "hello world Today"
  }
]
```

In these examples:

- The `msg` var is assigned to a constant.

- `msg2` is assigned to an expression that maps to a constant, so `msg2()` behaves the same way as
  `msg`, without the `()`.

- The `toUpper` variable maps an input parameter to the DataWeave `upper` function. So it is used
  like a more traditional function in other languages as `toUpper(aString)`.

- The `combined` variable accepts a function as an input parameter, then applies that function name
  to the second `msg` argument. The second `msg` argument is optional because a default value
  `universe` is specified.

The result of the expression `combined(toUpper, " world")` is to apply the `toUpper` function
defined earlier in the header to the `msg` parameter value `world`. The supplied second argument
`world` overrides the `msg="universe"` default value, so the result is `HELLO WORLD`. The expression
`combined(toUpper)`, which omits the second argument, uses the default `msg` value to return
`"combined": "UNIVERSE WORLD"`.

The `combined2: combined(x) → lower(x) ++ " Today", msg)` defines the lambda expression that you can
reuse in different contexts. In the example, `combined2` key defines the expression “in place” at
the time the function is called.

Note that these types of “in place” expressions are called closures in languages like JavaScript.

DataWeave includes syntactic sugar to make it easier to access lambda expressions that are assigned
to a variable as functions. To do this, you replace the `var` directive with the `fun` directive,
and replace the arrow `→` in the lambda expression with an equal sign (`=`). You also move the
lambda expression arguments next to the function name so the syntax looks like a function
declaration in other procedural programming languages. This enables you to use variables as if they
were functions. So the previous example can be equivalently written as:

```dataweave
%dw 2.0
output application/json
var msg = "Hello"

var toUpper = (aString) -> upper(aString)
var toLower = (aString) -> lower(aString)

fun msg2(optParm = "ignore") = "hello"

fun toTitle(text: String) = toLower(text[0]) ++ toUpper(text[1 to -1])

fun combined(function, msg="universe") = function(msg ++ " world")
---
[
   msg: msg,
   msg2: msg2(),
   toUpper: toTitle(msg),
   combined: combined(toUpper, msg),
   combined2: combined((x) -> lower(x) ++ " today", msg)
]
```

This example produces the same result:

```json
[
  {
    "msg": "Hello"
  },
  {
    "msg2": "hello"
  },
  {
    "toUpper": "hELLO"
  },
  {
    "combined": "HELLO WORLD"
  },
  {
    "combined2": "hello world today"
  }
]
```

The important distinction in DataWeave is that functions are variables, and every function is just a
syntactical renaming of the underlying `var` syntax, which allows you to pass function names or
lambda expressions as arguments to other functions. The `fun` syntax allows you to access the
powerful functional programming aspects of DataWeave while also being able to write simpler
expressions as function calls you might be more familiar with.

Also notice that DataWeave variables (and functions) can specify any number of optional arguments by
providing default values, so long as all those optional arguments are last in the argument list.

## Example: Declare an Array Variable and Transform its Elements

Variables are immutable in DataWeave, however you can iterate over an array variable and apply a
transformation to its elements, which can then be assigned to new variables. The following example
declares two array variables, iterates over them to transform their elements, and then declares an
object containing two new arrays with the transformed elements:

DataWeave Source:

```dataweave
%dw 2.0
import * from dw::core::Strings
output application/json
var numberArray = [1,2,3,4,5,6]
var stringArray = ["max", "astro", "einstein"]
---
{
  "numberArrayUpdated" : numberArray map ((value, index) -> value * value),
  "stringArrayUpdated" : stringArray map ((value, index) -> index ++ " - " ++ capitalize(value))
}
```

Output:

```json
{
  "numberArrayUpdated": [1, 4, 9, 16, 25, 36],
  "stringArrayUpdated": ["0 - Max", "1 - Astro", "2 - Einstein"]
}
```

## Naming Rules for Variables

You can declare any variable name that is a valid identifier. See
[Rules for Declaring Valid Identifiers](https://docs.mulesoft.com/dataweave/latest/dataweave-language-introduction#valid-identifiers) for more
details.

## Variable Scopes

You can initialize and use both global and local variables in DataWeave scripts.

- Global variables are initialized in the header of the DataWeave script and can be referenced by
  name from anywhere in the body of a DataWeave script.

  The header of a DataWeave script accepts a `var` directive that initializes a variable, for
  example: `var language='Español'`. You can declare multiple global variables on separate lines in
  the header.

- Local variables are initialized in the body of the DataWeave script and can be referenced by name
  only from within the scope of the expression where they are initialized.

  The syntax for initializing a local variable looks like this:

  ```dataweave
  do {
        [type <name> = <type expression>]*
        [var <name> = <expression>]*
        [fun <name>(<params>*) = <expression>]*
        [ns <name> <nsUri>]*
        ---
        <body>
  }
  ```

Note that DataWeave variables cannot be reassigned. They are also distinct from variables that are
part of the Mule message (such as target variables). DataWeave variables do not persist beyond the
scope of the script in which they are initialized.

## Example: Global DataWeave Variables

This example defines a `do` operation that initializes a `language` variable with the constant value
`Español` and returns that constant value. The body of the DataWeave script calls the `do` operation
using the variable `myVar`, which populates the `<language/>` element in the XML output with the
value `Español`.

Transform

```dataweave
%dw 2.0
output application/xml
var myVar = do {
    var language = "Español"
    ---
    language
}
---
{
  document: {
    language: myVar,
    text: "Hola mundo"
  }
}
```

Output

```xml
<?xml version='1.0' encoding='UTF-8'?>
<document>
  <language>Español</language>
  <text>Hola mundo</text>
</document>
```

## Example: Local DataWeave Variables

To initialize local variables, you can use either literal expressions, variable reference
expressions, or functional expressions. These expressions can reference any other local variables
within their scope or any input or global variables.

As a best practice, declare local variables within `do` scopes (see
[Flow Control in DataWeave](https://docs.mulesoft.com/dataweave/latest/dataweave-flow-control#control_flow_do)). The alternative method of
declaring a scope with the `using` keyword is no longer recommended and available only to provide
compatibility.

You can only reference a local variable by name from within the scope of the expression that
initializes it. The declaration can be prepended to any literal expression. The literal delimits the
scope of the variable, so you cannot reference any variable outside of its scope.

The examples that follow show initialization of local variables.

Example: Scoped to a Simple Value

The following example sets the local variable `myVar` in a `do` scope. It calls `do` from the body
of the DataWeave script:

```dataweave
%dw 2.0
output application/json
---
do {
      var myVar = 2
      ---
      3 + myVar
}
```

The result is `5`.

Example: Scoped to an Array Literal

The following example sets the local variable `myVar` in a `do` scope and uses it to set the value
of the second element in the array to `2`:

```dataweave
%dw 2.0
output application/json
---
do {
      var myVar = 2
      ---
      [1, myVar, 3]
}
```

The result is `[ 1, 2, 3]`

Example: Scoped to the Object literal

In the following example, references to all the variables are valid. `fn` and `ln` are defined and
called within the `do` scope. The global `myVar` variable is also accessible from that scope.

```dataweave
%dw 2.0
var myVar = 1234
var myDo =  do {
    var fn = "Annie"
    var ln = "Point"
    ---
    {
      id : myVar,
      firstname : fn,
      lastname : ln
    }
}
output application/xml
---
{ person : myDo }
```

```xml
<?xml version='1.0' encoding='UTF-8'?>
<person>
  <id>1234</id>
  <firstname>Annie</firstname>
  <lastname>Point</lastname>
</person>
```

Example: **Invalid Reference** That Is Outside the Scope

The following example produces an error because `fromDoScope` is referenced from outside the scope
of `do`. As a consequence, the concatenation operation (`++`) cannot append the name-value pair to
the collection.

```dataweave
%dw 2.0
var myVar = 1234
var myDo =  do {
    var fn = "Annie"
    var ln = "Point"
    var fromDoScope = "Platform"
    ---
    {
      id : myVar,
      firstname : fn,
      lastname : ln
    }
}
output application/xml
---
{
    person : myDo ++ { "outsideDoScope" : fromDoScope }
}
```

The invalid example returns this error: `Unable to resolve reference of fromDoScope.`

Example: Reference That Is Inside a Function

The following example passes the string `HELLO` to the `test` function defined in the header. The
`do` scope accepts the string, converts it to lowercase, and then concatenates that string to the
`suffix` variable, which is also defined in the header of the scope.

```dataweave
%dw 2.0
fun test(param1: String) = do {
    var suffix = "123"
    fun innerTest(str: String) = lower(str)
   ---
   innerTest(param1 ++ suffix)
}
output application/json
---
test("HELLO")
```

The result is `"hello123"`.

## Variables Assigned as Lambda Expressions

When a variable is assigned a lambda expression, it behaves just like a function. Like a function,
the lambda expression for a variable assignment can include parameters that can be used in the
right-hand side expression, such as `(string) → upper(string)`, which will convert any string to
uppercase.

Other variables can also be passed as arguments to another variable’s lambda expression. This
example shows how the `toUpper` variable’s lambda expression can be passed by name into the
`addSuffix` variable’s lambda expression.

```dataweave
%dw 2.0
output application/json
var toUpper = (aString) -> upper(aString)

var addSuffix = (msg, aFunction, suffix) -> aFunction(msg ++ suffix)
---
addSuffix("hello", toUpper, " world") //result is "HELLO WORLD"
```

## @Lazy() Annotation

When you are writing a DataWeave script in Studio, you might see the internal annotation `@Lazy()`
in autocompletion suggestions. This annotation is not intended for general use and does not improve
the performance of your scripts.

<!-- document id=5c7ab7328bffde01b49931a483ac54a7f11534ad14173cf1ba87efd2a81ee2e9 url=/mulesoft/current/en-us/dataweave/2.11/dw-dates-functions-date.md -->

---
product: DataWeave
version: 2.11
---

# date

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## date(parts: DateFactory): Date

Creates a `Date` value from values specified for `year`, `month`, and `day` fields.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>parts</code></p></td><td><div><div><p><code>Number</code> values for <code>year</code>, <code>month</code>, and <code>day</code> fields. The <code>month</code> must be a value between 1 and 12, and the <code>day</code> value must be between 1 and 31. You can specify the name-value pairs in any order, but the output is ordered by default as a Date value, such as <code>2012-10-11</code>. The input fields are parts of a <code>DateFactory</code> type.</p></div></div></td></tr></tbody></table>

### Example

This example shows how to create a value of type `Date`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
   newDate: date({year: 2012, month: 10, day: 11})
}
```

#### Output

```Json
{
   "newDate": "2012-10-11"
}
```

<!-- document id=0b13b17fcb355020fed2b91f514238aa5ed78ccea6dd490c1d1d7f082f397594 url=/mulesoft/current/en-us/dataweave/2.12/dw-dates-functions-date.md -->

---
product: DataWeave
version: 2.12
---

# date

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## date(parts: DateFactory): Date

Creates a `Date` value from values specified for `year`, `month`, and `day` fields.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>parts</code></p></td><td><div><div><p><code>Number</code> values for <code>year</code>, <code>month</code>, and <code>day</code> fields. The <code>month</code> must be a value between 1 and 12, and the <code>day</code> value must be between 1 and 31. You can specify the name-value pairs in any order, but the output is ordered by default as a Date value, such as <code>2012-10-11</code>. The input fields are parts of a <code>DateFactory</code> type.</p></div></div></td></tr></tbody></table>

### Example

This example shows how to create a value of type `Date`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
   newDate: date({year: 2012, month: 10, day: 11})
}
```

#### Output

```Json
{
   "newDate": "2012-10-11"
}
```

<!-- document id=5499622fac9353ae4e34865dfb7711757e97ee173dbbb64eccb51a90c7828ec0 url=/mulesoft/current/en-us/dataweave/2.4/dw-dates-functions-date.md -->

---
product: DataWeave
version: 2.4
---

# date

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## date(parts: DateFactory): Date

Creates a `Date` value from values specified for `year`, `month`, and `day` fields.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>parts</code></p></td><td><div><div><p><code>Number</code> values for <code>year</code>, <code>month</code>, and <code>day</code> fields. The <code>month</code> must be a value between 1 and 12, and the <code>day</code> value must be between 1 and 31. You can specify the name-value pairs in any order, but the output is ordered by default as a Date value, such as <code>2012-10-11</code>. The input fields are parts of a <code>DateFactory</code> type.</p></div></div></td></tr></tbody></table>

### Example

This example shows how to create a value of type `Date`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
   newDate: date({year: 2012, month: 10, day: 11})
}
```

#### Output

```Json
{
   "newDate": "2012-10-11"
}
```

<!-- document id=4cf194ba22f788fbfb1fafe6229f2b6898099dc9d83aab2317368e4e2a9a150b url=/mulesoft/current/en-us/dataweave/2.6/dw-dates-functions-date.md -->

---
product: DataWeave
version: 2.6
---

# date

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## date(parts: DateFactory): Date

Creates a `Date` value from values specified for `year`, `month`, and `day` fields.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>parts</code></p></td><td><div><div><p><code>Number</code> values for <code>year</code>, <code>month</code>, and <code>day</code> fields. The <code>month</code> must be a value between 1 and 12, and the <code>day</code> value must be between 1 and 31. You can specify the name-value pairs in any order, but the output is ordered by default as a Date value, such as <code>2012-10-11</code>. The input fields are parts of a <code>DateFactory</code> type.</p></div></div></td></tr></tbody></table>

### Example

This example shows how to create a value of type `Date`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
   newDate: date({year: 2012, month: 10, day: 11})
}
```

#### Output

```Json
{
   "newDate": "2012-10-11"
}
```

<!-- document id=7aa0fa156d5b315d0f0416a75bae78ac7827ac48df08642f6cc2f1de71e088ac url=/mulesoft/current/en-us/dataweave/2.9/dw-dates-functions-date.md -->

---
product: DataWeave
version: 2.9
---

# date

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## date(parts: DateFactory): Date

Creates a `Date` value from values specified for `year`, `month`, and `day` fields.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>parts</code></p></td><td><div><div><p><code>Number</code> values for <code>year</code>, <code>month</code>, and <code>day</code> fields. The <code>month</code> must be a value between 1 and 12, and the <code>day</code> value must be between 1 and 31. You can specify the name-value pairs in any order, but the output is ordered by default as a Date value, such as <code>2012-10-11</code>. The input fields are parts of a <code>DateFactory</code> type.</p></div></div></td></tr></tbody></table>

### Example

This example shows how to create a value of type `Date`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
   newDate: date({year: 2012, month: 10, day: 11})
}
```

#### Output

```Json
{
   "newDate": "2012-10-11"
}
```

<!-- document id=0e9fd4874816e1a372de817f062b4c92e82a63e0cd53b4cabf6593094b2e8b50 url=/mulesoft/current/en-us/dataweave/latest/dw-dates-functions-date.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# date

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## date(parts: DateFactory): Date

Creates a `Date` value from values specified for `year`, `month`, and `day` fields.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>parts</code></p></td><td><div><div><p><code>Number</code> values for <code>year</code>, <code>month</code>, and <code>day</code> fields. The <code>month</code> must be a value between 1 and 12, and the <code>day</code> value must be between 1 and 31. You can specify the name-value pairs in any order, but the output is ordered by default as a Date value, such as <code>2012-10-11</code>. The input fields are parts of a <code>DateFactory</code> type.</p></div></div></td></tr></tbody></table>

### Example

This example shows how to create a value of type `Date`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
   newDate: date({year: 2012, month: 10, day: 11})
}
```

#### Output

```Json
{
   "newDate": "2012-10-11"
}
```

<!-- document id=c3fa5615dd54ac649ab9a5635605e751bdf08e9e654d377f1f02757642a3b025 url=/mulesoft/current/en-us/dataweave/2.11/dw-dates.md -->

---
product: DataWeave
version: 2.11
---

# Dates (dw::core::Dates)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains functions for creating and manipulating dates.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Dates` to the header of your DataWeave script.

_Introduced in DataWeave version 2.4.0._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-dates-functions-atbeginningofday">atBeginningOfDay</a></p></td><td><p>Returns a new <code>DateTime</code> value that changes the <code>Time</code> value in the input to the beginning of the specified <em>day</em>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-dates-functions-atbeginningofhour">atBeginningOfHour</a></p></td><td><p>Returns a new <code>DateTime</code> value that changes the <code>Time</code> value in the input to the beginning of the specified <em>hour</em>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-dates-functions-atbeginningofmonth">atBeginningOfMonth</a></p></td><td><p>Returns a new <code>DateTime</code> value that changes the <code>Day</code> value from the input to the first day of the specified <em>month</em>. It also sets the <code>Time</code> value to <code>00:00:00</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-dates-functions-atbeginningofweek">atBeginningOfWeek</a></p></td><td><p>Returns a new <code>DateTime</code> value that changes the <code>Day</code> and <code>Time</code> values from the input to the beginning of the first day of the specified <em>week</em>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-dates-functions-atbeginningofyear">atBeginningOfYear</a></p></td><td><p>Takes a <code>DateTime</code> value as input and returns a <code>DateTime</code> value for the first day of the <em>year</em> specified in the input. It also sets the <code>Time</code> value to <code>00:00:00</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-dates-functions-date">date</a></p></td><td><p>Creates a <code>Date</code> value from values specified for <code>year</code>, <code>month</code>, and <code>day</code> fields.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-dates-functions-datetime">dateTime</a></p></td><td><p>Creates a <code>DateTime</code> value from values specified for <code>year</code>, <code>month</code>, <code>day</code>, <code>hour</code>, <code>minutes</code>, <code>seconds</code>, and <code>timezone</code> fields.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-dates-functions-localdatetime">localDateTime</a></p></td><td><p>Creates a <code>LocalDateTime</code> value from values specified for <code>year</code>, <code>month</code>, <code>day</code>, <code>hour</code>, <code>minutes</code>, and <code>seconds</code> fields.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-dates-functions-localtime">localTime</a></p></td><td><p>Creates a <code>LocalTime</code> value from values specified for <code>hour</code>, <code>minutes</code>, and <code>seconds</code> fields.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-dates-functions-time">time</a></p></td><td><p>Creates a <code>Time</code> value from values specified for <code>hour</code>, <code>minutes</code>, <code>seconds</code>, and <code>timezone</code> fields.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-dates-functions-today">today</a></p></td><td><p>Returns the date for today as a <code>Date</code> type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-dates-functions-tomorrow">tomorrow</a></p></td><td><p>Returns the date for tomorrow as a <code>Date</code> type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-dates-functions-yesterday">yesterday</a></p></td><td><p>Returns the date for yesterday as a <code>Date</code> type.</p></td></tr></tbody></table>

## Types

- [Dates Types](https://docs.mulesoft.com/dataweave/2.11/dw-dates-types)

<!-- document id=a45aa8848ba7610e5fe640d0bf7f123f73e303accbeeaf2508821d93f6470448 url=/mulesoft/current/en-us/dataweave/2.12/dw-dates.md -->

---
product: DataWeave
version: 2.12
---

# Dates (dw::core::Dates)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains functions for creating and manipulating dates.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Dates` to the header of your DataWeave script.

_Introduced in DataWeave version 2.4.0._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-dates-functions-atbeginningofday">atBeginningOfDay</a></p></td><td><p>Returns a new <code>DateTime</code> value that changes the <code>Time</code> value in the input to the beginning of the specified <em>day</em>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-dates-functions-atbeginningofhour">atBeginningOfHour</a></p></td><td><p>Returns a new <code>DateTime</code> value that changes the <code>Time</code> value in the input to the beginning of the specified <em>hour</em>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-dates-functions-atbeginningofmonth">atBeginningOfMonth</a></p></td><td><p>Returns a new <code>DateTime</code> value that changes the <code>Day</code> value from the input to the first day of the specified <em>month</em>. It also sets the <code>Time</code> value to <code>00:00:00</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-dates-functions-atbeginningofweek">atBeginningOfWeek</a></p></td><td><p>Returns a new <code>DateTime</code> value that changes the <code>Day</code> and <code>Time</code> values from the input to the beginning of the first day of the specified <em>week</em>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-dates-functions-atbeginningofyear">atBeginningOfYear</a></p></td><td><p>Takes a <code>DateTime</code> value as input and returns a <code>DateTime</code> value for the first day of the <em>year</em> specified in the input. It also sets the <code>Time</code> value to <code>00:00:00</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-dates-functions-date">date</a></p></td><td><p>Creates a <code>Date</code> value from values specified for <code>year</code>, <code>month</code>, and <code>day</code> fields.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-dates-functions-datetime">dateTime</a></p></td><td><p>Creates a <code>DateTime</code> value from values specified for <code>year</code>, <code>month</code>, <code>day</code>, <code>hour</code>, <code>minutes</code>, <code>seconds</code>, and <code>timezone</code> fields.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-dates-functions-localdatetime">localDateTime</a></p></td><td><p>Creates a <code>LocalDateTime</code> value from values specified for <code>year</code>, <code>month</code>, <code>day</code>, <code>hour</code>, <code>minutes</code>, and <code>seconds</code> fields.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-dates-functions-localtime">localTime</a></p></td><td><p>Creates a <code>LocalTime</code> value from values specified for <code>hour</code>, <code>minutes</code>, and <code>seconds</code> fields.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-dates-functions-time">time</a></p></td><td><p>Creates a <code>Time</code> value from values specified for <code>hour</code>, <code>minutes</code>, <code>seconds</code>, and <code>timezone</code> fields.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-dates-functions-today">today</a></p></td><td><p>Returns the date for today as a <code>Date</code> type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-dates-functions-tomorrow">tomorrow</a></p></td><td><p>Returns the date for tomorrow as a <code>Date</code> type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-dates-functions-yesterday">yesterday</a></p></td><td><p>Returns the date for yesterday as a <code>Date</code> type.</p></td></tr></tbody></table>

## Types

- [Dates Types](https://docs.mulesoft.com/dataweave/2.12/dw-dates-types)

<!-- document id=c3c823f07d556a6910addd1fd53a48436d8e4625c681775bbeb3ed0e95244fb0 url=/mulesoft/current/en-us/dataweave/2.4/dw-dates.md -->

---
product: DataWeave
version: 2.4
---

# Dates (dw::core::Dates)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains functions for creating and manipulating dates.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Dates` to the header of your DataWeave script.

_Introduced in DataWeave version 2.4.0._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-dates-functions-atbeginningofday">atBeginningOfDay</a></p></td><td><div><div><p>Returns a new <code>DateTime</code> value that changes the <code>Time</code> value in the input to the beginning of the specified <em>day</em>.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-dates-functions-atbeginningofhour">atBeginningOfHour</a></p></td><td><div><div><p>Returns a new <code>DateTime</code> value that changes the <code>Time</code> value in the input to the beginning of the specified <em>hour</em>.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-dates-functions-atbeginningofmonth">atBeginningOfMonth</a></p></td><td><div><div><p>Returns a new <code>DateTime</code> value that changes the <code>Day</code> value from the input to the first day of the specified <em>month</em>. It also sets the <code>Time</code> value to <code>00:00:00</code>.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-dates-functions-atbeginningofweek">atBeginningOfWeek</a></p></td><td><div><div><p>Returns a new <code>DateTime</code> value that changes the <code>Day</code> and <code>Time</code> values from the input to the beginning of the first day of the specified <em>week</em>.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-dates-functions-atbeginningofyear">atBeginningOfYear</a></p></td><td><div><div><p>Takes a <code>DateTime</code> value as input and returns a <code>DateTime</code> value for the first day of the <em>year</em> specified in the input. It also sets the <code>Time</code> value to <code>00:00:00</code>.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-dates-functions-date">date</a></p></td><td><div><div><p>Creates a <code>Date</code> value from values specified for <code>year</code>, <code>month</code>, and <code>day</code> fields.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-dates-functions-datetime">dateTime</a></p></td><td><div><div><p>Creates a <code>DateTime</code> value from values specified for <code>year</code>, <code>month</code>, <code>day</code>, <code>hour</code>, <code>minutes</code>, <code>seconds</code>, and <code>timezone</code> fields.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-dates-functions-localdatetime">localDateTime</a></p></td><td><div><div><p>Creates a <code>LocalDateTime</code> value from values specified for <code>year</code>, <code>month</code>, <code>day</code>, <code>hour</code>, <code>minutes</code>, and <code>seconds</code> fields.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-dates-functions-localtime">localTime</a></p></td><td><div><div><p>Creates a <code>LocalTime</code> value from values specified for <code>hour</code>, <code>minutes</code>, and <code>seconds</code> fields.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-dates-functions-time">time</a></p></td><td><div><div><p>Creates a <code>Time</code> value from values specified for <code>hour</code>, <code>minutes</code>, <code>seconds</code>, and <code>timezone</code> fields.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-dates-functions-today">today</a></p></td><td><div><div><p>Returns the date for today as a <code>Date</code> type.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-dates-functions-tomorrow">tomorrow</a></p></td><td><div><div><p>Returns the date for tomorrow as a <code>Date</code> type.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-dates-functions-yesterday">yesterday</a></p></td><td><div><div><p>Returns the date for yesterday as a <code>Date</code> type.</p></div></div></td></tr></tbody></table>

## Types

- [Dates Types](https://docs.mulesoft.com/dataweave/2.4/dw-dates-types)

<!-- document id=2c3b2d815e4b154a6ece432cf97081714c3aa6ff38e3ad13b69dfa6551bdfca8 url=/mulesoft/current/en-us/dataweave/2.6/dw-dates.md -->

---
product: DataWeave
version: 2.6
---

# Dates (dw::core::Dates)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains functions for creating and manipulating dates.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Dates` to the header of your DataWeave script.

_Introduced in DataWeave version 2.4.0._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-dates-functions-atbeginningofday">atBeginningOfDay</a></p></td><td><p>Returns a new <code>DateTime</code> value that changes the <code>Time</code> value in the input to the beginning of the specified <em>day</em>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-dates-functions-atbeginningofhour">atBeginningOfHour</a></p></td><td><p>Returns a new <code>DateTime</code> value that changes the <code>Time</code> value in the input to the beginning of the specified <em>hour</em>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-dates-functions-atbeginningofmonth">atBeginningOfMonth</a></p></td><td><p>Returns a new <code>DateTime</code> value that changes the <code>Day</code> value from the input to the first day of the specified <em>month</em>. It also sets the <code>Time</code> value to <code>00:00:00</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-dates-functions-atbeginningofweek">atBeginningOfWeek</a></p></td><td><p>Returns a new <code>DateTime</code> value that changes the <code>Day</code> and <code>Time</code> values from the input to the beginning of the first day of the specified <em>week</em>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-dates-functions-atbeginningofyear">atBeginningOfYear</a></p></td><td><p>Takes a <code>DateTime</code> value as input and returns a <code>DateTime</code> value for the first day of the <em>year</em> specified in the input. It also sets the <code>Time</code> value to <code>00:00:00</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-dates-functions-date">date</a></p></td><td><p>Creates a <code>Date</code> value from values specified for <code>year</code>, <code>month</code>, and <code>day</code> fields.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-dates-functions-datetime">dateTime</a></p></td><td><p>Creates a <code>DateTime</code> value from values specified for <code>year</code>, <code>month</code>, <code>day</code>, <code>hour</code>, <code>minutes</code>, <code>seconds</code>, and <code>timezone</code> fields.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-dates-functions-localdatetime">localDateTime</a></p></td><td><p>Creates a <code>LocalDateTime</code> value from values specified for <code>year</code>, <code>month</code>, <code>day</code>, <code>hour</code>, <code>minutes</code>, and <code>seconds</code> fields.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-dates-functions-localtime">localTime</a></p></td><td><p>Creates a <code>LocalTime</code> value from values specified for <code>hour</code>, <code>minutes</code>, and <code>seconds</code> fields.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-dates-functions-time">time</a></p></td><td><p>Creates a <code>Time</code> value from values specified for <code>hour</code>, <code>minutes</code>, <code>seconds</code>, and <code>timezone</code> fields.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-dates-functions-today">today</a></p></td><td><p>Returns the date for today as a <code>Date</code> type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-dates-functions-tomorrow">tomorrow</a></p></td><td><p>Returns the date for tomorrow as a <code>Date</code> type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-dates-functions-yesterday">yesterday</a></p></td><td><p>Returns the date for yesterday as a <code>Date</code> type.</p></td></tr></tbody></table>

## Types

- [Dates Types](https://docs.mulesoft.com/dataweave/2.6/dw-dates-types)

<!-- document id=6a73b25a6866aac1ab062254d1e5fddc1a2a8d6025c5944427daa1fad8d174b2 url=/mulesoft/current/en-us/dataweave/2.9/dw-dates.md -->

---
product: DataWeave
version: 2.9
---

# Dates (dw::core::Dates)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains functions for creating and manipulating dates.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Dates` to the header of your DataWeave script.

_Introduced in DataWeave version 2.4.0._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-dates-functions-atbeginningofday">atBeginningOfDay</a></p></td><td><p>Returns a new <code>DateTime</code> value that changes the <code>Time</code> value in the input to the beginning of the specified <em>day</em>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-dates-functions-atbeginningofhour">atBeginningOfHour</a></p></td><td><p>Returns a new <code>DateTime</code> value that changes the <code>Time</code> value in the input to the beginning of the specified <em>hour</em>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-dates-functions-atbeginningofmonth">atBeginningOfMonth</a></p></td><td><p>Returns a new <code>DateTime</code> value that changes the <code>Day</code> value from the input to the first day of the specified <em>month</em>. It also sets the <code>Time</code> value to <code>00:00:00</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-dates-functions-atbeginningofweek">atBeginningOfWeek</a></p></td><td><p>Returns a new <code>DateTime</code> value that changes the <code>Day</code> and <code>Time</code> values from the input to the beginning of the first day of the specified <em>week</em>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-dates-functions-atbeginningofyear">atBeginningOfYear</a></p></td><td><p>Takes a <code>DateTime</code> value as input and returns a <code>DateTime</code> value for the first day of the <em>year</em> specified in the input. It also sets the <code>Time</code> value to <code>00:00:00</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-dates-functions-date">date</a></p></td><td><p>Creates a <code>Date</code> value from values specified for <code>year</code>, <code>month</code>, and <code>day</code> fields.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-dates-functions-datetime">dateTime</a></p></td><td><p>Creates a <code>DateTime</code> value from values specified for <code>year</code>, <code>month</code>, <code>day</code>, <code>hour</code>, <code>minutes</code>, <code>seconds</code>, and <code>timezone</code> fields.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-dates-functions-localdatetime">localDateTime</a></p></td><td><p>Creates a <code>LocalDateTime</code> value from values specified for <code>year</code>, <code>month</code>, <code>day</code>, <code>hour</code>, <code>minutes</code>, and <code>seconds</code> fields.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-dates-functions-localtime">localTime</a></p></td><td><p>Creates a <code>LocalTime</code> value from values specified for <code>hour</code>, <code>minutes</code>, and <code>seconds</code> fields.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-dates-functions-time">time</a></p></td><td><p>Creates a <code>Time</code> value from values specified for <code>hour</code>, <code>minutes</code>, <code>seconds</code>, and <code>timezone</code> fields.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-dates-functions-today">today</a></p></td><td><p>Returns the date for today as a <code>Date</code> type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-dates-functions-tomorrow">tomorrow</a></p></td><td><p>Returns the date for tomorrow as a <code>Date</code> type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-dates-functions-yesterday">yesterday</a></p></td><td><p>Returns the date for yesterday as a <code>Date</code> type.</p></td></tr></tbody></table>

## Types

- [Dates Types](https://docs.mulesoft.com/dataweave/2.9/dw-dates-types)

<!-- document id=e1317a5a0f3afd6e3d1dcb00dc61f4623ef5e90572ac547f6ddb1e6e5c80661c url=/mulesoft/current/en-us/dataweave/latest/dw-dates.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Dates (dw::core::Dates)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains functions for creating and manipulating dates.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Dates` to the header of your DataWeave script.

_Introduced in DataWeave version 2.4.0._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-dates-functions-atbeginningofday">atBeginningOfDay</a></p></td><td><p>Returns a new <code>DateTime</code> value that changes the <code>Time</code> value in the input to the beginning of the specified <em>day</em>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-dates-functions-atbeginningofhour">atBeginningOfHour</a></p></td><td><p>Returns a new <code>DateTime</code> value that changes the <code>Time</code> value in the input to the beginning of the specified <em>hour</em>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-dates-functions-atbeginningofmonth">atBeginningOfMonth</a></p></td><td><p>Returns a new <code>DateTime</code> value that changes the <code>Day</code> value from the input to the first day of the specified <em>month</em>. It also sets the <code>Time</code> value to <code>00:00:00</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-dates-functions-atbeginningofweek">atBeginningOfWeek</a></p></td><td><p>Returns a new <code>DateTime</code> value that changes the <code>Day</code> and <code>Time</code> values from the input to the beginning of the first day of the specified <em>week</em>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-dates-functions-atbeginningofyear">atBeginningOfYear</a></p></td><td><p>Takes a <code>DateTime</code> value as input and returns a <code>DateTime</code> value for the first day of the <em>year</em> specified in the input. It also sets the <code>Time</code> value to <code>00:00:00</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-dates-functions-date">date</a></p></td><td><p>Creates a <code>Date</code> value from values specified for <code>year</code>, <code>month</code>, and <code>day</code> fields.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-dates-functions-datetime">dateTime</a></p></td><td><p>Creates a <code>DateTime</code> value from values specified for <code>year</code>, <code>month</code>, <code>day</code>, <code>hour</code>, <code>minutes</code>, <code>seconds</code>, and <code>timezone</code> fields.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-dates-functions-localdatetime">localDateTime</a></p></td><td><p>Creates a <code>LocalDateTime</code> value from values specified for <code>year</code>, <code>month</code>, <code>day</code>, <code>hour</code>, <code>minutes</code>, and <code>seconds</code> fields.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-dates-functions-localtime">localTime</a></p></td><td><p>Creates a <code>LocalTime</code> value from values specified for <code>hour</code>, <code>minutes</code>, and <code>seconds</code> fields.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-dates-functions-time">time</a></p></td><td><p>Creates a <code>Time</code> value from values specified for <code>hour</code>, <code>minutes</code>, <code>seconds</code>, and <code>timezone</code> fields.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-dates-functions-today">today</a></p></td><td><p>Returns the date for today as a <code>Date</code> type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-dates-functions-tomorrow">tomorrow</a></p></td><td><p>Returns the date for tomorrow as a <code>Date</code> type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-dates-functions-yesterday">yesterday</a></p></td><td><p>Returns the date for yesterday as a <code>Date</code> type.</p></td></tr></tbody></table>

## Types

- [Dates Types](https://docs.mulesoft.com/dataweave/latest/dw-dates-types)

<!-- document id=55e239077af84ebbc9e1453846b78afb701e3b5abd892f90159e5f8d84eac885 url=/mulesoft/current/en-us/dataweave/2.11/dw-dates-types.md -->

---
product: DataWeave
version: 2.11
---

# Dates Types (dw::core::Dates)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>DateFactory</p></td><td><div><div><p><code>type DateFactory = { day: Number, month: Number, year: Number }</code></p></div></div></td><td><div><div><p>Type containing selectable <code>day</code>, <code>month</code>, and <code>year</code> keys and corresponding <code>Number</code> values, such as <code>{day: 21, month: 1, year: 2021}</code>. The fields accept a <code>Number</code> value. Numbers preceded by <code>0</code>, such as <code>01</code>, are not valid.</p></div></div></td></tr><tr><td><p>DateTimeFactory</p></td><td><div><div><p><code>type DateTimeFactory = DateFactory &amp; LocalTimeFactory &amp; Zoned</code></p></div></div></td><td><div><div><p>Type that combines <code>DateFactory</code>, <code>LocalTimeFactory</code>, and <code>Zoned</code> types. For example, <code>{day: 21, month: 1, year: 2021, hour: 8, minutes: 31, seconds: 55, timeZone : |-03:00|} as DateTimeFactory</code> is a valid <code>DateTimeFactory</code> value.</p></div></div></td></tr><tr><td><p>LocalDateTimeFactory</p></td><td><div><div><p><code>type LocalDateTimeFactory = DateFactory &amp; LocalTimeFactory</code></p></div></div></td><td><div><div><p>Type that combines <code>DateFactory</code> and <code>LocalTimeFactory</code> types. For example, <code>{day: 21, month: 1, year: 2021, hour: 8, minutes: 31, seconds: 55, timeZone : |-03:00|} as LocalDateTimeFactory</code> is a valid <code>LocalDateTimeFactory</code> value. The <code>timeZone</code> field is optional.</p></div></div></td></tr><tr><td><p>LocalTimeFactory</p></td><td><div><div><p><code>type LocalTimeFactory = { hour: Number, minutes: Number, seconds: Number }</code></p></div></div></td><td><div><div><p>Type containing selectable <code>hour</code>, <code>minutes</code>, and <code>seconds</code> keys and corresponding <code>Number</code> values, such as <code>{hour: 8, minutes: 31, seconds: 55}</code>. The fields accept any <code>Number</code> value.</p></div></div></td></tr><tr><td><p>TimeFactory</p></td><td><div><div><p><code>type TimeFactory = LocalTimeFactory &amp; Zoned</code></p></div></div></td><td><div><div><p>Type that combines <code>LocalTimeFactory</code> and <code>Zoned</code> types. For example, <code>{hour: 8, minutes: 31, seconds: 55, timeZone : |-03:00|} as TimeFactory</code> is a valid <code>TimeFactory</code> value.</p></div></div></td></tr><tr><td><p>Zoned</p></td><td><div><div><p><code>type Zoned = { timeZone: TimeZone }</code></p></div></div></td><td><div><div><p>Type containing a selectable <code>timeZone</code> key and <code>TimeZone</code> value, such as <code>{ timezone : |-03:00|}</code>.</p></div></div></td></tr></tbody></table>

<!-- document id=69ddaaa6518d8fe11c6cdab8006ffbea7803da83136ec210e1cb9400ecad8bb0 url=/mulesoft/current/en-us/dataweave/2.12/dw-dates-types.md -->

---
product: DataWeave
version: 2.12
---

# Dates Types (dw::core::Dates)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>DateFactory</p></td><td><div><div><p><code>type DateFactory = { day: Number, month: Number, year: Number }</code></p></div></div></td><td><div><div><p>Type containing selectable <code>day</code>, <code>month</code>, and <code>year</code> keys and corresponding <code>Number</code> values, such as <code>{day: 21, month: 1, year: 2021}</code>. The fields accept a <code>Number</code> value. Numbers preceded by <code>0</code>, such as <code>01</code>, are not valid.</p></div></div></td></tr><tr><td><p>DateTimeFactory</p></td><td><div><div><p><code>type DateTimeFactory = DateFactory &amp; LocalTimeFactory &amp; Zoned</code></p></div></div></td><td><div><div><p>Type that combines <code>DateFactory</code>, <code>LocalTimeFactory</code>, and <code>Zoned</code> types. For example, <code>{day: 21, month: 1, year: 2021, hour: 8, minutes: 31, seconds: 55, timeZone : |-03:00|} as DateTimeFactory</code> is a valid <code>DateTimeFactory</code> value.</p></div></div></td></tr><tr><td><p>LocalDateTimeFactory</p></td><td><div><div><p><code>type LocalDateTimeFactory = DateFactory &amp; LocalTimeFactory</code></p></div></div></td><td><div><div><p>Type that combines <code>DateFactory</code> and <code>LocalTimeFactory</code> types. For example, <code>{day: 21, month: 1, year: 2021, hour: 8, minutes: 31, seconds: 55, timeZone : |-03:00|} as LocalDateTimeFactory</code> is a valid <code>LocalDateTimeFactory</code> value. The <code>timeZone</code> field is optional.</p></div></div></td></tr><tr><td><p>LocalTimeFactory</p></td><td><div><div><p><code>type LocalTimeFactory = { hour: Number, minutes: Number, seconds: Number }</code></p></div></div></td><td><div><div><p>Type containing selectable <code>hour</code>, <code>minutes</code>, and <code>seconds</code> keys and corresponding <code>Number</code> values, such as <code>{hour: 8, minutes: 31, seconds: 55}</code>. The fields accept any <code>Number</code> value.</p></div></div></td></tr><tr><td><p>TimeFactory</p></td><td><div><div><p><code>type TimeFactory = LocalTimeFactory &amp; Zoned</code></p></div></div></td><td><div><div><p>Type that combines <code>LocalTimeFactory</code> and <code>Zoned</code> types. For example, <code>{hour: 8, minutes: 31, seconds: 55, timeZone : |-03:00|} as TimeFactory</code> is a valid <code>TimeFactory</code> value.</p></div></div></td></tr><tr><td><p>Zoned</p></td><td><div><div><p><code>type Zoned = { timeZone: TimeZone }</code></p></div></div></td><td><div><div><p>Type containing a selectable <code>timeZone</code> key and <code>TimeZone</code> value, such as <code>{ timezone : |-03:00|}</code>.</p></div></div></td></tr></tbody></table>

<!-- document id=07e6f3a72a5b21c61da7af6666eca5cdc88f8d0ede76cadf8de317f41b256379 url=/mulesoft/current/en-us/dataweave/2.4/dw-dates-types.md -->

---
product: DataWeave
version: 2.4
---

# Dates Types (dw::core::Dates)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>DateFactory</p></td><td><div><div><p><code>type DateFactory = { day: Number, month: Number, year: Number }</code></p></div></div></td><td><div><div><p>Type containing selectable <code>day</code>, <code>month</code>, and <code>year</code> keys and corresponding <code>Number</code> values, such as <code>{day: 21, month: 1, year: 2021}</code>. The fields accept a <code>Number</code> value. Numbers preceded by <code>0</code>, such as <code>01</code>, are not valid.</p></div></div></td></tr><tr><td><p>DateTimeFactory</p></td><td><div><div><p><code>type DateTimeFactory = DateFactory &amp; LocalTimeFactory &amp; Zoned</code></p></div></div></td><td><div><div><p>Type that combines <code>DateFactory</code>, <code>LocalTimeFactory</code>, and <code>Zoned</code> types. For example, <code>{day: 21, month: 1, year: 2021, hour: 8, minutes: 31, seconds: 55, timeZone : |-03:00|} as DateTimeFactory</code> is a valid <code>DateTimeFactory</code> value.</p></div></div></td></tr><tr><td><p>LocalDateTimeFactory</p></td><td><div><div><p><code>type LocalDateTimeFactory = DateFactory &amp; LocalTimeFactory</code></p></div></div></td><td><div><div><p>Type that combines <code>DateFactory</code> and <code>LocalTimeFactory</code> types. For example, <code>{day: 21, month: 1, year: 2021, hour: 8, minutes: 31, seconds: 55, timeZone : |-03:00|} as LocalDateTimeFactory</code> is a valid <code>LocalDateTimeFactory</code> value. The <code>timeZone</code> field is optional.</p></div></div></td></tr><tr><td><p>LocalTimeFactory</p></td><td><div><div><p><code>type LocalTimeFactory = { hour: Number, minutes: Number, seconds: Number }</code></p></div></div></td><td><div><div><p>Type containing selectable <code>hour</code>, <code>minutes</code>, and <code>seconds</code> keys and corresponding <code>Number</code> values, such as <code>{hour: 8, minutes: 31, seconds: 55}</code>. The fields accept any <code>Number</code> value.</p></div></div></td></tr><tr><td><p>TimeFactory</p></td><td><div><div><p><code>type TimeFactory = LocalTimeFactory &amp; Zoned</code></p></div></div></td><td><div><div><p>Type that combines <code>LocalTimeFactory</code> and <code>Zoned</code> types. For example, <code>{hour: 8, minutes: 31, seconds: 55, timeZone : |-03:00|} as TimeFactory</code> is a valid <code>TimeFactory</code> value.</p></div></div></td></tr><tr><td><p>Zoned</p></td><td><div><div><p><code>type Zoned = { timeZone: TimeZone }</code></p></div></div></td><td><div><div><p>Type containing a selectable <code>timeZone</code> key and <code>TimeZone</code> value, such as <code>{ timezone : |-03:00|}</code>.</p></div></div></td></tr></tbody></table>

<!-- document id=723a6bfe5de1fdde517c713625b6cd46f507ba30fb02a756b64d480e974c297e url=/mulesoft/current/en-us/dataweave/2.6/dw-dates-types.md -->

---
product: DataWeave
version: 2.6
---

# Dates Types (dw::core::Dates)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>DateFactory</p></td><td><div><div><p><code>type DateFactory = { day: Number, month: Number, year: Number }</code></p></div></div></td><td><div><div><p>Type containing selectable <code>day</code>, <code>month</code>, and <code>year</code> keys and corresponding <code>Number</code> values, such as <code>{day: 21, month: 1, year: 2021}</code>. The fields accept a <code>Number</code> value. Numbers preceded by <code>0</code>, such as <code>01</code>, are not valid.</p></div></div></td></tr><tr><td><p>DateTimeFactory</p></td><td><div><div><p><code>type DateTimeFactory = DateFactory &amp; LocalTimeFactory &amp; Zoned</code></p></div></div></td><td><div><div><p>Type that combines <code>DateFactory</code>, <code>LocalTimeFactory</code>, and <code>Zoned</code> types. For example, <code>{day: 21, month: 1, year: 2021, hour: 8, minutes: 31, seconds: 55, timeZone : |-03:00|} as DateTimeFactory</code> is a valid <code>DateTimeFactory</code> value.</p></div></div></td></tr><tr><td><p>LocalDateTimeFactory</p></td><td><div><div><p><code>type LocalDateTimeFactory = DateFactory &amp; LocalTimeFactory</code></p></div></div></td><td><div><div><p>Type that combines <code>DateFactory</code> and <code>LocalTimeFactory</code> types. For example, <code>{day: 21, month: 1, year: 2021, hour: 8, minutes: 31, seconds: 55, timeZone : |-03:00|} as LocalDateTimeFactory</code> is a valid <code>LocalDateTimeFactory</code> value. The <code>timeZone</code> field is optional.</p></div></div></td></tr><tr><td><p>LocalTimeFactory</p></td><td><div><div><p><code>type LocalTimeFactory = { hour: Number, minutes: Number, seconds: Number }</code></p></div></div></td><td><div><div><p>Type containing selectable <code>hour</code>, <code>minutes</code>, and <code>seconds</code> keys and corresponding <code>Number</code> values, such as <code>{hour: 8, minutes: 31, seconds: 55}</code>. The fields accept any <code>Number</code> value.</p></div></div></td></tr><tr><td><p>TimeFactory</p></td><td><div><div><p><code>type TimeFactory = LocalTimeFactory &amp; Zoned</code></p></div></div></td><td><div><div><p>Type that combines <code>LocalTimeFactory</code> and <code>Zoned</code> types. For example, <code>{hour: 8, minutes: 31, seconds: 55, timeZone : |-03:00|} as TimeFactory</code> is a valid <code>TimeFactory</code> value.</p></div></div></td></tr><tr><td><p>Zoned</p></td><td><div><div><p><code>type Zoned = { timeZone: TimeZone }</code></p></div></div></td><td><div><div><p>Type containing a selectable <code>timeZone</code> key and <code>TimeZone</code> value, such as <code>{ timezone : |-03:00|}</code>.</p></div></div></td></tr></tbody></table>

<!-- document id=bb288ae1682164482bb9ab542c66ccac2495ae29e36e08712210a9d5da34ed9f url=/mulesoft/current/en-us/dataweave/2.9/dw-dates-types.md -->

---
product: DataWeave
version: 2.9
---

# Dates Types (dw::core::Dates)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>DateFactory</p></td><td><div><div><p><code>type DateFactory = { day: Number, month: Number, year: Number }</code></p></div></div></td><td><div><div><p>Type containing selectable <code>day</code>, <code>month</code>, and <code>year</code> keys and corresponding <code>Number</code> values, such as <code>{day: 21, month: 1, year: 2021}</code>. The fields accept a <code>Number</code> value. Numbers preceded by <code>0</code>, such as <code>01</code>, are not valid.</p></div></div></td></tr><tr><td><p>DateTimeFactory</p></td><td><div><div><p><code>type DateTimeFactory = DateFactory &amp; LocalTimeFactory &amp; Zoned</code></p></div></div></td><td><div><div><p>Type that combines <code>DateFactory</code>, <code>LocalTimeFactory</code>, and <code>Zoned</code> types. For example, <code>{day: 21, month: 1, year: 2021, hour: 8, minutes: 31, seconds: 55, timeZone : |-03:00|} as DateTimeFactory</code> is a valid <code>DateTimeFactory</code> value.</p></div></div></td></tr><tr><td><p>LocalDateTimeFactory</p></td><td><div><div><p><code>type LocalDateTimeFactory = DateFactory &amp; LocalTimeFactory</code></p></div></div></td><td><div><div><p>Type that combines <code>DateFactory</code> and <code>LocalTimeFactory</code> types. For example, <code>{day: 21, month: 1, year: 2021, hour: 8, minutes: 31, seconds: 55, timeZone : |-03:00|} as LocalDateTimeFactory</code> is a valid <code>LocalDateTimeFactory</code> value. The <code>timeZone</code> field is optional.</p></div></div></td></tr><tr><td><p>LocalTimeFactory</p></td><td><div><div><p><code>type LocalTimeFactory = { hour: Number, minutes: Number, seconds: Number }</code></p></div></div></td><td><div><div><p>Type containing selectable <code>hour</code>, <code>minutes</code>, and <code>seconds</code> keys and corresponding <code>Number</code> values, such as <code>{hour: 8, minutes: 31, seconds: 55}</code>. The fields accept any <code>Number</code> value.</p></div></div></td></tr><tr><td><p>TimeFactory</p></td><td><div><div><p><code>type TimeFactory = LocalTimeFactory &amp; Zoned</code></p></div></div></td><td><div><div><p>Type that combines <code>LocalTimeFactory</code> and <code>Zoned</code> types. For example, <code>{hour: 8, minutes: 31, seconds: 55, timeZone : |-03:00|} as TimeFactory</code> is a valid <code>TimeFactory</code> value.</p></div></div></td></tr><tr><td><p>Zoned</p></td><td><div><div><p><code>type Zoned = { timeZone: TimeZone }</code></p></div></div></td><td><div><div><p>Type containing a selectable <code>timeZone</code> key and <code>TimeZone</code> value, such as <code>{ timezone : |-03:00|}</code>.</p></div></div></td></tr></tbody></table>

<!-- document id=0e53290a46542daa3e6421d56f62eb7c8adc46debe4a60f9bd44353d5f8f38b8 url=/mulesoft/current/en-us/dataweave/latest/dw-dates-types.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Dates Types (dw::core::Dates)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>DateFactory</p></td><td><div><div><p><code>type DateFactory = { day: Number, month: Number, year: Number }</code></p></div></div></td><td><div><div><p>Type containing selectable <code>day</code>, <code>month</code>, and <code>year</code> keys and corresponding <code>Number</code> values, such as <code>{day: 21, month: 1, year: 2021}</code>. The fields accept a <code>Number</code> value. Numbers preceded by <code>0</code>, such as <code>01</code>, are not valid.</p></div></div></td></tr><tr><td><p>DateTimeFactory</p></td><td><div><div><p><code>type DateTimeFactory = DateFactory &amp; LocalTimeFactory &amp; Zoned</code></p></div></div></td><td><div><div><p>Type that combines <code>DateFactory</code>, <code>LocalTimeFactory</code>, and <code>Zoned</code> types. For example, <code>{day: 21, month: 1, year: 2021, hour: 8, minutes: 31, seconds: 55, timeZone : |-03:00|} as DateTimeFactory</code> is a valid <code>DateTimeFactory</code> value.</p></div></div></td></tr><tr><td><p>LocalDateTimeFactory</p></td><td><div><div><p><code>type LocalDateTimeFactory = DateFactory &amp; LocalTimeFactory</code></p></div></div></td><td><div><div><p>Type that combines <code>DateFactory</code> and <code>LocalTimeFactory</code> types. For example, <code>{day: 21, month: 1, year: 2021, hour: 8, minutes: 31, seconds: 55, timeZone : |-03:00|} as LocalDateTimeFactory</code> is a valid <code>LocalDateTimeFactory</code> value. The <code>timeZone</code> field is optional.</p></div></div></td></tr><tr><td><p>LocalTimeFactory</p></td><td><div><div><p><code>type LocalTimeFactory = { hour: Number, minutes: Number, seconds: Number }</code></p></div></div></td><td><div><div><p>Type containing selectable <code>hour</code>, <code>minutes</code>, and <code>seconds</code> keys and corresponding <code>Number</code> values, such as <code>{hour: 8, minutes: 31, seconds: 55}</code>. The fields accept any <code>Number</code> value.</p></div></div></td></tr><tr><td><p>TimeFactory</p></td><td><div><div><p><code>type TimeFactory = LocalTimeFactory &amp; Zoned</code></p></div></div></td><td><div><div><p>Type that combines <code>LocalTimeFactory</code> and <code>Zoned</code> types. For example, <code>{hour: 8, minutes: 31, seconds: 55, timeZone : |-03:00|} as TimeFactory</code> is a valid <code>TimeFactory</code> value.</p></div></div></td></tr><tr><td><p>Zoned</p></td><td><div><div><p><code>type Zoned = { timeZone: TimeZone }</code></p></div></div></td><td><div><div><p>Type containing a selectable <code>timeZone</code> key and <code>TimeZone</code> value, such as <code>{ timezone : |-03:00|}</code>.</p></div></div></td></tr></tbody></table>

<!-- document id=9895993b790bd7128c6fe8eb8a91b7fd7ff9b5bf7421f0743ef2c29b69e1a886 url=/mulesoft/current/en-us/dataweave/2.11/dw-dates-functions-datetime.md -->

---
product: DataWeave
version: 2.11
---

# dateTime

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## dateTime(parts: DateTimeFactory): DateTime

Creates a `DateTime` value from values specified for `year`, `month`, `day`, `hour`, `minutes`,
`seconds`, and `timezone` fields.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>parts</code></p></td><td><div><div><p><code>Number</code> values for <code>year</code>, <code>month</code>, <code>day</code>, <code>hour</code>, <code>minutes</code>, and <code>seconds</code> fields followed by a <code>TimeZone</code> value for the <code>timezone</code> field. Valid values are numbers between 1 and 12 for the <code>month</code>, 1 through 31 for the <code>day</code>, 0 through 23 for the <code>hour</code>, 0 through 59 for <code>minutes</code>, and 0 through 59 (including decimals, such as 59.99) for seconds. You can specify the name-value pairs in any order, but the output is ordered by default as a <code>DateTime</code> value, such as <code>2012-10-11T10:10:10-03:00</code>. The input fields are parts of a <code>DateTimeFactory</code> type.</p></div></div></td></tr></tbody></table>

### Example

This example shows how to create a value of type `DateTime`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
    newDateTime: dateTime({year: 2012, month: 10, day: 11, hour: 12, minutes: 30, seconds: 40 , timeZone: |-03:00|})
}
```

#### Output

```Json
{
   "newDateTime": "2012-10-11T12:30:40-03:00"
}
```

<!-- document id=1e1c5cfccfbe44c54b7a393c89e91cfa8d019a8b3f17ffb7fc74961f05dbcf1b url=/mulesoft/current/en-us/dataweave/2.12/dw-dates-functions-datetime.md -->

---
product: DataWeave
version: 2.12
---

# dateTime

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## dateTime(parts: DateTimeFactory): DateTime

Creates a `DateTime` value from values specified for `year`, `month`, `day`, `hour`, `minutes`,
`seconds`, and `timezone` fields.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>parts</code></p></td><td><div><div><p><code>Number</code> values for <code>year</code>, <code>month</code>, <code>day</code>, <code>hour</code>, <code>minutes</code>, and <code>seconds</code> fields followed by a <code>TimeZone</code> value for the <code>timezone</code> field. Valid values are numbers between 1 and 12 for the <code>month</code>, 1 through 31 for the <code>day</code>, 0 through 23 for the <code>hour</code>, 0 through 59 for <code>minutes</code>, and 0 through 59 (including decimals, such as 59.99) for seconds. You can specify the name-value pairs in any order, but the output is ordered by default as a <code>DateTime</code> value, such as <code>2012-10-11T10:10:10-03:00</code>. The input fields are parts of a <code>DateTimeFactory</code> type.</p></div></div></td></tr></tbody></table>

### Example

This example shows how to create a value of type `DateTime`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
    newDateTime: dateTime({year: 2012, month: 10, day: 11, hour: 12, minutes: 30, seconds: 40 , timeZone: |-03:00|})
}
```

#### Output

```Json
{
   "newDateTime": "2012-10-11T12:30:40-03:00"
}
```

<!-- document id=588b7bb6997db96d6bc945c5c6549c0fcf2901eb36b1fc4cef167c1b4cc2d6c3 url=/mulesoft/current/en-us/dataweave/2.4/dw-dates-functions-datetime.md -->

---
product: DataWeave
version: 2.4
---

# dateTime

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## dateTime(parts: DateTimeFactory): DateTime

Creates a `DateTime` value from values specified for `year`, `month`, `day`, `hour`, `minutes`,
`seconds`, and `timezone` fields.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>parts</code></p></td><td><div><div><p><code>Number</code> values for <code>year</code>, <code>month</code>, <code>day</code>, <code>hour</code>, <code>minutes</code>, and <code>seconds</code> fields followed by a <code>TimeZone</code> value for the the <code>timezone</code> field. Valid values are numbers between 1 and 12 for the <code>month</code>, 1 through 31 for the <code>day</code>, 0 through 23 for the <code>hour</code>, 0 through 59 for <code>minutes</code>, and 0 through 59 (including decimals, such as 59.99) for seconds. You can specify the name-value pairs in any order, but the output is ordered by default as a <code>DateTime</code> value, such as <code>2012-10-11T10:10:10-03:00</code>. The input fields are parts of a <code>DateTimeFactory</code> type.</p></div></div></td></tr></tbody></table>

### Example

This example shows how to create a value of type `DateTime`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
    newDateTime: dateTime({year: 2012, month: 10, day: 11, hour: 12, minutes: 30, seconds: 40 , timeZone: |-03:00|})
}
```

#### Output

```Json
{
   "newDateTime": "2012-10-11T12:30:40-03:00"
}
```

<!-- document id=4246f919eebd78a0f300d7b59c8a1ce31266114e007dfb605dc8cda8d1ab363d url=/mulesoft/current/en-us/dataweave/2.6/dw-dates-functions-datetime.md -->

---
product: DataWeave
version: 2.6
---

# dateTime

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## dateTime(parts: DateTimeFactory): DateTime

Creates a `DateTime` value from values specified for `year`, `month`, `day`, `hour`, `minutes`,
`seconds`, and `timezone` fields.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>parts</code></p></td><td><div><div><p><code>Number</code> values for <code>year</code>, <code>month</code>, <code>day</code>, <code>hour</code>, <code>minutes</code>, and <code>seconds</code> fields followed by a <code>TimeZone</code> value for the the <code>timezone</code> field. Valid values are numbers between 1 and 12 for the <code>month</code>, 1 through 31 for the <code>day</code>, 0 through 23 for the <code>hour</code>, 0 through 59 for <code>minutes</code>, and 0 through 59 (including decimals, such as 59.99) for seconds. You can specify the name-value pairs in any order, but the output is ordered by default as a <code>DateTime</code> value, such as <code>2012-10-11T10:10:10-03:00</code>. The input fields are parts of a <code>DateTimeFactory</code> type.</p></div></div></td></tr></tbody></table>

### Example

This example shows how to create a value of type `DateTime`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
    newDateTime: dateTime({year: 2012, month: 10, day: 11, hour: 12, minutes: 30, seconds: 40 , timeZone: |-03:00|})
}
```

#### Output

```Json
{
   "newDateTime": "2012-10-11T12:30:40-03:00"
}
```

<!-- document id=0d858e5a09cbfeeacc448b444b6472b465807e2afdbcf60fc1c04f9ca45fb85b url=/mulesoft/current/en-us/dataweave/2.9/dw-dates-functions-datetime.md -->

---
product: DataWeave
version: 2.9
---

# dateTime

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## dateTime(parts: DateTimeFactory): DateTime

Creates a `DateTime` value from values specified for `year`, `month`, `day`, `hour`, `minutes`,
`seconds`, and `timezone` fields.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>parts</code></p></td><td><div><div><p><code>Number</code> values for <code>year</code>, <code>month</code>, <code>day</code>, <code>hour</code>, <code>minutes</code>, and <code>seconds</code> fields followed by a <code>TimeZone</code> value for the <code>timezone</code> field. Valid values are numbers between 1 and 12 for the <code>month</code>, 1 through 31 for the <code>day</code>, 0 through 23 for the <code>hour</code>, 0 through 59 for <code>minutes</code>, and 0 through 59 (including decimals, such as 59.99) for seconds. You can specify the name-value pairs in any order, but the output is ordered by default as a <code>DateTime</code> value, such as <code>2012-10-11T10:10:10-03:00</code>. The input fields are parts of a <code>DateTimeFactory</code> type.</p></div></div></td></tr></tbody></table>

### Example

This example shows how to create a value of type `DateTime`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
    newDateTime: dateTime({year: 2012, month: 10, day: 11, hour: 12, minutes: 30, seconds: 40 , timeZone: |-03:00|})
}
```

#### Output

```Json
{
   "newDateTime": "2012-10-11T12:30:40-03:00"
}
```

<!-- document id=b45e3f75ac324400802ce0b4e09df4f8d92aeb9cecbf4f535aaddb8ae6f14aa1 url=/mulesoft/current/en-us/dataweave/latest/dw-dates-functions-datetime.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# dateTime

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## dateTime(parts: DateTimeFactory): DateTime

Creates a `DateTime` value from values specified for `year`, `month`, `day`, `hour`, `minutes`,
`seconds`, and `timezone` fields.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>parts</code></p></td><td><div><div><p><code>Number</code> values for <code>year</code>, <code>month</code>, <code>day</code>, <code>hour</code>, <code>minutes</code>, and <code>seconds</code> fields followed by a <code>TimeZone</code> value for the <code>timezone</code> field. Valid values are numbers between 1 and 12 for the <code>month</code>, 1 through 31 for the <code>day</code>, 0 through 23 for the <code>hour</code>, 0 through 59 for <code>minutes</code>, and 0 through 59 (including decimals, such as 59.99) for seconds. You can specify the name-value pairs in any order, but the output is ordered by default as a <code>DateTime</code> value, such as <code>2012-10-11T10:10:10-03:00</code>. The input fields are parts of a <code>DateTimeFactory</code> type.</p></div></div></td></tr></tbody></table>

### Example

This example shows how to create a value of type `DateTime`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
    newDateTime: dateTime({year: 2012, month: 10, day: 11, hour: 12, minutes: 30, seconds: 40 , timeZone: |-03:00|})
}
```

#### Output

```Json
{
   "newDateTime": "2012-10-11T12:30:40-03:00"
}
```

<!-- document id=951dece2913cdab0ceb5a6c2029a3bf681a12187d1eb5f12c78ee450426976e8 url=/mulesoft/current/en-us/dataweave/2.11/dw-periods-functions-days.md -->

---
product: DataWeave
version: 2.11
---

# days

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## days(nDays: Number): Period

Creates a Period value from the provided number of days.

The function applies the `period` function to input that is a whole number and the `duration`
function to decimal input.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>nDays</code></p></td><td><p>The number of hours as a whole or decimal number. A positive or negative number is valid.</p></td></tr></tbody></table>

### Example

This example shows how `days` behaves with different inputs. It adds and subtracts hours from
DateTime values. It also converts the decimal value `4.555` into a number of hours, minutes, and
second in the Period format (`PT109H19M12S`) and the whole number `4` into a number of days in the
Period format (`P4D`).

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Periods
output application/json
---
{
   tomorrow: |2020-10-05T20:22:34.385Z| + days(1),
   yesterday: |2020-10-05T20:22:34.385Z| - days(1),
   decimalDaysPlusQuarter:  |2020-10-05T00:00:00.000Z| + days(0.25),
   decimalDaysPlusHalf:  |2020-10-05T00:00:00.000Z| + days(0.5),
   decimalDaysPlusThreeQuarters:  |2020-10-05T00:00:00.000Z| + days(0.75),
   decimalInputAsPeriod : days(4.555),
   fourDayPeriod: days(4),
   negativeValue: days(-1)
}
```

#### Output

```Json
{
   "tomorrow": "2020-10-06T20:22:34.385Z",
   "yesterday": "2020-10-04T20:22:34.385Z",
   "decimalDaysPlusQuarter": "2020-10-05T06:00:00Z",
   "decimalDaysPlusHalf": "2020-10-05T12:00:00Z",
   "decimalDaysPlusThreeQuarters": "2020-10-05T18:00:00Z",
   "decimalInputAsPeriod": "PT109H19M12S",
   "fourDayPeriod": "P4D",
   "negativeValue": "P-1D"
}
```

<!-- document id=881d76062913ee8dddad3d5a588ee4ea1cf71448306445252a34036c6251dae4 url=/mulesoft/current/en-us/dataweave/2.12/dw-periods-functions-days.md -->

---
product: DataWeave
version: 2.12
---

# days

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## days(nDays: Number): Period

Creates a Period value from the provided number of days.

The function applies the `period` function to input that is a whole number and the `duration`
function to decimal input.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>nDays</code></p></td><td><p>The number of hours as a whole or decimal number. A positive or negative number is valid.</p></td></tr></tbody></table>

### Example

This example shows how `days` behaves with different inputs. It adds and subtracts hours from
DateTime values. It also converts the decimal value `4.555` into a number of hours, minutes, and
second in the Period format (`PT109H19M12S`) and the whole number `4` into a number of days in the
Period format (`P4D`).

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Periods
output application/json
---
{
   tomorrow: |2020-10-05T20:22:34.385Z| + days(1),
   yesterday: |2020-10-05T20:22:34.385Z| - days(1),
   decimalDaysPlusQuarter:  |2020-10-05T00:00:00.000Z| + days(0.25),
   decimalDaysPlusHalf:  |2020-10-05T00:00:00.000Z| + days(0.5),
   decimalDaysPlusThreeQuarters:  |2020-10-05T00:00:00.000Z| + days(0.75),
   decimalInputAsPeriod : days(4.555),
   fourDayPeriod: days(4),
   negativeValue: days(-1)
}
```

#### Output

```Json
{
   "tomorrow": "2020-10-06T20:22:34.385Z",
   "yesterday": "2020-10-04T20:22:34.385Z",
   "decimalDaysPlusQuarter": "2020-10-05T06:00:00Z",
   "decimalDaysPlusHalf": "2020-10-05T12:00:00Z",
   "decimalDaysPlusThreeQuarters": "2020-10-05T18:00:00Z",
   "decimalInputAsPeriod": "PT109H19M12S",
   "fourDayPeriod": "P4D",
   "negativeValue": "P-1D"
}
```

<!-- document id=5319ab5b236565dff9924a24e5e6c9c4f6ad25768a56c9d5eb720a47607eb98e url=/mulesoft/current/en-us/dataweave/2.4/dw-periods-functions-days.md -->

---
product: DataWeave
version: 2.4
---

# days

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## days(nDays: Number): Period

Creates a Period value from the provided number of days.

The function applies the `period` function to input that is a whole number and the `duration`
function to decimal input.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>nDays</code></p></td><td><p>The number of hours as a whole or decimal number. A positive or negative number is valid.</p></td></tr></tbody></table>

### Example

This example shows how `days` behaves with different inputs. It adds and subtracts hours from
DateTime values. It also converts the decimal value `4.555` into a number of hours, minutes, and
second in the Period format (`PT109H19M12S`) and the whole number `4` into a number of days in the
Period format (`P4D`).

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Periods
output application/json
---
{
   tomorrow: |2020-10-05T20:22:34.385Z| + days(1),
   yesterday: |2020-10-05T20:22:34.385Z| - days(1),
   decimalDaysPlusQuarter:  |2020-10-05T00:00:00.000Z| + days(0.25),
   decimalDaysPlusHalf:  |2020-10-05T00:00:00.000Z| + days(0.5),
   decimalDaysPlusThreeQuarters:  |2020-10-05T00:00:00.000Z| + days(0.75),
   decimalInputAsPeriod : days(4.555),
   fourDayPeriod: days(4),
   negativeValue: days(-1)
}
```

#### Output

```Json
{
   "tomorrow": "2020-10-06T20:22:34.385Z",
   "yesterday": "2020-10-04T20:22:34.385Z",
   "decimalDaysPlusQuarter": "2020-10-05T06:00:00Z",
   "decimalDaysPlusHalf": "2020-10-05T12:00:00Z",
   "decimalDaysPlusThreeQuarters": "2020-10-05T18:00:00Z",
   "decimalInputAsPeriod": "PT109H19M12S",
   "fourDayPeriod": "P4D",
   "negativeValue": "P-1D"
}
```

<!-- document id=466bff60f8f3e00fe684d8bf6e408d54618d75784b3ed87a8ad2b65b7ff9fb33 url=/mulesoft/current/en-us/dataweave/2.6/dw-periods-functions-days.md -->

---
product: DataWeave
version: 2.6
---

# days

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## days(nDays: Number): Period

Creates a Period value from the provided number of days.

The function applies the `period` function to input that is a whole number and the `duration`
function to decimal input.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>nDays</code></p></td><td><p>The number of hours as a whole or decimal number. A positive or negative number is valid.</p></td></tr></tbody></table>

### Example

This example shows how `days` behaves with different inputs. It adds and subtracts hours from
DateTime values. It also converts the decimal value `4.555` into a number of hours, minutes, and
second in the Period format (`PT109H19M12S`) and the whole number `4` into a number of days in the
Period format (`P4D`).

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Periods
output application/json
---
{
   tomorrow: |2020-10-05T20:22:34.385Z| + days(1),
   yesterday: |2020-10-05T20:22:34.385Z| - days(1),
   decimalDaysPlusQuarter:  |2020-10-05T00:00:00.000Z| + days(0.25),
   decimalDaysPlusHalf:  |2020-10-05T00:00:00.000Z| + days(0.5),
   decimalDaysPlusThreeQuarters:  |2020-10-05T00:00:00.000Z| + days(0.75),
   decimalInputAsPeriod : days(4.555),
   fourDayPeriod: days(4),
   negativeValue: days(-1)
}
```

#### Output

```Json
{
   "tomorrow": "2020-10-06T20:22:34.385Z",
   "yesterday": "2020-10-04T20:22:34.385Z",
   "decimalDaysPlusQuarter": "2020-10-05T06:00:00Z",
   "decimalDaysPlusHalf": "2020-10-05T12:00:00Z",
   "decimalDaysPlusThreeQuarters": "2020-10-05T18:00:00Z",
   "decimalInputAsPeriod": "PT109H19M12S",
   "fourDayPeriod": "P4D",
   "negativeValue": "P-1D"
}
```

<!-- document id=4993be818d9a373332e920e1b27371e7d88c1d61ded1300d3b183ebb9de654bc url=/mulesoft/current/en-us/dataweave/2.9/dw-periods-functions-days.md -->

---
product: DataWeave
version: 2.9
---

# days

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## days(nDays: Number): Period

Creates a Period value from the provided number of days.

The function applies the `period` function to input that is a whole number and the `duration`
function to decimal input.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>nDays</code></p></td><td><p>The number of hours as a whole or decimal number. A positive or negative number is valid.</p></td></tr></tbody></table>

### Example

This example shows how `days` behaves with different inputs. It adds and subtracts hours from
DateTime values. It also converts the decimal value `4.555` into a number of hours, minutes, and
second in the Period format (`PT109H19M12S`) and the whole number `4` into a number of days in the
Period format (`P4D`).

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Periods
output application/json
---
{
   tomorrow: |2020-10-05T20:22:34.385Z| + days(1),
   yesterday: |2020-10-05T20:22:34.385Z| - days(1),
   decimalDaysPlusQuarter:  |2020-10-05T00:00:00.000Z| + days(0.25),
   decimalDaysPlusHalf:  |2020-10-05T00:00:00.000Z| + days(0.5),
   decimalDaysPlusThreeQuarters:  |2020-10-05T00:00:00.000Z| + days(0.75),
   decimalInputAsPeriod : days(4.555),
   fourDayPeriod: days(4),
   negativeValue: days(-1)
}
```

#### Output

```Json
{
   "tomorrow": "2020-10-06T20:22:34.385Z",
   "yesterday": "2020-10-04T20:22:34.385Z",
   "decimalDaysPlusQuarter": "2020-10-05T06:00:00Z",
   "decimalDaysPlusHalf": "2020-10-05T12:00:00Z",
   "decimalDaysPlusThreeQuarters": "2020-10-05T18:00:00Z",
   "decimalInputAsPeriod": "PT109H19M12S",
   "fourDayPeriod": "P4D",
   "negativeValue": "P-1D"
}
```

<!-- document id=6e45e4649fb3fd0c2d7c02eee6c8030298948e2bbb49c7e1cc383356dea06f99 url=/mulesoft/current/en-us/dataweave/latest/dw-periods-functions-days.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# days

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## days(nDays: Number): Period

Creates a Period value from the provided number of days.

The function applies the `period` function to input that is a whole number and the `duration`
function to decimal input.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>nDays</code></p></td><td><p>The number of hours as a whole or decimal number. A positive or negative number is valid.</p></td></tr></tbody></table>

### Example

This example shows how `days` behaves with different inputs. It adds and subtracts hours from
DateTime values. It also converts the decimal value `4.555` into a number of hours, minutes, and
second in the Period format (`PT109H19M12S`) and the whole number `4` into a number of days in the
Period format (`P4D`).

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Periods
output application/json
---
{
   tomorrow: |2020-10-05T20:22:34.385Z| + days(1),
   yesterday: |2020-10-05T20:22:34.385Z| - days(1),
   decimalDaysPlusQuarter:  |2020-10-05T00:00:00.000Z| + days(0.25),
   decimalDaysPlusHalf:  |2020-10-05T00:00:00.000Z| + days(0.5),
   decimalDaysPlusThreeQuarters:  |2020-10-05T00:00:00.000Z| + days(0.75),
   decimalInputAsPeriod : days(4.555),
   fourDayPeriod: days(4),
   negativeValue: days(-1)
}
```

#### Output

```Json
{
   "tomorrow": "2020-10-06T20:22:34.385Z",
   "yesterday": "2020-10-04T20:22:34.385Z",
   "decimalDaysPlusQuarter": "2020-10-05T06:00:00Z",
   "decimalDaysPlusHalf": "2020-10-05T12:00:00Z",
   "decimalDaysPlusThreeQuarters": "2020-10-05T18:00:00Z",
   "decimalInputAsPeriod": "PT109H19M12S",
   "fourDayPeriod": "P4D",
   "negativeValue": "P-1D"
}
```

<!-- document id=c0360542eb15763ebae7a911c3e9221865641500fc019d723a4fee1728b28856 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-daysbetween.md -->

---
product: DataWeave
version: 2.11
---

# daysBetween

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## daysBetween(from: Date, to: Date): Number

Returns the number of days between two dates.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>from</code></p></td><td><p>From date (a <code>Date</code> type).</p></td></tr><tr><td><p><code>to</code></p></td><td><p>To date (a <code>Date</code> type). Note that if the <code>to</code> date is <em>earlier</em> than the <code>from</code> date, the function returns a negative number equal to the number of days between the two dates.</p></td></tr></tbody></table>

### Example

This example returns the number of days between the specified dates.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ days : daysBetween('2016-10-01T23:57:59-03:00', '2017-10-01T23:57:59-03:00') }
```

#### Output

```JSON
{ "days" : 365 }
```

<!-- document id=44902f0f9fa7867f69bc5b0ae498d78fa8e3dcae54bb2f34289db4e302ace159 url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-daysbetween.md -->

---
product: DataWeave
version: 2.12
---

# daysBetween

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## daysBetween(from: Date, to: Date): Number

Returns the number of days between two dates.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>from</code></p></td><td><p>From date (a <code>Date</code> type).</p></td></tr><tr><td><p><code>to</code></p></td><td><p>To date (a <code>Date</code> type). Note that if the <code>to</code> date is <em>earlier</em> than the <code>from</code> date, the function returns a negative number equal to the number of days between the two dates.</p></td></tr></tbody></table>

### Example

This example returns the number of days between the specified dates.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ days : daysBetween('2016-10-01T23:57:59-03:00', '2017-10-01T23:57:59-03:00') }
```

#### Output

```JSON
{ "days" : 365 }
```

<!-- document id=cc07ba2fc9ba7d9a2ae85c55c3ec4e113c3f498c9cf0f133192b33dfc72dd7ef url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-daysbetween.md -->

---
product: DataWeave
version: 2.3
---

# daysBetween

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## daysBetween(Date, Date): Number

Returns the number of days between two dates.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>from</code></p></td><td><p>From date (a <code>Date</code> type).</p></td></tr><tr><td><p><code>to</code></p></td><td><p>To date (a <code>Date</code> type). Note that if the <code>to</code> date is <em>earlier</em> than the <code>from</code> date, the function returns a negative number equal to the number of days between the two dates.</p></td></tr></tbody></table>

### Example

This example returns the number of days between the specified dates.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ days : daysBetween('2016-10-01T23:57:59-03:00', '2017-10-01T23:57:59-03:00') }
```

#### Output

```JSON
 { "days" : 365 }
```

<!-- document id=ac2d3236dc95f8097dd4ed2616f6dfc5a785f3c2750dc7fb771269809a2015ac url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-daysbetween.md -->

---
product: DataWeave
version: 2.4
---

# daysBetween

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## daysBetween(from: Date, to: Date): Number

Returns the number of days between two dates.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>from</code></p></td><td><p>From date (a <code>Date</code> type).</p></td></tr><tr><td><p><code>to</code></p></td><td><p>To date (a <code>Date</code> type). Note that if the <code>to</code> date is <em>earlier</em> than the <code>from</code> date, the function returns a negative number equal to the number of days between the two dates.</p></td></tr></tbody></table>

### Example

This example returns the number of days between the specified dates.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ days : daysBetween('2016-10-01T23:57:59-03:00', '2017-10-01T23:57:59-03:00') }
```

#### Output

```JSON
{ "days" : 365 }
```

<!-- document id=be579f868bccd0ce9edaca334c9acb1f33eae013bbf562cbd2cd4fb2edfa2701 url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-daysbetween.md -->

---
product: DataWeave
version: 2.6
---

# daysBetween

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## daysBetween(from: Date, to: Date): Number

Returns the number of days between two dates.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>from</code></p></td><td><p>From date (a <code>Date</code> type).</p></td></tr><tr><td><p><code>to</code></p></td><td><p>To date (a <code>Date</code> type). Note that if the <code>to</code> date is <em>earlier</em> than the <code>from</code> date, the function returns a negative number equal to the number of days between the two dates.</p></td></tr></tbody></table>

### Example

This example returns the number of days between the specified dates.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ days : daysBetween('2016-10-01T23:57:59-03:00', '2017-10-01T23:57:59-03:00') }
```

#### Output

```JSON
{ "days" : 365 }
```

<!-- document id=7ee0c088b9c64b58fc5c970f39a1d8bc1202b057bd2bbed2579812c90218fa23 url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-daysbetween.md -->

---
product: DataWeave
version: 2.9
---

# daysBetween

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## daysBetween(from: Date, to: Date): Number

Returns the number of days between two dates.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>from</code></p></td><td><p>From date (a <code>Date</code> type).</p></td></tr><tr><td><p><code>to</code></p></td><td><p>To date (a <code>Date</code> type). Note that if the <code>to</code> date is <em>earlier</em> than the <code>from</code> date, the function returns a negative number equal to the number of days between the two dates.</p></td></tr></tbody></table>

### Example

This example returns the number of days between the specified dates.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ days : daysBetween('2016-10-01T23:57:59-03:00', '2017-10-01T23:57:59-03:00') }
```

#### Output

```JSON
{ "days" : 365 }
```

<!-- document id=6b78eb89b923e3bc768c95ddb3c7982a1a80a7d1f0afa063ee8228a1d37b7a25 url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-daysbetween.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# daysBetween

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## daysBetween(from: Date, to: Date): Number

Returns the number of days between two dates.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>from</code></p></td><td><p>From date (a <code>Date</code> type).</p></td></tr><tr><td><p><code>to</code></p></td><td><p>To date (a <code>Date</code> type). Note that if the <code>to</code> date is <em>earlier</em> than the <code>from</code> date, the function returns a negative number equal to the number of days between the two dates.</p></td></tr></tbody></table>

### Example

This example returns the number of days between the specified dates.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ days : daysBetween('2016-10-01T23:57:59-03:00', '2017-10-01T23:57:59-03:00') }
```

#### Output

```JSON
{ "days" : 365 }
```

<!-- document id=0b2d3c553035776f1e6433a7f6a02feddbb29f744e185fe57785ad04d0f90398 url=/mulesoft/current/en-us/dataweave/2.11/dw-math-functions-decimaladd.md -->

---
product: DataWeave
version: 2.11
---

# decimalAdd

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## decimalAdd(lhs: Number, rhs: Number, ctx: OperationContext = DECIMAL\_128\_CONTEXT): Number

Performs number addition with rounding specified by the operation context.

<!-- document id=d3708f1371962212926971045b4d3c8f788ec6c85b4ad9fc3c78bdc85e993b3a url=/mulesoft/current/en-us/dataweave/2.12/dw-math-functions-decimaladd.md -->

---
product: DataWeave
version: 2.12
---

# decimalAdd

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## decimalAdd(lhs: Number, rhs: Number, ctx: OperationContext = DECIMAL\_128\_CONTEXT): Number

Performs number addition with rounding specified by the operation context.

<!-- document id=eb649a77f3c4e40d7bb4270fd6642a23b3f9d2899d8506cee1ed60ab895caa62 url=/mulesoft/current/en-us/dataweave/latest/dw-math-functions-decimaladd.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# decimalAdd

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## decimalAdd(lhs: Number, rhs: Number, ctx: OperationContext = DECIMAL\_128\_CONTEXT): Number

Performs number addition with rounding specified by the operation context.

<!-- document id=7d873d7484852de46afe2ef6636d7c39b0cfce7ecf927c4f31cc8d908b1387fb url=/mulesoft/current/en-us/dataweave/2.11/dw-math-functions-decimaldivide.md -->

---
product: DataWeave
version: 2.11
---

# decimalDivide

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## decimalDivide(dividend: Number, divisor: Number, ctx: OperationContext = DECIMAL\_128\_CONTEXT): Number

Performs number division with rounding specified by the operation context. If precision is set to 0
(unlimited precision) and the result has an infinite decimal expansion, the function returns an
error.

<!-- document id=50298d1e361c3c410658f29ac1342aac98b2d1fa1ebc418096ee103bef256b8e url=/mulesoft/current/en-us/dataweave/2.12/dw-math-functions-decimaldivide.md -->

---
product: DataWeave
version: 2.12
---

# decimalDivide

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## decimalDivide(dividend: Number, divisor: Number, ctx: OperationContext = DECIMAL\_128\_CONTEXT): Number

Performs number division with rounding specified by the operation context. If precision is set to 0
(unlimited precision) and the result has an infinite decimal expansion, the function returns an
error.

<!-- document id=e74a050f72f4a34475e0d359eb025939f296fd03208f824386a8a2ae3483a9aa url=/mulesoft/current/en-us/dataweave/latest/dw-math-functions-decimaldivide.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# decimalDivide

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## decimalDivide(dividend: Number, divisor: Number, ctx: OperationContext = DECIMAL\_128\_CONTEXT): Number

Performs number division with rounding specified by the operation context. If precision is set to 0
(unlimited precision) and the result has an infinite decimal expansion, the function returns an
error.

<!-- document id=9bd7d8d0ee18abda4fe06a389f5335ed6243f87e21fc579be31772586a8ad070 url=/mulesoft/current/en-us/dataweave/2.11/dw-math-functions-decimalmultiply.md -->

---
product: DataWeave
version: 2.11
---

# decimalMultiply

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## decimalMultiply(leftFactor: Number, rightFactor: Number, ctx: OperationContext = DECIMAL\_128\_CONTEXT): Number

Performs number multiplication with rounding specified by the operation context.

<!-- document id=5610f75b4e65c3c66f29662f467c092d78806c997cca762fa49bcb7f15cb3567 url=/mulesoft/current/en-us/dataweave/2.12/dw-math-functions-decimalmultiply.md -->

---
product: DataWeave
version: 2.12
---

# decimalMultiply

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## decimalMultiply(leftFactor: Number, rightFactor: Number, ctx: OperationContext = DECIMAL\_128\_CONTEXT): Number

Performs number multiplication with rounding specified by the operation context.

<!-- document id=d22813041a60ceb5b5834cb81c27a07b95eb4bdec13e5dd26ff9dabe70384f9a url=/mulesoft/current/en-us/dataweave/latest/dw-math-functions-decimalmultiply.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# decimalMultiply

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## decimalMultiply(leftFactor: Number, rightFactor: Number, ctx: OperationContext = DECIMAL\_128\_CONTEXT): Number

Performs number multiplication with rounding specified by the operation context.

<!-- document id=57330d0bc78c26d1fe1503ca2a907de9fe4500a09e0a7f852ed34aa539e12e0b url=/mulesoft/current/en-us/dataweave/2.11/dw-math-functions-decimalpow.md -->

---
product: DataWeave
version: 2.11
---

# decimalPow

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## decimalPow(base: Number, exponent: Number, ctx: OperationContext = DECIMAL\_128\_CONTEXT): Number

Returns a number with value base^exponent with rounding specified by the operation context. The
maximum value for exponent is 99999999.

<!-- document id=e8d298b746c232d862dfb6ae8cef7834a90c4900f56a221a8462f1b1f4b6c511 url=/mulesoft/current/en-us/dataweave/2.12/dw-math-functions-decimalpow.md -->

---
product: DataWeave
version: 2.12
---

# decimalPow

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## decimalPow(base: Number, exponent: Number, ctx: OperationContext = DECIMAL\_128\_CONTEXT): Number

Returns a number with value base^exponent with rounding specified by the operation context. The
maximum value for exponent is 99999999.

<!-- document id=eec5438e59447eb2783e06cf8b48a6e4db93eacf7ccb0b457c4c69a2b1fced33 url=/mulesoft/current/en-us/dataweave/latest/dw-math-functions-decimalpow.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# decimalPow

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## decimalPow(base: Number, exponent: Number, ctx: OperationContext = DECIMAL\_128\_CONTEXT): Number

Returns a number with value base^exponent with rounding specified by the operation context. The
maximum value for exponent is 99999999.

<!-- document id=e76fa30830e8153b1ebe30d28ca27cf40d7214b806d628d1220787f6e5e6d69d url=/mulesoft/current/en-us/dataweave/2.11/dw-math-functions-decimalround.md -->

---
product: DataWeave
version: 2.11
---

# decimalRound

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## decimalRound(n: Number, ctx: OperationContext = DECIMAL\_128\_CONTEXT)

Returns the argument number with rounding specified by the operation context.

<!-- document id=228300acc356cb7868faf13a5f1176b270bee8000eefbf810fd8df06277f4335 url=/mulesoft/current/en-us/dataweave/2.12/dw-math-functions-decimalround.md -->

---
product: DataWeave
version: 2.12
---

# decimalRound

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## decimalRound(n: Number, ctx: OperationContext = DECIMAL\_128\_CONTEXT)

Returns the argument number with rounding specified by the operation context.

<!-- document id=3fcb3ebe384d7da2ecf9fdedae7886c143188d70e134376494ec8fc4eb4dddab url=/mulesoft/current/en-us/dataweave/latest/dw-math-functions-decimalround.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# decimalRound

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## decimalRound(n: Number, ctx: OperationContext = DECIMAL\_128\_CONTEXT)

Returns the argument number with rounding specified by the operation context.

<!-- document id=facfd664a0fdec811ca0e31404342315c12d60a6a55c0d15a48ca684a859a0ee url=/mulesoft/current/en-us/dataweave/2.11/dw-math-functions-decimalsqrt.md -->

---
product: DataWeave
version: 2.11
---

# decimalSqrt

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## decimalSqrt(n: Number, ctx: OperationContext = DECIMAL\_128\_CONTEXT): Number

Returns a number that approximates the square root of the argument with rounding specified by the
operation context.

<!-- document id=ad7246decc2c41b76b44d527402ce169f5cf06365b69486ceb9f1a782b5fe531 url=/mulesoft/current/en-us/dataweave/2.12/dw-math-functions-decimalsqrt.md -->

---
product: DataWeave
version: 2.12
---

# decimalSqrt

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## decimalSqrt(n: Number, ctx: OperationContext = DECIMAL\_128\_CONTEXT): Number

Returns a number that approximates the square root of the argument with rounding specified by the
operation context.

<!-- document id=7acd27dcba3212a37afae187791166c60fc1067ab951d30c99f56265b79fd11b url=/mulesoft/current/en-us/dataweave/latest/dw-math-functions-decimalsqrt.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# decimalSqrt

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## decimalSqrt(n: Number, ctx: OperationContext = DECIMAL\_128\_CONTEXT): Number

Returns a number that approximates the square root of the argument with rounding specified by the
operation context.

<!-- document id=c410be9ee31cee14a20907fbba0a8cc43b66bba45fb7581e9d42344c7e73abb8 url=/mulesoft/current/en-us/dataweave/2.11/dw-math-functions-decimalsubtract.md -->

---
product: DataWeave
version: 2.11
---

# decimalSubtract

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## decimalSubtract(lhs: Number, rhs: Number, ctx: OperationContext = DECIMAL\_128\_CONTEXT): Number

Performs number subtraction with rounding specified by the operation context.

<!-- document id=e55b9e6e5549c833befe88989108cf3e54e5f5ad8a2ec08760e7098ac4363ade url=/mulesoft/current/en-us/dataweave/2.12/dw-math-functions-decimalsubtract.md -->

---
product: DataWeave
version: 2.12
---

# decimalSubtract

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## decimalSubtract(lhs: Number, rhs: Number, ctx: OperationContext = DECIMAL\_128\_CONTEXT): Number

Performs number subtraction with rounding specified by the operation context.

<!-- document id=1e9c9df39cdf9d1a72f933ce4390698efc5ed8742e528c9ff3a34b5e1e9ae97d url=/mulesoft/current/en-us/dataweave/latest/dw-math-functions-decimalsubtract.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# decimalSubtract

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## decimalSubtract(lhs: Number, rhs: Number, ctx: OperationContext = DECIMAL\_128\_CONTEXT): Number

Performs number subtraction with rounding specified by the operation context.

<!-- document id=aa31c8c6f979c834926a1aaff2bb9ae3a4733dcfb630142f42df9809da38c7be url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook-decode-encode.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Decode and Encode Base64

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following DataWeave examples show how to convert a file stream into Base64 and to convert a
Base64 string into a file stream. They use a PDF file as the input and output.

MuleSoft uses the standard Base64 encoding as defined in
[RFC 4648, section 4](https://www.rfc-editor.org/rfc/rfc4648#section-4). This standard includes the
`+` and `/` characters and uses `=` for padding. The encoding isn’t URL safe. To use Base64 encoding
in a URL, you must first encode the URL separately.

## Encode a PDF File to Base64

This example performs Base64 encoding on a PDF file. It simulates the transformation in the Read
operation from the [XML configuration](#xml_config) by converting a Base64 file stream
(`application/octet-stream`) to Binary and outputting the Binary in the `text/plain` format.

The example uses the following functions:

- `toBase64` from the `dw::core::Binaries` module to transform a binary value to a Base64 string.

- `readUrl` from the `Core (dw::Core)` module to input a PDF file.

  The example assumes that the PDF file is in the `src/main/resources` directory of a Mule project
  in Anypoint Studio. It provides the name of the PDF file and specifies the MIME type as
  `"application/octet-stream"`. Using `"binary"` as the second `readUrl` argument is also valid for
  this example.

DataWeave Script:

```dataweave
%dw 2.0
import * from dw::core::Binaries
var myPDF = readUrl("classpath://pdf-test.pdf", "application/octet-stream")
output text/plain
---
toBase64(myPDF as Binary)
```

Output (partial results):

```json
JVBERi0xLjYNJeLjz9MNCjM3IDAgb2JqIDw8L0xpbmVhcml6ZWQgMS9MIDIwNTk3L08gNDAvRSAx
...
```

## Decode Base64

This example simulates the transformation in the Write operation from the
[XML configuration](#xml_config) by converting a Base64 file stream (`application/octet-stream`) to
Binary and outputting the Binary in the `application/PDF with binary` format. The example does not
generate a PDF file; a Write operation is required to generate such a file.

The examples use the following functions:

- `fromBase64` in the `dw::core::Binaries` module to transform a Base64 string to a binary value.

- `readUrl` to input a PDF file.

  The example assumes that the PDF file is in the `src/main/resources` directory of a Mule project
  in Anypoint Studio. The function reads the input PDF as an octet-stream MIME type. Using the MIME
  type `"binary"` as the second `readUrl` argument is also valid for this example.

DataWeave Script:

```dataweave
%dw 2.0
import * from dw::core::Binaries
var myPDF = readUrl("classpath://pdf-test.pdf", "application/octet-stream")
var myPDFasBinary = toBase64(myPDF as Binary)
output application/PDF with binary
---
fromBase64(myPDFasBinary as String) as Binary
```

The output is the text representation of the PDF.

Output (partial results):

```json
%PDF-1.6
%����
37 0 obj <</Linearized 1/L 20597/O 40/E 14115/N 1/T 19795/H [ 1005 215]>>
endobj

xref
37 34
0000000016 00000 n
...
```

## XML Configuration Example

In Anypoint Studio, you can create and run a Mule flow that encodes and decodes a PDF file. After
you complete the procedure, the example reads the file from the specified local directory using the
File Connector Read operation. It writes the PDF to the specified directory by using the File
Connector Write operation, and it uses Transform Message components to encode the file to Base64 and
to decode that output from Base64.

1.  Create a Mule project in Anypoint Studio:

    1.  Select **File > New > Mule Project**.

    2.  Enter a name for your Mule project.

    3.  Click **Finish**.

2.  Use **Add Module** in the Mule Palette to add the File Connector:

    1.  In the **Mule Palette** view, click **(X) Search in Exchange**.

    2.  In the **Add Dependencies to Project** window, type `file` in the search field.

    3.  Click **File Connector** in Available modules.

    4.  Click **Add**.

    5.  Click **Finish**.

3.  In the Studio canvas, navigate to the **Configuration XML** tab.

4.  Copy and paste the following example between the `<mule/>` elements of a Mule flow in Anypoint
    Studio:

    ```XML
    <http:listener-config name="HTTP_Listener_config"
                          doc:name="HTTP Listener config" >
        <http:listener-connection
                                host="0.0.0.0"
                                port="8081" />
    </http:listener-config>
    <file:config name="File_Config"
                 doc:name="File Config" >
        <file:connection workingDir="/Users/me/Downloads" />
    </file:config>
    <flow name="encode-decode-base64">
        <http:listener doc:name="Listener"
                     path="/transform"
                     config-ref="HTTP_Listener_config"/>
        <file:read doc:name="Read"
                 config-ref="File_Config"
                 path="pdf-test.pdf" />
        <ee:transform doc:name="Transform Message">
            <ee:message>
              <ee:set-payload><![CDATA[%dw 2.0
    import * from dw::core::Binaries
    output text/plain
    ---
    toBase64(payload as Binary)]]></ee:set-payload>
            </ee:message>
        </ee:transform>
        <ee:transform doc:name="Transform Message" >
            <ee:message >
              <ee:set-payload ><![CDATA[%dw 2.0
    import * from dw::core::Binaries
    output application/pdf with binary
    ---
    fromBase64(payload as String) as Binary]]></ee:set-payload>
            </ee:message>
        </ee:transform>
        <file:write doc:name="Write"
                  path="/Users/me/pdf-test-result.pdf"/>
        <set-payload
                  value='#["PDF file created in the directory specified in the Write operation."]'
                  doc:name="Set Payload" />
    </flow>
    ```

    Note that it is valid to replace the directive `output application/pdf with binary` in the
    second Transform Message component with `output application/octet-stream`.

5.  Place a PDF file of your choice into a local directory on your machine.

6.  Correct the input and output directories of the **Read** and **Write** operations:

    - In the **Read** operation, change the **File Path** value \`/Users/me/Downloads" to the
      location of your PDF file.

    - In the **Write** operation, change the **Path** value `/Users/me/pdf-test.pdf"` to the
      location and file name that you want to output the file.

7.  Run the project in Studio.

8.  Load the `0.0.0.0:8081/transform` into a browser.

    This action creates a PDF file in the specified location and generates a separate `transform`
    file with the message in the Set Payload component,
    `PDF file created in the directory specified in the Write operation.`

## See Also

- [Binaries (dw::core::Binaries)](https://docs.mulesoft.com/dataweave/2.11/dw-binaries)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.11/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook)

<!-- document id=b2430e3553732645e3191f7e8cee52e63864f8bc9dadaddc9594924bb1b20a75 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook-decode-encode.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Decode and Encode Base64

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following DataWeave examples show how to convert a file stream into Base64 and to convert a
Base64 string into a file stream. They use a PDF file as the input and output.

MuleSoft uses the standard Base64 encoding as defined in
[RFC 4648, section 4](https://www.rfc-editor.org/rfc/rfc4648#section-4). This standard includes the
`+` and `/` characters and uses `=` for padding. The encoding isn’t URL safe. To use Base64 encoding
in a URL, you must first encode the URL separately.

## Encode a PDF File to Base64

This example performs Base64 encoding on a PDF file. It simulates the transformation in the Read
operation from the [XML configuration](#xml_config) by converting a Base64 file stream
(`application/octet-stream`) to Binary and outputting the Binary in the `text/plain` format.

The example uses the following functions:

- `toBase64` from the `dw::core::Binaries` module to transform a binary value to a Base64 string.

- `readUrl` from the `Core (dw::Core)` module to input a PDF file.

  The example assumes that the PDF file is in the `src/main/resources` directory of a Mule project
  in Anypoint Studio. It provides the name of the PDF file and specifies the MIME type as
  `"application/octet-stream"`. Using `"binary"` as the second `readUrl` argument is also valid for
  this example.

DataWeave Script:

```dataweave
%dw 2.0
import * from dw::core::Binaries
var myPDF = readUrl("classpath://pdf-test.pdf", "application/octet-stream")
output text/plain
---
toBase64(myPDF as Binary)
```

Output (partial results):

```json
JVBERi0xLjYNJeLjz9MNCjM3IDAgb2JqIDw8L0xpbmVhcml6ZWQgMS9MIDIwNTk3L08gNDAvRSAx
...
```

## Decode Base64

This example simulates the transformation in the Write operation from the
[XML configuration](#xml_config) by converting a Base64 file stream (`application/octet-stream`) to
Binary and outputting the Binary in the `application/PDF with binary` format. The example does not
generate a PDF file; a Write operation is required to generate such a file.

The examples use the following functions:

- `fromBase64` in the `dw::core::Binaries` module to transform a Base64 string to a binary value.

- `readUrl` to input a PDF file.

  The example assumes that the PDF file is in the `src/main/resources` directory of a Mule project
  in Anypoint Studio. The function reads the input PDF as an octet-stream MIME type. Using the MIME
  type `"binary"` as the second `readUrl` argument is also valid for this example.

DataWeave Script:

```dataweave
%dw 2.0
import * from dw::core::Binaries
var myPDF = readUrl("classpath://pdf-test.pdf", "application/octet-stream")
var myPDFasBinary = toBase64(myPDF as Binary)
output application/PDF with binary
---
fromBase64(myPDFasBinary as String) as Binary
```

The output is the text representation of the PDF.

Output (partial results):

```json
%PDF-1.6
%����
37 0 obj <</Linearized 1/L 20597/O 40/E 14115/N 1/T 19795/H [ 1005 215]>>
endobj

xref
37 34
0000000016 00000 n
...
```

## XML Configuration Example

In Anypoint Studio, you can create and run a Mule flow that encodes and decodes a PDF file. After
you complete the procedure, the example reads the file from the specified local directory using the
File Connector Read operation. It writes the PDF to the specified directory by using the File
Connector Write operation, and it uses Transform Message components to encode the file to Base64 and
to decode that output from Base64.

1.  Create a Mule project in Anypoint Studio:

    1.  Select **File > New > Mule Project**.

    2.  Enter a name for your Mule project.

    3.  Click **Finish**.

2.  Use **Add Module** in the Mule Palette to add the File Connector:

    1.  In the **Mule Palette** view, click **(X) Search in Exchange**.

    2.  In the **Add Dependencies to Project** window, type `file` in the search field.

    3.  Click **File Connector** in Available modules.

    4.  Click **Add**.

    5.  Click **Finish**.

3.  In the Studio canvas, navigate to the **Configuration XML** tab.

4.  Copy and paste the following example between the `<mule/>` elements of a Mule flow in Anypoint
    Studio:

    ```XML
    <http:listener-config name="HTTP_Listener_config"
                          doc:name="HTTP Listener config" >
        <http:listener-connection
                                host="0.0.0.0"
                                port="8081" />
    </http:listener-config>
    <file:config name="File_Config"
                 doc:name="File Config" >
        <file:connection workingDir="/Users/me/Downloads" />
    </file:config>
    <flow name="encode-decode-base64">
        <http:listener doc:name="Listener"
                     path="/transform"
                     config-ref="HTTP_Listener_config"/>
        <file:read doc:name="Read"
                 config-ref="File_Config"
                 path="pdf-test.pdf" />
        <ee:transform doc:name="Transform Message">
            <ee:message>
              <ee:set-payload><![CDATA[%dw 2.0
    import * from dw::core::Binaries
    output text/plain
    ---
    toBase64(payload as Binary)]]></ee:set-payload>
            </ee:message>
        </ee:transform>
        <ee:transform doc:name="Transform Message" >
            <ee:message >
              <ee:set-payload ><![CDATA[%dw 2.0
    import * from dw::core::Binaries
    output application/pdf with binary
    ---
    fromBase64(payload as String) as Binary]]></ee:set-payload>
            </ee:message>
        </ee:transform>
        <file:write doc:name="Write"
                  path="/Users/me/pdf-test-result.pdf"/>
        <set-payload
                  value='#["PDF file created in the directory specified in the Write operation."]'
                  doc:name="Set Payload" />
    </flow>
    ```

    Note that it is valid to replace the directive `output application/pdf with binary` in the
    second Transform Message component with `output application/octet-stream`.

5.  Place a PDF file of your choice into a local directory on your machine.

6.  Correct the input and output directories of the **Read** and **Write** operations:

    - In the **Read** operation, change the **File Path** value \`/Users/me/Downloads" to the
      location of your PDF file.

    - In the **Write** operation, change the **Path** value `/Users/me/pdf-test.pdf"` to the
      location and file name that you want to output the file.

7.  Run the project in Studio.

8.  Load the `0.0.0.0:8081/transform` into a browser.

    This action creates a PDF file in the specified location and generates a separate `transform`
    file with the message in the Set Payload component,
    `PDF file created in the directory specified in the Write operation.`

## See Also

- [Binaries (dw::core::Binaries)](https://docs.mulesoft.com/dataweave/2.12/dw-binaries)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.12/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook)

<!-- document id=02a43b31b839e88fc922facd2f3c866b4c833a2b7f3ae488293facd68011db9c url=/mulesoft/current/en-us/dataweave/2.3/dataweave-cookbook-decode-encode.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Decode and Encode Base64

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following DataWeave examples show how to convert a file stream into Base64 and to convert a
Base64 string into a file stream. They use a PDF file as the input and output.

## Encode a PDF File to Base64

This example performs Base64 encoding on a PDF file. It simulates the transformation in the Read
operation from the [XML configuration](#xml_config) by converting a Base64 file stream
(`application/octet-stream`) to Binary and outputting the Binary in the `text/plain` format.

The example uses the following functions:

- `toBase64` from the `dw::core::Binaries` module to transform a binary value to a Base64 string.

- `readUrl` from the `Core (dw::Core)` module to input a PDF file.

  The example assumes that the PDF file is in the `src/main/resources` directory of a Mule project
  in Anypoint Studio. It provides the name of the PDF file and specifies the MIME type as
  `"application/octet-stream"`. Using `"binary"` as the second `readUrl` argument is also valid for
  this example.

DataWeave Script:

```dataweave
%dw 2.0
import * from dw::core::Binaries
var myPDF = readUrl("classpath://pdf-test.pdf", "application/octet-stream")
output text/plain
---
toBase64(myPDF as Binary)
```

Output (partial results):

```json
JVBERi0xLjYNJeLjz9MNCjM3IDAgb2JqIDw8L0xpbmVhcml6ZWQgMS9MIDIwNTk3L08gNDAvRSAx
...
```

## Decode Base64

This example simulates the transformation in the Write operation from the
[XML configuration](#xml_config) by converting a Base64 file stream (`application/octet-stream`) to
Binary and outputting the Binary in the `application/PDF with binary` format. The example does not
generate a PDF file; a Write operation is required to generate such a file.

The examples use the following functions:

- `fromBase64` in the `dw::core::Binaries` module to transform a Base64 string to a binary value.

- `readUrl` to input a PDF file.

  The example assumes that the PDF file is in the `src/main/resources` directory of a Mule project
  in Anypoint Studio. The function reads the input PDF as an octet-stream MIME type. Using the MIME
  type `"binary"` as the second `readUrl` argument is also valid for this example.

DataWeave Script:

```dataweave
%dw 2.0
import * from dw::core::Binaries
var myPDF = readUrl("classpath://pdf-test.pdf", "application/octet-stream")
var myPDFasBinary = toBase64(myPDF as Binary)
output application/PDF with binary
---
fromBase64(myPDFasBinary as String) as Binary
```

The output is the text representation of the PDF.

Output (partial results):

```json
%PDF-1.6
%����
37 0 obj <</Linearized 1/L 20597/O 40/E 14115/N 1/T 19795/H [ 1005 215]>>
endobj

xref
37 34
0000000016 00000 n
...
```

## XML Configuration Example

In Anypoint Studio, you can create and run a Mule flow that encodes and decodes a PDF file. After
you complete the procedure, the example reads the file from the specified local directory using the
File Connector Read operation. It writes the PDF to the specified directory by using the File
Connector Write operation, and it uses Transform Message components to encode the file to Base64 and
to decode that output from Base64.

1.  Create a Mule project in Anypoint Studio:

    1.  Select **File > New > Mule Project**.

    2.  Enter a name for your Mule project.

    3.  Click **Finish**.

2.  Use **Add Module** in the Mule Palette to add the File Connector:

    1.  In the **Mule Palette** view, click **(X) Search in Exchange**.

    2.  In the **Add Dependencies to Project** window, type `file` in the search field.

    3.  Click **File Connector** in Available modules.

    4.  Click **Add**.

    5.  Click **Finish**.

3.  In the Studio canvas, navigate to the **Configuration XML** tab.

4.  Copy and paste the following example between the `<mule/>` elements of a Mule flow in Anypoint
    Studio:

    ```XML
    <http:listener-config name="HTTP_Listener_config"
                          doc:name="HTTP Listener config" >
        <http:listener-connection
                                host="0.0.0.0"
                                port="8081" />
    </http:listener-config>
    <file:config name="File_Config"
                 doc:name="File Config" >
        <file:connection workingDir="/Users/me/Downloads" />
    </file:config>
    <flow name="encode-decode-base64">
        <http:listener doc:name="Listener"
                     path="/transform"
                     config-ref="HTTP_Listener_config"/>
        <file:read doc:name="Read"
                 config-ref="File_Config"
                 path="pdf-test.pdf" />
        <ee:transform doc:name="Transform Message">
            <ee:message>
              <ee:set-payload><![CDATA[%dw 2.0
    import * from dw::core::Binaries
    output text/plain
    ---
    toBase64(payload as Binary)]]></ee:set-payload>
            </ee:message>
        </ee:transform>
        <ee:transform doc:name="Transform Message" >
            <ee:message >
              <ee:set-payload ><![CDATA[%dw 2.0
    import * from dw::core::Binaries
    output application/pdf with binary
    ---
    fromBase64(payload as String) as Binary]]></ee:set-payload>
            </ee:message>
        </ee:transform>
        <file:write doc:name="Write"
                  path="/Users/me/pdf-test-result.pdf"/>
        <set-payload
                  value='#["PDF file created in the directory specified in the Write operation."]'
                  doc:name="Set Payload" />
    </flow>
    ```

    Note that it is valid to replace the directive `output application/pdf with binary` in the
    second Transform Message component with `output application/octet-stream`.

5.  Place a PDF file of your choice into a local directory on your machine.

6.  Correct the input and output directories of the **Read** and **Write** operations:

    - In the **Read** operation, change the **File Path** value \`/Users/me/Downloads" to the
      location of your PDF file.

    - In the **Write** operation, change the **Path** value `/Users/me/pdf-test.pdf"` to the
      location and file name that you want to output the file.

7.  Run the project in Studio.

8.  Load the `0.0.0.0:8081/transform` into a browser.

    This action creates a PDF file in the specified location and generates a separate `transform`
    file with the message in the Set Payload component,
    `PDF file created in the directory specified in the Write operation.`

## See Also

- [Binaries (dw::core::Binaries)](https://docs.mulesoft.com/dataweave/2.3/dw-binaries)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.3/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook)

<!-- document id=1af0444d6a4f4f6b6e5dbbd2938d57b689738ed7d40063ff140f2bc9b0d81687 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook-decode-encode.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Decode and Encode Base64

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following DataWeave examples show how to convert a file stream into Base64 and to convert a
Base64 string into a file stream. They use a PDF file as the input and output.

MuleSoft uses the standard Base64 encoding as defined in
[RFC 4648, section 4](https://www.rfc-editor.org/rfc/rfc4648#section-4). This standard includes the
`+` and `/` characters and uses `=` for padding. The encoding isn’t URL safe. To use Base64 encoding
in a URL, you must first encode the URL separately.

## Encode a PDF File to Base64

This example performs Base64 encoding on a PDF file. It simulates the transformation in the Read
operation from the [XML configuration](#xml_config) by converting a Base64 file stream
(`application/octet-stream`) to Binary and outputting the Binary in the `text/plain` format.

The example uses the following functions:

- `toBase64` from the `dw::core::Binaries` module to transform a binary value to a Base64 string.

- `readUrl` from the `Core (dw::Core)` module to input a PDF file.

  The example assumes that the PDF file is in the `src/main/resources` directory of a Mule project
  in Anypoint Studio. It provides the name of the PDF file and specifies the MIME type as
  `"application/octet-stream"`. Using `"binary"` as the second `readUrl` argument is also valid for
  this example.

DataWeave Script:

```dataweave
%dw 2.0
import * from dw::core::Binaries
var myPDF = readUrl("classpath://pdf-test.pdf", "application/octet-stream")
output text/plain
---
toBase64(myPDF as Binary)
```

Output (partial results):

```json
JVBERi0xLjYNJeLjz9MNCjM3IDAgb2JqIDw8L0xpbmVhcml6ZWQgMS9MIDIwNTk3L08gNDAvRSAx
...
```

## Decode Base64

This example simulates the transformation in the Write operation from the
[XML configuration](#xml_config) by converting a Base64 file stream (`application/octet-stream`) to
Binary and outputting the Binary in the `application/PDF with binary` format. The example does not
generate a PDF file; a Write operation is required to generate such a file.

The examples use the following functions:

- `fromBase64` in the `dw::core::Binaries` module to transform a Base64 string to a binary value.

- `readUrl` to input a PDF file.

  The example assumes that the PDF file is in the `src/main/resources` directory of a Mule project
  in Anypoint Studio. The function reads the input PDF as an octet-stream MIME type. Using the MIME
  type `"binary"` as the second `readUrl` argument is also valid for this example.

DataWeave Script:

```dataweave
%dw 2.0
import * from dw::core::Binaries
var myPDF = readUrl("classpath://pdf-test.pdf", "application/octet-stream")
var myPDFasBinary = toBase64(myPDF as Binary)
output application/PDF with binary
---
fromBase64(myPDFasBinary as String) as Binary
```

The output is the text representation of the PDF.

Output (partial results):

```json
%PDF-1.6
%����
37 0 obj <</Linearized 1/L 20597/O 40/E 14115/N 1/T 19795/H [ 1005 215]>>
endobj

xref
37 34
0000000016 00000 n
...
```

## XML Configuration Example

In Anypoint Studio, you can create and run a Mule flow that encodes and decodes a PDF file. After
you complete the procedure, the example reads the file from the specified local directory using the
File Connector Read operation. It writes the PDF to the specified directory by using the File
Connector Write operation, and it uses Transform Message components to encode the file to Base64 and
to decode that output from Base64.

1.  Create a Mule project in Anypoint Studio:

    1.  Select **File > New > Mule Project**.

    2.  Enter a name for your Mule project.

    3.  Click **Finish**.

2.  Use **Add Module** in the Mule Palette to add the File Connector:

    1.  In the **Mule Palette** view, click **(X) Search in Exchange**.

    2.  In the **Add Dependencies to Project** window, type `file` in the search field.

    3.  Click **File Connector** in Available modules.

    4.  Click **Add**.

    5.  Click **Finish**.

3.  In the Studio canvas, navigate to the **Configuration XML** tab.

4.  Copy and paste the following example between the `<mule/>` elements of a Mule flow in Anypoint
    Studio:

    ```XML
    <http:listener-config name="HTTP_Listener_config"
                          doc:name="HTTP Listener config" >
        <http:listener-connection
                                host="0.0.0.0"
                                port="8081" />
    </http:listener-config>
    <file:config name="File_Config"
                 doc:name="File Config" >
        <file:connection workingDir="/Users/me/Downloads" />
    </file:config>
    <flow name="encode-decode-base64">
        <http:listener doc:name="Listener"
                     path="/transform"
                     config-ref="HTTP_Listener_config"/>
        <file:read doc:name="Read"
                 config-ref="File_Config"
                 path="pdf-test.pdf" />
        <ee:transform doc:name="Transform Message">
            <ee:message>
              <ee:set-payload><![CDATA[%dw 2.0
    import * from dw::core::Binaries
    output text/plain
    ---
    toBase64(payload as Binary)]]></ee:set-payload>
            </ee:message>
        </ee:transform>
        <ee:transform doc:name="Transform Message" >
            <ee:message >
              <ee:set-payload ><![CDATA[%dw 2.0
    import * from dw::core::Binaries
    output application/pdf with binary
    ---
    fromBase64(payload as String) as Binary]]></ee:set-payload>
            </ee:message>
        </ee:transform>
        <file:write doc:name="Write"
                  path="/Users/me/pdf-test-result.pdf"/>
        <set-payload
                  value='#["PDF file created in the directory specified in the Write operation."]'
                  doc:name="Set Payload" />
    </flow>
    ```

    Note that it is valid to replace the directive `output application/pdf with binary` in the
    second Transform Message component with `output application/octet-stream`.

5.  Place a PDF file of your choice into a local directory on your machine.

6.  Correct the input and output directories of the **Read** and **Write** operations:

    - In the **Read** operation, change the **File Path** value \`/Users/me/Downloads" to the
      location of your PDF file.

    - In the **Write** operation, change the **Path** value `/Users/me/pdf-test.pdf"` to the
      location and file name that you want to output the file.

7.  Run the project in Studio.

8.  Load the `0.0.0.0:8081/transform` into a browser.

    This action creates a PDF file in the specified location and generates a separate `transform`
    file with the message in the Set Payload component,
    `PDF file created in the directory specified in the Write operation.`

## See Also

- [Binaries (dw::core::Binaries)](https://docs.mulesoft.com/dataweave/2.4/dw-binaries)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.4/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook)

<!-- document id=395a657602f562fb768449820353c43171b1eaa6a984e2e058cd05bd21a46dc5 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook-decode-encode.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Decode and Encode Base64

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following DataWeave examples show how to convert a file stream into Base64 and to convert a
Base64 string into a file stream. They use a PDF file as the input and output.

MuleSoft uses the standard Base64 encoding as defined in
[RFC 4648, section 4](https://www.rfc-editor.org/rfc/rfc4648#section-4). This standard includes the
`+` and `/` characters and uses `=` for padding. The encoding isn’t URL safe. To use Base64 encoding
in a URL, you must first encode the URL separately.

## Encode a PDF File to Base64

This example performs Base64 encoding on a PDF file. It simulates the transformation in the Read
operation from the [XML configuration](#xml_config) by converting a Base64 file stream
(`application/octet-stream`) to Binary and outputting the Binary in the `text/plain` format.

The example uses the following functions:

- `toBase64` from the `dw::core::Binaries` module to transform a binary value to a Base64 string.

- `readUrl` from the `Core (dw::Core)` module to input a PDF file.

  The example assumes that the PDF file is in the `src/main/resources` directory of a Mule project
  in Anypoint Studio. It provides the name of the PDF file and specifies the MIME type as
  `"application/octet-stream"`. Using `"binary"` as the second `readUrl` argument is also valid for
  this example.

DataWeave Script:

```dataweave
%dw 2.0
import * from dw::core::Binaries
var myPDF = readUrl("classpath://pdf-test.pdf", "application/octet-stream")
output text/plain
---
toBase64(myPDF as Binary)
```

Output (partial results):

```json
JVBERi0xLjYNJeLjz9MNCjM3IDAgb2JqIDw8L0xpbmVhcml6ZWQgMS9MIDIwNTk3L08gNDAvRSAx
...
```

## Decode Base64

This example simulates the transformation in the Write operation from the
[XML configuration](#xml_config) by converting a Base64 file stream (`application/octet-stream`) to
Binary and outputting the Binary in the `application/PDF with binary` format. The example does not
generate a PDF file; a Write operation is required to generate such a file.

The examples use the following functions:

- `fromBase64` in the `dw::core::Binaries` module to transform a Base64 string to a binary value.

- `readUrl` to input a PDF file.

  The example assumes that the PDF file is in the `src/main/resources` directory of a Mule project
  in Anypoint Studio. The function reads the input PDF as an octet-stream MIME type. Using the MIME
  type `"binary"` as the second `readUrl` argument is also valid for this example.

DataWeave Script:

```dataweave
%dw 2.0
import * from dw::core::Binaries
var myPDF = readUrl("classpath://pdf-test.pdf", "application/octet-stream")
var myPDFasBinary = toBase64(myPDF as Binary)
output application/PDF with binary
---
fromBase64(myPDFasBinary as String) as Binary
```

The output is the text representation of the PDF.

Output (partial results):

```json
%PDF-1.6
%����
37 0 obj <</Linearized 1/L 20597/O 40/E 14115/N 1/T 19795/H [ 1005 215]>>
endobj

xref
37 34
0000000016 00000 n
...
```

## XML Configuration Example

In Anypoint Studio, you can create and run a Mule flow that encodes and decodes a PDF file. After
you complete the procedure, the example reads the file from the specified local directory using the
File Connector Read operation. It writes the PDF to the specified directory by using the File
Connector Write operation, and it uses Transform Message components to encode the file to Base64 and
to decode that output from Base64.

1.  Create a Mule project in Anypoint Studio:

    1.  Select **File > New > Mule Project**.

    2.  Enter a name for your Mule project.

    3.  Click **Finish**.

2.  Use **Add Module** in the Mule Palette to add the File Connector:

    1.  In the **Mule Palette** view, click **(X) Search in Exchange**.

    2.  In the **Add Dependencies to Project** window, type `file` in the search field.

    3.  Click **File Connector** in Available modules.

    4.  Click **Add**.

    5.  Click **Finish**.

3.  In the Studio canvas, navigate to the **Configuration XML** tab.

4.  Copy and paste the following example between the `<mule/>` elements of a Mule flow in Anypoint
    Studio:

    ```XML
    <http:listener-config name="HTTP_Listener_config"
                          doc:name="HTTP Listener config" >
        <http:listener-connection
                                host="0.0.0.0"
                                port="8081" />
    </http:listener-config>
    <file:config name="File_Config"
                 doc:name="File Config" >
        <file:connection workingDir="/Users/me/Downloads" />
    </file:config>
    <flow name="encode-decode-base64">
        <http:listener doc:name="Listener"
                     path="/transform"
                     config-ref="HTTP_Listener_config"/>
        <file:read doc:name="Read"
                 config-ref="File_Config"
                 path="pdf-test.pdf" />
        <ee:transform doc:name="Transform Message">
            <ee:message>
              <ee:set-payload><![CDATA[%dw 2.0
    import * from dw::core::Binaries
    output text/plain
    ---
    toBase64(payload as Binary)]]></ee:set-payload>
            </ee:message>
        </ee:transform>
        <ee:transform doc:name="Transform Message" >
            <ee:message >
              <ee:set-payload ><![CDATA[%dw 2.0
    import * from dw::core::Binaries
    output application/pdf with binary
    ---
    fromBase64(payload as String) as Binary]]></ee:set-payload>
            </ee:message>
        </ee:transform>
        <file:write doc:name="Write"
                  path="/Users/me/pdf-test-result.pdf"/>
        <set-payload
                  value='#["PDF file created in the directory specified in the Write operation."]'
                  doc:name="Set Payload" />
    </flow>
    ```

    Note that it is valid to replace the directive `output application/pdf with binary` in the
    second Transform Message component with `output application/octet-stream`.

5.  Place a PDF file of your choice into a local directory on your machine.

6.  Correct the input and output directories of the **Read** and **Write** operations:

    - In the **Read** operation, change the **File Path** value \`/Users/me/Downloads" to the
      location of your PDF file.

    - In the **Write** operation, change the **Path** value `/Users/me/pdf-test.pdf"` to the
      location and file name that you want to output the file.

7.  Run the project in Studio.

8.  Load the `0.0.0.0:8081/transform` into a browser.

    This action creates a PDF file in the specified location and generates a separate `transform`
    file with the message in the Set Payload component,
    `PDF file created in the directory specified in the Write operation.`

## See Also

- [Binaries (dw::core::Binaries)](https://docs.mulesoft.com/dataweave/2.6/dw-binaries)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.6/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook)

<!-- document id=ee05180476213f3b3788f0ae776ec6a250f912bf03ced7465500a651fd5ab349 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook-decode-encode.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Decode and Encode Base64

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following DataWeave examples show how to convert a file stream into Base64 and to convert a
Base64 string into a file stream. They use a PDF file as the input and output.

MuleSoft uses the standard Base64 encoding as defined in
[RFC 4648, section 4](https://www.rfc-editor.org/rfc/rfc4648#section-4). This standard includes the
`+` and `/` characters and uses `=` for padding. The encoding isn’t URL safe. To use Base64 encoding
in a URL, you must first encode the URL separately.

## Encode a PDF File to Base64

This example performs Base64 encoding on a PDF file. It simulates the transformation in the Read
operation from the [XML configuration](#xml_config) by converting a Base64 file stream
(`application/octet-stream`) to Binary and outputting the Binary in the `text/plain` format.

The example uses the following functions:

- `toBase64` from the `dw::core::Binaries` module to transform a binary value to a Base64 string.

- `readUrl` from the `Core (dw::Core)` module to input a PDF file.

  The example assumes that the PDF file is in the `src/main/resources` directory of a Mule project
  in Anypoint Studio. It provides the name of the PDF file and specifies the MIME type as
  `"application/octet-stream"`. Using `"binary"` as the second `readUrl` argument is also valid for
  this example.

DataWeave Script:

```dataweave
%dw 2.0
import * from dw::core::Binaries
var myPDF = readUrl("classpath://pdf-test.pdf", "application/octet-stream")
output text/plain
---
toBase64(myPDF as Binary)
```

Output (partial results):

```json
JVBERi0xLjYNJeLjz9MNCjM3IDAgb2JqIDw8L0xpbmVhcml6ZWQgMS9MIDIwNTk3L08gNDAvRSAx
...
```

## Decode Base64

This example simulates the transformation in the Write operation from the
[XML configuration](#xml_config) by converting a Base64 file stream (`application/octet-stream`) to
Binary and outputting the Binary in the `application/PDF with binary` format. The example does not
generate a PDF file; a Write operation is required to generate such a file.

The examples use the following functions:

- `fromBase64` in the `dw::core::Binaries` module to transform a Base64 string to a binary value.

- `readUrl` to input a PDF file.

  The example assumes that the PDF file is in the `src/main/resources` directory of a Mule project
  in Anypoint Studio. The function reads the input PDF as an octet-stream MIME type. Using the MIME
  type `"binary"` as the second `readUrl` argument is also valid for this example.

DataWeave Script:

```dataweave
%dw 2.0
import * from dw::core::Binaries
var myPDF = readUrl("classpath://pdf-test.pdf", "application/octet-stream")
var myPDFasBinary = toBase64(myPDF as Binary)
output application/PDF with binary
---
fromBase64(myPDFasBinary as String) as Binary
```

The output is the text representation of the PDF.

Output (partial results):

```json
%PDF-1.6
%����
37 0 obj <</Linearized 1/L 20597/O 40/E 14115/N 1/T 19795/H [ 1005 215]>>
endobj

xref
37 34
0000000016 00000 n
...
```

## XML Configuration Example

In Anypoint Studio, you can create and run a Mule flow that encodes and decodes a PDF file. After
you complete the procedure, the example reads the file from the specified local directory using the
File Connector Read operation. It writes the PDF to the specified directory by using the File
Connector Write operation, and it uses Transform Message components to encode the file to Base64 and
to decode that output from Base64.

1.  Create a Mule project in Anypoint Studio:

    1.  Select **File > New > Mule Project**.

    2.  Enter a name for your Mule project.

    3.  Click **Finish**.

2.  Use **Add Module** in the Mule Palette to add the File Connector:

    1.  In the **Mule Palette** view, click **(X) Search in Exchange**.

    2.  In the **Add Dependencies to Project** window, type `file` in the search field.

    3.  Click **File Connector** in Available modules.

    4.  Click **Add**.

    5.  Click **Finish**.

3.  In the Studio canvas, navigate to the **Configuration XML** tab.

4.  Copy and paste the following example between the `<mule/>` elements of a Mule flow in Anypoint
    Studio:

    ```XML
    <http:listener-config name="HTTP_Listener_config"
                          doc:name="HTTP Listener config" >
        <http:listener-connection
                                host="0.0.0.0"
                                port="8081" />
    </http:listener-config>
    <file:config name="File_Config"
                 doc:name="File Config" >
        <file:connection workingDir="/Users/me/Downloads" />
    </file:config>
    <flow name="encode-decode-base64">
        <http:listener doc:name="Listener"
                     path="/transform"
                     config-ref="HTTP_Listener_config"/>
        <file:read doc:name="Read"
                 config-ref="File_Config"
                 path="pdf-test.pdf" />
        <ee:transform doc:name="Transform Message">
            <ee:message>
              <ee:set-payload><![CDATA[%dw 2.0
    import * from dw::core::Binaries
    output text/plain
    ---
    toBase64(payload as Binary)]]></ee:set-payload>
            </ee:message>
        </ee:transform>
        <ee:transform doc:name="Transform Message" >
            <ee:message >
              <ee:set-payload ><![CDATA[%dw 2.0
    import * from dw::core::Binaries
    output application/pdf with binary
    ---
    fromBase64(payload as String) as Binary]]></ee:set-payload>
            </ee:message>
        </ee:transform>
        <file:write doc:name="Write"
                  path="/Users/me/pdf-test-result.pdf"/>
        <set-payload
                  value='#["PDF file created in the directory specified in the Write operation."]'
                  doc:name="Set Payload" />
    </flow>
    ```

    Note that it is valid to replace the directive `output application/pdf with binary` in the
    second Transform Message component with `output application/octet-stream`.

5.  Place a PDF file of your choice into a local directory on your machine.

6.  Correct the input and output directories of the **Read** and **Write** operations:

    - In the **Read** operation, change the **File Path** value \`/Users/me/Downloads" to the
      location of your PDF file.

    - In the **Write** operation, change the **Path** value `/Users/me/pdf-test.pdf"` to the
      location and file name that you want to output the file.

7.  Run the project in Studio.

8.  Load the `0.0.0.0:8081/transform` into a browser.

    This action creates a PDF file in the specified location and generates a separate `transform`
    file with the message in the Set Payload component,
    `PDF file created in the directory specified in the Write operation.`

## See Also

- [Binaries (dw::core::Binaries)](https://docs.mulesoft.com/dataweave/2.9/dw-binaries)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.9/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook)

<!-- document id=14fbeae33394ed1757e2fb1f8fea54b72f6d4bf1d2e4f864101d2334d6848063 url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook-decode-encode.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Decode and Encode Base64

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following DataWeave examples show how to convert a file stream into Base64 and to convert a
Base64 string into a file stream. They use a PDF file as the input and output.

MuleSoft uses the standard Base64 encoding as defined in
[RFC 4648, section 4](https://www.rfc-editor.org/rfc/rfc4648#section-4). This standard includes the
`+` and `/` characters and uses `=` for padding. The encoding isn’t URL safe. To use Base64 encoding
in a URL, you must first encode the URL separately.

## Encode a PDF File to Base64

This example performs Base64 encoding on a PDF file. It simulates the transformation in the Read
operation from the [XML configuration](#xml_config) by converting a Base64 file stream
(`application/octet-stream`) to Binary and outputting the Binary in the `text/plain` format.

The example uses the following functions:

- `toBase64` from the `dw::core::Binaries` module to transform a binary value to a Base64 string.

- `readUrl` from the `Core (dw::Core)` module to input a PDF file.

  The example assumes that the PDF file is in the `src/main/resources` directory of a Mule project
  in Anypoint Studio. It provides the name of the PDF file and specifies the MIME type as
  `"application/octet-stream"`. Using `"binary"` as the second `readUrl` argument is also valid for
  this example.

DataWeave Script:

```dataweave
%dw 2.0
import * from dw::core::Binaries
var myPDF = readUrl("classpath://pdf-test.pdf", "application/octet-stream")
output text/plain
---
toBase64(myPDF as Binary)
```

Output (partial results):

```json
JVBERi0xLjYNJeLjz9MNCjM3IDAgb2JqIDw8L0xpbmVhcml6ZWQgMS9MIDIwNTk3L08gNDAvRSAx
...
```

## Decode Base64

This example simulates the transformation in the Write operation from the
[XML configuration](#xml_config) by converting a Base64 file stream (`application/octet-stream`) to
Binary and outputting the Binary in the `application/PDF with binary` format. The example does not
generate a PDF file; a Write operation is required to generate such a file.

The examples use the following functions:

- `fromBase64` in the `dw::core::Binaries` module to transform a Base64 string to a binary value.

- `readUrl` to input a PDF file.

  The example assumes that the PDF file is in the `src/main/resources` directory of a Mule project
  in Anypoint Studio. The function reads the input PDF as an octet-stream MIME type. Using the MIME
  type `"binary"` as the second `readUrl` argument is also valid for this example.

DataWeave Script:

```dataweave
%dw 2.0
import * from dw::core::Binaries
var myPDF = readUrl("classpath://pdf-test.pdf", "application/octet-stream")
var myPDFasBinary = toBase64(myPDF as Binary)
output application/PDF with binary
---
fromBase64(myPDFasBinary as String) as Binary
```

The output is the text representation of the PDF.

Output (partial results):

```json
%PDF-1.6
%����
37 0 obj <</Linearized 1/L 20597/O 40/E 14115/N 1/T 19795/H [ 1005 215]>>
endobj

xref
37 34
0000000016 00000 n
...
```

## XML Configuration Example

In Anypoint Studio, you can create and run a Mule flow that encodes and decodes a PDF file. After
you complete the procedure, the example reads the file from the specified local directory using the
File Connector Read operation. It writes the PDF to the specified directory by using the File
Connector Write operation, and it uses Transform Message components to encode the file to Base64 and
to decode that output from Base64.

1.  Create a Mule project in Anypoint Studio:

    1.  Select **File > New > Mule Project**.

    2.  Enter a name for your Mule project.

    3.  Click **Finish**.

2.  Use **Add Module** in the Mule Palette to add the File Connector:

    1.  In the **Mule Palette** view, click **(X) Search in Exchange**.

    2.  In the **Add Dependencies to Project** window, type `file` in the search field.

    3.  Click **File Connector** in Available modules.

    4.  Click **Add**.

    5.  Click **Finish**.

3.  In the Studio canvas, navigate to the **Configuration XML** tab.

4.  Copy and paste the following example between the `<mule/>` elements of a Mule flow in Anypoint
    Studio:

    ```XML
    <http:listener-config name="HTTP_Listener_config"
                          doc:name="HTTP Listener config" >
        <http:listener-connection
                                host="0.0.0.0"
                                port="8081" />
    </http:listener-config>
    <file:config name="File_Config"
                 doc:name="File Config" >
        <file:connection workingDir="/Users/me/Downloads" />
    </file:config>
    <flow name="encode-decode-base64">
        <http:listener doc:name="Listener"
                     path="/transform"
                     config-ref="HTTP_Listener_config"/>
        <file:read doc:name="Read"
                 config-ref="File_Config"
                 path="pdf-test.pdf" />
        <ee:transform doc:name="Transform Message">
            <ee:message>
              <ee:set-payload><![CDATA[%dw 2.0
    import * from dw::core::Binaries
    output text/plain
    ---
    toBase64(payload as Binary)]]></ee:set-payload>
            </ee:message>
        </ee:transform>
        <ee:transform doc:name="Transform Message" >
            <ee:message >
              <ee:set-payload ><![CDATA[%dw 2.0
    import * from dw::core::Binaries
    output application/pdf with binary
    ---
    fromBase64(payload as String) as Binary]]></ee:set-payload>
            </ee:message>
        </ee:transform>
        <file:write doc:name="Write"
                  path="/Users/me/pdf-test-result.pdf"/>
        <set-payload
                  value='#["PDF file created in the directory specified in the Write operation."]'
                  doc:name="Set Payload" />
    </flow>
    ```

    Note that it is valid to replace the directive `output application/pdf with binary` in the
    second Transform Message component with `output application/octet-stream`.

5.  Place a PDF file of your choice into a local directory on your machine.

6.  Correct the input and output directories of the **Read** and **Write** operations:

    - In the **Read** operation, change the **File Path** value \`/Users/me/Downloads" to the
      location of your PDF file.

    - In the **Write** operation, change the **Path** value `/Users/me/pdf-test.pdf"` to the
      location and file name that you want to output the file.

7.  Run the project in Studio.

8.  Load the `0.0.0.0:8081/transform` into a browser.

    This action creates a PDF file in the specified location and generates a separate `transform`
    file with the message in the Set Payload component,
    `PDF file created in the directory specified in the Write operation.`

## See Also

- [Binaries (dw::core::Binaries)](https://docs.mulesoft.com/dataweave/latest/dw-binaries)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook)

<!-- document id=a92d30c0bdabe1ab8d557a314d52caf5123b8a33635ab6ed3341372e01faac75 url=/mulesoft/current/en-us/dataweave/2.11/dw-url-functions-decodeuri.md -->

---
product: DataWeave
version: 2.11
---

# decodeURI

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## decodeURI(text: String): String

Decodes the escape sequences (such as `%20`) in a URI.

The function replaces each escape sequence in the encoded URI with the character that it represents,
but does not decode escape sequences that could not have been introduced by `encodeURI`. The
character `#` is not decoded from escape sequences.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The URI to decode.</p></td></tr></tbody></table>

### Example

This example decodes a URI that contains the URL percent encoding `%20`, which is used for spaces.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::URL
output application/json
---
{
  "decodeURI" : decodeURI('http://asd/%20text%20to%20decode%20/text')
}
```

#### Output

```JSON
{
  "decodeURI": "http://asd/ text to decode /text"
}
```

<!-- document id=eda85851c0f083c7b25d1eda5ca516ed237433e32ae7e9dbd09a70049ee9e345 url=/mulesoft/current/en-us/dataweave/2.12/dw-url-functions-decodeuri.md -->

---
product: DataWeave
version: 2.12
---

# decodeURI

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## decodeURI(text: String): String

Decodes the escape sequences (such as `%20`) in a URI.

The function replaces each escape sequence in the encoded URI with the character that it represents,
but does not decode escape sequences that could not have been introduced by `encodeURI`. The
character `#` is not decoded from escape sequences.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The URI to decode.</p></td></tr></tbody></table>

### Example

This example decodes a URI that contains the URL percent encoding `%20`, which is used for spaces.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::URL
output application/json
---
{
  "decodeURI" : decodeURI('http://asd/%20text%20to%20decode%20/text')
}
```

#### Output

```JSON
{
  "decodeURI": "http://asd/ text to decode /text"
}
```

<!-- document id=4c711d2c8d7a78a6c0643e62b7c7bab456f0bdeec98cea09096f37d58f4f3de7 url=/mulesoft/current/en-us/dataweave/2.3/dw-url-functions-decodeuri.md -->

---
product: DataWeave
version: 2.3
---

# decodeURI

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## decodeURI(String): String

Decodes the escape sequences (such as `%20`) in a URI.

The function replaces each escape sequence in the encoded URI with the character that it represents,
but does not decode escape sequences that could not have been introduced by `encodeURI`. The
character `#` is not decoded from escape sequences.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The URI to decode.</p></td></tr></tbody></table>

### Example

This example decodes a URI that contains the URL percent encoding `%20`, which is used for spaces.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::URL
output application/json
---
{
  "decodeURI" : decodeURI('http://asd/%20text%20to%20decode%20/text')
}
```

#### Output

```JSON
{
  "decodeURI": "http://asd/ text to decode /text"
}
```

<!-- document id=5de37a966e60b8015aac9d44cc05a6b48431c8a060ae613c487a5ad317d23afc url=/mulesoft/current/en-us/dataweave/2.4/dw-url-functions-decodeuri.md -->

---
product: DataWeave
version: 2.4
---

# decodeURI

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## decodeURI(text: String): String

Decodes the escape sequences (such as `%20`) in a URI.

The function replaces each escape sequence in the encoded URI with the character that it represents,
but does not decode escape sequences that could not have been introduced by `encodeURI`. The
character `#` is not decoded from escape sequences.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The URI to decode.</p></td></tr></tbody></table>

### Example

This example decodes a URI that contains the URL percent encoding `%20`, which is used for spaces.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::URL
output application/json
---
{
  "decodeURI" : decodeURI('http://asd/%20text%20to%20decode%20/text')
}
```

#### Output

```JSON
{
  "decodeURI": "http://asd/ text to decode /text"
}
```

<!-- document id=f1145bcee9fc1357477e4c63d91196aa732dccbc410183218391f555bc6e5a66 url=/mulesoft/current/en-us/dataweave/2.6/dw-url-functions-decodeuri.md -->

---
product: DataWeave
version: 2.6
---

# decodeURI

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## decodeURI(text: String): String

Decodes the escape sequences (such as `%20`) in a URI.

The function replaces each escape sequence in the encoded URI with the character that it represents,
but does not decode escape sequences that could not have been introduced by `encodeURI`. The
character `#` is not decoded from escape sequences.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The URI to decode.</p></td></tr></tbody></table>

### Example

This example decodes a URI that contains the URL percent encoding `%20`, which is used for spaces.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::URL
output application/json
---
{
  "decodeURI" : decodeURI('http://asd/%20text%20to%20decode%20/text')
}
```

#### Output

```JSON
{
  "decodeURI": "http://asd/ text to decode /text"
}
```

<!-- document id=edaa98b48957a08feae11a6e09c3ed31e54f5e0686abfbcd551bf2e4fc950da5 url=/mulesoft/current/en-us/dataweave/2.9/dw-url-functions-decodeuri.md -->

---
product: DataWeave
version: 2.9
---

# decodeURI

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## decodeURI(text: String): String

Decodes the escape sequences (such as `%20`) in a URI.

The function replaces each escape sequence in the encoded URI with the character that it represents,
but does not decode escape sequences that could not have been introduced by `encodeURI`. The
character `#` is not decoded from escape sequences.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The URI to decode.</p></td></tr></tbody></table>

### Example

This example decodes a URI that contains the URL percent encoding `%20`, which is used for spaces.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::URL
output application/json
---
{
  "decodeURI" : decodeURI('http://asd/%20text%20to%20decode%20/text')
}
```

#### Output

```JSON
{
  "decodeURI": "http://asd/ text to decode /text"
}
```

<!-- document id=a1a7df2ce782a4c69b52872080c1699a9420c292858742ebb979db9b75dbad05 url=/mulesoft/current/en-us/dataweave/latest/dw-url-functions-decodeuri.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# decodeURI

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## decodeURI(text: String): String

Decodes the escape sequences (such as `%20`) in a URI.

The function replaces each escape sequence in the encoded URI with the character that it represents,
but does not decode escape sequences that could not have been introduced by `encodeURI`. The
character `#` is not decoded from escape sequences.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The URI to decode.</p></td></tr></tbody></table>

### Example

This example decodes a URI that contains the URL percent encoding `%20`, which is used for spaces.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::URL
output application/json
---
{
  "decodeURI" : decodeURI('http://asd/%20text%20to%20decode%20/text')
}
```

#### Output

```JSON
{
  "decodeURI": "http://asd/ text to decode /text"
}
```

<!-- document id=38d74f74d5eb31bb71072e7a246ed8dde2b7da7b3d649641c52f136159c61548 url=/mulesoft/current/en-us/dataweave/2.11/dw-url-functions-decodeuricomponent.md -->

---
product: DataWeave
version: 2.11
---

# decodeURIComponent

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## decodeURIComponent(text: String): String

Decodes a Uniform Resource Identifier (URI) component previously created by `encodeURIComponent` or
a similar routine.

For an example, see `encodeURIComponent`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>URI component string.</p></td></tr></tbody></table>

### Example

This example decodes a variety of URI components.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::URL
output application/json
---
{
  "decodeURIComponent": {
    "decodeURIComponent" : decodeURIComponent("%20PATH/%20TO%20/DECODE%20"),
    "decodeURIComponent" : decodeURIComponent("%3B%2C%2F%3F%3A%40%26%3D"),
    "decodeURIComponent" : decodeURIComponent("%2D%5F%2E%21%7E%2A%27%28%29%24"),
  }
}
```

#### Output

```JSON
{
   decodeURIComponent: {
     decodeURIComponent: " PATH/ TO /DECODE ",
     decodeURIComponent: ";,/?:@&=",
    decodeURIComponent: "-_.!~*'()\$"
   }
}
```

<!-- document id=663aefff47a2601886007ad1d7bbc40304d1736435298a8630d0a5b500cec891 url=/mulesoft/current/en-us/dataweave/2.12/dw-url-functions-decodeuricomponent.md -->

---
product: DataWeave
version: 2.12
---

# decodeURIComponent

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## decodeURIComponent(text: String): String

Decodes a Uniform Resource Identifier (URI) component previously created by `encodeURIComponent` or
a similar routine.

For an example, see `encodeURIComponent`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>URI component string.</p></td></tr></tbody></table>

### Example

This example decodes a variety of URI components.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::URL
output application/json
---
{
  "decodeURIComponent": {
    "decodeURIComponent" : decodeURIComponent("%20PATH/%20TO%20/DECODE%20"),
    "decodeURIComponent" : decodeURIComponent("%3B%2C%2F%3F%3A%40%26%3D"),
    "decodeURIComponent" : decodeURIComponent("%2D%5F%2E%21%7E%2A%27%28%29%24"),
  }
}
```

#### Output

```JSON
{
   decodeURIComponent: {
     decodeURIComponent: " PATH/ TO /DECODE ",
     decodeURIComponent: ";,/?:@&=",
    decodeURIComponent: "-_.!~*'()\$"
   }
}
```

<!-- document id=18ff722eab2bb408e9e13646ff591970165f323feadeceb9e979a8a703cb9116 url=/mulesoft/current/en-us/dataweave/2.3/dw-url-functions-decodeuricomponent.md -->

---
product: DataWeave
version: 2.3
---

# decodeURIComponent

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## decodeURIComponent(String): String

Decodes a Uniform Resource Identifier (URI) component previously created by `encodeURIComponent` or
a similar routine.

For an example, see `encodeURIComponent`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>URI component string.</p></td></tr></tbody></table>

### Example

This example decodes a variety of URI components.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::URL
output application/json
---
{
  "decodeURIComponent": {
    "decodeURIComponent" : decodeURIComponent("%20PATH/%20TO%20/DECODE%20"),
    "decodeURIComponent" : decodeURIComponent("%3B%2C%2F%3F%3A%40%26%3D"),
    "decodeURIComponent" : decodeURIComponent("%2D%5F%2E%21%7E%2A%27%28%29%24"),
  }
}
```

#### Output

```JSON
{
   decodeURIComponent: {
     decodeURIComponent: " PATH/ TO /DECODE ",
     decodeURIComponent: ";,/?:@&=",
    decodeURIComponent: "-_.!~*'()\$"
   }
}
```

<!-- document id=0963f6bd9035f55d3dbb640964dfe236375b48de2b0722f8c53f5bfe2a0b6db1 url=/mulesoft/current/en-us/dataweave/2.4/dw-url-functions-decodeuricomponent.md -->

---
product: DataWeave
version: 2.4
---

# decodeURIComponent

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## decodeURIComponent(text: String): String

Decodes a Uniform Resource Identifier (URI) component previously created by `encodeURIComponent` or
a similar routine.

For an example, see `encodeURIComponent`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>URI component string.</p></td></tr></tbody></table>

### Example

This example decodes a variety of URI components.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::URL
output application/json
---
{
  "decodeURIComponent": {
    "decodeURIComponent" : decodeURIComponent("%20PATH/%20TO%20/DECODE%20"),
    "decodeURIComponent" : decodeURIComponent("%3B%2C%2F%3F%3A%40%26%3D"),
    "decodeURIComponent" : decodeURIComponent("%2D%5F%2E%21%7E%2A%27%28%29%24"),
  }
}
```

#### Output

```JSON
{
   decodeURIComponent: {
     decodeURIComponent: " PATH/ TO /DECODE ",
     decodeURIComponent: ";,/?:@&=",
    decodeURIComponent: "-_.!~*'()\$"
   }
}
```

<!-- document id=939080d2607749dae8b1e0962cabde92121fba134f5b65ea6d09e14a8e3f63ad url=/mulesoft/current/en-us/dataweave/2.6/dw-url-functions-decodeuricomponent.md -->

---
product: DataWeave
version: 2.6
---

# decodeURIComponent

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## decodeURIComponent(text: String): String

Decodes a Uniform Resource Identifier (URI) component previously created by `encodeURIComponent` or
a similar routine.

For an example, see `encodeURIComponent`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>URI component string.</p></td></tr></tbody></table>

### Example

This example decodes a variety of URI components.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::URL
output application/json
---
{
  "decodeURIComponent": {
    "decodeURIComponent" : decodeURIComponent("%20PATH/%20TO%20/DECODE%20"),
    "decodeURIComponent" : decodeURIComponent("%3B%2C%2F%3F%3A%40%26%3D"),
    "decodeURIComponent" : decodeURIComponent("%2D%5F%2E%21%7E%2A%27%28%29%24"),
  }
}
```

#### Output

```JSON
{
   decodeURIComponent: {
     decodeURIComponent: " PATH/ TO /DECODE ",
     decodeURIComponent: ";,/?:@&=",
    decodeURIComponent: "-_.!~*'()\$"
   }
}
```

<!-- document id=ec48ea6e8a85e87d8e6d83d443216a1885726c64713985d7f464f3c8959c0afd url=/mulesoft/current/en-us/dataweave/2.9/dw-url-functions-decodeuricomponent.md -->

---
product: DataWeave
version: 2.9
---

# decodeURIComponent

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## decodeURIComponent(text: String): String

Decodes a Uniform Resource Identifier (URI) component previously created by `encodeURIComponent` or
a similar routine.

For an example, see `encodeURIComponent`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>URI component string.</p></td></tr></tbody></table>

### Example

This example decodes a variety of URI components.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::URL
output application/json
---
{
  "decodeURIComponent": {
    "decodeURIComponent" : decodeURIComponent("%20PATH/%20TO%20/DECODE%20"),
    "decodeURIComponent" : decodeURIComponent("%3B%2C%2F%3F%3A%40%26%3D"),
    "decodeURIComponent" : decodeURIComponent("%2D%5F%2E%21%7E%2A%27%28%29%24"),
  }
}
```

#### Output

```JSON
{
   decodeURIComponent: {
     decodeURIComponent: " PATH/ TO /DECODE ",
     decodeURIComponent: ";,/?:@&=",
    decodeURIComponent: "-_.!~*'()\$"
   }
}
```

<!-- document id=b69ccf34b9bd0970b0d4a21ba3f4b2ec12375a576e2c6afeb3589e439855f951 url=/mulesoft/current/en-us/dataweave/latest/dw-url-functions-decodeuricomponent.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# decodeURIComponent

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## decodeURIComponent(text: String): String

Decodes a Uniform Resource Identifier (URI) component previously created by `encodeURIComponent` or
a similar routine.

For an example, see `encodeURIComponent`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>URI component string.</p></td></tr></tbody></table>

### Example

This example decodes a variety of URI components.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::URL
output application/json
---
{
  "decodeURIComponent": {
    "decodeURIComponent" : decodeURIComponent("%20PATH/%20TO%20/DECODE%20"),
    "decodeURIComponent" : decodeURIComponent("%3B%2C%2F%3F%3A%40%26%3D"),
    "decodeURIComponent" : decodeURIComponent("%2D%5F%2E%21%7E%2A%27%28%29%24"),
  }
}
```

#### Output

```JSON
{
   decodeURIComponent: {
     decodeURIComponent: " PATH/ TO /DECODE ",
     decodeURIComponent: ";,/?:@&=",
    decodeURIComponent: "-_.!~*'()\$"
   }
}
```

<!-- document id=00c566764bf707fb611331b36dc6d5ed41d567caddb190b1454be09dc2c18fc1 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook-define-a-custom-addition-function.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Define a Custom Addition Function

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example takes in a set of item prices and stock amounts and uses several functions to
calculate subtotals, deduct discounts and add taxes.

It makes use of the following:

- `map` function to go through all the items in the input.

- basic math operations like `*`, `+` and `-`.

- String concatenation with `++`.

- `as` to force string values into numbers.

- Fixed values in the header to set tax and discount amounts.

- A custom function in the header, to define once and use multiple times in the code.

- `reduce` function to aggregate the various items into a total.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
var tax = 0.085
var discount = 0.05
fun getSubtotal (items) = items reduce ((item, accumulator = 0) ->
        accumulator + (item.unit_price * item.quantity * (1 - discount)))
---
invoice: {
    header: payload.invoice.header,
    items: { (payload.invoice.items map {
        item : {
            description: $.description,
            quantity: $.quantity,
            unit_price: $.unit_price,
            discount: (discount * 100) as Number ++ "%",
            subtotal: $.unit_price * $.quantity * (1 - discount)
        }
    }) },
    totals:
    {
        subtotal: getSubtotal(payload.invoice.items ),
        tax: (tax * 100) as Number ++ "%",
        total: getSubtotal(payload.invoice.items ) * (1 + tax)
    }
}
```

Input JSON Payload:

```json
{
  "invoice": {
    "header": {
      "customer_name": "ACME, Inc.",
      "customer_state": "CA"
    },
    "items": [
      {
        "description": "Product 1",
        "quantity": "2",
        "unit_price": "10"
      },
      {
        "description": "Product 2",
        "quantity": "1",
        "unit_price": "30"
      }
    ]
  }
}
```

Output

```json
{
  "invoice": {
    "header": {
      "customer_name": "ACME, Inc.",
      "customer_state": "CA"
    },
    "items": {
      "item": {
        "description": "Product 1",
        "quantity": "2",
        "unit_price": "10",
        "discount": "5%",
        "subtotal": 19.0
      },
      "item": {
        "description": "Product 2",
        "quantity": "1",
        "unit_price": "30",
        "discount": "5%",
        "subtotal": 28.5
      }
    },
    "totals": {
      "subtotal": 47.5,
      "tax": "8.500%",
      "total": 51.5375
    }
  }
}
```

## Related Examples

- [Map Data](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-map)

- [Use Constant Directives](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-use-constant-directives)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-conditional-list-reduction-via-function)

- [Define a Function that Flattens Data in a List](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-define-function-to-flatten-list)

- [Pass Functions as Arguments](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-pass-functions-as-arguments)

## See Also

- [DataWeave Core Functions](https://docs.mulesoft.com/dataweave/2.11/dw-core)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.11/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook)

<!-- document id=6afcf48a9ed70859407e09cb19ab0b03ecf42c84fc0122adbc11e97aad455d73 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook-define-a-custom-addition-function.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Define a Custom Addition Function

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example takes in a set of item prices and stock amounts and uses several functions to
calculate subtotals, deduct discounts and add taxes.

It makes use of the following:

- `map` function to go through all the items in the input.

- basic math operations like `*`, `+` and `-`.

- String concatenation with `++`.

- `as` to force string values into numbers.

- Fixed values in the header to set tax and discount amounts.

- A custom function in the header, to define once and use multiple times in the code.

- `reduce` function to aggregate the various items into a total.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
var tax = 0.085
var discount = 0.05
fun getSubtotal (items) = items reduce ((item, accumulator = 0) ->
        accumulator + (item.unit_price * item.quantity * (1 - discount)))
---
invoice: {
    header: payload.invoice.header,
    items: { (payload.invoice.items map {
        item : {
            description: $.description,
            quantity: $.quantity,
            unit_price: $.unit_price,
            discount: (discount * 100) as Number ++ "%",
            subtotal: $.unit_price * $.quantity * (1 - discount)
        }
    }) },
    totals:
    {
        subtotal: getSubtotal(payload.invoice.items ),
        tax: (tax * 100) as Number ++ "%",
        total: getSubtotal(payload.invoice.items ) * (1 + tax)
    }
}
```

Input JSON Payload:

```json
{
  "invoice": {
    "header": {
      "customer_name": "ACME, Inc.",
      "customer_state": "CA"
    },
    "items": [
      {
        "description": "Product 1",
        "quantity": "2",
        "unit_price": "10"
      },
      {
        "description": "Product 2",
        "quantity": "1",
        "unit_price": "30"
      }
    ]
  }
}
```

Output

```json
{
  "invoice": {
    "header": {
      "customer_name": "ACME, Inc.",
      "customer_state": "CA"
    },
    "items": {
      "item": {
        "description": "Product 1",
        "quantity": "2",
        "unit_price": "10",
        "discount": "5%",
        "subtotal": 19.0
      },
      "item": {
        "description": "Product 2",
        "quantity": "1",
        "unit_price": "30",
        "discount": "5%",
        "subtotal": 28.5
      }
    },
    "totals": {
      "subtotal": 47.5,
      "tax": "8.500%",
      "total": 51.5375
    }
  }
}
```

## Related Examples

- [Map Data](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-map)

- [Use Constant Directives](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-use-constant-directives)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-conditional-list-reduction-via-function)

- [Define a Function that Flattens Data in a List](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-define-function-to-flatten-list)

- [Pass Functions as Arguments](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-pass-functions-as-arguments)

## See Also

- [DataWeave Core Functions](https://docs.mulesoft.com/dataweave/2.12/dw-core)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.12/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook)

<!-- document id=df05bec5fbe466b691dbfab0bd4eda7c7328d9f4c2bfed8a425e1323ebca1521 url=/mulesoft/current/en-us/dataweave/2.3/dataweave-cookbook-define-a-custom-addition-function.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Define a Custom Addition Function

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example takes in a set of item prices and stock amounts and uses several functions to
calculate subtotals, deduct discounts and add taxes.

It makes use of the following:

- `map` function to go through all the items in the input.

- basic math operations like `*`, `+` and `-`.

- String concatenation with `++`.

- `as` to force string values into numbers.

- Fixed values in the header to set tax and discount amounts.

- A custom function in the header, to define once and use multiple times in the code.

- `reduce` function to aggregate the various items into a total.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
var tax = 0.085
var discount = 0.05
fun getSubtotal (items) = items reduce ((item, accumulator = 0) ->
        accumulator + (item.unit_price * item.quantity * (1 - discount)))
---
invoice: {
    header: payload.invoice.header,
    items: { (payload.invoice.items map {
        item : {
            description: $.description,
            quantity: $.quantity,
            unit_price: $.unit_price,
            discount: (discount * 100) as Number ++ "%",
            subtotal: $.unit_price * $.quantity * (1 - discount)
        }
    }) },
    totals:
    {
        subtotal: getSubtotal(payload.invoice.items ),
        tax: (tax * 100) as Number ++ "%",
        total: getSubtotal(payload.invoice.items ) * (1 + tax)
    }
}
```

Input JSON Payload:

```json
{
  "invoice": {
    "header": {
      "customer_name": "ACME, Inc.",
      "customer_state": "CA"
    },
    "items": [
      {
        "description": "Product 1",
        "quantity": "2",
        "unit_price": "10"
      },
      {
        "description": "Product 2",
        "quantity": "1",
        "unit_price": "30"
      }
    ]
  }
}
```

Output

```json
{
  "invoice": {
    "header": {
      "customer_name": "ACME, Inc.",
      "customer_state": "CA"
    },
    "items": {
      "item": {
        "description": "Product 1",
        "quantity": "2",
        "unit_price": "10",
        "discount": "5%",
        "subtotal": 19.0
      },
      "item": {
        "description": "Product 2",
        "quantity": "1",
        "unit_price": "30",
        "discount": "5%",
        "subtotal": 28.5
      }
    },
    "totals": {
      "subtotal": 47.5,
      "tax": "8.500%",
      "total": 51.5375
    }
  }
}
```

## Related Examples

- [Map Data](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-map)

- [Use Constant Directives](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-use-constant-directives)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-conditional-list-reduction-via-function)

- [Define a Function that Flattens Data in a List](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-define-function-to-flatten-list)

- [Pass Functions as Arguments](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-pass-functions-as-arguments)

## See Also

- [DataWeave Core Functions](https://docs.mulesoft.com/dataweave/2.3/dw-core)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.3/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook)

<!-- document id=0159b6ccf64a06e4109a83057a40622f23a2d04509299bba45f4f8b40411720a url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook-define-a-custom-addition-function.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Define a Custom Addition Function

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example takes in a set of item prices and stock amounts and uses several functions to
calculate subtotals, deduct discounts and add taxes.

It makes use of the following:

- `map` function to go through all the items in the input.

- basic math operations like `*`, `+` and `-`.

- String concatenation with `++`.

- `as` to force string values into numbers.

- Fixed values in the header to set tax and discount amounts.

- A custom function in the header, to define once and use multiple times in the code.

- `reduce` function to aggregate the various items into a total.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
var tax = 0.085
var discount = 0.05
fun getSubtotal (items) = items reduce ((item, accumulator = 0) ->
        accumulator + (item.unit_price * item.quantity * (1 - discount)))
---
invoice: {
    header: payload.invoice.header,
    items: { (payload.invoice.items map {
        item : {
            description: $.description,
            quantity: $.quantity,
            unit_price: $.unit_price,
            discount: (discount * 100) as Number ++ "%",
            subtotal: $.unit_price * $.quantity * (1 - discount)
        }
    }) },
    totals:
    {
        subtotal: getSubtotal(payload.invoice.items ),
        tax: (tax * 100) as Number ++ "%",
        total: getSubtotal(payload.invoice.items ) * (1 + tax)
    }
}
```

Input JSON Payload:

```json
{
  "invoice": {
    "header": {
      "customer_name": "ACME, Inc.",
      "customer_state": "CA"
    },
    "items": [
      {
        "description": "Product 1",
        "quantity": "2",
        "unit_price": "10"
      },
      {
        "description": "Product 2",
        "quantity": "1",
        "unit_price": "30"
      }
    ]
  }
}
```

Output

```json
{
  "invoice": {
    "header": {
      "customer_name": "ACME, Inc.",
      "customer_state": "CA"
    },
    "items": {
      "item": {
        "description": "Product 1",
        "quantity": "2",
        "unit_price": "10",
        "discount": "5%",
        "subtotal": 19.0
      },
      "item": {
        "description": "Product 2",
        "quantity": "1",
        "unit_price": "30",
        "discount": "5%",
        "subtotal": 28.5
      }
    },
    "totals": {
      "subtotal": 47.5,
      "tax": "8.500%",
      "total": 51.5375
    }
  }
}
```

## Related Examples

- [Map Data](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-map)

- [Use Constant Directives](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-use-constant-directives)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-conditional-list-reduction-via-function)

- [Define a Function that Flattens Data in a List](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-define-function-to-flatten-list)

- [Pass Functions as Arguments](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-pass-functions-as-arguments)

## See Also

- [DataWeave Core Functions](https://docs.mulesoft.com/dataweave/2.4/dw-core)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.4/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook)

<!-- document id=b9cb067d47aeaf2003dcc69aff1801cd77a170f0d00aab4a64b0ecf379653539 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook-define-a-custom-addition-function.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Define a Custom Addition Function

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example takes in a set of item prices and stock amounts and uses several functions to
calculate subtotals, deduct discounts and add taxes.

It makes use of the following:

- `map` function to go through all the items in the input.

- basic math operations like `*`, `+` and `-`.

- String concatenation with `++`.

- `as` to force string values into numbers.

- Fixed values in the header to set tax and discount amounts.

- A custom function in the header, to define once and use multiple times in the code.

- `reduce` function to aggregate the various items into a total.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
var tax = 0.085
var discount = 0.05
fun getSubtotal (items) = items reduce ((item, accumulator = 0) ->
        accumulator + (item.unit_price * item.quantity * (1 - discount)))
---
invoice: {
    header: payload.invoice.header,
    items: { (payload.invoice.items map {
        item : {
            description: $.description,
            quantity: $.quantity,
            unit_price: $.unit_price,
            discount: (discount * 100) as Number ++ "%",
            subtotal: $.unit_price * $.quantity * (1 - discount)
        }
    }) },
    totals:
    {
        subtotal: getSubtotal(payload.invoice.items ),
        tax: (tax * 100) as Number ++ "%",
        total: getSubtotal(payload.invoice.items ) * (1 + tax)
    }
}
```

Input JSON Payload:

```json
{
  "invoice": {
    "header": {
      "customer_name": "ACME, Inc.",
      "customer_state": "CA"
    },
    "items": [
      {
        "description": "Product 1",
        "quantity": "2",
        "unit_price": "10"
      },
      {
        "description": "Product 2",
        "quantity": "1",
        "unit_price": "30"
      }
    ]
  }
}
```

Output

```json
{
  "invoice": {
    "header": {
      "customer_name": "ACME, Inc.",
      "customer_state": "CA"
    },
    "items": {
      "item": {
        "description": "Product 1",
        "quantity": "2",
        "unit_price": "10",
        "discount": "5%",
        "subtotal": 19.0
      },
      "item": {
        "description": "Product 2",
        "quantity": "1",
        "unit_price": "30",
        "discount": "5%",
        "subtotal": 28.5
      }
    },
    "totals": {
      "subtotal": 47.5,
      "tax": "8.500%",
      "total": 51.5375
    }
  }
}
```

## Related Examples

- [Map Data](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-map)

- [Use Constant Directives](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-use-constant-directives)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-conditional-list-reduction-via-function)

- [Define a Function that Flattens Data in a List](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-define-function-to-flatten-list)

- [Pass Functions as Arguments](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-pass-functions-as-arguments)

## See Also

- [DataWeave Core Functions](https://docs.mulesoft.com/dataweave/2.6/dw-core)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.6/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook)

<!-- document id=d37a6e17bb8d3e8fae0b02d19004b7bd44060b0a62122fcc449c7621fb56c498 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook-define-a-custom-addition-function.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Define a Custom Addition Function

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example takes in a set of item prices and stock amounts and uses several functions to
calculate subtotals, deduct discounts and add taxes.

It makes use of the following:

- `map` function to go through all the items in the input.

- basic math operations like `*`, `+` and `-`.

- String concatenation with `++`.

- `as` to force string values into numbers.

- Fixed values in the header to set tax and discount amounts.

- A custom function in the header, to define once and use multiple times in the code.

- `reduce` function to aggregate the various items into a total.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
var tax = 0.085
var discount = 0.05
fun getSubtotal (items) = items reduce ((item, accumulator = 0) ->
        accumulator + (item.unit_price * item.quantity * (1 - discount)))
---
invoice: {
    header: payload.invoice.header,
    items: { (payload.invoice.items map {
        item : {
            description: $.description,
            quantity: $.quantity,
            unit_price: $.unit_price,
            discount: (discount * 100) as Number ++ "%",
            subtotal: $.unit_price * $.quantity * (1 - discount)
        }
    }) },
    totals:
    {
        subtotal: getSubtotal(payload.invoice.items ),
        tax: (tax * 100) as Number ++ "%",
        total: getSubtotal(payload.invoice.items ) * (1 + tax)
    }
}
```

Input JSON Payload:

```json
{
  "invoice": {
    "header": {
      "customer_name": "ACME, Inc.",
      "customer_state": "CA"
    },
    "items": [
      {
        "description": "Product 1",
        "quantity": "2",
        "unit_price": "10"
      },
      {
        "description": "Product 2",
        "quantity": "1",
        "unit_price": "30"
      }
    ]
  }
}
```

Output

```json
{
  "invoice": {
    "header": {
      "customer_name": "ACME, Inc.",
      "customer_state": "CA"
    },
    "items": {
      "item": {
        "description": "Product 1",
        "quantity": "2",
        "unit_price": "10",
        "discount": "5%",
        "subtotal": 19.0
      },
      "item": {
        "description": "Product 2",
        "quantity": "1",
        "unit_price": "30",
        "discount": "5%",
        "subtotal": 28.5
      }
    },
    "totals": {
      "subtotal": 47.5,
      "tax": "8.500%",
      "total": 51.5375
    }
  }
}
```

## Related Examples

- [Map Data](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-map)

- [Use Constant Directives](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-use-constant-directives)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-conditional-list-reduction-via-function)

- [Define a Function that Flattens Data in a List](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-define-function-to-flatten-list)

- [Pass Functions as Arguments](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-pass-functions-as-arguments)

## See Also

- [DataWeave Core Functions](https://docs.mulesoft.com/dataweave/2.9/dw-core)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.9/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook)

<!-- document id=94b43da3a3e2f6cb422dfe166346d93cc5dccdadeda181b852857f6956ab3fc7 url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook-define-a-custom-addition-function.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Define a Custom Addition Function

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example takes in a set of item prices and stock amounts and uses several functions to
calculate subtotals, deduct discounts and add taxes.

It makes use of the following:

- `map` function to go through all the items in the input.

- basic math operations like `*`, `+` and `-`.

- String concatenation with `++`.

- `as` to force string values into numbers.

- Fixed values in the header to set tax and discount amounts.

- A custom function in the header, to define once and use multiple times in the code.

- `reduce` function to aggregate the various items into a total.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
var tax = 0.085
var discount = 0.05
fun getSubtotal (items) = items reduce ((item, accumulator = 0) ->
        accumulator + (item.unit_price * item.quantity * (1 - discount)))
---
invoice: {
    header: payload.invoice.header,
    items: { (payload.invoice.items map {
        item : {
            description: $.description,
            quantity: $.quantity,
            unit_price: $.unit_price,
            discount: (discount * 100) as Number ++ "%",
            subtotal: $.unit_price * $.quantity * (1 - discount)
        }
    }) },
    totals:
    {
        subtotal: getSubtotal(payload.invoice.items ),
        tax: (tax * 100) as Number ++ "%",
        total: getSubtotal(payload.invoice.items ) * (1 + tax)
    }
}
```

Input JSON Payload:

```json
{
  "invoice": {
    "header": {
      "customer_name": "ACME, Inc.",
      "customer_state": "CA"
    },
    "items": [
      {
        "description": "Product 1",
        "quantity": "2",
        "unit_price": "10"
      },
      {
        "description": "Product 2",
        "quantity": "1",
        "unit_price": "30"
      }
    ]
  }
}
```

Output

```json
{
  "invoice": {
    "header": {
      "customer_name": "ACME, Inc.",
      "customer_state": "CA"
    },
    "items": {
      "item": {
        "description": "Product 1",
        "quantity": "2",
        "unit_price": "10",
        "discount": "5%",
        "subtotal": 19.0
      },
      "item": {
        "description": "Product 2",
        "quantity": "1",
        "unit_price": "30",
        "discount": "5%",
        "subtotal": 28.5
      }
    },
    "totals": {
      "subtotal": 47.5,
      "tax": "8.500%",
      "total": 51.5375
    }
  }
}
```

## Related Examples

- [Map Data](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-map)

- [Use Constant Directives](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-use-constant-directives)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-conditional-list-reduction-via-function)

- [Define a Function that Flattens Data in a List](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-define-function-to-flatten-list)

- [Pass Functions as Arguments](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-pass-functions-as-arguments)

## See Also

- [DataWeave Core Functions](https://docs.mulesoft.com/dataweave/latest/dw-core)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook)

<!-- document id=361199c64ed647dd3837fa8509967b0e1f34e724c5447bf359d2086a5f904a18 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook-define-function-to-flatten-list.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Define a Function that Flattens Data in a List

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

When presented with nested structures of data, you might need to reduce (or "flatten") the data in
them to produce a simpler output.

This DataWeave example flattens the data in the `interests` and `contenttypes` arrays with the
function that is defined in the header, and it only outputs `contenttypes` when it is not empty.

The example uses these functions:

- `map` to go through a set elements in the input.

- `reduce` to flatten the arrays.

- `if` to conditionally display a field.

- `splitBy` to parse the input.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
fun reduceMapFor(data) = data reduce (($$ splitBy ":")[0] ++ "," ++ ($ splitBy ":")[0])
---
payload.results map() ->
{
  email: $.profile.email,
  name: $.profile.firstName,
  tags: reduceMapFor($.data.interests.tags[0]),
        (contenttypes: reduceMapFor($.data.interests.contenttypes[0])) if(sizeOf($.data.interests.contenttypes[0]) > 0)
}
```

Input JSON Payload:

```json
{
  "results": [
    {
      "profile": {
        "firstName": "john",
        "lastName": "doe",
        "email": "johndoe@demo.com"
      },
      "data": {
        "interests": [
          {
            "language": "English",
            "tags": ["digital-strategy:Digital Strategy", "innovation:Innovation"],
            "contenttypes": []
          }
        ]
      }
    },
    {
      "profile": {
        "firstName": "jane",
        "lastName": "doe",
        "email": "janedoe@demo.com"
      },
      "data": {
        "interests": [
          {
            "language": "English",
            "tags": ["tax-reform:Tax Reform", "retail-health:Retail Health"],
            "contenttypes": ["News", "Analysis", "Case studies", "Press releases"]
          }
        ]
      }
    }
  ],
  "objectsCount": 2,
  "totalCount": 2,
  "statusCode": 200,
  "errorCode": 0,
  "statusReason": "OK"
}
```

Output

```json
[
  {
    "email": "johndoe@demo.com",
    "name": "john",
    "tags": "digital-strategy,innovation"
  },
  {
    "email": "janedoe@demo.com",
    "name": "jane",
    "tags": "tax-reform,retail-health",
    "contenttypes": "News,Analysis,Case studies,Press releases"
  }
]
```

## Related Examples

- [Use Constant Directives](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-use-constant-directives)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-conditional-list-reduction-via-function)

- [Define a Custom Addition Function](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-define-a-custom-addition-function)

- [Pass Functions as Arguments](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-pass-functions-as-arguments)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.11/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook)

<!-- document id=f1505eda4fa4bba797e3fb0c639731b8412ee55345549dd7ff468c53f6412f5c url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook-define-function-to-flatten-list.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Define a Function that Flattens Data in a List

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

When presented with nested structures of data, you might need to reduce (or "flatten") the data in
them to produce a simpler output.

This DataWeave example flattens the data in the `interests` and `contenttypes` arrays with the
function that is defined in the header, and it only outputs `contenttypes` when it is not empty.

The example uses these functions:

- `map` to go through a set elements in the input.

- `reduce` to flatten the arrays.

- `if` to conditionally display a field.

- `splitBy` to parse the input.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
fun reduceMapFor(data) = data reduce (($$ splitBy ":")[0] ++ "," ++ ($ splitBy ":")[0])
---
payload.results map() ->
{
  email: $.profile.email,
  name: $.profile.firstName,
  tags: reduceMapFor($.data.interests.tags[0]),
        (contenttypes: reduceMapFor($.data.interests.contenttypes[0])) if(sizeOf($.data.interests.contenttypes[0]) > 0)
}
```

Input JSON Payload:

```json
{
  "results": [
    {
      "profile": {
        "firstName": "john",
        "lastName": "doe",
        "email": "johndoe@demo.com"
      },
      "data": {
        "interests": [
          {
            "language": "English",
            "tags": ["digital-strategy:Digital Strategy", "innovation:Innovation"],
            "contenttypes": []
          }
        ]
      }
    },
    {
      "profile": {
        "firstName": "jane",
        "lastName": "doe",
        "email": "janedoe@demo.com"
      },
      "data": {
        "interests": [
          {
            "language": "English",
            "tags": ["tax-reform:Tax Reform", "retail-health:Retail Health"],
            "contenttypes": ["News", "Analysis", "Case studies", "Press releases"]
          }
        ]
      }
    }
  ],
  "objectsCount": 2,
  "totalCount": 2,
  "statusCode": 200,
  "errorCode": 0,
  "statusReason": "OK"
}
```

Output

```json
[
  {
    "email": "johndoe@demo.com",
    "name": "john",
    "tags": "digital-strategy,innovation"
  },
  {
    "email": "janedoe@demo.com",
    "name": "jane",
    "tags": "tax-reform,retail-health",
    "contenttypes": "News,Analysis,Case studies,Press releases"
  }
]
```

## Related Examples

- [Use Constant Directives](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-use-constant-directives)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-conditional-list-reduction-via-function)

- [Define a Custom Addition Function](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-define-a-custom-addition-function)

- [Pass Functions as Arguments](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-pass-functions-as-arguments)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.12/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook)

<!-- document id=39a695470e61ffe03424bf699334667d3944eb13e9f61979ae76383789e2902f url=/mulesoft/current/en-us/dataweave/2.3/dataweave-cookbook-define-function-to-flatten-list.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Define a Function that Flattens Data in a List

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

When presented with nested structures of data, you might need to reduce (or "flatten") the data in
them to produce a simpler output.

This DataWeave example flattens the data in the `interests` and `contenttypes` arrays with the
function that is defined in the header, and it only outputs `contenttypes` when it is not empty.

The example uses these functions:

- `map` to go through a set elements in the input.

- `reduce` to flatten the arrays.

- `if` to conditionally display a field.

- `splitBy` to parse the input.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
fun reduceMapFor(data) = data reduce (($$ splitBy ":")[0] ++ "," ++ ($ splitBy ":")[0])
---
payload.results map() ->
{
  email: $.profile.email,
  name: $.profile.firstName,
  tags: reduceMapFor($.data.interests.tags[0]),
        (contenttypes: reduceMapFor($.data.interests.contenttypes[0])) if(sizeOf($.data.interests.contenttypes[0]) > 0)
}
```

Input JSON Payload:

```json
{
  "results": [
    {
      "profile": {
        "firstName": "john",
        "lastName": "doe",
        "email": "johndoe@demo.com"
      },
      "data": {
        "interests": [
          {
            "language": "English",
            "tags": ["digital-strategy:Digital Strategy", "innovation:Innovation"],
            "contenttypes": []
          }
        ]
      }
    },
    {
      "profile": {
        "firstName": "jane",
        "lastName": "doe",
        "email": "janedoe@demo.com"
      },
      "data": {
        "interests": [
          {
            "language": "English",
            "tags": ["tax-reform:Tax Reform", "retail-health:Retail Health"],
            "contenttypes": ["News", "Analysis", "Case studies", "Press releases"]
          }
        ]
      }
    }
  ],
  "objectsCount": 2,
  "totalCount": 2,
  "statusCode": 200,
  "errorCode": 0,
  "statusReason": "OK"
}
```

Output

```json
[
  {
    "email": "johndoe@demo.com",
    "name": "john",
    "tags": "digital-strategy,innovation"
  },
  {
    "email": "janedoe@demo.com",
    "name": "jane",
    "tags": "tax-reform,retail-health",
    "contenttypes": "News,Analysis,Case studies,Press releases"
  }
]
```

## Related Examples

- [Use Constant Directives](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-use-constant-directives)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-conditional-list-reduction-via-function)

- [Define a Custom Addition Function](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-define-a-custom-addition-function)

- [Pass Functions as Arguments](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-pass-functions-as-arguments)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.3/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook)

<!-- document id=f111cf46f1b5b87ee705f673e7f2ec3e96633bb487930f6735eb54f5a5e39f8c url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook-define-function-to-flatten-list.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Define a Function that Flattens Data in a List

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

When presented with nested structures of data, you might need to reduce (or "flatten") the data in
them to produce a simpler output.

This DataWeave example flattens the data in the `interests` and `contenttypes` arrays with the
function that is defined in the header, and it only outputs `contenttypes` when it is not empty.

The example uses these functions:

- `map` to go through a set elements in the input.

- `reduce` to flatten the arrays.

- `if` to conditionally display a field.

- `splitBy` to parse the input.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
fun reduceMapFor(data) = data reduce (($$ splitBy ":")[0] ++ "," ++ ($ splitBy ":")[0])
---
payload.results map() ->
{
  email: $.profile.email,
  name: $.profile.firstName,
  tags: reduceMapFor($.data.interests.tags[0]),
        (contenttypes: reduceMapFor($.data.interests.contenttypes[0])) if(sizeOf($.data.interests.contenttypes[0]) > 0)
}
```

Input JSON Payload:

```json
{
  "results": [
    {
      "profile": {
        "firstName": "john",
        "lastName": "doe",
        "email": "johndoe@demo.com"
      },
      "data": {
        "interests": [
          {
            "language": "English",
            "tags": ["digital-strategy:Digital Strategy", "innovation:Innovation"],
            "contenttypes": []
          }
        ]
      }
    },
    {
      "profile": {
        "firstName": "jane",
        "lastName": "doe",
        "email": "janedoe@demo.com"
      },
      "data": {
        "interests": [
          {
            "language": "English",
            "tags": ["tax-reform:Tax Reform", "retail-health:Retail Health"],
            "contenttypes": ["News", "Analysis", "Case studies", "Press releases"]
          }
        ]
      }
    }
  ],
  "objectsCount": 2,
  "totalCount": 2,
  "statusCode": 200,
  "errorCode": 0,
  "statusReason": "OK"
}
```

Output

```json
[
  {
    "email": "johndoe@demo.com",
    "name": "john",
    "tags": "digital-strategy,innovation"
  },
  {
    "email": "janedoe@demo.com",
    "name": "jane",
    "tags": "tax-reform,retail-health",
    "contenttypes": "News,Analysis,Case studies,Press releases"
  }
]
```

## Related Examples

- [Use Constant Directives](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-use-constant-directives)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-conditional-list-reduction-via-function)

- [Define a Custom Addition Function](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-define-a-custom-addition-function)

- [Pass Functions as Arguments](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-pass-functions-as-arguments)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.4/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook)

<!-- document id=aa1991a3ff9cd5573c9dfd8c0600e9a30001659e95b5827191819b6f22befe57 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook-define-function-to-flatten-list.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Define a Function that Flattens Data in a List

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

When presented with nested structures of data, you might need to reduce (or "flatten") the data in
them to produce a simpler output.

This DataWeave example flattens the data in the `interests` and `contenttypes` arrays with the
function that is defined in the header, and it only outputs `contenttypes` when it is not empty.

The example uses these functions:

- `map` to go through a set elements in the input.

- `reduce` to flatten the arrays.

- `if` to conditionally display a field.

- `splitBy` to parse the input.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
fun reduceMapFor(data) = data reduce (($$ splitBy ":")[0] ++ "," ++ ($ splitBy ":")[0])
---
payload.results map() ->
{
  email: $.profile.email,
  name: $.profile.firstName,
  tags: reduceMapFor($.data.interests.tags[0]),
        (contenttypes: reduceMapFor($.data.interests.contenttypes[0])) if(sizeOf($.data.interests.contenttypes[0]) > 0)
}
```

Input JSON Payload:

```json
{
  "results": [
    {
      "profile": {
        "firstName": "john",
        "lastName": "doe",
        "email": "johndoe@demo.com"
      },
      "data": {
        "interests": [
          {
            "language": "English",
            "tags": ["digital-strategy:Digital Strategy", "innovation:Innovation"],
            "contenttypes": []
          }
        ]
      }
    },
    {
      "profile": {
        "firstName": "jane",
        "lastName": "doe",
        "email": "janedoe@demo.com"
      },
      "data": {
        "interests": [
          {
            "language": "English",
            "tags": ["tax-reform:Tax Reform", "retail-health:Retail Health"],
            "contenttypes": ["News", "Analysis", "Case studies", "Press releases"]
          }
        ]
      }
    }
  ],
  "objectsCount": 2,
  "totalCount": 2,
  "statusCode": 200,
  "errorCode": 0,
  "statusReason": "OK"
}
```

Output

```json
[
  {
    "email": "johndoe@demo.com",
    "name": "john",
    "tags": "digital-strategy,innovation"
  },
  {
    "email": "janedoe@demo.com",
    "name": "jane",
    "tags": "tax-reform,retail-health",
    "contenttypes": "News,Analysis,Case studies,Press releases"
  }
]
```

## Related Examples

- [Use Constant Directives](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-use-constant-directives)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-conditional-list-reduction-via-function)

- [Define a Custom Addition Function](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-define-a-custom-addition-function)

- [Pass Functions as Arguments](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-pass-functions-as-arguments)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.6/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook)

<!-- document id=0f5e203cdb8f8a7fba360eadceeee83c263e381797d9c4db023861ef550e0cb8 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook-define-function-to-flatten-list.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Define a Function that Flattens Data in a List

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

When presented with nested structures of data, you might need to reduce (or "flatten") the data in
them to produce a simpler output.

This DataWeave example flattens the data in the `interests` and `contenttypes` arrays with the
function that is defined in the header, and it only outputs `contenttypes` when it is not empty.

The example uses these functions:

- `map` to go through a set elements in the input.

- `reduce` to flatten the arrays.

- `if` to conditionally display a field.

- `splitBy` to parse the input.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
fun reduceMapFor(data) = data reduce (($$ splitBy ":")[0] ++ "," ++ ($ splitBy ":")[0])
---
payload.results map() ->
{
  email: $.profile.email,
  name: $.profile.firstName,
  tags: reduceMapFor($.data.interests.tags[0]),
        (contenttypes: reduceMapFor($.data.interests.contenttypes[0])) if(sizeOf($.data.interests.contenttypes[0]) > 0)
}
```

Input JSON Payload:

```json
{
  "results": [
    {
      "profile": {
        "firstName": "john",
        "lastName": "doe",
        "email": "johndoe@demo.com"
      },
      "data": {
        "interests": [
          {
            "language": "English",
            "tags": ["digital-strategy:Digital Strategy", "innovation:Innovation"],
            "contenttypes": []
          }
        ]
      }
    },
    {
      "profile": {
        "firstName": "jane",
        "lastName": "doe",
        "email": "janedoe@demo.com"
      },
      "data": {
        "interests": [
          {
            "language": "English",
            "tags": ["tax-reform:Tax Reform", "retail-health:Retail Health"],
            "contenttypes": ["News", "Analysis", "Case studies", "Press releases"]
          }
        ]
      }
    }
  ],
  "objectsCount": 2,
  "totalCount": 2,
  "statusCode": 200,
  "errorCode": 0,
  "statusReason": "OK"
}
```

Output

```json
[
  {
    "email": "johndoe@demo.com",
    "name": "john",
    "tags": "digital-strategy,innovation"
  },
  {
    "email": "janedoe@demo.com",
    "name": "jane",
    "tags": "tax-reform,retail-health",
    "contenttypes": "News,Analysis,Case studies,Press releases"
  }
]
```

## Related Examples

- [Use Constant Directives](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-use-constant-directives)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-conditional-list-reduction-via-function)

- [Define a Custom Addition Function](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-define-a-custom-addition-function)

- [Pass Functions as Arguments](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-pass-functions-as-arguments)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.9/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook)

<!-- document id=ac1dc6e6393d6937aebaec3389f228711b120df09d120400d7c97d9e0e1903e0 url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook-define-function-to-flatten-list.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Define a Function that Flattens Data in a List

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

When presented with nested structures of data, you might need to reduce (or "flatten") the data in
them to produce a simpler output.

This DataWeave example flattens the data in the `interests` and `contenttypes` arrays with the
function that is defined in the header, and it only outputs `contenttypes` when it is not empty.

The example uses these functions:

- `map` to go through a set elements in the input.

- `reduce` to flatten the arrays.

- `if` to conditionally display a field.

- `splitBy` to parse the input.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
fun reduceMapFor(data) = data reduce (($$ splitBy ":")[0] ++ "," ++ ($ splitBy ":")[0])
---
payload.results map() ->
{
  email: $.profile.email,
  name: $.profile.firstName,
  tags: reduceMapFor($.data.interests.tags[0]),
        (contenttypes: reduceMapFor($.data.interests.contenttypes[0])) if(sizeOf($.data.interests.contenttypes[0]) > 0)
}
```

Input JSON Payload:

```json
{
  "results": [
    {
      "profile": {
        "firstName": "john",
        "lastName": "doe",
        "email": "johndoe@demo.com"
      },
      "data": {
        "interests": [
          {
            "language": "English",
            "tags": ["digital-strategy:Digital Strategy", "innovation:Innovation"],
            "contenttypes": []
          }
        ]
      }
    },
    {
      "profile": {
        "firstName": "jane",
        "lastName": "doe",
        "email": "janedoe@demo.com"
      },
      "data": {
        "interests": [
          {
            "language": "English",
            "tags": ["tax-reform:Tax Reform", "retail-health:Retail Health"],
            "contenttypes": ["News", "Analysis", "Case studies", "Press releases"]
          }
        ]
      }
    }
  ],
  "objectsCount": 2,
  "totalCount": 2,
  "statusCode": 200,
  "errorCode": 0,
  "statusReason": "OK"
}
```

Output

```json
[
  {
    "email": "johndoe@demo.com",
    "name": "john",
    "tags": "digital-strategy,innovation"
  },
  {
    "email": "janedoe@demo.com",
    "name": "jane",
    "tags": "tax-reform,retail-health",
    "contenttypes": "News,Analysis,Case studies,Press releases"
  }
]
```

## Related Examples

- [Use Constant Directives](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-use-constant-directives)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-conditional-list-reduction-via-function)

- [Define a Custom Addition Function](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-define-a-custom-addition-function)

- [Pass Functions as Arguments](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-pass-functions-as-arguments)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook)

<!-- document id=9cd197b86de964e70a6718b558c4d586884e20cf29a86acf152c0d950ced2c4d url=/mulesoft/current/en-us/dataweave/2.11/dataweave-functions.md -->

---
product: DataWeave
version: 2.11
---

# Define DataWeave Functions

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You can define your own DataWeave functions using the `fun` declaration in the header of a DataWeave
script.

## DataWeave Function Definition Syntax

To define a function in DataWeave use the following syntax:

fun myFunction(param1, param2, ...) = <code to execute>

- The `fun` keyword starts the definition of a function.

- `myFunction` is the name you define for the function.

  Function names must be valid identifiers. For additional details about valid identifiers, see
  [Rules for Declaring Valid Identifiers](https://docs.mulesoft.com/dataweave/2.11/dataweave-language-introduction#valid-identifiers).

- `(param1, param2, …​ , paramn)` represents the parameters that your function accepts.

  You can specify from zero to any number of parameters, separated by commas (`,`) and enclosed in
  parentheses.

- The `=` sign marks the beginning of the code block to execute when the function is called.

- `<code to execute>` represents the actual code that you define for your function.

## Example Function Definitions

The following example defines a DataWeave function that accepts a single string argument, calls the
`upper` function using the received string argument, and then outputs the result:

Example: Simple Function Definition

```dataweave
%dw 2.0
output application/json
fun toUpper(aString) = upper(aString)
---
toUpper("hello")
```

Output

"HELLO"

The next example shows how the argument to a DataWeave function can be any DataWeave expression:

Example: Using Expressions as Arguments

```dataweave
%dw 2.0
output application/json
fun toUpper(aString) = upper(aString)
---
toUpper("h" ++ "el" ++ lower("LO") )
```

Output

"HELLO"

The following example tests the type of the argument passed to the function by performing
[pattern matching](https://docs.mulesoft.com/dataweave/2.11/dataweave-pattern-matching) with the built-in `match` operation:

Example: Function that Uses Pattern Matching

```dataweave
%dw 2.0
output application/json
fun toUpper(aString)
= aString match {
  case is String -> upper(aString)
  else -> null
}
---
toUpper("h" ++ "el" ++ lower("LO") )
```

Output

"HELLO"

This example creates a function that reformats a numeric string into a common phone number format:

Example: toPhoneFormat() Function

```dataweave
%dw 2.0
output application/json
fun toPhoneFormat(str: String) =
    "(" ++ str[0 to 2] ++ ") " ++ str[3 to 5] ++ "-" ++ str[6 to 9]
---
toPhoneFormat("1234567890")
```

Output

"(123) 456-7890"

## Type Constraint Definition

You can define type constraint expressions when you declare functions to ensure that the arguments
for a function call respect the defined type constraint.

To define type constraints for functions, use the following syntax:

fun myFunction(param1: Type, param2: Type): ResultType = <code to execute>

Example: Function with Type Constraints

%dw 2.0 output application/json fun toUser(id: Number, userName: String): String = "you called the
function toUser!"

In this example, the type constraints define that the function `toUser` accepts only a first
argument of type `Number` and a second argument of type `String`.

Also, the function specifies a constraint for the result to be of type `String`. This return type
constraint does not affect the function call; rather, this constraint applies to the function code
to validate that the function generates a result of the defined type.

You can find more details about the DataWeave type system in
[https://docs.mulesoft.com/dataweave/latest/dataweave-type-system](https://docs.mulesoft.com/dataweave/latest/dataweave-type-system).

## Optional Parameters Definition

You can define optional parameters by assigning a default value to them. The following example shows
a function that defines one parameter that is mandatory (`name`) and a second parameter that is
optional (`countryCode`) and has a default value:

Example: Function with Optional Parameters

```dataweave
%dw 2.0
output application/json
fun createUserData(name, countryCode = "US") = { "User name" : name, "Location": countryCode}
---
[createUserData("Cristian", "AR"), createUserData("Max The Mule")]
```

Output

\[ { "User name": "Cristian", "Location": "AR" }, { "User name": "Max The Mule", "Location": "US" }
\]

### Optional Parameter Order

DataWeave enables you to define optional parameters at the beginning or at the end of the parameter
definition:

Example: Functions with Optional Parameters

```dataweave
%dw 2.0
output application/json
fun optionalParamsLast(a, b = 2, c = 3)
fun optionalParamsFirst(a = 1, b = 2, c)
```

When you call a function, the arguments are assigned from left to right. However, if you define
optional parameters first, then the arguments are assigned from right to left. In addition, if all
the parameters in a function are optional, the assignment is also from right to left:

Example: Optional Parameter Assignment

```dataweave
%dw 2.0
output application/json
fun optionalParamsLast(param1, param2 = 2, param3 = 3) =
    { "param1": param1, "param2": param2, "param3": param3}
fun optionalParamsFirst(param1 = 1, param2 = 2, param3) =
    { "param1": param1, "param2": param2, "param3": param3}
fun allParametersOptional(param1 = 1, param2 = 2, param3 = 3) =
    { "param1": param1, "param2": param2, "param3": param3}
---
{
  "optionalParamsLast(A)":optionalParamsLast('A'),
  "optionalParamsLast(A, B)":optionalParamsLast('A', 'B'),
  "optionalParamsLast(A, B, C)":optionalParamsLast('A', 'B', 'C'),
  "optionalParamsFirst(A)":optionalParamsFirst('A'),
  "optionalParamsFirst(A, B)":optionalParamsFirst('A', 'B'),
  "optionalParamsFirst(A, B, C)":optionalParamsFirst('A', 'B', 'C'),
  "allParametersOptional(A)":allParametersOptional('A'),
  "allParametersOptional(A, B)":allParametersOptional('A', 'B'),
  "allParametersOptional(A, B, C)":allParametersOptional('A', 'B', 'C')
}
```

Output

{ "optionalParamsLast(A)": { "param1": "A", "param2": 2, "param3": 3 }, "optionalParamsLast(A, B)":
{ "param1": "A", "param2": "B", "param3": 3 }, "optionalParamsLast(A, B, C)": { "param1": "A",
"param2": "B", "param3": "C" }, "optionalParamsFirst(A)": { "param1": 1, "param2": 2, "param3": "A"
}, "optionalParamsFirst(A, B)": { "param1": 1, "param2": "A", "param3": "B" },
"optionalParamsFirst(A, B, C)": { "param1": "A", "param2": "B", "param3": "C" },
"allParametersOptional(A)": { "param1": 1, "param2": 2, "param3": "A" }, "allParametersOptional(A,
B)": { "param1": 1, "param2": "A", "param3": "B" }, "allParametersOptional(A, B, C)": { "param1":
"A", "param2": "B", "param3": "C" } }

## Type Parameters Definition

DataWeave function definitions support the use of type parameters, which are similar to generics in
some programming languages.

Example: Function that Uses Type Parameters

```dataweace
%dw 2.0
output application/json

fun toArray<T>(x: T): Array<T> = [x]
---
toArray(2)
```

DataWeave also supports adding type parameter constraints, which limit accepted inputs for a
function.

Example Function that Uses Type Parameters with Constraints

```dataweace
%dw 2.0
output application/json

fun getName<T <: { name: String }>(x: T): String = x.name
---
{
  name: getName({ name: "Andrés" })
  //name: getName({ age: 20 }) invalid call as the parameter does not fullfill the constraint
}
```

## Function Overloading

DataWeave enables you to create multiple functions with the same name but different parameters. This
feature is useful for defining different behaviors based on the arguments of a function call.

Parameters in overloaded functions differ in number or type. To understand more about defining type
constraints on function parameters, see [Type System](https://docs.mulesoft.com/dataweave/2.11/dataweave-type-system).

DataWeave uses the first function it finds that accepts the arguments of the function call, based on
the order in which the functions are declared in the script.

Example: Function that Uses Function Overloading

```dataweave
%dw 2.0
output application/json

fun toUpper(a: String) = upper(a)
fun toUpper(a: Any) = null
fun toUpper(a: String, b: Number) = upper(a) ++ b as String
---
toUpper("hi!")
```

The argument of the function call `toUpper("hi!")` matches the types String and Any, so it is
possible to call the function with the first two definitions. However, DataWeave executes the
function `fun toUpper(a: String) = upper(a)` because that function is defined before the one that
uses the type Any.

Output of toUpper("hi!")

"HI!"

Output of toUpper(true)

null

Output of toUpper("age: ", 26)

"AGE: 26"

## See Also

[Create Custom Modules and Mappings](https://docs.mulesoft.com/dataweave/2.11/dataweave-create-module)

[DataWeave Reference](https://docs.mulesoft.com/dataweave/2.11/dw-functions)

<!-- document id=b6955e8623482816681714e00194ab2e195f58375a0eab5bb5255dac3ade5972 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-functions.md -->

---
product: DataWeave
version: 2.12
---

# Define DataWeave Functions

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You can define your own DataWeave functions using the `fun` declaration in the header of a DataWeave
script.

## DataWeave Function Definition Syntax

To define a function in DataWeave use the following syntax:

fun myFunction(param1, param2, ...) = <code to execute>

- The `fun` keyword starts the definition of a function.

- `myFunction` is the name you define for the function.

  Function names must be valid identifiers. For additional details about valid identifiers, see
  [Rules for Declaring Valid Identifiers](https://docs.mulesoft.com/dataweave/2.12/dataweave-language-introduction#valid-identifiers).

- `(param1, param2, …​ , paramn)` represents the parameters that your function accepts.

  You can specify from zero to any number of parameters, separated by commas (`,`) and enclosed in
  parentheses.

- The `=` sign marks the beginning of the code block to execute when the function is called.

- `<code to execute>` represents the actual code that you define for your function.

## Example Function Definitions

The following example defines a DataWeave function that accepts a single string argument, calls the
`upper` function using the received string argument, and then outputs the result:

Example: Simple Function Definition

```dataweave
%dw 2.0
output application/json
fun toUpper(aString) = upper(aString)
---
toUpper("hello")
```

Output

"HELLO"

The next example shows how the argument to a DataWeave function can be any DataWeave expression:

Example: Using Expressions as Arguments

```dataweave
%dw 2.0
output application/json
fun toUpper(aString) = upper(aString)
---
toUpper("h" ++ "el" ++ lower("LO") )
```

Output

"HELLO"

The following example tests the type of the argument passed to the function by performing
[pattern matching](https://docs.mulesoft.com/dataweave/2.12/dataweave-pattern-matching) with the built-in `match` operation:

Example: Function that Uses Pattern Matching

```dataweave
%dw 2.0
output application/json
fun toUpper(aString)
= aString match {
  case is String -> upper(aString)
  else -> null
}
---
toUpper("h" ++ "el" ++ lower("LO") )
```

Output

"HELLO"

This example creates a function that reformats a numeric string into a common phone number format:

Example: toPhoneFormat() Function

```dataweave
%dw 2.0
output application/json
fun toPhoneFormat(str: String) =
    "(" ++ str[0 to 2] ++ ") " ++ str[3 to 5] ++ "-" ++ str[6 to 9]
---
toPhoneFormat("1234567890")
```

Output

"(123) 456-7890"

## Type Constraint Definition

You can define type constraint expressions when you declare functions to ensure that the arguments
for a function call respect the defined type constraint.

To define type constraints for functions, use the following syntax:

fun myFunction(param1: Type, param2: Type): ResultType = <code to execute>

Example: Function with Type Constraints

%dw 2.0 output application/json fun toUser(id: Number, userName: String): String = "you called the
function toUser!"

In this example, the type constraints define that the function `toUser` accepts only a first
argument of type `Number` and a second argument of type `String`.

Also, the function specifies a constraint for the result to be of type `String`. This return type
constraint does not affect the function call; rather, this constraint applies to the function code
to validate that the function generates a result of the defined type.

You can find more details about the DataWeave type system in
[https://docs.mulesoft.com/dataweave/latest/dataweave-type-system](https://docs.mulesoft.com/dataweave/latest/dataweave-type-system).

## Optional Parameters Definition

You can define optional parameters by assigning a default value to them. The following example shows
a function that defines one parameter that is mandatory (`name`) and a second parameter that is
optional (`countryCode`) and has a default value:

Example: Function with Optional Parameters

```dataweave
%dw 2.0
output application/json
fun createUserData(name, countryCode = "US") = { "User name" : name, "Location": countryCode}
---
[createUserData("Cristian", "AR"), createUserData("Max The Mule")]
```

Output

\[ { "User name": "Cristian", "Location": "AR" }, { "User name": "Max The Mule", "Location": "US" }
\]

### Optional Parameter Order

DataWeave enables you to define optional parameters at the beginning or at the end of the parameter
definition:

Example: Functions with Optional Parameters

```dataweave
%dw 2.0
output application/json
fun optionalParamsLast(a, b = 2, c = 3)
fun optionalParamsFirst(a = 1, b = 2, c)
```

When you call a function, the arguments are assigned from left to right. However, if you define
optional parameters first, then the arguments are assigned from right to left. In addition, if all
the parameters in a function are optional, the assignment is also from right to left:

Example: Optional Parameter Assignment

```dataweave
%dw 2.0
output application/json
fun optionalParamsLast(param1, param2 = 2, param3 = 3) =
    { "param1": param1, "param2": param2, "param3": param3}
fun optionalParamsFirst(param1 = 1, param2 = 2, param3) =
    { "param1": param1, "param2": param2, "param3": param3}
fun allParametersOptional(param1 = 1, param2 = 2, param3 = 3) =
    { "param1": param1, "param2": param2, "param3": param3}
---
{
  "optionalParamsLast(A)":optionalParamsLast('A'),
  "optionalParamsLast(A, B)":optionalParamsLast('A', 'B'),
  "optionalParamsLast(A, B, C)":optionalParamsLast('A', 'B', 'C'),
  "optionalParamsFirst(A)":optionalParamsFirst('A'),
  "optionalParamsFirst(A, B)":optionalParamsFirst('A', 'B'),
  "optionalParamsFirst(A, B, C)":optionalParamsFirst('A', 'B', 'C'),
  "allParametersOptional(A)":allParametersOptional('A'),
  "allParametersOptional(A, B)":allParametersOptional('A', 'B'),
  "allParametersOptional(A, B, C)":allParametersOptional('A', 'B', 'C')
}
```

Output

{ "optionalParamsLast(A)": { "param1": "A", "param2": 2, "param3": 3 }, "optionalParamsLast(A, B)":
{ "param1": "A", "param2": "B", "param3": 3 }, "optionalParamsLast(A, B, C)": { "param1": "A",
"param2": "B", "param3": "C" }, "optionalParamsFirst(A)": { "param1": 1, "param2": 2, "param3": "A"
}, "optionalParamsFirst(A, B)": { "param1": 1, "param2": "A", "param3": "B" },
"optionalParamsFirst(A, B, C)": { "param1": "A", "param2": "B", "param3": "C" },
"allParametersOptional(A)": { "param1": 1, "param2": 2, "param3": "A" }, "allParametersOptional(A,
B)": { "param1": 1, "param2": "A", "param3": "B" }, "allParametersOptional(A, B, C)": { "param1":
"A", "param2": "B", "param3": "C" } }

## Type Parameters Definition

DataWeave function definitions support the use of type parameters, which are similar to generics in
some programming languages.

Example: Function that Uses Type Parameters

```dataweace
%dw 2.0
output application/json

fun toArray<T>(x: T): Array<T> = [x]
---
toArray(2)
```

DataWeave also supports adding type parameter constraints, which limit accepted inputs for a
function.

Example Function that Uses Type Parameters with Constraints

```dataweace
%dw 2.0
output application/json

fun getName<T <: { name: String }>(x: T): String = x.name
---
{
  name: getName({ name: "Andrés" })
  //name: getName({ age: 20 }) invalid call as the parameter does not fullfill the constraint
}
```

## Function Overloading

DataWeave enables you to create multiple functions with the same name but different parameters. This
feature is useful for defining different behaviors based on the arguments of a function call.

Parameters in overloaded functions differ in number or type. To understand more about defining type
constraints on function parameters, see [Type System](https://docs.mulesoft.com/dataweave/2.12/dataweave-type-system).

DataWeave uses the first function it finds that accepts the arguments of the function call, based on
the order in which the functions are declared in the script.

Example: Function that Uses Function Overloading

```dataweave
%dw 2.0
output application/json

fun toUpper(a: String) = upper(a)
fun toUpper(a: Any) = null
fun toUpper(a: String, b: Number) = upper(a) ++ b as String
---
toUpper("hi!")
```

The argument of the function call `toUpper("hi!")` matches the types String and Any, so it is
possible to call the function with the first two definitions. However, DataWeave executes the
function `fun toUpper(a: String) = upper(a)` because that function is defined before the one that
uses the type Any.

Output of toUpper("hi!")

"HI!"

Output of toUpper(true)

null

Output of toUpper("age: ", 26)

"AGE: 26"

## See Also

[Create Custom Modules and Mappings](https://docs.mulesoft.com/dataweave/2.12/dataweave-create-module)

[DataWeave Reference](https://docs.mulesoft.com/dataweave/2.12/dw-functions)

<!-- document id=fac2377a64fe078e65a228d3f7a400c21aacecd82f5aba30b86ad8c16e45b93b url=/mulesoft/current/en-us/dataweave/2.3/dataweave-functions.md -->

---
product: DataWeave
version: 2.3
---

# Define DataWeave Functions

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You can define your own DataWeave functions using the `fun` declaration in the header of a DataWeave
script.

## DataWeave Function Definition Syntax

To define a function in DataWeave use the following syntax:

fun myFunction(param1, param2, ...) = <code to execute>

- The `fun` keyword starts the definition of a function.

- `myFunction` is the name you define for the function.

  Function names must be valid identifiers. For additional details about valid identifiers, see
  [Rules for Declaring Valid Identifiers](https://docs.mulesoft.com/dataweave/2.3/dataweave-language-introduction#valid-identifiers).

- `(param1, param2, …​ , paramn)` represents the parameters that your function accepts.

  You can specify from zero to any number of parameters, separated by commas (`,`) and enclosed in
  parentheses.

- The `=` sign marks the beginning of the code block to execute when the function is called.

- `<code to execute>` represents the actual code that you define for your function.

## Example Function Definitions

The following example defines a DataWeave function that accepts a single string argument, calls the
`upper` function using the received string argument, and then outputs the result:

Example: Simple Function Definition

```dataweave
%dw 2.0
output application/json
fun toUpper(aString) = upper(aString)
---
toUpper("hello")
```

Output

"HELLO"

The next example shows how the argument to a DataWeave function can be any DataWeave expression:

Example: Using Expressions as Arguments

```dataweave
%dw 2.0
output application/json
fun toUpper(aString) = upper(aString)
---
toUpper("h" ++ "el" ++ lower("LO") )
```

Output

"HELLO"

The following example tests the type of the argument passed to the function by performing
[pattern matching](https://docs.mulesoft.com/dataweave/2.3/dataweave-pattern-matching) with the built-in `match` operation:

Example: Function that Uses Pattern Matching

```dataweave
%dw 2.0
output application/json
fun toUpper(aString)
= aString match {
  case is String -> upper(aString)
  else -> null
}
---
toUpper("h" ++ "el" ++ lower("LO") )
```

Output

"HELLO"

This example creates a function that reformats a numeric string into a common phone number format:

Example: toPhoneFormat() Function

```dataweave
%dw 2.0
output application/json
fun toPhoneFormat(str: String) =
    "(" ++ str[0 to 2] ++ ") " ++ str[3 to 5] ++ "-" ++ str[6 to 9]
---
toPhoneFormat("1234567890")
```

Output

"(123) 456-7890"

## Type Constraint Definition

You can define type constraint expressions when you declare functions to ensure that the arguments
for a function call respect the defined type constraint.

To define type constraints for functions, use the following syntax:

fun myFunction(param1: Type, param2: Type): ResultType = <code to execute>

Example: Function with Type Constraints

%dw 2.0 output application/json fun toUser(id: Number, userName: String): String = "you called the
function toUser!"

In this example, the type constraints define that the function `toUser` accepts only a first
argument of type `Number` and a second argument of type `String`.

Also, the function specifies a constraint for the result to be of type `String`. This return type
constraint does not affect the function call; rather, this constraint applies to the function code
to validate that the function generates a result of the defined type.

You can find more details about the DataWeave type system in
[https://docs.mulesoft.com/dataweave/2.3/dataweave-type-system](https://docs.mulesoft.com/dataweave/2.3/dataweave-type-system).

## Optional Parameters Definition

You can define optional parameters by assigning a default value to them. The following example shows
a function that defines one parameter that is mandatory (`name`) and a second parameter that is
optional (`countryCode`) and has a default value:

Example: Function with Optional Parameters

```dataweave
%dw 2.0
output application/json
fun createUserData(name, countryCode = "US") = { "User name" : name, "Location": countryCode}
---
[createUserData("Cristian", "AR"), createUserData("Max The Mule")]
```

Output

\[ { "User name": "Cristian", "Location": "AR" }, { "User name": "Max The Mule", "Location": "US" }
\]

### Optional Parameter Order

DataWeave enables you to define optional parameters at the beginning or at the end of the parameter
definition:

Example: Functions with Optional Parameters

```dataweave
%dw 2.0
output application/json
fun optionalParamsLast(a, b = 2, c = 3)
fun optionalParamsFirst(a = 1, b = 2, c)
```

When you call a function, the arguments are assigned from left to right. However, if you define
optional parameters first, then the arguments are assigned from right to left. In addition, if all
the parameters in a function are optional, the assignment is also from right to left:

Example: Optional Parameter Assignment

```dataweave
%dw 2.0
output application/json
fun optionalParamsLast(param1, param2 = 2, param3 = 3) =
    { "param1": param1, "param2": param2, "param3": param3}
fun optionalParamsFirst(param1 = 1, param2 = 2, param3) =
    { "param1": param1, "param2": param2, "param3": param3}
fun allParametersOptional(param1 = 1, param2 = 2, param3 = 3) =
    { "param1": param1, "param2": param2, "param3": param3}
---
{
  "optionalParamsLast(A)":optionalParamsLast('A'),
  "optionalParamsLast(A, B)":optionalParamsLast('A', 'B'),
  "optionalParamsLast(A, B, C)":optionalParamsLast('A', 'B', 'C'),
  "optionalParamsFirst(A)":optionalParamsFirst('A'),
  "optionalParamsFirst(A, B)":optionalParamsFirst('A', 'B'),
  "optionalParamsFirst(A, B, C)":optionalParamsFirst('A', 'B', 'C'),
  "allParametersOptional(A)":allParametersOptional('A'),
  "allParametersOptional(A, B)":allParametersOptional('A', 'B'),
  "allParametersOptional(A, B, C)":allParametersOptional('A', 'B', 'C')
}
```

Output

{ "optionalParamsLast(A)": { "param1": "A", "param2": 2, "param3": 3 }, "optionalParamsLast(A, B)":
{ "param1": "A", "param2": "B", "param3": 3 }, "optionalParamsLast(A, B, C)": { "param1": "A",
"param2": "B", "param3": "C" }, "optionalParamsFirst(A)": { "param1": 1, "param2": 2, "param3": "A"
}, "optionalParamsFirst(A, B)": { "param1": 1, "param2": "A", "param3": "B" },
"optionalParamsFirst(A, B, C)": { "param1": "A", "param2": "B", "param3": "C" },
"allParametersOptional(A)": { "param1": 1, "param2": 2, "param3": "A" }, "allParametersOptional(A,
B)": { "param1": 1, "param2": "A", "param3": "B" }, "allParametersOptional(A, B, C)": { "param1":
"A", "param2": "B", "param3": "C" } }

## Function Overloading

DataWeave enables you to create multiple functions with the same name but different parameters. This
feature is useful for defining different behaviors based on the arguments of a function call.

Parameters in overloaded functions differ in number or type. To understand more about defining type
constraints on function parameters, see [Type System](https://docs.mulesoft.com/dataweave/2.3/dataweave-type-system).

DataWeave uses the first function it finds that accepts the arguments of the function call, based on
the order in which the functions are declared in the script.

Example: Function that Uses Function Overloading

```dataweave
%dw 2.0
output application/json

fun toUpper(a: String) = upper(a)
fun toUpper(a: Any) = null
fun toUpper(a: String, b: Number) = upper(a) ++ b as String
---
toUpper("hi!")
```

The argument of the function call `toUpper("hi!")` matches the types String and Any, so it is
possible to call the function with the first two definitions. However, DataWeave executes the
function `fun toUpper(a: String) = upper(a)` because that function is defined before the one that
uses the type Any.

Output of toUpper("hi!")

"HI!"

Output of toUpper(true)

null

Output of toUpper("age: ", 26)

"AGE: 26"

## See Also

[Create Custom Modules and Mappings](https://docs.mulesoft.com/dataweave/2.3/dataweave-create-module)

[DataWeave Reference](https://docs.mulesoft.com/dataweave/2.3/dw-functions)

<!-- document id=46eb51b0abb1df573c117ed847c398ed4299f5d5d641ca381123b77a0bbbc1c6 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-functions.md -->

---
product: DataWeave
version: 2.4
---

# Define DataWeave Functions

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You can define your own DataWeave functions using the `fun` declaration in the header of a DataWeave
script.

## DataWeave Function Definition Syntax

To define a function in DataWeave use the following syntax:

fun myFunction(param1, param2, ...) = <code to execute>

- The `fun` keyword starts the definition of a function.

- `myFunction` is the name you define for the function.

  Function names must be valid identifiers. For additional details about valid identifiers, see
  [Rules for Declaring Valid Identifiers](https://docs.mulesoft.com/dataweave/2.4/dataweave-language-introduction#valid-identifiers).

- `(param1, param2, …​ , paramn)` represents the parameters that your function accepts.

  You can specify from zero to any number of parameters, separated by commas (`,`) and enclosed in
  parentheses.

- The `=` sign marks the beginning of the code block to execute when the function is called.

- `<code to execute>` represents the actual code that you define for your function.

## Example Function Definitions

The following example defines a DataWeave function that accepts a single string argument, calls the
`upper` function using the received string argument, and then outputs the result:

Example: Simple Function Definition

```dataweave
%dw 2.0
output application/json
fun toUpper(aString) = upper(aString)
---
toUpper("hello")
```

Output

"HELLO"

The next example shows how the argument to a DataWeave function can be any DataWeave expression:

Example: Using Expressions as Arguments

```dataweave
%dw 2.0
output application/json
fun toUpper(aString) = upper(aString)
---
toUpper("h" ++ "el" ++ lower("LO") )
```

Output

"HELLO"

The following example tests the type of the argument passed to the function by performing
[pattern matching](https://docs.mulesoft.com/dataweave/2.4/dataweave-pattern-matching) with the built-in `match` operation:

Example: Function that Uses Pattern Matching

```dataweave
%dw 2.0
output application/json
fun toUpper(aString)
= aString match {
  case is String -> upper(aString)
  else -> null
}
---
toUpper("h" ++ "el" ++ lower("LO") )
```

Output

"HELLO"

This example creates a function that reformats a numeric string into a common phone number format:

Example: toPhoneFormat() Function

```dataweave
%dw 2.0
output application/json
fun toPhoneFormat(str: String) =
    "(" ++ str[0 to 2] ++ ") " ++ str[3 to 5] ++ "-" ++ str[6 to 9]
---
toPhoneFormat("1234567890")
```

Output

"(123) 456-7890"

## Type Constraint Definition

You can define type constraint expressions when you declare functions to ensure that the arguments
for a function call respect the defined type constraint.

To define type constraints for functions, use the following syntax:

fun myFunction(param1: Type, param2: Type): ResultType = <code to execute>

Example: Function with Type Constraints

%dw 2.0 output application/json fun toUser(id: Number, userName: String): String = "you called the
function toUser!"

In this example, the type constraints define that the function `toUser` accepts only a first
argument of type `Number` and a second argument of type `String`.

Also, the function specifies a constraint for the result to be of type `String`. This return type
constraint does not affect the function call; rather, this constraint applies to the function code
to validate that the function generates a result of the defined type.

You can find more details about the DataWeave type system in
[https://docs.mulesoft.com/dataweave/latest/dataweave-type-system](https://docs.mulesoft.com/dataweave/latest/dataweave-type-system).

## Optional Parameters Definition

You can define optional parameters by assigning a default value to them. The following example shows
a function that defines one parameter that is mandatory (`name`) and a second parameter that is
optional (`countryCode`) and has a default value:

Example: Function with Optional Parameters

```dataweave
%dw 2.0
output application/json
fun createUserData(name, countryCode = "US") = { "User name" : name, "Location": countryCode}
---
[createUserData("Cristian", "AR"), createUserData("Max The Mule")]
```

Output

\[ { "User name": "Cristian", "Location": "AR" }, { "User name": "Max The Mule", "Location": "US" }
\]

### Optional Parameter Order

DataWeave enables you to define optional parameters at the beginning or at the end of the parameter
definition:

Example: Functions with Optional Parameters

```dataweave
%dw 2.0
output application/json
fun optionalParamsLast(a, b = 2, c = 3)
fun optionalParamsFirst(a = 1, b = 2, c)
```

When you call a function, the arguments are assigned from left to right. However, if you define
optional parameters first, then the arguments are assigned from right to left. In addition, if all
the parameters in a function are optional, the assignment is also from right to left:

Example: Optional Parameter Assignment

```dataweave
%dw 2.0
output application/json
fun optionalParamsLast(param1, param2 = 2, param3 = 3) =
    { "param1": param1, "param2": param2, "param3": param3}
fun optionalParamsFirst(param1 = 1, param2 = 2, param3) =
    { "param1": param1, "param2": param2, "param3": param3}
fun allParametersOptional(param1 = 1, param2 = 2, param3 = 3) =
    { "param1": param1, "param2": param2, "param3": param3}
---
{
  "optionalParamsLast(A)":optionalParamsLast('A'),
  "optionalParamsLast(A, B)":optionalParamsLast('A', 'B'),
  "optionalParamsLast(A, B, C)":optionalParamsLast('A', 'B', 'C'),
  "optionalParamsFirst(A)":optionalParamsFirst('A'),
  "optionalParamsFirst(A, B)":optionalParamsFirst('A', 'B'),
  "optionalParamsFirst(A, B, C)":optionalParamsFirst('A', 'B', 'C'),
  "allParametersOptional(A)":allParametersOptional('A'),
  "allParametersOptional(A, B)":allParametersOptional('A', 'B'),
  "allParametersOptional(A, B, C)":allParametersOptional('A', 'B', 'C')
}
```

Output

{ "optionalParamsLast(A)": { "param1": "A", "param2": 2, "param3": 3 }, "optionalParamsLast(A, B)":
{ "param1": "A", "param2": "B", "param3": 3 }, "optionalParamsLast(A, B, C)": { "param1": "A",
"param2": "B", "param3": "C" }, "optionalParamsFirst(A)": { "param1": 1, "param2": 2, "param3": "A"
}, "optionalParamsFirst(A, B)": { "param1": 1, "param2": "A", "param3": "B" },
"optionalParamsFirst(A, B, C)": { "param1": "A", "param2": "B", "param3": "C" },
"allParametersOptional(A)": { "param1": 1, "param2": 2, "param3": "A" }, "allParametersOptional(A,
B)": { "param1": 1, "param2": "A", "param3": "B" }, "allParametersOptional(A, B, C)": { "param1":
"A", "param2": "B", "param3": "C" } }

## Function Overloading

DataWeave enables you to create multiple functions with the same name but different parameters. This
feature is useful for defining different behaviors based on the arguments of a function call.

Parameters in overloaded functions differ in number or type. To understand more about defining type
constraints on function parameters, see [Type System](https://docs.mulesoft.com/dataweave/2.4/dataweave-type-system).

DataWeave uses the first function it finds that accepts the arguments of the function call, based on
the order in which the functions are declared in the script.

Example: Function that Uses Function Overloading

```dataweave
%dw 2.0
output application/json

fun toUpper(a: String) = upper(a)
fun toUpper(a: Any) = null
fun toUpper(a: String, b: Number) = upper(a) ++ b as String
---
toUpper("hi!")
```

The argument of the function call `toUpper("hi!")` matches the types String and Any, so it is
possible to call the function with the first two definitions. However, DataWeave executes the
function `fun toUpper(a: String) = upper(a)` because that function is defined before the one that
uses the type Any.

Output of toUpper("hi!")

"HI!"

Output of toUpper(true)

null

Output of toUpper("age: ", 26)

"AGE: 26"

## See Also

[Create Custom Modules and Mappings](https://docs.mulesoft.com/dataweave/2.4/dataweave-create-module)

[DataWeave Reference](https://docs.mulesoft.com/dataweave/2.4/dw-functions)

<!-- document id=5132ef9ed5b30047fa3c63c3027c794b61e3d198a525fa1723948a10ef31ba4a url=/mulesoft/current/en-us/dataweave/2.6/dataweave-functions.md -->

---
product: DataWeave
version: 2.6
---

# Define DataWeave Functions

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You can define your own DataWeave functions using the `fun` declaration in the header of a DataWeave
script.

## DataWeave Function Definition Syntax

To define a function in DataWeave use the following syntax:

fun myFunction(param1, param2, ...) = <code to execute>

- The `fun` keyword starts the definition of a function.

- `myFunction` is the name you define for the function.

  Function names must be valid identifiers. For additional details about valid identifiers, see
  [Rules for Declaring Valid Identifiers](https://docs.mulesoft.com/dataweave/2.6/dataweave-language-introduction#valid-identifiers).

- `(param1, param2, …​ , paramn)` represents the parameters that your function accepts.

  You can specify from zero to any number of parameters, separated by commas (`,`) and enclosed in
  parentheses.

- The `=` sign marks the beginning of the code block to execute when the function is called.

- `<code to execute>` represents the actual code that you define for your function.

## Example Function Definitions

The following example defines a DataWeave function that accepts a single string argument, calls the
`upper` function using the received string argument, and then outputs the result:

Example: Simple Function Definition

```dataweave
%dw 2.0
output application/json
fun toUpper(aString) = upper(aString)
---
toUpper("hello")
```

Output

"HELLO"

The next example shows how the argument to a DataWeave function can be any DataWeave expression:

Example: Using Expressions as Arguments

```dataweave
%dw 2.0
output application/json
fun toUpper(aString) = upper(aString)
---
toUpper("h" ++ "el" ++ lower("LO") )
```

Output

"HELLO"

The following example tests the type of the argument passed to the function by performing
[pattern matching](https://docs.mulesoft.com/dataweave/2.6/dataweave-pattern-matching) with the built-in `match` operation:

Example: Function that Uses Pattern Matching

```dataweave
%dw 2.0
output application/json
fun toUpper(aString)
= aString match {
  case is String -> upper(aString)
  else -> null
}
---
toUpper("h" ++ "el" ++ lower("LO") )
```

Output

"HELLO"

This example creates a function that reformats a numeric string into a common phone number format:

Example: toPhoneFormat() Function

```dataweave
%dw 2.0
output application/json
fun toPhoneFormat(str: String) =
    "(" ++ str[0 to 2] ++ ") " ++ str[3 to 5] ++ "-" ++ str[6 to 9]
---
toPhoneFormat("1234567890")
```

Output

"(123) 456-7890"

## Type Constraint Definition

You can define type constraint expressions when you declare functions to ensure that the arguments
for a function call respect the defined type constraint.

To define type constraints for functions, use the following syntax:

fun myFunction(param1: Type, param2: Type): ResultType = <code to execute>

Example: Function with Type Constraints

%dw 2.0 output application/json fun toUser(id: Number, userName: String): String = "you called the
function toUser!"

In this example, the type constraints define that the function `toUser` accepts only a first
argument of type `Number` and a second argument of type `String`.

Also, the function specifies a constraint for the result to be of type `String`. This return type
constraint does not affect the function call; rather, this constraint applies to the function code
to validate that the function generates a result of the defined type.

You can find more details about the DataWeave type system in
[https://docs.mulesoft.com/dataweave/latest/dataweave-type-system](https://docs.mulesoft.com/dataweave/latest/dataweave-type-system).

## Optional Parameters Definition

You can define optional parameters by assigning a default value to them. The following example shows
a function that defines one parameter that is mandatory (`name`) and a second parameter that is
optional (`countryCode`) and has a default value:

Example: Function with Optional Parameters

```dataweave
%dw 2.0
output application/json
fun createUserData(name, countryCode = "US") = { "User name" : name, "Location": countryCode}
---
[createUserData("Cristian", "AR"), createUserData("Max The Mule")]
```

Output

\[ { "User name": "Cristian", "Location": "AR" }, { "User name": "Max The Mule", "Location": "US" }
\]

### Optional Parameter Order

DataWeave enables you to define optional parameters at the beginning or at the end of the parameter
definition:

Example: Functions with Optional Parameters

```dataweave
%dw 2.0
output application/json
fun optionalParamsLast(a, b = 2, c = 3)
fun optionalParamsFirst(a = 1, b = 2, c)
```

When you call a function, the arguments are assigned from left to right. However, if you define
optional parameters first, then the arguments are assigned from right to left. In addition, if all
the parameters in a function are optional, the assignment is also from right to left:

Example: Optional Parameter Assignment

```dataweave
%dw 2.0
output application/json
fun optionalParamsLast(param1, param2 = 2, param3 = 3) =
    { "param1": param1, "param2": param2, "param3": param3}
fun optionalParamsFirst(param1 = 1, param2 = 2, param3) =
    { "param1": param1, "param2": param2, "param3": param3}
fun allParametersOptional(param1 = 1, param2 = 2, param3 = 3) =
    { "param1": param1, "param2": param2, "param3": param3}
---
{
  "optionalParamsLast(A)":optionalParamsLast('A'),
  "optionalParamsLast(A, B)":optionalParamsLast('A', 'B'),
  "optionalParamsLast(A, B, C)":optionalParamsLast('A', 'B', 'C'),
  "optionalParamsFirst(A)":optionalParamsFirst('A'),
  "optionalParamsFirst(A, B)":optionalParamsFirst('A', 'B'),
  "optionalParamsFirst(A, B, C)":optionalParamsFirst('A', 'B', 'C'),
  "allParametersOptional(A)":allParametersOptional('A'),
  "allParametersOptional(A, B)":allParametersOptional('A', 'B'),
  "allParametersOptional(A, B, C)":allParametersOptional('A', 'B', 'C')
}
```

Output

{ "optionalParamsLast(A)": { "param1": "A", "param2": 2, "param3": 3 }, "optionalParamsLast(A, B)":
{ "param1": "A", "param2": "B", "param3": 3 }, "optionalParamsLast(A, B, C)": { "param1": "A",
"param2": "B", "param3": "C" }, "optionalParamsFirst(A)": { "param1": 1, "param2": 2, "param3": "A"
}, "optionalParamsFirst(A, B)": { "param1": 1, "param2": "A", "param3": "B" },
"optionalParamsFirst(A, B, C)": { "param1": "A", "param2": "B", "param3": "C" },
"allParametersOptional(A)": { "param1": 1, "param2": 2, "param3": "A" }, "allParametersOptional(A,
B)": { "param1": 1, "param2": "A", "param3": "B" }, "allParametersOptional(A, B, C)": { "param1":
"A", "param2": "B", "param3": "C" } }

## Type Parameters Definition

DataWeave function definitions support the use of type parameters, which are similar to generics in
some programming languages.

Example: Function that Uses Type Parameters

```dataweace
%dw 2.0
output application/json

fun toArray<T>(x: T): Array<T> = [x]
---
toArray(2)
```

DataWeave also supports adding type parameter constraints, which limit accepted inputs for a
function.

Example Function that Uses Type Parameters with Constraints

```dataweace
%dw 2.0
output application/json

fun getName<T <: { name: String }>(x: T): String = x.name
---
{
  name: getName({ name: "Andrés" })
  //name: getName({ age: 20 }) invalid call as the parameter does not fullfill the constraint
}
```

## Function Overloading

DataWeave enables you to create multiple functions with the same name but different parameters. This
feature is useful for defining different behaviors based on the arguments of a function call.

Parameters in overloaded functions differ in number or type. To understand more about defining type
constraints on function parameters, see [Type System](https://docs.mulesoft.com/dataweave/2.6/dataweave-type-system).

DataWeave uses the first function it finds that accepts the arguments of the function call, based on
the order in which the functions are declared in the script.

Example: Function that Uses Function Overloading

```dataweave
%dw 2.0
output application/json

fun toUpper(a: String) = upper(a)
fun toUpper(a: Any) = null
fun toUpper(a: String, b: Number) = upper(a) ++ b as String
---
toUpper("hi!")
```

The argument of the function call `toUpper("hi!")` matches the types String and Any, so it is
possible to call the function with the first two definitions. However, DataWeave executes the
function `fun toUpper(a: String) = upper(a)` because that function is defined before the one that
uses the type Any.

Output of toUpper("hi!")

"HI!"

Output of toUpper(true)

null

Output of toUpper("age: ", 26)

"AGE: 26"

## See Also

[Create Custom Modules and Mappings](https://docs.mulesoft.com/dataweave/2.6/dataweave-create-module)

[DataWeave Reference](https://docs.mulesoft.com/dataweave/2.6/dw-functions)

<!-- document id=3788e5cb2eee9e2a523c230ee3ccb6d752cd131bf4a1d5ad4025a2b101f1d457 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-functions.md -->

---
product: DataWeave
version: 2.9
---

# Define DataWeave Functions

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You can define your own DataWeave functions using the `fun` declaration in the header of a DataWeave
script.

## DataWeave Function Definition Syntax

To define a function in DataWeave use the following syntax:

fun myFunction(param1, param2, ...) = <code to execute>

- The `fun` keyword starts the definition of a function.

- `myFunction` is the name you define for the function.

  Function names must be valid identifiers. For additional details about valid identifiers, see
  [Rules for Declaring Valid Identifiers](https://docs.mulesoft.com/dataweave/2.9/dataweave-language-introduction#valid-identifiers).

- `(param1, param2, …​ , paramn)` represents the parameters that your function accepts.

  You can specify from zero to any number of parameters, separated by commas (`,`) and enclosed in
  parentheses.

- The `=` sign marks the beginning of the code block to execute when the function is called.

- `<code to execute>` represents the actual code that you define for your function.

## Example Function Definitions

The following example defines a DataWeave function that accepts a single string argument, calls the
`upper` function using the received string argument, and then outputs the result:

Example: Simple Function Definition

```dataweave
%dw 2.0
output application/json
fun toUpper(aString) = upper(aString)
---
toUpper("hello")
```

Output

"HELLO"

The next example shows how the argument to a DataWeave function can be any DataWeave expression:

Example: Using Expressions as Arguments

```dataweave
%dw 2.0
output application/json
fun toUpper(aString) = upper(aString)
---
toUpper("h" ++ "el" ++ lower("LO") )
```

Output

"HELLO"

The following example tests the type of the argument passed to the function by performing
[pattern matching](https://docs.mulesoft.com/dataweave/2.9/dataweave-pattern-matching) with the built-in `match` operation:

Example: Function that Uses Pattern Matching

```dataweave
%dw 2.0
output application/json
fun toUpper(aString)
= aString match {
  case is String -> upper(aString)
  else -> null
}
---
toUpper("h" ++ "el" ++ lower("LO") )
```

Output

"HELLO"

This example creates a function that reformats a numeric string into a common phone number format:

Example: toPhoneFormat() Function

```dataweave
%dw 2.0
output application/json
fun toPhoneFormat(str: String) =
    "(" ++ str[0 to 2] ++ ") " ++ str[3 to 5] ++ "-" ++ str[6 to 9]
---
toPhoneFormat("1234567890")
```

Output

"(123) 456-7890"

## Type Constraint Definition

You can define type constraint expressions when you declare functions to ensure that the arguments
for a function call respect the defined type constraint.

To define type constraints for functions, use the following syntax:

fun myFunction(param1: Type, param2: Type): ResultType = <code to execute>

Example: Function with Type Constraints

%dw 2.0 output application/json fun toUser(id: Number, userName: String): String = "you called the
function toUser!"

In this example, the type constraints define that the function `toUser` accepts only a first
argument of type `Number` and a second argument of type `String`.

Also, the function specifies a constraint for the result to be of type `String`. This return type
constraint does not affect the function call; rather, this constraint applies to the function code
to validate that the function generates a result of the defined type.

You can find more details about the DataWeave type system in
[https://docs.mulesoft.com/dataweave/latest/dataweave-type-system](https://docs.mulesoft.com/dataweave/latest/dataweave-type-system).

## Optional Parameters Definition

You can define optional parameters by assigning a default value to them. The following example shows
a function that defines one parameter that is mandatory (`name`) and a second parameter that is
optional (`countryCode`) and has a default value:

Example: Function with Optional Parameters

```dataweave
%dw 2.0
output application/json
fun createUserData(name, countryCode = "US") = { "User name" : name, "Location": countryCode}
---
[createUserData("Cristian", "AR"), createUserData("Max The Mule")]
```

Output

\[ { "User name": "Cristian", "Location": "AR" }, { "User name": "Max The Mule", "Location": "US" }
\]

### Optional Parameter Order

DataWeave enables you to define optional parameters at the beginning or at the end of the parameter
definition:

Example: Functions with Optional Parameters

```dataweave
%dw 2.0
output application/json
fun optionalParamsLast(a, b = 2, c = 3)
fun optionalParamsFirst(a = 1, b = 2, c)
```

When you call a function, the arguments are assigned from left to right. However, if you define
optional parameters first, then the arguments are assigned from right to left. In addition, if all
the parameters in a function are optional, the assignment is also from right to left:

Example: Optional Parameter Assignment

```dataweave
%dw 2.0
output application/json
fun optionalParamsLast(param1, param2 = 2, param3 = 3) =
    { "param1": param1, "param2": param2, "param3": param3}
fun optionalParamsFirst(param1 = 1, param2 = 2, param3) =
    { "param1": param1, "param2": param2, "param3": param3}
fun allParametersOptional(param1 = 1, param2 = 2, param3 = 3) =
    { "param1": param1, "param2": param2, "param3": param3}
---
{
  "optionalParamsLast(A)":optionalParamsLast('A'),
  "optionalParamsLast(A, B)":optionalParamsLast('A', 'B'),
  "optionalParamsLast(A, B, C)":optionalParamsLast('A', 'B', 'C'),
  "optionalParamsFirst(A)":optionalParamsFirst('A'),
  "optionalParamsFirst(A, B)":optionalParamsFirst('A', 'B'),
  "optionalParamsFirst(A, B, C)":optionalParamsFirst('A', 'B', 'C'),
  "allParametersOptional(A)":allParametersOptional('A'),
  "allParametersOptional(A, B)":allParametersOptional('A', 'B'),
  "allParametersOptional(A, B, C)":allParametersOptional('A', 'B', 'C')
}
```

Output

{ "optionalParamsLast(A)": { "param1": "A", "param2": 2, "param3": 3 }, "optionalParamsLast(A, B)":
{ "param1": "A", "param2": "B", "param3": 3 }, "optionalParamsLast(A, B, C)": { "param1": "A",
"param2": "B", "param3": "C" }, "optionalParamsFirst(A)": { "param1": 1, "param2": 2, "param3": "A"
}, "optionalParamsFirst(A, B)": { "param1": 1, "param2": "A", "param3": "B" },
"optionalParamsFirst(A, B, C)": { "param1": "A", "param2": "B", "param3": "C" },
"allParametersOptional(A)": { "param1": 1, "param2": 2, "param3": "A" }, "allParametersOptional(A,
B)": { "param1": 1, "param2": "A", "param3": "B" }, "allParametersOptional(A, B, C)": { "param1":
"A", "param2": "B", "param3": "C" } }

## Type Parameters Definition

DataWeave function definitions support the use of type parameters, which are similar to generics in
some programming languages.

Example: Function that Uses Type Parameters

```dataweace
%dw 2.0
output application/json

fun toArray<T>(x: T): Array<T> = [x]
---
toArray(2)
```

DataWeave also supports adding type parameter constraints, which limit accepted inputs for a
function.

Example Function that Uses Type Parameters with Constraints

```dataweace
%dw 2.0
output application/json

fun getName<T <: { name: String }>(x: T): String = x.name
---
{
  name: getName({ name: "Andrés" })
  //name: getName({ age: 20 }) invalid call as the parameter does not fullfill the constraint
}
```

## Function Overloading

DataWeave enables you to create multiple functions with the same name but different parameters. This
feature is useful for defining different behaviors based on the arguments of a function call.

Parameters in overloaded functions differ in number or type. To understand more about defining type
constraints on function parameters, see [Type System](https://docs.mulesoft.com/dataweave/2.9/dataweave-type-system).

DataWeave uses the first function it finds that accepts the arguments of the function call, based on
the order in which the functions are declared in the script.

Example: Function that Uses Function Overloading

```dataweave
%dw 2.0
output application/json

fun toUpper(a: String) = upper(a)
fun toUpper(a: Any) = null
fun toUpper(a: String, b: Number) = upper(a) ++ b as String
---
toUpper("hi!")
```

The argument of the function call `toUpper("hi!")` matches the types String and Any, so it is
possible to call the function with the first two definitions. However, DataWeave executes the
function `fun toUpper(a: String) = upper(a)` because that function is defined before the one that
uses the type Any.

Output of toUpper("hi!")

"HI!"

Output of toUpper(true)

null

Output of toUpper("age: ", 26)

"AGE: 26"

## See Also

[Create Custom Modules and Mappings](https://docs.mulesoft.com/dataweave/2.9/dataweave-create-module)

[DataWeave Reference](https://docs.mulesoft.com/dataweave/2.9/dw-functions)

<!-- document id=5d6352d0b741a452121a9f58f057f0c506d88e706010d6589ffb4d41b82436c4 url=/mulesoft/current/en-us/dataweave/latest/dataweave-functions.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Define DataWeave Functions

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You can define your own DataWeave functions using the `fun` declaration in the header of a DataWeave
script.

## DataWeave Function Definition Syntax

To define a function in DataWeave use the following syntax:

fun myFunction(param1, param2, ...) = <code to execute>

- The `fun` keyword starts the definition of a function.

- `myFunction` is the name you define for the function.

  Function names must be valid identifiers. For additional details about valid identifiers, see
  [Rules for Declaring Valid Identifiers](https://docs.mulesoft.com/dataweave/latest/dataweave-language-introduction#valid-identifiers).

- `(param1, param2, …​ , paramn)` represents the parameters that your function accepts.

  You can specify from zero to any number of parameters, separated by commas (`,`) and enclosed in
  parentheses.

- The `=` sign marks the beginning of the code block to execute when the function is called.

- `<code to execute>` represents the actual code that you define for your function.

## Example Function Definitions

The following example defines a DataWeave function that accepts a single string argument, calls the
`upper` function using the received string argument, and then outputs the result:

Example: Simple Function Definition

```dataweave
%dw 2.0
output application/json
fun toUpper(aString) = upper(aString)
---
toUpper("hello")
```

Output

"HELLO"

The next example shows how the argument to a DataWeave function can be any DataWeave expression:

Example: Using Expressions as Arguments

```dataweave
%dw 2.0
output application/json
fun toUpper(aString) = upper(aString)
---
toUpper("h" ++ "el" ++ lower("LO") )
```

Output

"HELLO"

The following example tests the type of the argument passed to the function by performing
[pattern matching](https://docs.mulesoft.com/dataweave/latest/dataweave-pattern-matching) with the built-in `match` operation:

Example: Function that Uses Pattern Matching

```dataweave
%dw 2.0
output application/json
fun toUpper(aString)
= aString match {
  case is String -> upper(aString)
  else -> null
}
---
toUpper("h" ++ "el" ++ lower("LO") )
```

Output

"HELLO"

This example creates a function that reformats a numeric string into a common phone number format:

Example: toPhoneFormat() Function

```dataweave
%dw 2.0
output application/json
fun toPhoneFormat(str: String) =
    "(" ++ str[0 to 2] ++ ") " ++ str[3 to 5] ++ "-" ++ str[6 to 9]
---
toPhoneFormat("1234567890")
```

Output

"(123) 456-7890"

## Type Constraint Definition

You can define type constraint expressions when you declare functions to ensure that the arguments
for a function call respect the defined type constraint.

To define type constraints for functions, use the following syntax:

fun myFunction(param1: Type, param2: Type): ResultType = <code to execute>

Example: Function with Type Constraints

%dw 2.0 output application/json fun toUser(id: Number, userName: String): String = "you called the
function toUser!"

In this example, the type constraints define that the function `toUser` accepts only a first
argument of type `Number` and a second argument of type `String`.

Also, the function specifies a constraint for the result to be of type `String`. This return type
constraint does not affect the function call; rather, this constraint applies to the function code
to validate that the function generates a result of the defined type.

You can find more details about the DataWeave type system in
[https://docs.mulesoft.com/dataweave/latest/dataweave-type-system](https://docs.mulesoft.com/dataweave/latest/dataweave-type-system).

## Optional Parameters Definition

You can define optional parameters by assigning a default value to them. The following example shows
a function that defines one parameter that is mandatory (`name`) and a second parameter that is
optional (`countryCode`) and has a default value:

Example: Function with Optional Parameters

```dataweave
%dw 2.0
output application/json
fun createUserData(name, countryCode = "US") = { "User name" : name, "Location": countryCode}
---
[createUserData("Cristian", "AR"), createUserData("Max The Mule")]
```

Output

\[ { "User name": "Cristian", "Location": "AR" }, { "User name": "Max The Mule", "Location": "US" }
\]

### Optional Parameter Order

DataWeave enables you to define optional parameters at the beginning or at the end of the parameter
definition:

Example: Functions with Optional Parameters

```dataweave
%dw 2.0
output application/json
fun optionalParamsLast(a, b = 2, c = 3)
fun optionalParamsFirst(a = 1, b = 2, c)
```

When you call a function, the arguments are assigned from left to right. However, if you define
optional parameters first, then the arguments are assigned from right to left. In addition, if all
the parameters in a function are optional, the assignment is also from right to left:

Example: Optional Parameter Assignment

```dataweave
%dw 2.0
output application/json
fun optionalParamsLast(param1, param2 = 2, param3 = 3) =
    { "param1": param1, "param2": param2, "param3": param3}
fun optionalParamsFirst(param1 = 1, param2 = 2, param3) =
    { "param1": param1, "param2": param2, "param3": param3}
fun allParametersOptional(param1 = 1, param2 = 2, param3 = 3) =
    { "param1": param1, "param2": param2, "param3": param3}
---
{
  "optionalParamsLast(A)":optionalParamsLast('A'),
  "optionalParamsLast(A, B)":optionalParamsLast('A', 'B'),
  "optionalParamsLast(A, B, C)":optionalParamsLast('A', 'B', 'C'),
  "optionalParamsFirst(A)":optionalParamsFirst('A'),
  "optionalParamsFirst(A, B)":optionalParamsFirst('A', 'B'),
  "optionalParamsFirst(A, B, C)":optionalParamsFirst('A', 'B', 'C'),
  "allParametersOptional(A)":allParametersOptional('A'),
  "allParametersOptional(A, B)":allParametersOptional('A', 'B'),
  "allParametersOptional(A, B, C)":allParametersOptional('A', 'B', 'C')
}
```

Output

{ "optionalParamsLast(A)": { "param1": "A", "param2": 2, "param3": 3 }, "optionalParamsLast(A, B)":
{ "param1": "A", "param2": "B", "param3": 3 }, "optionalParamsLast(A, B, C)": { "param1": "A",
"param2": "B", "param3": "C" }, "optionalParamsFirst(A)": { "param1": 1, "param2": 2, "param3": "A"
}, "optionalParamsFirst(A, B)": { "param1": 1, "param2": "A", "param3": "B" },
"optionalParamsFirst(A, B, C)": { "param1": "A", "param2": "B", "param3": "C" },
"allParametersOptional(A)": { "param1": 1, "param2": 2, "param3": "A" }, "allParametersOptional(A,
B)": { "param1": 1, "param2": "A", "param3": "B" }, "allParametersOptional(A, B, C)": { "param1":
"A", "param2": "B", "param3": "C" } }

## Type Parameters Definition

DataWeave function definitions support the use of type parameters, which are similar to generics in
some programming languages.

Example: Function that Uses Type Parameters

```dataweace
%dw 2.0
output application/json

fun toArray<T>(x: T): Array<T> = [x]
---
toArray(2)
```

DataWeave also supports adding type parameter constraints, which limit accepted inputs for a
function.

Example Function that Uses Type Parameters with Constraints

```dataweace
%dw 2.0
output application/json

fun getName<T <: { name: String }>(x: T): String = x.name
---
{
  name: getName({ name: "Andrés" })
  //name: getName({ age: 20 }) invalid call as the parameter does not fullfill the constraint
}
```

## Function Overloading

DataWeave enables you to create multiple functions with the same name but different parameters. This
feature is useful for defining different behaviors based on the arguments of a function call.

Parameters in overloaded functions differ in number or type. To understand more about defining type
constraints on function parameters, see [Type System](https://docs.mulesoft.com/dataweave/latest/dataweave-type-system).

DataWeave uses the first function it finds that accepts the arguments of the function call, based on
the order in which the functions are declared in the script.

Example: Function that Uses Function Overloading

```dataweave
%dw 2.0
output application/json

fun toUpper(a: String) = upper(a)
fun toUpper(a: Any) = null
fun toUpper(a: String, b: Number) = upper(a) ++ b as String
---
toUpper("hi!")
```

The argument of the function call `toUpper("hi!")` matches the types String and Any, so it is
possible to call the function with the first two definitions. However, DataWeave executes the
function `fun toUpper(a: String) = upper(a)` because that function is defined before the one that
uses the type Any.

Output of toUpper("hi!")

"HI!"

Output of toUpper(true)

null

Output of toUpper("age: ", 26)

"AGE: 26"

## See Also

[Create Custom Modules and Mappings](https://docs.mulesoft.com/dataweave/latest/dataweave-create-module)

[DataWeave Reference](https://docs.mulesoft.com/dataweave/latest/dw-functions)

<!-- document id=f61b62dc235ca40ce480315a8253d07bca7665874eb18747184fb66a42649c20 url=/mulesoft/current/en-us/dataweave/2.11/dw-diff-functions-diff.md -->

---
product: DataWeave
version: 2.11
---

# diff

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## diff(actual: Any, expected: Any, diffConfig: { unordered?: Boolean } = {}, path: String = "(root)"): Diff

Returns the structural differences between two values.

Differences between objects can be ordered (the default) or unordered. Ordered means that two
objects do not differ if their key-value pairs are in the same order. Differences are expressed as
`Difference` type.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>actual</code></p></td><td><p>The actual value. Can be any data type.</p></td></tr><tr><td><p><code>expected</code></p></td><td><p>The expected value to compare to the actual. Can be any data type.</p></td></tr><tr><td><p><code>diffConfig</code></p></td><td><p>Setting for changing the default to unordered using `{ "unordered" : true} (explained in the introduction).</p></td></tr></tbody></table>

### Example

This example shows a variety of uses of `diff`.

#### Source

```Dataweave
import diff from dw::util::Diff
ns ns0 http://locahost.com
ns ns1 http://acme.com
output application/dw
---
{
  "a": diff({a: 1}, {b:1}),
  "b": diff({ns0#a: 1}, {ns1#a:1}),
  "c": diff([1,2,3], []),
  "d": diff([], [1,2,3]),
  "e": diff([1,2,3], [1,2,3, 4]),
  "f": diff([{a: 1}], [{a: 2}]),
  "g": diff({a @(c: 2): 1}, {a @(c: 3): 1}),
  "h": diff(true, false),
  "i": diff(1, 2),
  "j": diff("test", "other test"),
  "k": diff({a: 1}, {a:1}),
  "l": diff({ns0#a: 1}, {ns0#a:1}),
  "m": diff([1,2,3], [1,2,3]),
  "n": diff([], []),
  "o": diff([{a: 1}], [{a: 1}]),
  "p": diff({a @(c: 2): 1}, {a @(c:2): 1}),
  "q": diff(true, true),
  "r": diff(1, 1),
  "s": diff("other test", "other test"),
  "t": diff({a:1 ,b: 2},{b: 2, a:1}, {unordered: true}),
  "u": [{format: "ssn",data: "ABC"}] diff [{ format: "ssn",data: "ABC"}]
}
```

#### Output

```XML
ns ns0 http://locahost.com
ns ns1 http://acme.com
---
{
  a: {
    matches: false,
    diffs: [
      {
        expected: "Entry (root).a with type Number",
        actual: "was not present in object.",
        path: "(root).a"
      }
    ]
  },
  b: {
    matches: false,
    diffs: [
      {
        expected: "Entry (root).ns0#a with type Number",
        actual: "was not present in object.",
        path: "(root).ns0#a"
      }
    ]
  },
  c: {
    matches: false,
    diffs: [
      {
        expected: "Array size is 0",
        actual: "was 3",
        path: "(root)"
      }
    ]
  },
  d: {
    matches: false,
    diffs: [
      {
        expected: "Array size is 3",
        actual: "was 0",
        path: "(root)"
      }
    ]
  },
  e: {
    matches: false,
    diffs: [
      {
        expected: "Array size is 4",
        actual: "was 3",
        path: "(root)"
      }
    ]
  },
  f: {
    matches: false,
    diffs: [
      {
        expected: "1" as String {mimeType: "application/dw"},
        actual: "2" as String {mimeType: "application/dw"},
        path: "(root)[0].a"
      }
    ]
  },
  g: {
    matches: false,
    diffs: [
      {
        expected: "3" as String {mimeType: "application/dw"},
        actual: "2" as String {mimeType: "application/dw"},
        path: "(root).a.@.c"
      }
    ]
  },
  h: {
    matches: false,
    diffs: [
      {
        expected: "false",
        actual: "true",
        path: "(root)"
      }
    ]
  },
  i: {
    matches: false,
    diffs: [
      {
        expected: "2",
        actual: "1",
        path: "(root)"
      }
    ]
  },
  j: {
    matches: false,
    diffs: [
      {
        expected: "\"other test\"",
        actual: "\"test\"",
        path: "(root)"
      }
    ]
  },
  k: {
    matches: true,
    diffs: []
  },
  l: {
    matches: true,
    diffs: []
  },
  m: {
    matches: true,
    diffs: []
  },
  n: {
    matches: true,
    diffs: []
  },
  o: {
    matches: true,
    diffs: []
  },
  p: {
    matches: true,
    diffs: []
  },
  q: {
    matches: true,
    diffs: []
  },
  r: {
    matches: true,
    diffs: []
  },
  s: {
    matches: true,
    diffs: []
  },
  t: {
    matches: true,
    diffs: []
  },
  u: {
    matches: true,
    diffs: []
  }
}
```

<!-- document id=ca62e63ef9694eb00982f1dd92983ff4dac3c3e12bf9f59ad6869119f2a3f8fa url=/mulesoft/current/en-us/dataweave/2.12/dw-diff-functions-diff.md -->

---
product: DataWeave
version: 2.12
---

# diff

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## diff(actual: Any, expected: Any, diffConfig: { unordered?: Boolean } = {}, path: String = "(root)"): Diff

Returns the structural differences between two values.

Differences between objects can be ordered (the default) or unordered. Ordered means that two
objects do not differ if their key-value pairs are in the same order. Differences are expressed as
`Difference` type.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>actual</code></p></td><td><p>The actual value. Can be any data type.</p></td></tr><tr><td><p><code>expected</code></p></td><td><p>The expected value to compare to the actual. Can be any data type.</p></td></tr><tr><td><p><code>diffConfig</code></p></td><td><p>Setting for changing the default to unordered using `{ "unordered" : true} (explained in the introduction).</p></td></tr></tbody></table>

### Example

This example shows a variety of uses of `diff`.

#### Source

```Dataweave
import diff from dw::util::Diff
ns ns0 http://locahost.com
ns ns1 http://acme.com
output application/dw
---
{
  "a": diff({a: 1}, {b:1}),
  "b": diff({ns0#a: 1}, {ns1#a:1}),
  "c": diff([1,2,3], []),
  "d": diff([], [1,2,3]),
  "e": diff([1,2,3], [1,2,3, 4]),
  "f": diff([{a: 1}], [{a: 2}]),
  "g": diff({a @(c: 2): 1}, {a @(c: 3): 1}),
  "h": diff(true, false),
  "i": diff(1, 2),
  "j": diff("test", "other test"),
  "k": diff({a: 1}, {a:1}),
  "l": diff({ns0#a: 1}, {ns0#a:1}),
  "m": diff([1,2,3], [1,2,3]),
  "n": diff([], []),
  "o": diff([{a: 1}], [{a: 1}]),
  "p": diff({a @(c: 2): 1}, {a @(c:2): 1}),
  "q": diff(true, true),
  "r": diff(1, 1),
  "s": diff("other test", "other test"),
  "t": diff({a:1 ,b: 2},{b: 2, a:1}, {unordered: true}),
  "u": [{format: "ssn",data: "ABC"}] diff [{ format: "ssn",data: "ABC"}]
}
```

#### Output

```XML
ns ns0 http://locahost.com
ns ns1 http://acme.com
---
{
  a: {
    matches: false,
    diffs: [
      {
        expected: "Entry (root).a with type Number",
        actual: "was not present in object.",
        path: "(root).a"
      }
    ]
  },
  b: {
    matches: false,
    diffs: [
      {
        expected: "Entry (root).ns0#a with type Number",
        actual: "was not present in object.",
        path: "(root).ns0#a"
      }
    ]
  },
  c: {
    matches: false,
    diffs: [
      {
        expected: "Array size is 0",
        actual: "was 3",
        path: "(root)"
      }
    ]
  },
  d: {
    matches: false,
    diffs: [
      {
        expected: "Array size is 3",
        actual: "was 0",
        path: "(root)"
      }
    ]
  },
  e: {
    matches: false,
    diffs: [
      {
        expected: "Array size is 4",
        actual: "was 3",
        path: "(root)"
      }
    ]
  },
  f: {
    matches: false,
    diffs: [
      {
        expected: "1" as String {mimeType: "application/dw"},
        actual: "2" as String {mimeType: "application/dw"},
        path: "(root)[0].a"
      }
    ]
  },
  g: {
    matches: false,
    diffs: [
      {
        expected: "3" as String {mimeType: "application/dw"},
        actual: "2" as String {mimeType: "application/dw"},
        path: "(root).a.@.c"
      }
    ]
  },
  h: {
    matches: false,
    diffs: [
      {
        expected: "false",
        actual: "true",
        path: "(root)"
      }
    ]
  },
  i: {
    matches: false,
    diffs: [
      {
        expected: "2",
        actual: "1",
        path: "(root)"
      }
    ]
  },
  j: {
    matches: false,
    diffs: [
      {
        expected: "\"other test\"",
        actual: "\"test\"",
        path: "(root)"
      }
    ]
  },
  k: {
    matches: true,
    diffs: []
  },
  l: {
    matches: true,
    diffs: []
  },
  m: {
    matches: true,
    diffs: []
  },
  n: {
    matches: true,
    diffs: []
  },
  o: {
    matches: true,
    diffs: []
  },
  p: {
    matches: true,
    diffs: []
  },
  q: {
    matches: true,
    diffs: []
  },
  r: {
    matches: true,
    diffs: []
  },
  s: {
    matches: true,
    diffs: []
  },
  t: {
    matches: true,
    diffs: []
  },
  u: {
    matches: true,
    diffs: []
  }
}
```

<!-- document id=7789209c8d72123f6fdc8a30c41a814832f2939c418e1a12d965aabf8575d197 url=/mulesoft/current/en-us/dataweave/2.3/dw-diff-functions-diff.md -->

---
product: DataWeave
version: 2.3
---

# diff

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## diff(Any, Any, { unordered?: Boolean }, String): Diff

Returns the structural differences between two values.

Differences between objects can be ordered (the default) or unordered. Ordered means that two
objects do not differ if their key-value pairs are in the same order. Differences are expressed as
`Difference` type.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>actual</code></p></td><td><p>The actual value. Can be any data type.</p></td></tr><tr><td><p><code>expected</code></p></td><td><p>The expected value to compare to the actual. Can be any data type.</p></td></tr><tr><td><p><code>diffConfig</code></p></td><td><p>Setting for changing the default to unordered using `{ "unordered" : true} (explained in the introduction).</p></td></tr></tbody></table>

### Example

This example shows a variety of uses of `diff`.

#### Source

```Dataweave
import diff from dw::util::Diff
ns ns0 http://locahost.com
ns ns1 http://acme.com
output application/dw
---
{
  "a": diff({a: 1}, {b:1}),
  "b": diff({ns0#a: 1}, {ns1#a:1}),
  "c": diff([1,2,3], []),
  "d": diff([], [1,2,3]),
  "e": diff([1,2,3], [1,2,3, 4]),
  "f": diff([{a: 1}], [{a: 2}]),
  "g": diff({a @(c: 2): 1}, {a @(c: 3): 1}),
  "h": diff(true, false),
  "i": diff(1, 2),
  "j": diff("test", "other test"),
  "k": diff({a: 1}, {a:1}),
  "l": diff({ns0#a: 1}, {ns0#a:1}),
  "m": diff([1,2,3], [1,2,3]),
  "n": diff([], []),
  "o": diff([{a: 1}], [{a: 1}]),
  "p": diff({a @(c: 2): 1}, {a @(c:2): 1}),
  "q": diff(true, true),
  "r": diff(1, 1),
  "s": diff("other test", "other test"),
  "t": diff({a:1 ,b: 2},{b: 2, a:1}, {unordered: true}),
  "u": [{format: "ssn",data: "ABC"}] diff [{ format: "ssn",data: "ABC"}]
}
```

#### Output

```XML
ns ns0 http://locahost.com
ns ns1 http://acme.com
---
{
  a: {
    matches: false,
    diffs: [
      {
        expected: "Entry (root).a with type Number",
        actual: "was not present in object.",
        path: "(root).a"
      }
    ]
  },
  b: {
    matches: false,
    diffs: [
      {
        expected: "Entry (root).ns0#a with type Number",
        actual: "was not present in object.",
        path: "(root).ns0#a"
      }
    ]
  },
  c: {
    matches: false,
    diffs: [
      {
        expected: "Array size is 0",
        actual: "was 3",
        path: "(root)"
      }
    ]
  },
  d: {
    matches: false,
    diffs: [
      {
        expected: "Array size is 3",
        actual: "was 0",
        path: "(root)"
      }
    ]
  },
  e: {
    matches: false,
    diffs: [
      {
        expected: "Array size is 4",
        actual: "was 3",
        path: "(root)"
      }
    ]
  },
  f: {
    matches: false,
    diffs: [
      {
        expected: "1" as String {mimeType: "application/dw"},
        actual: "2" as String {mimeType: "application/dw"},
        path: "(root)[0].a"
      }
    ]
  },
  g: {
    matches: false,
    diffs: [
      {
        expected: "3" as String {mimeType: "application/dw"},
        actual: "2" as String {mimeType: "application/dw"},
        path: "(root).a.@.c"
      }
    ]
  },
  h: {
    matches: false,
    diffs: [
      {
        expected: "false",
        actual: "true",
        path: "(root)"
      }
    ]
  },
  i: {
    matches: false,
    diffs: [
      {
        expected: "2",
        actual: "1",
        path: "(root)"
      }
    ]
  },
  j: {
    matches: false,
    diffs: [
      {
        expected: "\"other test\"",
        actual: "\"test\"",
        path: "(root)"
      }
    ]
  },
  k: {
    matches: true,
    diffs: []
  },
  l: {
    matches: true,
    diffs: []
  },
  m: {
    matches: true,
    diffs: []
  },
  n: {
    matches: true,
    diffs: []
  },
  o: {
    matches: true,
    diffs: []
  },
  p: {
    matches: true,
    diffs: []
  },
  q: {
    matches: true,
    diffs: []
  },
  r: {
    matches: true,
    diffs: []
  },
  s: {
    matches: true,
    diffs: []
  },
  t: {
    matches: true,
    diffs: []
  },
  u: {
    matches: true,
    diffs: []
  }
}
```

<!-- document id=0f4c00eee72e35f222da69f4da80c0e02a9a4630bc408ca9de9101dada3b5dfb url=/mulesoft/current/en-us/dataweave/2.4/dw-diff-functions-diff.md -->

---
product: DataWeave
version: 2.4
---

# diff

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## diff(actual: Any, expected: Any, diffConfig: { unordered?: Boolean } = {}, path: String = "(root)"): Diff

Returns the structural differences between two values.

Differences between objects can be ordered (the default) or unordered. Ordered means that two
objects do not differ if their key-value pairs are in the same order. Differences are expressed as
`Difference` type.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>actual</code></p></td><td><p>The actual value. Can be any data type.</p></td></tr><tr><td><p><code>expected</code></p></td><td><p>The expected value to compare to the actual. Can be any data type.</p></td></tr><tr><td><p><code>diffConfig</code></p></td><td><p>Setting for changing the default to unordered using `{ "unordered" : true} (explained in the introduction).</p></td></tr></tbody></table>

### Example

This example shows a variety of uses of `diff`.

#### Source

```Dataweave
import diff from dw::util::Diff
ns ns0 http://locahost.com
ns ns1 http://acme.com
output application/dw
---
{
  "a": diff({a: 1}, {b:1}),
  "b": diff({ns0#a: 1}, {ns1#a:1}),
  "c": diff([1,2,3], []),
  "d": diff([], [1,2,3]),
  "e": diff([1,2,3], [1,2,3, 4]),
  "f": diff([{a: 1}], [{a: 2}]),
  "g": diff({a @(c: 2): 1}, {a @(c: 3): 1}),
  "h": diff(true, false),
  "i": diff(1, 2),
  "j": diff("test", "other test"),
  "k": diff({a: 1}, {a:1}),
  "l": diff({ns0#a: 1}, {ns0#a:1}),
  "m": diff([1,2,3], [1,2,3]),
  "n": diff([], []),
  "o": diff([{a: 1}], [{a: 1}]),
  "p": diff({a @(c: 2): 1}, {a @(c:2): 1}),
  "q": diff(true, true),
  "r": diff(1, 1),
  "s": diff("other test", "other test"),
  "t": diff({a:1 ,b: 2},{b: 2, a:1}, {unordered: true}),
  "u": [{format: "ssn",data: "ABC"}] diff [{ format: "ssn",data: "ABC"}]
}
```

#### Output

```XML
ns ns0 http://locahost.com
ns ns1 http://acme.com
---
{
  a: {
    matches: false,
    diffs: [
      {
        expected: "Entry (root).a with type Number",
        actual: "was not present in object.",
        path: "(root).a"
      }
    ]
  },
  b: {
    matches: false,
    diffs: [
      {
        expected: "Entry (root).ns0#a with type Number",
        actual: "was not present in object.",
        path: "(root).ns0#a"
      }
    ]
  },
  c: {
    matches: false,
    diffs: [
      {
        expected: "Array size is 0",
        actual: "was 3",
        path: "(root)"
      }
    ]
  },
  d: {
    matches: false,
    diffs: [
      {
        expected: "Array size is 3",
        actual: "was 0",
        path: "(root)"
      }
    ]
  },
  e: {
    matches: false,
    diffs: [
      {
        expected: "Array size is 4",
        actual: "was 3",
        path: "(root)"
      }
    ]
  },
  f: {
    matches: false,
    diffs: [
      {
        expected: "1" as String {mimeType: "application/dw"},
        actual: "2" as String {mimeType: "application/dw"},
        path: "(root)[0].a"
      }
    ]
  },
  g: {
    matches: false,
    diffs: [
      {
        expected: "3" as String {mimeType: "application/dw"},
        actual: "2" as String {mimeType: "application/dw"},
        path: "(root).a.@.c"
      }
    ]
  },
  h: {
    matches: false,
    diffs: [
      {
        expected: "false",
        actual: "true",
        path: "(root)"
      }
    ]
  },
  i: {
    matches: false,
    diffs: [
      {
        expected: "2",
        actual: "1",
        path: "(root)"
      }
    ]
  },
  j: {
    matches: false,
    diffs: [
      {
        expected: "\"other test\"",
        actual: "\"test\"",
        path: "(root)"
      }
    ]
  },
  k: {
    matches: true,
    diffs: []
  },
  l: {
    matches: true,
    diffs: []
  },
  m: {
    matches: true,
    diffs: []
  },
  n: {
    matches: true,
    diffs: []
  },
  o: {
    matches: true,
    diffs: []
  },
  p: {
    matches: true,
    diffs: []
  },
  q: {
    matches: true,
    diffs: []
  },
  r: {
    matches: true,
    diffs: []
  },
  s: {
    matches: true,
    diffs: []
  },
  t: {
    matches: true,
    diffs: []
  },
  u: {
    matches: true,
    diffs: []
  }
}
```

<!-- document id=c88192e652b4dd72d70ab15b757c8bed0c948a0ae846854dc3ea3d7f878d4ef8 url=/mulesoft/current/en-us/dataweave/2.6/dw-diff-functions-diff.md -->

---
product: DataWeave
version: 2.6
---

# diff

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## diff(actual: Any, expected: Any, diffConfig: { unordered?: Boolean } = {}, path: String = "(root)"): Diff

Returns the structural differences between two values.

Differences between objects can be ordered (the default) or unordered. Ordered means that two
objects do not differ if their key-value pairs are in the same order. Differences are expressed as
`Difference` type.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>actual</code></p></td><td><p>The actual value. Can be any data type.</p></td></tr><tr><td><p><code>expected</code></p></td><td><p>The expected value to compare to the actual. Can be any data type.</p></td></tr><tr><td><p><code>diffConfig</code></p></td><td><p>Setting for changing the default to unordered using `{ "unordered" : true} (explained in the introduction).</p></td></tr></tbody></table>

### Example

This example shows a variety of uses of `diff`.

#### Source

```Dataweave
import diff from dw::util::Diff
ns ns0 http://locahost.com
ns ns1 http://acme.com
output application/dw
---
{
  "a": diff({a: 1}, {b:1}),
  "b": diff({ns0#a: 1}, {ns1#a:1}),
  "c": diff([1,2,3], []),
  "d": diff([], [1,2,3]),
  "e": diff([1,2,3], [1,2,3, 4]),
  "f": diff([{a: 1}], [{a: 2}]),
  "g": diff({a @(c: 2): 1}, {a @(c: 3): 1}),
  "h": diff(true, false),
  "i": diff(1, 2),
  "j": diff("test", "other test"),
  "k": diff({a: 1}, {a:1}),
  "l": diff({ns0#a: 1}, {ns0#a:1}),
  "m": diff([1,2,3], [1,2,3]),
  "n": diff([], []),
  "o": diff([{a: 1}], [{a: 1}]),
  "p": diff({a @(c: 2): 1}, {a @(c:2): 1}),
  "q": diff(true, true),
  "r": diff(1, 1),
  "s": diff("other test", "other test"),
  "t": diff({a:1 ,b: 2},{b: 2, a:1}, {unordered: true}),
  "u": [{format: "ssn",data: "ABC"}] diff [{ format: "ssn",data: "ABC"}]
}
```

#### Output

```XML
ns ns0 http://locahost.com
ns ns1 http://acme.com
---
{
  a: {
    matches: false,
    diffs: [
      {
        expected: "Entry (root).a with type Number",
        actual: "was not present in object.",
        path: "(root).a"
      }
    ]
  },
  b: {
    matches: false,
    diffs: [
      {
        expected: "Entry (root).ns0#a with type Number",
        actual: "was not present in object.",
        path: "(root).ns0#a"
      }
    ]
  },
  c: {
    matches: false,
    diffs: [
      {
        expected: "Array size is 0",
        actual: "was 3",
        path: "(root)"
      }
    ]
  },
  d: {
    matches: false,
    diffs: [
      {
        expected: "Array size is 3",
        actual: "was 0",
        path: "(root)"
      }
    ]
  },
  e: {
    matches: false,
    diffs: [
      {
        expected: "Array size is 4",
        actual: "was 3",
        path: "(root)"
      }
    ]
  },
  f: {
    matches: false,
    diffs: [
      {
        expected: "1" as String {mimeType: "application/dw"},
        actual: "2" as String {mimeType: "application/dw"},
        path: "(root)[0].a"
      }
    ]
  },
  g: {
    matches: false,
    diffs: [
      {
        expected: "3" as String {mimeType: "application/dw"},
        actual: "2" as String {mimeType: "application/dw"},
        path: "(root).a.@.c"
      }
    ]
  },
  h: {
    matches: false,
    diffs: [
      {
        expected: "false",
        actual: "true",
        path: "(root)"
      }
    ]
  },
  i: {
    matches: false,
    diffs: [
      {
        expected: "2",
        actual: "1",
        path: "(root)"
      }
    ]
  },
  j: {
    matches: false,
    diffs: [
      {
        expected: "\"other test\"",
        actual: "\"test\"",
        path: "(root)"
      }
    ]
  },
  k: {
    matches: true,
    diffs: []
  },
  l: {
    matches: true,
    diffs: []
  },
  m: {
    matches: true,
    diffs: []
  },
  n: {
    matches: true,
    diffs: []
  },
  o: {
    matches: true,
    diffs: []
  },
  p: {
    matches: true,
    diffs: []
  },
  q: {
    matches: true,
    diffs: []
  },
  r: {
    matches: true,
    diffs: []
  },
  s: {
    matches: true,
    diffs: []
  },
  t: {
    matches: true,
    diffs: []
  },
  u: {
    matches: true,
    diffs: []
  }
}
```

<!-- document id=3f788de79deb6ce6ab0e8a0c87f856507920226972796f44a01ce828bc5137ee url=/mulesoft/current/en-us/dataweave/2.9/dw-diff-functions-diff.md -->

---
product: DataWeave
version: 2.9
---

# diff

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## diff(actual: Any, expected: Any, diffConfig: { unordered?: Boolean } = {}, path: String = "(root)"): Diff

Returns the structural differences between two values.

Differences between objects can be ordered (the default) or unordered. Ordered means that two
objects do not differ if their key-value pairs are in the same order. Differences are expressed as
`Difference` type.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>actual</code></p></td><td><p>The actual value. Can be any data type.</p></td></tr><tr><td><p><code>expected</code></p></td><td><p>The expected value to compare to the actual. Can be any data type.</p></td></tr><tr><td><p><code>diffConfig</code></p></td><td><p>Setting for changing the default to unordered using `{ "unordered" : true} (explained in the introduction).</p></td></tr></tbody></table>

### Example

This example shows a variety of uses of `diff`.

#### Source

```Dataweave
import diff from dw::util::Diff
ns ns0 http://locahost.com
ns ns1 http://acme.com
output application/dw
---
{
  "a": diff({a: 1}, {b:1}),
  "b": diff({ns0#a: 1}, {ns1#a:1}),
  "c": diff([1,2,3], []),
  "d": diff([], [1,2,3]),
  "e": diff([1,2,3], [1,2,3, 4]),
  "f": diff([{a: 1}], [{a: 2}]),
  "g": diff({a @(c: 2): 1}, {a @(c: 3): 1}),
  "h": diff(true, false),
  "i": diff(1, 2),
  "j": diff("test", "other test"),
  "k": diff({a: 1}, {a:1}),
  "l": diff({ns0#a: 1}, {ns0#a:1}),
  "m": diff([1,2,3], [1,2,3]),
  "n": diff([], []),
  "o": diff([{a: 1}], [{a: 1}]),
  "p": diff({a @(c: 2): 1}, {a @(c:2): 1}),
  "q": diff(true, true),
  "r": diff(1, 1),
  "s": diff("other test", "other test"),
  "t": diff({a:1 ,b: 2},{b: 2, a:1}, {unordered: true}),
  "u": [{format: "ssn",data: "ABC"}] diff [{ format: "ssn",data: "ABC"}]
}
```

#### Output

```XML
ns ns0 http://locahost.com
ns ns1 http://acme.com
---
{
  a: {
    matches: false,
    diffs: [
      {
        expected: "Entry (root).a with type Number",
        actual: "was not present in object.",
        path: "(root).a"
      }
    ]
  },
  b: {
    matches: false,
    diffs: [
      {
        expected: "Entry (root).ns0#a with type Number",
        actual: "was not present in object.",
        path: "(root).ns0#a"
      }
    ]
  },
  c: {
    matches: false,
    diffs: [
      {
        expected: "Array size is 0",
        actual: "was 3",
        path: "(root)"
      }
    ]
  },
  d: {
    matches: false,
    diffs: [
      {
        expected: "Array size is 3",
        actual: "was 0",
        path: "(root)"
      }
    ]
  },
  e: {
    matches: false,
    diffs: [
      {
        expected: "Array size is 4",
        actual: "was 3",
        path: "(root)"
      }
    ]
  },
  f: {
    matches: false,
    diffs: [
      {
        expected: "1" as String {mimeType: "application/dw"},
        actual: "2" as String {mimeType: "application/dw"},
        path: "(root)[0].a"
      }
    ]
  },
  g: {
    matches: false,
    diffs: [
      {
        expected: "3" as String {mimeType: "application/dw"},
        actual: "2" as String {mimeType: "application/dw"},
        path: "(root).a.@.c"
      }
    ]
  },
  h: {
    matches: false,
    diffs: [
      {
        expected: "false",
        actual: "true",
        path: "(root)"
      }
    ]
  },
  i: {
    matches: false,
    diffs: [
      {
        expected: "2",
        actual: "1",
        path: "(root)"
      }
    ]
  },
  j: {
    matches: false,
    diffs: [
      {
        expected: "\"other test\"",
        actual: "\"test\"",
        path: "(root)"
      }
    ]
  },
  k: {
    matches: true,
    diffs: []
  },
  l: {
    matches: true,
    diffs: []
  },
  m: {
    matches: true,
    diffs: []
  },
  n: {
    matches: true,
    diffs: []
  },
  o: {
    matches: true,
    diffs: []
  },
  p: {
    matches: true,
    diffs: []
  },
  q: {
    matches: true,
    diffs: []
  },
  r: {
    matches: true,
    diffs: []
  },
  s: {
    matches: true,
    diffs: []
  },
  t: {
    matches: true,
    diffs: []
  },
  u: {
    matches: true,
    diffs: []
  }
}
```

<!-- document id=646231954a1aa5e2096bb46ea80020c58b6825c4528b15d09bb6930f371bcfb0 url=/mulesoft/current/en-us/dataweave/latest/dw-diff-functions-diff.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# diff

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## diff(actual: Any, expected: Any, diffConfig: { unordered?: Boolean } = {}, path: String = "(root)"): Diff

Returns the structural differences between two values.

Differences between objects can be ordered (the default) or unordered. Ordered means that two
objects do not differ if their key-value pairs are in the same order. Differences are expressed as
`Difference` type.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>actual</code></p></td><td><p>The actual value. Can be any data type.</p></td></tr><tr><td><p><code>expected</code></p></td><td><p>The expected value to compare to the actual. Can be any data type.</p></td></tr><tr><td><p><code>diffConfig</code></p></td><td><p>Setting for changing the default to unordered using `{ "unordered" : true} (explained in the introduction).</p></td></tr></tbody></table>

### Example

This example shows a variety of uses of `diff`.

#### Source

```Dataweave
import diff from dw::util::Diff
ns ns0 http://locahost.com
ns ns1 http://acme.com
output application/dw
---
{
  "a": diff({a: 1}, {b:1}),
  "b": diff({ns0#a: 1}, {ns1#a:1}),
  "c": diff([1,2,3], []),
  "d": diff([], [1,2,3]),
  "e": diff([1,2,3], [1,2,3, 4]),
  "f": diff([{a: 1}], [{a: 2}]),
  "g": diff({a @(c: 2): 1}, {a @(c: 3): 1}),
  "h": diff(true, false),
  "i": diff(1, 2),
  "j": diff("test", "other test"),
  "k": diff({a: 1}, {a:1}),
  "l": diff({ns0#a: 1}, {ns0#a:1}),
  "m": diff([1,2,3], [1,2,3]),
  "n": diff([], []),
  "o": diff([{a: 1}], [{a: 1}]),
  "p": diff({a @(c: 2): 1}, {a @(c:2): 1}),
  "q": diff(true, true),
  "r": diff(1, 1),
  "s": diff("other test", "other test"),
  "t": diff({a:1 ,b: 2},{b: 2, a:1}, {unordered: true}),
  "u": [{format: "ssn",data: "ABC"}] diff [{ format: "ssn",data: "ABC"}]
}
```

#### Output

```XML
ns ns0 http://locahost.com
ns ns1 http://acme.com
---
{
  a: {
    matches: false,
    diffs: [
      {
        expected: "Entry (root).a with type Number",
        actual: "was not present in object.",
        path: "(root).a"
      }
    ]
  },
  b: {
    matches: false,
    diffs: [
      {
        expected: "Entry (root).ns0#a with type Number",
        actual: "was not present in object.",
        path: "(root).ns0#a"
      }
    ]
  },
  c: {
    matches: false,
    diffs: [
      {
        expected: "Array size is 0",
        actual: "was 3",
        path: "(root)"
      }
    ]
  },
  d: {
    matches: false,
    diffs: [
      {
        expected: "Array size is 3",
        actual: "was 0",
        path: "(root)"
      }
    ]
  },
  e: {
    matches: false,
    diffs: [
      {
        expected: "Array size is 4",
        actual: "was 3",
        path: "(root)"
      }
    ]
  },
  f: {
    matches: false,
    diffs: [
      {
        expected: "1" as String {mimeType: "application/dw"},
        actual: "2" as String {mimeType: "application/dw"},
        path: "(root)[0].a"
      }
    ]
  },
  g: {
    matches: false,
    diffs: [
      {
        expected: "3" as String {mimeType: "application/dw"},
        actual: "2" as String {mimeType: "application/dw"},
        path: "(root).a.@.c"
      }
    ]
  },
  h: {
    matches: false,
    diffs: [
      {
        expected: "false",
        actual: "true",
        path: "(root)"
      }
    ]
  },
  i: {
    matches: false,
    diffs: [
      {
        expected: "2",
        actual: "1",
        path: "(root)"
      }
    ]
  },
  j: {
    matches: false,
    diffs: [
      {
        expected: "\"other test\"",
        actual: "\"test\"",
        path: "(root)"
      }
    ]
  },
  k: {
    matches: true,
    diffs: []
  },
  l: {
    matches: true,
    diffs: []
  },
  m: {
    matches: true,
    diffs: []
  },
  n: {
    matches: true,
    diffs: []
  },
  o: {
    matches: true,
    diffs: []
  },
  p: {
    matches: true,
    diffs: []
  },
  q: {
    matches: true,
    diffs: []
  },
  r: {
    matches: true,
    diffs: []
  },
  s: {
    matches: true,
    diffs: []
  },
  t: {
    matches: true,
    diffs: []
  },
  u: {
    matches: true,
    diffs: []
  }
}
```

<!-- document id=df4db0dacfad4526230526a720bbdb7d8d6e38b4e2b8033231219189bdf80c89 url=/mulesoft/current/en-us/dataweave/2.11/dw-diff.md -->

---
product: DataWeave
version: 2.11
---

# Diff (dw::util::Diff)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This utility module calculates the difference between two values and returns a list of differences.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::util::Diff` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-diff-functions-diff">diff</a></p></td><td><p>Returns the structural differences between two values.</p></td></tr></tbody></table>

## Types

- [Diff Types](https://docs.mulesoft.com/dataweave/2.11/dw-diff-types)

<!-- document id=004bd6235eb878579c3bf25de7aaa6e14dad80166200e83bed2b536cc97efde4 url=/mulesoft/current/en-us/dataweave/2.12/dw-diff.md -->

---
product: DataWeave
version: 2.12
---

# Diff (dw::util::Diff)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This utility module calculates the difference between two values and returns a list of differences.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::util::Diff` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-diff-functions-diff">diff</a></p></td><td><p>Returns the structural differences between two values.</p></td></tr></tbody></table>

## Types

- [Diff Types](https://docs.mulesoft.com/dataweave/2.12/dw-diff-types)

<!-- document id=bf9177feaaf300195bb715d014960165cd974ff78f230c3d710cf900c32ed264 url=/mulesoft/current/en-us/dataweave/2.3/dw-diff.md -->

---
product: DataWeave
version: 2.3
---

# Diff (dw::util::Diff)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This utility module calculates the difference between two values and returns the list of
differences.

The module is included with Mule runtime. To use it, you must import it to your DataWeave code, for
example, by adding the line `import dw::util::Diff` or `import * from dw::util::Diff` to your
header.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-diff-functions-diff">diff</a></p></td><td><p>Returns the structural differences between two values.</p></td></tr></tbody></table>

## Types

- [Diff Types](https://docs.mulesoft.com/dataweave/2.3/dw-diff-types)

<!-- document id=6447211e91a982be3654abb26522e0efa269ae1fc6c767850d329aaeb01be9e2 url=/mulesoft/current/en-us/dataweave/2.4/dw-diff.md -->

---
product: DataWeave
version: 2.4
---

# Diff (dw::util::Diff)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This utility module calculates the difference between two values and returns a list of differences.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::util::Diff` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-diff-functions-diff">diff</a></p></td><td><p>Returns the structural differences between two values.</p></td></tr></tbody></table>

## Types

- [Diff Types](https://docs.mulesoft.com/dataweave/2.4/dw-diff-types)

<!-- document id=cccda50297fc190780da1051683a5fc893edbffca227097ed2c500aa004ddaa5 url=/mulesoft/current/en-us/dataweave/2.6/dw-diff.md -->

---
product: DataWeave
version: 2.6
---

# Diff (dw::util::Diff)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This utility module calculates the difference between two values and returns a list of differences.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::util::Diff` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-diff-functions-diff">diff</a></p></td><td><p>Returns the structural differences between two values.</p></td></tr></tbody></table>

## Types

- [Diff Types](https://docs.mulesoft.com/dataweave/2.6/dw-diff-types)

<!-- document id=290ea5b5494346c21f6449043f944f73a102336bbdb6a270b646169a87b45eed url=/mulesoft/current/en-us/dataweave/2.9/dw-diff.md -->

---
product: DataWeave
version: 2.9
---

# Diff (dw::util::Diff)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This utility module calculates the difference between two values and returns a list of differences.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::util::Diff` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-diff-functions-diff">diff</a></p></td><td><p>Returns the structural differences between two values.</p></td></tr></tbody></table>

## Types

- [Diff Types](https://docs.mulesoft.com/dataweave/2.9/dw-diff-types)

<!-- document id=0ab61df4dfd848d161ca7370477fd2b4b37af8820b3f9c7c95339772996441d3 url=/mulesoft/current/en-us/dataweave/latest/dw-diff.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Diff (dw::util::Diff)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This utility module calculates the difference between two values and returns a list of differences.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::util::Diff` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-diff-functions-diff">diff</a></p></td><td><p>Returns the structural differences between two values.</p></td></tr></tbody></table>

## Types

- [Diff Types](https://docs.mulesoft.com/dataweave/latest/dw-diff-types)

<!-- document id=0ba8bb668285a86f8db8e119c80db756403d99cb67661673bf14775a25af9380 url=/mulesoft/current/en-us/dataweave/2.11/dw-diff-types.md -->

---
product: DataWeave
version: 2.11
---

# Diff Types (dw::util::Diff)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>Diff</p></td><td><div><div><p><code>type Diff = { matches: Boolean, diffs: Array&lt;Difference&gt; }</code></p></div></div></td><td><div><div><p>Describes the entire difference between two values.</p></div><div><ul><li><p><em>Example with no differences:</em> <code>{ "matches": true, "diffs": [ ] }</code></p></li><li><p><em>Example with differences:</em> <code>{ "matches": true, "diffs": [ "expected": "4", "actual": "2", "path": "(root).a.@.d" ] }</code></p></li></ul></div><div><p>See the <code>diff</code> function for another example.</p></div></div></td></tr><tr><td><p>Difference</p></td><td><div><div><p><code>type Difference = { expected: String, actual: String, path: String }</code></p></div></div></td><td><div><div><p>Describes a single difference between two values at a given structure.</p></div></div></td></tr></tbody></table>

<!-- document id=1fd9acf4a6f9f2c7559a341555d146eeb784d44157c41da80118228920167639 url=/mulesoft/current/en-us/dataweave/2.12/dw-diff-types.md -->

---
product: DataWeave
version: 2.12
---

# Diff Types (dw::util::Diff)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>Diff</p></td><td><div><div><p><code>type Diff = { matches: Boolean, diffs: Array&lt;Difference&gt; }</code></p></div></div></td><td><div><div><p>Describes the entire difference between two values.</p></div><div><ul><li><p><em>Example with no differences:</em> <code>{ "matches": true, "diffs": [ ] }</code></p></li><li><p><em>Example with differences:</em> <code>{ "matches": true, "diffs": [ "expected": "4", "actual": "2", "path": "(root).a.@.d" ] }</code></p></li></ul></div><div><p>See the <code>diff</code> function for another example.</p></div></div></td></tr><tr><td><p>Difference</p></td><td><div><div><p><code>type Difference = { expected: String, actual: String, path: String }</code></p></div></div></td><td><div><div><p>Describes a single difference between two values at a given structure.</p></div></div></td></tr></tbody></table>

<!-- document id=656bf05620a5f15f15d2efc5a0b688970bceceae89641e8a7c486b798d2d5f7f url=/mulesoft/current/en-us/dataweave/2.3/dw-diff-types.md -->

---
product: DataWeave
version: 2.3
---

# Diff Types (dw::util::Diff)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>Diff</p></td><td><p><code>type Diff = { matches: Boolean, diffs: Array&lt;Difference&gt; }</code></p></td><td><p>Describes the entire difference between two values.</p><p><strong>Example with no differences</strong>:</p><p><code>{ "matches": true, "diffs": [ ] }</code></p><p><strong>Example with differences</strong>:</p><p><code>{ "matches": true, "diffs": [ "expected": "4", "actual": "2", "path": "(root).a.@.d" ] }</code></p><p>See the <code>diff</code> function for another example.</p></td></tr><tr><td><p>Difference</p></td><td><p><code>type Difference = { expected: String, actual: String, path: String }</code></p></td><td><p>Describes a single difference between two values at a given structure.</p></td></tr></tbody></table>

<!-- document id=13a6c9bc4f05cac79e0633cfb77d1a775a859a7e6237c7bd67e02e9483ed8cbf url=/mulesoft/current/en-us/dataweave/2.4/dw-diff-types.md -->

---
product: DataWeave
version: 2.4
---

# Diff Types (dw::util::Diff)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>Diff</p></td><td><div><div><p><code>type Diff = { matches: Boolean, diffs: Array&lt;Difference&gt; }</code></p></div></div></td><td><div><div><p>Describes the entire difference between two values.</p></div><div><ul><li><p><em>Example with no differences:</em> <code>{ "matches": true, "diffs": [ ] }</code></p></li><li><p><em>Example with differences:</em> <code>{ "matches": true, "diffs": [ "expected": "4", "actual": "2", "path": "(root).a.@.d" ] }</code></p></li></ul></div><div><p>See the <code>diff</code> function for another example.</p></div></div></td></tr><tr><td><p>Difference</p></td><td><div><div><p><code>type Difference = { expected: String, actual: String, path: String }</code></p></div></div></td><td><div><div><p>Describes a single difference between two values at a given structure.</p></div></div></td></tr></tbody></table>

<!-- document id=c37e5001d771d907a21a639b31f4a1a26115b7f91b35f6f66209651ee486d044 url=/mulesoft/current/en-us/dataweave/2.6/dw-diff-types.md -->

---
product: DataWeave
version: 2.6
---

# Diff Types (dw::util::Diff)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>Diff</p></td><td><div><div><p><code>type Diff = { matches: Boolean, diffs: Array&lt;Difference&gt; }</code></p></div></div></td><td><div><div><p>Describes the entire difference between two values.</p></div><div><ul><li><p><em>Example with no differences:</em> <code>{ "matches": true, "diffs": [ ] }</code></p></li><li><p><em>Example with differences:</em> <code>{ "matches": true, "diffs": [ "expected": "4", "actual": "2", "path": "(root).a.@.d" ] }</code></p></li></ul></div><div><p>See the <code>diff</code> function for another example.</p></div></div></td></tr><tr><td><p>Difference</p></td><td><div><div><p><code>type Difference = { expected: String, actual: String, path: String }</code></p></div></div></td><td><div><div><p>Describes a single difference between two values at a given structure.</p></div></div></td></tr></tbody></table>

<!-- document id=094fc4fccea153a7eb0bca555e277ef37c6b036b4dd261b403226ceb4c09e081 url=/mulesoft/current/en-us/dataweave/2.9/dw-diff-types.md -->

---
product: DataWeave
version: 2.9
---

# Diff Types (dw::util::Diff)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>Diff</p></td><td><div><div><p><code>type Diff = { matches: Boolean, diffs: Array&lt;Difference&gt; }</code></p></div></div></td><td><div><div><p>Describes the entire difference between two values.</p></div><div><ul><li><p><em>Example with no differences:</em> <code>{ "matches": true, "diffs": [ ] }</code></p></li><li><p><em>Example with differences:</em> <code>{ "matches": true, "diffs": [ "expected": "4", "actual": "2", "path": "(root).a.@.d" ] }</code></p></li></ul></div><div><p>See the <code>diff</code> function for another example.</p></div></div></td></tr><tr><td><p>Difference</p></td><td><div><div><p><code>type Difference = { expected: String, actual: String, path: String }</code></p></div></div></td><td><div><div><p>Describes a single difference between two values at a given structure.</p></div></div></td></tr></tbody></table>

<!-- document id=4fac5cc920841dbdacb9cc105d368c9ec1a4882db0b39af4ab1bcb89aa6ef313 url=/mulesoft/current/en-us/dataweave/latest/dw-diff-types.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Diff Types (dw::util::Diff)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>Diff</p></td><td><div><div><p><code>type Diff = { matches: Boolean, diffs: Array&lt;Difference&gt; }</code></p></div></div></td><td><div><div><p>Describes the entire difference between two values.</p></div><div><ul><li><p><em>Example with no differences:</em> <code>{ "matches": true, "diffs": [ ] }</code></p></li><li><p><em>Example with differences:</em> <code>{ "matches": true, "diffs": [ "expected": "4", "actual": "2", "path": "(root).a.@.d" ] }</code></p></li></ul></div><div><p>See the <code>diff</code> function for another example.</p></div></div></td></tr><tr><td><p>Difference</p></td><td><div><div><p><code>type Difference = { expected: String, actual: String, path: String }</code></p></div></div></td><td><div><div><p>Describes a single difference between two values at a given structure.</p></div></div></td></tr></tbody></table>

<!-- document id=3c057de83dce8fb9b5f4a7772adbe0b5716384821433d389d51f8ad5c09a0ebc url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-distinctby.md -->

---
product: DataWeave
version: 2.11
---

# distinctBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## distinctBy<T>(@StreamCapable items: Array<T>, criteria: (item: T, index: Number) -> Any): Array<T>

Iterates over the input and returns the unique elements in it.

DataWeave uses the result of the provided lambda as the uniqueness criteria.

This version of `distinctBy` finds unique values in an array. Other versions act on an object and
handle a `null` value.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The array to evaluate.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The criteria used to select an <code>item</code> and/or <code>index</code> from the array.</p></td></tr></tbody></table>

### Example

This example inputs an array that contains duplicate numbers and returns an array with unique
numbers from that input. Note that you can write the same expression using an anonymous parameter
for the values: `[0, 1, 2, 3, 3, 2, 1, 4] distinctBy $`

#### Source

```DataWeave
%dw 2.0
output application/json
---
[0, 1, 2, 3, 3, 2, 1, 4] distinctBy (value) -> { "unique" : value }
```

#### Output

```JSON
[ 0, 1, 2, 3, 4]
```

### Example

This example removes duplicates of `"Kurt Cagle"` from an array.

#### Source

```DataWeave
%dw 2.0
output application/json
var record =  {
  "title": "XQuery Kick Start",
  "author": [
    "James McGovern",
    "Per Bothner",
    "Kurt Cagle",
    "James Linn",
    "Kurt Cagle",
    "Kurt Cagle",
    "Kurt Cagle",
    "Vaidyanathan Nagarajan"
  ],
  "year":"2000"
}
---
{
    "book" : {
      "title" : record.title,
      "year" : record.year,
      "authors" : record.author distinctBy $
    }
}
```

#### Output

```JSON
{
  "book": {
    "title": "XQuery Kick Start",
    "year": "2000",
    "authors": [
      "James McGovern",
      "Per Bothner",
      "Kurt Cagle",
      "James Linn",
      "Vaidyanathan Nagarajan"
    ]
  }
}
```

## distinctBy<K, V>(object: { (K)?: V }, criteria: (value: V, key: K) -> Any): Object

Removes duplicate key-value pairs from an object.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object from which to remove the key-value pairs.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The <code>key</code> and/or <code>value</code> used to identify the key-value pairs to remove.</p></td></tr></tbody></table>

### Example

This example inputs an object that contains duplicate key-value pairs and returns an object with
key-value pairs from that input. Notice that the keys (`a` and `A`) are not treated with case
sensitivity, but the values (`b` and `B`) are. Also note that you can write the same expression
using an anonymous parameter for the values: `{a : "b", a : "b", A : "b", a : "B"} distinctBy $`

#### Source

```DataWeave
%dw 2.0
output application/json
---
{a : "b", a : "b", A : "b", a : "B"} distinctBy (value) -> { "unique" : value }
```

#### Output

```JSON
{ "a": "b", "a": "B" }
```

### Example

This example removes duplicates (`<author>James McGovern</author>`) from `<book/>`.

#### Source

```DataWeave
%dw 2.0
output application/xml
---
{
   book : {
     title : payload.book.title,
     authors: payload.book.&author distinctBy $
   }
}
```

#### Input

```XML
<book>
  <title> "XQuery Kick Start"</title>
  <author>James Linn</author>
  <author>Per Bothner</author>
  <author>James McGovern</author>
  <author>James McGovern</author>
  <author>James McGovern</author>
</book>
```

#### Output

```XML
<book>
  <title> "XQuery Kick Start"</title>
  <authors>
      <author>James Linn</author>
      <author>Per Bothner</author>
      <author>James McGovern</author>
  </authors>
</book>
```

## distinctBy(@StreamCapable items: Null, criteria: (item: Nothing, index: Nothing) -> Any): Null

Helper function that enables `distinctBy` to work with a `null` value.

<!-- document id=8ad79c677b5cde3521f63f530aebb7a1417ff4823b5e725187c106f34a3c04ba url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-distinctby.md -->

---
product: DataWeave
version: 2.12
---

# distinctBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## distinctBy<T>(@StreamCapable items: Array<T>, criteria: (item: T, index: Number) -> Any): Array<T>

Iterates over the input and returns the unique elements in it.

DataWeave uses the result of the provided lambda as the uniqueness criteria.

This version of `distinctBy` finds unique values in an array. Other versions act on an object and
handle a `null` value.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The array to evaluate.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The criteria used to select an <code>item</code> and/or <code>index</code> from the array.</p></td></tr></tbody></table>

### Example

This example inputs an array that contains duplicate numbers and returns an array with unique
numbers from that input. Note that you can write the same expression using an anonymous parameter
for the values: `[0, 1, 2, 3, 3, 2, 1, 4] distinctBy $`

#### Source

```DataWeave
%dw 2.0
output application/json
---
[0, 1, 2, 3, 3, 2, 1, 4] distinctBy (value) -> { "unique" : value }
```

#### Output

```JSON
[ 0, 1, 2, 3, 4]
```

### Example

This example removes duplicates of `"Kurt Cagle"` from an array.

#### Source

```DataWeave
%dw 2.0
output application/json
var record =  {
  "title": "XQuery Kick Start",
  "author": [
    "James McGovern",
    "Per Bothner",
    "Kurt Cagle",
    "James Linn",
    "Kurt Cagle",
    "Kurt Cagle",
    "Kurt Cagle",
    "Vaidyanathan Nagarajan"
  ],
  "year":"2000"
}
---
{
    "book" : {
      "title" : record.title,
      "year" : record.year,
      "authors" : record.author distinctBy $
    }
}
```

#### Output

```JSON
{
  "book": {
    "title": "XQuery Kick Start",
    "year": "2000",
    "authors": [
      "James McGovern",
      "Per Bothner",
      "Kurt Cagle",
      "James Linn",
      "Vaidyanathan Nagarajan"
    ]
  }
}
```

## distinctBy<K, V>(object: { (K)?: V }, criteria: (value: V, key: K) -> Any): Object

Removes duplicate key-value pairs from an object.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object from which to remove the key-value pairs.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The <code>key</code> and/or <code>value</code> used to identify the key-value pairs to remove.</p></td></tr></tbody></table>

### Example

This example inputs an object that contains duplicate key-value pairs and returns an object with
key-value pairs from that input. Notice that the keys (`a` and `A`) are not treated with case
sensitivity, but the values (`b` and `B`) are. Also note that you can write the same expression
using an anonymous parameter for the values: `{a : "b", a : "b", A : "b", a : "B"} distinctBy $`

#### Source

```DataWeave
%dw 2.0
output application/json
---
{a : "b", a : "b", A : "b", a : "B"} distinctBy (value) -> { "unique" : value }
```

#### Output

```JSON
{ "a": "b", "a": "B" }
```

### Example

This example removes duplicates (`<author>James McGovern</author>`) from `<book/>`.

#### Source

```DataWeave
%dw 2.0
output application/xml
---
{
   book : {
     title : payload.book.title,
     authors: payload.book.&author distinctBy $
   }
}
```

#### Input

```XML
<book>
  <title> "XQuery Kick Start"</title>
  <author>James Linn</author>
  <author>Per Bothner</author>
  <author>James McGovern</author>
  <author>James McGovern</author>
  <author>James McGovern</author>
</book>
```

#### Output

```XML
<book>
  <title> "XQuery Kick Start"</title>
  <authors>
      <author>James Linn</author>
      <author>Per Bothner</author>
      <author>James McGovern</author>
  </authors>
</book>
```

## distinctBy(@StreamCapable items: Null, criteria: (item: Nothing, index: Nothing) -> Any): Null

Helper function that enables `distinctBy` to work with a `null` value.

<!-- document id=cd06c41fcfbc1b4dee0bc95804e6defdb9c866aac81a52f753563c5b9e5b1c03 url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-distinctby.md -->

---
product: DataWeave
version: 2.3
---

# distinctBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## distinctBy(Array<T>, (item: T, index: Number) -> Any): Array<T>

Iterates over an array and returns the unique elements in it.

This version of `distinctBy` finds unique values in an array. Other versions act on an object and
handle a null value. DataWeave uses the result of applying the provided lambda as the uniqueness
criteria.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The array to evaluate.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The criteria used to select an <code>item</code> and/or <code>index</code> from the array.</p></td></tr></tbody></table>

### Example

This example inputs an array that contains duplicate numbers and returns an array with unique
numbers from that input. Note that you can write the same expression using an anonymous parameter
for the values: `[0, 1, 2, 3, 3, 2, 1, 4] distinctBy $`

#### Source

```DataWeave
%dw 2.0
output application/json
---
[0, 1, 2, 3, 3, 2, 1, 4] distinctBy (value) -> { "unique" : value }
```

#### Output

```JSON
[ 0, 1, 2, 3, 4]
```

### Example

This example removes duplicates of `"Kurt Cagle"` from an array.

#### Source

```DataWeave
%dw 2.0
output application/json
var record =  {
  "title": "XQuery Kick Start",
  "author": [
    "James McGovern",
    "Per Bothner",
    "Kurt Cagle",
    "James Linn",
    "Kurt Cagle",
    "Kurt Cagle",
    "Kurt Cagle",
    "Vaidyanathan Nagarajan"
  ],
  "year":"2000"
}
---
{
    "book" : {
      "title" : record.title,
      "year" : record.year,
      "authors" : record.author distinctBy $
    }
}
```

#### Output

```JSON
{
  "book": {
    "title": "XQuery Kick Start",
    "year": "2000",
    "authors": [
      "James McGovern",
      "Per Bothner",
      "Kurt Cagle",
      "James Linn",
      "Vaidyanathan Nagarajan"
    ]
  }
}
```

## distinctBy(Null, (item: Nothing, index: Nothing) -> Any): Null

Helper function that enables `distinctBy` to work with a `null` value.

## distinctBy({ (K)?: V }, (value: V, key: K) -> Any): Object

Removes duplicate key-value pairs from an object.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object from which to remove the key-value pairs.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The <code>key</code> and/or <code>value</code> used to identify the key-value pairs to remove.</p></td></tr></tbody></table>

### Example

This example inputs an object that contains duplicate key-value pairs and returns an object with
key-value pairs from that input. Notice that the keys (`a` and `A`) are not treated with case
sensitivity, but the values (`b` and `B`) are. Also note that you can write the same expression
using an anonymous parameter for the values: `{a : "b", a : "b", A : "b", a : "B"} distinctBy $`

#### Source

```DataWeave
%dw 2.0
output application/json
---
{a : "b", a : "b", A : "b", a : "B"} distinctBy (value) -> { "unique" : value }
```

#### Output

```JSON
{ "a": "b", "a": "B" }
```

### Example

This example removes duplicates (`<author>James McGovern</author>`) from `<book/>`.

#### Source

```DataWeave
%dw 2.0
output application/xml
---
{
   book : {
     title : payload.book.title,
     authors: payload.book.&author distinctBy $
   }
}
```

#### Input

```XML
<book>
  <title> "XQuery Kick Start"</title>
  <author>James Linn</author>
  <author>Per Bothner</author>
  <author>James McGovern</author>
  <author>James McGovern</author>
  <author>James McGovern</author>
</book>
```

#### Output

```XML
<book>
  <title> "XQuery Kick Start"</title>
  <authors>
      <author>James Linn</author>
      <author>Per Bothner</author>
      <author>James McGovern</author>
  </authors>
</book>
```

<!-- document id=34a4692252ff529ee71f682c4c626a8dbe8698ca3b19e073fe437c9764b70b11 url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-distinctby.md -->

---
product: DataWeave
version: 2.4
---

# distinctBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## distinctBy<T>(@StreamCapable items: Array<T>, criteria: (item: T, index: Number) -> Any): Array<T>

Iterates over an array and returns the unique elements in it.

DataWeave uses the result of applying the provided lambda as the uniqueness criteria.

This version of `distinctBy` finds unique values in an array. Other versions act on an object and
handle a `null` value.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The array to evaluate.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The criteria used to select an <code>item</code> and/or <code>index</code> from the array.</p></td></tr></tbody></table>

### Example

This example inputs an array that contains duplicate numbers and returns an array with unique
numbers from that input. Note that you can write the same expression using an anonymous parameter
for the values: `[0, 1, 2, 3, 3, 2, 1, 4] distinctBy $`

#### Source

```DataWeave
%dw 2.0
output application/json
---
[0, 1, 2, 3, 3, 2, 1, 4] distinctBy (value) -> { "unique" : value }
```

#### Output

```JSON
[ 0, 1, 2, 3, 4]
```

### Example

This example removes duplicates of `"Kurt Cagle"` from an array.

#### Source

```DataWeave
%dw 2.0
output application/json
var record =  {
  "title": "XQuery Kick Start",
  "author": [
    "James McGovern",
    "Per Bothner",
    "Kurt Cagle",
    "James Linn",
    "Kurt Cagle",
    "Kurt Cagle",
    "Kurt Cagle",
    "Vaidyanathan Nagarajan"
  ],
  "year":"2000"
}
---
{
    "book" : {
      "title" : record.title,
      "year" : record.year,
      "authors" : record.author distinctBy $
    }
}
```

#### Output

```JSON
{
  "book": {
    "title": "XQuery Kick Start",
    "year": "2000",
    "authors": [
      "James McGovern",
      "Per Bothner",
      "Kurt Cagle",
      "James Linn",
      "Vaidyanathan Nagarajan"
    ]
  }
}
```

## distinctBy<K, V>(object: { (K)?: V }, criteria: (value: V, key: K) -> Any): Object

Removes duplicate key-value pairs from an object.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object from which to remove the key-value pairs.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The <code>key</code> and/or <code>value</code> used to identify the key-value pairs to remove.</p></td></tr></tbody></table>

### Example

This example inputs an object that contains duplicate key-value pairs and returns an object with
key-value pairs from that input. Notice that the keys (`a` and `A`) are not treated with case
sensitivity, but the values (`b` and `B`) are. Also note that you can write the same expression
using an anonymous parameter for the values: `{a : "b", a : "b", A : "b", a : "B"} distinctBy $`

#### Source

```DataWeave
%dw 2.0
output application/json
---
{a : "b", a : "b", A : "b", a : "B"} distinctBy (value) -> { "unique" : value }
```

#### Output

```JSON
{ "a": "b", "a": "B" }
```

### Example

This example removes duplicates (`<author>James McGovern</author>`) from `<book/>`.

#### Source

```DataWeave
%dw 2.0
output application/xml
---
{
   book : {
     title : payload.book.title,
     authors: payload.book.&author distinctBy $
   }
}
```

#### Input

```XML
<book>
  <title> "XQuery Kick Start"</title>
  <author>James Linn</author>
  <author>Per Bothner</author>
  <author>James McGovern</author>
  <author>James McGovern</author>
  <author>James McGovern</author>
</book>
```

#### Output

```XML
<book>
  <title> "XQuery Kick Start"</title>
  <authors>
      <author>James Linn</author>
      <author>Per Bothner</author>
      <author>James McGovern</author>
  </authors>
</book>
```

## distinctBy(@StreamCapable items: Null, criteria: (item: Nothing, index: Nothing) -> Any): Null

Helper function that enables `distinctBy` to work with a `null` value.

<!-- document id=d29be00f7e4ce124cec9ba7d705b12443245c9cbf4ccaccfaaebbc2c59c3ab42 url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-distinctby.md -->

---
product: DataWeave
version: 2.6
---

# distinctBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## distinctBy<T>(@StreamCapable items: Array<T>, criteria: (item: T, index: Number) -> Any): Array<T>

Iterates over the input and returns the unique elements in it.

DataWeave uses the result of the provided lambda as the uniqueness criteria.

This version of `distinctBy` finds unique values in an array. Other versions act on an object and
handle a `null` value.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The array to evaluate.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The criteria used to select an <code>item</code> and/or <code>index</code> from the array.</p></td></tr></tbody></table>

### Example

This example inputs an array that contains duplicate numbers and returns an array with unique
numbers from that input. Note that you can write the same expression using an anonymous parameter
for the values: `[0, 1, 2, 3, 3, 2, 1, 4] distinctBy $`

#### Source

```DataWeave
%dw 2.0
output application/json
---
[0, 1, 2, 3, 3, 2, 1, 4] distinctBy (value) -> { "unique" : value }
```

#### Output

```JSON
[ 0, 1, 2, 3, 4]
```

### Example

This example removes duplicates of `"Kurt Cagle"` from an array.

#### Source

```DataWeave
%dw 2.0
output application/json
var record =  {
  "title": "XQuery Kick Start",
  "author": [
    "James McGovern",
    "Per Bothner",
    "Kurt Cagle",
    "James Linn",
    "Kurt Cagle",
    "Kurt Cagle",
    "Kurt Cagle",
    "Vaidyanathan Nagarajan"
  ],
  "year":"2000"
}
---
{
    "book" : {
      "title" : record.title,
      "year" : record.year,
      "authors" : record.author distinctBy $
    }
}
```

#### Output

```JSON
{
  "book": {
    "title": "XQuery Kick Start",
    "year": "2000",
    "authors": [
      "James McGovern",
      "Per Bothner",
      "Kurt Cagle",
      "James Linn",
      "Vaidyanathan Nagarajan"
    ]
  }
}
```

## distinctBy<K, V>(object: { (K)?: V }, criteria: (value: V, key: K) -> Any): Object

Removes duplicate key-value pairs from an object.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object from which to remove the key-value pairs.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The <code>key</code> and/or <code>value</code> used to identify the key-value pairs to remove.</p></td></tr></tbody></table>

### Example

This example inputs an object that contains duplicate key-value pairs and returns an object with
key-value pairs from that input. Notice that the keys (`a` and `A`) are not treated with case
sensitivity, but the values (`b` and `B`) are. Also note that you can write the same expression
using an anonymous parameter for the values: `{a : "b", a : "b", A : "b", a : "B"} distinctBy $`

#### Source

```DataWeave
%dw 2.0
output application/json
---
{a : "b", a : "b", A : "b", a : "B"} distinctBy (value) -> { "unique" : value }
```

#### Output

```JSON
{ "a": "b", "a": "B" }
```

### Example

This example removes duplicates (`<author>James McGovern</author>`) from `<book/>`.

#### Source

```DataWeave
%dw 2.0
output application/xml
---
{
   book : {
     title : payload.book.title,
     authors: payload.book.&author distinctBy $
   }
}
```

#### Input

```XML
<book>
  <title> "XQuery Kick Start"</title>
  <author>James Linn</author>
  <author>Per Bothner</author>
  <author>James McGovern</author>
  <author>James McGovern</author>
  <author>James McGovern</author>
</book>
```

#### Output

```XML
<book>
  <title> "XQuery Kick Start"</title>
  <authors>
      <author>James Linn</author>
      <author>Per Bothner</author>
      <author>James McGovern</author>
  </authors>
</book>
```

## distinctBy(@StreamCapable items: Null, criteria: (item: Nothing, index: Nothing) -> Any): Null

Helper function that enables `distinctBy` to work with a `null` value.

<!-- document id=05889084caf70954272c6308d97ef0a3eb802ff0b2600b4aaa08b142540d8a31 url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-distinctby.md -->

---
product: DataWeave
version: 2.9
---

# distinctBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## distinctBy<T>(@StreamCapable items: Array<T>, criteria: (item: T, index: Number) -> Any): Array<T>

Iterates over the input and returns the unique elements in it.

DataWeave uses the result of the provided lambda as the uniqueness criteria.

This version of `distinctBy` finds unique values in an array. Other versions act on an object and
handle a `null` value.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The array to evaluate.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The criteria used to select an <code>item</code> and/or <code>index</code> from the array.</p></td></tr></tbody></table>

### Example

This example inputs an array that contains duplicate numbers and returns an array with unique
numbers from that input. Note that you can write the same expression using an anonymous parameter
for the values: `[0, 1, 2, 3, 3, 2, 1, 4] distinctBy $`

#### Source

```DataWeave
%dw 2.0
output application/json
---
[0, 1, 2, 3, 3, 2, 1, 4] distinctBy (value) -> { "unique" : value }
```

#### Output

```JSON
[ 0, 1, 2, 3, 4]
```

### Example

This example removes duplicates of `"Kurt Cagle"` from an array.

#### Source

```DataWeave
%dw 2.0
output application/json
var record =  {
  "title": "XQuery Kick Start",
  "author": [
    "James McGovern",
    "Per Bothner",
    "Kurt Cagle",
    "James Linn",
    "Kurt Cagle",
    "Kurt Cagle",
    "Kurt Cagle",
    "Vaidyanathan Nagarajan"
  ],
  "year":"2000"
}
---
{
    "book" : {
      "title" : record.title,
      "year" : record.year,
      "authors" : record.author distinctBy $
    }
}
```

#### Output

```JSON
{
  "book": {
    "title": "XQuery Kick Start",
    "year": "2000",
    "authors": [
      "James McGovern",
      "Per Bothner",
      "Kurt Cagle",
      "James Linn",
      "Vaidyanathan Nagarajan"
    ]
  }
}
```

## distinctBy<K, V>(object: { (K)?: V }, criteria: (value: V, key: K) -> Any): Object

Removes duplicate key-value pairs from an object.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object from which to remove the key-value pairs.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The <code>key</code> and/or <code>value</code> used to identify the key-value pairs to remove.</p></td></tr></tbody></table>

### Example

This example inputs an object that contains duplicate key-value pairs and returns an object with
key-value pairs from that input. Notice that the keys (`a` and `A`) are not treated with case
sensitivity, but the values (`b` and `B`) are. Also note that you can write the same expression
using an anonymous parameter for the values: `{a : "b", a : "b", A : "b", a : "B"} distinctBy $`

#### Source

```DataWeave
%dw 2.0
output application/json
---
{a : "b", a : "b", A : "b", a : "B"} distinctBy (value) -> { "unique" : value }
```

#### Output

```JSON
{ "a": "b", "a": "B" }
```

### Example

This example removes duplicates (`<author>James McGovern</author>`) from `<book/>`.

#### Source

```DataWeave
%dw 2.0
output application/xml
---
{
   book : {
     title : payload.book.title,
     authors: payload.book.&author distinctBy $
   }
}
```

#### Input

```XML
<book>
  <title> "XQuery Kick Start"</title>
  <author>James Linn</author>
  <author>Per Bothner</author>
  <author>James McGovern</author>
  <author>James McGovern</author>
  <author>James McGovern</author>
</book>
```

#### Output

```XML
<book>
  <title> "XQuery Kick Start"</title>
  <authors>
      <author>James Linn</author>
      <author>Per Bothner</author>
      <author>James McGovern</author>
  </authors>
</book>
```

## distinctBy(@StreamCapable items: Null, criteria: (item: Nothing, index: Nothing) -> Any): Null

Helper function that enables `distinctBy` to work with a `null` value.

<!-- document id=9919b14544dca495029b55ac7cb6d643d7e548d4a833b7e76bde3f957d88c58b url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-distinctby.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# distinctBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## distinctBy<T>(@StreamCapable items: Array<T>, criteria: (item: T, index: Number) -> Any): Array<T>

Iterates over the input and returns the unique elements in it.

DataWeave uses the result of the provided lambda as the uniqueness criteria.

This version of `distinctBy` finds unique values in an array. Other versions act on an object and
handle a `null` value.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The array to evaluate.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The criteria used to select an <code>item</code> and/or <code>index</code> from the array.</p></td></tr></tbody></table>

### Example

This example inputs an array that contains duplicate numbers and returns an array with unique
numbers from that input. Note that you can write the same expression using an anonymous parameter
for the values: `[0, 1, 2, 3, 3, 2, 1, 4] distinctBy $`

#### Source

```DataWeave
%dw 2.0
output application/json
---
[0, 1, 2, 3, 3, 2, 1, 4] distinctBy (value) -> { "unique" : value }
```

#### Output

```JSON
[ 0, 1, 2, 3, 4]
```

### Example

This example removes duplicates of `"Kurt Cagle"` from an array.

#### Source

```DataWeave
%dw 2.0
output application/json
var record =  {
  "title": "XQuery Kick Start",
  "author": [
    "James McGovern",
    "Per Bothner",
    "Kurt Cagle",
    "James Linn",
    "Kurt Cagle",
    "Kurt Cagle",
    "Kurt Cagle",
    "Vaidyanathan Nagarajan"
  ],
  "year":"2000"
}
---
{
    "book" : {
      "title" : record.title,
      "year" : record.year,
      "authors" : record.author distinctBy $
    }
}
```

#### Output

```JSON
{
  "book": {
    "title": "XQuery Kick Start",
    "year": "2000",
    "authors": [
      "James McGovern",
      "Per Bothner",
      "Kurt Cagle",
      "James Linn",
      "Vaidyanathan Nagarajan"
    ]
  }
}
```

## distinctBy<K, V>(object: { (K)?: V }, criteria: (value: V, key: K) -> Any): Object

Removes duplicate key-value pairs from an object.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object from which to remove the key-value pairs.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The <code>key</code> and/or <code>value</code> used to identify the key-value pairs to remove.</p></td></tr></tbody></table>

### Example

This example inputs an object that contains duplicate key-value pairs and returns an object with
key-value pairs from that input. Notice that the keys (`a` and `A`) are not treated with case
sensitivity, but the values (`b` and `B`) are. Also note that you can write the same expression
using an anonymous parameter for the values: `{a : "b", a : "b", A : "b", a : "B"} distinctBy $`

#### Source

```DataWeave
%dw 2.0
output application/json
---
{a : "b", a : "b", A : "b", a : "B"} distinctBy (value) -> { "unique" : value }
```

#### Output

```JSON
{ "a": "b", "a": "B" }
```

### Example

This example removes duplicates (`<author>James McGovern</author>`) from `<book/>`.

#### Source

```DataWeave
%dw 2.0
output application/xml
---
{
   book : {
     title : payload.book.title,
     authors: payload.book.&author distinctBy $
   }
}
```

#### Input

```XML
<book>
  <title> "XQuery Kick Start"</title>
  <author>James Linn</author>
  <author>Per Bothner</author>
  <author>James McGovern</author>
  <author>James McGovern</author>
  <author>James McGovern</author>
</book>
```

#### Output

```XML
<book>
  <title> "XQuery Kick Start"</title>
  <authors>
      <author>James Linn</author>
      <author>Per Bothner</author>
      <author>James McGovern</author>
  </authors>
</book>
```

## distinctBy(@StreamCapable items: Null, criteria: (item: Nothing, index: Nothing) -> Any): Null

Helper function that enables `distinctBy` to work with a `null` value.

<!-- document id=1a574ce5fbeee875af04d6e3df3bc431dbb37b18d54a3ba137b36ae22dfd338e url=/mulesoft/current/en-us/dataweave/2.11/dw-arrays-functions-divideby.md -->

---
product: DataWeave
version: 2.11
---

# divideBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## divideBy<T>(items: Array<T>, amount: Number): Array<Array<T>>

Breaks up an array into sub-arrays that contain the specified number of elements.

When there are fewer elements in the input array than the specified number, the function fills the
sub-array with those elements. When there are more elements, the function fills as many sub-arrays
needed with the extra elements.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>Items in the input array.</p></td></tr><tr><td><p><code>amount</code></p></td><td><p>The number of elements allowed per sub-array.</p></td></tr></tbody></table>

### Example

This example breaks up arrays into sub-arrays based on the specified `amount`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
---
{
  "divideBy" : [
      { "divideBy2" : [1, 2, 3, 4, 5] divideBy 2 },
      { "divideBy2" : [1, 2, 3, 4, 5, 6] divideBy 2 },
      { "divideBy3" : [1, 2, 3, 4, 5] divideBy 3 }
  ]
}
```

#### Output

```JSON
{
 "divideBy": [
  {
    "divideBy2": [
      [ 1, 2 ],
      [ 3, 4 ],
      [ 5 ]
    ]
  },
  {
    "divideBy2": [
      [ 1, 2 ],
      [ 3, 4 ],
      [ 5, 6 ]
    ]
  },
    {
      "divideBy3": [
        [ 1, 2, 3 ],
        [ 4, 5 ]
      ]
    }
 ]
}
```

## divideBy(items: Null, amount: Any): Null

Helper function that enables `divideBy` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=462f9e0ee0138827750edbf9f00ed1363dbb0de351748447e94283004fe8827a url=/mulesoft/current/en-us/dataweave/2.11/dw-objects-functions-divideby.md -->

---
product: DataWeave
version: 2.11
---

# divideBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## divideBy(items: Object, amount: Number): Array<Object>

Breaks up an object into sub-objects that contain the specified number of key-value pairs.

If there are fewer key-value pairs in an object than the specified number, the function will fill
the object with those pairs. If there are more pairs, the function will fill another object with the
extra pairs.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>Key-value pairs in the source object.</p></td></tr><tr><td><p><code>amount</code></p></td><td><p>The number of key-value pairs allowed in an object.</p></td></tr></tbody></table>

### Example

This example breaks up objects into sub-objects based on the specified `amount`.

#### Source

```DataWeave
%dw 2.0
import divideBy from dw::core::Objects
output application/json
---
{ "divideBy" : {"a": 1, "b" : true, "a" : 2, "b" : false, "c" : 3} divideBy 2 }
```

#### Output

```JSON
{
  "divideBy": [
    {
      "a": 1,
      "b": true
    },
    {
      "a": 2,
      "b": false
    },
    {
      "c": 3
    }
  ]
}
```

<!-- document id=3de1d8cfed2a56fb19347af55bfaa69f35c98d0cecc5665e0e648f9866f77ed2 url=/mulesoft/current/en-us/dataweave/2.12/dw-arrays-functions-divideby.md -->

---
product: DataWeave
version: 2.12
---

# divideBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## divideBy<T>(items: Array<T>, amount: Number): Array<Array<T>>

Breaks up an array into sub-arrays that contain the specified number of elements.

When there are fewer elements in the input array than the specified number, the function fills the
sub-array with those elements. When there are more elements, the function fills as many sub-arrays
needed with the extra elements.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>Items in the input array.</p></td></tr><tr><td><p><code>amount</code></p></td><td><p>The number of elements allowed per sub-array.</p></td></tr></tbody></table>

### Example

This example breaks up arrays into sub-arrays based on the specified `amount`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
---
{
  "divideBy" : [
      { "divideBy2" : [1, 2, 3, 4, 5] divideBy 2 },
      { "divideBy2" : [1, 2, 3, 4, 5, 6] divideBy 2 },
      { "divideBy3" : [1, 2, 3, 4, 5] divideBy 3 }
  ]
}
```

#### Output

```JSON
{
 "divideBy": [
  {
    "divideBy2": [
      [ 1, 2 ],
      [ 3, 4 ],
      [ 5 ]
    ]
  },
  {
    "divideBy2": [
      [ 1, 2 ],
      [ 3, 4 ],
      [ 5, 6 ]
    ]
  },
    {
      "divideBy3": [
        [ 1, 2, 3 ],
        [ 4, 5 ]
      ]
    }
 ]
}
```

## divideBy(items: Null, amount: Any): Null

Helper function that enables `divideBy` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=8430dd1d481761f78c307b4c0033ea2fc219ee73d6d5f3dac57c0e4eb8b11b57 url=/mulesoft/current/en-us/dataweave/2.12/dw-objects-functions-divideby.md -->

---
product: DataWeave
version: 2.12
---

# divideBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## divideBy(items: Object, amount: Number): Array<Object>

Breaks up an object into sub-objects that contain the specified number of key-value pairs.

If there are fewer key-value pairs in an object than the specified number, the function will fill
the object with those pairs. If there are more pairs, the function will fill another object with the
extra pairs.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>Key-value pairs in the source object.</p></td></tr><tr><td><p><code>amount</code></p></td><td><p>The number of key-value pairs allowed in an object.</p></td></tr></tbody></table>

### Example

This example breaks up objects into sub-objects based on the specified `amount`.

#### Source

```DataWeave
%dw 2.0
import divideBy from dw::core::Objects
output application/json
---
{ "divideBy" : {"a": 1, "b" : true, "a" : 2, "b" : false, "c" : 3} divideBy 2 }
```

#### Output

```JSON
{
  "divideBy": [
    {
      "a": 1,
      "b": true
    },
    {
      "a": 2,
      "b": false
    },
    {
      "c": 3
    }
  ]
}
```

<!-- document id=7575ca3609233e871184a9d0a61e54ddc0694ada7922d36a593e91344efac31b url=/mulesoft/current/en-us/dataweave/2.3/dw-arrays-functions-divideby.md -->

---
product: DataWeave
version: 2.3
---

# divideBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## divideBy(Array<T>, Number): Array<Array<T>>

Breaks up an array into sub-arrays that contain the specified number of elements.

When there are fewer elements in the input array than the specified number, the function fills the
sub-array with those elements. When there are more elements, the function fills as many sub-arrays
needed with the extra elements.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>Items in the input array.</p></td></tr><tr><td><p><code>amount</code></p></td><td><p>The number of elements allowed per sub-array.</p></td></tr></tbody></table>

### Example

This example breaks up arrays into sub-arrays based on the specified `amount`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
---
{
  "divideBy" : [
      { "divideBy2" : [1, 2, 3, 4, 5] divideBy 2 },
      { "divideBy2" : [1, 2, 3, 4, 5, 6] divideBy 2 },
      { "divideBy3" : [1, 2, 3, 4, 5] divideBy 3 }
  ]
}
```

#### Output

```JSON
{
 "divideBy": [
  {
    "divideBy2": [
      [ 1, 2 ],
      [ 3, 4 ],
      [ 5 ]
    ]
  },
  {
    "divideBy2": [
      [ 1, 2 ],
      [ 3, 4 ],
      [ 5, 6 ]
    ]
  },
    {
      "divideBy3": [
        [ 1, 2, 3 ],
        [ 4, 5 ]
      ]
    }
 ]
}
```

<!-- document id=5bdcdfe72ae42a4045fc9b8f600e3451a2bcaa0423cc45c0f3ca6a48ffbeb095 url=/mulesoft/current/en-us/dataweave/2.3/dw-objects-functions-divideby.md -->

---
product: DataWeave
version: 2.3
---

# divideBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## divideBy(Object, Number): Array<Object>

Breaks up an object into sub-objects that contain the specified number of key-value pairs.

If there are fewer key-value pairs in an object than the specified number, the function will fill
the object with those pairs. If there are more pairs, the function will fill another object with the
extra pairs.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>Key-value pairs in the source object.</p></td></tr><tr><td><p><code>amount</code></p></td><td><p>The number of key-value pairs allowed in an object.</p></td></tr></tbody></table>

### Example

This example breaks up objects into sub-objects based on the specified `amount`.

#### Source

```DataWeave
%dw 2.0
import divideBy from dw::core::Objects
output application/json
---
{ "divideBy" : {"a": 1, "b" : true, "a" : 2, "b" : false, "c" : 3} divideBy 2 }
```

#### Output

```JSON
{
  "divideBy": [
    {
      "a": 1,
      "b": true
    },
    {
      "a": 2,
      "b": false
    },
    {
      "c": 3
    }
  ]
}
```

<!-- document id=70878cb33c493ceda4bcbe1d67701a84269567c316879f364828bf6eb400990b url=/mulesoft/current/en-us/dataweave/2.4/dw-arrays-functions-divideby.md -->

---
product: DataWeave
version: 2.4
---

# divideBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## divideBy<T>(items: Array<T>, amount: Number): Array<Array<T>>

Breaks up an array into sub-arrays that contain the specified number of elements.

When there are fewer elements in the input array than the specified number, the function fills the
sub-array with those elements. When there are more elements, the function fills as many sub-arrays
needed with the extra elements.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>Items in the input array.</p></td></tr><tr><td><p><code>amount</code></p></td><td><p>The number of elements allowed per sub-array.</p></td></tr></tbody></table>

### Example

This example breaks up arrays into sub-arrays based on the specified `amount`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
---
{
  "divideBy" : [
      { "divideBy2" : [1, 2, 3, 4, 5] divideBy 2 },
      { "divideBy2" : [1, 2, 3, 4, 5, 6] divideBy 2 },
      { "divideBy3" : [1, 2, 3, 4, 5] divideBy 3 }
  ]
}
```

#### Output

```JSON
{
 "divideBy": [
  {
    "divideBy2": [
      [ 1, 2 ],
      [ 3, 4 ],
      [ 5 ]
    ]
  },
  {
    "divideBy2": [
      [ 1, 2 ],
      [ 3, 4 ],
      [ 5, 6 ]
    ]
  },
    {
      "divideBy3": [
        [ 1, 2, 3 ],
        [ 4, 5 ]
      ]
    }
 ]
}
```

## divideBy(items: Null, amount: Any): Null

Helper function that enables `divideBy` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=d73fb0f0ea5c335a5319a51767ce00d4b16b5fd4c8c38438d789f43b03b2830c url=/mulesoft/current/en-us/dataweave/2.4/dw-objects-functions-divideby.md -->

---
product: DataWeave
version: 2.4
---

# divideBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## divideBy(items: Object, amount: Number): Array<Object>

Breaks up an object into sub-objects that contain the specified number of key-value pairs.

If there are fewer key-value pairs in an object than the specified number, the function will fill
the object with those pairs. If there are more pairs, the function will fill another object with the
extra pairs.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>Key-value pairs in the source object.</p></td></tr><tr><td><p><code>amount</code></p></td><td><p>The number of key-value pairs allowed in an object.</p></td></tr></tbody></table>

### Example

This example breaks up objects into sub-objects based on the specified `amount`.

#### Source

```DataWeave
%dw 2.0
import divideBy from dw::core::Objects
output application/json
---
{ "divideBy" : {"a": 1, "b" : true, "a" : 2, "b" : false, "c" : 3} divideBy 2 }
```

#### Output

```JSON
{
  "divideBy": [
    {
      "a": 1,
      "b": true
    },
    {
      "a": 2,
      "b": false
    },
    {
      "c": 3
    }
  ]
}
```

<!-- document id=9b7b52bbe60631545bbb3e9a96155e7fb664dcdf541f4e05d14c484b5cdd001d url=/mulesoft/current/en-us/dataweave/2.6/dw-arrays-functions-divideby.md -->

---
product: DataWeave
version: 2.6
---

# divideBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## divideBy<T>(items: Array<T>, amount: Number): Array<Array<T>>

Breaks up an array into sub-arrays that contain the specified number of elements.

When there are fewer elements in the input array than the specified number, the function fills the
sub-array with those elements. When there are more elements, the function fills as many sub-arrays
needed with the extra elements.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>Items in the input array.</p></td></tr><tr><td><p><code>amount</code></p></td><td><p>The number of elements allowed per sub-array.</p></td></tr></tbody></table>

### Example

This example breaks up arrays into sub-arrays based on the specified `amount`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
---
{
  "divideBy" : [
      { "divideBy2" : [1, 2, 3, 4, 5] divideBy 2 },
      { "divideBy2" : [1, 2, 3, 4, 5, 6] divideBy 2 },
      { "divideBy3" : [1, 2, 3, 4, 5] divideBy 3 }
  ]
}
```

#### Output

```JSON
{
 "divideBy": [
  {
    "divideBy2": [
      [ 1, 2 ],
      [ 3, 4 ],
      [ 5 ]
    ]
  },
  {
    "divideBy2": [
      [ 1, 2 ],
      [ 3, 4 ],
      [ 5, 6 ]
    ]
  },
    {
      "divideBy3": [
        [ 1, 2, 3 ],
        [ 4, 5 ]
      ]
    }
 ]
}
```

## divideBy(items: Null, amount: Any): Null

Helper function that enables `divideBy` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=7324e3d3dd1c4cb73cc99c083284d06e872f911c492776b92cfdb9094bd666d6 url=/mulesoft/current/en-us/dataweave/2.6/dw-objects-functions-divideby.md -->

---
product: DataWeave
version: 2.6
---

# divideBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## divideBy(items: Object, amount: Number): Array<Object>

Breaks up an object into sub-objects that contain the specified number of key-value pairs.

If there are fewer key-value pairs in an object than the specified number, the function will fill
the object with those pairs. If there are more pairs, the function will fill another object with the
extra pairs.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>Key-value pairs in the source object.</p></td></tr><tr><td><p><code>amount</code></p></td><td><p>The number of key-value pairs allowed in an object.</p></td></tr></tbody></table>

### Example

This example breaks up objects into sub-objects based on the specified `amount`.

#### Source

```DataWeave
%dw 2.0
import divideBy from dw::core::Objects
output application/json
---
{ "divideBy" : {"a": 1, "b" : true, "a" : 2, "b" : false, "c" : 3} divideBy 2 }
```

#### Output

```JSON
{
  "divideBy": [
    {
      "a": 1,
      "b": true
    },
    {
      "a": 2,
      "b": false
    },
    {
      "c": 3
    }
  ]
}
```

<!-- document id=ea49db0c966ee841fee4cead85fa481d6e715fbdefd5ce5cce973b4b027780f0 url=/mulesoft/current/en-us/dataweave/2.9/dw-arrays-functions-divideby.md -->

---
product: DataWeave
version: 2.9
---

# divideBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## divideBy<T>(items: Array<T>, amount: Number): Array<Array<T>>

Breaks up an array into sub-arrays that contain the specified number of elements.

When there are fewer elements in the input array than the specified number, the function fills the
sub-array with those elements. When there are more elements, the function fills as many sub-arrays
needed with the extra elements.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>Items in the input array.</p></td></tr><tr><td><p><code>amount</code></p></td><td><p>The number of elements allowed per sub-array.</p></td></tr></tbody></table>

### Example

This example breaks up arrays into sub-arrays based on the specified `amount`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
---
{
  "divideBy" : [
      { "divideBy2" : [1, 2, 3, 4, 5] divideBy 2 },
      { "divideBy2" : [1, 2, 3, 4, 5, 6] divideBy 2 },
      { "divideBy3" : [1, 2, 3, 4, 5] divideBy 3 }
  ]
}
```

#### Output

```JSON
{
 "divideBy": [
  {
    "divideBy2": [
      [ 1, 2 ],
      [ 3, 4 ],
      [ 5 ]
    ]
  },
  {
    "divideBy2": [
      [ 1, 2 ],
      [ 3, 4 ],
      [ 5, 6 ]
    ]
  },
    {
      "divideBy3": [
        [ 1, 2, 3 ],
        [ 4, 5 ]
      ]
    }
 ]
}
```

## divideBy(items: Null, amount: Any): Null

Helper function that enables `divideBy` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=116bff17e41bb42ab0eff34f234631dd822817b7f8155e2315c33cab361bc799 url=/mulesoft/current/en-us/dataweave/2.9/dw-objects-functions-divideby.md -->

---
product: DataWeave
version: 2.9
---

# divideBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## divideBy(items: Object, amount: Number): Array<Object>

Breaks up an object into sub-objects that contain the specified number of key-value pairs.

If there are fewer key-value pairs in an object than the specified number, the function will fill
the object with those pairs. If there are more pairs, the function will fill another object with the
extra pairs.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>Key-value pairs in the source object.</p></td></tr><tr><td><p><code>amount</code></p></td><td><p>The number of key-value pairs allowed in an object.</p></td></tr></tbody></table>

### Example

This example breaks up objects into sub-objects based on the specified `amount`.

#### Source

```DataWeave
%dw 2.0
import divideBy from dw::core::Objects
output application/json
---
{ "divideBy" : {"a": 1, "b" : true, "a" : 2, "b" : false, "c" : 3} divideBy 2 }
```

#### Output

```JSON
{
  "divideBy": [
    {
      "a": 1,
      "b": true
    },
    {
      "a": 2,
      "b": false
    },
    {
      "c": 3
    }
  ]
}
```

<!-- document id=61b453c3a86c484694a6d084d32c8dad8581737f8e8a8e275bf8c8258fc66c1f url=/mulesoft/current/en-us/dataweave/latest/dw-arrays-functions-divideby.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# divideBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## divideBy<T>(items: Array<T>, amount: Number): Array<Array<T>>

Breaks up an array into sub-arrays that contain the specified number of elements.

When there are fewer elements in the input array than the specified number, the function fills the
sub-array with those elements. When there are more elements, the function fills as many sub-arrays
needed with the extra elements.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>Items in the input array.</p></td></tr><tr><td><p><code>amount</code></p></td><td><p>The number of elements allowed per sub-array.</p></td></tr></tbody></table>

### Example

This example breaks up arrays into sub-arrays based on the specified `amount`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
---
{
  "divideBy" : [
      { "divideBy2" : [1, 2, 3, 4, 5] divideBy 2 },
      { "divideBy2" : [1, 2, 3, 4, 5, 6] divideBy 2 },
      { "divideBy3" : [1, 2, 3, 4, 5] divideBy 3 }
  ]
}
```

#### Output

```JSON
{
 "divideBy": [
  {
    "divideBy2": [
      [ 1, 2 ],
      [ 3, 4 ],
      [ 5 ]
    ]
  },
  {
    "divideBy2": [
      [ 1, 2 ],
      [ 3, 4 ],
      [ 5, 6 ]
    ]
  },
    {
      "divideBy3": [
        [ 1, 2, 3 ],
        [ 4, 5 ]
      ]
    }
 ]
}
```

## divideBy(items: Null, amount: Any): Null

Helper function that enables `divideBy` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=2786b6cfbc90b30e47096f027e8934afa1fb2a61e2c755443e50dbd6a5f7ae73 url=/mulesoft/current/en-us/dataweave/latest/dw-objects-functions-divideby.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# divideBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## divideBy(items: Object, amount: Number): Array<Object>

Breaks up an object into sub-objects that contain the specified number of key-value pairs.

If there are fewer key-value pairs in an object than the specified number, the function will fill
the object with those pairs. If there are more pairs, the function will fill another object with the
extra pairs.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>Key-value pairs in the source object.</p></td></tr><tr><td><p><code>amount</code></p></td><td><p>The number of key-value pairs allowed in an object.</p></td></tr></tbody></table>

### Example

This example breaks up objects into sub-objects based on the specified `amount`.

#### Source

```DataWeave
%dw 2.0
import divideBy from dw::core::Objects
output application/json
---
{ "divideBy" : {"a": 1, "b" : true, "a" : 2, "b" : false, "c" : 3} divideBy 2 }
```

#### Output

```JSON
{
  "divideBy": [
    {
      "a": 1,
      "b": true
    },
    {
      "a": 2,
      "b": false
    },
    {
      "c": 3
    }
  ]
}
```

<!-- document id=2e7d81a5055d865b252f014a7c1e2d099645121b0e47308dcf6ac090521278ff url=/mulesoft/current/en-us/dataweave/2.11/dw-dtd-functions-doctypeasstring.md -->

---
product: DataWeave
version: 2.11
---

# docTypeAsString

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## docTypeAsString(docType: DocType): String

Transforms a `DocType` value to a string representation.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>docType</code></p></td><td><p>DocType</p></td><td><p>The <code>DocType</code> value to transform to a string.</p></td></tr></tbody></table>

### Example

This example transforms a `DocType` value that includes a `systemId` to a string representation.

#### Source

```DataWeave
%dw 2.0
import * from dw::xml::Dtd
output application/json
---
docTypeAsString({rootName: "cXML", systemId: "http://xml.cxml.org/schemas/cXML/1.2.014/cXML.dtd"})
```

#### Output

```Json
"cXML SYSTEM http://xml.cxml.org/schemas/cXML/1.2.014/cXML.dtd"
```

### Example

This example transforms a `DocType` value that includes a `publicId` and `systemId` to a string
representation.

#### Source

```DataWeave
%dw 2.0
import * from dw::xml::Dtd
output application/json
---
docTypeAsString({rootName: "html", publicId: "-//W3C//DTD XHTML 1.0 Transitional//EN", systemId: "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"})
```

#### Output

```Json
"html PUBLIC -//W3C//DTD XHTML 1.0 Transitional//EN http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"
```

<!-- document id=f37fb10504fab40e320d569e6723c94301467fac70066603a38ff846576fa46e url=/mulesoft/current/en-us/dataweave/2.12/dw-dtd-functions-doctypeasstring.md -->

---
product: DataWeave
version: 2.12
---

# docTypeAsString

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## docTypeAsString(docType: DocType): String

Transforms a `DocType` value to a string representation.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>docType</code></p></td><td><p>DocType</p></td><td><p>The <code>DocType</code> value to transform to a string.</p></td></tr></tbody></table>

### Example

This example transforms a `DocType` value that includes a `systemId` to a string representation.

#### Source

```DataWeave
%dw 2.0
import * from dw::xml::Dtd
output application/json
---
docTypeAsString({rootName: "cXML", systemId: "http://xml.cxml.org/schemas/cXML/1.2.014/cXML.dtd"})
```

#### Output

```Json
"cXML SYSTEM http://xml.cxml.org/schemas/cXML/1.2.014/cXML.dtd"
```

### Example

This example transforms a `DocType` value that includes a `publicId` and `systemId` to a string
representation.

#### Source

```DataWeave
%dw 2.0
import * from dw::xml::Dtd
output application/json
---
docTypeAsString({rootName: "html", publicId: "-//W3C//DTD XHTML 1.0 Transitional//EN", systemId: "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"})
```

#### Output

```Json
"html PUBLIC -//W3C//DTD XHTML 1.0 Transitional//EN http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"
```

<!-- document id=15dc4ff5ef6e5f6a2698e538c0c3e386737572c243d997cc91acf0c4591f769a url=/mulesoft/current/en-us/dataweave/2.6/dw-dtd-functions-doctypeasstring.md -->

---
product: DataWeave
version: 2.6
---

# docTypeAsString

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## docTypeAsString(docType: DocType): String

Transforms a `DocType` value to a string representation.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>docType</code></p></td><td><p>DocType</p></td><td><p>The <code>DocType</code> value to transform to a string.</p></td></tr></tbody></table>

### Example

This example transforms a `DocType` value that includes a `systemId` to a string representation.

#### Source

```DataWeave
%dw 2.0
import * from dw::xml::Dtd
output application/json
---
docTypeAsString({rootName: "cXML", systemId: "http://xml.cxml.org/schemas/cXML/1.2.014/cXML.dtd"})
```

#### Output

```Json
"cXML SYSTEM http://xml.cxml.org/schemas/cXML/1.2.014/cXML.dtd"
```

### Example

This example transforms a `DocType` value that includes a `publicId` and `systemId` to a string
representation.

#### Source

```DataWeave
%dw 2.0
import * from dw::xml::Dtd
output application/json
---
docTypeAsString({rootName: "html", publicId: "-//W3C//DTD XHTML 1.0 Transitional//EN", systemId: "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"})
```

#### Output

```Json
"html PUBLIC -//W3C//DTD XHTML 1.0 Transitional//EN http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"
```

<!-- document id=7799abb3902781585620d2be470590ae77bb0c5eb84c0a15f5adeb92ed719fbb url=/mulesoft/current/en-us/dataweave/2.9/dw-dtd-functions-doctypeasstring.md -->

---
product: DataWeave
version: 2.9
---

# docTypeAsString

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## docTypeAsString(docType: DocType): String

Transforms a `DocType` value to a string representation.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>docType</code></p></td><td><p>DocType</p></td><td><p>The <code>DocType</code> value to transform to a string.</p></td></tr></tbody></table>

### Example

This example transforms a `DocType` value that includes a `systemId` to a string representation.

#### Source

```DataWeave
%dw 2.0
import * from dw::xml::Dtd
output application/json
---
docTypeAsString({rootName: "cXML", systemId: "http://xml.cxml.org/schemas/cXML/1.2.014/cXML.dtd"})
```

#### Output

```Json
"cXML SYSTEM http://xml.cxml.org/schemas/cXML/1.2.014/cXML.dtd"
```

### Example

This example transforms a `DocType` value that includes a `publicId` and `systemId` to a string
representation.

#### Source

```DataWeave
%dw 2.0
import * from dw::xml::Dtd
output application/json
---
docTypeAsString({rootName: "html", publicId: "-//W3C//DTD XHTML 1.0 Transitional//EN", systemId: "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"})
```

#### Output

```Json
"html PUBLIC -//W3C//DTD XHTML 1.0 Transitional//EN http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"
```

<!-- document id=ab03336a7bcc112a40d562d294fa7045a62632aeb85240dedca10b701c5e3bc1 url=/mulesoft/current/en-us/dataweave/latest/dw-dtd-functions-doctypeasstring.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# docTypeAsString

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## docTypeAsString(docType: DocType): String

Transforms a `DocType` value to a string representation.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>docType</code></p></td><td><p>DocType</p></td><td><p>The <code>DocType</code> value to transform to a string.</p></td></tr></tbody></table>

### Example

This example transforms a `DocType` value that includes a `systemId` to a string representation.

#### Source

```DataWeave
%dw 2.0
import * from dw::xml::Dtd
output application/json
---
docTypeAsString({rootName: "cXML", systemId: "http://xml.cxml.org/schemas/cXML/1.2.014/cXML.dtd"})
```

#### Output

```Json
"cXML SYSTEM http://xml.cxml.org/schemas/cXML/1.2.014/cXML.dtd"
```

### Example

This example transforms a `DocType` value that includes a `publicId` and `systemId` to a string
representation.

#### Source

```DataWeave
%dw 2.0
import * from dw::xml::Dtd
output application/json
---
docTypeAsString({rootName: "html", publicId: "-//W3C//DTD XHTML 1.0 Transitional//EN", systemId: "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"})
```

#### Output

```Json
"html PUBLIC -//W3C//DTD XHTML 1.0 Transitional//EN http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"
```

<!-- document id=057a442bbce0acc9392167185c9dd2ebe8edf22ca92e94e7fd1439c27f1a1e1c url=/mulesoft/current/en-us/dataweave/2.11/dw-arrays-functions-drop.md -->

---
product: DataWeave
version: 2.11
---

# drop

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## drop<T>(array: Array<T>, n: Number): Array<T>

Drops the first `n` elements. It returns the original array when `n <= 0` and an empty array when
`n > sizeOf(array)`.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The left array of elements.</p></td></tr><tr><td><p><code>n</code></p></td><td><p>The number of elements to take.</p></td></tr></tbody></table>

### Example

This example returns an array that only contains the third element of the input array. It drops the
first two elements from the output.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
var users = ["Mariano", "Leandro", "Julian"]
output application/json
---
drop(users, 2)
```

#### Output

```json
["Julian"]
```

## drop(array: Null, n: Any): Null

Helper function that enables `drop` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=a04c2e2efb886391e77f63492cf399fa2f71f63f63d8e565232cd30e45cb8659 url=/mulesoft/current/en-us/dataweave/2.12/dw-arrays-functions-drop.md -->

---
product: DataWeave
version: 2.12
---

# drop

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## drop<T>(array: Array<T>, n: Number): Array<T>

Drops the first `n` elements. It returns the original array when `n <= 0` and an empty array when
`n > sizeOf(array)`.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The left array of elements.</p></td></tr><tr><td><p><code>n</code></p></td><td><p>The number of elements to take.</p></td></tr></tbody></table>

### Example

This example returns an array that only contains the third element of the input array. It drops the
first two elements from the output.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
var users = ["Mariano", "Leandro", "Julian"]
output application/json
---
drop(users, 2)
```

#### Output

```json
["Julian"]
```

## drop(array: Null, n: Any): Null

Helper function that enables `drop` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=92eb7fe49a58c25b217ee4b35fec6e11274637871b4c16943df5a281beb36752 url=/mulesoft/current/en-us/dataweave/2.3/dw-arrays-functions-drop.md -->

---
product: DataWeave
version: 2.3
---

# drop

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## drop(Array<T>, Number): Array<T>

Drops the first `n` elements. It returns the original array when `n <= 0` and an empty array when
`n > sizeOf(array)`.

_Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The left array of elements.</p></td></tr><tr><td><p><code>n</code></p></td><td><p>The number of elements to take.</p></td></tr></tbody></table>

### Example

This example returns an array that only contains the third element of the input array. It drops the
first two elements from the output.

#### Source

```DataWeave
 %dw 2.0
 import * from dw::core::Arrays
 var users = ["Mariano", "Leandro", "Julian"]
 output application/json
 ---
 drop(users, 2)
```

#### Output

```json
["Julian"]
```

<!-- document id=def77da1bcb6e74863b4dca8d915dde303dfd5e6f6df7da27d29f2981365c6b3 url=/mulesoft/current/en-us/dataweave/2.4/dw-arrays-functions-drop.md -->

---
product: DataWeave
version: 2.4
---

# drop

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## drop<T>(array: Array<T>, n: Number): Array<T>

Drops the first `n` elements. It returns the original array when `n <= 0` and an empty array when
`n > sizeOf(array)`.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The left array of elements.</p></td></tr><tr><td><p><code>n</code></p></td><td><p>The number of elements to take.</p></td></tr></tbody></table>

### Example

This example returns an array that only contains the third element of the input array. It drops the
first two elements from the output.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
var users = ["Mariano", "Leandro", "Julian"]
output application/json
---
drop(users, 2)
```

#### Output

```json
["Julian"]
```

## drop(array: Null, n: Any): Null

Helper function that enables `drop` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=98b462a5dd802462d40921319a1622a9975865e0f55e54769c03b0a87e0d3bf9 url=/mulesoft/current/en-us/dataweave/2.6/dw-arrays-functions-drop.md -->

---
product: DataWeave
version: 2.6
---

# drop

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## drop<T>(array: Array<T>, n: Number): Array<T>

Drops the first `n` elements. It returns the original array when `n <= 0` and an empty array when
`n > sizeOf(array)`.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The left array of elements.</p></td></tr><tr><td><p><code>n</code></p></td><td><p>The number of elements to take.</p></td></tr></tbody></table>

### Example

This example returns an array that only contains the third element of the input array. It drops the
first two elements from the output.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
var users = ["Mariano", "Leandro", "Julian"]
output application/json
---
drop(users, 2)
```

#### Output

```json
["Julian"]
```

## drop(array: Null, n: Any): Null

Helper function that enables `drop` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=1dec7c85a4efe1a0c8e2ab7bf03f12674aff3e851ab1645f4ab9151cd7d55ae2 url=/mulesoft/current/en-us/dataweave/2.9/dw-arrays-functions-drop.md -->

---
product: DataWeave
version: 2.9
---

# drop

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## drop<T>(array: Array<T>, n: Number): Array<T>

Drops the first `n` elements. It returns the original array when `n <= 0` and an empty array when
`n > sizeOf(array)`.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The left array of elements.</p></td></tr><tr><td><p><code>n</code></p></td><td><p>The number of elements to take.</p></td></tr></tbody></table>

### Example

This example returns an array that only contains the third element of the input array. It drops the
first two elements from the output.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
var users = ["Mariano", "Leandro", "Julian"]
output application/json
---
drop(users, 2)
```

#### Output

```json
["Julian"]
```

## drop(array: Null, n: Any): Null

Helper function that enables `drop` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=f4ac2823c95e9e1ab78e30098c503d114c0f101610bda550da5a6b0c65dcb285 url=/mulesoft/current/en-us/dataweave/latest/dw-arrays-functions-drop.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# drop

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## drop<T>(array: Array<T>, n: Number): Array<T>

Drops the first `n` elements. It returns the original array when `n <= 0` and an empty array when
`n > sizeOf(array)`.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The left array of elements.</p></td></tr><tr><td><p><code>n</code></p></td><td><p>The number of elements to take.</p></td></tr></tbody></table>

### Example

This example returns an array that only contains the third element of the input array. It drops the
first two elements from the output.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
var users = ["Mariano", "Leandro", "Julian"]
output application/json
---
drop(users, 2)
```

#### Output

```json
["Julian"]
```

## drop(array: Null, n: Any): Null

Helper function that enables `drop` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=4dff239c5beb108e1820440d4f169846d5227e7d834175aa71fe6ca092514528 url=/mulesoft/current/en-us/dataweave/2.11/dw-arrays-functions-dropwhile.md -->

---
product: DataWeave
version: 2.11
---

# dropWhile

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## dropWhile<T>(array: Array<T>, condition: (item: T) -> Boolean): Array<T>

Drops elements from the array while the condition is met but stops the selection process when it
reaches an element that fails to satisfy the condition.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition (or expression) used to match an element in the array.</p></td></tr></tbody></table>

### Example

This example returns an array that omits elements that are less than or equal to `2`. The last two
elements (`2` and `1`) are included in the output array because the function stops dropping elements
when it reaches the `3`, which is greater than `2`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var arr = [0,1,3,2,1]
---
arr dropWhile $ < 3
```

#### Output

```json
[3, 2, 1]
```

## dropWhile(array: Null, condition: (item: Nothing) -> Any): Null

Helper function that enables `dropWhile` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=a557790b28f02afc61ef950192f184ed0dc95e1f774a31db36631bb56258b626 url=/mulesoft/current/en-us/dataweave/2.12/dw-arrays-functions-dropwhile.md -->

---
product: DataWeave
version: 2.12
---

# dropWhile

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## dropWhile<T>(array: Array<T>, condition: (item: T) -> Boolean): Array<T>

Drops elements from the array while the condition is met but stops the selection process when it
reaches an element that fails to satisfy the condition.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition (or expression) used to match an element in the array.</p></td></tr></tbody></table>

### Example

This example returns an array that omits elements that are less than or equal to `2`. The last two
elements (`2` and `1`) are included in the output array because the function stops dropping elements
when it reaches the `3`, which is greater than `2`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var arr = [0,1,3,2,1]
---
arr dropWhile $ < 3
```

#### Output

```json
[3, 2, 1]
```

## dropWhile(array: Null, condition: (item: Nothing) -> Any): Null

Helper function that enables `dropWhile` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=3d32daae9ffd692afe01db93edd3b6ab754e661fb4450c0f64fdd2c3c2362244 url=/mulesoft/current/en-us/dataweave/2.3/dw-arrays-functions-dropwhile.md -->

---
product: DataWeave
version: 2.3
---

# dropWhile

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## dropWhile(Array<T>, (item: T) -> Boolean): Array<T>

Drops elements from the array while the condition is met but stops the selection process when it
reaches an element that fails to satisfy the condition.

_Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition (or expression) used to match an element in the array.</p></td></tr></tbody></table>

### Example

This example returns an array that omits elements that are less than or equal to `2`. The last two
elements (`2` and `1`) are included in the output array because the function stops dropping elements
when it reaches the `3`, which is greater than `2`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var arr = [0,1,3,2,1]
---
arr dropWhile $ < 3
```

#### Output

```json
[3, 2, 1]
```

<!-- document id=053b98b504eea8155dea6853ce6dfd54593b95cd1e88a29508a4c3e946bf9b15 url=/mulesoft/current/en-us/dataweave/2.4/dw-arrays-functions-dropwhile.md -->

---
product: DataWeave
version: 2.4
---

# dropWhile

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## dropWhile<T>(array: Array<T>, condition: (item: T) -> Boolean): Array<T>

Drops elements from the array while the condition is met but stops the selection process when it
reaches an element that fails to satisfy the condition.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition (or expression) used to match an element in the array.</p></td></tr></tbody></table>

### Example

This example returns an array that omits elements that are less than or equal to `2`. The last two
elements (`2` and `1`) are included in the output array because the function stops dropping elements
when it reaches the `3`, which is greater than `2`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var arr = [0,1,3,2,1]
---
arr dropWhile $ < 3
```

#### Output

```json
[3, 2, 1]
```

## dropWhile(array: Null, condition: (item: Nothing) -> Any): Null

Helper function that enables `dropWhile` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=a70817020a9ac917362dfdca44c59b8de8f7651c51e49e7ca74ac9633f6a5729 url=/mulesoft/current/en-us/dataweave/2.6/dw-arrays-functions-dropwhile.md -->

---
product: DataWeave
version: 2.6
---

# dropWhile

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## dropWhile<T>(array: Array<T>, condition: (item: T) -> Boolean): Array<T>

Drops elements from the array while the condition is met but stops the selection process when it
reaches an element that fails to satisfy the condition.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition (or expression) used to match an element in the array.</p></td></tr></tbody></table>

### Example

This example returns an array that omits elements that are less than or equal to `2`. The last two
elements (`2` and `1`) are included in the output array because the function stops dropping elements
when it reaches the `3`, which is greater than `2`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var arr = [0,1,3,2,1]
---
arr dropWhile $ < 3
```

#### Output

```json
[3, 2, 1]
```

## dropWhile(array: Null, condition: (item: Nothing) -> Any): Null

Helper function that enables `dropWhile` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=c1d4373889d4b4368c76503b2cfcb9a4c0b55550f2f2abb1afeb9b5fa2263884 url=/mulesoft/current/en-us/dataweave/2.9/dw-arrays-functions-dropwhile.md -->

---
product: DataWeave
version: 2.9
---

# dropWhile

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## dropWhile<T>(array: Array<T>, condition: (item: T) -> Boolean): Array<T>

Drops elements from the array while the condition is met but stops the selection process when it
reaches an element that fails to satisfy the condition.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition (or expression) used to match an element in the array.</p></td></tr></tbody></table>

### Example

This example returns an array that omits elements that are less than or equal to `2`. The last two
elements (`2` and `1`) are included in the output array because the function stops dropping elements
when it reaches the `3`, which is greater than `2`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var arr = [0,1,3,2,1]
---
arr dropWhile $ < 3
```

#### Output

```json
[3, 2, 1]
```

## dropWhile(array: Null, condition: (item: Nothing) -> Any): Null

Helper function that enables `dropWhile` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=be13fc3a4619e4b2c64b20af1c2dfa999841bc2da9b1f66a8ae7ef7a5d25fe26 url=/mulesoft/current/en-us/dataweave/latest/dw-arrays-functions-dropwhile.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# dropWhile

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## dropWhile<T>(array: Array<T>, condition: (item: T) -> Boolean): Array<T>

Drops elements from the array while the condition is met but stops the selection process when it
reaches an element that fails to satisfy the condition.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition (or expression) used to match an element in the array.</p></td></tr></tbody></table>

### Example

This example returns an array that omits elements that are less than or equal to `2`. The last two
elements (`2` and `1`) are included in the output array because the function stops dropping elements
when it reaches the `3`, which is greater than `2`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var arr = [0,1,3,2,1]
---
arr dropWhile $ < 3
```

#### Output

```json
[3, 2, 1]
```

## dropWhile(array: Null, condition: (item: Nothing) -> Any): Null

Helper function that enables `dropWhile` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=f095abf97d9a8a915923535592898143c9a5f22c5fe8a064c6496bd9501fed1e url=/mulesoft/current/en-us/dataweave/2.11/dw-dtd.md -->

---
product: DataWeave
version: 2.11
---

# Dtd (dw::xml::Dtd)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions for working with XML doctype declarations.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::xml::Dtd` to the header of your DataWeave script.

_Introduced in DataWeave version 2.5.0._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-dtd-functions-doctypeasstring">docTypeAsString</a></p></td><td><p>Transforms a <code>DocType</code> value to a string representation.</p></td></tr></tbody></table>

## Types

- [Dtd Types](https://docs.mulesoft.com/dataweave/2.11/dw-dtd-types)

<!-- document id=837bfcbb2cec4ab49a0b85a73604cf366cd0229a33c0cdd68a6d61131b7d25bc url=/mulesoft/current/en-us/dataweave/2.12/dw-dtd.md -->

---
product: DataWeave
version: 2.12
---

# Dtd (dw::xml::Dtd)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions for working with XML doctype declarations.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::xml::Dtd` to the header of your DataWeave script.

_Introduced in DataWeave version 2.5.0._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-dtd-functions-doctypeasstring">docTypeAsString</a></p></td><td><p>Transforms a <code>DocType</code> value to a string representation.</p></td></tr></tbody></table>

## Types

- [Dtd Types](https://docs.mulesoft.com/dataweave/2.12/dw-dtd-types)

<!-- document id=bb377b3dcd3df9325fb50a72a525e208f3de6005975018b4b958372298bba96d url=/mulesoft/current/en-us/dataweave/2.6/dw-dtd.md -->

---
product: DataWeave
version: 2.6
---

# Dtd (dw::xml::Dtd)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions for working with XML doctype declarations.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::xml::Dtd` to the header of your DataWeave script.

_Introduced in DataWeave version 2.5.0._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-dtd-functions-doctypeasstring">docTypeAsString</a></p></td><td><p>Transforms a <code>DocType</code> value to a string representation.</p></td></tr></tbody></table>

## Types

- [Dtd Types](https://docs.mulesoft.com/dataweave/2.6/dw-dtd-types)

<!-- document id=f9ce4173be875c87a0b36bad5192007e60cc4e4b7b291a1e9c31e8ade1a467ee url=/mulesoft/current/en-us/dataweave/2.9/dw-dtd.md -->

---
product: DataWeave
version: 2.9
---

# Dtd (dw::xml::Dtd)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions for working with XML doctype declarations.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::xml::Dtd` to the header of your DataWeave script.

_Introduced in DataWeave version 2.5.0._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-dtd-functions-doctypeasstring">docTypeAsString</a></p></td><td><p>Transforms a <code>DocType</code> value to a string representation.</p></td></tr></tbody></table>

## Types

- [Dtd Types](https://docs.mulesoft.com/dataweave/2.9/dw-dtd-types)

<!-- document id=6b690056e553c7c4bfad8cd70513410d37e4d799268b73c56911c3fd56654a95 url=/mulesoft/current/en-us/dataweave/latest/dw-dtd.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Dtd (dw::xml::Dtd)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions for working with XML doctype declarations.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::xml::Dtd` to the header of your DataWeave script.

_Introduced in DataWeave version 2.5.0._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-dtd-functions-doctypeasstring">docTypeAsString</a></p></td><td><p>Transforms a <code>DocType</code> value to a string representation.</p></td></tr></tbody></table>

## Types

- [Dtd Types](https://docs.mulesoft.com/dataweave/latest/dw-dtd-types)

<!-- document id=cf3d488da298a1e2e3204da8cc72faee2174bc1be70542ace155fec60ac20beb url=/mulesoft/current/en-us/dataweave/2.11/dw-dtd-types.md -->

---
product: DataWeave
version: 2.11
---

# Dtd Types (dw::xml::Dtd)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>DocType</p></td><td><div><div><p><code>type DocType = { rootName: String, publicId?: String, systemId?: String, internalSubset?: String }</code></p></div></div></td><td><div><div><p>DataWeave type for representing a doctype declaration that is part of an XML file. Supports the following fields:</p></div><div><ul><li><p><code>rootName</code>: Root element of the declaration.</p></li><li><p><code>publicId</code>: Publicly available standard (optional).</p></li><li><p><code>systemId</code>: Local URL (optional).</p></li><li><p><code>internalSubset</code>: Internal DTD subset (optional).</p></li></ul></div><div><p><em>Introduced in DataWeave version 2.5.0.</em></p></div></div></td></tr></tbody></table>

<!-- document id=1d0966bbdd3bc9243d88dcd7a8e9cf2b59432eda88fdbca24f0da0a531db939e url=/mulesoft/current/en-us/dataweave/2.12/dw-dtd-types.md -->

---
product: DataWeave
version: 2.12
---

# Dtd Types (dw::xml::Dtd)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>DocType</p></td><td><div><div><p><code>type DocType = { rootName: String, publicId?: String, systemId?: String, internalSubset?: String }</code></p></div></div></td><td><div><div><p>DataWeave type for representing a doctype declaration that is part of an XML file. Supports the following fields:</p></div><div><ul><li><p><code>rootName</code>: Root element of the declaration.</p></li><li><p><code>publicId</code>: Publicly available standard (optional).</p></li><li><p><code>systemId</code>: Local URL (optional).</p></li><li><p><code>internalSubset</code>: Internal DTD subset (optional).</p></li></ul></div><div><p><em>Introduced in DataWeave version 2.5.0.</em></p></div></div></td></tr></tbody></table>

<!-- document id=3876ed0c5e15157a40ab2cf3e3b087a418b300e4eb34a9bb5dfb514ad533f93d url=/mulesoft/current/en-us/dataweave/2.6/dw-dtd-types.md -->

---
product: DataWeave
version: 2.6
---

# Dtd Types (dw::xml::Dtd)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>DocType</p></td><td><div><div><p><code>type DocType = { rootName: String, publicId?: String, systemId?: String, internalSubset?: String }</code></p></div></div></td><td><div><div><p>DataWeave type for representing a doctype declaration that is part of an XML file. Supports the following fields:</p></div><div><ul><li><p><code>rootName</code>: Root element of the declaration.</p></li><li><p><code>publicId</code>: Publicly available standard (optional).</p></li><li><p><code>systemId</code>: Local URL (optional).</p></li><li><p><code>internalSubset</code>: Internal DTD subset (optional).</p></li></ul></div><div><p><em>Introduced in DataWeave version 2.5.0.</em></p></div></div></td></tr></tbody></table>

<!-- document id=3d745b8b44ef86755f37c301b1989e1cd97d413c8855fa1bfd506502b317232c url=/mulesoft/current/en-us/dataweave/2.9/dw-dtd-types.md -->

---
product: DataWeave
version: 2.9
---

# Dtd Types (dw::xml::Dtd)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>DocType</p></td><td><div><div><p><code>type DocType = { rootName: String, publicId?: String, systemId?: String, internalSubset?: String }</code></p></div></div></td><td><div><div><p>DataWeave type for representing a doctype declaration that is part of an XML file. Supports the following fields:</p></div><div><ul><li><p><code>rootName</code>: Root element of the declaration.</p></li><li><p><code>publicId</code>: Publicly available standard (optional).</p></li><li><p><code>systemId</code>: Local URL (optional).</p></li><li><p><code>internalSubset</code>: Internal DTD subset (optional).</p></li></ul></div><div><p><em>Introduced in DataWeave version 2.5.0.</em></p></div></div></td></tr></tbody></table>

<!-- document id=409de074a576b3fe6bd7002c9694a4ca7e3cb762001e652a02664ab682e3d422 url=/mulesoft/current/en-us/dataweave/latest/dw-dtd-types.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Dtd Types (dw::xml::Dtd)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>DocType</p></td><td><div><div><p><code>type DocType = { rootName: String, publicId?: String, systemId?: String, internalSubset?: String }</code></p></div></div></td><td><div><div><p>DataWeave type for representing a doctype declaration that is part of an XML file. Supports the following fields:</p></div><div><ul><li><p><code>rootName</code>: Root element of the declaration.</p></li><li><p><code>publicId</code>: Publicly available standard (optional).</p></li><li><p><code>systemId</code>: Local URL (optional).</p></li><li><p><code>internalSubset</code>: Internal DTD subset (optional).</p></li></ul></div><div><p><em>Introduced in DataWeave version 2.5.0.</em></p></div></div></td></tr></tbody></table>

<!-- document id=38c0f67d12ede40bfd7a2e3079615e138ed557809421eb725975b54b284b82e3 url=/mulesoft/current/en-us/dataweave/2.11/dw-periods-functions-duration.md -->

---
product: DataWeave
version: 2.11
---

# duration

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## duration(period: { days?: Number, hours?: Number, minutes?: Number, seconds?: Number }): Period

Creates a Period value that represents a number of days, hours, minutes, or seconds.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>period</code></p></td><td><p>An object such as <code>{days:4, hours:11, minutes:45, seconds: 55}</code>. The key-value pairs are optional and can be specified in any order. An empty object (<code>{}</code>) returns the Period value <code>"PT0S"</code> (zero seconds). The default value of each key is <code>0</code>. Valid values are whole or decimal numbers, which can be positive or negative. Key names are selectable.</p></td></tr></tbody></table>

### Example

This example shows how `duration` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Periods
output application/json
---
{
   dayAfterDateTime: |2020-10-05T20:22:34.385Z| + duration({days: 1}),
   dayAndHourBeforeDateTime: |2020-10-05T20:22:34.385Z| - duration({days: 1, hours: 1}),
   pointInTimeBefore: |2020-10-05T20:22:34.385Z| - duration({days: 1, hours: 1, minutes: 20, seconds: 10}),
   emptyDuration: duration({}),
   constructDuration: duration({days:4, hours:11, minutes:28}),
   selectHoursFromDuration: duration({days:4, hours:11, minutes:28}).hours,
   decimalAsPeriod:  duration({seconds: 30.5}),
   addNegativeValue: duration({ minutes : 1 }) + duration({ seconds : -1 })
}
```

#### Output

```Json
{
   "dayAfterDateTime": "2020-10-06T20:22:34.385Z",
   "dayAndHourBeforeDateTime": "2020-10-04T19:22:34.385Z",
   "pointInTimeBefore": "2020-10-04T19:02:24.385Z",
   "emptyDuration": "PT0S",
   "constructDuration": "PT107H28M",
   "selectHoursFromDuration": 11,
   "decimalAsPeriod": "PT30.5S",
   "addNegativeValue": 59
}
```

<!-- document id=793db2b2ade3af84d7e51e9f6a33c9cc8fad8d36358e780cb43707a2229ae18e url=/mulesoft/current/en-us/dataweave/2.11/dw-timer-functions-duration.md -->

---
product: DataWeave
version: 2.11
---

# duration

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## duration<T>(valueToMeasure: () -> T): DurationMeasurement<T>

Executes the input function and returns an object with execution time in milliseconds and result of
that function.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>valueToMeasure</code></p></td><td><p>A function to pass to <code>duration</code>.</p></td></tr></tbody></table>

### Example

This example passes a `wait` function (defined in the header), which returns the execution time and
result of that function in a `DurationMeasurement` object.

#### Source

```Dataweave
%dw 2.0
output application/json
fun myFunction() = dw::Runtime::wait("My result",100)
---
dw::util::Timer::duration(() -> myFunction())
```

#### Output

```XML
{
  "time": 101,
  "result": "My result"
}
```

<!-- document id=c37f76c948fd26eefb0c94478af19a4e0eeb34be2ea60cc1422c5ffe5b030c51 url=/mulesoft/current/en-us/dataweave/2.12/dw-periods-functions-duration.md -->

---
product: DataWeave
version: 2.12
---

# duration

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## duration(period: { days?: Number, hours?: Number, minutes?: Number, seconds?: Number }): Period

Creates a Period value that represents a number of days, hours, minutes, or seconds.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>period</code></p></td><td><p>An object such as <code>{days:4, hours:11, minutes:45, seconds: 55}</code>. The key-value pairs are optional and can be specified in any order. An empty object (<code>{}</code>) returns the Period value <code>"PT0S"</code> (zero seconds). The default value of each key is <code>0</code>. Valid values are whole or decimal numbers, which can be positive or negative. Key names are selectable.</p></td></tr></tbody></table>

### Example

This example shows how `duration` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Periods
output application/json
---
{
   dayAfterDateTime: |2020-10-05T20:22:34.385Z| + duration({days: 1}),
   dayAndHourBeforeDateTime: |2020-10-05T20:22:34.385Z| - duration({days: 1, hours: 1}),
   pointInTimeBefore: |2020-10-05T20:22:34.385Z| - duration({days: 1, hours: 1, minutes: 20, seconds: 10}),
   emptyDuration: duration({}),
   constructDuration: duration({days:4, hours:11, minutes:28}),
   selectHoursFromDuration: duration({days:4, hours:11, minutes:28}).hours,
   decimalAsPeriod:  duration({seconds: 30.5}),
   addNegativeValue: duration({ minutes : 1 }) + duration({ seconds : -1 })
}
```

#### Output

```Json
{
   "dayAfterDateTime": "2020-10-06T20:22:34.385Z",
   "dayAndHourBeforeDateTime": "2020-10-04T19:22:34.385Z",
   "pointInTimeBefore": "2020-10-04T19:02:24.385Z",
   "emptyDuration": "PT0S",
   "constructDuration": "PT107H28M",
   "selectHoursFromDuration": 11,
   "decimalAsPeriod": "PT30.5S",
   "addNegativeValue": 59
}
```

<!-- document id=60a538e0f6463a36279052a3d68e371d41eeca22bf765d0cb173865e174eafb5 url=/mulesoft/current/en-us/dataweave/2.12/dw-timer-functions-duration.md -->

---
product: DataWeave
version: 2.12
---

# duration

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## duration<T>(valueToMeasure: () -> T): DurationMeasurement<T>

Executes the input function and returns an object with execution time in milliseconds and result of
that function.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>valueToMeasure</code></p></td><td><p>A function to pass to <code>duration</code>.</p></td></tr></tbody></table>

### Example

This example passes a `wait` function (defined in the header), which returns the execution time and
result of that function in a `DurationMeasurement` object.

#### Source

```Dataweave
%dw 2.0
output application/json
fun myFunction() = dw::Runtime::wait("My result",100)
---
dw::util::Timer::duration(() -> myFunction())
```

#### Output

```XML
{
  "time": 101,
  "result": "My result"
}
```

<!-- document id=510f77f7bf5e0841d253d294094d8c8552dc6b5eb6258361d0d26721a3c92953 url=/mulesoft/current/en-us/dataweave/2.3/dw-timer-functions-duration.md -->

---
product: DataWeave
version: 2.3
---

# duration

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## duration(() -> T): DurationMeasurement<T>

Executes the input function and returns an object with execution time in milliseconds and result of
that function.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>valueToMeasure</code></p></td><td><p>A function to pass to <code>duration</code>.</p></td></tr></tbody></table>

### Example

This example passes a `wait` function (defined in the header), which returns the execution time and
result of that function in a `DurationMeasurement` object.

#### Source

```Dataweave
%dw 2.0
output application/json
fun myFunction() = dw::Runtime::wait("My result",100)
---
dw::util::Timer::duration(() -> myFunction())
```

#### Output

```XML
{
  "time": 101,
  "result": "My result"
}
```

<!-- document id=2a69733724ea1652fba8bed4f9df7d766bdde0bd4b1615717bce4b5165068255 url=/mulesoft/current/en-us/dataweave/2.4/dw-periods-functions-duration.md -->

---
product: DataWeave
version: 2.4
---

# duration

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## duration(period: { days?: Number, hours?: Number, minutes?: Number, seconds?: Number }): Period

Creates a Period value that represents a number of days, hours, minutes, or seconds.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>period</code></p></td><td><p>An object such as <code>{days:4, hours:11, minutes:45, seconds: 55}</code>. The key-value pairs are optional and can be specified in any order. An empty object (<code>{}</code>) returns the Period value <code>"PT0S"</code> (zero seconds). The default value of each key is <code>0</code>. Valid values are whole or decimal numbers, which can be positive or negative. Key names are selectable.</p></td></tr></tbody></table>

### Example

This example shows how `duration` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Periods
output application/json
---
{
   dayAfterDateTime: |2020-10-05T20:22:34.385Z| + duration({days: 1}),
   dayAndHourBeforeDateTime: |2020-10-05T20:22:34.385Z| - duration({days: 1, hours: 1}),
   pointInTimeBefore: |2020-10-05T20:22:34.385Z| - duration({days: 1, hours: 1, minutes: 20, seconds: 10}),
   emptyDuration: duration({}),
   constructDuration: duration({days:4, hours:11, minutes:28}),
   selectHoursFromDuration: duration({days:4, hours:11, minutes:28}).hours,
   decimalAsPeriod:  duration({seconds: 30.5}),
   addNegativeValue: duration({ minutes : 1 }) + duration({ seconds : -1 })
}
```

#### Output

```Json
{
   "dayAfterDateTime": "2020-10-06T20:22:34.385Z",
   "dayAndHourBeforeDateTime": "2020-10-04T19:22:34.385Z",
   "pointInTimeBefore": "2020-10-04T19:02:24.385Z",
   "emptyDuration": "PT0S",
   "constructDuration": "PT107H28M",
   "selectHoursFromDuration": 11,
   "decimalAsPeriod": "PT30.5S",
   "addNegativeValue": 59
}
```

<!-- document id=e10b91d92f597ad48d41bd0ad060254fd0f803b1c5f3af84418f2be6f3c79d03 url=/mulesoft/current/en-us/dataweave/2.4/dw-timer-functions-duration.md -->

---
product: DataWeave
version: 2.4
---

# duration

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## duration<T>(valueToMeasure: () -> T): DurationMeasurement<T>

Executes the input function and returns an object with execution time in milliseconds and result of
that function.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>valueToMeasure</code></p></td><td><p>A function to pass to <code>duration</code>.</p></td></tr></tbody></table>

### Example

This example passes a `wait` function (defined in the header), which returns the execution time and
result of that function in a `DurationMeasurement` object.

#### Source

```Dataweave
%dw 2.0
output application/json
fun myFunction() = dw::Runtime::wait("My result",100)
---
dw::util::Timer::duration(() -> myFunction())
```

#### Output

```XML
{
  "time": 101,
  "result": "My result"
}
```

<!-- document id=f11bb850702615a73085e656b1d933437807a72560c0f5946d8615a1ef878a98 url=/mulesoft/current/en-us/dataweave/2.6/dw-periods-functions-duration.md -->

---
product: DataWeave
version: 2.6
---

# duration

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## duration(period: { days?: Number, hours?: Number, minutes?: Number, seconds?: Number }): Period

Creates a Period value that represents a number of days, hours, minutes, or seconds.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>period</code></p></td><td><p>An object such as <code>{days:4, hours:11, minutes:45, seconds: 55}</code>. The key-value pairs are optional and can be specified in any order. An empty object (<code>{}</code>) returns the Period value <code>"PT0S"</code> (zero seconds). The default value of each key is <code>0</code>. Valid values are whole or decimal numbers, which can be positive or negative. Key names are selectable.</p></td></tr></tbody></table>

### Example

This example shows how `duration` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Periods
output application/json
---
{
   dayAfterDateTime: |2020-10-05T20:22:34.385Z| + duration({days: 1}),
   dayAndHourBeforeDateTime: |2020-10-05T20:22:34.385Z| - duration({days: 1, hours: 1}),
   pointInTimeBefore: |2020-10-05T20:22:34.385Z| - duration({days: 1, hours: 1, minutes: 20, seconds: 10}),
   emptyDuration: duration({}),
   constructDuration: duration({days:4, hours:11, minutes:28}),
   selectHoursFromDuration: duration({days:4, hours:11, minutes:28}).hours,
   decimalAsPeriod:  duration({seconds: 30.5}),
   addNegativeValue: duration({ minutes : 1 }) + duration({ seconds : -1 })
}
```

#### Output

```Json
{
   "dayAfterDateTime": "2020-10-06T20:22:34.385Z",
   "dayAndHourBeforeDateTime": "2020-10-04T19:22:34.385Z",
   "pointInTimeBefore": "2020-10-04T19:02:24.385Z",
   "emptyDuration": "PT0S",
   "constructDuration": "PT107H28M",
   "selectHoursFromDuration": 11,
   "decimalAsPeriod": "PT30.5S",
   "addNegativeValue": 59
}
```

<!-- document id=c99386ea7282f9f46b469ba2398d00415f5d2d412f00381f76512e965d569ea8 url=/mulesoft/current/en-us/dataweave/2.6/dw-timer-functions-duration.md -->

---
product: DataWeave
version: 2.6
---

# duration

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## duration<T>(valueToMeasure: () -> T): DurationMeasurement<T>

Executes the input function and returns an object with execution time in milliseconds and result of
that function.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>valueToMeasure</code></p></td><td><p>A function to pass to <code>duration</code>.</p></td></tr></tbody></table>

### Example

This example passes a `wait` function (defined in the header), which returns the execution time and
result of that function in a `DurationMeasurement` object.

#### Source

```Dataweave
%dw 2.0
output application/json
fun myFunction() = dw::Runtime::wait("My result",100)
---
dw::util::Timer::duration(() -> myFunction())
```

#### Output

```XML
{
  "time": 101,
  "result": "My result"
}
```

<!-- document id=592151ae2e689eb9105a2978be818245dfa4735c1b252fb23ae6b8328b8c7566 url=/mulesoft/current/en-us/dataweave/2.9/dw-periods-functions-duration.md -->

---
product: DataWeave
version: 2.9
---

# duration

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## duration(period: { days?: Number, hours?: Number, minutes?: Number, seconds?: Number }): Period

Creates a Period value that represents a number of days, hours, minutes, or seconds.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>period</code></p></td><td><p>An object such as <code>{days:4, hours:11, minutes:45, seconds: 55}</code>. The key-value pairs are optional and can be specified in any order. An empty object (<code>{}</code>) returns the Period value <code>"PT0S"</code> (zero seconds). The default value of each key is <code>0</code>. Valid values are whole or decimal numbers, which can be positive or negative. Key names are selectable.</p></td></tr></tbody></table>

### Example

This example shows how `duration` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Periods
output application/json
---
{
   dayAfterDateTime: |2020-10-05T20:22:34.385Z| + duration({days: 1}),
   dayAndHourBeforeDateTime: |2020-10-05T20:22:34.385Z| - duration({days: 1, hours: 1}),
   pointInTimeBefore: |2020-10-05T20:22:34.385Z| - duration({days: 1, hours: 1, minutes: 20, seconds: 10}),
   emptyDuration: duration({}),
   constructDuration: duration({days:4, hours:11, minutes:28}),
   selectHoursFromDuration: duration({days:4, hours:11, minutes:28}).hours,
   decimalAsPeriod:  duration({seconds: 30.5}),
   addNegativeValue: duration({ minutes : 1 }) + duration({ seconds : -1 })
}
```

#### Output

```Json
{
   "dayAfterDateTime": "2020-10-06T20:22:34.385Z",
   "dayAndHourBeforeDateTime": "2020-10-04T19:22:34.385Z",
   "pointInTimeBefore": "2020-10-04T19:02:24.385Z",
   "emptyDuration": "PT0S",
   "constructDuration": "PT107H28M",
   "selectHoursFromDuration": 11,
   "decimalAsPeriod": "PT30.5S",
   "addNegativeValue": 59
}
```

<!-- document id=0290fa3621c3234a1f1614daf0a522629cf59f3b698463da54ecbe0f649ec35d url=/mulesoft/current/en-us/dataweave/2.9/dw-timer-functions-duration.md -->

---
product: DataWeave
version: 2.9
---

# duration

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## duration<T>(valueToMeasure: () -> T): DurationMeasurement<T>

Executes the input function and returns an object with execution time in milliseconds and result of
that function.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>valueToMeasure</code></p></td><td><p>A function to pass to <code>duration</code>.</p></td></tr></tbody></table>

### Example

This example passes a `wait` function (defined in the header), which returns the execution time and
result of that function in a `DurationMeasurement` object.

#### Source

```Dataweave
%dw 2.0
output application/json
fun myFunction() = dw::Runtime::wait("My result",100)
---
dw::util::Timer::duration(() -> myFunction())
```

#### Output

```XML
{
  "time": 101,
  "result": "My result"
}
```

<!-- document id=228f02280987b7ebfd1329ac37a0218c0c364e24edc9c2f586684990d17fd8a1 url=/mulesoft/current/en-us/dataweave/latest/dw-periods-functions-duration.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# duration

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## duration(period: { days?: Number, hours?: Number, minutes?: Number, seconds?: Number }): Period

Creates a Period value that represents a number of days, hours, minutes, or seconds.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>period</code></p></td><td><p>An object such as <code>{days:4, hours:11, minutes:45, seconds: 55}</code>. The key-value pairs are optional and can be specified in any order. An empty object (<code>{}</code>) returns the Period value <code>"PT0S"</code> (zero seconds). The default value of each key is <code>0</code>. Valid values are whole or decimal numbers, which can be positive or negative. Key names are selectable.</p></td></tr></tbody></table>

### Example

This example shows how `duration` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Periods
output application/json
---
{
   dayAfterDateTime: |2020-10-05T20:22:34.385Z| + duration({days: 1}),
   dayAndHourBeforeDateTime: |2020-10-05T20:22:34.385Z| - duration({days: 1, hours: 1}),
   pointInTimeBefore: |2020-10-05T20:22:34.385Z| - duration({days: 1, hours: 1, minutes: 20, seconds: 10}),
   emptyDuration: duration({}),
   constructDuration: duration({days:4, hours:11, minutes:28}),
   selectHoursFromDuration: duration({days:4, hours:11, minutes:28}).hours,
   decimalAsPeriod:  duration({seconds: 30.5}),
   addNegativeValue: duration({ minutes : 1 }) + duration({ seconds : -1 })
}
```

#### Output

```Json
{
   "dayAfterDateTime": "2020-10-06T20:22:34.385Z",
   "dayAndHourBeforeDateTime": "2020-10-04T19:22:34.385Z",
   "pointInTimeBefore": "2020-10-04T19:02:24.385Z",
   "emptyDuration": "PT0S",
   "constructDuration": "PT107H28M",
   "selectHoursFromDuration": 11,
   "decimalAsPeriod": "PT30.5S",
   "addNegativeValue": 59
}
```

<!-- document id=8de0b0ae14349997d6bab6a3aa70db93a633b83cee6ead13a5aa8cd086640456 url=/mulesoft/current/en-us/dataweave/latest/dw-timer-functions-duration.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# duration

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## duration<T>(valueToMeasure: () -> T): DurationMeasurement<T>

Executes the input function and returns an object with execution time in milliseconds and result of
that function.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>valueToMeasure</code></p></td><td><p>A function to pass to <code>duration</code>.</p></td></tr></tbody></table>

### Example

This example passes a `wait` function (defined in the header), which returns the execution time and
result of that function in a `DurationMeasurement` object.

#### Source

```Dataweave
%dw 2.0
output application/json
fun myFunction() = dw::Runtime::wait("My result",100)
---
dw::util::Timer::duration(() -> myFunction())
```

#### Output

```XML
{
  "time": 101,
  "result": "My result"
}
```

<!-- document id=c08621f319f0cfdbed2ed16ca151e839b69e0bb73e0ec96d527356a6cad3bb25 url=/mulesoft/current/en-us/dataweave/2.11/dw-test-asserts.md -->

---
product: DataWeave
version: 2.11
---

# dw::test::Asserts

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains the set of core matchers to use in your tests.

## Example

This example validates if a payload is of type `Object`.

### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
payload must beObject()
```

## Functions

### anyOf

#### anyOf(matchers: Array<Matcher<Any>>): Matcher<Any>

Validates that the value satisfies at least one of the given matchers.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>matchers</code></p></td><td><p>The list of matchers to be tested.</p></td></tr></tbody></table>

##### Example

This example shows how to assert that a value must be of type `Object` or `String`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
"A Text" must anyOf(beObject(), beString())
```

### beArray

#### beArray(): Matcher

Validates that a given value is of type `Array`.

##### Example

This example shows how to validate that a value is of type `Array`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
[1, 4, 7] must beArray()
```

### beBlank

#### beBlank(): Matcher<String | Null>

Validates that the `String` value is blank.

##### Example

Validates that the string is empty or has whitespaces.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
"  " must beBlank()
```

### beBoolean

#### beBoolean(): Matcher

Validates that a given value is of type `Boolean`.

##### Example

This example shows how to validate that a value is of type `Boolean`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
true must beBoolean()
```

### beEmpty

#### beEmpty(): Matcher<String | Object | Array | Null>

Validates that the value (of the type `String`, `Object`, or `Array`) is empty.

##### Example

Validates that the array is of size `0`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
[] must beEmpty()
```

### beGreaterThan

#### beGreaterThan(expected: Comparable, inclusive: Boolean = false): Matcher<Comparable>

Validates that the asserted `Comparable` value is greater than the given one.

The value can be equal when using the _inclusive_ argument.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expected</code></p></td><td><p>The number to compare to.</p></td></tr><tr><td><p><code>inclusive</code></p></td><td><p>Specifies if the comparison is inclusive or not (Optional). False by default.</p></td></tr></tbody></table>

##### Example

Expects a `Number` to be greater than `2`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
3 must beGreaterThan(2)
```

##### Example

Expects a number to be greater or equal than `2`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
3 must beGreaterThan(2, true)
```

### beLowerThan

#### beLowerThan(expected: Comparable, inclusive: Boolean = false): Matcher<Comparable>

Validates that the asserted `Comparable` value is less than the given value.

The value can be equal when using the _inclusive_ argument.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expected</code></p></td><td><p>The number to compare to.</p></td></tr><tr><td><p><code>inclusive</code></p></td><td><p>Specifies if the comparison is inclusive or not (Optional). False by default.</p></td></tr></tbody></table>

##### Example

Expects a `Number` to be less than `2`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
1 must beLowerThan(2)
```

##### Example

Expects a `Number` to be less or equal than `2`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
1 must beLowerThan(2, true)
```

### beNull

#### beNull(): Matcher

Validates that a given value is of type `Null`.

##### Example

This example shows how to validate that a value is of type `Null`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
null must beNull()
```

### beNumber

#### beNumber(): Matcher

Validates that a given value is of type `Number`.

##### Example

This example shows how to validate that a value is of type `Number`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
123 must beNumber()
```

### beObject

#### beObject(): Matcher

Validates that a given value is of type `Object`.

##### Example

This example shows how to validate that a value is of type `Object`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
{ name : "Lionel", lastName: "Messi"} must beObject()
```

### beOneOf

#### beOneOf(expected: Array<Any>): Matcher

Validates that the value is contained in the given array.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expected</code></p></td><td><p>The array of expected elements.</p></td></tr></tbody></table>

##### Example

Asserts that the value is either `1` or "A Text" or `true`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
1 must beOneOf([1, "A Text", true])
```

### beString

#### beString(): Matcher

Validates that a given value is of type `String`.

##### Example

This example shows how to validate that a value is of type `String`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
"A Text" must beString()
```

### contain

#### contain(expected: String): Matcher<String>

Validates that the asserted string contains the given string.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expected</code></p></td><td><p>The text expected to be contained within the input string.</p></td></tr></tbody></table>

##### Example

Expects the value to contain the `String` value "ex".

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
"A Text" must contain("ex")
```

#### contain(expected: Any): Matcher<Array<Any>>

Validates that the asserted array contains the given value.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expected</code></p></td><td><p>The value expected to be in the array.</p></td></tr></tbody></table>

##### Example

Expects the `Array` value to contain the `Number` value 1.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
[1, "A Text", true] must contain(1)
```

### eachItem

#### eachItem(matcher: Matcher<Any>): Matcher<Array<Any>>

Validates that each item of the array satisfies the given matcher.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>matcher</code></p></td><td><p>The matcher to apply to all the elements.</p></td></tr></tbody></table>

##### Example

Expects all the elements in the array to be a number.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
[1,2,3] must eachItem(beNumber())
```

### endWith

#### endWith(expected: String): Matcher<String>

Validates that the asserted `String` value ends with the given string.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expected</code></p></td><td><p>Suffix of the 'String' value.</p></td></tr></tbody></table>

##### Example

Expects the `String` value to end with "xt".

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
"A Text" must endWith("xt")
```

### equalTo

#### equalTo(expected: Any, equalToConfig: { unordered?: Boolean } = {}): Matcher<Any>

Validates that a value is equal to another one.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expected</code></p></td><td><p>The expected value.</p></td></tr><tr><td><p><code>equalToConfig</code></p></td><td><p>Configuration of how to compare them.</p></td></tr></tbody></table>

##### Example

This example shows how to assert that a value must be `equal` to `3`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
(1 + 2) must equalTo(3)
```

### equalToResource

#### equalToResource(resourceName: String, contentType: String = "application/dw", readerProperties: Object = {}): Matcher<Any>

Validates that the given value is equal to the content of a resource file.

The resource file must belong to the classpath.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>resourceName</code></p></td><td><p>The resource name.</p></td></tr><tr><td><p><code>contentType</code></p></td><td><p>The content type of the resource (Optional).</p></td></tr><tr><td><p><code>readerProperties</code></p></td><td><p>An object with the configuration properties (Optional).</p></td></tr></tbody></table>

##### Example

Expects a value to be equal to the content of the resource `user.json`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
{ name: "Lionel", lastName: "Messi" } must equalToResource("user.json", "application/json")
```

### haveItem

#### haveItem(matcher: Matcher<Any>): Matcher<Array<Any>>

Validates that at least one item of the array satisfies the given matcher.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>matcher</code></p></td><td><p>The matcher to apply to at least one of the elements.</p></td></tr></tbody></table>

##### Example

Expects that one element of the array is a number.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
[1, true, "a text"] must haveItem(beNumber())
```

### haveKey

#### haveKey(keyName: String): Matcher<Object>

Validates that the object has the given key.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>keyName</code></p></td><td><p>The name of the key to expect to be present.</p></td></tr></tbody></table>

##### Example

Validates that the `Object` contains a key called "name".

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
{ name: "Lionel", lastName: "Messi" } must haveKey("name")
```

### haveSize

#### haveSize(expectedSize: Number): Matcher<Array | String | Object | Null>

Validates that the array has the given size.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expectedSize</code></p></td><td><p>The expected array size</p></td></tr></tbody></table>

##### Example

Expects that the array must be of size `3`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
[1, 4, 7] must haveSize(3)
```

### haveValue

#### haveValue(value: Any): Matcher<Object>

Validates that the Object has the given value.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The value that is expected to be present</p></td></tr></tbody></table>

##### Example

Expected that the `Object` contains the value "Messi".

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
{ name: "Lionel", lastName: "Messi" } must haveValue("Messi")
```

### must

#### must<T>(value: T, matchExpressions: Array<(value: T) → Matcher<T> | MatcherResult | Boolean>): MatcherResult

This function enables you to assert a value with with a list of matchers or expressions.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td></td></tr><tr><td><p><code>matchExpressions</code></p></td><td></td></tr></tbody></table>

##### Example

This example shows how to assert that a `payload` is of type `Object` and has a property `foo` that
is `null`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
payload must [
    beObject(),
    $.foo is Null
]
```

#### must<T>(value: T, matcher: (value: T) → Matcher<T> | Boolean): MatcherResult

This function enables you to assert a value with a matcher of expressions.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The value to assert.</p></td></tr><tr><td><p><code>matcher</code></p></td><td><p>The matcher to use.</p></td></tr></tbody></table>

##### Example

This example shows how to assert that a `payload` is of type `Object`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
payload must beObject()
```

### notBe

#### notBe<T>(matcher: Matcher<T>): Matcher<T>

Validates that the value doesn’t satisfy the given matcher.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>matcher</code></p></td><td><p>The matcher to negate.</p></td></tr></tbody></table>

##### Example

This example shows how to assert that a value mustn’t be equal to 2.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
1 must notBe(equalTo(2))
```

### notBeNull

#### notBeNull(): Matcher

Validates that a given value isn’t of type `Null`.

##### Example

This example shows how to validate that a value isn’t of type `Null`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
"A Text" must notBeNull()
```

### startWith

#### startWith(expected: String): Matcher<String>

Validates that the asserted string starts with the given `String` value.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expected</code></p></td><td><p>Prefix of the 'String' value.</p></td></tr></tbody></table>

##### Example

Validates that the string starts with "A".

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
"A Text" must startWith("A")
```

## Variables

### MATCHED

Constant that represents a successful match.

## Types

### Matcher

Data type that represents a matcher to perform assertions.

#### Example

##### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts

fun beEqualToOne(): Matcher<Any> =
    (actual) -> do {
        {
            matches: actual == 1,
            description: { expected: "To be 1", actual: write(actual) as String }
        }
    }
```

Definition

```DataWeave
(value: T) -> MatcherResult
```

### MatcherResult

Data Type that represents the result of an assertion.

#### Example

##### Source

```DataWeave
{
  "matches": false,
  description : { expected : "Number type", actual: "A Text" }
}
```

Definition

```DataWeave
{ matches: Boolean, description: { expected: String, actual: String }, reasons?: Array<String> }
```

<!-- document id=0662fc3f73980318fd55c919c315680e72a266894468316d31a6a8a35dafa68d url=/mulesoft/current/en-us/dataweave/2.12/dw-test-asserts.md -->

---
product: DataWeave
version: 2.12
---

# dw::test::Asserts

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains the set of core matchers to use in your tests.

## Example

This example validates if a payload is of type `Object`.

### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
payload must beObject()
```

## Functions

### anyOf

#### anyOf(matchers: Array<Matcher<Any>>): Matcher<Any>

Validates that the value satisfies at least one of the given matchers.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>matchers</code></p></td><td><p>The list of matchers to be tested.</p></td></tr></tbody></table>

##### Example

This example shows how to assert that a value must be of type `Object` or `String`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
"A Text" must anyOf(beObject(), beString())
```

### beArray

#### beArray(): Matcher

Validates that a given value is of type `Array`.

##### Example

This example shows how to validate that a value is of type `Array`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
[1, 4, 7] must beArray()
```

### beBlank

#### beBlank(): Matcher<String | Null>

Validates that the `String` value is blank.

##### Example

Validates that the string is empty or has whitespaces.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
"  " must beBlank()
```

### beBoolean

#### beBoolean(): Matcher

Validates that a given value is of type `Boolean`.

##### Example

This example shows how to validate that a value is of type `Boolean`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
true must beBoolean()
```

### beEmpty

#### beEmpty(): Matcher<String | Object | Array | Null>

Validates that the value (of the type `String`, `Object`, or `Array`) is empty.

##### Example

Validates that the array is of size `0`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
[] must beEmpty()
```

### beGreaterThan

#### beGreaterThan(expected: Comparable, inclusive: Boolean = false): Matcher<Comparable>

Validates that the asserted `Comparable` value is greater than the given one.

The value can be equal when using the _inclusive_ argument.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expected</code></p></td><td><p>The number to compare to.</p></td></tr><tr><td><p><code>inclusive</code></p></td><td><p>Specifies if the comparison is inclusive or not (Optional). False by default.</p></td></tr></tbody></table>

##### Example

Expects a `Number` to be greater than `2`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
3 must beGreaterThan(2)
```

##### Example

Expects a number to be greater or equal than `2`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
3 must beGreaterThan(2, true)
```

### beLowerThan

#### beLowerThan(expected: Comparable, inclusive: Boolean = false): Matcher<Comparable>

Validates that the asserted `Comparable` value is less than the given value.

The value can be equal when using the _inclusive_ argument.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expected</code></p></td><td><p>The number to compare to.</p></td></tr><tr><td><p><code>inclusive</code></p></td><td><p>Specifies if the comparison is inclusive or not (Optional). False by default.</p></td></tr></tbody></table>

##### Example

Expects a `Number` to be less than `2`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
1 must beLowerThan(2)
```

##### Example

Expects a `Number` to be less or equal than `2`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
1 must beLowerThan(2, true)
```

### beNull

#### beNull(): Matcher

Validates that a given value is of type `Null`.

##### Example

This example shows how to validate that a value is of type `Null`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
null must beNull()
```

### beNumber

#### beNumber(): Matcher

Validates that a given value is of type `Number`.

##### Example

This example shows how to validate that a value is of type `Number`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
123 must beNumber()
```

### beObject

#### beObject(): Matcher

Validates that a given value is of type `Object`.

##### Example

This example shows how to validate that a value is of type `Object`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
{ name : "Lionel", lastName: "Messi"} must beObject()
```

### beOneOf

#### beOneOf(expected: Array<Any>): Matcher

Validates that the value is contained in the given array.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expected</code></p></td><td><p>The array of expected elements.</p></td></tr></tbody></table>

##### Example

Asserts that the value is either `1` or "A Text" or `true`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
1 must beOneOf([1, "A Text", true])
```

### beString

#### beString(): Matcher

Validates that a given value is of type `String`.

##### Example

This example shows how to validate that a value is of type `String`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
"A Text" must beString()
```

### contain

#### contain(expected: String): Matcher<String>

Validates that the asserted string contains the given string.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expected</code></p></td><td><p>The text expected to be contained within the input string.</p></td></tr></tbody></table>

##### Example

Expects the value to contain the `String` value "ex".

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
"A Text" must contain("ex")
```

#### contain(expected: Any): Matcher<Array<Any>>

Validates that the asserted array contains the given value.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expected</code></p></td><td><p>The value expected to be in the array.</p></td></tr></tbody></table>

##### Example

Expects the `Array` value to contain the `Number` value 1.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
[1, "A Text", true] must contain(1)
```

### eachItem

#### eachItem(matcher: Matcher<Any>): Matcher<Array<Any>>

Validates that each item of the array satisfies the given matcher.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>matcher</code></p></td><td><p>The matcher to apply to all the elements.</p></td></tr></tbody></table>

##### Example

Expects all the elements in the array to be a number.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
[1,2,3] must eachItem(beNumber())
```

### endWith

#### endWith(expected: String): Matcher<String>

Validates that the asserted `String` value ends with the given string.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expected</code></p></td><td><p>Suffix of the 'String' value.</p></td></tr></tbody></table>

##### Example

Expects the `String` value to end with "xt".

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
"A Text" must endWith("xt")
```

### equalTo

#### equalTo(expected: Any, equalToConfig: { unordered?: Boolean } = {}): Matcher<Any>

Validates that a value is equal to another one.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expected</code></p></td><td><p>The expected value.</p></td></tr><tr><td><p><code>equalToConfig</code></p></td><td><p>Configuration of how to compare them.</p></td></tr></tbody></table>

##### Example

This example shows how to assert that a value must be `equal` to `3`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
(1 + 2) must equalTo(3)
```

### equalToResource

#### equalToResource(resourceName: String, contentType: String = "application/dw", readerProperties: Object = {}): Matcher<Any>

Validates that the given value is equal to the content of a resource file.

The resource file must belong to the classpath.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>resourceName</code></p></td><td><p>The resource name.</p></td></tr><tr><td><p><code>contentType</code></p></td><td><p>The content type of the resource (Optional).</p></td></tr><tr><td><p><code>readerProperties</code></p></td><td><p>An object with the configuration properties (Optional).</p></td></tr></tbody></table>

##### Example

Expects a value to be equal to the content of the resource `user.json`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
{ name: "Lionel", lastName: "Messi" } must equalToResource("user.json", "application/json")
```

### haveItem

#### haveItem(matcher: Matcher<Any>): Matcher<Array<Any>>

Validates that at least one item of the array satisfies the given matcher.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>matcher</code></p></td><td><p>The matcher to apply to at least one of the elements.</p></td></tr></tbody></table>

##### Example

Expects that one element of the array is a number.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
[1, true, "a text"] must haveItem(beNumber())
```

### haveKey

#### haveKey(keyName: String): Matcher<Object>

Validates that the object has the given key.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>keyName</code></p></td><td><p>The name of the key to expect to be present.</p></td></tr></tbody></table>

##### Example

Validates that the `Object` contains a key called "name".

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
{ name: "Lionel", lastName: "Messi" } must haveKey("name")
```

### haveSize

#### haveSize(expectedSize: Number): Matcher<Array | String | Object | Null>

Validates that the array has the given size.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expectedSize</code></p></td><td><p>The expected array size</p></td></tr></tbody></table>

##### Example

Expects that the array must be of size `3`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
[1, 4, 7] must haveSize(3)
```

### haveValue

#### haveValue(value: Any): Matcher<Object>

Validates that the Object has the given value.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The value that is expected to be present</p></td></tr></tbody></table>

##### Example

Expected that the `Object` contains the value "Messi".

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
{ name: "Lionel", lastName: "Messi" } must haveValue("Messi")
```

### must

#### must<T>(value: T, matchExpressions: Array<(value: T) → Matcher<T> | MatcherResult | Boolean>): MatcherResult

This function enables you to assert a value with with a list of matchers or expressions.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td></td></tr><tr><td><p><code>matchExpressions</code></p></td><td></td></tr></tbody></table>

##### Example

This example shows how to assert that a `payload` is of type `Object` and has a property `foo` that
is `null`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
payload must [
    beObject(),
    $.foo is Null
]
```

#### must<T>(value: T, matcher: (value: T) → Matcher<T> | Boolean): MatcherResult

This function enables you to assert a value with a matcher of expressions.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The value to assert.</p></td></tr><tr><td><p><code>matcher</code></p></td><td><p>The matcher to use.</p></td></tr></tbody></table>

##### Example

This example shows how to assert that a `payload` is of type `Object`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
payload must beObject()
```

### notBe

#### notBe<T>(matcher: Matcher<T>): Matcher<T>

Validates that the value doesn’t satisfy the given matcher.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>matcher</code></p></td><td><p>The matcher to negate.</p></td></tr></tbody></table>

##### Example

This example shows how to assert that a value mustn’t be equal to 2.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
1 must notBe(equalTo(2))
```

### notBeNull

#### notBeNull(): Matcher

Validates that a given value isn’t of type `Null`.

##### Example

This example shows how to validate that a value isn’t of type `Null`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
"A Text" must notBeNull()
```

### startWith

#### startWith(expected: String): Matcher<String>

Validates that the asserted string starts with the given `String` value.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expected</code></p></td><td><p>Prefix of the 'String' value.</p></td></tr></tbody></table>

##### Example

Validates that the string starts with "A".

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
"A Text" must startWith("A")
```

## Variables

### MATCHED

Constant that represents a successful match.

## Types

### Matcher

Data type that represents a matcher to perform assertions.

#### Example

##### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts

fun beEqualToOne(): Matcher<Any> =
    (actual) -> do {
        {
            matches: actual == 1,
            description: { expected: "To be 1", actual: write(actual) as String }
        }
    }
```

Definition

```DataWeave
(value: T) -> MatcherResult
```

### MatcherResult

Data Type that represents the result of an assertion.

#### Example

##### Source

```DataWeave
{
  "matches": false,
  description : { expected : "Number type", actual: "A Text" }
}
```

Definition

```DataWeave
{ matches: Boolean, description: { expected: String, actual: String }, reasons?: Array<String> }
```

<!-- document id=2a4d7bb60ee201d3a1c88691c49b491c71952a35048b0a089108ca46a1861c1c url=/mulesoft/current/en-us/dataweave/2.4/dw-test-asserts.md -->

---
product: DataWeave
version: 2.4
---

# dw::test::Asserts

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains the set of core matchers to use in your tests.

## Example

This example validates if a payload is of type `Object`.

### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
payload must beObject()
```

## Functions

### anyOf

#### anyOf(matchers: Array<Matcher<Any>>): Matcher<Any>

Validates that the value satisfies at least one of the given matchers.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>matchers</code></p></td><td><p>The list of matchers to be tested.</p></td></tr></tbody></table>

##### Example

This example shows how to assert that a value must be of type `Object` or `String`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
"A Text" must anyOf(beObject(), beString())
```

### beArray

#### beArray(): Matcher

Validates that a given value is of type `Array`.

##### Example

This example shows how to validate that a value is of type `Array`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
[1, 4, 7] must beArray()
```

### beBlank

#### beBlank(): Matcher<String | Null>

Validates that the `String` value is blank.

##### Example

Validates that the string is empty or has whitespaces.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
"  " must beBlank()
```

### beBoolean

#### beBoolean(): Matcher

Validates that a given value is of type `Boolean`.

##### Example

This example shows how to validate that a value is of type `Boolean`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
true must beBoolean()
```

### beEmpty

#### beEmpty(): Matcher<String | Object | Array | Null>

Validates that the value (of the type `String`, `Object`, or `Array`) is empty.

##### Example

Validates that the array is of size `0`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
[] must beEmpty()
```

### beGreaterThan

#### beGreaterThan(expected: Comparable, inclusive: Boolean = false): Matcher<Comparable>

Validates that the asserted `Comparable` value is greater than the given one.

The value can be equal when using the _inclusive_ argument.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expected</code></p></td><td><p>The number to compare to.</p></td></tr><tr><td><p><code>inclusive</code></p></td><td><p>Specifies if the comparison is inclusive or not (Optional). False by default.</p></td></tr></tbody></table>

##### Example

Expects a `Number` to be greater than `2`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
3 must beGreaterThan(2)
```

##### Example

Expects a number to be greater or equal than `2`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
3 must beGreaterThan(2, true)
```

### beLowerThan

#### beLowerThan(expected: Comparable, inclusive: Boolean = false): Matcher<Comparable>

Validates that the asserted `Comparable` value is less than the given value.

The value can be equal when using the _inclusive_ argument.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expected</code></p></td><td><p>The number to compare to.</p></td></tr><tr><td><p><code>inclusive</code></p></td><td><p>Specifies if the comparison is inclusive or not (Optional). False by default.</p></td></tr></tbody></table>

##### Example

Expects a `Number` to be less than `2`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
1 must beLowerThan(2)
```

##### Example

Expects a `Number` to be less or equal than `2`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
1 must beLowerThan(2, true)
```

### beNull

#### beNull(): Matcher

Validates that a given value is of type `Null`.

##### Example

This example shows how to validate that a value is of type `Null`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
null must beNull()
```

### beNumber

#### beNumber(): Matcher

Validates that a given value is of type `Number`.

##### Example

This example shows how to validate that a value is of type `Number`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
123 must beNumber()
```

### beObject

#### beObject(): Matcher

Validates that a given value is of type `Object`.

##### Example

This example shows how to validate that a value is of type `Object`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
{ name : "Lionel", lastName: "Messi"} must beObject()
```

### beOneOf

#### beOneOf(expected: Array<Any>): Matcher

Validates that the value is contained in the given array.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expected</code></p></td><td><p>The array of expected elements.</p></td></tr></tbody></table>

##### Example

Asserts that the value is either `1` or "A Text" or `true`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
1 must beOneOf([1, "A Text", true])
```

### beString

#### beString(): Matcher

Validates that a given value is of type `String`.

##### Example

This example shows how to validate that a value is of type `String`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
"A Text" must beString()
```

### contain

#### contain(expected: String): Matcher<String>

Validates that the asserted string contains the given string.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expected</code></p></td><td><p>The text expected to be contained within the input string.</p></td></tr></tbody></table>

##### Example

Expects the value to contain the `String` value "ex".

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
"A Text" must contain("ex")
```

#### contain(expected: Any): Matcher<Array<Any>>

Validates that the asserted array contains the given value.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expected</code></p></td><td><p>The value expected to be in the array.</p></td></tr></tbody></table>

##### Example

Expects the `Array` value to contain the `Number` value 1.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
[1, "A Text", true] must contain(1)
```

### eachItem

#### eachItem(matcher: Matcher<Any>): Matcher<Array<Any>>

Validates that each item of the array satisfies the given matcher.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>matcher</code></p></td><td><p>The matcher to apply to all the elements.</p></td></tr></tbody></table>

##### Example

Expects all the elements in the array to be a number.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
[1,2,3] must eachItem(beNumber())
```

### endWith

#### endWith(expected: String): Matcher<String>

Validates that the asserted `String` value ends with the given string.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expected</code></p></td><td><p>Suffix of the 'String' value.</p></td></tr></tbody></table>

##### Example

Expects the `String` value to end with "xt".

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
"A Text" must endWith("xt")
```

### equalTo

#### equalTo(expected: Any, equalToConfig: { unordered?: Boolean } = {}): Matcher<Any>

Validates that a value is equal to another one.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expected</code></p></td><td><p>The expected value.</p></td></tr><tr><td><p><code>equalToConfig</code></p></td><td><p>Configuration of how to compare them.</p></td></tr></tbody></table>

##### Example

This example shows how to assert that a value must be `equal` to `3`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
(1 + 2) must equalTo(3)
```

### equalToResource

#### equalToResource(resourceName: String, contentType: String = "application/dw", readerProperties: Object = {}): Matcher<Any>

Validates that the given value is equal to the content of a resource file.

The resource file must belong to the classpath.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>resourceName</code></p></td><td><p>The resource name.</p></td></tr><tr><td><p><code>contentType</code></p></td><td><p>The content type of the resource (Optional).</p></td></tr><tr><td><p><code>readerProperties</code></p></td><td><p>An object with the configuration properties (Optional).</p></td></tr></tbody></table>

##### Example

Expects a value to be equal to the content of the resource `user.json`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
{ name: "Lionel", lastName: "Messi" } must equalToResource("user.json", "application/json")
```

### haveItem

#### haveItem(matcher: Matcher<Any>): Matcher<Array<Any>>

Validates that at least one item of the array satisfies the given matcher.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>matcher</code></p></td><td><p>The matcher to apply to at least one of the elements.</p></td></tr></tbody></table>

##### Example

Expects that one element of the array is a number.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
[1, true, "a text"] must haveItem(beNumber())
```

### haveKey

#### haveKey(keyName: String): Matcher<Object>

Validates that the object has the given key.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>keyName</code></p></td><td><p>The name of the key to expect to be present.</p></td></tr></tbody></table>

##### Example

Validates that the `Object` contains a key called "name".

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
{ name: "Lionel", lastName: "Messi" } must haveKey("name")
```

### haveSize

#### haveSize(expectedSize: Number): Matcher<Array | String | Object | Null>

Validates that the array has the given size.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expectedSize</code></p></td><td><p>The expected array size</p></td></tr></tbody></table>

##### Example

Expects that the array must be of size `3`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
[1, 4, 7] must haveSize(3)
```

### haveValue

#### haveValue(value: Any): Matcher<Object>

Validates that the Object has the given value.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The value that is expected to be present</p></td></tr></tbody></table>

##### Example

Expected that the `Object` contains the value "Messi".

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
{ name: "Lionel", lastName: "Messi" } must haveValue("Messi")
```

### must

#### must<T>(value: T, matchExpressions: Array<(value: T) → Matcher<T> | MatcherResult | Boolean>): MatcherResult

This function enables you to assert a value with with a list of matchers or expressions.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td></td></tr><tr><td><p><code>matchExpressions</code></p></td><td></td></tr></tbody></table>

##### Example

This example shows how to assert that a `payload` is of type `Object` and has a property `foo` that
is `null`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
payload must [
    beObject(),
    $.foo is Null
]
```

#### must<T>(value: T, matcher: (value: T) → Matcher<T> | Boolean): MatcherResult

This function enables you to assert a value with a matcher of expressions.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The value to assert.</p></td></tr><tr><td><p><code>matcher</code></p></td><td><p>The matcher to use.</p></td></tr></tbody></table>

##### Example

This example shows how to assert that a `payload` is of type `Object`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
payload must beObject()
```

### notBe

#### notBe<T>(matcher: Matcher<T>): Matcher<T>

Validates that the value doesn’t satisfy the given matcher.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>matcher</code></p></td><td><p>The matcher to negate.</p></td></tr></tbody></table>

##### Example

This example shows how to assert that a value mustn’t be equal to 2.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
1 must notBe(equalTo(2))
```

### notBeNull

#### notBeNull(): Matcher

Validates that a given value isn’t of type `Null`.

##### Example

This example shows how to validate that a value isn’t of type `Null`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
"A Text" must notBeNull()
```

### startWith

#### startWith(expected: String): Matcher<String>

Validates that the asserted string starts with the given `String` value.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expected</code></p></td><td><p>Prefix of the 'String' value.</p></td></tr></tbody></table>

##### Example

Validates that the string starts with "A".

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
"A Text" must startWith("A")
```

## Variables

### MATCHED

Constant that represents a successful match.

## Types

### Matcher

Data type that represents a matcher to perform assertions.

#### Example

##### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts

fun beEqualToOne(): Matcher<Any> =
    (actual) -> do {
        {
            matches: actual == 1,
            description: { expected: "To be 1", actual: write(actual) as String }
        }
    }
```

Definition

```DataWeave
(value: T) -> MatcherResult
```

### MatcherResult

Data Type that represents the result of an assertion.

#### Example

##### Source

```DataWeave
{
  "matches": false,
  description : { expected : "Number type", actual: "A Text" }
}
```

Definition

```DataWeave
{ matches: Boolean, description: { expected: String, actual: String }, reasons?: Array<String> }
```

<!-- document id=87af27c04c5a541795d29c8eb5403311918231910c17e41bbe353750a9b81a13 url=/mulesoft/current/en-us/dataweave/2.6/dw-test-asserts.md -->

---
product: DataWeave
version: 2.6
---

# dw::test::Asserts

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains the set of core matchers to use in your tests.

## Example

This example validates if a payload is of type `Object`.

### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
payload must beObject()
```

## Functions

### anyOf

#### anyOf(matchers: Array<Matcher<Any>>): Matcher<Any>

Validates that the value satisfies at least one of the given matchers.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>matchers</code></p></td><td><p>The list of matchers to be tested.</p></td></tr></tbody></table>

##### Example

This example shows how to assert that a value must be of type `Object` or `String`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
"A Text" must anyOf(beObject(), beString())
```

### beArray

#### beArray(): Matcher

Validates that a given value is of type `Array`.

##### Example

This example shows how to validate that a value is of type `Array`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
[1, 4, 7] must beArray()
```

### beBlank

#### beBlank(): Matcher<String | Null>

Validates that the `String` value is blank.

##### Example

Validates that the string is empty or has whitespaces.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
"  " must beBlank()
```

### beBoolean

#### beBoolean(): Matcher

Validates that a given value is of type `Boolean`.

##### Example

This example shows how to validate that a value is of type `Boolean`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
true must beBoolean()
```

### beEmpty

#### beEmpty(): Matcher<String | Object | Array | Null>

Validates that the value (of the type `String`, `Object`, or `Array`) is empty.

##### Example

Validates that the array is of size `0`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
[] must beEmpty()
```

### beGreaterThan

#### beGreaterThan(expected: Comparable, inclusive: Boolean = false): Matcher<Comparable>

Validates that the asserted `Comparable` value is greater than the given one.

The value can be equal when using the _inclusive_ argument.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expected</code></p></td><td><p>The number to compare to.</p></td></tr><tr><td><p><code>inclusive</code></p></td><td><p>Specifies if the comparison is inclusive or not (Optional). False by default.</p></td></tr></tbody></table>

##### Example

Expects a `Number` to be greater than `2`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
3 must beGreaterThan(2)
```

##### Example

Expects a number to be greater or equal than `2`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
3 must beGreaterThan(2, true)
```

### beLowerThan

#### beLowerThan(expected: Comparable, inclusive: Boolean = false): Matcher<Comparable>

Validates that the asserted `Comparable` value is less than the given value.

The value can be equal when using the _inclusive_ argument.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expected</code></p></td><td><p>The number to compare to.</p></td></tr><tr><td><p><code>inclusive</code></p></td><td><p>Specifies if the comparison is inclusive or not (Optional). False by default.</p></td></tr></tbody></table>

##### Example

Expects a `Number` to be less than `2`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
1 must beLowerThan(2)
```

##### Example

Expects a `Number` to be less or equal than `2`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
1 must beLowerThan(2, true)
```

### beNull

#### beNull(): Matcher

Validates that a given value is of type `Null`.

##### Example

This example shows how to validate that a value is of type `Null`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
null must beNull()
```

### beNumber

#### beNumber(): Matcher

Validates that a given value is of type `Number`.

##### Example

This example shows how to validate that a value is of type `Number`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
123 must beNumber()
```

### beObject

#### beObject(): Matcher

Validates that a given value is of type `Object`.

##### Example

This example shows how to validate that a value is of type `Object`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
{ name : "Lionel", lastName: "Messi"} must beObject()
```

### beOneOf

#### beOneOf(expected: Array<Any>): Matcher

Validates that the value is contained in the given array.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expected</code></p></td><td><p>The array of expected elements.</p></td></tr></tbody></table>

##### Example

Asserts that the value is either `1` or "A Text" or `true`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
1 must beOneOf([1, "A Text", true])
```

### beString

#### beString(): Matcher

Validates that a given value is of type `String`.

##### Example

This example shows how to validate that a value is of type `String`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
"A Text" must beString()
```

### contain

#### contain(expected: String): Matcher<String>

Validates that the asserted string contains the given string.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expected</code></p></td><td><p>The text expected to be contained within the input string.</p></td></tr></tbody></table>

##### Example

Expects the value to contain the `String` value "ex".

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
"A Text" must contain("ex")
```

#### contain(expected: Any): Matcher<Array<Any>>

Validates that the asserted array contains the given value.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expected</code></p></td><td><p>The value expected to be in the array.</p></td></tr></tbody></table>

##### Example

Expects the `Array` value to contain the `Number` value 1.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
[1, "A Text", true] must contain(1)
```

### eachItem

#### eachItem(matcher: Matcher<Any>): Matcher<Array<Any>>

Validates that each item of the array satisfies the given matcher.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>matcher</code></p></td><td><p>The matcher to apply to all the elements.</p></td></tr></tbody></table>

##### Example

Expects all the elements in the array to be a number.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
[1,2,3] must eachItem(beNumber())
```

### endWith

#### endWith(expected: String): Matcher<String>

Validates that the asserted `String` value ends with the given string.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expected</code></p></td><td><p>Suffix of the 'String' value.</p></td></tr></tbody></table>

##### Example

Expects the `String` value to end with "xt".

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
"A Text" must endWith("xt")
```

### equalTo

#### equalTo(expected: Any, equalToConfig: { unordered?: Boolean } = {}): Matcher<Any>

Validates that a value is equal to another one.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expected</code></p></td><td><p>The expected value.</p></td></tr><tr><td><p><code>equalToConfig</code></p></td><td><p>Configuration of how to compare them.</p></td></tr></tbody></table>

##### Example

This example shows how to assert that a value must be `equal` to `3`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
(1 + 2) must equalTo(3)
```

### equalToResource

#### equalToResource(resourceName: String, contentType: String = "application/dw", readerProperties: Object = {}): Matcher<Any>

Validates that the given value is equal to the content of a resource file.

The resource file must belong to the classpath.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>resourceName</code></p></td><td><p>The resource name.</p></td></tr><tr><td><p><code>contentType</code></p></td><td><p>The content type of the resource (Optional).</p></td></tr><tr><td><p><code>readerProperties</code></p></td><td><p>An object with the configuration properties (Optional).</p></td></tr></tbody></table>

##### Example

Expects a value to be equal to the content of the resource `user.json`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
{ name: "Lionel", lastName: "Messi" } must equalToResource("user.json", "application/json")
```

### haveItem

#### haveItem(matcher: Matcher<Any>): Matcher<Array<Any>>

Validates that at least one item of the array satisfies the given matcher.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>matcher</code></p></td><td><p>The matcher to apply to at least one of the elements.</p></td></tr></tbody></table>

##### Example

Expects that one element of the array is a number.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
[1, true, "a text"] must haveItem(beNumber())
```

### haveKey

#### haveKey(keyName: String): Matcher<Object>

Validates that the object has the given key.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>keyName</code></p></td><td><p>The name of the key to expect to be present.</p></td></tr></tbody></table>

##### Example

Validates that the `Object` contains a key called "name".

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
{ name: "Lionel", lastName: "Messi" } must haveKey("name")
```

### haveSize

#### haveSize(expectedSize: Number): Matcher<Array | String | Object | Null>

Validates that the array has the given size.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expectedSize</code></p></td><td><p>The expected array size</p></td></tr></tbody></table>

##### Example

Expects that the array must be of size `3`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
[1, 4, 7] must haveSize(3)
```

### haveValue

#### haveValue(value: Any): Matcher<Object>

Validates that the Object has the given value.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The value that is expected to be present</p></td></tr></tbody></table>

##### Example

Expected that the `Object` contains the value "Messi".

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
{ name: "Lionel", lastName: "Messi" } must haveValue("Messi")
```

### must

#### must<T>(value: T, matchExpressions: Array<(value: T) → Matcher<T> | MatcherResult | Boolean>): MatcherResult

This function enables you to assert a value with with a list of matchers or expressions.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td></td></tr><tr><td><p><code>matchExpressions</code></p></td><td></td></tr></tbody></table>

##### Example

This example shows how to assert that a `payload` is of type `Object` and has a property `foo` that
is `null`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
payload must [
    beObject(),
    $.foo is Null
]
```

#### must<T>(value: T, matcher: (value: T) → Matcher<T> | Boolean): MatcherResult

This function enables you to assert a value with a matcher of expressions.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The value to assert.</p></td></tr><tr><td><p><code>matcher</code></p></td><td><p>The matcher to use.</p></td></tr></tbody></table>

##### Example

This example shows how to assert that a `payload` is of type `Object`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
payload must beObject()
```

### notBe

#### notBe<T>(matcher: Matcher<T>): Matcher<T>

Validates that the value doesn’t satisfy the given matcher.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>matcher</code></p></td><td><p>The matcher to negate.</p></td></tr></tbody></table>

##### Example

This example shows how to assert that a value mustn’t be equal to 2.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
1 must notBe(equalTo(2))
```

### notBeNull

#### notBeNull(): Matcher

Validates that a given value isn’t of type `Null`.

##### Example

This example shows how to validate that a value isn’t of type `Null`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
"A Text" must notBeNull()
```

### startWith

#### startWith(expected: String): Matcher<String>

Validates that the asserted string starts with the given `String` value.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expected</code></p></td><td><p>Prefix of the 'String' value.</p></td></tr></tbody></table>

##### Example

Validates that the string starts with "A".

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
"A Text" must startWith("A")
```

## Variables

### MATCHED

Constant that represents a successful match.

## Types

### Matcher

Data type that represents a matcher to perform assertions.

#### Example

##### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts

fun beEqualToOne(): Matcher<Any> =
    (actual) -> do {
        {
            matches: actual == 1,
            description: { expected: "To be 1", actual: write(actual) as String }
        }
    }
```

Definition

```DataWeave
(value: T) -> MatcherResult
```

### MatcherResult

Data Type that represents the result of an assertion.

#### Example

##### Source

```DataWeave
{
  "matches": false,
  description : { expected : "Number type", actual: "A Text" }
}
```

Definition

```DataWeave
{ matches: Boolean, description: { expected: String, actual: String }, reasons?: Array<String> }
```

<!-- document id=ec9f1bac544ec681da66b5cdea57d02fbb12d2acdaddd90ecb912a537866a07d url=/mulesoft/current/en-us/dataweave/2.9/dw-test-asserts.md -->

---
product: DataWeave
version: 2.9
---

# dw::test::Asserts

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains the set of core matchers to use in your tests.

## Example

This example validates if a payload is of type `Object`.

### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
payload must beObject()
```

## Functions

### anyOf

#### anyOf(matchers: Array<Matcher<Any>>): Matcher<Any>

Validates that the value satisfies at least one of the given matchers.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>matchers</code></p></td><td><p>The list of matchers to be tested.</p></td></tr></tbody></table>

##### Example

This example shows how to assert that a value must be of type `Object` or `String`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
"A Text" must anyOf(beObject(), beString())
```

### beArray

#### beArray(): Matcher

Validates that a given value is of type `Array`.

##### Example

This example shows how to validate that a value is of type `Array`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
[1, 4, 7] must beArray()
```

### beBlank

#### beBlank(): Matcher<String | Null>

Validates that the `String` value is blank.

##### Example

Validates that the string is empty or has whitespaces.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
"  " must beBlank()
```

### beBoolean

#### beBoolean(): Matcher

Validates that a given value is of type `Boolean`.

##### Example

This example shows how to validate that a value is of type `Boolean`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
true must beBoolean()
```

### beEmpty

#### beEmpty(): Matcher<String | Object | Array | Null>

Validates that the value (of the type `String`, `Object`, or `Array`) is empty.

##### Example

Validates that the array is of size `0`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
[] must beEmpty()
```

### beGreaterThan

#### beGreaterThan(expected: Comparable, inclusive: Boolean = false): Matcher<Comparable>

Validates that the asserted `Comparable` value is greater than the given one.

The value can be equal when using the _inclusive_ argument.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expected</code></p></td><td><p>The number to compare to.</p></td></tr><tr><td><p><code>inclusive</code></p></td><td><p>Specifies if the comparison is inclusive or not (Optional). False by default.</p></td></tr></tbody></table>

##### Example

Expects a `Number` to be greater than `2`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
3 must beGreaterThan(2)
```

##### Example

Expects a number to be greater or equal than `2`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
3 must beGreaterThan(2, true)
```

### beLowerThan

#### beLowerThan(expected: Comparable, inclusive: Boolean = false): Matcher<Comparable>

Validates that the asserted `Comparable` value is less than the given value.

The value can be equal when using the _inclusive_ argument.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expected</code></p></td><td><p>The number to compare to.</p></td></tr><tr><td><p><code>inclusive</code></p></td><td><p>Specifies if the comparison is inclusive or not (Optional). False by default.</p></td></tr></tbody></table>

##### Example

Expects a `Number` to be less than `2`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
1 must beLowerThan(2)
```

##### Example

Expects a `Number` to be less or equal than `2`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
1 must beLowerThan(2, true)
```

### beNull

#### beNull(): Matcher

Validates that a given value is of type `Null`.

##### Example

This example shows how to validate that a value is of type `Null`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
null must beNull()
```

### beNumber

#### beNumber(): Matcher

Validates that a given value is of type `Number`.

##### Example

This example shows how to validate that a value is of type `Number`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
123 must beNumber()
```

### beObject

#### beObject(): Matcher

Validates that a given value is of type `Object`.

##### Example

This example shows how to validate that a value is of type `Object`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
{ name : "Lionel", lastName: "Messi"} must beObject()
```

### beOneOf

#### beOneOf(expected: Array<Any>): Matcher

Validates that the value is contained in the given array.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expected</code></p></td><td><p>The array of expected elements.</p></td></tr></tbody></table>

##### Example

Asserts that the value is either `1` or "A Text" or `true`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
1 must beOneOf([1, "A Text", true])
```

### beString

#### beString(): Matcher

Validates that a given value is of type `String`.

##### Example

This example shows how to validate that a value is of type `String`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
"A Text" must beString()
```

### contain

#### contain(expected: String): Matcher<String>

Validates that the asserted string contains the given string.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expected</code></p></td><td><p>The text expected to be contained within the input string.</p></td></tr></tbody></table>

##### Example

Expects the value to contain the `String` value "ex".

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
"A Text" must contain("ex")
```

#### contain(expected: Any): Matcher<Array<Any>>

Validates that the asserted array contains the given value.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expected</code></p></td><td><p>The value expected to be in the array.</p></td></tr></tbody></table>

##### Example

Expects the `Array` value to contain the `Number` value 1.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
[1, "A Text", true] must contain(1)
```

### eachItem

#### eachItem(matcher: Matcher<Any>): Matcher<Array<Any>>

Validates that each item of the array satisfies the given matcher.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>matcher</code></p></td><td><p>The matcher to apply to all the elements.</p></td></tr></tbody></table>

##### Example

Expects all the elements in the array to be a number.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
[1,2,3] must eachItem(beNumber())
```

### endWith

#### endWith(expected: String): Matcher<String>

Validates that the asserted `String` value ends with the given string.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expected</code></p></td><td><p>Suffix of the 'String' value.</p></td></tr></tbody></table>

##### Example

Expects the `String` value to end with "xt".

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
"A Text" must endWith("xt")
```

### equalTo

#### equalTo(expected: Any, equalToConfig: { unordered?: Boolean } = {}): Matcher<Any>

Validates that a value is equal to another one.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expected</code></p></td><td><p>The expected value.</p></td></tr><tr><td><p><code>equalToConfig</code></p></td><td><p>Configuration of how to compare them.</p></td></tr></tbody></table>

##### Example

This example shows how to assert that a value must be `equal` to `3`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
(1 + 2) must equalTo(3)
```

### equalToResource

#### equalToResource(resourceName: String, contentType: String = "application/dw", readerProperties: Object = {}): Matcher<Any>

Validates that the given value is equal to the content of a resource file.

The resource file must belong to the classpath.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>resourceName</code></p></td><td><p>The resource name.</p></td></tr><tr><td><p><code>contentType</code></p></td><td><p>The content type of the resource (Optional).</p></td></tr><tr><td><p><code>readerProperties</code></p></td><td><p>An object with the configuration properties (Optional).</p></td></tr></tbody></table>

##### Example

Expects a value to be equal to the content of the resource `user.json`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
{ name: "Lionel", lastName: "Messi" } must equalToResource("user.json", "application/json")
```

### haveItem

#### haveItem(matcher: Matcher<Any>): Matcher<Array<Any>>

Validates that at least one item of the array satisfies the given matcher.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>matcher</code></p></td><td><p>The matcher to apply to at least one of the elements.</p></td></tr></tbody></table>

##### Example

Expects that one element of the array is a number.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
[1, true, "a text"] must haveItem(beNumber())
```

### haveKey

#### haveKey(keyName: String): Matcher<Object>

Validates that the object has the given key.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>keyName</code></p></td><td><p>The name of the key to expect to be present.</p></td></tr></tbody></table>

##### Example

Validates that the `Object` contains a key called "name".

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
{ name: "Lionel", lastName: "Messi" } must haveKey("name")
```

### haveSize

#### haveSize(expectedSize: Number): Matcher<Array | String | Object | Null>

Validates that the array has the given size.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expectedSize</code></p></td><td><p>The expected array size</p></td></tr></tbody></table>

##### Example

Expects that the array must be of size `3`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
[1, 4, 7] must haveSize(3)
```

### haveValue

#### haveValue(value: Any): Matcher<Object>

Validates that the Object has the given value.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The value that is expected to be present</p></td></tr></tbody></table>

##### Example

Expected that the `Object` contains the value "Messi".

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
{ name: "Lionel", lastName: "Messi" } must haveValue("Messi")
```

### must

#### must<T>(value: T, matchExpressions: Array<(value: T) → Matcher<T> | MatcherResult | Boolean>): MatcherResult

This function enables you to assert a value with with a list of matchers or expressions.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td></td></tr><tr><td><p><code>matchExpressions</code></p></td><td></td></tr></tbody></table>

##### Example

This example shows how to assert that a `payload` is of type `Object` and has a property `foo` that
is `null`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
payload must [
    beObject(),
    $.foo is Null
]
```

#### must<T>(value: T, matcher: (value: T) → Matcher<T> | Boolean): MatcherResult

This function enables you to assert a value with a matcher of expressions.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The value to assert.</p></td></tr><tr><td><p><code>matcher</code></p></td><td><p>The matcher to use.</p></td></tr></tbody></table>

##### Example

This example shows how to assert that a `payload` is of type `Object`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
payload must beObject()
```

### notBe

#### notBe<T>(matcher: Matcher<T>): Matcher<T>

Validates that the value doesn’t satisfy the given matcher.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>matcher</code></p></td><td><p>The matcher to negate.</p></td></tr></tbody></table>

##### Example

This example shows how to assert that a value mustn’t be equal to 2.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
1 must notBe(equalTo(2))
```

### notBeNull

#### notBeNull(): Matcher

Validates that a given value isn’t of type `Null`.

##### Example

This example shows how to validate that a value isn’t of type `Null`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
"A Text" must notBeNull()
```

### startWith

#### startWith(expected: String): Matcher<String>

Validates that the asserted string starts with the given `String` value.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expected</code></p></td><td><p>Prefix of the 'String' value.</p></td></tr></tbody></table>

##### Example

Validates that the string starts with "A".

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
"A Text" must startWith("A")
```

## Variables

### MATCHED

Constant that represents a successful match.

## Types

### Matcher

Data type that represents a matcher to perform assertions.

#### Example

##### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts

fun beEqualToOne(): Matcher<Any> =
    (actual) -> do {
        {
            matches: actual == 1,
            description: { expected: "To be 1", actual: write(actual) as String }
        }
    }
```

Definition

```DataWeave
(value: T) -> MatcherResult
```

### MatcherResult

Data Type that represents the result of an assertion.

#### Example

##### Source

```DataWeave
{
  "matches": false,
  description : { expected : "Number type", actual: "A Text" }
}
```

Definition

```DataWeave
{ matches: Boolean, description: { expected: String, actual: String }, reasons?: Array<String> }
```

<!-- document id=2df70b0942e41724489751bd77f87f68e5030c5fcc1ddacdd881d99ce78bb6e5 url=/mulesoft/current/en-us/dataweave/latest/dw-test-asserts.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# dw::test::Asserts

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains the set of core matchers to use in your tests.

## Example

This example validates if a payload is of type `Object`.

### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
payload must beObject()
```

## Functions

### anyOf

#### anyOf(matchers: Array<Matcher<Any>>): Matcher<Any>

Validates that the value satisfies at least one of the given matchers.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>matchers</code></p></td><td><p>The list of matchers to be tested.</p></td></tr></tbody></table>

##### Example

This example shows how to assert that a value must be of type `Object` or `String`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
"A Text" must anyOf(beObject(), beString())
```

### beArray

#### beArray(): Matcher

Validates that a given value is of type `Array`.

##### Example

This example shows how to validate that a value is of type `Array`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
[1, 4, 7] must beArray()
```

### beBlank

#### beBlank(): Matcher<String | Null>

Validates that the `String` value is blank.

##### Example

Validates that the string is empty or has whitespaces.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
"  " must beBlank()
```

### beBoolean

#### beBoolean(): Matcher

Validates that a given value is of type `Boolean`.

##### Example

This example shows how to validate that a value is of type `Boolean`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
true must beBoolean()
```

### beEmpty

#### beEmpty(): Matcher<String | Object | Array | Null>

Validates that the value (of the type `String`, `Object`, or `Array`) is empty.

##### Example

Validates that the array is of size `0`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
[] must beEmpty()
```

### beGreaterThan

#### beGreaterThan(expected: Comparable, inclusive: Boolean = false): Matcher<Comparable>

Validates that the asserted `Comparable` value is greater than the given one.

The value can be equal when using the _inclusive_ argument.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expected</code></p></td><td><p>The number to compare to.</p></td></tr><tr><td><p><code>inclusive</code></p></td><td><p>Specifies if the comparison is inclusive or not (Optional). False by default.</p></td></tr></tbody></table>

##### Example

Expects a `Number` to be greater than `2`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
3 must beGreaterThan(2)
```

##### Example

Expects a number to be greater or equal than `2`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
3 must beGreaterThan(2, true)
```

### beLowerThan

#### beLowerThan(expected: Comparable, inclusive: Boolean = false): Matcher<Comparable>

Validates that the asserted `Comparable` value is less than the given value.

The value can be equal when using the _inclusive_ argument.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expected</code></p></td><td><p>The number to compare to.</p></td></tr><tr><td><p><code>inclusive</code></p></td><td><p>Specifies if the comparison is inclusive or not (Optional). False by default.</p></td></tr></tbody></table>

##### Example

Expects a `Number` to be less than `2`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
1 must beLowerThan(2)
```

##### Example

Expects a `Number` to be less or equal than `2`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
1 must beLowerThan(2, true)
```

### beNull

#### beNull(): Matcher

Validates that a given value is of type `Null`.

##### Example

This example shows how to validate that a value is of type `Null`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
null must beNull()
```

### beNumber

#### beNumber(): Matcher

Validates that a given value is of type `Number`.

##### Example

This example shows how to validate that a value is of type `Number`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
123 must beNumber()
```

### beObject

#### beObject(): Matcher

Validates that a given value is of type `Object`.

##### Example

This example shows how to validate that a value is of type `Object`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
{ name : "Lionel", lastName: "Messi"} must beObject()
```

### beOneOf

#### beOneOf(expected: Array<Any>): Matcher

Validates that the value is contained in the given array.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expected</code></p></td><td><p>The array of expected elements.</p></td></tr></tbody></table>

##### Example

Asserts that the value is either `1` or "A Text" or `true`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
1 must beOneOf([1, "A Text", true])
```

### beString

#### beString(): Matcher

Validates that a given value is of type `String`.

##### Example

This example shows how to validate that a value is of type `String`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
"A Text" must beString()
```

### contain

#### contain(expected: String): Matcher<String>

Validates that the asserted string contains the given string.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expected</code></p></td><td><p>The text expected to be contained within the input string.</p></td></tr></tbody></table>

##### Example

Expects the value to contain the `String` value "ex".

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
"A Text" must contain("ex")
```

#### contain(expected: Any): Matcher<Array<Any>>

Validates that the asserted array contains the given value.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expected</code></p></td><td><p>The value expected to be in the array.</p></td></tr></tbody></table>

##### Example

Expects the `Array` value to contain the `Number` value 1.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
[1, "A Text", true] must contain(1)
```

### eachItem

#### eachItem(matcher: Matcher<Any>): Matcher<Array<Any>>

Validates that each item of the array satisfies the given matcher.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>matcher</code></p></td><td><p>The matcher to apply to all the elements.</p></td></tr></tbody></table>

##### Example

Expects all the elements in the array to be a number.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
[1,2,3] must eachItem(beNumber())
```

### endWith

#### endWith(expected: String): Matcher<String>

Validates that the asserted `String` value ends with the given string.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expected</code></p></td><td><p>Suffix of the 'String' value.</p></td></tr></tbody></table>

##### Example

Expects the `String` value to end with "xt".

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
"A Text" must endWith("xt")
```

### equalTo

#### equalTo(expected: Any, equalToConfig: { unordered?: Boolean } = {}): Matcher<Any>

Validates that a value is equal to another one.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expected</code></p></td><td><p>The expected value.</p></td></tr><tr><td><p><code>equalToConfig</code></p></td><td><p>Configuration of how to compare them.</p></td></tr></tbody></table>

##### Example

This example shows how to assert that a value must be `equal` to `3`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
(1 + 2) must equalTo(3)
```

### equalToResource

#### equalToResource(resourceName: String, contentType: String = "application/dw", readerProperties: Object = {}): Matcher<Any>

Validates that the given value is equal to the content of a resource file.

The resource file must belong to the classpath.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>resourceName</code></p></td><td><p>The resource name.</p></td></tr><tr><td><p><code>contentType</code></p></td><td><p>The content type of the resource (Optional).</p></td></tr><tr><td><p><code>readerProperties</code></p></td><td><p>An object with the configuration properties (Optional).</p></td></tr></tbody></table>

##### Example

Expects a value to be equal to the content of the resource `user.json`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
{ name: "Lionel", lastName: "Messi" } must equalToResource("user.json", "application/json")
```

### haveItem

#### haveItem(matcher: Matcher<Any>): Matcher<Array<Any>>

Validates that at least one item of the array satisfies the given matcher.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>matcher</code></p></td><td><p>The matcher to apply to at least one of the elements.</p></td></tr></tbody></table>

##### Example

Expects that one element of the array is a number.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
[1, true, "a text"] must haveItem(beNumber())
```

### haveKey

#### haveKey(keyName: String): Matcher<Object>

Validates that the object has the given key.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>keyName</code></p></td><td><p>The name of the key to expect to be present.</p></td></tr></tbody></table>

##### Example

Validates that the `Object` contains a key called "name".

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
{ name: "Lionel", lastName: "Messi" } must haveKey("name")
```

### haveSize

#### haveSize(expectedSize: Number): Matcher<Array | String | Object | Null>

Validates that the array has the given size.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expectedSize</code></p></td><td><p>The expected array size</p></td></tr></tbody></table>

##### Example

Expects that the array must be of size `3`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
[1, 4, 7] must haveSize(3)
```

### haveValue

#### haveValue(value: Any): Matcher<Object>

Validates that the Object has the given value.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The value that is expected to be present</p></td></tr></tbody></table>

##### Example

Expected that the `Object` contains the value "Messi".

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
{ name: "Lionel", lastName: "Messi" } must haveValue("Messi")
```

### must

#### must<T>(value: T, matchExpressions: Array<(value: T) → Matcher<T> | MatcherResult | Boolean>): MatcherResult

This function enables you to assert a value with with a list of matchers or expressions.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td></td></tr><tr><td><p><code>matchExpressions</code></p></td><td></td></tr></tbody></table>

##### Example

This example shows how to assert that a `payload` is of type `Object` and has a property `foo` that
is `null`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
payload must [
    beObject(),
    $.foo is Null
]
```

#### must<T>(value: T, matcher: (value: T) → Matcher<T> | Boolean): MatcherResult

This function enables you to assert a value with a matcher of expressions.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The value to assert.</p></td></tr><tr><td><p><code>matcher</code></p></td><td><p>The matcher to use.</p></td></tr></tbody></table>

##### Example

This example shows how to assert that a `payload` is of type `Object`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
payload must beObject()
```

### notBe

#### notBe<T>(matcher: Matcher<T>): Matcher<T>

Validates that the value doesn’t satisfy the given matcher.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>matcher</code></p></td><td><p>The matcher to negate.</p></td></tr></tbody></table>

##### Example

This example shows how to assert that a value mustn’t be equal to 2.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
1 must notBe(equalTo(2))
```

### notBeNull

#### notBeNull(): Matcher

Validates that a given value isn’t of type `Null`.

##### Example

This example shows how to validate that a value isn’t of type `Null`.

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
"A Text" must notBeNull()
```

### startWith

#### startWith(expected: String): Matcher<String>

Validates that the asserted string starts with the given `String` value.

##### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>expected</code></p></td><td><p>Prefix of the 'String' value.</p></td></tr></tbody></table>

##### Example

Validates that the string starts with "A".

###### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts
---
"A Text" must startWith("A")
```

## Variables

### MATCHED

Constant that represents a successful match.

## Types

### Matcher

Data type that represents a matcher to perform assertions.

#### Example

##### Source

```DataWeave
%dw 2.0
import dw::tests::Asserts

fun beEqualToOne(): Matcher<Any> =
    (actual) -> do {
        {
            matches: actual == 1,
            description: { expected: "To be 1", actual: write(actual) as String }
        }
    }
```

Definition

```DataWeave
(value: T) -> MatcherResult
```

### MatcherResult

Data Type that represents the result of an assertion.

#### Example

##### Source

```DataWeave
{
  "matches": false,
  description : { expected : "Number type", actual: "A Text" }
}
```

Definition

```DataWeave
{ matches: Boolean, description: { expected: String, actual: String }, reasons?: Array<String> }
```

<!-- document id=f0d8dcfe60c1b7f09f6acb340e5743885030cce9715866df469170940d6c203d url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook-map-based-on-an-external-definition.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Dynamically Map Based on a Definition

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You can create a transformation that can dynamically change what it does depending on a definition
input. This DataWeave example receives both a payload input, and a variable named `mappings` that
specifies how to rename each field and what default value to use in each.

The example uses the following:

- A `map` function to go through all of the elements in the input array. Also a second `map`
  function to go through each field in each element.

- A custom function that applies the changes specified in the `mappings` variable.

- `default` to set a default value, that comes from the `mappings` variable.

DataWeave Script:

%dw 2.0 output application/json var applyMapping = (in, mappingsDef) -> ( mappingsDef map (def) -> {
(def.target) : in\[def.source\] default def."default" } )
---

payload.sfdc\_users.\*sfdc\_user map (user) -> ( applyMapping(user, vars.mappings) )

Input XML Payload:

```xml
<sfdc_users>
    <sfdc_user>
      <sfdc_name>Mariano</sfdc_name>
      <sfdc_last_name>Achaval</sfdc_last_name>
      <sfdc_employee>true</sfdc_employee>
    </sfdc_user>
    <sfdc_user>
      <sfdc_name>Julian</sfdc_name>
      <sfdc_last_name>Esevich</sfdc_last_name>
      <sfdc_employee>true</sfdc_employee>
    </sfdc_user>
    <sfdc_user>
      <sfdc_name>Leandro</sfdc_name>
      <sfdc_last_name>Shokida</sfdc_last_name>
    </sfdc_user>
</sfdc_users>
```

Input JSON Mule Event Variable (`vars.mappings`):

```json
[
  {
    "source": "sfdc_name",
    "target": "name",
    "default": "---"
  },
  {
    "source": "sfdc_last_name",
    "target": "lastName",
    "default": "---"
  },
  {
    "source": "sfdc_employee",
    "target": "user",
    "default": true
  }
]
```

Output JSON:

```json
[
  [{ "name": "Mariano" }, { "lastName": "Achaval" }, { "user": "true" }],
  [{ "name": "Julian" }, { "lastName": "Esevich" }, { "user": "true" }],
  [{ "name": "Leandro" }, { "lastName": "Shokida" }, { "user": true }]
]
```

## Related Examples

- [Rename Keys](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-rename-keys)

- [Exclude Fields from the Output](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-exclude-field)

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-output-a-field-when-present)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.11/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook)

<!-- document id=af0365611a9a72f73398985f137cfdb814ff7a8524fb49f9054bdafa8de52c12 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook-map-based-on-an-external-definition.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Dynamically Map Based on a Definition

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You can create a transformation that can dynamically change what it does depending on a definition
input. This DataWeave example receives both a payload input, and a variable named `mappings` that
specifies how to rename each field and what default value to use in each.

The example uses the following:

- A `map` function to go through all of the elements in the input array. Also a second `map`
  function to go through each field in each element.

- A custom function that applies the changes specified in the `mappings` variable.

- `default` to set a default value, that comes from the `mappings` variable.

DataWeave Script:

%dw 2.0 output application/json var applyMapping = (in, mappingsDef) -> ( mappingsDef map (def) -> {
(def.target) : in\[def.source\] default def."default" } )
---

payload.sfdc\_users.\*sfdc\_user map (user) -> ( applyMapping(user, vars.mappings) )

Input XML Payload:

```xml
<sfdc_users>
    <sfdc_user>
      <sfdc_name>Mariano</sfdc_name>
      <sfdc_last_name>Achaval</sfdc_last_name>
      <sfdc_employee>true</sfdc_employee>
    </sfdc_user>
    <sfdc_user>
      <sfdc_name>Julian</sfdc_name>
      <sfdc_last_name>Esevich</sfdc_last_name>
      <sfdc_employee>true</sfdc_employee>
    </sfdc_user>
    <sfdc_user>
      <sfdc_name>Leandro</sfdc_name>
      <sfdc_last_name>Shokida</sfdc_last_name>
    </sfdc_user>
</sfdc_users>
```

Input JSON Mule Event Variable (`vars.mappings`):

```json
[
  {
    "source": "sfdc_name",
    "target": "name",
    "default": "---"
  },
  {
    "source": "sfdc_last_name",
    "target": "lastName",
    "default": "---"
  },
  {
    "source": "sfdc_employee",
    "target": "user",
    "default": true
  }
]
```

Output JSON:

```json
[
  [{ "name": "Mariano" }, { "lastName": "Achaval" }, { "user": "true" }],
  [{ "name": "Julian" }, { "lastName": "Esevich" }, { "user": "true" }],
  [{ "name": "Leandro" }, { "lastName": "Shokida" }, { "user": true }]
]
```

## Related Examples

- [Rename Keys](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-rename-keys)

- [Exclude Fields from the Output](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-exclude-field)

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-output-a-field-when-present)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.12/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook)

<!-- document id=36eda6d4d0285c9ef5736d5bf72fb7afc445e15654e6997e8d8bfc99b67510fc url=/mulesoft/current/en-us/dataweave/2.3/dataweave-cookbook-map-based-on-an-external-definition.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Dynamically Map Based on a Definition

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You can create a transformation that can dynamically change what it does depending on a definition
input. This DataWeave example receives both a payload input, and a variable named `mappings` that
specifies how to rename each field and what default value to use in each.

The example uses the following:

- A `map` function to go through all of the elements in the input array. Also a second `map`
  function to go through each field in each element.

- A custom function that applies the changes specified in the `mappings` variable.

- `default` to set a default value, that comes from the `mappings` variable.

DataWeave Script:

%dw 2.0 output application/json var applyMapping = (in, mappingsDef) -> ( mappingsDef map (def) -> {
(def.target) : in\[def.source\] default def."default" } )
---

payload.sfdc\_users.\*sfdc\_user map (user) -> ( applyMapping(user, vars.mappings) )

Input XML Payload:

```xml
<sfdc_users>
    <sfdc_user>
      <sfdc_name>Mariano</sfdc_name>
      <sfdc_last_name>Achaval</sfdc_last_name>
      <sfdc_employee>true</sfdc_employee>
    </sfdc_user>
    <sfdc_user>
      <sfdc_name>Julian</sfdc_name>
      <sfdc_last_name>Esevich</sfdc_last_name>
      <sfdc_employee>true</sfdc_employee>
    </sfdc_user>
    <sfdc_user>
      <sfdc_name>Leandro</sfdc_name>
      <sfdc_last_name>Shokida</sfdc_last_name>
    </sfdc_user>
</sfdc_users>
```

Input JSON Mule Event Variable (`vars.mappings`):

```json
[
  {
    "source": "sfdc_name",
    "target": "name",
    "default": "---"
  },
  {
    "source": "sfdc_last_name",
    "target": "lastName",
    "default": "---"
  },
  {
    "source": "sfdc_employee",
    "target": "user",
    "default": true
  }
]
```

Output JSON:

```json
[
  [{ "name": "Mariano" }, { "lastName": "Achaval" }, { "user": "true" }],
  [{ "name": "Julian" }, { "lastName": "Esevich" }, { "user": "true" }],
  [{ "name": "Leandro" }, { "lastName": "Shokida" }, { "user": true }]
]
```

## Related Examples

- [Rename Keys](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-rename-keys)

- [Exclude Fields from the Output](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-exclude-field)

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-output-a-field-when-present)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.3/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook)

<!-- document id=a3ab2ebbcdf186f57d450f97bf90e8cdb9207902af361cfb4fb59725b1f352bd url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook-map-based-on-an-external-definition.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Dynamically Map Based on a Definition

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You can create a transformation that can dynamically change what it does depending on a definition
input. This DataWeave example receives both a payload input, and a variable named `mappings` that
specifies how to rename each field and what default value to use in each.

The example uses the following:

- A `map` function to go through all of the elements in the input array. Also a second `map`
  function to go through each field in each element.

- A custom function that applies the changes specified in the `mappings` variable.

- `default` to set a default value, that comes from the `mappings` variable.

DataWeave Script:

%dw 2.0 output application/json var applyMapping = (in, mappingsDef) -> ( mappingsDef map (def) -> {
(def.target) : in\[def.source\] default def."default" } )
---

payload.sfdc\_users.\*sfdc\_user map (user) -> ( applyMapping(user, vars.mappings) )

Input XML Payload:

```xml
<sfdc_users>
    <sfdc_user>
      <sfdc_name>Mariano</sfdc_name>
      <sfdc_last_name>Achaval</sfdc_last_name>
      <sfdc_employee>true</sfdc_employee>
    </sfdc_user>
    <sfdc_user>
      <sfdc_name>Julian</sfdc_name>
      <sfdc_last_name>Esevich</sfdc_last_name>
      <sfdc_employee>true</sfdc_employee>
    </sfdc_user>
    <sfdc_user>
      <sfdc_name>Leandro</sfdc_name>
      <sfdc_last_name>Shokida</sfdc_last_name>
    </sfdc_user>
</sfdc_users>
```

Input JSON Mule Event Variable (`vars.mappings`):

```json
[
  {
    "source": "sfdc_name",
    "target": "name",
    "default": "---"
  },
  {
    "source": "sfdc_last_name",
    "target": "lastName",
    "default": "---"
  },
  {
    "source": "sfdc_employee",
    "target": "user",
    "default": true
  }
]
```

Output JSON:

```json
[
  [{ "name": "Mariano" }, { "lastName": "Achaval" }, { "user": "true" }],
  [{ "name": "Julian" }, { "lastName": "Esevich" }, { "user": "true" }],
  [{ "name": "Leandro" }, { "lastName": "Shokida" }, { "user": true }]
]
```

## Related Examples

- [Rename Keys](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-rename-keys)

- [Exclude Fields from the Output](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-exclude-field)

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-output-a-field-when-present)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.4/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook)

<!-- document id=92c2bf3fbc9e8a6d3aa1ed4b413e50572fe527f0346c877daf0229f8659a1dea url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook-map-based-on-an-external-definition.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Dynamically Map Based on a Definition

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You can create a transformation that can dynamically change what it does depending on a definition
input. This DataWeave example receives both a payload input, and a variable named `mappings` that
specifies how to rename each field and what default value to use in each.

The example uses the following:

- A `map` function to go through all of the elements in the input array. Also a second `map`
  function to go through each field in each element.

- A custom function that applies the changes specified in the `mappings` variable.

- `default` to set a default value, that comes from the `mappings` variable.

DataWeave Script:

%dw 2.0 output application/json var applyMapping = (in, mappingsDef) -> ( mappingsDef map (def) -> {
(def.target) : in\[def.source\] default def."default" } )
---

payload.sfdc\_users.\*sfdc\_user map (user) -> ( applyMapping(user, vars.mappings) )

Input XML Payload:

```xml
<sfdc_users>
    <sfdc_user>
      <sfdc_name>Mariano</sfdc_name>
      <sfdc_last_name>Achaval</sfdc_last_name>
      <sfdc_employee>true</sfdc_employee>
    </sfdc_user>
    <sfdc_user>
      <sfdc_name>Julian</sfdc_name>
      <sfdc_last_name>Esevich</sfdc_last_name>
      <sfdc_employee>true</sfdc_employee>
    </sfdc_user>
    <sfdc_user>
      <sfdc_name>Leandro</sfdc_name>
      <sfdc_last_name>Shokida</sfdc_last_name>
    </sfdc_user>
</sfdc_users>
```

Input JSON Mule Event Variable (`vars.mappings`):

```json
[
  {
    "source": "sfdc_name",
    "target": "name",
    "default": "---"
  },
  {
    "source": "sfdc_last_name",
    "target": "lastName",
    "default": "---"
  },
  {
    "source": "sfdc_employee",
    "target": "user",
    "default": true
  }
]
```

Output JSON:

```json
[
  [{ "name": "Mariano" }, { "lastName": "Achaval" }, { "user": "true" }],
  [{ "name": "Julian" }, { "lastName": "Esevich" }, { "user": "true" }],
  [{ "name": "Leandro" }, { "lastName": "Shokida" }, { "user": true }]
]
```

## Related Examples

- [Rename Keys](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-rename-keys)

- [Exclude Fields from the Output](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-exclude-field)

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-output-a-field-when-present)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.6/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook)

<!-- document id=9588d79cbe6358d65b29421cef819cc66f4ec1270e4e3a72c5fafc5f2216bb5e url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook-map-based-on-an-external-definition.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Dynamically Map Based on a Definition

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You can create a transformation that can dynamically change what it does depending on a definition
input. This DataWeave example receives both a payload input, and a variable named `mappings` that
specifies how to rename each field and what default value to use in each.

The example uses the following:

- A `map` function to go through all of the elements in the input array. Also a second `map`
  function to go through each field in each element.

- A custom function that applies the changes specified in the `mappings` variable.

- `default` to set a default value, that comes from the `mappings` variable.

DataWeave Script:

%dw 2.0 output application/json var applyMapping = (in, mappingsDef) -> ( mappingsDef map (def) -> {
(def.target) : in\[def.source\] default def."default" } )
---

payload.sfdc\_users.\*sfdc\_user map (user) -> ( applyMapping(user, vars.mappings) )

Input XML Payload:

```xml
<sfdc_users>
    <sfdc_user>
      <sfdc_name>Mariano</sfdc_name>
      <sfdc_last_name>Achaval</sfdc_last_name>
      <sfdc_employee>true</sfdc_employee>
    </sfdc_user>
    <sfdc_user>
      <sfdc_name>Julian</sfdc_name>
      <sfdc_last_name>Esevich</sfdc_last_name>
      <sfdc_employee>true</sfdc_employee>
    </sfdc_user>
    <sfdc_user>
      <sfdc_name>Leandro</sfdc_name>
      <sfdc_last_name>Shokida</sfdc_last_name>
    </sfdc_user>
</sfdc_users>
```

Input JSON Mule Event Variable (`vars.mappings`):

```json
[
  {
    "source": "sfdc_name",
    "target": "name",
    "default": "---"
  },
  {
    "source": "sfdc_last_name",
    "target": "lastName",
    "default": "---"
  },
  {
    "source": "sfdc_employee",
    "target": "user",
    "default": true
  }
]
```

Output JSON:

```json
[
  [{ "name": "Mariano" }, { "lastName": "Achaval" }, { "user": "true" }],
  [{ "name": "Julian" }, { "lastName": "Esevich" }, { "user": "true" }],
  [{ "name": "Leandro" }, { "lastName": "Shokida" }, { "user": true }]
]
```

## Related Examples

- [Rename Keys](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-rename-keys)

- [Exclude Fields from the Output](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-exclude-field)

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-output-a-field-when-present)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.9/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook)

<!-- document id=7e39e548ec7d8d903ff382a077b0251bf168d63767f9a19e4f26ea9705525330 url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook-map-based-on-an-external-definition.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Dynamically Map Based on a Definition

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You can create a transformation that can dynamically change what it does depending on a definition
input. This DataWeave example receives both a payload input, and a variable named `mappings` that
specifies how to rename each field and what default value to use in each.

The example uses the following:

- A `map` function to go through all of the elements in the input array. Also a second `map`
  function to go through each field in each element.

- A custom function that applies the changes specified in the `mappings` variable.

- `default` to set a default value, that comes from the `mappings` variable.

DataWeave Script:

%dw 2.0 output application/json var applyMapping = (in, mappingsDef) -> ( mappingsDef map (def) -> {
(def.target) : in\[def.source\] default def."default" } )
---

payload.sfdc\_users.\*sfdc\_user map (user) -> ( applyMapping(user, vars.mappings) )

Input XML Payload:

```xml
<sfdc_users>
    <sfdc_user>
      <sfdc_name>Mariano</sfdc_name>
      <sfdc_last_name>Achaval</sfdc_last_name>
      <sfdc_employee>true</sfdc_employee>
    </sfdc_user>
    <sfdc_user>
      <sfdc_name>Julian</sfdc_name>
      <sfdc_last_name>Esevich</sfdc_last_name>
      <sfdc_employee>true</sfdc_employee>
    </sfdc_user>
    <sfdc_user>
      <sfdc_name>Leandro</sfdc_name>
      <sfdc_last_name>Shokida</sfdc_last_name>
    </sfdc_user>
</sfdc_users>
```

Input JSON Mule Event Variable (`vars.mappings`):

```json
[
  {
    "source": "sfdc_name",
    "target": "name",
    "default": "---"
  },
  {
    "source": "sfdc_last_name",
    "target": "lastName",
    "default": "---"
  },
  {
    "source": "sfdc_employee",
    "target": "user",
    "default": true
  }
]
```

Output JSON:

```json
[
  [{ "name": "Mariano" }, { "lastName": "Achaval" }, { "user": "true" }],
  [{ "name": "Julian" }, { "lastName": "Esevich" }, { "user": "true" }],
  [{ "name": "Leandro" }, { "lastName": "Shokida" }, { "user": true }]
]
```

## Related Examples

- [Rename Keys](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-rename-keys)

- [Exclude Fields from the Output](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-exclude-field)

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-output-a-field-when-present)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook)

<!-- document id=07dce69355e628669f68b07c6c5f06ed18e5343c3e7a04dd4dd7a637e48e32f9 url=/mulesoft/current/en-us/dataweave/2.11/dw-url-functions-encodeuri.md -->

---
product: DataWeave
version: 2.11
---

# encodeURI

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## encodeURI(text: String): String

Encodes a URI with UTF-8 escape sequences.

Applies up to four escape sequences for characters composed of two "surrogate" characters. The
function assumes that the URI is a complete URI, so it does not encode reserved characters that have
special meaning.

The function _does not encode these characters_ with UTF-8 escape sequences:

<table><colgroup><col> <col></colgroup><thead><tr><th>Type (not escaped)</th><th>Examples</th></tr></thead><tbody><tr><td><p>Reserved characters</p></td><td><p>; , / ? : @ &amp; = $</p></td></tr><tr><td><p>Unescaped characters</p></td><td><p>alphabetic, decimal digits, - _ . ! ~ * ' ( )</p></td></tr><tr><td><p>Number sign</p></td><td><p>#</p></td></tr></tbody></table>

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The URI to encode.</p></td></tr></tbody></table>

### Example

This example shows encodes spaces in one URL and lists some characters that do not get encoded in
the `not_encoded` string.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::URL
output application/json
---
{
    "encodeURI" : encodeURI("http://asd/ text to decode /%/\"\\/text"),
    "not_encoded": encodeURI("http://:;,/?:@&=\$_-_.!~*'()")
}
```

#### Output

```JSON
{
    "encodeURI": "http://asd/%20text%20to%20decode%20/%25/%22%5C/text",
    "not_encoded": "http://:;,/?:@&=$_-_.!~*'()"
}
```

<!-- document id=698f388885b7c1af48034d06e1447dde8be52352ecfb7bba0059644778f3bbe0 url=/mulesoft/current/en-us/dataweave/2.12/dw-url-functions-encodeuri.md -->

---
product: DataWeave
version: 2.12
---

# encodeURI

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## encodeURI(text: String): String

Encodes a URI with UTF-8 escape sequences.

Applies up to four escape sequences for characters composed of two "surrogate" characters. The
function assumes that the URI is a complete URI, so it does not encode reserved characters that have
special meaning.

The function _does not encode these characters_ with UTF-8 escape sequences:

<table><colgroup><col> <col></colgroup><thead><tr><th>Type (not escaped)</th><th>Examples</th></tr></thead><tbody><tr><td><p>Reserved characters</p></td><td><p>; , / ? : @ &amp; = $</p></td></tr><tr><td><p>Unescaped characters</p></td><td><p>alphabetic, decimal digits, - _ . ! ~ * ' ( )</p></td></tr><tr><td><p>Number sign</p></td><td><p>#</p></td></tr></tbody></table>

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The URI to encode.</p></td></tr></tbody></table>

### Example

This example shows encodes spaces in one URL and lists some characters that do not get encoded in
the `not_encoded` string.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::URL
output application/json
---
{
    "encodeURI" : encodeURI("http://asd/ text to decode /%/\"\\/text"),
    "not_encoded": encodeURI("http://:;,/?:@&=\$_-_.!~*'()")
}
```

#### Output

```JSON
{
    "encodeURI": "http://asd/%20text%20to%20decode%20/%25/%22%5C/text",
    "not_encoded": "http://:;,/?:@&=$_-_.!~*'()"
}
```

<!-- document id=5e9951e46d2de3c190880c4835b2f4a0c573242e6f8cf545c522c7e05e3c182f url=/mulesoft/current/en-us/dataweave/2.3/dw-url-functions-encodeuri.md -->

---
product: DataWeave
version: 2.3
---

# encodeURI

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## encodeURI(String): String

Encodes a URI with UTF-8 escape sequences.

Applies up to four escape sequences for characters composed of two "surrogate" characters. The
function assumes that the URI is a complete URI, so it does not encode reserved characters that have
special meaning.

The function _does not encode these characters_ with UTF-8 escape sequences:

<table><colgroup><col> <col></colgroup><thead><tr><th>Type (not escaped)</th><th>Examples</th></tr></thead><tbody><tr><td><p>Reserved characters</p></td><td><p>; , / ? : @ &amp; = $</p></td></tr><tr><td><p>Unescaped characters</p></td><td><p>alphabetic, decimal digits, - _ . ! ~ * ' ( )</p></td></tr><tr><td><p>Number sign</p></td><td><p>#</p></td></tr></tbody></table>

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The URI to encode.</p></td></tr></tbody></table>

### Example

This example shows encodes spaces in one URL and lists some characters that do not get encoded in
the `not_encoded` string.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::URL
output application/json
---
{
    "encodeURI" : encodeURI("http://asd/ text to decode /text"),
    "not_encoded": encodeURI("http://:;,/?:@&=\$_-_.!~*'()")
}
```

#### Output

```JSON
{
   "encodeURI": "http://asd/%20text%20to%20decode%20/%25/\"\'/text",
   "not_encoded": "http://:;,/?:@&=$_-_.!~*'()"
}
```

<!-- document id=02a458546c8f9c90712a00e7f2519ffe1d3926d59f4fffe0b08d7b4310bbc286 url=/mulesoft/current/en-us/dataweave/2.4/dw-url-functions-encodeuri.md -->

---
product: DataWeave
version: 2.4
---

# encodeURI

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## encodeURI(text: String): String

Encodes a URI with UTF-8 escape sequences.

Applies up to four escape sequences for characters composed of two "surrogate" characters. The
function assumes that the URI is a complete URI, so it does not encode reserved characters that have
special meaning.

The function _does not encode these characters_ with UTF-8 escape sequences:

<table><colgroup><col> <col></colgroup><thead><tr><th>Type (not escaped)</th><th>Examples</th></tr></thead><tbody><tr><td><p>Reserved characters</p></td><td><p>; , / ? : @ &amp; = $</p></td></tr><tr><td><p>Unescaped characters</p></td><td><p>alphabetic, decimal digits, - _ . ! ~ * ' ( )</p></td></tr><tr><td><p>Number sign</p></td><td><p>#</p></td></tr></tbody></table>

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The URI to encode.</p></td></tr></tbody></table>

### Example

This example shows encodes spaces in one URL and lists some characters that do not get encoded in
the `not_encoded` string.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::URL
output application/json
---
{
    "encodeURI" : encodeURI("http://asd/ text to decode /%/\"\\/text"),
    "not_encoded": encodeURI("http://:;,/?:@&=\$_-_.!~*'()")
}
```

#### Output

```JSON
{
  "encodeURI": "http://asd/%20text%20to%20decode%20/%25/%22%5C/text",
  "not_encoded": "http://:;,/?:@&=$_-_.!~*'()"
}
```

<!-- document id=bedb9cf6cbd900f22a42b6d9d61bc6607c4a8af5f0bf3c53cc101272f78de0af url=/mulesoft/current/en-us/dataweave/2.6/dw-url-functions-encodeuri.md -->

---
product: DataWeave
version: 2.6
---

# encodeURI

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## encodeURI(text: String): String

Encodes a URI with UTF-8 escape sequences.

Applies up to four escape sequences for characters composed of two "surrogate" characters. The
function assumes that the URI is a complete URI, so it does not encode reserved characters that have
special meaning.

The function _does not encode these characters_ with UTF-8 escape sequences:

<table><colgroup><col> <col></colgroup><thead><tr><th>Type (not escaped)</th><th>Examples</th></tr></thead><tbody><tr><td><p>Reserved characters</p></td><td><p>; , / ? : @ &amp; = $</p></td></tr><tr><td><p>Unescaped characters</p></td><td><p>alphabetic, decimal digits, - _ . ! ~ * ' ( )</p></td></tr><tr><td><p>Number sign</p></td><td><p>#</p></td></tr></tbody></table>

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The URI to encode.</p></td></tr></tbody></table>

### Example

This example shows encodes spaces in one URL and lists some characters that do not get encoded in
the `not_encoded` string.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::URL
output application/json
---
{
    "encodeURI" : encodeURI("http://asd/ text to decode /%/\"\\/text"),
    "not_encoded": encodeURI("http://:;,/?:@&=\$_-_.!~*'()")
}
```

#### Output

```JSON
{
  "encodeURI": "http://asd/%20text%20to%20decode%20/%25/%22%5C/text",
  "not_encoded": "http://:;,/?:@&=$_-_.!~*'()"
}
```

<!-- document id=c0440ce39a9f8c6a810a0ad41d7c3b70f55f3e83acfc73ddd75fb62c26f0519a url=/mulesoft/current/en-us/dataweave/2.9/dw-url-functions-encodeuri.md -->

---
product: DataWeave
version: 2.9
---

# encodeURI

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## encodeURI(text: String): String

Encodes a URI with UTF-8 escape sequences.

Applies up to four escape sequences for characters composed of two "surrogate" characters. The
function assumes that the URI is a complete URI, so it does not encode reserved characters that have
special meaning.

The function _does not encode these characters_ with UTF-8 escape sequences:

<table><colgroup><col> <col></colgroup><thead><tr><th>Type (not escaped)</th><th>Examples</th></tr></thead><tbody><tr><td><p>Reserved characters</p></td><td><p>; , / ? : @ &amp; = $</p></td></tr><tr><td><p>Unescaped characters</p></td><td><p>alphabetic, decimal digits, - _ . ! ~ * ' ( )</p></td></tr><tr><td><p>Number sign</p></td><td><p>#</p></td></tr></tbody></table>

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The URI to encode.</p></td></tr></tbody></table>

### Example

This example shows encodes spaces in one URL and lists some characters that do not get encoded in
the `not_encoded` string.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::URL
output application/json
---
{
    "encodeURI" : encodeURI("http://asd/ text to decode /%/\"\\/text"),
    "not_encoded": encodeURI("http://:;,/?:@&=\$_-_.!~*'()")
}
```

#### Output

```JSON
{
  "encodeURI": "http://asd/%20text%20to%20decode%20/%25/%22%5C/text",
  "not_encoded": "http://:;,/?:@&=$_-_.!~*'()"
}
```

<!-- document id=faca04d392065f56398ff344922d7c5f03cf1047e14d321deb073d21a771f7ef url=/mulesoft/current/en-us/dataweave/latest/dw-url-functions-encodeuri.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# encodeURI

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## encodeURI(text: String): String

Encodes a URI with UTF-8 escape sequences.

Applies up to four escape sequences for characters composed of two "surrogate" characters. The
function assumes that the URI is a complete URI, so it does not encode reserved characters that have
special meaning.

The function _does not encode these characters_ with UTF-8 escape sequences:

<table><colgroup><col> <col></colgroup><thead><tr><th>Type (not escaped)</th><th>Examples</th></tr></thead><tbody><tr><td><p>Reserved characters</p></td><td><p>; , / ? : @ &amp; = $</p></td></tr><tr><td><p>Unescaped characters</p></td><td><p>alphabetic, decimal digits, - _ . ! ~ * ' ( )</p></td></tr><tr><td><p>Number sign</p></td><td><p>#</p></td></tr></tbody></table>

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The URI to encode.</p></td></tr></tbody></table>

### Example

This example shows encodes spaces in one URL and lists some characters that do not get encoded in
the `not_encoded` string.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::URL
output application/json
---
{
    "encodeURI" : encodeURI("http://asd/ text to decode /%/\"\\/text"),
    "not_encoded": encodeURI("http://:;,/?:@&=\$_-_.!~*'()")
}
```

#### Output

```JSON
{
    "encodeURI": "http://asd/%20text%20to%20decode%20/%25/%22%5C/text",
    "not_encoded": "http://:;,/?:@&=$_-_.!~*'()"
}
```

<!-- document id=fc42eecb927a839ef62a4703f4a124ca053d58e2708ef3d4d8d03fcc3d4cfc97 url=/mulesoft/current/en-us/dataweave/2.11/dw-url-functions-encodeuricomponent.md -->

---
product: DataWeave
version: 2.11
---

# encodeURIComponent

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## encodeURIComponent(text: String): String

Escapes certain characters in a URI component using UTF-8 encoding.

There can be only four escape sequences for characters composed of two "surrogate" \* characters.
`encodeURIComponent` escapes all characters _except the following_: alphabetic, decimal digits,
`- _ . ! ~ * ' ( )`. Note that `encodeURIComponent` differs from `encodeURI` in that it encodes
reserved characters and the Number sign `#` of `encodeURI`:

<table><colgroup><col> <col></colgroup><thead><tr><th>Type</th><th>Includes</th></tr></thead><tbody><tr><td><p>Reserved characters</p></td><td></td></tr><tr><td><p>Unescaped characters</p></td><td><p>alphabetic, decimal digits, - _ . ! ~ * ' ( )</p></td></tr><tr><td><p>Number sign</p></td><td></td></tr></tbody></table>

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>URI component string.</p></td></tr></tbody></table>

### Example

This example encodes a variety of URI components.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::URL
output application/json
---
{
  "comparing_encode_functions_output" : {
  	"encodeURIComponent" : encodeURI(" PATH/ TO /ENCODE "),
  	"encodeURI" : encodeURI(" PATH/ TO /ENCODE "),
  	"encodeURIComponent_to_hex" : encodeURIComponent(";,/?:@&="),
  	"encodeURI_not_to_hex" : encodeURI(";,/?:@&="),
  	"encodeURIComponent_not_encoded" : encodeURIComponent("-_.!~*'()"),
  	"encodeURI_not_encoded" : encodeURI("-_.!~*'()")
  }
}
```

#### Output

```JSON
{
  "comparing_encode_functions_output": {
    "encodeURIComponent": "%20PATH/%20TO%20/ENCODE%20",
    "encodeURI": "%20PATH/%20TO%20/ENCODE%20",
    "encodeURIComponent_to_hex": "%3B%2C%2F%3F%3A%40%26%3D",
    "encodeURI_not_to_hex": ";,/?:@&=",
    "encodeURIComponent_not_encoded": "-_.!~*'()",
    "encodeURI_not_encoded": "-_.!~*'()"
  }
}
```

<!-- document id=bc7ab704105ee629f15e4d80a15d7990cafcea33ca675b25403021ddc578bb5c url=/mulesoft/current/en-us/dataweave/2.12/dw-url-functions-encodeuricomponent.md -->

---
product: DataWeave
version: 2.12
---

# encodeURIComponent

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## encodeURIComponent(text: String): String

Escapes certain characters in a URI component using UTF-8 encoding.

There can be only four escape sequences for characters composed of two "surrogate" \* characters.
`encodeURIComponent` escapes all characters _except the following_: alphabetic, decimal digits,
`- _ . ! ~ * ' ( )`. Note that `encodeURIComponent` differs from `encodeURI` in that it encodes
reserved characters and the Number sign `#` of `encodeURI`:

<table><colgroup><col> <col></colgroup><thead><tr><th>Type</th><th>Includes</th></tr></thead><tbody><tr><td><p>Reserved characters</p></td><td></td></tr><tr><td><p>Unescaped characters</p></td><td><p>alphabetic, decimal digits, - _ . ! ~ * ' ( )</p></td></tr><tr><td><p>Number sign</p></td><td></td></tr></tbody></table>

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>URI component string.</p></td></tr></tbody></table>

### Example

This example encodes a variety of URI components.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::URL
output application/json
---
{
  "comparing_encode_functions_output" : {
  	"encodeURIComponent" : encodeURI(" PATH/ TO /ENCODE "),
  	"encodeURI" : encodeURI(" PATH/ TO /ENCODE "),
  	"encodeURIComponent_to_hex" : encodeURIComponent(";,/?:@&="),
  	"encodeURI_not_to_hex" : encodeURI(";,/?:@&="),
  	"encodeURIComponent_not_encoded" : encodeURIComponent("-_.!~*'()"),
  	"encodeURI_not_encoded" : encodeURI("-_.!~*'()")
  }
}
```

#### Output

```JSON
{
  "comparing_encode_functions_output": {
    "encodeURIComponent": "%20PATH/%20TO%20/ENCODE%20",
    "encodeURI": "%20PATH/%20TO%20/ENCODE%20",
    "encodeURIComponent_to_hex": "%3B%2C%2F%3F%3A%40%26%3D",
    "encodeURI_not_to_hex": ";,/?:@&=",
    "encodeURIComponent_not_encoded": "-_.!~*'()",
    "encodeURI_not_encoded": "-_.!~*'()"
  }
}
```

<!-- document id=ecc6c08b3dadab7110b322c293d52f3fc6c6d9330388732d7b97c687d3656cec url=/mulesoft/current/en-us/dataweave/2.3/dw-url-functions-encodeuricomponent.md -->

---
product: DataWeave
version: 2.3
---

# encodeURIComponent

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## encodeURIComponent(String): String

Escapes certain characters in a URI component using UTF-8 encoding.

There can be only four escape sequences for characters composed of two "surrogate" \* characters.
`encodeURIComponent` escapes all characters _except the following_: alphabetic, decimal digits,
`- _ . ! ~ * ' ( )`. Note that `encodeURIComponent` differs from `encodeURI` in that it encodes
reserved characters and the Number sign `#` of `encodeURI`:

<table><colgroup><col> <col></colgroup><thead><tr><th>Type</th><th>Includes</th></tr></thead><tbody><tr><td><p>Reserved characters</p></td><td></td></tr><tr><td><p>Unescaped characters</p></td><td><p>alphabetic, decimal digits, - _ . ! ~ * ' ( )</p></td></tr><tr><td><p>Number sign</p></td><td></td></tr></tbody></table>

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>URI component string.</p></td></tr></tbody></table>

### Example

This example encodes a variety of URI components.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::URL
output application/json
---
{
  "comparing_encode_functions_output" : {
  	"encodeURIComponent" : encodeURI(" PATH/ TO /ENCODE "),
  	"encodeURI" : encodeURI(" PATH/ TO /ENCODE "),
  	"encodeURIComponent_to_hex" : encodeURIComponent(";,/?:@&="),
  	"encodeURI_not_to_hex" : encodeURI(";,/?:@&="),
  	"encodeURIComponent_not_encoded" : encodeURIComponent("-_.!~*'()"),
  	"encodeURI_not_encoded" : encodeURI("-_.!~*'()")
  }
}
```

#### Output

```JSON
{
  "comparing_encode_functions_output": {
    "encodeURIComponent": "%20PATH/%20TO%20/ENCODE%20",
    "encodeURI": "%20PATH/%20TO%20/ENCODE%20",
    "encodeURIComponent_to_hex": "%3B%2C%2F%3F%3A%40%26%3D",
    "encodeURI_not_to_hex": ";,/?:@&=",
    "encodeURIComponent_not_encoded": "-_.!~*'()",
    "encodeURI_not_encoded": "-_.!~*'()"
  }
}
```

<!-- document id=03bd304a81c3da662dfaef96c1ed2c1d845997a99b135971add8f6b4854c853a url=/mulesoft/current/en-us/dataweave/2.4/dw-url-functions-encodeuricomponent.md -->

---
product: DataWeave
version: 2.4
---

# encodeURIComponent

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## encodeURIComponent(text: String): String

Escapes certain characters in a URI component using UTF-8 encoding.

There can be only four escape sequences for characters composed of two "surrogate" \* characters.
`encodeURIComponent` escapes all characters _except the following_: alphabetic, decimal digits,
`- _ . ! ~ * ' ( )`. Note that `encodeURIComponent` differs from `encodeURI` in that it encodes
reserved characters and the Number sign `#` of `encodeURI`:

<table><colgroup><col> <col></colgroup><thead><tr><th>Type</th><th>Includes</th></tr></thead><tbody><tr><td><p>Reserved characters</p></td><td></td></tr><tr><td><p>Unescaped characters</p></td><td><p>alphabetic, decimal digits, - _ . ! ~ * ' ( )</p></td></tr><tr><td><p>Number sign</p></td><td></td></tr></tbody></table>

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>URI component string.</p></td></tr></tbody></table>

### Example

This example encodes a variety of URI components.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::URL
output application/json
---
{
  "comparing_encode_functions_output" : {
  	"encodeURIComponent" : encodeURI(" PATH/ TO /ENCODE "),
  	"encodeURI" : encodeURI(" PATH/ TO /ENCODE "),
  	"encodeURIComponent_to_hex" : encodeURIComponent(";,/?:@&="),
  	"encodeURI_not_to_hex" : encodeURI(";,/?:@&="),
  	"encodeURIComponent_not_encoded" : encodeURIComponent("-_.!~*'()"),
  	"encodeURI_not_encoded" : encodeURI("-_.!~*'()")
  }
}
```

#### Output

```JSON
{
  "comparing_encode_functions_output": {
    "encodeURIComponent": "%20PATH/%20TO%20/ENCODE%20",
    "encodeURI": "%20PATH/%20TO%20/ENCODE%20",
    "encodeURIComponent_to_hex": "%3B%2C%2F%3F%3A%40%26%3D",
    "encodeURI_not_to_hex": ";,/?:@&=",
    "encodeURIComponent_not_encoded": "-_.!~*'()",
    "encodeURI_not_encoded": "-_.!~*'()"
  }
}
```

<!-- document id=cc802c538c301ce2766b9accf201c13a70ba3be975d5b5f7df1d380e40dfceb4 url=/mulesoft/current/en-us/dataweave/2.6/dw-url-functions-encodeuricomponent.md -->

---
product: DataWeave
version: 2.6
---

# encodeURIComponent

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## encodeURIComponent(text: String): String

Escapes certain characters in a URI component using UTF-8 encoding.

There can be only four escape sequences for characters composed of two "surrogate" \* characters.
`encodeURIComponent` escapes all characters _except the following_: alphabetic, decimal digits,
`- _ . ! ~ * ' ( )`. Note that `encodeURIComponent` differs from `encodeURI` in that it encodes
reserved characters and the Number sign `#` of `encodeURI`:

<table><colgroup><col> <col></colgroup><thead><tr><th>Type</th><th>Includes</th></tr></thead><tbody><tr><td><p>Reserved characters</p></td><td></td></tr><tr><td><p>Unescaped characters</p></td><td><p>alphabetic, decimal digits, - _ . ! ~ * ' ( )</p></td></tr><tr><td><p>Number sign</p></td><td></td></tr></tbody></table>

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>URI component string.</p></td></tr></tbody></table>

### Example

This example encodes a variety of URI components.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::URL
output application/json
---
{
  "comparing_encode_functions_output" : {
  	"encodeURIComponent" : encodeURI(" PATH/ TO /ENCODE "),
  	"encodeURI" : encodeURI(" PATH/ TO /ENCODE "),
  	"encodeURIComponent_to_hex" : encodeURIComponent(";,/?:@&="),
  	"encodeURI_not_to_hex" : encodeURI(";,/?:@&="),
  	"encodeURIComponent_not_encoded" : encodeURIComponent("-_.!~*'()"),
  	"encodeURI_not_encoded" : encodeURI("-_.!~*'()")
  }
}
```

#### Output

```JSON
{
  "comparing_encode_functions_output": {
    "encodeURIComponent": "%20PATH/%20TO%20/ENCODE%20",
    "encodeURI": "%20PATH/%20TO%20/ENCODE%20",
    "encodeURIComponent_to_hex": "%3B%2C%2F%3F%3A%40%26%3D",
    "encodeURI_not_to_hex": ";,/?:@&=",
    "encodeURIComponent_not_encoded": "-_.!~*'()",
    "encodeURI_not_encoded": "-_.!~*'()"
  }
}
```

<!-- document id=bfa85e1788fb132be761c9ef74ae0229ab69f42535fefc6965542476882d2b71 url=/mulesoft/current/en-us/dataweave/2.9/dw-url-functions-encodeuricomponent.md -->

---
product: DataWeave
version: 2.9
---

# encodeURIComponent

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## encodeURIComponent(text: String): String

Escapes certain characters in a URI component using UTF-8 encoding.

There can be only four escape sequences for characters composed of two "surrogate" \* characters.
`encodeURIComponent` escapes all characters _except the following_: alphabetic, decimal digits,
`- _ . ! ~ * ' ( )`. Note that `encodeURIComponent` differs from `encodeURI` in that it encodes
reserved characters and the Number sign `#` of `encodeURI`:

<table><colgroup><col> <col></colgroup><thead><tr><th>Type</th><th>Includes</th></tr></thead><tbody><tr><td><p>Reserved characters</p></td><td></td></tr><tr><td><p>Unescaped characters</p></td><td><p>alphabetic, decimal digits, - _ . ! ~ * ' ( )</p></td></tr><tr><td><p>Number sign</p></td><td></td></tr></tbody></table>

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>URI component string.</p></td></tr></tbody></table>

### Example

This example encodes a variety of URI components.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::URL
output application/json
---
{
  "comparing_encode_functions_output" : {
  	"encodeURIComponent" : encodeURI(" PATH/ TO /ENCODE "),
  	"encodeURI" : encodeURI(" PATH/ TO /ENCODE "),
  	"encodeURIComponent_to_hex" : encodeURIComponent(";,/?:@&="),
  	"encodeURI_not_to_hex" : encodeURI(";,/?:@&="),
  	"encodeURIComponent_not_encoded" : encodeURIComponent("-_.!~*'()"),
  	"encodeURI_not_encoded" : encodeURI("-_.!~*'()")
  }
}
```

#### Output

```JSON
{
  "comparing_encode_functions_output": {
    "encodeURIComponent": "%20PATH/%20TO%20/ENCODE%20",
    "encodeURI": "%20PATH/%20TO%20/ENCODE%20",
    "encodeURIComponent_to_hex": "%3B%2C%2F%3F%3A%40%26%3D",
    "encodeURI_not_to_hex": ";,/?:@&=",
    "encodeURIComponent_not_encoded": "-_.!~*'()",
    "encodeURI_not_encoded": "-_.!~*'()"
  }
}
```

<!-- document id=6b8502600421703bc5261b1033e7fd897f0245571d42b036c10d01f8299571d6 url=/mulesoft/current/en-us/dataweave/latest/dw-url-functions-encodeuricomponent.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# encodeURIComponent

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## encodeURIComponent(text: String): String

Escapes certain characters in a URI component using UTF-8 encoding.

There can be only four escape sequences for characters composed of two "surrogate" \* characters.
`encodeURIComponent` escapes all characters _except the following_: alphabetic, decimal digits,
`- _ . ! ~ * ' ( )`. Note that `encodeURIComponent` differs from `encodeURI` in that it encodes
reserved characters and the Number sign `#` of `encodeURI`:

<table><colgroup><col> <col></colgroup><thead><tr><th>Type</th><th>Includes</th></tr></thead><tbody><tr><td><p>Reserved characters</p></td><td></td></tr><tr><td><p>Unescaped characters</p></td><td><p>alphabetic, decimal digits, - _ . ! ~ * ' ( )</p></td></tr><tr><td><p>Number sign</p></td><td></td></tr></tbody></table>

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>URI component string.</p></td></tr></tbody></table>

### Example

This example encodes a variety of URI components.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::URL
output application/json
---
{
  "comparing_encode_functions_output" : {
  	"encodeURIComponent" : encodeURI(" PATH/ TO /ENCODE "),
  	"encodeURI" : encodeURI(" PATH/ TO /ENCODE "),
  	"encodeURIComponent_to_hex" : encodeURIComponent(";,/?:@&="),
  	"encodeURI_not_to_hex" : encodeURI(";,/?:@&="),
  	"encodeURIComponent_not_encoded" : encodeURIComponent("-_.!~*'()"),
  	"encodeURI_not_encoded" : encodeURI("-_.!~*'()")
  }
}
```

#### Output

```JSON
{
  "comparing_encode_functions_output": {
    "encodeURIComponent": "%20PATH/%20TO%20/ENCODE%20",
    "encodeURI": "%20PATH/%20TO%20/ENCODE%20",
    "encodeURIComponent_to_hex": "%3B%2C%2F%3F%3A%40%26%3D",
    "encodeURI_not_to_hex": ";,/?:@&=",
    "encodeURIComponent_not_encoded": "-_.!~*'()",
    "encodeURI_not_encoded": "-_.!~*'()"
  }
}
```

<!-- document id=89a5a7bf1fca7acde6d174e073c09e0fcc4fe0cfc453e75f93811c89dbe8b74f url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-endswith.md -->

---
product: DataWeave
version: 2.11
---

# endsWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## endsWith(text: String, suffix: String): Boolean

Returns `true` if a string ends with a provided substring, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string (a <code>String</code>).</p></td></tr><tr><td><p><code>suffix</code></p></td><td><p>The suffix string to find at the end of the input string.</p></td></tr></tbody></table>

### Example

This example finds "no" (but not "to") at the end of "Mariano".

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ "Mariano" endsWith "no", "Mariano" endsWith "to" ]
```

#### Output

```JSON
[ true, false ]
```

## endsWith(text: Null, suffix: Any): false

Helper function that enables `endsWith` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=babb40ede3ce53df130f0d49ba475773d7678c0215301b3ce7ffbe5991f11526 url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-endswith.md -->

---
product: DataWeave
version: 2.12
---

# endsWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## endsWith(text: String, suffix: String): Boolean

Returns `true` if a string ends with a provided substring, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string (a <code>String</code>).</p></td></tr><tr><td><p><code>suffix</code></p></td><td><p>The suffix string to find at the end of the input string.</p></td></tr></tbody></table>

### Example

This example finds "no" (but not "to") at the end of "Mariano".

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ "Mariano" endsWith "no", "Mariano" endsWith "to" ]
```

#### Output

```JSON
[ true, false ]
```

## endsWith(text: Null, suffix: Any): false

Helper function that enables `endsWith` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=6aa3f098e6879ff46f2866351593411dba58b158de71004eea5976421bab91c2 url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-endswith.md -->

---
product: DataWeave
version: 2.3
---

# endsWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## endsWith(String, String): Boolean

Returns `true` if a string ends with a provided substring, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string (a <code>String</code>).</p></td></tr><tr><td><p><code>suffix</code></p></td><td><p>The suffix string to find at the end of the input string.</p></td></tr></tbody></table>

### Example

This example finds "no" (but not "to") at the end of "Mariano".

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ "Mariano" endsWith "no", "Mariano" endsWith "to" ]
```

#### Output

```JSON
[ true, false ]
```

<!-- document id=ed5342fe39fbb2e51466454791132f7ab47367af2e9d50a10ef38e778044e112 url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-endswith.md -->

---
product: DataWeave
version: 2.4
---

# endsWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## endsWith(text: String, suffix: String): Boolean

Returns `true` if a string ends with a provided substring, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string (a <code>String</code>).</p></td></tr><tr><td><p><code>suffix</code></p></td><td><p>The suffix string to find at the end of the input string.</p></td></tr></tbody></table>

### Example

This example finds "no" (but not "to") at the end of "Mariano".

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ "Mariano" endsWith "no", "Mariano" endsWith "to" ]
```

#### Output

```JSON
[ true, false ]
```

## endsWith(text: Null, suffix: Any): false

Helper function that enables `endsWith` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=6413e5b9b8ccf91ab963f7afea59f6541fcd9e56b32ab95e3199714e3fb08711 url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-endswith.md -->

---
product: DataWeave
version: 2.6
---

# endsWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## endsWith(text: String, suffix: String): Boolean

Returns `true` if a string ends with a provided substring, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string (a <code>String</code>).</p></td></tr><tr><td><p><code>suffix</code></p></td><td><p>The suffix string to find at the end of the input string.</p></td></tr></tbody></table>

### Example

This example finds "no" (but not "to") at the end of "Mariano".

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ "Mariano" endsWith "no", "Mariano" endsWith "to" ]
```

#### Output

```JSON
[ true, false ]
```

## endsWith(text: Null, suffix: Any): false

Helper function that enables `endsWith` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=6ff6ba80188b3c06f02113b27c3cb3f500d855f74ac63fd510ab115c6945373a url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-endswith.md -->

---
product: DataWeave
version: 2.9
---

# endsWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## endsWith(text: String, suffix: String): Boolean

Returns `true` if a string ends with a provided substring, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string (a <code>String</code>).</p></td></tr><tr><td><p><code>suffix</code></p></td><td><p>The suffix string to find at the end of the input string.</p></td></tr></tbody></table>

### Example

This example finds "no" (but not "to") at the end of "Mariano".

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ "Mariano" endsWith "no", "Mariano" endsWith "to" ]
```

#### Output

```JSON
[ true, false ]
```

## endsWith(text: Null, suffix: Any): false

Helper function that enables `endsWith` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=1f4fa5a23349c1645df5b43705cc81582a84d5a84a6b2b93095562fdbf22ff47 url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-endswith.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# endsWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## endsWith(text: String, suffix: String): Boolean

Returns `true` if a string ends with a provided substring, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string (a <code>String</code>).</p></td></tr><tr><td><p><code>suffix</code></p></td><td><p>The suffix string to find at the end of the input string.</p></td></tr></tbody></table>

### Example

This example finds "no" (but not "to") at the end of "Mariano".

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ "Mariano" endsWith "no", "Mariano" endsWith "to" ]
```

#### Output

```JSON
[ true, false ]
```

## endsWith(text: Null, suffix: Any): false

Helper function that enables `endsWith` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=4425e7fc92ae18c39e9815ef517b85367d5ca5d9f9ea6ec8e441dc4f1819e2b4 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-entriesof.md -->

---
product: DataWeave
version: 2.11
---

# entriesOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## entriesOf<T <: Object>(obj: T): Array<{| key: Key, value: Any, attributes: Object |}>

Returns an array of key-value pairs that describe the key, value, and any attributes in the input
object.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to describe.</p></td></tr></tbody></table>

### Example

This example returns the key, value, and attributes from the object specified in the variable
`myVar`. The object is the XML input to the `read` function.

#### Source

```DataWeave
%dw 2.0
var myVar = read('<xml attr="x"><a>true</a><b>1</b></xml>', 'application/xml')
output application/json
---
{ "entriesOf" : entriesOf(myVar) }
```

#### Output

```JSON
{
  "entriesOf": [
    {
       "key": "xml",
       "value": {
         "a": "true",
         "b": "1"
       },
       "attributes": {
         "attr": "x"
       }
    }
  ]
}
```

## entriesOf(obj: Null): Null

Helper function that enables `entriesOf` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=264dc06b6c1a472e44f9287fee399ea8a0bb07d870813582bc9a88f597beab71 url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-entriesof.md -->

---
product: DataWeave
version: 2.12
---

# entriesOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## entriesOf<T <: Object>(obj: T): Array<{| key: Key, value: Any, attributes: Object |}>

Returns an array of key-value pairs that describe the key, value, and any attributes in the input
object.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to describe.</p></td></tr></tbody></table>

### Example

This example returns the key, value, and attributes from the object specified in the variable
`myVar`. The object is the XML input to the `read` function.

#### Source

```DataWeave
%dw 2.0
var myVar = read('<xml attr="x"><a>true</a><b>1</b></xml>', 'application/xml')
output application/json
---
{ "entriesOf" : entriesOf(myVar) }
```

#### Output

```JSON
{
  "entriesOf": [
    {
       "key": "xml",
       "value": {
         "a": "true",
         "b": "1"
       },
       "attributes": {
         "attr": "x"
       }
    }
  ]
}
```

## entriesOf(obj: Null): Null

Helper function that enables `entriesOf` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=51c362ef92eaac36d601f50ee3c9bc15351c30b94a14429069144f290d9935fc url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-entriesof.md -->

---
product: DataWeave
version: 2.3
---

# entriesOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## entriesOf(T): Array<{| key: Key, value: Any, attributes: Object |}>

Returns an array of key-value pairs that describe the key, value, and any attributes in the input
object.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to describe.</p></td></tr></tbody></table>

### Example

This example returns the key, value, and attributes from the object specified in the variable
`myVar`. The object is the XML input to the `read` function.

#### Source

```DataWeave
%dw 2.0
var myVar = read('<xml attr="x"><a>true</a><b>1</b></xml>', 'application/xml')
output application/json
---
{ "entriesOf" : entriesOf(myVar) }
```

#### Output

```JSON
{
  "entriesOf": [
    {
       "key": "xml",
       "value": {
         "a": "true",
         "b": "1"
       },
       "attributes": {
         "attr": "x"
       }
    }
  ]
}
```

<!-- document id=3cbc3773cbdb9be0d64025cd34df9e67bd47dd163ac962f8540d0d1922de657b url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-entriesof.md -->

---
product: DataWeave
version: 2.4
---

# entriesOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## entriesOf<T <: Object>(obj: T): Array<{| key: Key, value: Any, attributes: Object |}>

Returns an array of key-value pairs that describe the key, value, and any attributes in the input
object.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to describe.</p></td></tr></tbody></table>

### Example

This example returns the key, value, and attributes from the object specified in the variable
`myVar`. The object is the XML input to the `read` function.

#### Source

```DataWeave
%dw 2.0
var myVar = read('<xml attr="x"><a>true</a><b>1</b></xml>', 'application/xml')
output application/json
---
{ "entriesOf" : entriesOf(myVar) }
```

#### Output

```JSON
{
  "entriesOf": [
    {
       "key": "xml",
       "value": {
         "a": "true",
         "b": "1"
       },
       "attributes": {
         "attr": "x"
       }
    }
  ]
}
```

## entriesOf(obj: Null): Null

Helper function that enables `entriesOf` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=9fc94478d034098a913e04f449c97cf85bc8d8ba5cb8886a61e2a1e9153e614d url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-entriesof.md -->

---
product: DataWeave
version: 2.6
---

# entriesOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## entriesOf<T <: Object>(obj: T): Array<{| key: Key, value: Any, attributes: Object |}>

Returns an array of key-value pairs that describe the key, value, and any attributes in the input
object.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to describe.</p></td></tr></tbody></table>

### Example

This example returns the key, value, and attributes from the object specified in the variable
`myVar`. The object is the XML input to the `read` function.

#### Source

```DataWeave
%dw 2.0
var myVar = read('<xml attr="x"><a>true</a><b>1</b></xml>', 'application/xml')
output application/json
---
{ "entriesOf" : entriesOf(myVar) }
```

#### Output

```JSON
{
  "entriesOf": [
    {
       "key": "xml",
       "value": {
         "a": "true",
         "b": "1"
       },
       "attributes": {
         "attr": "x"
       }
    }
  ]
}
```

## entriesOf(obj: Null): Null

Helper function that enables `entriesOf` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=ea0c24c35ab4a905605c70cfba6a8ee7edf079756263b38cd8815e9edf415bef url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-entriesof.md -->

---
product: DataWeave
version: 2.9
---

# entriesOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## entriesOf<T <: Object>(obj: T): Array<{| key: Key, value: Any, attributes: Object |}>

Returns an array of key-value pairs that describe the key, value, and any attributes in the input
object.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to describe.</p></td></tr></tbody></table>

### Example

This example returns the key, value, and attributes from the object specified in the variable
`myVar`. The object is the XML input to the `read` function.

#### Source

```DataWeave
%dw 2.0
var myVar = read('<xml attr="x"><a>true</a><b>1</b></xml>', 'application/xml')
output application/json
---
{ "entriesOf" : entriesOf(myVar) }
```

#### Output

```JSON
{
  "entriesOf": [
    {
       "key": "xml",
       "value": {
         "a": "true",
         "b": "1"
       },
       "attributes": {
         "attr": "x"
       }
    }
  ]
}
```

## entriesOf(obj: Null): Null

Helper function that enables `entriesOf` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=6649d68ba4ddbad77f03f4e5178ef8efe0ac19af2e740870795470c4e5130c5d url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-entriesof.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# entriesOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## entriesOf<T <: Object>(obj: T): Array<{| key: Key, value: Any, attributes: Object |}>

Returns an array of key-value pairs that describe the key, value, and any attributes in the input
object.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to describe.</p></td></tr></tbody></table>

### Example

This example returns the key, value, and attributes from the object specified in the variable
`myVar`. The object is the XML input to the `read` function.

#### Source

```DataWeave
%dw 2.0
var myVar = read('<xml attr="x"><a>true</a><b>1</b></xml>', 'application/xml')
output application/json
---
{ "entriesOf" : entriesOf(myVar) }
```

#### Output

```JSON
{
  "entriesOf": [
    {
       "key": "xml",
       "value": {
         "a": "true",
         "b": "1"
       },
       "attributes": {
         "attr": "x"
       }
    }
  ]
}
```

## entriesOf(obj: Null): Null

Helper function that enables `entriesOf` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=d2076434438a356ca3031607f9465f2380defc2751196d1831b7c2ba5909ed8a url=/mulesoft/current/en-us/dataweave/2.11/dw-objects-functions-entryset.md -->

---
product: DataWeave
version: 2.11
---

# entrySet

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## entrySet<T <: Object>(obj: T): Array<{| key: Key, value: Any, attributes: Object |}>

Returns an array of key-value pairs that describe the key, value, and any attributes in the input
object.

_This function is **Deprecated**. Use [dw::Core::entriesOf](https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-entriesof), instead._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The <code>Object</code> to describe.</p></td></tr></tbody></table>

### Example

This example returns the key, value, and attributes in the object specified in the variable `myVar`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Objects
var myVar = read('<xml attr="x"><a>true</a><b>1</b></xml>', 'application/xml')
output application/json
---
{ "entrySet" : entrySet(myVar) }
```

#### Output

```JSON
{
  "entrySet": [
    {
       "key": "xml",
       "value": {
         "a": "true",
         "b": "1"
       },
       "attributes": {
         "attr": "x"
       }
    }
  ]
}
```

<!-- document id=efd80d387f8affc787cb6d39368dc349e856530eee6b2fa1c277e94b6baaecea url=/mulesoft/current/en-us/dataweave/2.12/dw-objects-functions-entryset.md -->

---
product: DataWeave
version: 2.12
---

# entrySet

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## entrySet<T <: Object>(obj: T): Array<{| key: Key, value: Any, attributes: Object |}>

Returns an array of key-value pairs that describe the key, value, and any attributes in the input
object.

_This function is **Deprecated**. Use [dw::Core::entriesOf](https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-entriesof), instead._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The <code>Object</code> to describe.</p></td></tr></tbody></table>

### Example

This example returns the key, value, and attributes in the object specified in the variable `myVar`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Objects
var myVar = read('<xml attr="x"><a>true</a><b>1</b></xml>', 'application/xml')
output application/json
---
{ "entrySet" : entrySet(myVar) }
```

#### Output

```JSON
{
  "entrySet": [
    {
       "key": "xml",
       "value": {
         "a": "true",
         "b": "1"
       },
       "attributes": {
         "attr": "x"
       }
    }
  ]
}
```

<!-- document id=48bd147dc5eb92cabf56f08861bb90745b88cdc8f1fd29964a898b2f3ce06540 url=/mulesoft/current/en-us/dataweave/2.3/dw-objects-functions-entryset.md -->

---
product: DataWeave
version: 2.3
---

# entrySet

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## entrySet(T): Array<{| key: Key, value: Any, attributes: Object |}>

Returns an array of key-value pairs that describe the key, value, and any attributes in the input
object.

This method is **Deprecated**. Use `entriesOf` from Core module, instead.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The <code>Object</code> to describe.</p></td></tr></tbody></table>

### Example

This example returns the key, value, and attributes in the object specified in the variable `myVar`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Objects
var myVar = read('<xml attr="x"><a>true</a><b>1</b></xml>', 'application/xml')
output application/json
---
{ "entrySet" : entrySet(myVar) }
```

#### Output

```JSON
{
  "entrySet": [
    {
       "key": "xml",
       "value": {
         "a": "true",
         "b": "1"
       },
       "attributes": {
         "attr": "x"
       }
    }
  ]
}
```

<!-- document id=0bd4b1b6d706af24cada0c621e007c5966ebf75db1c512c06a9e1b0318f1ba31 url=/mulesoft/current/en-us/dataweave/2.4/dw-objects-functions-entryset.md -->

---
product: DataWeave
version: 2.4
---

# entrySet

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## entrySet<T <: Object>(obj: T): Array<{| key: Key, value: Any, attributes: Object |}>

Returns an array of key-value pairs that describe the key, value, and any attributes in the input
object.

_This function is **Deprecated**. Use [dw::Core::entriesOf](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-entriesof), instead._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The <code>Object</code> to describe.</p></td></tr></tbody></table>

### Example

This example returns the key, value, and attributes in the object specified in the variable `myVar`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Objects
var myVar = read('<xml attr="x"><a>true</a><b>1</b></xml>', 'application/xml')
output application/json
---
{ "entrySet" : entrySet(myVar) }
```

#### Output

```JSON
{
  "entrySet": [
    {
       "key": "xml",
       "value": {
         "a": "true",
         "b": "1"
       },
       "attributes": {
         "attr": "x"
       }
    }
  ]
}
```

<!-- document id=7ecc2938d96d4cf06e65056eed3a0f3a5ec4ba41fb42b548616f6ab21be5853c url=/mulesoft/current/en-us/dataweave/2.6/dw-objects-functions-entryset.md -->

---
product: DataWeave
version: 2.6
---

# entrySet

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## entrySet<T <: Object>(obj: T): Array<{| key: Key, value: Any, attributes: Object |}>

Returns an array of key-value pairs that describe the key, value, and any attributes in the input
object.

_This function is **Deprecated**. Use [dw::Core::entriesOf](https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-entriesof), instead._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The <code>Object</code> to describe.</p></td></tr></tbody></table>

### Example

This example returns the key, value, and attributes in the object specified in the variable `myVar`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Objects
var myVar = read('<xml attr="x"><a>true</a><b>1</b></xml>', 'application/xml')
output application/json
---
{ "entrySet" : entrySet(myVar) }
```

#### Output

```JSON
{
  "entrySet": [
    {
       "key": "xml",
       "value": {
         "a": "true",
         "b": "1"
       },
       "attributes": {
         "attr": "x"
       }
    }
  ]
}
```

<!-- document id=178a0d319d9c8840f126958cbb35411f4f7672440e9e22460dbd9967fc345817 url=/mulesoft/current/en-us/dataweave/2.9/dw-objects-functions-entryset.md -->

---
product: DataWeave
version: 2.9
---

# entrySet

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## entrySet<T <: Object>(obj: T): Array<{| key: Key, value: Any, attributes: Object |}>

Returns an array of key-value pairs that describe the key, value, and any attributes in the input
object.

_This function is **Deprecated**. Use [dw::Core::entriesOf](https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-entriesof), instead._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The <code>Object</code> to describe.</p></td></tr></tbody></table>

### Example

This example returns the key, value, and attributes in the object specified in the variable `myVar`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Objects
var myVar = read('<xml attr="x"><a>true</a><b>1</b></xml>', 'application/xml')
output application/json
---
{ "entrySet" : entrySet(myVar) }
```

#### Output

```JSON
{
  "entrySet": [
    {
       "key": "xml",
       "value": {
         "a": "true",
         "b": "1"
       },
       "attributes": {
         "attr": "x"
       }
    }
  ]
}
```

<!-- document id=7d99f1886d81176beca6df15b9176bb817b6934044f3cd24c002ce0c42a4248b url=/mulesoft/current/en-us/dataweave/latest/dw-objects-functions-entryset.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# entrySet

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## entrySet<T <: Object>(obj: T): Array<{| key: Key, value: Any, attributes: Object |}>

Returns an array of key-value pairs that describe the key, value, and any attributes in the input
object.

_This function is **Deprecated**. Use [dw::Core::entriesOf](https://docs.mulesoft.com/dataweave/latest/dw-core-functions-entriesof), instead._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The <code>Object</code> to describe.</p></td></tr></tbody></table>

### Example

This example returns the key, value, and attributes in the object specified in the variable `myVar`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Objects
var myVar = read('<xml attr="x"><a>true</a><b>1</b></xml>', 'application/xml')
output application/json
---
{ "entrySet" : entrySet(myVar) }
```

#### Output

```JSON
{
  "entrySet": [
    {
       "key": "xml",
       "value": {
         "a": "true",
         "b": "1"
       },
       "attributes": {
         "attr": "x"
       }
    }
  ]
}
```

<!-- document id=8b8cfb84c79b589dd4331532be67cdfcda6c872ff4d7b36886c8f9a129fc0172 url=/mulesoft/current/en-us/dataweave/2.11/dw-system-functions-envvar.md -->

---
product: DataWeave
version: 2.11
---

# envVar

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## envVar(variableName: String): String | Null

Returns an environment variable with the specified name or `null` if the environment variable is not
defined.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>variableName</code></p></td><td><p>String that provides the name of the environment variable.</p></td></tr></tbody></table>

### Example

This example returns a Mac command console (`SHELL`) path and returns `null` on `FAKE_ENV_VAR` (an
undefined environment variable). `SHELL` is one of the standard Mac environment variables. Also
notice that the `import` command enables you to call the function without prepending the module name
to it.

#### Source

```DataWeave
%dw 2.0
import * from dw::System
output application/json
---
{
    "envVars" : [
       "real" : envVar("SHELL"),
       "fake" : envVar("FAKE_ENV_VAR")
    ]
}
```

#### Output

```JSON
"envVars": [
  {
    "real": "/bin/bash"
  },
  {
    "fake": null
  }
]
```

<!-- document id=f12e6d1ade84060998cf37c8dcda0b571d4efb383963709f705ef2f07fa1c3da url=/mulesoft/current/en-us/dataweave/2.12/dw-system-functions-envvar.md -->

---
product: DataWeave
version: 2.12
---

# envVar

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## envVar(variableName: String): String | Null

Returns an environment variable with the specified name or `null` if the environment variable is not
defined.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>variableName</code></p></td><td><p>String that provides the name of the environment variable.</p></td></tr></tbody></table>

### Example

This example returns a Mac command console (`SHELL`) path and returns `null` on `FAKE_ENV_VAR` (an
undefined environment variable). `SHELL` is one of the standard Mac environment variables. Also
notice that the `import` command enables you to call the function without prepending the module name
to it.

#### Source

```DataWeave
%dw 2.0
import * from dw::System
output application/json
---
{
    "envVars" : [
       "real" : envVar("SHELL"),
       "fake" : envVar("FAKE_ENV_VAR")
    ]
}
```

#### Output

```JSON
"envVars": [
  {
    "real": "/bin/bash"
  },
  {
    "fake": null
  }
]
```

<!-- document id=493321fe6d49a80af3144f1f26bc77b43166b0893a612c1d382b28b4a8159a13 url=/mulesoft/current/en-us/dataweave/2.3/dw-system-functions-envvar.md -->

---
product: DataWeave
version: 2.3
---

# envVar

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## envVar(String): String | Null

Returns an environment variable with the specified name or `null` if the environment variable is not
defined.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>variableName</code></p></td><td><p>Provides the name of the environment variable.</p></td></tr></tbody></table>

### Example

This example returns a Mac command console (`SHELL`) path and returns `null` on `FAKE_ENV_VAR` (an
undefined environment variable). `SHELL` is one of the standard Mac environment variables. Also
notice that the `import` command enables you to call the function without prepending the module name
to it.

#### Source

```DataWeave
%dw 2.0
import * from dw::System
output application/json
---
{
    "envVars" : [
       "real" : envVar("SHELL"),
       "fake" : envVar("FAKE_ENV_VAR")
    ]
}
```

#### Output

```JSON
"envVars": [
  {
    "real": "/bin/bash"
  },
  {
    "fake": null
  }
]
```

<!-- document id=0eb753b64308917922bd58cf5670343fe7c948760dbe022a30b2e80b1ab3dff6 url=/mulesoft/current/en-us/dataweave/2.4/dw-system-functions-envvar.md -->

---
product: DataWeave
version: 2.4
---

# envVar

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## envVar(variableName: String): String | Null

Returns an environment variable with the specified name or `null` if the environment variable is not
defined.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>variableName</code></p></td><td><p>String that provides the name of the environment variable.</p></td></tr></tbody></table>

### Example

This example returns a Mac command console (`SHELL`) path and returns `null` on `FAKE_ENV_VAR` (an
undefined environment variable). `SHELL` is one of the standard Mac environment variables. Also
notice that the `import` command enables you to call the function without prepending the module name
to it.

#### Source

```DataWeave
%dw 2.0
import * from dw::System
output application/json
---
{
    "envVars" : [
       "real" : envVar("SHELL"),
       "fake" : envVar("FAKE_ENV_VAR")
    ]
}
```

#### Output

```JSON
"envVars": [
  {
    "real": "/bin/bash"
  },
  {
    "fake": null
  }
]
```

<!-- document id=70039b71aa18e650f3680c02512a74c12d78e6a31864a973d9da42777482620b url=/mulesoft/current/en-us/dataweave/2.6/dw-system-functions-envvar.md -->

---
product: DataWeave
version: 2.6
---

# envVar

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## envVar(variableName: String): String | Null

Returns an environment variable with the specified name or `null` if the environment variable is not
defined.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>variableName</code></p></td><td><p>String that provides the name of the environment variable.</p></td></tr></tbody></table>

### Example

This example returns a Mac command console (`SHELL`) path and returns `null` on `FAKE_ENV_VAR` (an
undefined environment variable). `SHELL` is one of the standard Mac environment variables. Also
notice that the `import` command enables you to call the function without prepending the module name
to it.

#### Source

```DataWeave
%dw 2.0
import * from dw::System
output application/json
---
{
    "envVars" : [
       "real" : envVar("SHELL"),
       "fake" : envVar("FAKE_ENV_VAR")
    ]
}
```

#### Output

```JSON
"envVars": [
  {
    "real": "/bin/bash"
  },
  {
    "fake": null
  }
]
```

<!-- document id=6fa8b3fdfc4f9a566c1fdbf81c873ea04a965cb52eaceb3acdbaea96c73fcdfb url=/mulesoft/current/en-us/dataweave/2.9/dw-system-functions-envvar.md -->

---
product: DataWeave
version: 2.9
---

# envVar

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## envVar(variableName: String): String | Null

Returns an environment variable with the specified name or `null` if the environment variable is not
defined.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>variableName</code></p></td><td><p>String that provides the name of the environment variable.</p></td></tr></tbody></table>

### Example

This example returns a Mac command console (`SHELL`) path and returns `null` on `FAKE_ENV_VAR` (an
undefined environment variable). `SHELL` is one of the standard Mac environment variables. Also
notice that the `import` command enables you to call the function without prepending the module name
to it.

#### Source

```DataWeave
%dw 2.0
import * from dw::System
output application/json
---
{
    "envVars" : [
       "real" : envVar("SHELL"),
       "fake" : envVar("FAKE_ENV_VAR")
    ]
}
```

#### Output

```JSON
"envVars": [
  {
    "real": "/bin/bash"
  },
  {
    "fake": null
  }
]
```

<!-- document id=78bd6b4e6cb92380d90e03a145169e742ffea6d4aff992466423f162320ca291 url=/mulesoft/current/en-us/dataweave/latest/dw-system-functions-envvar.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# envVar

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## envVar(variableName: String): String | Null

Returns an environment variable with the specified name or `null` if the environment variable is not
defined.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>variableName</code></p></td><td><p>String that provides the name of the environment variable.</p></td></tr></tbody></table>

### Example

This example returns a Mac command console (`SHELL`) path and returns `null` on `FAKE_ENV_VAR` (an
undefined environment variable). `SHELL` is one of the standard Mac environment variables. Also
notice that the `import` command enables you to call the function without prepending the module name
to it.

#### Source

```DataWeave
%dw 2.0
import * from dw::System
output application/json
---
{
    "envVars" : [
       "real" : envVar("SHELL"),
       "fake" : envVar("FAKE_ENV_VAR")
    ]
}
```

#### Output

```JSON
"envVars": [
  {
    "real": "/bin/bash"
  },
  {
    "fake": null
  }
]
```

<!-- document id=496d1890aa6d0cb514a62add20746b0967c863625f79442fa852bfb97c330d1d url=/mulesoft/current/en-us/dataweave/2.11/dw-system-functions-envvars.md -->

---
product: DataWeave
version: 2.11
---

# envVars

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## envVars(): Dictionary<String>

Returns all the environment variables defined in the host system as an array of strings.

### Example

This example returns a Mac command console (`SHELL`) path. `SHELL` is one of the standard Mac
environment variables. To return all the environment variables, you can use `dw::System::envVars()`.

#### Source

```DataWeave
%dw 2.0
import dw::System
output application/json
---
{ "envVars" : dw::System::envVars().SHELL }
```

#### Output

```JSON
{ "envVars": "/bin/bash" }
```

<!-- document id=492b640696dbe4ef57034a7fe06f23f94b7c5cdecc7f61582cd3a87502ffd8d2 url=/mulesoft/current/en-us/dataweave/2.12/dw-system-functions-envvars.md -->

---
product: DataWeave
version: 2.12
---

# envVars

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## envVars(): Dictionary<String>

Returns all the environment variables defined in the host system as an array of strings.

### Example

This example returns a Mac command console (`SHELL`) path. `SHELL` is one of the standard Mac
environment variables. To return all the environment variables, you can use `dw::System::envVars()`.

#### Source

```DataWeave
%dw 2.0
import dw::System
output application/json
---
{ "envVars" : dw::System::envVars().SHELL }
```

#### Output

```JSON
{ "envVars": "/bin/bash" }
```

<!-- document id=858f8646e9b33a00faa299b82308466e8df0921d28176fb901f3f70919ca7b30 url=/mulesoft/current/en-us/dataweave/2.3/dw-system-functions-envvars.md -->

---
product: DataWeave
version: 2.3
---

# envVars

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## envVars(): Dictionary<String>

Returns all of the environment variables defined in the host system.

### Example

This example returns a Mac command console (`SHELL`) path. `SHELL` is one of the standard Mac
environment variables. To return all the environment variables, you can use `dw::System::envVars()`.

#### Source

```DataWeave
%dw 2.0
import dw::System
output application/json
---
{ "envVars" : dw::System::envVars().SHELL }
```

#### Output

```JSON
{ "envVars": "/bin/bash" }
```

<!-- document id=0cf12f2e6f2bcd6c41fa936a324616519acc8ed9cf048a787e8fb6e11c4f97d4 url=/mulesoft/current/en-us/dataweave/2.4/dw-system-functions-envvars.md -->

---
product: DataWeave
version: 2.4
---

# envVars

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## envVars(): Dictionary<String>

Returns all the environment variables defined in the host system as an array of strings.

### Example

This example returns a Mac command console (`SHELL`) path. `SHELL` is one of the standard Mac
environment variables. To return all the environment variables, you can use `dw::System::envVars()`.

#### Source

```DataWeave
%dw 2.0
import dw::System
output application/json
---
{ "envVars" : dw::System::envVars().SHELL }
```

#### Output

```JSON
{ "envVars": "/bin/bash" }
```

<!-- document id=97135921221e6a2d1017c7b378a144dcd47b36a4809e3f64bb5dae411cb88c12 url=/mulesoft/current/en-us/dataweave/2.6/dw-system-functions-envvars.md -->

---
product: DataWeave
version: 2.6
---

# envVars

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## envVars(): Dictionary<String>

Returns all the environment variables defined in the host system as an array of strings.

### Example

This example returns a Mac command console (`SHELL`) path. `SHELL` is one of the standard Mac
environment variables. To return all the environment variables, you can use `dw::System::envVars()`.

#### Source

```DataWeave
%dw 2.0
import dw::System
output application/json
---
{ "envVars" : dw::System::envVars().SHELL }
```

#### Output

```JSON
{ "envVars": "/bin/bash" }
```

<!-- document id=2b7b5cdc95c81381d869867e61ecb4153d98f85d2b7d8a4c0c5762df8229b9fc url=/mulesoft/current/en-us/dataweave/2.9/dw-system-functions-envvars.md -->

---
product: DataWeave
version: 2.9
---

# envVars

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## envVars(): Dictionary<String>

Returns all the environment variables defined in the host system as an array of strings.

### Example

This example returns a Mac command console (`SHELL`) path. `SHELL` is one of the standard Mac
environment variables. To return all the environment variables, you can use `dw::System::envVars()`.

#### Source

```DataWeave
%dw 2.0
import dw::System
output application/json
---
{ "envVars" : dw::System::envVars().SHELL }
```

#### Output

```JSON
{ "envVars": "/bin/bash" }
```

<!-- document id=c7b3e5d484a4c30f1de5fae2bb31301aef2fcbdbe9b16d20b8fdcbb4f4b791bc url=/mulesoft/current/en-us/dataweave/latest/dw-system-functions-envvars.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# envVars

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## envVars(): Dictionary<String>

Returns all the environment variables defined in the host system as an array of strings.

### Example

This example returns a Mac command console (`SHELL`) path. `SHELL` is one of the standard Mac
environment variables. To return all the environment variables, you can use `dw::System::envVars()`.

#### Source

```DataWeave
%dw 2.0
import dw::System
output application/json
---
{ "envVars" : dw::System::envVars().SHELL }
```

#### Output

```JSON
{ "envVars": "/bin/bash" }
```

<!-- document id=8c3a8a462da3de1a41d55c3dc33e98fe754eafa3e32b8b2854e7bd2456f1cf39 url=/mulesoft/current/en-us/dataweave/2.11/dw-runtime-functions-eval.md -->

---
product: DataWeave
version: 2.11
---

# eval

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## eval(fileToExecute: String, fs: Dictionary<String>, readerInputs: Dictionary<ReaderInput> = {}, inputValues: Dictionary<Any> = {}, configuration: RuntimeExecutionConfiguration = {}): EvalResult

Evaluates a script with the specified context and returns the result of that evaluation.

_Experimental:_ This function is an experimental feature that is subject to change or removal from
future versions of DataWeave.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>fileToExecute</code></p></td><td><p>Name of the file to execute.</p></td></tr><tr><td><p><code>fs</code></p></td><td><p>An object that contains the file to evaluate.</p></td></tr><tr><td><p><code>readerInputs</code></p></td><td><p>Reader inputs to bind.</p></td></tr><tr><td><p><code>inputValues</code></p></td><td><p>Additional literal values to bind</p></td></tr><tr><td><p><code>configuration</code></p></td><td><p>The runtime configuration.</p></td></tr></tbody></table>

### Example

This example shows how `eval` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime

var jsonValue = {
   value: '{"name": "Mariano"}' as Binary {encoding: "UTF-8"},
   encoding: "UTF-8",
   properties: {},
   mimeType: "application/json"
}

var jsonValue2 = {
   value: '{"name": "Mariano", "lastName": "achaval"}' as Binary {encoding: "UTF-8"},
   encoding: "UTF-8",
   properties: {},
   mimeType: "application/json"
}

var invalidJsonValue = {
   value: '{"name": "Mariano' as Binary {encoding: "UTF-8"},
   encoding: "UTF-8",
   properties: {},
   mimeType: "application/json"
}

var Utils = "fun sum(a,b) = a +b"
output application/json
---
{
   "execute_ok" : run("main.dwl", {"main.dwl": "{a: 1}"}, {"payload": jsonValue }),
   "logs" : do {
     var execResult = run("main.dwl", {"main.dwl": "{a: log(1)}"}, {"payload": jsonValue })
     ---
     {
         m: execResult.logs.message,
         l: execResult.logs.level
     }
   },
   "grant" : eval("main.dwl", {"main.dwl": "{a: readUrl(`http://google.com`)}"}, {"payload": jsonValue }, {},{ securityManager: (grant, args) -> false }),
   "library" : eval("main.dwl", {"main.dwl": "Utils::sum(1,2)", "/Utils.dwl": Utils }, {"payload": jsonValue }),
   "timeout" : eval("main.dwl", {"main.dwl": "(1 to 1000000000000) map \$ + 1" }, {"payload": jsonValue }, {},{timeOut: 2}).success,
   "execFail" : eval("main.dwl", {"main.dwl": "dw::Runtime::fail('My Bad')" }, {"payload": jsonValue }),
   "parseFail" : eval("main.dwl", {"main.dwl": "(1 + " }, {"payload": jsonValue }),
   "writerFail" : eval("main.dwl", {"main.dwl": "output application/xml --- 2" }, {"payload": jsonValue }),
   "defaultOutput" : eval("main.dwl", {"main.dwl": "payload" }, {"payload": jsonValue2}, {},{outputMimeType: "application/csv", writerProperties: {"separator": "|"}}),
   "onExceptionFail": do  {
     dw::Runtime::try( () ->
         eval("main.dwl", {"main.dwl": "dw::Runtime::fail('Failing Test')" }, {"payload": jsonValue2}, {},{onException: "FAIL"})
     ).success
   },
   "customLogger":
        eval(
  "main.dwl",
           {"main.dwl": "log(1234)" },
   {"payload": jsonValue2},
    {},
   {
                  loggerService: {
                     initialize: () -> {token: "123"},
                     log: (level, msg, context) -> log("$(level) $(msg)", context)
                  }
                }
           )
}
```

#### Output

```Json
{
  "execute_ok": {
    "success": true,
    "value": "{\n  a: 1\n}",
    "mimeType": "application/dw",
    "encoding": "UTF-8",
    "logs": [

    ]
  },
  "logs": {
    "m": [
      "1"
    ],
    "l": [
      "INFO"
    ]
  },
  "grant": {
    "success": false,
    "message": "The given required permissions: `Resource` are not being granted for this execution.\nTrace:\n  at readUrl (Unknown)\n  at main::main (line: 1, column: 5)",
    "location": {
      "start": {
        "index": 0,
        "line": 0,
        "column": 0
      },
      "end": {
        "index": 0,
        "line": 0,
        "column": 0
      },
      "content": "Unknown location"
    },
    "stack": [
      "readUrl (anonymous:0:0)",
      "main (main:1:5)"
    ],
    "logs": [

    ]
  },
  "library": {
    "success": true,
    "value": 3,
    "logs": [

    ]
  },
  "timeout": true,
  "execFail": {
    "success": false,
    "message": "My Bad\nTrace:\n  at fail (Unknown)\n  at main::main (line: 1, column: 1)",
    "location": {
      "start": {
        "index": 0,
        "line": 0,
        "column": 0
      },
      "end": {
        "index": 0,
        "line": 0,
        "column": 0
      },
      "content": "Unknown location"
    },
    "stack": [
      "fail (anonymous:0:0)",
      "main (main:1:1)"
    ],
    "logs": [

    ]
  },
  "parseFail": {
    "success": false,
    "message": "Invalid input \"1 + \", expected parameter or parenEnd (line 1, column 2):\n\n\n1| (1 + \n    ^^^^\nLocation:\nmain (line: 1, column:2)",
    "location": {
      "start": {
        "index": 0,
        "line": 1,
        "column": 2
      },
      "end": {
        "index": 4,
        "line": 1,
        "column": 6
      },
      "content": "\n1| (1 + \n    ^^^^"
    },
    "logs": [

    ]
  },
  "writerFail": {
    "success": true,
    "value": 2,
    "logs": [

    ]
  },
  "defaultOutput": {
    "success": true,
    "value": {
      "name": "Mariano",
      "lastName": "achaval"
    },
    "logs": [

    ]
  },
  "onExceptionFail": false,
  "customLogger": {
    "success": true,
    "value": 1234,
    "logs": [

    ]
  }
}
```

<!-- document id=35007aa09ff8c54ad2fba4b4f3f0a3b43566ca22a0442d43b9807b92e960c4ea url=/mulesoft/current/en-us/dataweave/2.12/dw-runtime-functions-eval.md -->

---
product: DataWeave
version: 2.12
---

# eval

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## eval(fileToExecute: String, fs: Dictionary<String>, readerInputs: Dictionary<ReaderInput> = {}, inputValues: Dictionary<Any> = {}, configuration: RuntimeExecutionConfiguration = {}): EvalResult

Evaluates a script with the specified context and returns the result of that evaluation.

_Experimental:_ This function is an experimental feature that is subject to change or removal from
future versions of DataWeave.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>fileToExecute</code></p></td><td><p>Name of the file to execute.</p></td></tr><tr><td><p><code>fs</code></p></td><td><p>An object that contains the file to evaluate.</p></td></tr><tr><td><p><code>readerInputs</code></p></td><td><p>Reader inputs to bind.</p></td></tr><tr><td><p><code>inputValues</code></p></td><td><p>Additional literal values to bind</p></td></tr><tr><td><p><code>configuration</code></p></td><td><p>The runtime configuration.</p></td></tr></tbody></table>

### Example

This example shows how `eval` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime

var jsonValue = {
   value: '{"name": "Mariano"}' as Binary {encoding: "UTF-8"},
   encoding: "UTF-8",
   properties: {},
   mimeType: "application/json"
}

var jsonValue2 = {
   value: '{"name": "Mariano", "lastName": "achaval"}' as Binary {encoding: "UTF-8"},
   encoding: "UTF-8",
   properties: {},
   mimeType: "application/json"
}

var invalidJsonValue = {
   value: '{"name": "Mariano' as Binary {encoding: "UTF-8"},
   encoding: "UTF-8",
   properties: {},
   mimeType: "application/json"
}

var Utils = "fun sum(a,b) = a +b"
output application/json
---
{
   "execute_ok" : run("main.dwl", {"main.dwl": "{a: 1}"}, {"payload": jsonValue }),
   "logs" : do {
     var execResult = run("main.dwl", {"main.dwl": "{a: log(1)}"}, {"payload": jsonValue })
     ---
     {
         m: execResult.logs.message,
         l: execResult.logs.level
     }
   },
   "grant" : eval("main.dwl", {"main.dwl": "{a: readUrl(`http://google.com`)}"}, {"payload": jsonValue }, {},{ securityManager: (grant, args) -> false }),
   "library" : eval("main.dwl", {"main.dwl": "Utils::sum(1,2)", "/Utils.dwl": Utils }, {"payload": jsonValue }),
   "timeout" : eval("main.dwl", {"main.dwl": "(1 to 1000000000000) map \$ + 1" }, {"payload": jsonValue }, {},{timeOut: 2}).success,
   "execFail" : eval("main.dwl", {"main.dwl": "dw::Runtime::fail('My Bad')" }, {"payload": jsonValue }),
   "parseFail" : eval("main.dwl", {"main.dwl": "(1 + " }, {"payload": jsonValue }),
   "writerFail" : eval("main.dwl", {"main.dwl": "output application/xml --- 2" }, {"payload": jsonValue }),
   "defaultOutput" : eval("main.dwl", {"main.dwl": "payload" }, {"payload": jsonValue2}, {},{outputMimeType: "application/csv", writerProperties: {"separator": "|"}}),
   "onExceptionFail": do  {
     dw::Runtime::try( () ->
         eval("main.dwl", {"main.dwl": "dw::Runtime::fail('Failing Test')" }, {"payload": jsonValue2}, {},{onException: "FAIL"})
     ).success
   },
   "customLogger":
        eval(
  "main.dwl",
           {"main.dwl": "log(1234)" },
   {"payload": jsonValue2},
    {},
   {
                  loggerService: {
                     initialize: () -> {token: "123"},
                     log: (level, msg, context) -> log("$(level) $(msg)", context)
                  }
                }
           )
}
```

#### Output

```Json
{
  "execute_ok": {
    "success": true,
    "value": "{\n  a: 1\n}",
    "mimeType": "application/dw",
    "encoding": "UTF-8",
    "logs": [

    ]
  },
  "logs": {
    "m": [
      "1"
    ],
    "l": [
      "INFO"
    ]
  },
  "grant": {
    "success": false,
    "message": "The given required permissions: `Resource` are not being granted for this execution.\nTrace:\n  at readUrl (Unknown)\n  at main::main (line: 1, column: 5)",
    "location": {
      "start": {
        "index": 0,
        "line": 0,
        "column": 0
      },
      "end": {
        "index": 0,
        "line": 0,
        "column": 0
      },
      "content": "Unknown location"
    },
    "stack": [
      "readUrl (anonymous:0:0)",
      "main (main:1:5)"
    ],
    "logs": [

    ]
  },
  "library": {
    "success": true,
    "value": 3,
    "logs": [

    ]
  },
  "timeout": true,
  "execFail": {
    "success": false,
    "message": "My Bad\nTrace:\n  at fail (Unknown)\n  at main::main (line: 1, column: 1)",
    "location": {
      "start": {
        "index": 0,
        "line": 0,
        "column": 0
      },
      "end": {
        "index": 0,
        "line": 0,
        "column": 0
      },
      "content": "Unknown location"
    },
    "stack": [
      "fail (anonymous:0:0)",
      "main (main:1:1)"
    ],
    "logs": [

    ]
  },
  "parseFail": {
    "success": false,
    "message": "Invalid input \"1 + \", expected parameter or parenEnd (line 1, column 2):\n\n\n1| (1 + \n    ^^^^\nLocation:\nmain (line: 1, column:2)",
    "location": {
      "start": {
        "index": 0,
        "line": 1,
        "column": 2
      },
      "end": {
        "index": 4,
        "line": 1,
        "column": 6
      },
      "content": "\n1| (1 + \n    ^^^^"
    },
    "logs": [

    ]
  },
  "writerFail": {
    "success": true,
    "value": 2,
    "logs": [

    ]
  },
  "defaultOutput": {
    "success": true,
    "value": {
      "name": "Mariano",
      "lastName": "achaval"
    },
    "logs": [

    ]
  },
  "onExceptionFail": false,
  "customLogger": {
    "success": true,
    "value": 1234,
    "logs": [

    ]
  }
}
```

<!-- document id=d0a888b39be05f787c178b01f596f9f7171f668bdb5c8ac54ce1b85916dc482c url=/mulesoft/current/en-us/dataweave/2.4/dw-runtime-functions-eval.md -->

---
product: DataWeave
version: 2.4
---

# eval

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## eval(fileToExecute: String, fs: Dictionary<String>, readerInputs: Dictionary<ReaderInput> = {}, inputValues: Dictionary<Any> = {}, configuration: RuntimeExecutionConfiguration = {}): EvalSuccess | ExecutionFailure

Evaluates a script with the specified context and returns the result of that evaluation.

_Experimental:_ This function is an experimental feature that is subject to change or removal from
future versions of DataWeave.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>fileToExecute</code></p></td><td><p>Name of the file to execute.</p></td></tr><tr><td><p><code>fs</code></p></td><td><p>An object that contains the file to evaluate.</p></td></tr><tr><td><p><code>readerInputs</code></p></td><td><p>Reader inputs to bind.</p></td></tr><tr><td><p><code>inputValues</code></p></td><td><p>Additional literal values to bind</p></td></tr><tr><td><p><code>configuration</code></p></td><td><p>The runtime configuration.</p></td></tr></tbody></table>

### Example

This example shows how `eval` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime

var jsonValue = {
   value: '{"name": "Mariano"}' as Binary {encoding: "UTF-8"},
   encoding: "UTF-8",
   properties: {},
   mimeType: "application/json"
}

var jsonValue2 = {
   value: '{"name": "Mariano", "lastName": "achaval"}' as Binary {encoding: "UTF-8"},
   encoding: "UTF-8",
   properties: {},
   mimeType: "application/json"
}

var invalidJsonValue = {
   value: '{"name": "Mariano' as Binary {encoding: "UTF-8"},
   encoding: "UTF-8",
   properties: {},
   mimeType: "application/json"
}

var Utils = "fun sum(a,b) = a +b"
output application/json
---
{
   "execute_ok" : run("main.dwl", {"main.dwl": "{a: 1}"}, {"payload": jsonValue }),
   "logs" : do {
     var execResult = run("main.dwl", {"main.dwl": "{a: log(1)}"}, {"payload": jsonValue })
     ---
     {
         m: execResult.logs.message,
         l: execResult.logs.level
     }
   },
   "grant" : eval("main.dwl", {"main.dwl": "{a: readUrl(`http://google.com`)}"}, {"payload": jsonValue }, {},{ securityManager: (grant, args) -> false }),
   "library" : eval("main.dwl", {"main.dwl": "Utils::sum(1,2)", "/Utils.dwl": Utils }, {"payload": jsonValue }),
   "timeout" : eval("main.dwl", {"main.dwl": "(1 to 1000000000000) map \$ + 1" }, {"payload": jsonValue }, {},{timeOut: 2}).success,
   "execFail" : eval("main.dwl", {"main.dwl": "dw::Runtime::fail('My Bad')" }, {"payload": jsonValue }),
   "parseFail" : eval("main.dwl", {"main.dwl": "(1 + " }, {"payload": jsonValue }),
   "writerFail" : eval("main.dwl", {"main.dwl": "output application/xml --- 2" }, {"payload": jsonValue }),
   "defaultOutput" : eval("main.dwl", {"main.dwl": "payload" }, {"payload": jsonValue2}, {},{outputMimeType: "application/csv", writerProperties: {"separator": "|"}}),
   "onExceptionFail": do  {
     dw::Runtime::try( () ->
         eval("main.dwl", {"main.dwl": "dw::Runtime::fail('Failing Test')" }, {"payload": jsonValue2}, {},{onException: "FAIL"})
     ).success
   },
   "customLogger":
        eval(
  "main.dwl",
           {"main.dwl": "log(1234)" },
   {"payload": jsonValue2},
    {},
   {
                  loggerService: {
                     initialize: () -> {token: "123"},
                     log: (level, msg, context) -> log("$(level) $(msg)", context)
                  }
                }
           )
}
```

#### Output

```Json
{
  "execute_ok": {
    "success": true,
    "value": "{\n  a: 1\n}",
    "mimeType": "application/dw",
    "encoding": "UTF-8",
    "logs": [

    ]
  },
  "logs": {
    "m": [
      "1"
    ],
    "l": [
      "INFO"
    ]
  },
  "grant": {
    "success": false,
    "message": "The given required permissions: `Resource` are not being granted for this execution.\nTrace:\n  at readUrl (Unknown)\n  at main::main (line: 1, column: 5)",
    "location": {
      "start": {
        "index": 0,
        "line": 0,
        "column": 0
      },
      "end": {
        "index": 0,
        "line": 0,
        "column": 0
      },
      "content": "Unknown location"
    },
    "stack": [
      "readUrl (anonymous:0:0)",
      "main (main:1:5)"
    ],
    "logs": [

    ]
  },
  "library": {
    "success": true,
    "value": 3,
    "logs": [

    ]
  },
  "timeout": true,
  "execFail": {
    "success": false,
    "message": "My Bad\nTrace:\n  at fail (Unknown)\n  at main::main (line: 1, column: 1)",
    "location": {
      "start": {
        "index": 0,
        "line": 0,
        "column": 0
      },
      "end": {
        "index": 0,
        "line": 0,
        "column": 0
      },
      "content": "Unknown location"
    },
    "stack": [
      "fail (anonymous:0:0)",
      "main (main:1:1)"
    ],
    "logs": [

    ]
  },
  "parseFail": {
    "success": false,
    "message": "Invalid input \"1 + \", expected parameter or parenEnd (line 1, column 2):\n\n\n1| (1 + \n    ^^^^\nLocation:\nmain (line: 1, column:2)",
    "location": {
      "start": {
        "index": 0,
        "line": 1,
        "column": 2
      },
      "end": {
        "index": 4,
        "line": 1,
        "column": 6
      },
      "content": "\n1| (1 + \n    ^^^^"
    },
    "logs": [

    ]
  },
  "writerFail": {
    "success": true,
    "value": 2,
    "logs": [

    ]
  },
  "defaultOutput": {
    "success": true,
    "value": {
      "name": "Mariano",
      "lastName": "achaval"
    },
    "logs": [

    ]
  },
  "onExceptionFail": false,
  "customLogger": {
    "success": true,
    "value": 1234,
    "logs": [

    ]
  }
}
```

<!-- document id=4c9d700004976ee2b7acb71582d68cc05f0c9cee2219a1f11afef5c214184ebb url=/mulesoft/current/en-us/dataweave/2.6/dw-runtime-functions-eval.md -->

---
product: DataWeave
version: 2.6
---

# eval

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## eval(fileToExecute: String, fs: Dictionary<String>, readerInputs: Dictionary<ReaderInput> = {}, inputValues: Dictionary<Any> = {}, configuration: RuntimeExecutionConfiguration = {}): EvalSuccess | ExecutionFailure

Evaluates a script with the specified context and returns the result of that evaluation.

_Experimental:_ This function is an experimental feature that is subject to change or removal from
future versions of DataWeave.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>fileToExecute</code></p></td><td><p>Name of the file to execute.</p></td></tr><tr><td><p><code>fs</code></p></td><td><p>An object that contains the file to evaluate.</p></td></tr><tr><td><p><code>readerInputs</code></p></td><td><p>Reader inputs to bind.</p></td></tr><tr><td><p><code>inputValues</code></p></td><td><p>Additional literal values to bind</p></td></tr><tr><td><p><code>configuration</code></p></td><td><p>The runtime configuration.</p></td></tr></tbody></table>

### Example

This example shows how `eval` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime

var jsonValue = {
   value: '{"name": "Mariano"}' as Binary {encoding: "UTF-8"},
   encoding: "UTF-8",
   properties: {},
   mimeType: "application/json"
}

var jsonValue2 = {
   value: '{"name": "Mariano", "lastName": "achaval"}' as Binary {encoding: "UTF-8"},
   encoding: "UTF-8",
   properties: {},
   mimeType: "application/json"
}

var invalidJsonValue = {
   value: '{"name": "Mariano' as Binary {encoding: "UTF-8"},
   encoding: "UTF-8",
   properties: {},
   mimeType: "application/json"
}

var Utils = "fun sum(a,b) = a +b"
output application/json
---
{
   "execute_ok" : run("main.dwl", {"main.dwl": "{a: 1}"}, {"payload": jsonValue }),
   "logs" : do {
     var execResult = run("main.dwl", {"main.dwl": "{a: log(1)}"}, {"payload": jsonValue })
     ---
     {
         m: execResult.logs.message,
         l: execResult.logs.level
     }
   },
   "grant" : eval("main.dwl", {"main.dwl": "{a: readUrl(`http://google.com`)}"}, {"payload": jsonValue }, {},{ securityManager: (grant, args) -> false }),
   "library" : eval("main.dwl", {"main.dwl": "Utils::sum(1,2)", "/Utils.dwl": Utils }, {"payload": jsonValue }),
   "timeout" : eval("main.dwl", {"main.dwl": "(1 to 1000000000000) map \$ + 1" }, {"payload": jsonValue }, {},{timeOut: 2}).success,
   "execFail" : eval("main.dwl", {"main.dwl": "dw::Runtime::fail('My Bad')" }, {"payload": jsonValue }),
   "parseFail" : eval("main.dwl", {"main.dwl": "(1 + " }, {"payload": jsonValue }),
   "writerFail" : eval("main.dwl", {"main.dwl": "output application/xml --- 2" }, {"payload": jsonValue }),
   "defaultOutput" : eval("main.dwl", {"main.dwl": "payload" }, {"payload": jsonValue2}, {},{outputMimeType: "application/csv", writerProperties: {"separator": "|"}}),
   "onExceptionFail": do  {
     dw::Runtime::try( () ->
         eval("main.dwl", {"main.dwl": "dw::Runtime::fail('Failing Test')" }, {"payload": jsonValue2}, {},{onException: "FAIL"})
     ).success
   },
   "customLogger":
        eval(
  "main.dwl",
           {"main.dwl": "log(1234)" },
   {"payload": jsonValue2},
    {},
   {
                  loggerService: {
                     initialize: () -> {token: "123"},
                     log: (level, msg, context) -> log("$(level) $(msg)", context)
                  }
                }
           )
}
```

#### Output

```Json
{
  "execute_ok": {
    "success": true,
    "value": "{\n  a: 1\n}",
    "mimeType": "application/dw",
    "encoding": "UTF-8",
    "logs": [

    ]
  },
  "logs": {
    "m": [
      "1"
    ],
    "l": [
      "INFO"
    ]
  },
  "grant": {
    "success": false,
    "message": "The given required permissions: `Resource` are not being granted for this execution.\nTrace:\n  at readUrl (Unknown)\n  at main::main (line: 1, column: 5)",
    "location": {
      "start": {
        "index": 0,
        "line": 0,
        "column": 0
      },
      "end": {
        "index": 0,
        "line": 0,
        "column": 0
      },
      "content": "Unknown location"
    },
    "stack": [
      "readUrl (anonymous:0:0)",
      "main (main:1:5)"
    ],
    "logs": [

    ]
  },
  "library": {
    "success": true,
    "value": 3,
    "logs": [

    ]
  },
  "timeout": true,
  "execFail": {
    "success": false,
    "message": "My Bad\nTrace:\n  at fail (Unknown)\n  at main::main (line: 1, column: 1)",
    "location": {
      "start": {
        "index": 0,
        "line": 0,
        "column": 0
      },
      "end": {
        "index": 0,
        "line": 0,
        "column": 0
      },
      "content": "Unknown location"
    },
    "stack": [
      "fail (anonymous:0:0)",
      "main (main:1:1)"
    ],
    "logs": [

    ]
  },
  "parseFail": {
    "success": false,
    "message": "Invalid input \"1 + \", expected parameter or parenEnd (line 1, column 2):\n\n\n1| (1 + \n    ^^^^\nLocation:\nmain (line: 1, column:2)",
    "location": {
      "start": {
        "index": 0,
        "line": 1,
        "column": 2
      },
      "end": {
        "index": 4,
        "line": 1,
        "column": 6
      },
      "content": "\n1| (1 + \n    ^^^^"
    },
    "logs": [

    ]
  },
  "writerFail": {
    "success": true,
    "value": 2,
    "logs": [

    ]
  },
  "defaultOutput": {
    "success": true,
    "value": {
      "name": "Mariano",
      "lastName": "achaval"
    },
    "logs": [

    ]
  },
  "onExceptionFail": false,
  "customLogger": {
    "success": true,
    "value": 1234,
    "logs": [

    ]
  }
}
```

<!-- document id=fec01f960fd065c0b9b3b3c490adc49f80f2dad8d8c9bef2c44e317cea6c5278 url=/mulesoft/current/en-us/dataweave/2.9/dw-runtime-functions-eval.md -->

---
product: DataWeave
version: 2.9
---

# eval

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## eval(fileToExecute: String, fs: Dictionary<String>, readerInputs: Dictionary<ReaderInput> = {}, inputValues: Dictionary<Any> = {}, configuration: RuntimeExecutionConfiguration = {}): EvalResult

Evaluates a script with the specified context and returns the result of that evaluation.

_Experimental:_ This function is an experimental feature that is subject to change or removal from
future versions of DataWeave.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>fileToExecute</code></p></td><td><p>Name of the file to execute.</p></td></tr><tr><td><p><code>fs</code></p></td><td><p>An object that contains the file to evaluate.</p></td></tr><tr><td><p><code>readerInputs</code></p></td><td><p>Reader inputs to bind.</p></td></tr><tr><td><p><code>inputValues</code></p></td><td><p>Additional literal values to bind</p></td></tr><tr><td><p><code>configuration</code></p></td><td><p>The runtime configuration.</p></td></tr></tbody></table>

### Example

This example shows how `eval` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime

var jsonValue = {
   value: '{"name": "Mariano"}' as Binary {encoding: "UTF-8"},
   encoding: "UTF-8",
   properties: {},
   mimeType: "application/json"
}

var jsonValue2 = {
   value: '{"name": "Mariano", "lastName": "achaval"}' as Binary {encoding: "UTF-8"},
   encoding: "UTF-8",
   properties: {},
   mimeType: "application/json"
}

var invalidJsonValue = {
   value: '{"name": "Mariano' as Binary {encoding: "UTF-8"},
   encoding: "UTF-8",
   properties: {},
   mimeType: "application/json"
}

var Utils = "fun sum(a,b) = a +b"
output application/json
---
{
   "execute_ok" : run("main.dwl", {"main.dwl": "{a: 1}"}, {"payload": jsonValue }),
   "logs" : do {
     var execResult = run("main.dwl", {"main.dwl": "{a: log(1)}"}, {"payload": jsonValue })
     ---
     {
         m: execResult.logs.message,
         l: execResult.logs.level
     }
   },
   "grant" : eval("main.dwl", {"main.dwl": "{a: readUrl(`http://google.com`)}"}, {"payload": jsonValue }, {},{ securityManager: (grant, args) -> false }),
   "library" : eval("main.dwl", {"main.dwl": "Utils::sum(1,2)", "/Utils.dwl": Utils }, {"payload": jsonValue }),
   "timeout" : eval("main.dwl", {"main.dwl": "(1 to 1000000000000) map \$ + 1" }, {"payload": jsonValue }, {},{timeOut: 2}).success,
   "execFail" : eval("main.dwl", {"main.dwl": "dw::Runtime::fail('My Bad')" }, {"payload": jsonValue }),
   "parseFail" : eval("main.dwl", {"main.dwl": "(1 + " }, {"payload": jsonValue }),
   "writerFail" : eval("main.dwl", {"main.dwl": "output application/xml --- 2" }, {"payload": jsonValue }),
   "defaultOutput" : eval("main.dwl", {"main.dwl": "payload" }, {"payload": jsonValue2}, {},{outputMimeType: "application/csv", writerProperties: {"separator": "|"}}),
   "onExceptionFail": do  {
     dw::Runtime::try( () ->
         eval("main.dwl", {"main.dwl": "dw::Runtime::fail('Failing Test')" }, {"payload": jsonValue2}, {},{onException: "FAIL"})
     ).success
   },
   "customLogger":
        eval(
  "main.dwl",
           {"main.dwl": "log(1234)" },
   {"payload": jsonValue2},
    {},
   {
                  loggerService: {
                     initialize: () -> {token: "123"},
                     log: (level, msg, context) -> log("$(level) $(msg)", context)
                  }
                }
           )
}
```

#### Output

```Json
{
  "execute_ok": {
    "success": true,
    "value": "{\n  a: 1\n}",
    "mimeType": "application/dw",
    "encoding": "UTF-8",
    "logs": [

    ]
  },
  "logs": {
    "m": [
      "1"
    ],
    "l": [
      "INFO"
    ]
  },
  "grant": {
    "success": false,
    "message": "The given required permissions: `Resource` are not being granted for this execution.\nTrace:\n  at readUrl (Unknown)\n  at main::main (line: 1, column: 5)",
    "location": {
      "start": {
        "index": 0,
        "line": 0,
        "column": 0
      },
      "end": {
        "index": 0,
        "line": 0,
        "column": 0
      },
      "content": "Unknown location"
    },
    "stack": [
      "readUrl (anonymous:0:0)",
      "main (main:1:5)"
    ],
    "logs": [

    ]
  },
  "library": {
    "success": true,
    "value": 3,
    "logs": [

    ]
  },
  "timeout": true,
  "execFail": {
    "success": false,
    "message": "My Bad\nTrace:\n  at fail (Unknown)\n  at main::main (line: 1, column: 1)",
    "location": {
      "start": {
        "index": 0,
        "line": 0,
        "column": 0
      },
      "end": {
        "index": 0,
        "line": 0,
        "column": 0
      },
      "content": "Unknown location"
    },
    "stack": [
      "fail (anonymous:0:0)",
      "main (main:1:1)"
    ],
    "logs": [

    ]
  },
  "parseFail": {
    "success": false,
    "message": "Invalid input \"1 + \", expected parameter or parenEnd (line 1, column 2):\n\n\n1| (1 + \n    ^^^^\nLocation:\nmain (line: 1, column:2)",
    "location": {
      "start": {
        "index": 0,
        "line": 1,
        "column": 2
      },
      "end": {
        "index": 4,
        "line": 1,
        "column": 6
      },
      "content": "\n1| (1 + \n    ^^^^"
    },
    "logs": [

    ]
  },
  "writerFail": {
    "success": true,
    "value": 2,
    "logs": [

    ]
  },
  "defaultOutput": {
    "success": true,
    "value": {
      "name": "Mariano",
      "lastName": "achaval"
    },
    "logs": [

    ]
  },
  "onExceptionFail": false,
  "customLogger": {
    "success": true,
    "value": 1234,
    "logs": [

    ]
  }
}
```

<!-- document id=53e86ed176dc5b71e1ee7eb303f99804c393150bf473bf3a40756a83bc97e461 url=/mulesoft/current/en-us/dataweave/latest/dw-runtime-functions-eval.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# eval

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## eval(fileToExecute: String, fs: Dictionary<String>, readerInputs: Dictionary<ReaderInput> = {}, inputValues: Dictionary<Any> = {}, configuration: RuntimeExecutionConfiguration = {}): EvalResult

Evaluates a script with the specified context and returns the result of that evaluation.

_Experimental:_ This function is an experimental feature that is subject to change or removal from
future versions of DataWeave.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>fileToExecute</code></p></td><td><p>Name of the file to execute.</p></td></tr><tr><td><p><code>fs</code></p></td><td><p>An object that contains the file to evaluate.</p></td></tr><tr><td><p><code>readerInputs</code></p></td><td><p>Reader inputs to bind.</p></td></tr><tr><td><p><code>inputValues</code></p></td><td><p>Additional literal values to bind</p></td></tr><tr><td><p><code>configuration</code></p></td><td><p>The runtime configuration.</p></td></tr></tbody></table>

### Example

This example shows how `eval` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime

var jsonValue = {
   value: '{"name": "Mariano"}' as Binary {encoding: "UTF-8"},
   encoding: "UTF-8",
   properties: {},
   mimeType: "application/json"
}

var jsonValue2 = {
   value: '{"name": "Mariano", "lastName": "achaval"}' as Binary {encoding: "UTF-8"},
   encoding: "UTF-8",
   properties: {},
   mimeType: "application/json"
}

var invalidJsonValue = {
   value: '{"name": "Mariano' as Binary {encoding: "UTF-8"},
   encoding: "UTF-8",
   properties: {},
   mimeType: "application/json"
}

var Utils = "fun sum(a,b) = a +b"
output application/json
---
{
   "execute_ok" : run("main.dwl", {"main.dwl": "{a: 1}"}, {"payload": jsonValue }),
   "logs" : do {
     var execResult = run("main.dwl", {"main.dwl": "{a: log(1)}"}, {"payload": jsonValue })
     ---
     {
         m: execResult.logs.message,
         l: execResult.logs.level
     }
   },
   "grant" : eval("main.dwl", {"main.dwl": "{a: readUrl(`http://google.com`)}"}, {"payload": jsonValue }, {},{ securityManager: (grant, args) -> false }),
   "library" : eval("main.dwl", {"main.dwl": "Utils::sum(1,2)", "/Utils.dwl": Utils }, {"payload": jsonValue }),
   "timeout" : eval("main.dwl", {"main.dwl": "(1 to 1000000000000) map \$ + 1" }, {"payload": jsonValue }, {},{timeOut: 2}).success,
   "execFail" : eval("main.dwl", {"main.dwl": "dw::Runtime::fail('My Bad')" }, {"payload": jsonValue }),
   "parseFail" : eval("main.dwl", {"main.dwl": "(1 + " }, {"payload": jsonValue }),
   "writerFail" : eval("main.dwl", {"main.dwl": "output application/xml --- 2" }, {"payload": jsonValue }),
   "defaultOutput" : eval("main.dwl", {"main.dwl": "payload" }, {"payload": jsonValue2}, {},{outputMimeType: "application/csv", writerProperties: {"separator": "|"}}),
   "onExceptionFail": do  {
     dw::Runtime::try( () ->
         eval("main.dwl", {"main.dwl": "dw::Runtime::fail('Failing Test')" }, {"payload": jsonValue2}, {},{onException: "FAIL"})
     ).success
   },
   "customLogger":
        eval(
  "main.dwl",
           {"main.dwl": "log(1234)" },
   {"payload": jsonValue2},
    {},
   {
                  loggerService: {
                     initialize: () -> {token: "123"},
                     log: (level, msg, context) -> log("$(level) $(msg)", context)
                  }
                }
           )
}
```

#### Output

```Json
{
  "execute_ok": {
    "success": true,
    "value": "{\n  a: 1\n}",
    "mimeType": "application/dw",
    "encoding": "UTF-8",
    "logs": [

    ]
  },
  "logs": {
    "m": [
      "1"
    ],
    "l": [
      "INFO"
    ]
  },
  "grant": {
    "success": false,
    "message": "The given required permissions: `Resource` are not being granted for this execution.\nTrace:\n  at readUrl (Unknown)\n  at main::main (line: 1, column: 5)",
    "location": {
      "start": {
        "index": 0,
        "line": 0,
        "column": 0
      },
      "end": {
        "index": 0,
        "line": 0,
        "column": 0
      },
      "content": "Unknown location"
    },
    "stack": [
      "readUrl (anonymous:0:0)",
      "main (main:1:5)"
    ],
    "logs": [

    ]
  },
  "library": {
    "success": true,
    "value": 3,
    "logs": [

    ]
  },
  "timeout": true,
  "execFail": {
    "success": false,
    "message": "My Bad\nTrace:\n  at fail (Unknown)\n  at main::main (line: 1, column: 1)",
    "location": {
      "start": {
        "index": 0,
        "line": 0,
        "column": 0
      },
      "end": {
        "index": 0,
        "line": 0,
        "column": 0
      },
      "content": "Unknown location"
    },
    "stack": [
      "fail (anonymous:0:0)",
      "main (main:1:1)"
    ],
    "logs": [

    ]
  },
  "parseFail": {
    "success": false,
    "message": "Invalid input \"1 + \", expected parameter or parenEnd (line 1, column 2):\n\n\n1| (1 + \n    ^^^^\nLocation:\nmain (line: 1, column:2)",
    "location": {
      "start": {
        "index": 0,
        "line": 1,
        "column": 2
      },
      "end": {
        "index": 4,
        "line": 1,
        "column": 6
      },
      "content": "\n1| (1 + \n    ^^^^"
    },
    "logs": [

    ]
  },
  "writerFail": {
    "success": true,
    "value": 2,
    "logs": [

    ]
  },
  "defaultOutput": {
    "success": true,
    "value": {
      "name": "Mariano",
      "lastName": "achaval"
    },
    "logs": [

    ]
  },
  "onExceptionFail": false,
  "customLogger": {
    "success": true,
    "value": 1234,
    "logs": [

    ]
  }
}
```

<!-- document id=e341c01d3b12454c0a3122259215b2ac53b1dc32156088cfd11d479b0cb68925 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-evaluatecompatibilityflag.md -->

---
product: DataWeave
version: 2.11
---

# evaluateCompatibilityFlag

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## evaluateCompatibilityFlag(flag: String): Boolean

Returns the value of the compatibility flag with the specified name.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>flag</code></p></td><td><p>String</p></td><td><p>The name of the compatibility flag to evaluate.</p></td></tr></tbody></table>

### Example

This example gets the `com.mulesoft.dw.xml_reader.honourMixedContentStructure` compatibility flag
value in the current DataWeave version.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  "com.mulesoft.dw.xml_reader.honourMixedContentStructure": evaluateCompatibilityFlag("com.mulesoft.dw.xml_reader.honourMixedContentStructure")
}
```

#### Output

```Json
{
  "com.mulesoft.dw.xml_reader.honourMixedContentStructure": true
}
```

<!-- document id=5c2b6abcf8b1a3d66f8b4a213c0fe31e68c42a431e13dce6b8f09ffedaaa8cf9 url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-evaluatecompatibilityflag.md -->

---
product: DataWeave
version: 2.12
---

# evaluateCompatibilityFlag

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## evaluateCompatibilityFlag(flag: String): Boolean

Returns the value of the compatibility flag with the specified name.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>flag</code></p></td><td><p>String</p></td><td><p>The name of the compatibility flag to evaluate.</p></td></tr></tbody></table>

### Example

This example gets the `com.mulesoft.dw.xml_reader.honourMixedContentStructure` compatibility flag
value in the current DataWeave version.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  "com.mulesoft.dw.xml_reader.honourMixedContentStructure": evaluateCompatibilityFlag("com.mulesoft.dw.xml_reader.honourMixedContentStructure")
}
```

#### Output

```Json
{
  "com.mulesoft.dw.xml_reader.honourMixedContentStructure": true
}
```

<!-- document id=d0f09410a45ea57763a64456abea632c0bfcb95371929186f1cf56d4295529a7 url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-evaluatecompatibilityflag.md -->

---
product: DataWeave
version: 2.6
---

# evaluateCompatibilityFlag

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## evaluateCompatibilityFlag(flag: String): Boolean

Returns the value of the compatibility flag with the specified name.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>flag</code></p></td><td><p>String</p></td><td><p>The name of the compatibility flag to evaluate.</p></td></tr></tbody></table>

### Example

This example gets the `com.mulesoft.dw.xml_reader.honourMixedContentStructure` compatibility flag
value in the current DataWeave version.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  "com.mulesoft.dw.xml_reader.honourMixedContentStructure": evaluateCompatibilityFlag("com.mulesoft.dw.xml_reader.honourMixedContentStructure")
}
```

#### Output

```Json
{
  "com.mulesoft.dw.xml_reader.honourMixedContentStructure": true
}
```

<!-- document id=10d8893cce902d49f895bc1b0e79b84512bf57e7a1010823308815200e17777e url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-evaluatecompatibilityflag.md -->

---
product: DataWeave
version: 2.9
---

# evaluateCompatibilityFlag

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## evaluateCompatibilityFlag(flag: String): Boolean

Returns the value of the compatibility flag with the specified name.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>flag</code></p></td><td><p>String</p></td><td><p>The name of the compatibility flag to evaluate.</p></td></tr></tbody></table>

### Example

This example gets the `com.mulesoft.dw.xml_reader.honourMixedContentStructure` compatibility flag
value in the current DataWeave version.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  "com.mulesoft.dw.xml_reader.honourMixedContentStructure": evaluateCompatibilityFlag("com.mulesoft.dw.xml_reader.honourMixedContentStructure")
}
```

#### Output

```Json
{
  "com.mulesoft.dw.xml_reader.honourMixedContentStructure": true
}
```

<!-- document id=11b8fed4a0ebfbbb18c1fedb0d34360c0f31b5d1bd426a1d2599502ee3c7d2f7 url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-evaluatecompatibilityflag.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# evaluateCompatibilityFlag

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## evaluateCompatibilityFlag(flag: String): Boolean

Returns the value of the compatibility flag with the specified name.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>flag</code></p></td><td><p>String</p></td><td><p>The name of the compatibility flag to evaluate.</p></td></tr></tbody></table>

### Example

This example gets the `com.mulesoft.dw.xml_reader.honourMixedContentStructure` compatibility flag
value in the current DataWeave version.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  "com.mulesoft.dw.xml_reader.honourMixedContentStructure": evaluateCompatibilityFlag("com.mulesoft.dw.xml_reader.honourMixedContentStructure")
}
```

#### Output

```Json
{
  "com.mulesoft.dw.xml_reader.honourMixedContentStructure": true
}
```

<!-- document id=e47a2ab473257d7e6c6c15aa2681e982baf7872a983cdc0af6d87cfb29560eed url=/mulesoft/current/en-us/dataweave/2.11/dw-runtime-functions-evalurl.md -->

---
product: DataWeave
version: 2.11
---

# evalUrl

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## evalUrl(url: String, readerInputs: Dictionary<ReaderInput> = {}, inputValues: Dictionary<Any> = {}, configuration: RuntimeExecutionConfiguration = {}): EvalResult

Evaluates the script at the specified URL.

_Experimental:_ This function is an experimental feature that is subject to change or removal from
future versions of DataWeave.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>url</code></p></td><td><p>Name of the file execute.</p></td></tr><tr><td><p><code>readerInputs</code></p></td><td><p>Inputs to read and bind to the execution.</p></td></tr><tr><td><p><code>inputValues</code></p></td><td><p>Inputs to bind directly to the execution.</p></td></tr><tr><td><p><code>configuration</code></p></td><td><p>The runtime configuration.</p></td></tr></tbody></table>

### Example

This example shows how `evalUrl` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
var jsonValue = {
  value: '{"name": "Mariano"}' as Binary {encoding: "UTF-8"},
  encoding: "UTF-8",
  properties: {},
  mimeType: "application/json"
}

var Utils = "fun sum(a,b) = a +b"
output application/json
---
{
  "execute_ok" : evalUrl("classpath://org/mule/weave/v2/engine/runtime_evalUrl/example.dwl", {"payload": jsonValue }),
  "execute_ok_withValue" : evalUrl("classpath://org/mule/weave/v2/engine/runtime_evalUrl/example.dwl", {}, {"payload": {name: "Mariano"}})
}
```

#### Output

```Json
{
   "execute_ok": {
     "success": true,
     "value": "Mariano",
     "logs": [

     ]
   },
   "execute_ok_withValue": {
     "success": true,
     "value": "Mariano",
     "logs": [

     ]
   }
 }
```

<!-- document id=f7c3283575db1d935063ffe5887259fc35edd2c6168e96320ca38c1cf8eb8000 url=/mulesoft/current/en-us/dataweave/2.12/dw-runtime-functions-evalurl.md -->

---
product: DataWeave
version: 2.12
---

# evalUrl

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## evalUrl(url: String, readerInputs: Dictionary<ReaderInput> = {}, inputValues: Dictionary<Any> = {}, configuration: RuntimeExecutionConfiguration = {}): EvalResult

Evaluates the script at the specified URL.

_Experimental:_ This function is an experimental feature that is subject to change or removal from
future versions of DataWeave.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>url</code></p></td><td><p>Name of the file execute.</p></td></tr><tr><td><p><code>readerInputs</code></p></td><td><p>Inputs to read and bind to the execution.</p></td></tr><tr><td><p><code>inputValues</code></p></td><td><p>Inputs to bind directly to the execution.</p></td></tr><tr><td><p><code>configuration</code></p></td><td><p>The runtime configuration.</p></td></tr></tbody></table>

### Example

This example shows how `evalUrl` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
var jsonValue = {
  value: '{"name": "Mariano"}' as Binary {encoding: "UTF-8"},
  encoding: "UTF-8",
  properties: {},
  mimeType: "application/json"
}

var Utils = "fun sum(a,b) = a +b"
output application/json
---
{
  "execute_ok" : evalUrl("classpath://org/mule/weave/v2/engine/runtime_evalUrl/example.dwl", {"payload": jsonValue }),
  "execute_ok_withValue" : evalUrl("classpath://org/mule/weave/v2/engine/runtime_evalUrl/example.dwl", {}, {"payload": {name: "Mariano"}})
}
```

#### Output

```Json
{
   "execute_ok": {
     "success": true,
     "value": "Mariano",
     "logs": [

     ]
   },
   "execute_ok_withValue": {
     "success": true,
     "value": "Mariano",
     "logs": [

     ]
   }
 }
```

<!-- document id=761df66508da0dfc00850e93bcd157594c2dcffa5abcf8d7f0730351917d452b url=/mulesoft/current/en-us/dataweave/2.4/dw-runtime-functions-evalurl.md -->

---
product: DataWeave
version: 2.4
---

# evalUrl

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## evalUrl(url: String, readerInputs: Dictionary<ReaderInput> = {}, inputValues: Dictionary<Any> = {}, configuration: RuntimeExecutionConfiguration = {}): EvalSuccess | ExecutionFailure

Evaluates the script at the specified URL.

_Experimental:_ This function is an experimental feature that is subject to change or removal from
future versions of DataWeave.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>url</code></p></td><td><p>Name of the file execute.</p></td></tr><tr><td><p><code>readerInputs</code></p></td><td><p>Inputs to read and bind to the execution.</p></td></tr><tr><td><p><code>inputValues</code></p></td><td><p>Inputs to bind directly to the execution.</p></td></tr><tr><td><p><code>configuration</code></p></td><td><p>The runtime configuration.</p></td></tr></tbody></table>

### Example

This example shows how `evalUrl` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
var jsonValue = {
  value: '{"name": "Mariano"}' as Binary {encoding: "UTF-8"},
  encoding: "UTF-8",
  properties: {},
  mimeType: "application/json"
}

var Utils = "fun sum(a,b) = a +b"
output application/json
---
{
  "execute_ok" : evalUrl("classpath://org/mule/weave/v2/engine/runtime_evalUrl/example.dwl", {"payload": jsonValue }),
  "execute_ok_withValue" : evalUrl("classpath://org/mule/weave/v2/engine/runtime_evalUrl/example.dwl", {}, {"payload": {name: "Mariano"}})
}
```

#### Output

```Json
{
   "execute_ok": {
     "success": true,
     "value": "Mariano",
     "logs": [

     ]
   },
   "execute_ok_withValue": {
     "success": true,
     "value": "Mariano",
     "logs": [

     ]
   }
 }
```

<!-- document id=5c5a1175aa4b2313c503b94a266c0b6303ccbbce7322988e43dcdb38c803d9a8 url=/mulesoft/current/en-us/dataweave/2.6/dw-runtime-functions-evalurl.md -->

---
product: DataWeave
version: 2.6
---

# evalUrl

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## evalUrl(url: String, readerInputs: Dictionary<ReaderInput> = {}, inputValues: Dictionary<Any> = {}, configuration: RuntimeExecutionConfiguration = {}): EvalSuccess | ExecutionFailure

Evaluates the script at the specified URL.

_Experimental:_ This function is an experimental feature that is subject to change or removal from
future versions of DataWeave.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>url</code></p></td><td><p>Name of the file execute.</p></td></tr><tr><td><p><code>readerInputs</code></p></td><td><p>Inputs to read and bind to the execution.</p></td></tr><tr><td><p><code>inputValues</code></p></td><td><p>Inputs to bind directly to the execution.</p></td></tr><tr><td><p><code>configuration</code></p></td><td><p>The runtime configuration.</p></td></tr></tbody></table>

### Example

This example shows how `evalUrl` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
var jsonValue = {
  value: '{"name": "Mariano"}' as Binary {encoding: "UTF-8"},
  encoding: "UTF-8",
  properties: {},
  mimeType: "application/json"
}

var Utils = "fun sum(a,b) = a +b"
output application/json
---
{
  "execute_ok" : evalUrl("classpath://org/mule/weave/v2/engine/runtime_evalUrl/example.dwl", {"payload": jsonValue }),
  "execute_ok_withValue" : evalUrl("classpath://org/mule/weave/v2/engine/runtime_evalUrl/example.dwl", {}, {"payload": {name: "Mariano"}})
}
```

#### Output

```Json
{
   "execute_ok": {
     "success": true,
     "value": "Mariano",
     "logs": [

     ]
   },
   "execute_ok_withValue": {
     "success": true,
     "value": "Mariano",
     "logs": [

     ]
   }
 }
```

<!-- document id=0010aaf1d14f7460f7c1efc0f385da91dbae1481bf37c99848049f5a68f9d3e3 url=/mulesoft/current/en-us/dataweave/2.9/dw-runtime-functions-evalurl.md -->

---
product: DataWeave
version: 2.9
---

# evalUrl

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## evalUrl(url: String, readerInputs: Dictionary<ReaderInput> = {}, inputValues: Dictionary<Any> = {}, configuration: RuntimeExecutionConfiguration = {}): EvalResult

Evaluates the script at the specified URL.

_Experimental:_ This function is an experimental feature that is subject to change or removal from
future versions of DataWeave.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>url</code></p></td><td><p>Name of the file execute.</p></td></tr><tr><td><p><code>readerInputs</code></p></td><td><p>Inputs to read and bind to the execution.</p></td></tr><tr><td><p><code>inputValues</code></p></td><td><p>Inputs to bind directly to the execution.</p></td></tr><tr><td><p><code>configuration</code></p></td><td><p>The runtime configuration.</p></td></tr></tbody></table>

### Example

This example shows how `evalUrl` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
var jsonValue = {
  value: '{"name": "Mariano"}' as Binary {encoding: "UTF-8"},
  encoding: "UTF-8",
  properties: {},
  mimeType: "application/json"
}

var Utils = "fun sum(a,b) = a +b"
output application/json
---
{
  "execute_ok" : evalUrl("classpath://org/mule/weave/v2/engine/runtime_evalUrl/example.dwl", {"payload": jsonValue }),
  "execute_ok_withValue" : evalUrl("classpath://org/mule/weave/v2/engine/runtime_evalUrl/example.dwl", {}, {"payload": {name: "Mariano"}})
}
```

#### Output

```Json
{
   "execute_ok": {
     "success": true,
     "value": "Mariano",
     "logs": [

     ]
   },
   "execute_ok_withValue": {
     "success": true,
     "value": "Mariano",
     "logs": [

     ]
   }
 }
```

<!-- document id=b0c44e5be84544d6e9ffd6326e66973758631dd32eb0d511522a687bfdf4a814 url=/mulesoft/current/en-us/dataweave/latest/dw-runtime-functions-evalurl.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# evalUrl

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## evalUrl(url: String, readerInputs: Dictionary<ReaderInput> = {}, inputValues: Dictionary<Any> = {}, configuration: RuntimeExecutionConfiguration = {}): EvalResult

Evaluates the script at the specified URL.

_Experimental:_ This function is an experimental feature that is subject to change or removal from
future versions of DataWeave.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>url</code></p></td><td><p>Name of the file execute.</p></td></tr><tr><td><p><code>readerInputs</code></p></td><td><p>Inputs to read and bind to the execution.</p></td></tr><tr><td><p><code>inputValues</code></p></td><td><p>Inputs to bind directly to the execution.</p></td></tr><tr><td><p><code>configuration</code></p></td><td><p>The runtime configuration.</p></td></tr></tbody></table>

### Example

This example shows how `evalUrl` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
var jsonValue = {
  value: '{"name": "Mariano"}' as Binary {encoding: "UTF-8"},
  encoding: "UTF-8",
  properties: {},
  mimeType: "application/json"
}

var Utils = "fun sum(a,b) = a +b"
output application/json
---
{
  "execute_ok" : evalUrl("classpath://org/mule/weave/v2/engine/runtime_evalUrl/example.dwl", {"payload": jsonValue }),
  "execute_ok_withValue" : evalUrl("classpath://org/mule/weave/v2/engine/runtime_evalUrl/example.dwl", {}, {"payload": {name: "Mariano"}})
}
```

#### Output

```Json
{
   "execute_ok": {
     "success": true,
     "value": "Mariano",
     "logs": [

     ]
   },
   "execute_ok_withValue": {
     "success": true,
     "value": "Mariano",
     "logs": [

     ]
   }
 }
```

<!-- document id=59759f7f88ab7f5d908bd62df22101a73ba047423fdf54402dde9e65030865df url=/mulesoft/current/en-us/dataweave/2.11/dataweave-formats-eventstream.md -->

---
product: DataWeave
version: 2.11
keywords: format, eventstream, text/event-stream, text/event-stream
---

# Event Stream Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `text/event-stream`

ID: `eventstream`

DataWeave represents the Event Stream as an `Array` of `Object`, where each value is a `String`. The
output type is `Array<{_:String}>`, where each key represents a field in the event.

## Examples

These examples show uses of the event stream format.

- [Example: Simple Server Event Input](#example1)

- [Example: Ignoring Spaces After the Colon](#example2)

### Example: Simple Server Event Input

This example shows how DataWeave represents a simple server event input.

#### Input

This stream contains four blocks. The first block has one comment, and fires no events. The second
block has two fields with names `data` and `id` respectively; an event is fired with the data
`first event` and sets the last event ID to `1`. The third block fires an event with the data
`second event`; it also has an `id` field with no value, which resets the last event ID to an empty
string. The fourth block contains a `data` field with the value `third event`, which fires an event.

```event-stream
: test stream

data: first event
id: 1

data:second event
id

data:  third event
```

#### Source

The DataWeave script transforms this input into the given output.

```dataweave
%dw 2.0
output application/json
---
payload
```

#### Output

The JSON format outputs these three events.

```json
[
  {
    "data": "first event",
    "id": "1"
  },
  {
    "data": "second event",
    "id": ""
  },
  {
    "data": "third event"
  }
]
```

### Example: Ignoring Spaces After the Colon

This example shows that spaces after the colon are ignored if present.

#### Input

myInput.sse:

```event-stream
data:test

data: test
```

#### Source

This process transforms the input into JSON.

```dataweave
%dw 2.0

output application/json
---
payload
```

#### Output

The JSON output is an `Array` of the valid `Object` from the server event input.

```weave
[
  {
    "data": "test"
  },
  {
    "data": "test"
  }
]
```

## Configuration Properties

DataWeave supports these configuration properties for this format.

### Reader Properties

This format has no reader properties.

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports this MIME type:

- `text/event-stream`

<!-- document id=09e170c1ac47c0c4b4c8a2cfe546be2999004df51e60b39ed9623f3900724e91 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-formats-eventstream.md -->

---
product: DataWeave
version: 2.12
keywords: format, eventstream, text/event-stream, text/event-stream
---

# Event Stream Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `text/event-stream`

ID: `eventstream`

DataWeave represents the Event Stream as an `Array` of `Object`, where each value is a `String`. The
output type is `Array<{_:String}>`, where each key represents a field in the event.

## Examples

These examples show uses of the event stream format.

- [Example: Simple Server Event Input](#example1)

- [Example: Ignoring Spaces After the Colon](#example2)

### Example: Simple Server Event Input

This example shows how DataWeave represents a simple server event input.

#### Input

This stream contains four blocks. The first block has one comment, and fires no events. The second
block has two fields with names `data` and `id` respectively; an event is fired with the data
`first event` and sets the last event ID to `1`. The third block fires an event with the data
`second event`; it also has an `id` field with no value, which resets the last event ID to an empty
string. The fourth block contains a `data` field with the value `third event`, which fires an event.

```event-stream
: test stream

data: first event
id: 1

data:second event
id

data:  third event
```

#### Source

The DataWeave script transforms this input into the given output.

```dataweave
%dw 2.0
output application/json
---
payload
```

#### Output

The JSON format outputs these three events.

```json
[
  {
    "data": "first event",
    "id": "1"
  },
  {
    "data": "second event",
    "id": ""
  },
  {
    "data": "third event"
  }
]
```

### Example: Ignoring Spaces After the Colon

This example shows that spaces after the colon are ignored if present.

#### Input

myInput.sse:

```event-stream
data:test

data: test
```

#### Source

This process transforms the input into JSON.

```dataweave
%dw 2.0

output application/json
---
payload
```

#### Output

The JSON output is an `Array` of the valid `Object` from the server event input.

```weave
[
  {
    "data": "test"
  },
  {
    "data": "test"
  }
]
```

## Configuration Properties

DataWeave supports these configuration properties for this format.

### Reader Properties

This format has no reader properties.

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports this MIME type:

- `text/event-stream`

<!-- document id=2933c13d98eb295876fe6c7aaf494950461707a2bbd4cca6d51bee574fe2a407 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-formats-eventstream.md -->

---
product: DataWeave
version: 2.9
keywords: format, eventstream, text/event-stream, text/event-stream
---

# Event Stream Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `text/event-stream`

ID: `eventstream`

DataWeave represents the Event Stream as an `Array` of `Object`, where each value is a `String`. The
output type is `Array<{_:String}>`, where each key represents a field in the event.

## Examples

These examples show uses of the Event Stream format.

- [Example: Simple Server Event Input](#example1)

- [Example: Ignoring Spaces After the Colon](#example2)

### Example: Simple Server Event Input

This example shows how DataWeave represents a simple server event input.

#### Input

This stream contains four blocks. The first block has one comment, and fires no events. The second
block has two fields with names `data` and `id` respectively; an event is fired with the data
`first event` and sets the last event ID to `1`. The third block fires an event with the data
`second event`; it also has an `id` field with no value, which resets the last event ID to an empty
string. The fourth block contains a `data` field with the value `third event`, which fires an event.

```event-stream
: test stream

data: first event
id: 1

data:second event
id

data:  third event
```

#### Source

The DataWeave script transforms this input into the given output.

```dataweave
%dw 2.0
output application/json
---
payload
```

#### Output

The JSON format outputs the 3 events.

```json
[
  {
    "data": "first event",
    "id": "1"
  },
  {
    "data": "second event",
    "id": ""
  },
  {
    "data": "third event"
  }
]
```

### Example: Ignoring Spaces After the Colon

This example shows that spaces after the colon are ignored if present.

#### Input

myInput.sse:

```event-stream
data:test

data: test
```

#### Source

This process transforms the input into JSON.

```dataweave
%dw 2.0

output application/json
---
payload
```

#### Output

The JSON output is an `Array` of the valid `Object` from the server event input.

```weave
[
  {
    "data": "test"
  },
  {
    "data": "test"
  }
]
```

## Configuration Properties

DataWeave supports these configuration properties for this format.

### Reader Properties

This format has no reader properties.

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>text/event-stream</code></p></td></tr></tbody></table>

<!-- document id=728c811fa4e31f88b04d95c6224dc0db627bf630e4527bb1b7a15869a72769c5 url=/mulesoft/current/en-us/dataweave/latest/dataweave-formats-eventstream.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: format, eventstream, text/event-stream, text/event-stream
---

# Event Stream Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `text/event-stream`

ID: `eventstream`

DataWeave represents the Event Stream as an `Array` of `Object`, where each value is a `String`. The
output type is `Array<{_:String}>`, where each key represents a field in the event.

## Examples

These examples show uses of the event stream format.

- [Example: Simple Server Event Input](#example1)

- [Example: Ignoring Spaces After the Colon](#example2)

### Example: Simple Server Event Input

This example shows how DataWeave represents a simple server event input.

#### Input

This stream contains four blocks. The first block has one comment, and fires no events. The second
block has two fields with names `data` and `id` respectively; an event is fired with the data
`first event` and sets the last event ID to `1`. The third block fires an event with the data
`second event`; it also has an `id` field with no value, which resets the last event ID to an empty
string. The fourth block contains a `data` field with the value `third event`, which fires an event.

```event-stream
: test stream

data: first event
id: 1

data:second event
id

data:  third event
```

#### Source

The DataWeave script transforms this input into the given output.

```dataweave
%dw 2.0
output application/json
---
payload
```

#### Output

The JSON format outputs these three events.

```json
[
  {
    "data": "first event",
    "id": "1"
  },
  {
    "data": "second event",
    "id": ""
  },
  {
    "data": "third event"
  }
]
```

### Example: Ignoring Spaces After the Colon

This example shows that spaces after the colon are ignored if present.

#### Input

myInput.sse:

```event-stream
data:test

data: test
```

#### Source

This process transforms the input into JSON.

```dataweave
%dw 2.0

output application/json
---
payload
```

#### Output

The JSON output is an `Array` of the valid `Object` from the server event input.

```weave
[
  {
    "data": "test"
  },
  {
    "data": "test"
  }
]
```

## Configuration Properties

DataWeave supports these configuration properties for this format.

### Reader Properties

This format has no reader properties.

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports this MIME type:

- `text/event-stream`

<!-- document id=02909e4a15ec4ca88b2a9edc27397356fa91c12493918e4efbf0c6cc3b39430d url=/mulesoft/current/en-us/dataweave/2.11/dw-arrays-functions-every.md -->

---
product: DataWeave
version: 2.11
---

# every

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## every<T>(list: Array<T>, condition: (T) -> Boolean): Boolean

Returns `true` if every element in the array matches the condition.

The function stops iterating after the first negative evaluation of an element in the array.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>list</code></p></td><td><p>The input array.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>A condition (or expression) to apply to elements in the input array.</p></td></tr></tbody></table>

### Example

This example applies a variety of expressions to the input arrays. The `$` references values of the
elements.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
var arr0 = [] as Array<Number>
output application/json
---
{ "results" : [
     "ok" : [
        [1,1,1] every ($ == 1),
        [1] every ($ == 1)
     ],
     "err" : [
        [1,2,3] every ((log('should stop at 2 ==', $) mod 2) == 1),
        [1,1,0] every ($ == 1),
        [0,1,1,0] every (log('should stop at 0 ==', $) == 1),
        [1,2,3] every ($ == 1),
        arr0 every true,
     ]
   ]
 }
```

#### Output

```JSON
{
   "results": [
     {
       "ok": [ true, true ]
     },
     {
       "err": [ false, false, false, false, false ]
     }
   ]
 }
```

## every(value: Null, condition: (Nothing) -> Any): Boolean

Helper function that enables `every` to work with a `null` value.

_Introduced in DataWeave version 2.3.0._

<!-- document id=ce612d60c04b3922530f72602ee4e25a8805e1da1358640f3461db9a4ecae407 url=/mulesoft/current/en-us/dataweave/2.12/dw-arrays-functions-every.md -->

---
product: DataWeave
version: 2.12
---

# every

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## every<T>(list: Array<T>, condition: (T) -> Boolean): Boolean

Returns `true` if every element in the array matches the condition.

The function stops iterating after the first negative evaluation of an element in the array.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>list</code></p></td><td><p>The input array.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>A condition (or expression) to apply to elements in the input array.</p></td></tr></tbody></table>

### Example

This example applies a variety of expressions to the input arrays. The `$` references values of the
elements.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
var arr0 = [] as Array<Number>
output application/json
---
{ "results" : [
     "ok" : [
        [1,1,1] every ($ == 1),
        [1] every ($ == 1)
     ],
     "err" : [
        [1,2,3] every ((log('should stop at 2 ==', $) mod 2) == 1),
        [1,1,0] every ($ == 1),
        [0,1,1,0] every (log('should stop at 0 ==', $) == 1),
        [1,2,3] every ($ == 1),
        arr0 every true,
     ]
   ]
 }
```

#### Output

```JSON
{
   "results": [
     {
       "ok": [ true, true ]
     },
     {
       "err": [ false, false, false, false, false ]
     }
   ]
 }
```

## every(value: Null, condition: (Nothing) -> Any): Boolean

Helper function that enables `every` to work with a `null` value.

_Introduced in DataWeave version 2.3.0._

<!-- document id=ee9535dddda704e1aeffda58e38cd443e7e5fa5f217e7224c7739b65540d0812 url=/mulesoft/current/en-us/dataweave/2.3/dw-arrays-functions-every.md -->

---
product: DataWeave
version: 2.3
---

# every

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## every(Array<T>, (T) -> Boolean): Boolean

Returns `true` if every element in the array matches the condition.

The function stops iterating after the first negative evaluation of an element in the array.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>list</code></p></td><td><p>The input array.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>A condition (or expression) to apply to elements in the input array.</p></td></tr></tbody></table>

### Example

This example applies a variety of expressions to the input arrays. The `$` references values of the
elements.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
var arr0 = [] as Array<Number>
output application/json
---
{ "results" : [
     "ok" : [
        [1,1,1] every ($ == 1),
        [1] every ($ == 1)
     ],
     "err" : [
        [1,2,3] every ((log('should stop at 2 ==', $) mod 2) == 1),
        [1,1,0] every ($ == 1),
        [0,1,1,0] every (log('should stop at 0 ==', $) == 1),
        [1,2,3] every ($ == 1),
        arr0 every true,
     ]
   ]
 }
```

#### Output

```JSON
{
   "results": [
     {
       "ok": [ true, true ]
     },
     {
       "err": [ false, false, false, false, true ]
     }
   ]
 }
```

## every(Null, (Nothing) -> Boolean): Boolean

Helper function that enables `every` to work with a `null` value.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

<!-- document id=394ef1dee3460ce2a0ae77b02f7ea126f1af8cb879ca31c2bb81e8447c03f958 url=/mulesoft/current/en-us/dataweave/2.4/dw-arrays-functions-every.md -->

---
product: DataWeave
version: 2.4
---

# every

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## every<T>(list: Array<T>, condition: (T) -> Boolean): Boolean

Returns `true` if every element in the array matches the condition.

The function stops iterating after the first negative evaluation of an element in the array.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>list</code></p></td><td><p>The input array.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>A condition (or expression) to apply to elements in the input array.</p></td></tr></tbody></table>

### Example

This example applies a variety of expressions to the input arrays. The `$` references values of the
elements.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
var arr0 = [] as Array<Number>
output application/json
---
{ "results" : [
     "ok" : [
        [1,1,1] every ($ == 1),
        [1] every ($ == 1)
     ],
     "err" : [
        [1,2,3] every ((log('should stop at 2 ==', $) mod 2) == 1),
        [1,1,0] every ($ == 1),
        [0,1,1,0] every (log('should stop at 0 ==', $) == 1),
        [1,2,3] every ($ == 1),
        arr0 every true,
     ]
   ]
 }
```

#### Output

```JSON
{
   "results": [
     {
       "ok": [ true, true ]
     },
     {
       "err": [ false, false, false, false, false ]
     }
   ]
 }
```

## every(value: Null, condition: (Nothing) -> Any): Boolean

Helper function that enables `every` to work with a `null` value.

_Introduced in DataWeave version 2.3.0._

<!-- document id=dfabdad07bc4b300464387d6f30054b88fd08197940fc05b1e973ee6276e17d9 url=/mulesoft/current/en-us/dataweave/2.6/dw-arrays-functions-every.md -->

---
product: DataWeave
version: 2.6
---

# every

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## every<T>(list: Array<T>, condition: (T) -> Boolean): Boolean

Returns `true` if every element in the array matches the condition.

The function stops iterating after the first negative evaluation of an element in the array.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>list</code></p></td><td><p>The input array.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>A condition (or expression) to apply to elements in the input array.</p></td></tr></tbody></table>

### Example

This example applies a variety of expressions to the input arrays. The `$` references values of the
elements.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
var arr0 = [] as Array<Number>
output application/json
---
{ "results" : [
     "ok" : [
        [1,1,1] every ($ == 1),
        [1] every ($ == 1)
     ],
     "err" : [
        [1,2,3] every ((log('should stop at 2 ==', $) mod 2) == 1),
        [1,1,0] every ($ == 1),
        [0,1,1,0] every (log('should stop at 0 ==', $) == 1),
        [1,2,3] every ($ == 1),
        arr0 every true,
     ]
   ]
 }
```

#### Output

```JSON
{
   "results": [
     {
       "ok": [ true, true ]
     },
     {
       "err": [ false, false, false, false, false ]
     }
   ]
 }
```

## every(value: Null, condition: (Nothing) -> Any): Boolean

Helper function that enables `every` to work with a `null` value.

_Introduced in DataWeave version 2.3.0._

<!-- document id=08764553e1f5553d5a14ef4f60a4863dd826658c9d038fa78e963211ad01c4c6 url=/mulesoft/current/en-us/dataweave/2.9/dw-arrays-functions-every.md -->

---
product: DataWeave
version: 2.9
---

# every

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## every<T>(list: Array<T>, condition: (T) -> Boolean): Boolean

Returns `true` if every element in the array matches the condition.

The function stops iterating after the first negative evaluation of an element in the array.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>list</code></p></td><td><p>The input array.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>A condition (or expression) to apply to elements in the input array.</p></td></tr></tbody></table>

### Example

This example applies a variety of expressions to the input arrays. The `$` references values of the
elements.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
var arr0 = [] as Array<Number>
output application/json
---
{ "results" : [
     "ok" : [
        [1,1,1] every ($ == 1),
        [1] every ($ == 1)
     ],
     "err" : [
        [1,2,3] every ((log('should stop at 2 ==', $) mod 2) == 1),
        [1,1,0] every ($ == 1),
        [0,1,1,0] every (log('should stop at 0 ==', $) == 1),
        [1,2,3] every ($ == 1),
        arr0 every true,
     ]
   ]
 }
```

#### Output

```JSON
{
   "results": [
     {
       "ok": [ true, true ]
     },
     {
       "err": [ false, false, false, false, false ]
     }
   ]
 }
```

## every(value: Null, condition: (Nothing) -> Any): Boolean

Helper function that enables `every` to work with a `null` value.

_Introduced in DataWeave version 2.3.0._

<!-- document id=ecb9df5a74e732844b496ece3decb012de4a752acc578e36dcebcd91ac39adfa url=/mulesoft/current/en-us/dataweave/latest/dw-arrays-functions-every.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# every

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## every<T>(list: Array<T>, condition: (T) -> Boolean): Boolean

Returns `true` if every element in the array matches the condition.

The function stops iterating after the first negative evaluation of an element in the array.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>list</code></p></td><td><p>The input array.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>A condition (or expression) to apply to elements in the input array.</p></td></tr></tbody></table>

### Example

This example applies a variety of expressions to the input arrays. The `$` references values of the
elements.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
var arr0 = [] as Array<Number>
output application/json
---
{ "results" : [
     "ok" : [
        [1,1,1] every ($ == 1),
        [1] every ($ == 1)
     ],
     "err" : [
        [1,2,3] every ((log('should stop at 2 ==', $) mod 2) == 1),
        [1,1,0] every ($ == 1),
        [0,1,1,0] every (log('should stop at 0 ==', $) == 1),
        [1,2,3] every ($ == 1),
        arr0 every true,
     ]
   ]
 }
```

#### Output

```JSON
{
   "results": [
     {
       "ok": [ true, true ]
     },
     {
       "err": [ false, false, false, false, false ]
     }
   ]
 }
```

## every(value: Null, condition: (Nothing) -> Any): Boolean

Helper function that enables `every` to work with a `null` value.

_Introduced in DataWeave version 2.3.0._

<!-- document id=c16bafdf4d312e9614b3bf39ca357b28a87502005ecac129b6763ead9f950d8f url=/mulesoft/current/en-us/dataweave/2.11/dw-strings-functions-everycharacter.md -->

---
product: DataWeave
version: 2.11
---

# everyCharacter

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## everyCharacter(text: String, condition: (character: String) -> Boolean): Boolean

Checks whether a condition is valid for _every_ character in a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to check.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>Expression that iterates through the characters in the string that it checks and returns a Boolean value.</p></td></tr></tbody></table>

### Example

This example determines whether a string is composed of only digits and spaces.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
"12 34  56" everyCharacter $ == " " or isNumeric($)
```

#### Output

```Json
true
```

## everyCharacter(text: Null, condition: (character: Nothing) -> Any): true

Helper function that enables `everyCharacter` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=b30386cc18a17f45e24ccb07abd37d57bb6c68e3f61b4ce7e1a02476d74c58a4 url=/mulesoft/current/en-us/dataweave/2.12/dw-strings-functions-everycharacter.md -->

---
product: DataWeave
version: 2.12
---

# everyCharacter

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## everyCharacter(text: String, condition: (character: String) -> Boolean): Boolean

Checks whether a condition is valid for _every_ character in a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to check.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>Expression that iterates through the characters in the string that it checks and returns a Boolean value.</p></td></tr></tbody></table>

### Example

This example determines whether a string is composed of only digits and spaces.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
"12 34  56" everyCharacter $ == " " or isNumeric($)
```

#### Output

```Json
true
```

## everyCharacter(text: Null, condition: (character: Nothing) -> Any): true

Helper function that enables `everyCharacter` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=bd948b9c8447d05a99631f8cf55392a686e15cc84ce1f46e1022d6da247ae3a5 url=/mulesoft/current/en-us/dataweave/2.4/dw-strings-functions-everycharacter.md -->

---
product: DataWeave
version: 2.4
---

# everyCharacter

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## everyCharacter(text: String, condition: (character: String) -> Boolean): Boolean

Checks whether a condition is valid for _every_ character in a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to check.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>Expression that iterates through the characters in the string that it checks and returns a Boolean value.</p></td></tr></tbody></table>

### Example

This example determines whether a string is composed of only digits and spaces.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
"12 34  56" everyCharacter $ == " " or isNumeric($)
```

#### Output

```Json
true
```

## everyCharacter(text: Null, condition: (character: Nothing) -> Any): true

Helper function that enables `everyCharacter` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=229255ea4ac2b42a2bef338a5b5c20b8e2c4815e22a629b0cc266f7e637e9d3a url=/mulesoft/current/en-us/dataweave/2.6/dw-strings-functions-everycharacter.md -->

---
product: DataWeave
version: 2.6
---

# everyCharacter

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## everyCharacter(text: String, condition: (character: String) -> Boolean): Boolean

Checks whether a condition is valid for _every_ character in a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to check.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>Expression that iterates through the characters in the string that it checks and returns a Boolean value.</p></td></tr></tbody></table>

### Example

This example determines whether a string is composed of only digits and spaces.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
"12 34  56" everyCharacter $ == " " or isNumeric($)
```

#### Output

```Json
true
```

## everyCharacter(text: Null, condition: (character: Nothing) -> Any): true

Helper function that enables `everyCharacter` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=ff3bd8e6ee9919fd9e4fe00c2587fc3efbd655ac91a4d5d7a2fd9deaf93fa343 url=/mulesoft/current/en-us/dataweave/2.9/dw-strings-functions-everycharacter.md -->

---
product: DataWeave
version: 2.9
---

# everyCharacter

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## everyCharacter(text: String, condition: (character: String) -> Boolean): Boolean

Checks whether a condition is valid for _every_ character in a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to check.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>Expression that iterates through the characters in the string that it checks and returns a Boolean value.</p></td></tr></tbody></table>

### Example

This example determines whether a string is composed of only digits and spaces.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
"12 34  56" everyCharacter $ == " " or isNumeric($)
```

#### Output

```Json
true
```

## everyCharacter(text: Null, condition: (character: Nothing) -> Any): true

Helper function that enables `everyCharacter` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=056e95d82df3489fa377f5664a5425510d7d0efad1faf312ac1aa0f3857e1cba url=/mulesoft/current/en-us/dataweave/latest/dw-strings-functions-everycharacter.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# everyCharacter

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## everyCharacter(text: String, condition: (character: String) -> Boolean): Boolean

Checks whether a condition is valid for _every_ character in a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to check.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>Expression that iterates through the characters in the string that it checks and returns a Boolean value.</p></td></tr></tbody></table>

### Example

This example determines whether a string is composed of only digits and spaces.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
"12 34  56" everyCharacter $ == " " or isNumeric($)
```

#### Output

```Json
true
```

## everyCharacter(text: Null, condition: (character: Nothing) -> Any): true

Helper function that enables `everyCharacter` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=8bfbf86c7bd8b937ed9c9def62aa420ef0780ebc3b50dfc7ddfcb6f19f5dade5 url=/mulesoft/current/en-us/dataweave/2.11/dw-objects-functions-everyentry.md -->

---
product: DataWeave
version: 2.11
---

# everyEntry

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## everyEntry(object: Object, condition: (value: Any, key: Key) -> Boolean): Boolean

Returns `true` if every entry in the object matches the condition.

The function stops iterating after the first negative evaluation of an element in the object.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object to evaluate.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition to apply to each element.</p></td></tr></tbody></table>

### Example

This example shows how `everyEntry` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import everyEntry from dw::core::Objects
output application/json
---
{
    a: {} everyEntry (value, key) -> value is String,
    b: {a: "", b: "123"} everyEntry (value, key) -> value is String,
    c: {a: "", b: 123} everyEntry (value, key) -> value is String,
    d: {a: "", b: 123} everyEntry (value, key) -> key as String == "a",
    e: {a: ""} everyEntry (value, key) -> key as String == "a",
    f: null everyEntry ((value, key) -> key as String == "a")
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false,
  "d": false,
  "e": true,
  "f": true
}
```

## everyEntry(list: Null, condition: (Nothing, Nothing) -> Boolean): Boolean

Helper function that enables `everyEntry` to work with a `null` value.

_Introduced in DataWeave version 2.3.0._

<!-- document id=211d004d75d021e54da9876953fac528f544f89eece2acfe7da54967635ed135 url=/mulesoft/current/en-us/dataweave/2.12/dw-objects-functions-everyentry.md -->

---
product: DataWeave
version: 2.12
---

# everyEntry

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## everyEntry(object: Object, condition: (value: Any, key: Key) -> Boolean): Boolean

Returns `true` if every entry in the object matches the condition.

The function stops iterating after the first negative evaluation of an element in the object.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object to evaluate.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition to apply to each element.</p></td></tr></tbody></table>

### Example

This example shows how `everyEntry` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import everyEntry from dw::core::Objects
output application/json
---
{
    a: {} everyEntry (value, key) -> value is String,
    b: {a: "", b: "123"} everyEntry (value, key) -> value is String,
    c: {a: "", b: 123} everyEntry (value, key) -> value is String,
    d: {a: "", b: 123} everyEntry (value, key) -> key as String == "a",
    e: {a: ""} everyEntry (value, key) -> key as String == "a",
    f: null everyEntry ((value, key) -> key as String == "a")
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false,
  "d": false,
  "e": true,
  "f": true
}
```

## everyEntry(list: Null, condition: (Nothing, Nothing) -> Boolean): Boolean

Helper function that enables `everyEntry` to work with a `null` value.

_Introduced in DataWeave version 2.3.0._

<!-- document id=65734678921f67a78f2381cca26dcfb43de4f210fdacfc197fae726e96bdfc56 url=/mulesoft/current/en-us/dataweave/2.3/dw-objects-functions-everyentry.md -->

---
product: DataWeave
version: 2.3
---

# everyEntry

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## everyEntry(Object, (value: Any, key: Key) -> Boolean): Boolean

Returns `true` if every entry in the object matches the condition.

The function stops iterating after the first negative evaluation of an element in the object.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object to evaluate.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition to apply to each element.</p></td></tr></tbody></table>

### Example

This example shows how `everyEntry` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import everyEntry from dw::core::Objects
output application/json
---
{
    a: {} everyEntry (value, key) -> value is String,
    b: {a: "", b: "123"} everyEntry (value, key) -> value is String,
    c: {a: "", b: 123} everyEntry (value, key) -> value is String,
    d: {a: "", b: 123} everyEntry (value, key) -> key as String == "a",
    e: {a: ""} everyEntry (value, key) -> key as String == "a",
    f: null everyEntry ((value, key) -> key as String == "a")
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false,
  "d": false,
  "e": true,
  "f": true
}
```

## everyEntry(Null, (Nothing, Nothing) -> Boolean): Boolean

Helper function that enables `everyEntry` to work with a `null` value.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

<!-- document id=73d72cd0c07d4f051200621e66aa55667d1e3f306d5ea3eaa870d370654fe0c8 url=/mulesoft/current/en-us/dataweave/2.4/dw-objects-functions-everyentry.md -->

---
product: DataWeave
version: 2.4
---

# everyEntry

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## everyEntry(object: Object, condition: (value: Any, key: Key) -> Boolean): Boolean

Returns `true` if every entry in the object matches the condition.

The function stops iterating after the first negative evaluation of an element in the object.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object to evaluate.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition to apply to each element.</p></td></tr></tbody></table>

### Example

This example shows how `everyEntry` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import everyEntry from dw::core::Objects
output application/json
---
{
    a: {} everyEntry (value, key) -> value is String,
    b: {a: "", b: "123"} everyEntry (value, key) -> value is String,
    c: {a: "", b: 123} everyEntry (value, key) -> value is String,
    d: {a: "", b: 123} everyEntry (value, key) -> key as String == "a",
    e: {a: ""} everyEntry (value, key) -> key as String == "a",
    f: null everyEntry ((value, key) -> key as String == "a")
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false,
  "d": false,
  "e": true,
  "f": true
}
```

## everyEntry(list: Null, condition: (Nothing, Nothing) -> Boolean): Boolean

Helper function that enables `everyEntry` to work with a `null` value.

_Introduced in DataWeave version 2.3.0._

<!-- document id=00607a7821110cd3b016498e433a852891fe5fa3028334c0b58a189f69b01ad7 url=/mulesoft/current/en-us/dataweave/2.6/dw-objects-functions-everyentry.md -->

---
product: DataWeave
version: 2.6
---

# everyEntry

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## everyEntry(object: Object, condition: (value: Any, key: Key) -> Boolean): Boolean

Returns `true` if every entry in the object matches the condition.

The function stops iterating after the first negative evaluation of an element in the object.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object to evaluate.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition to apply to each element.</p></td></tr></tbody></table>

### Example

This example shows how `everyEntry` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import everyEntry from dw::core::Objects
output application/json
---
{
    a: {} everyEntry (value, key) -> value is String,
    b: {a: "", b: "123"} everyEntry (value, key) -> value is String,
    c: {a: "", b: 123} everyEntry (value, key) -> value is String,
    d: {a: "", b: 123} everyEntry (value, key) -> key as String == "a",
    e: {a: ""} everyEntry (value, key) -> key as String == "a",
    f: null everyEntry ((value, key) -> key as String == "a")
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false,
  "d": false,
  "e": true,
  "f": true
}
```

## everyEntry(list: Null, condition: (Nothing, Nothing) -> Boolean): Boolean

Helper function that enables `everyEntry` to work with a `null` value.

_Introduced in DataWeave version 2.3.0._

<!-- document id=0173561583ba924f1dc4bca5ce924aea4d2a7e1cd5bd59cc711b5b1bc0b779b1 url=/mulesoft/current/en-us/dataweave/2.9/dw-objects-functions-everyentry.md -->

---
product: DataWeave
version: 2.9
---

# everyEntry

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## everyEntry(object: Object, condition: (value: Any, key: Key) -> Boolean): Boolean

Returns `true` if every entry in the object matches the condition.

The function stops iterating after the first negative evaluation of an element in the object.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object to evaluate.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition to apply to each element.</p></td></tr></tbody></table>

### Example

This example shows how `everyEntry` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import everyEntry from dw::core::Objects
output application/json
---
{
    a: {} everyEntry (value, key) -> value is String,
    b: {a: "", b: "123"} everyEntry (value, key) -> value is String,
    c: {a: "", b: 123} everyEntry (value, key) -> value is String,
    d: {a: "", b: 123} everyEntry (value, key) -> key as String == "a",
    e: {a: ""} everyEntry (value, key) -> key as String == "a",
    f: null everyEntry ((value, key) -> key as String == "a")
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false,
  "d": false,
  "e": true,
  "f": true
}
```

## everyEntry(list: Null, condition: (Nothing, Nothing) -> Boolean): Boolean

Helper function that enables `everyEntry` to work with a `null` value.

_Introduced in DataWeave version 2.3.0._

<!-- document id=75a1ba59d5fa3602ed4664ae0eea39a30825d54b17c954cdd6321f3ef90016aa url=/mulesoft/current/en-us/dataweave/latest/dw-objects-functions-everyentry.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# everyEntry

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## everyEntry(object: Object, condition: (value: Any, key: Key) -> Boolean): Boolean

Returns `true` if every entry in the object matches the condition.

The function stops iterating after the first negative evaluation of an element in the object.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object to evaluate.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition to apply to each element.</p></td></tr></tbody></table>

### Example

This example shows how `everyEntry` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import everyEntry from dw::core::Objects
output application/json
---
{
    a: {} everyEntry (value, key) -> value is String,
    b: {a: "", b: "123"} everyEntry (value, key) -> value is String,
    c: {a: "", b: 123} everyEntry (value, key) -> value is String,
    d: {a: "", b: 123} everyEntry (value, key) -> key as String == "a",
    e: {a: ""} everyEntry (value, key) -> key as String == "a",
    f: null everyEntry ((value, key) -> key as String == "a")
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false,
  "d": false,
  "e": true,
  "f": true
}
```

## everyEntry(list: Null, condition: (Nothing, Nothing) -> Boolean): Boolean

Helper function that enables `everyEntry` to work with a `null` value.

_Introduced in DataWeave version 2.3.0._

<!-- document id=162dd92f0b43021f590895be3eba479d4eb1ec3548a2b096c56da5a3a1e81428 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-formats-excel.md -->

---
product: DataWeave
version: 2.11
keywords: format, excel, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/xlsx, application/xlsx
---

# Excel Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/xlsx`

ID: `excel`

An Excel workbook is a sequence of sheets. In DataWeave, this is mapped to an object where each
sheet is a key. Only one table is allowed per Excel sheet. A table is expressed as an array of rows.
A row is an object where its keys are the columns and the values the cell content.

> [!NOTE] Only `.xlsx` files are supported (Excel 2007). `.xls` files are not supported by Mule.

The DataWeave reader for Excel input supports the following parsing strategies:

- In-Memory

- Streaming

To understand the parsing strategies that DataWeave readers and writers can apply to this format,
see [DataWeave Parsing Strategies](https://docs.mulesoft.com/dataweave/2.11/dataweave-formats#dw_readers_writers).

## Excel Type Mapping

The following table shows how Excel types map to DataWeave types.

<table><colgroup><col> <col></colgroup><thead><tr><th>Excel Type</th><th>DataWeave Type</th></tr></thead><tbody><tr><td><p><code>String</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>Numeric</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>Boolean</code></p></td><td><p><code>Boolean</code></p></td></tr><tr><td><p><code>Data</code></p></td><td><p><code>Date</code></p></td></tr></tbody></table>

## Examples

The following examples show uses of the Excel format.

- [Example: Represent Excel in the DataWeave (dw) Format](#example1)

- [Example: Output an Excel Table](#example2)

- [Example: Stream Excel Input](#example3)

### Example: Represent Excel in the DataWeave (dw) Format

This example shows how DataWeave represents an Excel workbook.

#### Input

The Excel workbook (`Sheet1`) serves as an input payload for the DataWeave source.

Sheet1:

. | A | B 1 | Id | Name 2 | 123 | George 3 | 456 | Lucas

#### Source

The DataWeave script transforms the Excel input payload to the DataWeave (dw) format and MIME type.

```dataweave
%dw 2.0
output application/dw
---
payload
```

#### Output

The DataWeave output looks like this. You can select values the same way you select values in other
objects.

```dataweave
{
    "Sheet1": [
        {
                "A": 123,
                "B": "George"
        },
        {
                "A": 456,
                "B": "Lucas"
        }
    ]
}
```

### Example: Output an Excel Table

The following DataWeave script outputs an Excel table with the header and fields.

The body of this DataWeave script is a DataWeave object that defines the content of the Excel sheet.
The name of the sheet, `Sheet1`, is the key of this object. The value is an array of objects. Each
object in the array contains a collection of key-value pairs. The keys in each pair are treated as
header values for the spreadsheet. The values in each pair are treated as data values for a row in
the sheet.

The output directive indicates that the output is the Excel format and MIME type. The `header=true`
setting indicates that the output includes the header values.

```dataweave
%dw 2.0
output application/xlsx header=true
---
{
  Sheet1: [
    {
      Id: 123,
      Name: George
    },
    {
      Id: 456,
      Name: Lucas
    }
  ]
}
```

For another example, see [Look Up Data in an Excel (XLSX) File](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-xlsx-lookup).

### Example: Stream Excel Input

By default, the Excel reader stores input data from an entire file in-memory if the file is 1.5MB or
less. If the file is larger than 1.5 MB, the process writes the data to disk. For very large files,
you can improve the performance of the reader by setting a `streaming` property to `true`.

The following Configuration XML for a Mule application streams an Excel file and transforms it to
JSON.

```xml
<http:listener-config
    name="HTTP_Listener_config"
    doc:name="HTTP Listener config" >
  <http:listener-connection host="0.0.0.0" port="8081" />
</http:listener-config>
<flow name="streaming_flow" >
  <http:listener
    doc:name="Listener"
    config-ref="HTTP_Listener_config"
    path="/"
    outputMimeType="application/xlsx; streaming=true"/>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
payload."Sheet Name" map ((row) -> {
    foo: row.a,
    bar: row.b
})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
</flow>
```

The example:

- Configures the HTTP listener to stream the XLSX input by setting
  `outputMimeType="application/xlsx; streaming=true"`. In the Studio UI, you can use the **MIME
  Type** on the listener to `application/xlsx` and the **Parameters** for the MIME Type to **Key**
  `streaming` and **Value** `true`.

- Uses a DataWeave script in the **Transform Message** component to iterate over each row in the
  XLSX payload (an XLSX sheet called `"Sheet Name"`) and select the values of each cell in the row
  (using `row.a`, `row.b`). It assumes columns named `a` and `b` and maps the values from each row
  in those columns into `foo` and `bar`, respectively.

#### Output

The following image shows the Excel table output.

![A table in an Excel format displaying IDs and names](/mulesoft/current/en-us/dataweave/2.11/_images/dataweave-formats-exceltable.png)

## Limitations

- Macros are currently not supported.

- Charts are ignored.

- Pivot tables are not supported.

- Formatting is currently not supported.

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>header</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether the first line of the output contains header field names.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>ignoreEmptyLine</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Ignores an empty line by default.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>maxEntrySize</code></p></td><td><p><code>Number</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Sets the maximum number of bytes a single entry in a ZIP file can have.</p></div></div></td></tr><tr><td><p><code>minInflateRatio</code></p></td><td><p><code>Number</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Sets the ratio between de- and inflated bytes to detect zip bomb. For example, if you set the value to 1 percent (= 0.01d) when the compression is better than 1 percent for any given read package part, the parsing fails to indicate a zip bomb.</p></div></div></td></tr><tr><td><p><code>streaming</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Streams input when set to <code>true</code>. Use only if entries are accessed sequentially. The input must be a top-level array. See the <a href="#example2">streaming example</a>, and see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats#dw_readers_writers">DataWeave Readers</a>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>tableLimit</code></p></td><td><p><code>String</code></p></td><td><p><code>'Unbounded'</code></p></td><td><div><div><p>Position of the last column in each row. Accepts a pattern <code>&lt;Column&gt;</code> (for example, <code>'A'</code> or <code>'AB'</code>), the value <code>'HeaderSize'</code>, which uses the location of the last header, or 'Unbounded', which consumes each row.</p></div></div></td></tr><tr><td><p><code>tableOffset</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Sets the position of the first cell. Accepts the pattern <code>&lt;Column&gt;&lt;Row&gt;</code>, for example, <code>A1</code> or <code>B3</code>.</p></div></div></td></tr><tr><td><p><code>zipBombCheck</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Turns off the zip bomb (decompression bomb) check when set to <code>false</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>header</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether the first line of the output contains header field names.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>ignoreEmptyLine</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Ignores an empty line by default.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>maxEntrySize</code></p></td><td><p><code>Number</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Sets the maximum number of bytes a single entry in a ZIP file can have.</p></div></div></td></tr><tr><td><p><code>minInflateRatio</code></p></td><td><p><code>Number</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Sets the ratio between de- and inflated bytes to detect zip bomb. For example, if you set the value to 1 percent (= 0.01d) when the compression is better than 1 percent for any given read package part, the parsing fails to indicate a zip bomb.</p></div></div></td></tr><tr><td><p><code>tableOffset</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Sets the position of the first cell. Accepts the pattern <code>&lt;Column&gt;&lt;Row&gt;</code>, for example, <code>A1</code> or <code>B3</code>.</p></div></div></td></tr><tr><td><p><code>zipBombCheck</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Turns off the zip bomb (decompression bomb) check when set to <code>false</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>application/vnd.openxmlformats-officedocument.spreadsheetml.sheet</code></p></td></tr><tr><td><p><code>application/xlsx</code></p></td></tr></tbody></table>

<!-- document id=26b9ffa49733899fba37271578a30bcc1f138fbfa7423c8169e8e8212218465c url=/mulesoft/current/en-us/dataweave/2.12/dataweave-formats-excel.md -->

---
product: DataWeave
version: 2.12
keywords: format, excel, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/xlsx, application/xlsx
---

# Excel Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/xlsx`

ID: `excel`

An Excel workbook is a sequence of sheets. In DataWeave, this is mapped to an object where each
sheet is a key. Only one table is allowed per Excel sheet. A table is expressed as an array of rows.
A row is an object where its keys are the columns and the values the cell content.

> [!NOTE] Only `.xlsx` files are supported (Excel 2007). `.xls` files are not supported by Mule.

The DataWeave reader for Excel input supports the following parsing strategies:

- In-Memory

- Streaming

To understand the parsing strategies that DataWeave readers and writers can apply to this format,
see [DataWeave Parsing Strategies](https://docs.mulesoft.com/dataweave/2.12/dataweave-formats#dw_readers_writers).

## Excel Type Mapping

The following table shows how Excel types map to DataWeave types.

<table><colgroup><col> <col></colgroup><thead><tr><th>Excel Type</th><th>DataWeave Type</th></tr></thead><tbody><tr><td><p><code>String</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>Numeric</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>Boolean</code></p></td><td><p><code>Boolean</code></p></td></tr><tr><td><p><code>Data</code></p></td><td><p><code>Date</code></p></td></tr></tbody></table>

## Examples

The following examples show uses of the Excel format.

- [Example: Represent Excel in the DataWeave (dw) Format](#example1)

- [Example: Output an Excel Table](#example2)

- [Example: Stream Excel Input](#example3)

### Example: Represent Excel in the DataWeave (dw) Format

This example shows how DataWeave represents an Excel workbook.

#### Input

The Excel workbook (`Sheet1`) serves as an input payload for the DataWeave source.

Sheet1:

. | A | B 1 | Id | Name 2 | 123 | George 3 | 456 | Lucas

#### Source

The DataWeave script transforms the Excel input payload to the DataWeave (dw) format and MIME type.

```dataweave
%dw 2.0
output application/dw
---
payload
```

#### Output

The DataWeave output looks like this. You can select values the same way you select values in other
objects.

```dataweave
{
    "Sheet1": [
        {
                "A": 123,
                "B": "George"
        },
        {
                "A": 456,
                "B": "Lucas"
        }
    ]
}
```

### Example: Output an Excel Table

The following DataWeave script outputs an Excel table with the header and fields.

The body of this DataWeave script is a DataWeave object that defines the content of the Excel sheet.
The name of the sheet, `Sheet1`, is the key of this object. The value is an array of objects. Each
object in the array contains a collection of key-value pairs. The keys in each pair are treated as
header values for the spreadsheet. The values in each pair are treated as data values for a row in
the sheet.

The output directive indicates that the output is the Excel format and MIME type. The `header=true`
setting indicates that the output includes the header values.

```dataweave
%dw 2.0
output application/xlsx header=true
---
{
  Sheet1: [
    {
      Id: 123,
      Name: George
    },
    {
      Id: 456,
      Name: Lucas
    }
  ]
}
```

For another example, see [Look Up Data in an Excel (XLSX) File](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-xlsx-lookup).

### Example: Stream Excel Input

By default, the Excel reader stores input data from an entire file in-memory if the file is 1.5MB or
less. If the file is larger than 1.5 MB, the process writes the data to disk. For very large files,
you can improve the performance of the reader by setting a `streaming` property to `true`.

The following Configuration XML for a Mule application streams an Excel file and transforms it to
JSON.

```xml
<http:listener-config
    name="HTTP_Listener_config"
    doc:name="HTTP Listener config" >
  <http:listener-connection host="0.0.0.0" port="8081" />
</http:listener-config>
<flow name="streaming_flow" >
  <http:listener
    doc:name="Listener"
    config-ref="HTTP_Listener_config"
    path="/"
    outputMimeType="application/xlsx; streaming=true"/>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
payload."Sheet Name" map ((row) -> {
    foo: row.a,
    bar: row.b
})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
</flow>
```

The example:

- Configures the HTTP listener to stream the XLSX input by setting
  `outputMimeType="application/xlsx; streaming=true"`. In the Studio UI, you can use the **MIME
  Type** on the listener to `application/xlsx` and the **Parameters** for the MIME Type to **Key**
  `streaming` and **Value** `true`.

- Uses a DataWeave script in the **Transform Message** component to iterate over each row in the
  XLSX payload (an XLSX sheet called `"Sheet Name"`) and select the values of each cell in the row
  (using `row.a`, `row.b`). It assumes columns named `a` and `b` and maps the values from each row
  in those columns into `foo` and `bar`, respectively.

#### Output

The following image shows the Excel table output.

![A table in an Excel format displaying IDs and names](/mulesoft/current/en-us/dataweave/2.12/_images/dataweave-formats-exceltable.png)

## Limitations

- Macros are currently not supported.

- Charts are ignored.

- Pivot tables are not supported.

- Formatting is currently not supported.

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>header</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether the first line of the output contains header field names.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>ignoreEmptyLine</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Ignores an empty line by default.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>maxEntrySize</code></p></td><td><p><code>Number</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Sets the maximum number of bytes a single entry in a ZIP file can have.</p></div></div></td></tr><tr><td><p><code>minInflateRatio</code></p></td><td><p><code>Number</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Sets the ratio between de- and inflated bytes to detect zip bomb. For example, if you set the value to 1 percent (= 0.01d) when the compression is better than 1 percent for any given read package part, the parsing fails to indicate a zip bomb.</p></div></div></td></tr><tr><td><p><code>streaming</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Streams input when set to <code>true</code>. Use only if entries are accessed sequentially. The input must be a top-level array. See the <a href="#example2">streaming example</a>, and see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats#dw_readers_writers">DataWeave Readers</a>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>tableLimit</code></p></td><td><p><code>String</code></p></td><td><p><code>'Unbounded'</code></p></td><td><div><div><p>Position of the last column in each row. Accepts a pattern <code>&lt;Column&gt;</code> (for example, <code>'A'</code> or <code>'AB'</code>), the value <code>'HeaderSize'</code>, which uses the location of the last header, or 'Unbounded', which consumes each row.</p></div></div></td></tr><tr><td><p><code>tableOffset</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Sets the position of the first cell. Accepts the pattern <code>&lt;Column&gt;&lt;Row&gt;</code>, for example, <code>A1</code> or <code>B3</code>.</p></div></div></td></tr><tr><td><p><code>zipBombCheck</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Turns off the zip bomb (decompression bomb) check when set to <code>false</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>header</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether the first line of the output contains header field names.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>ignoreEmptyLine</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Ignores an empty line by default.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>maxEntrySize</code></p></td><td><p><code>Number</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Sets the maximum number of bytes a single entry in a ZIP file can have.</p></div></div></td></tr><tr><td><p><code>minInflateRatio</code></p></td><td><p><code>Number</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Sets the ratio between de- and inflated bytes to detect zip bomb. For example, if you set the value to 1 percent (= 0.01d) when the compression is better than 1 percent for any given read package part, the parsing fails to indicate a zip bomb.</p></div></div></td></tr><tr><td><p><code>tableOffset</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Sets the position of the first cell. Accepts the pattern <code>&lt;Column&gt;&lt;Row&gt;</code>, for example, <code>A1</code> or <code>B3</code>.</p></div></div></td></tr><tr><td><p><code>zipBombCheck</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Turns off the zip bomb (decompression bomb) check when set to <code>false</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>application/vnd.openxmlformats-officedocument.spreadsheetml.sheet</code></p></td></tr><tr><td><p><code>application/xlsx</code></p></td></tr></tbody></table>

<!-- document id=a02e4ab2e772156da090ee29b1e893e07401023aae17eac9f8e62e62a3f6fcae url=/mulesoft/current/en-us/dataweave/2.3/dataweave-formats-excel.md -->

---
product: DataWeave
version: 2.3
---

# Excel Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME Type: `application/xlsx`

ID: `excel`

An Excel workbook is a sequence of sheets. In DataWeave, this is mapped to an object where each
sheet is a key. Only one table is allowed per Excel sheet. A table is expressed as an array of rows.
A row is an object where its keys are the columns and the values the cell content.

> [!NOTE] Only `.xlsx` files are supported (Excel 2007). `.xls` files are not supported by Mule.

The DataWeave reader for Excel input supports the following parsing strategies:

- In-Memory

- Streaming

To understand the parsing strategies that DataWeave readers and writers can apply to this format,
see [DataWeave Parsing Strategies](https://docs.mulesoft.com/dataweave/2.3/dataweave-formats#dw_readers_writers).

## Excel Type Mapping

The following table shows how Excel types map to DataWeave types.

<table><colgroup><col> <col></colgroup><thead><tr><th>Excel Type</th><th>DataWeave Type</th></tr></thead><tbody><tr><td><p><code>String</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>Numeric</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>Boolean</code></p></td><td><p><code>Boolean</code></p></td></tr><tr><td><p><code>Data</code></p></td><td><p><code>Date</code></p></td></tr></tbody></table>

## Examples

The following examples show uses of the Excel format.

- [Example: Represent Excel in the DataWeave (dw) Format](#example1)

- [Example: Output an Excel Table](#example2)

- [Example: Stream Excel Input](#example3)

### Example: Represent Excel in the DataWeave (dw) Format

This example shows how DataWeave represents an Excel workbook.

#### Input

The Excel workbook (`Sheet1`) serves as an input payload for the DataWeave source.

Sheet1:

. | A | B 1 | Id | Name 2 | 123 | George 3 | 456 | Lucas

#### Source

The DataWeave script transforms the Excel input payload to the DataWeave (dw) format and MIME type.

```dataweave
%dw 2.0
output application/dw
---
payload
```

#### Output

The DataWeave output looks like this. You can select values the same way you select values in other
objects.

```dataweave
{
    "Sheet1": [
        {
                "A": 123,
                "B": "George"
        },
        {
                "A": 456,
                "B": "Lucas"
        }
    ]
}
```

### Example: Output an Excel Table

The following DataWeave script outputs an Excel table with the header and fields.

The body of this DataWeave script is a DataWeave object that defines the content of the Excel sheet.
The name of the sheet, `Sheet1`, is the key of this object. The value is an array of objects. Each
object in the array contains a collection of key-value pairs. The keys in each pair are treated as
header values for the spreadsheet. The values in each pair are treated as data values for a row in
the sheet.

The output directive indicates that the output is the Excel format and MIME type. The `header=true`
setting indicates that the output includes the header values.

```dataweave
%dw 2.0
output application/xlsx header=true
---
{
  Sheet1: [
    {
      Id: 123,
      Name: George
    },
    {
      Id: 456,
      Name: Lucas
    }
  ]
}
```

For another example, see [Look Up Data in an Excel (XLSX) File](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-xlsx-lookup).

### Example: Stream Excel Input

By default, the Excel reader stores input data from an entire file in-memory if the file is 1.5MB or
less. If the file is larger than 1.5 MB, the process writes the data to disk. For very large files,
you can improve the performance of the reader by setting a `streaming` property to `true`.

The following Configuration XML for a Mule application streams an Excel file and transforms it to
JSON.

```xml
<http:listener-config
    name="HTTP_Listener_config"
    doc:name="HTTP Listener config" >
  <http:listener-connection host="0.0.0.0" port="8081" />
</http:listener-config>
<flow name="streaming_flow" >
  <http:listener
    doc:name="Listener"
    config-ref="HTTP_Listener_config"
    path="/"
    outputMimeType="application/xlsx; streaming=true"/>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
payload."Sheet Name" map ((row) -> {
    foo: row.a,
    bar: row.b
})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
</flow>
```

The example:

- Configures the HTTP listener to stream the XLSX input by setting
  `outputMimeType="application/xlsx; streaming=true"`. In the Studio UI, you can use the **MIME
  Type** on the listener to `application/xlsx` and the **Parameters** for the MIME Type to **Key**
  `streaming` and **Value** `true`.

- Uses a DataWeave script in the **Transform Message** component to iterate over each row in the
  XLSX payload (an XLSX sheet called `"Sheet Name"`) and select the values of each cell in the row
  (using `row.a`, `row.b`). It assumes columns named `a` and `b` and maps the values from each row
  in those columns into `foo` and `bar`, respectively.

#### Output

The following image shows the Excel table output.

![A table in an Excel format displaying IDs and names](/mulesoft/current/en-us/dataweave/2.3/_images/dataweave-formats-exceltable.png)

## Configuration Properties

DataWeave supports the following configuration properties for Excel.

### Reader Properties (for Excel)

The Excel format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>header</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether the Excel table contains headers. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>ignoreEmptyLine</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether to ignore empty line. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>streaming</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Introduced in Mule 4.2.2: Streaming is intended for processing a large file. When streaming is enabled, the reader accesses each row sequentially, keeping one row in memory at a time, instead of making all data available at once. Streaming does not permit random access to rows in the file. Use only if the entries are accessed sequentially. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>tableOffset</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The position of the first cell in the table (<code>&lt;Column&gt;&lt;Row&gt; example A1</code>).</p></div></div></td></tr><tr><td><p><code>zipBombCheck</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>If set to <code>false</code>, the zip bomb check is turned off. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties (for Excel)

The Excel format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the writer buffer.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>When set to <code>true</code>, DataWeave generates the output as a data stream, and the script’s execution is deferred until it is consumed. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>header</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether the Excel table contains headers. Valid values are <code>true</code> or <code>false</code>. When there are no headers, column names are used (for example, A, B, C, and so on).</p></div></div></td></tr><tr><td><p><code>ignoreEmptyLine</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether to ignore empty lines. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>tableOffset</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The position of the first cell in the table (<code>&lt;Column&gt;&lt;Row&gt; example A1</code>).</p></div></div></td></tr><tr><td><p><code>zipBombCheck</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>If set to <code>false</code>, the zip bomb check is turned off. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types (for Excel)

DataWeave supports the following MIME type.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>application/vnd.openxmlformats-officedocument.spreadsheetml.sheet</code></p></td></tr><tr><td><p><code>application/xlsx</code></p></td></tr></tbody></table>

<!-- document id=e273a5ed963316bd899eced9c490609a2ae683f1b0d95585cd77016a26be8115 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-formats-excel.md -->

---
product: DataWeave
version: 2.4
keywords: format, excel, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/xlsx, application/xlsx
---

# Excel Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/xlsx`

ID: `excel`

An Excel workbook is a sequence of sheets. In DataWeave, this is mapped to an object where each
sheet is a key. Only one table is allowed per Excel sheet. A table is expressed as an array of rows.
A row is an object where its keys are the columns and the values the cell content.

> [!NOTE] Only `.xlsx` files are supported (Excel 2007). `.xls` files are not supported by Mule.

The DataWeave reader for Excel input supports the following parsing strategies:

- In-Memory

- Streaming

To understand the parsing strategies that DataWeave readers and writers can apply to this format,
see [DataWeave Parsing Strategies](https://docs.mulesoft.com/dataweave/2.4/dataweave-formats#dw_readers_writers).

## Excel Type Mapping

The following table shows how Excel types map to DataWeave types.

<table><colgroup><col> <col></colgroup><thead><tr><th>Excel Type</th><th>DataWeave Type</th></tr></thead><tbody><tr><td><p><code>String</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>Numeric</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>Boolean</code></p></td><td><p><code>Boolean</code></p></td></tr><tr><td><p><code>Data</code></p></td><td><p><code>Date</code></p></td></tr></tbody></table>

## Examples

The following examples show uses of the Excel format.

- [Example: Represent Excel in the DataWeave (dw) Format](#example1)

- [Example: Output an Excel Table](#example2)

- [Example: Stream Excel Input](#example3)

### Example: Represent Excel in the DataWeave (dw) Format

This example shows how DataWeave represents an Excel workbook.

#### Input

The Excel workbook (`Sheet1`) serves as an input payload for the DataWeave source.

Sheet1:

. | A | B 1 | Id | Name 2 | 123 | George 3 | 456 | Lucas

#### Source

The DataWeave script transforms the Excel input payload to the DataWeave (dw) format and MIME type.

```dataweave
%dw 2.0
output application/dw
---
payload
```

#### Output

The DataWeave output looks like this. You can select values the same way you select values in other
objects.

```dataweave
{
    "Sheet1": [
        {
                "A": 123,
                "B": "George"
        },
        {
                "A": 456,
                "B": "Lucas"
        }
    ]
}
```

### Example: Output an Excel Table

The following DataWeave script outputs an Excel table with the header and fields.

The body of this DataWeave script is a DataWeave object that defines the content of the Excel sheet.
The name of the sheet, `Sheet1`, is the key of this object. The value is an array of objects. Each
object in the array contains a collection of key-value pairs. The keys in each pair are treated as
header values for the spreadsheet. The values in each pair are treated as data values for a row in
the sheet.

The output directive indicates that the output is the Excel format and MIME type. The `header=true`
setting indicates that the output includes the header values.

```dataweave
%dw 2.0
output application/xlsx header=true
---
{
  Sheet1: [
    {
      Id: 123,
      Name: George
    },
    {
      Id: 456,
      Name: Lucas
    }
  ]
}
```

For another example, see [Look Up Data in an Excel (XLSX) File](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-xlsx-lookup).

### Example: Stream Excel Input

By default, the Excel reader stores input data from an entire file in-memory if the file is 1.5MB or
less. If the file is larger than 1.5 MB, the process writes the data to disk. For very large files,
you can improve the performance of the reader by setting a `streaming` property to `true`.

The following Configuration XML for a Mule application streams an Excel file and transforms it to
JSON.

```xml
<http:listener-config
    name="HTTP_Listener_config"
    doc:name="HTTP Listener config" >
  <http:listener-connection host="0.0.0.0" port="8081" />
</http:listener-config>
<flow name="streaming_flow" >
  <http:listener
    doc:name="Listener"
    config-ref="HTTP_Listener_config"
    path="/"
    outputMimeType="application/xlsx; streaming=true"/>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
payload."Sheet Name" map ((row) -> {
    foo: row.a,
    bar: row.b
})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
</flow>
```

The example:

- Configures the HTTP listener to stream the XLSX input by setting
  `outputMimeType="application/xlsx; streaming=true"`. In the Studio UI, you can use the **MIME
  Type** on the listener to `application/xlsx` and the **Parameters** for the MIME Type to **Key**
  `streaming` and **Value** `true`.

- Uses a DataWeave script in the **Transform Message** component to iterate over each row in the
  XLSX payload (an XLSX sheet called `"Sheet Name"`) and select the values of each cell in the row
  (using `row.a`, `row.b`). It assumes columns named `a` and `b` and maps the values from each row
  in those columns into `foo` and `bar`, respectively.

#### Output

The following image shows the Excel table output.

![A table in an Excel format displaying IDs and names](/mulesoft/current/en-us/dataweave/2.4/_images/dataweave-formats-exceltable.png)

## Limitations

- Macros are currently not supported.

- Charts are ignored.

- Pivot tables are not supported.

  // CONFIG PROPS GET APPENDED BELOW /////////////////////////////////

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>header</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether the first line of the output contains header field names.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>ignoreEmptyLine</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Ignores an empty line by default.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>streaming</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Streams input when set to <code>true</code>. Use only if entries are accessed sequentially. The input must be a top-level array.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>tableLimit</code></p></td><td><p><code>String</code></p></td><td><p><code>'Unbounded'</code></p></td><td><div><div><p>Position of the last column in each row. Accepts a pattern <code>&lt;Column&gt;</code> (for example, <code>'A'</code> or <code>'AB'</code>), the value <code>'HeaderSize'</code>, which uses the location of the last header, or 'Unbounded', which consumes each row.</p></div></div></td></tr><tr><td><p><code>tableOffset</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Sets the position of the first cell. Accepts the pattern <code>&lt;Column&gt;&lt;Row&gt;</code>, for example, <code>A1</code> or <code>B3</code>.</p></div></div></td></tr><tr><td><p><code>zipBombCheck</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Turns off the zip bomb (decompression bomb) check when set to <code>false</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>header</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether the first line of the output contains header field names.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>ignoreEmptyLine</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Ignores an empty line by default.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>tableOffset</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Sets the position of the first cell. Accepts the pattern <code>&lt;Column&gt;&lt;Row&gt;</code>, for example, <code>A1</code> or <code>B3</code>.</p></div></div></td></tr><tr><td><p><code>zipBombCheck</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Turns off the zip bomb (decompression bomb) check when set to <code>false</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>application/vnd.openxmlformats-officedocument.spreadsheetml.sheet</code></p></td></tr><tr><td><p><code>application/xlsx</code></p></td></tr></tbody></table>

<!-- document id=7e04213eaac673dc9b3b5a9ffc306e4ebc0f4fb002a1a27448f6aa8aa0282011 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-formats-excel.md -->

---
product: DataWeave
version: 2.6
keywords: format, excel, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/xlsx, application/xlsx
---

# Excel Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/xlsx`

ID: `excel`

An Excel workbook is a sequence of sheets. In DataWeave, this is mapped to an object where each
sheet is a key. Only one table is allowed per Excel sheet. A table is expressed as an array of rows.
A row is an object where its keys are the columns and the values the cell content.

> [!NOTE] Only `.xlsx` files are supported (Excel 2007). `.xls` files are not supported by Mule.

The DataWeave reader for Excel input supports the following parsing strategies:

- In-Memory

- Streaming

To understand the parsing strategies that DataWeave readers and writers can apply to this format,
see [DataWeave Parsing Strategies](https://docs.mulesoft.com/dataweave/2.6/dataweave-formats#dw_readers_writers).

## Excel Type Mapping

The following table shows how Excel types map to DataWeave types.

<table><colgroup><col> <col></colgroup><thead><tr><th>Excel Type</th><th>DataWeave Type</th></tr></thead><tbody><tr><td><p><code>String</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>Numeric</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>Boolean</code></p></td><td><p><code>Boolean</code></p></td></tr><tr><td><p><code>Data</code></p></td><td><p><code>Date</code></p></td></tr></tbody></table>

## Examples

The following examples show uses of the Excel format.

- [Example: Represent Excel in the DataWeave (dw) Format](#example1)

- [Example: Output an Excel Table](#example2)

- [Example: Stream Excel Input](#example3)

### Example: Represent Excel in the DataWeave (dw) Format

This example shows how DataWeave represents an Excel workbook.

#### Input

The Excel workbook (`Sheet1`) serves as an input payload for the DataWeave source.

Sheet1:

. | A | B 1 | Id | Name 2 | 123 | George 3 | 456 | Lucas

#### Source

The DataWeave script transforms the Excel input payload to the DataWeave (dw) format and MIME type.

```dataweave
%dw 2.0
output application/dw
---
payload
```

#### Output

The DataWeave output looks like this. You can select values the same way you select values in other
objects.

```dataweave
{
    "Sheet1": [
        {
                "A": 123,
                "B": "George"
        },
        {
                "A": 456,
                "B": "Lucas"
        }
    ]
}
```

### Example: Output an Excel Table

The following DataWeave script outputs an Excel table with the header and fields.

The body of this DataWeave script is a DataWeave object that defines the content of the Excel sheet.
The name of the sheet, `Sheet1`, is the key of this object. The value is an array of objects. Each
object in the array contains a collection of key-value pairs. The keys in each pair are treated as
header values for the spreadsheet. The values in each pair are treated as data values for a row in
the sheet.

The output directive indicates that the output is the Excel format and MIME type. The `header=true`
setting indicates that the output includes the header values.

```dataweave
%dw 2.0
output application/xlsx header=true
---
{
  Sheet1: [
    {
      Id: 123,
      Name: George
    },
    {
      Id: 456,
      Name: Lucas
    }
  ]
}
```

For another example, see [Look Up Data in an Excel (XLSX) File](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-xlsx-lookup).

### Example: Stream Excel Input

By default, the Excel reader stores input data from an entire file in-memory if the file is 1.5MB or
less. If the file is larger than 1.5 MB, the process writes the data to disk. For very large files,
you can improve the performance of the reader by setting a `streaming` property to `true`.

The following Configuration XML for a Mule application streams an Excel file and transforms it to
JSON.

```xml
<http:listener-config
    name="HTTP_Listener_config"
    doc:name="HTTP Listener config" >
  <http:listener-connection host="0.0.0.0" port="8081" />
</http:listener-config>
<flow name="streaming_flow" >
  <http:listener
    doc:name="Listener"
    config-ref="HTTP_Listener_config"
    path="/"
    outputMimeType="application/xlsx; streaming=true"/>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
payload."Sheet Name" map ((row) -> {
    foo: row.a,
    bar: row.b
})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
</flow>
```

The example:

- Configures the HTTP listener to stream the XLSX input by setting
  `outputMimeType="application/xlsx; streaming=true"`. In the Studio UI, you can use the **MIME
  Type** on the listener to `application/xlsx` and the **Parameters** for the MIME Type to **Key**
  `streaming` and **Value** `true`.

- Uses a DataWeave script in the **Transform Message** component to iterate over each row in the
  XLSX payload (an XLSX sheet called `"Sheet Name"`) and select the values of each cell in the row
  (using `row.a`, `row.b`). It assumes columns named `a` and `b` and maps the values from each row
  in those columns into `foo` and `bar`, respectively.

#### Output

The following image shows the Excel table output.

![A table in an Excel format displaying IDs and names](/mulesoft/current/en-us/dataweave/2.6/_images/dataweave-formats-exceltable.png)

## Limitations

- Macros are currently not supported.

- Charts are ignored.

- Pivot tables are not supported.

- Formatting is currently not supported.

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>header</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether the first line of the output contains header field names.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>ignoreEmptyLine</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Ignores an empty line by default.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>maxEntrySize</code></p></td><td><p><code>Number</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Sets the maximum number of bytes a single entry in a ZIP file can have.</p></div></div></td></tr><tr><td><p><code>minInflateRatio</code></p></td><td><p><code>Number</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Sets the ratio between de- and inflated bytes to detect zip bomb. For example, if you set the value to 1 percent (= 0.01d) when the compression is better than 1 percent for any given read package part, the parsing fails to indicate a zip bomb.</p></div></div></td></tr><tr><td><p><code>streaming</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Streams input when set to <code>true</code>. Use only if entries are accessed sequentially. The input must be a top-level array. See the <a href="#example2">streaming example</a>, and see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats#dw_readers_writers">DataWeave Readers</a>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>tableLimit</code></p></td><td><p><code>String</code></p></td><td><p><code>'Unbounded'</code></p></td><td><div><div><p>Position of the last column in each row. Accepts a pattern <code>&lt;Column&gt;</code> (for example, <code>'A'</code> or <code>'AB'</code>), the value <code>'HeaderSize'</code>, which uses the location of the last header, or 'Unbounded', which consumes each row.</p></div></div></td></tr><tr><td><p><code>tableOffset</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Sets the position of the first cell. Accepts the pattern <code>&lt;Column&gt;&lt;Row&gt;</code>, for example, <code>A1</code> or <code>B3</code>.</p></div></div></td></tr><tr><td><p><code>zipBombCheck</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Turns off the zip bomb (decompression bomb) check when set to <code>false</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>header</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether the first line of the output contains header field names.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>ignoreEmptyLine</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Ignores an empty line by default.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>maxEntrySize</code></p></td><td><p><code>Number</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Sets the maximum number of bytes a single entry in a ZIP file can have.</p></div></div></td></tr><tr><td><p><code>minInflateRatio</code></p></td><td><p><code>Number</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Sets the ratio between de- and inflated bytes to detect zip bomb. For example, if you set the value to 1 percent (= 0.01d) when the compression is better than 1 percent for any given read package part, the parsing fails to indicate a zip bomb.</p></div></div></td></tr><tr><td><p><code>tableOffset</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Sets the position of the first cell. Accepts the pattern <code>&lt;Column&gt;&lt;Row&gt;</code>, for example, <code>A1</code> or <code>B3</code>.</p></div></div></td></tr><tr><td><p><code>zipBombCheck</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Turns off the zip bomb (decompression bomb) check when set to <code>false</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>application/vnd.openxmlformats-officedocument.spreadsheetml.sheet</code></p></td></tr><tr><td><p><code>application/xlsx</code></p></td></tr></tbody></table>

<!-- document id=27fe78674d925b7cd8d24b0ade2409a8af6ef71d970c523e4994fe85da51c100 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-formats-excel.md -->

---
product: DataWeave
version: 2.9
keywords: format, excel, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/xlsx, application/xlsx
---

# Excel Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/xlsx`

ID: `excel`

An Excel workbook is a sequence of sheets. In DataWeave, this is mapped to an object where each
sheet is a key. Only one table is allowed per Excel sheet. A table is expressed as an array of rows.
A row is an object where its keys are the columns and the values the cell content.

> [!NOTE] Only `.xlsx` files are supported (Excel 2007). `.xls` files are not supported by Mule.

The DataWeave reader for Excel input supports the following parsing strategies:

- In-Memory

- Streaming

To understand the parsing strategies that DataWeave readers and writers can apply to this format,
see [DataWeave Parsing Strategies](https://docs.mulesoft.com/dataweave/2.9/dataweave-formats#dw_readers_writers).

## Excel Type Mapping

The following table shows how Excel types map to DataWeave types.

<table><colgroup><col> <col></colgroup><thead><tr><th>Excel Type</th><th>DataWeave Type</th></tr></thead><tbody><tr><td><p><code>String</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>Numeric</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>Boolean</code></p></td><td><p><code>Boolean</code></p></td></tr><tr><td><p><code>Data</code></p></td><td><p><code>Date</code></p></td></tr></tbody></table>

## Examples

The following examples show uses of the Excel format.

- [Example: Represent Excel in the DataWeave (dw) Format](#example1)

- [Example: Output an Excel Table](#example2)

- [Example: Stream Excel Input](#example3)

### Example: Represent Excel in the DataWeave (dw) Format

This example shows how DataWeave represents an Excel workbook.

#### Input

The Excel workbook (`Sheet1`) serves as an input payload for the DataWeave source.

Sheet1:

. | A | B 1 | Id | Name 2 | 123 | George 3 | 456 | Lucas

#### Source

The DataWeave script transforms the Excel input payload to the DataWeave (dw) format and MIME type.

```dataweave
%dw 2.0
output application/dw
---
payload
```

#### Output

The DataWeave output looks like this. You can select values the same way you select values in other
objects.

```dataweave
{
    "Sheet1": [
        {
                "A": 123,
                "B": "George"
        },
        {
                "A": 456,
                "B": "Lucas"
        }
    ]
}
```

### Example: Output an Excel Table

The following DataWeave script outputs an Excel table with the header and fields.

The body of this DataWeave script is a DataWeave object that defines the content of the Excel sheet.
The name of the sheet, `Sheet1`, is the key of this object. The value is an array of objects. Each
object in the array contains a collection of key-value pairs. The keys in each pair are treated as
header values for the spreadsheet. The values in each pair are treated as data values for a row in
the sheet.

The output directive indicates that the output is the Excel format and MIME type. The `header=true`
setting indicates that the output includes the header values.

```dataweave
%dw 2.0
output application/xlsx header=true
---
{
  Sheet1: [
    {
      Id: 123,
      Name: George
    },
    {
      Id: 456,
      Name: Lucas
    }
  ]
}
```

For another example, see [Look Up Data in an Excel (XLSX) File](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-xlsx-lookup).

### Example: Stream Excel Input

By default, the Excel reader stores input data from an entire file in-memory if the file is 1.5MB or
less. If the file is larger than 1.5 MB, the process writes the data to disk. For very large files,
you can improve the performance of the reader by setting a `streaming` property to `true`.

The following Configuration XML for a Mule application streams an Excel file and transforms it to
JSON.

```xml
<http:listener-config
    name="HTTP_Listener_config"
    doc:name="HTTP Listener config" >
  <http:listener-connection host="0.0.0.0" port="8081" />
</http:listener-config>
<flow name="streaming_flow" >
  <http:listener
    doc:name="Listener"
    config-ref="HTTP_Listener_config"
    path="/"
    outputMimeType="application/xlsx; streaming=true"/>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
payload."Sheet Name" map ((row) -> {
    foo: row.a,
    bar: row.b
})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
</flow>
```

The example:

- Configures the HTTP listener to stream the XLSX input by setting
  `outputMimeType="application/xlsx; streaming=true"`. In the Studio UI, you can use the **MIME
  Type** on the listener to `application/xlsx` and the **Parameters** for the MIME Type to **Key**
  `streaming` and **Value** `true`.

- Uses a DataWeave script in the **Transform Message** component to iterate over each row in the
  XLSX payload (an XLSX sheet called `"Sheet Name"`) and select the values of each cell in the row
  (using `row.a`, `row.b`). It assumes columns named `a` and `b` and maps the values from each row
  in those columns into `foo` and `bar`, respectively.

#### Output

The following image shows the Excel table output.

![A table in an Excel format displaying IDs and names](/mulesoft/current/en-us/dataweave/2.9/_images/dataweave-formats-exceltable.png)

## Limitations

- Macros are currently not supported.

- Charts are ignored.

- Pivot tables are not supported.

- Formatting is currently not supported.

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>header</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether the first line of the output contains header field names.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>ignoreEmptyLine</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Ignores an empty line by default.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>maxEntrySize</code></p></td><td><p><code>Number</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Sets the maximum number of bytes a single entry in a ZIP file can have.</p></div></div></td></tr><tr><td><p><code>minInflateRatio</code></p></td><td><p><code>Number</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Sets the ratio between de- and inflated bytes to detect zip bomb. For example, if you set the value to 1 percent (= 0.01d) when the compression is better than 1 percent for any given read package part, the parsing fails to indicate a zip bomb.</p></div></div></td></tr><tr><td><p><code>streaming</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Streams input when set to <code>true</code>. Use only if entries are accessed sequentially. The input must be a top-level array. See the <a href="#example2">streaming example</a>, and see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats#dw_readers_writers">DataWeave Readers</a>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>tableLimit</code></p></td><td><p><code>String</code></p></td><td><p><code>'Unbounded'</code></p></td><td><div><div><p>Position of the last column in each row. Accepts a pattern <code>&lt;Column&gt;</code> (for example, <code>'A'</code> or <code>'AB'</code>), the value <code>'HeaderSize'</code>, which uses the location of the last header, or 'Unbounded', which consumes each row.</p></div></div></td></tr><tr><td><p><code>tableOffset</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Sets the position of the first cell. Accepts the pattern <code>&lt;Column&gt;&lt;Row&gt;</code>, for example, <code>A1</code> or <code>B3</code>.</p></div></div></td></tr><tr><td><p><code>zipBombCheck</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Turns off the zip bomb (decompression bomb) check when set to <code>false</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>header</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether the first line of the output contains header field names.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>ignoreEmptyLine</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Ignores an empty line by default.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>maxEntrySize</code></p></td><td><p><code>Number</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Sets the maximum number of bytes a single entry in a ZIP file can have.</p></div></div></td></tr><tr><td><p><code>minInflateRatio</code></p></td><td><p><code>Number</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Sets the ratio between de- and inflated bytes to detect zip bomb. For example, if you set the value to 1 percent (= 0.01d) when the compression is better than 1 percent for any given read package part, the parsing fails to indicate a zip bomb.</p></div></div></td></tr><tr><td><p><code>tableOffset</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Sets the position of the first cell. Accepts the pattern <code>&lt;Column&gt;&lt;Row&gt;</code>, for example, <code>A1</code> or <code>B3</code>.</p></div></div></td></tr><tr><td><p><code>zipBombCheck</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Turns off the zip bomb (decompression bomb) check when set to <code>false</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>application/vnd.openxmlformats-officedocument.spreadsheetml.sheet</code></p></td></tr><tr><td><p><code>application/xlsx</code></p></td></tr></tbody></table>

<!-- document id=5d468ce425278810e38c23f202ecfbcddc0e82a3e073c410337bd3354e5d5121 url=/mulesoft/current/en-us/dataweave/latest/dataweave-formats-excel.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: format, excel, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/xlsx, application/xlsx
---

# Excel Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/xlsx`

ID: `excel`

An Excel workbook is a sequence of sheets. In DataWeave, this is mapped to an object where each
sheet is a key. Only one table is allowed per Excel sheet. A table is expressed as an array of rows.
A row is an object where its keys are the columns and the values the cell content.

> [!NOTE] Only `.xlsx` files are supported (Excel 2007). `.xls` files are not supported by Mule.

The DataWeave reader for Excel input supports the following parsing strategies:

- In-Memory

- Streaming

To understand the parsing strategies that DataWeave readers and writers can apply to this format,
see [DataWeave Parsing Strategies](https://docs.mulesoft.com/dataweave/latest/dataweave-formats#dw_readers_writers).

## Excel Type Mapping

The following table shows how Excel types map to DataWeave types.

<table><colgroup><col> <col></colgroup><thead><tr><th>Excel Type</th><th>DataWeave Type</th></tr></thead><tbody><tr><td><p><code>String</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>Numeric</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>Boolean</code></p></td><td><p><code>Boolean</code></p></td></tr><tr><td><p><code>Data</code></p></td><td><p><code>Date</code></p></td></tr></tbody></table>

## Examples

The following examples show uses of the Excel format.

- [Example: Represent Excel in the DataWeave (dw) Format](#example1)

- [Example: Output an Excel Table](#example2)

- [Example: Stream Excel Input](#example3)

### Example: Represent Excel in the DataWeave (dw) Format

This example shows how DataWeave represents an Excel workbook.

#### Input

The Excel workbook (`Sheet1`) serves as an input payload for the DataWeave source.

Sheet1:

. | A | B 1 | Id | Name 2 | 123 | George 3 | 456 | Lucas

#### Source

The DataWeave script transforms the Excel input payload to the DataWeave (dw) format and MIME type.

```dataweave
%dw 2.0
output application/dw
---
payload
```

#### Output

The DataWeave output looks like this. You can select values the same way you select values in other
objects.

```dataweave
{
    "Sheet1": [
        {
                "A": 123,
                "B": "George"
        },
        {
                "A": 456,
                "B": "Lucas"
        }
    ]
}
```

### Example: Output an Excel Table

The following DataWeave script outputs an Excel table with the header and fields.

The body of this DataWeave script is a DataWeave object that defines the content of the Excel sheet.
The name of the sheet, `Sheet1`, is the key of this object. The value is an array of objects. Each
object in the array contains a collection of key-value pairs. The keys in each pair are treated as
header values for the spreadsheet. The values in each pair are treated as data values for a row in
the sheet.

The output directive indicates that the output is the Excel format and MIME type. The `header=true`
setting indicates that the output includes the header values.

```dataweave
%dw 2.0
output application/xlsx header=true
---
{
  Sheet1: [
    {
      Id: 123,
      Name: George
    },
    {
      Id: 456,
      Name: Lucas
    }
  ]
}
```

For another example, see [Look Up Data in an Excel (XLSX) File](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-xlsx-lookup).

### Example: Stream Excel Input

By default, the Excel reader stores input data from an entire file in-memory if the file is 1.5MB or
less. If the file is larger than 1.5 MB, the process writes the data to disk. For very large files,
you can improve the performance of the reader by setting a `streaming` property to `true`.

The following Configuration XML for a Mule application streams an Excel file and transforms it to
JSON.

```xml
<http:listener-config
    name="HTTP_Listener_config"
    doc:name="HTTP Listener config" >
  <http:listener-connection host="0.0.0.0" port="8081" />
</http:listener-config>
<flow name="streaming_flow" >
  <http:listener
    doc:name="Listener"
    config-ref="HTTP_Listener_config"
    path="/"
    outputMimeType="application/xlsx; streaming=true"/>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
payload."Sheet Name" map ((row) -> {
    foo: row.a,
    bar: row.b
})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
</flow>
```

The example:

- Configures the HTTP listener to stream the XLSX input by setting
  `outputMimeType="application/xlsx; streaming=true"`. In the Studio UI, you can use the **MIME
  Type** on the listener to `application/xlsx` and the **Parameters** for the MIME Type to **Key**
  `streaming` and **Value** `true`.

- Uses a DataWeave script in the **Transform Message** component to iterate over each row in the
  XLSX payload (an XLSX sheet called `"Sheet Name"`) and select the values of each cell in the row
  (using `row.a`, `row.b`). It assumes columns named `a` and `b` and maps the values from each row
  in those columns into `foo` and `bar`, respectively.

#### Output

The following image shows the Excel table output.

![A table in an Excel format displaying IDs and names](/mulesoft/current/en-us/dataweave/latest/_images/dataweave-formats-exceltable.png)

## Limitations

- Macros are currently not supported.

- Charts are ignored.

- Pivot tables are not supported.

- Formatting is currently not supported.

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>header</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether the first line of the output contains header field names.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>ignoreEmptyLine</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Ignores an empty line by default.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>maxEntrySize</code></p></td><td><p><code>Number</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Sets the maximum number of bytes a single entry in a ZIP file can have.</p></div></div></td></tr><tr><td><p><code>minInflateRatio</code></p></td><td><p><code>Number</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Sets the ratio between de- and inflated bytes to detect zip bomb. For example, if you set the value to 1 percent (= 0.01d) when the compression is better than 1 percent for any given read package part, the parsing fails to indicate a zip bomb.</p></div></div></td></tr><tr><td><p><code>streaming</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Streams input when set to <code>true</code>. Use only if entries are accessed sequentially. The input must be a top-level array. See the <a href="#example2">streaming example</a>, and see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats#dw_readers_writers">DataWeave Readers</a>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>tableLimit</code></p></td><td><p><code>String</code></p></td><td><p><code>'Unbounded'</code></p></td><td><div><div><p>Position of the last column in each row. Accepts a pattern <code>&lt;Column&gt;</code> (for example, <code>'A'</code> or <code>'AB'</code>), the value <code>'HeaderSize'</code>, which uses the location of the last header, or 'Unbounded', which consumes each row.</p></div></div></td></tr><tr><td><p><code>tableOffset</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Sets the position of the first cell. Accepts the pattern <code>&lt;Column&gt;&lt;Row&gt;</code>, for example, <code>A1</code> or <code>B3</code>.</p></div></div></td></tr><tr><td><p><code>zipBombCheck</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Turns off the zip bomb (decompression bomb) check when set to <code>false</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>header</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether the first line of the output contains header field names.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>ignoreEmptyLine</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Ignores an empty line by default.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>maxEntrySize</code></p></td><td><p><code>Number</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Sets the maximum number of bytes a single entry in a ZIP file can have.</p></div></div></td></tr><tr><td><p><code>minInflateRatio</code></p></td><td><p><code>Number</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Sets the ratio between de- and inflated bytes to detect zip bomb. For example, if you set the value to 1 percent (= 0.01d) when the compression is better than 1 percent for any given read package part, the parsing fails to indicate a zip bomb.</p></div></div></td></tr><tr><td><p><code>tableOffset</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Sets the position of the first cell. Accepts the pattern <code>&lt;Column&gt;&lt;Row&gt;</code>, for example, <code>A1</code> or <code>B3</code>.</p></div></div></td></tr><tr><td><p><code>zipBombCheck</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Turns off the zip bomb (decompression bomb) check when set to <code>false</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>application/vnd.openxmlformats-officedocument.spreadsheetml.sheet</code></p></td></tr><tr><td><p><code>application/xlsx</code></p></td></tr></tbody></table>

<!-- document id=98d45c190027865193e9e5cdf73ee544cd0c364168632ec1c30a334f690dc9ed url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook-exclude-field.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, remove, mapobject
---

# Exclude Fields from the Output

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example excludes specific XML elements from the output. You might perform a task like
this to remove sensitive data.

The example uses these functions:

- `-` to remove specific `key:value` pairs (here, the `ssn` and `password` XML elements).

- `mapObject` to go through the XML elements.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
users: {
      (payload.users mapObject {
        user: {
        personal_information: $.personal_information - "ssn",
        login_information: $.login_information - "password"
        }
      })
}
```

Input XML Payload:

```xml
<users>
    <user>
        <personal_information>
            <first_name>Emiliano</first_name>
            <middle_name>Romoaldo</middle_name>
            <last_name>Lesende</last_name>
            <ssn>001-08-84382</ssn>
        </personal_information>
        <login_information>
            <username>3miliano</username>
            <password>mypassword1234</password>
        </login_information>
    </user>
    <user>
        <personal_information>
            <first_name>Mariano</first_name>
            <middle_name>Toribio</middle_name>
            <last_name>de Achaval</last_name>
            <ssn>002-05-34738</ssn>
        </personal_information>
        <login_information>
            <username>machaval</username>
            <password>mypassword4321</password>
        </login_information>
    </user>
</users>
```

Output XML:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<users>
  <user>
    <personal_information>
      <first_name>Emiliano</first_name>
      <middle_name>Romoaldo</middle_name>
      <last_name>Lesende</last_name>
    </personal_information>
    <login_information>
      <username>3miliano</username>
    </login_information>
  </user>
  <user>
    <personal_information>
      <first_name>Mariano</first_name>
      <middle_name>Toribio</middle_name>
      <last_name>de Achaval</last_name>
    </personal_information>
    <login_information>
      <username>machaval</username>
    </login_information>
  </user>
</users>
```

## Related Examples

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-output-a-field-when-present)

- [Change the Value of a Field](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-change-value-of-a-field)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-conditional-list-reduction-via-function)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.11/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook)

<!-- document id=0a4a904e5c8081b4499a4d98f17cbf90700389ebc7a96a9fab2365f065bf5438 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook-exclude-field.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, remove, mapobject
---

# Exclude Fields from the Output

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example excludes specific XML elements from the output. You might perform a task like
this to remove sensitive data.

The example uses these functions:

- `-` to remove specific `key:value` pairs (here, the `ssn` and `password` XML elements).

- `mapObject` to go through the XML elements.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
users: {
      (payload.users mapObject {
        user: {
        personal_information: $.personal_information - "ssn",
        login_information: $.login_information - "password"
        }
      })
}
```

Input XML Payload:

```xml
<users>
    <user>
        <personal_information>
            <first_name>Emiliano</first_name>
            <middle_name>Romoaldo</middle_name>
            <last_name>Lesende</last_name>
            <ssn>001-08-84382</ssn>
        </personal_information>
        <login_information>
            <username>3miliano</username>
            <password>mypassword1234</password>
        </login_information>
    </user>
    <user>
        <personal_information>
            <first_name>Mariano</first_name>
            <middle_name>Toribio</middle_name>
            <last_name>de Achaval</last_name>
            <ssn>002-05-34738</ssn>
        </personal_information>
        <login_information>
            <username>machaval</username>
            <password>mypassword4321</password>
        </login_information>
    </user>
</users>
```

Output XML:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<users>
  <user>
    <personal_information>
      <first_name>Emiliano</first_name>
      <middle_name>Romoaldo</middle_name>
      <last_name>Lesende</last_name>
    </personal_information>
    <login_information>
      <username>3miliano</username>
    </login_information>
  </user>
  <user>
    <personal_information>
      <first_name>Mariano</first_name>
      <middle_name>Toribio</middle_name>
      <last_name>de Achaval</last_name>
    </personal_information>
    <login_information>
      <username>machaval</username>
    </login_information>
  </user>
</users>
```

## Related Examples

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-output-a-field-when-present)

- [Change the Value of a Field](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-change-value-of-a-field)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-conditional-list-reduction-via-function)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.12/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook)

<!-- document id=6cfbc090a59a6525c2dde7e3d1f6acd86ae594374790be817f07580053f1e72a url=/mulesoft/current/en-us/dataweave/2.3/dataweave-cookbook-exclude-field.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, remove, mapobject
---

# Exclude Fields from the Output

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example excludes specific XML elements from the output. You might perform a task like
this to remove sensitive data.

The example uses these functions:

- `-` to remove specific `key:value` pairs (here, the `ssn` and `password` XML elements).

- `mapObject` to go through the XML elements.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
users: {
      (payload.users mapObject {
        user: {
        personal_information: $.personal_information - "ssn",
        login_information: $.login_information - "password"
        }
      })
}
```

Input XML Payload:

```xml
<users>
    <user>
        <personal_information>
            <first_name>Emiliano</first_name>
            <middle_name>Romoaldo</middle_name>
            <last_name>Lesende</last_name>
            <ssn>001-08-84382</ssn>
        </personal_information>
        <login_information>
            <username>3miliano</username>
            <password>mypassword1234</password>
        </login_information>
    </user>
    <user>
        <personal_information>
            <first_name>Mariano</first_name>
            <middle_name>Toribio</middle_name>
            <last_name>de Achaval</last_name>
            <ssn>002-05-34738</ssn>
        </personal_information>
        <login_information>
            <username>machaval</username>
            <password>mypassword4321</password>
        </login_information>
    </user>
</users>
```

Output XML:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<users>
  <user>
    <personal_information>
      <first_name>Emiliano</first_name>
      <middle_name>Romoaldo</middle_name>
      <last_name>Lesende</last_name>
    </personal_information>
    <login_information>
      <username>3miliano</username>
    </login_information>
  </user>
  <user>
    <personal_information>
      <first_name>Mariano</first_name>
      <middle_name>Toribio</middle_name>
      <last_name>de Achaval</last_name>
    </personal_information>
    <login_information>
      <username>machaval</username>
    </login_information>
  </user>
</users>
```

## Related Examples

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-output-a-field-when-present)

- [Change the Value of a Field](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-change-value-of-a-field)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-conditional-list-reduction-via-function)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.3/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook)

<!-- document id=b375fa30650891cd35444402bd1d3678c23b4ac61c9663b69b78bb69ee7df2b0 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook-exclude-field.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, remove, mapobject
---

# Exclude Fields from the Output

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example excludes specific XML elements from the output. You might perform a task like
this to remove sensitive data.

The example uses these functions:

- `-` to remove specific `key:value` pairs (here, the `ssn` and `password` XML elements).

- `mapObject` to go through the XML elements.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
users: {
      (payload.users mapObject {
        user: {
        personal_information: $.personal_information - "ssn",
        login_information: $.login_information - "password"
        }
      })
}
```

Input XML Payload:

```xml
<users>
    <user>
        <personal_information>
            <first_name>Emiliano</first_name>
            <middle_name>Romoaldo</middle_name>
            <last_name>Lesende</last_name>
            <ssn>001-08-84382</ssn>
        </personal_information>
        <login_information>
            <username>3miliano</username>
            <password>mypassword1234</password>
        </login_information>
    </user>
    <user>
        <personal_information>
            <first_name>Mariano</first_name>
            <middle_name>Toribio</middle_name>
            <last_name>de Achaval</last_name>
            <ssn>002-05-34738</ssn>
        </personal_information>
        <login_information>
            <username>machaval</username>
            <password>mypassword4321</password>
        </login_information>
    </user>
</users>
```

Output XML:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<users>
  <user>
    <personal_information>
      <first_name>Emiliano</first_name>
      <middle_name>Romoaldo</middle_name>
      <last_name>Lesende</last_name>
    </personal_information>
    <login_information>
      <username>3miliano</username>
    </login_information>
  </user>
  <user>
    <personal_information>
      <first_name>Mariano</first_name>
      <middle_name>Toribio</middle_name>
      <last_name>de Achaval</last_name>
    </personal_information>
    <login_information>
      <username>machaval</username>
    </login_information>
  </user>
</users>
```

## Related Examples

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-output-a-field-when-present)

- [Change the Value of a Field](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-change-value-of-a-field)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-conditional-list-reduction-via-function)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.4/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook)

<!-- document id=5645e7376f0b240652ba80077dfe0919d4b2711880f498251641c76c481d5875 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook-exclude-field.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, remove, mapobject
---

# Exclude Fields from the Output

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example excludes specific XML elements from the output. You might perform a task like
this to remove sensitive data.

The example uses these functions:

- `-` to remove specific `key:value` pairs (here, the `ssn` and `password` XML elements).

- `mapObject` to go through the XML elements.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
users: {
      (payload.users mapObject {
        user: {
        personal_information: $.personal_information - "ssn",
        login_information: $.login_information - "password"
        }
      })
}
```

Input XML Payload:

```xml
<users>
    <user>
        <personal_information>
            <first_name>Emiliano</first_name>
            <middle_name>Romoaldo</middle_name>
            <last_name>Lesende</last_name>
            <ssn>001-08-84382</ssn>
        </personal_information>
        <login_information>
            <username>3miliano</username>
            <password>mypassword1234</password>
        </login_information>
    </user>
    <user>
        <personal_information>
            <first_name>Mariano</first_name>
            <middle_name>Toribio</middle_name>
            <last_name>de Achaval</last_name>
            <ssn>002-05-34738</ssn>
        </personal_information>
        <login_information>
            <username>machaval</username>
            <password>mypassword4321</password>
        </login_information>
    </user>
</users>
```

Output XML:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<users>
  <user>
    <personal_information>
      <first_name>Emiliano</first_name>
      <middle_name>Romoaldo</middle_name>
      <last_name>Lesende</last_name>
    </personal_information>
    <login_information>
      <username>3miliano</username>
    </login_information>
  </user>
  <user>
    <personal_information>
      <first_name>Mariano</first_name>
      <middle_name>Toribio</middle_name>
      <last_name>de Achaval</last_name>
    </personal_information>
    <login_information>
      <username>machaval</username>
    </login_information>
  </user>
</users>
```

## Related Examples

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-output-a-field-when-present)

- [Change the Value of a Field](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-change-value-of-a-field)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-conditional-list-reduction-via-function)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.6/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook)

<!-- document id=520d56765d4943a2f2637e54e428a1b73f3f53881d4d5f1f015d50333eb8db9f url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook-exclude-field.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, remove, mapobject
---

# Exclude Fields from the Output

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example excludes specific XML elements from the output. You might perform a task like
this to remove sensitive data.

The example uses these functions:

- `-` to remove specific `key:value` pairs (here, the `ssn` and `password` XML elements).

- `mapObject` to go through the XML elements.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
users: {
      (payload.users mapObject {
        user: {
        personal_information: $.personal_information - "ssn",
        login_information: $.login_information - "password"
        }
      })
}
```

Input XML Payload:

```xml
<users>
    <user>
        <personal_information>
            <first_name>Emiliano</first_name>
            <middle_name>Romoaldo</middle_name>
            <last_name>Lesende</last_name>
            <ssn>001-08-84382</ssn>
        </personal_information>
        <login_information>
            <username>3miliano</username>
            <password>mypassword1234</password>
        </login_information>
    </user>
    <user>
        <personal_information>
            <first_name>Mariano</first_name>
            <middle_name>Toribio</middle_name>
            <last_name>de Achaval</last_name>
            <ssn>002-05-34738</ssn>
        </personal_information>
        <login_information>
            <username>machaval</username>
            <password>mypassword4321</password>
        </login_information>
    </user>
</users>
```

Output XML:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<users>
  <user>
    <personal_information>
      <first_name>Emiliano</first_name>
      <middle_name>Romoaldo</middle_name>
      <last_name>Lesende</last_name>
    </personal_information>
    <login_information>
      <username>3miliano</username>
    </login_information>
  </user>
  <user>
    <personal_information>
      <first_name>Mariano</first_name>
      <middle_name>Toribio</middle_name>
      <last_name>de Achaval</last_name>
    </personal_information>
    <login_information>
      <username>machaval</username>
    </login_information>
  </user>
</users>
```

## Related Examples

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-output-a-field-when-present)

- [Change the Value of a Field](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-change-value-of-a-field)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-conditional-list-reduction-via-function)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.9/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook)

<!-- document id=86bc619d59735ecf994b254513e094965b0afa37c41434ef2d645a863363272e url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook-exclude-field.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, remove, mapobject
---

# Exclude Fields from the Output

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example excludes specific XML elements from the output. You might perform a task like
this to remove sensitive data.

The example uses these functions:

- `-` to remove specific `key:value` pairs (here, the `ssn` and `password` XML elements).

- `mapObject` to go through the XML elements.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
users: {
      (payload.users mapObject {
        user: {
        personal_information: $.personal_information - "ssn",
        login_information: $.login_information - "password"
        }
      })
}
```

Input XML Payload:

```xml
<users>
    <user>
        <personal_information>
            <first_name>Emiliano</first_name>
            <middle_name>Romoaldo</middle_name>
            <last_name>Lesende</last_name>
            <ssn>001-08-84382</ssn>
        </personal_information>
        <login_information>
            <username>3miliano</username>
            <password>mypassword1234</password>
        </login_information>
    </user>
    <user>
        <personal_information>
            <first_name>Mariano</first_name>
            <middle_name>Toribio</middle_name>
            <last_name>de Achaval</last_name>
            <ssn>002-05-34738</ssn>
        </personal_information>
        <login_information>
            <username>machaval</username>
            <password>mypassword4321</password>
        </login_information>
    </user>
</users>
```

Output XML:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<users>
  <user>
    <personal_information>
      <first_name>Emiliano</first_name>
      <middle_name>Romoaldo</middle_name>
      <last_name>Lesende</last_name>
    </personal_information>
    <login_information>
      <username>3miliano</username>
    </login_information>
  </user>
  <user>
    <personal_information>
      <first_name>Mariano</first_name>
      <middle_name>Toribio</middle_name>
      <last_name>de Achaval</last_name>
    </personal_information>
    <login_information>
      <username>machaval</username>
    </login_information>
  </user>
</users>
```

## Related Examples

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-output-a-field-when-present)

- [Change the Value of a Field](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-change-value-of-a-field)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-conditional-list-reduction-via-function)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook)

<!-- document id=771bc669450545a37f39b03ca9277d443dd8a8ecd615eef45486acd667d66a69 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-runtime-functions.md -->

---
product: DataWeave
version: 2.11
keywords: lookup, causedby, p, properties, functions
---

# External Functions Available to DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

In addition to the built-in DataWeave functions, Mule Runtime and some modules, connectors, and Core
components provide functions that you can use in DataWeave scripts. The functions are specific to
the modules, connectors, and components that provide them.

## Mule Runtime Functions

These functions are injected by the Mule Runtime:

- `p`

- `lookup`

- `causedBy`

> [!NOTE] Starting in Mule 4.1.4, DataWeave incorporated the Mule Runtime functions into its Mule
> function module.
>
> MuleSoft recommends that you start using the `Mule` namespace when using these functions in Mule
> apps that are running on Mule Runtime 4.1.4 or later. To use them, you simply prepend the
> namespace to the function name, for example, `Mule::p('http:port')`, instead of `p('http:port')`.
>
> In addition to its continued support for the use of Mule Runtime functions in your DataWeave
> scripts and mappings, the Mule module also enables you to use Mule Runtime functions in your
> [custom DataWeave modules](https://docs.mulesoft.com/dataweave/2.11/dataweave-create-module).
>
> Mule apps running on Mule Runtime versions _prior_ to version 4.1.4 cannot use the `Mule`
> namespace or use Mule Runtime functions in custom modules, only in DataWeave scripts and mappings.

For DataWeave runtime properties, see the DataWeave functions [props](https://docs.mulesoft.com/dataweave/2.11/dw-runtime-functions-props)
and [prop](https://docs.mulesoft.com/dataweave/2.11/dw-runtime-functions-prop).

### Accessing Properties (p Function)

The `p` function provides access to properties, whether these are:

- Mule property placeholders

- System properties

- Environment properties

For more on configuring properties and how they are handled, see
[Configure Properties](https://docs.mulesoft.com/mule-runtime/latest/configuring-properties).

The following example logs the value of the property `http.port`.

Example: Property Function Usage for Mule 4.1.4 and Later

```xml
<flow name="simple">
  <logger level="INFO" doc:name="Logger"
    message="#[Mule::p('http.port')]"/>
</flow>
```

Note that you can also use the function when defining a DataWeave variable or function. This example
uses the `p` function in the `myVar` definition. You can do the same thing with pre-4.1.4 runtimes
simply by omitting the `Mule::` namespace.

```xml
<flow name="simple">
  <logger level="INFO" doc:name="Logger"
    message="#[var myVar = Mule::p('http.port') --- myVar]"/>
</flow>
```

Example: Property Function Usage for Mule 4.1.3 and Earlier

```xml
<flow name="simple">
  <logger message="#[p('http.port')]"/>
</flow>
```

See also, the [p](https://docs.mulesoft.com/dataweave/2.11/dw-mule-functions-p) function introduced in the Mule function module in Mule 4.2.

### Execute a Flow (lookup Function)

Similar to the Flow Reference component, the `lookup` function enables you to execute another flow
within your app and to retrieve the resulting payload. It takes the flow’s name and an input payload
as parameters. For example, `lookup("anotherFlow", payload)` executes a flow named `anotherFlow`.

The function executes the specified flow using the current attributes, variables, and any error, but
it only passes in the payload without any attributes or variables. Similarly, the called flow will
only return its payload.

Note that `lookup` function does not support calling subflows.

#### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>flowName</code></p></td><td><p>A string that identifies the target flow.</p></td></tr><tr><td><p><code>payload</code></p></td><td><p>The payload to send to the target flow, which can be any (<code>Any</code>) type.</p></td></tr><tr><td><p><code>timeoutMillis</code></p></td><td><p>Optional. Timeout (in milliseconds) for the execution of the target flow. Defaults to <code>2000</code> milliseconds (2 seconds) if the thread that is executing is CPU_LIGHT or CPU_INTENSIVE, or 1 minute when executing from other threads. If the lookup takes more time than the specified <code>timeoutMillis</code> value, an error is raised.</p></td></tr></tbody></table>

This example shows XML for two flows. The `lookup` function in `flow1` executes `flow2` and passes
the object `{test:'hello '}` as its payload to `flow2`. The Set Payload component (`<set-payload/>`)
in `flow2` then concatenates the value of `{test:'hello '}` with the string `world` to output and
log `hello world`.

Example: Using the `lookup` Function in Mule 4.1.4 or Later

```XML
<flow name="flow1">
  <http:listener doc:name="Listener" config-ref="HTTP_Listener_config"
    path="/source"/>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
Mule::lookup('flow2', {test:'hello '})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
</flow>
<flow name="flow2" >
  <set-payload value='#[payload.test ++ "world"]' doc:name="Set Payload" />
  <logger level="INFO" doc:name="Logger" message='#[payload]'/>
</flow>
```

Example: Using the `lookup` Function in Mule 4.1.3 and Earlier

```XML
<flow name="flow1">
  <http:listener doc:name="Listener" config-ref="HTTP_Listener_config"
    path="/source"/>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
lookup('flow2', {test:'hello '})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
</flow>
<flow name="flow2" >
  <set-payload value='#[payload.test ++ "world"]' doc:name="Set Payload" />
  <logger level="INFO" doc:name="Logger" message='#[payload]'/>
</flow>
```

Output

```json
hello world
```

> [!WARNING] Always keep in mind that a functional language like DataWeave expects the invocation of
> the `lookup` function to _not_ have side effects. As such, the internal workings of the DataWeave
> engine might cause a `lookup` function to be invoked in parallel with other \`lookup\`s, or not
> invoked it at all.
>
> MuleSoft recommends that you invoke flows with the Flow Ref (`flow-ref`) component, using the
> `target` attribute to put the result of the flow in a `var` and then referencing that `var` from
> within the DataWeave script.

### Matching Errors by Types (causedBy Function)

The `causedBy` function matches an error by its type, like an error handler does. This is useful
when matching by a super type is required but specific sub-type logic is also needed or when
handling a `COMPOSITE_ROUTING` error that contains child errors of different types.

The error to match against can be implicit, but the type is always a required parameter.

In the following example, a global error handler is set up to handle `SECURITY` errors in a general
way, while specific actions are set up for `HTTP:UNAUTHORIZED` and `HTTP:FORBIDDEN` errors.

Example: Error Matcher Function Usage in Mule Runtime Version 4.1.4 and Later

```xml
<error-handler name="securityHandler">
  <on-error-continue type="SECURITY">
    <!-- general error handling for all SECURITY errors -->
    <choice>
      <when expression="#[error Mule::causedBy 'HTTP:UNAUTHORIZED']">
        <!-- specific error handling only for HTTP:UNAUTHORIZED errors -->
      </when>
      <when expression="#[Mule::causedBy('HTTP:FORBIDDEN')]">
        <!-- specific error handling only for HTTP:FORBIDDEN errors -->
      </when>
    </choice>
  </on-error-continue>
</error-handler>
```

Example: Error Matcher Function Usage in Mule Runtime Version 4.1.3 and Earlier

```xml
<error-handler name="securityHandler">
  <on-error-continue type="SECURITY">
    <!-- general error handling for all SECURITY errors -->
    <choice>
      <when expression="#[error causedBy 'HTTP:UNAUTHORIZED']">
        <!-- specific error handling only for HTTP:UNAUTHORIZED errors -->
      </when>
      <when expression="#[causedBy('HTTP:FORBIDDEN')]">
        <!-- specific error handling only for HTTP:FORBIDDEN errors -->
      </when>
    </choice>
  </on-error-continue>
</error-handler>
```

Notice that the error parameter is used both explicitly and implicitly.

## Connector and Component Functions

When using connectors and components in a Mule app, you can inject functions. Unlike the Runtime
functions, these functions require a namespace, which usually matches the component name.

For example, in an app using Batch you can use the following expression:
`#[Batch::isSuccessfulRecord()]`.

## See Also

[DataWeave Core Functions](https://docs.mulesoft.com/dataweave/2.11/dw-functions)

[DataWeave Types](https://docs.mulesoft.com/dataweave/2.11/dataweave-types)

[DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.11/dataweave-selectors)

<!-- document id=fba9f59bf9bea85a8ea1e38df48fa1aca73c0d14ae35016b08e93f2191911deb url=/mulesoft/current/en-us/dataweave/2.12/dataweave-runtime-functions.md -->

---
product: DataWeave
version: 2.12
keywords: lookup, causedby, p, properties, functions
---

# External Functions Available to DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

In addition to the built-in DataWeave functions, Mule Runtime and some modules, connectors, and Core
components provide functions that you can use in DataWeave scripts. The functions are specific to
the modules, connectors, and components that provide them.

## Mule Runtime Functions

These functions are injected by the Mule Runtime:

- `p`

- `lookup`

- `causedBy`

> [!NOTE] Starting in Mule 4.1.4, DataWeave incorporated the Mule Runtime functions into its Mule
> function module.
>
> MuleSoft recommends that you start using the `Mule` namespace when using these functions in Mule
> apps that are running on Mule Runtime 4.1.4 or later. To use them, you simply prepend the
> namespace to the function name, for example, `Mule::p('http:port')`, instead of `p('http:port')`.
>
> In addition to its continued support for the use of Mule Runtime functions in your DataWeave
> scripts and mappings, the Mule module also enables you to use Mule Runtime functions in your
> [custom DataWeave modules](https://docs.mulesoft.com/dataweave/2.12/dataweave-create-module).
>
> Mule apps running on Mule Runtime versions _prior_ to version 4.1.4 cannot use the `Mule`
> namespace or use Mule Runtime functions in custom modules, only in DataWeave scripts and mappings.

For DataWeave runtime properties, see the DataWeave functions [props](https://docs.mulesoft.com/dataweave/2.12/dw-runtime-functions-props)
and [prop](https://docs.mulesoft.com/dataweave/2.12/dw-runtime-functions-prop).

### Accessing Properties (p Function)

The `p` function provides access to properties, whether these are:

- Mule property placeholders

- System properties

- Environment properties

For more on configuring properties and how they are handled, see
[Configure Properties](https://docs.mulesoft.com/mule-runtime/latest/configuring-properties).

The following example logs the value of the property `http.port`.

Example: Property Function Usage for Mule 4.1.4 and Later

```xml
<flow name="simple">
  <logger level="INFO" doc:name="Logger"
    message="#[Mule::p('http.port')]"/>
</flow>
```

Note that you can also use the function when defining a DataWeave variable or function. This example
uses the `p` function in the `myVar` definition. You can do the same thing with pre-4.1.4 runtimes
simply by omitting the `Mule::` namespace.

```xml
<flow name="simple">
  <logger level="INFO" doc:name="Logger"
    message="#[var myVar = Mule::p('http.port') --- myVar]"/>
</flow>
```

Example: Property Function Usage for Mule 4.1.3 and Earlier

```xml
<flow name="simple">
  <logger message="#[p('http.port')]"/>
</flow>
```

See also, the [p](https://docs.mulesoft.com/dataweave/2.12/dw-mule-functions-p) function introduced in the Mule function module in Mule 4.2.

### Execute a Flow (lookup Function)

Similar to the Flow Reference component, the `lookup` function enables you to execute another flow
within your app and to retrieve the resulting payload. It takes the flow’s name and an input payload
as parameters. For example, `lookup("anotherFlow", payload)` executes a flow named `anotherFlow`.

The function executes the specified flow using the current attributes, variables, and any error, but
it only passes in the payload without any attributes or variables. Similarly, the called flow will
only return its payload.

Note that `lookup` function does not support calling subflows.

#### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>flowName</code></p></td><td><p>A string that identifies the target flow.</p></td></tr><tr><td><p><code>payload</code></p></td><td><p>The payload to send to the target flow, which can be any (<code>Any</code>) type.</p></td></tr><tr><td><p><code>timeoutMillis</code></p></td><td><p>Optional. Timeout (in milliseconds) for the execution of the target flow. Defaults to <code>2000</code> milliseconds (2 seconds) if the thread that is executing is CPU_LIGHT or CPU_INTENSIVE, or 1 minute when executing from other threads. If the lookup takes more time than the specified <code>timeoutMillis</code> value, an error is raised.</p></td></tr></tbody></table>

This example shows XML for two flows. The `lookup` function in `flow1` executes `flow2` and passes
the object `{test:'hello '}` as its payload to `flow2`. The Set Payload component (`<set-payload/>`)
in `flow2` then concatenates the value of `{test:'hello '}` with the string `world` to output and
log `hello world`.

Example: Using the `lookup` Function in Mule 4.1.4 or Later

```XML
<flow name="flow1">
  <http:listener doc:name="Listener" config-ref="HTTP_Listener_config"
    path="/source"/>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
Mule::lookup('flow2', {test:'hello '})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
</flow>
<flow name="flow2" >
  <set-payload value='#[payload.test ++ "world"]' doc:name="Set Payload" />
  <logger level="INFO" doc:name="Logger" message='#[payload]'/>
</flow>
```

Example: Using the `lookup` Function in Mule 4.1.3 and Earlier

```XML
<flow name="flow1">
  <http:listener doc:name="Listener" config-ref="HTTP_Listener_config"
    path="/source"/>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
lookup('flow2', {test:'hello '})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
</flow>
<flow name="flow2" >
  <set-payload value='#[payload.test ++ "world"]' doc:name="Set Payload" />
  <logger level="INFO" doc:name="Logger" message='#[payload]'/>
</flow>
```

Output

```json
hello world
```

> [!WARNING] Always keep in mind that a functional language like DataWeave expects the invocation of
> the `lookup` function to _not_ have side effects. As such, the internal workings of the DataWeave
> engine might cause a `lookup` function to be invoked in parallel with other \`lookup\`s, or not
> invoked it at all.
>
> MuleSoft recommends that you invoke flows with the Flow Ref (`flow-ref`) component, using the
> `target` attribute to put the result of the flow in a `var` and then referencing that `var` from
> within the DataWeave script.

### Matching Errors by Types (causedBy Function)

The `causedBy` function matches an error by its type, like an error handler does. This is useful
when matching by a super type is required but specific sub-type logic is also needed or when
handling a `COMPOSITE_ROUTING` error that contains child errors of different types.

The error to match against can be implicit, but the type is always a required parameter.

In the following example, a global error handler is set up to handle `SECURITY` errors in a general
way, while specific actions are set up for `HTTP:UNAUTHORIZED` and `HTTP:FORBIDDEN` errors.

Example: Error Matcher Function Usage in Mule Runtime Version 4.1.4 and Later

```xml
<error-handler name="securityHandler">
  <on-error-continue type="SECURITY">
    <!-- general error handling for all SECURITY errors -->
    <choice>
      <when expression="#[error Mule::causedBy 'HTTP:UNAUTHORIZED']">
        <!-- specific error handling only for HTTP:UNAUTHORIZED errors -->
      </when>
      <when expression="#[Mule::causedBy('HTTP:FORBIDDEN')]">
        <!-- specific error handling only for HTTP:FORBIDDEN errors -->
      </when>
    </choice>
  </on-error-continue>
</error-handler>
```

Example: Error Matcher Function Usage in Mule Runtime Version 4.1.3 and Earlier

```xml
<error-handler name="securityHandler">
  <on-error-continue type="SECURITY">
    <!-- general error handling for all SECURITY errors -->
    <choice>
      <when expression="#[error causedBy 'HTTP:UNAUTHORIZED']">
        <!-- specific error handling only for HTTP:UNAUTHORIZED errors -->
      </when>
      <when expression="#[causedBy('HTTP:FORBIDDEN')]">
        <!-- specific error handling only for HTTP:FORBIDDEN errors -->
      </when>
    </choice>
  </on-error-continue>
</error-handler>
```

Notice that the error parameter is used both explicitly and implicitly.

## Connector and Component Functions

When using connectors and components in a Mule app, you can inject functions. Unlike the Runtime
functions, these functions require a namespace, which usually matches the component name.

For example, in an app using Batch you can use the following expression:
`#[Batch::isSuccessfulRecord()]`.

## See Also

[DataWeave Core Functions](https://docs.mulesoft.com/dataweave/2.12/dw-functions)

[DataWeave Types](https://docs.mulesoft.com/dataweave/2.12/dataweave-types)

[DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.12/dataweave-selectors)

<!-- document id=e482d9df77f9e17004d56619abc832e297997885a4cc291387739fe5f5056b58 url=/mulesoft/current/en-us/dataweave/2.3/dataweave-runtime-functions.md -->

---
product: DataWeave
version: 2.3
keywords: lookup, causedby, p, properties, functions
---

# External Functions Available to DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

In addition to the built-in DataWeave functions, Mule Runtime and some modules, connectors, and Core
components provide functions that you can use in DataWeave scripts. The functions are specific to
the modules, connectors, and components that provide them.

## Mule Runtime Functions

These functions are injected by the Mule Runtime:

- `p`

- `lookup`

- `causedBy`

> [!NOTE] Starting in Mule 4.1.4, DataWeave incorporated the Mule Runtime functions into its Mule
> function module.
>
> MuleSoft recommends that you start using the `Mule` namespace when using these functions in Mule
> apps that are running on Mule Runtime 4.1.4 or later. To use them, you simply prepend the
> namespace to the function name, for example, `Mule::p('http:port')`, instead of `p('http:port')`.
>
> In addition to its continued support for the use of Mule Runtime functions in your DataWeave
> scripts and mappings, the Mule module also enables you to use Mule Runtime functions in your
> [custom DataWeave modules](https://docs.mulesoft.com/dataweave/2.3/dataweave-create-module).
>
> Mule apps running on Mule Runtime versions _prior_ to version 4.1.4 cannot use the `Mule`
> namespace or use Mule Runtime functions in custom modules, only in DataWeave scripts and mappings.

### Accessing Properties (p Function)

The `p` function provides access to properties, whether these are:

- Mule property placeholders

- System properties

- Environment properties

For more on configuring properties and how they are handled, see
[Configure Properties](https://docs.mulesoft.com/mule-runtime/4.3/configuring-properties).

The following example logs the value of the property `http.port`.

Example: Property Function Usage for Mule 4.1.4 and Later

```xml
<flow name="simple">
  <logger level="INFO" doc:name="Logger"
    message="#[Mule::p('http.port')]"/>
</flow>
```

Note that you can also use the function when defining a DataWeave variable or function. This example
uses the `p` function in the `myVar` definition. You can do the same thing with pre-4.1.4 runtimes
simply by omitting the `Mule::` namespace.

```xml
<flow name="simple">
  <logger level="INFO" doc:name="Logger"
    message="#[var myVar = Mule::p('http.port') --- myVar]"/>
</flow>
```

Example: Property Function Usage for Mule 4.1.3 and Earlier

```xml
<flow name="simple">
  <logger message="#[p('http.port')]"/>
</flow>
```

See also, the [p](https://docs.mulesoft.com/dataweave/2.3/dw-mule-functions-p) function introduced in the Mule function module in Mule 4.2.

### Execute a Flow (lookup Function)

Similar to the Flow Reference component, the `lookup` function enables you to execute another flow
within your app and to retrieve the resulting payload. It takes the flow’s name and an input payload
as parameters. For example, `lookup("anotherFlow", payload)` executes a flow named `anotherFlow`.

The function executes the specified flow using the current attributes, variables, and any error, but
it only passes in the payload without any attributes or variables. Similarly, the called flow will
only return its payload.

Note that `lookup` function does not support calling subflows.

#### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>flowName</code></p></td><td><p>A string that identifies the target flow.</p></td></tr><tr><td><p><code>payload</code></p></td><td><p>The payload to send to the target flow, which can be any (<code>Any</code>) type.</p></td></tr><tr><td><p><code>timeoutMillis</code></p></td><td><p>Optional. Timeout (in milliseconds) for the execution of the target flow. Defaults to <code>2000</code> milliseconds (2 seconds) if the thread that is executing is CPU_LIGHT or CPU_INTENSIVE, or 1 minute when executing from other threads. If the lookup takes more time than the specified <code>timeoutMillis</code> value, an error is raised.</p></td></tr></tbody></table>

This example shows XML for two flows. The `lookup` function in `flow1` executes `flow2` and passes
the object `{test:'hello '}` as its payload to `flow2`. The Set Payload component (`<set-payload/>`)
in `flow2` then concatenates the value of `{test:'hello '}` with the string `world` to output and
log `hello world`.

Example: Using the `lookup` Function in Mule 4.1.4 or Later

```XML
<flow name="flow1">
  <http:listener doc:name="Listener" config-ref="HTTP_Listener_config"
    path="/source"/>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
Mule::lookup('flow2', {test:'hello '})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
</flow>
<flow name="flow2" >
  <set-payload value='#[payload.test ++ "world"]' doc:name="Set Payload" />
  <logger level="INFO" doc:name="Logger" message='#[payload]'/>
</flow>
```

Example: Using the `lookup` Function in Mule 4.1.3 and Earlier

```XML
<flow name="flow1">
  <http:listener doc:name="Listener" config-ref="HTTP_Listener_config"
    path="/source"/>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
lookup('flow2', {test:'hello '})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
</flow>
<flow name="flow2" >
  <set-payload value='#[payload.test ++ "world"]' doc:name="Set Payload" />
  <logger level="INFO" doc:name="Logger" message='#[payload]'/>
</flow>
```

Output

```json
hello world
```

> [!WARNING] Always keep in mind that a functional language like DataWeave expects the invocation of
> the `lookup` function to _not_ have side effects. As such, the internal workings of the DataWeave
> engine might cause a `lookup` function to be invoked in parallel with other \`lookup\`s, or not
> invoked it at all.
>
> MuleSoft recommends that you invoke flows with the Flow Ref (`flow-ref`) component, using the
> `target` attribute to put the result of the flow in a `var` and then referencing that `var` from
> within the DataWeave script.

### Matching Errors by Types (causedBy Function)

The `causedBy` function matches an error by its type, like an error handler does. This is useful
when matching by a super type is required but specific sub-type logic is also needed or when
handling a `COMPOSITE_ROUTING` error that contains child errors of different types.

The error to match against can be implicit, but the type is always a required parameter.

In the following example, a global error handler is set up to handle `SECURITY` errors in a general
way, while specific actions are set up for `HTTP:UNAUTHORIZED` and `HTTP:FORBIDDEN` errors.

Example: Error Matcher Function Usage in Mule Runtime Version 4.1.4 and Later

```xml
<error-handler name="securityHandler">
  <on-error-continue type="SECURITY">
    <!-- general error handling for all SECURITY errors -->
    <choice>
      <when expression="#[error Mule::causedBy 'HTTP:UNAUTHORIZED']">
        <!-- specific error handling only for HTTP:UNAUTHORIZED errors -->
      </when>
      <when expression="#[Mule::causedBy('HTTP:FORBIDDEN')]">
        <!-- specific error handling only for HTTP:FORBIDDEN errors -->
      </when>
    </choice>
  </on-error-continue>
</error-handler>
```

Example: Error Matcher Function Usage in Mule Runtime Version 4.1.3 and Earlier

```xml
<error-handler name="securityHandler">
  <on-error-continue type="SECURITY">
    <!-- general error handling for all SECURITY errors -->
    <choice>
      <when expression="#[error causedBy 'HTTP:UNAUTHORIZED']">
        <!-- specific error handling only for HTTP:UNAUTHORIZED errors -->
      </when>
      <when expression="#[causedBy('HTTP:FORBIDDEN')]">
        <!-- specific error handling only for HTTP:FORBIDDEN errors -->
      </when>
    </choice>
  </on-error-continue>
</error-handler>
```

Notice that the error parameter is used both explicitly and implicitly.

## Connector and Component Functions

When using connectors and components in a Mule app, you can inject functions. Unlike the Runtime
functions, these functions require a namespace, which usually matches the component name.

For example, in an app using Batch you can use the following expression:
`#[Batch::isSuccessfulRecord()]`.

## See Also

[DataWeave Core Functions](https://docs.mulesoft.com/dataweave/2.3/dw-functions)

[DataWeave Types](https://docs.mulesoft.com/dataweave/2.3/dataweave-types)

[DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.3/dataweave-selectors)

<!-- document id=f75828ac1e24d514a5c18056a33816a8325134021936dc5707bf39f851084805 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-runtime-functions.md -->

---
product: DataWeave
version: 2.4
keywords: lookup, causedby, p, properties, functions
---

# External Functions Available to DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

In addition to the built-in DataWeave functions, Mule Runtime and some modules, connectors, and Core
components provide functions that you can use in DataWeave scripts. The functions are specific to
the modules, connectors, and components that provide them.

## Mule Runtime Functions

These functions are injected by the Mule Runtime:

- `p`

- `lookup`

- `causedBy`

> [!NOTE] Starting in Mule 4.1.4, DataWeave incorporated the Mule Runtime functions into its Mule
> function module.
>
> MuleSoft recommends that you start using the `Mule` namespace when using these functions in Mule
> apps that are running on Mule Runtime 4.1.4 or later. To use them, you simply prepend the
> namespace to the function name, for example, `Mule::p('http:port')`, instead of `p('http:port')`.
>
> In addition to its continued support for the use of Mule Runtime functions in your DataWeave
> scripts and mappings, the Mule module also enables you to use Mule Runtime functions in your
> [custom DataWeave modules](https://docs.mulesoft.com/dataweave/2.4/dataweave-create-module).
>
> Mule apps running on Mule Runtime versions _prior_ to version 4.1.4 cannot use the `Mule`
> namespace or use Mule Runtime functions in custom modules, only in DataWeave scripts and mappings.

For DataWeave runtime properties, see the DataWeave functions [props](https://docs.mulesoft.com/dataweave/2.4/dw-runtime-functions-props)
and [prop](https://docs.mulesoft.com/dataweave/2.4/dw-runtime-functions-prop).

### Accessing Properties (p Function)

The `p` function provides access to properties, whether these are:

- Mule property placeholders

- System properties

- Environment properties

For more on configuring properties and how they are handled, see
[Configure Properties](https://docs.mulesoft.com/mule-runtime/latest/configuring-properties).

The following example logs the value of the property `http.port`.

Example: Property Function Usage for Mule 4.1.4 and Later

```xml
<flow name="simple">
  <logger level="INFO" doc:name="Logger"
    message="#[Mule::p('http.port')]"/>
</flow>
```

Note that you can also use the function when defining a DataWeave variable or function. This example
uses the `p` function in the `myVar` definition. You can do the same thing with pre-4.1.4 runtimes
simply by omitting the `Mule::` namespace.

```xml
<flow name="simple">
  <logger level="INFO" doc:name="Logger"
    message="#[var myVar = Mule::p('http.port') --- myVar]"/>
</flow>
```

Example: Property Function Usage for Mule 4.1.3 and Earlier

```xml
<flow name="simple">
  <logger message="#[p('http.port')]"/>
</flow>
```

See also, the [p](https://docs.mulesoft.com/dataweave/2.4/dw-mule-functions-p) function introduced in the Mule function module in Mule 4.2.

### Execute a Flow (lookup Function)

Similar to the Flow Reference component, the `lookup` function enables you to execute another flow
within your app and to retrieve the resulting payload. It takes the flow’s name and an input payload
as parameters. For example, `lookup("anotherFlow", payload)` executes a flow named `anotherFlow`.

The function executes the specified flow using the current attributes, variables, and any error, but
it only passes in the payload without any attributes or variables. Similarly, the called flow will
only return its payload.

Note that `lookup` function does not support calling subflows.

#### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>flowName</code></p></td><td><p>A string that identifies the target flow.</p></td></tr><tr><td><p><code>payload</code></p></td><td><p>The payload to send to the target flow, which can be any (<code>Any</code>) type.</p></td></tr><tr><td><p><code>timeoutMillis</code></p></td><td><p>Optional. Timeout (in milliseconds) for the execution of the target flow. Defaults to <code>2000</code> milliseconds (2 seconds) if the thread that is executing is CPU_LIGHT or CPU_INTENSIVE, or 1 minute when executing from other threads. If the lookup takes more time than the specified <code>timeoutMillis</code> value, an error is raised.</p></td></tr></tbody></table>

This example shows XML for two flows. The `lookup` function in `flow1` executes `flow2` and passes
the object `{test:'hello '}` as its payload to `flow2`. The Set Payload component (`<set-payload/>`)
in `flow2` then concatenates the value of `{test:'hello '}` with the string `world` to output and
log `hello world`.

Example: Using the `lookup` Function in Mule 4.1.4 or Later

```XML
<flow name="flow1">
  <http:listener doc:name="Listener" config-ref="HTTP_Listener_config"
    path="/source"/>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
Mule::lookup('flow2', {test:'hello '})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
</flow>
<flow name="flow2" >
  <set-payload value='#[payload.test ++ "world"]' doc:name="Set Payload" />
  <logger level="INFO" doc:name="Logger" message='#[payload]'/>
</flow>
```

Example: Using the `lookup` Function in Mule 4.1.3 and Earlier

```XML
<flow name="flow1">
  <http:listener doc:name="Listener" config-ref="HTTP_Listener_config"
    path="/source"/>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
lookup('flow2', {test:'hello '})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
</flow>
<flow name="flow2" >
  <set-payload value='#[payload.test ++ "world"]' doc:name="Set Payload" />
  <logger level="INFO" doc:name="Logger" message='#[payload]'/>
</flow>
```

Output

```json
hello world
```

> [!WARNING] Always keep in mind that a functional language like DataWeave expects the invocation of
> the `lookup` function to _not_ have side effects. As such, the internal workings of the DataWeave
> engine might cause a `lookup` function to be invoked in parallel with other \`lookup\`s, or not
> invoked it at all.
>
> MuleSoft recommends that you invoke flows with the Flow Ref (`flow-ref`) component, using the
> `target` attribute to put the result of the flow in a `var` and then referencing that `var` from
> within the DataWeave script.

### Matching Errors by Types (causedBy Function)

The `causedBy` function matches an error by its type, like an error handler does. This is useful
when matching by a super type is required but specific sub-type logic is also needed or when
handling a `COMPOSITE_ROUTING` error that contains child errors of different types.

The error to match against can be implicit, but the type is always a required parameter.

In the following example, a global error handler is set up to handle `SECURITY` errors in a general
way, while specific actions are set up for `HTTP:UNAUTHORIZED` and `HTTP:FORBIDDEN` errors.

Example: Error Matcher Function Usage in Mule Runtime Version 4.1.4 and Later

```xml
<error-handler name="securityHandler">
  <on-error-continue type="SECURITY">
    <!-- general error handling for all SECURITY errors -->
    <choice>
      <when expression="#[error Mule::causedBy 'HTTP:UNAUTHORIZED']">
        <!-- specific error handling only for HTTP:UNAUTHORIZED errors -->
      </when>
      <when expression="#[Mule::causedBy('HTTP:FORBIDDEN')]">
        <!-- specific error handling only for HTTP:FORBIDDEN errors -->
      </when>
    </choice>
  </on-error-continue>
</error-handler>
```

Example: Error Matcher Function Usage in Mule Runtime Version 4.1.3 and Earlier

```xml
<error-handler name="securityHandler">
  <on-error-continue type="SECURITY">
    <!-- general error handling for all SECURITY errors -->
    <choice>
      <when expression="#[error causedBy 'HTTP:UNAUTHORIZED']">
        <!-- specific error handling only for HTTP:UNAUTHORIZED errors -->
      </when>
      <when expression="#[causedBy('HTTP:FORBIDDEN')]">
        <!-- specific error handling only for HTTP:FORBIDDEN errors -->
      </when>
    </choice>
  </on-error-continue>
</error-handler>
```

Notice that the error parameter is used both explicitly and implicitly.

## Connector and Component Functions

When using connectors and components in a Mule app, you can inject functions. Unlike the Runtime
functions, these functions require a namespace, which usually matches the component name.

For example, in an app using Batch you can use the following expression:
`#[Batch::isSuccessfulRecord()]`.

## See Also

[DataWeave Core Functions](https://docs.mulesoft.com/dataweave/2.4/dw-functions)

[DataWeave Types](https://docs.mulesoft.com/dataweave/2.4/dataweave-types)

[DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.4/dataweave-selectors)

<!-- document id=9d20bd9c36211aec09530752ff6ee3076c1c0b32949d875f2547791009b316d5 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-runtime-functions.md -->

---
product: DataWeave
version: 2.6
keywords: lookup, causedby, p, properties, functions
---

# External Functions Available to DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

In addition to the built-in DataWeave functions, Mule Runtime and some modules, connectors, and Core
components provide functions that you can use in DataWeave scripts. The functions are specific to
the modules, connectors, and components that provide them.

## Mule Runtime Functions

These functions are injected by the Mule Runtime:

- `p`

- `lookup`

- `causedBy`

> [!NOTE] Starting in Mule 4.1.4, DataWeave incorporated the Mule Runtime functions into its Mule
> function module.
>
> MuleSoft recommends that you start using the `Mule` namespace when using these functions in Mule
> apps that are running on Mule Runtime 4.1.4 or later. To use them, you simply prepend the
> namespace to the function name, for example, `Mule::p('http:port')`, instead of `p('http:port')`.
>
> In addition to its continued support for the use of Mule Runtime functions in your DataWeave
> scripts and mappings, the Mule module also enables you to use Mule Runtime functions in your
> [custom DataWeave modules](https://docs.mulesoft.com/dataweave/2.6/dataweave-create-module).
>
> Mule apps running on Mule Runtime versions _prior_ to version 4.1.4 cannot use the `Mule`
> namespace or use Mule Runtime functions in custom modules, only in DataWeave scripts and mappings.

For DataWeave runtime properties, see the DataWeave functions [props](https://docs.mulesoft.com/dataweave/2.6/dw-runtime-functions-props)
and [prop](https://docs.mulesoft.com/dataweave/2.6/dw-runtime-functions-prop).

### Accessing Properties (p Function)

The `p` function provides access to properties, whether these are:

- Mule property placeholders

- System properties

- Environment properties

For more on configuring properties and how they are handled, see
[Configure Properties](https://docs.mulesoft.com/mule-runtime/latest/configuring-properties).

The following example logs the value of the property `http.port`.

Example: Property Function Usage for Mule 4.1.4 and Later

```xml
<flow name="simple">
  <logger level="INFO" doc:name="Logger"
    message="#[Mule::p('http.port')]"/>
</flow>
```

Note that you can also use the function when defining a DataWeave variable or function. This example
uses the `p` function in the `myVar` definition. You can do the same thing with pre-4.1.4 runtimes
simply by omitting the `Mule::` namespace.

```xml
<flow name="simple">
  <logger level="INFO" doc:name="Logger"
    message="#[var myVar = Mule::p('http.port') --- myVar]"/>
</flow>
```

Example: Property Function Usage for Mule 4.1.3 and Earlier

```xml
<flow name="simple">
  <logger message="#[p('http.port')]"/>
</flow>
```

See also, the [p](https://docs.mulesoft.com/dataweave/2.6/dw-mule-functions-p) function introduced in the Mule function module in Mule 4.2.

### Execute a Flow (lookup Function)

Similar to the Flow Reference component, the `lookup` function enables you to execute another flow
within your app and to retrieve the resulting payload. It takes the flow’s name and an input payload
as parameters. For example, `lookup("anotherFlow", payload)` executes a flow named `anotherFlow`.

The function executes the specified flow using the current attributes, variables, and any error, but
it only passes in the payload without any attributes or variables. Similarly, the called flow will
only return its payload.

Note that `lookup` function does not support calling subflows.

#### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>flowName</code></p></td><td><p>A string that identifies the target flow.</p></td></tr><tr><td><p><code>payload</code></p></td><td><p>The payload to send to the target flow, which can be any (<code>Any</code>) type.</p></td></tr><tr><td><p><code>timeoutMillis</code></p></td><td><p>Optional. Timeout (in milliseconds) for the execution of the target flow. Defaults to <code>2000</code> milliseconds (2 seconds) if the thread that is executing is CPU_LIGHT or CPU_INTENSIVE, or 1 minute when executing from other threads. If the lookup takes more time than the specified <code>timeoutMillis</code> value, an error is raised.</p></td></tr></tbody></table>

This example shows XML for two flows. The `lookup` function in `flow1` executes `flow2` and passes
the object `{test:'hello '}` as its payload to `flow2`. The Set Payload component (`<set-payload/>`)
in `flow2` then concatenates the value of `{test:'hello '}` with the string `world` to output and
log `hello world`.

Example: Using the `lookup` Function in Mule 4.1.4 or Later

```XML
<flow name="flow1">
  <http:listener doc:name="Listener" config-ref="HTTP_Listener_config"
    path="/source"/>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
Mule::lookup('flow2', {test:'hello '})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
</flow>
<flow name="flow2" >
  <set-payload value='#[payload.test ++ "world"]' doc:name="Set Payload" />
  <logger level="INFO" doc:name="Logger" message='#[payload]'/>
</flow>
```

Example: Using the `lookup` Function in Mule 4.1.3 and Earlier

```XML
<flow name="flow1">
  <http:listener doc:name="Listener" config-ref="HTTP_Listener_config"
    path="/source"/>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
lookup('flow2', {test:'hello '})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
</flow>
<flow name="flow2" >
  <set-payload value='#[payload.test ++ "world"]' doc:name="Set Payload" />
  <logger level="INFO" doc:name="Logger" message='#[payload]'/>
</flow>
```

Output

```json
hello world
```

> [!WARNING] Always keep in mind that a functional language like DataWeave expects the invocation of
> the `lookup` function to _not_ have side effects. As such, the internal workings of the DataWeave
> engine might cause a `lookup` function to be invoked in parallel with other \`lookup\`s, or not
> invoked it at all.
>
> MuleSoft recommends that you invoke flows with the Flow Ref (`flow-ref`) component, using the
> `target` attribute to put the result of the flow in a `var` and then referencing that `var` from
> within the DataWeave script.

### Matching Errors by Types (causedBy Function)

The `causedBy` function matches an error by its type, like an error handler does. This is useful
when matching by a super type is required but specific sub-type logic is also needed or when
handling a `COMPOSITE_ROUTING` error that contains child errors of different types.

The error to match against can be implicit, but the type is always a required parameter.

In the following example, a global error handler is set up to handle `SECURITY` errors in a general
way, while specific actions are set up for `HTTP:UNAUTHORIZED` and `HTTP:FORBIDDEN` errors.

Example: Error Matcher Function Usage in Mule Runtime Version 4.1.4 and Later

```xml
<error-handler name="securityHandler">
  <on-error-continue type="SECURITY">
    <!-- general error handling for all SECURITY errors -->
    <choice>
      <when expression="#[error Mule::causedBy 'HTTP:UNAUTHORIZED']">
        <!-- specific error handling only for HTTP:UNAUTHORIZED errors -->
      </when>
      <when expression="#[Mule::causedBy('HTTP:FORBIDDEN')]">
        <!-- specific error handling only for HTTP:FORBIDDEN errors -->
      </when>
    </choice>
  </on-error-continue>
</error-handler>
```

Example: Error Matcher Function Usage in Mule Runtime Version 4.1.3 and Earlier

```xml
<error-handler name="securityHandler">
  <on-error-continue type="SECURITY">
    <!-- general error handling for all SECURITY errors -->
    <choice>
      <when expression="#[error causedBy 'HTTP:UNAUTHORIZED']">
        <!-- specific error handling only for HTTP:UNAUTHORIZED errors -->
      </when>
      <when expression="#[causedBy('HTTP:FORBIDDEN')]">
        <!-- specific error handling only for HTTP:FORBIDDEN errors -->
      </when>
    </choice>
  </on-error-continue>
</error-handler>
```

Notice that the error parameter is used both explicitly and implicitly.

## Connector and Component Functions

When using connectors and components in a Mule app, you can inject functions. Unlike the Runtime
functions, these functions require a namespace, which usually matches the component name.

For example, in an app using Batch you can use the following expression:
`#[Batch::isSuccessfulRecord()]`.

## See Also

[DataWeave Core Functions](https://docs.mulesoft.com/dataweave/2.6/dw-functions)

[DataWeave Types](https://docs.mulesoft.com/dataweave/2.6/dataweave-types)

[DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.6/dataweave-selectors)

<!-- document id=02fa52189dec45a518a9f4727a83b776242299d6ea39deb6c08b19d651733413 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-runtime-functions.md -->

---
product: DataWeave
version: 2.9
keywords: lookup, causedby, p, properties, functions
---

# External Functions Available to DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

In addition to the built-in DataWeave functions, Mule Runtime and some modules, connectors, and Core
components provide functions that you can use in DataWeave scripts. The functions are specific to
the modules, connectors, and components that provide them.

## Mule Runtime Functions

These functions are injected by the Mule Runtime:

- `p`

- `lookup`

- `causedBy`

> [!NOTE] Starting in Mule 4.1.4, DataWeave incorporated the Mule Runtime functions into its Mule
> function module.
>
> MuleSoft recommends that you start using the `Mule` namespace when using these functions in Mule
> apps that are running on Mule Runtime 4.1.4 or later. To use them, you simply prepend the
> namespace to the function name, for example, `Mule::p('http:port')`, instead of `p('http:port')`.
>
> In addition to its continued support for the use of Mule Runtime functions in your DataWeave
> scripts and mappings, the Mule module also enables you to use Mule Runtime functions in your
> [custom DataWeave modules](https://docs.mulesoft.com/dataweave/2.9/dataweave-create-module).
>
> Mule apps running on Mule Runtime versions _prior_ to version 4.1.4 cannot use the `Mule`
> namespace or use Mule Runtime functions in custom modules, only in DataWeave scripts and mappings.

For DataWeave runtime properties, see the DataWeave functions [props](https://docs.mulesoft.com/dataweave/2.9/dw-runtime-functions-props)
and [prop](https://docs.mulesoft.com/dataweave/2.9/dw-runtime-functions-prop).

### Accessing Properties (p Function)

The `p` function provides access to properties, whether these are:

- Mule property placeholders

- System properties

- Environment properties

For more on configuring properties and how they are handled, see
[Configure Properties](https://docs.mulesoft.com/mule-runtime/latest/configuring-properties).

The following example logs the value of the property `http.port`.

Example: Property Function Usage for Mule 4.1.4 and Later

```xml
<flow name="simple">
  <logger level="INFO" doc:name="Logger"
    message="#[Mule::p('http.port')]"/>
</flow>
```

Note that you can also use the function when defining a DataWeave variable or function. This example
uses the `p` function in the `myVar` definition. You can do the same thing with pre-4.1.4 runtimes
simply by omitting the `Mule::` namespace.

```xml
<flow name="simple">
  <logger level="INFO" doc:name="Logger"
    message="#[var myVar = Mule::p('http.port') --- myVar]"/>
</flow>
```

Example: Property Function Usage for Mule 4.1.3 and Earlier

```xml
<flow name="simple">
  <logger message="#[p('http.port')]"/>
</flow>
```

See also, the [p](https://docs.mulesoft.com/dataweave/2.9/dw-mule-functions-p) function introduced in the Mule function module in Mule 4.2.

### Execute a Flow (lookup Function)

Similar to the Flow Reference component, the `lookup` function enables you to execute another flow
within your app and to retrieve the resulting payload. It takes the flow’s name and an input payload
as parameters. For example, `lookup("anotherFlow", payload)` executes a flow named `anotherFlow`.

The function executes the specified flow using the current attributes, variables, and any error, but
it only passes in the payload without any attributes or variables. Similarly, the called flow will
only return its payload.

Note that `lookup` function does not support calling subflows.

#### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>flowName</code></p></td><td><p>A string that identifies the target flow.</p></td></tr><tr><td><p><code>payload</code></p></td><td><p>The payload to send to the target flow, which can be any (<code>Any</code>) type.</p></td></tr><tr><td><p><code>timeoutMillis</code></p></td><td><p>Optional. Timeout (in milliseconds) for the execution of the target flow. Defaults to <code>2000</code> milliseconds (2 seconds) if the thread that is executing is CPU_LIGHT or CPU_INTENSIVE, or 1 minute when executing from other threads. If the lookup takes more time than the specified <code>timeoutMillis</code> value, an error is raised.</p></td></tr></tbody></table>

This example shows XML for two flows. The `lookup` function in `flow1` executes `flow2` and passes
the object `{test:'hello '}` as its payload to `flow2`. The Set Payload component (`<set-payload/>`)
in `flow2` then concatenates the value of `{test:'hello '}` with the string `world` to output and
log `hello world`.

Example: Using the `lookup` Function in Mule 4.1.4 or Later

```XML
<flow name="flow1">
  <http:listener doc:name="Listener" config-ref="HTTP_Listener_config"
    path="/source"/>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
Mule::lookup('flow2', {test:'hello '})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
</flow>
<flow name="flow2" >
  <set-payload value='#[payload.test ++ "world"]' doc:name="Set Payload" />
  <logger level="INFO" doc:name="Logger" message='#[payload]'/>
</flow>
```

Example: Using the `lookup` Function in Mule 4.1.3 and Earlier

```XML
<flow name="flow1">
  <http:listener doc:name="Listener" config-ref="HTTP_Listener_config"
    path="/source"/>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
lookup('flow2', {test:'hello '})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
</flow>
<flow name="flow2" >
  <set-payload value='#[payload.test ++ "world"]' doc:name="Set Payload" />
  <logger level="INFO" doc:name="Logger" message='#[payload]'/>
</flow>
```

Output

```json
hello world
```

> [!WARNING] Always keep in mind that a functional language like DataWeave expects the invocation of
> the `lookup` function to _not_ have side effects. As such, the internal workings of the DataWeave
> engine might cause a `lookup` function to be invoked in parallel with other \`lookup\`s, or not
> invoked it at all.
>
> MuleSoft recommends that you invoke flows with the Flow Ref (`flow-ref`) component, using the
> `target` attribute to put the result of the flow in a `var` and then referencing that `var` from
> within the DataWeave script.

### Matching Errors by Types (causedBy Function)

The `causedBy` function matches an error by its type, like an error handler does. This is useful
when matching by a super type is required but specific sub-type logic is also needed or when
handling a `COMPOSITE_ROUTING` error that contains child errors of different types.

The error to match against can be implicit, but the type is always a required parameter.

In the following example, a global error handler is set up to handle `SECURITY` errors in a general
way, while specific actions are set up for `HTTP:UNAUTHORIZED` and `HTTP:FORBIDDEN` errors.

Example: Error Matcher Function Usage in Mule Runtime Version 4.1.4 and Later

```xml
<error-handler name="securityHandler">
  <on-error-continue type="SECURITY">
    <!-- general error handling for all SECURITY errors -->
    <choice>
      <when expression="#[error Mule::causedBy 'HTTP:UNAUTHORIZED']">
        <!-- specific error handling only for HTTP:UNAUTHORIZED errors -->
      </when>
      <when expression="#[Mule::causedBy('HTTP:FORBIDDEN')]">
        <!-- specific error handling only for HTTP:FORBIDDEN errors -->
      </when>
    </choice>
  </on-error-continue>
</error-handler>
```

Example: Error Matcher Function Usage in Mule Runtime Version 4.1.3 and Earlier

```xml
<error-handler name="securityHandler">
  <on-error-continue type="SECURITY">
    <!-- general error handling for all SECURITY errors -->
    <choice>
      <when expression="#[error causedBy 'HTTP:UNAUTHORIZED']">
        <!-- specific error handling only for HTTP:UNAUTHORIZED errors -->
      </when>
      <when expression="#[causedBy('HTTP:FORBIDDEN')]">
        <!-- specific error handling only for HTTP:FORBIDDEN errors -->
      </when>
    </choice>
  </on-error-continue>
</error-handler>
```

Notice that the error parameter is used both explicitly and implicitly.

## Connector and Component Functions

When using connectors and components in a Mule app, you can inject functions. Unlike the Runtime
functions, these functions require a namespace, which usually matches the component name.

For example, in an app using Batch you can use the following expression:
`#[Batch::isSuccessfulRecord()]`.

## See Also

[DataWeave Core Functions](https://docs.mulesoft.com/dataweave/2.9/dw-functions)

[DataWeave Types](https://docs.mulesoft.com/dataweave/2.9/dataweave-types)

[DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.9/dataweave-selectors)

<!-- document id=e814588be7a0b04b8d9f22665480e214bf40b7c5c474897cf53d6784adc7cad5 url=/mulesoft/current/en-us/dataweave/latest/dataweave-runtime-functions.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: lookup, causedby, p, properties, functions
---

# External Functions Available to DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

In addition to the built-in DataWeave functions, Mule Runtime and some modules, connectors, and Core
components provide functions that you can use in DataWeave scripts. The functions are specific to
the modules, connectors, and components that provide them.

## Mule Runtime Functions

These functions are injected by the Mule Runtime:

- `p`

- `lookup`

- `causedBy`

> [!NOTE] Starting in Mule 4.1.4, DataWeave incorporated the Mule Runtime functions into its Mule
> function module.
>
> MuleSoft recommends that you start using the `Mule` namespace when using these functions in Mule
> apps that are running on Mule Runtime 4.1.4 or later. To use them, you simply prepend the
> namespace to the function name, for example, `Mule::p('http:port')`, instead of `p('http:port')`.
>
> In addition to its continued support for the use of Mule Runtime functions in your DataWeave
> scripts and mappings, the Mule module also enables you to use Mule Runtime functions in your
> [custom DataWeave modules](https://docs.mulesoft.com/dataweave/latest/dataweave-create-module).
>
> Mule apps running on Mule Runtime versions _prior_ to version 4.1.4 cannot use the `Mule`
> namespace or use Mule Runtime functions in custom modules, only in DataWeave scripts and mappings.

For DataWeave runtime properties, see the DataWeave functions [props](https://docs.mulesoft.com/dataweave/latest/dw-runtime-functions-props)
and [prop](https://docs.mulesoft.com/dataweave/latest/dw-runtime-functions-prop).

### Accessing Properties (p Function)

The `p` function provides access to properties, whether these are:

- Mule property placeholders

- System properties

- Environment properties

For more on configuring properties and how they are handled, see
[Configure Properties](https://docs.mulesoft.com/mule-runtime/latest/configuring-properties).

The following example logs the value of the property `http.port`.

Example: Property Function Usage for Mule 4.1.4 and Later

```xml
<flow name="simple">
  <logger level="INFO" doc:name="Logger"
    message="#[Mule::p('http.port')]"/>
</flow>
```

Note that you can also use the function when defining a DataWeave variable or function. This example
uses the `p` function in the `myVar` definition. You can do the same thing with pre-4.1.4 runtimes
simply by omitting the `Mule::` namespace.

```xml
<flow name="simple">
  <logger level="INFO" doc:name="Logger"
    message="#[var myVar = Mule::p('http.port') --- myVar]"/>
</flow>
```

Example: Property Function Usage for Mule 4.1.3 and Earlier

```xml
<flow name="simple">
  <logger message="#[p('http.port')]"/>
</flow>
```

See also, the [p](https://docs.mulesoft.com/dataweave/latest/dw-mule-functions-p) function introduced in the Mule function module in Mule 4.2.

### Execute a Flow (lookup Function)

Similar to the Flow Reference component, the `lookup` function enables you to execute another flow
within your app and to retrieve the resulting payload. It takes the flow’s name and an input payload
as parameters. For example, `lookup("anotherFlow", payload)` executes a flow named `anotherFlow`.

The function executes the specified flow using the current attributes, variables, and any error, but
it only passes in the payload without any attributes or variables. Similarly, the called flow will
only return its payload.

Note that `lookup` function does not support calling subflows.

#### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>flowName</code></p></td><td><p>A string that identifies the target flow.</p></td></tr><tr><td><p><code>payload</code></p></td><td><p>The payload to send to the target flow, which can be any (<code>Any</code>) type.</p></td></tr><tr><td><p><code>timeoutMillis</code></p></td><td><p>Optional. Timeout (in milliseconds) for the execution of the target flow. Defaults to <code>2000</code> milliseconds (2 seconds) if the thread that is executing is CPU_LIGHT or CPU_INTENSIVE, or 1 minute when executing from other threads. If the lookup takes more time than the specified <code>timeoutMillis</code> value, an error is raised.</p></td></tr></tbody></table>

This example shows XML for two flows. The `lookup` function in `flow1` executes `flow2` and passes
the object `{test:'hello '}` as its payload to `flow2`. The Set Payload component (`<set-payload/>`)
in `flow2` then concatenates the value of `{test:'hello '}` with the string `world` to output and
log `hello world`.

Example: Using the `lookup` Function in Mule 4.1.4 or Later

```XML
<flow name="flow1">
  <http:listener doc:name="Listener" config-ref="HTTP_Listener_config"
    path="/source"/>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
Mule::lookup('flow2', {test:'hello '})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
</flow>
<flow name="flow2" >
  <set-payload value='#[payload.test ++ "world"]' doc:name="Set Payload" />
  <logger level="INFO" doc:name="Logger" message='#[payload]'/>
</flow>
```

Example: Using the `lookup` Function in Mule 4.1.3 and Earlier

```XML
<flow name="flow1">
  <http:listener doc:name="Listener" config-ref="HTTP_Listener_config"
    path="/source"/>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
lookup('flow2', {test:'hello '})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
</flow>
<flow name="flow2" >
  <set-payload value='#[payload.test ++ "world"]' doc:name="Set Payload" />
  <logger level="INFO" doc:name="Logger" message='#[payload]'/>
</flow>
```

Output

```json
hello world
```

> [!WARNING] Always keep in mind that a functional language like DataWeave expects the invocation of
> the `lookup` function to _not_ have side effects. As such, the internal workings of the DataWeave
> engine might cause a `lookup` function to be invoked in parallel with other \`lookup\`s, or not
> invoked it at all.
>
> MuleSoft recommends that you invoke flows with the Flow Ref (`flow-ref`) component, using the
> `target` attribute to put the result of the flow in a `var` and then referencing that `var` from
> within the DataWeave script.

### Matching Errors by Types (causedBy Function)

The `causedBy` function matches an error by its type, like an error handler does. This is useful
when matching by a super type is required but specific sub-type logic is also needed or when
handling a `COMPOSITE_ROUTING` error that contains child errors of different types.

The error to match against can be implicit, but the type is always a required parameter.

In the following example, a global error handler is set up to handle `SECURITY` errors in a general
way, while specific actions are set up for `HTTP:UNAUTHORIZED` and `HTTP:FORBIDDEN` errors.

Example: Error Matcher Function Usage in Mule Runtime Version 4.1.4 and Later

```xml
<error-handler name="securityHandler">
  <on-error-continue type="SECURITY">
    <!-- general error handling for all SECURITY errors -->
    <choice>
      <when expression="#[error Mule::causedBy 'HTTP:UNAUTHORIZED']">
        <!-- specific error handling only for HTTP:UNAUTHORIZED errors -->
      </when>
      <when expression="#[Mule::causedBy('HTTP:FORBIDDEN')]">
        <!-- specific error handling only for HTTP:FORBIDDEN errors -->
      </when>
    </choice>
  </on-error-continue>
</error-handler>
```

Example: Error Matcher Function Usage in Mule Runtime Version 4.1.3 and Earlier

```xml
<error-handler name="securityHandler">
  <on-error-continue type="SECURITY">
    <!-- general error handling for all SECURITY errors -->
    <choice>
      <when expression="#[error causedBy 'HTTP:UNAUTHORIZED']">
        <!-- specific error handling only for HTTP:UNAUTHORIZED errors -->
      </when>
      <when expression="#[causedBy('HTTP:FORBIDDEN')]">
        <!-- specific error handling only for HTTP:FORBIDDEN errors -->
      </when>
    </choice>
  </on-error-continue>
</error-handler>
```

Notice that the error parameter is used both explicitly and implicitly.

## Connector and Component Functions

When using connectors and components in a Mule app, you can inject functions. Unlike the Runtime
functions, these functions require a namespace, which usually matches the component name.

For example, in an app using Batch you can use the following expression:
`#[Batch::isSuccessfulRecord()]`.

## See Also

[DataWeave Core Functions](https://docs.mulesoft.com/dataweave/latest/dw-functions)

[DataWeave Types](https://docs.mulesoft.com/dataweave/latest/dataweave-types)

[DataWeave Selectors](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors)

<!-- document id=2d98b86d06e037bfafbc028ea88a76e3c7e100f4eb7ecbf42ff08376f3361582 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook-extract-data.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, transform, transformer, metadata, dataweave, data weave, datawave, datamapper, dwl, dfl, dw, payload, attribute, variable, flow, error, message
---

# Extract Data

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave can select data from DataWeave objects and arrays, variables that store that data, and the
output of DataWeave functions when that output is an array or object.

More precisely, a DataWeave selector operates within a context, which can be a reference to the
variable that stores the data, an object literal, an array literal, or the invocation of a DataWeave
function. You can use selectors in Mule modules, connectors, and components that accept DataWeave
expressions.

When DataWeave processes a selector, it sets a new context (or scope) for subsequent selectors, so
you can navigate through the complex structures of arrays and objects using chains of selectors. The
depth of the selection is limited only by the depth of the current context.

Supported variable references are [Mule Runtime variables](https://docs.mulesoft.com/dataweave/2.11/dataweave-variables-context), such as
`payload` and `attributes`, and [DataWeave variables](https://docs.mulesoft.com/dataweave/2.11/dataweave-variables) that store arrays or
objects. A simple example is `payload.myKey` where the payload is the object `{"myKey" : 1234 }`, so
the result is `1234`.

A selector can act on the invocation of a function, such as the DataWeave `read` function. For
example, `read('{"A":"B"}','application/json')."A"` returns `"B"`.

## Use Selectors on DataWeave Arrays and Objects

In DataWeave, selectors extract values from within a DataWeave object (such as
`{ myKey : "myValue" }`) or array (such as `[1,2,3,4]` or
`[ { "myKey" : "1234" }, { "name" : "somebody" } ]`).

The following DataWeave script uses the single-value selector (`.`) to retrieve values from the
object and array defined by the variables `myObject` and `myArray`.

DataWeave Script:

```dataweave
%dw 2.0
var myObject = { "myKey" : "1234", "name" : "somebody" }
var myArray = [ { "myKey" : "1234" }, { "name" : "somebody" } ]
output application/json
---
{
    selectingValueUsingKeyInObject : myObject.name,
    selectingValueUsingKeyOfObjectInArray : myArray.name,
}
```

Output JSON:

```json
{
  "selectingValueUsingKeyInObject": "somebody",
  "selectingValueUsingKeyOfObjectInArray": ["somebody"]
}
```

As the Output shows:

- `myObject.name` returns the value `"somebody"`

- `myArray.name` returns the array `[ "somebody" ]`

## Selector Quick Reference

Single Value (`.`)

Acts on arrays and objects to return the value of a matching key. The syntax is `.myKey`. To
retrieve values of duplicate keys in a DataWeave _object_, use `*`, instead. For examples, see
[Single-Value Selector (.myKey)](#single_value).

Multiple Values (`*`)

Acts on arrays and objects to retrieve the values of all matching keys at a single level in the
hierarchy of a data structure. The syntax is `*myKey`. For the values of all duplicate keys at lower
levels in the hierarchy, use the descendants selector (`..`), instead. For examples, see
[Multi-Value Selector (`.*`)](#multi_value).

Key-Value Pair (`&`)

Acts on arrays and objects. Instead of returning the value of the DataWeave object, this selector
returns the entire DataWeave object, both key and value. The syntax is `.&myKey`. For examples, see
[Key-Value Pair Selector (`.&myKey`)](#key_value).

Descendants (`..`)

Acts on arrays and objects to retrieve all matching keys from arrays and objects below the given
key, regardless of their location in the hierarchy. The syntax is `..myKey` For examples, see
[Descendants Selector (`..myKey`)](#descendants).

Index (`[]`)

Returns the value at the specified index of an array. An example is the `[0]` at the end of
`["a","b","c"][0]`, which returns `"a"`. For examples, see [Index Selector (`[anIndex]`)](#index).

Range `[index1 to index2]`

Returns an array with values of the selected indices. An example is the `[2 to 3]` at the end of
`["a","b","c","d"][2 to 3]`, which returns `["c","d"]`. For examples, see
[Range selector (`anIndex to anotherIndex`)](#range).

XML attribute (`.@myKey`)

Returns the value of a selected key for an XML attribute. For an example, see
[XML Attribute Selector (`.@myKey`)](#xml_attribute).

Namespace Selector (`myKey.#`)

Returns the `xmlns` namespace from the element that also contains the selected key. For an example,
see [Namespace Selector (`#`)](#namespace).

Selector Modifiers (`?` and `!`)

`?` and `!` check for the specified key. `?` returns `true` or `false`. `!` returns an error if the
key is not present. For examples, see [Selector Modifiers (`!`, `?`)](#selector_modifiers).

Filter Selectors (`myKey[?(booleanExpression)]`)

Returns the selected items if the Boolean expression returns `true` and the specified `key` is
present. It returns `null` if the expression is false or the key is not present. For examples, see
[Filter Selectors (`myKey[?($ == "aValue")]`)](#filter_selectors).

Metadata Selector `.^someMetadata`

Returns the value of specified metadata for a Mule payload, variable, or attribute. The selector can
return the value of class (`.^class`), content length (`.^contentLength`), encoding (`.^encoding`),
MIME type (`.^mimeType`), media type (`.^mediaType`), raw (`.^raw`), and custom
(`.^myCustomMetadata`) metadata. For details, see
[Metadata Selector (.^someMetadata)](#metadata_selector).

## Key and Selector Syntax

In DataWeave, quotes around the name of an object’s key are required in some cases but optional in
others. Though a key is not an identifier, if the key name meets the criteria of a
[valid identifier name](https://docs.mulesoft.com/dataweave/2.11/dataweave-language-introduction#valid-identifiers), quotes around the key
are optional. If the key does not meet this criteria, you _must_ surround the key in quotes. For
example, to correct the key syntax in `{ some-name : "somebody" }`, you can use
`{ "some-name" : "somebody" }` or `{ 'some-name' : "somebody" }`. Without quotes, the key in
`{ some-name : "somebody" }` produces the error `Invalid input '-', expected Namespace`.

If you are using a selector on a key that requires quotes, you must also surround the selector in
quotes. For example, the selector `"some-name"` in `{ "some-name" : "somebody" }."some-name"` works,
but the selector `some-name` in `{ "some-name" : "somebody" }.some-name` produces the error
`Unable to resolve reference of: name` because the selector is not surrounded in quotes.

Quotes around a selector are optional if you are using a selector on a key that does not require the
quotes. For example, all of these examples work:

- `{"name" : "somebody"}.name`

- `{"name" : "somebody"}."name"`

- `{name : "somebody"}.name`

- `{name : "somebody"}."name"`

## Single-Value Selector (.myKey)

`.myKey` selectors work over an object or array to return the value of a matching key.

### Single-Value Selector Over an Object

For an object, the single-value selector returns the value of the matching key. For example, in the
following script, `myObject.user` returns `"a"`.

DataWeave Script:

```dataweave
%dw 2.0
var myObject = { user : "a" }
output application/json
---
{ myObjectExample : myObject.user }
```

Output JSON:

```json
{
  "myObjectExample": "a"
}
```

When operating on a DataWeave _object_ (not an array), the `.` selector only returns the value of
the _first_ matching key, even if the object contains multiple matching keys, for example:

DataWeave Script:

```dataweave
%dw 2.0
var myObject = { user : "a", "user" : "b" }
output application/json
---
{ myObjectExample : myObject.user }
```

Output JSON:

```json
{
  "myObjectExample": "a"
}
```

To return the values of multiple matching keys in cases like this, see
[Multi-Value Selector (`.*`)](#multi_value).

In the next example, `payload.people.person.address` returns the value of the `address` element. (It
also uses the `output` directive to transform the JSON input to XML.)

DataWeave Script:

```dataweave
%dw 2.0
var myData = {
  "people": {
    "size" : 1,
    "person": {
      "name": "Nial",
      "address": {
        "street": {
          "name": "Italia",
          "number": 2164
        },
        "area": {
          "zone": "San Isidro",
          "name": "Martinez"
        }
      }
    }
  }
}
output application/xml
---
{ myaddresses: myData.people.person.address }
```

Output XML:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<myaddresses>
  <street>
    <name>Italia</name>
    <number>2164</number>
  </street>
  <area>
    <zone>San Isidro</zone>
    <name>Martinez</name>
  </area>
</myaddresses>
```

## Single-Value Selector Over an Array

When acting on an array, the `.` selector returns an array, even if there is only one matching
value. For example, `["a":"b"]."a"` returns `["b"]`.

Note that the `.` selector acts differently on arrays than it acts on objects. Like `.*`, the `.`
selector returns an array with the values of _all matching keys_ at the specified level of the input
array.

DataWeave Script:

```dataweave
%dw 2.0
var myArrayOfKeyValuePairs = [ "aString": "hello", "aNum": 2, "aString" : "world" ]
var myArrayOfObjects = [ { "aString": "hello" }, { "aNum": 2 }, { "aString" : "world" } ]
output application/json
---
{
    myKeyValueExample : myArrayOfKeyValuePairs.aString,
    myObjectExample :  myArrayOfObjects.aString
}
```

Output JSON:

```json
{
  "myKeyValueExample": ["hello", "world"],
  "myObjectExample": ["hello", "world"]
}
```

In the following example, the value of the input variable, `myData`, is an array that contains two
objects. The selector navigates both objects and returns the values of both `street` keys.

DataWeave Script:

```dataweave
%dw 2.0
var myData = {
  "people": [
    {
      "person": {
        "name": "Nial",
        "address": {
          "street": {
            "name": "Italia",
            "number": 2164
          },
          "area": {
            "zone": "San Isidro",
            "name": "Martinez"
          }
        }
      }
    },
    {
      "person": {
        "name": "Coty",
        "address": {
          "street": {
            "name": "Monroe",
            "number": 323
          },
          "area": {
            "zone": "BA",
            "name": "Belgrano"
          }
        }
      }
    }
  ]
}
output application/json
---
myData.people.person.address.street
```

Output JSON:

```json
[
  {
    "name": "Italia",
    "number": 2164
  },
  {
    "name": "Monroe",
    "number": 323
  }
]
```

## Multi-Value Selector (`.*`)

`.*` traverses objects and arrays to select the values of all matching keys and returns matching
results in an array.

### Multi-Value Selector Over an Object

`.*` returns an array with all the values whose key matches the expression.

The following example returns the values of all `user` elements from the input payload.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
payload.users.*user
```

Input XML Payload:

```xml
<users>
  <user>Mariano</user>
  <user>Martin</user>
  <user>Leandro</user>
</users>
```

Output JSON:

```json
["Mariano", "Martin", "Leandro"]
```

### Multi-Value Selector Over an Array

On arrays, `.*` works the same way as the single-value selector (`.`). For example,
`payload.people.person.address.*street` and the example `payload.people.person.address.street` (from
[Single-Value Selector Over an Array](#single_value_array)) return the same results.

DataWeave Script:

```dataweave
%dw 2.0
var myArrayOfKeyValuePairs = [ "aString": "hello", "aNum": 2, "aString" : "world" ]
var myArrayOfObjects = [ { "aString": "hello" }, { "aNum": 2 }, { "aString" : "world" } ]
output application/json
---
{
    myKeyValueExample : myArrayOfKeyValuePairs.*aString,
    myObjectExample :  myArrayOfObjects.*aString
}
```

Output JSON:

```json
{
  "myKeyValueExample": ["hello", "world"],
  "myObjectExample": ["hello", "world"]
}
```

## Descendants Selector (`..myKey`)

The `..` selector acts on arrays and objects.

This selector applies to the context using the form `..myKey`, and it retrieves the values of all
matching key-value pairs in the sub-tree under the selected context. Regardless of the hierarchical
structure of the fields, the output is returned at the same level.

In this example, all of the fields that match the key `name` are placed in a list called `names`
regardless of their cardinality in the tree of the input data.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{ names: payload.people..name }
```

Input JSON Payload:

```json
{
  "people": {
    "person": {
      "name": "Nial",
      "address": {
        "street": {
          "name": "Italia",
          "number": 2164
        },
        "area": {
          "zone": "San Isidro",
          "name": "Martinez"
        }
      }
    }
  }
}
```

Output JSON:

```json
{
  "names": ["Nial", "Italia", "Martinez"]
}
```

## Key-Value Pair Selector (`.&myKey`)

The `&` selector acts on arrays and objects. `&` retrieves both the keys and values of all matching
keys pairs in the current context. These are returned as an object, containing the retrieved keys
and values.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
{
  users: payload.users.&user
}
```

Input XML Payload:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<users>
  <user>Mariano</user>
  <user>Martin</user>
  <user>Leandro</user>
  <admin>Admin</admin>
  <admin>org_owner</admin>
</users>
```

Output XML:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<users>
  <user>Mariano</user>
  <user>Martin</user>
  <user>Leandro</user>
</users>
```

Note that unlike the multi-value selector, the output of this selector is an object, where the
original keys for each value are also extracted.

### Select All the Descendant Key-Value Pairs

This example uses the `..` and `&` selectors in `myVar.people..&name` to select and return an array
that contains all descendant objects from `myData` input that contain the key `name`. It also
transforms the JSON input to XML output.

DataWeave Script:

```dataweave
%dw 2.0
var myData = {
  "people": {
    "person": {
      "name": "Nial",
      "address": {
        "street": {
          "name": "Italia",
          "number": 2164
        },
        "area": {
          "zone": "San Isidro",
          "name": "Martinez"
        }
      }
    }
  }
}
output application/xml
---
names: {(myData.people..&name)}
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<names>
  <name>Nial</name>
  <name>Italia</name>
  <name>Martinez</name>
</names>
```

## Index Selector (`[anIndex]`)

The index selector returns the element at the specified position. It can be applied over an array,
object, or string.

### Index Selector Over an Array

This selector can be applied to String literals, Arrays and Objects. In the case of Objects, the
value of the key-value pair found at the index is returned. In the case of Arrays, the value of the
element is returned. The index is zero-based.

1.  If the index is bigger or equal to 0, it starts counting from the beginning.

2.  If the index is negative, it starts counting from the end where -1 is the last element.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
payload.people[1]
```

Input JSON Payload:

```json
{
  "people": [
    {
      "nameFirst": "Nial",
      "nameLast": "Martinez"
    },
    {
      "nameFirst": "Coty",
      "nameLast": "Belgrano"
    }
  ]
}
```

Output JSON:

```json
{
  "nameFirst": "Coty",
  "nameLast": "Belgrano"
}
```

### Index Selector Over an Object

The selector returns the value of the key-value pair at the specified position.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
payload[1]
```

Input JSON Payload:

```json
{
  "nameFirst": "Mark",
  "nameLast": "Nguyen"
}
```

Output JSON:

```json
"Nguyen"
```

### Index Selector Over a String

When using the Index Selector with a string, the string is broken down into an array, where each
character is an index.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{ name: "MuleSoft"[0] }
```

Output JSON:

```json
{ "name": "M" }
```

The selector picks the character at a given position, treating the string as an array of characters.

1.  If the index is bigger or equal to 0, it starts counting from the beginning.

2.  If the index is negative, it starts counting from the end.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{ name: "Emiliano"[0] }
```

Output JSON:

```json
{ "name": "E" }
```

## Range selector (`anIndex to anotherIndex`)

The `to` selector returns values of matching indices in an array or string. You can also use it to
reverse the order of the indices in the range. The selector treats characters in the string as
indices.

- Selecting an index from an array:

  - `[1,2,3,4][0]` returns `1`

    The index of the first element in an array is always `0`.

  - `[1,2,3,4][3]` returns `4`

### Range Selector Over an Array

Range selectors limit the output to only the elements specified by the range on that specific order.
This selector allows you to slice an array or even invert it.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
  slice: [0,1,2][0 to 1],
  last: [0,1,2][-1 to 0]
}
```

Output JSON:

```json
{
  "slice": [0, 1],
  "last": [2, 1, 0]
}
```

### Range Selector Over a String

The Range selector limits the output to only the elements specified by the range on that specific
order, treating the string as an array of characters. This selector enables you to slice a string or
invert it.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
  slice: "DataWeave"[0 to 1],
  middle : "superfragilisticexpialadocious"[10 to 13],
  last: "DataWeave"[-1 to 0]
}
```

Output JSON:

```json
{
  "slice": "Da",
  "middle": "list",
  "last": "evaeWataD"
}
```

## XML Attribute Selector (`.@myKey`)

`.@myKey` selects an attribute in an XML element.

Using `.@` without the key name returns an object containing the attributes as key-value pairs.

This DataWeave example reads an XML sample into a variable and uses `@` to select attributes from
the XML.

DataWeave Script:

```dataweave
%dw 2.0
var myVar = read('<product id="1" type="electronic">
  <brand>SomeBrand</brand>
</product>', 'application/xml')
output application/json
---
{
  item: [
  	{
      "type" : myVar.product.@."type",
      "name" : myVar.product.brand,
      "attributes": myVar.product.@
    }
  ]
}
```

Output JSON:

```json
{
  "item": [
    {
      "type": "electronic",
      "name": "SomeBrand",
      "attributes": {
        "id": "1",
        "type": "electronic"
      }
    }
  ]
}
```

## Namespace Selector (`#`)

`#` returns the XML namespace of a selected key as plain text.

DataWeave Script:

```dataweave
%dw 2.0
output text/plain
---
payload.order.#
```

Input XML Payload:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<ns0:order xmlns:ns0="http://orders.company.com">
  <name>Mark</name>
  <items>42</items>
  <orderdate>2017-01-04</orderdate>
</ns0:order>
```

Output Text:

```json
"http://orders.company.com"
```

## Selector Modifiers (`!`, `?`)

You can check for the presence of a given key.

- `!` evaluates the selection and fails with an exception message if the key is not present.

- `?` returns `true` if the selected key is present, `false` if not. Note that `?` is also used in
  [Filter Selectors (`myKey[?($ == "aValue")]`)](#filter_selectors).

### Assert Present Validator

`!` returns an error if any of the specified key is missing.

- `{ "name": "Annie" }.lastName!` returns an error with the message,
  `There is no key named 'lastName'`.

- Without the `!`, `{ "name": "Annie" }.lastName` returns `null`.

- When the key is present, `{ "name": "Annie" }.name!` the result is `"Annie"`.

### Key Present Validator

Returns `true` if the specified key is present in the object or as an attribute of an XML element.

This example returns `true` because the `name` key does exists.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
present: payload.name?
```

Input JSON Payload:

```json
{ "name": "Annie" }
```

Output XML:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<present>true</present>
```

`?` also works with XML attributes:

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
  item: {
    typePresent : payload.product.@."type"?
  }
}
```

Input XML Payload:

```xml
<product id="1" type="tv">
  <brand>Samsung</brand>
</product>
```

Output JSON:

```json
{
  "item": { "typePresent": true }
}
```

## Filter Selectors (`myKey[?($ == "aValue")]`)

`myKey[?($ == "aValue")]` returns only the values of matching keys within an array or object. Note
that `?` is also used in [Key Present Validator](#key_present). If no key-value pairs match, the
result is `null`.

The following example inputs the array of `name` keys returned by `*.name`, then checks for `name`
keys with the value `"Mariano"`. It filters out any values that do not match. Note that the `$`
references the value of the selected key.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{ users: payload.users.*name[?($ == "Mariano")] }
```

Input XML Payload:

```xml
<users>
  <name>Mariano</name>
  <name>Luis</name>
  <name>Mariano</name>
</users>
```

Output JSON:

```json
{
  "users": ["Mariano", "Mariano"]
}
```

The following example assumes the same [input](#input_filter_selectors) and returns all the
key-value pairs of the input because the expression `( 1 == 1 )` is true. Note that a false
expression, such as `( 1 == 2 )`, returns `null`.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{ users: payload.users.*name[?( 1 == 1)] }
```

Input XML Payload:

```xml
<users>
  <name>Mariano</name>
  <name>Luis</name>
  <name>Mariano</name>
</users>
```

Output JSON:

```json
{
  "users": ["Mariano", "Luis", "Mariano"]
}
```

The following example assumes the same [input](#input_filter_selectors). It uses `mapObject` to
iterate over the entire input object and return matching key-value pairs, filtering out any pairs
that do not match.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
payload mapObject { ($$) : $[?($=="Mariano")] }
```

Input XML Payload:

```xml
<users>
  <name>Mariano</name>
  <name>Luis</name>
  <name>Mariano</name>
</users>
```

Output JSON:

```json
{
  "users": {
    "name": "Mariano",
    "name": "Mariano"
  }
}
```

## Metadata Selector (.^someMetadata)

Returns the value of specified metadata for a Mule payload, variable, or attribute. The selector can
return the following metadata:

- Content length metadata: `.^contentLength` returns the content length of the value, if the value
  is present. For an example, see
  [Content Length Metadata Selector (.^contentLength)](#caret_contentlength).

- Class metadata: `.^class` returns the class of the Plain Old Java Object (POJO). For example,
  `{ "string" : payload.string.^class }` might return `{ "string": "java.lang.String" }` if the
  input payload defines a Java string, such as `simplePojo.string = "myString"`, in a simple POJO,
  and `{ "date" : payload.date.^class }` might return `{ "date": "java.util.Date" }`. For an
  example, see [Class Metadata Selector (.^class)](#caret_class).

- Encoding metadata: `.^encoding` returns the encoding of a value. For example,
  `{ "myEncoding" : payload.^encoding }` might return `{"myEncoding": "UTF-8"}` for an input POJO.
  For an example, see [Encoding Metadata Selector (.^encoding)](#caret_encoding).

- Media Type Selector: `.^mediaType` returns the MIME type of a value that includes parameters, for
  example, `application/json;charset=UTF-16`, and the expression in the value of
  `{ "myMediaType" : payload.^mediaType }` might return `"myMediaType": "**/**; charset=UTF-8"` for
  an input POJO. For an example, see [Media Type Metadata Selector (.^mediaType)](#caret_mediatype).

- MIME Type metadata: `.^mimeType` returns the MIME type (without parameters) of a value, for
  example, `application/json`, and `{ "myMimeType" : payload.^mimeType }` might return
  `{ "myMediaType": "**/**" }` for an input POJO. For an example, see
  [MIME Type Metadata Selector (.^mimeType)](#caret_mimetype).

- Raw metadata: `.^raw` returns the underlying data (typically, a binary value) of a plain old Java
  object (POJO). This selector is sometimes used when calculating an MD5 for hashes when checking
  for man-in-the-middle attacks. For examples, see [Raw Metadata Selector (.^raw)](#caret_raw).

- Custom metadata: `.^myCustomMetadata` returns the value of custom metadata. For examples, see
  [Custom Metadata Selector (.^myCustomMetadata)](#caret_custom_metadata).

### Content Length Metadata Selector (.^contentLength)

Returns the content length of the value, if the value is present.

In the following Mule app flow, the Logger uses `payload.^contentLength` to select the length of the
string `my string`, set in the Set Payload (`set-payload`) component.

Mule App XML in Anypoint Studio:

```XML
<flow name="setpayloadobjectFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="15" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <!-- Set the payload to "my string". -->
  <set-payload value='"my string"' doc:name="Set Payload" />
  <!-- Select the class to which "my string" belongs. -->
  <logger level="INFO" doc:name="Logger" message="#[payload.^contentLength]"/>
</flow>
```

The Studio console output shows that the length of the input string (`my string`) is eleven (`9`)
characters long. The length includes the blank space in the string.

Console Output in Anypoint Studio:

```txt
INFO  2019-05-07 16:59:33,690 [[MuleRuntime].cpuLight.07:
 [carets].caretsFlow.CPU_LITE @39f1dbde]
 [event: 28ce97a0-7124-11e9-acfe-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 11
```

### Class Metadata Selector (.^class)

Returns the class of the Plain Old Java Object (POJO). The value might result from calling a method
in a Java class or have a data type (such as `String` or `DateTime`) that DataWeave treats as a Java
value, for example:

- `{ "string" : payload.mystring.^class }` might return `{ "mystring": "java.lang.String" }` if the
  input payload defines a Java string, such as `simplePojo.string = "myString"`, in a simple POJO.

- `{ "mydate" : payload.mydate.^class }` might return `{ "mydate": "java.util.Date" }`.

In the following Mule app flow, the Logger uses `payload.^class` to select the Java class of
`"my string"`, set in the Set Payload (`set-payload`) component.

Mule App XML in Anypoint Studio:

```XML
<flow name="setpayloadobjectFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="15" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <!-- Set the payload to "my string". -->
  <set-payload value='"my string"' doc:name="Set Payload" />
  <!-- Select the class to which "my string" belongs. -->
  <logger level="INFO" doc:name="Logger" message="#[payload.^class]"/>
</flow>
```

The Studio console output shows that the payload string belongs to the class `java.lang.String`.

Console Output in Anypoint Studio:

```txt
INFO  2019-04-20 16:10:03,075 [[MuleRuntime].cpuLight.08:
 [setpayloadobject].setpayloadobjectFlow.CPU_LITE @6447187e]
 [event: 6da29400-63c1-11e9-98e0-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 java.lang.String
```

### Encoding Metadata Selector (.^encoding)

Returns the encoding of a value. For example, `{ "myEncoding" : payload.^encoding }` might return
`{"myEncoding": "UTF-8"}` for an input POJO.

In the following Mule app flow, the Logger uses `payload.^encoding` to select the encoding of
``"my string"`set in the Set Payload (`set-payload``) component. The Scheduler (`scheduler`)
component is simply an event source that regularly generates a new Mule event to hold the payload
set in Set Payload.

Mule App XML in Anypoint Studio:

```XML
<flow name="setpayloadobjectFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="15" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <!-- Set the payload to "my string". -->
  <set-payload value='"my string"' doc:name="Set Payload" />
  <!-- Select the encoding of "my string". -->
  <logger level="INFO" doc:name="Logger" message="#[payload.^encoding]"/>
</flow>
```

The Studio console output shows that the payload string has `UTF-8` encoding.

Console Output in Anypoint Studio:

```txt
INFO  2019-04-20 16:14:24,222 [[MuleRuntime].cpuLight.03:
 [setpayloadobject].setpayloadobjectFlow.CPU_LITE @62bea6a6]
 [event: 0938bf70-63c2-11e9-98e0-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 UTF-8
```

### Media Type Metadata Selector (.^mediaType)

Returns the MIME type of a value that includes parameters (for example,
`application/json;charset=UTF-16`). The expression in the value of
`{ "myMediaType" : payload.^mediaType }` might return `"myMediaType": "**/**; charset=UTF-8"` for an
input POJO.

In the following Mule app flow, the Logger uses `payload.^mediaType` to select the media type of
`2014-10-12T11:11:19-00:03` set in the Set Payload (`set-payload`) component.

Mule App XML in Anypoint Studio:

```XML
<flow name="setpayloadobjectFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="15" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <set-payload value='#[|2014-10-12T11:11:19-00:03| as DateTime]' doc:name="Set Payload" />
  <logger level="INFO" doc:name="Logger" message="#[payload.^mediaType]"/>
</flow>
```

The Studio console output shows that the `DateTime` payload has the
`application/java; charset=UTF-8` media type.

Console Output in Anypoint Studio:

INFO 2019-04-20 16:41:01,276 \[\[MuleRuntime\].cpuLight.04:
\[setpayloadobject\].setpayloadobjectFlow.CPU\_LITE @7e991c71\] \[event:
c0e96860-63c5-11e9-bcff-8c8590a99d48\]
rg.mule.runtime.core.internal.processor.LoggerMessageProcessor: application/java; charset=UTF-8

In the following Mule app flow, the Loggers use `payload.^mediaType` to select a string
`"my string"`, then to select a string that is set within an **fx** expression
(`#["my string as String type" as String]`) in the Set Payload (`set-payload`) component.

Mule App XML in Anypoint Studio:

```XML
<flow name="setpayloadobjectFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="15" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <!-- Set the payload to "my string". -->
  <set-payload value='"my string"' doc:name="Set Payload" />
  <!-- Select the media type of "my string". -->
  <logger level="INFO" doc:name="Logger" message='#[payload.^mediaType]'/>
  <!-- Set the payload using the fx expression "my string" as String. -->
  <set-payload value='#["my string as String type" as String]' doc:name="Set Payload" />
  <!-- Select the media type of a Java string. -->
  <logger level="INFO" doc:name="Logger" message='#[payload.^mediaType]'/>
</flow>
```

The Studio console output shows that the simple string has the media type `**/**`, while the string
that is set in the **fx** expression has the media type `application/java; charset=UTF-8`.

Console Output in Anypoint Studio:

```txt
INFO  2019-04-20 16:52:50,801 [[MuleRuntime].cpuLight.01:
 [setpayloadobject].setpayloadobjectFlow.CPU_LITE @5d914abe]
 [event: 68121cd0-63c7-11e9-bcff-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 */*

INFO  2019-04-20 16:52:51,085 [[MuleRuntime].cpuLight.01:
 [setpayloadobject].setpayloadobjectFlow.CPU_LITE @5d914abe]
 [event: 68121cd0-63c7-11e9-bcff-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 application/java; charset=UTF-8
```

### MIME Type Metadata Selector (.^mimeType)

Returns the MIME type (without parameters) of a value, for example, `application/json`, and
`{ "myMimeType" : payload.^mimeType }` might return `{ "myMediaType": "**/**" }` for an input POJO.

In the following Mule app flow, the Loggers use `payload.^mimeType` to select a string
`"my string"`, then to select a string that is set within an **fx** expression
(`#["my string as String type" as String]`) in the Set Payload (`set-payload`) component.

Mule App XML in Anypoint Studio:

```XML
<flow name="setpayloadobjectFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="15" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <!-- Set the payload to "my string". -->
  <set-payload value='"my string"' doc:name="Set Payload" />
  <!-- Select the MIME type of "my string". -->
  <logger level="INFO" doc:name="Logger" message='#[payload.^mimeType]'/>
  <!-- Set the payload using the fx expression "my string" as String. -->
  <set-payload value='#["my string as String type" as String]' doc:name="Set Payload" />
  <!-- Select the MIME type of a Java string. -->
  <logger level="INFO" doc:name="Logger" message='#[payload.^mimeType]'/>
</flow>
```

The Studio console output shows that the simple string has the MIME type `**/**`, while the string
that is set in the **fx** expression has the MIME type `application/java`.

Console Output in Anypoint Studio:

```txt
INFO  2019-04-20 17:02:07,762 [[MuleRuntime].cpuLight.06:
 [setpayloadobject].setpayloadobjectFlow.CPU_LITE @2d6f64b9]
 [event: b4097b00-63c8-11e9-bcff-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 */*

INFO  2019-04-20 17:02:08,029 [[MuleRuntime].cpuLight.06:
 [setpayloadobject].setpayloadobjectFlow.CPU_LITE @2d6f64b9]
 [event: b4097b00-63c8-11e9-bcff-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 application/java
```

### Raw Metadata Selector (.^raw)

Returns the underlying binary value of a POJO. This selector is sometimes used when calculating an
MD5 or some other cryptographic hash function to check for man-in-the-middle (MITM) attacks.

The following example uses the Set Payload component (`set-payload`) to produce a binary value, then
uses the Transform Message component (`ee:transform`) component to return raw data for the MD5
(`MD5(payload.^raw)`) of the binary value. The Logger component (`logger`) is also set to write the
raw data to the Studio console. For comparison, the second Logger returns the typical `payload` in a
standard JSON format.

Mule App XML in Anypoint Studio:

```XML
<flow name="rawcaret2Flow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="30" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <set-payload value='#["1234-5678-9123" as Binary]' doc:name="Set Payload" />
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
import * from dw::Crypto
output application/json
---
{ "myRawData" : MD5(payload.^raw) }]]></ee:set-payload>
    </ee:message>
  </ee:transform>
  <logger level="INFO" doc:name="Logger" message="#[payload.^raw]"/>
  <logger level="INFO" doc:name="Logger" message="#[payload]"/>
</flow>
```

Notice that instead of producing standard JSON output, the raw output in the Logger message
surrounds the entire payload in double-quotes and inserts new line characters (`\n`) for each new
line.

Console Output in Anypoint Studio:

```txt
INFO  2019-04-22 14:10:14,537 [[MuleRuntime].cpuLight.08:
 [rawcaret2].rawcaret2Flow.CPU_LITE @764a5a61]
 [event: 058f6a90-6543-11e9-9d99-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 "{\n  "myRawData": "5403e5a202c594871d59898b13054be5"\n}"

INFO  2019-04-22 14:10:14,540 [[MuleRuntime].cpuLight.08:
 [rawcaret2].rawcaret2Flow.CPU_LITE @764a5a61]
 [event: 058f6a90-6543-11e9-9d99-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 { "myRawData": "5403e5a202c594871d59898b13054be5" }
```

The following example uses the HTTP Listener source (`listener`) to get the XML payload received via
a POST request, then uses the Transform Message component (`ee:transform`) to get the encoding value
of the XML payload, by returning the raw data
(`(payload.^raw as String) scan /encoding='([A-z0-9-]+)'/)`). The Logger component (`logger`)
returns the `payload` in a JAVA format.

Mule App XML in Anypoint Studio:

```XML
<http:listener-config name="HTTP_Listener_config" >
    <http:listener-connection host="0.0.0.0" port="8081" />
</http:listener-config>
<flow name="test-flow">
	<http:listener path="/test" config-ref="HTTP_Listener_config"/>
	<ee:transform>
		<ee:message>
		<ee:set-payload ><![CDATA[%dw 2.0
output application/java
---
((payload.^raw as String) scan /encoding='([A-z0-9-]+)'/)[0][1]]]></ee:set-payload>
		</ee:message>
	</ee:transform>
	<logger level="INFO" message="#[payload]"/>
</flow>
```

Using your preferred REST client or API testing tool, send a POST request with the XML body:

```XML
<?xml version='1.0' encoding='ISO-8859-1'?>
<test>
</test>
```

The Logger message returns the extracted encoding value `ISO-8859-1`:

Console Output in Anypoint Studio:

```txt
INFO  2021-05-12 12:25:41,618 [[MuleRuntime].uber.03: [xmlmodule].Flow.CPU_INTENSIVE @de48fc8] [processor: Flow/processors/2; event: 4fe7f6a0-b336-11eb-909c-f01898ad2638] org.mule.runtime.core.internal.processor.LoggerMessageProcessor: ISO-8859-1
```

### Custom Metadata Selector (.^myCustomMetadata)

Returns the value of custom metadata. Metadata can be associated with any value by using the `as`
operator.

The following example uses `userName.^myCustomMetadata` to return the value of custom metadata that
is defined as a variable (named `userName`) in the header of the script as a DataWeave script. For
comparison, the example also returns the value of `userName`.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
var userName = "DataWeave" as String {myCustomMetadata: "customMetadataValue"}
---

{
  "valueOfVariableMetaData" :  userName.^myCustomMetadata,
  "valueOfVariable" :  userName,
}
```

The output of the script is `"customMetadataValue"` for the value of the custom metadata and
`"DataWeave"` for value of the `userName` variable.

Output JSON:

```json
{
  "valueOfVariableMetaData": "customMetadataValue",
  "valueOfVariable": "DataWeave"
}
```

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.11/dataweave-selectors)

- [DataWeave Quickstart](https://docs.mulesoft.com/dataweave/2.11/dataweave-quickstart)

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.11/dataweave-types)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook)

<!-- document id=9b93dbe8ce66f8c070f0612c3a0780b4e0addd40444dca1f2b2b467c0c6ff832 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook-extract-data.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, transform, transformer, metadata, dataweave, data weave, datawave, datamapper, dwl, dfl, dw, payload, attribute, variable, flow, error, message
---

# Extract Data

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave can select data from DataWeave objects and arrays, variables that store that data, and the
output of DataWeave functions when that output is an array or object.

More precisely, a DataWeave selector operates within a context, which can be a reference to the
variable that stores the data, an object literal, an array literal, or the invocation of a DataWeave
function. You can use selectors in Mule modules, connectors, and components that accept DataWeave
expressions.

When DataWeave processes a selector, it sets a new context (or scope) for subsequent selectors, so
you can navigate through the complex structures of arrays and objects using chains of selectors. The
depth of the selection is limited only by the depth of the current context.

Supported variable references are [Mule Runtime variables](https://docs.mulesoft.com/dataweave/2.12/dataweave-variables-context), such as
`payload` and `attributes`, and [DataWeave variables](https://docs.mulesoft.com/dataweave/2.12/dataweave-variables) that store arrays or
objects. A simple example is `payload.myKey` where the payload is the object `{"myKey" : 1234 }`, so
the result is `1234`.

A selector can act on the invocation of a function, such as the DataWeave `read` function. For
example, `read('{"A":"B"}','application/json')."A"` returns `"B"`.

## Use Selectors on DataWeave Arrays and Objects

In DataWeave, selectors extract values from within a DataWeave object (such as
`{ myKey : "myValue" }`) or array (such as `[1,2,3,4]` or
`[ { "myKey" : "1234" }, { "name" : "somebody" } ]`).

The following DataWeave script uses the single-value selector (`.`) to retrieve values from the
object and array defined by the variables `myObject` and `myArray`.

DataWeave Script:

```dataweave
%dw 2.0
var myObject = { "myKey" : "1234", "name" : "somebody" }
var myArray = [ { "myKey" : "1234" }, { "name" : "somebody" } ]
output application/json
---
{
    selectingValueUsingKeyInObject : myObject.name,
    selectingValueUsingKeyOfObjectInArray : myArray.name,
}
```

Output JSON:

```json
{
  "selectingValueUsingKeyInObject": "somebody",
  "selectingValueUsingKeyOfObjectInArray": ["somebody"]
}
```

As the Output shows:

- `myObject.name` returns the value `"somebody"`

- `myArray.name` returns the array `[ "somebody" ]`

## Selector Quick Reference

Single Value (`.`)

Acts on arrays and objects to return the value of a matching key. The syntax is `.myKey`. To
retrieve values of duplicate keys in a DataWeave _object_, use `*`, instead. For examples, see
[Single-Value Selector (.myKey)](#single_value).

Multiple Values (`*`)

Acts on arrays and objects to retrieve the values of all matching keys at a single level in the
hierarchy of a data structure. The syntax is `*myKey`. For the values of all duplicate keys at lower
levels in the hierarchy, use the descendants selector (`..`), instead. For examples, see
[Multi-Value Selector (`.*`)](#multi_value).

Key-Value Pair (`&`)

Acts on arrays and objects. Instead of returning the value of the DataWeave object, this selector
returns the entire DataWeave object, both key and value. The syntax is `.&myKey`. For examples, see
[Key-Value Pair Selector (`.&myKey`)](#key_value).

Descendants (`..`)

Acts on arrays and objects to retrieve all matching keys from arrays and objects below the given
key, regardless of their location in the hierarchy. The syntax is `..myKey` For examples, see
[Descendants Selector (`..myKey`)](#descendants).

Index (`[]`)

Returns the value at the specified index of an array. An example is the `[0]` at the end of
`["a","b","c"][0]`, which returns `"a"`. For examples, see [Index Selector (`[anIndex]`)](#index).

Range `[index1 to index2]`

Returns an array with values of the selected indices. An example is the `[2 to 3]` at the end of
`["a","b","c","d"][2 to 3]`, which returns `["c","d"]`. For examples, see
[Range selector (`anIndex to anotherIndex`)](#range).

XML attribute (`.@myKey`)

Returns the value of a selected key for an XML attribute. For an example, see
[XML Attribute Selector (`.@myKey`)](#xml_attribute).

Namespace Selector (`myKey.#`)

Returns the `xmlns` namespace from the element that also contains the selected key. For an example,
see [Namespace Selector (`#`)](#namespace).

Selector Modifiers (`?` and `!`)

`?` and `!` check for the specified key. `?` returns `true` or `false`. `!` returns an error if the
key is not present. For examples, see [Selector Modifiers (`!`, `?`)](#selector_modifiers).

Filter Selectors (`myKey[?(booleanExpression)]`)

Returns the selected items if the Boolean expression returns `true` and the specified `key` is
present. It returns `null` if the expression is false or the key is not present. For examples, see
[Filter Selectors (`myKey[?($ == "aValue")]`)](#filter_selectors).

Metadata Selector `.^someMetadata`

Returns the value of specified metadata for a Mule payload, variable, or attribute. The selector can
return the value of class (`.^class`), content length (`.^contentLength`), encoding (`.^encoding`),
MIME type (`.^mimeType`), media type (`.^mediaType`), raw (`.^raw`), and custom
(`.^myCustomMetadata`) metadata. For details, see
[Metadata Selector (.^someMetadata)](#metadata_selector).

## Key and Selector Syntax

In DataWeave, quotes around the name of an object’s key are required in some cases but optional in
others. Though a key is not an identifier, if the key name meets the criteria of a
[valid identifier name](https://docs.mulesoft.com/dataweave/2.12/dataweave-language-introduction#valid-identifiers), quotes around the key
are optional. If the key does not meet this criteria, you _must_ surround the key in quotes. For
example, to correct the key syntax in `{ some-name : "somebody" }`, you can use
`{ "some-name" : "somebody" }` or `{ 'some-name' : "somebody" }`. Without quotes, the key in
`{ some-name : "somebody" }` produces the error `Invalid input '-', expected Namespace`.

If you are using a selector on a key that requires quotes, you must also surround the selector in
quotes. For example, the selector `"some-name"` in `{ "some-name" : "somebody" }."some-name"` works,
but the selector `some-name` in `{ "some-name" : "somebody" }.some-name` produces the error
`Unable to resolve reference of: name` because the selector is not surrounded in quotes.

Quotes around a selector are optional if you are using a selector on a key that does not require the
quotes. For example, all of these examples work:

- `{"name" : "somebody"}.name`

- `{"name" : "somebody"}."name"`

- `{name : "somebody"}.name`

- `{name : "somebody"}."name"`

## Single-Value Selector (.myKey)

`.myKey` selectors work over an object or array to return the value of a matching key.

### Single-Value Selector Over an Object

For an object, the single-value selector returns the value of the matching key. For example, in the
following script, `myObject.user` returns `"a"`.

DataWeave Script:

```dataweave
%dw 2.0
var myObject = { user : "a" }
output application/json
---
{ myObjectExample : myObject.user }
```

Output JSON:

```json
{
  "myObjectExample": "a"
}
```

When operating on a DataWeave _object_ (not an array), the `.` selector only returns the value of
the _first_ matching key, even if the object contains multiple matching keys, for example:

DataWeave Script:

```dataweave
%dw 2.0
var myObject = { user : "a", "user" : "b" }
output application/json
---
{ myObjectExample : myObject.user }
```

Output JSON:

```json
{
  "myObjectExample": "a"
}
```

To return the values of multiple matching keys in cases like this, see
[Multi-Value Selector (`.*`)](#multi_value).

In the next example, `payload.people.person.address` returns the value of the `address` element. (It
also uses the `output` directive to transform the JSON input to XML.)

DataWeave Script:

```dataweave
%dw 2.0
var myData = {
  "people": {
    "size" : 1,
    "person": {
      "name": "Nial",
      "address": {
        "street": {
          "name": "Italia",
          "number": 2164
        },
        "area": {
          "zone": "San Isidro",
          "name": "Martinez"
        }
      }
    }
  }
}
output application/xml
---
{ myaddresses: myData.people.person.address }
```

Output XML:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<myaddresses>
  <street>
    <name>Italia</name>
    <number>2164</number>
  </street>
  <area>
    <zone>San Isidro</zone>
    <name>Martinez</name>
  </area>
</myaddresses>
```

## Single-Value Selector Over an Array

When acting on an array, the `.` selector returns an array, even if there is only one matching
value. For example, `["a":"b"]."a"` returns `["b"]`.

Note that the `.` selector acts differently on arrays than it acts on objects. Like `.*`, the `.`
selector returns an array with the values of _all matching keys_ at the specified level of the input
array.

DataWeave Script:

```dataweave
%dw 2.0
var myArrayOfKeyValuePairs = [ "aString": "hello", "aNum": 2, "aString" : "world" ]
var myArrayOfObjects = [ { "aString": "hello" }, { "aNum": 2 }, { "aString" : "world" } ]
output application/json
---
{
    myKeyValueExample : myArrayOfKeyValuePairs.aString,
    myObjectExample :  myArrayOfObjects.aString
}
```

Output JSON:

```json
{
  "myKeyValueExample": ["hello", "world"],
  "myObjectExample": ["hello", "world"]
}
```

In the following example, the value of the input variable, `myData`, is an array that contains two
objects. The selector navigates both objects and returns the values of both `street` keys.

DataWeave Script:

```dataweave
%dw 2.0
var myData = {
  "people": [
    {
      "person": {
        "name": "Nial",
        "address": {
          "street": {
            "name": "Italia",
            "number": 2164
          },
          "area": {
            "zone": "San Isidro",
            "name": "Martinez"
          }
        }
      }
    },
    {
      "person": {
        "name": "Coty",
        "address": {
          "street": {
            "name": "Monroe",
            "number": 323
          },
          "area": {
            "zone": "BA",
            "name": "Belgrano"
          }
        }
      }
    }
  ]
}
output application/json
---
myData.people.person.address.street
```

Output JSON:

```json
[
  {
    "name": "Italia",
    "number": 2164
  },
  {
    "name": "Monroe",
    "number": 323
  }
]
```

## Multi-Value Selector (`.*`)

`.*` traverses objects and arrays to select the values of all matching keys and returns matching
results in an array.

### Multi-Value Selector Over an Object

`.*` returns an array with all the values whose key matches the expression.

The following example returns the values of all `user` elements from the input payload.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
payload.users.*user
```

Input XML Payload:

```xml
<users>
  <user>Mariano</user>
  <user>Martin</user>
  <user>Leandro</user>
</users>
```

Output JSON:

```json
["Mariano", "Martin", "Leandro"]
```

### Multi-Value Selector Over an Array

On arrays, `.*` works the same way as the single-value selector (`.`). For example,
`payload.people.person.address.*street` and the example `payload.people.person.address.street` (from
[Single-Value Selector Over an Array](#single_value_array)) return the same results.

DataWeave Script:

```dataweave
%dw 2.0
var myArrayOfKeyValuePairs = [ "aString": "hello", "aNum": 2, "aString" : "world" ]
var myArrayOfObjects = [ { "aString": "hello" }, { "aNum": 2 }, { "aString" : "world" } ]
output application/json
---
{
    myKeyValueExample : myArrayOfKeyValuePairs.*aString,
    myObjectExample :  myArrayOfObjects.*aString
}
```

Output JSON:

```json
{
  "myKeyValueExample": ["hello", "world"],
  "myObjectExample": ["hello", "world"]
}
```

## Descendants Selector (`..myKey`)

The `..` selector acts on arrays and objects.

This selector applies to the context using the form `..myKey`, and it retrieves the values of all
matching key-value pairs in the sub-tree under the selected context. Regardless of the hierarchical
structure of the fields, the output is returned at the same level.

In this example, all of the fields that match the key `name` are placed in a list called `names`
regardless of their cardinality in the tree of the input data.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{ names: payload.people..name }
```

Input JSON Payload:

```json
{
  "people": {
    "person": {
      "name": "Nial",
      "address": {
        "street": {
          "name": "Italia",
          "number": 2164
        },
        "area": {
          "zone": "San Isidro",
          "name": "Martinez"
        }
      }
    }
  }
}
```

Output JSON:

```json
{
  "names": ["Nial", "Italia", "Martinez"]
}
```

## Key-Value Pair Selector (`.&myKey`)

The `&` selector acts on arrays and objects. `&` retrieves both the keys and values of all matching
keys pairs in the current context. These are returned as an object, containing the retrieved keys
and values.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
{
  users: payload.users.&user
}
```

Input XML Payload:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<users>
  <user>Mariano</user>
  <user>Martin</user>
  <user>Leandro</user>
  <admin>Admin</admin>
  <admin>org_owner</admin>
</users>
```

Output XML:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<users>
  <user>Mariano</user>
  <user>Martin</user>
  <user>Leandro</user>
</users>
```

Note that unlike the multi-value selector, the output of this selector is an object, where the
original keys for each value are also extracted.

### Select All the Descendant Key-Value Pairs

This example uses the `..` and `&` selectors in `myVar.people..&name` to select and return an array
that contains all descendant objects from `myData` input that contain the key `name`. It also
transforms the JSON input to XML output.

DataWeave Script:

```dataweave
%dw 2.0
var myData = {
  "people": {
    "person": {
      "name": "Nial",
      "address": {
        "street": {
          "name": "Italia",
          "number": 2164
        },
        "area": {
          "zone": "San Isidro",
          "name": "Martinez"
        }
      }
    }
  }
}
output application/xml
---
names: {(myData.people..&name)}
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<names>
  <name>Nial</name>
  <name>Italia</name>
  <name>Martinez</name>
</names>
```

## Index Selector (`[anIndex]`)

The index selector returns the element at the specified position. It can be applied over an array,
object, or string.

### Index Selector Over an Array

This selector can be applied to String literals, Arrays and Objects. In the case of Objects, the
value of the key-value pair found at the index is returned. In the case of Arrays, the value of the
element is returned. The index is zero-based.

1.  If the index is bigger or equal to 0, it starts counting from the beginning.

2.  If the index is negative, it starts counting from the end where -1 is the last element.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
payload.people[1]
```

Input JSON Payload:

```json
{
  "people": [
    {
      "nameFirst": "Nial",
      "nameLast": "Martinez"
    },
    {
      "nameFirst": "Coty",
      "nameLast": "Belgrano"
    }
  ]
}
```

Output JSON:

```json
{
  "nameFirst": "Coty",
  "nameLast": "Belgrano"
}
```

### Index Selector Over an Object

The selector returns the value of the key-value pair at the specified position.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
payload[1]
```

Input JSON Payload:

```json
{
  "nameFirst": "Mark",
  "nameLast": "Nguyen"
}
```

Output JSON:

```json
"Nguyen"
```

### Index Selector Over a String

When using the Index Selector with a string, the string is broken down into an array, where each
character is an index.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{ name: "MuleSoft"[0] }
```

Output JSON:

```json
{ "name": "M" }
```

The selector picks the character at a given position, treating the string as an array of characters.

1.  If the index is bigger or equal to 0, it starts counting from the beginning.

2.  If the index is negative, it starts counting from the end.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{ name: "Emiliano"[0] }
```

Output JSON:

```json
{ "name": "E" }
```

## Range selector (`anIndex to anotherIndex`)

The `to` selector returns values of matching indices in an array or string. You can also use it to
reverse the order of the indices in the range. The selector treats characters in the string as
indices.

- Selecting an index from an array:

  - `[1,2,3,4][0]` returns `1`

    The index of the first element in an array is always `0`.

  - `[1,2,3,4][3]` returns `4`

### Range Selector Over an Array

Range selectors limit the output to only the elements specified by the range on that specific order.
This selector allows you to slice an array or even invert it.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
  slice: [0,1,2][0 to 1],
  last: [0,1,2][-1 to 0]
}
```

Output JSON:

```json
{
  "slice": [0, 1],
  "last": [2, 1, 0]
}
```

### Range Selector Over a String

The Range selector limits the output to only the elements specified by the range on that specific
order, treating the string as an array of characters. This selector enables you to slice a string or
invert it.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
  slice: "DataWeave"[0 to 1],
  middle : "superfragilisticexpialadocious"[10 to 13],
  last: "DataWeave"[-1 to 0]
}
```

Output JSON:

```json
{
  "slice": "Da",
  "middle": "list",
  "last": "evaeWataD"
}
```

## XML Attribute Selector (`.@myKey`)

`.@myKey` selects an attribute in an XML element.

Using `.@` without the key name returns an object containing the attributes as key-value pairs.

This DataWeave example reads an XML sample into a variable and uses `@` to select attributes from
the XML.

DataWeave Script:

```dataweave
%dw 2.0
var myVar = read('<product id="1" type="electronic">
  <brand>SomeBrand</brand>
</product>', 'application/xml')
output application/json
---
{
  item: [
  	{
      "type" : myVar.product.@."type",
      "name" : myVar.product.brand,
      "attributes": myVar.product.@
    }
  ]
}
```

Output JSON:

```json
{
  "item": [
    {
      "type": "electronic",
      "name": "SomeBrand",
      "attributes": {
        "id": "1",
        "type": "electronic"
      }
    }
  ]
}
```

## Namespace Selector (`#`)

`#` returns the XML namespace of a selected key as plain text.

DataWeave Script:

```dataweave
%dw 2.0
output text/plain
---
payload.order.#
```

Input XML Payload:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<ns0:order xmlns:ns0="http://orders.company.com">
  <name>Mark</name>
  <items>42</items>
  <orderdate>2017-01-04</orderdate>
</ns0:order>
```

Output Text:

```json
"http://orders.company.com"
```

## Selector Modifiers (`!`, `?`)

You can check for the presence of a given key.

- `!` evaluates the selection and fails with an exception message if the key is not present.

- `?` returns `true` if the selected key is present, `false` if not. Note that `?` is also used in
  [Filter Selectors (`myKey[?($ == "aValue")]`)](#filter_selectors).

### Assert Present Validator

`!` returns an error if any of the specified key is missing.

- `{ "name": "Annie" }.lastName!` returns an error with the message,
  `There is no key named 'lastName'`.

- Without the `!`, `{ "name": "Annie" }.lastName` returns `null`.

- When the key is present, `{ "name": "Annie" }.name!` the result is `"Annie"`.

### Key Present Validator

Returns `true` if the specified key is present in the object or as an attribute of an XML element.

This example returns `true` because the `name` key does exists.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
present: payload.name?
```

Input JSON Payload:

```json
{ "name": "Annie" }
```

Output XML:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<present>true</present>
```

`?` also works with XML attributes:

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
  item: {
    typePresent : payload.product.@."type"?
  }
}
```

Input XML Payload:

```xml
<product id="1" type="tv">
  <brand>Samsung</brand>
</product>
```

Output JSON:

```json
{
  "item": { "typePresent": true }
}
```

## Filter Selectors (`myKey[?($ == "aValue")]`)

`myKey[?($ == "aValue")]` returns only the values of matching keys within an array or object. Note
that `?` is also used in [Key Present Validator](#key_present). If no key-value pairs match, the
result is `null`.

The following example inputs the array of `name` keys returned by `*.name`, then checks for `name`
keys with the value `"Mariano"`. It filters out any values that do not match. Note that the `$`
references the value of the selected key.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{ users: payload.users.*name[?($ == "Mariano")] }
```

Input XML Payload:

```xml
<users>
  <name>Mariano</name>
  <name>Luis</name>
  <name>Mariano</name>
</users>
```

Output JSON:

```json
{
  "users": ["Mariano", "Mariano"]
}
```

The following example assumes the same [input](#input_filter_selectors) and returns all the
key-value pairs of the input because the expression `( 1 == 1 )` is true. Note that a false
expression, such as `( 1 == 2 )`, returns `null`.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{ users: payload.users.*name[?( 1 == 1)] }
```

Input XML Payload:

```xml
<users>
  <name>Mariano</name>
  <name>Luis</name>
  <name>Mariano</name>
</users>
```

Output JSON:

```json
{
  "users": ["Mariano", "Luis", "Mariano"]
}
```

The following example assumes the same [input](#input_filter_selectors). It uses `mapObject` to
iterate over the entire input object and return matching key-value pairs, filtering out any pairs
that do not match.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
payload mapObject { ($$) : $[?($=="Mariano")] }
```

Input XML Payload:

```xml
<users>
  <name>Mariano</name>
  <name>Luis</name>
  <name>Mariano</name>
</users>
```

Output JSON:

```json
{
  "users": {
    "name": "Mariano",
    "name": "Mariano"
  }
}
```

## Metadata Selector (.^someMetadata)

Returns the value of specified metadata for a Mule payload, variable, or attribute. The selector can
return the following metadata:

- Content length metadata: `.^contentLength` returns the content length of the value, if the value
  is present. For an example, see
  [Content Length Metadata Selector (.^contentLength)](#caret_contentlength).

- Class metadata: `.^class` returns the class of the Plain Old Java Object (POJO). For example,
  `{ "string" : payload.string.^class }` might return `{ "string": "java.lang.String" }` if the
  input payload defines a Java string, such as `simplePojo.string = "myString"`, in a simple POJO,
  and `{ "date" : payload.date.^class }` might return `{ "date": "java.util.Date" }`. For an
  example, see [Class Metadata Selector (.^class)](#caret_class).

- Encoding metadata: `.^encoding` returns the encoding of a value. For example,
  `{ "myEncoding" : payload.^encoding }` might return `{"myEncoding": "UTF-8"}` for an input POJO.
  For an example, see [Encoding Metadata Selector (.^encoding)](#caret_encoding).

- Media Type Selector: `.^mediaType` returns the MIME type of a value that includes parameters, for
  example, `application/json;charset=UTF-16`, and the expression in the value of
  `{ "myMediaType" : payload.^mediaType }` might return `"myMediaType": "**/**; charset=UTF-8"` for
  an input POJO. For an example, see [Media Type Metadata Selector (.^mediaType)](#caret_mediatype).

- MIME Type metadata: `.^mimeType` returns the MIME type (without parameters) of a value, for
  example, `application/json`, and `{ "myMimeType" : payload.^mimeType }` might return
  `{ "myMediaType": "**/**" }` for an input POJO. For an example, see
  [MIME Type Metadata Selector (.^mimeType)](#caret_mimetype).

- Raw metadata: `.^raw` returns the underlying data (typically, a binary value) of a plain old Java
  object (POJO). This selector is sometimes used when calculating an MD5 for hashes when checking
  for man-in-the-middle attacks. For examples, see [Raw Metadata Selector (.^raw)](#caret_raw).

- Custom metadata: `.^myCustomMetadata` returns the value of custom metadata. For examples, see
  [Custom Metadata Selector (.^myCustomMetadata)](#caret_custom_metadata).

### Content Length Metadata Selector (.^contentLength)

Returns the content length of the value, if the value is present.

In the following Mule app flow, the Logger uses `payload.^contentLength` to select the length of the
string `my string`, set in the Set Payload (`set-payload`) component.

Mule App XML in Anypoint Studio:

```XML
<flow name="setpayloadobjectFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="15" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <!-- Set the payload to "my string". -->
  <set-payload value='"my string"' doc:name="Set Payload" />
  <!-- Select the class to which "my string" belongs. -->
  <logger level="INFO" doc:name="Logger" message="#[payload.^contentLength]"/>
</flow>
```

The Studio console output shows that the length of the input string (`my string`) is eleven (`9`)
characters long. The length includes the blank space in the string.

Console Output in Anypoint Studio:

```txt
INFO  2019-05-07 16:59:33,690 [[MuleRuntime].cpuLight.07:
 [carets].caretsFlow.CPU_LITE @39f1dbde]
 [event: 28ce97a0-7124-11e9-acfe-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 11
```

### Class Metadata Selector (.^class)

Returns the class of the Plain Old Java Object (POJO). The value might result from calling a method
in a Java class or have a data type (such as `String` or `DateTime`) that DataWeave treats as a Java
value, for example:

- `{ "string" : payload.mystring.^class }` might return `{ "mystring": "java.lang.String" }` if the
  input payload defines a Java string, such as `simplePojo.string = "myString"`, in a simple POJO.

- `{ "mydate" : payload.mydate.^class }` might return `{ "mydate": "java.util.Date" }`.

In the following Mule app flow, the Logger uses `payload.^class` to select the Java class of
`"my string"`, set in the Set Payload (`set-payload`) component.

Mule App XML in Anypoint Studio:

```XML
<flow name="setpayloadobjectFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="15" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <!-- Set the payload to "my string". -->
  <set-payload value='"my string"' doc:name="Set Payload" />
  <!-- Select the class to which "my string" belongs. -->
  <logger level="INFO" doc:name="Logger" message="#[payload.^class]"/>
</flow>
```

The Studio console output shows that the payload string belongs to the class `java.lang.String`.

Console Output in Anypoint Studio:

```txt
INFO  2019-04-20 16:10:03,075 [[MuleRuntime].cpuLight.08:
 [setpayloadobject].setpayloadobjectFlow.CPU_LITE @6447187e]
 [event: 6da29400-63c1-11e9-98e0-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 java.lang.String
```

### Encoding Metadata Selector (.^encoding)

Returns the encoding of a value. For example, `{ "myEncoding" : payload.^encoding }` might return
`{"myEncoding": "UTF-8"}` for an input POJO.

In the following Mule app flow, the Logger uses `payload.^encoding` to select the encoding of
``"my string"`set in the Set Payload (`set-payload``) component. The Scheduler (`scheduler`)
component is simply an event source that regularly generates a new Mule event to hold the payload
set in Set Payload.

Mule App XML in Anypoint Studio:

```XML
<flow name="setpayloadobjectFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="15" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <!-- Set the payload to "my string". -->
  <set-payload value='"my string"' doc:name="Set Payload" />
  <!-- Select the encoding of "my string". -->
  <logger level="INFO" doc:name="Logger" message="#[payload.^encoding]"/>
</flow>
```

The Studio console output shows that the payload string has `UTF-8` encoding.

Console Output in Anypoint Studio:

```txt
INFO  2019-04-20 16:14:24,222 [[MuleRuntime].cpuLight.03:
 [setpayloadobject].setpayloadobjectFlow.CPU_LITE @62bea6a6]
 [event: 0938bf70-63c2-11e9-98e0-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 UTF-8
```

### Media Type Metadata Selector (.^mediaType)

Returns the MIME type of a value that includes parameters (for example,
`application/json;charset=UTF-16`). The expression in the value of
`{ "myMediaType" : payload.^mediaType }` might return `"myMediaType": "**/**; charset=UTF-8"` for an
input POJO.

In the following Mule app flow, the Logger uses `payload.^mediaType` to select the media type of
`2014-10-12T11:11:19-00:03` set in the Set Payload (`set-payload`) component.

Mule App XML in Anypoint Studio:

```XML
<flow name="setpayloadobjectFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="15" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <set-payload value='#[|2014-10-12T11:11:19-00:03| as DateTime]' doc:name="Set Payload" />
  <logger level="INFO" doc:name="Logger" message="#[payload.^mediaType]"/>
</flow>
```

The Studio console output shows that the `DateTime` payload has the
`application/java; charset=UTF-8` media type.

Console Output in Anypoint Studio:

INFO 2019-04-20 16:41:01,276 \[\[MuleRuntime\].cpuLight.04:
\[setpayloadobject\].setpayloadobjectFlow.CPU\_LITE @7e991c71\] \[event:
c0e96860-63c5-11e9-bcff-8c8590a99d48\]
rg.mule.runtime.core.internal.processor.LoggerMessageProcessor: application/java; charset=UTF-8

In the following Mule app flow, the Loggers use `payload.^mediaType` to select a string
`"my string"`, then to select a string that is set within an **fx** expression
(`#["my string as String type" as String]`) in the Set Payload (`set-payload`) component.

Mule App XML in Anypoint Studio:

```XML
<flow name="setpayloadobjectFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="15" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <!-- Set the payload to "my string". -->
  <set-payload value='"my string"' doc:name="Set Payload" />
  <!-- Select the media type of "my string". -->
  <logger level="INFO" doc:name="Logger" message='#[payload.^mediaType]'/>
  <!-- Set the payload using the fx expression "my string" as String. -->
  <set-payload value='#["my string as String type" as String]' doc:name="Set Payload" />
  <!-- Select the media type of a Java string. -->
  <logger level="INFO" doc:name="Logger" message='#[payload.^mediaType]'/>
</flow>
```

The Studio console output shows that the simple string has the media type `**/**`, while the string
that is set in the **fx** expression has the media type `application/java; charset=UTF-8`.

Console Output in Anypoint Studio:

```txt
INFO  2019-04-20 16:52:50,801 [[MuleRuntime].cpuLight.01:
 [setpayloadobject].setpayloadobjectFlow.CPU_LITE @5d914abe]
 [event: 68121cd0-63c7-11e9-bcff-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 */*

INFO  2019-04-20 16:52:51,085 [[MuleRuntime].cpuLight.01:
 [setpayloadobject].setpayloadobjectFlow.CPU_LITE @5d914abe]
 [event: 68121cd0-63c7-11e9-bcff-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 application/java; charset=UTF-8
```

### MIME Type Metadata Selector (.^mimeType)

Returns the MIME type (without parameters) of a value, for example, `application/json`, and
`{ "myMimeType" : payload.^mimeType }` might return `{ "myMediaType": "**/**" }` for an input POJO.

In the following Mule app flow, the Loggers use `payload.^mimeType` to select a string
`"my string"`, then to select a string that is set within an **fx** expression
(`#["my string as String type" as String]`) in the Set Payload (`set-payload`) component.

Mule App XML in Anypoint Studio:

```XML
<flow name="setpayloadobjectFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="15" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <!-- Set the payload to "my string". -->
  <set-payload value='"my string"' doc:name="Set Payload" />
  <!-- Select the MIME type of "my string". -->
  <logger level="INFO" doc:name="Logger" message='#[payload.^mimeType]'/>
  <!-- Set the payload using the fx expression "my string" as String. -->
  <set-payload value='#["my string as String type" as String]' doc:name="Set Payload" />
  <!-- Select the MIME type of a Java string. -->
  <logger level="INFO" doc:name="Logger" message='#[payload.^mimeType]'/>
</flow>
```

The Studio console output shows that the simple string has the MIME type `**/**`, while the string
that is set in the **fx** expression has the MIME type `application/java`.

Console Output in Anypoint Studio:

```txt
INFO  2019-04-20 17:02:07,762 [[MuleRuntime].cpuLight.06:
 [setpayloadobject].setpayloadobjectFlow.CPU_LITE @2d6f64b9]
 [event: b4097b00-63c8-11e9-bcff-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 */*

INFO  2019-04-20 17:02:08,029 [[MuleRuntime].cpuLight.06:
 [setpayloadobject].setpayloadobjectFlow.CPU_LITE @2d6f64b9]
 [event: b4097b00-63c8-11e9-bcff-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 application/java
```

### Raw Metadata Selector (.^raw)

Returns the underlying binary value of a POJO. This selector is sometimes used when calculating an
MD5 or some other cryptographic hash function to check for man-in-the-middle (MITM) attacks.

The following example uses the Set Payload component (`set-payload`) to produce a binary value, then
uses the Transform Message component (`ee:transform`) component to return raw data for the MD5
(`MD5(payload.^raw)`) of the binary value. The Logger component (`logger`) is also set to write the
raw data to the Studio console. For comparison, the second Logger returns the typical `payload` in a
standard JSON format.

Mule App XML in Anypoint Studio:

```XML
<flow name="rawcaret2Flow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="30" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <set-payload value='#["1234-5678-9123" as Binary]' doc:name="Set Payload" />
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
import * from dw::Crypto
output application/json
---
{ "myRawData" : MD5(payload.^raw) }]]></ee:set-payload>
    </ee:message>
  </ee:transform>
  <logger level="INFO" doc:name="Logger" message="#[payload.^raw]"/>
  <logger level="INFO" doc:name="Logger" message="#[payload]"/>
</flow>
```

Notice that instead of producing standard JSON output, the raw output in the Logger message
surrounds the entire payload in double-quotes and inserts new line characters (`\n`) for each new
line.

Console Output in Anypoint Studio:

```txt
INFO  2019-04-22 14:10:14,537 [[MuleRuntime].cpuLight.08:
 [rawcaret2].rawcaret2Flow.CPU_LITE @764a5a61]
 [event: 058f6a90-6543-11e9-9d99-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 "{\n  "myRawData": "5403e5a202c594871d59898b13054be5"\n}"

INFO  2019-04-22 14:10:14,540 [[MuleRuntime].cpuLight.08:
 [rawcaret2].rawcaret2Flow.CPU_LITE @764a5a61]
 [event: 058f6a90-6543-11e9-9d99-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 { "myRawData": "5403e5a202c594871d59898b13054be5" }
```

The following example uses the HTTP Listener source (`listener`) to get the XML payload received via
a POST request, then uses the Transform Message component (`ee:transform`) to get the encoding value
of the XML payload, by returning the raw data
(`(payload.^raw as String) scan /encoding='([A-z0-9-]+)'/)`). The Logger component (`logger`)
returns the `payload` in a JAVA format.

Mule App XML in Anypoint Studio:

```XML
<http:listener-config name="HTTP_Listener_config" >
    <http:listener-connection host="0.0.0.0" port="8081" />
</http:listener-config>
<flow name="test-flow">
	<http:listener path="/test" config-ref="HTTP_Listener_config"/>
	<ee:transform>
		<ee:message>
		<ee:set-payload ><![CDATA[%dw 2.0
output application/java
---
((payload.^raw as String) scan /encoding='([A-z0-9-]+)'/)[0][1]]]></ee:set-payload>
		</ee:message>
	</ee:transform>
	<logger level="INFO" message="#[payload]"/>
</flow>
```

Using your preferred REST client or API testing tool, send a POST request with the XML body:

```XML
<?xml version='1.0' encoding='ISO-8859-1'?>
<test>
</test>
```

The Logger message returns the extracted encoding value `ISO-8859-1`:

Console Output in Anypoint Studio:

```txt
INFO  2021-05-12 12:25:41,618 [[MuleRuntime].uber.03: [xmlmodule].Flow.CPU_INTENSIVE @de48fc8] [processor: Flow/processors/2; event: 4fe7f6a0-b336-11eb-909c-f01898ad2638] org.mule.runtime.core.internal.processor.LoggerMessageProcessor: ISO-8859-1
```

### Custom Metadata Selector (.^myCustomMetadata)

Returns the value of custom metadata. Metadata can be associated with any value by using the `as`
operator.

The following example uses `userName.^myCustomMetadata` to return the value of custom metadata that
is defined as a variable (named `userName`) in the header of the script as a DataWeave script. For
comparison, the example also returns the value of `userName`.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
var userName = "DataWeave" as String {myCustomMetadata: "customMetadataValue"}
---

{
  "valueOfVariableMetaData" :  userName.^myCustomMetadata,
  "valueOfVariable" :  userName,
}
```

The output of the script is `"customMetadataValue"` for the value of the custom metadata and
`"DataWeave"` for value of the `userName` variable.

Output JSON:

```json
{
  "valueOfVariableMetaData": "customMetadataValue",
  "valueOfVariable": "DataWeave"
}
```

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.12/dataweave-selectors)

- [DataWeave Quickstart](https://docs.mulesoft.com/dataweave/2.12/dataweave-quickstart)

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.12/dataweave-types)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook)

<!-- document id=9cfa677c63fc4ce076fefcf8e6266116345dc0a3f9e4637f211ae9968769e645 url=/mulesoft/current/en-us/dataweave/2.3/dataweave-cookbook-extract-data.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, transform, transformer, metadata, dataweave, data weave, datawave, datamapper, dwl, dfl, dw, payload, attribute, variable, flow, error, message
---

# Extract Data

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave can select data from DataWeave objects and arrays, variables that store that data, and the
output of DataWeave functions when that output is an array or object.

More precisely, a DataWeave selector operates within a context, which can be a reference to the
variable that stores the data, an object literal, an array literal, or the invocation of a DataWeave
function. You can use selectors in Mule modules, connectors, and components that accept DataWeave
expressions.

When DataWeave processes a selector, it sets a new context (or scope) for subsequent selectors, so
you can navigate through the complex structures of arrays and objects using chains of selectors. The
depth of the selection is limited only by the depth of the current context.

Supported variable references are [Mule Runtime variables](https://docs.mulesoft.com/dataweave/2.3/dataweave-variables-context), such as
`payload` and `attributes`, and [DataWeave variables](https://docs.mulesoft.com/dataweave/2.3/dataweave-variables) that store arrays or
objects. A simple example is `payload.myKey` where the payload is the object `{"myKey" : 1234 }`, so
the result is `1234`.

A selector can act on the invocation of a function, such as the DataWeave `read` function. For
example, `read('{"A":"B"}','application/json')."A"` returns `"B"`.

## Use Selectors on DataWeave Arrays and Objects

In DataWeave, selectors extract values from within a DataWeave object (such as
`{ myKey : "myValue" }`) or array (such as `[1,2,3,4]` or
`[ { "myKey" : "1234" }, { "name" : "somebody" } ]`).

The following DataWeave script uses the single-value selector (`.`) to retrieve values from the
object and array defined by the variables `myObject` and `myArray`.

DataWeave Script:

```dataweave
%dw 2.0
var myObject = { "myKey" : "1234", "name" : "somebody" }
var myArray = [ { "myKey" : "1234" }, { "name" : "somebody" } ]
output application/json
---
{
    selectingValueUsingKeyInObject : myObject.name,
    selectingValueUsingKeyOfObjectInArray : myArray.name,
}
```

Output JSON:

```json
{
  "selectingValueUsingKeyInObject": "somebody",
  "selectingValueUsingKeyOfObjectInArray": ["somebody"]
}
```

As the Output shows:

- `myObject.name` returns the value `"somebody"`

- `myArray.name` returns the array `[ "somebody" ]`

## Selector Quick Reference

Single Value (`.`)

Acts on arrays and objects to return the value of a matching key. The syntax is `.myKey`. To
retrieve values of duplicate keys in a DataWeave _object_, use `*`, instead. For examples, see
[Single-Value Selector (.myKey)](#single_value).

Multiple Values (`*`)

Acts on arrays and objects to retrieve the values of all matching keys at a single level in the
hierarchy of a data structure. The syntax is `*myKey`. For the values of all duplicate keys at lower
levels in the hierarchy, use the descendants selector (`..`), instead. For examples, see
[Multi-Value Selector (`.*`)](#multi_value).

Key-Value Pair (`&`)

Acts on arrays and objects. Instead of returning the value of the DataWeave object, this selector
returns the entire DataWeave object, both key and value. The syntax is `.&myKey`. For examples, see
[Key-Value Pair Selector (`.&myKey`)](#key_value).

Descendants (`..`)

Acts on arrays and objects to retrieve all matching keys from arrays and objects below the given
key, regardless of their location in the hierarchy. The syntax is `..myKey` For examples, see
[Descendants Selector (`..myKey`)](#descendants).

Index (`[]`)

Returns the value at the specified index of an array. An example is the `[0]` at the end of
`["a","b","c"][0]`, which returns `"a"`. For examples, see [Index Selector (`[anIndex]`)](#index).

Range `[index1 to index2]`

Returns an array with values of the selected indices. An example is the `[2 to 3]` at the end of
`["a","b","c","d"][2 to 3]`, which returns `["c","d"]`. For examples, see
[Range selector (`anIndex to anotherIndex`)](#range).

XML attribute (`.@myKey`)

Returns the value of a selected key for an XML attribute. For an example, see
[XML Attribute Selector (`.@myKey`)](#xml_attribute).

Namespace Selector (`myKey.#`)

Returns the `xmlns` namespace from the element that also contains the selected key. For an example,
see [Namespace Selector (`#`)](#namespace).

Selector Modifiers (`?` and `!`)

`?` and `!` check for the specified key. `?` returns `true` or `false`. `!` returns an error if the
key is not present. For examples, see [Selector Modifiers (`!`, `?`)](#selector_modifiers).

Filter Selectors (`myKey[?(booleanExpression)]`)

Returns the selected items if the Boolean expression returns `true` and the specified `key` is
present. It returns `null` if the expression is false or the key is not present. For examples, see
[Filter Selectors (`myKey[?($ == "aValue")]`)](#filter_selectors).

Metadata Selector `.^someMetadata`

Returns the value of specified metadata for a Mule payload, variable, or attribute. The selector can
return the value of class (`.^class`), content length (`.^contentLength`), encoding (`.^encoding`),
MIME type (`.^mimeType`), media type (`.^mediaType`), raw (`.^raw`), and custom
(`.^myCustomMetadata`) metadata. For details, see
[Metadata Selector (.^someMetadata)](#metadata_selector).

## Key and Selector Syntax

In DataWeave, quotes around the name of an object’s key are required in some cases but optional in
others. Though a key is not an identifier, if the key name meets the criteria of a
[valid identifier name](https://docs.mulesoft.com/dataweave/2.3/dataweave-language-introduction#valid-identifiers), quotes around the key
are optional. If the key does not meet this criteria, you _must_ surround the key in quotes. For
example, to correct the key syntax in `{ some-name : "somebody" }`, you can use
`{ "some-name" : "somebody" }` or `{ 'some-name' : "somebody" }`. Without quotes, the key in
`{ some-name : "somebody" }` produces the error `Invalid input '-', expected Namespace`.

If you are using a selector on a key that requires quotes, you must also surround the selector in
quotes. For example, the selector `"some-name"` in `{ "some-name" : "somebody" }."some-name"` works,
but the selector `some-name` in `{ "some-name" : "somebody" }.some-name` produces the error
`Unable to resolve reference of: name` because the selector is not surrounded in quotes.

Quotes around a selector are optional if you are using a selector on a key that does not require the
quotes. For example, all of these examples work:

- `{"name" : "somebody"}.name`

- `{"name" : "somebody"}."name"`

- `{name : "somebody"}.name`

- `{name : "somebody"}."name"`

## Single-Value Selector (.myKey)

`.myKey` selectors work over an object or array to return the value of a matching key.

### Single-Value Selector Over an Object

For an object, the single-value selector returns the value of the matching key. For example, in the
following script, `myObject.user` returns `"a"`.

DataWeave Script:

```dataweave
%dw 2.0
var myObject = { user : "a" }
output application/json
---
{ myObjectExample : myObject.user }
```

Output JSON:

```json
{
  "myObjectExample": "a"
}
```

When operating on a DataWeave _object_ (not an array), the `.` selector only returns the value of
the _first_ matching key, even if the object contains multiple matching keys, for example:

DataWeave Script:

```dataweave
%dw 2.0
var myObject = { user : "a", "user" : "b" }
output application/json
---
{ myObjectExample : myObject.user }
```

Output JSON:

```json
{
  "myObjectExample": "a"
}
```

To return the values of mulitple matching keys in cases like this, see
[Multi-Value Selector (`.*`)](#multi_value).

In the next example, `payload.people.person.address` returns the value of the `address` element. (It
also uses the `output` directive to transform the JSON input to XML.)

DataWeave Script:

```dataweave
%dw 2.0
var myData = {
  "people": {
    "size" : 1,
    "person": {
      "name": "Nial",
      "address": {
        "street": {
          "name": "Italia",
          "number": 2164
        },
        "area": {
          "zone": "San Isidro",
          "name": "Martinez"
        }
      }
    }
  }
}
output application/xml
---
{ myaddresses: myData.people.person.address }
```

Output XML:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<myaddresses>
  <street>
    <name>Italia</name>
    <number>2164</number>
  </street>
  <area>
    <zone>San Isidro</zone>
    <name>Martinez</name>
  </area>
</myaddresses>
```

## Single-Value Selector Over an Array

When acting on an array, the `.` selector returns an array, even if there is only one matching
value. For example, `["a":"b"]."a"` returns `["b"]`.

Note that the `.` selector acts differently on arrays than it acts on objects. Like `.*`, the `.`
selector returns an array with the values of _all matching keys_ at the specified level of the input
array.

DataWeave Script:

```dataweave
%dw 2.0
var myArrayOfKeyValuePairs = [ "aString": "hello", "aNum": 2, "aString" : "world" ]
var myArrayOfObjects = [ { "aString": "hello" }, { "aNum": 2 }, { "aString" : "world" } ]
output application/json
---
{
    myKeyValueExample : myArrayOfKeyValuePairs.aString,
    myObjectExample :  myArrayOfObjects.aString
}
```

Output JSON:

```json
{
  "myKeyValueExample": ["hello", "world"],
  "myObjectExample": ["hello", "world"]
}
```

In the following example, the value of the input variable, `myData`, is an array that contains two
objects. The selector navigates both objects and returns the values of both `street` keys.

DataWeave Script:

```dataweave
%dw 2.0
var myData = {
  "people": [
    {
      "person": {
        "name": "Nial",
        "address": {
          "street": {
            "name": "Italia",
            "number": 2164
          },
          "area": {
            "zone": "San Isidro",
            "name": "Martinez"
          }
        }
      }
    },
    {
      "person": {
        "name": "Coty",
        "address": {
          "street": {
            "name": "Monroe",
            "number": 323
          },
          "area": {
            "zone": "BA",
            "name": "Belgrano"
          }
        }
      }
    }
  ]
}
output application/json
---
myData.people.person.address.street
```

Output JSON:

```json
[
  {
    "name": "Italia",
    "number": 2164
  },
  {
    "name": "Monroe",
    "number": 323
  }
]
```

## Multi-Value Selector (`.*`)

`.*` traverses objects and arrays to select the values of all matching keys and returns matching
results in an array.

### Multi-Value Selector Over an Object

`.*` returns an array with all the values whose key matches the expression.

The following example returns the values of all `user` elements from the input payload.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
payload.users.*user
```

Input XML Payload:

```xml
<users>
  <user>Mariano</user>
  <user>Martin</user>
  <user>Leandro</user>
</users>
```

Output JSON:

```json
["Mariano", "Martin", "Leandro"]
```

### Multi-Value Selector Over an Array

On arrays, `.*` works the same way as the single-value selector (`.`). For example,
`payload.people.person.address.*street` and the example `payload.people.person.address.street` (from
[Single-Value Selector Over an Array](#single_value_array)) return the same results.

DataWeave Script:

```dataweave
%dw 2.0
var myArrayOfKeyValuePairs = [ "aString": "hello", "aNum": 2, "aString" : "world" ]
var myArrayOfObjects = [ { "aString": "hello" }, { "aNum": 2 }, { "aString" : "world" } ]
output application/json
---
{
    myKeyValueExample : myArrayOfKeyValuePairs.*aString,
    myObjectExample :  myArrayOfObjects.*aString
}
```

Output JSON:

```json
{
  "myKeyValueExample": ["hello", "world"],
  "myObjectExample": ["hello", "world"]
}
```

## Descendants Selector (`..myKey`)

The `..` selector acts on arrays and objects.

This selector applies to the context using the form `..myKey`, and it retrieves the values of all
matching key-value pairs in the sub-tree under the selected context. Regardless of the hierarchical
structure of the fields, the output is returned at the same level.

In this example, all of the fields that match the key `name` are placed in a list called `names`
regardless of their cardinality in the tree of the input data.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{ names: payload.people..name }
```

Input JSON Payload:

```json
{
  "people": {
    "person": {
      "name": "Nial",
      "address": {
        "street": {
          "name": "Italia",
          "number": 2164
        },
        "area": {
          "zone": "San Isidro",
          "name": "Martinez"
        }
      }
    }
  }
}
```

Output JSON:

```json
{
  "names": ["Nial", "Italia", "Martinez"]
}
```

## Key-Value Pair Selector (`.&myKey`)

The `&` selector acts on arrays and objects. `&` retrieves both the keys and values of all matching
keys pairs in the current context. These are returned as an object, containing the retrieved keys
and values.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
{
  users: payload.users.&user
}
```

Input XML Payload:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<users>
  <user>Mariano</user>
  <user>Martin</user>
  <user>Leandro</user>
  <admin>Admin</admin>
  <admin>org_owner</admin>
</users>
```

Output XML:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<users>
  <user>Mariano</user>
  <user>Martin</user>
  <user>Leandro</user>
</users>
```

Note that unlike the multi-value selector, the output of this selector is an object, where the
original keys for each value are also extracted.

### Select All the Descendant Key-Value Pairs

This example uses the `..` and `&` selectors in `myVar.people..&name` to select and return an array
that contains all descendant objects from `myData` input that contain the key `name`. It also
transforms the JSON input to XML output.

DataWeave Script:

```dataweave
%dw 2.0
var myData = {
  "people": {
    "person": {
      "name": "Nial",
      "address": {
        "street": {
          "name": "Italia",
          "number": 2164
        },
        "area": {
          "zone": "San Isidro",
          "name": "Martinez"
        }
      }
    }
  }
}
output application/xml
---
names: {(myData.people..&name)}
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<names>
  <name>Nial</name>
  <name>Italia</name>
  <name>Martinez</name>
</names>
```

## Index Selector (`[anIndex]`)

The index selector returns the element at the specified position. It can be applied over an array,
object, or string.

### Index Selector Over an Array

This selector can be applied to String literals, Arrays and Objects. In the case of Objects, the
value of the key-value pair found at the index is returned. In the case of Arrays, the value of the
element is returned. The index is zero-based.

1.  If the index is bigger or equal to 0, it starts counting from the beginning.

2.  If the index is negative, it starts counting from the end where -1 is the last element.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
payload.people[1]
```

Input JSON Payload:

```json
{
  "people": [
    {
      "nameFirst": "Nial",
      "nameLast": "Martinez"
    },
    {
      "nameFirst": "Coty",
      "nameLast": "Belgrano"
    }
  ]
}
```

Output JSON:

```json
{
  "nameFirst": "Coty",
  "nameLast": "Belgrano"
}
```

### Index Selector Over an Object

The selector returns the value of the key-value pair at the specified position.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
payload[1]
```

Input JSON Payload:

```json
{
  "nameFirst": "Mark",
  "nameLast": "Nguyen"
}
```

Output JSON:

```json
"Nguyen"
```

### Index Selector Over a String

When using the Index Selector with a string, the string is broken down into an array, where each
character is an index.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{ name: "MuleSoft"[0] }
```

Output JSON:

```json
{ "name": "M" }
```

The selector picks the character at a given position, treating the string as an array of characters.

1.  If the index is bigger or equal to 0, it starts counting from the beginning.

2.  If the index is negative, it starts counting from the end.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{ name: "Emiliano"[0] }
```

Output JSON:

```json
{ "name": "E" }
```

## Range selector (`anIndex to anotherIndex`)

The `to` selector returns values of matching indices in an array or string. You can also use it to
reverse the order of the indices in the range. The selector treats characters in the string as
indices.

- Selecting an index from an array:

  - `[1,2,3,4][0]` returns `1`

    The index of the first element in an array is always `0`.

  - `[1,2,3,4][3]` returns `4`

### Range Selector Over an Array

Range selectors limit the output to only the elements specified by the range on that specific order.
This selector allows you to slice an array or even invert it.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
  slice: [0,1,2][0 to 1],
  last: [0,1,2][-1 to 0]
}
```

Output JSON:

```json
{
  "slice": [0, 1],
  "last": [2, 1, 0]
}
```

### Range Selector Over a String

The Range selector limits the output to only the elements specified by the range on that specific
order, treating the string as an array of characters. This selector enables you to slice a string or
invert it.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
  slice: "DataWeave"[0 to 1],
  middle : "superfragilisticexpialadocious"[10 to 13],
  last: "DataWeave"[-1 to 0]
}
```

Output JSON:

```json
{
  "slice": "Da",
  "middle": "list",
  "last": "evaeWataD"
}
```

## XML Attribute Selector (`.@myKey`)

`.@myKey` selects an attribute in an XML element.

Using `.@` without the key name returns an object containing the attributes as key-value pairs.

This DataWeave example reads an XML sample into a variable and uses `@` to select attributes from
the XML.

DataWeave Script:

```dataweave
%dw 2.0
var myVar = read('<product id="1" type="electronic">
  <brand>SomeBrand</brand>
</product>', 'application/xml')
output application/json
---
{
  item: [
  	{
      "type" : myVar.product.@."type",
      "name" : myVar.product.brand,
      "attributes": myVar.product.@
    }
  ]
}
```

Output JSON:

```json
{
  "item": [
    {
      "type": "electronic",
      "name": "SomeBrand",
      "attributes": {
        "id": "1",
        "type": "electronic"
      }
    }
  ]
}
```

## Namespace Selector (`#`)

`#` returns the XML namespace of a selected key as plain text.

DataWeave Script:

```dataweave
%dw 2.0
output text/plain
---
payload.order.#
```

Input XML Payload:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<ns0:order xmlns:ns0="http://orders.company.com">
  <name>Mark</name>
  <items>42</items>
  <orderdate>2017-01-04</orderdate>
</ns0:order>
```

Output Text:

```json
"http://orders.company.com"
```

## Selector Modifiers (`!`, `?`)

You can check for the presence of a given key.

- `!` evaluates the selection and fails with an exception message if the key is not present.

- `?` returns `true` if the selected key is present, `false` if not. Note that `?` is also used in
  [Filter Selectors (`myKey[?($ == "aValue")]`)](#filter_selectors).

### Assert Present Validator

`!` returns an error if any of the specified key is missing.

- `{ "name": "Annie" }.lastName!` returns an error with the message,
  `There is no key named 'lastName'`.

- Without the `!`, `{ "name": "Annie" }.lastName` returns `null`.

- When the key is present, `{ "name": "Annie" }.name!` the result is `"Annie"`.

### Key Present Validator

Returns `true` if the specified key is present in the object or as an attribute of an XML element.

This example returns `true` because the `name` key does exists.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
present: payload.name?
```

Input JSON Payload:

```json
{ "name": "Annie" }
```

Output XML:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<present>true</present>
```

`?` also works with XML attributes:

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
  item: {
    typePresent : payload.product.@."type"?
  }
}
```

Input XML Payload:

```xml
<product id="1" type="tv">
  <brand>Samsung</brand>
</product>
```

Output JSON:

```json
{
  "item": { "typePresent": true }
}
```

## Filter Selectors (`myKey[?($ == "aValue")]`)

`myKey[?($ == "aValue")]` returns only the values of matching keys within an array or object. Note
that `?` is also used in [Key Present Validator](#key_present). If no key-value pairs match, the
result is `null`.

The following example inputs the array of `name` keys returned by `*.name`, then checks for `name`
keys with the value `"Mariano"`. It filters out any values that do not match. Note that the `$`
references the value of the selected key.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{ users: payload.users.*name[?($ == "Mariano")] }
```

Input XML Payload:

```xml
<users>
  <name>Mariano</name>
  <name>Luis</name>
  <name>Mariano</name>
</users>
```

Output JSON:

```json
{
  "users": ["Mariano", "Mariano"]
}
```

The following example assumes the same [input](#input_filter_selectors) and returns all the
key-value pairs of the input because the expression `( 1 == 1 )` is true. Note that a false
expression, such as `( 1 == 2 )`, returns `null`.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{ users: payload.users.*name[?( 1 == 1)] }
```

Input XML Payload:

```xml
<users>
  <name>Mariano</name>
  <name>Luis</name>
  <name>Mariano</name>
</users>
```

Output JSON:

```json
{
  "users": ["Mariano", "Luis", "Mariano"]
}
```

The following example assumes the same [input](#input_filter_selectors). It uses `mapObject` to
iterate over the entire input object and return matching key-value pairs, filtering out any pairs
that do not match.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
payload mapObject { ($$) : $[?($=="Mariano")] }
```

Input XML Payload:

```xml
<users>
  <name>Mariano</name>
  <name>Luis</name>
  <name>Mariano</name>
</users>
```

Output JSON:

```json
{
  "users": {
    "name": "Mariano",
    "name": "Mariano"
  }
}
```

## Metadata Selector (.^someMetadata)

Returns the value of specified metadata for a Mule payload, variable, or attribute. The selector can
return the following metadata:

- Content length metadata: `.^contentLength` returns the content length of the value, if the value
  is present. For an example, see
  [Content Length Metadata Selector (.^contentLength)](#caret_contentlength).

- Class metadata: `.^class` returns the class of the Plain Old Java Object (POJO). For example,
  `{ "string" : payload.string.^class }` might return `{ "string": "java.lang.String" }` if the
  input payload defines a Java string, such as `simplePojo.string = "myString"`, in a simple POJO,
  and `{ "date" : payload.date.^class }` might return `{ "date": "java.util.Date" }`. For an
  example, see [Class Metadata Selector (.^class)](#caret_class).

- Encoding metadata: `.^encoding` returns the encoding of a value. For example,
  `{ "myEncoding" : payload.^encoding }` might return `{"myEncoding": "UTF-8"}` for an input POJO.
  For an example, see [Encoding Metadata Selector (.^encoding)](#caret_encoding).

- Media Type Selector: `.^mediaType` returns the MIME type of a value that includes parameters, for
  example, `application/json;charset=UTF-16`, and the expression in the value of
  `{ "myMediaType" : payload.^mediaType }` might return `"myMediaType": "**/**; charset=UTF-8"` for
  an input POJO. For an example, see [Media Type Metadata Selector (.^mediaType)](#caret_mediatype).

- MIME Type metadata: `.^mimeType` returns the MIME type (without parameters) of a value, for
  example, `application/json`, and `{ "myMimeType" : payload.^mimeType }` might return
  `{ "myMediaType": "**/**" }` for an input POJO. For an example, see
  [MIME Type Metadata Selector (.^mimeType)](#caret_mimetype).

- Raw metadata: `.^raw` returns the underlying data (typically, a binary value) of a plain old Java
  object (POJO). This selector is sometimes used when calculating an MD5 for hashes when checking
  for man-in-the-middle attacks. For examples, see [Raw Metadata Selector (.^raw)](#caret_raw).

- Custom metadata: `.^myCustomMetadata` returns the value of custom metadata. For examples, see
  [Custom Metadata Selector (.^myCustomMetadata)](#caret_custom_metadata).

### Content Length Metadata Selector (.^contentLength)

Returns the content length of the value, if the value is present.

In the following Mule app flow, the Logger uses `payload.^contentLength` to select the length of the
string `my string`, set in the Set Payload (`set-payload`) component.

Mule App XML in Anypoint Studio:

```XML
<flow name="setpayloadobjectFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="15" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <!-- Set the payload to "my string". -->
  <set-payload value='"my string"' doc:name="Set Payload" />
  <!-- Select the class to which "my string" belongs. -->
  <logger level="INFO" doc:name="Logger" message="#[payload.^contentLength]"/>
</flow>
```

The Studio console output shows that the length of the input string (`my string`) is eleven (`9`)
characters long. The length includes the blank space in the string.

Console Output in Anypoint Studio:

```txt
INFO  2019-05-07 16:59:33,690 [[MuleRuntime].cpuLight.07:
 [carets].caretsFlow.CPU_LITE @39f1dbde]
 [event: 28ce97a0-7124-11e9-acfe-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 11
```

### Class Metadata Selector (.^class)

Returns the class of the Plain Old Java Object (POJO). The value might result from calling a method
in a Java class or have a data type (such as `String` or `DateTime`) that DataWeave treats as a Java
value, for example:

- `{ "string" : payload.mystring.^class }` might return `{ "mystring": "java.lang.String" }` if the
  input payload defines a Java string, such as `simplePojo.string = "myString"`, in a simple POJO.

- `{ "mydate" : payload.mydate.^class }` might return `{ "mydate": "java.util.Date" }`.

In the following Mule app flow, the Logger uses `payload.^class` to select the Java class of
`"my string"`, set in the Set Payload (`set-payload`) component.

Mule App XML in Anypoint Studio:

```XML
<flow name="setpayloadobjectFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="15" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <!-- Set the payload to "my string". -->
  <set-payload value='"my string"' doc:name="Set Payload" />
  <!-- Select the class to which "my string" belongs. -->
  <logger level="INFO" doc:name="Logger" message="#[payload.^class]"/>
</flow>
```

The Studio console output shows that the payload string belongs to the class `java.lang.String`.

Console Output in Anypoint Studio:

```txt
INFO  2019-04-20 16:10:03,075 [[MuleRuntime].cpuLight.08:
 [setpayloadobject].setpayloadobjectFlow.CPU_LITE @6447187e]
 [event: 6da29400-63c1-11e9-98e0-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 java.lang.String
```

### Encoding Metadata Selector (.^encoding)

Returns the encoding of a value. For example, `{ "myEncoding" : payload.^encoding }` might return
`{"myEncoding": "UTF-8"}` for an input POJO.

In the following Mule app flow, the Logger uses `payload.^encoding` to select the encoding of
``"my string"`set in the Set Payload (`set-payload``) component. The Scheduler (`scheduler`)
component is simply an event source that regularly generates a new Mule event to hold the payload
set in Set Payload.

Mule App XML in Anypoint Studio:

```XML
<flow name="setpayloadobjectFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="15" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <!-- Set the payload to "my string". -->
  <set-payload value='"my string"' doc:name="Set Payload" />
  <!-- Select the encoding of "my string". -->
  <logger level="INFO" doc:name="Logger" message="#[payload.^encoding]"/>
</flow>
```

The Studio console output shows that the payload string has `UTF-8` encoding.

Console Output in Anypoint Studio:

```txt
INFO  2019-04-20 16:14:24,222 [[MuleRuntime].cpuLight.03:
 [setpayloadobject].setpayloadobjectFlow.CPU_LITE @62bea6a6]
 [event: 0938bf70-63c2-11e9-98e0-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 UTF-8
```

### Media Type Metadata Selector (.^mediaType)

Returns the MIME type of a value that includes parameters (for example,
`application/json;charset=UTF-16`). The expression in the value of
`{ "myMediaType" : payload.^mediaType }` might return `"myMediaType": "**/**; charset=UTF-8"` for an
input POJO.

In the following Mule app flow, the Logger uses `payload.^mediaType` to select the media type of
`2014-10-12T11:11:19-00:03` set in the Set Payload (`set-payload`) component.

Mule App XML in Anypoint Studio:

```XML
<flow name="setpayloadobjectFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="15" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <set-payload value='#[|2014-10-12T11:11:19-00:03| as DateTime]' doc:name="Set Payload" />
  <logger level="INFO" doc:name="Logger" message="#[payload.^mediaType]"/>
</flow>
```

The Studio console output shows that the `DateTime` payload has the
`application/java; charset=UTF-8` media type.

Console Output in Anypoint Studio:

INFO 2019-04-20 16:41:01,276 \[\[MuleRuntime\].cpuLight.04:
\[setpayloadobject\].setpayloadobjectFlow.CPU\_LITE @7e991c71\] \[event:
c0e96860-63c5-11e9-bcff-8c8590a99d48\]
rg.mule.runtime.core.internal.processor.LoggerMessageProcessor: application/java; charset=UTF-8

In the following Mule app flow, the Loggers use `payload.^mediaType` to select a string
`"my string"`, then to select a string that is set within an **fx** expression
(`#["my string as String type" as String]`) in the Set Payload (`set-payload`) component.

Mule App XML in Anypoint Studio:

```XML
<flow name="setpayloadobjectFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="15" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <!-- Set the payload to "my string". -->
  <set-payload value='"my string"' doc:name="Set Payload" />
  <!-- Select the media type of "my string". -->
  <logger level="INFO" doc:name="Logger" message='#[payload.^mediaType]'/>
  <!-- Set the payload using the fx expression "my string" as String. -->
  <set-payload value='#["my string as String type" as String]' doc:name="Set Payload" />
  <!-- Select the media type of a Java string. -->
  <logger level="INFO" doc:name="Logger" message='#[payload.^mediaType]'/>
</flow>
```

The Studio console output shows that the simple string has the media type `**/**`, while the string
that is set in the **fx** expression has the media type `application/java; charset=UTF-8`.

Console Output in Anypoint Studio:

```txt
INFO  2019-04-20 16:52:50,801 [[MuleRuntime].cpuLight.01:
 [setpayloadobject].setpayloadobjectFlow.CPU_LITE @5d914abe]
 [event: 68121cd0-63c7-11e9-bcff-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 */*

INFO  2019-04-20 16:52:51,085 [[MuleRuntime].cpuLight.01:
 [setpayloadobject].setpayloadobjectFlow.CPU_LITE @5d914abe]
 [event: 68121cd0-63c7-11e9-bcff-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 application/java; charset=UTF-8
```

### MIME Type Metadata Selector (.^mimeType)

Returns the MIME type (without parameters) of a value, for example, `application/json`, and
`{ "myMimeType" : payload.^mimeType }` might return `{ "myMediaType": "**/**" }` for an input POJO.

In the following Mule app flow, the Loggers use `payload.^mimeType` to select a string
`"my string"`, then to select a string that is set within an **fx** expression
(`#["my string as String type" as String]`) in the Set Payload (`set-payload`) component.

Mule App XML in Anypoint Studio:

```XML
<flow name="setpayloadobjectFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="15" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <!-- Set the payload to "my string". -->
  <set-payload value='"my string"' doc:name="Set Payload" />
  <!-- Select the MIME type of "my string". -->
  <logger level="INFO" doc:name="Logger" message='#[payload.^mimeType]'/>
  <!-- Set the payload using the fx expression "my string" as String. -->
  <set-payload value='#["my string as String type" as String]' doc:name="Set Payload" />
  <!-- Select the MIME type of a Java string. -->
  <logger level="INFO" doc:name="Logger" message='#[payload.^mimeType]'/>
</flow>
```

The Studio console output shows that the simple string has the MIME type `**/**`, while the string
that is set in the **fx** expression has the MIME type `application/java`.

Console Output in Anypoint Studio:

```txt
INFO  2019-04-20 17:02:07,762 [[MuleRuntime].cpuLight.06:
 [setpayloadobject].setpayloadobjectFlow.CPU_LITE @2d6f64b9]
 [event: b4097b00-63c8-11e9-bcff-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 */*

INFO  2019-04-20 17:02:08,029 [[MuleRuntime].cpuLight.06:
 [setpayloadobject].setpayloadobjectFlow.CPU_LITE @2d6f64b9]
 [event: b4097b00-63c8-11e9-bcff-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 application/java
```

### Raw Metadata Selector (.^raw)

Returns the underlying binary value of a POJO. This selector is sometimes used when calculating an
MD5 or some other cryptographic hash function to check for man-in-the-middle (MITM) attacks.

The following example uses the Set Payload component (`set-payload`) to produce a binary value, then
uses the Transform Message component (`ee:transform`) component to return raw data for the MD5
(`MD5(payload.^raw)`) of the binary value. The Logger component (`logger`) is also set to write the
raw data to the Studio console. For comparison, the second Logger returns the typical `payload` in a
standard JSON format.

Mule App XML in Anypoint Studio:

```XML
<flow name="rawcaret2Flow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="30" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <set-payload value='#["1234-5678-9123" as Binary]' doc:name="Set Payload" />
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
import * from dw::Crypto
output application/json
---
{ "myRawData" : MD5(payload.^raw) }]]></ee:set-payload>
    </ee:message>
  </ee:transform>
  <logger level="INFO" doc:name="Logger" message="#[payload.^raw]"/>
  <logger level="INFO" doc:name="Logger" message="#[payload]"/>
</flow>
```

Notice that instead of producing standard JSON output, the raw output in the Logger message
surrounds the entire payload in double-quotes and inserts new line characters (`\n`) for each new
line.

Console Output in Anypoint Studio:

```txt
INFO  2019-04-22 14:10:14,537 [[MuleRuntime].cpuLight.08:
 [rawcaret2].rawcaret2Flow.CPU_LITE @764a5a61]
 [event: 058f6a90-6543-11e9-9d99-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 "{\n  "myRawData": "5403e5a202c594871d59898b13054be5"\n}"

INFO  2019-04-22 14:10:14,540 [[MuleRuntime].cpuLight.08:
 [rawcaret2].rawcaret2Flow.CPU_LITE @764a5a61]
 [event: 058f6a90-6543-11e9-9d99-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 { "myRawData": "5403e5a202c594871d59898b13054be5" }
```

The following example uses the HTTP Listener source (`listener`) to get the XML payload received via
a POST request, then uses the Transform Message component (`ee:transform`) to get the encoding value
of the XML payload, by returning the raw data
(`(payload.^raw as String) scan /encoding='([A-z0-9-]+)'/)`). The Logger component (`logger`)
returns the `payload` in a JAVA format.

Mule App XML in Anypoint Studio:

```XML
<http:listener-config name="HTTP_Listener_config" >
    <http:listener-connection host="0.0.0.0" port="8081" />
</http:listener-config>
<flow name="test-flow">
	<http:listener path="/test" config-ref="HTTP_Listener_config"/>
	<ee:transform>
		<ee:message>
		<ee:set-payload ><![CDATA[%dw 2.0
output application/java
---
((payload.^raw as String) scan /encoding='([A-z0-9-]+)'/)[0][1]]]></ee:set-payload>
		</ee:message>
	</ee:transform>
	<logger level="INFO" message="#[payload]"/>
</flow>
```

Using your preferred REST client or API testing tool, send a POST request with the XML body:

```XML
<?xml version='1.0' encoding='ISO-8859-1'?>
<test>
</test>
```

The Logger message returns the extracted encoding value `ISO-8859-1`:

Console Output in Anypoint Studio:

```txt
INFO  2021-05-12 12:25:41,618 [[MuleRuntime].uber.03: [xmlmodule].Flow.CPU_INTENSIVE @de48fc8] [processor: Flow/processors/2; event: 4fe7f6a0-b336-11eb-909c-f01898ad2638] org.mule.runtime.core.internal.processor.LoggerMessageProcessor: ISO-8859-1
```

### Custom Metadata Selector (.^myCustomMetadata)

Returns the value of custom metadata. Metadata can be associated with any value by using the `as`
operator.

The following example uses `userName.^myCustomMetadata` to return the value of custom metadata that
is defined as a variable (named `userName`) in the header of the script as a DataWeave script. For
comparison, the example also returns the value of `userName`.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
var userName = "DataWeave" as String {myCustomMetadata: "customMetadataValue"}
---

{
  "valueOfVariableMetaData" :  userName.^myCustomMetadata,
  "valueOfVariable" :  userName,
}
```

The output of the script is `"customMetadataValue"` for the value of the custom metadata and
`"DataWeave"` for value of the `userName` variable.

Output JSON:

```json
{
  "valueOfVariableMetaData": "customMetadataValue",
  "valueOfVariable": "DataWeave"
}
```

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.3/dataweave-selectors)

- [DataWeave Quickstart](https://docs.mulesoft.com/dataweave/2.3/dataweave-quickstart)

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.3/dataweave-types)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook)

<!-- document id=669d1e23e8230078a108555175f236a1f1f493a6adc49be1bf8093423623c10d url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook-extract-data.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, transform, transformer, metadata, dataweave, data weave, datawave, datamapper, dwl, dfl, dw, payload, attribute, variable, flow, error, message
---

# Extract Data

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave can select data from DataWeave objects and arrays, variables that store that data, and the
output of DataWeave functions when that output is an array or object.

More precisely, a DataWeave selector operates within a context, which can be a reference to the
variable that stores the data, an object literal, an array literal, or the invocation of a DataWeave
function. You can use selectors in Mule modules, connectors, and components that accept DataWeave
expressions.

When DataWeave processes a selector, it sets a new context (or scope) for subsequent selectors, so
you can navigate through the complex structures of arrays and objects using chains of selectors. The
depth of the selection is limited only by the depth of the current context.

Supported variable references are [Mule Runtime variables](https://docs.mulesoft.com/dataweave/2.4/dataweave-variables-context), such as
`payload` and `attributes`, and [DataWeave variables](https://docs.mulesoft.com/dataweave/2.4/dataweave-variables) that store arrays or
objects. A simple example is `payload.myKey` where the payload is the object `{"myKey" : 1234 }`, so
the result is `1234`.

A selector can act on the invocation of a function, such as the DataWeave `read` function. For
example, `read('{"A":"B"}','application/json')."A"` returns `"B"`.

## Use Selectors on DataWeave Arrays and Objects

In DataWeave, selectors extract values from within a DataWeave object (such as
`{ myKey : "myValue" }`) or array (such as `[1,2,3,4]` or
`[ { "myKey" : "1234" }, { "name" : "somebody" } ]`).

The following DataWeave script uses the single-value selector (`.`) to retrieve values from the
object and array defined by the variables `myObject` and `myArray`.

DataWeave Script:

```dataweave
%dw 2.0
var myObject = { "myKey" : "1234", "name" : "somebody" }
var myArray = [ { "myKey" : "1234" }, { "name" : "somebody" } ]
output application/json
---
{
    selectingValueUsingKeyInObject : myObject.name,
    selectingValueUsingKeyOfObjectInArray : myArray.name,
}
```

Output JSON:

```json
{
  "selectingValueUsingKeyInObject": "somebody",
  "selectingValueUsingKeyOfObjectInArray": ["somebody"]
}
```

As the Output shows:

- `myObject.name` returns the value `"somebody"`

- `myArray.name` returns the array `[ "somebody" ]`

## Selector Quick Reference

Single Value (`.`)

Acts on arrays and objects to return the value of a matching key. The syntax is `.myKey`. To
retrieve values of duplicate keys in a DataWeave _object_, use `*`, instead. For examples, see
[Single-Value Selector (.myKey)](#single_value).

Multiple Values (`*`)

Acts on arrays and objects to retrieve the values of all matching keys at a single level in the
hierarchy of a data structure. The syntax is `*myKey`. For the values of all duplicate keys at lower
levels in the hierarchy, use the descendants selector (`..`), instead. For examples, see
[Multi-Value Selector (`.*`)](#multi_value).

Key-Value Pair (`&`)

Acts on arrays and objects. Instead of returning the value of the DataWeave object, this selector
returns the entire DataWeave object, both key and value. The syntax is `.&myKey`. For examples, see
[Key-Value Pair Selector (`.&myKey`)](#key_value).

Descendants (`..`)

Acts on arrays and objects to retrieve all matching keys from arrays and objects below the given
key, regardless of their location in the hierarchy. The syntax is `..myKey` For examples, see
[Descendants Selector (`..myKey`)](#descendants).

Index (`[]`)

Returns the value at the specified index of an array. An example is the `[0]` at the end of
`["a","b","c"][0]`, which returns `"a"`. For examples, see [Index Selector (`[anIndex]`)](#index).

Range `[index1 to index2]`

Returns an array with values of the selected indices. An example is the `[2 to 3]` at the end of
`["a","b","c","d"][2 to 3]`, which returns `["c","d"]`. For examples, see
[Range selector (`anIndex to anotherIndex`)](#range).

XML attribute (`.@myKey`)

Returns the value of a selected key for an XML attribute. For an example, see
[XML Attribute Selector (`.@myKey`)](#xml_attribute).

Namespace Selector (`myKey.#`)

Returns the `xmlns` namespace from the element that also contains the selected key. For an example,
see [Namespace Selector (`#`)](#namespace).

Selector Modifiers (`?` and `!`)

`?` and `!` check for the specified key. `?` returns `true` or `false`. `!` returns an error if the
key is not present. For examples, see [Selector Modifiers (`!`, `?`)](#selector_modifiers).

Filter Selectors (`myKey[?(booleanExpression)]`)

Returns the selected items if the Boolean expression returns `true` and the specified `key` is
present. It returns `null` if the expression is false or the key is not present. For examples, see
[Filter Selectors (`myKey[?($ == "aValue")]`)](#filter_selectors).

Metadata Selector `.^someMetadata`

Returns the value of specified metadata for a Mule payload, variable, or attribute. The selector can
return the value of class (`.^class`), content length (`.^contentLength`), encoding (`.^encoding`),
MIME type (`.^mimeType`), media type (`.^mediaType`), raw (`.^raw`), and custom
(`.^myCustomMetadata`) metadata. For details, see
[Metadata Selector (.^someMetadata)](#metadata_selector).

## Key and Selector Syntax

In DataWeave, quotes around the name of an object’s key are required in some cases but optional in
others. Though a key is not an identifier, if the key name meets the criteria of a
[valid identifier name](https://docs.mulesoft.com/dataweave/2.4/dataweave-language-introduction#valid-identifiers), quotes around the key
are optional. If the key does not meet this criteria, you _must_ surround the key in quotes. For
example, to correct the key syntax in `{ some-name : "somebody" }`, you can use
`{ "some-name" : "somebody" }` or `{ 'some-name' : "somebody" }`. Without quotes, the key in
`{ some-name : "somebody" }` produces the error `Invalid input '-', expected Namespace`.

If you are using a selector on a key that requires quotes, you must also surround the selector in
quotes. For example, the selector `"some-name"` in `{ "some-name" : "somebody" }."some-name"` works,
but the selector `some-name` in `{ "some-name" : "somebody" }.some-name` produces the error
`Unable to resolve reference of: name` because the selector is not surrounded in quotes.

Quotes around a selector are optional if you are using a selector on a key that does not require the
quotes. For example, all of these examples work:

- `{"name" : "somebody"}.name`

- `{"name" : "somebody"}."name"`

- `{name : "somebody"}.name`

- `{name : "somebody"}."name"`

## Single-Value Selector (.myKey)

`.myKey` selectors work over an object or array to return the value of a matching key.

### Single-Value Selector Over an Object

For an object, the single-value selector returns the value of the matching key. For example, in the
following script, `myObject.user` returns `"a"`.

DataWeave Script:

```dataweave
%dw 2.0
var myObject = { user : "a" }
output application/json
---
{ myObjectExample : myObject.user }
```

Output JSON:

```json
{
  "myObjectExample": "a"
}
```

When operating on a DataWeave _object_ (not an array), the `.` selector only returns the value of
the _first_ matching key, even if the object contains multiple matching keys, for example:

DataWeave Script:

```dataweave
%dw 2.0
var myObject = { user : "a", "user" : "b" }
output application/json
---
{ myObjectExample : myObject.user }
```

Output JSON:

```json
{
  "myObjectExample": "a"
}
```

To return the values of multiple matching keys in cases like this, see
[Multi-Value Selector (`.*`)](#multi_value).

In the next example, `payload.people.person.address` returns the value of the `address` element. (It
also uses the `output` directive to transform the JSON input to XML.)

DataWeave Script:

```dataweave
%dw 2.0
var myData = {
  "people": {
    "size" : 1,
    "person": {
      "name": "Nial",
      "address": {
        "street": {
          "name": "Italia",
          "number": 2164
        },
        "area": {
          "zone": "San Isidro",
          "name": "Martinez"
        }
      }
    }
  }
}
output application/xml
---
{ myaddresses: myData.people.person.address }
```

Output XML:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<myaddresses>
  <street>
    <name>Italia</name>
    <number>2164</number>
  </street>
  <area>
    <zone>San Isidro</zone>
    <name>Martinez</name>
  </area>
</myaddresses>
```

## Single-Value Selector Over an Array

When acting on an array, the `.` selector returns an array, even if there is only one matching
value. For example, `["a":"b"]."a"` returns `["b"]`.

Note that the `.` selector acts differently on arrays than it acts on objects. Like `.*`, the `.`
selector returns an array with the values of _all matching keys_ at the specified level of the input
array.

DataWeave Script:

```dataweave
%dw 2.0
var myArrayOfKeyValuePairs = [ "aString": "hello", "aNum": 2, "aString" : "world" ]
var myArrayOfObjects = [ { "aString": "hello" }, { "aNum": 2 }, { "aString" : "world" } ]
output application/json
---
{
    myKeyValueExample : myArrayOfKeyValuePairs.aString,
    myObjectExample :  myArrayOfObjects.aString
}
```

Output JSON:

```json
{
  "myKeyValueExample": ["hello", "world"],
  "myObjectExample": ["hello", "world"]
}
```

In the following example, the value of the input variable, `myData`, is an array that contains two
objects. The selector navigates both objects and returns the values of both `street` keys.

DataWeave Script:

```dataweave
%dw 2.0
var myData = {
  "people": [
    {
      "person": {
        "name": "Nial",
        "address": {
          "street": {
            "name": "Italia",
            "number": 2164
          },
          "area": {
            "zone": "San Isidro",
            "name": "Martinez"
          }
        }
      }
    },
    {
      "person": {
        "name": "Coty",
        "address": {
          "street": {
            "name": "Monroe",
            "number": 323
          },
          "area": {
            "zone": "BA",
            "name": "Belgrano"
          }
        }
      }
    }
  ]
}
output application/json
---
myData.people.person.address.street
```

Output JSON:

```json
[
  {
    "name": "Italia",
    "number": 2164
  },
  {
    "name": "Monroe",
    "number": 323
  }
]
```

## Multi-Value Selector (`.*`)

`.*` traverses objects and arrays to select the values of all matching keys and returns matching
results in an array.

### Multi-Value Selector Over an Object

`.*` returns an array with all the values whose key matches the expression.

The following example returns the values of all `user` elements from the input payload.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
payload.users.*user
```

Input XML Payload:

```xml
<users>
  <user>Mariano</user>
  <user>Martin</user>
  <user>Leandro</user>
</users>
```

Output JSON:

```json
["Mariano", "Martin", "Leandro"]
```

### Multi-Value Selector Over an Array

On arrays, `.*` works the same way as the single-value selector (`.`). For example,
`payload.people.person.address.*street` and the example `payload.people.person.address.street` (from
[Single-Value Selector Over an Array](#single_value_array)) return the same results.

DataWeave Script:

```dataweave
%dw 2.0
var myArrayOfKeyValuePairs = [ "aString": "hello", "aNum": 2, "aString" : "world" ]
var myArrayOfObjects = [ { "aString": "hello" }, { "aNum": 2 }, { "aString" : "world" } ]
output application/json
---
{
    myKeyValueExample : myArrayOfKeyValuePairs.*aString,
    myObjectExample :  myArrayOfObjects.*aString
}
```

Output JSON:

```json
{
  "myKeyValueExample": ["hello", "world"],
  "myObjectExample": ["hello", "world"]
}
```

## Descendants Selector (`..myKey`)

The `..` selector acts on arrays and objects.

This selector applies to the context using the form `..myKey`, and it retrieves the values of all
matching key-value pairs in the sub-tree under the selected context. Regardless of the hierarchical
structure of the fields, the output is returned at the same level.

In this example, all of the fields that match the key `name` are placed in a list called `names`
regardless of their cardinality in the tree of the input data.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{ names: payload.people..name }
```

Input JSON Payload:

```json
{
  "people": {
    "person": {
      "name": "Nial",
      "address": {
        "street": {
          "name": "Italia",
          "number": 2164
        },
        "area": {
          "zone": "San Isidro",
          "name": "Martinez"
        }
      }
    }
  }
}
```

Output JSON:

```json
{
  "names": ["Nial", "Italia", "Martinez"]
}
```

## Key-Value Pair Selector (`.&myKey`)

The `&` selector acts on arrays and objects. `&` retrieves both the keys and values of all matching
keys pairs in the current context. These are returned as an object, containing the retrieved keys
and values.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
{
  users: payload.users.&user
}
```

Input XML Payload:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<users>
  <user>Mariano</user>
  <user>Martin</user>
  <user>Leandro</user>
  <admin>Admin</admin>
  <admin>org_owner</admin>
</users>
```

Output XML:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<users>
  <user>Mariano</user>
  <user>Martin</user>
  <user>Leandro</user>
</users>
```

Note that unlike the multi-value selector, the output of this selector is an object, where the
original keys for each value are also extracted.

### Select All the Descendant Key-Value Pairs

This example uses the `..` and `&` selectors in `myVar.people..&name` to select and return an array
that contains all descendant objects from `myData` input that contain the key `name`. It also
transforms the JSON input to XML output.

DataWeave Script:

```dataweave
%dw 2.0
var myData = {
  "people": {
    "person": {
      "name": "Nial",
      "address": {
        "street": {
          "name": "Italia",
          "number": 2164
        },
        "area": {
          "zone": "San Isidro",
          "name": "Martinez"
        }
      }
    }
  }
}
output application/xml
---
names: {(myData.people..&name)}
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<names>
  <name>Nial</name>
  <name>Italia</name>
  <name>Martinez</name>
</names>
```

## Index Selector (`[anIndex]`)

The index selector returns the element at the specified position. It can be applied over an array,
object, or string.

### Index Selector Over an Array

This selector can be applied to String literals, Arrays and Objects. In the case of Objects, the
value of the key-value pair found at the index is returned. In the case of Arrays, the value of the
element is returned. The index is zero-based.

1.  If the index is bigger or equal to 0, it starts counting from the beginning.

2.  If the index is negative, it starts counting from the end where -1 is the last element.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
payload.people[1]
```

Input JSON Payload:

```json
{
  "people": [
    {
      "nameFirst": "Nial",
      "nameLast": "Martinez"
    },
    {
      "nameFirst": "Coty",
      "nameLast": "Belgrano"
    }
  ]
}
```

Output JSON:

```json
{
  "nameFirst": "Coty",
  "nameLast": "Belgrano"
}
```

### Index Selector Over an Object

The selector returns the value of the key-value pair at the specified position.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
payload[1]
```

Input JSON Payload:

```json
{
  "nameFirst": "Mark",
  "nameLast": "Nguyen"
}
```

Output JSON:

```json
"Nguyen"
```

### Index Selector Over a String

When using the Index Selector with a string, the string is broken down into an array, where each
character is an index.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{ name: "MuleSoft"[0] }
```

Output JSON:

```json
{ "name": "M" }
```

The selector picks the character at a given position, treating the string as an array of characters.

1.  If the index is bigger or equal to 0, it starts counting from the beginning.

2.  If the index is negative, it starts counting from the end.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{ name: "Emiliano"[0] }
```

Output JSON:

```json
{ "name": "E" }
```

## Range selector (`anIndex to anotherIndex`)

The `to` selector returns values of matching indices in an array or string. You can also use it to
reverse the order of the indices in the range. The selector treats characters in the string as
indices.

- Selecting an index from an array:

  - `[1,2,3,4][0]` returns `1`

    The index of the first element in an array is always `0`.

  - `[1,2,3,4][3]` returns `4`

### Range Selector Over an Array

Range selectors limit the output to only the elements specified by the range on that specific order.
This selector allows you to slice an array or even invert it.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
  slice: [0,1,2][0 to 1],
  last: [0,1,2][-1 to 0]
}
```

Output JSON:

```json
{
  "slice": [0, 1],
  "last": [2, 1, 0]
}
```

### Range Selector Over a String

The Range selector limits the output to only the elements specified by the range on that specific
order, treating the string as an array of characters. This selector enables you to slice a string or
invert it.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
  slice: "DataWeave"[0 to 1],
  middle : "superfragilisticexpialadocious"[10 to 13],
  last: "DataWeave"[-1 to 0]
}
```

Output JSON:

```json
{
  "slice": "Da",
  "middle": "list",
  "last": "evaeWataD"
}
```

## XML Attribute Selector (`.@myKey`)

`.@myKey` selects an attribute in an XML element.

Using `.@` without the key name returns an object containing the attributes as key-value pairs.

This DataWeave example reads an XML sample into a variable and uses `@` to select attributes from
the XML.

DataWeave Script:

```dataweave
%dw 2.0
var myVar = read('<product id="1" type="electronic">
  <brand>SomeBrand</brand>
</product>', 'application/xml')
output application/json
---
{
  item: [
  	{
      "type" : myVar.product.@."type",
      "name" : myVar.product.brand,
      "attributes": myVar.product.@
    }
  ]
}
```

Output JSON:

```json
{
  "item": [
    {
      "type": "electronic",
      "name": "SomeBrand",
      "attributes": {
        "id": "1",
        "type": "electronic"
      }
    }
  ]
}
```

## Namespace Selector (`#`)

`#` returns the XML namespace of a selected key as plain text.

DataWeave Script:

```dataweave
%dw 2.0
output text/plain
---
payload.order.#
```

Input XML Payload:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<ns0:order xmlns:ns0="http://orders.company.com">
  <name>Mark</name>
  <items>42</items>
  <orderdate>2017-01-04</orderdate>
</ns0:order>
```

Output Text:

```json
"http://orders.company.com"
```

## Selector Modifiers (`!`, `?`)

You can check for the presence of a given key.

- `!` evaluates the selection and fails with an exception message if the key is not present.

- `?` returns `true` if the selected key is present, `false` if not. Note that `?` is also used in
  [Filter Selectors (`myKey[?($ == "aValue")]`)](#filter_selectors).

### Assert Present Validator

`!` returns an error if any of the specified key is missing.

- `{ "name": "Annie" }.lastName!` returns an error with the message,
  `There is no key named 'lastName'`.

- Without the `!`, `{ "name": "Annie" }.lastName` returns `null`.

- When the key is present, `{ "name": "Annie" }.name!` the result is `"Annie"`.

### Key Present Validator

Returns `true` if the specified key is present in the object or as an attribute of an XML element.

This example returns `true` because the `name` key does exists.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
present: payload.name?
```

Input JSON Payload:

```json
{ "name": "Annie" }
```

Output XML:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<present>true</present>
```

`?` also works with XML attributes:

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
  item: {
    typePresent : payload.product.@."type"?
  }
}
```

Input XML Payload:

```xml
<product id="1" type="tv">
  <brand>Samsung</brand>
</product>
```

Output JSON:

```json
{
  "item": { "typePresent": true }
}
```

## Filter Selectors (`myKey[?($ == "aValue")]`)

`myKey[?($ == "aValue")]` returns only the values of matching keys within an array or object. Note
that `?` is also used in [Key Present Validator](#key_present). If no key-value pairs match, the
result is `null`.

The following example inputs the array of `name` keys returned by `*.name`, then checks for `name`
keys with the value `"Mariano"`. It filters out any values that do not match. Note that the `$`
references the value of the selected key.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{ users: payload.users.*name[?($ == "Mariano")] }
```

Input XML Payload:

```xml
<users>
  <name>Mariano</name>
  <name>Luis</name>
  <name>Mariano</name>
</users>
```

Output JSON:

```json
{
  "users": ["Mariano", "Mariano"]
}
```

The following example assumes the same [input](#input_filter_selectors) and returns all the
key-value pairs of the input because the expression `( 1 == 1 )` is true. Note that a false
expression, such as `( 1 == 2 )`, returns `null`.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{ users: payload.users.*name[?( 1 == 1)] }
```

Input XML Payload:

```xml
<users>
  <name>Mariano</name>
  <name>Luis</name>
  <name>Mariano</name>
</users>
```

Output JSON:

```json
{
  "users": ["Mariano", "Luis", "Mariano"]
}
```

The following example assumes the same [input](#input_filter_selectors). It uses `mapObject` to
iterate over the entire input object and return matching key-value pairs, filtering out any pairs
that do not match.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
payload mapObject { ($$) : $[?($=="Mariano")] }
```

Input XML Payload:

```xml
<users>
  <name>Mariano</name>
  <name>Luis</name>
  <name>Mariano</name>
</users>
```

Output JSON:

```json
{
  "users": {
    "name": "Mariano",
    "name": "Mariano"
  }
}
```

## Metadata Selector (.^someMetadata)

Returns the value of specified metadata for a Mule payload, variable, or attribute. The selector can
return the following metadata:

- Content length metadata: `.^contentLength` returns the content length of the value, if the value
  is present. For an example, see
  [Content Length Metadata Selector (.^contentLength)](#caret_contentlength).

- Class metadata: `.^class` returns the class of the Plain Old Java Object (POJO). For example,
  `{ "string" : payload.string.^class }` might return `{ "string": "java.lang.String" }` if the
  input payload defines a Java string, such as `simplePojo.string = "myString"`, in a simple POJO,
  and `{ "date" : payload.date.^class }` might return `{ "date": "java.util.Date" }`. For an
  example, see [Class Metadata Selector (.^class)](#caret_class).

- Encoding metadata: `.^encoding` returns the encoding of a value. For example,
  `{ "myEncoding" : payload.^encoding }` might return `{"myEncoding": "UTF-8"}` for an input POJO.
  For an example, see [Encoding Metadata Selector (.^encoding)](#caret_encoding).

- Media Type Selector: `.^mediaType` returns the MIME type of a value that includes parameters, for
  example, `application/json;charset=UTF-16`, and the expression in the value of
  `{ "myMediaType" : payload.^mediaType }` might return `"myMediaType": "**/**; charset=UTF-8"` for
  an input POJO. For an example, see [Media Type Metadata Selector (.^mediaType)](#caret_mediatype).

- MIME Type metadata: `.^mimeType` returns the MIME type (without parameters) of a value, for
  example, `application/json`, and `{ "myMimeType" : payload.^mimeType }` might return
  `{ "myMediaType": "**/**" }` for an input POJO. For an example, see
  [MIME Type Metadata Selector (.^mimeType)](#caret_mimetype).

- Raw metadata: `.^raw` returns the underlying data (typically, a binary value) of a plain old Java
  object (POJO). This selector is sometimes used when calculating an MD5 for hashes when checking
  for man-in-the-middle attacks. For examples, see [Raw Metadata Selector (.^raw)](#caret_raw).

- Custom metadata: `.^myCustomMetadata` returns the value of custom metadata. For examples, see
  [Custom Metadata Selector (.^myCustomMetadata)](#caret_custom_metadata).

### Content Length Metadata Selector (.^contentLength)

Returns the content length of the value, if the value is present.

In the following Mule app flow, the Logger uses `payload.^contentLength` to select the length of the
string `my string`, set in the Set Payload (`set-payload`) component.

Mule App XML in Anypoint Studio:

```XML
<flow name="setpayloadobjectFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="15" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <!-- Set the payload to "my string". -->
  <set-payload value='"my string"' doc:name="Set Payload" />
  <!-- Select the class to which "my string" belongs. -->
  <logger level="INFO" doc:name="Logger" message="#[payload.^contentLength]"/>
</flow>
```

The Studio console output shows that the length of the input string (`my string`) is eleven (`9`)
characters long. The length includes the blank space in the string.

Console Output in Anypoint Studio:

```txt
INFO  2019-05-07 16:59:33,690 [[MuleRuntime].cpuLight.07:
 [carets].caretsFlow.CPU_LITE @39f1dbde]
 [event: 28ce97a0-7124-11e9-acfe-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 11
```

### Class Metadata Selector (.^class)

Returns the class of the Plain Old Java Object (POJO). The value might result from calling a method
in a Java class or have a data type (such as `String` or `DateTime`) that DataWeave treats as a Java
value, for example:

- `{ "string" : payload.mystring.^class }` might return `{ "mystring": "java.lang.String" }` if the
  input payload defines a Java string, such as `simplePojo.string = "myString"`, in a simple POJO.

- `{ "mydate" : payload.mydate.^class }` might return `{ "mydate": "java.util.Date" }`.

In the following Mule app flow, the Logger uses `payload.^class` to select the Java class of
`"my string"`, set in the Set Payload (`set-payload`) component.

Mule App XML in Anypoint Studio:

```XML
<flow name="setpayloadobjectFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="15" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <!-- Set the payload to "my string". -->
  <set-payload value='"my string"' doc:name="Set Payload" />
  <!-- Select the class to which "my string" belongs. -->
  <logger level="INFO" doc:name="Logger" message="#[payload.^class]"/>
</flow>
```

The Studio console output shows that the payload string belongs to the class `java.lang.String`.

Console Output in Anypoint Studio:

```txt
INFO  2019-04-20 16:10:03,075 [[MuleRuntime].cpuLight.08:
 [setpayloadobject].setpayloadobjectFlow.CPU_LITE @6447187e]
 [event: 6da29400-63c1-11e9-98e0-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 java.lang.String
```

### Encoding Metadata Selector (.^encoding)

Returns the encoding of a value. For example, `{ "myEncoding" : payload.^encoding }` might return
`{"myEncoding": "UTF-8"}` for an input POJO.

In the following Mule app flow, the Logger uses `payload.^encoding` to select the encoding of
``"my string"`set in the Set Payload (`set-payload``) component. The Scheduler (`scheduler`)
component is simply an event source that regularly generates a new Mule event to hold the payload
set in Set Payload.

Mule App XML in Anypoint Studio:

```XML
<flow name="setpayloadobjectFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="15" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <!-- Set the payload to "my string". -->
  <set-payload value='"my string"' doc:name="Set Payload" />
  <!-- Select the encoding of "my string". -->
  <logger level="INFO" doc:name="Logger" message="#[payload.^encoding]"/>
</flow>
```

The Studio console output shows that the payload string has `UTF-8` encoding.

Console Output in Anypoint Studio:

```txt
INFO  2019-04-20 16:14:24,222 [[MuleRuntime].cpuLight.03:
 [setpayloadobject].setpayloadobjectFlow.CPU_LITE @62bea6a6]
 [event: 0938bf70-63c2-11e9-98e0-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 UTF-8
```

### Media Type Metadata Selector (.^mediaType)

Returns the MIME type of a value that includes parameters (for example,
`application/json;charset=UTF-16`). The expression in the value of
`{ "myMediaType" : payload.^mediaType }` might return `"myMediaType": "**/**; charset=UTF-8"` for an
input POJO.

In the following Mule app flow, the Logger uses `payload.^mediaType` to select the media type of
`2014-10-12T11:11:19-00:03` set in the Set Payload (`set-payload`) component.

Mule App XML in Anypoint Studio:

```XML
<flow name="setpayloadobjectFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="15" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <set-payload value='#[|2014-10-12T11:11:19-00:03| as DateTime]' doc:name="Set Payload" />
  <logger level="INFO" doc:name="Logger" message="#[payload.^mediaType]"/>
</flow>
```

The Studio console output shows that the `DateTime` payload has the
`application/java; charset=UTF-8` media type.

Console Output in Anypoint Studio:

INFO 2019-04-20 16:41:01,276 \[\[MuleRuntime\].cpuLight.04:
\[setpayloadobject\].setpayloadobjectFlow.CPU\_LITE @7e991c71\] \[event:
c0e96860-63c5-11e9-bcff-8c8590a99d48\]
rg.mule.runtime.core.internal.processor.LoggerMessageProcessor: application/java; charset=UTF-8

In the following Mule app flow, the Loggers use `payload.^mediaType` to select a string
`"my string"`, then to select a string that is set within an **fx** expression
(`#["my string as String type" as String]`) in the Set Payload (`set-payload`) component.

Mule App XML in Anypoint Studio:

```XML
<flow name="setpayloadobjectFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="15" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <!-- Set the payload to "my string". -->
  <set-payload value='"my string"' doc:name="Set Payload" />
  <!-- Select the media type of "my string". -->
  <logger level="INFO" doc:name="Logger" message='#[payload.^mediaType]'/>
  <!-- Set the payload using the fx expression "my string" as String. -->
  <set-payload value='#["my string as String type" as String]' doc:name="Set Payload" />
  <!-- Select the media type of a Java string. -->
  <logger level="INFO" doc:name="Logger" message='#[payload.^mediaType]'/>
</flow>
```

The Studio console output shows that the simple string has the media type `**/**`, while the string
that is set in the **fx** expression has the media type `application/java; charset=UTF-8`.

Console Output in Anypoint Studio:

```txt
INFO  2019-04-20 16:52:50,801 [[MuleRuntime].cpuLight.01:
 [setpayloadobject].setpayloadobjectFlow.CPU_LITE @5d914abe]
 [event: 68121cd0-63c7-11e9-bcff-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 */*

INFO  2019-04-20 16:52:51,085 [[MuleRuntime].cpuLight.01:
 [setpayloadobject].setpayloadobjectFlow.CPU_LITE @5d914abe]
 [event: 68121cd0-63c7-11e9-bcff-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 application/java; charset=UTF-8
```

### MIME Type Metadata Selector (.^mimeType)

Returns the MIME type (without parameters) of a value, for example, `application/json`, and
`{ "myMimeType" : payload.^mimeType }` might return `{ "myMediaType": "**/**" }` for an input POJO.

In the following Mule app flow, the Loggers use `payload.^mimeType` to select a string
`"my string"`, then to select a string that is set within an **fx** expression
(`#["my string as String type" as String]`) in the Set Payload (`set-payload`) component.

Mule App XML in Anypoint Studio:

```XML
<flow name="setpayloadobjectFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="15" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <!-- Set the payload to "my string". -->
  <set-payload value='"my string"' doc:name="Set Payload" />
  <!-- Select the MIME type of "my string". -->
  <logger level="INFO" doc:name="Logger" message='#[payload.^mimeType]'/>
  <!-- Set the payload using the fx expression "my string" as String. -->
  <set-payload value='#["my string as String type" as String]' doc:name="Set Payload" />
  <!-- Select the MIME type of a Java string. -->
  <logger level="INFO" doc:name="Logger" message='#[payload.^mimeType]'/>
</flow>
```

The Studio console output shows that the simple string has the MIME type `**/**`, while the string
that is set in the **fx** expression has the MIME type `application/java`.

Console Output in Anypoint Studio:

```txt
INFO  2019-04-20 17:02:07,762 [[MuleRuntime].cpuLight.06:
 [setpayloadobject].setpayloadobjectFlow.CPU_LITE @2d6f64b9]
 [event: b4097b00-63c8-11e9-bcff-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 */*

INFO  2019-04-20 17:02:08,029 [[MuleRuntime].cpuLight.06:
 [setpayloadobject].setpayloadobjectFlow.CPU_LITE @2d6f64b9]
 [event: b4097b00-63c8-11e9-bcff-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 application/java
```

### Raw Metadata Selector (.^raw)

Returns the underlying binary value of a POJO. This selector is sometimes used when calculating an
MD5 or some other cryptographic hash function to check for man-in-the-middle (MITM) attacks.

The following example uses the Set Payload component (`set-payload`) to produce a binary value, then
uses the Transform Message component (`ee:transform`) component to return raw data for the MD5
(`MD5(payload.^raw)`) of the binary value. The Logger component (`logger`) is also set to write the
raw data to the Studio console. For comparison, the second Logger returns the typical `payload` in a
standard JSON format.

Mule App XML in Anypoint Studio:

```XML
<flow name="rawcaret2Flow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="30" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <set-payload value='#["1234-5678-9123" as Binary]' doc:name="Set Payload" />
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
import * from dw::Crypto
output application/json
---
{ "myRawData" : MD5(payload.^raw) }]]></ee:set-payload>
    </ee:message>
  </ee:transform>
  <logger level="INFO" doc:name="Logger" message="#[payload.^raw]"/>
  <logger level="INFO" doc:name="Logger" message="#[payload]"/>
</flow>
```

Notice that instead of producing standard JSON output, the raw output in the Logger message
surrounds the entire payload in double-quotes and inserts new line characters (`\n`) for each new
line.

Console Output in Anypoint Studio:

```txt
INFO  2019-04-22 14:10:14,537 [[MuleRuntime].cpuLight.08:
 [rawcaret2].rawcaret2Flow.CPU_LITE @764a5a61]
 [event: 058f6a90-6543-11e9-9d99-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 "{\n  "myRawData": "5403e5a202c594871d59898b13054be5"\n}"

INFO  2019-04-22 14:10:14,540 [[MuleRuntime].cpuLight.08:
 [rawcaret2].rawcaret2Flow.CPU_LITE @764a5a61]
 [event: 058f6a90-6543-11e9-9d99-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 { "myRawData": "5403e5a202c594871d59898b13054be5" }
```

The following example uses the HTTP Listener source (`listener`) to get the XML payload received via
a POST request, then uses the Transform Message component (`ee:transform`) to get the encoding value
of the XML payload, by returning the raw data
(`(payload.^raw as String) scan /encoding='([A-z0-9-]+)'/)`). The Logger component (`logger`)
returns the `payload` in a JAVA format.

Mule App XML in Anypoint Studio:

```XML
<http:listener-config name="HTTP_Listener_config" >
    <http:listener-connection host="0.0.0.0" port="8081" />
</http:listener-config>
<flow name="test-flow">
	<http:listener path="/test" config-ref="HTTP_Listener_config"/>
	<ee:transform>
		<ee:message>
		<ee:set-payload ><![CDATA[%dw 2.0
output application/java
---
((payload.^raw as String) scan /encoding='([A-z0-9-]+)'/)[0][1]]]></ee:set-payload>
		</ee:message>
	</ee:transform>
	<logger level="INFO" message="#[payload]"/>
</flow>
```

Using your preferred REST client or API testing tool, send a POST request with the XML body:

```XML
<?xml version='1.0' encoding='ISO-8859-1'?>
<test>
</test>
```

The Logger message returns the extracted encoding value `ISO-8859-1`:

Console Output in Anypoint Studio:

```txt
INFO  2021-05-12 12:25:41,618 [[MuleRuntime].uber.03: [xmlmodule].Flow.CPU_INTENSIVE @de48fc8] [processor: Flow/processors/2; event: 4fe7f6a0-b336-11eb-909c-f01898ad2638] org.mule.runtime.core.internal.processor.LoggerMessageProcessor: ISO-8859-1
```

### Custom Metadata Selector (.^myCustomMetadata)

Returns the value of custom metadata. Metadata can be associated with any value by using the `as`
operator.

The following example uses `userName.^myCustomMetadata` to return the value of custom metadata that
is defined as a variable (named `userName`) in the header of the script as a DataWeave script. For
comparison, the example also returns the value of `userName`.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
var userName = "DataWeave" as String {myCustomMetadata: "customMetadataValue"}
---

{
  "valueOfVariableMetaData" :  userName.^myCustomMetadata,
  "valueOfVariable" :  userName,
}
```

The output of the script is `"customMetadataValue"` for the value of the custom metadata and
`"DataWeave"` for value of the `userName` variable.

Output JSON:

```json
{
  "valueOfVariableMetaData": "customMetadataValue",
  "valueOfVariable": "DataWeave"
}
```

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.4/dataweave-selectors)

- [DataWeave Quickstart](https://docs.mulesoft.com/dataweave/2.4/dataweave-quickstart)

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.4/dataweave-types)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook)

<!-- document id=0a768607a547254e72c98f41a341fa00cffedc00b250304fb67e936c6526d99c url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook-extract-data.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, transform, transformer, metadata, dataweave, data weave, datawave, datamapper, dwl, dfl, dw, payload, attribute, variable, flow, error, message
---

# Extract Data

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave can select data from DataWeave objects and arrays, variables that store that data, and the
output of DataWeave functions when that output is an array or object.

More precisely, a DataWeave selector operates within a context, which can be a reference to the
variable that stores the data, an object literal, an array literal, or the invocation of a DataWeave
function. You can use selectors in Mule modules, connectors, and components that accept DataWeave
expressions.

When DataWeave processes a selector, it sets a new context (or scope) for subsequent selectors, so
you can navigate through the complex structures of arrays and objects using chains of selectors. The
depth of the selection is limited only by the depth of the current context.

Supported variable references are [Mule Runtime variables](https://docs.mulesoft.com/dataweave/2.6/dataweave-variables-context), such as
`payload` and `attributes`, and [DataWeave variables](https://docs.mulesoft.com/dataweave/2.6/dataweave-variables) that store arrays or
objects. A simple example is `payload.myKey` where the payload is the object `{"myKey" : 1234 }`, so
the result is `1234`.

A selector can act on the invocation of a function, such as the DataWeave `read` function. For
example, `read('{"A":"B"}','application/json')."A"` returns `"B"`.

## Use Selectors on DataWeave Arrays and Objects

In DataWeave, selectors extract values from within a DataWeave object (such as
`{ myKey : "myValue" }`) or array (such as `[1,2,3,4]` or
`[ { "myKey" : "1234" }, { "name" : "somebody" } ]`).

The following DataWeave script uses the single-value selector (`.`) to retrieve values from the
object and array defined by the variables `myObject` and `myArray`.

DataWeave Script:

```dataweave
%dw 2.0
var myObject = { "myKey" : "1234", "name" : "somebody" }
var myArray = [ { "myKey" : "1234" }, { "name" : "somebody" } ]
output application/json
---
{
    selectingValueUsingKeyInObject : myObject.name,
    selectingValueUsingKeyOfObjectInArray : myArray.name,
}
```

Output JSON:

```json
{
  "selectingValueUsingKeyInObject": "somebody",
  "selectingValueUsingKeyOfObjectInArray": ["somebody"]
}
```

As the Output shows:

- `myObject.name` returns the value `"somebody"`

- `myArray.name` returns the array `[ "somebody" ]`

## Selector Quick Reference

Single Value (`.`)

Acts on arrays and objects to return the value of a matching key. The syntax is `.myKey`. To
retrieve values of duplicate keys in a DataWeave _object_, use `*`, instead. For examples, see
[Single-Value Selector (.myKey)](#single_value).

Multiple Values (`*`)

Acts on arrays and objects to retrieve the values of all matching keys at a single level in the
hierarchy of a data structure. The syntax is `*myKey`. For the values of all duplicate keys at lower
levels in the hierarchy, use the descendants selector (`..`), instead. For examples, see
[Multi-Value Selector (`.*`)](#multi_value).

Key-Value Pair (`&`)

Acts on arrays and objects. Instead of returning the value of the DataWeave object, this selector
returns the entire DataWeave object, both key and value. The syntax is `.&myKey`. For examples, see
[Key-Value Pair Selector (`.&myKey`)](#key_value).

Descendants (`..`)

Acts on arrays and objects to retrieve all matching keys from arrays and objects below the given
key, regardless of their location in the hierarchy. The syntax is `..myKey` For examples, see
[Descendants Selector (`..myKey`)](#descendants).

Index (`[]`)

Returns the value at the specified index of an array. An example is the `[0]` at the end of
`["a","b","c"][0]`, which returns `"a"`. For examples, see [Index Selector (`[anIndex]`)](#index).

Range `[index1 to index2]`

Returns an array with values of the selected indices. An example is the `[2 to 3]` at the end of
`["a","b","c","d"][2 to 3]`, which returns `["c","d"]`. For examples, see
[Range selector (`anIndex to anotherIndex`)](#range).

XML attribute (`.@myKey`)

Returns the value of a selected key for an XML attribute. For an example, see
[XML Attribute Selector (`.@myKey`)](#xml_attribute).

Namespace Selector (`myKey.#`)

Returns the `xmlns` namespace from the element that also contains the selected key. For an example,
see [Namespace Selector (`#`)](#namespace).

Selector Modifiers (`?` and `!`)

`?` and `!` check for the specified key. `?` returns `true` or `false`. `!` returns an error if the
key is not present. For examples, see [Selector Modifiers (`!`, `?`)](#selector_modifiers).

Filter Selectors (`myKey[?(booleanExpression)]`)

Returns the selected items if the Boolean expression returns `true` and the specified `key` is
present. It returns `null` if the expression is false or the key is not present. For examples, see
[Filter Selectors (`myKey[?($ == "aValue")]`)](#filter_selectors).

Metadata Selector `.^someMetadata`

Returns the value of specified metadata for a Mule payload, variable, or attribute. The selector can
return the value of class (`.^class`), content length (`.^contentLength`), encoding (`.^encoding`),
MIME type (`.^mimeType`), media type (`.^mediaType`), raw (`.^raw`), and custom
(`.^myCustomMetadata`) metadata. For details, see
[Metadata Selector (.^someMetadata)](#metadata_selector).

## Key and Selector Syntax

In DataWeave, quotes around the name of an object’s key are required in some cases but optional in
others. Though a key is not an identifier, if the key name meets the criteria of a
[valid identifier name](https://docs.mulesoft.com/dataweave/2.6/dataweave-language-introduction#valid-identifiers), quotes around the key
are optional. If the key does not meet this criteria, you _must_ surround the key in quotes. For
example, to correct the key syntax in `{ some-name : "somebody" }`, you can use
`{ "some-name" : "somebody" }` or `{ 'some-name' : "somebody" }`. Without quotes, the key in
`{ some-name : "somebody" }` produces the error `Invalid input '-', expected Namespace`.

If you are using a selector on a key that requires quotes, you must also surround the selector in
quotes. For example, the selector `"some-name"` in `{ "some-name" : "somebody" }."some-name"` works,
but the selector `some-name` in `{ "some-name" : "somebody" }.some-name` produces the error
`Unable to resolve reference of: name` because the selector is not surrounded in quotes.

Quotes around a selector are optional if you are using a selector on a key that does not require the
quotes. For example, all of these examples work:

- `{"name" : "somebody"}.name`

- `{"name" : "somebody"}."name"`

- `{name : "somebody"}.name`

- `{name : "somebody"}."name"`

## Single-Value Selector (.myKey)

`.myKey` selectors work over an object or array to return the value of a matching key.

### Single-Value Selector Over an Object

For an object, the single-value selector returns the value of the matching key. For example, in the
following script, `myObject.user` returns `"a"`.

DataWeave Script:

```dataweave
%dw 2.0
var myObject = { user : "a" }
output application/json
---
{ myObjectExample : myObject.user }
```

Output JSON:

```json
{
  "myObjectExample": "a"
}
```

When operating on a DataWeave _object_ (not an array), the `.` selector only returns the value of
the _first_ matching key, even if the object contains multiple matching keys, for example:

DataWeave Script:

```dataweave
%dw 2.0
var myObject = { user : "a", "user" : "b" }
output application/json
---
{ myObjectExample : myObject.user }
```

Output JSON:

```json
{
  "myObjectExample": "a"
}
```

To return the values of multiple matching keys in cases like this, see
[Multi-Value Selector (`.*`)](#multi_value).

In the next example, `payload.people.person.address` returns the value of the `address` element. (It
also uses the `output` directive to transform the JSON input to XML.)

DataWeave Script:

```dataweave
%dw 2.0
var myData = {
  "people": {
    "size" : 1,
    "person": {
      "name": "Nial",
      "address": {
        "street": {
          "name": "Italia",
          "number": 2164
        },
        "area": {
          "zone": "San Isidro",
          "name": "Martinez"
        }
      }
    }
  }
}
output application/xml
---
{ myaddresses: myData.people.person.address }
```

Output XML:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<myaddresses>
  <street>
    <name>Italia</name>
    <number>2164</number>
  </street>
  <area>
    <zone>San Isidro</zone>
    <name>Martinez</name>
  </area>
</myaddresses>
```

## Single-Value Selector Over an Array

When acting on an array, the `.` selector returns an array, even if there is only one matching
value. For example, `["a":"b"]."a"` returns `["b"]`.

Note that the `.` selector acts differently on arrays than it acts on objects. Like `.*`, the `.`
selector returns an array with the values of _all matching keys_ at the specified level of the input
array.

DataWeave Script:

```dataweave
%dw 2.0
var myArrayOfKeyValuePairs = [ "aString": "hello", "aNum": 2, "aString" : "world" ]
var myArrayOfObjects = [ { "aString": "hello" }, { "aNum": 2 }, { "aString" : "world" } ]
output application/json
---
{
    myKeyValueExample : myArrayOfKeyValuePairs.aString,
    myObjectExample :  myArrayOfObjects.aString
}
```

Output JSON:

```json
{
  "myKeyValueExample": ["hello", "world"],
  "myObjectExample": ["hello", "world"]
}
```

In the following example, the value of the input variable, `myData`, is an array that contains two
objects. The selector navigates both objects and returns the values of both `street` keys.

DataWeave Script:

```dataweave
%dw 2.0
var myData = {
  "people": [
    {
      "person": {
        "name": "Nial",
        "address": {
          "street": {
            "name": "Italia",
            "number": 2164
          },
          "area": {
            "zone": "San Isidro",
            "name": "Martinez"
          }
        }
      }
    },
    {
      "person": {
        "name": "Coty",
        "address": {
          "street": {
            "name": "Monroe",
            "number": 323
          },
          "area": {
            "zone": "BA",
            "name": "Belgrano"
          }
        }
      }
    }
  ]
}
output application/json
---
myData.people.person.address.street
```

Output JSON:

```json
[
  {
    "name": "Italia",
    "number": 2164
  },
  {
    "name": "Monroe",
    "number": 323
  }
]
```

## Multi-Value Selector (`.*`)

`.*` traverses objects and arrays to select the values of all matching keys and returns matching
results in an array.

### Multi-Value Selector Over an Object

`.*` returns an array with all the values whose key matches the expression.

The following example returns the values of all `user` elements from the input payload.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
payload.users.*user
```

Input XML Payload:

```xml
<users>
  <user>Mariano</user>
  <user>Martin</user>
  <user>Leandro</user>
</users>
```

Output JSON:

```json
["Mariano", "Martin", "Leandro"]
```

### Multi-Value Selector Over an Array

On arrays, `.*` works the same way as the single-value selector (`.`). For example,
`payload.people.person.address.*street` and the example `payload.people.person.address.street` (from
[Single-Value Selector Over an Array](#single_value_array)) return the same results.

DataWeave Script:

```dataweave
%dw 2.0
var myArrayOfKeyValuePairs = [ "aString": "hello", "aNum": 2, "aString" : "world" ]
var myArrayOfObjects = [ { "aString": "hello" }, { "aNum": 2 }, { "aString" : "world" } ]
output application/json
---
{
    myKeyValueExample : myArrayOfKeyValuePairs.*aString,
    myObjectExample :  myArrayOfObjects.*aString
}
```

Output JSON:

```json
{
  "myKeyValueExample": ["hello", "world"],
  "myObjectExample": ["hello", "world"]
}
```

## Descendants Selector (`..myKey`)

The `..` selector acts on arrays and objects.

This selector applies to the context using the form `..myKey`, and it retrieves the values of all
matching key-value pairs in the sub-tree under the selected context. Regardless of the hierarchical
structure of the fields, the output is returned at the same level.

In this example, all of the fields that match the key `name` are placed in a list called `names`
regardless of their cardinality in the tree of the input data.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{ names: payload.people..name }
```

Input JSON Payload:

```json
{
  "people": {
    "person": {
      "name": "Nial",
      "address": {
        "street": {
          "name": "Italia",
          "number": 2164
        },
        "area": {
          "zone": "San Isidro",
          "name": "Martinez"
        }
      }
    }
  }
}
```

Output JSON:

```json
{
  "names": ["Nial", "Italia", "Martinez"]
}
```

## Key-Value Pair Selector (`.&myKey`)

The `&` selector acts on arrays and objects. `&` retrieves both the keys and values of all matching
keys pairs in the current context. These are returned as an object, containing the retrieved keys
and values.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
{
  users: payload.users.&user
}
```

Input XML Payload:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<users>
  <user>Mariano</user>
  <user>Martin</user>
  <user>Leandro</user>
  <admin>Admin</admin>
  <admin>org_owner</admin>
</users>
```

Output XML:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<users>
  <user>Mariano</user>
  <user>Martin</user>
  <user>Leandro</user>
</users>
```

Note that unlike the multi-value selector, the output of this selector is an object, where the
original keys for each value are also extracted.

### Select All the Descendant Key-Value Pairs

This example uses the `..` and `&` selectors in `myVar.people..&name` to select and return an array
that contains all descendant objects from `myData` input that contain the key `name`. It also
transforms the JSON input to XML output.

DataWeave Script:

```dataweave
%dw 2.0
var myData = {
  "people": {
    "person": {
      "name": "Nial",
      "address": {
        "street": {
          "name": "Italia",
          "number": 2164
        },
        "area": {
          "zone": "San Isidro",
          "name": "Martinez"
        }
      }
    }
  }
}
output application/xml
---
names: {(myData.people..&name)}
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<names>
  <name>Nial</name>
  <name>Italia</name>
  <name>Martinez</name>
</names>
```

## Index Selector (`[anIndex]`)

The index selector returns the element at the specified position. It can be applied over an array,
object, or string.

### Index Selector Over an Array

This selector can be applied to String literals, Arrays and Objects. In the case of Objects, the
value of the key-value pair found at the index is returned. In the case of Arrays, the value of the
element is returned. The index is zero-based.

1.  If the index is bigger or equal to 0, it starts counting from the beginning.

2.  If the index is negative, it starts counting from the end where -1 is the last element.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
payload.people[1]
```

Input JSON Payload:

```json
{
  "people": [
    {
      "nameFirst": "Nial",
      "nameLast": "Martinez"
    },
    {
      "nameFirst": "Coty",
      "nameLast": "Belgrano"
    }
  ]
}
```

Output JSON:

```json
{
  "nameFirst": "Coty",
  "nameLast": "Belgrano"
}
```

### Index Selector Over an Object

The selector returns the value of the key-value pair at the specified position.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
payload[1]
```

Input JSON Payload:

```json
{
  "nameFirst": "Mark",
  "nameLast": "Nguyen"
}
```

Output JSON:

```json
"Nguyen"
```

### Index Selector Over a String

When using the Index Selector with a string, the string is broken down into an array, where each
character is an index.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{ name: "MuleSoft"[0] }
```

Output JSON:

```json
{ "name": "M" }
```

The selector picks the character at a given position, treating the string as an array of characters.

1.  If the index is bigger or equal to 0, it starts counting from the beginning.

2.  If the index is negative, it starts counting from the end.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{ name: "Emiliano"[0] }
```

Output JSON:

```json
{ "name": "E" }
```

## Range selector (`anIndex to anotherIndex`)

The `to` selector returns values of matching indices in an array or string. You can also use it to
reverse the order of the indices in the range. The selector treats characters in the string as
indices.

- Selecting an index from an array:

  - `[1,2,3,4][0]` returns `1`

    The index of the first element in an array is always `0`.

  - `[1,2,3,4][3]` returns `4`

### Range Selector Over an Array

Range selectors limit the output to only the elements specified by the range on that specific order.
This selector allows you to slice an array or even invert it.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
  slice: [0,1,2][0 to 1],
  last: [0,1,2][-1 to 0]
}
```

Output JSON:

```json
{
  "slice": [0, 1],
  "last": [2, 1, 0]
}
```

### Range Selector Over a String

The Range selector limits the output to only the elements specified by the range on that specific
order, treating the string as an array of characters. This selector enables you to slice a string or
invert it.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
  slice: "DataWeave"[0 to 1],
  middle : "superfragilisticexpialadocious"[10 to 13],
  last: "DataWeave"[-1 to 0]
}
```

Output JSON:

```json
{
  "slice": "Da",
  "middle": "list",
  "last": "evaeWataD"
}
```

## XML Attribute Selector (`.@myKey`)

`.@myKey` selects an attribute in an XML element.

Using `.@` without the key name returns an object containing the attributes as key-value pairs.

This DataWeave example reads an XML sample into a variable and uses `@` to select attributes from
the XML.

DataWeave Script:

```dataweave
%dw 2.0
var myVar = read('<product id="1" type="electronic">
  <brand>SomeBrand</brand>
</product>', 'application/xml')
output application/json
---
{
  item: [
  	{
      "type" : myVar.product.@."type",
      "name" : myVar.product.brand,
      "attributes": myVar.product.@
    }
  ]
}
```

Output JSON:

```json
{
  "item": [
    {
      "type": "electronic",
      "name": "SomeBrand",
      "attributes": {
        "id": "1",
        "type": "electronic"
      }
    }
  ]
}
```

## Namespace Selector (`#`)

`#` returns the XML namespace of a selected key as plain text.

DataWeave Script:

```dataweave
%dw 2.0
output text/plain
---
payload.order.#
```

Input XML Payload:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<ns0:order xmlns:ns0="http://orders.company.com">
  <name>Mark</name>
  <items>42</items>
  <orderdate>2017-01-04</orderdate>
</ns0:order>
```

Output Text:

```json
"http://orders.company.com"
```

## Selector Modifiers (`!`, `?`)

You can check for the presence of a given key.

- `!` evaluates the selection and fails with an exception message if the key is not present.

- `?` returns `true` if the selected key is present, `false` if not. Note that `?` is also used in
  [Filter Selectors (`myKey[?($ == "aValue")]`)](#filter_selectors).

### Assert Present Validator

`!` returns an error if any of the specified key is missing.

- `{ "name": "Annie" }.lastName!` returns an error with the message,
  `There is no key named 'lastName'`.

- Without the `!`, `{ "name": "Annie" }.lastName` returns `null`.

- When the key is present, `{ "name": "Annie" }.name!` the result is `"Annie"`.

### Key Present Validator

Returns `true` if the specified key is present in the object or as an attribute of an XML element.

This example returns `true` because the `name` key does exists.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
present: payload.name?
```

Input JSON Payload:

```json
{ "name": "Annie" }
```

Output XML:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<present>true</present>
```

`?` also works with XML attributes:

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
  item: {
    typePresent : payload.product.@."type"?
  }
}
```

Input XML Payload:

```xml
<product id="1" type="tv">
  <brand>Samsung</brand>
</product>
```

Output JSON:

```json
{
  "item": { "typePresent": true }
}
```

## Filter Selectors (`myKey[?($ == "aValue")]`)

`myKey[?($ == "aValue")]` returns only the values of matching keys within an array or object. Note
that `?` is also used in [Key Present Validator](#key_present). If no key-value pairs match, the
result is `null`.

The following example inputs the array of `name` keys returned by `*.name`, then checks for `name`
keys with the value `"Mariano"`. It filters out any values that do not match. Note that the `$`
references the value of the selected key.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{ users: payload.users.*name[?($ == "Mariano")] }
```

Input XML Payload:

```xml
<users>
  <name>Mariano</name>
  <name>Luis</name>
  <name>Mariano</name>
</users>
```

Output JSON:

```json
{
  "users": ["Mariano", "Mariano"]
}
```

The following example assumes the same [input](#input_filter_selectors) and returns all the
key-value pairs of the input because the expression `( 1 == 1 )` is true. Note that a false
expression, such as `( 1 == 2 )`, returns `null`.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{ users: payload.users.*name[?( 1 == 1)] }
```

Input XML Payload:

```xml
<users>
  <name>Mariano</name>
  <name>Luis</name>
  <name>Mariano</name>
</users>
```

Output JSON:

```json
{
  "users": ["Mariano", "Luis", "Mariano"]
}
```

The following example assumes the same [input](#input_filter_selectors). It uses `mapObject` to
iterate over the entire input object and return matching key-value pairs, filtering out any pairs
that do not match.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
payload mapObject { ($$) : $[?($=="Mariano")] }
```

Input XML Payload:

```xml
<users>
  <name>Mariano</name>
  <name>Luis</name>
  <name>Mariano</name>
</users>
```

Output JSON:

```json
{
  "users": {
    "name": "Mariano",
    "name": "Mariano"
  }
}
```

## Metadata Selector (.^someMetadata)

Returns the value of specified metadata for a Mule payload, variable, or attribute. The selector can
return the following metadata:

- Content length metadata: `.^contentLength` returns the content length of the value, if the value
  is present. For an example, see
  [Content Length Metadata Selector (.^contentLength)](#caret_contentlength).

- Class metadata: `.^class` returns the class of the Plain Old Java Object (POJO). For example,
  `{ "string" : payload.string.^class }` might return `{ "string": "java.lang.String" }` if the
  input payload defines a Java string, such as `simplePojo.string = "myString"`, in a simple POJO,
  and `{ "date" : payload.date.^class }` might return `{ "date": "java.util.Date" }`. For an
  example, see [Class Metadata Selector (.^class)](#caret_class).

- Encoding metadata: `.^encoding` returns the encoding of a value. For example,
  `{ "myEncoding" : payload.^encoding }` might return `{"myEncoding": "UTF-8"}` for an input POJO.
  For an example, see [Encoding Metadata Selector (.^encoding)](#caret_encoding).

- Media Type Selector: `.^mediaType` returns the MIME type of a value that includes parameters, for
  example, `application/json;charset=UTF-16`, and the expression in the value of
  `{ "myMediaType" : payload.^mediaType }` might return `"myMediaType": "**/**; charset=UTF-8"` for
  an input POJO. For an example, see [Media Type Metadata Selector (.^mediaType)](#caret_mediatype).

- MIME Type metadata: `.^mimeType` returns the MIME type (without parameters) of a value, for
  example, `application/json`, and `{ "myMimeType" : payload.^mimeType }` might return
  `{ "myMediaType": "**/**" }` for an input POJO. For an example, see
  [MIME Type Metadata Selector (.^mimeType)](#caret_mimetype).

- Raw metadata: `.^raw` returns the underlying data (typically, a binary value) of a plain old Java
  object (POJO). This selector is sometimes used when calculating an MD5 for hashes when checking
  for man-in-the-middle attacks. For examples, see [Raw Metadata Selector (.^raw)](#caret_raw).

- Custom metadata: `.^myCustomMetadata` returns the value of custom metadata. For examples, see
  [Custom Metadata Selector (.^myCustomMetadata)](#caret_custom_metadata).

### Content Length Metadata Selector (.^contentLength)

Returns the content length of the value, if the value is present.

In the following Mule app flow, the Logger uses `payload.^contentLength` to select the length of the
string `my string`, set in the Set Payload (`set-payload`) component.

Mule App XML in Anypoint Studio:

```XML
<flow name="setpayloadobjectFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="15" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <!-- Set the payload to "my string". -->
  <set-payload value='"my string"' doc:name="Set Payload" />
  <!-- Select the class to which "my string" belongs. -->
  <logger level="INFO" doc:name="Logger" message="#[payload.^contentLength]"/>
</flow>
```

The Studio console output shows that the length of the input string (`my string`) is eleven (`9`)
characters long. The length includes the blank space in the string.

Console Output in Anypoint Studio:

```txt
INFO  2019-05-07 16:59:33,690 [[MuleRuntime].cpuLight.07:
 [carets].caretsFlow.CPU_LITE @39f1dbde]
 [event: 28ce97a0-7124-11e9-acfe-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 11
```

### Class Metadata Selector (.^class)

Returns the class of the Plain Old Java Object (POJO). The value might result from calling a method
in a Java class or have a data type (such as `String` or `DateTime`) that DataWeave treats as a Java
value, for example:

- `{ "string" : payload.mystring.^class }` might return `{ "mystring": "java.lang.String" }` if the
  input payload defines a Java string, such as `simplePojo.string = "myString"`, in a simple POJO.

- `{ "mydate" : payload.mydate.^class }` might return `{ "mydate": "java.util.Date" }`.

In the following Mule app flow, the Logger uses `payload.^class` to select the Java class of
`"my string"`, set in the Set Payload (`set-payload`) component.

Mule App XML in Anypoint Studio:

```XML
<flow name="setpayloadobjectFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="15" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <!-- Set the payload to "my string". -->
  <set-payload value='"my string"' doc:name="Set Payload" />
  <!-- Select the class to which "my string" belongs. -->
  <logger level="INFO" doc:name="Logger" message="#[payload.^class]"/>
</flow>
```

The Studio console output shows that the payload string belongs to the class `java.lang.String`.

Console Output in Anypoint Studio:

```txt
INFO  2019-04-20 16:10:03,075 [[MuleRuntime].cpuLight.08:
 [setpayloadobject].setpayloadobjectFlow.CPU_LITE @6447187e]
 [event: 6da29400-63c1-11e9-98e0-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 java.lang.String
```

### Encoding Metadata Selector (.^encoding)

Returns the encoding of a value. For example, `{ "myEncoding" : payload.^encoding }` might return
`{"myEncoding": "UTF-8"}` for an input POJO.

In the following Mule app flow, the Logger uses `payload.^encoding` to select the encoding of
``"my string"`set in the Set Payload (`set-payload``) component. The Scheduler (`scheduler`)
component is simply an event source that regularly generates a new Mule event to hold the payload
set in Set Payload.

Mule App XML in Anypoint Studio:

```XML
<flow name="setpayloadobjectFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="15" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <!-- Set the payload to "my string". -->
  <set-payload value='"my string"' doc:name="Set Payload" />
  <!-- Select the encoding of "my string". -->
  <logger level="INFO" doc:name="Logger" message="#[payload.^encoding]"/>
</flow>
```

The Studio console output shows that the payload string has `UTF-8` encoding.

Console Output in Anypoint Studio:

```txt
INFO  2019-04-20 16:14:24,222 [[MuleRuntime].cpuLight.03:
 [setpayloadobject].setpayloadobjectFlow.CPU_LITE @62bea6a6]
 [event: 0938bf70-63c2-11e9-98e0-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 UTF-8
```

### Media Type Metadata Selector (.^mediaType)

Returns the MIME type of a value that includes parameters (for example,
`application/json;charset=UTF-16`). The expression in the value of
`{ "myMediaType" : payload.^mediaType }` might return `"myMediaType": "**/**; charset=UTF-8"` for an
input POJO.

In the following Mule app flow, the Logger uses `payload.^mediaType` to select the media type of
`2014-10-12T11:11:19-00:03` set in the Set Payload (`set-payload`) component.

Mule App XML in Anypoint Studio:

```XML
<flow name="setpayloadobjectFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="15" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <set-payload value='#[|2014-10-12T11:11:19-00:03| as DateTime]' doc:name="Set Payload" />
  <logger level="INFO" doc:name="Logger" message="#[payload.^mediaType]"/>
</flow>
```

The Studio console output shows that the `DateTime` payload has the
`application/java; charset=UTF-8` media type.

Console Output in Anypoint Studio:

INFO 2019-04-20 16:41:01,276 \[\[MuleRuntime\].cpuLight.04:
\[setpayloadobject\].setpayloadobjectFlow.CPU\_LITE @7e991c71\] \[event:
c0e96860-63c5-11e9-bcff-8c8590a99d48\]
rg.mule.runtime.core.internal.processor.LoggerMessageProcessor: application/java; charset=UTF-8

In the following Mule app flow, the Loggers use `payload.^mediaType` to select a string
`"my string"`, then to select a string that is set within an **fx** expression
(`#["my string as String type" as String]`) in the Set Payload (`set-payload`) component.

Mule App XML in Anypoint Studio:

```XML
<flow name="setpayloadobjectFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="15" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <!-- Set the payload to "my string". -->
  <set-payload value='"my string"' doc:name="Set Payload" />
  <!-- Select the media type of "my string". -->
  <logger level="INFO" doc:name="Logger" message='#[payload.^mediaType]'/>
  <!-- Set the payload using the fx expression "my string" as String. -->
  <set-payload value='#["my string as String type" as String]' doc:name="Set Payload" />
  <!-- Select the media type of a Java string. -->
  <logger level="INFO" doc:name="Logger" message='#[payload.^mediaType]'/>
</flow>
```

The Studio console output shows that the simple string has the media type `**/**`, while the string
that is set in the **fx** expression has the media type `application/java; charset=UTF-8`.

Console Output in Anypoint Studio:

```txt
INFO  2019-04-20 16:52:50,801 [[MuleRuntime].cpuLight.01:
 [setpayloadobject].setpayloadobjectFlow.CPU_LITE @5d914abe]
 [event: 68121cd0-63c7-11e9-bcff-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 */*

INFO  2019-04-20 16:52:51,085 [[MuleRuntime].cpuLight.01:
 [setpayloadobject].setpayloadobjectFlow.CPU_LITE @5d914abe]
 [event: 68121cd0-63c7-11e9-bcff-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 application/java; charset=UTF-8
```

### MIME Type Metadata Selector (.^mimeType)

Returns the MIME type (without parameters) of a value, for example, `application/json`, and
`{ "myMimeType" : payload.^mimeType }` might return `{ "myMediaType": "**/**" }` for an input POJO.

In the following Mule app flow, the Loggers use `payload.^mimeType` to select a string
`"my string"`, then to select a string that is set within an **fx** expression
(`#["my string as String type" as String]`) in the Set Payload (`set-payload`) component.

Mule App XML in Anypoint Studio:

```XML
<flow name="setpayloadobjectFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="15" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <!-- Set the payload to "my string". -->
  <set-payload value='"my string"' doc:name="Set Payload" />
  <!-- Select the MIME type of "my string". -->
  <logger level="INFO" doc:name="Logger" message='#[payload.^mimeType]'/>
  <!-- Set the payload using the fx expression "my string" as String. -->
  <set-payload value='#["my string as String type" as String]' doc:name="Set Payload" />
  <!-- Select the MIME type of a Java string. -->
  <logger level="INFO" doc:name="Logger" message='#[payload.^mimeType]'/>
</flow>
```

The Studio console output shows that the simple string has the MIME type `**/**`, while the string
that is set in the **fx** expression has the MIME type `application/java`.

Console Output in Anypoint Studio:

```txt
INFO  2019-04-20 17:02:07,762 [[MuleRuntime].cpuLight.06:
 [setpayloadobject].setpayloadobjectFlow.CPU_LITE @2d6f64b9]
 [event: b4097b00-63c8-11e9-bcff-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 */*

INFO  2019-04-20 17:02:08,029 [[MuleRuntime].cpuLight.06:
 [setpayloadobject].setpayloadobjectFlow.CPU_LITE @2d6f64b9]
 [event: b4097b00-63c8-11e9-bcff-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 application/java
```

### Raw Metadata Selector (.^raw)

Returns the underlying binary value of a POJO. This selector is sometimes used when calculating an
MD5 or some other cryptographic hash function to check for man-in-the-middle (MITM) attacks.

The following example uses the Set Payload component (`set-payload`) to produce a binary value, then
uses the Transform Message component (`ee:transform`) component to return raw data for the MD5
(`MD5(payload.^raw)`) of the binary value. The Logger component (`logger`) is also set to write the
raw data to the Studio console. For comparison, the second Logger returns the typical `payload` in a
standard JSON format.

Mule App XML in Anypoint Studio:

```XML
<flow name="rawcaret2Flow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="30" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <set-payload value='#["1234-5678-9123" as Binary]' doc:name="Set Payload" />
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
import * from dw::Crypto
output application/json
---
{ "myRawData" : MD5(payload.^raw) }]]></ee:set-payload>
    </ee:message>
  </ee:transform>
  <logger level="INFO" doc:name="Logger" message="#[payload.^raw]"/>
  <logger level="INFO" doc:name="Logger" message="#[payload]"/>
</flow>
```

Notice that instead of producing standard JSON output, the raw output in the Logger message
surrounds the entire payload in double-quotes and inserts new line characters (`\n`) for each new
line.

Console Output in Anypoint Studio:

```txt
INFO  2019-04-22 14:10:14,537 [[MuleRuntime].cpuLight.08:
 [rawcaret2].rawcaret2Flow.CPU_LITE @764a5a61]
 [event: 058f6a90-6543-11e9-9d99-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 "{\n  "myRawData": "5403e5a202c594871d59898b13054be5"\n}"

INFO  2019-04-22 14:10:14,540 [[MuleRuntime].cpuLight.08:
 [rawcaret2].rawcaret2Flow.CPU_LITE @764a5a61]
 [event: 058f6a90-6543-11e9-9d99-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 { "myRawData": "5403e5a202c594871d59898b13054be5" }
```

The following example uses the HTTP Listener source (`listener`) to get the XML payload received via
a POST request, then uses the Transform Message component (`ee:transform`) to get the encoding value
of the XML payload, by returning the raw data
(`(payload.^raw as String) scan /encoding='([A-z0-9-]+)'/)`). The Logger component (`logger`)
returns the `payload` in a JAVA format.

Mule App XML in Anypoint Studio:

```XML
<http:listener-config name="HTTP_Listener_config" >
    <http:listener-connection host="0.0.0.0" port="8081" />
</http:listener-config>
<flow name="test-flow">
	<http:listener path="/test" config-ref="HTTP_Listener_config"/>
	<ee:transform>
		<ee:message>
		<ee:set-payload ><![CDATA[%dw 2.0
output application/java
---
((payload.^raw as String) scan /encoding='([A-z0-9-]+)'/)[0][1]]]></ee:set-payload>
		</ee:message>
	</ee:transform>
	<logger level="INFO" message="#[payload]"/>
</flow>
```

Using your preferred REST client or API testing tool, send a POST request with the XML body:

```XML
<?xml version='1.0' encoding='ISO-8859-1'?>
<test>
</test>
```

The Logger message returns the extracted encoding value `ISO-8859-1`:

Console Output in Anypoint Studio:

```txt
INFO  2021-05-12 12:25:41,618 [[MuleRuntime].uber.03: [xmlmodule].Flow.CPU_INTENSIVE @de48fc8] [processor: Flow/processors/2; event: 4fe7f6a0-b336-11eb-909c-f01898ad2638] org.mule.runtime.core.internal.processor.LoggerMessageProcessor: ISO-8859-1
```

### Custom Metadata Selector (.^myCustomMetadata)

Returns the value of custom metadata. Metadata can be associated with any value by using the `as`
operator.

The following example uses `userName.^myCustomMetadata` to return the value of custom metadata that
is defined as a variable (named `userName`) in the header of the script as a DataWeave script. For
comparison, the example also returns the value of `userName`.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
var userName = "DataWeave" as String {myCustomMetadata: "customMetadataValue"}
---

{
  "valueOfVariableMetaData" :  userName.^myCustomMetadata,
  "valueOfVariable" :  userName,
}
```

The output of the script is `"customMetadataValue"` for the value of the custom metadata and
`"DataWeave"` for value of the `userName` variable.

Output JSON:

```json
{
  "valueOfVariableMetaData": "customMetadataValue",
  "valueOfVariable": "DataWeave"
}
```

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.6/dataweave-selectors)

- [DataWeave Quickstart](https://docs.mulesoft.com/dataweave/2.6/dataweave-quickstart)

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.6/dataweave-types)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook)

<!-- document id=4a7045757733c8f3671653481739cf9aa5a61653da3a853f5f9043691c9531f1 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook-extract-data.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, transform, transformer, metadata, dataweave, data weave, datawave, datamapper, dwl, dfl, dw, payload, attribute, variable, flow, error, message
---

# Extract Data

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave can select data from DataWeave objects and arrays, variables that store that data, and the
output of DataWeave functions when that output is an array or object.

More precisely, a DataWeave selector operates within a context, which can be a reference to the
variable that stores the data, an object literal, an array literal, or the invocation of a DataWeave
function. You can use selectors in Mule modules, connectors, and components that accept DataWeave
expressions.

When DataWeave processes a selector, it sets a new context (or scope) for subsequent selectors, so
you can navigate through the complex structures of arrays and objects using chains of selectors. The
depth of the selection is limited only by the depth of the current context.

Supported variable references are [Mule Runtime variables](https://docs.mulesoft.com/dataweave/2.9/dataweave-variables-context), such as
`payload` and `attributes`, and [DataWeave variables](https://docs.mulesoft.com/dataweave/2.9/dataweave-variables) that store arrays or
objects. A simple example is `payload.myKey` where the payload is the object `{"myKey" : 1234 }`, so
the result is `1234`.

A selector can act on the invocation of a function, such as the DataWeave `read` function. For
example, `read('{"A":"B"}','application/json')."A"` returns `"B"`.

## Use Selectors on DataWeave Arrays and Objects

In DataWeave, selectors extract values from within a DataWeave object (such as
`{ myKey : "myValue" }`) or array (such as `[1,2,3,4]` or
`[ { "myKey" : "1234" }, { "name" : "somebody" } ]`).

The following DataWeave script uses the single-value selector (`.`) to retrieve values from the
object and array defined by the variables `myObject` and `myArray`.

DataWeave Script:

```dataweave
%dw 2.0
var myObject = { "myKey" : "1234", "name" : "somebody" }
var myArray = [ { "myKey" : "1234" }, { "name" : "somebody" } ]
output application/json
---
{
    selectingValueUsingKeyInObject : myObject.name,
    selectingValueUsingKeyOfObjectInArray : myArray.name,
}
```

Output JSON:

```json
{
  "selectingValueUsingKeyInObject": "somebody",
  "selectingValueUsingKeyOfObjectInArray": ["somebody"]
}
```

As the Output shows:

- `myObject.name` returns the value `"somebody"`

- `myArray.name` returns the array `[ "somebody" ]`

## Selector Quick Reference

Single Value (`.`)

Acts on arrays and objects to return the value of a matching key. The syntax is `.myKey`. To
retrieve values of duplicate keys in a DataWeave _object_, use `*`, instead. For examples, see
[Single-Value Selector (.myKey)](#single_value).

Multiple Values (`*`)

Acts on arrays and objects to retrieve the values of all matching keys at a single level in the
hierarchy of a data structure. The syntax is `*myKey`. For the values of all duplicate keys at lower
levels in the hierarchy, use the descendants selector (`..`), instead. For examples, see
[Multi-Value Selector (`.*`)](#multi_value).

Key-Value Pair (`&`)

Acts on arrays and objects. Instead of returning the value of the DataWeave object, this selector
returns the entire DataWeave object, both key and value. The syntax is `.&myKey`. For examples, see
[Key-Value Pair Selector (`.&myKey`)](#key_value).

Descendants (`..`)

Acts on arrays and objects to retrieve all matching keys from arrays and objects below the given
key, regardless of their location in the hierarchy. The syntax is `..myKey` For examples, see
[Descendants Selector (`..myKey`)](#descendants).

Index (`[]`)

Returns the value at the specified index of an array. An example is the `[0]` at the end of
`["a","b","c"][0]`, which returns `"a"`. For examples, see [Index Selector (`[anIndex]`)](#index).

Range `[index1 to index2]`

Returns an array with values of the selected indices. An example is the `[2 to 3]` at the end of
`["a","b","c","d"][2 to 3]`, which returns `["c","d"]`. For examples, see
[Range selector (`anIndex to anotherIndex`)](#range).

XML attribute (`.@myKey`)

Returns the value of a selected key for an XML attribute. For an example, see
[XML Attribute Selector (`.@myKey`)](#xml_attribute).

Namespace Selector (`myKey.#`)

Returns the `xmlns` namespace from the element that also contains the selected key. For an example,
see [Namespace Selector (`#`)](#namespace).

Selector Modifiers (`?` and `!`)

`?` and `!` check for the specified key. `?` returns `true` or `false`. `!` returns an error if the
key is not present. For examples, see [Selector Modifiers (`!`, `?`)](#selector_modifiers).

Filter Selectors (`myKey[?(booleanExpression)]`)

Returns the selected items if the Boolean expression returns `true` and the specified `key` is
present. It returns `null` if the expression is false or the key is not present. For examples, see
[Filter Selectors (`myKey[?($ == "aValue")]`)](#filter_selectors).

Metadata Selector `.^someMetadata`

Returns the value of specified metadata for a Mule payload, variable, or attribute. The selector can
return the value of class (`.^class`), content length (`.^contentLength`), encoding (`.^encoding`),
MIME type (`.^mimeType`), media type (`.^mediaType`), raw (`.^raw`), and custom
(`.^myCustomMetadata`) metadata. For details, see
[Metadata Selector (.^someMetadata)](#metadata_selector).

## Key and Selector Syntax

In DataWeave, quotes around the name of an object’s key are required in some cases but optional in
others. Though a key is not an identifier, if the key name meets the criteria of a
[valid identifier name](https://docs.mulesoft.com/dataweave/2.9/dataweave-language-introduction#valid-identifiers), quotes around the key
are optional. If the key does not meet this criteria, you _must_ surround the key in quotes. For
example, to correct the key syntax in `{ some-name : "somebody" }`, you can use
`{ "some-name" : "somebody" }` or `{ 'some-name' : "somebody" }`. Without quotes, the key in
`{ some-name : "somebody" }` produces the error `Invalid input '-', expected Namespace`.

If you are using a selector on a key that requires quotes, you must also surround the selector in
quotes. For example, the selector `"some-name"` in `{ "some-name" : "somebody" }."some-name"` works,
but the selector `some-name` in `{ "some-name" : "somebody" }.some-name` produces the error
`Unable to resolve reference of: name` because the selector is not surrounded in quotes.

Quotes around a selector are optional if you are using a selector on a key that does not require the
quotes. For example, all of these examples work:

- `{"name" : "somebody"}.name`

- `{"name" : "somebody"}."name"`

- `{name : "somebody"}.name`

- `{name : "somebody"}."name"`

## Single-Value Selector (.myKey)

`.myKey` selectors work over an object or array to return the value of a matching key.

### Single-Value Selector Over an Object

For an object, the single-value selector returns the value of the matching key. For example, in the
following script, `myObject.user` returns `"a"`.

DataWeave Script:

```dataweave
%dw 2.0
var myObject = { user : "a" }
output application/json
---
{ myObjectExample : myObject.user }
```

Output JSON:

```json
{
  "myObjectExample": "a"
}
```

When operating on a DataWeave _object_ (not an array), the `.` selector only returns the value of
the _first_ matching key, even if the object contains multiple matching keys, for example:

DataWeave Script:

```dataweave
%dw 2.0
var myObject = { user : "a", "user" : "b" }
output application/json
---
{ myObjectExample : myObject.user }
```

Output JSON:

```json
{
  "myObjectExample": "a"
}
```

To return the values of multiple matching keys in cases like this, see
[Multi-Value Selector (`.*`)](#multi_value).

In the next example, `payload.people.person.address` returns the value of the `address` element. (It
also uses the `output` directive to transform the JSON input to XML.)

DataWeave Script:

```dataweave
%dw 2.0
var myData = {
  "people": {
    "size" : 1,
    "person": {
      "name": "Nial",
      "address": {
        "street": {
          "name": "Italia",
          "number": 2164
        },
        "area": {
          "zone": "San Isidro",
          "name": "Martinez"
        }
      }
    }
  }
}
output application/xml
---
{ myaddresses: myData.people.person.address }
```

Output XML:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<myaddresses>
  <street>
    <name>Italia</name>
    <number>2164</number>
  </street>
  <area>
    <zone>San Isidro</zone>
    <name>Martinez</name>
  </area>
</myaddresses>
```

## Single-Value Selector Over an Array

When acting on an array, the `.` selector returns an array, even if there is only one matching
value. For example, `["a":"b"]."a"` returns `["b"]`.

Note that the `.` selector acts differently on arrays than it acts on objects. Like `.*`, the `.`
selector returns an array with the values of _all matching keys_ at the specified level of the input
array.

DataWeave Script:

```dataweave
%dw 2.0
var myArrayOfKeyValuePairs = [ "aString": "hello", "aNum": 2, "aString" : "world" ]
var myArrayOfObjects = [ { "aString": "hello" }, { "aNum": 2 }, { "aString" : "world" } ]
output application/json
---
{
    myKeyValueExample : myArrayOfKeyValuePairs.aString,
    myObjectExample :  myArrayOfObjects.aString
}
```

Output JSON:

```json
{
  "myKeyValueExample": ["hello", "world"],
  "myObjectExample": ["hello", "world"]
}
```

In the following example, the value of the input variable, `myData`, is an array that contains two
objects. The selector navigates both objects and returns the values of both `street` keys.

DataWeave Script:

```dataweave
%dw 2.0
var myData = {
  "people": [
    {
      "person": {
        "name": "Nial",
        "address": {
          "street": {
            "name": "Italia",
            "number": 2164
          },
          "area": {
            "zone": "San Isidro",
            "name": "Martinez"
          }
        }
      }
    },
    {
      "person": {
        "name": "Coty",
        "address": {
          "street": {
            "name": "Monroe",
            "number": 323
          },
          "area": {
            "zone": "BA",
            "name": "Belgrano"
          }
        }
      }
    }
  ]
}
output application/json
---
myData.people.person.address.street
```

Output JSON:

```json
[
  {
    "name": "Italia",
    "number": 2164
  },
  {
    "name": "Monroe",
    "number": 323
  }
]
```

## Multi-Value Selector (`.*`)

`.*` traverses objects and arrays to select the values of all matching keys and returns matching
results in an array.

### Multi-Value Selector Over an Object

`.*` returns an array with all the values whose key matches the expression.

The following example returns the values of all `user` elements from the input payload.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
payload.users.*user
```

Input XML Payload:

```xml
<users>
  <user>Mariano</user>
  <user>Martin</user>
  <user>Leandro</user>
</users>
```

Output JSON:

```json
["Mariano", "Martin", "Leandro"]
```

### Multi-Value Selector Over an Array

On arrays, `.*` works the same way as the single-value selector (`.`). For example,
`payload.people.person.address.*street` and the example `payload.people.person.address.street` (from
[Single-Value Selector Over an Array](#single_value_array)) return the same results.

DataWeave Script:

```dataweave
%dw 2.0
var myArrayOfKeyValuePairs = [ "aString": "hello", "aNum": 2, "aString" : "world" ]
var myArrayOfObjects = [ { "aString": "hello" }, { "aNum": 2 }, { "aString" : "world" } ]
output application/json
---
{
    myKeyValueExample : myArrayOfKeyValuePairs.*aString,
    myObjectExample :  myArrayOfObjects.*aString
}
```

Output JSON:

```json
{
  "myKeyValueExample": ["hello", "world"],
  "myObjectExample": ["hello", "world"]
}
```

## Descendants Selector (`..myKey`)

The `..` selector acts on arrays and objects.

This selector applies to the context using the form `..myKey`, and it retrieves the values of all
matching key-value pairs in the sub-tree under the selected context. Regardless of the hierarchical
structure of the fields, the output is returned at the same level.

In this example, all of the fields that match the key `name` are placed in a list called `names`
regardless of their cardinality in the tree of the input data.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{ names: payload.people..name }
```

Input JSON Payload:

```json
{
  "people": {
    "person": {
      "name": "Nial",
      "address": {
        "street": {
          "name": "Italia",
          "number": 2164
        },
        "area": {
          "zone": "San Isidro",
          "name": "Martinez"
        }
      }
    }
  }
}
```

Output JSON:

```json
{
  "names": ["Nial", "Italia", "Martinez"]
}
```

## Key-Value Pair Selector (`.&myKey`)

The `&` selector acts on arrays and objects. `&` retrieves both the keys and values of all matching
keys pairs in the current context. These are returned as an object, containing the retrieved keys
and values.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
{
  users: payload.users.&user
}
```

Input XML Payload:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<users>
  <user>Mariano</user>
  <user>Martin</user>
  <user>Leandro</user>
  <admin>Admin</admin>
  <admin>org_owner</admin>
</users>
```

Output XML:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<users>
  <user>Mariano</user>
  <user>Martin</user>
  <user>Leandro</user>
</users>
```

Note that unlike the multi-value selector, the output of this selector is an object, where the
original keys for each value are also extracted.

### Select All the Descendant Key-Value Pairs

This example uses the `..` and `&` selectors in `myVar.people..&name` to select and return an array
that contains all descendant objects from `myData` input that contain the key `name`. It also
transforms the JSON input to XML output.

DataWeave Script:

```dataweave
%dw 2.0
var myData = {
  "people": {
    "person": {
      "name": "Nial",
      "address": {
        "street": {
          "name": "Italia",
          "number": 2164
        },
        "area": {
          "zone": "San Isidro",
          "name": "Martinez"
        }
      }
    }
  }
}
output application/xml
---
names: {(myData.people..&name)}
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<names>
  <name>Nial</name>
  <name>Italia</name>
  <name>Martinez</name>
</names>
```

## Index Selector (`[anIndex]`)

The index selector returns the element at the specified position. It can be applied over an array,
object, or string.

### Index Selector Over an Array

This selector can be applied to String literals, Arrays and Objects. In the case of Objects, the
value of the key-value pair found at the index is returned. In the case of Arrays, the value of the
element is returned. The index is zero-based.

1.  If the index is bigger or equal to 0, it starts counting from the beginning.

2.  If the index is negative, it starts counting from the end where -1 is the last element.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
payload.people[1]
```

Input JSON Payload:

```json
{
  "people": [
    {
      "nameFirst": "Nial",
      "nameLast": "Martinez"
    },
    {
      "nameFirst": "Coty",
      "nameLast": "Belgrano"
    }
  ]
}
```

Output JSON:

```json
{
  "nameFirst": "Coty",
  "nameLast": "Belgrano"
}
```

### Index Selector Over an Object

The selector returns the value of the key-value pair at the specified position.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
payload[1]
```

Input JSON Payload:

```json
{
  "nameFirst": "Mark",
  "nameLast": "Nguyen"
}
```

Output JSON:

```json
"Nguyen"
```

### Index Selector Over a String

When using the Index Selector with a string, the string is broken down into an array, where each
character is an index.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{ name: "MuleSoft"[0] }
```

Output JSON:

```json
{ "name": "M" }
```

The selector picks the character at a given position, treating the string as an array of characters.

1.  If the index is bigger or equal to 0, it starts counting from the beginning.

2.  If the index is negative, it starts counting from the end.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{ name: "Emiliano"[0] }
```

Output JSON:

```json
{ "name": "E" }
```

## Range selector (`anIndex to anotherIndex`)

The `to` selector returns values of matching indices in an array or string. You can also use it to
reverse the order of the indices in the range. The selector treats characters in the string as
indices.

- Selecting an index from an array:

  - `[1,2,3,4][0]` returns `1`

    The index of the first element in an array is always `0`.

  - `[1,2,3,4][3]` returns `4`

### Range Selector Over an Array

Range selectors limit the output to only the elements specified by the range on that specific order.
This selector allows you to slice an array or even invert it.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
  slice: [0,1,2][0 to 1],
  last: [0,1,2][-1 to 0]
}
```

Output JSON:

```json
{
  "slice": [0, 1],
  "last": [2, 1, 0]
}
```

### Range Selector Over a String

The Range selector limits the output to only the elements specified by the range on that specific
order, treating the string as an array of characters. This selector enables you to slice a string or
invert it.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
  slice: "DataWeave"[0 to 1],
  middle : "superfragilisticexpialadocious"[10 to 13],
  last: "DataWeave"[-1 to 0]
}
```

Output JSON:

```json
{
  "slice": "Da",
  "middle": "list",
  "last": "evaeWataD"
}
```

## XML Attribute Selector (`.@myKey`)

`.@myKey` selects an attribute in an XML element.

Using `.@` without the key name returns an object containing the attributes as key-value pairs.

This DataWeave example reads an XML sample into a variable and uses `@` to select attributes from
the XML.

DataWeave Script:

```dataweave
%dw 2.0
var myVar = read('<product id="1" type="electronic">
  <brand>SomeBrand</brand>
</product>', 'application/xml')
output application/json
---
{
  item: [
  	{
      "type" : myVar.product.@."type",
      "name" : myVar.product.brand,
      "attributes": myVar.product.@
    }
  ]
}
```

Output JSON:

```json
{
  "item": [
    {
      "type": "electronic",
      "name": "SomeBrand",
      "attributes": {
        "id": "1",
        "type": "electronic"
      }
    }
  ]
}
```

## Namespace Selector (`#`)

`#` returns the XML namespace of a selected key as plain text.

DataWeave Script:

```dataweave
%dw 2.0
output text/plain
---
payload.order.#
```

Input XML Payload:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<ns0:order xmlns:ns0="http://orders.company.com">
  <name>Mark</name>
  <items>42</items>
  <orderdate>2017-01-04</orderdate>
</ns0:order>
```

Output Text:

```json
"http://orders.company.com"
```

## Selector Modifiers (`!`, `?`)

You can check for the presence of a given key.

- `!` evaluates the selection and fails with an exception message if the key is not present.

- `?` returns `true` if the selected key is present, `false` if not. Note that `?` is also used in
  [Filter Selectors (`myKey[?($ == "aValue")]`)](#filter_selectors).

### Assert Present Validator

`!` returns an error if any of the specified key is missing.

- `{ "name": "Annie" }.lastName!` returns an error with the message,
  `There is no key named 'lastName'`.

- Without the `!`, `{ "name": "Annie" }.lastName` returns `null`.

- When the key is present, `{ "name": "Annie" }.name!` the result is `"Annie"`.

### Key Present Validator

Returns `true` if the specified key is present in the object or as an attribute of an XML element.

This example returns `true` because the `name` key does exists.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
present: payload.name?
```

Input JSON Payload:

```json
{ "name": "Annie" }
```

Output XML:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<present>true</present>
```

`?` also works with XML attributes:

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
  item: {
    typePresent : payload.product.@."type"?
  }
}
```

Input XML Payload:

```xml
<product id="1" type="tv">
  <brand>Samsung</brand>
</product>
```

Output JSON:

```json
{
  "item": { "typePresent": true }
}
```

## Filter Selectors (`myKey[?($ == "aValue")]`)

`myKey[?($ == "aValue")]` returns only the values of matching keys within an array or object. Note
that `?` is also used in [Key Present Validator](#key_present). If no key-value pairs match, the
result is `null`.

The following example inputs the array of `name` keys returned by `*.name`, then checks for `name`
keys with the value `"Mariano"`. It filters out any values that do not match. Note that the `$`
references the value of the selected key.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{ users: payload.users.*name[?($ == "Mariano")] }
```

Input XML Payload:

```xml
<users>
  <name>Mariano</name>
  <name>Luis</name>
  <name>Mariano</name>
</users>
```

Output JSON:

```json
{
  "users": ["Mariano", "Mariano"]
}
```

The following example assumes the same [input](#input_filter_selectors) and returns all the
key-value pairs of the input because the expression `( 1 == 1 )` is true. Note that a false
expression, such as `( 1 == 2 )`, returns `null`.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{ users: payload.users.*name[?( 1 == 1)] }
```

Input XML Payload:

```xml
<users>
  <name>Mariano</name>
  <name>Luis</name>
  <name>Mariano</name>
</users>
```

Output JSON:

```json
{
  "users": ["Mariano", "Luis", "Mariano"]
}
```

The following example assumes the same [input](#input_filter_selectors). It uses `mapObject` to
iterate over the entire input object and return matching key-value pairs, filtering out any pairs
that do not match.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
payload mapObject { ($$) : $[?($=="Mariano")] }
```

Input XML Payload:

```xml
<users>
  <name>Mariano</name>
  <name>Luis</name>
  <name>Mariano</name>
</users>
```

Output JSON:

```json
{
  "users": {
    "name": "Mariano",
    "name": "Mariano"
  }
}
```

## Metadata Selector (.^someMetadata)

Returns the value of specified metadata for a Mule payload, variable, or attribute. The selector can
return the following metadata:

- Content length metadata: `.^contentLength` returns the content length of the value, if the value
  is present. For an example, see
  [Content Length Metadata Selector (.^contentLength)](#caret_contentlength).

- Class metadata: `.^class` returns the class of the Plain Old Java Object (POJO). For example,
  `{ "string" : payload.string.^class }` might return `{ "string": "java.lang.String" }` if the
  input payload defines a Java string, such as `simplePojo.string = "myString"`, in a simple POJO,
  and `{ "date" : payload.date.^class }` might return `{ "date": "java.util.Date" }`. For an
  example, see [Class Metadata Selector (.^class)](#caret_class).

- Encoding metadata: `.^encoding` returns the encoding of a value. For example,
  `{ "myEncoding" : payload.^encoding }` might return `{"myEncoding": "UTF-8"}` for an input POJO.
  For an example, see [Encoding Metadata Selector (.^encoding)](#caret_encoding).

- Media Type Selector: `.^mediaType` returns the MIME type of a value that includes parameters, for
  example, `application/json;charset=UTF-16`, and the expression in the value of
  `{ "myMediaType" : payload.^mediaType }` might return `"myMediaType": "**/**; charset=UTF-8"` for
  an input POJO. For an example, see [Media Type Metadata Selector (.^mediaType)](#caret_mediatype).

- MIME Type metadata: `.^mimeType` returns the MIME type (without parameters) of a value, for
  example, `application/json`, and `{ "myMimeType" : payload.^mimeType }` might return
  `{ "myMediaType": "**/**" }` for an input POJO. For an example, see
  [MIME Type Metadata Selector (.^mimeType)](#caret_mimetype).

- Raw metadata: `.^raw` returns the underlying data (typically, a binary value) of a plain old Java
  object (POJO). This selector is sometimes used when calculating an MD5 for hashes when checking
  for man-in-the-middle attacks. For examples, see [Raw Metadata Selector (.^raw)](#caret_raw).

- Custom metadata: `.^myCustomMetadata` returns the value of custom metadata. For examples, see
  [Custom Metadata Selector (.^myCustomMetadata)](#caret_custom_metadata).

### Content Length Metadata Selector (.^contentLength)

Returns the content length of the value, if the value is present.

In the following Mule app flow, the Logger uses `payload.^contentLength` to select the length of the
string `my string`, set in the Set Payload (`set-payload`) component.

Mule App XML in Anypoint Studio:

```XML
<flow name="setpayloadobjectFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="15" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <!-- Set the payload to "my string". -->
  <set-payload value='"my string"' doc:name="Set Payload" />
  <!-- Select the class to which "my string" belongs. -->
  <logger level="INFO" doc:name="Logger" message="#[payload.^contentLength]"/>
</flow>
```

The Studio console output shows that the length of the input string (`my string`) is eleven (`9`)
characters long. The length includes the blank space in the string.

Console Output in Anypoint Studio:

```txt
INFO  2019-05-07 16:59:33,690 [[MuleRuntime].cpuLight.07:
 [carets].caretsFlow.CPU_LITE @39f1dbde]
 [event: 28ce97a0-7124-11e9-acfe-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 11
```

### Class Metadata Selector (.^class)

Returns the class of the Plain Old Java Object (POJO). The value might result from calling a method
in a Java class or have a data type (such as `String` or `DateTime`) that DataWeave treats as a Java
value, for example:

- `{ "string" : payload.mystring.^class }` might return `{ "mystring": "java.lang.String" }` if the
  input payload defines a Java string, such as `simplePojo.string = "myString"`, in a simple POJO.

- `{ "mydate" : payload.mydate.^class }` might return `{ "mydate": "java.util.Date" }`.

In the following Mule app flow, the Logger uses `payload.^class` to select the Java class of
`"my string"`, set in the Set Payload (`set-payload`) component.

Mule App XML in Anypoint Studio:

```XML
<flow name="setpayloadobjectFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="15" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <!-- Set the payload to "my string". -->
  <set-payload value='"my string"' doc:name="Set Payload" />
  <!-- Select the class to which "my string" belongs. -->
  <logger level="INFO" doc:name="Logger" message="#[payload.^class]"/>
</flow>
```

The Studio console output shows that the payload string belongs to the class `java.lang.String`.

Console Output in Anypoint Studio:

```txt
INFO  2019-04-20 16:10:03,075 [[MuleRuntime].cpuLight.08:
 [setpayloadobject].setpayloadobjectFlow.CPU_LITE @6447187e]
 [event: 6da29400-63c1-11e9-98e0-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 java.lang.String
```

### Encoding Metadata Selector (.^encoding)

Returns the encoding of a value. For example, `{ "myEncoding" : payload.^encoding }` might return
`{"myEncoding": "UTF-8"}` for an input POJO.

In the following Mule app flow, the Logger uses `payload.^encoding` to select the encoding of
``"my string"`set in the Set Payload (`set-payload``) component. The Scheduler (`scheduler`)
component is simply an event source that regularly generates a new Mule event to hold the payload
set in Set Payload.

Mule App XML in Anypoint Studio:

```XML
<flow name="setpayloadobjectFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="15" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <!-- Set the payload to "my string". -->
  <set-payload value='"my string"' doc:name="Set Payload" />
  <!-- Select the encoding of "my string". -->
  <logger level="INFO" doc:name="Logger" message="#[payload.^encoding]"/>
</flow>
```

The Studio console output shows that the payload string has `UTF-8` encoding.

Console Output in Anypoint Studio:

```txt
INFO  2019-04-20 16:14:24,222 [[MuleRuntime].cpuLight.03:
 [setpayloadobject].setpayloadobjectFlow.CPU_LITE @62bea6a6]
 [event: 0938bf70-63c2-11e9-98e0-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 UTF-8
```

### Media Type Metadata Selector (.^mediaType)

Returns the MIME type of a value that includes parameters (for example,
`application/json;charset=UTF-16`). The expression in the value of
`{ "myMediaType" : payload.^mediaType }` might return `"myMediaType": "**/**; charset=UTF-8"` for an
input POJO.

In the following Mule app flow, the Logger uses `payload.^mediaType` to select the media type of
`2014-10-12T11:11:19-00:03` set in the Set Payload (`set-payload`) component.

Mule App XML in Anypoint Studio:

```XML
<flow name="setpayloadobjectFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="15" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <set-payload value='#[|2014-10-12T11:11:19-00:03| as DateTime]' doc:name="Set Payload" />
  <logger level="INFO" doc:name="Logger" message="#[payload.^mediaType]"/>
</flow>
```

The Studio console output shows that the `DateTime` payload has the
`application/java; charset=UTF-8` media type.

Console Output in Anypoint Studio:

INFO 2019-04-20 16:41:01,276 \[\[MuleRuntime\].cpuLight.04:
\[setpayloadobject\].setpayloadobjectFlow.CPU\_LITE @7e991c71\] \[event:
c0e96860-63c5-11e9-bcff-8c8590a99d48\]
rg.mule.runtime.core.internal.processor.LoggerMessageProcessor: application/java; charset=UTF-8

In the following Mule app flow, the Loggers use `payload.^mediaType` to select a string
`"my string"`, then to select a string that is set within an **fx** expression
(`#["my string as String type" as String]`) in the Set Payload (`set-payload`) component.

Mule App XML in Anypoint Studio:

```XML
<flow name="setpayloadobjectFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="15" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <!-- Set the payload to "my string". -->
  <set-payload value='"my string"' doc:name="Set Payload" />
  <!-- Select the media type of "my string". -->
  <logger level="INFO" doc:name="Logger" message='#[payload.^mediaType]'/>
  <!-- Set the payload using the fx expression "my string" as String. -->
  <set-payload value='#["my string as String type" as String]' doc:name="Set Payload" />
  <!-- Select the media type of a Java string. -->
  <logger level="INFO" doc:name="Logger" message='#[payload.^mediaType]'/>
</flow>
```

The Studio console output shows that the simple string has the media type `**/**`, while the string
that is set in the **fx** expression has the media type `application/java; charset=UTF-8`.

Console Output in Anypoint Studio:

```txt
INFO  2019-04-20 16:52:50,801 [[MuleRuntime].cpuLight.01:
 [setpayloadobject].setpayloadobjectFlow.CPU_LITE @5d914abe]
 [event: 68121cd0-63c7-11e9-bcff-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 */*

INFO  2019-04-20 16:52:51,085 [[MuleRuntime].cpuLight.01:
 [setpayloadobject].setpayloadobjectFlow.CPU_LITE @5d914abe]
 [event: 68121cd0-63c7-11e9-bcff-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 application/java; charset=UTF-8
```

### MIME Type Metadata Selector (.^mimeType)

Returns the MIME type (without parameters) of a value, for example, `application/json`, and
`{ "myMimeType" : payload.^mimeType }` might return `{ "myMediaType": "**/**" }` for an input POJO.

In the following Mule app flow, the Loggers use `payload.^mimeType` to select a string
`"my string"`, then to select a string that is set within an **fx** expression
(`#["my string as String type" as String]`) in the Set Payload (`set-payload`) component.

Mule App XML in Anypoint Studio:

```XML
<flow name="setpayloadobjectFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="15" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <!-- Set the payload to "my string". -->
  <set-payload value='"my string"' doc:name="Set Payload" />
  <!-- Select the MIME type of "my string". -->
  <logger level="INFO" doc:name="Logger" message='#[payload.^mimeType]'/>
  <!-- Set the payload using the fx expression "my string" as String. -->
  <set-payload value='#["my string as String type" as String]' doc:name="Set Payload" />
  <!-- Select the MIME type of a Java string. -->
  <logger level="INFO" doc:name="Logger" message='#[payload.^mimeType]'/>
</flow>
```

The Studio console output shows that the simple string has the MIME type `**/**`, while the string
that is set in the **fx** expression has the MIME type `application/java`.

Console Output in Anypoint Studio:

```txt
INFO  2019-04-20 17:02:07,762 [[MuleRuntime].cpuLight.06:
 [setpayloadobject].setpayloadobjectFlow.CPU_LITE @2d6f64b9]
 [event: b4097b00-63c8-11e9-bcff-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 */*

INFO  2019-04-20 17:02:08,029 [[MuleRuntime].cpuLight.06:
 [setpayloadobject].setpayloadobjectFlow.CPU_LITE @2d6f64b9]
 [event: b4097b00-63c8-11e9-bcff-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 application/java
```

### Raw Metadata Selector (.^raw)

Returns the underlying binary value of a POJO. This selector is sometimes used when calculating an
MD5 or some other cryptographic hash function to check for man-in-the-middle (MITM) attacks.

The following example uses the Set Payload component (`set-payload`) to produce a binary value, then
uses the Transform Message component (`ee:transform`) component to return raw data for the MD5
(`MD5(payload.^raw)`) of the binary value. The Logger component (`logger`) is also set to write the
raw data to the Studio console. For comparison, the second Logger returns the typical `payload` in a
standard JSON format.

Mule App XML in Anypoint Studio:

```XML
<flow name="rawcaret2Flow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="30" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <set-payload value='#["1234-5678-9123" as Binary]' doc:name="Set Payload" />
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
import * from dw::Crypto
output application/json
---
{ "myRawData" : MD5(payload.^raw) }]]></ee:set-payload>
    </ee:message>
  </ee:transform>
  <logger level="INFO" doc:name="Logger" message="#[payload.^raw]"/>
  <logger level="INFO" doc:name="Logger" message="#[payload]"/>
</flow>
```

Notice that instead of producing standard JSON output, the raw output in the Logger message
surrounds the entire payload in double-quotes and inserts new line characters (`\n`) for each new
line.

Console Output in Anypoint Studio:

```txt
INFO  2019-04-22 14:10:14,537 [[MuleRuntime].cpuLight.08:
 [rawcaret2].rawcaret2Flow.CPU_LITE @764a5a61]
 [event: 058f6a90-6543-11e9-9d99-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 "{\n  "myRawData": "5403e5a202c594871d59898b13054be5"\n}"

INFO  2019-04-22 14:10:14,540 [[MuleRuntime].cpuLight.08:
 [rawcaret2].rawcaret2Flow.CPU_LITE @764a5a61]
 [event: 058f6a90-6543-11e9-9d99-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 { "myRawData": "5403e5a202c594871d59898b13054be5" }
```

The following example uses the HTTP Listener source (`listener`) to get the XML payload received via
a POST request, then uses the Transform Message component (`ee:transform`) to get the encoding value
of the XML payload, by returning the raw data
(`(payload.^raw as String) scan /encoding='([A-z0-9-]+)'/)`). The Logger component (`logger`)
returns the `payload` in a JAVA format.

Mule App XML in Anypoint Studio:

```XML
<http:listener-config name="HTTP_Listener_config" >
    <http:listener-connection host="0.0.0.0" port="8081" />
</http:listener-config>
<flow name="test-flow">
	<http:listener path="/test" config-ref="HTTP_Listener_config"/>
	<ee:transform>
		<ee:message>
		<ee:set-payload ><![CDATA[%dw 2.0
output application/java
---
((payload.^raw as String) scan /encoding='([A-z0-9-]+)'/)[0][1]]]></ee:set-payload>
		</ee:message>
	</ee:transform>
	<logger level="INFO" message="#[payload]"/>
</flow>
```

Using your preferred REST client or API testing tool, send a POST request with the XML body:

```XML
<?xml version='1.0' encoding='ISO-8859-1'?>
<test>
</test>
```

The Logger message returns the extracted encoding value `ISO-8859-1`:

Console Output in Anypoint Studio:

```txt
INFO  2021-05-12 12:25:41,618 [[MuleRuntime].uber.03: [xmlmodule].Flow.CPU_INTENSIVE @de48fc8] [processor: Flow/processors/2; event: 4fe7f6a0-b336-11eb-909c-f01898ad2638] org.mule.runtime.core.internal.processor.LoggerMessageProcessor: ISO-8859-1
```

### Custom Metadata Selector (.^myCustomMetadata)

Returns the value of custom metadata. Metadata can be associated with any value by using the `as`
operator.

The following example uses `userName.^myCustomMetadata` to return the value of custom metadata that
is defined as a variable (named `userName`) in the header of the script as a DataWeave script. For
comparison, the example also returns the value of `userName`.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
var userName = "DataWeave" as String {myCustomMetadata: "customMetadataValue"}
---

{
  "valueOfVariableMetaData" :  userName.^myCustomMetadata,
  "valueOfVariable" :  userName,
}
```

The output of the script is `"customMetadataValue"` for the value of the custom metadata and
`"DataWeave"` for value of the `userName` variable.

Output JSON:

```json
{
  "valueOfVariableMetaData": "customMetadataValue",
  "valueOfVariable": "DataWeave"
}
```

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.9/dataweave-selectors)

- [DataWeave Quickstart](https://docs.mulesoft.com/dataweave/2.9/dataweave-quickstart)

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.9/dataweave-types)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook)

<!-- document id=e07b54c28c252b01e462b0f458b8a49f93cc8d1c2c21608cc3573c78b05cab07 url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook-extract-data.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, transform, transformer, metadata, dataweave, data weave, datawave, datamapper, dwl, dfl, dw, payload, attribute, variable, flow, error, message
---

# Extract Data

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave can select data from DataWeave objects and arrays, variables that store that data, and the
output of DataWeave functions when that output is an array or object.

More precisely, a DataWeave selector operates within a context, which can be a reference to the
variable that stores the data, an object literal, an array literal, or the invocation of a DataWeave
function. You can use selectors in Mule modules, connectors, and components that accept DataWeave
expressions.

When DataWeave processes a selector, it sets a new context (or scope) for subsequent selectors, so
you can navigate through the complex structures of arrays and objects using chains of selectors. The
depth of the selection is limited only by the depth of the current context.

Supported variable references are [Mule Runtime variables](https://docs.mulesoft.com/dataweave/latest/dataweave-variables-context), such as
`payload` and `attributes`, and [DataWeave variables](https://docs.mulesoft.com/dataweave/latest/dataweave-variables) that store arrays or
objects. A simple example is `payload.myKey` where the payload is the object `{"myKey" : 1234 }`, so
the result is `1234`.

A selector can act on the invocation of a function, such as the DataWeave `read` function. For
example, `read('{"A":"B"}','application/json')."A"` returns `"B"`.

## Use Selectors on DataWeave Arrays and Objects

In DataWeave, selectors extract values from within a DataWeave object (such as
`{ myKey : "myValue" }`) or array (such as `[1,2,3,4]` or
`[ { "myKey" : "1234" }, { "name" : "somebody" } ]`).

The following DataWeave script uses the single-value selector (`.`) to retrieve values from the
object and array defined by the variables `myObject` and `myArray`.

DataWeave Script:

```dataweave
%dw 2.0
var myObject = { "myKey" : "1234", "name" : "somebody" }
var myArray = [ { "myKey" : "1234" }, { "name" : "somebody" } ]
output application/json
---
{
    selectingValueUsingKeyInObject : myObject.name,
    selectingValueUsingKeyOfObjectInArray : myArray.name,
}
```

Output JSON:

```json
{
  "selectingValueUsingKeyInObject": "somebody",
  "selectingValueUsingKeyOfObjectInArray": ["somebody"]
}
```

As the Output shows:

- `myObject.name` returns the value `"somebody"`

- `myArray.name` returns the array `[ "somebody" ]`

## Selector Quick Reference

Single Value (`.`)

Acts on arrays and objects to return the value of a matching key. The syntax is `.myKey`. To
retrieve values of duplicate keys in a DataWeave _object_, use `*`, instead. For examples, see
[Single-Value Selector (.myKey)](#single_value).

Multiple Values (`*`)

Acts on arrays and objects to retrieve the values of all matching keys at a single level in the
hierarchy of a data structure. The syntax is `*myKey`. For the values of all duplicate keys at lower
levels in the hierarchy, use the descendants selector (`..`), instead. For examples, see
[Multi-Value Selector (`.*`)](#multi_value).

Key-Value Pair (`&`)

Acts on arrays and objects. Instead of returning the value of the DataWeave object, this selector
returns the entire DataWeave object, both key and value. The syntax is `.&myKey`. For examples, see
[Key-Value Pair Selector (`.&myKey`)](#key_value).

Descendants (`..`)

Acts on arrays and objects to retrieve all matching keys from arrays and objects below the given
key, regardless of their location in the hierarchy. The syntax is `..myKey` For examples, see
[Descendants Selector (`..myKey`)](#descendants).

Index (`[]`)

Returns the value at the specified index of an array. An example is the `[0]` at the end of
`["a","b","c"][0]`, which returns `"a"`. For examples, see [Index Selector (`[anIndex]`)](#index).

Range `[index1 to index2]`

Returns an array with values of the selected indices. An example is the `[2 to 3]` at the end of
`["a","b","c","d"][2 to 3]`, which returns `["c","d"]`. For examples, see
[Range selector (`anIndex to anotherIndex`)](#range).

XML attribute (`.@myKey`)

Returns the value of a selected key for an XML attribute. For an example, see
[XML Attribute Selector (`.@myKey`)](#xml_attribute).

Namespace Selector (`myKey.#`)

Returns the `xmlns` namespace from the element that also contains the selected key. For an example,
see [Namespace Selector (`#`)](#namespace).

Selector Modifiers (`?` and `!`)

`?` and `!` check for the specified key. `?` returns `true` or `false`. `!` returns an error if the
key is not present. For examples, see [Selector Modifiers (`!`, `?`)](#selector_modifiers).

Filter Selectors (`myKey[?(booleanExpression)]`)

Returns the selected items if the Boolean expression returns `true` and the specified `key` is
present. It returns `null` if the expression is false or the key is not present. For examples, see
[Filter Selectors (`myKey[?($ == "aValue")]`)](#filter_selectors).

Metadata Selector `.^someMetadata`

Returns the value of specified metadata for a Mule payload, variable, or attribute. The selector can
return the value of class (`.^class`), content length (`.^contentLength`), encoding (`.^encoding`),
MIME type (`.^mimeType`), media type (`.^mediaType`), raw (`.^raw`), and custom
(`.^myCustomMetadata`) metadata. For details, see
[Metadata Selector (.^someMetadata)](#metadata_selector).

## Key and Selector Syntax

In DataWeave, quotes around the name of an object’s key are required in some cases but optional in
others. Though a key is not an identifier, if the key name meets the criteria of a
[valid identifier name](https://docs.mulesoft.com/dataweave/latest/dataweave-language-introduction#valid-identifiers), quotes around the key
are optional. If the key does not meet this criteria, you _must_ surround the key in quotes. For
example, to correct the key syntax in `{ some-name : "somebody" }`, you can use
`{ "some-name" : "somebody" }` or `{ 'some-name' : "somebody" }`. Without quotes, the key in
`{ some-name : "somebody" }` produces the error `Invalid input '-', expected Namespace`.

If you are using a selector on a key that requires quotes, you must also surround the selector in
quotes. For example, the selector `"some-name"` in `{ "some-name" : "somebody" }."some-name"` works,
but the selector `some-name` in `{ "some-name" : "somebody" }.some-name` produces the error
`Unable to resolve reference of: name` because the selector is not surrounded in quotes.

Quotes around a selector are optional if you are using a selector on a key that does not require the
quotes. For example, all of these examples work:

- `{"name" : "somebody"}.name`

- `{"name" : "somebody"}."name"`

- `{name : "somebody"}.name`

- `{name : "somebody"}."name"`

## Single-Value Selector (.myKey)

`.myKey` selectors work over an object or array to return the value of a matching key.

### Single-Value Selector Over an Object

For an object, the single-value selector returns the value of the matching key. For example, in the
following script, `myObject.user` returns `"a"`.

DataWeave Script:

```dataweave
%dw 2.0
var myObject = { user : "a" }
output application/json
---
{ myObjectExample : myObject.user }
```

Output JSON:

```json
{
  "myObjectExample": "a"
}
```

When operating on a DataWeave _object_ (not an array), the `.` selector only returns the value of
the _first_ matching key, even if the object contains multiple matching keys, for example:

DataWeave Script:

```dataweave
%dw 2.0
var myObject = { user : "a", "user" : "b" }
output application/json
---
{ myObjectExample : myObject.user }
```

Output JSON:

```json
{
  "myObjectExample": "a"
}
```

To return the values of multiple matching keys in cases like this, see
[Multi-Value Selector (`.*`)](#multi_value).

In the next example, `payload.people.person.address` returns the value of the `address` element. (It
also uses the `output` directive to transform the JSON input to XML.)

DataWeave Script:

```dataweave
%dw 2.0
var myData = {
  "people": {
    "size" : 1,
    "person": {
      "name": "Nial",
      "address": {
        "street": {
          "name": "Italia",
          "number": 2164
        },
        "area": {
          "zone": "San Isidro",
          "name": "Martinez"
        }
      }
    }
  }
}
output application/xml
---
{ myaddresses: myData.people.person.address }
```

Output XML:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<myaddresses>
  <street>
    <name>Italia</name>
    <number>2164</number>
  </street>
  <area>
    <zone>San Isidro</zone>
    <name>Martinez</name>
  </area>
</myaddresses>
```

## Single-Value Selector Over an Array

When acting on an array, the `.` selector returns an array, even if there is only one matching
value. For example, `["a":"b"]."a"` returns `["b"]`.

Note that the `.` selector acts differently on arrays than it acts on objects. Like `.*`, the `.`
selector returns an array with the values of _all matching keys_ at the specified level of the input
array.

DataWeave Script:

```dataweave
%dw 2.0
var myArrayOfKeyValuePairs = [ "aString": "hello", "aNum": 2, "aString" : "world" ]
var myArrayOfObjects = [ { "aString": "hello" }, { "aNum": 2 }, { "aString" : "world" } ]
output application/json
---
{
    myKeyValueExample : myArrayOfKeyValuePairs.aString,
    myObjectExample :  myArrayOfObjects.aString
}
```

Output JSON:

```json
{
  "myKeyValueExample": ["hello", "world"],
  "myObjectExample": ["hello", "world"]
}
```

In the following example, the value of the input variable, `myData`, is an array that contains two
objects. The selector navigates both objects and returns the values of both `street` keys.

DataWeave Script:

```dataweave
%dw 2.0
var myData = {
  "people": [
    {
      "person": {
        "name": "Nial",
        "address": {
          "street": {
            "name": "Italia",
            "number": 2164
          },
          "area": {
            "zone": "San Isidro",
            "name": "Martinez"
          }
        }
      }
    },
    {
      "person": {
        "name": "Coty",
        "address": {
          "street": {
            "name": "Monroe",
            "number": 323
          },
          "area": {
            "zone": "BA",
            "name": "Belgrano"
          }
        }
      }
    }
  ]
}
output application/json
---
myData.people.person.address.street
```

Output JSON:

```json
[
  {
    "name": "Italia",
    "number": 2164
  },
  {
    "name": "Monroe",
    "number": 323
  }
]
```

## Multi-Value Selector (`.*`)

`.*` traverses objects and arrays to select the values of all matching keys and returns matching
results in an array.

### Multi-Value Selector Over an Object

`.*` returns an array with all the values whose key matches the expression.

The following example returns the values of all `user` elements from the input payload.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
payload.users.*user
```

Input XML Payload:

```xml
<users>
  <user>Mariano</user>
  <user>Martin</user>
  <user>Leandro</user>
</users>
```

Output JSON:

```json
["Mariano", "Martin", "Leandro"]
```

### Multi-Value Selector Over an Array

On arrays, `.*` works the same way as the single-value selector (`.`). For example,
`payload.people.person.address.*street` and the example `payload.people.person.address.street` (from
[Single-Value Selector Over an Array](#single_value_array)) return the same results.

DataWeave Script:

```dataweave
%dw 2.0
var myArrayOfKeyValuePairs = [ "aString": "hello", "aNum": 2, "aString" : "world" ]
var myArrayOfObjects = [ { "aString": "hello" }, { "aNum": 2 }, { "aString" : "world" } ]
output application/json
---
{
    myKeyValueExample : myArrayOfKeyValuePairs.*aString,
    myObjectExample :  myArrayOfObjects.*aString
}
```

Output JSON:

```json
{
  "myKeyValueExample": ["hello", "world"],
  "myObjectExample": ["hello", "world"]
}
```

## Descendants Selector (`..myKey`)

The `..` selector acts on arrays and objects.

This selector applies to the context using the form `..myKey`, and it retrieves the values of all
matching key-value pairs in the sub-tree under the selected context. Regardless of the hierarchical
structure of the fields, the output is returned at the same level.

In this example, all of the fields that match the key `name` are placed in a list called `names`
regardless of their cardinality in the tree of the input data.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{ names: payload.people..name }
```

Input JSON Payload:

```json
{
  "people": {
    "person": {
      "name": "Nial",
      "address": {
        "street": {
          "name": "Italia",
          "number": 2164
        },
        "area": {
          "zone": "San Isidro",
          "name": "Martinez"
        }
      }
    }
  }
}
```

Output JSON:

```json
{
  "names": ["Nial", "Italia", "Martinez"]
}
```

## Key-Value Pair Selector (`.&myKey`)

The `&` selector acts on arrays and objects. `&` retrieves both the keys and values of all matching
keys pairs in the current context. These are returned as an object, containing the retrieved keys
and values.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
{
  users: payload.users.&user
}
```

Input XML Payload:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<users>
  <user>Mariano</user>
  <user>Martin</user>
  <user>Leandro</user>
  <admin>Admin</admin>
  <admin>org_owner</admin>
</users>
```

Output XML:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<users>
  <user>Mariano</user>
  <user>Martin</user>
  <user>Leandro</user>
</users>
```

Note that unlike the multi-value selector, the output of this selector is an object, where the
original keys for each value are also extracted.

### Select All the Descendant Key-Value Pairs

This example uses the `..` and `&` selectors in `myVar.people..&name` to select and return an array
that contains all descendant objects from `myData` input that contain the key `name`. It also
transforms the JSON input to XML output.

DataWeave Script:

```dataweave
%dw 2.0
var myData = {
  "people": {
    "person": {
      "name": "Nial",
      "address": {
        "street": {
          "name": "Italia",
          "number": 2164
        },
        "area": {
          "zone": "San Isidro",
          "name": "Martinez"
        }
      }
    }
  }
}
output application/xml
---
names: {(myData.people..&name)}
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<names>
  <name>Nial</name>
  <name>Italia</name>
  <name>Martinez</name>
</names>
```

## Index Selector (`[anIndex]`)

The index selector returns the element at the specified position. It can be applied over an array,
object, or string.

### Index Selector Over an Array

This selector can be applied to String literals, Arrays and Objects. In the case of Objects, the
value of the key-value pair found at the index is returned. In the case of Arrays, the value of the
element is returned. The index is zero-based.

1.  If the index is bigger or equal to 0, it starts counting from the beginning.

2.  If the index is negative, it starts counting from the end where -1 is the last element.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
payload.people[1]
```

Input JSON Payload:

```json
{
  "people": [
    {
      "nameFirst": "Nial",
      "nameLast": "Martinez"
    },
    {
      "nameFirst": "Coty",
      "nameLast": "Belgrano"
    }
  ]
}
```

Output JSON:

```json
{
  "nameFirst": "Coty",
  "nameLast": "Belgrano"
}
```

### Index Selector Over an Object

The selector returns the value of the key-value pair at the specified position.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
payload[1]
```

Input JSON Payload:

```json
{
  "nameFirst": "Mark",
  "nameLast": "Nguyen"
}
```

Output JSON:

```json
"Nguyen"
```

### Index Selector Over a String

When using the Index Selector with a string, the string is broken down into an array, where each
character is an index.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{ name: "MuleSoft"[0] }
```

Output JSON:

```json
{ "name": "M" }
```

The selector picks the character at a given position, treating the string as an array of characters.

1.  If the index is bigger or equal to 0, it starts counting from the beginning.

2.  If the index is negative, it starts counting from the end.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{ name: "Emiliano"[0] }
```

Output JSON:

```json
{ "name": "E" }
```

## Range selector (`anIndex to anotherIndex`)

The `to` selector returns values of matching indices in an array or string. You can also use it to
reverse the order of the indices in the range. The selector treats characters in the string as
indices.

- Selecting an index from an array:

  - `[1,2,3,4][0]` returns `1`

    The index of the first element in an array is always `0`.

  - `[1,2,3,4][3]` returns `4`

### Range Selector Over an Array

Range selectors limit the output to only the elements specified by the range on that specific order.
This selector allows you to slice an array or even invert it.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
  slice: [0,1,2][0 to 1],
  last: [0,1,2][-1 to 0]
}
```

Output JSON:

```json
{
  "slice": [0, 1],
  "last": [2, 1, 0]
}
```

### Range Selector Over a String

The Range selector limits the output to only the elements specified by the range on that specific
order, treating the string as an array of characters. This selector enables you to slice a string or
invert it.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
  slice: "DataWeave"[0 to 1],
  middle : "superfragilisticexpialadocious"[10 to 13],
  last: "DataWeave"[-1 to 0]
}
```

Output JSON:

```json
{
  "slice": "Da",
  "middle": "list",
  "last": "evaeWataD"
}
```

## XML Attribute Selector (`.@myKey`)

`.@myKey` selects an attribute in an XML element.

Using `.@` without the key name returns an object containing the attributes as key-value pairs.

This DataWeave example reads an XML sample into a variable and uses `@` to select attributes from
the XML.

DataWeave Script:

```dataweave
%dw 2.0
var myVar = read('<product id="1" type="electronic">
  <brand>SomeBrand</brand>
</product>', 'application/xml')
output application/json
---
{
  item: [
  	{
      "type" : myVar.product.@."type",
      "name" : myVar.product.brand,
      "attributes": myVar.product.@
    }
  ]
}
```

Output JSON:

```json
{
  "item": [
    {
      "type": "electronic",
      "name": "SomeBrand",
      "attributes": {
        "id": "1",
        "type": "electronic"
      }
    }
  ]
}
```

## Namespace Selector (`#`)

`#` returns the XML namespace of a selected key as plain text.

DataWeave Script:

```dataweave
%dw 2.0
output text/plain
---
payload.order.#
```

Input XML Payload:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<ns0:order xmlns:ns0="http://orders.company.com">
  <name>Mark</name>
  <items>42</items>
  <orderdate>2017-01-04</orderdate>
</ns0:order>
```

Output Text:

```json
"http://orders.company.com"
```

## Selector Modifiers (`!`, `?`)

You can check for the presence of a given key.

- `!` evaluates the selection and fails with an exception message if the key is not present.

- `?` returns `true` if the selected key is present, `false` if not. Note that `?` is also used in
  [Filter Selectors (`myKey[?($ == "aValue")]`)](#filter_selectors).

### Assert Present Validator

`!` returns an error if any of the specified key is missing.

- `{ "name": "Annie" }.lastName!` returns an error with the message,
  `There is no key named 'lastName'`.

- Without the `!`, `{ "name": "Annie" }.lastName` returns `null`.

- When the key is present, `{ "name": "Annie" }.name!` the result is `"Annie"`.

### Key Present Validator

Returns `true` if the specified key is present in the object or as an attribute of an XML element.

This example returns `true` because the `name` key does exists.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
present: payload.name?
```

Input JSON Payload:

```json
{ "name": "Annie" }
```

Output XML:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<present>true</present>
```

`?` also works with XML attributes:

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
  item: {
    typePresent : payload.product.@."type"?
  }
}
```

Input XML Payload:

```xml
<product id="1" type="tv">
  <brand>Samsung</brand>
</product>
```

Output JSON:

```json
{
  "item": { "typePresent": true }
}
```

## Filter Selectors (`myKey[?($ == "aValue")]`)

`myKey[?($ == "aValue")]` returns only the values of matching keys within an array or object. Note
that `?` is also used in [Key Present Validator](#key_present). If no key-value pairs match, the
result is `null`.

The following example inputs the array of `name` keys returned by `*.name`, then checks for `name`
keys with the value `"Mariano"`. It filters out any values that do not match. Note that the `$`
references the value of the selected key.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{ users: payload.users.*name[?($ == "Mariano")] }
```

Input XML Payload:

```xml
<users>
  <name>Mariano</name>
  <name>Luis</name>
  <name>Mariano</name>
</users>
```

Output JSON:

```json
{
  "users": ["Mariano", "Mariano"]
}
```

The following example assumes the same [input](#input_filter_selectors) and returns all the
key-value pairs of the input because the expression `( 1 == 1 )` is true. Note that a false
expression, such as `( 1 == 2 )`, returns `null`.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{ users: payload.users.*name[?( 1 == 1)] }
```

Input XML Payload:

```xml
<users>
  <name>Mariano</name>
  <name>Luis</name>
  <name>Mariano</name>
</users>
```

Output JSON:

```json
{
  "users": ["Mariano", "Luis", "Mariano"]
}
```

The following example assumes the same [input](#input_filter_selectors). It uses `mapObject` to
iterate over the entire input object and return matching key-value pairs, filtering out any pairs
that do not match.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
payload mapObject { ($$) : $[?($=="Mariano")] }
```

Input XML Payload:

```xml
<users>
  <name>Mariano</name>
  <name>Luis</name>
  <name>Mariano</name>
</users>
```

Output JSON:

```json
{
  "users": {
    "name": "Mariano",
    "name": "Mariano"
  }
}
```

## Metadata Selector (.^someMetadata)

Returns the value of specified metadata for a Mule payload, variable, or attribute. The selector can
return the following metadata:

- Content length metadata: `.^contentLength` returns the content length of the value, if the value
  is present. For an example, see
  [Content Length Metadata Selector (.^contentLength)](#caret_contentlength).

- Class metadata: `.^class` returns the class of the Plain Old Java Object (POJO). For example,
  `{ "string" : payload.string.^class }` might return `{ "string": "java.lang.String" }` if the
  input payload defines a Java string, such as `simplePojo.string = "myString"`, in a simple POJO,
  and `{ "date" : payload.date.^class }` might return `{ "date": "java.util.Date" }`. For an
  example, see [Class Metadata Selector (.^class)](#caret_class).

- Encoding metadata: `.^encoding` returns the encoding of a value. For example,
  `{ "myEncoding" : payload.^encoding }` might return `{"myEncoding": "UTF-8"}` for an input POJO.
  For an example, see [Encoding Metadata Selector (.^encoding)](#caret_encoding).

- Media Type Selector: `.^mediaType` returns the MIME type of a value that includes parameters, for
  example, `application/json;charset=UTF-16`, and the expression in the value of
  `{ "myMediaType" : payload.^mediaType }` might return `"myMediaType": "**/**; charset=UTF-8"` for
  an input POJO. For an example, see [Media Type Metadata Selector (.^mediaType)](#caret_mediatype).

- MIME Type metadata: `.^mimeType` returns the MIME type (without parameters) of a value, for
  example, `application/json`, and `{ "myMimeType" : payload.^mimeType }` might return
  `{ "myMediaType": "**/**" }` for an input POJO. For an example, see
  [MIME Type Metadata Selector (.^mimeType)](#caret_mimetype).

- Raw metadata: `.^raw` returns the underlying data (typically, a binary value) of a plain old Java
  object (POJO). This selector is sometimes used when calculating an MD5 for hashes when checking
  for man-in-the-middle attacks. For examples, see [Raw Metadata Selector (.^raw)](#caret_raw).

- Custom metadata: `.^myCustomMetadata` returns the value of custom metadata. For examples, see
  [Custom Metadata Selector (.^myCustomMetadata)](#caret_custom_metadata).

### Content Length Metadata Selector (.^contentLength)

Returns the content length of the value, if the value is present.

In the following Mule app flow, the Logger uses `payload.^contentLength` to select the length of the
string `my string`, set in the Set Payload (`set-payload`) component.

Mule App XML in Anypoint Studio:

```XML
<flow name="setpayloadobjectFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="15" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <!-- Set the payload to "my string". -->
  <set-payload value='"my string"' doc:name="Set Payload" />
  <!-- Select the class to which "my string" belongs. -->
  <logger level="INFO" doc:name="Logger" message="#[payload.^contentLength]"/>
</flow>
```

The Studio console output shows that the length of the input string (`my string`) is eleven (`9`)
characters long. The length includes the blank space in the string.

Console Output in Anypoint Studio:

```txt
INFO  2019-05-07 16:59:33,690 [[MuleRuntime].cpuLight.07:
 [carets].caretsFlow.CPU_LITE @39f1dbde]
 [event: 28ce97a0-7124-11e9-acfe-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 11
```

### Class Metadata Selector (.^class)

Returns the class of the Plain Old Java Object (POJO). The value might result from calling a method
in a Java class or have a data type (such as `String` or `DateTime`) that DataWeave treats as a Java
value, for example:

- `{ "string" : payload.mystring.^class }` might return `{ "mystring": "java.lang.String" }` if the
  input payload defines a Java string, such as `simplePojo.string = "myString"`, in a simple POJO.

- `{ "mydate" : payload.mydate.^class }` might return `{ "mydate": "java.util.Date" }`.

In the following Mule app flow, the Logger uses `payload.^class` to select the Java class of
`"my string"`, set in the Set Payload (`set-payload`) component.

Mule App XML in Anypoint Studio:

```XML
<flow name="setpayloadobjectFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="15" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <!-- Set the payload to "my string". -->
  <set-payload value='"my string"' doc:name="Set Payload" />
  <!-- Select the class to which "my string" belongs. -->
  <logger level="INFO" doc:name="Logger" message="#[payload.^class]"/>
</flow>
```

The Studio console output shows that the payload string belongs to the class `java.lang.String`.

Console Output in Anypoint Studio:

```txt
INFO  2019-04-20 16:10:03,075 [[MuleRuntime].cpuLight.08:
 [setpayloadobject].setpayloadobjectFlow.CPU_LITE @6447187e]
 [event: 6da29400-63c1-11e9-98e0-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 java.lang.String
```

### Encoding Metadata Selector (.^encoding)

Returns the encoding of a value. For example, `{ "myEncoding" : payload.^encoding }` might return
`{"myEncoding": "UTF-8"}` for an input POJO.

In the following Mule app flow, the Logger uses `payload.^encoding` to select the encoding of
``"my string"`set in the Set Payload (`set-payload``) component. The Scheduler (`scheduler`)
component is simply an event source that regularly generates a new Mule event to hold the payload
set in Set Payload.

Mule App XML in Anypoint Studio:

```XML
<flow name="setpayloadobjectFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="15" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <!-- Set the payload to "my string". -->
  <set-payload value='"my string"' doc:name="Set Payload" />
  <!-- Select the encoding of "my string". -->
  <logger level="INFO" doc:name="Logger" message="#[payload.^encoding]"/>
</flow>
```

The Studio console output shows that the payload string has `UTF-8` encoding.

Console Output in Anypoint Studio:

```txt
INFO  2019-04-20 16:14:24,222 [[MuleRuntime].cpuLight.03:
 [setpayloadobject].setpayloadobjectFlow.CPU_LITE @62bea6a6]
 [event: 0938bf70-63c2-11e9-98e0-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 UTF-8
```

### Media Type Metadata Selector (.^mediaType)

Returns the MIME type of a value that includes parameters (for example,
`application/json;charset=UTF-16`). The expression in the value of
`{ "myMediaType" : payload.^mediaType }` might return `"myMediaType": "**/**; charset=UTF-8"` for an
input POJO.

In the following Mule app flow, the Logger uses `payload.^mediaType` to select the media type of
`2014-10-12T11:11:19-00:03` set in the Set Payload (`set-payload`) component.

Mule App XML in Anypoint Studio:

```XML
<flow name="setpayloadobjectFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="15" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <set-payload value='#[|2014-10-12T11:11:19-00:03| as DateTime]' doc:name="Set Payload" />
  <logger level="INFO" doc:name="Logger" message="#[payload.^mediaType]"/>
</flow>
```

The Studio console output shows that the `DateTime` payload has the
`application/java; charset=UTF-8` media type.

Console Output in Anypoint Studio:

INFO 2019-04-20 16:41:01,276 \[\[MuleRuntime\].cpuLight.04:
\[setpayloadobject\].setpayloadobjectFlow.CPU\_LITE @7e991c71\] \[event:
c0e96860-63c5-11e9-bcff-8c8590a99d48\]
rg.mule.runtime.core.internal.processor.LoggerMessageProcessor: application/java; charset=UTF-8

In the following Mule app flow, the Loggers use `payload.^mediaType` to select a string
`"my string"`, then to select a string that is set within an **fx** expression
(`#["my string as String type" as String]`) in the Set Payload (`set-payload`) component.

Mule App XML in Anypoint Studio:

```XML
<flow name="setpayloadobjectFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="15" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <!-- Set the payload to "my string". -->
  <set-payload value='"my string"' doc:name="Set Payload" />
  <!-- Select the media type of "my string". -->
  <logger level="INFO" doc:name="Logger" message='#[payload.^mediaType]'/>
  <!-- Set the payload using the fx expression "my string" as String. -->
  <set-payload value='#["my string as String type" as String]' doc:name="Set Payload" />
  <!-- Select the media type of a Java string. -->
  <logger level="INFO" doc:name="Logger" message='#[payload.^mediaType]'/>
</flow>
```

The Studio console output shows that the simple string has the media type `**/**`, while the string
that is set in the **fx** expression has the media type `application/java; charset=UTF-8`.

Console Output in Anypoint Studio:

```txt
INFO  2019-04-20 16:52:50,801 [[MuleRuntime].cpuLight.01:
 [setpayloadobject].setpayloadobjectFlow.CPU_LITE @5d914abe]
 [event: 68121cd0-63c7-11e9-bcff-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 */*

INFO  2019-04-20 16:52:51,085 [[MuleRuntime].cpuLight.01:
 [setpayloadobject].setpayloadobjectFlow.CPU_LITE @5d914abe]
 [event: 68121cd0-63c7-11e9-bcff-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 application/java; charset=UTF-8
```

### MIME Type Metadata Selector (.^mimeType)

Returns the MIME type (without parameters) of a value, for example, `application/json`, and
`{ "myMimeType" : payload.^mimeType }` might return `{ "myMediaType": "**/**" }` for an input POJO.

In the following Mule app flow, the Loggers use `payload.^mimeType` to select a string
`"my string"`, then to select a string that is set within an **fx** expression
(`#["my string as String type" as String]`) in the Set Payload (`set-payload`) component.

Mule App XML in Anypoint Studio:

```XML
<flow name="setpayloadobjectFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="15" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <!-- Set the payload to "my string". -->
  <set-payload value='"my string"' doc:name="Set Payload" />
  <!-- Select the MIME type of "my string". -->
  <logger level="INFO" doc:name="Logger" message='#[payload.^mimeType]'/>
  <!-- Set the payload using the fx expression "my string" as String. -->
  <set-payload value='#["my string as String type" as String]' doc:name="Set Payload" />
  <!-- Select the MIME type of a Java string. -->
  <logger level="INFO" doc:name="Logger" message='#[payload.^mimeType]'/>
</flow>
```

The Studio console output shows that the simple string has the MIME type `**/**`, while the string
that is set in the **fx** expression has the MIME type `application/java`.

Console Output in Anypoint Studio:

```txt
INFO  2019-04-20 17:02:07,762 [[MuleRuntime].cpuLight.06:
 [setpayloadobject].setpayloadobjectFlow.CPU_LITE @2d6f64b9]
 [event: b4097b00-63c8-11e9-bcff-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 */*

INFO  2019-04-20 17:02:08,029 [[MuleRuntime].cpuLight.06:
 [setpayloadobject].setpayloadobjectFlow.CPU_LITE @2d6f64b9]
 [event: b4097b00-63c8-11e9-bcff-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 application/java
```

### Raw Metadata Selector (.^raw)

Returns the underlying binary value of a POJO. This selector is sometimes used when calculating an
MD5 or some other cryptographic hash function to check for man-in-the-middle (MITM) attacks.

The following example uses the Set Payload component (`set-payload`) to produce a binary value, then
uses the Transform Message component (`ee:transform`) component to return raw data for the MD5
(`MD5(payload.^raw)`) of the binary value. The Logger component (`logger`) is also set to write the
raw data to the Studio console. For comparison, the second Logger returns the typical `payload` in a
standard JSON format.

Mule App XML in Anypoint Studio:

```XML
<flow name="rawcaret2Flow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="30" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <set-payload value='#["1234-5678-9123" as Binary]' doc:name="Set Payload" />
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
import * from dw::Crypto
output application/json
---
{ "myRawData" : MD5(payload.^raw) }]]></ee:set-payload>
    </ee:message>
  </ee:transform>
  <logger level="INFO" doc:name="Logger" message="#[payload.^raw]"/>
  <logger level="INFO" doc:name="Logger" message="#[payload]"/>
</flow>
```

Notice that instead of producing standard JSON output, the raw output in the Logger message
surrounds the entire payload in double-quotes and inserts new line characters (`\n`) for each new
line.

Console Output in Anypoint Studio:

```txt
INFO  2019-04-22 14:10:14,537 [[MuleRuntime].cpuLight.08:
 [rawcaret2].rawcaret2Flow.CPU_LITE @764a5a61]
 [event: 058f6a90-6543-11e9-9d99-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 "{\n  "myRawData": "5403e5a202c594871d59898b13054be5"\n}"

INFO  2019-04-22 14:10:14,540 [[MuleRuntime].cpuLight.08:
 [rawcaret2].rawcaret2Flow.CPU_LITE @764a5a61]
 [event: 058f6a90-6543-11e9-9d99-8c8590a99d48]
 org.mule.runtime.core.internal.processor.LoggerMessageProcessor:
 { "myRawData": "5403e5a202c594871d59898b13054be5" }
```

The following example uses the HTTP Listener source (`listener`) to get the XML payload received via
a POST request, then uses the Transform Message component (`ee:transform`) to get the encoding value
of the XML payload, by returning the raw data
(`(payload.^raw as String) scan /encoding='([A-z0-9-]+)'/)`). The Logger component (`logger`)
returns the `payload` in a JAVA format.

Mule App XML in Anypoint Studio:

```XML
<http:listener-config name="HTTP_Listener_config" >
    <http:listener-connection host="0.0.0.0" port="8081" />
</http:listener-config>
<flow name="test-flow">
	<http:listener path="/test" config-ref="HTTP_Listener_config"/>
	<ee:transform>
		<ee:message>
		<ee:set-payload ><![CDATA[%dw 2.0
output application/java
---
((payload.^raw as String) scan /encoding='([A-z0-9-]+)'/)[0][1]]]></ee:set-payload>
		</ee:message>
	</ee:transform>
	<logger level="INFO" message="#[payload]"/>
</flow>
```

Using your preferred REST client or API testing tool, send a POST request with the XML body:

```XML
<?xml version='1.0' encoding='ISO-8859-1'?>
<test>
</test>
```

The Logger message returns the extracted encoding value `ISO-8859-1`:

Console Output in Anypoint Studio:

```txt
INFO  2021-05-12 12:25:41,618 [[MuleRuntime].uber.03: [xmlmodule].Flow.CPU_INTENSIVE @de48fc8] [processor: Flow/processors/2; event: 4fe7f6a0-b336-11eb-909c-f01898ad2638] org.mule.runtime.core.internal.processor.LoggerMessageProcessor: ISO-8859-1
```

### Custom Metadata Selector (.^myCustomMetadata)

Returns the value of custom metadata. Metadata can be associated with any value by using the `as`
operator.

The following example uses `userName.^myCustomMetadata` to return the value of custom metadata that
is defined as a variable (named `userName`) in the header of the script as a DataWeave script. For
comparison, the example also returns the value of `userName`.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
var userName = "DataWeave" as String {myCustomMetadata: "customMetadataValue"}
---

{
  "valueOfVariableMetaData" :  userName.^myCustomMetadata,
  "valueOfVariable" :  userName,
}
```

The output of the script is `"customMetadataValue"` for the value of the custom metadata and
`"DataWeave"` for value of the `userName` variable.

Output JSON:

```json
{
  "valueOfVariableMetaData": "customMetadataValue",
  "valueOfVariable": "DataWeave"
}
```

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors)

- [DataWeave Quickstart](https://docs.mulesoft.com/dataweave/latest/dataweave-quickstart)

- [DataWeave Types](https://docs.mulesoft.com/dataweave/latest/dataweave-types)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook)

<!-- document id=76bdfa02e65b0c38e9ba0be927d47340e282e3932bf89973b293e0eb3149b3b8 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook-pluck.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, transform, transformer, format, dataweave, data weave, output structure, mime type, mime
---

# Extract Key-Value Pairs with `Pluck` Function

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

In addition to using the DataWeave functions such as [entriesOf](https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-entriesof),
[keysOf](https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-keysof), or [valuesOf](https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-valuesof) to work with key-value
pairs, you can also use [pluck](https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-pluck). The following Mule app example shows how
to use the DataWeave `pluck` function to extract key-value pairs from a JSON payload and store them
into Mule event variables with variable names as the keys and their corresponding values.

The Mule app consists of:

- A Scheduler component that triggers the flow

- A Set Payload component that sets the JSON payload

- A Transform Message component that transforms the content read from the Set Payload component by
  extracting the key-value pairs with the `pluck` function and putting them into an array

- A For Each scope component that iterates over the array

- A Set Variable component that sets the variable name as the Key and variable value as the Value in
  the JSON array

- A Logger component that prints the variable results per each iteration

![Mule app flow example in Studio canvas](/mulesoft/current/en-us/dataweave/2.11/_images/dataweave-cookbook-pluck-examples.png)

Application XML File (reformatted for readability):

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
      xmlns="http://www.mulesoft.org/schema/mule/core"
      xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd">
      <flow name="json-varsFlow" >
            <scheduler doc:name="Scheduler" >
	          <scheduling-strategy >
		        <fixed-frequency frequency="10000"/>
                  </scheduling-strategy>
	    </scheduler>
	    <set-payload value='{"firstName": "jason", "job": "engineer", "dept":"support"}'
	                 doc:name="Set Payload"
			 mimeType="application/json" />
	    <ee:transform doc:name="Transform Message" >
	          <ee:message >
		        <ee:set-payload ><![CDATA[%dw 2.0
output application/json
---

payload pluck (value,key)  -> {
	Test:{
		Key: key,
		Value: value
	}
}]]></ee:set-payload>
                  </ee:message>
            </ee:transform>
	    <foreach doc:name="For Each"
	             collection="#[payload.Test]">
	                <logger level="INFO" doc:name="Logger" message="#[payload]" />
		        <set-variable value="#[payload.Value]"
		                      doc:name="Set Variable"
				      variableName="#[payload.Key]"/>
		        <logger level="INFO"
		                doc:name="Logger"
			        message="#[vars[payload.Key]]"/>
            </foreach>
      </flow>
</mule>
```

Note that the Transform Message configures the following DataWeave script:

```dataweave
%dw 2.0
output application/json
---
payload pluck (value,key)  -> {
  Test: {
    Key: key,
    Value: value
  }
}
```

When the Mule app executes with the following JSON payload:

```json
{
  "firstName": "jason",
  "job": "engineer",
  "dept": "support"
}
```

The DataWeave transformation result is:

```json
[
  {
    "Test": {
      "Key": "firstName",
      "Value": "jason"
    }
  },
  {
    "Test": {
      "Key": "job",
      "Value": "engineer"
    }
  },
  {
    "Test": {
      "Key": "dept",
      "Value": "support"
    }
  }
]
```

The For Each scope component iterates over the transformed values, and the app logs the values of
the variable results (reformatted for readability):

INFO 2022-06-22 10:11:17,864 \[\[MuleRuntime\].uber.02: \[jsonsample\].json-varsFlow.CPU\_INTENSIVE
@5c652aa\] \[processor: json-varsFlow/processors/2/processors/0; event:
545f5ef0-f24e-11ec-8c92-147ddaaf4f97\]
org.mule.runtime.core.internal.processor.LoggerMessageProcessor: { "Key": "firstName", "Value":
"jason" } INFO 2022-06-22 10:11:17,870 \[\[MuleRuntime\].uber.02:
\[jsonsample\].json-varsFlow.CPU\_INTENSIVE @5c652aa\] \[processor:
json-varsFlow/processors/2/processors/2; event: 545f5ef0-f24e-11ec-8c92-147ddaaf4f97\]
org.mule.runtime.core.internal.processor.LoggerMessageProcessor: "jason" INFO 2022-06-22
10:11:17,871 \[\[MuleRuntime\].uber.02: \[jsonsample\].json-varsFlow.CPU\_INTENSIVE @5c652aa\]
\[processor: json-varsFlow/processors/2/processors/0; event: 545f5ef0-f24e-11ec-8c92-147ddaaf4f97\]
org.mule.runtime.core.internal.processor.LoggerMessageProcessor: { "Key": "job", "Value": "engineer"
} INFO 2022-06-22 10:11:17,875 \[\[MuleRuntime\].uber.02:
\[jsonsample\].json-varsFlow.CPU\_INTENSIVE @5c652aa\] \[processor:
json-varsFlow/processors/2/processors/2; event: 545f5ef0-f24e-11ec-8c92-147ddaaf4f97\]
org.mule.runtime.core.internal.processor.LoggerMessageProcessor: "engineer" INFO 2022-06-22
10:11:17,877 \[\[MuleRuntime\].uber.02: \[jsonsample\].json-varsFlow.CPU\_INTENSIVE @5c652aa\]
\[processor: json-varsFlow/processors/2/processors/0; event: 545f5ef0-f24e-11ec-8c92-147ddaaf4f97\]
org.mule.runtime.core.internal.processor.LoggerMessageProcessor: { "Key": "dept", "Value": "support"
} INFO 2022-06-22 10:11:17,879 \[\[MuleRuntime\].uber.02:
\[jsonsample\].json-varsFlow.CPU\_INTENSIVE @5c652aa\] \[processor:
json-varsFlow/processors/2/processors/2; event: 545f5ef0-f24e-11ec-8c92-147ddaaf4f97\]
org.mule.runtime.core.internal.processor.LoggerMessageProcessor: "support"

## See Also

- [DataWeave Formats](https://docs.mulesoft.com/dataweave/2.11/dataweave-formats)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook)

<!-- document id=6744ee6f7b15b189f758c7dd38f257a2fbaba2e3e88f7de5a709bc5f07a0dc05 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook-pluck.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, transform, transformer, format, dataweave, data weave, output structure, mime type, mime
---

# Extract Key-Value Pairs with `Pluck` Function

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

In addition to using the DataWeave functions such as [entriesOf](https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-entriesof),
[keysOf](https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-keysof), or [valuesOf](https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-valuesof) to work with key-value
pairs, you can also use [pluck](https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-pluck). The following Mule app example shows how
to use the DataWeave `pluck` function to extract key-value pairs from a JSON payload and store them
into Mule event variables with variable names as the keys and their corresponding values.

The Mule app consists of:

- A Scheduler component that triggers the flow

- A Set Payload component that sets the JSON payload

- A Transform Message component that transforms the content read from the Set Payload component by
  extracting the key-value pairs with the `pluck` function and putting them into an array

- A For Each scope component that iterates over the array

- A Set Variable component that sets the variable name as the Key and variable value as the Value in
  the JSON array

- A Logger component that prints the variable results per each iteration

![Mule app flow example in Studio canvas](/mulesoft/current/en-us/dataweave/2.12/_images/dataweave-cookbook-pluck-examples.png)

Application XML File (reformatted for readability):

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
      xmlns="http://www.mulesoft.org/schema/mule/core"
      xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd">
      <flow name="json-varsFlow" >
            <scheduler doc:name="Scheduler" >
	          <scheduling-strategy >
		        <fixed-frequency frequency="10000"/>
                  </scheduling-strategy>
	    </scheduler>
	    <set-payload value='{"firstName": "jason", "job": "engineer", "dept":"support"}'
	                 doc:name="Set Payload"
			 mimeType="application/json" />
	    <ee:transform doc:name="Transform Message" >
	          <ee:message >
		        <ee:set-payload ><![CDATA[%dw 2.0
output application/json
---

payload pluck (value,key)  -> {
	Test:{
		Key: key,
		Value: value
	}
}]]></ee:set-payload>
                  </ee:message>
            </ee:transform>
	    <foreach doc:name="For Each"
	             collection="#[payload.Test]">
	                <logger level="INFO" doc:name="Logger" message="#[payload]" />
		        <set-variable value="#[payload.Value]"
		                      doc:name="Set Variable"
				      variableName="#[payload.Key]"/>
		        <logger level="INFO"
		                doc:name="Logger"
			        message="#[vars[payload.Key]]"/>
            </foreach>
      </flow>
</mule>
```

Note that the Transform Message configures the following DataWeave script:

```dataweave
%dw 2.0
output application/json
---
payload pluck (value,key)  -> {
  Test: {
    Key: key,
    Value: value
  }
}
```

When the Mule app executes with the following JSON payload:

```json
{
  "firstName": "jason",
  "job": "engineer",
  "dept": "support"
}
```

The DataWeave transformation result is:

```json
[
  {
    "Test": {
      "Key": "firstName",
      "Value": "jason"
    }
  },
  {
    "Test": {
      "Key": "job",
      "Value": "engineer"
    }
  },
  {
    "Test": {
      "Key": "dept",
      "Value": "support"
    }
  }
]
```

The For Each scope component iterates over the transformed values, and the app logs the values of
the variable results (reformatted for readability):

INFO 2022-06-22 10:11:17,864 \[\[MuleRuntime\].uber.02: \[jsonsample\].json-varsFlow.CPU\_INTENSIVE
@5c652aa\] \[processor: json-varsFlow/processors/2/processors/0; event:
545f5ef0-f24e-11ec-8c92-147ddaaf4f97\]
org.mule.runtime.core.internal.processor.LoggerMessageProcessor: { "Key": "firstName", "Value":
"jason" } INFO 2022-06-22 10:11:17,870 \[\[MuleRuntime\].uber.02:
\[jsonsample\].json-varsFlow.CPU\_INTENSIVE @5c652aa\] \[processor:
json-varsFlow/processors/2/processors/2; event: 545f5ef0-f24e-11ec-8c92-147ddaaf4f97\]
org.mule.runtime.core.internal.processor.LoggerMessageProcessor: "jason" INFO 2022-06-22
10:11:17,871 \[\[MuleRuntime\].uber.02: \[jsonsample\].json-varsFlow.CPU\_INTENSIVE @5c652aa\]
\[processor: json-varsFlow/processors/2/processors/0; event: 545f5ef0-f24e-11ec-8c92-147ddaaf4f97\]
org.mule.runtime.core.internal.processor.LoggerMessageProcessor: { "Key": "job", "Value": "engineer"
} INFO 2022-06-22 10:11:17,875 \[\[MuleRuntime\].uber.02:
\[jsonsample\].json-varsFlow.CPU\_INTENSIVE @5c652aa\] \[processor:
json-varsFlow/processors/2/processors/2; event: 545f5ef0-f24e-11ec-8c92-147ddaaf4f97\]
org.mule.runtime.core.internal.processor.LoggerMessageProcessor: "engineer" INFO 2022-06-22
10:11:17,877 \[\[MuleRuntime\].uber.02: \[jsonsample\].json-varsFlow.CPU\_INTENSIVE @5c652aa\]
\[processor: json-varsFlow/processors/2/processors/0; event: 545f5ef0-f24e-11ec-8c92-147ddaaf4f97\]
org.mule.runtime.core.internal.processor.LoggerMessageProcessor: { "Key": "dept", "Value": "support"
} INFO 2022-06-22 10:11:17,879 \[\[MuleRuntime\].uber.02:
\[jsonsample\].json-varsFlow.CPU\_INTENSIVE @5c652aa\] \[processor:
json-varsFlow/processors/2/processors/2; event: 545f5ef0-f24e-11ec-8c92-147ddaaf4f97\]
org.mule.runtime.core.internal.processor.LoggerMessageProcessor: "support"

## See Also

- [DataWeave Formats](https://docs.mulesoft.com/dataweave/2.12/dataweave-formats)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook)

<!-- document id=b6fd2d5aaefe019e31aaddf5e40c22b0ede2b81686e48f9479fbbc61467a51ff url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook-pluck.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, transform, transformer, format, dataweave, data weave, output structure, mime type, mime
---

# Extract Key-Value Pairs with `Pluck` Function

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

In addition to using the DataWeave functions such as [entriesOf](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-entriesof),
[keysOf](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-keysof), or [valuesOf](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-valuesof) to work with key-value
pairs, you can also use [pluck](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-pluck). The following Mule app example shows how
to use the DataWeave `pluck` function to extract key-value pairs from a JSON payload and store them
into Mule event variables with variable names as the keys and their corresponding values.

The Mule app consists of:

- A Scheduler component that triggers the flow

- A Set Payload component that sets the JSON payload

- A Transform Message component that transforms the content read from the Set Payload component by
  extracting the key-value pairs with the `pluck` function and putting them into an array

- A For Each scope component that iterates over the array

- A Set Variable component that sets the variable name as the Key and variable value as the Value in
  the JSON array

- A Logger component that prints the variable results per each iteration

![Mule app flow example in Studio canvas](/mulesoft/current/en-us/dataweave/2.4/_images/dataweave-cookbook-pluck-examples.png)

Application XML File (reformatted for readability):

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
      xmlns="http://www.mulesoft.org/schema/mule/core"
      xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd">
      <flow name="json-varsFlow" >
            <scheduler doc:name="Scheduler" >
	          <scheduling-strategy >
		        <fixed-frequency frequency="10000"/>
                  </scheduling-strategy>
	    </scheduler>
	    <set-payload value='{"firstName": "jason", "job": "engineer", "dept":"support"}'
	                 doc:name="Set Payload"
			 mimeType="application/json" />
	    <ee:transform doc:name="Transform Message" >
	          <ee:message >
		        <ee:set-payload ><![CDATA[%dw 2.0
output application/json
---

payload pluck (value,key)  -> {
	Test:{
		Key: key,
		Value: value
	}
}]]></ee:set-payload>
                  </ee:message>
            </ee:transform>
	    <foreach doc:name="For Each"
	             collection="#[payload.Test]">
	                <logger level="INFO" doc:name="Logger" message="#[payload]" />
		        <set-variable value="#[payload.Value]"
		                      doc:name="Set Variable"
				      variableName="#[payload.Key]"/>
		        <logger level="INFO"
		                doc:name="Logger"
			        message="#[vars[payload.Key]]"/>
            </foreach>
      </flow>
</mule>
```

Note that the Transform Message configures the following DataWeave script:

```dataweave
%dw 2.0
output application/json
---
payload pluck (value,key)  -> {
  Test: {
    Key: key,
    Value: value
  }
}
```

When the the Mule app executes with the following JSON payload:

```json
{
  "firstName": "jason",
  "job": "engineer",
  "dept": "support"
}
```

The DataWeave transformation result is:

```json
[
  {
    "Test": {
      "Key": "firstName",
      "Value": "jason"
    }
  },
  {
    "Test": {
      "Key": "job",
      "Value": "engineer"
    }
  },
  {
    "Test": {
      "Key": "dept",
      "Value": "support"
    }
  }
]
```

The For Each scope component iterates over the transformed values, and the app logs the values of
the variable results (reformatted for readability):

INFO 2022-06-22 10:11:17,864 \[\[MuleRuntime\].uber.02: \[jsonsample\].json-varsFlow.CPU\_INTENSIVE
@5c652aa\] \[processor: json-varsFlow/processors/2/processors/0; event:
545f5ef0-f24e-11ec-8c92-147ddaaf4f97\]
org.mule.runtime.core.internal.processor.LoggerMessageProcessor: { "Key": "firstName", "Value":
"jason" } INFO 2022-06-22 10:11:17,870 \[\[MuleRuntime\].uber.02:
\[jsonsample\].json-varsFlow.CPU\_INTENSIVE @5c652aa\] \[processor:
json-varsFlow/processors/2/processors/2; event: 545f5ef0-f24e-11ec-8c92-147ddaaf4f97\]
org.mule.runtime.core.internal.processor.LoggerMessageProcessor: "jason" INFO 2022-06-22
10:11:17,871 \[\[MuleRuntime\].uber.02: \[jsonsample\].json-varsFlow.CPU\_INTENSIVE @5c652aa\]
\[processor: json-varsFlow/processors/2/processors/0; event: 545f5ef0-f24e-11ec-8c92-147ddaaf4f97\]
org.mule.runtime.core.internal.processor.LoggerMessageProcessor: { "Key": "job", "Value": "engineer"
} INFO 2022-06-22 10:11:17,875 \[\[MuleRuntime\].uber.02:
\[jsonsample\].json-varsFlow.CPU\_INTENSIVE @5c652aa\] \[processor:
json-varsFlow/processors/2/processors/2; event: 545f5ef0-f24e-11ec-8c92-147ddaaf4f97\]
org.mule.runtime.core.internal.processor.LoggerMessageProcessor: "engineer" INFO 2022-06-22
10:11:17,877 \[\[MuleRuntime\].uber.02: \[jsonsample\].json-varsFlow.CPU\_INTENSIVE @5c652aa\]
\[processor: json-varsFlow/processors/2/processors/0; event: 545f5ef0-f24e-11ec-8c92-147ddaaf4f97\]
org.mule.runtime.core.internal.processor.LoggerMessageProcessor: { "Key": "dept", "Value": "support"
} INFO 2022-06-22 10:11:17,879 \[\[MuleRuntime\].uber.02:
\[jsonsample\].json-varsFlow.CPU\_INTENSIVE @5c652aa\] \[processor:
json-varsFlow/processors/2/processors/2; event: 545f5ef0-f24e-11ec-8c92-147ddaaf4f97\]
org.mule.runtime.core.internal.processor.LoggerMessageProcessor: "support"

## See Also

- [DataWeave Formats](https://docs.mulesoft.com/dataweave/2.4/dataweave-formats)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook)

<!-- document id=5891c88c4ccc1f2924c1ce24ebffeeadf8edeff5781b1734f92eb5f3485ccd92 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook-pluck.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, transform, transformer, format, dataweave, data weave, output structure, mime type, mime
---

# Extract Key-Value Pairs with `Pluck` Function

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

In addition to using the DataWeave functions such as [entriesOf](https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-entriesof),
[keysOf](https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-keysof), or [valuesOf](https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-valuesof) to work with key-value
pairs, you can also use [pluck](https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-pluck). The following Mule app example shows how
to use the DataWeave `pluck` function to extract key-value pairs from a JSON payload and store them
into Mule event variables with variable names as the keys and their corresponding values.

The Mule app consists of:

- A Scheduler component that triggers the flow

- A Set Payload component that sets the JSON payload

- A Transform Message component that transforms the content read from the Set Payload component by
  extracting the key-value pairs with the `pluck` function and putting them into an array

- A For Each scope component that iterates over the array

- A Set Variable component that sets the variable name as the Key and variable value as the Value in
  the JSON array

- A Logger component that prints the variable results per each iteration

![Mule app flow example in Studio canvas](/mulesoft/current/en-us/dataweave/2.6/_images/dataweave-cookbook-pluck-examples.png)

Application XML File (reformatted for readability):

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
      xmlns="http://www.mulesoft.org/schema/mule/core"
      xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd">
      <flow name="json-varsFlow" >
            <scheduler doc:name="Scheduler" >
	          <scheduling-strategy >
		        <fixed-frequency frequency="10000"/>
                  </scheduling-strategy>
	    </scheduler>
	    <set-payload value='{"firstName": "jason", "job": "engineer", "dept":"support"}'
	                 doc:name="Set Payload"
			 mimeType="application/json" />
	    <ee:transform doc:name="Transform Message" >
	          <ee:message >
		        <ee:set-payload ><![CDATA[%dw 2.0
output application/json
---

payload pluck (value,key)  -> {
	Test:{
		Key: key,
		Value: value
	}
}]]></ee:set-payload>
                  </ee:message>
            </ee:transform>
	    <foreach doc:name="For Each"
	             collection="#[payload.Test]">
	                <logger level="INFO" doc:name="Logger" message="#[payload]" />
		        <set-variable value="#[payload.Value]"
		                      doc:name="Set Variable"
				      variableName="#[payload.Key]"/>
		        <logger level="INFO"
		                doc:name="Logger"
			        message="#[vars[payload.Key]]"/>
            </foreach>
      </flow>
</mule>
```

Note that the Transform Message configures the following DataWeave script:

```dataweave
%dw 2.0
output application/json
---
payload pluck (value,key)  -> {
  Test: {
    Key: key,
    Value: value
  }
}
```

When the the Mule app executes with the following JSON payload:

```json
{
  "firstName": "jason",
  "job": "engineer",
  "dept": "support"
}
```

The DataWeave transformation result is:

```json
[
  {
    "Test": {
      "Key": "firstName",
      "Value": "jason"
    }
  },
  {
    "Test": {
      "Key": "job",
      "Value": "engineer"
    }
  },
  {
    "Test": {
      "Key": "dept",
      "Value": "support"
    }
  }
]
```

The For Each scope component iterates over the transformed values, and the app logs the values of
the variable results (reformatted for readability):

INFO 2022-06-22 10:11:17,864 \[\[MuleRuntime\].uber.02: \[jsonsample\].json-varsFlow.CPU\_INTENSIVE
@5c652aa\] \[processor: json-varsFlow/processors/2/processors/0; event:
545f5ef0-f24e-11ec-8c92-147ddaaf4f97\]
org.mule.runtime.core.internal.processor.LoggerMessageProcessor: { "Key": "firstName", "Value":
"jason" } INFO 2022-06-22 10:11:17,870 \[\[MuleRuntime\].uber.02:
\[jsonsample\].json-varsFlow.CPU\_INTENSIVE @5c652aa\] \[processor:
json-varsFlow/processors/2/processors/2; event: 545f5ef0-f24e-11ec-8c92-147ddaaf4f97\]
org.mule.runtime.core.internal.processor.LoggerMessageProcessor: "jason" INFO 2022-06-22
10:11:17,871 \[\[MuleRuntime\].uber.02: \[jsonsample\].json-varsFlow.CPU\_INTENSIVE @5c652aa\]
\[processor: json-varsFlow/processors/2/processors/0; event: 545f5ef0-f24e-11ec-8c92-147ddaaf4f97\]
org.mule.runtime.core.internal.processor.LoggerMessageProcessor: { "Key": "job", "Value": "engineer"
} INFO 2022-06-22 10:11:17,875 \[\[MuleRuntime\].uber.02:
\[jsonsample\].json-varsFlow.CPU\_INTENSIVE @5c652aa\] \[processor:
json-varsFlow/processors/2/processors/2; event: 545f5ef0-f24e-11ec-8c92-147ddaaf4f97\]
org.mule.runtime.core.internal.processor.LoggerMessageProcessor: "engineer" INFO 2022-06-22
10:11:17,877 \[\[MuleRuntime\].uber.02: \[jsonsample\].json-varsFlow.CPU\_INTENSIVE @5c652aa\]
\[processor: json-varsFlow/processors/2/processors/0; event: 545f5ef0-f24e-11ec-8c92-147ddaaf4f97\]
org.mule.runtime.core.internal.processor.LoggerMessageProcessor: { "Key": "dept", "Value": "support"
} INFO 2022-06-22 10:11:17,879 \[\[MuleRuntime\].uber.02:
\[jsonsample\].json-varsFlow.CPU\_INTENSIVE @5c652aa\] \[processor:
json-varsFlow/processors/2/processors/2; event: 545f5ef0-f24e-11ec-8c92-147ddaaf4f97\]
org.mule.runtime.core.internal.processor.LoggerMessageProcessor: "support"

## See Also

- [DataWeave Formats](https://docs.mulesoft.com/dataweave/2.6/dataweave-formats)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook)

<!-- document id=2b4886e9baf589c52221eeee493781c5217f0e5b62ba9d651800976b223ef963 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook-pluck.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, transform, transformer, format, dataweave, data weave, output structure, mime type, mime
---

# Extract Key-Value Pairs with `Pluck` Function

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

In addition to using the DataWeave functions such as [entriesOf](https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-entriesof),
[keysOf](https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-keysof), or [valuesOf](https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-valuesof) to work with key-value
pairs, you can also use [pluck](https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-pluck). The following Mule app example shows how
to use the DataWeave `pluck` function to extract key-value pairs from a JSON payload and store them
into Mule event variables with variable names as the keys and their corresponding values.

The Mule app consists of:

- A Scheduler component that triggers the flow

- A Set Payload component that sets the JSON payload

- A Transform Message component that transforms the content read from the Set Payload component by
  extracting the key-value pairs with the `pluck` function and putting them into an array

- A For Each scope component that iterates over the array

- A Set Variable component that sets the variable name as the Key and variable value as the Value in
  the JSON array

- A Logger component that prints the variable results per each iteration

![Mule app flow example in Studio canvas](/mulesoft/current/en-us/dataweave/2.9/_images/dataweave-cookbook-pluck-examples.png)

Application XML File (reformatted for readability):

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
      xmlns="http://www.mulesoft.org/schema/mule/core"
      xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd">
      <flow name="json-varsFlow" >
            <scheduler doc:name="Scheduler" >
	          <scheduling-strategy >
		        <fixed-frequency frequency="10000"/>
                  </scheduling-strategy>
	    </scheduler>
	    <set-payload value='{"firstName": "jason", "job": "engineer", "dept":"support"}'
	                 doc:name="Set Payload"
			 mimeType="application/json" />
	    <ee:transform doc:name="Transform Message" >
	          <ee:message >
		        <ee:set-payload ><![CDATA[%dw 2.0
output application/json
---

payload pluck (value,key)  -> {
	Test:{
		Key: key,
		Value: value
	}
}]]></ee:set-payload>
                  </ee:message>
            </ee:transform>
	    <foreach doc:name="For Each"
	             collection="#[payload.Test]">
	                <logger level="INFO" doc:name="Logger" message="#[payload]" />
		        <set-variable value="#[payload.Value]"
		                      doc:name="Set Variable"
				      variableName="#[payload.Key]"/>
		        <logger level="INFO"
		                doc:name="Logger"
			        message="#[vars[payload.Key]]"/>
            </foreach>
      </flow>
</mule>
```

Note that the Transform Message configures the following DataWeave script:

```dataweave
%dw 2.0
output application/json
---
payload pluck (value,key)  -> {
  Test: {
    Key: key,
    Value: value
  }
}
```

When the Mule app executes with the following JSON payload:

```json
{
  "firstName": "jason",
  "job": "engineer",
  "dept": "support"
}
```

The DataWeave transformation result is:

```json
[
  {
    "Test": {
      "Key": "firstName",
      "Value": "jason"
    }
  },
  {
    "Test": {
      "Key": "job",
      "Value": "engineer"
    }
  },
  {
    "Test": {
      "Key": "dept",
      "Value": "support"
    }
  }
]
```

The For Each scope component iterates over the transformed values, and the app logs the values of
the variable results (reformatted for readability):

INFO 2022-06-22 10:11:17,864 \[\[MuleRuntime\].uber.02: \[jsonsample\].json-varsFlow.CPU\_INTENSIVE
@5c652aa\] \[processor: json-varsFlow/processors/2/processors/0; event:
545f5ef0-f24e-11ec-8c92-147ddaaf4f97\]
org.mule.runtime.core.internal.processor.LoggerMessageProcessor: { "Key": "firstName", "Value":
"jason" } INFO 2022-06-22 10:11:17,870 \[\[MuleRuntime\].uber.02:
\[jsonsample\].json-varsFlow.CPU\_INTENSIVE @5c652aa\] \[processor:
json-varsFlow/processors/2/processors/2; event: 545f5ef0-f24e-11ec-8c92-147ddaaf4f97\]
org.mule.runtime.core.internal.processor.LoggerMessageProcessor: "jason" INFO 2022-06-22
10:11:17,871 \[\[MuleRuntime\].uber.02: \[jsonsample\].json-varsFlow.CPU\_INTENSIVE @5c652aa\]
\[processor: json-varsFlow/processors/2/processors/0; event: 545f5ef0-f24e-11ec-8c92-147ddaaf4f97\]
org.mule.runtime.core.internal.processor.LoggerMessageProcessor: { "Key": "job", "Value": "engineer"
} INFO 2022-06-22 10:11:17,875 \[\[MuleRuntime\].uber.02:
\[jsonsample\].json-varsFlow.CPU\_INTENSIVE @5c652aa\] \[processor:
json-varsFlow/processors/2/processors/2; event: 545f5ef0-f24e-11ec-8c92-147ddaaf4f97\]
org.mule.runtime.core.internal.processor.LoggerMessageProcessor: "engineer" INFO 2022-06-22
10:11:17,877 \[\[MuleRuntime\].uber.02: \[jsonsample\].json-varsFlow.CPU\_INTENSIVE @5c652aa\]
\[processor: json-varsFlow/processors/2/processors/0; event: 545f5ef0-f24e-11ec-8c92-147ddaaf4f97\]
org.mule.runtime.core.internal.processor.LoggerMessageProcessor: { "Key": "dept", "Value": "support"
} INFO 2022-06-22 10:11:17,879 \[\[MuleRuntime\].uber.02:
\[jsonsample\].json-varsFlow.CPU\_INTENSIVE @5c652aa\] \[processor:
json-varsFlow/processors/2/processors/2; event: 545f5ef0-f24e-11ec-8c92-147ddaaf4f97\]
org.mule.runtime.core.internal.processor.LoggerMessageProcessor: "support"

## See Also

- [DataWeave Formats](https://docs.mulesoft.com/dataweave/2.9/dataweave-formats)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook)

<!-- document id=cc15be7f6602f45eb5f87f11f153dc71c77cf657e4412a14cd577b7eacee5f80 url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook-pluck.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, transform, transformer, format, dataweave, data weave, output structure, mime type, mime
---

# Extract Key-Value Pairs with `Pluck` Function

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

In addition to using the DataWeave functions such as [entriesOf](https://docs.mulesoft.com/dataweave/latest/dw-core-functions-entriesof),
[keysOf](https://docs.mulesoft.com/dataweave/latest/dw-core-functions-keysof), or [valuesOf](https://docs.mulesoft.com/dataweave/latest/dw-core-functions-valuesof) to work with key-value
pairs, you can also use [pluck](https://docs.mulesoft.com/dataweave/latest/dw-core-functions-pluck). The following Mule app example shows how
to use the DataWeave `pluck` function to extract key-value pairs from a JSON payload and store them
into Mule event variables with variable names as the keys and their corresponding values.

The Mule app consists of:

- A Scheduler component that triggers the flow

- A Set Payload component that sets the JSON payload

- A Transform Message component that transforms the content read from the Set Payload component by
  extracting the key-value pairs with the `pluck` function and putting them into an array

- A For Each scope component that iterates over the array

- A Set Variable component that sets the variable name as the Key and variable value as the Value in
  the JSON array

- A Logger component that prints the variable results per each iteration

![Mule app flow example in Studio canvas](/mulesoft/current/en-us/dataweave/latest/_images/dataweave-cookbook-pluck-examples.png)

Application XML File (reformatted for readability):

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
      xmlns="http://www.mulesoft.org/schema/mule/core"
      xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd">
      <flow name="json-varsFlow" >
            <scheduler doc:name="Scheduler" >
	          <scheduling-strategy >
		        <fixed-frequency frequency="10000"/>
                  </scheduling-strategy>
	    </scheduler>
	    <set-payload value='{"firstName": "jason", "job": "engineer", "dept":"support"}'
	                 doc:name="Set Payload"
			 mimeType="application/json" />
	    <ee:transform doc:name="Transform Message" >
	          <ee:message >
		        <ee:set-payload ><![CDATA[%dw 2.0
output application/json
---

payload pluck (value,key)  -> {
	Test:{
		Key: key,
		Value: value
	}
}]]></ee:set-payload>
                  </ee:message>
            </ee:transform>
	    <foreach doc:name="For Each"
	             collection="#[payload.Test]">
	                <logger level="INFO" doc:name="Logger" message="#[payload]" />
		        <set-variable value="#[payload.Value]"
		                      doc:name="Set Variable"
				      variableName="#[payload.Key]"/>
		        <logger level="INFO"
		                doc:name="Logger"
			        message="#[vars[payload.Key]]"/>
            </foreach>
      </flow>
</mule>
```

Note that the Transform Message configures the following DataWeave script:

```dataweave
%dw 2.0
output application/json
---
payload pluck (value,key)  -> {
  Test: {
    Key: key,
    Value: value
  }
}
```

When the Mule app executes with the following JSON payload:

```json
{
  "firstName": "jason",
  "job": "engineer",
  "dept": "support"
}
```

The DataWeave transformation result is:

```json
[
  {
    "Test": {
      "Key": "firstName",
      "Value": "jason"
    }
  },
  {
    "Test": {
      "Key": "job",
      "Value": "engineer"
    }
  },
  {
    "Test": {
      "Key": "dept",
      "Value": "support"
    }
  }
]
```

The For Each scope component iterates over the transformed values, and the app logs the values of
the variable results (reformatted for readability):

INFO 2022-06-22 10:11:17,864 \[\[MuleRuntime\].uber.02: \[jsonsample\].json-varsFlow.CPU\_INTENSIVE
@5c652aa\] \[processor: json-varsFlow/processors/2/processors/0; event:
545f5ef0-f24e-11ec-8c92-147ddaaf4f97\]
org.mule.runtime.core.internal.processor.LoggerMessageProcessor: { "Key": "firstName", "Value":
"jason" } INFO 2022-06-22 10:11:17,870 \[\[MuleRuntime\].uber.02:
\[jsonsample\].json-varsFlow.CPU\_INTENSIVE @5c652aa\] \[processor:
json-varsFlow/processors/2/processors/2; event: 545f5ef0-f24e-11ec-8c92-147ddaaf4f97\]
org.mule.runtime.core.internal.processor.LoggerMessageProcessor: "jason" INFO 2022-06-22
10:11:17,871 \[\[MuleRuntime\].uber.02: \[jsonsample\].json-varsFlow.CPU\_INTENSIVE @5c652aa\]
\[processor: json-varsFlow/processors/2/processors/0; event: 545f5ef0-f24e-11ec-8c92-147ddaaf4f97\]
org.mule.runtime.core.internal.processor.LoggerMessageProcessor: { "Key": "job", "Value": "engineer"
} INFO 2022-06-22 10:11:17,875 \[\[MuleRuntime\].uber.02:
\[jsonsample\].json-varsFlow.CPU\_INTENSIVE @5c652aa\] \[processor:
json-varsFlow/processors/2/processors/2; event: 545f5ef0-f24e-11ec-8c92-147ddaaf4f97\]
org.mule.runtime.core.internal.processor.LoggerMessageProcessor: "engineer" INFO 2022-06-22
10:11:17,877 \[\[MuleRuntime\].uber.02: \[jsonsample\].json-varsFlow.CPU\_INTENSIVE @5c652aa\]
\[processor: json-varsFlow/processors/2/processors/0; event: 545f5ef0-f24e-11ec-8c92-147ddaaf4f97\]
org.mule.runtime.core.internal.processor.LoggerMessageProcessor: { "Key": "dept", "Value": "support"
} INFO 2022-06-22 10:11:17,879 \[\[MuleRuntime\].uber.02:
\[jsonsample\].json-varsFlow.CPU\_INTENSIVE @5c652aa\] \[processor:
json-varsFlow/processors/2/processors/2; event: 545f5ef0-f24e-11ec-8c92-147ddaaf4f97\]
org.mule.runtime.core.internal.processor.LoggerMessageProcessor: "support"

## See Also

- [DataWeave Formats](https://docs.mulesoft.com/dataweave/latest/dataweave-formats)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook)

<!-- document id=df75e462813ab8d5329b22c6f60237aa16fe0549b382be2b105d1dfd3851d511 url=/mulesoft/current/en-us/dataweave/2.11/dw-runtime-functions-fail.md -->

---
product: DataWeave
version: 2.11
---

# fail

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fail(message: String = 'Error'): Nothing

Throws an exception with the specified message.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>message</code></p></td><td><p>An error message (<code>String</code>).</p></td></tr></tbody></table>

### Example

This example returns a failure message `Data was empty` because the expression
`(sizeOf(myVar) <= 0)` is `true`. A shortened version of the error message is shown in the output.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
var result = []
output application/json
---
if(sizeOf(result) <= 0) fail('Data was empty') else result
```

#### Output

```TXT
ERROR 2018-07-29 11:47:44,983 ...
*********************************
Message               : "Data was empty
...
```

<!-- document id=80501a86d211f97e25824ec19a4bf8d32532f2672582e60026ea4a975471f9d3 url=/mulesoft/current/en-us/dataweave/2.12/dw-runtime-functions-fail.md -->

---
product: DataWeave
version: 2.12
---

# fail

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fail(message: String = 'Error'): Nothing

Throws an exception with the specified message.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>message</code></p></td><td><p>An error message (<code>String</code>).</p></td></tr></tbody></table>

### Example

This example returns a failure message `Data was empty` because the expression
`(sizeOf(myVar) <= 0)` is `true`. A shortened version of the error message is shown in the output.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
var result = []
output application/json
---
if(sizeOf(result) <= 0) fail('Data was empty') else result
```

#### Output

```TXT
ERROR 2018-07-29 11:47:44,983 ...
*********************************
Message               : "Data was empty
...
```

<!-- document id=c803541a8059a10e51acdb16103c187b26f6c7c18504a193bd41f0ef39791b0d url=/mulesoft/current/en-us/dataweave/2.3/dw-runtime-functions-fail.md -->

---
product: DataWeave
version: 2.3
---

# fail

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fail(String): Nothing

Throws an exception with the specified message.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>message</code></p></td><td><p>An error message (<code>String</code>).</p></td></tr></tbody></table>

### Example

This example returns a failure message `Data was empty` because the expression
`(sizeOf(myVar) <= 0)` is `true`. A shortened version of the error message is shown in the Output
section below.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
var result = []
output application/json
---
if(sizeOf(result) <= 0) fail('Data was empty') else result
```

#### Output

```TXT
ERROR 2018-07-29 11:47:44,983 ...
*********************************
Message               : "Data was empty
...
```

<!-- document id=d9b4238c580ea7a099ab399959d277a38bc41a61963f929e7887ef81394d8c61 url=/mulesoft/current/en-us/dataweave/2.4/dw-runtime-functions-fail.md -->

---
product: DataWeave
version: 2.4
---

# fail

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fail(message: String = 'Error'): Nothing

Throws an exception with the specified message.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>message</code></p></td><td><p>An error message (<code>String</code>).</p></td></tr></tbody></table>

### Example

This example returns a failure message `Data was empty` because the expression
`(sizeOf(myVar) <= 0)` is `true`. A shortened version of the error message is shown in the output.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
var result = []
output application/json
---
if(sizeOf(result) <= 0) fail('Data was empty') else result
```

#### Output

```TXT
ERROR 2018-07-29 11:47:44,983 ...
*********************************
Message               : "Data was empty
...
```

<!-- document id=ab10b69ffe75697701506bdead0f1fc2e4a1c2746b526403c7c36047ac99720c url=/mulesoft/current/en-us/dataweave/2.6/dw-runtime-functions-fail.md -->

---
product: DataWeave
version: 2.6
---

# fail

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fail(message: String = 'Error'): Nothing

Throws an exception with the specified message.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>message</code></p></td><td><p>An error message (<code>String</code>).</p></td></tr></tbody></table>

### Example

This example returns a failure message `Data was empty` because the expression
`(sizeOf(myVar) <= 0)` is `true`. A shortened version of the error message is shown in the output.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
var result = []
output application/json
---
if(sizeOf(result) <= 0) fail('Data was empty') else result
```

#### Output

```TXT
ERROR 2018-07-29 11:47:44,983 ...
*********************************
Message               : "Data was empty
...
```

<!-- document id=c0e6a6e24d9e577b6dfdb418c46139f322a50a1395b3cec54065c55fa8e58dba url=/mulesoft/current/en-us/dataweave/2.9/dw-runtime-functions-fail.md -->

---
product: DataWeave
version: 2.9
---

# fail

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fail(message: String = 'Error'): Nothing

Throws an exception with the specified message.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>message</code></p></td><td><p>An error message (<code>String</code>).</p></td></tr></tbody></table>

### Example

This example returns a failure message `Data was empty` because the expression
`(sizeOf(myVar) <= 0)` is `true`. A shortened version of the error message is shown in the output.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
var result = []
output application/json
---
if(sizeOf(result) <= 0) fail('Data was empty') else result
```

#### Output

```TXT
ERROR 2018-07-29 11:47:44,983 ...
*********************************
Message               : "Data was empty
...
```

<!-- document id=707b89d6cc3dba11d930034a95013dbd67559ef64964376cacafcdbd692c76ab url=/mulesoft/current/en-us/dataweave/latest/dw-runtime-functions-fail.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# fail

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fail(message: String = 'Error'): Nothing

Throws an exception with the specified message.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>message</code></p></td><td><p>An error message (<code>String</code>).</p></td></tr></tbody></table>

### Example

This example returns a failure message `Data was empty` because the expression
`(sizeOf(myVar) <= 0)` is `true`. A shortened version of the error message is shown in the output.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
var result = []
output application/json
---
if(sizeOf(result) <= 0) fail('Data was empty') else result
```

#### Output

```TXT
ERROR 2018-07-29 11:47:44,983 ...
*********************************
Message               : "Data was empty
...
```

<!-- document id=08918ec39598a00007ccf916ddf9af07f64566fdeeacabacb28a48fd59992c89 url=/mulesoft/current/en-us/dataweave/2.11/dw-runtime-functions-failif.md -->

---
product: DataWeave
version: 2.11
---

# failIf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## failIf<T>(value: T, evaluator: (value: T) -> Boolean, message: String = 'Failed'): T

Produces an error with the specified message if the expression in the evaluator returns `true`.
Otherwise, the function returns the value.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The value to return only if the <code>evaluator</code> expression is <code>false</code>.</p></td></tr><tr><td><p><code>evaluator</code></p></td><td><p>Expression that returns <code>true</code> or <code>false</code>.</p></td></tr></tbody></table>

### Example

This example produces a runtime error (instead of a SUCCESS message) because the expression
`isEmpty(result)` is `true`. It is `true` because an empty object is passed through variable
`result`.

#### Source

```DataWeave
%dw 2.0
import failIf from dw::Runtime
var result = {}
output application/json
---
{ "result" : "SUCCESS" failIf (isEmpty(result)) }
```

#### Output

```TXT
ERROR 2018-07-29 11:56:39,988 ...
**********************************
Message               : "Failed
```

Alternatively, the function outputs the value.

#### Source

```DataWeave
%dw 2.0
import failIf from dw::Runtime
var result = {"a":"test"}
output application/json
---
{ "result" : result failIf isEmpty($) }
```

#### Output

```JSON
{
  "result": {
    "a": "test"
  }
}
```

<!-- document id=344000ee00031522386af4077aefba2f9a2367c754550355b1a252389c972716 url=/mulesoft/current/en-us/dataweave/2.12/dw-runtime-functions-failif.md -->

---
product: DataWeave
version: 2.12
---

# failIf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## failIf<T>(value: T, evaluator: (value: T) -> Boolean, message: String = 'Failed'): T

Produces an error with the specified message if the expression in the evaluator returns `true`.
Otherwise, the function returns the value.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The value to return only if the <code>evaluator</code> expression is <code>false</code>.</p></td></tr><tr><td><p><code>evaluator</code></p></td><td><p>Expression that returns <code>true</code> or <code>false</code>.</p></td></tr></tbody></table>

### Example

This example produces a runtime error (instead of a SUCCESS message) because the expression
`isEmpty(result)` is `true`. It is `true` because an empty object is passed through variable
`result`.

#### Source

```DataWeave
%dw 2.0
import failIf from dw::Runtime
var result = {}
output application/json
---
{ "result" : "SUCCESS" failIf (isEmpty(result)) }
```

#### Output

```TXT
ERROR 2018-07-29 11:56:39,988 ...
**********************************
Message               : "Failed
```

Alternatively, the function outputs the value.

#### Source

```DataWeave
%dw 2.0
import failIf from dw::Runtime
var result = {"a":"test"}
output application/json
---
{ "result" : result failIf isEmpty($) }
```

#### Output

```JSON
{
  "result": {
    "a": "test"
  }
}
```

<!-- document id=d6206f2f3e5cb8b735f671c7b4ff7320cb76e5698dc4750a1cd049872cd1ad2f url=/mulesoft/current/en-us/dataweave/2.3/dw-runtime-functions-failif.md -->

---
product: DataWeave
version: 2.3
---

# failIf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## failIf(T, (value: T) -> Boolean, String): T

Produces an error with the specified message if the expression in the evaluator returns `true`,
otherwise returns the value.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The value to return only if the <code>evaluator</code> expression is <code>false</code>.</p></td></tr><tr><td><p><code>evaluator</code></p></td><td><p>Expression that returns <code>true</code> or <code>false</code>.</p></td></tr></tbody></table>

### Example

This example produces a runtime error (instead of a SUCCESS message) because the expression
`isEmpty(result)` is `true`. It is `true` because an empty object is passed through variable
`result`.

#### Source

```DataWeave
%dw 2.0
import failIf from dw::Runtime
var result = {}
output application/json
---
{ "result" : failIf(result, isEmpty) }
```

#### Output

```TXT
ERROR 2018-07-29 11:56:39,988 ...
**********************************
Message               : "Failed
```

Alternatively, the function outputs the value.

#### Source

```DataWeave
%dw 2.0
import failIf from dw::Runtime
var result = {"a":"test"}
output application/json
---
{ "result" : result failIf isEmpty($) }
```

#### Output

```Json
{
  "result": {
    "a": "test"
  }
}
```

<!-- document id=e07b62595a22d4e064fde5e2c4a7c86a0b46cb9de5dc35890fd4cb321f1d78f0 url=/mulesoft/current/en-us/dataweave/2.4/dw-runtime-functions-failif.md -->

---
product: DataWeave
version: 2.4
---

# failIf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## failIf<T>(value: T, evaluator: (value: T) -> Boolean, message: String = 'Failed'): T

Produces an error with the specified message if the expression in the evaluator returns `true`.
Otherwise, the function returns the value.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The value to return only if the <code>evaluator</code> expression is <code>false</code>.</p></td></tr><tr><td><p><code>evaluator</code></p></td><td><p>Expression that returns <code>true</code> or <code>false</code>.</p></td></tr></tbody></table>

### Example

This example produces a runtime error (instead of a SUCCESS message) because the expression
`isEmpty(result)` is `true`. It is `true` because an empty object is passed through variable
`result`.

#### Source

```DataWeave
%dw 2.0
import failIf from dw::Runtime
var result = {}
output application/json
---
{ "result" : failIf(result, isEmpty) }
```

#### Output

```TXT
ERROR 2018-07-29 11:56:39,988 ...
**********************************
Message               : "Failed
```

Alternatively, the function outputs the value.

#### Source

```DataWeave
%dw 2.0
import failIf from dw::Runtime
var result = {"a":"test"}
output application/json
---
{ "result" : result failIf isEmpty($) }
```

#### Output

```Json
{
  "result": {
    "a": "test"
  }
}
```

<!-- document id=a5a3daa2075e8f57765da205cfd86567c510df88019a6ff312cd76fbfc5469d7 url=/mulesoft/current/en-us/dataweave/2.6/dw-runtime-functions-failif.md -->

---
product: DataWeave
version: 2.6
---

# failIf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## failIf<T>(value: T, evaluator: (value: T) -> Boolean, message: String = 'Failed'): T

Produces an error with the specified message if the expression in the evaluator returns `true`.
Otherwise, the function returns the value.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The value to return only if the <code>evaluator</code> expression is <code>false</code>.</p></td></tr><tr><td><p><code>evaluator</code></p></td><td><p>Expression that returns <code>true</code> or <code>false</code>.</p></td></tr></tbody></table>

### Example

This example produces a runtime error (instead of a SUCCESS message) because the expression
`isEmpty(result)` is `true`. It is `true` because an empty object is passed through variable
`result`.

#### Source

```DataWeave
%dw 2.0
import failIf from dw::Runtime
var result = {}
output application/json
---
{ "result" : failIf(result, isEmpty) }
```

#### Output

```TXT
ERROR 2018-07-29 11:56:39,988 ...
**********************************
Message               : "Failed
```

Alternatively, the function outputs the value.

#### Source

```DataWeave
%dw 2.0
import failIf from dw::Runtime
var result = {"a":"test"}
output application/json
---
{ "result" : result failIf isEmpty($) }
```

#### Output

```Json
{
  "result": {
    "a": "test"
  }
}
```

<!-- document id=c79725151513cf0b0012ac15b46bf1f7142ba2a39ce57ef3cf4d0fbd4961d2ce url=/mulesoft/current/en-us/dataweave/2.9/dw-runtime-functions-failif.md -->

---
product: DataWeave
version: 2.9
---

# failIf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## failIf<T>(value: T, evaluator: (value: T) -> Boolean, message: String = 'Failed'): T

Produces an error with the specified message if the expression in the evaluator returns `true`.
Otherwise, the function returns the value.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The value to return only if the <code>evaluator</code> expression is <code>false</code>.</p></td></tr><tr><td><p><code>evaluator</code></p></td><td><p>Expression that returns <code>true</code> or <code>false</code>.</p></td></tr></tbody></table>

### Example

This example produces a runtime error (instead of a SUCCESS message) because the expression
`isEmpty(result)` is `true`. It is `true` because an empty object is passed through variable
`result`.

#### Source

```DataWeave
%dw 2.0
import failIf from dw::Runtime
var result = {}
output application/json
---
{ "result" : "SUCCESS" failIf (isEmpty(result)) }
```

#### Output

```TXT
ERROR 2018-07-29 11:56:39,988 ...
**********************************
Message               : "Failed
```

Alternatively, the function outputs the value.

#### Source

```DataWeave
%dw 2.0
import failIf from dw::Runtime
var result = {"a":"test"}
output application/json
---
{ "result" : result failIf isEmpty($) }
```

#### Output

```Json
{
  "result": {
    "a": "test"
  }
}
```

<!-- document id=bdf739235164b25262792be606b4a57a183af4eafc178aff40cd082da8f0fa58 url=/mulesoft/current/en-us/dataweave/latest/dw-runtime-functions-failif.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# failIf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## failIf<T>(value: T, evaluator: (value: T) -> Boolean, message: String = 'Failed'): T

Produces an error with the specified message if the expression in the evaluator returns `true`.
Otherwise, the function returns the value.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The value to return only if the <code>evaluator</code> expression is <code>false</code>.</p></td></tr><tr><td><p><code>evaluator</code></p></td><td><p>Expression that returns <code>true</code> or <code>false</code>.</p></td></tr></tbody></table>

### Example

This example produces a runtime error (instead of a SUCCESS message) because the expression
`isEmpty(result)` is `true`. It is `true` because an empty object is passed through variable
`result`.

#### Source

```DataWeave
%dw 2.0
import failIf from dw::Runtime
var result = {}
output application/json
---
{ "result" : "SUCCESS" failIf (isEmpty(result)) }
```

#### Output

```TXT
ERROR 2018-07-29 11:56:39,988 ...
**********************************
Message               : "Failed
```

Alternatively, the function outputs the value.

#### Source

```DataWeave
%dw 2.0
import failIf from dw::Runtime
var result = {"a":"test"}
output application/json
---
{ "result" : result failIf isEmpty($) }
```

#### Output

```JSON
{
  "result": {
    "a": "test"
  }
}
```

<!-- document id=05b9795d7e8d409c46e675b74e3337d0a26af26f6ffc1645113ad0c551ad7522 url=/mulesoft/current/en-us/dataweave/2.11/dw-multipart-functions-field.md -->

---
product: DataWeave
version: 2.11
---

# field

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## field(opts: {| name: String, value: Any, mime?: String, fileName?: String |}): MultipartPart

Creates a `MultipartPart` data structure using the specified part name, input content for the part,
format (or mime type), and optionally, file name.

This version of the `field` function accepts arguments as an array of objects that use the parameter
names as keys, for example:
`Multipart::field({name:"order",value: myOrder, mime: "application/json", fileName: "order.json"})`

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>opts</code></p></td><td><div><div><p>Array of objects that specifies:</p></div><div><ul><li><p>A unique <code>name</code> (required) for the <code>Content-Disposition</code> header of the part.</p></li><li><p>A <code>value</code> (required) for the content of the part.</p></li><li><p><code>mime</code> (optional for strings) for the mime type (for example, <code>application/json</code>) to apply to content within the part. This setting can be used to transform the input type, for example, from JSON to XML.</p></li><li><p>An optional <code>fileName</code> value that you can supply to the <code>filename</code> parameter in the part’s <code>Content-Disposition</code> header.</p></li></ul></div></div></td></tr></tbody></table>

### Example

This example creates a `Multipart` data structure that contains parts.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
output multipart/form-data
var firstPart = "content for my first part"
var secondPart = "content for my second part"
---
{
  parts: {
    part1: Multipart::field({name:"myFirstPart",value: firstPart}),
    part2: Multipart::field("mySecondPart", secondPart)
  }
}
```

#### Output

```json
------=_Part_320_1528378161.1542639222352
Content-Disposition: form-data; name="myFirstPart"
content for my first part
------=_Part_320_1528378161.1542639222352
Content-Disposition: form-data; name="mySecondPart"
content for my second part
------=_Part_320_1528378161.1542639222352--
```

### Example

This example produces two parts. The first part (named `order`) outputs content in JSON and provides
a file name for the part (`order.json`). The second (named `clients`) outputs content in XML and
does not provide a file name. Also notice that in this example you need to add the function’s
namespace to the function name, for example, `Multipart::field`.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
output multipart/form-data
var myOrder = [
  {
    order: 1,
    amount: 2
  },
  {
    order: 32,
    amount: 1
  }
]
var myClients = {
  clients: {
    client: {
      id: 1,
      name: "Mariano"
    },
    client: {
      id: 2,
      name: "Shoki"
    }
  }
}
---
{
  parts: {
    order: Multipart::field({name:"order",value: myOrder, mime: "application/json", fileName: "order.json"}),
    clients: Multipart::field({name:"clients", value: myClients, mime: "application/xml"})
  }
}
```

#### Output

```txt
------=_Part_8032_681891620.1542560124825
Content-Type: application/json
Content-Disposition: form-data; name="order"; filename="order.json"

[
  {
    "order": 1,
    "amount": 2
  },
  {
    "order": 32,
    "amount": 1
  }
]
------=_Part_8032_681891620.1542560124825
Content-Type: application/xml
Content-Disposition: form-data; name="clients"

<clients>
  <client>
    <id>1</id>
    <name>Mariano</name>
  </client>
  <client>
    <id>2</id>
    <name>Shoki</name>
  </client>
</clients>
------=_Part_8032_681891620.1542560124825--
```

## field(name: String, value: Any, mime: String = "", fileName: String = ""): MultipartPart

Creates a `MultipartPart` data structure using the specified part name, input content for the part,
format (or mime type), and optionally, file name.

This version of the `field` function accepts arguments in a comma-separated list, for example:

```txt
Multipart::field("order", myOrder,"application/json", "order.json")`
```

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>opts</code></p></td><td><div><div><p>A set of parameters that specify:</p></div><div><ul><li><p>A unique <code>name</code> (required) for the <code>Content-Disposition</code> header of the part.</p></li><li><p>A <code>value</code> (required) for the content of the part.</p></li><li><p><code>mime</code> (optional for strings) for the mime type (for example, <code>application/json</code>) to apply to content within the part. This type can be used to transform the input type.</p></li><li><p>An optional <code>fileName</code> value that you can supply to the <code>filename</code> parameter in the part’s <code>Content-Disposition</code> header.</p></li></ul></div></div></td></tr></tbody></table>

### Example

This example produces two parts. The first part (named `order`) outputs content in JSON and provides
a file name for the part (`order.json`). The second (named `clients`) outputs content in XML and
does not provide a file name. The only difference between this `field` example and the previous
`field` example is the way you pass in arguments to the method. Also notice that in this example you
need to add the function’s namespace to the function name, for example, `Multipart::field`.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
output multipart/form-data
var myOrder = [
  {
    order: 1,
    amount: 2
  },
  {
    order: 32,
    amount: 1
  }
]
var myClients = {
  clients: {
    client: {
      id: 1,
      name: "Mariano"
    },
    client: {
      id: 2,
      name: "Shoki"
    }
  }
}
---
{
  parts: {
    order: Multipart::field("order", myOrder, "application/json", "order.json"),
    clients: Multipart::field("clients", myClients, "application/xml")
  }
}
```

#### Output

```txt
------=_Part_4846_2022598837.1542560230901
Content-Type: application/json
Content-Disposition: form-data; name="order"; filename="order.json"

[
  {
    "order": 1,
    "amount": 2
  },
  {
    "order": 32,
    "amount": 1
  }
]
------=_Part_4846_2022598837.1542560230901
Content-Type: application/xml
Content-Disposition: form-data; name="clients"

<clients>
  <client>
    <id>1</id>
    <name>Mariano</name>
  </client>
  <client>
    <id>2</id>
    <name>Shoki</name>
  </client>
</clients>
------=_Part_4846_2022598837.1542560230901--
```

<!-- document id=5472ee52a69802b39fe562d1e27b8f8ba8290e3ff6f6a6c1b1bf07ea9b3d76d4 url=/mulesoft/current/en-us/dataweave/2.11/dw-values-functions-field.md -->

---
product: DataWeave
version: 2.11
---

# field

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## field(namespace: Namespace | Null = null, name: String): PathElement

This function creates a `PathElement` data type to use for selecting an _object field_ and populates
the type’s `selector` field with the given string.

Some versions of the `update` and `mask` functions accept a `PathElement` as an argument.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>namespace</code></p></td><td><p>The namespace of the field to select. If not specified, a null value is set.</p></td></tr><tr><td><p><code>name</code></p></td><td><p>A string that names the attribute to select.</p></td></tr></tbody></table>

### Example

This example creates an object field selector for a specified namespace (`ns0`) and sets the
selector’s value to `"myFieldName"`. In the output, also note that the value of the `"kind"` key is
`"Object"`.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::util::Values
ns ns0 http://acme.com/foo
---
field(ns0 , "myFieldName")
```

#### Output

```Json
{
   "kind": "Object",
   "namespace": "http://acme.com/foo",
   "selector": "myFieldName"
 }
```

<!-- document id=4c4bc474ee27356b014d89e990eed17324090e4643b8fc3721a537bc944009e7 url=/mulesoft/current/en-us/dataweave/2.12/dw-multipart-functions-field.md -->

---
product: DataWeave
version: 2.12
---

# field

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## field(opts: {| name: String, value: Any, mime?: String, fileName?: String |}): MultipartPart

Creates a `MultipartPart` data structure using the specified part name, input content for the part,
format (or mime type), and optionally, file name.

This version of the `field` function accepts arguments as an array of objects that use the parameter
names as keys, for example:
`Multipart::field({name:"order",value: myOrder, mime: "application/json", fileName: "order.json"})`

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>opts</code></p></td><td><div><div><p>Array of objects that specifies:</p></div><div><ul><li><p>A unique <code>name</code> (required) for the <code>Content-Disposition</code> header of the part.</p></li><li><p>A <code>value</code> (required) for the content of the part.</p></li><li><p><code>mime</code> (optional for strings) for the mime type (for example, <code>application/json</code>) to apply to content within the part. This setting can be used to transform the input type, for example, from JSON to XML.</p></li><li><p>An optional <code>fileName</code> value that you can supply to the <code>filename</code> parameter in the part’s <code>Content-Disposition</code> header.</p></li></ul></div></div></td></tr></tbody></table>

### Example

This example creates a `Multipart` data structure that contains parts.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
output multipart/form-data
var firstPart = "content for my first part"
var secondPart = "content for my second part"
---
{
  parts: {
    part1: Multipart::field({name:"myFirstPart",value: firstPart}),
    part2: Multipart::field("mySecondPart", secondPart)
  }
}
```

#### Output

```json
------=_Part_320_1528378161.1542639222352
Content-Disposition: form-data; name="myFirstPart"
content for my first part
------=_Part_320_1528378161.1542639222352
Content-Disposition: form-data; name="mySecondPart"
content for my second part
------=_Part_320_1528378161.1542639222352--
```

### Example

This example produces two parts. The first part (named `order`) outputs content in JSON and provides
a file name for the part (`order.json`). The second (named `clients`) outputs content in XML and
does not provide a file name. Also notice that in this example you need to add the function’s
namespace to the function name, for example, `Multipart::field`.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
output multipart/form-data
var myOrder = [
  {
    order: 1,
    amount: 2
  },
  {
    order: 32,
    amount: 1
  }
]
var myClients = {
  clients: {
    client: {
      id: 1,
      name: "Mariano"
    },
    client: {
      id: 2,
      name: "Shoki"
    }
  }
}
---
{
  parts: {
    order: Multipart::field({name:"order",value: myOrder, mime: "application/json", fileName: "order.json"}),
    clients: Multipart::field({name:"clients", value: myClients, mime: "application/xml"})
  }
}
```

#### Output

```txt
------=_Part_8032_681891620.1542560124825
Content-Type: application/json
Content-Disposition: form-data; name="order"; filename="order.json"

[
  {
    "order": 1,
    "amount": 2
  },
  {
    "order": 32,
    "amount": 1
  }
]
------=_Part_8032_681891620.1542560124825
Content-Type: application/xml
Content-Disposition: form-data; name="clients"

<clients>
  <client>
    <id>1</id>
    <name>Mariano</name>
  </client>
  <client>
    <id>2</id>
    <name>Shoki</name>
  </client>
</clients>
------=_Part_8032_681891620.1542560124825--
```

## field(name: String, value: Any, mime: String = "", fileName: String = ""): MultipartPart

Creates a `MultipartPart` data structure using the specified part name, input content for the part,
format (or mime type), and optionally, file name.

This version of the `field` function accepts arguments in a comma-separated list, for example:

```txt
Multipart::field("order", myOrder,"application/json", "order.json")`
```

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>opts</code></p></td><td><div><div><p>A set of parameters that specify:</p></div><div><ul><li><p>A unique <code>name</code> (required) for the <code>Content-Disposition</code> header of the part.</p></li><li><p>A <code>value</code> (required) for the content of the part.</p></li><li><p><code>mime</code> (optional for strings) for the mime type (for example, <code>application/json</code>) to apply to content within the part. This type can be used to transform the input type.</p></li><li><p>An optional <code>fileName</code> value that you can supply to the <code>filename</code> parameter in the part’s <code>Content-Disposition</code> header.</p></li></ul></div></div></td></tr></tbody></table>

### Example

This example produces two parts. The first part (named `order`) outputs content in JSON and provides
a file name for the part (`order.json`). The second (named `clients`) outputs content in XML and
does not provide a file name. The only difference between this `field` example and the previous
`field` example is the way you pass in arguments to the method. Also notice that in this example you
need to add the function’s namespace to the function name, for example, `Multipart::field`.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
output multipart/form-data
var myOrder = [
  {
    order: 1,
    amount: 2
  },
  {
    order: 32,
    amount: 1
  }
]
var myClients = {
  clients: {
    client: {
      id: 1,
      name: "Mariano"
    },
    client: {
      id: 2,
      name: "Shoki"
    }
  }
}
---
{
  parts: {
    order: Multipart::field("order", myOrder, "application/json", "order.json"),
    clients: Multipart::field("clients", myClients, "application/xml")
  }
}
```

#### Output

```txt
------=_Part_4846_2022598837.1542560230901
Content-Type: application/json
Content-Disposition: form-data; name="order"; filename="order.json"

[
  {
    "order": 1,
    "amount": 2
  },
  {
    "order": 32,
    "amount": 1
  }
]
------=_Part_4846_2022598837.1542560230901
Content-Type: application/xml
Content-Disposition: form-data; name="clients"

<clients>
  <client>
    <id>1</id>
    <name>Mariano</name>
  </client>
  <client>
    <id>2</id>
    <name>Shoki</name>
  </client>
</clients>
------=_Part_4846_2022598837.1542560230901--
```

<!-- document id=677b5549a6242b91cdb7e43665f8bd3090828b01cba0afef78cc6223e511c361 url=/mulesoft/current/en-us/dataweave/2.12/dw-values-functions-field.md -->

---
product: DataWeave
version: 2.12
---

# field

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## field(namespace: Namespace | Null = null, name: String): PathElement

This function creates a `PathElement` data type to use for selecting an _object field_ and populates
the type’s `selector` field with the given string.

Some versions of the `update` and `mask` functions accept a `PathElement` as an argument.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>namespace</code></p></td><td><p>The namespace of the field to select. If not specified, a null value is set.</p></td></tr><tr><td><p><code>name</code></p></td><td><p>A string that names the attribute to select.</p></td></tr></tbody></table>

### Example

This example creates an object field selector for a specified namespace (`ns0`) and sets the
selector’s value to `"myFieldName"`. In the output, also note that the value of the `"kind"` key is
`"Object"`.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::util::Values
ns ns0 http://acme.com/foo
---
field(ns0 , "myFieldName")
```

#### Output

```Json
{
   "kind": "Object",
   "namespace": "http://acme.com/foo",
   "selector": "myFieldName"
 }
```

<!-- document id=374197f02c2d6c5821e93a4390b107fee9fd180e67cae4fd1ebbcfe3ef0f323a url=/mulesoft/current/en-us/dataweave/2.3/dw-multipart-functions-field.md -->

---
product: DataWeave
version: 2.3
---

# field

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## field({| name: String, value: Any, mime?: String, fileName?: String |}): MultipartPart

Creates a `MultipartPart` data structure using the specified part name, input content for the part,
format (or mime type), and optionally, file name.

This version of the `field` function accepts arguments as an array of objects that use the parameter
names as keys, for example:
`Multipart::field({name:"order",value: myOrder, mime: "application/json", fileName: "order.json"})`

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>opts</code></p></td><td><div><div><p>Array of objects that specifies:</p></div><div><ul><li><p>A unique <code>name</code> (required) for the <code>Content-Disposition</code> header of the part.</p></li><li><p>A <code>value</code> (required) for the content of the part.</p></li><li><p><code>mime</code> (optional for strings) for the mime type (for example, <code>application/json</code>) to apply to content within the part. This setting can be used to transform the input type, for example, from JSON to XML.</p></li><li><p>An optional <code>fileName</code> value that you can supply to the <code>filename</code> parameter in the part’s <code>Content-Disposition</code> header.</p></li></ul></div></div></td></tr></tbody></table>

### Example

This example produces two parts. The first part (named `order`) outputs content in JSON and provides
a file name for the part (`order.json`). The second (named `clients`) outputs content in XML and
does not provide a file name. Also notice that in this example you need to add the function’s
namespace to the function name, for example, `Multipart::field`.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
output multipart/form-data
var myOrder = [
  {
    order: 1,
    amount: 2
  },
  {
    order: 32,
    amount: 1
  }
]
var myClients = {
  clients: {
    client: {
      id: 1,
      name: "Mariano"
    },
    client: {
      id: 2,
      name: "Shoki"
    }
  }
}
---
{
  parts: {
    order: Multipart::field({name:"order",value: myOrder, mime: "application/json", fileName: "order.json"}),
    clients: Multipart::field({name:"clients", value: myClients, mime: "application/xml"})
  }
}
```

#### Output

```txt
------=_Part_8032_681891620.1542560124825
Content-Type: application/json
Content-Disposition: form-data; name="order"; filename="order.json"

[
  {
    "order": 1,
    "amount": 2
  },
  {
    "order": 32,
    "amount": 1
  }
]
------=_Part_8032_681891620.1542560124825
Content-Type: application/xml
Content-Disposition: form-data; name="clients"

<clients>
  <client>
    <id>1</id>
    <name>Mariano</name>
  </client>
  <client>
    <id>2</id>
    <name>Shoki</name>
  </client>
</clients>
------=_Part_8032_681891620.1542560124825--
```

## field(String, Any, String, String): MultipartPart

Creates a `MultipartPart` data structure using the specified part name, input content for the part,
format (or mime type), and optionally, file name.

This version of the `field` function accepts arguments in a comma-separated list, for example:

```txt
Multipart::field("order", myOrder,"application/json", "order.json")`
```

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>opts</code></p></td><td><div><div><p>A set of parameters that specify:</p></div><div><ul><li><p>A unique <code>name</code> (required) for the <code>Content-Disposition</code> header of the part.</p></li><li><p>A <code>value</code> (required) for the content of the part.</p></li><li><p><code>mime</code> (optional for strings) for the mime type (for example, <code>application/json</code>) to apply to content within the part. This type can be used to transform the input type.</p></li><li><p>An optional <code>fileName</code> value that you can supply to the <code>filename</code> parameter in the part’s <code>Content-Disposition</code> header.</p></li></ul></div></div></td></tr></tbody></table>

### Example

This example produces two parts. The first part (named `order`) outputs content in JSON and provides
a file name for the part (`order.json`). The second (named `clients`) outputs content in XML and
does not provide a file name. The only difference between this `field` example and the previous
`field` example is the way you pass in arguments to the method. Also notice that in this example you
need to add the function’s namespace to the function name, for example, `Multipart::field`.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
output multipart/form-data
var myOrder = [
  {
    order: 1,
    amount: 2
  },
  {
    order: 32,
    amount: 1
  }
]
var myClients = {
  clients: {
    client: {
      id: 1,
      name: "Mariano"
    },
    client: {
      id: 2,
      name: "Shoki"
    }
  }
}
---
{
  parts: {
    order: Multipart::field("order", myOrder, "application/json", "order.json"),
    clients: Multipart::field("clients", myClients, "application/xml")
  }
}
```

#### Output

```txt
------=_Part_4846_2022598837.1542560230901
Content-Type: application/json
Content-Disposition: form-data; name="order"; filename="order.json"

[
  {
    "order": 1,
    "amount": 2
  },
  {
    "order": 32,
    "amount": 1
  }
]
------=_Part_4846_2022598837.1542560230901
Content-Type: application/xml
Content-Disposition: form-data; name="clients"

<clients>
  <client>
    <id>1</id>
    <name>Mariano</name>
  </client>
  <client>
    <id>2</id>
    <name>Shoki</name>
  </client>
</clients>
------=_Part_4846_2022598837.1542560230901--
```

<!-- document id=1d7f23aa9c521afc824a6af54bcee0ea69721c4f0aaaec6648fa7da09ea89717 url=/mulesoft/current/en-us/dataweave/2.3/dw-values-functions-field.md -->

---
product: DataWeave
version: 2.3
---

# field

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## field(Namespace | Null, String): PathElement

This function creates a `PathElement` data type to use for selecting an _object field_ and populates
the type’s `selector` field with the given string.

Some versions of the `update` and `mask` functions accept a `PathElement` as an argument.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>namespace</code></p></td><td><p>The namespace of the field to select. If not specified, a null value is set.</p></td></tr><tr><td><p><code>name</code></p></td><td><p>A string that names the attribute to select.</p></td></tr></tbody></table>

### Example

This example creates an object field selector for a specified namespace (`ns0`) and sets the
selector’s value to `"myFieldName"`. In the output, also note that the value of the `"kind"` key is
`"Object"`.

#### Source

```DataWeave
 %dw 2.0
 output application/json
 import * from dw::util::Values
 ns ns0 http://acme.com/foo
 ---
 field(ns0 , "myFieldName")
```

#### Output

```Json
{
   "kind": "Object",
   "namespace": "http://acme.com/foo",
   "selector": "myFieldName"
 }
```

<!-- document id=87844e7a4cf0ebacfe3abe4e191a911e7d46121ad4dc68bc4bccf371eea4cb3b url=/mulesoft/current/en-us/dataweave/2.4/dw-multipart-functions-field.md -->

---
product: DataWeave
version: 2.4
---

# field

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## field(opts: {| name: String, value: Any, mime?: String, fileName?: String |}): MultipartPart

Creates a `MultipartPart` data structure using the specified part name, input content for the part,
format (or mime type), and optionally, file name.

This version of the `field` function accepts arguments as an array of objects that use the parameter
names as keys, for example:
`Multipart::field({name:"order",value: myOrder, mime: "application/json", fileName: "order.json"})`

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>opts</code></p></td><td><div><div><p>Array of objects that specifies:</p></div><div><ul><li><p>A unique <code>name</code> (required) for the <code>Content-Disposition</code> header of the part.</p></li><li><p>A <code>value</code> (required) for the content of the part.</p></li><li><p><code>mime</code> (optional for strings) for the mime type (for example, <code>application/json</code>) to apply to content within the part. This setting can be used to transform the input type, for example, from JSON to XML.</p></li><li><p>An optional <code>fileName</code> value that you can supply to the <code>filename</code> parameter in the part’s <code>Content-Disposition</code> header.</p></li></ul></div></div></td></tr></tbody></table>

### Example

This example creates a `Multipart` data structure that contains parts.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
output multipart/form-data
var firstPart = "content for my first part"
var secondPart = "content for my second part"
---
{
  parts: {
    part1: Multipart::field({name:"myFirstPart",value: firstPart}),
    part2: Multipart::field("mySecondPart", secondPart)
  }
}
```

#### Output

```json
------=_Part_320_1528378161.1542639222352
Content-Disposition: form-data; name="myFirstPart"
content for my first part
------=_Part_320_1528378161.1542639222352
Content-Disposition: form-data; name="mySecondPart"
content for my second part
------=_Part_320_1528378161.1542639222352--
```

### Example

This example produces two parts. The first part (named `order`) outputs content in JSON and provides
a file name for the part (`order.json`). The second (named `clients`) outputs content in XML and
does not provide a file name. Also notice that in this example you need to add the function’s
namespace to the function name, for example, `Multipart::field`.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
output multipart/form-data
var myOrder = [
  {
    order: 1,
    amount: 2
  },
  {
    order: 32,
    amount: 1
  }
]
var myClients = {
  clients: {
    client: {
      id: 1,
      name: "Mariano"
    },
    client: {
      id: 2,
      name: "Shoki"
    }
  }
}
---
{
  parts: {
    order: Multipart::field({name:"order",value: myOrder, mime: "application/json", fileName: "order.json"}),
    clients: Multipart::field({name:"clients", value: myClients, mime: "application/xml"})
  }
}
```

#### Output

```txt
------=_Part_8032_681891620.1542560124825
Content-Type: application/json
Content-Disposition: form-data; name="order"; filename="order.json"

[
  {
    "order": 1,
    "amount": 2
  },
  {
    "order": 32,
    "amount": 1
  }
]
------=_Part_8032_681891620.1542560124825
Content-Type: application/xml
Content-Disposition: form-data; name="clients"

<clients>
  <client>
    <id>1</id>
    <name>Mariano</name>
  </client>
  <client>
    <id>2</id>
    <name>Shoki</name>
  </client>
</clients>
------=_Part_8032_681891620.1542560124825--
```

## field(name: String, value: Any, mime: String = "", fileName: String = ""): MultipartPart

Creates a `MultipartPart` data structure using the specified part name, input content for the part,
format (or mime type), and optionally, file name.

This version of the `field` function accepts arguments in a comma-separated list, for example:

```txt
Multipart::field("order", myOrder,"application/json", "order.json")`
```

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>opts</code></p></td><td><div><div><p>A set of parameters that specify:</p></div><div><ul><li><p>A unique <code>name</code> (required) for the <code>Content-Disposition</code> header of the part.</p></li><li><p>A <code>value</code> (required) for the content of the part.</p></li><li><p><code>mime</code> (optional for strings) for the mime type (for example, <code>application/json</code>) to apply to content within the part. This type can be used to transform the input type.</p></li><li><p>An optional <code>fileName</code> value that you can supply to the <code>filename</code> parameter in the part’s <code>Content-Disposition</code> header.</p></li></ul></div></div></td></tr></tbody></table>

### Example

This example produces two parts. The first part (named `order`) outputs content in JSON and provides
a file name for the part (`order.json`). The second (named `clients`) outputs content in XML and
does not provide a file name. The only difference between this `field` example and the previous
`field` example is the way you pass in arguments to the method. Also notice that in this example you
need to add the function’s namespace to the function name, for example, `Multipart::field`.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
output multipart/form-data
var myOrder = [
  {
    order: 1,
    amount: 2
  },
  {
    order: 32,
    amount: 1
  }
]
var myClients = {
  clients: {
    client: {
      id: 1,
      name: "Mariano"
    },
    client: {
      id: 2,
      name: "Shoki"
    }
  }
}
---
{
  parts: {
    order: Multipart::field("order", myOrder, "application/json", "order.json"),
    clients: Multipart::field("clients", myClients, "application/xml")
  }
}
```

#### Output

```txt
------=_Part_4846_2022598837.1542560230901
Content-Type: application/json
Content-Disposition: form-data; name="order"; filename="order.json"

[
  {
    "order": 1,
    "amount": 2
  },
  {
    "order": 32,
    "amount": 1
  }
]
------=_Part_4846_2022598837.1542560230901
Content-Type: application/xml
Content-Disposition: form-data; name="clients"

<clients>
  <client>
    <id>1</id>
    <name>Mariano</name>
  </client>
  <client>
    <id>2</id>
    <name>Shoki</name>
  </client>
</clients>
------=_Part_4846_2022598837.1542560230901--
```

<!-- document id=384b98e56275755bcee856fe2a1f4f04f3b77821646c42923def1aaded9c1f46 url=/mulesoft/current/en-us/dataweave/2.4/dw-values-functions-field.md -->

---
product: DataWeave
version: 2.4
---

# field

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## field(namespace: Namespace | Null = null, name: String): PathElement

This function creates a `PathElement` data type to use for selecting an _object field_ and populates
the type’s `selector` field with the given string.

Some versions of the `update` and `mask` functions accept a `PathElement` as an argument.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>namespace</code></p></td><td><p>The namespace of the field to select. If not specified, a null value is set.</p></td></tr><tr><td><p><code>name</code></p></td><td><p>A string that names the attribute to select.</p></td></tr></tbody></table>

### Example

This example creates an object field selector for a specified namespace (`ns0`) and sets the
selector’s value to `"myFieldName"`. In the output, also note that the value of the `"kind"` key is
`"Object"`.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::util::Values
ns ns0 http://acme.com/foo
---
field(ns0 , "myFieldName")
```

#### Output

```Json
{
   "kind": "Object",
   "namespace": "http://acme.com/foo",
   "selector": "myFieldName"
 }
```

<!-- document id=a5bff4c39c096cd36a431333b56c0182bc6a0a13ce618ac206ef9e13e087dd03 url=/mulesoft/current/en-us/dataweave/2.6/dw-multipart-functions-field.md -->

---
product: DataWeave
version: 2.6
---

# field

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## field(opts: {| name: String, value: Any, mime?: String, fileName?: String |}): MultipartPart

Creates a `MultipartPart` data structure using the specified part name, input content for the part,
format (or mime type), and optionally, file name.

This version of the `field` function accepts arguments as an array of objects that use the parameter
names as keys, for example:
`Multipart::field({name:"order",value: myOrder, mime: "application/json", fileName: "order.json"})`

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>opts</code></p></td><td><div><div><p>Array of objects that specifies:</p></div><div><ul><li><p>A unique <code>name</code> (required) for the <code>Content-Disposition</code> header of the part.</p></li><li><p>A <code>value</code> (required) for the content of the part.</p></li><li><p><code>mime</code> (optional for strings) for the mime type (for example, <code>application/json</code>) to apply to content within the part. This setting can be used to transform the input type, for example, from JSON to XML.</p></li><li><p>An optional <code>fileName</code> value that you can supply to the <code>filename</code> parameter in the part’s <code>Content-Disposition</code> header.</p></li></ul></div></div></td></tr></tbody></table>

### Example

This example creates a `Multipart` data structure that contains parts.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
output multipart/form-data
var firstPart = "content for my first part"
var secondPart = "content for my second part"
---
{
  parts: {
    part1: Multipart::field({name:"myFirstPart",value: firstPart}),
    part2: Multipart::field("mySecondPart", secondPart)
  }
}
```

#### Output

```json
------=_Part_320_1528378161.1542639222352
Content-Disposition: form-data; name="myFirstPart"
content for my first part
------=_Part_320_1528378161.1542639222352
Content-Disposition: form-data; name="mySecondPart"
content for my second part
------=_Part_320_1528378161.1542639222352--
```

### Example

This example produces two parts. The first part (named `order`) outputs content in JSON and provides
a file name for the part (`order.json`). The second (named `clients`) outputs content in XML and
does not provide a file name. Also notice that in this example you need to add the function’s
namespace to the function name, for example, `Multipart::field`.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
output multipart/form-data
var myOrder = [
  {
    order: 1,
    amount: 2
  },
  {
    order: 32,
    amount: 1
  }
]
var myClients = {
  clients: {
    client: {
      id: 1,
      name: "Mariano"
    },
    client: {
      id: 2,
      name: "Shoki"
    }
  }
}
---
{
  parts: {
    order: Multipart::field({name:"order",value: myOrder, mime: "application/json", fileName: "order.json"}),
    clients: Multipart::field({name:"clients", value: myClients, mime: "application/xml"})
  }
}
```

#### Output

```txt
------=_Part_8032_681891620.1542560124825
Content-Type: application/json
Content-Disposition: form-data; name="order"; filename="order.json"

[
  {
    "order": 1,
    "amount": 2
  },
  {
    "order": 32,
    "amount": 1
  }
]
------=_Part_8032_681891620.1542560124825
Content-Type: application/xml
Content-Disposition: form-data; name="clients"

<clients>
  <client>
    <id>1</id>
    <name>Mariano</name>
  </client>
  <client>
    <id>2</id>
    <name>Shoki</name>
  </client>
</clients>
------=_Part_8032_681891620.1542560124825--
```

## field(name: String, value: Any, mime: String = "", fileName: String = ""): MultipartPart

Creates a `MultipartPart` data structure using the specified part name, input content for the part,
format (or mime type), and optionally, file name.

This version of the `field` function accepts arguments in a comma-separated list, for example:

```txt
Multipart::field("order", myOrder,"application/json", "order.json")`
```

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>opts</code></p></td><td><div><div><p>A set of parameters that specify:</p></div><div><ul><li><p>A unique <code>name</code> (required) for the <code>Content-Disposition</code> header of the part.</p></li><li><p>A <code>value</code> (required) for the content of the part.</p></li><li><p><code>mime</code> (optional for strings) for the mime type (for example, <code>application/json</code>) to apply to content within the part. This type can be used to transform the input type.</p></li><li><p>An optional <code>fileName</code> value that you can supply to the <code>filename</code> parameter in the part’s <code>Content-Disposition</code> header.</p></li></ul></div></div></td></tr></tbody></table>

### Example

This example produces two parts. The first part (named `order`) outputs content in JSON and provides
a file name for the part (`order.json`). The second (named `clients`) outputs content in XML and
does not provide a file name. The only difference between this `field` example and the previous
`field` example is the way you pass in arguments to the method. Also notice that in this example you
need to add the function’s namespace to the function name, for example, `Multipart::field`.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
output multipart/form-data
var myOrder = [
  {
    order: 1,
    amount: 2
  },
  {
    order: 32,
    amount: 1
  }
]
var myClients = {
  clients: {
    client: {
      id: 1,
      name: "Mariano"
    },
    client: {
      id: 2,
      name: "Shoki"
    }
  }
}
---
{
  parts: {
    order: Multipart::field("order", myOrder, "application/json", "order.json"),
    clients: Multipart::field("clients", myClients, "application/xml")
  }
}
```

#### Output

```txt
------=_Part_4846_2022598837.1542560230901
Content-Type: application/json
Content-Disposition: form-data; name="order"; filename="order.json"

[
  {
    "order": 1,
    "amount": 2
  },
  {
    "order": 32,
    "amount": 1
  }
]
------=_Part_4846_2022598837.1542560230901
Content-Type: application/xml
Content-Disposition: form-data; name="clients"

<clients>
  <client>
    <id>1</id>
    <name>Mariano</name>
  </client>
  <client>
    <id>2</id>
    <name>Shoki</name>
  </client>
</clients>
------=_Part_4846_2022598837.1542560230901--
```

<!-- document id=cf77e2bff48218e3ab4b17659f2802bcde4b713b304f639997cc7dfbae285acb url=/mulesoft/current/en-us/dataweave/2.6/dw-values-functions-field.md -->

---
product: DataWeave
version: 2.6
---

# field

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## field(namespace: Namespace | Null = null, name: String): PathElement

This function creates a `PathElement` data type to use for selecting an _object field_ and populates
the type’s `selector` field with the given string.

Some versions of the `update` and `mask` functions accept a `PathElement` as an argument.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>namespace</code></p></td><td><p>The namespace of the field to select. If not specified, a null value is set.</p></td></tr><tr><td><p><code>name</code></p></td><td><p>A string that names the attribute to select.</p></td></tr></tbody></table>

### Example

This example creates an object field selector for a specified namespace (`ns0`) and sets the
selector’s value to `"myFieldName"`. In the output, also note that the value of the `"kind"` key is
`"Object"`.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::util::Values
ns ns0 http://acme.com/foo
---
field(ns0 , "myFieldName")
```

#### Output

```Json
{
   "kind": "Object",
   "namespace": "http://acme.com/foo",
   "selector": "myFieldName"
 }
```

<!-- document id=8be10782bb37387c912e16da37c75774f1ad31e0192a4d7cb96ee48cf93a41d8 url=/mulesoft/current/en-us/dataweave/2.9/dw-multipart-functions-field.md -->

---
product: DataWeave
version: 2.9
---

# field

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## field(opts: {| name: String, value: Any, mime?: String, fileName?: String |}): MultipartPart

Creates a `MultipartPart` data structure using the specified part name, input content for the part,
format (or mime type), and optionally, file name.

This version of the `field` function accepts arguments as an array of objects that use the parameter
names as keys, for example:
`Multipart::field({name:"order",value: myOrder, mime: "application/json", fileName: "order.json"})`

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>opts</code></p></td><td><div><div><p>Array of objects that specifies:</p></div><div><ul><li><p>A unique <code>name</code> (required) for the <code>Content-Disposition</code> header of the part.</p></li><li><p>A <code>value</code> (required) for the content of the part.</p></li><li><p><code>mime</code> (optional for strings) for the mime type (for example, <code>application/json</code>) to apply to content within the part. This setting can be used to transform the input type, for example, from JSON to XML.</p></li><li><p>An optional <code>fileName</code> value that you can supply to the <code>filename</code> parameter in the part’s <code>Content-Disposition</code> header.</p></li></ul></div></div></td></tr></tbody></table>

### Example

This example creates a `Multipart` data structure that contains parts.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
output multipart/form-data
var firstPart = "content for my first part"
var secondPart = "content for my second part"
---
{
  parts: {
    part1: Multipart::field({name:"myFirstPart",value: firstPart}),
    part2: Multipart::field("mySecondPart", secondPart)
  }
}
```

#### Output

```json
------=_Part_320_1528378161.1542639222352
Content-Disposition: form-data; name="myFirstPart"
content for my first part
------=_Part_320_1528378161.1542639222352
Content-Disposition: form-data; name="mySecondPart"
content for my second part
------=_Part_320_1528378161.1542639222352--
```

### Example

This example produces two parts. The first part (named `order`) outputs content in JSON and provides
a file name for the part (`order.json`). The second (named `clients`) outputs content in XML and
does not provide a file name. Also notice that in this example you need to add the function’s
namespace to the function name, for example, `Multipart::field`.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
output multipart/form-data
var myOrder = [
  {
    order: 1,
    amount: 2
  },
  {
    order: 32,
    amount: 1
  }
]
var myClients = {
  clients: {
    client: {
      id: 1,
      name: "Mariano"
    },
    client: {
      id: 2,
      name: "Shoki"
    }
  }
}
---
{
  parts: {
    order: Multipart::field({name:"order",value: myOrder, mime: "application/json", fileName: "order.json"}),
    clients: Multipart::field({name:"clients", value: myClients, mime: "application/xml"})
  }
}
```

#### Output

```txt
------=_Part_8032_681891620.1542560124825
Content-Type: application/json
Content-Disposition: form-data; name="order"; filename="order.json"

[
  {
    "order": 1,
    "amount": 2
  },
  {
    "order": 32,
    "amount": 1
  }
]
------=_Part_8032_681891620.1542560124825
Content-Type: application/xml
Content-Disposition: form-data; name="clients"

<clients>
  <client>
    <id>1</id>
    <name>Mariano</name>
  </client>
  <client>
    <id>2</id>
    <name>Shoki</name>
  </client>
</clients>
------=_Part_8032_681891620.1542560124825--
```

## field(name: String, value: Any, mime: String = "", fileName: String = ""): MultipartPart

Creates a `MultipartPart` data structure using the specified part name, input content for the part,
format (or mime type), and optionally, file name.

This version of the `field` function accepts arguments in a comma-separated list, for example:

```txt
Multipart::field("order", myOrder,"application/json", "order.json")`
```

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>opts</code></p></td><td><div><div><p>A set of parameters that specify:</p></div><div><ul><li><p>A unique <code>name</code> (required) for the <code>Content-Disposition</code> header of the part.</p></li><li><p>A <code>value</code> (required) for the content of the part.</p></li><li><p><code>mime</code> (optional for strings) for the mime type (for example, <code>application/json</code>) to apply to content within the part. This type can be used to transform the input type.</p></li><li><p>An optional <code>fileName</code> value that you can supply to the <code>filename</code> parameter in the part’s <code>Content-Disposition</code> header.</p></li></ul></div></div></td></tr></tbody></table>

### Example

This example produces two parts. The first part (named `order`) outputs content in JSON and provides
a file name for the part (`order.json`). The second (named `clients`) outputs content in XML and
does not provide a file name. The only difference between this `field` example and the previous
`field` example is the way you pass in arguments to the method. Also notice that in this example you
need to add the function’s namespace to the function name, for example, `Multipart::field`.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
output multipart/form-data
var myOrder = [
  {
    order: 1,
    amount: 2
  },
  {
    order: 32,
    amount: 1
  }
]
var myClients = {
  clients: {
    client: {
      id: 1,
      name: "Mariano"
    },
    client: {
      id: 2,
      name: "Shoki"
    }
  }
}
---
{
  parts: {
    order: Multipart::field("order", myOrder, "application/json", "order.json"),
    clients: Multipart::field("clients", myClients, "application/xml")
  }
}
```

#### Output

```txt
------=_Part_4846_2022598837.1542560230901
Content-Type: application/json
Content-Disposition: form-data; name="order"; filename="order.json"

[
  {
    "order": 1,
    "amount": 2
  },
  {
    "order": 32,
    "amount": 1
  }
]
------=_Part_4846_2022598837.1542560230901
Content-Type: application/xml
Content-Disposition: form-data; name="clients"

<clients>
  <client>
    <id>1</id>
    <name>Mariano</name>
  </client>
  <client>
    <id>2</id>
    <name>Shoki</name>
  </client>
</clients>
------=_Part_4846_2022598837.1542560230901--
```

<!-- document id=617dae4aaab2f3186d4c00601ddd5fb63dd25fcebbe838d8fffa38141ee83e85 url=/mulesoft/current/en-us/dataweave/2.9/dw-values-functions-field.md -->

---
product: DataWeave
version: 2.9
---

# field

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## field(namespace: Namespace | Null = null, name: String): PathElement

This function creates a `PathElement` data type to use for selecting an _object field_ and populates
the type’s `selector` field with the given string.

Some versions of the `update` and `mask` functions accept a `PathElement` as an argument.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>namespace</code></p></td><td><p>The namespace of the field to select. If not specified, a null value is set.</p></td></tr><tr><td><p><code>name</code></p></td><td><p>A string that names the attribute to select.</p></td></tr></tbody></table>

### Example

This example creates an object field selector for a specified namespace (`ns0`) and sets the
selector’s value to `"myFieldName"`. In the output, also note that the value of the `"kind"` key is
`"Object"`.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::util::Values
ns ns0 http://acme.com/foo
---
field(ns0 , "myFieldName")
```

#### Output

```Json
{
   "kind": "Object",
   "namespace": "http://acme.com/foo",
   "selector": "myFieldName"
 }
```

<!-- document id=6ee7f5f46aaaaa4f96ff109875ce63e1510ed03fff15e6fb6691c39dcb27cf76 url=/mulesoft/current/en-us/dataweave/latest/dw-multipart-functions-field.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# field

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## field(opts: {| name: String, value: Any, mime?: String, fileName?: String |}): MultipartPart

Creates a `MultipartPart` data structure using the specified part name, input content for the part,
format (or mime type), and optionally, file name.

This version of the `field` function accepts arguments as an array of objects that use the parameter
names as keys, for example:
`Multipart::field({name:"order",value: myOrder, mime: "application/json", fileName: "order.json"})`

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>opts</code></p></td><td><div><div><p>Array of objects that specifies:</p></div><div><ul><li><p>A unique <code>name</code> (required) for the <code>Content-Disposition</code> header of the part.</p></li><li><p>A <code>value</code> (required) for the content of the part.</p></li><li><p><code>mime</code> (optional for strings) for the mime type (for example, <code>application/json</code>) to apply to content within the part. This setting can be used to transform the input type, for example, from JSON to XML.</p></li><li><p>An optional <code>fileName</code> value that you can supply to the <code>filename</code> parameter in the part’s <code>Content-Disposition</code> header.</p></li></ul></div></div></td></tr></tbody></table>

### Example

This example creates a `Multipart` data structure that contains parts.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
output multipart/form-data
var firstPart = "content for my first part"
var secondPart = "content for my second part"
---
{
  parts: {
    part1: Multipart::field({name:"myFirstPart",value: firstPart}),
    part2: Multipart::field("mySecondPart", secondPart)
  }
}
```

#### Output

```json
------=_Part_320_1528378161.1542639222352
Content-Disposition: form-data; name="myFirstPart"
content for my first part
------=_Part_320_1528378161.1542639222352
Content-Disposition: form-data; name="mySecondPart"
content for my second part
------=_Part_320_1528378161.1542639222352--
```

### Example

This example produces two parts. The first part (named `order`) outputs content in JSON and provides
a file name for the part (`order.json`). The second (named `clients`) outputs content in XML and
does not provide a file name. Also notice that in this example you need to add the function’s
namespace to the function name, for example, `Multipart::field`.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
output multipart/form-data
var myOrder = [
  {
    order: 1,
    amount: 2
  },
  {
    order: 32,
    amount: 1
  }
]
var myClients = {
  clients: {
    client: {
      id: 1,
      name: "Mariano"
    },
    client: {
      id: 2,
      name: "Shoki"
    }
  }
}
---
{
  parts: {
    order: Multipart::field({name:"order",value: myOrder, mime: "application/json", fileName: "order.json"}),
    clients: Multipart::field({name:"clients", value: myClients, mime: "application/xml"})
  }
}
```

#### Output

```txt
------=_Part_8032_681891620.1542560124825
Content-Type: application/json
Content-Disposition: form-data; name="order"; filename="order.json"

[
  {
    "order": 1,
    "amount": 2
  },
  {
    "order": 32,
    "amount": 1
  }
]
------=_Part_8032_681891620.1542560124825
Content-Type: application/xml
Content-Disposition: form-data; name="clients"

<clients>
  <client>
    <id>1</id>
    <name>Mariano</name>
  </client>
  <client>
    <id>2</id>
    <name>Shoki</name>
  </client>
</clients>
------=_Part_8032_681891620.1542560124825--
```

## field(name: String, value: Any, mime: String = "", fileName: String = ""): MultipartPart

Creates a `MultipartPart` data structure using the specified part name, input content for the part,
format (or mime type), and optionally, file name.

This version of the `field` function accepts arguments in a comma-separated list, for example:

```txt
Multipart::field("order", myOrder,"application/json", "order.json")`
```

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>opts</code></p></td><td><div><div><p>A set of parameters that specify:</p></div><div><ul><li><p>A unique <code>name</code> (required) for the <code>Content-Disposition</code> header of the part.</p></li><li><p>A <code>value</code> (required) for the content of the part.</p></li><li><p><code>mime</code> (optional for strings) for the mime type (for example, <code>application/json</code>) to apply to content within the part. This type can be used to transform the input type.</p></li><li><p>An optional <code>fileName</code> value that you can supply to the <code>filename</code> parameter in the part’s <code>Content-Disposition</code> header.</p></li></ul></div></div></td></tr></tbody></table>

### Example

This example produces two parts. The first part (named `order`) outputs content in JSON and provides
a file name for the part (`order.json`). The second (named `clients`) outputs content in XML and
does not provide a file name. The only difference between this `field` example and the previous
`field` example is the way you pass in arguments to the method. Also notice that in this example you
need to add the function’s namespace to the function name, for example, `Multipart::field`.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
output multipart/form-data
var myOrder = [
  {
    order: 1,
    amount: 2
  },
  {
    order: 32,
    amount: 1
  }
]
var myClients = {
  clients: {
    client: {
      id: 1,
      name: "Mariano"
    },
    client: {
      id: 2,
      name: "Shoki"
    }
  }
}
---
{
  parts: {
    order: Multipart::field("order", myOrder, "application/json", "order.json"),
    clients: Multipart::field("clients", myClients, "application/xml")
  }
}
```

#### Output

```txt
------=_Part_4846_2022598837.1542560230901
Content-Type: application/json
Content-Disposition: form-data; name="order"; filename="order.json"

[
  {
    "order": 1,
    "amount": 2
  },
  {
    "order": 32,
    "amount": 1
  }
]
------=_Part_4846_2022598837.1542560230901
Content-Type: application/xml
Content-Disposition: form-data; name="clients"

<clients>
  <client>
    <id>1</id>
    <name>Mariano</name>
  </client>
  <client>
    <id>2</id>
    <name>Shoki</name>
  </client>
</clients>
------=_Part_4846_2022598837.1542560230901--
```

<!-- document id=1d5331f570ec7d70f78cb6f3a13b3cfe64cb25186a6267ac0a09f760ae5d0f5f url=/mulesoft/current/en-us/dataweave/latest/dw-values-functions-field.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# field

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## field(namespace: Namespace | Null = null, name: String): PathElement

This function creates a `PathElement` data type to use for selecting an _object field_ and populates
the type’s `selector` field with the given string.

Some versions of the `update` and `mask` functions accept a `PathElement` as an argument.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>namespace</code></p></td><td><p>The namespace of the field to select. If not specified, a null value is set.</p></td></tr><tr><td><p><code>name</code></p></td><td><p>A string that names the attribute to select.</p></td></tr></tbody></table>

### Example

This example creates an object field selector for a specified namespace (`ns0`) and sets the
selector’s value to `"myFieldName"`. In the output, also note that the value of the `"kind"` key is
`"Object"`.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::util::Values
ns ns0 http://acme.com/foo
---
field(ns0 , "myFieldName")
```

#### Output

```Json
{
   "kind": "Object",
   "namespace": "http://acme.com/foo",
   "selector": "myFieldName"
 }
```

<!-- document id=faa59b5b03336e28e1cd4d29c1f0d3940074d3faa7bee4270a4e5c6f6b6d239e url=/mulesoft/current/en-us/dataweave/2.11/dw-multipart-functions-file.md -->

---
product: DataWeave
version: 2.11
---

# file

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## file(opts: {| name: String, path: String, mime?: String, fileName?: String |})

Creates a `MultipartPart` data structure from a resource file.

This version of the `file` function accepts as argument an object containing key/value pairs,
enabling you to enter the key/value pairs in any order, for example:

```txt
Multipart::file({ name: "myFile", path: "myClients.json", mime: "application/json", fileName: "partMyClients.json"})
```

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>opts</code></p></div></div></td><td><div><div><p>An object that specifies the following key/value pairs:</p></div><div><ul><li><p>A unique <code>name</code> (required) for the <code>Content-Disposition</code> header of the part.</p></li><li><p>A <code>path</code> (required) relative to the <code>src/main/resources</code> project path for the Mule app.</p></li><li><p><code>mime</code> (optional for strings) for the mime type (for example, <code>application/json</code>) to apply to content within the part. This setting <em>cannot</em> be used to transform the input mime type.</p></li><li><p>An optional <code>fileName</code> value for the <code>filename</code> parameter in the part’s <code>Content-Disposition</code> header. Defaults to the string <code>"filename"</code> if not supplied. This value does not need to match the input file name.</p></li></ul></div></div></td></tr></tbody></table>

### Example

This example creates a `MultipartPart` from a file accessible to the DataWeave function, the file
name is `orders.xml` and is located in the Mule application’s `/src/main/resources` folder.

The `file` function locates the external `orders.xml` file and uses key/value pairs to indicate the
various parameters needed to build the `MultipartPart`.

- The `name` can be anything, but it usually coincides with the required parameter needed by the
  receiving server that accepts this `Multipart` payload.

- The `path` is set to `./orders.xml`, which is the path and name for the `orders.xml` file that is
  loaded into the `MultipartPart`.

- The `mime` parameter specifies the correct MIME type for the file. In this case, it is
  `application/xml`.

- The `filename` can be changed to any value, it can be different from the actual input file’s
  filename.

Note that the output of this example is not compatible with the `multipart/form-data` output type
because it is just one part of a `Multipart` structure. To create a valid `multipart/form-data`
output, use the `Multipart::form()` function with one or more `Multipart` files and/or fields.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
output application/dw
var ordersFilePath = "./orders.xml"
---
Multipart::file{ name: "file", path: ordersFilePath, mime: "application/xml", fileName: "orders.xml" }
```

#### Input

A file called `orders.xml` located in `src/main/resources` with the following content:

```xml
<orders>
  <order>
    <item>
      <id>1001</id>
      <qty>1</qty>
      <price>\$100</price>
    </item>
    <item>
      <id>2001</id>
      <qty>2</qty>
      <price>\$50</price>
    </item>
  </order>
</orders>
```

#### Output

```json
{
  "headers": {
    "Content-Type": "application/xml",
    "Content-Disposition": {
      "name": "file",
      "filename": "orders.xml"
    }
  },
  "content": "<?xml version='1.0' encoding='UTF-8'?>\n<orders>\n  <order>\n    <item>\n      <id>1001</id>\n      <qty>1</qty>\n      <price>\$100</price>\n    </item>\n    <item>\n      <id>2001</id>\n      <qty>2</qty>\n      <price>\$50</price>\n    </item>\n  </order>\n</orders>"
}
```

### Example

This example inserts file content from a `MultipartPart` into a `Multipart`, resulting in a
`multipart/form-data` output. The example uses the `form` function to create the `Multipart` and
uses `file` to create a part.

The `Multipart::form()` function accepts an array of `Multipart` items, where each part can be
created using the `Multipart::field()` or `Multipart::file()` functions.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
output multipart/form-data
var ordersFilePath = "./orders.xml"
var myArgs = { name: "file", path: ordersFilePath, mime: "application/xml", fileName: "myorders.xml"}
---
Multipart::form([
  Multipart::file(myArgs)
])
```

#### Output

```json
------=_Part_5349_1228640551.1560391284935
Content-Type: application/xml
Content-Disposition: form-data; name="file"; filename="myorders.xml"
<?xml version='1.0' encoding='UTF-8'?>
<orders>
  <order>
    <item>
      <id>1001</id>
      <qty>1</qty>
      <price>$100</price>
    </item>
    <item>
      <id>2001</id>
      <qty>2</qty>
      <price>$50</price>
    </item>
  </order>
</orders>
------=_Part_5349_1228640551.1560391284935--
```

## file(fieldName: String, path: String, mime: String = 'application/octet-stream', sentFileName: String = 'filename')

Creates a `MultipartPart` data structure from a resource file.

This version of the `file` function accepts String arguments in a comma-separated list, for example:

```txt
Multipart::field("myFile", myClients, 'application/json', "partMyClients.json")
```

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>fieldName</code></p></td><td><div><div><p>A unique name (required) for the <code>Content-Disposition</code> header of the part.</p></div></div></td></tr><tr><td><p><code>path</code></p></td><td><div><div><p>A path (required) relative to the <code>src/main/resources</code> project path for the Mule app.</p></div></div></td></tr><tr><td><p><code>mime</code></p></td><td><div><div><p>The mime type (optional for strings), for example, <code>application/json</code>, to apply to content within the part. This setting <em>cannot</em> be used to transform the input mime type.</p></div></div></td></tr><tr><td><p><code>sentFileName</code></p></td><td><div><div><p>An optional file name value for the <code>filename</code> parameter in the part’s <code>Content-Disposition</code> header. Defaults to the string <code>"filename"</code> if not specified. This value does not need to match the input file name.</p></div></div></td></tr></tbody></table>

### Example

This example inserts file content from a `MultipartPart` into a `Multipart` data structure. It uses
the `form` function to create the `Multipart` type and uses `file` to create a part named `myClient`
with JSON content from an external file `myClients.json`. It also specifies `partMyClients.json` as
the value for to the `filename` parameter.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
var myClients = "myClients.json"
output multipart/form-data
---
Multipart::form([
 Multipart::file("myFile", myClients, 'application/json', "partMyClients.json")
])
```

#### Input

A file called `myClients.json` and located in `src/main/resources` with the following content.

```JSON
clients: {
    client: {
      id: 1,
      name: "Mariano"
    },
    client: {
      id: 2,
      name: "Shoki"
    }
  }
```

#### Output

```txt
------=_Part_1586_1887987980.1542569342438
Content-Type: application/json
Content-Disposition: form-data; name="myFile"; filename="partMyClients.json"

{
   clients: {
     client: {
       id: 1,
       name: "Mariano"
     },
     client: {
       id: 2,
       name: "Shoki"
     }
   }
}
------=_Part_1586_1887987980.1542569342438--
```

<!-- document id=38c3929f299f4392e03656dfa234a8bb4eb864620d4ddd62bed7782bf8dd8b58 url=/mulesoft/current/en-us/dataweave/2.12/dw-multipart-functions-file.md -->

---
product: DataWeave
version: 2.12
---

# file

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## file(opts: {| name: String, path: String, mime?: String, fileName?: String |})

Creates a `MultipartPart` data structure from a resource file.

This version of the `file` function accepts as argument an object containing key/value pairs,
enabling you to enter the key/value pairs in any order, for example:

```txt
Multipart::file({ name: "myFile", path: "myClients.json", mime: "application/json", fileName: "partMyClients.json"})
```

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>opts</code></p></div></div></td><td><div><div><p>An object that specifies the following key/value pairs:</p></div><div><ul><li><p>A unique <code>name</code> (required) for the <code>Content-Disposition</code> header of the part.</p></li><li><p>A <code>path</code> (required) relative to the <code>src/main/resources</code> project path for the Mule app.</p></li><li><p><code>mime</code> (optional for strings) for the mime type (for example, <code>application/json</code>) to apply to content within the part. This setting <em>cannot</em> be used to transform the input mime type.</p></li><li><p>An optional <code>fileName</code> value for the <code>filename</code> parameter in the part’s <code>Content-Disposition</code> header. Defaults to the string <code>"filename"</code> if not supplied. This value does not need to match the input file name.</p></li></ul></div></div></td></tr></tbody></table>

### Example

This example creates a `MultipartPart` from a file accessible to the DataWeave function, the file
name is `orders.xml` and is located in the Mule application’s `/src/main/resources` folder.

The `file` function locates the external `orders.xml` file and uses key/value pairs to indicate the
various parameters needed to build the `MultipartPart`.

- The `name` can be anything, but it usually coincides with the required parameter needed by the
  receiving server that accepts this `Multipart` payload.

- The `path` is set to `./orders.xml`, which is the path and name for the `orders.xml` file that is
  loaded into the `MultipartPart`.

- The `mime` parameter specifies the correct MIME type for the file. In this case, it is
  `application/xml`.

- The `filename` can be changed to any value, it can be different from the actual input file’s
  filename.

Note that the output of this example is not compatible with the `multipart/form-data` output type
because it is just one part of a `Multipart` structure. To create a valid `multipart/form-data`
output, use the `Multipart::form()` function with one or more `Multipart` files and/or fields.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
output application/dw
var ordersFilePath = "./orders.xml"
---
Multipart::file{ name: "file", path: ordersFilePath, mime: "application/xml", fileName: "orders.xml" }
```

#### Input

A file called `orders.xml` located in `src/main/resources` with the following content:

```xml
<orders>
  <order>
    <item>
      <id>1001</id>
      <qty>1</qty>
      <price>\$100</price>
    </item>
    <item>
      <id>2001</id>
      <qty>2</qty>
      <price>\$50</price>
    </item>
  </order>
</orders>
```

#### Output

```json
{
  "headers": {
    "Content-Type": "application/xml",
    "Content-Disposition": {
      "name": "file",
      "filename": "orders.xml"
    }
  },
  "content": "<?xml version='1.0' encoding='UTF-8'?>\n<orders>\n  <order>\n    <item>\n      <id>1001</id>\n      <qty>1</qty>\n      <price>\$100</price>\n    </item>\n    <item>\n      <id>2001</id>\n      <qty>2</qty>\n      <price>\$50</price>\n    </item>\n  </order>\n</orders>"
}
```

### Example

This example inserts file content from a `MultipartPart` into a `Multipart`, resulting in a
`multipart/form-data` output. The example uses the `form` function to create the `Multipart` and
uses `file` to create a part.

The `Multipart::form()` function accepts an array of `Multipart` items, where each part can be
created using the `Multipart::field()` or `Multipart::file()` functions.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
output multipart/form-data
var ordersFilePath = "./orders.xml"
var myArgs = { name: "file", path: ordersFilePath, mime: "application/xml", fileName: "myorders.xml"}
---
Multipart::form([
  Multipart::file(myArgs)
])
```

#### Output

```json
------=_Part_5349_1228640551.1560391284935
Content-Type: application/xml
Content-Disposition: form-data; name="file"; filename="myorders.xml"
<?xml version='1.0' encoding='UTF-8'?>
<orders>
  <order>
    <item>
      <id>1001</id>
      <qty>1</qty>
      <price>$100</price>
    </item>
    <item>
      <id>2001</id>
      <qty>2</qty>
      <price>$50</price>
    </item>
  </order>
</orders>
------=_Part_5349_1228640551.1560391284935--
```

## file(fieldName: String, path: String, mime: String = 'application/octet-stream', sentFileName: String = 'filename')

Creates a `MultipartPart` data structure from a resource file.

This version of the `file` function accepts String arguments in a comma-separated list, for example:

```txt
Multipart::field("myFile", myClients, 'application/json', "partMyClients.json")
```

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>fieldName</code></p></td><td><div><div><p>A unique name (required) for the <code>Content-Disposition</code> header of the part.</p></div></div></td></tr><tr><td><p><code>path</code></p></td><td><div><div><p>A path (required) relative to the <code>src/main/resources</code> project path for the Mule app.</p></div></div></td></tr><tr><td><p><code>mime</code></p></td><td><div><div><p>The mime type (optional for strings), for example, <code>application/json</code>, to apply to content within the part. This setting <em>cannot</em> be used to transform the input mime type.</p></div></div></td></tr><tr><td><p><code>sentFileName</code></p></td><td><div><div><p>An optional file name value for the <code>filename</code> parameter in the part’s <code>Content-Disposition</code> header. Defaults to the string <code>"filename"</code> if not specified. This value does not need to match the input file name.</p></div></div></td></tr></tbody></table>

### Example

This example inserts file content from a `MultipartPart` into a `Multipart` data structure. It uses
the `form` function to create the `Multipart` type and uses `file` to create a part named `myClient`
with JSON content from an external file `myClients.json`. It also specifies `partMyClients.json` as
the value for to the `filename` parameter.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
var myClients = "myClients.json"
output multipart/form-data
---
Multipart::form([
 Multipart::file("myFile", myClients, 'application/json', "partMyClients.json")
])
```

#### Input

A file called `myClients.json` and located in `src/main/resources` with the following content.

```JSON
clients: {
    client: {
      id: 1,
      name: "Mariano"
    },
    client: {
      id: 2,
      name: "Shoki"
    }
  }
```

#### Output

```txt
------=_Part_1586_1887987980.1542569342438
Content-Type: application/json
Content-Disposition: form-data; name="myFile"; filename="partMyClients.json"

{
   clients: {
     client: {
       id: 1,
       name: "Mariano"
     },
     client: {
       id: 2,
       name: "Shoki"
     }
   }
}
------=_Part_1586_1887987980.1542569342438--
```

<!-- document id=4c3a6c8ec130351512b55a7cd363d38f3289f3c543ad9848a3ab347ad92bb8a2 url=/mulesoft/current/en-us/dataweave/2.3/dw-multipart-functions-file.md -->

---
product: DataWeave
version: 2.3
---

# file

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## file({| name: String, path: String, mime?: String, fileName?: String |})

Creates a `MultipartPart` data structure from a resource file.

This version of the `file` function accepts arguments as an array of objects that use the parameter
names as keys, for example:

```txt
Multipart::file({ name: "myFile", path: "myClients.json", mime: "application/json", fileName: "partMyClients.json"})
```

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>opts</code></p></td><td><div><div><p>Array of objects that specifies:</p></div><div><ul><li><p>A unique <code>name</code> (required) for the <code>Content-Disposition</code> header of the part.</p></li><li><p>A <code>path</code> (required) relative to the <code>src/main/resources</code> project path for the Mule app.</p></li><li><p><code>mime</code> (optional for strings) for the mime type (for example, <code>application/json</code>) to apply to content within the part. This setting <em>cannot</em> be used to transform the input mime type.</p></li><li><p>An optional <code>fileName</code> value for the <code>filename</code> parameter in the part’s <code>Content-Disposition</code> header. Defaults to the string <code>"filename"</code> if not supplied. This value does not need to match the input file name.</p></li></ul></div></div></td></tr></tbody></table>

### Example

This example inserts file content from a `MultipartPart` into a `Multipart` data structure. It uses
the `form` function to create the `Multipart` and uses `file` to create a part named `myClient` with
JSON content from an external file `myClients.json`. It also specifies `partMyClients.json` as the
value for to the `filename` parameter.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
output multipart/form-data
var myClients = "myClients.json"
var myArgs = { name: "myFile", path: "myClients.json", mime: "application/json", * fileName: "partMyClients.json"}
---
Multipart::form([
  Multipart::file(myArgs)
])
```

#### Input

A file called `myClients.json` and located in `src/main/resources` with the following content.

```json
clients: {
  client: {
    id: 1,
     name: "Mariano"
   },
   client: {
     id: 2,
     name: "Shoki"
  }
}
```

#### Output

```txt
------=_Part_1586_1887987980.1542569342438
Content-Type: application/json
Content-Disposition: form-data; name="myFile"; filename="partMyClients.json"

{
   clients: {
     client: {
       id: 1,
       name: "Mariano"
     },
     client: {
       id: 2,
       name: "Shoki"
     }
   }
}
------=_Part_1586_1887987980.1542569342438--
```

## file(String, String, String, String)

Creates a `MultipartPart` data structure from a resource file.

This version of the `file` function accepts arguments in a comma-separated list, for example:

```txt
Multipart::field("myFile", myClients, 'application/json', "partMyClients.json")
```

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>opts</code></p></td><td><div><div><p>Array of objects that specifies:</p></div><div><ul><li><p>A unique <code>name</code> (required) for the <code>Content-Disposition</code> header of the part.</p></li><li><p>A <code>path</code> (required) relative to the <code>src/main/resources</code> project path for the Mule app.</p></li><li><p><code>mime</code> (optional for strings) for the mime type (for example, <code>application/json</code>) to apply to content within the part. This setting <em>cannot</em> be used to transform the input mime type.</p></li><li><p>An optional <code>fileName</code> value for the <code>filename</code> parameter in the part’s <code>Content-Disposition</code> header. Defaults to the string <code>"filename"</code> if not supplied. This value does not need to match the input file name.</p></li></ul></div></div></td></tr></tbody></table>

### Example

This example inserts file content from a `MultipartPart` into a `Multipart` data structure. It uses
the `form` function to create the `Multipart` type and uses `file` to create a part named `myClient`
with JSON content from an external file `myClients.json`. It also specifies `partMyClients.json` as
the value for to the `filename` parameter.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
var myClients = "myClients.json"
output multipart/form-data
---
Multipart::form([
 Multipart::file("myFile", myClients, 'application/json', "partMyClients.json")
])
```

#### Input

A file called `myClients.json` and located in `src/main/resources` with the following content.

```JSON
clients: {
    client: {
      id: 1,
      name: "Mariano"
    },
    client: {
      id: 2,
      name: "Shoki"
    }
  }
```

#### Output

```txt
------=_Part_1586_1887987980.1542569342438
Content-Type: application/json
Content-Disposition: form-data; name="myFile"; filename="partMyClients.json"

{
   clients: {
     client: {
       id: 1,
       name: "Mariano"
     },
     client: {
       id: 2,
       name: "Shoki"
     }
   }
}
------=_Part_1586_1887987980.1542569342438--
```

<!-- document id=4fc429737d0407791dc6e5bdc95cbf644d55b0bad297cb0667de5b36b5c2505a url=/mulesoft/current/en-us/dataweave/2.4/dw-multipart-functions-file.md -->

---
product: DataWeave
version: 2.4
---

# file

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## file(opts: {| name: String, path: String, mime?: String, fileName?: String |})

Creates a `MultipartPart` data structure from a resource file.

This version of the `file` function accepts as argument an object containing key/value pairs,
enabling you to enter the key/value pairs in any order, for example:

```txt
Multipart::file({ name: "myFile", path: "myClients.json", mime: "application/json", fileName: "partMyClients.json"})
```

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>opts</code></p></div></div></td><td><div><div><p>An object that specifies the following key/value pairs:</p></div><div><ul><li><p>A unique <code>name</code> (required) for the <code>Content-Disposition</code> header of the part.</p></li><li><p>A <code>path</code> (required) relative to the <code>src/main/resources</code> project path for the Mule app.</p></li><li><p><code>mime</code> (optional for strings) for the mime type (for example, <code>application/json</code>) to apply to content within the part. This setting <em>cannot</em> be used to transform the input mime type.</p></li><li><p>An optional <code>fileName</code> value for the <code>filename</code> parameter in the part’s <code>Content-Disposition</code> header. Defaults to the string <code>"filename"</code> if not supplied. This value does not need to match the input file name.</p></li></ul></div></div></td></tr></tbody></table>

### Example

This example creates a `MultipartPart` from a file accessible to the DataWeave function, the file
name is `orders.xml` and is located in the Mule application’s `/src/main/resources` folder.

The `file` function locates the external `orders.xml` file and uses key/value pairs to indicate the
various parameters needed to build the `MultipartPart`.

- The `name` can be anything, but it usually coincides with the required parameter needed by the
  receiving server that accepts this `Multipart` payload.

- The `path` is set to `./orders.xml`, which is the path and name for the `orders.xml` file that is
  loaded into the `MultipartPart`.

- The `mime` parameter specifies the correct MIME type for the file. In this case, it is
  `application/xml`.

- The `filename` can be changed to any value, it can be different from the actual input file’s
  filename.

Note that the output of this example is not compatible with the `multipart/form-data` output type
because it is just one part of a `Multipart` structure. To create a valid `multipart/form-data`
output, use the `Multipart::form()` function with one or more `Multipart` files and/or fields.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
output application/dw
var ordersFilePath = "./orders.xml"
---
Multipart::file{ name: "file", path: ordersFilePath, mime: "application/xml", fileName: "orders.xml" }
```

#### Input

A file called `orders.xml` located in `src/main/resources` with the following content:

```xml
<orders>
  <order>
    <item>
      <id>1001</id>
      <qty>1</qty>
      <price>\$100</price>
    </item>
    <item>
      <id>2001</id>
      <qty>2</qty>
      <price>\$50</price>
    </item>
  </order>
</orders>
```

#### Output

```json
{
  "headers": {
    "Content-Type": "application/xml",
    "Content-Disposition": {
      "name": "file",
      "filename": "orders.xml"
    }
  },
  "content": "<?xml version='1.0' encoding='UTF-8'?>\n<orders>\n  <order>\n    <item>\n      <id>1001</id>\n      <qty>1</qty>\n      <price>\$100</price>\n    </item>\n    <item>\n      <id>2001</id>\n      <qty>2</qty>\n      <price>\$50</price>\n    </item>\n  </order>\n</orders>"
}
```

### Example

This example inserts file content from a `MultipartPart` into a `Multipart`, resulting in a
`multipart/form-data` output. The example uses the `form` function to create the `Multipart` and
uses `file` to create a part.

The `Multipart::form()` function accepts an array of `Multipart` items, where each part can be
created using the `Multipart::field()` or `Multipart::file()` functions.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
output multipart/form-data
var ordersFilePath = "./orders.xml"
var myArgs = { name: "file", path: ordersFilePath, mime: "application/xml", fileName: "myorders.xml"}
---
Multipart::form([
  Multipart::file(myArgs)
])
```

#### Output

```json
------=_Part_5349_1228640551.1560391284935
Content-Type: application/xml
Content-Disposition: form-data; name="file"; filename="myorders.xml"
<?xml version='1.0' encoding='UTF-8'?>
<orders>
  <order>
    <item>
      <id>1001</id>
      <qty>1</qty>
      <price>$100</price>
    </item>
    <item>
      <id>2001</id>
      <qty>2</qty>
      <price>$50</price>
    </item>
  </order>
</orders>
------=_Part_5349_1228640551.1560391284935--
```

## file(fieldName: String, path: String, mime: String = 'application/octet-stream', sentFileName: String = 'filename')

Creates a `MultipartPart` data structure from a resource file.

This version of the `file` function accepts String arguments in a comma-separated list, for example:

```txt
Multipart::field("myFile", myClients, 'application/json', "partMyClients.json")
```

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>fieldName</code></p></td><td><div><div><p>A unique name (required) for the <code>Content-Disposition</code> header of the part.</p></div></div></td></tr><tr><td><p><code>path</code></p></td><td><div><div><p>A path (required) relative to the <code>src/main/resources</code> project path for the Mule app.</p></div></div></td></tr><tr><td><p><code>mime</code></p></td><td><div><div><p>The mime type (optional for strings), for example, <code>application/json</code>, to apply to content within the part. This setting <em>cannot</em> be used to transform the input mime type.</p></div></div></td></tr><tr><td><p><code>sentFileName</code></p></td><td><div><div><p>An optional file name value for the <code>filename</code> parameter in the part’s <code>Content-Disposition</code> header. Defaults to the string <code>"filename"</code> if not specified. This value does not need to match the input file name.</p></div></div></td></tr></tbody></table>

### Example

This example inserts file content from a `MultipartPart` into a `Multipart` data structure. It uses
the `form` function to create the `Multipart` type and uses `file` to create a part named `myClient`
with JSON content from an external file `myClients.json`. It also specifies `partMyClients.json` as
the value for to the `filename` parameter.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
var myClients = "myClients.json"
output multipart/form-data
---
Multipart::form([
 Multipart::file("myFile", myClients, 'application/json', "partMyClients.json")
])
```

#### Input

A file called `myClients.json` and located in `src/main/resources` with the following content.

```JSON
clients: {
    client: {
      id: 1,
      name: "Mariano"
    },
    client: {
      id: 2,
      name: "Shoki"
    }
  }
```

#### Output

```txt
------=_Part_1586_1887987980.1542569342438
Content-Type: application/json
Content-Disposition: form-data; name="myFile"; filename="partMyClients.json"

{
   clients: {
     client: {
       id: 1,
       name: "Mariano"
     },
     client: {
       id: 2,
       name: "Shoki"
     }
   }
}
------=_Part_1586_1887987980.1542569342438--
```

<!-- document id=f7840afccda37f604d7c3fecefafb1b1db47c20ce6319a14749f52bbf14f329e url=/mulesoft/current/en-us/dataweave/2.6/dw-multipart-functions-file.md -->

---
product: DataWeave
version: 2.6
---

# file

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## file(opts: {| name: String, path: String, mime?: String, fileName?: String |})

Creates a `MultipartPart` data structure from a resource file.

This version of the `file` function accepts as argument an object containing key/value pairs,
enabling you to enter the key/value pairs in any order, for example:

```txt
Multipart::file({ name: "myFile", path: "myClients.json", mime: "application/json", fileName: "partMyClients.json"})
```

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>opts</code></p></div></div></td><td><div><div><p>An object that specifies the following key/value pairs:</p></div><div><ul><li><p>A unique <code>name</code> (required) for the <code>Content-Disposition</code> header of the part.</p></li><li><p>A <code>path</code> (required) relative to the <code>src/main/resources</code> project path for the Mule app.</p></li><li><p><code>mime</code> (optional for strings) for the mime type (for example, <code>application/json</code>) to apply to content within the part. This setting <em>cannot</em> be used to transform the input mime type.</p></li><li><p>An optional <code>fileName</code> value for the <code>filename</code> parameter in the part’s <code>Content-Disposition</code> header. Defaults to the string <code>"filename"</code> if not supplied. This value does not need to match the input file name.</p></li></ul></div></div></td></tr></tbody></table>

### Example

This example creates a `MultipartPart` from a file accessible to the DataWeave function, the file
name is `orders.xml` and is located in the Mule application’s `/src/main/resources` folder.

The `file` function locates the external `orders.xml` file and uses key/value pairs to indicate the
various parameters needed to build the `MultipartPart`.

- The `name` can be anything, but it usually coincides with the required parameter needed by the
  receiving server that accepts this `Multipart` payload.

- The `path` is set to `./orders.xml`, which is the path and name for the `orders.xml` file that is
  loaded into the `MultipartPart`.

- The `mime` parameter specifies the correct MIME type for the file. In this case, it is
  `application/xml`.

- The `filename` can be changed to any value, it can be different from the actual input file’s
  filename.

Note that the output of this example is not compatible with the `multipart/form-data` output type
because it is just one part of a `Multipart` structure. To create a valid `multipart/form-data`
output, use the `Multipart::form()` function with one or more `Multipart` files and/or fields.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
output application/dw
var ordersFilePath = "./orders.xml"
---
Multipart::file{ name: "file", path: ordersFilePath, mime: "application/xml", fileName: "orders.xml" }
```

#### Input

A file called `orders.xml` located in `src/main/resources` with the following content:

```xml
<orders>
  <order>
    <item>
      <id>1001</id>
      <qty>1</qty>
      <price>\$100</price>
    </item>
    <item>
      <id>2001</id>
      <qty>2</qty>
      <price>\$50</price>
    </item>
  </order>
</orders>
```

#### Output

```json
{
  "headers": {
    "Content-Type": "application/xml",
    "Content-Disposition": {
      "name": "file",
      "filename": "orders.xml"
    }
  },
  "content": "<?xml version='1.0' encoding='UTF-8'?>\n<orders>\n  <order>\n    <item>\n      <id>1001</id>\n      <qty>1</qty>\n      <price>\$100</price>\n    </item>\n    <item>\n      <id>2001</id>\n      <qty>2</qty>\n      <price>\$50</price>\n    </item>\n  </order>\n</orders>"
}
```

### Example

This example inserts file content from a `MultipartPart` into a `Multipart`, resulting in a
`multipart/form-data` output. The example uses the `form` function to create the `Multipart` and
uses `file` to create a part.

The `Multipart::form()` function accepts an array of `Multipart` items, where each part can be
created using the `Multipart::field()` or `Multipart::file()` functions.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
output multipart/form-data
var ordersFilePath = "./orders.xml"
var myArgs = { name: "file", path: ordersFilePath, mime: "application/xml", fileName: "myorders.xml"}
---
Multipart::form([
  Multipart::file(myArgs)
])
```

#### Output

```json
------=_Part_5349_1228640551.1560391284935
Content-Type: application/xml
Content-Disposition: form-data; name="file"; filename="myorders.xml"
<?xml version='1.0' encoding='UTF-8'?>
<orders>
  <order>
    <item>
      <id>1001</id>
      <qty>1</qty>
      <price>$100</price>
    </item>
    <item>
      <id>2001</id>
      <qty>2</qty>
      <price>$50</price>
    </item>
  </order>
</orders>
------=_Part_5349_1228640551.1560391284935--
```

## file(fieldName: String, path: String, mime: String = 'application/octet-stream', sentFileName: String = 'filename')

Creates a `MultipartPart` data structure from a resource file.

This version of the `file` function accepts String arguments in a comma-separated list, for example:

```txt
Multipart::field("myFile", myClients, 'application/json', "partMyClients.json")
```

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>fieldName</code></p></td><td><div><div><p>A unique name (required) for the <code>Content-Disposition</code> header of the part.</p></div></div></td></tr><tr><td><p><code>path</code></p></td><td><div><div><p>A path (required) relative to the <code>src/main/resources</code> project path for the Mule app.</p></div></div></td></tr><tr><td><p><code>mime</code></p></td><td><div><div><p>The mime type (optional for strings), for example, <code>application/json</code>, to apply to content within the part. This setting <em>cannot</em> be used to transform the input mime type.</p></div></div></td></tr><tr><td><p><code>sentFileName</code></p></td><td><div><div><p>An optional file name value for the <code>filename</code> parameter in the part’s <code>Content-Disposition</code> header. Defaults to the string <code>"filename"</code> if not specified. This value does not need to match the input file name.</p></div></div></td></tr></tbody></table>

### Example

This example inserts file content from a `MultipartPart` into a `Multipart` data structure. It uses
the `form` function to create the `Multipart` type and uses `file` to create a part named `myClient`
with JSON content from an external file `myClients.json`. It also specifies `partMyClients.json` as
the value for to the `filename` parameter.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
var myClients = "myClients.json"
output multipart/form-data
---
Multipart::form([
 Multipart::file("myFile", myClients, 'application/json', "partMyClients.json")
])
```

#### Input

A file called `myClients.json` and located in `src/main/resources` with the following content.

```JSON
clients: {
    client: {
      id: 1,
      name: "Mariano"
    },
    client: {
      id: 2,
      name: "Shoki"
    }
  }
```

#### Output

```txt
------=_Part_1586_1887987980.1542569342438
Content-Type: application/json
Content-Disposition: form-data; name="myFile"; filename="partMyClients.json"

{
   clients: {
     client: {
       id: 1,
       name: "Mariano"
     },
     client: {
       id: 2,
       name: "Shoki"
     }
   }
}
------=_Part_1586_1887987980.1542569342438--
```

<!-- document id=18fad32164d4e81bcbb05d2d5bae8c828a34aaf905e9961d0960b9d378ba3395 url=/mulesoft/current/en-us/dataweave/2.9/dw-multipart-functions-file.md -->

---
product: DataWeave
version: 2.9
---

# file

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## file(opts: {| name: String, path: String, mime?: String, fileName?: String |})

Creates a `MultipartPart` data structure from a resource file.

This version of the `file` function accepts as argument an object containing key/value pairs,
enabling you to enter the key/value pairs in any order, for example:

```txt
Multipart::file({ name: "myFile", path: "myClients.json", mime: "application/json", fileName: "partMyClients.json"})
```

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>opts</code></p></div></div></td><td><div><div><p>An object that specifies the following key/value pairs:</p></div><div><ul><li><p>A unique <code>name</code> (required) for the <code>Content-Disposition</code> header of the part.</p></li><li><p>A <code>path</code> (required) relative to the <code>src/main/resources</code> project path for the Mule app.</p></li><li><p><code>mime</code> (optional for strings) for the mime type (for example, <code>application/json</code>) to apply to content within the part. This setting <em>cannot</em> be used to transform the input mime type.</p></li><li><p>An optional <code>fileName</code> value for the <code>filename</code> parameter in the part’s <code>Content-Disposition</code> header. Defaults to the string <code>"filename"</code> if not supplied. This value does not need to match the input file name.</p></li></ul></div></div></td></tr></tbody></table>

### Example

This example creates a `MultipartPart` from a file accessible to the DataWeave function, the file
name is `orders.xml` and is located in the Mule application’s `/src/main/resources` folder.

The `file` function locates the external `orders.xml` file and uses key/value pairs to indicate the
various parameters needed to build the `MultipartPart`.

- The `name` can be anything, but it usually coincides with the required parameter needed by the
  receiving server that accepts this `Multipart` payload.

- The `path` is set to `./orders.xml`, which is the path and name for the `orders.xml` file that is
  loaded into the `MultipartPart`.

- The `mime` parameter specifies the correct MIME type for the file. In this case, it is
  `application/xml`.

- The `filename` can be changed to any value, it can be different from the actual input file’s
  filename.

Note that the output of this example is not compatible with the `multipart/form-data` output type
because it is just one part of a `Multipart` structure. To create a valid `multipart/form-data`
output, use the `Multipart::form()` function with one or more `Multipart` files and/or fields.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
output application/dw
var ordersFilePath = "./orders.xml"
---
Multipart::file{ name: "file", path: ordersFilePath, mime: "application/xml", fileName: "orders.xml" }
```

#### Input

A file called `orders.xml` located in `src/main/resources` with the following content:

```xml
<orders>
  <order>
    <item>
      <id>1001</id>
      <qty>1</qty>
      <price>\$100</price>
    </item>
    <item>
      <id>2001</id>
      <qty>2</qty>
      <price>\$50</price>
    </item>
  </order>
</orders>
```

#### Output

```json
{
  "headers": {
    "Content-Type": "application/xml",
    "Content-Disposition": {
      "name": "file",
      "filename": "orders.xml"
    }
  },
  "content": "<?xml version='1.0' encoding='UTF-8'?>\n<orders>\n  <order>\n    <item>\n      <id>1001</id>\n      <qty>1</qty>\n      <price>\$100</price>\n    </item>\n    <item>\n      <id>2001</id>\n      <qty>2</qty>\n      <price>\$50</price>\n    </item>\n  </order>\n</orders>"
}
```

### Example

This example inserts file content from a `MultipartPart` into a `Multipart`, resulting in a
`multipart/form-data` output. The example uses the `form` function to create the `Multipart` and
uses `file` to create a part.

The `Multipart::form()` function accepts an array of `Multipart` items, where each part can be
created using the `Multipart::field()` or `Multipart::file()` functions.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
output multipart/form-data
var ordersFilePath = "./orders.xml"
var myArgs = { name: "file", path: ordersFilePath, mime: "application/xml", fileName: "myorders.xml"}
---
Multipart::form([
  Multipart::file(myArgs)
])
```

#### Output

```json
------=_Part_5349_1228640551.1560391284935
Content-Type: application/xml
Content-Disposition: form-data; name="file"; filename="myorders.xml"
<?xml version='1.0' encoding='UTF-8'?>
<orders>
  <order>
    <item>
      <id>1001</id>
      <qty>1</qty>
      <price>$100</price>
    </item>
    <item>
      <id>2001</id>
      <qty>2</qty>
      <price>$50</price>
    </item>
  </order>
</orders>
------=_Part_5349_1228640551.1560391284935--
```

## file(fieldName: String, path: String, mime: String = 'application/octet-stream', sentFileName: String = 'filename')

Creates a `MultipartPart` data structure from a resource file.

This version of the `file` function accepts String arguments in a comma-separated list, for example:

```txt
Multipart::field("myFile", myClients, 'application/json', "partMyClients.json")
```

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>fieldName</code></p></td><td><div><div><p>A unique name (required) for the <code>Content-Disposition</code> header of the part.</p></div></div></td></tr><tr><td><p><code>path</code></p></td><td><div><div><p>A path (required) relative to the <code>src/main/resources</code> project path for the Mule app.</p></div></div></td></tr><tr><td><p><code>mime</code></p></td><td><div><div><p>The mime type (optional for strings), for example, <code>application/json</code>, to apply to content within the part. This setting <em>cannot</em> be used to transform the input mime type.</p></div></div></td></tr><tr><td><p><code>sentFileName</code></p></td><td><div><div><p>An optional file name value for the <code>filename</code> parameter in the part’s <code>Content-Disposition</code> header. Defaults to the string <code>"filename"</code> if not specified. This value does not need to match the input file name.</p></div></div></td></tr></tbody></table>

### Example

This example inserts file content from a `MultipartPart` into a `Multipart` data structure. It uses
the `form` function to create the `Multipart` type and uses `file` to create a part named `myClient`
with JSON content from an external file `myClients.json`. It also specifies `partMyClients.json` as
the value for to the `filename` parameter.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
var myClients = "myClients.json"
output multipart/form-data
---
Multipart::form([
 Multipart::file("myFile", myClients, 'application/json', "partMyClients.json")
])
```

#### Input

A file called `myClients.json` and located in `src/main/resources` with the following content.

```JSON
clients: {
    client: {
      id: 1,
      name: "Mariano"
    },
    client: {
      id: 2,
      name: "Shoki"
    }
  }
```

#### Output

```txt
------=_Part_1586_1887987980.1542569342438
Content-Type: application/json
Content-Disposition: form-data; name="myFile"; filename="partMyClients.json"

{
   clients: {
     client: {
       id: 1,
       name: "Mariano"
     },
     client: {
       id: 2,
       name: "Shoki"
     }
   }
}
------=_Part_1586_1887987980.1542569342438--
```

<!-- document id=fa5977c5b9205ec6f21bb21bffed1ed3f265e4a6c9eaed684b1879330d3a11c2 url=/mulesoft/current/en-us/dataweave/latest/dw-multipart-functions-file.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# file

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## file(opts: {| name: String, path: String, mime?: String, fileName?: String |})

Creates a `MultipartPart` data structure from a resource file.

This version of the `file` function accepts as argument an object containing key/value pairs,
enabling you to enter the key/value pairs in any order, for example:

```txt
Multipart::file({ name: "myFile", path: "myClients.json", mime: "application/json", fileName: "partMyClients.json"})
```

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>opts</code></p></div></div></td><td><div><div><p>An object that specifies the following key/value pairs:</p></div><div><ul><li><p>A unique <code>name</code> (required) for the <code>Content-Disposition</code> header of the part.</p></li><li><p>A <code>path</code> (required) relative to the <code>src/main/resources</code> project path for the Mule app.</p></li><li><p><code>mime</code> (optional for strings) for the mime type (for example, <code>application/json</code>) to apply to content within the part. This setting <em>cannot</em> be used to transform the input mime type.</p></li><li><p>An optional <code>fileName</code> value for the <code>filename</code> parameter in the part’s <code>Content-Disposition</code> header. Defaults to the string <code>"filename"</code> if not supplied. This value does not need to match the input file name.</p></li></ul></div></div></td></tr></tbody></table>

### Example

This example creates a `MultipartPart` from a file accessible to the DataWeave function, the file
name is `orders.xml` and is located in the Mule application’s `/src/main/resources` folder.

The `file` function locates the external `orders.xml` file and uses key/value pairs to indicate the
various parameters needed to build the `MultipartPart`.

- The `name` can be anything, but it usually coincides with the required parameter needed by the
  receiving server that accepts this `Multipart` payload.

- The `path` is set to `./orders.xml`, which is the path and name for the `orders.xml` file that is
  loaded into the `MultipartPart`.

- The `mime` parameter specifies the correct MIME type for the file. In this case, it is
  `application/xml`.

- The `filename` can be changed to any value, it can be different from the actual input file’s
  filename.

Note that the output of this example is not compatible with the `multipart/form-data` output type
because it is just one part of a `Multipart` structure. To create a valid `multipart/form-data`
output, use the `Multipart::form()` function with one or more `Multipart` files and/or fields.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
output application/dw
var ordersFilePath = "./orders.xml"
---
Multipart::file{ name: "file", path: ordersFilePath, mime: "application/xml", fileName: "orders.xml" }
```

#### Input

A file called `orders.xml` located in `src/main/resources` with the following content:

```xml
<orders>
  <order>
    <item>
      <id>1001</id>
      <qty>1</qty>
      <price>\$100</price>
    </item>
    <item>
      <id>2001</id>
      <qty>2</qty>
      <price>\$50</price>
    </item>
  </order>
</orders>
```

#### Output

```json
{
  "headers": {
    "Content-Type": "application/xml",
    "Content-Disposition": {
      "name": "file",
      "filename": "orders.xml"
    }
  },
  "content": "<?xml version='1.0' encoding='UTF-8'?>\n<orders>\n  <order>\n    <item>\n      <id>1001</id>\n      <qty>1</qty>\n      <price>\$100</price>\n    </item>\n    <item>\n      <id>2001</id>\n      <qty>2</qty>\n      <price>\$50</price>\n    </item>\n  </order>\n</orders>"
}
```

### Example

This example inserts file content from a `MultipartPart` into a `Multipart`, resulting in a
`multipart/form-data` output. The example uses the `form` function to create the `Multipart` and
uses `file` to create a part.

The `Multipart::form()` function accepts an array of `Multipart` items, where each part can be
created using the `Multipart::field()` or `Multipart::file()` functions.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
output multipart/form-data
var ordersFilePath = "./orders.xml"
var myArgs = { name: "file", path: ordersFilePath, mime: "application/xml", fileName: "myorders.xml"}
---
Multipart::form([
  Multipart::file(myArgs)
])
```

#### Output

```json
------=_Part_5349_1228640551.1560391284935
Content-Type: application/xml
Content-Disposition: form-data; name="file"; filename="myorders.xml"
<?xml version='1.0' encoding='UTF-8'?>
<orders>
  <order>
    <item>
      <id>1001</id>
      <qty>1</qty>
      <price>$100</price>
    </item>
    <item>
      <id>2001</id>
      <qty>2</qty>
      <price>$50</price>
    </item>
  </order>
</orders>
------=_Part_5349_1228640551.1560391284935--
```

## file(fieldName: String, path: String, mime: String = 'application/octet-stream', sentFileName: String = 'filename')

Creates a `MultipartPart` data structure from a resource file.

This version of the `file` function accepts String arguments in a comma-separated list, for example:

```txt
Multipart::field("myFile", myClients, 'application/json', "partMyClients.json")
```

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>fieldName</code></p></td><td><div><div><p>A unique name (required) for the <code>Content-Disposition</code> header of the part.</p></div></div></td></tr><tr><td><p><code>path</code></p></td><td><div><div><p>A path (required) relative to the <code>src/main/resources</code> project path for the Mule app.</p></div></div></td></tr><tr><td><p><code>mime</code></p></td><td><div><div><p>The mime type (optional for strings), for example, <code>application/json</code>, to apply to content within the part. This setting <em>cannot</em> be used to transform the input mime type.</p></div></div></td></tr><tr><td><p><code>sentFileName</code></p></td><td><div><div><p>An optional file name value for the <code>filename</code> parameter in the part’s <code>Content-Disposition</code> header. Defaults to the string <code>"filename"</code> if not specified. This value does not need to match the input file name.</p></div></div></td></tr></tbody></table>

### Example

This example inserts file content from a `MultipartPart` into a `Multipart` data structure. It uses
the `form` function to create the `Multipart` type and uses `file` to create a part named `myClient`
with JSON content from an external file `myClients.json`. It also specifies `partMyClients.json` as
the value for to the `filename` parameter.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
var myClients = "myClients.json"
output multipart/form-data
---
Multipart::form([
 Multipart::file("myFile", myClients, 'application/json', "partMyClients.json")
])
```

#### Input

A file called `myClients.json` and located in `src/main/resources` with the following content.

```JSON
clients: {
    client: {
      id: 1,
      name: "Mariano"
    },
    client: {
      id: 2,
      name: "Shoki"
    }
  }
```

#### Output

```txt
------=_Part_1586_1887987980.1542569342438
Content-Type: application/json
Content-Disposition: form-data; name="myFile"; filename="partMyClients.json"

{
   clients: {
     client: {
       id: 1,
       name: "Mariano"
     },
     client: {
       id: 2,
       name: "Shoki"
     }
   }
}
------=_Part_1586_1887987980.1542569342438--
```

<!-- document id=330b1e65fd963b4ec5b7c26bf72fdb6012892af314726f65d73f7d2b680ecd1c url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-filter.md -->

---
product: DataWeave
version: 2.11
---

# filter

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## filter<T>(@StreamCapable items: Array<T>, criteria: (item: T, index: Number) -> Boolean): Array<T>

Iterates over an array and applies an expression that returns matching values.

The expression must return `true` or `false`. If the expression returns `true` for a value or index
in the array, the value gets captured in the output array. If it returns `false` for a value or
index in the array, that item gets filtered out of the output. If there are no matches, the output
array will be empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The array to filter.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>Boolean expression that selects an <code>item</code> and/or <code>index</code>.</p></td></tr></tbody></table>

### Example

This example returns an array of values in the array that are greater than `2`.

#### Source

```DataWeave
[9,2,3,4,5] filter (value, index) -> (value > 2)
```

#### Output

```JSON
[9,3,4,5]
```

### Example

This example returns an array of all the users with age bigger or equal to 30. The script accesses
data of each element from within the lambda expression.

#### Source

```DataWeave
%dw 2.0
---
[{name: "Mariano", age: 37}, {name: "Shoki", age: 30}, {name: "Tomo", age: 25}, {name: "Ana", age: 29}]
          filter ((value, index) -> value.age >= 30)
```

#### Output

```JSON
[
   {
     "name": "Mariano",
     "age": 37
   },
   {
     "name": "Shoki",
     "age": 30
   }
]
```

### Example

This example returns an array of all items found at an index (`$$`) greater than `1` where the value
of the element is less than `5`. Notice that it is using anonymous parameters as selectors instead
of using named parameters in an anonymous function.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[9, 2, 3, 4, 5] filter (($$ > 1) and ($ < 5))
```

#### Output

```JSON
[3,4]
```

### Example

This example reads a JSON array that contains objects with `user` and `error` keys, and uses the
`filter` function to return only the objects in which the value of the `error` key is `null`.

#### Source

```DataWeave
%dw 2.0
output application/json

var users = [
   {
      "user": {
         "name": "123",
         "lastName": "Smith"
      },
      "error": "That name doesn't exists"
   },
   {
      "user": {
         "name": "John",
         "lastName": "Johnson"
      },
      "error": null
   }
]
---
users filter ((item, index) -> item.error == null)
```

#### Output

```JSON
[
  {
    "user": {
      "name": "John",
      "lastName": "Johnson"
    },
    "error": null
  }
]
```

### Example

This example reads a JSON array and uses the `filter` function to extract the phone numbers that are
active.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
    id: payload.Id,
    markCode: payload.marketCode,
    languageCode: payload.languageCode,
    username: payload.profile.base.username,
    phoneNumber: (payload.profile.base.phone filter ($.activeInd == "Y" and $.primaryInd== "Y")).number default []
}
```

#### Input

```JSON
{
  "Id": "1184001100000000517",
  "marketCode": "US",
  "languageCode": "en-US",
  "profile": {
  "base": {
     "username": "TheMule",
     "activeInd": "R",
     "phone": [
       {
          "activeInd": "Y",
          "type": "mobile",
          "primaryInd": "Y",
          "number": "230678123"
       },
       {
         "activeInd": "N",
         "type": "mobile",
         "primaryInd": "N",
         "number": ""
       },
       {
          "activeInd": "Y",
          "type": "mobile",
          "primaryInd": "Y",
          "number": "154896523"
       }
      ]
    }
  }
 }
```

#### Output

```JSON
{
  "id": "1184001100000000517",
  "markCode": "US",
  "languageCode": "en-US",
  "username": "TheMule",
  "phoneNumber": [
    "230678123"
    "154896523"
  ]
}
```

## filter(@StreamCapable text: String, criteria: (character: String, index: Number) -> Boolean): String

Iterates over a string and applies an expression that returns matching values.

The expression must return `true` or `false`. If the expression returns `true` for a character or
index in the array, the character gets captured in the output string. If it returns `false` for a
character or index in the array, that character gets filtered out of the output. If there are no
matches, the output string will be empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The text to filter.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The criteria to use.</p></td></tr></tbody></table>

### Example

This example shows how `filter` can be used to remove all characters in odd positions.

#### Source

```DataWeave
%dw 2.0
output application/json
---
"hello world" filter ($$ mod 2) == 0
```

#### Output

```Json
"hlowrd"
```

## filter(@StreamCapable value: Null, criteria: (item: Nothing, index: Nothing) -> Any): Null

Helper function that enables `filter` to work with a `null` value.

<!-- document id=f3bf958deecd44670a25bc045b47c9bd981996a7e0451c137a692504a14ba41b url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-filter.md -->

---
product: DataWeave
version: 2.12
---

# filter

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## filter<T>(@StreamCapable items: Array<T>, criteria: (item: T, index: Number) -> Boolean): Array<T>

Iterates over an array and applies an expression that returns matching values.

The expression must return `true` or `false`. If the expression returns `true` for a value or index
in the array, the value gets captured in the output array. If it returns `false` for a value or
index in the array, that item gets filtered out of the output. If there are no matches, the output
array will be empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The array to filter.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>Boolean expression that selects an <code>item</code> and/or <code>index</code>.</p></td></tr></tbody></table>

### Example

This example returns an array of values in the array that are greater than `2`.

#### Source

```DataWeave
[9,2,3,4,5] filter (value, index) -> (value > 2)
```

#### Output

```JSON
[9,3,4,5]
```

### Example

This example returns an array of all the users with age bigger or equal to 30. The script accesses
data of each element from within the lambda expression.

#### Source

```DataWeave
%dw 2.0
---
[{name: "Mariano", age: 37}, {name: "Shoki", age: 30}, {name: "Tomo", age: 25}, {name: "Ana", age: 29}]
          filter ((value, index) -> value.age >= 30)
```

#### Output

```JSON
[
   {
     "name": "Mariano",
     "age": 37
   },
   {
     "name": "Shoki",
     "age": 30
   }
]
```

### Example

This example returns an array of all items found at an index (`$$`) greater than `1` where the value
of the element is less than `5`. Notice that it is using anonymous parameters as selectors instead
of using named parameters in an anonymous function.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[9, 2, 3, 4, 5] filter (($$ > 1) and ($ < 5))
```

#### Output

```JSON
[3,4]
```

### Example

This example reads a JSON array that contains objects with `user` and `error` keys, and uses the
`filter` function to return only the objects in which the value of the `error` key is `null`.

#### Source

```DataWeave
%dw 2.0
output application/json

var users = [
   {
      "user": {
         "name": "123",
         "lastName": "Smith"
      },
      "error": "That name doesn't exists"
   },
   {
      "user": {
         "name": "John",
         "lastName": "Johnson"
      },
      "error": null
   }
]
---
users filter ((item, index) -> item.error == null)
```

#### Output

```JSON
[
  {
    "user": {
      "name": "John",
      "lastName": "Johnson"
    },
    "error": null
  }
]
```

### Example

This example reads a JSON array and uses the `filter` function to extract the phone numbers that are
active.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
    id: payload.Id,
    markCode: payload.marketCode,
    languageCode: payload.languageCode,
    username: payload.profile.base.username,
    phoneNumber: (payload.profile.base.phone filter ($.activeInd == "Y" and $.primaryInd== "Y")).number default []
}
```

#### Input

```JSON
{
  "Id": "1184001100000000517",
  "marketCode": "US",
  "languageCode": "en-US",
  "profile": {
  "base": {
     "username": "TheMule",
     "activeInd": "R",
     "phone": [
       {
          "activeInd": "Y",
          "type": "mobile",
          "primaryInd": "Y",
          "number": "230678123"
       },
       {
         "activeInd": "N",
         "type": "mobile",
         "primaryInd": "N",
         "number": ""
       },
       {
          "activeInd": "Y",
          "type": "mobile",
          "primaryInd": "Y",
          "number": "154896523"
       }
      ]
    }
  }
 }
```

#### Output

```JSON
{
  "id": "1184001100000000517",
  "markCode": "US",
  "languageCode": "en-US",
  "username": "TheMule",
  "phoneNumber": [
    "230678123"
    "154896523"
  ]
}
```

## filter(@StreamCapable text: String, criteria: (character: String, index: Number) -> Boolean): String

Iterates over a string and applies an expression that returns matching values.

The expression must return `true` or `false`. If the expression returns `true` for a character or
index in the array, the character gets captured in the output string. If it returns `false` for a
character or index in the array, that character gets filtered out of the output. If there are no
matches, the output string will be empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The text to filter.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The criteria to use.</p></td></tr></tbody></table>

### Example

This example shows how `filter` can be used to remove all characters in odd positions.

#### Source

```DataWeave
%dw 2.0
output application/json
---
"hello world" filter ($$ mod 2) == 0
```

#### Output

```Json
"hlowrd"
```

## filter(@StreamCapable value: Null, criteria: (item: Nothing, index: Nothing) -> Any): Null

Helper function that enables `filter` to work with a `null` value.

<!-- document id=e72bbf4661508de5ca5561aef22fdaf5fe48bb513bb84f28aae2566cb8c38e10 url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-filter.md -->

---
product: DataWeave
version: 2.3
---

# filter

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## filter(Array<T>, (item: T, index: Number) -> Boolean): Array<T>

Iterates over an array and applies an expression that returns matching values.

The expression must return `true` or `false`. If the expression returns `true` for a value or index
in the array, the value gets captured in the output array. If it returns `false` for a value or
index in the array, that item gets filtered out of the output. If there are no matches, the output
array will be empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The array to filter.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>Boolean expression that selects an <code>item</code> and/or <code>index</code>.</p></td></tr></tbody></table>

### Example

This example returns an array of values in the array that are greater than `2`.

#### Source

```DataWeave
[9,2,3,4,5] filter (value, index) -> (value > 2)
```

#### Output

```JSON
[9,3,4,5]
```

### Example

This example returns an array of all values found at an index greater than `2`.

#### Source

```DataWeave
[9,2,3,4,5] filter ((value, index) -> (index > 2))
```

#### Output

```JSON
[4,5]
```

### Example

This example returns an array of all items found at an index (`$$`) greater than `1` where the value
of the element is less than `5`. Notice that it is using anonymous parameters as selectors instead
of using named parameters in an anonymous function.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[9, 2, 3, 4, 5] filter (($$ > 1) and ($ < 5))
```

#### Output

```JSON
[3,4]
```

### Example

This example reads a JSON array that contains objects with `user` and `error` keys, and uses the
`filter` function to return only the objects in which the value of the `error` key is `null`.

#### Source

```DataWeave
%dw 2.0
output application/json

var users = [
   {
      "user": {
         "name": "123",
         "lastName": "Smith"
      },
      "error": "That name doesn't exists"
   },
   {
      "user": {
         "name": "John",
         "lastName": "Johnson"
      },
      "error": null
   }
]
---
users filter ((item, index) -> item.error == null)
```

#### Output

```JSON
[
  {
    "user": {
      "name": "John",
      "lastName": "Johnson"
    },
    "error": null
  }
]
```

### Example

This example reads a JSON array and uses the `filter` function to extract the phone numbers that are
active.

#### Input

```JSON
{
  "Id": "1184001100000000517",
  "marketCode": "US",
  "languageCode": "en-US",
  "profile": {
  "base": {
     "username": "TheMule",
     "activeInd": "R",
     "phone": [
       {
          "activeInd": "Y",
          "type": "mobile",
          "primaryInd": "Y",
          "number": "230678123"
       },
       {
         "activeInd": "N",
         "type": "mobile",
         "primaryInd": "N",
         "number": ""
       },
       {
          "activeInd": "Y",
          "type": "mobile",
          "primaryInd": "Y",
          "number": "154896523"
       }

      ]
    }
  }
 }
```

#### DataWeave Script

```DataWeave
%dw 2.0
output application/json
---
{
    id: payload.Id,
    markCode: payload.marketCode,
    languageCode: payload.languageCode,
    username: payload.profile.base.username,
    phoneNumber: (payload.profile.base.phone filter ($.activeInd == "Y" and $.primaryInd== "Y")).number default []
}
```

#### Output

```JSON
{
  "id": "1184001100000000517",
  "markCode": "US",
  "languageCode": "en-US",
  "username": "TheMule",
  "phoneNumber": [
  "230678123"
  "154896523"
]
}
```

## filter(Null, (item: Nothing, index: Nothing) -> Boolean): Null

Helper function that enables `filter` to work with a `null` value.

<!-- document id=eb390d153213c18d327c7be0331074e5c2b593beca318e549960f0257a70bc14 url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-filter.md -->

---
product: DataWeave
version: 2.4
---

# filter

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## filter<T>(@StreamCapable items: Array<T>, criteria: (item: T, index: Number) -> Boolean): Array<T>

Iterates over an array and applies an expression that returns matching values.

The expression must return `true` or `false`. If the expression returns `true` for a value or index
in the array, the value gets captured in the output array. If it returns `false` for a value or
index in the array, that item gets filtered out of the output. If there are no matches, the output
array will be empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The array to filter.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>Boolean expression that selects an <code>item</code> and/or <code>index</code>.</p></td></tr></tbody></table>

### Example

This example returns an array of values in the array that are greater than `2`.

#### Source

```DataWeave
[9,2,3,4,5] filter (value, index) -> (value > 2)
```

#### Output

```JSON
[9,3,4,5]
```

### Example

This example returns an array of all the users with age bigger or equal to 30. The script accesses
data of each element from within the lambda expression.

#### Source

```DataWeave
%dw 2.0
---
[{name: "Mariano", age: 37}, {name: "Shoki", age: 30}, {name: "Tomo", age: 25}, {name: "Ana", age: 29}]
          filter ((value, index) -> value.age >= 30)
```

#### Output

```JSON
[
   {
     "name": "Mariano",
     "age": 37
   },
   {
     "name": "Shoki",
     "age": 30
   }
]
```

### Example

This example returns an array of all items found at an index (`$$`) greater than `1` where the value
of the element is less than `5`. Notice that it is using anonymous parameters as selectors instead
of using named parameters in an anonymous function.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[9, 2, 3, 4, 5] filter (($$ > 1) and ($ < 5))
```

#### Output

```JSON
[3,4]
```

### Example

This example reads a JSON array that contains objects with `user` and `error` keys, and uses the
`filter` function to return only the objects in which the value of the `error` key is `null`.

#### Source

```DataWeave
%dw 2.0
output application/json

var users = [
   {
      "user": {
         "name": "123",
         "lastName": "Smith"
      },
      "error": "That name doesn't exists"
   },
   {
      "user": {
         "name": "John",
         "lastName": "Johnson"
      },
      "error": null
   }
]
---
users filter ((item, index) -> item.error == null)
```

#### Output

```JSON
[
  {
    "user": {
      "name": "John",
      "lastName": "Johnson"
    },
    "error": null
  }
]
```

### Example

This example reads a JSON array and uses the `filter` function to extract the phone numbers that are
active.

#### Input

```JSON
{
  "Id": "1184001100000000517",
  "marketCode": "US",
  "languageCode": "en-US",
  "profile": {
  "base": {
     "username": "TheMule",
     "activeInd": "R",
     "phone": [
       {
          "activeInd": "Y",
          "type": "mobile",
          "primaryInd": "Y",
          "number": "230678123"
       },
       {
         "activeInd": "N",
         "type": "mobile",
         "primaryInd": "N",
         "number": ""
       },
       {
          "activeInd": "Y",
          "type": "mobile",
          "primaryInd": "Y",
          "number": "154896523"
       }

      ]
    }
  }
 }
```

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
    id: payload.Id,
    markCode: payload.marketCode,
    languageCode: payload.languageCode,
    username: payload.profile.base.username,
    phoneNumber: (payload.profile.base.phone filter ($.activeInd == "Y" and $.primaryInd== "Y")).number default []
}
```

#### Output

```JSON
{
  "id": "1184001100000000517",
  "markCode": "US",
  "languageCode": "en-US",
  "username": "TheMule",
  "phoneNumber": [
    "230678123"
    "154896523"
  ]
}
```

## filter(@StreamCapable text: String, criteria: (character: String, index: Number) -> Boolean): String

Iterates over a string and applies an expression that returns matching values.

The expression must return `true` or `false`. If the expression returns `true` for a character or
index in the array, the character gets captured in the output string. If it returns `false` for a
character or index in the array, that character gets filtered out of the output. If there are no
matches, the output string will be empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>text</p></td><td><p>The text to filter.</p></td></tr><tr><td><p>criteria</p></td><td><p>The criteria to use.</p></td></tr></tbody></table>

### Example

This example shows how `filter` can be used to remove all characters in odd positions.

#### Source

```DataWeave
%dw 2.0
output application/json
---
"hello world" filter ($$ mod 2) == 0
```

#### Output

```Json
"hlowrd"
```

## filter(@StreamCapable value: Null, criteria: (item: Nothing, index: Nothing) -> Any): Null

Helper function that enables `filter` to work with a `null` value.

<!-- document id=8cd837e0a2b90cca47860e1c5daa3746e812a3d02e4105bb753a19140a954a93 url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-filter.md -->

---
product: DataWeave
version: 2.6
---

# filter

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## filter<T>(@StreamCapable items: Array<T>, criteria: (item: T, index: Number) -> Boolean): Array<T>

Iterates over an array and applies an expression that returns matching values.

The expression must return `true` or `false`. If the expression returns `true` for a value or index
in the array, the value gets captured in the output array. If it returns `false` for a value or
index in the array, that item gets filtered out of the output. If there are no matches, the output
array will be empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The array to filter.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>Boolean expression that selects an <code>item</code> and/or <code>index</code>.</p></td></tr></tbody></table>

### Example

This example returns an array of values in the array that are greater than `2`.

#### Source

```DataWeave
[9,2,3,4,5] filter (value, index) -> (value > 2)
```

#### Output

```JSON
[9,3,4,5]
```

### Example

This example returns an array of all the users with age bigger or equal to 30. The script accesses
data of each element from within the lambda expression.

#### Source

```DataWeave
%dw 2.0
---
[{name: "Mariano", age: 37}, {name: "Shoki", age: 30}, {name: "Tomo", age: 25}, {name: "Ana", age: 29}]
          filter ((value, index) -> value.age >= 30)
```

#### Output

```JSON
[
   {
     "name": "Mariano",
     "age": 37
   },
   {
     "name": "Shoki",
     "age": 30
   }
]
```

### Example

This example returns an array of all items found at an index (`$$`) greater than `1` where the value
of the element is less than `5`. Notice that it is using anonymous parameters as selectors instead
of using named parameters in an anonymous function.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[9, 2, 3, 4, 5] filter (($$ > 1) and ($ < 5))
```

#### Output

```JSON
[3,4]
```

### Example

This example reads a JSON array that contains objects with `user` and `error` keys, and uses the
`filter` function to return only the objects in which the value of the `error` key is `null`.

#### Source

```DataWeave
%dw 2.0
output application/json

var users = [
   {
      "user": {
         "name": "123",
         "lastName": "Smith"
      },
      "error": "That name doesn't exists"
   },
   {
      "user": {
         "name": "John",
         "lastName": "Johnson"
      },
      "error": null
   }
]
---
users filter ((item, index) -> item.error == null)
```

#### Output

```JSON
[
  {
    "user": {
      "name": "John",
      "lastName": "Johnson"
    },
    "error": null
  }
]
```

### Example

This example reads a JSON array and uses the `filter` function to extract the phone numbers that are
active.

#### Input

```JSON
{
  "Id": "1184001100000000517",
  "marketCode": "US",
  "languageCode": "en-US",
  "profile": {
  "base": {
     "username": "TheMule",
     "activeInd": "R",
     "phone": [
       {
          "activeInd": "Y",
          "type": "mobile",
          "primaryInd": "Y",
          "number": "230678123"
       },
       {
         "activeInd": "N",
         "type": "mobile",
         "primaryInd": "N",
         "number": ""
       },
       {
          "activeInd": "Y",
          "type": "mobile",
          "primaryInd": "Y",
          "number": "154896523"
       }
      ]
    }
  }
 }
```

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
    id: payload.Id,
    markCode: payload.marketCode,
    languageCode: payload.languageCode,
    username: payload.profile.base.username,
    phoneNumber: (payload.profile.base.phone filter ($.activeInd == "Y" and $.primaryInd== "Y")).number default []
}
```

#### Output

```JSON
{
  "id": "1184001100000000517",
  "markCode": "US",
  "languageCode": "en-US",
  "username": "TheMule",
  "phoneNumber": [
    "230678123"
    "154896523"
  ]
}
```

## filter(@StreamCapable text: String, criteria: (character: String, index: Number) -> Boolean): String

Iterates over a string and applies an expression that returns matching values.

The expression must return `true` or `false`. If the expression returns `true` for a character or
index in the array, the character gets captured in the output string. If it returns `false` for a
character or index in the array, that character gets filtered out of the output. If there are no
matches, the output string will be empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The text to filter.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The criteria to use.</p></td></tr></tbody></table>

### Example

This example shows how `filter` can be used to remove all characters in odd positions.

#### Source

```DataWeave
%dw 2.0
output application/json
---
"hello world" filter ($$ mod 2) == 0
```

#### Output

```Json
"hlowrd"
```

## filter(@StreamCapable value: Null, criteria: (item: Nothing, index: Nothing) -> Any): Null

Helper function that enables `filter` to work with a `null` value.

<!-- document id=bcf34a18bdb37a145a4f0f9f24e215d7409f96ae1cd6a042c8cd4ecb0b0f107a url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-filter.md -->

---
product: DataWeave
version: 2.9
---

# filter

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## filter<T>(@StreamCapable items: Array<T>, criteria: (item: T, index: Number) -> Boolean): Array<T>

Iterates over an array and applies an expression that returns matching values.

The expression must return `true` or `false`. If the expression returns `true` for a value or index
in the array, the value gets captured in the output array. If it returns `false` for a value or
index in the array, that item gets filtered out of the output. If there are no matches, the output
array will be empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The array to filter.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>Boolean expression that selects an <code>item</code> and/or <code>index</code>.</p></td></tr></tbody></table>

### Example

This example returns an array of values in the array that are greater than `2`.

#### Source

```DataWeave
[9,2,3,4,5] filter (value, index) -> (value > 2)
```

#### Output

```JSON
[9,3,4,5]
```

### Example

This example returns an array of all the users with age bigger or equal to 30. The script accesses
data of each element from within the lambda expression.

#### Source

```DataWeave
%dw 2.0
---
[{name: "Mariano", age: 37}, {name: "Shoki", age: 30}, {name: "Tomo", age: 25}, {name: "Ana", age: 29}]
          filter ((value, index) -> value.age >= 30)
```

#### Output

```JSON
[
   {
     "name": "Mariano",
     "age": 37
   },
   {
     "name": "Shoki",
     "age": 30
   }
]
```

### Example

This example returns an array of all items found at an index (`$$`) greater than `1` where the value
of the element is less than `5`. Notice that it is using anonymous parameters as selectors instead
of using named parameters in an anonymous function.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[9, 2, 3, 4, 5] filter (($$ > 1) and ($ < 5))
```

#### Output

```JSON
[3,4]
```

### Example

This example reads a JSON array that contains objects with `user` and `error` keys, and uses the
`filter` function to return only the objects in which the value of the `error` key is `null`.

#### Source

```DataWeave
%dw 2.0
output application/json

var users = [
   {
      "user": {
         "name": "123",
         "lastName": "Smith"
      },
      "error": "That name doesn't exists"
   },
   {
      "user": {
         "name": "John",
         "lastName": "Johnson"
      },
      "error": null
   }
]
---
users filter ((item, index) -> item.error == null)
```

#### Output

```JSON
[
  {
    "user": {
      "name": "John",
      "lastName": "Johnson"
    },
    "error": null
  }
]
```

### Example

This example reads a JSON array and uses the `filter` function to extract the phone numbers that are
active.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
    id: payload.Id,
    markCode: payload.marketCode,
    languageCode: payload.languageCode,
    username: payload.profile.base.username,
    phoneNumber: (payload.profile.base.phone filter ($.activeInd == "Y" and $.primaryInd== "Y")).number default []
}
```

#### Input

```JSON
{
  "Id": "1184001100000000517",
  "marketCode": "US",
  "languageCode": "en-US",
  "profile": {
  "base": {
     "username": "TheMule",
     "activeInd": "R",
     "phone": [
       {
          "activeInd": "Y",
          "type": "mobile",
          "primaryInd": "Y",
          "number": "230678123"
       },
       {
         "activeInd": "N",
         "type": "mobile",
         "primaryInd": "N",
         "number": ""
       },
       {
          "activeInd": "Y",
          "type": "mobile",
          "primaryInd": "Y",
          "number": "154896523"
       }
      ]
    }
  }
 }
```

#### Output

```JSON
{
  "id": "1184001100000000517",
  "markCode": "US",
  "languageCode": "en-US",
  "username": "TheMule",
  "phoneNumber": [
    "230678123"
    "154896523"
  ]
}
```

## filter(@StreamCapable text: String, criteria: (character: String, index: Number) -> Boolean): String

Iterates over a string and applies an expression that returns matching values.

The expression must return `true` or `false`. If the expression returns `true` for a character or
index in the array, the character gets captured in the output string. If it returns `false` for a
character or index in the array, that character gets filtered out of the output. If there are no
matches, the output string will be empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The text to filter.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The criteria to use.</p></td></tr></tbody></table>

### Example

This example shows how `filter` can be used to remove all characters in odd positions.

#### Source

```DataWeave
%dw 2.0
output application/json
---
"hello world" filter ($$ mod 2) == 0
```

#### Output

```Json
"hlowrd"
```

## filter(@StreamCapable value: Null, criteria: (item: Nothing, index: Nothing) -> Any): Null

Helper function that enables `filter` to work with a `null` value.

<!-- document id=64eaed328711bf2beb55cb43a54e78454fe8dc74833e6ebd08fcab7ac66169ad url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-filter.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# filter

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## filter<T>(@StreamCapable items: Array<T>, criteria: (item: T, index: Number) -> Boolean): Array<T>

Iterates over an array and applies an expression that returns matching values.

The expression must return `true` or `false`. If the expression returns `true` for a value or index
in the array, the value gets captured in the output array. If it returns `false` for a value or
index in the array, that item gets filtered out of the output. If there are no matches, the output
array will be empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The array to filter.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>Boolean expression that selects an <code>item</code> and/or <code>index</code>.</p></td></tr></tbody></table>

### Example

This example returns an array of values in the array that are greater than `2`.

#### Source

```DataWeave
[9,2,3,4,5] filter (value, index) -> (value > 2)
```

#### Output

```JSON
[9,3,4,5]
```

### Example

This example returns an array of all the users with age bigger or equal to 30. The script accesses
data of each element from within the lambda expression.

#### Source

```DataWeave
%dw 2.0
---
[{name: "Mariano", age: 37}, {name: "Shoki", age: 30}, {name: "Tomo", age: 25}, {name: "Ana", age: 29}]
          filter ((value, index) -> value.age >= 30)
```

#### Output

```JSON
[
   {
     "name": "Mariano",
     "age": 37
   },
   {
     "name": "Shoki",
     "age": 30
   }
]
```

### Example

This example returns an array of all items found at an index (`$$`) greater than `1` where the value
of the element is less than `5`. Notice that it is using anonymous parameters as selectors instead
of using named parameters in an anonymous function.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[9, 2, 3, 4, 5] filter (($$ > 1) and ($ < 5))
```

#### Output

```JSON
[3,4]
```

### Example

This example reads a JSON array that contains objects with `user` and `error` keys, and uses the
`filter` function to return only the objects in which the value of the `error` key is `null`.

#### Source

```DataWeave
%dw 2.0
output application/json

var users = [
   {
      "user": {
         "name": "123",
         "lastName": "Smith"
      },
      "error": "That name doesn't exists"
   },
   {
      "user": {
         "name": "John",
         "lastName": "Johnson"
      },
      "error": null
   }
]
---
users filter ((item, index) -> item.error == null)
```

#### Output

```JSON
[
  {
    "user": {
      "name": "John",
      "lastName": "Johnson"
    },
    "error": null
  }
]
```

### Example

This example reads a JSON array and uses the `filter` function to extract the phone numbers that are
active.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
    id: payload.Id,
    markCode: payload.marketCode,
    languageCode: payload.languageCode,
    username: payload.profile.base.username,
    phoneNumber: (payload.profile.base.phone filter ($.activeInd == "Y" and $.primaryInd== "Y")).number default []
}
```

#### Input

```JSON
{
  "Id": "1184001100000000517",
  "marketCode": "US",
  "languageCode": "en-US",
  "profile": {
  "base": {
     "username": "TheMule",
     "activeInd": "R",
     "phone": [
       {
          "activeInd": "Y",
          "type": "mobile",
          "primaryInd": "Y",
          "number": "230678123"
       },
       {
         "activeInd": "N",
         "type": "mobile",
         "primaryInd": "N",
         "number": ""
       },
       {
          "activeInd": "Y",
          "type": "mobile",
          "primaryInd": "Y",
          "number": "154896523"
       }
      ]
    }
  }
 }
```

#### Output

```JSON
{
  "id": "1184001100000000517",
  "markCode": "US",
  "languageCode": "en-US",
  "username": "TheMule",
  "phoneNumber": [
    "230678123"
    "154896523"
  ]
}
```

## filter(@StreamCapable text: String, criteria: (character: String, index: Number) -> Boolean): String

Iterates over a string and applies an expression that returns matching values.

The expression must return `true` or `false`. If the expression returns `true` for a character or
index in the array, the character gets captured in the output string. If it returns `false` for a
character or index in the array, that character gets filtered out of the output. If there are no
matches, the output string will be empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The text to filter.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The criteria to use.</p></td></tr></tbody></table>

### Example

This example shows how `filter` can be used to remove all characters in odd positions.

#### Source

```DataWeave
%dw 2.0
output application/json
---
"hello world" filter ($$ mod 2) == 0
```

#### Output

```Json
"hlowrd"
```

## filter(@StreamCapable value: Null, criteria: (item: Nothing, index: Nothing) -> Any): Null

Helper function that enables `filter` to work with a `null` value.

<!-- document id=800dac2876e8651cf2314db8b5b64b309b411cfaa576f9128da232b0bcc7e550 url=/mulesoft/current/en-us/dataweave/2.11/dw-tree-functions-filterarrayleafs.md -->

---
product: DataWeave
version: 2.11
---

# filterArrayLeafs

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## filterArrayLeafs(value: Any, criteria: (value: Any, path: Path) -> Boolean): Any

Applies a filtering expression to leaf or `Path` values of an array.

The leaf values in the array must be `SimpleType` or `Null` values. See
[Core Types](https://docs.mulesoft.com/dataweave/latest/dw-core-types) for descriptions of the
types.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>An input value of <code>Any</code> type.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>Boolean expression to apply to <code>SimpleType</code> or <code>Null</code> leaf values of all arrays in the input <code>value</code>. If the result is <code>true</code>, the array retains the leaf value. If not, the function removes the leaf value from the output.</p></td></tr></tbody></table>

### Example

This example shows how `filterArrayLeafs` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
var myArray = [1, {name: ["", true], test: 213}, "123", null]
output application/json
---
{
   a: myArray filterArrayLeafs ((value, path) ->
        !(value is Null or value is String)),
   b:  myArray filterArrayLeafs ((value, path) ->
        (value is Null or value == 1)),
   c: { a : [1,2] } filterArrayLeafs ((value, path) ->
        (value is Null or value == 1)),
   d: myArray filterArrayLeafs ((value, path) ->
        !isArrayType(path))
}
```

#### Output

```Json
{
  "a": [
    1,
    {
      "name": [
        true
      ],
      "test": 213
    }
  ],
  "b": [
    1,
    {
      "name": [

      ],
      "test": 213
    },
    null
  ],
  "c": {
    "a": [
     1
    ]
  },
  "d": [
    {
      "name": [

      ],
      "test": 213
    }
  ]
}
```

<!-- document id=ca5284824733ed5df614d73d4c36659847588927f1346b799b28c40e129fc154 url=/mulesoft/current/en-us/dataweave/2.12/dw-tree-functions-filterarrayleafs.md -->

---
product: DataWeave
version: 2.12
---

# filterArrayLeafs

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## filterArrayLeafs(value: Any, criteria: (value: Any, path: Path) -> Boolean): Any

Applies a filtering expression to leaf or `Path` values of an array.

The leaf values in the array must be `SimpleType` or `Null` values. See
[Core Types](https://docs.mulesoft.com/dataweave/latest/dw-core-types) for descriptions of the
types.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>An input value of <code>Any</code> type.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>Boolean expression to apply to <code>SimpleType</code> or <code>Null</code> leaf values of all arrays in the input <code>value</code>. If the result is <code>true</code>, the array retains the leaf value. If not, the function removes the leaf value from the output.</p></td></tr></tbody></table>

### Example

This example shows how `filterArrayLeafs` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
var myArray = [1, {name: ["", true], test: 213}, "123", null]
output application/json
---
{
   a: myArray filterArrayLeafs ((value, path) ->
        !(value is Null or value is String)),
   b:  myArray filterArrayLeafs ((value, path) ->
        (value is Null or value == 1)),
   c: { a : [1,2] } filterArrayLeafs ((value, path) ->
        (value is Null or value == 1)),
   d: myArray filterArrayLeafs ((value, path) ->
        !isArrayType(path))
}
```

#### Output

```Json
{
  "a": [
    1,
    {
      "name": [
        true
      ],
      "test": 213
    }
  ],
  "b": [
    1,
    {
      "name": [

      ],
      "test": 213
    },
    null
  ],
  "c": {
    "a": [
     1
    ]
  },
  "d": [
    {
      "name": [

      ],
      "test": 213
    }
  ]
}
```

<!-- document id=1bbbfbfe457171c1cd1a82ab2798e098553a0ed65b0fb64426580d49e7714525 url=/mulesoft/current/en-us/dataweave/2.4/dw-tree-functions-filterarrayleafs.md -->

---
product: DataWeave
version: 2.4
---

# filterArrayLeafs

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## filterArrayLeafs(value: Any, criteria: (value: Any, path: Path) -> Boolean): Any

Applies a filtering expression to leaf or `Path` values of an array.

The leaf values in the array must be `SimpleType` or `Null` values. See
[Core Types](https://docs.mulesoft.com/dataweave/latest/dw-core-types) for descriptions of the
types.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>An input value of <code>Any</code> type.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>Boolean expression to apply to <code>SimpleType</code> or <code>Null</code> leaf values of all arrays in the input <code>value</code>. If the result is <code>true</code>, the array retains the leaf value. If not, the function removes the leaf value from the output.</p></td></tr></tbody></table>

### Example

This example shows how `filterArrayLeafs` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
var myArray = [1, {name: ["", true], test: 213}, "123", null]
output application/json
---
{
   a: myArray filterArrayLeafs ((value, path) ->
        !(value is Null or value is String)),
   b:  myArray filterArrayLeafs ((value, path) ->
        (value is Null or value == 1)),
   c: { a : [1,2] } filterArrayLeafs ((value, path) ->
        (value is Null or value == 1)),
   d: myArray filterArrayLeafs ((value, path) ->
        !isArrayType(path))
}
```

#### Output

```Json
{
  "a": [
    1,
    {
      "name": [
        true
      ],
      "test": 213
    }
  ],
  "b": [
    1,
    {
      "name": [

      ],
      "test": 213
    },
    null
  ],
  "c": {
    "a": [
     1
    ]
  },
  "d": [
    {
      "name": [

      ],
      "test": 213
    }
  ]
}
```

<!-- document id=c823f83dda7bdd61803133e810939f7320e4896ebcbaf42eea089bd23c8fe09c url=/mulesoft/current/en-us/dataweave/2.6/dw-tree-functions-filterarrayleafs.md -->

---
product: DataWeave
version: 2.6
---

# filterArrayLeafs

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## filterArrayLeafs(value: Any, criteria: (value: Any, path: Path) -> Boolean): Any

Applies a filtering expression to leaf or `Path` values of an array.

The leaf values in the array must be `SimpleType` or `Null` values. See
[Core Types](https://docs.mulesoft.com/dataweave/latest/dw-core-types) for descriptions of the
types.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>An input value of <code>Any</code> type.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>Boolean expression to apply to <code>SimpleType</code> or <code>Null</code> leaf values of all arrays in the input <code>value</code>. If the result is <code>true</code>, the array retains the leaf value. If not, the function removes the leaf value from the output.</p></td></tr></tbody></table>

### Example

This example shows how `filterArrayLeafs` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
var myArray = [1, {name: ["", true], test: 213}, "123", null]
output application/json
---
{
   a: myArray filterArrayLeafs ((value, path) ->
        !(value is Null or value is String)),
   b:  myArray filterArrayLeafs ((value, path) ->
        (value is Null or value == 1)),
   c: { a : [1,2] } filterArrayLeafs ((value, path) ->
        (value is Null or value == 1)),
   d: myArray filterArrayLeafs ((value, path) ->
        !isArrayType(path))
}
```

#### Output

```Json
{
  "a": [
    1,
    {
      "name": [
        true
      ],
      "test": 213
    }
  ],
  "b": [
    1,
    {
      "name": [

      ],
      "test": 213
    },
    null
  ],
  "c": {
    "a": [
     1
    ]
  },
  "d": [
    {
      "name": [

      ],
      "test": 213
    }
  ]
}
```

<!-- document id=5f09d2cfe41118039fbf9cbb5d14dc8c518f6b3cc1bca4f387d3b8be96a24a70 url=/mulesoft/current/en-us/dataweave/2.9/dw-tree-functions-filterarrayleafs.md -->

---
product: DataWeave
version: 2.9
---

# filterArrayLeafs

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## filterArrayLeafs(value: Any, criteria: (value: Any, path: Path) -> Boolean): Any

Applies a filtering expression to leaf or `Path` values of an array.

The leaf values in the array must be `SimpleType` or `Null` values. See
[Core Types](https://docs.mulesoft.com/dataweave/latest/dw-core-types) for descriptions of the
types.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>An input value of <code>Any</code> type.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>Boolean expression to apply to <code>SimpleType</code> or <code>Null</code> leaf values of all arrays in the input <code>value</code>. If the result is <code>true</code>, the array retains the leaf value. If not, the function removes the leaf value from the output.</p></td></tr></tbody></table>

### Example

This example shows how `filterArrayLeafs` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
var myArray = [1, {name: ["", true], test: 213}, "123", null]
output application/json
---
{
   a: myArray filterArrayLeafs ((value, path) ->
        !(value is Null or value is String)),
   b:  myArray filterArrayLeafs ((value, path) ->
        (value is Null or value == 1)),
   c: { a : [1,2] } filterArrayLeafs ((value, path) ->
        (value is Null or value == 1)),
   d: myArray filterArrayLeafs ((value, path) ->
        !isArrayType(path))
}
```

#### Output

```Json
{
  "a": [
    1,
    {
      "name": [
        true
      ],
      "test": 213
    }
  ],
  "b": [
    1,
    {
      "name": [

      ],
      "test": 213
    },
    null
  ],
  "c": {
    "a": [
     1
    ]
  },
  "d": [
    {
      "name": [

      ],
      "test": 213
    }
  ]
}
```

<!-- document id=1b3022db2320ee0c3ec9e7e5ddd773cbd5a788943da25caf76b2e1b7c23cc637 url=/mulesoft/current/en-us/dataweave/latest/dw-tree-functions-filterarrayleafs.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# filterArrayLeafs

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## filterArrayLeafs(value: Any, criteria: (value: Any, path: Path) -> Boolean): Any

Applies a filtering expression to leaf or `Path` values of an array.

The leaf values in the array must be `SimpleType` or `Null` values. See
[Core Types](https://docs.mulesoft.com/dataweave/latest/dw-core-types) for descriptions of the
types.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>An input value of <code>Any</code> type.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>Boolean expression to apply to <code>SimpleType</code> or <code>Null</code> leaf values of all arrays in the input <code>value</code>. If the result is <code>true</code>, the array retains the leaf value. If not, the function removes the leaf value from the output.</p></td></tr></tbody></table>

### Example

This example shows how `filterArrayLeafs` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
var myArray = [1, {name: ["", true], test: 213}, "123", null]
output application/json
---
{
   a: myArray filterArrayLeafs ((value, path) ->
        !(value is Null or value is String)),
   b:  myArray filterArrayLeafs ((value, path) ->
        (value is Null or value == 1)),
   c: { a : [1,2] } filterArrayLeafs ((value, path) ->
        (value is Null or value == 1)),
   d: myArray filterArrayLeafs ((value, path) ->
        !isArrayType(path))
}
```

#### Output

```Json
{
  "a": [
    1,
    {
      "name": [
        true
      ],
      "test": 213
    }
  ],
  "b": [
    1,
    {
      "name": [

      ],
      "test": 213
    },
    null
  ],
  "c": {
    "a": [
     1
    ]
  },
  "d": [
    {
      "name": [

      ],
      "test": 213
    }
  ]
}
```

<!-- document id=b4ab6e82c53d0f0aadd3ee20f6b615f3034d40611e8285a19893bf670362341b url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-filterobject.md -->

---
product: DataWeave
version: 2.11
---

# filterObject

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## filterObject<K, V>(@StreamCapable value: { (K)?: V }, criteria: (value: V, key: K, index: Number) -> Boolean): { (K)?: V }

Iterates a list of key-value pairs in an object and applies an expression that returns only matching
objects, filtering out the rest from the output.

The expression must return `true` or `false`. If the expression returns `true` for a key, value, or
index of an object, the object gets captured in the output. If it returns `false` for any of them,
the object gets filtered out of the output. If there are no matches, the output array will be empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The source object to evaluate.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>Boolean expression that selects a <code>value</code>, <code>key</code>, or <code>index</code> of the object.</p></td></tr></tbody></table>

### Example

This example outputs an object if its value equals `"apple"`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{"a" : "apple", "b" : "banana"} filterObject ((value) -> value == "apple")
```

#### Output

```JSON
{ "a": "apple" }
```

### Example

This example only outputs an object if the key starts with "letter". The DataWeave `startsWith`
function returns `true` or `false`. Note that you can use the anonymous parameter for the key to
write the expression `((value, key) → key startsWith "letter")`: ($$ startsWith "letter")\`

#### Source

```DataWeave
%dw 2.0
output application/json
---
{"letter1": "a", "letter2": "b", "id": 1} filterObject ((value, key) -> key startsWith "letter")
```

#### Output

```JSON
{ "letter1": "a", "letter2": "b" }
```

### Example

This example only outputs an object if the index of the object in the array is less than 1, which is
always true of the first object. Note that you can use the anonymous parameter for the index to
write the expression `((value, key, index) → index < 1)`: `($$$ < 1)`

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "1": "a", "2": "b", "3": "c"} filterObject ((value, key, index) -> index < 1)
```

#### Output

```json
{ "1": "a" }
```

### Example

This example outputs an object that contains only the values that are not `null` in the input JSON
object.

#### Source

```DataWeave
%dw 2.0
output application/json
var myObject = {
    str1 : "String 1",
    str2 : "String 2",
    str3 : null,
    str4 : "String 4",
}
---
myObject filterObject $ != null
```

#### Output

```json
{
  "str1": "String 1",
  "str2": "String 2",
  "str4": "String 4"
}
```

## filterObject(value: Null, criteria: (value: Nothing, key: Nothing, index: Nothing) -> Any): Null

Helper function that enables `filterObject` to work with a `null` value.

<!-- document id=4c373a847158a1dff931708f135c0f04e48f15f960141ce643a537f41409777c url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-filterobject.md -->

---
product: DataWeave
version: 2.12
---

# filterObject

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## filterObject<K, V>(@StreamCapable value: { (K)?: V }, criteria: (value: V, key: K, index: Number) -> Boolean): { (K)?: V }

Iterates a list of key-value pairs in an object and applies an expression that returns only matching
objects, filtering out the rest from the output.

The expression must return `true` or `false`. If the expression returns `true` for a key, value, or
index of an object, the object gets captured in the output. If it returns `false` for any of them,
the object gets filtered out of the output. If there are no matches, the output array will be empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The source object to evaluate.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>Boolean expression that selects a <code>value</code>, <code>key</code>, or <code>index</code> of the object.</p></td></tr></tbody></table>

### Example

This example outputs an object if its value equals `"apple"`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{"a" : "apple", "b" : "banana"} filterObject ((value) -> value == "apple")
```

#### Output

```JSON
{ "a": "apple" }
```

### Example

This example only outputs an object if the key starts with "letter". The DataWeave `startsWith`
function returns `true` or `false`. Note that you can use the anonymous parameter for the key to
write the expression `((value, key) → key startsWith "letter")`: ($$ startsWith "letter")\`

#### Source

```DataWeave
%dw 2.0
output application/json
---
{"letter1": "a", "letter2": "b", "id": 1} filterObject ((value, key) -> key startsWith "letter")
```

#### Output

```JSON
{ "letter1": "a", "letter2": "b" }
```

### Example

This example only outputs an object if the index of the object in the array is less than 1, which is
always true of the first object. Note that you can use the anonymous parameter for the index to
write the expression `((value, key, index) → index < 1)`: `($$$ < 1)`

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "1": "a", "2": "b", "3": "c"} filterObject ((value, key, index) -> index < 1)
```

#### Output

```json
{ "1": "a" }
```

### Example

This example outputs an object that contains only the values that are not `null` in the input JSON
object.

#### Source

```DataWeave
%dw 2.0
output application/json
var myObject = {
    str1 : "String 1",
    str2 : "String 2",
    str3 : null,
    str4 : "String 4",
}
---
myObject filterObject $ != null
```

#### Output

```json
{
  "str1": "String 1",
  "str2": "String 2",
  "str4": "String 4"
}
```

## filterObject(value: Null, criteria: (value: Nothing, key: Nothing, index: Nothing) -> Any): Null

Helper function that enables `filterObject` to work with a `null` value.

<!-- document id=6bad60936de6f931a5882028c53bf155801cc2bead7cf724f4c8868365d1d8fa url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-filterobject.md -->

---
product: DataWeave
version: 2.3
---

# filterObject

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## filterObject({ (K)?: V }, (value: V, key: K, index: Number) -> Boolean): { (K)?: V }

Iterates a list of key-value pairs in an object and applies an expression that returns only matching
objects, filtering out the rest from the output.

The expression must return `true` or `false`. If the expression returns `true` for a key, value, or
index of an object, the object gets captured in the output. If it returns `false` for any of them,
the object gets filtered out of the output. If there are no matches, the output array will be empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The source object to evaluate.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>Boolean expression that selects a <code>value</code>, <code>key</code>, or <code>index</code> of the object.</p></td></tr></tbody></table>

### Example

This example outputs an object if its value equals `"apple"`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{"a" : "apple", "b" : "banana"} filterObject ((value) -> value == "apple")
```

#### Output

```JSON
{ "a": "apple" }
```

### Example

This example only outputs an object if the key starts with "letter". The DataWeave `startsWith`
function returns `true` or `false`. Note that you can use the anonymous parameter for the key to
write the expression `((value, key) → key startsWith "letter")`: ($$ startsWith "letter")\`

#### Source

```DataWeave
%dw 2.0
output application/json
---
{"letter1": "a", "letter2": "b", "id": 1} filterObject ((value, key) -> key startsWith "letter")
```

#### Output

```JSON
{ "letter1": "a", "letter2": "b" }
```

### Example

This example only outputs an object if the index of the object in the array is less than 1, which is
always true of the first object. Note that you can use the anonymous parameter for the index to
write the expression `((value, key, index) → index < 1)`: `($$$ < 1)`

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "1": "a", "2": "b", "3": "c"} filterObject ((value, key, index) -> index < 1)
```

#### Output

```json
{ "1": "a" }
```

### Example

This example outputs an object that contains only the values that are not `null` in the input JSON
object.

#### Source

```DataWeave
%dw 2.0
output application/json
var o = {
    str1 : "String 1",
    str2 : "String 2",
    str3 : null,
    str4 : "String 4",
}
---
o filterObject $ != null
```

#### Output

```json
{
  "str1": "String 1",
  "str2": "String 2",
  "str4": "String 4"
}
```

## filterObject(Null, (value: Nothing, key: Nothing, index: Nothing) -> Boolean): Null

Helper function that enables `filterObject` to work with a `null` value.

<!-- document id=d444c394b04dbd52867e1922eb218a190c527d043b56dddcd5fbd09c3d529c25 url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-filterobject.md -->

---
product: DataWeave
version: 2.4
---

# filterObject

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## filterObject<K, V>(@StreamCapable value: { (K)?: V }, criteria: (value: V, key: K, index: Number) -> Boolean): { (K)?: V }

Iterates a list of key-value pairs in an object and applies an expression that returns only matching
objects, filtering out the rest from the output.

The expression must return `true` or `false`. If the expression returns `true` for a key, value, or
index of an object, the object gets captured in the output. If it returns `false` for any of them,
the object gets filtered out of the output. If there are no matches, the output array will be empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The source object to evaluate.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>Boolean expression that selects a <code>value</code>, <code>key</code>, or <code>index</code> of the object.</p></td></tr></tbody></table>

### Example

This example outputs an object if its value equals `"apple"`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{"a" : "apple", "b" : "banana"} filterObject ((value) -> value == "apple")
```

#### Output

```JSON
{ "a": "apple" }
```

### Example

This example only outputs an object if the key starts with "letter". The DataWeave `startsWith`
function returns `true` or `false`. Note that you can use the anonymous parameter for the key to
write the expression `((value, key) → key startsWith "letter")`: ($$ startsWith "letter")\`

#### Source

```DataWeave
%dw 2.0
output application/json
---
{"letter1": "a", "letter2": "b", "id": 1} filterObject ((value, key) -> key startsWith "letter")
```

#### Output

```JSON
{ "letter1": "a", "letter2": "b" }
```

### Example

This example only outputs an object if the index of the object in the array is less than 1, which is
always true of the first object. Note that you can use the anonymous parameter for the index to
write the expression `((value, key, index) → index < 1)`: `($$$ < 1)`

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "1": "a", "2": "b", "3": "c"} filterObject ((value, key, index) -> index < 1)
```

#### Output

```json
{ "1": "a" }
```

### Example

This example outputs an object that contains only the values that are not `null` in the input JSON
object.

#### Source

```DataWeave
%dw 2.0
output application/json
var myObject = {
    str1 : "String 1",
    str2 : "String 2",
    str3 : null,
    str4 : "String 4",
}
---
myObject filterObject $ != null
```

#### Output

```json
{
  "str1": "String 1",
  "str2": "String 2",
  "str4": "String 4"
}
```

## filterObject(value: Null, criteria: (value: Nothing, key: Nothing, index: Nothing) -> Any): Null

Helper function that enables `filterObject` to work with a `null` value.

<!-- document id=4b015edafe3bb6346898bbe1d98a7748a4a462311aa4ea39061b90f1fe67e851 url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-filterobject.md -->

---
product: DataWeave
version: 2.6
---

# filterObject

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## filterObject<K, V>(@StreamCapable value: { (K)?: V }, criteria: (value: V, key: K, index: Number) -> Boolean): { (K)?: V }

Iterates a list of key-value pairs in an object and applies an expression that returns only matching
objects, filtering out the rest from the output.

The expression must return `true` or `false`. If the expression returns `true` for a key, value, or
index of an object, the object gets captured in the output. If it returns `false` for any of them,
the object gets filtered out of the output. If there are no matches, the output array will be empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The source object to evaluate.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>Boolean expression that selects a <code>value</code>, <code>key</code>, or <code>index</code> of the object.</p></td></tr></tbody></table>

### Example

This example outputs an object if its value equals `"apple"`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{"a" : "apple", "b" : "banana"} filterObject ((value) -> value == "apple")
```

#### Output

```JSON
{ "a": "apple" }
```

### Example

This example only outputs an object if the key starts with "letter". The DataWeave `startsWith`
function returns `true` or `false`. Note that you can use the anonymous parameter for the key to
write the expression `((value, key) → key startsWith "letter")`: ($$ startsWith "letter")\`

#### Source

```DataWeave
%dw 2.0
output application/json
---
{"letter1": "a", "letter2": "b", "id": 1} filterObject ((value, key) -> key startsWith "letter")
```

#### Output

```JSON
{ "letter1": "a", "letter2": "b" }
```

### Example

This example only outputs an object if the index of the object in the array is less than 1, which is
always true of the first object. Note that you can use the anonymous parameter for the index to
write the expression `((value, key, index) → index < 1)`: `($$$ < 1)`

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "1": "a", "2": "b", "3": "c"} filterObject ((value, key, index) -> index < 1)
```

#### Output

```json
{ "1": "a" }
```

### Example

This example outputs an object that contains only the values that are not `null` in the input JSON
object.

#### Source

```DataWeave
%dw 2.0
output application/json
var myObject = {
    str1 : "String 1",
    str2 : "String 2",
    str3 : null,
    str4 : "String 4",
}
---
myObject filterObject $ != null
```

#### Output

```json
{
  "str1": "String 1",
  "str2": "String 2",
  "str4": "String 4"
}
```

## filterObject(value: Null, criteria: (value: Nothing, key: Nothing, index: Nothing) -> Any): Null

Helper function that enables `filterObject` to work with a `null` value.

<!-- document id=3be3421448198c6ccdb9397ab3ea9609e727f3d07012a8211a20cc417bdadcc2 url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-filterobject.md -->

---
product: DataWeave
version: 2.9
---

# filterObject

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## filterObject<K, V>(@StreamCapable value: { (K)?: V }, criteria: (value: V, key: K, index: Number) -> Boolean): { (K)?: V }

Iterates a list of key-value pairs in an object and applies an expression that returns only matching
objects, filtering out the rest from the output.

The expression must return `true` or `false`. If the expression returns `true` for a key, value, or
index of an object, the object gets captured in the output. If it returns `false` for any of them,
the object gets filtered out of the output. If there are no matches, the output array will be empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The source object to evaluate.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>Boolean expression that selects a <code>value</code>, <code>key</code>, or <code>index</code> of the object.</p></td></tr></tbody></table>

### Example

This example outputs an object if its value equals `"apple"`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{"a" : "apple", "b" : "banana"} filterObject ((value) -> value == "apple")
```

#### Output

```JSON
{ "a": "apple" }
```

### Example

This example only outputs an object if the key starts with "letter". The DataWeave `startsWith`
function returns `true` or `false`. Note that you can use the anonymous parameter for the key to
write the expression `((value, key) → key startsWith "letter")`: ($$ startsWith "letter")\`

#### Source

```DataWeave
%dw 2.0
output application/json
---
{"letter1": "a", "letter2": "b", "id": 1} filterObject ((value, key) -> key startsWith "letter")
```

#### Output

```JSON
{ "letter1": "a", "letter2": "b" }
```

### Example

This example only outputs an object if the index of the object in the array is less than 1, which is
always true of the first object. Note that you can use the anonymous parameter for the index to
write the expression `((value, key, index) → index < 1)`: `($$$ < 1)`

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "1": "a", "2": "b", "3": "c"} filterObject ((value, key, index) -> index < 1)
```

#### Output

```json
{ "1": "a" }
```

### Example

This example outputs an object that contains only the values that are not `null` in the input JSON
object.

#### Source

```DataWeave
%dw 2.0
output application/json
var myObject = {
    str1 : "String 1",
    str2 : "String 2",
    str3 : null,
    str4 : "String 4",
}
---
myObject filterObject $ != null
```

#### Output

```json
{
  "str1": "String 1",
  "str2": "String 2",
  "str4": "String 4"
}
```

## filterObject(value: Null, criteria: (value: Nothing, key: Nothing, index: Nothing) -> Any): Null

Helper function that enables `filterObject` to work with a `null` value.

<!-- document id=9f8c50b24f8f74282a966960e3e15a262af13fa6d476cdeb4128e2c1e99e55fa url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-filterobject.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# filterObject

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## filterObject<K, V>(@StreamCapable value: { (K)?: V }, criteria: (value: V, key: K, index: Number) -> Boolean): { (K)?: V }

Iterates a list of key-value pairs in an object and applies an expression that returns only matching
objects, filtering out the rest from the output.

The expression must return `true` or `false`. If the expression returns `true` for a key, value, or
index of an object, the object gets captured in the output. If it returns `false` for any of them,
the object gets filtered out of the output. If there are no matches, the output array will be empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The source object to evaluate.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>Boolean expression that selects a <code>value</code>, <code>key</code>, or <code>index</code> of the object.</p></td></tr></tbody></table>

### Example

This example outputs an object if its value equals `"apple"`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{"a" : "apple", "b" : "banana"} filterObject ((value) -> value == "apple")
```

#### Output

```JSON
{ "a": "apple" }
```

### Example

This example only outputs an object if the key starts with "letter". The DataWeave `startsWith`
function returns `true` or `false`. Note that you can use the anonymous parameter for the key to
write the expression `((value, key) → key startsWith "letter")`: ($$ startsWith "letter")\`

#### Source

```DataWeave
%dw 2.0
output application/json
---
{"letter1": "a", "letter2": "b", "id": 1} filterObject ((value, key) -> key startsWith "letter")
```

#### Output

```JSON
{ "letter1": "a", "letter2": "b" }
```

### Example

This example only outputs an object if the index of the object in the array is less than 1, which is
always true of the first object. Note that you can use the anonymous parameter for the index to
write the expression `((value, key, index) → index < 1)`: `($$$ < 1)`

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "1": "a", "2": "b", "3": "c"} filterObject ((value, key, index) -> index < 1)
```

#### Output

```json
{ "1": "a" }
```

### Example

This example outputs an object that contains only the values that are not `null` in the input JSON
object.

#### Source

```DataWeave
%dw 2.0
output application/json
var myObject = {
    str1 : "String 1",
    str2 : "String 2",
    str3 : null,
    str4 : "String 4",
}
---
myObject filterObject $ != null
```

#### Output

```json
{
  "str1": "String 1",
  "str2": "String 2",
  "str4": "String 4"
}
```

## filterObject(value: Null, criteria: (value: Nothing, key: Nothing, index: Nothing) -> Any): Null

Helper function that enables `filterObject` to work with a `null` value.

<!-- document id=59bbfcb7f8c5f98820a6b07567fddce742281f172ecd38e181235baa102bbee9 url=/mulesoft/current/en-us/dataweave/2.11/dw-tree-functions-filterobjectleafs.md -->

---
product: DataWeave
version: 2.11
---

# filterObjectLeafs

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## filterObjectLeafs(value: Any, criteria: (value: Any, path: Path) -> Boolean): Any

Applies a filtering expression to leaf or `Path` values of keys in an object.

The leaf values in the object must be `SimpleType` or `Null` values. See
[Core Types](https://docs.mulesoft.com/dataweave/latest/dw-core-types) for descriptions of the
types.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>An input value of <code>Any</code> type.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>Boolean expression to apply to <code>SimpleType</code> or <code>Null</code> leaf values of all objects in the input <code>value</code>. If the result is <code>true</code>, the object retains the leaf value and its key. If not, the function removes the leaf value and key from the output.</p></td></tr></tbody></table>

### Example

This example shows how `filterObjectLeafs` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
var myArray = [{name @(mail: "me@me.com", test:123 ): "", id:"test"},
               {name: "Me", id:null}]
output application/json
---
{
 a: {
     name: "Mariano",
     lastName: null,
     age: 123,
     friends: myArray
    }  filterObjectLeafs ((value, path) ->
         !(value is Null or value is String)),
 b: { c : null, d : "hello" } filterObjectLeafs ((value, path) ->
         (value is Null and isObjectType(path)))
}
```

#### Output

```Json
{
  "a": {
    "age": 123,
    "friends": [
      {

      },
      {

      }
    ]
  },
  "b": {
    "c": null
  }
}
```

<!-- document id=19be04d6452504f91d1321ffee9f011e7f21a87b97ac9a35935fa7273c589869 url=/mulesoft/current/en-us/dataweave/2.12/dw-tree-functions-filterobjectleafs.md -->

---
product: DataWeave
version: 2.12
---

# filterObjectLeafs

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## filterObjectLeafs(value: Any, criteria: (value: Any, path: Path) -> Boolean): Any

Applies a filtering expression to leaf or `Path` values of keys in an object.

The leaf values in the object must be `SimpleType` or `Null` values. See
[Core Types](https://docs.mulesoft.com/dataweave/latest/dw-core-types) for descriptions of the
types.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>An input value of <code>Any</code> type.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>Boolean expression to apply to <code>SimpleType</code> or <code>Null</code> leaf values of all objects in the input <code>value</code>. If the result is <code>true</code>, the object retains the leaf value and its key. If not, the function removes the leaf value and key from the output.</p></td></tr></tbody></table>

### Example

This example shows how `filterObjectLeafs` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
var myArray = [{name @(mail: "me@me.com", test:123 ): "", id:"test"},
               {name: "Me", id:null}]
output application/json
---
{
 a: {
     name: "Mariano",
     lastName: null,
     age: 123,
     friends: myArray
    }  filterObjectLeafs ((value, path) ->
         !(value is Null or value is String)),
 b: { c : null, d : "hello" } filterObjectLeafs ((value, path) ->
         (value is Null and isObjectType(path)))
}
```

#### Output

```Json
{
  "a": {
    "age": 123,
    "friends": [
      {

      },
      {

      }
    ]
  },
  "b": {
    "c": null
  }
}
```

<!-- document id=d04b7b4c6dc2155a65bdecfa97f2b443ea039bce8ea00cb5c6e2e737a667053e url=/mulesoft/current/en-us/dataweave/2.4/dw-tree-functions-filterobjectleafs.md -->

---
product: DataWeave
version: 2.4
---

# filterObjectLeafs

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## filterObjectLeafs(value: Any, criteria: (value: Any, path: Path) -> Boolean): Any

Applies a filtering expression to leaf or `Path` values of keys in an object.

The leaf values in the object must be `SimpleType` or `Null` values. See
[Core Types](https://docs.mulesoft.com/dataweave/latest/dw-core-types) for descriptions of the
types.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>An input value of <code>Any</code> type.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>Boolean expression to apply to <code>SimpleType</code> or <code>Null</code> leaf values of all objects in the input <code>value</code>. If the result is <code>true</code>, the object retains the leaf value and its key. If not, the function removes the leaf value and key from the output.</p></td></tr></tbody></table>

### Example

This example shows how `filterObjectLeafs` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
var myArray = [{name @(mail: "me@me.com", test:123 ): "", id:"test"},
               {name: "Me", id:null}]
output application/json
---
{
 a: {
     name: "Mariano",
     lastName: null,
     age: 123,
     friends: myArray
    }  filterObjectLeafs ((value, path) ->
         !(value is Null or value is String)),
 b: { c : null, d : "hello" } filterObjectLeafs ((value, path) ->
         (value is Null and isObjectType(path)))
}
```

#### Output

```Json
{
  "a": {
    "age": 123,
    "friends": [
      {

      },
      {

      }
    ]
  },
  "b": {
    "c": null
  }
}
```

<!-- document id=077d3c8823681d6c0cde883b86669245613eb2064030a039dc23652f55473938 url=/mulesoft/current/en-us/dataweave/2.6/dw-tree-functions-filterobjectleafs.md -->

---
product: DataWeave
version: 2.6
---

# filterObjectLeafs

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## filterObjectLeafs(value: Any, criteria: (value: Any, path: Path) -> Boolean): Any

Applies a filtering expression to leaf or `Path` values of keys in an object.

The leaf values in the object must be `SimpleType` or `Null` values. See
[Core Types](https://docs.mulesoft.com/dataweave/latest/dw-core-types) for descriptions of the
types.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>An input value of <code>Any</code> type.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>Boolean expression to apply to <code>SimpleType</code> or <code>Null</code> leaf values of all objects in the input <code>value</code>. If the result is <code>true</code>, the object retains the leaf value and its key. If not, the function removes the leaf value and key from the output.</p></td></tr></tbody></table>

### Example

This example shows how `filterObjectLeafs` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
var myArray = [{name @(mail: "me@me.com", test:123 ): "", id:"test"},
               {name: "Me", id:null}]
output application/json
---
{
 a: {
     name: "Mariano",
     lastName: null,
     age: 123,
     friends: myArray
    }  filterObjectLeafs ((value, path) ->
         !(value is Null or value is String)),
 b: { c : null, d : "hello" } filterObjectLeafs ((value, path) ->
         (value is Null and isObjectType(path)))
}
```

#### Output

```Json
{
  "a": {
    "age": 123,
    "friends": [
      {

      },
      {

      }
    ]
  },
  "b": {
    "c": null
  }
}
```

<!-- document id=dd7c2a32e9757b057af85587c5e76b9049e8ead94239c3aff1f12d58e929a429 url=/mulesoft/current/en-us/dataweave/2.9/dw-tree-functions-filterobjectleafs.md -->

---
product: DataWeave
version: 2.9
---

# filterObjectLeafs

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## filterObjectLeafs(value: Any, criteria: (value: Any, path: Path) -> Boolean): Any

Applies a filtering expression to leaf or `Path` values of keys in an object.

The leaf values in the object must be `SimpleType` or `Null` values. See
[Core Types](https://docs.mulesoft.com/dataweave/latest/dw-core-types) for descriptions of the
types.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>An input value of <code>Any</code> type.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>Boolean expression to apply to <code>SimpleType</code> or <code>Null</code> leaf values of all objects in the input <code>value</code>. If the result is <code>true</code>, the object retains the leaf value and its key. If not, the function removes the leaf value and key from the output.</p></td></tr></tbody></table>

### Example

This example shows how `filterObjectLeafs` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
var myArray = [{name @(mail: "me@me.com", test:123 ): "", id:"test"},
               {name: "Me", id:null}]
output application/json
---
{
 a: {
     name: "Mariano",
     lastName: null,
     age: 123,
     friends: myArray
    }  filterObjectLeafs ((value, path) ->
         !(value is Null or value is String)),
 b: { c : null, d : "hello" } filterObjectLeafs ((value, path) ->
         (value is Null and isObjectType(path)))
}
```

#### Output

```Json
{
  "a": {
    "age": 123,
    "friends": [
      {

      },
      {

      }
    ]
  },
  "b": {
    "c": null
  }
}
```

<!-- document id=e7ba1830d23d75ef178f15856cdef23b85c365b426484cf92a3cd0dc32cc9fa9 url=/mulesoft/current/en-us/dataweave/latest/dw-tree-functions-filterobjectleafs.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# filterObjectLeafs

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## filterObjectLeafs(value: Any, criteria: (value: Any, path: Path) -> Boolean): Any

Applies a filtering expression to leaf or `Path` values of keys in an object.

The leaf values in the object must be `SimpleType` or `Null` values. See
[Core Types](https://docs.mulesoft.com/dataweave/latest/dw-core-types) for descriptions of the
types.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>An input value of <code>Any</code> type.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>Boolean expression to apply to <code>SimpleType</code> or <code>Null</code> leaf values of all objects in the input <code>value</code>. If the result is <code>true</code>, the object retains the leaf value and its key. If not, the function removes the leaf value and key from the output.</p></td></tr></tbody></table>

### Example

This example shows how `filterObjectLeafs` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
var myArray = [{name @(mail: "me@me.com", test:123 ): "", id:"test"},
               {name: "Me", id:null}]
output application/json
---
{
 a: {
     name: "Mariano",
     lastName: null,
     age: 123,
     friends: myArray
    }  filterObjectLeafs ((value, path) ->
         !(value is Null or value is String)),
 b: { c : null, d : "hello" } filterObjectLeafs ((value, path) ->
         (value is Null and isObjectType(path)))
}
```

#### Output

```Json
{
  "a": {
    "age": 123,
    "friends": [
      {

      },
      {

      }
    ]
  },
  "b": {
    "c": null
  }
}
```

<!-- document id=d5f5ab057a018629e6818195d258a4d4894945854f0b17d293af760ed3235b3f url=/mulesoft/current/en-us/dataweave/2.11/dw-tree-functions-filtertree.md -->

---
product: DataWeave
version: 2.11
---

# filterTree

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## filterTree(value: Any, criteria: (value: Any, path: Path) -> Boolean): Any

Filters the value or path of nodes in an input based on a specified `criteria`.

The function iterates through the nodes in the input. The `criteria` can apply to the value or path
in the input. If the `criteria` evaluates to `true`, the node remains in the output. If `false`, the
function filters out the node.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The value to filter.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The expression that determines whether to filter the node.</p></td></tr></tbody></table>

### Example

This example shows how `filterTree` behaves with different inputs. The output is `application/dw`
for demonstration purposes.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
output application/dw
---
{
    a: {
          name : "",
          lastName @(foo: ""): "Achaval",
          friends @(id: 123): [{id: "", test: true}, {age: 123}, ""]
        } filterTree ((value, path) ->
            value match  {
                            case s is String -> !isEmpty(s)
                            else -> true
                          }
    ),
    b: null filterTree ((value, path) -> value is String),
    c: [
            {name: "Mariano", friends: []},
            {test: [1,2,3]},
            {dw: ""}
        ] filterTree ((value, path) ->
            value match  {
                            case a is Array ->  !isEmpty(a as Array)
                            else -> true
                        })
}
```

#### Output

```DataWeave
{
  a: {
    lastName: "Achaval",
    friends @(id: 123): [
      {
        test: true
      },
      {
        age: 123
      }
    ]
  },
  b: null,
  c: [
    {
      name: "Mariano"
    },
    {
      test: [
        1,
        2,
        3
      ]
    },
    {
      dw: ""
    }
  ]
}
```

<!-- document id=63e2d14261516ff345220764c1b485ed9f4819d849339bb2694bc1976d289bab url=/mulesoft/current/en-us/dataweave/2.12/dw-tree-functions-filtertree.md -->

---
product: DataWeave
version: 2.12
---

# filterTree

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## filterTree(value: Any, criteria: (value: Any, path: Path) -> Boolean): Any

Filters the value or path of nodes in an input based on a specified `criteria`.

The function iterates through the nodes in the input. The `criteria` can apply to the value or path
in the input. If the `criteria` evaluates to `true`, the node remains in the output. If `false`, the
function filters out the node.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The value to filter.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The expression that determines whether to filter the node.</p></td></tr></tbody></table>

### Example

This example shows how `filterTree` behaves with different inputs. The output is `application/dw`
for demonstration purposes.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
output application/dw
---
{
    a: {
          name : "",
          lastName @(foo: ""): "Achaval",
          friends @(id: 123): [{id: "", test: true}, {age: 123}, ""]
        } filterTree ((value, path) ->
            value match  {
                            case s is String -> !isEmpty(s)
                            else -> true
                          }
    ),
    b: null filterTree ((value, path) -> value is String),
    c: [
            {name: "Mariano", friends: []},
            {test: [1,2,3]},
            {dw: ""}
        ] filterTree ((value, path) ->
            value match  {
                            case a is Array ->  !isEmpty(a as Array)
                            else -> true
                        })
}
```

#### Output

```DataWeave
{
  a: {
    lastName: "Achaval",
    friends @(id: 123): [
      {
        test: true
      },
      {
        age: 123
      }
    ]
  },
  b: null,
  c: [
    {
      name: "Mariano"
    },
    {
      test: [
        1,
        2,
        3
      ]
    },
    {
      dw: ""
    }
  ]
}
```

<!-- document id=21404d2559aa7a7e1507fb1e10c413f6764e32fad037c7c662ba0aa743d3b3bc url=/mulesoft/current/en-us/dataweave/2.4/dw-tree-functions-filtertree.md -->

---
product: DataWeave
version: 2.4
---

# filterTree

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## filterTree(value: Any, criteria: (value: Any, path: Path) -> Boolean): Any

Filters the value or path of nodes in an input based on a specified `criteria`.

The function iterates through the nodes in the input. The `criteria` can apply to the value or path
in the input. If the `criteria` evaluates to `true`, the node remains in the output. If `false`, the
function filters out the node.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The value to filter.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The expression that determines whether to filter the node.</p></td></tr></tbody></table>

### Example

This example shows how `filterTree` behaves with different inputs. The output is `application/dw`
for demonstration purposes.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
output application/dw
---
{
    a: {
          name : "",
          lastName @(foo: ""): "Achaval",
          friends @(id: 123): [{id: "", test: true}, {age: 123}, ""]
        } filterTree ((value, path) ->
            value match  {
                            case s is String -> !isEmpty(s)
                            else -> true
                          }
    ),
    b: null filterTree ((value, path) -> value is String),
    c: [
            {name: "Mariano", friends: []},
            {test: [1,2,3]},
            {dw: ""}
        ] filterTree ((value, path) ->
            value match  {
                            case a is Array ->  !isEmpty(a as Array)
                            else -> true
                        })
}
```

#### Output

```DataWeave
{
  a: {
    lastName: "Achaval",
    friends @(id: 123): [
      {
        test: true
      },
      {
        age: 123
      }
    ]
  },
  b: null,
  c: [
    {
      name: "Mariano"
    },
    {
      test: [
        1,
        2,
        3
      ]
    },
    {
      dw: ""
    }
  ]
}
```

<!-- document id=b8c5438ff695a47bfc838829ef96d080b8498b996da30a49cd9f37b9a7f813b6 url=/mulesoft/current/en-us/dataweave/2.6/dw-tree-functions-filtertree.md -->

---
product: DataWeave
version: 2.6
---

# filterTree

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## filterTree(value: Any, criteria: (value: Any, path: Path) -> Boolean): Any

Filters the value or path of nodes in an input based on a specified `criteria`.

The function iterates through the nodes in the input. The `criteria` can apply to the value or path
in the input. If the `criteria` evaluates to `true`, the node remains in the output. If `false`, the
function filters out the node.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The value to filter.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The expression that determines whether to filter the node.</p></td></tr></tbody></table>

### Example

This example shows how `filterTree` behaves with different inputs. The output is `application/dw`
for demonstration purposes.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
output application/dw
---
{
    a: {
          name : "",
          lastName @(foo: ""): "Achaval",
          friends @(id: 123): [{id: "", test: true}, {age: 123}, ""]
        } filterTree ((value, path) ->
            value match  {
                            case s is String -> !isEmpty(s)
                            else -> true
                          }
    ),
    b: null filterTree ((value, path) -> value is String),
    c: [
            {name: "Mariano", friends: []},
            {test: [1,2,3]},
            {dw: ""}
        ] filterTree ((value, path) ->
            value match  {
                            case a is Array ->  !isEmpty(a as Array)
                            else -> true
                        })
}
```

#### Output

```DataWeave
{
  a: {
    lastName: "Achaval",
    friends @(id: 123): [
      {
        test: true
      },
      {
        age: 123
      }
    ]
  },
  b: null,
  c: [
    {
      name: "Mariano"
    },
    {
      test: [
        1,
        2,
        3
      ]
    },
    {
      dw: ""
    }
  ]
}
```

<!-- document id=7376b9c8990031046db2aa8feeea5d3a03fc817d1e011a2453387ca4753c6c5e url=/mulesoft/current/en-us/dataweave/2.9/dw-tree-functions-filtertree.md -->

---
product: DataWeave
version: 2.9
---

# filterTree

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## filterTree(value: Any, criteria: (value: Any, path: Path) -> Boolean): Any

Filters the value or path of nodes in an input based on a specified `criteria`.

The function iterates through the nodes in the input. The `criteria` can apply to the value or path
in the input. If the `criteria` evaluates to `true`, the node remains in the output. If `false`, the
function filters out the node.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The value to filter.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The expression that determines whether to filter the node.</p></td></tr></tbody></table>

### Example

This example shows how `filterTree` behaves with different inputs. The output is `application/dw`
for demonstration purposes.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
output application/dw
---
{
    a: {
          name : "",
          lastName @(foo: ""): "Achaval",
          friends @(id: 123): [{id: "", test: true}, {age: 123}, ""]
        } filterTree ((value, path) ->
            value match  {
                            case s is String -> !isEmpty(s)
                            else -> true
                          }
    ),
    b: null filterTree ((value, path) -> value is String),
    c: [
            {name: "Mariano", friends: []},
            {test: [1,2,3]},
            {dw: ""}
        ] filterTree ((value, path) ->
            value match  {
                            case a is Array ->  !isEmpty(a as Array)
                            else -> true
                        })
}
```

#### Output

```DataWeave
{
  a: {
    lastName: "Achaval",
    friends @(id: 123): [
      {
        test: true
      },
      {
        age: 123
      }
    ]
  },
  b: null,
  c: [
    {
      name: "Mariano"
    },
    {
      test: [
        1,
        2,
        3
      ]
    },
    {
      dw: ""
    }
  ]
}
```

<!-- document id=332ddd06aee9ad4134c7b34deec882adaa817f91b8bf3a3addbc1298a08b3153 url=/mulesoft/current/en-us/dataweave/latest/dw-tree-functions-filtertree.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# filterTree

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## filterTree(value: Any, criteria: (value: Any, path: Path) -> Boolean): Any

Filters the value or path of nodes in an input based on a specified `criteria`.

The function iterates through the nodes in the input. The `criteria` can apply to the value or path
in the input. If the `criteria` evaluates to `true`, the node remains in the output. If `false`, the
function filters out the node.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The value to filter.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The expression that determines whether to filter the node.</p></td></tr></tbody></table>

### Example

This example shows how `filterTree` behaves with different inputs. The output is `application/dw`
for demonstration purposes.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
output application/dw
---
{
    a: {
          name : "",
          lastName @(foo: ""): "Achaval",
          friends @(id: 123): [{id: "", test: true}, {age: 123}, ""]
        } filterTree ((value, path) ->
            value match  {
                            case s is String -> !isEmpty(s)
                            else -> true
                          }
    ),
    b: null filterTree ((value, path) -> value is String),
    c: [
            {name: "Mariano", friends: []},
            {test: [1,2,3]},
            {dw: ""}
        ] filterTree ((value, path) ->
            value match  {
                            case a is Array ->  !isEmpty(a as Array)
                            else -> true
                        })
}
```

#### Output

```DataWeave
{
  a: {
    lastName: "Achaval",
    friends @(id: 123): [
      {
        test: true
      },
      {
        age: 123
      }
    ]
  },
  b: null,
  c: [
    {
      name: "Mariano"
    },
    {
      test: [
        1,
        2,
        3
      ]
    },
    {
      dw: ""
    }
  ]
}
```

<!-- document id=c6d8d0409e5b877748b6cccf92767acdc2ec12d79372675cfaed79049ee1d8b8 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-find.md -->

---
product: DataWeave
version: 2.11
---

# find

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## find<T>(@StreamCapable() elements: Array<T>, elementToFind: Any): Array<Number>

Returns indices of an input that match a specified value.

This version of the function returns indices of an array. Others return indices of a string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>elements</code></p></td><td><p>An array with elements of any type.</p></td></tr><tr><td><p><code>elementToFind</code></p></td><td><p>Value to find in the input array.</p></td></tr></tbody></table>

### Example

This example finds the index of an element in a string array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
["Bond", "James", "Bond"] find "Bond"
```

#### Output

```JSON
[0,2]
```

## find(@StreamCapable() text: String, matcher: Regex): Array<Array<Number>>

Returns the indices in the text that match the specified regular expression (regex), followed by the
capture groups.

The first element in each resulting sub-array is the index in the text that matches the regex, and
the next ones are the capture groups in the regex (if present).

Note: To retrieve parts of the text that match a regex. use the `scan` function.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>A string.</p></td></tr><tr><td><p><code>matcher</code></p></td><td><p>A Java regular expression for matching characters in the <code>text</code>.</p></td></tr></tbody></table>

### Example

This example finds the beginning and ending indices of words that contain `ea`

#### Source

```DataWeave
%dw 2.0
output application/json
---
"I heart DataWeave" find /\w*ea\w*(\b)/
```

#### Output

```JSON
[ [2,7], [8,17] ]
```

## find(@StreamCapable() text: String, textToFind: String): Array<Number>

Lists indices where the specified characters of a string are present.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>A source string.</p></td></tr><tr><td><p><code>textToFind</code></p></td><td><p>The string to find in the source string.</p></td></tr></tbody></table>

### Example

This example lists the indices of "a" found in "aabccdbce".

#### Source

```DataWeave
%dw 2.0
output application/json
---
"aabccdbce" find "a"
```

#### Output

```JSON
[0,1]
```

## find(@StreamCapable() text: Null, textToFind: Any): Array<Nothing>

Helper function that enables `find` to work with a `null` value.

<!-- document id=00a74adc94ec5d4739eeb19a123e64e3be6a0d3f508e8a1f152677609432ad9e url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-find.md -->

---
product: DataWeave
version: 2.12
---

# find

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## find<T>(@StreamCapable() elements: Array<T>, elementToFind: Any): Array<Number>

Returns indices of an input that match a specified value.

This version of the function returns indices of an array. Others return indices of a string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>elements</code></p></td><td><p>An array with elements of any type.</p></td></tr><tr><td><p><code>elementToFind</code></p></td><td><p>Value to find in the input array.</p></td></tr></tbody></table>

### Example

This example finds the index of an element in a string array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
["Bond", "James", "Bond"] find "Bond"
```

#### Output

```JSON
[0,2]
```

## find(@StreamCapable() text: String, matcher: Regex): Array<Array<Number>>

Returns the indices in the text that match the specified regular expression (regex), followed by the
capture groups.

The first element in each resulting sub-array is the index in the text that matches the regex, and
the next ones are the capture groups in the regex (if present).

Note: To retrieve parts of the text that match a regex. use the `scan` function.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>A string.</p></td></tr><tr><td><p><code>matcher</code></p></td><td><p>A Java regular expression for matching characters in the <code>text</code>.</p></td></tr></tbody></table>

### Example

This example finds the beginning and ending indices of words that contain `ea`

#### Source

```DataWeave
%dw 2.0
output application/json
---
"I heart DataWeave" find /\w*ea\w*(\b)/
```

#### Output

```JSON
[ [2,7], [8,17] ]
```

## find(@StreamCapable() text: String, textToFind: String): Array<Number>

Lists indices where the specified characters of a string are present.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>A source string.</p></td></tr><tr><td><p><code>textToFind</code></p></td><td><p>The string to find in the source string.</p></td></tr></tbody></table>

### Example

This example lists the indices of "a" found in "aabccdbce".

#### Source

```DataWeave
%dw 2.0
output application/json
---
"aabccdbce" find "a"
```

#### Output

```JSON
[0,1]
```

## find(@StreamCapable() text: Null, textToFind: Any): Array<Nothing>

Helper function that enables `find` to work with a `null` value.

<!-- document id=1d7418a145251dfb53f579fe33782ccb102c1ba9443064d27eae1173ff4c2e7e url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-find.md -->

---
product: DataWeave
version: 2.3
---

# find

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## find(Array<T>, Any): Array<Number>

Returns indices of an input that match a specified value.

This version of the function returns indices of an array. Others return indices of a string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>elements</code></p></td><td><p>An array with elements of any type.</p></td></tr><tr><td><p><code>elementToFind</code></p></td><td><p>Value to find in the input array.</p></td></tr></tbody></table>

### Example

This example finds the index of an element in a string array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
["Bond", "James", "Bond"] find "Bond"
```

#### Output

```JSON
[0,2]
```

## find(String, Regex): Array<Array<Number>>

Returns the indices in the text that match the specified regular expression (regex), followed by the
capture groups.

The first element in each resulting sub-array is the index in the text that matches the regex, and
the next ones are the capture groups in the regex (if present).

Note: To retrieve parts of the text that match a regex. use the `scan` function.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>A string.</p></td></tr><tr><td><p><code>matcher</code></p></td><td><p>A Java regular expression for matching characters in the <code>text</code>.</p></td></tr></tbody></table>

### Example

This example finds the beginning and ending indices of words that contain `ea`

#### Source

```DataWeave
%dw 2.0
output application/json
---
"I heart DataWeave" find /\w*ea\w*(\b)/
```

#### Output

```JSON
[ [2,7], [8,17] ]
```

## find(String, String): Array<Number>

Lists indices where the specified characters of a string are present.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>A source string.</p></td></tr><tr><td><p><code>textToFind</code></p></td><td><p>The string to find in the source string.</p></td></tr></tbody></table>

### Example

This example lists the indices of "a" found in "aabccdbce".

#### Source

```DataWeave
%dw 2.0
output application/json
---
"aabccdbce" find "a"
```

#### Output

```JSON
[0,1]
```

<!-- document id=9ce6c07d499551ccca3fefa72ec022f83dcd02c32317e71a76f97e0f1f5ed2e7 url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-find.md -->

---
product: DataWeave
version: 2.4
---

# find

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## find<T>(@StreamCapable() elements: Array<T>, elementToFind: Any): Array<Number>

Returns indices of an input that match a specified value.

This version of the function returns indices of an array. Others return indices of a string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>elements</code></p></td><td><p>An array with elements of any type.</p></td></tr><tr><td><p><code>elementToFind</code></p></td><td><p>Value to find in the input array.</p></td></tr></tbody></table>

### Example

This example finds the index of an element in a string array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
["Bond", "James", "Bond"] find "Bond"
```

#### Output

```JSON
[0,2]
```

## find(@StreamCapable() text: String, matcher: Regex): Array<Array<Number>>

Returns the indices in the text that match the specified regular expression (regex), followed by the
capture groups.

The first element in each resulting sub-array is the index in the text that matches the regex, and
the next ones are the capture groups in the regex (if present).

Note: To retrieve parts of the text that match a regex. use the `scan` function.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>A string.</p></td></tr><tr><td><p><code>matcher</code></p></td><td><p>A Java regular expression for matching characters in the <code>text</code>.</p></td></tr></tbody></table>

### Example

This example finds the beginning and ending indices of words that contain `ea`

#### Source

```DataWeave
%dw 2.0
output application/json
---
"I heart DataWeave" find /\w*ea\w*(\b)/
```

#### Output

```JSON
[ [2,7], [8,17] ]
```

## find(@StreamCapable() text: String, textToFind: String): Array<Number>

Lists indices where the specified characters of a string are present.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>A source string.</p></td></tr><tr><td><p><code>textToFind</code></p></td><td><p>The string to find in the source string.</p></td></tr></tbody></table>

### Example

This example lists the indices of "a" found in "aabccdbce".

#### Source

```DataWeave
%dw 2.0
output application/json
---
"aabccdbce" find "a"
```

#### Output

```JSON
[0,1]
```

## find(@StreamCapable() text: Null, textToFind: Any): Array<Nothing>

Helper function that enables `find` to work with a `null` value.

<!-- document id=173767c9aef0c5593225a1cdbf4cc5a613822b4ae879c823c7ff048e0438baff url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-find.md -->

---
product: DataWeave
version: 2.6
---

# find

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## find<T>(@StreamCapable() elements: Array<T>, elementToFind: Any): Array<Number>

Returns indices of an input that match a specified value.

This version of the function returns indices of an array. Others return indices of a string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>elements</code></p></td><td><p>An array with elements of any type.</p></td></tr><tr><td><p><code>elementToFind</code></p></td><td><p>Value to find in the input array.</p></td></tr></tbody></table>

### Example

This example finds the index of an element in a string array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
["Bond", "James", "Bond"] find "Bond"
```

#### Output

```JSON
[0,2]
```

## find(@StreamCapable() text: String, matcher: Regex): Array<Array<Number>>

Returns the indices in the text that match the specified regular expression (regex), followed by the
capture groups.

The first element in each resulting sub-array is the index in the text that matches the regex, and
the next ones are the capture groups in the regex (if present).

Note: To retrieve parts of the text that match a regex. use the `scan` function.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>A string.</p></td></tr><tr><td><p><code>matcher</code></p></td><td><p>A Java regular expression for matching characters in the <code>text</code>.</p></td></tr></tbody></table>

### Example

This example finds the beginning and ending indices of words that contain `ea`

#### Source

```DataWeave
%dw 2.0
output application/json
---
"I heart DataWeave" find /\w*ea\w*(\b)/
```

#### Output

```JSON
[ [2,7], [8,17] ]
```

## find(@StreamCapable() text: String, textToFind: String): Array<Number>

Lists indices where the specified characters of a string are present.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>A source string.</p></td></tr><tr><td><p><code>textToFind</code></p></td><td><p>The string to find in the source string.</p></td></tr></tbody></table>

### Example

This example lists the indices of "a" found in "aabccdbce".

#### Source

```DataWeave
%dw 2.0
output application/json
---
"aabccdbce" find "a"
```

#### Output

```JSON
[0,1]
```

## find(@StreamCapable() text: Null, textToFind: Any): Array<Nothing>

Helper function that enables `find` to work with a `null` value.

<!-- document id=63aace801d11494f5d48bcf291b71b47c7c236c26b9a9e88c339bcae7a18288e url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-find.md -->

---
product: DataWeave
version: 2.9
---

# find

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## find<T>(@StreamCapable() elements: Array<T>, elementToFind: Any): Array<Number>

Returns indices of an input that match a specified value.

This version of the function returns indices of an array. Others return indices of a string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>elements</code></p></td><td><p>An array with elements of any type.</p></td></tr><tr><td><p><code>elementToFind</code></p></td><td><p>Value to find in the input array.</p></td></tr></tbody></table>

### Example

This example finds the index of an element in a string array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
["Bond", "James", "Bond"] find "Bond"
```

#### Output

```JSON
[0,2]
```

## find(@StreamCapable() text: String, matcher: Regex): Array<Array<Number>>

Returns the indices in the text that match the specified regular expression (regex), followed by the
capture groups.

The first element in each resulting sub-array is the index in the text that matches the regex, and
the next ones are the capture groups in the regex (if present).

Note: To retrieve parts of the text that match a regex. use the `scan` function.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>A string.</p></td></tr><tr><td><p><code>matcher</code></p></td><td><p>A Java regular expression for matching characters in the <code>text</code>.</p></td></tr></tbody></table>

### Example

This example finds the beginning and ending indices of words that contain `ea`

#### Source

```DataWeave
%dw 2.0
output application/json
---
"I heart DataWeave" find /\w*ea\w*(\b)/
```

#### Output

```JSON
[ [2,7], [8,17] ]
```

## find(@StreamCapable() text: String, textToFind: String): Array<Number>

Lists indices where the specified characters of a string are present.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>A source string.</p></td></tr><tr><td><p><code>textToFind</code></p></td><td><p>The string to find in the source string.</p></td></tr></tbody></table>

### Example

This example lists the indices of "a" found in "aabccdbce".

#### Source

```DataWeave
%dw 2.0
output application/json
---
"aabccdbce" find "a"
```

#### Output

```JSON
[0,1]
```

## find(@StreamCapable() text: Null, textToFind: Any): Array<Nothing>

Helper function that enables `find` to work with a `null` value.

<!-- document id=87a199424d84c5a2ad16226247ed2636a1b7c4ebfd889094689802814f4a4ac7 url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-find.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# find

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## find<T>(@StreamCapable() elements: Array<T>, elementToFind: Any): Array<Number>

Returns indices of an input that match a specified value.

This version of the function returns indices of an array. Others return indices of a string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>elements</code></p></td><td><p>An array with elements of any type.</p></td></tr><tr><td><p><code>elementToFind</code></p></td><td><p>Value to find in the input array.</p></td></tr></tbody></table>

### Example

This example finds the index of an element in a string array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
["Bond", "James", "Bond"] find "Bond"
```

#### Output

```JSON
[0,2]
```

## find(@StreamCapable() text: String, matcher: Regex): Array<Array<Number>>

Returns the indices in the text that match the specified regular expression (regex), followed by the
capture groups.

The first element in each resulting sub-array is the index in the text that matches the regex, and
the next ones are the capture groups in the regex (if present).

Note: To retrieve parts of the text that match a regex. use the `scan` function.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>A string.</p></td></tr><tr><td><p><code>matcher</code></p></td><td><p>A Java regular expression for matching characters in the <code>text</code>.</p></td></tr></tbody></table>

### Example

This example finds the beginning and ending indices of words that contain `ea`

#### Source

```DataWeave
%dw 2.0
output application/json
---
"I heart DataWeave" find /\w*ea\w*(\b)/
```

#### Output

```JSON
[ [2,7], [8,17] ]
```

## find(@StreamCapable() text: String, textToFind: String): Array<Number>

Lists indices where the specified characters of a string are present.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>A source string.</p></td></tr><tr><td><p><code>textToFind</code></p></td><td><p>The string to find in the source string.</p></td></tr></tbody></table>

### Example

This example lists the indices of "a" found in "aabccdbce".

#### Source

```DataWeave
%dw 2.0
output application/json
---
"aabccdbce" find "a"
```

#### Output

```JSON
[0,1]
```

## find(@StreamCapable() text: Null, textToFind: Any): Array<Nothing>

Helper function that enables `find` to work with a `null` value.

<!-- document id=1a5707f86d2b6ed106ec9af959d32452b74ab9986e72330d22b1f01c4daf6406 url=/mulesoft/current/en-us/dataweave/2.11/dw-runtime-functions-finddataformatdescriptorbymime.md -->

---
product: DataWeave
version: 2.11
---

# findDataFormatDescriptorByMime

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## findDataFormatDescriptorByMime(mime: dw::module::Mime::MimeType): DataFormatDescriptor | Null

Returns the `DataFormatDescriptor` based on the `dw::module::Mime::MimeType` specified or `null` if
there is no `DataFormatDescriptor` for the given `MimeType`.

_Experimental:_ This function is an experimental feature that is subject to change or removal from
future versions of DataWeave.

_Introduced in DataWeave version 2.7.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>mimeType</code></p></td><td><p><code>dw::module::Mime::MimeType</code></p></td><td><p>The MIME type value to search.</p></td></tr></tbody></table>

### Example

This example searches for a JSON `DataFormatDescriptor` and an unknown `DataFormatDescriptor`.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
output application/json

var jsonDF = findDataFormatDescriptorByMime({'type': "*", subtype: "json", parameters: {}})
var unknownDF = findDataFormatDescriptorByMime({'type': "*", subtype: "*", parameters: {}})

fun simplify(df: DataFormatDescriptor | Null) = df  match {
  case d is DataFormatDescriptor -> { name: d.name, defaultMimeType: d.defaultMimeType }
  case is Null -> { name: "unknown", defaultMimeType: "unknown" }
}
---
{
  json: simplify(jsonDF),
  unknown: simplify(unknownDF)
}
```

#### Output

```Json
{
  "json": {
    "name": "json",
    "defaultMimeType": "application/json"
  },
  "unknown": {
    "name": "unknown",
    "defaultMimeType": "unknown"
  }
}
```

<!-- document id=38bf8fad8c74d981dac92caf1bbd5cabf0335e331f848350849baac5ad623103 url=/mulesoft/current/en-us/dataweave/2.12/dw-runtime-functions-finddataformatdescriptorbymime.md -->

---
product: DataWeave
version: 2.12
---

# findDataFormatDescriptorByMime

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## findDataFormatDescriptorByMime(mime: dw::module::Mime::MimeType): DataFormatDescriptor | Null

Returns the `DataFormatDescriptor` based on the `dw::module::Mime::MimeType` specified or `null` if
there is no `DataFormatDescriptor` for the given `MimeType`.

_Experimental:_ This function is an experimental feature that is subject to change or removal from
future versions of DataWeave.

_Introduced in DataWeave version 2.7.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>mimeType</code></p></td><td><p><code>dw::module::Mime::MimeType</code></p></td><td><p>The MIME type value to search.</p></td></tr></tbody></table>

### Example

This example searches for a JSON `DataFormatDescriptor` and an unknown `DataFormatDescriptor`.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
output application/json

var jsonDF = findDataFormatDescriptorByMime({'type': "*", subtype: "json", parameters: {}})
var unknownDF = findDataFormatDescriptorByMime({'type': "*", subtype: "*", parameters: {}})

fun simplify(df: DataFormatDescriptor | Null) = df  match {
  case d is DataFormatDescriptor -> { name: d.name, defaultMimeType: d.defaultMimeType }
  case is Null -> { name: "unknown", defaultMimeType: "unknown" }
}
---
{
  json: simplify(jsonDF),
  unknown: simplify(unknownDF)
}
```

#### Output

```Json
{
  "json": {
    "name": "json",
    "defaultMimeType": "application/json"
  },
  "unknown": {
    "name": "unknown",
    "defaultMimeType": "unknown"
  }
}
```

<!-- document id=95112d8db81b3617b72f9b023784c3e8e2bab894e578d1ed25ca27725a0b0553 url=/mulesoft/current/en-us/dataweave/2.9/dw-runtime-functions-finddataformatdescriptorbymime.md -->

---
product: DataWeave
version: 2.9
---

# findDataFormatDescriptorByMime

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## findDataFormatDescriptorByMime(mime: dw::module::Mime::MimeType): DataFormatDescriptor | Null

Returns the `DataFormatDescriptor` based on the `dw::module::Mime::MimeType` specified or `null` if
there is no `DataFormatDescriptor` for the given `MimeType`.

_Experimental:_ This function is an experimental feature that is subject to change or removal from
future versions of DataWeave.

_Introduced in DataWeave version 2.7.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>mimeType</code></p></td><td><p><code>dw::module::Mime::MimeType</code></p></td><td><p>The MIME type value to search.</p></td></tr></tbody></table>

### Example

This example searches for a JSON `DataFormatDescriptor` and an unknown `DataFormatDescriptor`.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
output application/json

var jsonDF = findDataFormatDescriptorByMime({'type': "*", subtype: "json", parameters: {}})
var unknownDF = findDataFormatDescriptorByMime({'type': "*", subtype: "*", parameters: {}})

fun simplify(df: DataFormatDescriptor | Null) = df  match {
  case d is DataFormatDescriptor -> { name: d.name, defaultMimeType: d.defaultMimeType }
  case is Null -> { name: "unknown", defaultMimeType: "unknown" }
}
---
{
  json: simplify(jsonDF),
  unknown: simplify(unknownDF)
}
```

#### Output

```Json
{
  "json": {
    "name": "json",
    "defaultMimeType": "application/json"
  },
  "unknown": {
    "name": "unknown",
    "defaultMimeType": "unknown"
  }
}
```

<!-- document id=bc70fee7a4f8626decf6b357c9e09575788bcaf1029682f09dbc11edc94f86ea url=/mulesoft/current/en-us/dataweave/latest/dw-runtime-functions-finddataformatdescriptorbymime.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# findDataFormatDescriptorByMime

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## findDataFormatDescriptorByMime(mime: dw::module::Mime::MimeType): DataFormatDescriptor | Null

Returns the `DataFormatDescriptor` based on the `dw::module::Mime::MimeType` specified or `null` if
there is no `DataFormatDescriptor` for the given `MimeType`.

_Experimental:_ This function is an experimental feature that is subject to change or removal from
future versions of DataWeave.

_Introduced in DataWeave version 2.7.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>mimeType</code></p></td><td><p><code>dw::module::Mime::MimeType</code></p></td><td><p>The MIME type value to search.</p></td></tr></tbody></table>

### Example

This example searches for a JSON `DataFormatDescriptor` and an unknown `DataFormatDescriptor`.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
output application/json

var jsonDF = findDataFormatDescriptorByMime({'type': "*", subtype: "json", parameters: {}})
var unknownDF = findDataFormatDescriptorByMime({'type': "*", subtype: "*", parameters: {}})

fun simplify(df: DataFormatDescriptor | Null) = df  match {
  case d is DataFormatDescriptor -> { name: d.name, defaultMimeType: d.defaultMimeType }
  case is Null -> { name: "unknown", defaultMimeType: "unknown" }
}
---
{
  json: simplify(jsonDF),
  unknown: simplify(unknownDF)
}
```

#### Output

```Json
{
  "json": {
    "name": "json",
    "defaultMimeType": "application/json"
  },
  "unknown": {
    "name": "unknown",
    "defaultMimeType": "unknown"
  }
}
```

<!-- document id=820dc0270b8df768af9bbdc06f90772c8d82bbce812e5a042f9dfe916dc40402 url=/mulesoft/current/en-us/dataweave/2.11/dw-strings-functions-first.md -->

---
product: DataWeave
version: 2.11
---

# first

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## first(text: String, amount: Number): String

Returns characters from the beginning of a string to the specified number of characters in the
string, for example, the first two characters of a string.

If the number is equal to or greater than the number of characters in the string, the function
returns the entire string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to process.</p></td></tr><tr><td><p><code>amount</code></p></td><td><p>The number of characters to return. Negative numbers and <code>0</code> return an empty string. Decimals are rounded down to the nearest whole number.</p></td></tr></tbody></table>

### Example

This example returns the first five characters from a string.

#### Source

```DataWeave
%dw 2.0
import first from dw::core::Strings
output application/json
---
"hello world!" first 5
```

#### Output

```Json
"hello"
```

## first(text: Null, amount: Any): Null

Helper function that enables `first` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=1aa6af614b839ed7d03e1b257745fcf3154357191c2997ebaccc3a7ed4d62763 url=/mulesoft/current/en-us/dataweave/2.12/dw-strings-functions-first.md -->

---
product: DataWeave
version: 2.12
---

# first

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## first(text: String, amount: Number): String

Returns characters from the beginning of a string to the specified number of characters in the
string, for example, the first two characters of a string.

If the number is equal to or greater than the number of characters in the string, the function
returns the entire string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to process.</p></td></tr><tr><td><p><code>amount</code></p></td><td><p>The number of characters to return. Negative numbers and <code>0</code> return an empty string. Decimals are rounded down to the nearest whole number.</p></td></tr></tbody></table>

### Example

This example returns the first five characters from a string.

#### Source

```DataWeave
%dw 2.0
import first from dw::core::Strings
output application/json
---
"hello world!" first 5
```

#### Output

```Json
"hello"
```

## first(text: Null, amount: Any): Null

Helper function that enables `first` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=cfe2508fd253b065ef1d381ce29a55904baeb82db0f9f23c4879f15cbd0a3c29 url=/mulesoft/current/en-us/dataweave/2.4/dw-strings-functions-first.md -->

---
product: DataWeave
version: 2.4
---

# first

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## first(text: String, amount: Number): String

Returns characters from the beginning of a string to the specified number of characters in the
string, for example, the first two characters of a string.

If the number is equal to or greater than the number of characters in the string, the function
returns the entire string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to process.</p></td></tr><tr><td><p><code>amount</code></p></td><td><p>The number of characters to return. Negative numbers and <code>0</code> return an empty string. Decimals are rounded down to the nearest whole number.</p></td></tr></tbody></table>

### Example

This example returns the first five characters from a string.

#### Source

```DataWeave
%dw 2.0
import first from dw::core::Strings
output application/json
---
"hello world!" first 5
```

#### Output

```Json
"hello"
```

## first(text: Null, amount: Any): Null

Helper function that enables `first` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=4ed409e3f805954ad9a1ce81f6976ae61cab8b8ef1a3633cc4f75a8c78d887d5 url=/mulesoft/current/en-us/dataweave/2.6/dw-strings-functions-first.md -->

---
product: DataWeave
version: 2.6
---

# first

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## first(text: String, amount: Number): String

Returns characters from the beginning of a string to the specified number of characters in the
string, for example, the first two characters of a string.

If the number is equal to or greater than the number of characters in the string, the function
returns the entire string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to process.</p></td></tr><tr><td><p><code>amount</code></p></td><td><p>The number of characters to return. Negative numbers and <code>0</code> return an empty string. Decimals are rounded down to the nearest whole number.</p></td></tr></tbody></table>

### Example

This example returns the first five characters from a string.

#### Source

```DataWeave
%dw 2.0
import first from dw::core::Strings
output application/json
---
"hello world!" first 5
```

#### Output

```Json
"hello"
```

## first(text: Null, amount: Any): Null

Helper function that enables `first` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=7078c461ba2495cc0157ed29b44349c7483cd98e6ab018b81f4b96f9fa3bd134 url=/mulesoft/current/en-us/dataweave/2.9/dw-strings-functions-first.md -->

---
product: DataWeave
version: 2.9
---

# first

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## first(text: String, amount: Number): String

Returns characters from the beginning of a string to the specified number of characters in the
string, for example, the first two characters of a string.

If the number is equal to or greater than the number of characters in the string, the function
returns the entire string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to process.</p></td></tr><tr><td><p><code>amount</code></p></td><td><p>The number of characters to return. Negative numbers and <code>0</code> return an empty string. Decimals are rounded down to the nearest whole number.</p></td></tr></tbody></table>

### Example

This example returns the first five characters from a string.

#### Source

```DataWeave
%dw 2.0
import first from dw::core::Strings
output application/json
---
"hello world!" first 5
```

#### Output

```Json
"hello"
```

## first(text: Null, amount: Any): Null

Helper function that enables `first` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=d2ed0bc987cf2295f8719ce9009f76a3986bafe6774e1de1d208696b94a17902 url=/mulesoft/current/en-us/dataweave/latest/dw-strings-functions-first.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# first

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## first(text: String, amount: Number): String

Returns characters from the beginning of a string to the specified number of characters in the
string, for example, the first two characters of a string.

If the number is equal to or greater than the number of characters in the string, the function
returns the entire string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to process.</p></td></tr><tr><td><p><code>amount</code></p></td><td><p>The number of characters to return. Negative numbers and <code>0</code> return an empty string. Decimals are rounded down to the nearest whole number.</p></td></tr></tbody></table>

### Example

This example returns the first five characters from a string.

#### Source

```DataWeave
%dw 2.0
import first from dw::core::Strings
output application/json
---
"hello world!" first 5
```

#### Output

```Json
"hello"
```

## first(text: Null, amount: Any): Null

Helper function that enables `first` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=b5c35886be73271a9427612d9621a21891edb27149b7ad84c8539e842b12867e url=/mulesoft/current/en-us/dataweave/2.11/dw-arrays-functions-firstwith.md -->

---
product: DataWeave
version: 2.11
---

# firstWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## firstWith<T>(array: Array<T>, condition: (item: T, index: Number) -> Boolean): T | Null

Returns the first element that satisfies the condition, or returns `null` if no element meets the
condition.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements to search.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition to satisfy.</p></td></tr></tbody></table>

### Example

This example shows how `firstWith` behaves when an element matches and when an element does not
match.

#### Source

```DataWeave
%dw 2.0
output application/json
import firstWith from dw::core::Arrays
var users = [{name: "Mariano", lastName: "Achaval"}, {name: "Ana", lastName: "Felisatti"}, {name: "Mariano", lastName: "de Sousa"}]
---
{
  a: users firstWith ((user, index) -> user.name == "Mariano"),
  b: users firstWith ((user, index) -> user.name == "Peter")
}
```

#### Output

```Json
{
  "a": {
    "name": "Mariano",
    "lastName": "Achaval"
  },
  "b": null
}
```

## firstWith(array: Null, condition: (item: Nothing, index: Nothing) -> Any): Null

Helper function that enables `firstWith` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=9a4cc18d19c4aed38baa7c70ee3b82dc967efbea80aa0409bc922b17fcc7cac5 url=/mulesoft/current/en-us/dataweave/2.12/dw-arrays-functions-firstwith.md -->

---
product: DataWeave
version: 2.12
---

# firstWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## firstWith<T>(array: Array<T>, condition: (item: T, index: Number) -> Boolean): T | Null

Returns the first element that satisfies the condition, or returns `null` if no element meets the
condition.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements to search.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition to satisfy.</p></td></tr></tbody></table>

### Example

This example shows how `firstWith` behaves when an element matches and when an element does not
match.

#### Source

```DataWeave
%dw 2.0
output application/json
import firstWith from dw::core::Arrays
var users = [{name: "Mariano", lastName: "Achaval"}, {name: "Ana", lastName: "Felisatti"}, {name: "Mariano", lastName: "de Sousa"}]
---
{
  a: users firstWith ((user, index) -> user.name == "Mariano"),
  b: users firstWith ((user, index) -> user.name == "Peter")
}
```

#### Output

```Json
{
  "a": {
    "name": "Mariano",
    "lastName": "Achaval"
  },
  "b": null
}
```

## firstWith(array: Null, condition: (item: Nothing, index: Nothing) -> Any): Null

Helper function that enables `firstWith` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=2f13526bd759c22a9337f668ee113a67b21f59c762af810aa1bdf406a92d50c6 url=/mulesoft/current/en-us/dataweave/2.3/dw-arrays-functions-firstwith.md -->

---
product: DataWeave
version: 2.3
---

# firstWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## firstWith(Array<T>, (item: T, index: Number) -> Boolean): T | Null

Returns the first element that satisfies the condition, or returns `null` if no element meets the
condition.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>array</p></td><td><p>The array of elements to search.</p></td></tr><tr><td><p>condition</p></td><td><p>The condition to satisfy.</p></td></tr></tbody></table>

### Example

This example shows how `firstWith` behaves when an element matches and when an element does not
match.

#### Source

```DataWeave
%dw 2.0
output application/json
import firstWith from dw::core::Arrays
var users = [{name: "Mariano", lastName: "Achaval"}, {name: "Ana", lastName: "Felisatti"}, {name: "Mariano", lastName: "de Sousa"}]
---
{
  a: users firstWith ((user, index) -> user.name == "Mariano"),
  b: users firstWith ((user, index) -> user.name == "Peter")
}
```

#### Output

```Json
{
  "a": {
    "name": "Mariano",
    "lastName": "Achaval"
  },
  "b": null
}
```

<!-- document id=c965c9efab00c0843be90926bd437ac21f39d0f92dec8637af0c79b13049494e url=/mulesoft/current/en-us/dataweave/2.4/dw-arrays-functions-firstwith.md -->

---
product: DataWeave
version: 2.4
---

# firstWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## firstWith<T>(array: Array<T>, condition: (item: T, index: Number) -> Boolean): T | Null

Returns the first element that satisfies the condition, or returns `null` if no element meets the
condition.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements to search.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition to satisfy.</p></td></tr></tbody></table>

### Example

This example shows how `firstWith` behaves when an element matches and when an element does not
match.

#### Source

```DataWeave
%dw 2.0
output application/json
import firstWith from dw::core::Arrays
var users = [{name: "Mariano", lastName: "Achaval"}, {name: "Ana", lastName: "Felisatti"}, {name: "Mariano", lastName: "de Sousa"}]
---
{
  a: users firstWith ((user, index) -> user.name == "Mariano"),
  b: users firstWith ((user, index) -> user.name == "Peter")
}
```

#### Output

```Json
{
  "a": {
    "name": "Mariano",
    "lastName": "Achaval"
  },
  "b": null
}
```

## firstWith(array: Null, condition: (item: Nothing, index: Nothing) -> Any): Null

Helper function that enables `firstWith` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=ed963ceeab99199c285bf1bc5629041d28dbaa8821b42fc58baae24e3b53f449 url=/mulesoft/current/en-us/dataweave/2.6/dw-arrays-functions-firstwith.md -->

---
product: DataWeave
version: 2.6
---

# firstWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## firstWith<T>(array: Array<T>, condition: (item: T, index: Number) -> Boolean): T | Null

Returns the first element that satisfies the condition, or returns `null` if no element meets the
condition.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements to search.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition to satisfy.</p></td></tr></tbody></table>

### Example

This example shows how `firstWith` behaves when an element matches and when an element does not
match.

#### Source

```DataWeave
%dw 2.0
output application/json
import firstWith from dw::core::Arrays
var users = [{name: "Mariano", lastName: "Achaval"}, {name: "Ana", lastName: "Felisatti"}, {name: "Mariano", lastName: "de Sousa"}]
---
{
  a: users firstWith ((user, index) -> user.name == "Mariano"),
  b: users firstWith ((user, index) -> user.name == "Peter")
}
```

#### Output

```Json
{
  "a": {
    "name": "Mariano",
    "lastName": "Achaval"
  },
  "b": null
}
```

## firstWith(array: Null, condition: (item: Nothing, index: Nothing) -> Any): Null

Helper function that enables `firstWith` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=d2b26218f4fb637a37e0e6265d04f017cf6874e9ce4f622a1fff0dfc78b69cc7 url=/mulesoft/current/en-us/dataweave/2.9/dw-arrays-functions-firstwith.md -->

---
product: DataWeave
version: 2.9
---

# firstWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## firstWith<T>(array: Array<T>, condition: (item: T, index: Number) -> Boolean): T | Null

Returns the first element that satisfies the condition, or returns `null` if no element meets the
condition.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements to search.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition to satisfy.</p></td></tr></tbody></table>

### Example

This example shows how `firstWith` behaves when an element matches and when an element does not
match.

#### Source

```DataWeave
%dw 2.0
output application/json
import firstWith from dw::core::Arrays
var users = [{name: "Mariano", lastName: "Achaval"}, {name: "Ana", lastName: "Felisatti"}, {name: "Mariano", lastName: "de Sousa"}]
---
{
  a: users firstWith ((user, index) -> user.name == "Mariano"),
  b: users firstWith ((user, index) -> user.name == "Peter")
}
```

#### Output

```Json
{
  "a": {
    "name": "Mariano",
    "lastName": "Achaval"
  },
  "b": null
}
```

## firstWith(array: Null, condition: (item: Nothing, index: Nothing) -> Any): Null

Helper function that enables `firstWith` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=60e02c3e233172543354b067dacbe477ceaa18718042f769d56af964a1331e7b url=/mulesoft/current/en-us/dataweave/latest/dw-arrays-functions-firstwith.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# firstWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## firstWith<T>(array: Array<T>, condition: (item: T, index: Number) -> Boolean): T | Null

Returns the first element that satisfies the condition, or returns `null` if no element meets the
condition.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements to search.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition to satisfy.</p></td></tr></tbody></table>

### Example

This example shows how `firstWith` behaves when an element matches and when an element does not
match.

#### Source

```DataWeave
%dw 2.0
output application/json
import firstWith from dw::core::Arrays
var users = [{name: "Mariano", lastName: "Achaval"}, {name: "Ana", lastName: "Felisatti"}, {name: "Mariano", lastName: "de Sousa"}]
---
{
  a: users firstWith ((user, index) -> user.name == "Mariano"),
  b: users firstWith ((user, index) -> user.name == "Peter")
}
```

#### Output

```Json
{
  "a": {
    "name": "Mariano",
    "lastName": "Achaval"
  },
  "b": null
}
```

## firstWith(array: Null, condition: (item: Nothing, index: Nothing) -> Any): Null

Helper function that enables `firstWith` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=aa779549909d4bec63da30504ac40c37134acd5753ece5f76cc235bd2fe62c54 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-formats-fixedwidth.md -->

---
product: DataWeave
version: 2.11
---

# Fixed Width Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME Type: `application/flatfile`

ID: `flatfile`

Fixed width types are technically considered a type of Flat File format, but when selecting this
option, the Transform component offers you settings that are better tailored to the needs of this
format.

> [!NOTE] Fixed width in DataWeave supports files of up to 15 MB, and the memory requirement is
> roughly 40 to 1. For example, a 1-MB file requires up to 40 MB of memory to process, so it’s
> important to consider this memory requirement in conjunction with your TPS needs for large fixed
> width files. This is not an exact figure; the value might vary according to the complexity of the
> mapping instructions.

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>allowLenientWithBinaryNotEndElement</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>When the schema contains elements of type Binary or Packed, the <code>lenient</code> option does not allow short records, regardless of the last element’s format type. When you set this property to <code>true</code>, the validation applies only to cases in which the record ends with type Binary or Packed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>enforceRequires</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Produces an error when set to <code>true</code> if a required value is missing.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>missingValues</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Fill character used to represent missing values. To activate a non-default setting, set the <code>useMissCharAsDefaultForFill</code> property to <code>true</code>, and use one of the following values to <code>missingValues</code>:</p></div><div><ul><li><p><code>none</code> (for the reader) or <code>NONE</code> (for the writer): Treats all data as values.</p></li><li><p><code>spaces</code> (for the reader) or <code>SPACES</code> (for the writer): Interprets a field consisting of only spaces as a missing value. Default for flat file and fixed-width formats.</p></li><li><p><code>zeroes</code> (for the reader) or <code>ZEROES</code> (for the writer): Interprets numeric fields consisting of only <code>0</code> characters <em>and</em> character fields consisting of only spaces as missing values.</p></li><li><p><code>nulls</code> (for the reader) or <code>NULLS</code> (for the writer): Interprets a field consisting only of <code>0</code> bytes as a missing value. Default for COBOL copybook schema.</p></li></ul></div></div></td></tr><tr><td><p><code>notTruncateDependingOnSubjectNotPresent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Fills the entire group when the DEPENDING ON subject is not present.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>recordParsing</code></p></td><td><p><code>String</code></p></td><td><p><code>'strict'</code></p></td><td><div><div><p>Specifies the expected type of separation between lines or records:</p></div><div><ul><li><p><code>strict</code>: Line break is expected at exact end of each record. <code>strict</code> is the default.</p></li><li><p><code>lenient</code>: Line break is used, but records can be shorter or longer than the schema specifies. Do not use <code>lenient</code> if your payload lacks line breaks. The other options to <code>recordParsing</code> support records that lack line breaks.</p></li><li><p><code>noTerminator</code>: Records follow one another with no separation. This option is preferred for fixed-length records that lack a line break.</p></li><li><p><code>singleRecord</code>: The entire input is a single record.</p></li></ul></div><div><p>Note that schemas with type <code>Binary</code> or <code>Packed</code> don’t allow for line break detection, so setting <code>recordParsing</code> to <code>lenient</code> only allows long records to be handled, not short ones. These schemas also currently only work with certain single-byte character encodings (so not with UTF-8 or any multibyte format).</p></div></div></td></tr><tr><td><p><code>retainEmptyStringFieldsOnParsing</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Allow parsing behavior to keep missing string value fields with a default value in the output map</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>schemaPath</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Path to the schema definition. Specifies the location in your local disk of the schema file that parses your input.</p></div></div></td></tr><tr><td><p><code>segmentIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Segment identifier in the schema for fixed-width or COBOL copybook schemas. Required when parsing a single segment or record definition if the schema includes multiple segment definitions.</p></div></div></td></tr><tr><td><p><code>structureIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Structure identifier in the schema for flat file schemas. Required when parsing a structure definition if the schema includes multiple structure definitions.</p></div></div></td></tr><tr><td><p><code>truncateDependingOn</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, truncates DEPENDING ON values to the length used.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>useMissCharAsDefaultForFill</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>By default, the flat file reader and writer use spaces for missing characters and ignore the setting of the <code>missingValues</code> property. When you set this property to <code>true</code>, DataWeave honors the setting of the <code>missingValues property</code>. Introduced in DataWeave 2.3 (2.3.0-20210823) for the September 2021 release of Mule 4.3.0-20210823.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>zonedDecimalStrict</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, uses the 'strict' ASCII form of sign encoding for zoned decimal values.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr><tr><td><p><code>enforceRequires</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Produces an error when set to <code>true</code> if a required value is missing.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>missingValues</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Fill character used to represent missing values. To activate a non-default setting, set the <code>useMissCharAsDefaultForFill</code> property to <code>true</code>, and use one of the following values to <code>missingValues</code>:</p></div><div><ul><li><p><code>none</code> (for the reader) or <code>NONE</code> (for the writer): Treats all data as values.</p></li><li><p><code>spaces</code> (for the reader) or <code>SPACES</code> (for the writer): Interprets a field consisting of only spaces as a missing value. Default for flat file and fixed-width formats.</p></li><li><p><code>zeroes</code> (for the reader) or <code>ZEROES</code> (for the writer): Interprets numeric fields consisting of only <code>0</code> characters <em>and</em> character fields consisting of only spaces as missing values.</p></li><li><p><code>nulls</code> (for the reader) or <code>NULLS</code> (for the writer): Interprets a field consisting only of <code>0</code> bytes as a missing value. Default for COBOL copybook schema.</p></li></ul></div></div></td></tr><tr><td><p><code>notTruncateDependingOnSubjectNotPresent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Fills the entire group when the DEPENDING ON subject is not present.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>recordTerminator</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Line break for a record separator. Valid values: <code>lf</code>, <code>cr</code>, <code>crlf</code>, <code>none</code>. Note that in Mule versions 4.0.4 and later, this is only used as a separator when there are multiple records. Values translate directly to character codes (<code>none</code> leaves no termination on each record).</p></div></div></td></tr><tr><td><p><code>schemaPath</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Path to the schema definition. Specifies the location in your local disk of the schema file that parses your input.</p></div></div></td></tr><tr><td><p><code>segmentIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Segment identifier in the schema for fixed-width or COBOL copybook schemas. Required when parsing a single segment or record definition if the schema includes multiple segment definitions.</p></div></div></td></tr><tr><td><p><code>structureIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Structure identifier in the schema for flat file schemas. Required when parsing a structure definition if the schema includes multiple structure definitions.</p></div></div></td></tr><tr><td><p><code>trimValues</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Trim values that are longer than the width of a field.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>truncateDependingOn</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, truncates DEPENDING ON values to the length used.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>useMissCharAsDefaultForFill</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>By default, the flat file reader and writer use spaces for missing characters and ignore the setting of the <code>missingValues</code> property. When you set this property to <code>true</code>, DataWeave honors the setting of the <code>missingValues property</code>. Introduced in DataWeave 2.3 (2.3.0-20210823) for the September 2021 release of Mule 4.3.0-20210823.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>zonedDecimalStrict</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, uses the 'strict' ASCII form of sign encoding for zoned decimal values.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types (for Fixed Width)

The Fixed Width format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/flatfile</code></p></td></tr></tbody></table>

<!-- document id=1a3b85bb8fb7b5b2b65c6824ed9833d3d3543c0877394249db28479f3ca4e770 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-formats-fixedwidth.md -->

---
product: DataWeave
version: 2.12
---

# Fixed Width Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME Type: `application/flatfile`

ID: `flatfile`

Fixed width types are technically considered a type of Flat File format, but when selecting this
option, the Transform component offers you settings that are better tailored to the needs of this
format.

> [!NOTE] Fixed width in DataWeave supports files of up to 15 MB, and the memory requirement is
> roughly 40 to 1. For example, a 1-MB file requires up to 40 MB of memory to process, so it’s
> important to consider this memory requirement in conjunction with your TPS needs for large fixed
> width files. This is not an exact figure; the value might vary according to the complexity of the
> mapping instructions.

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>allowLenientWithBinaryNotEndElement</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>When the schema contains elements of type Binary or Packed, the <code>lenient</code> option does not allow short records, regardless of the last element’s format type. When you set this property to <code>true</code>, the validation applies only to cases in which the record ends with type Binary or Packed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>enforceRequires</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Produces an error when set to <code>true</code> if a required value is missing.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>missingValues</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Fill character used to represent missing values. To activate a non-default setting, set the <code>useMissCharAsDefaultForFill</code> property to <code>true</code>, and use one of the following values to <code>missingValues</code>:</p></div><div><ul><li><p><code>none</code> (for the reader) or <code>NONE</code> (for the writer): Treats all data as values.</p></li><li><p><code>spaces</code> (for the reader) or <code>SPACES</code> (for the writer): Interprets a field consisting of only spaces as a missing value. Default for flat file and fixed-width formats.</p></li><li><p><code>zeroes</code> (for the reader) or <code>ZEROES</code> (for the writer): Interprets numeric fields consisting of only <code>0</code> characters <em>and</em> character fields consisting of only spaces as missing values.</p></li><li><p><code>nulls</code> (for the reader) or <code>NULLS</code> (for the writer): Interprets a field consisting only of <code>0</code> bytes as a missing value. Default for COBOL copybook schema.</p></li></ul></div></div></td></tr><tr><td><p><code>notTruncateDependingOnSubjectNotPresent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Fills the entire group when the DEPENDING ON subject is not present.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>recordParsing</code></p></td><td><p><code>String</code></p></td><td><p><code>'strict'</code></p></td><td><div><div><p>Specifies the expected type of separation between lines or records:</p></div><div><ul><li><p><code>strict</code>: Line break is expected at exact end of each record. <code>strict</code> is the default.</p></li><li><p><code>lenient</code>: Line break is used, but records can be shorter or longer than the schema specifies. Do not use <code>lenient</code> if your payload lacks line breaks. The other options to <code>recordParsing</code> support records that lack line breaks.</p></li><li><p><code>noTerminator</code>: Records follow one another with no separation. This option is preferred for fixed-length records that lack a line break.</p></li><li><p><code>singleRecord</code>: The entire input is a single record.</p></li></ul></div><div><p>Note that schemas with type <code>Binary</code> or <code>Packed</code> don’t allow for line break detection, so setting <code>recordParsing</code> to <code>lenient</code> only allows long records to be handled, not short ones. These schemas also currently only work with certain single-byte character encodings (so not with UTF-8 or any multibyte format).</p></div></div></td></tr><tr><td><p><code>retainEmptyStringFieldsOnParsing</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Allow parsing behavior to keep missing string value fields with a default value in the output map</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>schemaPath</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Path to the schema definition. Specifies the location in your local disk of the schema file that parses your input.</p></div></div></td></tr><tr><td><p><code>segmentIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Segment identifier in the schema for fixed-width or COBOL copybook schemas. Required when parsing a single segment or record definition if the schema includes multiple segment definitions.</p></div></div></td></tr><tr><td><p><code>structureIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Structure identifier in the schema for flat file schemas. Required when parsing a structure definition if the schema includes multiple structure definitions.</p></div></div></td></tr><tr><td><p><code>truncateDependingOn</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, truncates DEPENDING ON values to the length used.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>useMissCharAsDefaultForFill</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>By default, the flat file reader and writer use spaces for missing characters and ignore the setting of the <code>missingValues</code> property. When you set this property to <code>true</code>, DataWeave honors the setting of the <code>missingValues property</code>. Introduced in DataWeave 2.3 (2.3.0-20210823) for the September 2021 release of Mule 4.3.0-20210823.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>zonedDecimalStrict</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, uses the 'strict' ASCII form of sign encoding for zoned decimal values.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr><tr><td><p><code>enforceRequires</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Produces an error when set to <code>true</code> if a required value is missing.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>missingValues</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Fill character used to represent missing values. To activate a non-default setting, set the <code>useMissCharAsDefaultForFill</code> property to <code>true</code>, and use one of the following values to <code>missingValues</code>:</p></div><div><ul><li><p><code>none</code> (for the reader) or <code>NONE</code> (for the writer): Treats all data as values.</p></li><li><p><code>spaces</code> (for the reader) or <code>SPACES</code> (for the writer): Interprets a field consisting of only spaces as a missing value. Default for flat file and fixed-width formats.</p></li><li><p><code>zeroes</code> (for the reader) or <code>ZEROES</code> (for the writer): Interprets numeric fields consisting of only <code>0</code> characters <em>and</em> character fields consisting of only spaces as missing values.</p></li><li><p><code>nulls</code> (for the reader) or <code>NULLS</code> (for the writer): Interprets a field consisting only of <code>0</code> bytes as a missing value. Default for COBOL copybook schema.</p></li></ul></div></div></td></tr><tr><td><p><code>notTruncateDependingOnSubjectNotPresent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Fills the entire group when the DEPENDING ON subject is not present.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>recordTerminator</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Line break for a record separator. Valid values: <code>lf</code>, <code>cr</code>, <code>crlf</code>, <code>none</code>. Note that in Mule versions 4.0.4 and later, this is only used as a separator when there are multiple records. Values translate directly to character codes (<code>none</code> leaves no termination on each record).</p></div></div></td></tr><tr><td><p><code>schemaPath</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Path to the schema definition. Specifies the location in your local disk of the schema file that parses your input.</p></div></div></td></tr><tr><td><p><code>segmentIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Segment identifier in the schema for fixed-width or COBOL copybook schemas. Required when parsing a single segment or record definition if the schema includes multiple segment definitions.</p></div></div></td></tr><tr><td><p><code>structureIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Structure identifier in the schema for flat file schemas. Required when parsing a structure definition if the schema includes multiple structure definitions.</p></div></div></td></tr><tr><td><p><code>trimValues</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Trim values that are longer than the width of a field.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>truncateDependingOn</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, truncates DEPENDING ON values to the length used.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>useMissCharAsDefaultForFill</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>By default, the flat file reader and writer use spaces for missing characters and ignore the setting of the <code>missingValues</code> property. When you set this property to <code>true</code>, DataWeave honors the setting of the <code>missingValues property</code>. Introduced in DataWeave 2.3 (2.3.0-20210823) for the September 2021 release of Mule 4.3.0-20210823.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>zonedDecimalStrict</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, uses the 'strict' ASCII form of sign encoding for zoned decimal values.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types (for Fixed Width)

The Fixed Width format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/flatfile</code></p></td></tr></tbody></table>

<!-- document id=22ecb4be12f0e12c836b11432c235f1d000a69789beed45ff6f6fee909bec5ed url=/mulesoft/current/en-us/dataweave/2.3/dataweave-formats-fixedwidth.md -->

---
product: DataWeave
version: 2.3
---

# Fixed Width Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME Type: `application/flatfile`

ID: `flatfile`

Fixed width types are technically considered a type of Flat File format, but when selecting this
option, the Transform component offers you settings that are better tailored to the needs of this
format.

> [!NOTE] Fixed width in DataWeave supports files of up to 15 MB, and the memory requirement is
> roughly 40 to 1. For example, a 1-MB file requires up to 40 MB of memory to process, so it’s
> important to consider this memory requirement in conjunction with your TPS needs for large fixed
> width files. This is not an exact figure; the value might vary according to the complexity of the
> mapping instructions.

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

DataWeave accepts properties that provide instructions for reading input data in this format.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>allowLenientWithBinaryNotEndElement</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>When the schema contains elements of type Binary or Packed, the <code>lenient</code> option does not allow short records, regardless of the last element’s format type. When you set this property to <code>true</code>, the validation applies only to cases in which the record ends with type Binary or Packed.</p></div></div></td></tr><tr><td><p><code>enforceRequires</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Error if required value missing. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>missingValues</code></p></td><td><p><code>String</code></p></td><td><p><code>nulls</code> for copybook schema, <code>spaces</code> otherwise</p></td><td><div><div><p>Fill character used to represent missing values. To activate a non-default setting, set the <code>useMissCharAsDefaultForFill</code> property to <code>true</code>, and use one of the following values to <code>missingValues</code>:</p></div><div><ul><li><p><code>none</code>: Treat all data as actual values</p></li><li><p><code>spaces</code>: Interpret a field consisting of only spaces as a missing value</p></li><li><p><code>zeroes</code>: Interpret numeric fields consisting of only '0' characters and character fields consisting of only spaces as missing values</p></li><li><p><code>nulls</code>: Interpret a field consisting only of 0 bytes as a missing value</p></li></ul></div></div></td></tr><tr><td><p><code>notTruncateDependingOnSubjectNotPresent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Fills the entire group when the DEPENDING ON subject is not present. <em>Introduced in DataWeave 2.3 with the August 2021 release of Mule 4.3.0-20210622.</em></p></div></div></td></tr><tr><td><p><code>recordParsing</code></p></td><td><p><code>String</code></p></td><td><p><code>strict</code></p></td><td><div><div><p>Expected separation between lines/records:</p></div><div><ul><li><p><code>strict</code>: Line break expected at exact end of each record.</p></li><li><p><code>lenient</code>: Line break is used, but records can be shorter or longer than the schema specifies. Do not use <code>lenient</code> if your payload lacks line breaks. The other options to <code>recordParsing</code> support records that lack line breaks.</p></li><li><p><code>noTerminator</code>: Records follow one another with no separation. This option is preferred for fixed-length records that lack a line break.</p></li><li><p><code>singleRecord</code>: Entire input is a single record.</p></li></ul></div><div><p>Note that schemas with type <code>Binary</code> or <code>Packed</code> don’t allow for line break detection, so setting <code>recordParsing</code> to <code>lenient</code> only allows long records to be handled, not short ones. These schemas also currently only work with certain single-byte character encodings (so not with UTF-8 or any multibyte format).</p></div></div></td></tr><tr><td><p><code>schemaPath</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Schema definition. Location in your local disk of the schema file used to parse your input.</p></div></div></td></tr><tr><td><p><code>segmentIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Segment identifier in the schema for fixed width or copybook schemas (only needed when parsing a single segment/record definition and if the schema includes multiple segment definitions).</p></div></div></td></tr><tr><td><p><code>structureIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Structure identifier in schema for flatfile schemas (only needed when parsing a structure definition, and if the schema includes multiple structure definitions)</p></div></div></td></tr><tr><td><p><code>truncateDependingOn</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Truncate COBOL copybook DEPENDING ON values to the length used. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>useMissCharAsDefaultForFill</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>By default, the flat file reader and writer use spaces for missing characters and ignore the setting of the <code>missingValues</code> property. When you set this property to <code>true</code>, the reader honors the setting of the <code>missingValues</code> property. <em>Introduced in DataWeave 2.3 (2.3.0-20210823) for the September 2021 release of Mule 4.3.0-20210823.</em> Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>zonedDecimalStrict</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Use the <code>strict</code> ASCII form of sign encoding for COBOL copybook zoned decimal values. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

DataWeave accepts properties that provide instructions for writing output data in this format.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>When set to <code>true</code>, DataWeave generates the output as a data stream, and the script’s execution is deferred until it is consumed. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Encoding to be used by this writer, such as <code>UTF-8</code>.</p></div></div></td></tr><tr><td><p><code>enforceRequires</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Error if a required value is missing. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>missingValues</code></p></td><td><p><code>String</code></p></td><td><p><code>NULLS</code> for copybook schema, <code>SPACES</code> otherwise</p></td><td><div><div><p>Fill character used to represent missing values. To activate a non-default setting, use <code>useMissCharAsDefaultForFill</code>, and use one of the following values to <code>missingValues</code>:</p></div><div><ul><li><p><code>NONE</code>: Write nothing for missing values.</p></li><li><p><code>SPACES</code>: Fill the field with spaces.</p></li><li><p><code>ZEROES</code>: Fill numeric fields with <code>0</code> characters and character fields with space characters.</p></li><li><p><code>NULLS</code>: Fill the field with 0 bytes.</p></li></ul></div></div></td></tr><tr><td><p><code>notTruncateDependingOnSubjectNotPresent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Fills the entire group when the DEPENDING ON subject is not present. <em>Introduced in DataWeave 2.3 with the August 2021 release of Mule 4.3.0-20210622.</em></p></div></div></td></tr><tr><td><p><code>recordTerminator</code></p></td><td><p><code>String</code></p></td><td><p>System property <code>line.separator</code></p></td><td><div><div><p>Record separator line break. Valid values:</p></div><div><ul><li><p><code>lf</code></p></li><li><p><code>cr</code></p></li><li><p><code>crlf</code></p></li><li><p><code>none</code></p></li></ul></div><div><p>Note that in Mule versions 4.0.4 and later, this is only used as a separator when there are multiple records. Values translate directly to character codes (<code>none</code> leaves no termination on each record).</p></div></div></td></tr><tr><td><p><code>retainEmptyStringFieldsOnParsing</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>When set to <code>true</code>, this property makes the reader retain fields that lack values and set their values to an empty string. <em>Introduced in the January 2023 version of DataWeave 2.3 for Mule version 4.3.0-20221212.</em></p></div></div></td></tr><tr><td><p><code>schemaPath</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Schema definition. Path where the schema file to be used is located.</p></div></div></td></tr><tr><td><p><code>segmentIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Segment identifier in the schema for fixed width or copybook schemas (only needed when writing a single segment/record definition, and if the schema includes multiple segment definitions).</p></div></div></td></tr><tr><td><p><code>structureIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Structure identifier in schema for flatfile schemas (only needed when writing a structure definition and if the schema includes multiple structure definitions).</p></div></div></td></tr><tr><td><p><code>trimValues</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Trim string values that are longer than the field width by truncating trailing characters. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>truncateDependingOn</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Truncate COBOL copybook DEPENDING ON values to the length used. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>useMissCharAsDefaultForFill</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>By default, the flat file reader and writer use spaces for missing characters and ignore the setting of the <code>missingValues</code> property. When you set this property to <code>true</code>, the writer honors the setting of the <code>missingValues</code> property. <em>Introduced in DataWeave 2.3 (2.3.0-20210823) for the September 2021 release of Mule 4.3.0-20210823.</em></p></div></div></td></tr><tr><td><p><code>zonedDecimalStrict</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Use the <code>strict</code> ASCII form of sign encoding for COBOL copybook zoned decimal values. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types (for Fixed Width)

The Fixed Width format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/flatfile</code></p></td></tr></tbody></table>

<!-- document id=c16beed269d75bd3d6e9bbc7c8bb628e1e8d98fb0d8a6e86ee20fb656e9afb75 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-formats-fixedwidth.md -->

---
product: DataWeave
version: 2.4
---

# Fixed Width Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME Type: `application/flatfile`

ID: `flatfile`

Fixed width types are technically considered a type of Flat File format, but when selecting this
option, the Transform component offers you settings that are better tailored to the needs of this
format.

> [!NOTE] Fixed width in DataWeave supports files of up to 15 MB, and the memory requirement is
> roughly 40 to 1. For example, a 1-MB file requires up to 40 MB of memory to process, so it’s
> important to consider this memory requirement in conjunction with your TPS needs for large fixed
> width files. This is not an exact figure; the value might vary according to the complexity of the
> mapping instructions.

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

DataWeave accepts properties that provide instructions for reading input data in this format.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>allowLenientWithBinaryNotEndElement</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>When the schema contains elements of type Binary or Packed, the <code>lenient</code> option does not allow short records, regardless of the last element’s format type. When you set this property to <code>true</code>, the validation applies only to cases in which the record ends with type Binary or Packed.</p></div></div></td></tr><tr><td><p><code>enforceRequires</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Error if required value missing. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>missingValues</code></p></td><td><p><code>String</code></p></td><td><p><code>nulls</code> for copybook schema, <code>spaces</code> otherwise</p></td><td><div><div><p>Fill character used to represent missing values. To activate a non-default setting, set the <code>useMissCharAsDefaultForFill</code> property to <code>true</code>, and use one of the following values to <code>missingValues</code>:</p></div><div><ul><li><p><code>none</code>: Treat all data as actual values</p></li><li><p><code>spaces</code>: Interpret a field consisting of only spaces as a missing value</p></li><li><p><code>zeroes</code>: Interpret numeric fields consisting of only '0' characters and character fields consisting of only spaces as missing values</p></li><li><p><code>nulls</code>: Interpret a field consisting only of 0 bytes as a missing value</p></li></ul></div></div></td></tr><tr><td><p><code>notTruncateDependingOnSubjectNotPresent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Fills the entire group when the DEPENDING ON subject is not present. <em>Introduced in DataWeave 2.3 with the August 2021 release of Mule 4.3.0-20210622.</em></p></div></div></td></tr><tr><td><p><code>recordParsing</code></p></td><td><p><code>String</code></p></td><td><p><code>strict</code></p></td><td><div><div><p>Expected separation between lines/records:</p></div><div><ul><li><p><code>strict</code>: Line break expected at exact end of each record.</p></li><li><p><code>lenient</code>: Line break is used, but records can be shorter or longer than the schema specifies. Do not use <code>lenient</code> if your payload lacks line breaks. The other options to <code>recordParsing</code> support records that lack line breaks.</p></li><li><p><code>noTerminator</code>: Records follow one another with no separation. This option is preferred for fixed-length records that lack a line break.</p></li><li><p><code>singleRecord</code>: Entire input is a single record.</p></li></ul></div><div><p>Note that schemas with type <code>Binary</code> or <code>Packed</code> don’t allow for line break detection, so setting <code>recordParsing</code> to <code>lenient</code> only allows long records to be handled, not short ones. These schemas also currently only work with certain single-byte character encodings (so not with UTF-8 or any multibyte format).</p></div></div></td></tr><tr><td><p><code>schemaPath</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Schema definition. Location in your local disk of the schema file used to parse your input.</p></div></div></td></tr><tr><td><p><code>segmentIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Segment identifier in the schema for fixed width or copybook schemas (only needed when parsing a single segment/record definition and if the schema includes multiple segment definitions).</p></div></div></td></tr><tr><td><p><code>structureIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Structure identifier in schema for flatfile schemas (only needed when parsing a structure definition, and if the schema includes multiple structure definitions)</p></div></div></td></tr><tr><td><p><code>truncateDependingOn</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Truncate COBOL copybook DEPENDING ON values to the length used. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>useMissCharAsDefaultForFill</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>By default, the flat file reader and writer use spaces for missing characters and ignore the setting of the <code>missingValues</code> property. When you set this property to <code>true</code>, the reader honors the setting of the <code>missingValues</code> property. <em>Introduced in DataWeave 2.3 (2.3.0-20210823) for the September 2021 release of Mule 4.3.0-20210823.</em> Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>zonedDecimalStrict</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Use the <code>strict</code> ASCII form of sign encoding for COBOL copybook zoned decimal values. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

DataWeave accepts properties that provide instructions for writing output data in this format.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>When set to <code>true</code>, DataWeave generates the output as a data stream, and the script’s execution is deferred until it is consumed. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Encoding to be used by this writer, such as <code>UTF-8</code>.</p></div></div></td></tr><tr><td><p><code>enforceRequires</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Error if a required value is missing. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>missingValues</code></p></td><td><p><code>String</code></p></td><td><p><code>NULLS</code> for copybook schema, <code>SPACES</code> otherwise</p></td><td><div><div><p>Fill character used to represent missing values. To activate a non-default setting, use <code>useMissCharAsDefaultForFill</code>, and use one of the following values to <code>missingValues</code>:</p></div><div><ul><li><p><code>NONE</code>: Write nothing for missing values.</p></li><li><p><code>SPACES</code>: Fill the field with spaces.</p></li><li><p><code>ZEROES</code>: Fill numeric fields with <code>0</code> characters and character fields with space characters.</p></li><li><p><code>NULLS</code>: Fill the field with 0 bytes.</p></li></ul></div></div></td></tr><tr><td><p><code>notTruncateDependingOnSubjectNotPresent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Fills the entire group when the DEPENDING ON subject is not present. <em>Introduced in DataWeave 2.3 with the August 2021 release of Mule 4.3.0-20210622.</em></p></div></div></td></tr><tr><td><p><code>recordTerminator</code></p></td><td><p><code>String</code></p></td><td><p>System property <code>line.separator</code></p></td><td><div><div><p>Record separator line break. Valid values:</p></div><div><ul><li><p><code>lf</code></p></li><li><p><code>cr</code></p></li><li><p><code>crlf</code></p></li><li><p><code>none</code></p></li></ul></div><div><p>Note that in Mule versions 4.0.4 and later, this is only used as a separator when there are multiple records. Values translate directly to character codes. (<code>none</code> leaves no termination on each record).</p></div></div></td></tr><tr><td><p><code>retainEmptyStringFieldsOnParsing</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>When set to <code>true</code>, this property makes the reader retain fields that lack values and set their values to an empty string. The default behavior of the reader is to remove those fields. <em>Introduced in the January 2023 version of DataWeave 2.4 for Mule version 4.4.0-20230102.</em></p></div></div></td></tr><tr><td><p><code>schemaPath</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Schema definition. Path where the schema file to be used is located.</p></div></div></td></tr><tr><td><p><code>segmentIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Segment identifier in the schema for fixed width or copybook schemas (only needed when writing a single segment/record definition, and if the schema includes multiple segment definitions).</p></div></div></td></tr><tr><td><p><code>structureIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Structure identifier in schema for flatfile schemas (only needed when writing a structure definition and if the schema includes multiple structure definitions)</p></div></div></td></tr><tr><td><p><code>trimValues</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Trim string values longer than the field length by truncating trailing characters. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>trimValues</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Indicates whether trim values are longer than the field width. Valid Options are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>truncateDependingOn</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Truncate COBOL copybook DEPENDING ON values to the length used. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>useMissCharAsDefaultForFill</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>By default, the flat file reader and writer use spaces for missing characters and ignore the setting of the <code>missingValues</code> property. When you set this property to <code>true</code>, the writer honors the setting of the <code>missingValues</code> property. <em>Introduced in DataWeave 2.3 (2.3.0-20210823) for the September 2021 release of Mule 4.3.0-20210823.</em></p></div></div></td></tr><tr><td><p><code>zonedDecimalStrict</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Use the <code>strict</code> ASCII form of sign encoding for COBOL copybook zoned decimal values. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types (for Fixed Width)

The Fixed Width format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/flatfile</code></p></td></tr></tbody></table>

<!-- document id=f34eefeaefe7e5704038998a094dac805996d4a7d996381e83347919129f2b66 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-formats-fixedwidth.md -->

---
product: DataWeave
version: 2.6
---

# Fixed Width Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME Type: `application/flatfile`

ID: `flatfile`

Fixed width types are technically considered a type of Flat File format, but when selecting this
option, the Transform component offers you settings that are better tailored to the needs of this
format.

> [!NOTE] Fixed width in DataWeave supports files of up to 15 MB, and the memory requirement is
> roughly 40 to 1. For example, a 1-MB file requires up to 40 MB of memory to process, so it’s
> important to consider this memory requirement in conjunction with your TPS needs for large fixed
> width files. This is not an exact figure; the value might vary according to the complexity of the
> mapping instructions.

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>allowLenientWithBinaryNotEndElement</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>When the schema contains elements of type Binary or Packed, the <code>lenient</code> option does not allow short records, regardless of the last element’s format type. When you set this property to <code>true</code>, the validation applies only to cases in which the record ends with type Binary or Packed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>enforceRequires</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Produces an error when set to <code>true</code> if a required value is missing.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>missingValues</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Fill character used to represent missing values. To activate a non-default setting, set the <code>useMissCharAsDefaultForFill</code> property to <code>true</code>, and use one of the following values to <code>missingValues</code>:</p></div><div><ul><li><p><code>none</code> (for the reader) or <code>NONE</code> (for the writer): Treats all data as values.</p></li><li><p><code>spaces</code> (for the reader) or <code>SPACES</code> (for the writer): Interprets a field consisting of only spaces as a missing value. Default for flat file and fixed-width formats.</p></li><li><p><code>zeroes</code> (for the reader) or <code>ZEROES</code> (for the writer): Interprets numeric fields consisting of only <code>0</code> characters <em>and</em> character fields consisting of only spaces as missing values.</p></li><li><p><code>nulls</code> (for the reader) or <code>NULLS</code> (for the writer): Interprets a field consisting only of <code>0</code> bytes as a missing value. Default for COBOL copybook schema.</p></li></ul></div></div></td></tr><tr><td><p><code>notTruncateDependingOnSubjectNotPresent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Fills the entire group when the DEPENDING ON subject is not present.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>recordParsing</code></p></td><td><p><code>String</code></p></td><td><p><code>'strict'</code></p></td><td><div><div><p>Specifies the expected type of separation between lines or records:</p></div><div><ul><li><p><code>strict</code>: Line break is expected at exact end of each record. <code>strict</code> is the default.</p></li><li><p><code>lenient</code>: Line break is used, but records can be shorter or longer than the schema specifies. Do not use <code>lenient</code> if your payload lacks line breaks. The other options to <code>recordParsing</code> support records that lack line breaks.</p></li><li><p><code>noTerminator</code>: Records follow one another with no separation. This option is preferred for fixed-length records that lack a line break.</p></li><li><p><code>singleRecord</code>: The entire input is a single record.</p></li></ul></div><div><p>Note that schemas with type <code>Binary</code> or <code>Packed</code> don’t allow for line break detection, so setting <code>recordParsing</code> to <code>lenient</code> only allows long records to be handled, not short ones. These schemas also currently only work with certain single-byte character encodings (so not with UTF-8 or any multibyte format).</p></div></div></td></tr><tr><td><p><code>retainEmptyStringFieldsOnParsing</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Allow parsing behavior to keep missing string value fields with a default value in the output map</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>schemaPath</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Path to the schema definition. Specifies the location in your local disk of the schema file that parses your input.</p></div></div></td></tr><tr><td><p><code>segmentIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Segment identifier in the schema for fixed-width or COBOL copybook schemas. Required when parsing a single segment or record definition if the schema includes multiple segment definitions.</p></div></div></td></tr><tr><td><p><code>structureIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Structure identifier in the schema for flat file schemas. Required when parsing a structure definition if the schema includes multiple structure definitions.</p></div></div></td></tr><tr><td><p><code>truncateDependingOn</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, truncates DEPENDING ON values to the length used.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>useMissCharAsDefaultForFill</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>By default, the flat file reader and writer use spaces for missing characters and ignore the setting of the <code>missingValues</code> property. When you set this property to <code>true</code>, DataWeave honors the setting of the <code>missingValues property</code>. Introduced in DataWeave 2.3 (2.3.0-20210823) for the September 2021 release of Mule 4.3.0-20210823.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>zonedDecimalStrict</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, uses the 'strict' ASCII form of sign encoding for zoned decimal values.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr><tr><td><p><code>enforceRequires</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Produces an error when set to <code>true</code> if a required value is missing.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>missingValues</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Fill character used to represent missing values. To activate a non-default setting, set the <code>useMissCharAsDefaultForFill</code> property to <code>true</code>, and use one of the following values to <code>missingValues</code>:</p></div><div><ul><li><p><code>none</code> (for the reader) or <code>NONE</code> (for the writer): Treats all data as values.</p></li><li><p><code>spaces</code> (for the reader) or <code>SPACES</code> (for the writer): Interprets a field consisting of only spaces as a missing value. Default for flat file and fixed-width formats.</p></li><li><p><code>zeroes</code> (for the reader) or <code>ZEROES</code> (for the writer): Interprets numeric fields consisting of only <code>0</code> characters <em>and</em> character fields consisting of only spaces as missing values.</p></li><li><p><code>nulls</code> (for the reader) or <code>NULLS</code> (for the writer): Interprets a field consisting only of <code>0</code> bytes as a missing value. Default for COBOL copybook schema.</p></li></ul></div></div></td></tr><tr><td><p><code>notTruncateDependingOnSubjectNotPresent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Fills the entire group when the DEPENDING ON subject is not present.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>recordTerminator</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Line break for a record separator. Valid values: <code>lf</code>, <code>cr</code>, <code>crlf</code>, <code>none</code>. Note that in Mule versions 4.0.4 and later, this is only used as a separator when there are multiple records. Values translate directly to character codes (<code>none</code> leaves no termination on each record).</p></div></div></td></tr><tr><td><p><code>schemaPath</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Path to the schema definition. Specifies the location in your local disk of the schema file that parses your input.</p></div></div></td></tr><tr><td><p><code>segmentIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Segment identifier in the schema for fixed-width or COBOL copybook schemas. Required when parsing a single segment or record definition if the schema includes multiple segment definitions.</p></div></div></td></tr><tr><td><p><code>structureIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Structure identifier in the schema for flat file schemas. Required when parsing a structure definition if the schema includes multiple structure definitions.</p></div></div></td></tr><tr><td><p><code>trimValues</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Trim values that are longer than the width of a field.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>truncateDependingOn</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, truncates DEPENDING ON values to the length used.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>useMissCharAsDefaultForFill</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>By default, the flat file reader and writer use spaces for missing characters and ignore the setting of the <code>missingValues</code> property. When you set this property to <code>true</code>, DataWeave honors the setting of the <code>missingValues property</code>. Introduced in DataWeave 2.3 (2.3.0-20210823) for the September 2021 release of Mule 4.3.0-20210823.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>zonedDecimalStrict</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, uses the 'strict' ASCII form of sign encoding for zoned decimal values.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types (for Fixed Width)

The Fixed Width format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/flatfile</code></p></td></tr></tbody></table>

<!-- document id=4591b9aa4b430da134983f1f9b07f2cf0d1c1d363fc83f5384dc0c76b0e1bd80 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-formats-fixedwidth.md -->

---
product: DataWeave
version: 2.9
---

# Fixed Width Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME Type: `application/flatfile`

ID: `flatfile`

Fixed width types are technically considered a type of Flat File format, but when selecting this
option, the Transform component offers you settings that are better tailored to the needs of this
format.

> [!NOTE] Fixed width in DataWeave supports files of up to 15 MB, and the memory requirement is
> roughly 40 to 1. For example, a 1-MB file requires up to 40 MB of memory to process, so it’s
> important to consider this memory requirement in conjunction with your TPS needs for large fixed
> width files. This is not an exact figure; the value might vary according to the complexity of the
> mapping instructions.

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>allowLenientWithBinaryNotEndElement</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>When the schema contains elements of type Binary or Packed, the <code>lenient</code> option does not allow short records, regardless of the last element’s format type. When you set this property to <code>true</code>, the validation applies only to cases in which the record ends with type Binary or Packed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>enforceRequires</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Produces an error when set to <code>true</code> if a required value is missing.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>missingValues</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Fill character used to represent missing values. To activate a non-default setting, set the <code>useMissCharAsDefaultForFill</code> property to <code>true</code>, and use one of the following values to <code>missingValues</code>:</p></div><div><ul><li><p><code>none</code> (for the reader) or <code>NONE</code> (for the writer): Treats all data as values.</p></li><li><p><code>spaces</code> (for the reader) or <code>SPACES</code> (for the writer): Interprets a field consisting of only spaces as a missing value. Default for flat file and fixed-width formats.</p></li><li><p><code>zeroes</code> (for the reader) or <code>ZEROES</code> (for the writer): Interprets numeric fields consisting of only <code>0</code> characters <em>and</em> character fields consisting of only spaces as missing values.</p></li><li><p><code>nulls</code> (for the reader) or <code>NULLS</code> (for the writer): Interprets a field consisting only of <code>0</code> bytes as a missing value. Default for COBOL copybook schema.</p></li></ul></div></div></td></tr><tr><td><p><code>notTruncateDependingOnSubjectNotPresent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Fills the entire group when the DEPENDING ON subject is not present.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>recordParsing</code></p></td><td><p><code>String</code></p></td><td><p><code>'strict'</code></p></td><td><div><div><p>Specifies the expected type of separation between lines or records:</p></div><div><ul><li><p><code>strict</code>: Line break is expected at exact end of each record. <code>strict</code> is the default.</p></li><li><p><code>lenient</code>: Line break is used, but records can be shorter or longer than the schema specifies. Do not use <code>lenient</code> if your payload lacks line breaks. The other options to <code>recordParsing</code> support records that lack line breaks.</p></li><li><p><code>noTerminator</code>: Records follow one another with no separation. This option is preferred for fixed-length records that lack a line break.</p></li><li><p><code>singleRecord</code>: The entire input is a single record.</p></li></ul></div><div><p>Note that schemas with type <code>Binary</code> or <code>Packed</code> don’t allow for line break detection, so setting <code>recordParsing</code> to <code>lenient</code> only allows long records to be handled, not short ones. These schemas also currently only work with certain single-byte character encodings (so not with UTF-8 or any multibyte format).</p></div></div></td></tr><tr><td><p><code>retainEmptyStringFieldsOnParsing</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Allow parsing behavior to keep missing string value fields with a default value in the output map</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>schemaPath</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Path to the schema definition. Specifies the location in your local disk of the schema file that parses your input.</p></div></div></td></tr><tr><td><p><code>segmentIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Segment identifier in the schema for fixed-width or COBOL copybook schemas. Required when parsing a single segment or record definition if the schema includes multiple segment definitions.</p></div></div></td></tr><tr><td><p><code>structureIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Structure identifier in the schema for flat file schemas. Required when parsing a structure definition if the schema includes multiple structure definitions.</p></div></div></td></tr><tr><td><p><code>truncateDependingOn</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, truncates DEPENDING ON values to the length used.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>useMissCharAsDefaultForFill</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>By default, the flat file reader and writer use spaces for missing characters and ignore the setting of the <code>missingValues</code> property. When you set this property to <code>true</code>, DataWeave honors the setting of the <code>missingValues property</code>. Introduced in DataWeave 2.3 (2.3.0-20210823) for the September 2021 release of Mule 4.3.0-20210823.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>zonedDecimalStrict</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, uses the 'strict' ASCII form of sign encoding for zoned decimal values.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr><tr><td><p><code>enforceRequires</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Produces an error when set to <code>true</code> if a required value is missing.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>missingValues</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Fill character used to represent missing values. To activate a non-default setting, set the <code>useMissCharAsDefaultForFill</code> property to <code>true</code>, and use one of the following values to <code>missingValues</code>:</p></div><div><ul><li><p><code>none</code> (for the reader) or <code>NONE</code> (for the writer): Treats all data as values.</p></li><li><p><code>spaces</code> (for the reader) or <code>SPACES</code> (for the writer): Interprets a field consisting of only spaces as a missing value. Default for flat file and fixed-width formats.</p></li><li><p><code>zeroes</code> (for the reader) or <code>ZEROES</code> (for the writer): Interprets numeric fields consisting of only <code>0</code> characters <em>and</em> character fields consisting of only spaces as missing values.</p></li><li><p><code>nulls</code> (for the reader) or <code>NULLS</code> (for the writer): Interprets a field consisting only of <code>0</code> bytes as a missing value. Default for COBOL copybook schema.</p></li></ul></div></div></td></tr><tr><td><p><code>notTruncateDependingOnSubjectNotPresent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Fills the entire group when the DEPENDING ON subject is not present.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>recordTerminator</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Line break for a record separator. Valid values: <code>lf</code>, <code>cr</code>, <code>crlf</code>, <code>none</code>. Note that in Mule versions 4.0.4 and later, this is only used as a separator when there are multiple records. Values translate directly to character codes (<code>none</code> leaves no termination on each record).</p></div></div></td></tr><tr><td><p><code>schemaPath</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Path to the schema definition. Specifies the location in your local disk of the schema file that parses your input.</p></div></div></td></tr><tr><td><p><code>segmentIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Segment identifier in the schema for fixed-width or COBOL copybook schemas. Required when parsing a single segment or record definition if the schema includes multiple segment definitions.</p></div></div></td></tr><tr><td><p><code>structureIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Structure identifier in the schema for flat file schemas. Required when parsing a structure definition if the schema includes multiple structure definitions.</p></div></div></td></tr><tr><td><p><code>trimValues</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Trim values that are longer than the width of a field.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>truncateDependingOn</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, truncates DEPENDING ON values to the length used.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>useMissCharAsDefaultForFill</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>By default, the flat file reader and writer use spaces for missing characters and ignore the setting of the <code>missingValues</code> property. When you set this property to <code>true</code>, DataWeave honors the setting of the <code>missingValues property</code>. Introduced in DataWeave 2.3 (2.3.0-20210823) for the September 2021 release of Mule 4.3.0-20210823.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>zonedDecimalStrict</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, uses the 'strict' ASCII form of sign encoding for zoned decimal values.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types (for Fixed Width)

The Fixed Width format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/flatfile</code></p></td></tr></tbody></table>

<!-- document id=58454d75c701c3b29f01d1e8d55f6aa120733fe3ab504d8541ac89be7007ee07 url=/mulesoft/current/en-us/dataweave/latest/dataweave-formats-fixedwidth.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Fixed Width Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME Type: `application/flatfile`

ID: `flatfile`

Fixed width types are technically considered a type of Flat File format, but when selecting this
option, the Transform component offers you settings that are better tailored to the needs of this
format.

> [!NOTE] Fixed width in DataWeave supports files of up to 15 MB, and the memory requirement is
> roughly 40 to 1. For example, a 1-MB file requires up to 40 MB of memory to process, so it’s
> important to consider this memory requirement in conjunction with your TPS needs for large fixed
> width files. This is not an exact figure; the value might vary according to the complexity of the
> mapping instructions.

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>allowLenientWithBinaryNotEndElement</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>When the schema contains elements of type Binary or Packed, the <code>lenient</code> option does not allow short records, regardless of the last element’s format type. When you set this property to <code>true</code>, the validation applies only to cases in which the record ends with type Binary or Packed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>enforceRequires</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Produces an error when set to <code>true</code> if a required value is missing.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>missingValues</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Fill character used to represent missing values. To activate a non-default setting, set the <code>useMissCharAsDefaultForFill</code> property to <code>true</code>, and use one of the following values to <code>missingValues</code>:</p></div><div><ul><li><p><code>none</code> (for the reader) or <code>NONE</code> (for the writer): Treats all data as values.</p></li><li><p><code>spaces</code> (for the reader) or <code>SPACES</code> (for the writer): Interprets a field consisting of only spaces as a missing value. Default for flat file and fixed-width formats.</p></li><li><p><code>zeroes</code> (for the reader) or <code>ZEROES</code> (for the writer): Interprets numeric fields consisting of only <code>0</code> characters <em>and</em> character fields consisting of only spaces as missing values.</p></li><li><p><code>nulls</code> (for the reader) or <code>NULLS</code> (for the writer): Interprets a field consisting only of <code>0</code> bytes as a missing value. Default for COBOL copybook schema.</p></li></ul></div></div></td></tr><tr><td><p><code>notTruncateDependingOnSubjectNotPresent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Fills the entire group when the DEPENDING ON subject is not present.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>recordParsing</code></p></td><td><p><code>String</code></p></td><td><p><code>'strict'</code></p></td><td><div><div><p>Specifies the expected type of separation between lines or records:</p></div><div><ul><li><p><code>strict</code>: Line break is expected at exact end of each record. <code>strict</code> is the default.</p></li><li><p><code>lenient</code>: Line break is used, but records can be shorter or longer than the schema specifies. Do not use <code>lenient</code> if your payload lacks line breaks. The other options to <code>recordParsing</code> support records that lack line breaks.</p></li><li><p><code>noTerminator</code>: Records follow one another with no separation. This option is preferred for fixed-length records that lack a line break.</p></li><li><p><code>singleRecord</code>: The entire input is a single record.</p></li></ul></div><div><p>Note that schemas with type <code>Binary</code> or <code>Packed</code> don’t allow for line break detection, so setting <code>recordParsing</code> to <code>lenient</code> only allows long records to be handled, not short ones. These schemas also currently only work with certain single-byte character encodings (so not with UTF-8 or any multibyte format).</p></div></div></td></tr><tr><td><p><code>retainEmptyStringFieldsOnParsing</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Allow parsing behavior to keep missing string value fields with a default value in the output map</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>schemaPath</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Path to the schema definition. Specifies the location in your local disk of the schema file that parses your input.</p></div></div></td></tr><tr><td><p><code>segmentIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Segment identifier in the schema for fixed-width or COBOL copybook schemas. Required when parsing a single segment or record definition if the schema includes multiple segment definitions.</p></div></div></td></tr><tr><td><p><code>structureIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Structure identifier in the schema for flat file schemas. Required when parsing a structure definition if the schema includes multiple structure definitions.</p></div></div></td></tr><tr><td><p><code>truncateDependingOn</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, truncates DEPENDING ON values to the length used.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>useMissCharAsDefaultForFill</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>By default, the flat file reader and writer use spaces for missing characters and ignore the setting of the <code>missingValues</code> property. When you set this property to <code>true</code>, DataWeave honors the setting of the <code>missingValues property</code>. Introduced in DataWeave 2.3 (2.3.0-20210823) for the September 2021 release of Mule 4.3.0-20210823.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>zonedDecimalStrict</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, uses the 'strict' ASCII form of sign encoding for zoned decimal values.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr><tr><td><p><code>enforceRequires</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Produces an error when set to <code>true</code> if a required value is missing.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>missingValues</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Fill character used to represent missing values. To activate a non-default setting, set the <code>useMissCharAsDefaultForFill</code> property to <code>true</code>, and use one of the following values to <code>missingValues</code>:</p></div><div><ul><li><p><code>none</code> (for the reader) or <code>NONE</code> (for the writer): Treats all data as values.</p></li><li><p><code>spaces</code> (for the reader) or <code>SPACES</code> (for the writer): Interprets a field consisting of only spaces as a missing value. Default for flat file and fixed-width formats.</p></li><li><p><code>zeroes</code> (for the reader) or <code>ZEROES</code> (for the writer): Interprets numeric fields consisting of only <code>0</code> characters <em>and</em> character fields consisting of only spaces as missing values.</p></li><li><p><code>nulls</code> (for the reader) or <code>NULLS</code> (for the writer): Interprets a field consisting only of <code>0</code> bytes as a missing value. Default for COBOL copybook schema.</p></li></ul></div></div></td></tr><tr><td><p><code>notTruncateDependingOnSubjectNotPresent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Fills the entire group when the DEPENDING ON subject is not present.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>recordTerminator</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Line break for a record separator. Valid values: <code>lf</code>, <code>cr</code>, <code>crlf</code>, <code>none</code>. Note that in Mule versions 4.0.4 and later, this is only used as a separator when there are multiple records. Values translate directly to character codes (<code>none</code> leaves no termination on each record).</p></div></div></td></tr><tr><td><p><code>schemaPath</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Path to the schema definition. Specifies the location in your local disk of the schema file that parses your input.</p></div></div></td></tr><tr><td><p><code>segmentIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Segment identifier in the schema for fixed-width or COBOL copybook schemas. Required when parsing a single segment or record definition if the schema includes multiple segment definitions.</p></div></div></td></tr><tr><td><p><code>structureIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Structure identifier in the schema for flat file schemas. Required when parsing a structure definition if the schema includes multiple structure definitions.</p></div></div></td></tr><tr><td><p><code>trimValues</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Trim values that are longer than the width of a field.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>truncateDependingOn</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, truncates DEPENDING ON values to the length used.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>useMissCharAsDefaultForFill</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>By default, the flat file reader and writer use spaces for missing characters and ignore the setting of the <code>missingValues</code> property. When you set this property to <code>true</code>, DataWeave honors the setting of the <code>missingValues property</code>. Introduced in DataWeave 2.3 (2.3.0-20210823) for the September 2021 release of Mule 4.3.0-20210823.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>zonedDecimalStrict</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, uses the 'strict' ASCII form of sign encoding for zoned decimal values.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types (for Fixed Width)

The Fixed Width format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/flatfile</code></p></td></tr></tbody></table>

<!-- document id=d00f155b4e6195d84a1c97128ab5d879e717f1456c6fe0fd6ebfcccccb94512c url=/mulesoft/current/en-us/dataweave/2.11/dataweave-formats-flatfile.md -->

---
product: DataWeave
version: 2.11
keywords: format, flatfile, */flatfile, application/flatfile
---

# Flat File Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/flatfile`

ID: `flatfile`

The Flat File format supports multiple types of fixed width records within a single message. The
schema structure allows you to define how different record types are distinguished, and how the
records are logically grouped.

> [!NOTE] Flat File in DataWeave supports files of up to 15 MB, and the memory requirement is
> roughly 40 to 1. For example, a 1-MB file requires up to 40 MB of memory to process, so it’s
> important to consider this memory requirement in conjunction with your TPS needs for large flat
> files. This is not an exact figure; the value might vary according to the complexity of the
> mapping instructions.

## Example: Specify a Flat File Schema

This example shows a DataWeave script that outputs data in the Flat File format. Notice that it uses
the `schemaPath` and `structureIndent` writer properties.

```dataweave
%dw 2.0
output application/flatfile schemaPath="src/main/resources/test-data/QBReqRsp.esl", structureIdent="QBResponse"
---
payload
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>allowLenientWithBinaryNotEndElement</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>When the schema contains elements of type Binary or Packed, the <code>lenient</code> option does not allow short records, regardless of the last element’s format type. When you set this property to <code>true</code>, the validation applies only to cases in which the record ends with type Binary or Packed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>enforceRequires</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Produces an error when set to <code>true</code> if a required value is missing.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>missingValues</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Fill character used to represent missing values. To activate a non-default setting, set the <code>useMissCharAsDefaultForFill</code> property to <code>true</code>, and use one of the following values to <code>missingValues</code>:</p></div><div><ul><li><p><code>none</code> (for the reader) or <code>NONE</code> (for the writer): Treats all data as values.</p></li><li><p><code>spaces</code> (for the reader) or <code>SPACES</code> (for the writer): Interprets a field consisting of only spaces as a missing value. Default for flat file and fixed-width formats.</p></li><li><p><code>zeroes</code> (for the reader) or <code>ZEROES</code> (for the writer): Interprets numeric fields consisting of only <code>0</code> characters <em>and</em> character fields consisting of only spaces as missing values.</p></li><li><p><code>nulls</code> (for the reader) or <code>NULLS</code> (for the writer): Interprets a field consisting only of <code>0</code> bytes as a missing value. Default for COBOL copybook schema.</p></li></ul></div><div><p>Valid values are <code>none</code> or <code>spaces</code> or <code>zeroes</code> or <code>nulls</code>.</p></div></div></td></tr><tr><td><p><code>notTruncateDependingOnSubjectNotPresent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Fills the entire group when the DEPENDING ON subject is not present.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>recordParsing</code></p></td><td><p><code>String</code></p></td><td><p><code>'strict'</code></p></td><td><div><div><p>Specifies the expected type of separation between lines or records:</p></div><div><ul><li><p><code>strict</code>: Line break is expected at exact end of each record. <code>strict</code> is the default.</p></li><li><p><code>lenient</code>: Line break is used, but records can be shorter or longer than the schema specifies. Don’t use <code>lenient</code> if your payload lacks line breaks. The other options to <code>recordParsing</code> support records that lack line breaks.</p></li><li><p><code>noTerminator</code>: Records follow one another with no separation. This option is preferred for fixed-length records that lack a line break.</p></li><li><p><code>singleRecord</code>: The entire input is a single record.</p></li></ul></div><div><p>Note that schemas with type <code>Binary</code> or <code>Packed</code> don’t allow for line break detection, so setting <code>recordParsing</code> to <code>lenient</code> only allows long records to be handled, not short ones. These schemas also currently only work with certain single-byte character encodings (so not with UTF-8 or any multibyte format).</p></div><div><p>Valid values are <code>strict</code> or <code>lenient</code> or <code>noTerminator</code> or <code>singleRecord</code>.</p></div></div></td></tr><tr><td><p><code>retainEmptyStringFieldsOnParsing</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Allow parsing behavior to keep missing string value fields with a default value in the output map</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>schemaPath</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Path to the schema definition. Specifies the location in your local disk of the schema file that parses your input.</p></div></div></td></tr><tr><td><p><code>segmentIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Segment identifier in the schema for fixed-width or COBOL copybook schemas. Required when parsing a single segment or record definition if the schema includes multiple segment definitions.</p></div></div></td></tr><tr><td><p><code>structureIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Structure identifier in the schema for flat file schemas. Required when parsing a structure definition if the schema includes multiple structure definitions.</p></div></div></td></tr><tr><td><p><code>substituteCharacterAsMissingValue</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>If set to <code>true</code> and the <code>missingValues</code> property is set to <code>none</code>, with <code>useMissCharAsDefaultForFill</code> set to <code>true</code>, the flat file parser handles the <code>0x1A</code> (SUB) character as the missing value.<br>Otherwise, the flat file parser doesn’t handle the <code>0x1A</code> character as the missing value.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>truncateDependingOn</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, truncates DEPENDING ON values to the length used.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>useMissCharAsDefaultForFill</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>By default, the flat file reader and writer use spaces for missing characters and ignore the setting of the <code>missingValues</code> property. When you set this property to <code>true</code>, DataWeave honors the <code>missingValues property</code> setting. Introduced in DataWeave 2.3 (2.3.0-20210823) for the September 2021 release of Mule 4.3.0-20210823.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>zonedDecimalStrict</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, uses the 'strict' ASCII form of sign encoding for zoned decimal values.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr><tr><td><p><code>enforceRequires</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Produces an error when set to <code>true</code> if a required value is missing.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>fillRedefinesByMaxLength</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>If set to <code>true</code>, the flat file module fills the <code>Redefines</code> components that are considered to be missing values up to the maximum number of characters set in the <code>maxLength</code> parameter.<br>If set to <code>false</code>, the module uses all the defined view options to determine how to fill the <code>Redefines</code> components.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>missingValues</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Fill character used to represent missing values. To activate a non-default setting, set the <code>useMissCharAsDefaultForFill</code> property to <code>true</code>, and use one of the following values to <code>missingValues</code>:</p></div><div><ul><li><p><code>none</code> (for the reader) or <code>NONE</code> (for the writer): Treats all data as values.</p></li><li><p><code>spaces</code> (for the reader) or <code>SPACES</code> (for the writer): Interprets a field consisting of only spaces as a missing value. Default for flat file and fixed-width formats.</p></li><li><p><code>zeroes</code> (for the reader) or <code>ZEROES</code> (for the writer): Interprets numeric fields consisting of only <code>0</code> characters <em>and</em> character fields consisting of only spaces as missing values.</p></li><li><p><code>nulls</code> (for the reader) or <code>NULLS</code> (for the writer): Interprets a field consisting only of <code>0</code> bytes as a missing value. Default for COBOL copybook schema.</p></li></ul></div><div><p>Valid values are <code>none</code> or <code>spaces</code> or <code>zeroes</code> or <code>nulls</code>.</p></div></div></td></tr><tr><td><p><code>notTruncateDependingOnSubjectNotPresent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Fills the entire group when the DEPENDING ON subject is not present.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>recordTerminator</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Line break for a record separator. DataWeave uses this property as a separator only when there are multiple records. Values translate directly to character codes, and <code>none</code> leaves no termination on each record.</p></div><div><p>Valid values are <code>lf</code> or <code>cr</code> or <code>crlf</code> or <code>none</code>.</p></div></div></td></tr><tr><td><p><code>schemaPath</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Path to the schema definition. Specifies the location in your local disk of the schema file that parses your input.</p></div></div></td></tr><tr><td><p><code>segmentIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Segment identifier in the schema for fixed-width or COBOL copybook schemas. Required when parsing a single segment or record definition if the schema includes multiple segment definitions.</p></div></div></td></tr><tr><td><p><code>structureIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Structure identifier in the schema for flat file schemas. Required when parsing a structure definition if the schema includes multiple structure definitions.</p></div></div></td></tr><tr><td><p><code>trimValues</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Trim values that are longer than the width of a field.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>truncateDependingOn</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, truncates DEPENDING ON values to the length used.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>useMissCharAsDefaultForFill</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>By default, the flat file reader and writer use spaces for missing characters and ignore the setting of the <code>missingValues</code> property. When you set this property to <code>true</code>, DataWeave honors the <code>missingValues property</code> setting. Introduced in DataWeave 2.3 (2.3.0-20210823) for the September 2021 release of Mule 4.3.0-20210823.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>zonedDecimalStrict</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, uses the 'strict' ASCII form of sign encoding for zoned decimal values.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports this MIME type:

- `*/flatfile`

<!-- document id=4f5c8f83bda5efd7488d814f2fe2f8500b99ede7ee448ac8c63dbf394d9cc928 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-formats-flatfile.md -->

---
product: DataWeave
version: 2.12
keywords: format, flatfile, */flatfile, application/flatfile
---

# Flat File Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/flatfile`

ID: `flatfile`

The Flat File format supports multiple types of fixed width records within a single message. The
schema structure allows you to define how different record types are distinguished, and how the
records are logically grouped.

> [!NOTE] Flat File in DataWeave supports files of up to 15 MB, and the memory requirement is
> roughly 40 to 1. For example, a 1-MB file requires up to 40 MB of memory to process, so it’s
> important to consider this memory requirement in conjunction with your TPS needs for large flat
> files. This is not an exact figure; the value might vary according to the complexity of the
> mapping instructions.

## Example: Specify a Flat File Schema

This example shows a DataWeave script that outputs data in the Flat File format. Notice that it uses
the `schemaPath` and `structureIndent` writer properties.

```dataweave
%dw 2.0
output application/flatfile schemaPath="src/main/resources/test-data/QBReqRsp.esl", structureIdent="QBResponse"
---
payload
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>allowLenientWithBinaryNotEndElement</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>When the schema contains elements of type Binary or Packed, the <code>lenient</code> option does not allow short records, regardless of the last element’s format type. When you set this property to <code>true</code>, the validation applies only to cases in which the record ends with type Binary or Packed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>enforceRequires</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Produces an error when set to <code>true</code> if a required value is missing.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>missingValues</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Fill character used to represent missing values. To activate a non-default setting, set the <code>useMissCharAsDefaultForFill</code> property to <code>true</code>, and use one of the following values to <code>missingValues</code>:</p></div><div><ul><li><p><code>none</code> (for the reader) or <code>NONE</code> (for the writer): Treats all data as values.</p></li><li><p><code>spaces</code> (for the reader) or <code>SPACES</code> (for the writer): Interprets a field consisting of only spaces as a missing value. Default for flat file and fixed-width formats.</p></li><li><p><code>zeroes</code> (for the reader) or <code>ZEROES</code> (for the writer): Interprets numeric fields consisting of only <code>0</code> characters <em>and</em> character fields consisting of only spaces as missing values.</p></li><li><p><code>nulls</code> (for the reader) or <code>NULLS</code> (for the writer): Interprets a field consisting only of <code>0</code> bytes as a missing value. Default for COBOL copybook schema.</p></li></ul></div><div><p>Valid values are <code>none</code> or <code>spaces</code> or <code>zeroes</code> or <code>nulls</code>.</p></div></div></td></tr><tr><td><p><code>notTruncateDependingOnSubjectNotPresent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Fills the entire group when the DEPENDING ON subject is not present.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>recordParsing</code></p></td><td><p><code>String</code></p></td><td><p><code>'strict'</code></p></td><td><div><div><p>Specifies the expected type of separation between lines or records:</p></div><div><ul><li><p><code>strict</code>: Line break is expected at exact end of each record. <code>strict</code> is the default.</p></li><li><p><code>lenient</code>: Line break is used, but records can be shorter or longer than the schema specifies. Don’t use <code>lenient</code> if your payload lacks line breaks. The other options to <code>recordParsing</code> support records that lack line breaks.</p></li><li><p><code>noTerminator</code>: Records follow one another with no separation. This option is preferred for fixed-length records that lack a line break.</p></li><li><p><code>singleRecord</code>: The entire input is a single record.</p></li></ul></div><div><p>Note that schemas with type <code>Binary</code> or <code>Packed</code> don’t allow for line break detection, so setting <code>recordParsing</code> to <code>lenient</code> only allows long records to be handled, not short ones. These schemas also currently only work with certain single-byte character encodings (so not with UTF-8 or any multibyte format).</p></div><div><p>Valid values are <code>strict</code> or <code>lenient</code> or <code>noTerminator</code> or <code>singleRecord</code>.</p></div></div></td></tr><tr><td><p><code>retainEmptyStringFieldsOnParsing</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Allow parsing behavior to keep missing string value fields with a default value in the output map</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>schemaPath</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Path to the schema definition. Specifies the location in your local disk of the schema file that parses your input.</p></div></div></td></tr><tr><td><p><code>segmentIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Segment identifier in the schema for fixed-width or COBOL copybook schemas. Required when parsing a single segment or record definition if the schema includes multiple segment definitions.</p></div></div></td></tr><tr><td><p><code>structureIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Structure identifier in the schema for flat file schemas. Required when parsing a structure definition if the schema includes multiple structure definitions.</p></div></div></td></tr><tr><td><p><code>substituteCharacterAsMissingValue</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>If set to <code>true</code> and the <code>missingValues</code> property is set to <code>none</code>, with <code>useMissCharAsDefaultForFill</code> set to <code>true</code>, the flat file parser handles the <code>0x1A</code> (SUB) character as the missing value.<br>Otherwise, the flat file parser doesn’t handle the <code>0x1A</code> character as the missing value.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>truncateDependingOn</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, truncates DEPENDING ON values to the length used.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>useMissCharAsDefaultForFill</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>By default, the flat file reader and writer use spaces for missing characters and ignore the setting of the <code>missingValues</code> property. When you set this property to <code>true</code>, DataWeave honors the <code>missingValues property</code> setting. Introduced in DataWeave 2.3 (2.3.0-20210823) for the September 2021 release of Mule 4.3.0-20210823.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>zonedDecimalStrict</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, uses the 'strict' ASCII form of sign encoding for zoned decimal values.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr><tr><td><p><code>enforceRequires</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Produces an error when set to <code>true</code> if a required value is missing.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>fillRedefinesByMaxLength</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>If set to <code>true</code>, the flat file module fills the <code>Redefines</code> components that are considered to be missing values up to the maximum number of characters set in the <code>maxLength</code> parameter.<br>If set to <code>false</code>, the module uses all the defined view options to determine how to fill the <code>Redefines</code> components.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>missingValues</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Fill character used to represent missing values. To activate a non-default setting, set the <code>useMissCharAsDefaultForFill</code> property to <code>true</code>, and use one of the following values to <code>missingValues</code>:</p></div><div><ul><li><p><code>none</code> (for the reader) or <code>NONE</code> (for the writer): Treats all data as values.</p></li><li><p><code>spaces</code> (for the reader) or <code>SPACES</code> (for the writer): Interprets a field consisting of only spaces as a missing value. Default for flat file and fixed-width formats.</p></li><li><p><code>zeroes</code> (for the reader) or <code>ZEROES</code> (for the writer): Interprets numeric fields consisting of only <code>0</code> characters <em>and</em> character fields consisting of only spaces as missing values.</p></li><li><p><code>nulls</code> (for the reader) or <code>NULLS</code> (for the writer): Interprets a field consisting only of <code>0</code> bytes as a missing value. Default for COBOL copybook schema.</p></li></ul></div><div><p>Valid values are <code>none</code> or <code>spaces</code> or <code>zeroes</code> or <code>nulls</code>.</p></div></div></td></tr><tr><td><p><code>notTruncateDependingOnSubjectNotPresent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Fills the entire group when the DEPENDING ON subject is not present.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>recordTerminator</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Line break for a record separator. DataWeave uses this property as a separator only when there are multiple records. Values translate directly to character codes, and <code>none</code> leaves no termination on each record.</p></div><div><p>Valid values are <code>lf</code> or <code>cr</code> or <code>crlf</code> or <code>none</code>.</p></div></div></td></tr><tr><td><p><code>schemaPath</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Path to the schema definition. Specifies the location in your local disk of the schema file that parses your input.</p></div></div></td></tr><tr><td><p><code>segmentIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Segment identifier in the schema for fixed-width or COBOL copybook schemas. Required when parsing a single segment or record definition if the schema includes multiple segment definitions.</p></div></div></td></tr><tr><td><p><code>structureIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Structure identifier in the schema for flat file schemas. Required when parsing a structure definition if the schema includes multiple structure definitions.</p></div></div></td></tr><tr><td><p><code>trimValues</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Trim values that are longer than the width of a field.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>truncateDependingOn</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, truncates DEPENDING ON values to the length used.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>useMissCharAsDefaultForFill</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>By default, the flat file reader and writer use spaces for missing characters and ignore the setting of the <code>missingValues</code> property. When you set this property to <code>true</code>, DataWeave honors the <code>missingValues property</code> setting. Introduced in DataWeave 2.3 (2.3.0-20210823) for the September 2021 release of Mule 4.3.0-20210823.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>zonedDecimalStrict</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, uses the 'strict' ASCII form of sign encoding for zoned decimal values.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports this MIME type:

- `*/flatfile`

<!-- document id=3afc509175bc5ed2fc9759c20bfa40acffddfa1a612a7851ff3756c0d3345102 url=/mulesoft/current/en-us/dataweave/2.3/dataweave-formats-flatfile.md -->

---
product: DataWeave
version: 2.3
---

# Flat File Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME Type: `application/flatfile`

ID: `flatfile`

The Flat File format supports multiple types of fixed width records within a single message. The
schema structure allows you to define how different record types are distinguished, and how the
records are logically grouped.

> [!NOTE] Flat File in DataWeave supports files of up to 15 MB, and the memory requirement is
> roughly 40 to 1. For example, a 1-MB file requires up to 40 MB of memory to process, so it’s
> important to consider this memory requirement in conjunction with your TPS needs for large flat
> files. This is not an exact figure; the value might vary according to the complexity of the
> mapping instructions.

## Example: Specify a Flat File Schema

This example shows a DataWeave script that outputs data in the Flat File format. Notice that it uses
the `schemaPath` and `structureIndent` writer properties.

```dataweave
%dw 2.0
output application/flatfile schemaPath="src/main/resources/test-data/QBReqRsp.esl", structureIdent="QBResponse"
---
payload
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

DataWeave accepts properties that provide instructions for reading input data in this format.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>allowLenientWithBinaryNotEndElement</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>When the schema contains elements of type Binary or Packed, the <code>lenient</code> option does not allow short records, regardless of the last element’s format type. When you set this property to <code>true</code>, the validation applies only to cases in which the record ends with type Binary or Packed.</p></div></div></td></tr><tr><td><p><code>enforceRequires</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Error if required value missing. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>missingValues</code></p></td><td><p><code>String</code></p></td><td><p><code>nulls</code> for copybook schema, <code>spaces</code> otherwise</p></td><td><div><div><p>Fill character used to represent missing values. To activate a non-default setting, set the <code>useMissCharAsDefaultForFill</code> property to <code>true</code>, and use one of the following values to <code>missingValues</code>:</p></div><div><ul><li><p><code>none</code>: Treat all data as actual values</p></li><li><p><code>spaces</code>: Interpret a field consisting of only spaces as a missing value</p></li><li><p><code>zeroes</code>: Interpret numeric fields consisting of only '0' characters and character fields consisting of only spaces as missing values</p></li><li><p><code>nulls</code>: Interpret a field consisting only of 0 bytes as a missing value</p></li></ul></div></div></td></tr><tr><td><p><code>notTruncateDependingOnSubjectNotPresent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Fills the entire group when the DEPENDING ON subject is not present. <em>Introduced in DataWeave 2.3 with the August 2021 release of Mule 4.3.0-20210622.</em></p></div></div></td></tr><tr><td><p><code>recordParsing</code></p></td><td><p><code>String</code></p></td><td><p><code>strict</code></p></td><td><div><div><p>Expected separation between lines/records:</p></div><div><ul><li><p><code>strict</code>: Line break expected at exact end of each record.</p></li><li><p><code>lenient</code>: Line break is used, but records can be shorter or longer than the schema specifies. Do not use <code>lenient</code> if your payload lacks line breaks. The other options to <code>recordParsing</code> support records that lack line breaks.</p></li><li><p><code>noTerminator</code>: Records follow one another with no separation. This option is preferred for fixed-length records that lack a line break.</p></li><li><p><code>singleRecord</code>: Entire input is a single record.</p></li></ul></div><div><p>Note that schemas with type <code>Binary</code> or <code>Packed</code> don’t allow for line break detection, so setting <code>recordParsing</code> to <code>lenient</code> only allows long records to be handled, not short ones. These schemas also currently only work with certain single-byte character encodings (so not with UTF-8 or any multibyte format).</p></div></div></td></tr><tr><td><p><code>schemaPath</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Schema definition. Location in your local disk of the schema file used to parse your input.</p></div></div></td></tr><tr><td><p><code>segmentIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Segment identifier in the schema for fixed width or copybook schemas (only needed when parsing a single segment/record definition and if the schema includes multiple segment definitions).</p></div></div></td></tr><tr><td><p><code>structureIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Structure identifier in schema for flatfile schemas (only needed when parsing a structure definition, and if the schema includes multiple structure definitions)</p></div></div></td></tr><tr><td><p><code>truncateDependingOn</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Truncate COBOL copybook DEPENDING ON values to the length used. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>useMissCharAsDefaultForFill</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>By default, the flat file reader and writer use spaces for missing characters and ignore the setting of the <code>missingValues</code> property. When you set this property to <code>true</code>, the reader honors the setting of the <code>missingValues</code> property. <em>Introduced in DataWeave 2.3 (2.3.0-20210823) for the September 2021 release of Mule 4.3.0-20210823.</em> Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>zonedDecimalStrict</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Use the <code>strict</code> ASCII form of sign encoding for COBOL copybook zoned decimal values. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

DataWeave accepts properties that provide instructions for writing output data in this format.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>When set to <code>true</code>, DataWeave generates the output as a data stream, and the script’s execution is deferred until it is consumed. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Encoding to be used by this writer, such as <code>UTF-8</code>.</p></div></div></td></tr><tr><td><p><code>enforceRequires</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Error if a required value is missing. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>missingValues</code></p></td><td><p><code>String</code></p></td><td><p><code>NULLS</code> for copybook schema, <code>SPACES</code> otherwise</p></td><td><div><div><p>Fill character used to represent missing values. To activate a non-default setting, use <code>useMissCharAsDefaultForFill</code>, and use one of the following values to <code>missingValues</code>:</p></div><div><ul><li><p><code>NONE</code>: Write nothing for missing values.</p></li><li><p><code>SPACES</code>: Fill the field with spaces.</p></li><li><p><code>ZEROES</code>: Fill numeric fields with <code>0</code> characters and character fields with space characters.</p></li><li><p><code>NULLS</code>: Fill the field with 0 bytes.</p></li></ul></div></div></td></tr><tr><td><p><code>notTruncateDependingOnSubjectNotPresent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Fills the entire group when the DEPENDING ON subject is not present. <em>Introduced in DataWeave 2.3 with the August 2021 release of Mule 4.3.0-20210622.</em></p></div></div></td></tr><tr><td><p><code>recordTerminator</code></p></td><td><p><code>String</code></p></td><td><p>System property <code>line.separator</code></p></td><td><div><div><p>Record separator line break. Valid values:</p></div><div><ul><li><p><code>lf</code></p></li><li><p><code>cr</code></p></li><li><p><code>crlf</code></p></li><li><p><code>none</code></p></li></ul></div><div><p>Note that in Mule versions 4.0.4 and later, this is only used as a separator when there are multiple records. Values translate directly to character codes (<code>none</code> leaves no termination on each record).</p></div></div></td></tr><tr><td><p><code>retainEmptyStringFieldsOnParsing</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>When set to <code>true</code>, this property makes the reader retain fields that lack values and set their values to an empty string. <em>Introduced in the January 2023 version of DataWeave 2.3 for Mule version 4.3.0-20221212.</em></p></div></div></td></tr><tr><td><p><code>schemaPath</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Schema definition. Path where the schema file to be used is located.</p></div></div></td></tr><tr><td><p><code>segmentIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Segment identifier in the schema for fixed width or copybook schemas (only needed when writing a single segment/record definition, and if the schema includes multiple segment definitions).</p></div></div></td></tr><tr><td><p><code>structureIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Structure identifier in schema for flatfile schemas (only needed when writing a structure definition and if the schema includes multiple structure definitions).</p></div></div></td></tr><tr><td><p><code>trimValues</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Trim string values that are longer than the field width by truncating trailing characters. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>truncateDependingOn</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Truncate COBOL copybook DEPENDING ON values to the length used. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>useMissCharAsDefaultForFill</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>By default, the flat file reader and writer use spaces for missing characters and ignore the setting of the <code>missingValues</code> property. When you set this property to <code>true</code>, the writer honors the setting of the <code>missingValues</code> property. <em>Introduced in DataWeave 2.3 (2.3.0-20210823) for the September 2021 release of Mule 4.3.0-20210823.</em></p></div></div></td></tr><tr><td><p><code>zonedDecimalStrict</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Use the <code>strict</code> ASCII form of sign encoding for COBOL copybook zoned decimal values. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

The Flat File format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/flatfile</code></p></td></tr></tbody></table>

<!-- document id=68bcba5b7254bab758bf5da9425d5f1e87e0123ccd578da90e034da3e4f55be9 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-formats-flatfile.md -->

---
product: DataWeave
version: 2.4
keywords: format, flatfile, */flatfile, application/flatfile
---

# Flat File Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/flatfile`

ID: `flatfile`

The Flat File format supports multiple types of fixed width records within a single message. The
schema structure allows you to define how different record types are distinguished, and how the
records are logically grouped.

> [!NOTE] Flat File in DataWeave supports files of up to 15 MB, and the memory requirement is
> roughly 40 to 1. For example, a 1-MB file requires up to 40 MB of memory to process, so it’s
> important to consider this memory requirement in conjunction with your TPS needs for large flat
> files. This is not an exact figure; the value might vary according to the complexity of the
> mapping instructions.

## Example: Specify a Flat File Schema

This example shows a DataWeave script that outputs data in the Flat File format. Notice that it uses
the `schemaPath` and `structureIndent` writer properties.

```dataweave
%dw 2.0
output application/flatfile schemaPath="src/main/resources/test-data/QBReqRsp.esl", structureIdent="QBResponse"
---
payload
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

DataWeave accepts properties that provide instructions for reading input data in this format.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>allowLenientWithBinaryNotEndElement</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>When the schema contains elements of type Binary or Packed, the <code>lenient</code> option does not allow short records, regardless of the last element’s format type. When you set this property to <code>true</code>, the validation applies only to cases in which the record ends with type Binary or Packed.</p></div></div></td></tr><tr><td><p><code>enforceRequires</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Error if required value missing. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>missingValues</code></p></td><td><p><code>String</code></p></td><td><p><code>nulls</code> for copybook schema, <code>spaces</code> otherwise</p></td><td><div><div><p>Fill character used to represent missing values. To activate a non-default setting, set the <code>useMissCharAsDefaultForFill</code> property to <code>true</code>, and use one of the following values to <code>missingValues</code>:</p></div><div><ul><li><p><code>none</code>: Treat all data as actual values</p></li><li><p><code>spaces</code>: Interpret a field consisting of only spaces as a missing value</p></li><li><p><code>zeroes</code>: Interpret numeric fields consisting of only '0' characters and character fields consisting of only spaces as missing values</p></li><li><p><code>nulls</code>: Interpret a field consisting only of 0 bytes as a missing value</p></li></ul></div></div></td></tr><tr><td><p><code>notTruncateDependingOnSubjectNotPresent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Fills the entire group when the DEPENDING ON subject is not present. <em>Introduced in DataWeave 2.3 with the August 2021 release of Mule 4.3.0-20210622.</em></p></div></div></td></tr><tr><td><p><code>recordParsing</code></p></td><td><p><code>String</code></p></td><td><p><code>strict</code></p></td><td><div><div><p>Expected separation between lines/records:</p></div><div><ul><li><p><code>strict</code>: Line break expected at exact end of each record.</p></li><li><p><code>lenient</code>: Line break is used, but records can be shorter or longer than the schema specifies. Do not use <code>lenient</code> if your payload lacks line breaks. The other options to <code>recordParsing</code> support records that lack line breaks.</p></li><li><p><code>noTerminator</code>: Records follow one another with no separation. This option is preferred for fixed-length records that lack a line break.</p></li><li><p><code>singleRecord</code>: Entire input is a single record.</p></li></ul></div><div><p>Note that schemas with type <code>Binary</code> or <code>Packed</code> don’t allow for line break detection, so setting <code>recordParsing</code> to <code>lenient</code> only allows long records to be handled, not short ones. These schemas also currently only work with certain single-byte character encodings (so not with UTF-8 or any multibyte format).</p></div></div></td></tr><tr><td><p><code>schemaPath</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Schema definition. Location in your local disk of the schema file used to parse your input.</p></div></div></td></tr><tr><td><p><code>segmentIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Segment identifier in the schema for fixed width or copybook schemas (only needed when parsing a single segment/record definition and if the schema includes multiple segment definitions).</p></div></div></td></tr><tr><td><p><code>structureIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Structure identifier in schema for flatfile schemas (only needed when parsing a structure definition, and if the schema includes multiple structure definitions)</p></div></div></td></tr><tr><td><p><code>truncateDependingOn</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Truncate COBOL copybook DEPENDING ON values to the length used. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>useMissCharAsDefaultForFill</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>By default, the flat file reader and writer use spaces for missing characters and ignore the setting of the <code>missingValues</code> property. When you set this property to <code>true</code>, the reader honors the setting of the <code>missingValues</code> property. <em>Introduced in DataWeave 2.3 (2.3.0-20210823) for the September 2021 release of Mule 4.3.0-20210823.</em> Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>zonedDecimalStrict</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Use the <code>strict</code> ASCII form of sign encoding for COBOL copybook zoned decimal values. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

DataWeave accepts properties that provide instructions for writing output data in this format.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>When set to <code>true</code>, DataWeave generates the output as a data stream, and the script’s execution is deferred until it is consumed. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Encoding to be used by this writer, such as <code>UTF-8</code>.</p></div></div></td></tr><tr><td><p><code>enforceRequires</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Error if a required value is missing. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>missingValues</code></p></td><td><p><code>String</code></p></td><td><p><code>NULLS</code> for copybook schema, <code>SPACES</code> otherwise</p></td><td><div><div><p>Fill character used to represent missing values. To activate a non-default setting, use <code>useMissCharAsDefaultForFill</code>, and use one of the following values to <code>missingValues</code>:</p></div><div><ul><li><p><code>NONE</code>: Write nothing for missing values.</p></li><li><p><code>SPACES</code>: Fill the field with spaces.</p></li><li><p><code>ZEROES</code>: Fill numeric fields with <code>0</code> characters and character fields with space characters.</p></li><li><p><code>NULLS</code>: Fill the field with 0 bytes.</p></li></ul></div></div></td></tr><tr><td><p><code>notTruncateDependingOnSubjectNotPresent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Fills the entire group when the DEPENDING ON subject is not present. <em>Introduced in DataWeave 2.3 with the August 2021 release of Mule 4.3.0-20210622.</em></p></div></div></td></tr><tr><td><p><code>recordTerminator</code></p></td><td><p><code>String</code></p></td><td><p>System property <code>line.separator</code></p></td><td><div><div><p>Record separator line break. Valid values:</p></div><div><ul><li><p><code>lf</code></p></li><li><p><code>cr</code></p></li><li><p><code>crlf</code></p></li><li><p><code>none</code></p></li></ul></div><div><p>Note that in Mule versions 4.0.4 and later, this is only used as a separator when there are multiple records. Values translate directly to character codes. (<code>none</code> leaves no termination on each record).</p></div></div></td></tr><tr><td><p><code>retainEmptyStringFieldsOnParsing</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>When set to <code>true</code>, this property makes the reader retain fields that lack values and set their values to an empty string. The default behavior of the reader is to remove those fields. <em>Introduced in the January 2023 version of DataWeave 2.4 for Mule version 4.4.0-20230102.</em></p></div></div></td></tr><tr><td><p><code>schemaPath</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Schema definition. Path where the schema file to be used is located.</p></div></div></td></tr><tr><td><p><code>segmentIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Segment identifier in the schema for fixed width or copybook schemas (only needed when writing a single segment/record definition, and if the schema includes multiple segment definitions).</p></div></div></td></tr><tr><td><p><code>structureIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Structure identifier in schema for flatfile schemas (only needed when writing a structure definition and if the schema includes multiple structure definitions)</p></div></div></td></tr><tr><td><p><code>trimValues</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Trim string values longer than the field length by truncating trailing characters. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>trimValues</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Indicates whether trim values are longer than the field width. Valid Options are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>truncateDependingOn</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Truncate COBOL copybook DEPENDING ON values to the length used. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>useMissCharAsDefaultForFill</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>By default, the flat file reader and writer use spaces for missing characters and ignore the setting of the <code>missingValues</code> property. When you set this property to <code>true</code>, the writer honors the setting of the <code>missingValues</code> property. <em>Introduced in DataWeave 2.3 (2.3.0-20210823) for the September 2021 release of Mule 4.3.0-20210823.</em></p></div></div></td></tr><tr><td><p><code>zonedDecimalStrict</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Use the <code>strict</code> ASCII form of sign encoding for COBOL copybook zoned decimal values. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/flatfile</code></p></td></tr></tbody></table>

<!-- document id=536a4927c8d937de398ed54576a7f68fd60823bac97c3d9b27ca824a51b76106 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-formats-flatfile.md -->

---
product: DataWeave
version: 2.6
keywords: format, flatfile, */flatfile, application/flatfile
---

# Flat File Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/flatfile`

ID: `flatfile`

The Flat File format supports multiple types of fixed width records within a single message. The
schema structure allows you to define how different record types are distinguished, and how the
records are logically grouped.

> [!NOTE] Flat File in DataWeave supports files of up to 15 MB, and the memory requirement is
> roughly 40 to 1. For example, a 1-MB file requires up to 40 MB of memory to process, so it’s
> important to consider this memory requirement in conjunction with your TPS needs for large flat
> files. This is not an exact figure; the value might vary according to the complexity of the
> mapping instructions.

## Example: Specify a Flat File Schema

This example shows a DataWeave script that outputs data in the Flat File format. Notice that it uses
the `schemaPath` and `structureIndent` writer properties.

```dataweave
%dw 2.0
output application/flatfile schemaPath="src/main/resources/test-data/QBReqRsp.esl", structureIdent="QBResponse"
---
payload
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>allowLenientWithBinaryNotEndElement</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>When the schema contains elements of type Binary or Packed, the <code>lenient</code> option does not allow short records, regardless of the last element’s format type. When you set this property to <code>true</code>, the validation applies only to cases in which the record ends with type Binary or Packed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>enforceRequires</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Produces an error when set to <code>true</code> if a required value is missing.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>missingValues</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Fill character used to represent missing values. To activate a non-default setting, set the <code>useMissCharAsDefaultForFill</code> property to <code>true</code>, and use one of the following values to <code>missingValues</code>:</p></div><div><ul><li><p><code>none</code> (for the reader) or <code>NONE</code> (for the writer): Treats all data as values.</p></li><li><p><code>spaces</code> (for the reader) or <code>SPACES</code> (for the writer): Interprets a field consisting of only spaces as a missing value. Default for flat file and fixed-width formats.</p></li><li><p><code>zeroes</code> (for the reader) or <code>ZEROES</code> (for the writer): Interprets numeric fields consisting of only <code>0</code> characters <em>and</em> character fields consisting of only spaces as missing values.</p></li><li><p><code>nulls</code> (for the reader) or <code>NULLS</code> (for the writer): Interprets a field consisting only of <code>0</code> bytes as a missing value. Default for COBOL copybook schema.</p></li></ul></div><div><p>Valid values are <code>none</code> or <code>spaces</code> or <code>zeroes</code> or <code>nulls</code>.</p></div></div></td></tr><tr><td><p><code>notTruncateDependingOnSubjectNotPresent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Fills the entire group when the DEPENDING ON subject is not present.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>recordParsing</code></p></td><td><p><code>String</code></p></td><td><p><code>'strict'</code></p></td><td><div><div><p>Specifies the expected type of separation between lines or records:</p></div><div><ul><li><p><code>strict</code>: Line break is expected at exact end of each record. <code>strict</code> is the default.</p></li><li><p><code>lenient</code>: Line break is used, but records can be shorter or longer than the schema specifies. Don’t use <code>lenient</code> if your payload lacks line breaks. The other options to <code>recordParsing</code> support records that lack line breaks.</p></li><li><p><code>noTerminator</code>: Records follow one another with no separation. This option is preferred for fixed-length records that lack a line break.</p></li><li><p><code>singleRecord</code>: The entire input is a single record.</p></li></ul></div><div><p>Note that schemas with type <code>Binary</code> or <code>Packed</code> don’t allow for line break detection, so setting <code>recordParsing</code> to <code>lenient</code> only allows long records to be handled, not short ones. These schemas also currently only work with certain single-byte character encodings (so not with UTF-8 or any multibyte format).</p></div><div><p>Valid values are <code>strict</code> or <code>lenient</code> or <code>noTerminator</code> or <code>singleRecord</code>.</p></div></div></td></tr><tr><td><p><code>retainEmptyStringFieldsOnParsing</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Allow parsing behavior to keep missing string value fields with a default value in the output map</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>schemaPath</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Path to the schema definition. Specifies the location in your local disk of the schema file that parses your input.</p></div></div></td></tr><tr><td><p><code>segmentIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Segment identifier in the schema for fixed-width or COBOL copybook schemas. Required when parsing a single segment or record definition if the schema includes multiple segment definitions.</p></div></div></td></tr><tr><td><p><code>structureIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Structure identifier in the schema for flat file schemas. Required when parsing a structure definition if the schema includes multiple structure definitions.</p></div></div></td></tr><tr><td><p><code>truncateDependingOn</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, truncates DEPENDING ON values to the length used.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>useMissCharAsDefaultForFill</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>By default, the flat file reader and writer use spaces for missing characters and ignore the setting of the <code>missingValues</code> property. When you set this property to <code>true</code>, DataWeave honors the setting of the <code>missingValues property</code>. Introduced in DataWeave 2.3 (2.3.0-20210823) for the September 2021 release of Mule 4.3.0-20210823.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>zonedDecimalStrict</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, uses the 'strict' ASCII form of sign encoding for zoned decimal values.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr><tr><td><p><code>enforceRequires</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Produces an error when set to <code>true</code> if a required value is missing.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>missingValues</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Fill character used to represent missing values. To activate a non-default setting, set the <code>useMissCharAsDefaultForFill</code> property to <code>true</code>, and use one of the following values to <code>missingValues</code>:</p></div><div><ul><li><p><code>none</code> (for the reader) or <code>NONE</code> (for the writer): Treats all data as values.</p></li><li><p><code>spaces</code> (for the reader) or <code>SPACES</code> (for the writer): Interprets a field consisting of only spaces as a missing value. Default for flat file and fixed-width formats.</p></li><li><p><code>zeroes</code> (for the reader) or <code>ZEROES</code> (for the writer): Interprets numeric fields consisting of only <code>0</code> characters <em>and</em> character fields consisting of only spaces as missing values.</p></li><li><p><code>nulls</code> (for the reader) or <code>NULLS</code> (for the writer): Interprets a field consisting only of <code>0</code> bytes as a missing value. Default for COBOL copybook schema.</p></li></ul></div><div><p>Valid values are <code>none</code> or <code>spaces</code> or <code>zeroes</code> or <code>nulls</code>.</p></div></div></td></tr><tr><td><p><code>notTruncateDependingOnSubjectNotPresent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Fills the entire group when the DEPENDING ON subject is not present.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>recordTerminator</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Line break for a record separator. DataWeave uses this property as a separator only when there are multiple records. Values translate directly to character codes, and <code>none</code> leaves no termination on each record.</p></div><div><p>Valid values are <code>lf</code> or <code>cr</code> or <code>crlf</code> or <code>none</code>.</p></div></div></td></tr><tr><td><p><code>schemaPath</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Path to the schema definition. Specifies the location in your local disk of the schema file that parses your input.</p></div></div></td></tr><tr><td><p><code>segmentIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Segment identifier in the schema for fixed-width or COBOL copybook schemas. Required when parsing a single segment or record definition if the schema includes multiple segment definitions.</p></div></div></td></tr><tr><td><p><code>structureIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Structure identifier in the schema for flat file schemas. Required when parsing a structure definition if the schema includes multiple structure definitions.</p></div></div></td></tr><tr><td><p><code>trimValues</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Trim values that are longer than the width of a field.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>truncateDependingOn</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, truncates DEPENDING ON values to the length used.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>useMissCharAsDefaultForFill</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>By default, the flat file reader and writer use spaces for missing characters and ignore the setting of the <code>missingValues</code> property. When you set this property to <code>true</code>, DataWeave honors the setting of the <code>missingValues property</code>. Introduced in DataWeave 2.3 (2.3.0-20210823) for the September 2021 release of Mule 4.3.0-20210823.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>zonedDecimalStrict</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, uses the 'strict' ASCII form of sign encoding for zoned decimal values.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/flatfile</code></p></td></tr></tbody></table>

<!-- document id=b596b67af67b011f1386964da354487b1c7e810b926e037a39e7f7f9fbef682f url=/mulesoft/current/en-us/dataweave/2.9/dataweave-formats-flatfile.md -->

---
product: DataWeave
version: 2.9
keywords: format, flatfile, */flatfile, application/flatfile
---

# Flat File Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/flatfile`

ID: `flatfile`

The Flat File format supports multiple types of fixed width records within a single message. The
schema structure allows you to define how different record types are distinguished, and how the
records are logically grouped.

> [!NOTE] Flat File in DataWeave supports files of up to 15 MB, and the memory requirement is
> roughly 40 to 1. For example, a 1-MB file requires up to 40 MB of memory to process, so it’s
> important to consider this memory requirement in conjunction with your TPS needs for large flat
> files. This is not an exact figure; the value might vary according to the complexity of the
> mapping instructions.

## Example: Specify a Flat File Schema

This example shows a DataWeave script that outputs data in the Flat File format. Notice that it uses
the `schemaPath` and `structureIndent` writer properties.

```dataweave
%dw 2.0
output application/flatfile schemaPath="src/main/resources/test-data/QBReqRsp.esl", structureIdent="QBResponse"
---
payload
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>allowLenientWithBinaryNotEndElement</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>When the schema contains elements of type Binary or Packed, the <code>lenient</code> option does not allow short records, regardless of the last element’s format type. When you set this property to <code>true</code>, the validation applies only to cases in which the record ends with type Binary or Packed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>enforceRequires</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Produces an error when set to <code>true</code> if a required value is missing.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>missingValues</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Fill character used to represent missing values. To activate a non-default setting, set the <code>useMissCharAsDefaultForFill</code> property to <code>true</code>, and use one of the following values to <code>missingValues</code>:</p></div><div><ul><li><p><code>none</code> (for the reader) or <code>NONE</code> (for the writer): Treats all data as values.</p></li><li><p><code>spaces</code> (for the reader) or <code>SPACES</code> (for the writer): Interprets a field consisting of only spaces as a missing value. Default for flat file and fixed-width formats.</p></li><li><p><code>zeroes</code> (for the reader) or <code>ZEROES</code> (for the writer): Interprets numeric fields consisting of only <code>0</code> characters <em>and</em> character fields consisting of only spaces as missing values.</p></li><li><p><code>nulls</code> (for the reader) or <code>NULLS</code> (for the writer): Interprets a field consisting only of <code>0</code> bytes as a missing value. Default for COBOL copybook schema.</p></li></ul></div><div><p>Valid values are <code>none</code> or <code>spaces</code> or <code>zeroes</code> or <code>nulls</code>.</p></div></div></td></tr><tr><td><p><code>notTruncateDependingOnSubjectNotPresent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Fills the entire group when the DEPENDING ON subject is not present.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>recordParsing</code></p></td><td><p><code>String</code></p></td><td><p><code>'strict'</code></p></td><td><div><div><p>Specifies the expected type of separation between lines or records:</p></div><div><ul><li><p><code>strict</code>: Line break is expected at exact end of each record. <code>strict</code> is the default.</p></li><li><p><code>lenient</code>: Line break is used, but records can be shorter or longer than the schema specifies. Don’t use <code>lenient</code> if your payload lacks line breaks. The other options to <code>recordParsing</code> support records that lack line breaks.</p></li><li><p><code>noTerminator</code>: Records follow one another with no separation. This option is preferred for fixed-length records that lack a line break.</p></li><li><p><code>singleRecord</code>: The entire input is a single record.</p></li></ul></div><div><p>Note that schemas with type <code>Binary</code> or <code>Packed</code> don’t allow for line break detection, so setting <code>recordParsing</code> to <code>lenient</code> only allows long records to be handled, not short ones. These schemas also currently only work with certain single-byte character encodings (so not with UTF-8 or any multibyte format).</p></div><div><p>Valid values are <code>strict</code> or <code>lenient</code> or <code>noTerminator</code> or <code>singleRecord</code>.</p></div></div></td></tr><tr><td><p><code>retainEmptyStringFieldsOnParsing</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Allow parsing behavior to keep missing string value fields with a default value in the output map</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>schemaPath</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Path to the schema definition. Specifies the location in your local disk of the schema file that parses your input.</p></div></div></td></tr><tr><td><p><code>segmentIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Segment identifier in the schema for fixed-width or COBOL copybook schemas. Required when parsing a single segment or record definition if the schema includes multiple segment definitions.</p></div></div></td></tr><tr><td><p><code>structureIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Structure identifier in the schema for flat file schemas. Required when parsing a structure definition if the schema includes multiple structure definitions.</p></div></div></td></tr><tr><td><p><code>substituteCharacterAsMissingValue</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>If set to <code>true</code> and the <code>missingValues</code> property is set to <code>none</code>, with <code>useMissCharAsDefaultForFill</code> set to <code>true</code>, the flat file parser handles the <code>0x1A</code> (SUB) character as the missing value.<br>Otherwise, the flat file parser doesn’t handle the <code>0x1A</code> character as the missing value.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>truncateDependingOn</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, truncates DEPENDING ON values to the length used.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>useMissCharAsDefaultForFill</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>By default, the flat file reader and writer use spaces for missing characters and ignore the setting of the <code>missingValues</code> property. When you set this property to <code>true</code>, DataWeave honors the <code>missingValues property</code> setting. Introduced in DataWeave 2.3 (2.3.0-20210823) for the September 2021 release of Mule 4.3.0-20210823.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>zonedDecimalStrict</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, uses the 'strict' ASCII form of sign encoding for zoned decimal values.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr><tr><td><p><code>enforceRequires</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Produces an error when set to <code>true</code> if a required value is missing.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>fillRedefinesByMaxLength</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>If set to <code>true</code>, the flat file module fills the <code>Redefines</code> components that are considered to be missing values up to the maximum number of characters set in the <code>maxLength</code> parameter.<br>If set to <code>false</code>, the module uses all the defined view options to determine how to fill the <code>Redefines</code> components.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>missingValues</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Fill character used to represent missing values. To activate a non-default setting, set the <code>useMissCharAsDefaultForFill</code> property to <code>true</code>, and use one of the following values to <code>missingValues</code>:</p></div><div><ul><li><p><code>none</code> (for the reader) or <code>NONE</code> (for the writer): Treats all data as values.</p></li><li><p><code>spaces</code> (for the reader) or <code>SPACES</code> (for the writer): Interprets a field consisting of only spaces as a missing value. Default for flat file and fixed-width formats.</p></li><li><p><code>zeroes</code> (for the reader) or <code>ZEROES</code> (for the writer): Interprets numeric fields consisting of only <code>0</code> characters <em>and</em> character fields consisting of only spaces as missing values.</p></li><li><p><code>nulls</code> (for the reader) or <code>NULLS</code> (for the writer): Interprets a field consisting only of <code>0</code> bytes as a missing value. Default for COBOL copybook schema.</p></li></ul></div><div><p>Valid values are <code>none</code> or <code>spaces</code> or <code>zeroes</code> or <code>nulls</code>.</p></div></div></td></tr><tr><td><p><code>notTruncateDependingOnSubjectNotPresent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Fills the entire group when the DEPENDING ON subject is not present.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>recordTerminator</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Line break for a record separator. DataWeave uses this property as a separator only when there are multiple records. Values translate directly to character codes, and <code>none</code> leaves no termination on each record.</p></div><div><p>Valid values are <code>lf</code> or <code>cr</code> or <code>crlf</code> or <code>none</code>.</p></div></div></td></tr><tr><td><p><code>schemaPath</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Path to the schema definition. Specifies the location in your local disk of the schema file that parses your input.</p></div></div></td></tr><tr><td><p><code>segmentIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Segment identifier in the schema for fixed-width or COBOL copybook schemas. Required when parsing a single segment or record definition if the schema includes multiple segment definitions.</p></div></div></td></tr><tr><td><p><code>structureIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Structure identifier in the schema for flat file schemas. Required when parsing a structure definition if the schema includes multiple structure definitions.</p></div></div></td></tr><tr><td><p><code>trimValues</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Trim values that are longer than the width of a field.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>truncateDependingOn</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, truncates DEPENDING ON values to the length used.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>useMissCharAsDefaultForFill</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>By default, the flat file reader and writer use spaces for missing characters and ignore the setting of the <code>missingValues</code> property. When you set this property to <code>true</code>, DataWeave honors the <code>missingValues property</code> setting. Introduced in DataWeave 2.3 (2.3.0-20210823) for the September 2021 release of Mule 4.3.0-20210823.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>zonedDecimalStrict</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, uses the 'strict' ASCII form of sign encoding for zoned decimal values.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/flatfile</code></p></td></tr></tbody></table>

<!-- document id=3416f5848bbd0ec68db8fedc4631a821744243ed756c9e9d6e416bcbd6ded938 url=/mulesoft/current/en-us/dataweave/latest/dataweave-formats-flatfile.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: format, flatfile, */flatfile, application/flatfile
---

# Flat File Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/flatfile`

ID: `flatfile`

The Flat File format supports multiple types of fixed width records within a single message. The
schema structure allows you to define how different record types are distinguished, and how the
records are logically grouped.

> [!NOTE] Flat File in DataWeave supports files of up to 15 MB, and the memory requirement is
> roughly 40 to 1. For example, a 1-MB file requires up to 40 MB of memory to process, so it’s
> important to consider this memory requirement in conjunction with your TPS needs for large flat
> files. This is not an exact figure; the value might vary according to the complexity of the
> mapping instructions.

## Example: Specify a Flat File Schema

This example shows a DataWeave script that outputs data in the Flat File format. Notice that it uses
the `schemaPath` and `structureIndent` writer properties.

```dataweave
%dw 2.0
output application/flatfile schemaPath="src/main/resources/test-data/QBReqRsp.esl", structureIdent="QBResponse"
---
payload
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>allowLenientWithBinaryNotEndElement</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>When the schema contains elements of type Binary or Packed, the <code>lenient</code> option does not allow short records, regardless of the last element’s format type. When you set this property to <code>true</code>, the validation applies only to cases in which the record ends with type Binary or Packed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>enforceRequires</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Produces an error when set to <code>true</code> if a required value is missing.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>missingValues</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Fill character used to represent missing values. To activate a non-default setting, set the <code>useMissCharAsDefaultForFill</code> property to <code>true</code>, and use one of the following values to <code>missingValues</code>:</p></div><div><ul><li><p><code>none</code> (for the reader) or <code>NONE</code> (for the writer): Treats all data as values.</p></li><li><p><code>spaces</code> (for the reader) or <code>SPACES</code> (for the writer): Interprets a field consisting of only spaces as a missing value. Default for flat file and fixed-width formats.</p></li><li><p><code>zeroes</code> (for the reader) or <code>ZEROES</code> (for the writer): Interprets numeric fields consisting of only <code>0</code> characters <em>and</em> character fields consisting of only spaces as missing values.</p></li><li><p><code>nulls</code> (for the reader) or <code>NULLS</code> (for the writer): Interprets a field consisting only of <code>0</code> bytes as a missing value. Default for COBOL copybook schema.</p></li></ul></div><div><p>Valid values are <code>none</code> or <code>spaces</code> or <code>zeroes</code> or <code>nulls</code>.</p></div></div></td></tr><tr><td><p><code>notTruncateDependingOnSubjectNotPresent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Fills the entire group when the DEPENDING ON subject is not present.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>recordParsing</code></p></td><td><p><code>String</code></p></td><td><p><code>'strict'</code></p></td><td><div><div><p>Specifies the expected type of separation between lines or records:</p></div><div><ul><li><p><code>strict</code>: Line break is expected at exact end of each record. <code>strict</code> is the default.</p></li><li><p><code>lenient</code>: Line break is used, but records can be shorter or longer than the schema specifies. Don’t use <code>lenient</code> if your payload lacks line breaks. The other options to <code>recordParsing</code> support records that lack line breaks.</p></li><li><p><code>noTerminator</code>: Records follow one another with no separation. This option is preferred for fixed-length records that lack a line break.</p></li><li><p><code>singleRecord</code>: The entire input is a single record.</p></li></ul></div><div><p>Note that schemas with type <code>Binary</code> or <code>Packed</code> don’t allow for line break detection, so setting <code>recordParsing</code> to <code>lenient</code> only allows long records to be handled, not short ones. These schemas also currently only work with certain single-byte character encodings (so not with UTF-8 or any multibyte format).</p></div><div><p>Valid values are <code>strict</code> or <code>lenient</code> or <code>noTerminator</code> or <code>singleRecord</code>.</p></div></div></td></tr><tr><td><p><code>retainEmptyStringFieldsOnParsing</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Allow parsing behavior to keep missing string value fields with a default value in the output map</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>schemaPath</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Path to the schema definition. Specifies the location in your local disk of the schema file that parses your input.</p></div></div></td></tr><tr><td><p><code>segmentIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Segment identifier in the schema for fixed-width or COBOL copybook schemas. Required when parsing a single segment or record definition if the schema includes multiple segment definitions.</p></div></div></td></tr><tr><td><p><code>structureIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Structure identifier in the schema for flat file schemas. Required when parsing a structure definition if the schema includes multiple structure definitions.</p></div></div></td></tr><tr><td><p><code>substituteCharacterAsMissingValue</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>If set to <code>true</code> and the <code>missingValues</code> property is set to <code>none</code>, with <code>useMissCharAsDefaultForFill</code> set to <code>true</code>, the flat file parser handles the <code>0x1A</code> (SUB) character as the missing value.<br>Otherwise, the flat file parser doesn’t handle the <code>0x1A</code> character as the missing value.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>truncateDependingOn</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, truncates DEPENDING ON values to the length used.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>useMissCharAsDefaultForFill</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>By default, the flat file reader and writer use spaces for missing characters and ignore the setting of the <code>missingValues</code> property. When you set this property to <code>true</code>, DataWeave honors the <code>missingValues property</code> setting. Introduced in DataWeave 2.3 (2.3.0-20210823) for the September 2021 release of Mule 4.3.0-20210823.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>zonedDecimalStrict</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, uses the 'strict' ASCII form of sign encoding for zoned decimal values.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr><tr><td><p><code>enforceRequires</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Produces an error when set to <code>true</code> if a required value is missing.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>fillRedefinesByMaxLength</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>If set to <code>true</code>, the flat file module fills the <code>Redefines</code> components that are considered to be missing values up to the maximum number of characters set in the <code>maxLength</code> parameter.<br>If set to <code>false</code>, the module uses all the defined view options to determine how to fill the <code>Redefines</code> components.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>missingValues</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Fill character used to represent missing values. To activate a non-default setting, set the <code>useMissCharAsDefaultForFill</code> property to <code>true</code>, and use one of the following values to <code>missingValues</code>:</p></div><div><ul><li><p><code>none</code> (for the reader) or <code>NONE</code> (for the writer): Treats all data as values.</p></li><li><p><code>spaces</code> (for the reader) or <code>SPACES</code> (for the writer): Interprets a field consisting of only spaces as a missing value. Default for flat file and fixed-width formats.</p></li><li><p><code>zeroes</code> (for the reader) or <code>ZEROES</code> (for the writer): Interprets numeric fields consisting of only <code>0</code> characters <em>and</em> character fields consisting of only spaces as missing values.</p></li><li><p><code>nulls</code> (for the reader) or <code>NULLS</code> (for the writer): Interprets a field consisting only of <code>0</code> bytes as a missing value. Default for COBOL copybook schema.</p></li></ul></div><div><p>Valid values are <code>none</code> or <code>spaces</code> or <code>zeroes</code> or <code>nulls</code>.</p></div></div></td></tr><tr><td><p><code>notTruncateDependingOnSubjectNotPresent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Fills the entire group when the DEPENDING ON subject is not present.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>recordTerminator</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Line break for a record separator. DataWeave uses this property as a separator only when there are multiple records. Values translate directly to character codes, and <code>none</code> leaves no termination on each record.</p></div><div><p>Valid values are <code>lf</code> or <code>cr</code> or <code>crlf</code> or <code>none</code>.</p></div></div></td></tr><tr><td><p><code>schemaPath</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Path to the schema definition. Specifies the location in your local disk of the schema file that parses your input.</p></div></div></td></tr><tr><td><p><code>segmentIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Segment identifier in the schema for fixed-width or COBOL copybook schemas. Required when parsing a single segment or record definition if the schema includes multiple segment definitions.</p></div></div></td></tr><tr><td><p><code>structureIdent</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Structure identifier in the schema for flat file schemas. Required when parsing a structure definition if the schema includes multiple structure definitions.</p></div></div></td></tr><tr><td><p><code>trimValues</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Trim values that are longer than the width of a field.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>truncateDependingOn</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, truncates DEPENDING ON values to the length used.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>useMissCharAsDefaultForFill</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>By default, the flat file reader and writer use spaces for missing characters and ignore the setting of the <code>missingValues</code> property. When you set this property to <code>true</code>, DataWeave honors the <code>missingValues property</code> setting. Introduced in DataWeave 2.3 (2.3.0-20210823) for the September 2021 release of Mule 4.3.0-20210823.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>zonedDecimalStrict</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>For COBOL copybook, uses the 'strict' ASCII form of sign encoding for zoned decimal values.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports this MIME type:

- `*/flatfile`

<!-- document id=b50d8669595213771318e7633934bd21fcae867b24697f6b5b9c9ec654d4c35f url=/mulesoft/current/en-us/dataweave/2.11/dataweave-flat-file-schemas.md -->

---
product: DataWeave
version: 2.11
keywords: b2b, edi, schema, dataweave, yaml, language, reference
---

# Flat File Schemas

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave can process several different types of data. For most of these types, you can import a
schema that describes the input structure in order to have access to valuable metadata at design
time.

DataWeave uses a YAML format called FFD (for Flat File Definition) to represent flat file schemas.
The FFD format is flexible enough to support a range of use cases, but is based around the concepts
of elements, composites, segments, groups, and structures.

Schemas must be written in Flat File Schema Language, and by convention use a `.ffd` extension. This
language is very similar to EDI Schema Language (ESL), which is also accepted by Anypoint Studio.

In DataWeave, you can bind your input or output to a flat file schema through a property.

Note that if you intend to use a simple fixed-width format, you can set up your data type directly
through the Transform component using the `Fixed Width` type. Creating an instance of this type in
Studio will automatically generate a matching schema definition.

## Types of Components in a Schema

Here are the different types of components that make up a flat file schema, going from the most
elementary to the more complex. Elements and Segments are always required, while Composites, Groups,
and Structures might be needed depending on the
[top-level structure of your document](#top_level_structure).

- Element - An element is a basic data item, which has an associated type and fixed width, along
  with formatting options for how the data value is read and written.

- Composite - (Optional) A group of elements. It can also include other child composites.

- Segment - A line of data, or record, made up of any number of elements and/or composites that
  might be repeated.

- Group - (Optional) Several segments grouped together. It can also include other child groups.

- Structure - A hierarchical organization of segments, which requires that the segments have unique
  identifier codes as part of their data.

## Top-level structure of an FFD Document

The top-level definition in an FFD document starts with the form of the schema. In this case it must
always be "FLATFILE", "COPYBOOK", or "FIXEDWIDTH". The differences between these forms are minor and
mostly relate to how they are handled in Studio. The rest depends on the form of definitions present
in the file, with the following alternatives:

- Single segment - Segment information directly at the top level (including a `values` key giving
  the element and/or composite details of the segment).

- Multiple segments - A `segments` key with multiple child objects, each defining one segment.

- Multiple structures - A `structures` key with multiple child objects, each defining one structure.

### Single Segment

If you are only working with one type of record, you only need to have a segment definition for that
record type in your FFD.

![A flat file schema with multiple elements and segments](/mulesoft/current/en-us/dataweave/2.11/_images/dataweave-flat-file-schemas-22788.png)

This is a simple schema with only one segment:

```yaml
form: FLATFILE
id: "RQH"
name: Request Header Record
values:
  - { name: "Organization Code", type: String, length: 10 }
  - { name: "File Creation Date", type: Date, length: 8 }
  - { name: "File Creation Time", type: Time, length: 4 }
```

The example above simply defines a list of elements within a single segment. It has no composites to
group them into.

Here is another example:

```yaml
form: FIXEDWIDTH
name: my-flat-file
values:
  - { name: "Row-id", type: String, length: 2 }
  - { name: "Total", type: Decimal, length: 11 }
  - { name: "Module", type: String, length: 8 }
  - { name: "Cost", type: Decimal, length: 8, format: { implicit: 2 } }
  - { name: "Program-id", type: String, length: 8 }
  - { name: "user-id", type: String, length: 8 }
  - { name: "return-sign", type: String, length: 1 }
```

Note that simplified forms are only for convenience. You can use the `segments` key even if you only
have a single child segment definition.

### Multiple Segments

If you are working with multiple types of records in the same transformation, you need to use a
structure definition that controls how these different records are combined.

![A flat file schema with elements and segments](/mulesoft/current/en-us/dataweave/2.11/_images/dataweave-flat-file-schemas-680c6.png)

In most cases, you need to define a way to distinguish between the different types of records. You
do this by identifying `tagValue` fields as part of the record definitions. The parser will check
the content of the fields of each record to identify the record type, then see how it fits into the
defined structure.

This is an example of a complete structure schema with several component record types:

```yaml
form: FIXEDWIDTH
structures:
- id: 'BatchReq'
  name: Batch Request
  data:
  - { idRef: 'RQH' }
  - groupId: 'Batch'
    count: '>1'
    items:
    - { idRef: 'BCH' }
    - { idRef: 'TDR', count: '>1' }
    - { idRef: 'BCF' }
  - { idRef: 'RQF' }
segments:
- id: 'RQH'
  ...
```

Note that this example is not complete. It needs to define each of the referenced segments at the
end. See [Referenced versus Inlined Definitions](#referenced_vs_inlined_defs) to understand how
these segments are being referenced in this example.

### Multiple Structures

If you have multiple structures or segment definitions in an FFD, when you apply your schema to an
metadata description on a Transform component, you need to specify which one you want to use.

![A flat file schema showing groups, segments, and elements](/mulesoft/current/en-us/dataweave/2.11/_images/dataweave-flat-file-schemas-4e1eb.png)

A top-level structure of a schema with multiple structures might look like this:

```yaml
form: FIXEDWIDTH
structures:
- id: 'BatchReq'
  name: Batch Request
  data:
  - { idRef: 'RQH' }
  - groupId: 'Batch'
    usage: O
    count: '>1'
    items:
    - { idRef: 'BCH' }
    - { idRef: 'TDR', count: '>1' }
    - { idRef: 'BCF' }
  - { idRef: 'RQF' }
- id: 'BatchRsp'
  name: Batch Response
  data:
  - { idRef: 'RSH' }
  - groupId: 'Batch'
    usage: O
    count: '>1'
    items:
    - { idRef: 'BCH' }
    - { idRef: 'TDR', count: '>1' }
    - { idRef: 'BCF' }
  - { idRef: 'RSF' }
segments:
- id: 'RQH'
  ...
```

The example defines two different structures, the `BatchReq` structure and the `BatchRsp` structure.
Each of these structures uses a particular sequence of segments and groups of segments. The group
`Batch` is repeated in both structures. A Batch group is composed of a single BCH line, multiple TDR
lines, and a single BCF line.

Note that this example is not complete. It needs to define each of the referenced segments at the
end. See [Referenced versus Inlined Definitions](#referenced_vs_inlined_defs) to understand how
these segments are referenced in this example.

## Element Definitions

Element definitions are the basic building blocks of application data, consisting of basic key-value
pairs for standard characteristics. Flat file schemas generally use inline element definitions,
where each element is defined at the point it is used within a segment or composite structure, but
you can also define elements separately and reference them as needed. Here are several element
definitions defined for use by reference:

```yaml
- { id: "OrgCode", name: "Organization Code", type: String, length: 10 }
- { id: "CreateDate", name: "File Creation Date", type: Date, length: 8 }
- { id: "CreateTime", name: "File Creation Time", type: Time, length: 4 }
- {
    id: "BatchTransCount",
    name: "Batch Transaction Count",
    type: Integer,
    format: { justify: zeroes },
    length: 6,
  }
- {
    id: "BatchTransAmount",
    name: "Batch Transaction Amount",
    type: Integer,
    format: { justify: zeroes },
    length: 10,
  }
```

The supplied `id` value is used as the `idRef` value when referencing one of these definitions as
part of a segment or composite. Note that if you are defining elements inline within a segment
definition (as opposed to defining them at the end of the document and referencing them), the `id`
field is not required.

Element definitions might have the following attributes, classified by Form as applying to inline
definitions, referenced definitions (as in the above example), or references to definitions:

<table><caption>Table 1. Attributes</caption> <colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Description</th><th>Form</th></tr></thead><tbody><tr><td><p><code>count</code></p></td><td><p>Number of occurrences (optional, default is <code>1</code>)</p></td><td><p>Inline or reference</p></td></tr><tr><td><p><code>id</code></p></td><td><p>Element identifier</p></td><td><p>Referenced definition</p></td></tr><tr><td><p><code>idRef</code></p></td><td><p>Element identifier</p></td><td><p>Reference</p></td></tr><tr><td><p><code>name</code></p></td><td><p>Element name (optional)</p></td><td><p>All</p></td></tr><tr><td><p><code>type</code></p></td><td><p>Value type code, as listed below</p></td><td><p>Inline, or referenced definition</p></td></tr><tr><td><p><code>format</code></p></td><td><p>Type-specific formatting information</p></td><td><p>Inline, or referenced definition</p></td></tr><tr><td><p><code>length</code></p></td><td><p>Number of character positions for value</p></td><td><p>Inline, or referenced definition</p></td></tr><tr><td><p><code>tagValue</code></p></td><td><p>Value for this element used to identify a segment (see <a href="#full_schema_ex">the Full Schema Example</a>)</p></td><td><p>Inline, or referenced definition</p></td></tr></tbody></table>

The allowed types for defining an element are:

<table><caption>Table 2. Types</caption> <colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>Binary</p></td><td><p>Binary value (COBOL format, 2, 4, or 8 bytes)</p></td></tr><tr><td><p>Boolean</p></td><td><p>Boolean value</p></td></tr><tr><td><p>Date</p></td><td><p>Unzoned date value with year, month, and day components (which might not all be shown in text form)</p></td></tr><tr><td><p>DateTime</p></td><td><p>Unzoned date/time value with year, month, day, hour, minute, second, and millisecond components (which might not all be shown in text form)</p></td></tr><tr><td><p>Decimal</p></td><td><p>Decimal number value, which might or might not include an explicit decimal point in text form</p></td></tr><tr><td><p>Integer</p></td><td><p>Integer number value</p></td></tr><tr><td><p>Packed</p></td><td><p>Packed decimal representation of a decimal number value (COBOL format)</p></td></tr><tr><td><p>String</p></td><td><p>String value</p></td></tr><tr><td><p>Time</p></td><td><p>Unzoned time value with hour, minute, second, and millisecond components (which might not all be shown in text form)</p></td></tr><tr><td><p>Zoned</p></td><td><p>Zoned decimal (COBOL format)</p></td></tr></tbody></table>

Value types support a range of format options that affect the text form of the values. These are the
main options, along with the types to which they apply:

<table><caption>Table 3. Format Options</caption> <colgroup><col> <col> <col></colgroup><thead><tr><th>Key</th><th>Description</th><th>Applies to</th></tr></thead><tbody><tr><td><p>digits</p></td><td><p>Number of digits allowed</p></td><td><p>Binary</p></td></tr><tr><td><p>implicit</p></td><td><p>Implicit number of decimal digits (used for fixed-point values with no decimal in text form)</p></td><td><p>Binary, Decimal, Packed, Zoned</p></td></tr><tr><td><p>justify</p></td><td><p>Justification in field (LEFT, RIGHT, NONE, or ZEROES, the last only for numbers)</p></td><td><p>All except Binary and Packed</p></td></tr><tr><td><p>pattern</p></td><td><p>For numeric values, the <code>java.text.DecimalFormat</code> pattern for parsing and writing. For date/time values, the <code>java.time.format.DateTimeFormatter</code> pattern.</p></td><td><p>Date, DateTime, Decimal, Integer, Time</p></td></tr><tr><td><p>sign</p></td><td><p>Sign usage for numeric values (UNSIGNED, NEGATIVE_ONLY, OPTIONAL, ALWAYS_LEFT, ALWAYS_RIGHT)</p></td><td><p>Decimal, Integer, Zoned</p></td></tr><tr><td><p>signed</p></td><td><p>Signed versus unsigned flag</p></td><td><p>Binary, Packed</p></td></tr></tbody></table>

## Composite Definitions

Composites serve to reference a list of elements that are typically presented together. For example,
`firstName` and `lastName` can be bundled together into a single composite because they are likely
to be referred to as a group. Grouping elements into a composite also allows the list to be
repeated.

Composite definitions are very similar to segment definitions, composed of some key-value pairs for
standard characteristics along with lists of values. Composites might include both references to
elements or other nested composites and inlined definitions. This is a example of a composite
definition:

```yaml
- id: "DateTime"
  name: "Date/Time pair"
  values:
    - { name: "File Creation Date", type: Date, length: 8 }
    - { name: "File Creation Time", type: Time, length: 4 }
```

Composite definitions might have the following attributes:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Description</th><th>Form</th></tr></thead><tbody><tr><td><p><code>controlVal</code></p></td><td><p>Value from containing level giving actual number of occurrences (only used with <code>count</code> != 1)</p></td><td><p>Inline definition, or on <a href="#referenced_vs_inlined_defs">reference</a></p></td></tr><tr><td><p><code>count</code></p></td><td><p>Number (or maximum number, if <code>controlVal</code> is used) of occurrences (optional, default is <code>1</code>)</p></td><td><p>Inline definition, or on <a href="#referenced_vs_inlined_defs">reference</a></p></td></tr><tr><td><p><code>id</code></p></td><td><p>Composite identifier for references</p></td><td><p><a href="#referenced_vs_inlined_defs">Referenced definition</a></p></td></tr><tr><td><p><code>name</code></p></td><td><p>Composite name (optional)</p></td><td><p>Inline or <a href="#referenced_vs_inlined_defs">referenced definition</a></p></td></tr><tr><td><p><code>values</code></p></td><td><p>List of elements and composites within the composite</p></td><td><p>Inline or <a href="#referenced_vs_inlined_defs">referenced definition</a></p></td></tr></tbody></table>

The values list takes the same form as the values list in a segment definition.

## Segment Definitions

A segment describes a type of record in your data. Segments are mainly composed of references or
direct definitions of elements and composites, together with some key-value pairs that describe the
segment. In a somewhat complex schema, you might have a structure that contains two different
segments, where one of these describes the fields that go in the single header of a bill of
materials (such as date and person), while the other segment describes the recurring fields that go
into each of the actual items in the bill of materials.

This is a sample segment definition that includes one simple element and a composite with two
elements within:

```yaml
- id: "RQH"
  name: Request Header Record
  values:
    - { name: "Organization Code", type: String, length: 10 }
    - id: "DateTime"
      name: "Date/Time pair"
      values:
        - { name: "File Creation Date", type: Date, length: 8 }
        - { name: "File Creation Time", type: Time, length: 4 }
```

Segment definitions might include the following attributes:

<table><colgroup><col> <col></colgroup><thead><tr><th>Section</th><th>Description</th></tr></thead><tbody><tr><td><p><code>id</code></p></td><td><p>Segment identifier (unused for inline definitions, required for <a href="#referenced_vs_inlined_defs">referenced definitions</a>)</p></td></tr><tr><td><p><code>name</code></p></td><td><p>Segment name (optional)</p></td></tr><tr><td><p><code>values</code></p></td><td><p>List of elements and composites within the segment (either inlined, or <a href="#referenced_vs_inlined_defs">references</a>)</p></td></tr></tbody></table>

## Structure Definitions

Structure definitions are composed of a list of references to segments and group definitions, as
well as a set of key-value pairs for standard characteristics. Segments may be further organized
into groups consisting of a potentially repeated sequence of segments.

Here’s a sample structure definition again:

```yaml
form: FIXEDWIDTH
structures:
- id: 'BatchReq'
  name: Batch Request
  data:
  - { idRef: 'RQH' }
  - groupId: 'Batch'
    count: '>1'
    items:
    - { idRef: 'BCH' }
    - { idRef: 'TDR', count: '>1' }
    - { idRef: 'BCF' }
  - { idRef: 'RQF' }
segments:
- id: 'RQH'
  ...
```

This example includes references to two segments at the top level (`RQH` and `RQF`), as well as a
group definition `Batch` that includes references to other segments (`BCH`, `TDR` and `BCF`). Note
that for this structure to work, each of the [referenced segments](#segment_definitions) needs to be
defined. See [Referenced versus Inlined Definitions](#referenced_vs_inlined_defs) to understand how
segments are referenced in this example.

A structure definition can contain the following attributes:

<table><colgroup><col> <col></colgroup><thead><tr><th>Structure Key/Section</th><th>Description</th></tr></thead><tbody><tr><td><p><code>id</code></p></td><td><p>Structure identifier</p></td></tr><tr><td><p><code>name</code></p></td><td><p>Structure name (optional)</p></td></tr><tr><td><p><code>data</code></p></td><td><p>List of segments (and groups) in the structure</p></td></tr></tbody></table>

Each item in a segment list is either a segment reference (or inline definition) or a group
definition (always inline).

### Group Definitions

A group definition can have the following attributes:

<table><colgroup><col> <col></colgroup><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td><p><code>groupId</code></p></td><td><p>The group identifier</p></td></tr><tr><td><p><code>usage</code></p></td><td><p>Usage code, which might be <code>M</code> for Mandatory, <code>O</code> for Optional, or <code>U</code> for Unused (optional, defaults to <code>M</code>)</p></td></tr><tr><td><p><code>count</code></p></td><td><p>Maximum repetition count value, which might be a number or the special value <code>&gt;1</code>, meaning any number of repeats (optional, count value of <code>1</code> is used if not specified)</p></td></tr><tr><td><p><code>items</code></p></td><td><p>List of segments (and potentially nested groups) making up the group</p></td></tr></tbody></table>

## Referenced Versus Inlined Definitions

Besides the choice of top-level form, you also have choices when it comes to representing the
components of a structure, segment, or composite. You can define the component segments, composites,
and elements inline at the point of use, or you can define them in a table and reference them from
anywhere. Inlining definitions is simpler and more compact, but the table form allows definitions to
be reused. Table form examples must include an `id` value, and each reference to that definition
uses an `idRef`. This example shows how this applies to the segments making up a structure:

```yaml
form: FIXEDWIDTH
structures:
  - id: "BatchReq"
    name: Batch Request
    data:
      - { idRef: "RQH" }
      - { idRef: "RQF" }
segments:
  - id: "RQH"
    name: "Request File Header Record"
    values:
      - { idref: createDate }
      - { idref: createTime }
      - { idref: fileId }
      - { idref: currency }
  - id: "RQF"
    name: "Request File Footer Record"
    values:
      - { idref: batchCount }
      - { idref: transactionCount }
      - { idref: transactionAmount }
      - { idref: debitCredit }
      - { idref: fileId }
elements:
  - { id: createDate, type: Date, length: 8 }
  - { id: createTime, type: Time, length: 4 }
  - { id: fileId, type: String, length: 10 }
  - { id: currency, type: String, length: 3 }
  - { id: batchCount, type: Integer, format: { justify: zeroes }, length: 4 }
  - { id: transactionCount, type: Integer, format: { justify: zeroes }, length: 6 }
  - { id: transactionAmount, type: Integer, format: { justify: zeroes }, length: 12 }
  - { id: debitCredit, type: String, length: 2 }
```

In the above example, the `BatchReq` structure references segments in the `data` definition section.
The segments are each then defined in the `segments` section at the top level of the schema, and
these in turn reference elements that are later defined in the `elements` section.

An inlined definition of the same structure looks like this:

```yaml
form: FIXEDWIDTH
structures:
  - id: "BatchReq"
    name: Batch Request
    data:
      - { idRef: "RQH" }
      - { idRef: "RQF" }
segments:
  - id: "RQH"
    name: "Request File Header Record"
    values:
      - { name: "File Creation Date", type: Date, length: 8 }
      - { name: "File Creation Time", type: Time, length: 4 }
      - { name: "Unique File Identifier", type: String, length: 10 }
      - { name: "Currency", type: String, length: 3 }
  - id: "RQF"
    name: "Request File Footer Record"
    values:
      - { name: "File Batch Count", type: Integer, format: { justify: zeroes }, length: 4 }
      - { name: "File Transaction Count", type: Integer, format: { justify: zeroes }, length: 6 }
      - { name: "File Transaction Amount", type: Integer, format: { justify: zeroes }, length: 12 }
      - { name: "Type", type: String, length: 2 }
      - { name: "Unique File Identifier", type: String, length: 10 }
```

## Full Example Schema

```yaml
form: FLATFILE
structures:
  - id: "BatchReq"
    name: Batch Request
    data:
      - { idRef: "RQH" }
      - groupId: "Batch"
        count: ">1"
        items:
          - { idRef: "BCH" }
          - { idRef: "TDR", count: ">1" }
          - { idRef: "BCF" }
      - { idRef: "RQF" }
segments:
  - id: "RQH"
    name: "Request File Header Record"
    values:
      - { name: "Record Type", type: String, length: 3, tagValue: "RQH" }
      - { name: "File Creation Date", type: Date, length: 8 }
      - { name: "File Creation Time", type: Time, length: 4 }
      - { name: "Unique File Identifier", type: String, length: 10 }
      - { name: "Currency", type: String, length: 3 }
  - id: "BCH"
    name: "Batch Header Record"
    values:
      - { name: "Record Type", type: String, length: 3, tagValue: "BAT" }
      - { name: "Sequence Number", type: Integer, format: { justify: zeroes }, length: 6 }
      - { name: "Batch Function", type: String, length: 1, tagValue: "H" }
      - { name: "Company Name", type: String, length: 30 }
      - { name: "Unique Batch Identifier", type: String, length: 10 }
  - id: "TDR"
    name: "Transaction Detail Record"
    values:
      - { name: "Record Type", type: String, length: 3, tagValue: "BAT" }
      - { name: "Sequence Number", type: Integer, format: { justify: zeroes }, length: 6 }
      - { name: "Batch Function", type: String, length: 1, tagValue: "D" }
      - { name: "Account Number", type: String, length: 10 }
      - { name: "Amount", type: Integer, format: { justify: zeroes }, length: 10 }
      - { name: "Type", type: String, length: 2 }
  - id: "BCF"
    name: "Batch Footer Record"
    values:
      - { name: "Record Type", type: String, length: 3, tagValue: "BAT" }
      - { name: "Sequence Number", type: Integer, format: { justify: zeroes }, length: 6 }
      - { name: "Batch Function", type: String, length: 1, tagValue: "T" }
      - { name: "Batch Transaction Amount", type: Integer, format: { justify: zeroes }, length: 10 }
      - { name: "Type", type: String, length: 2 }
      - { name: "Batch Transaction Count", type: Integer, format: { justify: zeroes }, length: 6 }
      - { name: "Unique Batch Identifier", type: String, length: 10 }
  - id: "RQF"
    name: "Request File Footer Record"
    values:
      - { name: "Record Type", type: String, length: 3, tagValue: "RQF" }
      - { name: "File Batch Count", type: Integer, format: { justify: zeroes }, length: 4 }
      - { name: "File Transaction Count", type: Integer, format: { justify: zeroes }, length: 6 }
      - { name: "File Transaction Amount", type: Integer, format: { justify: zeroes }, length: 12 }
      - { name: "Type", type: String, length: 2 }
      - { name: "Unique File Identifier", type: String, length: 10 }
```

This example contains a single [structure](#structure_definitions) named 'BatchReq' with 5
components [segments](#segment_definitions), using a doubly-nested structure of file and batch data
for the segments. Each batch contains repeating detail records. All element definitions are
in-lined.

The `BatchReq` structure definition requires that the data will consist of:

- A single record that corresponds to the segment `RQH`

- One or more records that correspond to the segment `BCH`

- For each `BCH` record, one or more `TDR` records giving details of a particular transaction

- For each `BCH` record, a `BCF` record following any contained `TDR` records

- A final, single record that corresponds to the segment `RQF`

For this example every record starts with a three-character Record Type field with a specified
`tagValue`. In the case of the batch records, the record type is further specified by a Batch
Function `tagValue`.

This is a sample of data matching the schema example:

```text
RQH201809011010A000000001USD
BAT000001HACME RESEARCH                 A000000001
BAT000002D01234567890000032876CR
BAT000003D01234567880000087326CR
BAT000004T0000120202CR000002A000000001
BAT000005HAJAX EXPLOSIVES               A000000002
BAT000006D12345678900000003582DB
BAT000007D12345678910000000256CR
BAT000008T0000003326DB000002A000000002
RQF0002000008000000116876CRA000000001
```

The lines in the example match the defined structure as listed below:

- 1 `RQH` (Request File Header Record) identified by the "RQH" value in the first three characters

- 2 `BCH` (Batch Header Record) identified by the "BAT" value in the first three characters combined
  with the 'H' character in position 10

- 3-4 `TDR` (Transaction Detail Record) identified by the "BAT" value in the first three characters
  combined with the 'D' character in position 10

- 5 `BCF` (Batch Footer Record) identified by the "BAT" value in the first three characters combined
  with the 'T' character in position 10

- 6 `BCH` (Batch Header Record) identified by the "BAT" value in the first three characters combined
  with the 'H' character in position 10

- 7-8 `TDR` (Transaction Detail Record) identified by the "BAT" value in the first three characters
  combined with the 'D' character in position 10

- 9 `BCF` (Batch Footer Record) identified by the "BAT" value in the first three characters combined
  with the 'T' character in position 10

- 10 `RQF` (Request File Footer Record) identified by the "RQF" value in the first three characters

`tagValue` fields provide a lot of flexibility. The above example shows using a single `tagValue`
for some record types, while adding a second `tagValue` for others, but you can also use completely
different fields (or even disjoint sets of fields) for a `tagValue`, as long as you provide enough
details for the parser to distinguish between the different types of records.

Note that older versions of the documentation showed a different way of distinguishing records based
on tag values, using `tagStart` and `tagLength` values for the structure and `tag` values for the
segments. This method of distinguishing segments is much more limited than the `tagValue` approach,
and is now deprecated.

## See Also

[Supported Data Formats](https://docs.mulesoft.com/dataweave/2.11/dataweave-formats#format_flat_file)

<!-- document id=83a0f40c4f5e6a8cf2a7bc9779b12a9bfdffd435cc2ac26d76c9bf70b64a4d8a url=/mulesoft/current/en-us/dataweave/2.12/dataweave-flat-file-schemas.md -->

---
product: DataWeave
version: 2.12
keywords: b2b, edi, schema, dataweave, yaml, language, reference
---

# Flat File Schemas

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave can process several different types of data. For most of these types, you can import a
schema that describes the input structure in order to have access to valuable metadata at design
time.

DataWeave uses a YAML format called FFD (for Flat File Definition) to represent flat file schemas.
The FFD format is flexible enough to support a range of use cases, but is based around the concepts
of elements, composites, segments, groups, and structures.

Schemas must be written in Flat File Schema Language, and by convention use a `.ffd` extension. This
language is very similar to EDI Schema Language (ESL), which is also accepted by Anypoint Studio.

In DataWeave, you can bind your input or output to a flat file schema through a property.

Note that if you intend to use a simple fixed-width format, you can set up your data type directly
through the Transform component using the `Fixed Width` type. Creating an instance of this type in
Studio will automatically generate a matching schema definition.

## Types of Components in a Schema

Here are the different types of components that make up a flat file schema, going from the most
elementary to the more complex. Elements and Segments are always required, while Composites, Groups,
and Structures might be needed depending on the
[top-level structure of your document](#top_level_structure).

- Element - An element is a basic data item, which has an associated type and fixed width, along
  with formatting options for how the data value is read and written.

- Composite - (Optional) A group of elements. It can also include other child composites.

- Segment - A line of data, or record, made up of any number of elements and/or composites that
  might be repeated.

- Group - (Optional) Several segments grouped together. It can also include other child groups.

- Structure - A hierarchical organization of segments, which requires that the segments have unique
  identifier codes as part of their data.

## Top-level structure of an FFD Document

The top-level definition in an FFD document starts with the form of the schema. In this case it must
always be "FLATFILE", "COPYBOOK", or "FIXEDWIDTH". The differences between these forms are minor and
mostly relate to how they are handled in Studio. The rest depends on the form of definitions present
in the file, with the following alternatives:

- Single segment - Segment information directly at the top level (including a `values` key giving
  the element and/or composite details of the segment).

- Multiple segments - A `segments` key with multiple child objects, each defining one segment.

- Multiple structures - A `structures` key with multiple child objects, each defining one structure.

### Single Segment

If you are only working with one type of record, you only need to have a segment definition for that
record type in your FFD.

![A flat file schema with multiple elements and segments](/mulesoft/current/en-us/dataweave/2.12/_images/dataweave-flat-file-schemas-22788.png)

This is a simple schema with only one segment:

```yaml
form: FLATFILE
id: "RQH"
name: Request Header Record
values:
  - { name: "Organization Code", type: String, length: 10 }
  - { name: "File Creation Date", type: Date, length: 8 }
  - { name: "File Creation Time", type: Time, length: 4 }
```

The example above simply defines a list of elements within a single segment. It has no composites to
group them into.

Here is another example:

```yaml
form: FIXEDWIDTH
name: my-flat-file
values:
  - { name: "Row-id", type: String, length: 2 }
  - { name: "Total", type: Decimal, length: 11 }
  - { name: "Module", type: String, length: 8 }
  - { name: "Cost", type: Decimal, length: 8, format: { implicit: 2 } }
  - { name: "Program-id", type: String, length: 8 }
  - { name: "user-id", type: String, length: 8 }
  - { name: "return-sign", type: String, length: 1 }
```

Note that simplified forms are only for convenience. You can use the `segments` key even if you only
have a single child segment definition.

### Multiple Segments

If you are working with multiple types of records in the same transformation, you need to use a
structure definition that controls how these different records are combined.

![A flat file schema with elements and segments](/mulesoft/current/en-us/dataweave/2.12/_images/dataweave-flat-file-schemas-680c6.png)

In most cases, you need to define a way to distinguish between the different types of records. You
do this by identifying `tagValue` fields as part of the record definitions. The parser will check
the content of the fields of each record to identify the record type, then see how it fits into the
defined structure.

This is an example of a complete structure schema with several component record types:

```yaml
form: FIXEDWIDTH
structures:
- id: 'BatchReq'
  name: Batch Request
  data:
  - { idRef: 'RQH' }
  - groupId: 'Batch'
    count: '>1'
    items:
    - { idRef: 'BCH' }
    - { idRef: 'TDR', count: '>1' }
    - { idRef: 'BCF' }
  - { idRef: 'RQF' }
segments:
- id: 'RQH'
  ...
```

Note that this example is not complete. It needs to define each of the referenced segments at the
end. See [Referenced versus Inlined Definitions](#referenced_vs_inlined_defs) to understand how
these segments are being referenced in this example.

### Multiple Structures

If you have multiple structures or segment definitions in an FFD, when you apply your schema to an
metadata description on a Transform component, you need to specify which one you want to use.

![A flat file schema showing groups, segments, and elements](/mulesoft/current/en-us/dataweave/2.12/_images/dataweave-flat-file-schemas-4e1eb.png)

A top-level structure of a schema with multiple structures might look like this:

```yaml
form: FIXEDWIDTH
structures:
- id: 'BatchReq'
  name: Batch Request
  data:
  - { idRef: 'RQH' }
  - groupId: 'Batch'
    usage: O
    count: '>1'
    items:
    - { idRef: 'BCH' }
    - { idRef: 'TDR', count: '>1' }
    - { idRef: 'BCF' }
  - { idRef: 'RQF' }
- id: 'BatchRsp'
  name: Batch Response
  data:
  - { idRef: 'RSH' }
  - groupId: 'Batch'
    usage: O
    count: '>1'
    items:
    - { idRef: 'BCH' }
    - { idRef: 'TDR', count: '>1' }
    - { idRef: 'BCF' }
  - { idRef: 'RSF' }
segments:
- id: 'RQH'
  ...
```

The example defines two different structures, the `BatchReq` structure and the `BatchRsp` structure.
Each of these structures uses a particular sequence of segments and groups of segments. The group
`Batch` is repeated in both structures. A Batch group is composed of a single BCH line, multiple TDR
lines, and a single BCF line.

Note that this example is not complete. It needs to define each of the referenced segments at the
end. See [Referenced versus Inlined Definitions](#referenced_vs_inlined_defs) to understand how
these segments are referenced in this example.

## Element Definitions

Element definitions are the basic building blocks of application data, consisting of basic key-value
pairs for standard characteristics. Flat file schemas generally use inline element definitions,
where each element is defined at the point it is used within a segment or composite structure, but
you can also define elements separately and reference them as needed. Here are several element
definitions defined for use by reference:

```yaml
- { id: "OrgCode", name: "Organization Code", type: String, length: 10 }
- { id: "CreateDate", name: "File Creation Date", type: Date, length: 8 }
- { id: "CreateTime", name: "File Creation Time", type: Time, length: 4 }
- {
    id: "BatchTransCount",
    name: "Batch Transaction Count",
    type: Integer,
    format: { justify: zeroes },
    length: 6,
  }
- {
    id: "BatchTransAmount",
    name: "Batch Transaction Amount",
    type: Integer,
    format: { justify: zeroes },
    length: 10,
  }
```

The supplied `id` value is used as the `idRef` value when referencing one of these definitions as
part of a segment or composite. Note that if you are defining elements inline within a segment
definition (as opposed to defining them at the end of the document and referencing them), the `id`
field is not required.

Element definitions might have the following attributes, classified by Form as applying to inline
definitions, referenced definitions (as in the above example), or references to definitions:

<table><caption>Table 1. Attributes</caption> <colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Description</th><th>Form</th></tr></thead><tbody><tr><td><p><code>count</code></p></td><td><p>Number of occurrences (optional, default is <code>1</code>)</p></td><td><p>Inline or reference</p></td></tr><tr><td><p><code>id</code></p></td><td><p>Element identifier</p></td><td><p>Referenced definition</p></td></tr><tr><td><p><code>idRef</code></p></td><td><p>Element identifier</p></td><td><p>Reference</p></td></tr><tr><td><p><code>name</code></p></td><td><p>Element name (optional)</p></td><td><p>All</p></td></tr><tr><td><p><code>type</code></p></td><td><p>Value type code, as listed below</p></td><td><p>Inline, or referenced definition</p></td></tr><tr><td><p><code>format</code></p></td><td><p>Type-specific formatting information</p></td><td><p>Inline, or referenced definition</p></td></tr><tr><td><p><code>length</code></p></td><td><p>Number of character positions for value</p></td><td><p>Inline, or referenced definition</p></td></tr><tr><td><p><code>tagValue</code></p></td><td><p>Value for this element used to identify a segment (see <a href="#full_schema_ex">the Full Schema Example</a>)</p></td><td><p>Inline, or referenced definition</p></td></tr></tbody></table>

The allowed types for defining an element are:

<table><caption>Table 2. Types</caption> <colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>Binary</p></td><td><p>Binary value (COBOL format, 2, 4, or 8 bytes)</p></td></tr><tr><td><p>Boolean</p></td><td><p>Boolean value</p></td></tr><tr><td><p>Date</p></td><td><p>Unzoned date value with year, month, and day components (which might not all be shown in text form)</p></td></tr><tr><td><p>DateTime</p></td><td><p>Unzoned date/time value with year, month, day, hour, minute, second, and millisecond components (which might not all be shown in text form)</p></td></tr><tr><td><p>Decimal</p></td><td><p>Decimal number value, which might or might not include an explicit decimal point in text form</p></td></tr><tr><td><p>Integer</p></td><td><p>Integer number value</p></td></tr><tr><td><p>Packed</p></td><td><p>Packed decimal representation of a decimal number value (COBOL format)</p></td></tr><tr><td><p>String</p></td><td><p>String value</p></td></tr><tr><td><p>Time</p></td><td><p>Unzoned time value with hour, minute, second, and millisecond components (which might not all be shown in text form)</p></td></tr><tr><td><p>Zoned</p></td><td><p>Zoned decimal (COBOL format)</p></td></tr></tbody></table>

Value types support a range of format options that affect the text form of the values. These are the
main options, along with the types to which they apply:

<table><caption>Table 3. Format Options</caption> <colgroup><col> <col> <col></colgroup><thead><tr><th>Key</th><th>Description</th><th>Applies to</th></tr></thead><tbody><tr><td><p>digits</p></td><td><p>Number of digits allowed</p></td><td><p>Binary</p></td></tr><tr><td><p>implicit</p></td><td><p>Implicit number of decimal digits (used for fixed-point values with no decimal in text form)</p></td><td><p>Binary, Decimal, Packed, Zoned</p></td></tr><tr><td><p>justify</p></td><td><p>Justification in field (LEFT, RIGHT, NONE, or ZEROES, the last only for numbers)</p></td><td><p>All except Binary and Packed</p></td></tr><tr><td><p>pattern</p></td><td><p>For numeric values, the <code>java.text.DecimalFormat</code> pattern for parsing and writing. For date/time values, the <code>java.time.format.DateTimeFormatter</code> pattern.</p></td><td><p>Date, DateTime, Decimal, Integer, Time</p></td></tr><tr><td><p>sign</p></td><td><p>Sign usage for numeric values (UNSIGNED, NEGATIVE_ONLY, OPTIONAL, ALWAYS_LEFT, ALWAYS_RIGHT)</p></td><td><p>Decimal, Integer, Zoned</p></td></tr><tr><td><p>signed</p></td><td><p>Signed versus unsigned flag</p></td><td><p>Binary, Packed</p></td></tr></tbody></table>

## Composite Definitions

Composites serve to reference a list of elements that are typically presented together. For example,
`firstName` and `lastName` can be bundled together into a single composite because they are likely
to be referred to as a group. Grouping elements into a composite also allows the list to be
repeated.

Composite definitions are very similar to segment definitions, composed of some key-value pairs for
standard characteristics along with lists of values. Composites might include both references to
elements or other nested composites and inlined definitions. This is a example of a composite
definition:

```yaml
- id: "DateTime"
  name: "Date/Time pair"
  values:
    - { name: "File Creation Date", type: Date, length: 8 }
    - { name: "File Creation Time", type: Time, length: 4 }
```

Composite definitions might have the following attributes:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Description</th><th>Form</th></tr></thead><tbody><tr><td><p><code>controlVal</code></p></td><td><p>Value from containing level giving actual number of occurrences (only used with <code>count</code> != 1)</p></td><td><p>Inline definition, or on <a href="#referenced_vs_inlined_defs">reference</a></p></td></tr><tr><td><p><code>count</code></p></td><td><p>Number (or maximum number, if <code>controlVal</code> is used) of occurrences (optional, default is <code>1</code>)</p></td><td><p>Inline definition, or on <a href="#referenced_vs_inlined_defs">reference</a></p></td></tr><tr><td><p><code>id</code></p></td><td><p>Composite identifier for references</p></td><td><p><a href="#referenced_vs_inlined_defs">Referenced definition</a></p></td></tr><tr><td><p><code>name</code></p></td><td><p>Composite name (optional)</p></td><td><p>Inline or <a href="#referenced_vs_inlined_defs">referenced definition</a></p></td></tr><tr><td><p><code>values</code></p></td><td><p>List of elements and composites within the composite</p></td><td><p>Inline or <a href="#referenced_vs_inlined_defs">referenced definition</a></p></td></tr></tbody></table>

The values list takes the same form as the values list in a segment definition.

## Segment Definitions

A segment describes a type of record in your data. Segments are mainly composed of references or
direct definitions of elements and composites, together with some key-value pairs that describe the
segment. In a somewhat complex schema, you might have a structure that contains two different
segments, where one of these describes the fields that go in the single header of a bill of
materials (such as date and person), while the other segment describes the recurring fields that go
into each of the actual items in the bill of materials.

This is a sample segment definition that includes one simple element and a composite with two
elements within:

```yaml
- id: "RQH"
  name: Request Header Record
  values:
    - { name: "Organization Code", type: String, length: 10 }
    - id: "DateTime"
      name: "Date/Time pair"
      values:
        - { name: "File Creation Date", type: Date, length: 8 }
        - { name: "File Creation Time", type: Time, length: 4 }
```

Segment definitions might include the following attributes:

<table><colgroup><col> <col></colgroup><thead><tr><th>Section</th><th>Description</th></tr></thead><tbody><tr><td><p><code>id</code></p></td><td><p>Segment identifier (unused for inline definitions, required for <a href="#referenced_vs_inlined_defs">referenced definitions</a>)</p></td></tr><tr><td><p><code>name</code></p></td><td><p>Segment name (optional)</p></td></tr><tr><td><p><code>values</code></p></td><td><p>List of elements and composites within the segment (either inlined, or <a href="#referenced_vs_inlined_defs">references</a>)</p></td></tr></tbody></table>

## Structure Definitions

Structure definitions are composed of a list of references to segments and group definitions, as
well as a set of key-value pairs for standard characteristics. Segments may be further organized
into groups consisting of a potentially repeated sequence of segments.

Here’s a sample structure definition again:

```yaml
form: FIXEDWIDTH
structures:
- id: 'BatchReq'
  name: Batch Request
  data:
  - { idRef: 'RQH' }
  - groupId: 'Batch'
    count: '>1'
    items:
    - { idRef: 'BCH' }
    - { idRef: 'TDR', count: '>1' }
    - { idRef: 'BCF' }
  - { idRef: 'RQF' }
segments:
- id: 'RQH'
  ...
```

This example includes references to two segments at the top level (`RQH` and `RQF`), as well as a
group definition `Batch` that includes references to other segments (`BCH`, `TDR` and `BCF`). Note
that for this structure to work, each of the [referenced segments](#segment_definitions) needs to be
defined. See [Referenced versus Inlined Definitions](#referenced_vs_inlined_defs) to understand how
segments are referenced in this example.

A structure definition can contain the following attributes:

<table><colgroup><col> <col></colgroup><thead><tr><th>Structure Key/Section</th><th>Description</th></tr></thead><tbody><tr><td><p><code>id</code></p></td><td><p>Structure identifier</p></td></tr><tr><td><p><code>name</code></p></td><td><p>Structure name (optional)</p></td></tr><tr><td><p><code>data</code></p></td><td><p>List of segments (and groups) in the structure</p></td></tr></tbody></table>

Each item in a segment list is either a segment reference (or inline definition) or a group
definition (always inline).

### Group Definitions

A group definition can have the following attributes:

<table><colgroup><col> <col></colgroup><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td><p><code>groupId</code></p></td><td><p>The group identifier</p></td></tr><tr><td><p><code>usage</code></p></td><td><p>Usage code, which might be <code>M</code> for Mandatory, <code>O</code> for Optional, or <code>U</code> for Unused (optional, defaults to <code>M</code>)</p></td></tr><tr><td><p><code>count</code></p></td><td><p>Maximum repetition count value, which might be a number or the special value <code>&gt;1</code>, meaning any number of repeats (optional, count value of <code>1</code> is used if not specified)</p></td></tr><tr><td><p><code>items</code></p></td><td><p>List of segments (and potentially nested groups) making up the group</p></td></tr></tbody></table>

## Referenced Versus Inlined Definitions

Besides the choice of top-level form, you also have choices when it comes to representing the
components of a structure, segment, or composite. You can define the component segments, composites,
and elements inline at the point of use, or you can define them in a table and reference them from
anywhere. Inlining definitions is simpler and more compact, but the table form allows definitions to
be reused. Table form examples must include an `id` value, and each reference to that definition
uses an `idRef`. This example shows how this applies to the segments making up a structure:

```yaml
form: FIXEDWIDTH
structures:
  - id: "BatchReq"
    name: Batch Request
    data:
      - { idRef: "RQH" }
      - { idRef: "RQF" }
segments:
  - id: "RQH"
    name: "Request File Header Record"
    values:
      - { idref: createDate }
      - { idref: createTime }
      - { idref: fileId }
      - { idref: currency }
  - id: "RQF"
    name: "Request File Footer Record"
    values:
      - { idref: batchCount }
      - { idref: transactionCount }
      - { idref: transactionAmount }
      - { idref: debitCredit }
      - { idref: fileId }
elements:
  - { id: createDate, type: Date, length: 8 }
  - { id: createTime, type: Time, length: 4 }
  - { id: fileId, type: String, length: 10 }
  - { id: currency, type: String, length: 3 }
  - { id: batchCount, type: Integer, format: { justify: zeroes }, length: 4 }
  - { id: transactionCount, type: Integer, format: { justify: zeroes }, length: 6 }
  - { id: transactionAmount, type: Integer, format: { justify: zeroes }, length: 12 }
  - { id: debitCredit, type: String, length: 2 }
```

In the above example, the `BatchReq` structure references segments in the `data` definition section.
The segments are each then defined in the `segments` section at the top level of the schema, and
these in turn reference elements that are later defined in the `elements` section.

An inlined definition of the same structure looks like this:

```yaml
form: FIXEDWIDTH
structures:
  - id: "BatchReq"
    name: Batch Request
    data:
      - { idRef: "RQH" }
      - { idRef: "RQF" }
segments:
  - id: "RQH"
    name: "Request File Header Record"
    values:
      - { name: "File Creation Date", type: Date, length: 8 }
      - { name: "File Creation Time", type: Time, length: 4 }
      - { name: "Unique File Identifier", type: String, length: 10 }
      - { name: "Currency", type: String, length: 3 }
  - id: "RQF"
    name: "Request File Footer Record"
    values:
      - { name: "File Batch Count", type: Integer, format: { justify: zeroes }, length: 4 }
      - { name: "File Transaction Count", type: Integer, format: { justify: zeroes }, length: 6 }
      - { name: "File Transaction Amount", type: Integer, format: { justify: zeroes }, length: 12 }
      - { name: "Type", type: String, length: 2 }
      - { name: "Unique File Identifier", type: String, length: 10 }
```

## Full Example Schema

```yaml
form: FLATFILE
structures:
  - id: "BatchReq"
    name: Batch Request
    data:
      - { idRef: "RQH" }
      - groupId: "Batch"
        count: ">1"
        items:
          - { idRef: "BCH" }
          - { idRef: "TDR", count: ">1" }
          - { idRef: "BCF" }
      - { idRef: "RQF" }
segments:
  - id: "RQH"
    name: "Request File Header Record"
    values:
      - { name: "Record Type", type: String, length: 3, tagValue: "RQH" }
      - { name: "File Creation Date", type: Date, length: 8 }
      - { name: "File Creation Time", type: Time, length: 4 }
      - { name: "Unique File Identifier", type: String, length: 10 }
      - { name: "Currency", type: String, length: 3 }
  - id: "BCH"
    name: "Batch Header Record"
    values:
      - { name: "Record Type", type: String, length: 3, tagValue: "BAT" }
      - { name: "Sequence Number", type: Integer, format: { justify: zeroes }, length: 6 }
      - { name: "Batch Function", type: String, length: 1, tagValue: "H" }
      - { name: "Company Name", type: String, length: 30 }
      - { name: "Unique Batch Identifier", type: String, length: 10 }
  - id: "TDR"
    name: "Transaction Detail Record"
    values:
      - { name: "Record Type", type: String, length: 3, tagValue: "BAT" }
      - { name: "Sequence Number", type: Integer, format: { justify: zeroes }, length: 6 }
      - { name: "Batch Function", type: String, length: 1, tagValue: "D" }
      - { name: "Account Number", type: String, length: 10 }
      - { name: "Amount", type: Integer, format: { justify: zeroes }, length: 10 }
      - { name: "Type", type: String, length: 2 }
  - id: "BCF"
    name: "Batch Footer Record"
    values:
      - { name: "Record Type", type: String, length: 3, tagValue: "BAT" }
      - { name: "Sequence Number", type: Integer, format: { justify: zeroes }, length: 6 }
      - { name: "Batch Function", type: String, length: 1, tagValue: "T" }
      - { name: "Batch Transaction Amount", type: Integer, format: { justify: zeroes }, length: 10 }
      - { name: "Type", type: String, length: 2 }
      - { name: "Batch Transaction Count", type: Integer, format: { justify: zeroes }, length: 6 }
      - { name: "Unique Batch Identifier", type: String, length: 10 }
  - id: "RQF"
    name: "Request File Footer Record"
    values:
      - { name: "Record Type", type: String, length: 3, tagValue: "RQF" }
      - { name: "File Batch Count", type: Integer, format: { justify: zeroes }, length: 4 }
      - { name: "File Transaction Count", type: Integer, format: { justify: zeroes }, length: 6 }
      - { name: "File Transaction Amount", type: Integer, format: { justify: zeroes }, length: 12 }
      - { name: "Type", type: String, length: 2 }
      - { name: "Unique File Identifier", type: String, length: 10 }
```

This example contains a single [structure](#structure_definitions) named 'BatchReq' with 5
components [segments](#segment_definitions), using a doubly-nested structure of file and batch data
for the segments. Each batch contains repeating detail records. All element definitions are
in-lined.

The `BatchReq` structure definition requires that the data will consist of:

- A single record that corresponds to the segment `RQH`

- One or more records that correspond to the segment `BCH`

- For each `BCH` record, one or more `TDR` records giving details of a particular transaction

- For each `BCH` record, a `BCF` record following any contained `TDR` records

- A final, single record that corresponds to the segment `RQF`

For this example every record starts with a three-character Record Type field with a specified
`tagValue`. In the case of the batch records, the record type is further specified by a Batch
Function `tagValue`.

This is a sample of data matching the schema example:

```text
RQH201809011010A000000001USD
BAT000001HACME RESEARCH                 A000000001
BAT000002D01234567890000032876CR
BAT000003D01234567880000087326CR
BAT000004T0000120202CR000002A000000001
BAT000005HAJAX EXPLOSIVES               A000000002
BAT000006D12345678900000003582DB
BAT000007D12345678910000000256CR
BAT000008T0000003326DB000002A000000002
RQF0002000008000000116876CRA000000001
```

The lines in the example match the defined structure as listed below:

- 1 `RQH` (Request File Header Record) identified by the "RQH" value in the first three characters

- 2 `BCH` (Batch Header Record) identified by the "BAT" value in the first three characters combined
  with the 'H' character in position 10

- 3-4 `TDR` (Transaction Detail Record) identified by the "BAT" value in the first three characters
  combined with the 'D' character in position 10

- 5 `BCF` (Batch Footer Record) identified by the "BAT" value in the first three characters combined
  with the 'T' character in position 10

- 6 `BCH` (Batch Header Record) identified by the "BAT" value in the first three characters combined
  with the 'H' character in position 10

- 7-8 `TDR` (Transaction Detail Record) identified by the "BAT" value in the first three characters
  combined with the 'D' character in position 10

- 9 `BCF` (Batch Footer Record) identified by the "BAT" value in the first three characters combined
  with the 'T' character in position 10

- 10 `RQF` (Request File Footer Record) identified by the "RQF" value in the first three characters

`tagValue` fields provide a lot of flexibility. The above example shows using a single `tagValue`
for some record types, while adding a second `tagValue` for others, but you can also use completely
different fields (or even disjoint sets of fields) for a `tagValue`, as long as you provide enough
details for the parser to distinguish between the different types of records.

Note that older versions of the documentation showed a different way of distinguishing records based
on tag values, using `tagStart` and `tagLength` values for the structure and `tag` values for the
segments. This method of distinguishing segments is much more limited than the `tagValue` approach,
and is now deprecated.

## See Also

[Supported Data Formats](https://docs.mulesoft.com/dataweave/2.12/dataweave-formats#format_flat_file)

<!-- document id=d67c181975f75cb49c3104d47dec4c491eb3c977bd9ddf04ed87e138b228d213 url=/mulesoft/current/en-us/dataweave/2.3/dataweave-flat-file-schemas.md -->

---
product: DataWeave
version: 2.3
keywords: b2b, edi, schema, dataweave, yaml, language, reference
---

# Flat File Schemas

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave can process several different types of data. For most of these types, you can import a
schema that describes the input structure in order to have access to valuable metadata at design
time.

DataWeave uses a YAML format called FFD (for Flat File Definition) to represent flat file schemas.
The FFD format is flexible enough to support a range of use cases, but is based around the concepts
of elements, composites, segments, groups, and structures.

Schemas must be written in Flat File Schema Language, and by convention use a `.ffd` extension. This
language is very similar to EDI Schema Language (ESL), which is also accepted by Anypoint Studio.

In DataWeave, you can bind your input or output to a flat file schema through a property.

Note that if you intend to use a simple fixed-width format, you can set up your data type directly
through the Transform component using the `Fixed Width` type. Creating an instance of this type in
Studio will automatically generate a matching schema definition.

## Types of Components in a Schema

Here are the different types of components that make up a flat file schema, going from the most
elementary to the more complex. Elements and Segments are always required, while Composites, Groups,
and Structures might be needed depending on the
[top-level structure of your document](#top_level_structure).

- Element - An element is a basic data item, which has an associated type and fixed width, along
  with formatting options for how the data value is read and written.

- Composite - (Optional) A group of elements. It can also include other child composites.

- Segment - A line of data, or record, made up of any number of elements and/or composites that
  might be repeated.

- Group - (Optional) Several segments grouped together. It can also include other child groups.

- Structure - A hierarchical organization of segments, which requires that the segments have unique
  identifier codes as part of their data.

## Top-level structure of an FFD Document

The top-level definition in an FFD document starts with the form of the schema. In this case it must
always be "FLATFILE", "COPYBOOK", or "FIXEDWIDTH". The differences between these forms are minor and
mostly relate to how they are handled in Studio. The rest depends on the form of definitions present
in the file, with the following alternatives:

- Single segment - Segment information directly at the top level (including a `values` key giving
  the element and/or composite details of the segment).

- Multiple segments - A `segments` key with multiple child objects, each defining one segment.

- Multiple structures - A `structures` key with multiple child objects, each defining one structure.

### Single Segment

If you are only working with one type of record, you only need to have a segment definition for that
record type in your FFD.

![A flat file schema with multiple elements and segments](/mulesoft/current/en-us/dataweave/2.3/_images/dataweave-flat-file-schemas-22788.png)

This is a simple schema with only one segment:

```yaml
form: FLATFILE
id: "RQH"
name: Request Header Record
values:
  - { name: "Organization Code", type: String, length: 10 }
  - { name: "File Creation Date", type: Date, length: 8 }
  - { name: "File Creation Time", type: Time, length: 4 }
```

The example above simply defines a list of elements within a single segment. It has no composites to
group them into.

Here is another example:

```yaml
form: FIXEDWIDTH
name: my-flat-file
values:
  - { name: "Row-id", type: String, length: 2 }
  - { name: "Total", type: Decimal, length: 11 }
  - { name: "Module", type: String, length: 8 }
  - { name: "Cost", type: Decimal, length: 8, format: { implicit: 2 } }
  - { name: "Program-id", type: String, length: 8 }
  - { name: "user-id", type: String, length: 8 }
  - { name: "return-sign", type: String, length: 1 }
```

Note that simplified forms are only for convenience. You can use the `segments` key even if you only
have a single child segment definition.

### Multiple Segments

If you are working with multiple types of records in the same transformation, you need to use a
structure definition that controls how these different records are combined.

![A flat file schema with elements and segments](/mulesoft/current/en-us/dataweave/2.3/_images/dataweave-flat-file-schemas-680c6.png)

In most cases, you need to define a way to distinguish between the different types of records. You
do this by identifying `tagValue` fields as part of the record definitions. The parser will check
the content of the fields of each record to identify the record type, then see how it fits into the
defined structure.

This is an example of a complete structure schema with several component record types:

```yaml
form: FIXEDWIDTH
structures:
- id: 'BatchReq'
  name: Batch Request
  data:
  - { idRef: 'RQH' }
  - groupId: 'Batch'
    count: '>1'
    items:
    - { idRef: 'BCH' }
    - { idRef: 'TDR', count: '>1' }
    - { idRef: 'BCF' }
  - { idRef: 'RQF' }
segments:
- id: 'RQH'
  ...
```

Note that this example is not complete. It needs to define each of the referenced segments at the
end. See [Referenced versus Inlined Definitions](#referenced_vs_inlined_defs) to understand how
these segments are being referenced in this example.

### Multiple Structures

If you have multiple structures or segment definitions in an FFD, when you apply your schema to an
metadata description on a Transform component, you need to specify which one you want to use.

![A flat file schema showing groups, segments, and elements](/mulesoft/current/en-us/dataweave/2.3/_images/dataweave-flat-file-schemas-4e1eb.png)

A top-level structure of a schema with multiple structures might look like this:

```yaml
form: FIXEDWIDTH
structures:
- id: 'BatchReq'
  name: Batch Request
  data:
  - { idRef: 'RQH' }
  - groupId: 'Batch'
    usage: O
    count: '>1'
    items:
    - { idRef: 'BCH' }
    - { idRef: 'TDR', count: '>1' }
    - { idRef: 'BCF' }
  - { idRef: 'RQF' }
- id: 'BatchRsp'
  name: Batch Response
  data:
  - { idRef: 'RSH' }
  - groupId: 'Batch'
    usage: O
    count: '>1'
    items:
    - { idRef: 'BCH' }
    - { idRef: 'TDR', count: '>1' }
    - { idRef: 'BCF' }
  - { idRef: 'RSF' }
segments:
- id: 'RQH'
  ...
```

The example defines two different structures, the `BatchReq` structure and the `BatchRsp` structure.
Each of these structures uses a particular sequence of segments and groups of segments. The group
`Batch` is repeated in both structures. A Batch group is composed of a single BCH line, multiple TDR
lines, and a single BCF line.

Note that this example is not complete. It needs to define each of the referenced segments at the
end. See [Referenced versus Inlined Definitions](#referenced_vs_inlined_defs) to understand how
these segments are referenced in this example.

## Element Definitions

Element definitions are the basic building blocks of application data, consisting of basic key-value
pairs for standard characteristics. Flat file schemas generally use inline element definitions,
where each element is defined at the point it is used within a segment or composite structure, but
you can also define elements separately and reference them as needed. Here are several element
definitions defined for use by reference:

```yaml
- { id: "OrgCode", name: "Organization Code", type: String, length: 10 }
- { id: "CreatDate", name: "File Creation Date", type: Date, length: 8 }
- { id: "CreatTime", name: "File Creation Time", type: Time, length: 4 }
- {
    id: "BatchTransCount",
    name: "Batch Transaction Count",
    type: Integer,
    format: { justify: zeroes },
    length: 6,
  }
- {
    id: "BatchTransAmount",
    name: "Batch Transaction Amount",
    type: Integer,
    format: { justify: zeroes },
    length: 10,
  }
```

The supplied `id` value is used as the `idRef` value when referencing one of these definitions as
part of a segment or composite. Note that if you are defining elements inline within a segment
definition (as opposed to defining them at the end of the document and referencing them), the `id`
field is not required.

Element definitions might have the following attributes, classified by Form as applying to inline
definitions, referenced definitions (as in the above example), or references to definitions:

<table><caption>Table 1. Attributes</caption> <colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Description</th><th>Form</th></tr></thead><tbody><tr><td><p><code>count</code></p></td><td><p>Number of occurrences (optional, default is <code>1</code>)</p></td><td><p>Inline or reference</p></td></tr><tr><td><p><code>id</code></p></td><td><p>Element identifier</p></td><td><p>Referenced definition</p></td></tr><tr><td><p><code>idRef</code></p></td><td><p>Element identifier</p></td><td><p>Reference</p></td></tr><tr><td><p><code>name</code></p></td><td><p>Element name (optional)</p></td><td><p>All</p></td></tr><tr><td><p><code>type</code></p></td><td><p>Value type code, as listed below</p></td><td><p>Inline, or referenced definition</p></td></tr><tr><td><p><code>format</code></p></td><td><p>Type-specific formatting information</p></td><td><p>Inline, or referenced definition</p></td></tr><tr><td><p><code>length</code></p></td><td><p>Number of character positions for value</p></td><td><p>Inline, or referenced definition</p></td></tr><tr><td><p><code>tagValue</code></p></td><td><p>Value for this element used to identify a segment (see <a href="#full_schema_ex">the Full Schema Example</a>)</p></td><td><p>Inline, or referenced definition</p></td></tr></tbody></table>

The allowed types for defining an element are:

<table><caption>Table 2. Types</caption> <colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>Binary</p></td><td><p>Binary value (COBOL format, 2, 4, or 8 bytes)</p></td></tr><tr><td><p>Boolean</p></td><td><p>Boolean value</p></td></tr><tr><td><p>Date</p></td><td><p>Unzoned date value with year, month, and day components (which might not all be shown in text form)</p></td></tr><tr><td><p>DateTime</p></td><td><p>Unzoned date/time value with year, month, day, hour, minute, second, and millisecond components (which might not all be shown in text form)</p></td></tr><tr><td><p>Decimal</p></td><td><p>Decimal number value, which might or might not include an explicit decimal point in text form</p></td></tr><tr><td><p>Integer</p></td><td><p>Integer number value</p></td></tr><tr><td><p>Packed</p></td><td><p>Packed decimal representation of a decimal number value (COBOL format)</p></td></tr><tr><td><p>String</p></td><td><p>String value</p></td></tr><tr><td><p>Time</p></td><td><p>Unzoned time value with hour, minute, second, and millisecond components (which might not all be shown in text form)</p></td></tr><tr><td><p>Zoned</p></td><td><p>Zoned decimal (COBOL format)</p></td></tr></tbody></table>

Value types support a range of format options that affect the text form of the values. These are the
main options, along with the types to which they apply:

<table><caption>Table 3. Format Options</caption> <colgroup><col> <col> <col></colgroup><thead><tr><th>Key</th><th>Description</th><th>Applies to</th></tr></thead><tbody><tr><td><p>digits</p></td><td><p>Number of digits allowed</p></td><td><p>Binary</p></td></tr><tr><td><p>implicit</p></td><td><p>Implicit number of decimal digits (used for fixed-point values with no decimal in text form)</p></td><td><p>Binary, Decimal, Packed, Zoned</p></td></tr><tr><td><p>justify</p></td><td><p>Justification in field (LEFT, RIGHT, NONE, or ZEROES, the last only for numbers)</p></td><td><p>All except Binary and Packed</p></td></tr><tr><td><p>pattern</p></td><td><p>For numeric values, the <code>java.text.DecimalFormat</code> pattern for parsing and writing. For date/time values, the <code>java.time.format.DateTimeFormatter</code> pattern.</p></td><td><p>Date, DateTime, Decimal, Integer, Time</p></td></tr><tr><td><p>sign</p></td><td><p>Sign usage for numeric values (UNSIGNED, NEGATIVE_ONLY, OPTIONAL, ALWAYS_LEFT, ALWAYS_RIGHT)</p></td><td><p>Decimal, Integer, Zoned</p></td></tr><tr><td><p>signed</p></td><td><p>Signed versus unsigned flag</p></td><td><p>Binary, Packed</p></td></tr></tbody></table>

## Composite Definitions

Composites serve to reference a list of elements that are typically presented together. For example,
`firstName` and `lastName` can be bundled together into a single composite because they are likely
to be referred to as a group. Grouping elements into a composite also allows the list to be
repeated.

Composite definitions are very similar to segment definitions, composed of some key-value pairs for
standard characteristics along with lists of values. Composites might include both references to
elements or other nested composites and inlined definitions. This is a example of a composite
definition:

```yaml
- id: "DateTime"
  name: "Date/Time pair"
  values:
    - { name: "File Creation Date", type: Date, length: 8 }
    - { name: "File Creation Time", type: Time, length: 4 }
```

Composite definitions might have the following attributes:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Description</th><th>Form</th></tr></thead><tbody><tr><td><p><code>controlVal</code></p></td><td><p>Value from containing level giving actual number of occurrences (only used with <code>count</code> != 1)</p></td><td><p>Inline definition, or on <a href="#referenced_vs_inlined_defs">reference</a></p></td></tr><tr><td><p><code>count</code></p></td><td><p>Number (or maximum number, if <code>controlVal</code> is used) of occurrences (optional, default is <code>1</code>)</p></td><td><p>Inline definition, or on <a href="#referenced_vs_inlined_defs">reference</a></p></td></tr><tr><td><p><code>id</code></p></td><td><p>Composite identifier for references</p></td><td><p><a href="#referenced_vs_inlined_defs">Referenced definition</a></p></td></tr><tr><td><p><code>name</code></p></td><td><p>Composite name (optional)</p></td><td><p>Inline or <a href="#referenced_vs_inlined_defs">referenced definition</a></p></td></tr><tr><td><p><code>values</code></p></td><td><p>List of elements and composites within the composite</p></td><td><p>Inline or <a href="#referenced_vs_inlined_defs">referenced definition</a></p></td></tr></tbody></table>

The values list takes the same form as the values list in a segment definition.

## Segment Definitions

A segment describes a type of record in your data. Segments are mainly composed of references or
direct definitions of elements and composites, together with some key-value pairs that describe the
segment. In a somewhat complex schema, you might have a structure that contains two different
segments, where one of these describes the fields that go in the single header of a bill of
materials (such as date and person), while the other segment describes the recurring fields that go
into each of the actual items in the bill of materials.

This is a sample segment definition that includes one simple element and a composite with two
elements within:

```yaml
- id: "RQH"
  name: Request Header Record
  values:
    - { name: "Organization Code", type: String, length: 10 }
    - id: "DateTime"
      name: "Date/Time pair"
      values:
        - { name: "File Creation Date", type: Date, length: 8 }
        - { name: "File Creation Time", type: Time, length: 4 }
```

Segment definitions might include the following attributes:

<table><colgroup><col> <col></colgroup><thead><tr><th>Section</th><th>Description</th></tr></thead><tbody><tr><td><p><code>id</code></p></td><td><p>Segment identifier (unused for inline definitions, required for <a href="#referenced_vs_inlined_defs">referenced definitions</a>)</p></td></tr><tr><td><p><code>name</code></p></td><td><p>Segment name (optional)</p></td></tr><tr><td><p><code>values</code></p></td><td><p>List of elements and composites within the segment (either inlined, or <a href="#referenced_vs_inlined_defs">references</a>)</p></td></tr></tbody></table>

## Structure Definitions

Structure definitions are composed of a list of references to segments and group definitions, as
well as a set of key-value pairs for standard characteristics. Segments may be further organized
into groups consisting of a potentially repeated sequence of segments.

Here’s a sample structure definition again:

```yaml
form: FIXEDWIDTH
structures:
- id: 'BatchReq'
  name: Batch Request
  data:
  - { idRef: 'RQH' }
  - groupId: 'Batch'
    count: '>1'
    items:
    - { idRef: 'BCH' }
    - { idRef: 'TDR', count: '>1' }
    - { idRef: 'BCF' }
  - { idRef: 'RQF' }
segments:
- id: 'RQH'
  ...
```

This example includes references to two segments at the top level (`RQH` and `RQF`), as well as a
group definition `Batch` that includes references to other segments (`BCH`, `TDR` and `BCF`). Note
that for this structure to work, each of the [referenced segments](#segment_definitions) needs to be
defined. See [Referenced versus Inlined Definitions](#referenced_vs_inlined_defs) to understand how
segments are referenced in this example.

A structure definition can contain the following attributes:

<table><colgroup><col> <col></colgroup><thead><tr><th>Structure Key/Section</th><th>Description</th></tr></thead><tbody><tr><td><p><code>id</code></p></td><td><p>Structure identifier</p></td></tr><tr><td><p><code>name</code></p></td><td><p>Structure name (optional)</p></td></tr><tr><td><p><code>data</code></p></td><td><p>List of segments (and groups) in the structure</p></td></tr></tbody></table>

Each item in a segment list is either a segment reference (or inline definition) or a group
definition (always inline).

### Group Definitions

A group definition can have the following attributes:

<table><colgroup><col> <col></colgroup><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td><p><code>groupId</code></p></td><td><p>The group identifier</p></td></tr><tr><td><p><code>usage</code></p></td><td><p>Usage code, which might be <code>M</code> for Mandatory, <code>O</code> for Optional, or <code>U</code> for Unused (optional, defaults to <code>M</code>)</p></td></tr><tr><td><p><code>count</code></p></td><td><p>Maximum repetition count value, which might be a number or the special value <code>&gt;1</code>, meaning any number of repeats (optional, count value of <code>1</code> is used if not specified)</p></td></tr><tr><td><p><code>items</code></p></td><td><p>List of segments (and potentially nested groups) making up the group</p></td></tr></tbody></table>

## Referenced Versus Inlined Definitions

Besides the choice of top-level form, you also have choices when it comes to representing the
components of a structure, segment, or composite. You can define the component segments, composites,
and elements inline at the point of use, or you can define them in a table and reference them from
anywhere. Inlining definitions is simpler and more compact, but the table form allows definitions to
be reused. Table form examples must include an `id` value, and each reference to that definition
uses an `idRef`. This example shows how this applies to the segments making up a structure:

```yaml
form: FIXEDWIDTH
structures:
  - id: "BatchReq"
    name: Batch Request
    data:
      - { idRef: "RQH" }
      - { idRef: "RQF" }
segments:
  - id: "RQH"
    name: "Request File Header Record"
    values:
      - { idref: createDate }
      - { idref: createTime }
      - { idref: fileId }
      - { idref: currency }
  - id: "RQF"
    name: "Request File Footer Record"
    values:
      - { idref: batchCount }
      - { idref: transactionCount }
      - { idref: transactionAmount }
      - { idref: debitCredit }
      - { idref: fileId }
elements:
  - { id: createDate, type: Date, length: 8 }
  - { id: createTime, type: Time, length: 4 }
  - { id: fileId, type: String, length: 10 }
  - { id: currency, type: String, length: 3 }
  - { id: batchCount, type: Integer, format: { justify: zeroes }, length: 4 }
  - { id: transactionCount, type: Integer, format: { justify: zeroes }, length: 6 }
  - { id: transactionAmount, type: Integer, format: { justify: zeroes }, length: 12 }
  - { id: debitCredit, type: String, length: 2 }
```

In the above example, the `BatchReq` structure references segments in the `data` definition section.
The segments are each then defined in the `segments` section at the top level of the schema, and
these in turn reference elements that are later defined in the `elements` section.

An inlined definition of the same structure looks like this:

```yaml
form: FIXEDWIDTH
structures:
  - id: "BatchReq"
    name: Batch Request
    data:
      - { idRef: "RQH" }
      - { idRef: "RQF" }
segments:
  - id: "RQH"
    name: "Request File Header Record"
    values:
      - { name: "File Creation Date", type: Date, length: 8 }
      - { name: "File Creation Time", type: Time, length: 4 }
      - { name: "Unique File Identifier", type: String, length: 10 }
      - { name: "Currency", type: String, length: 3 }
  - id: "RQF"
    name: "Request File Footer Record"
    values:
      - { name: "File Batch Count", type: Integer, format: { justify: zeroes }, length: 4 }
      - { name: "File Transaction Count", type: Integer, format: { justify: zeroes }, length: 6 }
      - { name: "File Transaction Amount", type: Integer, format: { justify: zeroes }, length: 12 }
      - { name: "Type", type: String, length: 2 }
      - { name: "Unique File Identifier", type: String, length: 10 }
```

## Full Example Schema

```yaml
form: FLATFILE
structures:
  - id: "BatchReq"
    name: Batch Request
    data:
      - { idRef: "RQH" }
      - groupId: "Batch"
        count: ">1"
        items:
          - { idRef: "BCH" }
          - { idRef: "TDR", count: ">1" }
          - { idRef: "BCF" }
      - { idRef: "RQF" }
segments:
  - id: "RQH"
    name: "Request File Header Record"
    values:
      - { name: "Record Type", type: String, length: 3, tagValue: "RQH" }
      - { name: "File Creation Date", type: Date, length: 8 }
      - { name: "File Creation Time", type: Time, length: 4 }
      - { name: "Unique File Identifier", type: String, length: 10 }
      - { name: "Currency", type: String, length: 3 }
  - id: "BCH"
    name: "Batch Header Record"
    values:
      - { name: "Record Type", type: String, length: 3, tagValue: "BAT" }
      - { name: "Sequence Number", type: Integer, format: { justify: zeroes }, length: 6 }
      - { name: "Batch Function", type: String, length: 1, tagValue: "H" }
      - { name: "Company Name", type: String, length: 30 }
      - { name: "Unique Batch Identifier", type: String, length: 10 }
  - id: "TDR"
    name: "Transaction Detail Record"
    values:
      - { name: "Record Type", type: String, length: 3, tagValue: "BAT" }
      - { name: "Sequence Number", type: Integer, format: { justify: zeroes }, length: 6 }
      - { name: "Batch Function", type: String, length: 1, tagValue: "D" }
      - { name: "Account Number", type: String, length: 10 }
      - { name: "Amount", type: Integer, format: { justify: zeroes }, length: 10 }
      - { name: "Type", type: String, length: 2 }
  - id: "BCF"
    name: "Batch Footer Record"
    values:
      - { name: "Record Type", type: String, length: 3, tagValue: "BAT" }
      - { name: "Sequence Number", type: Integer, format: { justify: zeroes }, length: 6 }
      - { name: "Batch Function", type: String, length: 1, tagValue: "T" }
      - { name: "Batch Transaction Amount", type: Integer, format: { justify: zeroes }, length: 10 }
      - { name: "Type", type: String, length: 2 }
      - { name: "Batch Transaction Count", type: Integer, format: { justify: zeroes }, length: 6 }
      - { name: "Unique Batch Identifier", type: String, length: 10 }
  - id: "RQF"
    name: "Request File Footer Record"
    values:
      - { name: "Record Type", type: String, length: 3, tagValue: "RQF" }
      - { name: "File Batch Count", type: Integer, format: { justify: zeroes }, length: 4 }
      - { name: "File Transaction Count", type: Integer, format: { justify: zeroes }, length: 6 }
      - { name: "File Transaction Amount", type: Integer, format: { justify: zeroes }, length: 12 }
      - { name: "Type", type: String, length: 2 }
      - { name: "Unique File Identifier", type: String, length: 10 }
```

This example contains a single [structure](#structure_definitions) named 'BatchReq' with 5
components [segments](#segment_definitions), using a doubly-nested structure of file and batch data
for the segments. Each batch contains repeating detail records. All element definitions are
in-lined.

The `BatchReq` structure definition requires that the data will consist of:

- A single record that corresponds to the segment `RQH`

- One or more records that correspond to the segment `BCH`

- For each `BCH` record, one or more `TDR` records giving details of a particular transaction

- For each `BCH` record, a `BCF` record following any contained `TDR` records

- A final, single record that corresponds to the segment `RQF`

For this example every record starts with a three-character Record Type field with a specified
`tagValue`. In the case of the batch records, the record type is further specified by a Batch
Function `tagValue`.

This is a sample of data matching the schema example:

```text
RQH201809011010A000000001USD
BAT000001HACME RESEARCH                 A000000001
BAT000002D01234567890000032876CR
BAT000003D01234567880000087326CR
BAT000004T0000120202CR000002A000000001
BAT000005HAJAX EXPLOSIVES               A000000002
BAT000006D12345678900000003582DB
BAT000007D12345678910000000256CR
BAT000008T0000003326DB000002A000000002
RQF0002000008000000116876CRA000000001
```

The lines in the example match the defined structure as listed below:

- 1 `RQH` (Request File Header Record) identified by the "RQH" value in the first three characters

- 2 `BCH` (Batch Header Record) identified by the "BAT" value in the first three characters combined
  with the 'H' character in position 10

- 3-4 `TDR` (Transaction Detail Record) identified by the "BAT" value in the first three characters
  combined with the 'D' character in position 10

- 5 `BCF` (Batch Footer Record) identified by the "BAT" value in the first three characters combined
  with the 'T' character in position 10

- 6 `BCH` (Batch Header Record) identified by the "BAT" value in the first three characters combined
  with the 'H' character in position 10

- 7-8 `TDR` (Transaction Detail Record) identified by the "BAT" value in the first three characters
  combined with the 'D' character in position 10

- 9 `BCF` (Batch Footer Record) identified by the "BAT" value in the first three characters combined
  with the 'T' character in position 10

- 10 `RQF` (Request File Footer Record) identified by the "RQF" value in the first three characters

`tagValue` fields provide a lot of flexibility. The above example shows using a single `tagValue`
for some record types, while adding a second `tagValue` for others, but you can also use completely
different fields (or even disjoint sets of fields) for a `tagValue`, as long as you provide enough
details for the parser to distinguish between the different types of records.

Note that older versions of the documentation showed a different way of distinguishing records based
on tag values, using `tagStart` and `tagLength` values for the structure and `tag` values for the
segments. This method of distinguishing segments is much more limited than the `tagValue` approach,
and is now deprecated.

## See Also

[Supported Data Formats](https://docs.mulesoft.com/dataweave/2.3/dataweave-formats#format_flat_file)

<!-- document id=faf0c30bf111b8fa0224ae2b4fe8c9c69f610974362d36ecab56454e50b82c4c url=/mulesoft/current/en-us/dataweave/2.4/dataweave-flat-file-schemas.md -->

---
product: DataWeave
version: 2.4
keywords: b2b, edi, schema, dataweave, yaml, language, reference
---

# Flat File Schemas

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave can process several different types of data. For most of these types, you can import a
schema that describes the input structure in order to have access to valuable metadata at design
time.

DataWeave uses a YAML format called FFD (for Flat File Definition) to represent flat file schemas.
The FFD format is flexible enough to support a range of use cases, but is based around the concepts
of elements, composites, segments, groups, and structures.

Schemas must be written in Flat File Schema Language, and by convention use a `.ffd` extension. This
language is very similar to EDI Schema Language (ESL), which is also accepted by Anypoint Studio.

In DataWeave, you can bind your input or output to a flat file schema through a property.

Note that if you intend to use a simple fixed-width format, you can set up your data type directly
through the Transform component using the `Fixed Width` type. Creating an instance of this type in
Studio will automatically generate a matching schema definition.

## Types of Components in a Schema

Here are the different types of components that make up a flat file schema, going from the most
elementary to the more complex. Elements and Segments are always required, while Composites, Groups,
and Structures might be needed depending on the
[top-level structure of your document](#top_level_structure).

- Element - An element is a basic data item, which has an associated type and fixed width, along
  with formatting options for how the data value is read and written.

- Composite - (Optional) A group of elements. It can also include other child composites.

- Segment - A line of data, or record, made up of any number of elements and/or composites that
  might be repeated.

- Group - (Optional) Several segments grouped together. It can also include other child groups.

- Structure - A hierarchical organization of segments, which requires that the segments have unique
  identifier codes as part of their data.

## Top-level structure of an FFD Document

The top-level definition in an FFD document starts with the form of the schema. In this case it must
always be "FLATFILE", "COPYBOOK", or "FIXEDWIDTH". The differences between these forms are minor and
mostly relate to how they are handled in Studio. The rest depends on the form of definitions present
in the file, with the following alternatives:

- Single segment - Segment information directly at the top level (including a `values` key giving
  the element and/or composite details of the segment).

- Multiple segments - A `segments` key with multiple child objects, each defining one segment.

- Multiple structures - A `structures` key with multiple child objects, each defining one structure.

### Single Segment

If you are only working with one type of record, you only need to have a segment definition for that
record type in your FFD.

![A flat file schema with multiple elements and segments](/mulesoft/current/en-us/dataweave/2.4/_images/dataweave-flat-file-schemas-22788.png)

This is a simple schema with only one segment:

```yaml
form: FLATFILE
id: "RQH"
name: Request Header Record
values:
  - { name: "Organization Code", type: String, length: 10 }
  - { name: "File Creation Date", type: Date, length: 8 }
  - { name: "File Creation Time", type: Time, length: 4 }
```

The example above simply defines a list of elements within a single segment. It has no composites to
group them into.

Here is another example:

```yaml
form: FIXEDWIDTH
name: my-flat-file
values:
  - { name: "Row-id", type: String, length: 2 }
  - { name: "Total", type: Decimal, length: 11 }
  - { name: "Module", type: String, length: 8 }
  - { name: "Cost", type: Decimal, length: 8, format: { implicit: 2 } }
  - { name: "Program-id", type: String, length: 8 }
  - { name: "user-id", type: String, length: 8 }
  - { name: "return-sign", type: String, length: 1 }
```

Note that simplified forms are only for convenience. You can use the `segments` key even if you only
have a single child segment definition.

### Multiple Segments

If you are working with multiple types of records in the same transformation, you need to use a
structure definition that controls how these different records are combined.

![A flat file schema with elements and segments](/mulesoft/current/en-us/dataweave/2.4/_images/dataweave-flat-file-schemas-680c6.png)

In most cases, you need to define a way to distinguish between the different types of records. You
do this by identifying `tagValue` fields as part of the record definitions. The parser will check
the content of the fields of each record to identify the record type, then see how it fits into the
defined structure.

This is an example of a complete structure schema with several component record types:

```yaml
form: FIXEDWIDTH
structures:
- id: 'BatchReq'
  name: Batch Request
  data:
  - { idRef: 'RQH' }
  - groupId: 'Batch'
    count: '>1'
    items:
    - { idRef: 'BCH' }
    - { idRef: 'TDR', count: '>1' }
    - { idRef: 'BCF' }
  - { idRef: 'RQF' }
segments:
- id: 'RQH'
  ...
```

Note that this example is not complete. It needs to define each of the referenced segments at the
end. See [Referenced versus Inlined Definitions](#referenced_vs_inlined_defs) to understand how
these segments are being referenced in this example.

### Multiple Structures

If you have multiple structures or segment definitions in an FFD, when you apply your schema to an
metadata description on a Transform component, you need to specify which one you want to use.

![A flat file schema showing groups, segments, and elements](/mulesoft/current/en-us/dataweave/2.4/_images/dataweave-flat-file-schemas-4e1eb.png)

A top-level structure of a schema with multiple structures might look like this:

```yaml
form: FIXEDWIDTH
structures:
- id: 'BatchReq'
  name: Batch Request
  data:
  - { idRef: 'RQH' }
  - groupId: 'Batch'
    usage: O
    count: '>1'
    items:
    - { idRef: 'BCH' }
    - { idRef: 'TDR', count: '>1' }
    - { idRef: 'BCF' }
  - { idRef: 'RQF' }
- id: 'BatchRsp'
  name: Batch Response
  data:
  - { idRef: 'RSH' }
  - groupId: 'Batch'
    usage: O
    count: '>1'
    items:
    - { idRef: 'BCH' }
    - { idRef: 'TDR', count: '>1' }
    - { idRef: 'BCF' }
  - { idRef: 'RSF' }
segments:
- id: 'RQH'
  ...
```

The example defines two different structures, the `BatchReq` structure and the `BatchRsp` structure.
Each of these structures uses a particular sequence of segments and groups of segments. The group
`Batch` is repeated in both structures. A Batch group is composed of a single BCH line, multiple TDR
lines, and a single BCF line.

Note that this example is not complete. It needs to define each of the referenced segments at the
end. See [Referenced versus Inlined Definitions](#referenced_vs_inlined_defs) to understand how
these segments are referenced in this example.

## Element Definitions

Element definitions are the basic building blocks of application data, consisting of basic key-value
pairs for standard characteristics. Flat file schemas generally use inline element definitions,
where each element is defined at the point it is used within a segment or composite structure, but
you can also define elements separately and reference them as needed. Here are several element
definitions defined for use by reference:

```yaml
- { id: "OrgCode", name: "Organization Code", type: String, length: 10 }
- { id: "CreateDate", name: "File Creation Date", type: Date, length: 8 }
- { id: "CreateTime", name: "File Creation Time", type: Time, length: 4 }
- {
    id: "BatchTransCount",
    name: "Batch Transaction Count",
    type: Integer,
    format: { justify: zeroes },
    length: 6,
  }
- {
    id: "BatchTransAmount",
    name: "Batch Transaction Amount",
    type: Integer,
    format: { justify: zeroes },
    length: 10,
  }
```

The supplied `id` value is used as the `idRef` value when referencing one of these definitions as
part of a segment or composite. Note that if you are defining elements inline within a segment
definition (as opposed to defining them at the end of the document and referencing them), the `id`
field is not required.

Element definitions might have the following attributes, classified by Form as applying to inline
definitions, referenced definitions (as in the above example), or references to definitions:

<table><caption>Table 1. Attributes</caption> <colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Description</th><th>Form</th></tr></thead><tbody><tr><td><p><code>count</code></p></td><td><p>Number of occurrences (optional, default is <code>1</code>)</p></td><td><p>Inline or reference</p></td></tr><tr><td><p><code>id</code></p></td><td><p>Element identifier</p></td><td><p>Referenced definition</p></td></tr><tr><td><p><code>idRef</code></p></td><td><p>Element identifier</p></td><td><p>Reference</p></td></tr><tr><td><p><code>name</code></p></td><td><p>Element name (optional)</p></td><td><p>All</p></td></tr><tr><td><p><code>type</code></p></td><td><p>Value type code, as listed below</p></td><td><p>Inline, or referenced definition</p></td></tr><tr><td><p><code>format</code></p></td><td><p>Type-specific formatting information</p></td><td><p>Inline, or referenced definition</p></td></tr><tr><td><p><code>length</code></p></td><td><p>Number of character positions for value</p></td><td><p>Inline, or referenced definition</p></td></tr><tr><td><p><code>tagValue</code></p></td><td><p>Value for this element used to identify a segment (see <a href="#full_schema_ex">the Full Schema Example</a>)</p></td><td><p>Inline, or referenced definition</p></td></tr></tbody></table>

The allowed types for defining an element are:

<table><caption>Table 2. Types</caption> <colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>Binary</p></td><td><p>Binary value (COBOL format, 2, 4, or 8 bytes)</p></td></tr><tr><td><p>Boolean</p></td><td><p>Boolean value</p></td></tr><tr><td><p>Date</p></td><td><p>Unzoned date value with year, month, and day components (which might not all be shown in text form)</p></td></tr><tr><td><p>DateTime</p></td><td><p>Unzoned date/time value with year, month, day, hour, minute, second, and millisecond components (which might not all be shown in text form)</p></td></tr><tr><td><p>Decimal</p></td><td><p>Decimal number value, which might or might not include an explicit decimal point in text form</p></td></tr><tr><td><p>Integer</p></td><td><p>Integer number value</p></td></tr><tr><td><p>Packed</p></td><td><p>Packed decimal representation of a decimal number value (COBOL format)</p></td></tr><tr><td><p>String</p></td><td><p>String value</p></td></tr><tr><td><p>Time</p></td><td><p>Unzoned time value with hour, minute, second, and millisecond components (which might not all be shown in text form)</p></td></tr><tr><td><p>Zoned</p></td><td><p>Zoned decimal (COBOL format)</p></td></tr></tbody></table>

Value types support a range of format options that affect the text form of the values. These are the
main options, along with the types to which they apply:

<table><caption>Table 3. Format Options</caption> <colgroup><col> <col> <col></colgroup><thead><tr><th>Key</th><th>Description</th><th>Applies to</th></tr></thead><tbody><tr><td><p>digits</p></td><td><p>Number of digits allowed</p></td><td><p>Binary</p></td></tr><tr><td><p>implicit</p></td><td><p>Implicit number of decimal digits (used for fixed-point values with no decimal in text form)</p></td><td><p>Binary, Decimal, Packed, Zoned</p></td></tr><tr><td><p>justify</p></td><td><p>Justification in field (LEFT, RIGHT, NONE, or ZEROES, the last only for numbers)</p></td><td><p>All except Binary and Packed</p></td></tr><tr><td><p>pattern</p></td><td><p>For numeric values, the <code>java.text.DecimalFormat</code> pattern for parsing and writing. For date/time values, the <code>java.time.format.DateTimeFormatter</code> pattern.</p></td><td><p>Date, DateTime, Decimal, Integer, Time</p></td></tr><tr><td><p>sign</p></td><td><p>Sign usage for numeric values (UNSIGNED, NEGATIVE_ONLY, OPTIONAL, ALWAYS_LEFT, ALWAYS_RIGHT)</p></td><td><p>Decimal, Integer, Zoned</p></td></tr><tr><td><p>signed</p></td><td><p>Signed versus unsigned flag</p></td><td><p>Binary, Packed</p></td></tr></tbody></table>

## Composite Definitions

Composites serve to reference a list of elements that are typically presented together. For example,
`firstName` and `lastName` can be bundled together into a single composite because they are likely
to be referred to as a group. Grouping elements into a composite also allows the list to be
repeated.

Composite definitions are very similar to segment definitions, composed of some key-value pairs for
standard characteristics along with lists of values. Composites might include both references to
elements or other nested composites and inlined definitions. This is a example of a composite
definition:

```yaml
- id: "DateTime"
  name: "Date/Time pair"
  values:
    - { name: "File Creation Date", type: Date, length: 8 }
    - { name: "File Creation Time", type: Time, length: 4 }
```

Composite definitions might have the following attributes:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Description</th><th>Form</th></tr></thead><tbody><tr><td><p><code>controlVal</code></p></td><td><p>Value from containing level giving actual number of occurrences (only used with <code>count</code> != 1)</p></td><td><p>Inline definition, or on <a href="#referenced_vs_inlined_defs">reference</a></p></td></tr><tr><td><p><code>count</code></p></td><td><p>Number (or maximum number, if <code>controlVal</code> is used) of occurrences (optional, default is <code>1</code>)</p></td><td><p>Inline definition, or on <a href="#referenced_vs_inlined_defs">reference</a></p></td></tr><tr><td><p><code>id</code></p></td><td><p>Composite identifier for references</p></td><td><p><a href="#referenced_vs_inlined_defs">Referenced definition</a></p></td></tr><tr><td><p><code>name</code></p></td><td><p>Composite name (optional)</p></td><td><p>Inline or <a href="#referenced_vs_inlined_defs">referenced definition</a></p></td></tr><tr><td><p><code>values</code></p></td><td><p>List of elements and composites within the composite</p></td><td><p>Inline or <a href="#referenced_vs_inlined_defs">referenced definition</a></p></td></tr></tbody></table>

The values list takes the same form as the values list in a segment definition.

## Segment Definitions

A segment describes a type of record in your data. Segments are mainly composed of references or
direct definitions of elements and composites, together with some key-value pairs that describe the
segment. In a somewhat complex schema, you might have a structure that contains two different
segments, where one of these describes the fields that go in the single header of a bill of
materials (such as date and person), while the other segment describes the recurring fields that go
into each of the actual items in the bill of materials.

This is a sample segment definition that includes one simple element and a composite with two
elements within:

```yaml
- id: "RQH"
  name: Request Header Record
  values:
    - { name: "Organization Code", type: String, length: 10 }
    - id: "DateTime"
      name: "Date/Time pair"
      values:
        - { name: "File Creation Date", type: Date, length: 8 }
        - { name: "File Creation Time", type: Time, length: 4 }
```

Segment definitions might include the following attributes:

<table><colgroup><col> <col></colgroup><thead><tr><th>Section</th><th>Description</th></tr></thead><tbody><tr><td><p><code>id</code></p></td><td><p>Segment identifier (unused for inline definitions, required for <a href="#referenced_vs_inlined_defs">referenced definitions</a>)</p></td></tr><tr><td><p><code>name</code></p></td><td><p>Segment name (optional)</p></td></tr><tr><td><p><code>values</code></p></td><td><p>List of elements and composites within the segment (either inlined, or <a href="#referenced_vs_inlined_defs">references</a>)</p></td></tr></tbody></table>

## Structure Definitions

Structure definitions are composed of a list of references to segments and group definitions, as
well as a set of key-value pairs for standard characteristics. Segments may be further organized
into groups consisting of a potentially repeated sequence of segments.

Here’s a sample structure definition again:

```yaml
form: FIXEDWIDTH
structures:
- id: 'BatchReq'
  name: Batch Request
  data:
  - { idRef: 'RQH' }
  - groupId: 'Batch'
    count: '>1'
    items:
    - { idRef: 'BCH' }
    - { idRef: 'TDR', count: '>1' }
    - { idRef: 'BCF' }
  - { idRef: 'RQF' }
segments:
- id: 'RQH'
  ...
```

This example includes references to two segments at the top level (`RQH` and `RQF`), as well as a
group definition `Batch` that includes references to other segments (`BCH`, `TDR` and `BCF`). Note
that for this structure to work, each of the [referenced segments](#segment_definitions) needs to be
defined. See [Referenced versus Inlined Definitions](#referenced_vs_inlined_defs) to understand how
segments are referenced in this example.

A structure definition can contain the following attributes:

<table><colgroup><col> <col></colgroup><thead><tr><th>Structure Key/Section</th><th>Description</th></tr></thead><tbody><tr><td><p><code>id</code></p></td><td><p>Structure identifier</p></td></tr><tr><td><p><code>name</code></p></td><td><p>Structure name (optional)</p></td></tr><tr><td><p><code>data</code></p></td><td><p>List of segments (and groups) in the structure</p></td></tr></tbody></table>

Each item in a segment list is either a segment reference (or inline definition) or a group
definition (always inline).

### Group Definitions

A group definition can have the following attributes:

<table><colgroup><col> <col></colgroup><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td><p><code>groupId</code></p></td><td><p>The group identifier</p></td></tr><tr><td><p><code>usage</code></p></td><td><p>Usage code, which might be <code>M</code> for Mandatory, <code>O</code> for Optional, or <code>U</code> for Unused (optional, defaults to <code>M</code>)</p></td></tr><tr><td><p><code>count</code></p></td><td><p>Maximum repetition count value, which might be a number or the special value <code>&gt;1</code>, meaning any number of repeats (optional, count value of <code>1</code> is used if not specified)</p></td></tr><tr><td><p><code>items</code></p></td><td><p>List of segments (and potentially nested groups) making up the group</p></td></tr></tbody></table>

## Referenced Versus Inlined Definitions

Besides the choice of top-level form, you also have choices when it comes to representing the
components of a structure, segment, or composite. You can define the component segments, composites,
and elements inline at the point of use, or you can define them in a table and reference them from
anywhere. Inlining definitions is simpler and more compact, but the table form allows definitions to
be reused. Table form examples must include an `id` value, and each reference to that definition
uses an `idRef`. This example shows how this applies to the segments making up a structure:

```yaml
form: FIXEDWIDTH
structures:
  - id: "BatchReq"
    name: Batch Request
    data:
      - { idRef: "RQH" }
      - { idRef: "RQF" }
segments:
  - id: "RQH"
    name: "Request File Header Record"
    values:
      - { idref: createDate }
      - { idref: createTime }
      - { idref: fileId }
      - { idref: currency }
  - id: "RQF"
    name: "Request File Footer Record"
    values:
      - { idref: batchCount }
      - { idref: transactionCount }
      - { idref: transactionAmount }
      - { idref: debitCredit }
      - { idref: fileId }
elements:
  - { id: createDate, type: Date, length: 8 }
  - { id: createTime, type: Time, length: 4 }
  - { id: fileId, type: String, length: 10 }
  - { id: currency, type: String, length: 3 }
  - { id: batchCount, type: Integer, format: { justify: zeroes }, length: 4 }
  - { id: transactionCount, type: Integer, format: { justify: zeroes }, length: 6 }
  - { id: transactionAmount, type: Integer, format: { justify: zeroes }, length: 12 }
  - { id: debitCredit, type: String, length: 2 }
```

In the above example, the `BatchReq` structure references segments in the `data` definition section.
The segments are each then defined in the `segments` section at the top level of the schema, and
these in turn reference elements that are later defined in the `elements` section.

An inlined definition of the same structure looks like this:

```yaml
form: FIXEDWIDTH
structures:
  - id: "BatchReq"
    name: Batch Request
    data:
      - { idRef: "RQH" }
      - { idRef: "RQF" }
segments:
  - id: "RQH"
    name: "Request File Header Record"
    values:
      - { name: "File Creation Date", type: Date, length: 8 }
      - { name: "File Creation Time", type: Time, length: 4 }
      - { name: "Unique File Identifier", type: String, length: 10 }
      - { name: "Currency", type: String, length: 3 }
  - id: "RQF"
    name: "Request File Footer Record"
    values:
      - { name: "File Batch Count", type: Integer, format: { justify: zeroes }, length: 4 }
      - { name: "File Transaction Count", type: Integer, format: { justify: zeroes }, length: 6 }
      - { name: "File Transaction Amount", type: Integer, format: { justify: zeroes }, length: 12 }
      - { name: "Type", type: String, length: 2 }
      - { name: "Unique File Identifier", type: String, length: 10 }
```

## Full Example Schema

```yaml
form: FLATFILE
structures:
  - id: "BatchReq"
    name: Batch Request
    data:
      - { idRef: "RQH" }
      - groupId: "Batch"
        count: ">1"
        items:
          - { idRef: "BCH" }
          - { idRef: "TDR", count: ">1" }
          - { idRef: "BCF" }
      - { idRef: "RQF" }
segments:
  - id: "RQH"
    name: "Request File Header Record"
    values:
      - { name: "Record Type", type: String, length: 3, tagValue: "RQH" }
      - { name: "File Creation Date", type: Date, length: 8 }
      - { name: "File Creation Time", type: Time, length: 4 }
      - { name: "Unique File Identifier", type: String, length: 10 }
      - { name: "Currency", type: String, length: 3 }
  - id: "BCH"
    name: "Batch Header Record"
    values:
      - { name: "Record Type", type: String, length: 3, tagValue: "BAT" }
      - { name: "Sequence Number", type: Integer, format: { justify: zeroes }, length: 6 }
      - { name: "Batch Function", type: String, length: 1, tagValue: "H" }
      - { name: "Company Name", type: String, length: 30 }
      - { name: "Unique Batch Identifier", type: String, length: 10 }
  - id: "TDR"
    name: "Transaction Detail Record"
    values:
      - { name: "Record Type", type: String, length: 3, tagValue: "BAT" }
      - { name: "Sequence Number", type: Integer, format: { justify: zeroes }, length: 6 }
      - { name: "Batch Function", type: String, length: 1, tagValue: "D" }
      - { name: "Account Number", type: String, length: 10 }
      - { name: "Amount", type: Integer, format: { justify: zeroes }, length: 10 }
      - { name: "Type", type: String, length: 2 }
  - id: "BCF"
    name: "Batch Footer Record"
    values:
      - { name: "Record Type", type: String, length: 3, tagValue: "BAT" }
      - { name: "Sequence Number", type: Integer, format: { justify: zeroes }, length: 6 }
      - { name: "Batch Function", type: String, length: 1, tagValue: "T" }
      - { name: "Batch Transaction Amount", type: Integer, format: { justify: zeroes }, length: 10 }
      - { name: "Type", type: String, length: 2 }
      - { name: "Batch Transaction Count", type: Integer, format: { justify: zeroes }, length: 6 }
      - { name: "Unique Batch Identifier", type: String, length: 10 }
  - id: "RQF"
    name: "Request File Footer Record"
    values:
      - { name: "Record Type", type: String, length: 3, tagValue: "RQF" }
      - { name: "File Batch Count", type: Integer, format: { justify: zeroes }, length: 4 }
      - { name: "File Transaction Count", type: Integer, format: { justify: zeroes }, length: 6 }
      - { name: "File Transaction Amount", type: Integer, format: { justify: zeroes }, length: 12 }
      - { name: "Type", type: String, length: 2 }
      - { name: "Unique File Identifier", type: String, length: 10 }
```

This example contains a single [structure](#structure_definitions) named 'BatchReq' with 5
components [segments](#segment_definitions), using a doubly-nested structure of file and batch data
for the segments. Each batch contains repeating detail records. All element definitions are
in-lined.

The `BatchReq` structure definition requires that the data will consist of:

- A single record that corresponds to the segment `RQH`

- One or more records that correspond to the segment `BCH`

- For each `BCH` record, one or more `TDR` records giving details of a particular transaction

- For each `BCH` record, a `BCF` record following any contained `TDR` records

- A final, single record that corresponds to the segment `RQF`

For this example every record starts with a three-character Record Type field with a specified
`tagValue`. In the case of the batch records, the record type is further specified by a Batch
Function `tagValue`.

This is a sample of data matching the schema example:

```text
RQH201809011010A000000001USD
BAT000001HACME RESEARCH                 A000000001
BAT000002D01234567890000032876CR
BAT000003D01234567880000087326CR
BAT000004T0000120202CR000002A000000001
BAT000005HAJAX EXPLOSIVES               A000000002
BAT000006D12345678900000003582DB
BAT000007D12345678910000000256CR
BAT000008T0000003326DB000002A000000002
RQF0002000008000000116876CRA000000001
```

The lines in the example match the defined structure as listed below:

- 1 `RQH` (Request File Header Record) identified by the "RQH" value in the first three characters

- 2 `BCH` (Batch Header Record) identified by the "BAT" value in the first three characters combined
  with the 'H' character in position 10

- 3-4 `TDR` (Transaction Detail Record) identified by the "BAT" value in the first three characters
  combined with the 'D' character in position 10

- 5 `BCF` (Batch Footer Record) identified by the "BAT" value in the first three characters combined
  with the 'T' character in position 10

- 6 `BCH` (Batch Header Record) identified by the "BAT" value in the first three characters combined
  with the 'H' character in position 10

- 7-8 `TDR` (Transaction Detail Record) identified by the "BAT" value in the first three characters
  combined with the 'D' character in position 10

- 9 `BCF` (Batch Footer Record) identified by the "BAT" value in the first three characters combined
  with the 'T' character in position 10

- 10 `RQF` (Request File Footer Record) identified by the "RQF" value in the first three characters

`tagValue` fields provide a lot of flexibility. The above example shows using a single `tagValue`
for some record types, while adding a second `tagValue` for others, but you can also use completely
different fields (or even disjoint sets of fields) for a `tagValue`, as long as you provide enough
details for the parser to distinguish between the different types of records.

Note that older versions of the documentation showed a different way of distinguishing records based
on tag values, using `tagStart` and `tagLength` values for the structure and `tag` values for the
segments. This method of distinguishing segments is much more limited than the `tagValue` approach,
and is now deprecated.

## See Also

[Supported Data Formats](https://docs.mulesoft.com/dataweave/2.4/dataweave-formats#format_flat_file)

<!-- document id=3e3313ace94bba2f4ef3cbd2e4fbb1158029277bfec0872224882d9764e934d4 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-flat-file-schemas.md -->

---
product: DataWeave
version: 2.6
keywords: b2b, edi, schema, dataweave, yaml, language, reference
---

# Flat File Schemas

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave can process several different types of data. For most of these types, you can import a
schema that describes the input structure in order to have access to valuable metadata at design
time.

DataWeave uses a YAML format called FFD (for Flat File Definition) to represent flat file schemas.
The FFD format is flexible enough to support a range of use cases, but is based around the concepts
of elements, composites, segments, groups, and structures.

Schemas must be written in Flat File Schema Language, and by convention use a `.ffd` extension. This
language is very similar to EDI Schema Language (ESL), which is also accepted by Anypoint Studio.

In DataWeave, you can bind your input or output to a flat file schema through a property.

Note that if you intend to use a simple fixed-width format, you can set up your data type directly
through the Transform component using the `Fixed Width` type. Creating an instance of this type in
Studio will automatically generate a matching schema definition.

## Types of Components in a Schema

Here are the different types of components that make up a flat file schema, going from the most
elementary to the more complex. Elements and Segments are always required, while Composites, Groups,
and Structures might be needed depending on the
[top-level structure of your document](#top_level_structure).

- Element - An element is a basic data item, which has an associated type and fixed width, along
  with formatting options for how the data value is read and written.

- Composite - (Optional) A group of elements. It can also include other child composites.

- Segment - A line of data, or record, made up of any number of elements and/or composites that
  might be repeated.

- Group - (Optional) Several segments grouped together. It can also include other child groups.

- Structure - A hierarchical organization of segments, which requires that the segments have unique
  identifier codes as part of their data.

## Top-level structure of an FFD Document

The top-level definition in an FFD document starts with the form of the schema. In this case it must
always be "FLATFILE", "COPYBOOK", or "FIXEDWIDTH". The differences between these forms are minor and
mostly relate to how they are handled in Studio. The rest depends on the form of definitions present
in the file, with the following alternatives:

- Single segment - Segment information directly at the top level (including a `values` key giving
  the element and/or composite details of the segment).

- Multiple segments - A `segments` key with multiple child objects, each defining one segment.

- Multiple structures - A `structures` key with multiple child objects, each defining one structure.

### Single Segment

If you are only working with one type of record, you only need to have a segment definition for that
record type in your FFD.

![A flat file schema with multiple elements and segments](/mulesoft/current/en-us/dataweave/2.6/_images/dataweave-flat-file-schemas-22788.png)

This is a simple schema with only one segment:

```yaml
form: FLATFILE
id: "RQH"
name: Request Header Record
values:
  - { name: "Organization Code", type: String, length: 10 }
  - { name: "File Creation Date", type: Date, length: 8 }
  - { name: "File Creation Time", type: Time, length: 4 }
```

The example above simply defines a list of elements within a single segment. It has no composites to
group them into.

Here is another example:

```yaml
form: FIXEDWIDTH
name: my-flat-file
values:
  - { name: "Row-id", type: String, length: 2 }
  - { name: "Total", type: Decimal, length: 11 }
  - { name: "Module", type: String, length: 8 }
  - { name: "Cost", type: Decimal, length: 8, format: { implicit: 2 } }
  - { name: "Program-id", type: String, length: 8 }
  - { name: "user-id", type: String, length: 8 }
  - { name: "return-sign", type: String, length: 1 }
```

Note that simplified forms are only for convenience. You can use the `segments` key even if you only
have a single child segment definition.

### Multiple Segments

If you are working with multiple types of records in the same transformation, you need to use a
structure definition that controls how these different records are combined.

![A flat file schema with elements and segments](/mulesoft/current/en-us/dataweave/2.6/_images/dataweave-flat-file-schemas-680c6.png)

In most cases, you need to define a way to distinguish between the different types of records. You
do this by identifying `tagValue` fields as part of the record definitions. The parser will check
the content of the fields of each record to identify the record type, then see how it fits into the
defined structure.

This is an example of a complete structure schema with several component record types:

```yaml
form: FIXEDWIDTH
structures:
- id: 'BatchReq'
  name: Batch Request
  data:
  - { idRef: 'RQH' }
  - groupId: 'Batch'
    count: '>1'
    items:
    - { idRef: 'BCH' }
    - { idRef: 'TDR', count: '>1' }
    - { idRef: 'BCF' }
  - { idRef: 'RQF' }
segments:
- id: 'RQH'
  ...
```

Note that this example is not complete. It needs to define each of the referenced segments at the
end. See [Referenced versus Inlined Definitions](#referenced_vs_inlined_defs) to understand how
these segments are being referenced in this example.

### Multiple Structures

If you have multiple structures or segment definitions in an FFD, when you apply your schema to an
metadata description on a Transform component, you need to specify which one you want to use.

![A flat file schema showing groups, segments, and elements](/mulesoft/current/en-us/dataweave/2.6/_images/dataweave-flat-file-schemas-4e1eb.png)

A top-level structure of a schema with multiple structures might look like this:

```yaml
form: FIXEDWIDTH
structures:
- id: 'BatchReq'
  name: Batch Request
  data:
  - { idRef: 'RQH' }
  - groupId: 'Batch'
    usage: O
    count: '>1'
    items:
    - { idRef: 'BCH' }
    - { idRef: 'TDR', count: '>1' }
    - { idRef: 'BCF' }
  - { idRef: 'RQF' }
- id: 'BatchRsp'
  name: Batch Response
  data:
  - { idRef: 'RSH' }
  - groupId: 'Batch'
    usage: O
    count: '>1'
    items:
    - { idRef: 'BCH' }
    - { idRef: 'TDR', count: '>1' }
    - { idRef: 'BCF' }
  - { idRef: 'RSF' }
segments:
- id: 'RQH'
  ...
```

The example defines two different structures, the `BatchReq` structure and the `BatchRsp` structure.
Each of these structures uses a particular sequence of segments and groups of segments. The group
`Batch` is repeated in both structures. A Batch group is composed of a single BCH line, multiple TDR
lines, and a single BCF line.

Note that this example is not complete. It needs to define each of the referenced segments at the
end. See [Referenced versus Inlined Definitions](#referenced_vs_inlined_defs) to understand how
these segments are referenced in this example.

## Element Definitions

Element definitions are the basic building blocks of application data, consisting of basic key-value
pairs for standard characteristics. Flat file schemas generally use inline element definitions,
where each element is defined at the point it is used within a segment or composite structure, but
you can also define elements separately and reference them as needed. Here are several element
definitions defined for use by reference:

```yaml
- { id: "OrgCode", name: "Organization Code", type: String, length: 10 }
- { id: "CreateDate", name: "File Creation Date", type: Date, length: 8 }
- { id: "CreateTime", name: "File Creation Time", type: Time, length: 4 }
- {
    id: "BatchTransCount",
    name: "Batch Transaction Count",
    type: Integer,
    format: { justify: zeroes },
    length: 6,
  }
- {
    id: "BatchTransAmount",
    name: "Batch Transaction Amount",
    type: Integer,
    format: { justify: zeroes },
    length: 10,
  }
```

The supplied `id` value is used as the `idRef` value when referencing one of these definitions as
part of a segment or composite. Note that if you are defining elements inline within a segment
definition (as opposed to defining them at the end of the document and referencing them), the `id`
field is not required.

Element definitions might have the following attributes, classified by Form as applying to inline
definitions, referenced definitions (as in the above example), or references to definitions:

<table><caption>Table 1. Attributes</caption> <colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Description</th><th>Form</th></tr></thead><tbody><tr><td><p><code>count</code></p></td><td><p>Number of occurrences (optional, default is <code>1</code>)</p></td><td><p>Inline or reference</p></td></tr><tr><td><p><code>id</code></p></td><td><p>Element identifier</p></td><td><p>Referenced definition</p></td></tr><tr><td><p><code>idRef</code></p></td><td><p>Element identifier</p></td><td><p>Reference</p></td></tr><tr><td><p><code>name</code></p></td><td><p>Element name (optional)</p></td><td><p>All</p></td></tr><tr><td><p><code>type</code></p></td><td><p>Value type code, as listed below</p></td><td><p>Inline, or referenced definition</p></td></tr><tr><td><p><code>format</code></p></td><td><p>Type-specific formatting information</p></td><td><p>Inline, or referenced definition</p></td></tr><tr><td><p><code>length</code></p></td><td><p>Number of character positions for value</p></td><td><p>Inline, or referenced definition</p></td></tr><tr><td><p><code>tagValue</code></p></td><td><p>Value for this element used to identify a segment (see <a href="#full_schema_ex">the Full Schema Example</a>)</p></td><td><p>Inline, or referenced definition</p></td></tr></tbody></table>

The allowed types for defining an element are:

<table><caption>Table 2. Types</caption> <colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>Binary</p></td><td><p>Binary value (COBOL format, 2, 4, or 8 bytes)</p></td></tr><tr><td><p>Boolean</p></td><td><p>Boolean value</p></td></tr><tr><td><p>Date</p></td><td><p>Unzoned date value with year, month, and day components (which might not all be shown in text form)</p></td></tr><tr><td><p>DateTime</p></td><td><p>Unzoned date/time value with year, month, day, hour, minute, second, and millisecond components (which might not all be shown in text form)</p></td></tr><tr><td><p>Decimal</p></td><td><p>Decimal number value, which might or might not include an explicit decimal point in text form</p></td></tr><tr><td><p>Integer</p></td><td><p>Integer number value</p></td></tr><tr><td><p>Packed</p></td><td><p>Packed decimal representation of a decimal number value (COBOL format)</p></td></tr><tr><td><p>String</p></td><td><p>String value</p></td></tr><tr><td><p>Time</p></td><td><p>Unzoned time value with hour, minute, second, and millisecond components (which might not all be shown in text form)</p></td></tr><tr><td><p>Zoned</p></td><td><p>Zoned decimal (COBOL format)</p></td></tr></tbody></table>

Value types support a range of format options that affect the text form of the values. These are the
main options, along with the types to which they apply:

<table><caption>Table 3. Format Options</caption> <colgroup><col> <col> <col></colgroup><thead><tr><th>Key</th><th>Description</th><th>Applies to</th></tr></thead><tbody><tr><td><p>digits</p></td><td><p>Number of digits allowed</p></td><td><p>Binary</p></td></tr><tr><td><p>implicit</p></td><td><p>Implicit number of decimal digits (used for fixed-point values with no decimal in text form)</p></td><td><p>Binary, Decimal, Packed, Zoned</p></td></tr><tr><td><p>justify</p></td><td><p>Justification in field (LEFT, RIGHT, NONE, or ZEROES, the last only for numbers)</p></td><td><p>All except Binary and Packed</p></td></tr><tr><td><p>pattern</p></td><td><p>For numeric values, the <code>java.text.DecimalFormat</code> pattern for parsing and writing. For date/time values, the <code>java.time.format.DateTimeFormatter</code> pattern.</p></td><td><p>Date, DateTime, Decimal, Integer, Time</p></td></tr><tr><td><p>sign</p></td><td><p>Sign usage for numeric values (UNSIGNED, NEGATIVE_ONLY, OPTIONAL, ALWAYS_LEFT, ALWAYS_RIGHT)</p></td><td><p>Decimal, Integer, Zoned</p></td></tr><tr><td><p>signed</p></td><td><p>Signed versus unsigned flag</p></td><td><p>Binary, Packed</p></td></tr></tbody></table>

## Composite Definitions

Composites serve to reference a list of elements that are typically presented together. For example,
`firstName` and `lastName` can be bundled together into a single composite because they are likely
to be referred to as a group. Grouping elements into a composite also allows the list to be
repeated.

Composite definitions are very similar to segment definitions, composed of some key-value pairs for
standard characteristics along with lists of values. Composites might include both references to
elements or other nested composites and inlined definitions. This is a example of a composite
definition:

```yaml
- id: "DateTime"
  name: "Date/Time pair"
  values:
    - { name: "File Creation Date", type: Date, length: 8 }
    - { name: "File Creation Time", type: Time, length: 4 }
```

Composite definitions might have the following attributes:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Description</th><th>Form</th></tr></thead><tbody><tr><td><p><code>controlVal</code></p></td><td><p>Value from containing level giving actual number of occurrences (only used with <code>count</code> != 1)</p></td><td><p>Inline definition, or on <a href="#referenced_vs_inlined_defs">reference</a></p></td></tr><tr><td><p><code>count</code></p></td><td><p>Number (or maximum number, if <code>controlVal</code> is used) of occurrences (optional, default is <code>1</code>)</p></td><td><p>Inline definition, or on <a href="#referenced_vs_inlined_defs">reference</a></p></td></tr><tr><td><p><code>id</code></p></td><td><p>Composite identifier for references</p></td><td><p><a href="#referenced_vs_inlined_defs">Referenced definition</a></p></td></tr><tr><td><p><code>name</code></p></td><td><p>Composite name (optional)</p></td><td><p>Inline or <a href="#referenced_vs_inlined_defs">referenced definition</a></p></td></tr><tr><td><p><code>values</code></p></td><td><p>List of elements and composites within the composite</p></td><td><p>Inline or <a href="#referenced_vs_inlined_defs">referenced definition</a></p></td></tr></tbody></table>

The values list takes the same form as the values list in a segment definition.

## Segment Definitions

A segment describes a type of record in your data. Segments are mainly composed of references or
direct definitions of elements and composites, together with some key-value pairs that describe the
segment. In a somewhat complex schema, you might have a structure that contains two different
segments, where one of these describes the fields that go in the single header of a bill of
materials (such as date and person), while the other segment describes the recurring fields that go
into each of the actual items in the bill of materials.

This is a sample segment definition that includes one simple element and a composite with two
elements within:

```yaml
- id: "RQH"
  name: Request Header Record
  values:
    - { name: "Organization Code", type: String, length: 10 }
    - id: "DateTime"
      name: "Date/Time pair"
      values:
        - { name: "File Creation Date", type: Date, length: 8 }
        - { name: "File Creation Time", type: Time, length: 4 }
```

Segment definitions might include the following attributes:

<table><colgroup><col> <col></colgroup><thead><tr><th>Section</th><th>Description</th></tr></thead><tbody><tr><td><p><code>id</code></p></td><td><p>Segment identifier (unused for inline definitions, required for <a href="#referenced_vs_inlined_defs">referenced definitions</a>)</p></td></tr><tr><td><p><code>name</code></p></td><td><p>Segment name (optional)</p></td></tr><tr><td><p><code>values</code></p></td><td><p>List of elements and composites within the segment (either inlined, or <a href="#referenced_vs_inlined_defs">references</a>)</p></td></tr></tbody></table>

## Structure Definitions

Structure definitions are composed of a list of references to segments and group definitions, as
well as a set of key-value pairs for standard characteristics. Segments may be further organized
into groups consisting of a potentially repeated sequence of segments.

Here’s a sample structure definition again:

```yaml
form: FIXEDWIDTH
structures:
- id: 'BatchReq'
  name: Batch Request
  data:
  - { idRef: 'RQH' }
  - groupId: 'Batch'
    count: '>1'
    items:
    - { idRef: 'BCH' }
    - { idRef: 'TDR', count: '>1' }
    - { idRef: 'BCF' }
  - { idRef: 'RQF' }
segments:
- id: 'RQH'
  ...
```

This example includes references to two segments at the top level (`RQH` and `RQF`), as well as a
group definition `Batch` that includes references to other segments (`BCH`, `TDR` and `BCF`). Note
that for this structure to work, each of the [referenced segments](#segment_definitions) needs to be
defined. See [Referenced versus Inlined Definitions](#referenced_vs_inlined_defs) to understand how
segments are referenced in this example.

A structure definition can contain the following attributes:

<table><colgroup><col> <col></colgroup><thead><tr><th>Structure Key/Section</th><th>Description</th></tr></thead><tbody><tr><td><p><code>id</code></p></td><td><p>Structure identifier</p></td></tr><tr><td><p><code>name</code></p></td><td><p>Structure name (optional)</p></td></tr><tr><td><p><code>data</code></p></td><td><p>List of segments (and groups) in the structure</p></td></tr></tbody></table>

Each item in a segment list is either a segment reference (or inline definition) or a group
definition (always inline).

### Group Definitions

A group definition can have the following attributes:

<table><colgroup><col> <col></colgroup><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td><p><code>groupId</code></p></td><td><p>The group identifier</p></td></tr><tr><td><p><code>usage</code></p></td><td><p>Usage code, which might be <code>M</code> for Mandatory, <code>O</code> for Optional, or <code>U</code> for Unused (optional, defaults to <code>M</code>)</p></td></tr><tr><td><p><code>count</code></p></td><td><p>Maximum repetition count value, which might be a number or the special value <code>&gt;1</code>, meaning any number of repeats (optional, count value of <code>1</code> is used if not specified)</p></td></tr><tr><td><p><code>items</code></p></td><td><p>List of segments (and potentially nested groups) making up the group</p></td></tr></tbody></table>

## Referenced Versus Inlined Definitions

Besides the choice of top-level form, you also have choices when it comes to representing the
components of a structure, segment, or composite. You can define the component segments, composites,
and elements inline at the point of use, or you can define them in a table and reference them from
anywhere. Inlining definitions is simpler and more compact, but the table form allows definitions to
be reused. Table form examples must include an `id` value, and each reference to that definition
uses an `idRef`. This example shows how this applies to the segments making up a structure:

```yaml
form: FIXEDWIDTH
structures:
  - id: "BatchReq"
    name: Batch Request
    data:
      - { idRef: "RQH" }
      - { idRef: "RQF" }
segments:
  - id: "RQH"
    name: "Request File Header Record"
    values:
      - { idref: createDate }
      - { idref: createTime }
      - { idref: fileId }
      - { idref: currency }
  - id: "RQF"
    name: "Request File Footer Record"
    values:
      - { idref: batchCount }
      - { idref: transactionCount }
      - { idref: transactionAmount }
      - { idref: debitCredit }
      - { idref: fileId }
elements:
  - { id: createDate, type: Date, length: 8 }
  - { id: createTime, type: Time, length: 4 }
  - { id: fileId, type: String, length: 10 }
  - { id: currency, type: String, length: 3 }
  - { id: batchCount, type: Integer, format: { justify: zeroes }, length: 4 }
  - { id: transactionCount, type: Integer, format: { justify: zeroes }, length: 6 }
  - { id: transactionAmount, type: Integer, format: { justify: zeroes }, length: 12 }
  - { id: debitCredit, type: String, length: 2 }
```

In the above example, the `BatchReq` structure references segments in the `data` definition section.
The segments are each then defined in the `segments` section at the top level of the schema, and
these in turn reference elements that are later defined in the `elements` section.

An inlined definition of the same structure looks like this:

```yaml
form: FIXEDWIDTH
structures:
  - id: "BatchReq"
    name: Batch Request
    data:
      - { idRef: "RQH" }
      - { idRef: "RQF" }
segments:
  - id: "RQH"
    name: "Request File Header Record"
    values:
      - { name: "File Creation Date", type: Date, length: 8 }
      - { name: "File Creation Time", type: Time, length: 4 }
      - { name: "Unique File Identifier", type: String, length: 10 }
      - { name: "Currency", type: String, length: 3 }
  - id: "RQF"
    name: "Request File Footer Record"
    values:
      - { name: "File Batch Count", type: Integer, format: { justify: zeroes }, length: 4 }
      - { name: "File Transaction Count", type: Integer, format: { justify: zeroes }, length: 6 }
      - { name: "File Transaction Amount", type: Integer, format: { justify: zeroes }, length: 12 }
      - { name: "Type", type: String, length: 2 }
      - { name: "Unique File Identifier", type: String, length: 10 }
```

## Full Example Schema

```yaml
form: FLATFILE
structures:
  - id: "BatchReq"
    name: Batch Request
    data:
      - { idRef: "RQH" }
      - groupId: "Batch"
        count: ">1"
        items:
          - { idRef: "BCH" }
          - { idRef: "TDR", count: ">1" }
          - { idRef: "BCF" }
      - { idRef: "RQF" }
segments:
  - id: "RQH"
    name: "Request File Header Record"
    values:
      - { name: "Record Type", type: String, length: 3, tagValue: "RQH" }
      - { name: "File Creation Date", type: Date, length: 8 }
      - { name: "File Creation Time", type: Time, length: 4 }
      - { name: "Unique File Identifier", type: String, length: 10 }
      - { name: "Currency", type: String, length: 3 }
  - id: "BCH"
    name: "Batch Header Record"
    values:
      - { name: "Record Type", type: String, length: 3, tagValue: "BAT" }
      - { name: "Sequence Number", type: Integer, format: { justify: zeroes }, length: 6 }
      - { name: "Batch Function", type: String, length: 1, tagValue: "H" }
      - { name: "Company Name", type: String, length: 30 }
      - { name: "Unique Batch Identifier", type: String, length: 10 }
  - id: "TDR"
    name: "Transaction Detail Record"
    values:
      - { name: "Record Type", type: String, length: 3, tagValue: "BAT" }
      - { name: "Sequence Number", type: Integer, format: { justify: zeroes }, length: 6 }
      - { name: "Batch Function", type: String, length: 1, tagValue: "D" }
      - { name: "Account Number", type: String, length: 10 }
      - { name: "Amount", type: Integer, format: { justify: zeroes }, length: 10 }
      - { name: "Type", type: String, length: 2 }
  - id: "BCF"
    name: "Batch Footer Record"
    values:
      - { name: "Record Type", type: String, length: 3, tagValue: "BAT" }
      - { name: "Sequence Number", type: Integer, format: { justify: zeroes }, length: 6 }
      - { name: "Batch Function", type: String, length: 1, tagValue: "T" }
      - { name: "Batch Transaction Amount", type: Integer, format: { justify: zeroes }, length: 10 }
      - { name: "Type", type: String, length: 2 }
      - { name: "Batch Transaction Count", type: Integer, format: { justify: zeroes }, length: 6 }
      - { name: "Unique Batch Identifier", type: String, length: 10 }
  - id: "RQF"
    name: "Request File Footer Record"
    values:
      - { name: "Record Type", type: String, length: 3, tagValue: "RQF" }
      - { name: "File Batch Count", type: Integer, format: { justify: zeroes }, length: 4 }
      - { name: "File Transaction Count", type: Integer, format: { justify: zeroes }, length: 6 }
      - { name: "File Transaction Amount", type: Integer, format: { justify: zeroes }, length: 12 }
      - { name: "Type", type: String, length: 2 }
      - { name: "Unique File Identifier", type: String, length: 10 }
```

This example contains a single [structure](#structure_definitions) named 'BatchReq' with 5
components [segments](#segment_definitions), using a doubly-nested structure of file and batch data
for the segments. Each batch contains repeating detail records. All element definitions are
in-lined.

The `BatchReq` structure definition requires that the data will consist of:

- A single record that corresponds to the segment `RQH`

- One or more records that correspond to the segment `BCH`

- For each `BCH` record, one or more `TDR` records giving details of a particular transaction

- For each `BCH` record, a `BCF` record following any contained `TDR` records

- A final, single record that corresponds to the segment `RQF`

For this example every record starts with a three-character Record Type field with a specified
`tagValue`. In the case of the batch records, the record type is further specified by a Batch
Function `tagValue`.

This is a sample of data matching the schema example:

```text
RQH201809011010A000000001USD
BAT000001HACME RESEARCH                 A000000001
BAT000002D01234567890000032876CR
BAT000003D01234567880000087326CR
BAT000004T0000120202CR000002A000000001
BAT000005HAJAX EXPLOSIVES               A000000002
BAT000006D12345678900000003582DB
BAT000007D12345678910000000256CR
BAT000008T0000003326DB000002A000000002
RQF0002000008000000116876CRA000000001
```

The lines in the example match the defined structure as listed below:

- 1 `RQH` (Request File Header Record) identified by the "RQH" value in the first three characters

- 2 `BCH` (Batch Header Record) identified by the "BAT" value in the first three characters combined
  with the 'H' character in position 10

- 3-4 `TDR` (Transaction Detail Record) identified by the "BAT" value in the first three characters
  combined with the 'D' character in position 10

- 5 `BCF` (Batch Footer Record) identified by the "BAT" value in the first three characters combined
  with the 'T' character in position 10

- 6 `BCH` (Batch Header Record) identified by the "BAT" value in the first three characters combined
  with the 'H' character in position 10

- 7-8 `TDR` (Transaction Detail Record) identified by the "BAT" value in the first three characters
  combined with the 'D' character in position 10

- 9 `BCF` (Batch Footer Record) identified by the "BAT" value in the first three characters combined
  with the 'T' character in position 10

- 10 `RQF` (Request File Footer Record) identified by the "RQF" value in the first three characters

`tagValue` fields provide a lot of flexibility. The above example shows using a single `tagValue`
for some record types, while adding a second `tagValue` for others, but you can also use completely
different fields (or even disjoint sets of fields) for a `tagValue`, as long as you provide enough
details for the parser to distinguish between the different types of records.

Note that older versions of the documentation showed a different way of distinguishing records based
on tag values, using `tagStart` and `tagLength` values for the structure and `tag` values for the
segments. This method of distinguishing segments is much more limited than the `tagValue` approach,
and is now deprecated.

## See Also

[Supported Data Formats](https://docs.mulesoft.com/dataweave/2.6/dataweave-formats#format_flat_file)

<!-- document id=e6ce2ed56af0169f1e412660ef06a6810fdfd80f80c5877f8206e5a3a667ed81 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-flat-file-schemas.md -->

---
product: DataWeave
version: 2.9
keywords: b2b, edi, schema, dataweave, yaml, language, reference
---

# Flat File Schemas

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave can process several different types of data. For most of these types, you can import a
schema that describes the input structure in order to have access to valuable metadata at design
time.

DataWeave uses a YAML format called FFD (for Flat File Definition) to represent flat file schemas.
The FFD format is flexible enough to support a range of use cases, but is based around the concepts
of elements, composites, segments, groups, and structures.

Schemas must be written in Flat File Schema Language, and by convention use a `.ffd` extension. This
language is very similar to EDI Schema Language (ESL), which is also accepted by Anypoint Studio.

In DataWeave, you can bind your input or output to a flat file schema through a property.

Note that if you intend to use a simple fixed-width format, you can set up your data type directly
through the Transform component using the `Fixed Width` type. Creating an instance of this type in
Studio will automatically generate a matching schema definition.

## Types of Components in a Schema

Here are the different types of components that make up a flat file schema, going from the most
elementary to the more complex. Elements and Segments are always required, while Composites, Groups,
and Structures might be needed depending on the
[top-level structure of your document](#top_level_structure).

- Element - An element is a basic data item, which has an associated type and fixed width, along
  with formatting options for how the data value is read and written.

- Composite - (Optional) A group of elements. It can also include other child composites.

- Segment - A line of data, or record, made up of any number of elements and/or composites that
  might be repeated.

- Group - (Optional) Several segments grouped together. It can also include other child groups.

- Structure - A hierarchical organization of segments, which requires that the segments have unique
  identifier codes as part of their data.

## Top-level structure of an FFD Document

The top-level definition in an FFD document starts with the form of the schema. In this case it must
always be "FLATFILE", "COPYBOOK", or "FIXEDWIDTH". The differences between these forms are minor and
mostly relate to how they are handled in Studio. The rest depends on the form of definitions present
in the file, with the following alternatives:

- Single segment - Segment information directly at the top level (including a `values` key giving
  the element and/or composite details of the segment).

- Multiple segments - A `segments` key with multiple child objects, each defining one segment.

- Multiple structures - A `structures` key with multiple child objects, each defining one structure.

### Single Segment

If you are only working with one type of record, you only need to have a segment definition for that
record type in your FFD.

![A flat file schema with multiple elements and segments](/mulesoft/current/en-us/dataweave/2.9/_images/dataweave-flat-file-schemas-22788.png)

This is a simple schema with only one segment:

```yaml
form: FLATFILE
id: "RQH"
name: Request Header Record
values:
  - { name: "Organization Code", type: String, length: 10 }
  - { name: "File Creation Date", type: Date, length: 8 }
  - { name: "File Creation Time", type: Time, length: 4 }
```

The example above simply defines a list of elements within a single segment. It has no composites to
group them into.

Here is another example:

```yaml
form: FIXEDWIDTH
name: my-flat-file
values:
  - { name: "Row-id", type: String, length: 2 }
  - { name: "Total", type: Decimal, length: 11 }
  - { name: "Module", type: String, length: 8 }
  - { name: "Cost", type: Decimal, length: 8, format: { implicit: 2 } }
  - { name: "Program-id", type: String, length: 8 }
  - { name: "user-id", type: String, length: 8 }
  - { name: "return-sign", type: String, length: 1 }
```

Note that simplified forms are only for convenience. You can use the `segments` key even if you only
have a single child segment definition.

### Multiple Segments

If you are working with multiple types of records in the same transformation, you need to use a
structure definition that controls how these different records are combined.

![A flat file schema with elements and segments](/mulesoft/current/en-us/dataweave/2.9/_images/dataweave-flat-file-schemas-680c6.png)

In most cases, you need to define a way to distinguish between the different types of records. You
do this by identifying `tagValue` fields as part of the record definitions. The parser will check
the content of the fields of each record to identify the record type, then see how it fits into the
defined structure.

This is an example of a complete structure schema with several component record types:

```yaml
form: FIXEDWIDTH
structures:
- id: 'BatchReq'
  name: Batch Request
  data:
  - { idRef: 'RQH' }
  - groupId: 'Batch'
    count: '>1'
    items:
    - { idRef: 'BCH' }
    - { idRef: 'TDR', count: '>1' }
    - { idRef: 'BCF' }
  - { idRef: 'RQF' }
segments:
- id: 'RQH'
  ...
```

Note that this example is not complete. It needs to define each of the referenced segments at the
end. See [Referenced versus Inlined Definitions](#referenced_vs_inlined_defs) to understand how
these segments are being referenced in this example.

### Multiple Structures

If you have multiple structures or segment definitions in an FFD, when you apply your schema to an
metadata description on a Transform component, you need to specify which one you want to use.

![A flat file schema showing groups, segments, and elements](/mulesoft/current/en-us/dataweave/2.9/_images/dataweave-flat-file-schemas-4e1eb.png)

A top-level structure of a schema with multiple structures might look like this:

```yaml
form: FIXEDWIDTH
structures:
- id: 'BatchReq'
  name: Batch Request
  data:
  - { idRef: 'RQH' }
  - groupId: 'Batch'
    usage: O
    count: '>1'
    items:
    - { idRef: 'BCH' }
    - { idRef: 'TDR', count: '>1' }
    - { idRef: 'BCF' }
  - { idRef: 'RQF' }
- id: 'BatchRsp'
  name: Batch Response
  data:
  - { idRef: 'RSH' }
  - groupId: 'Batch'
    usage: O
    count: '>1'
    items:
    - { idRef: 'BCH' }
    - { idRef: 'TDR', count: '>1' }
    - { idRef: 'BCF' }
  - { idRef: 'RSF' }
segments:
- id: 'RQH'
  ...
```

The example defines two different structures, the `BatchReq` structure and the `BatchRsp` structure.
Each of these structures uses a particular sequence of segments and groups of segments. The group
`Batch` is repeated in both structures. A Batch group is composed of a single BCH line, multiple TDR
lines, and a single BCF line.

Note that this example is not complete. It needs to define each of the referenced segments at the
end. See [Referenced versus Inlined Definitions](#referenced_vs_inlined_defs) to understand how
these segments are referenced in this example.

## Element Definitions

Element definitions are the basic building blocks of application data, consisting of basic key-value
pairs for standard characteristics. Flat file schemas generally use inline element definitions,
where each element is defined at the point it is used within a segment or composite structure, but
you can also define elements separately and reference them as needed. Here are several element
definitions defined for use by reference:

```yaml
- { id: "OrgCode", name: "Organization Code", type: String, length: 10 }
- { id: "CreateDate", name: "File Creation Date", type: Date, length: 8 }
- { id: "CreateTime", name: "File Creation Time", type: Time, length: 4 }
- {
    id: "BatchTransCount",
    name: "Batch Transaction Count",
    type: Integer,
    format: { justify: zeroes },
    length: 6,
  }
- {
    id: "BatchTransAmount",
    name: "Batch Transaction Amount",
    type: Integer,
    format: { justify: zeroes },
    length: 10,
  }
```

The supplied `id` value is used as the `idRef` value when referencing one of these definitions as
part of a segment or composite. Note that if you are defining elements inline within a segment
definition (as opposed to defining them at the end of the document and referencing them), the `id`
field is not required.

Element definitions might have the following attributes, classified by Form as applying to inline
definitions, referenced definitions (as in the above example), or references to definitions:

<table><caption>Table 1. Attributes</caption> <colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Description</th><th>Form</th></tr></thead><tbody><tr><td><p><code>count</code></p></td><td><p>Number of occurrences (optional, default is <code>1</code>)</p></td><td><p>Inline or reference</p></td></tr><tr><td><p><code>id</code></p></td><td><p>Element identifier</p></td><td><p>Referenced definition</p></td></tr><tr><td><p><code>idRef</code></p></td><td><p>Element identifier</p></td><td><p>Reference</p></td></tr><tr><td><p><code>name</code></p></td><td><p>Element name (optional)</p></td><td><p>All</p></td></tr><tr><td><p><code>type</code></p></td><td><p>Value type code, as listed below</p></td><td><p>Inline, or referenced definition</p></td></tr><tr><td><p><code>format</code></p></td><td><p>Type-specific formatting information</p></td><td><p>Inline, or referenced definition</p></td></tr><tr><td><p><code>length</code></p></td><td><p>Number of character positions for value</p></td><td><p>Inline, or referenced definition</p></td></tr><tr><td><p><code>tagValue</code></p></td><td><p>Value for this element used to identify a segment (see <a href="#full_schema_ex">the Full Schema Example</a>)</p></td><td><p>Inline, or referenced definition</p></td></tr></tbody></table>

The allowed types for defining an element are:

<table><caption>Table 2. Types</caption> <colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>Binary</p></td><td><p>Binary value (COBOL format, 2, 4, or 8 bytes)</p></td></tr><tr><td><p>Boolean</p></td><td><p>Boolean value</p></td></tr><tr><td><p>Date</p></td><td><p>Unzoned date value with year, month, and day components (which might not all be shown in text form)</p></td></tr><tr><td><p>DateTime</p></td><td><p>Unzoned date/time value with year, month, day, hour, minute, second, and millisecond components (which might not all be shown in text form)</p></td></tr><tr><td><p>Decimal</p></td><td><p>Decimal number value, which might or might not include an explicit decimal point in text form</p></td></tr><tr><td><p>Integer</p></td><td><p>Integer number value</p></td></tr><tr><td><p>Packed</p></td><td><p>Packed decimal representation of a decimal number value (COBOL format)</p></td></tr><tr><td><p>String</p></td><td><p>String value</p></td></tr><tr><td><p>Time</p></td><td><p>Unzoned time value with hour, minute, second, and millisecond components (which might not all be shown in text form)</p></td></tr><tr><td><p>Zoned</p></td><td><p>Zoned decimal (COBOL format)</p></td></tr></tbody></table>

Value types support a range of format options that affect the text form of the values. These are the
main options, along with the types to which they apply:

<table><caption>Table 3. Format Options</caption> <colgroup><col> <col> <col></colgroup><thead><tr><th>Key</th><th>Description</th><th>Applies to</th></tr></thead><tbody><tr><td><p>digits</p></td><td><p>Number of digits allowed</p></td><td><p>Binary</p></td></tr><tr><td><p>implicit</p></td><td><p>Implicit number of decimal digits (used for fixed-point values with no decimal in text form)</p></td><td><p>Binary, Decimal, Packed, Zoned</p></td></tr><tr><td><p>justify</p></td><td><p>Justification in field (LEFT, RIGHT, NONE, or ZEROES, the last only for numbers)</p></td><td><p>All except Binary and Packed</p></td></tr><tr><td><p>pattern</p></td><td><p>For numeric values, the <code>java.text.DecimalFormat</code> pattern for parsing and writing. For date/time values, the <code>java.time.format.DateTimeFormatter</code> pattern.</p></td><td><p>Date, DateTime, Decimal, Integer, Time</p></td></tr><tr><td><p>sign</p></td><td><p>Sign usage for numeric values (UNSIGNED, NEGATIVE_ONLY, OPTIONAL, ALWAYS_LEFT, ALWAYS_RIGHT)</p></td><td><p>Decimal, Integer, Zoned</p></td></tr><tr><td><p>signed</p></td><td><p>Signed versus unsigned flag</p></td><td><p>Binary, Packed</p></td></tr></tbody></table>

## Composite Definitions

Composites serve to reference a list of elements that are typically presented together. For example,
`firstName` and `lastName` can be bundled together into a single composite because they are likely
to be referred to as a group. Grouping elements into a composite also allows the list to be
repeated.

Composite definitions are very similar to segment definitions, composed of some key-value pairs for
standard characteristics along with lists of values. Composites might include both references to
elements or other nested composites and inlined definitions. This is a example of a composite
definition:

```yaml
- id: "DateTime"
  name: "Date/Time pair"
  values:
    - { name: "File Creation Date", type: Date, length: 8 }
    - { name: "File Creation Time", type: Time, length: 4 }
```

Composite definitions might have the following attributes:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Description</th><th>Form</th></tr></thead><tbody><tr><td><p><code>controlVal</code></p></td><td><p>Value from containing level giving actual number of occurrences (only used with <code>count</code> != 1)</p></td><td><p>Inline definition, or on <a href="#referenced_vs_inlined_defs">reference</a></p></td></tr><tr><td><p><code>count</code></p></td><td><p>Number (or maximum number, if <code>controlVal</code> is used) of occurrences (optional, default is <code>1</code>)</p></td><td><p>Inline definition, or on <a href="#referenced_vs_inlined_defs">reference</a></p></td></tr><tr><td><p><code>id</code></p></td><td><p>Composite identifier for references</p></td><td><p><a href="#referenced_vs_inlined_defs">Referenced definition</a></p></td></tr><tr><td><p><code>name</code></p></td><td><p>Composite name (optional)</p></td><td><p>Inline or <a href="#referenced_vs_inlined_defs">referenced definition</a></p></td></tr><tr><td><p><code>values</code></p></td><td><p>List of elements and composites within the composite</p></td><td><p>Inline or <a href="#referenced_vs_inlined_defs">referenced definition</a></p></td></tr></tbody></table>

The values list takes the same form as the values list in a segment definition.

## Segment Definitions

A segment describes a type of record in your data. Segments are mainly composed of references or
direct definitions of elements and composites, together with some key-value pairs that describe the
segment. In a somewhat complex schema, you might have a structure that contains two different
segments, where one of these describes the fields that go in the single header of a bill of
materials (such as date and person), while the other segment describes the recurring fields that go
into each of the actual items in the bill of materials.

This is a sample segment definition that includes one simple element and a composite with two
elements within:

```yaml
- id: "RQH"
  name: Request Header Record
  values:
    - { name: "Organization Code", type: String, length: 10 }
    - id: "DateTime"
      name: "Date/Time pair"
      values:
        - { name: "File Creation Date", type: Date, length: 8 }
        - { name: "File Creation Time", type: Time, length: 4 }
```

Segment definitions might include the following attributes:

<table><colgroup><col> <col></colgroup><thead><tr><th>Section</th><th>Description</th></tr></thead><tbody><tr><td><p><code>id</code></p></td><td><p>Segment identifier (unused for inline definitions, required for <a href="#referenced_vs_inlined_defs">referenced definitions</a>)</p></td></tr><tr><td><p><code>name</code></p></td><td><p>Segment name (optional)</p></td></tr><tr><td><p><code>values</code></p></td><td><p>List of elements and composites within the segment (either inlined, or <a href="#referenced_vs_inlined_defs">references</a>)</p></td></tr></tbody></table>

## Structure Definitions

Structure definitions are composed of a list of references to segments and group definitions, as
well as a set of key-value pairs for standard characteristics. Segments may be further organized
into groups consisting of a potentially repeated sequence of segments.

Here’s a sample structure definition again:

```yaml
form: FIXEDWIDTH
structures:
- id: 'BatchReq'
  name: Batch Request
  data:
  - { idRef: 'RQH' }
  - groupId: 'Batch'
    count: '>1'
    items:
    - { idRef: 'BCH' }
    - { idRef: 'TDR', count: '>1' }
    - { idRef: 'BCF' }
  - { idRef: 'RQF' }
segments:
- id: 'RQH'
  ...
```

This example includes references to two segments at the top level (`RQH` and `RQF`), as well as a
group definition `Batch` that includes references to other segments (`BCH`, `TDR` and `BCF`). Note
that for this structure to work, each of the [referenced segments](#segment_definitions) needs to be
defined. See [Referenced versus Inlined Definitions](#referenced_vs_inlined_defs) to understand how
segments are referenced in this example.

A structure definition can contain the following attributes:

<table><colgroup><col> <col></colgroup><thead><tr><th>Structure Key/Section</th><th>Description</th></tr></thead><tbody><tr><td><p><code>id</code></p></td><td><p>Structure identifier</p></td></tr><tr><td><p><code>name</code></p></td><td><p>Structure name (optional)</p></td></tr><tr><td><p><code>data</code></p></td><td><p>List of segments (and groups) in the structure</p></td></tr></tbody></table>

Each item in a segment list is either a segment reference (or inline definition) or a group
definition (always inline).

### Group Definitions

A group definition can have the following attributes:

<table><colgroup><col> <col></colgroup><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td><p><code>groupId</code></p></td><td><p>The group identifier</p></td></tr><tr><td><p><code>usage</code></p></td><td><p>Usage code, which might be <code>M</code> for Mandatory, <code>O</code> for Optional, or <code>U</code> for Unused (optional, defaults to <code>M</code>)</p></td></tr><tr><td><p><code>count</code></p></td><td><p>Maximum repetition count value, which might be a number or the special value <code>&gt;1</code>, meaning any number of repeats (optional, count value of <code>1</code> is used if not specified)</p></td></tr><tr><td><p><code>items</code></p></td><td><p>List of segments (and potentially nested groups) making up the group</p></td></tr></tbody></table>

## Referenced Versus Inlined Definitions

Besides the choice of top-level form, you also have choices when it comes to representing the
components of a structure, segment, or composite. You can define the component segments, composites,
and elements inline at the point of use, or you can define them in a table and reference them from
anywhere. Inlining definitions is simpler and more compact, but the table form allows definitions to
be reused. Table form examples must include an `id` value, and each reference to that definition
uses an `idRef`. This example shows how this applies to the segments making up a structure:

```yaml
form: FIXEDWIDTH
structures:
  - id: "BatchReq"
    name: Batch Request
    data:
      - { idRef: "RQH" }
      - { idRef: "RQF" }
segments:
  - id: "RQH"
    name: "Request File Header Record"
    values:
      - { idref: createDate }
      - { idref: createTime }
      - { idref: fileId }
      - { idref: currency }
  - id: "RQF"
    name: "Request File Footer Record"
    values:
      - { idref: batchCount }
      - { idref: transactionCount }
      - { idref: transactionAmount }
      - { idref: debitCredit }
      - { idref: fileId }
elements:
  - { id: createDate, type: Date, length: 8 }
  - { id: createTime, type: Time, length: 4 }
  - { id: fileId, type: String, length: 10 }
  - { id: currency, type: String, length: 3 }
  - { id: batchCount, type: Integer, format: { justify: zeroes }, length: 4 }
  - { id: transactionCount, type: Integer, format: { justify: zeroes }, length: 6 }
  - { id: transactionAmount, type: Integer, format: { justify: zeroes }, length: 12 }
  - { id: debitCredit, type: String, length: 2 }
```

In the above example, the `BatchReq` structure references segments in the `data` definition section.
The segments are each then defined in the `segments` section at the top level of the schema, and
these in turn reference elements that are later defined in the `elements` section.

An inlined definition of the same structure looks like this:

```yaml
form: FIXEDWIDTH
structures:
  - id: "BatchReq"
    name: Batch Request
    data:
      - { idRef: "RQH" }
      - { idRef: "RQF" }
segments:
  - id: "RQH"
    name: "Request File Header Record"
    values:
      - { name: "File Creation Date", type: Date, length: 8 }
      - { name: "File Creation Time", type: Time, length: 4 }
      - { name: "Unique File Identifier", type: String, length: 10 }
      - { name: "Currency", type: String, length: 3 }
  - id: "RQF"
    name: "Request File Footer Record"
    values:
      - { name: "File Batch Count", type: Integer, format: { justify: zeroes }, length: 4 }
      - { name: "File Transaction Count", type: Integer, format: { justify: zeroes }, length: 6 }
      - { name: "File Transaction Amount", type: Integer, format: { justify: zeroes }, length: 12 }
      - { name: "Type", type: String, length: 2 }
      - { name: "Unique File Identifier", type: String, length: 10 }
```

## Full Example Schema

```yaml
form: FLATFILE
structures:
  - id: "BatchReq"
    name: Batch Request
    data:
      - { idRef: "RQH" }
      - groupId: "Batch"
        count: ">1"
        items:
          - { idRef: "BCH" }
          - { idRef: "TDR", count: ">1" }
          - { idRef: "BCF" }
      - { idRef: "RQF" }
segments:
  - id: "RQH"
    name: "Request File Header Record"
    values:
      - { name: "Record Type", type: String, length: 3, tagValue: "RQH" }
      - { name: "File Creation Date", type: Date, length: 8 }
      - { name: "File Creation Time", type: Time, length: 4 }
      - { name: "Unique File Identifier", type: String, length: 10 }
      - { name: "Currency", type: String, length: 3 }
  - id: "BCH"
    name: "Batch Header Record"
    values:
      - { name: "Record Type", type: String, length: 3, tagValue: "BAT" }
      - { name: "Sequence Number", type: Integer, format: { justify: zeroes }, length: 6 }
      - { name: "Batch Function", type: String, length: 1, tagValue: "H" }
      - { name: "Company Name", type: String, length: 30 }
      - { name: "Unique Batch Identifier", type: String, length: 10 }
  - id: "TDR"
    name: "Transaction Detail Record"
    values:
      - { name: "Record Type", type: String, length: 3, tagValue: "BAT" }
      - { name: "Sequence Number", type: Integer, format: { justify: zeroes }, length: 6 }
      - { name: "Batch Function", type: String, length: 1, tagValue: "D" }
      - { name: "Account Number", type: String, length: 10 }
      - { name: "Amount", type: Integer, format: { justify: zeroes }, length: 10 }
      - { name: "Type", type: String, length: 2 }
  - id: "BCF"
    name: "Batch Footer Record"
    values:
      - { name: "Record Type", type: String, length: 3, tagValue: "BAT" }
      - { name: "Sequence Number", type: Integer, format: { justify: zeroes }, length: 6 }
      - { name: "Batch Function", type: String, length: 1, tagValue: "T" }
      - { name: "Batch Transaction Amount", type: Integer, format: { justify: zeroes }, length: 10 }
      - { name: "Type", type: String, length: 2 }
      - { name: "Batch Transaction Count", type: Integer, format: { justify: zeroes }, length: 6 }
      - { name: "Unique Batch Identifier", type: String, length: 10 }
  - id: "RQF"
    name: "Request File Footer Record"
    values:
      - { name: "Record Type", type: String, length: 3, tagValue: "RQF" }
      - { name: "File Batch Count", type: Integer, format: { justify: zeroes }, length: 4 }
      - { name: "File Transaction Count", type: Integer, format: { justify: zeroes }, length: 6 }
      - { name: "File Transaction Amount", type: Integer, format: { justify: zeroes }, length: 12 }
      - { name: "Type", type: String, length: 2 }
      - { name: "Unique File Identifier", type: String, length: 10 }
```

This example contains a single [structure](#structure_definitions) named 'BatchReq' with 5
components [segments](#segment_definitions), using a doubly-nested structure of file and batch data
for the segments. Each batch contains repeating detail records. All element definitions are
in-lined.

The `BatchReq` structure definition requires that the data will consist of:

- A single record that corresponds to the segment `RQH`

- One or more records that correspond to the segment `BCH`

- For each `BCH` record, one or more `TDR` records giving details of a particular transaction

- For each `BCH` record, a `BCF` record following any contained `TDR` records

- A final, single record that corresponds to the segment `RQF`

For this example every record starts with a three-character Record Type field with a specified
`tagValue`. In the case of the batch records, the record type is further specified by a Batch
Function `tagValue`.

This is a sample of data matching the schema example:

```text
RQH201809011010A000000001USD
BAT000001HACME RESEARCH                 A000000001
BAT000002D01234567890000032876CR
BAT000003D01234567880000087326CR
BAT000004T0000120202CR000002A000000001
BAT000005HAJAX EXPLOSIVES               A000000002
BAT000006D12345678900000003582DB
BAT000007D12345678910000000256CR
BAT000008T0000003326DB000002A000000002
RQF0002000008000000116876CRA000000001
```

The lines in the example match the defined structure as listed below:

- 1 `RQH` (Request File Header Record) identified by the "RQH" value in the first three characters

- 2 `BCH` (Batch Header Record) identified by the "BAT" value in the first three characters combined
  with the 'H' character in position 10

- 3-4 `TDR` (Transaction Detail Record) identified by the "BAT" value in the first three characters
  combined with the 'D' character in position 10

- 5 `BCF` (Batch Footer Record) identified by the "BAT" value in the first three characters combined
  with the 'T' character in position 10

- 6 `BCH` (Batch Header Record) identified by the "BAT" value in the first three characters combined
  with the 'H' character in position 10

- 7-8 `TDR` (Transaction Detail Record) identified by the "BAT" value in the first three characters
  combined with the 'D' character in position 10

- 9 `BCF` (Batch Footer Record) identified by the "BAT" value in the first three characters combined
  with the 'T' character in position 10

- 10 `RQF` (Request File Footer Record) identified by the "RQF" value in the first three characters

`tagValue` fields provide a lot of flexibility. The above example shows using a single `tagValue`
for some record types, while adding a second `tagValue` for others, but you can also use completely
different fields (or even disjoint sets of fields) for a `tagValue`, as long as you provide enough
details for the parser to distinguish between the different types of records.

Note that older versions of the documentation showed a different way of distinguishing records based
on tag values, using `tagStart` and `tagLength` values for the structure and `tag` values for the
segments. This method of distinguishing segments is much more limited than the `tagValue` approach,
and is now deprecated.

## See Also

[Supported Data Formats](https://docs.mulesoft.com/dataweave/2.9/dataweave-formats#format_flat_file)

<!-- document id=57a4406f99572295be4723b712560f9eed1db32a0d9f38a23727e8993f16f20a url=/mulesoft/current/en-us/dataweave/latest/dataweave-flat-file-schemas.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: b2b, edi, schema, dataweave, yaml, language, reference
---

# Flat File Schemas

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave can process several different types of data. For most of these types, you can import a
schema that describes the input structure in order to have access to valuable metadata at design
time.

DataWeave uses a YAML format called FFD (for Flat File Definition) to represent flat file schemas.
The FFD format is flexible enough to support a range of use cases, but is based around the concepts
of elements, composites, segments, groups, and structures.

Schemas must be written in Flat File Schema Language, and by convention use a `.ffd` extension. This
language is very similar to EDI Schema Language (ESL), which is also accepted by Anypoint Studio.

In DataWeave, you can bind your input or output to a flat file schema through a property.

Note that if you intend to use a simple fixed-width format, you can set up your data type directly
through the Transform component using the `Fixed Width` type. Creating an instance of this type in
Studio will automatically generate a matching schema definition.

## Types of Components in a Schema

Here are the different types of components that make up a flat file schema, going from the most
elementary to the more complex. Elements and Segments are always required, while Composites, Groups,
and Structures might be needed depending on the
[top-level structure of your document](#top_level_structure).

- Element - An element is a basic data item, which has an associated type and fixed width, along
  with formatting options for how the data value is read and written.

- Composite - (Optional) A group of elements. It can also include other child composites.

- Segment - A line of data, or record, made up of any number of elements and/or composites that
  might be repeated.

- Group - (Optional) Several segments grouped together. It can also include other child groups.

- Structure - A hierarchical organization of segments, which requires that the segments have unique
  identifier codes as part of their data.

## Top-level structure of an FFD Document

The top-level definition in an FFD document starts with the form of the schema. In this case it must
always be "FLATFILE", "COPYBOOK", or "FIXEDWIDTH". The differences between these forms are minor and
mostly relate to how they are handled in Studio. The rest depends on the form of definitions present
in the file, with the following alternatives:

- Single segment - Segment information directly at the top level (including a `values` key giving
  the element and/or composite details of the segment).

- Multiple segments - A `segments` key with multiple child objects, each defining one segment.

- Multiple structures - A `structures` key with multiple child objects, each defining one structure.

### Single Segment

If you are only working with one type of record, you only need to have a segment definition for that
record type in your FFD.

![A flat file schema with multiple elements and segments](/mulesoft/current/en-us/dataweave/latest/_images/dataweave-flat-file-schemas-22788.png)

This is a simple schema with only one segment:

```yaml
form: FLATFILE
id: "RQH"
name: Request Header Record
values:
  - { name: "Organization Code", type: String, length: 10 }
  - { name: "File Creation Date", type: Date, length: 8 }
  - { name: "File Creation Time", type: Time, length: 4 }
```

The example above simply defines a list of elements within a single segment. It has no composites to
group them into.

Here is another example:

```yaml
form: FIXEDWIDTH
name: my-flat-file
values:
  - { name: "Row-id", type: String, length: 2 }
  - { name: "Total", type: Decimal, length: 11 }
  - { name: "Module", type: String, length: 8 }
  - { name: "Cost", type: Decimal, length: 8, format: { implicit: 2 } }
  - { name: "Program-id", type: String, length: 8 }
  - { name: "user-id", type: String, length: 8 }
  - { name: "return-sign", type: String, length: 1 }
```

Note that simplified forms are only for convenience. You can use the `segments` key even if you only
have a single child segment definition.

### Multiple Segments

If you are working with multiple types of records in the same transformation, you need to use a
structure definition that controls how these different records are combined.

![A flat file schema with elements and segments](/mulesoft/current/en-us/dataweave/latest/_images/dataweave-flat-file-schemas-680c6.png)

In most cases, you need to define a way to distinguish between the different types of records. You
do this by identifying `tagValue` fields as part of the record definitions. The parser will check
the content of the fields of each record to identify the record type, then see how it fits into the
defined structure.

This is an example of a complete structure schema with several component record types:

```yaml
form: FIXEDWIDTH
structures:
- id: 'BatchReq'
  name: Batch Request
  data:
  - { idRef: 'RQH' }
  - groupId: 'Batch'
    count: '>1'
    items:
    - { idRef: 'BCH' }
    - { idRef: 'TDR', count: '>1' }
    - { idRef: 'BCF' }
  - { idRef: 'RQF' }
segments:
- id: 'RQH'
  ...
```

Note that this example is not complete. It needs to define each of the referenced segments at the
end. See [Referenced versus Inlined Definitions](#referenced_vs_inlined_defs) to understand how
these segments are being referenced in this example.

### Multiple Structures

If you have multiple structures or segment definitions in an FFD, when you apply your schema to an
metadata description on a Transform component, you need to specify which one you want to use.

![A flat file schema showing groups, segments, and elements](/mulesoft/current/en-us/dataweave/latest/_images/dataweave-flat-file-schemas-4e1eb.png)

A top-level structure of a schema with multiple structures might look like this:

```yaml
form: FIXEDWIDTH
structures:
- id: 'BatchReq'
  name: Batch Request
  data:
  - { idRef: 'RQH' }
  - groupId: 'Batch'
    usage: O
    count: '>1'
    items:
    - { idRef: 'BCH' }
    - { idRef: 'TDR', count: '>1' }
    - { idRef: 'BCF' }
  - { idRef: 'RQF' }
- id: 'BatchRsp'
  name: Batch Response
  data:
  - { idRef: 'RSH' }
  - groupId: 'Batch'
    usage: O
    count: '>1'
    items:
    - { idRef: 'BCH' }
    - { idRef: 'TDR', count: '>1' }
    - { idRef: 'BCF' }
  - { idRef: 'RSF' }
segments:
- id: 'RQH'
  ...
```

The example defines two different structures, the `BatchReq` structure and the `BatchRsp` structure.
Each of these structures uses a particular sequence of segments and groups of segments. The group
`Batch` is repeated in both structures. A Batch group is composed of a single BCH line, multiple TDR
lines, and a single BCF line.

Note that this example is not complete. It needs to define each of the referenced segments at the
end. See [Referenced versus Inlined Definitions](#referenced_vs_inlined_defs) to understand how
these segments are referenced in this example.

## Element Definitions

Element definitions are the basic building blocks of application data, consisting of basic key-value
pairs for standard characteristics. Flat file schemas generally use inline element definitions,
where each element is defined at the point it is used within a segment or composite structure, but
you can also define elements separately and reference them as needed. Here are several element
definitions defined for use by reference:

```yaml
- { id: "OrgCode", name: "Organization Code", type: String, length: 10 }
- { id: "CreateDate", name: "File Creation Date", type: Date, length: 8 }
- { id: "CreateTime", name: "File Creation Time", type: Time, length: 4 }
- {
    id: "BatchTransCount",
    name: "Batch Transaction Count",
    type: Integer,
    format: { justify: zeroes },
    length: 6,
  }
- {
    id: "BatchTransAmount",
    name: "Batch Transaction Amount",
    type: Integer,
    format: { justify: zeroes },
    length: 10,
  }
```

The supplied `id` value is used as the `idRef` value when referencing one of these definitions as
part of a segment or composite. Note that if you are defining elements inline within a segment
definition (as opposed to defining them at the end of the document and referencing them), the `id`
field is not required.

Element definitions might have the following attributes, classified by Form as applying to inline
definitions, referenced definitions (as in the above example), or references to definitions:

<table><caption>Table 1. Attributes</caption> <colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Description</th><th>Form</th></tr></thead><tbody><tr><td><p><code>count</code></p></td><td><p>Number of occurrences (optional, default is <code>1</code>)</p></td><td><p>Inline or reference</p></td></tr><tr><td><p><code>id</code></p></td><td><p>Element identifier</p></td><td><p>Referenced definition</p></td></tr><tr><td><p><code>idRef</code></p></td><td><p>Element identifier</p></td><td><p>Reference</p></td></tr><tr><td><p><code>name</code></p></td><td><p>Element name (optional)</p></td><td><p>All</p></td></tr><tr><td><p><code>type</code></p></td><td><p>Value type code, as listed below</p></td><td><p>Inline, or referenced definition</p></td></tr><tr><td><p><code>format</code></p></td><td><p>Type-specific formatting information</p></td><td><p>Inline, or referenced definition</p></td></tr><tr><td><p><code>length</code></p></td><td><p>Number of character positions for value</p></td><td><p>Inline, or referenced definition</p></td></tr><tr><td><p><code>tagValue</code></p></td><td><p>Value for this element used to identify a segment (see <a href="#full_schema_ex">the Full Schema Example</a>)</p></td><td><p>Inline, or referenced definition</p></td></tr></tbody></table>

The allowed types for defining an element are:

<table><caption>Table 2. Types</caption> <colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>Binary</p></td><td><p>Binary value (COBOL format, 2, 4, or 8 bytes)</p></td></tr><tr><td><p>Boolean</p></td><td><p>Boolean value</p></td></tr><tr><td><p>Date</p></td><td><p>Unzoned date value with year, month, and day components (which might not all be shown in text form)</p></td></tr><tr><td><p>DateTime</p></td><td><p>Unzoned date/time value with year, month, day, hour, minute, second, and millisecond components (which might not all be shown in text form)</p></td></tr><tr><td><p>Decimal</p></td><td><p>Decimal number value, which might or might not include an explicit decimal point in text form</p></td></tr><tr><td><p>Integer</p></td><td><p>Integer number value</p></td></tr><tr><td><p>Packed</p></td><td><p>Packed decimal representation of a decimal number value (COBOL format)</p></td></tr><tr><td><p>String</p></td><td><p>String value</p></td></tr><tr><td><p>Time</p></td><td><p>Unzoned time value with hour, minute, second, and millisecond components (which might not all be shown in text form)</p></td></tr><tr><td><p>Zoned</p></td><td><p>Zoned decimal (COBOL format)</p></td></tr></tbody></table>

Value types support a range of format options that affect the text form of the values. These are the
main options, along with the types to which they apply:

<table><caption>Table 3. Format Options</caption> <colgroup><col> <col> <col></colgroup><thead><tr><th>Key</th><th>Description</th><th>Applies to</th></tr></thead><tbody><tr><td><p>digits</p></td><td><p>Number of digits allowed</p></td><td><p>Binary</p></td></tr><tr><td><p>implicit</p></td><td><p>Implicit number of decimal digits (used for fixed-point values with no decimal in text form)</p></td><td><p>Binary, Decimal, Packed, Zoned</p></td></tr><tr><td><p>justify</p></td><td><p>Justification in field (LEFT, RIGHT, NONE, or ZEROES, the last only for numbers)</p></td><td><p>All except Binary and Packed</p></td></tr><tr><td><p>pattern</p></td><td><p>For numeric values, the <code>java.text.DecimalFormat</code> pattern for parsing and writing. For date/time values, the <code>java.time.format.DateTimeFormatter</code> pattern.</p></td><td><p>Date, DateTime, Decimal, Integer, Time</p></td></tr><tr><td><p>sign</p></td><td><p>Sign usage for numeric values (UNSIGNED, NEGATIVE_ONLY, OPTIONAL, ALWAYS_LEFT, ALWAYS_RIGHT)</p></td><td><p>Decimal, Integer, Zoned</p></td></tr><tr><td><p>signed</p></td><td><p>Signed versus unsigned flag</p></td><td><p>Binary, Packed</p></td></tr></tbody></table>

## Composite Definitions

Composites serve to reference a list of elements that are typically presented together. For example,
`firstName` and `lastName` can be bundled together into a single composite because they are likely
to be referred to as a group. Grouping elements into a composite also allows the list to be
repeated.

Composite definitions are very similar to segment definitions, composed of some key-value pairs for
standard characteristics along with lists of values. Composites might include both references to
elements or other nested composites and inlined definitions. This is a example of a composite
definition:

```yaml
- id: "DateTime"
  name: "Date/Time pair"
  values:
    - { name: "File Creation Date", type: Date, length: 8 }
    - { name: "File Creation Time", type: Time, length: 4 }
```

Composite definitions might have the following attributes:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Description</th><th>Form</th></tr></thead><tbody><tr><td><p><code>controlVal</code></p></td><td><p>Value from containing level giving actual number of occurrences (only used with <code>count</code> != 1)</p></td><td><p>Inline definition, or on <a href="#referenced_vs_inlined_defs">reference</a></p></td></tr><tr><td><p><code>count</code></p></td><td><p>Number (or maximum number, if <code>controlVal</code> is used) of occurrences (optional, default is <code>1</code>)</p></td><td><p>Inline definition, or on <a href="#referenced_vs_inlined_defs">reference</a></p></td></tr><tr><td><p><code>id</code></p></td><td><p>Composite identifier for references</p></td><td><p><a href="#referenced_vs_inlined_defs">Referenced definition</a></p></td></tr><tr><td><p><code>name</code></p></td><td><p>Composite name (optional)</p></td><td><p>Inline or <a href="#referenced_vs_inlined_defs">referenced definition</a></p></td></tr><tr><td><p><code>values</code></p></td><td><p>List of elements and composites within the composite</p></td><td><p>Inline or <a href="#referenced_vs_inlined_defs">referenced definition</a></p></td></tr></tbody></table>

The values list takes the same form as the values list in a segment definition.

## Segment Definitions

A segment describes a type of record in your data. Segments are mainly composed of references or
direct definitions of elements and composites, together with some key-value pairs that describe the
segment. In a somewhat complex schema, you might have a structure that contains two different
segments, where one of these describes the fields that go in the single header of a bill of
materials (such as date and person), while the other segment describes the recurring fields that go
into each of the actual items in the bill of materials.

This is a sample segment definition that includes one simple element and a composite with two
elements within:

```yaml
- id: "RQH"
  name: Request Header Record
  values:
    - { name: "Organization Code", type: String, length: 10 }
    - id: "DateTime"
      name: "Date/Time pair"
      values:
        - { name: "File Creation Date", type: Date, length: 8 }
        - { name: "File Creation Time", type: Time, length: 4 }
```

Segment definitions might include the following attributes:

<table><colgroup><col> <col></colgroup><thead><tr><th>Section</th><th>Description</th></tr></thead><tbody><tr><td><p><code>id</code></p></td><td><p>Segment identifier (unused for inline definitions, required for <a href="#referenced_vs_inlined_defs">referenced definitions</a>)</p></td></tr><tr><td><p><code>name</code></p></td><td><p>Segment name (optional)</p></td></tr><tr><td><p><code>values</code></p></td><td><p>List of elements and composites within the segment (either inlined, or <a href="#referenced_vs_inlined_defs">references</a>)</p></td></tr></tbody></table>

## Structure Definitions

Structure definitions are composed of a list of references to segments and group definitions, as
well as a set of key-value pairs for standard characteristics. Segments may be further organized
into groups consisting of a potentially repeated sequence of segments.

Here’s a sample structure definition again:

```yaml
form: FIXEDWIDTH
structures:
- id: 'BatchReq'
  name: Batch Request
  data:
  - { idRef: 'RQH' }
  - groupId: 'Batch'
    count: '>1'
    items:
    - { idRef: 'BCH' }
    - { idRef: 'TDR', count: '>1' }
    - { idRef: 'BCF' }
  - { idRef: 'RQF' }
segments:
- id: 'RQH'
  ...
```

This example includes references to two segments at the top level (`RQH` and `RQF`), as well as a
group definition `Batch` that includes references to other segments (`BCH`, `TDR` and `BCF`). Note
that for this structure to work, each of the [referenced segments](#segment_definitions) needs to be
defined. See [Referenced versus Inlined Definitions](#referenced_vs_inlined_defs) to understand how
segments are referenced in this example.

A structure definition can contain the following attributes:

<table><colgroup><col> <col></colgroup><thead><tr><th>Structure Key/Section</th><th>Description</th></tr></thead><tbody><tr><td><p><code>id</code></p></td><td><p>Structure identifier</p></td></tr><tr><td><p><code>name</code></p></td><td><p>Structure name (optional)</p></td></tr><tr><td><p><code>data</code></p></td><td><p>List of segments (and groups) in the structure</p></td></tr></tbody></table>

Each item in a segment list is either a segment reference (or inline definition) or a group
definition (always inline).

### Group Definitions

A group definition can have the following attributes:

<table><colgroup><col> <col></colgroup><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td><p><code>groupId</code></p></td><td><p>The group identifier</p></td></tr><tr><td><p><code>usage</code></p></td><td><p>Usage code, which might be <code>M</code> for Mandatory, <code>O</code> for Optional, or <code>U</code> for Unused (optional, defaults to <code>M</code>)</p></td></tr><tr><td><p><code>count</code></p></td><td><p>Maximum repetition count value, which might be a number or the special value <code>&gt;1</code>, meaning any number of repeats (optional, count value of <code>1</code> is used if not specified)</p></td></tr><tr><td><p><code>items</code></p></td><td><p>List of segments (and potentially nested groups) making up the group</p></td></tr></tbody></table>

## Referenced Versus Inlined Definitions

Besides the choice of top-level form, you also have choices when it comes to representing the
components of a structure, segment, or composite. You can define the component segments, composites,
and elements inline at the point of use, or you can define them in a table and reference them from
anywhere. Inlining definitions is simpler and more compact, but the table form allows definitions to
be reused. Table form examples must include an `id` value, and each reference to that definition
uses an `idRef`. This example shows how this applies to the segments making up a structure:

```yaml
form: FIXEDWIDTH
structures:
  - id: "BatchReq"
    name: Batch Request
    data:
      - { idRef: "RQH" }
      - { idRef: "RQF" }
segments:
  - id: "RQH"
    name: "Request File Header Record"
    values:
      - { idref: createDate }
      - { idref: createTime }
      - { idref: fileId }
      - { idref: currency }
  - id: "RQF"
    name: "Request File Footer Record"
    values:
      - { idref: batchCount }
      - { idref: transactionCount }
      - { idref: transactionAmount }
      - { idref: debitCredit }
      - { idref: fileId }
elements:
  - { id: createDate, type: Date, length: 8 }
  - { id: createTime, type: Time, length: 4 }
  - { id: fileId, type: String, length: 10 }
  - { id: currency, type: String, length: 3 }
  - { id: batchCount, type: Integer, format: { justify: zeroes }, length: 4 }
  - { id: transactionCount, type: Integer, format: { justify: zeroes }, length: 6 }
  - { id: transactionAmount, type: Integer, format: { justify: zeroes }, length: 12 }
  - { id: debitCredit, type: String, length: 2 }
```

In the above example, the `BatchReq` structure references segments in the `data` definition section.
The segments are each then defined in the `segments` section at the top level of the schema, and
these in turn reference elements that are later defined in the `elements` section.

An inlined definition of the same structure looks like this:

```yaml
form: FIXEDWIDTH
structures:
  - id: "BatchReq"
    name: Batch Request
    data:
      - { idRef: "RQH" }
      - { idRef: "RQF" }
segments:
  - id: "RQH"
    name: "Request File Header Record"
    values:
      - { name: "File Creation Date", type: Date, length: 8 }
      - { name: "File Creation Time", type: Time, length: 4 }
      - { name: "Unique File Identifier", type: String, length: 10 }
      - { name: "Currency", type: String, length: 3 }
  - id: "RQF"
    name: "Request File Footer Record"
    values:
      - { name: "File Batch Count", type: Integer, format: { justify: zeroes }, length: 4 }
      - { name: "File Transaction Count", type: Integer, format: { justify: zeroes }, length: 6 }
      - { name: "File Transaction Amount", type: Integer, format: { justify: zeroes }, length: 12 }
      - { name: "Type", type: String, length: 2 }
      - { name: "Unique File Identifier", type: String, length: 10 }
```

## Full Example Schema

```yaml
form: FLATFILE
structures:
  - id: "BatchReq"
    name: Batch Request
    data:
      - { idRef: "RQH" }
      - groupId: "Batch"
        count: ">1"
        items:
          - { idRef: "BCH" }
          - { idRef: "TDR", count: ">1" }
          - { idRef: "BCF" }
      - { idRef: "RQF" }
segments:
  - id: "RQH"
    name: "Request File Header Record"
    values:
      - { name: "Record Type", type: String, length: 3, tagValue: "RQH" }
      - { name: "File Creation Date", type: Date, length: 8 }
      - { name: "File Creation Time", type: Time, length: 4 }
      - { name: "Unique File Identifier", type: String, length: 10 }
      - { name: "Currency", type: String, length: 3 }
  - id: "BCH"
    name: "Batch Header Record"
    values:
      - { name: "Record Type", type: String, length: 3, tagValue: "BAT" }
      - { name: "Sequence Number", type: Integer, format: { justify: zeroes }, length: 6 }
      - { name: "Batch Function", type: String, length: 1, tagValue: "H" }
      - { name: "Company Name", type: String, length: 30 }
      - { name: "Unique Batch Identifier", type: String, length: 10 }
  - id: "TDR"
    name: "Transaction Detail Record"
    values:
      - { name: "Record Type", type: String, length: 3, tagValue: "BAT" }
      - { name: "Sequence Number", type: Integer, format: { justify: zeroes }, length: 6 }
      - { name: "Batch Function", type: String, length: 1, tagValue: "D" }
      - { name: "Account Number", type: String, length: 10 }
      - { name: "Amount", type: Integer, format: { justify: zeroes }, length: 10 }
      - { name: "Type", type: String, length: 2 }
  - id: "BCF"
    name: "Batch Footer Record"
    values:
      - { name: "Record Type", type: String, length: 3, tagValue: "BAT" }
      - { name: "Sequence Number", type: Integer, format: { justify: zeroes }, length: 6 }
      - { name: "Batch Function", type: String, length: 1, tagValue: "T" }
      - { name: "Batch Transaction Amount", type: Integer, format: { justify: zeroes }, length: 10 }
      - { name: "Type", type: String, length: 2 }
      - { name: "Batch Transaction Count", type: Integer, format: { justify: zeroes }, length: 6 }
      - { name: "Unique Batch Identifier", type: String, length: 10 }
  - id: "RQF"
    name: "Request File Footer Record"
    values:
      - { name: "Record Type", type: String, length: 3, tagValue: "RQF" }
      - { name: "File Batch Count", type: Integer, format: { justify: zeroes }, length: 4 }
      - { name: "File Transaction Count", type: Integer, format: { justify: zeroes }, length: 6 }
      - { name: "File Transaction Amount", type: Integer, format: { justify: zeroes }, length: 12 }
      - { name: "Type", type: String, length: 2 }
      - { name: "Unique File Identifier", type: String, length: 10 }
```

This example contains a single [structure](#structure_definitions) named 'BatchReq' with 5
components [segments](#segment_definitions), using a doubly-nested structure of file and batch data
for the segments. Each batch contains repeating detail records. All element definitions are
in-lined.

The `BatchReq` structure definition requires that the data will consist of:

- A single record that corresponds to the segment `RQH`

- One or more records that correspond to the segment `BCH`

- For each `BCH` record, one or more `TDR` records giving details of a particular transaction

- For each `BCH` record, a `BCF` record following any contained `TDR` records

- A final, single record that corresponds to the segment `RQF`

For this example every record starts with a three-character Record Type field with a specified
`tagValue`. In the case of the batch records, the record type is further specified by a Batch
Function `tagValue`.

This is a sample of data matching the schema example:

```text
RQH201809011010A000000001USD
BAT000001HACME RESEARCH                 A000000001
BAT000002D01234567890000032876CR
BAT000003D01234567880000087326CR
BAT000004T0000120202CR000002A000000001
BAT000005HAJAX EXPLOSIVES               A000000002
BAT000006D12345678900000003582DB
BAT000007D12345678910000000256CR
BAT000008T0000003326DB000002A000000002
RQF0002000008000000116876CRA000000001
```

The lines in the example match the defined structure as listed below:

- 1 `RQH` (Request File Header Record) identified by the "RQH" value in the first three characters

- 2 `BCH` (Batch Header Record) identified by the "BAT" value in the first three characters combined
  with the 'H' character in position 10

- 3-4 `TDR` (Transaction Detail Record) identified by the "BAT" value in the first three characters
  combined with the 'D' character in position 10

- 5 `BCF` (Batch Footer Record) identified by the "BAT" value in the first three characters combined
  with the 'T' character in position 10

- 6 `BCH` (Batch Header Record) identified by the "BAT" value in the first three characters combined
  with the 'H' character in position 10

- 7-8 `TDR` (Transaction Detail Record) identified by the "BAT" value in the first three characters
  combined with the 'D' character in position 10

- 9 `BCF` (Batch Footer Record) identified by the "BAT" value in the first three characters combined
  with the 'T' character in position 10

- 10 `RQF` (Request File Footer Record) identified by the "RQF" value in the first three characters

`tagValue` fields provide a lot of flexibility. The above example shows using a single `tagValue`
for some record types, while adding a second `tagValue` for others, but you can also use completely
different fields (or even disjoint sets of fields) for a `tagValue`, as long as you provide enough
details for the parser to distinguish between the different types of records.

Note that older versions of the documentation showed a different way of distinguishing records based
on tag values, using `tagStart` and `tagLength` values for the structure and `tag` values for the
segments. This method of distinguishing segments is much more limited than the `tagValue` approach,
and is now deprecated.

## See Also

[Supported Data Formats](https://docs.mulesoft.com/dataweave/latest/dataweave-formats#format_flat_file)

<!-- document id=038f679daa3902b390b08cf1fcd5ef670b5eb0d2ab2780dc045852193a88b8fd url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-flatmap.md -->

---
product: DataWeave
version: 2.11
---

# flatMap

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## flatMap<T, R>(@StreamCapable items: Array<T>, mapper: (item: T, index: Number) -> Array<R>): Array<R>

Iterates over each item in an array and flattens the results.

Instead of returning an array of arrays (as `map` does when you iterate over the values within an
input like `[ [1,2], [3,4] ]`), `flatMap` returns a flattened array that looks like this:
`[1, 2, 3, 4]`. `flatMap` is similar to `flatten`, but `flatten` only acts on the values of the
arrays, while `flatMap` can act on values and indices of items in the array.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The array to map.</p></td></tr><tr><td><p><code>mapper</code></p></td><td><p>Expression or selector for an <code>item</code> and/or <code>index</code> in the array to flatten.</p></td></tr></tbody></table>

### Example

This example returns an array containing each value in order. Though it names the optional `index`
parameter in its anonymous function `(value, index) → value`, it does not use `index` as a selector
for the output, so it is possible to write the anonymous function using `(value) → value`. You can
also use an anonymous parameter for the value to write the example like this:
`[ [3,5], [0.9,5.5] ] flatMap $`. Note that this example produces the same result as
`flatten([ [3,5], [0.9,5.5] ])`, which uses `flatten`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ [3,5], [0.9,5.5] ] flatMap (value, index) -> value
```

#### Output

```JSON
[ 3, 5, 0.9, 5.5]
```

## flatMap<T, R>(@StreamCapable value: Null, mapper: (item: Nothing, index: Nothing) -> Any): Null

Helper function that enables `flatMap` to work with a `null` value.

<!-- document id=cddafc5d7bba4420274b4ea56841b5bf91d253d173e7d193eb4f457607ca0849 url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-flatmap.md -->

---
product: DataWeave
version: 2.12
---

# flatMap

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## flatMap<T, R>(@StreamCapable items: Array<T>, mapper: (item: T, index: Number) -> Array<R>): Array<R>

Iterates over each item in an array and flattens the results.

Instead of returning an array of arrays (as `map` does when you iterate over the values within an
input like `[ [1,2], [3,4] ]`), `flatMap` returns a flattened array that looks like this:
`[1, 2, 3, 4]`. `flatMap` is similar to `flatten`, but `flatten` only acts on the values of the
arrays, while `flatMap` can act on values and indices of items in the array.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The array to map.</p></td></tr><tr><td><p><code>mapper</code></p></td><td><p>Expression or selector for an <code>item</code> and/or <code>index</code> in the array to flatten.</p></td></tr></tbody></table>

### Example

This example returns an array containing each value in order. Though it names the optional `index`
parameter in its anonymous function `(value, index) → value`, it does not use `index` as a selector
for the output, so it is possible to write the anonymous function using `(value) → value`. You can
also use an anonymous parameter for the value to write the example like this:
`[ [3,5], [0.9,5.5] ] flatMap $`. Note that this example produces the same result as
`flatten([ [3,5], [0.9,5.5] ])`, which uses `flatten`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ [3,5], [0.9,5.5] ] flatMap (value, index) -> value
```

#### Output

```JSON
[ 3, 5, 0.9, 5.5]
```

## flatMap<T, R>(@StreamCapable value: Null, mapper: (item: Nothing, index: Nothing) -> Any): Null

Helper function that enables `flatMap` to work with a `null` value.

<!-- document id=8a7cd18466db16ad2d68575b56642fd18eb0342905ea16169fdaf9b0fb58ae0a url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-flatmap.md -->

---
product: DataWeave
version: 2.3
---

# flatMap

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## flatMap(Array<T>, (item: T, index: Number) -> Array<R>): Array<R>

Iterates over each item in an array and flattens the results.

Instead of returning an array of arrays (as `map` does when you iterate over the values within an
input like `[ [1,2], [3,4] ]`), `flatMap` returns a flattened array that looks like this:
`[1, 2, 3, 4]`. `flatMap` is similar to `flatten`, but `flatten` only acts on the values of the
arrays, while `flatMap` can act on values and indices of items in the array.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The array to map.</p></td></tr><tr><td><p><code>mapper</code></p></td><td><p>Expression or selector for an <code>item</code> and/or <code>index</code> in the array to flatten.</p></td></tr></tbody></table>

### Example

This example returns an array containing each value in order. Though it names the optional `index`
parameter in its anonymous function `(value, index) → value`, it does not use `index` as a selector
for the output, so it is possible to write the anonymous function using `(value) → value`. You can
also use an anonymous parameter for the value to write the example like this:
`[ [3,5], [0.9,5.5] ] flatMap $`. Note that this example produces the same result as
`flatten([ [3,5], [0.9,5.5] ])`, which uses `flatten`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ [3,5], [0.9,5.5] ] flatMap (value, index) -> value
```

#### Output

```JSON
[ 3, 5, 0.9, 5.5]
```

## flatMap(Null, (item: Nothing, index: Nothing) -> Any): Null

Helper function that enables `flatMap` to work with a `null` value.

<!-- document id=f33410ef995385a217a0c0441b6cdc2f448e024d62898a96a99c1f461e86b32b url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-flatmap.md -->

---
product: DataWeave
version: 2.4
---

# flatMap

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## flatMap<T, R>(@StreamCapable items: Array<T>, mapper: (item: T, index: Number) -> Array<R>): Array<R>

Iterates over each item in an array and flattens the results.

Instead of returning an array of arrays (as `map` does when you iterate over the values within an
input like `[ [1,2], [3,4] ]`), `flatMap` returns a flattened array that looks like this:
`[1, 2, 3, 4]`. `flatMap` is similar to `flatten`, but `flatten` only acts on the values of the
arrays, while `flatMap` can act on values and indices of items in the array.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The array to map.</p></td></tr><tr><td><p><code>mapper</code></p></td><td><p>Expression or selector for an <code>item</code> and/or <code>index</code> in the array to flatten.</p></td></tr></tbody></table>

### Example

This example returns an array containing each value in order. Though it names the optional `index`
parameter in its anonymous function `(value, index) → value`, it does not use `index` as a selector
for the output, so it is possible to write the anonymous function using `(value) → value`. You can
also use an anonymous parameter for the value to write the example like this:
`[ [3,5], [0.9,5.5] ] flatMap $`. Note that this example produces the same result as
`flatten([ [3,5], [0.9,5.5] ])`, which uses `flatten`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ [3,5], [0.9,5.5] ] flatMap (value, index) -> value
```

#### Output

```JSON
[ 3, 5, 0.9, 5.5]
```

## flatMap<T, R>(@StreamCapable value: Null, mapper: (item: Nothing, index: Nothing) -> Any): Null

Helper function that enables `flatMap` to work with a `null` value.

<!-- document id=17901b4f0b83dc311d7a8cd27ed1b1ea6719e55d3518fcc7d155f03609878ab5 url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-flatmap.md -->

---
product: DataWeave
version: 2.6
---

# flatMap

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## flatMap<T, R>(@StreamCapable items: Array<T>, mapper: (item: T, index: Number) -> Array<R>): Array<R>

Iterates over each item in an array and flattens the results.

Instead of returning an array of arrays (as `map` does when you iterate over the values within an
input like `[ [1,2], [3,4] ]`), `flatMap` returns a flattened array that looks like this:
`[1, 2, 3, 4]`. `flatMap` is similar to `flatten`, but `flatten` only acts on the values of the
arrays, while `flatMap` can act on values and indices of items in the array.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The array to map.</p></td></tr><tr><td><p><code>mapper</code></p></td><td><p>Expression or selector for an <code>item</code> and/or <code>index</code> in the array to flatten.</p></td></tr></tbody></table>

### Example

This example returns an array containing each value in order. Though it names the optional `index`
parameter in its anonymous function `(value, index) → value`, it does not use `index` as a selector
for the output, so it is possible to write the anonymous function using `(value) → value`. You can
also use an anonymous parameter for the value to write the example like this:
`[ [3,5], [0.9,5.5] ] flatMap $`. Note that this example produces the same result as
`flatten([ [3,5], [0.9,5.5] ])`, which uses `flatten`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ [3,5], [0.9,5.5] ] flatMap (value, index) -> value
```

#### Output

```JSON
[ 3, 5, 0.9, 5.5]
```

## flatMap<T, R>(@StreamCapable value: Null, mapper: (item: Nothing, index: Nothing) -> Any): Null

Helper function that enables `flatMap` to work with a `null` value.

<!-- document id=efd7fd866a61d06246bfbf8e9d0618f00a8c27125a9606292f7f130697465f82 url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-flatmap.md -->

---
product: DataWeave
version: 2.9
---

# flatMap

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## flatMap<T, R>(@StreamCapable items: Array<T>, mapper: (item: T, index: Number) -> Array<R>): Array<R>

Iterates over each item in an array and flattens the results.

Instead of returning an array of arrays (as `map` does when you iterate over the values within an
input like `[ [1,2], [3,4] ]`), `flatMap` returns a flattened array that looks like this:
`[1, 2, 3, 4]`. `flatMap` is similar to `flatten`, but `flatten` only acts on the values of the
arrays, while `flatMap` can act on values and indices of items in the array.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The array to map.</p></td></tr><tr><td><p><code>mapper</code></p></td><td><p>Expression or selector for an <code>item</code> and/or <code>index</code> in the array to flatten.</p></td></tr></tbody></table>

### Example

This example returns an array containing each value in order. Though it names the optional `index`
parameter in its anonymous function `(value, index) → value`, it does not use `index` as a selector
for the output, so it is possible to write the anonymous function using `(value) → value`. You can
also use an anonymous parameter for the value to write the example like this:
`[ [3,5], [0.9,5.5] ] flatMap $`. Note that this example produces the same result as
`flatten([ [3,5], [0.9,5.5] ])`, which uses `flatten`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ [3,5], [0.9,5.5] ] flatMap (value, index) -> value
```

#### Output

```JSON
[ 3, 5, 0.9, 5.5]
```

## flatMap<T, R>(@StreamCapable value: Null, mapper: (item: Nothing, index: Nothing) -> Any): Null

Helper function that enables `flatMap` to work with a `null` value.

<!-- document id=d1975097c3514d337404d0559cb1af5a4a3f19429a913ad750adb5ed4ed7605d url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-flatmap.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# flatMap

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## flatMap<T, R>(@StreamCapable items: Array<T>, mapper: (item: T, index: Number) -> Array<R>): Array<R>

Iterates over each item in an array and flattens the results.

Instead of returning an array of arrays (as `map` does when you iterate over the values within an
input like `[ [1,2], [3,4] ]`), `flatMap` returns a flattened array that looks like this:
`[1, 2, 3, 4]`. `flatMap` is similar to `flatten`, but `flatten` only acts on the values of the
arrays, while `flatMap` can act on values and indices of items in the array.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The array to map.</p></td></tr><tr><td><p><code>mapper</code></p></td><td><p>Expression or selector for an <code>item</code> and/or <code>index</code> in the array to flatten.</p></td></tr></tbody></table>

### Example

This example returns an array containing each value in order. Though it names the optional `index`
parameter in its anonymous function `(value, index) → value`, it does not use `index` as a selector
for the output, so it is possible to write the anonymous function using `(value) → value`. You can
also use an anonymous parameter for the value to write the example like this:
`[ [3,5], [0.9,5.5] ] flatMap $`. Note that this example produces the same result as
`flatten([ [3,5], [0.9,5.5] ])`, which uses `flatten`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ [3,5], [0.9,5.5] ] flatMap (value, index) -> value
```

#### Output

```JSON
[ 3, 5, 0.9, 5.5]
```

## flatMap<T, R>(@StreamCapable value: Null, mapper: (item: Nothing, index: Nothing) -> Any): Null

Helper function that enables `flatMap` to work with a `null` value.

<!-- document id=d06195e8d25f4b7e45bf2ed5aa141798654b0fef5eb53dd3614893bff3b8bf22 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-flatten.md -->

---
product: DataWeave
version: 2.11
---

# flatten

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## flatten<T, Q>(@StreamCapable items: Array<Array<T> | Q>): Array<T | Q>

Turns a set of subarrays (such as `[ [1,2,3], [4,5,[6]], [], [null] ]`) into a single, flattened
array (such as `[ 1, 2, 3, 4, 5, [6], null ]`).

Note that it flattens only the first level of subarrays and omits empty subarrays.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The input array of arrays made up of any supported types.</p></td></tr></tbody></table>

### Example

This example defines three arrays of numbers, creates another array containing those three arrays,
and then uses the flatten function to convert the array of arrays into a single array with all
values.

#### Source

```DataWeave
%dw 2.0
output application/json
var array1 = [1,2,3]
var array2 = [4,5,6]
var array3 = [7,8,9]
var arrayOfArrays = [array1, array2, array3]
---
flatten(arrayOfArrays)
```

#### Output

```JSON
[ 1,2,3,4,5,6,7,8,9 ]
```

### Example

This example returns a single array from nested arrays of objects.

#### Source

```DataWeave
%dw 2.0
var myData =
{ user : [
   {
     group : "dev",
     myarray : [
       { name : "Shoki", id : 5678 },
       { name : "Mariano", id : 9123 }
     ]
   },
   {
     group : "test",
     myarray : [
       { name : "Sai", id : 2001 },
       { name : "Peter", id : 2002 }
     ]
   }
 ]
}
output application/json
---
flatten(myData.user.myarray)
```

#### Output

```JSON
[
  {
    "name": "Shoki",
    "id": 5678
  },
  {
    "name": "Mariano",
    "id": 9123
  },
  {
    "name": "Sai",
    "id": 2001
  },
  {
    "name": "Peter",
    "id": 2002
  }
]
```

Note that if you use `myData.user.myarray` to select the array of objects in `myarray`, instead of
using `flatten(myData.user.myarray)`, the output is a nested array of objects:

```JSON
[
  [
    {
      "name": "Shoki",
      "id": 5678
    },
    {
      "name": "Mariano",
      "id": 9123
    }
  ]
]
```

## flatten(@StreamCapable value: Null): Null

Helper function that enables `flatten` to work with a `null` value.

<!-- document id=9bf065d7025976cb1c0ffa948c9b87cd2086ccc07591666878a31bec08ca1084 url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-flatten.md -->

---
product: DataWeave
version: 2.12
---

# flatten

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## flatten<T, Q>(@StreamCapable items: Array<Array<T> | Q>): Array<T | Q>

Turns a set of subarrays (such as `[ [1,2,3], [4,5,[6]], [], [null] ]`) into a single, flattened
array (such as `[ 1, 2, 3, 4, 5, [6], null ]`).

Note that it flattens only the first level of subarrays and omits empty subarrays.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The input array of arrays made up of any supported types.</p></td></tr></tbody></table>

### Example

This example defines three arrays of numbers, creates another array containing those three arrays,
and then uses the flatten function to convert the array of arrays into a single array with all
values.

#### Source

```DataWeave
%dw 2.0
output application/json
var array1 = [1,2,3]
var array2 = [4,5,6]
var array3 = [7,8,9]
var arrayOfArrays = [array1, array2, array3]
---
flatten(arrayOfArrays)
```

#### Output

```JSON
[ 1,2,3,4,5,6,7,8,9 ]
```

### Example

This example returns a single array from nested arrays of objects.

#### Source

```DataWeave
%dw 2.0
var myData =
{ user : [
   {
     group : "dev",
     myarray : [
       { name : "Shoki", id : 5678 },
       { name : "Mariano", id : 9123 }
     ]
   },
   {
     group : "test",
     myarray : [
       { name : "Sai", id : 2001 },
       { name : "Peter", id : 2002 }
     ]
   }
 ]
}
output application/json
---
flatten(myData.user.myarray)
```

#### Output

```JSON
[
  {
    "name": "Shoki",
    "id": 5678
  },
  {
    "name": "Mariano",
    "id": 9123
  },
  {
    "name": "Sai",
    "id": 2001
  },
  {
    "name": "Peter",
    "id": 2002
  }
]
```

Note that if you use `myData.user.myarray` to select the array of objects in `myarray`, instead of
using `flatten(myData.user.myarray)`, the output is a nested array of objects:

```JSON
[
  [
    {
      "name": "Shoki",
      "id": 5678
    },
    {
      "name": "Mariano",
      "id": 9123
    }
  ]
]
```

## flatten(@StreamCapable value: Null): Null

Helper function that enables `flatten` to work with a `null` value.

<!-- document id=29b422fe27d281cdf161fe7417a36b6c4954ae3af753accc7148eeb2388b12af url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-flatten.md -->

---
product: DataWeave
version: 2.3
---

# flatten

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## flatten(Array<Array<T> | Q>): Array<T | Q>

Turns a set of subarrays (such as `[ [1,2,3], [4,5,[6]], [], [null] ]`) into a single, flattened
array (such as `[ 1, 2, 3, 4, 5, [6], null ]`).

Note that it flattens only the first level of subarrays and omits empty subarrays.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The input array of arrays made up of any supported types.</p></td></tr></tbody></table>

### Example

This example defines three arrays of numbers, creates another array containing those three arrays,
and then uses the flatten function to convert the array of arrays into a single array with all
values.

#### Source

```DataWeave
%dw 2.0
output application/json
var array1 = [1,2,3]
var array2 = [4,5,6]
var array3 = [7,8,9]
var arrayOfArrays = [array1, array2, array3]
---
flatten(arrayOfArrays)
```

#### Output

```JSON
[ 1,2,3,4,5,6,7,8,9 ]
```

### Example

This example returns a single array from a nested array of objects.

#### Source

```DataWeave
%dw 2.0
var myData =
{ user : [
   {
     group : "dev",
     myarray : [
       { name : "Shoki", id : 5678 },
       { name : "Mariano", id : 9123 }
     ]
   }
 ]
}
output application/json
---
flatten(myData.user.myarray)
```

#### Output

```JSON
[
  {
    "name": "Shoki",
    "id": 5678
  },
  {
    "name": "Mariano",
    "id": 9123
  }
]
```

Note that if you use `myData.user.myarray` to select the array of objects in `myarray`, instead of
using `flatten(myData.user.myarray)`, the output is a nested array of objects:

```JSON
[
  [
    {
      "name": "Shoki",
      "id": 5678
    },
    {
      "name": "Mariano",
      "id": 9123
    }
  ]
]
```

## flatten(Null): Null

Helper function that enables `flatten` to work with a `null` value.

<!-- document id=c84ec418dd1e1dbbd38a96bddf07d3c43788e2d0da21f6e856fac9165d7bff9b url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-flatten.md -->

---
product: DataWeave
version: 2.4
---

# flatten

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## flatten<T, Q>(@StreamCapable items: Array<Array<T> | Q>): Array<T | Q>

Turns a set of subarrays (such as `[ [1,2,3], [4,5,[6]], [], [null] ]`) into a single, flattened
array (such as `[ 1, 2, 3, 4, 5, [6], null ]`).

Note that it flattens only the first level of subarrays and omits empty subarrays.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The input array of arrays made up of any supported types.</p></td></tr></tbody></table>

### Example

This example defines three arrays of numbers, creates another array containing those three arrays,
and then uses the flatten function to convert the array of arrays into a single array with all
values.

#### Source

```DataWeave
%dw 2.0
output application/json
var array1 = [1,2,3]
var array2 = [4,5,6]
var array3 = [7,8,9]
var arrayOfArrays = [array1, array2, array3]
---
flatten(arrayOfArrays)
```

#### Output

```JSON
[ 1,2,3,4,5,6,7,8,9 ]
```

### Example

This example returns a single array from nested arrays of objects.

#### Source

```DataWeave
%dw 2.0
var myData =
{ user : [
   {
     group : "dev",
     myarray : [
       { name : "Shoki", id : 5678 },
       { name : "Mariano", id : 9123 }
     ]
   },
   {
     group : "test",
     myarray : [
       { name : "Sai", id : 2001 },
       { name : "Peter", id : 2002 }
     ]
   }
 ]
}
output application/json
---
flatten(myData.user.myarray)
```

#### Output

```JSON
[
  {
    "name": "Shoki",
    "id": 5678
  },
  {
    "name": "Mariano",
    "id": 9123
  },
  {
    "name": "Sai",
    "id": 2001
  },
  {
    "name": "Peter",
    "id": 2002
  }
]
```

Note that if you use `myData.user.myarray` to select the array of objects in `myarray`, instead of
using `flatten(myData.user.myarray)`, the output is a nested array of objects:

```JSON
[
  [
    {
      "name": "Shoki",
      "id": 5678
    },
    {
      "name": "Mariano",
      "id": 9123
    }
  ]
]
```

## flatten(@StreamCapable value: Null): Null

Helper function that enables `flatten` to work with a `null` value.

<!-- document id=cdc7585fdb83c29c71a3028c5cd5b6bda2265771cca2bd253e6db013e7dd1fc7 url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-flatten.md -->

---
product: DataWeave
version: 2.6
---

# flatten

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## flatten<T, Q>(@StreamCapable items: Array<Array<T> | Q>): Array<T | Q>

Turns a set of subarrays (such as `[ [1,2,3], [4,5,[6]], [], [null] ]`) into a single, flattened
array (such as `[ 1, 2, 3, 4, 5, [6], null ]`).

Note that it flattens only the first level of subarrays and omits empty subarrays.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The input array of arrays made up of any supported types.</p></td></tr></tbody></table>

### Example

This example defines three arrays of numbers, creates another array containing those three arrays,
and then uses the flatten function to convert the array of arrays into a single array with all
values.

#### Source

```DataWeave
%dw 2.0
output application/json
var array1 = [1,2,3]
var array2 = [4,5,6]
var array3 = [7,8,9]
var arrayOfArrays = [array1, array2, array3]
---
flatten(arrayOfArrays)
```

#### Output

```JSON
[ 1,2,3,4,5,6,7,8,9 ]
```

### Example

This example returns a single array from nested arrays of objects.

#### Source

```DataWeave
%dw 2.0
var myData =
{ user : [
   {
     group : "dev",
     myarray : [
       { name : "Shoki", id : 5678 },
       { name : "Mariano", id : 9123 }
     ]
   },
   {
     group : "test",
     myarray : [
       { name : "Sai", id : 2001 },
       { name : "Peter", id : 2002 }
     ]
   }
 ]
}
output application/json
---
flatten(myData.user.myarray)
```

#### Output

```JSON
[
  {
    "name": "Shoki",
    "id": 5678
  },
  {
    "name": "Mariano",
    "id": 9123
  },
  {
    "name": "Sai",
    "id": 2001
  },
  {
    "name": "Peter",
    "id": 2002
  }
]
```

Note that if you use `myData.user.myarray` to select the array of objects in `myarray`, instead of
using `flatten(myData.user.myarray)`, the output is a nested array of objects:

```JSON
[
  [
    {
      "name": "Shoki",
      "id": 5678
    },
    {
      "name": "Mariano",
      "id": 9123
    }
  ]
]
```

## flatten(@StreamCapable value: Null): Null

Helper function that enables `flatten` to work with a `null` value.

<!-- document id=4e249c75234feff3fbda87164b24fc6fca85ab9c5eb04d8ee9c4913083a7efea url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-flatten.md -->

---
product: DataWeave
version: 2.9
---

# flatten

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## flatten<T, Q>(@StreamCapable items: Array<Array<T> | Q>): Array<T | Q>

Turns a set of subarrays (such as `[ [1,2,3], [4,5,[6]], [], [null] ]`) into a single, flattened
array (such as `[ 1, 2, 3, 4, 5, [6], null ]`).

Note that it flattens only the first level of subarrays and omits empty subarrays.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The input array of arrays made up of any supported types.</p></td></tr></tbody></table>

### Example

This example defines three arrays of numbers, creates another array containing those three arrays,
and then uses the flatten function to convert the array of arrays into a single array with all
values.

#### Source

```DataWeave
%dw 2.0
output application/json
var array1 = [1,2,3]
var array2 = [4,5,6]
var array3 = [7,8,9]
var arrayOfArrays = [array1, array2, array3]
---
flatten(arrayOfArrays)
```

#### Output

```JSON
[ 1,2,3,4,5,6,7,8,9 ]
```

### Example

This example returns a single array from nested arrays of objects.

#### Source

```DataWeave
%dw 2.0
var myData =
{ user : [
   {
     group : "dev",
     myarray : [
       { name : "Shoki", id : 5678 },
       { name : "Mariano", id : 9123 }
     ]
   },
   {
     group : "test",
     myarray : [
       { name : "Sai", id : 2001 },
       { name : "Peter", id : 2002 }
     ]
   }
 ]
}
output application/json
---
flatten(myData.user.myarray)
```

#### Output

```JSON
[
  {
    "name": "Shoki",
    "id": 5678
  },
  {
    "name": "Mariano",
    "id": 9123
  },
  {
    "name": "Sai",
    "id": 2001
  },
  {
    "name": "Peter",
    "id": 2002
  }
]
```

Note that if you use `myData.user.myarray` to select the array of objects in `myarray`, instead of
using `flatten(myData.user.myarray)`, the output is a nested array of objects:

```JSON
[
  [
    {
      "name": "Shoki",
      "id": 5678
    },
    {
      "name": "Mariano",
      "id": 9123
    }
  ]
]
```

## flatten(@StreamCapable value: Null): Null

Helper function that enables `flatten` to work with a `null` value.

<!-- document id=de4315c31f4ec808a65151b7bb84779eab9116d5eb5aa0d36bde59ded4726252 url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-flatten.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# flatten

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## flatten<T, Q>(@StreamCapable items: Array<Array<T> | Q>): Array<T | Q>

Turns a set of subarrays (such as `[ [1,2,3], [4,5,[6]], [], [null] ]`) into a single, flattened
array (such as `[ 1, 2, 3, 4, 5, [6], null ]`).

Note that it flattens only the first level of subarrays and omits empty subarrays.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The input array of arrays made up of any supported types.</p></td></tr></tbody></table>

### Example

This example defines three arrays of numbers, creates another array containing those three arrays,
and then uses the flatten function to convert the array of arrays into a single array with all
values.

#### Source

```DataWeave
%dw 2.0
output application/json
var array1 = [1,2,3]
var array2 = [4,5,6]
var array3 = [7,8,9]
var arrayOfArrays = [array1, array2, array3]
---
flatten(arrayOfArrays)
```

#### Output

```JSON
[ 1,2,3,4,5,6,7,8,9 ]
```

### Example

This example returns a single array from nested arrays of objects.

#### Source

```DataWeave
%dw 2.0
var myData =
{ user : [
   {
     group : "dev",
     myarray : [
       { name : "Shoki", id : 5678 },
       { name : "Mariano", id : 9123 }
     ]
   },
   {
     group : "test",
     myarray : [
       { name : "Sai", id : 2001 },
       { name : "Peter", id : 2002 }
     ]
   }
 ]
}
output application/json
---
flatten(myData.user.myarray)
```

#### Output

```JSON
[
  {
    "name": "Shoki",
    "id": 5678
  },
  {
    "name": "Mariano",
    "id": 9123
  },
  {
    "name": "Sai",
    "id": 2001
  },
  {
    "name": "Peter",
    "id": 2002
  }
]
```

Note that if you use `myData.user.myarray` to select the array of objects in `myarray`, instead of
using `flatten(myData.user.myarray)`, the output is a nested array of objects:

```JSON
[
  [
    {
      "name": "Shoki",
      "id": 5678
    },
    {
      "name": "Mariano",
      "id": 9123
    }
  ]
]
```

## flatten(@StreamCapable value: Null): Null

Helper function that enables `flatten` to work with a `null` value.

<!-- document id=98c00edb46f90eded99c1463f6b99a4a7c2964413a03559a18d3eabe6c98f28e url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook-flatten-arrays.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Flatten Elements of Arrays

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave can flatten subarrays of an array and collections of key-value pairs within DataWeave
objects, arrays, and subarrays.

## Flatten Subarrays with Key-Value Pairs into an Array of Objects

This example shows how `flatten` acts on key-value pairs of the input array defined by the variable
`arrayOne`. Notice that every key-value pair in the array becomes a separate DataWeave object.

The example uses this function:

- `flatten` to move the elements from the subarrays to the parent array, eliminate the subarrays,
  and covert all key-value pairs into a list of objects within the parent array.

DataWeave Script:

```dataweave
%dw 2.0
var arrayOne = [
                 [
                    "keyOne" : 1,
                    "keyTwo" : 2
                 ],
                 [
                    "keyThree" : 3,
                    "keyFour" : 4,
                    "keyFive" : 5
                 ],
                 "keySix" : 6
               ]
output application/json
---
flatten(arrayOne)
```

Output JSON:

```json
[
  {
    "keyOne": 1
  },
  {
    "keyTwo": 2
  },
  {
    "keyThree": 3
  },
  {
    "keyFour": 4
  },
  {
    "keyFive": 5
  },
  {
    "keySix": 6
  }
]
```

## Flatten Combined Arrays

Like the previous DataWeave example, the following returns an array that combines and flattens the
elements from two arrays. This second example applies the selector `fruit` to select only the values
of the key `fruit` and to exclude other values in the array.

This example uses:

- `++` to combine the objects of two arrays (`arrayOne` and `arrayTwo`) into a single array.

- `flatten` to flatten the combined array into a list of key-value pairs.

DataWeave Script:

```dataweave
%dw 2.0
var arrayOne = [
                  [
                     "fruit" : "orange",
                     "fruit" : "apple"
                  ],
                  [
                     "fruit" : "grape",
                     "notfruit" : "something else"
                  ]
               ]
var arrayTwo = [
                  [
                  	{  "fruit" : "kiwi" }
                  ],
                  "fruit" : "strawberry",
                  "fruit" : "plum",
                  { "fruit" : "banana" },
                  "notfruit" : "something else"
               ]
output application/json
---
flatten(arrayOne ++ arrayTwo)
```

Output JSON:

```json
[
  { "fruit": "orange" },
  { "fruit": "apple" },
  { "fruit": "grape" },
  { "notfruit": "something else" },
  { "fruit": "kiwi" },
  { "fruit": "strawberry" },
  { "fruit": "plum" },
  { "fruit": "banana" },
  { "notfruit": "something else" }
]
```

The only difference between the [previous example](#ex02) and the following example is the addition
of the `.fruit` selector to the body expression to select all the `fruit` values and to exclude
values of the `notfruit` keys from the output array.

DataWeave Script:

```dataweave
%dw 2.0
var arrayOne = [
                  [
                     "fruit" : "orange",
                     "fruit" : "apple"
                  ],
                  [
                     "fruit" : "grape",
                     "notfruit" : "something else"
                  ]
               ]
var arrayTwo = [
                  [
                  	{  "fruit" : "kiwi" }
                  ],
                  "fruit" : "strawberry",
                  "fruit" : "plum",
                  { "fruit" : "banana" },
                  "notfruit" : "something else"
               ]
output application/json
---
flatten(arrayOne ++ arrayTwo).fruit
```

Output JSON:

```json
["orange", "apple", "grape", "kiwi", "strawberry", "plum", "banana"]
```

The next example uses `..*fruit` as a selector in the body expression instead of `.fruit` to return
all nested `fruit` values in the flattened array. It also flattens three combined arrays instead of
two.

DataWeave Script:

```dataweave
%dw 2.0
var arrayOne = [
                  [
                     "fruit" : "orange",
                     "fruit" : "apple"
                  ],
                  [
                     "fruit" : "grape",
                     "notfruit" : "something else"
                  ]
               ]
var arrayTwo = [
                  [
                  	{  "fruit" : "kiwi" }
                  ],
                  "fruit" : "strawberry",
                  "fruit" : "plum",
                  { "fruit" : "banana" },
                  "notfruit" : "something else"
               ]
var arrayThree = [
                    { parentOne :
                        [
                     	     { child :
                     	       [
                     	         { grandchild :
                                   {
                                      "fruit" : "watermelon",
                                      "notfruit" : "something else"
                                   }
                                },
                                {
                                   fruit : "cantaloupe",
                                   "notfruit" : "something else"
                                }
                             ]
                           },
                           {
                              fruit : "honeydew",
                              "notfruit" : "something else"
                           }
                        ]
                    },
                    { parentTwo:
                     	  [
                     	  	 fruit : "cherry",
                     		   "notfruit" : "something else"
                     	  ]
                    }
                 ]
output application/json
---
flatten(arrayOne ++ arrayTwo ++ arrayThree)..*fruit
```

Output JSON:

```json
[
  "orange",
  "apple",
  "grape",
  "kiwi",
  "strawberry",
  "plum",
  "banana",
  "watermelon",
  "cantaloupe",
  "honeydew",
  "cherry"
]
```

## Flatten Subarrays into the Parent Array

This example shows how the `flatten` function acts on a variety of data types, including numbers,
DataWeave objects, subarrays, a string, a `null` value, and and a key-value pair. Notice that
elements of the subarrays become elements of the parent array, and the subarrays are no longer
present.

The example uses this function:

- `flatten` to flatten the subarrays into their parent arrays.

DataWeave Script:

```dataweave
%dw 2.0
var myArray = [
                 1,
                 [2,3],
                 { a : "b"},
                 "my string",
                 [ [4,5], { c : "d"}, 6 ],
                 null,
                 "e" : "f"
              ]
output application/json
---
flatten(myArray)
```

Output JSON:

```json
[
  1,
  2,
  3,
  {
    "a": "b"
  },
  "my string",
  [4, 5],
  {
    "c": "d"
  },
  6,
  null,
  {
    "e": "f"
  }
]
```

## See Also

- [flatten](https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-flatten)

- [Define a Function That Flattens Data in a List](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-define-function-to-flatten-list)

- [Selectors](https://docs.mulesoft.com/dataweave/2.11/dataweave-selectors)

<!-- document id=300f7d0dd2ce31ac2e8776550f1740bd741fc8ea5910ce89b1165289d2c8342e url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook-flatten-arrays.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Flatten Elements of Arrays

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave can flatten subarrays of an array and collections of key-value pairs within DataWeave
objects, arrays, and subarrays.

## Flatten Subarrays with Key-Value Pairs into an Array of Objects

This example shows how `flatten` acts on key-value pairs of the input array defined by the variable
`arrayOne`. Notice that every key-value pair in the array becomes a separate DataWeave object.

The example uses this function:

- `flatten` to move the elements from the subarrays to the parent array, eliminate the subarrays,
  and covert all key-value pairs into a list of objects within the parent array.

DataWeave Script:

```dataweave
%dw 2.0
var arrayOne = [
                 [
                    "keyOne" : 1,
                    "keyTwo" : 2
                 ],
                 [
                    "keyThree" : 3,
                    "keyFour" : 4,
                    "keyFive" : 5
                 ],
                 "keySix" : 6
               ]
output application/json
---
flatten(arrayOne)
```

Output JSON:

```json
[
  {
    "keyOne": 1
  },
  {
    "keyTwo": 2
  },
  {
    "keyThree": 3
  },
  {
    "keyFour": 4
  },
  {
    "keyFive": 5
  },
  {
    "keySix": 6
  }
]
```

## Flatten Combined Arrays

Like the previous DataWeave example, the following returns an array that combines and flattens the
elements from two arrays. This second example applies the selector `fruit` to select only the values
of the key `fruit` and to exclude other values in the array.

This example uses:

- `++` to combine the objects of two arrays (`arrayOne` and `arrayTwo`) into a single array.

- `flatten` to flatten the combined array into a list of key-value pairs.

DataWeave Script:

```dataweave
%dw 2.0
var arrayOne = [
                  [
                     "fruit" : "orange",
                     "fruit" : "apple"
                  ],
                  [
                     "fruit" : "grape",
                     "notfruit" : "something else"
                  ]
               ]
var arrayTwo = [
                  [
                  	{  "fruit" : "kiwi" }
                  ],
                  "fruit" : "strawberry",
                  "fruit" : "plum",
                  { "fruit" : "banana" },
                  "notfruit" : "something else"
               ]
output application/json
---
flatten(arrayOne ++ arrayTwo)
```

Output JSON:

```json
[
  { "fruit": "orange" },
  { "fruit": "apple" },
  { "fruit": "grape" },
  { "notfruit": "something else" },
  { "fruit": "kiwi" },
  { "fruit": "strawberry" },
  { "fruit": "plum" },
  { "fruit": "banana" },
  { "notfruit": "something else" }
]
```

The only difference between the [previous example](#ex02) and the following example is the addition
of the `.fruit` selector to the body expression to select all the `fruit` values and to exclude
values of the `notfruit` keys from the output array.

DataWeave Script:

```dataweave
%dw 2.0
var arrayOne = [
                  [
                     "fruit" : "orange",
                     "fruit" : "apple"
                  ],
                  [
                     "fruit" : "grape",
                     "notfruit" : "something else"
                  ]
               ]
var arrayTwo = [
                  [
                  	{  "fruit" : "kiwi" }
                  ],
                  "fruit" : "strawberry",
                  "fruit" : "plum",
                  { "fruit" : "banana" },
                  "notfruit" : "something else"
               ]
output application/json
---
flatten(arrayOne ++ arrayTwo).fruit
```

Output JSON:

```json
["orange", "apple", "grape", "kiwi", "strawberry", "plum", "banana"]
```

The next example uses `..*fruit` as a selector in the body expression instead of `.fruit` to return
all nested `fruit` values in the flattened array. It also flattens three combined arrays instead of
two.

DataWeave Script:

```dataweave
%dw 2.0
var arrayOne = [
                  [
                     "fruit" : "orange",
                     "fruit" : "apple"
                  ],
                  [
                     "fruit" : "grape",
                     "notfruit" : "something else"
                  ]
               ]
var arrayTwo = [
                  [
                  	{  "fruit" : "kiwi" }
                  ],
                  "fruit" : "strawberry",
                  "fruit" : "plum",
                  { "fruit" : "banana" },
                  "notfruit" : "something else"
               ]
var arrayThree = [
                    { parentOne :
                        [
                     	     { child :
                     	       [
                     	         { grandchild :
                                   {
                                      "fruit" : "watermelon",
                                      "notfruit" : "something else"
                                   }
                                },
                                {
                                   fruit : "cantaloupe",
                                   "notfruit" : "something else"
                                }
                             ]
                           },
                           {
                              fruit : "honeydew",
                              "notfruit" : "something else"
                           }
                        ]
                    },
                    { parentTwo:
                     	  [
                     	  	 fruit : "cherry",
                     		   "notfruit" : "something else"
                     	  ]
                    }
                 ]
output application/json
---
flatten(arrayOne ++ arrayTwo ++ arrayThree)..*fruit
```

Output JSON:

```json
[
  "orange",
  "apple",
  "grape",
  "kiwi",
  "strawberry",
  "plum",
  "banana",
  "watermelon",
  "cantaloupe",
  "honeydew",
  "cherry"
]
```

## Flatten Subarrays into the Parent Array

This example shows how the `flatten` function acts on a variety of data types, including numbers,
DataWeave objects, subarrays, a string, a `null` value, and and a key-value pair. Notice that
elements of the subarrays become elements of the parent array, and the subarrays are no longer
present.

The example uses this function:

- `flatten` to flatten the subarrays into their parent arrays.

DataWeave Script:

```dataweave
%dw 2.0
var myArray = [
                 1,
                 [2,3],
                 { a : "b"},
                 "my string",
                 [ [4,5], { c : "d"}, 6 ],
                 null,
                 "e" : "f"
              ]
output application/json
---
flatten(myArray)
```

Output JSON:

```json
[
  1,
  2,
  3,
  {
    "a": "b"
  },
  "my string",
  [4, 5],
  {
    "c": "d"
  },
  6,
  null,
  {
    "e": "f"
  }
]
```

## See Also

- [flatten](https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-flatten)

- [Define a Function That Flattens Data in a List](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-define-function-to-flatten-list)

- [Selectors](https://docs.mulesoft.com/dataweave/2.12/dataweave-selectors)

<!-- document id=4351039bbb922f3f21bf982ec6ea3427c0c7dd1808d57673b92dcd1cacc0377f url=/mulesoft/current/en-us/dataweave/2.3/dataweave-cookbook-flatten-arrays.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Flatten Elements of Arrays

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave can flatten subarrays of an array and collections of key-value pairs within DataWeave
objects, arrays, and subarrays.

## Flatten Subarrays with Key-Value Pairs into an Array of Objects

This example shows how `flatten` acts on key-value pairs of the input array defined by the variable
`arrayOne`. Notice that every key-value pair in the array becomes a separate DataWeave object.

The example uses this function:

- `flatten` to move the elements from the subarrays to the parent array, eliminate the subarrays,
  and covert all key-value pairs into a list of objects within the parent array.

DataWeave Script:

```dataweave
%dw 2.0
var arrayOne = [
                 [
                    "keyOne" : 1,
                    "keyTwo" : 2
                 ],
                 [
                    "keyThree" : 3,
                    "keyFour" : 4,
                    "keyFive" : 5
                 ],
                 "keySix" : 6
               ]
output application/json
---
flatten(arrayOne)
```

Output JSON:

```json
[
  {
    "keyOne": 1
  },
  {
    "keyTwo": 2
  },
  {
    "keyThree": 3
  },
  {
    "keyFour": 4
  },
  {
    "keyFive": 5
  },
  {
    "keySix": 6
  }
]
```

## Flatten Combined Arrays

Like the previous DataWeave example, the following returns an array that combines and flattens the
elements from two arrays. This second example applies the selector `fruit` to select only the values
of the key `fruit` and to exclude other values in the array.

This example uses:

- `++` to combine the objects of two arrays (`arrayOne` and `arrayTwo`) into a single array.

- `flatten` to flatten the combined array into a list of key-value pairs.

DataWeave Script:

```dataweave
%dw 2.0
var arrayOne = [
                  [
                     "fruit" : "orange",
                     "fruit" : "apple"
                  ],
                  [
                     "fruit" : "grape",
                     "notfruit" : "something else"
                  ]
               ]
var arrayTwo = [
                  [
                  	{  "fruit" : "kiwi" }
                  ],
                  "fruit" : "strawberry",
                  "fruit" : "plum",
                  { "fruit" : "banana" },
                  "notfruit" : "something else"
               ]
output application/json
---
flatten(arrayOne ++ arrayTwo)
```

Output JSON:

```json
[
  { "fruit": "orange" },
  { "fruit": "apple" },
  { "fruit": "grape" },
  { "notfruit": "something else" },
  { "fruit": "kiwi" },
  { "fruit": "strawberry" },
  { "fruit": "plum" },
  { "fruit": "banana" },
  { "notfruit": "something else" }
]
```

The only difference between the [previous example](#ex02) and the following example is the addition
of the `.fruit` selector to the body expression to select all the `fruit` values and to exclude
values of the `notfruit` keys from the output array.

DataWeave Script:

```dataweave
%dw 2.0
var arrayOne = [
                  [
                     "fruit" : "orange",
                     "fruit" : "apple"
                  ],
                  [
                     "fruit" : "grape",
                     "notfruit" : "something else"
                  ]
               ]
var arrayTwo = [
                  [
                  	{  "fruit" : "kiwi" }
                  ],
                  "fruit" : "strawberry",
                  "fruit" : "plum",
                  { "fruit" : "banana" },
                  "notfruit" : "something else"
               ]
output application/json
---
flatten(arrayOne ++ arrayTwo).fruit
```

Output JSON:

```json
["orange", "apple", "grape", "kiwi", "strawberry", "plum", "banana"]
```

The next example uses `..*fruit` as a selector in the body expression instead of `.fruit` to return
all nested `fruit` values in the flattened array. It also flattens three combined arrays instead of
two.

DataWeave Script:

```dataweave
%dw 2.0
var arrayOne = [
                  [
                     "fruit" : "orange",
                     "fruit" : "apple"
                  ],
                  [
                     "fruit" : "grape",
                     "notfruit" : "something else"
                  ]
               ]
var arrayTwo = [
                  [
                  	{  "fruit" : "kiwi" }
                  ],
                  "fruit" : "strawberry",
                  "fruit" : "plum",
                  { "fruit" : "banana" },
                  "notfruit" : "something else"
               ]
var arrayThree = [
                    { parentOne :
                        [
                     	     { child :
                     	       [
                     	         { grandchild :
                                   {
                                      "fruit" : "watermelon",
                                      "notfruit" : "something else"
                                   }
                                },
                                {
                                   fruit : "cantaloupe",
                                   "notfruit" : "something else"
                                }
                             ]
                           },
                           {
                              fruit : "honeydew",
                              "notfruit" : "something else"
                           }
                        ]
                    },
                    { parentTwo:
                     	  [
                     	  	 fruit : "cherry",
                     		   "notfruit" : "something else"
                     	  ]
                    }
                 ]
output application/json
---
flatten(arrayOne ++ arrayTwo ++ arrayThree)..*fruit
```

Output JSON:

```json
[
  "orange",
  "apple",
  "grape",
  "kiwi",
  "strawberry",
  "plum",
  "banana",
  "watermelon",
  "cantaloupe",
  "honeydew",
  "cherry"
]
```

## Flatten Subarrays into the Parent Array

This example shows how the `flatten` function acts on a variety of data types, including numbers,
DataWeave objects, subarrays, a string, a `null` value, and and a key-value pair. Notice that
elements of the subarrays become elements of the parent array, and the subarrays are no longer
present.

The example uses this function:

- `flatten` to flatten the subarrays into their parent arrays.

DataWeave Script:

```dataweave
%dw 2.0
var myArray = [
                 1,
                 [2,3],
                 { a : "b"},
                 "my string",
                 [ [4,5], { c : "d"}, 6 ],
                 null,
                 "e" : "f"
              ]
output application/json
---
flatten(myArray)
```

Output JSON:

```json
[
  1,
  2,
  3,
  {
    "a": "b"
  },
  "my string",
  [4, 5],
  {
    "c": "d"
  },
  6,
  null,
  {
    "e": "f"
  }
]
```

## See Also

- [flatten](https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-flatten)

- [Define a Function That Flattens Data in a List](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-define-function-to-flatten-list)

- [Selectors](https://docs.mulesoft.com/dataweave/2.3/dataweave-selectors)

<!-- document id=a799e299694de5f1c8acc5f6661eb40a4fc0f12b1da61ae2c0aa3a77e3eebc98 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook-flatten-arrays.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Flatten Elements of Arrays

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave can flatten subarrays of an array and collections of key-value pairs within DataWeave
objects, arrays, and subarrays.

## Flatten Subarrays with Key-Value Pairs into an Array of Objects

This example shows how `flatten` acts on key-value pairs of the input array defined by the variable
`arrayOne`. Notice that every key-value pair in the array becomes a separate DataWeave object.

The example uses this function:

- `flatten` to move the elements from the subarrays to the parent array, eliminate the subarrays,
  and covert all key-value pairs into a list of objects within the parent array.

DataWeave Script:

```dataweave
%dw 2.0
var arrayOne = [
                 [
                    "keyOne" : 1,
                    "keyTwo" : 2
                 ],
                 [
                    "keyThree" : 3,
                    "keyFour" : 4,
                    "keyFive" : 5
                 ],
                 "keySix" : 6
               ]
output application/json
---
flatten(arrayOne)
```

Output JSON:

```json
[
  {
    "keyOne": 1
  },
  {
    "keyTwo": 2
  },
  {
    "keyThree": 3
  },
  {
    "keyFour": 4
  },
  {
    "keyFive": 5
  },
  {
    "keySix": 6
  }
]
```

## Flatten Combined Arrays

Like the previous DataWeave example, the following returns an array that combines and flattens the
elements from two arrays. This second example applies the selector `fruit` to select only the values
of the key `fruit` and to exclude other values in the array.

This example uses:

- `++` to combine the objects of two arrays (`arrayOne` and `arrayTwo`) into a single array.

- `flatten` to flatten the combined array into a list of key-value pairs.

DataWeave Script:

```dataweave
%dw 2.0
var arrayOne = [
                  [
                     "fruit" : "orange",
                     "fruit" : "apple"
                  ],
                  [
                     "fruit" : "grape",
                     "notfruit" : "something else"
                  ]
               ]
var arrayTwo = [
                  [
                  	{  "fruit" : "kiwi" }
                  ],
                  "fruit" : "strawberry",
                  "fruit" : "plum",
                  { "fruit" : "banana" },
                  "notfruit" : "something else"
               ]
output application/json
---
flatten(arrayOne ++ arrayTwo)
```

Output JSON:

```json
[
  { "fruit": "orange" },
  { "fruit": "apple" },
  { "fruit": "grape" },
  { "notfruit": "something else" },
  { "fruit": "kiwi" },
  { "fruit": "strawberry" },
  { "fruit": "plum" },
  { "fruit": "banana" },
  { "notfruit": "something else" }
]
```

The only difference between the [previous example](#ex02) and the following example is the addition
of the `.fruit` selector to the body expression to select all the `fruit` values and to exclude
values of the `notfruit` keys from the output array.

DataWeave Script:

```dataweave
%dw 2.0
var arrayOne = [
                  [
                     "fruit" : "orange",
                     "fruit" : "apple"
                  ],
                  [
                     "fruit" : "grape",
                     "notfruit" : "something else"
                  ]
               ]
var arrayTwo = [
                  [
                  	{  "fruit" : "kiwi" }
                  ],
                  "fruit" : "strawberry",
                  "fruit" : "plum",
                  { "fruit" : "banana" },
                  "notfruit" : "something else"
               ]
output application/json
---
flatten(arrayOne ++ arrayTwo).fruit
```

Output JSON:

```json
["orange", "apple", "grape", "kiwi", "strawberry", "plum", "banana"]
```

The next example uses `..*fruit` as a selector in the body expression instead of `.fruit` to return
all nested `fruit` values in the flattened array. It also flattens three combined arrays instead of
two.

DataWeave Script:

```dataweave
%dw 2.0
var arrayOne = [
                  [
                     "fruit" : "orange",
                     "fruit" : "apple"
                  ],
                  [
                     "fruit" : "grape",
                     "notfruit" : "something else"
                  ]
               ]
var arrayTwo = [
                  [
                  	{  "fruit" : "kiwi" }
                  ],
                  "fruit" : "strawberry",
                  "fruit" : "plum",
                  { "fruit" : "banana" },
                  "notfruit" : "something else"
               ]
var arrayThree = [
                    { parentOne :
                        [
                     	     { child :
                     	       [
                     	         { grandchild :
                                   {
                                      "fruit" : "watermelon",
                                      "notfruit" : "something else"
                                   }
                                },
                                {
                                   fruit : "cantaloupe",
                                   "notfruit" : "something else"
                                }
                             ]
                           },
                           {
                              fruit : "honeydew",
                              "notfruit" : "something else"
                           }
                        ]
                    },
                    { parentTwo:
                     	  [
                     	  	 fruit : "cherry",
                     		   "notfruit" : "something else"
                     	  ]
                    }
                 ]
output application/json
---
flatten(arrayOne ++ arrayTwo ++ arrayThree)..*fruit
```

Output JSON:

```json
[
  "orange",
  "apple",
  "grape",
  "kiwi",
  "strawberry",
  "plum",
  "banana",
  "watermelon",
  "cantaloupe",
  "honeydew",
  "cherry"
]
```

## Flatten Subarrays into the Parent Array

This example shows how the `flatten` function acts on a variety of data types, including numbers,
DataWeave objects, subarrays, a string, a `null` value, and and a key-value pair. Notice that
elements of the subarrays become elements of the parent array, and the subarrays are no longer
present.

The example uses this function:

- `flatten` to flatten the subarrays into their parent arrays.

DataWeave Script:

```dataweave
%dw 2.0
var myArray = [
                 1,
                 [2,3],
                 { a : "b"},
                 "my string",
                 [ [4,5], { c : "d"}, 6 ],
                 null,
                 "e" : "f"
              ]
output application/json
---
flatten(myArray)
```

Output JSON:

```json
[
  1,
  2,
  3,
  {
    "a": "b"
  },
  "my string",
  [4, 5],
  {
    "c": "d"
  },
  6,
  null,
  {
    "e": "f"
  }
]
```

## See Also

- [flatten](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-flatten)

- [Define a Function That Flattens Data in a List](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-define-function-to-flatten-list)

- [Selectors](https://docs.mulesoft.com/dataweave/2.4/dataweave-selectors)

<!-- document id=c277015eaf796245a2a68f8060ff6b9b6f234a16170a9580e96d4f6d34990dae url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook-flatten-arrays.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Flatten Elements of Arrays

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave can flatten subarrays of an array and collections of key-value pairs within DataWeave
objects, arrays, and subarrays.

## Flatten Subarrays with Key-Value Pairs into an Array of Objects

This example shows how `flatten` acts on key-value pairs of the input array defined by the variable
`arrayOne`. Notice that every key-value pair in the array becomes a separate DataWeave object.

The example uses this function:

- `flatten` to move the elements from the subarrays to the parent array, eliminate the subarrays,
  and covert all key-value pairs into a list of objects within the parent array.

DataWeave Script:

```dataweave
%dw 2.0
var arrayOne = [
                 [
                    "keyOne" : 1,
                    "keyTwo" : 2
                 ],
                 [
                    "keyThree" : 3,
                    "keyFour" : 4,
                    "keyFive" : 5
                 ],
                 "keySix" : 6
               ]
output application/json
---
flatten(arrayOne)
```

Output JSON:

```json
[
  {
    "keyOne": 1
  },
  {
    "keyTwo": 2
  },
  {
    "keyThree": 3
  },
  {
    "keyFour": 4
  },
  {
    "keyFive": 5
  },
  {
    "keySix": 6
  }
]
```

## Flatten Combined Arrays

Like the previous DataWeave example, the following returns an array that combines and flattens the
elements from two arrays. This second example applies the selector `fruit` to select only the values
of the key `fruit` and to exclude other values in the array.

This example uses:

- `++` to combine the objects of two arrays (`arrayOne` and `arrayTwo`) into a single array.

- `flatten` to flatten the combined array into a list of key-value pairs.

DataWeave Script:

```dataweave
%dw 2.0
var arrayOne = [
                  [
                     "fruit" : "orange",
                     "fruit" : "apple"
                  ],
                  [
                     "fruit" : "grape",
                     "notfruit" : "something else"
                  ]
               ]
var arrayTwo = [
                  [
                  	{  "fruit" : "kiwi" }
                  ],
                  "fruit" : "strawberry",
                  "fruit" : "plum",
                  { "fruit" : "banana" },
                  "notfruit" : "something else"
               ]
output application/json
---
flatten(arrayOne ++ arrayTwo)
```

Output JSON:

```json
[
  { "fruit": "orange" },
  { "fruit": "apple" },
  { "fruit": "grape" },
  { "notfruit": "something else" },
  { "fruit": "kiwi" },
  { "fruit": "strawberry" },
  { "fruit": "plum" },
  { "fruit": "banana" },
  { "notfruit": "something else" }
]
```

The only difference between the [previous example](#ex02) and the following example is the addition
of the `.fruit` selector to the body expression to select all the `fruit` values and to exclude
values of the `notfruit` keys from the output array.

DataWeave Script:

```dataweave
%dw 2.0
var arrayOne = [
                  [
                     "fruit" : "orange",
                     "fruit" : "apple"
                  ],
                  [
                     "fruit" : "grape",
                     "notfruit" : "something else"
                  ]
               ]
var arrayTwo = [
                  [
                  	{  "fruit" : "kiwi" }
                  ],
                  "fruit" : "strawberry",
                  "fruit" : "plum",
                  { "fruit" : "banana" },
                  "notfruit" : "something else"
               ]
output application/json
---
flatten(arrayOne ++ arrayTwo).fruit
```

Output JSON:

```json
["orange", "apple", "grape", "kiwi", "strawberry", "plum", "banana"]
```

The next example uses `..*fruit` as a selector in the body expression instead of `.fruit` to return
all nested `fruit` values in the flattened array. It also flattens three combined arrays instead of
two.

DataWeave Script:

```dataweave
%dw 2.0
var arrayOne = [
                  [
                     "fruit" : "orange",
                     "fruit" : "apple"
                  ],
                  [
                     "fruit" : "grape",
                     "notfruit" : "something else"
                  ]
               ]
var arrayTwo = [
                  [
                  	{  "fruit" : "kiwi" }
                  ],
                  "fruit" : "strawberry",
                  "fruit" : "plum",
                  { "fruit" : "banana" },
                  "notfruit" : "something else"
               ]
var arrayThree = [
                    { parentOne :
                        [
                     	     { child :
                     	       [
                     	         { grandchild :
                                   {
                                      "fruit" : "watermelon",
                                      "notfruit" : "something else"
                                   }
                                },
                                {
                                   fruit : "cantaloupe",
                                   "notfruit" : "something else"
                                }
                             ]
                           },
                           {
                              fruit : "honeydew",
                              "notfruit" : "something else"
                           }
                        ]
                    },
                    { parentTwo:
                     	  [
                     	  	 fruit : "cherry",
                     		   "notfruit" : "something else"
                     	  ]
                    }
                 ]
output application/json
---
flatten(arrayOne ++ arrayTwo ++ arrayThree)..*fruit
```

Output JSON:

```json
[
  "orange",
  "apple",
  "grape",
  "kiwi",
  "strawberry",
  "plum",
  "banana",
  "watermelon",
  "cantaloupe",
  "honeydew",
  "cherry"
]
```

## Flatten Subarrays into the Parent Array

This example shows how the `flatten` function acts on a variety of data types, including numbers,
DataWeave objects, subarrays, a string, a `null` value, and and a key-value pair. Notice that
elements of the subarrays become elements of the parent array, and the subarrays are no longer
present.

The example uses this function:

- `flatten` to flatten the subarrays into their parent arrays.

DataWeave Script:

```dataweave
%dw 2.0
var myArray = [
                 1,
                 [2,3],
                 { a : "b"},
                 "my string",
                 [ [4,5], { c : "d"}, 6 ],
                 null,
                 "e" : "f"
              ]
output application/json
---
flatten(myArray)
```

Output JSON:

```json
[
  1,
  2,
  3,
  {
    "a": "b"
  },
  "my string",
  [4, 5],
  {
    "c": "d"
  },
  6,
  null,
  {
    "e": "f"
  }
]
```

## See Also

- [flatten](https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-flatten)

- [Define a Function That Flattens Data in a List](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-define-function-to-flatten-list)

- [Selectors](https://docs.mulesoft.com/dataweave/2.6/dataweave-selectors)

<!-- document id=7fac7fc11bda01c4a0b9df631effd241e8a500d580527953bcdb9f81db78e0c3 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook-flatten-arrays.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Flatten Elements of Arrays

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave can flatten subarrays of an array and collections of key-value pairs within DataWeave
objects, arrays, and subarrays.

## Flatten Subarrays with Key-Value Pairs into an Array of Objects

This example shows how `flatten` acts on key-value pairs of the input array defined by the variable
`arrayOne`. Notice that every key-value pair in the array becomes a separate DataWeave object.

The example uses this function:

- `flatten` to move the elements from the subarrays to the parent array, eliminate the subarrays,
  and covert all key-value pairs into a list of objects within the parent array.

DataWeave Script:

```dataweave
%dw 2.0
var arrayOne = [
                 [
                    "keyOne" : 1,
                    "keyTwo" : 2
                 ],
                 [
                    "keyThree" : 3,
                    "keyFour" : 4,
                    "keyFive" : 5
                 ],
                 "keySix" : 6
               ]
output application/json
---
flatten(arrayOne)
```

Output JSON:

```json
[
  {
    "keyOne": 1
  },
  {
    "keyTwo": 2
  },
  {
    "keyThree": 3
  },
  {
    "keyFour": 4
  },
  {
    "keyFive": 5
  },
  {
    "keySix": 6
  }
]
```

## Flatten Combined Arrays

Like the previous DataWeave example, the following returns an array that combines and flattens the
elements from two arrays. This second example applies the selector `fruit` to select only the values
of the key `fruit` and to exclude other values in the array.

This example uses:

- `++` to combine the objects of two arrays (`arrayOne` and `arrayTwo`) into a single array.

- `flatten` to flatten the combined array into a list of key-value pairs.

DataWeave Script:

```dataweave
%dw 2.0
var arrayOne = [
                  [
                     "fruit" : "orange",
                     "fruit" : "apple"
                  ],
                  [
                     "fruit" : "grape",
                     "notfruit" : "something else"
                  ]
               ]
var arrayTwo = [
                  [
                  	{  "fruit" : "kiwi" }
                  ],
                  "fruit" : "strawberry",
                  "fruit" : "plum",
                  { "fruit" : "banana" },
                  "notfruit" : "something else"
               ]
output application/json
---
flatten(arrayOne ++ arrayTwo)
```

Output JSON:

```json
[
  { "fruit": "orange" },
  { "fruit": "apple" },
  { "fruit": "grape" },
  { "notfruit": "something else" },
  { "fruit": "kiwi" },
  { "fruit": "strawberry" },
  { "fruit": "plum" },
  { "fruit": "banana" },
  { "notfruit": "something else" }
]
```

The only difference between the [previous example](#ex02) and the following example is the addition
of the `.fruit` selector to the body expression to select all the `fruit` values and to exclude
values of the `notfruit` keys from the output array.

DataWeave Script:

```dataweave
%dw 2.0
var arrayOne = [
                  [
                     "fruit" : "orange",
                     "fruit" : "apple"
                  ],
                  [
                     "fruit" : "grape",
                     "notfruit" : "something else"
                  ]
               ]
var arrayTwo = [
                  [
                  	{  "fruit" : "kiwi" }
                  ],
                  "fruit" : "strawberry",
                  "fruit" : "plum",
                  { "fruit" : "banana" },
                  "notfruit" : "something else"
               ]
output application/json
---
flatten(arrayOne ++ arrayTwo).fruit
```

Output JSON:

```json
["orange", "apple", "grape", "kiwi", "strawberry", "plum", "banana"]
```

The next example uses `..*fruit` as a selector in the body expression instead of `.fruit` to return
all nested `fruit` values in the flattened array. It also flattens three combined arrays instead of
two.

DataWeave Script:

```dataweave
%dw 2.0
var arrayOne = [
                  [
                     "fruit" : "orange",
                     "fruit" : "apple"
                  ],
                  [
                     "fruit" : "grape",
                     "notfruit" : "something else"
                  ]
               ]
var arrayTwo = [
                  [
                  	{  "fruit" : "kiwi" }
                  ],
                  "fruit" : "strawberry",
                  "fruit" : "plum",
                  { "fruit" : "banana" },
                  "notfruit" : "something else"
               ]
var arrayThree = [
                    { parentOne :
                        [
                     	     { child :
                     	       [
                     	         { grandchild :
                                   {
                                      "fruit" : "watermelon",
                                      "notfruit" : "something else"
                                   }
                                },
                                {
                                   fruit : "cantaloupe",
                                   "notfruit" : "something else"
                                }
                             ]
                           },
                           {
                              fruit : "honeydew",
                              "notfruit" : "something else"
                           }
                        ]
                    },
                    { parentTwo:
                     	  [
                     	  	 fruit : "cherry",
                     		   "notfruit" : "something else"
                     	  ]
                    }
                 ]
output application/json
---
flatten(arrayOne ++ arrayTwo ++ arrayThree)..*fruit
```

Output JSON:

```json
[
  "orange",
  "apple",
  "grape",
  "kiwi",
  "strawberry",
  "plum",
  "banana",
  "watermelon",
  "cantaloupe",
  "honeydew",
  "cherry"
]
```

## Flatten Subarrays into the Parent Array

This example shows how the `flatten` function acts on a variety of data types, including numbers,
DataWeave objects, subarrays, a string, a `null` value, and and a key-value pair. Notice that
elements of the subarrays become elements of the parent array, and the subarrays are no longer
present.

The example uses this function:

- `flatten` to flatten the subarrays into their parent arrays.

DataWeave Script:

```dataweave
%dw 2.0
var myArray = [
                 1,
                 [2,3],
                 { a : "b"},
                 "my string",
                 [ [4,5], { c : "d"}, 6 ],
                 null,
                 "e" : "f"
              ]
output application/json
---
flatten(myArray)
```

Output JSON:

```json
[
  1,
  2,
  3,
  {
    "a": "b"
  },
  "my string",
  [4, 5],
  {
    "c": "d"
  },
  6,
  null,
  {
    "e": "f"
  }
]
```

## See Also

- [flatten](https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-flatten)

- [Define a Function That Flattens Data in a List](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-define-function-to-flatten-list)

- [Selectors](https://docs.mulesoft.com/dataweave/2.9/dataweave-selectors)

<!-- document id=9429f115be97be8e5d8bc70112ed283afdcbd4a046eb90cda5616d73830581f7 url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook-flatten-arrays.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Flatten Elements of Arrays

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave can flatten subarrays of an array and collections of key-value pairs within DataWeave
objects, arrays, and subarrays.

## Flatten Subarrays with Key-Value Pairs into an Array of Objects

This example shows how `flatten` acts on key-value pairs of the input array defined by the variable
`arrayOne`. Notice that every key-value pair in the array becomes a separate DataWeave object.

The example uses this function:

- `flatten` to move the elements from the subarrays to the parent array, eliminate the subarrays,
  and covert all key-value pairs into a list of objects within the parent array.

DataWeave Script:

```dataweave
%dw 2.0
var arrayOne = [
                 [
                    "keyOne" : 1,
                    "keyTwo" : 2
                 ],
                 [
                    "keyThree" : 3,
                    "keyFour" : 4,
                    "keyFive" : 5
                 ],
                 "keySix" : 6
               ]
output application/json
---
flatten(arrayOne)
```

Output JSON:

```json
[
  {
    "keyOne": 1
  },
  {
    "keyTwo": 2
  },
  {
    "keyThree": 3
  },
  {
    "keyFour": 4
  },
  {
    "keyFive": 5
  },
  {
    "keySix": 6
  }
]
```

## Flatten Combined Arrays

Like the previous DataWeave example, the following returns an array that combines and flattens the
elements from two arrays. This second example applies the selector `fruit` to select only the values
of the key `fruit` and to exclude other values in the array.

This example uses:

- `++` to combine the objects of two arrays (`arrayOne` and `arrayTwo`) into a single array.

- `flatten` to flatten the combined array into a list of key-value pairs.

DataWeave Script:

```dataweave
%dw 2.0
var arrayOne = [
                  [
                     "fruit" : "orange",
                     "fruit" : "apple"
                  ],
                  [
                     "fruit" : "grape",
                     "notfruit" : "something else"
                  ]
               ]
var arrayTwo = [
                  [
                  	{  "fruit" : "kiwi" }
                  ],
                  "fruit" : "strawberry",
                  "fruit" : "plum",
                  { "fruit" : "banana" },
                  "notfruit" : "something else"
               ]
output application/json
---
flatten(arrayOne ++ arrayTwo)
```

Output JSON:

```json
[
  { "fruit": "orange" },
  { "fruit": "apple" },
  { "fruit": "grape" },
  { "notfruit": "something else" },
  { "fruit": "kiwi" },
  { "fruit": "strawberry" },
  { "fruit": "plum" },
  { "fruit": "banana" },
  { "notfruit": "something else" }
]
```

The only difference between the [previous example](#ex02) and the following example is the addition
of the `.fruit` selector to the body expression to select all the `fruit` values and to exclude
values of the `notfruit` keys from the output array.

DataWeave Script:

```dataweave
%dw 2.0
var arrayOne = [
                  [
                     "fruit" : "orange",
                     "fruit" : "apple"
                  ],
                  [
                     "fruit" : "grape",
                     "notfruit" : "something else"
                  ]
               ]
var arrayTwo = [
                  [
                  	{  "fruit" : "kiwi" }
                  ],
                  "fruit" : "strawberry",
                  "fruit" : "plum",
                  { "fruit" : "banana" },
                  "notfruit" : "something else"
               ]
output application/json
---
flatten(arrayOne ++ arrayTwo).fruit
```

Output JSON:

```json
["orange", "apple", "grape", "kiwi", "strawberry", "plum", "banana"]
```

The next example uses `..*fruit` as a selector in the body expression instead of `.fruit` to return
all nested `fruit` values in the flattened array. It also flattens three combined arrays instead of
two.

DataWeave Script:

```dataweave
%dw 2.0
var arrayOne = [
                  [
                     "fruit" : "orange",
                     "fruit" : "apple"
                  ],
                  [
                     "fruit" : "grape",
                     "notfruit" : "something else"
                  ]
               ]
var arrayTwo = [
                  [
                  	{  "fruit" : "kiwi" }
                  ],
                  "fruit" : "strawberry",
                  "fruit" : "plum",
                  { "fruit" : "banana" },
                  "notfruit" : "something else"
               ]
var arrayThree = [
                    { parentOne :
                        [
                     	     { child :
                     	       [
                     	         { grandchild :
                                   {
                                      "fruit" : "watermelon",
                                      "notfruit" : "something else"
                                   }
                                },
                                {
                                   fruit : "cantaloupe",
                                   "notfruit" : "something else"
                                }
                             ]
                           },
                           {
                              fruit : "honeydew",
                              "notfruit" : "something else"
                           }
                        ]
                    },
                    { parentTwo:
                     	  [
                     	  	 fruit : "cherry",
                     		   "notfruit" : "something else"
                     	  ]
                    }
                 ]
output application/json
---
flatten(arrayOne ++ arrayTwo ++ arrayThree)..*fruit
```

Output JSON:

```json
[
  "orange",
  "apple",
  "grape",
  "kiwi",
  "strawberry",
  "plum",
  "banana",
  "watermelon",
  "cantaloupe",
  "honeydew",
  "cherry"
]
```

## Flatten Subarrays into the Parent Array

This example shows how the `flatten` function acts on a variety of data types, including numbers,
DataWeave objects, subarrays, a string, a `null` value, and and a key-value pair. Notice that
elements of the subarrays become elements of the parent array, and the subarrays are no longer
present.

The example uses this function:

- `flatten` to flatten the subarrays into their parent arrays.

DataWeave Script:

```dataweave
%dw 2.0
var myArray = [
                 1,
                 [2,3],
                 { a : "b"},
                 "my string",
                 [ [4,5], { c : "d"}, 6 ],
                 null,
                 "e" : "f"
              ]
output application/json
---
flatten(myArray)
```

Output JSON:

```json
[
  1,
  2,
  3,
  {
    "a": "b"
  },
  "my string",
  [4, 5],
  {
    "c": "d"
  },
  6,
  null,
  {
    "e": "f"
  }
]
```

## See Also

- [flatten](https://docs.mulesoft.com/dataweave/latest/dw-core-functions-flatten)

- [Define a Function That Flattens Data in a List](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-define-function-to-flatten-list)

- [Selectors](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors)

<!-- document id=44231102f50171b09611e39bd909ddbacbc88700f0f4f0298628f987e13ceaf3 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-floor.md -->

---
product: DataWeave
version: 2.11
---

# floor

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## floor(number: Number): Number

Rounds a number down to the nearest whole number.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Example

This example rounds numbers down to the nearest whole numbers. Notice that `1.5` rounds down to `1`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ floor(1.5), floor(2.2), floor(3) ]
```

#### Output

```JSON
[ 1, 2, 3]
```

<!-- document id=803237820114e586014b37d4d15e168e009774465598770349539dbdef82298d url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-floor.md -->

---
product: DataWeave
version: 2.12
---

# floor

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## floor(number: Number): Number

Rounds a number down to the nearest whole number.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Example

This example rounds numbers down to the nearest whole numbers. Notice that `1.5` rounds down to `1`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ floor(1.5), floor(2.2), floor(3) ]
```

#### Output

```JSON
[ 1, 2, 3]
```

<!-- document id=d2c08790d8a5a02078290847505ebe1710e9b3d9256e08116ca860a6ceeb05f8 url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-floor.md -->

---
product: DataWeave
version: 2.3
---

# floor

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## floor(Number): Number

Rounds a number down to the nearest whole number.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Example

This example rounds numbers down to the nearest whole numbers. Notice that `1.5` rounds down to `1`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ floor(1.5), floor(2.2), floor(3) ]
```

#### Output

```JSON
[ 1, 2, 3]
```

<!-- document id=4f857aac17981ad32ff05e8416316a0e1c3de049abc4d8df7c212b8d76d7672d url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-floor.md -->

---
product: DataWeave
version: 2.4
---

# floor

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## floor(number: Number): Number

Rounds a number down to the nearest whole number.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Example

This example rounds numbers down to the nearest whole numbers. Notice that `1.5` rounds down to `1`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ floor(1.5), floor(2.2), floor(3) ]
```

#### Output

```JSON
[ 1, 2, 3]
```

<!-- document id=ac499cc9d65fbe6659dd5de2cae50d8b7ef6e33b69d0672c1b8b4134644b0e9c url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-floor.md -->

---
product: DataWeave
version: 2.6
---

# floor

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## floor(number: Number): Number

Rounds a number down to the nearest whole number.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Example

This example rounds numbers down to the nearest whole numbers. Notice that `1.5` rounds down to `1`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ floor(1.5), floor(2.2), floor(3) ]
```

#### Output

```JSON
[ 1, 2, 3]
```

<!-- document id=61a099b1d8a6ca1bde14fcde9b87fc25230a0d6254e97db509fd7d706e5b83a5 url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-floor.md -->

---
product: DataWeave
version: 2.9
---

# floor

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## floor(number: Number): Number

Rounds a number down to the nearest whole number.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Example

This example rounds numbers down to the nearest whole numbers. Notice that `1.5` rounds down to `1`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ floor(1.5), floor(2.2), floor(3) ]
```

#### Output

```JSON
[ 1, 2, 3]
```

<!-- document id=37d44f4b6063051ed3b1b6077457345ce99e514a573a954ac9b5ba5589ec99a7 url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-floor.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# floor

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## floor(number: Number): Number

Rounds a number down to the nearest whole number.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Example

This example rounds numbers down to the nearest whole numbers. Notice that `1.5` rounds down to `1`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ floor(1.5), floor(2.2), floor(3) ]
```

#### Output

```JSON
[ 1, 2, 3]
```

<!-- document id=4c1ab1862348d5b27e266e63db06802d387027f68950aadc964dfbff7dcd0126 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-flow-control.md -->

---
product: DataWeave
version: 2.11
---

# Flow Control and Scope Operations in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You can use the following operators within any DataWeave expression:

- [`do`](#control_flow_do)

- [`if else`](#control_flow_if_else)

- [`else if`](#control_flow_else_if)

## `do`

A `do` statement creates a scope in which new variables, functions, annotations, or namespaces can
be declared and used. The syntax is similar to a mapping in that it is composed of a header and body
separated by `---`. Its header is where all the declarations are defined, and its body is the result
of the expression.

This example uses `do` to return the string `"DataWeave"` when `myfun()` is called from the main
body of the script.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
fun myfun() = do {
    var name = "DataWeave"
    ---
    name
}
---
{ result: myfun() }
```

This example uses `do` to return the string `"DataWeave"` when the variable `myVar` is referenced
from the main body of the script.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
var myVar = do {
    var name = "DataWeave"
    ---
    name
}
---
{ result: myVar }
```

Both scripts produce this output:

Output:

```json
{
  "result": "DataWeave"
}
```

The next example uses `do` to prepend the string `"Foo"` to a string (`" Bar"`) that is passed to
the `test(p: String)` function.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
fun test(p: String) = do {
    var a = "Foo" ++ p
    ---
    a
}
---
{ result: test(" Bar") }
```

Output:

```json
{
  "result": "Foo Bar"
}
```

See also, [Examples: Local DataWeave Variables](https://docs.mulesoft.com/dataweave/2.11/dataweave-variables#example_local_variable).

## `if else`

An `if` statement evaluates a conditional expression and returns the value under the `if` only if
the conditional expression returns `true`. Otherwise, it returns the expression under `else`. Every
`if` expression must have a matching `else` expression.

The following example uses the input `{ country : "FRANCE" }`, which is defined by the `myVar`
variable in the header:

DataWeave Script:

```dataweave
%dw 2.0
var myVar = { country : "FRANCE" }
output application/json
---
if (myVar.country == "USA")
  { currency: "USD" }
else { currency: "EUR" }
```

Output:

{ "currency": "EUR" }

You can use the if-else construct on any condition that evaluates to `true` or `false`, including
mathematical, logical, equality, and relational statements. The condition can act on any valid
input.

The next DataWeave script applies `if else` statements to the result of the following conditional
statements:

- A mathematical operation in `ex1`  
  The `if else` statement returns the Boolean value `true` if the operation `1 + 1 == 55` is true
  and `false` if not.

- An equality operation in `ex2`  
  The `if else` statement returns `1` if the value of the specified index is `1` or a string if the
  value is not `1`.

- An `isEmpty` function in `ex3`  
  The `if else` statement returns the string `"ID is empty"` or `"ID is not empty"` depending on
  whether `aRecord.bookId` contains a value.

- A mapping in `ex4` that iterates over `firstInput`  
  The `if else` statement returns the value of the `bookId` as a Number if the value is equal to
  `101`. It returns the specified string if the value is not equal to `101`.

DataWeave Script:

```dataweave
%dw 2.0
var aRecord =
 [
    "bookId":"101",
    "title":"world history",
    "price":"19.99"
 ]
output application/xml
---
{ examples:
	{
	   ex1 : if (1 + 1 == 55) true
	         else false,
	   ex2 : if ([1,2,3,4][1] == 1) 1
	         else "value of index 1 is not 1",
	   ex3 : if (isEmpty(aRecord.bookId)) "ID is empty"
	  	 else "ID is not empty",
	   ex4 : aRecord.bookId map (idValue) ->
	   	 if (idValue as Number == 101) idValue as Number
		 else "not 101"
	}
}
```

Output:

<?xml version='1.0' encoding='UTF-8'?>
<examples>
  <ex1>false</ex1>
  <ex2>value of index 1 is not 1</ex2>
  <ex3>ID is not empty</ex3>
  <ex4>101</ex4>
</examples>

Additional examples are available in [DataWeave Operators](https://docs.mulesoft.com/dataweave/2.11/dw-operators).

## `else if`

You can chain several `else` expressions together within an if-else construct by incorporating
`else if`. The following example uses the input `var myVar = { country : "UK" }`, which is defined
by the `myVar` variable in the header.

DataWeave Script:

```dataweave
%dw 2.0
var myVar = { country : "UK" }
output application/json
---
if (myVar.country =="USA")
	{ currency: "USD" }
else if (myVar.country =="UK")
	{ currency: "GBP" }
else { currency: "EUR" }
```

Output

{ "currency": "GBP" }

The following example is similar but takes an array as input instead of an object. The body of the
script uses `if else` and `else if` statements within a `do` operation to populate the value of the
`hello` variable.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
["Argentina", "USA", "Brazil"] map (country) -> do {
  var hello = if(country == "Argentina") "Hola"
   else if(country == "USA") "Hello"
   else if(country == "Brazil") "Ola"
   else "Sorry! We don't know $(country)'s language."
   ---
   "$(hello) DataWeave"
}
```

Output:

\[ "Hola DataWeave", "Hello DataWeave", "Ola DataWeave" \]

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.11/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.11/dataweave-selectors)

<!-- document id=b2c415fbbf0ec683141e11b4932e455af3fa2157dcc7bec26683fdba77b7e49b url=/mulesoft/current/en-us/dataweave/2.12/dataweave-flow-control.md -->

---
product: DataWeave
version: 2.12
---

# Flow Control and Scope Operations in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You can use the following operators within any DataWeave expression:

- [`do`](#control_flow_do)

- [`if else`](#control_flow_if_else)

- [`else if`](#control_flow_else_if)

## `do`

A `do` statement creates a scope in which new variables, functions, annotations, or namespaces can
be declared and used. The syntax is similar to a mapping in that it is composed of a header and body
separated by `---`. Its header is where all the declarations are defined, and its body is the result
of the expression.

This example uses `do` to return the string `"DataWeave"` when `myfun()` is called from the main
body of the script.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
fun myfun() = do {
    var name = "DataWeave"
    ---
    name
}
---
{ result: myfun() }
```

This example uses `do` to return the string `"DataWeave"` when the variable `myVar` is referenced
from the main body of the script.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
var myVar = do {
    var name = "DataWeave"
    ---
    name
}
---
{ result: myVar }
```

Both scripts produce this output:

Output:

```json
{
  "result": "DataWeave"
}
```

The next example uses `do` to prepend the string `"Foo"` to a string (`" Bar"`) that is passed to
the `test(p: String)` function.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
fun test(p: String) = do {
    var a = "Foo" ++ p
    ---
    a
}
---
{ result: test(" Bar") }
```

Output:

```json
{
  "result": "Foo Bar"
}
```

See also, [Examples: Local DataWeave Variables](https://docs.mulesoft.com/dataweave/2.12/dataweave-variables#example_local_variable).

## `if else`

An `if` statement evaluates a conditional expression and returns the value under the `if` only if
the conditional expression returns `true`. Otherwise, it returns the expression under `else`. Every
`if` expression must have a matching `else` expression.

The following example uses the input `{ country : "FRANCE" }`, which is defined by the `myVar`
variable in the header:

DataWeave Script:

```dataweave
%dw 2.0
var myVar = { country : "FRANCE" }
output application/json
---
if (myVar.country == "USA")
  { currency: "USD" }
else { currency: "EUR" }
```

Output:

{ "currency": "EUR" }

You can use the if-else construct on any condition that evaluates to `true` or `false`, including
mathematical, logical, equality, and relational statements. The condition can act on any valid
input.

The next DataWeave script applies `if else` statements to the result of the following conditional
statements:

- A mathematical operation in `ex1`  
  The `if else` statement returns the Boolean value `true` if the operation `1 + 1 == 55` is true
  and `false` if not.

- An equality operation in `ex2`  
  The `if else` statement returns `1` if the value of the specified index is `1` or a string if the
  value is not `1`.

- An `isEmpty` function in `ex3`  
  The `if else` statement returns the string `"ID is empty"` or `"ID is not empty"` depending on
  whether `aRecord.bookId` contains a value.

- A mapping in `ex4` that iterates over `firstInput`  
  The `if else` statement returns the value of the `bookId` as a Number if the value is equal to
  `101`. It returns the specified string if the value is not equal to `101`.

DataWeave Script:

```dataweave
%dw 2.0
var aRecord =
 [
    "bookId":"101",
    "title":"world history",
    "price":"19.99"
 ]
output application/xml
---
{ examples:
	{
	   ex1 : if (1 + 1 == 55) true
	         else false,
	   ex2 : if ([1,2,3,4][1] == 1) 1
	         else "value of index 1 is not 1",
	   ex3 : if (isEmpty(aRecord.bookId)) "ID is empty"
	  	 else "ID is not empty",
	   ex4 : aRecord.bookId map (idValue) ->
	   	 if (idValue as Number == 101) idValue as Number
		 else "not 101"
	}
}
```

Output:

<?xml version='1.0' encoding='UTF-8'?>
<examples>
  <ex1>false</ex1>
  <ex2>value of index 1 is not 1</ex2>
  <ex3>ID is not empty</ex3>
  <ex4>101</ex4>
</examples>

Additional examples are available in [DataWeave Operators](https://docs.mulesoft.com/dataweave/2.12/dw-operators).

## `else if`

You can chain several `else` expressions together within an if-else construct by incorporating
`else if`. The following example uses the input `var myVar = { country : "UK" }`, which is defined
by the `myVar` variable in the header.

DataWeave Script:

```dataweave
%dw 2.0
var myVar = { country : "UK" }
output application/json
---
if (myVar.country =="USA")
	{ currency: "USD" }
else if (myVar.country =="UK")
	{ currency: "GBP" }
else { currency: "EUR" }
```

Output

{ "currency": "GBP" }

The following example is similar but takes an array as input instead of an object. The body of the
script uses `if else` and `else if` statements within a `do` operation to populate the value of the
`hello` variable.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
["Argentina", "USA", "Brazil"] map (country) -> do {
  var hello = if(country == "Argentina") "Hola"
   else if(country == "USA") "Hello"
   else if(country == "Brazil") "Ola"
   else "Sorry! We don't know $(country)'s language."
   ---
   "$(hello) DataWeave"
}
```

Output:

\[ "Hola DataWeave", "Hello DataWeave", "Ola DataWeave" \]

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.12/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.12/dataweave-selectors)

<!-- document id=d50142df147bf60dd7fdb54765c12a1f67a905b73beb3f3f151e42d1d663b73e url=/mulesoft/current/en-us/dataweave/2.3/dataweave-flow-control.md -->

---
product: DataWeave
version: 2.3
---

# Flow Control and Scope Operations in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You can use the following operators within any DataWeave expression:

- [`do`](#control_flow_do)

- [`if else`](#control_flow_if_else)

- [`else if`](#control_flow_else_if)

## `do`

A `do` statement creates a scope in which new variables, functions, annotations, or namespaces can
be declared and used. The syntax is similar to a mapping in that it is composed of a header and body
separated by `---`. Its header is where all the declarations are defined, and its body is the result
of the expression.

This example uses `do` to return the string `"DataWeave"` when `myfun()` is called from the main
body of the script.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
fun myfun() = do {
    var name = "DataWeave"
    ---
    name
}
---
{ result: myfun() }
```

This example uses `do` to return the string `"DataWeave"` when the variable `myVar` is referenced
from the main body of the script.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
var myVar = do {
    var name = "DataWeave"
    ---
    name
}
---
{ result: myVar }
```

Both scripts produce this output:

Output:

```json
{
  "result": "DataWeave"
}
```

The next example uses `do` to prepend the string `"Foo"` to a string (`" Bar"`) that is passed to
the `test(p: String)` function.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
fun test(p: String) = do {
    var a = "Foo" ++ p
    ---
    a
}
---
{ result: test(" Bar") }
```

Output:

```json
{
  "result": "Foo Bar"
}
```

See also, [Examples: Local DataWeave Variables](https://docs.mulesoft.com/dataweave/2.3/dataweave-variables#example_local_variable).

## `if else`

An `if` statement evaluates a conditional expression and returns the value under the `if` only if
the conditional expression returns `true`. Otherwise, it returns the expression under `else`. Every
`if` expression must have a matching `else` expression.

The following example uses the input `{ country : "FRANCE" }`, which is defined by the `myVar`
variable in the header:

DataWeave Script:

```dataweave
%dw 2.0
var myVar = { country : "FRANCE" }
output application/json
---
if (myVar.country == "USA")
  { currency: "USD" }
else { currency: "EUR" }
```

Output:

{ "currency": "EUR" }

You can use the if-else construct on any condition that evaluates to `true` or `false`, including
mathematical, logical, equality, and relational statements. The condition can act on any valid
input.

The next DataWeave script applies `if else` statements to the result of the following conditional
statements:

- A mathematical operation in `ex1`  
  The `if else` statement returns the Boolean value `true` if the operation `1 + 1 == 55` is true
  and `false` if not.

- An equality operation in `ex2`  
  The `if else` statement returns `1` if the value of the specified index is `1` or a string if the
  value is not `1`.

- An `isEmpty` function in `ex3`  
  The `if else` statement returns the string `"ID is empty"` or `"ID is not empty"` depending on
  whether `aRecord.bookId` contains a value.

- A mapping in `ex4` that iterates over `firstInput`  
  The `if else` statement returns the value of the `bookId` as a Number if the value is equal to
  `101`. It returns the specified string if the value is not equal to `101`.

DataWeave Script:

```dataweave
%dw 2.0
var aRecord =
 [
    "bookId":"101",
    "title":"world history",
    "price":"19.99"
 ]
output application/xml
---
{ examples:
	{
	   ex1 : if (1 + 1 == 55) true
	         else false,
	   ex2 : if ([1,2,3,4][1] == 1) 1
	         else "value of index 1 is not 1",
	   ex3 : if (isEmpty(aRecord.bookId)) "ID is empty"
	  	 else "ID is not empty",
	   ex4 : aRecord.bookId map (idValue) ->
	   	 if (idValue as Number == 101) idValue as Number
		 else "not 101"
	}
}
```

Output:

<?xml version='1.0' encoding='UTF-8'?>
<examples>
  <ex1>false</ex1>
  <ex2>value of index 1 is not 1</ex2>
  <ex3>ID is not empty</ex3>
  <ex4>101</ex4>
</examples>

Additional examples are available in [DataWeave Operators](https://docs.mulesoft.com/dataweave/2.3/dw-operators).

## `else if`

You can chain several `else` expressions together within an if-else construct by incorporating
`else if`. The following example uses the input `var myVar = { country : "UK" }`, which is defined
by the `myVar` variable in the header.

DataWeave Script:

```dataweave
%dw 2.0
var myVar = { country : "UK" }
output application/json
---
if (myVar.country =="USA")
	{ currency: "USD" }
else if (myVar.country =="UK")
	{ currency: "GBP" }
else { currency: "EUR" }
```

Output

{ "currency": "GBP" }

The following example is similar but takes an array as input instead of an object. The body of the
script uses `if else` and `else if` statements within a `do` operation to populate the value of the
`hello` variable.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
["Argentina", "USA", "Brazil"] map (country) -> do {
  var hello = if(country == "Argentina") "Hola"
   else if(country == "USA") "Hello"
   else if(country == "Brazil") "Ola"
   else "Sorry! We don't know $(country)'s language."
   ---
   "$(hello) DataWeave"
}
```

Output:

\[ "Hola DataWeave", "Hello DataWeave", "Ola DataWeave" \]

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.3/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.3/dataweave-selectors)

<!-- document id=9ca7fef0a97dae05bf0bac42af5dea3c0b2a8a75209881cabc33b4ebb27d5234 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-flow-control.md -->

---
product: DataWeave
version: 2.4
---

# Flow Control and Scope Operations in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You can use the following operators within any DataWeave expression:

- [`do`](#control_flow_do)

- [`if else`](#control_flow_if_else)

- [`else if`](#control_flow_else_if)

## `do`

A `do` statement creates a scope in which new variables, functions, annotations, or namespaces can
be declared and used. The syntax is similar to a mapping in that it is composed of a header and body
separated by `---`. Its header is where all the declarations are defined, and its body is the result
of the expression.

This example uses `do` to return the string `"DataWeave"` when `myfun()` is called from the main
body of the script.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
fun myfun() = do {
    var name = "DataWeave"
    ---
    name
}
---
{ result: myfun() }
```

This example uses `do` to return the string `"DataWeave"` when the variable `myVar` is referenced
from the main body of the script.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
var myVar = do {
    var name = "DataWeave"
    ---
    name
}
---
{ result: myVar }
```

Both scripts produce this output:

Output:

```json
{
  "result": "DataWeave"
}
```

The next example uses `do` to prepend the string `"Foo"` to a string (`" Bar"`) that is passed to
the `test(p: String)` function.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
fun test(p: String) = do {
    var a = "Foo" ++ p
    ---
    a
}
---
{ result: test(" Bar") }
```

Output:

```json
{
  "result": "Foo Bar"
}
```

See also, [Examples: Local DataWeave Variables](https://docs.mulesoft.com/dataweave/2.4/dataweave-variables#example_local_variable).

## `if else`

An `if` statement evaluates a conditional expression and returns the value under the `if` only if
the conditional expression returns `true`. Otherwise, it returns the expression under `else`. Every
`if` expression must have a matching `else` expression.

The following example uses the input `{ country : "FRANCE" }`, which is defined by the `myVar`
variable in the header:

DataWeave Script:

```dataweave
%dw 2.0
var myVar = { country : "FRANCE" }
output application/json
---
if (myVar.country == "USA")
  { currency: "USD" }
else { currency: "EUR" }
```

Output:

{ "currency": "EUR" }

You can use the if-else construct on any condition that evaluates to `true` or `false`, including
mathematical, logical, equality, and relational statements. The condition can act on any valid
input.

The next DataWeave script applies `if else` statements to the result of the following conditional
statements:

- A mathematical operation in `ex1`  
  The `if else` statement returns the Boolean value `true` if the operation `1 + 1 == 55` is true
  and `false` if not.

- An equality operation in `ex2`  
  The `if else` statement returns `1` if the value of the specified index is `1` or a string if the
  value is not `1`.

- An `isEmpty` function in `ex3`  
  The `if else` statement returns the string `"ID is empty"` or `"ID is not empty"` depending on
  whether `aRecord.bookId` contains a value.

- A mapping in `ex4` that iterates over `firstInput`  
  The `if else` statement returns the value of the `bookId` as a Number if the value is equal to
  `101`. It returns the specified string if the value is not equal to `101`.

DataWeave Script:

```dataweave
%dw 2.0
var aRecord =
 [
    "bookId":"101",
    "title":"world history",
    "price":"19.99"
 ]
output application/xml
---
{ examples:
	{
	   ex1 : if (1 + 1 == 55) true
	         else false,
	   ex2 : if ([1,2,3,4][1] == 1) 1
	         else "value of index 1 is not 1",
	   ex3 : if (isEmpty(aRecord.bookId)) "ID is empty"
	  	 else "ID is not empty",
	   ex4 : aRecord.bookId map (idValue) ->
	   	 if (idValue as Number == 101) idValue as Number
		 else "not 101"
	}
}
```

Output:

<?xml version='1.0' encoding='UTF-8'?>
<examples>
  <ex1>false</ex1>
  <ex2>value of index 1 is not 1</ex2>
  <ex3>ID is not empty</ex3>
  <ex4>101</ex4>
</examples>

Additional examples are available in [DataWeave Operators](https://docs.mulesoft.com/dataweave/2.4/dw-operators).

## `else if`

You can chain several `else` expressions together within an if-else construct by incorporating
`else if`. The following example uses the input `var myVar = { country : "UK" }`, which is defined
by the `myVar` variable in the header.

DataWeave Script:

```dataweave
%dw 2.0
var myVar = { country : "UK" }
output application/json
---
if (myVar.country =="USA")
	{ currency: "USD" }
else if (myVar.country =="UK")
	{ currency: "GBP" }
else { currency: "EUR" }
```

Output

{ "currency": "GBP" }

The following example is similar but takes an array as input instead of an object. The body of the
script uses `if else` and `else if` statements within a `do` operation to populate the value of the
`hello` variable.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
["Argentina", "USA", "Brazil"] map (country) -> do {
  var hello = if(country == "Argentina") "Hola"
   else if(country == "USA") "Hello"
   else if(country == "Brazil") "Ola"
   else "Sorry! We don't know $(country)'s language."
   ---
   "$(hello) DataWeave"
}
```

Output:

\[ "Hola DataWeave", "Hello DataWeave", "Ola DataWeave" \]

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.4/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.4/dataweave-selectors)

<!-- document id=e599401874b8baed9948a393787f0ace1d37a1aab404df9a0e60bea95c8ed923 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-flow-control.md -->

---
product: DataWeave
version: 2.6
---

# Flow Control and Scope Operations in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You can use the following operators within any DataWeave expression:

- [`do`](#control_flow_do)

- [`if else`](#control_flow_if_else)

- [`else if`](#control_flow_else_if)

## `do`

A `do` statement creates a scope in which new variables, functions, annotations, or namespaces can
be declared and used. The syntax is similar to a mapping in that it is composed of a header and body
separated by `---`. Its header is where all the declarations are defined, and its body is the result
of the expression.

This example uses `do` to return the string `"DataWeave"` when `myfun()` is called from the main
body of the script.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
fun myfun() = do {
    var name = "DataWeave"
    ---
    name
}
---
{ result: myfun() }
```

This example uses `do` to return the string `"DataWeave"` when the variable `myVar` is referenced
from the main body of the script.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
var myVar = do {
    var name = "DataWeave"
    ---
    name
}
---
{ result: myVar }
```

Both scripts produce this output:

Output:

```json
{
  "result": "DataWeave"
}
```

The next example uses `do` to prepend the string `"Foo"` to a string (`" Bar"`) that is passed to
the `test(p: String)` function.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
fun test(p: String) = do {
    var a = "Foo" ++ p
    ---
    a
}
---
{ result: test(" Bar") }
```

Output:

```json
{
  "result": "Foo Bar"
}
```

See also, [Examples: Local DataWeave Variables](https://docs.mulesoft.com/dataweave/2.6/dataweave-variables#example_local_variable).

## `if else`

An `if` statement evaluates a conditional expression and returns the value under the `if` only if
the conditional expression returns `true`. Otherwise, it returns the expression under `else`. Every
`if` expression must have a matching `else` expression.

The following example uses the input `{ country : "FRANCE" }`, which is defined by the `myVar`
variable in the header:

DataWeave Script:

```dataweave
%dw 2.0
var myVar = { country : "FRANCE" }
output application/json
---
if (myVar.country == "USA")
  { currency: "USD" }
else { currency: "EUR" }
```

Output:

{ "currency": "EUR" }

You can use the if-else construct on any condition that evaluates to `true` or `false`, including
mathematical, logical, equality, and relational statements. The condition can act on any valid
input.

The next DataWeave script applies `if else` statements to the result of the following conditional
statements:

- A mathematical operation in `ex1`  
  The `if else` statement returns the Boolean value `true` if the operation `1 + 1 == 55` is true
  and `false` if not.

- An equality operation in `ex2`  
  The `if else` statement returns `1` if the value of the specified index is `1` or a string if the
  value is not `1`.

- An `isEmpty` function in `ex3`  
  The `if else` statement returns the string `"ID is empty"` or `"ID is not empty"` depending on
  whether `aRecord.bookId` contains a value.

- A mapping in `ex4` that iterates over `firstInput`  
  The `if else` statement returns the value of the `bookId` as a Number if the value is equal to
  `101`. It returns the specified string if the value is not equal to `101`.

DataWeave Script:

```dataweave
%dw 2.0
var aRecord =
 [
    "bookId":"101",
    "title":"world history",
    "price":"19.99"
 ]
output application/xml
---
{ examples:
	{
	   ex1 : if (1 + 1 == 55) true
	         else false,
	   ex2 : if ([1,2,3,4][1] == 1) 1
	         else "value of index 1 is not 1",
	   ex3 : if (isEmpty(aRecord.bookId)) "ID is empty"
	  	 else "ID is not empty",
	   ex4 : aRecord.bookId map (idValue) ->
	   	 if (idValue as Number == 101) idValue as Number
		 else "not 101"
	}
}
```

Output:

<?xml version='1.0' encoding='UTF-8'?>
<examples>
  <ex1>false</ex1>
  <ex2>value of index 1 is not 1</ex2>
  <ex3>ID is not empty</ex3>
  <ex4>101</ex4>
</examples>

Additional examples are available in [DataWeave Operators](https://docs.mulesoft.com/dataweave/2.6/dw-operators).

## `else if`

You can chain several `else` expressions together within an if-else construct by incorporating
`else if`. The following example uses the input `var myVar = { country : "UK" }`, which is defined
by the `myVar` variable in the header.

DataWeave Script:

```dataweave
%dw 2.0
var myVar = { country : "UK" }
output application/json
---
if (myVar.country =="USA")
	{ currency: "USD" }
else if (myVar.country =="UK")
	{ currency: "GBP" }
else { currency: "EUR" }
```

Output

{ "currency": "GBP" }

The following example is similar but takes an array as input instead of an object. The body of the
script uses `if else` and `else if` statements within a `do` operation to populate the value of the
`hello` variable.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
["Argentina", "USA", "Brazil"] map (country) -> do {
  var hello = if(country == "Argentina") "Hola"
   else if(country == "USA") "Hello"
   else if(country == "Brazil") "Ola"
   else "Sorry! We don't know $(country)'s language."
   ---
   "$(hello) DataWeave"
}
```

Output:

\[ "Hola DataWeave", "Hello DataWeave", "Ola DataWeave" \]

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.6/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.6/dataweave-selectors)

<!-- document id=ae23a54e08afec7bdd8951c0ccfbf3dcc1ae70cdc970cca6ab9c1aa85d04f139 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-flow-control.md -->

---
product: DataWeave
version: 2.9
---

# Flow Control and Scope Operations in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You can use the following operators within any DataWeave expression:

- [`do`](#control_flow_do)

- [`if else`](#control_flow_if_else)

- [`else if`](#control_flow_else_if)

## `do`

A `do` statement creates a scope in which new variables, functions, annotations, or namespaces can
be declared and used. The syntax is similar to a mapping in that it is composed of a header and body
separated by `---`. Its header is where all the declarations are defined, and its body is the result
of the expression.

This example uses `do` to return the string `"DataWeave"` when `myfun()` is called from the main
body of the script.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
fun myfun() = do {
    var name = "DataWeave"
    ---
    name
}
---
{ result: myfun() }
```

This example uses `do` to return the string `"DataWeave"` when the variable `myVar` is referenced
from the main body of the script.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
var myVar = do {
    var name = "DataWeave"
    ---
    name
}
---
{ result: myVar }
```

Both scripts produce this output:

Output:

```json
{
  "result": "DataWeave"
}
```

The next example uses `do` to prepend the string `"Foo"` to a string (`" Bar"`) that is passed to
the `test(p: String)` function.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
fun test(p: String) = do {
    var a = "Foo" ++ p
    ---
    a
}
---
{ result: test(" Bar") }
```

Output:

```json
{
  "result": "Foo Bar"
}
```

See also, [Examples: Local DataWeave Variables](https://docs.mulesoft.com/dataweave/2.9/dataweave-variables#example_local_variable).

## `if else`

An `if` statement evaluates a conditional expression and returns the value under the `if` only if
the conditional expression returns `true`. Otherwise, it returns the expression under `else`. Every
`if` expression must have a matching `else` expression.

The following example uses the input `{ country : "FRANCE" }`, which is defined by the `myVar`
variable in the header:

DataWeave Script:

```dataweave
%dw 2.0
var myVar = { country : "FRANCE" }
output application/json
---
if (myVar.country == "USA")
  { currency: "USD" }
else { currency: "EUR" }
```

Output:

{ "currency": "EUR" }

You can use the if-else construct on any condition that evaluates to `true` or `false`, including
mathematical, logical, equality, and relational statements. The condition can act on any valid
input.

The next DataWeave script applies `if else` statements to the result of the following conditional
statements:

- A mathematical operation in `ex1`  
  The `if else` statement returns the Boolean value `true` if the operation `1 + 1 == 55` is true
  and `false` if not.

- An equality operation in `ex2`  
  The `if else` statement returns `1` if the value of the specified index is `1` or a string if the
  value is not `1`.

- An `isEmpty` function in `ex3`  
  The `if else` statement returns the string `"ID is empty"` or `"ID is not empty"` depending on
  whether `aRecord.bookId` contains a value.

- A mapping in `ex4` that iterates over `firstInput`  
  The `if else` statement returns the value of the `bookId` as a Number if the value is equal to
  `101`. It returns the specified string if the value is not equal to `101`.

DataWeave Script:

```dataweave
%dw 2.0
var aRecord =
 [
    "bookId":"101",
    "title":"world history",
    "price":"19.99"
 ]
output application/xml
---
{ examples:
	{
	   ex1 : if (1 + 1 == 55) true
	         else false,
	   ex2 : if ([1,2,3,4][1] == 1) 1
	         else "value of index 1 is not 1",
	   ex3 : if (isEmpty(aRecord.bookId)) "ID is empty"
	  	 else "ID is not empty",
	   ex4 : aRecord.bookId map (idValue) ->
	   	 if (idValue as Number == 101) idValue as Number
		 else "not 101"
	}
}
```

Output:

<?xml version='1.0' encoding='UTF-8'?>
<examples>
  <ex1>false</ex1>
  <ex2>value of index 1 is not 1</ex2>
  <ex3>ID is not empty</ex3>
  <ex4>101</ex4>
</examples>

Additional examples are available in [DataWeave Operators](https://docs.mulesoft.com/dataweave/2.9/dw-operators).

## `else if`

You can chain several `else` expressions together within an if-else construct by incorporating
`else if`. The following example uses the input `var myVar = { country : "UK" }`, which is defined
by the `myVar` variable in the header.

DataWeave Script:

```dataweave
%dw 2.0
var myVar = { country : "UK" }
output application/json
---
if (myVar.country =="USA")
	{ currency: "USD" }
else if (myVar.country =="UK")
	{ currency: "GBP" }
else { currency: "EUR" }
```

Output

{ "currency": "GBP" }

The following example is similar but takes an array as input instead of an object. The body of the
script uses `if else` and `else if` statements within a `do` operation to populate the value of the
`hello` variable.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
["Argentina", "USA", "Brazil"] map (country) -> do {
  var hello = if(country == "Argentina") "Hola"
   else if(country == "USA") "Hello"
   else if(country == "Brazil") "Ola"
   else "Sorry! We don't know $(country)'s language."
   ---
   "$(hello) DataWeave"
}
```

Output:

\[ "Hola DataWeave", "Hello DataWeave", "Ola DataWeave" \]

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.9/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.9/dataweave-selectors)

<!-- document id=7f850b18d81bb58dd25fd66ab3901ab70a9391679eeebce7f5876a14bd8729b8 url=/mulesoft/current/en-us/dataweave/latest/dataweave-flow-control.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Flow Control and Scope Operations in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You can use the following operators within any DataWeave expression:

- [`do`](#control_flow_do)

- [`if else`](#control_flow_if_else)

- [`else if`](#control_flow_else_if)

## `do`

A `do` statement creates a scope in which new variables, functions, annotations, or namespaces can
be declared and used. The syntax is similar to a mapping in that it is composed of a header and body
separated by `---`. Its header is where all the declarations are defined, and its body is the result
of the expression.

This example uses `do` to return the string `"DataWeave"` when `myfun()` is called from the main
body of the script.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
fun myfun() = do {
    var name = "DataWeave"
    ---
    name
}
---
{ result: myfun() }
```

This example uses `do` to return the string `"DataWeave"` when the variable `myVar` is referenced
from the main body of the script.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
var myVar = do {
    var name = "DataWeave"
    ---
    name
}
---
{ result: myVar }
```

Both scripts produce this output:

Output:

```json
{
  "result": "DataWeave"
}
```

The next example uses `do` to prepend the string `"Foo"` to a string (`" Bar"`) that is passed to
the `test(p: String)` function.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
fun test(p: String) = do {
    var a = "Foo" ++ p
    ---
    a
}
---
{ result: test(" Bar") }
```

Output:

```json
{
  "result": "Foo Bar"
}
```

See also, [Examples: Local DataWeave Variables](https://docs.mulesoft.com/dataweave/latest/dataweave-variables#example_local_variable).

## `if else`

An `if` statement evaluates a conditional expression and returns the value under the `if` only if
the conditional expression returns `true`. Otherwise, it returns the expression under `else`. Every
`if` expression must have a matching `else` expression.

The following example uses the input `{ country : "FRANCE" }`, which is defined by the `myVar`
variable in the header:

DataWeave Script:

```dataweave
%dw 2.0
var myVar = { country : "FRANCE" }
output application/json
---
if (myVar.country == "USA")
  { currency: "USD" }
else { currency: "EUR" }
```

Output:

{ "currency": "EUR" }

You can use the if-else construct on any condition that evaluates to `true` or `false`, including
mathematical, logical, equality, and relational statements. The condition can act on any valid
input.

The next DataWeave script applies `if else` statements to the result of the following conditional
statements:

- A mathematical operation in `ex1`  
  The `if else` statement returns the Boolean value `true` if the operation `1 + 1 == 55` is true
  and `false` if not.

- An equality operation in `ex2`  
  The `if else` statement returns `1` if the value of the specified index is `1` or a string if the
  value is not `1`.

- An `isEmpty` function in `ex3`  
  The `if else` statement returns the string `"ID is empty"` or `"ID is not empty"` depending on
  whether `aRecord.bookId` contains a value.

- A mapping in `ex4` that iterates over `firstInput`  
  The `if else` statement returns the value of the `bookId` as a Number if the value is equal to
  `101`. It returns the specified string if the value is not equal to `101`.

DataWeave Script:

```dataweave
%dw 2.0
var aRecord =
 [
    "bookId":"101",
    "title":"world history",
    "price":"19.99"
 ]
output application/xml
---
{ examples:
	{
	   ex1 : if (1 + 1 == 55) true
	         else false,
	   ex2 : if ([1,2,3,4][1] == 1) 1
	         else "value of index 1 is not 1",
	   ex3 : if (isEmpty(aRecord.bookId)) "ID is empty"
	  	 else "ID is not empty",
	   ex4 : aRecord.bookId map (idValue) ->
	   	 if (idValue as Number == 101) idValue as Number
		 else "not 101"
	}
}
```

Output:

<?xml version='1.0' encoding='UTF-8'?>
<examples>
  <ex1>false</ex1>
  <ex2>value of index 1 is not 1</ex2>
  <ex3>ID is not empty</ex3>
  <ex4>101</ex4>
</examples>

Additional examples are available in [DataWeave Operators](https://docs.mulesoft.com/dataweave/latest/dw-operators).

## `else if`

You can chain several `else` expressions together within an if-else construct by incorporating
`else if`. The following example uses the input `var myVar = { country : "UK" }`, which is defined
by the `myVar` variable in the header.

DataWeave Script:

```dataweave
%dw 2.0
var myVar = { country : "UK" }
output application/json
---
if (myVar.country =="USA")
	{ currency: "USD" }
else if (myVar.country =="UK")
	{ currency: "GBP" }
else { currency: "EUR" }
```

Output

{ "currency": "GBP" }

The following example is similar but takes an array as input instead of an object. The body of the
script uses `if else` and `else if` statements within a `do` operation to populate the value of the
`hello` variable.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
["Argentina", "USA", "Brazil"] map (country) -> do {
  var hello = if(country == "Argentina") "Hola"
   else if(country == "USA") "Hello"
   else if(country == "Brazil") "Ola"
   else "Sorry! We don't know $(country)'s language."
   ---
   "$(hello) DataWeave"
}
```

Output:

\[ "Hola DataWeave", "Hello DataWeave", "Ola DataWeave" \]

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/latest/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors)

<!-- document id=96cef3ddd69c5c14a0a127aaad1b50bdce6da1f7d508aeae2006cb02f388b17c url=/mulesoft/current/en-us/dataweave/2.11/dw-multipart-functions-form.md -->

---
product: DataWeave
version: 2.11
---

# form

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## form(parts: Array<MultipartPart>): Multipart

Creates a `Multipart` data structure using a specified array of parts.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>parts</code></p></td><td><div><div><p>An array of parts (<code>MultipartPart</code> data structures).</p></div></div></td></tr></tbody></table>

### Example

This example creates a `Multipart` data structure that contains three parts.

The first part uses the `Multipart::file()` function to import an external file named `orders.xml`.
The file is located in the internal `src/main/resources` folder of the Mule application. See the
[file](https://docs.mulesoft.com/dataweave/2.11/dw-multipart-functions-file) function documentation for more details on this example.

The second part uses the `Multipart::field()` function version that accepts field names as input
parameters in the form of an object with key/value pairs, enabling you to pass the keys in any
order. This part also does not specify the optional `fileName` parameter. When specified, `fileName`
is part of the `Content-Distribution` element of the part. The `mime` field is also optional. When
included, the field sets the `Content-Type` element to the `mime` value. In this case the
`Content-Type` is set to `text/plain`.

The third part uses the more compact version of the `Multipart::field()` function which sets the
required and optional parameters, in the correct order, as input parameters. The first three
parameters `name`, `value`, and `mime` are required. The `fileName` parameters is optional, use it
only if the content is read from a file or is written to a file. In this version, the `mime`
parameter is output as the `Content-Type` element, and the `fileName` is output as the `filename`
parameter of the `Content-Distribution` element.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
output multipart/form-data
var myOrders = "./orders.xml"
var fileArgs = { name: "file", path: myOrders, mime: "application/xml", fileName: "myorders.xml"}
var fieldArgs = {name:"userName",value: "Annie Point", mime: "text/plain"}
---
Multipart::form([
  Multipart::file(fileArgs),
  Multipart::field(fieldArgs),
  Multipart::field("myJson", {"user": "Annie Point"}, "application/json", "userInfo.json")
])
```

#### Output

```json
------=_Part_146_143704079.1560394078604
Content-Type: application/xml
Content-Disposition: form-data; name="file"; filename="myorders.xml"
<?xml version='1.0' encoding='UTF-8'?>
<orders>
  <order>
    <item>
      <id>1001</id>
      <qty>1</qty>
      <price>$100</price>
    </item>
    <item>
      <id>2001</id>
      <qty>2</qty>
      <price>$50</price>
    </item>
  </order>
</orders>
------=_Part_146_143704079.1560394078604
Content-Type: text/plain
Content-Disposition: form-data; name="userName"
Annie Point
------=_Part_146_143704079.1560394078604
Content-Type: application/json
Content-Disposition: form-data; name="myJson"; filename="userInfo.json"
{
  "user": "Annie Point"
}
------=_Part_146_143704079.1560394078604--
```

### Example

This example constructs a data structure using DataWeave code that is compatible with the
`multipart/form-data` output format, demonstrating how you can manually construct a data structure
compatible with `multipart/form-data` output, without using the `form` function.

In the following structure, the part keys `part1` and `part2` are stripped out in the
`multipart/form-data` output.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
output multipart/form-data
var firstPart = "content for my first part"
var secondPart = "content for my second part"
---
{
  parts: {
    part1: Multipart::field({name:"myFirstPart",value: firstPart}),
    part2: Multipart::field("mySecondPart", secondPart)
  }
}
```

#### Output

```txt
------=_Part_320_1528378161.1542639222352
Content-Disposition: form-data; name="myFirstPart"

content for my first part
------=_Part_320_1528378161.1542639222352
Content-Disposition: form-data; name="mySecondPart"

content for my second part
------=_Part_320_1528378161.1542639222352--
```

<!-- document id=2973f3955b2cc3c9283dcee3070a3f148f032fd8db159eb57516a1adee08f96c url=/mulesoft/current/en-us/dataweave/2.12/dw-multipart-functions-form.md -->

---
product: DataWeave
version: 2.12
---

# form

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## form(parts: Array<MultipartPart>): Multipart

Creates a `Multipart` data structure using a specified array of parts.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>parts</code></p></td><td><div><div><p>An array of parts (<code>MultipartPart</code> data structures).</p></div></div></td></tr></tbody></table>

### Example

This example creates a `Multipart` data structure that contains three parts.

The first part uses the `Multipart::file()` function to import an external file named `orders.xml`.
The file is located in the internal `src/main/resources` folder of the Mule application. See the
[file](https://docs.mulesoft.com/dataweave/2.12/dw-multipart-functions-file) function documentation for more details on this example.

The second part uses the `Multipart::field()` function version that accepts field names as input
parameters in the form of an object with key/value pairs, enabling you to pass the keys in any
order. This part also does not specify the optional `fileName` parameter. When specified, `fileName`
is part of the `Content-Distribution` element of the part. The `mime` field is also optional. When
included, the field sets the `Content-Type` element to the `mime` value. In this case the
`Content-Type` is set to `text/plain`.

The third part uses the more compact version of the `Multipart::field()` function which sets the
required and optional parameters, in the correct order, as input parameters. The first three
parameters `name`, `value`, and `mime` are required. The `fileName` parameters is optional, use it
only if the content is read from a file or is written to a file. In this version, the `mime`
parameter is output as the `Content-Type` element, and the `fileName` is output as the `filename`
parameter of the `Content-Distribution` element.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
output multipart/form-data
var myOrders = "./orders.xml"
var fileArgs = { name: "file", path: myOrders, mime: "application/xml", fileName: "myorders.xml"}
var fieldArgs = {name:"userName",value: "Annie Point", mime: "text/plain"}
---
Multipart::form([
  Multipart::file(fileArgs),
  Multipart::field(fieldArgs),
  Multipart::field("myJson", {"user": "Annie Point"}, "application/json", "userInfo.json")
])
```

#### Output

```json
------=_Part_146_143704079.1560394078604
Content-Type: application/xml
Content-Disposition: form-data; name="file"; filename="myorders.xml"
<?xml version='1.0' encoding='UTF-8'?>
<orders>
  <order>
    <item>
      <id>1001</id>
      <qty>1</qty>
      <price>$100</price>
    </item>
    <item>
      <id>2001</id>
      <qty>2</qty>
      <price>$50</price>
    </item>
  </order>
</orders>
------=_Part_146_143704079.1560394078604
Content-Type: text/plain
Content-Disposition: form-data; name="userName"
Annie Point
------=_Part_146_143704079.1560394078604
Content-Type: application/json
Content-Disposition: form-data; name="myJson"; filename="userInfo.json"
{
  "user": "Annie Point"
}
------=_Part_146_143704079.1560394078604--
```

### Example

This example constructs a data structure using DataWeave code that is compatible with the
`multipart/form-data` output format, demonstrating how you can manually construct a data structure
compatible with `multipart/form-data` output, without using the `form` function.

In the following structure, the part keys `part1` and `part2` are stripped out in the
`multipart/form-data` output.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
output multipart/form-data
var firstPart = "content for my first part"
var secondPart = "content for my second part"
---
{
  parts: {
    part1: Multipart::field({name:"myFirstPart",value: firstPart}),
    part2: Multipart::field("mySecondPart", secondPart)
  }
}
```

#### Output

```txt
------=_Part_320_1528378161.1542639222352
Content-Disposition: form-data; name="myFirstPart"

content for my first part
------=_Part_320_1528378161.1542639222352
Content-Disposition: form-data; name="mySecondPart"

content for my second part
------=_Part_320_1528378161.1542639222352--
```

<!-- document id=97bd4d7d6552dbbee69fd52abfa5c1b6f2d91c5b6b33ac97702cdf2e5cf3bd0c url=/mulesoft/current/en-us/dataweave/2.3/dw-multipart-functions-form.md -->

---
product: DataWeave
version: 2.3
---

# form

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## form(Array<MultipartPart>): Multipart

Creates a `Multipart` data structure using a specified array of parts.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>parts</code></p></td><td><p>An array of parts (<code>MultipartPart</code> data structures).</p></td></tr></tbody></table>

### Example

This example creates a `Multipart` data structure that contains parts, which are described in
examples for the `field` function. For additional uses of `form`, see examples in the Multipart
`file` and `field`
[documentation](https://docs.mulesoft.com/dataweave/2.3/dw-multipart-functions-form).

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
output multipart/form-data
var firstPart = "content for my first part"
var secondPart = "content for my second part"
---
{
  parts: {
    part1: Multipart::field({name:"myFirstPart",value: firstPart}),
    part2: Multipart::field("mySecondPart", secondPart)
  }
}
```

#### Output

```txt
------=_Part_320_1528378161.1542639222352
Content-Disposition: form-data; name="myFirstPart"

content for my first part
------=_Part_320_1528378161.1542639222352
Content-Disposition: form-data; name="mySecondPart"

content for my second part
------=_Part_320_1528378161.1542639222352--
```

<!-- document id=8649a3705eea17599300f1cccea7cec0c529c2d49dd19d6829f71087fff9ba99 url=/mulesoft/current/en-us/dataweave/2.4/dw-multipart-functions-form.md -->

---
product: DataWeave
version: 2.4
---

# form

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## form(parts: Array<MultipartPart>): Multipart

Creates a `Multipart` data structure using a specified array of parts.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>parts</code></p></td><td><div><div><p>An array of parts (<code>MultipartPart</code> data structures).</p></div></div></td></tr></tbody></table>

### Example

This example creates a `Multipart` data structure that contains three parts.

The first part uses the `Multipart::file()` function to import an external file named `orders.xml`.
The file is located in the internal `src/main/resources` folder of the Mule application. See the
[file](https://docs.mulesoft.com/dataweave/2.4/dw-multipart-functions-file) function documentation for more details on this example.

The second part uses the `Multipart::field()` function version that accepts field names as input
parameters in the form of an object with key/value pairs, enabling you to pass the keys in any
order. This part also does not specify the optional `fileName` parameter. When specified, `fileName`
is part of the `Content-Distribution` element of the part. The `mime` field is also optional. When
included, the field sets the `Content-Type` element to the `mime` value. In this case the
`Content-Type` is set to `text/plain`.

The third part uses the more compact version of the `Multipart::field()` function which sets the
required and optional parameters, in the correct order, as input parameters. The first three
parameters `name`, `value`, and `mime` are required. The `fileName` parameters is optional, use it
only if the content is read from a file or is written to a file. In this version, the `mime`
parameter is output as the `Content-Type` element, and the `fileName` is output as the `filename`
parameter of the `Content-Distribution` element.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
output multipart/form-data
var myOrders = "./orders.xml"
var fileArgs = { name: "file", path: myOrders, mime: "application/xml", fileName: "myorders.xml"}
var fieldArgs = {name:"userName",value: "Annie Point", mime: "text/plain"}
---
Multipart::form([
  Multipart::file(fileArgs),
  Multipart::field(fieldArgs),
  Multipart::field("myJson", {"user": "Annie Point"}, "application/json", "userInfo.json")
])
```

#### Output

```json
------=_Part_146_143704079.1560394078604
Content-Type: application/xml
Content-Disposition: form-data; name="file"; filename="myorders.xml"
<?xml version='1.0' encoding='UTF-8'?>
<orders>
  <order>
    <item>
      <id>1001</id>
      <qty>1</qty>
      <price>$100</price>
    </item>
    <item>
      <id>2001</id>
      <qty>2</qty>
      <price>$50</price>
    </item>
  </order>
</orders>
------=_Part_146_143704079.1560394078604
Content-Type: text/plain
Content-Disposition: form-data; name="userName"
Annie Point
------=_Part_146_143704079.1560394078604
Content-Type: application/json
Content-Disposition: form-data; name="myJson"; filename="userInfo.json"
{
  "user": "Annie Point"
}
------=_Part_146_143704079.1560394078604--
```

### Example

This example constructs a data structure using DataWeave code that is compatible with the
`multipart/form-data` output format, demonstrating how you can manually construct a data structure
compatible with `multipart/form-data` output, without using the `form` function.

In the following structure, the part keys `part1` and `part2` are stripped out in the
`multipart/form-data` output.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
output multipart/form-data
var firstPart = "content for my first part"
var secondPart = "content for my second part"
---
{
  parts: {
    part1: Multipart::field({name:"myFirstPart",value: firstPart}),
    part2: Multipart::field("mySecondPart", secondPart)
  }
}
```

#### Output

```txt
------=_Part_320_1528378161.1542639222352
Content-Disposition: form-data; name="myFirstPart"

content for my first part
------=_Part_320_1528378161.1542639222352
Content-Disposition: form-data; name="mySecondPart"

content for my second part
------=_Part_320_1528378161.1542639222352--
```

<!-- document id=0341b8f696423251bd2df31a495e5c05622f46227f23a8bbead60afc374bf8b3 url=/mulesoft/current/en-us/dataweave/2.6/dw-multipart-functions-form.md -->

---
product: DataWeave
version: 2.6
---

# form

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## form(parts: Array<MultipartPart>): Multipart

Creates a `Multipart` data structure using a specified array of parts.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>parts</code></p></td><td><div><div><p>An array of parts (<code>MultipartPart</code> data structures).</p></div></div></td></tr></tbody></table>

### Example

This example creates a `Multipart` data structure that contains three parts.

The first part uses the `Multipart::file()` function to import an external file named `orders.xml`.
The file is located in the internal `src/main/resources` folder of the Mule application. See the
[file](https://docs.mulesoft.com/dataweave/2.6/dw-multipart-functions-file) function documentation for more details on this example.

The second part uses the `Multipart::field()` function version that accepts field names as input
parameters in the form of an object with key/value pairs, enabling you to pass the keys in any
order. This part also does not specify the optional `fileName` parameter. When specified, `fileName`
is part of the `Content-Distribution` element of the part. The `mime` field is also optional. When
included, the field sets the `Content-Type` element to the `mime` value. In this case the
`Content-Type` is set to `text/plain`.

The third part uses the more compact version of the `Multipart::field()` function which sets the
required and optional parameters, in the correct order, as input parameters. The first three
parameters `name`, `value`, and `mime` are required. The `fileName` parameters is optional, use it
only if the content is read from a file or is written to a file. In this version, the `mime`
parameter is output as the `Content-Type` element, and the `fileName` is output as the `filename`
parameter of the `Content-Distribution` element.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
output multipart/form-data
var myOrders = "./orders.xml"
var fileArgs = { name: "file", path: myOrders, mime: "application/xml", fileName: "myorders.xml"}
var fieldArgs = {name:"userName",value: "Annie Point", mime: "text/plain"}
---
Multipart::form([
  Multipart::file(fileArgs),
  Multipart::field(fieldArgs),
  Multipart::field("myJson", {"user": "Annie Point"}, "application/json", "userInfo.json")
])
```

#### Output

```json
------=_Part_146_143704079.1560394078604
Content-Type: application/xml
Content-Disposition: form-data; name="file"; filename="myorders.xml"
<?xml version='1.0' encoding='UTF-8'?>
<orders>
  <order>
    <item>
      <id>1001</id>
      <qty>1</qty>
      <price>$100</price>
    </item>
    <item>
      <id>2001</id>
      <qty>2</qty>
      <price>$50</price>
    </item>
  </order>
</orders>
------=_Part_146_143704079.1560394078604
Content-Type: text/plain
Content-Disposition: form-data; name="userName"
Annie Point
------=_Part_146_143704079.1560394078604
Content-Type: application/json
Content-Disposition: form-data; name="myJson"; filename="userInfo.json"
{
  "user": "Annie Point"
}
------=_Part_146_143704079.1560394078604--
```

### Example

This example constructs a data structure using DataWeave code that is compatible with the
`multipart/form-data` output format, demonstrating how you can manually construct a data structure
compatible with `multipart/form-data` output, without using the `form` function.

In the following structure, the part keys `part1` and `part2` are stripped out in the
`multipart/form-data` output.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
output multipart/form-data
var firstPart = "content for my first part"
var secondPart = "content for my second part"
---
{
  parts: {
    part1: Multipart::field({name:"myFirstPart",value: firstPart}),
    part2: Multipart::field("mySecondPart", secondPart)
  }
}
```

#### Output

```txt
------=_Part_320_1528378161.1542639222352
Content-Disposition: form-data; name="myFirstPart"

content for my first part
------=_Part_320_1528378161.1542639222352
Content-Disposition: form-data; name="mySecondPart"

content for my second part
------=_Part_320_1528378161.1542639222352--
```

<!-- document id=20546d082ec2d04473fb71a1da83a2d77d2c8ae1c27ac4a3dcb504ecf65d9150 url=/mulesoft/current/en-us/dataweave/2.9/dw-multipart-functions-form.md -->

---
product: DataWeave
version: 2.9
---

# form

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## form(parts: Array<MultipartPart>): Multipart

Creates a `Multipart` data structure using a specified array of parts.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>parts</code></p></td><td><div><div><p>An array of parts (<code>MultipartPart</code> data structures).</p></div></div></td></tr></tbody></table>

### Example

This example creates a `Multipart` data structure that contains three parts.

The first part uses the `Multipart::file()` function to import an external file named `orders.xml`.
The file is located in the internal `src/main/resources` folder of the Mule application. See the
[file](https://docs.mulesoft.com/dataweave/2.9/dw-multipart-functions-file) function documentation for more details on this example.

The second part uses the `Multipart::field()` function version that accepts field names as input
parameters in the form of an object with key/value pairs, enabling you to pass the keys in any
order. This part also does not specify the optional `fileName` parameter. When specified, `fileName`
is part of the `Content-Distribution` element of the part. The `mime` field is also optional. When
included, the field sets the `Content-Type` element to the `mime` value. In this case the
`Content-Type` is set to `text/plain`.

The third part uses the more compact version of the `Multipart::field()` function which sets the
required and optional parameters, in the correct order, as input parameters. The first three
parameters `name`, `value`, and `mime` are required. The `fileName` parameters is optional, use it
only if the content is read from a file or is written to a file. In this version, the `mime`
parameter is output as the `Content-Type` element, and the `fileName` is output as the `filename`
parameter of the `Content-Distribution` element.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
output multipart/form-data
var myOrders = "./orders.xml"
var fileArgs = { name: "file", path: myOrders, mime: "application/xml", fileName: "myorders.xml"}
var fieldArgs = {name:"userName",value: "Annie Point", mime: "text/plain"}
---
Multipart::form([
  Multipart::file(fileArgs),
  Multipart::field(fieldArgs),
  Multipart::field("myJson", {"user": "Annie Point"}, "application/json", "userInfo.json")
])
```

#### Output

```json
------=_Part_146_143704079.1560394078604
Content-Type: application/xml
Content-Disposition: form-data; name="file"; filename="myorders.xml"
<?xml version='1.0' encoding='UTF-8'?>
<orders>
  <order>
    <item>
      <id>1001</id>
      <qty>1</qty>
      <price>$100</price>
    </item>
    <item>
      <id>2001</id>
      <qty>2</qty>
      <price>$50</price>
    </item>
  </order>
</orders>
------=_Part_146_143704079.1560394078604
Content-Type: text/plain
Content-Disposition: form-data; name="userName"
Annie Point
------=_Part_146_143704079.1560394078604
Content-Type: application/json
Content-Disposition: form-data; name="myJson"; filename="userInfo.json"
{
  "user": "Annie Point"
}
------=_Part_146_143704079.1560394078604--
```

### Example

This example constructs a data structure using DataWeave code that is compatible with the
`multipart/form-data` output format, demonstrating how you can manually construct a data structure
compatible with `multipart/form-data` output, without using the `form` function.

In the following structure, the part keys `part1` and `part2` are stripped out in the
`multipart/form-data` output.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
output multipart/form-data
var firstPart = "content for my first part"
var secondPart = "content for my second part"
---
{
  parts: {
    part1: Multipart::field({name:"myFirstPart",value: firstPart}),
    part2: Multipart::field("mySecondPart", secondPart)
  }
}
```

#### Output

```txt
------=_Part_320_1528378161.1542639222352
Content-Disposition: form-data; name="myFirstPart"

content for my first part
------=_Part_320_1528378161.1542639222352
Content-Disposition: form-data; name="mySecondPart"

content for my second part
------=_Part_320_1528378161.1542639222352--
```

<!-- document id=fec2354c6b885d991c61352f48125a168907af49b2ec5d86b32a089c3cedf229 url=/mulesoft/current/en-us/dataweave/latest/dw-multipart-functions-form.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# form

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## form(parts: Array<MultipartPart>): Multipart

Creates a `Multipart` data structure using a specified array of parts.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>parts</code></p></td><td><div><div><p>An array of parts (<code>MultipartPart</code> data structures).</p></div></div></td></tr></tbody></table>

### Example

This example creates a `Multipart` data structure that contains three parts.

The first part uses the `Multipart::file()` function to import an external file named `orders.xml`.
The file is located in the internal `src/main/resources` folder of the Mule application. See the
[file](https://docs.mulesoft.com/dataweave/latest/dw-multipart-functions-file) function documentation for more details on this example.

The second part uses the `Multipart::field()` function version that accepts field names as input
parameters in the form of an object with key/value pairs, enabling you to pass the keys in any
order. This part also does not specify the optional `fileName` parameter. When specified, `fileName`
is part of the `Content-Distribution` element of the part. The `mime` field is also optional. When
included, the field sets the `Content-Type` element to the `mime` value. In this case the
`Content-Type` is set to `text/plain`.

The third part uses the more compact version of the `Multipart::field()` function which sets the
required and optional parameters, in the correct order, as input parameters. The first three
parameters `name`, `value`, and `mime` are required. The `fileName` parameters is optional, use it
only if the content is read from a file or is written to a file. In this version, the `mime`
parameter is output as the `Content-Type` element, and the `fileName` is output as the `filename`
parameter of the `Content-Distribution` element.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
output multipart/form-data
var myOrders = "./orders.xml"
var fileArgs = { name: "file", path: myOrders, mime: "application/xml", fileName: "myorders.xml"}
var fieldArgs = {name:"userName",value: "Annie Point", mime: "text/plain"}
---
Multipart::form([
  Multipart::file(fileArgs),
  Multipart::field(fieldArgs),
  Multipart::field("myJson", {"user": "Annie Point"}, "application/json", "userInfo.json")
])
```

#### Output

```json
------=_Part_146_143704079.1560394078604
Content-Type: application/xml
Content-Disposition: form-data; name="file"; filename="myorders.xml"
<?xml version='1.0' encoding='UTF-8'?>
<orders>
  <order>
    <item>
      <id>1001</id>
      <qty>1</qty>
      <price>$100</price>
    </item>
    <item>
      <id>2001</id>
      <qty>2</qty>
      <price>$50</price>
    </item>
  </order>
</orders>
------=_Part_146_143704079.1560394078604
Content-Type: text/plain
Content-Disposition: form-data; name="userName"
Annie Point
------=_Part_146_143704079.1560394078604
Content-Type: application/json
Content-Disposition: form-data; name="myJson"; filename="userInfo.json"
{
  "user": "Annie Point"
}
------=_Part_146_143704079.1560394078604--
```

### Example

This example constructs a data structure using DataWeave code that is compatible with the
`multipart/form-data` output format, demonstrating how you can manually construct a data structure
compatible with `multipart/form-data` output, without using the `form` function.

In the following structure, the part keys `part1` and `part2` are stripped out in the
`multipart/form-data` output.

#### Source

```DataWeave
%dw 2.0
import dw::module::Multipart
output multipart/form-data
var firstPart = "content for my first part"
var secondPart = "content for my second part"
---
{
  parts: {
    part1: Multipart::field({name:"myFirstPart",value: firstPart}),
    part2: Multipart::field("mySecondPart", secondPart)
  }
}
```

#### Output

```txt
------=_Part_320_1528378161.1542639222352
Content-Disposition: form-data; name="myFirstPart"

content for my first part
------=_Part_320_1528378161.1542639222352
Content-Disposition: form-data; name="mySecondPart"

content for my second part
------=_Part_320_1528378161.1542639222352--
```

<!-- document id=240267742a5a68b6d89e6639bebd3bd7a0562aff98a03bd861116c64e147b9cb url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook-format-according-to-type.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Format According to Type

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example applies changes to the keys in an object, depending on the type of their
corresponding values. When the element is an array, the keys are pluralized. When it’s a number,
they are set to camel case. In any other case they are capitalized.

The example uses:

- `mapObject` to go through each element in the payload.

- `if` to check that an element is of a given type.

- `camelize` from the String library to apply a camel case format to strings (all words stringed
  together, using upper case letters to mark separations).

- `capitalize` from the String library to apply a capitalized format to strings (all words are
  separate and start with an upper case letter).

- `pluralize` from the String library to change singular words into plural.

DataWeave Script:

```dataweave
%dw 2.0
import * from dw::core::Strings
output application/json
---
payload mapObject ((elementValue, elementKey) -> {
  (if (elementValue is Array)
      pluralize(elementKey)
    else if(elementValue is Number)
      camelize(elementKey)
    else capitalize(elementKey)) : elementValue
})
```

Input JSON Payload:

```json
{
  "VersionNo": 1.6,
  "StoreOfOrigin": "SFO",
  "Item": [
    {
      "ID": "34546315801",
      "DeliveryMethod": "AIR",
      "Quantity": 8
    },
    {
      "ID": "56722087289",
      "Boxes": 3,
      "DeliveryMethod": "GROUND",
      "Quantity": 2
    }
  ]
}
```

Output JSON:

```json
{
  "versionNo": 1.6,
  "Store Of Origin": "SFO",
  "Items": [
    {
      "ID": "34546315801",
      "DeliveryMethod": "AIR",
      "Quantity": 8
    },
    {
      "ID": "56722087289",
      "Boxes": 3,
      "DeliveryMethod": "GROUND",
      "Quantity": 2
    }
  ]
}
```

## Related Examples

- [Output Self-closing XML tags](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-output-self-closing-xml-tags)

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-insert-attribute)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.11/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook)

<!-- document id=0ffb76780d11157c540a0cf412d55732ac4d083fa57da6d928325cf0c7b7f94d url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook-format-according-to-type.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Format According to Type

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example applies changes to the keys in an object, depending on the type of their
corresponding values. When the element is an array, the keys are pluralized. When it’s a number,
they are set to camel case. In any other case they are capitalized.

The example uses:

- `mapObject` to go through each element in the payload.

- `if` to check that an element is of a given type.

- `camelize` from the String library to apply a camel case format to strings (all words stringed
  together, using upper case letters to mark separations).

- `capitalize` from the String library to apply a capitalized format to strings (all words are
  separate and start with an upper case letter).

- `pluralize` from the String library to change singular words into plural.

DataWeave Script:

```dataweave
%dw 2.0
import * from dw::core::Strings
output application/json
---
payload mapObject ((elementValue, elementKey) -> {
  (if (elementValue is Array)
      pluralize(elementKey)
    else if(elementValue is Number)
      camelize(elementKey)
    else capitalize(elementKey)) : elementValue
})
```

Input JSON Payload:

```json
{
  "VersionNo": 1.6,
  "StoreOfOrigin": "SFO",
  "Item": [
    {
      "ID": "34546315801",
      "DeliveryMethod": "AIR",
      "Quantity": 8
    },
    {
      "ID": "56722087289",
      "Boxes": 3,
      "DeliveryMethod": "GROUND",
      "Quantity": 2
    }
  ]
}
```

Output JSON:

```json
{
  "versionNo": 1.6,
  "Store Of Origin": "SFO",
  "Items": [
    {
      "ID": "34546315801",
      "DeliveryMethod": "AIR",
      "Quantity": 8
    },
    {
      "ID": "56722087289",
      "Boxes": 3,
      "DeliveryMethod": "GROUND",
      "Quantity": 2
    }
  ]
}
```

## Related Examples

- [Output Self-closing XML tags](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-output-self-closing-xml-tags)

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-insert-attribute)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.12/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook)

<!-- document id=f79c974ee6fbad76ddd918e6e6b4feca433e29d2b020ec10f795f19f8094dff4 url=/mulesoft/current/en-us/dataweave/2.3/dataweave-cookbook-format-according-to-type.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Format According to Type

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example applies changes to the keys in an object, depending on the type of their
corresponding values. When the element is an array, the keys are pluralized. When it’s a number,
they are set to camel case. In any other case they are capitalized.

The example uses:

- `mapObject` to go through each element in the payload.

- `if` to check that an element is of a given type.

- `camelize` from the String library to apply a camel case format to strings (all words stringed
  together, using upper case letters to mark separations).

- `capitalize` from the String library to apply a capitalized format to strings (all words are
  separate and start with an upper case letter).

- `pluralize` from the String library to change singular words into plural.

DataWeave Script:

```dataweave
%dw 2.0
import * from dw::core::Strings
output application/json
---
payload mapObject ((elementValue, elementKey) -> {
  (if (elementValue is Array)
      pluralize(elementKey)
    else if(elementValue is Number)
      camelize(elementKey)
    else capitalize(elementKey)) : elementValue
})
```

Input JSON Payload:

```json
{
  "VersionNo": 1.6,
  "StoreOfOrigin": "SFO",
  "Item": [
    {
      "ID": "34546315801",
      "DeliveryMethod": "AIR",
      "Quantity": 8
    },
    {
      "ID": "56722087289",
      "Boxes": 3,
      "DeliveryMethod": "GROUND",
      "Quantity": 2
    }
  ]
}
```

Output JSON:

```json
{
  "versionNo": 1.6,
  "Store Of Origin": "SFO",
  "Items": [
    {
      "ID": "34546315801",
      "DeliveryMethod": "AIR",
      "Quantity": 8
    },
    {
      "ID": "56722087289",
      "Boxes": 3,
      "DeliveryMethod": "GROUND",
      "Quantity": 2
    }
  ]
}
```

## Related Examples

- [Output Self-closing XML tags](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-output-self-closing-xml-tags)

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-insert-attribute)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.3/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook)

<!-- document id=5fe7424b395c5a2951a166428702e49c6f53b3b6158874895cd80233243c1928 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook-format-according-to-type.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Format According to Type

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example applies changes to the keys in an object, depending on the type of their
corresponding values. When the element is an array, the keys are pluralized. When it’s a number,
they are set to camel case. In any other case they are capitalized.

The example uses:

- `mapObject` to go through each element in the payload.

- `if` to check that an element is of a given type.

- `camelize` from the String library to apply a camel case format to strings (all words stringed
  together, using upper case letters to mark separations).

- `capitalize` from the String library to apply a capitalized format to strings (all words are
  separate and start with an upper case letter).

- `pluralize` from the String library to change singular words into plural.

DataWeave Script:

```dataweave
%dw 2.0
import * from dw::core::Strings
output application/json
---
payload mapObject ((elementValue, elementKey) -> {
  (if (elementValue is Array)
      pluralize(elementKey)
    else if(elementValue is Number)
      camelize(elementKey)
    else capitalize(elementKey)) : elementValue
})
```

Input JSON Payload:

```json
{
  "VersionNo": 1.6,
  "StoreOfOrigin": "SFO",
  "Item": [
    {
      "ID": "34546315801",
      "DeliveryMethod": "AIR",
      "Quantity": 8
    },
    {
      "ID": "56722087289",
      "Boxes": 3,
      "DeliveryMethod": "GROUND",
      "Quantity": 2
    }
  ]
}
```

Output JSON:

```json
{
  "versionNo": 1.6,
  "Store Of Origin": "SFO",
  "Items": [
    {
      "ID": "34546315801",
      "DeliveryMethod": "AIR",
      "Quantity": 8
    },
    {
      "ID": "56722087289",
      "Boxes": 3,
      "DeliveryMethod": "GROUND",
      "Quantity": 2
    }
  ]
}
```

## Related Examples

- [Output Self-closing XML tags](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-output-self-closing-xml-tags)

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-insert-attribute)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.4/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook)

<!-- document id=303f6b39796467e5d7485142dd2e32cbebe08568ee87e537e264b8f9d69035a6 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook-format-according-to-type.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Format According to Type

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example applies changes to the keys in an object, depending on the type of their
corresponding values. When the element is an array, the keys are pluralized. When it’s a number,
they are set to camel case. In any other case they are capitalized.

The example uses:

- `mapObject` to go through each element in the payload.

- `if` to check that an element is of a given type.

- `camelize` from the String library to apply a camel case format to strings (all words stringed
  together, using upper case letters to mark separations).

- `capitalize` from the String library to apply a capitalized format to strings (all words are
  separate and start with an upper case letter).

- `pluralize` from the String library to change singular words into plural.

DataWeave Script:

```dataweave
%dw 2.0
import * from dw::core::Strings
output application/json
---
payload mapObject ((elementValue, elementKey) -> {
  (if (elementValue is Array)
      pluralize(elementKey)
    else if(elementValue is Number)
      camelize(elementKey)
    else capitalize(elementKey)) : elementValue
})
```

Input JSON Payload:

```json
{
  "VersionNo": 1.6,
  "StoreOfOrigin": "SFO",
  "Item": [
    {
      "ID": "34546315801",
      "DeliveryMethod": "AIR",
      "Quantity": 8
    },
    {
      "ID": "56722087289",
      "Boxes": 3,
      "DeliveryMethod": "GROUND",
      "Quantity": 2
    }
  ]
}
```

Output JSON:

```json
{
  "versionNo": 1.6,
  "Store Of Origin": "SFO",
  "Items": [
    {
      "ID": "34546315801",
      "DeliveryMethod": "AIR",
      "Quantity": 8
    },
    {
      "ID": "56722087289",
      "Boxes": 3,
      "DeliveryMethod": "GROUND",
      "Quantity": 2
    }
  ]
}
```

## Related Examples

- [Output Self-closing XML tags](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-output-self-closing-xml-tags)

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-insert-attribute)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.6/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook)

<!-- document id=3503cdf28e83e58da77ad3ced81d6ad4c3ad32a0fd72facefd20dd80009a5b37 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook-format-according-to-type.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Format According to Type

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example applies changes to the keys in an object, depending on the type of their
corresponding values. When the element is an array, the keys are pluralized. When it’s a number,
they are set to camel case. In any other case they are capitalized.

The example uses:

- `mapObject` to go through each element in the payload.

- `if` to check that an element is of a given type.

- `camelize` from the String library to apply a camel case format to strings (all words stringed
  together, using upper case letters to mark separations).

- `capitalize` from the String library to apply a capitalized format to strings (all words are
  separate and start with an upper case letter).

- `pluralize` from the String library to change singular words into plural.

DataWeave Script:

```dataweave
%dw 2.0
import * from dw::core::Strings
output application/json
---
payload mapObject ((elementValue, elementKey) -> {
  (if (elementValue is Array)
      pluralize(elementKey)
    else if(elementValue is Number)
      camelize(elementKey)
    else capitalize(elementKey)) : elementValue
})
```

Input JSON Payload:

```json
{
  "VersionNo": 1.6,
  "StoreOfOrigin": "SFO",
  "Item": [
    {
      "ID": "34546315801",
      "DeliveryMethod": "AIR",
      "Quantity": 8
    },
    {
      "ID": "56722087289",
      "Boxes": 3,
      "DeliveryMethod": "GROUND",
      "Quantity": 2
    }
  ]
}
```

Output JSON:

```json
{
  "versionNo": 1.6,
  "Store Of Origin": "SFO",
  "Items": [
    {
      "ID": "34546315801",
      "DeliveryMethod": "AIR",
      "Quantity": 8
    },
    {
      "ID": "56722087289",
      "Boxes": 3,
      "DeliveryMethod": "GROUND",
      "Quantity": 2
    }
  ]
}
```

## Related Examples

- [Output Self-closing XML tags](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-output-self-closing-xml-tags)

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-insert-attribute)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.9/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook)

<!-- document id=cd7e0ca1e0bdbbbdeca14dbe45dc4bd37dcde80c939d52f0ee4e58c9860715db url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook-format-according-to-type.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Format According to Type

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example applies changes to the keys in an object, depending on the type of their
corresponding values. When the element is an array, the keys are pluralized. When it’s a number,
they are set to camel case. In any other case they are capitalized.

The example uses:

- `mapObject` to go through each element in the payload.

- `if` to check that an element is of a given type.

- `camelize` from the String library to apply a camel case format to strings (all words stringed
  together, using upper case letters to mark separations).

- `capitalize` from the String library to apply a capitalized format to strings (all words are
  separate and start with an upper case letter).

- `pluralize` from the String library to change singular words into plural.

DataWeave Script:

```dataweave
%dw 2.0
import * from dw::core::Strings
output application/json
---
payload mapObject ((elementValue, elementKey) -> {
  (if (elementValue is Array)
      pluralize(elementKey)
    else if(elementValue is Number)
      camelize(elementKey)
    else capitalize(elementKey)) : elementValue
})
```

Input JSON Payload:

```json
{
  "VersionNo": 1.6,
  "StoreOfOrigin": "SFO",
  "Item": [
    {
      "ID": "34546315801",
      "DeliveryMethod": "AIR",
      "Quantity": 8
    },
    {
      "ID": "56722087289",
      "Boxes": 3,
      "DeliveryMethod": "GROUND",
      "Quantity": 2
    }
  ]
}
```

Output JSON:

```json
{
  "versionNo": 1.6,
  "Store Of Origin": "SFO",
  "Items": [
    {
      "ID": "34546315801",
      "DeliveryMethod": "AIR",
      "Quantity": 8
    },
    {
      "ID": "56722087289",
      "Boxes": 3,
      "DeliveryMethod": "GROUND",
      "Quantity": 2
    }
  ]
}
```

## Related Examples

- [Output Self-closing XML tags](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-output-self-closing-xml-tags)

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-insert-attribute)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook)

<!-- document id=f5c62489f07f57c87025e18a0d3a315ae4acec64b228fe504ac54fdafb25d44a url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook-format-dates.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, date, time
---

# Format Dates and Times

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You can use DataWeave to change the format of date and time input.

## Change Date and Time Formats

You can combine formatting characters, such as `MM` and `dd`, to write supported date and time
formats. The example uses the `as` operator to write the dates and times as a string.

Transform

```dataweave
%dw 2.0
output application/json
---
{
  formattedDate: |2020-10-01T23:57:59| as String {format: "uuuu-MM-dd"},
  formattedTime: |2020-10-01T23:57:59| as String {format: "KK:mm:ss a"},
  formattedDateTime: |2020-10-01T23:57:59| as String {format: "KK:mm:ss a, MMMM dd, uuuu"}
}
```

Output

```json
{
  "formattedDate": "2020-10-01",
  "formattedTime": "11:57:59 PM",
  "formattedDateTime": "11:57:59 PM, October 01, 2020"
}
```

## Create a Custom Date Format as a DataWeave Type

For multiple, similar conversions in your script, you can define a custom type as a directive in the
header and set each date to that type. Names of DataWeave type are case-sensitive.

DataWeave Script

```dataweave
%dw 2.0
output application/json
type Mydate = String { format: "uuuu/MM/dd" }
---
{
  formattedDate1: |2019-10-01T23:57:59| as Mydate,
  formattedDate2: |2020-07-06T08:53:15| as Mydate
}
```

Output

```json
{
  "formattedDate1": "2019/10/01",
  "formattedDate2": "2020/07/06"
}
```

## Use Date and Time Formatting Characters

DataWeave supports the use of formatting characters, such as the `u` (for the year), `M`, and `d` in
the date format `uuuu-MM-dd`. These characters are based on the Java 8 `java.time.format` package.

The following example formats the output of the `now` DataWeave function to show supported letters:

DataWeave Script

```dataweave
%dw 2.0
var myDateTime = ("2020-11-10T13:44:12.283-08:00" as DateTime)
output application/json
---
{
    "dateTime" : myDateTime,
    "era-G" : myDateTime as String { format: "G"},
    "year-u" : myDateTime as String {format: "u"},
    "year-uu" : myDateTime as String {format: "uu"},
  //y is for use with the era (BCE or CE). Generally, use u, instead.
    "year-y" : myDateTime as String { format: "y"},
    "year-yy" : myDateTime as String { format: "yy"},
    "dayOfYear-D" : myDateTime as String { format: "D"},
    "monthOfYear-MMMM": myDateTime as String { format: "MMMM"},
    "monthOfYear-MMM": myDateTime as String { format: "MMM"},
    "monthOfYear-MM": myDateTime as String { format: "MM"},
    "monthOfYear-M": myDateTime as String { format: "M"},
    "monthOfYear-LL": myDateTime as String { format: "LL"},
    "monthOfYear-L": myDateTime as String { format: "L"},
    "dayOfMonth-d" : myDateTime as String {format: "d"},
    "quarterOfYear-qqq" : myDateTime as String {format: "qqq"},
    "quarterOfYear-qq" : myDateTime as String {format: "qq"},
    "quarterOfYear-q" : myDateTime as String {format: "q"},
    "quarterOfYear-QQQQ" : myDateTime as String {format: "QQQQ"},
    "quarterOfYear-QQQ" : myDateTime as String {format: "QQQ"},
    "quarterOfYear-QQ" : myDateTime as String {format: "QQ"},
    "quarterOfYear-Q" : myDateTime as String {format: "Q"},
  // Understand "Y" and "YY" thoroughly before using it.
    "weekBasedYear-YY" : myDateTime as String { format: "YY"},
    "weekBasedYear-Y" : myDateTime as String { format: "Y"},
    "weekInYear-w" : myDateTime as String {format: "w"},
    "weekInMonth-W" : myDateTime as String {format: "W"},
    "dayOfWeekAbbreviatedName-E" : myDateTime as String {format: "E"},
    "dayOfWeekFullName-EEEE" : myDateTime as String {format: "EEEE"},
    "localizedDayOfWeek-eeee" : myDateTime as String {format: "eeee"},
    "localizedDayOfWeek-eee" : myDateTime as String {format: "eee"},
    "localizedDayOfWeek-ee" : myDateTime as String {format: "ee"},
    "localizedDayOfWeek-e" : myDateTime as String {format: "e"},
    "localizedDayOfWeek-cccc" : myDateTime as String {format: "cccc"},
    "localizedDayOfWeek-ccc" : myDateTime as String {format: "ccc"},
    "localizedDayOfWeek-c" : myDateTime as String {format: "c"},
    "weekOfMonth-F" : myDateTime as String {format: "F"},
    "amORpm-a" : myDateTime as String {format: "a"},
  // "h" outputs 12 o'clock as 12. Other hours match "K" output.
    "hourOfDay1to12-h" : myDateTime as String {format: "h"},
  // "K" outputs 12 o'clock as 0. Other hours match "h" output.
    "hourOfDay0to11-K" : myDateTime as String {format: "K"},
    "clockHourOfAmPm-k" : myDateTime as String {format: "k"},
    "hourOfDay0to23-H" : myDateTime as String {format: "H"},
    "minuteOfHour-m" : myDateTime as String {format: "m"},
    "secondOfMinute-s" : myDateTime as String {format: "s"},
    "fractionOfSecond-S" : myDateTime as String {format: "S"},
    "millisecondOfDay-A" : myDateTime as String {format: "A"},
    "nanosecondCountOfSecond-n" : myDateTime as String {format: "n"},
    "nanosecondCountOfDay-N" : myDateTime as String {format: "N"},
    "timeZoneID-VV" : myDateTime as String {format: "VV"},
    "timeZoneName-zz" : myDateTime as String {format: "zz"},
    "localizedZoneOffset-zzz" : myDateTime as String {format: "zzz"},
    "localizedZoneOffset-O" : myDateTime as String {format: "O"},
    "timeZoneOffsetZforZero-XXX" : myDateTime as String {format: "XXX"},
    "timeZoneOffsetZforZero-XX" : myDateTime as String {format: "XX"},
    "timeZoneOffsetZforZero-X" : myDateTime as String {format: "X"},
    "timeZoneOffset-xxx" : myDateTime as String {format: "xxx"},
    "timeZoneOffset-xx" : myDateTime as String {format: "xx"},
    "timeZoneOffset-x" : myDateTime as String {format: "x"},
    "timeZoneOffset-Z" : myDateTime as String {format: "Z"}
 }
```

Notice the use of the syntax to format the date or time.

Output

```json
{
  "dateTime": "2020-11-10T13:44:12.283-08:00",
  "era-G": "AD",
  "year-u": "2020",
  "year-uu": "20",
  "year-y": "2020",
  "year-yy": "20",
  "dayOfYear-D": "315",
  "monthOfYear-MMMM": "November",
  "monthOfYear-MMM": "Nov",
  "monthOfYear-MM": "11",
  "monthOfYear-M": "11",
  "monthOfYear-LL": "11",
  "monthOfYear-L": "11",
  "dayOfMonth-d": "10",
  "quarterOfYear-qqq": "4",
  "quarterOfYear-qq": "04",
  "quarterOfYear-q": "4",
  "quarterOfYear-QQQQ": "4th quarter",
  "quarterOfYear-QQQ": "Q4",
  "quarterOfYear-QQ": "04",
  "quarterOfYear-Q": "4",
  "weekBasedYear-YY": "20",
  "weekBasedYear-Y": "2020",
  "weekInYear-w": "46",
  "weekInMonth-W": "2",
  "dayOfWeekAbbreviatedName-E": "Tue",
  "dayOfWeekFullName-EEEE": "Tuesday",
  "localizedDayOfWeek-eeee": "Tuesday",
  "localizedDayOfWeek-eee": "Tue",
  "localizedDayOfWeek-ee": "03",
  "localizedDayOfWeek-e": "3",
  "localizedDayOfWeek-cccc": "Tuesday",
  "localizedDayOfWeek-ccc": "Tue",
  "localizedDayOfWeek-c": "3",
  "weekOfMonth-F": "3",
  "amORpm-a": "PM",
  "hourOfDay1to12-h": "1",
  "hourOfDay0to11-K": "1",
  "clockHourOfAmPm-k": "13",
  "hourOfDay0to23-H": "13",
  "minuteOfHour-m": "44",
  "secondOfMinute-s": "12",
  "fractionOfSecond-S": "2",
  "millisecondOfDay-A": "49452283",
  "nanosecondCountOfSecond-n": "283000000",
  "nanosecondCountOfDay-N": "49452283000000",
  "timeZoneID-VV": "-08:00",
  "timeZoneName-zz": "-08:00",
  "localizedZoneOffset-zzz": "-08:00",
  "localizedZoneOffset-O": "GMT-8",
  "timeZoneOffsetZforZero-XXX": "-08:00",
  "timeZoneOffsetZforZero-XX": "-0800",
  "timeZoneOffsetZforZero-X": "-08",
  "timeZoneOffset-xxx": "-08:00",
  "timeZoneOffset-xx": "-0800",
  "timeZoneOffset-x": "-08",
  "timeZoneOffset-Z": "-0800"
}
```

## Related Examples

- [Parse Dates with DataWeave](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-parse-dates)

- [Add and Subtract Time](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-add-and-subtract-time)

- [Change a Time Zone](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-change-time-zone)

## See Also

- [Date and Time (dw::Core Types)](https://docs.mulesoft.com/dataweave/2.11/dataweave-types#dw_type_dates)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.11/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook)

<!-- document id=5bf9ddbf39b62e21b16730ae3b4c000fb0cbeed0580e75a45fb7ca7afe135e42 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook-format-dates.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, date, time
---

# Format Dates and Times

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You can use DataWeave to change the format of date and time input.

## Change Date and Time Formats

You can combine formatting characters, such as `MM` and `dd`, to write supported date and time
formats. The example uses the `as` operator to write the dates and times as a string.

Transform

```dataweave
%dw 2.0
output application/json
---
{
  formattedDate: |2020-10-01T23:57:59| as String {format: "uuuu-MM-dd"},
  formattedTime: |2020-10-01T23:57:59| as String {format: "KK:mm:ss a"},
  formattedDateTime: |2020-10-01T23:57:59| as String {format: "KK:mm:ss a, MMMM dd, uuuu"}
}
```

Output

```json
{
  "formattedDate": "2020-10-01",
  "formattedTime": "11:57:59 PM",
  "formattedDateTime": "11:57:59 PM, October 01, 2020"
}
```

## Create a Custom Date Format as a DataWeave Type

For multiple, similar conversions in your script, you can define a custom type as a directive in the
header and set each date to that type. Names of DataWeave type are case-sensitive.

DataWeave Script

```dataweave
%dw 2.0
output application/json
type Mydate = String { format: "uuuu/MM/dd" }
---
{
  formattedDate1: |2019-10-01T23:57:59| as Mydate,
  formattedDate2: |2020-07-06T08:53:15| as Mydate
}
```

Output

```json
{
  "formattedDate1": "2019/10/01",
  "formattedDate2": "2020/07/06"
}
```

## Use Date and Time Formatting Characters

DataWeave supports the use of formatting characters, such as the `u` (for the year), `M`, and `d` in
the date format `uuuu-MM-dd`. These characters are based on the Java 8 `java.time.format` package.

The following example formats the output of the `now` DataWeave function to show supported letters:

DataWeave Script

```dataweave
%dw 2.0
var myDateTime = ("2020-11-10T13:44:12.283-08:00" as DateTime)
output application/json
---
{
    "dateTime" : myDateTime,
    "era-G" : myDateTime as String { format: "G"},
    "year-u" : myDateTime as String {format: "u"},
    "year-uu" : myDateTime as String {format: "uu"},
  //y is for use with the era (BCE or CE). Generally, use u, instead.
    "year-y" : myDateTime as String { format: "y"},
    "year-yy" : myDateTime as String { format: "yy"},
    "dayOfYear-D" : myDateTime as String { format: "D"},
    "monthOfYear-MMMM": myDateTime as String { format: "MMMM"},
    "monthOfYear-MMM": myDateTime as String { format: "MMM"},
    "monthOfYear-MM": myDateTime as String { format: "MM"},
    "monthOfYear-M": myDateTime as String { format: "M"},
    "monthOfYear-LL": myDateTime as String { format: "LL"},
    "monthOfYear-L": myDateTime as String { format: "L"},
    "dayOfMonth-d" : myDateTime as String {format: "d"},
    "quarterOfYear-qqq" : myDateTime as String {format: "qqq"},
    "quarterOfYear-qq" : myDateTime as String {format: "qq"},
    "quarterOfYear-q" : myDateTime as String {format: "q"},
    "quarterOfYear-QQQQ" : myDateTime as String {format: "QQQQ"},
    "quarterOfYear-QQQ" : myDateTime as String {format: "QQQ"},
    "quarterOfYear-QQ" : myDateTime as String {format: "QQ"},
    "quarterOfYear-Q" : myDateTime as String {format: "Q"},
  // Understand "Y" and "YY" thoroughly before using it.
    "weekBasedYear-YY" : myDateTime as String { format: "YY"},
    "weekBasedYear-Y" : myDateTime as String { format: "Y"},
    "weekInYear-w" : myDateTime as String {format: "w"},
    "weekInMonth-W" : myDateTime as String {format: "W"},
    "dayOfWeekAbbreviatedName-E" : myDateTime as String {format: "E"},
    "dayOfWeekFullName-EEEE" : myDateTime as String {format: "EEEE"},
    "localizedDayOfWeek-eeee" : myDateTime as String {format: "eeee"},
    "localizedDayOfWeek-eee" : myDateTime as String {format: "eee"},
    "localizedDayOfWeek-ee" : myDateTime as String {format: "ee"},
    "localizedDayOfWeek-e" : myDateTime as String {format: "e"},
    "localizedDayOfWeek-cccc" : myDateTime as String {format: "cccc"},
    "localizedDayOfWeek-ccc" : myDateTime as String {format: "ccc"},
    "localizedDayOfWeek-c" : myDateTime as String {format: "c"},
    "weekOfMonth-F" : myDateTime as String {format: "F"},
    "amORpm-a" : myDateTime as String {format: "a"},
  // "h" outputs 12 o'clock as 12. Other hours match "K" output.
    "hourOfDay1to12-h" : myDateTime as String {format: "h"},
  // "K" outputs 12 o'clock as 0. Other hours match "h" output.
    "hourOfDay0to11-K" : myDateTime as String {format: "K"},
    "clockHourOfAmPm-k" : myDateTime as String {format: "k"},
    "hourOfDay0to23-H" : myDateTime as String {format: "H"},
    "minuteOfHour-m" : myDateTime as String {format: "m"},
    "secondOfMinute-s" : myDateTime as String {format: "s"},
    "fractionOfSecond-S" : myDateTime as String {format: "S"},
    "millisecondOfDay-A" : myDateTime as String {format: "A"},
    "nanosecondCountOfSecond-n" : myDateTime as String {format: "n"},
    "nanosecondCountOfDay-N" : myDateTime as String {format: "N"},
    "timeZoneID-VV" : myDateTime as String {format: "VV"},
    "timeZoneName-zz" : myDateTime as String {format: "zz"},
    "localizedZoneOffset-zzz" : myDateTime as String {format: "zzz"},
    "localizedZoneOffset-O" : myDateTime as String {format: "O"},
    "timeZoneOffsetZforZero-XXX" : myDateTime as String {format: "XXX"},
    "timeZoneOffsetZforZero-XX" : myDateTime as String {format: "XX"},
    "timeZoneOffsetZforZero-X" : myDateTime as String {format: "X"},
    "timeZoneOffset-xxx" : myDateTime as String {format: "xxx"},
    "timeZoneOffset-xx" : myDateTime as String {format: "xx"},
    "timeZoneOffset-x" : myDateTime as String {format: "x"},
    "timeZoneOffset-Z" : myDateTime as String {format: "Z"}
 }
```

Notice the use of the syntax to format the date or time.

Output

```json
{
  "dateTime": "2020-11-10T13:44:12.283-08:00",
  "era-G": "AD",
  "year-u": "2020",
  "year-uu": "20",
  "year-y": "2020",
  "year-yy": "20",
  "dayOfYear-D": "315",
  "monthOfYear-MMMM": "November",
  "monthOfYear-MMM": "Nov",
  "monthOfYear-MM": "11",
  "monthOfYear-M": "11",
  "monthOfYear-LL": "11",
  "monthOfYear-L": "11",
  "dayOfMonth-d": "10",
  "quarterOfYear-qqq": "4",
  "quarterOfYear-qq": "04",
  "quarterOfYear-q": "4",
  "quarterOfYear-QQQQ": "4th quarter",
  "quarterOfYear-QQQ": "Q4",
  "quarterOfYear-QQ": "04",
  "quarterOfYear-Q": "4",
  "weekBasedYear-YY": "20",
  "weekBasedYear-Y": "2020",
  "weekInYear-w": "46",
  "weekInMonth-W": "2",
  "dayOfWeekAbbreviatedName-E": "Tue",
  "dayOfWeekFullName-EEEE": "Tuesday",
  "localizedDayOfWeek-eeee": "Tuesday",
  "localizedDayOfWeek-eee": "Tue",
  "localizedDayOfWeek-ee": "03",
  "localizedDayOfWeek-e": "3",
  "localizedDayOfWeek-cccc": "Tuesday",
  "localizedDayOfWeek-ccc": "Tue",
  "localizedDayOfWeek-c": "3",
  "weekOfMonth-F": "3",
  "amORpm-a": "PM",
  "hourOfDay1to12-h": "1",
  "hourOfDay0to11-K": "1",
  "clockHourOfAmPm-k": "13",
  "hourOfDay0to23-H": "13",
  "minuteOfHour-m": "44",
  "secondOfMinute-s": "12",
  "fractionOfSecond-S": "2",
  "millisecondOfDay-A": "49452283",
  "nanosecondCountOfSecond-n": "283000000",
  "nanosecondCountOfDay-N": "49452283000000",
  "timeZoneID-VV": "-08:00",
  "timeZoneName-zz": "-08:00",
  "localizedZoneOffset-zzz": "-08:00",
  "localizedZoneOffset-O": "GMT-8",
  "timeZoneOffsetZforZero-XXX": "-08:00",
  "timeZoneOffsetZforZero-XX": "-0800",
  "timeZoneOffsetZforZero-X": "-08",
  "timeZoneOffset-xxx": "-08:00",
  "timeZoneOffset-xx": "-0800",
  "timeZoneOffset-x": "-08",
  "timeZoneOffset-Z": "-0800"
}
```

## Related Examples

- [Parse Dates with DataWeave](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-parse-dates)

- [Add and Subtract Time](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-add-and-subtract-time)

- [Change a Time Zone](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-change-time-zone)

## See Also

- [Date and Time (dw::Core Types)](https://docs.mulesoft.com/dataweave/2.12/dataweave-types#dw_type_dates)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.12/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook)

<!-- document id=645a66186290010556032dee0b8da7c100a92942bad85500dd9c670169d27434 url=/mulesoft/current/en-us/dataweave/2.3/dataweave-cookbook-format-dates.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, date, time
---

# Format Dates and Times

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You can use DataWeave to change the format of date and time input.

## Change Date and Time Formats

You can combine formatting characters, such as `MM` and `dd`, to write supported date and time
formats. The example uses the `as` operator to write the dates and times as a string.

Transform

```dataweave
%dw 2.0
output application/json
---
{
  formattedDate: |2020-10-01T23:57:59| as String {format: "uuuu-MM-dd"},
  formattedTime: |2020-10-01T23:57:59| as String {format: "KK:mm:ss a"},
  formattedDateTime: |2020-10-01T23:57:59| as String {format: "KK:mm:ss a, MMMM dd, uuuu"}
}
```

Output

```json
{
  "formattedDate": "2020-10-01",
  "formattedTime": "11:57:59 PM",
  "formattedDateTime": "11:57:59 PM, October 01, 2020"
}
```

## Create a Custom Date Format as a DataWeave Type

For multiple, similar conversions in your script, you can define a custom type as a directive in the
header and set each date to that type. Names of DataWeave type are case-sensitive.

DataWeave Script

```dataweave
%dw 2.0
output application/json
type Mydate = String { format: "uuuu/MM/dd" }
---
{
  formattedDate1: |2019-10-01T23:57:59| as Mydate,
  formattedDate2: |2020-07-06T08:53:15| as Mydate
}
```

Output

```json
{
  "formattedDate1": "2019/10/01",
  "formattedDate2": "2020/07/06"
}
```

## Use Date and Time Formatting Characters

DataWeave supports the use of formatting characters, such as the `u` (for the year), `M`, and `d` in
the date format `uuuu-MM-dd`. These characters are based on the Java 8 `java.time.format` package.

The following example formats the output of the `now` DataWeave function to show supported letters:

DataWeave Script

```dataweave
%dw 2.0
var myDateTime = ("2020-11-10T13:44:12.283-08:00" as DateTime)
output application/json
---
{
    "dateTime" : myDateTime,
    "era-G" : myDateTime as String { format: "G"},
    "year-u" : myDateTime as String {format: "u"},
    "year-uu" : myDateTime as String {format: "uu"},
  //y is for use with the era (BCE or CE). Generally, use u, instead.
    "year-y" : myDateTime as String { format: "y"},
    "year-yy" : myDateTime as String { format: "yy"},
    "dayOfYear-D" : myDateTime as String { format: "D"},
    "monthOfYear-MMMM": myDateTime as String { format: "MMMM"},
    "monthOfYear-MMM": myDateTime as String { format: "MMM"},
    "monthOfYear-MM": myDateTime as String { format: "MM"},
    "monthOfYear-M": myDateTime as String { format: "M"},
    "monthOfYear-LL": myDateTime as String { format: "LL"},
    "monthOfYear-L": myDateTime as String { format: "L"},
    "dayOfMonth-d" : myDateTime as String {format: "d"},
    "quarterOfYear-qqq" : myDateTime as String {format: "qqq"},
    "quarterOfYear-qq" : myDateTime as String {format: "qq"},
    "quarterOfYear-q" : myDateTime as String {format: "q"},
    "quarterOfYear-QQQQ" : myDateTime as String {format: "QQQQ"},
    "quarterOfYear-QQQ" : myDateTime as String {format: "QQQ"},
    "quarterOfYear-QQ" : myDateTime as String {format: "QQ"},
    "quarterOfYear-Q" : myDateTime as String {format: "Q"},
  // Understand "Y" and "YY" thoroughly before using it.
    "weekBasedYear-YY" : myDateTime as String { format: "YY"},
    "weekBasedYear-Y" : myDateTime as String { format: "Y"},
    "weekInYear-w" : myDateTime as String {format: "w"},
    "weekInMonth-W" : myDateTime as String {format: "W"},
    "dayOfWeekAbbreviatedName-E" : myDateTime as String {format: "E"},
    "dayOfWeekFullName-EEEE" : myDateTime as String {format: "EEEE"},
    "localizedDayOfWeek-eeee" : myDateTime as String {format: "eeee"},
    "localizedDayOfWeek-eee" : myDateTime as String {format: "eee"},
    "localizedDayOfWeek-ee" : myDateTime as String {format: "ee"},
    "localizedDayOfWeek-e" : myDateTime as String {format: "e"},
    "localizedDayOfWeek-cccc" : myDateTime as String {format: "cccc"},
    "localizedDayOfWeek-ccc" : myDateTime as String {format: "ccc"},
    "localizedDayOfWeek-c" : myDateTime as String {format: "c"},
    "weekOfMonth-F" : myDateTime as String {format: "F"},
    "amORpm-a" : myDateTime as String {format: "a"},
  // "h" outputs 12 o'clock as 12. Other hours match "K" output.
    "hourOfDay1to12-h" : myDateTime as String {format: "h"},
  // "K" outputs 12 o'clock as 0. Other hours match "h" output.
    "hourOfDay0to11-K" : myDateTime as String {format: "K"},
    "clockHourOfAmPm-k" : myDateTime as String {format: "k"},
    "hourOfDay0to23-H" : myDateTime as String {format: "H"},
    "minuteOfHour-m" : myDateTime as String {format: "m"},
    "secondOfMinute-s" : myDateTime as String {format: "s"},
    "fractionOfSecond-S" : myDateTime as String {format: "S"},
    "millisecondOfDay-A" : myDateTime as String {format: "A"},
    "nanosecondCountOfSecond-n" : myDateTime as String {format: "n"},
    "nanosecondCountOfDay-N" : myDateTime as String {format: "N"},
    "timeZoneID-VV" : myDateTime as String {format: "VV"},
    "timeZoneName-zz" : myDateTime as String {format: "zz"},
    "localizedZoneOffset-zzz" : myDateTime as String {format: "zzz"},
    "localizedZoneOffset-O" : myDateTime as String {format: "O"},
    "timeZoneOffsetZforZero-XXX" : myDateTime as String {format: "XXX"},
    "timeZoneOffsetZforZero-XX" : myDateTime as String {format: "XX"},
    "timeZoneOffsetZforZero-X" : myDateTime as String {format: "X"},
    "timeZoneOffset-xxx" : myDateTime as String {format: "xxx"},
    "timeZoneOffset-xx" : myDateTime as String {format: "xx"},
    "timeZoneOffset-x" : myDateTime as String {format: "x"},
    "timeZoneOffset-Z" : myDateTime as String {format: "Z"}
 }
```

Notice the use of the syntax to format the date or time.

Output

{ "dateTime": "2020-11-10T13:44:12.283-08:00", "era-G": "AD", "year-u": "2020", "year-uu": "20",
"year-y": "2020", "year-yy": "20", "dayOfYear-D": "315", "monthOfYear-MMMM": "November",
"monthOfYear-MMM": "Nov", "monthOfYear-MM": "11", "monthOfYear-M": "11", "monthOfYear-LL": "11",
"monthOfYear-L": "11", "dayOfMonth-d": "10", "quarterOfYear-qqq": "4", "quarterOfYear-qq": "04",
"quarterOfYear-q": "4", "quarterOfYear-QQQQ": "4th quarter", "quarterOfYear-QQQ": "Q4",
"quarterOfYear-QQ": "04", "quarterOfYear-Q": "4", "weekBasedYear-YY": "20", "weekBasedYear-Y":
"2020", "weekInYear-w": "46", "weekInMonth-W": "2", "dayOfWeekAbbreviatedName-E": "Tue",
"dayOfWeekFullName-EEEE": "Tuesday", "localizedDayOfWeek-eeee": "Tuesday", "localizedDayOfWeek-eee":
"Tue", "localizedDayOfWeek-ee": "03", "localizedDayOfWeek-e": "3", "localizedDayOfWeek-cccc":
"Tuesday", "localizedDayOfWeek-ccc": "Tue", "localizedDayOfWeek-c": "3", "weekOfMonth-F": "3",
"amORpm-a": "PM", "hourOfDay1to12-h": "1", "hourOfDay0to11-K": "1", "clockHourOfAmPm-k": "13",
"hourOfDay0to23-H": "13", "minuteOfHour-m": "44", "secondOfMinute-s": "12", "fractionOfSecond-S":
"2", "millisecondOfDay-A": "49452283", "nanosecondCountOfSecond-n": "283000000",
"nanosecondCountOfDay-N": "49452283000000", "timeZoneID-VV": "-08:00", "timeZoneName-zz": "-08:00",
"localizedZoneOffset-zzz": "-08:00", "localizedZoneOffset-O": "GMT-8", "timeZoneOffsetZforZero-XXX":
"-08:00", "timeZoneOffsetZforZero-XX": "-0800", "timeZoneOffsetZforZero-X": "-08",
"timeZoneOffset-xxx": "-08:00", "timeZoneOffset-xx": "-0800", "timeZoneOffset-x": "-08",
"timeZoneOffset-Z": "-0800" }

## Related Examples

- [Parse Dates with DataWeave](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-parse-dates)

- [Add and Subtract Time](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-add-and-subtract-time)

- [Change a Time Zone](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-change-time-zone)

## See Also

- [Date and Time (dw::Core Types)](https://docs.mulesoft.com/dataweave/2.3/dataweave-types#dw_type_dates)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.3/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook)

<!-- document id=e1da64e40e175bd03ee112551e5ae6578fc57500902eb5b13fa4911820c4acbc url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook-format-dates.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, date, time
---

# Format Dates and Times

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You can use DataWeave to change the format of date and time input.

## Change Date and Time Formats

You can combine formatting characters, such as `MM` and `dd`, to write supported date and time
formats. The example uses the `as` operator to write the dates and times as a string.

Transform

```dataweave
%dw 2.0
output application/json
---
{
  formattedDate: |2020-10-01T23:57:59| as String {format: "uuuu-MM-dd"},
  formattedTime: |2020-10-01T23:57:59| as String {format: "KK:mm:ss a"},
  formattedDateTime: |2020-10-01T23:57:59| as String {format: "KK:mm:ss a, MMMM dd, uuuu"}
}
```

Output

```json
{
  "formattedDate": "2020-10-01",
  "formattedTime": "11:57:59 PM",
  "formattedDateTime": "11:57:59 PM, October 01, 2020"
}
```

## Create a Custom Date Format as a DataWeave Type

For multiple, similar conversions in your script, you can define a custom type as a directive in the
header and set each date to that type. Names of DataWeave type are case-sensitive.

DataWeave Script

```dataweave
%dw 2.0
output application/json
type Mydate = String { format: "uuuu/MM/dd" }
---
{
  formattedDate1: |2019-10-01T23:57:59| as Mydate,
  formattedDate2: |2020-07-06T08:53:15| as Mydate
}
```

Output

```json
{
  "formattedDate1": "2019/10/01",
  "formattedDate2": "2020/07/06"
}
```

## Use Date and Time Formatting Characters

DataWeave supports the use of formatting characters, such as the `u` (for the year), `M`, and `d` in
the date format `uuuu-MM-dd`. These characters are based on the Java 8 `java.time.format` package.

The following example formats the output of the `now` DataWeave function to show supported letters:

DataWeave Script

```dataweave
%dw 2.0
var myDateTime = ("2020-11-10T13:44:12.283-08:00" as DateTime)
output application/json
---
{
    "dateTime" : myDateTime,
    "era-G" : myDateTime as String { format: "G"},
    "year-u" : myDateTime as String {format: "u"},
    "year-uu" : myDateTime as String {format: "uu"},
  //y is for use with the era (BCE or CE). Generally, use u, instead.
    "year-y" : myDateTime as String { format: "y"},
    "year-yy" : myDateTime as String { format: "yy"},
    "dayOfYear-D" : myDateTime as String { format: "D"},
    "monthOfYear-MMMM": myDateTime as String { format: "MMMM"},
    "monthOfYear-MMM": myDateTime as String { format: "MMM"},
    "monthOfYear-MM": myDateTime as String { format: "MM"},
    "monthOfYear-M": myDateTime as String { format: "M"},
    "monthOfYear-LL": myDateTime as String { format: "LL"},
    "monthOfYear-L": myDateTime as String { format: "L"},
    "dayOfMonth-d" : myDateTime as String {format: "d"},
    "quarterOfYear-qqq" : myDateTime as String {format: "qqq"},
    "quarterOfYear-qq" : myDateTime as String {format: "qq"},
    "quarterOfYear-q" : myDateTime as String {format: "q"},
    "quarterOfYear-QQQQ" : myDateTime as String {format: "QQQQ"},
    "quarterOfYear-QQQ" : myDateTime as String {format: "QQQ"},
    "quarterOfYear-QQ" : myDateTime as String {format: "QQ"},
    "quarterOfYear-Q" : myDateTime as String {format: "Q"},
  // Understand "Y" and "YY" thoroughly before using it.
    "weekBasedYear-YY" : myDateTime as String { format: "YY"},
    "weekBasedYear-Y" : myDateTime as String { format: "Y"},
    "weekInYear-w" : myDateTime as String {format: "w"},
    "weekInMonth-W" : myDateTime as String {format: "W"},
    "dayOfWeekAbbreviatedName-E" : myDateTime as String {format: "E"},
    "dayOfWeekFullName-EEEE" : myDateTime as String {format: "EEEE"},
    "localizedDayOfWeek-eeee" : myDateTime as String {format: "eeee"},
    "localizedDayOfWeek-eee" : myDateTime as String {format: "eee"},
    "localizedDayOfWeek-ee" : myDateTime as String {format: "ee"},
    "localizedDayOfWeek-e" : myDateTime as String {format: "e"},
    "localizedDayOfWeek-cccc" : myDateTime as String {format: "cccc"},
    "localizedDayOfWeek-ccc" : myDateTime as String {format: "ccc"},
    "localizedDayOfWeek-c" : myDateTime as String {format: "c"},
    "weekOfMonth-F" : myDateTime as String {format: "F"},
    "amORpm-a" : myDateTime as String {format: "a"},
  // "h" outputs 12 o'clock as 12. Other hours match "K" output.
    "hourOfDay1to12-h" : myDateTime as String {format: "h"},
  // "K" outputs 12 o'clock as 0. Other hours match "h" output.
    "hourOfDay0to11-K" : myDateTime as String {format: "K"},
    "clockHourOfAmPm-k" : myDateTime as String {format: "k"},
    "hourOfDay0to23-H" : myDateTime as String {format: "H"},
    "minuteOfHour-m" : myDateTime as String {format: "m"},
    "secondOfMinute-s" : myDateTime as String {format: "s"},
    "fractionOfSecond-S" : myDateTime as String {format: "S"},
    "millisecondOfDay-A" : myDateTime as String {format: "A"},
    "nanosecondCountOfSecond-n" : myDateTime as String {format: "n"},
    "nanosecondCountOfDay-N" : myDateTime as String {format: "N"},
    "timeZoneID-VV" : myDateTime as String {format: "VV"},
    "timeZoneName-zz" : myDateTime as String {format: "zz"},
    "localizedZoneOffset-zzz" : myDateTime as String {format: "zzz"},
    "localizedZoneOffset-O" : myDateTime as String {format: "O"},
    "timeZoneOffsetZforZero-XXX" : myDateTime as String {format: "XXX"},
    "timeZoneOffsetZforZero-XX" : myDateTime as String {format: "XX"},
    "timeZoneOffsetZforZero-X" : myDateTime as String {format: "X"},
    "timeZoneOffset-xxx" : myDateTime as String {format: "xxx"},
    "timeZoneOffset-xx" : myDateTime as String {format: "xx"},
    "timeZoneOffset-x" : myDateTime as String {format: "x"},
    "timeZoneOffset-Z" : myDateTime as String {format: "Z"}
 }
```

Notice the use of the syntax to format the date or time.

Output

```json
{
  "dateTime": "2020-11-10T13:44:12.283-08:00",
  "era-G": "AD",
  "year-u": "2020",
  "year-uu": "20",
  "year-y": "2020",
  "year-yy": "20",
  "dayOfYear-D": "315",
  "monthOfYear-MMMM": "November",
  "monthOfYear-MMM": "Nov",
  "monthOfYear-MM": "11",
  "monthOfYear-M": "11",
  "monthOfYear-LL": "11",
  "monthOfYear-L": "11",
  "dayOfMonth-d": "10",
  "quarterOfYear-qqq": "4",
  "quarterOfYear-qq": "04",
  "quarterOfYear-q": "4",
  "quarterOfYear-QQQQ": "4th quarter",
  "quarterOfYear-QQQ": "Q4",
  "quarterOfYear-QQ": "04",
  "quarterOfYear-Q": "4",
  "weekBasedYear-YY": "20",
  "weekBasedYear-Y": "2020",
  "weekInYear-w": "46",
  "weekInMonth-W": "2",
  "dayOfWeekAbbreviatedName-E": "Tue",
  "dayOfWeekFullName-EEEE": "Tuesday",
  "localizedDayOfWeek-eeee": "Tuesday",
  "localizedDayOfWeek-eee": "Tue",
  "localizedDayOfWeek-ee": "03",
  "localizedDayOfWeek-e": "3",
  "localizedDayOfWeek-cccc": "Tuesday",
  "localizedDayOfWeek-ccc": "Tue",
  "localizedDayOfWeek-c": "3",
  "weekOfMonth-F": "3",
  "amORpm-a": "PM",
  "hourOfDay1to12-h": "1",
  "hourOfDay0to11-K": "1",
  "clockHourOfAmPm-k": "13",
  "hourOfDay0to23-H": "13",
  "minuteOfHour-m": "44",
  "secondOfMinute-s": "12",
  "fractionOfSecond-S": "2",
  "millisecondOfDay-A": "49452283",
  "nanosecondCountOfSecond-n": "283000000",
  "nanosecondCountOfDay-N": "49452283000000",
  "timeZoneID-VV": "-08:00",
  "timeZoneName-zz": "-08:00",
  "localizedZoneOffset-zzz": "-08:00",
  "localizedZoneOffset-O": "GMT-8",
  "timeZoneOffsetZforZero-XXX": "-08:00",
  "timeZoneOffsetZforZero-XX": "-0800",
  "timeZoneOffsetZforZero-X": "-08",
  "timeZoneOffset-xxx": "-08:00",
  "timeZoneOffset-xx": "-0800",
  "timeZoneOffset-x": "-08",
  "timeZoneOffset-Z": "-0800"
}
```

## Related Examples

- [Parse Dates with DataWeave](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-parse-dates)

- [Add and Subtract Time](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-add-and-subtract-time)

- [Change a Time Zone](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-change-time-zone)

## See Also

- [Date and Time (dw::Core Types)](https://docs.mulesoft.com/dataweave/2.4/dataweave-types#dw_type_dates)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.4/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook)

<!-- document id=cbea1a504cf1253d4a624b2d34a3f7161a29d5b2f5914cfb6dac36e77f4d8320 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook-format-dates.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, date, time
---

# Format Dates and Times

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You can use DataWeave to change the format of date and time input.

## Change Date and Time Formats

You can combine formatting characters, such as `MM` and `dd`, to write supported date and time
formats. The example uses the `as` operator to write the dates and times as a string.

Transform

```dataweave
%dw 2.0
output application/json
---
{
  formattedDate: |2020-10-01T23:57:59| as String {format: "uuuu-MM-dd"},
  formattedTime: |2020-10-01T23:57:59| as String {format: "KK:mm:ss a"},
  formattedDateTime: |2020-10-01T23:57:59| as String {format: "KK:mm:ss a, MMMM dd, uuuu"}
}
```

Output

```json
{
  "formattedDate": "2020-10-01",
  "formattedTime": "11:57:59 PM",
  "formattedDateTime": "11:57:59 PM, October 01, 2020"
}
```

## Create a Custom Date Format as a DataWeave Type

For multiple, similar conversions in your script, you can define a custom type as a directive in the
header and set each date to that type. Names of DataWeave type are case-sensitive.

DataWeave Script

```dataweave
%dw 2.0
output application/json
type Mydate = String { format: "uuuu/MM/dd" }
---
{
  formattedDate1: |2019-10-01T23:57:59| as Mydate,
  formattedDate2: |2020-07-06T08:53:15| as Mydate
}
```

Output

```json
{
  "formattedDate1": "2019/10/01",
  "formattedDate2": "2020/07/06"
}
```

## Use Date and Time Formatting Characters

DataWeave supports the use of formatting characters, such as the `u` (for the year), `M`, and `d` in
the date format `uuuu-MM-dd`. These characters are based on the Java 8 `java.time.format` package.

The following example formats the output of the `now` DataWeave function to show supported letters:

DataWeave Script

```dataweave
%dw 2.0
var myDateTime = ("2020-11-10T13:44:12.283-08:00" as DateTime)
output application/json
---
{
    "dateTime" : myDateTime,
    "era-G" : myDateTime as String { format: "G"},
    "year-u" : myDateTime as String {format: "u"},
    "year-uu" : myDateTime as String {format: "uu"},
  //y is for use with the era (BCE or CE). Generally, use u, instead.
    "year-y" : myDateTime as String { format: "y"},
    "year-yy" : myDateTime as String { format: "yy"},
    "dayOfYear-D" : myDateTime as String { format: "D"},
    "monthOfYear-MMMM": myDateTime as String { format: "MMMM"},
    "monthOfYear-MMM": myDateTime as String { format: "MMM"},
    "monthOfYear-MM": myDateTime as String { format: "MM"},
    "monthOfYear-M": myDateTime as String { format: "M"},
    "monthOfYear-LL": myDateTime as String { format: "LL"},
    "monthOfYear-L": myDateTime as String { format: "L"},
    "dayOfMonth-d" : myDateTime as String {format: "d"},
    "quarterOfYear-qqq" : myDateTime as String {format: "qqq"},
    "quarterOfYear-qq" : myDateTime as String {format: "qq"},
    "quarterOfYear-q" : myDateTime as String {format: "q"},
    "quarterOfYear-QQQQ" : myDateTime as String {format: "QQQQ"},
    "quarterOfYear-QQQ" : myDateTime as String {format: "QQQ"},
    "quarterOfYear-QQ" : myDateTime as String {format: "QQ"},
    "quarterOfYear-Q" : myDateTime as String {format: "Q"},
  // Understand "Y" and "YY" thoroughly before using it.
    "weekBasedYear-YY" : myDateTime as String { format: "YY"},
    "weekBasedYear-Y" : myDateTime as String { format: "Y"},
    "weekInYear-w" : myDateTime as String {format: "w"},
    "weekInMonth-W" : myDateTime as String {format: "W"},
    "dayOfWeekAbbreviatedName-E" : myDateTime as String {format: "E"},
    "dayOfWeekFullName-EEEE" : myDateTime as String {format: "EEEE"},
    "localizedDayOfWeek-eeee" : myDateTime as String {format: "eeee"},
    "localizedDayOfWeek-eee" : myDateTime as String {format: "eee"},
    "localizedDayOfWeek-ee" : myDateTime as String {format: "ee"},
    "localizedDayOfWeek-e" : myDateTime as String {format: "e"},
    "localizedDayOfWeek-cccc" : myDateTime as String {format: "cccc"},
    "localizedDayOfWeek-ccc" : myDateTime as String {format: "ccc"},
    "localizedDayOfWeek-c" : myDateTime as String {format: "c"},
    "weekOfMonth-F" : myDateTime as String {format: "F"},
    "amORpm-a" : myDateTime as String {format: "a"},
  // "h" outputs 12 o'clock as 12. Other hours match "K" output.
    "hourOfDay1to12-h" : myDateTime as String {format: "h"},
  // "K" outputs 12 o'clock as 0. Other hours match "h" output.
    "hourOfDay0to11-K" : myDateTime as String {format: "K"},
    "clockHourOfAmPm-k" : myDateTime as String {format: "k"},
    "hourOfDay0to23-H" : myDateTime as String {format: "H"},
    "minuteOfHour-m" : myDateTime as String {format: "m"},
    "secondOfMinute-s" : myDateTime as String {format: "s"},
    "fractionOfSecond-S" : myDateTime as String {format: "S"},
    "millisecondOfDay-A" : myDateTime as String {format: "A"},
    "nanosecondCountOfSecond-n" : myDateTime as String {format: "n"},
    "nanosecondCountOfDay-N" : myDateTime as String {format: "N"},
    "timeZoneID-VV" : myDateTime as String {format: "VV"},
    "timeZoneName-zz" : myDateTime as String {format: "zz"},
    "localizedZoneOffset-zzz" : myDateTime as String {format: "zzz"},
    "localizedZoneOffset-O" : myDateTime as String {format: "O"},
    "timeZoneOffsetZforZero-XXX" : myDateTime as String {format: "XXX"},
    "timeZoneOffsetZforZero-XX" : myDateTime as String {format: "XX"},
    "timeZoneOffsetZforZero-X" : myDateTime as String {format: "X"},
    "timeZoneOffset-xxx" : myDateTime as String {format: "xxx"},
    "timeZoneOffset-xx" : myDateTime as String {format: "xx"},
    "timeZoneOffset-x" : myDateTime as String {format: "x"},
    "timeZoneOffset-Z" : myDateTime as String {format: "Z"}
 }
```

Notice the use of the syntax to format the date or time.

Output

```json
{
  "dateTime": "2020-11-10T13:44:12.283-08:00",
  "era-G": "AD",
  "year-u": "2020",
  "year-uu": "20",
  "year-y": "2020",
  "year-yy": "20",
  "dayOfYear-D": "315",
  "monthOfYear-MMMM": "November",
  "monthOfYear-MMM": "Nov",
  "monthOfYear-MM": "11",
  "monthOfYear-M": "11",
  "monthOfYear-LL": "11",
  "monthOfYear-L": "11",
  "dayOfMonth-d": "10",
  "quarterOfYear-qqq": "4",
  "quarterOfYear-qq": "04",
  "quarterOfYear-q": "4",
  "quarterOfYear-QQQQ": "4th quarter",
  "quarterOfYear-QQQ": "Q4",
  "quarterOfYear-QQ": "04",
  "quarterOfYear-Q": "4",
  "weekBasedYear-YY": "20",
  "weekBasedYear-Y": "2020",
  "weekInYear-w": "46",
  "weekInMonth-W": "2",
  "dayOfWeekAbbreviatedName-E": "Tue",
  "dayOfWeekFullName-EEEE": "Tuesday",
  "localizedDayOfWeek-eeee": "Tuesday",
  "localizedDayOfWeek-eee": "Tue",
  "localizedDayOfWeek-ee": "03",
  "localizedDayOfWeek-e": "3",
  "localizedDayOfWeek-cccc": "Tuesday",
  "localizedDayOfWeek-ccc": "Tue",
  "localizedDayOfWeek-c": "3",
  "weekOfMonth-F": "3",
  "amORpm-a": "PM",
  "hourOfDay1to12-h": "1",
  "hourOfDay0to11-K": "1",
  "clockHourOfAmPm-k": "13",
  "hourOfDay0to23-H": "13",
  "minuteOfHour-m": "44",
  "secondOfMinute-s": "12",
  "fractionOfSecond-S": "2",
  "millisecondOfDay-A": "49452283",
  "nanosecondCountOfSecond-n": "283000000",
  "nanosecondCountOfDay-N": "49452283000000",
  "timeZoneID-VV": "-08:00",
  "timeZoneName-zz": "-08:00",
  "localizedZoneOffset-zzz": "-08:00",
  "localizedZoneOffset-O": "GMT-8",
  "timeZoneOffsetZforZero-XXX": "-08:00",
  "timeZoneOffsetZforZero-XX": "-0800",
  "timeZoneOffsetZforZero-X": "-08",
  "timeZoneOffset-xxx": "-08:00",
  "timeZoneOffset-xx": "-0800",
  "timeZoneOffset-x": "-08",
  "timeZoneOffset-Z": "-0800"
}
```

## Related Examples

- [Parse Dates with DataWeave](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-parse-dates)

- [Add and Subtract Time](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-add-and-subtract-time)

- [Change a Time Zone](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-change-time-zone)

## See Also

- [Date and Time (dw::Core Types)](https://docs.mulesoft.com/dataweave/2.6/dataweave-types#dw_type_dates)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.6/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook)

<!-- document id=a8b8a7a4f61e9f38c1d83425cdc11e563f3e142415732c7b5c95e69f556565c1 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook-format-dates.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, date, time
---

# Format Dates and Times

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You can use DataWeave to change the format of date and time input.

## Change Date and Time Formats

You can combine formatting characters, such as `MM` and `dd`, to write supported date and time
formats. The example uses the `as` operator to write the dates and times as a string.

Transform

```dataweave
%dw 2.0
output application/json
---
{
  formattedDate: |2020-10-01T23:57:59| as String {format: "uuuu-MM-dd"},
  formattedTime: |2020-10-01T23:57:59| as String {format: "KK:mm:ss a"},
  formattedDateTime: |2020-10-01T23:57:59| as String {format: "KK:mm:ss a, MMMM dd, uuuu"}
}
```

Output

```json
{
  "formattedDate": "2020-10-01",
  "formattedTime": "11:57:59 PM",
  "formattedDateTime": "11:57:59 PM, October 01, 2020"
}
```

## Create a Custom Date Format as a DataWeave Type

For multiple, similar conversions in your script, you can define a custom type as a directive in the
header and set each date to that type. Names of DataWeave type are case-sensitive.

DataWeave Script

```dataweave
%dw 2.0
output application/json
type Mydate = String { format: "uuuu/MM/dd" }
---
{
  formattedDate1: |2019-10-01T23:57:59| as Mydate,
  formattedDate2: |2020-07-06T08:53:15| as Mydate
}
```

Output

```json
{
  "formattedDate1": "2019/10/01",
  "formattedDate2": "2020/07/06"
}
```

## Use Date and Time Formatting Characters

DataWeave supports the use of formatting characters, such as the `u` (for the year), `M`, and `d` in
the date format `uuuu-MM-dd`. These characters are based on the Java 8 `java.time.format` package.

The following example formats the output of the `now` DataWeave function to show supported letters:

DataWeave Script

```dataweave
%dw 2.0
var myDateTime = ("2020-11-10T13:44:12.283-08:00" as DateTime)
output application/json
---
{
    "dateTime" : myDateTime,
    "era-G" : myDateTime as String { format: "G"},
    "year-u" : myDateTime as String {format: "u"},
    "year-uu" : myDateTime as String {format: "uu"},
  //y is for use with the era (BCE or CE). Generally, use u, instead.
    "year-y" : myDateTime as String { format: "y"},
    "year-yy" : myDateTime as String { format: "yy"},
    "dayOfYear-D" : myDateTime as String { format: "D"},
    "monthOfYear-MMMM": myDateTime as String { format: "MMMM"},
    "monthOfYear-MMM": myDateTime as String { format: "MMM"},
    "monthOfYear-MM": myDateTime as String { format: "MM"},
    "monthOfYear-M": myDateTime as String { format: "M"},
    "monthOfYear-LL": myDateTime as String { format: "LL"},
    "monthOfYear-L": myDateTime as String { format: "L"},
    "dayOfMonth-d" : myDateTime as String {format: "d"},
    "quarterOfYear-qqq" : myDateTime as String {format: "qqq"},
    "quarterOfYear-qq" : myDateTime as String {format: "qq"},
    "quarterOfYear-q" : myDateTime as String {format: "q"},
    "quarterOfYear-QQQQ" : myDateTime as String {format: "QQQQ"},
    "quarterOfYear-QQQ" : myDateTime as String {format: "QQQ"},
    "quarterOfYear-QQ" : myDateTime as String {format: "QQ"},
    "quarterOfYear-Q" : myDateTime as String {format: "Q"},
  // Understand "Y" and "YY" thoroughly before using it.
    "weekBasedYear-YY" : myDateTime as String { format: "YY"},
    "weekBasedYear-Y" : myDateTime as String { format: "Y"},
    "weekInYear-w" : myDateTime as String {format: "w"},
    "weekInMonth-W" : myDateTime as String {format: "W"},
    "dayOfWeekAbbreviatedName-E" : myDateTime as String {format: "E"},
    "dayOfWeekFullName-EEEE" : myDateTime as String {format: "EEEE"},
    "localizedDayOfWeek-eeee" : myDateTime as String {format: "eeee"},
    "localizedDayOfWeek-eee" : myDateTime as String {format: "eee"},
    "localizedDayOfWeek-ee" : myDateTime as String {format: "ee"},
    "localizedDayOfWeek-e" : myDateTime as String {format: "e"},
    "localizedDayOfWeek-cccc" : myDateTime as String {format: "cccc"},
    "localizedDayOfWeek-ccc" : myDateTime as String {format: "ccc"},
    "localizedDayOfWeek-c" : myDateTime as String {format: "c"},
    "weekOfMonth-F" : myDateTime as String {format: "F"},
    "amORpm-a" : myDateTime as String {format: "a"},
  // "h" outputs 12 o'clock as 12. Other hours match "K" output.
    "hourOfDay1to12-h" : myDateTime as String {format: "h"},
  // "K" outputs 12 o'clock as 0. Other hours match "h" output.
    "hourOfDay0to11-K" : myDateTime as String {format: "K"},
    "clockHourOfAmPm-k" : myDateTime as String {format: "k"},
    "hourOfDay0to23-H" : myDateTime as String {format: "H"},
    "minuteOfHour-m" : myDateTime as String {format: "m"},
    "secondOfMinute-s" : myDateTime as String {format: "s"},
    "fractionOfSecond-S" : myDateTime as String {format: "S"},
    "millisecondOfDay-A" : myDateTime as String {format: "A"},
    "nanosecondCountOfSecond-n" : myDateTime as String {format: "n"},
    "nanosecondCountOfDay-N" : myDateTime as String {format: "N"},
    "timeZoneID-VV" : myDateTime as String {format: "VV"},
    "timeZoneName-zz" : myDateTime as String {format: "zz"},
    "localizedZoneOffset-zzz" : myDateTime as String {format: "zzz"},
    "localizedZoneOffset-O" : myDateTime as String {format: "O"},
    "timeZoneOffsetZforZero-XXX" : myDateTime as String {format: "XXX"},
    "timeZoneOffsetZforZero-XX" : myDateTime as String {format: "XX"},
    "timeZoneOffsetZforZero-X" : myDateTime as String {format: "X"},
    "timeZoneOffset-xxx" : myDateTime as String {format: "xxx"},
    "timeZoneOffset-xx" : myDateTime as String {format: "xx"},
    "timeZoneOffset-x" : myDateTime as String {format: "x"},
    "timeZoneOffset-Z" : myDateTime as String {format: "Z"}
 }
```

Notice the use of the syntax to format the date or time.

Output

```json
{
  "dateTime": "2020-11-10T13:44:12.283-08:00",
  "era-G": "AD",
  "year-u": "2020",
  "year-uu": "20",
  "year-y": "2020",
  "year-yy": "20",
  "dayOfYear-D": "315",
  "monthOfYear-MMMM": "November",
  "monthOfYear-MMM": "Nov",
  "monthOfYear-MM": "11",
  "monthOfYear-M": "11",
  "monthOfYear-LL": "11",
  "monthOfYear-L": "11",
  "dayOfMonth-d": "10",
  "quarterOfYear-qqq": "4",
  "quarterOfYear-qq": "04",
  "quarterOfYear-q": "4",
  "quarterOfYear-QQQQ": "4th quarter",
  "quarterOfYear-QQQ": "Q4",
  "quarterOfYear-QQ": "04",
  "quarterOfYear-Q": "4",
  "weekBasedYear-YY": "20",
  "weekBasedYear-Y": "2020",
  "weekInYear-w": "46",
  "weekInMonth-W": "2",
  "dayOfWeekAbbreviatedName-E": "Tue",
  "dayOfWeekFullName-EEEE": "Tuesday",
  "localizedDayOfWeek-eeee": "Tuesday",
  "localizedDayOfWeek-eee": "Tue",
  "localizedDayOfWeek-ee": "03",
  "localizedDayOfWeek-e": "3",
  "localizedDayOfWeek-cccc": "Tuesday",
  "localizedDayOfWeek-ccc": "Tue",
  "localizedDayOfWeek-c": "3",
  "weekOfMonth-F": "3",
  "amORpm-a": "PM",
  "hourOfDay1to12-h": "1",
  "hourOfDay0to11-K": "1",
  "clockHourOfAmPm-k": "13",
  "hourOfDay0to23-H": "13",
  "minuteOfHour-m": "44",
  "secondOfMinute-s": "12",
  "fractionOfSecond-S": "2",
  "millisecondOfDay-A": "49452283",
  "nanosecondCountOfSecond-n": "283000000",
  "nanosecondCountOfDay-N": "49452283000000",
  "timeZoneID-VV": "-08:00",
  "timeZoneName-zz": "-08:00",
  "localizedZoneOffset-zzz": "-08:00",
  "localizedZoneOffset-O": "GMT-8",
  "timeZoneOffsetZforZero-XXX": "-08:00",
  "timeZoneOffsetZforZero-XX": "-0800",
  "timeZoneOffsetZforZero-X": "-08",
  "timeZoneOffset-xxx": "-08:00",
  "timeZoneOffset-xx": "-0800",
  "timeZoneOffset-x": "-08",
  "timeZoneOffset-Z": "-0800"
}
```

## Related Examples

- [Parse Dates with DataWeave](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-parse-dates)

- [Add and Subtract Time](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-add-and-subtract-time)

- [Change a Time Zone](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-change-time-zone)

## See Also

- [Date and Time (dw::Core Types)](https://docs.mulesoft.com/dataweave/2.9/dataweave-types#dw_type_dates)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.9/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook)

<!-- document id=96f03bc8445d76a3222ab11220dffd8f111fd365c63e7cd76afd2eed590229b1 url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook-format-dates.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, date, time
---

# Format Dates and Times

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You can use DataWeave to change the format of date and time input.

## Change Date and Time Formats

You can combine formatting characters, such as `MM` and `dd`, to write supported date and time
formats. The example uses the `as` operator to write the dates and times as a string.

Transform

```dataweave
%dw 2.0
output application/json
---
{
  formattedDate: |2020-10-01T23:57:59| as String {format: "uuuu-MM-dd"},
  formattedTime: |2020-10-01T23:57:59| as String {format: "KK:mm:ss a"},
  formattedDateTime: |2020-10-01T23:57:59| as String {format: "KK:mm:ss a, MMMM dd, uuuu"}
}
```

Output

```json
{
  "formattedDate": "2020-10-01",
  "formattedTime": "11:57:59 PM",
  "formattedDateTime": "11:57:59 PM, October 01, 2020"
}
```

## Create a Custom Date Format as a DataWeave Type

For multiple, similar conversions in your script, you can define a custom type as a directive in the
header and set each date to that type. Names of DataWeave type are case-sensitive.

DataWeave Script

```dataweave
%dw 2.0
output application/json
type Mydate = String { format: "uuuu/MM/dd" }
---
{
  formattedDate1: |2019-10-01T23:57:59| as Mydate,
  formattedDate2: |2020-07-06T08:53:15| as Mydate
}
```

Output

```json
{
  "formattedDate1": "2019/10/01",
  "formattedDate2": "2020/07/06"
}
```

## Use Date and Time Formatting Characters

DataWeave supports the use of formatting characters, such as the `u` (for the year), `M`, and `d` in
the date format `uuuu-MM-dd`. These characters are based on the Java 8 `java.time.format` package.

The following example formats the output of the `now` DataWeave function to show supported letters:

DataWeave Script

```dataweave
%dw 2.0
var myDateTime = ("2020-11-10T13:44:12.283-08:00" as DateTime)
output application/json
---
{
    "dateTime" : myDateTime,
    "era-G" : myDateTime as String { format: "G"},
    "year-u" : myDateTime as String {format: "u"},
    "year-uu" : myDateTime as String {format: "uu"},
  //y is for use with the era (BCE or CE). Generally, use u, instead.
    "year-y" : myDateTime as String { format: "y"},
    "year-yy" : myDateTime as String { format: "yy"},
    "dayOfYear-D" : myDateTime as String { format: "D"},
    "monthOfYear-MMMM": myDateTime as String { format: "MMMM"},
    "monthOfYear-MMM": myDateTime as String { format: "MMM"},
    "monthOfYear-MM": myDateTime as String { format: "MM"},
    "monthOfYear-M": myDateTime as String { format: "M"},
    "monthOfYear-LL": myDateTime as String { format: "LL"},
    "monthOfYear-L": myDateTime as String { format: "L"},
    "dayOfMonth-d" : myDateTime as String {format: "d"},
    "quarterOfYear-qqq" : myDateTime as String {format: "qqq"},
    "quarterOfYear-qq" : myDateTime as String {format: "qq"},
    "quarterOfYear-q" : myDateTime as String {format: "q"},
    "quarterOfYear-QQQQ" : myDateTime as String {format: "QQQQ"},
    "quarterOfYear-QQQ" : myDateTime as String {format: "QQQ"},
    "quarterOfYear-QQ" : myDateTime as String {format: "QQ"},
    "quarterOfYear-Q" : myDateTime as String {format: "Q"},
  // Understand "Y" and "YY" thoroughly before using it.
    "weekBasedYear-YY" : myDateTime as String { format: "YY"},
    "weekBasedYear-Y" : myDateTime as String { format: "Y"},
    "weekInYear-w" : myDateTime as String {format: "w"},
    "weekInMonth-W" : myDateTime as String {format: "W"},
    "dayOfWeekAbbreviatedName-E" : myDateTime as String {format: "E"},
    "dayOfWeekFullName-EEEE" : myDateTime as String {format: "EEEE"},
    "localizedDayOfWeek-eeee" : myDateTime as String {format: "eeee"},
    "localizedDayOfWeek-eee" : myDateTime as String {format: "eee"},
    "localizedDayOfWeek-ee" : myDateTime as String {format: "ee"},
    "localizedDayOfWeek-e" : myDateTime as String {format: "e"},
    "localizedDayOfWeek-cccc" : myDateTime as String {format: "cccc"},
    "localizedDayOfWeek-ccc" : myDateTime as String {format: "ccc"},
    "localizedDayOfWeek-c" : myDateTime as String {format: "c"},
    "weekOfMonth-F" : myDateTime as String {format: "F"},
    "amORpm-a" : myDateTime as String {format: "a"},
  // "h" outputs 12 o'clock as 12. Other hours match "K" output.
    "hourOfDay1to12-h" : myDateTime as String {format: "h"},
  // "K" outputs 12 o'clock as 0. Other hours match "h" output.
    "hourOfDay0to11-K" : myDateTime as String {format: "K"},
    "clockHourOfAmPm-k" : myDateTime as String {format: "k"},
    "hourOfDay0to23-H" : myDateTime as String {format: "H"},
    "minuteOfHour-m" : myDateTime as String {format: "m"},
    "secondOfMinute-s" : myDateTime as String {format: "s"},
    "fractionOfSecond-S" : myDateTime as String {format: "S"},
    "millisecondOfDay-A" : myDateTime as String {format: "A"},
    "nanosecondCountOfSecond-n" : myDateTime as String {format: "n"},
    "nanosecondCountOfDay-N" : myDateTime as String {format: "N"},
    "timeZoneID-VV" : myDateTime as String {format: "VV"},
    "timeZoneName-zz" : myDateTime as String {format: "zz"},
    "localizedZoneOffset-zzz" : myDateTime as String {format: "zzz"},
    "localizedZoneOffset-O" : myDateTime as String {format: "O"},
    "timeZoneOffsetZforZero-XXX" : myDateTime as String {format: "XXX"},
    "timeZoneOffsetZforZero-XX" : myDateTime as String {format: "XX"},
    "timeZoneOffsetZforZero-X" : myDateTime as String {format: "X"},
    "timeZoneOffset-xxx" : myDateTime as String {format: "xxx"},
    "timeZoneOffset-xx" : myDateTime as String {format: "xx"},
    "timeZoneOffset-x" : myDateTime as String {format: "x"},
    "timeZoneOffset-Z" : myDateTime as String {format: "Z"}
 }
```

Notice the use of the syntax to format the date or time.

Output

```json
{
  "dateTime": "2020-11-10T13:44:12.283-08:00",
  "era-G": "AD",
  "year-u": "2020",
  "year-uu": "20",
  "year-y": "2020",
  "year-yy": "20",
  "dayOfYear-D": "315",
  "monthOfYear-MMMM": "November",
  "monthOfYear-MMM": "Nov",
  "monthOfYear-MM": "11",
  "monthOfYear-M": "11",
  "monthOfYear-LL": "11",
  "monthOfYear-L": "11",
  "dayOfMonth-d": "10",
  "quarterOfYear-qqq": "4",
  "quarterOfYear-qq": "04",
  "quarterOfYear-q": "4",
  "quarterOfYear-QQQQ": "4th quarter",
  "quarterOfYear-QQQ": "Q4",
  "quarterOfYear-QQ": "04",
  "quarterOfYear-Q": "4",
  "weekBasedYear-YY": "20",
  "weekBasedYear-Y": "2020",
  "weekInYear-w": "46",
  "weekInMonth-W": "2",
  "dayOfWeekAbbreviatedName-E": "Tue",
  "dayOfWeekFullName-EEEE": "Tuesday",
  "localizedDayOfWeek-eeee": "Tuesday",
  "localizedDayOfWeek-eee": "Tue",
  "localizedDayOfWeek-ee": "03",
  "localizedDayOfWeek-e": "3",
  "localizedDayOfWeek-cccc": "Tuesday",
  "localizedDayOfWeek-ccc": "Tue",
  "localizedDayOfWeek-c": "3",
  "weekOfMonth-F": "3",
  "amORpm-a": "PM",
  "hourOfDay1to12-h": "1",
  "hourOfDay0to11-K": "1",
  "clockHourOfAmPm-k": "13",
  "hourOfDay0to23-H": "13",
  "minuteOfHour-m": "44",
  "secondOfMinute-s": "12",
  "fractionOfSecond-S": "2",
  "millisecondOfDay-A": "49452283",
  "nanosecondCountOfSecond-n": "283000000",
  "nanosecondCountOfDay-N": "49452283000000",
  "timeZoneID-VV": "-08:00",
  "timeZoneName-zz": "-08:00",
  "localizedZoneOffset-zzz": "-08:00",
  "localizedZoneOffset-O": "GMT-8",
  "timeZoneOffsetZforZero-XXX": "-08:00",
  "timeZoneOffsetZforZero-XX": "-0800",
  "timeZoneOffsetZforZero-X": "-08",
  "timeZoneOffset-xxx": "-08:00",
  "timeZoneOffset-xx": "-0800",
  "timeZoneOffset-x": "-08",
  "timeZoneOffset-Z": "-0800"
}
```

## Related Examples

- [Parse Dates with DataWeave](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-parse-dates)

- [Add and Subtract Time](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-add-and-subtract-time)

- [Change a Time Zone](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-change-time-zone)

## See Also

- [Date and Time (dw::Core Types)](https://docs.mulesoft.com/dataweave/latest/dataweave-types#dw_type_dates)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook)

<!-- document id=c78f4c0a46189cafe359d54e784e41025beafa8d46be9178d6cacaba60c85ebf url=/mulesoft/current/en-us/dataweave/2.11/dw-binaries-functions-frombase64.md -->

---
product: DataWeave
version: 2.11
---

# fromBase64

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fromBase64(base64String: String): Binary

Transforms a Base64 string into a binary value.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>base64String</code></p></td><td><p>The Base64 string to transform.</p></td></tr></tbody></table>

### Example

This example takes a Base64 encoded string and transforms it into a binary value. This example
assumes that the `payload` contains the Base64 string generated from an image in example
[toBase64](https://docs.mulesoft.com/dataweave/2.11/dw-binaries-functions-tobase64#toBase64-example). The output of this function is a binary
value that represents the image generated in example
[toBase64](https://docs.mulesoft.com/dataweave/latest/dw-binaries-functions-tobase64).

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Binaries
output application/octet-stream
---
fromBase64(payload)
```

<!-- document id=43fba568349d51b55196b78b742c449d924387a00d46f5eca882d18f2a70343b url=/mulesoft/current/en-us/dataweave/2.12/dw-binaries-functions-frombase64.md -->

---
product: DataWeave
version: 2.12
---

# fromBase64

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fromBase64(base64String: String): Binary

Transforms a Base64 string into a binary value.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>base64String</code></p></td><td><p>The Base64 string to transform.</p></td></tr></tbody></table>

### Example

This example takes a Base64 encoded string and transforms it into a binary value. This example
assumes that the `payload` contains the Base64 string generated from an image in example
[toBase64](https://docs.mulesoft.com/dataweave/2.12/dw-binaries-functions-tobase64#toBase64-example). The output of this function is a binary
value that represents the image generated in example
[toBase64](https://docs.mulesoft.com/dataweave/latest/dw-binaries-functions-tobase64).

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Binaries
output application/octet-stream
---
fromBase64(payload)
```

<!-- document id=c3fcc544af3e0f5040eed38cfe6fe0579514c7d980e74794c5f35c0716dfa8a2 url=/mulesoft/current/en-us/dataweave/2.3/dw-binaries-functions-frombase64.md -->

---
product: DataWeave
version: 2.3
---

# fromBase64

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fromBase64(String): Binary

Transforms a Base64 string into a binary value.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>base64String</code></p></td><td><p>The Base64 string to transform.</p></td></tr></tbody></table>

### Example

This example takes a Base64 encoded string and transforms it into a binary value. This example
assumes that the `payload` contains the Base64 string generated from an image in example
[toBase64](https://docs.mulesoft.com/dataweave/2.3/dw-binaries-functions-tobase64#toBase64-example).

#### Source

```DataWeave
%dw 2.0

import fromBase64 from dw::core::Binaries
output application/octet-stream
---
fromBase64(payload)
```

#### Output

The output of this function is a binary value that represents the image generated in example
[toBase64](https://docs.mulesoft.com/dataweave/2.3/dw-binaries-functions-tobase64#toBase64-example).

<!-- document id=ab21e471a499fd5991cd210efb154db7d000f3baba0de9cadecabf6d88302963 url=/mulesoft/current/en-us/dataweave/2.4/dw-binaries-functions-frombase64.md -->

---
product: DataWeave
version: 2.4
---

# fromBase64

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fromBase64(base64String: String): Binary

Transforms a Base64 string into a binary value.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>base64String</code></p></td><td><p>The Base64 string to transform.</p></td></tr></tbody></table>

### Example

This example takes a Base64 encoded string and transforms it into a binary value. This example
assumes that the `payload` contains the Base64 string generated from an image in example
[toBase64](https://docs.mulesoft.com/dataweave/2.4/dw-binaries-functions-tobase64#toBase64-example).

#### Source

```DataWeave
%dw 2.0

import fromBase64 from dw::core::Binaries
output application/octet-stream
---
fromBase64(payload)
```

<!-- document id=d6dbecead7421c78b36615a4669610c3fbb304948bd9e53681e94c027124de09 url=/mulesoft/current/en-us/dataweave/2.6/dw-binaries-functions-frombase64.md -->

---
product: DataWeave
version: 2.6
---

# fromBase64

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fromBase64(base64String: String): Binary

Transforms a Base64 string into a binary value.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>base64String</code></p></td><td><p>The Base64 string to transform.</p></td></tr></tbody></table>

### Example

This example takes a Base64 encoded string and transforms it into a binary value. This example
assumes that the `payload` contains the Base64 string generated from an image in example
[toBase64](https://docs.mulesoft.com/dataweave/2.6/dw-binaries-functions-tobase64#toBase64-example). The output of this function is a binary
value that represents the image generated in example
[toBase64](https://docs.mulesoft.com/dataweave/latest/dw-binaries-functions-tobase64).

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Binaries
output application/octet-stream
---
fromBase64(payload)
```

<!-- document id=d8a5bd3db473ed7703f23cd96c7089af401185ddd012569bc4f01b7f7e3a164d url=/mulesoft/current/en-us/dataweave/2.9/dw-binaries-functions-frombase64.md -->

---
product: DataWeave
version: 2.9
---

# fromBase64

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fromBase64(base64String: String): Binary

Transforms a Base64 string into a binary value.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>base64String</code></p></td><td><p>The Base64 string to transform.</p></td></tr></tbody></table>

### Example

This example takes a Base64 encoded string and transforms it into a binary value. This example
assumes that the `payload` contains the Base64 string generated from an image in example
[toBase64](https://docs.mulesoft.com/dataweave/2.9/dw-binaries-functions-tobase64#toBase64-example). The output of this function is a binary
value that represents the image generated in example
[toBase64](https://docs.mulesoft.com/dataweave/latest/dw-binaries-functions-tobase64).

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Binaries
output application/octet-stream
---
fromBase64(payload)
```

<!-- document id=3eb9fd87132fb9700cfc438b995a1ef12a7f4932a9e3b99a3b285029e1125b34 url=/mulesoft/current/en-us/dataweave/latest/dw-binaries-functions-frombase64.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# fromBase64

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fromBase64(base64String: String): Binary

Transforms a Base64 string into a binary value.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>base64String</code></p></td><td><p>The Base64 string to transform.</p></td></tr></tbody></table>

### Example

This example takes a Base64 encoded string and transforms it into a binary value. This example
assumes that the `payload` contains the Base64 string generated from an image in example
[toBase64](https://docs.mulesoft.com/dataweave/latest/dw-binaries-functions-tobase64#toBase64-example). The output of this function is a binary
value that represents the image generated in example
[toBase64](https://docs.mulesoft.com/dataweave/latest/dw-binaries-functions-tobase64).

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Binaries
output application/octet-stream
---
fromBase64(payload)
```

<!-- document id=74f9b9ede3d727b025abd8e834a67cdb000070595f36ebb5d423092850337ba4 url=/mulesoft/current/en-us/dataweave/2.11/dw-numbers-functions-frombinary.md -->

---
product: DataWeave
version: 2.11
---

# fromBinary

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fromBinary(binaryText: String): Number

Transforms from a binary number into a decimal number.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>binaryText</code></p></td><td><p>The binary number represented in a <code>String</code>.</p></td></tr></tbody></table>

### Example

This example shows how the `toBinary` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import fromBinary from dw::core::Numbers
output application/json
---
{
    a: fromBinary("-10"),
    b: fromBinary("11111000111010111010110100101011100001001110000011010101100010111101001011100000100010011000011101100101101001111101111010110010010100110010100100000000000000000000000000000000000000000000000000000000000000"),
    c: fromBinary(0),
    d: fromBinary(null),
    e: fromBinary("100"),
}
```

#### Output

```JSON
{
  "a": -2,
  "b": 100000000000000000000000000000000000000000000000000000000000000,
  "c": 0,
  "d": null,
  "e": 4
}
```

## fromBinary(binaryText: Null): Null

Helper function that enables `fromBinary` to work with null value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=466433d6864dfa8274097b46ae8c2f1c30065497581fedb3407a7a261c7e6e38 url=/mulesoft/current/en-us/dataweave/2.12/dw-numbers-functions-frombinary.md -->

---
product: DataWeave
version: 2.12
---

# fromBinary

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fromBinary(binaryText: String): Number

Transforms from a binary number into a decimal number.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>binaryText</code></p></td><td><p>The binary number represented in a <code>String</code>.</p></td></tr></tbody></table>

### Example

This example shows how the `toBinary` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import fromBinary from dw::core::Numbers
output application/json
---
{
    a: fromBinary("-10"),
    b: fromBinary("11111000111010111010110100101011100001001110000011010101100010111101001011100000100010011000011101100101101001111101111010110010010100110010100100000000000000000000000000000000000000000000000000000000000000"),
    c: fromBinary(0),
    d: fromBinary(null),
    e: fromBinary("100"),
}
```

#### Output

```JSON
{
  "a": -2,
  "b": 100000000000000000000000000000000000000000000000000000000000000,
  "c": 0,
  "d": null,
  "e": 4
}
```

## fromBinary(binaryText: Null): Null

Helper function that enables `fromBinary` to work with null value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=afb1fe04f366709b4b0be19aec08b92977efc0b3588abcb50660be8dec7d5012 url=/mulesoft/current/en-us/dataweave/2.3/dw-numbers-functions-frombinary.md -->

---
product: DataWeave
version: 2.3
---

# fromBinary

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fromBinary(String): Number

Transforms from a binary number into a decimal number.

_Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>binaryText</code></p></td><td><p>The binary number represented in a <code>String</code>.</p></td></tr></tbody></table>

### Example

This example shows how the `toBinary` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import fromBinary from dw::core::Numbers
output application/json
---
{
    a: fromBinary("-10"),
    b: fromBinary("11111000111010111010110100101011100001001110000011010101100010111101001011100000100010011000011101100101101001111101111010110010010100110010100100000000000000000000000000000000000000000000000000000000000000"),
    c: fromBinary(0),
    d: fromBinary(null),
    e: fromBinary("100"),
}
```

#### Output

```JSON
{
  "a": -2,
  "b": 100000000000000000000000000000000000000000000000000000000000000,
  "c": 0,
  "d": null,
  "e": 4
}
```

## fromBinary(Null): Null

Helper function that enables `fromBinary` to work with null value.

<!-- document id=4918effc69feba470203541cf484143afada4b63b66355859215bb1280ea063e url=/mulesoft/current/en-us/dataweave/2.4/dw-numbers-functions-frombinary.md -->

---
product: DataWeave
version: 2.4
---

# fromBinary

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fromBinary(binaryText: String): Number

Transforms from a binary number into a decimal number.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>binaryText</code></p></td><td><p>The binary number represented in a <code>String</code>.</p></td></tr></tbody></table>

### Example

This example shows how the `toBinary` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import fromBinary from dw::core::Numbers
output application/json
---
{
    a: fromBinary("-10"),
    b: fromBinary("11111000111010111010110100101011100001001110000011010101100010111101001011100000100010011000011101100101101001111101111010110010010100110010100100000000000000000000000000000000000000000000000000000000000000"),
    c: fromBinary(0),
    d: fromBinary(null),
    e: fromBinary("100"),
}
```

#### Output

```JSON
{
  "a": -2,
  "b": 100000000000000000000000000000000000000000000000000000000000000,
  "c": 0,
  "d": null,
  "e": 4
}
```

## fromBinary(binaryText: Null): Null

Helper function that enables `fromBinary` to work with null value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=86b9ee69fe800c8a54af258655210376eb07bb1427f9c6e223785be7c1efa8f4 url=/mulesoft/current/en-us/dataweave/2.6/dw-numbers-functions-frombinary.md -->

---
product: DataWeave
version: 2.6
---

# fromBinary

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fromBinary(binaryText: String): Number

Transforms from a binary number into a decimal number.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>binaryText</code></p></td><td><p>The binary number represented in a <code>String</code>.</p></td></tr></tbody></table>

### Example

This example shows how the `toBinary` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import fromBinary from dw::core::Numbers
output application/json
---
{
    a: fromBinary("-10"),
    b: fromBinary("11111000111010111010110100101011100001001110000011010101100010111101001011100000100010011000011101100101101001111101111010110010010100110010100100000000000000000000000000000000000000000000000000000000000000"),
    c: fromBinary(0),
    d: fromBinary(null),
    e: fromBinary("100"),
}
```

#### Output

```JSON
{
  "a": -2,
  "b": 100000000000000000000000000000000000000000000000000000000000000,
  "c": 0,
  "d": null,
  "e": 4
}
```

## fromBinary(binaryText: Null): Null

Helper function that enables `fromBinary` to work with null value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=78802c20ec33296a464dbd5fd76c362d141e2eeec9cf3441753356b402a534c1 url=/mulesoft/current/en-us/dataweave/2.9/dw-numbers-functions-frombinary.md -->

---
product: DataWeave
version: 2.9
---

# fromBinary

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fromBinary(binaryText: String): Number

Transforms from a binary number into a decimal number.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>binaryText</code></p></td><td><p>The binary number represented in a <code>String</code>.</p></td></tr></tbody></table>

### Example

This example shows how the `toBinary` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import fromBinary from dw::core::Numbers
output application/json
---
{
    a: fromBinary("-10"),
    b: fromBinary("11111000111010111010110100101011100001001110000011010101100010111101001011100000100010011000011101100101101001111101111010110010010100110010100100000000000000000000000000000000000000000000000000000000000000"),
    c: fromBinary(0),
    d: fromBinary(null),
    e: fromBinary("100"),
}
```

#### Output

```JSON
{
  "a": -2,
  "b": 100000000000000000000000000000000000000000000000000000000000000,
  "c": 0,
  "d": null,
  "e": 4
}
```

## fromBinary(binaryText: Null): Null

Helper function that enables `fromBinary` to work with null value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=5fd26c01b146259ca42772660044cbf4fc69c2923f4f1377b657b11982788bc5 url=/mulesoft/current/en-us/dataweave/latest/dw-numbers-functions-frombinary.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# fromBinary

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fromBinary(binaryText: String): Number

Transforms from a binary number into a decimal number.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>binaryText</code></p></td><td><p>The binary number represented in a <code>String</code>.</p></td></tr></tbody></table>

### Example

This example shows how the `toBinary` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import fromBinary from dw::core::Numbers
output application/json
---
{
    a: fromBinary("-10"),
    b: fromBinary("11111000111010111010110100101011100001001110000011010101100010111101001011100000100010011000011101100101101001111101111010110010010100110010100100000000000000000000000000000000000000000000000000000000000000"),
    c: fromBinary(0),
    d: fromBinary(null),
    e: fromBinary("100"),
}
```

#### Output

```JSON
{
  "a": -2,
  "b": 100000000000000000000000000000000000000000000000000000000000000,
  "c": 0,
  "d": null,
  "e": 4
}
```

## fromBinary(binaryText: Null): Null

Helper function that enables `fromBinary` to work with null value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=416026e340ab72f030d323e233c627aa00811758adcdb2c68f7f22013ae0bf72 url=/mulesoft/current/en-us/dataweave/2.11/dw-strings-functions-fromcharcode.md -->

---
product: DataWeave
version: 2.11
---

# fromCharCode

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fromCharCode(charCode: Number): String

Returns a character that matches the specified Unicode.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>charCode</code></p></td><td><p>The input Unicode (a <code>Number</code>).</p></td></tr></tbody></table>

### Example

This example inputs the Unicode number `117` to return the character "u".

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "fromCharCode" : fromCharCode(117)
}
```

#### Output

```JSON
{ "fromCharCode": "u" }
```

## fromCharCode(charCode: Null): Null

Helper function that enables `fromCharCode` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=ab55f5ff8c6b163f6db96183589d21eae0f848f3ca4977840fdf88f5143ab0b8 url=/mulesoft/current/en-us/dataweave/2.12/dw-strings-functions-fromcharcode.md -->

---
product: DataWeave
version: 2.12
---

# fromCharCode

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fromCharCode(charCode: Number): String

Returns a character that matches the specified Unicode.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>charCode</code></p></td><td><p>The input Unicode (a <code>Number</code>).</p></td></tr></tbody></table>

### Example

This example inputs the Unicode number `117` to return the character "u".

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "fromCharCode" : fromCharCode(117)
}
```

#### Output

```JSON
{ "fromCharCode": "u" }
```

## fromCharCode(charCode: Null): Null

Helper function that enables `fromCharCode` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=c1e5b539739287e58ba30b2189887669338e3f07a95c54ddadfde79501473236 url=/mulesoft/current/en-us/dataweave/2.3/dw-strings-functions-fromcharcode.md -->

---
product: DataWeave
version: 2.3
---

# fromCharCode

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fromCharCode(Number): String

Returns a character that matches the specified Unicode.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>charCode</code></p></td><td><p>The input Unicode (a <code>Number</code>).</p></td></tr></tbody></table>

### Example

This example inputs the Unicode number `117` to return the character "u".

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "fromCharCode" : fromCharCode(117)
}
```

#### Output

```JSON
{ "fromCharCode": "u" }
```

<!-- document id=b562d712aca9dd0e5dfb7c06bdb4cb00d56f49c06f73fa5d75e84f96640af2ce url=/mulesoft/current/en-us/dataweave/2.4/dw-strings-functions-fromcharcode.md -->

---
product: DataWeave
version: 2.4
---

# fromCharCode

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fromCharCode(charCode: Number): String

Returns a character that matches the specified Unicode.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>charCode</code></p></td><td><p>The input Unicode (a <code>Number</code>).</p></td></tr></tbody></table>

### Example

This example inputs the Unicode number `117` to return the character "u".

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "fromCharCode" : fromCharCode(117)
}
```

#### Output

```JSON
{ "fromCharCode": "u" }
```

## fromCharCode(charCode: Null): Null

Helper function that enables `fromCharCode` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=2eea2ce40317fb64afe71bc1cf56210c31d70a26a15e58292cb98d20e0c59363 url=/mulesoft/current/en-us/dataweave/2.6/dw-strings-functions-fromcharcode.md -->

---
product: DataWeave
version: 2.6
---

# fromCharCode

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fromCharCode(charCode: Number): String

Returns a character that matches the specified Unicode.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>charCode</code></p></td><td><p>The input Unicode (a <code>Number</code>).</p></td></tr></tbody></table>

### Example

This example inputs the Unicode number `117` to return the character "u".

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "fromCharCode" : fromCharCode(117)
}
```

#### Output

```JSON
{ "fromCharCode": "u" }
```

## fromCharCode(charCode: Null): Null

Helper function that enables `fromCharCode` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=4fb4d60e5ef1f00796bc03c9200a41aeac872decf80ab0ad71371b5f6391faf1 url=/mulesoft/current/en-us/dataweave/2.9/dw-strings-functions-fromcharcode.md -->

---
product: DataWeave
version: 2.9
---

# fromCharCode

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fromCharCode(charCode: Number): String

Returns a character that matches the specified Unicode.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>charCode</code></p></td><td><p>The input Unicode (a <code>Number</code>).</p></td></tr></tbody></table>

### Example

This example inputs the Unicode number `117` to return the character "u".

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "fromCharCode" : fromCharCode(117)
}
```

#### Output

```JSON
{ "fromCharCode": "u" }
```

## fromCharCode(charCode: Null): Null

Helper function that enables `fromCharCode` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=4c8acafc633b9c7aeebf133d9bfece1e794a21a403fcb6452392ec2db9a0768e url=/mulesoft/current/en-us/dataweave/latest/dw-strings-functions-fromcharcode.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# fromCharCode

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fromCharCode(charCode: Number): String

Returns a character that matches the specified Unicode.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>charCode</code></p></td><td><p>The input Unicode (a <code>Number</code>).</p></td></tr></tbody></table>

### Example

This example inputs the Unicode number `117` to return the character "u".

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "fromCharCode" : fromCharCode(117)
}
```

#### Output

```JSON
{ "fromCharCode": "u" }
```

## fromCharCode(charCode: Null): Null

Helper function that enables `fromCharCode` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=d6429ee824cf559bfa244c58ee8e3951cb1307b6b8a42b869660d00d3b9ac09c url=/mulesoft/current/en-us/dataweave/2.11/dw-binaries-functions-fromhex.md -->

---
product: DataWeave
version: 2.11
---

# fromHex

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fromHex(hexString: String): Binary

Transforms a hexadecimal string into a binary.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>hexString</code></p></td><td><p>A hexadecimal string to transform.</p></td></tr></tbody></table>

### Example

This example transforms a hexadecimal string to "Mule". To make the resulting type clear, it outputs
data in the `application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Binaries
output application/dw
---
{ "hexToBinary": fromHex("4D756C65") }
```

#### Output

```JSON
{
   hexToBinary: "TXVsZQ==" as Binary {base: "64"}
}
```

<!-- document id=30e10c7e84ab540861081d8d0ff6be92aa44e8d39651ec847d2ee95d2169c2df url=/mulesoft/current/en-us/dataweave/2.11/dw-numbers-functions-fromhex.md -->

---
product: DataWeave
version: 2.11
---

# fromHex

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fromHex(hexText: String): Number

Transforms a hexadecimal number into decimal number.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>hexText</code></p></td><td><p>The hexadecimal number represented in a <code>String</code>.</p></td></tr></tbody></table>

### Example

This example shows how the `toBinary` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import fromHex from dw::core::Numbers
output application/json
---
{
    a: fromHex("-1"),
    b: fromHex("3e3aeb4ae1383562f4b82261d969f7ac94ca4000000000000000"),
    c: fromHex(0),
    d: fromHex(null),
    e: fromHex("f"),
}
```

#### Output

```JSON
{
  "a": -1,
  "b": 100000000000000000000000000000000000000000000000000000000000000,
  "c": 0,
  "d": null,
  "e": 15
}
```

## fromHex(hexText: Null): Null

Helper function that enables `fromHex` to work with null value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=74be3147055667ecc3f401fbe85dc4b792b48db75488e97c912f846200d4f7b7 url=/mulesoft/current/en-us/dataweave/2.12/dw-binaries-functions-fromhex.md -->

---
product: DataWeave
version: 2.12
---

# fromHex

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fromHex(hexString: String): Binary

Transforms a hexadecimal string into a binary.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>hexString</code></p></td><td><p>A hexadecimal string to transform.</p></td></tr></tbody></table>

### Example

This example transforms a hexadecimal string to "Mule". To make the resulting type clear, it outputs
data in the `application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Binaries
output application/dw
---
{ "hexToBinary": fromHex("4D756C65") }
```

#### Output

```JSON
{
   hexToBinary: "TXVsZQ==" as Binary {base: "64"}
}
```

<!-- document id=b4f5bb47450e3e3f1e9ed71809b27a0520e0dbb1b662cf63305e4ea0d192ed40 url=/mulesoft/current/en-us/dataweave/2.12/dw-numbers-functions-fromhex.md -->

---
product: DataWeave
version: 2.12
---

# fromHex

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fromHex(hexText: String): Number

Transforms a hexadecimal number into decimal number.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>hexText</code></p></td><td><p>The hexadecimal number represented in a <code>String</code>.</p></td></tr></tbody></table>

### Example

This example shows how the `toBinary` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import fromHex from dw::core::Numbers
output application/json
---
{
    a: fromHex("-1"),
    b: fromHex("3e3aeb4ae1383562f4b82261d969f7ac94ca4000000000000000"),
    c: fromHex(0),
    d: fromHex(null),
    e: fromHex("f"),
}
```

#### Output

```JSON
{
  "a": -1,
  "b": 100000000000000000000000000000000000000000000000000000000000000,
  "c": 0,
  "d": null,
  "e": 15
}
```

## fromHex(hexText: Null): Null

Helper function that enables `fromHex` to work with null value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=9dba74df5d758990574b015afcd6e55e82adda4264da2ea41248283a91fb4593 url=/mulesoft/current/en-us/dataweave/2.3/dw-binaries-functions-fromhex.md -->

---
product: DataWeave
version: 2.3
---

# fromHex

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fromHex(String): Binary

Transforms a hexadecimal string into a binary.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>hexString</code></p></td><td><p>A hexadecimal string to transform.</p></td></tr></tbody></table>

### Example

This example transforms a hexadecimal string to "Mule". To make the resulting type clear, it outputs
data in the `application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Binaries
output application/dw
---
{ "hexToBinary": fromHex("4D756C65") }
```

#### Output

```JSON
{
    hexToBinary: "TXVsZQ==" as Binary {base: "64"}
}
```

<!-- document id=c263778a7e59968cf1307cdafa1e21bb1d50ee4c1a69269c5c25aef0a2bf464a url=/mulesoft/current/en-us/dataweave/2.3/dw-numbers-functions-fromhex.md -->

---
product: DataWeave
version: 2.3
---

# fromHex

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fromHex(String): Number

Transforms a hexadecimal number into decimal number.

_Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>hexText</code></p></td><td><p>The hexadecimal number represented in a <code>String</code>.</p></td></tr></tbody></table>

### Example

This example shows how the `toBinary` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import fromHex from dw::core::Numbers
output application/json
---
{
    a: fromHex("-1"),
    b: fromHex("3e3aeb4ae1383562f4b82261d969f7ac94ca4000000000000000"),
    c: fromHex(0),
    d: fromHex(null),
    e: fromHex("f"),
}
```

#### Output

```JSON
{
  "a": -1,
  "b": 100000000000000000000000000000000000000000000000000000000000000,
  "c": 0,
  "d": null,
  "e": 15
}
```

## fromHex(Null): Null

Helper function that enables `fromHex` to work with null value.

<!-- document id=1c63a9310b8367bdd2cee055d0ecd4680d8668deb7308d884304532d140e710f url=/mulesoft/current/en-us/dataweave/2.4/dw-binaries-functions-fromhex.md -->

---
product: DataWeave
version: 2.4
---

# fromHex

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fromHex(hexString: String): Binary

Transforms a hexadecimal string into a binary.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>hexString</code></p></td><td><p>A hexadecimal string to transform.</p></td></tr></tbody></table>

### Example

This example transforms a hexadecimal string to "Mule". To make the resulting type clear, it outputs
data in the `application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Binaries
output application/dw
---
{ "hexToBinary": fromHex("4D756C65") }
```

#### Output

```JSON
{
   hexToBinary: "TXVsZQ==" as Binary {base: "64"}
}
```

<!-- document id=eeea2e88282f9f23a63ca23010674308e6f820542194449b774709e50270c51b url=/mulesoft/current/en-us/dataweave/2.4/dw-numbers-functions-fromhex.md -->

---
product: DataWeave
version: 2.4
---

# fromHex

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fromHex(hexText: String): Number

Transforms a hexadecimal number into decimal number.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>hexText</code></p></td><td><p>The hexadecimal number represented in a <code>String</code>.</p></td></tr></tbody></table>

### Example

This example shows how the `toBinary` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import fromHex from dw::core::Numbers
output application/json
---
{
    a: fromHex("-1"),
    b: fromHex("3e3aeb4ae1383562f4b82261d969f7ac94ca4000000000000000"),
    c: fromHex(0),
    d: fromHex(null),
    e: fromHex("f"),
}
```

#### Output

```JSON
{
  "a": -1,
  "b": 100000000000000000000000000000000000000000000000000000000000000,
  "c": 0,
  "d": null,
  "e": 15
}
```

## fromHex(hexText: Null): Null

Helper function that enables `fromHex` to work with null value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=47e27ae7805d7fcb281d50160f9390339a6128efbae8b21d1299d4862025006a url=/mulesoft/current/en-us/dataweave/2.6/dw-binaries-functions-fromhex.md -->

---
product: DataWeave
version: 2.6
---

# fromHex

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fromHex(hexString: String): Binary

Transforms a hexadecimal string into a binary.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>hexString</code></p></td><td><p>A hexadecimal string to transform.</p></td></tr></tbody></table>

### Example

This example transforms a hexadecimal string to "Mule". To make the resulting type clear, it outputs
data in the `application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Binaries
output application/dw
---
{ "hexToBinary": fromHex("4D756C65") }
```

#### Output

```JSON
{
   hexToBinary: "TXVsZQ==" as Binary {base: "64"}
}
```

<!-- document id=5efdce5c705381791beb4d68168a58602446aa87f1bd5b31a5e356e71188c9c1 url=/mulesoft/current/en-us/dataweave/2.6/dw-numbers-functions-fromhex.md -->

---
product: DataWeave
version: 2.6
---

# fromHex

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fromHex(hexText: String): Number

Transforms a hexadecimal number into decimal number.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>hexText</code></p></td><td><p>The hexadecimal number represented in a <code>String</code>.</p></td></tr></tbody></table>

### Example

This example shows how the `toBinary` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import fromHex from dw::core::Numbers
output application/json
---
{
    a: fromHex("-1"),
    b: fromHex("3e3aeb4ae1383562f4b82261d969f7ac94ca4000000000000000"),
    c: fromHex(0),
    d: fromHex(null),
    e: fromHex("f"),
}
```

#### Output

```JSON
{
  "a": -1,
  "b": 100000000000000000000000000000000000000000000000000000000000000,
  "c": 0,
  "d": null,
  "e": 15
}
```

## fromHex(hexText: Null): Null

Helper function that enables `fromHex` to work with null value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=05fb5628c2a70e327a393c0d955e97e357003ed987800db5ab9754ad9b1dc8f6 url=/mulesoft/current/en-us/dataweave/2.9/dw-binaries-functions-fromhex.md -->

---
product: DataWeave
version: 2.9
---

# fromHex

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fromHex(hexString: String): Binary

Transforms a hexadecimal string into a binary.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>hexString</code></p></td><td><p>A hexadecimal string to transform.</p></td></tr></tbody></table>

### Example

This example transforms a hexadecimal string to "Mule". To make the resulting type clear, it outputs
data in the `application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Binaries
output application/dw
---
{ "hexToBinary": fromHex("4D756C65") }
```

#### Output

```JSON
{
   hexToBinary: "TXVsZQ==" as Binary {base: "64"}
}
```

<!-- document id=35a297541666aeb2ee1c25ce94f4f7bc177cb054537120f39faafe09b0813cfd url=/mulesoft/current/en-us/dataweave/2.9/dw-numbers-functions-fromhex.md -->

---
product: DataWeave
version: 2.9
---

# fromHex

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fromHex(hexText: String): Number

Transforms a hexadecimal number into decimal number.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>hexText</code></p></td><td><p>The hexadecimal number represented in a <code>String</code>.</p></td></tr></tbody></table>

### Example

This example shows how the `toBinary` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import fromHex from dw::core::Numbers
output application/json
---
{
    a: fromHex("-1"),
    b: fromHex("3e3aeb4ae1383562f4b82261d969f7ac94ca4000000000000000"),
    c: fromHex(0),
    d: fromHex(null),
    e: fromHex("f"),
}
```

#### Output

```JSON
{
  "a": -1,
  "b": 100000000000000000000000000000000000000000000000000000000000000,
  "c": 0,
  "d": null,
  "e": 15
}
```

## fromHex(hexText: Null): Null

Helper function that enables `fromHex` to work with null value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=b9abcbaa65db8549f4445469e4fb380de7ddd7825a8353bf854311b9c7ccdd2d url=/mulesoft/current/en-us/dataweave/latest/dw-binaries-functions-fromhex.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# fromHex

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fromHex(hexString: String): Binary

Transforms a hexadecimal string into a binary.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>hexString</code></p></td><td><p>A hexadecimal string to transform.</p></td></tr></tbody></table>

### Example

This example transforms a hexadecimal string to "Mule". To make the resulting type clear, it outputs
data in the `application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Binaries
output application/dw
---
{ "hexToBinary": fromHex("4D756C65") }
```

#### Output

```JSON
{
   hexToBinary: "TXVsZQ==" as Binary {base: "64"}
}
```

<!-- document id=bde6072e80a9c8d85322b2d71d5a24ade486a388be26f8acb7d57987f9e14c90 url=/mulesoft/current/en-us/dataweave/latest/dw-numbers-functions-fromhex.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# fromHex

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fromHex(hexText: String): Number

Transforms a hexadecimal number into decimal number.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>hexText</code></p></td><td><p>The hexadecimal number represented in a <code>String</code>.</p></td></tr></tbody></table>

### Example

This example shows how the `toBinary` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import fromHex from dw::core::Numbers
output application/json
---
{
    a: fromHex("-1"),
    b: fromHex("3e3aeb4ae1383562f4b82261d969f7ac94ca4000000000000000"),
    c: fromHex(0),
    d: fromHex(null),
    e: fromHex("f"),
}
```

#### Output

```JSON
{
  "a": -1,
  "b": 100000000000000000000000000000000000000000000000000000000000000,
  "c": 0,
  "d": null,
  "e": 15
}
```

## fromHex(hexText: Null): Null

Helper function that enables `fromHex` to work with null value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=aae51fed0758e09635475aa9c3b3a333b5070f600e631e27e31e3ef2dfae54eb url=/mulesoft/current/en-us/dataweave/2.11/dw-numbers-functions-fromradixnumber.md -->

---
product: DataWeave
version: 2.11
---

# fromRadixNumber

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fromRadixNumber(numberStr: String, radix: Number): Number

Transforms a number in the specified radix into decimal number

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>numberText</code></p></td><td><p>The number text.</p></td></tr><tr><td><p><code>radix</code></p></td><td><p>The radix number.</p></td></tr></tbody></table>

### Example

This example shows how the `fromRadixNumber` behaves under different inputs.

#### Source

```DataWeave
%dw 2.0
import fromRadixNumber from dw::core::Numbers
output application/json
---
{
    a: fromRadixNumber("10", 2),
    b: fromRadixNumber("FF", 16)
}
```

#### Output

```JSON
{
  "a": 2,
  "b": 255
}
```

<!-- document id=57965691df0be0369ec780c8aa8e27c61b3e3eb81fd73253bf5b7ea2b5268140 url=/mulesoft/current/en-us/dataweave/2.12/dw-numbers-functions-fromradixnumber.md -->

---
product: DataWeave
version: 2.12
---

# fromRadixNumber

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fromRadixNumber(numberStr: String, radix: Number): Number

Transforms a number in the specified radix into decimal number

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>numberText</code></p></td><td><p>The number text.</p></td></tr><tr><td><p><code>radix</code></p></td><td><p>The radix number.</p></td></tr></tbody></table>

### Example

This example shows how the `fromRadixNumber` behaves under different inputs.

#### Source

```DataWeave
%dw 2.0
import fromRadixNumber from dw::core::Numbers
output application/json
---
{
    a: fromRadixNumber("10", 2),
    b: fromRadixNumber("FF", 16)
}
```

#### Output

```JSON
{
  "a": 2,
  "b": 255
}
```

<!-- document id=15c95899bd435f017a577680f08f439522c842477d6bfe70bcaf033d8e4d3229 url=/mulesoft/current/en-us/dataweave/2.3/dw-numbers-functions-fromradixnumber.md -->

---
product: DataWeave
version: 2.3
---

# fromRadixNumber

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fromRadixNumber(String, Number): Number

Transforms a number in the specified radix into decimal number

_Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>numberText</code></p></td><td><p>The number text.</p></td></tr><tr><td><p><code>radix</code></p></td><td><p>The radix number.</p></td></tr></tbody></table>

### Example

This example shows how the `fromRadixNumber` behaves under different inputs.

#### Source

```DataWeave
%dw 2.0
import fromRadixNumber from dw::core::Numbers
output application/json
---
{
    a: fromRadixNumber("10", 2),
    b: fromRadixNumber("FF", 16)
}
```

#### Output

```JSON
{
  "a": 2,
  "b": 255
}
```

<!-- document id=6c026afb17fa7b9203425b6e344873c716897f4e233833b04af6aab9990460a3 url=/mulesoft/current/en-us/dataweave/2.4/dw-numbers-functions-fromradixnumber.md -->

---
product: DataWeave
version: 2.4
---

# fromRadixNumber

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fromRadixNumber(numberStr: String, radix: Number): Number

Transforms a number in the specified radix into decimal number

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>numberText</code></p></td><td><p>The number text.</p></td></tr><tr><td><p><code>radix</code></p></td><td><p>The radix number.</p></td></tr></tbody></table>

### Example

This example shows how the `fromRadixNumber` behaves under different inputs.

#### Source

```DataWeave
%dw 2.0
import fromRadixNumber from dw::core::Numbers
output application/json
---
{
    a: fromRadixNumber("10", 2),
    b: fromRadixNumber("FF", 16)
}
```

#### Output

```JSON
{
  "a": 2,
  "b": 255
}
```

<!-- document id=f36174800cd0bf5b3aa7d909e4aa24db4834e5a3021f077c00661a6398bf20a4 url=/mulesoft/current/en-us/dataweave/2.6/dw-numbers-functions-fromradixnumber.md -->

---
product: DataWeave
version: 2.6
---

# fromRadixNumber

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fromRadixNumber(numberStr: String, radix: Number): Number

Transforms a number in the specified radix into decimal number

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>numberText</code></p></td><td><p>The number text.</p></td></tr><tr><td><p><code>radix</code></p></td><td><p>The radix number.</p></td></tr></tbody></table>

### Example

This example shows how the `fromRadixNumber` behaves under different inputs.

#### Source

```DataWeave
%dw 2.0
import fromRadixNumber from dw::core::Numbers
output application/json
---
{
    a: fromRadixNumber("10", 2),
    b: fromRadixNumber("FF", 16)
}
```

#### Output

```JSON
{
  "a": 2,
  "b": 255
}
```

<!-- document id=bf158d1d8885c92cd5f718f81370c46f7ce7c2ac923476e81b339d23130c5cf7 url=/mulesoft/current/en-us/dataweave/2.9/dw-numbers-functions-fromradixnumber.md -->

---
product: DataWeave
version: 2.9
---

# fromRadixNumber

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fromRadixNumber(numberStr: String, radix: Number): Number

Transforms a number in the specified radix into decimal number

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>numberText</code></p></td><td><p>The number text.</p></td></tr><tr><td><p><code>radix</code></p></td><td><p>The radix number.</p></td></tr></tbody></table>

### Example

This example shows how the `fromRadixNumber` behaves under different inputs.

#### Source

```DataWeave
%dw 2.0
import fromRadixNumber from dw::core::Numbers
output application/json
---
{
    a: fromRadixNumber("10", 2),
    b: fromRadixNumber("FF", 16)
}
```

#### Output

```JSON
{
  "a": 2,
  "b": 255
}
```

<!-- document id=f069f61a28b0e67d12bc44f11ccc5693e7296d83d11f6bf5aca232704fe7a069 url=/mulesoft/current/en-us/dataweave/latest/dw-numbers-functions-fromradixnumber.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# fromRadixNumber

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fromRadixNumber(numberStr: String, radix: Number): Number

Transforms a number in the specified radix into decimal number

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>numberText</code></p></td><td><p>The number text.</p></td></tr><tr><td><p><code>radix</code></p></td><td><p>The radix number.</p></td></tr></tbody></table>

### Example

This example shows how the `fromRadixNumber` behaves under different inputs.

#### Source

```DataWeave
%dw 2.0
import fromRadixNumber from dw::core::Numbers
output application/json
---
{
    a: fromRadixNumber("10", 2),
    b: fromRadixNumber("FF", 16)
}
```

#### Output

```JSON
{
  "a": 2,
  "b": 255
}
```

<!-- document id=bb5c31660b50f2ffd5f93ddafce058d73050aca80aa2e23e65105ed05664876f url=/mulesoft/current/en-us/dataweave/2.11/dw-mime-functions-fromstring.md -->

---
product: DataWeave
version: 2.11
---

# fromString

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fromString(mimeType: String): Result<MimeType, MimeTypeError>

Transforms a MIME type string value representation to a `MimeType`.

_Introduced in DataWeave version 2.7.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>mimeType</code></p></td><td><p>String</p></td><td><p>The MIME type string value to transform to a <code>MimeType</code>.</p></td></tr></tbody></table>

### Example

This example transforms a MIME type string value without `parameters` to a `MimeType` value.

#### Source

```DataWeave
%dw 2.0
import * from dw::module::Mime
output application/json
---
fromString("application/json")
```

#### Output

```Json
{
  "success": true,
  "result": {
      "type": "application",
      "subtype": "json",
      "parameters": {}
  }
}
```

### Example

This example transforms a MIME type string value that includes a `parameters` to a `MimeType` value.

#### Source

```DataWeave
%dw 2.0
import * from dw::module::Mime
output application/json
---
fromString("multipart/form-data; boundary=the-boundary")
```

#### Output

```Json
{
  "success": true,
  "result": {
      "type": "multipart",
      "subtype": "form-data",
      "parameters": {
          "boundary": "the-boundary"
      }
  }
}
```

### Example

This example transforms an invalid MIME type string value.

#### Source

```DataWeave
%dw 2.0
import * from dw::module::Mime
output application/json
---
fromString("Invalid MIME type")
```

#### Output

```Json
{
  "success": false,
  "error": {
      "message": "Unable to find a sub type in `Invalid MIME type`."
  }
}
```

<!-- document id=fb531b40ec5b94d10fbaeceafc30267bbf0070a18fbefeafefe2430195f4235d url=/mulesoft/current/en-us/dataweave/2.12/dw-mime-functions-fromstring.md -->

---
product: DataWeave
version: 2.12
---

# fromString

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fromString(mimeType: String): Result<MimeType, MimeTypeError>

Transforms a MIME type string value representation to a `MimeType`.

_Introduced in DataWeave version 2.7.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>mimeType</code></p></td><td><p>String</p></td><td><p>The MIME type string value to transform to a <code>MimeType</code>.</p></td></tr></tbody></table>

### Example

This example transforms a MIME type string value without `parameters` to a `MimeType` value.

#### Source

```DataWeave
%dw 2.0
import * from dw::module::Mime
output application/json
---
fromString("application/json")
```

#### Output

```Json
{
  "success": true,
  "result": {
      "type": "application",
      "subtype": "json",
      "parameters": {}
  }
}
```

### Example

This example transforms a MIME type string value that includes a `parameters` to a `MimeType` value.

#### Source

```DataWeave
%dw 2.0
import * from dw::module::Mime
output application/json
---
fromString("multipart/form-data; boundary=the-boundary")
```

#### Output

```Json
{
  "success": true,
  "result": {
      "type": "multipart",
      "subtype": "form-data",
      "parameters": {
          "boundary": "the-boundary"
      }
  }
}
```

### Example

This example transforms an invalid MIME type string value.

#### Source

```DataWeave
%dw 2.0
import * from dw::module::Mime
output application/json
---
fromString("Invalid MIME type")
```

#### Output

```Json
{
  "success": false,
  "error": {
      "message": "Unable to find a sub type in `Invalid MIME type`."
  }
}
```

<!-- document id=0e10c070edb8f3145be1c265b38fe8c750e84db6f203944ea1d7134da3bfa99e url=/mulesoft/current/en-us/dataweave/2.9/dw-mime-functions-fromstring.md -->

---
product: DataWeave
version: 2.9
---

# fromString

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fromString(mimeType: String): Result<MimeType, MimeTypeError>

Transforms a MIME type string value representation to a `MimeType`.

_Introduced in DataWeave version 2.7.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>mimeType</code></p></td><td><p>String</p></td><td><p>The MIME type string value to transform to a <code>MimeType</code>.</p></td></tr></tbody></table>

### Example

This example transforms a MIME type string value without `parameters` to a `MimeType` value.

#### Source

```DataWeave
%dw 2.0
import * from dw::module::Mime
output application/json
---
fromString("application/json")
```

#### Output

```Json
{
  "success": true,
  "result": {
      "type": "application",
      "subtype": "json",
      "parameters": {}
  }
}
```

### Example

This example transforms a MIME type string value that includes a `parameters` to a `MimeType` value.

#### Source

```DataWeave
%dw 2.0
import * from dw::module::Mime
output application/json
---
fromString("multipart/form-data; boundary=the-boundary")
```

#### Output

```Json
{
  "success": true,
  "result": {
      "type": "multipart",
      "subtype": "form-data",
      "parameters": {
          "boundary": "the-boundary"
      }
  }
}
```

### Example

This example transforms an invalid MIME type string value.

#### Source

```DataWeave
%dw 2.0
import * from dw::module::Mime
output application/json
---
fromString("Invalid MIME type")
```

#### Output

```Json
{
  "success": false,
  "error": {
      "message": "Unable to find a sub type in `Invalid MIME type`."
  }
}
```

<!-- document id=f6b050079f8af1ab1153ed1f97af7690180c7cdd2f49c6ffb941fff1e12b5b45 url=/mulesoft/current/en-us/dataweave/latest/dw-mime-functions-fromstring.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# fromString

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## fromString(mimeType: String): Result<MimeType, MimeTypeError>

Transforms a MIME type string value representation to a `MimeType`.

_Introduced in DataWeave version 2.7.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>mimeType</code></p></td><td><p>String</p></td><td><p>The MIME type string value to transform to a <code>MimeType</code>.</p></td></tr></tbody></table>

### Example

This example transforms a MIME type string value without `parameters` to a `MimeType` value.

#### Source

```DataWeave
%dw 2.0
import * from dw::module::Mime
output application/json
---
fromString("application/json")
```

#### Output

```Json
{
  "success": true,
  "result": {
      "type": "application",
      "subtype": "json",
      "parameters": {}
  }
}
```

### Example

This example transforms a MIME type string value that includes a `parameters` to a `MimeType` value.

#### Source

```DataWeave
%dw 2.0
import * from dw::module::Mime
output application/json
---
fromString("multipart/form-data; boundary=the-boundary")
```

#### Output

```Json
{
  "success": true,
  "result": {
      "type": "multipart",
      "subtype": "form-data",
      "parameters": {
          "boundary": "the-boundary"
      }
  }
}
```

### Example

This example transforms an invalid MIME type string value.

#### Source

```DataWeave
%dw 2.0
import * from dw::module::Mime
output application/json
---
fromString("Invalid MIME type")
```

#### Output

```Json
{
  "success": false,
  "error": {
      "message": "Unable to find a sub type in `Invalid MIME type`."
  }
}
```

<!-- document id=3bf0edd92b45b908ca1c328c1db6dc6dc765d5fe5b85457bde60bb103c9eee02 url=/mulesoft/current/en-us/dataweave/2.11/dw-types-functions-functionparamtypes.md -->

---
product: DataWeave
version: 2.11
---

# functionParamTypes

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## functionParamTypes(t: Type): Array<FunctionParam>

Returns the list of parameters from the given function type. This function fails if the provided
type is not a Function type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The function type.</p></td></tr></tbody></table>

### Example

This example shows how `functionParamTypes` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::core::Types
type AFunction = (String, Number) -> Number
type AFunction2 = () -> Number
---
{
    a: functionParamTypes(AFunction),
    b: functionParamTypes(AFunction2)
}
```

#### Output

```Json
{
   "a": [
     {
       "paramType": "String",
       "optional": false
     },
     {
       "paramType": "Number",
       "optional": false
     }
   ],
   "b": [

   ]
 }
```

<!-- document id=22d50ee279aa99efd30d0ce8d99f7c2557de8ca69a9f068134cf7b8fc4af8230 url=/mulesoft/current/en-us/dataweave/2.12/dw-types-functions-functionparamtypes.md -->

---
product: DataWeave
version: 2.12
---

# functionParamTypes

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## functionParamTypes(t: Type): Array<FunctionParam>

Returns the list of parameters from the given function type. This function fails if the provided
type is not a Function type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The function type.</p></td></tr></tbody></table>

### Example

This example shows how `functionParamTypes` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::core::Types
type AFunction = (String, Number) -> Number
type AFunction2 = () -> Number
---
{
    a: functionParamTypes(AFunction),
    b: functionParamTypes(AFunction2)
}
```

#### Output

```Json
{
   "a": [
     {
       "paramType": "String",
       "optional": false
     },
     {
       "paramType": "Number",
       "optional": false
     }
   ],
   "b": [

   ]
 }
```

<!-- document id=838d2b49494010a77ea6ea1ccff36959762736e7894a49e05f71ed4626d7b558 url=/mulesoft/current/en-us/dataweave/2.3/dw-types-functions-functionparamtypes.md -->

---
product: DataWeave
version: 2.3
---

# functionParamTypes

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## functionParamTypes(Type): Array<FunctionParam>

Returns the list of parameters from the given function type. This function fails if the provided
type is not a Function type.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>t</p></td><td><p>The function type.</p></td></tr></tbody></table>

### Example

This example shows how `functionParamTypes` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::core::Types
type AFunction = (String, Number) -> Number
type AFunction2 = () -> Number
---
{
    a: functionParamTypes(AFunction),
    b: functionParamTypes(AFunction2)
}
```

#### Output

```Json
 {
    "a": [
      {
        "paramType": "String",
        "optional": false
      },
      {
        "paramType": "Number",
        "optional": false
      }
    ],
    "b": [

    ]
  }
```

<!-- document id=9cfd92d40443baebd08d244462ffae545287031aa87c53f72ab5ae4020fa37b7 url=/mulesoft/current/en-us/dataweave/2.4/dw-types-functions-functionparamtypes.md -->

---
product: DataWeave
version: 2.4
---

# functionParamTypes

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## functionParamTypes(t: Type): Array<FunctionParam>

Returns the list of parameters from the given function type. This function fails if the provided
type is not a Function type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The function type.</p></td></tr></tbody></table>

### Example

This example shows how `functionParamTypes` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::core::Types
type AFunction = (String, Number) -> Number
type AFunction2 = () -> Number
---
{
    a: functionParamTypes(AFunction),
    b: functionParamTypes(AFunction2)
}
```

#### Output

```Json
{
   "a": [
     {
       "paramType": "String",
       "optional": false
     },
     {
       "paramType": "Number",
       "optional": false
     }
   ],
   "b": [

   ]
 }
```

<!-- document id=953e8c1ef661504d80b4818072f240c6209910a6e1ba6a2624b48426359897b5 url=/mulesoft/current/en-us/dataweave/2.6/dw-types-functions-functionparamtypes.md -->

---
product: DataWeave
version: 2.6
---

# functionParamTypes

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## functionParamTypes(t: Type): Array<FunctionParam>

Returns the list of parameters from the given function type. This function fails if the provided
type is not a Function type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The function type.</p></td></tr></tbody></table>

### Example

This example shows how `functionParamTypes` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::core::Types
type AFunction = (String, Number) -> Number
type AFunction2 = () -> Number
---
{
    a: functionParamTypes(AFunction),
    b: functionParamTypes(AFunction2)
}
```

#### Output

```Json
{
   "a": [
     {
       "paramType": "String",
       "optional": false
     },
     {
       "paramType": "Number",
       "optional": false
     }
   ],
   "b": [

   ]
 }
```

<!-- document id=27ad6805d54395caaa03e43ac8ab89891256b02e6647356e68d2a3e49ae09912 url=/mulesoft/current/en-us/dataweave/2.9/dw-types-functions-functionparamtypes.md -->

---
product: DataWeave
version: 2.9
---

# functionParamTypes

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## functionParamTypes(t: Type): Array<FunctionParam>

Returns the list of parameters from the given function type. This function fails if the provided
type is not a Function type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The function type.</p></td></tr></tbody></table>

### Example

This example shows how `functionParamTypes` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::core::Types
type AFunction = (String, Number) -> Number
type AFunction2 = () -> Number
---
{
    a: functionParamTypes(AFunction),
    b: functionParamTypes(AFunction2)
}
```

#### Output

```Json
{
   "a": [
     {
       "paramType": "String",
       "optional": false
     },
     {
       "paramType": "Number",
       "optional": false
     }
   ],
   "b": [

   ]
 }
```

<!-- document id=236f6f502ec45574e82892bbae986143d8455cbd5391a70bb8bed446d23ece94 url=/mulesoft/current/en-us/dataweave/latest/dw-types-functions-functionparamtypes.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# functionParamTypes

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## functionParamTypes(t: Type): Array<FunctionParam>

Returns the list of parameters from the given function type. This function fails if the provided
type is not a Function type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The function type.</p></td></tr></tbody></table>

### Example

This example shows how `functionParamTypes` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::core::Types
type AFunction = (String, Number) -> Number
type AFunction2 = () -> Number
---
{
    a: functionParamTypes(AFunction),
    b: functionParamTypes(AFunction2)
}
```

#### Output

```Json
{
   "a": [
     {
       "paramType": "String",
       "optional": false
     },
     {
       "paramType": "Number",
       "optional": false
     }
   ],
   "b": [

   ]
 }
```

<!-- document id=bf1cbdf0d364fdcca8dc5899c00fe0abc6570cc3cd85cac41c749b2629b73dca url=/mulesoft/current/en-us/dataweave/2.11/dw-types-functions-functionreturntype.md -->

---
product: DataWeave
version: 2.11
---

# functionReturnType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## functionReturnType(t: Type): Type | Null

Returns the type of a function’s return type. This function fails if the input type is not a
Function type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The function type.</p></td></tr></tbody></table>

### Example

This example shows how `functionReturnType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::core::Types
type AFunction = (String, Number) -> Number
type AFunction2 = () -> Number
---
{
    a: functionReturnType(AFunction),
    b: functionReturnType(AFunction2)
}
```

#### Output

```Json
{
  "a": "Number",
  "b": "Number"
}
```

<!-- document id=bd93cbbab759f36cf92e34b65338b1e5d6c0041ee6fa369a25adf2c3187f2fe9 url=/mulesoft/current/en-us/dataweave/2.12/dw-types-functions-functionreturntype.md -->

---
product: DataWeave
version: 2.12
---

# functionReturnType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## functionReturnType(t: Type): Type | Null

Returns the type of a function’s return type. This function fails if the input type is not a
Function type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The function type.</p></td></tr></tbody></table>

### Example

This example shows how `functionReturnType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::core::Types
type AFunction = (String, Number) -> Number
type AFunction2 = () -> Number
---
{
    a: functionReturnType(AFunction),
    b: functionReturnType(AFunction2)
}
```

#### Output

```Json
{
  "a": "Number",
  "b": "Number"
}
```

<!-- document id=6355f838f9edea7339c723682a05db41e7d5e868f0bd12b2de4d8baf3dcb3ec1 url=/mulesoft/current/en-us/dataweave/2.3/dw-types-functions-functionreturntype.md -->

---
product: DataWeave
version: 2.3
---

# functionReturnType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## functionReturnType(Type): Type | Null

Returns the type of a function’s return type. This function fails if the input type is not a
Function type.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>t</p></td><td><p>The function type.</p></td></tr></tbody></table>

### Example

This example shows how `functionReturnType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::core::Types
type AFunction = (String, Number) -> Number
type AFunction2 = () -> Number
---
{
    a: functionReturnType(AFunction),
    b: functionReturnType(AFunction2)
}
```

#### Output

```Json
 {
    "a": "Number",
    "b": "Number"
  }
```

<!-- document id=0a07bee84cee58a4fac4786b6ef5ebf85dd942572a30fef02fe2c65a4d5518bd url=/mulesoft/current/en-us/dataweave/2.4/dw-types-functions-functionreturntype.md -->

---
product: DataWeave
version: 2.4
---

# functionReturnType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## functionReturnType(t: Type): Type | Null

Returns the type of a function’s return type. This function fails if the input type is not a
Function type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The function type.</p></td></tr></tbody></table>

### Example

This example shows how `functionReturnType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::core::Types
type AFunction = (String, Number) -> Number
type AFunction2 = () -> Number
---
{
    a: functionReturnType(AFunction),
    b: functionReturnType(AFunction2)
}
```

#### Output

```Json
{
  "a": "Number",
  "b": "Number"
}
```

<!-- document id=ebf9c816b3a6e3b0620495349bd5e711ccf59f9355c3d6e44f76fd117530f23f url=/mulesoft/current/en-us/dataweave/2.6/dw-types-functions-functionreturntype.md -->

---
product: DataWeave
version: 2.6
---

# functionReturnType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## functionReturnType(t: Type): Type | Null

Returns the type of a function’s return type. This function fails if the input type is not a
Function type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The function type.</p></td></tr></tbody></table>

### Example

This example shows how `functionReturnType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::core::Types
type AFunction = (String, Number) -> Number
type AFunction2 = () -> Number
---
{
    a: functionReturnType(AFunction),
    b: functionReturnType(AFunction2)
}
```

#### Output

```Json
{
  "a": "Number",
  "b": "Number"
}
```

<!-- document id=754c3d16cb8686cd43d19afda4328bd92b2584a350d490edddade6b3329a6834 url=/mulesoft/current/en-us/dataweave/2.9/dw-types-functions-functionreturntype.md -->

---
product: DataWeave
version: 2.9
---

# functionReturnType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## functionReturnType(t: Type): Type | Null

Returns the type of a function’s return type. This function fails if the input type is not a
Function type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The function type.</p></td></tr></tbody></table>

### Example

This example shows how `functionReturnType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::core::Types
type AFunction = (String, Number) -> Number
type AFunction2 = () -> Number
---
{
    a: functionReturnType(AFunction),
    b: functionReturnType(AFunction2)
}
```

#### Output

```Json
{
  "a": "Number",
  "b": "Number"
}
```

<!-- document id=846ca3f89e69eb4a95b93c04554b992b88d1a78768fe27b25af4011290dd1f49 url=/mulesoft/current/en-us/dataweave/latest/dw-types-functions-functionreturntype.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# functionReturnType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## functionReturnType(t: Type): Type | Null

Returns the type of a function’s return type. This function fails if the input type is not a
Function type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The function type.</p></td></tr></tbody></table>

### Example

This example shows how `functionReturnType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::core::Types
type AFunction = (String, Number) -> Number
type AFunction2 = () -> Number
---
{
    a: functionReturnType(AFunction),
    b: functionReturnType(AFunction2)
}
```

#### Output

```Json
{
  "a": "Number",
  "b": "Number"
}
```

<!-- document id=eb66dd08cce5263b2512785a5a1c762e65def8630d5a882b9f1b57b094efa9b2 url=/mulesoft/current/en-us/dataweave/2.11/dw-multipart-functions-generateboundary.md -->

---
product: DataWeave
version: 2.11
---

# generateBoundary

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## generateBoundary(len: Number = 70): String

Helper function for generating boundaries in `Multipart` data structures.

<!-- document id=ff45d4df4d015ee322b7e9fae91ed6fb064aee31e9a0986ed9d6fd45934239ce url=/mulesoft/current/en-us/dataweave/2.12/dw-multipart-functions-generateboundary.md -->

---
product: DataWeave
version: 2.12
---

# generateBoundary

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## generateBoundary(len: Number = 70): String

Helper function for generating boundaries in `Multipart` data structures.

<!-- document id=d7f2ef2b38f58a46a0b69ff2fbf474a98b8db6802d21040e2a4d5778e32fbc66 url=/mulesoft/current/en-us/dataweave/2.3/dw-multipart-functions-generateboundary.md -->

---
product: DataWeave
version: 2.3
---

# generateBoundary

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## generateBoundary(Number): String

Helper function for generating boundaries in `Multipart` data structures.

<!-- document id=a3dcd74859adc001a6ca459b5f35b601b2ef372c362bff5e59807f9a95e43ee9 url=/mulesoft/current/en-us/dataweave/2.4/dw-multipart-functions-generateboundary.md -->

---
product: DataWeave
version: 2.4
---

# generateBoundary

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## generateBoundary(len: Number = 70): String

Helper function for generating boundaries in `Multipart` data structures.

<!-- document id=9085a4a7cbd1e678b8355b255e14b8ebd45993bc0edfabd403ac85f2439f9163 url=/mulesoft/current/en-us/dataweave/2.6/dw-multipart-functions-generateboundary.md -->

---
product: DataWeave
version: 2.6
---

# generateBoundary

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## generateBoundary(len: Number = 70): String

Helper function for generating boundaries in `Multipart` data structures.

<!-- document id=2b23450ee7fbf01f2ba7f4c55c81954b9bd9e8f5f184544ca2d545028b343ad6 url=/mulesoft/current/en-us/dataweave/2.9/dw-multipart-functions-generateboundary.md -->

---
product: DataWeave
version: 2.9
---

# generateBoundary

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## generateBoundary(len: Number = 70): String

Helper function for generating boundaries in `Multipart` data structures.

<!-- document id=18ab484dd9392ea7bd6c1555db50aa15e95f508207ce592882311e28b48022be url=/mulesoft/current/en-us/dataweave/latest/dw-multipart-functions-generateboundary.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# generateBoundary

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## generateBoundary(len: Number = 70): String

Helper function for generating boundaries in `Multipart` data structures.

<!-- document id=fc70ed7a0dcc154f20ab61390edc1b26dff7b454bb3d9d052ca016dbcc040e16 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-groupby.md -->

---
product: DataWeave
version: 2.11
---

# groupBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## groupBy<T, R>(items: Array<T>, criteria: (item: T, index: Number) -> R): {| (R): Array<T> |}

Returns an object that groups items from an array based on specified criteria, such as an expression
or matching selector.

This version of `groupBy` groups the elements of an array using the `criteria` function. Other
versions act on objects and handle null values.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The array to group.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>Expression providing the criteria by which to group the items in the array.</p></td></tr></tbody></table>

### Example

This example groups items from the input array `["a","b","c"]` by their indices. Notice that it
returns the numeric indices as strings and that items (or values) of the array are returned as
arrays, in this case, with a single item each. The items in the array are grouped based on an
anonymous function `(item, index) → index` that uses named parameters (`item` and `index`). Note
that you can produce the same result using the anonymous parameter `$$` to identify the indices of
the array like this: `["a","b","c"] groupBy $$`

#### Source

```DataWeave
%dw 2.0
output application/json
---
["a","b","c"] groupBy (item, index) -> index
```

#### Output

```JSON
{ "2": [ "c" ], "1": [ "b" ], "0": [ "a" ] }
```

### Example

This example groups the elements of an array based on the language field. Notice that it uses the
`item.language` selector to specify the grouping criteria. So the resulting object uses the
"language" values (`"Scala"` and `"Java"`) from the input to group the output. Also notice that the
output places the each input object in an array.

#### Source

```DataWeave
%dw 2.0
var myArray = [
   { "name": "Foo", "language": "Java" },
   { "name": "Bar", "language": "Scala" },
   { "name": "FooBar", "language": "Java" }
]
output application/json
---
myArray groupBy (item) -> item.language
```

#### Output

```JSON
{
  "Scala": [
    { "name": "Bar", "language": "Scala" }
  ],
  "Java": [
    { "name": "Foo", "language": "Java" },
    { "name": "FooBar", "language": "Java" }
  ]
}
```

### Example

This example uses ``groupBy "myLabels"`to return an object where `"mylabels"`` is the key, and an
array of selected values (`["Open New", "Zoom In", "Zoom Out", "Original View" ]`) is the value. It
uses the selectors (`myVar.menu.items.*label`) to create that array. Notice that the selectors
retain all values where `"label"` is the key but filter out values where `"id"` is the key.

#### Source

```DataWeave
%dw 2.0
var myVar = { menu: {
    header: "Move Items",
    items: [
        {"id": "internal"},
        {"id": "left", "label": "Move Left"},
        {"id": "right", "label": "Move Right"},
        {"id": "up", "label": "Move Up"},
        {"id": "down", "label": "Move Down"}
    ]
}}
output application/json
---
(myVar.menu.items.*label groupBy "myLabels")
```

#### Output

```JSON
{ "myLabels": [ "Move Left", "Move Right", "Move Up", "Move Down" ] }
```

## groupBy<R>(text: String, criteria: (character: String, index: Number) -> R): { (R): String }

Returns an object that groups characters from a string based on specified criteria, such as an
expression or matching selector.

This version of `groupBy` groups the elements of an array using the `criteria` function. Other
versions act on objects and handle `null` values.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to group by.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The criteria to use.</p></td></tr></tbody></table>

### Example

This example shows howyou can use `groupBy` to split a string into vowels and not vowels.

#### Source

```DataWeave
%dw 2.0
output application/json
---
"hello world!" groupBy (not isEmpty($ find /[aeiou]/))
```

#### Output

```Json
{
  "false": "hll wrld!",
  "true": "eoo"
}
```

## groupBy<K, V, R>(object: { (K)?: V }, criteria: (value: V, key: K) -> R): { (R): { (K)?: V } }

Groups elements of an object based on criteria that the `groupBy` uses to iterate over elements in
the input.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object containing objects to group.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The grouping criteria to apply to elements in the input object, such as a <code>key</code> and/or <code>value</code> of the object to use for grouping.</p></td></tr></tbody></table>

### Example

This example groups objects within an array of objects using the anonymous parameter `$` for the
value of each key in the input objects. It applies the DataWeave `upper` function to those values.
In the output, these values become upper-case keys. Note that you can also write the same example
using a named parameter for the within an anonymous function like this:
`{ "a" : "b", "c" : "d"} groupBy (value) → upper(value)`

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "a" : "b", "c" : "d"} groupBy upper($)
```

#### Output

```JSON
{ "D": { "c": "d" }, "B": { "a": "b" } }
```

### Example

This example uses `groupBy "costs"` to produce a JSON object from an XML object where `"costs"` is
the key, and the selected values of the XML element `prices` becomes the JSON value
(`{ "price": "9.99", "price": "10.99" }`).

#### Source

```DataWeave
%dw 2.0
var myRead =
read("<prices><price>9.99</price><price>10.99</price></prices>","application/xml")
output application/json
---
myRead.prices groupBy "costs"
```

#### Output

```JSON
{ "costs" : { "price": "9.99", "price": "10.99" } }
```

## groupBy(value: Null, criteria: (Nothing, Nothing) -> Any): Null

Helper function that enables `groupBy` to work with a `null` value.

<!-- document id=646f0dfef78bccd5cbf5884b72fbca3e532e0bb6c24df0cdbb1162eefc76474c url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-groupby.md -->

---
product: DataWeave
version: 2.12
---

# groupBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## groupBy<T, R>(items: Array<T>, criteria: (item: T, index: Number) -> R): {| (R): Array<T> |}

Returns an object that groups items from an array based on specified criteria, such as an expression
or matching selector.

This version of `groupBy` groups the elements of an array using the `criteria` function. Other
versions act on objects and handle null values.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The array to group.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>Expression providing the criteria by which to group the items in the array.</p></td></tr></tbody></table>

### Example

This example groups items from the input array `["a","b","c"]` by their indices. Notice that it
returns the numeric indices as strings and that items (or values) of the array are returned as
arrays, in this case, with a single item each. The items in the array are grouped based on an
anonymous function `(item, index) → index` that uses named parameters (`item` and `index`). Note
that you can produce the same result using the anonymous parameter `$$` to identify the indices of
the array like this: `["a","b","c"] groupBy $$`

#### Source

```DataWeave
%dw 2.0
output application/json
---
["a","b","c"] groupBy (item, index) -> index
```

#### Output

```JSON
{ "2": [ "c" ], "1": [ "b" ], "0": [ "a" ] }
```

### Example

This example groups the elements of an array based on the language field. Notice that it uses the
`item.language` selector to specify the grouping criteria. So the resulting object uses the
"language" values (`"Scala"` and `"Java"`) from the input to group the output. Also notice that the
output places the each input object in an array.

#### Source

```DataWeave
%dw 2.0
var myArray = [
   { "name": "Foo", "language": "Java" },
   { "name": "Bar", "language": "Scala" },
   { "name": "FooBar", "language": "Java" }
]
output application/json
---
myArray groupBy (item) -> item.language
```

#### Output

```JSON
{
  "Scala": [
    { "name": "Bar", "language": "Scala" }
  ],
  "Java": [
    { "name": "Foo", "language": "Java" },
    { "name": "FooBar", "language": "Java" }
  ]
}
```

### Example

This example uses ``groupBy "myLabels"`to return an object where `"mylabels"`` is the key, and an
array of selected values (`["Open New", "Zoom In", "Zoom Out", "Original View" ]`) is the value. It
uses the selectors (`myVar.menu.items.*label`) to create that array. Notice that the selectors
retain all values where `"label"` is the key but filter out values where `"id"` is the key.

#### Source

```DataWeave
%dw 2.0
var myVar = { menu: {
    header: "Move Items",
    items: [
        {"id": "internal"},
        {"id": "left", "label": "Move Left"},
        {"id": "right", "label": "Move Right"},
        {"id": "up", "label": "Move Up"},
        {"id": "down", "label": "Move Down"}
    ]
}}
output application/json
---
(myVar.menu.items.*label groupBy "myLabels")
```

#### Output

```JSON
{ "myLabels": [ "Move Left", "Move Right", "Move Up", "Move Down" ] }
```

## groupBy<R>(text: String, criteria: (character: String, index: Number) -> R): { (R): String }

Returns an object that groups characters from a string based on specified criteria, such as an
expression or matching selector.

This version of `groupBy` groups the elements of an array using the `criteria` function. Other
versions act on objects and handle `null` values.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to group by.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The criteria to use.</p></td></tr></tbody></table>

### Example

This example shows howyou can use `groupBy` to split a string into vowels and not vowels.

#### Source

```DataWeave
%dw 2.0
output application/json
---
"hello world!" groupBy (not isEmpty($ find /[aeiou]/))
```

#### Output

```Json
{
  "false": "hll wrld!",
  "true": "eoo"
}
```

## groupBy<K, V, R>(object: { (K)?: V }, criteria: (value: V, key: K) -> R): { (R): { (K)?: V } }

Groups elements of an object based on criteria that the `groupBy` uses to iterate over elements in
the input.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object containing objects to group.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The grouping criteria to apply to elements in the input object, such as a <code>key</code> and/or <code>value</code> of the object to use for grouping.</p></td></tr></tbody></table>

### Example

This example groups objects within an array of objects using the anonymous parameter `$` for the
value of each key in the input objects. It applies the DataWeave `upper` function to those values.
In the output, these values become upper-case keys. Note that you can also write the same example
using a named parameter for the within an anonymous function like this:
`{ "a" : "b", "c" : "d"} groupBy (value) → upper(value)`

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "a" : "b", "c" : "d"} groupBy upper($)
```

#### Output

```JSON
{ "D": { "c": "d" }, "B": { "a": "b" } }
```

### Example

This example uses `groupBy "costs"` to produce a JSON object from an XML object where `"costs"` is
the key, and the selected values of the XML element `prices` becomes the JSON value
(`{ "price": "9.99", "price": "10.99" }`).

#### Source

```DataWeave
%dw 2.0
var myRead =
read("<prices><price>9.99</price><price>10.99</price></prices>","application/xml")
output application/json
---
myRead.prices groupBy "costs"
```

#### Output

```JSON
{ "costs" : { "price": "9.99", "price": "10.99" } }
```

## groupBy(value: Null, criteria: (Nothing, Nothing) -> Any): Null

Helper function that enables `groupBy` to work with a `null` value.

<!-- document id=10a3654a5bb252ad2da3b0bee431c3c5ca57b89d518285dc474763beff6d33d2 url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-groupby.md -->

---
product: DataWeave
version: 2.3
---

# groupBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## groupBy(Array<T>, (item: T, index: Number) -> R): { (R): Array<T> }

Returns an object that groups items from an array based on specified criteria, such as an expression
or matching selector.

This version of `groupBy` groups the elements of an array using the `criteria` function. Other
versions act on objects and handle null values.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The array to group.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>Expression providing the criteria by which to group the items in the array.</p></td></tr></tbody></table>

### Example

This example groups items from the input array `["a","b","c"]` by their indices. Notice that it
returns the numeric indices as strings and that items (or values) of the array are returned as
arrays, in this case, with a single item each. The items in the array are grouped based on an
anonymous function `(item, index) → index` that uses named parameters (`item` and `index`). Note
that you can produce the same result using the anonymous parameter `$$` to identify the indices of
the array like this: `["a","b","c"] groupBy $$`

#### Source

```DataWeave
%dw 2.0
output application/json
---
["a","b","c"] groupBy (item, index) -> index
```

#### Output

```JSON
{ "2": [ "c" ], "1": [ "b" ], "0": [ "a" ] }
```

### Example

This example groups the elements of an array based on the language field. Notice that it uses the
`item.language` selector to specify the grouping criteria. So the resulting object uses the
"language" values (`"Scala"` and `"Java"`) from the input to group the output. Also notice that the
output places the each input object in an array.

#### Source

```DataWeave
%dw 2.0
var myArray = [
   { "name": "Foo", "language": "Java" },
   { "name": "Bar", "language": "Scala" },
   { "name": "FooBar", "language": "Java" }
]
output application/json
---
myArray groupBy (item) -> item.language
```

#### Output

```JSON
{
  "Scala": [
    { "name": "Bar", "language": "Scala" }
  ],
  "Java": [
    { "name": "Foo", "language": "Java" },
    { "name": "FooBar", "language": "Java" }
  ]
}
```

### Example

This example uses ``groupBy "myLabels"`to return an object where `"mylabels"`` is the key, and an
array of selected values (`["Open New", "Zoom In", "Zoom Out", "Original View" ]`) is the value. It
uses the selectors (`myVar.menu.items.*label`) to create that array. Notice that the selectors
retain all values where `"label"` is the key but filter out values where `"id"` is the key.

#### Source

```DataWeave
%dw 2.0
var myVar = { menu: {
    header: "Move Items",
    items: [
        {"id": "internal"},
        {"id": "left", "label": "Move Left"},
        {"id": "right", "label": "Move Right"},
        {"id": "up", "label": "Move Up"},
        {"id": "down", "label": "Move Down"}
    ]
}}
output application/json
---
(myVar.menu.items.*label groupBy "myLabels")
```

#### Output

```JSON
{ "myLabels": [ "Move Left", "Move Right", "Move Up", "Move Down" ] }
```

## groupBy({ (K)?: V }, (value: V, key: K) -> R): { (R): { (K)?: V } }

Groups elements of an object based on criteria that the `groupBy` uses to iterate over elements in
the input.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object containing objects to group.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The grouping criteria to apply to elements in the input object, such as a <code>key</code> and/or <code>value</code> of the object to use for grouping.</p></td></tr></tbody></table>

### Example

This example groups objects within an array of objects using the anonymous parameter `$` for the
value of each key in the input objects. It applies the DataWeave `upper` function to those values.
In the output, these values become upper-case keys. Note that you can also write the same example
using a named parameter for the within an anonymous function like this:
`{ "a" : "b", "c" : "d"} groupBy (value) → upper(value)`

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "a" : "b", "c" : "d"} groupBy upper($)
```

#### Output

```JSON
{ "D": { "c": "d" }, "B": { "a": "b" } }
```

### Example

This example uses `groupBy "costs"` to produce a JSON object from an XML object where `"costs"` is
the key, and the selected values of the XML element `prices` becomes the JSON value
(`{ "price": "9.99", "price": "10.99" }`).

#### Source

```DataWeave
%dw 2.0
var myRead =
read("<prices><price>9.99</price><price>10.99</price></prices>","application/xml")
output application/json
---
myRead.prices groupBy "costs"
```

#### Output

```JSON
{ "costs" : { "price": "9.99", "price": "10.99" } }
```

## groupBy(Null, (Nothing, Nothing) -> Any): Null

Helper function that enables `groupBy` to work with a `null` value.

<!-- document id=481b34836de84548e50c567e6c167e8e7022d3621eaf0fa823e26124ad3ff539 url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-groupby.md -->

---
product: DataWeave
version: 2.4
---

# groupBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## groupBy<T, R>(items: Array<T>, criteria: (item: T, index: Number) -> R): { (R): Array<T> }

Returns an object that groups items from an array based on specified criteria, such as an expression
or matching selector.

This version of `groupBy` groups the elements of an array using the `criteria` function. Other
versions act on objects and handle null values.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The array to group.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>Expression providing the criteria by which to group the items in the array.</p></td></tr></tbody></table>

### Example

This example groups items from the input array `["a","b","c"]` by their indices. Notice that it
returns the numeric indices as strings and that items (or values) of the array are returned as
arrays, in this case, with a single item each. The items in the array are grouped based on an
anonymous function `(item, index) → index` that uses named parameters (`item` and `index`). Note
that you can produce the same result using the anonymous parameter `$$` to identify the indices of
the array like this: `["a","b","c"] groupBy $$`

#### Source

```DataWeave
%dw 2.0
output application/json
---
["a","b","c"] groupBy (item, index) -> index
```

#### Output

```JSON
{ "2": [ "c" ], "1": [ "b" ], "0": [ "a" ] }
```

### Example

This example groups the elements of an array based on the language field. Notice that it uses the
`item.language` selector to specify the grouping criteria. So the resulting object uses the
"language" values (`"Scala"` and `"Java"`) from the input to group the output. Also notice that the
output places the each input object in an array.

#### Source

```DataWeave
%dw 2.0
var myArray = [
   { "name": "Foo", "language": "Java" },
   { "name": "Bar", "language": "Scala" },
   { "name": "FooBar", "language": "Java" }
]
output application/json
---
myArray groupBy (item) -> item.language
```

#### Output

```JSON
{
  "Scala": [
    { "name": "Bar", "language": "Scala" }
  ],
  "Java": [
    { "name": "Foo", "language": "Java" },
    { "name": "FooBar", "language": "Java" }
  ]
}
```

### Example

This example uses ``groupBy "myLabels"`to return an object where `"mylabels"`` is the key, and an
array of selected values (`["Open New", "Zoom In", "Zoom Out", "Original View" ]`) is the value. It
uses the selectors (`myVar.menu.items.*label`) to create that array. Notice that the selectors
retain all values where `"label"` is the key but filter out values where `"id"` is the key.

#### Source

```DataWeave
%dw 2.0
var myVar = { menu: {
    header: "Move Items",
    items: [
        {"id": "internal"},
        {"id": "left", "label": "Move Left"},
        {"id": "right", "label": "Move Right"},
        {"id": "up", "label": "Move Up"},
        {"id": "down", "label": "Move Down"}
    ]
}}
output application/json
---
(myVar.menu.items.*label groupBy "myLabels")
```

#### Output

```JSON
{ "myLabels": [ "Move Left", "Move Right", "Move Up", "Move Down" ] }
```

## groupBy<R>(text: String, criteria: (character: String, index: Number) -> R): { (R): String }

Returns an object that groups characters from a string based on specified criteria, such as an
expression or matching selector.

This version of `groupBy` groups the elements of an array using the `criteria` function. Other
versions act on objects and handle `null` values.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to group by.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The criteria to use.</p></td></tr></tbody></table>

### Example

This example shows howyou can use `groupBy` to split a string into vowels and not vowels.

#### Source

```DataWeave
%dw 2.0
output application/json
---
"hello world!" groupBy (not isEmpty($ find /[aeiou]/))
```

#### Output

```Json
{
  "false": "hll wrld!",
  "true": "eoo"
}
```

## groupBy<K, V, R>(object: { (K)?: V }, criteria: (value: V, key: K) -> R): { (R): { (K)?: V } }

Groups elements of an object based on criteria that the `groupBy` uses to iterate over elements in
the input.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object containing objects to group.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The grouping criteria to apply to elements in the input object, such as a <code>key</code> and/or <code>value</code> of the object to use for grouping.</p></td></tr></tbody></table>

### Example

This example groups objects within an array of objects using the anonymous parameter `$` for the
value of each key in the input objects. It applies the DataWeave `upper` function to those values.
In the output, these values become upper-case keys. Note that you can also write the same example
using a named parameter for the within an anonymous function like this:
`{ "a" : "b", "c" : "d"} groupBy (value) → upper(value)`

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "a" : "b", "c" : "d"} groupBy upper($)
```

#### Output

```JSON
{ "D": { "c": "d" }, "B": { "a": "b" } }
```

### Example

This example uses `groupBy "costs"` to produce a JSON object from an XML object where `"costs"` is
the key, and the selected values of the XML element `prices` becomes the JSON value
(`{ "price": "9.99", "price": "10.99" }`).

#### Source

```DataWeave
%dw 2.0
var myRead =
read("<prices><price>9.99</price><price>10.99</price></prices>","application/xml")
output application/json
---
myRead.prices groupBy "costs"
```

#### Output

```JSON
{ "costs" : { "price": "9.99", "price": "10.99" } }
```

## groupBy(value: Null, criteria: (Nothing, Nothing) -> Any): Null

Helper function that enables `groupBy` to work with a `null` value.

<!-- document id=0adb02ebf8430d3cdb480d738f8cdfb57360f552a9f571e2e72304842d59b32c url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-groupby.md -->

---
product: DataWeave
version: 2.6
---

# groupBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## groupBy<T, R>(items: Array<T>, criteria: (item: T, index: Number) -> R): {| (R): Array<T> |}

Returns an object that groups items from an array based on specified criteria, such as an expression
or matching selector.

This version of `groupBy` groups the elements of an array using the `criteria` function. Other
versions act on objects and handle null values.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The array to group.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>Expression providing the criteria by which to group the items in the array.</p></td></tr></tbody></table>

### Example

This example groups items from the input array `["a","b","c"]` by their indices. Notice that it
returns the numeric indices as strings and that items (or values) of the array are returned as
arrays, in this case, with a single item each. The items in the array are grouped based on an
anonymous function `(item, index) → index` that uses named parameters (`item` and `index`). Note
that you can produce the same result using the anonymous parameter `$$` to identify the indices of
the array like this: `["a","b","c"] groupBy $$`

#### Source

```DataWeave
%dw 2.0
output application/json
---
["a","b","c"] groupBy (item, index) -> index
```

#### Output

```JSON
{ "2": [ "c" ], "1": [ "b" ], "0": [ "a" ] }
```

### Example

This example groups the elements of an array based on the language field. Notice that it uses the
`item.language` selector to specify the grouping criteria. So the resulting object uses the
"language" values (`"Scala"` and `"Java"`) from the input to group the output. Also notice that the
output places the each input object in an array.

#### Source

```DataWeave
%dw 2.0
var myArray = [
   { "name": "Foo", "language": "Java" },
   { "name": "Bar", "language": "Scala" },
   { "name": "FooBar", "language": "Java" }
]
output application/json
---
myArray groupBy (item) -> item.language
```

#### Output

```JSON
{
  "Scala": [
    { "name": "Bar", "language": "Scala" }
  ],
  "Java": [
    { "name": "Foo", "language": "Java" },
    { "name": "FooBar", "language": "Java" }
  ]
}
```

### Example

This example uses ``groupBy "myLabels"`to return an object where `"mylabels"`` is the key, and an
array of selected values (`["Open New", "Zoom In", "Zoom Out", "Original View" ]`) is the value. It
uses the selectors (`myVar.menu.items.*label`) to create that array. Notice that the selectors
retain all values where `"label"` is the key but filter out values where `"id"` is the key.

#### Source

```DataWeave
%dw 2.0
var myVar = { menu: {
    header: "Move Items",
    items: [
        {"id": "internal"},
        {"id": "left", "label": "Move Left"},
        {"id": "right", "label": "Move Right"},
        {"id": "up", "label": "Move Up"},
        {"id": "down", "label": "Move Down"}
    ]
}}
output application/json
---
(myVar.menu.items.*label groupBy "myLabels")
```

#### Output

```JSON
{ "myLabels": [ "Move Left", "Move Right", "Move Up", "Move Down" ] }
```

## groupBy<R>(text: String, criteria: (character: String, index: Number) -> R): { (R): String }

Returns an object that groups characters from a string based on specified criteria, such as an
expression or matching selector.

This version of `groupBy` groups the elements of an array using the `criteria` function. Other
versions act on objects and handle `null` values.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to group by.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The criteria to use.</p></td></tr></tbody></table>

### Example

This example shows howyou can use `groupBy` to split a string into vowels and not vowels.

#### Source

```DataWeave
%dw 2.0
output application/json
---
"hello world!" groupBy (not isEmpty($ find /[aeiou]/))
```

#### Output

```Json
{
  "false": "hll wrld!",
  "true": "eoo"
}
```

## groupBy<K, V, R>(object: { (K)?: V }, criteria: (value: V, key: K) -> R): { (R): { (K)?: V } }

Groups elements of an object based on criteria that the `groupBy` uses to iterate over elements in
the input.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object containing objects to group.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The grouping criteria to apply to elements in the input object, such as a <code>key</code> and/or <code>value</code> of the object to use for grouping.</p></td></tr></tbody></table>

### Example

This example groups objects within an array of objects using the anonymous parameter `$` for the
value of each key in the input objects. It applies the DataWeave `upper` function to those values.
In the output, these values become upper-case keys. Note that you can also write the same example
using a named parameter for the within an anonymous function like this:
`{ "a" : "b", "c" : "d"} groupBy (value) → upper(value)`

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "a" : "b", "c" : "d"} groupBy upper($)
```

#### Output

```JSON
{ "D": { "c": "d" }, "B": { "a": "b" } }
```

### Example

This example uses `groupBy "costs"` to produce a JSON object from an XML object where `"costs"` is
the key, and the selected values of the XML element `prices` becomes the JSON value
(`{ "price": "9.99", "price": "10.99" }`).

#### Source

```DataWeave
%dw 2.0
var myRead =
read("<prices><price>9.99</price><price>10.99</price></prices>","application/xml")
output application/json
---
myRead.prices groupBy "costs"
```

#### Output

```JSON
{ "costs" : { "price": "9.99", "price": "10.99" } }
```

## groupBy(value: Null, criteria: (Nothing, Nothing) -> Any): Null

Helper function that enables `groupBy` to work with a `null` value.

<!-- document id=3f6dc59e18e9c90b38734df86dd0638b9653633a11455e5d52bd3f77d776a20b url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-groupby.md -->

---
product: DataWeave
version: 2.9
---

# groupBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## groupBy<T, R>(items: Array<T>, criteria: (item: T, index: Number) -> R): {| (R): Array<T> |}

Returns an object that groups items from an array based on specified criteria, such as an expression
or matching selector.

This version of `groupBy` groups the elements of an array using the `criteria` function. Other
versions act on objects and handle null values.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The array to group.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>Expression providing the criteria by which to group the items in the array.</p></td></tr></tbody></table>

### Example

This example groups items from the input array `["a","b","c"]` by their indices. Notice that it
returns the numeric indices as strings and that items (or values) of the array are returned as
arrays, in this case, with a single item each. The items in the array are grouped based on an
anonymous function `(item, index) → index` that uses named parameters (`item` and `index`). Note
that you can produce the same result using the anonymous parameter `$$` to identify the indices of
the array like this: `["a","b","c"] groupBy $$`

#### Source

```DataWeave
%dw 2.0
output application/json
---
["a","b","c"] groupBy (item, index) -> index
```

#### Output

```JSON
{ "2": [ "c" ], "1": [ "b" ], "0": [ "a" ] }
```

### Example

This example groups the elements of an array based on the language field. Notice that it uses the
`item.language` selector to specify the grouping criteria. So the resulting object uses the
"language" values (`"Scala"` and `"Java"`) from the input to group the output. Also notice that the
output places the each input object in an array.

#### Source

```DataWeave
%dw 2.0
var myArray = [
   { "name": "Foo", "language": "Java" },
   { "name": "Bar", "language": "Scala" },
   { "name": "FooBar", "language": "Java" }
]
output application/json
---
myArray groupBy (item) -> item.language
```

#### Output

```JSON
{
  "Scala": [
    { "name": "Bar", "language": "Scala" }
  ],
  "Java": [
    { "name": "Foo", "language": "Java" },
    { "name": "FooBar", "language": "Java" }
  ]
}
```

### Example

This example uses ``groupBy "myLabels"`to return an object where `"mylabels"`` is the key, and an
array of selected values (`["Open New", "Zoom In", "Zoom Out", "Original View" ]`) is the value. It
uses the selectors (`myVar.menu.items.*label`) to create that array. Notice that the selectors
retain all values where `"label"` is the key but filter out values where `"id"` is the key.

#### Source

```DataWeave
%dw 2.0
var myVar = { menu: {
    header: "Move Items",
    items: [
        {"id": "internal"},
        {"id": "left", "label": "Move Left"},
        {"id": "right", "label": "Move Right"},
        {"id": "up", "label": "Move Up"},
        {"id": "down", "label": "Move Down"}
    ]
}}
output application/json
---
(myVar.menu.items.*label groupBy "myLabels")
```

#### Output

```JSON
{ "myLabels": [ "Move Left", "Move Right", "Move Up", "Move Down" ] }
```

## groupBy<R>(text: String, criteria: (character: String, index: Number) -> R): { (R): String }

Returns an object that groups characters from a string based on specified criteria, such as an
expression or matching selector.

This version of `groupBy` groups the elements of an array using the `criteria` function. Other
versions act on objects and handle `null` values.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to group by.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The criteria to use.</p></td></tr></tbody></table>

### Example

This example shows howyou can use `groupBy` to split a string into vowels and not vowels.

#### Source

```DataWeave
%dw 2.0
output application/json
---
"hello world!" groupBy (not isEmpty($ find /[aeiou]/))
```

#### Output

```Json
{
  "false": "hll wrld!",
  "true": "eoo"
}
```

## groupBy<K, V, R>(object: { (K)?: V }, criteria: (value: V, key: K) -> R): { (R): { (K)?: V } }

Groups elements of an object based on criteria that the `groupBy` uses to iterate over elements in
the input.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object containing objects to group.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The grouping criteria to apply to elements in the input object, such as a <code>key</code> and/or <code>value</code> of the object to use for grouping.</p></td></tr></tbody></table>

### Example

This example groups objects within an array of objects using the anonymous parameter `$` for the
value of each key in the input objects. It applies the DataWeave `upper` function to those values.
In the output, these values become upper-case keys. Note that you can also write the same example
using a named parameter for the within an anonymous function like this:
`{ "a" : "b", "c" : "d"} groupBy (value) → upper(value)`

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "a" : "b", "c" : "d"} groupBy upper($)
```

#### Output

```JSON
{ "D": { "c": "d" }, "B": { "a": "b" } }
```

### Example

This example uses `groupBy "costs"` to produce a JSON object from an XML object where `"costs"` is
the key, and the selected values of the XML element `prices` becomes the JSON value
(`{ "price": "9.99", "price": "10.99" }`).

#### Source

```DataWeave
%dw 2.0
var myRead =
read("<prices><price>9.99</price><price>10.99</price></prices>","application/xml")
output application/json
---
myRead.prices groupBy "costs"
```

#### Output

```JSON
{ "costs" : { "price": "9.99", "price": "10.99" } }
```

## groupBy(value: Null, criteria: (Nothing, Nothing) -> Any): Null

Helper function that enables `groupBy` to work with a `null` value.

<!-- document id=f7cb93932f84b8f1311ee74fca47683eec1c473ce8fb663693a4eda0a2500c3d url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-groupby.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# groupBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## groupBy<T, R>(items: Array<T>, criteria: (item: T, index: Number) -> R): {| (R): Array<T> |}

Returns an object that groups items from an array based on specified criteria, such as an expression
or matching selector.

This version of `groupBy` groups the elements of an array using the `criteria` function. Other
versions act on objects and handle null values.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The array to group.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>Expression providing the criteria by which to group the items in the array.</p></td></tr></tbody></table>

### Example

This example groups items from the input array `["a","b","c"]` by their indices. Notice that it
returns the numeric indices as strings and that items (or values) of the array are returned as
arrays, in this case, with a single item each. The items in the array are grouped based on an
anonymous function `(item, index) → index` that uses named parameters (`item` and `index`). Note
that you can produce the same result using the anonymous parameter `$$` to identify the indices of
the array like this: `["a","b","c"] groupBy $$`

#### Source

```DataWeave
%dw 2.0
output application/json
---
["a","b","c"] groupBy (item, index) -> index
```

#### Output

```JSON
{ "2": [ "c" ], "1": [ "b" ], "0": [ "a" ] }
```

### Example

This example groups the elements of an array based on the language field. Notice that it uses the
`item.language` selector to specify the grouping criteria. So the resulting object uses the
"language" values (`"Scala"` and `"Java"`) from the input to group the output. Also notice that the
output places the each input object in an array.

#### Source

```DataWeave
%dw 2.0
var myArray = [
   { "name": "Foo", "language": "Java" },
   { "name": "Bar", "language": "Scala" },
   { "name": "FooBar", "language": "Java" }
]
output application/json
---
myArray groupBy (item) -> item.language
```

#### Output

```JSON
{
  "Scala": [
    { "name": "Bar", "language": "Scala" }
  ],
  "Java": [
    { "name": "Foo", "language": "Java" },
    { "name": "FooBar", "language": "Java" }
  ]
}
```

### Example

This example uses ``groupBy "myLabels"`to return an object where `"mylabels"`` is the key, and an
array of selected values (`["Open New", "Zoom In", "Zoom Out", "Original View" ]`) is the value. It
uses the selectors (`myVar.menu.items.*label`) to create that array. Notice that the selectors
retain all values where `"label"` is the key but filter out values where `"id"` is the key.

#### Source

```DataWeave
%dw 2.0
var myVar = { menu: {
    header: "Move Items",
    items: [
        {"id": "internal"},
        {"id": "left", "label": "Move Left"},
        {"id": "right", "label": "Move Right"},
        {"id": "up", "label": "Move Up"},
        {"id": "down", "label": "Move Down"}
    ]
}}
output application/json
---
(myVar.menu.items.*label groupBy "myLabels")
```

#### Output

```JSON
{ "myLabels": [ "Move Left", "Move Right", "Move Up", "Move Down" ] }
```

## groupBy<R>(text: String, criteria: (character: String, index: Number) -> R): { (R): String }

Returns an object that groups characters from a string based on specified criteria, such as an
expression or matching selector.

This version of `groupBy` groups the elements of an array using the `criteria` function. Other
versions act on objects and handle `null` values.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to group by.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The criteria to use.</p></td></tr></tbody></table>

### Example

This example shows howyou can use `groupBy` to split a string into vowels and not vowels.

#### Source

```DataWeave
%dw 2.0
output application/json
---
"hello world!" groupBy (not isEmpty($ find /[aeiou]/))
```

#### Output

```Json
{
  "false": "hll wrld!",
  "true": "eoo"
}
```

## groupBy<K, V, R>(object: { (K)?: V }, criteria: (value: V, key: K) -> R): { (R): { (K)?: V } }

Groups elements of an object based on criteria that the `groupBy` uses to iterate over elements in
the input.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object containing objects to group.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The grouping criteria to apply to elements in the input object, such as a <code>key</code> and/or <code>value</code> of the object to use for grouping.</p></td></tr></tbody></table>

### Example

This example groups objects within an array of objects using the anonymous parameter `$` for the
value of each key in the input objects. It applies the DataWeave `upper` function to those values.
In the output, these values become upper-case keys. Note that you can also write the same example
using a named parameter for the within an anonymous function like this:
`{ "a" : "b", "c" : "d"} groupBy (value) → upper(value)`

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "a" : "b", "c" : "d"} groupBy upper($)
```

#### Output

```JSON
{ "D": { "c": "d" }, "B": { "a": "b" } }
```

### Example

This example uses `groupBy "costs"` to produce a JSON object from an XML object where `"costs"` is
the key, and the selected values of the XML element `prices` becomes the JSON value
(`{ "price": "9.99", "price": "10.99" }`).

#### Source

```DataWeave
%dw 2.0
var myRead =
read("<prices><price>9.99</price><price>10.99</price></prices>","application/xml")
output application/json
---
myRead.prices groupBy "costs"
```

#### Output

```JSON
{ "costs" : { "price": "9.99", "price": "10.99" } }
```

## groupBy(value: Null, criteria: (Nothing, Nothing) -> Any): Null

Helper function that enables `groupBy` to work with a `null` value.

<!-- document id=18e0694215d298f56a2803a815d681004dd53e96124b47b93bef8d81d402c672 url=/mulesoft/current/en-us/dataweave/2.11/dw-strings-functions-hammingdistance.md -->

---
product: DataWeave
version: 2.11
---

# hammingDistance

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## hammingDistance(a: String, b: String): Number | Null

Returns the Hamming distance between two strings.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>a</code></p></td><td><p>The first string.</p></td></tr><tr><td><p><code>b</code></p></td><td><p>The second string.</p></td></tr></tbody></table>

### Example

This example shows how `hammingDistance` behaves with different strings.

#### Source

```DataWeave
%dw 2.0
import hammingDistance from dw::core::Strings
output application/json
---
"holu" hammingDistance "chau"
```

#### Output

```Json
3
```

<!-- document id=bff60af505be95783f193387dba40d72d63935bcc5165597996ae9e18ea6960c url=/mulesoft/current/en-us/dataweave/2.12/dw-strings-functions-hammingdistance.md -->

---
product: DataWeave
version: 2.12
---

# hammingDistance

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## hammingDistance(a: String, b: String): Number | Null

Returns the Hamming distance between two strings.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>a</code></p></td><td><p>The first string.</p></td></tr><tr><td><p><code>b</code></p></td><td><p>The second string.</p></td></tr></tbody></table>

### Example

This example shows how `hammingDistance` behaves with different strings.

#### Source

```DataWeave
%dw 2.0
import hammingDistance from dw::core::Strings
output application/json
---
"holu" hammingDistance "chau"
```

#### Output

```Json
3
```

<!-- document id=d06871b74f804ac30bbf505403cf0fa1caf0c7d86c1b4b1a817d490408e1b666 url=/mulesoft/current/en-us/dataweave/2.4/dw-strings-functions-hammingdistance.md -->

---
product: DataWeave
version: 2.4
---

# hammingDistance

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## hammingDistance(a: String, b: String): Number | Null

Returns the Hamming distance between two strings.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>a</code></p></td><td><p>The first string.</p></td></tr><tr><td><p><code>b</code></p></td><td><p>The second string.</p></td></tr></tbody></table>

### Example

This example shows how `hammingDistance` behaves with different strings.

#### Source

```DataWeave
%dw 2.0
import hammingDistance from dw::core::Strings
output application/json
---
"holu" hammingDistance "chau"
```

#### Output

```Json
3
```

<!-- document id=d3ff53f26a57e599f48b12fce21618e3f43ad6ded550310101ce489b19208fb2 url=/mulesoft/current/en-us/dataweave/2.6/dw-strings-functions-hammingdistance.md -->

---
product: DataWeave
version: 2.6
---

# hammingDistance

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## hammingDistance(a: String, b: String): Number | Null

Returns the Hamming distance between two strings.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>a</code></p></td><td><p>The first string.</p></td></tr><tr><td><p><code>b</code></p></td><td><p>The second string.</p></td></tr></tbody></table>

### Example

This example shows how `hammingDistance` behaves with different strings.

#### Source

```DataWeave
%dw 2.0
import hammingDistance from dw::core::Strings
output application/json
---
"holu" hammingDistance "chau"
```

#### Output

```Json
3
```

<!-- document id=740ec22814f1e7c95e11ecc0124dd79f66a94dee011860544a5c7c0b2f537d7e url=/mulesoft/current/en-us/dataweave/2.9/dw-strings-functions-hammingdistance.md -->

---
product: DataWeave
version: 2.9
---

# hammingDistance

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## hammingDistance(a: String, b: String): Number | Null

Returns the Hamming distance between two strings.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>a</code></p></td><td><p>The first string.</p></td></tr><tr><td><p><code>b</code></p></td><td><p>The second string.</p></td></tr></tbody></table>

### Example

This example shows how `hammingDistance` behaves with different strings.

#### Source

```DataWeave
%dw 2.0
import hammingDistance from dw::core::Strings
output application/json
---
"holu" hammingDistance "chau"
```

#### Output

```Json
3
```

<!-- document id=6d9c8a08469d865b6714fecbf236283b3ff6463459b05dfc739431fc6d6c0c7f url=/mulesoft/current/en-us/dataweave/latest/dw-strings-functions-hammingdistance.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# hammingDistance

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## hammingDistance(a: String, b: String): Number | Null

Returns the Hamming distance between two strings.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>a</code></p></td><td><p>The first string.</p></td></tr><tr><td><p><code>b</code></p></td><td><p>The second string.</p></td></tr></tbody></table>

### Example

This example shows how `hammingDistance` behaves with different strings.

#### Source

```DataWeave
%dw 2.0
import hammingDistance from dw::core::Strings
output application/json
---
"holu" hammingDistance "chau"
```

#### Output

```Json
3
```

<!-- document id=79e50192e3e2887b461382561c7ab6f038682649b81a96dfd3e05cc03d56f661 url=/mulesoft/current/en-us/dataweave/2.11/dw-crypto-functions-hashwith.md -->

---
product: DataWeave
version: 2.11
---

# hashWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## hashWith(content: Binary, algorithm: String = "SHA-1"): Binary

Computes the hash value of binary content using a specified algorithm.

The first argument specifies the binary content to use to calculate the hash value, and the second
argument specifies the hashing algorithm to use. The second argument must be any of the accepted
Algorithm names:

<table><colgroup><col> <col></colgroup><thead><tr><th>Algorithm names</th><th>Description</th></tr></thead><tbody><tr><td><p><code>MD2</code></p></td><td><p>The MD2 message digest algorithm as defined in <a href="https://www.ietf.org/rfc/rfc1319.txt">RFC 1319</a>.</p></td></tr><tr><td><p><code>MD5</code></p></td><td><p>The MD5 message digest algorithm as defined in <a href="https://www.ietf.org/rfc/rfc1321.txt">RFC 1321</a>.</p></td></tr><tr><td><p><code>SHA-1</code>, <code>SHA-256</code>, <code>SHA-384</code>, <code>SHA-512</code></p></td><td><p>Hash algorithms defined in the <a href="https://csrc.nist.gov/publications/fips">FIPS PUB 180-2</a>. SHA-256 is a 256-bit hash function intended to provide 128 bits of security against collision attacks, while SHA-512 is a 512-bit hash function intended to provide 256 bits of security. A 384-bit hash may be obtained by truncating the SHA-512 output.</p></td></tr></tbody></table>

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>The binary input value to hash.</p></td></tr><tr><td><p><code>algorithm</code></p></td><td><p>The name of the algorithm to use for calculating the hash value of <code>content</code>. This value is a string. Defaults to <code>SHA-1</code>.</p></td></tr></tbody></table>

### Example

This example uses the MD2 algorithm to encrypt a binary value.

#### Source

```DataWeave
%dw 2.0
import dw::Crypto
output application/json
---
{ "md2" : Crypto::hashWith("hello" as Binary, "MD2") }
```

#### Output

```JSON
{ "md2": "\ufffd\u0004ls\ufffd\u00031\ufffdh\ufffd}8\u0004\ufffd\u0006U" }
```

<!-- document id=bdab74822f8a205e436036b2ababd68f8feb8d12e4119552912ca74089a0fec5 url=/mulesoft/current/en-us/dataweave/2.12/dw-crypto-functions-hashwith.md -->

---
product: DataWeave
version: 2.12
---

# hashWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## hashWith(content: Binary, @CryptographicSink algorithm: String = "SHA-1"): Binary

Computes the hash value of binary content using a specified algorithm.

The first argument specifies the binary content to use to calculate the hash value, and the second
argument specifies the hashing algorithm to use. The second argument must be any of the accepted
Algorithm names:

<table><colgroup><col> <col></colgroup><thead><tr><th>Algorithm names</th><th>Description</th></tr></thead><tbody><tr><td><p><code>MD2</code></p></td><td><p>The MD2 message digest algorithm as defined in <a href="https://www.ietf.org/rfc/rfc1319.txt">RFC 1319</a>.</p></td></tr><tr><td><p><code>MD5</code></p></td><td><p>The MD5 message digest algorithm as defined in <a href="https://www.ietf.org/rfc/rfc1321.txt">RFC 1321</a>.</p></td></tr><tr><td><p><code>SHA-1</code>, <code>SHA-256</code>, <code>SHA-384</code>, <code>SHA-512</code></p></td><td><p>Hash algorithms defined in the <a href="https://csrc.nist.gov/publications/fips">FIPS PUB 180-2</a>. SHA-256 is a 256-bit hash function intended to provide 128 bits of security against collision attacks, while SHA-512 is a 512-bit hash function intended to provide 256 bits of security. A 384-bit hash may be obtained by truncating the SHA-512 output.</p></td></tr></tbody></table>

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>The binary input value to hash.</p></td></tr><tr><td><p><code>algorithm</code></p></td><td><p>The name of the algorithm to use for calculating the hash value of <code>content</code>. This value is a string. Defaults to <code>SHA-1</code>.</p></td></tr></tbody></table>

### Example

This example uses the MD2 algorithm to encrypt a binary value.

#### Source

```DataWeave
%dw 2.0
import dw::Crypto
output application/json
---
{ "md2" : Crypto::hashWith("hello" as Binary, "MD2") }
```

#### Output

```JSON
{ "md2": "\ufffd\u0004ls\ufffd\u00031\ufffdh\ufffd}8\u0004\ufffd\u0006U" }
```

<!-- document id=9feaaa577c849424710d28e74e405b9a09d1241d96cf42591b4ef68f974ca332 url=/mulesoft/current/en-us/dataweave/2.3/dw-crypto-functions-hashwith.md -->

---
product: DataWeave
version: 2.3
---

# hashWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## hashWith(Binary, String): Binary

Computes the hash value of binary content using a specified algorithm.

The first argument specifies the binary content to use to calculate the hash value, and the second
argument specifies the hashing algorithm to use. The second argument must be any of the accepted
Algorithm names:

<table><colgroup><col> <col></colgroup><thead><tr><th>Algorithm names</th><th>Description</th></tr></thead><tbody><tr><td><p><code>MD2</code></p></td><td><p>The MD2 message digest algorithm as defined in <a href="https://www.ietf.org/rfc/rfc1319.txt">RFC 1319</a>.</p></td></tr><tr><td><p><code>MD5</code></p></td><td><p>The MD5 message digest algorithm as defined in <a href="https://www.ietf.org/rfc/rfc1321.txt">RFC 1321</a>.</p></td></tr><tr><td><p><code>SHA-1</code>, <code>SHA-256</code>, <code>SHA-384</code>, <code>SHA-512</code></p></td><td><p>Hash algorithms defined in the <a href="https://csrc.nist.gov/publications/fips">FIPS PUB 180-2</a>. SHA-256 is a 256-bit hash function intended to provide 128 bits of security against collision attacks, while SHA-512 is a 512-bit hash function intended to provide 256 bits of security. A 384-bit hash may be obtained by truncating the SHA-512 output.</p></td></tr></tbody></table>

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>The binary input content to hash.</p></td></tr><tr><td><p><code>algorithm</code></p></td><td><p>The name of the algorithm to use to calculate the hash value of <code>content</code>. This value is a <code>String</code>. Defaults to <code>SHA-1</code>.</p></td></tr></tbody></table>

### Example

This example uses the MD2 algorithm to encrypt a binary value.

#### Source

```DataWeave
%dw 2.0
import dw::Crypto
output application/json
---
{ "md2" : Crypto::hashWith("hello" as Binary, "MD2") }
```

#### Output

```JSON
{ "md2": "\ufffd\u0004ls\ufffd\u00031\ufffdh\ufffd}8\u0004\ufffd\u0006U" }
```

<!-- document id=94a84d5f4b66bfc89985a53c1bab65af8efcd3fc7a53baf29bc03c00091f9469 url=/mulesoft/current/en-us/dataweave/2.4/dw-crypto-functions-hashwith.md -->

---
product: DataWeave
version: 2.4
---

# hashWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## hashWith(content: Binary, algorithm: String = "SHA-1"): Binary

Computes the hash value of binary content using a specified algorithm.

The first argument specifies the binary content to use to calculate the hash value, and the second
argument specifies the hashing algorithm to use. The second argument must be any of the accepted
Algorithm names:

<table><colgroup><col> <col></colgroup><thead><tr><th>Algorithm names</th><th>Description</th></tr></thead><tbody><tr><td><p><code>MD2</code></p></td><td><p>The MD2 message digest algorithm as defined in <a href="https://www.ietf.org/rfc/rfc1319.txt">RFC 1319</a>.</p></td></tr><tr><td><p><code>MD5</code></p></td><td><p>The MD5 message digest algorithm as defined in <a href="https://www.ietf.org/rfc/rfc1321.txt">RFC 1321</a>.</p></td></tr><tr><td><p><code>SHA-1</code>, <code>SHA-256</code>, <code>SHA-384</code>, <code>SHA-512</code></p></td><td><p>Hash algorithms defined in the <a href="https://csrc.nist.gov/publications/fips">FIPS PUB 180-2</a>. SHA-256 is a 256-bit hash function intended to provide 128 bits of security against collision attacks, while SHA-512 is a 512-bit hash function intended to provide 256 bits of security. A 384-bit hash may be obtained by truncating the SHA-512 output.</p></td></tr></tbody></table>

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>The binary input value to hash.</p></td></tr><tr><td><p><code>algorithm</code></p></td><td><p>The name of the algorithm to use for calculating the hash value of <code>content</code>. This value is a string. Defaults to <code>SHA-1</code>.</p></td></tr></tbody></table>

### Example

This example uses the MD2 algorithm to encrypt a binary value.

#### Source

```DataWeave
%dw 2.0
import dw::Crypto
output application/json
---
{ "md2" : Crypto::hashWith("hello" as Binary, "MD2") }
```

#### Output

```JSON
{ "md2": "\ufffd\u0004ls\ufffd\u00031\ufffdh\ufffd}8\u0004\ufffd\u0006U" }
```

<!-- document id=32d75a75334ffb554f52e893e63882aeae375381c4fd720ab98ea64d6c0a09d2 url=/mulesoft/current/en-us/dataweave/2.6/dw-crypto-functions-hashwith.md -->

---
product: DataWeave
version: 2.6
---

# hashWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## hashWith(content: Binary, algorithm: String = "SHA-1"): Binary

Computes the hash value of binary content using a specified algorithm.

The first argument specifies the binary content to use to calculate the hash value, and the second
argument specifies the hashing algorithm to use. The second argument must be any of the accepted
Algorithm names:

<table><colgroup><col> <col></colgroup><thead><tr><th>Algorithm names</th><th>Description</th></tr></thead><tbody><tr><td><p><code>MD2</code></p></td><td><p>The MD2 message digest algorithm as defined in <a href="https://www.ietf.org/rfc/rfc1319.txt">RFC 1319</a>.</p></td></tr><tr><td><p><code>MD5</code></p></td><td><p>The MD5 message digest algorithm as defined in <a href="https://www.ietf.org/rfc/rfc1321.txt">RFC 1321</a>.</p></td></tr><tr><td><p><code>SHA-1</code>, <code>SHA-256</code>, <code>SHA-384</code>, <code>SHA-512</code></p></td><td><p>Hash algorithms defined in the <a href="https://csrc.nist.gov/publications/fips">FIPS PUB 180-2</a>. SHA-256 is a 256-bit hash function intended to provide 128 bits of security against collision attacks, while SHA-512 is a 512-bit hash function intended to provide 256 bits of security. A 384-bit hash may be obtained by truncating the SHA-512 output.</p></td></tr></tbody></table>

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>The binary input value to hash.</p></td></tr><tr><td><p><code>algorithm</code></p></td><td><p>The name of the algorithm to use for calculating the hash value of <code>content</code>. This value is a string. Defaults to <code>SHA-1</code>.</p></td></tr></tbody></table>

### Example

This example uses the MD2 algorithm to encrypt a binary value.

#### Source

```DataWeave
%dw 2.0
import dw::Crypto
output application/json
---
{ "md2" : Crypto::hashWith("hello" as Binary, "MD2") }
```

#### Output

```JSON
{ "md2": "\ufffd\u0004ls\ufffd\u00031\ufffdh\ufffd}8\u0004\ufffd\u0006U" }
```

<!-- document id=9dd079352a779e0b19f0c90863f9f65de87a9b5c162fe50d5d36bf21c987a0d1 url=/mulesoft/current/en-us/dataweave/2.9/dw-crypto-functions-hashwith.md -->

---
product: DataWeave
version: 2.9
---

# hashWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## hashWith(content: Binary, algorithm: String = "SHA-1"): Binary

Computes the hash value of binary content using a specified algorithm.

The first argument specifies the binary content to use to calculate the hash value, and the second
argument specifies the hashing algorithm to use. The second argument must be any of the accepted
Algorithm names:

<table><colgroup><col> <col></colgroup><thead><tr><th>Algorithm names</th><th>Description</th></tr></thead><tbody><tr><td><p><code>MD2</code></p></td><td><p>The MD2 message digest algorithm as defined in <a href="https://www.ietf.org/rfc/rfc1319.txt">RFC 1319</a>.</p></td></tr><tr><td><p><code>MD5</code></p></td><td><p>The MD5 message digest algorithm as defined in <a href="https://www.ietf.org/rfc/rfc1321.txt">RFC 1321</a>.</p></td></tr><tr><td><p><code>SHA-1</code>, <code>SHA-256</code>, <code>SHA-384</code>, <code>SHA-512</code></p></td><td><p>Hash algorithms defined in the <a href="https://csrc.nist.gov/publications/fips">FIPS PUB 180-2</a>. SHA-256 is a 256-bit hash function intended to provide 128 bits of security against collision attacks, while SHA-512 is a 512-bit hash function intended to provide 256 bits of security. A 384-bit hash may be obtained by truncating the SHA-512 output.</p></td></tr></tbody></table>

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>The binary input value to hash.</p></td></tr><tr><td><p><code>algorithm</code></p></td><td><p>The name of the algorithm to use for calculating the hash value of <code>content</code>. This value is a string. Defaults to <code>SHA-1</code>.</p></td></tr></tbody></table>

### Example

This example uses the MD2 algorithm to encrypt a binary value.

#### Source

```DataWeave
%dw 2.0
import dw::Crypto
output application/json
---
{ "md2" : Crypto::hashWith("hello" as Binary, "MD2") }
```

#### Output

```JSON
{ "md2": "\ufffd\u0004ls\ufffd\u00031\ufffdh\ufffd}8\u0004\ufffd\u0006U" }
```

<!-- document id=464fbdf608bb285dfc3b5caac79b4182e7ded351f56996fc08781d8326858702 url=/mulesoft/current/en-us/dataweave/latest/dw-crypto-functions-hashwith.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# hashWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## hashWith(content: Binary, @CryptographicSink algorithm: String = "SHA-1"): Binary

Computes the hash value of binary content using a specified algorithm.

The first argument specifies the binary content to use to calculate the hash value, and the second
argument specifies the hashing algorithm to use. The second argument must be any of the accepted
Algorithm names:

<table><colgroup><col> <col></colgroup><thead><tr><th>Algorithm names</th><th>Description</th></tr></thead><tbody><tr><td><p><code>MD2</code></p></td><td><p>The MD2 message digest algorithm as defined in <a href="https://www.ietf.org/rfc/rfc1319.txt">RFC 1319</a>.</p></td></tr><tr><td><p><code>MD5</code></p></td><td><p>The MD5 message digest algorithm as defined in <a href="https://www.ietf.org/rfc/rfc1321.txt">RFC 1321</a>.</p></td></tr><tr><td><p><code>SHA-1</code>, <code>SHA-256</code>, <code>SHA-384</code>, <code>SHA-512</code></p></td><td><p>Hash algorithms defined in the <a href="https://csrc.nist.gov/publications/fips">FIPS PUB 180-2</a>. SHA-256 is a 256-bit hash function intended to provide 128 bits of security against collision attacks, while SHA-512 is a 512-bit hash function intended to provide 256 bits of security. A 384-bit hash may be obtained by truncating the SHA-512 output.</p></td></tr></tbody></table>

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>The binary input value to hash.</p></td></tr><tr><td><p><code>algorithm</code></p></td><td><p>The name of the algorithm to use for calculating the hash value of <code>content</code>. This value is a string. Defaults to <code>SHA-1</code>.</p></td></tr></tbody></table>

### Example

This example uses the MD2 algorithm to encrypt a binary value.

#### Source

```DataWeave
%dw 2.0
import dw::Crypto
output application/json
---
{ "md2" : Crypto::hashWith("hello" as Binary, "MD2") }
```

#### Output

```JSON
{ "md2": "\ufffd\u0004ls\ufffd\u00031\ufffdh\ufffd}8\u0004\ufffd\u0006U" }
```

<!-- document id=d1f4e02625576a4dd715489973d34d9af1b0b9035743ad026c4928e55fd52b99 url=/mulesoft/current/en-us/dataweave/latest/dw-hmac.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# HMAC (dw::util::jwt::HMAC)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module provides functionality to create signed JSON Web Tokens using HMAC.

The supported HMAC algorithms are:

- HS256

- HS384

- HS512

Signing keys must be at least 256, 384, and 512 bits long for HS256, HS384, and HS512, respectively.

To use this module, import it to your DataWeave code. For example, by adding the line
`import * from dw::util::jwt::HMAC` to the header of your DataWeave script.

_Introduced in DataWeave version 2.6.0._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-hmac-functions-jwt">JWT</a></p></td><td><p>Generate JWT with header, payload, and signature by specific algorithm.</p></td></tr></tbody></table>

## Variables

- [HMAC Variables](https://docs.mulesoft.com/dataweave/latest/dw-hmac-variables)

<!-- document id=fde3ab3f209fc6d5b5649ea8f99f56bf6c9394aa157b13dcdcf7ef170c5d5419 url=/mulesoft/current/en-us/dataweave/latest/dw-hmac-variables.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# HMAC Variables (dw::util::jwt::HMAC)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains variables for the HMAC module.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Variable</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>algMapping</p></td><td><div><div><p><code>algMapping</code></p></div></div></td><td><div><div><p>Supported HMAC algorithms.</p></div><div><p><em>Introduced in DataWeave version 2.6.0.</em></p></div></div></td></tr><tr><td><p>requiredKeyLengthBits</p></td><td><div><div><p><code>requiredKeyLengthBits</code></p></div></div></td><td><div><div><p>Required key lengths for FIPS 198-1 compliance. NIST recommends HMAC key length &gt;= hash output length.</p></div><div><p><em>Introduced in DataWeave version 2.6.0.</em></p></div></div></td></tr></tbody></table>

<!-- document id=101c12f7e795977c145841ad33f8e6f88370a5d6b6a864eadeab1da39a7d8853 url=/mulesoft/current/en-us/dataweave/2.11/dw-crypto-functions-hmacbinary.md -->

---
product: DataWeave
version: 2.11
---

# HMACBinary

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## HMACBinary(secret: Binary, content: Binary, algorithm: String = "HmacSHA1"): Binary

Computes an HMAC hash (with a secret cryptographic key) on input content.

See also, `HMACWith`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>secret</code></p></td><td><div><div><p>The secret cryptographic key (a binary value) used when encrypting the <code>content</code>.</p></div></div></td></tr><tr><td><p><code>content</code></p></td><td><div><div><p>The binary input value.</p></div></div></td></tr><tr><td><p><code>algorithm</code></p></td><td><div><div><p>The hashing algorithm. <code>HmacSHA1</code> is the default. Valid values depend on the JDK version you are using. For JDK 8 and JDK 11, <code>HmacMD5</code>, <code>HmacSHA1</code>, <code>HmacSHA224</code>, <code>HmacSHA256</code>, <code>HmacSHA384</code>, and <code>HmacSHA512</code> are valid algorithms. For JDK 11, <code>HmacSHA512/224</code> and <code>HmacSHA512/256</code> are also valid.</p></div></div></td></tr></tbody></table>

### Example

This example uses HMAC with a secret value to encrypt the input content.

#### Source

```DataWeave
%dw 2.0
import dw::Crypto
output application/json
---
{
  "HMACBinary" : Crypto::HMACBinary("confidential" as Binary, "xxxxx" as Binary, "HmacSHA512")
}
```

#### Output

```JSON
{
  "HMACBinary": "\ufffd\ufffd\ufffd\ufffd^h\ufffd!3\u0005\ufffd֎\u00017\ufffd\ufffd\ufffd`\ufffd8?\ufffdjn7\ufffdbs;\t\ufffdƅ\ufffd\ufffd\ufffdx&g\ufffd~\ufffd\ufffd%\ufffd7>1\ufffdK\u000e@\ufffdC\u0011\ufffdT\ufffd}W"
}
```

<!-- document id=3b4ed6fd19dc64f74def3b37feee6e5c17c7e905e54eb2098ca9142064fb3bf4 url=/mulesoft/current/en-us/dataweave/2.12/dw-crypto-functions-hmacbinary.md -->

---
product: DataWeave
version: 2.12
---

# HMACBinary

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## HMACBinary(secret: Binary, content: Binary, @CryptographicSink algorithm: String = "HmacSHA1"): Binary

Computes an HMAC hash (with a secret cryptographic key) on input content.

See also, `HMACWith`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>secret</code></p></td><td><div><div><p>The secret cryptographic key (a binary value) used when encrypting the <code>content</code>.</p></div></div></td></tr><tr><td><p><code>content</code></p></td><td><div><div><p>The binary input value.</p></div></div></td></tr><tr><td><p><code>algorithm</code></p></td><td><div><div><p>The hashing algorithm. <code>HmacSHA1</code> is the default. Valid values depend on the JDK version you are using. For JDK 8 and JDK 11, <code>HmacMD5</code>, <code>HmacSHA1</code>, <code>HmacSHA224</code>, <code>HmacSHA256</code>, <code>HmacSHA384</code>, and <code>HmacSHA512</code> are valid algorithms. For JDK 11, <code>HmacSHA512/224</code> and <code>HmacSHA512/256</code> are also valid.</p></div></div></td></tr></tbody></table>

### Example

This example uses HMAC with a secret value to encrypt the input content.

#### Source

```DataWeave
%dw 2.0
import dw::Crypto
output application/json
---
{
  "HMACBinary" : Crypto::HMACBinary("confidential" as Binary, "xxxxx" as Binary, "HmacSHA512")
}
```

#### Output

```JSON
{
  "HMACBinary": "\ufffd\ufffd\ufffd\ufffd^h\ufffd!3\u0005\ufffd֎\u00017\ufffd\ufffd\ufffd`\ufffd8?\ufffdjn7\ufffdbs;\t\ufffdƅ\ufffd\ufffd\ufffdx&g\ufffd~\ufffd\ufffd%\ufffd7>1\ufffdK\u000e@\ufffdC\u0011\ufffdT\ufffd}W"
}
```

<!-- document id=666f9448d6bf6702d9e5f22606eab0249a1be26aaac00e5b9ef0220bec2eed32 url=/mulesoft/current/en-us/dataweave/2.3/dw-crypto-functions-hmacbinary.md -->

---
product: DataWeave
version: 2.3
---

# HMACBinary

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## HMACBinary(Binary, Binary, String): Binary

Computes an HMAC hash (with a secret cryptographic key) on input content.

See also, `HMACWith`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>secret</code></p></td><td><p>The secret cryptographic key (a <code>Binary</code>) used when encrypting the <code>content</code>).</p></td></tr><tr><td><p><code>content</code></p></td><td><p>The input content, a <code>Binary</code> value.</p></td></tr><tr><td><p><code>algorithm</code></p></td><td><p>The hashing algorithm. <code>HmacSHA1</code> is the default. Valid values depend on the JDK version you are using. For JDK 8 and JDK 11, <code>HmacMD5</code>, <code>HmacSHA1</code>, <code>HmacSHA224</code>, <code>HmacSHA256</code>, <code>HmacSHA384</code>, and <code>HmacSHA512</code> are valid algorithms. For JDK 11, <code>HmacSHA512/224</code> and <code>HmacSHA512/256</code> are also valid.</p></td></tr></tbody></table>

### Example

This example uses HMAC with a secret value to encrypt the input content.

#### Source

```DataWeave
%dw 2.0
import dw::Crypto
output application/json
---
{
  "HMACBinary" : Crypto::HMACBinary("confidential" as Binary, "xxxxx" as Binary, "HmacSHA512")
}
```

#### Output

```JSON
{
  "HMACBinary": "^\tXƐ\f\ufffd\ufffd\ufffdӞ]\ufffdd\ufffd\ufffd\u001b\u0003\ufffd\tL\ufffd\ufffdr#\ufffd\ufffdc\ufffd\u001bl\ufffd-q\ufffd\u001bؐ+\ufffd\u001d*M\ufffdz\ufffd\u0012&\ufffd&\ufffd\ufffdd\ufffd\ufffd̷R\u0003qO\ufffdF"
}
```

<!-- document id=7d7c17181414cad28c925f14d67a03ab4f45f0647f1a44b7def8a10f41c6415b url=/mulesoft/current/en-us/dataweave/2.4/dw-crypto-functions-hmacbinary.md -->

---
product: DataWeave
version: 2.4
---

# HMACBinary

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## HMACBinary(secret: Binary, content: Binary, algorithm: String = "HmacSHA1"): Binary

Computes an HMAC hash (with a secret cryptographic key) on input content.

See also, `HMACWith`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>secret</code></p></td><td><div><div><p>The secret cryptographic key (a binary value) used when encrypting the <code>content</code>.</p></div></div></td></tr><tr><td><p><code>content</code></p></td><td><div><div><p>The binary input value.</p></div></div></td></tr><tr><td><p><code>algorithm</code></p></td><td><div><div><p>The hashing algorithm. <code>HmacSHA1</code> is the default. Valid values depend on the JDK version you are using. For JDK 8 and JDK 11, <code>HmacMD5</code>, <code>HmacSHA1</code>, <code>HmacSHA224</code>, <code>HmacSHA256</code>, <code>HmacSHA384</code>, and <code>HmacSHA512</code> are valid algorithms. For JDK 11, <code>HmacSHA512/224</code> and <code>HmacSHA512/256</code> are also valid.</p></div></div></td></tr></tbody></table>

### Example

This example uses HMAC with a secret value to encrypt the input content.

#### Source

```DataWeave
%dw 2.0
import dw::Crypto
output application/json
---
{
  "HMACBinary" : Crypto::HMACBinary("confidential" as Binary, "xxxxx" as Binary, "HmacSHA512")
}
```

#### Output

```JSON
{
  "HMACBinary": "\ufffd\ufffd\ufffd\ufffd^h\ufffd!3\u0005\ufffd֎\u00017\ufffd\ufffd\ufffd`\ufffd8?\ufffdjn7\ufffdbs;\t\ufffdƅ\ufffd\ufffd\ufffdx&g\ufffd~\ufffd\ufffd%\ufffd7>1\ufffdK\u000e@\ufffdC\u0011\ufffdT\ufffd}W"
}
```

<!-- document id=8ee30f6eba18d78aa250e1264b5a2b22c13812b70ea3dd0ecf51bc8b42375f6b url=/mulesoft/current/en-us/dataweave/2.6/dw-crypto-functions-hmacbinary.md -->

---
product: DataWeave
version: 2.6
---

# HMACBinary

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## HMACBinary(secret: Binary, content: Binary, algorithm: String = "HmacSHA1"): Binary

Computes an HMAC hash (with a secret cryptographic key) on input content.

See also, `HMACWith`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>secret</code></p></td><td><div><div><p>The secret cryptographic key (a binary value) used when encrypting the <code>content</code>.</p></div></div></td></tr><tr><td><p><code>content</code></p></td><td><div><div><p>The binary input value.</p></div></div></td></tr><tr><td><p><code>algorithm</code></p></td><td><div><div><p>The hashing algorithm. <code>HmacSHA1</code> is the default. Valid values depend on the JDK version you are using. For JDK 8 and JDK 11, <code>HmacMD5</code>, <code>HmacSHA1</code>, <code>HmacSHA224</code>, <code>HmacSHA256</code>, <code>HmacSHA384</code>, and <code>HmacSHA512</code> are valid algorithms. For JDK 11, <code>HmacSHA512/224</code> and <code>HmacSHA512/256</code> are also valid.</p></div></div></td></tr></tbody></table>

### Example

This example uses HMAC with a secret value to encrypt the input content.

#### Source

```DataWeave
%dw 2.0
import dw::Crypto
output application/json
---
{
  "HMACBinary" : Crypto::HMACBinary("confidential" as Binary, "xxxxx" as Binary, "HmacSHA512")
}
```

#### Output

```JSON
{
  "HMACBinary": "\ufffd\ufffd\ufffd\ufffd^h\ufffd!3\u0005\ufffd֎\u00017\ufffd\ufffd\ufffd`\ufffd8?\ufffdjn7\ufffdbs;\t\ufffdƅ\ufffd\ufffd\ufffdx&g\ufffd~\ufffd\ufffd%\ufffd7>1\ufffdK\u000e@\ufffdC\u0011\ufffdT\ufffd}W"
}
```

<!-- document id=be7ed8dcda0697b0ba809b5905800472100360a44a180e23ea65a4d38567fbe9 url=/mulesoft/current/en-us/dataweave/2.9/dw-crypto-functions-hmacbinary.md -->

---
product: DataWeave
version: 2.9
---

# HMACBinary

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## HMACBinary(secret: Binary, content: Binary, algorithm: String = "HmacSHA1"): Binary

Computes an HMAC hash (with a secret cryptographic key) on input content.

See also, `HMACWith`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>secret</code></p></td><td><div><div><p>The secret cryptographic key (a binary value) used when encrypting the <code>content</code>.</p></div></div></td></tr><tr><td><p><code>content</code></p></td><td><div><div><p>The binary input value.</p></div></div></td></tr><tr><td><p><code>algorithm</code></p></td><td><div><div><p>The hashing algorithm. <code>HmacSHA1</code> is the default. Valid values depend on the JDK version you are using. For JDK 8 and JDK 11, <code>HmacMD5</code>, <code>HmacSHA1</code>, <code>HmacSHA224</code>, <code>HmacSHA256</code>, <code>HmacSHA384</code>, and <code>HmacSHA512</code> are valid algorithms. For JDK 11, <code>HmacSHA512/224</code> and <code>HmacSHA512/256</code> are also valid.</p></div></div></td></tr></tbody></table>

### Example

This example uses HMAC with a secret value to encrypt the input content.

#### Source

```DataWeave
%dw 2.0
import dw::Crypto
output application/json
---
{
  "HMACBinary" : Crypto::HMACBinary("confidential" as Binary, "xxxxx" as Binary, "HmacSHA512")
}
```

#### Output

```JSON
{
  "HMACBinary": "\ufffd\ufffd\ufffd\ufffd^h\ufffd!3\u0005\ufffd֎\u00017\ufffd\ufffd\ufffd`\ufffd8?\ufffdjn7\ufffdbs;\t\ufffdƅ\ufffd\ufffd\ufffdx&g\ufffd~\ufffd\ufffd%\ufffd7>1\ufffdK\u000e@\ufffdC\u0011\ufffdT\ufffd}W"
}
```

<!-- document id=087d43baa0a2f0942cef5d5286ae0d7beb93f94ad5cad89b2f41c146d0512f62 url=/mulesoft/current/en-us/dataweave/latest/dw-crypto-functions-hmacbinary.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# HMACBinary

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## HMACBinary(secret: Binary, content: Binary, @CryptographicSink algorithm: String = "HmacSHA1"): Binary

Computes an HMAC hash (with a secret cryptographic key) on input content.

See also, `HMACWith`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>secret</code></p></td><td><div><div><p>The secret cryptographic key (a binary value) used when encrypting the <code>content</code>.</p></div></div></td></tr><tr><td><p><code>content</code></p></td><td><div><div><p>The binary input value.</p></div></div></td></tr><tr><td><p><code>algorithm</code></p></td><td><div><div><p>The hashing algorithm. <code>HmacSHA1</code> is the default. Valid values depend on the JDK version you are using. For JDK 8 and JDK 11, <code>HmacMD5</code>, <code>HmacSHA1</code>, <code>HmacSHA224</code>, <code>HmacSHA256</code>, <code>HmacSHA384</code>, and <code>HmacSHA512</code> are valid algorithms. For JDK 11, <code>HmacSHA512/224</code> and <code>HmacSHA512/256</code> are also valid.</p></div></div></td></tr></tbody></table>

### Example

This example uses HMAC with a secret value to encrypt the input content.

#### Source

```DataWeave
%dw 2.0
import dw::Crypto
output application/json
---
{
  "HMACBinary" : Crypto::HMACBinary("confidential" as Binary, "xxxxx" as Binary, "HmacSHA512")
}
```

#### Output

```JSON
{
  "HMACBinary": "\ufffd\ufffd\ufffd\ufffd^h\ufffd!3\u0005\ufffd֎\u00017\ufffd\ufffd\ufffd`\ufffd8?\ufffdjn7\ufffdbs;\t\ufffdƅ\ufffd\ufffd\ufffdx&g\ufffd~\ufffd\ufffd%\ufffd7>1\ufffdK\u000e@\ufffdC\u0011\ufffdT\ufffd}W"
}
```

<!-- document id=e601fd5fe32c8368aaaa2370551cffa0f18ce285da3a608ee3227409184eacbb url=/mulesoft/current/en-us/dataweave/2.11/dw-crypto-functions-hmacwith.md -->

---
product: DataWeave
version: 2.11
---

# HMACWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## HMACWith(secret: Binary, content: Binary, @Since(version = "2.2.0") algorithm: String = "HmacSHA1"): String

Computes an HMAC hash (with a secret cryptographic key) on input content, then transforms the result
into a lowercase, hexadecimal string.

See also, `HMACBinary`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>secret</code></p></td><td><p>The secret cryptographic key (a binary value) used when encrypting the <code>content</code>.</p></td></tr><tr><td><p><code>content</code></p></td><td><p>The binary input value.</p></td></tr><tr><td><p><code>algorithm</code></p></td><td><p>(<em>Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later.</em>) The hashing algorithm. By default, <code>HmacSHA1</code> is used. Other valid values are <code>HmacSHA256</code> and <code>HmacSHA512</code>.</p></td></tr></tbody></table>

### Example

This example uses HMAC with a secret value to encrypt the input content using the `HmacSHA256`
algorithm.

#### Source

```DataWeave
%dw 2.0
import dw::Crypto
output application/json
---
{ "HMACWith" : Crypto::HMACWith("secret_key" as Binary, "Some value to hash" as Binary, "HmacSHA256") }
```

#### Output

```JSON
{ "HMACWith": "b51b4fe8c4e37304605753272b5b4321f9644a9b09cb1179d7016c25041d1747" }
```

<!-- document id=52d4e790fb02d93643b08a7ca2e914b877302e9c5626a2fa34f02ead7eb470b0 url=/mulesoft/current/en-us/dataweave/2.12/dw-crypto-functions-hmacwith.md -->

---
product: DataWeave
version: 2.12
---

# HMACWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## HMACWith(secret: Binary, content: Binary, @Since(version = "2.2.0") algorithm: String = "HmacSHA1"): String

Computes an HMAC hash (with a secret cryptographic key) on input content, then transforms the result
into a lowercase, hexadecimal string.

See also, `HMACBinary`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>secret</code></p></td><td><p>The secret cryptographic key (a binary value) used when encrypting the <code>content</code>.</p></td></tr><tr><td><p><code>content</code></p></td><td><p>The binary input value.</p></td></tr><tr><td><p><code>algorithm</code></p></td><td><p>(<em>Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later.</em>) The hashing algorithm. By default, <code>HmacSHA1</code> is used. Other valid values are <code>HmacSHA256</code> and <code>HmacSHA512</code>.</p></td></tr></tbody></table>

### Example

This example uses HMAC with a secret value to encrypt the input content using the `HmacSHA256`
algorithm.

#### Source

```DataWeave
%dw 2.0
import dw::Crypto
output application/json
---
{ "HMACWith" : Crypto::HMACWith("secret_key" as Binary, "Some value to hash" as Binary, "HmacSHA256") }
```

#### Output

```JSON
{ "HMACWith": "b51b4fe8c4e37304605753272b5b4321f9644a9b09cb1179d7016c25041d1747" }
```

<!-- document id=6fa241ea6f3fca99c174bf8c47fc27b7f069970b7bb44f25b02c7d992791ed98 url=/mulesoft/current/en-us/dataweave/2.3/dw-crypto-functions-hmacwith.md -->

---
product: DataWeave
version: 2.3
---

# HMACWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## HMACWith(Binary, Binary, String): String

Computes an HMAC hash (with a secret cryptographic key) on input content, then transforms the result
into a lowercase, hexadecimal string.

See also, `HMACBinary`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>secret</code></p></td><td><p>The secret cryptographic key (a <code>Binary</code>) used when encrypting the <code>content</code>).</p></td></tr><tr><td><p><code>content</code></p></td><td><p>The input content, a <code>Binary</code> value.</p></td></tr><tr><td><p><code>algorithm</code></p></td><td><p>(<em>Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later.</em>) The hashing algorithm. By default, <code>HmacSHA1</code> is used. Other valid values are <code>HmacSHA256</code> and <code>HmacSHA512</code>.</p></td></tr></tbody></table>

### Example

This example uses HMAC with a secret value to encrypt the input content using the `HmacSHA256`
algorithm.

#### Source

```DataWeave
%dw 2.0
import dw::Crypto
output application/json
---
{ "HMACWith" : Crypto::HMACWith("secret_key" as Binary, "Some value to hash" as Binary, "HmacSHA256") }
```

#### Output

```JSON
{ "HMACWith": "b51b4fe8c4e37304605753272b5b4321f9644a9b09cb1179d7016c25041d1747" }
```

<!-- document id=74d5bbc92f0e2acb2d18aa0ec35df5f136208c984013f1a33adc7b2b1ee5bab4 url=/mulesoft/current/en-us/dataweave/2.4/dw-crypto-functions-hmacwith.md -->

---
product: DataWeave
version: 2.4
---

# HMACWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## HMACWith(secret: Binary, content: Binary, @Since(version= "2.2.0") algorithm: String = "HmacSHA1"): String

Computes an HMAC hash (with a secret cryptographic key) on input content, then transforms the result
into a lowercase, hexadecimal string.

See also, `HMACBinary`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>secret</code></p></td><td><p>The secret cryptographic key (a binary value) used when encrypting the <code>content</code>.</p></td></tr><tr><td><p><code>content</code></p></td><td><p>The binary input value.</p></td></tr><tr><td><p><code>algorithm</code></p></td><td><p>(<em>Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later.</em>) The hashing algorithm. By default, <code>HmacSHA1</code> is used. Other valid values are <code>HmacSHA256</code> and <code>HmacSHA512</code>.</p></td></tr></tbody></table>

### Example

This example uses HMAC with a secret value to encrypt the input content using the `HmacSHA256`
algorithm.

#### Source

```DataWeave
%dw 2.0
import dw::Crypto
output application/json
---
{ "HMACWith" : Crypto::HMACWith("secret_key" as Binary, "Some value to hash" as Binary, "HmacSHA256") }
```

#### Output

```JSON
{ "HMACWith": "b51b4fe8c4e37304605753272b5b4321f9644a9b09cb1179d7016c25041d1747" }
```

<!-- document id=d7dab67cad2ef5668ed388328f9632af4e981fb500f8a2b85f87ababca7612e2 url=/mulesoft/current/en-us/dataweave/2.6/dw-crypto-functions-hmacwith.md -->

---
product: DataWeave
version: 2.6
---

# HMACWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## HMACWith(secret: Binary, content: Binary, @Since(version = "2.2.0") algorithm: String = "HmacSHA1"): String

Computes an HMAC hash (with a secret cryptographic key) on input content, then transforms the result
into a lowercase, hexadecimal string.

See also, `HMACBinary`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>secret</code></p></td><td><p>The secret cryptographic key (a binary value) used when encrypting the <code>content</code>.</p></td></tr><tr><td><p><code>content</code></p></td><td><p>The binary input value.</p></td></tr><tr><td><p><code>algorithm</code></p></td><td><p>(<em>Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later.</em>) The hashing algorithm. By default, <code>HmacSHA1</code> is used. Other valid values are <code>HmacSHA256</code> and <code>HmacSHA512</code>.</p></td></tr></tbody></table>

### Example

This example uses HMAC with a secret value to encrypt the input content using the `HmacSHA256`
algorithm.

#### Source

```DataWeave
%dw 2.0
import dw::Crypto
output application/json
---
{ "HMACWith" : Crypto::HMACWith("secret_key" as Binary, "Some value to hash" as Binary, "HmacSHA256") }
```

#### Output

```JSON
{ "HMACWith": "b51b4fe8c4e37304605753272b5b4321f9644a9b09cb1179d7016c25041d1747" }
```

<!-- document id=cce6bfa732839db4cc2d4d2b2a6301560f26bb9147470869a798905ce57129eb url=/mulesoft/current/en-us/dataweave/2.9/dw-crypto-functions-hmacwith.md -->

---
product: DataWeave
version: 2.9
---

# HMACWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## HMACWith(secret: Binary, content: Binary, @Since(version = "2.2.0") algorithm: String = "HmacSHA1"): String

Computes an HMAC hash (with a secret cryptographic key) on input content, then transforms the result
into a lowercase, hexadecimal string.

See also, `HMACBinary`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>secret</code></p></td><td><p>The secret cryptographic key (a binary value) used when encrypting the <code>content</code>.</p></td></tr><tr><td><p><code>content</code></p></td><td><p>The binary input value.</p></td></tr><tr><td><p><code>algorithm</code></p></td><td><p>(<em>Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later.</em>) The hashing algorithm. By default, <code>HmacSHA1</code> is used. Other valid values are <code>HmacSHA256</code> and <code>HmacSHA512</code>.</p></td></tr></tbody></table>

### Example

This example uses HMAC with a secret value to encrypt the input content using the `HmacSHA256`
algorithm.

#### Source

```DataWeave
%dw 2.0
import dw::Crypto
output application/json
---
{ "HMACWith" : Crypto::HMACWith("secret_key" as Binary, "Some value to hash" as Binary, "HmacSHA256") }
```

#### Output

```JSON
{ "HMACWith": "b51b4fe8c4e37304605753272b5b4321f9644a9b09cb1179d7016c25041d1747" }
```

<!-- document id=2f76f4aad65615d4725d5f28642f73a4ed52d15c34e97beb3215feb81b0fa9d8 url=/mulesoft/current/en-us/dataweave/latest/dw-crypto-functions-hmacwith.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# HMACWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## HMACWith(secret: Binary, content: Binary, @Since(version = "2.2.0") algorithm: String = "HmacSHA1"): String

Computes an HMAC hash (with a secret cryptographic key) on input content, then transforms the result
into a lowercase, hexadecimal string.

See also, `HMACBinary`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>secret</code></p></td><td><p>The secret cryptographic key (a binary value) used when encrypting the <code>content</code>.</p></td></tr><tr><td><p><code>content</code></p></td><td><p>The binary input value.</p></td></tr><tr><td><p><code>algorithm</code></p></td><td><p>(<em>Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later.</em>) The hashing algorithm. By default, <code>HmacSHA1</code> is used. Other valid values are <code>HmacSHA256</code> and <code>HmacSHA512</code>.</p></td></tr></tbody></table>

### Example

This example uses HMAC with a secret value to encrypt the input content using the `HmacSHA256`
algorithm.

#### Source

```DataWeave
%dw 2.0
import dw::Crypto
output application/json
---
{ "HMACWith" : Crypto::HMACWith("secret_key" as Binary, "Some value to hash" as Binary, "HmacSHA256") }
```

#### Output

```JSON
{ "HMACWith": "b51b4fe8c4e37304605753272b5b4321f9644a9b09cb1179d7016c25041d1747" }
```

<!-- document id=a303fefb5bdaa3704e7c319692609a94b3c644e9338347629f80f50418e5d073 url=/mulesoft/current/en-us/dataweave/2.11/dw-periods-functions-hours.md -->

---
product: DataWeave
version: 2.11
---

# hours

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## hours(nHours: Number): Period

Creates a Period value from the provided number of hours.

The function applies the `duration` function to the input value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>nHours</code></p></td><td><p>The number of hours as a whole or decimal number. A positive or negative number is valid.</p></td></tr></tbody></table>

### Example

This example shows how `hours` behaves with different inputs. It adds and subtracts hours from
DateTime and LocalTime values. It also converts the decimal value `4.555` into the Period format
(`PT4H33M18S`) and the whole number `4` into the Period format (`PT4H`). Notice that
`hours(-1) + hours(2)` returns the number of seconds.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Periods
output application/json
---
{
   nextHour: |2020-10-05T20:22:34.385Z| + hours(1),
   previousHour: |2020-10-05T20:22:34.385Z| - hours(1),
   threeHoursLater: |20:22| + hours(3),
   addDecimalInput: |20:22| + hours(3.5),
   decimalInputAsPeriod : hours(4.555),
   fourHourPeriod : hours(4),
   addNegativeValue: hours(-1) + hours(2)
}
```

#### Output

```Json
{
   "nextHour": "2020-10-05T21:22:34.385Z",
   "previousHour": "2020-10-05T19:22:34.385Z",
   "threeHoursLater": "23:22:00",
   "addDecimalInput": "23:52:00",
   "decimalInputAsPeriod": "PT4H33M18S",
   "fourHourPeriod": "PT4H",
   "addNegativeValue": 3600
}
```

<!-- document id=62c03bf56ae1158a75d4f3b12a1da88993eb69f7a48f1b445a6ebf829ce066dd url=/mulesoft/current/en-us/dataweave/2.12/dw-periods-functions-hours.md -->

---
product: DataWeave
version: 2.12
---

# hours

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## hours(nHours: Number): Period

Creates a Period value from the provided number of hours.

The function applies the `duration` function to the input value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>nHours</code></p></td><td><p>The number of hours as a whole or decimal number. A positive or negative number is valid.</p></td></tr></tbody></table>

### Example

This example shows how `hours` behaves with different inputs. It adds and subtracts hours from
DateTime and LocalTime values. It also converts the decimal value `4.555` into the Period format
(`PT4H33M18S`) and the whole number `4` into the Period format (`PT4H`). Notice that
`hours(-1) + hours(2)` returns the number of seconds.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Periods
output application/json
---
{
   nextHour: |2020-10-05T20:22:34.385Z| + hours(1),
   previousHour: |2020-10-05T20:22:34.385Z| - hours(1),
   threeHoursLater: |20:22| + hours(3),
   addDecimalInput: |20:22| + hours(3.5),
   decimalInputAsPeriod : hours(4.555),
   fourHourPeriod : hours(4),
   addNegativeValue: hours(-1) + hours(2)
}
```

#### Output

```Json
{
   "nextHour": "2020-10-05T21:22:34.385Z",
   "previousHour": "2020-10-05T19:22:34.385Z",
   "threeHoursLater": "23:22:00",
   "addDecimalInput": "23:52:00",
   "decimalInputAsPeriod": "PT4H33M18S",
   "fourHourPeriod": "PT4H",
   "addNegativeValue": 3600
}
```

<!-- document id=8a07e2debb809906892324adb7ebd84f160a3a12b30d30f99d431bd767aba77f url=/mulesoft/current/en-us/dataweave/2.4/dw-periods-functions-hours.md -->

---
product: DataWeave
version: 2.4
---

# hours

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## hours(nHours: Number): Period

Creates a Period value from the provided number of hours.

The function applies the `duration` function to the input value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>nHours</code></p></td><td><p>The number of hours as a whole or decimal number. A positive or negative number is valid.</p></td></tr></tbody></table>

### Example

This example shows how `hours` behaves with different inputs. It adds and subtracts hours from
DateTime and LocalTime values. It also converts the decimal value `4.555` into the Period format
(`PT4H33M18S`) and the whole number `4` into the Period format (`PT4H`). Notice that
`hours(-1) + hours(2)` returns the number of seconds.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Periods
output application/json
---
{
   nextHour: |2020-10-05T20:22:34.385Z| + hours(1),
   previousHour: |2020-10-05T20:22:34.385Z| - hours(1),
   threeHoursLater: |20:22| + hours(3),
   addDecimalInput: |20:22| + hours(3.5),
   decimalInputAsPeriod : hours(4.555),
   fourHourPeriod : hours(4),
   addNegativeValue: hours(-1) + hours(2)
}
```

#### Output

```Json
{
   "nextHour": "2020-10-05T21:22:34.385Z",
   "previousHour": "2020-10-05T19:22:34.385Z",
   "threeHoursLater": "23:22:00",
   "addDecimalInput": "23:52:00",
   "decimalInputAsPeriod": "PT4H33M18S",
   "fourHourPeriod": "PT4H",
   "addNegativeValue": 3600
}
```

<!-- document id=389f83a95edb23909b1be0c02f00ed40f344e07684b7c428483250d9fbbd9798 url=/mulesoft/current/en-us/dataweave/2.6/dw-periods-functions-hours.md -->

---
product: DataWeave
version: 2.6
---

# hours

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## hours(nHours: Number): Period

Creates a Period value from the provided number of hours.

The function applies the `duration` function to the input value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>nHours</code></p></td><td><p>The number of hours as a whole or decimal number. A positive or negative number is valid.</p></td></tr></tbody></table>

### Example

This example shows how `hours` behaves with different inputs. It adds and subtracts hours from
DateTime and LocalTime values. It also converts the decimal value `4.555` into the Period format
(`PT4H33M18S`) and the whole number `4` into the Period format (`PT4H`). Notice that
`hours(-1) + hours(2)` returns the number of seconds.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Periods
output application/json
---
{
   nextHour: |2020-10-05T20:22:34.385Z| + hours(1),
   previousHour: |2020-10-05T20:22:34.385Z| - hours(1),
   threeHoursLater: |20:22| + hours(3),
   addDecimalInput: |20:22| + hours(3.5),
   decimalInputAsPeriod : hours(4.555),
   fourHourPeriod : hours(4),
   addNegativeValue: hours(-1) + hours(2)
}
```

#### Output

```Json
{
   "nextHour": "2020-10-05T21:22:34.385Z",
   "previousHour": "2020-10-05T19:22:34.385Z",
   "threeHoursLater": "23:22:00",
   "addDecimalInput": "23:52:00",
   "decimalInputAsPeriod": "PT4H33M18S",
   "fourHourPeriod": "PT4H",
   "addNegativeValue": 3600
}
```

<!-- document id=8289477a95e345facef2c1d0341599a71aa35174c2d0f0029a1d28828477c915 url=/mulesoft/current/en-us/dataweave/2.9/dw-periods-functions-hours.md -->

---
product: DataWeave
version: 2.9
---

# hours

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## hours(nHours: Number): Period

Creates a Period value from the provided number of hours.

The function applies the `duration` function to the input value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>nHours</code></p></td><td><p>The number of hours as a whole or decimal number. A positive or negative number is valid.</p></td></tr></tbody></table>

### Example

This example shows how `hours` behaves with different inputs. It adds and subtracts hours from
DateTime and LocalTime values. It also converts the decimal value `4.555` into the Period format
(`PT4H33M18S`) and the whole number `4` into the Period format (`PT4H`). Notice that
`hours(-1) + hours(2)` returns the number of seconds.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Periods
output application/json
---
{
   nextHour: |2020-10-05T20:22:34.385Z| + hours(1),
   previousHour: |2020-10-05T20:22:34.385Z| - hours(1),
   threeHoursLater: |20:22| + hours(3),
   addDecimalInput: |20:22| + hours(3.5),
   decimalInputAsPeriod : hours(4.555),
   fourHourPeriod : hours(4),
   addNegativeValue: hours(-1) + hours(2)
}
```

#### Output

```Json
{
   "nextHour": "2020-10-05T21:22:34.385Z",
   "previousHour": "2020-10-05T19:22:34.385Z",
   "threeHoursLater": "23:22:00",
   "addDecimalInput": "23:52:00",
   "decimalInputAsPeriod": "PT4H33M18S",
   "fourHourPeriod": "PT4H",
   "addNegativeValue": 3600
}
```

<!-- document id=a845d6e01572f8e9bf33454150d4f6eaafe0d253796165b822e7f7e9518276de url=/mulesoft/current/en-us/dataweave/latest/dw-periods-functions-hours.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# hours

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## hours(nHours: Number): Period

Creates a Period value from the provided number of hours.

The function applies the `duration` function to the input value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>nHours</code></p></td><td><p>The number of hours as a whole or decimal number. A positive or negative number is valid.</p></td></tr></tbody></table>

### Example

This example shows how `hours` behaves with different inputs. It adds and subtracts hours from
DateTime and LocalTime values. It also converts the decimal value `4.555` into the Period format
(`PT4H33M18S`) and the whole number `4` into the Period format (`PT4H`). Notice that
`hours(-1) + hours(2)` returns the number of seconds.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Periods
output application/json
---
{
   nextHour: |2020-10-05T20:22:34.385Z| + hours(1),
   previousHour: |2020-10-05T20:22:34.385Z| - hours(1),
   threeHoursLater: |20:22| + hours(3),
   addDecimalInput: |20:22| + hours(3.5),
   decimalInputAsPeriod : hours(4.555),
   fourHourPeriod : hours(4),
   addNegativeValue: hours(-1) + hours(2)
}
```

#### Output

```Json
{
   "nextHour": "2020-10-05T21:22:34.385Z",
   "previousHour": "2020-10-05T19:22:34.385Z",
   "threeHoursLater": "23:22:00",
   "addDecimalInput": "23:52:00",
   "decimalInputAsPeriod": "PT4H33M18S",
   "fourHourPeriod": "PT4H",
   "addNegativeValue": 3600
}
```

<!-- document id=36cf32663fcc36e11c6f055ee54c5f2389e1703d0aa78d4bcb72d570e5841b7c url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook-include-xml-namespaces.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Include XML Namespaces

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You can define different namespaces in the header and then reference them on each tag.

Starting in the Mule 4.2.1 release, DataWeave also supports dynamically generated namespace keys and
attributes.

The following example uses:

- `ns` for namespace definitions in the header

- `@` to define other attributes in an XML element

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
ns orders http://www.acme.com/shemas/Orders
ns stores http://www.acme.com/shemas/Stores
---
root:
    orders#orders: {
        stores#shipNodeId: "SF01",
        stores#shipNodeId @(shipsVia:"LA01"): "NY03"
    }
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<root>
  <orders:orders xmlns:orders="http://www.acme.com/shemas/Orders">
    <stores:shipNodeId xmlns:stores="http://www.acme.com/shemas/Stores">SF01</stores:shipNodeId>
    <stores:shipNodeId xmlns:stores="http://www.acme.com/shemas/Stores" shipsVia="LA01">NY03</stores:shipNodeId>
  </orders:orders>
</root>
```

## Dynamically Generated Namespace Values

_Support starting in Mule version 4.2.1_

Using input defined in the DataWeave variables, the DataWeave functions in the following example
output values for namespace keys and attributes.

DataWeave Script:

```dataweave
%dw 2.0
fun dynKeyNs(ns0: Namespace, value: Any) = { ns0#myDynKey: value }
fun dynAttrNs(ns0: Namespace, value: Any) = { myChildTag @(ns0#myDynAttribute: true): value }
var namespace1 = {uri: "http://acme.com", prefix: "ns0"} as Namespace
var namespace2 = {uri: "http://emca.com", prefix: "ns0"} as Namespace
output application/xml
---
root:

{
  mytagA: dynKeyNs(namespace1, "myTest1"),
  myTagB: dynKeyNs(namespace2, "myTest2"),
  myTagC: dynAttrNs(namespace1, "myTest1"),
  myTagD: dynAttrNs(namespace2, "myTest2")
}
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<root>
  <mytagA>
    <ns0:myDynKey xmlns:ns0="http://acme.com">myTest1</ns0:myDynKey>
  </mytagA>
  <myTagB>
    <ns0:myDynKey xmlns:ns0="http://emca.com">myTest2</ns0:myDynKey>
  </myTagB>
  <myTagC>
    <myChildTag xmlns:ns0="http://acme.com" ns0:myDynAttribute="true">myTest1</myChildTag>
  </myTagC>
  <myTagD>
    <myChildTag xmlns:ns0="http://emca.com" ns0:myDynAttribute="true">myTest2</myChildTag>
  </myTagD>
</root>
```

## Use XML Namespace with Hyphen Character

The following DataWeave script shows you how to define an XML namespace as an object, which enables
you to use special characters such as hyphen (`-`) in the namespace definition:

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
var myNS = {uri: "http://www.abc.com", prefix: "ns-0"} as Namespace
---
{myNS#bla : "dw"}
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<ns-0:bla xmlns:ns-0="http://www.abc.com">dw</ns-0:bla>
```

## Related Examples

- [Output Self-closing XML tags](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-output-self-closing-xml-tags)

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-insert-attribute)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.11/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook)

<!-- document id=91cd67fc12496a7223b56cbb3fd17fc651d5cf4228d17a3ccab1c0659c974afb url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook-include-xml-namespaces.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Include XML Namespaces

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You can define different namespaces in the header and then reference them on each tag.

Starting in the Mule 4.2.1 release, DataWeave also supports dynamically generated namespace keys and
attributes.

The following example uses:

- `ns` for namespace definitions in the header

- `@` to define other attributes in an XML element

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
ns orders http://www.acme.com/shemas/Orders
ns stores http://www.acme.com/shemas/Stores
---
root:
    orders#orders: {
        stores#shipNodeId: "SF01",
        stores#shipNodeId @(shipsVia:"LA01"): "NY03"
    }
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<root>
  <orders:orders xmlns:orders="http://www.acme.com/shemas/Orders">
    <stores:shipNodeId xmlns:stores="http://www.acme.com/shemas/Stores">SF01</stores:shipNodeId>
    <stores:shipNodeId xmlns:stores="http://www.acme.com/shemas/Stores" shipsVia="LA01">NY03</stores:shipNodeId>
  </orders:orders>
</root>
```

## Dynamically Generated Namespace Values

_Support starting in Mule version 4.2.1_

Using input defined in the DataWeave variables, the DataWeave functions in the following example
output values for namespace keys and attributes.

DataWeave Script:

```dataweave
%dw 2.0
fun dynKeyNs(ns0: Namespace, value: Any) = { ns0#myDynKey: value }
fun dynAttrNs(ns0: Namespace, value: Any) = { myChildTag @(ns0#myDynAttribute: true): value }
var namespace1 = {uri: "http://acme.com", prefix: "ns0"} as Namespace
var namespace2 = {uri: "http://emca.com", prefix: "ns0"} as Namespace
output application/xml
---
root:

{
  mytagA: dynKeyNs(namespace1, "myTest1"),
  myTagB: dynKeyNs(namespace2, "myTest2"),
  myTagC: dynAttrNs(namespace1, "myTest1"),
  myTagD: dynAttrNs(namespace2, "myTest2")
}
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<root>
  <mytagA>
    <ns0:myDynKey xmlns:ns0="http://acme.com">myTest1</ns0:myDynKey>
  </mytagA>
  <myTagB>
    <ns0:myDynKey xmlns:ns0="http://emca.com">myTest2</ns0:myDynKey>
  </myTagB>
  <myTagC>
    <myChildTag xmlns:ns0="http://acme.com" ns0:myDynAttribute="true">myTest1</myChildTag>
  </myTagC>
  <myTagD>
    <myChildTag xmlns:ns0="http://emca.com" ns0:myDynAttribute="true">myTest2</myChildTag>
  </myTagD>
</root>
```

## Use XML Namespace with Hyphen Character

The following DataWeave script shows you how to define an XML namespace as an object, which enables
you to use special characters such as hyphen (`-`) in the namespace definition:

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
var myNS = {uri: "http://www.abc.com", prefix: "ns-0"} as Namespace
---
{myNS#bla : "dw"}
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<ns-0:bla xmlns:ns-0="http://www.abc.com">dw</ns-0:bla>
```

## Related Examples

- [Output Self-closing XML tags](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-output-self-closing-xml-tags)

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-insert-attribute)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.12/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook)

<!-- document id=780499f88814e7fc2a839401a022c80aab804be0e51d998e9a6b37c5af6a1ead url=/mulesoft/current/en-us/dataweave/2.3/dataweave-cookbook-include-xml-namespaces.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Include XML Namespaces

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You can define different namespaces in the header and then reference them on each tag.

Starting in the Mule 4.2.1 release, DataWeave also supports dynamically generated namespace keys and
attributes.

The following example uses:

- `ns` for namespace definitions in the header

- `@` to define other attributes in an XML element

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
ns orders http://www.acme.com/shemas/Orders
ns stores http://www.acme.com/shemas/Stores
---
root:
    orders#orders: {
        stores#shipNodeId: "SF01",
        stores#shipNodeId @(shipsVia:"LA01"): "NY03"
    }
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<root>
  <orders:orders xmlns:orders="http://www.acme.com/shemas/Orders">
    <stores:shipNodeId xmlns:stores="http://www.acme.com/shemas/Stores">SF01</stores:shipNodeId>
    <stores:shipNodeId xmlns:stores="http://www.acme.com/shemas/Stores" shipsVia="LA01">NY03</stores:shipNodeId>
  </orders:orders>
</root>
```

## Dynamically Generated Namespace Values

_Support starting in Mule version 4.2.1_

Using input defined in the DataWeave variables, the DataWeave functions in the following example
output values for namespace keys and attributes.

DataWeave Script:

```dataweave
%dw 2.0
fun dynKeyNs(ns0: Namespace, value: Any) = { ns0#myDynKey: value }
fun dynAttrNs(ns0: Namespace, value: Any) = { myChildTag @(ns0#myDynAttribute: true): value }
var namespace1 = {uri: "http://acme.com", prefix: "ns0"} as Namespace
var namespace2 = {uri: "http://emca.com", prefix: "ns0"} as Namespace
output application/xml
---
root:

{
  mytagA: dynKeyNs(namespace1, "myTest1"),
  myTagB: dynKeyNs(namespace2, "myTest2"),
  myTagC: dynAttrNs(namespace1, "myTest1"),
  myTagD: dynAttrNs(namespace2, "myTest2")
}
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<root>
  <mytagA>
    <ns0:myDynKey xmlns:ns0="http://acme.com">myTest1</ns0:myDynKey>
  </mytagA>
  <myTagB>
    <ns0:myDynKey xmlns:ns0="http://emca.com">myTest2</ns0:myDynKey>
  </myTagB>
  <myTagC>
    <myChildTag xmlns:ns0="http://acme.com" ns0:myDynAttribute="true">myTest1</myChildTag>
  </myTagC>
  <myTagD>
    <myChildTag xmlns:ns0="http://emca.com" ns0:myDynAttribute="true">myTest2</myChildTag>
  </myTagD>
</root>
```

## Use XML Namespace with Hyphen Character

The following DataWeave script shows you how to define an XML namespace as an object, which enables
you to use special characters such as hyphen (`-`) in the namespace definition:

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
var myNS = {uri: "http://www.abc.com", prefix: "ns-0"} as Namespace
---
{myNS#bla : "dw"}
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<ns-0:bla xmlns:ns-0="http://www.abc.com">dw</ns-0:bla>
```

## Related Examples

- [Output Self-closing XML tags](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-output-self-closing-xml-tags)

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-insert-attribute)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.3/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook)

<!-- document id=cac6c7debc4b3fdd66813a7531f2a5a45d24d70e9385afc03d4c377eb659e072 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook-include-xml-namespaces.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Include XML Namespaces

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You can define different namespaces in the header and then reference them on each tag.

Starting in the Mule 4.2.1 release, DataWeave also supports dynamically generated namespace keys and
attributes.

The following example uses:

- `ns` for namespace definitions in the header

- `@` to define other attributes in an XML element

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
ns orders http://www.acme.com/shemas/Orders
ns stores http://www.acme.com/shemas/Stores
---
root:
    orders#orders: {
        stores#shipNodeId: "SF01",
        stores#shipNodeId @(shipsVia:"LA01"): "NY03"
    }
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<root>
  <orders:orders xmlns:orders="http://www.acme.com/shemas/Orders">
    <stores:shipNodeId xmlns:stores="http://www.acme.com/shemas/Stores">SF01</stores:shipNodeId>
    <stores:shipNodeId xmlns:stores="http://www.acme.com/shemas/Stores" shipsVia="LA01">NY03</stores:shipNodeId>
  </orders:orders>
</root>
```

## Dynamically Generated Namespace Values

_Support starting in Mule version 4.2.1_

Using input defined in the DataWeave variables, the DataWeave functions in the following example
output values for namespace keys and attributes.

DataWeave Script:

```dataweave
%dw 2.0
fun dynKeyNs(ns0: Namespace, value: Any) = { ns0#myDynKey: value }
fun dynAttrNs(ns0: Namespace, value: Any) = { myChildTag @(ns0#myDynAttribute: true): value }
var namespace1 = {uri: "http://acme.com", prefix: "ns0"} as Namespace
var namespace2 = {uri: "http://emca.com", prefix: "ns0"} as Namespace
output application/xml
---
root:

{
  mytagA: dynKeyNs(namespace1, "myTest1"),
  myTagB: dynKeyNs(namespace2, "myTest2"),
  myTagC: dynAttrNs(namespace1, "myTest1"),
  myTagD: dynAttrNs(namespace2, "myTest2")
}
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<root>
  <mytagA>
    <ns0:myDynKey xmlns:ns0="http://acme.com">myTest1</ns0:myDynKey>
  </mytagA>
  <myTagB>
    <ns0:myDynKey xmlns:ns0="http://emca.com">myTest2</ns0:myDynKey>
  </myTagB>
  <myTagC>
    <myChildTag xmlns:ns0="http://acme.com" ns0:myDynAttribute="true">myTest1</myChildTag>
  </myTagC>
  <myTagD>
    <myChildTag xmlns:ns0="http://emca.com" ns0:myDynAttribute="true">myTest2</myChildTag>
  </myTagD>
</root>
```

## Use XML Namespace with Hyphen Character

The following DataWeave script shows you how to define an XML namespace as an object, which enables
you to use special characters such as hyphen (`-`) in the namespace definition:

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
var myNS = {uri: "http://www.abc.com", prefix: "ns-0"} as Namespace
---
{myNS#bla : "dw"}
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<ns-0:bla xmlns:ns-0="http://www.abc.com">dw</ns-0:bla>
```

## Related Examples

- [Output Self-closing XML tags](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-output-self-closing-xml-tags)

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-insert-attribute)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.4/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook)

<!-- document id=3b5be95fcd43f5ba0d3ad81b41511ddbdf181abaf218d597214255aa7a6ed305 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook-include-xml-namespaces.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Include XML Namespaces

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You can define different namespaces in the header and then reference them on each tag.

Starting in the Mule 4.2.1 release, DataWeave also supports dynamically generated namespace keys and
attributes.

The following example uses:

- `ns` for namespace definitions in the header

- `@` to define other attributes in an XML element

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
ns orders http://www.acme.com/shemas/Orders
ns stores http://www.acme.com/shemas/Stores
---
root:
    orders#orders: {
        stores#shipNodeId: "SF01",
        stores#shipNodeId @(shipsVia:"LA01"): "NY03"
    }
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<root>
  <orders:orders xmlns:orders="http://www.acme.com/shemas/Orders">
    <stores:shipNodeId xmlns:stores="http://www.acme.com/shemas/Stores">SF01</stores:shipNodeId>
    <stores:shipNodeId xmlns:stores="http://www.acme.com/shemas/Stores" shipsVia="LA01">NY03</stores:shipNodeId>
  </orders:orders>
</root>
```

## Dynamically Generated Namespace Values

_Support starting in Mule version 4.2.1_

Using input defined in the DataWeave variables, the DataWeave functions in the following example
output values for namespace keys and attributes.

DataWeave Script:

```dataweave
%dw 2.0
fun dynKeyNs(ns0: Namespace, value: Any) = { ns0#myDynKey: value }
fun dynAttrNs(ns0: Namespace, value: Any) = { myChildTag @(ns0#myDynAttribute: true): value }
var namespace1 = {uri: "http://acme.com", prefix: "ns0"} as Namespace
var namespace2 = {uri: "http://emca.com", prefix: "ns0"} as Namespace
output application/xml
---
root:

{
  mytagA: dynKeyNs(namespace1, "myTest1"),
  myTagB: dynKeyNs(namespace2, "myTest2"),
  myTagC: dynAttrNs(namespace1, "myTest1"),
  myTagD: dynAttrNs(namespace2, "myTest2")
}
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<root>
  <mytagA>
    <ns0:myDynKey xmlns:ns0="http://acme.com">myTest1</ns0:myDynKey>
  </mytagA>
  <myTagB>
    <ns0:myDynKey xmlns:ns0="http://emca.com">myTest2</ns0:myDynKey>
  </myTagB>
  <myTagC>
    <myChildTag xmlns:ns0="http://acme.com" ns0:myDynAttribute="true">myTest1</myChildTag>
  </myTagC>
  <myTagD>
    <myChildTag xmlns:ns0="http://emca.com" ns0:myDynAttribute="true">myTest2</myChildTag>
  </myTagD>
</root>
```

## Use XML Namespace with Hyphen Character

The following DataWeave script shows you how to define an XML namespace as an object, which enables
you to use special characters such as hyphen (`-`) in the namespace definition:

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
var myNS = {uri: "http://www.abc.com", prefix: "ns-0"} as Namespace
---
{myNS#bla : "dw"}
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<ns-0:bla xmlns:ns-0="http://www.abc.com">dw</ns-0:bla>
```

## Related Examples

- [Output Self-closing XML tags](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-output-self-closing-xml-tags)

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-insert-attribute)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.6/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook)

<!-- document id=98f71bbaf68b2b5d4b9417e0be5c413f0aca4583b07e2cf8594dae125237a333 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook-include-xml-namespaces.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Include XML Namespaces

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You can define different namespaces in the header and then reference them on each tag.

Starting in the Mule 4.2.1 release, DataWeave also supports dynamically generated namespace keys and
attributes.

The following example uses:

- `ns` for namespace definitions in the header

- `@` to define other attributes in an XML element

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
ns orders http://www.acme.com/shemas/Orders
ns stores http://www.acme.com/shemas/Stores
---
root:
    orders#orders: {
        stores#shipNodeId: "SF01",
        stores#shipNodeId @(shipsVia:"LA01"): "NY03"
    }
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<root>
  <orders:orders xmlns:orders="http://www.acme.com/shemas/Orders">
    <stores:shipNodeId xmlns:stores="http://www.acme.com/shemas/Stores">SF01</stores:shipNodeId>
    <stores:shipNodeId xmlns:stores="http://www.acme.com/shemas/Stores" shipsVia="LA01">NY03</stores:shipNodeId>
  </orders:orders>
</root>
```

## Dynamically Generated Namespace Values

_Support starting in Mule version 4.2.1_

Using input defined in the DataWeave variables, the DataWeave functions in the following example
output values for namespace keys and attributes.

DataWeave Script:

```dataweave
%dw 2.0
fun dynKeyNs(ns0: Namespace, value: Any) = { ns0#myDynKey: value }
fun dynAttrNs(ns0: Namespace, value: Any) = { myChildTag @(ns0#myDynAttribute: true): value }
var namespace1 = {uri: "http://acme.com", prefix: "ns0"} as Namespace
var namespace2 = {uri: "http://emca.com", prefix: "ns0"} as Namespace
output application/xml
---
root:

{
  mytagA: dynKeyNs(namespace1, "myTest1"),
  myTagB: dynKeyNs(namespace2, "myTest2"),
  myTagC: dynAttrNs(namespace1, "myTest1"),
  myTagD: dynAttrNs(namespace2, "myTest2")
}
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<root>
  <mytagA>
    <ns0:myDynKey xmlns:ns0="http://acme.com">myTest1</ns0:myDynKey>
  </mytagA>
  <myTagB>
    <ns0:myDynKey xmlns:ns0="http://emca.com">myTest2</ns0:myDynKey>
  </myTagB>
  <myTagC>
    <myChildTag xmlns:ns0="http://acme.com" ns0:myDynAttribute="true">myTest1</myChildTag>
  </myTagC>
  <myTagD>
    <myChildTag xmlns:ns0="http://emca.com" ns0:myDynAttribute="true">myTest2</myChildTag>
  </myTagD>
</root>
```

## Use XML Namespace with Hyphen Character

The following DataWeave script shows you how to define an XML namespace as an object, which enables
you to use special characters such as hyphen (`-`) in the namespace definition:

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
var myNS = {uri: "http://www.abc.com", prefix: "ns-0"} as Namespace
---
{myNS#bla : "dw"}
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<ns-0:bla xmlns:ns-0="http://www.abc.com">dw</ns-0:bla>
```

## Related Examples

- [Output Self-closing XML tags](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-output-self-closing-xml-tags)

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-insert-attribute)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.9/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook)

<!-- document id=d617ca22c2b7c5ed2ab9e20be71c322f65a5cd913dbc74e3463adb68c7b71d30 url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook-include-xml-namespaces.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Include XML Namespaces

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You can define different namespaces in the header and then reference them on each tag.

Starting in the Mule 4.2.1 release, DataWeave also supports dynamically generated namespace keys and
attributes.

The following example uses:

- `ns` for namespace definitions in the header

- `@` to define other attributes in an XML element

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
ns orders http://www.acme.com/shemas/Orders
ns stores http://www.acme.com/shemas/Stores
---
root:
    orders#orders: {
        stores#shipNodeId: "SF01",
        stores#shipNodeId @(shipsVia:"LA01"): "NY03"
    }
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<root>
  <orders:orders xmlns:orders="http://www.acme.com/shemas/Orders">
    <stores:shipNodeId xmlns:stores="http://www.acme.com/shemas/Stores">SF01</stores:shipNodeId>
    <stores:shipNodeId xmlns:stores="http://www.acme.com/shemas/Stores" shipsVia="LA01">NY03</stores:shipNodeId>
  </orders:orders>
</root>
```

## Dynamically Generated Namespace Values

_Support starting in Mule version 4.2.1_

Using input defined in the DataWeave variables, the DataWeave functions in the following example
output values for namespace keys and attributes.

DataWeave Script:

```dataweave
%dw 2.0
fun dynKeyNs(ns0: Namespace, value: Any) = { ns0#myDynKey: value }
fun dynAttrNs(ns0: Namespace, value: Any) = { myChildTag @(ns0#myDynAttribute: true): value }
var namespace1 = {uri: "http://acme.com", prefix: "ns0"} as Namespace
var namespace2 = {uri: "http://emca.com", prefix: "ns0"} as Namespace
output application/xml
---
root:

{
  mytagA: dynKeyNs(namespace1, "myTest1"),
  myTagB: dynKeyNs(namespace2, "myTest2"),
  myTagC: dynAttrNs(namespace1, "myTest1"),
  myTagD: dynAttrNs(namespace2, "myTest2")
}
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<root>
  <mytagA>
    <ns0:myDynKey xmlns:ns0="http://acme.com">myTest1</ns0:myDynKey>
  </mytagA>
  <myTagB>
    <ns0:myDynKey xmlns:ns0="http://emca.com">myTest2</ns0:myDynKey>
  </myTagB>
  <myTagC>
    <myChildTag xmlns:ns0="http://acme.com" ns0:myDynAttribute="true">myTest1</myChildTag>
  </myTagC>
  <myTagD>
    <myChildTag xmlns:ns0="http://emca.com" ns0:myDynAttribute="true">myTest2</myChildTag>
  </myTagD>
</root>
```

## Use XML Namespace with Hyphen Character

The following DataWeave script shows you how to define an XML namespace as an object, which enables
you to use special characters such as hyphen (`-`) in the namespace definition:

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
var myNS = {uri: "http://www.abc.com", prefix: "ns-0"} as Namespace
---
{myNS#bla : "dw"}
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<ns-0:bla xmlns:ns-0="http://www.abc.com">dw</ns-0:bla>
```

## Related Examples

- [Output Self-closing XML tags](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-output-self-closing-xml-tags)

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-insert-attribute)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook)

<!-- document id=4676690feef3d15bc558730f7c4295d2959bef4f1333481172a4e945c7c33c9e url=/mulesoft/current/en-us/dataweave/2.11/dw-values-functions-index.md -->

---
product: DataWeave
version: 2.11
---

# index

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## index(index: Number): PathElement

This function creates a `PathElement` data type to use for selecting an _array element_ and
populates the type’s `selector` field with the specified index.

Some versions of the `update` and `mask` functions accept a `PathElement` as an argument.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>index</code></p></td><td><p>The index.</p></td></tr></tbody></table>

### Example

This example creates an selector for a specified index. It sets the selector’s value to `0`. In the
output, also note that the value of the `"kind"` key is `"Array"`.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::util::Values
ns ns0 http://acme.com/foo
---
index(0)
```

#### Output

```Json
{
   "kind": "Array",
   "namespace": null,
   "selector": 0
 }
```

<!-- document id=b9c255be746f7869886549da2983d425efb6aaa95f63e375f283affcb763a50e url=/mulesoft/current/en-us/dataweave/2.12/dw-values-functions-index.md -->

---
product: DataWeave
version: 2.12
---

# index

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## index(index: Number): PathElement

This function creates a `PathElement` data type to use for selecting an _array element_ and
populates the type’s `selector` field with the specified index.

Some versions of the `update` and `mask` functions accept a `PathElement` as an argument.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>index</code></p></td><td><p>The index.</p></td></tr></tbody></table>

### Example

This example creates an selector for a specified index. It sets the selector’s value to `0`. In the
output, also note that the value of the `"kind"` key is `"Array"`.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::util::Values
ns ns0 http://acme.com/foo
---
index(0)
```

#### Output

```Json
{
   "kind": "Array",
   "namespace": null,
   "selector": 0
 }
```

<!-- document id=c6fb1b057f250c66f61a3ecb4fb0b9255bbfda5c483c7507e2bcabf720f397bc url=/mulesoft/current/en-us/dataweave/2.3/dw-values-functions-index.md -->

---
product: DataWeave
version: 2.3
---

# index

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## index(Number): PathElement

This function creates a `PathElement` data type to use for selecting an _array element_ and
populates the type’s `selector` field with the specified index.

Some versions of the `update` and `mask` functions accept a `PathElement` as an argument.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>index</code></p></td><td><p>The index.</p></td></tr></tbody></table>

### Example

This example creates an selector for a specified index. It sets the selector’s value to `0`. In the
output, also note that the value of the `"kind"` key is `"Array"`.

#### Source

```DataWeave
 %dw 2.0
 output application/json
 import * from dw::util::Values
 ns ns0 http://acme.com/foo
 ---
 index(0)
```

#### Output

```Json
{
   "kind": "Array",
   "namespace": null,
   "selector": 0
 }
```

<!-- document id=e953e88c3e8ddb631791596396ba82b1a7b19229e2d791b3e886c3028c932a7c url=/mulesoft/current/en-us/dataweave/2.4/dw-values-functions-index.md -->

---
product: DataWeave
version: 2.4
---

# index

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## index(index: Number): PathElement

This function creates a `PathElement` data type to use for selecting an _array element_ and
populates the type’s `selector` field with the specified index.

Some versions of the `update` and `mask` functions accept a `PathElement` as an argument.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>index</code></p></td><td><p>The index.</p></td></tr></tbody></table>

### Example

This example creates an selector for a specified index. It sets the selector’s value to `0`. In the
output, also note that the value of the `"kind"` key is `"Array"`.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::util::Values
ns ns0 http://acme.com/foo
---
index(0)
```

#### Output

```Json
{
   "kind": "Array",
   "namespace": null,
   "selector": 0
 }
```

<!-- document id=0ed595cf85d58ca26a538224ec8b5c4b961516114de6551203111a80446b62b7 url=/mulesoft/current/en-us/dataweave/2.6/dw-values-functions-index.md -->

---
product: DataWeave
version: 2.6
---

# index

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## index(index: Number): PathElement

This function creates a `PathElement` data type to use for selecting an _array element_ and
populates the type’s `selector` field with the specified index.

Some versions of the `update` and `mask` functions accept a `PathElement` as an argument.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>index</code></p></td><td><p>The index.</p></td></tr></tbody></table>

### Example

This example creates an selector for a specified index. It sets the selector’s value to `0`. In the
output, also note that the value of the `"kind"` key is `"Array"`.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::util::Values
ns ns0 http://acme.com/foo
---
index(0)
```

#### Output

```Json
{
   "kind": "Array",
   "namespace": null,
   "selector": 0
 }
```

<!-- document id=38bfd3f6a6681f52135c93b60594f6ed53777e0db13aed3884b0a2f353bf6781 url=/mulesoft/current/en-us/dataweave/2.9/dw-values-functions-index.md -->

---
product: DataWeave
version: 2.9
---

# index

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## index(index: Number): PathElement

This function creates a `PathElement` data type to use for selecting an _array element_ and
populates the type’s `selector` field with the specified index.

Some versions of the `update` and `mask` functions accept a `PathElement` as an argument.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>index</code></p></td><td><p>The index.</p></td></tr></tbody></table>

### Example

This example creates an selector for a specified index. It sets the selector’s value to `0`. In the
output, also note that the value of the `"kind"` key is `"Array"`.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::util::Values
ns ns0 http://acme.com/foo
---
index(0)
```

#### Output

```Json
{
   "kind": "Array",
   "namespace": null,
   "selector": 0
 }
```

<!-- document id=810e858bda52c9d4465010431c2f3ec42944c23004cd1ebca9082d04bd17697d url=/mulesoft/current/en-us/dataweave/latest/dw-values-functions-index.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# index

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## index(index: Number): PathElement

This function creates a `PathElement` data type to use for selecting an _array element_ and
populates the type’s `selector` field with the specified index.

Some versions of the `update` and `mask` functions accept a `PathElement` as an argument.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>index</code></p></td><td><p>The index.</p></td></tr></tbody></table>

### Example

This example creates an selector for a specified index. It sets the selector’s value to `0`. In the
output, also note that the value of the `"kind"` key is `"Array"`.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::util::Values
ns ns0 http://acme.com/foo
---
index(0)
```

#### Output

```Json
{
   "kind": "Array",
   "namespace": null,
   "selector": 0
 }
```

<!-- document id=0c495289c0524e018d78819d491570375ccee7b590f17549a0ab9362c0f7ee26 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-indexed-readers.md -->

---
product: DataWeave
version: 2.11
---

# Indexed Readers in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

In DataWeave, some readers of input data (such as XML, JSON, and CSV) support an indexed strategy to
avoid loading the whole document in memory while still allowing random access just like in the
in-memory strategy. DataWeave uses indexed readers when the input is larger than a certain
configurable threshold or if the `indexedReader` setting is set to `true`.

The trade-off for managing files that wouldn’t fit in memory is to write the files to a temporary
file in disk and index the document content beforehand, which also takes time and disk space.

Indexed readers can process input files up to 20 GB. For bigger files use the streaming strategy,
which is faster. Despite this mode being more limited in functionality, there’s no maximum input
size limitation for streaming readers.

The actual max input file size supported is difficult to estimate because it depends on the content
of the input.

The following list shows the limits on different parts of the input file:

- Max nesting depth: `4096`

- Max individual value size: `4 GB`

- Tokens: `​​2^32-1` (approximately 4 billion)  
  A token is either a key/value pair, object-start or array-start, that limits the max input file
  size. The amount of the max input file size is irrespective of the size of each token in the file.
  The bigger your average value length, the bigger your input file size can be because what is
  important is the amount of tokens, not their size.

The following examples show input file size samples:

In this example, the max input file size is between 40 GB and 50 GB:

```json
[
  {
    "name": "Mariano",
    "lastName": "Achaval"
  },
  ...
]
```

The following example is similar to the previous one but minified where the max file size is
approximately 30 GB:

```json
[{"name":"Mariano","lastName":"Achaval"},...]
```

The following example shows a minified array of numbers `1`. DataWeave supports only approximately 8
GB of such file:

```json
[1,1,1,1,1,1,...]
```

## Large Strings Management

When processing a `String` with a size larger than 1.5 MB, DataWeave automatically splits the value
in chunks to avoid out-of-memory issues. This feature works only with `JSON` and `XML` input data.

You can configure the threshold that DataWeave uses to determine when to process a string using this
splitting strategy by modifying the following system property:

```none
com.mulesoft.dw.max_memory_allocation
```

Note that using this feature has a negative impact on performance due to splitting strings and
accessing them through local storage. If your environment has enough resources to load all content
in memory, you can also disable this string management feature completely by setting the value of
the following system property to `false`:

```none
com.mulesoft.dw.buffered_char_sequence.enabled
```

## See Also

- [CSV Format](https://docs.mulesoft.com/dataweave/2.11/dataweave-formats-csv)

- [JSON Format](https://docs.mulesoft.com/dataweave/2.11/dataweave-formats-json)

- [XML Format](https://docs.mulesoft.com/dataweave/2.11/dataweave-formats-xml)

- [Supported DataWeave Formats](https://docs.mulesoft.com/dataweave/2.11/dataweave-formats)

<!-- document id=fbde2bf4f474cb3052988058fb52e8b588bea7145e14559712047b705fb5d034 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-indexed-readers.md -->

---
product: DataWeave
version: 2.12
---

# Indexed Readers in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

In DataWeave, some readers of input data (such as XML, JSON, and CSV) support an indexed strategy to
avoid loading the whole document in memory while still allowing random access just like in the
in-memory strategy. DataWeave uses indexed readers when the input is larger than a certain
configurable threshold or if the `indexedReader` setting is set to `true`.

The trade-off for managing files that wouldn’t fit in memory is to write the files to a temporary
file in disk and index the document content beforehand, which also takes time and disk space.

Indexed readers can process input files up to 20 GB. For bigger files use the streaming strategy,
which is faster. Despite this mode being more limited in functionality, there’s no maximum input
size limitation for streaming readers.

The actual max input file size supported is difficult to estimate because it depends on the content
of the input.

The following list shows the limits on different parts of the input file:

- Max nesting depth: `4096`

- Max individual value size: `4 GB`

- Tokens: `​​2^32-1` (approximately 4 billion)  
  A token is either a key/value pair, object-start or array-start, that limits the max input file
  size. The amount of the max input file size is irrespective of the size of each token in the file.
  The bigger your average value length, the bigger your input file size can be because what is
  important is the amount of tokens, not their size.

The following examples show input file size samples:

In this example, the max input file size is between 40 GB and 50 GB:

```json
[
  {
    "name": "Mariano",
    "lastName": "Achaval"
  },
  ...
]
```

The following example is similar to the previous one but minified where the max file size is
approximately 30 GB:

```json
[{"name":"Mariano","lastName":"Achaval"},...]
```

The following example shows a minified array of numbers `1`. DataWeave supports only approximately 8
GB of such file:

```json
[1,1,1,1,1,1,...]
```

## Large Strings Management

When processing a `String` with a size larger than 1.5 MB, DataWeave automatically splits the value
in chunks to avoid out-of-memory issues. This feature works only with `JSON` and `XML` input data.

You can configure the threshold that DataWeave uses to determine when to process a string using this
splitting strategy by modifying the following system property:

```none
com.mulesoft.dw.max_memory_allocation
```

Note that using this feature has a negative impact on performance due to splitting strings and
accessing them through local storage. If your environment has enough resources to load all content
in memory, you can also disable this string management feature completely by setting the value of
the following system property to `false`:

```none
com.mulesoft.dw.buffered_char_sequence.enabled
```

## See Also

- [CSV Format](https://docs.mulesoft.com/dataweave/2.12/dataweave-formats-csv)

- [JSON Format](https://docs.mulesoft.com/dataweave/2.12/dataweave-formats-json)

- [XML Format](https://docs.mulesoft.com/dataweave/2.12/dataweave-formats-xml)

- [Supported DataWeave Formats](https://docs.mulesoft.com/dataweave/2.12/dataweave-formats)

<!-- document id=0fccc9ddfad644ad0533f8f949ab12feff6701cffa247020df2379827bbd5de0 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-indexed-readers.md -->

---
product: DataWeave
version: 2.4
---

# Indexed Readers in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

In DataWeave, some readers of input data (such as XML, JSON, and CSV) support an indexed strategy to
avoid loading the whole document in memory while still allowing random access just like in the
in-memory strategy. DataWeave uses indexed readers when the input is larger than a certain
configurable threshold or if the `indexedReader` setting is set to `true`.

The trade-off for managing files that wouldn’t fit in memory is to write the files to a temporary
file in disk and index the document content beforehand, which also takes time and disk space.

Indexed readers can process input files up to 20 GB. For bigger files use the streaming strategy,
which is faster. Despite this mode being more limited in functionality, there’s no maximum input
size limitation for streaming readers.

The actual max input file size supported is difficult to estimate because it depends on the content
of the input.

The following list shows the limits on different parts of the input file:

- Max nesting depth: `4096`

- Max individual value size: `4 GB`

- Tokens: `​​2^32-1` (approximately 4 billion)  
  A token is either a key/value pair, object-start or array-start, that limits the max input file
  size. The amount of the max input file size is irrespective of the size of each token in the file.
  The bigger your average value length, the bigger your input file size can be because what is
  important is the amount of tokens, not their size.

The following examples show input file size samples:

In this example, the max input file size is between 40 GB and 50 GB:

```json
[
  {
    "name": "Mariano",
    "lastName": "Achaval"
  },
  ...
]
```

The following example is similar to the previous one but minified where the max file size is
approximately 30 GB:

```json
[{"name":"Mariano","lastName":"Achaval"},...]
```

The following example shows a minified array of numbers `1`. DataWeave supports only approximately 8
GB of such file:

```json
[1,1,1,1,1,1,...]
```

## Large Strings Management

When processing a `String` with a size larger than 1.5 MB, DataWeave automatically splits the value
in chunks to avoid out-of-memory issues. This feature works only with `JSON` and `XML` input data.

You can configure the threshold that DataWeave uses to determine when to process a string using this
splitting strategy by modifying the following system property:

```none
com.mulesoft.dw.max_memory_allocation
```

Note that using this feature has a negative impact on performance due to splitting strings and
accessing them through local storage. If your environment has enough resources to load all content
in memory, you can also disable this string management feature completely by setting the value of
the following system property to `false`:

```none
com.mulesoft.dw.buffered_char_sequence.enabled
```

## See Also

- [CSV Format](https://docs.mulesoft.com/dataweave/2.4/dataweave-formats-csv)

- [JSON Format](https://docs.mulesoft.com/dataweave/2.4/dataweave-formats-json)

- [XML Format](https://docs.mulesoft.com/dataweave/2.4/dataweave-formats-xml)

- [Supported DataWeave Formats](https://docs.mulesoft.com/dataweave/2.4/dataweave-formats)

<!-- document id=27575b7a06fca1968c7316c3dd7659147bc0f63fc9377343d44dda06ab3ece04 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-indexed-readers.md -->

---
product: DataWeave
version: 2.6
---

# Indexed Readers in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

In DataWeave, some readers of input data (such as XML, JSON, and CSV) support an indexed strategy to
avoid loading the whole document in memory while still allowing random access just like in the
in-memory strategy. DataWeave uses indexed readers when the input is larger than a certain
configurable threshold or if the `indexedReader` setting is set to `true`.

The trade-off for managing files that wouldn’t fit in memory is to write the files to a temporary
file in disk and index the document content beforehand, which also takes time and disk space.

Indexed readers can process input files up to 20 GB. For bigger files use the streaming strategy,
which is faster. Despite this mode being more limited in functionality, there’s no maximum input
size limitation for streaming readers.

The actual max input file size supported is difficult to estimate because it depends on the content
of the input.

The following list shows the limits on different parts of the input file:

- Max nesting depth: `4096`

- Max individual value size: `4 GB`

- Tokens: `​​2^32-1` (approximately 4 billion)  
  A token is either a key/value pair, object-start or array-start, that limits the max input file
  size. The amount of the max input file size is irrespective of the size of each token in the file.
  The bigger your average value length, the bigger your input file size can be because what is
  important is the amount of tokens, not their size.

The following examples show input file size samples:

In this example, the max input file size is between 40 GB and 50 GB:

```json
[
  {
    "name": "Mariano",
    "lastName": "Achaval"
  },
  ...
]
```

The following example is similar to the previous one but minified where the max file size is
approximately 30 GB:

```json
[{"name":"Mariano","lastName":"Achaval"},...]
```

The following example shows a minified array of numbers `1`. DataWeave supports only approximately 8
GB of such file:

```json
[1,1,1,1,1,1,...]
```

## Large Strings Management

When processing a `String` with a size larger than 1.5 MB, DataWeave automatically splits the value
in chunks to avoid out-of-memory issues. This feature works only with `JSON` and `XML` input data.

You can configure the threshold that DataWeave uses to determine when to process a string using this
splitting strategy by modifying the following system property:

```none
com.mulesoft.dw.max_memory_allocation
```

Note that using this feature has a negative impact on performance due to splitting strings and
accessing them through local storage. If your environment has enough resources to load all content
in memory, you can also disable this string management feature completely by setting the value of
the following system property to `false`:

```none
com.mulesoft.dw.buffered_char_sequence.enabled
```

## See Also

- [CSV Format](https://docs.mulesoft.com/dataweave/2.6/dataweave-formats-csv)

- [JSON Format](https://docs.mulesoft.com/dataweave/2.6/dataweave-formats-json)

- [XML Format](https://docs.mulesoft.com/dataweave/2.6/dataweave-formats-xml)

- [Supported DataWeave Formats](https://docs.mulesoft.com/dataweave/2.6/dataweave-formats)

<!-- document id=7889c0b9ffada2bdc47f84e4ed0ff23a406d734869dec695d60744233c14f835 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-indexed-readers.md -->

---
product: DataWeave
version: 2.9
---

# Indexed Readers in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

In DataWeave, some readers of input data (such as XML, JSON, and CSV) support an indexed strategy to
avoid loading the whole document in memory while still allowing random access just like in the
in-memory strategy. DataWeave uses indexed readers when the input is larger than a certain
configurable threshold or if the `indexedReader` setting is set to `true`.

The trade-off for managing files that wouldn’t fit in memory is to write the files to a temporary
file in disk and index the document content beforehand, which also takes time and disk space.

Indexed readers can process input files up to 20 GB. For bigger files use the streaming strategy,
which is faster. Despite this mode being more limited in functionality, there’s no maximum input
size limitation for streaming readers.

The actual max input file size supported is difficult to estimate because it depends on the content
of the input.

The following list shows the limits on different parts of the input file:

- Max nesting depth: `4096`

- Max individual value size: `4 GB`

- Tokens: `​​2^32-1` (approximately 4 billion)  
  A token is either a key/value pair, object-start or array-start, that limits the max input file
  size. The amount of the max input file size is irrespective of the size of each token in the file.
  The bigger your average value length, the bigger your input file size can be because what is
  important is the amount of tokens, not their size.

The following examples show input file size samples:

In this example, the max input file size is between 40 GB and 50 GB:

```json
[
  {
    "name": "Mariano",
    "lastName": "Achaval"
  },
  ...
]
```

The following example is similar to the previous one but minified where the max file size is
approximately 30 GB:

```json
[{"name":"Mariano","lastName":"Achaval"},...]
```

The following example shows a minified array of numbers `1`. DataWeave supports only approximately 8
GB of such file:

```json
[1,1,1,1,1,1,...]
```

## Large Strings Management

When processing a `String` with a size larger than 1.5 MB, DataWeave automatically splits the value
in chunks to avoid out-of-memory issues. This feature works only with `JSON` and `XML` input data.

You can configure the threshold that DataWeave uses to determine when to process a string using this
splitting strategy by modifying the following system property:

```none
com.mulesoft.dw.max_memory_allocation
```

Note that using this feature has a negative impact on performance due to splitting strings and
accessing them through local storage. If your environment has enough resources to load all content
in memory, you can also disable this string management feature completely by setting the value of
the following system property to `false`:

```none
com.mulesoft.dw.buffered_char_sequence.enabled
```

## See Also

- [CSV Format](https://docs.mulesoft.com/dataweave/2.9/dataweave-formats-csv)

- [JSON Format](https://docs.mulesoft.com/dataweave/2.9/dataweave-formats-json)

- [XML Format](https://docs.mulesoft.com/dataweave/2.9/dataweave-formats-xml)

- [Supported DataWeave Formats](https://docs.mulesoft.com/dataweave/2.9/dataweave-formats)

<!-- document id=1de2ae6e4779d82e507247f7a2db4a2db2a06c4c6e1b7a7b6fb1c108cb30a942 url=/mulesoft/current/en-us/dataweave/latest/dataweave-indexed-readers.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Indexed Readers in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

In DataWeave, some readers of input data (such as XML, JSON, and CSV) support an indexed strategy to
avoid loading the whole document in memory while still allowing random access just like in the
in-memory strategy. DataWeave uses indexed readers when the input is larger than a certain
configurable threshold or if the `indexedReader` setting is set to `true`.

The trade-off for managing files that wouldn’t fit in memory is to write the files to a temporary
file in disk and index the document content beforehand, which also takes time and disk space.

Indexed readers can process input files up to 20 GB. For bigger files use the streaming strategy,
which is faster. Despite this mode being more limited in functionality, there’s no maximum input
size limitation for streaming readers.

The actual max input file size supported is difficult to estimate because it depends on the content
of the input.

The following list shows the limits on different parts of the input file:

- Max nesting depth: `4096`

- Max individual value size: `4 GB`

- Tokens: `​​2^32-1` (approximately 4 billion)  
  A token is either a key/value pair, object-start or array-start, that limits the max input file
  size. The amount of the max input file size is irrespective of the size of each token in the file.
  The bigger your average value length, the bigger your input file size can be because what is
  important is the amount of tokens, not their size.

The following examples show input file size samples:

In this example, the max input file size is between 40 GB and 50 GB:

```json
[
  {
    "name": "Mariano",
    "lastName": "Achaval"
  },
  ...
]
```

The following example is similar to the previous one but minified where the max file size is
approximately 30 GB:

```json
[{"name":"Mariano","lastName":"Achaval"},...]
```

The following example shows a minified array of numbers `1`. DataWeave supports only approximately 8
GB of such file:

```json
[1,1,1,1,1,1,...]
```

## Large Strings Management

When processing a `String` with a size larger than 1.5 MB, DataWeave automatically splits the value
in chunks to avoid out-of-memory issues. This feature works only with `JSON` and `XML` input data.

You can configure the threshold that DataWeave uses to determine when to process a string using this
splitting strategy by modifying the following system property:

```none
com.mulesoft.dw.max_memory_allocation
```

Note that using this feature has a negative impact on performance due to splitting strings and
accessing them through local storage. If your environment has enough resources to load all content
in memory, you can also disable this string management feature completely by setting the value of
the following system property to `false`:

```none
com.mulesoft.dw.buffered_char_sequence.enabled
```

## See Also

- [CSV Format](https://docs.mulesoft.com/dataweave/latest/dataweave-formats-csv)

- [JSON Format](https://docs.mulesoft.com/dataweave/latest/dataweave-formats-json)

- [XML Format](https://docs.mulesoft.com/dataweave/latest/dataweave-formats-xml)

- [Supported DataWeave Formats](https://docs.mulesoft.com/dataweave/latest/dataweave-formats)

<!-- document id=a61539f699f625ee9cb2c45618f391308d0863a19fd0189a884ec803f5de2910 url=/mulesoft/current/en-us/dataweave/2.11/dw-arrays-functions-indexof.md -->

---
product: DataWeave
version: 2.11
---

# indexOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## indexOf<T>(array: Array<T>, toFind: T): Number

Returns the index of the first occurrence of an element within the array. If the value is not found,
the function returns `-1`.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>toFind</code></p></td><td><p>The element to find.</p></td></tr></tbody></table>

### Example

This example returns the index of the matching value from the input array. The index of `"Julian"`
is `2`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var users = ["Mariano", "Leandro", "Julian"]
---
indexOf(users, "Julian")
```

#### Output

```json
2
```

<!-- document id=118bfe17535eb133054e520900cc9c17ad7113f3c7e8983dc6099d40020b5b81 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-indexof.md -->

---
product: DataWeave
version: 2.11
---

# indexOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## indexOf(array: Array, value: Any): Number

Returns the index of the _first_ occurrence of the specified element in this array, or `-1` if this
list does not contain the element.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements to search.</p></td></tr><tr><td><p><code>value</code></p></td><td><p>The value to search.</p></td></tr></tbody></table>

### Example

This example shows how `indexOf` behaves given different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  present: ["a","b","c","d"] indexOf "c",
  notPresent: ["x","w","x"] indexOf "c",
  presentMoreThanOnce: ["a","b","c","c"] indexOf "c",
}
```

#### Output

```Json
{
   "present": 2,
   "notPresent": -1,
   "presentMoreThanOnce": 2
 }
```

## indexOf(theString: String, search: String): Number

Returns the index of the **first** occurrence of the specified String in this String.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>theString</code></p></td><td><p>The string to search.</p></td></tr><tr><td><p><code>search</code></p></td><td><p>The string to find within <code>theString</code>.</p></td></tr></tbody></table>

### Example

This example shows how the `indexOf` behaves under different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  present: "abcd" indexOf "c",
  notPresent: "xyz" indexOf "c",
  presentMoreThanOnce: "abcdc" indexOf "c",
}
```

#### Output

```Json
{
   "present": 2,
   "notPresent": -1,
   "presentMoreThanOnce": 2
 }
```

## indexOf(array: Null, value: Any): Number

Helper method to make indexOf null friendly

_Introduced in DataWeave version 2.4.0._

<!-- document id=e7f3ec50eccefa1e4e2f20d26627ba8a5f865baec34a9995b22de988720c69e1 url=/mulesoft/current/en-us/dataweave/2.12/dw-arrays-functions-indexof.md -->

---
product: DataWeave
version: 2.12
---

# indexOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## indexOf<T>(array: Array<T>, toFind: T): Number

Returns the index of the first occurrence of an element within the array. If the value is not found,
the function returns `-1`.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>toFind</code></p></td><td><p>The element to find.</p></td></tr></tbody></table>

### Example

This example returns the index of the matching value from the input array. The index of `"Julian"`
is `2`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var users = ["Mariano", "Leandro", "Julian"]
---
indexOf(users, "Julian")
```

#### Output

```json
2
```

<!-- document id=48bae5ce7e0202d86f03b7def7f1447f27b8d68c395b2e974bfb4edc20d64e35 url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-indexof.md -->

---
product: DataWeave
version: 2.12
---

# indexOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## indexOf(array: Array, value: Any): Number

Returns the index of the _first_ occurrence of the specified element in this array, or `-1` if this
list does not contain the element.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements to search.</p></td></tr><tr><td><p><code>value</code></p></td><td><p>The value to search.</p></td></tr></tbody></table>

### Example

This example shows how `indexOf` behaves given different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  present: ["a","b","c","d"] indexOf "c",
  notPresent: ["x","w","x"] indexOf "c",
  presentMoreThanOnce: ["a","b","c","c"] indexOf "c",
}
```

#### Output

```Json
{
   "present": 2,
   "notPresent": -1,
   "presentMoreThanOnce": 2
 }
```

## indexOf(theString: String, search: String): Number

Returns the index of the **first** occurrence of the specified String in this String.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>theString</code></p></td><td><p>The string to search.</p></td></tr><tr><td><p><code>search</code></p></td><td><p>The string to find within <code>theString</code>.</p></td></tr></tbody></table>

### Example

This example shows how the `indexOf` behaves under different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  present: "abcd" indexOf "c",
  notPresent: "xyz" indexOf "c",
  presentMoreThanOnce: "abcdc" indexOf "c",
}
```

#### Output

```Json
{
   "present": 2,
   "notPresent": -1,
   "presentMoreThanOnce": 2
 }
```

## indexOf(array: Null, value: Any): Number

Helper method to make indexOf null friendly

_Introduced in DataWeave version 2.4.0._

<!-- document id=f7ac7cbc68d3f28cfa519190c3fa902ac112ff2abf42a659ef3091afeaa3438f url=/mulesoft/current/en-us/dataweave/2.3/dw-arrays-functions-indexof.md -->

---
product: DataWeave
version: 2.3
---

# indexOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## indexOf(Array<T>, T): Number

Returns the index of the first occurrence of an element within the array. If the value is not found,
it returns `-1`.

_Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>toFind</code></p></td><td><p>The element to find.</p></td></tr></tbody></table>

### Example

This example returns the index of the matching value from the input array. The index of `"Julian"`
is `2`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var users = ["Mariano", "Leandro", "Julian"]
---
indexOf(users, "Julian")
```

#### Output

```json
2
```

<!-- document id=eb74492550d0bbea634cb76f07513a92b32ccab9a9f4c0cbb2aad4dd57722d92 url=/mulesoft/current/en-us/dataweave/2.4/dw-arrays-functions-indexof.md -->

---
product: DataWeave
version: 2.4
---

# indexOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## indexOf<T>(array: Array<T>, toFind: T): Number

Returns the index of the first occurrence of an element within the array. If the value is not found,
the function returns `-1`.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>toFind</code></p></td><td><p>The element to find.</p></td></tr></tbody></table>

### Example

This example returns the index of the matching value from the input array. The index of `"Julian"`
is `2`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var users = ["Mariano", "Leandro", "Julian"]
---
indexOf(users, "Julian")
```

#### Output

```json
2
```

<!-- document id=121c16c0fe3d01548e52aaa08389b899d5c2b63fc699c22d02208cf7333a7615 url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-indexof.md -->

---
product: DataWeave
version: 2.4
---

# indexOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## indexOf(array: Array, value: Any): Number

Returns the index of the _first_ occurrence of the specified element in this array, or `-1` if this
list does not contain the element.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements to search.</p></td></tr><tr><td><p><code>value</code></p></td><td><p>The value to search.</p></td></tr></tbody></table>

### Example

This example shows how `indexOf` behaves given different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  present: ["a","b","c","d"] indexOf "c",
  notPresent: ["x","w","x"] indexOf "c",
  presentMoreThanOnce: ["a","b","c","c"] indexOf "c",
}
```

#### Output

```Json
{
   "present": 2,
   "notPresent": -1,
   "presentMoreThanOnce": 2
 }
```

## indexOf(theString: String, search: String): Number

Returns the index of the **first** occurrence of the specified String in this String.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>theString</code></p></td><td><p>The string to search.</p></td></tr><tr><td><p><code>search</code></p></td><td><p>The string to find within <code>theString</code>.</p></td></tr></tbody></table>

### Example

This example shows how the `indexOf` behaves under different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  present: "abcd" indexOf "c",
  notPresent: "xyz" indexOf "c",
  presentMoreThanOnce: "abcdc" indexOf "c",
}
```

#### Output

```Json
{
   "present": 2,
   "notPresent": -1,
   "presentMoreThanOnce": 2
 }
```

## indexOf(array: Null, value: Any): Number

Helper method to make indexOf null friendly

_Introduced in DataWeave version 2.4.0._

<!-- document id=8ca36dc939d204d465a489250a8b54f9b3fc01dccac7f480fec247628a58df86 url=/mulesoft/current/en-us/dataweave/2.6/dw-arrays-functions-indexof.md -->

---
product: DataWeave
version: 2.6
---

# indexOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## indexOf<T>(array: Array<T>, toFind: T): Number

Returns the index of the first occurrence of an element within the array. If the value is not found,
the function returns `-1`.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>toFind</code></p></td><td><p>The element to find.</p></td></tr></tbody></table>

### Example

This example returns the index of the matching value from the input array. The index of `"Julian"`
is `2`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var users = ["Mariano", "Leandro", "Julian"]
---
indexOf(users, "Julian")
```

#### Output

```json
2
```

<!-- document id=cdfe9f7c5e08b63b62f0acbd0894f0d6261cb87994291e43b16560b8daa8e5f7 url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-indexof.md -->

---
product: DataWeave
version: 2.6
---

# indexOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## indexOf(array: Array, value: Any): Number

Returns the index of the _first_ occurrence of the specified element in this array, or `-1` if this
list does not contain the element.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements to search.</p></td></tr><tr><td><p><code>value</code></p></td><td><p>The value to search.</p></td></tr></tbody></table>

### Example

This example shows how `indexOf` behaves given different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  present: ["a","b","c","d"] indexOf "c",
  notPresent: ["x","w","x"] indexOf "c",
  presentMoreThanOnce: ["a","b","c","c"] indexOf "c",
}
```

#### Output

```Json
{
   "present": 2,
   "notPresent": -1,
   "presentMoreThanOnce": 2
 }
```

## indexOf(theString: String, search: String): Number

Returns the index of the **first** occurrence of the specified String in this String.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>theString</code></p></td><td><p>The string to search.</p></td></tr><tr><td><p><code>search</code></p></td><td><p>The string to find within <code>theString</code>.</p></td></tr></tbody></table>

### Example

This example shows how the `indexOf` behaves under different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  present: "abcd" indexOf "c",
  notPresent: "xyz" indexOf "c",
  presentMoreThanOnce: "abcdc" indexOf "c",
}
```

#### Output

```Json
{
   "present": 2,
   "notPresent": -1,
   "presentMoreThanOnce": 2
 }
```

## indexOf(array: Null, value: Any): Number

Helper method to make indexOf null friendly

_Introduced in DataWeave version 2.4.0._

<!-- document id=64d2b991b5d669f85f77e3a44886f1218956e71822c99620dc12c8efe1629e9d url=/mulesoft/current/en-us/dataweave/2.9/dw-arrays-functions-indexof.md -->

---
product: DataWeave
version: 2.9
---

# indexOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## indexOf<T>(array: Array<T>, toFind: T): Number

Returns the index of the first occurrence of an element within the array. If the value is not found,
the function returns `-1`.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>toFind</code></p></td><td><p>The element to find.</p></td></tr></tbody></table>

### Example

This example returns the index of the matching value from the input array. The index of `"Julian"`
is `2`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var users = ["Mariano", "Leandro", "Julian"]
---
indexOf(users, "Julian")
```

#### Output

```json
2
```

<!-- document id=e72a9fb4e3852fb8107a21958dcd5437e33b76bf884ced54cafc3a3acc959226 url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-indexof.md -->

---
product: DataWeave
version: 2.9
---

# indexOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## indexOf(array: Array, value: Any): Number

Returns the index of the _first_ occurrence of the specified element in this array, or `-1` if this
list does not contain the element.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements to search.</p></td></tr><tr><td><p><code>value</code></p></td><td><p>The value to search.</p></td></tr></tbody></table>

### Example

This example shows how `indexOf` behaves given different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  present: ["a","b","c","d"] indexOf "c",
  notPresent: ["x","w","x"] indexOf "c",
  presentMoreThanOnce: ["a","b","c","c"] indexOf "c",
}
```

#### Output

```Json
{
   "present": 2,
   "notPresent": -1,
   "presentMoreThanOnce": 2
 }
```

## indexOf(theString: String, search: String): Number

Returns the index of the **first** occurrence of the specified String in this String.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>theString</code></p></td><td><p>The string to search.</p></td></tr><tr><td><p><code>search</code></p></td><td><p>The string to find within <code>theString</code>.</p></td></tr></tbody></table>

### Example

This example shows how the `indexOf` behaves under different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  present: "abcd" indexOf "c",
  notPresent: "xyz" indexOf "c",
  presentMoreThanOnce: "abcdc" indexOf "c",
}
```

#### Output

```Json
{
   "present": 2,
   "notPresent": -1,
   "presentMoreThanOnce": 2
 }
```

## indexOf(array: Null, value: Any): Number

Helper method to make indexOf null friendly

_Introduced in DataWeave version 2.4.0._

<!-- document id=d1ca67f7b75f841caf5376f912d80b01dddb03b39c428be68bf64e1c9720de98 url=/mulesoft/current/en-us/dataweave/latest/dw-arrays-functions-indexof.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# indexOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## indexOf<T>(array: Array<T>, toFind: T): Number

Returns the index of the first occurrence of an element within the array. If the value is not found,
the function returns `-1`.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>toFind</code></p></td><td><p>The element to find.</p></td></tr></tbody></table>

### Example

This example returns the index of the matching value from the input array. The index of `"Julian"`
is `2`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var users = ["Mariano", "Leandro", "Julian"]
---
indexOf(users, "Julian")
```

#### Output

```json
2
```

<!-- document id=4eb45f2dc557648008bbf1f82fb5b0ef392a2b25ce7e10c7db605683bd8d52f8 url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-indexof.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# indexOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## indexOf(array: Array, value: Any): Number

Returns the index of the _first_ occurrence of the specified element in this array, or `-1` if this
list does not contain the element.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements to search.</p></td></tr><tr><td><p><code>value</code></p></td><td><p>The value to search.</p></td></tr></tbody></table>

### Example

This example shows how `indexOf` behaves given different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  present: ["a","b","c","d"] indexOf "c",
  notPresent: ["x","w","x"] indexOf "c",
  presentMoreThanOnce: ["a","b","c","c"] indexOf "c",
}
```

#### Output

```Json
{
   "present": 2,
   "notPresent": -1,
   "presentMoreThanOnce": 2
 }
```

## indexOf(theString: String, search: String): Number

Returns the index of the **first** occurrence of the specified String in this String.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>theString</code></p></td><td><p>The string to search.</p></td></tr><tr><td><p><code>search</code></p></td><td><p>The string to find within <code>theString</code>.</p></td></tr></tbody></table>

### Example

This example shows how the `indexOf` behaves under different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  present: "abcd" indexOf "c",
  notPresent: "xyz" indexOf "c",
  presentMoreThanOnce: "abcdc" indexOf "c",
}
```

#### Output

```Json
{
   "present": 2,
   "notPresent": -1,
   "presentMoreThanOnce": 2
 }
```

## indexOf(array: Null, value: Any): Number

Helper method to make indexOf null friendly

_Introduced in DataWeave version 2.4.0._

<!-- document id=5d3df8fa5595ae31ecb0fa9cf5acdb7cd7be48ead8868aff81b4ada56beb8549 url=/mulesoft/current/en-us/dataweave/2.11/dw-arrays-functions-indexwhere.md -->

---
product: DataWeave
version: 2.11
---

# indexWhere

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## indexWhere<T>(array: Array<T>, condition: (item: T) -> Boolean): Number

Returns the index of the first occurrence of an element that matches a condition within the array.
If no element matches the condition, the function returns `-1`.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition (or expression) used to match an element in the array.</p></td></tr></tbody></table>

### Example

This example returns the index of the value from the input array that matches the condition in the
lambda expression, `(item) → item startsWith "Jul"`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var users = ["Mariano", "Leandro", "Julian"]
---
users indexWhere (item) -> item startsWith "Jul"
```

#### Output

```json
2
```

## indexWhere(array: Null, condition: (item: Nothing) -> Any): Null

Helper function that enables `indexWhere` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=4269a4e50bcf1834af7c5fe4ab98e42d4ec5ffd0451d842b0dd47faaef4e40e8 url=/mulesoft/current/en-us/dataweave/2.12/dw-arrays-functions-indexwhere.md -->

---
product: DataWeave
version: 2.12
---

# indexWhere

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## indexWhere<T>(array: Array<T>, condition: (item: T) -> Boolean): Number

Returns the index of the first occurrence of an element that matches a condition within the array.
If no element matches the condition, the function returns `-1`.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition (or expression) used to match an element in the array.</p></td></tr></tbody></table>

### Example

This example returns the index of the value from the input array that matches the condition in the
lambda expression, `(item) → item startsWith "Jul"`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var users = ["Mariano", "Leandro", "Julian"]
---
users indexWhere (item) -> item startsWith "Jul"
```

#### Output

```json
2
```

## indexWhere(array: Null, condition: (item: Nothing) -> Any): Null

Helper function that enables `indexWhere` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=11477a7ad666ba0f9292c8d80bba7f6f1fd244ac0d47860dd4ffe46fe6ea1212 url=/mulesoft/current/en-us/dataweave/2.3/dw-arrays-functions-indexwhere.md -->

---
product: DataWeave
version: 2.3
---

# indexWhere

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## indexWhere(Array<T>, (item: T) -> Boolean): Number

Returns the index of the first occurrence of an element that matches a condition within the array.

_Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition (or expression) used to match an element in the array.</p></td></tr></tbody></table>

### Example

This example returns the index of the value from the input array that matches the condition in the
lambda expression, `(item) → item startsWith "Jul"`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var users = ["Mariano", "Leandro", "Julian"]
---
users indexWhere (item) -> item startsWith "Jul"
```

#### Output

```json
2
```

<!-- document id=2e5cb1fb200f8c1dc5c9580a4cc8e0a414c3bba8049d316652dee1a3d80cc0c8 url=/mulesoft/current/en-us/dataweave/2.4/dw-arrays-functions-indexwhere.md -->

---
product: DataWeave
version: 2.4
---

# indexWhere

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## indexWhere<T>(array: Array<T>, condition: (item: T) -> Boolean): Number

Returns the index of the first occurrence of an element that matches a condition within the array.
If no element matches the condition, the function returns `-1`.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition (or expression) used to match an element in the array.</p></td></tr></tbody></table>

### Example

This example returns the index of the value from the input array that matches the condition in the
lambda expression, `(item) → item startsWith "Jul"`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var users = ["Mariano", "Leandro", "Julian"]
---
users indexWhere (item) -> item startsWith "Jul"
```

#### Output

```json
2
```

## indexWhere(array: Null, condition: (item: Nothing) -> Any): Null

Helper function that enables `indexWhere` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=12ab3e9320f21f10a879cea297f92ef779e1570b998d0b61f0c2fc0dceb65871 url=/mulesoft/current/en-us/dataweave/2.6/dw-arrays-functions-indexwhere.md -->

---
product: DataWeave
version: 2.6
---

# indexWhere

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## indexWhere<T>(array: Array<T>, condition: (item: T) -> Boolean): Number

Returns the index of the first occurrence of an element that matches a condition within the array.
If no element matches the condition, the function returns `-1`.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition (or expression) used to match an element in the array.</p></td></tr></tbody></table>

### Example

This example returns the index of the value from the input array that matches the condition in the
lambda expression, `(item) → item startsWith "Jul"`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var users = ["Mariano", "Leandro", "Julian"]
---
users indexWhere (item) -> item startsWith "Jul"
```

#### Output

```json
2
```

## indexWhere(array: Null, condition: (item: Nothing) -> Any): Null

Helper function that enables `indexWhere` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=3390cc2fe33421ba8624403ba640ee93e349820fb8407324d916c80e8c64b001 url=/mulesoft/current/en-us/dataweave/2.9/dw-arrays-functions-indexwhere.md -->

---
product: DataWeave
version: 2.9
---

# indexWhere

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## indexWhere<T>(array: Array<T>, condition: (item: T) -> Boolean): Number

Returns the index of the first occurrence of an element that matches a condition within the array.
If no element matches the condition, the function returns `-1`.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition (or expression) used to match an element in the array.</p></td></tr></tbody></table>

### Example

This example returns the index of the value from the input array that matches the condition in the
lambda expression, `(item) → item startsWith "Jul"`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var users = ["Mariano", "Leandro", "Julian"]
---
users indexWhere (item) -> item startsWith "Jul"
```

#### Output

```json
2
```

## indexWhere(array: Null, condition: (item: Nothing) -> Any): Null

Helper function that enables `indexWhere` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=b69fdcf15862056b8c3fd60ee19d43a877e99a30838a08add1386cfd5ab34d23 url=/mulesoft/current/en-us/dataweave/latest/dw-arrays-functions-indexwhere.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# indexWhere

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## indexWhere<T>(array: Array<T>, condition: (item: T) -> Boolean): Number

Returns the index of the first occurrence of an element that matches a condition within the array.
If no element matches the condition, the function returns `-1`.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition (or expression) used to match an element in the array.</p></td></tr></tbody></table>

### Example

This example returns the index of the value from the input array that matches the condition in the
lambda expression, `(item) → item startsWith "Jul"`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var users = ["Mariano", "Leandro", "Julian"]
---
users indexWhere (item) -> item startsWith "Jul"
```

#### Output

```json
2
```

## indexWhere(array: Null, condition: (item: Nothing) -> Any): Null

Helper function that enables `indexWhere` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=86a66a5bc4cb04d2bbf3ac2d67735b99d9c8a87bc889d85bb0008121efc41852 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook-insert-attribute.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, transform, transformer, format, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Insert Attributes to an XML Tag

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example uses `@(key:value)` syntax (for example, `@(loc: "US")`) to inject attributes
to XML tags. The example populates the `title` element with two attributes and each of the `author`
elements with one attribute.

It uses these functions:

- `mapObject` to iterate over each of the books in the input XML, defined in the variable `myInput`.

- `map` to iterate over the `author` elements in each book.

DataWeave Script:

```dataweave
%dw 2.0
var myInput = read('<bookstore>
  <book>
    <title>Everyday Italian</title>
    <year>2005</year>
    <price>30</price>
    <author>Giada De Laurentiis</author>
  </book>
  <book>
    <title>Harry Potter</title>
    <year>2005</year>
    <price>29.99</price>
    <author>J K. Rowling</author>
  </book>
  <book>
    <title>XQuery Kick Start</title>
    <year>2003</year>
    <price>49.99</price>
    <author>James McGovern</author>
    <author>Per Bothner</author>
    <author>Kurt Cagle</author>
    <author>James Linn</author>
    <author>Vaidyanathan Nagarajan</author>
  </book>
  <book>
    <title>Learning XML</title>
    <year>2003</year>
    <price>39.95</price>
    <author>Erik T. Ray</author>
  </book>
</bookstore>', 'application/xml')
output application/xml
---
bookstore: myInput.bookstore mapObject (book) -> {
      book : {
      title @(lang: "en", year: book.year): book.title,
      price: book.price,
      (book.*author map
      author @(loc: "US"): $)
    }
}
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<bookstore>
  <book>
    <title lang="en" year="2005">Everyday Italian</title>
    <price>30</price>
    <author loc="US">Giada De Laurentiis</author>
  </book>
  <book>
    <title lang="en" year="2005">Harry Potter</title>
    <price>29.99</price>
    <author loc="US">J K. Rowling</author>
  </book>
  <book>
    <title lang="en" year="2003">XQuery Kick Start</title>
    <price>49.99</price>
    <author loc="US">James McGovern</author>
    <author loc="US">Per Bothner</author>
    <author loc="US">Kurt Cagle</author>
    <author loc="US">James Linn</author>
    <author loc="US">Vaidyanathan Nagarajan</author>
  </book>
  <book>
    <title lang="en" year="2003">Learning XML</title>
    <price>39.95</price>
    <author loc="US">Erik T. Ray</author>
  </book>
</bookstore>
```

## Related Examples

- [Output Self-closing XML tags](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-output-self-closing-xml-tags)

- [Remove Specified XML Attributes](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-remove-certain-xml-attributes)

- [Include XML Namespaces](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-include-xml-namespaces)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.11/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook)

<!-- document id=9ba71105be3b08f12c97221d08a7421f2353563d72b75e187f0ff2d0385f6a9e url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook-insert-attribute.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, transform, transformer, format, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Insert Attributes to an XML Tag

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example uses `@(key:value)` syntax (for example, `@(loc: "US")`) to inject attributes
to XML tags. The example populates the `title` element with two attributes and each of the `author`
elements with one attribute.

It uses these functions:

- `mapObject` to iterate over each of the books in the input XML, defined in the variable `myInput`.

- `map` to iterate over the `author` elements in each book.

DataWeave Script:

```dataweave
%dw 2.0
var myInput = read('<bookstore>
  <book>
    <title>Everyday Italian</title>
    <year>2005</year>
    <price>30</price>
    <author>Giada De Laurentiis</author>
  </book>
  <book>
    <title>Harry Potter</title>
    <year>2005</year>
    <price>29.99</price>
    <author>J K. Rowling</author>
  </book>
  <book>
    <title>XQuery Kick Start</title>
    <year>2003</year>
    <price>49.99</price>
    <author>James McGovern</author>
    <author>Per Bothner</author>
    <author>Kurt Cagle</author>
    <author>James Linn</author>
    <author>Vaidyanathan Nagarajan</author>
  </book>
  <book>
    <title>Learning XML</title>
    <year>2003</year>
    <price>39.95</price>
    <author>Erik T. Ray</author>
  </book>
</bookstore>', 'application/xml')
output application/xml
---
bookstore: myInput.bookstore mapObject (book) -> {
      book : {
      title @(lang: "en", year: book.year): book.title,
      price: book.price,
      (book.*author map
      author @(loc: "US"): $)
    }
}
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<bookstore>
  <book>
    <title lang="en" year="2005">Everyday Italian</title>
    <price>30</price>
    <author loc="US">Giada De Laurentiis</author>
  </book>
  <book>
    <title lang="en" year="2005">Harry Potter</title>
    <price>29.99</price>
    <author loc="US">J K. Rowling</author>
  </book>
  <book>
    <title lang="en" year="2003">XQuery Kick Start</title>
    <price>49.99</price>
    <author loc="US">James McGovern</author>
    <author loc="US">Per Bothner</author>
    <author loc="US">Kurt Cagle</author>
    <author loc="US">James Linn</author>
    <author loc="US">Vaidyanathan Nagarajan</author>
  </book>
  <book>
    <title lang="en" year="2003">Learning XML</title>
    <price>39.95</price>
    <author loc="US">Erik T. Ray</author>
  </book>
</bookstore>
```

## Related Examples

- [Output Self-closing XML tags](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-output-self-closing-xml-tags)

- [Remove Specified XML Attributes](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-remove-certain-xml-attributes)

- [Include XML Namespaces](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-include-xml-namespaces)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.12/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook)

<!-- document id=b8d503854494845ffcf88a5b4c3662e098555c3818e3a375d494a6848902b25a url=/mulesoft/current/en-us/dataweave/2.3/dataweave-cookbook-insert-attribute.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, transform, transformer, format, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Insert Attributes to an XML Tag

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example uses `@(key:value)` syntax (for example, `@(loc: "US")`) to inject attributes
to XML tags. The example populates the `title` element with two attributes and each of the `author`
elements with one attribute.

It uses these functions:

- `mapObject` to iterate over each of the books in the input XML, defined in the variable `myInput`.

- `map` to iterate over the `author` elements in each book.

DataWeave Script:

```dataweave
%dw 2.0
var myInput = read('<bookstore>
  <book>
    <title>Everyday Italian</title>
    <year>2005</year>
    <price>30</price>
    <author>Giada De Laurentiis</author>
  </book>
  <book>
    <title>Harry Potter</title>
    <year>2005</year>
    <price>29.99</price>
    <author>J K. Rowling</author>
  </book>
  <book>
    <title>XQuery Kick Start</title>
    <year>2003</year>
    <price>49.99</price>
    <author>James McGovern</author>
    <author>Per Bothner</author>
    <author>Kurt Cagle</author>
    <author>James Linn</author>
    <author>Vaidyanathan Nagarajan</author>
  </book>
  <book>
    <title>Learning XML</title>
    <year>2003</year>
    <price>39.95</price>
    <author>Erik T. Ray</author>
  </book>
</bookstore>', 'application/xml')
output application/xml
---
bookstore: myInput.bookstore mapObject (book) -> {
      book : {
      title @(lang: "en", year: book.year): book.title,
      price: book.price,
      (book.*author map
      author @(loc: "US"): $)
    }
}
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<bookstore>
  <book>
    <title lang="en" year="2005">Everyday Italian</title>
    <price>30</price>
    <author loc="US">Giada De Laurentiis</author>
  </book>
  <book>
    <title lang="en" year="2005">Harry Potter</title>
    <price>29.99</price>
    <author loc="US">J K. Rowling</author>
  </book>
  <book>
    <title lang="en" year="2003">XQuery Kick Start</title>
    <price>49.99</price>
    <author loc="US">James McGovern</author>
    <author loc="US">Per Bothner</author>
    <author loc="US">Kurt Cagle</author>
    <author loc="US">James Linn</author>
    <author loc="US">Vaidyanathan Nagarajan</author>
  </book>
  <book>
    <title lang="en" year="2003">Learning XML</title>
    <price>39.95</price>
    <author loc="US">Erik T. Ray</author>
  </book>
</bookstore>
```

## Related Examples

- [Output Self-closing XML tags](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-output-self-closing-xml-tags)

- [Remove Specified XML Attributes](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-remove-certain-xml-attributes)

- [Include XML Namespaces](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-include-xml-namespaces)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.3/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook)

<!-- document id=132240ee07318b5b590de31c497c35a3f8d55089bd163ccd9ef8042091b91fb8 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook-insert-attribute.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, transform, transformer, format, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Insert Attributes to an XML Tag

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example uses `@(key:value)` syntax (for example, `@(loc: "US")`) to inject attributes
to XML tags. The example populates the `title` element with two attributes and each of the `author`
elements with one attribute.

It uses these functions:

- `mapObject` to iterate over each of the books in the input XML, defined in the variable `myInput`.

- `map` to iterate over the `author` elements in each book.

DataWeave Script:

```dataweave
%dw 2.0
var myInput = read('<bookstore>
  <book>
    <title>Everyday Italian</title>
    <year>2005</year>
    <price>30</price>
    <author>Giada De Laurentiis</author>
  </book>
  <book>
    <title>Harry Potter</title>
    <year>2005</year>
    <price>29.99</price>
    <author>J K. Rowling</author>
  </book>
  <book>
    <title>XQuery Kick Start</title>
    <year>2003</year>
    <price>49.99</price>
    <author>James McGovern</author>
    <author>Per Bothner</author>
    <author>Kurt Cagle</author>
    <author>James Linn</author>
    <author>Vaidyanathan Nagarajan</author>
  </book>
  <book>
    <title>Learning XML</title>
    <year>2003</year>
    <price>39.95</price>
    <author>Erik T. Ray</author>
  </book>
</bookstore>', 'application/xml')
output application/xml
---
bookstore: myInput.bookstore mapObject (book) -> {
      book : {
      title @(lang: "en", year: book.year): book.title,
      price: book.price,
      (book.*author map
      author @(loc: "US"): $)
    }
}
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<bookstore>
  <book>
    <title lang="en" year="2005">Everyday Italian</title>
    <price>30</price>
    <author loc="US">Giada De Laurentiis</author>
  </book>
  <book>
    <title lang="en" year="2005">Harry Potter</title>
    <price>29.99</price>
    <author loc="US">J K. Rowling</author>
  </book>
  <book>
    <title lang="en" year="2003">XQuery Kick Start</title>
    <price>49.99</price>
    <author loc="US">James McGovern</author>
    <author loc="US">Per Bothner</author>
    <author loc="US">Kurt Cagle</author>
    <author loc="US">James Linn</author>
    <author loc="US">Vaidyanathan Nagarajan</author>
  </book>
  <book>
    <title lang="en" year="2003">Learning XML</title>
    <price>39.95</price>
    <author loc="US">Erik T. Ray</author>
  </book>
</bookstore>
```

## Related Examples

- [Output Self-closing XML tags](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-output-self-closing-xml-tags)

- [Remove Specified XML Attributes](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-remove-certain-xml-attributes)

- [Include XML Namespaces](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-include-xml-namespaces)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.4/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook)

<!-- document id=f39005f3dd22ecee614ae06b2a1efbfe2bc7d648ded677d36fdedf8e6154bdb3 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook-insert-attribute.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, transform, transformer, format, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Insert Attributes to an XML Tag

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example uses `@(key:value)` syntax (for example, `@(loc: "US")`) to inject attributes
to XML tags. The example populates the `title` element with two attributes and each of the `author`
elements with one attribute.

It uses these functions:

- `mapObject` to iterate over each of the books in the input XML, defined in the variable `myInput`.

- `map` to iterate over the `author` elements in each book.

DataWeave Script:

```dataweave
%dw 2.0
var myInput = read('<bookstore>
  <book>
    <title>Everyday Italian</title>
    <year>2005</year>
    <price>30</price>
    <author>Giada De Laurentiis</author>
  </book>
  <book>
    <title>Harry Potter</title>
    <year>2005</year>
    <price>29.99</price>
    <author>J K. Rowling</author>
  </book>
  <book>
    <title>XQuery Kick Start</title>
    <year>2003</year>
    <price>49.99</price>
    <author>James McGovern</author>
    <author>Per Bothner</author>
    <author>Kurt Cagle</author>
    <author>James Linn</author>
    <author>Vaidyanathan Nagarajan</author>
  </book>
  <book>
    <title>Learning XML</title>
    <year>2003</year>
    <price>39.95</price>
    <author>Erik T. Ray</author>
  </book>
</bookstore>', 'application/xml')
output application/xml
---
bookstore: myInput.bookstore mapObject (book) -> {
      book : {
      title @(lang: "en", year: book.year): book.title,
      price: book.price,
      (book.*author map
      author @(loc: "US"): $)
    }
}
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<bookstore>
  <book>
    <title lang="en" year="2005">Everyday Italian</title>
    <price>30</price>
    <author loc="US">Giada De Laurentiis</author>
  </book>
  <book>
    <title lang="en" year="2005">Harry Potter</title>
    <price>29.99</price>
    <author loc="US">J K. Rowling</author>
  </book>
  <book>
    <title lang="en" year="2003">XQuery Kick Start</title>
    <price>49.99</price>
    <author loc="US">James McGovern</author>
    <author loc="US">Per Bothner</author>
    <author loc="US">Kurt Cagle</author>
    <author loc="US">James Linn</author>
    <author loc="US">Vaidyanathan Nagarajan</author>
  </book>
  <book>
    <title lang="en" year="2003">Learning XML</title>
    <price>39.95</price>
    <author loc="US">Erik T. Ray</author>
  </book>
</bookstore>
```

## Related Examples

- [Output Self-closing XML tags](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-output-self-closing-xml-tags)

- [Remove Specified XML Attributes](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-remove-certain-xml-attributes)

- [Include XML Namespaces](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-include-xml-namespaces)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.6/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook)

<!-- document id=d5a55aab8aa185452e5feea4b2c68169b172b3817a175e8f3d2d8d973df1b48f url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook-insert-attribute.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, transform, transformer, format, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Insert Attributes to an XML Tag

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example uses `@(key:value)` syntax (for example, `@(loc: "US")`) to inject attributes
to XML tags. The example populates the `title` element with two attributes and each of the `author`
elements with one attribute.

It uses these functions:

- `mapObject` to iterate over each of the books in the input XML, defined in the variable `myInput`.

- `map` to iterate over the `author` elements in each book.

DataWeave Script:

```dataweave
%dw 2.0
var myInput = read('<bookstore>
  <book>
    <title>Everyday Italian</title>
    <year>2005</year>
    <price>30</price>
    <author>Giada De Laurentiis</author>
  </book>
  <book>
    <title>Harry Potter</title>
    <year>2005</year>
    <price>29.99</price>
    <author>J K. Rowling</author>
  </book>
  <book>
    <title>XQuery Kick Start</title>
    <year>2003</year>
    <price>49.99</price>
    <author>James McGovern</author>
    <author>Per Bothner</author>
    <author>Kurt Cagle</author>
    <author>James Linn</author>
    <author>Vaidyanathan Nagarajan</author>
  </book>
  <book>
    <title>Learning XML</title>
    <year>2003</year>
    <price>39.95</price>
    <author>Erik T. Ray</author>
  </book>
</bookstore>', 'application/xml')
output application/xml
---
bookstore: myInput.bookstore mapObject (book) -> {
      book : {
      title @(lang: "en", year: book.year): book.title,
      price: book.price,
      (book.*author map
      author @(loc: "US"): $)
    }
}
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<bookstore>
  <book>
    <title lang="en" year="2005">Everyday Italian</title>
    <price>30</price>
    <author loc="US">Giada De Laurentiis</author>
  </book>
  <book>
    <title lang="en" year="2005">Harry Potter</title>
    <price>29.99</price>
    <author loc="US">J K. Rowling</author>
  </book>
  <book>
    <title lang="en" year="2003">XQuery Kick Start</title>
    <price>49.99</price>
    <author loc="US">James McGovern</author>
    <author loc="US">Per Bothner</author>
    <author loc="US">Kurt Cagle</author>
    <author loc="US">James Linn</author>
    <author loc="US">Vaidyanathan Nagarajan</author>
  </book>
  <book>
    <title lang="en" year="2003">Learning XML</title>
    <price>39.95</price>
    <author loc="US">Erik T. Ray</author>
  </book>
</bookstore>
```

## Related Examples

- [Output Self-closing XML tags](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-output-self-closing-xml-tags)

- [Remove Specified XML Attributes](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-remove-certain-xml-attributes)

- [Include XML Namespaces](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-include-xml-namespaces)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.9/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook)

<!-- document id=d22b1c2a9395c045698dafd6bd8b99e8e29b66176038b2b346a16df596fcb93a url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook-insert-attribute.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, transform, transformer, format, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Insert Attributes to an XML Tag

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example uses `@(key:value)` syntax (for example, `@(loc: "US")`) to inject attributes
to XML tags. The example populates the `title` element with two attributes and each of the `author`
elements with one attribute.

It uses these functions:

- `mapObject` to iterate over each of the books in the input XML, defined in the variable `myInput`.

- `map` to iterate over the `author` elements in each book.

DataWeave Script:

```dataweave
%dw 2.0
var myInput = read('<bookstore>
  <book>
    <title>Everyday Italian</title>
    <year>2005</year>
    <price>30</price>
    <author>Giada De Laurentiis</author>
  </book>
  <book>
    <title>Harry Potter</title>
    <year>2005</year>
    <price>29.99</price>
    <author>J K. Rowling</author>
  </book>
  <book>
    <title>XQuery Kick Start</title>
    <year>2003</year>
    <price>49.99</price>
    <author>James McGovern</author>
    <author>Per Bothner</author>
    <author>Kurt Cagle</author>
    <author>James Linn</author>
    <author>Vaidyanathan Nagarajan</author>
  </book>
  <book>
    <title>Learning XML</title>
    <year>2003</year>
    <price>39.95</price>
    <author>Erik T. Ray</author>
  </book>
</bookstore>', 'application/xml')
output application/xml
---
bookstore: myInput.bookstore mapObject (book) -> {
      book : {
      title @(lang: "en", year: book.year): book.title,
      price: book.price,
      (book.*author map
      author @(loc: "US"): $)
    }
}
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<bookstore>
  <book>
    <title lang="en" year="2005">Everyday Italian</title>
    <price>30</price>
    <author loc="US">Giada De Laurentiis</author>
  </book>
  <book>
    <title lang="en" year="2005">Harry Potter</title>
    <price>29.99</price>
    <author loc="US">J K. Rowling</author>
  </book>
  <book>
    <title lang="en" year="2003">XQuery Kick Start</title>
    <price>49.99</price>
    <author loc="US">James McGovern</author>
    <author loc="US">Per Bothner</author>
    <author loc="US">Kurt Cagle</author>
    <author loc="US">James Linn</author>
    <author loc="US">Vaidyanathan Nagarajan</author>
  </book>
  <book>
    <title lang="en" year="2003">Learning XML</title>
    <price>39.95</price>
    <author loc="US">Erik T. Ray</author>
  </book>
</bookstore>
```

## Related Examples

- [Output Self-closing XML tags](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-output-self-closing-xml-tags)

- [Remove Specified XML Attributes](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-remove-certain-xml-attributes)

- [Include XML Namespaces](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-include-xml-namespaces)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook)

<!-- document id=a5053067549d149bc4e8ffd09781a5cb72688f722d886e25a94817736234d292 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-extension-plugin.md -->

---
product: DataWeave
version: 2.11
---

# Installing and Using the DataWeave Extension

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Install and use DataWeave extension in Visual Studio Code (DataWeave extension) to develop, preview,
test, and deploy custom mappings and modules into libraries in a DataWeave project. The extension
also enables you to preview transformations similar to those you perform in the
[DataWeave Playground](https://dataweave.mulesoft.com/learn/).

## Before You Begin

Before installing the DataWeave extension to Visual Studio Code, you must:

- Install AdoptOpenJDK

- Install Apache Maven (3.6.3 minimum)

- Install Microsoft Visual Studio Code for your specific operating system

> [!NOTE] If you have any other prior extensions for DataWeave, whether experimental or from a third
> party, uninstall them.

## Install the DataWeave Extension

To install the extension:

1.  Open Visual Studio Code.

2.  In the **EXTENSIONS** tab, type `dataweave` to search the extension in the marketplace.

3.  Select **Anypoint Code Builder - DataWeave Extension** from the search results.

4.  Click **Install**.

    ![DataWeave extension installation](/mulesoft/current/en-us/dataweave/2.11/_images/dataweave-extension-plugin-install.png)

5.  After the installation finishes, restart Visual Studio Code.

## Developing DataWeave Libraries

A DataWeave library is a reusable package of DataWeave module and mapping files, and resource files,
such as JSON, XML, and CSV. To develop DataWeave libraries, first create a new DataWeave project in
Visual Studio Code where you then create, preview, and test custom mappings and modules.

If you want to try out your mapping without creating a DataWeave project, you can either open your
`.dwl` mapping file directly in Visual Studio Code or create a new one and use
[sample data](#sample-data) and [scenarios](#scenarios).

### Understanding the DataWeave Project Structure

DataWeave projects use Apache Maven to build and declare project dependencies. The following diagram
shows the DataWeave project structure:

```none
├── src
│   ├── main
│   │   ├── dw // Put your DataWeave mappings and module files here
│   │   │   ├── MyMapping.dwl
|   |   |   └── MyModule.dwl
│   │   └── resources
│   └── test
│       ├── dw
│       │   └── MyModuleTest.dwl  //Unit tests for the functions in your module
│       │   └── MyMappingTest.dwl //Integration test for your mapping using the saved scenarios
│       ├── resources
│       │       └── MyMapping //Contains the different scenarios for your mapping
│       │           ├── default
│       │           │   └── inputs
│       │           │       └── payload.json //[Sample data](#sample-data) for your mappings
│       │           └── SavedTestScenario //Scenario used for the integration test
├── pom.xml
```

### Create a DataWeave Project

To create a new project:

1.  Open Visual Studio Code.

2.  Click **View > Command Palette**.

3.  In the search bar, type `dataweave`.

4.  Select **DataWeave: Create New Library Project**.

    ![Command Palette with DataWeave: Create New Library Project option selected](/mulesoft/current/en-us/dataweave/2.11/_images/dataweave-extension-new-project.png)

5.  Follow prompts to complete an initial configuration for your project:

    1.  **Organization ID** (Group ID)

    2.  **Artifact ID**

    3.  **Version**

    4.  **Project name**

6.  Choose a directory folder for your new project.

7.  Select **OK**.

8.  When prompted, select **Yes** or **No** whether you want to open the project in a new Visual
    Studio Code window.

The following image shows a new DataWeave project in Visual Studio Code:

![DataWeave project example window](/mulesoft/current/en-us/dataweave/2.11/_images/dataweave-extension-new-project-sample.png)

When creating a DataWeave project, the DataWeave extension requires all dependencies to be loaded
and indexed before it can search the libraries and make them available in your project. Visual
Studio Code provides a notification bar at the bottom of the screen editor that shows when the
dependencies are loading and when the indexing is complete.

![Dependencies loading and indexing](/mulesoft/current/en-us/dataweave/2.11/_images/dataweave-extension-dependencies.png)

## Create a DataWeave Module

DataWeave modules are `.dwl` files that define functions, variables, types, and namespaces. These
files cannot contain output directives, body expressions, or `---` separators between header and
body sections. A DataWeave module enables you to share all the content defined in the `.dwl` file
for reuse.

To create a new DataWeave module:

1.  In Visual Studio Code, click **View > Command Palette**.

2.  In the search bar, type `dataweave`.

3.  Select **DataWeave: Create New Module**.

    ![Command Palette with DataWeave: Create new module option selected](/mulesoft/current/en-us/dataweave/2.11/_images/dataweave-extension-createmodule.png)

4.  Add a name for the new module `dwl` file and press enter.  
    This creates a new module `.dwl` file under the `src/main/dw` folder.

## Preview a DataWeave Module

For a better development experience, you can use the _preview_ view to develop your module’s
functions. The _preview_ view lets you get instant feedback on how a mapping file is working by
previewing its output. Use this view to develop the module’s functions by creating a DataWeave
mapping inside the `src/test/dw` folder that imports your functions and calls them to check how
they’re currently working.

To preview the module functionality, follow these steps:

1.  In Visual Studio Code, open your DataWeave project.

2.  Navigate to the `src/main/dw` folder.

3.  Select your module `.dwl` file.

4.  Click the **Create Integration Mapping** button located at the top of your module `.dwl` file.  
    This create a mapping file under the `src/test/dw` folder to test your module, which isn’t meant
    to be shared or reused.

![Create Integration Mapping button above the .dwl file](/mulesoft/current/en-us/dataweave/2.11/_images/dataweave-extension-preview-1.png)

5.  Either preview the module function by one of these options:

    - Click the **DataWeave: Run Preview** button (arrow icon) at the top right corner of your
      module `.dwl` file.

      ![DataWeave: Run Preview button](/mulesoft/current/en-us/dataweave/2.11/_images/dataweave-extension-preview-2.png)

    - Right-click the editor and select **DataWeave: Enable AutoPreview** to run it on every file
      change.

      ![DataWeave: Enable AutoPreview option](/mulesoft/current/en-us/dataweave/2.11/_images/dataweave-extension-preview-3.png)

## Test a DataWeave Module

There’re two ways to test your module:

- By running a unit test

- By creating a test mapping located in your `src/test/dw` folder to avoid exposing the test to
  consumers of your module

The tests use functions of the modules `dw::test::Tests` and `dw::test::Asserts` provided by the
artifact `org.mule.weave:data-weave-testing-framework` of the
[DataWeave Testing Framework](https://docs.mulesoft.com/dataweave/2.11/dataweave-testing-framework).

To generate a unit test for a DataWeave module, follow these steps:

1.  In Visual Studio Code, open your DataWeave project.

2.  Navigate to the `src/main/dw` folder.

3.  Select your module `.dwl` file.

4.  In your module `.dwl` file, click the **Add Unit Test** button located above your function.

    ![MyModule.dwl file showing the function and the Add Unit Test button](/mulesoft/current/en-us/dataweave/2.11/_images/dataweave-extension-testmodule-1.png)

This behavior generates:

- A new `.dwl` test file in `src/test/dw` that describes test cases and tests suites for the module.

  - A test case is a single test with the evaluation and assertion of the result.

  - A test suite groups tests with a name that better describes the intention of some related cases.

    The test file defines a test case for the function that you call with specific arguments and use
    to make assertions over the output.

- A new test case within a test suite for the function. If not present, the test suite is also
  created.

![MyModuleTest.dwl file in the src/test/dw folder](/mulesoft/current/en-us/dataweave/2.11/_images/dataweave-extension-testmodule-2.png)

To run the test:

1.  In Visual Studio Code, go to the **TESTING** view.

2.  Select the dropdown arrows of your module test file.

3.  Click the **Run Test** arrow button.

![MyModuleTest file in the TESTING TAB and Run Test button](/mulesoft/current/en-us/dataweave/2.11/_images/dataweave-extension-testmodule-3.png)

## Create a DataWeave Mapping

A DataWeave mapping is a `.dwl` file that enables you to map and connect to anything, regardless of
data type or structure. As when using a DataWeave module, you can use a mapping to define functions,
variables, types, and namespaces, but you can additionally specify a body section after the
separator `---`.

Unlike a DataWeave module file, a DataWeave mapping file is an executable unit that enables you to
transform zero or more inputs into a single output. Using the DataWeave extension, you can develop
these files to create reusable assets that you can deploy and share with others.

To create a new DataWeave mapping, follow these steps:

1.  In Visual Studio Code, click **View > Command Palette**.

2.  In the search bar, type `dataweave`.

3.  Select **DataWeave: Create New Mapping**.

    ![Command Palette with DataWeave: Create new mapping selected](/mulesoft/current/en-us/dataweave/2.11/_images/dataweave-extension-createmapping.png)

4.  Add a name for the new mapping `dwl` file and press enter.  
    This creates a new mapping `.dwl` file under the `src/main/dw` folder.

### Define Sample Data for DataWeave Mappings

Generate multiple sample data inputs for your mapping by clicking the **Define Sample Data** button
at the top of your mapping `.dwl` file. Sample data is a key part of DataWeave project development
to run your mappings.

To define sample data, follow these steps:

1.  In Visual Studio Code, open your DataWeave project.

2.  Navigate to the `src/main/dw` folder.

3.  Select your mapping `.dwl` file.

4.  Click the **Define Sample Data** button located above your mapping `.dwl` file.

    ![MyMapping.dwl file with Define Sample Data button](/mulesoft/current/en-us/dataweave/2.11/_images/dataweave-extension-sampledata-1.png)

5.  Specify the name for the sample data file and press enter.

Using sample data generates a DataWeave _scenario_ that contains all the resources required to run
the mapping in the context of that scenario.

![Generated new sample data payload.json file as input for the MyMapping.dwl file](/mulesoft/current/en-us/dataweave/2.11/_images/dataweave-extension-sampledata-2.png)

## Understanding DataWeave Scenarios

A DataWeave _scenario_ is a group of inputs and outputs that you can inject into your mapping either
to try out in the **Preview Output** view or to test your mapping using the input to evaluate it and
compare its output with the desired saved output of your scenario. Scenarios also provide
autocompletion based on the input structures.

These scenarios and their resources live in the `src/test/resources` folder and have the following
structure:

```none
├── src/test/resources
│       └── MyMapping //Contains the different scenarios for your mapping called "MyMapping"
│           ├── default //Name of your scenario
│           │   └── inputs //Folder where all of your inputs live
│           │   │   └── payload.json //Input for your mapping (you can use it in your script, naming it to be the same as the name of the file without the file's extension)
│           │   │   └── vars //Folder that represents a name for your input variable in your script: in this case vars
│           │   │       └── test.json //Input for your mapping (you can use it in your script, calling it vars.test)
│           │   └── out.json // Expected output of your mapping running against your inputs (only present when testing)
│           └── SavedTestScenario //Another scenario used for the integration test
```

### Using the DataWeave Scenarios View

The **DATAWEAVE SCENARIOS** view shows the available scenarios for the `.dwl` file. In this view,
you can add, remove, or set the active scenario that is used for your preview execution, or you can
choose that the values be autocompleted.

![DataWeave Scenarios view in Visual Studio Code](/mulesoft/current/en-us/dataweave/2.11/_images/dataweave-extension-dataweavescenario.png)

### Using Reader Properties for Inputs

If you want to set different reader properties to the inputs you use, create a properties file with
the suffix `{fileName}-config.properties` in the same directory of your input. For example, if your
input is called `payload.csv` then create a `payload-config.properties` file that contains all the
reader properties required to run your scenario. Creating the properties file also applies while
testing your DataWeave mappings.

## Preview a DataWeave Mapping

After you define sample data, get feedback on how your mapping is working by previewing the output.

1.  In Visual Studio Code, open your DataWeave project.

2.  Navigate to the `src/main/dw` folder.

3.  Select your module `.dwl` file.

4.  Either preview the mapping function by one of these options:

    - Click the **DataWeave: Run Preview** button (arrow icon) at the top right corner of your
      mapping `.dwl` file.

    - Right-click the editor and select **DataWeave: Enable AutoPreview** to run it on every file
      change.

## Run and Debug a DataWeave Mapping

Run and debug a DataWeave mapping to be guided through all of the mapping elements, which you can
then fix or otherwise update. You can also set breakpoints to stop evaluating expressions and use
all the debugging capabilities that Visual Studio Code provides. Debugging works on mapping tests as
well.

To run and debug a DataWeave mapping, follow these steps:

1.  In Visual Studio Code, open your DataWeave project.

2.  Navigate to the `src/main/dw` folder.

3.  Select your mapping `.dwl` file.

4.  Click the **Run Mapping** button located at the top of your `.dwl` file.

    ![MyMapping.dwl and Run Mapping button](/mulesoft/current/en-us/dataweave/2.11/_images/dataweave-extension-runmapping.png)

## Test a DataWeave Mapping

To test a DataWeave mapping, click the **Dataweave: Create Mapping Test** button located at the top
of your `.dwl` file to create a new test scenario from a snapshot of your input and your current
output. You can also use this newly created scenario as a normal scenario for your preview or
autocompletion.

To test a DataWeave mapping, follow these steps:

1.  In Visual Studio Code, open your DataWeave project.

2.  Navigate to the `src/main/dw` folder.

3.  Click the **DataWeave: Create Mapping Test** button (microscope icon) located at the top of your
    mapping `.dwl` file.

    ![MyMapping.dwl file and the DataWeave Create Mapping Test button](/mulesoft/current/en-us/dataweave/2.11/_images/dataweave-extension-testmapping.png)

4.  Specify a name for the mapping test and press enter.

This creates a new mapping test `.dwl` file:

![MyMappingTest.dwl file](/mulesoft/current/en-us/dataweave/2.11/_images/dataweave-extension-testmapping-2.png)

## Using the DataWeave Dependencies View

The **DATAWEAVE DEPENDENCIES** view shows all the dependencies resolved for a DataWeave project. The
view enables you to navigate through all of your project’s dependencies and open DataWeave files
inside those dependencies.

![DataWeave Dependencies View](/mulesoft/current/en-us/dataweave/2.11/_images/dataweave-extension-dataweavedependencies.png)

## Deploy DataWeave Libraries

Before deploying your DataWeave library to Anypoint Exchange, generate documentation for your
mapping or module functions. When you deploy your DataWeave library to Exchange, the documentation
is also published to the Exchange library page.

To generate documentation for the functions, follow these steps:

1.  In Visual Studio Code, open your DataWeave project.

2.  Navigate to the `src/main/dw` folder.

3.  Click the **Generate Weave Documentation** button located at the top of the function in the
    `.dwl` file.

    ![MyMapping.dwl file and the Generate Weave Documentation button](/mulesoft/current/en-us/dataweave/2.11/_images/dataweave-extension-generatedocs-1.png)

The documentation template appears as a comment above the function:

![Auto-generated documentation located above the function](/mulesoft/current/en-us/dataweave/2.11/_images/dataweave-extension-generatedocs-2.png)

To deploy a DataWeave library to Exchange:

1.  In Visual Studio Code, open your DataWeave project.

2.  Open and configure your `pom.xml` file.

    1.  Ensure that your `groupId` is set to your `organization ID`.

    2.  Add the Maven facade as a repository within the `<distributionManagement>` element.

        ![Maven facade in <distributionManagement> element](/mulesoft/current/en-us/dataweave/2.11/_images/dataweave-extension-mavenfacade.png)

3.  Update the `settings.xml` file in your Maven `.m2` directory with your Anypoint Platform
    credentials.

    For guidance, refer to the
    [Publish an Asset to Exchange Using Maven](https://docs.mulesoft.com/dataweave/2.11/exchange/to-publish-assets-maven#publish-an-asset-to-exchange-using-maven guide>)
    documentation.

4.  Execute the Maven `deploy` command to upload the DataWeave library to the deployment target and
    the auto-generated documentation to Exchange.

    For guidance, refer to the [DataWeave Maven Plugin](https://docs.mulesoft.com/dataweave/2.11/dataweave-maven-plugin) documentation.

## Consume DataWeave Libraries

After deploying your DataWeave library to Exchange, the library appears as an asset for your
organization in the Exchange marketplace.

To consume the DataWeave library:

1.  Add the library’s group ID, artifact ID, version, and classifier to the `dependencies` element
    in your project’s `pom.xml` file.

    You can copy the dependency snippet from Exchange.

2.  Add the Maven facade as a repository in the `repositories` section.

For more details, refer to the
[Publish and Consume Federated Assets](https://docs.mulesoft.com/exchange/to-publish-assets-maven#publish-and-consume-federated-assets)
documentation.

## DataWeave Extension Language Edition Features

The Language Edition features of the DataWeave extension include completion, navigation, code
editing, and code inspection.

### Completion

The completion feature enables you to autocomplete content for any visible functions, variables, or
types. The feature also suggests fields based on the type inference.

![Completion Feature sample](/mulesoft/current/en-us/dataweave/2.11/_images/dataweave-extension-completion.png)

### Navigation

You can navigate to any local definition or from any imported library.

### Code Editing Features

The following features help you to easily code in Visual Studio Code:

- Find all references

- Refactors (local and cross files)

- Quick fixes:

  - Auto import when a function is present in a module

  - Create a function, variable, or type when one isn’t found

- Outline

- Show parameters information

- Hover information with documentation

![Auto Import Feature sample](/mulesoft/current/en-us/dataweave/2.11/_images/dataweave-extension-autoimport.png)

### Code Inspections

The DataWeave extension tries to detect and suggest replacements for idioms in expressions, as shown
in the following examples:

- Default Value

![Default Value Code Inspection sample](/mulesoft/current/en-us/dataweave/2.11/_images/dataweave-extension-defaultvalue.png)

- TypeOf

![TypeOf Code Inspection sample](/mulesoft/current/en-us/dataweave/2.11/_images/dataweave-extension-typeof.png)

- IsEmpty

![Is Empty Code Inspection sample](/mulesoft/current/en-us/dataweave/2.11/_images/dataweave-extension-isempty.png)

## DataWeave Extension Troubleshooting Logs

If an error occurs while you’re working with the DataWeave Extension, check the logs output of the
DataWeave Language Server that provide details of what can cause the issue:

To check the logs, follow these steps:

1.  In Visual Studio Code, navigate to **View > Output** to open the **OUTPUT** view in the Visual
    Studio Code editor window.

2.  In the drop-down menu located on the left of the screen editor, select **Mule DX DataWeave LS**
    to show the logs.

![Mule DX DataWeave LS option to select in the drop-down menu of the Output](/mulesoft/current/en-us/dataweave/2.11/_images/dataweave-extension-logs.png)

## See Also

- [DataWeave Extension](https://docs.mulesoft.com/dataweave/2.11/dataweave-extension)

- [DataWeave Maven Plugin](https://docs.mulesoft.com/dataweave/2.11/dataweave-maven-plugin)

- [DataWeave Testing Framework](https://docs.mulesoft.com/dataweave/2.11/dataweave-testing-framework)

<!-- document id=8bc6315230cc70c3bd6539fed487f43749ae50551b0ea0056d97a7c4b49ab7cd url=/mulesoft/current/en-us/dataweave/2.12/dataweave-extension-plugin.md -->

---
product: DataWeave
version: 2.12
---

# Installing and Using the DataWeave Extension

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Install and use DataWeave extension in Visual Studio Code (DataWeave extension) to develop, preview,
test, and deploy custom mappings and modules into libraries in a DataWeave project. The extension
also enables you to preview transformations similar to those you perform in the
[DataWeave Playground](https://dataweave.mulesoft.com/learn/).

## Before You Begin

Before installing the DataWeave extension to Visual Studio Code, you must:

- Install AdoptOpenJDK

- Install Apache Maven (3.6.3 minimum)

- Install Microsoft Visual Studio Code for your specific operating system

> [!NOTE] If you have any other prior extensions for DataWeave, whether experimental or from a third
> party, uninstall them.

## Install the DataWeave Extension

To install the extension:

1.  Open Visual Studio Code.

2.  In the **EXTENSIONS** tab, type `dataweave` to search the extension in the marketplace.

3.  Select **Anypoint Code Builder - DataWeave Extension** from the search results.

4.  Click **Install**.

    ![DataWeave extension installation](/mulesoft/current/en-us/dataweave/2.12/_images/dataweave-extension-plugin-install.png)

5.  After the installation finishes, restart Visual Studio Code.

## Developing DataWeave Libraries

A DataWeave library is a reusable package of DataWeave module and mapping files, and resource files,
such as JSON, XML, and CSV. To develop DataWeave libraries, first create a new DataWeave project in
Visual Studio Code where you then create, preview, and test custom mappings and modules.

If you want to try out your mapping without creating a DataWeave project, you can either open your
`.dwl` mapping file directly in Visual Studio Code or create a new one and use
[sample data](#sample-data) and [scenarios](#scenarios).

### Understanding the DataWeave Project Structure

DataWeave projects use Apache Maven to build and declare project dependencies. The following diagram
shows the DataWeave project structure:

```none
├── src
│   ├── main
│   │   ├── dw // Put your DataWeave mappings and module files here
│   │   │   ├── MyMapping.dwl
|   |   |   └── MyModule.dwl
│   │   └── resources
│   └── test
│       ├── dw
│       │   └── MyModuleTest.dwl  //Unit tests for the functions in your module
│       │   └── MyMappingTest.dwl //Integration test for your mapping using the saved scenarios
│       ├── resources
│       │       └── MyMapping //Contains the different scenarios for your mapping
│       │           ├── default
│       │           │   └── inputs
│       │           │       └── payload.json //[Sample data](#sample-data) for your mappings
│       │           └── SavedTestScenario //Scenario used for the integration test
├── pom.xml
```

### Create a DataWeave Project

To create a new project:

1.  Open Visual Studio Code.

2.  Click **View > Command Palette**.

3.  In the search bar, type `dataweave`.

4.  Select **DataWeave: Create New Library Project**.

    ![Command Palette with DataWeave: Create New Library Project option selected](/mulesoft/current/en-us/dataweave/2.12/_images/dataweave-extension-new-project.png)

5.  Follow prompts to complete an initial configuration for your project:

    1.  **Organization ID** (Group ID)

    2.  **Artifact ID**

    3.  **Version**

    4.  **Project name**

6.  Choose a directory folder for your new project.

7.  Select **OK**.

8.  When prompted, select **Yes** or **No** whether you want to open the project in a new Visual
    Studio Code window.

The following image shows a new DataWeave project in Visual Studio Code:

![DataWeave project example window](/mulesoft/current/en-us/dataweave/2.12/_images/dataweave-extension-new-project-sample.png)

When creating a DataWeave project, the DataWeave extension requires all dependencies to be loaded
and indexed before it can search the libraries and make them available in your project. Visual
Studio Code provides a notification bar at the bottom of the screen editor that shows when the
dependencies are loading and when the indexing is complete.

![Dependencies loading and indexing](/mulesoft/current/en-us/dataweave/2.12/_images/dataweave-extension-dependencies.png)

## Create a DataWeave Module

DataWeave modules are `.dwl` files that define functions, variables, types, and namespaces. These
files cannot contain output directives, body expressions, or `---` separators between header and
body sections. A DataWeave module enables you to share all the content defined in the `.dwl` file
for reuse.

To create a new DataWeave module:

1.  In Visual Studio Code, click **View > Command Palette**.

2.  In the search bar, type `dataweave`.

3.  Select **DataWeave: Create New Module**.

    ![Command Palette with DataWeave: Create new module option selected](/mulesoft/current/en-us/dataweave/2.12/_images/dataweave-extension-createmodule.png)

4.  Add a name for the new module `dwl` file and press enter.  
    This creates a new module `.dwl` file under the `src/main/dw` folder.

## Preview a DataWeave Module

For a better development experience, you can use the _preview_ view to develop your module’s
functions. The _preview_ view lets you get instant feedback on how a mapping file is working by
previewing its output. Use this view to develop the module’s functions by creating a DataWeave
mapping inside the `src/test/dw` folder that imports your functions and calls them to check how
they’re currently working.

To preview the module functionality, follow these steps:

1.  In Visual Studio Code, open your DataWeave project.

2.  Navigate to the `src/main/dw` folder.

3.  Select your module `.dwl` file.

4.  Click the **Create Integration Mapping** button located at the top of your module `.dwl` file.  
    This create a mapping file under the `src/test/dw` folder to test your module, which isn’t meant
    to be shared or reused.

![Create Integration Mapping button above the .dwl file](/mulesoft/current/en-us/dataweave/2.12/_images/dataweave-extension-preview-1.png)

5.  Either preview the module function by one of these options:

    - Click the **DataWeave: Run Preview** button (arrow icon) at the top right corner of your
      module `.dwl` file.

      ![DataWeave: Run Preview button](/mulesoft/current/en-us/dataweave/2.12/_images/dataweave-extension-preview-2.png)

    - Right-click the editor and select **DataWeave: Enable AutoPreview** to run it on every file
      change.

      ![DataWeave: Enable AutoPreview option](/mulesoft/current/en-us/dataweave/2.12/_images/dataweave-extension-preview-3.png)

## Test a DataWeave Module

There’re two ways to test your module:

- By running a unit test

- By creating a test mapping located in your `src/test/dw` folder to avoid exposing the test to
  consumers of your module

The tests use functions of the modules `dw::test::Tests` and `dw::test::Asserts` provided by the
artifact `org.mule.weave:data-weave-testing-framework` of the
[DataWeave Testing Framework](https://docs.mulesoft.com/dataweave/2.12/dataweave-testing-framework).

To generate a unit test for a DataWeave module, follow these steps:

1.  In Visual Studio Code, open your DataWeave project.

2.  Navigate to the `src/main/dw` folder.

3.  Select your module `.dwl` file.

4.  In your module `.dwl` file, click the **Add Unit Test** button located above your function.

    ![MyModule.dwl file showing the function and the Add Unit Test button](/mulesoft/current/en-us/dataweave/2.12/_images/dataweave-extension-testmodule-1.png)

This behavior generates:

- A new `.dwl` test file in `src/test/dw` that describes test cases and tests suites for the module.

  - A test case is a single test with the evaluation and assertion of the result.

  - A test suite groups tests with a name that better describes the intention of some related cases.

    The test file defines a test case for the function that you call with specific arguments and use
    to make assertions over the output.

- A new test case within a test suite for the function. If not present, the test suite is also
  created.

![MyModuleTest.dwl file in the src/test/dw folder](/mulesoft/current/en-us/dataweave/2.12/_images/dataweave-extension-testmodule-2.png)

To run the test:

1.  In Visual Studio Code, go to the **TESTING** view.

2.  Select the dropdown arrows of your module test file.

3.  Click the **Run Test** arrow button.

![MyModuleTest file in the TESTING TAB and Run Test button](/mulesoft/current/en-us/dataweave/2.12/_images/dataweave-extension-testmodule-3.png)

## Create a DataWeave Mapping

A DataWeave mapping is a `.dwl` file that enables you to map and connect to anything, regardless of
data type or structure. As when using a DataWeave module, you can use a mapping to define functions,
variables, types, and namespaces, but you can additionally specify a body section after the
separator `---`.

Unlike a DataWeave module file, a DataWeave mapping file is an executable unit that enables you to
transform zero or more inputs into a single output. Using the DataWeave extension, you can develop
these files to create reusable assets that you can deploy and share with others.

To create a new DataWeave mapping, follow these steps:

1.  In Visual Studio Code, click **View > Command Palette**.

2.  In the search bar, type `dataweave`.

3.  Select **DataWeave: Create New Mapping**.

    ![Command Palette with DataWeave: Create new mapping selected](/mulesoft/current/en-us/dataweave/2.12/_images/dataweave-extension-createmapping.png)

4.  Add a name for the new mapping `dwl` file and press enter.  
    This creates a new mapping `.dwl` file under the `src/main/dw` folder.

### Define Sample Data for DataWeave Mappings

Generate multiple sample data inputs for your mapping by clicking the **Define Sample Data** button
at the top of your mapping `.dwl` file. Sample data is a key part of DataWeave project development
to run your mappings.

To define sample data, follow these steps:

1.  In Visual Studio Code, open your DataWeave project.

2.  Navigate to the `src/main/dw` folder.

3.  Select your mapping `.dwl` file.

4.  Click the **Define Sample Data** button located above your mapping `.dwl` file.

    ![MyMapping.dwl file with Define Sample Data button](/mulesoft/current/en-us/dataweave/2.12/_images/dataweave-extension-sampledata-1.png)

5.  Specify the name for the sample data file and press enter.

Using sample data generates a DataWeave _scenario_ that contains all the resources required to run
the mapping in the context of that scenario.

![Generated new sample data payload.json file as input for the MyMapping.dwl file](/mulesoft/current/en-us/dataweave/2.12/_images/dataweave-extension-sampledata-2.png)

## Understanding DataWeave Scenarios

A DataWeave _scenario_ is a group of inputs and outputs that you can inject into your mapping either
to try out in the **Preview Output** view or to test your mapping using the input to evaluate it and
compare its output with the desired saved output of your scenario. Scenarios also provide
autocompletion based on the input structures.

These scenarios and their resources live in the `src/test/resources` folder and have the following
structure:

```none
├── src/test/resources
│       └── MyMapping //Contains the different scenarios for your mapping called "MyMapping"
│           ├── default //Name of your scenario
│           │   └── inputs //Folder where all of your inputs live
│           │   │   └── payload.json //Input for your mapping (you can use it in your script, naming it to be the same as the name of the file without the file's extension)
│           │   │   └── vars //Folder that represents a name for your input variable in your script: in this case vars
│           │   │       └── test.json //Input for your mapping (you can use it in your script, calling it vars.test)
│           │   └── out.json // Expected output of your mapping running against your inputs (only present when testing)
│           └── SavedTestScenario //Another scenario used for the integration test
```

### Using the DataWeave Scenarios View

The **DATAWEAVE SCENARIOS** view shows the available scenarios for the `.dwl` file. In this view,
you can add, remove, or set the active scenario that is used for your preview execution, or you can
choose that the values be autocompleted.

![DataWeave Scenarios view in Visual Studio Code](/mulesoft/current/en-us/dataweave/2.12/_images/dataweave-extension-dataweavescenario.png)

### Using Reader Properties for Inputs

If you want to set different reader properties to the inputs you use, create a properties file with
the suffix `{fileName}-config.properties` in the same directory of your input. For example, if your
input is called `payload.csv` then create a `payload-config.properties` file that contains all the
reader properties required to run your scenario. Creating the properties file also applies while
testing your DataWeave mappings.

## Preview a DataWeave Mapping

After you define sample data, get feedback on how your mapping is working by previewing the output.

1.  In Visual Studio Code, open your DataWeave project.

2.  Navigate to the `src/main/dw` folder.

3.  Select your module `.dwl` file.

4.  Either preview the mapping function by one of these options:

    - Click the **DataWeave: Run Preview** button (arrow icon) at the top right corner of your
      mapping `.dwl` file.

    - Right-click the editor and select **DataWeave: Enable AutoPreview** to run it on every file
      change.

## Run and Debug a DataWeave Mapping

Run and debug a DataWeave mapping to be guided through all of the mapping elements, which you can
then fix or otherwise update. You can also set breakpoints to stop evaluating expressions and use
all the debugging capabilities that Visual Studio Code provides. Debugging works on mapping tests as
well.

To run and debug a DataWeave mapping, follow these steps:

1.  In Visual Studio Code, open your DataWeave project.

2.  Navigate to the `src/main/dw` folder.

3.  Select your mapping `.dwl` file.

4.  Click the **Run Mapping** button located at the top of your `.dwl` file.

    ![MyMapping.dwl and Run Mapping button](/mulesoft/current/en-us/dataweave/2.12/_images/dataweave-extension-runmapping.png)

## Test a DataWeave Mapping

To test a DataWeave mapping, click the **Dataweave: Create Mapping Test** button located at the top
of your `.dwl` file to create a new test scenario from a snapshot of your input and your current
output. You can also use this newly created scenario as a normal scenario for your preview or
autocompletion.

To test a DataWeave mapping, follow these steps:

1.  In Visual Studio Code, open your DataWeave project.

2.  Navigate to the `src/main/dw` folder.

3.  Click the **DataWeave: Create Mapping Test** button (microscope icon) located at the top of your
    mapping `.dwl` file.

    ![MyMapping.dwl file and the DataWeave Create Mapping Test button](/mulesoft/current/en-us/dataweave/2.12/_images/dataweave-extension-testmapping.png)

4.  Specify a name for the mapping test and press enter.

This creates a new mapping test `.dwl` file:

![MyMappingTest.dwl file](/mulesoft/current/en-us/dataweave/2.12/_images/dataweave-extension-testmapping-2.png)

## Using the DataWeave Dependencies View

The **DATAWEAVE DEPENDENCIES** view shows all the dependencies resolved for a DataWeave project. The
view enables you to navigate through all of your project’s dependencies and open DataWeave files
inside those dependencies.

![DataWeave Dependencies View](/mulesoft/current/en-us/dataweave/2.12/_images/dataweave-extension-dataweavedependencies.png)

## Deploy DataWeave Libraries

Before deploying your DataWeave library to Anypoint Exchange, generate documentation for your
mapping or module functions. When you deploy your DataWeave library to Exchange, the documentation
is also published to the Exchange library page.

To generate documentation for the functions, follow these steps:

1.  In Visual Studio Code, open your DataWeave project.

2.  Navigate to the `src/main/dw` folder.

3.  Click the **Generate Weave Documentation** button located at the top of the function in the
    `.dwl` file.

    ![MyMapping.dwl file and the Generate Weave Documentation button](/mulesoft/current/en-us/dataweave/2.12/_images/dataweave-extension-generatedocs-1.png)

The documentation template appears as a comment above the function:

![Auto-generated documentation located above the function](/mulesoft/current/en-us/dataweave/2.12/_images/dataweave-extension-generatedocs-2.png)

To deploy a DataWeave library to Exchange:

1.  In Visual Studio Code, open your DataWeave project.

2.  Open and configure your `pom.xml` file.

    1.  Ensure that your `groupId` is set to your `organization ID`.

    2.  Add the Maven facade as a repository within the `<distributionManagement>` element.

        ![Maven facade in <distributionManagement> element](/mulesoft/current/en-us/dataweave/2.12/_images/dataweave-extension-mavenfacade.png)

3.  Update the `settings.xml` file in your Maven `.m2` directory with your Anypoint Platform
    credentials.

    For guidance, refer to the
    [Publish an Asset to Exchange Using Maven](https://docs.mulesoft.com/dataweave/2.12/exchange/to-publish-assets-maven#publish-an-asset-to-exchange-using-maven guide>)
    documentation.

4.  Execute the Maven `deploy` command to upload the DataWeave library to the deployment target and
    the auto-generated documentation to Exchange.

    For guidance, refer to the [DataWeave Maven Plugin](https://docs.mulesoft.com/dataweave/2.12/dataweave-maven-plugin) documentation.

## Consume DataWeave Libraries

After deploying your DataWeave library to Exchange, the library appears as an asset for your
organization in the Exchange marketplace.

To consume the DataWeave library:

1.  Add the library’s group ID, artifact ID, version, and classifier to the `dependencies` element
    in your project’s `pom.xml` file.

    You can copy the dependency snippet from Exchange.

2.  Add the Maven facade as a repository in the `repositories` section.

For more details, refer to the
[Publish and Consume Federated Assets](https://docs.mulesoft.com/exchange/to-publish-assets-maven#publish-and-consume-federated-assets)
documentation.

## DataWeave Extension Language Edition Features

The Language Edition features of the DataWeave extension include completion, navigation, code
editing, and code inspection.

### Completion

The completion feature enables you to autocomplete content for any visible functions, variables, or
types. The feature also suggests fields based on the type inference.

![Completion Feature sample](/mulesoft/current/en-us/dataweave/2.12/_images/dataweave-extension-completion.png)

### Navigation

You can navigate to any local definition or from any imported library.

### Code Editing Features

The following features help you to easily code in Visual Studio Code:

- Find all references

- Refactors (local and cross files)

- Quick fixes:

  - Auto import when a function is present in a module

  - Create a function, variable, or type when one isn’t found

- Outline

- Show parameters information

- Hover information with documentation

![Auto Import Feature sample](/mulesoft/current/en-us/dataweave/2.12/_images/dataweave-extension-autoimport.png)

### Code Inspections

The DataWeave extension tries to detect and suggest replacements for idioms in expressions, as shown
in the following examples:

- Default Value

![Default Value Code Inspection sample](/mulesoft/current/en-us/dataweave/2.12/_images/dataweave-extension-defaultvalue.png)

- TypeOf

![TypeOf Code Inspection sample](/mulesoft/current/en-us/dataweave/2.12/_images/dataweave-extension-typeof.png)

- IsEmpty

![Is Empty Code Inspection sample](/mulesoft/current/en-us/dataweave/2.12/_images/dataweave-extension-isempty.png)

## DataWeave Extension Troubleshooting Logs

If an error occurs while you’re working with the DataWeave Extension, check the logs output of the
DataWeave Language Server that provide details of what can cause the issue:

To check the logs, follow these steps:

1.  In Visual Studio Code, navigate to **View > Output** to open the **OUTPUT** view in the Visual
    Studio Code editor window.

2.  In the drop-down menu located on the left of the screen editor, select **Mule DX DataWeave LS**
    to show the logs.

![Mule DX DataWeave LS option to select in the drop-down menu of the Output](/mulesoft/current/en-us/dataweave/2.12/_images/dataweave-extension-logs.png)

## Scope Visibility

When you author DataWeave libraries (`.dwl` files that other DataWeave code imports), the DataWeave
extension supports the visibility model introduced in DataWeave 2.12.0:

- Highlights the keywords `private` and `internal` as language keywords.

- Recognizes the `@VisibleTo` annotation when applied to `internal` directives.

- Reports visibility violations inline and uses the same wording as the compiler
  (`…​ cannot be accessed from …​ as it is private to the module …​`,
  `…​ is internal to the component …​`).

- Filters out directives that aren’t visible from the current file in auto-completion. For example,
  `private` helpers defined in another file don’t appear in the suggestion list.

- Supports `Go to definition` and warns when you navigate to a directive that isn’t accessible from
  the current file.

These features apply to library projects only. If you write a Mule transformation mapping inline (a
`%dw 2.0` expression in a Transform Message component, a Set Variable expression, or a DataWeave
expression embedded in a connector), the `internal` keyword and `@VisibleTo` annotation have no
practical effect. An inline mapping is a self-contained script that can’t be imported from another
inline mapping, so there is nothing to constrain. The keywords are still parsed, but you don’t need
them in mapping code.

The same rule applies to `.dwl` modules defined inside the Mule application. Every inline mapping
and application-level module belongs to an unnamed component, so they can freely reference each
other’s `internal` directives. The `private` keyword still applies and restricts a directive to its
declaring file regardless of component.

For the full visibility model, including definitions for `private`, `internal`, and components, and
how the Maven plugin for DataWeave generates the component descriptor, see
[Scope Visibility in DataWeave](https://docs.mulesoft.com/dataweave/2.12/dataweave-scope-visibility).

## See Also

- [DataWeave Extension](https://docs.mulesoft.com/dataweave/2.12/dataweave-extension)

- [DataWeave Maven Plugin](https://docs.mulesoft.com/dataweave/2.12/dataweave-maven-plugin)

- [DataWeave Testing Framework](https://docs.mulesoft.com/dataweave/2.12/dataweave-testing-framework)

<!-- document id=f24872bd145e03ced3e1272613503e465fc3a4d3680e25c352c5b3afc40b42c3 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-extension-plugin.md -->

---
product: DataWeave
version: 2.4
---

# Installing and Using the DataWeave Extension

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Install and use DataWeave extension in Visual Studio Code (DataWeave extension) to develop, preview,
test, and deploy custom mappings and modules into libraries in a DataWeave project. The extension
also enables you to preview transformations similar to those you perform in the
[DataWeave Playground](https://dataweave.mulesoft.com/learn/).

## Before You Begin

Before installing the DataWeave extension to Visual Studio Code, you must:

- Install AdoptOpenJDK

- Install Apache Maven (3.6.3 minimum)

- Install Microsoft Visual Studio Code for your specific operating system

> [!NOTE] If you have any other prior extensions for DataWeave, whether experimental or from a third
> party, uninstall them.

## Install the DataWeave Extension

To install the extension:

1.  Open Visual Studio Code.

2.  In the **EXTENSIONS** tab, type `dataweave` to search the extension in the marketplace.

3.  Select **Anypoint Code Builder - DataWeave Extension** from the search results.

4.  Click **Install**.

    ![DataWeave extension installation](/mulesoft/current/en-us/dataweave/2.4/_images/dataweave-extension-plugin-install.png)

5.  After the installation finishes, restart Visual Studio Code.

## Developing DataWeave Libraries

A DataWeave library is a reusable package of DataWeave module and mapping files, and resource files,
such as JSON, XML, and CSV. To develop DataWeave libraries, first create a new DataWeave project in
Visual Studio Code where you then create, preview, and test custom mappings and modules.

If you want to try out your mapping without creating a DataWeave project, you can either open your
`.dwl` mapping file directly in Visual Studio Code or create a new one and use
[sample data](#sample-data) and [scenarios](#scenarios).

### Understanding the DataWeave Project Structure

DataWeave projects use Apache Maven to build and declare project dependencies. The following diagram
shows the DataWeave project structure:

```none
├── src
│   ├── main
│   │   ├── dw // Put your DataWeave mappings and module files here
│   │   │   ├── MyMapping.dwl
|   |   |   └── MyModule.dwl
│   │   └── resources
│   └── test
│       ├── dw
│       │   └── MyModuleTest.dwl  //Unit tests for the functions in your module
│       │   └── MyMappingTest.dwl //Integration test for your mapping using the saved scenarios
│       ├── resources
│       │       └── MyMapping //Contains the different scenarios for your mapping
│       │           ├── default
│       │           │   └── inputs
│       │           │       └── payload.json //[Sample data](#sample-data) for your mappings
│       │           └── SavedTestScenario //Scenario used for the integration test
├── pom.xml
```

### Create a DataWeave Project

To create a new project:

1.  Open Visual Studio Code.

2.  Click **View > Command Palette**.

3.  In the search bar, type `dataweave`.

4.  Select **DataWeave: Create New Library Project**.

    ![Command Palette with DataWeave: Create New Library Project option selected](/mulesoft/current/en-us/dataweave/2.4/_images/dataweave-extension-new-project.png)

5.  Follow prompts to complete an initial configuration for your project:

    1.  **Organization ID** (Group ID)

    2.  **Artifact ID**

    3.  **Version**

    4.  **Project name**

6.  Choose a directory folder for your new project.

7.  Select **OK**.

8.  When prompted, select **Yes** or **No** whether you want to open the project in a new Visual
    Studio Code window.

The following image shows a new DataWeave project in Visual Studio Code:

![DataWeave project example window](/mulesoft/current/en-us/dataweave/2.4/_images/dataweave-extension-new-project-sample.png)

When creating a DataWeave project, the DataWeave extension requires all dependencies to be loaded
and indexed before it can search the libraries and make them available in your project. Visual
Studio Code provides a notification bar at the bottom of the screen editor that shows when the
dependencies are loading and when the indexing is complete.

![Dependencies loading and indexing](/mulesoft/current/en-us/dataweave/2.4/_images/dataweave-extension-dependencies.png)

## Create a DataWeave Module

DataWeave modules are `.dwl` files that define functions, variables, types, and namespaces. These
files cannot contain output directives, body expressions, or `---` separators between header and
body sections. A DataWeave module enables you to share all the content defined in the `.dwl` file
for reuse.

To create a new DataWeave module:

1.  In Visual Studio Code, click **View > Command Palette**.

2.  In the search bar, type `dataweave`.

3.  Select **DataWeave: Create New Module**.

    ![Command Palette with DataWeave: Create new module option selected](/mulesoft/current/en-us/dataweave/2.4/_images/dataweave-extension-createmodule.png)

4.  Add a name for the new module `dwl` file and press enter.  
    This creates a new module `.dwl` file under the `src/main/dw` folder.

## Preview a DataWeave Module

For a better development experience, you can use the _preview_ view to develop your module’s
functions. The _preview_ view lets you get instant feedback on how a mapping file is working by
previewing its output. Use this view to develop the module’s functions by creating a DataWeave
mapping inside the `src/test/dw` folder that imports your functions and calls them to check how
they’re currently working.

To preview the module functionality, follow these steps:

1.  In Visual Studio Code, open your DataWeave project.

2.  Navigate to the `src/main/dw` folder.

3.  Select your module `.dwl` file.

4.  Click the **Create Integration Mapping** button located at the top of your module `.dwl` file.  
    This create a mapping file under the `src/test/dw` folder to test your module, which isn’t meant
    to be shared or reused.

![Create Integration Mapping button above the .dwl file](/mulesoft/current/en-us/dataweave/2.4/_images/dataweave-extension-preview-1.png)

5.  Either preview the module function by one of these options:

    - Click the **DataWeave: Run Preview** button (arrow icon) at the top right corner of your
      module `.dwl` file.

      ![DataWeave: Run Preview button](/mulesoft/current/en-us/dataweave/2.4/_images/dataweave-extension-preview-2.png)

    - Right-click the editor and select **DataWeave: Enable AutoPreview** to run it on every file
      change.

      ![DataWeave: Enable AutoPreview option](/mulesoft/current/en-us/dataweave/2.4/_images/dataweave-extension-preview-3.png)

## Test a DataWeave Module

There’re two ways to test your module:

- By running a unit test

- By creating a test mapping located in your `src/test/dw` folder to avoid exposing the test to
  consumers of your module

The tests use functions of the modules `dw::test::Tests` and `dw::test::Asserts` provided by the
artifact `org.mule.weave:data-weave-testing-framework` of the
[DataWeave Testing Framework](https://docs.mulesoft.com/dataweave/2.4/dataweave-testing-framework).

To generate a unit test for a DataWeave module, follow these steps:

1.  In Visual Studio Code, open your DataWeave project.

2.  Navigate to the `src/main/dw` folder.

3.  Select your module `.dwl` file.

4.  In your module `.dwl` file, click the **Add Unit Test** button located above your function.

    ![MyModule.dwl file showing the function and the Add Unit Test button](/mulesoft/current/en-us/dataweave/2.4/_images/dataweave-extension-testmodule-1.png)

This behavior generates:

- A new `.dwl` test file in `src/test/dw` that describes test cases and tests suites for the module.

  - A test case is a single test with the evaluation and assertion of the result.

  - A test suite groups tests with a name that better describes the intention of some related cases.

    The test file defines a test case for the function that you call with specific arguments and use
    to make assertions over the output.

- A new test case within a test suite for the function. If not present, the test suite is also
  created.

![MyModuleTest.dwl file in the src/test/dw folder](/mulesoft/current/en-us/dataweave/2.4/_images/dataweave-extension-testmodule-2.png)

To run the test:

1.  In Visual Studio Code, go to the **TESTING** view.

2.  Select the dropdown arrows of your module test file.

3.  Click the **Run Test** arrow button.

![MyModuleTest file in the TESTING TAB and Run Test button](/mulesoft/current/en-us/dataweave/2.4/_images/dataweave-extension-testmodule-3.png)

## Create a DataWeave Mapping

A DataWeave mapping is a `.dwl` file that enables you to map and connect to anything, regardless of
data type or structure. As when using a DataWeave module, you can use a mapping to define functions,
variables, types, and namespaces, but you can additionally specify a body section after the
separator `---`.

Unlike a DataWeave module file, a DataWeave mapping file is an executable unit that enables you to
transform zero or more inputs into a single output. Using the DataWeave extension, you can develop
these files to create reusable assets that you can deploy and share with others.

To create a new DataWeave mapping, follow these steps:

1.  In Visual Studio Code, click **View > Command Palette**.

2.  In the search bar, type `dataweave`.

3.  Select **DataWeave: Create New Mapping**.

    ![Command Palette with DataWeave: Create new mapping selected](/mulesoft/current/en-us/dataweave/2.4/_images/dataweave-extension-createmapping.png)

4.  Add a name for the new mapping `dwl` file and press enter.  
    This creates a new mapping `.dwl` file under the `src/main/dw` folder.

### Define Sample Data for DataWeave Mappings

Generate multiple sample data inputs for your mapping by clicking the **Define Sample Data** button
at the top of your mapping `.dwl` file. Sample data is a key part of DataWeave project development
to run your mappings.

To define sample data, follow these steps:

1.  In Visual Studio Code, open your DataWeave project.

2.  Navigate to the `src/main/dw` folder.

3.  Select your mapping `.dwl` file.

4.  Click the **Define Sample Data** button located above your mapping `.dwl` file.

    ![MyMapping.dwl file with Define Sample Data button](/mulesoft/current/en-us/dataweave/2.4/_images/dataweave-extension-sampledata-1.png)

5.  Specify the name for the sample data file and press enter.

Using sample data generates a DataWeave _scenario_ that contains all the resources required to run
the mapping in the context of that scenario.

![Generated new sample data payload.json file as input for the MyMapping.dwl file](/mulesoft/current/en-us/dataweave/2.4/_images/dataweave-extension-sampledata-2.png)

## Understanding DataWeave Scenarios

A DataWeave _scenario_ is a group of inputs and outputs that you can inject into your mapping either
to try out in the **Preview Output** view or to test your mapping using the input to evaluate it and
compare its output with the desired saved output of your scenario. Scenarios also provide
autocompletion based on the input structures.

These scenarios and their resources live in the `src/test/resources` folder and have the following
structure:

```none
├── src/test/resources
│       └── MyMapping //Contains the different scenarios for your mapping called "MyMapping"
│           ├── default //Name of your scenario
│           │   └── inputs //Folder where all of your inputs live
│           │   │   └── payload.json //Input for your mapping (you can use it in your script, naming it to be the same as the name of the file without the file's extension)
│           │   │   └── vars //Folder that represents a name for your input variable in your script: in this case vars
│           │   │       └── test.json //Input for your mapping (you can use it in your script, calling it vars.test)
│           │   └── out.json // Expected output of your mapping running against your inputs (only present when testing)
│           └── SavedTestScenario //Another scenario used for the integration test
```

### Using the DataWeave Scenarios View

The **DATAWEAVE SCENARIOS** view shows the available scenarios for the `.dwl` file. In this view,
you can add, remove, or set the active scenario that is used for your preview execution, or you can
choose that the values be autocompleted.

![DataWeave Scenarios view in Visual Studio Code](/mulesoft/current/en-us/dataweave/2.4/_images/dataweave-extension-dataweavescenario.png)

### Using Reader Properties for Inputs

If you want to set different reader properties to the inputs you use, create a properties file with
the suffix `{fileName}-config.properties` in the same directory of your input. For example, if your
input is called `payload.csv` then create a `payload-config.properties` file that contains all the
reader properties required to run your scenario. Creating the properties file also applies while
testing your DataWeave mappings.

## Preview a DataWeave Mapping

After you define sample data, get feedback on how your mapping is working by previewing the output.

1.  In Visual Studio Code, open your DataWeave project.

2.  Navigate to the `src/main/dw` folder.

3.  Select your module `.dwl` file.

4.  Either preview the mapping function by one of these options:

    - Click the **DataWeave: Run Preview** button (arrow icon) at the top right corner of your
      mapping `.dwl` file.

    - Right-click the editor and select **DataWeave: Enable AutoPreview** to run it on every file
      change.

## Run and Debug a DataWeave Mapping

Run and debug a DataWeave mapping to be guided through all of the mapping elements, which you can
then fix or otherwise update. You can also set breakpoints to stop evaluating expressions and use
all the debugging capabilities that Visual Studio Code provides. Debugging works on mapping tests as
well.

To run and debug a DataWeave mapping, follow these steps:

1.  In Visual Studio Code, open your DataWeave project.

2.  Navigate to the `src/main/dw` folder.

3.  Select your mapping `.dwl` file.

4.  Click the **Run Mapping** button located at the top of your `.dwl` file.

    ![MyMapping.dwl and Run Mapping button](/mulesoft/current/en-us/dataweave/2.4/_images/dataweave-extension-runmapping.png)

## Test a DataWeave Mapping

To test a DataWeave mapping, click the **Dataweave: Create Mapping Test** button located at the top
of your `.dwl` file to create a new test scenario from a snapshot of your input and your current
output. You can also use this newly created scenario as a normal scenario for your preview or
autocompletion.

To test a DataWeave mapping, follow these steps:

1.  In Visual Studio Code, open your DataWeave project.

2.  Navigate to the `src/main/dw` folder.

3.  Click the **DataWeave: Create Mapping Test** button (microscope icon) located at the top of your
    mapping `.dwl` file.

    ![MyMapping.dwl file and the DataWeave Create Mapping Test button](/mulesoft/current/en-us/dataweave/2.4/_images/dataweave-extension-testmapping.png)

4.  Specify a name for the mapping test and press enter.

This creates a new mapping test `.dwl` file:

![MyMappingTest.dwl file](/mulesoft/current/en-us/dataweave/2.4/_images/dataweave-extension-testmapping-2.png)

## Using the DataWeave Dependencies View

The **DATAWEAVE DEPENDENCIES** view shows all the dependencies resolved for a DataWeave project. The
view enables you to navigate through all of your project’s dependencies and open DataWeave files
inside those dependencies.

![DataWeave Dependencies View](/mulesoft/current/en-us/dataweave/2.4/_images/dataweave-extension-dataweavedependencies.png)

## Deploy DataWeave Libraries

Before deploying your DataWeave library to Anypoint Exchange, generate documentation for your
mapping or module functions. When you deploy your DataWeave library to Exchange, the documentation
is also published to the Exchange library page.

To generate documentation for the functions, follow these steps:

1.  In Visual Studio Code, open your DataWeave project.

2.  Navigate to the `src/main/dw` folder.

3.  Click the **Generate Weave Documentation** button located at the top of the function in the
    `.dwl` file.

    ![MyMapping.dwl file and the Generate Weave Documentation button](/mulesoft/current/en-us/dataweave/2.4/_images/dataweave-extension-generatedocs-1.png)

The documentation template appears as a comment above the function:

![Auto-generated documentation located above the function](/mulesoft/current/en-us/dataweave/2.4/_images/dataweave-extension-generatedocs-2.png)

To deploy a DataWeave library to Exchange:

1.  In Visual Studio Code, open your DataWeave project.

2.  Open and configure your `pom.xml` file.

    1.  Ensure that your `groupId` is set to your `organization ID`.

    2.  Add the Maven facade as a repository within the `<distributionManagement>` element.

        ![Maven facade in <distributionManagement> element](/mulesoft/current/en-us/dataweave/2.4/_images/dataweave-extension-mavenfacade.png)

3.  Update the `settings.xml` file in your Maven `.m2` directory with your Anypoint Platform
    credentials.

    For guidance, refer to the
    [Publish an Asset to Exchange Using Maven](https://docs.mulesoft.com/dataweave/2.4/exchange/to-publish-assets-maven#publish-an-asset-to-exchange-using-maven guide>)
    documentation.

4.  Execute the Maven `deploy` command to upload the DataWeave library to the deployment target and
    the auto-generated documentation to Exchange.

    For guidance, refer to the [DataWeave Maven Plugin](https://docs.mulesoft.com/dataweave/2.4/dataweave-maven-plugin) documentation.

## Consume DataWeave Libraries

After deploying your DataWeave library to Exchange, the library appears as an asset for your
organization in the Exchange marketplace.

To consume the DataWeave library:

1.  Add the library’s group ID, artifact ID, version, and classifier to the `dependencies` element
    in your project’s `pom.xml` file.

    You can copy the dependency snippet from Exchange.

2.  Add the Maven facade as a repository in the `repositories` section.

For more details, refer to the
[Publish and Consume Federated Assets](https://docs.mulesoft.com/exchange/to-publish-assets-maven#publish-and-consume-federated-assets)
documentation.

## DataWeave Extension Language Edition Features

The Language Edition features of the DataWeave extension include completion, navigation, code
editing, and code inspection.

### Completion

The completion feature enables you to autocomplete content for any visible functions, variables, or
types. The feature also suggests fields based on the type inference.

![Completion Feature sample](/mulesoft/current/en-us/dataweave/2.4/_images/dataweave-extension-completion.png)

### Navigation

You can navigate to any local definition or from any imported library.

### Code Editing Features

The following features help you to easily code in Visual Studio Code:

- Find all references

- Refactors (local and cross files)

- Quick fixes:

  - Auto import when a function is present in a module

  - Create a function, variable, or type when one isn’t found

- Outline

- Show parameters information

- Hover information with documentation

![Auto Import Feature sample](/mulesoft/current/en-us/dataweave/2.4/_images/dataweave-extension-autoimport.png)

### Code Inspections

The DataWeave extension tries to detect and suggest replacements for idioms in expressions, as shown
in the following examples:

- Default Value

![Default Value Code Inspection sample](/mulesoft/current/en-us/dataweave/2.4/_images/dataweave-extension-defaultvalue.png)

- TypeOf

![TypeOf Code Inspection sample](/mulesoft/current/en-us/dataweave/2.4/_images/dataweave-extension-typeof.png)

- IsEmpty

![Is Empty Code Inspection sample](/mulesoft/current/en-us/dataweave/2.4/_images/dataweave-extension-isempty.png)

## DataWeave Extension Troubleshooting Logs

If an error occurs while you’re working with the DataWeave Extension, check the logs output of the
DataWeave Language Server that provide details of what can cause the issue:

To check the logs, follow these steps:

1.  In Visual Studio Code, navigate to **View > Output** to open the **OUTPUT** view in the Visual
    Studio Code editor window.

2.  In the drop-down menu located on the left of the screen editor, select **Mule DX DataWeave LS**
    to show the logs.

![Mule DX DataWeave LS option to select in the drop-down menu of the Output](/mulesoft/current/en-us/dataweave/2.4/_images/dataweave-extension-logs.png)

## See Also

- [DataWeave Extension](https://docs.mulesoft.com/dataweave/2.4/dataweave-extension)

- [DataWeave Maven Plugin](https://docs.mulesoft.com/dataweave/2.4/dataweave-maven-plugin)

- [DataWeave Testing Framework](https://docs.mulesoft.com/dataweave/2.4/dataweave-testing-framework)

<!-- document id=8aef6a1925d33a8de5bb52b43ca5a6c5c08eede46f0f766423dd14efa49add95 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-extension-plugin.md -->

---
product: DataWeave
version: 2.6
---

# Installing and Using the DataWeave Extension

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Install and use DataWeave extension in Visual Studio Code (DataWeave extension) to develop, preview,
test, and deploy custom mappings and modules into libraries in a DataWeave project. The extension
also enables you to preview transformations similar to those you perform in the
[DataWeave Playground](https://dataweave.mulesoft.com/learn/).

## Before You Begin

Before installing the DataWeave extension to Visual Studio Code, you must:

- Install AdoptOpenJDK

- Install Apache Maven (3.6.3 minimum)

- Install Microsoft Visual Studio Code for your specific operating system

> [!NOTE] If you have any other prior extensions for DataWeave, whether experimental or from a third
> party, uninstall them.

## Install the DataWeave Extension

To install the extension:

1.  Open Visual Studio Code.

2.  In the **EXTENSIONS** tab, type `dataweave` to search the extension in the marketplace.

3.  Select **Anypoint Code Builder - DataWeave Extension** from the search results.

4.  Click **Install**.

    ![DataWeave extension installation](/mulesoft/current/en-us/dataweave/2.6/_images/dataweave-extension-plugin-install.png)

5.  After the installation finishes, restart Visual Studio Code.

## Developing DataWeave Libraries

A DataWeave library is a reusable package of DataWeave module and mapping files, and resource files,
such as JSON, XML, and CSV. To develop DataWeave libraries, first create a new DataWeave project in
Visual Studio Code where you then create, preview, and test custom mappings and modules.

If you want to try out your mapping without creating a DataWeave project, you can either open your
`.dwl` mapping file directly in Visual Studio Code or create a new one and use
[sample data](#sample-data) and [scenarios](#scenarios).

### Understanding the DataWeave Project Structure

DataWeave projects use Apache Maven to build and declare project dependencies. The following diagram
shows the DataWeave project structure:

```none
├── src
│   ├── main
│   │   ├── dw // Put your DataWeave mappings and module files here
│   │   │   ├── MyMapping.dwl
|   |   |   └── MyModule.dwl
│   │   └── resources
│   └── test
│       ├── dw
│       │   └── MyModuleTest.dwl  //Unit tests for the functions in your module
│       │   └── MyMappingTest.dwl //Integration test for your mapping using the saved scenarios
│       ├── resources
│       │       └── MyMapping //Contains the different scenarios for your mapping
│       │           ├── default
│       │           │   └── inputs
│       │           │       └── payload.json //[Sample data](#sample-data) for your mappings
│       │           └── SavedTestScenario //Scenario used for the integration test
├── pom.xml
```

### Create a DataWeave Project

To create a new project:

1.  Open Visual Studio Code.

2.  Click **View > Command Palette**.

3.  In the search bar, type `dataweave`.

4.  Select **DataWeave: Create New Library Project**.

    ![Command Palette with DataWeave: Create New Library Project option selected](/mulesoft/current/en-us/dataweave/2.6/_images/dataweave-extension-new-project.png)

5.  Follow prompts to complete an initial configuration for your project:

    1.  **Organization ID** (Group ID)

    2.  **Artifact ID**

    3.  **Version**

    4.  **Project name**

6.  Choose a directory folder for your new project.

7.  Select **OK**.

8.  When prompted, select **Yes** or **No** whether you want to open the project in a new Visual
    Studio Code window.

The following image shows a new DataWeave project in Visual Studio Code:

![DataWeave project example window](/mulesoft/current/en-us/dataweave/2.6/_images/dataweave-extension-new-project-sample.png)

When creating a DataWeave project, the DataWeave extension requires all dependencies to be loaded
and indexed before it can search the libraries and make them available in your project. Visual
Studio Code provides a notification bar at the bottom of the screen editor that shows when the
dependencies are loading and when the indexing is complete.

![Dependencies loading and indexing](/mulesoft/current/en-us/dataweave/2.6/_images/dataweave-extension-dependencies.png)

## Create a DataWeave Module

DataWeave modules are `.dwl` files that define functions, variables, types, and namespaces. These
files cannot contain output directives, body expressions, or `---` separators between header and
body sections. A DataWeave module enables you to share all the content defined in the `.dwl` file
for reuse.

To create a new DataWeave module:

1.  In Visual Studio Code, click **View > Command Palette**.

2.  In the search bar, type `dataweave`.

3.  Select **DataWeave: Create New Module**.

    ![Command Palette with DataWeave: Create new module option selected](/mulesoft/current/en-us/dataweave/2.6/_images/dataweave-extension-createmodule.png)

4.  Add a name for the new module `dwl` file and press enter.  
    This creates a new module `.dwl` file under the `src/main/dw` folder.

## Preview a DataWeave Module

For a better development experience, you can use the _preview_ view to develop your module’s
functions. The _preview_ view lets you get instant feedback on how a mapping file is working by
previewing its output. Use this view to develop the module’s functions by creating a DataWeave
mapping inside the `src/test/dw` folder that imports your functions and calls them to check how
they’re currently working.

To preview the module functionality, follow these steps:

1.  In Visual Studio Code, open your DataWeave project.

2.  Navigate to the `src/main/dw` folder.

3.  Select your module `.dwl` file.

4.  Click the **Create Integration Mapping** button located at the top of your module `.dwl` file.  
    This create a mapping file under the `src/test/dw` folder to test your module, which isn’t meant
    to be shared or reused.

![Create Integration Mapping button above the .dwl file](/mulesoft/current/en-us/dataweave/2.6/_images/dataweave-extension-preview-1.png)

5.  Either preview the module function by one of these options:

    - Click the **DataWeave: Run Preview** button (arrow icon) at the top right corner of your
      module `.dwl` file.

      ![DataWeave: Run Preview button](/mulesoft/current/en-us/dataweave/2.6/_images/dataweave-extension-preview-2.png)

    - Right-click the editor and select **DataWeave: Enable AutoPreview** to run it on every file
      change.

      ![DataWeave: Enable AutoPreview option](/mulesoft/current/en-us/dataweave/2.6/_images/dataweave-extension-preview-3.png)

## Test a DataWeave Module

There’re two ways to test your module:

- By running a unit test

- By creating a test mapping located in your `src/test/dw` folder to avoid exposing the test to
  consumers of your module

The tests use functions of the modules `dw::test::Tests` and `dw::test::Asserts` provided by the
artifact `org.mule.weave:data-weave-testing-framework` of the
[DataWeave Testing Framework](https://docs.mulesoft.com/dataweave/2.6/dataweave-testing-framework).

To generate a unit test for a DataWeave module, follow these steps:

1.  In Visual Studio Code, open your DataWeave project.

2.  Navigate to the `src/main/dw` folder.

3.  Select your module `.dwl` file.

4.  In your module `.dwl` file, click the **Add Unit Test** button located above your function.

    ![MyModule.dwl file showing the function and the Add Unit Test button](/mulesoft/current/en-us/dataweave/2.6/_images/dataweave-extension-testmodule-1.png)

This behavior generates:

- A new `.dwl` test file in `src/test/dw` that describes test cases and tests suites for the module.

  - A test case is a single test with the evaluation and assertion of the result.

  - A test suite groups tests with a name that better describes the intention of some related cases.

    The test file defines a test case for the function that you call with specific arguments and use
    to make assertions over the output.

- A new test case within a test suite for the function. If not present, the test suite is also
  created.

![MyModuleTest.dwl file in the src/test/dw folder](/mulesoft/current/en-us/dataweave/2.6/_images/dataweave-extension-testmodule-2.png)

To run the test:

1.  In Visual Studio Code, go to the **TESTING** view.

2.  Select the dropdown arrows of your module test file.

3.  Click the **Run Test** arrow button.

![MyModuleTest file in the TESTING TAB and Run Test button](/mulesoft/current/en-us/dataweave/2.6/_images/dataweave-extension-testmodule-3.png)

## Create a DataWeave Mapping

A DataWeave mapping is a `.dwl` file that enables you to map and connect to anything, regardless of
data type or structure. As when using a DataWeave module, you can use a mapping to define functions,
variables, types, and namespaces, but you can additionally specify a body section after the
separator `---`.

Unlike a DataWeave module file, a DataWeave mapping file is an executable unit that enables you to
transform zero or more inputs into a single output. Using the DataWeave extension, you can develop
these files to create reusable assets that you can deploy and share with others.

To create a new DataWeave mapping, follow these steps:

1.  In Visual Studio Code, click **View > Command Palette**.

2.  In the search bar, type `dataweave`.

3.  Select **DataWeave: Create New Mapping**.

    ![Command Palette with DataWeave: Create new mapping selected](/mulesoft/current/en-us/dataweave/2.6/_images/dataweave-extension-createmapping.png)

4.  Add a name for the new mapping `dwl` file and press enter.  
    This creates a new mapping `.dwl` file under the `src/main/dw` folder.

### Define Sample Data for DataWeave Mappings

Generate multiple sample data inputs for your mapping by clicking the **Define Sample Data** button
at the top of your mapping `.dwl` file. Sample data is a key part of DataWeave project development
to run your mappings.

To define sample data, follow these steps:

1.  In Visual Studio Code, open your DataWeave project.

2.  Navigate to the `src/main/dw` folder.

3.  Select your mapping `.dwl` file.

4.  Click the **Define Sample Data** button located above your mapping `.dwl` file.

    ![MyMapping.dwl file with Define Sample Data button](/mulesoft/current/en-us/dataweave/2.6/_images/dataweave-extension-sampledata-1.png)

5.  Specify the name for the sample data file and press enter.

Using sample data generates a DataWeave _scenario_ that contains all the resources required to run
the mapping in the context of that scenario.

![Generated new sample data payload.json file as input for the MyMapping.dwl file](/mulesoft/current/en-us/dataweave/2.6/_images/dataweave-extension-sampledata-2.png)

## Understanding DataWeave Scenarios

A DataWeave _scenario_ is a group of inputs and outputs that you can inject into your mapping either
to try out in the **Preview Output** view or to test your mapping using the input to evaluate it and
compare its output with the desired saved output of your scenario. Scenarios also provide
autocompletion based on the input structures.

These scenarios and their resources live in the `src/test/resources` folder and have the following
structure:

```none
├── src/test/resources
│       └── MyMapping //Contains the different scenarios for your mapping called "MyMapping"
│           ├── default //Name of your scenario
│           │   └── inputs //Folder where all of your inputs live
│           │   │   └── payload.json //Input for your mapping (you can use it in your script, naming it to be the same as the name of the file without the file's extension)
│           │   │   └── vars //Folder that represents a name for your input variable in your script: in this case vars
│           │   │       └── test.json //Input for your mapping (you can use it in your script, calling it vars.test)
│           │   └── out.json // Expected output of your mapping running against your inputs (only present when testing)
│           └── SavedTestScenario //Another scenario used for the integration test
```

### Using the DataWeave Scenarios View

The **DATAWEAVE SCENARIOS** view shows the available scenarios for the `.dwl` file. In this view,
you can add, remove, or set the active scenario that is used for your preview execution, or you can
choose that the values be autocompleted.

![DataWeave Scenarios view in Visual Studio Code](/mulesoft/current/en-us/dataweave/2.6/_images/dataweave-extension-dataweavescenario.png)

### Using Reader Properties for Inputs

If you want to set different reader properties to the inputs you use, create a properties file with
the suffix `{fileName}-config.properties` in the same directory of your input. For example, if your
input is called `payload.csv` then create a `payload-config.properties` file that contains all the
reader properties required to run your scenario. Creating the properties file also applies while
testing your DataWeave mappings.

## Preview a DataWeave Mapping

After you define sample data, get feedback on how your mapping is working by previewing the output.

1.  In Visual Studio Code, open your DataWeave project.

2.  Navigate to the `src/main/dw` folder.

3.  Select your module `.dwl` file.

4.  Either preview the mapping function by one of these options:

    - Click the **DataWeave: Run Preview** button (arrow icon) at the top right corner of your
      mapping `.dwl` file.

    - Right-click the editor and select **DataWeave: Enable AutoPreview** to run it on every file
      change.

## Run and Debug a DataWeave Mapping

Run and debug a DataWeave mapping to be guided through all of the mapping elements, which you can
then fix or otherwise update. You can also set breakpoints to stop evaluating expressions and use
all the debugging capabilities that Visual Studio Code provides. Debugging works on mapping tests as
well.

To run and debug a DataWeave mapping, follow these steps:

1.  In Visual Studio Code, open your DataWeave project.

2.  Navigate to the `src/main/dw` folder.

3.  Select your mapping `.dwl` file.

4.  Click the **Run Mapping** button located at the top of your `.dwl` file.

    ![MyMapping.dwl and Run Mapping button](/mulesoft/current/en-us/dataweave/2.6/_images/dataweave-extension-runmapping.png)

## Test a DataWeave Mapping

To test a DataWeave mapping, click the **Dataweave: Create Mapping Test** button located at the top
of your `.dwl` file to create a new test scenario from a snapshot of your input and your current
output. You can also use this newly created scenario as a normal scenario for your preview or
autocompletion.

To test a DataWeave mapping, follow these steps:

1.  In Visual Studio Code, open your DataWeave project.

2.  Navigate to the `src/main/dw` folder.

3.  Click the **DataWeave: Create Mapping Test** button (microscope icon) located at the top of your
    mapping `.dwl` file.

    ![MyMapping.dwl file and the DataWeave Create Mapping Test button](/mulesoft/current/en-us/dataweave/2.6/_images/dataweave-extension-testmapping.png)

4.  Specify a name for the mapping test and press enter.

This creates a new mapping test `.dwl` file:

![MyMappingTest.dwl file](/mulesoft/current/en-us/dataweave/2.6/_images/dataweave-extension-testmapping-2.png)

## Using the DataWeave Dependencies View

The **DATAWEAVE DEPENDENCIES** view shows all the dependencies resolved for a DataWeave project. The
view enables you to navigate through all of your project’s dependencies and open DataWeave files
inside those dependencies.

![DataWeave Dependencies View](/mulesoft/current/en-us/dataweave/2.6/_images/dataweave-extension-dataweavedependencies.png)

## Deploy DataWeave Libraries

Before deploying your DataWeave library to Anypoint Exchange, generate documentation for your
mapping or module functions. When you deploy your DataWeave library to Exchange, the documentation
is also published to the Exchange library page.

To generate documentation for the functions, follow these steps:

1.  In Visual Studio Code, open your DataWeave project.

2.  Navigate to the `src/main/dw` folder.

3.  Click the **Generate Weave Documentation** button located at the top of the function in the
    `.dwl` file.

    ![MyMapping.dwl file and the Generate Weave Documentation button](/mulesoft/current/en-us/dataweave/2.6/_images/dataweave-extension-generatedocs-1.png)

The documentation template appears as a comment above the function:

![Auto-generated documentation located above the function](/mulesoft/current/en-us/dataweave/2.6/_images/dataweave-extension-generatedocs-2.png)

To deploy a DataWeave library to Exchange:

1.  In Visual Studio Code, open your DataWeave project.

2.  Open and configure your `pom.xml` file.

    1.  Ensure that your `groupId` is set to your `organization ID`.

    2.  Add the Maven facade as a repository within the `<distributionManagement>` element.

        ![Maven facade in <distributionManagement> element](/mulesoft/current/en-us/dataweave/2.6/_images/dataweave-extension-mavenfacade.png)

3.  Update the `settings.xml` file in your Maven `.m2` directory with your Anypoint Platform
    credentials.

    For guidance, refer to the
    [Publish an Asset to Exchange Using Maven](https://docs.mulesoft.com/dataweave/2.6/exchange/to-publish-assets-maven#publish-an-asset-to-exchange-using-maven guide>)
    documentation.

4.  Execute the Maven `deploy` command to upload the DataWeave library to the deployment target and
    the auto-generated documentation to Exchange.

    For guidance, refer to the [DataWeave Maven Plugin](https://docs.mulesoft.com/dataweave/2.6/dataweave-maven-plugin) documentation.

## Consume DataWeave Libraries

After deploying your DataWeave library to Exchange, the library appears as an asset for your
organization in the Exchange marketplace.

To consume the DataWeave library:

1.  Add the library’s group ID, artifact ID, version, and classifier to the `dependencies` element
    in your project’s `pom.xml` file.

    You can copy the dependency snippet from Exchange.

2.  Add the Maven facade as a repository in the `repositories` section.

For more details, refer to the
[Publish and Consume Federated Assets](https://docs.mulesoft.com/exchange/to-publish-assets-maven#publish-and-consume-federated-assets)
documentation.

## DataWeave Extension Language Edition Features

The Language Edition features of the DataWeave extension include completion, navigation, code
editing, and code inspection.

### Completion

The completion feature enables you to autocomplete content for any visible functions, variables, or
types. The feature also suggests fields based on the type inference.

![Completion Feature sample](/mulesoft/current/en-us/dataweave/2.6/_images/dataweave-extension-completion.png)

### Navigation

You can navigate to any local definition or from any imported library.

### Code Editing Features

The following features help you to easily code in Visual Studio Code:

- Find all references

- Refactors (local and cross files)

- Quick fixes:

  - Auto import when a function is present in a module

  - Create a function, variable, or type when one isn’t found

- Outline

- Show parameters information

- Hover information with documentation

![Auto Import Feature sample](/mulesoft/current/en-us/dataweave/2.6/_images/dataweave-extension-autoimport.png)

### Code Inspections

The DataWeave extension tries to detect and suggest replacements for idioms in expressions, as shown
in the following examples:

- Default Value

![Default Value Code Inspection sample](/mulesoft/current/en-us/dataweave/2.6/_images/dataweave-extension-defaultvalue.png)

- TypeOf

![TypeOf Code Inspection sample](/mulesoft/current/en-us/dataweave/2.6/_images/dataweave-extension-typeof.png)

- IsEmpty

![Is Empty Code Inspection sample](/mulesoft/current/en-us/dataweave/2.6/_images/dataweave-extension-isempty.png)

## DataWeave Extension Troubleshooting Logs

If an error occurs while you’re working with the DataWeave Extension, check the logs output of the
DataWeave Language Server that provide details of what can cause the issue:

To check the logs, follow these steps:

1.  In Visual Studio Code, navigate to **View > Output** to open the **OUTPUT** view in the Visual
    Studio Code editor window.

2.  In the drop-down menu located on the left of the screen editor, select **Mule DX DataWeave LS**
    to show the logs.

![Mule DX DataWeave LS option to select in the drop-down menu of the Output](/mulesoft/current/en-us/dataweave/2.6/_images/dataweave-extension-logs.png)

## See Also

- [DataWeave Extension](https://docs.mulesoft.com/dataweave/2.6/dataweave-extension)

- [DataWeave Maven Plugin](https://docs.mulesoft.com/dataweave/2.6/dataweave-maven-plugin)

- [DataWeave Testing Framework](https://docs.mulesoft.com/dataweave/2.6/dataweave-testing-framework)

<!-- document id=16db27ec51a7ef5fd965663834d75a08813b521c9642fb902df7fa59cca0d541 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-extension-plugin.md -->

---
product: DataWeave
version: 2.9
---

# Installing and Using the DataWeave Extension

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Install and use DataWeave extension in Visual Studio Code (DataWeave extension) to develop, preview,
test, and deploy custom mappings and modules into libraries in a DataWeave project. The extension
also enables you to preview transformations similar to those you perform in the
[DataWeave Playground](https://dataweave.mulesoft.com/learn/).

## Before You Begin

Before installing the DataWeave extension to Visual Studio Code, you must:

- Install AdoptOpenJDK

- Install Apache Maven (3.6.3 minimum)

- Install Microsoft Visual Studio Code for your specific operating system

> [!NOTE] If you have any other prior extensions for DataWeave, whether experimental or from a third
> party, uninstall them.

## Install the DataWeave Extension

To install the extension:

1.  Open Visual Studio Code.

2.  In the **EXTENSIONS** tab, type `dataweave` to search the extension in the marketplace.

3.  Select **Anypoint Code Builder - DataWeave Extension** from the search results.

4.  Click **Install**.

    ![DataWeave extension installation](/mulesoft/current/en-us/dataweave/2.9/_images/dataweave-extension-plugin-install.png)

5.  After the installation finishes, restart Visual Studio Code.

## Developing DataWeave Libraries

A DataWeave library is a reusable package of DataWeave module and mapping files, and resource files,
such as JSON, XML, and CSV. To develop DataWeave libraries, first create a new DataWeave project in
Visual Studio Code where you then create, preview, and test custom mappings and modules.

If you want to try out your mapping without creating a DataWeave project, you can either open your
`.dwl` mapping file directly in Visual Studio Code or create a new one and use
[sample data](#sample-data) and [scenarios](#scenarios).

### Understanding the DataWeave Project Structure

DataWeave projects use Apache Maven to build and declare project dependencies. The following diagram
shows the DataWeave project structure:

```none
├── src
│   ├── main
│   │   ├── dw // Put your DataWeave mappings and module files here
│   │   │   ├── MyMapping.dwl
|   |   |   └── MyModule.dwl
│   │   └── resources
│   └── test
│       ├── dw
│       │   └── MyModuleTest.dwl  //Unit tests for the functions in your module
│       │   └── MyMappingTest.dwl //Integration test for your mapping using the saved scenarios
│       ├── resources
│       │       └── MyMapping //Contains the different scenarios for your mapping
│       │           ├── default
│       │           │   └── inputs
│       │           │       └── payload.json //[Sample data](#sample-data) for your mappings
│       │           └── SavedTestScenario //Scenario used for the integration test
├── pom.xml
```

### Create a DataWeave Project

To create a new project:

1.  Open Visual Studio Code.

2.  Click **View > Command Palette**.

3.  In the search bar, type `dataweave`.

4.  Select **DataWeave: Create New Library Project**.

    ![Command Palette with DataWeave: Create New Library Project option selected](/mulesoft/current/en-us/dataweave/2.9/_images/dataweave-extension-new-project.png)

5.  Follow prompts to complete an initial configuration for your project:

    1.  **Organization ID** (Group ID)

    2.  **Artifact ID**

    3.  **Version**

    4.  **Project name**

6.  Choose a directory folder for your new project.

7.  Select **OK**.

8.  When prompted, select **Yes** or **No** whether you want to open the project in a new Visual
    Studio Code window.

The following image shows a new DataWeave project in Visual Studio Code:

![DataWeave project example window](/mulesoft/current/en-us/dataweave/2.9/_images/dataweave-extension-new-project-sample.png)

When creating a DataWeave project, the DataWeave extension requires all dependencies to be loaded
and indexed before it can search the libraries and make them available in your project. Visual
Studio Code provides a notification bar at the bottom of the screen editor that shows when the
dependencies are loading and when the indexing is complete.

![Dependencies loading and indexing](/mulesoft/current/en-us/dataweave/2.9/_images/dataweave-extension-dependencies.png)

## Create a DataWeave Module

DataWeave modules are `.dwl` files that define functions, variables, types, and namespaces. These
files cannot contain output directives, body expressions, or `---` separators between header and
body sections. A DataWeave module enables you to share all the content defined in the `.dwl` file
for reuse.

To create a new DataWeave module:

1.  In Visual Studio Code, click **View > Command Palette**.

2.  In the search bar, type `dataweave`.

3.  Select **DataWeave: Create New Module**.

    ![Command Palette with DataWeave: Create new module option selected](/mulesoft/current/en-us/dataweave/2.9/_images/dataweave-extension-createmodule.png)

4.  Add a name for the new module `dwl` file and press enter.  
    This creates a new module `.dwl` file under the `src/main/dw` folder.

## Preview a DataWeave Module

For a better development experience, you can use the _preview_ view to develop your module’s
functions. The _preview_ view lets you get instant feedback on how a mapping file is working by
previewing its output. Use this view to develop the module’s functions by creating a DataWeave
mapping inside the `src/test/dw` folder that imports your functions and calls them to check how
they’re currently working.

To preview the module functionality, follow these steps:

1.  In Visual Studio Code, open your DataWeave project.

2.  Navigate to the `src/main/dw` folder.

3.  Select your module `.dwl` file.

4.  Click the **Create Integration Mapping** button located at the top of your module `.dwl` file.  
    This create a mapping file under the `src/test/dw` folder to test your module, which isn’t meant
    to be shared or reused.

![Create Integration Mapping button above the .dwl file](/mulesoft/current/en-us/dataweave/2.9/_images/dataweave-extension-preview-1.png)

5.  Either preview the module function by one of these options:

    - Click the **DataWeave: Run Preview** button (arrow icon) at the top right corner of your
      module `.dwl` file.

      ![DataWeave: Run Preview button](/mulesoft/current/en-us/dataweave/2.9/_images/dataweave-extension-preview-2.png)

    - Right-click the editor and select **DataWeave: Enable AutoPreview** to run it on every file
      change.

      ![DataWeave: Enable AutoPreview option](/mulesoft/current/en-us/dataweave/2.9/_images/dataweave-extension-preview-3.png)

## Test a DataWeave Module

There’re two ways to test your module:

- By running a unit test

- By creating a test mapping located in your `src/test/dw` folder to avoid exposing the test to
  consumers of your module

The tests use functions of the modules `dw::test::Tests` and `dw::test::Asserts` provided by the
artifact `org.mule.weave:data-weave-testing-framework` of the
[DataWeave Testing Framework](https://docs.mulesoft.com/dataweave/2.9/dataweave-testing-framework).

To generate a unit test for a DataWeave module, follow these steps:

1.  In Visual Studio Code, open your DataWeave project.

2.  Navigate to the `src/main/dw` folder.

3.  Select your module `.dwl` file.

4.  In your module `.dwl` file, click the **Add Unit Test** button located above your function.

    ![MyModule.dwl file showing the function and the Add Unit Test button](/mulesoft/current/en-us/dataweave/2.9/_images/dataweave-extension-testmodule-1.png)

This behavior generates:

- A new `.dwl` test file in `src/test/dw` that describes test cases and tests suites for the module.

  - A test case is a single test with the evaluation and assertion of the result.

  - A test suite groups tests with a name that better describes the intention of some related cases.

    The test file defines a test case for the function that you call with specific arguments and use
    to make assertions over the output.

- A new test case within a test suite for the function. If not present, the test suite is also
  created.

![MyModuleTest.dwl file in the src/test/dw folder](/mulesoft/current/en-us/dataweave/2.9/_images/dataweave-extension-testmodule-2.png)

To run the test:

1.  In Visual Studio Code, go to the **TESTING** view.

2.  Select the dropdown arrows of your module test file.

3.  Click the **Run Test** arrow button.

![MyModuleTest file in the TESTING TAB and Run Test button](/mulesoft/current/en-us/dataweave/2.9/_images/dataweave-extension-testmodule-3.png)

## Create a DataWeave Mapping

A DataWeave mapping is a `.dwl` file that enables you to map and connect to anything, regardless of
data type or structure. As when using a DataWeave module, you can use a mapping to define functions,
variables, types, and namespaces, but you can additionally specify a body section after the
separator `---`.

Unlike a DataWeave module file, a DataWeave mapping file is an executable unit that enables you to
transform zero or more inputs into a single output. Using the DataWeave extension, you can develop
these files to create reusable assets that you can deploy and share with others.

To create a new DataWeave mapping, follow these steps:

1.  In Visual Studio Code, click **View > Command Palette**.

2.  In the search bar, type `dataweave`.

3.  Select **DataWeave: Create New Mapping**.

    ![Command Palette with DataWeave: Create new mapping selected](/mulesoft/current/en-us/dataweave/2.9/_images/dataweave-extension-createmapping.png)

4.  Add a name for the new mapping `dwl` file and press enter.  
    This creates a new mapping `.dwl` file under the `src/main/dw` folder.

### Define Sample Data for DataWeave Mappings

Generate multiple sample data inputs for your mapping by clicking the **Define Sample Data** button
at the top of your mapping `.dwl` file. Sample data is a key part of DataWeave project development
to run your mappings.

To define sample data, follow these steps:

1.  In Visual Studio Code, open your DataWeave project.

2.  Navigate to the `src/main/dw` folder.

3.  Select your mapping `.dwl` file.

4.  Click the **Define Sample Data** button located above your mapping `.dwl` file.

    ![MyMapping.dwl file with Define Sample Data button](/mulesoft/current/en-us/dataweave/2.9/_images/dataweave-extension-sampledata-1.png)

5.  Specify the name for the sample data file and press enter.

Using sample data generates a DataWeave _scenario_ that contains all the resources required to run
the mapping in the context of that scenario.

![Generated new sample data payload.json file as input for the MyMapping.dwl file](/mulesoft/current/en-us/dataweave/2.9/_images/dataweave-extension-sampledata-2.png)

## Understanding DataWeave Scenarios

A DataWeave _scenario_ is a group of inputs and outputs that you can inject into your mapping either
to try out in the **Preview Output** view or to test your mapping using the input to evaluate it and
compare its output with the desired saved output of your scenario. Scenarios also provide
autocompletion based on the input structures.

These scenarios and their resources live in the `src/test/resources` folder and have the following
structure:

```none
├── src/test/resources
│       └── MyMapping //Contains the different scenarios for your mapping called "MyMapping"
│           ├── default //Name of your scenario
│           │   └── inputs //Folder where all of your inputs live
│           │   │   └── payload.json //Input for your mapping (you can use it in your script, naming it to be the same as the name of the file without the file's extension)
│           │   │   └── vars //Folder that represents a name for your input variable in your script: in this case vars
│           │   │       └── test.json //Input for your mapping (you can use it in your script, calling it vars.test)
│           │   └── out.json // Expected output of your mapping running against your inputs (only present when testing)
│           └── SavedTestScenario //Another scenario used for the integration test
```

### Using the DataWeave Scenarios View

The **DATAWEAVE SCENARIOS** view shows the available scenarios for the `.dwl` file. In this view,
you can add, remove, or set the active scenario that is used for your preview execution, or you can
choose that the values be autocompleted.

![DataWeave Scenarios view in Visual Studio Code](/mulesoft/current/en-us/dataweave/2.9/_images/dataweave-extension-dataweavescenario.png)

### Using Reader Properties for Inputs

If you want to set different reader properties to the inputs you use, create a properties file with
the suffix `{fileName}-config.properties` in the same directory of your input. For example, if your
input is called `payload.csv` then create a `payload-config.properties` file that contains all the
reader properties required to run your scenario. Creating the properties file also applies while
testing your DataWeave mappings.

## Preview a DataWeave Mapping

After you define sample data, get feedback on how your mapping is working by previewing the output.

1.  In Visual Studio Code, open your DataWeave project.

2.  Navigate to the `src/main/dw` folder.

3.  Select your module `.dwl` file.

4.  Either preview the mapping function by one of these options:

    - Click the **DataWeave: Run Preview** button (arrow icon) at the top right corner of your
      mapping `.dwl` file.

    - Right-click the editor and select **DataWeave: Enable AutoPreview** to run it on every file
      change.

## Run and Debug a DataWeave Mapping

Run and debug a DataWeave mapping to be guided through all of the mapping elements, which you can
then fix or otherwise update. You can also set breakpoints to stop evaluating expressions and use
all the debugging capabilities that Visual Studio Code provides. Debugging works on mapping tests as
well.

To run and debug a DataWeave mapping, follow these steps:

1.  In Visual Studio Code, open your DataWeave project.

2.  Navigate to the `src/main/dw` folder.

3.  Select your mapping `.dwl` file.

4.  Click the **Run Mapping** button located at the top of your `.dwl` file.

    ![MyMapping.dwl and Run Mapping button](/mulesoft/current/en-us/dataweave/2.9/_images/dataweave-extension-runmapping.png)

## Test a DataWeave Mapping

To test a DataWeave mapping, click the **Dataweave: Create Mapping Test** button located at the top
of your `.dwl` file to create a new test scenario from a snapshot of your input and your current
output. You can also use this newly created scenario as a normal scenario for your preview or
autocompletion.

To test a DataWeave mapping, follow these steps:

1.  In Visual Studio Code, open your DataWeave project.

2.  Navigate to the `src/main/dw` folder.

3.  Click the **DataWeave: Create Mapping Test** button (microscope icon) located at the top of your
    mapping `.dwl` file.

    ![MyMapping.dwl file and the DataWeave Create Mapping Test button](/mulesoft/current/en-us/dataweave/2.9/_images/dataweave-extension-testmapping.png)

4.  Specify a name for the mapping test and press enter.

This creates a new mapping test `.dwl` file:

![MyMappingTest.dwl file](/mulesoft/current/en-us/dataweave/2.9/_images/dataweave-extension-testmapping-2.png)

## Using the DataWeave Dependencies View

The **DATAWEAVE DEPENDENCIES** view shows all the dependencies resolved for a DataWeave project. The
view enables you to navigate through all of your project’s dependencies and open DataWeave files
inside those dependencies.

![DataWeave Dependencies View](/mulesoft/current/en-us/dataweave/2.9/_images/dataweave-extension-dataweavedependencies.png)

## Deploy DataWeave Libraries

Before deploying your DataWeave library to Anypoint Exchange, generate documentation for your
mapping or module functions. When you deploy your DataWeave library to Exchange, the documentation
is also published to the Exchange library page.

To generate documentation for the functions, follow these steps:

1.  In Visual Studio Code, open your DataWeave project.

2.  Navigate to the `src/main/dw` folder.

3.  Click the **Generate Weave Documentation** button located at the top of the function in the
    `.dwl` file.

    ![MyMapping.dwl file and the Generate Weave Documentation button](/mulesoft/current/en-us/dataweave/2.9/_images/dataweave-extension-generatedocs-1.png)

The documentation template appears as a comment above the function:

![Auto-generated documentation located above the function](/mulesoft/current/en-us/dataweave/2.9/_images/dataweave-extension-generatedocs-2.png)

To deploy a DataWeave library to Exchange:

1.  In Visual Studio Code, open your DataWeave project.

2.  Open and configure your `pom.xml` file.

    1.  Ensure that your `groupId` is set to your `organization ID`.

    2.  Add the Maven facade as a repository within the `<distributionManagement>` element.

        ![Maven facade in <distributionManagement> element](/mulesoft/current/en-us/dataweave/2.9/_images/dataweave-extension-mavenfacade.png)

3.  Update the `settings.xml` file in your Maven `.m2` directory with your Anypoint Platform
    credentials.

    For guidance, refer to the
    [Publish an Asset to Exchange Using Maven](https://docs.mulesoft.com/dataweave/2.9/exchange/to-publish-assets-maven#publish-an-asset-to-exchange-using-maven guide>)
    documentation.

4.  Execute the Maven `deploy` command to upload the DataWeave library to the deployment target and
    the auto-generated documentation to Exchange.

    For guidance, refer to the [DataWeave Maven Plugin](https://docs.mulesoft.com/dataweave/2.9/dataweave-maven-plugin) documentation.

## Consume DataWeave Libraries

After deploying your DataWeave library to Exchange, the library appears as an asset for your
organization in the Exchange marketplace.

To consume the DataWeave library:

1.  Add the library’s group ID, artifact ID, version, and classifier to the `dependencies` element
    in your project’s `pom.xml` file.

    You can copy the dependency snippet from Exchange.

2.  Add the Maven facade as a repository in the `repositories` section.

For more details, refer to the
[Publish and Consume Federated Assets](https://docs.mulesoft.com/exchange/to-publish-assets-maven#publish-and-consume-federated-assets)
documentation.

## DataWeave Extension Language Edition Features

The Language Edition features of the DataWeave extension include completion, navigation, code
editing, and code inspection.

### Completion

The completion feature enables you to autocomplete content for any visible functions, variables, or
types. The feature also suggests fields based on the type inference.

![Completion Feature sample](/mulesoft/current/en-us/dataweave/2.9/_images/dataweave-extension-completion.png)

### Navigation

You can navigate to any local definition or from any imported library.

### Code Editing Features

The following features help you to easily code in Visual Studio Code:

- Find all references

- Refactors (local and cross files)

- Quick fixes:

  - Auto import when a function is present in a module

  - Create a function, variable, or type when one isn’t found

- Outline

- Show parameters information

- Hover information with documentation

![Auto Import Feature sample](/mulesoft/current/en-us/dataweave/2.9/_images/dataweave-extension-autoimport.png)

### Code Inspections

The DataWeave extension tries to detect and suggest replacements for idioms in expressions, as shown
in the following examples:

- Default Value

![Default Value Code Inspection sample](/mulesoft/current/en-us/dataweave/2.9/_images/dataweave-extension-defaultvalue.png)

- TypeOf

![TypeOf Code Inspection sample](/mulesoft/current/en-us/dataweave/2.9/_images/dataweave-extension-typeof.png)

- IsEmpty

![Is Empty Code Inspection sample](/mulesoft/current/en-us/dataweave/2.9/_images/dataweave-extension-isempty.png)

## DataWeave Extension Troubleshooting Logs

If an error occurs while you’re working with the DataWeave Extension, check the logs output of the
DataWeave Language Server that provide details of what can cause the issue:

To check the logs, follow these steps:

1.  In Visual Studio Code, navigate to **View > Output** to open the **OUTPUT** view in the Visual
    Studio Code editor window.

2.  In the drop-down menu located on the left of the screen editor, select **Mule DX DataWeave LS**
    to show the logs.

![Mule DX DataWeave LS option to select in the drop-down menu of the Output](/mulesoft/current/en-us/dataweave/2.9/_images/dataweave-extension-logs.png)

## See Also

- [DataWeave Extension](https://docs.mulesoft.com/dataweave/2.9/dataweave-extension)

- [DataWeave Maven Plugin](https://docs.mulesoft.com/dataweave/2.9/dataweave-maven-plugin)

- [DataWeave Testing Framework](https://docs.mulesoft.com/dataweave/2.9/dataweave-testing-framework)

<!-- document id=7c5b343d71b312fa1c11c179285f4029fc8ae1d57925d80ea587f85ad553919f url=/mulesoft/current/en-us/dataweave/latest/dataweave-extension-plugin.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Installing and Using the DataWeave Extension

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Install and use DataWeave extension in Visual Studio Code (DataWeave extension) to develop, preview,
test, and deploy custom mappings and modules into libraries in a DataWeave project. The extension
also enables you to preview transformations similar to those you perform in the
[DataWeave Playground](https://dataweave.mulesoft.com/learn/).

## Before You Begin

Before installing the DataWeave extension to Visual Studio Code, you must:

- Install AdoptOpenJDK

- Install Apache Maven (3.6.3 minimum)

- Install Microsoft Visual Studio Code for your specific operating system

> [!NOTE] If you have any other prior extensions for DataWeave, whether experimental or from a third
> party, uninstall them.

## Install the DataWeave Extension

To install the extension:

1.  Open Visual Studio Code.

2.  In the **EXTENSIONS** tab, type `dataweave` to search the extension in the marketplace.

3.  Select **Anypoint Code Builder - DataWeave Extension** from the search results.

4.  Click **Install**.

    ![DataWeave extension installation](/mulesoft/current/en-us/dataweave/latest/_images/dataweave-extension-plugin-install.png)

5.  After the installation finishes, restart Visual Studio Code.

## Developing DataWeave Libraries

A DataWeave library is a reusable package of DataWeave module and mapping files, and resource files,
such as JSON, XML, and CSV. To develop DataWeave libraries, first create a new DataWeave project in
Visual Studio Code where you then create, preview, and test custom mappings and modules.

If you want to try out your mapping without creating a DataWeave project, you can either open your
`.dwl` mapping file directly in Visual Studio Code or create a new one and use
[sample data](#sample-data) and [scenarios](#scenarios).

### Understanding the DataWeave Project Structure

DataWeave projects use Apache Maven to build and declare project dependencies. The following diagram
shows the DataWeave project structure:

```none
├── src
│   ├── main
│   │   ├── dw // Put your DataWeave mappings and module files here
│   │   │   ├── MyMapping.dwl
|   |   |   └── MyModule.dwl
│   │   └── resources
│   └── test
│       ├── dw
│       │   └── MyModuleTest.dwl  //Unit tests for the functions in your module
│       │   └── MyMappingTest.dwl //Integration test for your mapping using the saved scenarios
│       ├── resources
│       │       └── MyMapping //Contains the different scenarios for your mapping
│       │           ├── default
│       │           │   └── inputs
│       │           │       └── payload.json //[Sample data](#sample-data) for your mappings
│       │           └── SavedTestScenario //Scenario used for the integration test
├── pom.xml
```

### Create a DataWeave Project

To create a new project:

1.  Open Visual Studio Code.

2.  Click **View > Command Palette**.

3.  In the search bar, type `dataweave`.

4.  Select **DataWeave: Create New Library Project**.

    ![Command Palette with DataWeave: Create New Library Project option selected](/mulesoft/current/en-us/dataweave/latest/_images/dataweave-extension-new-project.png)

5.  Follow prompts to complete an initial configuration for your project:

    1.  **Organization ID** (Group ID)

    2.  **Artifact ID**

    3.  **Version**

    4.  **Project name**

6.  Choose a directory folder for your new project.

7.  Select **OK**.

8.  When prompted, select **Yes** or **No** whether you want to open the project in a new Visual
    Studio Code window.

The following image shows a new DataWeave project in Visual Studio Code:

![DataWeave project example window](/mulesoft/current/en-us/dataweave/latest/_images/dataweave-extension-new-project-sample.png)

When creating a DataWeave project, the DataWeave extension requires all dependencies to be loaded
and indexed before it can search the libraries and make them available in your project. Visual
Studio Code provides a notification bar at the bottom of the screen editor that shows when the
dependencies are loading and when the indexing is complete.

![Dependencies loading and indexing](/mulesoft/current/en-us/dataweave/latest/_images/dataweave-extension-dependencies.png)

## Create a DataWeave Module

DataWeave modules are `.dwl` files that define functions, variables, types, and namespaces. These
files cannot contain output directives, body expressions, or `---` separators between header and
body sections. A DataWeave module enables you to share all the content defined in the `.dwl` file
for reuse.

To create a new DataWeave module:

1.  In Visual Studio Code, click **View > Command Palette**.

2.  In the search bar, type `dataweave`.

3.  Select **DataWeave: Create New Module**.

    ![Command Palette with DataWeave: Create new module option selected](/mulesoft/current/en-us/dataweave/latest/_images/dataweave-extension-createmodule.png)

4.  Add a name for the new module `dwl` file and press enter.  
    This creates a new module `.dwl` file under the `src/main/dw` folder.

## Preview a DataWeave Module

For a better development experience, you can use the _preview_ view to develop your module’s
functions. The _preview_ view lets you get instant feedback on how a mapping file is working by
previewing its output. Use this view to develop the module’s functions by creating a DataWeave
mapping inside the `src/test/dw` folder that imports your functions and calls them to check how
they’re currently working.

To preview the module functionality, follow these steps:

1.  In Visual Studio Code, open your DataWeave project.

2.  Navigate to the `src/main/dw` folder.

3.  Select your module `.dwl` file.

4.  Click the **Create Integration Mapping** button located at the top of your module `.dwl` file.  
    This create a mapping file under the `src/test/dw` folder to test your module, which isn’t meant
    to be shared or reused.

![Create Integration Mapping button above the .dwl file](/mulesoft/current/en-us/dataweave/latest/_images/dataweave-extension-preview-1.png)

5.  Either preview the module function by one of these options:

    - Click the **DataWeave: Run Preview** button (arrow icon) at the top right corner of your
      module `.dwl` file.

      ![DataWeave: Run Preview button](/mulesoft/current/en-us/dataweave/latest/_images/dataweave-extension-preview-2.png)

    - Right-click the editor and select **DataWeave: Enable AutoPreview** to run it on every file
      change.

      ![DataWeave: Enable AutoPreview option](/mulesoft/current/en-us/dataweave/latest/_images/dataweave-extension-preview-3.png)

## Test a DataWeave Module

There’re two ways to test your module:

- By running a unit test

- By creating a test mapping located in your `src/test/dw` folder to avoid exposing the test to
  consumers of your module

The tests use functions of the modules `dw::test::Tests` and `dw::test::Asserts` provided by the
artifact `org.mule.weave:data-weave-testing-framework` of the
[DataWeave Testing Framework](https://docs.mulesoft.com/dataweave/latest/dataweave-testing-framework).

To generate a unit test for a DataWeave module, follow these steps:

1.  In Visual Studio Code, open your DataWeave project.

2.  Navigate to the `src/main/dw` folder.

3.  Select your module `.dwl` file.

4.  In your module `.dwl` file, click the **Add Unit Test** button located above your function.

    ![MyModule.dwl file showing the function and the Add Unit Test button](/mulesoft/current/en-us/dataweave/latest/_images/dataweave-extension-testmodule-1.png)

This behavior generates:

- A new `.dwl` test file in `src/test/dw` that describes test cases and tests suites for the module.

  - A test case is a single test with the evaluation and assertion of the result.

  - A test suite groups tests with a name that better describes the intention of some related cases.

    The test file defines a test case for the function that you call with specific arguments and use
    to make assertions over the output.

- A new test case within a test suite for the function. If not present, the test suite is also
  created.

![MyModuleTest.dwl file in the src/test/dw folder](/mulesoft/current/en-us/dataweave/latest/_images/dataweave-extension-testmodule-2.png)

To run the test:

1.  In Visual Studio Code, go to the **TESTING** view.

2.  Select the dropdown arrows of your module test file.

3.  Click the **Run Test** arrow button.

![MyModuleTest file in the TESTING TAB and Run Test button](/mulesoft/current/en-us/dataweave/latest/_images/dataweave-extension-testmodule-3.png)

## Create a DataWeave Mapping

A DataWeave mapping is a `.dwl` file that enables you to map and connect to anything, regardless of
data type or structure. As when using a DataWeave module, you can use a mapping to define functions,
variables, types, and namespaces, but you can additionally specify a body section after the
separator `---`.

Unlike a DataWeave module file, a DataWeave mapping file is an executable unit that enables you to
transform zero or more inputs into a single output. Using the DataWeave extension, you can develop
these files to create reusable assets that you can deploy and share with others.

To create a new DataWeave mapping, follow these steps:

1.  In Visual Studio Code, click **View > Command Palette**.

2.  In the search bar, type `dataweave`.

3.  Select **DataWeave: Create New Mapping**.

    ![Command Palette with DataWeave: Create new mapping selected](/mulesoft/current/en-us/dataweave/latest/_images/dataweave-extension-createmapping.png)

4.  Add a name for the new mapping `dwl` file and press enter.  
    This creates a new mapping `.dwl` file under the `src/main/dw` folder.

### Define Sample Data for DataWeave Mappings

Generate multiple sample data inputs for your mapping by clicking the **Define Sample Data** button
at the top of your mapping `.dwl` file. Sample data is a key part of DataWeave project development
to run your mappings.

To define sample data, follow these steps:

1.  In Visual Studio Code, open your DataWeave project.

2.  Navigate to the `src/main/dw` folder.

3.  Select your mapping `.dwl` file.

4.  Click the **Define Sample Data** button located above your mapping `.dwl` file.

    ![MyMapping.dwl file with Define Sample Data button](/mulesoft/current/en-us/dataweave/latest/_images/dataweave-extension-sampledata-1.png)

5.  Specify the name for the sample data file and press enter.

Using sample data generates a DataWeave _scenario_ that contains all the resources required to run
the mapping in the context of that scenario.

![Generated new sample data payload.json file as input for the MyMapping.dwl file](/mulesoft/current/en-us/dataweave/latest/_images/dataweave-extension-sampledata-2.png)

## Understanding DataWeave Scenarios

A DataWeave _scenario_ is a group of inputs and outputs that you can inject into your mapping either
to try out in the **Preview Output** view or to test your mapping using the input to evaluate it and
compare its output with the desired saved output of your scenario. Scenarios also provide
autocompletion based on the input structures.

These scenarios and their resources live in the `src/test/resources` folder and have the following
structure:

```none
├── src/test/resources
│       └── MyMapping //Contains the different scenarios for your mapping called "MyMapping"
│           ├── default //Name of your scenario
│           │   └── inputs //Folder where all of your inputs live
│           │   │   └── payload.json //Input for your mapping (you can use it in your script, naming it to be the same as the name of the file without the file's extension)
│           │   │   └── vars //Folder that represents a name for your input variable in your script: in this case vars
│           │   │       └── test.json //Input for your mapping (you can use it in your script, calling it vars.test)
│           │   └── out.json // Expected output of your mapping running against your inputs (only present when testing)
│           └── SavedTestScenario //Another scenario used for the integration test
```

### Using the DataWeave Scenarios View

The **DATAWEAVE SCENARIOS** view shows the available scenarios for the `.dwl` file. In this view,
you can add, remove, or set the active scenario that is used for your preview execution, or you can
choose that the values be autocompleted.

![DataWeave Scenarios view in Visual Studio Code](/mulesoft/current/en-us/dataweave/latest/_images/dataweave-extension-dataweavescenario.png)

### Using Reader Properties for Inputs

If you want to set different reader properties to the inputs you use, create a properties file with
the suffix `{fileName}-config.properties` in the same directory of your input. For example, if your
input is called `payload.csv` then create a `payload-config.properties` file that contains all the
reader properties required to run your scenario. Creating the properties file also applies while
testing your DataWeave mappings.

## Preview a DataWeave Mapping

After you define sample data, get feedback on how your mapping is working by previewing the output.

1.  In Visual Studio Code, open your DataWeave project.

2.  Navigate to the `src/main/dw` folder.

3.  Select your module `.dwl` file.

4.  Either preview the mapping function by one of these options:

    - Click the **DataWeave: Run Preview** button (arrow icon) at the top right corner of your
      mapping `.dwl` file.

    - Right-click the editor and select **DataWeave: Enable AutoPreview** to run it on every file
      change.

## Run and Debug a DataWeave Mapping

Run and debug a DataWeave mapping to be guided through all of the mapping elements, which you can
then fix or otherwise update. You can also set breakpoints to stop evaluating expressions and use
all the debugging capabilities that Visual Studio Code provides. Debugging works on mapping tests as
well.

To run and debug a DataWeave mapping, follow these steps:

1.  In Visual Studio Code, open your DataWeave project.

2.  Navigate to the `src/main/dw` folder.

3.  Select your mapping `.dwl` file.

4.  Click the **Run Mapping** button located at the top of your `.dwl` file.

    ![MyMapping.dwl and Run Mapping button](/mulesoft/current/en-us/dataweave/latest/_images/dataweave-extension-runmapping.png)

## Test a DataWeave Mapping

To test a DataWeave mapping, click the **Dataweave: Create Mapping Test** button located at the top
of your `.dwl` file to create a new test scenario from a snapshot of your input and your current
output. You can also use this newly created scenario as a normal scenario for your preview or
autocompletion.

To test a DataWeave mapping, follow these steps:

1.  In Visual Studio Code, open your DataWeave project.

2.  Navigate to the `src/main/dw` folder.

3.  Click the **DataWeave: Create Mapping Test** button (microscope icon) located at the top of your
    mapping `.dwl` file.

    ![MyMapping.dwl file and the DataWeave Create Mapping Test button](/mulesoft/current/en-us/dataweave/latest/_images/dataweave-extension-testmapping.png)

4.  Specify a name for the mapping test and press enter.

This creates a new mapping test `.dwl` file:

![MyMappingTest.dwl file](/mulesoft/current/en-us/dataweave/latest/_images/dataweave-extension-testmapping-2.png)

## Using the DataWeave Dependencies View

The **DATAWEAVE DEPENDENCIES** view shows all the dependencies resolved for a DataWeave project. The
view enables you to navigate through all of your project’s dependencies and open DataWeave files
inside those dependencies.

![DataWeave Dependencies View](/mulesoft/current/en-us/dataweave/latest/_images/dataweave-extension-dataweavedependencies.png)

## Deploy DataWeave Libraries

Before deploying your DataWeave library to Anypoint Exchange, generate documentation for your
mapping or module functions. When you deploy your DataWeave library to Exchange, the documentation
is also published to the Exchange library page.

To generate documentation for the functions, follow these steps:

1.  In Visual Studio Code, open your DataWeave project.

2.  Navigate to the `src/main/dw` folder.

3.  Click the **Generate Weave Documentation** button located at the top of the function in the
    `.dwl` file.

    ![MyMapping.dwl file and the Generate Weave Documentation button](/mulesoft/current/en-us/dataweave/latest/_images/dataweave-extension-generatedocs-1.png)

The documentation template appears as a comment above the function:

![Auto-generated documentation located above the function](/mulesoft/current/en-us/dataweave/latest/_images/dataweave-extension-generatedocs-2.png)

To deploy a DataWeave library to Exchange:

1.  In Visual Studio Code, open your DataWeave project.

2.  Open and configure your `pom.xml` file.

    1.  Ensure that your `groupId` is set to your `organization ID`.

    2.  Add the Maven facade as a repository within the `<distributionManagement>` element.

        ![Maven facade in <distributionManagement> element](/mulesoft/current/en-us/dataweave/latest/_images/dataweave-extension-mavenfacade.png)

3.  Update the `settings.xml` file in your Maven `.m2` directory with your Anypoint Platform
    credentials.

    For guidance, refer to the
    [Publish an Asset to Exchange Using Maven](https://docs.mulesoft.com/dataweave/latest/exchange/to-publish-assets-maven#publish-an-asset-to-exchange-using-maven guide>)
    documentation.

4.  Execute the Maven `deploy` command to upload the DataWeave library to the deployment target and
    the auto-generated documentation to Exchange.

    For guidance, refer to the [DataWeave Maven Plugin](https://docs.mulesoft.com/dataweave/latest/dataweave-maven-plugin) documentation.

## Consume DataWeave Libraries

After deploying your DataWeave library to Exchange, the library appears as an asset for your
organization in the Exchange marketplace.

To consume the DataWeave library:

1.  Add the library’s group ID, artifact ID, version, and classifier to the `dependencies` element
    in your project’s `pom.xml` file.

    You can copy the dependency snippet from Exchange.

2.  Add the Maven facade as a repository in the `repositories` section.

For more details, refer to the
[Publish and Consume Federated Assets](https://docs.mulesoft.com/exchange/to-publish-assets-maven#publish-and-consume-federated-assets)
documentation.

## DataWeave Extension Language Edition Features

The Language Edition features of the DataWeave extension include completion, navigation, code
editing, and code inspection.

### Completion

The completion feature enables you to autocomplete content for any visible functions, variables, or
types. The feature also suggests fields based on the type inference.

![Completion Feature sample](/mulesoft/current/en-us/dataweave/latest/_images/dataweave-extension-completion.png)

### Navigation

You can navigate to any local definition or from any imported library.

### Code Editing Features

The following features help you to easily code in Visual Studio Code:

- Find all references

- Refactors (local and cross files)

- Quick fixes:

  - Auto import when a function is present in a module

  - Create a function, variable, or type when one isn’t found

- Outline

- Show parameters information

- Hover information with documentation

![Auto Import Feature sample](/mulesoft/current/en-us/dataweave/latest/_images/dataweave-extension-autoimport.png)

### Code Inspections

The DataWeave extension tries to detect and suggest replacements for idioms in expressions, as shown
in the following examples:

- Default Value

![Default Value Code Inspection sample](/mulesoft/current/en-us/dataweave/latest/_images/dataweave-extension-defaultvalue.png)

- TypeOf

![TypeOf Code Inspection sample](/mulesoft/current/en-us/dataweave/latest/_images/dataweave-extension-typeof.png)

- IsEmpty

![Is Empty Code Inspection sample](/mulesoft/current/en-us/dataweave/latest/_images/dataweave-extension-isempty.png)

## DataWeave Extension Troubleshooting Logs

If an error occurs while you’re working with the DataWeave Extension, check the logs output of the
DataWeave Language Server that provide details of what can cause the issue:

To check the logs, follow these steps:

1.  In Visual Studio Code, navigate to **View > Output** to open the **OUTPUT** view in the Visual
    Studio Code editor window.

2.  In the drop-down menu located on the left of the screen editor, select **Mule DX DataWeave LS**
    to show the logs.

![Mule DX DataWeave LS option to select in the drop-down menu of the Output](/mulesoft/current/en-us/dataweave/latest/_images/dataweave-extension-logs.png)

## Scope Visibility

When you author DataWeave libraries (`.dwl` files that other DataWeave code imports), the DataWeave
extension supports the visibility model introduced in DataWeave 2.12.0:

- Highlights the keywords `private` and `internal` as language keywords.

- Recognizes the `@VisibleTo` annotation when applied to `internal` directives.

- Reports visibility violations inline and uses the same wording as the compiler
  (`…​ cannot be accessed from …​ as it is private to the module …​`,
  `…​ is internal to the component …​`).

- Filters out directives that aren’t visible from the current file in auto-completion. For example,
  `private` helpers defined in another file don’t appear in the suggestion list.

- Supports `Go to definition` and warns when you navigate to a directive that isn’t accessible from
  the current file.

These features apply to library projects only. If you write a Mule transformation mapping inline (a
`%dw 2.0` expression in a Transform Message component, a Set Variable expression, or a DataWeave
expression embedded in a connector), the `internal` keyword and `@VisibleTo` annotation have no
practical effect. An inline mapping is a self-contained script that can’t be imported from another
inline mapping, so there is nothing to constrain. The keywords are still parsed, but you don’t need
them in mapping code.

The same rule applies to `.dwl` modules defined inside the Mule application. Every inline mapping
and application-level module belongs to an unnamed component, so they can freely reference each
other’s `internal` directives. The `private` keyword still applies and restricts a directive to its
declaring file regardless of component.

For the full visibility model, including definitions for `private`, `internal`, and components, and
how the Maven plugin for DataWeave generates the component descriptor, see
[Scope Visibility in DataWeave](https://docs.mulesoft.com/dataweave/latest/dataweave-scope-visibility).

## See Also

- [DataWeave Extension](https://docs.mulesoft.com/dataweave/latest/dataweave-extension)

- [DataWeave Maven Plugin](https://docs.mulesoft.com/dataweave/latest/dataweave-maven-plugin)

- [DataWeave Testing Framework](https://docs.mulesoft.com/dataweave/latest/dataweave-testing-framework)

<!-- document id=21f892cb1dbc931835e5ff9d8d48c0a3aab9cf72a70c13f96c0e9b4cadb94c19 url=/mulesoft/current/en-us/dataweave/2.11/dw-types-functions-intersectionitems.md -->

---
product: DataWeave
version: 2.11
---

# intersectionItems

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## intersectionItems(t: Type): Array<Type>

Returns an array of all the types that define a given Intersection type. This function fails if the
input is not an Intersection type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `intersectionItems` behaves with different inputs. Note that the `AType`
variable defines an Intersection type `{name: String} & {age: Number}` by using an `&` between the
two objects.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = {name: String} & {age: Number}
output application/json
---
{
   a: intersectionItems(AType)
}
```

#### Output

```Json
{
  "a": ["Object","Object"]
}
```

<!-- document id=37aebae252e59fb6710a28ad9de64e67c60f0cf447c9e119c5ec63d279e1bf11 url=/mulesoft/current/en-us/dataweave/2.12/dw-types-functions-intersectionitems.md -->

---
product: DataWeave
version: 2.12
---

# intersectionItems

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## intersectionItems(t: Type): Array<Type>

Returns an array of all the types that define a given Intersection type. This function fails if the
input is not an Intersection type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `intersectionItems` behaves with different inputs. Note that the `AType`
variable defines an Intersection type `{name: String} & {age: Number}` by using an `&` between the
two objects.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = {name: String} & {age: Number}
output application/json
---
{
   a: intersectionItems(AType)
}
```

#### Output

```Json
{
  "a": ["Object","Object"]
}
```

<!-- document id=3b817690aed041f1903a060696df91827e3cc11d8b9b6d379fe8b208c63130e8 url=/mulesoft/current/en-us/dataweave/2.3/dw-types-functions-intersectionitems.md -->

---
product: DataWeave
version: 2.3
---

# intersectionItems

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## intersectionItems(Type): Array<Type>

Returns an array of all the types that define a given Intersection type. This function fails if the
input is not an Intersection type.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>t</p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `intersectionItems` behaves with different inputs. Note that the `AType`
variable defines an Intersection type `{name: String} & {age: Number}` by using an `&` between the
two objects.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = {name: String} & {age: Number}
output application/json
---
{
   a: intersectionItems(AType)
}
```

#### Output

```Json
{
  "a": ["Object","Object"]
}
```

<!-- document id=50dabac9ac965ccd96be3f5738c6e7936ddbc6f591f9ffb11efe830ef8ce1da5 url=/mulesoft/current/en-us/dataweave/2.4/dw-types-functions-intersectionitems.md -->

---
product: DataWeave
version: 2.4
---

# intersectionItems

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## intersectionItems(t: Type): Array<Type>

Returns an array of all the types that define a given Intersection type. This function fails if the
input is not an Intersection type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `intersectionItems` behaves with different inputs. Note that the `AType`
variable defines an Intersection type `{name: String} & {age: Number}` by using an `&` between the
two objects.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = {name: String} & {age: Number}
output application/json
---
{
   a: intersectionItems(AType)
}
```

#### Output

```Json
{
  "a": ["Object","Object"]
}
```

<!-- document id=f4ead445a6ffae655c4274974850783cdd01b52aaea98df7a5c0daf5da1a3565 url=/mulesoft/current/en-us/dataweave/2.6/dw-types-functions-intersectionitems.md -->

---
product: DataWeave
version: 2.6
---

# intersectionItems

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## intersectionItems(t: Type): Array<Type>

Returns an array of all the types that define a given Intersection type. This function fails if the
input is not an Intersection type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `intersectionItems` behaves with different inputs. Note that the `AType`
variable defines an Intersection type `{name: String} & {age: Number}` by using an `&` between the
two objects.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = {name: String} & {age: Number}
output application/json
---
{
   a: intersectionItems(AType)
}
```

#### Output

```Json
{
  "a": ["Object","Object"]
}
```

<!-- document id=139549927ecca852ccc78b406afc90e1b1be675bce7a8141f7eda88000d7ffaf url=/mulesoft/current/en-us/dataweave/2.9/dw-types-functions-intersectionitems.md -->

---
product: DataWeave
version: 2.9
---

# intersectionItems

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## intersectionItems(t: Type): Array<Type>

Returns an array of all the types that define a given Intersection type. This function fails if the
input is not an Intersection type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `intersectionItems` behaves with different inputs. Note that the `AType`
variable defines an Intersection type `{name: String} & {age: Number}` by using an `&` between the
two objects.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = {name: String} & {age: Number}
output application/json
---
{
   a: intersectionItems(AType)
}
```

#### Output

```Json
{
  "a": ["Object","Object"]
}
```

<!-- document id=d2f89f4641c00fe397cddf29125a29c48f0316807e68e843350a70f7006c4b7a url=/mulesoft/current/en-us/dataweave/latest/dw-types-functions-intersectionitems.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# intersectionItems

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## intersectionItems(t: Type): Array<Type>

Returns an array of all the types that define a given Intersection type. This function fails if the
input is not an Intersection type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `intersectionItems` behaves with different inputs. Note that the `AType`
variable defines an Intersection type `{name: String} & {age: Number}` by using an `&` between the
two objects.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = {name: String} & {age: Number}
output application/json
---
{
   a: intersectionItems(AType)
}
```

#### Output

```Json
{
  "a": ["Object","Object"]
}
```

<!-- document id=d12458bdbf4ec02632dc991ccdfa08992b01dd502d064652614afcc237a5e1d0 url=/mulesoft/current/en-us/dataweave/2.11/dw-strings-functions-isalpha.md -->

---
product: DataWeave
version: 2.11
---

# isAlpha

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isAlpha(text: String): Boolean

Checks if the `text` contains only Unicode digits. This excludes digits, punctuation, and other
nonletter characters.

Note that the method does not allow for a leading sign, either positive or negative.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example shows how `isAlpha` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import isAlpha from dw::core::Strings
output application/json
---
{
  "a": isAlpha(null),
  "b": isAlpha(""),
  "c": isAlpha("  "),
  "d": isAlpha("abc"),
  "e": isAlpha("ab2c"),
  "f": isAlpha("ab-c")
}
```

#### Output

```JSON
{
  "a": false,
  "b": false,
  "c": false,
  "d": true,
  "e": false,
  "f": false
}
```

## isAlpha(text: Null): Boolean

Helper function that enables `isAlpha` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=193aeba939393ccd29132a83f5847b97b5aa642f61bbfb37d1239cb0a1f9dc6c url=/mulesoft/current/en-us/dataweave/2.12/dw-strings-functions-isalpha.md -->

---
product: DataWeave
version: 2.12
---

# isAlpha

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isAlpha(text: String): Boolean

Checks if the `text` contains only Unicode digits. This excludes digits, punctuation, and other
nonletter characters.

Note that the method does not allow for a leading sign, either positive or negative.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example shows how `isAlpha` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import isAlpha from dw::core::Strings
output application/json
---
{
  "a": isAlpha(null),
  "b": isAlpha(""),
  "c": isAlpha("  "),
  "d": isAlpha("abc"),
  "e": isAlpha("ab2c"),
  "f": isAlpha("ab-c")
}
```

#### Output

```JSON
{
  "a": false,
  "b": false,
  "c": false,
  "d": true,
  "e": false,
  "f": false
}
```

## isAlpha(text: Null): Boolean

Helper function that enables `isAlpha` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=cfd65ef42698e42a59ec1c2b1f2731cede4190d928e92a04a474ac3b73a3a6fa url=/mulesoft/current/en-us/dataweave/2.3/dw-strings-functions-isalpha.md -->

---
product: DataWeave
version: 2.3
---

# isAlpha

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isAlpha(String): Boolean

Checks if the `text` contains only Unicode digits. A decimal point is not a Unicode digit and
returns `false`.

Note that the method does not allow for a leading sign, either positive or negative.

_Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example shows how `isNumeric` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import isAlpha from dw::core::Strings
output application/json
---
{
  "a": isAlpha(null),
  "b": isAlpha(""),
  "c": isAlpha("  "),
  "d": isAlpha("abc"),
  "e": isAlpha("ab2c"),
  "f": isAlpha("ab-c")
}
```

#### Output

```JSON
{
  "a": false,
  "b": false,
  "c": false,
  "d": true,
  "e": false,
  "f": false
}
```

## isAlpha(Null): Boolean

Helper function that enables `isAlpha` to work with a `null` value.

<!-- document id=ca1896ad58d16a42c52b8ee468d164368295f39c0fd99667272dd4f719dd6655 url=/mulesoft/current/en-us/dataweave/2.4/dw-strings-functions-isalpha.md -->

---
product: DataWeave
version: 2.4
---

# isAlpha

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isAlpha(text: String): Boolean

Checks if the `text` contains only Unicode digits. This excludes digits, punctuation, and other
nonletter characters.

Note that the method does not allow for a leading sign, either positive or negative.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example shows how `isAlpha` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import isAlpha from dw::core::Strings
output application/json
---
{
  "a": isAlpha(null),
  "b": isAlpha(""),
  "c": isAlpha("  "),
  "d": isAlpha("abc"),
  "e": isAlpha("ab2c"),
  "f": isAlpha("ab-c")
}
```

#### Output

```JSON
{
  "a": false,
  "b": false,
  "c": false,
  "d": true,
  "e": false,
  "f": false
}
```

## isAlpha(text: Null): Boolean

Helper function that enables `isAlpha` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=3309fd6e56800df4044235da38a720b912364ff0ed7436b414299ff9e2c507bf url=/mulesoft/current/en-us/dataweave/2.6/dw-strings-functions-isalpha.md -->

---
product: DataWeave
version: 2.6
---

# isAlpha

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isAlpha(text: String): Boolean

Checks if the `text` contains only Unicode digits. This excludes digits, punctuation, and other
nonletter characters.

Note that the method does not allow for a leading sign, either positive or negative.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example shows how `isAlpha` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import isAlpha from dw::core::Strings
output application/json
---
{
  "a": isAlpha(null),
  "b": isAlpha(""),
  "c": isAlpha("  "),
  "d": isAlpha("abc"),
  "e": isAlpha("ab2c"),
  "f": isAlpha("ab-c")
}
```

#### Output

```JSON
{
  "a": false,
  "b": false,
  "c": false,
  "d": true,
  "e": false,
  "f": false
}
```

## isAlpha(text: Null): Boolean

Helper function that enables `isAlpha` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=88c6410d43cec6547118917948c3c4d6198fa21981efaeb7e9a2829dbc5bd725 url=/mulesoft/current/en-us/dataweave/2.9/dw-strings-functions-isalpha.md -->

---
product: DataWeave
version: 2.9
---

# isAlpha

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isAlpha(text: String): Boolean

Checks if the `text` contains only Unicode digits. This excludes digits, punctuation, and other
nonletter characters.

Note that the method does not allow for a leading sign, either positive or negative.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example shows how `isAlpha` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import isAlpha from dw::core::Strings
output application/json
---
{
  "a": isAlpha(null),
  "b": isAlpha(""),
  "c": isAlpha("  "),
  "d": isAlpha("abc"),
  "e": isAlpha("ab2c"),
  "f": isAlpha("ab-c")
}
```

#### Output

```JSON
{
  "a": false,
  "b": false,
  "c": false,
  "d": true,
  "e": false,
  "f": false
}
```

## isAlpha(text: Null): Boolean

Helper function that enables `isAlpha` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=3cdac4a5e581b90f51be4bc4c26f172c9809c295a4a59c91edef4314512c50ab url=/mulesoft/current/en-us/dataweave/latest/dw-strings-functions-isalpha.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# isAlpha

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isAlpha(text: String): Boolean

Checks if the `text` contains only Unicode digits. This excludes digits, punctuation, and other
nonletter characters.

Note that the method does not allow for a leading sign, either positive or negative.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example shows how `isAlpha` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import isAlpha from dw::core::Strings
output application/json
---
{
  "a": isAlpha(null),
  "b": isAlpha(""),
  "c": isAlpha("  "),
  "d": isAlpha("abc"),
  "e": isAlpha("ab2c"),
  "f": isAlpha("ab-c")
}
```

#### Output

```JSON
{
  "a": false,
  "b": false,
  "c": false,
  "d": true,
  "e": false,
  "f": false
}
```

## isAlpha(text: Null): Boolean

Helper function that enables `isAlpha` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=a4899e46613306ccfa8287b1f0d9bc32c2a93d3b218674aeb1461aa0bde62c6f url=/mulesoft/current/en-us/dataweave/2.11/dw-strings-functions-isalphanumeric.md -->

---
product: DataWeave
version: 2.11
---

# isAlphanumeric

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isAlphanumeric(text: String): Boolean

Checks if the `text` contains only Unicode letters or digits.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example shows how `isAlphanumeric` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import isAlphanumeric from dw::core::Strings
output application/json
---
{
  "a": isAlphanumeric(null),
  "b": isAlphanumeric(""),
  "c": isAlphanumeric("  "),
  "d": isAlphanumeric("abc"),
  "e": isAlphanumeric("ab c"),
  "f": isAlphanumeric("ab2c"),
  "g": isAlphanumeric("ab-c")
}
```

#### Output

```JSON
{
  "a": false,
  "b": false,
  "c": false,
  "d": true,
  "e": false,
  "f": true,
  "g": false
}
```

## isAlphanumeric(text: Null): Boolean

Helper function that enables `isAlphanumeric` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=980ed50759bcec7c2b5eeb8b4349f466c3b81fd7ae1e135f7eeeb8cda831b5e0 url=/mulesoft/current/en-us/dataweave/2.12/dw-strings-functions-isalphanumeric.md -->

---
product: DataWeave
version: 2.12
---

# isAlphanumeric

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isAlphanumeric(text: String): Boolean

Checks if the `text` contains only Unicode letters or digits.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example shows how `isAlphanumeric` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import isAlphanumeric from dw::core::Strings
output application/json
---
{
  "a": isAlphanumeric(null),
  "b": isAlphanumeric(""),
  "c": isAlphanumeric("  "),
  "d": isAlphanumeric("abc"),
  "e": isAlphanumeric("ab c"),
  "f": isAlphanumeric("ab2c"),
  "g": isAlphanumeric("ab-c")
}
```

#### Output

```JSON
{
  "a": false,
  "b": false,
  "c": false,
  "d": true,
  "e": false,
  "f": true,
  "g": false
}
```

## isAlphanumeric(text: Null): Boolean

Helper function that enables `isAlphanumeric` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=804b90aca6f0a25df9ee9726dac21f37d0cc37cd6ed8dad33a3d4d409684ee1b url=/mulesoft/current/en-us/dataweave/2.3/dw-strings-functions-isalphanumeric.md -->

---
product: DataWeave
version: 2.3
---

# isAlphanumeric

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isAlphanumeric(String): Boolean

Checks if the `text` contains only Unicode letters or digits.

_Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example shows how `isAlphanumeric` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import isAlphanumeric from dw::core::Strings
output application/json
---
{
  "a": isAlphanumeric(null),
  "b": isAlphanumeric(""),
  "c": isAlphanumeric("  "),
  "d": isAlphanumeric("abc"),
  "e": isAlphanumeric("ab c"),
  "f": isAlphanumeric("ab2c"),
  "g": isAlphanumeric("ab-c")
}
```

#### Output

```JSON
{
  "a": false,
  "b": false,
  "c": false,
  "d": true,
  "e": false,
  "f": true,
  "g": false
}
```

## isAlphanumeric(Null): Boolean

Helper function that enables `isAlphanumeric` to work with a `null` value.

<!-- document id=ac68f744dc869c459f3865a8fe05455a6ee413f69cc32062ce9ea0bab0ec777d url=/mulesoft/current/en-us/dataweave/2.4/dw-strings-functions-isalphanumeric.md -->

---
product: DataWeave
version: 2.4
---

# isAlphanumeric

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isAlphanumeric(text: String): Boolean

Checks if the `text` contains only Unicode letters or digits.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example shows how `isAlphanumeric` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import isAlphanumeric from dw::core::Strings
output application/json
---
{
  "a": isAlphanumeric(null),
  "b": isAlphanumeric(""),
  "c": isAlphanumeric("  "),
  "d": isAlphanumeric("abc"),
  "e": isAlphanumeric("ab c"),
  "f": isAlphanumeric("ab2c"),
  "g": isAlphanumeric("ab-c")
}
```

#### Output

```JSON
{
  "a": false,
  "b": false,
  "c": false,
  "d": true,
  "e": false,
  "f": true,
  "g": false
}
```

## isAlphanumeric(text: Null): Boolean

Helper function that enables `isAlphanumeric` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=239d91f86c77401d9ba20376aa47eb47205cbdca048f0964d11ee144287d9d2d url=/mulesoft/current/en-us/dataweave/2.6/dw-strings-functions-isalphanumeric.md -->

---
product: DataWeave
version: 2.6
---

# isAlphanumeric

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isAlphanumeric(text: String): Boolean

Checks if the `text` contains only Unicode letters or digits.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example shows how `isAlphanumeric` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import isAlphanumeric from dw::core::Strings
output application/json
---
{
  "a": isAlphanumeric(null),
  "b": isAlphanumeric(""),
  "c": isAlphanumeric("  "),
  "d": isAlphanumeric("abc"),
  "e": isAlphanumeric("ab c"),
  "f": isAlphanumeric("ab2c"),
  "g": isAlphanumeric("ab-c")
}
```

#### Output

```JSON
{
  "a": false,
  "b": false,
  "c": false,
  "d": true,
  "e": false,
  "f": true,
  "g": false
}
```

## isAlphanumeric(text: Null): Boolean

Helper function that enables `isAlphanumeric` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=44959ac6d199847092dbaaa9bf7b39e3ba65136ef4868fa04de125d0696254e8 url=/mulesoft/current/en-us/dataweave/2.9/dw-strings-functions-isalphanumeric.md -->

---
product: DataWeave
version: 2.9
---

# isAlphanumeric

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isAlphanumeric(text: String): Boolean

Checks if the `text` contains only Unicode letters or digits.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example shows how `isAlphanumeric` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import isAlphanumeric from dw::core::Strings
output application/json
---
{
  "a": isAlphanumeric(null),
  "b": isAlphanumeric(""),
  "c": isAlphanumeric("  "),
  "d": isAlphanumeric("abc"),
  "e": isAlphanumeric("ab c"),
  "f": isAlphanumeric("ab2c"),
  "g": isAlphanumeric("ab-c")
}
```

#### Output

```JSON
{
  "a": false,
  "b": false,
  "c": false,
  "d": true,
  "e": false,
  "f": true,
  "g": false
}
```

## isAlphanumeric(text: Null): Boolean

Helper function that enables `isAlphanumeric` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=8b87c97cfa61c43c7b5312b8713a15d8ffd307993686f95606a50cf3b9d13f4c url=/mulesoft/current/en-us/dataweave/latest/dw-strings-functions-isalphanumeric.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# isAlphanumeric

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isAlphanumeric(text: String): Boolean

Checks if the `text` contains only Unicode letters or digits.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example shows how `isAlphanumeric` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import isAlphanumeric from dw::core::Strings
output application/json
---
{
  "a": isAlphanumeric(null),
  "b": isAlphanumeric(""),
  "c": isAlphanumeric("  "),
  "d": isAlphanumeric("abc"),
  "e": isAlphanumeric("ab c"),
  "f": isAlphanumeric("ab2c"),
  "g": isAlphanumeric("ab-c")
}
```

#### Output

```JSON
{
  "a": false,
  "b": false,
  "c": false,
  "d": true,
  "e": false,
  "f": true,
  "g": false
}
```

## isAlphanumeric(text: Null): Boolean

Helper function that enables `isAlphanumeric` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=21132aa1fa67e302eff5da909e372f08cfe1c81e73166bfdf7e2888a2003d69d url=/mulesoft/current/en-us/dataweave/2.11/dw-types-functions-isanytype.md -->

---
product: DataWeave
version: 2.11
---

# isAnyType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isAnyType(t: Type): Boolean

Returns `true` if the input is the Any type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isAnyType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AAny = Any
output application/json
---
{
   a: isAnyType(AAny),
   b: isAnyType(Any),
   c: isAnyType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=c15fcd73296f202f11257de578752f65e93fbc2ec8499cb81972373552bc5aac url=/mulesoft/current/en-us/dataweave/2.12/dw-types-functions-isanytype.md -->

---
product: DataWeave
version: 2.12
---

# isAnyType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isAnyType(t: Type): Boolean

Returns `true` if the input is the Any type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isAnyType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AAny = Any
output application/json
---
{
   a: isAnyType(AAny),
   b: isAnyType(Any),
   c: isAnyType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=9b5bcf82394ae2ced5f23c9c94f2d356a4edd8387d215e47327f1fac70f6fd45 url=/mulesoft/current/en-us/dataweave/2.3/dw-types-functions-isanytype.md -->

---
product: DataWeave
version: 2.3
---

# isAnyType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isAnyType(Type): Boolean

Returns `true` if the input is the Any type.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>t</p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isAnyType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AAny = Any
output application/json
---
{
   a: isAnyType(AAny),
   b: isAnyType(Any),
   c: isAnyType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=3b74882d96969de3a7f8568560606d25eecb54c2465d69c18438de7bb26460dd url=/mulesoft/current/en-us/dataweave/2.4/dw-types-functions-isanytype.md -->

---
product: DataWeave
version: 2.4
---

# isAnyType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isAnyType(t: Type): Boolean

Returns `true` if the input is the Any type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isAnyType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AAny = Any
output application/json
---
{
   a: isAnyType(AAny),
   b: isAnyType(Any),
   c: isAnyType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=be7174d10c59958759b1f9f469d13718070bd44ec5ce356506dbab42fa17ecc9 url=/mulesoft/current/en-us/dataweave/2.6/dw-types-functions-isanytype.md -->

---
product: DataWeave
version: 2.6
---

# isAnyType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isAnyType(t: Type): Boolean

Returns `true` if the input is the Any type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isAnyType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AAny = Any
output application/json
---
{
   a: isAnyType(AAny),
   b: isAnyType(Any),
   c: isAnyType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=5ca39e096a8c2feceff6c690d3924212e7d181486cc23c200f4d0831b3b9960d url=/mulesoft/current/en-us/dataweave/2.9/dw-types-functions-isanytype.md -->

---
product: DataWeave
version: 2.9
---

# isAnyType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isAnyType(t: Type): Boolean

Returns `true` if the input is the Any type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isAnyType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AAny = Any
output application/json
---
{
   a: isAnyType(AAny),
   b: isAnyType(Any),
   c: isAnyType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=95e28ca865b4d0f39da5403ff9bcd0cd2e5e2311dd8b433382bd7e197185984e url=/mulesoft/current/en-us/dataweave/latest/dw-types-functions-isanytype.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# isAnyType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isAnyType(t: Type): Boolean

Returns `true` if the input is the Any type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isAnyType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AAny = Any
output application/json
---
{
   a: isAnyType(AAny),
   b: isAnyType(Any),
   c: isAnyType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=5222238ec23a2673acbbefc026ffb7f2ff9a3e95e5318e4f715a5211b9691d5e url=/mulesoft/current/en-us/dataweave/2.11/dw-tree-functions-isarraytype.md -->

---
product: DataWeave
version: 2.11
---

# isArrayType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isArrayType(path: Path): Boolean

Returns `true` if the provided `Path` value is an `ARRAY_TYPE` expression.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>path</code></p></td><td><p>The <code>Path</code> value to validate.</p></td></tr></tbody></table>

### Example

This example shows how `isArrayType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
output application/json
---
{
  a: isArrayType([{kind: OBJECT_TYPE, selector: "user", namespace: null},
                  {kind: ATTRIBUTE_TYPE, selector: "name", namespace: null}]),
  b: isArrayType([{kind: OBJECT_TYPE, selector: "user", namespace: null},
                  {kind: ARRAY_TYPE, selector: 0, namespace: null}]),
  c: isArrayType([{kind: ARRAY_TYPE, selector: 0, namespace: null}])
}
```

#### Output

```Json
{
  "a": false,
  "b": true,
  "c": true
}
```

<!-- document id=3dd9894f470e0b4bc2b14a9a0c4da56a55b5ee8c31d42f2ca4daee006f578dd1 url=/mulesoft/current/en-us/dataweave/2.11/dw-types-functions-isarraytype.md -->

---
product: DataWeave
version: 2.11
---

# isArrayType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isArrayType(t: Type): Boolean

Returns `true` if the input type is the Array type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isArrayType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = Array<String>
output application/json
---
{
   a: isArrayType(AType),
   b: isArrayType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": false
}
```

<!-- document id=27fe87cbda8a58bd2b7a25e50e1d0c7fdcba1c56eac18faf577eef608d08dd4f url=/mulesoft/current/en-us/dataweave/2.12/dw-tree-functions-isarraytype.md -->

---
product: DataWeave
version: 2.12
---

# isArrayType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isArrayType(path: Path): Boolean

Returns `true` if the provided `Path` value is an `ARRAY_TYPE` expression.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>path</code></p></td><td><p>The <code>Path</code> value to validate.</p></td></tr></tbody></table>

### Example

This example shows how `isArrayType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
output application/json
---
{
  a: isArrayType([{kind: OBJECT_TYPE, selector: "user", namespace: null},
                  {kind: ATTRIBUTE_TYPE, selector: "name", namespace: null}]),
  b: isArrayType([{kind: OBJECT_TYPE, selector: "user", namespace: null},
                  {kind: ARRAY_TYPE, selector: 0, namespace: null}]),
  c: isArrayType([{kind: ARRAY_TYPE, selector: 0, namespace: null}])
}
```

#### Output

```Json
{
  "a": false,
  "b": true,
  "c": true
}
```

<!-- document id=cb25ca52b1ca5849feb5f7c324d37adad5e3d40500a4f3a03a59a9bc8a31791b url=/mulesoft/current/en-us/dataweave/2.12/dw-types-functions-isarraytype.md -->

---
product: DataWeave
version: 2.12
---

# isArrayType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isArrayType(t: Type): Boolean

Returns `true` if the input type is the Array type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isArrayType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = Array<String>
output application/json
---
{
   a: isArrayType(AType),
   b: isArrayType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": false
}
```

<!-- document id=990747c2157b2276edf8f60c4382df1cc055aa440d227804847a695f2dc5c5bb url=/mulesoft/current/en-us/dataweave/2.3/dw-types-functions-isarraytype.md -->

---
product: DataWeave
version: 2.3
---

# isArrayType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isArrayType(Type): Boolean

Returns `true` if the input type is the Array type.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>t</p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isArrayType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = Array<String>
output application/json
---
{
   a: isArrayType(AType),
   b: isArrayType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": false
}
```

<!-- document id=d83624f0c5cb9121d34755e4d5cec6c2cb7a89697064231749411a9d31f9f59c url=/mulesoft/current/en-us/dataweave/2.4/dw-tree-functions-isarraytype.md -->

---
product: DataWeave
version: 2.4
---

# isArrayType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isArrayType(path: Path): Boolean

Returns `true` if the provided `Path` value is an `ARRAY_TYPE` expression.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>path</code></p></td><td><p>The <code>Path</code> value to validate.</p></td></tr></tbody></table>

### Example

This example shows how `isArrayType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
output application/json
---
{
  a: isArrayType([{kind: OBJECT_TYPE, selector: "user", namespace: null},
                  {kind: ATTRIBUTE_TYPE, selector: "name", namespace: null}]),
  b: isArrayType([{kind: OBJECT_TYPE, selector: "user", namespace: null},
                  {kind: ARRAY_TYPE, selector: 0, namespace: null}]),
  c: isArrayType([{kind: ARRAY_TYPE, selector: 0, namespace: null}])
}
```

#### Output

```Json
{
  "a": false,
  "b": true,
  "c": true
}
```

<!-- document id=6ed30d5085339f002e2e8abd14930ddc40c06cb45b32887bae74229fe6c92d4c url=/mulesoft/current/en-us/dataweave/2.4/dw-types-functions-isarraytype.md -->

---
product: DataWeave
version: 2.4
---

# isArrayType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isArrayType(t: Type): Boolean

Returns `true` if the input type is the Array type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isArrayType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = Array<String>
output application/json
---
{
   a: isArrayType(AType),
   b: isArrayType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": false
}
```

<!-- document id=c97b662f8d370f223bab0129dec7623ce69fca70b5c3bfc89db0dc3081a285be url=/mulesoft/current/en-us/dataweave/2.6/dw-tree-functions-isarraytype.md -->

---
product: DataWeave
version: 2.6
---

# isArrayType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isArrayType(path: Path): Boolean

Returns `true` if the provided `Path` value is an `ARRAY_TYPE` expression.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>path</code></p></td><td><p>The <code>Path</code> value to validate.</p></td></tr></tbody></table>

### Example

This example shows how `isArrayType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
output application/json
---
{
  a: isArrayType([{kind: OBJECT_TYPE, selector: "user", namespace: null},
                  {kind: ATTRIBUTE_TYPE, selector: "name", namespace: null}]),
  b: isArrayType([{kind: OBJECT_TYPE, selector: "user", namespace: null},
                  {kind: ARRAY_TYPE, selector: 0, namespace: null}]),
  c: isArrayType([{kind: ARRAY_TYPE, selector: 0, namespace: null}])
}
```

#### Output

```Json
{
  "a": false,
  "b": true,
  "c": true
}
```

<!-- document id=ef45c42b6a5306856a5be92f9e66dc44c4a0ee638b5d89923fc94d7c72e82be6 url=/mulesoft/current/en-us/dataweave/2.6/dw-types-functions-isarraytype.md -->

---
product: DataWeave
version: 2.6
---

# isArrayType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isArrayType(t: Type): Boolean

Returns `true` if the input type is the Array type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isArrayType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = Array<String>
output application/json
---
{
   a: isArrayType(AType),
   b: isArrayType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": false
}
```

<!-- document id=fee977483d417f1fd785b652ead64ffe4524157603134a51528eef91a79845f5 url=/mulesoft/current/en-us/dataweave/2.9/dw-tree-functions-isarraytype.md -->

---
product: DataWeave
version: 2.9
---

# isArrayType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isArrayType(path: Path): Boolean

Returns `true` if the provided `Path` value is an `ARRAY_TYPE` expression.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>path</code></p></td><td><p>The <code>Path</code> value to validate.</p></td></tr></tbody></table>

### Example

This example shows how `isArrayType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
output application/json
---
{
  a: isArrayType([{kind: OBJECT_TYPE, selector: "user", namespace: null},
                  {kind: ATTRIBUTE_TYPE, selector: "name", namespace: null}]),
  b: isArrayType([{kind: OBJECT_TYPE, selector: "user", namespace: null},
                  {kind: ARRAY_TYPE, selector: 0, namespace: null}]),
  c: isArrayType([{kind: ARRAY_TYPE, selector: 0, namespace: null}])
}
```

#### Output

```Json
{
  "a": false,
  "b": true,
  "c": true
}
```

<!-- document id=b67b8b20578c80374450305d7831ccf3cd094ad6bba3e07bbe7cbb658541ad23 url=/mulesoft/current/en-us/dataweave/2.9/dw-types-functions-isarraytype.md -->

---
product: DataWeave
version: 2.9
---

# isArrayType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isArrayType(t: Type): Boolean

Returns `true` if the input type is the Array type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isArrayType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = Array<String>
output application/json
---
{
   a: isArrayType(AType),
   b: isArrayType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": false
}
```

<!-- document id=ce82560962a21ddb00991866146a49eee323d601a5b1442d866ecb1b5cf934b9 url=/mulesoft/current/en-us/dataweave/latest/dw-tree-functions-isarraytype.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# isArrayType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isArrayType(path: Path): Boolean

Returns `true` if the provided `Path` value is an `ARRAY_TYPE` expression.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>path</code></p></td><td><p>The <code>Path</code> value to validate.</p></td></tr></tbody></table>

### Example

This example shows how `isArrayType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
output application/json
---
{
  a: isArrayType([{kind: OBJECT_TYPE, selector: "user", namespace: null},
                  {kind: ATTRIBUTE_TYPE, selector: "name", namespace: null}]),
  b: isArrayType([{kind: OBJECT_TYPE, selector: "user", namespace: null},
                  {kind: ARRAY_TYPE, selector: 0, namespace: null}]),
  c: isArrayType([{kind: ARRAY_TYPE, selector: 0, namespace: null}])
}
```

#### Output

```Json
{
  "a": false,
  "b": true,
  "c": true
}
```

<!-- document id=6bae926fa46272a46b93db8d88b4ee48a2e0e0506825da13e246e78eb4dfb0d7 url=/mulesoft/current/en-us/dataweave/latest/dw-types-functions-isarraytype.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# isArrayType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isArrayType(t: Type): Boolean

Returns `true` if the input type is the Array type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isArrayType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = Array<String>
output application/json
---
{
   a: isArrayType(AType),
   b: isArrayType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": false
}
```

<!-- document id=b44adcec1b03280455e917d8e2ef5d5c7b2269e701c01d298d28be09c5303b39 url=/mulesoft/current/en-us/dataweave/2.11/dw-tree-functions-isattributetype.md -->

---
product: DataWeave
version: 2.11
---

# isAttributeType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isAttributeType(path: Path): Boolean

Returns `true` if the provided `Path` value is an `ATTRIBUTE_TYPE` expression.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>path</code></p></td><td><p>The <code>Path</code> value to validate.</p></td></tr></tbody></table>

### Example

This example shows how `isAttributeType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
output application/json
---
{
  a: isAttributeType([{kind: OBJECT_TYPE, selector: "user", namespace: null},
                      {kind: ATTRIBUTE_TYPE, selector: "name", namespace: null}]),
  b: isAttributeType([{kind: OBJECT_TYPE, selector: "user", namespace: null},
                      {kind: ARRAY_TYPE, selector: "name", namespace: null}]),
  c: isAttributeType([{kind: ATTRIBUTE_TYPE, selector: "name", namespace: null}])
}
```

#### Output

```Json
{
  "a": true,
  "b": false,
  "c": true
}
```

<!-- document id=c8108d14638d600779e4e0e9101646fcd4d20fa14acb3eeadc74aaba35b0e25d url=/mulesoft/current/en-us/dataweave/2.12/dw-tree-functions-isattributetype.md -->

---
product: DataWeave
version: 2.12
---

# isAttributeType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isAttributeType(path: Path): Boolean

Returns `true` if the provided `Path` value is an `ATTRIBUTE_TYPE` expression.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>path</code></p></td><td><p>The <code>Path</code> value to validate.</p></td></tr></tbody></table>

### Example

This example shows how `isAttributeType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
output application/json
---
{
  a: isAttributeType([{kind: OBJECT_TYPE, selector: "user", namespace: null},
                      {kind: ATTRIBUTE_TYPE, selector: "name", namespace: null}]),
  b: isAttributeType([{kind: OBJECT_TYPE, selector: "user", namespace: null},
                      {kind: ARRAY_TYPE, selector: "name", namespace: null}]),
  c: isAttributeType([{kind: ATTRIBUTE_TYPE, selector: "name", namespace: null}])
}
```

#### Output

```Json
{
  "a": true,
  "b": false,
  "c": true
}
```

<!-- document id=dcafd96dbefc66a741a879754abf1ea4c914bc0fdd06fcd0b61f92aee4a86735 url=/mulesoft/current/en-us/dataweave/2.4/dw-tree-functions-isattributetype.md -->

---
product: DataWeave
version: 2.4
---

# isAttributeType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isAttributeType(path: Path): Boolean

Returns `true` if the provided `Path` value is an `ATTRIBUTE_TYPE` expression.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>path</code></p></td><td><p>The <code>Path</code> value to validate.</p></td></tr></tbody></table>

### Example

This example shows how `isAttributeType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
output application/json
---
{
  a: isAttributeType([{kind: OBJECT_TYPE, selector: "user", namespace: null},
                      {kind: ATTRIBUTE_TYPE, selector: "name", namespace: null}]),
  b: isAttributeType([{kind: OBJECT_TYPE, selector: "user", namespace: null},
                      {kind: ARRAY_TYPE, selector: "name", namespace: null}]),
  c: isAttributeType([{kind: ATTRIBUTE_TYPE, selector: "name", namespace: null}])
}
```

#### Output

```Json
{
  "a": true,
  "b": false,
  "c": true
}
```

<!-- document id=a28bc5333bec3d7dee4d5f03df1d8209b212782877c1492abe5ab5964503a426 url=/mulesoft/current/en-us/dataweave/2.6/dw-tree-functions-isattributetype.md -->

---
product: DataWeave
version: 2.6
---

# isAttributeType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isAttributeType(path: Path): Boolean

Returns `true` if the provided `Path` value is an `ATTRIBUTE_TYPE` expression.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>path</code></p></td><td><p>The <code>Path</code> value to validate.</p></td></tr></tbody></table>

### Example

This example shows how `isAttributeType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
output application/json
---
{
  a: isAttributeType([{kind: OBJECT_TYPE, selector: "user", namespace: null},
                      {kind: ATTRIBUTE_TYPE, selector: "name", namespace: null}]),
  b: isAttributeType([{kind: OBJECT_TYPE, selector: "user", namespace: null},
                      {kind: ARRAY_TYPE, selector: "name", namespace: null}]),
  c: isAttributeType([{kind: ATTRIBUTE_TYPE, selector: "name", namespace: null}])
}
```

#### Output

```Json
{
  "a": true,
  "b": false,
  "c": true
}
```

<!-- document id=8caf3fa7907662286b8f1299dbbb2b1ac4c4587dbac8b77f8a2de8baee382dde url=/mulesoft/current/en-us/dataweave/2.9/dw-tree-functions-isattributetype.md -->

---
product: DataWeave
version: 2.9
---

# isAttributeType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isAttributeType(path: Path): Boolean

Returns `true` if the provided `Path` value is an `ATTRIBUTE_TYPE` expression.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>path</code></p></td><td><p>The <code>Path</code> value to validate.</p></td></tr></tbody></table>

### Example

This example shows how `isAttributeType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
output application/json
---
{
  a: isAttributeType([{kind: OBJECT_TYPE, selector: "user", namespace: null},
                      {kind: ATTRIBUTE_TYPE, selector: "name", namespace: null}]),
  b: isAttributeType([{kind: OBJECT_TYPE, selector: "user", namespace: null},
                      {kind: ARRAY_TYPE, selector: "name", namespace: null}]),
  c: isAttributeType([{kind: ATTRIBUTE_TYPE, selector: "name", namespace: null}])
}
```

#### Output

```Json
{
  "a": true,
  "b": false,
  "c": true
}
```

<!-- document id=1b361983107cf490349ac0e5050545d8e1335b5730e542bda15bd71bcb132f5d url=/mulesoft/current/en-us/dataweave/latest/dw-tree-functions-isattributetype.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# isAttributeType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isAttributeType(path: Path): Boolean

Returns `true` if the provided `Path` value is an `ATTRIBUTE_TYPE` expression.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>path</code></p></td><td><p>The <code>Path</code> value to validate.</p></td></tr></tbody></table>

### Example

This example shows how `isAttributeType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
output application/json
---
{
  a: isAttributeType([{kind: OBJECT_TYPE, selector: "user", namespace: null},
                      {kind: ATTRIBUTE_TYPE, selector: "name", namespace: null}]),
  b: isAttributeType([{kind: OBJECT_TYPE, selector: "user", namespace: null},
                      {kind: ARRAY_TYPE, selector: "name", namespace: null}]),
  c: isAttributeType([{kind: ATTRIBUTE_TYPE, selector: "name", namespace: null}])
}
```

#### Output

```Json
{
  "a": true,
  "b": false,
  "c": true
}
```

<!-- document id=c35cdd7f34a02a5908d98857610ab43089ea553dc495726f3bb6885552293bdf url=/mulesoft/current/en-us/dataweave/2.11/dw-types-functions-isbinarytype.md -->

---
product: DataWeave
version: 2.11
---

# isBinaryType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isBinaryType(t: Type): Boolean

Returns `true` if the input is the Binary type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isBinaryType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ABinary = Binary
output application/json
---
{
   a: isBinaryType(ABinary),
   b: isBinaryType(Binary),
   c: isBinaryType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=f7074b84c622efa845cb61f6a4b51490df294d226c6f66330c4501c84e51de5e url=/mulesoft/current/en-us/dataweave/2.12/dw-types-functions-isbinarytype.md -->

---
product: DataWeave
version: 2.12
---

# isBinaryType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isBinaryType(t: Type): Boolean

Returns `true` if the input is the Binary type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isBinaryType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ABinary = Binary
output application/json
---
{
   a: isBinaryType(ABinary),
   b: isBinaryType(Binary),
   c: isBinaryType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=712accd8362c587d34efe98ed2102cce90ec7f4865b78e338366b8271e195f45 url=/mulesoft/current/en-us/dataweave/2.3/dw-types-functions-isbinarytype.md -->

---
product: DataWeave
version: 2.3
---

# isBinaryType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isBinaryType(Type): Boolean

Returns `true` if the input is the Binary type.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>t</p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isBinaryType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ABinary = Binary
output application/json
---
{
   a: isBinaryType(ABinary),
   b: isBinaryType(Binary),
   c: isBinaryType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=8de9f305cf771f67151e189d6ae5d8b04e01085b86c15fa4f61a9abdd9c2967f url=/mulesoft/current/en-us/dataweave/2.4/dw-types-functions-isbinarytype.md -->

---
product: DataWeave
version: 2.4
---

# isBinaryType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isBinaryType(t: Type): Boolean

Returns `true` if the input is the Binary type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isBinaryType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ABinary = Binary
output application/json
---
{
   a: isBinaryType(ABinary),
   b: isBinaryType(Binary),
   c: isBinaryType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=a3d001848acc2fd46c05b709f31e36c505f3c4d90cac488e6e4a0241836ff34b url=/mulesoft/current/en-us/dataweave/2.6/dw-types-functions-isbinarytype.md -->

---
product: DataWeave
version: 2.6
---

# isBinaryType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isBinaryType(t: Type): Boolean

Returns `true` if the input is the Binary type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isBinaryType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ABinary = Binary
output application/json
---
{
   a: isBinaryType(ABinary),
   b: isBinaryType(Binary),
   c: isBinaryType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=b29ee304db91a3f262dffd2f881431766a51dc1cca5c3b3f9ce67d4345c703b1 url=/mulesoft/current/en-us/dataweave/2.9/dw-types-functions-isbinarytype.md -->

---
product: DataWeave
version: 2.9
---

# isBinaryType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isBinaryType(t: Type): Boolean

Returns `true` if the input is the Binary type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isBinaryType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ABinary = Binary
output application/json
---
{
   a: isBinaryType(ABinary),
   b: isBinaryType(Binary),
   c: isBinaryType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=052f3c384b2b1d348dec26c853c5ee61dd09a9d96c08ce4d105ad2d969012e28 url=/mulesoft/current/en-us/dataweave/latest/dw-types-functions-isbinarytype.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# isBinaryType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isBinaryType(t: Type): Boolean

Returns `true` if the input is the Binary type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isBinaryType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ABinary = Binary
output application/json
---
{
   a: isBinaryType(ABinary),
   b: isBinaryType(Binary),
   c: isBinaryType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=825e9d131dc743cc8c67e42a3bb495f4516e0893c0d2d822b08560f6985aa142 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-isblank.md -->

---
product: DataWeave
version: 2.11
---

# isBlank

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isBlank(text: String | Null): Boolean

Returns `true` if the given string is empty (`""`), completely composed of whitespaces, or `null`.
Otherwise, the function returns `false`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>An input string to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the given values are blank. It also uses the `not` and `!` operators
to check that a value is not blank. The `!` operator is supported starting in Dataweave 2.2.0. Use
`!` only in Mule 4.2 and later versions.

#### Source

```DataWeave
%dw 2.0
output  application/json
var someString = "something"
var nullString = null
---
{
  // checking if the string is blank
  "emptyString" : isBlank(""),
  "stringWithSpaces" : isBlank("      "),
  "textString" : isBlank(someString),
  "somePayloadValue" : isBlank(payload.nonExistingValue),
  "nullString" : isBlank(nullString),

  // checking if the string is not blank
  "notEmptyTextString" : not isBlank(" 1234"),
  "notEmptyTextStringTwo" : ! isBlank("")
}
```

#### Output

```JSON
{
  "emptyString": true,
  "stringWithSpaces": true,
  "textString": false,
  "somePayloadValue": true,
  "nullString": true,
  "notEmptyTextString": true,
  "notEmptyTextStringTwo": false
}
```

<!-- document id=eae905f2903fdd45d6fb8bf6aaee33fbfc0b0b0762e5bd02c12d7c219c123ad3 url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-isblank.md -->

---
product: DataWeave
version: 2.12
---

# isBlank

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isBlank(text: String | Null): Boolean

Returns `true` if the given string is empty (`""`), completely composed of whitespaces, or `null`.
Otherwise, the function returns `false`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>An input string to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the given values are blank. It also uses the `not` and `!` operators
to check that a value is not blank. The `!` operator is supported starting in Dataweave 2.2.0. Use
`!` only in Mule 4.2 and later versions.

#### Source

```DataWeave
%dw 2.0
output  application/json
var someString = "something"
var nullString = null
---
{
  // checking if the string is blank
  "emptyString" : isBlank(""),
  "stringWithSpaces" : isBlank("      "),
  "textString" : isBlank(someString),
  "somePayloadValue" : isBlank(payload.nonExistingValue),
  "nullString" : isBlank(nullString),

  // checking if the string is not blank
  "notEmptyTextString" : not isBlank(" 1234"),
  "notEmptyTextStringTwo" : ! isBlank("")
}
```

#### Output

```JSON
{
  "emptyString": true,
  "stringWithSpaces": true,
  "textString": false,
  "somePayloadValue": true,
  "nullString": true,
  "notEmptyTextString": true,
  "notEmptyTextStringTwo": false
}
```

<!-- document id=ab6d8712226e38ae6ac3c3a26cb886df84c3fbe2388a5d3419bf08c9cbe7d493 url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-isblank.md -->

---
product: DataWeave
version: 2.3
---

# isBlank

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isBlank(String | Null): Boolean

Returns `true` if the given string is empty (`""`), completely composed of whitespaces, or `null`.
Otherwise, the function returns `false`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>An input string to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the given values are blank. It also uses the `not` and `!` operators
to check that a value is not blank.

The `!` operator is supported starting in Dataweave 2.2.0. Use `!` only in Mule 4.2 and later
versions.

#### Source

```DataWeave
%dw 2.0
output  application/json
var someString = "something"
var nullString = null
---
{
  // checking if the string is blank
  "emptyString" : isBlank(""),
  "stringWithSpaces" : isBlank("      "),
  "textString" : isBlank(someString),
  "somePayloadValue" : isBlank(payload.nonExistingValue),
  "nullString" : isBlank(nullString),

  // checking if the string is not blank
  "notEmptyTextString" : not isBlank(" 1234"),
  "notEmptyTextStringTwo" : ! isBlank("")
}
```

#### Output

```JSON
{
  "emptyString": true,
  "stringWithSpaces": true,
  "textString": false,
  "somePayloadValue": true,
  "nullString": true,
  "notEmptyTextString": true,
  "notEmptyTextStringTwo": false
}
```

<!-- document id=7be06ca3f9189783131bfcdf7d7a04d4cf9feb461df93faf6c493a57f525cda4 url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-isblank.md -->

---
product: DataWeave
version: 2.4
---

# isBlank

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isBlank(text: String | Null): Boolean

Returns `true` if the given string is empty (`""`), completely composed of whitespaces, or `null`.
Otherwise, the function returns `false`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>An input string to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the given values are blank. It also uses the `not` and `!` operators
to check that a value is not blank. The `!` operator is supported starting in Dataweave 2.2.0. Use
`!` only in Mule 4.2 and later versions.

#### Source

```DataWeave
%dw 2.0
output  application/json
var someString = "something"
var nullString = null
---
{
  // checking if the string is blank
  "emptyString" : isBlank(""),
  "stringWithSpaces" : isBlank("      "),
  "textString" : isBlank(someString),
  "somePayloadValue" : isBlank(payload.nonExistingValue),
  "nullString" : isBlank(nullString),

  // checking if the string is not blank
  "notEmptyTextString" : not isBlank(" 1234"),
  "notEmptyTextStringTwo" : ! isBlank("")
}
```

#### Output

```JSON
{
  "emptyString": true,
  "stringWithSpaces": true,
  "textString": false,
  "somePayloadValue": true,
  "nullString": true,
  "notEmptyTextString": true,
  "notEmptyTextStringTwo": false
}
```

<!-- document id=36eeb3fbc116522f3e317fe16de20df66a8eacd80bff48e3c2275eaee372152e url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-isblank.md -->

---
product: DataWeave
version: 2.6
---

# isBlank

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isBlank(text: String | Null): Boolean

Returns `true` if the given string is empty (`""`), completely composed of whitespaces, or `null`.
Otherwise, the function returns `false`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>An input string to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the given values are blank. It also uses the `not` and `!` operators
to check that a value is not blank. The `!` operator is supported starting in Dataweave 2.2.0. Use
`!` only in Mule 4.2 and later versions.

#### Source

```DataWeave
%dw 2.0
output  application/json
var someString = "something"
var nullString = null
---
{
  // checking if the string is blank
  "emptyString" : isBlank(""),
  "stringWithSpaces" : isBlank("      "),
  "textString" : isBlank(someString),
  "somePayloadValue" : isBlank(payload.nonExistingValue),
  "nullString" : isBlank(nullString),

  // checking if the string is not blank
  "notEmptyTextString" : not isBlank(" 1234"),
  "notEmptyTextStringTwo" : ! isBlank("")
}
```

#### Output

```JSON
{
  "emptyString": true,
  "stringWithSpaces": true,
  "textString": false,
  "somePayloadValue": true,
  "nullString": true,
  "notEmptyTextString": true,
  "notEmptyTextStringTwo": false
}
```

<!-- document id=827d2a943a91f0dcf3af1dbca93932cb86491884dbbca11dba23870e6f9cac64 url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-isblank.md -->

---
product: DataWeave
version: 2.9
---

# isBlank

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isBlank(text: String | Null): Boolean

Returns `true` if the given string is empty (`""`), completely composed of whitespaces, or `null`.
Otherwise, the function returns `false`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>An input string to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the given values are blank. It also uses the `not` and `!` operators
to check that a value is not blank. The `!` operator is supported starting in Dataweave 2.2.0. Use
`!` only in Mule 4.2 and later versions.

#### Source

```DataWeave
%dw 2.0
output  application/json
var someString = "something"
var nullString = null
---
{
  // checking if the string is blank
  "emptyString" : isBlank(""),
  "stringWithSpaces" : isBlank("      "),
  "textString" : isBlank(someString),
  "somePayloadValue" : isBlank(payload.nonExistingValue),
  "nullString" : isBlank(nullString),

  // checking if the string is not blank
  "notEmptyTextString" : not isBlank(" 1234"),
  "notEmptyTextStringTwo" : ! isBlank("")
}
```

#### Output

```JSON
{
  "emptyString": true,
  "stringWithSpaces": true,
  "textString": false,
  "somePayloadValue": true,
  "nullString": true,
  "notEmptyTextString": true,
  "notEmptyTextStringTwo": false
}
```

<!-- document id=4ef3909f9333b657e33a165cd4f12b2fbd0b2e02f811cd0ce61985a8d89a1b58 url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-isblank.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# isBlank

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isBlank(text: String | Null): Boolean

Returns `true` if the given string is empty (`""`), completely composed of whitespaces, or `null`.
Otherwise, the function returns `false`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>An input string to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the given values are blank. It also uses the `not` and `!` operators
to check that a value is not blank. The `!` operator is supported starting in Dataweave 2.2.0. Use
`!` only in Mule 4.2 and later versions.

#### Source

```DataWeave
%dw 2.0
output  application/json
var someString = "something"
var nullString = null
---
{
  // checking if the string is blank
  "emptyString" : isBlank(""),
  "stringWithSpaces" : isBlank("      "),
  "textString" : isBlank(someString),
  "somePayloadValue" : isBlank(payload.nonExistingValue),
  "nullString" : isBlank(nullString),

  // checking if the string is not blank
  "notEmptyTextString" : not isBlank(" 1234"),
  "notEmptyTextStringTwo" : ! isBlank("")
}
```

#### Output

```JSON
{
  "emptyString": true,
  "stringWithSpaces": true,
  "textString": false,
  "somePayloadValue": true,
  "nullString": true,
  "notEmptyTextString": true,
  "notEmptyTextStringTwo": false
}
```

<!-- document id=e622c75b97e64cf4d2f87dcedfb6a3f9647f8c5714bb733e336f698d30c9cbf8 url=/mulesoft/current/en-us/dataweave/2.11/dw-types-functions-isbooleantype.md -->

---
product: DataWeave
version: 2.11
---

# isBooleanType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isBooleanType(t: Type): Boolean

Returns `true` if the input is the Boolean type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isBooleanType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ABoolean = Boolean
output application/json
---
{
   a: isBooleanType(ABoolean),
   b: isBooleanType(Boolean),
   c: isBooleanType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=1513e6c188e3951b9541076bd0b3822466edc31dd33e31a11578bd065be96957 url=/mulesoft/current/en-us/dataweave/2.12/dw-types-functions-isbooleantype.md -->

---
product: DataWeave
version: 2.12
---

# isBooleanType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isBooleanType(t: Type): Boolean

Returns `true` if the input is the Boolean type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isBooleanType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ABoolean = Boolean
output application/json
---
{
   a: isBooleanType(ABoolean),
   b: isBooleanType(Boolean),
   c: isBooleanType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=e5f1e7f7806de9a0cd40dd76279f3056fdf4c9e6c58cb2c0468d378762a4df6a url=/mulesoft/current/en-us/dataweave/2.3/dw-types-functions-isbooleantype.md -->

---
product: DataWeave
version: 2.3
---

# isBooleanType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isBooleanType(Type): Boolean

Returns `true` if the input is the Boolean type.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>t</p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isBooleanType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ABoolean = Boolean
output application/json
---
{
   a: isBooleanType(ABoolean),
   b: isBooleanType(Boolean),
   c: isBooleanType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=d87e9fb0d74ca95c075d9e81c1b4b50f31cdee5f16919fa4fd1ad12bc4a0a68c url=/mulesoft/current/en-us/dataweave/2.4/dw-types-functions-isbooleantype.md -->

---
product: DataWeave
version: 2.4
---

# isBooleanType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isBooleanType(t: Type): Boolean

Returns `true` if the input is the Boolean type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isBooleanType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ABoolean = Boolean
output application/json
---
{
   a: isBooleanType(ABoolean),
   b: isBooleanType(Boolean),
   c: isBooleanType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=e75ce2753f73b41b8eb430fff7a847c7820564a172df9b850d04238480b3045f url=/mulesoft/current/en-us/dataweave/2.6/dw-types-functions-isbooleantype.md -->

---
product: DataWeave
version: 2.6
---

# isBooleanType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isBooleanType(t: Type): Boolean

Returns `true` if the input is the Boolean type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isBooleanType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ABoolean = Boolean
output application/json
---
{
   a: isBooleanType(ABoolean),
   b: isBooleanType(Boolean),
   c: isBooleanType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=6d8285780c254337d4127b83a56db22294c478fae5b039d167849bb0f23be05c url=/mulesoft/current/en-us/dataweave/2.9/dw-types-functions-isbooleantype.md -->

---
product: DataWeave
version: 2.9
---

# isBooleanType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isBooleanType(t: Type): Boolean

Returns `true` if the input is the Boolean type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isBooleanType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ABoolean = Boolean
output application/json
---
{
   a: isBooleanType(ABoolean),
   b: isBooleanType(Boolean),
   c: isBooleanType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=792cc38b86e44dc3daa15df92b69a7a15e4ee42a7e0455c7eb3a58b481b2eb6a url=/mulesoft/current/en-us/dataweave/latest/dw-types-functions-isbooleantype.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# isBooleanType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isBooleanType(t: Type): Boolean

Returns `true` if the input is the Boolean type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isBooleanType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ABoolean = Boolean
output application/json
---
{
   a: isBooleanType(ABoolean),
   b: isBooleanType(Boolean),
   c: isBooleanType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=5c9555f4cf8bf874528fd529af23d5dc9fb3680cc8292a7d04038e656cd40a76 url=/mulesoft/current/en-us/dataweave/2.11/dw-types-functions-isdatetimetype.md -->

---
product: DataWeave
version: 2.11
---

# isDateTimeType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isDateTimeType(t: Type): Boolean

Returns `true` if the input is the DateTime type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isDateTimeType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ADateTime = DateTime
output application/json
---
{
   a: isDateTimeType(ADateTime),
   b: isDateTimeType(DateTime),
   c: isDateTimeType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=a542c6cec5338f0e6e8a009271df639e1ac87e8ef26d34541170ba680283104c url=/mulesoft/current/en-us/dataweave/2.12/dw-types-functions-isdatetimetype.md -->

---
product: DataWeave
version: 2.12
---

# isDateTimeType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isDateTimeType(t: Type): Boolean

Returns `true` if the input is the DateTime type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isDateTimeType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ADateTime = DateTime
output application/json
---
{
   a: isDateTimeType(ADateTime),
   b: isDateTimeType(DateTime),
   c: isDateTimeType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=4ed8ed821ddab64147ea2b98d616e422ffc31f1b79835a1f861b585eaca9acb9 url=/mulesoft/current/en-us/dataweave/2.3/dw-types-functions-isdatetimetype.md -->

---
product: DataWeave
version: 2.3
---

# isDateTimeType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isDateTimeType(Type): Boolean

Returns `true` if the input is the DateTime type.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>t</p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isDateTimeType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ADateTime = DateTime
output application/json
---
{
   a: isDateTimeType(ADateTime),
   b: isDateTimeType(DateTime),
   c: isDateTimeType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=1ebd95ffb2459b5a18459932c612bb5188a20d20188bbb8eb73be8bccba63873 url=/mulesoft/current/en-us/dataweave/2.4/dw-types-functions-isdatetimetype.md -->

---
product: DataWeave
version: 2.4
---

# isDateTimeType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isDateTimeType(t: Type): Boolean

Returns `true` if the input is the DateTime type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isDateTimeType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ADateTime = DateTime
output application/json
---
{
   a: isDateTimeType(ADateTime),
   b: isDateTimeType(DateTime),
   c: isDateTimeType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=abfe348cdce87daf9b7590bff1d56e70ed4b6f10612e74b0776ad9f8ab660130 url=/mulesoft/current/en-us/dataweave/2.6/dw-types-functions-isdatetimetype.md -->

---
product: DataWeave
version: 2.6
---

# isDateTimeType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isDateTimeType(t: Type): Boolean

Returns `true` if the input is the DateTime type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isDateTimeType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ADateTime = DateTime
output application/json
---
{
   a: isDateTimeType(ADateTime),
   b: isDateTimeType(DateTime),
   c: isDateTimeType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=744da708be31d2fcd2fadc9094a2b61247b7aff84be30d0ae2fa51cec40b92e1 url=/mulesoft/current/en-us/dataweave/2.9/dw-types-functions-isdatetimetype.md -->

---
product: DataWeave
version: 2.9
---

# isDateTimeType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isDateTimeType(t: Type): Boolean

Returns `true` if the input is the DateTime type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isDateTimeType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ADateTime = DateTime
output application/json
---
{
   a: isDateTimeType(ADateTime),
   b: isDateTimeType(DateTime),
   c: isDateTimeType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=b1bfe6514faac3235a0fc1e60d3bf7527a85be618e9f5e38cf288939b254dfa5 url=/mulesoft/current/en-us/dataweave/latest/dw-types-functions-isdatetimetype.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# isDateTimeType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isDateTimeType(t: Type): Boolean

Returns `true` if the input is the DateTime type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isDateTimeType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ADateTime = DateTime
output application/json
---
{
   a: isDateTimeType(ADateTime),
   b: isDateTimeType(DateTime),
   c: isDateTimeType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=2d535b1a6b103d88a1620b3910f4eb791505073a5ebae048b2e8e3caeb2760de url=/mulesoft/current/en-us/dataweave/2.11/dw-types-functions-isdatetype.md -->

---
product: DataWeave
version: 2.11
---

# isDateType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isDateType(t: Type): Boolean

Returns `true` if the input is the Date type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isDateType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ADate = Date
output application/json
---
{
   a: isDateType(ADate),
   b: isDateType(Date),
   c: isDateType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=8667a5602ce0a411484c4cc67f99a861e43b4945ecf50c79ede1ca4f84246f47 url=/mulesoft/current/en-us/dataweave/2.12/dw-types-functions-isdatetype.md -->

---
product: DataWeave
version: 2.12
---

# isDateType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isDateType(t: Type): Boolean

Returns `true` if the input is the Date type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isDateType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ADate = Date
output application/json
---
{
   a: isDateType(ADate),
   b: isDateType(Date),
   c: isDateType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=5763e901af49e0339e581da3ac6324082b6e12425fbc4b62e098af377a6a6def url=/mulesoft/current/en-us/dataweave/2.3/dw-types-functions-isdatetype.md -->

---
product: DataWeave
version: 2.3
---

# isDateType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isDateType(Type): Boolean

Returns `true` if the input is the Date type.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>t</p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isDateType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ADate = Date
output application/json
---
{
   a: isDateType(ADate),
   b: isDateType(Date),
   c: isDateType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=429980ca9344d280e1c0d04bbb228ce5c1ea0bb22f03595b4f5e490423a421ef url=/mulesoft/current/en-us/dataweave/2.4/dw-types-functions-isdatetype.md -->

---
product: DataWeave
version: 2.4
---

# isDateType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isDateType(t: Type): Boolean

Returns `true` if the input is the Date type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isDateType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ADate = Date
output application/json
---
{
   a: isDateType(ADate),
   b: isDateType(Date),
   c: isDateType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=497ca3be946a47ec9aa7800b2d46661237e2ad4038c33fbe9640229bfa4ba6f7 url=/mulesoft/current/en-us/dataweave/2.6/dw-types-functions-isdatetype.md -->

---
product: DataWeave
version: 2.6
---

# isDateType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isDateType(t: Type): Boolean

Returns `true` if the input is the Date type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isDateType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ADate = Date
output application/json
---
{
   a: isDateType(ADate),
   b: isDateType(Date),
   c: isDateType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=9eacead2116a6a60a33aca2e818dfb7c91373a9249933722312293984ade0fe1 url=/mulesoft/current/en-us/dataweave/2.9/dw-types-functions-isdatetype.md -->

---
product: DataWeave
version: 2.9
---

# isDateType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isDateType(t: Type): Boolean

Returns `true` if the input is the Date type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isDateType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ADate = Date
output application/json
---
{
   a: isDateType(ADate),
   b: isDateType(Date),
   c: isDateType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=77fffa9b052070fc13b5de568c51c62a6b1d8fbd58235650587b0dc20cebe4c8 url=/mulesoft/current/en-us/dataweave/latest/dw-types-functions-isdatetype.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# isDateType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isDateType(t: Type): Boolean

Returns `true` if the input is the Date type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isDateType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ADate = Date
output application/json
---
{
   a: isDateType(ADate),
   b: isDateType(Date),
   c: isDateType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=33530d1358afc6e671a74a6095821e7bd9fbb3b143b796b76de69cc5ec703d07 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-isdecimal.md -->

---
product: DataWeave
version: 2.11
---

# isDecimal

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isDecimal(number: Number): Boolean

Returns `true` if the given number contains a decimal, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether a number has a decimal. Note that numbers within strings get coerced
to numbers.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ isDecimal(1.1), isDecimal(1), isDecimal("1.1") ]
```

#### Output

```JSON
[ true, false, true ]
```

<!-- document id=2b46e650898ad912acb4afc43381a490cd9d1b4caafdfcbf7a6633c9b9cd83cc url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-isdecimal.md -->

---
product: DataWeave
version: 2.12
---

# isDecimal

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isDecimal(number: Number): Boolean

Returns `true` if the given number contains a decimal, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether a number has a decimal. Note that numbers within strings get coerced
to numbers.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ isDecimal(1.1), isDecimal(1), isDecimal("1.1") ]
```

#### Output

```JSON
[ true, false, true ]
```

<!-- document id=d4eaf368f04661bea8b0855e3a7ed83b06b82ed73f6652549c53483fb75aad0d url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-isdecimal.md -->

---
product: DataWeave
version: 2.3
---

# isDecimal

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isDecimal(Number): Boolean

Returns `true` if the given number contains a decimal, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether a number has a decimal. Note that numbers within strings get coerced
to numbers.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ isDecimal(1.1), isDecimal(1), isDecimal("1.1") ]
```

#### Output

```JSON
[ true, false, true ]
```

<!-- document id=ac3da66f5336858eb2e532b06ebb1304959eaab343916d372bdbd3d92fece2fe url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-isdecimal.md -->

---
product: DataWeave
version: 2.4
---

# isDecimal

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isDecimal(number: Number): Boolean

Returns `true` if the given number contains a decimal, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether a number has a decimal. Note that numbers within strings get coerced
to numbers.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ isDecimal(1.1), isDecimal(1), isDecimal("1.1") ]
```

#### Output

```JSON
[ true, false, true ]
```

<!-- document id=4f56c034560d224a8c24f74a54c5cafb61dbc852bcc6cd6744ba1fbc01a77148 url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-isdecimal.md -->

---
product: DataWeave
version: 2.6
---

# isDecimal

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isDecimal(number: Number): Boolean

Returns `true` if the given number contains a decimal, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether a number has a decimal. Note that numbers within strings get coerced
to numbers.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ isDecimal(1.1), isDecimal(1), isDecimal("1.1") ]
```

#### Output

```JSON
[ true, false, true ]
```

<!-- document id=60eb398ebbae051b5c3016cd43ae577c5c1073f1395788ddf58c7bf997914ef9 url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-isdecimal.md -->

---
product: DataWeave
version: 2.9
---

# isDecimal

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isDecimal(number: Number): Boolean

Returns `true` if the given number contains a decimal, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether a number has a decimal. Note that numbers within strings get coerced
to numbers.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ isDecimal(1.1), isDecimal(1), isDecimal("1.1") ]
```

#### Output

```JSON
[ true, false, true ]
```

<!-- document id=aaeaa2ccbef09b350ca521c533a0c102d151b0e08473a88d587c59c71b105f1f url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-isdecimal.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# isDecimal

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isDecimal(number: Number): Boolean

Returns `true` if the given number contains a decimal, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether a number has a decimal. Note that numbers within strings get coerced
to numbers.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ isDecimal(1.1), isDecimal(1), isDecimal("1.1") ]
```

#### Output

```JSON
[ true, false, true ]
```

<!-- document id=1f5e72fea19b867c4a73c1107c0e00ac7c26284b12e151fbcb981761b6e03937 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-isempty.md -->

---
product: DataWeave
version: 2.11
---

# isEmpty

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isEmpty(elements: Array<Any>): Boolean

Returns `true` if the given input value is empty, `false` if not.

This version of `isEmpty` acts on an array. Other versions act on a string or object, and handle
null values.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>elements</code></p></td><td><p>The input array to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input array is empty.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ isEmpty([]), isEmpty([1]) ]
```

#### Output

```JSON
[ true, false ]
```

## isEmpty(value: String): Boolean

Returns `true` if the input string is empty, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>A string to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input strings are empty.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ isEmpty(""), isEmpty("DataWeave") ]
```

#### Output

```JSON
[ true, false ]
```

## isEmpty(value: Object): Boolean

Returns `true` if the given object is empty, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input objects are empty.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ isEmpty({}), isEmpty({name: "DataWeave"}) ]
```

#### Output

```JSON
[ true, false ]
```

## isEmpty(value: Binary): Boolean

Returns `true` if the input binary is empty, `false` if not.

_Introduced in DataWeave version 2.11.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>Binary</p></td><td><p>The input binary value.</p></td></tr></tbody></table>

### Example

This example indicates whether the input binary is empty.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ isEmpty("" as Binary), isEmpty("DataWeave" as Binary) ]
```

#### Output

```JSON
[ true, false ]
```

## isEmpty(value: Null): true

Returns `true` if the input is `null`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p><code>null</code> is the value in this case.</p></td></tr></tbody></table>

### Example

This example indicates whether the input is `null`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "nullValue" : isEmpty(null) }
```

#### Output

```JSON
{ "nullValue": true }
```

<!-- document id=6257e9788ea3a66209ae6ba5862ec6850f73b6f06a786a383e5ffdfbc7903ea9 url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-isempty.md -->

---
product: DataWeave
version: 2.12
---

# isEmpty

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isEmpty(elements: Array<Any>): Boolean

Returns `true` if the given input value is empty, `false` if not.

This version of `isEmpty` acts on an array. Other versions act on a string or object, and handle
null values.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>elements</code></p></td><td><p>The input array to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input array is empty.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ isEmpty([]), isEmpty([1]) ]
```

#### Output

```JSON
[ true, false ]
```

## isEmpty(value: String): Boolean

Returns `true` if the input string is empty, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>A string to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input strings are empty.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ isEmpty(""), isEmpty("DataWeave") ]
```

#### Output

```JSON
[ true, false ]
```

## isEmpty(value: Object): Boolean

Returns `true` if the given object is empty, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input objects are empty.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ isEmpty({}), isEmpty({name: "DataWeave"}) ]
```

#### Output

```JSON
[ true, false ]
```

## isEmpty(value: Binary): Boolean

Returns `true` if the input binary is empty, `false` if not.

_Introduced in DataWeave version 2.11.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>Binary</p></td><td><p>The input binary value.</p></td></tr></tbody></table>

### Example

This example indicates whether the input binary is empty.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ isEmpty("" as Binary), isEmpty("DataWeave" as Binary) ]
```

#### Output

```JSON
[ true, false ]
```

## isEmpty(value: Null): true

Returns `true` if the input is `null`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p><code>null</code> is the value in this case.</p></td></tr></tbody></table>

### Example

This example indicates whether the input is `null`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "nullValue" : isEmpty(null) }
```

#### Output

```JSON
{ "nullValue": true }
```

<!-- document id=6cd62153f5991dcbfca4e1cdb58b6c530705a998adfd98259247ea7164aba2d0 url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-isempty.md -->

---
product: DataWeave
version: 2.3
---

# isEmpty

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isEmpty(Array<Any>): Boolean

Returns `true` if the given input value is empty, `false` if not.

This version of `isEmpty` acts on an array. Other versions act on a string or object, and handle
null values.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>elements</code></p></td><td><p>The input array to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input array is empty.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ isEmpty([]), isEmpty([1]) ]
```

#### Output

```JSON
[ true, false ]
```

## isEmpty(String): Boolean

Returns `true` if the input string is empty, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>A string to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input strings are empty.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ isEmpty(""), isEmpty("DataWeave") ]
```

#### Output

```JSON
[ true, false ]
```

## isEmpty(Null): Boolean

Returns `true` if the input is `null`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p><code>null</code> is the value in this case.</p></td></tr></tbody></table>

### Example

This example indicates whether the input is `null`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "nullValue" : isEmpty(null) }
```

#### Output

```JSON
{ "nullValue": true }
```

## isEmpty(Object): Boolean

Returns `true` if the given object is empty, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input objects are empty.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ isEmpty({}), isEmpty({name: "DataWeave"}) ]
```

#### Output

```JSON
[ true, false ]
```

<!-- document id=875e60c5d12bddc955ae0cd4bf0e76a310eca8c04880a133ff682bc3c3c5e913 url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-isempty.md -->

---
product: DataWeave
version: 2.4
---

# isEmpty

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isEmpty(elements: Array<Any>): Boolean

Returns `true` if the given input value is empty, `false` if not.

This version of `isEmpty` acts on an array. Other versions act on a string or object, and handle
null values.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>elements</code></p></td><td><p>The input array to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input array is empty.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ isEmpty([]), isEmpty([1]) ]
```

#### Output

```JSON
[ true, false ]
```

## isEmpty(value: String): Boolean

Returns `true` if the input string is empty, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>A string to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input strings are empty.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ isEmpty(""), isEmpty("DataWeave") ]
```

#### Output

```JSON
[ true, false ]
```

## isEmpty(value: Object): Boolean

Returns `true` if the given object is empty, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input objects are empty.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ isEmpty({}), isEmpty({name: "DataWeave"}) ]
```

#### Output

```JSON
[ true, false ]
```

## isEmpty(value: Null): true

Returns `true` if the input is `null`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p><code>null</code> is the value in this case.</p></td></tr></tbody></table>

### Example

This example indicates whether the input is `null`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "nullValue" : isEmpty(null) }
```

#### Output

```JSON
{ "nullValue": true }
```

<!-- document id=d47b8d7a2208417ce43959d855115a81dbe67b17fe355000d93541a0eccde5f3 url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-isempty.md -->

---
product: DataWeave
version: 2.6
---

# isEmpty

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isEmpty(elements: Array<Any>): Boolean

Returns `true` if the given input value is empty, `false` if not.

This version of `isEmpty` acts on an array. Other versions act on a string or object, and handle
null values.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>elements</code></p></td><td><p>The input array to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input array is empty.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ isEmpty([]), isEmpty([1]) ]
```

#### Output

```JSON
[ true, false ]
```

## isEmpty(value: String): Boolean

Returns `true` if the input string is empty, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>A string to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input strings are empty.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ isEmpty(""), isEmpty("DataWeave") ]
```

#### Output

```JSON
[ true, false ]
```

## isEmpty(value: Object): Boolean

Returns `true` if the given object is empty, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input objects are empty.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ isEmpty({}), isEmpty({name: "DataWeave"}) ]
```

#### Output

```JSON
[ true, false ]
```

## isEmpty(value: Null): true

Returns `true` if the input is `null`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p><code>null</code> is the value in this case.</p></td></tr></tbody></table>

### Example

This example indicates whether the input is `null`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "nullValue" : isEmpty(null) }
```

#### Output

```JSON
{ "nullValue": true }
```

<!-- document id=93eac96043f053379edf6b82fa4fcf5a4a5533b4e20fb7307ae7d431ada32a09 url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-isempty.md -->

---
product: DataWeave
version: 2.9
---

# isEmpty

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isEmpty(elements: Array<Any>): Boolean

Returns `true` if the given input value is empty, `false` if not.

This version of `isEmpty` acts on an array. Other versions act on a string or object, and handle
null values.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>elements</code></p></td><td><p>The input array to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input array is empty.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ isEmpty([]), isEmpty([1]) ]
```

#### Output

```JSON
[ true, false ]
```

## isEmpty(value: String): Boolean

Returns `true` if the input string is empty, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>A string to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input strings are empty.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ isEmpty(""), isEmpty("DataWeave") ]
```

#### Output

```JSON
[ true, false ]
```

## isEmpty(value: Object): Boolean

Returns `true` if the given object is empty, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input objects are empty.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ isEmpty({}), isEmpty({name: "DataWeave"}) ]
```

#### Output

```JSON
[ true, false ]
```

## isEmpty(value: Null): true

Returns `true` if the input is `null`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p><code>null</code> is the value in this case.</p></td></tr></tbody></table>

### Example

This example indicates whether the input is `null`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "nullValue" : isEmpty(null) }
```

#### Output

```JSON
{ "nullValue": true }
```

<!-- document id=586860219deb16c5a36c09121ce830dca507c11361b667c8a838d09281f8c0e7 url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-isempty.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# isEmpty

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isEmpty(elements: Array<Any>): Boolean

Returns `true` if the given input value is empty, `false` if not.

This version of `isEmpty` acts on an array. Other versions act on a string or object, and handle
null values.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>elements</code></p></td><td><p>The input array to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input array is empty.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ isEmpty([]), isEmpty([1]) ]
```

#### Output

```JSON
[ true, false ]
```

## isEmpty(value: String): Boolean

Returns `true` if the input string is empty, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>A string to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input strings are empty.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ isEmpty(""), isEmpty("DataWeave") ]
```

#### Output

```JSON
[ true, false ]
```

## isEmpty(value: Object): Boolean

Returns `true` if the given object is empty, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input objects are empty.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ isEmpty({}), isEmpty({name: "DataWeave"}) ]
```

#### Output

```JSON
[ true, false ]
```

## isEmpty(value: Binary): Boolean

Returns `true` if the input binary is empty, `false` if not.

_Introduced in DataWeave version 2.11.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>Binary</p></td><td><p>The input binary value.</p></td></tr></tbody></table>

### Example

This example indicates whether the input binary is empty.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ isEmpty("" as Binary), isEmpty("DataWeave" as Binary) ]
```

#### Output

```JSON
[ true, false ]
```

## isEmpty(value: Null): true

Returns `true` if the input is `null`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p><code>null</code> is the value in this case.</p></td></tr></tbody></table>

### Example

This example indicates whether the input is `null`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "nullValue" : isEmpty(null) }
```

#### Output

```JSON
{ "nullValue": true }
```

<!-- document id=870bc16b6b1d1027a665a859e0a4200cce309b16060ebf42bf39a9eb1c4a71b4 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-iseven.md -->

---
product: DataWeave
version: 2.11
---

# isEven

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isEven(number: Number): Boolean

Returns `true` if the number or numeric result of a mathematical operation is even, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the numbers and result of an operation are even.

#### Source

```DataWeave
%dw 2.0
output  application/json
---
{ "isEven" : [ isEven(0), isEven(1), isEven(1+1) ] }
```

#### Output

```JSON
{ "isEven" : [ true, false, true ] }
```

<!-- document id=a81ccf0cd9dbcbad916cf38160ad9f91203e8820e4497e22ffd589c6aa397639 url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-iseven.md -->

---
product: DataWeave
version: 2.12
---

# isEven

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isEven(number: Number): Boolean

Returns `true` if the number or numeric result of a mathematical operation is even, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the numbers and result of an operation are even.

#### Source

```DataWeave
%dw 2.0
output  application/json
---
{ "isEven" : [ isEven(0), isEven(1), isEven(1+1) ] }
```

#### Output

```JSON
{ "isEven" : [ true, false, true ] }
```

<!-- document id=300dca2e7140acb33f8da3cae0ecc22a51f545aa23af18464d42406571009753 url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-iseven.md -->

---
product: DataWeave
version: 2.3
---

# isEven

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isEven(Number): Boolean

Returns `true` if the number or numeric result of a mathematical operation is even, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the numbers and result of an operation are even.

#### Source

```DataWeave
%dw 2.0
output  application/json
---
{ "isEven" : [ isEven(0), isEven(1), isEven(1+1) ] }
```

#### Output

```JSON
{ "isEven" : [ true, false, true ] }
```

<!-- document id=f6f63936e729b0c591de11aaa4122859b4d5a03321a320890a13034a2084619b url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-iseven.md -->

---
product: DataWeave
version: 2.4
---

# isEven

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isEven(number: Number): Boolean

Returns `true` if the number or numeric result of a mathematical operation is even, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the numbers and result of an operation are even.

#### Source

```DataWeave
%dw 2.0
output  application/json
---
{ "isEven" : [ isEven(0), isEven(1), isEven(1+1) ] }
```

#### Output

```JSON
{ "isEven" : [ true, false, true ] }
```

<!-- document id=d56cc80c215bdd0ab7bf75b1d335eb360621cd12170d0a80e49fbcc36e5f09bf url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-iseven.md -->

---
product: DataWeave
version: 2.6
---

# isEven

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isEven(number: Number): Boolean

Returns `true` if the number or numeric result of a mathematical operation is even, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the numbers and result of an operation are even.

#### Source

```DataWeave
%dw 2.0
output  application/json
---
{ "isEven" : [ isEven(0), isEven(1), isEven(1+1) ] }
```

#### Output

```JSON
{ "isEven" : [ true, false, true ] }
```

<!-- document id=ea3b5b4de291e982b55dca82cbc6d907e314195bff3fb64e5997c4d039c9b3e4 url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-iseven.md -->

---
product: DataWeave
version: 2.9
---

# isEven

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isEven(number: Number): Boolean

Returns `true` if the number or numeric result of a mathematical operation is even, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the numbers and result of an operation are even.

#### Source

```DataWeave
%dw 2.0
output  application/json
---
{ "isEven" : [ isEven(0), isEven(1), isEven(1+1) ] }
```

#### Output

```JSON
{ "isEven" : [ true, false, true ] }
```

<!-- document id=c4f7f4e3e2f58311a350299fade26802723372876f80e20c0cf3d45a99f714a5 url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-iseven.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# isEven

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isEven(number: Number): Boolean

Returns `true` if the number or numeric result of a mathematical operation is even, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the numbers and result of an operation are even.

#### Source

```DataWeave
%dw 2.0
output  application/json
---
{ "isEven" : [ isEven(0), isEven(1), isEven(1+1) ] }
```

#### Output

```JSON
{ "isEven" : [ true, false, true ] }
```

<!-- document id=fb1b6599991e367d5b0eb48f2cd485f69bc19a51a20fab94b33f17adca6228c4 url=/mulesoft/current/en-us/dataweave/2.11/dw-types-functions-isfunctiontype.md -->

---
product: DataWeave
version: 2.11
---

# isFunctionType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isFunctionType(t: Type): Boolean

Returns `true` if the input is the Function type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isFunctionType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AFunction = (String) -> String
output application/json
---
{
   a: isFunctionType(AFunction),
   b: isFunctionType(Boolean)
}
```

#### Output

```Json
{
  "a": true,
  "b": false
}
```

<!-- document id=1c03b78f075c94746be6c97e114dffa29826c359293b7f5badc3f09db3841ff2 url=/mulesoft/current/en-us/dataweave/2.12/dw-types-functions-isfunctiontype.md -->

---
product: DataWeave
version: 2.12
---

# isFunctionType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isFunctionType(t: Type): Boolean

Returns `true` if the input is the Function type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isFunctionType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AFunction = (String) -> String
output application/json
---
{
   a: isFunctionType(AFunction),
   b: isFunctionType(Boolean)
}
```

#### Output

```Json
{
  "a": true,
  "b": false
}
```

<!-- document id=477fe7f03fd558c1dfb8710218f1a48bcf491df2059cd964c248fa6f600ce8eb url=/mulesoft/current/en-us/dataweave/2.3/dw-types-functions-isfunctiontype.md -->

---
product: DataWeave
version: 2.3
---

# isFunctionType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isFunctionType(Type): Boolean

Returns `true` if the input is the Function type.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>t</p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isFunctionType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AFunction = (String) -> String
output application/json
---
{
   a: isFunctionType(AFunction),
   b: isFunctionType(Boolean)
}
```

#### Output

```Json
{
  "a": true,
  "b": false
}
```

<!-- document id=024ca235a87756ad0da3c54003f0f64aaeda6f81ae747461cc5597e4752abf67 url=/mulesoft/current/en-us/dataweave/2.4/dw-types-functions-isfunctiontype.md -->

---
product: DataWeave
version: 2.4
---

# isFunctionType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isFunctionType(t: Type): Boolean

Returns `true` if the input is the Function type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isFunctionType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AFunction = (String) -> String
output application/json
---
{
   a: isFunctionType(AFunction),
   b: isFunctionType(Boolean)
}
```

#### Output

```Json
{
  "a": true,
  "b": false
}
```

<!-- document id=ffbe85541c9e15bd5ebe33ffd0253454d38d4093280cd6b6d0603cf6c94eb936 url=/mulesoft/current/en-us/dataweave/2.6/dw-types-functions-isfunctiontype.md -->

---
product: DataWeave
version: 2.6
---

# isFunctionType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isFunctionType(t: Type): Boolean

Returns `true` if the input is the Function type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isFunctionType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AFunction = (String) -> String
output application/json
---
{
   a: isFunctionType(AFunction),
   b: isFunctionType(Boolean)
}
```

#### Output

```Json
{
  "a": true,
  "b": false
}
```

<!-- document id=bb40d0d69f20bbdb0226a0bb2c8f419d91f9834f847db8eb70b88dc248a46943 url=/mulesoft/current/en-us/dataweave/2.9/dw-types-functions-isfunctiontype.md -->

---
product: DataWeave
version: 2.9
---

# isFunctionType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isFunctionType(t: Type): Boolean

Returns `true` if the input is the Function type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isFunctionType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AFunction = (String) -> String
output application/json
---
{
   a: isFunctionType(AFunction),
   b: isFunctionType(Boolean)
}
```

#### Output

```Json
{
  "a": true,
  "b": false
}
```

<!-- document id=275c1af48eb76f0782ab8cb4c2c7cd97153356c3ed60dcc7deedc406bc479839 url=/mulesoft/current/en-us/dataweave/latest/dw-types-functions-isfunctiontype.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# isFunctionType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isFunctionType(t: Type): Boolean

Returns `true` if the input is the Function type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isFunctionType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AFunction = (String) -> String
output application/json
---
{
   a: isFunctionType(AFunction),
   b: isFunctionType(Boolean)
}
```

#### Output

```Json
{
  "a": true,
  "b": false
}
```

<!-- document id=7e87e924b130a32a8a84286087d5c9691bce50e7d85b69bbc7cd7951f910329a url=/mulesoft/current/en-us/dataweave/2.11/dw-mime-functions-ishandledby.md -->

---
product: DataWeave
version: 2.11
---

# isHandledBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isHandledBy(base: MimeType, other: MimeType): Boolean

Returns `true` if the given `MimeType` value is handled by the base `MimeType` value.

_Introduced in DataWeave version 2.7.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>base</code></p></td><td><p><code>MimeType</code></p></td><td><p>The MIME type value used as baseline.</p></td></tr><tr><td><p><code>other</code></p></td><td><p><code>MimeType</code></p></td><td><p>The MIME type value to be validated.</p></td></tr></tbody></table>

### Example

This example tests how MIME types handles several validations.

#### Source

```DataWeave
%dw 2.0
import * from dw::module::Mime
output application/json

var JSON = {'type': "application", subtype: "json", parameters: {}}
var MULTIPART = {'type': "multipart", subtype: "form-data", parameters: {boundary: "my-boundary"}}
var ALL = {'type': "*", subtype: "*", parameters: {}}
---
{
  a: isHandledBy(JSON, JSON),
  b: isHandledBy({'type': "*", subtype: "json", parameters: {}}, JSON),
  c: isHandledBy({'type': "application", subtype: "*", parameters: {}}, JSON),
  d: isHandledBy(ALL, MULTIPART),
  e: isHandledBy(MULTIPART, ALL),
  f: isHandledBy(JSON, MULTIPART),
  g: isHandledBy(
    {'type': "application", subtype: "*+xml", parameters: {}},
    {'type': "application", subtype: "soap+xml", parameters: {}})
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": true,
  "d": true,
  "e": false,
  "f": false,
  "g": true
}
```

<!-- document id=80a1f926ac2a3352766d82597fcfafae0747a874999b667941fcafc5eb02c8e4 url=/mulesoft/current/en-us/dataweave/2.12/dw-mime-functions-ishandledby.md -->

---
product: DataWeave
version: 2.12
---

# isHandledBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isHandledBy(base: MimeType, other: MimeType): Boolean

Returns `true` if the given `MimeType` value is handled by the base `MimeType` value.

_Introduced in DataWeave version 2.7.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>base</code></p></td><td><p><code>MimeType</code></p></td><td><p>The MIME type value used as baseline.</p></td></tr><tr><td><p><code>other</code></p></td><td><p><code>MimeType</code></p></td><td><p>The MIME type value to be validated.</p></td></tr></tbody></table>

### Example

This example tests how MIME types handles several validations.

#### Source

```DataWeave
%dw 2.0
import * from dw::module::Mime
output application/json

var JSON = {'type': "application", subtype: "json", parameters: {}}
var MULTIPART = {'type': "multipart", subtype: "form-data", parameters: {boundary: "my-boundary"}}
var ALL = {'type': "*", subtype: "*", parameters: {}}
---
{
  a: isHandledBy(JSON, JSON),
  b: isHandledBy({'type': "*", subtype: "json", parameters: {}}, JSON),
  c: isHandledBy({'type': "application", subtype: "*", parameters: {}}, JSON),
  d: isHandledBy(ALL, MULTIPART),
  e: isHandledBy(MULTIPART, ALL),
  f: isHandledBy(JSON, MULTIPART),
  g: isHandledBy(
    {'type': "application", subtype: "*+xml", parameters: {}},
    {'type': "application", subtype: "soap+xml", parameters: {}})
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": true,
  "d": true,
  "e": false,
  "f": false,
  "g": true
}
```

<!-- document id=2d590ed1253c5dc6ca4731fad6ee70886265d9f1c058d2d9eb43ce623f5f1c99 url=/mulesoft/current/en-us/dataweave/2.9/dw-mime-functions-ishandledby.md -->

---
product: DataWeave
version: 2.9
---

# isHandledBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isHandledBy(base: MimeType, other: MimeType): Boolean

Returns `true` if the given `MimeType` value is handled by the base `MimeType` value.

_Introduced in DataWeave version 2.7.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>base</code></p></td><td><p><code>MimeType</code></p></td><td><p>The MIME type value used as baseline.</p></td></tr><tr><td><p><code>other</code></p></td><td><p><code>MimeType</code></p></td><td><p>The MIME type value to be validated.</p></td></tr></tbody></table>

### Example

This example tests how MIME types handles several validations.

#### Source

```DataWeave
%dw 2.0
import * from dw::module::Mime
output application/json

var JSON = {'type': "application", subtype: "json", parameters: {}}
var MULTIPART = {'type': "multipart", subtype: "form-data", parameters: {boundary: "my-boundary"}}
var ALL = {'type': "*", subtype: "*", parameters: {}}
---
{
  a: isHandledBy(JSON, JSON),
  b: isHandledBy({'type': "*", subtype: "json", parameters: {}}, JSON),
  c: isHandledBy({'type': "application", subtype: "*", parameters: {}}, JSON),
  d: isHandledBy(ALL, MULTIPART),
  e: isHandledBy(MULTIPART, ALL),
  f: isHandledBy(JSON, MULTIPART),
  g: isHandledBy(
    {'type': "application", subtype: "*+xml", parameters: {}},
    {'type': "application", subtype: "soap+xml", parameters: {}})
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": true,
  "d": true,
  "e": false,
  "f": false,
  "g": true
}
```

<!-- document id=327abcb0b16c5c68c680f353635380694d5a00637c02e41ea67f6ee67723f3cc url=/mulesoft/current/en-us/dataweave/latest/dw-mime-functions-ishandledby.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# isHandledBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isHandledBy(base: MimeType, other: MimeType): Boolean

Returns `true` if the given `MimeType` value is handled by the base `MimeType` value.

_Introduced in DataWeave version 2.7.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>base</code></p></td><td><p><code>MimeType</code></p></td><td><p>The MIME type value used as baseline.</p></td></tr><tr><td><p><code>other</code></p></td><td><p><code>MimeType</code></p></td><td><p>The MIME type value to be validated.</p></td></tr></tbody></table>

### Example

This example tests how MIME types handles several validations.

#### Source

```DataWeave
%dw 2.0
import * from dw::module::Mime
output application/json

var JSON = {'type': "application", subtype: "json", parameters: {}}
var MULTIPART = {'type': "multipart", subtype: "form-data", parameters: {boundary: "my-boundary"}}
var ALL = {'type': "*", subtype: "*", parameters: {}}
---
{
  a: isHandledBy(JSON, JSON),
  b: isHandledBy({'type': "*", subtype: "json", parameters: {}}, JSON),
  c: isHandledBy({'type': "application", subtype: "*", parameters: {}}, JSON),
  d: isHandledBy(ALL, MULTIPART),
  e: isHandledBy(MULTIPART, ALL),
  f: isHandledBy(JSON, MULTIPART),
  g: isHandledBy(
    {'type': "application", subtype: "*+xml", parameters: {}},
    {'type': "application", subtype: "soap+xml", parameters: {}})
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": true,
  "d": true,
  "e": false,
  "f": false,
  "g": true
}
```

<!-- document id=97b929f2db99886e7bd14f42795cd37301af411e58af704f0683153000d7ba7f url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-isinteger.md -->

---
product: DataWeave
version: 2.11
---

# isInteger

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isInteger(number: Number): Boolean

Returns `true` if the given number is an integer (which lacks decimals), `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input is an integer for different values. Note numbers within
strings get coerced to numbers.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[isInteger(1), isInteger(2.0), isInteger(2.2), isInteger("1")]
```

#### Output

```JSON
[ true, true, false, true ]
```

<!-- document id=977f3a466121fa09bf87c6544478cc9e07ee0d83e7b1340deb7b1aaa79b7d0b6 url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-isinteger.md -->

---
product: DataWeave
version: 2.12
---

# isInteger

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isInteger(number: Number): Boolean

Returns `true` if the given number is an integer (which lacks decimals), `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input is an integer for different values. Note numbers within
strings get coerced to numbers.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[isInteger(1), isInteger(2.0), isInteger(2.2), isInteger("1")]
```

#### Output

```JSON
[ true, true, false, true ]
```

<!-- document id=7e2bae12cfa1111ad2fab6392ced110a6c3373daa71d7406f338e063041a1c9d url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-isinteger.md -->

---
product: DataWeave
version: 2.3
---

# isInteger

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isInteger(Number): Boolean

Returns `true` if the given number is an integer (which lacks decimals), `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input is an integer for different values. Note numbers within
strings get coerced to numbers.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[isInteger(1), isInteger(2.0), isInteger(2.2), isInteger("1")]
```

#### Output

```JSON
[ true, true, false, true ]
```

<!-- document id=e94b4d89d04d6af476d5059cb93e654cd7e1c1d4e3c47eee25604303357c1a9a url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-isinteger.md -->

---
product: DataWeave
version: 2.4
---

# isInteger

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isInteger(number: Number): Boolean

Returns `true` if the given number is an integer (which lacks decimals), `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input is an integer for different values. Note numbers within
strings get coerced to numbers.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[isInteger(1), isInteger(2.0), isInteger(2.2), isInteger("1")]
```

#### Output

```JSON
[ true, true, false, true ]
```

<!-- document id=5cf8de18dd8ff5035c6dbd1b1acd276de3f375e692a34aed92c3532a88f1182d url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-isinteger.md -->

---
product: DataWeave
version: 2.6
---

# isInteger

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isInteger(number: Number): Boolean

Returns `true` if the given number is an integer (which lacks decimals), `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input is an integer for different values. Note numbers within
strings get coerced to numbers.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[isInteger(1), isInteger(2.0), isInteger(2.2), isInteger("1")]
```

#### Output

```JSON
[ true, true, false, true ]
```

<!-- document id=a9660287020fe7814e51463fad50803b70241de273d77a727a31eff4d0a68125 url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-isinteger.md -->

---
product: DataWeave
version: 2.9
---

# isInteger

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isInteger(number: Number): Boolean

Returns `true` if the given number is an integer (which lacks decimals), `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input is an integer for different values. Note numbers within
strings get coerced to numbers.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[isInteger(1), isInteger(2.0), isInteger(2.2), isInteger("1")]
```

#### Output

```JSON
[ true, true, false, true ]
```

<!-- document id=e15e754e99b49864ecef2915d805e56f0b9291918af8646c76191ff0482fe561 url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-isinteger.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# isInteger

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isInteger(number: Number): Boolean

Returns `true` if the given number is an integer (which lacks decimals), `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input is an integer for different values. Note numbers within
strings get coerced to numbers.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[isInteger(1), isInteger(2.0), isInteger(2.2), isInteger("1")]
```

#### Output

```JSON
[ true, true, false, true ]
```

<!-- document id=5dc6413e81beba6c341c35b9dd163fac43aa50bf3fc6b3007d4a486843faaa98 url=/mulesoft/current/en-us/dataweave/2.11/dw-types-functions-isintersectiontype.md -->

---
product: DataWeave
version: 2.11
---

# isIntersectionType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isIntersectionType(t: Type): Boolean

Returns `true` if the input type is the Intersection type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isIntersectionType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = {name: String} & {age: Number}
output application/json
---
{
   a: isIntersectionType(AType),
   b: isIntersectionType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": false
}
```

<!-- document id=91a1d028081a714ca5e51a5ab7e53ad379e8b2589832ea1d17ee05d4afaf24e7 url=/mulesoft/current/en-us/dataweave/2.12/dw-types-functions-isintersectiontype.md -->

---
product: DataWeave
version: 2.12
---

# isIntersectionType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isIntersectionType(t: Type): Boolean

Returns `true` if the input type is the Intersection type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isIntersectionType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = {name: String} & {age: Number}
output application/json
---
{
   a: isIntersectionType(AType),
   b: isIntersectionType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": false
}
```

<!-- document id=ba9171c5e104f5781dc57a88b03ac01d16f89377e974b8b53fc271d269b0ecfe url=/mulesoft/current/en-us/dataweave/2.3/dw-types-functions-isintersectiontype.md -->

---
product: DataWeave
version: 2.3
---

# isIntersectionType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isIntersectionType(Type): Boolean

Returns `true` if the input type is the Intersection type.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>t</p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isIntersectionType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = {name: String} & {age: Number}
output application/json
---
{
   a: isIntersectionType(AType),
   b: isIntersectionType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": false
}
```

<!-- document id=6ac227a868bdda90737670b77a2f3d3ce158e322c226d998a182cab7c176474f url=/mulesoft/current/en-us/dataweave/2.4/dw-types-functions-isintersectiontype.md -->

---
product: DataWeave
version: 2.4
---

# isIntersectionType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isIntersectionType(t: Type): Boolean

Returns `true` if the input type is the Intersection type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isIntersectionType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = {name: String} & {age: Number}
output application/json
---
{
   a: isIntersectionType(AType),
   b: isIntersectionType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": false
}
```

<!-- document id=9a1b80c1b0617a199873727f80217abfafef197b4b51ebcdf02009698221a8df url=/mulesoft/current/en-us/dataweave/2.6/dw-types-functions-isintersectiontype.md -->

---
product: DataWeave
version: 2.6
---

# isIntersectionType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isIntersectionType(t: Type): Boolean

Returns `true` if the input type is the Intersection type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isIntersectionType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = {name: String} & {age: Number}
output application/json
---
{
   a: isIntersectionType(AType),
   b: isIntersectionType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": false
}
```

<!-- document id=d26276aca7acef380aa6618661eee1c3af14f1d1096cad212bff220315c3196f url=/mulesoft/current/en-us/dataweave/2.9/dw-types-functions-isintersectiontype.md -->

---
product: DataWeave
version: 2.9
---

# isIntersectionType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isIntersectionType(t: Type): Boolean

Returns `true` if the input type is the Intersection type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isIntersectionType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = {name: String} & {age: Number}
output application/json
---
{
   a: isIntersectionType(AType),
   b: isIntersectionType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": false
}
```

<!-- document id=d2eacad4112d95fd667624b89a1a6e1e0f81eeb2666405d6513cb469afca7f20 url=/mulesoft/current/en-us/dataweave/latest/dw-types-functions-isintersectiontype.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# isIntersectionType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isIntersectionType(t: Type): Boolean

Returns `true` if the input type is the Intersection type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isIntersectionType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = {name: String} & {age: Number}
output application/json
---
{
   a: isIntersectionType(AType),
   b: isIntersectionType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": false
}
```

<!-- document id=f37e074a9b15cf3742b73f2427fca45f5356e8a245a557d90322bc15b4f0d10d url=/mulesoft/current/en-us/dataweave/2.11/dw-types-functions-iskeytype.md -->

---
product: DataWeave
version: 2.11
---

# isKeyType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isKeyType(t: Type): Boolean

Returns `true` if the input is the Key type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isKeyType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AKey = Key
output application/json
---
{
   a: isKeyType(AKey),
   b: isKeyType(Key),
   c: isKeyType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=10717276b690aa0bf4806a62c6a8031ac24bb84ffebc262b71dbe7680c8d1f3f url=/mulesoft/current/en-us/dataweave/2.12/dw-types-functions-iskeytype.md -->

---
product: DataWeave
version: 2.12
---

# isKeyType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isKeyType(t: Type): Boolean

Returns `true` if the input is the Key type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isKeyType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AKey = Key
output application/json
---
{
   a: isKeyType(AKey),
   b: isKeyType(Key),
   c: isKeyType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=d7323a3505a8659dbcd286362950d0abe840f21f787ca1f97eb1d94db884b6d3 url=/mulesoft/current/en-us/dataweave/2.3/dw-types-functions-iskeytype.md -->

---
product: DataWeave
version: 2.3
---

# isKeyType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isKeyType(Type): Boolean

Returns `true` if the input is the Key type.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>t</p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isKeyType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AKey = Key
output application/json
---
{
   a: isKeyType(AKey),
   b: isKeyType(Key),
   c: isKeyType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=720fc5f888d5f150293099cd2772440bef6736cfbca0c80bfb4296bc88852821 url=/mulesoft/current/en-us/dataweave/2.4/dw-types-functions-iskeytype.md -->

---
product: DataWeave
version: 2.4
---

# isKeyType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isKeyType(t: Type): Boolean

Returns `true` if the input is the Key type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isKeyType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AKey = Key
output application/json
---
{
   a: isKeyType(AKey),
   b: isKeyType(Key),
   c: isKeyType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=e040e831d015bb39ea5a18144fa3dbc41507e407e2795b25652b66d466762fd5 url=/mulesoft/current/en-us/dataweave/2.6/dw-types-functions-iskeytype.md -->

---
product: DataWeave
version: 2.6
---

# isKeyType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isKeyType(t: Type): Boolean

Returns `true` if the input is the Key type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isKeyType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AKey = Key
output application/json
---
{
   a: isKeyType(AKey),
   b: isKeyType(Key),
   c: isKeyType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=910adbf3758508c0e883b5ad408c77e2d365427fe3a265b20648d9e71e36bff3 url=/mulesoft/current/en-us/dataweave/2.9/dw-types-functions-iskeytype.md -->

---
product: DataWeave
version: 2.9
---

# isKeyType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isKeyType(t: Type): Boolean

Returns `true` if the input is the Key type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isKeyType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AKey = Key
output application/json
---
{
   a: isKeyType(AKey),
   b: isKeyType(Key),
   c: isKeyType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=9477ab213778aa3820c847d9ba643bb3a7111ee0bfb5034629e4fa74d4ae7c7b url=/mulesoft/current/en-us/dataweave/latest/dw-types-functions-iskeytype.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# isKeyType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isKeyType(t: Type): Boolean

Returns `true` if the input is the Key type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isKeyType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AKey = Key
output application/json
---
{
   a: isKeyType(AKey),
   b: isKeyType(Key),
   c: isKeyType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=c2288c30b6cd452735c8a7ab0690be49e4608eab57c8cbb102ee984fac9afdf8 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-isleapyear.md -->

---
product: DataWeave
version: 2.11
---

# isLeapYear

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isLeapYear(dateTime: DateTime): Boolean

Returns `true` if it receives a date for a leap year, `false` if not.

This version of `leapYear` acts on a `DateTime` type. Other versions act on the other date and time
formats that DataWeave supports.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><p>The <code>DateTime</code> value to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input is a leap year.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ isLeapYear(|2016-10-01T23:57:59|), isLeapYear(|2017-10-01T23:57:59|) ]
```

#### Output

```JSON
[ true, false ]
```

## isLeapYear(date: Date): Boolean

Returns `true` if the input `Date` is a leap year, 'false' if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><p>The <code>Date</code> value to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input is a leap year.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ isLeapYear(|2016-10-01|), isLeapYear(|2017-10-01|) ]
```

#### Output

```JSON
[ true, false ]
```

## isLeapYear(datetime: LocalDateTime): Boolean

Returns `true` if the input local date-time is a leap year, 'false' if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>datetime</code></p></td><td><p>A <code>LocalDateTime</code> value to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input is a leap year. It uses a `map` function to iterate through
the array of its `LocalDateTime` values, applies the `isLeapYear` to those values, returning the
results in an array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ |2016-10-01T23:57:59-03:00|, |2016-10-01T23:57:59Z| ] map isLeapYear($)
```

#### Output

```JSON
[ true, true ]
```

<!-- document id=c03974955879a14cf83b00fd513914715a80d10b9e30867e467cc42f02597fcf url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-isleapyear.md -->

---
product: DataWeave
version: 2.12
---

# isLeapYear

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isLeapYear(dateTime: DateTime): Boolean

Returns `true` if it receives a date for a leap year, `false` if not.

This version of `leapYear` acts on a `DateTime` type. Other versions act on the other date and time
formats that DataWeave supports.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><p>The <code>DateTime</code> value to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input is a leap year.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ isLeapYear(|2016-10-01T23:57:59|), isLeapYear(|2017-10-01T23:57:59|) ]
```

#### Output

```JSON
[ true, false ]
```

## isLeapYear(date: Date): Boolean

Returns `true` if the input `Date` is a leap year, 'false' if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><p>The <code>Date</code> value to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input is a leap year.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ isLeapYear(|2016-10-01|), isLeapYear(|2017-10-01|) ]
```

#### Output

```JSON
[ true, false ]
```

## isLeapYear(datetime: LocalDateTime): Boolean

Returns `true` if the input local date-time is a leap year, 'false' if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>datetime</code></p></td><td><p>A <code>LocalDateTime</code> value to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input is a leap year. It uses a `map` function to iterate through
the array of its `LocalDateTime` values, applies the `isLeapYear` to those values, returning the
results in an array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ |2016-10-01T23:57:59-03:00|, |2016-10-01T23:57:59Z| ] map isLeapYear($)
```

#### Output

```JSON
[ true, true ]
```

<!-- document id=c10e0fb2a91923b6d8ca77ac47f11f6b2376fa462252e7a3aec631cf19707e5f url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-isleapyear.md -->

---
product: DataWeave
version: 2.3
---

# isLeapYear

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isLeapYear(DateTime): Boolean

Returns `true` if it receives a date for a leap year, `false` if not.

This version of `leapYear` acts on a `DateTime` type. Other versions act on the other date and time
formats that DataWeave supports.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><p>The <code>DateTime</code> value to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input is a leap year.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ isLeapYear(|2016-10-01T23:57:59|), isLeapYear(|2017-10-01T23:57:59|) ]
```

#### Output

```JSON
[ true, false ]
```

## isLeapYear(Date): Boolean

Returns `true` if the input `Date` is a leap year, 'false' if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><p>The <code>Date</code> value to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input is a leap year.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ isLeapYear(|2016-10-01|), isLeapYear(|2017-10-01|) ]
```

#### Output

```JSON
[ true, false ]
```

## isLeapYear(LocalDateTime): Boolean

Returns `true` if the input local date-time is a leap year, 'false' if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>datetime</code></p></td><td><p>A <code>LocalDateTime</code> value to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input is a leap year. It uses a `map` function to iterate through
the array of its `LocalDateTime` values, applies the `isLeapYear` to those values, returning the
results in an array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ |2016-10-01T23:57:59-03:00|, |2016-10-01T23:57:59Z| ] map isLeapYear($)
```

#### Output

```JSON
[ true, true ]
```

<!-- document id=3bf7e93377fef4508c53b0bb41952a58cc568975288ba2dcc373c3ef2ab7a445 url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-isleapyear.md -->

---
product: DataWeave
version: 2.4
---

# isLeapYear

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isLeapYear(dateTime: DateTime): Boolean

Returns `true` if it receives a date for a leap year, `false` if not.

This version of `leapYear` acts on a `DateTime` type. Other versions act on the other date and time
formats that DataWeave supports.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><p>The <code>DateTime</code> value to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input is a leap year.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ isLeapYear(|2016-10-01T23:57:59|), isLeapYear(|2017-10-01T23:57:59|) ]
```

#### Output

```JSON
[ true, false ]
```

## isLeapYear(date: Date): Boolean

Returns `true` if the input `Date` is a leap year, 'false' if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><p>The <code>Date</code> value to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input is a leap year.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ isLeapYear(|2016-10-01|), isLeapYear(|2017-10-01|) ]
```

#### Output

```JSON
[ true, false ]
```

## isLeapYear(datetime: LocalDateTime): Boolean

Returns `true` if the input local date-time is a leap year, 'false' if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>datetime</code></p></td><td><p>A <code>LocalDateTime</code> value to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input is a leap year. It uses a `map` function to iterate through
the array of its `LocalDateTime` values, applies the `isLeapYear` to those values, returning the
results in an array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ |2016-10-01T23:57:59-03:00|, |2016-10-01T23:57:59Z| ] map isLeapYear($)
```

#### Output

```JSON
[ true, true ]
```

<!-- document id=245ef7ad2f85befd9231fd40e2d71d28c7bfeb2e9aa3a79a6aa2612946e05560 url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-isleapyear.md -->

---
product: DataWeave
version: 2.6
---

# isLeapYear

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isLeapYear(dateTime: DateTime): Boolean

Returns `true` if it receives a date for a leap year, `false` if not.

This version of `leapYear` acts on a `DateTime` type. Other versions act on the other date and time
formats that DataWeave supports.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><p>The <code>DateTime</code> value to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input is a leap year.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ isLeapYear(|2016-10-01T23:57:59|), isLeapYear(|2017-10-01T23:57:59|) ]
```

#### Output

```JSON
[ true, false ]
```

## isLeapYear(date: Date): Boolean

Returns `true` if the input `Date` is a leap year, 'false' if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><p>The <code>Date</code> value to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input is a leap year.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ isLeapYear(|2016-10-01|), isLeapYear(|2017-10-01|) ]
```

#### Output

```JSON
[ true, false ]
```

## isLeapYear(datetime: LocalDateTime): Boolean

Returns `true` if the input local date-time is a leap year, 'false' if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>datetime</code></p></td><td><p>A <code>LocalDateTime</code> value to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input is a leap year. It uses a `map` function to iterate through
the array of its `LocalDateTime` values, applies the `isLeapYear` to those values, returning the
results in an array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ |2016-10-01T23:57:59-03:00|, |2016-10-01T23:57:59Z| ] map isLeapYear($)
```

#### Output

```JSON
[ true, true ]
```

<!-- document id=718653f8f909c3359741649334135d20451fb87741ac7c2f72a15076f26a3db3 url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-isleapyear.md -->

---
product: DataWeave
version: 2.9
---

# isLeapYear

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isLeapYear(dateTime: DateTime): Boolean

Returns `true` if it receives a date for a leap year, `false` if not.

This version of `leapYear` acts on a `DateTime` type. Other versions act on the other date and time
formats that DataWeave supports.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><p>The <code>DateTime</code> value to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input is a leap year.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ isLeapYear(|2016-10-01T23:57:59|), isLeapYear(|2017-10-01T23:57:59|) ]
```

#### Output

```JSON
[ true, false ]
```

## isLeapYear(date: Date): Boolean

Returns `true` if the input `Date` is a leap year, 'false' if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><p>The <code>Date</code> value to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input is a leap year.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ isLeapYear(|2016-10-01|), isLeapYear(|2017-10-01|) ]
```

#### Output

```JSON
[ true, false ]
```

## isLeapYear(datetime: LocalDateTime): Boolean

Returns `true` if the input local date-time is a leap year, 'false' if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>datetime</code></p></td><td><p>A <code>LocalDateTime</code> value to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input is a leap year. It uses a `map` function to iterate through
the array of its `LocalDateTime` values, applies the `isLeapYear` to those values, returning the
results in an array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ |2016-10-01T23:57:59-03:00|, |2016-10-01T23:57:59Z| ] map isLeapYear($)
```

#### Output

```JSON
[ true, true ]
```

<!-- document id=cd30a36600d4215519211838142fddf18b9fb51664112b3bf643af10ae135b3c url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-isleapyear.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# isLeapYear

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isLeapYear(dateTime: DateTime): Boolean

Returns `true` if it receives a date for a leap year, `false` if not.

This version of `leapYear` acts on a `DateTime` type. Other versions act on the other date and time
formats that DataWeave supports.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><p>The <code>DateTime</code> value to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input is a leap year.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ isLeapYear(|2016-10-01T23:57:59|), isLeapYear(|2017-10-01T23:57:59|) ]
```

#### Output

```JSON
[ true, false ]
```

## isLeapYear(date: Date): Boolean

Returns `true` if the input `Date` is a leap year, 'false' if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><p>The <code>Date</code> value to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input is a leap year.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ isLeapYear(|2016-10-01|), isLeapYear(|2017-10-01|) ]
```

#### Output

```JSON
[ true, false ]
```

## isLeapYear(datetime: LocalDateTime): Boolean

Returns `true` if the input local date-time is a leap year, 'false' if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>datetime</code></p></td><td><p>A <code>LocalDateTime</code> value to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the input is a leap year. It uses a `map` function to iterate through
the array of its `LocalDateTime` values, applies the `isLeapYear` to those values, returning the
results in an array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ |2016-10-01T23:57:59-03:00|, |2016-10-01T23:57:59Z| ] map isLeapYear($)
```

#### Output

```JSON
[ true, true ]
```

<!-- document id=71fc4822405fb3c13e3feaf2b3e6b920f0d6ed3a808f6968643ecf7650794686 url=/mulesoft/current/en-us/dataweave/2.11/dw-types-functions-isliteraltype.md -->

---
product: DataWeave
version: 2.11
---

# isLiteralType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isLiteralType(t: Type): Boolean

Returns `true` if the input is the Literal type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isLiteralType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ALiteralType = "Mariano"
output application/json
---
{
   a: isLiteralType(ALiteralType),
   b: isLiteralType(Boolean)
}
```

#### Output

```Json
{
  "a": true,
  "b": false
}
```

<!-- document id=19c5fd0695492f3c4e5dff18a201e3a0f75631b001eb56fa270524f1f742ac52 url=/mulesoft/current/en-us/dataweave/2.12/dw-types-functions-isliteraltype.md -->

---
product: DataWeave
version: 2.12
---

# isLiteralType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isLiteralType(t: Type): Boolean

Returns `true` if the input is the Literal type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isLiteralType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ALiteralType = "Mariano"
output application/json
---
{
   a: isLiteralType(ALiteralType),
   b: isLiteralType(Boolean)
}
```

#### Output

```Json
{
  "a": true,
  "b": false
}
```

<!-- document id=13f839862285a40c622584451c4deb63a8ac5daca428ce949ba882d3d38d6655 url=/mulesoft/current/en-us/dataweave/2.3/dw-types-functions-isliteraltype.md -->

---
product: DataWeave
version: 2.3
---

# isLiteralType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isLiteralType(Type): Boolean

Returns `true` if the input is the Literal type.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>t</p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isLiteralType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ALiteralType = "Mariano"
output application/json
---
{
   a: isLiteralType(ALiteralType),
   b: isLiteralType(Boolean)
}
```

#### Output

```Json
{
  "a": true,
  "b": false
}
```

<!-- document id=d250f41ac33a2af6cad2c72bc6169deaf93b00b7cdc3f57dc4ac3e43713cca89 url=/mulesoft/current/en-us/dataweave/2.4/dw-types-functions-isliteraltype.md -->

---
product: DataWeave
version: 2.4
---

# isLiteralType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isLiteralType(t: Type): Boolean

Returns `true` if the input is the Literal type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isLiteralType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ALiteralType = "Mariano"
output application/json
---
{
   a: isLiteralType(ALiteralType),
   b: isLiteralType(Boolean)
}
```

#### Output

```Json
{
  "a": true,
  "b": false
}
```

<!-- document id=013aae5fd053476642509179d4abfc8928abb582298c2d69b52d239f044264d8 url=/mulesoft/current/en-us/dataweave/2.6/dw-types-functions-isliteraltype.md -->

---
product: DataWeave
version: 2.6
---

# isLiteralType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isLiteralType(t: Type): Boolean

Returns `true` if the input is the Literal type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isLiteralType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ALiteralType = "Mariano"
output application/json
---
{
   a: isLiteralType(ALiteralType),
   b: isLiteralType(Boolean)
}
```

#### Output

```Json
{
  "a": true,
  "b": false
}
```

<!-- document id=c471c34e40ee9143c66d1189838dd921110689b417f5d192558a097f3567d94d url=/mulesoft/current/en-us/dataweave/2.9/dw-types-functions-isliteraltype.md -->

---
product: DataWeave
version: 2.9
---

# isLiteralType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isLiteralType(t: Type): Boolean

Returns `true` if the input is the Literal type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isLiteralType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ALiteralType = "Mariano"
output application/json
---
{
   a: isLiteralType(ALiteralType),
   b: isLiteralType(Boolean)
}
```

#### Output

```Json
{
  "a": true,
  "b": false
}
```

<!-- document id=683fcceed012eddf5c30cd7b45ddfa0ffc656e4e68611229dfff23acf1cd00a7 url=/mulesoft/current/en-us/dataweave/latest/dw-types-functions-isliteraltype.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# isLiteralType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isLiteralType(t: Type): Boolean

Returns `true` if the input is the Literal type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isLiteralType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ALiteralType = "Mariano"
output application/json
---
{
   a: isLiteralType(ALiteralType),
   b: isLiteralType(Boolean)
}
```

#### Output

```Json
{
  "a": true,
  "b": false
}
```

<!-- document id=c846e831c02e5f51b5033a3340c28a8a95dee8a0fd201c9cb6b76e05a07a8c9d url=/mulesoft/current/en-us/dataweave/2.11/dw-types-functions-islocaldatetimetype.md -->

---
product: DataWeave
version: 2.11
---

# isLocalDateTimeType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isLocalDateTimeType(t: Type): Boolean

Returns `true` if the input is the LocalDateTime type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isLocalDateTimeType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ALocalDateTime = LocalDateTime
output application/json
---
{
   a: isLocalDateTimeType(ALocalDateTime),
   b: isLocalDateTimeType(LocalDateTime),
   c: isLocalDateTimeType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=50386c5edf5880a0b36c81bd8dd99441eda1f12b201c648ae1a6eedb4e92f271 url=/mulesoft/current/en-us/dataweave/2.12/dw-types-functions-islocaldatetimetype.md -->

---
product: DataWeave
version: 2.12
---

# isLocalDateTimeType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isLocalDateTimeType(t: Type): Boolean

Returns `true` if the input is the LocalDateTime type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isLocalDateTimeType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ALocalDateTime = LocalDateTime
output application/json
---
{
   a: isLocalDateTimeType(ALocalDateTime),
   b: isLocalDateTimeType(LocalDateTime),
   c: isLocalDateTimeType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=0fa983d2c51583c7402943b18e39d0577fe3180eff365a38fdad984366f04b56 url=/mulesoft/current/en-us/dataweave/2.3/dw-types-functions-islocaldatetimetype.md -->

---
product: DataWeave
version: 2.3
---

# isLocalDateTimeType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isLocalDateTimeType(Type): Boolean

Returns `true` if the input is the LocalDateTime type.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>t</p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isLocalDateTimeType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ALocalDateTime = LocalDateTime
output application/json
---
{
   a: isLocalDateTimeType(ALocalDateTime),
   b: isLocalDateTimeType(LocalDateTime),
   c: isLocalDateTimeType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=6a11880e085bb61c3fcc9b6152dfb326085730f6028cd5de3da678ce43eb357a url=/mulesoft/current/en-us/dataweave/2.4/dw-types-functions-islocaldatetimetype.md -->

---
product: DataWeave
version: 2.4
---

# isLocalDateTimeType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isLocalDateTimeType(t: Type): Boolean

Returns `true` if the input is the LocalDateTime type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isLocalDateTimeType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ALocalDateTime = LocalDateTime
output application/json
---
{
   a: isLocalDateTimeType(ALocalDateTime),
   b: isLocalDateTimeType(LocalDateTime),
   c: isLocalDateTimeType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=8e8b00bc9f846f9a4a10d7533438847ecc9440e82ef71f2a69c2938208c9bd25 url=/mulesoft/current/en-us/dataweave/2.6/dw-types-functions-islocaldatetimetype.md -->

---
product: DataWeave
version: 2.6
---

# isLocalDateTimeType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isLocalDateTimeType(t: Type): Boolean

Returns `true` if the input is the LocalDateTime type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isLocalDateTimeType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ALocalDateTime = LocalDateTime
output application/json
---
{
   a: isLocalDateTimeType(ALocalDateTime),
   b: isLocalDateTimeType(LocalDateTime),
   c: isLocalDateTimeType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=57063ccb1bda3245943072198583ef7785eaa61b4e6f5aba6969649cfc1037e2 url=/mulesoft/current/en-us/dataweave/2.9/dw-types-functions-islocaldatetimetype.md -->

---
product: DataWeave
version: 2.9
---

# isLocalDateTimeType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isLocalDateTimeType(t: Type): Boolean

Returns `true` if the input is the LocalDateTime type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isLocalDateTimeType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ALocalDateTime = LocalDateTime
output application/json
---
{
   a: isLocalDateTimeType(ALocalDateTime),
   b: isLocalDateTimeType(LocalDateTime),
   c: isLocalDateTimeType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=f824cf1f45bbefa4e1152ec0f5b04d171369ab35491f58ef2eba8ad391899553 url=/mulesoft/current/en-us/dataweave/latest/dw-types-functions-islocaldatetimetype.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# isLocalDateTimeType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isLocalDateTimeType(t: Type): Boolean

Returns `true` if the input is the LocalDateTime type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isLocalDateTimeType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ALocalDateTime = LocalDateTime
output application/json
---
{
   a: isLocalDateTimeType(ALocalDateTime),
   b: isLocalDateTimeType(LocalDateTime),
   c: isLocalDateTimeType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=931f2debbf87b9c4f8088574b2cec13960c515ffbc1143eb5017da70d7582768 url=/mulesoft/current/en-us/dataweave/2.11/dw-types-functions-islocaltimetype.md -->

---
product: DataWeave
version: 2.11
---

# isLocalTimeType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isLocalTimeType(t: Type): Boolean

Returns `true` if the input is the LocalTime type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isLocalTimeType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ALocalTime = LocalTime
output application/json
---
{
   a: isLocalTimeType(ALocalTime),
   b: isLocalTimeType(LocalTime),
   c: isLocalTimeType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=4511fc3370afb0cdee436b686bdb627e1d83e21f7a3627660e7e2b0b839d68e3 url=/mulesoft/current/en-us/dataweave/2.12/dw-types-functions-islocaltimetype.md -->

---
product: DataWeave
version: 2.12
---

# isLocalTimeType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isLocalTimeType(t: Type): Boolean

Returns `true` if the input is the LocalTime type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isLocalTimeType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ALocalTime = LocalTime
output application/json
---
{
   a: isLocalTimeType(ALocalTime),
   b: isLocalTimeType(LocalTime),
   c: isLocalTimeType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=2ad7c4d68522f53d3e125b5c943ab17f22f70a2acc1e747fbe8dd90c43de9d03 url=/mulesoft/current/en-us/dataweave/2.3/dw-types-functions-islocaltimetype.md -->

---
product: DataWeave
version: 2.3
---

# isLocalTimeType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isLocalTimeType(Type): Boolean

Returns `true` if the input is the LocalTime type.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>t</p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isLocalTimeType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ALocalTime = LocalTime
output application/json
---
{
   a: isLocalTimeType(ALocalTime),
   b: isLocalTimeType(LocalTime),
   c: isLocalTimeType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=8977a6b8947eaa1342d6d7a517d548b22092193709ce6abeb0b92de4ccf78eb8 url=/mulesoft/current/en-us/dataweave/2.4/dw-types-functions-islocaltimetype.md -->

---
product: DataWeave
version: 2.4
---

# isLocalTimeType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isLocalTimeType(t: Type): Boolean

Returns `true` if the input is the LocalTime type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isLocalTimeType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ALocalTime = LocalTime
output application/json
---
{
   a: isLocalTimeType(ALocalTime),
   b: isLocalTimeType(LocalTime),
   c: isLocalTimeType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=9490c67f9960847335f42225f4275756b8824bcb925142ca08aaaf45b4d60d06 url=/mulesoft/current/en-us/dataweave/2.6/dw-types-functions-islocaltimetype.md -->

---
product: DataWeave
version: 2.6
---

# isLocalTimeType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isLocalTimeType(t: Type): Boolean

Returns `true` if the input is the LocalTime type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isLocalTimeType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ALocalTime = LocalTime
output application/json
---
{
   a: isLocalTimeType(ALocalTime),
   b: isLocalTimeType(LocalTime),
   c: isLocalTimeType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=adfc53a9532fae14b244a5d1340d75842d124d8a81b2081710e5bf1834c3a973 url=/mulesoft/current/en-us/dataweave/2.9/dw-types-functions-islocaltimetype.md -->

---
product: DataWeave
version: 2.9
---

# isLocalTimeType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isLocalTimeType(t: Type): Boolean

Returns `true` if the input is the LocalTime type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isLocalTimeType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ALocalTime = LocalTime
output application/json
---
{
   a: isLocalTimeType(ALocalTime),
   b: isLocalTimeType(LocalTime),
   c: isLocalTimeType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=bdd2be3fc571c4a706ec825ec59c096f7e775fd5ad4c49d11682956562d6e562 url=/mulesoft/current/en-us/dataweave/latest/dw-types-functions-islocaltimetype.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# isLocalTimeType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isLocalTimeType(t: Type): Boolean

Returns `true` if the input is the LocalTime type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isLocalTimeType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ALocalTime = LocalTime
output application/json
---
{
   a: isLocalTimeType(ALocalTime),
   b: isLocalTimeType(LocalTime),
   c: isLocalTimeType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=e40964be016183654af7ff717aa796d8d012943eb5a22c2c326e0091a824db1c url=/mulesoft/current/en-us/dataweave/2.11/dw-strings-functions-islowercase.md -->

---
product: DataWeave
version: 2.11
---

# isLowerCase

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isLowerCase(text: String): Boolean

Checks if the `text` contains only lowercase Unicode characters.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example shows how `isLowerCase` behaves with different inputs, including Unicode characters
outside the ASCII range.

#### Source

```DataWeave
%dw 2.0
import isLowerCase from dw::core::Strings
output application/json
---
{
  "a": isLowerCase(null),
  "b": isLowerCase(""),
  "c": isLowerCase("  "),
  "d": isLowerCase("abc"),
  "e": isLowerCase("aBC"),
  "f": isLowerCase("a c"),
  "g": isLowerCase("a1c"),
  "h": isLowerCase("a/c"),
  "i": isLowerCase("mulesöft"),
  "j": isLowerCase("mulesÖft")
}
```

#### Output

```JSON
{
  "a": false,
  "b": false,
  "c": false,
  "d": false,
  "e": false,
  "f": false,
  "g": false,
  "h": false,
  "i": true,
  "j": false
}
```

## isLowerCase(text: Null): Boolean

Helper function that enables `isLowerCase` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=37ae512fd06f411397e0e629f58cb413a4fdc21de99121c11bf32232ab7584c0 url=/mulesoft/current/en-us/dataweave/2.12/dw-strings-functions-islowercase.md -->

---
product: DataWeave
version: 2.12
---

# isLowerCase

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isLowerCase(text: String): Boolean

Checks if the `text` contains only lowercase Unicode characters.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example shows how `isLowerCase` behaves with different inputs, including Unicode characters
outside the ASCII range.

#### Source

```DataWeave
%dw 2.0
import isLowerCase from dw::core::Strings
output application/json
---
{
  "a": isLowerCase(null),
  "b": isLowerCase(""),
  "c": isLowerCase("  "),
  "d": isLowerCase("abc"),
  "e": isLowerCase("aBC"),
  "f": isLowerCase("a c"),
  "g": isLowerCase("a1c"),
  "h": isLowerCase("a/c"),
  "i": isLowerCase("mulesöft"),
  "j": isLowerCase("mulesÖft")
}
```

#### Output

```JSON
{
  "a": false,
  "b": false,
  "c": false,
  "d": false,
  "e": false,
  "f": false,
  "g": false,
  "h": false,
  "i": true,
  "j": false
}
```

## isLowerCase(text: Null): Boolean

Helper function that enables `isLowerCase` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=639bde1fff83722666faf5dadb119b31936bb3c390c98762ad20c4e692303be3 url=/mulesoft/current/en-us/dataweave/2.3/dw-strings-functions-islowercase.md -->

---
product: DataWeave
version: 2.3
---

# isLowerCase

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isLowerCase(String): Boolean

Checks if the `text` contains only lowercase characters.

_Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example shows how `isNumeric` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import isLowerCase from dw::core::Strings
output application/json
---
{
  "a": isLowerCase(null),
  "b": isLowerCase(""),
  "c": isLowerCase("  "),
  "d": isLowerCase("abc"),
  "e": isLowerCase("aBC"),
  "f": isLowerCase("a c"),
  "g": isLowerCase("a1c"),
  "h": isLowerCase("a/c")
}
```

#### Output

```JSON
{
  "a": false,
  "b": false,
  "c": false,
  "d": true,
  "e": false,
  "f": false,
  "g": false,
  "h": false
}
```

## isLowerCase(Null): Boolean

Helper function that enables `isLowerCase` to work with a `null` value.

<!-- document id=114677e2126abd9c8c527a94e664cb6084919b3d44eab4e655df96678684212a url=/mulesoft/current/en-us/dataweave/2.4/dw-strings-functions-islowercase.md -->

---
product: DataWeave
version: 2.4
---

# isLowerCase

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isLowerCase(text: String): Boolean

Checks if the `text` contains only lowercase Unicode characters.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example shows how `isLowerCase` behaves with different inputs, including Unicode characters
outside the ASCII range.

#### Source

```DataWeave
%dw 2.0
import isLowerCase from dw::core::Strings
output application/json
---
{
 "a": isLowerCase(null),
 "b": isLowerCase(""),
 "c": isLowerCase(" "),
 "d": isLowerCase("abc"),
 "e": isLowerCase("aBC"),
 "f": isLowerCase("a c"),
 "g": isLowerCase("a1c"),
 "h": isLowerCase("a/c"),
 "i": isLowerCase("mulesöft"), // ö is lowercase Unicode
 "j": isLowerCase("mulesÖft") // Ö is uppercase Unicode
}
```

#### Output

```JSON
{
 "a": false,
 "b": false,
 "c": false,
 "d": true,
 "e": false,
 "f": false,
 "g": false,
 "h": false,
 "i": true,
 "j": false
}
```

## isLowerCase(text: Null): Boolean

Helper function that enables `isLowerCase` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=74a0aa18b89f0e4593c20d12ccc3103e90f27b26e787855cc7381db6b2446f75 url=/mulesoft/current/en-us/dataweave/2.6/dw-strings-functions-islowercase.md -->

---
product: DataWeave
version: 2.6
---

# isLowerCase

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isLowerCase(text: String): Boolean

Checks if the `text` contains only lowercase Unicode characters.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example shows how `isLowerCase` behaves with different inputs, including Unicode characters
outside the ASCII range.

#### Source

```DataWeave
%dw 2.0
import isLowerCase from dw::core::Strings
output application/json
---
{
 "a": isLowerCase(null),
 "b": isLowerCase(""),
 "c": isLowerCase(" "),
 "d": isLowerCase("abc"),
 "e": isLowerCase("aBC"),
 "f": isLowerCase("a c"),
 "g": isLowerCase("a1c"),
 "h": isLowerCase("a/c"),
 "i": isLowerCase("mulesöft"), // ö is lowercase Unicode
 "j": isLowerCase("mulesÖft") // Ö is uppercase Unicode
}
```

#### Output

```JSON
{
 "a": false,
 "b": false,
 "c": false,
 "d": true,
 "e": false,
 "f": false,
 "g": false,
 "h": false,
 "i": true,
 "j": false
}
```

## isLowerCase(text: Null): Boolean

Helper function that enables `isLowerCase` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=d854ebde602724aa824aefd0f04264d8ace9570f5e74fb12e28f76f360af361d url=/mulesoft/current/en-us/dataweave/2.9/dw-strings-functions-islowercase.md -->

---
product: DataWeave
version: 2.9
---

# isLowerCase

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isLowerCase(text: String): Boolean

Checks if the `text` contains only lowercase Unicode characters.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example shows how `isLowerCase` behaves with different inputs, including Unicode characters
outside the ASCII range.

#### Source

```DataWeave
%dw 2.0
import isLowerCase from dw::core::Strings
output application/json
---
{
 "a": isLowerCase(null),
 "b": isLowerCase(""),
 "c": isLowerCase(" "),
 "d": isLowerCase("abc"),
 "e": isLowerCase("aBC"),
 "f": isLowerCase("a c"),
 "g": isLowerCase("a1c"),
 "h": isLowerCase("a/c"),
 "i": isLowerCase("mulesöft"), // ö is lowercase Unicode
 "j": isLowerCase("mulesÖft") // Ö is uppercase Unicode
}
```

#### Output

```JSON
{
 "a": false,
 "b": false,
 "c": false,
 "d": true,
 "e": false,
 "f": false,
 "g": false,
 "h": false,
 "i": true,
 "j": false
}
```

## isLowerCase(text: Null): Boolean

Helper function that enables `isLowerCase` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=bac34c9a90247837ea32f5a31afab158c7a677822d4ddaf4ac2cab100498586e url=/mulesoft/current/en-us/dataweave/latest/dw-strings-functions-islowercase.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# isLowerCase

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isLowerCase(text: String): Boolean

Checks if the `text` contains only lowercase Unicode characters.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example shows how `isLowerCase` behaves with different inputs, including Unicode characters
outside the ASCII range.

#### Source

```DataWeave
%dw 2.0
import isLowerCase from dw::core::Strings
output application/json
---
{
  "a": isLowerCase(null),
  "b": isLowerCase(""),
  "c": isLowerCase("  "),
  "d": isLowerCase("abc"),
  "e": isLowerCase("aBC"),
  "f": isLowerCase("a c"),
  "g": isLowerCase("a1c"),
  "h": isLowerCase("a/c"),
  "i": isLowerCase("mulesöft"),
  "j": isLowerCase("mulesÖft")
}
```

#### Output

```JSON
{
  "a": false,
  "b": false,
  "c": false,
  "d": false,
  "e": false,
  "f": false,
  "g": false,
  "h": false,
  "i": true,
  "j": false
}
```

## isLowerCase(text: Null): Boolean

Helper function that enables `isLowerCase` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=654e0425718b34587496e48d94b3f03c4849fa2f8cd3573f9f3cbc78a9e6fe72 url=/mulesoft/current/en-us/dataweave/2.11/dw-types-functions-isnamespacetype.md -->

---
product: DataWeave
version: 2.11
---

# isNamespaceType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isNamespaceType(t: Type): Boolean

Returns `true` if the input is the Namespace type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isNamespaceType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ANamespace = Namespace
output application/json
---
{
   a: isNamespaceType(ANamespace),
   b: isNamespaceType(Namespace),
   c: isNamespaceType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=7d156fdd380c0c3e166465c71cee1133fb6d2950093d4a282c530f76526c38ea url=/mulesoft/current/en-us/dataweave/2.12/dw-types-functions-isnamespacetype.md -->

---
product: DataWeave
version: 2.12
---

# isNamespaceType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isNamespaceType(t: Type): Boolean

Returns `true` if the input is the Namespace type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isNamespaceType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ANamespace = Namespace
output application/json
---
{
   a: isNamespaceType(ANamespace),
   b: isNamespaceType(Namespace),
   c: isNamespaceType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=1a509d4df6646646002fd801353e3a8bbfbc403abcd26ad35c56488ac94b87f1 url=/mulesoft/current/en-us/dataweave/2.3/dw-types-functions-isnamespacetype.md -->

---
product: DataWeave
version: 2.3
---

# isNamespaceType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isNamespaceType(Type): Boolean

Returns `true` if the input is the Namespace type.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>t</p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isNamespaceType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ANamespace = Namespace
output application/json
---
{
   a: isNamespaceType(ANamespace),
   b: isNamespaceType(Namespace),
   c: isNamespaceType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=e15f58e9ec1d2622afe23b113b31c6d95cfcd7f460966b061d4a4d5cfb678248 url=/mulesoft/current/en-us/dataweave/2.4/dw-types-functions-isnamespacetype.md -->

---
product: DataWeave
version: 2.4
---

# isNamespaceType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isNamespaceType(t: Type): Boolean

Returns `true` if the input is the Namespace type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isNamespaceType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ANamespace = Namespace
output application/json
---
{
   a: isNamespaceType(ANamespace),
   b: isNamespaceType(Namespace),
   c: isNamespaceType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=a8983722398fa11878bbc945f04d9e35899f1b4dae3c0919768207d8e4aaa0c8 url=/mulesoft/current/en-us/dataweave/2.6/dw-types-functions-isnamespacetype.md -->

---
product: DataWeave
version: 2.6
---

# isNamespaceType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isNamespaceType(t: Type): Boolean

Returns `true` if the input is the Namespace type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isNamespaceType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ANamespace = Namespace
output application/json
---
{
   a: isNamespaceType(ANamespace),
   b: isNamespaceType(Namespace),
   c: isNamespaceType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=7c20b50ee78e5514ac19651267200de87f490bb479d86693550fdd0eef7b0a72 url=/mulesoft/current/en-us/dataweave/2.9/dw-types-functions-isnamespacetype.md -->

---
product: DataWeave
version: 2.9
---

# isNamespaceType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isNamespaceType(t: Type): Boolean

Returns `true` if the input is the Namespace type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isNamespaceType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ANamespace = Namespace
output application/json
---
{
   a: isNamespaceType(ANamespace),
   b: isNamespaceType(Namespace),
   c: isNamespaceType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=a58ad30c1be0bf1f39b0c467394f7b589c31762adf9ffd2da374af7a1a8196da url=/mulesoft/current/en-us/dataweave/latest/dw-types-functions-isnamespacetype.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# isNamespaceType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isNamespaceType(t: Type): Boolean

Returns `true` if the input is the Namespace type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isNamespaceType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ANamespace = Namespace
output application/json
---
{
   a: isNamespaceType(ANamespace),
   b: isNamespaceType(Namespace),
   c: isNamespaceType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=29cb58c0074a13ab94300c965f83e1d936d4e13d538c483a53cded6cdd6b082a url=/mulesoft/current/en-us/dataweave/2.11/dw-types-functions-isnothingtype.md -->

---
product: DataWeave
version: 2.11
---

# isNothingType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isNothingType(t: Type): Boolean

Returns `true` if the input is the Nothing type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isNothingType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ANothing = Nothing
output application/json
---
{
   a: isNothingType(ANothing),
   b: isNothingType(Nothing),
   c: isNothingType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=2a4d00c74876007eddcd1c8780911ec305d49348aea8332520b4162dcabe4120 url=/mulesoft/current/en-us/dataweave/2.12/dw-types-functions-isnothingtype.md -->

---
product: DataWeave
version: 2.12
---

# isNothingType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isNothingType(t: Type): Boolean

Returns `true` if the input is the Nothing type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isNothingType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ANothing = Nothing
output application/json
---
{
   a: isNothingType(ANothing),
   b: isNothingType(Nothing),
   c: isNothingType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=737a9e3ad16834780245f599d361bff16b2de02886ad7ba394fe128288eb6545 url=/mulesoft/current/en-us/dataweave/2.3/dw-types-functions-isnothingtype.md -->

---
product: DataWeave
version: 2.3
---

# isNothingType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isNothingType(Type): Boolean

Returns `true` if the input is the Nothing type.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>t</p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isNothingType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ANothing = Nothing
output application/json
---
{
   a: isNothingType(ANothing),
   b: isNothingType(Nothing),
   c: isNothingType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=16b83a3a6c6f29bbdd8059b5464125cee5582def1c4afbfbaab47abb6c9be723 url=/mulesoft/current/en-us/dataweave/2.4/dw-types-functions-isnothingtype.md -->

---
product: DataWeave
version: 2.4
---

# isNothingType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isNothingType(t: Type): Boolean

Returns `true` if the input is the Nothing type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isNothingType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ANothing = Nothing
output application/json
---
{
   a: isNothingType(ANothing),
   b: isNothingType(Nothing),
   c: isNothingType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=d1ed2c61c97a8100b788136cacc13dc94e4ff2b528dd2f4185d6e108b648a908 url=/mulesoft/current/en-us/dataweave/2.6/dw-types-functions-isnothingtype.md -->

---
product: DataWeave
version: 2.6
---

# isNothingType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isNothingType(t: Type): Boolean

Returns `true` if the input is the Nothing type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isNothingType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ANothing = Nothing
output application/json
---
{
   a: isNothingType(ANothing),
   b: isNothingType(Nothing),
   c: isNothingType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=a0f20ff0e02ad3882a76c0936b8e39fe2549e8cd9ace66df1c42138b2e826cce url=/mulesoft/current/en-us/dataweave/2.9/dw-types-functions-isnothingtype.md -->

---
product: DataWeave
version: 2.9
---

# isNothingType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isNothingType(t: Type): Boolean

Returns `true` if the input is the Nothing type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isNothingType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ANothing = Nothing
output application/json
---
{
   a: isNothingType(ANothing),
   b: isNothingType(Nothing),
   c: isNothingType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=ad89af447c6a4e378812d2e6993312a0ef7b87e220694008f2d1c2d5520269e0 url=/mulesoft/current/en-us/dataweave/latest/dw-types-functions-isnothingtype.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# isNothingType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isNothingType(t: Type): Boolean

Returns `true` if the input is the Nothing type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isNothingType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ANothing = Nothing
output application/json
---
{
   a: isNothingType(ANothing),
   b: isNothingType(Nothing),
   c: isNothingType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=ca6e8a0ccfdf82426f67cf74016267235a2cd032a6561628eaf1420a530ee1ab url=/mulesoft/current/en-us/dataweave/2.11/dw-types-functions-isnulltype.md -->

---
product: DataWeave
version: 2.11
---

# isNullType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isNullType(t: Type): Boolean

Returns `true` if the input is the Null type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isNullType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ANull = Null
output application/json
---
{
   a: isNullType(ANull),
   b: isNullType(Null),
   c: isNullType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=355f8a1162d0ca4f193889f327c741aad51d3e3315869f80f652fdc994ee9175 url=/mulesoft/current/en-us/dataweave/2.12/dw-types-functions-isnulltype.md -->

---
product: DataWeave
version: 2.12
---

# isNullType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isNullType(t: Type): Boolean

Returns `true` if the input is the Null type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isNullType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ANull = Null
output application/json
---
{
   a: isNullType(ANull),
   b: isNullType(Null),
   c: isNullType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=74764d0fd41af88553777eeb9db0db056b49a5f1e7d4b50072c7ea08d7474970 url=/mulesoft/current/en-us/dataweave/2.3/dw-types-functions-isnulltype.md -->

---
product: DataWeave
version: 2.3
---

# isNullType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isNullType(Type): Boolean

Returns `true` if the input is the Null type.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>t</p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isNullType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ANull = Null
output application/json
---
{
   a: isNullType(ANull),
   b: isNullType(Null),
   c: isNullType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=3c31bd5203f5e8717125d761b1beeb2e42f5a953308cd2aca40e8966c1489245 url=/mulesoft/current/en-us/dataweave/2.4/dw-types-functions-isnulltype.md -->

---
product: DataWeave
version: 2.4
---

# isNullType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isNullType(t: Type): Boolean

Returns `true` if the input is the Null type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isNullType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ANull = Null
output application/json
---
{
   a: isNullType(ANull),
   b: isNullType(Null),
   c: isNullType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=61c77cd5232e5c9ad654dbb3c963df112d1ee71a468f0844511f568d1a83c321 url=/mulesoft/current/en-us/dataweave/2.6/dw-types-functions-isnulltype.md -->

---
product: DataWeave
version: 2.6
---

# isNullType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isNullType(t: Type): Boolean

Returns `true` if the input is the Null type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isNullType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ANull = Null
output application/json
---
{
   a: isNullType(ANull),
   b: isNullType(Null),
   c: isNullType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=256b637e9cacc37c3fa6410fe51eadeff021ea8c6d180db1e4f2e739a82dcd96 url=/mulesoft/current/en-us/dataweave/2.9/dw-types-functions-isnulltype.md -->

---
product: DataWeave
version: 2.9
---

# isNullType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isNullType(t: Type): Boolean

Returns `true` if the input is the Null type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isNullType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ANull = Null
output application/json
---
{
   a: isNullType(ANull),
   b: isNullType(Null),
   c: isNullType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=5a8c5685bdc975330d979e0e7c3ec6a2ce25b9d8bc4b86b6c6d1abe4a1f578b9 url=/mulesoft/current/en-us/dataweave/latest/dw-types-functions-isnulltype.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# isNullType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isNullType(t: Type): Boolean

Returns `true` if the input is the Null type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isNullType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ANull = Null
output application/json
---
{
   a: isNullType(ANull),
   b: isNullType(Null),
   c: isNullType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=a9777f8a32e38a4eae92309137a68396cf2aaab8a5d8b6c5e021562867ebcdc4 url=/mulesoft/current/en-us/dataweave/2.11/dw-types-functions-isnumbertype.md -->

---
product: DataWeave
version: 2.11
---

# isNumberType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isNumberType(t: Type): Boolean

Returns `true` if the input is the Number type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isNumberType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ANumber = Number
output application/json
---
{
   a: isNumberType(ANumber),
   b: isNumberType(Number),
   c: isNumberType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=88780d56d8b092f1dd8dd340bc8ecdd94b362aab2fecaf285105f3e4afc646d9 url=/mulesoft/current/en-us/dataweave/2.12/dw-types-functions-isnumbertype.md -->

---
product: DataWeave
version: 2.12
---

# isNumberType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isNumberType(t: Type): Boolean

Returns `true` if the input is the Number type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isNumberType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ANumber = Number
output application/json
---
{
   a: isNumberType(ANumber),
   b: isNumberType(Number),
   c: isNumberType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=863f49aa9310229a0f282dcc5d037d570717999f85b266680775cc61a8070594 url=/mulesoft/current/en-us/dataweave/2.3/dw-types-functions-isnumbertype.md -->

---
product: DataWeave
version: 2.3
---

# isNumberType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isNumberType(Type): Boolean

Returns `true` if the input is the Number type.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>t</p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isNumberType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ANumber = Number
output application/json
---
{
   a: isNumberType(ANumber),
   b: isNumberType(Number),
   c: isNumberType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=ca814785c0797a6cbcf2db1ae2b710c90a7fab94efc03a28de845c9b257e5d4b url=/mulesoft/current/en-us/dataweave/2.4/dw-types-functions-isnumbertype.md -->

---
product: DataWeave
version: 2.4
---

# isNumberType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isNumberType(t: Type): Boolean

Returns `true` if the input is the Number type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isNumberType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ANumber = Number
output application/json
---
{
   a: isNumberType(ANumber),
   b: isNumberType(Number),
   c: isNumberType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=72b7e825ecd771bf7a9133cf232c9b79fc2217cd2b7a55dc5b4e6633942d605e url=/mulesoft/current/en-us/dataweave/2.6/dw-types-functions-isnumbertype.md -->

---
product: DataWeave
version: 2.6
---

# isNumberType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isNumberType(t: Type): Boolean

Returns `true` if the input is the Number type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isNumberType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ANumber = Number
output application/json
---
{
   a: isNumberType(ANumber),
   b: isNumberType(Number),
   c: isNumberType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=d7f181f3fa0a2648e02e8d961ea0dd0ae23b96268e71f0e2b9fe06176cdbbb23 url=/mulesoft/current/en-us/dataweave/2.9/dw-types-functions-isnumbertype.md -->

---
product: DataWeave
version: 2.9
---

# isNumberType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isNumberType(t: Type): Boolean

Returns `true` if the input is the Number type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isNumberType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ANumber = Number
output application/json
---
{
   a: isNumberType(ANumber),
   b: isNumberType(Number),
   c: isNumberType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=a37d5bbf7dd08236085a0ffac111f223b5afd15d4b8f8cbdf8e3486188ec73f6 url=/mulesoft/current/en-us/dataweave/latest/dw-types-functions-isnumbertype.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# isNumberType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isNumberType(t: Type): Boolean

Returns `true` if the input is the Number type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isNumberType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ANumber = Number
output application/json
---
{
   a: isNumberType(ANumber),
   b: isNumberType(Number),
   c: isNumberType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=bb5905988000c8a51f5a10131539b671e8435b1b4027bb00b1e1147593b81355 url=/mulesoft/current/en-us/dataweave/2.11/dw-strings-functions-isnumeric.md -->

---
product: DataWeave
version: 2.11
---

# isNumeric

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isNumeric(text: String): Boolean

Checks if the `text` contains only Unicode digits.

A decimal point is not a Unicode digit and returns false. Note that the method does not allow for a
leading sign, either positive or negative.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example shows how `isNumeric` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import isNumeric from dw::core::Strings
output application/json
---
{
  "a": isNumeric(null),
  "b": isNumeric(""),
  "c": isNumeric("  "),
  "d": isNumeric("123"),
  "e": isNumeric("१२३"),
  "f": isNumeric("12 3"),
  "g": isNumeric("ab2c"),
  "h": isNumeric("12-3"),
  "i": isNumeric("12.3"),
  "j": isNumeric("-123"),
  "k": isNumeric("+123")
}
```

#### Output

```JSON
{
  "a": false,
  "b": false,
  "c": false,
  "d": true,
  "e": true,
  "f": false,
  "g": false,
  "h": false,
  "i": false,
  "j": false,
  "k": false
}
```

## isNumeric(text: Null): Boolean

Helper function that enables `isNumeric` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=36b141d8f2f7d0fbfc734cd29ee94e290465b63c1381e55cf4a69bcc892b2226 url=/mulesoft/current/en-us/dataweave/2.12/dw-strings-functions-isnumeric.md -->

---
product: DataWeave
version: 2.12
---

# isNumeric

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isNumeric(text: String): Boolean

Checks if the `text` contains only Unicode digits.

A decimal point is not a Unicode digit and returns false. Note that the method does not allow for a
leading sign, either positive or negative.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example shows how `isNumeric` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import isNumeric from dw::core::Strings
output application/json
---
{
  "a": isNumeric(null),
  "b": isNumeric(""),
  "c": isNumeric("  "),
  "d": isNumeric("123"),
  "e": isNumeric("१२३"),
  "f": isNumeric("12 3"),
  "g": isNumeric("ab2c"),
  "h": isNumeric("12-3"),
  "i": isNumeric("12.3"),
  "j": isNumeric("-123"),
  "k": isNumeric("+123")
}
```

#### Output

```JSON
{
  "a": false,
  "b": false,
  "c": false,
  "d": true,
  "e": true,
  "f": false,
  "g": false,
  "h": false,
  "i": false,
  "j": false,
  "k": false
}
```

## isNumeric(text: Null): Boolean

Helper function that enables `isNumeric` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=5a786ee262f140416ee8506fc616c828022bb5e22e7fe5b8f1d9de93a648235f url=/mulesoft/current/en-us/dataweave/2.3/dw-strings-functions-isnumeric.md -->

---
product: DataWeave
version: 2.3
---

# isNumeric

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isNumeric(String): Boolean

Checks if the `text` contains only Unicode digits.

A decimal point is not a Unicode digit and returns false. Note that the method does not allow for a
leading sign, either positive or negative.

_Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example shows how `isNumeric` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import isNumeric from dw::core::Strings
output application/json
---
{
  "a": isNumeric(null),
  "b": isNumeric(""),
  "c": isNumeric("  "),
  "d": isNumeric("123"),
  "e": isNumeric("१२३"),
  "f": isNumeric("12 3"),
  "g": isNumeric("ab2c"),
  "h": isNumeric("12-3"),
  "i": isNumeric("12.3"),
  "j": isNumeric("-123"),
  "k": isNumeric("+123")
}
```

#### Output

```JSON
{
  "a": false,
  "b": false,
  "c": false,
  "d": true,
  "e": true,
  "f": false,
  "g": false,
  "h": false,
  "i": false,
  "j": false,
  "k": false
}
```

## isNumeric(Null): Boolean

Helper function that enables `isNumeric` to work with a `null` value.

<!-- document id=1208bbadad9af4885f3e2f852f6f9018b14c71c116c31b3526fdf7e11759e772 url=/mulesoft/current/en-us/dataweave/2.4/dw-strings-functions-isnumeric.md -->

---
product: DataWeave
version: 2.4
---

# isNumeric

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isNumeric(text: String): Boolean

Checks if the `text` contains only Unicode digits.

A decimal point is not a Unicode digit and returns false. Note that the method does not allow for a
leading sign, either positive or negative.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example shows how `isNumeric` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import isNumeric from dw::core::Strings
output application/json
---
{
  "a": isNumeric(null),
  "b": isNumeric(""),
  "c": isNumeric("  "),
  "d": isNumeric("123"),
  "e": isNumeric("१२३"),
  "f": isNumeric("12 3"),
  "g": isNumeric("ab2c"),
  "h": isNumeric("12-3"),
  "i": isNumeric("12.3"),
  "j": isNumeric("-123"),
  "k": isNumeric("+123")
}
```

#### Output

```JSON
{
  "a": false,
  "b": false,
  "c": false,
  "d": true,
  "e": true,
  "f": false,
  "g": false,
  "h": false,
  "i": false,
  "j": false,
  "k": false
}
```

## isNumeric(text: Null): Boolean

Helper function that enables `isNumeric` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=f30192ab4e26934a4e1b58b7ffa40574aadfaf2ef9cd2952ef3e29863f798734 url=/mulesoft/current/en-us/dataweave/2.6/dw-strings-functions-isnumeric.md -->

---
product: DataWeave
version: 2.6
---

# isNumeric

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isNumeric(text: String): Boolean

Checks if the `text` contains only Unicode digits.

A decimal point is not a Unicode digit and returns false. Note that the method does not allow for a
leading sign, either positive or negative.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example shows how `isNumeric` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import isNumeric from dw::core::Strings
output application/json
---
{
  "a": isNumeric(null),
  "b": isNumeric(""),
  "c": isNumeric("  "),
  "d": isNumeric("123"),
  "e": isNumeric("१२३"),
  "f": isNumeric("12 3"),
  "g": isNumeric("ab2c"),
  "h": isNumeric("12-3"),
  "i": isNumeric("12.3"),
  "j": isNumeric("-123"),
  "k": isNumeric("+123")
}
```

#### Output

```JSON
{
  "a": false,
  "b": false,
  "c": false,
  "d": true,
  "e": true,
  "f": false,
  "g": false,
  "h": false,
  "i": false,
  "j": false,
  "k": false
}
```

## isNumeric(text: Null): Boolean

Helper function that enables `isNumeric` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=174bca89b270532b03293f26d0dad06959ebf87dfd3e4fc41fa7e983feb5011e url=/mulesoft/current/en-us/dataweave/2.9/dw-strings-functions-isnumeric.md -->

---
product: DataWeave
version: 2.9
---

# isNumeric

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isNumeric(text: String): Boolean

Checks if the `text` contains only Unicode digits.

A decimal point is not a Unicode digit and returns false. Note that the method does not allow for a
leading sign, either positive or negative.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example shows how `isNumeric` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import isNumeric from dw::core::Strings
output application/json
---
{
  "a": isNumeric(null),
  "b": isNumeric(""),
  "c": isNumeric("  "),
  "d": isNumeric("123"),
  "e": isNumeric("१२३"),
  "f": isNumeric("12 3"),
  "g": isNumeric("ab2c"),
  "h": isNumeric("12-3"),
  "i": isNumeric("12.3"),
  "j": isNumeric("-123"),
  "k": isNumeric("+123")
}
```

#### Output

```JSON
{
  "a": false,
  "b": false,
  "c": false,
  "d": true,
  "e": true,
  "f": false,
  "g": false,
  "h": false,
  "i": false,
  "j": false,
  "k": false
}
```

## isNumeric(text: Null): Boolean

Helper function that enables `isNumeric` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=b394774c93a965c27b52ccb5838711f7c4bfa95a7643f6bfd18d73c7cd398272 url=/mulesoft/current/en-us/dataweave/latest/dw-strings-functions-isnumeric.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# isNumeric

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isNumeric(text: String): Boolean

Checks if the `text` contains only Unicode digits.

A decimal point is not a Unicode digit and returns false. Note that the method does not allow for a
leading sign, either positive or negative.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example shows how `isNumeric` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import isNumeric from dw::core::Strings
output application/json
---
{
  "a": isNumeric(null),
  "b": isNumeric(""),
  "c": isNumeric("  "),
  "d": isNumeric("123"),
  "e": isNumeric("१२३"),
  "f": isNumeric("12 3"),
  "g": isNumeric("ab2c"),
  "h": isNumeric("12-3"),
  "i": isNumeric("12.3"),
  "j": isNumeric("-123"),
  "k": isNumeric("+123")
}
```

#### Output

```JSON
{
  "a": false,
  "b": false,
  "c": false,
  "d": true,
  "e": true,
  "f": false,
  "g": false,
  "h": false,
  "i": false,
  "j": false,
  "k": false
}
```

## isNumeric(text: Null): Boolean

Helper function that enables `isNumeric` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=d50aa95f67091b0da53bf8a15f1768fd8ef146e90e18965c8695f9ba80224bfc url=/mulesoft/current/en-us/dataweave/2.11/dw-tree-functions-isobjecttype.md -->

---
product: DataWeave
version: 2.11
---

# isObjectType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isObjectType(path: Path): Boolean

Returns `true` if the provided `Path` value is an `OBJECT_TYPE` expression.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>path</code></p></td><td><p>The <code>Path</code> value to validate.</p></td></tr></tbody></table>

### Example

This example shows how `isObjectType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
output application/json
---
{
  a: isObjectType([{kind: OBJECT_TYPE, selector: "user", namespace: null},
                   {kind: ATTRIBUTE_TYPE, selector: "name", namespace: null}]),
  b: isObjectType([{kind: OBJECT_TYPE, selector: "user", namespace: null},
                   {kind: OBJECT_TYPE, selector: "name", namespace: null}]),
  c: isObjectType([{kind: OBJECT_TYPE, selector: "user", namespace: null}])
}
```

#### Output

```Json
{
  "a": false,
  "b": true,
  "c": true
}
```

<!-- document id=7d0e97b9fe96e6702d99abc88c84d4cf34a8cbf2769504f8284c1180cd2c8a97 url=/mulesoft/current/en-us/dataweave/2.11/dw-types-functions-isobjecttype.md -->

---
product: DataWeave
version: 2.11
---

# isObjectType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isObjectType(t: Type): Boolean

Returns `true` if the input is the Object type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isObjectType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = {name: String}
output application/json
---
{
   a: isObjectType(AType),
   b: isObjectType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": false
}
```

<!-- document id=ca1761ef2f72eed5f73ec7b2b1991186e4ad82f1389064d28f7f4770f169b36c url=/mulesoft/current/en-us/dataweave/2.12/dw-tree-functions-isobjecttype.md -->

---
product: DataWeave
version: 2.12
---

# isObjectType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isObjectType(path: Path): Boolean

Returns `true` if the provided `Path` value is an `OBJECT_TYPE` expression.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>path</code></p></td><td><p>The <code>Path</code> value to validate.</p></td></tr></tbody></table>

### Example

This example shows how `isObjectType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
output application/json
---
{
  a: isObjectType([{kind: OBJECT_TYPE, selector: "user", namespace: null},
                   {kind: ATTRIBUTE_TYPE, selector: "name", namespace: null}]),
  b: isObjectType([{kind: OBJECT_TYPE, selector: "user", namespace: null},
                   {kind: OBJECT_TYPE, selector: "name", namespace: null}]),
  c: isObjectType([{kind: OBJECT_TYPE, selector: "user", namespace: null}])
}
```

#### Output

```Json
{
  "a": false,
  "b": true,
  "c": true
}
```

<!-- document id=9a6c7bedc1ebedc9a0b71e064a63c71ca28684a4dd6f84046898777bae82728a url=/mulesoft/current/en-us/dataweave/2.12/dw-types-functions-isobjecttype.md -->

---
product: DataWeave
version: 2.12
---

# isObjectType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isObjectType(t: Type): Boolean

Returns `true` if the input is the Object type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isObjectType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = {name: String}
output application/json
---
{
   a: isObjectType(AType),
   b: isObjectType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": false
}
```

<!-- document id=9cbd4b7b13dc7ba8d36970c233e2dd54b1b53c457c7e4c00339449a3619d1b1a url=/mulesoft/current/en-us/dataweave/2.3/dw-types-functions-isobjecttype.md -->

---
product: DataWeave
version: 2.3
---

# isObjectType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isObjectType(Type): Boolean

Returns `true` if the input is the Object type.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>t</p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isObjectType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = {name: String}
output application/json
---
{
   a: isObjectType(AType),
   b: isObjectType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": false
}
```

<!-- document id=d38677c597f3f34fe247777a21fbbd7b2d053db3b58bd40ec133b69dff7896b3 url=/mulesoft/current/en-us/dataweave/2.4/dw-tree-functions-isobjecttype.md -->

---
product: DataWeave
version: 2.4
---

# isObjectType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isObjectType(path: Path): Boolean

Returns `true` if the provided `Path` value is an `OBJECT_TYPE` expression.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>path</code></p></td><td><p>The <code>Path</code> value to validate.</p></td></tr></tbody></table>

### Example

This example shows how `isObjectType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
output application/json
---
{
  a: isObjectType([{kind: OBJECT_TYPE, selector: "user", namespace: null},
                   {kind: ATTRIBUTE_TYPE, selector: "name", namespace: null}]),
  b: isObjectType([{kind: OBJECT_TYPE, selector: "user", namespace: null},
                   {kind: OBJECT_TYPE, selector: "name", namespace: null}]),
  c: isObjectType([{kind: OBJECT_TYPE, selector: "user", namespace: null}])
}
```

#### Output

```Json
{
  "a": false,
  "b": true,
  "c": true
}
```

<!-- document id=790683299462954f4f5f393e7c959624dc88ce2109e44bef65963c0cfdbcfc61 url=/mulesoft/current/en-us/dataweave/2.4/dw-types-functions-isobjecttype.md -->

---
product: DataWeave
version: 2.4
---

# isObjectType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isObjectType(t: Type): Boolean

Returns `true` if the input is the Object type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isObjectType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = {name: String}
output application/json
---
{
   a: isObjectType(AType),
   b: isObjectType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": false
}
```

<!-- document id=b85a3711f4b3a6c9fe02a5a6b717bcca3dcc50378f2899bcfbfb7681b9a06a76 url=/mulesoft/current/en-us/dataweave/2.6/dw-tree-functions-isobjecttype.md -->

---
product: DataWeave
version: 2.6
---

# isObjectType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isObjectType(path: Path): Boolean

Returns `true` if the provided `Path` value is an `OBJECT_TYPE` expression.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>path</code></p></td><td><p>The <code>Path</code> value to validate.</p></td></tr></tbody></table>

### Example

This example shows how `isObjectType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
output application/json
---
{
  a: isObjectType([{kind: OBJECT_TYPE, selector: "user", namespace: null},
                   {kind: ATTRIBUTE_TYPE, selector: "name", namespace: null}]),
  b: isObjectType([{kind: OBJECT_TYPE, selector: "user", namespace: null},
                   {kind: OBJECT_TYPE, selector: "name", namespace: null}]),
  c: isObjectType([{kind: OBJECT_TYPE, selector: "user", namespace: null}])
}
```

#### Output

```Json
{
  "a": false,
  "b": true,
  "c": true
}
```

<!-- document id=8748e5c028cd44b0481709c332254ddb77b43a47c259c3c69ef7f0bc0b7b45a3 url=/mulesoft/current/en-us/dataweave/2.6/dw-types-functions-isobjecttype.md -->

---
product: DataWeave
version: 2.6
---

# isObjectType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isObjectType(t: Type): Boolean

Returns `true` if the input is the Object type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isObjectType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = {name: String}
output application/json
---
{
   a: isObjectType(AType),
   b: isObjectType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": false
}
```

<!-- document id=6a318a2784a3f9fb0fbafe51188b6898716c0990343d2563f42b5184cc736308 url=/mulesoft/current/en-us/dataweave/2.9/dw-tree-functions-isobjecttype.md -->

---
product: DataWeave
version: 2.9
---

# isObjectType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isObjectType(path: Path): Boolean

Returns `true` if the provided `Path` value is an `OBJECT_TYPE` expression.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>path</code></p></td><td><p>The <code>Path</code> value to validate.</p></td></tr></tbody></table>

### Example

This example shows how `isObjectType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
output application/json
---
{
  a: isObjectType([{kind: OBJECT_TYPE, selector: "user", namespace: null},
                   {kind: ATTRIBUTE_TYPE, selector: "name", namespace: null}]),
  b: isObjectType([{kind: OBJECT_TYPE, selector: "user", namespace: null},
                   {kind: OBJECT_TYPE, selector: "name", namespace: null}]),
  c: isObjectType([{kind: OBJECT_TYPE, selector: "user", namespace: null}])
}
```

#### Output

```Json
{
  "a": false,
  "b": true,
  "c": true
}
```

<!-- document id=7fd03ca01bd0cc5a8c6c4bb1a3b1f60539428139d57f5b570c24085a04602189 url=/mulesoft/current/en-us/dataweave/2.9/dw-types-functions-isobjecttype.md -->

---
product: DataWeave
version: 2.9
---

# isObjectType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isObjectType(t: Type): Boolean

Returns `true` if the input is the Object type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isObjectType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = {name: String}
output application/json
---
{
   a: isObjectType(AType),
   b: isObjectType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": false
}
```

<!-- document id=e2d9438953a765c36f3563b38f7401401ab56c1b56592f7113f5db2ab8872f23 url=/mulesoft/current/en-us/dataweave/latest/dw-tree-functions-isobjecttype.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# isObjectType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isObjectType(path: Path): Boolean

Returns `true` if the provided `Path` value is an `OBJECT_TYPE` expression.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>path</code></p></td><td><p>The <code>Path</code> value to validate.</p></td></tr></tbody></table>

### Example

This example shows how `isObjectType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
output application/json
---
{
  a: isObjectType([{kind: OBJECT_TYPE, selector: "user", namespace: null},
                   {kind: ATTRIBUTE_TYPE, selector: "name", namespace: null}]),
  b: isObjectType([{kind: OBJECT_TYPE, selector: "user", namespace: null},
                   {kind: OBJECT_TYPE, selector: "name", namespace: null}]),
  c: isObjectType([{kind: OBJECT_TYPE, selector: "user", namespace: null}])
}
```

#### Output

```Json
{
  "a": false,
  "b": true,
  "c": true
}
```

<!-- document id=920c70450b65de21bc2faa14d896e08d3fda5c37eddc525ced98568703d8ec65 url=/mulesoft/current/en-us/dataweave/latest/dw-types-functions-isobjecttype.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# isObjectType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isObjectType(t: Type): Boolean

Returns `true` if the input is the Object type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isObjectType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = {name: String}
output application/json
---
{
   a: isObjectType(AType),
   b: isObjectType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": false
}
```

<!-- document id=bd154edd4350f2fa45c0ec15fd4940d7bb247f5e16b84196a644316bc8cbab96 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-isodd.md -->

---
product: DataWeave
version: 2.11
---

# isOdd

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isOdd(number: Number): Boolean

Returns `true` if the number or numeric result of a mathematical operation is odd, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>A number to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the numbers are odd.

#### Source

```DataWeave
%dw 2.0
output  application/json
---
{ "isOdd" : [ isOdd(0), isOdd(1), isOdd(2+2) ] }
```

#### Output

```JSON
{ "isOdd": [ false, true, false ] }
```

<!-- document id=cde25cd94beb2382a713b1113c5c4686dcca0cdffce6e9a52c5b5dee11cb19fe url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-isodd.md -->

---
product: DataWeave
version: 2.12
---

# isOdd

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isOdd(number: Number): Boolean

Returns `true` if the number or numeric result of a mathematical operation is odd, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>A number to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the numbers are odd.

#### Source

```DataWeave
%dw 2.0
output  application/json
---
{ "isOdd" : [ isOdd(0), isOdd(1), isOdd(2+2) ] }
```

#### Output

```JSON
{ "isOdd": [ false, true, false ] }
```

<!-- document id=8b5b857b5d366a8005824729f86d92c5499a83cffd8a172c24d5ed51930c0af2 url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-isodd.md -->

---
product: DataWeave
version: 2.3
---

# isOdd

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isOdd(Number): Boolean

Returns `true` if the number or numeric result of a mathematical operation is odd, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>A number to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the numbers are odd.

#### Source

```DataWeave
%dw 2.0
output  application/json
---
{ "isOdd" : [ isOdd(0), isOdd(1), isOdd(2+2) ] }
```

#### Output

```JSON
{ "isOdd": [ false, true, false ] }
```

<!-- document id=c5293fe5a4e049ed5375fa55cae6103e46956375035b78b03705b17602ef0853 url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-isodd.md -->

---
product: DataWeave
version: 2.4
---

# isOdd

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isOdd(number: Number): Boolean

Returns `true` if the number or numeric result of a mathematical operation is odd, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>A number to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the numbers are odd.

#### Source

```DataWeave
%dw 2.0
output  application/json
---
{ "isOdd" : [ isOdd(0), isOdd(1), isOdd(2+2) ] }
```

#### Output

```JSON
{ "isOdd": [ false, true, false ] }
```

<!-- document id=2a14d58a101fc0e64357ee7973e63e2dd35f52fae22c782e1a9a9d5235e95840 url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-isodd.md -->

---
product: DataWeave
version: 2.6
---

# isOdd

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isOdd(number: Number): Boolean

Returns `true` if the number or numeric result of a mathematical operation is odd, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>A number to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the numbers are odd.

#### Source

```DataWeave
%dw 2.0
output  application/json
---
{ "isOdd" : [ isOdd(0), isOdd(1), isOdd(2+2) ] }
```

#### Output

```JSON
{ "isOdd": [ false, true, false ] }
```

<!-- document id=48e4ec147863aae2d6ce9b36003ea4038beeba6a340c890922d6cdae27026fae url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-isodd.md -->

---
product: DataWeave
version: 2.9
---

# isOdd

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isOdd(number: Number): Boolean

Returns `true` if the number or numeric result of a mathematical operation is odd, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>A number to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the numbers are odd.

#### Source

```DataWeave
%dw 2.0
output  application/json
---
{ "isOdd" : [ isOdd(0), isOdd(1), isOdd(2+2) ] }
```

#### Output

```JSON
{ "isOdd": [ false, true, false ] }
```

<!-- document id=9b1b32e05990389c586ab232ff3daf681c8e5baaa811a672c07f2849e484d105 url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-isodd.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# isOdd

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isOdd(number: Number): Boolean

Returns `true` if the number or numeric result of a mathematical operation is odd, `false` if not.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>A number to evaluate.</p></td></tr></tbody></table>

### Example

This example indicates whether the numbers are odd.

#### Source

```DataWeave
%dw 2.0
output  application/json
---
{ "isOdd" : [ isOdd(0), isOdd(1), isOdd(2+2) ] }
```

#### Output

```JSON
{ "isOdd": [ false, true, false ] }
```

<!-- document id=381df7e5805bd40dd4e534497b2c6ac0805b74bc169aa9c12c4144b09a613212 url=/mulesoft/current/en-us/dataweave/2.11/dw-types-functions-isperiodtype.md -->

---
product: DataWeave
version: 2.11
---

# isPeriodType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isPeriodType(t: Type): Boolean

Returns `true` if the input is the Period type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isPeriodType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type APeriod = Period
output application/json
---
{
   a: isPeriodType(APeriod),
   b: isPeriodType(Period),
   c: isPeriodType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=ac5a734ecfdb78ba8c7848df584d0a206ba92ccfb0540204b0266d372d4a2e52 url=/mulesoft/current/en-us/dataweave/2.12/dw-types-functions-isperiodtype.md -->

---
product: DataWeave
version: 2.12
---

# isPeriodType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isPeriodType(t: Type): Boolean

Returns `true` if the input is the Period type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isPeriodType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type APeriod = Period
output application/json
---
{
   a: isPeriodType(APeriod),
   b: isPeriodType(Period),
   c: isPeriodType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=00c485f9a9c1f57a90dffe03185975f18644139d69cc15977e78e091d426b70b url=/mulesoft/current/en-us/dataweave/2.3/dw-types-functions-isperiodtype.md -->

---
product: DataWeave
version: 2.3
---

# isPeriodType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isPeriodType(Type): Boolean

Returns `true` if the input is the Period type.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>t</p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isPeriodType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type APeriod = Period
output application/json
---
{
   a: isPeriodType(APeriod),
   b: isPeriodType(Period),
   c: isPeriodType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=6f58934acc0190d1f8c4b054bdcc74dcc98f0a20b71e3a14e4cf3cdfeae4a99a url=/mulesoft/current/en-us/dataweave/2.4/dw-types-functions-isperiodtype.md -->

---
product: DataWeave
version: 2.4
---

# isPeriodType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isPeriodType(t: Type): Boolean

Returns `true` if the input is the Period type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isPeriodType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type APeriod = Period
output application/json
---
{
   a: isPeriodType(APeriod),
   b: isPeriodType(Period),
   c: isPeriodType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=cf6282ea8f60e2288e4fba0d7b5b46e237e43d689f4652672cd74d46fc9d8302 url=/mulesoft/current/en-us/dataweave/2.6/dw-types-functions-isperiodtype.md -->

---
product: DataWeave
version: 2.6
---

# isPeriodType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isPeriodType(t: Type): Boolean

Returns `true` if the input is the Period type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isPeriodType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type APeriod = Period
output application/json
---
{
   a: isPeriodType(APeriod),
   b: isPeriodType(Period),
   c: isPeriodType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=564cff8cbb847fce29a5af005a4f50526fd3ecaeb98ef70139e5aebc5290b613 url=/mulesoft/current/en-us/dataweave/2.9/dw-types-functions-isperiodtype.md -->

---
product: DataWeave
version: 2.9
---

# isPeriodType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isPeriodType(t: Type): Boolean

Returns `true` if the input is the Period type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isPeriodType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type APeriod = Period
output application/json
---
{
   a: isPeriodType(APeriod),
   b: isPeriodType(Period),
   c: isPeriodType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=8108c47152191e9cde4cf9f72c1a4b40723105f402532ed5df8953dcd14d74ce url=/mulesoft/current/en-us/dataweave/latest/dw-types-functions-isperiodtype.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# isPeriodType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isPeriodType(t: Type): Boolean

Returns `true` if the input is the Period type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isPeriodType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type APeriod = Period
output application/json
---
{
   a: isPeriodType(APeriod),
   b: isPeriodType(Period),
   c: isPeriodType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=d871d21fa524c05b1addf75233b0348ed47bc66fc5fdbda806c819430d3479c9 url=/mulesoft/current/en-us/dataweave/2.11/dw-types-functions-israngetype.md -->

---
product: DataWeave
version: 2.11
---

# isRangeType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isRangeType(t: Type): Boolean

Returns `true` if the input is the Range type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isRangeType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ARange = Range
output application/json
---
{
   a: isRangeType(ARange),
   b: isRangeType(Range),
   c: isRangeType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=90dab1d237eeee86d93042446e1a37d94ecfdbd7bffe64da916741a4f9bacb77 url=/mulesoft/current/en-us/dataweave/2.12/dw-types-functions-israngetype.md -->

---
product: DataWeave
version: 2.12
---

# isRangeType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isRangeType(t: Type): Boolean

Returns `true` if the input is the Range type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isRangeType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ARange = Range
output application/json
---
{
   a: isRangeType(ARange),
   b: isRangeType(Range),
   c: isRangeType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=72b6ef596e5a59be5fa0763fe8775d1443aaa0c185a596ebaa8bad05fa58f552 url=/mulesoft/current/en-us/dataweave/2.3/dw-types-functions-israngetype.md -->

---
product: DataWeave
version: 2.3
---

# isRangeType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isRangeType(Type): Boolean

Returns `true` if the input is the Range type.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>t</p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isRangeType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ARange = Range
output application/json
---
{
   a: isRangeType(ARange),
   b: isRangeType(Range),
   c: isRangeType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=0ac71fe5eae6a7b9996e080610b821e16dc9133cc98d5b0a887508681d9a2afd url=/mulesoft/current/en-us/dataweave/2.4/dw-types-functions-israngetype.md -->

---
product: DataWeave
version: 2.4
---

# isRangeType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isRangeType(t: Type): Boolean

Returns `true` if the input is the Range type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isRangeType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ARange = Range
output application/json
---
{
   a: isRangeType(ARange),
   b: isRangeType(Range),
   c: isRangeType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=e4425324ebd39451d35c0c7c524f4a7309dc0d731244641db2a7e63813089112 url=/mulesoft/current/en-us/dataweave/2.6/dw-types-functions-israngetype.md -->

---
product: DataWeave
version: 2.6
---

# isRangeType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isRangeType(t: Type): Boolean

Returns `true` if the input is the Range type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isRangeType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ARange = Range
output application/json
---
{
   a: isRangeType(ARange),
   b: isRangeType(Range),
   c: isRangeType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=95747b0a19454244eab99ada2bc23105211c64669258e0c748f25ca931f679d0 url=/mulesoft/current/en-us/dataweave/2.9/dw-types-functions-israngetype.md -->

---
product: DataWeave
version: 2.9
---

# isRangeType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isRangeType(t: Type): Boolean

Returns `true` if the input is the Range type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isRangeType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ARange = Range
output application/json
---
{
   a: isRangeType(ARange),
   b: isRangeType(Range),
   c: isRangeType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=d546f2765cd9f377d62b1ad9dee2451a22518751d7b2976474b5a4d4d74e58c7 url=/mulesoft/current/en-us/dataweave/latest/dw-types-functions-israngetype.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# isRangeType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isRangeType(t: Type): Boolean

Returns `true` if the input is the Range type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isRangeType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ARange = Range
output application/json
---
{
   a: isRangeType(ARange),
   b: isRangeType(Range),
   c: isRangeType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=afeb1658517e90aa2c92365c23b0480e7fd5b6c77ea2249fc12c7c6b1a30a5bc url=/mulesoft/current/en-us/dataweave/2.11/dw-types-functions-isreferencetype.md -->

---
product: DataWeave
version: 2.11
---

# isReferenceType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isReferenceType(t: Type): Boolean

Returns `true` if the input type is a Reference type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isReferenceType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::core::Types
 type AArray = Array<String> {n: 1}
 type AArray2 = Array<AArray>
 ---
 {
     a: isReferenceType( AArray),
     b: isReferenceType(arrayItem(AArray2)),
     c: isReferenceType(String)
 }
```

#### Output

```Json
{
  "a": false,
  "b": true,
  "c": false
}
```

<!-- document id=19991ecfa80f530deb018df3eab5cadc24fdf9c83f9676daace807329bb9acd5 url=/mulesoft/current/en-us/dataweave/2.12/dw-types-functions-isreferencetype.md -->

---
product: DataWeave
version: 2.12
---

# isReferenceType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isReferenceType(t: Type): Boolean

Returns `true` if the input type is a Reference type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isReferenceType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::core::Types
 type AArray = Array<String> {n: 1}
 type AArray2 = Array<AArray>
 ---
 {
     a: isReferenceType( AArray),
     b: isReferenceType(arrayItem(AArray2)),
     c: isReferenceType(String)
 }
```

#### Output

```Json
{
  "a": false,
  "b": true,
  "c": false
}
```

<!-- document id=3d487703ffd785472e9425115dcb17c824125b796062266a2a1a7e0c8aead133 url=/mulesoft/current/en-us/dataweave/2.3/dw-types-functions-isreferencetype.md -->

---
product: DataWeave
version: 2.3
---

# isReferenceType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isReferenceType(Type): Boolean

Returns `true` if the input type is a Reference type.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>t</p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isReferenceType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::core::Types
 type AArray = Array<String> {n: 1}
 type AArray2 = Array<AArray>
 ---
 {
     a: isReferenceType( AArray),
     b: isReferenceType(arrayItem(AArray2)),
     c: isReferenceType(String)
 }
```

#### Output

```Json
{
  "a": false,
  "b": true,
  "c": false
}
```

<!-- document id=8023df536d3997bbca7a967035bfaa020a0f5faed0bd325ffc6029b23eb2dc02 url=/mulesoft/current/en-us/dataweave/2.4/dw-types-functions-isreferencetype.md -->

---
product: DataWeave
version: 2.4
---

# isReferenceType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isReferenceType(t: Type): Boolean

Returns `true` if the input type is a Reference type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isReferenceType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::core::Types
 type AArray = Array<String> {n: 1}
 type AArray2 = Array<AArray>
 ---
 {
     a: isReferenceType( AArray),
     b: isReferenceType(arrayItem(AArray2)),
     c: isReferenceType(String)
 }
```

#### Output

```Json
{
  "a": false,
  "b": true,
  "c": false
}
```

<!-- document id=f2ff7907fc3c728a7f62b733f66c632d747f7a91203c93819381a62671a582ec url=/mulesoft/current/en-us/dataweave/2.6/dw-types-functions-isreferencetype.md -->

---
product: DataWeave
version: 2.6
---

# isReferenceType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isReferenceType(t: Type): Boolean

Returns `true` if the input type is a Reference type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isReferenceType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::core::Types
 type AArray = Array<String> {n: 1}
 type AArray2 = Array<AArray>
 ---
 {
     a: isReferenceType( AArray),
     b: isReferenceType(arrayItem(AArray2)),
     c: isReferenceType(String)
 }
```

#### Output

```Json
{
  "a": false,
  "b": true,
  "c": false
}
```

<!-- document id=10eb5abf7cd489e1f0092833a10ff5a19167755a357d0af73ddd0b37fc64f591 url=/mulesoft/current/en-us/dataweave/2.9/dw-types-functions-isreferencetype.md -->

---
product: DataWeave
version: 2.9
---

# isReferenceType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isReferenceType(t: Type): Boolean

Returns `true` if the input type is a Reference type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isReferenceType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::core::Types
 type AArray = Array<String> {n: 1}
 type AArray2 = Array<AArray>
 ---
 {
     a: isReferenceType( AArray),
     b: isReferenceType(arrayItem(AArray2)),
     c: isReferenceType(String)
 }
```

#### Output

```Json
{
  "a": false,
  "b": true,
  "c": false
}
```

<!-- document id=8f5ee789b1096578e2404377bc0e5b388b4d660c7cf7e5cd1cab4021ce244a1a url=/mulesoft/current/en-us/dataweave/latest/dw-types-functions-isreferencetype.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# isReferenceType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isReferenceType(t: Type): Boolean

Returns `true` if the input type is a Reference type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isReferenceType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::core::Types
 type AArray = Array<String> {n: 1}
 type AArray2 = Array<AArray>
 ---
 {
     a: isReferenceType( AArray),
     b: isReferenceType(arrayItem(AArray2)),
     c: isReferenceType(String)
 }
```

#### Output

```Json
{
  "a": false,
  "b": true,
  "c": false
}
```

<!-- document id=8c28ff192a5482798b5f0c906a2827329069abe7921d8ef1c700a1c27e9dc86d url=/mulesoft/current/en-us/dataweave/2.11/dw-types-functions-isregextype.md -->

---
product: DataWeave
version: 2.11
---

# isRegexType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isRegexType(t: Type): Boolean

Returns `true` if the input is the Regex type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isRegexType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ARegex = Regex
output application/json
---
{
   a: isRegexType(ARegex),
   b: isRegexType(Regex),
   c: isRegexType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=77ec30da5a4a81f7f0d9097441498bac933d39e175b654a92fad2f32e135ac40 url=/mulesoft/current/en-us/dataweave/2.12/dw-types-functions-isregextype.md -->

---
product: DataWeave
version: 2.12
---

# isRegexType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isRegexType(t: Type): Boolean

Returns `true` if the input is the Regex type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isRegexType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ARegex = Regex
output application/json
---
{
   a: isRegexType(ARegex),
   b: isRegexType(Regex),
   c: isRegexType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=7dfb5634938e9d201742d0749b4fdfcd5bdd4832c594f94a4d9bc7b12cb26ba1 url=/mulesoft/current/en-us/dataweave/2.3/dw-types-functions-isregextype.md -->

---
product: DataWeave
version: 2.3
---

# isRegexType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isRegexType(Type): Boolean

Returns `true` if the input is the Regex type.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>t</p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isRegexType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ARegex = Regex
output application/json
---
{
   a: isRegexType(ARegex),
   b: isRegexType(Regex),
   c: isRegexType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=529fade0678ed67bcf8549012b93c005dbd6700c789d272fe6b570131be2c3e1 url=/mulesoft/current/en-us/dataweave/2.4/dw-types-functions-isregextype.md -->

---
product: DataWeave
version: 2.4
---

# isRegexType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isRegexType(t: Type): Boolean

Returns `true` if the input is the Regex type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isRegexType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ARegex = Regex
output application/json
---
{
   a: isRegexType(ARegex),
   b: isRegexType(Regex),
   c: isRegexType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=74586ee643a2e38fde1dd983b31cce8fb0303e61de80ee93cf2cd11ae471ac13 url=/mulesoft/current/en-us/dataweave/2.6/dw-types-functions-isregextype.md -->

---
product: DataWeave
version: 2.6
---

# isRegexType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isRegexType(t: Type): Boolean

Returns `true` if the input is the Regex type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isRegexType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ARegex = Regex
output application/json
---
{
   a: isRegexType(ARegex),
   b: isRegexType(Regex),
   c: isRegexType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=3a955e68dede7eed49e2ec3458fc512f9099dd3f1527ba01e521e66ca09192ce url=/mulesoft/current/en-us/dataweave/2.9/dw-types-functions-isregextype.md -->

---
product: DataWeave
version: 2.9
---

# isRegexType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isRegexType(t: Type): Boolean

Returns `true` if the input is the Regex type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isRegexType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ARegex = Regex
output application/json
---
{
   a: isRegexType(ARegex),
   b: isRegexType(Regex),
   c: isRegexType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=37145d6c7d5d6dd1b4e8c531ee15dbc45a0e5e18e7fe7e0088b622611261e7d9 url=/mulesoft/current/en-us/dataweave/latest/dw-types-functions-isregextype.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# isRegexType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isRegexType(t: Type): Boolean

Returns `true` if the input is the Regex type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isRegexType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ARegex = Regex
output application/json
---
{
   a: isRegexType(ARegex),
   b: isRegexType(Regex),
   c: isRegexType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=e1ab339c2ba9391bcd2f8bf616cc1707edfc774008e0c56ff559f327e649de0c url=/mulesoft/current/en-us/dataweave/2.11/dw-types-functions-isstringtype.md -->

---
product: DataWeave
version: 2.11
---

# isStringType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isStringType(t: Type): Boolean

Returns `true` if the input is the String type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isStringType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AString = String
output application/json
---
{
   a: isStringType(AString),
   b: isStringType(String),
   c: isStringType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=60612f23a9b8121ecfcc486b140a3ad38b37f608fde205e527d5751cdea62a31 url=/mulesoft/current/en-us/dataweave/2.12/dw-types-functions-isstringtype.md -->

---
product: DataWeave
version: 2.12
---

# isStringType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isStringType(t: Type): Boolean

Returns `true` if the input is the String type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isStringType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AString = String
output application/json
---
{
   a: isStringType(AString),
   b: isStringType(String),
   c: isStringType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=2088f3b846b62acb1a5f78303fe291eb13fd06f270ffbda86c9926db14f51f1a url=/mulesoft/current/en-us/dataweave/2.3/dw-types-functions-isstringtype.md -->

---
product: DataWeave
version: 2.3
---

# isStringType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isStringType(Type): Boolean

Returns `true` if the input is the String type.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>t</p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isStringType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AString = String
output application/json
---
{
   a: isStringType(AString),
   b: isStringType(String),
   c: isStringType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=ad7764baf665058f364ea99724eb9d62f473dd0d23871a35096c5e4ea52c20ea url=/mulesoft/current/en-us/dataweave/2.4/dw-types-functions-isstringtype.md -->

---
product: DataWeave
version: 2.4
---

# isStringType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isStringType(t: Type): Boolean

Returns `true` if the input is the String type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isStringType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AString = String
output application/json
---
{
   a: isStringType(AString),
   b: isStringType(String),
   c: isStringType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=1ea0f01fcbaf3fa394bcb791422448b625e911f5a2d51ed9d06edb59c9e5d40b url=/mulesoft/current/en-us/dataweave/2.6/dw-types-functions-isstringtype.md -->

---
product: DataWeave
version: 2.6
---

# isStringType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isStringType(t: Type): Boolean

Returns `true` if the input is the String type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isStringType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AString = String
output application/json
---
{
   a: isStringType(AString),
   b: isStringType(String),
   c: isStringType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=029c280c3d160b5d3a75a7c463bd0b6054792b9e02319e0fe517e5ca61477d35 url=/mulesoft/current/en-us/dataweave/2.9/dw-types-functions-isstringtype.md -->

---
product: DataWeave
version: 2.9
---

# isStringType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isStringType(t: Type): Boolean

Returns `true` if the input is the String type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isStringType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AString = String
output application/json
---
{
   a: isStringType(AString),
   b: isStringType(String),
   c: isStringType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=590e7089bc265e2dcee16fd8ae3de7cc0332a175faf489ea6950e053eaed9ec4 url=/mulesoft/current/en-us/dataweave/latest/dw-types-functions-isstringtype.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# isStringType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isStringType(t: Type): Boolean

Returns `true` if the input is the String type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isStringType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AString = String
output application/json
---
{
   a: isStringType(AString),
   b: isStringType(String),
   c: isStringType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=c9eb9ad664d5da3cac1a1d1825e6fa7de23f2507b3b0308fdebb326fc2d837ed url=/mulesoft/current/en-us/dataweave/2.11/dw-types-functions-istimetype.md -->

---
product: DataWeave
version: 2.11
---

# isTimeType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isTimeType(t: Type): Boolean

Returns `true` if the input is the Time type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isTimeType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ATime = Time
output application/json
---
{
   a: isTimeType(ATime),
   b: isTimeType(Time),
   c: isTimeType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=bd4f7711c656393c5b2c1f05aedcae100979a9e10d98ed0a2521dd3984e737d7 url=/mulesoft/current/en-us/dataweave/2.12/dw-types-functions-istimetype.md -->

---
product: DataWeave
version: 2.12
---

# isTimeType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isTimeType(t: Type): Boolean

Returns `true` if the input is the Time type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isTimeType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ATime = Time
output application/json
---
{
   a: isTimeType(ATime),
   b: isTimeType(Time),
   c: isTimeType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=0df0d5d3153c81ec06c5ba02521345727e5a7041ad0515682ec17effddf9aa2f url=/mulesoft/current/en-us/dataweave/2.3/dw-types-functions-istimetype.md -->

---
product: DataWeave
version: 2.3
---

# isTimeType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isTimeType(Type): Boolean

Returns `true` if the input is the Time type.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>t</p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isTimeType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ATime = Time
output application/json
---
{
   a: isTimeType(ATime),
   b: isTimeType(Time),
   c: isTimeType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=08217e414da05bea93dd28797401767bae1fea129ffca688880792b27df6be64 url=/mulesoft/current/en-us/dataweave/2.4/dw-types-functions-istimetype.md -->

---
product: DataWeave
version: 2.4
---

# isTimeType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isTimeType(t: Type): Boolean

Returns `true` if the input is the Time type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isTimeType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ATime = Time
output application/json
---
{
   a: isTimeType(ATime),
   b: isTimeType(Time),
   c: isTimeType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=96911d28ffe74ce18fb1f5d4003959987e943f17e0667873a53ab7780a8241d6 url=/mulesoft/current/en-us/dataweave/2.6/dw-types-functions-istimetype.md -->

---
product: DataWeave
version: 2.6
---

# isTimeType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isTimeType(t: Type): Boolean

Returns `true` if the input is the Time type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isTimeType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ATime = Time
output application/json
---
{
   a: isTimeType(ATime),
   b: isTimeType(Time),
   c: isTimeType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=2dc53749c789cbe398f8253061c723842f4b7abcc596c4a0353c0b19d3d487fc url=/mulesoft/current/en-us/dataweave/2.9/dw-types-functions-istimetype.md -->

---
product: DataWeave
version: 2.9
---

# isTimeType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isTimeType(t: Type): Boolean

Returns `true` if the input is the Time type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isTimeType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ATime = Time
output application/json
---
{
   a: isTimeType(ATime),
   b: isTimeType(Time),
   c: isTimeType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=ae3ec146044259ac4ccec3cadf5139ddace236edc738f259ac60a8b3edaf9e33 url=/mulesoft/current/en-us/dataweave/latest/dw-types-functions-istimetype.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# isTimeType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isTimeType(t: Type): Boolean

Returns `true` if the input is the Time type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isTimeType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ATime = Time
output application/json
---
{
   a: isTimeType(ATime),
   b: isTimeType(Time),
   c: isTimeType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=c9fb2e2a85cfde81f958196e3f9f330b04a0d670b9c0bb30972032471f792344 url=/mulesoft/current/en-us/dataweave/2.11/dw-types-functions-istimezonetype.md -->

---
product: DataWeave
version: 2.11
---

# isTimeZoneType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isTimeZoneType(t: Type): Boolean

Returns `true` if the input is the TimeZone type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isTimeZoneType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ATimeZone = TimeZone
output application/json
---
{
   a: isTimeZoneType(ATimeZone),
   b: isTimeZoneType(TimeZone),
   c: isTimeZoneType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=88c995f5db068a66667f07d50d3527073f9e402d6cd40f090720537683b0138f url=/mulesoft/current/en-us/dataweave/2.12/dw-types-functions-istimezonetype.md -->

---
product: DataWeave
version: 2.12
---

# isTimeZoneType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isTimeZoneType(t: Type): Boolean

Returns `true` if the input is the TimeZone type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isTimeZoneType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ATimeZone = TimeZone
output application/json
---
{
   a: isTimeZoneType(ATimeZone),
   b: isTimeZoneType(TimeZone),
   c: isTimeZoneType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=3650b36429df1dad49d7d9a702a07213d16ff8d5ea997c01ae364b0df7299d35 url=/mulesoft/current/en-us/dataweave/2.3/dw-types-functions-istimezonetype.md -->

---
product: DataWeave
version: 2.3
---

# isTimeZoneType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isTimeZoneType(Type): Boolean

Returns `true` if the input is the TimeZone type.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>t</p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isTimeZoneType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ATimeZone = TimeZone
output application/json
---
{
   a: isTimeZoneType(ATimeZone),
   b: isTimeZoneType(TimeZone),
   c: isTimeZoneType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=99d12efa3b7386868083616d51c25d7a0c495f72bb32bcdd5e3c52abee89e589 url=/mulesoft/current/en-us/dataweave/2.4/dw-types-functions-istimezonetype.md -->

---
product: DataWeave
version: 2.4
---

# isTimeZoneType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isTimeZoneType(t: Type): Boolean

Returns `true` if the input is the TimeZone type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isTimeZoneType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ATimeZone = TimeZone
output application/json
---
{
   a: isTimeZoneType(ATimeZone),
   b: isTimeZoneType(TimeZone),
   c: isTimeZoneType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=53901913656e05a3dc03c78d5d0619e9f585bd7f31b859ea46eea76a0aafbacb url=/mulesoft/current/en-us/dataweave/2.6/dw-types-functions-istimezonetype.md -->

---
product: DataWeave
version: 2.6
---

# isTimeZoneType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isTimeZoneType(t: Type): Boolean

Returns `true` if the input is the TimeZone type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isTimeZoneType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ATimeZone = TimeZone
output application/json
---
{
   a: isTimeZoneType(ATimeZone),
   b: isTimeZoneType(TimeZone),
   c: isTimeZoneType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=38c0c0fafa09d426cd3802286dcc7be8c50f8ee388237ca933f93b5d255eeb79 url=/mulesoft/current/en-us/dataweave/2.9/dw-types-functions-istimezonetype.md -->

---
product: DataWeave
version: 2.9
---

# isTimeZoneType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isTimeZoneType(t: Type): Boolean

Returns `true` if the input is the TimeZone type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isTimeZoneType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ATimeZone = TimeZone
output application/json
---
{
   a: isTimeZoneType(ATimeZone),
   b: isTimeZoneType(TimeZone),
   c: isTimeZoneType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=bb1ea4aa240899ab9a07faf16bdc22885c183d6edcd3e48d15fe4fe6c490b401 url=/mulesoft/current/en-us/dataweave/latest/dw-types-functions-istimezonetype.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# isTimeZoneType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isTimeZoneType(t: Type): Boolean

Returns `true` if the input is the TimeZone type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isTimeZoneType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type ATimeZone = TimeZone
output application/json
---
{
   a: isTimeZoneType(ATimeZone),
   b: isTimeZoneType(TimeZone),
   c: isTimeZoneType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=ddf3c8d3042a74bd16bbf8cf2472ea57a39bf34c6a05a73feefabf34669b1346 url=/mulesoft/current/en-us/dataweave/2.11/dw-types-functions-istypetype.md -->

---
product: DataWeave
version: 2.11
---

# isTypeType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isTypeType(t: Type): Boolean

Returns `true` if the input is the Type type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isTypeType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = Type
output application/json
---
{
   a: isTypeType(AType),
   b: isTypeType(Type),
   c: isTypeType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=16d3b838246f3b953ecc07c43043d19ce25ed1d3f8589d36959d24f2bc37bc73 url=/mulesoft/current/en-us/dataweave/2.12/dw-types-functions-istypetype.md -->

---
product: DataWeave
version: 2.12
---

# isTypeType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isTypeType(t: Type): Boolean

Returns `true` if the input is the Type type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isTypeType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = Type
output application/json
---
{
   a: isTypeType(AType),
   b: isTypeType(Type),
   c: isTypeType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=e9cd0cae250979ee108a5bebe0146066807b038b7eff431fc7cb1458367a63e1 url=/mulesoft/current/en-us/dataweave/2.3/dw-types-functions-istypetype.md -->

---
product: DataWeave
version: 2.3
---

# isTypeType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isTypeType(Type): Boolean

Returns `true` if the input is the Type type.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>t</p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isTypeType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = Type
output application/json
---
{
   a: isTypeType(AType),
   b: isTypeType(Type),
   c: isTypeType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=acd2379384203739f94d86271fa57fbbfb82d0cc73025369c253610c7fe1ac21 url=/mulesoft/current/en-us/dataweave/2.4/dw-types-functions-istypetype.md -->

---
product: DataWeave
version: 2.4
---

# isTypeType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isTypeType(t: Type): Boolean

Returns `true` if the input is the Type type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isTypeType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = Type
output application/json
---
{
   a: isTypeType(AType),
   b: isTypeType(Type),
   c: isTypeType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=42eaf5725295edb7b8e67c51505ff2f5594ea9bcb64e645767104f40db7ae3a5 url=/mulesoft/current/en-us/dataweave/2.6/dw-types-functions-istypetype.md -->

---
product: DataWeave
version: 2.6
---

# isTypeType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isTypeType(t: Type): Boolean

Returns `true` if the input is the Type type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isTypeType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = Type
output application/json
---
{
   a: isTypeType(AType),
   b: isTypeType(Type),
   c: isTypeType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=229d1134c035ae10a37e7f61f38b199ac30935ba98a3094c0deab02a792c05d0 url=/mulesoft/current/en-us/dataweave/2.9/dw-types-functions-istypetype.md -->

---
product: DataWeave
version: 2.9
---

# isTypeType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isTypeType(t: Type): Boolean

Returns `true` if the input is the Type type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isTypeType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = Type
output application/json
---
{
   a: isTypeType(AType),
   b: isTypeType(Type),
   c: isTypeType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=849f7ba34dd602e1731df45b2252bdd8e7b2ad39625f6c9ee777dfe7a88cc64e url=/mulesoft/current/en-us/dataweave/latest/dw-types-functions-istypetype.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# isTypeType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isTypeType(t: Type): Boolean

Returns `true` if the input is the Type type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isTypeType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = Type
output application/json
---
{
   a: isTypeType(AType),
   b: isTypeType(Type),
   c: isTypeType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=d2ef6d5a200f209171e556e2c166533e473f9b1d22e9468588623a607e856f95 url=/mulesoft/current/en-us/dataweave/2.11/dw-types-functions-isuniontype.md -->

---
product: DataWeave
version: 2.11
---

# isUnionType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isUnionType(t: Type): Boolean

Returns `true` if the input type is the Union type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isUnionType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = String | Number
output application/json
---
{
   a: isUnionType(AType),
   b: isUnionType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": false
}
```

<!-- document id=86a1c6198b76e5f11e325225744614949a488d698a7d56fc1e120dd6a0701f99 url=/mulesoft/current/en-us/dataweave/2.12/dw-types-functions-isuniontype.md -->

---
product: DataWeave
version: 2.12
---

# isUnionType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isUnionType(t: Type): Boolean

Returns `true` if the input type is the Union type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isUnionType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = String | Number
output application/json
---
{
   a: isUnionType(AType),
   b: isUnionType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": false
}
```

<!-- document id=ccf0dc3865eec6cf019d7b02fa9e3688950f5e8e49a4107a83d0028809eed7df url=/mulesoft/current/en-us/dataweave/2.3/dw-types-functions-isuniontype.md -->

---
product: DataWeave
version: 2.3
---

# isUnionType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isUnionType(Type): Boolean

Returns `true` if the input type is the Union type.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>t</p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isUnionType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = String | Number
output application/json
---
{
   a: isUnionType(AType),
   b: isUnionType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": false
}
```

<!-- document id=957e85b9d06e069f9b76571aab7aa361d467d3835643ddaa1db4246e1bcef405 url=/mulesoft/current/en-us/dataweave/2.4/dw-types-functions-isuniontype.md -->

---
product: DataWeave
version: 2.4
---

# isUnionType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isUnionType(t: Type): Boolean

Returns `true` if the input type is the Union type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isUnionType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = String | Number
output application/json
---
{
   a: isUnionType(AType),
   b: isUnionType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": false
}
```

<!-- document id=e27f7282ee041992073bc19879e218f4e7ed9d82eb769f83bf7b8b37e5ef39a6 url=/mulesoft/current/en-us/dataweave/2.6/dw-types-functions-isuniontype.md -->

---
product: DataWeave
version: 2.6
---

# isUnionType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isUnionType(t: Type): Boolean

Returns `true` if the input type is the Union type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isUnionType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = String | Number
output application/json
---
{
   a: isUnionType(AType),
   b: isUnionType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": false
}
```

<!-- document id=1ce06406d16edd96694cbe1336ccf25f453f6eaf1b3bc14621f1a6a27ddae4a0 url=/mulesoft/current/en-us/dataweave/2.9/dw-types-functions-isuniontype.md -->

---
product: DataWeave
version: 2.9
---

# isUnionType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isUnionType(t: Type): Boolean

Returns `true` if the input type is the Union type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isUnionType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = String | Number
output application/json
---
{
   a: isUnionType(AType),
   b: isUnionType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": false
}
```

<!-- document id=ea63077faf6130d68c7848d71bd1f62ac086b1195fbc68679f79b93baea156ec url=/mulesoft/current/en-us/dataweave/latest/dw-types-functions-isuniontype.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# isUnionType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isUnionType(t: Type): Boolean

Returns `true` if the input type is the Union type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isUnionType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = String | Number
output application/json
---
{
   a: isUnionType(AType),
   b: isUnionType(Boolean),
}
```

#### Output

```Json
{
  "a": true,
  "b": false
}
```

<!-- document id=9d7d33329a5a52709b5a0de717ccd07dfce5df7d9b8842f3b9be90dce11b9370 url=/mulesoft/current/en-us/dataweave/2.11/dw-strings-functions-isuppercase.md -->

---
product: DataWeave
version: 2.11
---

# isUpperCase

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isUpperCase(text: String): Boolean

Checks if the `text` contains only uppercase characters.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example shows how `isUpperCase` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import isUpperCase from dw::core::Strings
output application/json
---
{
  "a": isUpperCase(null),
  "b": isUpperCase(""),
  "c": isUpperCase("  "),
  "d": isUpperCase("ABC"),
  "e": isUpperCase("aBC"),
  "f": isUpperCase("A C"),
  "g": isUpperCase("A1C"),
  "h": isUpperCase("A/C")
}
```

#### Output

```JSON
{
  "a": false,
  "b": false,
  "c": false,
  "d": true,
  "e": false,
  "f": false,
  "g": false,
  "h": false
}
```

## isUpperCase(text: Null): Boolean

Helper function that enables `isUpperCase` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=0249d67bb07396d0e64c5ff414c753b31190f803ecc986845ce96356e9c3045e url=/mulesoft/current/en-us/dataweave/2.12/dw-strings-functions-isuppercase.md -->

---
product: DataWeave
version: 2.12
---

# isUpperCase

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isUpperCase(text: String): Boolean

Checks if the `text` contains only uppercase characters.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example shows how `isUpperCase` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import isUpperCase from dw::core::Strings
output application/json
---
{
  "a": isUpperCase(null),
  "b": isUpperCase(""),
  "c": isUpperCase("  "),
  "d": isUpperCase("ABC"),
  "e": isUpperCase("aBC"),
  "f": isUpperCase("A C"),
  "g": isUpperCase("A1C"),
  "h": isUpperCase("A/C")
}
```

#### Output

```JSON
{
  "a": false,
  "b": false,
  "c": false,
  "d": true,
  "e": false,
  "f": false,
  "g": false,
  "h": false
}
```

## isUpperCase(text: Null): Boolean

Helper function that enables `isUpperCase` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=da2ad005d782f917add2c04c3da74e478e51171dc06ad2b894fedb762410412e url=/mulesoft/current/en-us/dataweave/2.3/dw-strings-functions-isuppercase.md -->

---
product: DataWeave
version: 2.3
---

# isUpperCase

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isUpperCase(String): Boolean

Checks if the `text` contains only uppercase characters.

_Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example shows how `isNumeric` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import isUpperCase from dw::core::Strings
output application/json
---
{
  "a": isUpperCase(null),
  "b": isUpperCase(""),
  "c": isUpperCase("  "),
  "d": isUpperCase("ABC"),
  "e": isUpperCase("aBC"),
  "f": isUpperCase("A C"),
  "g": isUpperCase("A1C"),
  "h": isUpperCase("A/C")
}
```

#### Output

```JSON
{
  "a": false,
  "b": false,
  "c": false,
  "d": true,
  "e": false,
  "f": false,
  "g": false,
  "h": false
}
```

## isUpperCase(Null): Boolean

Helper function that enables `isUpperCase` to work with a `null` value.

<!-- document id=25c1ce705c5b9deaff0fc0e25f89cb0abdf45340ee68a8d72739417eba756056 url=/mulesoft/current/en-us/dataweave/2.4/dw-strings-functions-isuppercase.md -->

---
product: DataWeave
version: 2.4
---

# isUpperCase

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isUpperCase(text: String): Boolean

Checks if the `text` contains only uppercase characters.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example shows how `isUpperCase` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import isUpperCase from dw::core::Strings
output application/json
---
{
  "a": isUpperCase(null),
  "b": isUpperCase(""),
  "c": isUpperCase("  "),
  "d": isUpperCase("ABC"),
  "e": isUpperCase("aBC"),
  "f": isUpperCase("A C"),
  "g": isUpperCase("A1C"),
  "h": isUpperCase("A/C")
}
```

#### Output

```JSON
{
  "a": false,
  "b": false,
  "c": false,
  "d": true,
  "e": false,
  "f": false,
  "g": false,
  "h": false
}
```

## isUpperCase(text: Null): Boolean

Helper function that enables `isUpperCase` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=d998f1e0231c5a905183c3e81e692424cb395baf4d9c9ca0f325223d79471068 url=/mulesoft/current/en-us/dataweave/2.6/dw-strings-functions-isuppercase.md -->

---
product: DataWeave
version: 2.6
---

# isUpperCase

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isUpperCase(text: String): Boolean

Checks if the `text` contains only uppercase characters.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example shows how `isUpperCase` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import isUpperCase from dw::core::Strings
output application/json
---
{
  "a": isUpperCase(null),
  "b": isUpperCase(""),
  "c": isUpperCase("  "),
  "d": isUpperCase("ABC"),
  "e": isUpperCase("aBC"),
  "f": isUpperCase("A C"),
  "g": isUpperCase("A1C"),
  "h": isUpperCase("A/C")
}
```

#### Output

```JSON
{
  "a": false,
  "b": false,
  "c": false,
  "d": true,
  "e": false,
  "f": false,
  "g": false,
  "h": false
}
```

## isUpperCase(text: Null): Boolean

Helper function that enables `isUpperCase` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=c920830a527948b34d19347c2f01453f5fffad465538c44858c794d6d9424f36 url=/mulesoft/current/en-us/dataweave/2.9/dw-strings-functions-isuppercase.md -->

---
product: DataWeave
version: 2.9
---

# isUpperCase

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isUpperCase(text: String): Boolean

Checks if the `text` contains only uppercase characters.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example shows how `isUpperCase` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import isUpperCase from dw::core::Strings
output application/json
---
{
  "a": isUpperCase(null),
  "b": isUpperCase(""),
  "c": isUpperCase("  "),
  "d": isUpperCase("ABC"),
  "e": isUpperCase("aBC"),
  "f": isUpperCase("A C"),
  "g": isUpperCase("A1C"),
  "h": isUpperCase("A/C")
}
```

#### Output

```JSON
{
  "a": false,
  "b": false,
  "c": false,
  "d": true,
  "e": false,
  "f": false,
  "g": false,
  "h": false
}
```

## isUpperCase(text: Null): Boolean

Helper function that enables `isUpperCase` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=df230de4197139fb324985408a1f8bb4a30f6c41edf067be15cccef12f7fcfdd url=/mulesoft/current/en-us/dataweave/latest/dw-strings-functions-isuppercase.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# isUpperCase

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isUpperCase(text: String): Boolean

Checks if the `text` contains only uppercase characters.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example shows how `isUpperCase` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import isUpperCase from dw::core::Strings
output application/json
---
{
  "a": isUpperCase(null),
  "b": isUpperCase(""),
  "c": isUpperCase("  "),
  "d": isUpperCase("ABC"),
  "e": isUpperCase("aBC"),
  "f": isUpperCase("A C"),
  "g": isUpperCase("A1C"),
  "h": isUpperCase("A/C")
}
```

#### Output

```JSON
{
  "a": false,
  "b": false,
  "c": false,
  "d": true,
  "e": false,
  "f": false,
  "g": false,
  "h": false
}
```

## isUpperCase(text: Null): Boolean

Helper function that enables `isUpperCase` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=6a2660cc39108bd051bbb8b667858c2cb69678b65ff0c2d98a71c9b926d736cb url=/mulesoft/current/en-us/dataweave/2.11/dw-types-functions-isuritype.md -->

---
product: DataWeave
version: 2.11
---

# isUriType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isUriType(t: Type): Boolean

Returns `true` if the input is the Uri type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isUriType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AUri = Uri
output application/json
---
{
   a: isUriType(AUri),
   b: isUriType(Uri),
   c: isUriType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=f270e0a6b4e1236f2311f6b6b865ed82b6dab52e55583f43cad1f4b6171087dc url=/mulesoft/current/en-us/dataweave/2.12/dw-types-functions-isuritype.md -->

---
product: DataWeave
version: 2.12
---

# isUriType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isUriType(t: Type): Boolean

Returns `true` if the input is the Uri type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isUriType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AUri = Uri
output application/json
---
{
   a: isUriType(AUri),
   b: isUriType(Uri),
   c: isUriType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=ea6d35484fbac83eb18e46f1afd0bc986f08e471f6f60820cb7e07190229b78a url=/mulesoft/current/en-us/dataweave/2.3/dw-types-functions-isuritype.md -->

---
product: DataWeave
version: 2.3
---

# isUriType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isUriType(Type): Boolean

Returns `true` if the input is the Uri type.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>t</p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isUriType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AUri = Uri
output application/json
---
{
   a: isUriType(AUri),
   b: isUriType(Uri),
   c: isUriType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=c8c90f114fdc6e6252b1cc42973eb25e1bde2cc0d1fea5b1d223b9cbd2edfa54 url=/mulesoft/current/en-us/dataweave/2.4/dw-types-functions-isuritype.md -->

---
product: DataWeave
version: 2.4
---

# isUriType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isUriType(t: Type): Boolean

Returns `true` if the input is the Uri type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isUriType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AUri = Uri
output application/json
---
{
   a: isUriType(AUri),
   b: isUriType(Uri),
   c: isUriType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=0dc8719fd4b727cf58b6cce4f66feaad1b6e96c116fbb0077e0c42d908214a9c url=/mulesoft/current/en-us/dataweave/2.6/dw-types-functions-isuritype.md -->

---
product: DataWeave
version: 2.6
---

# isUriType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isUriType(t: Type): Boolean

Returns `true` if the input is the Uri type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isUriType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AUri = Uri
output application/json
---
{
   a: isUriType(AUri),
   b: isUriType(Uri),
   c: isUriType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=5d57c4e5e2be2705fd8e2eb06e558390b03624f51d065443cd16ca4aee0c245e url=/mulesoft/current/en-us/dataweave/2.9/dw-types-functions-isuritype.md -->

---
product: DataWeave
version: 2.9
---

# isUriType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isUriType(t: Type): Boolean

Returns `true` if the input is the Uri type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isUriType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AUri = Uri
output application/json
---
{
   a: isUriType(AUri),
   b: isUriType(Uri),
   c: isUriType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=f1a7f8d7a07b5df8ca71a870a0aee9f91582f3278f903c0ecbee689bf2b4340e url=/mulesoft/current/en-us/dataweave/latest/dw-types-functions-isuritype.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# isUriType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isUriType(t: Type): Boolean

Returns `true` if the input is the Uri type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `isUriType` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AUri = Uri
output application/json
---
{
   a: isUriType(AUri),
   b: isUriType(Uri),
   c: isUriType(String),
}
```

#### Output

```Json
{
  "a": true,
  "b": true,
  "c": false
}
```

<!-- document id=3567f3f158c028ff1c1b48c33a3830a3fe360f183bd3a2ba11534fcc9bb1129c url=/mulesoft/current/en-us/dataweave/2.11/dw-strings-functions-iswhitespace.md -->

---
product: DataWeave
version: 2.11
---

# isWhitespace

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isWhitespace(text: String): Boolean

Checks if the `text` contains only whitespace.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example shows how `isWhitespace` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import isWhitespace from dw::core::Strings
output application/json
---
{
  "a": isWhitespace(null),
  "b": isWhitespace(""),
  "c": isWhitespace("  "),
  "d": isWhitespace("abc"),
  "e": isWhitespace("ab2c"),
  "f": isWhitespace("ab-c")
}
```

#### Output

```JSON
{
  "a": false,
  "b": true,
  "c": true,
  "d": false,
  "e": false,
  "f": false
}
```

## isWhitespace(text: Null): Boolean

Helper function that enables `isWhitespace` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=d574706312ecf194d477c9092173153ca2a69e98e1a117c0fd945dcad42ca9d7 url=/mulesoft/current/en-us/dataweave/2.12/dw-strings-functions-iswhitespace.md -->

---
product: DataWeave
version: 2.12
---

# isWhitespace

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isWhitespace(text: String): Boolean

Checks if the `text` contains only whitespace.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example shows how `isWhitespace` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import isWhitespace from dw::core::Strings
output application/json
---
{
  "a": isWhitespace(null),
  "b": isWhitespace(""),
  "c": isWhitespace("  "),
  "d": isWhitespace("abc"),
  "e": isWhitespace("ab2c"),
  "f": isWhitespace("ab-c")
}
```

#### Output

```JSON
{
  "a": false,
  "b": true,
  "c": true,
  "d": false,
  "e": false,
  "f": false
}
```

## isWhitespace(text: Null): Boolean

Helper function that enables `isWhitespace` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=a12988254240f84ef9dcbf8da9d7dd3521e13ead804607b8f65eff3a600d635a url=/mulesoft/current/en-us/dataweave/2.3/dw-strings-functions-iswhitespace.md -->

---
product: DataWeave
version: 2.3
---

# isWhitespace

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isWhitespace(String): Boolean

Checks if the `text` contains only whitespace.

_Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example shows how `isWhitespace` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import isWhitespace from dw::core::Strings
output application/json
---
{
  "a": isWhitespace(null),
  "b": isWhitespace(""),
  "c": isWhitespace("  "),
  "d": isWhitespace("abc"),
  "e": isWhitespace("ab2c"),
  "f": isWhitespace("ab-c")
}
```

#### Output

```JSON
{
  "a": false,
  "b": true,
  "c": true,
  "d": false,
  "e": false,
  "f": false
}
```

## isWhitespace(Null): Boolean

Helper function that enables `isWhitespace` to work with a `null` value.

<!-- document id=89785c8398cf09b10313ef1ea4c6a32fd571a83d8c155639d90d8b67e797f2b8 url=/mulesoft/current/en-us/dataweave/2.4/dw-strings-functions-iswhitespace.md -->

---
product: DataWeave
version: 2.4
---

# isWhitespace

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isWhitespace(text: String): Boolean

Checks if the `text` contains only whitespace.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example shows how `isWhitespace` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import isWhitespace from dw::core::Strings
output application/json
---
{
  "a": isWhitespace(null),
  "b": isWhitespace(""),
  "c": isWhitespace("  "),
  "d": isWhitespace("abc"),
  "e": isWhitespace("ab2c"),
  "f": isWhitespace("ab-c")
}
```

#### Output

```JSON
{
  "a": false,
  "b": true,
  "c": true,
  "d": false,
  "e": false,
  "f": false
}
```

## isWhitespace(text: Null): Boolean

Helper function that enables `isWhitespace` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=d39a15bbe0518b1ae55075fd29e258b50b25ba7a7d8a5cd3fa82ca95a9738170 url=/mulesoft/current/en-us/dataweave/2.6/dw-strings-functions-iswhitespace.md -->

---
product: DataWeave
version: 2.6
---

# isWhitespace

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isWhitespace(text: String): Boolean

Checks if the `text` contains only whitespace.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example shows how `isWhitespace` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import isWhitespace from dw::core::Strings
output application/json
---
{
  "a": isWhitespace(null),
  "b": isWhitespace(""),
  "c": isWhitespace("  "),
  "d": isWhitespace("abc"),
  "e": isWhitespace("ab2c"),
  "f": isWhitespace("ab-c")
}
```

#### Output

```JSON
{
  "a": false,
  "b": true,
  "c": true,
  "d": false,
  "e": false,
  "f": false
}
```

## isWhitespace(text: Null): Boolean

Helper function that enables `isWhitespace` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=205221dafcfe6ec4467c27a4078b2918d935e22d27ba2eabeb0683f5e7e70045 url=/mulesoft/current/en-us/dataweave/2.9/dw-strings-functions-iswhitespace.md -->

---
product: DataWeave
version: 2.9
---

# isWhitespace

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isWhitespace(text: String): Boolean

Checks if the `text` contains only whitespace.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example shows how `isWhitespace` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import isWhitespace from dw::core::Strings
output application/json
---
{
  "a": isWhitespace(null),
  "b": isWhitespace(""),
  "c": isWhitespace("  "),
  "d": isWhitespace("abc"),
  "e": isWhitespace("ab2c"),
  "f": isWhitespace("ab-c")
}
```

#### Output

```JSON
{
  "a": false,
  "b": true,
  "c": true,
  "d": false,
  "e": false,
  "f": false
}
```

## isWhitespace(text: Null): Boolean

Helper function that enables `isWhitespace` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=c468e09ae78f7c1b7b4dbcb46f008b8e56331ea7d65de3312ad900d3e6ccbcb5 url=/mulesoft/current/en-us/dataweave/latest/dw-strings-functions-iswhitespace.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# isWhitespace

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## isWhitespace(text: String): Boolean

Checks if the `text` contains only whitespace.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example shows how `isWhitespace` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import isWhitespace from dw::core::Strings
output application/json
---
{
  "a": isWhitespace(null),
  "b": isWhitespace(""),
  "c": isWhitespace("  "),
  "d": isWhitespace("abc"),
  "e": isWhitespace("ab2c"),
  "f": isWhitespace("ab-c")
}
```

#### Output

```JSON
{
  "a": false,
  "b": true,
  "c": true,
  "d": false,
  "e": false,
  "f": false
}
```

## isWhitespace(text: Null): Boolean

Helper function that enables `isWhitespace` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=4f514c614c4e3553e6f423f990963fe47365499989970e35181dfacde62c393c url=/mulesoft/current/en-us/dataweave/2.11/dataweave-formats-java.md -->

---
product: DataWeave
version: 2.11
keywords: format, java, */java, application/java
---

# Java Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/java`

ID: `java`

For the Java data format, DataWeave attempts to map any Java value to a DataWeave value, most often
by matching the semantics of DataWeave and Java.

## Java Value Mapping

This table maps Java classes to DataWeave types:

<table><colgroup><col> <col></colgroup><thead><tr><th>Java Class</th><th>DataWeave</th></tr></thead><tbody><tr><td><p><code>java.lang.String</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>Enum</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>Class</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>UUID</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>CharSequence</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>Char</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>java.sql.Clob</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>java.io.Reader</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>int</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>long</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>double</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>short</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>BigInteger</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>BigDecimal</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>AtomicInteger</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>AtomicLong</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>boolean</code></p></td><td><p><code>Boolean</code></p></td></tr><tr><td><p><code>AtomicBoolean</code></p></td><td><p><code>Boolean</code></p></td></tr><tr><td><p><code>java.util.Collection</code></p></td><td><p><code>Array</code></p></td></tr><tr><td><p><code>java.lang.Iterable</code></p></td><td><p><code>Array</code></p></td></tr><tr><td><p><code>java.util.Iterator</code></p></td><td><p><code>Array</code></p></td></tr><tr><td><p><code>java.util.Map</code></p></td><td><p><code>Object</code></p></td></tr><tr><td><p><code>java.util.Optional</code></p></td><td><p><code>Null</code> or <code>Value</code></p></td></tr><tr><td><p><code>java.util.OptionalInt</code></p></td><td><p><code>Null</code> or <code>Number</code></p></td></tr><tr><td><p><code>java.util.OptionalDouble</code></p></td><td><p><code>Null</code> or <code>Number</code></p></td></tr><tr><td><p><code>java.util.OptionalLong</code></p></td><td><p><code>Null</code> or <code>Number</code></p></td></tr><tr><td><p><code>byte[]</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>java.lang.InputStream</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>java.nio.ByteBuffer</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>byte</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>java.lang.File</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>java.time.Instant</code></p></td><td><p><code>LocalDateTime</code></p></td></tr><tr><td><p><code>java.time.LocalDateTime</code></p></td><td><p><code>LocalDateTime</code></p></td></tr><tr><td><p><code>java.sql.Timestamp</code></p></td><td><p><code>LocalDateTime</code></p></td></tr><tr><td><p><code>java.sql.Date</code></p></td><td><p><code>LocalDateTime</code></p></td></tr><tr><td><p><code>java.util.Date</code></p></td><td><p><code>LocalDateTime</code></p></td></tr><tr><td><p><code>java.time.ZonedDateTime</code></p></td><td><p><code>DateTime</code></p></td></tr><tr><td><p><code>java.time.LocalTime</code></p></td><td><p><code>LocalTime</code></p></td></tr><tr><td><p><code>java.time.OffsetTime</code></p></td><td><p><code>Time</code></p></td></tr><tr><td><p><code>java.time.LocalDate</code></p></td><td><p><code>Date</code></p></td></tr><tr><td><p><code>java.time.ZoneOffset</code></p></td><td><p><code>TimeZone</code></p></td></tr><tr><td><p><code>java.util.Calendar</code></p></td><td><p><code>DateTime</code></p></td></tr><tr><td><p><code>java.util.XMLGregorianCalendar</code></p></td><td><p><code>DateTime</code></p></td></tr><tr><td><p><code>*[]</code></p></td><td><p><code>Array</code></p></td></tr></tbody></table>

> [!IMPORTANT] If a Java class isn’t present in the table, DataWeave treats it as a `JavaBean` and
> maps it as an `Object` type. In this case, DataWeave takes all properties from the Java getters.

## Metadata

DataWeave supports the `^class` metadata for the Java format.

All Java objects are associated with a class. DataWeave maintains this association by mapping the
class to a Metadata property.

`payload.^class` returns the name of the class of the `payload`.

The Java writer uses the metadata property to discover the Java class to which the DataWeave value
maps. That is, DataWeave uses the metadata property to determine which Java class is to be created
from a given DataWeave value. For example, the expression
`output application/java --- now() as DateTime {class: "java.util.Calendar"}` creates a
`java.util.Calendar`.

## Enum Custom Type

The Java format supports the `Enum` custom type. To put a Java `enum` value into a `java.util.Map`,
the DataWeave Java module defines a custom type called `Enum`. This custom type enables you to
handle a given string as the name of a specified `enum` type. You must use the `class` metadata
property when specifying the Java class name of the enum, for example:
`{gender: "Female" as Enum {class: "org.mycompany.Gender"}}`

## Handling `java.io.InputStream` Instances

Using `java.io.InputStream` instances in DataWeave, whether running DataWeave functions, calling
Java methods from DataWeave code, or writing them to an output, requires understanding how DataWeave
manages `java.io.InputStream` instances.

The Java format makes a deep copy of the `java.io.InputStream` instance. As a result, DataWeave
creates a new `java.io.InputStream` instance that can be reused later in your script while retaining
the content of the original stream.

However, if the original `java.io.InputStream` doesn’t support repeatable streams, it may get
consumed and become unusable.

To avoid unexpected behavior, always check whether your `java.io.InputStream` is repeatable before
processing it multiple times.

## Examples

The following examples show uses of the Java format.

- [Example: Access Values of Java Properties](#example1)

- [Example: Create a Customer Object](#example2)

- [Example: Use a Generic](#example3)

### Class Definitions

The Java examples use these class definitions:

- [`User`](#class_user)

- [`Customer`](#class_customer) (which extends `User`)

User class:

```java
class User {
    private String name;
    private String lastName;

    public User(){

    }

    public User(String name, String lastName){
        this.name = name;
        this.lastName = lastName;
    }

    public void setName(String name){
        this.name = name;
    }

     public void setLastName(String lastName){
        this.lastName = lastName;
    }

    public String getName(){
        return name;
    }

    public String getLastName(){
        return lastName;
    }
}
```

This class extends `User`.

Customer class:

```java
import java.util.Calendar;
class Customer extends User {
    private Calendar expirationDate;
    private User salesRepr;

    public User(){

    }

    public User(String name, String lastName,Calendar expirationDate){
        super(name,lastName);
        this.expirationDate = expirationDate;
    }

    public void setSalesRepr(User salesRepr){
        this.salesRepr = salesRepr;
    }

    public User getSalesRepr(){
        return this.salesRepr;
    }

    public void  setExpirationDate(Calendar expirationDate){
        this.expirationDate = expirationDate;
    }

    public Calendar getExpirationDate(){
        return this.expirationDate;
    }
}
```

### Example: Access Values of Java Properties

This example shows how to access the values of Java properties.

#### Input

The `User` values serves as the input payload to the DataWeave script.

```groovy
new User("Leandro", "Shokida")
```

#### Source

The DataWeave scripts transforms the input value to JSON.

```dataweave
output application/json
---
{
    a: payload.name,
    b: payload.lastName
}
```

#### Output

The output is a JSON object that contains key-value pairs. The values are the `name` and `lastName`
values from the input `User` object.

```json
{
  "a": "Leandro",
  "b": "Shokida"
}
```

### Example: Create a Customer Object

This example shows how to create an instance of a `Customer` class. The script outputs the object in
the JSON format and MIME type.

Notice that it’s not necessary to specify the class of inner properties because their class is
inferred from the parent class definition.

```dataweave
output application/json
---
{
    name: "Tomo",
    lastName: "Chibana",
    expirationDate: now(),
    salesRepr: {
        name: "Mariano",
        lastName: "de Achaval",
    }
} as Object {class: "Customer"}
```

### Example: Use a Generic

This example relies on generic support in the class name to create a `java.util.ArrayList` of `User`
objects.

Don’t use a generic to specify the class in each instance. The class is taken from the generic in
the list.

```dataweave
output application/json
---
[{
    name: "Tomo",
    lastName: "Chibana"
},
{
    name: "Ana",
    lastName: "Felissati"
},
{
    name: "Leandro",
    lastName: "Shokida"
}
] as Array {class: "java.util.ArrayList<User>"}
```

## Java Support

Starting with version 2.6, DataWeave supports Java 17. Java 17 adds restrictions in encapsulation
and reflective access that affects the
[Java Format](https://docs.mulesoft.com/dataweave/latest/dataweave-formats-java). Because DataWeave
uses Java’s reflection API to read and write Java objects, ensure that the objects your application
uses are Plain Old Java Objects (POJOs) containing:

- Default constructor

- Getters for all properties

- Setters for all properties

## Examples of Java Support

These examples run using Java 17 and
[language level 2.6](https://docs.mulesoft.com/dataweave/latest/dataweave-versioning-behavior.adoc).

- [Example: Create a Java Object Instance](#example4)

- [Example: Access the Values of Java Properties](#example5)

### Example: Create a Java Object Instance

This example shows how to create a Java object instance.

#### User Class

The Java example uses this class:

```java
public class User {
   private String name;
   private String lastName;
   public User(){
   }
   public String getName(){
       return name;
   }
   public String getLastName(){
       return lastName;
   }
}
```

#### DataWeave Script

```java
{name: "Tomo", lastName: "Chibana" } as Object {class: "User"}
```

#### Output

The expected output is an instance of the user class. Because the user class definition doesn’t have
the proper setters, the output is `IllegalAccessException`.

```java
java.lang.IllegalAccessException - class
org.mule.weave.v2.module.pojo.reader.PropertyDefinition (in module org.mule.weave.module.java) cannot access a member of class User with modifiers "private
```

### Example: Access the Values of Java Properties

This example shows how to access the values of Java properties.

#### Item Class

The Java example uses the following class:

```java
public class Item {
	private String name;
	private int quantity;

	public Item() {
	}
    public Item(String name, int quantity) {
		this.name = name;
		this.quantity = quantity;
	}
	public void setName(String name) {
		this.name = name;
	}
	public void setQuantity(int quantity) {
		this.quantity = quantity;
	}
}
```

#### Input

new Item("Pencil", 5)

#### DataWeave Script

```dataweave
output application/json
---
{
    "name": "payload.name",
    "quantity": "payload.quantity"
}
```

#### Output

The expected output is a JSON object.

```json
{
  "name": "Pencil",
  "quantity": "5"
}
```

Because the item class definition doesn’t have the proper getters, the output is
`IllegalAccessException`.

```java
java.lang.IllegalAccessException: class
org.mule.weave.v2.module.pojo.reader.PropertyDefinition (in module org.mule.weave.module.java) cannot access a member of class Item with modifiers "private"
```

### Troubleshooting Common Errors

To resolve conflicts, ensure that you:

- Update your class definitions to follow the POJOs structure (recommended).

- Use the compatibility flag `com.mulesoft.dw.java.disable_set_accessible=false` to allow accessible
  flag modification for reflection objects.

  This approach is a workaround and works for customer domain classes only. Note that the usage of
  this compatibility flag might not affect future versions.

## Configuration Properties

DataWeave supports these configuration properties for this format.

### Reader Properties

There are no reader properties for this format.

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>duplicateKeyAsArray</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Converts the values of duplicate keys in an object to a single array of values to the duplicated key.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>writeAttributes</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Converts attributes of a key into child key-value pairs of that key. The attribute key name starts with @.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports this MIME type:

- `*/java`

<!-- document id=1c7e0eac8ee40a542b7014e2d8759dbec54eb976073f8df0b8a5f3227edd0755 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-formats-java.md -->

---
product: DataWeave
version: 2.12
keywords: format, java, */java, application/java
---

# Java Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/java`

ID: `java`

For the Java data format, DataWeave attempts to map any Java value to a DataWeave value, most often
by matching the semantics of DataWeave and Java.

## Java Value Mapping

This table maps Java classes to DataWeave types:

<table><colgroup><col> <col></colgroup><thead><tr><th>Java Class</th><th>DataWeave</th></tr></thead><tbody><tr><td><p><code>java.lang.String</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>Enum</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>Class</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>UUID</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>CharSequence</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>Char</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>java.sql.Clob</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>java.io.Reader</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>int</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>long</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>double</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>short</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>BigInteger</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>BigDecimal</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>AtomicInteger</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>AtomicLong</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>boolean</code></p></td><td><p><code>Boolean</code></p></td></tr><tr><td><p><code>AtomicBoolean</code></p></td><td><p><code>Boolean</code></p></td></tr><tr><td><p><code>java.util.Collection</code></p></td><td><p><code>Array</code></p></td></tr><tr><td><p><code>java.lang.Iterable</code></p></td><td><p><code>Array</code></p></td></tr><tr><td><p><code>java.util.Iterator</code></p></td><td><p><code>Array</code></p></td></tr><tr><td><p><code>java.util.Map</code></p></td><td><p><code>Object</code></p></td></tr><tr><td><p><code>java.util.Optional</code></p></td><td><p><code>Null</code> or <code>Value</code></p></td></tr><tr><td><p><code>java.util.OptionalInt</code></p></td><td><p><code>Null</code> or <code>Number</code></p></td></tr><tr><td><p><code>java.util.OptionalDouble</code></p></td><td><p><code>Null</code> or <code>Number</code></p></td></tr><tr><td><p><code>java.util.OptionalLong</code></p></td><td><p><code>Null</code> or <code>Number</code></p></td></tr><tr><td><p><code>byte[]</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>java.lang.InputStream</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>java.nio.ByteBuffer</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>byte</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>java.lang.File</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>java.time.Instant</code></p></td><td><p><code>LocalDateTime</code></p></td></tr><tr><td><p><code>java.time.LocalDateTime</code></p></td><td><p><code>LocalDateTime</code></p></td></tr><tr><td><p><code>java.sql.Timestamp</code></p></td><td><p><code>LocalDateTime</code></p></td></tr><tr><td><p><code>java.sql.Date</code></p></td><td><p><code>LocalDateTime</code></p></td></tr><tr><td><p><code>java.util.Date</code></p></td><td><p><code>LocalDateTime</code></p></td></tr><tr><td><p><code>java.time.ZonedDateTime</code></p></td><td><p><code>DateTime</code></p></td></tr><tr><td><p><code>java.time.LocalTime</code></p></td><td><p><code>LocalTime</code></p></td></tr><tr><td><p><code>java.time.OffsetTime</code></p></td><td><p><code>Time</code></p></td></tr><tr><td><p><code>java.time.LocalDate</code></p></td><td><p><code>Date</code></p></td></tr><tr><td><p><code>java.time.ZoneOffset</code></p></td><td><p><code>TimeZone</code></p></td></tr><tr><td><p><code>java.util.Calendar</code></p></td><td><p><code>DateTime</code></p></td></tr><tr><td><p><code>java.util.XMLGregorianCalendar</code></p></td><td><p><code>DateTime</code></p></td></tr><tr><td><p><code>*[]</code></p></td><td><p><code>Array</code></p></td></tr></tbody></table>

> [!IMPORTANT] If a Java class isn’t present in the table, DataWeave treats it as a `JavaBean` and
> maps it as an `Object` type. In this case, DataWeave takes all properties from the Java getters.

## Metadata

DataWeave supports the `^class` metadata for the Java format.

All Java objects are associated with a class. DataWeave maintains this association by mapping the
class to a Metadata property.

`payload.^class` returns the name of the class of the `payload`.

The Java writer uses the metadata property to discover the Java class to which the DataWeave value
maps. That is, DataWeave uses the metadata property to determine which Java class is to be created
from a given DataWeave value. For example, the expression
`output application/java --- now() as DateTime {class: "java.util.Calendar"}` creates a
`java.util.Calendar`.

## Enum Custom Type

The Java format supports the `Enum` custom type. To put a Java `enum` value into a `java.util.Map`,
the DataWeave Java module defines a custom type called `Enum`. This custom type enables you to
handle a given string as the name of a specified `enum` type. You must use the `class` metadata
property when specifying the Java class name of the enum, for example:
`{gender: "Female" as Enum {class: "org.mycompany.Gender"}}`

## Handling `java.io.InputStream` Instances

Using `java.io.InputStream` instances in DataWeave, whether running DataWeave functions, calling
Java methods from DataWeave code, or writing them to an output, requires understanding how DataWeave
manages `java.io.InputStream` instances.

The Java format makes a deep copy of the `java.io.InputStream` instance. As a result, DataWeave
creates a new `java.io.InputStream` instance that can be reused later in your script while retaining
the content of the original stream.

However, if the original `java.io.InputStream` doesn’t support repeatable streams, it may get
consumed and become unusable.

To avoid unexpected behavior, always check whether your `java.io.InputStream` is repeatable before
processing it multiple times.

## Examples

The following examples show uses of the Java format.

- [Example: Access Values of Java Properties](#example1)

- [Example: Create a Customer Object](#example2)

- [Example: Use a Generic](#example3)

### Class Definitions

The Java examples use these class definitions:

- [`User`](#class_user)

- [`Customer`](#class_customer) (which extends `User`)

User class:

```java
class User {
    private String name;
    private String lastName;

    public User(){

    }

    public User(String name, String lastName){
        this.name = name;
        this.lastName = lastName;
    }

    public void setName(String name){
        this.name = name;
    }

     public void setLastName(String lastName){
        this.lastName = lastName;
    }

    public String getName(){
        return name;
    }

    public String getLastName(){
        return lastName;
    }
}
```

This class extends `User`.

Customer class:

```java
import java.util.Calendar;
class Customer extends User {
    private Calendar expirationDate;
    private User salesRepr;

    public User(){

    }

    public User(String name, String lastName,Calendar expirationDate){
        super(name,lastName);
        this.expirationDate = expirationDate;
    }

    public void setSalesRepr(User salesRepr){
        this.salesRepr = salesRepr;
    }

    public User getSalesRepr(){
        return this.salesRepr;
    }

    public void  setExpirationDate(Calendar expirationDate){
        this.expirationDate = expirationDate;
    }

    public Calendar getExpirationDate(){
        return this.expirationDate;
    }
}
```

### Example: Access Values of Java Properties

This example shows how to access the values of Java properties.

#### Input

The `User` values serves as the input payload to the DataWeave script.

```groovy
new User("Leandro", "Shokida")
```

#### Source

The DataWeave scripts transforms the input value to JSON.

```dataweave
output application/json
---
{
    a: payload.name,
    b: payload.lastName
}
```

#### Output

The output is a JSON object that contains key-value pairs. The values are the `name` and `lastName`
values from the input `User` object.

```json
{
  "a": "Leandro",
  "b": "Shokida"
}
```

### Example: Create a Customer Object

This example shows how to create an instance of a `Customer` class. The script outputs the object in
the JSON format and MIME type.

Notice that it’s not necessary to specify the class of inner properties because their class is
inferred from the parent class definition.

```dataweave
output application/json
---
{
    name: "Tomo",
    lastName: "Chibana",
    expirationDate: now(),
    salesRepr: {
        name: "Mariano",
        lastName: "de Achaval",
    }
} as Object {class: "Customer"}
```

### Example: Use a Generic

This example relies on generic support in the class name to create a `java.util.ArrayList` of `User`
objects.

Don’t use a generic to specify the class in each instance. The class is taken from the generic in
the list.

```dataweave
output application/json
---
[{
    name: "Tomo",
    lastName: "Chibana"
},
{
    name: "Ana",
    lastName: "Felissati"
},
{
    name: "Leandro",
    lastName: "Shokida"
}
] as Array {class: "java.util.ArrayList<User>"}
```

## Java Support

Starting with version 2.6, DataWeave supports Java 17. Java 17 adds restrictions in encapsulation
and reflective access that affects the
[Java Format](https://docs.mulesoft.com/dataweave/latest/dataweave-formats-java). Because DataWeave
uses Java’s reflection API to read and write Java objects, ensure that the objects your application
uses are Plain Old Java Objects (POJOs) containing:

- Default constructor

- Getters for all properties

- Setters for all properties

## Examples of Java Support

These examples run using Java 17 and
[language level 2.6](https://docs.mulesoft.com/dataweave/latest/dataweave-versioning-behavior.adoc).

- [Example: Create a Java Object Instance](#example4)

- [Example: Access the Values of Java Properties](#example5)

### Example: Create a Java Object Instance

This example shows how to create a Java object instance.

#### User Class

The Java example uses this class:

```java
public class User {
   private String name;
   private String lastName;
   public User(){
   }
   public String getName(){
       return name;
   }
   public String getLastName(){
       return lastName;
   }
}
```

#### DataWeave Script

```java
{name: "Tomo", lastName: "Chibana" } as Object {class: "User"}
```

#### Output

The expected output is an instance of the user class. Because the user class definition doesn’t have
the proper setters, the output is `IllegalAccessException`.

```java
java.lang.IllegalAccessException - class
org.mule.weave.v2.module.pojo.reader.PropertyDefinition (in module org.mule.weave.module.java) cannot access a member of class User with modifiers "private
```

### Example: Access the Values of Java Properties

This example shows how to access the values of Java properties.

#### Item Class

The Java example uses the following class:

```java
public class Item {
	private String name;
	private int quantity;

	public Item() {
	}
    public Item(String name, int quantity) {
		this.name = name;
		this.quantity = quantity;
	}
	public void setName(String name) {
		this.name = name;
	}
	public void setQuantity(int quantity) {
		this.quantity = quantity;
	}
}
```

#### Input

new Item("Pencil", 5)

#### DataWeave Script

```dataweave
output application/json
---
{
    "name": "payload.name",
    "quantity": "payload.quantity"
}
```

#### Output

The expected output is a JSON object.

```json
{
  "name": "Pencil",
  "quantity": "5"
}
```

Because the item class definition doesn’t have the proper getters, the output is
`IllegalAccessException`.

```java
java.lang.IllegalAccessException: class
org.mule.weave.v2.module.pojo.reader.PropertyDefinition (in module org.mule.weave.module.java) cannot access a member of class Item with modifiers "private"
```

### Troubleshooting Common Errors

To resolve conflicts, ensure that you:

- Update your class definitions to follow the POJOs structure (recommended).

- Use the compatibility flag `com.mulesoft.dw.java.disable_set_accessible=false` to allow accessible
  flag modification for reflection objects.

  This approach is a workaround and works for customer domain classes only. Note that the usage of
  this compatibility flag might not affect future versions.

## Configuration Properties

DataWeave supports these configuration properties for this format.

### Reader Properties

There are no reader properties for this format.

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>duplicateKeyAsArray</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Converts the values of duplicate keys in an object to a single array of values to the duplicated key.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>writeAttributes</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Converts attributes of a key into child key-value pairs of that key. The attribute key name starts with @.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports this MIME type:

- `*/java`

<!-- document id=cf8a260acf73c7a248584b147a5c0a74c93ddbe32025f839fc422b48afca5bab url=/mulesoft/current/en-us/dataweave/2.3/dataweave-formats-java.md -->

---
product: DataWeave
version: 2.3
---

# Java Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME Type: `application/java`

ID: `java`

For the Java data format, DataWeave attempts to map any Java value to a DataWeave value, most often
by matching the semantics of DataWeave and Java.

## Java Value Mapping

The following table maps Java classes to DataWeave types.

<table><colgroup><col> <col></colgroup><thead><tr><th>Java Class</th><th>DataWeave</th></tr></thead><tbody><tr><td><p><code>java.lang.String</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>Enum</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>Class</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>UUID</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>CharSequence</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>Char</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>java.sql.Clob</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>java.io.Reader</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>int</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>long</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>double</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>short</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>BigInteger</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>BigDecimal</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>AtomicInteger</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>AtomicLong</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>boolean</code></p></td><td><p><code>Boolean</code></p></td></tr><tr><td><p><code>AtomicBoolean</code></p></td><td><p><code>Boolean</code></p></td></tr><tr><td><p><code>java.util.Collection</code></p></td><td><p><code>Array</code></p></td></tr><tr><td><p><code>java.lang.Iterable</code></p></td><td><p><code>Array</code></p></td></tr><tr><td><p><code>java.util.Iterator</code></p></td><td><p><code>Array</code></p></td></tr><tr><td><p><code>java.util.Map</code></p></td><td><p><code>Object</code></p></td></tr><tr><td><p><code>java.util.Optional</code></p></td><td><p><code>Null</code> or <code>Value</code></p></td></tr><tr><td><p><code>byte[]</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>java.lang.InputStream</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>byte</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>java.lang.File</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>java.time.LocalDateTime</code></p></td><td><p><code>LocalDateTime</code></p></td></tr><tr><td><p><code>java.sql.Timestamp</code></p></td><td><p><code>LocalDateTime</code></p></td></tr><tr><td><p><code>java.sql.Date</code></p></td><td><p><code>LocalDateTime</code></p></td></tr><tr><td><p><code>java.time.ZonedDateTime</code></p></td><td><p><code>DateTime</code></p></td></tr><tr><td><p><code>java.time.LocalTime</code></p></td><td><p><code>LocalTime</code></p></td></tr><tr><td><p><code>java.time.OffsetTime</code></p></td><td><p><code>Time</code></p></td></tr><tr><td><p><code>java.time.LocalDate</code></p></td><td><p><code>Date</code></p></td></tr><tr><td><p><code>java.time.ZoneOffset</code></p></td><td><p><code>TimeZone</code></p></td></tr><tr><td><p><code>java.util.Calendar</code></p></td><td><p><code>DateTime</code></p></td></tr><tr><td><p><code>java.util.XMLGregorianCalendar</code></p></td><td><p><code>DateTime</code></p></td></tr><tr><td><p><code>*[]</code></p></td><td><p><code>Array</code></p></td></tr></tbody></table>

> [!IMPORTANT] If a Java class is not in present in the table, DataWeave treats it as a `JavaBean`
> and maps it as an `Object` type. In this case, DataWeave takes all properties from the Java
> getters.

## Metadata

DataWeave supports the `^class` metadata for the Java format.

All Java objects are associated with a class. DataWeave maintains this association by mapping the
class to a Metadata property.

`payload.^class` returns the name of the class of the `payload`.

The Java writer uses the metadata property to discover the Java class to which the DataWeave value
maps. That is, DataWeave uses the metadata property to determine which Java class is to be created
from a given DataWeave value. For example, the expression
`output application/java --- now() as DateTime {class: "java.util.Calendar"}` creates a
`java.util.Calendar`.

## Enum Custom Type

The Java format supports the `Enum` custom type. To put a Java `enum` value into a `java.util.Map`,
the DataWeave Java module defines a custom type called `Enum`. This custom type enables you to
handle a given string as the name of a specified `enum` type. You must use the `class` metadata
property when specifying the Java class name of the enum, for example:
`{gender: "Female" as Enum {class: "org.mycompany.Gender"}}`

## Examples

The following examples show uses of the Java format.

- [Example: Access Values of Java Properties](#example1)

- [Example: Create a Customer Object](#example2)

- [Example: Use a Generic](#example3)

### Class Definitions

The Java examples use the following class definitions:

- [`User`](#class_user)

- [`Customer`](#class_customer) (which extends `User`)

User class:

```java
class User {
    private String name;
    private String lastName;

    public User(){

    }

    public User(String name, String lastName){
        this.name = name;
        this.lastName = lastName;
    }

    public void setName(String name){
        this.name = name;
    }

     public void setLastName(String lastName){
        this.lastName = lastName;
    }

    public String getName(){
        return name;
    }

    public String getLastName(){
        return lastName;
    }
}
```

The following class extends `User`.

Customer class:

```java
import java.util.Calendar;
class Customer extends User {
    private Calendar expirationDate;
    private User salesRepr;

    public User(){

    }

    public User(String name, String lastName,Calendar expirationDate){
        super(name,lastName);
        this.expirationDate = expirationDate;
    }

    public void setSalesRepr(User salesRepr){
        this.salesRepr = salesRepr;
    }

    public User getSalesRepr(){
        return this.salesRepr;
    }

    public void  setExpirationDate(Calendar expirationDate){
        this.expirationDate = expirationDate;
    }

    public Calendar getExpirationDate(){
        return this.expirationDate;
    }
}
```

### Example: Access Values of Java Properties

This example shows how to access the values of Java properties.

#### Input

The `User` values serves as the input payload to the DataWeave script.

```groovy
new User("Leandro", "Shokida")
```

#### Source

The DataWeave scripts transforms the input value to JSON.

```dataweave
output application/json
---
{
    a: payload.name,
    b: payload.lastName
}
```

#### Output

The output is a JSON object that contains key-value pairs. The values are the `name` and `lastName`
values from the input `User` object.

```json
{
  "a": "Leandro",
  "b": "Shokida"
}
```

### Example: Create a Customer Object

This example shows how to create an instance of a `Customer` class. The script outputs the object in
the JSON format and MIME type.

Notice that it is not necessary to specify the class of inner properties because their class is
inferred from the parent class definition.

```dataweave
output application/json
---
{
    name: "Tomo",
    lastName: "Chibana",
    expirationDate: now(),
    salesRepr: {
        name: "Mariano",
        lastName: "de Achaval",
    }
} as Object {class: "Customer"}
```

### Example: Use a Generic

This example relies on generic support in the class name to create a `java.util.ArrayList` of `User`
objects.

Note that you do not need to use a generic to specify the class in each instance. The class is taken
from the generic in the list.

```dataweave
output application/json
---
[{
    name: "Tomo",
    lastName: "Chibana"
},
{
    name: "Ana",
    lastName: "Felissati"
},
{
    name: "Leandro",
    lastName: "Shokida"
}
] as Array {class: "java.util.ArrayList<User>"}
```

## Configuration Properties

DataWeave supports the following configuration properties for the Java format.

### Reader Properties

There are no reader properties for Java data.

### Writer Properties

The Java format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>duplicateKeyAsArray</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>If duplicate keys are detected in an object, the writer will change the value to an array with all those values. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>writeAttributes</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Indicates whether to add attributes of a key to children of the key. The new attribute key name will start with @. Valid options are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

The Java format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/java</code></p></td></tr></tbody></table>

## See Also

- [Call Java Methods with DataWeave](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-java-methods)

<!-- document id=1b13fa41c7caac622fc5f63b3df4320c6dff4b86527fc04d051f4ea82cbbbfc1 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-formats-java.md -->

---
product: DataWeave
version: 2.4
keywords: format, java, */java, application/java
---

# Java Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/java`

ID: `java`

For the Java data format, DataWeave attempts to map any Java value to a DataWeave value, most often
by matching the semantics of DataWeave and Java.

## Java Value Mapping

The following table maps Java classes to DataWeave types.

<table><colgroup><col> <col></colgroup><thead><tr><th>Java Class</th><th>DataWeave</th></tr></thead><tbody><tr><td><p><code>java.lang.String</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>Enum</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>Class</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>UUID</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>CharSequence</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>Char</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>java.sql.Clob</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>java.io.Reader</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>int</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>long</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>double</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>short</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>BigInteger</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>BigDecimal</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>AtomicInteger</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>AtomicLong</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>boolean</code></p></td><td><p><code>Boolean</code></p></td></tr><tr><td><p><code>AtomicBoolean</code></p></td><td><p><code>Boolean</code></p></td></tr><tr><td><p><code>java.util.Collection</code></p></td><td><p><code>Array</code></p></td></tr><tr><td><p><code>java.lang.Iterable</code></p></td><td><p><code>Array</code></p></td></tr><tr><td><p><code>java.util.Iterator</code></p></td><td><p><code>Array</code></p></td></tr><tr><td><p><code>java.util.Map</code></p></td><td><p><code>Object</code></p></td></tr><tr><td><p><code>java.util.Optional</code></p></td><td><p><code>Null</code> or <code>Value</code></p></td></tr><tr><td><p><code>java.util.OptionalInt</code></p></td><td><p><code>Null</code> or <code>Number</code></p></td></tr><tr><td><p><code>java.util.OptionalDouble</code></p></td><td><p><code>Null</code> or <code>Number</code></p></td></tr><tr><td><p><code>java.util.OptionalLong</code></p></td><td><p><code>Null</code> or <code>Number</code></p></td></tr><tr><td><p><code>byte[]</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>java.lang.InputStream</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>java.nio.ByteBuffer</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>byte</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>java.lang.File</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>java.time.Instant</code></p></td><td><p><code>LocalDateTime</code></p></td></tr><tr><td><p><code>java.time.LocalDateTime</code></p></td><td><p><code>LocalDateTime</code></p></td></tr><tr><td><p><code>java.sql.Timestamp</code></p></td><td><p><code>LocalDateTime</code></p></td></tr><tr><td><p><code>java.sql.Date</code></p></td><td><p><code>LocalDateTime</code></p></td></tr><tr><td><p><code>java.util.Date</code></p></td><td><p><code>LocalDateTime</code></p></td></tr><tr><td><p><code>java.time.ZonedDateTime</code></p></td><td><p><code>DateTime</code></p></td></tr><tr><td><p><code>java.time.LocalTime</code></p></td><td><p><code>LocalTime</code></p></td></tr><tr><td><p><code>java.time.OffsetTime</code></p></td><td><p><code>Time</code></p></td></tr><tr><td><p><code>java.time.LocalDate</code></p></td><td><p><code>Date</code></p></td></tr><tr><td><p><code>java.time.ZoneOffset</code></p></td><td><p><code>TimeZone</code></p></td></tr><tr><td><p><code>java.util.Calendar</code></p></td><td><p><code>DateTime</code></p></td></tr><tr><td><p><code>java.util.XMLGregorianCalendar</code></p></td><td><p><code>DateTime</code></p></td></tr><tr><td><p><code>*[]</code></p></td><td><p><code>Array</code></p></td></tr></tbody></table>

> [!IMPORTANT] If a Java class is not in present in the table, DataWeave treats it as a `JavaBean`
> and maps it as an `Object` type. In this case, DataWeave takes all properties from the Java
> getters.

## Metadata

DataWeave supports the `^class` metadata for the Java format.

All Java objects are associated with a class. DataWeave maintains this association by mapping the
class to a Metadata property.

`payload.^class` returns the name of the class of the `payload`.

The Java writer uses the metadata property to discover the Java class to which the DataWeave value
maps. That is, DataWeave uses the metadata property to determine which Java class is to be created
from a given DataWeave value. For example, the expression
`output application/java --- now() as DateTime {class: "java.util.Calendar"}` creates a
`java.util.Calendar`.

## Enum Custom Type

The Java format supports the `Enum` custom type. To put a Java `enum` value into a `java.util.Map`,
the DataWeave Java module defines a custom type called `Enum`. This custom type enables you to
handle a given string as the name of a specified `enum` type. You must use the `class` metadata
property when specifying the Java class name of the enum, for example:
`{gender: "Female" as Enum {class: "org.mycompany.Gender"}}`

## Examples

The following examples show uses of the Java format.

- [Example: Access Values of Java Properties](#example1)

- [Example: Create a Customer Object](#example2)

- [Example: Use a Generic](#example3)

### Class Definitions

The Java examples use the following class definitions:

- [`User`](#class_user)

- [`Customer`](#class_customer) (which extends `User`)

User class:

```java
class User {
    private String name;
    private String lastName;

    public User(){

    }

    public User(String name, String lastName){
        this.name = name;
        this.lastName = lastName;
    }

    public void setName(String name){
        this.name = name;
    }

     public void setLastName(String lastName){
        this.lastName = lastName;
    }

    public String getName(){
        return name;
    }

    public String getLastName(){
        return lastName;
    }
}
```

The following class extends `User`.

Customer class:

```java
import java.util.Calendar;
class Customer extends User {
    private Calendar expirationDate;
    private User salesRepr;

    public User(){

    }

    public User(String name, String lastName,Calendar expirationDate){
        super(name,lastName);
        this.expirationDate = expirationDate;
    }

    public void setSalesRepr(User salesRepr){
        this.salesRepr = salesRepr;
    }

    public User getSalesRepr(){
        return this.salesRepr;
    }

    public void  setExpirationDate(Calendar expirationDate){
        this.expirationDate = expirationDate;
    }

    public Calendar getExpirationDate(){
        return this.expirationDate;
    }
}
```

### Example: Access Values of Java Properties

This example shows how to access the values of Java properties.

#### Input

The `User` values serves as the input payload to the DataWeave script.

```groovy
new User("Leandro", "Shokida")
```

#### Source

The DataWeave scripts transforms the input value to JSON.

```dataweave
output application/json
---
{
    a: payload.name,
    b: payload.lastName
}
```

#### Output

The output is a JSON object that contains key-value pairs. The values are the `name` and `lastName`
values from the input `User` object.

```json
{
  "a": "Leandro",
  "b": "Shokida"
}
```

### Example: Create a Customer Object

This example shows how to create an instance of a `Customer` class. The script outputs the object in
the JSON format and MIME type.

Notice that it is not necessary to specify the class of inner properties because their class is
inferred from the parent class definition.

```dataweave
output application/json
---
{
    name: "Tomo",
    lastName: "Chibana",
    expirationDate: now(),
    salesRepr: {
        name: "Mariano",
        lastName: "de Achaval",
    }
} as Object {class: "Customer"}
```

### Example: Use a Generic

This example relies on generic support in the class name to create a `java.util.ArrayList` of `User`
objects.

Note that you do not need to use a generic to specify the class in each instance. The class is taken
from the generic in the list.

```dataweave
output application/json
---
[{
    name: "Tomo",
    lastName: "Chibana"
},
{
    name: "Ana",
    lastName: "Felissati"
},
{
    name: "Leandro",
    lastName: "Shokida"
}
] as Array {class: "java.util.ArrayList<User>"}
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

There are no reader properties for this format.

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>duplicateKeyAsArray</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Converts the values of duplicate keys in an object to a single array of values to the duplicated key.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>writeAttributes</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Converts attributes of a key into child key-value pairs of that key. The attribute key name starts with @.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/java</code></p></td></tr></tbody></table>

<!-- document id=5627fdc9becf8e3a4eb4ad65902687a174b80b42add0a5064498e7546a2c9ecf url=/mulesoft/current/en-us/dataweave/2.6/dataweave-formats-java.md -->

---
product: DataWeave
version: 2.6
keywords: format, java, */java, application/java
---

# Java Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/java`

ID: `java`

For the Java data format, DataWeave attempts to map any Java value to a DataWeave value, most often
by matching the semantics of DataWeave and Java.

## Java Value Mapping

The following table maps Java classes to DataWeave types.

<table><colgroup><col> <col></colgroup><thead><tr><th>Java Class</th><th>DataWeave</th></tr></thead><tbody><tr><td><p><code>java.lang.String</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>Enum</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>Class</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>UUID</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>CharSequence</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>Char</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>java.sql.Clob</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>java.io.Reader</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>int</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>long</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>double</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>short</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>BigInteger</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>BigDecimal</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>AtomicInteger</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>AtomicLong</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>boolean</code></p></td><td><p><code>Boolean</code></p></td></tr><tr><td><p><code>AtomicBoolean</code></p></td><td><p><code>Boolean</code></p></td></tr><tr><td><p><code>java.util.Collection</code></p></td><td><p><code>Array</code></p></td></tr><tr><td><p><code>java.lang.Iterable</code></p></td><td><p><code>Array</code></p></td></tr><tr><td><p><code>java.util.Iterator</code></p></td><td><p><code>Array</code></p></td></tr><tr><td><p><code>java.util.Map</code></p></td><td><p><code>Object</code></p></td></tr><tr><td><p><code>java.util.Optional</code></p></td><td><p><code>Null</code> or <code>Value</code></p></td></tr><tr><td><p><code>java.util.OptionalInt</code></p></td><td><p><code>Null</code> or <code>Number</code></p></td></tr><tr><td><p><code>java.util.OptionalDouble</code></p></td><td><p><code>Null</code> or <code>Number</code></p></td></tr><tr><td><p><code>java.util.OptionalLong</code></p></td><td><p><code>Null</code> or <code>Number</code></p></td></tr><tr><td><p><code>byte[]</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>java.lang.InputStream</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>java.nio.ByteBuffer</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>byte</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>java.lang.File</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>java.time.Instant</code></p></td><td><p><code>LocalDateTime</code></p></td></tr><tr><td><p><code>java.time.LocalDateTime</code></p></td><td><p><code>LocalDateTime</code></p></td></tr><tr><td><p><code>java.sql.Timestamp</code></p></td><td><p><code>LocalDateTime</code></p></td></tr><tr><td><p><code>java.sql.Date</code></p></td><td><p><code>LocalDateTime</code></p></td></tr><tr><td><p><code>java.util.Date</code></p></td><td><p><code>LocalDateTime</code></p></td></tr><tr><td><p><code>java.time.ZonedDateTime</code></p></td><td><p><code>DateTime</code></p></td></tr><tr><td><p><code>java.time.LocalTime</code></p></td><td><p><code>LocalTime</code></p></td></tr><tr><td><p><code>java.time.OffsetTime</code></p></td><td><p><code>Time</code></p></td></tr><tr><td><p><code>java.time.LocalDate</code></p></td><td><p><code>Date</code></p></td></tr><tr><td><p><code>java.time.ZoneOffset</code></p></td><td><p><code>TimeZone</code></p></td></tr><tr><td><p><code>java.util.Calendar</code></p></td><td><p><code>DateTime</code></p></td></tr><tr><td><p><code>java.util.XMLGregorianCalendar</code></p></td><td><p><code>DateTime</code></p></td></tr><tr><td><p><code>*[]</code></p></td><td><p><code>Array</code></p></td></tr></tbody></table>

> [!IMPORTANT] If a Java class is not in present in the table, DataWeave treats it as a `JavaBean`
> and maps it as an `Object` type. In this case, DataWeave takes all properties from the Java
> getters.

## Metadata

DataWeave supports the `^class` metadata for the Java format.

All Java objects are associated with a class. DataWeave maintains this association by mapping the
class to a Metadata property.

`payload.^class` returns the name of the class of the `payload`.

The Java writer uses the metadata property to discover the Java class to which the DataWeave value
maps. That is, DataWeave uses the metadata property to determine which Java class is to be created
from a given DataWeave value. For example, the expression
`output application/java --- now() as DateTime {class: "java.util.Calendar"}` creates a
`java.util.Calendar`.

## Enum Custom Type

The Java format supports the `Enum` custom type. To put a Java `enum` value into a `java.util.Map`,
the DataWeave Java module defines a custom type called `Enum`. This custom type enables you to
handle a given string as the name of a specified `enum` type. You must use the `class` metadata
property when specifying the Java class name of the enum, for example:
`{gender: "Female" as Enum {class: "org.mycompany.Gender"}}`

## Handling `java.io.InputStream` Instances

Using `java.io.InputStream` instances in DataWeave, whether running DataWeave functions, calling
Java methods from DataWeave code, or writing them to an output, requires understanding how DataWeave
manages `java.io.InputStream` instances.

The Java format makes a deep copy of the `java.io.InputStream` instance. As a result, DataWeave
creates a new `java.io.InputStream` instance that can be reused later in your script while retaining
the content of the original stream.

However, if the original `java.io.InputStream` doesn’t support repeatable streams, it may get
consumed and become unusable.

To avoid unexpected behavior, always check whether your `java.io.InputStream` is repeatable before
processing it multiple times.

## Examples

The following examples show uses of the Java format.

- [Example: Access Values of Java Properties](#example1)

- [Example: Create a Customer Object](#example2)

- [Example: Use a Generic](#example3)

### Class Definitions

The Java examples use the following class definitions:

- [`User`](#class_user)

- [`Customer`](#class_customer) (which extends `User`)

User class:

```java
class User {
    private String name;
    private String lastName;

    public User(){

    }

    public User(String name, String lastName){
        this.name = name;
        this.lastName = lastName;
    }

    public void setName(String name){
        this.name = name;
    }

     public void setLastName(String lastName){
        this.lastName = lastName;
    }

    public String getName(){
        return name;
    }

    public String getLastName(){
        return lastName;
    }
}
```

The following class extends `User`.

Customer class:

```java
import java.util.Calendar;
class Customer extends User {
    private Calendar expirationDate;
    private User salesRepr;

    public User(){

    }

    public User(String name, String lastName,Calendar expirationDate){
        super(name,lastName);
        this.expirationDate = expirationDate;
    }

    public void setSalesRepr(User salesRepr){
        this.salesRepr = salesRepr;
    }

    public User getSalesRepr(){
        return this.salesRepr;
    }

    public void  setExpirationDate(Calendar expirationDate){
        this.expirationDate = expirationDate;
    }

    public Calendar getExpirationDate(){
        return this.expirationDate;
    }
}
```

### Example: Access Values of Java Properties

This example shows how to access the values of Java properties.

#### Input

The `User` values serves as the input payload to the DataWeave script.

```groovy
new User("Leandro", "Shokida")
```

#### Source

The DataWeave scripts transforms the input value to JSON.

```dataweave
output application/json
---
{
    a: payload.name,
    b: payload.lastName
}
```

#### Output

The output is a JSON object that contains key-value pairs. The values are the `name` and `lastName`
values from the input `User` object.

```json
{
  "a": "Leandro",
  "b": "Shokida"
}
```

### Example: Create a Customer Object

This example shows how to create an instance of a `Customer` class. The script outputs the object in
the JSON format and MIME type.

Notice that it is not necessary to specify the class of inner properties because their class is
inferred from the parent class definition.

```dataweave
output application/json
---
{
    name: "Tomo",
    lastName: "Chibana",
    expirationDate: now(),
    salesRepr: {
        name: "Mariano",
        lastName: "de Achaval",
    }
} as Object {class: "Customer"}
```

### Example: Use a Generic

This example relies on generic support in the class name to create a `java.util.ArrayList` of `User`
objects.

Note that you do not need to use a generic to specify the class in each instance. The class is taken
from the generic in the list.

```dataweave
output application/json
---
[{
    name: "Tomo",
    lastName: "Chibana"
},
{
    name: "Ana",
    lastName: "Felissati"
},
{
    name: "Leandro",
    lastName: "Shokida"
}
] as Array {class: "java.util.ArrayList<User>"}
```

## Java Support

Starting with version 2.6, DataWeave supports Java 17. Java 17 adds restrictions in encapsulation
and reflective access that affects the
[Java Format](https://docs.mulesoft.com/dataweave/latest/dataweave-formats-java). Because DataWeave
uses Java’s reflection API to read and write Java objects, ensure that the objects your application
uses are Plain Old Java Objects (POJOs) containing:

- Default constructor

- Getters for all properties

- Setters for all properties

## Examples of Java Support

The following examples run using Java 17 and
[language level 2.6](https://docs.mulesoft.com/dataweave/2.6/dataweave-versioning-behavior).

- [Example: Create a Java Object Instance](#example4)

- [Example: Access the Values of Java Properties](#example5)

### Example: Create a Java Object Instance

This example shows how to create a Java object instance.

#### User Class

The Java example uses the following class:

```java
public class User {
   private String name;
   private String lastName;
   public User(){
   }
   public String getName(){
       return name;
   }
   public String getLastName(){
       return lastName;
   }
}
```

#### DataWeave Script

```java
{name: "Tomo", lastName: "Chibana" } as Object {class: "User"}
```

#### Output

The expected output is an instance of the user class. Because the user class definition doesn’t have
the proper setters, the output is `IllegalAccessException`.

```java
java.lang.IllegalAccessException - class
org.mule.weave.v2.module.pojo.reader.PropertyDefinition (in module org.mule.weave.module.java) cannot access a member of class User with modifiers "private
```

### Example: Access the Values of Java Properties

This example shows how to access the values of Java properties.

#### Item Class

The Java example uses the following class:

```java
public class Item {
	private String name;
	private int quantity;

	public Item() {
	}
    public Item(String name, int quantity) {
		this.name = name;
		this.quantity = quantity;
	}
	public void setName(String name) {
		this.name = name;
	}
	public void setQuantity(int quantity) {
		this.quantity = quantity;
	}
}
```

#### Input

new Item("Pencil", 5)

#### DataWeave Script

```dataweave
output application/json
---
{
    "name": "payload.name",
    "quantity": "payload.quantity"
}
```

#### Output

The expected output is a JSON object.

```json
{
  "name": "Pencil",
  "quantity": "5"
}
```

Because the item class definition doesn’t have the proper getters, the output is
`IllegalAccessException`.

```java
java.lang.IllegalAccessException: class
org.mule.weave.v2.module.pojo.reader.PropertyDefinition (in module org.mule.weave.module.java) cannot access a member of class Item with modifiers "private"
```

### Troubleshooting Common Errors

To resolve conflicts, ensure that you:

- Update your class definitions to follow the POJOs structure (recommended).

- Use the compatibility flag `com.mulesoft.dw.java.disable_set_accessible=false` to allow accessible
  flag modification for reflection objects.

  This approach is a workaround and works for customer domain classes only. Note that the usage of
  this compatibility flag might not affect future versions.

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

There are no reader properties for this format.

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>duplicateKeyAsArray</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Converts the values of duplicate keys in an object to a single array of values to the duplicated key.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>writeAttributes</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Converts attributes of a key into child key-value pairs of that key. The attribute key name starts with @.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/java</code></p></td></tr></tbody></table>

<!-- document id=14200514276cfb561a121683ee3614458ab57f382bf051eabe5a1f2cc0eccc1e url=/mulesoft/current/en-us/dataweave/2.9/dataweave-formats-java.md -->

---
product: DataWeave
version: 2.9
keywords: format, java, */java, application/java
---

# Java Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/java`

ID: `java`

For the Java data format, DataWeave attempts to map any Java value to a DataWeave value, most often
by matching the semantics of DataWeave and Java.

## Java Value Mapping

The following table maps Java classes to DataWeave types.

<table><colgroup><col> <col></colgroup><thead><tr><th>Java Class</th><th>DataWeave</th></tr></thead><tbody><tr><td><p><code>java.lang.String</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>Enum</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>Class</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>UUID</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>CharSequence</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>Char</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>java.sql.Clob</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>java.io.Reader</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>int</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>long</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>double</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>short</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>BigInteger</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>BigDecimal</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>AtomicInteger</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>AtomicLong</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>boolean</code></p></td><td><p><code>Boolean</code></p></td></tr><tr><td><p><code>AtomicBoolean</code></p></td><td><p><code>Boolean</code></p></td></tr><tr><td><p><code>java.util.Collection</code></p></td><td><p><code>Array</code></p></td></tr><tr><td><p><code>java.lang.Iterable</code></p></td><td><p><code>Array</code></p></td></tr><tr><td><p><code>java.util.Iterator</code></p></td><td><p><code>Array</code></p></td></tr><tr><td><p><code>java.util.Map</code></p></td><td><p><code>Object</code></p></td></tr><tr><td><p><code>java.util.Optional</code></p></td><td><p><code>Null</code> or <code>Value</code></p></td></tr><tr><td><p><code>java.util.OptionalInt</code></p></td><td><p><code>Null</code> or <code>Number</code></p></td></tr><tr><td><p><code>java.util.OptionalDouble</code></p></td><td><p><code>Null</code> or <code>Number</code></p></td></tr><tr><td><p><code>java.util.OptionalLong</code></p></td><td><p><code>Null</code> or <code>Number</code></p></td></tr><tr><td><p><code>byte[]</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>java.lang.InputStream</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>java.nio.ByteBuffer</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>byte</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>java.lang.File</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>java.time.Instant</code></p></td><td><p><code>LocalDateTime</code></p></td></tr><tr><td><p><code>java.time.LocalDateTime</code></p></td><td><p><code>LocalDateTime</code></p></td></tr><tr><td><p><code>java.sql.Timestamp</code></p></td><td><p><code>LocalDateTime</code></p></td></tr><tr><td><p><code>java.sql.Date</code></p></td><td><p><code>LocalDateTime</code></p></td></tr><tr><td><p><code>java.util.Date</code></p></td><td><p><code>LocalDateTime</code></p></td></tr><tr><td><p><code>java.time.ZonedDateTime</code></p></td><td><p><code>DateTime</code></p></td></tr><tr><td><p><code>java.time.LocalTime</code></p></td><td><p><code>LocalTime</code></p></td></tr><tr><td><p><code>java.time.OffsetTime</code></p></td><td><p><code>Time</code></p></td></tr><tr><td><p><code>java.time.LocalDate</code></p></td><td><p><code>Date</code></p></td></tr><tr><td><p><code>java.time.ZoneOffset</code></p></td><td><p><code>TimeZone</code></p></td></tr><tr><td><p><code>java.util.Calendar</code></p></td><td><p><code>DateTime</code></p></td></tr><tr><td><p><code>java.util.XMLGregorianCalendar</code></p></td><td><p><code>DateTime</code></p></td></tr><tr><td><p><code>*[]</code></p></td><td><p><code>Array</code></p></td></tr></tbody></table>

> [!IMPORTANT] If a Java class is not in present in the table, DataWeave treats it as a `JavaBean`
> and maps it as an `Object` type. In this case, DataWeave takes all properties from the Java
> getters.

## Metadata

DataWeave supports the `^class` metadata for the Java format.

All Java objects are associated with a class. DataWeave maintains this association by mapping the
class to a Metadata property.

`payload.^class` returns the name of the class of the `payload`.

The Java writer uses the metadata property to discover the Java class to which the DataWeave value
maps. That is, DataWeave uses the metadata property to determine which Java class is to be created
from a given DataWeave value. For example, the expression
`output application/java --- now() as DateTime {class: "java.util.Calendar"}` creates a
`java.util.Calendar`.

## Enum Custom Type

The Java format supports the `Enum` custom type. To put a Java `enum` value into a `java.util.Map`,
the DataWeave Java module defines a custom type called `Enum`. This custom type enables you to
handle a given string as the name of a specified `enum` type. You must use the `class` metadata
property when specifying the Java class name of the enum, for example:
`{gender: "Female" as Enum {class: "org.mycompany.Gender"}}`

## Handling `java.io.InputStream` Instances

Using `java.io.InputStream` instances in DataWeave, whether running DataWeave functions, calling
Java methods from DataWeave code, or writing them to an output, requires understanding how DataWeave
manages `java.io.InputStream` instances.

The Java format makes a deep copy of the `java.io.InputStream` instance. As a result, DataWeave
creates a new `java.io.InputStream` instance that can be reused later in your script while retaining
the content of the original stream.

However, if the original `java.io.InputStream` doesn’t support repeatable streams, it may get
consumed and become unusable.

To avoid unexpected behavior, always check whether your `java.io.InputStream` is repeatable before
processing it multiple times.

## Examples

The following examples show uses of the Java format.

- [Example: Access Values of Java Properties](#example1)

- [Example: Create a Customer Object](#example2)

- [Example: Use a Generic](#example3)

### Class Definitions

The Java examples use the following class definitions:

- [`User`](#class_user)

- [`Customer`](#class_customer) (which extends `User`)

User class:

```java
class User {
    private String name;
    private String lastName;

    public User(){

    }

    public User(String name, String lastName){
        this.name = name;
        this.lastName = lastName;
    }

    public void setName(String name){
        this.name = name;
    }

     public void setLastName(String lastName){
        this.lastName = lastName;
    }

    public String getName(){
        return name;
    }

    public String getLastName(){
        return lastName;
    }
}
```

The following class extends `User`.

Customer class:

```java
import java.util.Calendar;
class Customer extends User {
    private Calendar expirationDate;
    private User salesRepr;

    public User(){

    }

    public User(String name, String lastName,Calendar expirationDate){
        super(name,lastName);
        this.expirationDate = expirationDate;
    }

    public void setSalesRepr(User salesRepr){
        this.salesRepr = salesRepr;
    }

    public User getSalesRepr(){
        return this.salesRepr;
    }

    public void  setExpirationDate(Calendar expirationDate){
        this.expirationDate = expirationDate;
    }

    public Calendar getExpirationDate(){
        return this.expirationDate;
    }
}
```

### Example: Access Values of Java Properties

This example shows how to access the values of Java properties.

#### Input

The `User` values serves as the input payload to the DataWeave script.

```groovy
new User("Leandro", "Shokida")
```

#### Source

The DataWeave scripts transforms the input value to JSON.

```dataweave
output application/json
---
{
    a: payload.name,
    b: payload.lastName
}
```

#### Output

The output is a JSON object that contains key-value pairs. The values are the `name` and `lastName`
values from the input `User` object.

```json
{
  "a": "Leandro",
  "b": "Shokida"
}
```

### Example: Create a Customer Object

This example shows how to create an instance of a `Customer` class. The script outputs the object in
the JSON format and MIME type.

Notice that it is not necessary to specify the class of inner properties because their class is
inferred from the parent class definition.

```dataweave
output application/json
---
{
    name: "Tomo",
    lastName: "Chibana",
    expirationDate: now(),
    salesRepr: {
        name: "Mariano",
        lastName: "de Achaval",
    }
} as Object {class: "Customer"}
```

### Example: Use a Generic

This example relies on generic support in the class name to create a `java.util.ArrayList` of `User`
objects.

Note that you do not need to use a generic to specify the class in each instance. The class is taken
from the generic in the list.

```dataweave
output application/json
---
[{
    name: "Tomo",
    lastName: "Chibana"
},
{
    name: "Ana",
    lastName: "Felissati"
},
{
    name: "Leandro",
    lastName: "Shokida"
}
] as Array {class: "java.util.ArrayList<User>"}
```

## Java Support

Starting with version 2.6, DataWeave supports Java 17. Java 17 adds restrictions in encapsulation
and reflective access that affects the
[Java Format](https://docs.mulesoft.com/dataweave/latest/dataweave-formats-java). Because DataWeave
uses Java’s reflection API to read and write Java objects, ensure that the objects your application
uses are Plain Old Java Objects (POJOs) containing:

- Default constructor

- Getters for all properties

- Setters for all properties

## Examples of Java Support

The following examples run using Java 17 and
[language level 2.6](https://docs.mulesoft.com/dataweave/2.6/dataweave-versioning-behavior).

- [Example: Create a Java Object Instance](#example4)

- [Example: Access the Values of Java Properties](#example5)

### Example: Create a Java Object Instance

This example shows how to create a Java object instance.

#### User Class

The Java example uses the following class:

```java
public class User {
   private String name;
   private String lastName;
   public User(){
   }
   public String getName(){
       return name;
   }
   public String getLastName(){
       return lastName;
   }
}
```

#### DataWeave Script

```java
{name: "Tomo", lastName: "Chibana" } as Object {class: "User"}
```

#### Output

The expected output is an instance of the user class. Because the user class definition doesn’t have
the proper setters, the output is `IllegalAccessException`.

```java
java.lang.IllegalAccessException - class
org.mule.weave.v2.module.pojo.reader.PropertyDefinition (in module org.mule.weave.module.java) cannot access a member of class User with modifiers "private
```

### Example: Access the Values of Java Properties

This example shows how to access the values of Java properties.

#### Item Class

The Java example uses the following class:

```java
public class Item {
	private String name;
	private int quantity;

	public Item() {
	}
    public Item(String name, int quantity) {
		this.name = name;
		this.quantity = quantity;
	}
	public void setName(String name) {
		this.name = name;
	}
	public void setQuantity(int quantity) {
		this.quantity = quantity;
	}
}
```

#### Input

new Item("Pencil", 5)

#### DataWeave Script

```dataweave
output application/json
---
{
    "name": "payload.name",
    "quantity": "payload.quantity"
}
```

#### Output

The expected output is a JSON object.

```json
{
  "name": "Pencil",
  "quantity": "5"
}
```

Because the item class definition doesn’t have the proper getters, the output is
`IllegalAccessException`.

```java
java.lang.IllegalAccessException: class
org.mule.weave.v2.module.pojo.reader.PropertyDefinition (in module org.mule.weave.module.java) cannot access a member of class Item with modifiers "private"
```

### Troubleshooting Common Errors

To resolve conflicts, ensure that you:

- Update your class definitions to follow the POJOs structure (recommended).

- Use the compatibility flag `com.mulesoft.dw.java.disable_set_accessible=false` to allow accessible
  flag modification for reflection objects.

  This approach is a workaround and works for customer domain classes only. Note that the usage of
  this compatibility flag might not affect future versions.

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

There are no reader properties for this format.

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>duplicateKeyAsArray</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Converts the values of duplicate keys in an object to a single array of values to the duplicated key.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>writeAttributes</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Converts attributes of a key into child key-value pairs of that key. The attribute key name starts with @.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/java</code></p></td></tr></tbody></table>

<!-- document id=e16315d55285ad9db87c394427483d52cd5098593a1499cb2ffaa306a5ceaf51 url=/mulesoft/current/en-us/dataweave/latest/dataweave-formats-java.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: format, java, */java, application/java
---

# Java Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/java`

ID: `java`

For the Java data format, DataWeave attempts to map any Java value to a DataWeave value, most often
by matching the semantics of DataWeave and Java.

## Java Value Mapping

This table maps Java classes to DataWeave types:

<table><colgroup><col> <col></colgroup><thead><tr><th>Java Class</th><th>DataWeave</th></tr></thead><tbody><tr><td><p><code>java.lang.String</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>Enum</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>Class</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>UUID</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>CharSequence</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>Char</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>java.sql.Clob</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>java.io.Reader</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>int</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>long</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>double</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>short</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>BigInteger</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>BigDecimal</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>AtomicInteger</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>AtomicLong</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>boolean</code></p></td><td><p><code>Boolean</code></p></td></tr><tr><td><p><code>AtomicBoolean</code></p></td><td><p><code>Boolean</code></p></td></tr><tr><td><p><code>java.util.Collection</code></p></td><td><p><code>Array</code></p></td></tr><tr><td><p><code>java.lang.Iterable</code></p></td><td><p><code>Array</code></p></td></tr><tr><td><p><code>java.util.Iterator</code></p></td><td><p><code>Array</code></p></td></tr><tr><td><p><code>java.util.Map</code></p></td><td><p><code>Object</code></p></td></tr><tr><td><p><code>java.util.Optional</code></p></td><td><p><code>Null</code> or <code>Value</code></p></td></tr><tr><td><p><code>java.util.OptionalInt</code></p></td><td><p><code>Null</code> or <code>Number</code></p></td></tr><tr><td><p><code>java.util.OptionalDouble</code></p></td><td><p><code>Null</code> or <code>Number</code></p></td></tr><tr><td><p><code>java.util.OptionalLong</code></p></td><td><p><code>Null</code> or <code>Number</code></p></td></tr><tr><td><p><code>byte[]</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>java.lang.InputStream</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>java.nio.ByteBuffer</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>byte</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>java.lang.File</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>java.time.Instant</code></p></td><td><p><code>LocalDateTime</code></p></td></tr><tr><td><p><code>java.time.LocalDateTime</code></p></td><td><p><code>LocalDateTime</code></p></td></tr><tr><td><p><code>java.sql.Timestamp</code></p></td><td><p><code>LocalDateTime</code></p></td></tr><tr><td><p><code>java.sql.Date</code></p></td><td><p><code>LocalDateTime</code></p></td></tr><tr><td><p><code>java.util.Date</code></p></td><td><p><code>LocalDateTime</code></p></td></tr><tr><td><p><code>java.time.ZonedDateTime</code></p></td><td><p><code>DateTime</code></p></td></tr><tr><td><p><code>java.time.LocalTime</code></p></td><td><p><code>LocalTime</code></p></td></tr><tr><td><p><code>java.time.OffsetTime</code></p></td><td><p><code>Time</code></p></td></tr><tr><td><p><code>java.time.LocalDate</code></p></td><td><p><code>Date</code></p></td></tr><tr><td><p><code>java.time.ZoneOffset</code></p></td><td><p><code>TimeZone</code></p></td></tr><tr><td><p><code>java.util.Calendar</code></p></td><td><p><code>DateTime</code></p></td></tr><tr><td><p><code>java.util.XMLGregorianCalendar</code></p></td><td><p><code>DateTime</code></p></td></tr><tr><td><p><code>*[]</code></p></td><td><p><code>Array</code></p></td></tr></tbody></table>

> [!IMPORTANT] If a Java class isn’t present in the table, DataWeave treats it as a `JavaBean` and
> maps it as an `Object` type. In this case, DataWeave takes all properties from the Java getters.

## Metadata

DataWeave supports the `^class` metadata for the Java format.

All Java objects are associated with a class. DataWeave maintains this association by mapping the
class to a Metadata property.

`payload.^class` returns the name of the class of the `payload`.

The Java writer uses the metadata property to discover the Java class to which the DataWeave value
maps. That is, DataWeave uses the metadata property to determine which Java class is to be created
from a given DataWeave value. For example, the expression
`output application/java --- now() as DateTime {class: "java.util.Calendar"}` creates a
`java.util.Calendar`.

## Enum Custom Type

The Java format supports the `Enum` custom type. To put a Java `enum` value into a `java.util.Map`,
the DataWeave Java module defines a custom type called `Enum`. This custom type enables you to
handle a given string as the name of a specified `enum` type. You must use the `class` metadata
property when specifying the Java class name of the enum, for example:
`{gender: "Female" as Enum {class: "org.mycompany.Gender"}}`

## Handling `java.io.InputStream` Instances

Using `java.io.InputStream` instances in DataWeave, whether running DataWeave functions, calling
Java methods from DataWeave code, or writing them to an output, requires understanding how DataWeave
manages `java.io.InputStream` instances.

The Java format makes a deep copy of the `java.io.InputStream` instance. As a result, DataWeave
creates a new `java.io.InputStream` instance that can be reused later in your script while retaining
the content of the original stream.

However, if the original `java.io.InputStream` doesn’t support repeatable streams, it may get
consumed and become unusable.

To avoid unexpected behavior, always check whether your `java.io.InputStream` is repeatable before
processing it multiple times.

## Examples

The following examples show uses of the Java format.

- [Example: Access Values of Java Properties](#example1)

- [Example: Create a Customer Object](#example2)

- [Example: Use a Generic](#example3)

### Class Definitions

The Java examples use these class definitions:

- [`User`](#class_user)

- [`Customer`](#class_customer) (which extends `User`)

User class:

```java
class User {
    private String name;
    private String lastName;

    public User(){

    }

    public User(String name, String lastName){
        this.name = name;
        this.lastName = lastName;
    }

    public void setName(String name){
        this.name = name;
    }

     public void setLastName(String lastName){
        this.lastName = lastName;
    }

    public String getName(){
        return name;
    }

    public String getLastName(){
        return lastName;
    }
}
```

This class extends `User`.

Customer class:

```java
import java.util.Calendar;
class Customer extends User {
    private Calendar expirationDate;
    private User salesRepr;

    public User(){

    }

    public User(String name, String lastName,Calendar expirationDate){
        super(name,lastName);
        this.expirationDate = expirationDate;
    }

    public void setSalesRepr(User salesRepr){
        this.salesRepr = salesRepr;
    }

    public User getSalesRepr(){
        return this.salesRepr;
    }

    public void  setExpirationDate(Calendar expirationDate){
        this.expirationDate = expirationDate;
    }

    public Calendar getExpirationDate(){
        return this.expirationDate;
    }
}
```

### Example: Access Values of Java Properties

This example shows how to access the values of Java properties.

#### Input

The `User` values serves as the input payload to the DataWeave script.

```groovy
new User("Leandro", "Shokida")
```

#### Source

The DataWeave scripts transforms the input value to JSON.

```dataweave
output application/json
---
{
    a: payload.name,
    b: payload.lastName
}
```

#### Output

The output is a JSON object that contains key-value pairs. The values are the `name` and `lastName`
values from the input `User` object.

```json
{
  "a": "Leandro",
  "b": "Shokida"
}
```

### Example: Create a Customer Object

This example shows how to create an instance of a `Customer` class. The script outputs the object in
the JSON format and MIME type.

Notice that it’s not necessary to specify the class of inner properties because their class is
inferred from the parent class definition.

```dataweave
output application/json
---
{
    name: "Tomo",
    lastName: "Chibana",
    expirationDate: now(),
    salesRepr: {
        name: "Mariano",
        lastName: "de Achaval",
    }
} as Object {class: "Customer"}
```

### Example: Use a Generic

This example relies on generic support in the class name to create a `java.util.ArrayList` of `User`
objects.

Don’t use a generic to specify the class in each instance. The class is taken from the generic in
the list.

```dataweave
output application/json
---
[{
    name: "Tomo",
    lastName: "Chibana"
},
{
    name: "Ana",
    lastName: "Felissati"
},
{
    name: "Leandro",
    lastName: "Shokida"
}
] as Array {class: "java.util.ArrayList<User>"}
```

## Java Support

Starting with version 2.6, DataWeave supports Java 17. Java 17 adds restrictions in encapsulation
and reflective access that affects the
[Java Format](https://docs.mulesoft.com/dataweave/latest/dataweave-formats-java). Because DataWeave
uses Java’s reflection API to read and write Java objects, ensure that the objects your application
uses are Plain Old Java Objects (POJOs) containing:

- Default constructor

- Getters for all properties

- Setters for all properties

## Examples of Java Support

These examples run using Java 17 and
[language level 2.6](https://docs.mulesoft.com/dataweave/latest/dataweave-versioning-behavior.adoc).

- [Example: Create a Java Object Instance](#example4)

- [Example: Access the Values of Java Properties](#example5)

### Example: Create a Java Object Instance

This example shows how to create a Java object instance.

#### User Class

The Java example uses this class:

```java
public class User {
   private String name;
   private String lastName;
   public User(){
   }
   public String getName(){
       return name;
   }
   public String getLastName(){
       return lastName;
   }
}
```

#### DataWeave Script

```java
{name: "Tomo", lastName: "Chibana" } as Object {class: "User"}
```

#### Output

The expected output is an instance of the user class. Because the user class definition doesn’t have
the proper setters, the output is `IllegalAccessException`.

```java
java.lang.IllegalAccessException - class
org.mule.weave.v2.module.pojo.reader.PropertyDefinition (in module org.mule.weave.module.java) cannot access a member of class User with modifiers "private
```

### Example: Access the Values of Java Properties

This example shows how to access the values of Java properties.

#### Item Class

The Java example uses the following class:

```java
public class Item {
	private String name;
	private int quantity;

	public Item() {
	}
    public Item(String name, int quantity) {
		this.name = name;
		this.quantity = quantity;
	}
	public void setName(String name) {
		this.name = name;
	}
	public void setQuantity(int quantity) {
		this.quantity = quantity;
	}
}
```

#### Input

new Item("Pencil", 5)

#### DataWeave Script

```dataweave
output application/json
---
{
    "name": "payload.name",
    "quantity": "payload.quantity"
}
```

#### Output

The expected output is a JSON object.

```json
{
  "name": "Pencil",
  "quantity": "5"
}
```

Because the item class definition doesn’t have the proper getters, the output is
`IllegalAccessException`.

```java
java.lang.IllegalAccessException: class
org.mule.weave.v2.module.pojo.reader.PropertyDefinition (in module org.mule.weave.module.java) cannot access a member of class Item with modifiers "private"
```

### Troubleshooting Common Errors

To resolve conflicts, ensure that you:

- Update your class definitions to follow the POJOs structure (recommended).

- Use the compatibility flag `com.mulesoft.dw.java.disable_set_accessible=false` to allow accessible
  flag modification for reflection objects.

  This approach is a workaround and works for customer domain classes only. Note that the usage of
  this compatibility flag might not affect future versions.

## Configuration Properties

DataWeave supports these configuration properties for this format.

### Reader Properties

There are no reader properties for this format.

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>duplicateKeyAsArray</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Converts the values of duplicate keys in an object to a single array of values to the duplicated key.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>writeAttributes</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Converts attributes of a key into child key-value pairs of that key. The attribute key name starts with @.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports this MIME type:

- `*/java`

<!-- document id=89d59cfb1b19e499c012af80e4f246841265adc2c28d4a64bbebb4d6da2e1987 url=/mulesoft/current/en-us/dataweave/2.11/dw-arrays-functions-join.md -->

---
product: DataWeave
version: 2.11
---

# join

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## join<L <: Object, R <: Object>(left: Array<L>, right: Array<R>, leftCriteria: (leftValue: L) -> String, rightCriteria: (rightValue: R) -> String): Array<Pair<L, R>>

Joins two arrays of objects by a given ID criteria.

`join` returns an array all the `left` items, merged by ID with any right items that exist.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>left</code></p></td><td><p>The left-side array of objects.</p></td></tr><tr><td><p><code>right</code></p></td><td><p>The right-side array of objects.</p></td></tr><tr><td><p><code>leftCriteria</code></p></td><td><p>The criteria used to extract the ID for the left collection.</p></td></tr><tr><td><p><code>rightCriteria</code></p></td><td><p>The criteria used to extract the ID for the right collection.</p></td></tr></tbody></table>

### Example

This example shows how join behaves. Notice that the output only includes objects where the values
of the input `user.id` and `product.ownerId` match. The function includes the `"l"` and `"r"` keys
in the output.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
var users = [{id: "1", name:"Mariano"},{id: "2", name:"Leandro"},{id: "3", name:"Julian"},{id: "5", name:"Julian"}]
var products = [{ownerId: "1", name:"DataWeave"},{ownerId: "1", name:"BAT"}, {ownerId: "3", name:"DataSense"}, {ownerId: "4", name:"SmartConnectors"}]
output application/json
---
join(users, products, (user) -> user.id, (product) -> product.ownerId)
```

#### Output

```json
[
  {
    "l": {
      "id": "1",
      "name": "Mariano"
    },
    "r": {
      "ownerId": "1",
      "name": "DataWeave"
    }
  },
  {
    "l": {
      "id": "1",
      "name": "Mariano"
    },
    "r": {
      "ownerId": "1",
      "name": "BAT"
    }
  },
  {
    "l": {
      "id": "3",
      "name": "Julian"
    },
    "r": {
      "ownerId": "3",
      "name": "DataSense"
    }
  }
]
```

<!-- document id=c888e9c09fe0d225a8cb9325423018ac1b064cb312ea2ac5627710db89735379 url=/mulesoft/current/en-us/dataweave/2.12/dw-arrays-functions-join.md -->

---
product: DataWeave
version: 2.12
---

# join

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## join<L <: Object, R <: Object>(left: Array<L>, right: Array<R>, leftCriteria: (leftValue: L) -> String, rightCriteria: (rightValue: R) -> String): Array<Pair<L, R>>

Joins two arrays of objects by a given ID criteria.

`join` returns an array all the `left` items, merged by ID with any right items that exist.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>left</code></p></td><td><p>The left-side array of objects.</p></td></tr><tr><td><p><code>right</code></p></td><td><p>The right-side array of objects.</p></td></tr><tr><td><p><code>leftCriteria</code></p></td><td><p>The criteria used to extract the ID for the left collection.</p></td></tr><tr><td><p><code>rightCriteria</code></p></td><td><p>The criteria used to extract the ID for the right collection.</p></td></tr></tbody></table>

### Example

This example shows how join behaves. Notice that the output only includes objects where the values
of the input `user.id` and `product.ownerId` match. The function includes the `"l"` and `"r"` keys
in the output.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
var users = [{id: "1", name:"Mariano"},{id: "2", name:"Leandro"},{id: "3", name:"Julian"},{id: "5", name:"Julian"}]
var products = [{ownerId: "1", name:"DataWeave"},{ownerId: "1", name:"BAT"}, {ownerId: "3", name:"DataSense"}, {ownerId: "4", name:"SmartConnectors"}]
output application/json
---
join(users, products, (user) -> user.id, (product) -> product.ownerId)
```

#### Output

```json
[
  {
    "l": {
      "id": "1",
      "name": "Mariano"
    },
    "r": {
      "ownerId": "1",
      "name": "DataWeave"
    }
  },
  {
    "l": {
      "id": "1",
      "name": "Mariano"
    },
    "r": {
      "ownerId": "1",
      "name": "BAT"
    }
  },
  {
    "l": {
      "id": "3",
      "name": "Julian"
    },
    "r": {
      "ownerId": "3",
      "name": "DataSense"
    }
  }
]
```

<!-- document id=82322e78c30d81bc192eb8e5804a19283b181ad4f12f7175d5a2bf8a1f2836fd url=/mulesoft/current/en-us/dataweave/2.3/dw-arrays-functions-join.md -->

---
product: DataWeave
version: 2.3
---

# join

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## join(Array<L>, Array<R>, (leftValue: L) -> String, (rightValue: R) -> String): Array<Pair<L, R>>

Joins two arrays of objects by a given ID criteria.

`join` returns an array all the `left` items, merged by ID with any right items that exist.

_Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>left</code></p></td><td><p>The left-side array of objects.</p></td></tr><tr><td><p><code>right</code></p></td><td><p>The right-side array of objects.</p></td></tr><tr><td><p><code>leftCriteria</code></p></td><td><p>The criteria used to extract the ID for the left collection.</p></td></tr><tr><td><p><code>rightCriteria</code></p></td><td><p>The criteria used to extract the ID for the right collection.</p></td></tr></tbody></table>

### Example

This example shows how join behaves. Notice that the output only includes objects where the values
of the input `user.id` and `product.ownerId` match. The function includes the `"l"` and `"r"` keys
in the output.

#### Source

```DataWeave
 %dw 2.0
 import * from dw::core::Arrays
 var users = [{id: "1", name:"Mariano"},{id: "2", name:"Leandro"},{id: "3", name:"Julian"},{id: "5", name:"Julian"}]
 var products = [{ownerId: "1", name:"DataWeave"},{ownerId: "1", name:"BAT"}, {ownerId: "3", name:"DataSense"}, {ownerId: "4", name:"SmartConnectors"}]
 output application/json
 ---
 join(users, products, (user) -> user.id, (product) -> product.ownerId)
```

#### Output

```json
[
  {
    "l": {
      "id": "1",
      "name": "Mariano"
    },
    "r": {
      "ownerId": "1",
      "name": "DataWeave"
    }
  },
  {
    "l": {
      "id": "1",
      "name": "Mariano"
    },
    "r": {
      "ownerId": "1",
      "name": "BAT"
    }
  },
  {
    "l": {
      "id": "3",
      "name": "Julian"
    },
    "r": {
      "ownerId": "3",
      "name": "DataSense"
    }
  }
]
```

<!-- document id=29fccfc3eac21ae7214e609a7050910d5525eeac82534bd1b7878b0f1bdb9971 url=/mulesoft/current/en-us/dataweave/2.4/dw-arrays-functions-join.md -->

---
product: DataWeave
version: 2.4
---

# join

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## join<L <: Object, R <: Object>(left: Array<L>, right: Array<R>, leftCriteria: (leftValue: L) -> String, rightCriteria: (rightValue: R) -> String): Array<Pair<L, R>>

Joins two arrays of objects by a given ID criteria.

`join` returns an array all the `left` items, merged by ID with any right items that exist.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>left</code></p></td><td><p>The left-side array of objects.</p></td></tr><tr><td><p><code>right</code></p></td><td><p>The right-side array of objects.</p></td></tr><tr><td><p><code>leftCriteria</code></p></td><td><p>The criteria used to extract the ID for the left collection.</p></td></tr><tr><td><p><code>rightCriteria</code></p></td><td><p>The criteria used to extract the ID for the right collection.</p></td></tr></tbody></table>

### Example

This example shows how join behaves. Notice that the output only includes objects where the values
of the input `user.id` and `product.ownerId` match. The function includes the `"l"` and `"r"` keys
in the output.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
var users = [{id: "1", name:"Mariano"},{id: "2", name:"Leandro"},{id: "3", name:"Julian"},{id: "5", name:"Julian"}]
var products = [{ownerId: "1", name:"DataWeave"},{ownerId: "1", name:"BAT"}, {ownerId: "3", name:"DataSense"}, {ownerId: "4", name:"SmartConnectors"}]
output application/json
---
join(users, products, (user) -> user.id, (product) -> product.ownerId)
```

#### Output

```json
[
  {
    "l": {
      "id": "1",
      "name": "Mariano"
    },
    "r": {
      "ownerId": "1",
      "name": "DataWeave"
    }
  },
  {
    "l": {
      "id": "1",
      "name": "Mariano"
    },
    "r": {
      "ownerId": "1",
      "name": "BAT"
    }
  },
  {
    "l": {
      "id": "3",
      "name": "Julian"
    },
    "r": {
      "ownerId": "3",
      "name": "DataSense"
    }
  }
]
```

<!-- document id=94d43d3a05e78550f561a373febfdb2dc5cfa7457f5e5c8dff50407c413c3d12 url=/mulesoft/current/en-us/dataweave/2.6/dw-arrays-functions-join.md -->

---
product: DataWeave
version: 2.6
---

# join

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## join<L <: Object, R <: Object>(left: Array<L>, right: Array<R>, leftCriteria: (leftValue: L) -> String, rightCriteria: (rightValue: R) -> String): Array<Pair<L, R>>

Joins two arrays of objects by a given ID criteria.

`join` returns an array all the `left` items, merged by ID with any right items that exist.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>left</code></p></td><td><p>The left-side array of objects.</p></td></tr><tr><td><p><code>right</code></p></td><td><p>The right-side array of objects.</p></td></tr><tr><td><p><code>leftCriteria</code></p></td><td><p>The criteria used to extract the ID for the left collection.</p></td></tr><tr><td><p><code>rightCriteria</code></p></td><td><p>The criteria used to extract the ID for the right collection.</p></td></tr></tbody></table>

### Example

This example shows how join behaves. Notice that the output only includes objects where the values
of the input `user.id` and `product.ownerId` match. The function includes the `"l"` and `"r"` keys
in the output.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
var users = [{id: "1", name:"Mariano"},{id: "2", name:"Leandro"},{id: "3", name:"Julian"},{id: "5", name:"Julian"}]
var products = [{ownerId: "1", name:"DataWeave"},{ownerId: "1", name:"BAT"}, {ownerId: "3", name:"DataSense"}, {ownerId: "4", name:"SmartConnectors"}]
output application/json
---
join(users, products, (user) -> user.id, (product) -> product.ownerId)
```

#### Output

```json
[
  {
    "l": {
      "id": "1",
      "name": "Mariano"
    },
    "r": {
      "ownerId": "1",
      "name": "DataWeave"
    }
  },
  {
    "l": {
      "id": "1",
      "name": "Mariano"
    },
    "r": {
      "ownerId": "1",
      "name": "BAT"
    }
  },
  {
    "l": {
      "id": "3",
      "name": "Julian"
    },
    "r": {
      "ownerId": "3",
      "name": "DataSense"
    }
  }
]
```

<!-- document id=f03be9caed6f7f5f5723a10ff9702c2fe1b0cc5ccc37396934035238baed5875 url=/mulesoft/current/en-us/dataweave/2.9/dw-arrays-functions-join.md -->

---
product: DataWeave
version: 2.9
---

# join

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## join<L <: Object, R <: Object>(left: Array<L>, right: Array<R>, leftCriteria: (leftValue: L) -> String, rightCriteria: (rightValue: R) -> String): Array<Pair<L, R>>

Joins two arrays of objects by a given ID criteria.

`join` returns an array all the `left` items, merged by ID with any right items that exist.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>left</code></p></td><td><p>The left-side array of objects.</p></td></tr><tr><td><p><code>right</code></p></td><td><p>The right-side array of objects.</p></td></tr><tr><td><p><code>leftCriteria</code></p></td><td><p>The criteria used to extract the ID for the left collection.</p></td></tr><tr><td><p><code>rightCriteria</code></p></td><td><p>The criteria used to extract the ID for the right collection.</p></td></tr></tbody></table>

### Example

This example shows how join behaves. Notice that the output only includes objects where the values
of the input `user.id` and `product.ownerId` match. The function includes the `"l"` and `"r"` keys
in the output.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
var users = [{id: "1", name:"Mariano"},{id: "2", name:"Leandro"},{id: "3", name:"Julian"},{id: "5", name:"Julian"}]
var products = [{ownerId: "1", name:"DataWeave"},{ownerId: "1", name:"BAT"}, {ownerId: "3", name:"DataSense"}, {ownerId: "4", name:"SmartConnectors"}]
output application/json
---
join(users, products, (user) -> user.id, (product) -> product.ownerId)
```

#### Output

```json
[
  {
    "l": {
      "id": "1",
      "name": "Mariano"
    },
    "r": {
      "ownerId": "1",
      "name": "DataWeave"
    }
  },
  {
    "l": {
      "id": "1",
      "name": "Mariano"
    },
    "r": {
      "ownerId": "1",
      "name": "BAT"
    }
  },
  {
    "l": {
      "id": "3",
      "name": "Julian"
    },
    "r": {
      "ownerId": "3",
      "name": "DataSense"
    }
  }
]
```

<!-- document id=7b9155e6ae355698f5e3bf6178836e76151daae586037b32df9fa15587a984e3 url=/mulesoft/current/en-us/dataweave/latest/dw-arrays-functions-join.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# join

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## join<L <: Object, R <: Object>(left: Array<L>, right: Array<R>, leftCriteria: (leftValue: L) -> String, rightCriteria: (rightValue: R) -> String): Array<Pair<L, R>>

Joins two arrays of objects by a given ID criteria.

`join` returns an array all the `left` items, merged by ID with any right items that exist.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>left</code></p></td><td><p>The left-side array of objects.</p></td></tr><tr><td><p><code>right</code></p></td><td><p>The right-side array of objects.</p></td></tr><tr><td><p><code>leftCriteria</code></p></td><td><p>The criteria used to extract the ID for the left collection.</p></td></tr><tr><td><p><code>rightCriteria</code></p></td><td><p>The criteria used to extract the ID for the right collection.</p></td></tr></tbody></table>

### Example

This example shows how join behaves. Notice that the output only includes objects where the values
of the input `user.id` and `product.ownerId` match. The function includes the `"l"` and `"r"` keys
in the output.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
var users = [{id: "1", name:"Mariano"},{id: "2", name:"Leandro"},{id: "3", name:"Julian"},{id: "5", name:"Julian"}]
var products = [{ownerId: "1", name:"DataWeave"},{ownerId: "1", name:"BAT"}, {ownerId: "3", name:"DataSense"}, {ownerId: "4", name:"SmartConnectors"}]
output application/json
---
join(users, products, (user) -> user.id, (product) -> product.ownerId)
```

#### Output

```json
[
  {
    "l": {
      "id": "1",
      "name": "Mariano"
    },
    "r": {
      "ownerId": "1",
      "name": "DataWeave"
    }
  },
  {
    "l": {
      "id": "1",
      "name": "Mariano"
    },
    "r": {
      "ownerId": "1",
      "name": "BAT"
    }
  },
  {
    "l": {
      "id": "3",
      "name": "Julian"
    },
    "r": {
      "ownerId": "3",
      "name": "DataSense"
    }
  }
]
```

<!-- document id=ef49af110b62b9851726e20cfeb236d0390b2fa4b7f36bb5a240ff0c2caa9d55 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-joinby.md -->

---
product: DataWeave
version: 2.11
---

# joinBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## joinBy(@StreamCapable elements: Array<StringCoerceable>, separator: String): String

Merges an array into a single string value and uses the provided string as a separator between each
item in the list.

Note that `joinBy` performs the opposite task of `splitBy`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>elements</code></p></td><td><p>The input array.</p></td></tr><tr><td><p><code>separator</code></p></td><td><p>A <code>String</code> used to join elements in the list.</p></td></tr></tbody></table>

### Example

This example joins the elements with a hyphen (`-`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "hyphenate" : ["a","b","c"] joinBy "-" }
```

#### Output

```JSON
{ "hyphenate": "a-b-c" }
```

## joinBy(n: Null, separator: Any): Null

Helper function that enables `joinBy` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=24714f3963b171da4f477b0b42d2671e6d73407602b83561088328725a6e5a03 url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-joinby.md -->

---
product: DataWeave
version: 2.12
---

# joinBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## joinBy(@StreamCapable elements: Array<StringCoerceable>, separator: String): String

Merges an array into a single string value and uses the provided string as a separator between each
item in the list.

Note that `joinBy` performs the opposite task of `splitBy`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>elements</code></p></td><td><p>The input array.</p></td></tr><tr><td><p><code>separator</code></p></td><td><p>A <code>String</code> used to join elements in the list.</p></td></tr></tbody></table>

### Example

This example joins the elements with a hyphen (`-`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "hyphenate" : ["a","b","c"] joinBy "-" }
```

#### Output

```JSON
{ "hyphenate": "a-b-c" }
```

## joinBy(n: Null, separator: Any): Null

Helper function that enables `joinBy` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=cd4dbebb9ea81f5d186b2dfad0d7e9a43a670ce97757fb8013c4592b3fa0d019 url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-joinby.md -->

---
product: DataWeave
version: 2.3
---

# joinBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## joinBy(Array<StringCoerceable>, String): String

Merges an array into a single string value and uses the provided string as a separator between each
item in the list.

Note that `joinBy` performs the opposite task of `splitBy`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>elements</code></p></td><td><p>The input array.</p></td></tr><tr><td><p><code>separator</code></p></td><td><p>A <code>String</code> used to join elements in the list.</p></td></tr></tbody></table>

### Example

This example joins the elements with a hyphen (`-`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "hyphenate" : ["a","b","c"] joinBy "-" }
```

#### Output

```JSON
{ "hyphenate": "a-b-c" }
```

<!-- document id=06c846efc2a5aaf43c35cad22710c1b8f4287c9e7690e7b7e652cbdbe281025c url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-joinby.md -->

---
product: DataWeave
version: 2.4
---

# joinBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## joinBy(elements: Array<StringCoerceable>, separator: String): String

Merges an array into a single string value and uses the provided string as a separator between each
item in the list.

Note that `joinBy` performs the opposite task of `splitBy`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>elements</code></p></td><td><p>The input array.</p></td></tr><tr><td><p><code>separator</code></p></td><td><p>A <code>String</code> used to join elements in the list.</p></td></tr></tbody></table>

### Example

This example joins the elements with a hyphen (`-`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "hyphenate" : ["a","b","c"] joinBy "-" }
```

#### Output

```JSON
{ "hyphenate": "a-b-c" }
```

## joinBy(n: Null, separator: Any): Null

Helper function that enables `joinBy` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=84d03938d13e368db2377d57253576aa74fb82980a165568fc05d6ffe8d0e2ab url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-joinby.md -->

---
product: DataWeave
version: 2.6
---

# joinBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## joinBy(elements: Array<StringCoerceable>, separator: String): String

Merges an array into a single string value and uses the provided string as a separator between each
item in the list.

Note that `joinBy` performs the opposite task of `splitBy`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>elements</code></p></td><td><p>The input array.</p></td></tr><tr><td><p><code>separator</code></p></td><td><p>A <code>String</code> used to join elements in the list.</p></td></tr></tbody></table>

### Example

This example joins the elements with a hyphen (`-`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "hyphenate" : ["a","b","c"] joinBy "-" }
```

#### Output

```JSON
{ "hyphenate": "a-b-c" }
```

## joinBy(n: Null, separator: Any): Null

Helper function that enables `joinBy` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=a98e0e898f2187459d0e0c666249ae57d3bdf184ce00b6e7604b818e785b2ed0 url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-joinby.md -->

---
product: DataWeave
version: 2.9
---

# joinBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## joinBy(@StreamCapable elements: Array<StringCoerceable>, separator: String): String

Merges an array into a single string value and uses the provided string as a separator between each
item in the list.

Note that `joinBy` performs the opposite task of `splitBy`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>elements</code></p></td><td><p>The input array.</p></td></tr><tr><td><p><code>separator</code></p></td><td><p>A <code>String</code> used to join elements in the list.</p></td></tr></tbody></table>

### Example

This example joins the elements with a hyphen (`-`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "hyphenate" : ["a","b","c"] joinBy "-" }
```

#### Output

```JSON
{ "hyphenate": "a-b-c" }
```

## joinBy(n: Null, separator: Any): Null

Helper function that enables `joinBy` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=d126c0ea2181bfe3ce70f836c4db171f583e20d52a3a688e28847f125c8dd5d8 url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-joinby.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# joinBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## joinBy(@StreamCapable elements: Array<StringCoerceable>, separator: String): String

Merges an array into a single string value and uses the provided string as a separator between each
item in the list.

Note that `joinBy` performs the opposite task of `splitBy`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>elements</code></p></td><td><p>The input array.</p></td></tr><tr><td><p><code>separator</code></p></td><td><p>A <code>String</code> used to join elements in the list.</p></td></tr></tbody></table>

### Example

This example joins the elements with a hyphen (`-`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "hyphenate" : ["a","b","c"] joinBy "-" }
```

#### Output

```JSON
{ "hyphenate": "a-b-c" }
```

## joinBy(n: Null, separator: Any): Null

Helper function that enables `joinBy` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=e443d60787a05ca91c9dc29b1a7bbed5f4179959faf85b7a1508465684ecf13f url=/mulesoft/current/en-us/dataweave/2.11/dataweave-formats-json.md -->

---
product: DataWeave
version: 2.11
keywords: format, json, */json, */*+json, application/json
---

# JSON Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/json`

ID: `json`

In the JSON data format, values map one-to-one with DataWeave values. JSON supports `String`,
`Boolean`, `Number`, `Null`, `Object`, and `Array` types. DataWeave supports each of these values
natively.

The DataWeave reader for JSON input supports the following parsing strategies:

- Indexed

- In-Memory

- Streaming

To understand the parsing strategies that DataWeave readers and writers can apply to this format,
see [DataWeave Parsing Strategies](https://docs.mulesoft.com/dataweave/2.11/dataweave-formats#dw_readers_writers).

## Examples

The following examples show uses of the JSON format:

- [Example: Represent JSON in the DataWeave (dw) Format](#example1)

- [Example: Convert Repeated XML Elements to JSON](#example2)

- [Example: Stream JSON Data](#example3)

### Example: Represent JSON in the DataWeave (dw) Format

This example shows how JSON input is represented in the DataWeave (dw) format.

#### Input

The following JSON object serves as the input payload to the DataWeave source.

```json
{
  "name": "Matias",
  "age": 8,
  "male": true,
  "kids": null,
  "brothers": ["Pedro", "Sara"]
}
```

#### Source

The DataWeave script transforms the JSON input payload to the DataWeave (dw) format and MIME type.

```dataweave
output application/dw
---
payload
```

#### Output

Notice that only the keys of the JSON input and the `application/dw` output differ. The JSON keys
are surrounded by quotation marks. These DataWeave (dw) keys do not require quotation marks. See
[Valid Keys](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-extract-data#valid-keys) for details.

```dataweave
{
  name: "Matias",
  age: 8,
  male: true,
  kids: null,
  brothers: [
    "Pedro",
    "Sara"
  ]
}
```

### Example: Convert Repeated XML Elements to JSON

This example shows how to convert repeated XML elements to JSON.

Note that XML encodes collections using repeated (unbounded) elements. DataWeave represents
unbounded elements by repeating the same key.

#### Input

The following XML data contains repeating child elements with the key `name`. This XML serves as the
input payload to the DataWeave source.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<friends>
  <name>Mariano</name>
  <name>Shoki</name>
  <name>Tomo</name>
  <name>Ana</name>
</friends>
```

#### Source

The following DataWeave script takes the XML input as its payload and outputs that payload in the
JSON format.

The script selects the `name` elements from the XML input and uses the DataWeave `map` function to
map the values of those elements into an array of objects. Each object in the array takes the form
`{ name : item }`, where `item` is the value of the `name` element. The entire array serves as the
value of the `friends` key.

```dataweave
%dw 2.0
output application/json
---
friends: payload.friends.*name map (
            (item, index) -> {name: item}
         )
```

#### Output

The DataWeave script outputs the following JSON object.

```json
{
  "friends": [
    {
      "name": "Mariano"
    },
    {
      "name": "Shoki"
    },
    {
      "name": "Tomo"
    },
    {
      "name": "Ana"
    }
  ]
}
```

### Example: Stream JSON Data

To demonstrate streaming, the following example streams a JSON file by reading each element in an
array one at a time.

#### Input

The JSON input payload serves as input for the XML configuration.

JSON Input (truncated):

```json
{
  "myJsonExample": [
    {
      "name": "Shoki",
      "zipcode": "95838"
    },
    {
      "name": "Leandro",
      "zipcode": "95823"
    },
    {
      "name": "Mariano",
      "zipcode": "95815"
    },
    {
      "name": "Cristian",
      "zipcode": "95815"
    },
    {
      "name": "Kevin",
      "zipcode": "95824"
    },
    {
      "name": "Stanley",
      "zipcode": "95841"
    }
  ]
}
```

#### XML Configuration

The following XML configuration streams JSON input.

```xml
<file:config name="File_Config" doc:name="File Config" />
<flow name="dw-streaming-jsonFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="1" timeUnit="MINUTES"/>
    </scheduling-strategy>
  </scheduler>
  <file:read doc:name="Read"
     config-ref="File_Config"
     path="${app.home}/myjsonarray.json"
     outputMimeType="application/json; streaming=true"/>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
payload.myJsonExample map ((element) -> {
returnedElement : element.zipcode
})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
  <file:write doc:name="Write"
    path="/path/to/output/file/output.json"
    config-ref="File_Config1"/>
  <logger level="INFO" doc:name="Logger" message="#[payload]"/>
</flow>
```

- The streaming example configures the File Read operation to stream the JSON input by setting
  `outputMimeType="application/json; streaming=true"`. In the Studio UI, you can set the **MIME
  Type** on the listener to `application/json` and the **Parameters** for the MIME Type to **Key**
  `streaming` and **Value** `true`.

- The DataWeave script in the **Transform Message** component iterates over the array in the input
  payload and selects its `zipcode` values.

- The Write operation returns a file, `output.json`, which contains the result of the
  transformation.

- The Logger prints the same output payload that you see in `output.json`.

#### Output

The JSON streaming example produces a JSON array of objects.

```json
[
  {
    "returnedElement": "95838"
  },
  {
    "returnedElement": "95823"
  },
  {
    "returnedElement": "95815"
  },
  {
    "returnedElement": "95815"
  },
  {
    "returnedElement": "95824"
  },
  {
    "returnedElement": "95841"
  }
]
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>streaming</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Streams input when set to <code>true</code>. Use only if entries are accessed sequentially. The input must be a top-level array. See the <a href="#example2">streaming example</a>, and see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats#dw_readers_writers">DataWeave Readers</a>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>duplicateKeyAsArray</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Converts the values of duplicate keys in an object to a single array of values to the duplicated key.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>'UTF-8'</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr><tr><td><p><code>indent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Write indented output for better readability by default, or compress output into a single line when set to <code>false</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>skipNullOn</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Skips <code>null</code> values in the specified data structure. By default, DataWeave does not skip the values.</p></div><div><ul><li><p><code>arrays</code> + Ignore and omit <code>null</code> values inside arrays from the JSON output, for example, with <code>output application/json skipNullOn="arrays"</code>.</p></li><li><p><code>objects</code> + Ignore key-value pairs that have <code>null</code> as the value, for example, with <code>output application/json skipNullOn="objects"</code>.</p></li><li><p><code>everywhere</code> + Apply <code>skipNullOn</code> to arrays and objects, for example, <code>output application/json skipNullOn="everywhere"</code>.</p></li></ul></div><div><p>Valid values are <code>arrays</code> or <code>objects</code> or <code>everywhere</code>.</p></div></div></td></tr><tr><td><p><code>writeAttributes</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Converts attributes of a key into child key-value pairs of that key. The attribute key name starts with @.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/json</code></p></td></tr><tr><td><p><code><strong>/</strong>+json</code></p></td></tr></tbody></table>

<!-- document id=e76d5b62325a40d34d06d3f70514a9f6c224b57998607d2ab7bfaed230f85db9 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-formats-json.md -->

---
product: DataWeave
version: 2.12
keywords: format, json, */json, */*+json, application/json
---

# JSON Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/json`

ID: `json`

In the JSON data format, values map one-to-one with DataWeave values. JSON supports `String`,
`Boolean`, `Number`, `Null`, `Object`, and `Array` types. DataWeave supports each of these values
natively.

The DataWeave reader for JSON input supports the following parsing strategies:

- Indexed

- In-Memory

- Streaming

To understand the parsing strategies that DataWeave readers and writers can apply to this format,
see [DataWeave Parsing Strategies](https://docs.mulesoft.com/dataweave/2.12/dataweave-formats#dw_readers_writers).

## Examples

The following examples show uses of the JSON format:

- [Example: Represent JSON in the DataWeave (dw) Format](#example1)

- [Example: Convert Repeated XML Elements to JSON](#example2)

- [Example: Stream JSON Data](#example3)

### Example: Represent JSON in the DataWeave (dw) Format

This example shows how JSON input is represented in the DataWeave (dw) format.

#### Input

The following JSON object serves as the input payload to the DataWeave source.

```json
{
  "name": "Matias",
  "age": 8,
  "male": true,
  "kids": null,
  "brothers": ["Pedro", "Sara"]
}
```

#### Source

The DataWeave script transforms the JSON input payload to the DataWeave (dw) format and MIME type.

```dataweave
output application/dw
---
payload
```

#### Output

Notice that only the keys of the JSON input and the `application/dw` output differ. The JSON keys
are surrounded by quotation marks. These DataWeave (dw) keys do not require quotation marks. See
[Valid Keys](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-extract-data#valid-keys) for details.

```dataweave
{
  name: "Matias",
  age: 8,
  male: true,
  kids: null,
  brothers: [
    "Pedro",
    "Sara"
  ]
}
```

### Example: Convert Repeated XML Elements to JSON

This example shows how to convert repeated XML elements to JSON.

Note that XML encodes collections using repeated (unbounded) elements. DataWeave represents
unbounded elements by repeating the same key.

#### Input

The following XML data contains repeating child elements with the key `name`. This XML serves as the
input payload to the DataWeave source.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<friends>
  <name>Mariano</name>
  <name>Shoki</name>
  <name>Tomo</name>
  <name>Ana</name>
</friends>
```

#### Source

The following DataWeave script takes the XML input as its payload and outputs that payload in the
JSON format.

The script selects the `name` elements from the XML input and uses the DataWeave `map` function to
map the values of those elements into an array of objects. Each object in the array takes the form
`{ name : item }`, where `item` is the value of the `name` element. The entire array serves as the
value of the `friends` key.

```dataweave
%dw 2.0
output application/json
---
friends: payload.friends.*name map (
            (item, index) -> {name: item}
         )
```

#### Output

The DataWeave script outputs the following JSON object.

```json
{
  "friends": [
    {
      "name": "Mariano"
    },
    {
      "name": "Shoki"
    },
    {
      "name": "Tomo"
    },
    {
      "name": "Ana"
    }
  ]
}
```

### Example: Stream JSON Data

To demonstrate streaming, the following example streams a JSON file by reading each element in an
array one at a time.

#### Input

The JSON input payload serves as input for the XML configuration.

JSON Input (truncated):

```json
{
  "myJsonExample": [
    {
      "name": "Shoki",
      "zipcode": "95838"
    },
    {
      "name": "Leandro",
      "zipcode": "95823"
    },
    {
      "name": "Mariano",
      "zipcode": "95815"
    },
    {
      "name": "Cristian",
      "zipcode": "95815"
    },
    {
      "name": "Kevin",
      "zipcode": "95824"
    },
    {
      "name": "Stanley",
      "zipcode": "95841"
    }
  ]
}
```

#### XML Configuration

The following XML configuration streams JSON input.

```xml
<file:config name="File_Config" doc:name="File Config" />
<flow name="dw-streaming-jsonFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="1" timeUnit="MINUTES"/>
    </scheduling-strategy>
  </scheduler>
  <file:read doc:name="Read"
     config-ref="File_Config"
     path="${app.home}/myjsonarray.json"
     outputMimeType="application/json; streaming=true"/>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
payload.myJsonExample map ((element) -> {
returnedElement : element.zipcode
})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
  <file:write doc:name="Write"
    path="/path/to/output/file/output.json"
    config-ref="File_Config1"/>
  <logger level="INFO" doc:name="Logger" message="#[payload]"/>
</flow>
```

- The streaming example configures the File Read operation to stream the JSON input by setting
  `outputMimeType="application/json; streaming=true"`. In the Studio UI, you can set the **MIME
  Type** on the listener to `application/json` and the **Parameters** for the MIME Type to **Key**
  `streaming` and **Value** `true`.

- The DataWeave script in the **Transform Message** component iterates over the array in the input
  payload and selects its `zipcode` values.

- The Write operation returns a file, `output.json`, which contains the result of the
  transformation.

- The Logger prints the same output payload that you see in `output.json`.

#### Output

The JSON streaming example produces a JSON array of objects.

```json
[
  {
    "returnedElement": "95838"
  },
  {
    "returnedElement": "95823"
  },
  {
    "returnedElement": "95815"
  },
  {
    "returnedElement": "95815"
  },
  {
    "returnedElement": "95824"
  },
  {
    "returnedElement": "95841"
  }
]
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>streaming</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Streams input when set to <code>true</code>. Use only if entries are accessed sequentially. The input must be a top-level array. See the <a href="#example2">streaming example</a>, and see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats#dw_readers_writers">DataWeave Readers</a>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>duplicateKeyAsArray</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Converts the values of duplicate keys in an object to a single array of values to the duplicated key.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>'UTF-8'</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr><tr><td><p><code>indent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Write indented output for better readability by default, or compress output into a single line when set to <code>false</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>skipNullOn</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Skips <code>null</code> values in the specified data structure. By default, DataWeave does not skip the values.</p></div><div><ul><li><p><code>arrays</code> + Ignore and omit <code>null</code> values inside arrays from the JSON output, for example, with <code>output application/json skipNullOn="arrays"</code>.</p></li><li><p><code>objects</code> + Ignore key-value pairs that have <code>null</code> as the value, for example, with <code>output application/json skipNullOn="objects"</code>.</p></li><li><p><code>everywhere</code> + Apply <code>skipNullOn</code> to arrays and objects, for example, <code>output application/json skipNullOn="everywhere"</code>.</p></li></ul></div><div><p>Valid values are <code>arrays</code> or <code>objects</code> or <code>everywhere</code>.</p></div></div></td></tr><tr><td><p><code>writeAttributes</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Converts attributes of a key into child key-value pairs of that key. The attribute key name starts with @.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/json</code></p></td></tr><tr><td><p><code><strong>/</strong>+json</code></p></td></tr></tbody></table>

<!-- document id=86286320b9340b753b9f441bb708f871d0f36d53982af6f36f7d1c5a8d73ae31 url=/mulesoft/current/en-us/dataweave/2.3/dataweave-formats-json.md -->

---
product: DataWeave
version: 2.3
---

# JSON Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME Type: `application/json`

ID: `json`

In the JSON data format, values map one-to-one with DataWeave values. JSON supports `String`,
`Boolean`, `Number`, `Null`, `Object`, and `Array` types. DataWeave supports each of these values
natively.

The DataWeave reader for JSON input supports the following parsing strategies:

- Indexed

- In-Memory

- Streaming

To understand the parsing strategies that DataWeave readers and writers can apply to this format,
see [DataWeave Parsing Strategies](https://docs.mulesoft.com/dataweave/2.3/dataweave-formats#dw_readers_writers).

## Examples

The following examples show uses of the JSON format:

- [Example: Represent JSON in the DataWeave (dw) Format](#example1)

- [Example: Convert Repeated XML Elements to JSON](#example2)

- [Example: Stream JSON Data](#example3)

### Example: Represent JSON in the DataWeave (dw) Format

This example shows how JSON input is represented in the DataWeave (dw) format.

#### Input

The following JSON object serves as the input payload to the DataWeave source.

```json
{
  "name": "Matias",
  "age": 8,
  "male": true,
  "kids": null,
  "brothers": ["Pedro", "Sara"]
}
```

#### Source

The DataWeave script transforms the JSON input payload to the DataWeave (dw) format and MIME type.

```dataweave
output application/dw
---
payload
```

#### Output

Notice that only the keys of the JSON input and the `application/dw` output differ. The JSON keys
are surrounded by quotation marks. These DataWeave (dw) keys do not require quotation marks. See
[Valid Keys](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-extract-data#valid-keys) for details.

```dataweave
{
  name: "Matias",
  age: 8,
  male: true,
  kids: null,
  brothers: [
    "Pedro",
    "Sara"
  ]
}
```

### Example: Convert Repeated XML Elements to JSON

This example shows how to convert repeated XML elements to JSON.

Note that XML encodes collections using repeated (unbounded) elements. DataWeave represents
unbounded elements by repeating the same key.

#### Input

The following XML data contains repeating child elements with the key `name`. This XML serves as the
input payload to the DataWeave source.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<friends>
  <name>Mariano</name>
  <name>Shoki</name>
  <name>Tomo</name>
  <name>Ana</name>
</friends>
```

#### Source

The following DataWeave script takes the XML input as its payload and outputs that payload in the
JSON format.

The script selects the `name` elements from the XML input and uses the DataWeave `map` function to
map the values of those elements into an array of objects. Each object in the array takes the form
`{ name : item }`, where `item` is the value of the `name` element. The entire array serves as the
value of the `friends` key.

```dataweave
%dw 2.0
output application/json
---
friends: payload.friends.*name map (
            (item, index) -> {name: item}
         )
```

#### Output

The DataWeave script outputs the following JSON object.

```json
{
  "friends": [
    {
      "name": "Mariano"
    },
    {
      "name": "Shoki"
    },
    {
      "name": "Tomo"
    },
    {
      "name": "Ana"
    }
  ]
}
```

### Example: Stream JSON Data

To demonstrate streaming, the following example streams a JSON file by reading each element in an
array one at a time.

#### Input

The JSON input payload serves as input for the XML configuration.

JSON Input (truncated):

```json
{
  "myJsonExample": [
    {
      "name": "Shoki",
      "zipcode": "95838"
    },
    {
      "name": "Leandro",
      "zipcode": "95823"
    },
    {
      "name": "Mariano",
      "zipcode": "95815"
    },
    {
      "name": "Cristian",
      "zipcode": "95815"
    },
    {
      "name": "Kevin",
      "zipcode": "95824"
    },
    {
      "name": "Stanley",
      "zipcode": "95841"
    }
  ]
}
```

#### XML Configuration

The following XML configuration streams JSON input.

```xml
<file:config name="File_Config" doc:name="File Config" />
<flow name="dw-streaming-jsonFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="1" timeUnit="MINUTES"/>
    </scheduling-strategy>
  </scheduler>
  <file:read doc:name="Read"
     config-ref="File_Config"
     path="${app.home}/myjsonarray.json"
     outputMimeType="application/json; streaming=true"/>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
payload.myJsonExample map ((element) -> {
returnedElement : element.zipcode
})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
  <file:write doc:name="Write"
    path="/path/to/output/file/output.json"
    config-ref="File_Config1"/>
  <logger level="INFO" doc:name="Logger" message="#[payload]"/>
</flow>
```

- The streaming example configures the File Read operation to stream the JSON input by setting
  `outputMimeType="application/json; streaming=true"`. In the Studio UI, you can set the **MIME
  Type** on the listener to `application/json` and the **Parameters** for the MIME Type to **Key**
  `streaming` and **Value** `true`.

- The DataWeave script in the **Transform Message** component iterates over the array in the input
  payload and selects its `zipcode` values.

- The Write operation returns a file, `output.json`, which contains the result of the
  transformation.

- The Logger prints the same output payload that you see in `output.json`.

#### Output

The JSON streaming example produces a JSON array of objects.

```json
[
  {
    "returnedElement": "95838"
  },
  {
    "returnedElement": "95823"
  },
  {
    "returnedElement": "95815"
  },
  {
    "returnedElement": "95815"
  },
  {
    "returnedElement": "95824"
  },
  {
    "returnedElement": "95841"
  }
]
```

## Configuration Properties

DataWeave supports the following configuration properties for JSON.

### Reader Properties (for JSON)

The JSON format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>streaming</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Property for streaming input. Use only if entries are accessed sequentially. Valid values are <code>true</code> or <code>false</code>. The input must be a top-level array. For more on streaming in DataWeave, see <a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-formats#dw_readers_writers">DataWeave Readers</a>.</p></div></div></td></tr></tbody></table>

### Writer Properties (for JSON)

The JSON format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the writer buffer.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>When set to <code>true</code>, DataWeave generates the output as a data stream, and the script’s execution is deferred until it is consumed. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>duplicateKeyAsArray</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>If duplicate keys are detected in an object, the writer changes the value to an array with all those values. Valid values are <code>true</code> or <code>false</code>. Note that JSON language does not allow duplicate keys with one same parent, so the duplication usually raises an exception.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>UTF-8</code></p></td><td><div><div><p>The character set to use for the output.</p></div></div></td></tr><tr><td><p><code>indent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether to indent the JSON code for better readability or to compress the JSON into a single line. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>skipNullOn</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Skips <code>null</code> values in the specified data structure. By default, it does not skip the values. Valid values are <code>arrays</code>, <code>objects</code>, or <code>everywhere</code>.</p></div><div><ul><li><p><code>arrays</code><br>Ignore and omit <code>null</code> values inside arrays from the JSON output, for example, with <code>output application/json skipNullOn="arrays"</code>.</p></li><li><p><code>objects</code><br>Ignore key-value pairs that have <code>null</code> as the value, for example, with <code>output application/json skipNullOn="objects"</code>.</p></li><li><p><code>everywhere</code><br>Apply <code>skipNullOn</code> to arrays and objects, for example, <code>output application/json skipNullOn="everywhere"</code>.</p></li></ul></div></div></td></tr><tr><td><p><code>writeAttributes</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Indicates whether to add attributes of a key to children of the key. The new attribute key name will start with @. Valid options are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types (for JSON)

The JSON format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/json</code></p></td></tr><tr><td><p><code><strong>/</strong>+json</code></p></td></tr></tbody></table>

<!-- document id=264f4d4b61756ee8170ee0714a6d7c9b34e4a1dd9a75c9e35f936e077f266ef5 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-formats-json.md -->

---
product: DataWeave
version: 2.4
keywords: format, json, */json, */*+json, application/json
---

# JSON Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/json`

ID: `json`

In the JSON data format, values map one-to-one with DataWeave values. JSON supports `String`,
`Boolean`, `Number`, `Null`, `Object`, and `Array` types. DataWeave supports each of these values
natively.

The DataWeave reader for JSON input supports the following parsing strategies:

- Indexed

- In-Memory

- Streaming

To understand the parsing strategies that DataWeave readers and writers can apply to this format,
see [DataWeave Parsing Strategies](https://docs.mulesoft.com/dataweave/2.4/dataweave-formats#dw_readers_writers).

## Examples

The following examples show uses of the JSON format:

- [Example: Represent JSON in the DataWeave (dw) Format](#example1)

- [Example: Convert Repeated XML Elements to JSON](#example2)

- [Example: Stream JSON Data](#example3)

### Example: Represent JSON in the DataWeave (dw) Format

This example shows how JSON input is represented in the DataWeave (dw) format.

#### Input

The following JSON object serves as the input payload to the DataWeave source.

```json
{
  "name": "Matias",
  "age": 8,
  "male": true,
  "kids": null,
  "brothers": ["Pedro", "Sara"]
}
```

#### Source

The DataWeave script transforms the JSON input payload to the DataWeave (dw) format and MIME type.

```dataweave
output application/dw
---
payload
```

#### Output

Notice that only the keys of the JSON input and the `application/dw` output differ. The JSON keys
are surrounded by quotation marks. These DataWeave (dw) keys do not require quotation marks. See
[Valid Keys](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-extract-data#valid-keys) for details.

```dataweave
{
  name: "Matias",
  age: 8,
  male: true,
  kids: null,
  brothers: [
    "Pedro",
    "Sara"
  ]
}
```

### Example: Convert Repeated XML Elements to JSON

This example shows how to convert repeated XML elements to JSON.

Note that XML encodes collections using repeated (unbounded) elements. DataWeave represents
unbounded elements by repeating the same key.

#### Input

The following XML data contains repeating child elements with the key `name`. This XML serves as the
input payload to the DataWeave source.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<friends>
  <name>Mariano</name>
  <name>Shoki</name>
  <name>Tomo</name>
  <name>Ana</name>
</friends>
```

#### Source

The following DataWeave script takes the XML input as its payload and outputs that payload in the
JSON format.

The script selects the `name` elements from the XML input and uses the DataWeave `map` function to
map the values of those elements into an array of objects. Each object in the array takes the form
`{ name : item }`, where `item` is the value of the `name` element. The entire array serves as the
value of the `friends` key.

```dataweave
%dw 2.0
output application/json
---
friends: payload.friends.*name map (
            (item, index) -> {name: item}
         )
```

#### Output

The DataWeave script outputs the following JSON object.

```json
{
  "friends": [
    {
      "name": "Mariano"
    },
    {
      "name": "Shoki"
    },
    {
      "name": "Tomo"
    },
    {
      "name": "Ana"
    }
  ]
}
```

### Example: Stream JSON Data

To demonstrate streaming, the following example streams a JSON file by reading each element in an
array one at a time.

#### Input

The JSON input payload serves as input for the XML configuration.

JSON Input (truncated):

```json
{
  "myJsonExample": [
    {
      "name": "Shoki",
      "zipcode": "95838"
    },
    {
      "name": "Leandro",
      "zipcode": "95823"
    },
    {
      "name": "Mariano",
      "zipcode": "95815"
    },
    {
      "name": "Cristian",
      "zipcode": "95815"
    },
    {
      "name": "Kevin",
      "zipcode": "95824"
    },
    {
      "name": "Stanley",
      "zipcode": "95841"
    }
  ]
}
```

#### XML Configuration

The following XML configuration streams JSON input.

```xml
<file:config name="File_Config" doc:name="File Config" />
<flow name="dw-streaming-jsonFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="1" timeUnit="MINUTES"/>
    </scheduling-strategy>
  </scheduler>
  <file:read doc:name="Read"
     config-ref="File_Config"
     path="${app.home}/myjsonarray.json"
     outputMimeType="application/json; streaming=true"/>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
payload.myJsonExample map ((element) -> {
returnedElement : element.zipcode
})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
  <file:write doc:name="Write"
    path="/path/to/output/file/output.json"
    config-ref="File_Config1"/>
  <logger level="INFO" doc:name="Logger" message="#[payload]"/>
</flow>
```

- The streaming example configures the File Read operation to stream the JSON input by setting
  `outputMimeType="application/json; streaming=true"`. In the Studio UI, you can set the **MIME
  Type** on the listener to `application/json` and the **Parameters** for the MIME Type to **Key**
  `streaming` and **Value** `true`.

- The DataWeave script in the **Transform Message** component iterates over the array in the input
  payload and selects its `zipcode` values.

- The Write operation returns a file, `output.json`, which contains the result of the
  transformation.

- The Logger prints the same output payload that you see in `output.json`.

#### Output

The JSON streaming example produces a JSON array of objects.

```json
[
  {
    "returnedElement": "95838"
  },
  {
    "returnedElement": "95823"
  },
  {
    "returnedElement": "95815"
  },
  {
    "returnedElement": "95815"
  },
  {
    "returnedElement": "95824"
  },
  {
    "returnedElement": "95841"
  }
]
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>streaming</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Streams input when set to <code>true</code>. Use only if entries are accessed sequentially. The input must be a top-level array.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>duplicateKeyAsArray</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Converts the values of duplicate keys in an object to a single array of values to the duplicated key.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>'UTF-8'</code></p></td><td><div><div><p>The character set to use for the output, such as UTF-8.</p></div></div></td></tr><tr><td><p><code>indent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Write indented output for better readability by default, or compress output into a single line when set to <code>false</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>skipNullOn</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Skips <code>null</code> values in the specified data structure. By default, DataWeave does not skip the values.</p></div><div><ul><li><p><code>arrays</code> + Ignore and omit <code>null</code> values inside arrays from the JSON output, for example, with <code>output application/json skipNullOn="arrays"</code>.</p></li><li><p><code>objects</code> + Ignore key-value pairs that have <code>null</code> as the value, for example, with <code>output application/json skipNullOn="objects"</code>.</p></li><li><p><code>everywhere</code> + Apply <code>skipNullOn</code> to arrays and objects, for example, <code>output application/json skipNullOn="everywhere"</code>.</p></li></ul></div><div><p>Valid values are <code>arrays</code> or <code>objects</code> or <code>everywhere</code>.</p></div></div></td></tr><tr><td><p><code>writeAttributes</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Converts attributes of a key into child key-value pairs of that key. The attribute key name starts with @.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/json</code></p></td></tr><tr><td><p><code><strong>/</strong>+json</code></p></td></tr></tbody></table>

<!-- document id=5a1556cc06414e7e6ae7707d894b81eb2946a1acc6157c314435a747f2f2a933 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-formats-json.md -->

---
product: DataWeave
version: 2.6
keywords: format, json, */json, */*+json, application/json
---

# JSON Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/json`

ID: `json`

In the JSON data format, values map one-to-one with DataWeave values. JSON supports `String`,
`Boolean`, `Number`, `Null`, `Object`, and `Array` types. DataWeave supports each of these values
natively.

The DataWeave reader for JSON input supports the following parsing strategies:

- Indexed

- In-Memory

- Streaming

To understand the parsing strategies that DataWeave readers and writers can apply to this format,
see [DataWeave Parsing Strategies](https://docs.mulesoft.com/dataweave/2.6/dataweave-formats#dw_readers_writers).

## Examples

The following examples show uses of the JSON format:

- [Example: Represent JSON in the DataWeave (dw) Format](#example1)

- [Example: Convert Repeated XML Elements to JSON](#example2)

- [Example: Stream JSON Data](#example3)

### Example: Represent JSON in the DataWeave (dw) Format

This example shows how JSON input is represented in the DataWeave (dw) format.

#### Input

The following JSON object serves as the input payload to the DataWeave source.

```json
{
  "name": "Matias",
  "age": 8,
  "male": true,
  "kids": null,
  "brothers": ["Pedro", "Sara"]
}
```

#### Source

The DataWeave script transforms the JSON input payload to the DataWeave (dw) format and MIME type.

```dataweave
output application/dw
---
payload
```

#### Output

Notice that only the keys of the JSON input and the `application/dw` output differ. The JSON keys
are surrounded by quotation marks. These DataWeave (dw) keys do not require quotation marks. See
[Valid Keys](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-extract-data#valid-keys) for details.

```dataweave
{
  name: "Matias",
  age: 8,
  male: true,
  kids: null,
  brothers: [
    "Pedro",
    "Sara"
  ]
}
```

### Example: Convert Repeated XML Elements to JSON

This example shows how to convert repeated XML elements to JSON.

Note that XML encodes collections using repeated (unbounded) elements. DataWeave represents
unbounded elements by repeating the same key.

#### Input

The following XML data contains repeating child elements with the key `name`. This XML serves as the
input payload to the DataWeave source.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<friends>
  <name>Mariano</name>
  <name>Shoki</name>
  <name>Tomo</name>
  <name>Ana</name>
</friends>
```

#### Source

The following DataWeave script takes the XML input as its payload and outputs that payload in the
JSON format.

The script selects the `name` elements from the XML input and uses the DataWeave `map` function to
map the values of those elements into an array of objects. Each object in the array takes the form
`{ name : item }`, where `item` is the value of the `name` element. The entire array serves as the
value of the `friends` key.

```dataweave
%dw 2.0
output application/json
---
friends: payload.friends.*name map (
            (item, index) -> {name: item}
         )
```

#### Output

The DataWeave script outputs the following JSON object.

```json
{
  "friends": [
    {
      "name": "Mariano"
    },
    {
      "name": "Shoki"
    },
    {
      "name": "Tomo"
    },
    {
      "name": "Ana"
    }
  ]
}
```

### Example: Stream JSON Data

To demonstrate streaming, the following example streams a JSON file by reading each element in an
array one at a time.

#### Input

The JSON input payload serves as input for the XML configuration.

JSON Input (truncated):

```json
{
  "myJsonExample": [
    {
      "name": "Shoki",
      "zipcode": "95838"
    },
    {
      "name": "Leandro",
      "zipcode": "95823"
    },
    {
      "name": "Mariano",
      "zipcode": "95815"
    },
    {
      "name": "Cristian",
      "zipcode": "95815"
    },
    {
      "name": "Kevin",
      "zipcode": "95824"
    },
    {
      "name": "Stanley",
      "zipcode": "95841"
    }
  ]
}
```

#### XML Configuration

The following XML configuration streams JSON input.

```xml
<file:config name="File_Config" doc:name="File Config" />
<flow name="dw-streaming-jsonFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="1" timeUnit="MINUTES"/>
    </scheduling-strategy>
  </scheduler>
  <file:read doc:name="Read"
     config-ref="File_Config"
     path="${app.home}/myjsonarray.json"
     outputMimeType="application/json; streaming=true"/>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
payload.myJsonExample map ((element) -> {
returnedElement : element.zipcode
})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
  <file:write doc:name="Write"
    path="/path/to/output/file/output.json"
    config-ref="File_Config1"/>
  <logger level="INFO" doc:name="Logger" message="#[payload]"/>
</flow>
```

- The streaming example configures the File Read operation to stream the JSON input by setting
  `outputMimeType="application/json; streaming=true"`. In the Studio UI, you can set the **MIME
  Type** on the listener to `application/json` and the **Parameters** for the MIME Type to **Key**
  `streaming` and **Value** `true`.

- The DataWeave script in the **Transform Message** component iterates over the array in the input
  payload and selects its `zipcode` values.

- The Write operation returns a file, `output.json`, which contains the result of the
  transformation.

- The Logger prints the same output payload that you see in `output.json`.

#### Output

The JSON streaming example produces a JSON array of objects.

```json
[
  {
    "returnedElement": "95838"
  },
  {
    "returnedElement": "95823"
  },
  {
    "returnedElement": "95815"
  },
  {
    "returnedElement": "95815"
  },
  {
    "returnedElement": "95824"
  },
  {
    "returnedElement": "95841"
  }
]
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>streaming</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Streams input when set to <code>true</code>. Use only if entries are accessed sequentially. The input must be a top-level array. See the <a href="#example2">streaming example</a>, and see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats#dw_readers_writers">DataWeave Readers</a>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>duplicateKeyAsArray</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Converts the values of duplicate keys in an object to a single array of values to the duplicated key.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>'UTF-8'</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr><tr><td><p><code>indent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Write indented output for better readability by default, or compress output into a single line when set to <code>false</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>skipNullOn</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Skips <code>null</code> values in the specified data structure. By default, DataWeave does not skip the values.</p></div><div><ul><li><p><code>arrays</code> + Ignore and omit <code>null</code> values inside arrays from the JSON output, for example, with <code>output application/json skipNullOn="arrays"</code>.</p></li><li><p><code>objects</code> + Ignore key-value pairs that have <code>null</code> as the value, for example, with <code>output application/json skipNullOn="objects"</code>.</p></li><li><p><code>everywhere</code> + Apply <code>skipNullOn</code> to arrays and objects, for example, <code>output application/json skipNullOn="everywhere"</code>.</p></li></ul></div><div><p>Valid values are <code>arrays</code> or <code>objects</code> or <code>everywhere</code>.</p></div></div></td></tr><tr><td><p><code>writeAttributes</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Converts attributes of a key into child key-value pairs of that key. The attribute key name starts with @.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/json</code></p></td></tr><tr><td><p><code><strong>/</strong>+json</code></p></td></tr></tbody></table>

<!-- document id=6a4aceab921a1681374d2b757a31a4e732e7cb1ce58a23e1d669550400ac40a2 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-formats-json.md -->

---
product: DataWeave
version: 2.9
keywords: format, json, */json, */*+json, application/json
---

# JSON Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/json`

ID: `json`

In the JSON data format, values map one-to-one with DataWeave values. JSON supports `String`,
`Boolean`, `Number`, `Null`, `Object`, and `Array` types. DataWeave supports each of these values
natively.

The DataWeave reader for JSON input supports the following parsing strategies:

- Indexed

- In-Memory

- Streaming

To understand the parsing strategies that DataWeave readers and writers can apply to this format,
see [DataWeave Parsing Strategies](https://docs.mulesoft.com/dataweave/2.9/dataweave-formats#dw_readers_writers).

## Examples

The following examples show uses of the JSON format:

- [Example: Represent JSON in the DataWeave (dw) Format](#example1)

- [Example: Convert Repeated XML Elements to JSON](#example2)

- [Example: Stream JSON Data](#example3)

### Example: Represent JSON in the DataWeave (dw) Format

This example shows how JSON input is represented in the DataWeave (dw) format.

#### Input

The following JSON object serves as the input payload to the DataWeave source.

```json
{
  "name": "Matias",
  "age": 8,
  "male": true,
  "kids": null,
  "brothers": ["Pedro", "Sara"]
}
```

#### Source

The DataWeave script transforms the JSON input payload to the DataWeave (dw) format and MIME type.

```dataweave
output application/dw
---
payload
```

#### Output

Notice that only the keys of the JSON input and the `application/dw` output differ. The JSON keys
are surrounded by quotation marks. These DataWeave (dw) keys do not require quotation marks. See
[Valid Keys](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-extract-data#valid-keys) for details.

```dataweave
{
  name: "Matias",
  age: 8,
  male: true,
  kids: null,
  brothers: [
    "Pedro",
    "Sara"
  ]
}
```

### Example: Convert Repeated XML Elements to JSON

This example shows how to convert repeated XML elements to JSON.

Note that XML encodes collections using repeated (unbounded) elements. DataWeave represents
unbounded elements by repeating the same key.

#### Input

The following XML data contains repeating child elements with the key `name`. This XML serves as the
input payload to the DataWeave source.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<friends>
  <name>Mariano</name>
  <name>Shoki</name>
  <name>Tomo</name>
  <name>Ana</name>
</friends>
```

#### Source

The following DataWeave script takes the XML input as its payload and outputs that payload in the
JSON format.

The script selects the `name` elements from the XML input and uses the DataWeave `map` function to
map the values of those elements into an array of objects. Each object in the array takes the form
`{ name : item }`, where `item` is the value of the `name` element. The entire array serves as the
value of the `friends` key.

```dataweave
%dw 2.0
output application/json
---
friends: payload.friends.*name map (
            (item, index) -> {name: item}
         )
```

#### Output

The DataWeave script outputs the following JSON object.

```json
{
  "friends": [
    {
      "name": "Mariano"
    },
    {
      "name": "Shoki"
    },
    {
      "name": "Tomo"
    },
    {
      "name": "Ana"
    }
  ]
}
```

### Example: Stream JSON Data

To demonstrate streaming, the following example streams a JSON file by reading each element in an
array one at a time.

#### Input

The JSON input payload serves as input for the XML configuration.

JSON Input (truncated):

```json
{
  "myJsonExample": [
    {
      "name": "Shoki",
      "zipcode": "95838"
    },
    {
      "name": "Leandro",
      "zipcode": "95823"
    },
    {
      "name": "Mariano",
      "zipcode": "95815"
    },
    {
      "name": "Cristian",
      "zipcode": "95815"
    },
    {
      "name": "Kevin",
      "zipcode": "95824"
    },
    {
      "name": "Stanley",
      "zipcode": "95841"
    }
  ]
}
```

#### XML Configuration

The following XML configuration streams JSON input.

```xml
<file:config name="File_Config" doc:name="File Config" />
<flow name="dw-streaming-jsonFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="1" timeUnit="MINUTES"/>
    </scheduling-strategy>
  </scheduler>
  <file:read doc:name="Read"
     config-ref="File_Config"
     path="${app.home}/myjsonarray.json"
     outputMimeType="application/json; streaming=true"/>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
payload.myJsonExample map ((element) -> {
returnedElement : element.zipcode
})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
  <file:write doc:name="Write"
    path="/path/to/output/file/output.json"
    config-ref="File_Config1"/>
  <logger level="INFO" doc:name="Logger" message="#[payload]"/>
</flow>
```

- The streaming example configures the File Read operation to stream the JSON input by setting
  `outputMimeType="application/json; streaming=true"`. In the Studio UI, you can set the **MIME
  Type** on the listener to `application/json` and the **Parameters** for the MIME Type to **Key**
  `streaming` and **Value** `true`.

- The DataWeave script in the **Transform Message** component iterates over the array in the input
  payload and selects its `zipcode` values.

- The Write operation returns a file, `output.json`, which contains the result of the
  transformation.

- The Logger prints the same output payload that you see in `output.json`.

#### Output

The JSON streaming example produces a JSON array of objects.

```json
[
  {
    "returnedElement": "95838"
  },
  {
    "returnedElement": "95823"
  },
  {
    "returnedElement": "95815"
  },
  {
    "returnedElement": "95815"
  },
  {
    "returnedElement": "95824"
  },
  {
    "returnedElement": "95841"
  }
]
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>streaming</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Streams input when set to <code>true</code>. Use only if entries are accessed sequentially. The input must be a top-level array. See the <a href="#example2">streaming example</a>, and see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats#dw_readers_writers">DataWeave Readers</a>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>duplicateKeyAsArray</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Converts the values of duplicate keys in an object to a single array of values to the duplicated key.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>'UTF-8'</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr><tr><td><p><code>indent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Write indented output for better readability by default, or compress output into a single line when set to <code>false</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>skipNullOn</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Skips <code>null</code> values in the specified data structure. By default, DataWeave does not skip the values.</p></div><div><ul><li><p><code>arrays</code> + Ignore and omit <code>null</code> values inside arrays from the JSON output, for example, with <code>output application/json skipNullOn="arrays"</code>.</p></li><li><p><code>objects</code> + Ignore key-value pairs that have <code>null</code> as the value, for example, with <code>output application/json skipNullOn="objects"</code>.</p></li><li><p><code>everywhere</code> + Apply <code>skipNullOn</code> to arrays and objects, for example, <code>output application/json skipNullOn="everywhere"</code>.</p></li></ul></div><div><p>Valid values are <code>arrays</code> or <code>objects</code> or <code>everywhere</code>.</p></div></div></td></tr><tr><td><p><code>writeAttributes</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Converts attributes of a key into child key-value pairs of that key. The attribute key name starts with @.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/json</code></p></td></tr><tr><td><p><code><strong>/</strong>+json</code></p></td></tr></tbody></table>

<!-- document id=900e7c02ac9b5e455c8c832d495d79a657333d6d08cd47a36332774d78008993 url=/mulesoft/current/en-us/dataweave/latest/dataweave-formats-json.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: format, json, */json, */*+json, application/json
---

# JSON Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/json`

ID: `json`

In the JSON data format, values map one-to-one with DataWeave values. JSON supports `String`,
`Boolean`, `Number`, `Null`, `Object`, and `Array` types. DataWeave supports each of these values
natively.

The DataWeave reader for JSON input supports the following parsing strategies:

- Indexed

- In-Memory

- Streaming

To understand the parsing strategies that DataWeave readers and writers can apply to this format,
see [DataWeave Parsing Strategies](https://docs.mulesoft.com/dataweave/latest/dataweave-formats#dw_readers_writers).

## Examples

The following examples show uses of the JSON format:

- [Example: Represent JSON in the DataWeave (dw) Format](#example1)

- [Example: Convert Repeated XML Elements to JSON](#example2)

- [Example: Stream JSON Data](#example3)

### Example: Represent JSON in the DataWeave (dw) Format

This example shows how JSON input is represented in the DataWeave (dw) format.

#### Input

The following JSON object serves as the input payload to the DataWeave source.

```json
{
  "name": "Matias",
  "age": 8,
  "male": true,
  "kids": null,
  "brothers": ["Pedro", "Sara"]
}
```

#### Source

The DataWeave script transforms the JSON input payload to the DataWeave (dw) format and MIME type.

```dataweave
output application/dw
---
payload
```

#### Output

Notice that only the keys of the JSON input and the `application/dw` output differ. The JSON keys
are surrounded by quotation marks. These DataWeave (dw) keys do not require quotation marks. See
[Valid Keys](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-extract-data#valid-keys) for details.

```dataweave
{
  name: "Matias",
  age: 8,
  male: true,
  kids: null,
  brothers: [
    "Pedro",
    "Sara"
  ]
}
```

### Example: Convert Repeated XML Elements to JSON

This example shows how to convert repeated XML elements to JSON.

Note that XML encodes collections using repeated (unbounded) elements. DataWeave represents
unbounded elements by repeating the same key.

#### Input

The following XML data contains repeating child elements with the key `name`. This XML serves as the
input payload to the DataWeave source.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<friends>
  <name>Mariano</name>
  <name>Shoki</name>
  <name>Tomo</name>
  <name>Ana</name>
</friends>
```

#### Source

The following DataWeave script takes the XML input as its payload and outputs that payload in the
JSON format.

The script selects the `name` elements from the XML input and uses the DataWeave `map` function to
map the values of those elements into an array of objects. Each object in the array takes the form
`{ name : item }`, where `item` is the value of the `name` element. The entire array serves as the
value of the `friends` key.

```dataweave
%dw 2.0
output application/json
---
friends: payload.friends.*name map (
            (item, index) -> {name: item}
         )
```

#### Output

The DataWeave script outputs the following JSON object.

```json
{
  "friends": [
    {
      "name": "Mariano"
    },
    {
      "name": "Shoki"
    },
    {
      "name": "Tomo"
    },
    {
      "name": "Ana"
    }
  ]
}
```

### Example: Stream JSON Data

To demonstrate streaming, the following example streams a JSON file by reading each element in an
array one at a time.

#### Input

The JSON input payload serves as input for the XML configuration.

JSON Input (truncated):

```json
{
  "myJsonExample": [
    {
      "name": "Shoki",
      "zipcode": "95838"
    },
    {
      "name": "Leandro",
      "zipcode": "95823"
    },
    {
      "name": "Mariano",
      "zipcode": "95815"
    },
    {
      "name": "Cristian",
      "zipcode": "95815"
    },
    {
      "name": "Kevin",
      "zipcode": "95824"
    },
    {
      "name": "Stanley",
      "zipcode": "95841"
    }
  ]
}
```

#### XML Configuration

The following XML configuration streams JSON input.

```xml
<file:config name="File_Config" doc:name="File Config" />
<flow name="dw-streaming-jsonFlow" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="1" timeUnit="MINUTES"/>
    </scheduling-strategy>
  </scheduler>
  <file:read doc:name="Read"
     config-ref="File_Config"
     path="${app.home}/myjsonarray.json"
     outputMimeType="application/json; streaming=true"/>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
payload.myJsonExample map ((element) -> {
returnedElement : element.zipcode
})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
  <file:write doc:name="Write"
    path="/path/to/output/file/output.json"
    config-ref="File_Config1"/>
  <logger level="INFO" doc:name="Logger" message="#[payload]"/>
</flow>
```

- The streaming example configures the File Read operation to stream the JSON input by setting
  `outputMimeType="application/json; streaming=true"`. In the Studio UI, you can set the **MIME
  Type** on the listener to `application/json` and the **Parameters** for the MIME Type to **Key**
  `streaming` and **Value** `true`.

- The DataWeave script in the **Transform Message** component iterates over the array in the input
  payload and selects its `zipcode` values.

- The Write operation returns a file, `output.json`, which contains the result of the
  transformation.

- The Logger prints the same output payload that you see in `output.json`.

#### Output

The JSON streaming example produces a JSON array of objects.

```json
[
  {
    "returnedElement": "95838"
  },
  {
    "returnedElement": "95823"
  },
  {
    "returnedElement": "95815"
  },
  {
    "returnedElement": "95815"
  },
  {
    "returnedElement": "95824"
  },
  {
    "returnedElement": "95841"
  }
]
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>streaming</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Streams input when set to <code>true</code>. Use only if entries are accessed sequentially. The input must be a top-level array. See the <a href="#example2">streaming example</a>, and see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats#dw_readers_writers">DataWeave Readers</a>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>duplicateKeyAsArray</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Converts the values of duplicate keys in an object to a single array of values to the duplicated key.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>'UTF-8'</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr><tr><td><p><code>indent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Write indented output for better readability by default, or compress output into a single line when set to <code>false</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>skipNullOn</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Skips <code>null</code> values in the specified data structure. By default, DataWeave does not skip the values.</p></div><div><ul><li><p><code>arrays</code> + Ignore and omit <code>null</code> values inside arrays from the JSON output, for example, with <code>output application/json skipNullOn="arrays"</code>.</p></li><li><p><code>objects</code> + Ignore key-value pairs that have <code>null</code> as the value, for example, with <code>output application/json skipNullOn="objects"</code>.</p></li><li><p><code>everywhere</code> + Apply <code>skipNullOn</code> to arrays and objects, for example, <code>output application/json skipNullOn="everywhere"</code>.</p></li></ul></div><div><p>Valid values are <code>arrays</code> or <code>objects</code> or <code>everywhere</code>.</p></div></div></td></tr><tr><td><p><code>writeAttributes</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Converts attributes of a key into child key-value pairs of that key. The attribute key name starts with @.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/json</code></p></td></tr><tr><td><p><code><strong>/</strong>+json</code></p></td></tr></tbody></table>

<!-- document id=de77b2caae08efa8f99d5f7c1afd7fb43153a05eb676267a2415a3e056309af2 url=/mulesoft/current/en-us/dataweave/latest/dw-hmac-functions-jwt.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# JWT

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## JWT(header: Object, payload: Object, signingKey: String, algorithm: String): String

Generate JWT with header, payload, and signature by specific algorithm.

_Introduced in DataWeave version 2.6.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>header</code></p></td><td><p><code>Object</code></p></td><td><p>JWT header.</p></td></tr><tr><td><p><code>payload</code></p></td><td><p><code>Object</code></p></td><td><p>JWT payload.</p></td></tr><tr><td><p><code>signingKey</code></p></td><td><p><code>String</code></p></td><td><p>Signing key.</p></td></tr><tr><td><p><code>algorithm</code></p></td><td><p><code>String</code></p></td><td><p>HMAC algorithm.</p></td></tr></tbody></table>

### Example

This example signs a payload with HS384 and a 384-bit key.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::jwt::HMAC
output application/json
---
JWT({"header": "value"}, {"firstName": "Michael", "lastName": "Jones"},
  "012345678901234567890123456789012345678901234567", "HmacSHA384")
```

#### Output

```Json
"eyJoZWFkZXIiOiAidmFsdWUiLCJhbGciOiAiSFMzODQiLCJ0eXAiOiAiSldUIn0.eyJmaXJzdE5hbWUiOiAiTWljaGFlbCIsImxhc3ROYW1lIjogIkpvbmVzIn0.F1xP9JjXqmwVfPXULZ7F6EYu2Td36eW4xUWElGHN7ayjWIiBPWM3L4STPQzQ570R"
```

## JWT(header: Object, payload: Object, signingKey: String): String

Generate JWT with a header, payload, and key signed with HMAC-SHA256.

_Introduced in DataWeave version 2.6.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>header</code></p></td><td><p><code>Object</code></p></td><td><p>JWT header.</p></td></tr><tr><td><p><code>payload</code></p></td><td><p><code>Object</code></p></td><td><p>JWT payload.</p></td></tr><tr><td><p><code>signingKey</code></p></td><td><p><code>String</code></p></td><td><p>Signing key.</p></td></tr></tbody></table>

### Example

This example uses HS256 and a 256-bit key.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::jwt::HMAC
output application/json
---
JWT({"header": "value"}, {"firstName": "Michael", "lastName": "Jones"},
  "01234567890123456789012345678901")
```

#### Output

```Json
"eyJoZWFkZXIiOiAidmFsdWUiLCJhbGciOiAiSFMyNTYiLCJ0eXAiOiAiSldUIn0.eyJmaXJzdE5hbWUiOiAiTWljaGFlbCIsImxhc3ROYW1lIjogIkpvbmVzIn0.wAoUwkmKhZy6Op119t0N5MwQX-03fJZClzfA5lFwEhg"
```

## JWT(payload: Object, signingKey: String): String

Generate JWT with a payload, automatically generated header, and key signed with HMAC-SHA256.

_Introduced in DataWeave version 2.6.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>payload</code></p></td><td><p><code>Object</code></p></td><td><p>JWT payload.</p></td></tr><tr><td><p><code>signingKey</code></p></td><td><p><code>String</code></p></td><td><p>Signing key.</p></td></tr></tbody></table>

### Example

This example signs a payload with the default HS256 algorithm.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::jwt::HMAC
output application/json
---
JWT({"firstName": "Michael", "lastName": "Jones"},
  "01234567890123456789012345678901")
```

#### Output

```Json
"eyJhbGciOiAiSFMyNTYiLCJ0eXAiOiAiSldUIn0.eyJmaXJzdE5hbWUiOiAiTWljaGFlbCIsImxhc3ROYW1lIjogIkpvbmVzIn0.JaEz34HXuF4fWg5jM2U9JRnX4vu5twoeDRRg9_anWMc"
```

<!-- document id=92e4fea9c09be89005504918277627dd2e663d44faba6850e305a231a9452f4c url=/mulesoft/current/en-us/dataweave/latest/dw-rsa-functions-jwt.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# JWT

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## JWT(header: Object, payload: Object, signingKey: String, algorithm: String): String

Generate JWT with header, payload, and signature by specific algorithm.

_Introduced in DataWeave version 2.6.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>header</code></p></td><td><p><code>Object</code></p></td><td><p>JWT header.</p></td></tr><tr><td><p><code>payload</code></p></td><td><p><code>Object</code></p></td><td><p>JWT payload.</p></td></tr><tr><td><p><code>signingKey</code></p></td><td><p><code>String</code></p></td><td><p>RSA private key in PEM format.</p></td></tr><tr><td><p><code>algorithm</code></p></td><td><p><code>String</code></p></td><td><p>RSA algorithm, such as <code>Sha384withRSA</code>.</p></td></tr></tbody></table>

### Example

Supply `key` as a JSON string containing an unencrypted RSA private key with a modulus of at least
2048 bits. This example signs with RS384.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::jwt::RSA
output application/json
input key application/json
---
JWT({kid: "example"}, {sub: "test"}, key, "Sha384withRSA")
```

#### Output

The exact signature depends on `key`.

```Json
"<base64url-header>.<base64url-payload>.<base64url-signature>"
```

## JWT(payload: Object, signingKey: String): String

Generate JWT with a payload, automatically generated header, and key signed with RS256.

_Introduced in DataWeave version 2.6.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>payload</code></p></td><td><p><code>Object</code></p></td><td><p>JWT payload.</p></td></tr><tr><td><p><code>signingKey</code></p></td><td><p><code>String</code></p></td><td><p>RSA private key in PEM format.</p></td></tr></tbody></table>

### Example

Supply `key` as a JSON string containing an unencrypted RSA private key with a modulus of at least
2048 bits. This example signs with RS256.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::jwt::RSA
output application/json
input key application/json
---
JWT({sub: "test"}, key)
```

#### Output

The exact signature depends on `key`.

```Json
"<base64url-header>.<base64url-payload>.<base64url-signature>"
```

<!-- document id=8a9c5bea17b8e0a85f6feee596d65d49cf5f1e4d0c17c90f4fcc504e9b2ce54b url=/mulesoft/current/en-us/dataweave/2.11/dw-objects-functions-keyset.md -->

---
product: DataWeave
version: 2.11
---

# keySet

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## keySet<K, V>(obj: { (K)?: V }): Array<K>

Returns an array of key names from an object.

_This function is **Deprecated**. Use [dw::Core::keysOf](https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-keysof), instead._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the keys from the input object.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Objects
output application/json
---
{ "keySet" : keySet({ "a" : true, "b" : 1}) }
```

#### Output

```JSON
{ "keySet" : ["a","b"] }
```

### Example

This example illustrates a difference between `keySet` and `nameSet`. Notice that `keySet` retains
the attributes (`name` and `lastName`) and namespaces (`xmlns`) from the XML input, while `nameSet`
returns `null` for them because it does not retain them.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Objects
var myVar = read('<users xmlns="http://test.com">
                     <user name="Mariano" lastName="Achaval"/>
                     <user name="Stacey" lastName="Duke"/>
                  </users>', 'application/xml')
output application/json
---
{ keySetExample: flatten([keySet(myVar.users) map $.#,
                          keySet(myVar.users) map $.@])
}
++
{ nameSet: flatten([nameSet(myVar.users) map $.#,
                    nameSet(myVar.users) map $.@])
}
```

#### Output

```JSON
{
  "keySet": [
    "http://test.com",
    "http://test.com",
    {
      "name": "Mariano",
      "lastName": "Achaval"
    },
    {
      "name": "Stacey",
      "lastName": "Duke"
    }
  ],
  "nameSet": [
    null,
    null,
    null,
    null
  ]
}
```

<!-- document id=742e4de646f2b410ad48a4846878cc0739ae7b934164e65e3e9a73edf9aeefaa url=/mulesoft/current/en-us/dataweave/2.12/dw-objects-functions-keyset.md -->

---
product: DataWeave
version: 2.12
---

# keySet

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## keySet<K, V>(obj: { (K)?: V }): Array<K>

Returns an array of key names from an object.

_This function is **Deprecated**. Use [dw::Core::keysOf](https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-keysof), instead._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the keys from the input object.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Objects
output application/json
---
{ "keySet" : keySet({ "a" : true, "b" : 1}) }
```

#### Output

```JSON
{ "keySet" : ["a","b"] }
```

### Example

This example illustrates a difference between `keySet` and `nameSet`. Notice that `keySet` retains
the attributes (`name` and `lastName`) and namespaces (`xmlns`) from the XML input, while `nameSet`
returns `null` for them because it does not retain them.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Objects
var myVar = read('<users xmlns="http://test.com">
                     <user name="Mariano" lastName="Achaval"/>
                     <user name="Stacey" lastName="Duke"/>
                  </users>', 'application/xml')
output application/json
---
{ keySetExample: flatten([keySet(myVar.users) map $.#,
                          keySet(myVar.users) map $.@])
}
++
{ nameSet: flatten([nameSet(myVar.users) map $.#,
                    nameSet(myVar.users) map $.@])
}
```

#### Output

```JSON
{
  "keySet": [
    "http://test.com",
    "http://test.com",
    {
      "name": "Mariano",
      "lastName": "Achaval"
    },
    {
      "name": "Stacey",
      "lastName": "Duke"
    }
  ],
  "nameSet": [
    null,
    null,
    null,
    null
  ]
}
```

<!-- document id=8bd1531441efe77277f4313471b9e225ce5b8ab03615696aa66729d41c00f9af url=/mulesoft/current/en-us/dataweave/2.3/dw-objects-functions-keyset.md -->

---
product: DataWeave
version: 2.3
---

# keySet

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## keySet(T): ?

Returns an array of key names from an object.

This method is **Deprecated**. Use `keysOf` from Core module, instead.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the keys from the input object.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Objects
output application/json
---
{ "keySet" : keySet({ "a" : true, "b" : 1}) }
```

#### Output

```JSON
{ "keySet" : ["a","b"] }
```

### Example

This example illustrates a difference between `keySet` and `nameSet`. Notice that `keySet` retains
the attributes (`name` and `lastName`) and namespaces (`xmlns`) from the XML input, while `nameSet`
returns `null` for them because it does not retain them.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Objects
var myVar = read('<users xmlns="http://test.com">
                     <user name="Mariano" lastName="Achaval"/>
                     <user name="Stacey" lastName="Duke"/>
                  </users>', 'application/xml')
output application/json
---
{ keySetExample: flatten([keySet(myVar.users) map $.#,
                          keySet(myVar.users) map $.@])
}
++
{ nameSet: flatten([nameSet(myVar.users) map $.#,
                    nameSet(myVar.users) map $.@])
}
```

#### Output

```JSON
{
  "keySet": [
    "http://test.com",
    "http://test.com",
    {
      "name": "Mariano",
      "lastName": "Achaval"
    },
    {
      "name": "Stacey",
      "lastName": "Duke"
    }
  ],
  "nameSet": [
    null,
    null,
    null,
    null
  ]
}
```

<!-- document id=977c4a72e692840024a069cdf8dcde9d815c21128f613a9efe40d5f8f5ff8487 url=/mulesoft/current/en-us/dataweave/2.4/dw-objects-functions-keyset.md -->

---
product: DataWeave
version: 2.4
---

# keySet

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## keySet<K, V>(obj: { (K)?: V }): Array<K>

Returns an array of key names from an object.

_This function is **Deprecated**. Use [dw::Core::keysOf](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-keysof), instead._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the keys from the input object.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Objects
output application/json
---
{ "keySet" : keySet({ "a" : true, "b" : 1}) }
```

#### Output

```JSON
{ "keySet" : ["a","b"] }
```

### Example

This example illustrates a difference between `keySet` and `nameSet`. Notice that `keySet` retains
the attributes (`name` and `lastName`) and namespaces (`xmlns`) from the XML input, while `nameSet`
returns `null` for them because it does not retain them.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Objects
var myVar = read('<users xmlns="http://test.com">
                     <user name="Mariano" lastName="Achaval"/>
                     <user name="Stacey" lastName="Duke"/>
                  </users>', 'application/xml')
output application/json
---
{ keySetExample: flatten([keySet(myVar.users) map $.#,
                          keySet(myVar.users) map $.@])
}
++
{ nameSet: flatten([nameSet(myVar.users) map $.#,
                    nameSet(myVar.users) map $.@])
}
```

#### Output

```JSON
{
  "keySet": [
    "http://test.com",
    "http://test.com",
    {
      "name": "Mariano",
      "lastName": "Achaval"
    },
    {
      "name": "Stacey",
      "lastName": "Duke"
    }
  ],
  "nameSet": [
    null,
    null,
    null,
    null
  ]
}
```

<!-- document id=8a130631c3fecaf75f3b8ceb833514ee870b8504b53b4fde571742f0a508a5fc url=/mulesoft/current/en-us/dataweave/2.6/dw-objects-functions-keyset.md -->

---
product: DataWeave
version: 2.6
---

# keySet

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## keySet<K, V>(obj: { (K)?: V }): Array<K>

Returns an array of key names from an object.

_This function is **Deprecated**. Use [dw::Core::keysOf](https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-keysof), instead._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the keys from the input object.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Objects
output application/json
---
{ "keySet" : keySet({ "a" : true, "b" : 1}) }
```

#### Output

```JSON
{ "keySet" : ["a","b"] }
```

### Example

This example illustrates a difference between `keySet` and `nameSet`. Notice that `keySet` retains
the attributes (`name` and `lastName`) and namespaces (`xmlns`) from the XML input, while `nameSet`
returns `null` for them because it does not retain them.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Objects
var myVar = read('<users xmlns="http://test.com">
                     <user name="Mariano" lastName="Achaval"/>
                     <user name="Stacey" lastName="Duke"/>
                  </users>', 'application/xml')
output application/json
---
{ keySetExample: flatten([keySet(myVar.users) map $.#,
                          keySet(myVar.users) map $.@])
}
++
{ nameSet: flatten([nameSet(myVar.users) map $.#,
                    nameSet(myVar.users) map $.@])
}
```

#### Output

```JSON
{
  "keySet": [
    "http://test.com",
    "http://test.com",
    {
      "name": "Mariano",
      "lastName": "Achaval"
    },
    {
      "name": "Stacey",
      "lastName": "Duke"
    }
  ],
  "nameSet": [
    null,
    null,
    null,
    null
  ]
}
```

<!-- document id=f536af2a3aea76857f52de52c2fb447ec7780774838d95d7b99a01b0c14687f9 url=/mulesoft/current/en-us/dataweave/2.9/dw-objects-functions-keyset.md -->

---
product: DataWeave
version: 2.9
---

# keySet

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## keySet<K, V>(obj: { (K)?: V }): Array<K>

Returns an array of key names from an object.

_This function is **Deprecated**. Use [dw::Core::keysOf](https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-keysof), instead._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the keys from the input object.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Objects
output application/json
---
{ "keySet" : keySet({ "a" : true, "b" : 1}) }
```

#### Output

```JSON
{ "keySet" : ["a","b"] }
```

### Example

This example illustrates a difference between `keySet` and `nameSet`. Notice that `keySet` retains
the attributes (`name` and `lastName`) and namespaces (`xmlns`) from the XML input, while `nameSet`
returns `null` for them because it does not retain them.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Objects
var myVar = read('<users xmlns="http://test.com">
                     <user name="Mariano" lastName="Achaval"/>
                     <user name="Stacey" lastName="Duke"/>
                  </users>', 'application/xml')
output application/json
---
{ keySetExample: flatten([keySet(myVar.users) map $.#,
                          keySet(myVar.users) map $.@])
}
++
{ nameSet: flatten([nameSet(myVar.users) map $.#,
                    nameSet(myVar.users) map $.@])
}
```

#### Output

```JSON
{
  "keySet": [
    "http://test.com",
    "http://test.com",
    {
      "name": "Mariano",
      "lastName": "Achaval"
    },
    {
      "name": "Stacey",
      "lastName": "Duke"
    }
  ],
  "nameSet": [
    null,
    null,
    null,
    null
  ]
}
```

<!-- document id=95b842442cbaa4ba677dd53ab19d4aa95920667b1370eb4016c3b68ae6ccc003 url=/mulesoft/current/en-us/dataweave/latest/dw-objects-functions-keyset.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# keySet

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## keySet<K, V>(obj: { (K)?: V }): Array<K>

Returns an array of key names from an object.

_This function is **Deprecated**. Use [dw::Core::keysOf](https://docs.mulesoft.com/dataweave/latest/dw-core-functions-keysof), instead._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the keys from the input object.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Objects
output application/json
---
{ "keySet" : keySet({ "a" : true, "b" : 1}) }
```

#### Output

```JSON
{ "keySet" : ["a","b"] }
```

### Example

This example illustrates a difference between `keySet` and `nameSet`. Notice that `keySet` retains
the attributes (`name` and `lastName`) and namespaces (`xmlns`) from the XML input, while `nameSet`
returns `null` for them because it does not retain them.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Objects
var myVar = read('<users xmlns="http://test.com">
                     <user name="Mariano" lastName="Achaval"/>
                     <user name="Stacey" lastName="Duke"/>
                  </users>', 'application/xml')
output application/json
---
{ keySetExample: flatten([keySet(myVar.users) map $.#,
                          keySet(myVar.users) map $.@])
}
++
{ nameSet: flatten([nameSet(myVar.users) map $.#,
                    nameSet(myVar.users) map $.@])
}
```

#### Output

```JSON
{
  "keySet": [
    "http://test.com",
    "http://test.com",
    {
      "name": "Mariano",
      "lastName": "Achaval"
    },
    {
      "name": "Stacey",
      "lastName": "Duke"
    }
  ],
  "nameSet": [
    null,
    null,
    null,
    null
  ]
}
```

<!-- document id=45389e50a0cbdc5ef2354d7962f19bcc7f2687d68f0c48bbd8b745b423ff1b51 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-keysof.md -->

---
product: DataWeave
version: 2.11
---

# keysOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## keysOf<K, V>(obj: { (K)?: V }): Array<K>

Returns an array of keys from key-value pairs within the input object.

The returned keys belong to the Key type. To return each key as a string, you can use `namesOf`,
instead.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the keys from the key-value pairs within the input object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "keysOf" : keysOf({ "a" : true, "b" : 1}) }
```

#### Output

```JSON
{ "keysOf" : ["a","b"] }
```

### Example

This example illustrates a difference between `keysOf` and `namesOf`. Notice that `keysOf` retains
the attributes (`name` and `lastName`) and namespaces (`xmlns`) from the XML input, while `namesOf`
returns `null` for them because it does not retain them.

#### Source

```DataWeave
%dw 2.0
var myVar = read('<users xmlns="http://test.com">
                     <user name="Mariano" lastName="Achaval"/>
                     <user name="Stacey" lastName="Duke"/>
                  </users>', 'application/xml')
output application/json
---
{ keysOfExample: flatten([keysOf(myVar.users) map $.#,
                          keysOf(myVar.users) map $.@])
}
++
{ namesOfExample: flatten([namesOf(myVar.users) map $.#,
                    namesOf(myVar.users) map $.@])
}
```

#### Output

```JSON
{
  "keysOfExample": [
    "http://test.com",
    "http://test.com",
    {
      "name": "Mariano",
      "lastName": "Achaval"
    },
    {
      "name": "Stacey",
      "lastName": "Duke"
    }
  ],
  "namesOfExample": [
    null,
    null,
    null,
    null
  ]
}
```

## keysOf(obj: Null): Null

Helper function that enables `keysOf` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=baa037e1e3d607e81b876a8dac8560c8dd187286a9cd62db6e0f319980a73264 url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-keysof.md -->

---
product: DataWeave
version: 2.12
---

# keysOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## keysOf<K, V>(obj: { (K)?: V }): Array<K>

Returns an array of keys from key-value pairs within the input object.

The returned keys belong to the Key type. To return each key as a string, you can use `namesOf`,
instead.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the keys from the key-value pairs within the input object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "keysOf" : keysOf({ "a" : true, "b" : 1}) }
```

#### Output

```JSON
{ "keysOf" : ["a","b"] }
```

### Example

This example illustrates a difference between `keysOf` and `namesOf`. Notice that `keysOf` retains
the attributes (`name` and `lastName`) and namespaces (`xmlns`) from the XML input, while `namesOf`
returns `null` for them because it does not retain them.

#### Source

```DataWeave
%dw 2.0
var myVar = read('<users xmlns="http://test.com">
                     <user name="Mariano" lastName="Achaval"/>
                     <user name="Stacey" lastName="Duke"/>
                  </users>', 'application/xml')
output application/json
---
{ keysOfExample: flatten([keysOf(myVar.users) map $.#,
                          keysOf(myVar.users) map $.@])
}
++
{ namesOfExample: flatten([namesOf(myVar.users) map $.#,
                    namesOf(myVar.users) map $.@])
}
```

#### Output

```JSON
{
  "keysOfExample": [
    "http://test.com",
    "http://test.com",
    {
      "name": "Mariano",
      "lastName": "Achaval"
    },
    {
      "name": "Stacey",
      "lastName": "Duke"
    }
  ],
  "namesOfExample": [
    null,
    null,
    null,
    null
  ]
}
```

## keysOf(obj: Null): Null

Helper function that enables `keysOf` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=34b56d890484210d890ac7dc7847ca4afe489432b837bef7937bc8a02d6cbe3e url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-keysof.md -->

---
product: DataWeave
version: 2.3
---

# keysOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## keysOf(Object): Array<Key>

Returns an array of keys from key-value pairs within the input object.

The returned keys belong to the Key type. To return each key as a string, you can use `namesOf`,
instead.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the keys from the key-value pairs within the input object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "keysOf" : keysOf({ "a" : true, "b" : 1}) }
```

#### Output

```JSON
{ "keysOf" : ["a","b"] }
```

### Example

This example illustrates a difference between `keysOf` and `namesOf`. Notice that `keysOf` retains
the attributes (`name` and `lastName`) and namespaces (`xmlns`) from the XML input, while `namesOf`
returns `null` for them because it does not retain them.

#### Source

```DataWeave
%dw 2.0
var myVar = read('<users xmlns="http://test.com">
                     <user name="Mariano" lastName="Achaval"/>
                     <user name="Stacey" lastName="Duke"/>
                  </users>', 'application/xml')
output application/json
---
{ keysOfExample: flatten([keysOf(myVar.users) map $.#,
                          keysOf(myVar.users) map $.@])
}
++
{ namesOfExample: flatten([namesOf(myVar.users) map $.#,
                    namesOf(myVar.users) map $.@])
}
```

#### Output

```JSON
{
  "keysOfExample": [
    "http://test.com",
    "http://test.com",
    {
      "name": "Mariano",
      "lastName": "Achaval"
    },
    {
      "name": "Stacey",
      "lastName": "Duke"
    }
  ],
  "namesOfExample": [
    null,
    null,
    null,
    null
  ]
}
```

<!-- document id=49b487455ee8d9767a5988404b26ae1c3b4725818653d062eb72a82af0284c41 url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-keysof.md -->

---
product: DataWeave
version: 2.4
---

# keysOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## keysOf<K, V>(obj: { (K)?: V }): Array<K>

Returns an array of keys from key-value pairs within the input object.

The returned keys belong to the Key type. To return each key as a string, you can use `namesOf`,
instead.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the keys from the key-value pairs within the input object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "keysOf" : keysOf({ "a" : true, "b" : 1}) }
```

#### Output

```JSON
{ "keysOf" : ["a","b"] }
```

### Example

This example illustrates a difference between `keysOf` and `namesOf`. Notice that `keysOf` retains
the attributes (`name` and `lastName`) and namespaces (`xmlns`) from the XML input, while `namesOf`
returns `null` for them because it does not retain them.

#### Source

```DataWeave
%dw 2.0
var myVar = read('<users xmlns="http://test.com">
                     <user name="Mariano" lastName="Achaval"/>
                     <user name="Stacey" lastName="Duke"/>
                  </users>', 'application/xml')
output application/json
---
{ keysOfExample: flatten([keysOf(myVar.users) map $.#,
                          keysOf(myVar.users) map $.@])
}
++
{ namesOfExample: flatten([namesOf(myVar.users) map $.#,
                    namesOf(myVar.users) map $.@])
}
```

#### Output

```JSON
{
  "keysOfExample": [
    "http://test.com",
    "http://test.com",
    {
      "name": "Mariano",
      "lastName": "Achaval"
    },
    {
      "name": "Stacey",
      "lastName": "Duke"
    }
  ],
  "namesOfExample": [
    null,
    null,
    null,
    null
  ]
}
```

## keysOf(obj: Null): Null

Helper function that enables `keysOf` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=0d2449f378e5bc1abf38521b83e1bfaaa68ca42c2f49b2a967c338ae77b82529 url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-keysof.md -->

---
product: DataWeave
version: 2.6
---

# keysOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## keysOf<K, V>(obj: { (K)?: V }): Array<K>

Returns an array of keys from key-value pairs within the input object.

The returned keys belong to the Key type. To return each key as a string, you can use `namesOf`,
instead.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the keys from the key-value pairs within the input object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "keysOf" : keysOf({ "a" : true, "b" : 1}) }
```

#### Output

```JSON
{ "keysOf" : ["a","b"] }
```

### Example

This example illustrates a difference between `keysOf` and `namesOf`. Notice that `keysOf` retains
the attributes (`name` and `lastName`) and namespaces (`xmlns`) from the XML input, while `namesOf`
returns `null` for them because it does not retain them.

#### Source

```DataWeave
%dw 2.0
var myVar = read('<users xmlns="http://test.com">
                     <user name="Mariano" lastName="Achaval"/>
                     <user name="Stacey" lastName="Duke"/>
                  </users>', 'application/xml')
output application/json
---
{ keysOfExample: flatten([keysOf(myVar.users) map $.#,
                          keysOf(myVar.users) map $.@])
}
++
{ namesOfExample: flatten([namesOf(myVar.users) map $.#,
                    namesOf(myVar.users) map $.@])
}
```

#### Output

```JSON
{
  "keysOfExample": [
    "http://test.com",
    "http://test.com",
    {
      "name": "Mariano",
      "lastName": "Achaval"
    },
    {
      "name": "Stacey",
      "lastName": "Duke"
    }
  ],
  "namesOfExample": [
    null,
    null,
    null,
    null
  ]
}
```

## keysOf(obj: Null): Null

Helper function that enables `keysOf` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=a5b7279de138330fc423b525c7b1e1046ee8ae5bec9610865738a5e28c9ee4c6 url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-keysof.md -->

---
product: DataWeave
version: 2.9
---

# keysOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## keysOf<K, V>(obj: { (K)?: V }): Array<K>

Returns an array of keys from key-value pairs within the input object.

The returned keys belong to the Key type. To return each key as a string, you can use `namesOf`,
instead.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the keys from the key-value pairs within the input object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "keysOf" : keysOf({ "a" : true, "b" : 1}) }
```

#### Output

```JSON
{ "keysOf" : ["a","b"] }
```

### Example

This example illustrates a difference between `keysOf` and `namesOf`. Notice that `keysOf` retains
the attributes (`name` and `lastName`) and namespaces (`xmlns`) from the XML input, while `namesOf`
returns `null` for them because it does not retain them.

#### Source

```DataWeave
%dw 2.0
var myVar = read('<users xmlns="http://test.com">
                     <user name="Mariano" lastName="Achaval"/>
                     <user name="Stacey" lastName="Duke"/>
                  </users>', 'application/xml')
output application/json
---
{ keysOfExample: flatten([keysOf(myVar.users) map $.#,
                          keysOf(myVar.users) map $.@])
}
++
{ namesOfExample: flatten([namesOf(myVar.users) map $.#,
                    namesOf(myVar.users) map $.@])
}
```

#### Output

```JSON
{
  "keysOfExample": [
    "http://test.com",
    "http://test.com",
    {
      "name": "Mariano",
      "lastName": "Achaval"
    },
    {
      "name": "Stacey",
      "lastName": "Duke"
    }
  ],
  "namesOfExample": [
    null,
    null,
    null,
    null
  ]
}
```

## keysOf(obj: Null): Null

Helper function that enables `keysOf` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=e81dc2d6f2cb1dc8fe5f58263508cea4b047efb27cec4084e295ac64b9878be8 url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-keysof.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# keysOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## keysOf<K, V>(obj: { (K)?: V }): Array<K>

Returns an array of keys from key-value pairs within the input object.

The returned keys belong to the Key type. To return each key as a string, you can use `namesOf`,
instead.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the keys from the key-value pairs within the input object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "keysOf" : keysOf({ "a" : true, "b" : 1}) }
```

#### Output

```JSON
{ "keysOf" : ["a","b"] }
```

### Example

This example illustrates a difference between `keysOf` and `namesOf`. Notice that `keysOf` retains
the attributes (`name` and `lastName`) and namespaces (`xmlns`) from the XML input, while `namesOf`
returns `null` for them because it does not retain them.

#### Source

```DataWeave
%dw 2.0
var myVar = read('<users xmlns="http://test.com">
                     <user name="Mariano" lastName="Achaval"/>
                     <user name="Stacey" lastName="Duke"/>
                  </users>', 'application/xml')
output application/json
---
{ keysOfExample: flatten([keysOf(myVar.users) map $.#,
                          keysOf(myVar.users) map $.@])
}
++
{ namesOfExample: flatten([namesOf(myVar.users) map $.#,
                    namesOf(myVar.users) map $.@])
}
```

#### Output

```JSON
{
  "keysOfExample": [
    "http://test.com",
    "http://test.com",
    {
      "name": "Mariano",
      "lastName": "Achaval"
    },
    {
      "name": "Stacey",
      "lastName": "Duke"
    }
  ],
  "namesOfExample": [
    null,
    null,
    null,
    null
  ]
}
```

## keysOf(obj: Null): Null

Helper function that enables `keysOf` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=527a74a7fe045125c4db16fc547ef9bf1122bf0eebee9e4b09301d5927b26d2b url=/mulesoft/current/en-us/dataweave/2.11/dw-strings-functions-last.md -->

---
product: DataWeave
version: 2.11
---

# last

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## last(text: String, amount: Number): String

Returns characters from the end of string to a specified number of characters, for example, the last
two characters of a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to process.</p></td></tr><tr><td><p><code>amount</code></p></td><td><p>The number of characters to return. Negative numbers and <code>0</code> return an empty string. Decimals are rounded up to the nearest whole number.</p></td></tr></tbody></table>

### Example

This example returns the last six characters from a string.

#### Source

```DataWeave
%dw 2.0
import last from dw::core::Strings
output application/json
---
"hello world!" last 6
```

#### Output

```Json
"world!"
```

## last(text: Null, amount: Any): Null

Helper function that enables `last` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=3431502c91dad3d2e11e70b70a53f21e2de3877748c2f4c3b1da5e7c313f19b2 url=/mulesoft/current/en-us/dataweave/2.12/dw-strings-functions-last.md -->

---
product: DataWeave
version: 2.12
---

# last

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## last(text: String, amount: Number): String

Returns characters from the end of string to a specified number of characters, for example, the last
two characters of a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to process.</p></td></tr><tr><td><p><code>amount</code></p></td><td><p>The number of characters to return. Negative numbers and <code>0</code> return an empty string. Decimals are rounded up to the nearest whole number.</p></td></tr></tbody></table>

### Example

This example returns the last six characters from a string.

#### Source

```DataWeave
%dw 2.0
import last from dw::core::Strings
output application/json
---
"hello world!" last 6
```

#### Output

```Json
"world!"
```

## last(text: Null, amount: Any): Null

Helper function that enables `last` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=2e312b14a3f37e2e8493deab0b3d0224397e81236fd17805e2b9f453b4eb598d url=/mulesoft/current/en-us/dataweave/2.4/dw-strings-functions-last.md -->

---
product: DataWeave
version: 2.4
---

# last

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## last(text: String, amount: Number): String

Returns characters from the end of string to a specified number of characters, for example, the last
two characters of a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to process.</p></td></tr><tr><td><p><code>amount</code></p></td><td><p>The number of characters to return. Negative numbers and <code>0</code> return an empty string. Decimals are rounded up to the nearest whole number.</p></td></tr></tbody></table>

### Example

This example returns the last six characters from a string.

#### Source

```DataWeave
%dw 2.0
import last from dw::core::Strings
output application/json
---
"hello world!" last 6
```

#### Output

```Json
"world!"
```

## last(text: Null, amount: Any): Null

Helper function that enables `last` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=2ecc425a7bd3767cf07afcb3b0ff3921ad73900ebbea35ff6125745d996ed83e url=/mulesoft/current/en-us/dataweave/2.6/dw-strings-functions-last.md -->

---
product: DataWeave
version: 2.6
---

# last

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## last(text: String, amount: Number): String

Returns characters from the end of string to a specified number of characters, for example, the last
two characters of a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to process.</p></td></tr><tr><td><p><code>amount</code></p></td><td><p>The number of characters to return. Negative numbers and <code>0</code> return an empty string. Decimals are rounded up to the nearest whole number.</p></td></tr></tbody></table>

### Example

This example returns the last six characters from a string.

#### Source

```DataWeave
%dw 2.0
import last from dw::core::Strings
output application/json
---
"hello world!" last 6
```

#### Output

```Json
"world!"
```

## last(text: Null, amount: Any): Null

Helper function that enables `last` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=36c8eeb0071e9ccc9b8d2818a5566da0fce103fd6d99d5354efd3e318f49baf1 url=/mulesoft/current/en-us/dataweave/2.9/dw-strings-functions-last.md -->

---
product: DataWeave
version: 2.9
---

# last

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## last(text: String, amount: Number): String

Returns characters from the end of string to a specified number of characters, for example, the last
two characters of a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to process.</p></td></tr><tr><td><p><code>amount</code></p></td><td><p>The number of characters to return. Negative numbers and <code>0</code> return an empty string. Decimals are rounded up to the nearest whole number.</p></td></tr></tbody></table>

### Example

This example returns the last six characters from a string.

#### Source

```DataWeave
%dw 2.0
import last from dw::core::Strings
output application/json
---
"hello world!" last 6
```

#### Output

```Json
"world!"
```

## last(text: Null, amount: Any): Null

Helper function that enables `last` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=bf57d7622890594f255c186b367aa1e32b8ff6b22d58d06b2505e57526468a09 url=/mulesoft/current/en-us/dataweave/latest/dw-strings-functions-last.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# last

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## last(text: String, amount: Number): String

Returns characters from the end of string to a specified number of characters, for example, the last
two characters of a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to process.</p></td></tr><tr><td><p><code>amount</code></p></td><td><p>The number of characters to return. Negative numbers and <code>0</code> return an empty string. Decimals are rounded up to the nearest whole number.</p></td></tr></tbody></table>

### Example

This example returns the last six characters from a string.

#### Source

```DataWeave
%dw 2.0
import last from dw::core::Strings
output application/json
---
"hello world!" last 6
```

#### Output

```Json
"world!"
```

## last(text: Null, amount: Any): Null

Helper function that enables `last` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=9fed2c7ed1a8f6b381b5d33f86a276f8dd9bd859641b53fe40a02f0726211017 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-lastindexof.md -->

---
product: DataWeave
version: 2.11
---

# lastIndexOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## lastIndexOf(array: Array, value: Any): Number

Returns the index of the _last_ occurrence of the specified element in a given array or `-1` if the
array does not contain the element.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements to search.</p></td></tr><tr><td><p><code>value</code></p></td><td><p>The value to search.</p></td></tr></tbody></table>

### Example

This example shows how `indexOf` behaves given different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  present: ["a","b","c","d"] lastIndexOf "c",
  notPresent: ["x","w","x"] lastIndexOf "c",
  presentMoreThanOnce: ["a","b","c","c"] lastIndexOf "c",
}
```

#### Output

```Json
{
  "present": 2,
  "notPresent": -1,
  "presentMoreThanOnce": 3
}
```

## lastIndexOf(array: String, value: String): Number

Takes a string as input and returns the index of the _last_ occurrence of a given search string
within the input. The function returns `-1` if the search string is not present in the input.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>string</code></p></td><td><p>The string to search.</p></td></tr><tr><td><p><code>value</code></p></td><td><p>A string value to search for within the input string.</p></td></tr></tbody></table>

### Example

This example shows how the `indexOf` behaves given different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  present: "abcd" lastIndexOf "c",
  notPresent: "xyz" lastIndexOf "c",
  presentMoreThanOnce: "abcdc" lastIndexOf "c",
}
```

#### Output

```Json
{
  "present": 2,
  "notPresent": -1,
  "presentMoreThanOnce": 4
}
```

## lastIndexOf(array: Null, value: Any): Number

Helper function that enables `lastIndexOf` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=8813e2993641649a3ced950e67e958508fb21e7dce0b501d8e83269e9c913d68 url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-lastindexof.md -->

---
product: DataWeave
version: 2.12
---

# lastIndexOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## lastIndexOf(array: Array, value: Any): Number

Returns the index of the _last_ occurrence of the specified element in a given array or `-1` if the
array does not contain the element.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements to search.</p></td></tr><tr><td><p><code>value</code></p></td><td><p>The value to search.</p></td></tr></tbody></table>

### Example

This example shows how `indexOf` behaves given different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  present: ["a","b","c","d"] lastIndexOf "c",
  notPresent: ["x","w","x"] lastIndexOf "c",
  presentMoreThanOnce: ["a","b","c","c"] lastIndexOf "c",
}
```

#### Output

```Json
{
  "present": 2,
  "notPresent": -1,
  "presentMoreThanOnce": 3
}
```

## lastIndexOf(array: String, value: String): Number

Takes a string as input and returns the index of the _last_ occurrence of a given search string
within the input. The function returns `-1` if the search string is not present in the input.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>string</code></p></td><td><p>The string to search.</p></td></tr><tr><td><p><code>value</code></p></td><td><p>A string value to search for within the input string.</p></td></tr></tbody></table>

### Example

This example shows how the `indexOf` behaves given different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  present: "abcd" lastIndexOf "c",
  notPresent: "xyz" lastIndexOf "c",
  presentMoreThanOnce: "abcdc" lastIndexOf "c",
}
```

#### Output

```Json
{
  "present": 2,
  "notPresent": -1,
  "presentMoreThanOnce": 4
}
```

## lastIndexOf(array: Null, value: Any): Number

Helper function that enables `lastIndexOf` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=97b2e1177e07433a2b4042a1e791348290685ece4f9e7e57542cb8d9271f4939 url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-lastindexof.md -->

---
product: DataWeave
version: 2.4
---

# lastIndexOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## lastIndexOf(array: Array, value: Any): Number

Returns the index of the _last_ occurrence of the specified element in a given array or `-1` if the
array does not contain the element.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements to search.</p></td></tr><tr><td><p><code>value</code></p></td><td><p>The value to search.</p></td></tr></tbody></table>

### Example

This example shows how `indexOf` behaves given different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  present: ["a","b","c","d"] lastIndexOf "c",
  notPresent: ["x","w","x"] lastIndexOf "c",
  presentMoreThanOnce: ["a","b","c","c"] lastIndexOf "c",
}
```

#### Output

```Json
{
  "present": 2,
  "notPresent": -1,
  "presentMoreThanOnce": 3
}
```

## lastIndexOf(array: String, value: String): Number

Takes a string as input and returns the index of the _last_ occurrence of a given search string
within the input. The function returns `-1` if the search string is not present in the input.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>string</code></p></td><td><p>The string to search.</p></td></tr><tr><td><p><code>value</code></p></td><td><p>A string value to search for within the input string.</p></td></tr></tbody></table>

### Example

This example shows how the `indexOf` behaves given different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  present: "abcd" lastIndexOf "c",
  notPresent: "xyz" lastIndexOf "c",
  presentMoreThanOnce: "abcdc" lastIndexOf "c",
}
```

#### Output

```Json
{
  "present": 2,
  "notPresent": -1,
  "presentMoreThanOnce": 4
}
```

## lastIndexOf(array: Null, value: Any): Number

Helper function that enables `lastIndexOf` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=f6d4455e66c619a0d4bea76420d5df47da564b136c50906c8cde2329ee14c530 url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-lastindexof.md -->

---
product: DataWeave
version: 2.6
---

# lastIndexOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## lastIndexOf(array: Array, value: Any): Number

Returns the index of the _last_ occurrence of the specified element in a given array or `-1` if the
array does not contain the element.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements to search.</p></td></tr><tr><td><p><code>value</code></p></td><td><p>The value to search.</p></td></tr></tbody></table>

### Example

This example shows how `indexOf` behaves given different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  present: ["a","b","c","d"] lastIndexOf "c",
  notPresent: ["x","w","x"] lastIndexOf "c",
  presentMoreThanOnce: ["a","b","c","c"] lastIndexOf "c",
}
```

#### Output

```Json
{
  "present": 2,
  "notPresent": -1,
  "presentMoreThanOnce": 3
}
```

## lastIndexOf(array: String, value: String): Number

Takes a string as input and returns the index of the _last_ occurrence of a given search string
within the input. The function returns `-1` if the search string is not present in the input.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>string</code></p></td><td><p>The string to search.</p></td></tr><tr><td><p><code>value</code></p></td><td><p>A string value to search for within the input string.</p></td></tr></tbody></table>

### Example

This example shows how the `indexOf` behaves given different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  present: "abcd" lastIndexOf "c",
  notPresent: "xyz" lastIndexOf "c",
  presentMoreThanOnce: "abcdc" lastIndexOf "c",
}
```

#### Output

```Json
{
  "present": 2,
  "notPresent": -1,
  "presentMoreThanOnce": 4
}
```

## lastIndexOf(array: Null, value: Any): Number

Helper function that enables `lastIndexOf` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=eb4315ab8957bbd241609a379feca598fe27e4833cf03b444315b584e9b6d0d5 url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-lastindexof.md -->

---
product: DataWeave
version: 2.9
---

# lastIndexOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## lastIndexOf(array: Array, value: Any): Number

Returns the index of the _last_ occurrence of the specified element in a given array or `-1` if the
array does not contain the element.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements to search.</p></td></tr><tr><td><p><code>value</code></p></td><td><p>The value to search.</p></td></tr></tbody></table>

### Example

This example shows how `indexOf` behaves given different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  present: ["a","b","c","d"] lastIndexOf "c",
  notPresent: ["x","w","x"] lastIndexOf "c",
  presentMoreThanOnce: ["a","b","c","c"] lastIndexOf "c",
}
```

#### Output

```Json
{
  "present": 2,
  "notPresent": -1,
  "presentMoreThanOnce": 3
}
```

## lastIndexOf(array: String, value: String): Number

Takes a string as input and returns the index of the _last_ occurrence of a given search string
within the input. The function returns `-1` if the search string is not present in the input.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>string</code></p></td><td><p>The string to search.</p></td></tr><tr><td><p><code>value</code></p></td><td><p>A string value to search for within the input string.</p></td></tr></tbody></table>

### Example

This example shows how the `indexOf` behaves given different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  present: "abcd" lastIndexOf "c",
  notPresent: "xyz" lastIndexOf "c",
  presentMoreThanOnce: "abcdc" lastIndexOf "c",
}
```

#### Output

```Json
{
  "present": 2,
  "notPresent": -1,
  "presentMoreThanOnce": 4
}
```

## lastIndexOf(array: Null, value: Any): Number

Helper function that enables `lastIndexOf` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=8868c4a6839f14f0c03e750455cb042a663c31435e7985822c5796c5f241aeaf url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-lastindexof.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# lastIndexOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## lastIndexOf(array: Array, value: Any): Number

Returns the index of the _last_ occurrence of the specified element in a given array or `-1` if the
array does not contain the element.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements to search.</p></td></tr><tr><td><p><code>value</code></p></td><td><p>The value to search.</p></td></tr></tbody></table>

### Example

This example shows how `indexOf` behaves given different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  present: ["a","b","c","d"] lastIndexOf "c",
  notPresent: ["x","w","x"] lastIndexOf "c",
  presentMoreThanOnce: ["a","b","c","c"] lastIndexOf "c",
}
```

#### Output

```Json
{
  "present": 2,
  "notPresent": -1,
  "presentMoreThanOnce": 3
}
```

## lastIndexOf(array: String, value: String): Number

Takes a string as input and returns the index of the _last_ occurrence of a given search string
within the input. The function returns `-1` if the search string is not present in the input.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>string</code></p></td><td><p>The string to search.</p></td></tr><tr><td><p><code>value</code></p></td><td><p>A string value to search for within the input string.</p></td></tr></tbody></table>

### Example

This example shows how the `indexOf` behaves given different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  present: "abcd" lastIndexOf "c",
  notPresent: "xyz" lastIndexOf "c",
  presentMoreThanOnce: "abcdc" lastIndexOf "c",
}
```

#### Output

```Json
{
  "present": 2,
  "notPresent": -1,
  "presentMoreThanOnce": 4
}
```

## lastIndexOf(array: Null, value: Any): Number

Helper function that enables `lastIndexOf` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=c7b15f3412b2e0d102fa66c7432c1925721338af374e93175f85698b455c7570 url=/mulesoft/current/en-us/dataweave/2.11/dw-arrays-functions-leftjoin.md -->

---
product: DataWeave
version: 2.11
---

# leftJoin

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## leftJoin<L <: Object, R <: Object>(left: Array<L>, right: Array<R>, leftCriteria: (leftValue: L) -> String, rightCriteria: (rightValue: R) -> String): Array<{ l: L, r?: R }>

Joins two arrays of objects by a given ID criteria.

`leftJoin` returns an array all the `left` items, merged by ID with any right items that meet the
joining criteria.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>left</code></p></td><td><p>The left-side array of objects.</p></td></tr><tr><td><p><code>right</code></p></td><td><p>The right-side array of objects.</p></td></tr><tr><td><p><code>leftCriteria</code></p></td><td><p>The criteria used to extract the ID for the left collection.</p></td></tr><tr><td><p><code>rightCriteria</code></p></td><td><p>The criteria used to extract the ID for the right collection.</p></td></tr></tbody></table>

### Example

This example shows how join behaves. Notice that it returns all objects from the left-side array
(`left`) but only joins items from the right-side array (`right`) if the values of the left-side
`user.id` and right-side `product.ownerId` match.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
var users = [{id: "1", name:"Mariano"},{id: "2", name:"Leandro"},{id: "3", name:"Julian"},{id: "5", name:"Julian"}]
var products = [{ownerId: "1", name:"DataWeave"},{ownerId: "1", name:"BAT"}, {ownerId: "3", name:"DataSense"}, {ownerId: "4", name:"SmartConnectors"}]
output application/json
---
leftJoin(users, products, (user) -> user.id, (product) -> product.ownerId)
```

#### Output

```json
[
  {
    "l": {
      "id": "1",
      "name": "Mariano"
    },
    "r": {
      "ownerId": "1",
      "name": "DataWeave"
    }
  },
  {
    "l": {
      "id": "1",
      "name": "Mariano"
    },
    "r": {
      "ownerId": "1",
      "name": "BAT"
    }
  },
  {
    "l": {
      "id": "2",
      "name": "Leandro"
    }
  },
  {
    "l": {
      "id": "3",
      "name": "Julian"
    },
    "r": {
      "ownerId": "3",
      "name": "DataSense"
    }
  },
  {
    "l": {
      "id": "5",
      "name": "Julian"
    }
  }
]
```

<!-- document id=732b7bb0975abd60d9981d242bfc35fb21a6cf25a472927773d92a66acfeda31 url=/mulesoft/current/en-us/dataweave/2.12/dw-arrays-functions-leftjoin.md -->

---
product: DataWeave
version: 2.12
---

# leftJoin

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## leftJoin<L <: Object, R <: Object>(left: Array<L>, right: Array<R>, leftCriteria: (leftValue: L) -> String, rightCriteria: (rightValue: R) -> String): Array<{ l: L, r?: R }>

Joins two arrays of objects by a given ID criteria.

`leftJoin` returns an array all the `left` items, merged by ID with any right items that meet the
joining criteria.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>left</code></p></td><td><p>The left-side array of objects.</p></td></tr><tr><td><p><code>right</code></p></td><td><p>The right-side array of objects.</p></td></tr><tr><td><p><code>leftCriteria</code></p></td><td><p>The criteria used to extract the ID for the left collection.</p></td></tr><tr><td><p><code>rightCriteria</code></p></td><td><p>The criteria used to extract the ID for the right collection.</p></td></tr></tbody></table>

### Example

This example shows how join behaves. Notice that it returns all objects from the left-side array
(`left`) but only joins items from the right-side array (`right`) if the values of the left-side
`user.id` and right-side `product.ownerId` match.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
var users = [{id: "1", name:"Mariano"},{id: "2", name:"Leandro"},{id: "3", name:"Julian"},{id: "5", name:"Julian"}]
var products = [{ownerId: "1", name:"DataWeave"},{ownerId: "1", name:"BAT"}, {ownerId: "3", name:"DataSense"}, {ownerId: "4", name:"SmartConnectors"}]
output application/json
---
leftJoin(users, products, (user) -> user.id, (product) -> product.ownerId)
```

#### Output

```json
[
  {
    "l": {
      "id": "1",
      "name": "Mariano"
    },
    "r": {
      "ownerId": "1",
      "name": "DataWeave"
    }
  },
  {
    "l": {
      "id": "1",
      "name": "Mariano"
    },
    "r": {
      "ownerId": "1",
      "name": "BAT"
    }
  },
  {
    "l": {
      "id": "2",
      "name": "Leandro"
    }
  },
  {
    "l": {
      "id": "3",
      "name": "Julian"
    },
    "r": {
      "ownerId": "3",
      "name": "DataSense"
    }
  },
  {
    "l": {
      "id": "5",
      "name": "Julian"
    }
  }
]
```

<!-- document id=56eae87456cfe268390001e50570c14c4c62894efaff88ddfb9a753f9e382dd0 url=/mulesoft/current/en-us/dataweave/2.3/dw-arrays-functions-leftjoin.md -->

---
product: DataWeave
version: 2.3
---

# leftJoin

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## leftJoin(Array<L>, Array<R>, (leftValue: L) -> String, (rightValue: R) -> String): Array<{ l: L, r?: R }>

Joins two arrays of objects by a given ID criteria.

`leftJoin` returns an array all the `left` items, merged by ID with any right items that meet the
joining criteria.

_Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>left</code></p></td><td><p>The left-side array of objects.</p></td></tr><tr><td><p><code>right</code></p></td><td><p>The right-side array of objects.</p></td></tr><tr><td><p><code>leftCriteria</code></p></td><td><p>The criteria used to extract the ID for the left collection.</p></td></tr><tr><td><p><code>rightCriteria</code></p></td><td><p>The criteria used to extract the ID for the right collection.</p></td></tr></tbody></table>

### Example

This example shows how join behaves. Notice that it returns all objects from the left-side array
(`left`) but only joins items from the right-side array (`right`) if the values of the left-side
`user.id` and right-side `product.ownerId` match.

#### Source

```DataWeave
 %dw 2.0
 import * from dw::core::Arrays
 var users = [{id: "1", name:"Mariano"},{id: "2", name:"Leandro"},{id: "3", name:"Julian"},{id: "5", name:"Julian"}]
 var products = [{ownerId: "1", name:"DataWeave"},{ownerId: "1", name:"BAT"}, {ownerId: "3", name:"DataSense"}, {ownerId: "4", name:"SmartConnectors"}]
 output application/json
 ---
 leftJoin(users, products, (user) -> user.id, (product) -> product.ownerId)
```

#### Output

```json
[
  {
    "l": {
      "id": "1",
      "name": "Mariano"
    },
    "r": {
      "ownerId": "1",
      "name": "DataWeave"
    }
  },
  {
    "l": {
      "id": "1",
      "name": "Mariano"
    },
    "r": {
      "ownerId": "1",
      "name": "BAT"
    }
  },
  {
    "l": {
      "id": "2",
      "name": "Leandro"
    }
  },
  {
    "l": {
      "id": "3",
      "name": "Julian"
    },
    "r": {
      "ownerId": "3",
      "name": "DataSense"
    }
  },
  {
    "l": {
      "id": "5",
      "name": "Julian"
    }
  }
]
```

<!-- document id=4194e6474050b8d764bad9d4cff96fba3ff3e5c4a03960410158ff120189d512 url=/mulesoft/current/en-us/dataweave/2.4/dw-arrays-functions-leftjoin.md -->

---
product: DataWeave
version: 2.4
---

# leftJoin

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## leftJoin<L <: Object, R <: Object>(left: Array<L>, right: Array<R>, leftCriteria: (leftValue: L) -> String, rightCriteria: (rightValue: R) -> String): Array<{ l: L, r?: R }>

Joins two arrays of objects by a given ID criteria.

`leftJoin` returns an array all the `left` items, merged by ID with any right items that meet the
joining criteria.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>left</code></p></td><td><p>The left-side array of objects.</p></td></tr><tr><td><p><code>right</code></p></td><td><p>The right-side array of objects.</p></td></tr><tr><td><p><code>leftCriteria</code></p></td><td><p>The criteria used to extract the ID for the left collection.</p></td></tr><tr><td><p><code>rightCriteria</code></p></td><td><p>The criteria used to extract the ID for the right collection.</p></td></tr></tbody></table>

### Example

This example shows how join behaves. Notice that it returns all objects from the left-side array
(`left`) but only joins items from the right-side array (`right`) if the values of the left-side
`user.id` and right-side `product.ownerId` match.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
var users = [{id: "1", name:"Mariano"},{id: "2", name:"Leandro"},{id: "3", name:"Julian"},{id: "5", name:"Julian"}]
var products = [{ownerId: "1", name:"DataWeave"},{ownerId: "1", name:"BAT"}, {ownerId: "3", name:"DataSense"}, {ownerId: "4", name:"SmartConnectors"}]
output application/json
---
leftJoin(users, products, (user) -> user.id, (product) -> product.ownerId)
```

#### Output

```json
[
  {
    "l": {
      "id": "1",
      "name": "Mariano"
    },
    "r": {
      "ownerId": "1",
      "name": "DataWeave"
    }
  },
  {
    "l": {
      "id": "1",
      "name": "Mariano"
    },
    "r": {
      "ownerId": "1",
      "name": "BAT"
    }
  },
  {
    "l": {
      "id": "2",
      "name": "Leandro"
    }
  },
  {
    "l": {
      "id": "3",
      "name": "Julian"
    },
    "r": {
      "ownerId": "3",
      "name": "DataSense"
    }
  },
  {
    "l": {
      "id": "5",
      "name": "Julian"
    }
  }
]
```

<!-- document id=7576a4afe36375f84828a4752350938e282c6da68c1b3d9e8500f19319cdd87c url=/mulesoft/current/en-us/dataweave/2.6/dw-arrays-functions-leftjoin.md -->

---
product: DataWeave
version: 2.6
---

# leftJoin

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## leftJoin<L <: Object, R <: Object>(left: Array<L>, right: Array<R>, leftCriteria: (leftValue: L) -> String, rightCriteria: (rightValue: R) -> String): Array<{ l: L, r?: R }>

Joins two arrays of objects by a given ID criteria.

`leftJoin` returns an array all the `left` items, merged by ID with any right items that meet the
joining criteria.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>left</code></p></td><td><p>The left-side array of objects.</p></td></tr><tr><td><p><code>right</code></p></td><td><p>The right-side array of objects.</p></td></tr><tr><td><p><code>leftCriteria</code></p></td><td><p>The criteria used to extract the ID for the left collection.</p></td></tr><tr><td><p><code>rightCriteria</code></p></td><td><p>The criteria used to extract the ID for the right collection.</p></td></tr></tbody></table>

### Example

This example shows how join behaves. Notice that it returns all objects from the left-side array
(`left`) but only joins items from the right-side array (`right`) if the values of the left-side
`user.id` and right-side `product.ownerId` match.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
var users = [{id: "1", name:"Mariano"},{id: "2", name:"Leandro"},{id: "3", name:"Julian"},{id: "5", name:"Julian"}]
var products = [{ownerId: "1", name:"DataWeave"},{ownerId: "1", name:"BAT"}, {ownerId: "3", name:"DataSense"}, {ownerId: "4", name:"SmartConnectors"}]
output application/json
---
leftJoin(users, products, (user) -> user.id, (product) -> product.ownerId)
```

#### Output

```json
[
  {
    "l": {
      "id": "1",
      "name": "Mariano"
    },
    "r": {
      "ownerId": "1",
      "name": "DataWeave"
    }
  },
  {
    "l": {
      "id": "1",
      "name": "Mariano"
    },
    "r": {
      "ownerId": "1",
      "name": "BAT"
    }
  },
  {
    "l": {
      "id": "2",
      "name": "Leandro"
    }
  },
  {
    "l": {
      "id": "3",
      "name": "Julian"
    },
    "r": {
      "ownerId": "3",
      "name": "DataSense"
    }
  },
  {
    "l": {
      "id": "5",
      "name": "Julian"
    }
  }
]
```

<!-- document id=5d741b0da33c7f261b33cf3ef19c45490427eebde9446220d759eb0d4ec0f431 url=/mulesoft/current/en-us/dataweave/2.9/dw-arrays-functions-leftjoin.md -->

---
product: DataWeave
version: 2.9
---

# leftJoin

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## leftJoin<L <: Object, R <: Object>(left: Array<L>, right: Array<R>, leftCriteria: (leftValue: L) -> String, rightCriteria: (rightValue: R) -> String): Array<{ l: L, r?: R }>

Joins two arrays of objects by a given ID criteria.

`leftJoin` returns an array all the `left` items, merged by ID with any right items that meet the
joining criteria.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>left</code></p></td><td><p>The left-side array of objects.</p></td></tr><tr><td><p><code>right</code></p></td><td><p>The right-side array of objects.</p></td></tr><tr><td><p><code>leftCriteria</code></p></td><td><p>The criteria used to extract the ID for the left collection.</p></td></tr><tr><td><p><code>rightCriteria</code></p></td><td><p>The criteria used to extract the ID for the right collection.</p></td></tr></tbody></table>

### Example

This example shows how join behaves. Notice that it returns all objects from the left-side array
(`left`) but only joins items from the right-side array (`right`) if the values of the left-side
`user.id` and right-side `product.ownerId` match.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
var users = [{id: "1", name:"Mariano"},{id: "2", name:"Leandro"},{id: "3", name:"Julian"},{id: "5", name:"Julian"}]
var products = [{ownerId: "1", name:"DataWeave"},{ownerId: "1", name:"BAT"}, {ownerId: "3", name:"DataSense"}, {ownerId: "4", name:"SmartConnectors"}]
output application/json
---
leftJoin(users, products, (user) -> user.id, (product) -> product.ownerId)
```

#### Output

```json
[
  {
    "l": {
      "id": "1",
      "name": "Mariano"
    },
    "r": {
      "ownerId": "1",
      "name": "DataWeave"
    }
  },
  {
    "l": {
      "id": "1",
      "name": "Mariano"
    },
    "r": {
      "ownerId": "1",
      "name": "BAT"
    }
  },
  {
    "l": {
      "id": "2",
      "name": "Leandro"
    }
  },
  {
    "l": {
      "id": "3",
      "name": "Julian"
    },
    "r": {
      "ownerId": "3",
      "name": "DataSense"
    }
  },
  {
    "l": {
      "id": "5",
      "name": "Julian"
    }
  }
]
```

<!-- document id=f9f21ebc567b8c491d9f3e463a5a4a687aa09b0743849f00a79367edbeb60266 url=/mulesoft/current/en-us/dataweave/latest/dw-arrays-functions-leftjoin.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# leftJoin

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## leftJoin<L <: Object, R <: Object>(left: Array<L>, right: Array<R>, leftCriteria: (leftValue: L) -> String, rightCriteria: (rightValue: R) -> String): Array<{ l: L, r?: R }>

Joins two arrays of objects by a given ID criteria.

`leftJoin` returns an array all the `left` items, merged by ID with any right items that meet the
joining criteria.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>left</code></p></td><td><p>The left-side array of objects.</p></td></tr><tr><td><p><code>right</code></p></td><td><p>The right-side array of objects.</p></td></tr><tr><td><p><code>leftCriteria</code></p></td><td><p>The criteria used to extract the ID for the left collection.</p></td></tr><tr><td><p><code>rightCriteria</code></p></td><td><p>The criteria used to extract the ID for the right collection.</p></td></tr></tbody></table>

### Example

This example shows how join behaves. Notice that it returns all objects from the left-side array
(`left`) but only joins items from the right-side array (`right`) if the values of the left-side
`user.id` and right-side `product.ownerId` match.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
var users = [{id: "1", name:"Mariano"},{id: "2", name:"Leandro"},{id: "3", name:"Julian"},{id: "5", name:"Julian"}]
var products = [{ownerId: "1", name:"DataWeave"},{ownerId: "1", name:"BAT"}, {ownerId: "3", name:"DataSense"}, {ownerId: "4", name:"SmartConnectors"}]
output application/json
---
leftJoin(users, products, (user) -> user.id, (product) -> product.ownerId)
```

#### Output

```json
[
  {
    "l": {
      "id": "1",
      "name": "Mariano"
    },
    "r": {
      "ownerId": "1",
      "name": "DataWeave"
    }
  },
  {
    "l": {
      "id": "1",
      "name": "Mariano"
    },
    "r": {
      "ownerId": "1",
      "name": "BAT"
    }
  },
  {
    "l": {
      "id": "2",
      "name": "Leandro"
    }
  },
  {
    "l": {
      "id": "3",
      "name": "Julian"
    },
    "r": {
      "ownerId": "3",
      "name": "DataSense"
    }
  },
  {
    "l": {
      "id": "5",
      "name": "Julian"
    }
  }
]
```

<!-- document id=5ae111341c19715a01b3c453551dc6fd3f548e8801107f754d90e9de59eab247 url=/mulesoft/current/en-us/dataweave/2.11/dw-strings-functions-leftpad.md -->

---
product: DataWeave
version: 2.11
---

# leftPad

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## leftPad(text: String, size: Number, padText: String = " "): String

The specified `text` is _left_\-padded to the `size` using the `padText`. By default `padText` is
`" "`.

Returns left-padded `String` or original `String` if no padding is necessary.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>size</code></p></td><td><p>The size to pad to.</p></td></tr><tr><td><p><code>padText</code></p></td><td><p>The text to pad with. It defaults to one space if not specified.</p></td></tr></tbody></table>

### Example

This example shows how `leftPad` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
   "a": leftPad(null, 3),
   "b": leftPad("", 3),
   "c": leftPad("bat", 5),
   "d": leftPad("bat", 3),
   "e": leftPad("bat", -1)
}
```

#### Output

```JSON
{
  "a": null,
  "b": "   ",
  "c": "  bat",
  "d": "bat",
  "e": "bat"
}
```

## leftPad(text: Null, size: Any, padText: Any = " "): Null

Helper function that enables `leftPad` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=51f4eb344994142ee9a811d9a12aa7dad1fc98f88af3bac409af8ed714583027 url=/mulesoft/current/en-us/dataweave/2.12/dw-strings-functions-leftpad.md -->

---
product: DataWeave
version: 2.12
---

# leftPad

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## leftPad(text: String, size: Number, padText: String = " "): String

The specified `text` is _left_\-padded to the `size` using the `padText`. By default `padText` is
`" "`.

Returns left-padded `String` or original `String` if no padding is necessary.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>size</code></p></td><td><p>The size to pad to.</p></td></tr><tr><td><p><code>padText</code></p></td><td><p>The text to pad with. It defaults to one space if not specified.</p></td></tr></tbody></table>

### Example

This example shows how `leftPad` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
   "a": leftPad(null, 3),
   "b": leftPad("", 3),
   "c": leftPad("bat", 5),
   "d": leftPad("bat", 3),
   "e": leftPad("bat", -1)
}
```

#### Output

```JSON
{
  "a": null,
  "b": "   ",
  "c": "  bat",
  "d": "bat",
  "e": "bat"
}
```

## leftPad(text: Null, size: Any, padText: Any = " "): Null

Helper function that enables `leftPad` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=62db060bcb5b713cf760f15c7fd273a2e8e230e5ee08694cc13ac4c309aa18fd url=/mulesoft/current/en-us/dataweave/2.3/dw-strings-functions-leftpad.md -->

---
product: DataWeave
version: 2.3
---

# leftPad

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## leftPad(String, Number, String): String

The specified `text` is _left_\-padded to the `size` using the `padText`. By default `padText` is
`" "`.

Returns left-padded `String` or original `String` if no padding is necessary.

_Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>size</code></p></td><td><p>The size to pad to.</p></td></tr><tr><td><p><code>padText</code></p></td><td><p>The text to pad with. It defaults to one space if not specified.</p></td></tr></tbody></table>

### Example

This example shows how `leftPad` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
   "a": leftPad(null, 3),
   "b": leftPad("", 3),
   "c": leftPad("bat", 5),
   "d": leftPad("bat", 3),
   "e": leftPad("bat", -1)
}
```

#### Output

```JSON
{
  "a": null,
  "b": "   ",
  "c": "  bat",
  "d": "bat",
  "e": "bat"
}
```

## leftPad(Null, Number, String): Null

Helper function that enables `leftPad` to work with a `null` value.

<!-- document id=cfef1485dcce18fc0984784584703e52f9db4ff852e62c8f45d01aadf281864e url=/mulesoft/current/en-us/dataweave/2.4/dw-strings-functions-leftpad.md -->

---
product: DataWeave
version: 2.4
---

# leftPad

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## leftPad(text: String, size: Number, padText: String = " "): String

The specified `text` is _left_\-padded to the `size` using the `padText`. By default `padText` is
`" "`.

Returns left-padded `String` or original `String` if no padding is necessary.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>size</code></p></td><td><p>The size to pad to.</p></td></tr><tr><td><p><code>padText</code></p></td><td><p>The text to pad with. It defaults to one space if not specified.</p></td></tr></tbody></table>

### Example

This example shows how `leftPad` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
   "a": leftPad(null, 3),
   "b": leftPad("", 3),
   "c": leftPad("bat", 5),
   "d": leftPad("bat", 3),
   "e": leftPad("bat", -1)
}
```

#### Output

```JSON
{
  "a": null,
  "b": "   ",
  "c": "  bat",
  "d": "bat",
  "e": "bat"
}
```

## leftPad(text: Null, size: Any, padText: Any = " "): Null

Helper function that enables `leftPad` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=3380ba1dc14ad49442fb7c6490b031516b8379ca4508df47351676993cde8b09 url=/mulesoft/current/en-us/dataweave/2.6/dw-strings-functions-leftpad.md -->

---
product: DataWeave
version: 2.6
---

# leftPad

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## leftPad(text: String, size: Number, padText: String = " "): String

The specified `text` is _left_\-padded to the `size` using the `padText`. By default `padText` is
`" "`.

Returns left-padded `String` or original `String` if no padding is necessary.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>size</code></p></td><td><p>The size to pad to.</p></td></tr><tr><td><p><code>padText</code></p></td><td><p>The text to pad with. It defaults to one space if not specified.</p></td></tr></tbody></table>

### Example

This example shows how `leftPad` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
   "a": leftPad(null, 3),
   "b": leftPad("", 3),
   "c": leftPad("bat", 5),
   "d": leftPad("bat", 3),
   "e": leftPad("bat", -1)
}
```

#### Output

```JSON
{
  "a": null,
  "b": "   ",
  "c": "  bat",
  "d": "bat",
  "e": "bat"
}
```

## leftPad(text: Null, size: Any, padText: Any = " "): Null

Helper function that enables `leftPad` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=7c140ba3b21f304ad6d65793e7a9d4ea87b4ea7c7feba96fcc16b2495ed9a33d url=/mulesoft/current/en-us/dataweave/2.9/dw-strings-functions-leftpad.md -->

---
product: DataWeave
version: 2.9
---

# leftPad

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## leftPad(text: String, size: Number, padText: String = " "): String

The specified `text` is _left_\-padded to the `size` using the `padText`. By default `padText` is
`" "`.

Returns left-padded `String` or original `String` if no padding is necessary.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>size</code></p></td><td><p>The size to pad to.</p></td></tr><tr><td><p><code>padText</code></p></td><td><p>The text to pad with. It defaults to one space if not specified.</p></td></tr></tbody></table>

### Example

This example shows how `leftPad` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
   "a": leftPad(null, 3),
   "b": leftPad("", 3),
   "c": leftPad("bat", 5),
   "d": leftPad("bat", 3),
   "e": leftPad("bat", -1)
}
```

#### Output

```JSON
{
  "a": null,
  "b": "   ",
  "c": "  bat",
  "d": "bat",
  "e": "bat"
}
```

## leftPad(text: Null, size: Any, padText: Any = " "): Null

Helper function that enables `leftPad` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=fa6cdcda2e4f48c7ea9f149b5316d8d26661ad8fae058c859190bb40c5bd75dd url=/mulesoft/current/en-us/dataweave/latest/dw-strings-functions-leftpad.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# leftPad

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## leftPad(text: String, size: Number, padText: String = " "): String

The specified `text` is _left_\-padded to the `size` using the `padText`. By default `padText` is
`" "`.

Returns left-padded `String` or original `String` if no padding is necessary.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>size</code></p></td><td><p>The size to pad to.</p></td></tr><tr><td><p><code>padText</code></p></td><td><p>The text to pad with. It defaults to one space if not specified.</p></td></tr></tbody></table>

### Example

This example shows how `leftPad` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
   "a": leftPad(null, 3),
   "b": leftPad("", 3),
   "c": leftPad("bat", 5),
   "d": leftPad("bat", 3),
   "e": leftPad("bat", -1)
}
```

#### Output

```JSON
{
  "a": null,
  "b": "   ",
  "c": "  bat",
  "d": "bat",
  "e": "bat"
}
```

## leftPad(text: Null, size: Any, padText: Any = " "): Null

Helper function that enables `leftPad` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=abc7e90b1f13d7a7cc316833594d8acd166bc94907c62d9c56600fef424338bf url=/mulesoft/current/en-us/dataweave/2.11/dw-strings-functions-levenshteindistance.md -->

---
product: DataWeave
version: 2.11
---

# levenshteinDistance

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## levenshteinDistance(a: String, b: String): Number

Returns the Levenshtein distance (or edit distance) between two strings.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>a</code></p></td><td><p>The first string.</p></td></tr><tr><td><p><code>b</code></p></td><td><p>The second string.</p></td></tr></tbody></table>

### Example

This example shows how `levenshteinDistance` behaves with different strings.

#### Source

```DataWeave
%dw 2.0
import levenshteinDistance from dw::core::Strings
output application/json
---
"kitten" levenshteinDistance "sitting"
```

#### Output

```Json
3
```

<!-- document id=c4d5498fb4b9c7790cc890a8c68737ca16b63e7417fc904eafae7e9a449db8db url=/mulesoft/current/en-us/dataweave/2.12/dw-strings-functions-levenshteindistance.md -->

---
product: DataWeave
version: 2.12
---

# levenshteinDistance

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## levenshteinDistance(a: String, b: String): Number

Returns the Levenshtein distance (or edit distance) between two strings.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>a</code></p></td><td><p>The first string.</p></td></tr><tr><td><p><code>b</code></p></td><td><p>The second string.</p></td></tr></tbody></table>

### Example

This example shows how `levenshteinDistance` behaves with different strings.

#### Source

```DataWeave
%dw 2.0
import levenshteinDistance from dw::core::Strings
output application/json
---
"kitten" levenshteinDistance "sitting"
```

#### Output

```Json
3
```

<!-- document id=4c6e7cb04e2cf57b92b1d2e6245d7ecac7dbb4b74d3a599a1da11efb74baa36f url=/mulesoft/current/en-us/dataweave/2.4/dw-strings-functions-levenshteindistance.md -->

---
product: DataWeave
version: 2.4
---

# levenshteinDistance

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## levenshteinDistance(a: String, b: String): Number

Returns the Levenshtein distance (or edit distance) between two strings.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>a</code></p></td><td><p>The first string.</p></td></tr><tr><td><p><code>b</code></p></td><td><p>The second string.</p></td></tr></tbody></table>

### Example

This example shows how `levenshteinDistance` behaves with different strings.

#### Source

```DataWeave
%dw 2.0
import levenshteinDistance from dw::core::Strings
output application/json
---
"kitten" levenshteinDistance "sitting"
```

#### Output

```Json
3
```

<!-- document id=a5066ff3134529b84cc3be3d1c2eb1354d15866eac690f5c42cd51816a8f12ac url=/mulesoft/current/en-us/dataweave/2.6/dw-strings-functions-levenshteindistance.md -->

---
product: DataWeave
version: 2.6
---

# levenshteinDistance

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## levenshteinDistance(a: String, b: String): Number

Returns the Levenshtein distance (or edit distance) between two strings.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>a</code></p></td><td><p>The first string.</p></td></tr><tr><td><p><code>b</code></p></td><td><p>The second string.</p></td></tr></tbody></table>

### Example

This example shows how `levenshteinDistance` behaves with different strings.

#### Source

```DataWeave
%dw 2.0
import levenshteinDistance from dw::core::Strings
output application/json
---
"kitten" levenshteinDistance "sitting"
```

#### Output

```Json
3
```

<!-- document id=7a54fc0b8b7cfc53dfb09412f83a6ca4329a74b0170158717bd8caa81411787f url=/mulesoft/current/en-us/dataweave/2.9/dw-strings-functions-levenshteindistance.md -->

---
product: DataWeave
version: 2.9
---

# levenshteinDistance

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## levenshteinDistance(a: String, b: String): Number

Returns the Levenshtein distance (or edit distance) between two strings.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>a</code></p></td><td><p>The first string.</p></td></tr><tr><td><p><code>b</code></p></td><td><p>The second string.</p></td></tr></tbody></table>

### Example

This example shows how `levenshteinDistance` behaves with different strings.

#### Source

```DataWeave
%dw 2.0
import levenshteinDistance from dw::core::Strings
output application/json
---
"kitten" levenshteinDistance "sitting"
```

#### Output

```Json
3
```

<!-- document id=d3c23fd9eef22e296d5082d5077aeff2ff1883d09838c99dcbffcda3952c96c3 url=/mulesoft/current/en-us/dataweave/latest/dw-strings-functions-levenshteindistance.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# levenshteinDistance

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## levenshteinDistance(a: String, b: String): Number

Returns the Levenshtein distance (or edit distance) between two strings.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>a</code></p></td><td><p>The first string.</p></td></tr><tr><td><p><code>b</code></p></td><td><p>The second string.</p></td></tr></tbody></table>

### Example

This example shows how `levenshteinDistance` behaves with different strings.

#### Source

```DataWeave
%dw 2.0
import levenshteinDistance from dw::core::Strings
output application/json
---
"kitten" levenshteinDistance "sitting"
```

#### Output

```Json
3
```

<!-- document id=eb7b97af1868dc7ebd4194b11e7f26e7eed95998042489d791c23cb35db0aa1f url=/mulesoft/current/en-us/dataweave/2.11/dw-strings-functions-lines.md -->

---
product: DataWeave
version: 2.11
---

# lines

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## lines(text: String): Array<String>

Returns an array of lines from a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to split into lines.</p></td></tr></tbody></table>

### Example

This example divides a string into lines. An `\n` represents a line break.

#### Source

```DataWeave
%dw 2.0
import lines from dw::core::Strings
output application/json
---
lines("hello world\n\nhere   data-weave")
```

#### Output

```Json
["hello world", "", "here   data-weave"]
```

## lines(text: Null): Null

Helper function that enables `lines` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=230ca48402826c7f4f7099e2cd91b5d233f9ee5e2817d066f449c7894f9e7530 url=/mulesoft/current/en-us/dataweave/2.12/dw-strings-functions-lines.md -->

---
product: DataWeave
version: 2.12
---

# lines

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## lines(text: String): Array<String>

Returns an array of lines from a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to split into lines.</p></td></tr></tbody></table>

### Example

This example divides a string into lines. An `\n` represents a line break.

#### Source

```DataWeave
%dw 2.0
import lines from dw::core::Strings
output application/json
---
lines("hello world\n\nhere   data-weave")
```

#### Output

```Json
["hello world", "", "here   data-weave"]
```

## lines(text: Null): Null

Helper function that enables `lines` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=9b7d15cdb3bb90191d237989533b52b9022b9ab41423e372192dfbab7e860009 url=/mulesoft/current/en-us/dataweave/2.4/dw-strings-functions-lines.md -->

---
product: DataWeave
version: 2.4
---

# lines

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## lines(text: String): Array<String>

Returns an array of lines from a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to split into lines.</p></td></tr></tbody></table>

### Example

This example divides a string into lines. An `\n` represents a line break.

#### Source

```DataWeave
%dw 2.0
import lines from dw::core::Strings
output application/json
---
lines("hello world\n\nhere   data-weave")
```

#### Output

```Json
["hello world", "", "here   data-weave"]
```

## lines(text: Null): Null

Helper function that enables `lines` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=fcbb7ba6fbb1f69796375663587fa5642913a9994a82f97f7a027ba2e6f6f365 url=/mulesoft/current/en-us/dataweave/2.6/dw-strings-functions-lines.md -->

---
product: DataWeave
version: 2.6
---

# lines

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## lines(text: String): Array<String>

Returns an array of lines from a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to split into lines.</p></td></tr></tbody></table>

### Example

This example divides a string into lines. An `\n` represents a line break.

#### Source

```DataWeave
%dw 2.0
import lines from dw::core::Strings
output application/json
---
lines("hello world\n\nhere   data-weave")
```

#### Output

```Json
["hello world", "", "here   data-weave"]
```

## lines(text: Null): Null

Helper function that enables `lines` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=11bd386a62e345589ea29876d4390a11d299056d0a78a461a46691f772bc4e9d url=/mulesoft/current/en-us/dataweave/2.9/dw-strings-functions-lines.md -->

---
product: DataWeave
version: 2.9
---

# lines

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## lines(text: String): Array<String>

Returns an array of lines from a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to split into lines.</p></td></tr></tbody></table>

### Example

This example divides a string into lines. An `\n` represents a line break.

#### Source

```DataWeave
%dw 2.0
import lines from dw::core::Strings
output application/json
---
lines("hello world\n\nhere   data-weave")
```

#### Output

```Json
["hello world", "", "here   data-weave"]
```

## lines(text: Null): Null

Helper function that enables `lines` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=9f86394415c7f057debd85209a2fef72d976fc2434da50b8b2f744be071efa21 url=/mulesoft/current/en-us/dataweave/latest/dw-strings-functions-lines.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# lines

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## lines(text: String): Array<String>

Returns an array of lines from a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to split into lines.</p></td></tr></tbody></table>

### Example

This example divides a string into lines. An `\n` represents a line break.

#### Source

```DataWeave
%dw 2.0
import lines from dw::core::Strings
output application/json
---
lines("hello world\n\nhere   data-weave")
```

#### Output

```Json
["hello world", "", "here   data-weave"]
```

## lines(text: Null): Null

Helper function that enables `lines` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=f88284764d710b0d4e3fed717584a234397d81447e8223d2d788492788526ac4 url=/mulesoft/current/en-us/dataweave/2.11/dw-types-functions-literalvalueof.md -->

---
product: DataWeave
version: 2.11
---

# literalValueOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## literalValueOf(t: Type): String | Number | Boolean

Returns the value of an input belongs to the Literal type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `literalValueOf` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = "Mariano"
output application/json
---
{
   a: literalValueOf(AType)
}
```

#### Output

```Json
{
  "a": "Mariano"
}
```

<!-- document id=4d4d209a2901d076fa80e3b860c9da25d760b686e84787ac8f4d274c3a2671d2 url=/mulesoft/current/en-us/dataweave/2.12/dw-types-functions-literalvalueof.md -->

---
product: DataWeave
version: 2.12
---

# literalValueOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## literalValueOf(t: Type): String | Number | Boolean

Returns the value of an input belongs to the Literal type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `literalValueOf` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = "Mariano"
output application/json
---
{
   a: literalValueOf(AType)
}
```

#### Output

```Json
{
  "a": "Mariano"
}
```

<!-- document id=d2b225beeb6de9a684293431c41ae54a2549c23fcebca2aaa9d1c6fc9d451281 url=/mulesoft/current/en-us/dataweave/2.3/dw-types-functions-literalvalueof.md -->

---
product: DataWeave
version: 2.3
---

# literalValueOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## literalValueOf(Type): String | Number | Boolean

Returns the value of an input belongs to the Literal type.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>t</p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `literalValueOf` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = "Mariano"
output application/json
---
{
   a: literalValueOf(AType)
}
```

#### Output

```Json
{
  "a": "Mariano"
}
```

<!-- document id=4255663f5c6bdbc7dd8e40734d3ae732620d593ca5f24194bb063fa3aff844ce url=/mulesoft/current/en-us/dataweave/2.4/dw-types-functions-literalvalueof.md -->

---
product: DataWeave
version: 2.4
---

# literalValueOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## literalValueOf(t: Type): String | Number | Boolean

Returns the value of an input belongs to the Literal type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `literalValueOf` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = "Mariano"
output application/json
---
{
   a: literalValueOf(AType)
}
```

#### Output

```Json
{
  "a": "Mariano"
}
```

<!-- document id=2cfce70ebcb97b0e3e483bfc79483c2c5e65e98f55df0d5d607d24cc2a957085 url=/mulesoft/current/en-us/dataweave/2.6/dw-types-functions-literalvalueof.md -->

---
product: DataWeave
version: 2.6
---

# literalValueOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## literalValueOf(t: Type): String | Number | Boolean

Returns the value of an input belongs to the Literal type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `literalValueOf` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = "Mariano"
output application/json
---
{
   a: literalValueOf(AType)
}
```

#### Output

```Json
{
  "a": "Mariano"
}
```

<!-- document id=8dea78b499fe27aa1c78ecc1117d33c00c2cb119583c02fca33ee5c0814fa063 url=/mulesoft/current/en-us/dataweave/2.9/dw-types-functions-literalvalueof.md -->

---
product: DataWeave
version: 2.9
---

# literalValueOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## literalValueOf(t: Type): String | Number | Boolean

Returns the value of an input belongs to the Literal type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `literalValueOf` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = "Mariano"
output application/json
---
{
   a: literalValueOf(AType)
}
```

#### Output

```Json
{
  "a": "Mariano"
}
```

<!-- document id=6e60b3e8a8d94130e8210cff79ab3c41171635e15e0fab7ffe9c9fd0bb296d3e url=/mulesoft/current/en-us/dataweave/latest/dw-types-functions-literalvalueof.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# literalValueOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## literalValueOf(t: Type): String | Number | Boolean

Returns the value of an input belongs to the Literal type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `literalValueOf` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = "Mariano"
output application/json
---
{
   a: literalValueOf(AType)
}
```

#### Output

```Json
{
  "a": "Mariano"
}
```

<!-- document id=30027d69b888934af0a1cd262687890b6d6f4c8c7ed3fc5d6ac52d2fd88dcc38 url=/mulesoft/current/en-us/dataweave/2.11/dw-dates-functions-localdatetime.md -->

---
product: DataWeave
version: 2.11
---

# localDateTime

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## localDateTime(parts: LocalDateTimeFactory): LocalDateTime

Creates a `LocalDateTime` value from values specified for `year`, `month`, `day`, `hour`, `minutes`,
and `seconds` fields.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>parts</code></p></td><td><div><div><p><code>Number</code> values for <code>year</code>, <code>month</code>, <code>day</code>, <code>hour</code>, <code>minutes</code>, and <code>seconds</code> fields. Valid values are numbers between 1 and 12 for the <code>month</code>, 1 through 31 for the <code>day</code>, 0 through 23 for the <code>hour</code>, 0 through 59 for <code>minutes</code>, and 0 through 59 (including decimals, such as 59.99) for <code>seconds</code> fields. You can specify the name-value pairs in any order, but the output is ordered as a default <code>LocalDateTime</code> value, such as <code>2012-10-11T10:10:10</code>. The input fields are parts of a <code>LocalDateTimeFactory</code> type.</p></div></div></td></tr></tbody></table>

### Example

This example shows how to create a value of type `LocalDateTime`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
    newLocalDateTime: localDateTime({year: 2012, month: 10, day: 11, hour: 12, minutes: 30, seconds: 40})
}
```

#### Output

```Json
{
   "newLocalDateTime": "2012-10-11T12:30:40"
}
```

<!-- document id=3ffa416225c0e527a0662886808154bab2805bd61a0d77a399e0860c5ca27a2e url=/mulesoft/current/en-us/dataweave/2.12/dw-dates-functions-localdatetime.md -->

---
product: DataWeave
version: 2.12
---

# localDateTime

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## localDateTime(parts: LocalDateTimeFactory): LocalDateTime

Creates a `LocalDateTime` value from values specified for `year`, `month`, `day`, `hour`, `minutes`,
and `seconds` fields.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>parts</code></p></td><td><div><div><p><code>Number</code> values for <code>year</code>, <code>month</code>, <code>day</code>, <code>hour</code>, <code>minutes</code>, and <code>seconds</code> fields. Valid values are numbers between 1 and 12 for the <code>month</code>, 1 through 31 for the <code>day</code>, 0 through 23 for the <code>hour</code>, 0 through 59 for <code>minutes</code>, and 0 through 59 (including decimals, such as 59.99) for <code>seconds</code> fields. You can specify the name-value pairs in any order, but the output is ordered as a default <code>LocalDateTime</code> value, such as <code>2012-10-11T10:10:10</code>. The input fields are parts of a <code>LocalDateTimeFactory</code> type.</p></div></div></td></tr></tbody></table>

### Example

This example shows how to create a value of type `LocalDateTime`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
    newLocalDateTime: localDateTime({year: 2012, month: 10, day: 11, hour: 12, minutes: 30, seconds: 40})
}
```

#### Output

```Json
{
   "newLocalDateTime": "2012-10-11T12:30:40"
}
```

<!-- document id=6a32b32c8d90729b1dbaf01cbe95edda86fc661b7777c33ddf3a17cc0f472212 url=/mulesoft/current/en-us/dataweave/2.4/dw-dates-functions-localdatetime.md -->

---
product: DataWeave
version: 2.4
---

# localDateTime

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## localDateTime(parts: LocalDateTimeFactory): LocalDateTime

Creates a `LocalDateTime` value from values specified for `year`, `month`, `day`, `hour`, `minutes`,
and `seconds` fields.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>parts</code></p></td><td><div><div><p><code>Number</code> values for <code>year</code>, <code>month</code>, <code>day</code>, <code>hour</code>, <code>minutes</code>, and <code>seconds</code> fields. Valid values are numbers between 1 and 12 for the <code>month</code>, 1 through 31 for the <code>day</code>, 0 through 23 for the <code>hour</code>, 0 through 59 for <code>minutes</code>, and 0 through 59 (including decimals, such as 59.99) for <code>seconds</code> fields. You can specify the name-value pairs in any order, but the output is ordered as a default <code>LocalDateTime</code> value, such as <code>2012-10-11T10:10:10</code>. The input fields are parts of a <code>LocalDateTimeFactory</code> type.</p></div></div></td></tr></tbody></table>

### Example

This example shows how to create a value of type `LocalDateTime`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
    newLocalDateTime: localDateTime({year: 2012, month: 10, day: 11, hour: 12, minutes: 30, seconds: 40})
}
```

#### Output

```Json
{
   "newLocalDateTime": "2012-10-11T12:30:40"
}
```

<!-- document id=e6ce6c09b716a46378c8cf3cc0a7074bc960815e2b4e3b3cf43c39f967be4ecc url=/mulesoft/current/en-us/dataweave/2.6/dw-dates-functions-localdatetime.md -->

---
product: DataWeave
version: 2.6
---

# localDateTime

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## localDateTime(parts: LocalDateTimeFactory): LocalDateTime

Creates a `LocalDateTime` value from values specified for `year`, `month`, `day`, `hour`, `minutes`,
and `seconds` fields.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>parts</code></p></td><td><div><div><p><code>Number</code> values for <code>year</code>, <code>month</code>, <code>day</code>, <code>hour</code>, <code>minutes</code>, and <code>seconds</code> fields. Valid values are numbers between 1 and 12 for the <code>month</code>, 1 through 31 for the <code>day</code>, 0 through 23 for the <code>hour</code>, 0 through 59 for <code>minutes</code>, and 0 through 59 (including decimals, such as 59.99) for <code>seconds</code> fields. You can specify the name-value pairs in any order, but the output is ordered as a default <code>LocalDateTime</code> value, such as <code>2012-10-11T10:10:10</code>. The input fields are parts of a <code>LocalDateTimeFactory</code> type.</p></div></div></td></tr></tbody></table>

### Example

This example shows how to create a value of type `LocalDateTime`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
    newLocalDateTime: localDateTime({year: 2012, month: 10, day: 11, hour: 12, minutes: 30, seconds: 40})
}
```

#### Output

```Json
{
   "newLocalDateTime": "2012-10-11T12:30:40"
}
```

<!-- document id=5d31f894e1531859751b5271c946f62ae69521b4d51f0b278099713c606936d5 url=/mulesoft/current/en-us/dataweave/2.9/dw-dates-functions-localdatetime.md -->

---
product: DataWeave
version: 2.9
---

# localDateTime

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## localDateTime(parts: LocalDateTimeFactory): LocalDateTime

Creates a `LocalDateTime` value from values specified for `year`, `month`, `day`, `hour`, `minutes`,
and `seconds` fields.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>parts</code></p></td><td><div><div><p><code>Number</code> values for <code>year</code>, <code>month</code>, <code>day</code>, <code>hour</code>, <code>minutes</code>, and <code>seconds</code> fields. Valid values are numbers between 1 and 12 for the <code>month</code>, 1 through 31 for the <code>day</code>, 0 through 23 for the <code>hour</code>, 0 through 59 for <code>minutes</code>, and 0 through 59 (including decimals, such as 59.99) for <code>seconds</code> fields. You can specify the name-value pairs in any order, but the output is ordered as a default <code>LocalDateTime</code> value, such as <code>2012-10-11T10:10:10</code>. The input fields are parts of a <code>LocalDateTimeFactory</code> type.</p></div></div></td></tr></tbody></table>

### Example

This example shows how to create a value of type `LocalDateTime`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
    newLocalDateTime: localDateTime({year: 2012, month: 10, day: 11, hour: 12, minutes: 30, seconds: 40})
}
```

#### Output

```Json
{
   "newLocalDateTime": "2012-10-11T12:30:40"
}
```

<!-- document id=4f12880fb01334b1c57a2913c87fa7b7acce6ab27f30361fc2c76783666cdc52 url=/mulesoft/current/en-us/dataweave/latest/dw-dates-functions-localdatetime.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# localDateTime

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## localDateTime(parts: LocalDateTimeFactory): LocalDateTime

Creates a `LocalDateTime` value from values specified for `year`, `month`, `day`, `hour`, `minutes`,
and `seconds` fields.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>parts</code></p></td><td><div><div><p><code>Number</code> values for <code>year</code>, <code>month</code>, <code>day</code>, <code>hour</code>, <code>minutes</code>, and <code>seconds</code> fields. Valid values are numbers between 1 and 12 for the <code>month</code>, 1 through 31 for the <code>day</code>, 0 through 23 for the <code>hour</code>, 0 through 59 for <code>minutes</code>, and 0 through 59 (including decimals, such as 59.99) for <code>seconds</code> fields. You can specify the name-value pairs in any order, but the output is ordered as a default <code>LocalDateTime</code> value, such as <code>2012-10-11T10:10:10</code>. The input fields are parts of a <code>LocalDateTimeFactory</code> type.</p></div></div></td></tr></tbody></table>

### Example

This example shows how to create a value of type `LocalDateTime`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
    newLocalDateTime: localDateTime({year: 2012, month: 10, day: 11, hour: 12, minutes: 30, seconds: 40})
}
```

#### Output

```Json
{
   "newLocalDateTime": "2012-10-11T12:30:40"
}
```

<!-- document id=5e3cb5878022640a6e70270b86556e1dc144a56661dc6d6141efb6666e64d346 url=/mulesoft/current/en-us/dataweave/2.11/dw-dates-functions-localtime.md -->

---
product: DataWeave
version: 2.11
---

# localTime

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## localTime(parts: LocalTimeFactory): LocalTime

Creates a `LocalTime` value from values specified for `hour`, `minutes`, and `seconds` fields.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>parts</code></p></td><td><div><div><p><code>Number</code> values for <code>hour</code>, <code>minutes</code>, and <code>seconds</code> fields. Valid values are 0 through 23 for the <code>hour</code>, 0 through 59 for <code>minutes</code>, and 0 through 59 (including decimals, such as 59.99) for <code>seconds</code> fields. You can specify the name-value pairs in any order, but the output is ordered as a default <code>LocalTime</code> value, such as <code>10:10:10</code>. The input fields are parts of a <code>LocalDateTimeFactory</code> type.</p></div></div></td></tr></tbody></table>

### Example

This example shows how to create a value of type `LocalTime`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  newLocalTime: localTime({ hour: 12, minutes: 30, seconds: 40})
}
```

#### Output

```Json
{
   "newLocalTime": "12:30:40"
}
```

<!-- document id=2475e4d6053d5f5036644dbfe4d6a5a078947ea343a3bb9d9a22f95542ffb3a1 url=/mulesoft/current/en-us/dataweave/2.12/dw-dates-functions-localtime.md -->

---
product: DataWeave
version: 2.12
---

# localTime

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## localTime(parts: LocalTimeFactory): LocalTime

Creates a `LocalTime` value from values specified for `hour`, `minutes`, and `seconds` fields.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>parts</code></p></td><td><div><div><p><code>Number</code> values for <code>hour</code>, <code>minutes</code>, and <code>seconds</code> fields. Valid values are 0 through 23 for the <code>hour</code>, 0 through 59 for <code>minutes</code>, and 0 through 59 (including decimals, such as 59.99) for <code>seconds</code> fields. You can specify the name-value pairs in any order, but the output is ordered as a default <code>LocalTime</code> value, such as <code>10:10:10</code>. The input fields are parts of a <code>LocalDateTimeFactory</code> type.</p></div></div></td></tr></tbody></table>

### Example

This example shows how to create a value of type `LocalTime`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  newLocalTime: localTime({ hour: 12, minutes: 30, seconds: 40})
}
```

#### Output

```Json
{
   "newLocalTime": "12:30:40"
}
```

<!-- document id=0039aa6767b679484be1e6eddaed3b53565a7466bda9d34ffc649e879dfb1e4f url=/mulesoft/current/en-us/dataweave/2.4/dw-dates-functions-localtime.md -->

---
product: DataWeave
version: 2.4
---

# localTime

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## localTime(parts: LocalTimeFactory): LocalTime

Creates a `LocalTime` value from values specified for `hour`, `minutes`, and `seconds` fields.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>parts</code></p></td><td><div><div><p><code>Number</code> values for <code>hour</code>, <code>minutes</code>, and <code>seconds</code> fields. Valid values are 0 through 23 for the <code>hour</code>, 0 through 59 for <code>minutes</code>, and 0 through 59 (including decimals, such as 59.99) for <code>seconds</code> fields. You can specify the name-value pairs in any order, but the output is ordered as a default <code>LocalTime</code> value, such as <code>10:10:10</code>. The input fields are parts of a <code>LocalDateTimeFactory</code> type.</p></div></div></td></tr></tbody></table>

### Example

This example shows how to create a value of type `LocalTime`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  newLocalTime: localTime({ hour: 12, minutes: 30, seconds: 40})
}
```

#### Output

```Json
{
   "newLocalTime": "12:30:40"
}
```

<!-- document id=1a999620799b08aa59f200ccf0edb83020ae7bc2d827dc1bad5ab927179c9233 url=/mulesoft/current/en-us/dataweave/2.6/dw-dates-functions-localtime.md -->

---
product: DataWeave
version: 2.6
---

# localTime

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## localTime(parts: LocalTimeFactory): LocalTime

Creates a `LocalTime` value from values specified for `hour`, `minutes`, and `seconds` fields.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>parts</code></p></td><td><div><div><p><code>Number</code> values for <code>hour</code>, <code>minutes</code>, and <code>seconds</code> fields. Valid values are 0 through 23 for the <code>hour</code>, 0 through 59 for <code>minutes</code>, and 0 through 59 (including decimals, such as 59.99) for <code>seconds</code> fields. You can specify the name-value pairs in any order, but the output is ordered as a default <code>LocalTime</code> value, such as <code>10:10:10</code>. The input fields are parts of a <code>LocalDateTimeFactory</code> type.</p></div></div></td></tr></tbody></table>

### Example

This example shows how to create a value of type `LocalTime`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  newLocalTime: localTime({ hour: 12, minutes: 30, seconds: 40})
}
```

#### Output

```Json
{
   "newLocalTime": "12:30:40"
}
```

<!-- document id=8c9b3a39e79efa6e1473e21c0f0b009dc004b467b5b021d79cf1f14c86756db9 url=/mulesoft/current/en-us/dataweave/2.9/dw-dates-functions-localtime.md -->

---
product: DataWeave
version: 2.9
---

# localTime

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## localTime(parts: LocalTimeFactory): LocalTime

Creates a `LocalTime` value from values specified for `hour`, `minutes`, and `seconds` fields.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>parts</code></p></td><td><div><div><p><code>Number</code> values for <code>hour</code>, <code>minutes</code>, and <code>seconds</code> fields. Valid values are 0 through 23 for the <code>hour</code>, 0 through 59 for <code>minutes</code>, and 0 through 59 (including decimals, such as 59.99) for <code>seconds</code> fields. You can specify the name-value pairs in any order, but the output is ordered as a default <code>LocalTime</code> value, such as <code>10:10:10</code>. The input fields are parts of a <code>LocalDateTimeFactory</code> type.</p></div></div></td></tr></tbody></table>

### Example

This example shows how to create a value of type `LocalTime`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  newLocalTime: localTime({ hour: 12, minutes: 30, seconds: 40})
}
```

#### Output

```Json
{
   "newLocalTime": "12:30:40"
}
```

<!-- document id=5cfb4b9cce62afb176338f1755d672c32891baec69fb8fa1ac01bd057b308ce2 url=/mulesoft/current/en-us/dataweave/latest/dw-dates-functions-localtime.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# localTime

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## localTime(parts: LocalTimeFactory): LocalTime

Creates a `LocalTime` value from values specified for `hour`, `minutes`, and `seconds` fields.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>parts</code></p></td><td><div><div><p><code>Number</code> values for <code>hour</code>, <code>minutes</code>, and <code>seconds</code> fields. Valid values are 0 through 23 for the <code>hour</code>, 0 through 59 for <code>minutes</code>, and 0 through 59 (including decimals, such as 59.99) for <code>seconds</code> fields. You can specify the name-value pairs in any order, but the output is ordered as a default <code>LocalTime</code> value, such as <code>10:10:10</code>. The input fields are parts of a <code>LocalDateTimeFactory</code> type.</p></div></div></td></tr></tbody></table>

### Example

This example shows how to create a value of type `LocalTime`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  newLocalTime: localTime({ hour: 12, minutes: 30, seconds: 40})
}
```

#### Output

```Json
{
   "newLocalTime": "12:30:40"
}
```

<!-- document id=627c3244a64a8f67acea3d6d07e1752bfc1b1a197d785ae891c5d89bb77f08ae url=/mulesoft/current/en-us/dataweave/2.11/dw-runtime-functions-location.md -->

---
product: DataWeave
version: 2.11
---

# location

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## location(value: Any): Location

Returns the location of a given value, or `null` if the location can’t be traced back to a DataWeave
file.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>A value of any type.</p></td></tr></tbody></table>

### Example

This example returns the location that defines the function `sqrt` in the `dw::Core` module.

#### Source

```DataWeave
%dw 2.0
import location from dw::Runtime
output application/json
---
location(sqrt)
```

#### Output

```JSON
{
  "uri": "/dw/Core.dwl",
  "nameIdentifier": "dw::Core",
  "startLine": 5797,
  "startColumn": 36,
  "endLine": 5797,
  "endColumn": 77
}
```

<!-- document id=12a7eb240a8fe4d55c796bca10ca07444fcbc447638dee42110ef36a509d60f6 url=/mulesoft/current/en-us/dataweave/2.12/dw-runtime-functions-location.md -->

---
product: DataWeave
version: 2.12
---

# location

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## location(value: Any): Location

Returns the location of a given value, or `null` if the location can’t be traced back to a DataWeave
file.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>A value of any type.</p></td></tr></tbody></table>

### Example

This example returns the location that defines the function `sqrt` in the `dw::Core` module.

#### Source

```DataWeave
%dw 2.0
import location from dw::Runtime
output application/json
---
location(sqrt)
```

#### Output

```JSON
{
  "uri": "/dw/Core.dwl",
  "nameIdentifier": "dw::Core",
  "startLine": 5797,
  "startColumn": 36,
  "endLine": 5797,
  "endColumn": 77
}
```

<!-- document id=ce209eab4a4dd31041feb143466d33103ea293f223cdaf8652544aa2b18b0130 url=/mulesoft/current/en-us/dataweave/2.4/dw-runtime-functions-location.md -->

---
product: DataWeave
version: 2.4
---

# location

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## location(value: Any): Location

Returns the location of a given value, or `null` if the location can’t be traced back to a DataWeave
file.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>A value of any type.</p></td></tr></tbody></table>

### Example

This example returns the location that defines the function `sqrt` in the `dw::Core` module.

#### Source

```DataWeave
%dw 2.0
import location from dw::Runtime
output application/json
---
location(sqrt)
```

#### Output

```JSON
{
  "uri": "/dw/Core.dwl",
  "nameIdentifier": "dw::Core",
  "startLine": 5797,
  "startColumn": 36,
  "endLine": 5797,
  "endColumn": 77
}
```

<!-- document id=2a4c179fbefe1e0ed36dc8bcd01e80b2612bc306ed35c749d23f04abf0d68613 url=/mulesoft/current/en-us/dataweave/2.6/dw-runtime-functions-location.md -->

---
product: DataWeave
version: 2.6
---

# location

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## location(value: Any): Location

Returns the location of a given value, or `null` if the location can’t be traced back to a DataWeave
file.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>A value of any type.</p></td></tr></tbody></table>

### Example

This example returns the location that defines the function `sqrt` in the `dw::Core` module.

#### Source

```DataWeave
%dw 2.0
import location from dw::Runtime
output application/json
---
location(sqrt)
```

#### Output

```JSON
{
  "uri": "/dw/Core.dwl",
  "nameIdentifier": "dw::Core",
  "startLine": 5797,
  "startColumn": 36,
  "endLine": 5797,
  "endColumn": 77
}
```

<!-- document id=dd93aed8dbbad60b209df9564a373703a6d01084bf92c0b79b37133ce90bbb24 url=/mulesoft/current/en-us/dataweave/2.9/dw-runtime-functions-location.md -->

---
product: DataWeave
version: 2.9
---

# location

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## location(value: Any): Location

Returns the location of a given value, or `null` if the location can’t be traced back to a DataWeave
file.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>A value of any type.</p></td></tr></tbody></table>

### Example

This example returns the location that defines the function `sqrt` in the `dw::Core` module.

#### Source

```DataWeave
%dw 2.0
import location from dw::Runtime
output application/json
---
location(sqrt)
```

#### Output

```JSON
{
  "uri": "/dw/Core.dwl",
  "nameIdentifier": "dw::Core",
  "startLine": 5797,
  "startColumn": 36,
  "endLine": 5797,
  "endColumn": 77
}
```

<!-- document id=8b0f4b57e20f0342a1998e5a80dac7660f0a15997af7672588b843a0e332aa57 url=/mulesoft/current/en-us/dataweave/latest/dw-runtime-functions-location.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# location

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## location(value: Any): Location

Returns the location of a given value, or `null` if the location can’t be traced back to a DataWeave
file.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>A value of any type.</p></td></tr></tbody></table>

### Example

This example returns the location that defines the function `sqrt` in the `dw::Core` module.

#### Source

```DataWeave
%dw 2.0
import location from dw::Runtime
output application/json
---
location(sqrt)
```

#### Output

```JSON
{
  "uri": "/dw/Core.dwl",
  "nameIdentifier": "dw::Core",
  "startLine": 5797,
  "startColumn": 36,
  "endLine": 5797,
  "endColumn": 77
}
```

<!-- document id=622edbf3386dc50454e81968e2b9b0f8b949da2e802473bda6b55d63996ff58f url=/mulesoft/current/en-us/dataweave/2.11/dw-runtime-functions-locationstring.md -->

---
product: DataWeave
version: 2.11
---

# locationString

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## locationString(value: Any): String

Returns the location string of a given value.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>A value of any type.</p></td></tr></tbody></table>

### Example

This example returns the contents of the line (the location) that defines variable `a` in the header
of the DataWeave script.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
var a = 123
output application/json
---
locationString(a)
```

#### Output

```JSON
"var a = 123"
```

<!-- document id=b04de35fa2e9fa677f4ae57b77b31f599624cf8f7eac4cf8f8302ef4ffa134d7 url=/mulesoft/current/en-us/dataweave/2.12/dw-runtime-functions-locationstring.md -->

---
product: DataWeave
version: 2.12
---

# locationString

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## locationString(value: Any): String

Returns the location string of a given value.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>A value of any type.</p></td></tr></tbody></table>

### Example

This example returns the contents of the line (the location) that defines variable `a` in the header
of the DataWeave script.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
var a = 123
output application/json
---
locationString(a)
```

#### Output

```JSON
"var a = 123"
```

<!-- document id=608bc1bacbcebe46ea1c7fb367ab6f4fc743c7e09cf11269075f81b092d9b563 url=/mulesoft/current/en-us/dataweave/2.3/dw-runtime-functions-locationstring.md -->

---
product: DataWeave
version: 2.3
---

# locationString

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## locationString(Any): String

Returns the location string of a given value.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>A value of any type.</p></td></tr></tbody></table>

### Example

This example returns the contents of the line (the location) that defines variable `a` in the header
of the DataWeave script.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
var a = 123
output application/json
---
locationString(a)
```

#### Output

```JSON
"var a = 123"
```

<!-- document id=cae669422e2d56dfbaab41553a2aad79407e6269b5370be868e47c92f70f27c6 url=/mulesoft/current/en-us/dataweave/2.4/dw-runtime-functions-locationstring.md -->

---
product: DataWeave
version: 2.4
---

# locationString

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## locationString(value: Any): String

Returns the location string of a given value.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>A value of any type.</p></td></tr></tbody></table>

### Example

This example returns the contents of the line (the location) that defines variable `a` in the header
of the DataWeave script.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
var a = 123
output application/json
---
locationString(a)
```

#### Output

```JSON
"var a = 123"
```

<!-- document id=cdf78f152fed3ca5b04f93606f986816988c1d5af1e1af91503acbf474dfa6bc url=/mulesoft/current/en-us/dataweave/2.6/dw-runtime-functions-locationstring.md -->

---
product: DataWeave
version: 2.6
---

# locationString

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## locationString(value: Any): String

Returns the location string of a given value.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>A value of any type.</p></td></tr></tbody></table>

### Example

This example returns the contents of the line (the location) that defines variable `a` in the header
of the DataWeave script.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
var a = 123
output application/json
---
locationString(a)
```

#### Output

```JSON
"var a = 123"
```

<!-- document id=aee2eb1bdecd4cae77de4a89a054384c0a74c456ca95d1e61408305ebc494fa4 url=/mulesoft/current/en-us/dataweave/2.9/dw-runtime-functions-locationstring.md -->

---
product: DataWeave
version: 2.9
---

# locationString

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## locationString(value: Any): String

Returns the location string of a given value.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>A value of any type.</p></td></tr></tbody></table>

### Example

This example returns the contents of the line (the location) that defines variable `a` in the header
of the DataWeave script.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
var a = 123
output application/json
---
locationString(a)
```

#### Output

```JSON
"var a = 123"
```

<!-- document id=aed0568e2f0c95443f8afc3008eb1174d444128ecbc6aa1826abb078fe953a61 url=/mulesoft/current/en-us/dataweave/latest/dw-runtime-functions-locationstring.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# locationString

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## locationString(value: Any): String

Returns the location string of a given value.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>A value of any type.</p></td></tr></tbody></table>

### Example

This example returns the contents of the line (the location) that defines variable `a` in the header
of the DataWeave script.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
var a = 123
output application/json
---
locationString(a)
```

#### Output

```JSON
"var a = 123"
```

<!-- document id=7ac1c0c035c0998173efc40a23538156146538411ea4ec7a5d854075ce88d8da url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-log.md -->

---
product: DataWeave
version: 2.11
---

# log

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## log<T>(prefix: String = "", value: T): T

Without changing the value of the input, `log` returns the input as a system log. So this makes it
very simple to debug your code, because any expression or subexpression can be wrapped with **log**
and the result will be printed out without modifying the result of the expression. The output is
going to be printed in application/dw format.

The prefix parameter is optional and allows to easily find the log output.

Use this function to help with debugging DataWeave scripts. A Mule app outputs the results through
the `DefaultLoggingService`, which you can see in the Studio console.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>prefix</code></p></td><td><p>An optional string that typically describes the log.</p></td></tr><tr><td><p><code>value</code></p></td><td><p>The value to log.</p></td></tr></tbody></table>

### Example

This example logs the specified message. Note that the `DefaultLoggingService` in a Mule app that is
running in Studio returns the message `WARNING - "Houston, we have a problem,"` adding the dash `-`
between the prefix and value. The Logger component’s `LoggerMessageProcessor` returns the input
string `"Houston, we have a problem."`, without the `WARNING` prefix.

#### Source

```DataWeave
%dw 2.0
output application/json
---
log("WARNING", "Houston, we have a problem")
```

#### Output

`Console Output`

```XML
"WARNING - Houston, we have a problem"
```

`Expression Output`

```XML
"Houston, we have a problem"
```

### Example

This example shows how to log the result of expression `myUser.user` without modifying the original
expression `myUser.user.friend.name`.

#### Source

```DataWeave
%dw 2.0
output application/json

var myUser = {user: {friend: {name: "Shoki"}, id: 1, name: "Tomo"}, accountId: "leansh" }
---
log("User", myUser.user).friend.name
```

#### Output

`Console output`

```console
User - {
  friend: {
    name: "Shoki"
  },
  id: 1,
  name: "Tomo"
}
```

`Expression Output`

```DataWeave
"Shoki"
```

<!-- document id=70e44d43db160801a4cb9c0726008613a791b63615a81da1205c8a203bc41a76 url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-log.md -->

---
product: DataWeave
version: 2.12
---

# log

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## log<T>(prefix: String = "", value: T): T

Without changing the value of the input, `log` returns the input as a system log. So this makes it
very simple to debug your code, because any expression or subexpression can be wrapped with **log**
and the result will be printed out without modifying the result of the expression. The output is
going to be printed in application/dw format.

The prefix parameter is optional and allows to easily find the log output.

Use this function to help with debugging DataWeave scripts. A Mule app outputs the results through
the `DefaultLoggingService`, which you can see in the Studio console.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>prefix</code></p></td><td><p>An optional string that typically describes the log.</p></td></tr><tr><td><p><code>value</code></p></td><td><p>The value to log.</p></td></tr></tbody></table>

### Example

This example logs the specified message. Note that the `DefaultLoggingService` in a Mule app that is
running in Studio returns the message `WARNING - "Houston, we have a problem,"` adding the dash `-`
between the prefix and value. The Logger component’s `LoggerMessageProcessor` returns the input
string `"Houston, we have a problem."`, without the `WARNING` prefix.

#### Source

```DataWeave
%dw 2.0
output application/json
---
log("WARNING", "Houston, we have a problem")
```

#### Output

`Console Output`

```XML
"WARNING - Houston, we have a problem"
```

`Expression Output`

```XML
"Houston, we have a problem"
```

### Example

This example shows how to log the result of expression `myUser.user` without modifying the original
expression `myUser.user.friend.name`.

#### Source

```DataWeave
%dw 2.0
output application/json

var myUser = {user: {friend: {name: "Shoki"}, id: 1, name: "Tomo"}, accountId: "leansh" }
---
log("User", myUser.user).friend.name
```

#### Output

`Console output`

```console
User - {
  friend: {
    name: "Shoki"
  },
  id: 1,
  name: "Tomo"
}
```

`Expression Output`

```DataWeave
"Shoki"
```

<!-- document id=039fb7ff66cac868f484b9d4a0d67de2e9961e7b156ea052430c825f91e7cafa url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-log.md -->

---
product: DataWeave
version: 2.3
---

# log

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## log(String, T): T

Without changing the value of the input, `log` returns the input as a system log.

Use this function to help with debugging DataWeave scripts. A Mule app outputs the results through
the `DefaultLoggingService`, which you can see in the Studio console.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>prefix</code></p></td><td><p>An optional string that typically describes the log.</p></td></tr><tr><td><p><code>value</code></p></td><td><p>The value to log.</p></td></tr></tbody></table>

### Example

This example logs the specified message. Note that the `DefaultLoggingService` in a Mule app that is
running in Studio returns the message `WARNING - "Houston, we have a problem,"` adding the dash `-`
between the prefix and value. The Logger component’s `LoggerMessageProcessor` returns the input
string `"Houston, we have a problem."`, without the `WARNING` prefix.

#### Source

```DataWeave
%dw 2.0
output application/json
---
log("WARNING", "Houston, we have a problem.")
```

#### Console Output

```XML
WARNING - "Houston, we have a problem."
```

#### Expression Output

```XML
"Houston, we have a problem."
```

### Example

This example shows how to log the result of expression `myUser.user` without modifying the original
expression `myUser.user.friend.name`.

#### Source

```DataWeave
%dw 2.0
output application/json

var myUser = {user: {friend: {name: "Shoki"}, id: 1, name: "Tomo"}, accountId: "leansh" }
---
log("User", myUser.user).friend.name
```

#### Console Output

```linenums
 User - {
   friend: {
     name: "Shoki"
   },
   id: 1,
   name: "Tomo"
 }
```

#### Expression Output

```linenums
"Shoki"
```

<!-- document id=056c62eaa758f7bd7449a3b78e2e611d57d40335ffdf8eab48a174a0d97c59c6 url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-log.md -->

---
product: DataWeave
version: 2.4
---

# log

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## log<T>(prefix: String = "", value: T): T

Without changing the value of the input, `log` returns the input as a system log. So this makes it
very simple to debug your code, because any expression or subexpression can be wrapped with **log**
and the result will be printed out without modifying the result of the expression. The output is
going to be printed in application/dw format.

The prefix parameter is optional and allows to easily find the log output.

Use this function to help with debugging DataWeave scripts. A Mule app outputs the results through
the `DefaultLoggingService`, which you can see in the Studio console.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>prefix</code></p></td><td><p>An optional string that typically describes the log.</p></td></tr><tr><td><p><code>value</code></p></td><td><p>The value to log.</p></td></tr></tbody></table>

### Example

This example logs the specified message. Note that the `DefaultLoggingService` in a Mule app that is
running in Studio returns the message `WARNING - "Houston, we have a problem,"` adding the dash `-`
between the prefix and value. The Logger component’s `LoggerMessageProcessor` returns the input
string `"Houston, we have a problem."`, without the `WARNING` prefix.

#### Source

```DataWeave
%dw 2.0
output application/json
---
log("WARNING", "Houston, we have a problem")
```

#### Output

`Console Output`

```XML
"WARNING - Houston, we have a problem"
```

`Expression Output`

```XML
"Houston, we have a problem"
```

### Example

This example shows how to log the result of expression `myUser.user` without modifying the original
expression `myUser.user.friend.name`.

#### Source

```DataWeave
%dw 2.0
output application/json

var myUser = {user: {friend: {name: "Shoki"}, id: 1, name: "Tomo"}, accountId: "leansh" }
---
log("User", myUser.user).friend.name
```

#### Output

`Console output`

```console
User - {
  friend: {
    name: "Shoki"
  },
  id: 1,
  name: "Tomo"
}
```

`Expression Output`

```DataWeave
"Shoki"
```

<!-- document id=44434a4584366047ab01d87e1d8e0aeb006d844d26af4405c1f846e46bfee683 url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-log.md -->

---
product: DataWeave
version: 2.6
---

# log

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## log<T>(prefix: String = "", value: T): T

Without changing the value of the input, `log` returns the input as a system log. So this makes it
very simple to debug your code, because any expression or subexpression can be wrapped with **log**
and the result will be printed out without modifying the result of the expression. The output is
going to be printed in application/dw format.

The prefix parameter is optional and allows to easily find the log output.

Use this function to help with debugging DataWeave scripts. A Mule app outputs the results through
the `DefaultLoggingService`, which you can see in the Studio console.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>prefix</code></p></td><td><p>An optional string that typically describes the log.</p></td></tr><tr><td><p><code>value</code></p></td><td><p>The value to log.</p></td></tr></tbody></table>

### Example

This example logs the specified message. Note that the `DefaultLoggingService` in a Mule app that is
running in Studio returns the message `WARNING - "Houston, we have a problem,"` adding the dash `-`
between the prefix and value. The Logger component’s `LoggerMessageProcessor` returns the input
string `"Houston, we have a problem."`, without the `WARNING` prefix.

#### Source

```DataWeave
%dw 2.0
output application/json
---
log("WARNING", "Houston, we have a problem")
```

#### Output

`Console Output`

```XML
"WARNING - Houston, we have a problem"
```

`Expression Output`

```XML
"Houston, we have a problem"
```

### Example

This example shows how to log the result of expression `myUser.user` without modifying the original
expression `myUser.user.friend.name`.

#### Source

```DataWeave
%dw 2.0
output application/json

var myUser = {user: {friend: {name: "Shoki"}, id: 1, name: "Tomo"}, accountId: "leansh" }
---
log("User", myUser.user).friend.name
```

#### Output

`Console output`

```console
User - {
  friend: {
    name: "Shoki"
  },
  id: 1,
  name: "Tomo"
}
```

`Expression Output`

```DataWeave
"Shoki"
```

<!-- document id=f7d4bb1e1072d2240a8f1d7b0873790530d74344cdde24908ffdd530c8f72c8f url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-log.md -->

---
product: DataWeave
version: 2.9
---

# log

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## log<T>(prefix: String = "", value: T): T

Without changing the value of the input, `log` returns the input as a system log. So this makes it
very simple to debug your code, because any expression or subexpression can be wrapped with **log**
and the result will be printed out without modifying the result of the expression. The output is
going to be printed in application/dw format.

The prefix parameter is optional and allows to easily find the log output.

Use this function to help with debugging DataWeave scripts. A Mule app outputs the results through
the `DefaultLoggingService`, which you can see in the Studio console.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>prefix</code></p></td><td><p>An optional string that typically describes the log.</p></td></tr><tr><td><p><code>value</code></p></td><td><p>The value to log.</p></td></tr></tbody></table>

### Example

This example logs the specified message. Note that the `DefaultLoggingService` in a Mule app that is
running in Studio returns the message `WARNING - "Houston, we have a problem,"` adding the dash `-`
between the prefix and value. The Logger component’s `LoggerMessageProcessor` returns the input
string `"Houston, we have a problem."`, without the `WARNING` prefix.

#### Source

```DataWeave
%dw 2.0
output application/json
---
log("WARNING", "Houston, we have a problem")
```

#### Output

`Console Output`

```XML
"WARNING - Houston, we have a problem"
```

`Expression Output`

```XML
"Houston, we have a problem"
```

### Example

This example shows how to log the result of expression `myUser.user` without modifying the original
expression `myUser.user.friend.name`.

#### Source

```DataWeave
%dw 2.0
output application/json

var myUser = {user: {friend: {name: "Shoki"}, id: 1, name: "Tomo"}, accountId: "leansh" }
---
log("User", myUser.user).friend.name
```

#### Output

`Console output`

```console
User - {
  friend: {
    name: "Shoki"
  },
  id: 1,
  name: "Tomo"
}
```

`Expression Output`

```DataWeave
"Shoki"
```

<!-- document id=70f142ac4e74960902453ed1769e138ca59833072b88ef9e2bd6570197271dc7 url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-log.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# log

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## log<T>(prefix: String = "", value: T): T

Without changing the value of the input, `log` returns the input as a system log. So this makes it
very simple to debug your code, because any expression or subexpression can be wrapped with **log**
and the result will be printed out without modifying the result of the expression. The output is
going to be printed in application/dw format.

The prefix parameter is optional and allows to easily find the log output.

Use this function to help with debugging DataWeave scripts. A Mule app outputs the results through
the `DefaultLoggingService`, which you can see in the Studio console.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>prefix</code></p></td><td><p>An optional string that typically describes the log.</p></td></tr><tr><td><p><code>value</code></p></td><td><p>The value to log.</p></td></tr></tbody></table>

### Example

This example logs the specified message. Note that the `DefaultLoggingService` in a Mule app that is
running in Studio returns the message `WARNING - "Houston, we have a problem,"` adding the dash `-`
between the prefix and value. The Logger component’s `LoggerMessageProcessor` returns the input
string `"Houston, we have a problem."`, without the `WARNING` prefix.

#### Source

```DataWeave
%dw 2.0
output application/json
---
log("WARNING", "Houston, we have a problem")
```

#### Output

`Console Output`

```XML
"WARNING - Houston, we have a problem"
```

`Expression Output`

```XML
"Houston, we have a problem"
```

### Example

This example shows how to log the result of expression `myUser.user` without modifying the original
expression `myUser.user.friend.name`.

#### Source

```DataWeave
%dw 2.0
output application/json

var myUser = {user: {friend: {name: "Shoki"}, id: 1, name: "Tomo"}, accountId: "leansh" }
---
log("User", myUser.user).friend.name
```

#### Output

`Console output`

```console
User - {
  friend: {
    name: "Shoki"
  },
  id: 1,
  name: "Tomo"
}
```

`Expression Output`

```DataWeave
"Shoki"
```

<!-- document id=f5af3a502bcb5b58b52b651e4b0ab5d06e6605eb482e351f9ffa6066b7cf3875 url=/mulesoft/current/en-us/dataweave/2.11/dw-math-functions-log10.md -->

---
product: DataWeave
version: 2.11
---

# log10

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## log10(a: Number): Number | NaN

Returns the logarithm base 10 of a number.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>a</code></p></td><td><div><div><p>A <code>Number</code> value that serves as input to the function.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `log10` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
  "log1010": log10(10),
  "log1013": log10(0.13),
  "log10-20": log10(-20)
}
```

#### Output

```Json
{
   "log1010": 1.0,
   "log1013": -0.8860566476931632,
   "log10-20": null
}
```

<!-- document id=92ec1b7d4521fac60f3bff39b738a9cedfd40bd48823eba3c7e0e253ccf731d7 url=/mulesoft/current/en-us/dataweave/2.12/dw-math-functions-log10.md -->

---
product: DataWeave
version: 2.12
---

# log10

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## log10(a: Number): Number | NaN

Returns the logarithm base 10 of a number.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>a</code></p></td><td><div><div><p>A <code>Number</code> value that serves as input to the function.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `log10` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
  "log1010": log10(10),
  "log1013": log10(0.13),
  "log10-20": log10(-20)
}
```

#### Output

```Json
{
   "log1010": 1.0,
   "log1013": -0.8860566476931632,
   "log10-20": null
}
```

<!-- document id=c0cde6e3b4e68a41a08e530a8dbb73c998fd2c366c42951a91fd5427cad66d82 url=/mulesoft/current/en-us/dataweave/2.4/dw-math-functions-log10.md -->

---
product: DataWeave
version: 2.4
---

# log10

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## log10(a: Number): Number | NaN

Returns the logarithm base 10 of a number.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>a</code></p></td><td><p>A <code>Number</code> value that serves as input to the function.</p></td></tr></tbody></table>

### Example

This example shows how `log10` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
  "log1010": log10(10),
  "log1013": log10(0.13),
  "log10-20": log10(-20)
}
```

#### Output

```Json
{
   "log1010": 1.0,
   "log1013": -0.8860566476931632,
   "log10-20": null
}
```

<!-- document id=9747fb9478455f84e84dcffc2f3c94e5310cdde897009a3fdd26c79878b04bca url=/mulesoft/current/en-us/dataweave/2.6/dw-math-functions-log10.md -->

---
product: DataWeave
version: 2.6
---

# log10

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## log10(a: Number): Number | NaN

Returns the logarithm base 10 of a number.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>a</code></p></td><td><div><div><p>A <code>Number</code> value that serves as input to the function.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `log10` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
  "log1010": log10(10),
  "log1013": log10(0.13),
  "log10-20": log10(-20)
}
```

#### Output

```Json
{
   "log1010": 1.0,
   "log1013": -0.8860566476931632,
   "log10-20": null
}
```

<!-- document id=4a38979e8872ad3ab414fa707c46513ff25ac9eef63effb6b88992c114658913 url=/mulesoft/current/en-us/dataweave/2.9/dw-math-functions-log10.md -->

---
product: DataWeave
version: 2.9
---

# log10

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## log10(a: Number): Number | NaN

Returns the logarithm base 10 of a number.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>a</code></p></td><td><div><div><p>A <code>Number</code> value that serves as input to the function.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `log10` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
  "log1010": log10(10),
  "log1013": log10(0.13),
  "log10-20": log10(-20)
}
```

#### Output

```Json
{
   "log1010": 1.0,
   "log1013": -0.8860566476931632,
   "log10-20": null
}
```

<!-- document id=b84eede45cc1d50a88ce4fe42c083dc1dfab75861c9db73dcfbb24440c492131 url=/mulesoft/current/en-us/dataweave/latest/dw-math-functions-log10.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# log10

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## log10(a: Number): Number | NaN

Returns the logarithm base 10 of a number.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>a</code></p></td><td><div><div><p>A <code>Number</code> value that serves as input to the function.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `log10` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
  "log1010": log10(10),
  "log1013": log10(0.13),
  "log10-20": log10(-20)
}
```

#### Output

```Json
{
   "log1010": 1.0,
   "log1013": -0.8860566476931632,
   "log10-20": null
}
```

<!-- document id=d466145be5309ebb29e39198c7389fe0a32e6b9d183ce96eb1b7008e2d716876 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-logdebug.md -->

---
product: DataWeave
version: 2.11
---

# logDebug

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## logDebug<T>(prefix: String = "", value: T): T

Helper function that logs messages at `Debug` level.

_Introduced in DataWeave version 2.10.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>prefix</code></p></td><td><p>An optional string that typically describes the log.</p></td></tr><tr><td><p><code>value</code></p></td><td><p>The value to log.</p></td></tr></tbody></table>

<!-- document id=db21fae1218b8bb57c6e6c26fafe3fb5a3209ef021ed467b2560fb007a8ac6fd url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-logdebug.md -->

---
product: DataWeave
version: 2.12
---

# logDebug

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## logDebug<T>(prefix: String = "", value: T): T

Helper function that logs messages at `Debug` level.

_Introduced in DataWeave version 2.10.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>prefix</code></p></td><td><p>An optional string that typically describes the log.</p></td></tr><tr><td><p><code>value</code></p></td><td><p>The value to log.</p></td></tr></tbody></table>

<!-- document id=b88b63153eb9f636aae393e6983cf94309064be4d2179f1d6e1db27eb014fa1e url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-logdebug.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# logDebug

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## logDebug<T>(prefix: String = "", value: T): T

Helper function that logs messages at `Debug` level.

_Introduced in DataWeave version 2.10.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>prefix</code></p></td><td><p>An optional string that typically describes the log.</p></td></tr><tr><td><p><code>value</code></p></td><td><p>The value to log.</p></td></tr></tbody></table>

<!-- document id=976e40a190e2cd0a40a3297fe0bddfbb1ef5b1b26b93d2e216d62b29bcb9fcfa url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-logerror.md -->

---
product: DataWeave
version: 2.11
---

# logError

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## logError<T>(prefix: String = "", value: T): T

Helper function that logs messages at `Error` level.

_Introduced in DataWeave version 2.10.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>prefix</code></p></td><td><p>An optional string that typically describes the log.</p></td></tr><tr><td><p><code>value</code></p></td><td><p>The value to log.</p></td></tr></tbody></table>

<!-- document id=e808df81b8b502bf3e24af8830c688e5fd5a57793b4fbe87c4712f5712053180 url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-logerror.md -->

---
product: DataWeave
version: 2.12
---

# logError

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## logError<T>(prefix: String = "", value: T): T

Helper function that logs messages at `Error` level.

_Introduced in DataWeave version 2.10.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>prefix</code></p></td><td><p>An optional string that typically describes the log.</p></td></tr><tr><td><p><code>value</code></p></td><td><p>The value to log.</p></td></tr></tbody></table>

<!-- document id=7809e09f96d9684da32f2dd87cb771b5c8a12072fc8e13503bc04cdfbaa36b69 url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-logerror.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# logError

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## logError<T>(prefix: String = "", value: T): T

Helper function that logs messages at `Error` level.

_Introduced in DataWeave version 2.10.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>prefix</code></p></td><td><p>An optional string that typically describes the log.</p></td></tr><tr><td><p><code>value</code></p></td><td><p>The value to log.</p></td></tr></tbody></table>

<!-- document id=cb2605ae57acbd477ca6a739f7cc59052c2b1ede4cf118e13a3639f50099d828 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-loginfo.md -->

---
product: DataWeave
version: 2.11
---

# logInfo

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## logInfo<T>(prefix: String = "", value: T): T

Helper function that logs messages at `Info` level.

_Introduced in DataWeave version 2.10.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>prefix</code></p></td><td><p>An optional string that typically describes the log.</p></td></tr><tr><td><p><code>value</code></p></td><td><p>The value to log.</p></td></tr></tbody></table>

<!-- document id=32b4058a831d9b4e670c595cd1bce6230fd44b6e17a2fba69686fb2c0a9f7d35 url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-loginfo.md -->

---
product: DataWeave
version: 2.12
---

# logInfo

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## logInfo<T>(prefix: String = "", value: T): T

Helper function that logs messages at `Info` level.

_Introduced in DataWeave version 2.10.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>prefix</code></p></td><td><p>An optional string that typically describes the log.</p></td></tr><tr><td><p><code>value</code></p></td><td><p>The value to log.</p></td></tr></tbody></table>

<!-- document id=f3593afd6fd5435646aca3d9d1f2f34d50db9dfcadebac9d56d76d55bdb3aa7b url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-loginfo.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# logInfo

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## logInfo<T>(prefix: String = "", value: T): T

Helper function that logs messages at `Info` level.

_Introduced in DataWeave version 2.10.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>prefix</code></p></td><td><p>An optional string that typically describes the log.</p></td></tr><tr><td><p><code>value</code></p></td><td><p>The value to log.</p></td></tr></tbody></table>

<!-- document id=3a5f337ef1916e95da636a2242151baf132aadb2c1fc21576deb1481aafae3e3 url=/mulesoft/current/en-us/dataweave/2.11/dw-math-functions-logn.md -->

---
product: DataWeave
version: 2.11
---

# logn

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## logn(a: Number): Number | NaN

Returns the natural logarithm (base `e`) of a number.

If the input value is less than or equal to zero, the result is `NaN` (or `null`).

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>a</code></p></td><td><div><div><p>Number to convert into its natural logarithm.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `logn` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
   "logn10":  logn(10),
   "logn13": logn(0.13),
   "logn-20": logn(-20)
}
```

#### Output

```Json
{
   "logn10": 2.302585092994046,
   "logn13": -2.0402208285265546,
   "logn-20": null
}
```

<!-- document id=b7212c8122fc469ec352cdccbff955b262ef9d48740d97e25f07118a6bb78630 url=/mulesoft/current/en-us/dataweave/2.12/dw-math-functions-logn.md -->

---
product: DataWeave
version: 2.12
---

# logn

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## logn(a: Number): Number | NaN

Returns the natural logarithm (base `e`) of a number.

If the input value is less than or equal to zero, the result is `NaN` (or `null`).

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>a</code></p></td><td><div><div><p>Number to convert into its natural logarithm.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `logn` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
   "logn10":  logn(10),
   "logn13": logn(0.13),
   "logn-20": logn(-20)
}
```

#### Output

```Json
{
   "logn10": 2.302585092994046,
   "logn13": -2.0402208285265546,
   "logn-20": null
}
```

<!-- document id=63435023977a95488b3c6000856ed144733e3491078466f783fa71507daa73f8 url=/mulesoft/current/en-us/dataweave/2.4/dw-math-functions-logn.md -->

---
product: DataWeave
version: 2.4
---

# logn

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## logn(a: Number): Number | NaN

Returns the natural logarithm (base `e`) of a number.

If the input value is less than or equal to zero, the result is `NaN` (or `null`).

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>a</code></p></td><td><div><div><p>Number to convert into its natural logarithm.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `logn` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
   "logn10":  logn(10),
   "logn13": logn(0.13),
   "logn-20": logn(-20)
}
```

#### Output

```Json
{
   "logn10": 2.302585092994046,
   "logn13": -2.0402208285265546,
   "logn-20": null
}
```

<!-- document id=dd225fb8ada20aa04a20559833d29f19c388ee4b34b613cfef9c09efe244f298 url=/mulesoft/current/en-us/dataweave/2.6/dw-math-functions-logn.md -->

---
product: DataWeave
version: 2.6
---

# logn

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## logn(a: Number): Number | NaN

Returns the natural logarithm (base `e`) of a number.

If the input value is less than or equal to zero, the result is `NaN` (or `null`).

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>a</code></p></td><td><div><div><p>Number to convert into its natural logarithm.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `logn` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
   "logn10":  logn(10),
   "logn13": logn(0.13),
   "logn-20": logn(-20)
}
```

#### Output

```Json
{
   "logn10": 2.302585092994046,
   "logn13": -2.0402208285265546,
   "logn-20": null
}
```

<!-- document id=ffe3539b92aeb555eb041a921814d4efcec0c91306139f25c4d39b14ddccd10f url=/mulesoft/current/en-us/dataweave/2.9/dw-math-functions-logn.md -->

---
product: DataWeave
version: 2.9
---

# logn

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## logn(a: Number): Number | NaN

Returns the natural logarithm (base `e`) of a number.

If the input value is less than or equal to zero, the result is `NaN` (or `null`).

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>a</code></p></td><td><div><div><p>Number to convert into its natural logarithm.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `logn` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
   "logn10":  logn(10),
   "logn13": logn(0.13),
   "logn-20": logn(-20)
}
```

#### Output

```Json
{
   "logn10": 2.302585092994046,
   "logn13": -2.0402208285265546,
   "logn-20": null
}
```

<!-- document id=4e60935efb304d6ded1f84605849debe3c9d7a8b7c5eb4f702bf0f3acb293b95 url=/mulesoft/current/en-us/dataweave/latest/dw-math-functions-logn.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# logn

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## logn(a: Number): Number | NaN

Returns the natural logarithm (base `e`) of a number.

If the input value is less than or equal to zero, the result is `NaN` (or `null`).

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>a</code></p></td><td><div><div><p>Number to convert into its natural logarithm.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `logn` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
   "logn10":  logn(10),
   "logn13": logn(0.13),
   "logn-20": logn(-20)
}
```

#### Output

```Json
{
   "logn10": 2.302585092994046,
   "logn13": -2.0402208285265546,
   "logn-20": null
}
```

<!-- document id=dc928de1074c334a4b37c195400315ec279a6fa3e2d64ca2af73fd5b856013dd url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-logwarn.md -->

---
product: DataWeave
version: 2.11
---

# logWarn

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## logWarn<T>(prefix: String = "", value: T): T

Helper function that logs messages at `Warn` level.

_Introduced in DataWeave version 2.10.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>prefix</code></p></td><td><p>An optional string that typically describes the log.</p></td></tr><tr><td><p><code>value</code></p></td><td><p>The value to log.</p></td></tr></tbody></table>

<!-- document id=b20f3918adf2ebcb19c615e31603efc055c205b071d2c39395c67cc87acbdac8 url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-logwarn.md -->

---
product: DataWeave
version: 2.12
---

# logWarn

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## logWarn<T>(prefix: String = "", value: T): T

Helper function that logs messages at `Warn` level.

_Introduced in DataWeave version 2.10.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>prefix</code></p></td><td><p>An optional string that typically describes the log.</p></td></tr><tr><td><p><code>value</code></p></td><td><p>The value to log.</p></td></tr></tbody></table>

<!-- document id=0f841aafd8b836d31ce019111a6e81a6424f0f640abf8783bcf6b55fe3941243 url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-logwarn.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# logWarn

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## logWarn<T>(prefix: String = "", value: T): T

Helper function that logs messages at `Warn` level.

_Introduced in DataWeave version 2.10.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>prefix</code></p></td><td><p>An optional string that typically describes the log.</p></td></tr><tr><td><p><code>value</code></p></td><td><p>The value to log.</p></td></tr></tbody></table>

<!-- document id=911bb3e83c8ba095b70653cd350f02b20539b946960d998f130b178bd1cfd55e url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-logwith.md -->

---
product: DataWeave
version: 2.11
---

# logWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## logWith<T>(level: LogLevel, prefix: String, value: T): T

Without changing the value of the input, `logWith` returns the input as a system log at the
specified level. This makes it simple to debug your code, because any expression or subexpression
can be wrapped with **log** and the result is printed out without modifying the result of the
expression. The output is printed in application/dw format.

The prefix parameter is optional and allows finding the log output easily.

Use the `LogLevel` to categorize log events by severity and control the verbosity of the logs.

Use this function to help with debugging DataWeave scripts. A Mule app outputs the results through
the `DefaultLoggingService`, which you can see in the Studio console.

_Introduced in DataWeave version 2.10.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>level</code></p></td><td><p>Log level that indicates the severity of the event.</p></td></tr><tr><td><p><code>prefix</code></p></td><td><p>An optional string that typically describes the log.</p></td></tr><tr><td><p><code>value</code></p></td><td><p>The value to log.</p></td></tr></tbody></table>

<!-- document id=8ae6598f7c300fa867a941771406e9642442cabeca946e925f051aefc5148f54 url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-logwith.md -->

---
product: DataWeave
version: 2.12
---

# logWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## logWith<T>(level: LogLevel, prefix: String, value: T): T

Without changing the value of the input, `logWith` returns the input as a system log at the
specified level. This makes it simple to debug your code, because any expression or subexpression
can be wrapped with **log** and the result is printed out without modifying the result of the
expression. The output is printed in application/dw format.

The prefix parameter is optional and allows finding the log output easily.

Use the `LogLevel` to categorize log events by severity and control the verbosity of the logs.

Use this function to help with debugging DataWeave scripts. A Mule app outputs the results through
the `DefaultLoggingService`, which you can see in the Studio console.

_Introduced in DataWeave version 2.10.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>level</code></p></td><td><p>Log level that indicates the severity of the event.</p></td></tr><tr><td><p><code>prefix</code></p></td><td><p>An optional string that typically describes the log.</p></td></tr><tr><td><p><code>value</code></p></td><td><p>The value to log.</p></td></tr></tbody></table>

<!-- document id=2126e6216fe8d311fa8ad0580768d447b0afe98752133273d510289ee40ebd05 url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-logwith.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# logWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## logWith<T>(level: LogLevel, prefix: String, value: T): T

Without changing the value of the input, `logWith` returns the input as a system log at the
specified level. This makes it simple to debug your code, because any expression or subexpression
can be wrapped with **log** and the result is printed out without modifying the result of the
expression. The output is printed in application/dw format.

The prefix parameter is optional and allows finding the log output easily.

Use the `LogLevel` to categorize log events by severity and control the verbosity of the logs.

Use this function to help with debugging DataWeave scripts. A Mule app outputs the results through
the `DefaultLoggingService`, which you can see in the Studio console.

_Introduced in DataWeave version 2.10.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>level</code></p></td><td><p>Log level that indicates the severity of the event.</p></td></tr><tr><td><p><code>prefix</code></p></td><td><p>An optional string that typically describes the log.</p></td></tr><tr><td><p><code>value</code></p></td><td><p>The value to log.</p></td></tr></tbody></table>

<!-- document id=207670ff6bd6d33d3413bb3854e0c65224885015c06bd736b073dceda55b1e5a url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook-csv-lookup.md -->

---
product: DataWeave
version: 2.11
---

# Look Up Data in a CSV File

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example uses `filter` with `map` to look up data in a CSV file and return a country
code for each calling code found within an input array of phone numbers.

The following JSON payload provides an array of phone numbers to the DataWeave script.

```JSON
[
   "54-112724555",
   "1-6298765432"
]
```

The value of the Mule variable `country_codes` is a CSV file that maps calling codes to country
codes.

```CSV
CALLING_CODE,COUNTRY_CODE
1,US
7,RU
54,AR
20,EG
32,BE
33,FR
505,NI
506,CR
1876,JM
1905,CA
1939,PR
262262,RE
262269,YT
.,.
.,.
```

The following DataWeave script reads each phone number in the payload and uses the `filter` function
to search for the calling code within the Mule variable `country_code` that matches the calling code
in the phone number. Then the `map` function gets the country code that corresponds to the calling
code and returns the results to an array of JSON objects.

DataWeave Script:

```dataweave
%dw 2.0
output application/json

fun lookupCountryCode(phoneNumber: String): String = do {
    var callingCode = (phoneNumber splitBy("-"))[0]
    ---
    (vars.country_code filter ((item, index) -> item.CALLING_CODE == callingCode) map ((item, index) -> item.COUNTRY_CODE))[0]
}
---
payload map ((item, index) -> { phone: item, countryCode: lookupCountryCode(item)})
```

Sample Output (JSON):

```JSON
[
  {
    "phone": "54-112724555",
    "countryCode": "AR"
  },
  {
    "phone": "1-6298765432",
    "countryCode": "US"
  }
]
```

## See Also

- [Supported Data Formats](https://docs.mulesoft.com/dataweave/2.11/dataweave-formats)

<!-- document id=ce500390b8980bd0bc8ab707cb77edbee3eb575472c77978fc3ed01d0f0f99ac url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook-csv-lookup.md -->

---
product: DataWeave
version: 2.12
---

# Look Up Data in a CSV File

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example uses `filter` with `map` to look up data in a CSV file and return a country
code for each calling code found within an input array of phone numbers.

The following JSON payload provides an array of phone numbers to the DataWeave script.

```JSON
[
   "54-112724555",
   "1-6298765432"
]
```

The value of the Mule variable `country_codes` is a CSV file that maps calling codes to country
codes.

```CSV
CALLING_CODE,COUNTRY_CODE
1,US
7,RU
54,AR
20,EG
32,BE
33,FR
505,NI
506,CR
1876,JM
1905,CA
1939,PR
262262,RE
262269,YT
.,.
.,.
```

The following DataWeave script reads each phone number in the payload and uses the `filter` function
to search for the calling code within the Mule variable `country_code` that matches the calling code
in the phone number. Then the `map` function gets the country code that corresponds to the calling
code and returns the results to an array of JSON objects.

DataWeave Script:

```dataweave
%dw 2.0
output application/json

fun lookupCountryCode(phoneNumber: String): String = do {
    var callingCode = (phoneNumber splitBy("-"))[0]
    ---
    (vars.country_code filter ((item, index) -> item.CALLING_CODE == callingCode) map ((item, index) -> item.COUNTRY_CODE))[0]
}
---
payload map ((item, index) -> { phone: item, countryCode: lookupCountryCode(item)})
```

Sample Output (JSON):

```JSON
[
  {
    "phone": "54-112724555",
    "countryCode": "AR"
  },
  {
    "phone": "1-6298765432",
    "countryCode": "US"
  }
]
```

## See Also

- [Supported Data Formats](https://docs.mulesoft.com/dataweave/2.12/dataweave-formats)

<!-- document id=83e1e02536161539a03d350a24916b818dc84535e2743ed1df5785863944ac68 url=/mulesoft/current/en-us/dataweave/2.3/dataweave-cookbook-csv-lookup.md -->

---
product: DataWeave
version: 2.3
---

# Look Up Data in a CSV File

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example uses `filter` with `map` to look up data in a CSV file and return a country
code for each calling code found within an input array of phone numbers.

The following JSON payload provides an array of phone numbers to the DataWeave script.

```JSON
[
   "54-112724555",
   "1-6298765432"
]
```

The value of the Mule variable `country_codes` is a CSV file that maps calling codes to country
codes.

```CSV
CALLING_CODE,COUNTRY_CODE
1,US
7,RU
54,AR
20,EG
32,BE
33,FR
505,NI
506,CR
1876,JM
1905,CA
1939,PR
262262,RE
262269,YT
.,.
.,.
```

The following DataWeave script reads each phone number in the payload and uses the `filter` function
to search for the calling code within the Mule variable `country_code` that matches the calling code
in the phone number. Then the `map` function gets the country code that corresponds to the calling
code and returns the results to an array of JSON objects.

DataWeave Script:

```dataweave
%dw 2.0
output application/json

fun lookupCountryCode(phoneNumber: String): String = do {
    var callingCode = (phoneNumber splitBy("-"))[0]
    ---
    (vars.country_code filter ((item, index) -> item.CALLING_CODE == callingCode) map ((item, index) -> item.COUNTRY_CODE))[0]
}
---
payload map ((item, index) -> { phone: item, countryCode: lookupCountryCode(item)})
```

Sample Output (JSON):

```JSON
[
  {
    "phone": "54-112724555",
    "countryCode": "AR"
  },
  {
    "phone": "1-6298765432",
    "countryCode": "US"
  }
]
```

## See Also

- [Supported Data Formats](https://docs.mulesoft.com/dataweave/2.3/dataweave-formats)

<!-- document id=69b62f3a2af9a7da8ebd4a1ebe9e6e479d4973005639e9b39f780ca1db0af857 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook-csv-lookup.md -->

---
product: DataWeave
version: 2.4
---

# Look Up Data in a CSV File

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example uses `filter` with `map` to look up data in a CSV file and return a country
code for each calling code found within an input array of phone numbers.

The following JSON payload provides an array of phone numbers to the DataWeave script.

```JSON
[
   "54-112724555",
   "1-6298765432"
]
```

The value of the Mule variable `country_codes` is a CSV file that maps calling codes to country
codes.

```CSV
CALLING_CODE,COUNTRY_CODE
1,US
7,RU
54,AR
20,EG
32,BE
33,FR
505,NI
506,CR
1876,JM
1905,CA
1939,PR
262262,RE
262269,YT
.,.
.,.
```

The following DataWeave script reads each phone number in the payload and uses the `filter` function
to search for the calling code within the Mule variable `country_code` that matches the calling code
in the phone number. Then the `map` function gets the country code that corresponds to the calling
code and returns the results to an array of JSON objects.

DataWeave Script:

```dataweave
%dw 2.0
output application/json

fun lookupCountryCode(phoneNumber: String): String = do {
    var callingCode = (phoneNumber splitBy("-"))[0]
    ---
    (vars.country_code filter ((item, index) -> item.CALLING_CODE == callingCode) map ((item, index) -> item.COUNTRY_CODE))[0]
}
---
payload map ((item, index) -> { phone: item, countryCode: lookupCountryCode(item)})
```

Sample Output (JSON):

```JSON
[
  {
    "phone": "54-112724555",
    "countryCode": "AR"
  },
  {
    "phone": "1-6298765432",
    "countryCode": "US"
  }
]
```

## See Also

- [Supported Data Formats](https://docs.mulesoft.com/dataweave/2.4/dataweave-formats)

<!-- document id=8e208fcf05f8950f1fa61f04f3845af532c6ca6950c000e1301689c5559a4b86 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook-csv-lookup.md -->

---
product: DataWeave
version: 2.6
---

# Look Up Data in a CSV File

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example uses `filter` with `map` to look up data in a CSV file and return a country
code for each calling code found within an input array of phone numbers.

The following JSON payload provides an array of phone numbers to the DataWeave script.

```JSON
[
   "54-112724555",
   "1-6298765432"
]
```

The value of the Mule variable `country_codes` is a CSV file that maps calling codes to country
codes.

```CSV
CALLING_CODE,COUNTRY_CODE
1,US
7,RU
54,AR
20,EG
32,BE
33,FR
505,NI
506,CR
1876,JM
1905,CA
1939,PR
262262,RE
262269,YT
.,.
.,.
```

The following DataWeave script reads each phone number in the payload and uses the `filter` function
to search for the calling code within the Mule variable `country_code` that matches the calling code
in the phone number. Then the `map` function gets the country code that corresponds to the calling
code and returns the results to an array of JSON objects.

DataWeave Script:

```dataweave
%dw 2.0
output application/json

fun lookupCountryCode(phoneNumber: String): String = do {
    var callingCode = (phoneNumber splitBy("-"))[0]
    ---
    (vars.country_code filter ((item, index) -> item.CALLING_CODE == callingCode) map ((item, index) -> item.COUNTRY_CODE))[0]
}
---
payload map ((item, index) -> { phone: item, countryCode: lookupCountryCode(item)})
```

Sample Output (JSON):

```JSON
[
  {
    "phone": "54-112724555",
    "countryCode": "AR"
  },
  {
    "phone": "1-6298765432",
    "countryCode": "US"
  }
]
```

## See Also

- [Supported Data Formats](https://docs.mulesoft.com/dataweave/2.6/dataweave-formats)

<!-- document id=b1377c06d49f1d0ecd02898a0fe84ebd79dba5f72e61240d8bc91b3f5b266e5d url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook-csv-lookup.md -->

---
product: DataWeave
version: 2.9
---

# Look Up Data in a CSV File

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example uses `filter` with `map` to look up data in a CSV file and return a country
code for each calling code found within an input array of phone numbers.

The following JSON payload provides an array of phone numbers to the DataWeave script.

```JSON
[
   "54-112724555",
   "1-6298765432"
]
```

The value of the Mule variable `country_codes` is a CSV file that maps calling codes to country
codes.

```CSV
CALLING_CODE,COUNTRY_CODE
1,US
7,RU
54,AR
20,EG
32,BE
33,FR
505,NI
506,CR
1876,JM
1905,CA
1939,PR
262262,RE
262269,YT
.,.
.,.
```

The following DataWeave script reads each phone number in the payload and uses the `filter` function
to search for the calling code within the Mule variable `country_code` that matches the calling code
in the phone number. Then the `map` function gets the country code that corresponds to the calling
code and returns the results to an array of JSON objects.

DataWeave Script:

```dataweave
%dw 2.0
output application/json

fun lookupCountryCode(phoneNumber: String): String = do {
    var callingCode = (phoneNumber splitBy("-"))[0]
    ---
    (vars.country_code filter ((item, index) -> item.CALLING_CODE == callingCode) map ((item, index) -> item.COUNTRY_CODE))[0]
}
---
payload map ((item, index) -> { phone: item, countryCode: lookupCountryCode(item)})
```

Sample Output (JSON):

```JSON
[
  {
    "phone": "54-112724555",
    "countryCode": "AR"
  },
  {
    "phone": "1-6298765432",
    "countryCode": "US"
  }
]
```

## See Also

- [Supported Data Formats](https://docs.mulesoft.com/dataweave/2.9/dataweave-formats)

<!-- document id=f6a2a9a9e7876a0403a221e6472528a2ac063bcef844c6e26d7831f55b18525f url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook-csv-lookup.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Look Up Data in a CSV File

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example uses `filter` with `map` to look up data in a CSV file and return a country
code for each calling code found within an input array of phone numbers.

The following JSON payload provides an array of phone numbers to the DataWeave script.

```JSON
[
   "54-112724555",
   "1-6298765432"
]
```

The value of the Mule variable `country_codes` is a CSV file that maps calling codes to country
codes.

```CSV
CALLING_CODE,COUNTRY_CODE
1,US
7,RU
54,AR
20,EG
32,BE
33,FR
505,NI
506,CR
1876,JM
1905,CA
1939,PR
262262,RE
262269,YT
.,.
.,.
```

The following DataWeave script reads each phone number in the payload and uses the `filter` function
to search for the calling code within the Mule variable `country_code` that matches the calling code
in the phone number. Then the `map` function gets the country code that corresponds to the calling
code and returns the results to an array of JSON objects.

DataWeave Script:

```dataweave
%dw 2.0
output application/json

fun lookupCountryCode(phoneNumber: String): String = do {
    var callingCode = (phoneNumber splitBy("-"))[0]
    ---
    (vars.country_code filter ((item, index) -> item.CALLING_CODE == callingCode) map ((item, index) -> item.COUNTRY_CODE))[0]
}
---
payload map ((item, index) -> { phone: item, countryCode: lookupCountryCode(item)})
```

Sample Output (JSON):

```JSON
[
  {
    "phone": "54-112724555",
    "countryCode": "AR"
  },
  {
    "phone": "1-6298765432",
    "countryCode": "US"
  }
]
```

## See Also

- [Supported Data Formats](https://docs.mulesoft.com/dataweave/latest/dataweave-formats)

<!-- document id=3c05b7b42a80bc785855250546625a8b500193fae8701f2e3f2875e7318763c9 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook-xlsx-lookup.md -->

---
product: DataWeave
version: 2.11
---

# Look Up Data in an Excel (XLSX) File

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example uses the `filter` function to return only the rows in an Excel (XLSX) input
file that contain a specified value.

> [!NOTE] By default, files over 1.5 MB are stored on disk. Smaller files are stored in memory.

The following DataWeave script reads an XLSX file and returns filtered data from it. It assumes that
a spreadsheet named `ourBugs.xlsx` contains data on bugs assigned to all the members of a team,
including an assignee named `Fred M`.

DataWeave Script:

```dataweave
%dw 2.0
var myInput = readUrl("classpath://ourBugs.xlsx", "application/xlsx")
output application/json
---
myInput."Data" filter ((entry, index) -> entry."Assignee" == "Fred M")
```

- The script passes `classpath:ourBugs.xlsx` to the `readUrl` function to read the file from a
  Studio project directory (`src/main/resources`). It stores the results in the variable `myInput`.

- The script selects a sheet named `Data` from the XLSX file, then filters out all records except
  the ones where the `Assignee` column contains the value `Fred M`. It returns the results in an
  array of JSON objects, for example:

\[ { "Issue Key": "BUG-11708", "Issue Type": "Bug", "Summary": "Some Description of the Bug",
"Assignee": "Fred M", "Reporter": "Natalie C", "Priority": "To be reviewed", "Status": "Closed",
"Resolution": "Done", "Created": "2019-04-29T03:57:00", "Updated": "2019-05-06T10:40:00", "Due
Date": "" }, { "Issue Key": "BUG-4903", "Issue Type": "Story", "Summary": "Some Description of the
Bug", "Assignee": "Fred M", "Reporter": "Fred M", "Priority": "To be reviewed", "Status": "In
Progress", "Resolution": "", "Created": "2019-05-07T11:22:00", "Updated": "2019-05-08T10:16:00",
"Due Date": "" }, { "Issue Key": "BUG-4840", "Issue Type": "Story", "Summary": "Some Description of
the Bug", "Assignee": "Fred M", "Reporter": "Pablo C", "Priority": "To be reviewed", "Status": "In
Validation", "Resolution": "", "Created": "2019-04-30T07:11:00", "Updated": "2019-05-08T10:16:00",
"Due Date": "" } \]

Using the same DataWeave script as in the previous example, the next example writes the results of
the `filter` expression to a file, `fredBugs.json`. The example is a configuration XML from a Mule
project in Studio.

XML Configuration in Studio:

```XML
<file:config name="File_Read_Config" doc:name="File Read Config" />
<file:config name="File_Write_Config" doc:name="File Write Config" />
<flow name="xlsx-lookup" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="1" timeUnit="MINUTES"/>
    </scheduling-strategy>
  </scheduler>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
var myInput = readUrl("classpath://ourBugs.xlsx", "application/xlsx")
output application/json
---
myInput."Data" filter ((entry, index) -> entry."Assignee" == "Fred M")]]></ee:set-payload>
    </ee:message>
  </ee:transform>
  <file:write doc:name="Write JSON"
              path="/path/to/fredBugs.json"
              config-ref="File_Write_Config">
</flow>
```

- The Scheduler (`scheduler`) triggers the flow to execute the next component, Transform Message.

- The Transform Message component (`ee:transform`) provides a DataWeave script to return all records
  from the `"Data"` sheet for which the `Assignee` column contains the value `Fred M`, and it
  transforms the binary XLSX input to JSON output.

- The Write operation (`file:write`) from the File connector receives the JSON payload from
  `ee:transform` and writes it to a file called `fredBugs.json`.

## See Also

- [filter Function](https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-filter)

- [Supported Data Formats](https://docs.mulesoft.com/dataweave/2.11/dataweave-formats)

<!-- document id=5c8dc4f175ad76e4c0f9c460ada15aad0307c5da635c4ea85460ee16911e6c18 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook-xlsx-lookup.md -->

---
product: DataWeave
version: 2.12
---

# Look Up Data in an Excel (XLSX) File

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example uses the `filter` function to return only the rows in an Excel (XLSX) input
file that contain a specified value.

> [!NOTE] By default, files over 1.5 MB are stored on disk. Smaller files are stored in memory.

The following DataWeave script reads an XLSX file and returns filtered data from it. It assumes that
a spreadsheet named `ourBugs.xlsx` contains data on bugs assigned to all the members of a team,
including an assignee named `Fred M`.

DataWeave Script:

```dataweave
%dw 2.0
var myInput = readUrl("classpath://ourBugs.xlsx", "application/xlsx")
output application/json
---
myInput."Data" filter ((entry, index) -> entry."Assignee" == "Fred M")
```

- The script passes `classpath:ourBugs.xlsx` to the `readUrl` function to read the file from a
  Studio project directory (`src/main/resources`). It stores the results in the variable `myInput`.

- The script selects a sheet named `Data` from the XLSX file, then filters out all records except
  the ones where the `Assignee` column contains the value `Fred M`. It returns the results in an
  array of JSON objects, for example:

\[ { "Issue Key": "BUG-11708", "Issue Type": "Bug", "Summary": "Some Description of the Bug",
"Assignee": "Fred M", "Reporter": "Natalie C", "Priority": "To be reviewed", "Status": "Closed",
"Resolution": "Done", "Created": "2019-04-29T03:57:00", "Updated": "2019-05-06T10:40:00", "Due
Date": "" }, { "Issue Key": "BUG-4903", "Issue Type": "Story", "Summary": "Some Description of the
Bug", "Assignee": "Fred M", "Reporter": "Fred M", "Priority": "To be reviewed", "Status": "In
Progress", "Resolution": "", "Created": "2019-05-07T11:22:00", "Updated": "2019-05-08T10:16:00",
"Due Date": "" }, { "Issue Key": "BUG-4840", "Issue Type": "Story", "Summary": "Some Description of
the Bug", "Assignee": "Fred M", "Reporter": "Pablo C", "Priority": "To be reviewed", "Status": "In
Validation", "Resolution": "", "Created": "2019-04-30T07:11:00", "Updated": "2019-05-08T10:16:00",
"Due Date": "" } \]

Using the same DataWeave script as in the previous example, the next example writes the results of
the `filter` expression to a file, `fredBugs.json`. The example is a configuration XML from a Mule
project in Studio.

XML Configuration in Studio:

```XML
<file:config name="File_Read_Config" doc:name="File Read Config" />
<file:config name="File_Write_Config" doc:name="File Write Config" />
<flow name="xlsx-lookup" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="1" timeUnit="MINUTES"/>
    </scheduling-strategy>
  </scheduler>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
var myInput = readUrl("classpath://ourBugs.xlsx", "application/xlsx")
output application/json
---
myInput."Data" filter ((entry, index) -> entry."Assignee" == "Fred M")]]></ee:set-payload>
    </ee:message>
  </ee:transform>
  <file:write doc:name="Write JSON"
              path="/path/to/fredBugs.json"
              config-ref="File_Write_Config">
</flow>
```

- The Scheduler (`scheduler`) triggers the flow to execute the next component, Transform Message.

- The Transform Message component (`ee:transform`) provides a DataWeave script to return all records
  from the `"Data"` sheet for which the `Assignee` column contains the value `Fred M`, and it
  transforms the binary XLSX input to JSON output.

- The Write operation (`file:write`) from the File connector receives the JSON payload from
  `ee:transform` and writes it to a file called `fredBugs.json`.

## See Also

- [filter Function](https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-filter)

- [Supported Data Formats](https://docs.mulesoft.com/dataweave/2.12/dataweave-formats)

<!-- document id=3b5fe4935414967262fc1869feb5ca359f00c87fb712792a392ee9d4cb670f41 url=/mulesoft/current/en-us/dataweave/2.3/dataweave-cookbook-xlsx-lookup.md -->

---
product: DataWeave
version: 2.3
---

# Look Up Data in an Excel (XLSX) File

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example uses the `filter` function to return only the rows in an Excel (XLSX) input
file that contain a specified value.

> [!NOTE] By default, files over 1.5 MB are stored on disk. Smaller files are stored in memory.

The following DataWeave script reads an XLSX file and returns filtered data from it. It assumes that
a spreadsheet named `ourBugs.xlsx` contains data on bugs assigned to all the members of a team,
including an assignee named `Fred M`.

DataWeave Script:

```dataweave
%dw 2.0
var myInput = readUrl("classpath://ourBugs.xlsx", "application/xlsx")
output application/json
---
myInput."Data" filter ((entry, index) -> entry."Assignee" == "Fred M")
```

- The script passes `classpath:ourBugs.xlsx` to the `readUrl` function to read the file from a
  Studio project directory (`src/main/resources`). It stores the results in the variable `myInput`.

- The script selects a sheet named `Data` from the XLSX file, then filters out all records except
  the ones where the `Assignee` column contains the value `Fred M`. It returns the results in an
  array of JSON objects, for example:

\[ { "Issue Key": "BUG-11708", "Issue Type": "Bug", "Summary": "Some Description of the Bug",
"Assignee": "Fred M", "Reporter": "Natalie C", "Priority": "To be reviewed", "Status": "Closed",
"Resolution": "Done", "Created": "2019-04-29T03:57:00", "Updated": "2019-05-06T10:40:00", "Due
Date": "" }, { "Issue Key": "BUG-4903", "Issue Type": "Story", "Summary": "Some Description of the
Bug", "Assignee": "Fred M", "Reporter": "Fred M", "Priority": "To be reviewed", "Status": "In
Progress", "Resolution": "", "Created": "2019-05-07T11:22:00", "Updated": "2019-05-08T10:16:00",
"Due Date": "" }, { "Issue Key": "BUG-4840", "Issue Type": "Story", "Summary": "Some Description of
the Bug", "Assignee": "Fred M", "Reporter": "Pablo C", "Priority": "To be reviewed", "Status": "In
Validation", "Resolution": "", "Created": "2019-04-30T07:11:00", "Updated": "2019-05-08T10:16:00",
"Due Date": "" } \]

Using the same DataWeave script as in the previous example, the next example writes the results of
the `filter` expression to a file, `fredBugs.json`. The example is a configuration XML from a Mule
project in Studio.

XML Configuration in Studio:

```XML
<file:config name="File_Read_Config" doc:name="File Read Config" />
<file:config name="File_Write_Config" doc:name="File Write Config" />
<flow name="xlsx-lookup" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="1" timeUnit="MINUTES"/>
    </scheduling-strategy>
  </scheduler>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
var myInput = readUrl("classpath://ourBugs.xlsx", "application/xlsx")
output application/json
---
myInput."Data" filter ((entry, index) -> entry."Assignee" == "Fred M")]]></ee:set-payload>
    </ee:message>
  </ee:transform>
  <file:write doc:name="Write JSON"
              path="/path/to/fredBugs.json"
              config-ref="File_Write_Config">
</flow>
```

- The Scheduler (`scheduler`) triggers the flow to execute the next component, Transform Message.

- The Transform Message component (`ee:transform`) provides a DataWeave script to return all records
  from the `"Data"` sheet for which the `Assignee` column contains the value `Fred M`, and it
  transforms the binary XLSX input to JSON output.

- The Write operation (`file:write`) from the File connector receives the JSON payload from
  `ee:transform` and writes it to a file called `fredBugs.json`.

## See Also

- [filter Function](https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-filter)

- [Supported Data Formats](https://docs.mulesoft.com/dataweave/2.3/dataweave-formats)

<!-- document id=1df200a4c1f5edb2951e5f0b12c4969519921defda8169e192ef55e56822bcd0 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook-xlsx-lookup.md -->

---
product: DataWeave
version: 2.4
---

# Look Up Data in an Excel (XLSX) File

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example uses the `filter` function to return only the rows in an Excel (XLSX) input
file that contain a specified value.

> [!NOTE] By default, files over 1.5 MB are stored on disk. Smaller files are stored in memory.

The following DataWeave script reads an XLSX file and returns filtered data from it. It assumes that
a spreadsheet named `ourBugs.xlsx` contains data on bugs assigned to all the members of a team,
including an assignee named `Fred M`.

DataWeave Script:

```dataweave
%dw 2.0
var myInput = readUrl("classpath://ourBugs.xlsx", "application/xlsx")
output application/json
---
myInput."Data" filter ((entry, index) -> entry."Assignee" == "Fred M")
```

- The script passes `classpath:ourBugs.xlsx` to the `readUrl` function to read the file from a
  Studio project directory (`src/main/resources`). It stores the results in the variable `myInput`.

- The script selects a sheet named `Data` from the XLSX file, then filters out all records except
  the ones where the `Assignee` column contains the value `Fred M`. It returns the results in an
  array of JSON objects, for example:

\[ { "Issue Key": "BUG-11708", "Issue Type": "Bug", "Summary": "Some Description of the Bug",
"Assignee": "Fred M", "Reporter": "Natalie C", "Priority": "To be reviewed", "Status": "Closed",
"Resolution": "Done", "Created": "2019-04-29T03:57:00", "Updated": "2019-05-06T10:40:00", "Due
Date": "" }, { "Issue Key": "BUG-4903", "Issue Type": "Story", "Summary": "Some Description of the
Bug", "Assignee": "Fred M", "Reporter": "Fred M", "Priority": "To be reviewed", "Status": "In
Progress", "Resolution": "", "Created": "2019-05-07T11:22:00", "Updated": "2019-05-08T10:16:00",
"Due Date": "" }, { "Issue Key": "BUG-4840", "Issue Type": "Story", "Summary": "Some Description of
the Bug", "Assignee": "Fred M", "Reporter": "Pablo C", "Priority": "To be reviewed", "Status": "In
Validation", "Resolution": "", "Created": "2019-04-30T07:11:00", "Updated": "2019-05-08T10:16:00",
"Due Date": "" } \]

Using the same DataWeave script as in the previous example, the next example writes the results of
the `filter` expression to a file, `fredBugs.json`. The example is a configuration XML from a Mule
project in Studio.

XML Configuration in Studio:

```XML
<file:config name="File_Read_Config" doc:name="File Read Config" />
<file:config name="File_Write_Config" doc:name="File Write Config" />
<flow name="xlsx-lookup" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="1" timeUnit="MINUTES"/>
    </scheduling-strategy>
  </scheduler>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
var myInput = readUrl("classpath://ourBugs.xlsx", "application/xlsx")
output application/json
---
myInput."Data" filter ((entry, index) -> entry."Assignee" == "Fred M")]]></ee:set-payload>
    </ee:message>
  </ee:transform>
  <file:write doc:name="Write JSON"
              path="/path/to/fredBugs.json"
              config-ref="File_Write_Config">
</flow>
```

- The Scheduler (`scheduler`) triggers the flow to execute the next component, Transform Message.

- The Transform Message component (`ee:transform`) provides a DataWeave script to return all records
  from the `"Data"` sheet for which the `Assignee` column contains the value `Fred M`, and it
  transforms the binary XLSX input to JSON output.

- The Write operation (`file:write`) from the File connector receives the JSON payload from
  `ee:transform` and writes it to a file called `fredBugs.json`.

## See Also

- [filter Function](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-filter)

- [Supported Data Formats](https://docs.mulesoft.com/dataweave/2.4/dataweave-formats)

<!-- document id=259c0503d3844aaa9878586afae797fc429c1e74231bd04153ec61aa6eacdbf6 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook-xlsx-lookup.md -->

---
product: DataWeave
version: 2.6
---

# Look Up Data in an Excel (XLSX) File

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example uses the `filter` function to return only the rows in an Excel (XLSX) input
file that contain a specified value.

> [!NOTE] By default, files over 1.5 MB are stored on disk. Smaller files are stored in memory.

The following DataWeave script reads an XLSX file and returns filtered data from it. It assumes that
a spreadsheet named `ourBugs.xlsx` contains data on bugs assigned to all the members of a team,
including an assignee named `Fred M`.

DataWeave Script:

```dataweave
%dw 2.0
var myInput = readUrl("classpath://ourBugs.xlsx", "application/xlsx")
output application/json
---
myInput."Data" filter ((entry, index) -> entry."Assignee" == "Fred M")
```

- The script passes `classpath:ourBugs.xlsx` to the `readUrl` function to read the file from a
  Studio project directory (`src/main/resources`). It stores the results in the variable `myInput`.

- The script selects a sheet named `Data` from the XLSX file, then filters out all records except
  the ones where the `Assignee` column contains the value `Fred M`. It returns the results in an
  array of JSON objects, for example:

\[ { "Issue Key": "BUG-11708", "Issue Type": "Bug", "Summary": "Some Description of the Bug",
"Assignee": "Fred M", "Reporter": "Natalie C", "Priority": "To be reviewed", "Status": "Closed",
"Resolution": "Done", "Created": "2019-04-29T03:57:00", "Updated": "2019-05-06T10:40:00", "Due
Date": "" }, { "Issue Key": "BUG-4903", "Issue Type": "Story", "Summary": "Some Description of the
Bug", "Assignee": "Fred M", "Reporter": "Fred M", "Priority": "To be reviewed", "Status": "In
Progress", "Resolution": "", "Created": "2019-05-07T11:22:00", "Updated": "2019-05-08T10:16:00",
"Due Date": "" }, { "Issue Key": "BUG-4840", "Issue Type": "Story", "Summary": "Some Description of
the Bug", "Assignee": "Fred M", "Reporter": "Pablo C", "Priority": "To be reviewed", "Status": "In
Validation", "Resolution": "", "Created": "2019-04-30T07:11:00", "Updated": "2019-05-08T10:16:00",
"Due Date": "" } \]

Using the same DataWeave script as in the previous example, the next example writes the results of
the `filter` expression to a file, `fredBugs.json`. The example is a configuration XML from a Mule
project in Studio.

XML Configuration in Studio:

```XML
<file:config name="File_Read_Config" doc:name="File Read Config" />
<file:config name="File_Write_Config" doc:name="File Write Config" />
<flow name="xlsx-lookup" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="1" timeUnit="MINUTES"/>
    </scheduling-strategy>
  </scheduler>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
var myInput = readUrl("classpath://ourBugs.xlsx", "application/xlsx")
output application/json
---
myInput."Data" filter ((entry, index) -> entry."Assignee" == "Fred M")]]></ee:set-payload>
    </ee:message>
  </ee:transform>
  <file:write doc:name="Write JSON"
              path="/path/to/fredBugs.json"
              config-ref="File_Write_Config">
</flow>
```

- The Scheduler (`scheduler`) triggers the flow to execute the next component, Transform Message.

- The Transform Message component (`ee:transform`) provides a DataWeave script to return all records
  from the `"Data"` sheet for which the `Assignee` column contains the value `Fred M`, and it
  transforms the binary XLSX input to JSON output.

- The Write operation (`file:write`) from the File connector receives the JSON payload from
  `ee:transform` and writes it to a file called `fredBugs.json`.

## See Also

- [filter Function](https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-filter)

- [Supported Data Formats](https://docs.mulesoft.com/dataweave/2.6/dataweave-formats)

<!-- document id=4523b13c6bf109d511abf16f0abf8be8409cf7e1fb1822becf06f42e5ea11dad url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook-xlsx-lookup.md -->

---
product: DataWeave
version: 2.9
---

# Look Up Data in an Excel (XLSX) File

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example uses the `filter` function to return only the rows in an Excel (XLSX) input
file that contain a specified value.

> [!NOTE] By default, files over 1.5 MB are stored on disk. Smaller files are stored in memory.

The following DataWeave script reads an XLSX file and returns filtered data from it. It assumes that
a spreadsheet named `ourBugs.xlsx` contains data on bugs assigned to all the members of a team,
including an assignee named `Fred M`.

DataWeave Script:

```dataweave
%dw 2.0
var myInput = readUrl("classpath://ourBugs.xlsx", "application/xlsx")
output application/json
---
myInput."Data" filter ((entry, index) -> entry."Assignee" == "Fred M")
```

- The script passes `classpath:ourBugs.xlsx` to the `readUrl` function to read the file from a
  Studio project directory (`src/main/resources`). It stores the results in the variable `myInput`.

- The script selects a sheet named `Data` from the XLSX file, then filters out all records except
  the ones where the `Assignee` column contains the value `Fred M`. It returns the results in an
  array of JSON objects, for example:

\[ { "Issue Key": "BUG-11708", "Issue Type": "Bug", "Summary": "Some Description of the Bug",
"Assignee": "Fred M", "Reporter": "Natalie C", "Priority": "To be reviewed", "Status": "Closed",
"Resolution": "Done", "Created": "2019-04-29T03:57:00", "Updated": "2019-05-06T10:40:00", "Due
Date": "" }, { "Issue Key": "BUG-4903", "Issue Type": "Story", "Summary": "Some Description of the
Bug", "Assignee": "Fred M", "Reporter": "Fred M", "Priority": "To be reviewed", "Status": "In
Progress", "Resolution": "", "Created": "2019-05-07T11:22:00", "Updated": "2019-05-08T10:16:00",
"Due Date": "" }, { "Issue Key": "BUG-4840", "Issue Type": "Story", "Summary": "Some Description of
the Bug", "Assignee": "Fred M", "Reporter": "Pablo C", "Priority": "To be reviewed", "Status": "In
Validation", "Resolution": "", "Created": "2019-04-30T07:11:00", "Updated": "2019-05-08T10:16:00",
"Due Date": "" } \]

Using the same DataWeave script as in the previous example, the next example writes the results of
the `filter` expression to a file, `fredBugs.json`. The example is a configuration XML from a Mule
project in Studio.

XML Configuration in Studio:

```XML
<file:config name="File_Read_Config" doc:name="File Read Config" />
<file:config name="File_Write_Config" doc:name="File Write Config" />
<flow name="xlsx-lookup" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="1" timeUnit="MINUTES"/>
    </scheduling-strategy>
  </scheduler>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
var myInput = readUrl("classpath://ourBugs.xlsx", "application/xlsx")
output application/json
---
myInput."Data" filter ((entry, index) -> entry."Assignee" == "Fred M")]]></ee:set-payload>
    </ee:message>
  </ee:transform>
  <file:write doc:name="Write JSON"
              path="/path/to/fredBugs.json"
              config-ref="File_Write_Config">
</flow>
```

- The Scheduler (`scheduler`) triggers the flow to execute the next component, Transform Message.

- The Transform Message component (`ee:transform`) provides a DataWeave script to return all records
  from the `"Data"` sheet for which the `Assignee` column contains the value `Fred M`, and it
  transforms the binary XLSX input to JSON output.

- The Write operation (`file:write`) from the File connector receives the JSON payload from
  `ee:transform` and writes it to a file called `fredBugs.json`.

## See Also

- [filter Function](https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-filter)

- [Supported Data Formats](https://docs.mulesoft.com/dataweave/2.9/dataweave-formats)

<!-- document id=4da77a4151878b528ae9cab5f6f53ab68e8a70786b3e321d99f366f7621f2ecb url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook-xlsx-lookup.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Look Up Data in an Excel (XLSX) File

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example uses the `filter` function to return only the rows in an Excel (XLSX) input
file that contain a specified value.

> [!NOTE] By default, files over 1.5 MB are stored on disk. Smaller files are stored in memory.

The following DataWeave script reads an XLSX file and returns filtered data from it. It assumes that
a spreadsheet named `ourBugs.xlsx` contains data on bugs assigned to all the members of a team,
including an assignee named `Fred M`.

DataWeave Script:

```dataweave
%dw 2.0
var myInput = readUrl("classpath://ourBugs.xlsx", "application/xlsx")
output application/json
---
myInput."Data" filter ((entry, index) -> entry."Assignee" == "Fred M")
```

- The script passes `classpath:ourBugs.xlsx` to the `readUrl` function to read the file from a
  Studio project directory (`src/main/resources`). It stores the results in the variable `myInput`.

- The script selects a sheet named `Data` from the XLSX file, then filters out all records except
  the ones where the `Assignee` column contains the value `Fred M`. It returns the results in an
  array of JSON objects, for example:

\[ { "Issue Key": "BUG-11708", "Issue Type": "Bug", "Summary": "Some Description of the Bug",
"Assignee": "Fred M", "Reporter": "Natalie C", "Priority": "To be reviewed", "Status": "Closed",
"Resolution": "Done", "Created": "2019-04-29T03:57:00", "Updated": "2019-05-06T10:40:00", "Due
Date": "" }, { "Issue Key": "BUG-4903", "Issue Type": "Story", "Summary": "Some Description of the
Bug", "Assignee": "Fred M", "Reporter": "Fred M", "Priority": "To be reviewed", "Status": "In
Progress", "Resolution": "", "Created": "2019-05-07T11:22:00", "Updated": "2019-05-08T10:16:00",
"Due Date": "" }, { "Issue Key": "BUG-4840", "Issue Type": "Story", "Summary": "Some Description of
the Bug", "Assignee": "Fred M", "Reporter": "Pablo C", "Priority": "To be reviewed", "Status": "In
Validation", "Resolution": "", "Created": "2019-04-30T07:11:00", "Updated": "2019-05-08T10:16:00",
"Due Date": "" } \]

Using the same DataWeave script as in the previous example, the next example writes the results of
the `filter` expression to a file, `fredBugs.json`. The example is a configuration XML from a Mule
project in Studio.

XML Configuration in Studio:

```XML
<file:config name="File_Read_Config" doc:name="File Read Config" />
<file:config name="File_Write_Config" doc:name="File Write Config" />
<flow name="xlsx-lookup" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="1" timeUnit="MINUTES"/>
    </scheduling-strategy>
  </scheduler>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
var myInput = readUrl("classpath://ourBugs.xlsx", "application/xlsx")
output application/json
---
myInput."Data" filter ((entry, index) -> entry."Assignee" == "Fred M")]]></ee:set-payload>
    </ee:message>
  </ee:transform>
  <file:write doc:name="Write JSON"
              path="/path/to/fredBugs.json"
              config-ref="File_Write_Config">
</flow>
```

- The Scheduler (`scheduler`) triggers the flow to execute the next component, Transform Message.

- The Transform Message component (`ee:transform`) provides a DataWeave script to return all records
  from the `"Data"` sheet for which the `Assignee` column contains the value `Fred M`, and it
  transforms the binary XLSX input to JSON output.

- The Write operation (`file:write`) from the File connector receives the JSON payload from
  `ee:transform` and writes it to a file called `fredBugs.json`.

## See Also

- [filter Function](https://docs.mulesoft.com/dataweave/latest/dw-core-functions-filter)

- [Supported Data Formats](https://docs.mulesoft.com/dataweave/latest/dataweave-formats)

<!-- document id=fdeaa43559cf0941e3f14e51cd91f29322ec7724b15ec3ddc5cf3ecca6f986df url=/mulesoft/current/en-us/dataweave/2.11/dw-mule-functions-lookup.md -->

---
product: DataWeave
version: 2.11
---

# lookup

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## lookup(flowName: String, payload: Any, timeoutMillis: Number = 2000)

This function enables you to execute a flow within a Mule app and retrieve the resulting payload.

It works in Mule apps that are running on Mule Runtime version 4.1.4 and later.

Similar to the Flow Reference component (recommended), the `lookup` function enables you to execute
another flow within your app and to retrieve the resulting payload. It takes the flow’s name and an
input payload as parameters. For example, `lookup("anotherFlow", payload)` executes a flow named
`anotherFlow`.

The function executes the specified flow using the current attributes, variables, and any error, but
it only passes in the payload without any attributes or variables. Similarly, the called flow will
only return its payload.

Note that the `lookup` function doesn’t support calling subflows.

> [!WARNING] Always keep in mind that a functional language like DataWeave expects the invocation of
> the `lookup` function to _not_ have side effects. So, the internal workings of the DataWeave
> engine might cause a `lookup` function to be invoked in parallel with other `lookup` functions, or
> not to be invoked at all.
>
> MuleSoft recommends that you invoke flows with the Flow Ref (`flow-ref`) component, using the
> `target` attribute to put the result of the flow in a `var` and then referencing that `var` from
> within the DataWeave script.

_This function is **Deprecated**. Use
[DataWeave functions](https://docs.mulesoft.com/dataweave/latest/dataweave-functions), instead._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>flowName</code></p></td><td><p>A string that identifies the target flow.</p></td></tr><tr><td><p><code>payload</code></p></td><td><p>The payload to send to the target flow, which can be any (<code>Any</code>) type.</p></td></tr><tr><td><p><code>timeoutMillis</code></p></td><td><p>Optional. Timeout (in milliseconds) for the execution of the target flow. Defaults to <code>2000</code> milliseconds (2 seconds) if the thread that is executing is CPU_LIGHT or CPU_INTENSIVE, or 1 minute when executing from other threads. If the lookup takes more time than the specified <code>timeoutMillis</code> value, an error is raised.</p></td></tr></tbody></table>

### Example

This example shows XML for two flows. The `lookup` function in `flow1` executes `flow2` and passes
the object `{test:'hello '}` as its payload to `flow2`. The Set Payload component (`<set-payload/>`)
in `flow2` then concatenates the value of `{test:'hello '}` with the string `world` to output and
log `hello world`.

#### Source

```XML
<flow name="flow1">
  <http:listener doc:name="Listener" config-ref="HTTP_Listener_config"
    path="/source"/>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
Mule::lookup('flow2', {test:'hello '})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
</flow>
<flow name="flow2" >
  <set-payload value='#[payload.test ++ "world"]' doc:name="Set Payload" />
  <logger level="INFO" doc:name="Logger" message='#[payload]'/>
</flow>
```

<!-- document id=ce51b260f4a176f9fb9be88bb4e4ab09dad683b0eb337fdce27b19f502307948 url=/mulesoft/current/en-us/dataweave/2.12/dw-mule-functions-lookup.md -->

---
product: DataWeave
version: 2.12
---

# lookup

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## lookup(flowName: String, payload: Any, timeoutMillis: Number = 2000)

This function enables you to execute a flow within a Mule app and retrieve the resulting payload.

It works in Mule apps that are running on Mule Runtime version 4.1.4 and later.

Similar to the Flow Reference component (recommended), the `lookup` function enables you to execute
another flow within your app and to retrieve the resulting payload. It takes the flow’s name and an
input payload as parameters. For example, `lookup("anotherFlow", payload)` executes a flow named
`anotherFlow`.

The function executes the specified flow using the current attributes, variables, and any error, but
it only passes in the payload without any attributes or variables. Similarly, the called flow will
only return its payload.

Note that the `lookup` function doesn’t support calling subflows.

> [!WARNING] Always keep in mind that a functional language like DataWeave expects the invocation of
> the `lookup` function to _not_ have side effects. So, the internal workings of the DataWeave
> engine might cause a `lookup` function to be invoked in parallel with other `lookup` functions, or
> not to be invoked at all.
>
> MuleSoft recommends that you invoke flows with the Flow Ref (`flow-ref`) component, using the
> `target` attribute to put the result of the flow in a `var` and then referencing that `var` from
> within the DataWeave script.

_This function is **Deprecated**. Use
[DataWeave functions](https://docs.mulesoft.com/dataweave/latest/dataweave-functions), instead._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>flowName</code></p></td><td><p>A string that identifies the target flow.</p></td></tr><tr><td><p><code>payload</code></p></td><td><p>The payload to send to the target flow, which can be any (<code>Any</code>) type.</p></td></tr><tr><td><p><code>timeoutMillis</code></p></td><td><p>Optional. Timeout (in milliseconds) for the execution of the target flow. Defaults to <code>2000</code> milliseconds (2 seconds) if the thread that is executing is CPU_LIGHT or CPU_INTENSIVE, or 1 minute when executing from other threads. If the lookup takes more time than the specified <code>timeoutMillis</code> value, an error is raised.</p></td></tr></tbody></table>

### Example

This example shows XML for two flows. The `lookup` function in `flow1` executes `flow2` and passes
the object `{test:'hello '}` as its payload to `flow2`. The Set Payload component (`<set-payload/>`)
in `flow2` then concatenates the value of `{test:'hello '}` with the string `world` to output and
log `hello world`.

#### Source

```XML
<flow name="flow1">
  <http:listener doc:name="Listener" config-ref="HTTP_Listener_config"
    path="/source"/>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
Mule::lookup('flow2', {test:'hello '})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
</flow>
<flow name="flow2" >
  <set-payload value='#[payload.test ++ "world"]' doc:name="Set Payload" />
  <logger level="INFO" doc:name="Logger" message='#[payload]'/>
</flow>
```

<!-- document id=952b8523c25d07ad479b826b9cae77df48582b5a48ef28c612e31133efe55143 url=/mulesoft/current/en-us/dataweave/2.3/dw-mule-functions-lookup.md -->

---
product: DataWeave
version: 2.3
---

# lookup

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## lookup(String, Any, Number)

This function enables you to execute a flow within a Mule app and retrieve the resulting payload.

It works in Mule apps that are running on Mule Runtime version 4.1.4 and later.

Similar to the Flow Reference component (recommended), the `lookup` function enables you to execute
another flow within your app and to retrieve the resulting payload. It takes the flow’s name and an
input payload as parameters. For example, `lookup("anotherFlow", payload)` executes a flow named
`anotherFlow`.

The function executes the specified flow using the current attributes, variables, and any error, but
it only passes in the payload without any attributes or variables. Similarly, the called flow will
only return its payload.

Note that `lookup` function does not support calling subflows.

> [!WARNING] Always keep in mind that a functional language like DataWeave expects the invocation of
> the `lookup` function to _not_ have side effects. So, the internal workings of the DataWeave
> engine might cause a `lookup` function to be invoked in parallel with other `lookup` functions, or
> not to be invoked at all.
>
> MuleSoft recommends that you invoke flows with the Flow Ref (`flow-ref`) component, using the
> `target` attribute to put the result of the flow in a `var` and then referencing that `var` from
> within the DataWeave script.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>flowName</code></p></td><td><p>A string that identifies the target flow.</p></td></tr><tr><td><p><code>payload</code></p></td><td><p>The payload to send to the target flow, which can be any (<code>Any</code>) type.</p></td></tr><tr><td><p><code>timeoutMillis</code></p></td><td><p>Optional. Timeout (in milliseconds) for the execution of the target flow. Defaults to <code>2000</code> milliseconds (2 seconds) if the thread that is executing is CPU_LIGHT or CPU_INTENSIVE, or 1 minute when executing from other threads. If the lookup takes more time than the specified <code>timeoutMillis</code> value, an error is raised.</p></td></tr></tbody></table>

### Example

This example shows XML for two flows. The `lookup` function in `flow1` executes `flow2` and passes
the object `{test:'hello '}` as its payload to `flow2`. The Set Payload component (`<set-payload/>`)
in `flow2` then concatenates the value of `{test:'hello '}` with the string `world` to output and
log `hello world`.

#### Source

```XML
<flow name="flow1">
  <http:listener doc:name="Listener" config-ref="HTTP_Listener_config"
    path="/source"/>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
Mule::lookup('flow2', {test:'hello '})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
</flow>
<flow name="flow2" >
  <set-payload value='#[payload.test ++ "world"]' doc:name="Set Payload" />
  <logger level="INFO" doc:name="Logger" message='#[payload]'/>
</flow>
```

<!-- document id=fcffcbf541cb99a88be3ffcd245abe6fc39ab98501c95d240d723abeb6f908fd url=/mulesoft/current/en-us/dataweave/2.4/dw-mule-functions-lookup.md -->

---
product: DataWeave
version: 2.4
---

# lookup

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## lookup(flowName: String, payload: Any, timeoutMillis: Number = 2000)

This function enables you to execute a flow within a Mule app and retrieve the resulting payload.

It works in Mule apps that are running on Mule Runtime version 4.1.4 and later.

Similar to the Flow Reference component (recommended), the `lookup` function enables you to execute
another flow within your app and to retrieve the resulting payload. It takes the flow’s name and an
input payload as parameters. For example, `lookup("anotherFlow", payload)` executes a flow named
`anotherFlow`.

The function executes the specified flow using the current attributes, variables, and any error, but
it only passes in the payload without any attributes or variables. Similarly, the called flow will
only return its payload.

> [!NOTE] The `lookup` function does not support calling subflows.

> [!WARNING] Always keep in mind that a functional language like DataWeave expects the invocation of
> the `lookup` function to _not_ have side effects. So, the internal workings of the DataWeave
> engine might cause a `lookup` function to be invoked in parallel with other `lookup` functions, or
> not to be invoked at all.
>
> MuleSoft recommends that you invoke flows with the Flow Ref (`flow-ref`) component, using the
> `target` attribute to put the result of the flow in a `var` and then referencing that `var` from
> within the DataWeave script.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>flowName</code></p></td><td><p>A string that identifies the target flow.</p></td></tr><tr><td><p><code>payload</code></p></td><td><p>The payload to send to the target flow, which can be any (<code>Any</code>) type.</p></td></tr><tr><td><p><code>timeoutMillis</code></p></td><td><p>Optional. Timeout (in milliseconds) for the execution of the target flow. Defaults to <code>2000</code> milliseconds (2 seconds) if the thread that is executing is CPU_LIGHT or CPU_INTENSIVE, or 1 minute when executing from other threads. If the lookup takes more time than the specified <code>timeoutMillis</code> value, an error is raised.</p></td></tr></tbody></table>

### Example

This example shows XML for two flows. The `lookup` function in `flow1` executes `flow2` and passes
the object `{test:'hello '}` as its payload to `flow2`. The Set Payload component (`<set-payload/>`)
in `flow2` then concatenates the value of `{test:'hello '}` with the string `world` to output and
log `hello world`.

#### Source

```XML
<flow name="flow1">
  <http:listener doc:name="Listener" config-ref="HTTP_Listener_config"
    path="/source"/>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
Mule::lookup('flow2', {test:'hello '})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
</flow>
<flow name="flow2" >
  <set-payload value='#[payload.test ++ "world"]' doc:name="Set Payload" />
  <logger level="INFO" doc:name="Logger" message='#[payload]'/>
</flow>
```

<!-- document id=7f981868ab735e8720a5adb42beaaf6ce438c964969faeb538a8316d388ab5f9 url=/mulesoft/current/en-us/dataweave/2.6/dw-mule-functions-lookup.md -->

---
product: DataWeave
version: 2.6
---

# lookup

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## lookup(flowName: String, payload: Any, timeoutMillis: Number = 2000)

This function enables you to execute a flow within a Mule app and retrieve the resulting payload.

It works in Mule apps that are running on Mule Runtime version 4.1.4 and later.

Similar to the Flow Reference component (recommended), the `lookup` function enables you to execute
another flow within your app and to retrieve the resulting payload. It takes the flow’s name and an
input payload as parameters. For example, `lookup("anotherFlow", payload)` executes a flow named
`anotherFlow`.

The function executes the specified flow using the current attributes, variables, and any error, but
it only passes in the payload without any attributes or variables. Similarly, the called flow will
only return its payload.

Note that the `lookup` function _doesn’t_ support calling subflows.

> [!WARNING] Always keep in mind that a functional language like DataWeave expects the invocation of
> the `lookup` function to _not_ have side effects. So, the internal workings of the DataWeave
> engine might cause a `lookup` function to be invoked in parallel with other `lookup` functions, or
> not to be invoked at all.
>
> MuleSoft recommends that you invoke flows with the Flow Ref (`flow-ref`) component, using the
> `target` attribute to put the result of the flow in a `var` and then referencing that `var` from
> within the DataWeave script.

_This function is **Deprecated**. Use
[https://docs.mulesoft.com/dataweave/latest/dataweave-functions](https://docs.mulesoft.com/dataweave/latest/dataweave-functions),
instead._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>flowName</code></p></td><td><p>A string that identifies the target flow.</p></td></tr><tr><td><p><code>payload</code></p></td><td><p>The payload to send to the target flow, which can be any (<code>Any</code>) type.</p></td></tr><tr><td><p><code>timeoutMillis</code></p></td><td><p>Optional. Timeout (in milliseconds) for the execution of the target flow. Defaults to <code>2000</code> milliseconds (2 seconds) if the thread that is executing is CPU_LIGHT or CPU_INTENSIVE, or 1 minute when executing from other threads. If the lookup takes more time than the specified <code>timeoutMillis</code> value, an error is raised.</p></td></tr></tbody></table>

### Example

This example shows XML for two flows. The `lookup` function in `flow1` executes `flow2` and passes
the object `{test:'hello '}` as its payload to `flow2`. The Set Payload component (`<set-payload/>`)
in `flow2` then concatenates the value of `{test:'hello '}` with the string `world` to output and
log `hello world`.

#### Source

```XML
<flow name="flow1">
  <http:listener doc:name="Listener" config-ref="HTTP_Listener_config"
    path="/source"/>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
Mule::lookup('flow2', {test:'hello '})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
</flow>
<flow name="flow2" >
  <set-payload value='#[payload.test ++ "world"]' doc:name="Set Payload" />
  <logger level="INFO" doc:name="Logger" message='#[payload]'/>
</flow>
```

<!-- document id=82b244a538adbf17768d8b2f58b216f0998872490641f57fe7c27b0a432efd3a url=/mulesoft/current/en-us/dataweave/2.9/dw-mule-functions-lookup.md -->

---
product: DataWeave
version: 2.9
---

# lookup

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## lookup(flowName: String, payload: Any, timeoutMillis: Number = 2000)

This function enables you to execute a flow within a Mule app and retrieve the resulting payload.

It works in Mule apps that are running on Mule Runtime version 4.1.4 and later.

Similar to the Flow Reference component (recommended), the `lookup` function enables you to execute
another flow within your app and to retrieve the resulting payload. It takes the flow’s name and an
input payload as parameters. For example, `lookup("anotherFlow", payload)` executes a flow named
`anotherFlow`.

The function executes the specified flow using the current attributes, variables, and any error, but
it only passes in the payload without any attributes or variables. Similarly, the called flow will
only return its payload.

Note that the `lookup` function doesn’t support calling subflows.

> [!WARNING] Always keep in mind that a functional language like DataWeave expects the invocation of
> the `lookup` function to _not_ have side effects. So, the internal workings of the DataWeave
> engine might cause a `lookup` function to be invoked in parallel with other `lookup` functions, or
> not to be invoked at all.
>
> MuleSoft recommends that you invoke flows with the Flow Ref (`flow-ref`) component, using the
> `target` attribute to put the result of the flow in a `var` and then referencing that `var` from
> within the DataWeave script.

_This function is **Deprecated**. Use
[DataWeave functions](https://docs.mulesoft.com/dataweave/latest/dataweave-functions), instead._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>flowName</code></p></td><td><p>A string that identifies the target flow.</p></td></tr><tr><td><p><code>payload</code></p></td><td><p>The payload to send to the target flow, which can be any (<code>Any</code>) type.</p></td></tr><tr><td><p><code>timeoutMillis</code></p></td><td><p>Optional. Timeout (in milliseconds) for the execution of the target flow. Defaults to <code>2000</code> milliseconds (2 seconds) if the thread that is executing is CPU_LIGHT or CPU_INTENSIVE, or 1 minute when executing from other threads. If the lookup takes more time than the specified <code>timeoutMillis</code> value, an error is raised.</p></td></tr></tbody></table>

### Example

This example shows XML for two flows. The `lookup` function in `flow1` executes `flow2` and passes
the object `{test:'hello '}` as its payload to `flow2`. The Set Payload component (`<set-payload/>`)
in `flow2` then concatenates the value of `{test:'hello '}` with the string `world` to output and
log `hello world`.

#### Source

```XML
<flow name="flow1">
  <http:listener doc:name="Listener" config-ref="HTTP_Listener_config"
    path="/source"/>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
Mule::lookup('flow2', {test:'hello '})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
</flow>
<flow name="flow2" >
  <set-payload value='#[payload.test ++ "world"]' doc:name="Set Payload" />
  <logger level="INFO" doc:name="Logger" message='#[payload]'/>
</flow>
```

<!-- document id=cdc4a8ad657327a05521f0d12511f59cdfcac126e97269a5328fd36012ac5757 url=/mulesoft/current/en-us/dataweave/latest/dw-mule-functions-lookup.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# lookup

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## lookup(flowName: String, payload: Any, timeoutMillis: Number = 2000)

This function enables you to execute a flow within a Mule app and retrieve the resulting payload.

It works in Mule apps that are running on Mule Runtime version 4.1.4 and later.

Similar to the Flow Reference component (recommended), the `lookup` function enables you to execute
another flow within your app and to retrieve the resulting payload. It takes the flow’s name and an
input payload as parameters. For example, `lookup("anotherFlow", payload)` executes a flow named
`anotherFlow`.

The function executes the specified flow using the current attributes, variables, and any error, but
it only passes in the payload without any attributes or variables. Similarly, the called flow will
only return its payload.

Note that the `lookup` function doesn’t support calling subflows.

> [!WARNING] Always keep in mind that a functional language like DataWeave expects the invocation of
> the `lookup` function to _not_ have side effects. So, the internal workings of the DataWeave
> engine might cause a `lookup` function to be invoked in parallel with other `lookup` functions, or
> not to be invoked at all.
>
> MuleSoft recommends that you invoke flows with the Flow Ref (`flow-ref`) component, using the
> `target` attribute to put the result of the flow in a `var` and then referencing that `var` from
> within the DataWeave script.

_This function is **Deprecated**. Use
[DataWeave functions](https://docs.mulesoft.com/dataweave/latest/dataweave-functions), instead._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>flowName</code></p></td><td><p>A string that identifies the target flow.</p></td></tr><tr><td><p><code>payload</code></p></td><td><p>The payload to send to the target flow, which can be any (<code>Any</code>) type.</p></td></tr><tr><td><p><code>timeoutMillis</code></p></td><td><p>Optional. Timeout (in milliseconds) for the execution of the target flow. Defaults to <code>2000</code> milliseconds (2 seconds) if the thread that is executing is CPU_LIGHT or CPU_INTENSIVE, or 1 minute when executing from other threads. If the lookup takes more time than the specified <code>timeoutMillis</code> value, an error is raised.</p></td></tr></tbody></table>

### Example

This example shows XML for two flows. The `lookup` function in `flow1` executes `flow2` and passes
the object `{test:'hello '}` as its payload to `flow2`. The Set Payload component (`<set-payload/>`)
in `flow2` then concatenates the value of `{test:'hello '}` with the string `world` to output and
log `hello world`.

#### Source

```XML
<flow name="flow1">
  <http:listener doc:name="Listener" config-ref="HTTP_Listener_config"
    path="/source"/>
  <ee:transform doc:name="Transform Message" >
    <ee:message >
      <ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
Mule::lookup('flow2', {test:'hello '})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
</flow>
<flow name="flow2" >
  <set-payload value='#[payload.test ++ "world"]' doc:name="Set Payload" />
  <logger level="INFO" doc:name="Logger" message='#[payload]'/>
</flow>
```

<!-- document id=290696761edf20083c5f3a6d5df72b2115ea66431b21ec7771e4df5bf96f1a43 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-lower.md -->

---
product: DataWeave
version: 2.11
---

# lower

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## lower(text: String): String

Returns the provided string in lowercase characters.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example converts uppercase characters to lower-case.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "name" : lower("MULESOFT") }
```

#### Output

```JSON
{ "name": "mulesoft" }
```

## lower(value: Null): Null

Helper function that enables `lower` to work with a `null` value.

<!-- document id=adb39e5752f3f6deff6cd2d79c8abc639dd5043f23ed58a01d8051b6c814f284 url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-lower.md -->

---
product: DataWeave
version: 2.12
---

# lower

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## lower(text: String): String

Returns the provided string in lowercase characters.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example converts uppercase characters to lower-case.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "name" : lower("MULESOFT") }
```

#### Output

```JSON
{ "name": "mulesoft" }
```

## lower(value: Null): Null

Helper function that enables `lower` to work with a `null` value.

<!-- document id=7761e026ab9ae67ac6e6bb9b2c5780499b201c7a5c47082a7e9d3de91a8bc7fd url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-lower.md -->

---
product: DataWeave
version: 2.3
---

# lower

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## lower(String): String

Returns the provided string in lowercase characters.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>A string.</p></td></tr></tbody></table>

### Example

This example converts uppercase characters to lower-case.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "name" : lower("MULESOFT") }
```

#### Output

```JSON
{ "name": "mulesoft" }
```

## lower(Null): Null

Helper function that enables `lower` to work with a `null` value.

<!-- document id=25d579255f5345fc735c05473edbe37e85e7ceaff6d3fc9d613d3cc8fe7914c9 url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-lower.md -->

---
product: DataWeave
version: 2.4
---

# lower

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## lower(text: String): String

Returns the provided string in lowercase characters.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example converts uppercase characters to lower-case.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "name" : lower("MULESOFT") }
```

#### Output

```JSON
{ "name": "mulesoft" }
```

## lower(value: Null): Null

Helper function that enables `lower` to work with a `null` value.

<!-- document id=60b2619e74b09f6c69d97cf4d2f282736b83b92eebaa6840052a19c9a2336aed url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-lower.md -->

---
product: DataWeave
version: 2.6
---

# lower

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## lower(text: String): String

Returns the provided string in lowercase characters.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example converts uppercase characters to lower-case.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "name" : lower("MULESOFT") }
```

#### Output

```JSON
{ "name": "mulesoft" }
```

## lower(value: Null): Null

Helper function that enables `lower` to work with a `null` value.

<!-- document id=48bbb96f38afdc290c2fcbc278db681a9451629e5eea2c14b48f36eca1ebabbe url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-lower.md -->

---
product: DataWeave
version: 2.9
---

# lower

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## lower(text: String): String

Returns the provided string in lowercase characters.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example converts uppercase characters to lower-case.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "name" : lower("MULESOFT") }
```

#### Output

```JSON
{ "name": "mulesoft" }
```

## lower(value: Null): Null

Helper function that enables `lower` to work with a `null` value.

<!-- document id=64ffeab07924e821346f29b32029fadd4aa8c3edba77e49e60b3aba807a9c13d url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-lower.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# lower

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## lower(text: String): String

Returns the provided string in lowercase characters.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example converts uppercase characters to lower-case.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "name" : lower("MULESOFT") }
```

#### Output

```JSON
{ "name": "mulesoft" }
```

## lower(value: Null): Null

Helper function that enables `lower` to work with a `null` value.

<!-- document id=2980f37d80312b957235e893fea2db9d2ec80d329a273035456fed6618c326eb url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-map.md -->

---
product: DataWeave
version: 2.11
---

# map

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## map<T, R>(@StreamCapable items: Array<T>, mapper: (item: T, index: Number) -> R): Array<R>

Iterates over items in an array and outputs the results into a new array.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The array to map.</p></td></tr><tr><td><p><code>mapper</code></p></td><td><p>Expression or selector used to act on each <code>item</code> and optionally, each <code>index</code> of that item.</p></td></tr></tbody></table>

### Example

This example iterates over an input array (`["jose", "pedro", "mateo"]`) to produce an array of
DataWeave objects. The anonymous function `(value, index) → {index: value}` maps each item in the
input to an object. As `{index: value}` shows, each index from the input array becomes a key for an
output object, and each value of the input array becomes the value of that object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
["jose", "pedro", "mateo"] map (value, index) -> { (index) : value}
```

#### Output

```JSON
[ { "0": "jose" }, { "1": "pedro" }, { "2": "mateo" } ]
```

### Example

This example iterates over the input array (`['a', 'b', 'c']`) using an anonymous function that acts
on the items and indices of the input. For each item in the input array, it concatenates the
`index + 1` (`index` plus 1) with an underscore (`_`), and the corresponding `value` to return the
array, `[ "1_a", "2_b", "3_c" ]`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
['a', 'b', 'c'] map ((value, index) -> (index + 1) ++ '_' ++ value)
```

#### Output

```JSON
[ "1_a", "2_b", "3_c" ]
```

### Example

If the parameters of the `mapper` function are not named, the index can be referenced with `$$`, and
the value with `$`. This example iterates over each item in the input array
`['joe', 'pete', 'matt']` and returns an array of objects where the index is selected as the key.
The value of each item in the array is selected as the value of the returned object. Note that the
quotes around `$$` are necessary to convert the numeric keys to strings.

#### Source

```DataWeave
%dw 2.0
output application/json
---
['joe', 'pete', 'matt'] map ( "$$" : $)
```

#### Output

```JSON
[
  { "0": "joe" },
  { "1": "pete" },
  { "2": "matt" }
]
```

### Example

This example iterates over a list of objects and transform the values into CSV. Each of these
objects represent a CSV row. The `map` operation generates an object with `age` and `address` for
each entry in the list. `$` represents the implicit variable under iteration.

#### Source

```DataWeave
%dw 2.0
output application/csv
---
[{
 "age": 14 ,
 "name": "Claire"
}, {
 "age": 56,
 "name": "Max"
}, {
 "age": 89,
 "name": "John"
}] map {
   age: $.age,
   name: $.name
}
```

#### Output

```CSV
age,name
14,Claire
56,Max
89,John
```

## map(@StreamCapable value: Null, mapper: (item: Nothing, index: Nothing) -> Any): Null

Helper function that enables `map` to work with a `null` value.

<!-- document id=1f01ff22bf18e4791082e0313a4fc97483aa6138e428f9d32e158bb3b763dc78 url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-map.md -->

---
product: DataWeave
version: 2.12
---

# map

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## map<T, R>(@StreamCapable items: Array<T>, mapper: (item: T, index: Number) -> R): Array<R>

Iterates over items in an array and outputs the results into a new array.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The array to map.</p></td></tr><tr><td><p><code>mapper</code></p></td><td><p>Expression or selector used to act on each <code>item</code> and optionally, each <code>index</code> of that item.</p></td></tr></tbody></table>

### Example

This example iterates over an input array (`["jose", "pedro", "mateo"]`) to produce an array of
DataWeave objects. The anonymous function `(value, index) → {index: value}` maps each item in the
input to an object. As `{index: value}` shows, each index from the input array becomes a key for an
output object, and each value of the input array becomes the value of that object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
["jose", "pedro", "mateo"] map (value, index) -> { (index) : value}
```

#### Output

```JSON
[ { "0": "jose" }, { "1": "pedro" }, { "2": "mateo" } ]
```

### Example

This example iterates over the input array (`['a', 'b', 'c']`) using an anonymous function that acts
on the items and indices of the input. For each item in the input array, it concatenates the
`index + 1` (`index` plus 1) with an underscore (`_`), and the corresponding `value` to return the
array, `[ "1_a", "2_b", "3_c" ]`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
['a', 'b', 'c'] map ((value, index) -> (index + 1) ++ '_' ++ value)
```

#### Output

```JSON
[ "1_a", "2_b", "3_c" ]
```

### Example

If the parameters of the `mapper` function are not named, the index can be referenced with `$$`, and
the value with `$`. This example iterates over each item in the input array
`['joe', 'pete', 'matt']` and returns an array of objects where the index is selected as the key.
The value of each item in the array is selected as the value of the returned object. Note that the
quotes around `$$` are necessary to convert the numeric keys to strings.

#### Source

```DataWeave
%dw 2.0
output application/json
---
['joe', 'pete', 'matt'] map ( "$$" : $)
```

#### Output

```JSON
[
  { "0": "joe" },
  { "1": "pete" },
  { "2": "matt" }
]
```

### Example

This example iterates over a list of objects and transform the values into CSV. Each of these
objects represent a CSV row. The `map` operation generates an object with `age` and `address` for
each entry in the list. `$` represents the implicit variable under iteration.

#### Source

```DataWeave
%dw 2.0
output application/csv
---
[{
 "age": 14 ,
 "name": "Claire"
}, {
 "age": 56,
 "name": "Max"
}, {
 "age": 89,
 "name": "John"
}] map {
   age: $.age,
   name: $.name
}
```

#### Output

```CSV
age,name
14,Claire
56,Max
89,John
```

## map(@StreamCapable value: Null, mapper: (item: Nothing, index: Nothing) -> Any): Null

Helper function that enables `map` to work with a `null` value.

<!-- document id=85fc26d669aaa8553dfeb26b786cc09b62fb1d2a8d87b9b04db7660443bfc139 url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-map.md -->

---
product: DataWeave
version: 2.3
---

# map

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## map(Array<T>, (item: T, index: Number) -> R): Array<R>

Iterates over items in an array and outputs the results into a new array.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The array to map.</p></td></tr><tr><td><p><code>mapper</code></p></td><td><p>Expression or selector used to act on each <code>item</code> and optionally, each <code>index</code> of that item.</p></td></tr></tbody></table>

### Example

This example iterates over an input array (`["jose", "pedro", "mateo"]`) to produce an array of
DataWeave objects. The anonymous function `(value, index) → {index: value}` maps each item in the
input to an object. As `{index: value}` shows, each index from the input array becomes a key for an
output object, and each value of the input array becomes the value of that object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
["jose", "pedro", "mateo"] map (value, index) -> { (index) : value}
```

#### Output

```JSON
[ { "0": "jose" }, { "1": "pedro" }, { "2": "mateo" } ]
```

### Example

This example iterates over the input array (`['a', 'b', 'c']`) using an anonymous function that acts
on the items and indices of the input. For each item in the input array, it concatenates the
`index + 1` (`index` plus 1) with an underscore (`_`), and the corresponding `value` to return the
array, `[ "1_a", "2_b", "3_c" ]`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
['a', 'b', 'c'] map ((value, index) -> (index + 1) ++ '_' ++ value)
```

#### Output

```JSON
[ "1_a", "2_b", "3_c" ]
```

### Example

If the parameters of the `mapper` function are not named, the index can be referenced with `$$`, and
the value with `$`. This example iterates over each item in the input array
`['joe', 'pete', 'matt']` and returns an array of objects where the index is selected as the key.
The value of each item in the array is selected as the value of the returned object. Note that the
quotes around `$$` are necessary to convert the numeric keys to strings.

#### Source

```DataWeave
%dw 2.0
output application/json
---
['joe', 'pete', 'matt'] map ( "$$" : $)
```

#### Output

```JSON
[
  { "0": "joe" },
  { "1": "pete" },
  { "2": "matt" }
]
```

### Example

This example iterates over a list of objects and transform the values into CSV. Each of these
objects represent a CSV row. The `map` operation generates an object with `age` and `address` for
each entry in the list. `$` represents the implicit variable under iteration.

#### Source

```DataWeave
%dw 2.0
output application/csv
---
[{
  "age": 14 ,
  "name": "Claire"
}, {
  "age": 56,
  "name": "Max"
}, {
  "age": 89,
  "name": "John"
}] map {
    age: $.age,
    name: $.name
}
```

#### Output

```CSV
age,name
14,Claire
56,Max
89,John
```

## map(Null, (item: Nothing, index: Nothing) -> Any): Null

Helper function that enables `map` to work with a `null` value.

<!-- document id=7ee80fe0edaa42959df1d429df6f3e9c93d62a6029a960b33bc56852a1a6f8da url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-map.md -->

---
product: DataWeave
version: 2.4
---

# map

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## map<T, R>(@StreamCapable items: Array<T>, mapper: (item: T, index: Number) -> R): Array<R>

Iterates over items in an array and outputs the results into a new array.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The array to map.</p></td></tr><tr><td><p><code>mapper</code></p></td><td><p>Expression or selector used to act on each <code>item</code> and optionally, each <code>index</code> of that item.</p></td></tr></tbody></table>

### Example

This example iterates over an input array (`["jose", "pedro", "mateo"]`) to produce an array of
DataWeave objects. The anonymous function `(value, index) → {index: value}` maps each item in the
input to an object. As `{index: value}` shows, each index from the input array becomes a key for an
output object, and each value of the input array becomes the value of that object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
["jose", "pedro", "mateo"] map (value, index) -> { (index) : value}
```

#### Output

```JSON
[ { "0": "jose" }, { "1": "pedro" }, { "2": "mateo" } ]
```

### Example

This example iterates over the input array (`['a', 'b', 'c']`) using an anonymous function that acts
on the items and indices of the input. For each item in the input array, it concatenates the
`index + 1` (`index` plus 1) with an underscore (`_`), and the corresponding `value` to return the
array, `[ "1_a", "2_b", "3_c" ]`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
['a', 'b', 'c'] map ((value, index) -> (index + 1) ++ '_' ++ value)
```

#### Output

```JSON
[ "1_a", "2_b", "3_c" ]
```

### Example

If the parameters of the `mapper` function are not named, the index can be referenced with `$$`, and
the value with `$`. This example iterates over each item in the input array
`['joe', 'pete', 'matt']` and returns an array of objects where the index is selected as the key.
The value of each item in the array is selected as the value of the returned object. Note that the
quotes around `$$` are necessary to convert the numeric keys to strings.

#### Source

```DataWeave
%dw 2.0
output application/json
---
['joe', 'pete', 'matt'] map ( "$$" : $)
```

#### Output

```JSON
[
  { "0": "joe" },
  { "1": "pete" },
  { "2": "matt" }
]
```

### Example

This example iterates over a list of objects and transform the values into CSV. Each of these
objects represent a CSV row. The `map` operation generates an object with `age` and `address` for
each entry in the list. `$` represents the implicit variable under iteration.

#### Source

```DataWeave
%dw 2.0
output application/csv
---
[{
 "age": 14 ,
 "name": "Claire"
}, {
 "age": 56,
 "name": "Max"
}, {
 "age": 89,
 "name": "John"
}] map {
   age: $.age,
   name: $.name
}
```

#### Output

```CSV
age,name
14,Claire
56,Max
89,John
```

## map(@StreamCapable value: Null, mapper: (item: Nothing, index: Nothing) -> Any): Null

Helper function that enables `map` to work with a `null` value.

<!-- document id=86081e288ef05a7ae32a9239b2a3fa21d0b4bf4ce2a1cc48fa376778b657514f url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-map.md -->

---
product: DataWeave
version: 2.6
---

# map

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## map<T, R>(@StreamCapable items: Array<T>, mapper: (item: T, index: Number) -> R): Array<R>

Iterates over items in an array and outputs the results into a new array.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The array to map.</p></td></tr><tr><td><p><code>mapper</code></p></td><td><p>Expression or selector used to act on each <code>item</code> and optionally, each <code>index</code> of that item.</p></td></tr></tbody></table>

### Example

This example iterates over an input array (`["jose", "pedro", "mateo"]`) to produce an array of
DataWeave objects. The anonymous function `(value, index) → {index: value}` maps each item in the
input to an object. As `{index: value}` shows, each index from the input array becomes a key for an
output object, and each value of the input array becomes the value of that object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
["jose", "pedro", "mateo"] map (value, index) -> { (index) : value}
```

#### Output

```JSON
[ { "0": "jose" }, { "1": "pedro" }, { "2": "mateo" } ]
```

### Example

This example iterates over the input array (`['a', 'b', 'c']`) using an anonymous function that acts
on the items and indices of the input. For each item in the input array, it concatenates the
`index + 1` (`index` plus 1) with an underscore (`_`), and the corresponding `value` to return the
array, `[ "1_a", "2_b", "3_c" ]`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
['a', 'b', 'c'] map ((value, index) -> (index + 1) ++ '_' ++ value)
```

#### Output

```JSON
[ "1_a", "2_b", "3_c" ]
```

### Example

If the parameters of the `mapper` function are not named, the index can be referenced with `$$`, and
the value with `$`. This example iterates over each item in the input array
`['joe', 'pete', 'matt']` and returns an array of objects where the index is selected as the key.
The value of each item in the array is selected as the value of the returned object. Note that the
quotes around `$$` are necessary to convert the numeric keys to strings.

#### Source

```DataWeave
%dw 2.0
output application/json
---
['joe', 'pete', 'matt'] map ( "$$" : $)
```

#### Output

```JSON
[
  { "0": "joe" },
  { "1": "pete" },
  { "2": "matt" }
]
```

### Example

This example iterates over a list of objects and transform the values into CSV. Each of these
objects represent a CSV row. The `map` operation generates an object with `age` and `address` for
each entry in the list. `$` represents the implicit variable under iteration.

#### Source

```DataWeave
%dw 2.0
output application/csv
---
[{
 "age": 14 ,
 "name": "Claire"
}, {
 "age": 56,
 "name": "Max"
}, {
 "age": 89,
 "name": "John"
}] map {
   age: $.age,
   name: $.name
}
```

#### Output

```CSV
age,name
14,Claire
56,Max
89,John
```

## map(@StreamCapable value: Null, mapper: (item: Nothing, index: Nothing) -> Any): Null

Helper function that enables `map` to work with a `null` value.

<!-- document id=73cd557e75bbf6e07b1393c975821fc36d1001859e1c7c09566473e509d55fdb url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-map.md -->

---
product: DataWeave
version: 2.9
---

# map

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## map<T, R>(@StreamCapable items: Array<T>, mapper: (item: T, index: Number) -> R): Array<R>

Iterates over items in an array and outputs the results into a new array.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The array to map.</p></td></tr><tr><td><p><code>mapper</code></p></td><td><p>Expression or selector used to act on each <code>item</code> and optionally, each <code>index</code> of that item.</p></td></tr></tbody></table>

### Example

This example iterates over an input array (`["jose", "pedro", "mateo"]`) to produce an array of
DataWeave objects. The anonymous function `(value, index) → {index: value}` maps each item in the
input to an object. As `{index: value}` shows, each index from the input array becomes a key for an
output object, and each value of the input array becomes the value of that object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
["jose", "pedro", "mateo"] map (value, index) -> { (index) : value}
```

#### Output

```JSON
[ { "0": "jose" }, { "1": "pedro" }, { "2": "mateo" } ]
```

### Example

This example iterates over the input array (`['a', 'b', 'c']`) using an anonymous function that acts
on the items and indices of the input. For each item in the input array, it concatenates the
`index + 1` (`index` plus 1) with an underscore (`_`), and the corresponding `value` to return the
array, `[ "1_a", "2_b", "3_c" ]`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
['a', 'b', 'c'] map ((value, index) -> (index + 1) ++ '_' ++ value)
```

#### Output

```JSON
[ "1_a", "2_b", "3_c" ]
```

### Example

If the parameters of the `mapper` function are not named, the index can be referenced with `$$`, and
the value with `$`. This example iterates over each item in the input array
`['joe', 'pete', 'matt']` and returns an array of objects where the index is selected as the key.
The value of each item in the array is selected as the value of the returned object. Note that the
quotes around `$$` are necessary to convert the numeric keys to strings.

#### Source

```DataWeave
%dw 2.0
output application/json
---
['joe', 'pete', 'matt'] map ( "$$" : $)
```

#### Output

```JSON
[
  { "0": "joe" },
  { "1": "pete" },
  { "2": "matt" }
]
```

### Example

This example iterates over a list of objects and transform the values into CSV. Each of these
objects represent a CSV row. The `map` operation generates an object with `age` and `address` for
each entry in the list. `$` represents the implicit variable under iteration.

#### Source

```DataWeave
%dw 2.0
output application/csv
---
[{
 "age": 14 ,
 "name": "Claire"
}, {
 "age": 56,
 "name": "Max"
}, {
 "age": 89,
 "name": "John"
}] map {
   age: $.age,
   name: $.name
}
```

#### Output

```CSV
age,name
14,Claire
56,Max
89,John
```

## map(@StreamCapable value: Null, mapper: (item: Nothing, index: Nothing) -> Any): Null

Helper function that enables `map` to work with a `null` value.

<!-- document id=953bda1c93b75592e0bd4619a810cf9487db57baf36bd064c0736081c3581791 url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-map.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# map

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## map<T, R>(@StreamCapable items: Array<T>, mapper: (item: T, index: Number) -> R): Array<R>

Iterates over items in an array and outputs the results into a new array.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The array to map.</p></td></tr><tr><td><p><code>mapper</code></p></td><td><p>Expression or selector used to act on each <code>item</code> and optionally, each <code>index</code> of that item.</p></td></tr></tbody></table>

### Example

This example iterates over an input array (`["jose", "pedro", "mateo"]`) to produce an array of
DataWeave objects. The anonymous function `(value, index) → {index: value}` maps each item in the
input to an object. As `{index: value}` shows, each index from the input array becomes a key for an
output object, and each value of the input array becomes the value of that object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
["jose", "pedro", "mateo"] map (value, index) -> { (index) : value}
```

#### Output

```JSON
[ { "0": "jose" }, { "1": "pedro" }, { "2": "mateo" } ]
```

### Example

This example iterates over the input array (`['a', 'b', 'c']`) using an anonymous function that acts
on the items and indices of the input. For each item in the input array, it concatenates the
`index + 1` (`index` plus 1) with an underscore (`_`), and the corresponding `value` to return the
array, `[ "1_a", "2_b", "3_c" ]`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
['a', 'b', 'c'] map ((value, index) -> (index + 1) ++ '_' ++ value)
```

#### Output

```JSON
[ "1_a", "2_b", "3_c" ]
```

### Example

If the parameters of the `mapper` function are not named, the index can be referenced with `$$`, and
the value with `$`. This example iterates over each item in the input array
`['joe', 'pete', 'matt']` and returns an array of objects where the index is selected as the key.
The value of each item in the array is selected as the value of the returned object. Note that the
quotes around `$$` are necessary to convert the numeric keys to strings.

#### Source

```DataWeave
%dw 2.0
output application/json
---
['joe', 'pete', 'matt'] map ( "$$" : $)
```

#### Output

```JSON
[
  { "0": "joe" },
  { "1": "pete" },
  { "2": "matt" }
]
```

### Example

This example iterates over a list of objects and transform the values into CSV. Each of these
objects represent a CSV row. The `map` operation generates an object with `age` and `address` for
each entry in the list. `$` represents the implicit variable under iteration.

#### Source

```DataWeave
%dw 2.0
output application/csv
---
[{
 "age": 14 ,
 "name": "Claire"
}, {
 "age": 56,
 "name": "Max"
}, {
 "age": 89,
 "name": "John"
}] map {
   age: $.age,
   name: $.name
}
```

#### Output

```CSV
age,name
14,Claire
56,Max
89,John
```

## map(@StreamCapable value: Null, mapper: (item: Nothing, index: Nothing) -> Any): Null

Helper function that enables `map` to work with a `null` value.

<!-- document id=4671f9066c5ccb5337a4054628ea299bde7f157aff4a69beba1246358ea13790 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook-map-and-flatten.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Map and Flatten an Array

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The `flatMap` function calls `map` on an input and wraps the results in a call to `flatten`.

The `flatMap` function is useful for refactoring uses of `flatten` on the results of a call to
`map`. For example, review the following DataWeave script:

DataWeave Script:

```dataweave
%dw 2.0
output application/json
var myData = [{name:1},{name:2},{name:3}]
fun myExternalFunction(data): Array =
    if(data.name == 1)
        []
    else if(data.name == 2)
        [{name: 3}, {name:5}]
    else
        [data]
---
//flatten(myData map ((item, index) -> myExternalFunction(item)))
myData flatMap ((item, index) -> myExternalFunction(item))
```

The header of the script creates a variable `myData` to define an array of objects, each with the
key `name`. It also defines a function with a set of if-else statements that act on name-value pairs
with the key `name`.

The body of the DataWeave script contains the following expressions, each of which produces the same
result:

- `flatten(myData map ((item, index) → myExternalFunction(item)))`

- `myData flatMap ((item, index) → myExternalFunction(item))`

Whether you use the `flatMap` expression or explicitly use `flatten` to wrap the `map` expression,
the following takes place:

1.  The expression maps the items in the input array according to if-else conditions in the function
    `myExternalFunction()`, which is defined in the header.

    The mapping produces the following output:

    ```json
    [[], [{ "name": 3 }, { "name": 5 }], [{ "name": 3 }]]
    ```

2.  The expression flattens the mapped results by consolidating the elements from the subarrays into
    a single array, removing the parent array and eliminating the empty child array.

    Flattening produces the following output:

    Output JSON:

    ```json
    [
      {
        "name": 3
      },
      {
        "name": 5
      },
      {
        "name": 3
      }
    ]
    ```

## See Also

- [flatMap](https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-flatmap)

<!-- document id=48789476222f077ac5e83dd3efab435a78435d264ef773efba823354220cdd22 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook-map-and-flatten.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Map and Flatten an Array

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The `flatMap` function calls `map` on an input and wraps the results in a call to `flatten`.

The `flatMap` function is useful for refactoring uses of `flatten` on the results of a call to
`map`. For example, review the following DataWeave script:

DataWeave Script:

```dataweave
%dw 2.0
output application/json
var myData = [{name:1},{name:2},{name:3}]
fun myExternalFunction(data): Array =
    if(data.name == 1)
        []
    else if(data.name == 2)
        [{name: 3}, {name:5}]
    else
        [data]
---
//flatten(myData map ((item, index) -> myExternalFunction(item)))
myData flatMap ((item, index) -> myExternalFunction(item))
```

The header of the script creates a variable `myData` to define an array of objects, each with the
key `name`. It also defines a function with a set of if-else statements that act on name-value pairs
with the key `name`.

The body of the DataWeave script contains the following expressions, each of which produces the same
result:

- `flatten(myData map ((item, index) → myExternalFunction(item)))`

- `myData flatMap ((item, index) → myExternalFunction(item))`

Whether you use the `flatMap` expression or explicitly use `flatten` to wrap the `map` expression,
the following takes place:

1.  The expression maps the items in the input array according to if-else conditions in the function
    `myExternalFunction()`, which is defined in the header.

    The mapping produces the following output:

    ```json
    [[], [{ "name": 3 }, { "name": 5 }], [{ "name": 3 }]]
    ```

2.  The expression flattens the mapped results by consolidating the elements from the subarrays into
    a single array, removing the parent array and eliminating the empty child array.

    Flattening produces the following output:

    Output JSON:

    ```json
    [
      {
        "name": 3
      },
      {
        "name": 5
      },
      {
        "name": 3
      }
    ]
    ```

## See Also

- [flatMap](https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-flatmap)

<!-- document id=df37397b386c16c9a0bcb40e94dded474e7350d059d0ef1bbd800871ebe562fd url=/mulesoft/current/en-us/dataweave/2.3/dataweave-cookbook-map-and-flatten.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Map and Flatten an Array

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The `flatMap` function calls `map` on an input and wraps the results in a call to `flatten`.

The `flatMap` function is useful for refactoring uses of `flatten` on the results of a call to
`map`. For example, review the following DataWeave script:

DataWeave Script:

```dataweave
%dw 2.0
output application/json
var myData = [{name:1},{name:2},{name:3}]
fun myExternalFunction(data): Array =
    if(data.name == 1)
        []
    else if(data.name == 2)
        [{name: 3}, {name:5}]
    else
        [data]
---
//flatten(myData map ((item, index) -> myExternalFunction(item)))
myData flatMap ((item, index) -> myExternalFunction(item))
```

The header of the script creates a variable `myData` to define an array of objects, each with the
key `name`. It also defines a function with a set of if-else statements that act on name-value pairs
with the key `name`.

The body of the DataWeave script contains the following expressions, each of which produces the same
result:

- `flatten(myData map ((item, index) → myExternalFunction(item)))`

- `myData flatMap ((item, index) → myExternalFunction(item))`

Whether you use the `flatMap` expression or explicitly use `flatten` to wrap the `map` expression,
the following takes place:

1.  The expression maps the items in the input array according to if-else conditions in the function
    `myExternalFunction()`, which is defined in the header.

    The mapping produces the following output:

    ```json
    [[], [{ "name": 3 }, { "name": 5 }], [{ "name": 3 }]]
    ```

2.  The expression flattens the mapped results by consolidating the elements from the subarrays into
    a single array, removing the parent array and eliminating the empty child array.

    Flattening produces the following output:

    Output JSON:

    ```json
    [
      {
        "name": 3
      },
      {
        "name": 5
      },
      {
        "name": 3
      }
    ]
    ```

## See Also

- [flatMap](https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-flatmap)

<!-- document id=9708517f9dc53eb2de0e4f9567f95d7707deba170882be2f9f855d8079503678 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook-map-and-flatten.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Map and Flatten an Array

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The `flatMap` function calls `map` on an input and wraps the results in a call to `flatten`.

The `flatMap` function is useful for refactoring uses of `flatten` on the results of a call to
`map`. For example, review the following DataWeave script:

DataWeave Script:

```dataweave
%dw 2.0
output application/json
var myData = [{name:1},{name:2},{name:3}]
fun myExternalFunction(data): Array =
    if(data.name == 1)
        []
    else if(data.name == 2)
        [{name: 3}, {name:5}]
    else
        [data]
---
//flatten(myData map ((item, index) -> myExternalFunction(item)))
myData flatMap ((item, index) -> myExternalFunction(item))
```

The header of the script creates a variable `myData` to define an array of objects, each with the
key `name`. It also defines a function with a set of if-else statements that act on name-value pairs
with the key `name`.

The body of the DataWeave script contains the following expressions, each of which produces the same
result:

- `flatten(myData map ((item, index) → myExternalFunction(item)))`

- `myData flatMap ((item, index) → myExternalFunction(item))`

Whether you use the `flatMap` expression or explicitly use `flatten` to wrap the `map` expression,
the following takes place:

1.  The expression maps the items in the input array according to if-else conditions in the function
    `myExternalFunction()`, which is defined in the header.

    The mapping produces the following output:

    ```json
    [[], [{ "name": 3 }, { "name": 5 }], [{ "name": 3 }]]
    ```

2.  The expression flattens the mapped results by consolidating the elements from the subarrays into
    a single array, removing the parent array and eliminating the empty child array.

    Flattening produces the following output:

    Output JSON:

    ```json
    [
      {
        "name": 3
      },
      {
        "name": 5
      },
      {
        "name": 3
      }
    ]
    ```

## See Also

- [flatMap](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-flatmap)

<!-- document id=f6425582f1b8f50816afd0635228c88bc455527cb867e40de64ce6361af394d0 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook-map-and-flatten.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Map and Flatten an Array

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The `flatMap` function calls `map` on an input and wraps the results in a call to `flatten`.

The `flatMap` function is useful for refactoring uses of `flatten` on the results of a call to
`map`. For example, review the following DataWeave script:

DataWeave Script:

```dataweave
%dw 2.0
output application/json
var myData = [{name:1},{name:2},{name:3}]
fun myExternalFunction(data): Array =
    if(data.name == 1)
        []
    else if(data.name == 2)
        [{name: 3}, {name:5}]
    else
        [data]
---
//flatten(myData map ((item, index) -> myExternalFunction(item)))
myData flatMap ((item, index) -> myExternalFunction(item))
```

The header of the script creates a variable `myData` to define an array of objects, each with the
key `name`. It also defines a function with a set of if-else statements that act on name-value pairs
with the key `name`.

The body of the DataWeave script contains the following expressions, each of which produces the same
result:

- `flatten(myData map ((item, index) → myExternalFunction(item)))`

- `myData flatMap ((item, index) → myExternalFunction(item))`

Whether you use the `flatMap` expression or explicitly use `flatten` to wrap the `map` expression,
the following takes place:

1.  The expression maps the items in the input array according to if-else conditions in the function
    `myExternalFunction()`, which is defined in the header.

    The mapping produces the following output:

    ```json
    [[], [{ "name": 3 }, { "name": 5 }], [{ "name": 3 }]]
    ```

2.  The expression flattens the mapped results by consolidating the elements from the subarrays into
    a single array, removing the parent array and eliminating the empty child array.

    Flattening produces the following output:

    Output JSON:

    ```json
    [
      {
        "name": 3
      },
      {
        "name": 5
      },
      {
        "name": 3
      }
    ]
    ```

## See Also

- [flatMap](https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-flatmap)

<!-- document id=95d544bb8c880d589611854f523c2f45430657e4c91776b3e9c4c2ecb64dd149 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook-map-and-flatten.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Map and Flatten an Array

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The `flatMap` function calls `map` on an input and wraps the results in a call to `flatten`.

The `flatMap` function is useful for refactoring uses of `flatten` on the results of a call to
`map`. For example, review the following DataWeave script:

DataWeave Script:

```dataweave
%dw 2.0
output application/json
var myData = [{name:1},{name:2},{name:3}]
fun myExternalFunction(data): Array =
    if(data.name == 1)
        []
    else if(data.name == 2)
        [{name: 3}, {name:5}]
    else
        [data]
---
//flatten(myData map ((item, index) -> myExternalFunction(item)))
myData flatMap ((item, index) -> myExternalFunction(item))
```

The header of the script creates a variable `myData` to define an array of objects, each with the
key `name`. It also defines a function with a set of if-else statements that act on name-value pairs
with the key `name`.

The body of the DataWeave script contains the following expressions, each of which produces the same
result:

- `flatten(myData map ((item, index) → myExternalFunction(item)))`

- `myData flatMap ((item, index) → myExternalFunction(item))`

Whether you use the `flatMap` expression or explicitly use `flatten` to wrap the `map` expression,
the following takes place:

1.  The expression maps the items in the input array according to if-else conditions in the function
    `myExternalFunction()`, which is defined in the header.

    The mapping produces the following output:

    ```json
    [[], [{ "name": 3 }, { "name": 5 }], [{ "name": 3 }]]
    ```

2.  The expression flattens the mapped results by consolidating the elements from the subarrays into
    a single array, removing the parent array and eliminating the empty child array.

    Flattening produces the following output:

    Output JSON:

    ```json
    [
      {
        "name": 3
      },
      {
        "name": 5
      },
      {
        "name": 3
      }
    ]
    ```

## See Also

- [flatMap](https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-flatmap)

<!-- document id=5de9840061a76be3988a43c0ac1053aca1886a0e566a4747d14b5790af50e4cd url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook-map-and-flatten.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Map and Flatten an Array

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The `flatMap` function calls `map` on an input and wraps the results in a call to `flatten`.

The `flatMap` function is useful for refactoring uses of `flatten` on the results of a call to
`map`. For example, review the following DataWeave script:

DataWeave Script:

```dataweave
%dw 2.0
output application/json
var myData = [{name:1},{name:2},{name:3}]
fun myExternalFunction(data): Array =
    if(data.name == 1)
        []
    else if(data.name == 2)
        [{name: 3}, {name:5}]
    else
        [data]
---
//flatten(myData map ((item, index) -> myExternalFunction(item)))
myData flatMap ((item, index) -> myExternalFunction(item))
```

The header of the script creates a variable `myData` to define an array of objects, each with the
key `name`. It also defines a function with a set of if-else statements that act on name-value pairs
with the key `name`.

The body of the DataWeave script contains the following expressions, each of which produces the same
result:

- `flatten(myData map ((item, index) → myExternalFunction(item)))`

- `myData flatMap ((item, index) → myExternalFunction(item))`

Whether you use the `flatMap` expression or explicitly use `flatten` to wrap the `map` expression,
the following takes place:

1.  The expression maps the items in the input array according to if-else conditions in the function
    `myExternalFunction()`, which is defined in the header.

    The mapping produces the following output:

    ```json
    [[], [{ "name": 3 }, { "name": 5 }], [{ "name": 3 }]]
    ```

2.  The expression flattens the mapped results by consolidating the elements from the subarrays into
    a single array, removing the parent array and eliminating the empty child array.

    Flattening produces the following output:

    Output JSON:

    ```json
    [
      {
        "name": 3
      },
      {
        "name": 5
      },
      {
        "name": 3
      }
    ]
    ```

## See Also

- [flatMap](https://docs.mulesoft.com/dataweave/latest/dw-core-functions-flatmap)

<!-- document id=e717abc05289c3d1b0117c64264fb1ceebc963ee02d0e568ef2e5b6e94e743d1 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook-map.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, as
---

# Map Data with DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example uses the DataWeave `map` function to iterate through an array of books and
perform a series of tasks on each.

The example uses these DataWeave functions:

- `map` to go through each object in the `books` array.

- `as` to coerce the price data into a Number type, which ensures that the transformation generates
  the correct type for each element.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
items: payload.books map (item, index) -> {
      book: item mapObject (value, key) -> {
      (upper(key)): value
      }
}
```

Input JSON Payload:

```json
{
  "books": [
    {
      "-category": "cooking",
      "title": "Everyday Italian",
      "author": "Giada De Laurentiis",
      "year": "2005",
      "price": "30.00"
    },
    {
      "-category": "children",
      "title": "Harry Potter",
      "author": "J K. Rowling",
      "year": "2005",
      "price": "29.99"
    },
    {
      "-category": "web",
      "title": "XQuery Kick Start",
      "author": [
        "James McGovern",
        "Per Bothner",
        "Kurt Cagle",
        "James Linn",
        "Vaidyanathan Nagarajan"
      ],
      "year": "2003",
      "price": "49.99"
    },
    {
      "-category": "web",
      "-cover": "paperback",
      "title": "Learning XML",
      "author": "Erik T. Ray",
      "year": "2003",
      "price": "39.95"
    }
  ]
}
```

Output JSON:

```json
{
  "items": [
    {
      "book": {
        "-CATEGORY": "cooking",
        "TITLE": "Everyday Italian",
        "AUTHOR": "Giada De Laurentiis",
        "YEAR": "2005",
        "PRICE": "30.00"
      }
    },
    {
      "book": {
        "-CATEGORY": "children",
        "TITLE": "Harry Potter",
        "AUTHOR": "J K. Rowling",
        "YEAR": "2005",
        "PRICE": "29.99"
      }
    },
    {
      "book": {
        "-CATEGORY": "web",
        "TITLE": "XQuery Kick Start",
        "AUTHOR": [
          "James McGovern",
          "Per Bothner",
          "Kurt Cagle",
          "James Linn",
          "Vaidyanathan Nagarajan"
        ],
        "YEAR": "2003",
        "PRICE": "49.99"
      }
    },
    {
      "book": {
        "-CATEGORY": "web",
        "-COVER": "paperback",
        "TITLE": "Learning XML",
        "AUTHOR": "Erik T. Ray",
        "YEAR": "2003",
        "PRICE": "39.95"
      }
    }
  ]
}
```

> [!TIP] Note that when a book has multiple authors, `item.author` evaluates to the entire array of
> authors instead of a single name.

## Using Default Values

The following example performs the same transformation as above, but it doesn’t explicitly define
the properties "item" and "index". Instead, it calls them through the default names: `$` and `$$`
respectively.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
items: (payload.books map {
      category: "book",
      price: $.price as Number,
      id: $$,
      properties: {
        title: $.title,
        author: $.author,
        year: $.year as Number
      }
})
```

Input JSON Payload:

```json
{
  "books": [
    {
      "-category": "cooking",
      "title": {
        "-lang": "en",
        "#text": "Everyday Italian"
      },
      "author": "Giada De Laurentiis",
      "year": "2005",
      "price": "30.00"
    },
    {
      "-category": "children",
      "title": {
        "-lang": "en",
        "#text": "Harry Potter"
      },
      "author": "J K. Rowling",
      "year": "2005",
      "price": "29.99"
    },
    {
      "-category": "web",
      "title": {
        "-lang": "en",
        "#text": "XQuery Kick Start"
      },
      "author": [
        "James McGovern",
        "Per Bothner",
        "Kurt Cagle",
        "James Linn",
        "Vaidyanathan Nagarajan"
      ],
      "year": "2003",
      "price": "49.99"
    },
    {
      "-category": "web",
      "-cover": "paperback",
      "title": {
        "-lang": "en",
        "#text": "Learning XML"
      },
      "author": "Erik T. Ray",
      "year": "2003",
      "price": "39.95"
    }
  ]
}
```

Output JSON:

```json
{
  "items": [
    {
      "category": "book",
      "price": 30.0,
      "id": 0,
      "properties": {
        "title": {
          "-lang": "en",
          "#text": "Everyday Italian"
        },
        "author": "Giada De Laurentiis",
        "year": 2005
      }
    },
    {
      "category": "book",
      "price": 29.99,
      "id": 1,
      "properties": {
        "title": {
          "-lang": "en",
          "#text": "Harry Potter"
        },
        "author": "J K. Rowling",
        "year": 2005
      }
    },
    {
      "category": "book",
      "price": 49.99,
      "id": 2,
      "properties": {
        "title": {
          "-lang": "en",
          "#text": "XQuery Kick Start"
        },
        "author": [
          "James McGovern",
          "Per Bothner",
          "Kurt Cagle",
          "James Linn",
          "Vaidyanathan Nagarajan"
        ],
        "year": 2003
      }
    },
    {
      "category": "book",
      "price": 39.95,
      "id": 3,
      "properties": {
        "title": {
          "-lang": "en",
          "#text": "Learning XML"
        },
        "author": "Erik T. Ray",
        "year": 2003
      }
    }
  ]
}
```

## Related Examples

- [Extract Data](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-extract-data)

- [Transform XML to JSON](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-perform-basic-transformation)

- [Rename Keys](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-rename-keys)

- [Map Object Elements as an Array](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-map-object-elements-as-an-array)

- [Map an Object](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-map-an-object)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.11/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.11/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook)

<!-- document id=2d49a4021cf0e32d7b86d445950f6a5d8a6b6be87be96c9724a4c4cbc3a453c6 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook-map.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, as
---

# Map Data with DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example uses the DataWeave `map` function to iterate through an array of books and
perform a series of tasks on each.

The example uses these DataWeave functions:

- `map` to go through each object in the `books` array.

- `as` to coerce the price data into a Number type, which ensures that the transformation generates
  the correct type for each element.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
items: payload.books map (item, index) -> {
      book: item mapObject (value, key) -> {
      (upper(key)): value
      }
}
```

Input JSON Payload:

```json
{
  "books": [
    {
      "-category": "cooking",
      "title": "Everyday Italian",
      "author": "Giada De Laurentiis",
      "year": "2005",
      "price": "30.00"
    },
    {
      "-category": "children",
      "title": "Harry Potter",
      "author": "J K. Rowling",
      "year": "2005",
      "price": "29.99"
    },
    {
      "-category": "web",
      "title": "XQuery Kick Start",
      "author": [
        "James McGovern",
        "Per Bothner",
        "Kurt Cagle",
        "James Linn",
        "Vaidyanathan Nagarajan"
      ],
      "year": "2003",
      "price": "49.99"
    },
    {
      "-category": "web",
      "-cover": "paperback",
      "title": "Learning XML",
      "author": "Erik T. Ray",
      "year": "2003",
      "price": "39.95"
    }
  ]
}
```

Output JSON:

```json
{
  "items": [
    {
      "book": {
        "-CATEGORY": "cooking",
        "TITLE": "Everyday Italian",
        "AUTHOR": "Giada De Laurentiis",
        "YEAR": "2005",
        "PRICE": "30.00"
      }
    },
    {
      "book": {
        "-CATEGORY": "children",
        "TITLE": "Harry Potter",
        "AUTHOR": "J K. Rowling",
        "YEAR": "2005",
        "PRICE": "29.99"
      }
    },
    {
      "book": {
        "-CATEGORY": "web",
        "TITLE": "XQuery Kick Start",
        "AUTHOR": [
          "James McGovern",
          "Per Bothner",
          "Kurt Cagle",
          "James Linn",
          "Vaidyanathan Nagarajan"
        ],
        "YEAR": "2003",
        "PRICE": "49.99"
      }
    },
    {
      "book": {
        "-CATEGORY": "web",
        "-COVER": "paperback",
        "TITLE": "Learning XML",
        "AUTHOR": "Erik T. Ray",
        "YEAR": "2003",
        "PRICE": "39.95"
      }
    }
  ]
}
```

> [!TIP] Note that when a book has multiple authors, `item.author` evaluates to the entire array of
> authors instead of a single name.

## Using Default Values

The following example performs the same transformation as above, but it doesn’t explicitly define
the properties "item" and "index". Instead, it calls them through the default names: `$` and `$$`
respectively.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
items: (payload.books map {
      category: "book",
      price: $.price as Number,
      id: $$,
      properties: {
        title: $.title,
        author: $.author,
        year: $.year as Number
      }
})
```

Input JSON Payload:

```json
{
  "books": [
    {
      "-category": "cooking",
      "title": {
        "-lang": "en",
        "#text": "Everyday Italian"
      },
      "author": "Giada De Laurentiis",
      "year": "2005",
      "price": "30.00"
    },
    {
      "-category": "children",
      "title": {
        "-lang": "en",
        "#text": "Harry Potter"
      },
      "author": "J K. Rowling",
      "year": "2005",
      "price": "29.99"
    },
    {
      "-category": "web",
      "title": {
        "-lang": "en",
        "#text": "XQuery Kick Start"
      },
      "author": [
        "James McGovern",
        "Per Bothner",
        "Kurt Cagle",
        "James Linn",
        "Vaidyanathan Nagarajan"
      ],
      "year": "2003",
      "price": "49.99"
    },
    {
      "-category": "web",
      "-cover": "paperback",
      "title": {
        "-lang": "en",
        "#text": "Learning XML"
      },
      "author": "Erik T. Ray",
      "year": "2003",
      "price": "39.95"
    }
  ]
}
```

Output JSON:

```json
{
  "items": [
    {
      "category": "book",
      "price": 30.0,
      "id": 0,
      "properties": {
        "title": {
          "-lang": "en",
          "#text": "Everyday Italian"
        },
        "author": "Giada De Laurentiis",
        "year": 2005
      }
    },
    {
      "category": "book",
      "price": 29.99,
      "id": 1,
      "properties": {
        "title": {
          "-lang": "en",
          "#text": "Harry Potter"
        },
        "author": "J K. Rowling",
        "year": 2005
      }
    },
    {
      "category": "book",
      "price": 49.99,
      "id": 2,
      "properties": {
        "title": {
          "-lang": "en",
          "#text": "XQuery Kick Start"
        },
        "author": [
          "James McGovern",
          "Per Bothner",
          "Kurt Cagle",
          "James Linn",
          "Vaidyanathan Nagarajan"
        ],
        "year": 2003
      }
    },
    {
      "category": "book",
      "price": 39.95,
      "id": 3,
      "properties": {
        "title": {
          "-lang": "en",
          "#text": "Learning XML"
        },
        "author": "Erik T. Ray",
        "year": 2003
      }
    }
  ]
}
```

## Related Examples

- [Extract Data](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-extract-data)

- [Transform XML to JSON](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-perform-basic-transformation)

- [Rename Keys](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-rename-keys)

- [Map Object Elements as an Array](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-map-object-elements-as-an-array)

- [Map an Object](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-map-an-object)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.12/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.12/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook)

<!-- document id=ed752c2030628b623a4da2f4f1f40e1a74df48d47122bc78042bd8408bcb3513 url=/mulesoft/current/en-us/dataweave/2.3/dataweave-cookbook-map.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, as
---

# Map Data with DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example uses the DataWeave `map` function to iterate through an array of books and
perform a series of tasks on each.

The example uses these DataWeave functions:

- `map` to go through each object in the `books` array.

- `as` to coerce the price data into a Number type, which ensures that the transformation generates
  the correct type for each element.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
items: payload.books map (item, index) -> {
      book: item mapObject (value, key) -> {
      (upper(key)): value
      }
}
```

Input JSON Payload:

```json
{
  "books": [
    {
      "-category": "cooking",
      "title": "Everyday Italian",
      "author": "Giada De Laurentiis",
      "year": "2005",
      "price": "30.00"
    },
    {
      "-category": "children",
      "title": "Harry Potter",
      "author": "J K. Rowling",
      "year": "2005",
      "price": "29.99"
    },
    {
      "-category": "web",
      "title": "XQuery Kick Start",
      "author": [
        "James McGovern",
        "Per Bothner",
        "Kurt Cagle",
        "James Linn",
        "Vaidyanathan Nagarajan"
      ],
      "year": "2003",
      "price": "49.99"
    },
    {
      "-category": "web",
      "-cover": "paperback",
      "title": "Learning XML",
      "author": "Erik T. Ray",
      "year": "2003",
      "price": "39.95"
    }
  ]
}
```

Output JSON:

```json
{
  "items": [
    {
      "book": {
        "-CATEGORY": "cooking",
        "TITLE": "Everyday Italian",
        "AUTHOR": "Giada De Laurentiis",
        "YEAR": "2005",
        "PRICE": "30.00"
      }
    },
    {
      "book": {
        "-CATEGORY": "children",
        "TITLE": "Harry Potter",
        "AUTHOR": "J K. Rowling",
        "YEAR": "2005",
        "PRICE": "29.99"
      }
    },
    {
      "book": {
        "-CATEGORY": "web",
        "TITLE": "XQuery Kick Start",
        "AUTHOR": [
          "James McGovern",
          "Per Bothner",
          "Kurt Cagle",
          "James Linn",
          "Vaidyanathan Nagarajan"
        ],
        "YEAR": "2003",
        "PRICE": "49.99"
      }
    },
    {
      "book": {
        "-CATEGORY": "web",
        "-COVER": "paperback",
        "TITLE": "Learning XML",
        "AUTHOR": "Erik T. Ray",
        "YEAR": "2003",
        "PRICE": "39.95"
      }
    }
  ]
}
```

> [!TIP] Note that when a book has multiple authors, `item.author` evaluates to the entire array of
> authors instead of a single name.

## Using Default Values

The following example performs the same transformation as above, but it doesn’t explicitly define
the properties "item" and "index". Instead, it calls them through the default names: `$` and `$$`
respectively.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
items: (payload.books map {
      category: "book",
      price: $.price as Number,
      id: $$,
      properties: {
        title: $.title,
        author: $.author,
        year: $.year as Number
      }
})
```

Input JSON Payload:

```json
{
  "books": [
    {
      "-category": "cooking",
      "title": {
        "-lang": "en",
        "#text": "Everyday Italian"
      },
      "author": "Giada De Laurentiis",
      "year": "2005",
      "price": "30.00"
    },
    {
      "-category": "children",
      "title": {
        "-lang": "en",
        "#text": "Harry Potter"
      },
      "author": "J K. Rowling",
      "year": "2005",
      "price": "29.99"
    },
    {
      "-category": "web",
      "title": {
        "-lang": "en",
        "#text": "XQuery Kick Start"
      },
      "author": [
        "James McGovern",
        "Per Bothner",
        "Kurt Cagle",
        "James Linn",
        "Vaidyanathan Nagarajan"
      ],
      "year": "2003",
      "price": "49.99"
    },
    {
      "-category": "web",
      "-cover": "paperback",
      "title": {
        "-lang": "en",
        "#text": "Learning XML"
      },
      "author": "Erik T. Ray",
      "year": "2003",
      "price": "39.95"
    }
  ]
}
```

Output JSON:

```json
{
  "items": [
    {
      "category": "book",
      "price": 30.0,
      "id": 0,
      "properties": {
        "title": {
          "-lang": "en",
          "#text": "Everyday Italian"
        },
        "author": "Giada De Laurentiis",
        "year": 2005
      }
    },
    {
      "category": "book",
      "price": 29.99,
      "id": 1,
      "properties": {
        "title": {
          "-lang": "en",
          "#text": "Harry Potter"
        },
        "author": "J K. Rowling",
        "year": 2005
      }
    },
    {
      "category": "book",
      "price": 49.99,
      "id": 2,
      "properties": {
        "title": {
          "-lang": "en",
          "#text": "XQuery Kick Start"
        },
        "author": [
          "James McGovern",
          "Per Bothner",
          "Kurt Cagle",
          "James Linn",
          "Vaidyanathan Nagarajan"
        ],
        "year": 2003
      }
    },
    {
      "category": "book",
      "price": 39.95,
      "id": 3,
      "properties": {
        "title": {
          "-lang": "en",
          "#text": "Learning XML"
        },
        "author": "Erik T. Ray",
        "year": 2003
      }
    }
  ]
}
```

## Related Examples

- [Extract Data](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-extract-data)

- [Transform XML to JSON](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-perform-basic-transformation)

- [Rename Keys](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-rename-keys)

- [Map Object Elements as an Array](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-map-object-elements-as-an-array)

- [Map an Object](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-map-an-object)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.3/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.3/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook)

<!-- document id=1b850e7b337dc79fe2e90daff170e988c0fd824fd166eeab70f5e5cf7c71ea05 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook-map.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, as
---

# Map Data with DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example uses the DataWeave `map` function to iterate through an array of books and
perform a series of tasks on each.

The example uses these DataWeave functions:

- `map` to go through each object in the `books` array.

- `as` to coerce the price data into a Number type, which ensures that the transformation generates
  the correct type for each element.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
items: payload.books map (item, index) -> {
      book: item mapObject (value, key) -> {
      (upper(key)): value
      }
}
```

Input JSON Payload:

```json
{
  "books": [
    {
      "-category": "cooking",
      "title": "Everyday Italian",
      "author": "Giada De Laurentiis",
      "year": "2005",
      "price": "30.00"
    },
    {
      "-category": "children",
      "title": "Harry Potter",
      "author": "J K. Rowling",
      "year": "2005",
      "price": "29.99"
    },
    {
      "-category": "web",
      "title": "XQuery Kick Start",
      "author": [
        "James McGovern",
        "Per Bothner",
        "Kurt Cagle",
        "James Linn",
        "Vaidyanathan Nagarajan"
      ],
      "year": "2003",
      "price": "49.99"
    },
    {
      "-category": "web",
      "-cover": "paperback",
      "title": "Learning XML",
      "author": "Erik T. Ray",
      "year": "2003",
      "price": "39.95"
    }
  ]
}
```

Output JSON:

```json
{
  "items": [
    {
      "book": {
        "-CATEGORY": "cooking",
        "TITLE": "Everyday Italian",
        "AUTHOR": "Giada De Laurentiis",
        "YEAR": "2005",
        "PRICE": "30.00"
      }
    },
    {
      "book": {
        "-CATEGORY": "children",
        "TITLE": "Harry Potter",
        "AUTHOR": "J K. Rowling",
        "YEAR": "2005",
        "PRICE": "29.99"
      }
    },
    {
      "book": {
        "-CATEGORY": "web",
        "TITLE": "XQuery Kick Start",
        "AUTHOR": [
          "James McGovern",
          "Per Bothner",
          "Kurt Cagle",
          "James Linn",
          "Vaidyanathan Nagarajan"
        ],
        "YEAR": "2003",
        "PRICE": "49.99"
      }
    },
    {
      "book": {
        "-CATEGORY": "web",
        "-COVER": "paperback",
        "TITLE": "Learning XML",
        "AUTHOR": "Erik T. Ray",
        "YEAR": "2003",
        "PRICE": "39.95"
      }
    }
  ]
}
```

> [!TIP] Note that when a book has multiple authors, `item.author` evaluates to the entire array of
> authors instead of a single name.

## Using Default Values

The following example performs the same transformation as above, but it doesn’t explicitly define
the properties "item" and "index". Instead, it calls them through the default names: `$` and `$$`
respectively.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
items: (payload.books map {
      category: "book",
      price: $.price as Number,
      id: $$,
      properties: {
        title: $.title,
        author: $.author,
        year: $.year as Number
      }
})
```

Input JSON Payload:

```json
{
  "books": [
    {
      "-category": "cooking",
      "title": {
        "-lang": "en",
        "#text": "Everyday Italian"
      },
      "author": "Giada De Laurentiis",
      "year": "2005",
      "price": "30.00"
    },
    {
      "-category": "children",
      "title": {
        "-lang": "en",
        "#text": "Harry Potter"
      },
      "author": "J K. Rowling",
      "year": "2005",
      "price": "29.99"
    },
    {
      "-category": "web",
      "title": {
        "-lang": "en",
        "#text": "XQuery Kick Start"
      },
      "author": [
        "James McGovern",
        "Per Bothner",
        "Kurt Cagle",
        "James Linn",
        "Vaidyanathan Nagarajan"
      ],
      "year": "2003",
      "price": "49.99"
    },
    {
      "-category": "web",
      "-cover": "paperback",
      "title": {
        "-lang": "en",
        "#text": "Learning XML"
      },
      "author": "Erik T. Ray",
      "year": "2003",
      "price": "39.95"
    }
  ]
}
```

Output JSON:

```json
{
  "items": [
    {
      "category": "book",
      "price": 30.0,
      "id": 0,
      "properties": {
        "title": {
          "-lang": "en",
          "#text": "Everyday Italian"
        },
        "author": "Giada De Laurentiis",
        "year": 2005
      }
    },
    {
      "category": "book",
      "price": 29.99,
      "id": 1,
      "properties": {
        "title": {
          "-lang": "en",
          "#text": "Harry Potter"
        },
        "author": "J K. Rowling",
        "year": 2005
      }
    },
    {
      "category": "book",
      "price": 49.99,
      "id": 2,
      "properties": {
        "title": {
          "-lang": "en",
          "#text": "XQuery Kick Start"
        },
        "author": [
          "James McGovern",
          "Per Bothner",
          "Kurt Cagle",
          "James Linn",
          "Vaidyanathan Nagarajan"
        ],
        "year": 2003
      }
    },
    {
      "category": "book",
      "price": 39.95,
      "id": 3,
      "properties": {
        "title": {
          "-lang": "en",
          "#text": "Learning XML"
        },
        "author": "Erik T. Ray",
        "year": 2003
      }
    }
  ]
}
```

## Related Examples

- [Extract Data](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-extract-data)

- [Transform XML to JSON](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-perform-basic-transformation)

- [Rename Keys](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-rename-keys)

- [Map Object Elements as an Array](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-map-object-elements-as-an-array)

- [Map an Object](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-map-an-object)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.4/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.4/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook)

<!-- document id=d63962ca18ad57a6bfe2ffad859a96d348e77d589bc7fef9a094c9567f436825 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook-map.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, as
---

# Map Data with DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example uses the DataWeave `map` function to iterate through an array of books and
perform a series of tasks on each.

The example uses these DataWeave functions:

- `map` to go through each object in the `books` array.

- `as` to coerce the price data into a Number type, which ensures that the transformation generates
  the correct type for each element.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
items: payload.books map (item, index) -> {
      book: item mapObject (value, key) -> {
      (upper(key)): value
      }
}
```

Input JSON Payload:

```json
{
  "books": [
    {
      "-category": "cooking",
      "title": "Everyday Italian",
      "author": "Giada De Laurentiis",
      "year": "2005",
      "price": "30.00"
    },
    {
      "-category": "children",
      "title": "Harry Potter",
      "author": "J K. Rowling",
      "year": "2005",
      "price": "29.99"
    },
    {
      "-category": "web",
      "title": "XQuery Kick Start",
      "author": [
        "James McGovern",
        "Per Bothner",
        "Kurt Cagle",
        "James Linn",
        "Vaidyanathan Nagarajan"
      ],
      "year": "2003",
      "price": "49.99"
    },
    {
      "-category": "web",
      "-cover": "paperback",
      "title": "Learning XML",
      "author": "Erik T. Ray",
      "year": "2003",
      "price": "39.95"
    }
  ]
}
```

Output JSON:

```json
{
  "items": [
    {
      "book": {
        "-CATEGORY": "cooking",
        "TITLE": "Everyday Italian",
        "AUTHOR": "Giada De Laurentiis",
        "YEAR": "2005",
        "PRICE": "30.00"
      }
    },
    {
      "book": {
        "-CATEGORY": "children",
        "TITLE": "Harry Potter",
        "AUTHOR": "J K. Rowling",
        "YEAR": "2005",
        "PRICE": "29.99"
      }
    },
    {
      "book": {
        "-CATEGORY": "web",
        "TITLE": "XQuery Kick Start",
        "AUTHOR": [
          "James McGovern",
          "Per Bothner",
          "Kurt Cagle",
          "James Linn",
          "Vaidyanathan Nagarajan"
        ],
        "YEAR": "2003",
        "PRICE": "49.99"
      }
    },
    {
      "book": {
        "-CATEGORY": "web",
        "-COVER": "paperback",
        "TITLE": "Learning XML",
        "AUTHOR": "Erik T. Ray",
        "YEAR": "2003",
        "PRICE": "39.95"
      }
    }
  ]
}
```

> [!TIP] Note that when a book has multiple authors, `item.author` evaluates to the entire array of
> authors instead of a single name.

## Using Default Values

The following example performs the same transformation as above, but it doesn’t explicitly define
the properties "item" and "index". Instead, it calls them through the default names: `$` and `$$`
respectively.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
items: (payload.books map {
      category: "book",
      price: $.price as Number,
      id: $$,
      properties: {
        title: $.title,
        author: $.author,
        year: $.year as Number
      }
})
```

Input JSON Payload:

```json
{
  "books": [
    {
      "-category": "cooking",
      "title": {
        "-lang": "en",
        "#text": "Everyday Italian"
      },
      "author": "Giada De Laurentiis",
      "year": "2005",
      "price": "30.00"
    },
    {
      "-category": "children",
      "title": {
        "-lang": "en",
        "#text": "Harry Potter"
      },
      "author": "J K. Rowling",
      "year": "2005",
      "price": "29.99"
    },
    {
      "-category": "web",
      "title": {
        "-lang": "en",
        "#text": "XQuery Kick Start"
      },
      "author": [
        "James McGovern",
        "Per Bothner",
        "Kurt Cagle",
        "James Linn",
        "Vaidyanathan Nagarajan"
      ],
      "year": "2003",
      "price": "49.99"
    },
    {
      "-category": "web",
      "-cover": "paperback",
      "title": {
        "-lang": "en",
        "#text": "Learning XML"
      },
      "author": "Erik T. Ray",
      "year": "2003",
      "price": "39.95"
    }
  ]
}
```

Output JSON:

```json
{
  "items": [
    {
      "category": "book",
      "price": 30.0,
      "id": 0,
      "properties": {
        "title": {
          "-lang": "en",
          "#text": "Everyday Italian"
        },
        "author": "Giada De Laurentiis",
        "year": 2005
      }
    },
    {
      "category": "book",
      "price": 29.99,
      "id": 1,
      "properties": {
        "title": {
          "-lang": "en",
          "#text": "Harry Potter"
        },
        "author": "J K. Rowling",
        "year": 2005
      }
    },
    {
      "category": "book",
      "price": 49.99,
      "id": 2,
      "properties": {
        "title": {
          "-lang": "en",
          "#text": "XQuery Kick Start"
        },
        "author": [
          "James McGovern",
          "Per Bothner",
          "Kurt Cagle",
          "James Linn",
          "Vaidyanathan Nagarajan"
        ],
        "year": 2003
      }
    },
    {
      "category": "book",
      "price": 39.95,
      "id": 3,
      "properties": {
        "title": {
          "-lang": "en",
          "#text": "Learning XML"
        },
        "author": "Erik T. Ray",
        "year": 2003
      }
    }
  ]
}
```

## Related Examples

- [Extract Data](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-extract-data)

- [Transform XML to JSON](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-perform-basic-transformation)

- [Rename Keys](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-rename-keys)

- [Map Object Elements as an Array](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-map-object-elements-as-an-array)

- [Map an Object](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-map-an-object)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.6/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.6/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook)

<!-- document id=6aa228c3e3ca0c47d8cedfa74fd012ea08ab5c3d67db0ceb1d56cfe4f3ebd955 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook-map.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, as
---

# Map Data with DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example uses the DataWeave `map` function to iterate through an array of books and
perform a series of tasks on each.

The example uses these DataWeave functions:

- `map` to go through each object in the `books` array.

- `as` to coerce the price data into a Number type, which ensures that the transformation generates
  the correct type for each element.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
items: payload.books map (item, index) -> {
      book: item mapObject (value, key) -> {
      (upper(key)): value
      }
}
```

Input JSON Payload:

```json
{
  "books": [
    {
      "-category": "cooking",
      "title": "Everyday Italian",
      "author": "Giada De Laurentiis",
      "year": "2005",
      "price": "30.00"
    },
    {
      "-category": "children",
      "title": "Harry Potter",
      "author": "J K. Rowling",
      "year": "2005",
      "price": "29.99"
    },
    {
      "-category": "web",
      "title": "XQuery Kick Start",
      "author": [
        "James McGovern",
        "Per Bothner",
        "Kurt Cagle",
        "James Linn",
        "Vaidyanathan Nagarajan"
      ],
      "year": "2003",
      "price": "49.99"
    },
    {
      "-category": "web",
      "-cover": "paperback",
      "title": "Learning XML",
      "author": "Erik T. Ray",
      "year": "2003",
      "price": "39.95"
    }
  ]
}
```

Output JSON:

```json
{
  "items": [
    {
      "book": {
        "-CATEGORY": "cooking",
        "TITLE": "Everyday Italian",
        "AUTHOR": "Giada De Laurentiis",
        "YEAR": "2005",
        "PRICE": "30.00"
      }
    },
    {
      "book": {
        "-CATEGORY": "children",
        "TITLE": "Harry Potter",
        "AUTHOR": "J K. Rowling",
        "YEAR": "2005",
        "PRICE": "29.99"
      }
    },
    {
      "book": {
        "-CATEGORY": "web",
        "TITLE": "XQuery Kick Start",
        "AUTHOR": [
          "James McGovern",
          "Per Bothner",
          "Kurt Cagle",
          "James Linn",
          "Vaidyanathan Nagarajan"
        ],
        "YEAR": "2003",
        "PRICE": "49.99"
      }
    },
    {
      "book": {
        "-CATEGORY": "web",
        "-COVER": "paperback",
        "TITLE": "Learning XML",
        "AUTHOR": "Erik T. Ray",
        "YEAR": "2003",
        "PRICE": "39.95"
      }
    }
  ]
}
```

> [!TIP] Note that when a book has multiple authors, `item.author` evaluates to the entire array of
> authors instead of a single name.

## Using Default Values

The following example performs the same transformation as above, but it doesn’t explicitly define
the properties "item" and "index". Instead, it calls them through the default names: `$` and `$$`
respectively.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
items: (payload.books map {
      category: "book",
      price: $.price as Number,
      id: $$,
      properties: {
        title: $.title,
        author: $.author,
        year: $.year as Number
      }
})
```

Input JSON Payload:

```json
{
  "books": [
    {
      "-category": "cooking",
      "title": {
        "-lang": "en",
        "#text": "Everyday Italian"
      },
      "author": "Giada De Laurentiis",
      "year": "2005",
      "price": "30.00"
    },
    {
      "-category": "children",
      "title": {
        "-lang": "en",
        "#text": "Harry Potter"
      },
      "author": "J K. Rowling",
      "year": "2005",
      "price": "29.99"
    },
    {
      "-category": "web",
      "title": {
        "-lang": "en",
        "#text": "XQuery Kick Start"
      },
      "author": [
        "James McGovern",
        "Per Bothner",
        "Kurt Cagle",
        "James Linn",
        "Vaidyanathan Nagarajan"
      ],
      "year": "2003",
      "price": "49.99"
    },
    {
      "-category": "web",
      "-cover": "paperback",
      "title": {
        "-lang": "en",
        "#text": "Learning XML"
      },
      "author": "Erik T. Ray",
      "year": "2003",
      "price": "39.95"
    }
  ]
}
```

Output JSON:

```json
{
  "items": [
    {
      "category": "book",
      "price": 30.0,
      "id": 0,
      "properties": {
        "title": {
          "-lang": "en",
          "#text": "Everyday Italian"
        },
        "author": "Giada De Laurentiis",
        "year": 2005
      }
    },
    {
      "category": "book",
      "price": 29.99,
      "id": 1,
      "properties": {
        "title": {
          "-lang": "en",
          "#text": "Harry Potter"
        },
        "author": "J K. Rowling",
        "year": 2005
      }
    },
    {
      "category": "book",
      "price": 49.99,
      "id": 2,
      "properties": {
        "title": {
          "-lang": "en",
          "#text": "XQuery Kick Start"
        },
        "author": [
          "James McGovern",
          "Per Bothner",
          "Kurt Cagle",
          "James Linn",
          "Vaidyanathan Nagarajan"
        ],
        "year": 2003
      }
    },
    {
      "category": "book",
      "price": 39.95,
      "id": 3,
      "properties": {
        "title": {
          "-lang": "en",
          "#text": "Learning XML"
        },
        "author": "Erik T. Ray",
        "year": 2003
      }
    }
  ]
}
```

## Related Examples

- [Extract Data](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-extract-data)

- [Transform XML to JSON](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-perform-basic-transformation)

- [Rename Keys](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-rename-keys)

- [Map Object Elements as an Array](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-map-object-elements-as-an-array)

- [Map an Object](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-map-an-object)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.9/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.9/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook)

<!-- document id=4e92280a5a387410d0db9a0b1d1f416aa8d71947cc81adb525e2ea025b6a136a url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook-map.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, as
---

# Map Data with DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example uses the DataWeave `map` function to iterate through an array of books and
perform a series of tasks on each.

The example uses these DataWeave functions:

- `map` to go through each object in the `books` array.

- `as` to coerce the price data into a Number type, which ensures that the transformation generates
  the correct type for each element.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
items: payload.books map (item, index) -> {
      book: item mapObject (value, key) -> {
      (upper(key)): value
      }
}
```

Input JSON Payload:

```json
{
  "books": [
    {
      "-category": "cooking",
      "title": "Everyday Italian",
      "author": "Giada De Laurentiis",
      "year": "2005",
      "price": "30.00"
    },
    {
      "-category": "children",
      "title": "Harry Potter",
      "author": "J K. Rowling",
      "year": "2005",
      "price": "29.99"
    },
    {
      "-category": "web",
      "title": "XQuery Kick Start",
      "author": [
        "James McGovern",
        "Per Bothner",
        "Kurt Cagle",
        "James Linn",
        "Vaidyanathan Nagarajan"
      ],
      "year": "2003",
      "price": "49.99"
    },
    {
      "-category": "web",
      "-cover": "paperback",
      "title": "Learning XML",
      "author": "Erik T. Ray",
      "year": "2003",
      "price": "39.95"
    }
  ]
}
```

Output JSON:

```json
{
  "items": [
    {
      "book": {
        "-CATEGORY": "cooking",
        "TITLE": "Everyday Italian",
        "AUTHOR": "Giada De Laurentiis",
        "YEAR": "2005",
        "PRICE": "30.00"
      }
    },
    {
      "book": {
        "-CATEGORY": "children",
        "TITLE": "Harry Potter",
        "AUTHOR": "J K. Rowling",
        "YEAR": "2005",
        "PRICE": "29.99"
      }
    },
    {
      "book": {
        "-CATEGORY": "web",
        "TITLE": "XQuery Kick Start",
        "AUTHOR": [
          "James McGovern",
          "Per Bothner",
          "Kurt Cagle",
          "James Linn",
          "Vaidyanathan Nagarajan"
        ],
        "YEAR": "2003",
        "PRICE": "49.99"
      }
    },
    {
      "book": {
        "-CATEGORY": "web",
        "-COVER": "paperback",
        "TITLE": "Learning XML",
        "AUTHOR": "Erik T. Ray",
        "YEAR": "2003",
        "PRICE": "39.95"
      }
    }
  ]
}
```

> [!TIP] Note that when a book has multiple authors, `item.author` evaluates to the entire array of
> authors instead of a single name.

## Using Default Values

The following example performs the same transformation as above, but it doesn’t explicitly define
the properties "item" and "index". Instead, it calls them through the default names: `$` and `$$`
respectively.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
items: (payload.books map {
      category: "book",
      price: $.price as Number,
      id: $$,
      properties: {
        title: $.title,
        author: $.author,
        year: $.year as Number
      }
})
```

Input JSON Payload:

```json
{
  "books": [
    {
      "-category": "cooking",
      "title": {
        "-lang": "en",
        "#text": "Everyday Italian"
      },
      "author": "Giada De Laurentiis",
      "year": "2005",
      "price": "30.00"
    },
    {
      "-category": "children",
      "title": {
        "-lang": "en",
        "#text": "Harry Potter"
      },
      "author": "J K. Rowling",
      "year": "2005",
      "price": "29.99"
    },
    {
      "-category": "web",
      "title": {
        "-lang": "en",
        "#text": "XQuery Kick Start"
      },
      "author": [
        "James McGovern",
        "Per Bothner",
        "Kurt Cagle",
        "James Linn",
        "Vaidyanathan Nagarajan"
      ],
      "year": "2003",
      "price": "49.99"
    },
    {
      "-category": "web",
      "-cover": "paperback",
      "title": {
        "-lang": "en",
        "#text": "Learning XML"
      },
      "author": "Erik T. Ray",
      "year": "2003",
      "price": "39.95"
    }
  ]
}
```

Output JSON:

```json
{
  "items": [
    {
      "category": "book",
      "price": 30.0,
      "id": 0,
      "properties": {
        "title": {
          "-lang": "en",
          "#text": "Everyday Italian"
        },
        "author": "Giada De Laurentiis",
        "year": 2005
      }
    },
    {
      "category": "book",
      "price": 29.99,
      "id": 1,
      "properties": {
        "title": {
          "-lang": "en",
          "#text": "Harry Potter"
        },
        "author": "J K. Rowling",
        "year": 2005
      }
    },
    {
      "category": "book",
      "price": 49.99,
      "id": 2,
      "properties": {
        "title": {
          "-lang": "en",
          "#text": "XQuery Kick Start"
        },
        "author": [
          "James McGovern",
          "Per Bothner",
          "Kurt Cagle",
          "James Linn",
          "Vaidyanathan Nagarajan"
        ],
        "year": 2003
      }
    },
    {
      "category": "book",
      "price": 39.95,
      "id": 3,
      "properties": {
        "title": {
          "-lang": "en",
          "#text": "Learning XML"
        },
        "author": "Erik T. Ray",
        "year": 2003
      }
    }
  ]
}
```

## Related Examples

- [Extract Data](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-extract-data)

- [Transform XML to JSON](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-perform-basic-transformation)

- [Rename Keys](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-rename-keys)

- [Map Object Elements as an Array](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-map-object-elements-as-an-array)

- [Map an Object](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-map-an-object)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/latest/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook)

<!-- document id=3845a43ff8f87b185f3829d74857ce81eaf26929844e7c405dfd02f98ea9d3a7 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook-map-object-elements-as-an-array.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, as
---

# Map Object Elements as an Array

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example uses the DataWeave `map` function to iterate through the object elements that
match the key `book`. The input also includes the key `magazine`, which is ignored.

The example uses these DataWeave functions:

- The multi-value selector `*book` to return an array with the elements that match the key `"book"`.

- `map` to go through each object in the array that’s returned by the multi-value selector.

DataWeave Script:

```dataweave
%dw 2.0
var myInputExample = {
  "inventory": {
      "book" : {
        "category": "cooking",
        "title": "Everyday Italian",
        "author": "Giada De Laurentiis",
        "year": "2005",
        "price": "30.00"
      },
      "book" :{
        "category": "children",
        "title": "Harry Potter",
        "author": "J K. Rowling",
        "year": "2005",
        "price": "29.99"
      },
      "book" :{
        "category": "web",
        "title": "Learning XML",
        "author": "Erik T. Ray",
        "year": "2003",
        "price": "39.95"
      },
      "magazine" :{
        "category": "web",
        "title": "Wired Magazine",
        "edition": "03-2017",
        "price": "15.95"
      },
        "magazine" :{
        "category": "business",
        "title": "Time Magazine",
        "edition": "04-2017",
        "price": "17.95"
      }
   }
}
output application/json
---
items: myInputExample.inventory.*book map (item, index) -> {
      "theType": "book",
      "theID": index,
      "theCategory": item.category,
      "theTitle": item.title,
      "theAuthor": item.author,
      "theYear": item.year,
      "thePrice": item.price as Number
}
```

Output JSON:

```json
{
  "items": [
    {
      "theType": "book",
      "theID": 0,
      "theCategory": "cooking",
      "theTitle": "Everyday Italian",
      "theAuthor": "Giada De Laurentiis",
      "theYear": "2005",
      "thePrice": 30.0
    },
    {
      "theType": "book",
      "theID": 1,
      "theCategory": "children",
      "theTitle": "Harry Potter",
      "theAuthor": "J K. Rowling",
      "theYear": "2005",
      "thePrice": 29.99
    },
    {
      "theType": "book",
      "theID": 2,
      "theCategory": "web",
      "theTitle": "Learning XML",
      "theAuthor": "Erik T. Ray",
      "theYear": "2003",
      "thePrice": 39.95
    }
  ]
}
```

## Related Examples

- [Map Data with DataWeave](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-map)

- [Map an Object](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-map-an-object)

- [Exclude Field](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-exclude-field)

- [Rename Keys](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-rename-keys)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.11/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.11/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook)

<!-- document id=7a15e1deb440cac7bbd02bfdd77f5daad794efe36a360a171d3158965d22712d url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook-map-object-elements-as-an-array.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, as
---

# Map Object Elements as an Array

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example uses the DataWeave `map` function to iterate through the object elements that
match the key `book`. The input also includes the key `magazine`, which is ignored.

The example uses these DataWeave functions:

- The multi-value selector `*book` to return an array with the elements that match the key `"book"`.

- `map` to go through each object in the array that’s returned by the multi-value selector.

DataWeave Script:

```dataweave
%dw 2.0
var myInputExample = {
  "inventory": {
      "book" : {
        "category": "cooking",
        "title": "Everyday Italian",
        "author": "Giada De Laurentiis",
        "year": "2005",
        "price": "30.00"
      },
      "book" :{
        "category": "children",
        "title": "Harry Potter",
        "author": "J K. Rowling",
        "year": "2005",
        "price": "29.99"
      },
      "book" :{
        "category": "web",
        "title": "Learning XML",
        "author": "Erik T. Ray",
        "year": "2003",
        "price": "39.95"
      },
      "magazine" :{
        "category": "web",
        "title": "Wired Magazine",
        "edition": "03-2017",
        "price": "15.95"
      },
        "magazine" :{
        "category": "business",
        "title": "Time Magazine",
        "edition": "04-2017",
        "price": "17.95"
      }
   }
}
output application/json
---
items: myInputExample.inventory.*book map (item, index) -> {
      "theType": "book",
      "theID": index,
      "theCategory": item.category,
      "theTitle": item.title,
      "theAuthor": item.author,
      "theYear": item.year,
      "thePrice": item.price as Number
}
```

Output JSON:

```json
{
  "items": [
    {
      "theType": "book",
      "theID": 0,
      "theCategory": "cooking",
      "theTitle": "Everyday Italian",
      "theAuthor": "Giada De Laurentiis",
      "theYear": "2005",
      "thePrice": 30.0
    },
    {
      "theType": "book",
      "theID": 1,
      "theCategory": "children",
      "theTitle": "Harry Potter",
      "theAuthor": "J K. Rowling",
      "theYear": "2005",
      "thePrice": 29.99
    },
    {
      "theType": "book",
      "theID": 2,
      "theCategory": "web",
      "theTitle": "Learning XML",
      "theAuthor": "Erik T. Ray",
      "theYear": "2003",
      "thePrice": 39.95
    }
  ]
}
```

## Related Examples

- [Map Data with DataWeave](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-map)

- [Map an Object](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-map-an-object)

- [Exclude Field](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-exclude-field)

- [Rename Keys](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-rename-keys)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.12/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.12/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook)

<!-- document id=a3220a373b799e969b505c2d708462d4faf4775b450b8fbed8587650c7849469 url=/mulesoft/current/en-us/dataweave/2.3/dataweave-cookbook-map-object-elements-as-an-array.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, as
---

# Map Object Elements as an Array

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example uses the DataWeave `map` function to iterate through the object elements that
match the key `book`. The input also includes the key `magazine`, which is ignored.

The example uses these DataWeave functions:

- The multi-value selector `*book` to return an array with the elements that match the key `"book"`.

- `map` to go through each object in the array that’s returned by the multi-value selector.

DataWeave Script:

```dataweave
%dw 2.0
var myInputExample = {
  "inventory": {
      "book" : {
        "category": "cooking",
        "title": "Everyday Italian",
        "author": "Giada De Laurentiis",
        "year": "2005",
        "price": "30.00"
      },
      "book" :{
        "category": "children",
        "title": "Harry Potter",
        "author": "J K. Rowling",
        "year": "2005",
        "price": "29.99"
      },
      "book" :{
        "category": "web",
        "title": "Learning XML",
        "author": "Erik T. Ray",
        "year": "2003",
        "price": "39.95"
      },
      "magazine" :{
        "category": "web",
        "title": "Wired Magazine",
        "edition": "03-2017",
        "price": "15.95"
      },
        "magazine" :{
        "category": "business",
        "title": "Time Magazine",
        "edition": "04-2017",
        "price": "17.95"
      }
   }
}
output application/json
---
items: myInputExample.inventory.*book map (item, index) -> {
      "theType": "book",
      "theID": index,
      "theCategory": item.category,
      "theTitle": item.title,
      "theAuthor": item.author,
      "theYear": item.year,
      "thePrice": item.price as Number
}
```

Output JSON:

```json
{
  "items": [
    {
      "theType": "book",
      "theID": 0,
      "theCategory": "cooking",
      "theTitle": "Everyday Italian",
      "theAuthor": "Giada De Laurentiis",
      "theYear": "2005",
      "thePrice": 30.0
    },
    {
      "theType": "book",
      "theID": 1,
      "theCategory": "children",
      "theTitle": "Harry Potter",
      "theAuthor": "J K. Rowling",
      "theYear": "2005",
      "thePrice": 29.99
    },
    {
      "theType": "book",
      "theID": 2,
      "theCategory": "web",
      "theTitle": "Learning XML",
      "theAuthor": "Erik T. Ray",
      "theYear": "2003",
      "thePrice": 39.95
    }
  ]
}
```

## Related Examples

- [Map Data with DataWeave](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-map)

- [Map an Object](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-map-an-object)

- [Exclude Field](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-exclude-field)

- [Rename Keys](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-rename-keys)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.3/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.3/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook)

<!-- document id=0fb110cafa0627019c6aff1200f53808e2cac14a9e26937a677e25439f2f3765 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook-map-object-elements-as-an-array.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, as
---

# Map Object Elements as an Array

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example uses the DataWeave `map` function to iterate through the object elements that
match the key `book`. The input also includes the key `magazine`, which is ignored.

The example uses these DataWeave functions:

- The multi-value selector `*book` to return an array with the elements that match the key `"book"`.

- `map` to go through each object in the array that’s returned by the multi-value selector.

DataWeave Script:

```dataweave
%dw 2.0
var myInputExample = {
  "inventory": {
      "book" : {
        "category": "cooking",
        "title": "Everyday Italian",
        "author": "Giada De Laurentiis",
        "year": "2005",
        "price": "30.00"
      },
      "book" :{
        "category": "children",
        "title": "Harry Potter",
        "author": "J K. Rowling",
        "year": "2005",
        "price": "29.99"
      },
      "book" :{
        "category": "web",
        "title": "Learning XML",
        "author": "Erik T. Ray",
        "year": "2003",
        "price": "39.95"
      },
      "magazine" :{
        "category": "web",
        "title": "Wired Magazine",
        "edition": "03-2017",
        "price": "15.95"
      },
        "magazine" :{
        "category": "business",
        "title": "Time Magazine",
        "edition": "04-2017",
        "price": "17.95"
      }
   }
}
output application/json
---
items: myInputExample.inventory.*book map (item, index) -> {
      "theType": "book",
      "theID": index,
      "theCategory": item.category,
      "theTitle": item.title,
      "theAuthor": item.author,
      "theYear": item.year,
      "thePrice": item.price as Number
}
```

Output JSON:

```json
{
  "items": [
    {
      "theType": "book",
      "theID": 0,
      "theCategory": "cooking",
      "theTitle": "Everyday Italian",
      "theAuthor": "Giada De Laurentiis",
      "theYear": "2005",
      "thePrice": 30.0
    },
    {
      "theType": "book",
      "theID": 1,
      "theCategory": "children",
      "theTitle": "Harry Potter",
      "theAuthor": "J K. Rowling",
      "theYear": "2005",
      "thePrice": 29.99
    },
    {
      "theType": "book",
      "theID": 2,
      "theCategory": "web",
      "theTitle": "Learning XML",
      "theAuthor": "Erik T. Ray",
      "theYear": "2003",
      "thePrice": 39.95
    }
  ]
}
```

## Related Examples

- [Map Data with DataWeave](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-map)

- [Map an Object](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-map-an-object)

- [Exclude Field](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-exclude-field)

- [Rename Keys](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-rename-keys)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.4/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.4/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook)

<!-- document id=94d60b8437aed175c5c81d806c8dd7492740d3a46580eb5c77a0c2f9a6ae90d4 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook-map-object-elements-as-an-array.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, as
---

# Map Object Elements as an Array

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example uses the DataWeave `map` function to iterate through the object elements that
match the key `book`. The input also includes the key `magazine`, which is ignored.

The example uses these DataWeave functions:

- The multi-value selector `*book` to return an array with the elements that match the key `"book"`.

- `map` to go through each object in the array that’s returned by the multi-value selector.

DataWeave Script:

```dataweave
%dw 2.0
var myInputExample = {
  "inventory": {
      "book" : {
        "category": "cooking",
        "title": "Everyday Italian",
        "author": "Giada De Laurentiis",
        "year": "2005",
        "price": "30.00"
      },
      "book" :{
        "category": "children",
        "title": "Harry Potter",
        "author": "J K. Rowling",
        "year": "2005",
        "price": "29.99"
      },
      "book" :{
        "category": "web",
        "title": "Learning XML",
        "author": "Erik T. Ray",
        "year": "2003",
        "price": "39.95"
      },
      "magazine" :{
        "category": "web",
        "title": "Wired Magazine",
        "edition": "03-2017",
        "price": "15.95"
      },
        "magazine" :{
        "category": "business",
        "title": "Time Magazine",
        "edition": "04-2017",
        "price": "17.95"
      }
   }
}
output application/json
---
items: myInputExample.inventory.*book map (item, index) -> {
      "theType": "book",
      "theID": index,
      "theCategory": item.category,
      "theTitle": item.title,
      "theAuthor": item.author,
      "theYear": item.year,
      "thePrice": item.price as Number
}
```

Output JSON:

```json
{
  "items": [
    {
      "theType": "book",
      "theID": 0,
      "theCategory": "cooking",
      "theTitle": "Everyday Italian",
      "theAuthor": "Giada De Laurentiis",
      "theYear": "2005",
      "thePrice": 30.0
    },
    {
      "theType": "book",
      "theID": 1,
      "theCategory": "children",
      "theTitle": "Harry Potter",
      "theAuthor": "J K. Rowling",
      "theYear": "2005",
      "thePrice": 29.99
    },
    {
      "theType": "book",
      "theID": 2,
      "theCategory": "web",
      "theTitle": "Learning XML",
      "theAuthor": "Erik T. Ray",
      "theYear": "2003",
      "thePrice": 39.95
    }
  ]
}
```

## Related Examples

- [Map Data with DataWeave](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-map)

- [Map an Object](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-map-an-object)

- [Exclude Field](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-exclude-field)

- [Rename Keys](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-rename-keys)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.6/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.6/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook)

<!-- document id=aaae157565ab3643283cd1b3dee0b2c51b94f3fc1c56393359b9bcf897a48d37 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook-map-object-elements-as-an-array.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, as
---

# Map Object Elements as an Array

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example uses the DataWeave `map` function to iterate through the object elements that
match the key `book`. The input also includes the key `magazine`, which is ignored.

The example uses these DataWeave functions:

- The multi-value selector `*book` to return an array with the elements that match the key `"book"`.

- `map` to go through each object in the array that’s returned by the multi-value selector.

DataWeave Script:

```dataweave
%dw 2.0
var myInputExample = {
  "inventory": {
      "book" : {
        "category": "cooking",
        "title": "Everyday Italian",
        "author": "Giada De Laurentiis",
        "year": "2005",
        "price": "30.00"
      },
      "book" :{
        "category": "children",
        "title": "Harry Potter",
        "author": "J K. Rowling",
        "year": "2005",
        "price": "29.99"
      },
      "book" :{
        "category": "web",
        "title": "Learning XML",
        "author": "Erik T. Ray",
        "year": "2003",
        "price": "39.95"
      },
      "magazine" :{
        "category": "web",
        "title": "Wired Magazine",
        "edition": "03-2017",
        "price": "15.95"
      },
        "magazine" :{
        "category": "business",
        "title": "Time Magazine",
        "edition": "04-2017",
        "price": "17.95"
      }
   }
}
output application/json
---
items: myInputExample.inventory.*book map (item, index) -> {
      "theType": "book",
      "theID": index,
      "theCategory": item.category,
      "theTitle": item.title,
      "theAuthor": item.author,
      "theYear": item.year,
      "thePrice": item.price as Number
}
```

Output JSON:

```json
{
  "items": [
    {
      "theType": "book",
      "theID": 0,
      "theCategory": "cooking",
      "theTitle": "Everyday Italian",
      "theAuthor": "Giada De Laurentiis",
      "theYear": "2005",
      "thePrice": 30.0
    },
    {
      "theType": "book",
      "theID": 1,
      "theCategory": "children",
      "theTitle": "Harry Potter",
      "theAuthor": "J K. Rowling",
      "theYear": "2005",
      "thePrice": 29.99
    },
    {
      "theType": "book",
      "theID": 2,
      "theCategory": "web",
      "theTitle": "Learning XML",
      "theAuthor": "Erik T. Ray",
      "theYear": "2003",
      "thePrice": 39.95
    }
  ]
}
```

## Related Examples

- [Map Data with DataWeave](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-map)

- [Map an Object](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-map-an-object)

- [Exclude Field](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-exclude-field)

- [Rename Keys](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-rename-keys)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.9/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.9/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook)

<!-- document id=8a8ef06d89df758347cc4caa5d79dbed337271fee6988c953315ed5c828ac994 url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook-map-object-elements-as-an-array.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, as
---

# Map Object Elements as an Array

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example uses the DataWeave `map` function to iterate through the object elements that
match the key `book`. The input also includes the key `magazine`, which is ignored.

The example uses these DataWeave functions:

- The multi-value selector `*book` to return an array with the elements that match the key `"book"`.

- `map` to go through each object in the array that’s returned by the multi-value selector.

DataWeave Script:

```dataweave
%dw 2.0
var myInputExample = {
  "inventory": {
      "book" : {
        "category": "cooking",
        "title": "Everyday Italian",
        "author": "Giada De Laurentiis",
        "year": "2005",
        "price": "30.00"
      },
      "book" :{
        "category": "children",
        "title": "Harry Potter",
        "author": "J K. Rowling",
        "year": "2005",
        "price": "29.99"
      },
      "book" :{
        "category": "web",
        "title": "Learning XML",
        "author": "Erik T. Ray",
        "year": "2003",
        "price": "39.95"
      },
      "magazine" :{
        "category": "web",
        "title": "Wired Magazine",
        "edition": "03-2017",
        "price": "15.95"
      },
        "magazine" :{
        "category": "business",
        "title": "Time Magazine",
        "edition": "04-2017",
        "price": "17.95"
      }
   }
}
output application/json
---
items: myInputExample.inventory.*book map (item, index) -> {
      "theType": "book",
      "theID": index,
      "theCategory": item.category,
      "theTitle": item.title,
      "theAuthor": item.author,
      "theYear": item.year,
      "thePrice": item.price as Number
}
```

Output JSON:

```json
{
  "items": [
    {
      "theType": "book",
      "theID": 0,
      "theCategory": "cooking",
      "theTitle": "Everyday Italian",
      "theAuthor": "Giada De Laurentiis",
      "theYear": "2005",
      "thePrice": 30.0
    },
    {
      "theType": "book",
      "theID": 1,
      "theCategory": "children",
      "theTitle": "Harry Potter",
      "theAuthor": "J K. Rowling",
      "theYear": "2005",
      "thePrice": 29.99
    },
    {
      "theType": "book",
      "theID": 2,
      "theCategory": "web",
      "theTitle": "Learning XML",
      "theAuthor": "Erik T. Ray",
      "theYear": "2003",
      "thePrice": 39.95
    }
  ]
}
```

## Related Examples

- [Map Data with DataWeave](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-map)

- [Map an Object](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-map-an-object)

- [Exclude Field](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-exclude-field)

- [Rename Keys](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-rename-keys)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/latest/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook)

<!-- document id=05cc6221773a232c64adb85bba60c823ba40f5c2252a9302376a965d3ebd2597 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook-map-an-object.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, as
---

# Map Objects

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following DataWeave examples use the `mapObject` function to iterate through the keys and values
of objects.

## First Example

This example uses both the `map` and `mapObject` functions to iterate through the input and set all
of the keys to upper case.

The example uses these DataWeave functions:

- `map` to go through the elements in the "books" array.

- `mapObject` to go through the keys and values in each of the objects of the array.

- `upper` to set each key to upper case.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
items: payload.books map (item, index) -> {
      book: item mapObject (value, key) -> {
      (upper(key)): value
      }
}
```

Input JSON Payload:

```json
{
  "books": [
    {
      "-category": "cooking",
      "title": "Everyday Italian",
      "author": "Giada De Laurentiis",
      "year": "2005",
      "price": "30.00"
    },
    {
      "-category": "children",
      "title": "Harry Potter",
      "author": "J K. Rowling",
      "year": "2005",
      "price": "29.99"
    },
    {
      "-category": "web",
      "title": "XQuery Kick Start",
      "author": [
        "James McGovern",
        "Per Bothner",
        "Kurt Cagle",
        "James Linn",
        "Vaidyanathan Nagarajan"
      ],
      "year": "2003",
      "price": "49.99"
    },
    {
      "-category": "web",
      "-cover": "paperback",
      "title": "Learning XML",
      "author": "Erik T. Ray",
      "year": "2003",
      "price": "39.95"
    }
  ]
}
```

Output JSON:

```json
{
  "items": [
    {
      "book": {
        "-CATEGORY": "cooking",
        "TITLE": "Everyday Italian",
        "AUTHOR": "Giada De Laurentiis",
        "YEAR": "2005",
        "PRICE": "30.00"
      }
    },
    {
      "book": {
        "-CATEGORY": "children",
        "TITLE": "Harry Potter",
        "AUTHOR": "J K. Rowling",
        "YEAR": "2005",
        "PRICE": "29.99"
      }
    },
    {
      "book": {
        "-CATEGORY": "web",
        "TITLE": "XQuery Kick Start",
        "AUTHOR": [
          "James McGovern",
          "Per Bothner",
          "Kurt Cagle",
          "James Linn",
          "Vaidyanathan Nagarajan"
        ],
        "YEAR": "2003",
        "PRICE": "49.99"
      }
    },
    {
      "book": {
        "-CATEGORY": "web",
        "-COVER": "paperback",
        "TITLE": "Learning XML",
        "AUTHOR": "Erik T. Ray",
        "YEAR": "2003",
        "PRICE": "39.95"
      }
    }
  ]
}
```

## Second Example

This example uses the `mapObject` function to iterate through the keys and values of the object that
results from using `groupBy` on the payload. If some objects of the input payload have the same
values in the `FirstName`, `LastName` and `Age` keys, the DataWeave script transforms those objects
into a single row in a CSV file. The remaining values in the `Team Name` and `Role` keys for those
objects are concatenated with `:` in the single CSV row.

Input JSON Payload:

```json
[
  {
    "Sr.No.": 1,
    "FirstName": "Charles",
    "LastName": "Lock",
    "Age": 40,
    "Team Name": "Scrum team 1",
    "Role": "developer"
  },
  {
    "Sr.No.": 2,
    "FirstName": "Josh",
    "LastName": "Rodriguez",
    "Age": 45,
    "Team Name": "architecture",
    "Role": "SA"
  },
  {
    "Sr.No.": 3,
    "FirstName": "Josh",
    "LastName": "Rodriguez",
    "Age": 45,
    "Team Name": "technology",
    "Role": "advisor"
  },
  {
    "Sr.No.": 4,
    "FirstName": "Josh",
    "LastName": "Rodriguez",
    "Age": 35,
    "Team Name": "development",
    "Role": "developer"
  },
  {
    "Sr.No.": 5,
    "FirstName": "Jane",
    "LastName": "Rodriguez",
    "Age": 30,
    "Team Name": "architecture",
    "Role": "SA"
  },
  {
    "Sr.No.": 6,
    "FirstName": "Jane",
    "LastName": "Rodriguez",
    "Age": 30,
    "Team Name": "Scrum team 1",
    "Role": "developer"
  },
  {
    "Sr.No.": 7,
    "FirstName": "Josh",
    "LastName": "Lee",
    "Age": 42,
    "Team Name": "Scrum team1",
    "Role": "developer"
  }
]
```

In the previous input example, `Sr.No. 2` and `Sr.No. 3`, as well as `Sr.No. 5` and `Sr.No. 6`,
refer to the same person, as they have the same first name, last name, and age. However, `Sr.No. 4`
refers to a different person, as it has the same first and last name but a different age.

DataWeave Script:

```dataweave
output application/csv
---
valuesOf(
    payload
        groupBy ((item, index) -> (
            item.FirstName ++ item.LastName ++ item.Age))
        mapObject ((value, key, index) ->
            (index): {
                "Sr.No.": value."Sr.No." joinBy ":",
                "FirstName": value.FirstName[0],
                "LastName": value.LastName[0],
                "Age": value.Age[0],
                "Team Name": value."Team Name" joinBy ":",
                "Role": value.Role joinBy ":"
            })
)
```

The DataWeave script merges the repeated values of keys `FirstName`, `LastName` and `Age` of the
objects with key-value `Sr.No. 2` and `Sr.No. 3`, as well as `Sr.No. 5` and `Sr.No. 6`. These values
are separated with `,` in the single CSV row. The values of `Team Name` and `Role` for those objects
are concatenated with `:` in the single CSV row.

Output CSV:

```CSV
Sr.No.,FirstName,LastName,Age,Team Name,Role
1,Charles,Lock,40,Scrum team 1,developer
2:3,Josh,Rodriguez,45,architecture:technology,SA:advisor
4,Josh,Rodriguez,35,development,developer
5:6,Jane,Rodriguez,30,architecture:Scrum team 1,SA:developer
7,Josh,Lee,42,Scrum team1,developer
```

## Related Examples

- [Map Data with DataWeave](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-map)

- [Map Object Elements as an Array](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-map-object-elements-as-an-array)

- [Extract Data](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-extract-data)

- [Transform XML to JSON](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-perform-basic-transformation)

- [Rename Keys](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-rename-keys)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.11/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.11/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook)

<!-- document id=067c4be9232550b69413a603b481c74be046e087e38af956463b918f6b143ece url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook-map-an-object.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, as
---

# Map Objects

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following DataWeave examples use the `mapObject` function to iterate through the keys and values
of objects.

## First Example

This example uses both the `map` and `mapObject` functions to iterate through the input and set all
of the keys to upper case.

The example uses these DataWeave functions:

- `map` to go through the elements in the "books" array.

- `mapObject` to go through the keys and values in each of the objects of the array.

- `upper` to set each key to upper case.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
items: payload.books map (item, index) -> {
      book: item mapObject (value, key) -> {
      (upper(key)): value
      }
}
```

Input JSON Payload:

```json
{
  "books": [
    {
      "-category": "cooking",
      "title": "Everyday Italian",
      "author": "Giada De Laurentiis",
      "year": "2005",
      "price": "30.00"
    },
    {
      "-category": "children",
      "title": "Harry Potter",
      "author": "J K. Rowling",
      "year": "2005",
      "price": "29.99"
    },
    {
      "-category": "web",
      "title": "XQuery Kick Start",
      "author": [
        "James McGovern",
        "Per Bothner",
        "Kurt Cagle",
        "James Linn",
        "Vaidyanathan Nagarajan"
      ],
      "year": "2003",
      "price": "49.99"
    },
    {
      "-category": "web",
      "-cover": "paperback",
      "title": "Learning XML",
      "author": "Erik T. Ray",
      "year": "2003",
      "price": "39.95"
    }
  ]
}
```

Output JSON:

```json
{
  "items": [
    {
      "book": {
        "-CATEGORY": "cooking",
        "TITLE": "Everyday Italian",
        "AUTHOR": "Giada De Laurentiis",
        "YEAR": "2005",
        "PRICE": "30.00"
      }
    },
    {
      "book": {
        "-CATEGORY": "children",
        "TITLE": "Harry Potter",
        "AUTHOR": "J K. Rowling",
        "YEAR": "2005",
        "PRICE": "29.99"
      }
    },
    {
      "book": {
        "-CATEGORY": "web",
        "TITLE": "XQuery Kick Start",
        "AUTHOR": [
          "James McGovern",
          "Per Bothner",
          "Kurt Cagle",
          "James Linn",
          "Vaidyanathan Nagarajan"
        ],
        "YEAR": "2003",
        "PRICE": "49.99"
      }
    },
    {
      "book": {
        "-CATEGORY": "web",
        "-COVER": "paperback",
        "TITLE": "Learning XML",
        "AUTHOR": "Erik T. Ray",
        "YEAR": "2003",
        "PRICE": "39.95"
      }
    }
  ]
}
```

## Second Example

This example uses the `mapObject` function to iterate through the keys and values of the object that
results from using `groupBy` on the payload. If some objects of the input payload have the same
values in the `FirstName`, `LastName` and `Age` keys, the DataWeave script transforms those objects
into a single row in a CSV file. The remaining values in the `Team Name` and `Role` keys for those
objects are concatenated with `:` in the single CSV row.

Input JSON Payload:

```json
[
  {
    "Sr.No.": 1,
    "FirstName": "Charles",
    "LastName": "Lock",
    "Age": 40,
    "Team Name": "Scrum team 1",
    "Role": "developer"
  },
  {
    "Sr.No.": 2,
    "FirstName": "Josh",
    "LastName": "Rodriguez",
    "Age": 45,
    "Team Name": "architecture",
    "Role": "SA"
  },
  {
    "Sr.No.": 3,
    "FirstName": "Josh",
    "LastName": "Rodriguez",
    "Age": 45,
    "Team Name": "technology",
    "Role": "advisor"
  },
  {
    "Sr.No.": 4,
    "FirstName": "Josh",
    "LastName": "Rodriguez",
    "Age": 35,
    "Team Name": "development",
    "Role": "developer"
  },
  {
    "Sr.No.": 5,
    "FirstName": "Jane",
    "LastName": "Rodriguez",
    "Age": 30,
    "Team Name": "architecture",
    "Role": "SA"
  },
  {
    "Sr.No.": 6,
    "FirstName": "Jane",
    "LastName": "Rodriguez",
    "Age": 30,
    "Team Name": "Scrum team 1",
    "Role": "developer"
  },
  {
    "Sr.No.": 7,
    "FirstName": "Josh",
    "LastName": "Lee",
    "Age": 42,
    "Team Name": "Scrum team1",
    "Role": "developer"
  }
]
```

In the previous input example, `Sr.No. 2` and `Sr.No. 3`, as well as `Sr.No. 5` and `Sr.No. 6`,
refer to the same person, as they have the same first name, last name, and age. However, `Sr.No. 4`
refers to a different person, as it has the same first and last name but a different age.

DataWeave Script:

```dataweave
output application/csv
---
valuesOf(
    payload
        groupBy ((item, index) -> (
            item.FirstName ++ item.LastName ++ item.Age))
        mapObject ((value, key, index) ->
            (index): {
                "Sr.No.": value."Sr.No." joinBy ":",
                "FirstName": value.FirstName[0],
                "LastName": value.LastName[0],
                "Age": value.Age[0],
                "Team Name": value."Team Name" joinBy ":",
                "Role": value.Role joinBy ":"
            })
)
```

The DataWeave script merges the repeated values of keys `FirstName`, `LastName` and `Age` of the
objects with key-value `Sr.No. 2` and `Sr.No. 3`, as well as `Sr.No. 5` and `Sr.No. 6`. These values
are separated with `,` in the single CSV row. The values of `Team Name` and `Role` for those objects
are concatenated with `:` in the single CSV row.

Output CSV:

```CSV
Sr.No.,FirstName,LastName,Age,Team Name,Role
1,Charles,Lock,40,Scrum team 1,developer
2:3,Josh,Rodriguez,45,architecture:technology,SA:advisor
4,Josh,Rodriguez,35,development,developer
5:6,Jane,Rodriguez,30,architecture:Scrum team 1,SA:developer
7,Josh,Lee,42,Scrum team1,developer
```

## Related Examples

- [Map Data with DataWeave](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-map)

- [Map Object Elements as an Array](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-map-object-elements-as-an-array)

- [Extract Data](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-extract-data)

- [Transform XML to JSON](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-perform-basic-transformation)

- [Rename Keys](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-rename-keys)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.12/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.12/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook)

<!-- document id=617a935a3ac9f9afeb18f8395b9e830555bde70de6b7a2e3fdd8c358df064d2e url=/mulesoft/current/en-us/dataweave/2.3/dataweave-cookbook-map-an-object.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, as
---

# Map Objects

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example uses both the `map` and `mapObject` functions to iterate through the input
and set all of the keys to upper case.

The example uses these DataWeave functions:

- `map` to go through the elements in the "books" array.

- `mapObject` to go through the keys and values in each of the objects of the array.

- `upper` to set each key to upper case.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
items: payload.books map (item, index) -> {
      book: item mapObject (value, key) -> {
      (upper(key)): value
      }
}
```

Input JSON Payload:

```json
{
  "books": [
    {
      "-category": "cooking",
      "title": "Everyday Italian",
      "author": "Giada De Laurentiis",
      "year": "2005",
      "price": "30.00"
    },
    {
      "-category": "children",
      "title": "Harry Potter",
      "author": "J K. Rowling",
      "year": "2005",
      "price": "29.99"
    },
    {
      "-category": "web",
      "title": "XQuery Kick Start",
      "author": [
        "James McGovern",
        "Per Bothner",
        "Kurt Cagle",
        "James Linn",
        "Vaidyanathan Nagarajan"
      ],
      "year": "2003",
      "price": "49.99"
    },
    {
      "-category": "web",
      "-cover": "paperback",
      "title": "Learning XML",
      "author": "Erik T. Ray",
      "year": "2003",
      "price": "39.95"
    }
  ]
}
```

Output JSON:

```json
{
  "items": [
    {
      "book": {
        "-CATEGORY": "cooking",
        "TITLE": "Everyday Italian",
        "AUTHOR": "Giada De Laurentiis",
        "YEAR": "2005",
        "PRICE": "30.00"
      }
    },
    {
      "book": {
        "-CATEGORY": "children",
        "TITLE": "Harry Potter",
        "AUTHOR": "J K. Rowling",
        "YEAR": "2005",
        "PRICE": "29.99"
      }
    },
    {
      "book": {
        "-CATEGORY": "web",
        "TITLE": "XQuery Kick Start",
        "AUTHOR": [
          "James McGovern",
          "Per Bothner",
          "Kurt Cagle",
          "James Linn",
          "Vaidyanathan Nagarajan"
        ],
        "YEAR": "2003",
        "PRICE": "49.99"
      }
    },
    {
      "book": {
        "-CATEGORY": "web",
        "-COVER": "paperback",
        "TITLE": "Learning XML",
        "AUTHOR": "Erik T. Ray",
        "YEAR": "2003",
        "PRICE": "39.95"
      }
    }
  ]
}
```

## Related Examples

- [Map Data with DataWeave](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-map)

- [Map Object Elements as an Array](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-map-object-elements-as-an-array)

- [Extract Data](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-extract-data)

- [Transform XML to JSON](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-perform-basic-transformation)

- [Rename Keys](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-rename-keys)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.3/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.3/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook)

<!-- document id=4041dd8572bf6e288eae17fc5be745d78a06c0cd92d96360867e0bce0386872c url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook-map-an-object.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, as
---

# Map Objects

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following DataWeave examples use the `mapObject` function to iterate through the keys and values
of objects.

## First Example

This example uses both the `map` and `mapObject` functions to iterate through the input and set all
of the keys to upper case.

The example uses these DataWeave functions:

- `map` to go through the elements in the "books" array.

- `mapObject` to go through the keys and values in each of the objects of the array.

- `upper` to set each key to upper case.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
items: payload.books map (item, index) -> {
      book: item mapObject (value, key) -> {
      (upper(key)): value
      }
}
```

Input JSON Payload:

```json
{
  "books": [
    {
      "-category": "cooking",
      "title": "Everyday Italian",
      "author": "Giada De Laurentiis",
      "year": "2005",
      "price": "30.00"
    },
    {
      "-category": "children",
      "title": "Harry Potter",
      "author": "J K. Rowling",
      "year": "2005",
      "price": "29.99"
    },
    {
      "-category": "web",
      "title": "XQuery Kick Start",
      "author": [
        "James McGovern",
        "Per Bothner",
        "Kurt Cagle",
        "James Linn",
        "Vaidyanathan Nagarajan"
      ],
      "year": "2003",
      "price": "49.99"
    },
    {
      "-category": "web",
      "-cover": "paperback",
      "title": "Learning XML",
      "author": "Erik T. Ray",
      "year": "2003",
      "price": "39.95"
    }
  ]
}
```

Output JSON:

```json
{
  "items": [
    {
      "book": {
        "-CATEGORY": "cooking",
        "TITLE": "Everyday Italian",
        "AUTHOR": "Giada De Laurentiis",
        "YEAR": "2005",
        "PRICE": "30.00"
      }
    },
    {
      "book": {
        "-CATEGORY": "children",
        "TITLE": "Harry Potter",
        "AUTHOR": "J K. Rowling",
        "YEAR": "2005",
        "PRICE": "29.99"
      }
    },
    {
      "book": {
        "-CATEGORY": "web",
        "TITLE": "XQuery Kick Start",
        "AUTHOR": [
          "James McGovern",
          "Per Bothner",
          "Kurt Cagle",
          "James Linn",
          "Vaidyanathan Nagarajan"
        ],
        "YEAR": "2003",
        "PRICE": "49.99"
      }
    },
    {
      "book": {
        "-CATEGORY": "web",
        "-COVER": "paperback",
        "TITLE": "Learning XML",
        "AUTHOR": "Erik T. Ray",
        "YEAR": "2003",
        "PRICE": "39.95"
      }
    }
  ]
}
```

## Second Example

This example uses the `mapObject` function to iterate through the keys and values of the object that
results from using `groupBy` on the payload. If some objects of the input payload have the same
values in the `FirstName`, `LastName` and `Age` keys, the DataWeave script transforms those objects
into a single row in a CSV file. The remaining values in the `Team Name` and `Role` keys for those
objects are concatenated with `:` in the single CSV row.

Input JSON Payload:

```json
[
  {
    "Sr.No.": 1,
    "FirstName": "Charles",
    "LastName": "Lock",
    "Age": 40,
    "Team Name": "Scrum team 1",
    "Role": "developer"
  },
  {
    "Sr.No.": 2,
    "FirstName": "Josh",
    "LastName": "Rodriguez",
    "Age": 45,
    "Team Name": "architecture",
    "Role": "SA"
  },
  {
    "Sr.No.": 3,
    "FirstName": "Josh",
    "LastName": "Rodriguez",
    "Age": 45,
    "Team Name": "technology",
    "Role": "advisor"
  },
  {
    "Sr.No.": 4,
    "FirstName": "Josh",
    "LastName": "Rodriguez",
    "Age": 35,
    "Team Name": "development",
    "Role": "developer"
  },
  {
    "Sr.No.": 5,
    "FirstName": "Jane",
    "LastName": "Rodriguez",
    "Age": 30,
    "Team Name": "architecture",
    "Role": "SA"
  },
  {
    "Sr.No.": 6,
    "FirstName": "Jane",
    "LastName": "Rodriguez",
    "Age": 30,
    "Team Name": "Scrum team 1",
    "Role": "developer"
  },
  {
    "Sr.No.": 7,
    "FirstName": "Josh",
    "LastName": "Lee",
    "Age": 42,
    "Team Name": "Scrum team1",
    "Role": "developer"
  }
]
```

In the previous input example, `Sr.No. 2` and `Sr.No. 3`, as well as `Sr.No. 5` and `Sr.No. 6`,
refer to the same person, as they have the same first name, last name, and age. However, `Sr.No. 4`
refers to a different person, as it has the same first and last name but a different age.

DataWeave Script:

```dataweave
output application/csv
---
valuesOf(
    payload
        groupBy ((item, index) -> (
            item.FirstName ++ item.LastName ++ item.Age))
        mapObject ((value, key, index) ->
            (index): {
                "Sr.No.": value."Sr.No." joinBy ":",
                "FirstName": value.FirstName[0],
                "LastName": value.LastName[0],
                "Age": value.Age[0],
                "Team Name": value."Team Name" joinBy ":",
                "Role": value.Role joinBy ":"
            })
)
```

The DataWeave script merges the repeated values of keys `FirstName`, `LastName` and `Age` of the
objects with key-value `Sr.No. 2` and `Sr.No. 3`, as well as `Sr.No. 5` and `Sr.No. 6`. These values
are separated with `,` in the single CSV row. The values of `Team Name` and `Role` for those objects
are concatenated with `:` in the single CSV row.

Output CSV:

```CSV
Sr.No.,FirstName,LastName,Age,Team Name,Role
1,Charles,Lock,40,Scrum team 1,developer
2:3,Josh,Rodriguez,45,architecture:technology,SA:advisor
4,Josh,Rodriguez,35,development,developer
5:6,Jane,Rodriguez,30,architecture:Scrum team 1,SA:developer
7,Josh,Lee,42,Scrum team1,developer
```

## Related Examples

- [Map Data with DataWeave](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-map)

- [Map Object Elements as an Array](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-map-object-elements-as-an-array)

- [Extract Data](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-extract-data)

- [Transform XML to JSON](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-perform-basic-transformation)

- [Rename Keys](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-rename-keys)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.4/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.4/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook)

<!-- document id=f85223017bb5eebc56fd25058793f2a819b40ffa9a4ed058408e0435cb0e27f7 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook-map-an-object.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, as
---

# Map Objects

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following DataWeave examples use the `mapObject` function to iterate through the keys and values
of objects.

## First Example

This example uses both the `map` and `mapObject` functions to iterate through the input and set all
of the keys to upper case.

The example uses these DataWeave functions:

- `map` to go through the elements in the "books" array.

- `mapObject` to go through the keys and values in each of the objects of the array.

- `upper` to set each key to upper case.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
items: payload.books map (item, index) -> {
      book: item mapObject (value, key) -> {
      (upper(key)): value
      }
}
```

Input JSON Payload:

```json
{
  "books": [
    {
      "-category": "cooking",
      "title": "Everyday Italian",
      "author": "Giada De Laurentiis",
      "year": "2005",
      "price": "30.00"
    },
    {
      "-category": "children",
      "title": "Harry Potter",
      "author": "J K. Rowling",
      "year": "2005",
      "price": "29.99"
    },
    {
      "-category": "web",
      "title": "XQuery Kick Start",
      "author": [
        "James McGovern",
        "Per Bothner",
        "Kurt Cagle",
        "James Linn",
        "Vaidyanathan Nagarajan"
      ],
      "year": "2003",
      "price": "49.99"
    },
    {
      "-category": "web",
      "-cover": "paperback",
      "title": "Learning XML",
      "author": "Erik T. Ray",
      "year": "2003",
      "price": "39.95"
    }
  ]
}
```

Output JSON:

```json
{
  "items": [
    {
      "book": {
        "-CATEGORY": "cooking",
        "TITLE": "Everyday Italian",
        "AUTHOR": "Giada De Laurentiis",
        "YEAR": "2005",
        "PRICE": "30.00"
      }
    },
    {
      "book": {
        "-CATEGORY": "children",
        "TITLE": "Harry Potter",
        "AUTHOR": "J K. Rowling",
        "YEAR": "2005",
        "PRICE": "29.99"
      }
    },
    {
      "book": {
        "-CATEGORY": "web",
        "TITLE": "XQuery Kick Start",
        "AUTHOR": [
          "James McGovern",
          "Per Bothner",
          "Kurt Cagle",
          "James Linn",
          "Vaidyanathan Nagarajan"
        ],
        "YEAR": "2003",
        "PRICE": "49.99"
      }
    },
    {
      "book": {
        "-CATEGORY": "web",
        "-COVER": "paperback",
        "TITLE": "Learning XML",
        "AUTHOR": "Erik T. Ray",
        "YEAR": "2003",
        "PRICE": "39.95"
      }
    }
  ]
}
```

## Second Example

This example uses the `mapObject` function to iterate through the keys and values of the object that
results from using `groupBy` on the payload. If some objects of the input payload have the same
values in the `FirstName`, `LastName` and `Age` keys, the DataWeave script transforms those objects
into a single row in a CSV file. The remaining values in the `Team Name` and `Role` keys for those
objects are concatenated with `:` in the single CSV row.

Input JSON Payload:

```json
[
  {
    "Sr.No.": 1,
    "FirstName": "Charles",
    "LastName": "Lock",
    "Age": 40,
    "Team Name": "Scrum team 1",
    "Role": "developer"
  },
  {
    "Sr.No.": 2,
    "FirstName": "Josh",
    "LastName": "Rodriguez",
    "Age": 45,
    "Team Name": "architecture",
    "Role": "SA"
  },
  {
    "Sr.No.": 3,
    "FirstName": "Josh",
    "LastName": "Rodriguez",
    "Age": 45,
    "Team Name": "technology",
    "Role": "advisor"
  },
  {
    "Sr.No.": 4,
    "FirstName": "Josh",
    "LastName": "Rodriguez",
    "Age": 35,
    "Team Name": "development",
    "Role": "developer"
  },
  {
    "Sr.No.": 5,
    "FirstName": "Jane",
    "LastName": "Rodriguez",
    "Age": 30,
    "Team Name": "architecture",
    "Role": "SA"
  },
  {
    "Sr.No.": 6,
    "FirstName": "Jane",
    "LastName": "Rodriguez",
    "Age": 30,
    "Team Name": "Scrum team 1",
    "Role": "developer"
  },
  {
    "Sr.No.": 7,
    "FirstName": "Josh",
    "LastName": "Lee",
    "Age": 42,
    "Team Name": "Scrum team1",
    "Role": "developer"
  }
]
```

In the previous input example, `Sr.No. 2` and `Sr.No. 3`, as well as `Sr.No. 5` and `Sr.No. 6`,
refer to the same person, as they have the same first name, last name, and age. However, `Sr.No. 4`
refers to a different person, as it has the same first and last name but a different age.

DataWeave Script:

```dataweave
output application/csv
---
valuesOf(
    payload
        groupBy ((item, index) -> (
            item.FirstName ++ item.LastName ++ item.Age))
        mapObject ((value, key, index) ->
            (index): {
                "Sr.No.": value."Sr.No." joinBy ":",
                "FirstName": value.FirstName[0],
                "LastName": value.LastName[0],
                "Age": value.Age[0],
                "Team Name": value."Team Name" joinBy ":",
                "Role": value.Role joinBy ":"
            })
)
```

The DataWeave script merges the repeated values of keys `FirstName`, `LastName` and `Age` of the
objects with key-value `Sr.No. 2` and `Sr.No. 3`, as well as `Sr.No. 5` and `Sr.No. 6`. These values
are separated with `,` in the single CSV row. The values of `Team Name` and `Role` for those objects
are concatenated with `:` in the single CSV row.

Output CSV:

```CSV
Sr.No.,FirstName,LastName,Age,Team Name,Role
1,Charles,Lock,40,Scrum team 1,developer
2:3,Josh,Rodriguez,45,architecture:technology,SA:advisor
4,Josh,Rodriguez,35,development,developer
5:6,Jane,Rodriguez,30,architecture:Scrum team 1,SA:developer
7,Josh,Lee,42,Scrum team1,developer
```

## Related Examples

- [Map Data with DataWeave](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-map)

- [Map Object Elements as an Array](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-map-object-elements-as-an-array)

- [Extract Data](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-extract-data)

- [Transform XML to JSON](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-perform-basic-transformation)

- [Rename Keys](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-rename-keys)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.6/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.6/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook)

<!-- document id=41344b3b0895b210c2bf8488e907f32c1698eade69417ecdc0dee409e134e73d url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook-map-an-object.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, as
---

# Map Objects

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following DataWeave examples use the `mapObject` function to iterate through the keys and values
of objects.

## First Example

This example uses both the `map` and `mapObject` functions to iterate through the input and set all
of the keys to upper case.

The example uses these DataWeave functions:

- `map` to go through the elements in the "books" array.

- `mapObject` to go through the keys and values in each of the objects of the array.

- `upper` to set each key to upper case.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
items: payload.books map (item, index) -> {
      book: item mapObject (value, key) -> {
      (upper(key)): value
      }
}
```

Input JSON Payload:

```json
{
  "books": [
    {
      "-category": "cooking",
      "title": "Everyday Italian",
      "author": "Giada De Laurentiis",
      "year": "2005",
      "price": "30.00"
    },
    {
      "-category": "children",
      "title": "Harry Potter",
      "author": "J K. Rowling",
      "year": "2005",
      "price": "29.99"
    },
    {
      "-category": "web",
      "title": "XQuery Kick Start",
      "author": [
        "James McGovern",
        "Per Bothner",
        "Kurt Cagle",
        "James Linn",
        "Vaidyanathan Nagarajan"
      ],
      "year": "2003",
      "price": "49.99"
    },
    {
      "-category": "web",
      "-cover": "paperback",
      "title": "Learning XML",
      "author": "Erik T. Ray",
      "year": "2003",
      "price": "39.95"
    }
  ]
}
```

Output JSON:

```json
{
  "items": [
    {
      "book": {
        "-CATEGORY": "cooking",
        "TITLE": "Everyday Italian",
        "AUTHOR": "Giada De Laurentiis",
        "YEAR": "2005",
        "PRICE": "30.00"
      }
    },
    {
      "book": {
        "-CATEGORY": "children",
        "TITLE": "Harry Potter",
        "AUTHOR": "J K. Rowling",
        "YEAR": "2005",
        "PRICE": "29.99"
      }
    },
    {
      "book": {
        "-CATEGORY": "web",
        "TITLE": "XQuery Kick Start",
        "AUTHOR": [
          "James McGovern",
          "Per Bothner",
          "Kurt Cagle",
          "James Linn",
          "Vaidyanathan Nagarajan"
        ],
        "YEAR": "2003",
        "PRICE": "49.99"
      }
    },
    {
      "book": {
        "-CATEGORY": "web",
        "-COVER": "paperback",
        "TITLE": "Learning XML",
        "AUTHOR": "Erik T. Ray",
        "YEAR": "2003",
        "PRICE": "39.95"
      }
    }
  ]
}
```

## Second Example

This example uses the `mapObject` function to iterate through the keys and values of the object that
results from using `groupBy` on the payload. If some objects of the input payload have the same
values in the `FirstName`, `LastName` and `Age` keys, the DataWeave script transforms those objects
into a single row in a CSV file. The remaining values in the `Team Name` and `Role` keys for those
objects are concatenated with `:` in the single CSV row.

Input JSON Payload:

```json
[
  {
    "Sr.No.": 1,
    "FirstName": "Charles",
    "LastName": "Lock",
    "Age": 40,
    "Team Name": "Scrum team 1",
    "Role": "developer"
  },
  {
    "Sr.No.": 2,
    "FirstName": "Josh",
    "LastName": "Rodriguez",
    "Age": 45,
    "Team Name": "architecture",
    "Role": "SA"
  },
  {
    "Sr.No.": 3,
    "FirstName": "Josh",
    "LastName": "Rodriguez",
    "Age": 45,
    "Team Name": "technology",
    "Role": "advisor"
  },
  {
    "Sr.No.": 4,
    "FirstName": "Josh",
    "LastName": "Rodriguez",
    "Age": 35,
    "Team Name": "development",
    "Role": "developer"
  },
  {
    "Sr.No.": 5,
    "FirstName": "Jane",
    "LastName": "Rodriguez",
    "Age": 30,
    "Team Name": "architecture",
    "Role": "SA"
  },
  {
    "Sr.No.": 6,
    "FirstName": "Jane",
    "LastName": "Rodriguez",
    "Age": 30,
    "Team Name": "Scrum team 1",
    "Role": "developer"
  },
  {
    "Sr.No.": 7,
    "FirstName": "Josh",
    "LastName": "Lee",
    "Age": 42,
    "Team Name": "Scrum team1",
    "Role": "developer"
  }
]
```

In the previous input example, `Sr.No. 2` and `Sr.No. 3`, as well as `Sr.No. 5` and `Sr.No. 6`,
refer to the same person, as they have the same first name, last name, and age. However, `Sr.No. 4`
refers to a different person, as it has the same first and last name but a different age.

DataWeave Script:

```dataweave
output application/csv
---
valuesOf(
    payload
        groupBy ((item, index) -> (
            item.FirstName ++ item.LastName ++ item.Age))
        mapObject ((value, key, index) ->
            (index): {
                "Sr.No.": value."Sr.No." joinBy ":",
                "FirstName": value.FirstName[0],
                "LastName": value.LastName[0],
                "Age": value.Age[0],
                "Team Name": value."Team Name" joinBy ":",
                "Role": value.Role joinBy ":"
            })
)
```

The DataWeave script merges the repeated values of keys `FirstName`, `LastName` and `Age` of the
objects with key-value `Sr.No. 2` and `Sr.No. 3`, as well as `Sr.No. 5` and `Sr.No. 6`. These values
are separated with `,` in the single CSV row. The values of `Team Name` and `Role` for those objects
are concatenated with `:` in the single CSV row.

Output CSV:

```CSV
Sr.No.,FirstName,LastName,Age,Team Name,Role
1,Charles,Lock,40,Scrum team 1,developer
2:3,Josh,Rodriguez,45,architecture:technology,SA:advisor
4,Josh,Rodriguez,35,development,developer
5:6,Jane,Rodriguez,30,architecture:Scrum team 1,SA:developer
7,Josh,Lee,42,Scrum team1,developer
```

## Related Examples

- [Map Data with DataWeave](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-map)

- [Map Object Elements as an Array](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-map-object-elements-as-an-array)

- [Extract Data](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-extract-data)

- [Transform XML to JSON](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-perform-basic-transformation)

- [Rename Keys](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-rename-keys)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.9/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.9/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook)

<!-- document id=fc3d42dab471117594ab9132ef6f71480e6ce5592c1f64e4a1e88b319de75e3d url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook-map-an-object.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, as
---

# Map Objects

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following DataWeave examples use the `mapObject` function to iterate through the keys and values
of objects.

## First Example

This example uses both the `map` and `mapObject` functions to iterate through the input and set all
of the keys to upper case.

The example uses these DataWeave functions:

- `map` to go through the elements in the "books" array.

- `mapObject` to go through the keys and values in each of the objects of the array.

- `upper` to set each key to upper case.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
items: payload.books map (item, index) -> {
      book: item mapObject (value, key) -> {
      (upper(key)): value
      }
}
```

Input JSON Payload:

```json
{
  "books": [
    {
      "-category": "cooking",
      "title": "Everyday Italian",
      "author": "Giada De Laurentiis",
      "year": "2005",
      "price": "30.00"
    },
    {
      "-category": "children",
      "title": "Harry Potter",
      "author": "J K. Rowling",
      "year": "2005",
      "price": "29.99"
    },
    {
      "-category": "web",
      "title": "XQuery Kick Start",
      "author": [
        "James McGovern",
        "Per Bothner",
        "Kurt Cagle",
        "James Linn",
        "Vaidyanathan Nagarajan"
      ],
      "year": "2003",
      "price": "49.99"
    },
    {
      "-category": "web",
      "-cover": "paperback",
      "title": "Learning XML",
      "author": "Erik T. Ray",
      "year": "2003",
      "price": "39.95"
    }
  ]
}
```

Output JSON:

```json
{
  "items": [
    {
      "book": {
        "-CATEGORY": "cooking",
        "TITLE": "Everyday Italian",
        "AUTHOR": "Giada De Laurentiis",
        "YEAR": "2005",
        "PRICE": "30.00"
      }
    },
    {
      "book": {
        "-CATEGORY": "children",
        "TITLE": "Harry Potter",
        "AUTHOR": "J K. Rowling",
        "YEAR": "2005",
        "PRICE": "29.99"
      }
    },
    {
      "book": {
        "-CATEGORY": "web",
        "TITLE": "XQuery Kick Start",
        "AUTHOR": [
          "James McGovern",
          "Per Bothner",
          "Kurt Cagle",
          "James Linn",
          "Vaidyanathan Nagarajan"
        ],
        "YEAR": "2003",
        "PRICE": "49.99"
      }
    },
    {
      "book": {
        "-CATEGORY": "web",
        "-COVER": "paperback",
        "TITLE": "Learning XML",
        "AUTHOR": "Erik T. Ray",
        "YEAR": "2003",
        "PRICE": "39.95"
      }
    }
  ]
}
```

## Second Example

This example uses the `mapObject` function to iterate through the keys and values of the object that
results from using `groupBy` on the payload. If some objects of the input payload have the same
values in the `FirstName`, `LastName` and `Age` keys, the DataWeave script transforms those objects
into a single row in a CSV file. The remaining values in the `Team Name` and `Role` keys for those
objects are concatenated with `:` in the single CSV row.

Input JSON Payload:

```json
[
  {
    "Sr.No.": 1,
    "FirstName": "Charles",
    "LastName": "Lock",
    "Age": 40,
    "Team Name": "Scrum team 1",
    "Role": "developer"
  },
  {
    "Sr.No.": 2,
    "FirstName": "Josh",
    "LastName": "Rodriguez",
    "Age": 45,
    "Team Name": "architecture",
    "Role": "SA"
  },
  {
    "Sr.No.": 3,
    "FirstName": "Josh",
    "LastName": "Rodriguez",
    "Age": 45,
    "Team Name": "technology",
    "Role": "advisor"
  },
  {
    "Sr.No.": 4,
    "FirstName": "Josh",
    "LastName": "Rodriguez",
    "Age": 35,
    "Team Name": "development",
    "Role": "developer"
  },
  {
    "Sr.No.": 5,
    "FirstName": "Jane",
    "LastName": "Rodriguez",
    "Age": 30,
    "Team Name": "architecture",
    "Role": "SA"
  },
  {
    "Sr.No.": 6,
    "FirstName": "Jane",
    "LastName": "Rodriguez",
    "Age": 30,
    "Team Name": "Scrum team 1",
    "Role": "developer"
  },
  {
    "Sr.No.": 7,
    "FirstName": "Josh",
    "LastName": "Lee",
    "Age": 42,
    "Team Name": "Scrum team1",
    "Role": "developer"
  }
]
```

In the previous input example, `Sr.No. 2` and `Sr.No. 3`, as well as `Sr.No. 5` and `Sr.No. 6`,
refer to the same person, as they have the same first name, last name, and age. However, `Sr.No. 4`
refers to a different person, as it has the same first and last name but a different age.

DataWeave Script:

```dataweave
output application/csv
---
valuesOf(
    payload
        groupBy ((item, index) -> (
            item.FirstName ++ item.LastName ++ item.Age))
        mapObject ((value, key, index) ->
            (index): {
                "Sr.No.": value."Sr.No." joinBy ":",
                "FirstName": value.FirstName[0],
                "LastName": value.LastName[0],
                "Age": value.Age[0],
                "Team Name": value."Team Name" joinBy ":",
                "Role": value.Role joinBy ":"
            })
)
```

The DataWeave script merges the repeated values of keys `FirstName`, `LastName` and `Age` of the
objects with key-value `Sr.No. 2` and `Sr.No. 3`, as well as `Sr.No. 5` and `Sr.No. 6`. These values
are separated with `,` in the single CSV row. The values of `Team Name` and `Role` for those objects
are concatenated with `:` in the single CSV row.

Output CSV:

```CSV
Sr.No.,FirstName,LastName,Age,Team Name,Role
1,Charles,Lock,40,Scrum team 1,developer
2:3,Josh,Rodriguez,45,architecture:technology,SA:advisor
4,Josh,Rodriguez,35,development,developer
5:6,Jane,Rodriguez,30,architecture:Scrum team 1,SA:developer
7,Josh,Lee,42,Scrum team1,developer
```

## Related Examples

- [Map Data with DataWeave](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-map)

- [Map Object Elements as an Array](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-map-object-elements-as-an-array)

- [Extract Data](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-extract-data)

- [Transform XML to JSON](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-perform-basic-transformation)

- [Rename Keys](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-rename-keys)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/latest/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook)

<!-- document id=1c6dea62cc27ec4aafe183f27dfbc088bf36ee51b686307be40b6b6b2ecc5dda url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook-map-an-object-key.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, as
---

# Map Objects Key

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example uses the `mapObject` function to iterate through an array of objects and
appends a new object that matches the value of the specified criteria.

The input consists of a JSON object with sheets. The value of every sheet (for example, `(sheet)1`,
`(sheet)2`) is an array of objects. The DataWeave script adds another object `append` as the last
item to the matched sheet array if the sheet number equals to the value of the `Id` key of the
`append` object. The example uses the function `fun extractNumber` to extract the sheet number from
the sheet page name `pageName`. Then the DataWeave function `mapObject` iterates over every sheet in
the root, and if the `extractNumber` equals to the `append.Id` value, the function adds the `append`
object to the matched sheet object.

DataWeave Script:

```dataweave
%dw 2.0
output application/json

var append =
    {
    "Id": "2",
    "Access": "4444",
    "Subteam": "1",
    }

fun extractNumber(pageName: Key) =
     (pageName as String match  /\(sheet\)([0-9]+)/)[1]
---
payload mapObject ((value, key, index) -> do {
        if(extractNumber(key) == append.Id)
            {(key): value << append}
         else
            {(key): value}
})
```

Input JSON Payload:

```json
{
  "(sheet)1": [
    {
      "Id": 1.0,
      "Team": "Mule",
      "timestamp": "2019-09-26T16:37:54",
      "Access": 12431
    }
  ],
  "(sheet)2": [
    {
      "Id": 2.0,
      "Team": "Max",
      "timestamp": "2019-09-26T16:37:54",
      "Access": 81243
    },
    {
      "Id": 2.0,
      "Team": "Max Mule",
      "timestamp": "2019-09-26T18:00:54",
      "Access": 67676
    }
  ]
}
```

Output JSON:

```json
{
  "(sheet)1": [
    {
      "Id": 1.0,
      "Team": "Mule",
      "timestamp": "2019-09-26T16:37:54",
      "Access": 12431
    }
  ],
  "(sheet)2": [
    {
      "Id": 2.0,
      "Team": "Max",
      "timestamp": "2019-09-26T16:37:54",
      "Access": 81243
    },
    {
      "Id": 2.0,
      "Team": "Max Mule",
      "timestamp": "2019-09-26T18:00:54",
      "Access": 67676
    },
    {
      "Id": "2",
      "Access": "4444",
      "Subteam": "1"
    }
  ]
}
```

## Related Examples

- [Map Data with DataWeave](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-map)

- [Map Object Elements as an Array](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-map-object-elements-as-an-array)

- [Extract Data](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-extract-data)

- [Transform XML to JSON](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-perform-basic-transformation)

- [Rename Keys](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-rename-keys)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.11/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.11/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook)

<!-- document id=b36c8e6950e6c5d43df3b2a367b4d077ffca8c80b778cb84c0cbe13754e181b4 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook-map-an-object-key.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, as
---

# Map Objects Key

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example uses the `mapObject` function to iterate through an array of objects and
appends a new object that matches the value of the specified criteria.

The input consists of a JSON object with sheets. The value of every sheet (for example, `(sheet)1`,
`(sheet)2`) is an array of objects. The DataWeave script adds another object `append` as the last
item to the matched sheet array if the sheet number equals to the value of the `Id` key of the
`append` object. The example uses the function `fun extractNumber` to extract the sheet number from
the sheet page name `pageName`. Then the DataWeave function `mapObject` iterates over every sheet in
the root, and if the `extractNumber` equals to the `append.Id` value, the function adds the `append`
object to the matched sheet object.

DataWeave Script:

```dataweave
%dw 2.0
output application/json

var append =
    {
    "Id": "2",
    "Access": "4444",
    "Subteam": "1",
    }

fun extractNumber(pageName: Key) =
     (pageName as String match  /\(sheet\)([0-9]+)/)[1]
---
payload mapObject ((value, key, index) -> do {
        if(extractNumber(key) == append.Id)
            {(key): value << append}
         else
            {(key): value}
})
```

Input JSON Payload:

```json
{
  "(sheet)1": [
    {
      "Id": 1.0,
      "Team": "Mule",
      "timestamp": "2019-09-26T16:37:54",
      "Access": 12431
    }
  ],
  "(sheet)2": [
    {
      "Id": 2.0,
      "Team": "Max",
      "timestamp": "2019-09-26T16:37:54",
      "Access": 81243
    },
    {
      "Id": 2.0,
      "Team": "Max Mule",
      "timestamp": "2019-09-26T18:00:54",
      "Access": 67676
    }
  ]
}
```

Output JSON:

```json
{
  "(sheet)1": [
    {
      "Id": 1.0,
      "Team": "Mule",
      "timestamp": "2019-09-26T16:37:54",
      "Access": 12431
    }
  ],
  "(sheet)2": [
    {
      "Id": 2.0,
      "Team": "Max",
      "timestamp": "2019-09-26T16:37:54",
      "Access": 81243
    },
    {
      "Id": 2.0,
      "Team": "Max Mule",
      "timestamp": "2019-09-26T18:00:54",
      "Access": 67676
    },
    {
      "Id": "2",
      "Access": "4444",
      "Subteam": "1"
    }
  ]
}
```

## Related Examples

- [Map Data with DataWeave](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-map)

- [Map Object Elements as an Array](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-map-object-elements-as-an-array)

- [Extract Data](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-extract-data)

- [Transform XML to JSON](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-perform-basic-transformation)

- [Rename Keys](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-rename-keys)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.12/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.12/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook)

<!-- document id=c485716978aa0fefb27c2c1225f5674837b9751af5e3ffb92acea571092489f8 url=/mulesoft/current/en-us/dataweave/2.3/dataweave-cookbook-map-an-object-key.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, as
---

# Map Objects Key

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example uses the `mapObject` function to iterate through an array of objects and
appends a new object that matches the value of the specified criteria.

The input consists of a JSON object with sheets. The value of every sheet (for example, `(sheet)1`,
`(sheet)2`) is an array of objects. The DataWeave script adds another object `append` as the last
item to the matched sheet array if the sheet number equals to the value of the `Id` key of the
`append` object. The example uses the function `fun extractNumber` to extract the sheet number from
the sheet page name `pageName`. Then the DataWeave function `mapObject` iterates over every sheet in
the root, and if the `extractNumber` equals to the `append.Id` value, the function adds the `append`
object to the matched sheet object.

DataWeave Script:

```dataweave
%dw 2.0
output application/json

var append =
    {
    "Id": "2",
    "Access": "4444",
    "Subteam": "1",
    }

fun extractNumber(pageName: Key) =
     (pageName as String match  /\(sheet\)([0-9]+)/)[1]
---
payload mapObject ((value, key, index) -> do {
        if(extractNumber(key) == append.Id)
            {(key): value << append}
         else
            {(key): value}
})
```

Input JSON Payload:

```json
{
  "(sheet)1": [
    {
      "Id": 1.0,
      "Team": "Mule",
      "timestamp": "2019-09-26T16:37:54",
      "Access": 12431
    }
  ],
  "(sheet)2": [
    {
      "Id": 2.0,
      "Team": "Max",
      "timestamp": "2019-09-26T16:37:54",
      "Access": 81243
    },
    {
      "Id": 2.0,
      "Team": "Max Mule",
      "timestamp": "2019-09-26T18:00:54",
      "Access": 67676
    }
  ]
}
```

Output JSON:

```json
{
  "(sheet)1": [
    {
      "Id": 1.0,
      "Team": "Mule",
      "timestamp": "2019-09-26T16:37:54",
      "Access": 12431
    }
  ],
  "(sheet)2": [
    {
      "Id": 2.0,
      "Team": "Max",
      "timestamp": "2019-09-26T16:37:54",
      "Access": 81243
    },
    {
      "Id": 2.0,
      "Team": "Max Mule",
      "timestamp": "2019-09-26T18:00:54",
      "Access": 67676
    },
    {
      "Id": "2",
      "Access": "4444",
      "Subteam": "1"
    }
  ]
}
```

## Related Examples

- [Map Data with DataWeave](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-map)

- [Map Object Elements as an Array](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-map-object-elements-as-an-array)

- [Extract Data](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-extract-data)

- [Transform XML to JSON](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-perform-basic-transformation)

- [Rename Keys](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-rename-keys)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.3/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.3/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook)

<!-- document id=4c0b1cf3ca9b25c44a4eff22c84aa588b5e541d009197205cd308b1a39922d93 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook-map-an-object-key.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, as
---

# Map Objects Key

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example uses the `mapObject` function to iterate through an array of objects and
appends a new object that matches the value of the specified criteria.

The input consists of a JSON object with sheets. The value of every sheet (for example, `(sheet)1`,
`(sheet)2`) is an array of objects. The DataWeave script adds another object `append` as the last
item to the matched sheet array if the sheet number equals to the value of the `Id` key of the
`append` object. The example uses the function `fun extractNumber` to extract the sheet number from
the sheet page name `pageName`. Then the DataWeave function `mapObject` iterates over every sheet in
the root, and if the `extractNumber` equals to the `append.Id` value, the function adds the `append`
object to the matched sheet object.

DataWeave Script:

```dataweave
%dw 2.0
output application/json

var append =
    {
    "Id": "2",
    "Access": "4444",
    "Subteam": "1",
    }

fun extractNumber(pageName: Key) =
     (pageName as String match  /\(sheet\)([0-9]+)/)[1]
---
payload mapObject ((value, key, index) -> do {
        if(extractNumber(key) == append.Id)
            {(key): value << append}
         else
            {(key): value}
})
```

Input JSON Payload:

```json
{
  "(sheet)1": [
    {
      "Id": 1.0,
      "Team": "Mule",
      "timestamp": "2019-09-26T16:37:54",
      "Access": 12431
    }
  ],
  "(sheet)2": [
    {
      "Id": 2.0,
      "Team": "Max",
      "timestamp": "2019-09-26T16:37:54",
      "Access": 81243
    },
    {
      "Id": 2.0,
      "Team": "Max Mule",
      "timestamp": "2019-09-26T18:00:54",
      "Access": 67676
    }
  ]
}
```

Output JSON:

```json
{
  "(sheet)1": [
    {
      "Id": 1.0,
      "Team": "Mule",
      "timestamp": "2019-09-26T16:37:54",
      "Access": 12431
    }
  ],
  "(sheet)2": [
    {
      "Id": 2.0,
      "Team": "Max",
      "timestamp": "2019-09-26T16:37:54",
      "Access": 81243
    },
    {
      "Id": 2.0,
      "Team": "Max Mule",
      "timestamp": "2019-09-26T18:00:54",
      "Access": 67676
    },
    {
      "Id": "2",
      "Access": "4444",
      "Subteam": "1"
    }
  ]
}
```

## Related Examples

- [Map Data with DataWeave](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-map)

- [Map Object Elements as an Array](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-map-object-elements-as-an-array)

- [Extract Data](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-extract-data)

- [Transform XML to JSON](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-perform-basic-transformation)

- [Rename Keys](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-rename-keys)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.4/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.4/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook)

<!-- document id=5de6a1de65d4368945172656b9c41d3198b8b881bba4a941b80640c0d291e2ad url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook-map-an-object-key.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, as
---

# Map Objects Key

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example uses the `mapObject` function to iterate through an array of objects and
appends a new object that matches the value of the specified criteria.

The input consists of a JSON object with sheets. The value of every sheet (for example, `(sheet)1`,
`(sheet)2`) is an array of objects. The DataWeave script adds another object `append` as the last
item to the matched sheet array if the sheet number equals to the value of the `Id` key of the
`append` object. The example uses the function `fun extractNumber` to extract the sheet number from
the sheet page name `pageName`. Then the DataWeave function `mapObject` iterates over every sheet in
the root, and if the `extractNumber` equals to the `append.Id` value, the function adds the `append`
object to the matched sheet object.

DataWeave Script:

```dataweave
%dw 2.0
output application/json

var append =
    {
    "Id": "2",
    "Access": "4444",
    "Subteam": "1",
    }

fun extractNumber(pageName: Key) =
     (pageName as String match  /\(sheet\)([0-9]+)/)[1]
---
payload mapObject ((value, key, index) -> do {
        if(extractNumber(key) == append.Id)
            {(key): value << append}
         else
            {(key): value}
})
```

Input JSON Payload:

```json
{
  "(sheet)1": [
    {
      "Id": 1.0,
      "Team": "Mule",
      "timestamp": "2019-09-26T16:37:54",
      "Access": 12431
    }
  ],
  "(sheet)2": [
    {
      "Id": 2.0,
      "Team": "Max",
      "timestamp": "2019-09-26T16:37:54",
      "Access": 81243
    },
    {
      "Id": 2.0,
      "Team": "Max Mule",
      "timestamp": "2019-09-26T18:00:54",
      "Access": 67676
    }
  ]
}
```

Output JSON:

```json
{
  "(sheet)1": [
    {
      "Id": 1.0,
      "Team": "Mule",
      "timestamp": "2019-09-26T16:37:54",
      "Access": 12431
    }
  ],
  "(sheet)2": [
    {
      "Id": 2.0,
      "Team": "Max",
      "timestamp": "2019-09-26T16:37:54",
      "Access": 81243
    },
    {
      "Id": 2.0,
      "Team": "Max Mule",
      "timestamp": "2019-09-26T18:00:54",
      "Access": 67676
    },
    {
      "Id": "2",
      "Access": "4444",
      "Subteam": "1"
    }
  ]
}
```

## Related Examples

- [Map Data with DataWeave](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-map)

- [Map Object Elements as an Array](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-map-object-elements-as-an-array)

- [Extract Data](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-extract-data)

- [Transform XML to JSON](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-perform-basic-transformation)

- [Rename Keys](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-rename-keys)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.6/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.6/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook)

<!-- document id=d25c581e55b2c7b887610d0cc090ea272f9c64cc197e6b7251a42e1335ae077e url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook-map-an-object-key.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, as
---

# Map Objects Key

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example uses the `mapObject` function to iterate through an array of objects and
appends a new object that matches the value of the specified criteria.

The input consists of a JSON object with sheets. The value of every sheet (for example, `(sheet)1`,
`(sheet)2`) is an array of objects. The DataWeave script adds another object `append` as the last
item to the matched sheet array if the sheet number equals to the value of the `Id` key of the
`append` object. The example uses the function `fun extractNumber` to extract the sheet number from
the sheet page name `pageName`. Then the DataWeave function `mapObject` iterates over every sheet in
the root, and if the `extractNumber` equals to the `append.Id` value, the function adds the `append`
object to the matched sheet object.

DataWeave Script:

```dataweave
%dw 2.0
output application/json

var append =
    {
    "Id": "2",
    "Access": "4444",
    "Subteam": "1",
    }

fun extractNumber(pageName: Key) =
     (pageName as String match  /\(sheet\)([0-9]+)/)[1]
---
payload mapObject ((value, key, index) -> do {
        if(extractNumber(key) == append.Id)
            {(key): value << append}
         else
            {(key): value}
})
```

Input JSON Payload:

```json
{
  "(sheet)1": [
    {
      "Id": 1.0,
      "Team": "Mule",
      "timestamp": "2019-09-26T16:37:54",
      "Access": 12431
    }
  ],
  "(sheet)2": [
    {
      "Id": 2.0,
      "Team": "Max",
      "timestamp": "2019-09-26T16:37:54",
      "Access": 81243
    },
    {
      "Id": 2.0,
      "Team": "Max Mule",
      "timestamp": "2019-09-26T18:00:54",
      "Access": 67676
    }
  ]
}
```

Output JSON:

```json
{
  "(sheet)1": [
    {
      "Id": 1.0,
      "Team": "Mule",
      "timestamp": "2019-09-26T16:37:54",
      "Access": 12431
    }
  ],
  "(sheet)2": [
    {
      "Id": 2.0,
      "Team": "Max",
      "timestamp": "2019-09-26T16:37:54",
      "Access": 81243
    },
    {
      "Id": 2.0,
      "Team": "Max Mule",
      "timestamp": "2019-09-26T18:00:54",
      "Access": 67676
    },
    {
      "Id": "2",
      "Access": "4444",
      "Subteam": "1"
    }
  ]
}
```

## Related Examples

- [Map Data with DataWeave](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-map)

- [Map Object Elements as an Array](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-map-object-elements-as-an-array)

- [Extract Data](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-extract-data)

- [Transform XML to JSON](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-perform-basic-transformation)

- [Rename Keys](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-rename-keys)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.9/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.9/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook)

<!-- document id=c2304c30e77e48eac1b49d926ff6c6412941ffac96fdb6f8dabd6cf464dd8ec8 url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook-map-an-object-key.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, as
---

# Map Objects Key

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example uses the `mapObject` function to iterate through an array of objects and
appends a new object that matches the value of the specified criteria.

The input consists of a JSON object with sheets. The value of every sheet (for example, `(sheet)1`,
`(sheet)2`) is an array of objects. The DataWeave script adds another object `append` as the last
item to the matched sheet array if the sheet number equals to the value of the `Id` key of the
`append` object. The example uses the function `fun extractNumber` to extract the sheet number from
the sheet page name `pageName`. Then the DataWeave function `mapObject` iterates over every sheet in
the root, and if the `extractNumber` equals to the `append.Id` value, the function adds the `append`
object to the matched sheet object.

DataWeave Script:

```dataweave
%dw 2.0
output application/json

var append =
    {
    "Id": "2",
    "Access": "4444",
    "Subteam": "1",
    }

fun extractNumber(pageName: Key) =
     (pageName as String match  /\(sheet\)([0-9]+)/)[1]
---
payload mapObject ((value, key, index) -> do {
        if(extractNumber(key) == append.Id)
            {(key): value << append}
         else
            {(key): value}
})
```

Input JSON Payload:

```json
{
  "(sheet)1": [
    {
      "Id": 1.0,
      "Team": "Mule",
      "timestamp": "2019-09-26T16:37:54",
      "Access": 12431
    }
  ],
  "(sheet)2": [
    {
      "Id": 2.0,
      "Team": "Max",
      "timestamp": "2019-09-26T16:37:54",
      "Access": 81243
    },
    {
      "Id": 2.0,
      "Team": "Max Mule",
      "timestamp": "2019-09-26T18:00:54",
      "Access": 67676
    }
  ]
}
```

Output JSON:

```json
{
  "(sheet)1": [
    {
      "Id": 1.0,
      "Team": "Mule",
      "timestamp": "2019-09-26T16:37:54",
      "Access": 12431
    }
  ],
  "(sheet)2": [
    {
      "Id": 2.0,
      "Team": "Max",
      "timestamp": "2019-09-26T16:37:54",
      "Access": 81243
    },
    {
      "Id": 2.0,
      "Team": "Max Mule",
      "timestamp": "2019-09-26T18:00:54",
      "Access": 67676
    },
    {
      "Id": "2",
      "Access": "4444",
      "Subteam": "1"
    }
  ]
}
```

## Related Examples

- [Map Data with DataWeave](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-map)

- [Map Object Elements as an Array](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-map-object-elements-as-an-array)

- [Extract Data](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-extract-data)

- [Transform XML to JSON](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-perform-basic-transformation)

- [Rename Keys](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-rename-keys)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/latest/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook)

<!-- document id=4b2f29e2b140058e4d6b657a3f08a64183fa9cd65f700bdac735f4632e05fe4c url=/mulesoft/current/en-us/dataweave/2.11/dw-tree-functions-mapleafvalues.md -->

---
product: DataWeave
version: 2.11
---

# mapLeafValues

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## mapLeafValues(value: Any, callback: (value: Any, path: Path) -> Any): Any

Maps the terminal (leaf) nodes in the tree.

Leafs nodes cannot have an object or an array as a value.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The value to map.</p></td></tr><tr><td><p><code>callback</code></p></td><td><p>The mapper function.</p></td></tr></tbody></table>

### Example

This example transforms all the string values to upper case.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
output application/json
---
 {
     user: [{
         name: "mariano",
         lastName: "achaval"
     }],
     group: "data-weave"
 } mapLeafValues (value, path) -> upper(value)
```

#### Output

```Json
{
   "user": [
     {
       "name": "MARIANO",
       "lastName": "ACHAVAL"
     }
   ],
   "group": "DATA-WEAVE"
 }
```

### Example

This example returns a new value for an object, array, or attribute.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::util::Tree
---
{
    name: "Mariano",
    test: [1,2,3]
} mapLeafValues ((value, path) -> if(isObjectType(path))
                                        "***"
                                  else if(isArrayType(path))
                                        "In an array"
                                  else "Is an attribute")
```

#### Output

```Json
{
  "name": "***",
  "test": [
    "In an array",
    "In an array",
    "In an array"
  ]
}
```

<!-- document id=d87bf0926d83b931f3c30992ec1a3aed7153b8605440897f95f37c7c5969e9a0 url=/mulesoft/current/en-us/dataweave/2.12/dw-tree-functions-mapleafvalues.md -->

---
product: DataWeave
version: 2.12
---

# mapLeafValues

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## mapLeafValues(value: Any, callback: (value: Any, path: Path) -> Any): Any

Maps the terminal (leaf) nodes in the tree.

Leafs nodes cannot have an object or an array as a value.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The value to map.</p></td></tr><tr><td><p><code>callback</code></p></td><td><p>The mapper function.</p></td></tr></tbody></table>

### Example

This example transforms all the string values to upper case.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
output application/json
---
 {
     user: [{
         name: "mariano",
         lastName: "achaval"
     }],
     group: "data-weave"
 } mapLeafValues (value, path) -> upper(value)
```

#### Output

```Json
{
   "user": [
     {
       "name": "MARIANO",
       "lastName": "ACHAVAL"
     }
   ],
   "group": "DATA-WEAVE"
 }
```

### Example

This example returns a new value for an object, array, or attribute.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::util::Tree
---
{
    name: "Mariano",
    test: [1,2,3]
} mapLeafValues ((value, path) -> if(isObjectType(path))
                                        "***"
                                  else if(isArrayType(path))
                                        "In an array"
                                  else "Is an attribute")
```

#### Output

```Json
{
  "name": "***",
  "test": [
    "In an array",
    "In an array",
    "In an array"
  ]
}
```

<!-- document id=ea802d1f30d46bb2ff73fabf4624da1c0d5b1da5d26401da333bd49931a307ca url=/mulesoft/current/en-us/dataweave/2.3/dw-tree-functions-mapleafvalues.md -->

---
product: DataWeave
version: 2.3
---

# mapLeafValues

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## mapLeafValues(Any, (value: Any, path: Path) -> Any): Any

Maps the terminal (leaf) nodes in the tree.

Leafs nodes cannot have an object or an array as a value.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The value to map.</p></td></tr><tr><td><p><code>callback</code></p></td><td><p>The mapper function.</p></td></tr></tbody></table>

### Example

This example transforms all the string values to upper case.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
output application/json
---
 {
     user: [{
         name: "mariano",
         lastName: "achaval"
     }],
     group: "data-weave"
 } mapLeafValues (value, path) -> upper(value)
```

#### Output

```Json
{
   "user": [
     {
       "name": "MARIANO",
       "lastName": "ACHAVAL"
     }
   ],
   "group": "DATA-WEAVE"
 }
```

<!-- document id=24bb1c0443df12ac257801fe766819542a26f51e060e9691adcb464983dfe55c url=/mulesoft/current/en-us/dataweave/2.4/dw-tree-functions-mapleafvalues.md -->

---
product: DataWeave
version: 2.4
---

# mapLeafValues

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## mapLeafValues(value: Any, callback: (value: Any, path: Path) -> Any): Any

Maps the terminal (leaf) nodes in the tree.

Leafs nodes cannot have an object or an array as a value.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The value to map.</p></td></tr><tr><td><p><code>callback</code></p></td><td><p>The mapper function.</p></td></tr></tbody></table>

### Example

This example transforms all the string values to upper case.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
output application/json
---
 {
     user: [{
         name: "mariano",
         lastName: "achaval"
     }],
     group: "data-weave"
 } mapLeafValues (value, path) -> upper(value)
```

#### Output

```Json
{
   "user": [
     {
       "name": "MARIANO",
       "lastName": "ACHAVAL"
     }
   ],
   "group": "DATA-WEAVE"
 }
```

### Example

This example returns a new value for an object, array, or attribute.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::util::Tree
---
{
    name: "Mariano",
    test: [1,2,3]
} mapLeafValues ((value, path) -> if(isObjectType(path))
                                        "***"
                                  else if(isArrayType(path))
                                        "In an array"
                                  else "Is an attribute")
```

#### Output

```Json
{
  "name": "***",
  "test": [
    "In an array",
    "In an array",
    "In an array"
  ]
}
```

<!-- document id=cd6d85f727507c7772f03cbbd22222c7d8149bb787273b505d74c8bfc4250c7e url=/mulesoft/current/en-us/dataweave/2.6/dw-tree-functions-mapleafvalues.md -->

---
product: DataWeave
version: 2.6
---

# mapLeafValues

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## mapLeafValues(value: Any, callback: (value: Any, path: Path) -> Any): Any

Maps the terminal (leaf) nodes in the tree.

Leafs nodes cannot have an object or an array as a value.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The value to map.</p></td></tr><tr><td><p><code>callback</code></p></td><td><p>The mapper function.</p></td></tr></tbody></table>

### Example

This example transforms all the string values to upper case.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
output application/json
---
 {
     user: [{
         name: "mariano",
         lastName: "achaval"
     }],
     group: "data-weave"
 } mapLeafValues (value, path) -> upper(value)
```

#### Output

```Json
{
   "user": [
     {
       "name": "MARIANO",
       "lastName": "ACHAVAL"
     }
   ],
   "group": "DATA-WEAVE"
 }
```

### Example

This example returns a new value for an object, array, or attribute.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::util::Tree
---
{
    name: "Mariano",
    test: [1,2,3]
} mapLeafValues ((value, path) -> if(isObjectType(path))
                                        "***"
                                  else if(isArrayType(path))
                                        "In an array"
                                  else "Is an attribute")
```

#### Output

```Json
{
  "name": "***",
  "test": [
    "In an array",
    "In an array",
    "In an array"
  ]
}
```

<!-- document id=a479d66822278fb37ac0096afcb85f7a8d0effd098a24d4c2e561f0e08afd22f url=/mulesoft/current/en-us/dataweave/2.9/dw-tree-functions-mapleafvalues.md -->

---
product: DataWeave
version: 2.9
---

# mapLeafValues

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## mapLeafValues(value: Any, callback: (value: Any, path: Path) -> Any): Any

Maps the terminal (leaf) nodes in the tree.

Leafs nodes cannot have an object or an array as a value.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The value to map.</p></td></tr><tr><td><p><code>callback</code></p></td><td><p>The mapper function.</p></td></tr></tbody></table>

### Example

This example transforms all the string values to upper case.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
output application/json
---
 {
     user: [{
         name: "mariano",
         lastName: "achaval"
     }],
     group: "data-weave"
 } mapLeafValues (value, path) -> upper(value)
```

#### Output

```Json
{
   "user": [
     {
       "name": "MARIANO",
       "lastName": "ACHAVAL"
     }
   ],
   "group": "DATA-WEAVE"
 }
```

### Example

This example returns a new value for an object, array, or attribute.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::util::Tree
---
{
    name: "Mariano",
    test: [1,2,3]
} mapLeafValues ((value, path) -> if(isObjectType(path))
                                        "***"
                                  else if(isArrayType(path))
                                        "In an array"
                                  else "Is an attribute")
```

#### Output

```Json
{
  "name": "***",
  "test": [
    "In an array",
    "In an array",
    "In an array"
  ]
}
```

<!-- document id=714fe4b71ba43a98968fb75d053b0c927a4179aac51a4887448778e35913d5cb url=/mulesoft/current/en-us/dataweave/latest/dw-tree-functions-mapleafvalues.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# mapLeafValues

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## mapLeafValues(value: Any, callback: (value: Any, path: Path) -> Any): Any

Maps the terminal (leaf) nodes in the tree.

Leafs nodes cannot have an object or an array as a value.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The value to map.</p></td></tr><tr><td><p><code>callback</code></p></td><td><p>The mapper function.</p></td></tr></tbody></table>

### Example

This example transforms all the string values to upper case.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
output application/json
---
 {
     user: [{
         name: "mariano",
         lastName: "achaval"
     }],
     group: "data-weave"
 } mapLeafValues (value, path) -> upper(value)
```

#### Output

```Json
{
   "user": [
     {
       "name": "MARIANO",
       "lastName": "ACHAVAL"
     }
   ],
   "group": "DATA-WEAVE"
 }
```

### Example

This example returns a new value for an object, array, or attribute.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::util::Tree
---
{
    name: "Mariano",
    test: [1,2,3]
} mapLeafValues ((value, path) -> if(isObjectType(path))
                                        "***"
                                  else if(isArrayType(path))
                                        "In an array"
                                  else "Is an attribute")
```

#### Output

```Json
{
  "name": "***",
  "test": [
    "In an array",
    "In an array",
    "In an array"
  ]
}
```

<!-- document id=5b0a465b3f5aeb84b22c1988726cdbe1d0c910149eb7ee2f11e24cbe5e1be1d0 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-mapobject.md -->

---
product: DataWeave
version: 2.11
---

# mapObject

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## mapObject<K, V>(@StreamCapable object: { (K)?: V }, mapper: (value: V, key: K, index: Number) -> Object): Object

Iterates over an object using a mapper that acts on keys, values, or indices of that object.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object to map.</p></td></tr><tr><td><p><code>mapper</code></p></td><td><p>Expression or selector that provides the <code>key</code>, <code>value</code>, or <code>index</code> used for mapping the specified object into an output object.</p></td></tr></tbody></table>

### Example

This example iterates over the input `{ "a":"b","c":"d"}` and uses the anonymous mapper function
(`(value,key,index) → { (index) : { (value):key} }`) to invert the keys and values in each specified
object and to return the indices of the objects as keys. The mapper uses named parameters to
identify the keys, values, and indices of the input object. Note that you can write the same
expression using anonymous parameters, like this:
`{"a":"b","c":"d"} mapObject { ($$$) : { ($):$$} }`

#### Source

```DataWeave
%dw 2.0
output application/json
---
{"a":"b","c":"d"} mapObject (value,key,index) -> { (index) : { (value):key} }
```

#### Output

```JSON
{ "0": { "b": "a" }, "1": { "d": "c" } }
```

### Example

This example increases each price by 5 and formats the numbers to always include 2 decimals.

#### Source

```DataWeave
%dw 2.0
output application/xml
---
{
    prices: payload.prices mapObject (value, key) -> {
        (key): (value + 5) as Number {format: "##.00"}
    }
}
```

#### Input

```XML
<?xml version='1.0' encoding='UTF-8'?>
<prices>
    <basic>9.99</basic>
    <premium>53</premium>
    <vip>398.99</vip>
</prices>
```

#### Output

```XML
<?xml version='1.0' encoding='UTF-8'?>
<prices>
  <basic>14.99</basic>
  <premium>58.00</premium>
  <vip>403.99</vip>
</prices>
```

## mapObject(value: Null, mapper: (value: Nothing, key: Nothing, index: Nothing) -> Any): Null

Helper function that enables `mapObject` to work with a `null` value.

### Example

Using the previous example, you can test that if the input of the `mapObject` is `null`, the output
result is `null` as well. In XML `null` values are written as empty tags. You can change these
values by using the writer property `writeNilOnNull=true`.

#### Input

```XML
<?xml version='1.0' encoding='UTF-8'?>
<prices>
</prices>
```

#### Output

```XML
<?xml version='1.0' encoding='UTF-8'?>
<prices>
</prices>
```

<!-- document id=1e467ae3f7ba5459fbb87066cc1d2f3e2efb572cdd0ec0947b23fff54dc18879 url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-mapobject.md -->

---
product: DataWeave
version: 2.12
---

# mapObject

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## mapObject<K, V>(@StreamCapable object: { (K)?: V }, mapper: (value: V, key: K, index: Number) -> Object): Object

Iterates over an object using a mapper that acts on keys, values, or indices of that object.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object to map.</p></td></tr><tr><td><p><code>mapper</code></p></td><td><p>Expression or selector that provides the <code>key</code>, <code>value</code>, or <code>index</code> used for mapping the specified object into an output object.</p></td></tr></tbody></table>

### Example

This example iterates over the input `{ "a":"b","c":"d"}` and uses the anonymous mapper function
(`(value,key,index) → { (index) : { (value):key} }`) to invert the keys and values in each specified
object and to return the indices of the objects as keys. The mapper uses named parameters to
identify the keys, values, and indices of the input object. Note that you can write the same
expression using anonymous parameters, like this:
`{"a":"b","c":"d"} mapObject { ($$$) : { ($):$$} }`

#### Source

```DataWeave
%dw 2.0
output application/json
---
{"a":"b","c":"d"} mapObject (value,key,index) -> { (index) : { (value):key} }
```

#### Output

```JSON
{ "0": { "b": "a" }, "1": { "d": "c" } }
```

### Example

This example increases each price by 5 and formats the numbers to always include 2 decimals.

#### Source

```DataWeave
%dw 2.0
output application/xml
---
{
    prices: payload.prices mapObject (value, key) -> {
        (key): (value + 5) as Number {format: "##.00"}
    }
}
```

#### Input

```XML
<?xml version='1.0' encoding='UTF-8'?>
<prices>
    <basic>9.99</basic>
    <premium>53</premium>
    <vip>398.99</vip>
</prices>
```

#### Output

```XML
<?xml version='1.0' encoding='UTF-8'?>
<prices>
  <basic>14.99</basic>
  <premium>58.00</premium>
  <vip>403.99</vip>
</prices>
```

## mapObject(value: Null, mapper: (value: Nothing, key: Nothing, index: Nothing) -> Any): Null

Helper function that enables `mapObject` to work with a `null` value.

### Example

Using the previous example, you can test that if the input of the `mapObject` is `null`, the output
result is `null` as well. In XML `null` values are written as empty tags. You can change these
values by using the writer property `writeNilOnNull=true`.

#### Input

```XML
<?xml version='1.0' encoding='UTF-8'?>
<prices>
</prices>
```

#### Output

```XML
<?xml version='1.0' encoding='UTF-8'?>
<prices>
</prices>
```

<!-- document id=2f128fd854fa12516f4a881822060194bb2cba36fac0fbd4ddd16c38b33a821b url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-mapobject.md -->

---
product: DataWeave
version: 2.3
---

# mapObject

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## mapObject({ (K)?: V }, (value: V, key: K, index: Number) -> Object): Object

Iterates over an object using a mapper that acts on keys, values, or indices of that object.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object to map.</p></td></tr><tr><td><p><code>mapper</code></p></td><td><p>Expression or selector that provides the <code>key</code>, <code>value</code>, or <code>index</code> used for mapping the specified object into an output object.</p></td></tr></tbody></table>

### Example

This example iterates over the input `{ "a":"b","c":"d"}` and uses the anonymous mapper function
(`(value,key,index) → { (index) : { (value):key} }`) to invert the keys and values in each specified
object and to return the indices of the objects as keys. The mapper uses named parameters to
identify the keys, values, and indices of the input object. Note that you can write the same
expression using anonymous parameters, like this:
`{"a":"b","c":"d"} mapObject { ($$$) : { ($):$$} }`

#### Source

```DataWeave
%dw 2.0
output application/json
---
{"a":"b","c":"d"} mapObject (value,key,index) -> { (index) : { (value):key} }
```

#### Output

```JSON
{ "0": { "b": "a" }, "1": { "d": "c" } }
```

### Example

This example increases each price by 5 and formats the numbers to always include 2 decimals.

#### Source

```DataWeave
%dw 2.0
output application/xml
---
{
    prices: payload.prices mapObject (value, key) -> {
        (key): (value + 5) as Number {format: "##.00"}
    }
}
```

#### Input

```XML
<?xml version='1.0' encoding='UTF-8'?>
<prices>
    <basic>9.99</basic>
    <premium>53</premium>
    <vip>398.99</vip>
</prices>
```

#### Output

```XML
<?xml version='1.0' encoding='UTF-8'?>
<prices>
  <basic>14.99</basic>
  <premium>58.00</premium>
  <vip>403.99</vip>
</prices>
```

## mapObject(Null, (value: Nothing, key: Nothing, index: Nothing) -> Any): Null

Helper function that enables `mapObject` to work with a `null` value.

### Example

Using the previous example, you can test that if the input of the `mapObject` is `null`, the output
result is `null` as well. In XML `null` values are written as empty tags. You can change these
values by using the writer property `writeNilOnNull=true`.

#### Input

```XML
<?xml version='1.0' encoding='UTF-8'?>
<prices>
</prices>
```

#### Output

```XML
<?xml version='1.0' encoding='UTF-8'?>
<prices>
</prices>
```

<!-- document id=899d067ff24cec2170e26fd3fe1567ff8a83ec8c10d4ce6fa59aadc6e3076e58 url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-mapobject.md -->

---
product: DataWeave
version: 2.4
---

# mapObject

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## mapObject<K, V>(@StreamCapable object: { (K)?: V }, mapper: (value: V, key: K, index: Number) -> Object): Object

Iterates over an object using a mapper that acts on keys, values, or indices of that object.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object to map.</p></td></tr><tr><td><p><code>mapper</code></p></td><td><p>Expression or selector that provides the <code>key</code>, <code>value</code>, or <code>index</code> used for mapping the specified object into an output object.</p></td></tr></tbody></table>

### Example

This example iterates over the input `{ "a":"b","c":"d"}` and uses the anonymous mapper function
(`(value,key,index) → { (index) : { (value):key} }`) to invert the keys and values in each specified
object and to return the indices of the objects as keys. The mapper uses named parameters to
identify the keys, values, and indices of the input object. Note that you can write the same
expression using anonymous parameters, like this:
`{"a":"b","c":"d"} mapObject { ($$$) : { ($):$$} }`

#### Source

```DataWeave
%dw 2.0
output application/json
---
{"a":"b","c":"d"} mapObject (value,key,index) -> { (index) : { (value):key} }
```

#### Output

```JSON
{ "0": { "b": "a" }, "1": { "d": "c" } }
```

### Example

This example increases each price by 5 and formats the numbers to always include 2 decimals.

#### Source

```DataWeave
%dw 2.0
output application/xml
---
{
    prices: payload.prices mapObject (value, key) -> {
        (key): (value + 5) as Number {format: "##.00"}
    }
}
```

#### Input

```XML
<?xml version='1.0' encoding='UTF-8'?>
<prices>
    <basic>9.99</basic>
    <premium>53</premium>
    <vip>398.99</vip>
</prices>
```

#### Output

```XML
<?xml version='1.0' encoding='UTF-8'?>
<prices>
  <basic>14.99</basic>
  <premium>58.00</premium>
  <vip>403.99</vip>
</prices>
```

## mapObject(value: Null, mapper: (value: Nothing, key: Nothing, index: Nothing) -> Any): Null

Helper function that enables `mapObject` to work with a `null` value.

### Example

Using the previous example, you can test that if the input of the `mapObject` is `null`, the output
result is `null` as well. In XML `null` values are written as empty tags. You can change these
values by using the writer property `writeNilOnNull=true`.

#### Input

```XML
<?xml version='1.0' encoding='UTF-8'?>
<prices>
</prices>
```

#### Output

```XML
<?xml version='1.0' encoding='UTF-8'?>
<prices>
</prices>
```

<!-- document id=b62d5474d601fbd1d8214dc0b62aeb2819aaa8daf4e8e14a718da0d6a3cd27b3 url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-mapobject.md -->

---
product: DataWeave
version: 2.6
---

# mapObject

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## mapObject<K, V>(@StreamCapable object: { (K)?: V }, mapper: (value: V, key: K, index: Number) -> Object): Object

Iterates over an object using a mapper that acts on keys, values, or indices of that object.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object to map.</p></td></tr><tr><td><p><code>mapper</code></p></td><td><p>Expression or selector that provides the <code>key</code>, <code>value</code>, or <code>index</code> used for mapping the specified object into an output object.</p></td></tr></tbody></table>

### Example

This example iterates over the input `{ "a":"b","c":"d"}` and uses the anonymous mapper function
(`(value,key,index) → { (index) : { (value):key} }`) to invert the keys and values in each specified
object and to return the indices of the objects as keys. The mapper uses named parameters to
identify the keys, values, and indices of the input object. Note that you can write the same
expression using anonymous parameters, like this:
`{"a":"b","c":"d"} mapObject { ($$$) : { ($):$$} }`

#### Source

```DataWeave
%dw 2.0
output application/json
---
{"a":"b","c":"d"} mapObject (value,key,index) -> { (index) : { (value):key} }
```

#### Output

```JSON
{ "0": { "b": "a" }, "1": { "d": "c" } }
```

### Example

This example increases each price by 5 and formats the numbers to always include 2 decimals.

#### Source

```DataWeave
%dw 2.0
output application/xml
---
{
    prices: payload.prices mapObject (value, key) -> {
        (key): (value + 5) as Number {format: "##.00"}
    }
}
```

#### Input

```XML
<?xml version='1.0' encoding='UTF-8'?>
<prices>
    <basic>9.99</basic>
    <premium>53</premium>
    <vip>398.99</vip>
</prices>
```

#### Output

```XML
<?xml version='1.0' encoding='UTF-8'?>
<prices>
  <basic>14.99</basic>
  <premium>58.00</premium>
  <vip>403.99</vip>
</prices>
```

## mapObject(value: Null, mapper: (value: Nothing, key: Nothing, index: Nothing) -> Any): Null

Helper function that enables `mapObject` to work with a `null` value.

### Example

Using the previous example, you can test that if the input of the `mapObject` is `null`, the output
result is `null` as well. In XML `null` values are written as empty tags. You can change these
values by using the writer property `writeNilOnNull=true`.

#### Input

```XML
<?xml version='1.0' encoding='UTF-8'?>
<prices>
</prices>
```

#### Output

```XML
<?xml version='1.0' encoding='UTF-8'?>
<prices>
</prices>
```

<!-- document id=d42bea73aa6751cfd0e51ed127153f86aa4ed8a2dd1c6cce78f272132d003fc9 url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-mapobject.md -->

---
product: DataWeave
version: 2.9
---

# mapObject

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## mapObject<K, V>(@StreamCapable object: { (K)?: V }, mapper: (value: V, key: K, index: Number) -> Object): Object

Iterates over an object using a mapper that acts on keys, values, or indices of that object.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object to map.</p></td></tr><tr><td><p><code>mapper</code></p></td><td><p>Expression or selector that provides the <code>key</code>, <code>value</code>, or <code>index</code> used for mapping the specified object into an output object.</p></td></tr></tbody></table>

### Example

This example iterates over the input `{ "a":"b","c":"d"}` and uses the anonymous mapper function
(`(value,key,index) → { (index) : { (value):key} }`) to invert the keys and values in each specified
object and to return the indices of the objects as keys. The mapper uses named parameters to
identify the keys, values, and indices of the input object. Note that you can write the same
expression using anonymous parameters, like this:
`{"a":"b","c":"d"} mapObject { ($$$) : { ($):$$} }`

#### Source

```DataWeave
%dw 2.0
output application/json
---
{"a":"b","c":"d"} mapObject (value,key,index) -> { (index) : { (value):key} }
```

#### Output

```JSON
{ "0": { "b": "a" }, "1": { "d": "c" } }
```

### Example

This example increases each price by 5 and formats the numbers to always include 2 decimals.

#### Source

```DataWeave
%dw 2.0
output application/xml
---
{
    prices: payload.prices mapObject (value, key) -> {
        (key): (value + 5) as Number {format: "##.00"}
    }
}
```

#### Input

```XML
<?xml version='1.0' encoding='UTF-8'?>
<prices>
    <basic>9.99</basic>
    <premium>53</premium>
    <vip>398.99</vip>
</prices>
```

#### Output

```XML
<?xml version='1.0' encoding='UTF-8'?>
<prices>
  <basic>14.99</basic>
  <premium>58.00</premium>
  <vip>403.99</vip>
</prices>
```

## mapObject(value: Null, mapper: (value: Nothing, key: Nothing, index: Nothing) -> Any): Null

Helper function that enables `mapObject` to work with a `null` value.

### Example

Using the previous example, you can test that if the input of the `mapObject` is `null`, the output
result is `null` as well. In XML `null` values are written as empty tags. You can change these
values by using the writer property `writeNilOnNull=true`.

#### Input

```XML
<?xml version='1.0' encoding='UTF-8'?>
<prices>
</prices>
```

#### Output

```XML
<?xml version='1.0' encoding='UTF-8'?>
<prices>
</prices>
```

<!-- document id=97c75364cd39f440c5b84e77fed76363389ab610b172329efeca452fe8c53e73 url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-mapobject.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# mapObject

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## mapObject<K, V>(@StreamCapable object: { (K)?: V }, mapper: (value: V, key: K, index: Number) -> Object): Object

Iterates over an object using a mapper that acts on keys, values, or indices of that object.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object to map.</p></td></tr><tr><td><p><code>mapper</code></p></td><td><p>Expression or selector that provides the <code>key</code>, <code>value</code>, or <code>index</code> used for mapping the specified object into an output object.</p></td></tr></tbody></table>

### Example

This example iterates over the input `{ "a":"b","c":"d"}` and uses the anonymous mapper function
(`(value,key,index) → { (index) : { (value):key} }`) to invert the keys and values in each specified
object and to return the indices of the objects as keys. The mapper uses named parameters to
identify the keys, values, and indices of the input object. Note that you can write the same
expression using anonymous parameters, like this:
`{"a":"b","c":"d"} mapObject { ($$$) : { ($):$$} }`

#### Source

```DataWeave
%dw 2.0
output application/json
---
{"a":"b","c":"d"} mapObject (value,key,index) -> { (index) : { (value):key} }
```

#### Output

```JSON
{ "0": { "b": "a" }, "1": { "d": "c" } }
```

### Example

This example increases each price by 5 and formats the numbers to always include 2 decimals.

#### Source

```DataWeave
%dw 2.0
output application/xml
---
{
    prices: payload.prices mapObject (value, key) -> {
        (key): (value + 5) as Number {format: "##.00"}
    }
}
```

#### Input

```XML
<?xml version='1.0' encoding='UTF-8'?>
<prices>
    <basic>9.99</basic>
    <premium>53</premium>
    <vip>398.99</vip>
</prices>
```

#### Output

```XML
<?xml version='1.0' encoding='UTF-8'?>
<prices>
  <basic>14.99</basic>
  <premium>58.00</premium>
  <vip>403.99</vip>
</prices>
```

## mapObject(value: Null, mapper: (value: Nothing, key: Nothing, index: Nothing) -> Any): Null

Helper function that enables `mapObject` to work with a `null` value.

### Example

Using the previous example, you can test that if the input of the `mapObject` is `null`, the output
result is `null` as well. In XML `null` values are written as empty tags. You can change these
values by using the writer property `writeNilOnNull=true`.

#### Input

```XML
<?xml version='1.0' encoding='UTF-8'?>
<prices>
</prices>
```

#### Output

```XML
<?xml version='1.0' encoding='UTF-8'?>
<prices>
</prices>
```

<!-- document id=4865b26257e4e4760299f6555e1803ea27d413515d9ab989c7c50feb562dbf36 url=/mulesoft/current/en-us/dataweave/2.11/dw-strings-functions-mapstring.md -->

---
product: DataWeave
version: 2.11
---

# mapString

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## mapString(@StreamCapable text: String, mapper: (character: String, index: Number) -> String): String

Applies an expression to every character of a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to map.</p></td></tr><tr><td><p><code>mapper</code></p></td><td><p>Expression that applies to each character (<code>$</code>) or index (<code>$$</code>) of the <code>text</code> string and returns a string.</p></td></tr></tbody></table>

### Example

This example redacts sensitive data from a string.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{ balance: ("\$234" mapString if (isNumeric($)) "~" else $) }
```

#### Output

```Json
{
  "balance": "$~~~"
}
```

## mapString(@StreamCapable text: Null, mapper: (character: Nothing, index: Nothing) -> Any): Null

Helper function that enables `mapString` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=31ce4ca960ee7556b0c4696b3c61dabf4642a04586b84c7b93bf490d14f95073 url=/mulesoft/current/en-us/dataweave/2.12/dw-strings-functions-mapstring.md -->

---
product: DataWeave
version: 2.12
---

# mapString

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## mapString(@StreamCapable text: String, mapper: (character: String, index: Number) -> String): String

Applies an expression to every character of a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to map.</p></td></tr><tr><td><p><code>mapper</code></p></td><td><p>Expression that applies to each character (<code>$</code>) or index (<code>$$</code>) of the <code>text</code> string and returns a string.</p></td></tr></tbody></table>

### Example

This example redacts sensitive data from a string.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{ balance: ("\$234" mapString if (isNumeric($)) "~" else $) }
```

#### Output

```Json
{
  "balance": "$~~~"
}
```

## mapString(@StreamCapable text: Null, mapper: (character: Nothing, index: Nothing) -> Any): Null

Helper function that enables `mapString` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=56a5567d00c4fe2da44a46e353ea04675d87cf2d2aa45fe78dbf8d0c7ac74caf url=/mulesoft/current/en-us/dataweave/2.4/dw-strings-functions-mapstring.md -->

---
product: DataWeave
version: 2.4
---

# mapString

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## mapString(@StreamCapable text: String, mapper: (character: String, index: Number) -> String): String

Applies an expression to every character of a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to map.</p></td></tr><tr><td><p><code>mapper</code></p></td><td><p>Expression that applies to each character (<code>$</code>) or index (<code>$$</code>) of the <code>text</code> string and returns a string.</p></td></tr></tbody></table>

### Example

This example redacts sensitive data from a string.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{ balance: ("\$234" mapString if (isNumeric($)) "~" else $) }
```

#### Output

```Json
{
  "balance": "$~~~"
}
```

## mapString(@StreamCapable text: Null, mapper: (character: Nothing, index: Nothing) -> Any): Null

Helper function that enables `mapString` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=c0d7a726789c3210930b083ec8efd49226608f4e81ba9c2db38e7be84e60e51e url=/mulesoft/current/en-us/dataweave/2.6/dw-strings-functions-mapstring.md -->

---
product: DataWeave
version: 2.6
---

# mapString

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## mapString(@StreamCapable text: String, mapper: (character: String, index: Number) -> String): String

Applies an expression to every character of a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to map.</p></td></tr><tr><td><p><code>mapper</code></p></td><td><p>Expression that applies to each character (<code>$</code>) or index (<code>$$</code>) of the <code>text</code> string and returns a string.</p></td></tr></tbody></table>

### Example

This example redacts sensitive data from a string.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{ balance: ("\$234" mapString if (isNumeric($)) "~" else $) }
```

#### Output

```Json
{
  "balance": "$~~~"
}
```

## mapString(@StreamCapable text: Null, mapper: (character: Nothing, index: Nothing) -> Any): Null

Helper function that enables `mapString` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=acfe9dbf93ff1bd21d0bf2889b2670c4fc03e19e5424992e5e1dd1b8028495d1 url=/mulesoft/current/en-us/dataweave/2.9/dw-strings-functions-mapstring.md -->

---
product: DataWeave
version: 2.9
---

# mapString

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## mapString(@StreamCapable text: String, mapper: (character: String, index: Number) -> String): String

Applies an expression to every character of a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to map.</p></td></tr><tr><td><p><code>mapper</code></p></td><td><p>Expression that applies to each character (<code>$</code>) or index (<code>$$</code>) of the <code>text</code> string and returns a string.</p></td></tr></tbody></table>

### Example

This example redacts sensitive data from a string.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{ balance: ("\$234" mapString if (isNumeric($)) "~" else $) }
```

#### Output

```Json
{
  "balance": "$~~~"
}
```

## mapString(@StreamCapable text: Null, mapper: (character: Nothing, index: Nothing) -> Any): Null

Helper function that enables `mapString` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=45433be127ec0b1dbc7c414b9a61173ff3e4f0610c607dd43fd33b23392f8cae url=/mulesoft/current/en-us/dataweave/latest/dw-strings-functions-mapstring.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# mapString

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## mapString(@StreamCapable text: String, mapper: (character: String, index: Number) -> String): String

Applies an expression to every character of a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to map.</p></td></tr><tr><td><p><code>mapper</code></p></td><td><p>Expression that applies to each character (<code>$</code>) or index (<code>$$</code>) of the <code>text</code> string and returns a string.</p></td></tr></tbody></table>

### Example

This example redacts sensitive data from a string.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{ balance: ("\$234" mapString if (isNumeric($)) "~" else $) }
```

#### Output

```Json
{
  "balance": "$~~~"
}
```

## mapString(@StreamCapable text: Null, mapper: (character: Nothing, index: Nothing) -> Any): Null

Helper function that enables `mapString` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=16e7ebed8dbffb2643539ceb25fd5a91c6611e767ef87c41e8e62971ca135040 url=/mulesoft/current/en-us/dataweave/2.11/dw-values-functions-mask.md -->

# mask

## [](#mask1)mask(value: Null, fieldName: String | Number | PathElement): (newValueProvider: (oldValue: Any, path: Path) -> Any) -> Null

Helper function that enables `mask` to work with a `null` value.

_Introduced in DataWeave version 2.2.2._

## [](#mask2)mask(value: Any, selector: PathElement): (newValueProvider: (oldValue: Any, path: Path) -> Any) -> Any

This `mask` function replaces all _simple_ elements that match the specified criteria.

Simple elements do not have child elements and cannot be objects or arrays.

_Introduced in DataWeave version 2.2.2._

### [](#parameters)Parameters

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 75%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Name</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>value</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">A value to use for masking. The value can be any DataWeave type.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>selector</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The <code>PathElement</code> selector.</p></td>
</tr>
</tbody>
</table>

### [](#example)Example

This example shows how to mask the value of a `password` field in an array of objects. It uses `field("password")` to return the `PathElement` that it passes to `mask`. It uses `with "**"**` **to specify the value (**) to use for masking.

#### [](#source)Source

```DataWeave
%dw 2.0
output application/json
import * from dw::util::Values
---
[{name: "Peter Parker", password: "spiderman"}, {name: "Bruce Wayne", password: "batman"}] mask field("password") with "*****"
```

#### [](#output)Output

```Json
[
   {
     "name": "Peter Parker",
     "password": "*****"
   },
   {
     "name": "Bruce Wayne",
     "password": "*****"
   }
 ]
```

## [](#mask3)mask(value: Any, fieldName: String): (newValueProvider: (oldValue: Any, path: Path) -> Any) -> Any

This `mask` function selects a field by its name.

_Introduced in DataWeave version 2.2.2._

### [](#parameters-2)Parameters

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 75%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Name</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>value</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The value to use for masking. The value can be any DataWeave type.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>fieldName</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">A string that specifies the name of the field to mask.</p></td>
</tr>
</tbody>
</table>

### [](#example-2)Example

This example shows how to perform masking using the name of a field in the input. It modifies the values of all fields with that value.

#### [](#source-2)Source

```DataWeave
%dw 2.0
output application/json
import * from dw::util::Values
---
[{name: "Peter Parker", password: "spiderman"}, {name: "Bruce Wayne", password: "batman"}] mask "password" with "*****"
```

#### [](#output-2)Output

```Json
[
   {
     "name": "Peter Parker",
     "password": "*****"
   },
   {
     "name": "Bruce Wayne",
     "password": "*****"
   }
 ]
```

## [](#mask4)mask(value: Any, i: Number): (newValueProvider: (oldValue: Any, path: Path) -> Any) -> Any

This `mask` function selects an element from array by its index.

_Introduced in DataWeave version 2.2.2._

### [](#parameters-3)Parameters

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 75%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Name</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>value</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The value to mask. The value can be any DataWeave type.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>index</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The index to mask. The index must be a number.</p></td>
</tr>
</tbody>
</table>

### [](#example-3)Example

This example shows how `mask` acts on all elements in the nested arrays. It changes the value of each element at index `1` to `false`.

#### [](#source-3)Source

```DataWeave
%dw 2.0
output application/json
import * from dw::util::Values
---
[[123, true], [456, true]] mask 1 with false
```

#### [](#output-3)Output

```Json
[
   [
     123,
     false
   ],
   [
     456,
     false
   ]
 ]
```

<!-- document id=7f2c9a45c97b4fb31a437843f372bf8274487a14ece3ff1ce9f02f75f65ab6e4 url=/mulesoft/current/en-us/dataweave/2.12/dw-values-functions-mask.md -->

# mask

## [](#mask1)mask(value: Null, fieldName: String | Number | PathElement): (newValueProvider: (oldValue: Any, path: Path) -> Any) -> Null

Helper function that enables `mask` to work with a `null` value.

_Introduced in DataWeave version 2.2.2._

## [](#mask2)mask(value: Any, selector: PathElement): (newValueProvider: (oldValue: Any, path: Path) -> Any) -> Any

This `mask` function replaces all _simple_ elements that match the specified criteria.

Simple elements do not have child elements and cannot be objects or arrays.

_Introduced in DataWeave version 2.2.2._

### [](#parameters)Parameters

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 75%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Name</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>value</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">A value to use for masking. The value can be any DataWeave type.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>selector</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The <code>PathElement</code> selector.</p></td>
</tr>
</tbody>
</table>

### [](#example)Example

This example shows how to mask the value of a `password` field in an array of objects. It uses `field("password")` to return the `PathElement` that it passes to `mask`. It uses `with "**"**` **to specify the value (**) to use for masking.

#### [](#source)Source

```DataWeave
%dw 2.0
output application/json
import * from dw::util::Values
---
[{name: "Peter Parker", password: "spiderman"}, {name: "Bruce Wayne", password: "batman"}] mask field("password") with "*****"
```

#### [](#output)Output

```Json
[
   {
     "name": "Peter Parker",
     "password": "*****"
   },
   {
     "name": "Bruce Wayne",
     "password": "*****"
   }
 ]
```

## [](#mask3)mask(value: Any, fieldName: String): (newValueProvider: (oldValue: Any, path: Path) -> Any) -> Any

This `mask` function selects a field by its name.

_Introduced in DataWeave version 2.2.2._

### [](#parameters-2)Parameters

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 75%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Name</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>value</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The value to use for masking. The value can be any DataWeave type.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>fieldName</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">A string that specifies the name of the field to mask.</p></td>
</tr>
</tbody>
</table>

### [](#example-2)Example

This example shows how to perform masking using the name of a field in the input. It modifies the values of all fields with that value.

#### [](#source-2)Source

```DataWeave
%dw 2.0
output application/json
import * from dw::util::Values
---
[{name: "Peter Parker", password: "spiderman"}, {name: "Bruce Wayne", password: "batman"}] mask "password" with "*****"
```

#### [](#output-2)Output

```Json
[
   {
     "name": "Peter Parker",
     "password": "*****"
   },
   {
     "name": "Bruce Wayne",
     "password": "*****"
   }
 ]
```

## [](#mask4)mask(value: Any, i: Number): (newValueProvider: (oldValue: Any, path: Path) -> Any) -> Any

This `mask` function selects an element from array by its index.

_Introduced in DataWeave version 2.2.2._

### [](#parameters-3)Parameters

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 75%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Name</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>value</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The value to mask. The value can be any DataWeave type.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>index</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The index to mask. The index must be a number.</p></td>
</tr>
</tbody>
</table>

### [](#example-3)Example

This example shows how `mask` acts on all elements in the nested arrays. It changes the value of each element at index `1` to `false`.

#### [](#source-3)Source

```DataWeave
%dw 2.0
output application/json
import * from dw::util::Values
---
[[123, true], [456, true]] mask 1 with false
```

#### [](#output-3)Output

```Json
[
   [
     123,
     false
   ],
   [
     456,
     false
   ]
 ]
```

<!-- document id=1ff8541f03556053867181745e373380f380973deafb09bca2defa5b79bfe20d url=/mulesoft/current/en-us/dataweave/2.3/dw-values-functions-mask.md -->

# mask

## [](#mask1)mask(Null, String | Number | PathElement): Any

Helper function that enables `mask` to work with a `null` value.

## [](#mask2)mask(Any, PathElement): Any

This `mask` function replaces all _simple_ elements that match the specified criteria.

Simple elements do not have child elements and cannot be objects or arrays.

### [](#parameters)Parameters

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 75%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Name</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>value</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">A value to use for masking. The value can be any DataWeave type.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>selector</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The <code>PathElement</code> selector.</p></td>
</tr>
</tbody>
</table>

### [](#example)Example

This example shows how to mask the value of a `password` field in an array of objects. It uses `field("password")` to return the `PathElement` that it passes to `mask`. It uses `with "**"**` **to specify the value (**) to use for masking.

#### [](#source)Source

```DataWeave
%dw 2.0
output application/json
import * from dw::util::Values
---
[{name: "Peter Parker", password: "spiderman"}, {name: "Bruce Wayne", password: "batman"}] mask field("password") with "*****"
```

#### [](#output)Output

```Json
[
   {
     "name": "Peter Parker",
     "password": "*****"
   },
   {
     "name": "Bruce Wayne",
     "password": "*****"
   }
 ]
```

## [](#mask3)mask(Any, String): Any

This `mask` function selects a field by its name.

### [](#parameters-2)Parameters

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 75%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Name</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>value</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The value to use for masking. The value can be any DataWeave type.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>fieldName</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">A string that specifies the name of the field to mask.</p></td>
</tr>
</tbody>
</table>

### [](#example-2)Example

This example shows how to perform masking using the name of a field in the input. It modifies the values of all fields with that value.

#### [](#source-2)Source

```DataWeave
%dw 2.0
output application/json
import * from dw::util::Values
---
[{name: "Peter Parker", password: "spiderman"}, {name: "Bruce Wayne", password: "batman"}] mask "password" with "*****"
```

#### [](#output-2)Output

```Json
[
   {
     "name": "Peter Parker",
     "password": "*****"
   },
   {
     "name": "Bruce Wayne",
     "password": "*****"
   }
 ]
```

## [](#mask4)mask(Any, Number): Any

This `mask` function selects an element from array by its index.

### [](#parameters-3)Parameters

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 75%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Name</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>value</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The value to mask. The value can be any DataWeave type.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>index</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The index to mask. The index must be a number.</p></td>
</tr>
</tbody>
</table>

### [](#example-3)Example

This example shows how `mask` acts on all elements in the nested arrays. It changes the value of each element at index `1` to `false`.

#### [](#source-3)Source

```DataWeave
%dw 2.0
output application/json
import * from dw::util::Values
---
[[123, true], [456, true]] mask 1 with false
```

#### [](#output-3)Output

```Json
[
   [
     123,
     false
   ],
   [
     456,
     false
   ]
 ]
```

<!-- document id=57117408068264a92f701a192c6704bbb1e1b24e892dd3de1ab8f608482c1481 url=/mulesoft/current/en-us/dataweave/2.4/dw-values-functions-mask.md -->

# mask

## [](#mask1)mask(value: Null, fieldName: String | Number | PathElement): (newValueProvider: (oldValue: Any, path: Path) -> Any) -> Null

Helper function that enables `mask` to work with a `null` value.

_Introduced in DataWeave version 2.2.2._

## [](#mask2)mask(value: Any, selector: PathElement): (newValueProvider: (oldValue: Any, path: Path) -> Any) -> Any

This `mask` function replaces all _simple_ elements that match the specified criteria.

Simple elements do not have child elements and cannot be objects or arrays.

_Introduced in DataWeave version 2.2.2._

### [](#parameters)Parameters

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 75%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Name</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>value</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">A value to use for masking. The value can be any DataWeave type.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>selector</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The <code>PathElement</code> selector.</p></td>
</tr>
</tbody>
</table>

### [](#example)Example

This example shows how to mask the value of a `password` field in an array of objects. It uses `field("password")` to return the `PathElement` that it passes to `mask`. It uses `with "**"**` **to specify the value (**) to use for masking.

#### [](#source)Source

```DataWeave
%dw 2.0
output application/json
import * from dw::util::Values
---
[{name: "Peter Parker", password: "spiderman"}, {name: "Bruce Wayne", password: "batman"}] mask field("password") with "*****"
```

#### [](#output)Output

```Json
[
   {
     "name": "Peter Parker",
     "password": "*****"
   },
   {
     "name": "Bruce Wayne",
     "password": "*****"
   }
 ]
```

## [](#mask3)mask(value: Any, fieldName: String): (newValueProvider: (oldValue: Any, path: Path) -> Any) -> Any

This `mask` function selects a field by its name.

_Introduced in DataWeave version 2.2.2._

### [](#parameters-2)Parameters

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 75%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Name</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>value</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The value to use for masking. The value can be any DataWeave type.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>fieldName</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">A string that specifies the name of the field to mask.</p></td>
</tr>
</tbody>
</table>

### [](#example-2)Example

This example shows how to perform masking using the name of a field in the input. It modifies the values of all fields with that value.

#### [](#source-2)Source

```DataWeave
%dw 2.0
output application/json
import * from dw::util::Values
---
[{name: "Peter Parker", password: "spiderman"}, {name: "Bruce Wayne", password: "batman"}] mask "password" with "*****"
```

#### [](#output-2)Output

```Json
[
   {
     "name": "Peter Parker",
     "password": "*****"
   },
   {
     "name": "Bruce Wayne",
     "password": "*****"
   }
 ]
```

## [](#mask4)mask(value: Any, i: Number): (newValueProvider: (oldValue: Any, path: Path) -> Any) -> Any

This `mask` function selects an element from array by its index.

_Introduced in DataWeave version 2.2.2._

### [](#parameters-3)Parameters

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 75%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Name</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>value</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The value to mask. The value can be any DataWeave type.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>index</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The index to mask. The index must be a number.</p></td>
</tr>
</tbody>
</table>

### [](#example-3)Example

This example shows how `mask` acts on all elements in the nested arrays. It changes the value of each element at index `1` to `false`.

#### [](#source-3)Source

```DataWeave
%dw 2.0
output application/json
import * from dw::util::Values
---
[[123, true], [456, true]] mask 1 with false
```

#### [](#output-3)Output

```Json
[
   [
     123,
     false
   ],
   [
     456,
     false
   ]
 ]
```

<!-- document id=a9310848ff68a87241b73153cf32ab222e182003e920a2cb083640e8e82c6570 url=/mulesoft/current/en-us/dataweave/2.6/dw-values-functions-mask.md -->

# mask

## [](#mask1)mask(value: Null, fieldName: String | Number | PathElement): (newValueProvider: (oldValue: Any, path: Path) -> Any) -> Null

Helper function that enables `mask` to work with a `null` value.

_Introduced in DataWeave version 2.2.2._

## [](#mask2)mask(value: Any, selector: PathElement): (newValueProvider: (oldValue: Any, path: Path) -> Any) -> Any

This `mask` function replaces all _simple_ elements that match the specified criteria.

Simple elements do not have child elements and cannot be objects or arrays.

_Introduced in DataWeave version 2.2.2._

### [](#parameters)Parameters

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 75%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Name</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>value</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">A value to use for masking. The value can be any DataWeave type.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>selector</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The <code>PathElement</code> selector.</p></td>
</tr>
</tbody>
</table>

### [](#example)Example

This example shows how to mask the value of a `password` field in an array of objects. It uses `field("password")` to return the `PathElement` that it passes to `mask`. It uses `with "**"**` **to specify the value (**) to use for masking.

#### [](#source)Source

```DataWeave
%dw 2.0
output application/json
import * from dw::util::Values
---
[{name: "Peter Parker", password: "spiderman"}, {name: "Bruce Wayne", password: "batman"}] mask field("password") with "*****"
```

#### [](#output)Output

```Json
[
   {
     "name": "Peter Parker",
     "password": "*****"
   },
   {
     "name": "Bruce Wayne",
     "password": "*****"
   }
 ]
```

## [](#mask3)mask(value: Any, fieldName: String): (newValueProvider: (oldValue: Any, path: Path) -> Any) -> Any

This `mask` function selects a field by its name.

_Introduced in DataWeave version 2.2.2._

### [](#parameters-2)Parameters

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 75%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Name</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>value</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The value to use for masking. The value can be any DataWeave type.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>fieldName</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">A string that specifies the name of the field to mask.</p></td>
</tr>
</tbody>
</table>

### [](#example-2)Example

This example shows how to perform masking using the name of a field in the input. It modifies the values of all fields with that value.

#### [](#source-2)Source

```DataWeave
%dw 2.0
output application/json
import * from dw::util::Values
---
[{name: "Peter Parker", password: "spiderman"}, {name: "Bruce Wayne", password: "batman"}] mask "password" with "*****"
```

#### [](#output-2)Output

```Json
[
   {
     "name": "Peter Parker",
     "password": "*****"
   },
   {
     "name": "Bruce Wayne",
     "password": "*****"
   }
 ]
```

## [](#mask4)mask(value: Any, i: Number): (newValueProvider: (oldValue: Any, path: Path) -> Any) -> Any

This `mask` function selects an element from array by its index.

_Introduced in DataWeave version 2.2.2._

### [](#parameters-3)Parameters

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 75%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Name</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>value</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The value to mask. The value can be any DataWeave type.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>index</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The index to mask. The index must be a number.</p></td>
</tr>
</tbody>
</table>

### [](#example-3)Example

This example shows how `mask` acts on all elements in the nested arrays. It changes the value of each element at index `1` to `false`.

#### [](#source-3)Source

```DataWeave
%dw 2.0
output application/json
import * from dw::util::Values
---
[[123, true], [456, true]] mask 1 with false
```

#### [](#output-3)Output

```Json
[
   [
     123,
     false
   ],
   [
     456,
     false
   ]
 ]
```

<!-- document id=6def63a6d5772cd6b38cc672e423bfc718c3aaa9e748e1f6acf7f46234155174 url=/mulesoft/current/en-us/dataweave/2.9/dw-values-functions-mask.md -->

# mask

## [](#mask1)mask(value: Null, fieldName: String | Number | PathElement): (newValueProvider: (oldValue: Any, path: Path) -> Any) -> Null

Helper function that enables `mask` to work with a `null` value.

_Introduced in DataWeave version 2.2.2._

## [](#mask2)mask(value: Any, selector: PathElement): (newValueProvider: (oldValue: Any, path: Path) -> Any) -> Any

This `mask` function replaces all _simple_ elements that match the specified criteria.

Simple elements do not have child elements and cannot be objects or arrays.

_Introduced in DataWeave version 2.2.2._

### [](#parameters)Parameters

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 75%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Name</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>value</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">A value to use for masking. The value can be any DataWeave type.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>selector</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The <code>PathElement</code> selector.</p></td>
</tr>
</tbody>
</table>

### [](#example)Example

This example shows how to mask the value of a `password` field in an array of objects. It uses `field("password")` to return the `PathElement` that it passes to `mask`. It uses `with "**"**` **to specify the value (**) to use for masking.

#### [](#source)Source

```DataWeave
%dw 2.0
output application/json
import * from dw::util::Values
---
[{name: "Peter Parker", password: "spiderman"}, {name: "Bruce Wayne", password: "batman"}] mask field("password") with "*****"
```

#### [](#output)Output

```Json
[
   {
     "name": "Peter Parker",
     "password": "*****"
   },
   {
     "name": "Bruce Wayne",
     "password": "*****"
   }
 ]
```

## [](#mask3)mask(value: Any, fieldName: String): (newValueProvider: (oldValue: Any, path: Path) -> Any) -> Any

This `mask` function selects a field by its name.

_Introduced in DataWeave version 2.2.2._

### [](#parameters-2)Parameters

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 75%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Name</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>value</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The value to use for masking. The value can be any DataWeave type.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>fieldName</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">A string that specifies the name of the field to mask.</p></td>
</tr>
</tbody>
</table>

### [](#example-2)Example

This example shows how to perform masking using the name of a field in the input. It modifies the values of all fields with that value.

#### [](#source-2)Source

```DataWeave
%dw 2.0
output application/json
import * from dw::util::Values
---
[{name: "Peter Parker", password: "spiderman"}, {name: "Bruce Wayne", password: "batman"}] mask "password" with "*****"
```

#### [](#output-2)Output

```Json
[
   {
     "name": "Peter Parker",
     "password": "*****"
   },
   {
     "name": "Bruce Wayne",
     "password": "*****"
   }
 ]
```

## [](#mask4)mask(value: Any, i: Number): (newValueProvider: (oldValue: Any, path: Path) -> Any) -> Any

This `mask` function selects an element from array by its index.

_Introduced in DataWeave version 2.2.2._

### [](#parameters-3)Parameters

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 75%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Name</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>value</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The value to mask. The value can be any DataWeave type.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>index</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The index to mask. The index must be a number.</p></td>
</tr>
</tbody>
</table>

### [](#example-3)Example

This example shows how `mask` acts on all elements in the nested arrays. It changes the value of each element at index `1` to `false`.

#### [](#source-3)Source

```DataWeave
%dw 2.0
output application/json
import * from dw::util::Values
---
[[123, true], [456, true]] mask 1 with false
```

#### [](#output-3)Output

```Json
[
   [
     123,
     false
   ],
   [
     456,
     false
   ]
 ]
```

<!-- document id=ddb13fdcdd1fdc4b035a7c57e9a87975520feeed6b38b412d80086192904331a url=/mulesoft/current/en-us/dataweave/latest/dw-values-functions-mask.md -->

# mask

## [](#mask1)mask(value: Null, fieldName: String | Number | PathElement): (newValueProvider: (oldValue: Any, path: Path) -> Any) -> Null

Helper function that enables `mask` to work with a `null` value.

_Introduced in DataWeave version 2.2.2._

## [](#mask2)mask(value: Any, selector: PathElement): (newValueProvider: (oldValue: Any, path: Path) -> Any) -> Any

This `mask` function replaces all _simple_ elements that match the specified criteria.

Simple elements do not have child elements and cannot be objects or arrays.

_Introduced in DataWeave version 2.2.2._

### [](#parameters)Parameters

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 75%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Name</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>value</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">A value to use for masking. The value can be any DataWeave type.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>selector</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The <code>PathElement</code> selector.</p></td>
</tr>
</tbody>
</table>

### [](#example)Example

This example shows how to mask the value of a `password` field in an array of objects. It uses `field("password")` to return the `PathElement` that it passes to `mask`. It uses `with "**"**` **to specify the value (**) to use for masking.

#### [](#source)Source

```DataWeave
%dw 2.0
output application/json
import * from dw::util::Values
---
[{name: "Peter Parker", password: "spiderman"}, {name: "Bruce Wayne", password: "batman"}] mask field("password") with "*****"
```

#### [](#output)Output

```Json
[
   {
     "name": "Peter Parker",
     "password": "*****"
   },
   {
     "name": "Bruce Wayne",
     "password": "*****"
   }
 ]
```

## [](#mask3)mask(value: Any, fieldName: String): (newValueProvider: (oldValue: Any, path: Path) -> Any) -> Any

This `mask` function selects a field by its name.

_Introduced in DataWeave version 2.2.2._

### [](#parameters-2)Parameters

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 75%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Name</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>value</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The value to use for masking. The value can be any DataWeave type.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>fieldName</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">A string that specifies the name of the field to mask.</p></td>
</tr>
</tbody>
</table>

### [](#example-2)Example

This example shows how to perform masking using the name of a field in the input. It modifies the values of all fields with that value.

#### [](#source-2)Source

```DataWeave
%dw 2.0
output application/json
import * from dw::util::Values
---
[{name: "Peter Parker", password: "spiderman"}, {name: "Bruce Wayne", password: "batman"}] mask "password" with "*****"
```

#### [](#output-2)Output

```Json
[
   {
     "name": "Peter Parker",
     "password": "*****"
   },
   {
     "name": "Bruce Wayne",
     "password": "*****"
   }
 ]
```

## [](#mask4)mask(value: Any, i: Number): (newValueProvider: (oldValue: Any, path: Path) -> Any) -> Any

This `mask` function selects an element from array by its index.

_Introduced in DataWeave version 2.2.2._

### [](#parameters-3)Parameters

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 75%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Name</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>value</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The value to mask. The value can be any DataWeave type.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>index</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The index to mask. The index must be a number.</p></td>
</tr>
</tbody>
</table>

### [](#example-3)Example

This example shows how `mask` acts on all elements in the nested arrays. It changes the value of each element at index `1` to `false`.

#### [](#source-3)Source

```DataWeave
%dw 2.0
output application/json
import * from dw::util::Values
---
[[123, true], [456, true]] mask 1 with false
```

#### [](#output-3)Output

```Json
[
   [
     123,
     false
   ],
   [
     456,
     false
   ]
 ]
```

<!-- document id=cd5999efca9acf5172d38df9003f637f902317531696be0cb807d0e1bee402d9 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-match.md -->

# match

## [](#match1)match(text: String, matcher: Regex): Array<String>

Uses a Java regular expression (regex) to match a string and then separates it into capture groups. Returns the results in an array.

Note that you can use `match` for pattern matching expressions that include [case statements](https://docs.mulesoft.com/dataweave/latest/dataweave-pattern-matching).

### [](#parameters)Parameters

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 75%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Name</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>text</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">A string.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>matcher</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">A Java regex for matching characters in the <code>text</code>.</p></td>
</tr>
</tbody>
</table>

### [](#example)Example

In this example, the regex matches the input email address and contains two capture groups within parentheses (located before and after the `@`). The result is an array of elements: The first matching the entire regex, the second matching the initial capture group (**) in the regex, the third matching the last capture group (`[a-z]`**).

#### [](#source)Source

```DataWeave
%dw 2.0
output application/json
---
"me@mulesoft.com" match(/([a-z]*)@([a-z]*)\.com/)
```

#### [](#output)Output

```JSON
[
  "me@mulesoft.com",
  "me",
  "mulesoft"
]
```

### [](#example-2)Example

This example outputs matches to values in an array that end in `4`. It uses `flatMap` to iterate over and flatten the list.

#### [](#source-2)Source

```DataWeave
%dw 2.0
var a = '192.88.99.0/24'
var b = '192.168.0.0/16'
var c = '192.175.48.0/24'
output application/json
---
[ a, b, c ] flatMap ( $ match(/.*[$4]/) )
```

#### [](#output-2)Output

```JSON
[  "192.88.99.0/24", "192.175.48.0/24" ]
```

## [](#match2)match(text: Null, matcher: Any): Null

Helper function that enables `match` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=31664b375927529b91009d24f6eef853c2850294593e9e4bf5574ea0c15311e9 url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-match.md -->

# match

## [](#match1)match(text: String, matcher: Regex): Array<String>

Uses a Java regular expression (regex) to match a string and then separates it into capture groups. Returns the results in an array.

Note that you can use `match` for pattern matching expressions that include [case statements](https://docs.mulesoft.com/dataweave/latest/dataweave-pattern-matching).

### [](#parameters)Parameters

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 75%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Name</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>text</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">A string.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>matcher</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">A Java regex for matching characters in the <code>text</code>.</p></td>
</tr>
</tbody>
</table>

### [](#example)Example

In this example, the regex matches the input email address and contains two capture groups within parentheses (located before and after the `@`). The result is an array of elements: The first matching the entire regex, the second matching the initial capture group (**) in the regex, the third matching the last capture group (`[a-z]`**).

#### [](#source)Source

```DataWeave
%dw 2.0
output application/json
---
"me@mulesoft.com" match(/([a-z]*)@([a-z]*)\.com/)
```

#### [](#output)Output

```JSON
[
  "me@mulesoft.com",
  "me",
  "mulesoft"
]
```

### [](#example-2)Example

This example outputs matches to values in an array that end in `4`. It uses `flatMap` to iterate over and flatten the list.

#### [](#source-2)Source

```DataWeave
%dw 2.0
var a = '192.88.99.0/24'
var b = '192.168.0.0/16'
var c = '192.175.48.0/24'
output application/json
---
[ a, b, c ] flatMap ( $ match(/.*[$4]/) )
```

#### [](#output-2)Output

```JSON
[  "192.88.99.0/24", "192.175.48.0/24" ]
```

## [](#match2)match(text: Null, matcher: Any): Null

Helper function that enables `match` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=060fbf0bb0ce6a7dd636f433d58999d8d5d9906c229a38478d48811e226aff28 url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-match.md -->

# match

## [](#match1)match(String, Regex): Array<String>

Uses a Java regular expression (regex) to match a string and then separates it into capture groups. Returns the results in an array.

Note that you can use `match` for pattern matching expressions that include [case statements](https://docs.mulesoft.com/dataweave/2.3/dataweave-pattern-matching).

### [](#parameters)Parameters

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 75%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Name</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>text</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">A string.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>matcher</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">A Java regex for matching characters in the <code>text</code>.</p></td>
</tr>
</tbody>
</table>

### [](#example)Example

In this example, the regex matches the input email address and contains two capture groups within parentheses (located before and after the `@`). The result is an array of elements: The first matching the entire regex, the second matching the initial capture group (**) in the the regex, the third matching the last capture group (`[a-z]`**).

#### [](#source)Source

```DataWeave
%dw 2.0
output application/json
---
"me@mulesoft.com" match(/([a-z]*)@([a-z]*).com/)
```

#### [](#output)Output

```JSON
[
  "me@mulesoft.com",
  "me",
  "mulesoft"
]
```

### [](#example-2)Example

This example outputs matches to values in an array that end in `4`. It uses `flatMap` to iterate over and flatten the list.

#### [](#source-2)Source

```DataWeave
%dw 2.0
var a = '192.88.99.0/24'
var b = '192.168.0.0/16'
var c = '192.175.48.0/24'
output application/json
---
[ a, b, c ] flatMap ( $ match(/.*[$4]/) )
```

#### [](#output-2)Output

```JSON
[  "192.88.99.0/24", "192.175.48.0/24" ]
```

<!-- document id=489481f5a201b1e9bdeec763a5041e3b77685598e2978aaaa5ee8c4fe3b4bfe0 url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-match.md -->

# match

## [](#match1)match(text: String, matcher: Regex): Array<String>

Uses a Java regular expression (regex) to match a string and then separates it into capture groups. Returns the results in an array.

Note that you can use `match` for pattern matching expressions that include [case statements](https://docs.mulesoft.com/dataweave/latest/dataweave-pattern-matching).

### [](#parameters)Parameters

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 75%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Name</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>text</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">A string.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>matcher</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">A Java regex for matching characters in the <code>text</code>.</p></td>
</tr>
</tbody>
</table>

### [](#example)Example

In this example, the regex matches the input email address and contains two capture groups within parentheses (located before and after the `@`). The result is an array of elements: The first matching the entire regex, the second matching the initial capture group (**) in the the regex, the third matching the last capture group (`[a-z]`**).

#### [](#source)Source

```DataWeave
%dw 2.0
output application/json
---
"me@mulesoft.com" match(/([a-z]*)@([a-z]*)\.com/)
```

#### [](#output)Output

```JSON
[
  "me@mulesoft.com",
  "me",
  "mulesoft"
]
```

### [](#example-2)Example

This example outputs matches to values in an array that end in `4`. It uses `flatMap` to iterate over and flatten the list.

#### [](#source-2)Source

```DataWeave
%dw 2.0
var a = '192.88.99.0/24'
var b = '192.168.0.0/16'
var c = '192.175.48.0/24'
output application/json
---
[ a, b, c ] flatMap ( $ match(/.*[$4]/) )
```

#### [](#output-2)Output

```JSON
[  "192.88.99.0/24", "192.175.48.0/24" ]
```

## [](#match2)match(text: Null, matcher: Any): Null

Helper function that enables `match` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=0c9019eb8e2de73f30c372d62cd55e31b2d37441b0f7391877a436acea0cb117 url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-match.md -->

# match

## [](#match1)match(text: String, matcher: Regex): Array<String>

Uses a Java regular expression (regex) to match a string and then separates it into capture groups. Returns the results in an array.

Note that you can use `match` for pattern matching expressions that include [case statements](https://docs.mulesoft.com/dataweave/latest/dataweave-pattern-matching).

### [](#parameters)Parameters

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 75%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Name</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>text</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">A string.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>matcher</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">A Java regex for matching characters in the <code>text</code>.</p></td>
</tr>
</tbody>
</table>

### [](#example)Example

In this example, the regex matches the input email address and contains two capture groups within parentheses (located before and after the `@`). The result is an array of elements: The first matching the entire regex, the second matching the initial capture group (**) in the the regex, the third matching the last capture group (`[a-z]`**).

#### [](#source)Source

```DataWeave
%dw 2.0
output application/json
---
"me@mulesoft.com" match(/([a-z]*)@([a-z]*)\.com/)
```

#### [](#output)Output

```JSON
[
  "me@mulesoft.com",
  "me",
  "mulesoft"
]
```

### [](#example-2)Example

This example outputs matches to values in an array that end in `4`. It uses `flatMap` to iterate over and flatten the list.

#### [](#source-2)Source

```DataWeave
%dw 2.0
var a = '192.88.99.0/24'
var b = '192.168.0.0/16'
var c = '192.175.48.0/24'
output application/json
---
[ a, b, c ] flatMap ( $ match(/.*[$4]/) )
```

#### [](#output-2)Output

```JSON
[  "192.88.99.0/24", "192.175.48.0/24" ]
```

## [](#match2)match(text: Null, matcher: Any): Null

Helper function that enables `match` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=2268e4867700ce437677c2f36e28821c9d475bcd6cb6c49896865ffd015e3c1a url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-match.md -->

# match

## [](#match1)match(text: String, matcher: Regex): Array<String>

Uses a Java regular expression (regex) to match a string and then separates it into capture groups. Returns the results in an array.

Note that you can use `match` for pattern matching expressions that include [case statements](https://docs.mulesoft.com/dataweave/latest/dataweave-pattern-matching).

### [](#parameters)Parameters

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 75%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Name</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>text</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">A string.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>matcher</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">A Java regex for matching characters in the <code>text</code>.</p></td>
</tr>
</tbody>
</table>

### [](#example)Example

In this example, the regex matches the input email address and contains two capture groups within parentheses (located before and after the `@`). The result is an array of elements: The first matching the entire regex, the second matching the initial capture group (**) in the regex, the third matching the last capture group (`[a-z]`**).

#### [](#source)Source

```DataWeave
%dw 2.0
output application/json
---
"me@mulesoft.com" match(/([a-z]*)@([a-z]*)\.com/)
```

#### [](#output)Output

```JSON
[
  "me@mulesoft.com",
  "me",
  "mulesoft"
]
```

### [](#example-2)Example

This example outputs matches to values in an array that end in `4`. It uses `flatMap` to iterate over and flatten the list.

#### [](#source-2)Source

```DataWeave
%dw 2.0
var a = '192.88.99.0/24'
var b = '192.168.0.0/16'
var c = '192.175.48.0/24'
output application/json
---
[ a, b, c ] flatMap ( $ match(/.*[$4]/) )
```

#### [](#output-2)Output

```JSON
[  "192.88.99.0/24", "192.175.48.0/24" ]
```

## [](#match2)match(text: Null, matcher: Any): Null

Helper function that enables `match` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=dd8b7ead8146a311c66020a7c787fb4e4fc686967bbc1e647444fa86be680e9b url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-match.md -->

# match

## [](#match1)match(text: String, matcher: Regex): Array<String>

Uses a Java regular expression (regex) to match a string and then separates it into capture groups. Returns the results in an array.

Note that you can use `match` for pattern matching expressions that include [case statements](https://docs.mulesoft.com/dataweave/latest/dataweave-pattern-matching).

### [](#parameters)Parameters

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 75%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Name</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>text</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">A string.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>matcher</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">A Java regex for matching characters in the <code>text</code>.</p></td>
</tr>
</tbody>
</table>

### [](#example)Example

In this example, the regex matches the input email address and contains two capture groups within parentheses (located before and after the `@`). The result is an array of elements: The first matching the entire regex, the second matching the initial capture group (**) in the regex, the third matching the last capture group (`[a-z]`**).

#### [](#source)Source

```DataWeave
%dw 2.0
output application/json
---
"me@mulesoft.com" match(/([a-z]*)@([a-z]*)\.com/)
```

#### [](#output)Output

```JSON
[
  "me@mulesoft.com",
  "me",
  "mulesoft"
]
```

### [](#example-2)Example

This example outputs matches to values in an array that end in `4`. It uses `flatMap` to iterate over and flatten the list.

#### [](#source-2)Source

```DataWeave
%dw 2.0
var a = '192.88.99.0/24'
var b = '192.168.0.0/16'
var c = '192.175.48.0/24'
output application/json
---
[ a, b, c ] flatMap ( $ match(/.*[$4]/) )
```

#### [](#output-2)Output

```JSON
[  "192.88.99.0/24", "192.175.48.0/24" ]
```

## [](#match2)match(text: Null, matcher: Any): Null

Helper function that enables `match` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=c8c759dc246afbe2e0bf10ffc26afe17d1de71a2281d7f56130b731a40b3d152 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-matches.md -->

---
product: DataWeave
version: 2.11
---

# matches

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## matches(text: String, matcher: Regex): Boolean

Checks if an expression matches the entire input string.

For use cases where you need to output or conditionally process the matched value, see
[Pattern Matching in DataWeave](https://docs.mulesoft.com/dataweave/latest/dataweave-pattern-matching).

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>matcher</code></p></td><td><p>A Java regular expression for matching characters in the string.</p></td></tr></tbody></table>

### Example

This example indicates whether the regular expression matches the input text. Note that you can also
use the `matches(text,matcher)` notation (for example, `matches("admin123", /a.*\d+/)`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ ("admin123" matches /a.*\d+/), ("admin123" matches /^b.+/) ]
```

#### Output

```JSON
[ true, false ]
```

## matches(text: Null, matcher: Any): false

Helper function that enables `matches` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=0d3f0da0a7311c9e00c9fee86e5aeec43f2aa883d02b461dfca9f86e60be828e url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-matches.md -->

---
product: DataWeave
version: 2.12
---

# matches

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## matches(text: String, matcher: Regex): Boolean

Checks if an expression matches the entire input string.

For use cases where you need to output or conditionally process the matched value, see
[Pattern Matching in DataWeave](https://docs.mulesoft.com/dataweave/latest/dataweave-pattern-matching).

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>matcher</code></p></td><td><p>A Java regular expression for matching characters in the string.</p></td></tr></tbody></table>

### Example

This example indicates whether the regular expression matches the input text. Note that you can also
use the `matches(text,matcher)` notation (for example, `matches("admin123", /a.*\d+/)`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ ("admin123" matches /a.*\d+/), ("admin123" matches /^b.+/) ]
```

#### Output

```JSON
[ true, false ]
```

## matches(text: Null, matcher: Any): false

Helper function that enables `matches` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=2f27525c763be1bcb5bc1724360465b8a64b416138dcc51fabb3997868c00631 url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-matches.md -->

---
product: DataWeave
version: 2.3
---

# matches

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## matches(String, Regex): Boolean

Checks if an expression matches the entire input string.

For use cases where you need to output or conditionally process the matched value, see
[Pattern Matching in DataWeave](https://docs.mulesoft.com/dataweave/2.3/dataweave-pattern-matching).

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>matcher</code></p></td><td><p>A Java regular expression for matching characters in the string.</p></td></tr></tbody></table>

### Example

This example indicates whether the regular expression matches the input text. Note that you can also
use the `matches(text,matcher)` notation (for example, `matches("admin123", /a.*\d+/)`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ ("admin123" matches /a.*\d+/), ("admin123" matches /^b.+/) ]
```

#### Output

```JSON
[ true, false ]
```

<!-- document id=7dde77cc65309e84c9b8d7dde1787b606a458f7219d6ca294b2ab6b44fc45e50 url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-matches.md -->

---
product: DataWeave
version: 2.4
---

# matches

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## matches(text: String, matcher: Regex): Boolean

Checks if an expression matches the entire input string.

For use cases where you need to output or conditionally process the matched value, see
[Pattern Matching in DataWeave](https://docs.mulesoft.com/dataweave/latest/dataweave-pattern-matching).

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>matcher</code></p></td><td><p>A Java regular expression for matching characters in the string.</p></td></tr></tbody></table>

### Example

This example indicates whether the regular expression matches the input text. Note that you can also
use the `matches(text,matcher)` notation (for example, `matches("admin123", /a.*\d+/)`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ ("admin123" matches /a.*\d+/), ("admin123" matches /^b.+/) ]
```

#### Output

```JSON
[ true, false ]
```

## matches(text: Null, matcher: Any): false

Helper function that enables `matches` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=6b0a5de7600314464094c0047384cde6cc36a7d6e064e89c13ccc3e37cce2f5c url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-matches.md -->

---
product: DataWeave
version: 2.6
---

# matches

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## matches(text: String, matcher: Regex): Boolean

Checks if an expression matches the entire input string.

For use cases where you need to output or conditionally process the matched value, see
[Pattern Matching in DataWeave](https://docs.mulesoft.com/dataweave/latest/dataweave-pattern-matching).

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>matcher</code></p></td><td><p>A Java regular expression for matching characters in the string.</p></td></tr></tbody></table>

### Example

This example indicates whether the regular expression matches the input text. Note that you can also
use the `matches(text,matcher)` notation (for example, `matches("admin123", /a.*\d+/)`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ ("admin123" matches /a.*\d+/), ("admin123" matches /^b.+/) ]
```

#### Output

```JSON
[ true, false ]
```

## matches(text: Null, matcher: Any): false

Helper function that enables `matches` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=5fc699ebb27a29275df0ca41cc504ca27d32b5e91ad66a4de7172abad7dc03e4 url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-matches.md -->

---
product: DataWeave
version: 2.9
---

# matches

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## matches(text: String, matcher: Regex): Boolean

Checks if an expression matches the entire input string.

For use cases where you need to output or conditionally process the matched value, see
[Pattern Matching in DataWeave](https://docs.mulesoft.com/dataweave/latest/dataweave-pattern-matching).

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>matcher</code></p></td><td><p>A Java regular expression for matching characters in the string.</p></td></tr></tbody></table>

### Example

This example indicates whether the regular expression matches the input text. Note that you can also
use the `matches(text,matcher)` notation (for example, `matches("admin123", /a.*\d+/)`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ ("admin123" matches /a.*\d+/), ("admin123" matches /^b.+/) ]
```

#### Output

```JSON
[ true, false ]
```

## matches(text: Null, matcher: Any): false

Helper function that enables `matches` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=268bdad15fdd01af81ee8f55cd2d84504938289273ef80be22f0943b23106cb8 url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-matches.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# matches

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## matches(text: String, matcher: Regex): Boolean

Checks if an expression matches the entire input string.

For use cases where you need to output or conditionally process the matched value, see
[Pattern Matching in DataWeave](https://docs.mulesoft.com/dataweave/latest/dataweave-pattern-matching).

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>matcher</code></p></td><td><p>A Java regular expression for matching characters in the string.</p></td></tr></tbody></table>

### Example

This example indicates whether the regular expression matches the input text. Note that you can also
use the `matches(text,matcher)` notation (for example, `matches("admin123", /a.*\d+/)`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ ("admin123" matches /a.*\d+/), ("admin123" matches /^b.+/) ]
```

#### Output

```JSON
[ true, false ]
```

## matches(text: Null, matcher: Any): false

Helper function that enables `matches` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=b7fcca515d184b0ea4bff471964b5e460d49632c3ba06a6f49c2d3b7cbf253ac url=/mulesoft/current/en-us/dataweave/2.11/dw-math.md -->

---
product: DataWeave
version: 2.11
---

# Math (dw::util::Math)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

A utility module that provides mathematical functions.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::util::Math` to the header of your DataWeave script.

_Introduced in DataWeave version 2.4.0._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-math-functions-acos">acos</a></p></td><td><p>Returns an arc cosine value that can range from <code>0.0</code> through pi.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-math-functions-asin">asin</a></p></td><td><p>Returns an arc sine value that can range from <code>-pi/2</code> through <code>pi/2</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-math-functions-atan">atan</a></p></td><td><p>Returns an arc tangent value that can range from <code>-pi/2</code> through <code>pi/2</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-math-functions-cos">cos</a></p></td><td><p>Returns the trigonometric cosine of an angle from a given number of radians.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-math-functions-decimaladd">decimalAdd</a></p></td><td><p>Performs number addition with rounding specified by the operation context.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-math-functions-decimaldivide">decimalDivide</a></p></td><td><p>Performs number division with rounding specified by the operation context. If precision is set to <code>0</code> (unlimited precision) and the result has an infinite decimal expansion, the function returns an error.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-math-functions-decimalmultiply">decimalMultiply</a></p></td><td><p>Performs number multiplication with rounding specified by the operation context.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-math-functions-decimalpow">decimalPow</a></p></td><td><p>Returns a number with value base^exponent with rounding specified by the operation context. The maximum value for the exponent is <code>99999999</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-math-functions-decimalround">decimalRound</a></p></td><td><p>Returns the argument number with rounding specified by the operation context.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-math-functions-decimalsqrt">decimalSqrt</a></p></td><td><p>Returns a number that approximates the square root of the argument with rounding specified by the operation context.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-math-functions-decimalsubtract">decimalSubtract</a></p></td><td><p>Performs number subtraction with rounding specified by the operation context.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-math-functions-log10">log10</a></p></td><td><p>Returns the logarithm base 10 of a number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-math-functions-logn">logn</a></p></td><td><p>Returns the natural logarithm (base <code>e</code>) of a number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-math-functions-sin">sin</a></p></td><td><p>Returns the trigonometric sine of an angle from a given number of radians.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-math-functions-tan">tan</a></p></td><td><p>Returns the trigonometric tangent of an angle from a given number of radians.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-math-functions-todegrees">toDegrees</a></p></td><td><p>Converts an angle measured in radians to an approximately equivalent number of degrees.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-math-functions-toradians">toRadians</a></p></td><td><p>Converts a given number of degrees in an angle to an approximately equivalent number of radians.</p></td></tr></tbody></table>

## Variables

- [Math Variables](https://docs.mulesoft.com/dataweave/2.11/dw-math-variables)

## Types

- [Math Types](https://docs.mulesoft.com/dataweave/2.11/dw-math-types)

<!-- document id=f8a71e8ba17620026660bb93159bee4952783672f529233da351c7ef8cc17d12 url=/mulesoft/current/en-us/dataweave/2.12/dw-math.md -->

---
product: DataWeave
version: 2.12
---

# Math (dw::util::Math)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

A utility module that provides mathematical functions.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::util::Math` to the header of your DataWeave script.

_Introduced in DataWeave version 2.4.0._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-math-functions-acos">acos</a></p></td><td><p>Returns an arc cosine value that can range from <code>0.0</code> through pi.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-math-functions-asin">asin</a></p></td><td><p>Returns an arc sine value that can range from <code>-pi/2</code> through <code>pi/2</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-math-functions-atan">atan</a></p></td><td><p>Returns an arc tangent value that can range from <code>-pi/2</code> through <code>pi/2</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-math-functions-cos">cos</a></p></td><td><p>Returns the trigonometric cosine of an angle from a given number of radians.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-math-functions-decimaladd">decimalAdd</a></p></td><td><p>Performs number addition with rounding specified by the operation context.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-math-functions-decimaldivide">decimalDivide</a></p></td><td><p>Performs number division with rounding specified by the operation context. If precision is set to <code>0</code> (unlimited precision) and the result has an infinite decimal expansion, the function returns an error.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-math-functions-decimalmultiply">decimalMultiply</a></p></td><td><p>Performs number multiplication with rounding specified by the operation context.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-math-functions-decimalpow">decimalPow</a></p></td><td><p>Returns a number with value base^exponent with rounding specified by the operation context. The maximum value for the exponent is <code>99999999</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-math-functions-decimalround">decimalRound</a></p></td><td><p>Returns the argument number with rounding specified by the operation context.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-math-functions-decimalsqrt">decimalSqrt</a></p></td><td><p>Returns a number that approximates the square root of the argument with rounding specified by the operation context.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-math-functions-decimalsubtract">decimalSubtract</a></p></td><td><p>Performs number subtraction with rounding specified by the operation context.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-math-functions-log10">log10</a></p></td><td><p>Returns the logarithm base 10 of a number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-math-functions-logn">logn</a></p></td><td><p>Returns the natural logarithm (base <code>e</code>) of a number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-math-functions-sin">sin</a></p></td><td><p>Returns the trigonometric sine of an angle from a given number of radians.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-math-functions-tan">tan</a></p></td><td><p>Returns the trigonometric tangent of an angle from a given number of radians.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-math-functions-todegrees">toDegrees</a></p></td><td><p>Converts an angle measured in radians to an approximately equivalent number of degrees.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-math-functions-toradians">toRadians</a></p></td><td><p>Converts a given number of degrees in an angle to an approximately equivalent number of radians.</p></td></tr></tbody></table>

## Variables

- [Math Variables](https://docs.mulesoft.com/dataweave/2.12/dw-math-variables)

## Types

- [Math Types](https://docs.mulesoft.com/dataweave/2.12/dw-math-types)

<!-- document id=f8e6c6bb13ec694f92774a54c26d4055dc77545cc4d6a880bb5810048294b45e url=/mulesoft/current/en-us/dataweave/2.4/dw-math.md -->

---
product: DataWeave
version: 2.4
---

# Math (dw::util::Math)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

A utility module that provides mathematical functions.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::util::Math` to the header of your DataWeave script.

_Introduced in DataWeave version 2.4.0._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-math-functions-acos">acos</a></p></td><td><div><div><p>Returns an arc cosine value that can range from <code>0.0</code> through pi.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-math-functions-asin">asin</a></p></td><td><div><div><p>Returns an arc sine value that can range from <code>-pi/2</code> through <code>pi/2</code>.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-math-functions-atan">atan</a></p></td><td><div><div><p>Returns an arc tangent value that can range from <code>-pi/2</code> through <code>pi/2</code>.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-math-functions-cos">cos</a></p></td><td><div><div><p>Returns the trigonometric cosine of an angle from a given number of radians.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-math-functions-log10">log10</a></p></td><td><div><div><p>Returns the logarithm base 10 of a number.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-math-functions-logn">logn</a></p></td><td><div><div><p>Returns the natural logarithm (base <code>e</code>) of a number.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-math-functions-sin">sin</a></p></td><td><div><div><p>Returns the trigonometric sine of an angle from a given number of radians.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-math-functions-tan">tan</a></p></td><td><div><div><p>Returns the trigonometric tangent of an angle from a given number of radians.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-math-functions-todegrees">toDegrees</a></p></td><td><div><div><p>Converts an angle measured in radians to an approximately equivalent number of degrees.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-math-functions-toradians">toRadians</a></p></td><td><div><div><p>Converts a given number of degrees in an angle to an approximately equivalent number of radians.</p></div></div></td></tr></tbody></table>

## Variables

- [Math Variables](https://docs.mulesoft.com/dataweave/2.4/dw-math-variables)

<!-- document id=8d4ca05dc119fdd0bbff3b492ccb016dd085044ebf1fab50fc69b3340def9d1d url=/mulesoft/current/en-us/dataweave/2.6/dw-math.md -->

---
product: DataWeave
version: 2.6
---

# Math (dw::util::Math)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

A utility module that provides mathematical functions.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::util::Math` to the header of your DataWeave script.

_Introduced in DataWeave version 2.4.0._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-math-functions-acos">acos</a></p></td><td><p>Returns an arc cosine value that can range from <code>0.0</code> through pi.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-math-functions-asin">asin</a></p></td><td><p>Returns an arc sine value that can range from <code>-pi/2</code> through <code>pi/2</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-math-functions-atan">atan</a></p></td><td><p>Returns an arc tangent value that can range from <code>-pi/2</code> through <code>pi/2</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-math-functions-cos">cos</a></p></td><td><p>Returns the trigonometric cosine of an angle from a given number of radians.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-math-functions-log10">log10</a></p></td><td><p>Returns the logarithm base 10 of a number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-math-functions-logn">logn</a></p></td><td><p>Returns the natural logarithm (base <code>e</code>) of a number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-math-functions-sin">sin</a></p></td><td><p>Returns the trigonometric sine of an angle from a given number of radians.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-math-functions-tan">tan</a></p></td><td><p>Returns the trigonometric tangent of an angle from a given number of radians.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-math-functions-todegrees">toDegrees</a></p></td><td><p>Converts an angle measured in radians to an approximately equivalent number of degrees.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-math-functions-toradians">toRadians</a></p></td><td><p>Converts a given number of degrees in an angle to an approximately equivalent number of radians.</p></td></tr></tbody></table>

## Variables

- [Math Variables](https://docs.mulesoft.com/dataweave/2.6/dw-math-variables)

<!-- document id=55698446b7e4dc03ec59b74d8624680084e220b434e26215ec0abcd5e6bdae5a url=/mulesoft/current/en-us/dataweave/2.9/dw-math.md -->

---
product: DataWeave
version: 2.9
---

# Math (dw::util::Math)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

A utility module that provides mathematical functions.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::util::Math` to the header of your DataWeave script.

_Introduced in DataWeave version 2.4.0._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-math-functions-acos">acos</a></p></td><td><p>Returns an arc cosine value that can range from <code>0.0</code> through pi.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-math-functions-asin">asin</a></p></td><td><p>Returns an arc sine value that can range from <code>-pi/2</code> through <code>pi/2</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-math-functions-atan">atan</a></p></td><td><p>Returns an arc tangent value that can range from <code>-pi/2</code> through <code>pi/2</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-math-functions-cos">cos</a></p></td><td><p>Returns the trigonometric cosine of an angle from a given number of radians.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-math-functions-log10">log10</a></p></td><td><p>Returns the logarithm base 10 of a number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-math-functions-logn">logn</a></p></td><td><p>Returns the natural logarithm (base <code>e</code>) of a number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-math-functions-sin">sin</a></p></td><td><p>Returns the trigonometric sine of an angle from a given number of radians.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-math-functions-tan">tan</a></p></td><td><p>Returns the trigonometric tangent of an angle from a given number of radians.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-math-functions-todegrees">toDegrees</a></p></td><td><p>Converts an angle measured in radians to an approximately equivalent number of degrees.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-math-functions-toradians">toRadians</a></p></td><td><p>Converts a given number of degrees in an angle to an approximately equivalent number of radians.</p></td></tr></tbody></table>

## Variables

- [Math Variables](https://docs.mulesoft.com/dataweave/2.9/dw-math-variables)

<!-- document id=3ae083ab41d798c2b12c2903be74f29c3f05cf21980f2f10e66694598f221be7 url=/mulesoft/current/en-us/dataweave/latest/dw-math.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Math (dw::util::Math)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

A utility module that provides mathematical functions.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::util::Math` to the header of your DataWeave script.

_Introduced in DataWeave version 2.4.0._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-math-functions-acos">acos</a></p></td><td><p>Returns an arc cosine value that can range from <code>0.0</code> through pi.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-math-functions-asin">asin</a></p></td><td><p>Returns an arc sine value that can range from <code>-pi/2</code> through <code>pi/2</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-math-functions-atan">atan</a></p></td><td><p>Returns an arc tangent value that can range from <code>-pi/2</code> through <code>pi/2</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-math-functions-cos">cos</a></p></td><td><p>Returns the trigonometric cosine of an angle from a given number of radians.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-math-functions-decimaladd">decimalAdd</a></p></td><td><p>Performs number addition with rounding specified by the operation context.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-math-functions-decimaldivide">decimalDivide</a></p></td><td><p>Performs number division with rounding specified by the operation context. If precision is set to <code>0</code> (unlimited precision) and the result has an infinite decimal expansion, the function returns an error.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-math-functions-decimalmultiply">decimalMultiply</a></p></td><td><p>Performs number multiplication with rounding specified by the operation context.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-math-functions-decimalpow">decimalPow</a></p></td><td><p>Returns a number with value base^exponent with rounding specified by the operation context. The maximum value for the exponent is <code>99999999</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-math-functions-decimalround">decimalRound</a></p></td><td><p>Returns the argument number with rounding specified by the operation context.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-math-functions-decimalsqrt">decimalSqrt</a></p></td><td><p>Returns a number that approximates the square root of the argument with rounding specified by the operation context.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-math-functions-decimalsubtract">decimalSubtract</a></p></td><td><p>Performs number subtraction with rounding specified by the operation context.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-math-functions-log10">log10</a></p></td><td><p>Returns the logarithm base 10 of a number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-math-functions-logn">logn</a></p></td><td><p>Returns the natural logarithm (base <code>e</code>) of a number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-math-functions-sin">sin</a></p></td><td><p>Returns the trigonometric sine of an angle from a given number of radians.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-math-functions-tan">tan</a></p></td><td><p>Returns the trigonometric tangent of an angle from a given number of radians.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-math-functions-todegrees">toDegrees</a></p></td><td><p>Converts an angle measured in radians to an approximately equivalent number of degrees.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-math-functions-toradians">toRadians</a></p></td><td><p>Converts a given number of degrees in an angle to an approximately equivalent number of radians.</p></td></tr></tbody></table>

## Variables

- [Math Variables](https://docs.mulesoft.com/dataweave/latest/dw-math-variables)

## Types

- [Math Types](https://docs.mulesoft.com/dataweave/latest/dw-math-types)

<!-- document id=a1b30118fb7d416d5cf71b6344c8fe5797aa5838770e781d570ae694925d10c3 url=/mulesoft/current/en-us/dataweave/2.11/dw-math-types.md -->

---
product: DataWeave
version: 2.11
---

# Math Types (dw::util::Math)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>OperationContext</p></td><td><div><div><p><code>type OperationContext = {| precision?: Number, roundingMode?: RoundingMode |}</code></p></div></div></td><td><div><div><p>Defines the configuration under which a math operation is executed.</p></div><div><ul><li><p><code>precision</code>: number of digits used for the operation.</p></li><li><p><code>roundingMode</code>: rounding mode applied to the operation.</p></li></ul></div></div></td></tr><tr><td><p>RoundCeiling</p></td><td><div><div><p><code>type RoundCeiling = "CEILING"</code></p></div></div></td><td><div><div><p>Rounding mode that rounds toward positive infinity. If the number is positive, it behaves like <code>ROUND_UP</code>. If negative, it behaves like <code>ROUND_DOWN</code>. This rounding mode never decreases the calculated value.</p></div></div></td></tr><tr><td><p>RoundDown</p></td><td><div><div><p><code>type RoundDown = "DOWN"</code></p></div></div></td><td><div><div><p>Rounding mode that rounds toward zero. It never increments the digit before a discarded fraction (for example, truncates).</p></div></div></td></tr><tr><td><p>RoundFloor</p></td><td><div><div><p><code>type RoundFloor = "FLOOR"</code></p></div></div></td><td><div><div><p>Rounding mode that rounds toward negative infinity. If the number is positive, it behaves like <code>ROUND_DOWN</code>. If negative, it behaves like <code>ROUND_UP</code>.</p></div></div></td></tr><tr><td><p>RoundHalfDown</p></td><td><div><div><p><code>type RoundHalfDown = "HALF_DOWN"</code></p></div></div></td><td><div><div><p>Rounding mode that rounds toward the nearest neighbor, unless both neighbors are equidistant, in which case it rounds down. If the discarded fraction is greater than 0.5, it behaves like <code>ROUND_UP</code>. Otherwise, it behaves like <code>ROUND_DOWN</code>.</p></div></div></td></tr><tr><td><p>RoundHalfEven</p></td><td><div><div><p><code>type RoundHalfEven = "HALF_EVEN"</code></p></div></div></td><td><div><div><p>Rounding mode that rounds toward the nearest neighbor, unless both neighbors are equidistant, in which case it rounds toward the even neighbor. If the digit to the left of the discarded fraction is odd, it behaves like <code>ROUND_HALF_UP</code>. If even, it behaves like <code>ROUND_HALF_DOWN</code>.</p></div></div></td></tr><tr><td><p>RoundHalfUp</p></td><td><div><div><p><code>type RoundHalfUp = "HALF_UP"</code></p></div></div></td><td><div><div><p>Rounding mode that rounds toward the nearest neighbor, unless both neighbors are equidistant, in which case it rounds up. If the discarded fraction is greater than or equal to 0.5, it behaves like <code>ROUND_UP</code>. Otherwise, it behaves like <code>ROUND_DOWN</code>.</p></div></div></td></tr><tr><td><p>RoundUnnecessary</p></td><td><div><div><p><code>type RoundUnnecessary = "UNNECESSARY"</code></p></div></div></td><td><div><div><p>Rounding mode that asserts that the requested operation has an exact result, so rounding isn’t necessary.</p></div></div></td></tr><tr><td><p>RoundUp</p></td><td><div><div><p><code>type RoundUp = "UP"</code></p></div></div></td><td><div><div><p>Rounding mode that rounds away from zero. It always increments the digit before a nonzero discarded fraction.</p></div></div></td></tr><tr><td><p>RoundingMode</p></td><td><div><div><p><code>type RoundingMode = RoundUp | RoundDown | RoundCeiling | RoundFloor | RoundHalfUp | RoundHalfDown | RoundHalfEven | RoundUnnecessary</code></p></div></div></td><td><div><div><p>Enumeration of rounding strategies available for math operations. Available options are: <code>RoundUp</code>, <code>RoundDown</code>, <code>RoundCeiling</code>, <code>RoundFloor</code>, <code>RoundHalfUp</code>, <code>RoundHalfDown</code>, <code>RoundHalfEven</code>, <code>RoundUnnecessary</code>.</p></div></div></td></tr></tbody></table>

<!-- document id=792afe90266ca27d95494703410e4ccf4e5b26514ec2f29890bca5851096d101 url=/mulesoft/current/en-us/dataweave/2.12/dw-math-types.md -->

---
product: DataWeave
version: 2.12
---

# Math Types (dw::util::Math)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>OperationContext</p></td><td><div><div><p><code>type OperationContext = {| precision?: Number, roundingMode?: RoundingMode |}</code></p></div></div></td><td><div><div><p>Defines the configuration under which a math operation is executed.</p></div><div><ul><li><p><code>precision</code>: number of digits used for the operation.</p></li><li><p><code>roundingMode</code>: rounding mode applied to the operation.</p></li></ul></div></div></td></tr><tr><td><p>RoundCeiling</p></td><td><div><div><p><code>type RoundCeiling = "CEILING"</code></p></div></div></td><td><div><div><p>Rounding mode that rounds toward positive infinity. If the number is positive, it behaves like <code>ROUND_UP</code>. If negative, it behaves like <code>ROUND_DOWN</code>. This rounding mode never decreases the calculated value.</p></div></div></td></tr><tr><td><p>RoundDown</p></td><td><div><div><p><code>type RoundDown = "DOWN"</code></p></div></div></td><td><div><div><p>Rounding mode that rounds toward zero. It never increments the digit before a discarded fraction (for example, truncates).</p></div></div></td></tr><tr><td><p>RoundFloor</p></td><td><div><div><p><code>type RoundFloor = "FLOOR"</code></p></div></div></td><td><div><div><p>Rounding mode that rounds toward negative infinity. If the number is positive, it behaves like <code>ROUND_DOWN</code>. If negative, it behaves like <code>ROUND_UP</code>.</p></div></div></td></tr><tr><td><p>RoundHalfDown</p></td><td><div><div><p><code>type RoundHalfDown = "HALF_DOWN"</code></p></div></div></td><td><div><div><p>Rounding mode that rounds toward the nearest neighbor, unless both neighbors are equidistant, in which case it rounds down. If the discarded fraction is greater than 0.5, it behaves like <code>ROUND_UP</code>. Otherwise, it behaves like <code>ROUND_DOWN</code>.</p></div></div></td></tr><tr><td><p>RoundHalfEven</p></td><td><div><div><p><code>type RoundHalfEven = "HALF_EVEN"</code></p></div></div></td><td><div><div><p>Rounding mode that rounds toward the nearest neighbor, unless both neighbors are equidistant, in which case it rounds toward the even neighbor. If the digit to the left of the discarded fraction is odd, it behaves like <code>ROUND_HALF_UP</code>. If even, it behaves like <code>ROUND_HALF_DOWN</code>.</p></div></div></td></tr><tr><td><p>RoundHalfUp</p></td><td><div><div><p><code>type RoundHalfUp = "HALF_UP"</code></p></div></div></td><td><div><div><p>Rounding mode that rounds toward the nearest neighbor, unless both neighbors are equidistant, in which case it rounds up. If the discarded fraction is greater than or equal to 0.5, it behaves like <code>ROUND_UP</code>. Otherwise, it behaves like <code>ROUND_DOWN</code>.</p></div></div></td></tr><tr><td><p>RoundUnnecessary</p></td><td><div><div><p><code>type RoundUnnecessary = "UNNECESSARY"</code></p></div></div></td><td><div><div><p>Rounding mode that asserts that the requested operation has an exact result, so rounding isn’t necessary.</p></div></div></td></tr><tr><td><p>RoundUp</p></td><td><div><div><p><code>type RoundUp = "UP"</code></p></div></div></td><td><div><div><p>Rounding mode that rounds away from zero. It always increments the digit before a nonzero discarded fraction.</p></div></div></td></tr><tr><td><p>RoundingMode</p></td><td><div><div><p><code>type RoundingMode = RoundUp | RoundDown | RoundCeiling | RoundFloor | RoundHalfUp | RoundHalfDown | RoundHalfEven | RoundUnnecessary</code></p></div></div></td><td><div><div><p>Enumeration of rounding strategies available for math operations. Available options are: <code>RoundUp</code>, <code>RoundDown</code>, <code>RoundCeiling</code>, <code>RoundFloor</code>, <code>RoundHalfUp</code>, <code>RoundHalfDown</code>, <code>RoundHalfEven</code>, <code>RoundUnnecessary</code>.</p></div></div></td></tr></tbody></table>

<!-- document id=8d589e7905de290b136b0ee8cc4c54cffd4def7ed51e8b5e8721e75b1782228e url=/mulesoft/current/en-us/dataweave/latest/dw-math-types.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Math Types (dw::util::Math)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>OperationContext</p></td><td><div><div><p><code>type OperationContext = {| precision?: Number, roundingMode?: RoundingMode |}</code></p></div></div></td><td><div><div><p>Defines the configuration under which a math operation is executed.</p></div><div><ul><li><p><code>precision</code>: number of digits used for the operation.</p></li><li><p><code>roundingMode</code>: rounding mode applied to the operation.</p></li></ul></div></div></td></tr><tr><td><p>RoundCeiling</p></td><td><div><div><p><code>type RoundCeiling = "CEILING"</code></p></div></div></td><td><div><div><p>Rounding mode that rounds toward positive infinity. If the number is positive, it behaves like <code>ROUND_UP</code>. If negative, it behaves like <code>ROUND_DOWN</code>. This rounding mode never decreases the calculated value.</p></div></div></td></tr><tr><td><p>RoundDown</p></td><td><div><div><p><code>type RoundDown = "DOWN"</code></p></div></div></td><td><div><div><p>Rounding mode that rounds toward zero. It never increments the digit before a discarded fraction (for example, truncates).</p></div></div></td></tr><tr><td><p>RoundFloor</p></td><td><div><div><p><code>type RoundFloor = "FLOOR"</code></p></div></div></td><td><div><div><p>Rounding mode that rounds toward negative infinity. If the number is positive, it behaves like <code>ROUND_DOWN</code>. If negative, it behaves like <code>ROUND_UP</code>.</p></div></div></td></tr><tr><td><p>RoundHalfDown</p></td><td><div><div><p><code>type RoundHalfDown = "HALF_DOWN"</code></p></div></div></td><td><div><div><p>Rounding mode that rounds toward the nearest neighbor, unless both neighbors are equidistant, in which case it rounds down. If the discarded fraction is greater than 0.5, it behaves like <code>ROUND_UP</code>. Otherwise, it behaves like <code>ROUND_DOWN</code>.</p></div></div></td></tr><tr><td><p>RoundHalfEven</p></td><td><div><div><p><code>type RoundHalfEven = "HALF_EVEN"</code></p></div></div></td><td><div><div><p>Rounding mode that rounds toward the nearest neighbor, unless both neighbors are equidistant, in which case it rounds toward the even neighbor. If the digit to the left of the discarded fraction is odd, it behaves like <code>ROUND_HALF_UP</code>. If even, it behaves like <code>ROUND_HALF_DOWN</code>.</p></div></div></td></tr><tr><td><p>RoundHalfUp</p></td><td><div><div><p><code>type RoundHalfUp = "HALF_UP"</code></p></div></div></td><td><div><div><p>Rounding mode that rounds toward the nearest neighbor, unless both neighbors are equidistant, in which case it rounds up. If the discarded fraction is greater than or equal to 0.5, it behaves like <code>ROUND_UP</code>. Otherwise, it behaves like <code>ROUND_DOWN</code>.</p></div></div></td></tr><tr><td><p>RoundUnnecessary</p></td><td><div><div><p><code>type RoundUnnecessary = "UNNECESSARY"</code></p></div></div></td><td><div><div><p>Rounding mode that asserts that the requested operation has an exact result, so rounding isn’t necessary.</p></div></div></td></tr><tr><td><p>RoundUp</p></td><td><div><div><p><code>type RoundUp = "UP"</code></p></div></div></td><td><div><div><p>Rounding mode that rounds away from zero. It always increments the digit before a nonzero discarded fraction.</p></div></div></td></tr><tr><td><p>RoundingMode</p></td><td><div><div><p><code>type RoundingMode = RoundUp | RoundDown | RoundCeiling | RoundFloor | RoundHalfUp | RoundHalfDown | RoundHalfEven | RoundUnnecessary</code></p></div></div></td><td><div><div><p>Enumeration of rounding strategies available for math operations. Available options are: <code>RoundUp</code>, <code>RoundDown</code>, <code>RoundCeiling</code>, <code>RoundFloor</code>, <code>RoundHalfUp</code>, <code>RoundHalfDown</code>, <code>RoundHalfEven</code>, <code>RoundUnnecessary</code>.</p></div></div></td></tr></tbody></table>

<!-- document id=e126013b4912116f5858c50b578d49ffcdd398297ebf68cbd07ff5791be78d67 url=/mulesoft/current/en-us/dataweave/2.11/dw-math-variables.md -->

---
product: DataWeave
version: 2.11
---

# Math Variables (dw::util::Math)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Variable</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>DECIMAL_128_CONTEXT</p></td><td><div><div><p><code>DECIMAL_128_CONTEXT: OperationContext</code></p></div></div></td><td><div><div><p>A <code>MathContext</code> object with a precision of 34 digits, matching the IEEE 754-2019 decimal128 format, and a rounding mode of <code>HALF_EVEN</code>.</p></div></div></td></tr><tr><td><p>E</p></td><td><div><div><p><code>E</code></p></div></div></td><td><div><div><p>Variable <code>E</code> sets the value of mathematical constant <code>e</code>, the base of natural logarithms.</p></div><div><p><em>Introduced in DataWeave version 2.4.0.</em></p></div></div></td></tr><tr><td><p>PI</p></td><td><div><div><p><code>PI</code></p></div></div></td><td><div><div><p>Variable <code>PI</code> sets the value of constant value pi, the ratio of the circumference of a circle to its diameter.</p></div><div><p><em>Introduced in DataWeave version 2.4.0.</em></p></div></div></td></tr><tr><td><p>UNLIMITED_CONTEXT</p></td><td><div><div><p><code>UNLIMITED_CONTEXT: OperationContext</code></p></div></div></td><td><div><div><p>A <code>MathContext</code> object with settings configured for unlimited precision arithmetic.</p></div></div></td></tr></tbody></table>

<!-- document id=3472ee7cc0f69c6ab979eb2f9954626462dfab4d77b5e6aad15a21ee546f1449 url=/mulesoft/current/en-us/dataweave/2.12/dw-math-variables.md -->

---
product: DataWeave
version: 2.12
---

# Math Variables (dw::util::Math)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Variable</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>DECIMAL_128_CONTEXT</p></td><td><div><div><p><code>DECIMAL_128_CONTEXT: OperationContext</code></p></div></div></td><td><div><div><p>A <code>MathContext</code> object with a precision of 34 digits, matching the IEEE 754-2019 decimal128 format, and a rounding mode of <code>HALF_EVEN</code>.</p></div></div></td></tr><tr><td><p>E</p></td><td><div><div><p><code>E</code></p></div></div></td><td><div><div><p>Variable <code>E</code> sets the value of mathematical constant <code>e</code>, the base of natural logarithms.</p></div><div><p><em>Introduced in DataWeave version 2.4.0.</em></p></div></div></td></tr><tr><td><p>PI</p></td><td><div><div><p><code>PI</code></p></div></div></td><td><div><div><p>Variable <code>PI</code> sets the value of constant value pi, the ratio of the circumference of a circle to its diameter.</p></div><div><p><em>Introduced in DataWeave version 2.4.0.</em></p></div></div></td></tr><tr><td><p>UNLIMITED_CONTEXT</p></td><td><div><div><p><code>UNLIMITED_CONTEXT: OperationContext</code></p></div></div></td><td><div><div><p>A <code>MathContext</code> object with settings configured for unlimited precision arithmetic. The values of the settings are: <code>precision=0</code> and <code>roundingMode=HALF_UP</code>.</p></div></div></td></tr></tbody></table>

<!-- document id=42a7086737c7a69f2f9049665dc74589d57df030ae70a09a9127504a047db05f url=/mulesoft/current/en-us/dataweave/2.4/dw-math-variables.md -->

---
product: DataWeave
version: 2.4
---

# Math Variables (dw::util::Math)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Variable</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>E</p></td><td><p><code>E</code></p></td><td><p>Variable <code>E</code> sets the value of mathematical constant <code>e</code>, the base of natural logarithms.</p><p><em>Introduced in DataWeave version 2.4.0.</em></p></td></tr><tr><td><p>PI</p></td><td><p><code>PI</code></p></td><td><p>Variable <code>PI</code> sets the value of constant value pi, the ratio of the circumference of a circle to its diameter.</p><p><em>Introduced in DataWeave version 2.4.0.</em></p></td></tr></tbody></table>

<!-- document id=1af63ee62508f91f6c34046d8231aed6648e499464e7fd07efc01ff14fcf857b url=/mulesoft/current/en-us/dataweave/2.6/dw-math-variables.md -->

---
product: DataWeave
version: 2.6
---

# Math Variables (dw::util::Math)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Variable</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>E</p></td><td><div><div><p><code>E</code></p></div></div></td><td><div><div><p>Variable <code>E</code> sets the value of mathematical constant <code>e</code>, the base of natural logarithms.</p></div><div><p><em>Introduced in DataWeave version 2.4.0.</em></p></div></div></td></tr><tr><td><p>PI</p></td><td><div><div><p><code>PI</code></p></div></div></td><td><div><div><p>Variable <code>PI</code> sets the value of constant value pi, the ratio of the circumference of a circle to its diameter.</p></div><div><p><em>Introduced in DataWeave version 2.4.0.</em></p></div></div></td></tr></tbody></table>

<!-- document id=8c6d75209b47bc8b26c76354f8703ee47e063881f28b73aa28f49d776edcd65c url=/mulesoft/current/en-us/dataweave/2.9/dw-math-variables.md -->

---
product: DataWeave
version: 2.9
---

# Math Variables (dw::util::Math)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Variable</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>E</p></td><td><div><div><p><code>E</code></p></div></div></td><td><div><div><p>Variable <code>E</code> sets the value of mathematical constant <code>e</code>, the base of natural logarithms.</p></div><div><p><em>Introduced in DataWeave version 2.4.0.</em></p></div></div></td></tr><tr><td><p>PI</p></td><td><div><div><p><code>PI</code></p></div></div></td><td><div><div><p>Variable <code>PI</code> sets the value of constant value pi, the ratio of the circumference of a circle to its diameter.</p></div><div><p><em>Introduced in DataWeave version 2.4.0.</em></p></div></div></td></tr></tbody></table>

<!-- document id=55ef372b934cf4a4dc13e3f170e1efd4b21bf98a4d71244050fb10204e2bb99a url=/mulesoft/current/en-us/dataweave/latest/dw-math-variables.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Math Variables (dw::util::Math)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Variable</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>DECIMAL_128_CONTEXT</p></td><td><div><div><p><code>DECIMAL_128_CONTEXT: OperationContext</code></p></div></div></td><td><div><div><p>A <code>MathContext</code> object with a precision of 34 digits, matching the IEEE 754-2019 decimal128 format, and a rounding mode of <code>HALF_EVEN</code>.</p></div></div></td></tr><tr><td><p>E</p></td><td><div><div><p><code>E</code></p></div></div></td><td><div><div><p>Variable <code>E</code> sets the value of mathematical constant <code>e</code>, the base of natural logarithms.</p></div><div><p><em>Introduced in DataWeave version 2.4.0.</em></p></div></div></td></tr><tr><td><p>PI</p></td><td><div><div><p><code>PI</code></p></div></div></td><td><div><div><p>Variable <code>PI</code> sets the value of constant value pi, the ratio of the circumference of a circle to its diameter.</p></div><div><p><em>Introduced in DataWeave version 2.4.0.</em></p></div></div></td></tr><tr><td><p>UNLIMITED_CONTEXT</p></td><td><div><div><p><code>UNLIMITED_CONTEXT: OperationContext</code></p></div></div></td><td><div><div><p>A <code>MathContext</code> object with settings configured for unlimited precision arithmetic. The values of the settings are: <code>precision=0</code> and <code>roundingMode=HALF_UP</code>.</p></div></div></td></tr></tbody></table>

<!-- document id=7318f8bc1dc2f01aa6c415ddb69402b999e14b0cfd2cde316e2bfe7c0d8f1fc8 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-max.md -->

---
product: DataWeave
version: 2.11
---

# max

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## max<T <: Comparable>(@StreamCapable values: Array<T>): T | Null

Returns the highest `Comparable` value in an array.

The items must be of the same type, or the function throws an error. The function returns `null` if
the array is empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>values</code></p></td><td><p>The input array. The elements in the array can be any supported type.</p></td></tr></tbody></table>

### Example

This example returns the maximum value of each input array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ a: max([1, 1000]), b: max([1, 2, 3]), c: max([1.5, 2.5, 3.5]) }
```

#### Output

```JSON
{ "a": 1000, "b": 3, "c": 3.5 }
```

<!-- document id=c622ce00c86ebbd4a51fd858e0dc4308325f9d0cd01bda1422a563315d9d97dd url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-max.md -->

---
product: DataWeave
version: 2.12
---

# max

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## max<T <: Comparable>(@StreamCapable values: Array<T>): T | Null

Returns the highest `Comparable` value in an array.

The items must be of the same type, or the function throws an error. The function returns `null` if
the array is empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>values</code></p></td><td><p>The input array. The elements in the array can be any supported type.</p></td></tr></tbody></table>

### Example

This example returns the maximum value of each input array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ a: max([1, 1000]), b: max([1, 2, 3]), c: max([1.5, 2.5, 3.5]) }
```

#### Output

```JSON
{ "a": 1000, "b": 3, "c": 3.5 }
```

<!-- document id=42ce567d918ee6a48341fd8c0b91110dbf8417d65e96b57391ead191015844b0 url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-max.md -->

---
product: DataWeave
version: 2.3
---

# max

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## max(Array<T>): T | Null

Returns the highest `Comparable` value in an array.

The items must be of the same type, or the function throws an error. The function returns `null` if
the array is empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>values</code></p></td><td><p>The input array. The elements in the array can be any supported type.</p></td></tr></tbody></table>

### Example

This example returns the maximum value of each input array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ a: max([1, 1000]), b: max([1, 2, 3]), c: max([1.5, 2.5, 3.5]) }
```

#### Output

```JSON
{ "a": 1000, "b": 3, "c": 3.5 }
```

<!-- document id=1b2ca10fb06e437335f8d2303c47f0bc314ceefb9cd77b011528a57e98adb566 url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-max.md -->

---
product: DataWeave
version: 2.4
---

# max

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## max<T <: Comparable>(@StreamCapable values: Array<T>): T | Null

Returns the highest `Comparable` value in an array.

The items must be of the same type, or the function throws an error. The function returns `null` if
the array is empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>values</code></p></td><td><p>The input array. The elements in the array can be any supported type.</p></td></tr></tbody></table>

### Example

This example returns the maximum value of each input array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ a: max([1, 1000]), b: max([1, 2, 3]), c: max([1.5, 2.5, 3.5]) }
```

#### Output

```JSON
{ "a": 1000, "b": 3, "c": 3.5 }
```

<!-- document id=a6571c0be5850a195865f1dd8c00d99829d9c244faa6c4f71bfa4d395929bb79 url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-max.md -->

---
product: DataWeave
version: 2.6
---

# max

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## max<T <: Comparable>(@StreamCapable values: Array<T>): T | Null

Returns the highest `Comparable` value in an array.

The items must be of the same type, or the function throws an error. The function returns `null` if
the array is empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>values</code></p></td><td><p>The input array. The elements in the array can be any supported type.</p></td></tr></tbody></table>

### Example

This example returns the maximum value of each input array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ a: max([1, 1000]), b: max([1, 2, 3]), c: max([1.5, 2.5, 3.5]) }
```

#### Output

```JSON
{ "a": 1000, "b": 3, "c": 3.5 }
```

<!-- document id=809802a8b03e8b1a3770b7ddab7bccffcdc7e9e8084757dfdbbb84f778d927d6 url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-max.md -->

---
product: DataWeave
version: 2.9
---

# max

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## max<T <: Comparable>(@StreamCapable values: Array<T>): T | Null

Returns the highest `Comparable` value in an array.

The items must be of the same type, or the function throws an error. The function returns `null` if
the array is empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>values</code></p></td><td><p>The input array. The elements in the array can be any supported type.</p></td></tr></tbody></table>

### Example

This example returns the maximum value of each input array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ a: max([1, 1000]), b: max([1, 2, 3]), c: max([1.5, 2.5, 3.5]) }
```

#### Output

```JSON
{ "a": 1000, "b": 3, "c": 3.5 }
```

<!-- document id=4580f2c33d569f784a858ce8554d06c42deae63047fb95ce4231788011f5360e url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-max.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# max

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## max<T <: Comparable>(@StreamCapable values: Array<T>): T | Null

Returns the highest `Comparable` value in an array.

The items must be of the same type, or the function throws an error. The function returns `null` if
the array is empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>values</code></p></td><td><p>The input array. The elements in the array can be any supported type.</p></td></tr></tbody></table>

### Example

This example returns the maximum value of each input array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ a: max([1, 1000]), b: max([1, 2, 3]), c: max([1.5, 2.5, 3.5]) }
```

#### Output

```JSON
{ "a": 1000, "b": 3, "c": 3.5 }
```

<!-- document id=387fc6e67bfa36cb91e73cfe3f43593845ca78d7d4338b327c9fa00c31697a47 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-maxby.md -->

---
product: DataWeave
version: 2.11
---

# maxBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## maxBy<T>(@StreamCapable array: Array<T>, criteria: (item: T) -> Comparable): T | Null

Iterates over an array and returns the highest value of `Comparable` elements from it.

The items must be of the same type. `maxBy` throws an error if they are not, and the function
returns `null` if the array is empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The input array.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>Expression for selecting an item from the array, where the item is a <code>Number</code>, <code>Boolean</code>, <code>DateTime</code>, <code>LocalDateTime</code>, <code>Date</code>, <code>LocalTime</code>, <code>Time</code>, or <code>TimeZone</code> data type. Can be referenced with <code>$</code>.</p></td></tr></tbody></table>

### Example: Numeric Values

This example returns the greatest numeric value within objects (key-value pairs) in an array. Notice
that it uses `item.a` to select the value of the object. You can also write the same expression like
this, using an anonymous parameter: `[ { "a" : 1 }, { "a" : 3 }, { "a" : 2 } ] maxBy $.a`

#### Source

```DataWeave
%dw 2.0
output  application/json
---
[ { "a" : 1 }, { "a" : 3 }, { "a" : 2 } ] maxBy ((item) -> item.a)
```

#### Output

```JSON
{ "a" : 3 }
```

### Example: Date and Time Values

This example gets the latest `DateTime`, `Date`, and `Time` from inputs defined in the variables
`myDateTime1` and `myDateTime2`. It also shows that the function returns null on an empty array.

#### Source

```DataWeave
%dw 2.0
var myDateTime1 = |2017-10-01T22:57:59-03:00|
var myDateTime2 = |2018-10-01T23:57:59-03:00|
output application/json
---
{
  myMaxBy: {
    byDateTime: [ myDateTime1, myDateTime2 ] maxBy ((item) -> item),
    byDate: [ myDateTime1 as Date, myDateTime2 as Date ] maxBy ((item) -> item),
    byTime: [ myDateTime1 as Time, myDateTime2 as Time ] maxBy ((item) -> item),
    emptyArray: [] maxBy ((item) -> item)
  }
}
```

#### Output

```JSON
{
  "myMaxBy": {
    "byDateTime": "2018-10-01T23:57:59-03:00",
    "byDate": "2018-10-01",
    "byTime": "23:57:59-03:00",
    "emptyArray": null
  }
}
```

### Example: String Values

`maxBy` can also compare strings. The following example demonstrates this using simple string
elements.

#### Source

```DataWeave
[ "A", "B", "C" ] maxBy ((item) -> item)
```

#### Output

```JSON
"C"
```

<!-- document id=3bdff8f34ab45c566ee98079851505cd5a3ed1b41acee524e25bc2e69e72fa5b url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-maxby.md -->

---
product: DataWeave
version: 2.12
---

# maxBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## maxBy<T>(@StreamCapable array: Array<T>, criteria: (item: T) -> Comparable): T | Null

Iterates over an array and returns the highest value of `Comparable` elements from it.

The items must be of the same type. `maxBy` throws an error if they are not, and the function
returns `null` if the array is empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The input array.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>Expression for selecting an item from the array, where the item is a <code>Number</code>, <code>Boolean</code>, <code>DateTime</code>, <code>LocalDateTime</code>, <code>Date</code>, <code>LocalTime</code>, <code>Time</code>, or <code>TimeZone</code> data type. Can be referenced with <code>$</code>.</p></td></tr></tbody></table>

### Example: Numeric Values

This example returns the greatest numeric value within objects (key-value pairs) in an array. Notice
that it uses `item.a` to select the value of the object. You can also write the same expression like
this, using an anonymous parameter: `[ { "a" : 1 }, { "a" : 3 }, { "a" : 2 } ] maxBy $.a`

#### Source

```DataWeave
%dw 2.0
output  application/json
---
[ { "a" : 1 }, { "a" : 3 }, { "a" : 2 } ] maxBy ((item) -> item.a)
```

#### Output

```JSON
{ "a" : 3 }
```

### Example: Date and Time Values

This example gets the latest `DateTime`, `Date`, and `Time` from inputs defined in the variables
`myDateTime1` and `myDateTime2`. It also shows that the function returns null on an empty array.

#### Source

```DataWeave
%dw 2.0
var myDateTime1 = |2017-10-01T22:57:59-03:00|
var myDateTime2 = |2018-10-01T23:57:59-03:00|
output application/json
---
{
  myMaxBy: {
    byDateTime: [ myDateTime1, myDateTime2 ] maxBy ((item) -> item),
    byDate: [ myDateTime1 as Date, myDateTime2 as Date ] maxBy ((item) -> item),
    byTime: [ myDateTime1 as Time, myDateTime2 as Time ] maxBy ((item) -> item),
    emptyArray: [] maxBy ((item) -> item)
  }
}
```

#### Output

```JSON
{
  "myMaxBy": {
    "byDateTime": "2018-10-01T23:57:59-03:00",
    "byDate": "2018-10-01",
    "byTime": "23:57:59-03:00",
    "emptyArray": null
  }
}
```

### Example: String Values

`maxBy` can also compare strings. The following example demonstrates this using simple string
elements.

#### Source

```DataWeave
[ "A", "B", "C" ] maxBy ((item) -> item)
```

#### Output

```JSON
"C"
```

<!-- document id=6fd769e366774865e51bbe7e92690d9c2f733c1389b6aafabc244dd06be6d23e url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-maxby.md -->

---
product: DataWeave
version: 2.3
---

# maxBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## maxBy(Array<T>, (item: T) -> Comparable): T | Null

Iterates over an array and returns the highest value of `Comparable` elements from it.

The items must be of the same type. `maxBy` throws an error if they are not, and the function
returns `null` if the array is empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The input array.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>Expression for selecting an item from the array, where the item is a <code>Number</code>, <code>Boolean</code>, <code>DateTime</code>, <code>LocalDateTime</code>, <code>Date</code>, <code>LocalTime</code>, <code>Time</code>, or <code>TimeZone</code> data type. Can be referenced with <code>$</code>.</p></td></tr></tbody></table>

### Example

This example returns the greatest numeric value within objects (key-value pairs) in an array. Notice
that it uses `item.a` to select the value of the object. You can also write the same expression like
this, using an anonymous parameter: `[ { "a" : 1 }, { "a" : 3 }, { "a" : 2 } ] maxBy $.a`

#### Source

```DataWeave
%dw 2.0
output  application/json
---
[ { "a" : 1 }, { "a" : 3 }, { "a" : 2 } ] maxBy ((item) -> item.a)
```

#### Output

```JSON
{ "a" : 3 }
```

### Example

This example gets the latest `DateTime`, `Date`, and `Time` from inputs defined in the variables
`myDateTime1` and `myDateTime2`. It also shows that the function returns null on an empty array.

#### Source

```DataWeave
%dw 2.0
var myDateTime1 = "2017-10-01T22:57:59-03:00"
var myDateTime2 = "2018-10-01T23:57:59-03:00"
output application/json
---
{
  myMaxBy: {
    byDateTime: [ myDateTime1, myDateTime2 ] maxBy ((item) -> item),
    byDate: [ myDateTime1 as Date, myDateTime2 as Date ] maxBy ((item) -> item),
    byTime: [ myDateTime1 as Time, myDateTime2 as Time ] maxBy ((item) -> item),
    emptyArray: [] maxBy ((item) -> item)
  }
}
```

#### Output

```JSON
{
  "myMaxBy": {
    "byDateTime": "2018-10-01T23:57:59-03:00",
    "byDate": "2018-10-01",
    "byTime": "23:57:59-03:00",
    "emptyArray": null
  }
}
```

<!-- document id=5bc4d05e2f242ddce02af45bb473a8803897e3909ebe82a764867ba1da41bb3e url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-maxby.md -->

---
product: DataWeave
version: 2.4
---

# maxBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## maxBy<T>(@StreamCapable array: Array<T>, criteria: (item: T) -> Comparable): T | Null

Iterates over an array and returns the highest value of `Comparable` elements from it.

The items must be of the same type. `maxBy` throws an error if they are not, and the function
returns `null` if the array is empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The input array.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>Expression for selecting an item from the array, where the item is a <code>Number</code>, <code>Boolean</code>, <code>DateTime</code>, <code>LocalDateTime</code>, <code>Date</code>, <code>LocalTime</code>, <code>Time</code>, or <code>TimeZone</code> data type. Can be referenced with <code>$</code>.</p></td></tr></tbody></table>

### Example: Numeric Values

This example returns the greatest numeric value within objects (key-value pairs) in an array. Notice
that it uses `item.a` to select the value of the object. You can also write the same expression like
this, using an anonymous parameter: `[ { "a" : 1 }, { "a" : 3 }, { "a" : 2 } ] maxBy $.a`

#### Source

```DataWeave
%dw 2.0
output  application/json
---
[ { "a" : 1 }, { "a" : 3 }, { "a" : 2 } ] maxBy ((item) -> item.a)
```

#### Output

```JSON
{ "a" : 3 }
```

### Example: Date and Time Values

This example gets the latest `DateTime`, `Date`, and `Time` from inputs defined in the variables
`myDateTime1` and `myDateTime2`. It also shows that the function returns null on an empty array.

#### Source

```DataWeave
%dw 2.0
var myDateTime1 = |2017-10-01T22:57:59-03:00|
var myDateTime2 = |2018-10-01T23:57:59-03:00|
output application/json
---
{
  myMaxBy: {
    byDateTime: [ myDateTime1, myDateTime2 ] maxBy ((item) -> item),
    byDate: [ myDateTime1 as Date, myDateTime2 as Date ] maxBy ((item) -> item),
    byTime: [ myDateTime1 as Time, myDateTime2 as Time ] maxBy ((item) -> item),
    emptyArray: [] maxBy ((item) -> item)
  }
}
```

#### Output

```JSON
{
  "myMaxBy": {
    "byDateTime": "2018-10-01T23:57:59-03:00",
    "byDate": "2018-10-01",
    "byTime": "23:57:59-03:00",
    "emptyArray": null
  }
}
```

### Example: String Values

`maxBy` can also compare strings. The following example demonstrates this using simple string
elements.

#### Source

```DataWeave
[ "A", "B", "C" ] maxBy ((item) -> item)
```

#### Output

```JSON
"C"
```

<!-- document id=3a9314596e1d5f6179af8b49ba4dfd760b91e8cc0f685ca3347f59317fd439de url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-maxby.md -->

---
product: DataWeave
version: 2.6
---

# maxBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## maxBy<T>(@StreamCapable array: Array<T>, criteria: (item: T) -> Comparable): T | Null

Iterates over an array and returns the highest value of `Comparable` elements from it.

The items must be of the same type. `maxBy` throws an error if they are not, and the function
returns `null` if the array is empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The input array.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>Expression for selecting an item from the array, where the item is a <code>Number</code>, <code>Boolean</code>, <code>DateTime</code>, <code>LocalDateTime</code>, <code>Date</code>, <code>LocalTime</code>, <code>Time</code>, or <code>TimeZone</code> data type. Can be referenced with <code>$</code>.</p></td></tr></tbody></table>

### Example: Numeric Values

This example returns the greatest numeric value within objects (key-value pairs) in an array. Notice
that it uses `item.a` to select the value of the object. You can also write the same expression like
this, using an anonymous parameter: `[ { "a" : 1 }, { "a" : 3 }, { "a" : 2 } ] maxBy $.a`

#### Source

```DataWeave
%dw 2.0
output  application/json
---
[ { "a" : 1 }, { "a" : 3 }, { "a" : 2 } ] maxBy ((item) -> item.a)
```

#### Output

```JSON
{ "a" : 3 }
```

### Example: Date and Time Values

This example gets the latest `DateTime`, `Date`, and `Time` from inputs defined in the variables
`myDateTime1` and `myDateTime2`. It also shows that the function returns null on an empty array.

#### Source

```DataWeave
%dw 2.0
var myDateTime1 = |2017-10-01T22:57:59-03:00|
var myDateTime2 = |2018-10-01T23:57:59-03:00|
output application/json
---
{
  myMaxBy: {
    byDateTime: [ myDateTime1, myDateTime2 ] maxBy ((item) -> item),
    byDate: [ myDateTime1 as Date, myDateTime2 as Date ] maxBy ((item) -> item),
    byTime: [ myDateTime1 as Time, myDateTime2 as Time ] maxBy ((item) -> item),
    emptyArray: [] maxBy ((item) -> item)
  }
}
```

#### Output

```JSON
{
  "myMaxBy": {
    "byDateTime": "2018-10-01T23:57:59-03:00",
    "byDate": "2018-10-01",
    "byTime": "23:57:59-03:00",
    "emptyArray": null
  }
}
```

### Example: String Values

`maxBy` can also compare strings. The following example demonstrates this using simple string
elements.

#### Source

```DataWeave
[ "A", "B", "C" ] maxBy ((item) -> item)
```

#### Output

```JSON
"C"
```

<!-- document id=95e8dfeb45628f3aadebde080efc6b06020e04b22c9c566514af3d0494568e9e url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-maxby.md -->

---
product: DataWeave
version: 2.9
---

# maxBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## maxBy<T>(@StreamCapable array: Array<T>, criteria: (item: T) -> Comparable): T | Null

Iterates over an array and returns the highest value of `Comparable` elements from it.

The items must be of the same type. `maxBy` throws an error if they are not, and the function
returns `null` if the array is empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The input array.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>Expression for selecting an item from the array, where the item is a <code>Number</code>, <code>Boolean</code>, <code>DateTime</code>, <code>LocalDateTime</code>, <code>Date</code>, <code>LocalTime</code>, <code>Time</code>, or <code>TimeZone</code> data type. Can be referenced with <code>$</code>.</p></td></tr></tbody></table>

### Example: Numeric Values

This example returns the greatest numeric value within objects (key-value pairs) in an array. Notice
that it uses `item.a` to select the value of the object. You can also write the same expression like
this, using an anonymous parameter: `[ { "a" : 1 }, { "a" : 3 }, { "a" : 2 } ] maxBy $.a`

#### Source

```DataWeave
%dw 2.0
output  application/json
---
[ { "a" : 1 }, { "a" : 3 }, { "a" : 2 } ] maxBy ((item) -> item.a)
```

#### Output

```JSON
{ "a" : 3 }
```

### Example: Date and Time Values

This example gets the latest `DateTime`, `Date`, and `Time` from inputs defined in the variables
`myDateTime1` and `myDateTime2`. It also shows that the function returns null on an empty array.

#### Source

```DataWeave
%dw 2.0
var myDateTime1 = |2017-10-01T22:57:59-03:00|
var myDateTime2 = |2018-10-01T23:57:59-03:00|
output application/json
---
{
  myMaxBy: {
    byDateTime: [ myDateTime1, myDateTime2 ] maxBy ((item) -> item),
    byDate: [ myDateTime1 as Date, myDateTime2 as Date ] maxBy ((item) -> item),
    byTime: [ myDateTime1 as Time, myDateTime2 as Time ] maxBy ((item) -> item),
    emptyArray: [] maxBy ((item) -> item)
  }
}
```

#### Output

```JSON
{
  "myMaxBy": {
    "byDateTime": "2018-10-01T23:57:59-03:00",
    "byDate": "2018-10-01",
    "byTime": "23:57:59-03:00",
    "emptyArray": null
  }
}
```

### Example: String Values

`maxBy` can also compare strings. The following example demonstrates this using simple string
elements.

#### Source

```DataWeave
[ "A", "B", "C" ] maxBy ((item) -> item)
```

#### Output

```JSON
"C"
```

<!-- document id=85f99babf801e15035512ff9550f5d1248f98582753717c0ace89559f92bd26b url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-maxby.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# maxBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## maxBy<T>(@StreamCapable array: Array<T>, criteria: (item: T) -> Comparable): T | Null

Iterates over an array and returns the highest value of `Comparable` elements from it.

The items must be of the same type. `maxBy` throws an error if they are not, and the function
returns `null` if the array is empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The input array.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>Expression for selecting an item from the array, where the item is a <code>Number</code>, <code>Boolean</code>, <code>DateTime</code>, <code>LocalDateTime</code>, <code>Date</code>, <code>LocalTime</code>, <code>Time</code>, or <code>TimeZone</code> data type. Can be referenced with <code>$</code>.</p></td></tr></tbody></table>

### Example: Numeric Values

This example returns the greatest numeric value within objects (key-value pairs) in an array. Notice
that it uses `item.a` to select the value of the object. You can also write the same expression like
this, using an anonymous parameter: `[ { "a" : 1 }, { "a" : 3 }, { "a" : 2 } ] maxBy $.a`

#### Source

```DataWeave
%dw 2.0
output  application/json
---
[ { "a" : 1 }, { "a" : 3 }, { "a" : 2 } ] maxBy ((item) -> item.a)
```

#### Output

```JSON
{ "a" : 3 }
```

### Example: Date and Time Values

This example gets the latest `DateTime`, `Date`, and `Time` from inputs defined in the variables
`myDateTime1` and `myDateTime2`. It also shows that the function returns null on an empty array.

#### Source

```DataWeave
%dw 2.0
var myDateTime1 = |2017-10-01T22:57:59-03:00|
var myDateTime2 = |2018-10-01T23:57:59-03:00|
output application/json
---
{
  myMaxBy: {
    byDateTime: [ myDateTime1, myDateTime2 ] maxBy ((item) -> item),
    byDate: [ myDateTime1 as Date, myDateTime2 as Date ] maxBy ((item) -> item),
    byTime: [ myDateTime1 as Time, myDateTime2 as Time ] maxBy ((item) -> item),
    emptyArray: [] maxBy ((item) -> item)
  }
}
```

#### Output

```JSON
{
  "myMaxBy": {
    "byDateTime": "2018-10-01T23:57:59-03:00",
    "byDate": "2018-10-01",
    "byTime": "23:57:59-03:00",
    "emptyArray": null
  }
}
```

### Example: String Values

`maxBy` can also compare strings. The following example demonstrates this using simple string
elements.

#### Source

```DataWeave
[ "A", "B", "C" ] maxBy ((item) -> item)
```

#### Output

```JSON
"C"
```

<!-- document id=2b0b657ff44b81ca498c9920bc225a9fbcadcc6e9e721a978fd44d0067063f96 url=/mulesoft/current/en-us/dataweave/2.11/dw-crypto-functions-md5.md -->

---
product: DataWeave
version: 2.11
---

# MD5

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## MD5(content: Binary): String

Computes the MD5 hash and transforms the binary result into a hexadecimal lower case string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>A binary input value to encrypt.</p></td></tr></tbody></table>

### Example

This example uses the MD5 algorithm to encrypt a binary value.

#### Source

```DataWeave
%dw 2.0
import dw::Crypto
output application/json
---
{ "md5" : Crypto::MD5("asd" as Binary) }
```

#### Output

```JSON
{ "md5": "7815696ecbf1c96e6894b779456d330e" }
```

<!-- document id=7d2ce1b17250190816a32aba3ace4997720515c3b6b874575ed6c280768df249 url=/mulesoft/current/en-us/dataweave/2.12/dw-crypto-functions-md5.md -->

---
product: DataWeave
version: 2.12
---

# MD5

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## MD5(content: Binary): String

Computes the MD5 hash and transforms the binary result into a hexadecimal lower case string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>A binary input value to encrypt.</p></td></tr></tbody></table>

### Example

This example uses the MD5 algorithm to encrypt a binary value.

#### Source

```DataWeave
%dw 2.0
import dw::Crypto
output application/json
---
{ "md5" : Crypto::MD5("asd" as Binary) }
```

#### Output

```JSON
{ "md5": "7815696ecbf1c96e6894b779456d330e" }
```

<!-- document id=b22df93e38a4804939a3f6abc601b5920bf9220e41f876c347e58a3891accd61 url=/mulesoft/current/en-us/dataweave/2.3/dw-crypto-functions-md5.md -->

---
product: DataWeave
version: 2.3
---

# MD5

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## MD5(Binary): String

Computes the MD5 hash and transforms the binary result into a hexadecimal lower case string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>A binary input value to encrypt.</p></td></tr></tbody></table>

### Example

This example uses the MD5 algorithm to encrypt a binary value.

#### Source

```DataWeave
%dw 2.0
import dw::Crypto
output application/json
---
{ "md5" : Crypto::MD5("asd" as Binary) }
```

#### Output

```JSON
{ "md5": "7815696ecbf1c96e6894b779456d330e" }
```

<!-- document id=672e8f370eff763e9712f1fba9424f78f439d64b603a71c52f67fc1208729aaa url=/mulesoft/current/en-us/dataweave/2.4/dw-crypto-functions-md5.md -->

---
product: DataWeave
version: 2.4
---

# MD5

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## MD5(content: Binary): String

Computes the MD5 hash and transforms the binary result into a hexadecimal lower case string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>A binary input value to encrypt.</p></td></tr></tbody></table>

### Example

This example uses the MD5 algorithm to encrypt a binary value.

#### Source

```DataWeave
%dw 2.0
import dw::Crypto
output application/json
---
{ "md5" : Crypto::MD5("asd" as Binary) }
```

#### Output

```JSON
{ "md5": "7815696ecbf1c96e6894b779456d330e" }
```

<!-- document id=73c05db755b1ac30a14d7051d695a31109a7eee280712eaf267a114e52775e4d url=/mulesoft/current/en-us/dataweave/2.6/dw-crypto-functions-md5.md -->

---
product: DataWeave
version: 2.6
---

# MD5

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## MD5(content: Binary): String

Computes the MD5 hash and transforms the binary result into a hexadecimal lower case string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>A binary input value to encrypt.</p></td></tr></tbody></table>

### Example

This example uses the MD5 algorithm to encrypt a binary value.

#### Source

```DataWeave
%dw 2.0
import dw::Crypto
output application/json
---
{ "md5" : Crypto::MD5("asd" as Binary) }
```

#### Output

```JSON
{ "md5": "7815696ecbf1c96e6894b779456d330e" }
```

<!-- document id=fb36f80f516e1cd252a08fa9cf88423cd46f50d675362265ce21c73867fef4b1 url=/mulesoft/current/en-us/dataweave/2.9/dw-crypto-functions-md5.md -->

---
product: DataWeave
version: 2.9
---

# MD5

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## MD5(content: Binary): String

Computes the MD5 hash and transforms the binary result into a hexadecimal lower case string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>A binary input value to encrypt.</p></td></tr></tbody></table>

### Example

This example uses the MD5 algorithm to encrypt a binary value.

#### Source

```DataWeave
%dw 2.0
import dw::Crypto
output application/json
---
{ "md5" : Crypto::MD5("asd" as Binary) }
```

#### Output

```JSON
{ "md5": "7815696ecbf1c96e6894b779456d330e" }
```

<!-- document id=3e181c65e4bf8ab7d832bff3d1e23b74d43500ffa244d24f3a3a9f9c54abc361 url=/mulesoft/current/en-us/dataweave/latest/dw-crypto-functions-md5.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# MD5

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## MD5(content: Binary): String

Computes the MD5 hash and transforms the binary result into a hexadecimal lower case string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>A binary input value to encrypt.</p></td></tr></tbody></table>

### Example

This example uses the MD5 algorithm to encrypt a binary value.

#### Source

```DataWeave
%dw 2.0
import dw::Crypto
output application/json
---
{ "md5" : Crypto::MD5("asd" as Binary) }
```

#### Output

```JSON
{ "md5": "7815696ecbf1c96e6894b779456d330e" }
```

<!-- document id=be6462893b640b9ec1aa8fc9521a2cd9e20350bedccbd874ec33389392606767 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook-merge-multiple-payloads.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, transform, transformer, format, aggregate, filter, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, contains, as
---

# Merge Fields from Separate Objects

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The DataWeave examples merge fields from separate input arrays. The first (`firstInput`) is a
DataWeave variable that lists price by book ID, and the second (`secondInput`) lists authors by book
ID. Each book has a unique `bookId` key.

The DataWeave scripts produce the same output. Both scripts use two `map` functions with a filter,
and one of them also creates an alias for the `bookId`:

- The first `map` function iterates over the elements of the `firstInput` array. As the function
  evaluates each element, a second `map` function uses a filter to identify any elements in the
  second array (`secondInput`) that match the `filter` criteria
  (`secondInput filter ($.*bookId contains firstInputValue.bookId)`). The filter returns an element
  from `secondInput` that contains a `bookId` value that matches the `bookId` value in the
  `firstInput` element.

- The second `map` function evaluates that filtered element and then uses `secondInputValue.author`
  to select and populate the value of its `"author"` field in the object
  `{author : secondInputValue.author}`.

- `filter` limits the scope of the second `map` function to objects in the `secondInput` that share
  the same `bookId`.

DataWeave Script:

```dataweave
%dw 2.0
var firstInput = [
  { "bookId":"101",
    "title":"world history",
    "price":"19.99"
  },
  {
    "bookId":"202",
    "title":"the great outdoors",
    "price":"15.99"
  }
]
var secondInput = [
  {
    "bookId":"101",
    "author":"john doe"
  },
  {
    "bookId":"202",
    "author":"jane doe"
  }
]
output application/json
---
firstInput map (firstInputValue) ->
  {
    theId : firstInputValue.bookId as Number,
    theTitle: firstInputValue.title,
    thePrice: firstInputValue.price as Number,
    (secondInput filter ($.*bookId contains firstInputValue.bookId) map (secondInputValue) -> {
      theAuthor : secondInputValue.author
    })
  }
```

Output JSON:

```json
[
  {
    "theId": 101,
    "theTitle": "world history",
    "thePrice": 19.99,
    "theAuthor": "john doe"
  },
  {
    "theId": 202,
    "theTitle": "the great outdoors",
    "thePrice": 15.99,
    "theAuthor": "jane doe"
  }
]
```

As the next script shows, you can also write the same script using an `id` alias (created with
`using (id = firstInputValue.bookId)`). The alias replaces the selector expression,
`firstInputValue.bookId`, which is longer.

DataWeave Script:

```dataweave
%dw 2.0
var firstInput = [
  { "bookId":"101",
    "title":"world history",
    "price":"19.99"
  },
  {
    "bookId":"202",
    "title":"the great outdoors",
    "price":"15.99"
  }
]
var secondInput = [
  {
    "bookId":"101",
    "author":"john doe"
  },
  {
    "bookId":"202",
    "author":"jane doe"
  }
]
output application/json
---
firstInput map (firstInputValue) -> using (id = firstInputValue.bookId)
  {
    theValue : id as Number,
    theTitle: firstInputValue.title,
    thePrice: firstInputValue.price as Number,
    (secondInput filter ($.*bookId contains id)  map (secondInputValue) -> {
      theAuthor : secondInputValue.author
    })
  }
```

Output JSON:

```json
[
  {
    "theValue": 101,
    "theTitle": "world history",
    "thePrice": 19.99,
    "theAuthor": "john doe"
  },
  {
    "theValue": 202,
    "theTitle": "the great outdoors",
    "thePrice": 15.99,
    "theAuthor": "jane doe"
  }
]
```

Both scripts produce the same output.

## Related Examples

- [Extract Data](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-extract-data)

- [Reference Multiple Inputs](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-reference-multiple-inputs)

- [Zip Arrays Together](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-zip-arrays-together)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.11/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook)

<!-- document id=710fd858abed4c3773215a4fc449e45535f5ddc6f5f981e255ec7d33ce048519 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook-merge-multiple-payloads.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, transform, transformer, format, aggregate, filter, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, contains, as
---

# Merge Fields from Separate Objects

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The DataWeave examples merge fields from separate input arrays. The first (`firstInput`) is a
DataWeave variable that lists price by book ID, and the second (`secondInput`) lists authors by book
ID. Each book has a unique `bookId` key.

The DataWeave scripts produce the same output. Both scripts use two `map` functions with a filter,
and one of them also creates an alias for the `bookId`:

- The first `map` function iterates over the elements of the `firstInput` array. As the function
  evaluates each element, a second `map` function uses a filter to identify any elements in the
  second array (`secondInput`) that match the `filter` criteria
  (`secondInput filter ($.*bookId contains firstInputValue.bookId)`). The filter returns an element
  from `secondInput` that contains a `bookId` value that matches the `bookId` value in the
  `firstInput` element.

- The second `map` function evaluates that filtered element and then uses `secondInputValue.author`
  to select and populate the value of its `"author"` field in the object
  `{author : secondInputValue.author}`.

- `filter` limits the scope of the second `map` function to objects in the `secondInput` that share
  the same `bookId`.

DataWeave Script:

```dataweave
%dw 2.0
var firstInput = [
  { "bookId":"101",
    "title":"world history",
    "price":"19.99"
  },
  {
    "bookId":"202",
    "title":"the great outdoors",
    "price":"15.99"
  }
]
var secondInput = [
  {
    "bookId":"101",
    "author":"john doe"
  },
  {
    "bookId":"202",
    "author":"jane doe"
  }
]
output application/json
---
firstInput map (firstInputValue) ->
  {
    theId : firstInputValue.bookId as Number,
    theTitle: firstInputValue.title,
    thePrice: firstInputValue.price as Number,
    (secondInput filter ($.*bookId contains firstInputValue.bookId) map (secondInputValue) -> {
      theAuthor : secondInputValue.author
    })
  }
```

Output JSON:

```json
[
  {
    "theId": 101,
    "theTitle": "world history",
    "thePrice": 19.99,
    "theAuthor": "john doe"
  },
  {
    "theId": 202,
    "theTitle": "the great outdoors",
    "thePrice": 15.99,
    "theAuthor": "jane doe"
  }
]
```

As the next script shows, you can also write the same script using an `id` alias (created with
`using (id = firstInputValue.bookId)`). The alias replaces the selector expression,
`firstInputValue.bookId`, which is longer.

DataWeave Script:

```dataweave
%dw 2.0
var firstInput = [
  { "bookId":"101",
    "title":"world history",
    "price":"19.99"
  },
  {
    "bookId":"202",
    "title":"the great outdoors",
    "price":"15.99"
  }
]
var secondInput = [
  {
    "bookId":"101",
    "author":"john doe"
  },
  {
    "bookId":"202",
    "author":"jane doe"
  }
]
output application/json
---
firstInput map (firstInputValue) -> using (id = firstInputValue.bookId)
  {
    theValue : id as Number,
    theTitle: firstInputValue.title,
    thePrice: firstInputValue.price as Number,
    (secondInput filter ($.*bookId contains id)  map (secondInputValue) -> {
      theAuthor : secondInputValue.author
    })
  }
```

Output JSON:

```json
[
  {
    "theValue": 101,
    "theTitle": "world history",
    "thePrice": 19.99,
    "theAuthor": "john doe"
  },
  {
    "theValue": 202,
    "theTitle": "the great outdoors",
    "thePrice": 15.99,
    "theAuthor": "jane doe"
  }
]
```

Both scripts produce the same output.

## Related Examples

- [Extract Data](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-extract-data)

- [Reference Multiple Inputs](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-reference-multiple-inputs)

- [Zip Arrays Together](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-zip-arrays-together)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.12/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook)

<!-- document id=9a62eb683f5a89919d729ae0c2f9cbf0d63133456b1d186798b51d8cab15409f url=/mulesoft/current/en-us/dataweave/2.3/dataweave-cookbook-merge-multiple-payloads.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, transform, transformer, format, aggregate, filter, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, contains, as
---

# Merge Fields from Separate Objects

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The DataWeave examples merge fields from separate input arrays. The first (`firstInput`) is a
DataWeave variable that lists price by book ID, and the second (`secondInput`) lists authors by book
ID. Each book has a unique `bookId` key.

The DataWeave scripts produce the same output. Both scripts use two `map` functions with a filter,
and one of them also creates an alias for the `bookId`:

- The first `map` function iterates over the elements of the `firstInput` array. As the function
  evaluates each element, a second `map` function uses a filter to identify any elements in the
  second array (`secondInput`) that match the `filter` criteria
  (`secondInput filter ($.*bookId contains firstInputValue.bookId)`). The filter returns an element
  from `secondInput` that contains a `bookId` value that matches the `bookId` value in the
  `firstInput` element.

- The second `map` function evaluates that filtered element and then uses `secondInputValue.author`
  to select and populate the value of its `"author"` field in the object
  `{author : secondInputValue.author}`.

- `filter` limits the scope of the second `map` function to objects in the `secondInput` that share
  the same `bookId`.

DataWeave Script:

```dataweave
%dw 2.0
var firstInput = [
  { "bookId":"101",
    "title":"world history",
    "price":"19.99"
  },
  {
    "bookId":"202",
    "title":"the great outdoors",
    "price":"15.99"
  }
]
var secondInput = [
  {
    "bookId":"101",
    "author":"john doe"
  },
  {
    "bookId":"202",
    "author":"jane doe"
  }
]
output application/json
---
firstInput map (firstInputValue) ->
  {
    theId : firstInputValue.bookId as Number,
    theTitle: firstInputValue.title,
    thePrice: firstInputValue.price as Number,
    (secondInput filter ($.*bookId contains firstInputValue.bookId) map (secondInputValue) -> {
      theAuthor : secondInputValue.author
    })
  }
```

Output JSON:

```json
[
  {
    "theId": 101,
    "theTitle": "world history",
    "thePrice": 19.99,
    "theAuthor": "john doe"
  },
  {
    "theId": 202,
    "theTitle": "the great outdoors",
    "thePrice": 15.99,
    "theAuthor": "jane doe"
  }
]
```

As the next script shows, you can also write the same script using an `id` alias (created with
`using (id = firstInputValue.bookId)`). The alias replaces the selector expression,
`firstInputValue.bookId`, which is longer.

DataWeave Script:

```dataweave
%dw 2.0
var firstInput = [
  { "bookId":"101",
    "title":"world history",
    "price":"19.99"
  },
  {
    "bookId":"202",
    "title":"the great outdoors",
    "price":"15.99"
  }
]
var secondInput = [
  {
    "bookId":"101",
    "author":"john doe"
  },
  {
    "bookId":"202",
    "author":"jane doe"
  }
]
output application/json
---
firstInput map (firstInputValue) -> using (id = firstInputValue.bookId)
  {
    theValue : id as Number,
    theTitle: firstInputValue.title,
    thePrice: firstInputValue.price as Number,
    (secondInput filter ($.*bookId contains id)  map (secondInputValue) -> {
      theAuthor : secondInputValue.author
    })
  }
```

Output JSON:

```json
[
  {
    "theValue": 101,
    "theTitle": "world history",
    "thePrice": 19.99,
    "theAuthor": "john doe"
  },
  {
    "theValue": 202,
    "theTitle": "the great outdoors",
    "thePrice": 15.99,
    "theAuthor": "jane doe"
  }
]
```

Both scripts produce the same output.

## Related Examples

- [Extract Data](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-extract-data)

- [Reference Multiple Inputs](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-reference-multiple-inputs)

- [Zip Arrays Together](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-zip-arrays-together)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.3/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook)

<!-- document id=b36184e704136a462328c5a325e48d9f1ef179be87a5c76d9a2b253cd4ec91d8 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook-merge-multiple-payloads.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, transform, transformer, format, aggregate, filter, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, contains, as
---

# Merge Fields from Separate Objects

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The DataWeave examples merge fields from separate input arrays. The first (`firstInput`) is a
DataWeave variable that lists price by book ID, and the second (`secondInput`) lists authors by book
ID. Each book has a unique `bookId` key.

The DataWeave scripts produce the same output. Both scripts use two `map` functions with a filter,
and one of them also creates an alias for the `bookId`:

- The first `map` function iterates over the elements of the `firstInput` array. As the function
  evaluates each element, a second `map` function uses a filter to identify any elements in the
  second array (`secondInput`) that match the `filter` criteria
  (`secondInput filter ($.*bookId contains firstInputValue.bookId)`). The filter returns an element
  from `secondInput` that contains a `bookId` value that matches the `bookId` value in the
  `firstInput` element.

- The second `map` function evaluates that filtered element and then uses `secondInputValue.author`
  to select and populate the value of its `"author"` field in the object
  `{author : secondInputValue.author}`.

- `filter` limits the scope of the second `map` function to objects in the `secondInput` that share
  the same `bookId`.

DataWeave Script:

```dataweave
%dw 2.0
var firstInput = [
  { "bookId":"101",
    "title":"world history",
    "price":"19.99"
  },
  {
    "bookId":"202",
    "title":"the great outdoors",
    "price":"15.99"
  }
]
var secondInput = [
  {
    "bookId":"101",
    "author":"john doe"
  },
  {
    "bookId":"202",
    "author":"jane doe"
  }
]
output application/json
---
firstInput map (firstInputValue) ->
  {
    theId : firstInputValue.bookId as Number,
    theTitle: firstInputValue.title,
    thePrice: firstInputValue.price as Number,
    (secondInput filter ($.*bookId contains firstInputValue.bookId) map (secondInputValue) -> {
      theAuthor : secondInputValue.author
    })
  }
```

Output JSON:

```json
[
  {
    "theId": 101,
    "theTitle": "world history",
    "thePrice": 19.99,
    "theAuthor": "john doe"
  },
  {
    "theId": 202,
    "theTitle": "the great outdoors",
    "thePrice": 15.99,
    "theAuthor": "jane doe"
  }
]
```

As the next script shows, you can also write the same script using an `id` alias (created with
`using (id = firstInputValue.bookId)`). The alias replaces the selector expression,
`firstInputValue.bookId`, which is longer.

DataWeave Script:

```dataweave
%dw 2.0
var firstInput = [
  { "bookId":"101",
    "title":"world history",
    "price":"19.99"
  },
  {
    "bookId":"202",
    "title":"the great outdoors",
    "price":"15.99"
  }
]
var secondInput = [
  {
    "bookId":"101",
    "author":"john doe"
  },
  {
    "bookId":"202",
    "author":"jane doe"
  }
]
output application/json
---
firstInput map (firstInputValue) -> using (id = firstInputValue.bookId)
  {
    theValue : id as Number,
    theTitle: firstInputValue.title,
    thePrice: firstInputValue.price as Number,
    (secondInput filter ($.*bookId contains id)  map (secondInputValue) -> {
      theAuthor : secondInputValue.author
    })
  }
```

Output JSON:

```json
[
  {
    "theValue": 101,
    "theTitle": "world history",
    "thePrice": 19.99,
    "theAuthor": "john doe"
  },
  {
    "theValue": 202,
    "theTitle": "the great outdoors",
    "thePrice": 15.99,
    "theAuthor": "jane doe"
  }
]
```

Both scripts produce the same output.

## Related Examples

- [Extract Data](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-extract-data)

- [Reference Multiple Inputs](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-reference-multiple-inputs)

- [Zip Arrays Together](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-zip-arrays-together)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.4/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook)

<!-- document id=0c24de2f7a28e5c24e69b8a1f9593627ec9d7a321645bb8261e76b8815ae5b65 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook-merge-multiple-payloads.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, transform, transformer, format, aggregate, filter, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, contains, as
---

# Merge Fields from Separate Objects

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The DataWeave examples merge fields from separate input arrays. The first (`firstInput`) is a
DataWeave variable that lists price by book ID, and the second (`secondInput`) lists authors by book
ID. Each book has a unique `bookId` key.

The DataWeave scripts produce the same output. Both scripts use two `map` functions with a filter,
and one of them also creates an alias for the `bookId`:

- The first `map` function iterates over the elements of the `firstInput` array. As the function
  evaluates each element, a second `map` function uses a filter to identify any elements in the
  second array (`secondInput`) that match the `filter` criteria
  (`secondInput filter ($.*bookId contains firstInputValue.bookId)`). The filter returns an element
  from `secondInput` that contains a `bookId` value that matches the `bookId` value in the
  `firstInput` element.

- The second `map` function evaluates that filtered element and then uses `secondInputValue.author`
  to select and populate the value of its `"author"` field in the object
  `{author : secondInputValue.author}`.

- `filter` limits the scope of the second `map` function to objects in the `secondInput` that share
  the same `bookId`.

DataWeave Script:

```dataweave
%dw 2.0
var firstInput = [
  { "bookId":"101",
    "title":"world history",
    "price":"19.99"
  },
  {
    "bookId":"202",
    "title":"the great outdoors",
    "price":"15.99"
  }
]
var secondInput = [
  {
    "bookId":"101",
    "author":"john doe"
  },
  {
    "bookId":"202",
    "author":"jane doe"
  }
]
output application/json
---
firstInput map (firstInputValue) ->
  {
    theId : firstInputValue.bookId as Number,
    theTitle: firstInputValue.title,
    thePrice: firstInputValue.price as Number,
    (secondInput filter ($.*bookId contains firstInputValue.bookId) map (secondInputValue) -> {
      theAuthor : secondInputValue.author
    })
  }
```

Output JSON:

```json
[
  {
    "theId": 101,
    "theTitle": "world history",
    "thePrice": 19.99,
    "theAuthor": "john doe"
  },
  {
    "theId": 202,
    "theTitle": "the great outdoors",
    "thePrice": 15.99,
    "theAuthor": "jane doe"
  }
]
```

As the next script shows, you can also write the same script using an `id` alias (created with
`using (id = firstInputValue.bookId)`). The alias replaces the selector expression,
`firstInputValue.bookId`, which is longer.

DataWeave Script:

```dataweave
%dw 2.0
var firstInput = [
  { "bookId":"101",
    "title":"world history",
    "price":"19.99"
  },
  {
    "bookId":"202",
    "title":"the great outdoors",
    "price":"15.99"
  }
]
var secondInput = [
  {
    "bookId":"101",
    "author":"john doe"
  },
  {
    "bookId":"202",
    "author":"jane doe"
  }
]
output application/json
---
firstInput map (firstInputValue) -> using (id = firstInputValue.bookId)
  {
    theValue : id as Number,
    theTitle: firstInputValue.title,
    thePrice: firstInputValue.price as Number,
    (secondInput filter ($.*bookId contains id)  map (secondInputValue) -> {
      theAuthor : secondInputValue.author
    })
  }
```

Output JSON:

```json
[
  {
    "theValue": 101,
    "theTitle": "world history",
    "thePrice": 19.99,
    "theAuthor": "john doe"
  },
  {
    "theValue": 202,
    "theTitle": "the great outdoors",
    "thePrice": 15.99,
    "theAuthor": "jane doe"
  }
]
```

Both scripts produce the same output.

## Related Examples

- [Extract Data](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-extract-data)

- [Reference Multiple Inputs](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-reference-multiple-inputs)

- [Zip Arrays Together](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-zip-arrays-together)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.6/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook)

<!-- document id=7d99994bddb8ff0a958431b797bc0a956e0ead385f99101d97af9c999e8593d8 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook-merge-multiple-payloads.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, transform, transformer, format, aggregate, filter, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, contains, as
---

# Merge Fields from Separate Objects

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The DataWeave examples merge fields from separate input arrays. The first (`firstInput`) is a
DataWeave variable that lists price by book ID, and the second (`secondInput`) lists authors by book
ID. Each book has a unique `bookId` key.

The DataWeave scripts produce the same output. Both scripts use two `map` functions with a filter,
and one of them also creates an alias for the `bookId`:

- The first `map` function iterates over the elements of the `firstInput` array. As the function
  evaluates each element, a second `map` function uses a filter to identify any elements in the
  second array (`secondInput`) that match the `filter` criteria
  (`secondInput filter ($.*bookId contains firstInputValue.bookId)`). The filter returns an element
  from `secondInput` that contains a `bookId` value that matches the `bookId` value in the
  `firstInput` element.

- The second `map` function evaluates that filtered element and then uses `secondInputValue.author`
  to select and populate the value of its `"author"` field in the object
  `{author : secondInputValue.author}`.

- `filter` limits the scope of the second `map` function to objects in the `secondInput` that share
  the same `bookId`.

DataWeave Script:

```dataweave
%dw 2.0
var firstInput = [
  { "bookId":"101",
    "title":"world history",
    "price":"19.99"
  },
  {
    "bookId":"202",
    "title":"the great outdoors",
    "price":"15.99"
  }
]
var secondInput = [
  {
    "bookId":"101",
    "author":"john doe"
  },
  {
    "bookId":"202",
    "author":"jane doe"
  }
]
output application/json
---
firstInput map (firstInputValue) ->
  {
    theId : firstInputValue.bookId as Number,
    theTitle: firstInputValue.title,
    thePrice: firstInputValue.price as Number,
    (secondInput filter ($.*bookId contains firstInputValue.bookId) map (secondInputValue) -> {
      theAuthor : secondInputValue.author
    })
  }
```

Output JSON:

```json
[
  {
    "theId": 101,
    "theTitle": "world history",
    "thePrice": 19.99,
    "theAuthor": "john doe"
  },
  {
    "theId": 202,
    "theTitle": "the great outdoors",
    "thePrice": 15.99,
    "theAuthor": "jane doe"
  }
]
```

As the next script shows, you can also write the same script using an `id` alias (created with
`using (id = firstInputValue.bookId)`). The alias replaces the selector expression,
`firstInputValue.bookId`, which is longer.

DataWeave Script:

```dataweave
%dw 2.0
var firstInput = [
  { "bookId":"101",
    "title":"world history",
    "price":"19.99"
  },
  {
    "bookId":"202",
    "title":"the great outdoors",
    "price":"15.99"
  }
]
var secondInput = [
  {
    "bookId":"101",
    "author":"john doe"
  },
  {
    "bookId":"202",
    "author":"jane doe"
  }
]
output application/json
---
firstInput map (firstInputValue) -> using (id = firstInputValue.bookId)
  {
    theValue : id as Number,
    theTitle: firstInputValue.title,
    thePrice: firstInputValue.price as Number,
    (secondInput filter ($.*bookId contains id)  map (secondInputValue) -> {
      theAuthor : secondInputValue.author
    })
  }
```

Output JSON:

```json
[
  {
    "theValue": 101,
    "theTitle": "world history",
    "thePrice": 19.99,
    "theAuthor": "john doe"
  },
  {
    "theValue": 202,
    "theTitle": "the great outdoors",
    "thePrice": 15.99,
    "theAuthor": "jane doe"
  }
]
```

Both scripts produce the same output.

## Related Examples

- [Extract Data](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-extract-data)

- [Reference Multiple Inputs](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-reference-multiple-inputs)

- [Zip Arrays Together](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-zip-arrays-together)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.9/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook)

<!-- document id=f25b5375018979169d0072abeee5832df3245f9e690e2f34cbc9cbeacbcd7881 url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook-merge-multiple-payloads.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, transform, transformer, format, aggregate, filter, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, contains, as
---

# Merge Fields from Separate Objects

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The DataWeave examples merge fields from separate input arrays. The first (`firstInput`) is a
DataWeave variable that lists price by book ID, and the second (`secondInput`) lists authors by book
ID. Each book has a unique `bookId` key.

The DataWeave scripts produce the same output. Both scripts use two `map` functions with a filter,
and one of them also creates an alias for the `bookId`:

- The first `map` function iterates over the elements of the `firstInput` array. As the function
  evaluates each element, a second `map` function uses a filter to identify any elements in the
  second array (`secondInput`) that match the `filter` criteria
  (`secondInput filter ($.*bookId contains firstInputValue.bookId)`). The filter returns an element
  from `secondInput` that contains a `bookId` value that matches the `bookId` value in the
  `firstInput` element.

- The second `map` function evaluates that filtered element and then uses `secondInputValue.author`
  to select and populate the value of its `"author"` field in the object
  `{author : secondInputValue.author}`.

- `filter` limits the scope of the second `map` function to objects in the `secondInput` that share
  the same `bookId`.

DataWeave Script:

```dataweave
%dw 2.0
var firstInput = [
  { "bookId":"101",
    "title":"world history",
    "price":"19.99"
  },
  {
    "bookId":"202",
    "title":"the great outdoors",
    "price":"15.99"
  }
]
var secondInput = [
  {
    "bookId":"101",
    "author":"john doe"
  },
  {
    "bookId":"202",
    "author":"jane doe"
  }
]
output application/json
---
firstInput map (firstInputValue) ->
  {
    theId : firstInputValue.bookId as Number,
    theTitle: firstInputValue.title,
    thePrice: firstInputValue.price as Number,
    (secondInput filter ($.*bookId contains firstInputValue.bookId) map (secondInputValue) -> {
      theAuthor : secondInputValue.author
    })
  }
```

Output JSON:

```json
[
  {
    "theId": 101,
    "theTitle": "world history",
    "thePrice": 19.99,
    "theAuthor": "john doe"
  },
  {
    "theId": 202,
    "theTitle": "the great outdoors",
    "thePrice": 15.99,
    "theAuthor": "jane doe"
  }
]
```

As the next script shows, you can also write the same script using an `id` alias (created with
`using (id = firstInputValue.bookId)`). The alias replaces the selector expression,
`firstInputValue.bookId`, which is longer.

DataWeave Script:

```dataweave
%dw 2.0
var firstInput = [
  { "bookId":"101",
    "title":"world history",
    "price":"19.99"
  },
  {
    "bookId":"202",
    "title":"the great outdoors",
    "price":"15.99"
  }
]
var secondInput = [
  {
    "bookId":"101",
    "author":"john doe"
  },
  {
    "bookId":"202",
    "author":"jane doe"
  }
]
output application/json
---
firstInput map (firstInputValue) -> using (id = firstInputValue.bookId)
  {
    theValue : id as Number,
    theTitle: firstInputValue.title,
    thePrice: firstInputValue.price as Number,
    (secondInput filter ($.*bookId contains id)  map (secondInputValue) -> {
      theAuthor : secondInputValue.author
    })
  }
```

Output JSON:

```json
[
  {
    "theValue": 101,
    "theTitle": "world history",
    "thePrice": 19.99,
    "theAuthor": "john doe"
  },
  {
    "theValue": 202,
    "theTitle": "the great outdoors",
    "thePrice": 15.99,
    "theAuthor": "jane doe"
  }
]
```

Both scripts produce the same output.

## Related Examples

- [Extract Data](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-extract-data)

- [Reference Multiple Inputs](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-reference-multiple-inputs)

- [Zip Arrays Together](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-zip-arrays-together)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook)

<!-- document id=c4e2bd434e8b40154b8f0c7be71417674f6ca55aaadf770cfb6f3534a90ea96b url=/mulesoft/current/en-us/dataweave/2.11/dw-objects-functions-mergewith.md -->

---
product: DataWeave
version: 2.11
---

# mergeWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## mergeWith<T <: Object, V <: Object>(source: T, target: V): ?

Appends any key-value pairs from a source object to a target object.

If source and target objects have the same key, the function appends that source object to the
target and removes that target object from the output.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The object to append to the <code>target</code>.</p></td></tr><tr><td><p><code>target</code></p></td><td><p>The object to which the <code>source</code> object is appended.</p></td></tr></tbody></table>

### Example

This example appends the source objects to the target. Notice that `"a" : true,` is removed from the
output, and `"a" : false` is appended to the target.

#### Source

```DataWeave
%dw 2.0
import mergeWith from dw::core::Objects
output application/json
---
{ "mergeWith" : { "a" : true, "b" : 1} mergeWith { "a" : false, "c" : "Test"} }
```

#### Output

```JSON
"mergeWith": {
    "b": 1,
    "a": false,
    "c": "Test"
}
```

## mergeWith<T <: Object>(a: Null, b: T): T

Helper function that enables `mergeWith` to work with a `null` value.

## mergeWith<T <: Object>(a: T, b: Null): T

Helper function that enables `mergeWith` to work with a `null` value.

<!-- document id=7bec4b8d505842703ee7e9252965f660b8900e2a9324c5be454432ce4d95abbd url=/mulesoft/current/en-us/dataweave/2.12/dw-objects-functions-mergewith.md -->

---
product: DataWeave
version: 2.12
---

# mergeWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## mergeWith<T <: Object, V <: Object>(source: T, target: V): ?

Appends any key-value pairs from a source object to a target object.

If source and target objects have the same key, the function appends that source object to the
target and removes that target object from the output.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The object to append to the <code>target</code>.</p></td></tr><tr><td><p><code>target</code></p></td><td><p>The object to which the <code>source</code> object is appended.</p></td></tr></tbody></table>

### Example

This example appends the source objects to the target. Notice that `"a" : true,` is removed from the
output, and `"a" : false` is appended to the target.

#### Source

```DataWeave
%dw 2.0
import mergeWith from dw::core::Objects
output application/json
---
{ "mergeWith" : { "a" : true, "b" : 1} mergeWith { "a" : false, "c" : "Test"} }
```

#### Output

```JSON
"mergeWith": {
    "b": 1,
    "a": false,
    "c": "Test"
}
```

## mergeWith<T <: Object>(a: Null, b: T): T

Helper function that enables `mergeWith` to work with a `null` value.

## mergeWith<T <: Object>(a: T, b: Null): T

Helper function that enables `mergeWith` to work with a `null` value.

<!-- document id=3c637c61cf58564753ae182c8ae93d7db4ea0a7835dada7353e7b15dfd1ca3fe url=/mulesoft/current/en-us/dataweave/2.3/dw-objects-functions-mergewith.md -->

---
product: DataWeave
version: 2.3
---

# mergeWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## mergeWith(T, V): ?

Appends any key-value pairs from a source object to a target object.

If source and target objects have the same key, the function appends that source object to the
target and removes that target object from the output.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The object to append to the <code>target</code>.</p></td></tr><tr><td><p><code>target</code></p></td><td><p>The object to which the <code>source</code> object is appended.</p></td></tr></tbody></table>

### Example

This example appends the source objects to the target. Notice that `"a" : true,` is removed from the
output, and `"a" : false` is appended to the target.

#### Source

```DataWeave
%dw 2.0
import mergeWith from dw::core::Objects
output application/json
---
{ "mergeWith" : { "a" : true, "b" : 1} mergeWith { "a" : false, "c" : "Test"} }
```

#### Output

```JSON
"mergeWith": {
    "b": 1,
    "a": false,
    "c": "Test"
}
```

## mergeWith(Null, T): T

Helper function that enables `mergeWith` to work with a `null` value.

## mergeWith(T, Null): T

Helper function that enables `mergeWith` to work with a `null` value.

<!-- document id=58bcee7e0c1be53f3e9161a85af3dc269756f0089a24f0fdf196e19482a8e281 url=/mulesoft/current/en-us/dataweave/2.4/dw-objects-functions-mergewith.md -->

---
product: DataWeave
version: 2.4
---

# mergeWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## mergeWith<T <: Object, V <: Object>(source: T, target: V): ?

Appends any key-value pairs from a source object to a target object.

If source and target objects have the same key, the function appends that source object to the
target and removes that target object from the output.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The object to append to the <code>target</code>.</p></td></tr><tr><td><p><code>target</code></p></td><td><p>The object to which the <code>source</code> object is appended.</p></td></tr></tbody></table>

### Example

This example appends the source objects to the target. Notice that `"a" : true,` is removed from the
output, and `"a" : false` is appended to the target.

#### Source

```DataWeave
%dw 2.0
import mergeWith from dw::core::Objects
output application/json
---
{ "mergeWith" : { "a" : true, "b" : 1} mergeWith { "a" : false, "c" : "Test"} }
```

#### Output

```JSON
"mergeWith": {
    "b": 1,
    "a": false,
    "c": "Test"
}
```

## mergeWith<T <: Object>(a: Null, b: T): T

Helper function that enables `mergeWith` to work with a `null` value.

## mergeWith<T <: Object>(a: T, b: Null): T

Helper function that enables `mergeWith` to work with a `null` value.

<!-- document id=acd7bb05d485e1883e1bcb071ce4a7ab262593a79de565b913737152c35dc96e url=/mulesoft/current/en-us/dataweave/2.6/dw-objects-functions-mergewith.md -->

---
product: DataWeave
version: 2.6
---

# mergeWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## mergeWith<T <: Object, V <: Object>(source: T, target: V): ?

Appends any key-value pairs from a source object to a target object.

If source and target objects have the same key, the function appends that source object to the
target and removes that target object from the output.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The object to append to the <code>target</code>.</p></td></tr><tr><td><p><code>target</code></p></td><td><p>The object to which the <code>source</code> object is appended.</p></td></tr></tbody></table>

### Example

This example appends the source objects to the target. Notice that `"a" : true,` is removed from the
output, and `"a" : false` is appended to the target.

#### Source

```DataWeave
%dw 2.0
import mergeWith from dw::core::Objects
output application/json
---
{ "mergeWith" : { "a" : true, "b" : 1} mergeWith { "a" : false, "c" : "Test"} }
```

#### Output

```JSON
"mergeWith": {
    "b": 1,
    "a": false,
    "c": "Test"
}
```

## mergeWith<T <: Object>(a: Null, b: T): T

Helper function that enables `mergeWith` to work with a `null` value.

## mergeWith<T <: Object>(a: T, b: Null): T

Helper function that enables `mergeWith` to work with a `null` value.

<!-- document id=494ecb6b521bc4107795fc2b72719969ece53396dcd9216da5aaa140a730e23b url=/mulesoft/current/en-us/dataweave/2.9/dw-objects-functions-mergewith.md -->

---
product: DataWeave
version: 2.9
---

# mergeWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## mergeWith<T <: Object, V <: Object>(source: T, target: V): ?

Appends any key-value pairs from a source object to a target object.

If source and target objects have the same key, the function appends that source object to the
target and removes that target object from the output.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The object to append to the <code>target</code>.</p></td></tr><tr><td><p><code>target</code></p></td><td><p>The object to which the <code>source</code> object is appended.</p></td></tr></tbody></table>

### Example

This example appends the source objects to the target. Notice that `"a" : true,` is removed from the
output, and `"a" : false` is appended to the target.

#### Source

```DataWeave
%dw 2.0
import mergeWith from dw::core::Objects
output application/json
---
{ "mergeWith" : { "a" : true, "b" : 1} mergeWith { "a" : false, "c" : "Test"} }
```

#### Output

```JSON
"mergeWith": {
    "b": 1,
    "a": false,
    "c": "Test"
}
```

## mergeWith<T <: Object>(a: Null, b: T): T

Helper function that enables `mergeWith` to work with a `null` value.

## mergeWith<T <: Object>(a: T, b: Null): T

Helper function that enables `mergeWith` to work with a `null` value.

<!-- document id=65440a6cbad53cd13de4f3dc95f5f8f970ceee8620196c94a40e341289b187de url=/mulesoft/current/en-us/dataweave/latest/dw-objects-functions-mergewith.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# mergeWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## mergeWith<T <: Object, V <: Object>(source: T, target: V): ?

Appends any key-value pairs from a source object to a target object.

If source and target objects have the same key, the function appends that source object to the
target and removes that target object from the output.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>source</code></p></td><td><p>The object to append to the <code>target</code>.</p></td></tr><tr><td><p><code>target</code></p></td><td><p>The object to which the <code>source</code> object is appended.</p></td></tr></tbody></table>

### Example

This example appends the source objects to the target. Notice that `"a" : true,` is removed from the
output, and `"a" : false` is appended to the target.

#### Source

```DataWeave
%dw 2.0
import mergeWith from dw::core::Objects
output application/json
---
{ "mergeWith" : { "a" : true, "b" : 1} mergeWith { "a" : false, "c" : "Test"} }
```

#### Output

```JSON
"mergeWith": {
    "b": 1,
    "a": false,
    "c": "Test"
}
```

## mergeWith<T <: Object>(a: Null, b: T): T

Helper function that enables `mergeWith` to work with a `null` value.

## mergeWith<T <: Object>(a: T, b: Null): T

Helper function that enables `mergeWith` to work with a `null` value.

<!-- document id=36cf590e442e7dff6b5142001c00a2a5ea2ee0d480cf472e029edf02b2424e15 url=/mulesoft/current/en-us/dataweave/2.11/dw-types-functions-metadataof.md -->

---
product: DataWeave
version: 2.11
---

# metadataOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## metadataOf(t: Type): Object

Returns metadata that is attached to the given type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `metadataOf` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = String {format: "YYYY-MM-dd"}
output application/json
---
{
   a: metadataOf(AType)
}
```

#### Output

```Json
{
  "a": {"format": "YYYY-MM-dd"}
}
```

<!-- document id=ba18f8eaab1130e1c7d00892febe0dd0c236afc279b78a1c53dd8074538f0e9c url=/mulesoft/current/en-us/dataweave/2.12/dw-types-functions-metadataof.md -->

---
product: DataWeave
version: 2.12
---

# metadataOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## metadataOf(t: Type): Object

Returns metadata that is attached to the given type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `metadataOf` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = String {format: "YYYY-MM-dd"}
output application/json
---
{
   a: metadataOf(AType)
}
```

#### Output

```Json
{
  "a": {"format": "YYYY-MM-dd"}
}
```

<!-- document id=baffb23a3110ae0dae723efa8bd442a0eb568323b6873c25fecb8e900eea5582 url=/mulesoft/current/en-us/dataweave/2.3/dw-types-functions-metadataof.md -->

---
product: DataWeave
version: 2.3
---

# metadataOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## metadataOf(Type): Object

Returns metadata that is attached to the given type.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>t</p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `metadataOf` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = String {format: "YYYY-MM-dd"}
output application/json
---
{
   a: metadataOf(AType)
}
```

#### Output

```Json
{
  "a": {"format": "YYYY-MM-dd"}
}
```

<!-- document id=3bfb4d327b3c72abeae23f5bd48f5e8be7d12fe26f147ade3ed798ebe375698e url=/mulesoft/current/en-us/dataweave/2.4/dw-types-functions-metadataof.md -->

---
product: DataWeave
version: 2.4
---

# metadataOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## metadataOf(t: Type): Object

Returns metadata that is attached to the given type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `metadataOf` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = String {format: "YYYY-MM-dd"}
output application/json
---
{
   a: metadataOf(AType)
}
```

#### Output

```Json
{
  "a": {"format": "YYYY-MM-dd"}
}
```

<!-- document id=f0127d57af7a6c38739a8c0c5d0b52a973bae3d2ef95975161ca2cae53953bcf url=/mulesoft/current/en-us/dataweave/2.6/dw-types-functions-metadataof.md -->

---
product: DataWeave
version: 2.6
---

# metadataOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## metadataOf(t: Type): Object

Returns metadata that is attached to the given type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `metadataOf` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = String {format: "YYYY-MM-dd"}
output application/json
---
{
   a: metadataOf(AType)
}
```

#### Output

```Json
{
  "a": {"format": "YYYY-MM-dd"}
}
```

<!-- document id=7d07d87c672471a260687d446a479d0718cea1c9b5a8418b437267c53d1ed91b url=/mulesoft/current/en-us/dataweave/2.9/dw-types-functions-metadataof.md -->

---
product: DataWeave
version: 2.9
---

# metadataOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## metadataOf(t: Type): Object

Returns metadata that is attached to the given type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `metadataOf` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = String {format: "YYYY-MM-dd"}
output application/json
---
{
   a: metadataOf(AType)
}
```

#### Output

```Json
{
  "a": {"format": "YYYY-MM-dd"}
}
```

<!-- document id=686e633ff9e37e54b5b7d363e30b03ae937211e225675b5fecab8ebdbe83e1af url=/mulesoft/current/en-us/dataweave/latest/dw-types-functions-metadataof.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# metadataOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## metadataOf(t: Type): Object

Returns metadata that is attached to the given type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `metadataOf` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = String {format: "YYYY-MM-dd"}
output application/json
---
{
   a: metadataOf(AType)
}
```

#### Output

```Json
{
  "a": {"format": "YYYY-MM-dd"}
}
```

<!-- document id=40f1052a8a644c775dd4e71be2555c51b6870febcde805ed196df9e065bb1eeb url=/mulesoft/current/en-us/dataweave/2.11/dw-mime.md -->

---
product: DataWeave
version: 2.11
---

# Mime (dw::module::Mime)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions for working with MIME type.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::module::Mime` to the header of your DataWeave script.

_Introduced in DataWeave version 2.7.0._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-mime-functions-fromstring">fromString</a></p></td><td><p>Transforms a MIME type string value representation to a <code>MimeType</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-mime-functions-ishandledby">isHandledBy</a></p></td><td><p>Returns <code>true</code> if the given <code>MimeType</code> value is handled by the base <code>MimeType</code> value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-mime-functions-tostring">toString</a></p></td><td><p>Transforms a <code>MimeType</code> value to a string representation.</p></td></tr></tbody></table>

## Types

- [Mime Types](https://docs.mulesoft.com/dataweave/2.11/dw-mime-types)

<!-- document id=8a4eb533cbf26b21b02409e90db66548d18849eeabb8162aa9d6c1c5e6fd8d3b url=/mulesoft/current/en-us/dataweave/2.12/dw-mime.md -->

---
product: DataWeave
version: 2.12
---

# Mime (dw::module::Mime)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions for working with MIME type.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::module::Mime` to the header of your DataWeave script.

_Introduced in DataWeave version 2.7.0._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-mime-functions-fromstring">fromString</a></p></td><td><p>Transforms a MIME type string value representation to a <code>MimeType</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-mime-functions-ishandledby">isHandledBy</a></p></td><td><p>Returns <code>true</code> if the given <code>MimeType</code> value is handled by the base <code>MimeType</code> value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-mime-functions-tostring">toString</a></p></td><td><p>Transforms a <code>MimeType</code> value to a string representation.</p></td></tr></tbody></table>

## Types

- [Mime Types](https://docs.mulesoft.com/dataweave/2.12/dw-mime-types)

<!-- document id=69363c1044e833a818ad95aa7243dc466d26013b4b2fbe1409b3e6f56644d401 url=/mulesoft/current/en-us/dataweave/2.9/dw-mime.md -->

---
product: DataWeave
version: 2.9
---

# Mime (dw::module::Mime)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions for working with MIME type.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::module::Mime` to the header of your DataWeave script.

_Introduced in DataWeave version 2.7.0._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-mime-functions-fromstring">fromString</a></p></td><td><p>Transforms a MIME type string value representation to a <code>MimeType</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-mime-functions-ishandledby">isHandledBy</a></p></td><td><p>Returns <code>true</code> if the given <code>MimeType</code> value is handled by the base <code>MimeType</code> value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-mime-functions-tostring">toString</a></p></td><td><p>Transforms a <code>MimeType</code> value to a string representation.</p></td></tr></tbody></table>

## Types

- [Mime Types](https://docs.mulesoft.com/dataweave/2.9/dw-mime-types)

<!-- document id=5b2b3f7d084418be7a281e5970b66903a99cb5ee750c64f8e1db885deed83d8d url=/mulesoft/current/en-us/dataweave/latest/dw-mime.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Mime (dw::module::Mime)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions for working with MIME type.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::module::Mime` to the header of your DataWeave script.

_Introduced in DataWeave version 2.7.0._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-mime-functions-fromstring">fromString</a></p></td><td><p>Transforms a MIME type string value representation to a <code>MimeType</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-mime-functions-ishandledby">isHandledBy</a></p></td><td><p>Returns <code>true</code> if the given <code>MimeType</code> value is handled by the base <code>MimeType</code> value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-mime-functions-tostring">toString</a></p></td><td><p>Transforms a <code>MimeType</code> value to a string representation.</p></td></tr></tbody></table>

## Types

- [Mime Types](https://docs.mulesoft.com/dataweave/latest/dw-mime-types)

<!-- document id=c3e8c60ee1cade1c43337e7fbdea2f7575e8f69fdd6f633cd2c3b9ac824ee7d1 url=/mulesoft/current/en-us/dataweave/2.11/dw-mime-types.md -->

---
product: DataWeave
version: 2.11
---

# Mime Types (dw::module::Mime)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>MimeType</p></td><td><div><div><p><code>type MimeType = { "type": String, subtype: String, parameters: MimeTypeParameter }</code></p></div></div></td><td><div><div><p>DataWeave type for representing a MIME type. Supports the following fields:</p></div><div><ul><li><p><code>type</code>: Represents the general category into which the data type falls, such as 'video' or 'text'.</p></li><li><p><code>subtype</code>: Identifies the exact kind of data of the specified type the MIME type represents.</p></li><li><p><code>parameters</code>: Parameters attached to the MIME type.</p></li></ul></div><div><p><em>Introduced in DataWeave version 2.7.0.</em></p></div></div></td></tr><tr><td><p>MimeTypeError</p></td><td><div><div><p><code>type MimeTypeError = { message: String }</code></p></div></div></td><td><div><div><p>DataWeave type of the data that returns when a <code>fromString</code> function fails. Supports the following fields:</p></div><div><ul><li><p><code>message</code>: The error message.</p></li></ul></div><div><p><em>Introduced in DataWeave version 2.7.0.</em></p></div></div></td></tr><tr><td><p>MimeTypeParameter</p></td><td><div><div><p><code>type MimeTypeParameter = { _?: String }</code></p></div></div></td><td><div><div><p>DataWeave type for representing a MIME type parameter.</p></div><div><p><em>Introduced in DataWeave version 2.7.0.</em></p></div></div></td></tr></tbody></table>

<!-- document id=62d3885fdf0716ceca860d39b3d57f3789debbc28e4d47340182889b7747ea44 url=/mulesoft/current/en-us/dataweave/2.12/dw-mime-types.md -->

---
product: DataWeave
version: 2.12
---

# Mime Types (dw::module::Mime)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>MimeType</p></td><td><div><div><p><code>type MimeType = { "type": String, subtype: String, parameters: MimeTypeParameter }</code></p></div></div></td><td><div><div><p>DataWeave type for representing a MIME type. Supports the following fields:</p></div><div><ul><li><p><code>type</code>: Represents the general category into which the data type falls, such as 'video' or 'text'.</p></li><li><p><code>subtype</code>: Identifies the exact kind of data of the specified type the MIME type represents.</p></li><li><p><code>parameters</code>: Parameters attached to the MIME type.</p></li></ul></div><div><p><em>Introduced in DataWeave version 2.7.0.</em></p></div></div></td></tr><tr><td><p>MimeTypeError</p></td><td><div><div><p><code>type MimeTypeError = { message: String }</code></p></div></div></td><td><div><div><p>DataWeave type of the data that returns when a <code>fromString</code> function fails. Supports the following fields:</p></div><div><ul><li><p><code>message</code>: The error message.</p></li></ul></div><div><p><em>Introduced in DataWeave version 2.7.0.</em></p></div></div></td></tr><tr><td><p>MimeTypeParameter</p></td><td><div><div><p><code>type MimeTypeParameter = { _?: String }</code></p></div></div></td><td><div><div><p>DataWeave type for representing a MIME type parameter.</p></div><div><p><em>Introduced in DataWeave version 2.7.0.</em></p></div></div></td></tr></tbody></table>

<!-- document id=b08aefba504b39ee497af1262f380adc8e1e403b708b6cdfc404ac464700bc56 url=/mulesoft/current/en-us/dataweave/2.9/dw-mime-types.md -->

---
product: DataWeave
version: 2.9
---

# Mime Types (dw::module::Mime)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>MimeType</p></td><td><div><div><p><code>type MimeType = { "type": String, subtype: String, parameters: MimeTypeParameter }</code></p></div></div></td><td><div><div><p>DataWeave type for representing a MIME type. Supports the following fields:</p></div><div><ul><li><p><code>type</code>: Represents the general category into which the data type falls, such as 'video' or 'text'.</p></li><li><p><code>subtype</code>: Identifies the exact kind of data of the specified type the MIME type represents.</p></li><li><p><code>parameters</code>: Parameters attached to the MIME type.</p></li></ul></div><div><p><em>Introduced in DataWeave version 2.7.0.</em></p></div></div></td></tr><tr><td><p>MimeTypeError</p></td><td><div><div><p><code>type MimeTypeError = { message: String }</code></p></div></div></td><td><div><div><p>DataWeave type of the data that returns when a <code>fromString</code> function fails. Supports the following fields:</p></div><div><ul><li><p><code>message</code>: The error message.</p></li></ul></div><div><p><em>Introduced in DataWeave version 2.7.0.</em></p></div></div></td></tr><tr><td><p>MimeTypeParameter</p></td><td><div><div><p><code>type MimeTypeParameter = { _?: String }</code></p></div></div></td><td><div><div><p>DataWeave type for representing a MIME type parameter.</p></div><div><p><em>Introduced in DataWeave version 2.7.0.</em></p></div></div></td></tr></tbody></table>

<!-- document id=6bd287b431aba21f3a57da48511eaefda359779cc42735b91fcec68b4bc298fb url=/mulesoft/current/en-us/dataweave/latest/dw-mime-types.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Mime Types (dw::module::Mime)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>MimeType</p></td><td><div><div><p><code>type MimeType = { "type": String, subtype: String, parameters: MimeTypeParameter }</code></p></div></div></td><td><div><div><p>DataWeave type for representing a MIME type. Supports the following fields:</p></div><div><ul><li><p><code>type</code>: Represents the general category into which the data type falls, such as 'video' or 'text'.</p></li><li><p><code>subtype</code>: Identifies the exact kind of data of the specified type the MIME type represents.</p></li><li><p><code>parameters</code>: Parameters attached to the MIME type.</p></li></ul></div><div><p><em>Introduced in DataWeave version 2.7.0.</em></p></div></div></td></tr><tr><td><p>MimeTypeError</p></td><td><div><div><p><code>type MimeTypeError = { message: String }</code></p></div></div></td><td><div><div><p>DataWeave type of the data that returns when a <code>fromString</code> function fails. Supports the following fields:</p></div><div><ul><li><p><code>message</code>: The error message.</p></li></ul></div><div><p><em>Introduced in DataWeave version 2.7.0.</em></p></div></div></td></tr><tr><td><p>MimeTypeParameter</p></td><td><div><div><p><code>type MimeTypeParameter = { _?: String }</code></p></div></div></td><td><div><div><p>DataWeave type for representing a MIME type parameter.</p></div><div><p><em>Introduced in DataWeave version 2.7.0.</em></p></div></div></td></tr></tbody></table>

<!-- document id=8db244a361aaac24fa84322609d51f7f905e1215002fba09ac53666f290415af url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-min.md -->

---
product: DataWeave
version: 2.11
---

# min

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## min<T <: Comparable>(@StreamCapable values: Array<T>): T | Null

Returns the lowest `Comparable` value in an array.

The items must be of the same type or `min` throws an error. The function returns `null` if the
array is empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>values</code></p></td><td><p>The input array. The elements in the array can be any supported type.</p></td></tr></tbody></table>

### Example

This example returns the lowest numeric value of each input array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ a: min([1, 1000]), b: min([1, 2, 3]), c: min([1.5, 2.5, 3.5]) }
```

#### Output

```JSON
{ "a": 1, "b": 1, "c": 1.5 }
```

<!-- document id=33c493293e9c8a27c71cd4830875d1ddb0dd00f484bf3c50713e019c0691c27a url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-min.md -->

---
product: DataWeave
version: 2.12
---

# min

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## min<T <: Comparable>(@StreamCapable values: Array<T>): T | Null

Returns the lowest `Comparable` value in an array.

The items must be of the same type or `min` throws an error. The function returns `null` if the
array is empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>values</code></p></td><td><p>The input array. The elements in the array can be any supported type.</p></td></tr></tbody></table>

### Example

This example returns the lowest numeric value of each input array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ a: min([1, 1000]), b: min([1, 2, 3]), c: min([1.5, 2.5, 3.5]) }
```

#### Output

```JSON
{ "a": 1, "b": 1, "c": 1.5 }
```

<!-- document id=4df5839f6d977d8b4713f622492cb6957071e284bf9e271e3fda01d432ba0c3c url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-min.md -->

---
product: DataWeave
version: 2.3
---

# min

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## min(Array<T>): T | Null

Returns the lowest `Comparable` value in an array.

The items must be of the same type or `min` throws an error. The function returns `null` if the
array is empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>values</code></p></td><td><p>The input array. The elements in the array can be any supported type.</p></td></tr></tbody></table>

### Example

This example returns the lowest numeric value of each input array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ a: min([1, 1000]), b: min([1, 2, 3]), c: min([1.5, 2.5, 3.5]) }
```

#### Output

```JSON
{ "a": 1, "b": 1, "c": 1.5 }
```

<!-- document id=c6a99a664257f7ac89a180e585595012786663876401c01aa67b1adc98d4909f url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-min.md -->

---
product: DataWeave
version: 2.4
---

# min

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## min<T <: Comparable>(@StreamCapable values: Array<T>): T | Null

Returns the lowest `Comparable` value in an array.

The items must be of the same type or `min` throws an error. The function returns `null` if the
array is empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>values</code></p></td><td><p>The input array. The elements in the array can be any supported type.</p></td></tr></tbody></table>

### Example

This example returns the lowest numeric value of each input array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ a: min([1, 1000]), b: min([1, 2, 3]), c: min([1.5, 2.5, 3.5]) }
```

#### Output

```JSON
{ "a": 1, "b": 1, "c": 1.5 }
```

<!-- document id=8b862f95993e009427742219064835744a7e80691d7a0f5d28019909b2196af8 url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-min.md -->

---
product: DataWeave
version: 2.6
---

# min

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## min<T <: Comparable>(@StreamCapable values: Array<T>): T | Null

Returns the lowest `Comparable` value in an array.

The items must be of the same type or `min` throws an error. The function returns `null` if the
array is empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>values</code></p></td><td><p>The input array. The elements in the array can be any supported type.</p></td></tr></tbody></table>

### Example

This example returns the lowest numeric value of each input array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ a: min([1, 1000]), b: min([1, 2, 3]), c: min([1.5, 2.5, 3.5]) }
```

#### Output

```JSON
{ "a": 1, "b": 1, "c": 1.5 }
```

<!-- document id=2b28b1f2a46a7a37bafaa0a12a4b94a6e2b257dace7def477fc519a7e4b6edf8 url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-min.md -->

---
product: DataWeave
version: 2.9
---

# min

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## min<T <: Comparable>(@StreamCapable values: Array<T>): T | Null

Returns the lowest `Comparable` value in an array.

The items must be of the same type or `min` throws an error. The function returns `null` if the
array is empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>values</code></p></td><td><p>The input array. The elements in the array can be any supported type.</p></td></tr></tbody></table>

### Example

This example returns the lowest numeric value of each input array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ a: min([1, 1000]), b: min([1, 2, 3]), c: min([1.5, 2.5, 3.5]) }
```

#### Output

```JSON
{ "a": 1, "b": 1, "c": 1.5 }
```

<!-- document id=4536841ac47e212ba5df5f2e6a2e9d5f2eea2e1724f4f912529568dda2e56dfd url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-min.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# min

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## min<T <: Comparable>(@StreamCapable values: Array<T>): T | Null

Returns the lowest `Comparable` value in an array.

The items must be of the same type or `min` throws an error. The function returns `null` if the
array is empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>values</code></p></td><td><p>The input array. The elements in the array can be any supported type.</p></td></tr></tbody></table>

### Example

This example returns the lowest numeric value of each input array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ a: min([1, 1000]), b: min([1, 2, 3]), c: min([1.5, 2.5, 3.5]) }
```

#### Output

```JSON
{ "a": 1, "b": 1, "c": 1.5 }
```

<!-- document id=dd9cd9b9dcdbbbf451f20262edc339c5b61594282be0816573c02bcaf186b57d url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-minby.md -->

---
product: DataWeave
version: 2.11
---

# minBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## minBy<T>(@StreamCapable array: Array<T>, criteria: (item: T) -> Comparable): T | Null

Iterates over an array to return the lowest value of comparable elements from it.

The items need to be of the same type. `minBy` returns an error if they are not, and it returns null
when the array is empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>item</code></p></td><td><p>Element in the input array (of type <code>Number</code>, <code>Boolean</code>, <code>DateTime</code>, <code>LocalDateTime</code>, <code>Date</code>, <code>LocalTime</code>, <code>Time</code>, or <code>TimeZone</code>). Can be referenced with <code>$</code>.</p></td></tr></tbody></table>

### Example

This example returns the lowest numeric value within objects (key-value pairs) in an array. Notice
that it uses `item.a` to select the value of the object. You can also write the same expression like
this, using an anonymous parameter: `[ { "a" : 1 }, { "a" : 3 }, { "a" : 2 } ] minBy $.a`

#### Source

```DataWeave
%dw 2.0
output  application/json
---
[ { "a" : 1 }, { "a" : 2 }, { "a" : 3 } ] minBy (item) -> item.a
```

#### Output

```JSON
{ "a" : 1 }
```

### Example

This example gets the latest `DateTime`, `Date`, and `Time` from inputs defined in the variables
`myDateTime1` and `myDateTime2`. It also shows that the function returns null on an empty array.

#### Source

```DataWeave
%dw 2.0
var myDateTime1 = "2017-10-01T22:57:59-03:00"
var myDateTime2 = "2018-10-01T23:57:59-03:00"
output application/json
---
{
  myMinBy: {
    byDateTime: [ myDateTime1, myDateTime2 ] minBy ((item) -> item),
    byDate: [ myDateTime1 as Date, myDateTime2 as Date ] minBy ((item) -> item),
    byTime: [ myDateTime1 as Time, myDateTime2 as Time ] minBy ((item) -> item),
    aBoolean: [ true, false, (0 > 1), (1 > 0) ] minBy $,
    emptyArray: [] minBy ((item) -> item)
  }
}
```

#### Output

```JSON
{
  "myMinBy": {
    "byDateTime": "2017-10-01T22:57:59-03:00",
    "byDate": "2017-10-01",
    "byTime": "22:57:59-03:00",
    "aBoolean": false,
    "emptyArray": null
  }
}
```

<!-- document id=11cab1c6f85dc02f704001b2e29cf38346c7894efbd9b8f03ed7d1156cde08f7 url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-minby.md -->

---
product: DataWeave
version: 2.12
---

# minBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## minBy<T>(@StreamCapable array: Array<T>, criteria: (item: T) -> Comparable): T | Null

Iterates over an array to return the lowest value of comparable elements from it.

The items need to be of the same type. `minBy` returns an error if they are not, and it returns null
when the array is empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>item</code></p></td><td><p>Element in the input array (of type <code>Number</code>, <code>Boolean</code>, <code>DateTime</code>, <code>LocalDateTime</code>, <code>Date</code>, <code>LocalTime</code>, <code>Time</code>, or <code>TimeZone</code>). Can be referenced with <code>$</code>.</p></td></tr></tbody></table>

### Example

This example returns the lowest numeric value within objects (key-value pairs) in an array. Notice
that it uses `item.a` to select the value of the object. You can also write the same expression like
this, using an anonymous parameter: `[ { "a" : 1 }, { "a" : 3 }, { "a" : 2 } ] minBy $.a`

#### Source

```DataWeave
%dw 2.0
output  application/json
---
[ { "a" : 1 }, { "a" : 2 }, { "a" : 3 } ] minBy (item) -> item.a
```

#### Output

```JSON
{ "a" : 1 }
```

### Example

This example gets the latest `DateTime`, `Date`, and `Time` from inputs defined in the variables
`myDateTime1` and `myDateTime2`. It also shows that the function returns null on an empty array.

#### Source

```DataWeave
%dw 2.0
var myDateTime1 = "2017-10-01T22:57:59-03:00"
var myDateTime2 = "2018-10-01T23:57:59-03:00"
output application/json
---
{
  myMinBy: {
    byDateTime: [ myDateTime1, myDateTime2 ] minBy ((item) -> item),
    byDate: [ myDateTime1 as Date, myDateTime2 as Date ] minBy ((item) -> item),
    byTime: [ myDateTime1 as Time, myDateTime2 as Time ] minBy ((item) -> item),
    aBoolean: [ true, false, (0 > 1), (1 > 0) ] minBy $,
    emptyArray: [] minBy ((item) -> item)
  }
}
```

#### Output

```JSON
{
  "myMinBy": {
    "byDateTime": "2017-10-01T22:57:59-03:00",
    "byDate": "2017-10-01",
    "byTime": "22:57:59-03:00",
    "aBoolean": false,
    "emptyArray": null
  }
}
```

<!-- document id=d2310a85f02e8574e1defad681d72324be2af0c5b964d3a48f05fc1807477bd2 url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-minby.md -->

---
product: DataWeave
version: 2.3
---

# minBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## minBy(Array<T>, (item: T) -> Comparable): T | Null

Iterates over an array to return the lowest value of comparable elements from it.

The items need to be of the same type. `minBy` returns an error if they are not, and it returns null
when the array is empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>item</code></p></td><td><p>Element in the input array (of type <code>Number</code>, <code>Boolean</code>, <code>DateTime</code>, <code>LocalDateTime</code>, <code>Date</code>, <code>LocalTime</code>, <code>Time</code>, or <code>TimeZone</code>). Can be referenced with <code>$</code>.</p></td></tr></tbody></table>

### Example

This example returns the lowest numeric value within objects (key-value pairs) in an array. Notice
that it uses `item.a` to select the value of the object. You can also write the same expression like
this, using an anonymous parameter: `[ { "a" : 1 }, { "a" : 3 }, { "a" : 2 } ] minBy $.a`

#### Source

```DataWeave
%dw 2.0
output  application/json
---
[ { "a" : 1 }, { "a" : 2 }, { "a" : 3 } ] minBy (item) -> item.a
```

#### Output

```JSON
{ "a" : 1 }
```

### Example

This example gets the latest `DateTime`, `Date`, and `Time` from inputs defined in the variables
`myDateTime1` and `myDateTime2`. It also shows that the function returns null on an empty array.

#### Source

```DataWeave
%dw 2.0
var myDateTime1 = "2017-10-01T22:57:59-03:00"
var myDateTime2 = "2018-10-01T23:57:59-03:00"
output application/json
---
{
  myMinBy: {
    byDateTime: [ myDateTime1, myDateTime2 ] minBy ((item) -> item),
    byDate: [ myDateTime1 as Date, myDateTime2 as Date ] minBy ((item) -> item),
    byTime: [ myDateTime1 as Time, myDateTime2 as Time ] minBy ((item) -> item),
    aBoolean: [ true, false, (0 > 1), (1 > 0) ] minBy $,
    emptyArray: [] minBy ((item) -> item)
  }
}
```

#### Output

```JSON
{
  "myMinBy": {
    "byDateTime": "2017-10-01T22:57:59-03:00",
    "byDate": "2017-10-01",
    "byTime": "22:57:59-03:00",
    "aBoolean": false,
    "emptyArray": null
  }
}
```

<!-- document id=1e32a2d8493d6a03c5a901f36c92c93316cb7d917208c45a20f64b3aa617ac0a url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-minby.md -->

---
product: DataWeave
version: 2.4
---

# minBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## minBy<T>(@StreamCapable array: Array<T>, criteria: (item: T) -> Comparable): T | Null

Iterates over an array to return the lowest value of comparable elements from it.

The items need to be of the same type. `minBy` returns an error if they are not, and it returns null
when the array is empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>item</code></p></td><td><p>Element in the input array (of type <code>Number</code>, <code>Boolean</code>, <code>DateTime</code>, <code>LocalDateTime</code>, <code>Date</code>, <code>LocalTime</code>, <code>Time</code>, or <code>TimeZone</code>). Can be referenced with <code>$</code>.</p></td></tr></tbody></table>

### Example

This example returns the lowest numeric value within objects (key-value pairs) in an array. Notice
that it uses `item.a` to select the value of the object. You can also write the same expression like
this, using an anonymous parameter: `[ { "a" : 1 }, { "a" : 3 }, { "a" : 2 } ] minBy $.a`

#### Source

```DataWeave
%dw 2.0
output  application/json
---
[ { "a" : 1 }, { "a" : 2 }, { "a" : 3 } ] minBy (item) -> item.a
```

#### Output

```JSON
{ "a" : 1 }
```

### Example

This example gets the latest `DateTime`, `Date`, and `Time` from inputs defined in the variables
`myDateTime1` and `myDateTime2`. It also shows that the function returns null on an empty array.

#### Source

```DataWeave
%dw 2.0
var myDateTime1 = "2017-10-01T22:57:59-03:00"
var myDateTime2 = "2018-10-01T23:57:59-03:00"
output application/json
---
{
  myMinBy: {
    byDateTime: [ myDateTime1, myDateTime2 ] minBy ((item) -> item),
    byDate: [ myDateTime1 as Date, myDateTime2 as Date ] minBy ((item) -> item),
    byTime: [ myDateTime1 as Time, myDateTime2 as Time ] minBy ((item) -> item),
    aBoolean: [ true, false, (0 > 1), (1 > 0) ] minBy $,
    emptyArray: [] minBy ((item) -> item)
  }
}
```

#### Output

```JSON
{
  "myMinBy": {
    "byDateTime": "2017-10-01T22:57:59-03:00",
    "byDate": "2017-10-01",
    "byTime": "22:57:59-03:00",
    "aBoolean": false,
    "emptyArray": null
  }
}
```

<!-- document id=34ead19d92a8d51387d0ec8992637626c2b2753e5c10955de2fedc48cbd6400c url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-minby.md -->

---
product: DataWeave
version: 2.6
---

# minBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## minBy<T>(@StreamCapable array: Array<T>, criteria: (item: T) -> Comparable): T | Null

Iterates over an array to return the lowest value of comparable elements from it.

The items need to be of the same type. `minBy` returns an error if they are not, and it returns null
when the array is empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>item</code></p></td><td><p>Element in the input array (of type <code>Number</code>, <code>Boolean</code>, <code>DateTime</code>, <code>LocalDateTime</code>, <code>Date</code>, <code>LocalTime</code>, <code>Time</code>, or <code>TimeZone</code>). Can be referenced with <code>$</code>.</p></td></tr></tbody></table>

### Example

This example returns the lowest numeric value within objects (key-value pairs) in an array. Notice
that it uses `item.a` to select the value of the object. You can also write the same expression like
this, using an anonymous parameter: `[ { "a" : 1 }, { "a" : 3 }, { "a" : 2 } ] minBy $.a`

#### Source

```DataWeave
%dw 2.0
output  application/json
---
[ { "a" : 1 }, { "a" : 2 }, { "a" : 3 } ] minBy (item) -> item.a
```

#### Output

```JSON
{ "a" : 1 }
```

### Example

This example gets the latest `DateTime`, `Date`, and `Time` from inputs defined in the variables
`myDateTime1` and `myDateTime2`. It also shows that the function returns null on an empty array.

#### Source

```DataWeave
%dw 2.0
var myDateTime1 = "2017-10-01T22:57:59-03:00"
var myDateTime2 = "2018-10-01T23:57:59-03:00"
output application/json
---
{
  myMinBy: {
    byDateTime: [ myDateTime1, myDateTime2 ] minBy ((item) -> item),
    byDate: [ myDateTime1 as Date, myDateTime2 as Date ] minBy ((item) -> item),
    byTime: [ myDateTime1 as Time, myDateTime2 as Time ] minBy ((item) -> item),
    aBoolean: [ true, false, (0 > 1), (1 > 0) ] minBy $,
    emptyArray: [] minBy ((item) -> item)
  }
}
```

#### Output

```JSON
{
  "myMinBy": {
    "byDateTime": "2017-10-01T22:57:59-03:00",
    "byDate": "2017-10-01",
    "byTime": "22:57:59-03:00",
    "aBoolean": false,
    "emptyArray": null
  }
}
```

<!-- document id=504fb7a5c7e83d1e1b03d5ef5f9f719b70b39a5e715da6a5b3bc054686bebacc url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-minby.md -->

---
product: DataWeave
version: 2.9
---

# minBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## minBy<T>(@StreamCapable array: Array<T>, criteria: (item: T) -> Comparable): T | Null

Iterates over an array to return the lowest value of comparable elements from it.

The items need to be of the same type. `minBy` returns an error if they are not, and it returns null
when the array is empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>item</code></p></td><td><p>Element in the input array (of type <code>Number</code>, <code>Boolean</code>, <code>DateTime</code>, <code>LocalDateTime</code>, <code>Date</code>, <code>LocalTime</code>, <code>Time</code>, or <code>TimeZone</code>). Can be referenced with <code>$</code>.</p></td></tr></tbody></table>

### Example

This example returns the lowest numeric value within objects (key-value pairs) in an array. Notice
that it uses `item.a` to select the value of the object. You can also write the same expression like
this, using an anonymous parameter: `[ { "a" : 1 }, { "a" : 3 }, { "a" : 2 } ] minBy $.a`

#### Source

```DataWeave
%dw 2.0
output  application/json
---
[ { "a" : 1 }, { "a" : 2 }, { "a" : 3 } ] minBy (item) -> item.a
```

#### Output

```JSON
{ "a" : 1 }
```

### Example

This example gets the latest `DateTime`, `Date`, and `Time` from inputs defined in the variables
`myDateTime1` and `myDateTime2`. It also shows that the function returns null on an empty array.

#### Source

```DataWeave
%dw 2.0
var myDateTime1 = "2017-10-01T22:57:59-03:00"
var myDateTime2 = "2018-10-01T23:57:59-03:00"
output application/json
---
{
  myMinBy: {
    byDateTime: [ myDateTime1, myDateTime2 ] minBy ((item) -> item),
    byDate: [ myDateTime1 as Date, myDateTime2 as Date ] minBy ((item) -> item),
    byTime: [ myDateTime1 as Time, myDateTime2 as Time ] minBy ((item) -> item),
    aBoolean: [ true, false, (0 > 1), (1 > 0) ] minBy $,
    emptyArray: [] minBy ((item) -> item)
  }
}
```

#### Output

```JSON
{
  "myMinBy": {
    "byDateTime": "2017-10-01T22:57:59-03:00",
    "byDate": "2017-10-01",
    "byTime": "22:57:59-03:00",
    "aBoolean": false,
    "emptyArray": null
  }
}
```

<!-- document id=fba3a077891e0818b0bb1ca68452934c1f832fa4ead5e6bdedb7ea53953b264c url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-minby.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# minBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## minBy<T>(@StreamCapable array: Array<T>, criteria: (item: T) -> Comparable): T | Null

Iterates over an array to return the lowest value of comparable elements from it.

The items need to be of the same type. `minBy` returns an error if they are not, and it returns null
when the array is empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>item</code></p></td><td><p>Element in the input array (of type <code>Number</code>, <code>Boolean</code>, <code>DateTime</code>, <code>LocalDateTime</code>, <code>Date</code>, <code>LocalTime</code>, <code>Time</code>, or <code>TimeZone</code>). Can be referenced with <code>$</code>.</p></td></tr></tbody></table>

### Example

This example returns the lowest numeric value within objects (key-value pairs) in an array. Notice
that it uses `item.a` to select the value of the object. You can also write the same expression like
this, using an anonymous parameter: `[ { "a" : 1 }, { "a" : 3 }, { "a" : 2 } ] minBy $.a`

#### Source

```DataWeave
%dw 2.0
output  application/json
---
[ { "a" : 1 }, { "a" : 2 }, { "a" : 3 } ] minBy (item) -> item.a
```

#### Output

```JSON
{ "a" : 1 }
```

### Example

This example gets the latest `DateTime`, `Date`, and `Time` from inputs defined in the variables
`myDateTime1` and `myDateTime2`. It also shows that the function returns null on an empty array.

#### Source

```DataWeave
%dw 2.0
var myDateTime1 = "2017-10-01T22:57:59-03:00"
var myDateTime2 = "2018-10-01T23:57:59-03:00"
output application/json
---
{
  myMinBy: {
    byDateTime: [ myDateTime1, myDateTime2 ] minBy ((item) -> item),
    byDate: [ myDateTime1 as Date, myDateTime2 as Date ] minBy ((item) -> item),
    byTime: [ myDateTime1 as Time, myDateTime2 as Time ] minBy ((item) -> item),
    aBoolean: [ true, false, (0 > 1), (1 > 0) ] minBy $,
    emptyArray: [] minBy ((item) -> item)
  }
}
```

#### Output

```JSON
{
  "myMinBy": {
    "byDateTime": "2017-10-01T22:57:59-03:00",
    "byDate": "2017-10-01",
    "byTime": "22:57:59-03:00",
    "aBoolean": false,
    "emptyArray": null
  }
}
```

<!-- document id=370d2aab698900841a7bbf1b0981901afb7d30b8c032369c1bb319a73934c351 url=/mulesoft/current/en-us/dataweave/2.11/dw-periods-functions-minutes.md -->

---
product: DataWeave
version: 2.11
---

# minutes

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## minutes(nMinutes: Number): Period

Creates a Period value from the provided number of minutes.

The function applies the `duration` function to the input value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>nMinutes</code></p></td><td><p>The number of minutes as a whole or decimal number. A positive or negative number is valid.</p></td></tr></tbody></table>

### Example

This example shows how `minutes` behaves with different inputs. It adds and subtracts hours from
DateTime values. It also converts the decimal value `4.555` into the Period format (`PT4M33.3S`) and
and the whole number `4` into the Period format (`PT4M`). Notice that `minutes(-1) + minutes(2)`
returns the number of seconds.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Periods
output application/json
---
{
   nextMinute: |2020-10-05T20:22:34.385Z| + minutes(1),
   previousMinute: |2020-10-05T20:22:34.385Z| - minutes(1),
   decimalInputPeriod: minutes(4.555),
   wholeNumberInputPeriod: minutes(4),
   addNegativeValue: minutes(-1) + minutes(2)
}
```

#### Output

```Json
{
   "nextMinute": "2020-10-05T20:23:34.385Z",
   "previousMinute": "2020-10-05T20:21:34.385Z",
   "decimalInputPeriod": "PT4M33.3S",
   "wholeNumberInputPeriod": "PT4M",
   "addNegativeValue": 60
}
```

<!-- document id=33d6e3537b96a9a3784f8a2e7e8e3924c42eb1506eab56c5f3a523738c781e47 url=/mulesoft/current/en-us/dataweave/2.12/dw-periods-functions-minutes.md -->

---
product: DataWeave
version: 2.12
---

# minutes

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## minutes(nMinutes: Number): Period

Creates a Period value from the provided number of minutes.

The function applies the `duration` function to the input value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>nMinutes</code></p></td><td><p>The number of minutes as a whole or decimal number. A positive or negative number is valid.</p></td></tr></tbody></table>

### Example

This example shows how `minutes` behaves with different inputs. It adds and subtracts hours from
DateTime values. It also converts the decimal value `4.555` into the Period format (`PT4M33.3S`) and
and the whole number `4` into the Period format (`PT4M`). Notice that `minutes(-1) + minutes(2)`
returns the number of seconds.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Periods
output application/json
---
{
   nextMinute: |2020-10-05T20:22:34.385Z| + minutes(1),
   previousMinute: |2020-10-05T20:22:34.385Z| - minutes(1),
   decimalInputPeriod: minutes(4.555),
   wholeNumberInputPeriod: minutes(4),
   addNegativeValue: minutes(-1) + minutes(2)
}
```

#### Output

```Json
{
   "nextMinute": "2020-10-05T20:23:34.385Z",
   "previousMinute": "2020-10-05T20:21:34.385Z",
   "decimalInputPeriod": "PT4M33.3S",
   "wholeNumberInputPeriod": "PT4M",
   "addNegativeValue": 60
}
```

<!-- document id=2fd91c0c91488330a153f7cf609ffbef1f47ac81eea37497d5eca8c4c55f463c url=/mulesoft/current/en-us/dataweave/2.4/dw-periods-functions-minutes.md -->

---
product: DataWeave
version: 2.4
---

# minutes

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## minutes(nMinutes: Number): Period

Creates a Period value from the provided number of minutes.

The function applies the `duration` function to the input value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>nMinutes</code></p></td><td><p>The number of minutes as a whole or decimal number. A positive or negative number is valid.</p></td></tr></tbody></table>

### Example

This example shows how `minutes` behaves with different inputs. It adds and subtracts hours from
DateTime values. It also converts the decimal value `4.555` into the Period format (`PT4M33.3S`) and
and the whole number `4` into the Period format (`PT4M`). Notice that `minutes(-1) + minutes(2)`
returns the number of seconds.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Periods
output application/json
---
{
   nextMinute: |2020-10-05T20:22:34.385Z| + minutes(1),
   previousMinute: |2020-10-05T20:22:34.385Z| - minutes(1),
   decimalInputPeriod: minutes(4.555),
   wholeNumberInputPeriod: minutes(4),
   addNegativeValue: minutes(-1) + minutes(2)
}
```

#### Output

```Json
{
   "nextMinute": "2020-10-05T20:23:34.385Z",
   "previousMinute": "2020-10-05T20:21:34.385Z",
   "decimalInputPeriod": "PT4M33.3S",
   "wholeNumberInputPeriod": "PT4M",
   "addNegativeValue": 60
}
```

<!-- document id=c8c3acc4c8bd523b556e58f260f693a325ba618748dc27821a8890519e9c4b48 url=/mulesoft/current/en-us/dataweave/2.6/dw-periods-functions-minutes.md -->

---
product: DataWeave
version: 2.6
---

# minutes

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## minutes(nMinutes: Number): Period

Creates a Period value from the provided number of minutes.

The function applies the `duration` function to the input value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>nMinutes</code></p></td><td><p>The number of minutes as a whole or decimal number. A positive or negative number is valid.</p></td></tr></tbody></table>

### Example

This example shows how `minutes` behaves with different inputs. It adds and subtracts hours from
DateTime values. It also converts the decimal value `4.555` into the Period format (`PT4M33.3S`) and
and the whole number `4` into the Period format (`PT4M`). Notice that `minutes(-1) + minutes(2)`
returns the number of seconds.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Periods
output application/json
---
{
   nextMinute: |2020-10-05T20:22:34.385Z| + minutes(1),
   previousMinute: |2020-10-05T20:22:34.385Z| - minutes(1),
   decimalInputPeriod: minutes(4.555),
   wholeNumberInputPeriod: minutes(4),
   addNegativeValue: minutes(-1) + minutes(2)
}
```

#### Output

```Json
{
   "nextMinute": "2020-10-05T20:23:34.385Z",
   "previousMinute": "2020-10-05T20:21:34.385Z",
   "decimalInputPeriod": "PT4M33.3S",
   "wholeNumberInputPeriod": "PT4M",
   "addNegativeValue": 60
}
```

<!-- document id=a559338c00063f6113caf5c0ac5e3db87cb7570652ad415e01e745dae668c453 url=/mulesoft/current/en-us/dataweave/2.9/dw-periods-functions-minutes.md -->

---
product: DataWeave
version: 2.9
---

# minutes

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## minutes(nMinutes: Number): Period

Creates a Period value from the provided number of minutes.

The function applies the `duration` function to the input value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>nMinutes</code></p></td><td><p>The number of minutes as a whole or decimal number. A positive or negative number is valid.</p></td></tr></tbody></table>

### Example

This example shows how `minutes` behaves with different inputs. It adds and subtracts hours from
DateTime values. It also converts the decimal value `4.555` into the Period format (`PT4M33.3S`) and
and the whole number `4` into the Period format (`PT4M`). Notice that `minutes(-1) + minutes(2)`
returns the number of seconds.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Periods
output application/json
---
{
   nextMinute: |2020-10-05T20:22:34.385Z| + minutes(1),
   previousMinute: |2020-10-05T20:22:34.385Z| - minutes(1),
   decimalInputPeriod: minutes(4.555),
   wholeNumberInputPeriod: minutes(4),
   addNegativeValue: minutes(-1) + minutes(2)
}
```

#### Output

```Json
{
   "nextMinute": "2020-10-05T20:23:34.385Z",
   "previousMinute": "2020-10-05T20:21:34.385Z",
   "decimalInputPeriod": "PT4M33.3S",
   "wholeNumberInputPeriod": "PT4M",
   "addNegativeValue": 60
}
```

<!-- document id=8125306fdd5dd9d5a1795ffaba7ccb53cc0eee5cc5ee69d916317e2db29c7e69 url=/mulesoft/current/en-us/dataweave/latest/dw-periods-functions-minutes.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# minutes

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## minutes(nMinutes: Number): Period

Creates a Period value from the provided number of minutes.

The function applies the `duration` function to the input value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>nMinutes</code></p></td><td><p>The number of minutes as a whole or decimal number. A positive or negative number is valid.</p></td></tr></tbody></table>

### Example

This example shows how `minutes` behaves with different inputs. It adds and subtracts hours from
DateTime values. It also converts the decimal value `4.555` into the Period format (`PT4M33.3S`) and
and the whole number `4` into the Period format (`PT4M`). Notice that `minutes(-1) + minutes(2)`
returns the number of seconds.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Periods
output application/json
---
{
   nextMinute: |2020-10-05T20:22:34.385Z| + minutes(1),
   previousMinute: |2020-10-05T20:22:34.385Z| - minutes(1),
   decimalInputPeriod: minutes(4.555),
   wholeNumberInputPeriod: minutes(4),
   addNegativeValue: minutes(-1) + minutes(2)
}
```

#### Output

```Json
{
   "nextMinute": "2020-10-05T20:23:34.385Z",
   "previousMinute": "2020-10-05T20:21:34.385Z",
   "decimalInputPeriod": "PT4M33.3S",
   "wholeNumberInputPeriod": "PT4M",
   "addNegativeValue": 60
}
```

<!-- document id=f7c740e02979f4c1d3df874a1de7fd19ffd08f7d9ce70b5725e104abfaac0100 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-mod.md -->

---
product: DataWeave
version: 2.11
---

# mod

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## mod(dividend: Number, divisor: Number): Number

Returns the modulo (the remainder after dividing the `dividend` by the `divisor`).

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dividend</code></p></td><td><p>The number that serves as the dividend for the operation.</p></td></tr><tr><td><p><code>divisor</code></p></td><td><p>The number that serves as the divisor for the operation.</p></td></tr></tbody></table>

### Example

This example returns the modulo of the input values. Note that you can also use the
`mod(dividend, divisor)` notation (for example, `mod(3, 2)` to return `1`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ (3 mod 2), (4 mod 2), (2.2 mod 2) ]
```

#### Output

```JSON
[ 1, 0, 0.2]
```

<!-- document id=6102f441a95f92f0017eb7aeb16ecd8b9e2657cfdb4538dc41cbb38e8dd3d775 url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-mod.md -->

---
product: DataWeave
version: 2.12
---

# mod

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## mod(dividend: Number, divisor: Number): Number

Returns the modulo (the remainder after dividing the `dividend` by the `divisor`).

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dividend</code></p></td><td><p>The number that serves as the dividend for the operation.</p></td></tr><tr><td><p><code>divisor</code></p></td><td><p>The number that serves as the divisor for the operation.</p></td></tr></tbody></table>

### Example

This example returns the modulo of the input values. Note that you can also use the
`mod(dividend, divisor)` notation (for example, `mod(3, 2)` to return `1`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ (3 mod 2), (4 mod 2), (2.2 mod 2) ]
```

#### Output

```JSON
[ 1, 0, 0.2]
```

<!-- document id=91d3c8250ffb724e6fa1855c6cc90d765d737261186c5b87e433fd506c9562ca url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-mod.md -->

---
product: DataWeave
version: 2.3
---

# mod

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## mod(Number, Number): Number

Returns the modulo (the remainder after dividing the `dividend` by the `divisor`).

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dividend</code></p></td><td><p>The number that serves as the dividend for the operation.</p></td></tr><tr><td><p><code>divisor</code></p></td><td><p>The number that serves as the divisor for the operation.</p></td></tr></tbody></table>

### Example

This example returns the modulo of the input values. Note that you can also use the
`mod(dividend, divisor)` notation (for example, `mod(3, 2)` to return `1`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ (3 mod 2), (4 mod 2), (2.2 mod 2) ]
```

#### Output

```JSON
[ 1, 0, 0.2]
```

<!-- document id=74b66451665e8a8bfe26a329cfe112b2c8c75637a8f29b1e9a9abc53f8989678 url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-mod.md -->

---
product: DataWeave
version: 2.4
---

# mod

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## mod(dividend: Number, divisor: Number): Number

Returns the modulo (the remainder after dividing the `dividend` by the `divisor`).

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dividend</code></p></td><td><p>The number that serves as the dividend for the operation.</p></td></tr><tr><td><p><code>divisor</code></p></td><td><p>The number that serves as the divisor for the operation.</p></td></tr></tbody></table>

### Example

This example returns the modulo of the input values. Note that you can also use the
`mod(dividend, divisor)` notation (for example, `mod(3, 2)` to return `1`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ (3 mod 2), (4 mod 2), (2.2 mod 2) ]
```

#### Output

```JSON
[ 1, 0, 0.2]
```

<!-- document id=fd54142a8725abfbb0d68949b27cb01588ccbb2d8aca5e6b6617cd2a196ffcc6 url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-mod.md -->

---
product: DataWeave
version: 2.6
---

# mod

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## mod(dividend: Number, divisor: Number): Number

Returns the modulo (the remainder after dividing the `dividend` by the `divisor`).

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dividend</code></p></td><td><p>The number that serves as the dividend for the operation.</p></td></tr><tr><td><p><code>divisor</code></p></td><td><p>The number that serves as the divisor for the operation.</p></td></tr></tbody></table>

### Example

This example returns the modulo of the input values. Note that you can also use the
`mod(dividend, divisor)` notation (for example, `mod(3, 2)` to return `1`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ (3 mod 2), (4 mod 2), (2.2 mod 2) ]
```

#### Output

```JSON
[ 1, 0, 0.2]
```

<!-- document id=89e6b269392b2ca38ac85deb75054cae7a61e9db1e91729ddd2c35b55534544c url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-mod.md -->

---
product: DataWeave
version: 2.9
---

# mod

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## mod(dividend: Number, divisor: Number): Number

Returns the modulo (the remainder after dividing the `dividend` by the `divisor`).

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dividend</code></p></td><td><p>The number that serves as the dividend for the operation.</p></td></tr><tr><td><p><code>divisor</code></p></td><td><p>The number that serves as the divisor for the operation.</p></td></tr></tbody></table>

### Example

This example returns the modulo of the input values. Note that you can also use the
`mod(dividend, divisor)` notation (for example, `mod(3, 2)` to return `1`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ (3 mod 2), (4 mod 2), (2.2 mod 2) ]
```

#### Output

```JSON
[ 1, 0, 0.2]
```

<!-- document id=9896ed04f9b1cd31d2a5897ee38835126e28d657ab8cc765cdd776911b0591dc url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-mod.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# mod

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## mod(dividend: Number, divisor: Number): Number

Returns the modulo (the remainder after dividing the `dividend` by the `divisor`).

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dividend</code></p></td><td><p>The number that serves as the dividend for the operation.</p></td></tr><tr><td><p><code>divisor</code></p></td><td><p>The number that serves as the divisor for the operation.</p></td></tr></tbody></table>

### Example

This example returns the modulo of the input values. Note that you can also use the
`mod(dividend, divisor)` notation (for example, `mod(3, 2)` to return `1`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ (3 mod 2), (4 mod 2), (2.2 mod 2) ]
```

#### Output

```JSON
[ 1, 0, 0.2]
```

<!-- document id=758c6c8b1b4294ac5f5d2e71baf03b2fef659996bb0cee75dadee48fc307d3c1 url=/mulesoft/current/en-us/dataweave/2.11/dw-periods-functions-months.md -->

---
product: DataWeave
version: 2.11
---

# months

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## months(nMonths: Number): Period

Creates a Period value from the provided number of months.

The function applies the `period` function to the input value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>nMonths</code></p></td><td><p>The number of months as a whole number. A positive or negative number is valid.</p></td></tr></tbody></table>

### Example

This example shows how `months` behaves with different inputs. It adds a month to a DateTime value,
and it converts the whole number `4` to a number of months in the Period format (`P4M`).

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Periods
output application/json
---
{
  nextMonth: |2020-10-05T20:22:34.385Z| + months(1),
  fourMonthPeriod : months(4),
  addNegativeValue: months(-1) + months(2)
}
```

#### Output

```Json
{
  "nextMonth": "2020-11-05T20:22:34.385Z",
  "fourMonthPeriod": "P4M",
  "addNegativeValue": 1
}
```

<!-- document id=670b9919ccedc27aae81deb823ec6fc159fac06775b195794b8a79129ad7f27e url=/mulesoft/current/en-us/dataweave/2.12/dw-periods-functions-months.md -->

---
product: DataWeave
version: 2.12
---

# months

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## months(nMonths: Number): Period

Creates a Period value from the provided number of months.

The function applies the `period` function to the input value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>nMonths</code></p></td><td><p>The number of months as a whole number. A positive or negative number is valid.</p></td></tr></tbody></table>

### Example

This example shows how `months` behaves with different inputs. It adds a month to a DateTime value,
and it converts the whole number `4` to a number of months in the Period format (`P4M`).

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Periods
output application/json
---
{
  nextMonth: |2020-10-05T20:22:34.385Z| + months(1),
  fourMonthPeriod : months(4),
  addNegativeValue: months(-1) + months(2)
}
```

#### Output

```Json
{
  "nextMonth": "2020-11-05T20:22:34.385Z",
  "fourMonthPeriod": "P4M",
  "addNegativeValue": 1
}
```

<!-- document id=b40dc53601bb9ad82f595d67e745e2ee992cc532ad8d07e4a23795a652a7e0d2 url=/mulesoft/current/en-us/dataweave/2.4/dw-periods-functions-months.md -->

---
product: DataWeave
version: 2.4
---

# months

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## months(nMonths: Number): Period

Creates a Period value from the provided number of months.

The function applies the `period` function to the input value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>nMonths</code></p></td><td><p>The number of months as a whole number. A positive or negative number is valid.</p></td></tr></tbody></table>

### Example

This example shows how `months` behaves with different inputs. It adds a month to a DateTime value,
and it converts the whole number `4` to a number of months in the Period format (`P4M`).

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Periods
output application/json
---
{
  nextMonth: |2020-10-05T20:22:34.385Z| + months(1),
  fourMonthPeriod : months(4),
  addNegativeValue: months(-1) + months(2)
}
```

#### Output

```Json
{
  "nextMonth": "2020-11-05T20:22:34.385Z",
  "fourMonthPeriod": "P4M",
  "addNegativeValue": 1
}
```

<!-- document id=aa4aed80574707709b0b2b445e25a746e2ff756c34005ab5da355a4ce39f624d url=/mulesoft/current/en-us/dataweave/2.6/dw-periods-functions-months.md -->

---
product: DataWeave
version: 2.6
---

# months

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## months(nMonths: Number): Period

Creates a Period value from the provided number of months.

The function applies the `period` function to the input value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>nMonths</code></p></td><td><p>The number of months as a whole number. A positive or negative number is valid.</p></td></tr></tbody></table>

### Example

This example shows how `months` behaves with different inputs. It adds a month to a DateTime value,
and it converts the whole number `4` to a number of months in the Period format (`P4M`).

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Periods
output application/json
---
{
  nextMonth: |2020-10-05T20:22:34.385Z| + months(1),
  fourMonthPeriod : months(4),
  addNegativeValue: months(-1) + months(2)
}
```

#### Output

```Json
{
  "nextMonth": "2020-11-05T20:22:34.385Z",
  "fourMonthPeriod": "P4M",
  "addNegativeValue": 1
}
```

<!-- document id=645331f5c4f50d7518ed9d3856e4b0d72607598fd40b136ea428b63b077f08a0 url=/mulesoft/current/en-us/dataweave/2.9/dw-periods-functions-months.md -->

---
product: DataWeave
version: 2.9
---

# months

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## months(nMonths: Number): Period

Creates a Period value from the provided number of months.

The function applies the `period` function to the input value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>nMonths</code></p></td><td><p>The number of months as a whole number. A positive or negative number is valid.</p></td></tr></tbody></table>

### Example

This example shows how `months` behaves with different inputs. It adds a month to a DateTime value,
and it converts the whole number `4` to a number of months in the Period format (`P4M`).

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Periods
output application/json
---
{
  nextMonth: |2020-10-05T20:22:34.385Z| + months(1),
  fourMonthPeriod : months(4),
  addNegativeValue: months(-1) + months(2)
}
```

#### Output

```Json
{
  "nextMonth": "2020-11-05T20:22:34.385Z",
  "fourMonthPeriod": "P4M",
  "addNegativeValue": 1
}
```

<!-- document id=22b4a4fa17cda63be57e5cd26d0aae401755ddbe8a41c0798f9e2c2c42435ef7 url=/mulesoft/current/en-us/dataweave/latest/dw-periods-functions-months.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# months

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## months(nMonths: Number): Period

Creates a Period value from the provided number of months.

The function applies the `period` function to the input value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>nMonths</code></p></td><td><p>The number of months as a whole number. A positive or negative number is valid.</p></td></tr></tbody></table>

### Example

This example shows how `months` behaves with different inputs. It adds a month to a DateTime value,
and it converts the whole number `4` to a number of months in the Period format (`P4M`).

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Periods
output application/json
---
{
  nextMonth: |2020-10-05T20:22:34.385Z| + months(1),
  fourMonthPeriod : months(4),
  addNegativeValue: months(-1) + months(2)
}
```

#### Output

```Json
{
  "nextMonth": "2020-11-05T20:22:34.385Z",
  "fourMonthPeriod": "P4M",
  "addNegativeValue": 1
}
```

<!-- document id=d3646e2c74a5636864e9c40cc76dbe260367d14baaf171db25ea9f950da57ecb url=/mulesoft/current/en-us/dataweave/2.11/dw-mule.md -->

---
product: DataWeave
version: 2.11
---

# Mule (dw::Mule)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave module contains functions for interacting with Mule runtime.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-mule-functions-causedby">causedBy</a></p></td><td><p>This function matches an error by its type, like an error handler does.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-mule-functions-lookup">lookup</a></p></td><td><p>This function enables you to execute a flow within a Mule app and retrieve the resulting payload.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-mule-functions-p">p</a></p></td><td><p>This function returns a string that identifies the value of one of these input properties: Mule property placeholders, System properties, or Environment variables.</p></td></tr></tbody></table>

## Types

- [Mule Types](https://docs.mulesoft.com/dataweave/2.11/dw-mule-types)

<!-- document id=8d6375ba48395911862a5f03d200e3e76a790b9aa7fff8cd393e9511a019b765 url=/mulesoft/current/en-us/dataweave/2.12/dw-mule.md -->

---
product: DataWeave
version: 2.12
---

# Mule (dw::Mule)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave module contains functions for interacting with Mule runtime.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-mule-functions-causedby">causedBy</a></p></td><td><p>This function matches an error by its type, like an error handler does.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-mule-functions-lookup">lookup</a></p></td><td><p>This function enables you to execute a flow within a Mule app and retrieve the resulting payload.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-mule-functions-p">p</a></p></td><td><p>This function returns a string that identifies the value of one of these input properties: Mule property placeholders, System properties, or Environment variables.</p></td></tr></tbody></table>

## Types

- [Mule Types](https://docs.mulesoft.com/dataweave/2.12/dw-mule-types)

<!-- document id=6f13d92a775a748c7ef0aa0ae3f7433d58f64498d56949f06c9bd25161b6947e url=/mulesoft/current/en-us/dataweave/2.3/dw-mule.md -->

---
product: DataWeave
version: 2.3
---

# Mule (dw::Mule)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave module contains functions for interacting with Mule runtime.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-mule-functions-causedby">causedBy</a></p></td><td><p>This function matches an error by its type, like an error handler does.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-mule-functions-lookup">lookup</a></p></td><td><p>This function enables you to execute a flow within a Mule app and retrieve the resulting payload.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-mule-functions-p">p</a></p></td><td><p>This function returns a string that identifies the value of one of these input properties: Mule property placeholders, System properties, or Environment variables.</p></td></tr></tbody></table>

## Types

- [Mule Types](https://docs.mulesoft.com/dataweave/2.3/dw-mule-types)

<!-- document id=d48a5a1e1e66511b43bd857b20e3a98509b85ffbd74ff58425c7b33f74293d63 url=/mulesoft/current/en-us/dataweave/2.4/dw-mule.md -->

---
product: DataWeave
version: 2.4
---

# Mule (dw::Mule)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave module contains functions for interacting with Mule runtime engine.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::Mule` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-mule-functions-causedby">causedBy</a></p></td><td><p>This function matches an error by its type, like an error handler does.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-mule-functions-lookup">lookup</a></p></td><td><p>This function enables you to execute a flow within a Mule app and retrieve the resulting payload.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-mule-functions-p">p</a></p></td><td><p>This function returns a string that identifies the value of one of these input properties: Mule property placeholders, System properties, or Environment variables.</p></td></tr></tbody></table>

## Types

- [Mule Types](https://docs.mulesoft.com/dataweave/2.4/dw-mule-types)

<!-- document id=487800b4fa8f5925f032f5f9132d31d7d11e9fe7624b3d28e9d2c0cbc532a694 url=/mulesoft/current/en-us/dataweave/2.6/dw-mule.md -->

---
product: DataWeave
version: 2.6
---

# Mule (dw::Mule)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave module contains functions for interacting with Mule runtime.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-mule-functions-causedby">causedBy</a></p></td><td><p>This function matches an error by its type, like an error handler does.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-mule-functions-lookup">lookup</a></p></td><td><p>This function enables you to execute a flow within a Mule app and retrieve the resulting payload.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-mule-functions-p">p</a></p></td><td><p>This function returns a string that identifies the value of one of these input properties: Mule property placeholders, System properties, or Environment variables.</p></td></tr></tbody></table>

## Types

- [Mule Types](https://docs.mulesoft.com/dataweave/2.6/dw-mule-types)

<!-- document id=4c22326a6d86b0316b742714f32e4c863d2b5ab7f8a8c2bdcabeb3c493324500 url=/mulesoft/current/en-us/dataweave/2.9/dw-mule.md -->

---
product: DataWeave
version: 2.9
---

# Mule (dw::Mule)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave module contains functions for interacting with Mule runtime.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-mule-functions-causedby">causedBy</a></p></td><td><p>This function matches an error by its type, like an error handler does.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-mule-functions-lookup">lookup</a></p></td><td><p>This function enables you to execute a flow within a Mule app and retrieve the resulting payload.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-mule-functions-p">p</a></p></td><td><p>This function returns a string that identifies the value of one of these input properties: Mule property placeholders, System properties, or Environment variables.</p></td></tr></tbody></table>

## Types

- [Mule Types](https://docs.mulesoft.com/dataweave/2.9/dw-mule-types)

<!-- document id=d21eb1582d9da072ed207bdadbb01786dc3971dc012e591b8b32d63922124eb1 url=/mulesoft/current/en-us/dataweave/latest/dw-mule.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Mule (dw::Mule)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave module contains functions for interacting with Mule runtime.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-mule-functions-causedby">causedBy</a></p></td><td><p>This function matches an error by its type, like an error handler does.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-mule-functions-lookup">lookup</a></p></td><td><p>This function enables you to execute a flow within a Mule app and retrieve the resulting payload.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-mule-functions-p">p</a></p></td><td><p>This function returns a string that identifies the value of one of these input properties: Mule property placeholders, System properties, or Environment variables.</p></td></tr></tbody></table>

## Types

- [Mule Types](https://docs.mulesoft.com/dataweave/latest/dw-mule-types)

<!-- document id=951234c91f0755f1ba2f00da3cf17d00af08ca917b869b637fc0e71e70d1d24e url=/mulesoft/current/en-us/dataweave/2.11/dw-mule-types.md -->

---
product: DataWeave
version: 2.11
---

# Mule Types (dw::Mule)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>Error</p></td><td><div><div><p><code>type Error = { description?: String, detailedDescription?: String, errorType?: ErrorType, childErrors?: Array&lt;Error&gt; }</code></p></div></div></td><td><div><div><p>Type that represents an Error and contains the following fields:</p></div><div><ul><li><p><code>description</code>: Concise description of the error.</p></li><li><p><code>detailedDescription</code>: Detailed description of the error. This message can include information specific to a Java exception.</p></li><li><p><code>errorType</code>: Returns the type of the error.</p></li><li><p><code>childErrors</code>: Lists child Errors, if any. For example, the Scatter-Gather router might throw an error aggregating all of its routes errors as children. Not all failing components aggregate errors, so this type can return an empty collection.</p></li></ul></div></div></td></tr><tr><td><p>ErrorType</p></td><td><div><div><p><code>type ErrorType = { identifier?: String, namespace?: String, parentErrorType?: ErrorType | Null }</code></p></div></div></td><td><div><div><p>A type of error that a Mule component can throw.</p></div><div><p>The error type has a <code>identifier</code> string that end users can provide in the Mule configuration.</p></div><div><p>Every error belongs to a <code>namespace</code> to avoid collisions with errors that have the same <code>identifier</code> string but belong to different namespace.</p></div><div><p>Error types can be a specialization of a more general error type, in which case the <code>parentErrorType</code> should return the more general error type. This type is used during error type matching within error handlers. So when selecting the general error type for error handling, it also handles the more specialized error types.</p></div></div></td></tr><tr><td><p>Message</p></td><td><div><div><p><code>type Message = Object {class: "org.mule.runtime.api.message.Message"}</code></p></div></div></td><td><div><div><p>Type that represents a Mule message.</p></div></div></td></tr></tbody></table>

<!-- document id=20777a39835423264b427044812afbdf7c613629e3552b86daebfb911c684534 url=/mulesoft/current/en-us/dataweave/2.12/dw-mule-types.md -->

---
product: DataWeave
version: 2.12
---

# Mule Types (dw::Mule)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>Error</p></td><td><div><div><p><code>type Error = { description?: String, detailedDescription?: String, errorType?: ErrorType, childErrors?: Array&lt;Error&gt; }</code></p></div></div></td><td><div><div><p>Type that represents an Error and contains the following fields:</p></div><div><ul><li><p><code>description</code>: Concise description of the error.</p></li><li><p><code>detailedDescription</code>: Detailed description of the error. This message can include information specific to a Java exception.</p></li><li><p><code>errorType</code>: Returns the type of the error.</p></li><li><p><code>childErrors</code>: Lists child Errors, if any. For example, the Scatter-Gather router might throw an error aggregating all of its routes errors as children. Not all failing components aggregate errors, so this type can return an empty collection.</p></li></ul></div></div></td></tr><tr><td><p>ErrorType</p></td><td><div><div><p><code>type ErrorType = { identifier?: String, namespace?: String, parentErrorType?: ErrorType | Null }</code></p></div></div></td><td><div><div><p>A type of error that a Mule component can throw.</p></div><div><p>The error type has a <code>identifier</code> string that end users can provide in the Mule configuration.</p></div><div><p>Every error belongs to a <code>namespace</code> to avoid collisions with errors that have the same <code>identifier</code> string but belong to different namespace.</p></div><div><p>Error types can be a specialization of a more general error type, in which case the <code>parentErrorType</code> should return the more general error type. This type is used during error type matching within error handlers. So when selecting the general error type for error handling, it also handles the more specialized error types.</p></div></div></td></tr><tr><td><p>Message</p></td><td><div><div><p><code>type Message = Object {class: "org.mule.runtime.api.message.Message"}</code></p></div></div></td><td><div><div><p>Type that represents a Mule message.</p></div></div></td></tr></tbody></table>

<!-- document id=fdc3ac6f16655830de7b995d2f87d9488ab35d09d3f4351a40d889a9ebe84df5 url=/mulesoft/current/en-us/dataweave/2.6/dw-mule-types.md -->

---
product: DataWeave
version: 2.6
---

# Mule Types (dw::Mule)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>Error</p></td><td><div><div><p><code>type Error = { description?: String, detailedDescription?: String, errorType?: ErrorType, childErrors?: Array&lt;Error&gt; }</code></p></div></div></td><td><div><div><p>Type that represents an Error and contains the following fields:</p></div><div><ul><li><p><code>description</code>: Concise description of the error.</p></li><li><p><code>detailedDescription</code>: Detailed description of the error. This message can include information specific to a Java exception.</p></li><li><p><code>errorType</code>: Returns the type of the error.</p></li><li><p><code>childErrors</code>: Lists child Errors, if any. For example, the Scatter-Gather router might throw an error aggregating all of its routes errors as children. Not all failing components aggregate errors, so this type can return an empty collection.</p></li></ul></div></div></td></tr><tr><td><p>ErrorType</p></td><td><div><div><p><code>type ErrorType = { identifier?: String, namespace?: String, parentErrorType?: ErrorType | Null }</code></p></div></div></td><td><div><div><p>A type of error that a Mule component can throw.</p></div><div><p>The error type has a <code>identifier</code> string that end users can provide in the Mule configuration. Every error belongs to a <code>namespace</code> to avoid collisions with errors that have the same <code>identifier</code> string but belong to different namespace. Error types can be a specialization of a more general error type, in which case the <code>parentErrorType</code> should return the more general error type. This type is used during error type matching within error handlers. So when selecting the general error type for error handling, it also handles the more specialized error types.</p></div></div></td></tr><tr><td><p>Message</p></td><td><div><div><p><code>type Message = Object {class: "org.mule.runtime.api.message.Message"}</code></p></div></div></td><td><div><div><p>Type that represents a Mule message.</p></div></div></td></tr></tbody></table>

<!-- document id=fd38f3ed262d9fbef7fda342e9b14c1e070764ade73c45a44f7d32a584613bc9 url=/mulesoft/current/en-us/dataweave/2.9/dw-mule-types.md -->

---
product: DataWeave
version: 2.9
---

# Mule Types (dw::Mule)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>Error</p></td><td><div><div><p><code>type Error = { description?: String, detailedDescription?: String, errorType?: ErrorType, childErrors?: Array&lt;Error&gt; }</code></p></div></div></td><td><div><div><p>Type that represents an Error and contains the following fields:</p></div><div><ul><li><p><code>description</code>: Concise description of the error.</p></li><li><p><code>detailedDescription</code>: Detailed description of the error. This message can include information specific to a Java exception.</p></li><li><p><code>errorType</code>: Returns the type of the error.</p></li><li><p><code>childErrors</code>: Lists child Errors, if any. For example, the Scatter-Gather router might throw an error aggregating all of its routes errors as children. Not all failing components aggregate errors, so this type can return an empty collection.</p></li></ul></div></div></td></tr><tr><td><p>ErrorType</p></td><td><div><div><p><code>type ErrorType = { identifier?: String, namespace?: String, parentErrorType?: ErrorType | Null }</code></p></div></div></td><td><div><div><p>A type of error that a Mule component can throw.</p></div><div><p>The error type has a <code>identifier</code> string that end users can provide in the Mule configuration.</p></div><div><p>Every error belongs to a <code>namespace</code> to avoid collisions with errors that have the same <code>identifier</code> string but belong to different namespace.</p></div><div><p>Error types can be a specialization of a more general error type, in which case the <code>parentErrorType</code> should return the more general error type. This type is used during error type matching within error handlers. So when selecting the general error type for error handling, it also handles the more specialized error types.</p></div></div></td></tr><tr><td><p>Message</p></td><td><div><div><p><code>type Message = Object {class: "org.mule.runtime.api.message.Message"}</code></p></div></div></td><td><div><div><p>Type that represents a Mule message.</p></div></div></td></tr></tbody></table>

<!-- document id=44e49193cf4d1322967357a4588aad5398a4a5de337c72a31822b08faa9f56c6 url=/mulesoft/current/en-us/dataweave/latest/dw-mule-types.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Mule Types (dw::Mule)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>Error</p></td><td><div><div><p><code>type Error = { description?: String, detailedDescription?: String, errorType?: ErrorType, childErrors?: Array&lt;Error&gt; }</code></p></div></div></td><td><div><div><p>Type that represents an Error and contains the following fields:</p></div><div><ul><li><p><code>description</code>: Concise description of the error.</p></li><li><p><code>detailedDescription</code>: Detailed description of the error. This message can include information specific to a Java exception.</p></li><li><p><code>errorType</code>: Returns the type of the error.</p></li><li><p><code>childErrors</code>: Lists child Errors, if any. For example, the Scatter-Gather router might throw an error aggregating all of its routes errors as children. Not all failing components aggregate errors, so this type can return an empty collection.</p></li></ul></div></div></td></tr><tr><td><p>ErrorType</p></td><td><div><div><p><code>type ErrorType = { identifier?: String, namespace?: String, parentErrorType?: ErrorType | Null }</code></p></div></div></td><td><div><div><p>A type of error that a Mule component can throw.</p></div><div><p>The error type has a <code>identifier</code> string that end users can provide in the Mule configuration.</p></div><div><p>Every error belongs to a <code>namespace</code> to avoid collisions with errors that have the same <code>identifier</code> string but belong to different namespace.</p></div><div><p>Error types can be a specialization of a more general error type, in which case the <code>parentErrorType</code> should return the more general error type. This type is used during error type matching within error handlers. So when selecting the general error type for error handling, it also handles the more specialized error types.</p></div></div></td></tr><tr><td><p>Message</p></td><td><div><div><p><code>type Message = Object {class: "org.mule.runtime.api.message.Message"}</code></p></div></div></td><td><div><div><p>Type that represents a Mule message.</p></div></div></td></tr></tbody></table>

<!-- document id=ead56340c46a73e87fa12db22c8d058a1c654baa1d5fc08d6d78572ef2c979a8 url=/mulesoft/current/en-us/dataweave/2.3/dw-mule-types.md -->

---
product: DataWeave
version: 2.3
---

# Mule Types (Mule)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>Error</p></td><td><p><code>type Error = { description?: String, detailedDescription?: String, errorType?: ErrorType, childErrors?: Array&lt;Error&gt; }</code></p></td><td><div><div><p>A complex type that represents an Error:</p></div><div><ul><li><p><code>description?: String</code>: Concise description of the error.</p></li><li><p><code>detailedDescription?: String</code>: Detailed description of the error. This message can include information specific to a Java exception.</p></li><li><p><code>errorType?: ErrorType</code>: Returns the type of the error.</p></li><li><p><code>childErrors?: Array&lt;Error&gt;</code>: Lists child Errors, if any. For example, the Scatter-Gather router might throw an error aggregating all of its routing errors as children.</p></li></ul></div><div><p>Not all failing components aggregate errors, so this type can return an empty collection.</p></div></div></td></tr><tr><td><p>ErrorType</p></td><td><p><code>type ErrorType = { identifier?: String, namespace?: String, parentErrorType?: ErrorType }</code></p></td><td><div><div><p>A type of error that a Mule component can throw.</p></div><div><ul><li><p>The error type has a <code>identifier</code> string that end users can provide in the Mule configuration.</p></li><li><p>Every error belongs to a <code>namespace</code> to avoid collisions with errors that have the same <code>identifier</code> string but belong to different namespace.</p></li><li><p>Error types can be a specialization of a more general error type, in which case the <code>parentErrorType</code> should return the more general error type. This type is used during error type matching within error handlers. So when selecting the general error type for error handling, it also handles the more specialized error types.</p></li></ul></div></div></td></tr><tr><td><p>Message</p></td><td><p><code>type Message = Object {class: "org.mule.runtime.api.message.Message"}</code></p></td><td><p>Type that represents a Mule message.</p></td></tr></tbody></table>

<!-- document id=6a2f62c55bed15e4ee17954809dc2f5867a2b78fb16f38038e94fd609f58d3f0 url=/mulesoft/current/en-us/dataweave/2.4/dw-mule-types.md -->

---
product: DataWeave
version: 2.4
---

# Mule Types (Mule)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>Error</p></td><td><div><div><p><code>type Error = { description?: String, detailedDescription?: String, errorType?: ErrorType, childErrors?: Array&lt;Error&gt; }</code></p></div></div></td><td><div><div><p>A complex type that represents an Error:</p></div><div><ul><li><p><code>description?: String</code>: Concise description of the error.</p></li><li><p><code>detailedDescription?: String</code>: Detailed description of the error. This message can include information specific to a Java exception.</p></li><li><p><code>errorType?: ErrorType</code>: Returns the type of the error.</p></li><li><p><code>childErrors?: Array&lt;Error&gt;</code>: Lists child Errors, if any. For example, the Scatter-Gather router might throw an error aggregating all of its routing errors as children.</p></li></ul></div><div><p>Not all failing components aggregate errors, so this type can return an empty collection.</p></div></div></td></tr><tr><td><p>ErrorType</p></td><td><div><div><p><code>type ErrorType = { identifier?: String, namespace?: String, parentErrorType?: ErrorType }</code></p></div></div></td><td><div><div><p>A type of error that a Mule component can throw.</p></div><div><ul><li><p>The error type has a <code>identifier</code> string that end users can provide in the Mule configuration.</p></li><li><p>Every error belongs to a <code>namespace</code> to avoid collisions with errors that have the same <code>identifier</code> string but belong to different namespace.</p></li><li><p>Error types can be a specialization of a more general error type, in which case the <code>parentErrorType</code> should return the more general error type. This type is used during error type matching within error handlers. So when selecting the general error type for error handling, it also handles the more specialized error types.</p></li></ul></div></div></td></tr><tr><td><p>Message</p></td><td><div><div><p><code>type Message = Object {class: "org.mule.runtime.api.message.Message"}</code></p></div></div></td><td><div><div><p>Type that represents a Mule message.</p></div></div></td></tr></tbody></table>

<!-- document id=991992b17ad0c355c4af136d51640c606f8401e7f1cf8e8cfce3a9b0e761eb90 url=/mulesoft/current/en-us/dataweave/2.11/dw-multipart.md -->

---
product: DataWeave
version: 2.11
---

# Multipart (dw::module::Multipart)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This helper module provide functions for creating MultiPart and formats and parts (including fields
and boundaries) of MultiPart formats.

To use this module, you must import it into your DataWeave code, for example, by adding the line
`import dw::module::Multipart` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-multipart-functions-field">field</a></p></td><td><p>Creates a <code>MultipartPart</code> data structure using the specified part name, input content for the part, format (or mime type), and optionally, file name.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-multipart-functions-file">file</a></p></td><td><p>Creates a <code>MultipartPart</code> data structure from a resource file.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-multipart-functions-form">form</a></p></td><td><p>Creates a <code>Multipart</code> data structure using a specified array of parts.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-multipart-functions-generateboundary">generateBoundary</a></p></td><td><p>Helper function for generating boundaries in <code>Multipart</code> data structures.</p></td></tr></tbody></table>

## Types

- [Multipart Types](https://docs.mulesoft.com/dataweave/2.11/dw-multipart-types)

<!-- document id=45018df7e95f06ddd6889120aff617d3eb1c1c90781571ee92f3978487dd42c0 url=/mulesoft/current/en-us/dataweave/2.12/dw-multipart.md -->

---
product: DataWeave
version: 2.12
---

# Multipart (dw::module::Multipart)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This helper module provide functions for creating MultiPart and formats and parts (including fields
and boundaries) of MultiPart formats.

To use this module, you must import it into your DataWeave code, for example, by adding the line
`import dw::module::Multipart` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-multipart-functions-field">field</a></p></td><td><p>Creates a <code>MultipartPart</code> data structure using the specified part name, input content for the part, format (or mime type), and optionally, file name.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-multipart-functions-file">file</a></p></td><td><p>Creates a <code>MultipartPart</code> data structure from a resource file.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-multipart-functions-form">form</a></p></td><td><p>Creates a <code>Multipart</code> data structure using a specified array of parts.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-multipart-functions-generateboundary">generateBoundary</a></p></td><td><p>Helper function for generating boundaries in <code>Multipart</code> data structures.</p></td></tr></tbody></table>

## Types

- [Multipart Types](https://docs.mulesoft.com/dataweave/2.12/dw-multipart-types)

<!-- document id=8db3807474bcabdd2bc994c771a082a0950128031bacc8822ec6ca95617bf427 url=/mulesoft/current/en-us/dataweave/2.3/dw-multipart.md -->

---
product: DataWeave
version: 2.3
---

# Multipart (dw::module::Multipart)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This helper module provide functions for creating MultiPart and formats and parts (including fields
and boundaries) of MultiPart formats.

To use this module, you must import it into your DataWeave code, for example, by adding the line
`import dw::module::Multipart` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-multipart-functions-field">field</a></p></td><td><p>Creates a <code>MultipartPart</code> data structure using the specified part name, input content for the part, format (or mime type), and optionally, file name.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-multipart-functions-file">file</a></p></td><td><p>Creates a <code>MultipartPart</code> data structure from a resource file.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-multipart-functions-form">form</a></p></td><td><p>Creates a <code>Multipart</code> data structure using a specified array of parts.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-multipart-functions-generateboundary">generateBoundary</a></p></td><td><p>Helper function for generating boundaries in <code>Multipart</code> data structures.</p></td></tr></tbody></table>

## Types

- [Multipart Types](https://docs.mulesoft.com/dataweave/2.3/dw-multipart-types)

<!-- document id=ba7b5aa4da6df1b52c928f55bc117fe94809d2dca8a048ec8591a9be857a3371 url=/mulesoft/current/en-us/dataweave/2.4/dw-multipart.md -->

---
product: DataWeave
version: 2.4
---

# Multipart (dw::module::Multipart)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This helper module provide functions for creating MultiPart and formats and parts (including fields
and boundaries) of MultiPart formats.

To use this module, you must import it into your DataWeave code, for example, by adding the line
`import dw::module::Multipart` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-multipart-functions-field">field</a></p></td><td><div><div><p>Creates a <code>MultipartPart</code> data structure using the specified part name, input content for the part, format (or mime type), and optionally, file name.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-multipart-functions-file">file</a></p></td><td><div><div><p>Creates a <code>MultipartPart</code> data structure from a resource file.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-multipart-functions-form">form</a></p></td><td><div><div><p>Creates a <code>Multipart</code> data structure using a specified array of parts.</p></div></div></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-multipart-functions-generateboundary">generateBoundary</a></p></td><td><div><div><p>Helper function for generating boundaries in <code>Multipart</code> data structures.</p></div></div></td></tr></tbody></table>

## Types

- [Multipart Types](https://docs.mulesoft.com/dataweave/2.4/dw-multipart-types)

<!-- document id=41f779e06d54eff8418b45c3fb7d103980040b63ae2264d6489f1d27163e041f url=/mulesoft/current/en-us/dataweave/2.6/dw-multipart.md -->

---
product: DataWeave
version: 2.6
---

# Multipart (dw::module::Multipart)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This helper module provide functions for creating MultiPart and formats and parts (including fields
and boundaries) of MultiPart formats.

To use this module, you must import it into your DataWeave code, for example, by adding the line
`import dw::module::Multipart` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-multipart-functions-field">field</a></p></td><td><p>Creates a <code>MultipartPart</code> data structure using the specified part name, input content for the part, format (or mime type), and optionally, file name.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-multipart-functions-file">file</a></p></td><td><p>Creates a <code>MultipartPart</code> data structure from a resource file.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-multipart-functions-form">form</a></p></td><td><p>Creates a <code>Multipart</code> data structure using a specified array of parts.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-multipart-functions-generateboundary">generateBoundary</a></p></td><td><p>Helper function for generating boundaries in <code>Multipart</code> data structures.</p></td></tr></tbody></table>

## Types

- [Multipart Types](https://docs.mulesoft.com/dataweave/2.6/dw-multipart-types)

<!-- document id=d2bf33bd921b82ed08ab5fe7e7d30994936ddfadef985c78bd9511733c866810 url=/mulesoft/current/en-us/dataweave/2.9/dw-multipart.md -->

---
product: DataWeave
version: 2.9
---

# Multipart (dw::module::Multipart)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This helper module provide functions for creating MultiPart and formats and parts (including fields
and boundaries) of MultiPart formats.

To use this module, you must import it into your DataWeave code, for example, by adding the line
`import dw::module::Multipart` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-multipart-functions-field">field</a></p></td><td><p>Creates a <code>MultipartPart</code> data structure using the specified part name, input content for the part, format (or mime type), and optionally, file name.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-multipart-functions-file">file</a></p></td><td><p>Creates a <code>MultipartPart</code> data structure from a resource file.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-multipart-functions-form">form</a></p></td><td><p>Creates a <code>Multipart</code> data structure using a specified array of parts.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-multipart-functions-generateboundary">generateBoundary</a></p></td><td><p>Helper function for generating boundaries in <code>Multipart</code> data structures.</p></td></tr></tbody></table>

## Types

- [Multipart Types](https://docs.mulesoft.com/dataweave/2.9/dw-multipart-types)

<!-- document id=82e0093d6232874c2179edc27cc7865c966993a0857d1fd01da1d6dad7445a8b url=/mulesoft/current/en-us/dataweave/latest/dw-multipart.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Multipart (dw::module::Multipart)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This helper module provide functions for creating MultiPart and formats and parts (including fields
and boundaries) of MultiPart formats.

To use this module, you must import it into your DataWeave code, for example, by adding the line
`import dw::module::Multipart` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-multipart-functions-field">field</a></p></td><td><p>Creates a <code>MultipartPart</code> data structure using the specified part name, input content for the part, format (or mime type), and optionally, file name.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-multipart-functions-file">file</a></p></td><td><p>Creates a <code>MultipartPart</code> data structure from a resource file.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-multipart-functions-form">form</a></p></td><td><p>Creates a <code>Multipart</code> data structure using a specified array of parts.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-multipart-functions-generateboundary">generateBoundary</a></p></td><td><p>Helper function for generating boundaries in <code>Multipart</code> data structures.</p></td></tr></tbody></table>

## Types

- [Multipart Types](https://docs.mulesoft.com/dataweave/latest/dw-multipart-types)

<!-- document id=ad90d8c83ba9c568fa3190d870fb84a506c4e847e9372d930a67b1018e506cc2 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-formats-multipart.md -->

---
product: DataWeave
version: 2.11
keywords: format, multipart, multipart/*, multipart/form-data
---

# Multipart (Form Data) Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `multipart/form-data`

ID: `multipart`

DataWeave supports Multipart subtypes, in particular `form-data`. These formats enable you to handle
several different data parts in a single payload, regardless of the format each part has. To
distinguish the beginning and end of a part, a boundary is used and metadata for each part can be
added through headers.

DataWeave represents a Multipart document with the given `Object` structure:

```weave
type Multipart = {
  preamble?: String,
  parts: {
    _?: MultipartPart
  }
}
type MultipartPart = {
  headers?: {
    "Content-Disposition"?: {
      name: String,
      filename?: String
    },
    "Content-Type"?: String
  },
  content: Any
}
```

## Examples

The following examples show uses of the Multipart format.

- [Example: Multipart](#example1)

- [Example: Access and Transform Data from Parts](#example2)

- [Example: Generate Multipart Content](#example3)

- [Example: Iterate through Multipart payload](#example4)

- [Example: Using ^mediaType and ^mimeType Metadata Selectors](#example5)

### Example: Multipart

This example shows how DataWeave reads simple Multipart content.

#### Input

The Multipart input serves as the payload to the DataWeave source.

```text
--34b21
Content-Disposition: form-data; name="text"
Content-Type: text/plain
Book
--34b21
Content-Disposition: form-data; name="file1"; filename="a.json"
Content-Type: application/json
{
"title": "Java 8 in Action",
"author": "Mario Fusco",
"year": 2014
}
--34b21
Content-Disposition: form-data; name="file2"; filename="a.html"
Content-Type: text/html

<title> Available for download! </title>
--34b21--
```

#### Source

The DataWeave script transforms the Multipart input payload to the DataWeave (dw) format.

```weave
%dw 2.0
output application/dw
---
payload
```

#### Output

The output shows how the DataWeave (dw) format represents the Multipart input. Note that the `raw`
and `content` values are shortened for brevity. The full values are longer.

```weave
{
    parts: {
        text: {
            headers: {
                "Content-Disposition": {
                    name: "text",
                    subtype: "form-data"
                },
                "Content-Type": "text/plain"
            },
        content: "Book" as String {
            raw: "Qm9vaw==" as Binary {
                    base: "64"
                },
                encoding: null,
                mediaType: "text/plain",
                mimeType: "text/plain"
            }
        },
        file1: {
            headers: {
                "Content-Disposition": {
                    name: "file1",
                    filename: "a.json",
                    subtype: "form-data"
                },
                "Content-Type": "application/json"
            },
            content: {
                title: "Java 8 in Action",
                author: "Mario Fusco",
                year: 2014
            } as Object {
                raw: "ewogICJ0aXRsZSI6ICJKYXZhI...==" as Binary {
                    base: "64"
                },
                encoding: null,
                mediaType: "application/json",
                mimeType: "application/json"
            }
        },
        file2: {
            headers: {
                "Content-Disposition": {
                    name: "file2",
                    filename: "a.html",
                    subtype: "form-data"
                },
                "Content-Type": "text/html"
            },
            content: "PCFET0NUWVBFIGh0bWw+Cjx0aXRsZT4KI...==" as Binary {
                base: "64"
            }
       }
    }
}
----
```

### Example: Access and Transform Data from Parts

Within a DataWeave script, you can access and transform data from any of the parts by selecting the
`parts` element. Navigation can be array-based or key-based when parts feature a name to reference
them by. The part’s data can be accessed through the `content` keyword, while headers can be
accessed through the `headers` keyword.

#### Input

This example serves as input to separate DataWeave scripts. It shows a raw `multipart/form-data`
payload with a `34b21` boundary consisting of 3 parts:

- a `text/plain` one named `text`

- an `application/json` file (`a.json`) named `file1`

- a `text/html` file (`a.html`) named `file2`

Raw Multipart Data:

```text
--34b21
Content-Disposition: form-data; name="text"
Content-Type: text/plain

Book
--34b21
Content-Disposition: form-data; name="file1"; filename="a.json"
Content-Type: application/json

{
  "title": "Java 8 in Action",
  "author": "Mario Fusco",
  "year": 2014
}
--34b21
Content-Disposition: form-data; name="file2"; filename="a.html"
Content-Type: text/html

<!DOCTYPE html>
<title>
  Available for download!
</title>
--34b21--
```

#### Source

The following DataWeave script uses the raw `multipart/form-data` payload as input to produce
`Book:a.json`.

Reading Multipart Content:

```dataweave
%dw 2.0
output text/plain
---
payload.parts.text.content ++ ':' ++ payload.parts[1].headers.'Content-Disposition'.filename
```

### Example: Generate Multipart Content

You can generate multipart content that DataWeave uses to build an object with a list of parts, each
containing its headers and content. The following DataWeave script produces the raw multipart data
(previously analyzed) if the HTML data is available in the payload.

> [!NOTE] To provide a consistent output in the DataWeave documentation, the example hardcodes the
> `boundary` property. However, you do not need to hardcode this property in most cases because
> DataWeave generates a random boundary and adds it to the output MIME type.

Writing Multipart Content:

```dataweave
%dw 2.0
output multipart/form-data boundary='34b21'
---
{
  parts : {
    text : {
      headers : {
        "Content-Type": "text/plain"
      },
      content : "Book"
    },
    file1 : {
      headers : {
        "Content-Disposition" : {
            "name": "file1",
            "filename": "a.json"
        },
        "Content-Type" : "application/json"
      },
      content : {
        title: "Java 8 in Action",
        author: "Mario Fusco",
        year: 2014
      }
    },
    file2 : {
      headers : {
        "Content-Disposition" : {
            "filename": "a.html"
        },
        "Content-Type" : payload.^mimeType
      },
      content : payload
    }
  }
}
```

Notice that the key determines the part’s name if the name is not explicitly provided in the
`Content-Disposition` header, and note that DataWeave can handle content from supported formats, as
well as references to unsupported ones, such as HTML.

The following example shows how to send the current payload as a file part in a multipart form-data.
You need to use a DataWeave script similar to the following:

```dataweave
%dw 2.0
input payload application/xml
output multipart/form-data boundary="----myboundary----"
---
{
  parts: {
    filePart: {
      headers: {
        "Content-Disposition": {
          "name": "<NAME>",
          "filename": "<FILE_NAME>.<FILE_EXTENSION>"
        },
        "Content-Type": "<FILE_CONTENT-TYPE>"
      },
      content: payload
    },
    otherJsonPart: {
      content: '{"name": "sampleFile.xml", "sampleFile": {"type": "sample"} }'
    }
  }
}
```

- `boundary` sets the boundary value, for example `"----myboundary----"`.

- `<NAME>` is the tag name of your file, for example `"sampleFile"`.

- `<FILE_NAME>.<FILE_EXTENSION>` is the filename to populate the payload content, for example
  `"sampleFile.xml"`.

- `<FILE_CONTENT-TYPE>` matches the content of the file you send, for example `"application/xml"`.

- The content of the file is the current payload.

This example contains two parts in the multipart which are the file and the `otherJsonPart`. In case
you want to add more parts, add them under the `parts:{}` section with the following format:

```dataweave
  <PART_NAME>: {
    content: <PART_CONTENT>
  }
```

- `<PART_NAME>` is the name of the part without quotes, for example `json`.

- `<PART_CONTENT>` is the content for that part, for example
  `'{"name": "sampleFile.xml", "sampleFile": {"type": "sample"} }'`.

Based on the following XML input:

```xml
<Customers>
	<Customer>
		<Number>1</Number>
		<FirstName>Fred</FirstName>
		<LastName>Landis</LastName>
		<Address>
			<Street>Oakstreet</Street>
			<City>Boston</City>
			<ZIP>23320</ZIP>
			<State>MA</State>
		</Address>
	</Customer>
	<Customer>
		<Number>2</Number>
		<FirstName>Michelle</FirstName>
		<LastName>Butler</LastName>
		<Address>
			<Street>First Avenue</Street>
			<City>San-Francisco</City>
			<ZIP>44324</ZIP>
			<State>CA</State>
		</Address>
	</Customer>
	<Customer>
		<Number>3</Number>
		<FirstName>Ted</FirstName>
		<LastName>Little</LastName>
		<Address>
			<Street>Long Way</Street>
			<City>Los-Angeles</City>
			<ZIP>34424</ZIP>
			<State>CA</State>
		</Address>
	</Customer>
</Customers>
```

The DataWeave script is:

```dataweave
%dw 2.0
output multipart/form-data  boundary="----myboundary----"
---
{
  parts: {
    filePart: {
      headers: {
        "Content-Disposition": {
          "name": "test",
          "filename": "sampleFile.xml"
        },
        "Content-Type": "application/xml"
      },
      content: payload
    },
    otherJsonPart: {
      content: '{"name": "sampleFile.xml", "sampleFile": {"type": "sample"} }'
    }
  }
}
```

The output multipart is:

```multipart
------myboundary----
Content-Type: application/xml
Content-Disposition: form-data; name="test"; filename="sampleFile.xml"

<Customers>
  <Customer>
    <Number>1</Number>
    <FirstName>Fred</FirstName>
    <LastName>Landis</LastName>
    <Address>
      <Street>Oakstreet</Street>
      <City>Boston</City>
      <ZIP>23320</ZIP>
      <State>MA</State>
    </Address>
  </Customer>
  <Customer>
    <Number>2</Number>
    <FirstName>Michelle</FirstName>
    <LastName>Butler</LastName>
    <Address>
      <Street>First Avenue</Street>
      <City>San-Francisco</City>
      <ZIP>44324</ZIP>
      <State>CA</State>
    </Address>
  </Customer>
  <Customer>
    <Number>3</Number>
    <FirstName>Ted</FirstName>
    <LastName>Little</LastName>
    <Address>
      <Street>Long Way</Street>
      <City>Los-Angeles</City>
      <ZIP>34424</ZIP>
      <State>CA</State>
    </Address>
  </Customer>
</Customers>
------myboundary----
Content-Disposition: form-data; name="otherJsonPart"

{"name": "sampleFile.xml", "sampleFile": {"type": "sample"} }
------myboundary------
```

### Example: Iterate through Multipart payload

This example shows how DataWeave iterates through all the parts of the payload and processes the
each part individually.

### Source

```dataweave
%dw 2.0
output application/json
var multi = '--34b21
Content-Disposition: form-data; name="text"
Content-Type: text/plain

Book
--34b21
Content-Disposition: form-data; name="file1"; filename="a.json"
Content-Type: application/json

{
"title":"Java 8 in Action",
"author":"Mario Fusco",
"year":2014
}
--34b21
Content-Disposition: form-data; name="file2"; filename="a.html"
Content-Type: text/html

<!DOCTYPE html>
<title>
Available for download!
</title>
--34b21--'
var parsed = read(multi, "multipart/form-data", {boundary:'34b21'})
---
parsed.parts mapObject ((value, key, index) -> {(index): key})
```

### Output

```json
{
  "0": "text",
  "1": "file1",
  "2": "file2"
}
```

### Example: Using ^mediaType and ^mimeType Metadata Selectors

The `^mimeType` selector returns the MIME type of a value without parameters, for example,
`application/json`. The `^mediaType` selector, by contrast, provides the MIME type and any other
parameters related to it, for example, `application/json;charset=UTF-16`.

The following example shows how to transform multipart inputs into multipart outputs with a
different format. The DataWeave script uses both the `^mimeType` and `^mediaType` selectors to
generate the new multipart content.

### Input

The multipart input has more than one Content-Type. In this case `application/json` and
`application/csv` including a non-standard separator:

```text
----------------------------049709565842371278701691
Content-Type: application/json
Content-Disposition: form-data; name="order"

{
"name": "order1",
"id": 123,
"content": "orderContent"
}
----------------------------049709565842371278701691
Content-Type: application/csv;separator=.
Content-Disposition: form-data; name="partner"

partnerName.id
mulesoft.1
----------------------------049709565842371278701691--
```

### Source

The DataWeave script transforms the multipart input into multipart output by defining
`output multipart/form-data` MIME type. The multipart output data contains two parts:

- `orderAck`

Contains a text with an acknowledgement of the receipt of an order. The Content-Type is
`text/plain`. The ^mimeType\` selector becomes useful to log the Content-Type as part of the
message.

- `partner`

Contains the original partner itself. Notice that this time, the Content-Type is
`payload.parts..^mediaType`. The ^mediaType selector includes also the separator, that parses the
`application/csv` content.

```dataweave
%dw 2.0
input payload multipart boundary='boundary1'
output multipart boundary='test2'
---
{
  parts : {
    orderAck : {
      headers : {
        "Content-Type": "text/plain"
      },
      content : "Order payload of type " ++ payload.parts.order.content.^mimeType ++ " and id " ++ (payload.parts.order.content.id as String) ++ " received. Receipt available."
    },
    partner: {
      headers : {
        "Content-Type": payload.parts.partner.content.^mediaType
      },
      content : payload.parts.partner.content
    }
  }
}
```

### Output

```text
--test2
Content-Type: text/plain
Content-Disposition: form-data; name="orderAck"

Order payload of type application/json and id 123 received. Receipt available.
--test2
Content-Type: application/csv;separator=.
Content-Disposition: form-data; name="partner"

partnerName.id
mulesoft.1
--test2--
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>boundary</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The multipart <code>boundary</code> value, a string to delimit parts.</p></div></div></td></tr><tr><td><p><code>defaultContentType</code></p></td><td><p><code>String</code></p></td><td><p><code>'application/octet-stream'</code></p></td><td><div><div><p>Sets the default Content-Type to use on parts of the <code>multipart/*</code> format. When set, this property takes precedence over the setting for the <a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-system-properties">system property</a> <code>com.mulesoft.dw.multipart.defaultContentType</code>.</p></div><div><p><em>Introduced in DataWeave 2.3 (2.3.0-20210720) for the August 2021 release of Mule 4.3.0-20210719.</em></p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>boundary</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The multipart <code>boundary</code> value, a string to delimit parts.</p></div></div></td></tr><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>multipart/*</code></p></td></tr></tbody></table>

<!-- document id=76cdd4fd5c60603bce4962b77a3e69436fb9ef1e2887e32f18fa74b1f4535771 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-formats-multipart.md -->

---
product: DataWeave
version: 2.12
keywords: format, multipart, multipart/*, multipart/form-data
---

# Multipart (Form Data) Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `multipart/form-data`

ID: `multipart`

DataWeave supports Multipart subtypes, in particular `form-data`. These formats enable you to handle
several different data parts in a single payload, regardless of the format each part has. To
distinguish the beginning and end of a part, a boundary is used and metadata for each part can be
added through headers.

DataWeave represents a Multipart document with the given `Object` structure:

```weave
type Multipart = {
  preamble?: String,
  parts: {
    _?: MultipartPart
  }
}
type MultipartPart = {
  headers?: {
    "Content-Disposition"?: {
      name: String,
      filename?: String
    },
    "Content-Type"?: String
  },
  content: Any
}
```

## Examples

The following examples show uses of the Multipart format.

- [Example: Multipart](#example1)

- [Example: Access and Transform Data from Parts](#example2)

- [Example: Generate Multipart Content](#example3)

- [Example: Iterate through Multipart payload](#example4)

- [Example: Using ^mediaType and ^mimeType Metadata Selectors](#example5)

### Example: Multipart

This example shows how DataWeave reads simple Multipart content.

#### Input

The Multipart input serves as the payload to the DataWeave source.

```text
--34b21
Content-Disposition: form-data; name="text"
Content-Type: text/plain
Book
--34b21
Content-Disposition: form-data; name="file1"; filename="a.json"
Content-Type: application/json
{
"title": "Java 8 in Action",
"author": "Mario Fusco",
"year": 2014
}
--34b21
Content-Disposition: form-data; name="file2"; filename="a.html"
Content-Type: text/html

<title> Available for download! </title>
--34b21--
```

#### Source

The DataWeave script transforms the Multipart input payload to the DataWeave (dw) format.

```weave
%dw 2.0
output application/dw
---
payload
```

#### Output

The output shows how the DataWeave (dw) format represents the Multipart input. Note that the `raw`
and `content` values are shortened for brevity. The full values are longer.

```weave
{
    parts: {
        text: {
            headers: {
                "Content-Disposition": {
                    name: "text",
                    subtype: "form-data"
                },
                "Content-Type": "text/plain"
            },
        content: "Book" as String {
            raw: "Qm9vaw==" as Binary {
                    base: "64"
                },
                encoding: null,
                mediaType: "text/plain",
                mimeType: "text/plain"
            }
        },
        file1: {
            headers: {
                "Content-Disposition": {
                    name: "file1",
                    filename: "a.json",
                    subtype: "form-data"
                },
                "Content-Type": "application/json"
            },
            content: {
                title: "Java 8 in Action",
                author: "Mario Fusco",
                year: 2014
            } as Object {
                raw: "ewogICJ0aXRsZSI6ICJKYXZhI...==" as Binary {
                    base: "64"
                },
                encoding: null,
                mediaType: "application/json",
                mimeType: "application/json"
            }
        },
        file2: {
            headers: {
                "Content-Disposition": {
                    name: "file2",
                    filename: "a.html",
                    subtype: "form-data"
                },
                "Content-Type": "text/html"
            },
            content: "PCFET0NUWVBFIGh0bWw+Cjx0aXRsZT4KI...==" as Binary {
                base: "64"
            }
       }
    }
}
----
```

### Example: Access and Transform Data from Parts

Within a DataWeave script, you can access and transform data from any of the parts by selecting the
`parts` element. Navigation can be array-based or key-based when parts feature a name to reference
them by. The part’s data can be accessed through the `content` keyword, while headers can be
accessed through the `headers` keyword.

#### Input

This example serves as input to separate DataWeave scripts. It shows a raw `multipart/form-data`
payload with a `34b21` boundary consisting of 3 parts:

- a `text/plain` one named `text`

- an `application/json` file (`a.json`) named `file1`

- a `text/html` file (`a.html`) named `file2`

Raw Multipart Data:

```text
--34b21
Content-Disposition: form-data; name="text"
Content-Type: text/plain

Book
--34b21
Content-Disposition: form-data; name="file1"; filename="a.json"
Content-Type: application/json

{
  "title": "Java 8 in Action",
  "author": "Mario Fusco",
  "year": 2014
}
--34b21
Content-Disposition: form-data; name="file2"; filename="a.html"
Content-Type: text/html

<!DOCTYPE html>
<title>
  Available for download!
</title>
--34b21--
```

#### Source

The following DataWeave script uses the raw `multipart/form-data` payload as input to produce
`Book:a.json`.

Reading Multipart Content:

```dataweave
%dw 2.0
output text/plain
---
payload.parts.text.content ++ ':' ++ payload.parts[1].headers.'Content-Disposition'.filename
```

### Example: Generate Multipart Content

You can generate multipart content that DataWeave uses to build an object with a list of parts, each
containing its headers and content. The following DataWeave script produces the raw multipart data
(previously analyzed) if the HTML data is available in the payload.

> [!NOTE] To provide a consistent output in the DataWeave documentation, the example hardcodes the
> `boundary` property. However, you do not need to hardcode this property in most cases because
> DataWeave generates a random boundary and adds it to the output MIME type.

Writing Multipart Content:

```dataweave
%dw 2.0
output multipart/form-data boundary='34b21'
---
{
  parts : {
    text : {
      headers : {
        "Content-Type": "text/plain"
      },
      content : "Book"
    },
    file1 : {
      headers : {
        "Content-Disposition" : {
            "name": "file1",
            "filename": "a.json"
        },
        "Content-Type" : "application/json"
      },
      content : {
        title: "Java 8 in Action",
        author: "Mario Fusco",
        year: 2014
      }
    },
    file2 : {
      headers : {
        "Content-Disposition" : {
            "filename": "a.html"
        },
        "Content-Type" : payload.^mimeType
      },
      content : payload
    }
  }
}
```

Notice that the key determines the part’s name if the name is not explicitly provided in the
`Content-Disposition` header, and note that DataWeave can handle content from supported formats, as
well as references to unsupported ones, such as HTML.

The following example shows how to send the current payload as a file part in a multipart form-data.
You need to use a DataWeave script similar to the following:

```dataweave
%dw 2.0
input payload application/xml
output multipart/form-data boundary="----myboundary----"
---
{
  parts: {
    filePart: {
      headers: {
        "Content-Disposition": {
          "name": "<NAME>",
          "filename": "<FILE_NAME>.<FILE_EXTENSION>"
        },
        "Content-Type": "<FILE_CONTENT-TYPE>"
      },
      content: payload
    },
    otherJsonPart: {
      content: '{"name": "sampleFile.xml", "sampleFile": {"type": "sample"} }'
    }
  }
}
```

- `boundary` sets the boundary value, for example `"----myboundary----"`.

- `<NAME>` is the tag name of your file, for example `"sampleFile"`.

- `<FILE_NAME>.<FILE_EXTENSION>` is the filename to populate the payload content, for example
  `"sampleFile.xml"`.

- `<FILE_CONTENT-TYPE>` matches the content of the file you send, for example `"application/xml"`.

- The content of the file is the current payload.

This example contains two parts in the multipart which are the file and the `otherJsonPart`. In case
you want to add more parts, add them under the `parts:{}` section with the following format:

```dataweave
  <PART_NAME>: {
    content: <PART_CONTENT>
  }
```

- `<PART_NAME>` is the name of the part without quotes, for example `json`.

- `<PART_CONTENT>` is the content for that part, for example
  `'{"name": "sampleFile.xml", "sampleFile": {"type": "sample"} }'`.

Based on the following XML input:

```xml
<Customers>
	<Customer>
		<Number>1</Number>
		<FirstName>Fred</FirstName>
		<LastName>Landis</LastName>
		<Address>
			<Street>Oakstreet</Street>
			<City>Boston</City>
			<ZIP>23320</ZIP>
			<State>MA</State>
		</Address>
	</Customer>
	<Customer>
		<Number>2</Number>
		<FirstName>Michelle</FirstName>
		<LastName>Butler</LastName>
		<Address>
			<Street>First Avenue</Street>
			<City>San-Francisco</City>
			<ZIP>44324</ZIP>
			<State>CA</State>
		</Address>
	</Customer>
	<Customer>
		<Number>3</Number>
		<FirstName>Ted</FirstName>
		<LastName>Little</LastName>
		<Address>
			<Street>Long Way</Street>
			<City>Los-Angeles</City>
			<ZIP>34424</ZIP>
			<State>CA</State>
		</Address>
	</Customer>
</Customers>
```

The DataWeave script is:

```dataweave
%dw 2.0
output multipart/form-data  boundary="----myboundary----"
---
{
  parts: {
    filePart: {
      headers: {
        "Content-Disposition": {
          "name": "test",
          "filename": "sampleFile.xml"
        },
        "Content-Type": "application/xml"
      },
      content: payload
    },
    otherJsonPart: {
      content: '{"name": "sampleFile.xml", "sampleFile": {"type": "sample"} }'
    }
  }
}
```

The output multipart is:

```multipart
------myboundary----
Content-Type: application/xml
Content-Disposition: form-data; name="test"; filename="sampleFile.xml"

<Customers>
  <Customer>
    <Number>1</Number>
    <FirstName>Fred</FirstName>
    <LastName>Landis</LastName>
    <Address>
      <Street>Oakstreet</Street>
      <City>Boston</City>
      <ZIP>23320</ZIP>
      <State>MA</State>
    </Address>
  </Customer>
  <Customer>
    <Number>2</Number>
    <FirstName>Michelle</FirstName>
    <LastName>Butler</LastName>
    <Address>
      <Street>First Avenue</Street>
      <City>San-Francisco</City>
      <ZIP>44324</ZIP>
      <State>CA</State>
    </Address>
  </Customer>
  <Customer>
    <Number>3</Number>
    <FirstName>Ted</FirstName>
    <LastName>Little</LastName>
    <Address>
      <Street>Long Way</Street>
      <City>Los-Angeles</City>
      <ZIP>34424</ZIP>
      <State>CA</State>
    </Address>
  </Customer>
</Customers>
------myboundary----
Content-Disposition: form-data; name="otherJsonPart"

{"name": "sampleFile.xml", "sampleFile": {"type": "sample"} }
------myboundary------
```

### Example: Iterate through Multipart payload

This example shows how DataWeave iterates through all the parts of the payload and processes the
each part individually.

### Source

```dataweave
%dw 2.0
output application/json
var multi = '--34b21
Content-Disposition: form-data; name="text"
Content-Type: text/plain

Book
--34b21
Content-Disposition: form-data; name="file1"; filename="a.json"
Content-Type: application/json

{
"title":"Java 8 in Action",
"author":"Mario Fusco",
"year":2014
}
--34b21
Content-Disposition: form-data; name="file2"; filename="a.html"
Content-Type: text/html

<!DOCTYPE html>
<title>
Available for download!
</title>
--34b21--'
var parsed = read(multi, "multipart/form-data", {boundary:'34b21'})
---
parsed.parts mapObject ((value, key, index) -> {(index): key})
```

### Output

```json
{
  "0": "text",
  "1": "file1",
  "2": "file2"
}
```

### Example: Using ^mediaType and ^mimeType Metadata Selectors

The `^mimeType` selector returns the MIME type of a value without parameters, for example,
`application/json`. The `^mediaType` selector, by contrast, provides the MIME type and any other
parameters related to it, for example, `application/json;charset=UTF-16`.

The following example shows how to transform multipart inputs into multipart outputs with a
different format. The DataWeave script uses both the `^mimeType` and `^mediaType` selectors to
generate the new multipart content.

### Input

The multipart input has more than one Content-Type. In this case `application/json` and
`application/csv` including a non-standard separator:

```text
----------------------------049709565842371278701691
Content-Type: application/json
Content-Disposition: form-data; name="order"

{
"name": "order1",
"id": 123,
"content": "orderContent"
}
----------------------------049709565842371278701691
Content-Type: application/csv;separator=.
Content-Disposition: form-data; name="partner"

partnerName.id
mulesoft.1
----------------------------049709565842371278701691--
```

### Source

The DataWeave script transforms the multipart input into multipart output by defining
`output multipart/form-data` MIME type. The multipart output data contains two parts:

- `orderAck`

Contains a text with an acknowledgement of the receipt of an order. The Content-Type is
`text/plain`. The ^mimeType\` selector becomes useful to log the Content-Type as part of the
message.

- `partner`

Contains the original partner itself. Notice that this time, the Content-Type is
`payload.parts..^mediaType`. The ^mediaType selector includes also the separator, that parses the
`application/csv` content.

```dataweave
%dw 2.0
input payload multipart boundary='boundary1'
output multipart boundary='test2'
---
{
  parts : {
    orderAck : {
      headers : {
        "Content-Type": "text/plain"
      },
      content : "Order payload of type " ++ payload.parts.order.content.^mimeType ++ " and id " ++ (payload.parts.order.content.id as String) ++ " received. Receipt available."
    },
    partner: {
      headers : {
        "Content-Type": payload.parts.partner.content.^mediaType
      },
      content : payload.parts.partner.content
    }
  }
}
```

### Output

```text
--test2
Content-Type: text/plain
Content-Disposition: form-data; name="orderAck"

Order payload of type application/json and id 123 received. Receipt available.
--test2
Content-Type: application/csv;separator=.
Content-Disposition: form-data; name="partner"

partnerName.id
mulesoft.1
--test2--
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>boundary</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The multipart <code>boundary</code> value, a string to delimit parts.</p></div></div></td></tr><tr><td><p><code>defaultContentType</code></p></td><td><p><code>String</code></p></td><td><p><code>'application/octet-stream'</code></p></td><td><div><div><p>Sets the default Content-Type to use on parts of the <code>multipart/*</code> format. When set, this property takes precedence over the setting for the <a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-system-properties">system property</a> <code>com.mulesoft.dw.multipart.defaultContentType</code>.</p></div><div><p><em>Introduced in DataWeave 2.3 (2.3.0-20210720) for the August 2021 release of Mule 4.3.0-20210719.</em></p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>boundary</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The multipart <code>boundary</code> value, a string to delimit parts.</p></div></div></td></tr><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>multipart/*</code></p></td></tr></tbody></table>

<!-- document id=7d6f785d60766b7f8f2603b0db3e6c1ba9ca931c1567b1c3e9a56a77a5c129e2 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-formats-multipart.md -->

---
product: DataWeave
version: 2.4
keywords: format, multipart, multipart/*, multipart/form-data
---

# Multipart (Form Data) Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `multipart/form-data`

ID: `multipart`

DataWeave supports Multipart subtypes, in particular `form-data`. These formats enable you to handle
several different data parts in a single payload, regardless of the format each part has. To
distinguish the beginning and end of a part, a boundary is used and metadata for each part can be
added through headers.

DataWeave represents a Multipart document with the given `Object` structure:

```weave
type Multipart = {
  preamble?: String,
  parts: {
    _?: MultipartPart
  }
}
type MultipartPart = {
  headers?: {
    "Content-Disposition"?: {
      name: String,
      filename?: String
    },
    "Content-Type"?: String
  },
  content: Any
}
```

## Examples

The following examples show uses of the Multipart format.

- [Example: Multipart](#example1)

- [Example: Access and Transform Data from Parts](#example2)

- [Example: Generate Multipart Content](#example3)

- [Example: Iterate through Multipart payload](#example4)

- [Example: Using ^mediaType and ^mimeType Metadata Selectors](#example5)

### Example: Multipart

This example shows how DataWeave reads simple Multipart content.

#### Input

The Multipart input serves as the payload to the DataWeave source.

```text
--34b21
Content-Disposition: form-data; name="text"
Content-Type: text/plain
Book
--34b21
Content-Disposition: form-data; name="file1"; filename="a.json"
Content-Type: application/json
{
"title": "Java 8 in Action",
"author": "Mario Fusco",
"year": 2014
}
--34b21
Content-Disposition: form-data; name="file2"; filename="a.html"
Content-Type: text/html

<title> Available for download! </title>
--34b21--
```

#### Source

The DataWeave script transforms the Multipart input payload to the DataWeave (dw) format.

```weave
%dw 2.0
output application/dw
---
payload
```

#### Output

The output shows how the DataWeave (dw) format represents the Multipart input. Note that the `raw`
and `content` values are shortened for brevity. The full values are longer.

```weave
{
    parts: {
        text: {
            headers: {
                "Content-Disposition": {
                    name: "text",
                    subtype: "form-data"
                },
                "Content-Type": "text/plain"
            },
        content: "Book" as String {
            raw: "Qm9vaw==" as Binary {
                    base: "64"
                },
                encoding: null,
                mediaType: "text/plain",
                mimeType: "text/plain"
            }
        },
        file1: {
            headers: {
                "Content-Disposition": {
                    name: "file1",
                    filename: "a.json",
                    subtype: "form-data"
                },
                "Content-Type": "application/json"
            },
            content: {
                title: "Java 8 in Action",
                author: "Mario Fusco",
                year: 2014
            } as Object {
                raw: "ewogICJ0aXRsZSI6ICJKYXZhI...==" as Binary {
                    base: "64"
                },
                encoding: null,
                mediaType: "application/json",
                mimeType: "application/json"
            }
        },
        file2: {
            headers: {
                "Content-Disposition": {
                    name: "file2",
                    filename: "a.html",
                    subtype: "form-data"
                },
                "Content-Type": "text/html"
            },
            content: "PCFET0NUWVBFIGh0bWw+Cjx0aXRsZT4KI...==" as Binary {
                base: "64"
            }
       }
    }
}
----
```

### Example: Access and Transform Data from Parts

Within a DataWeave script, you can access and transform data from any of the parts by selecting the
`parts` element. Navigation can be array-based or key-based when parts feature a name to reference
them by. The part’s data can be accessed through the `content` keyword, while headers can be
accessed through the `headers` keyword.

#### Input

This example serves as input to separate DataWeave scripts. shows a raw `multipart/form-data`
payload with a `34b21` boundary consisting of 3 parts:

- a `text/plain` one named `text`

- an `application/json` file (`a.json`) named `file1`

- a `text/html` file (`a.html`) named `file2`

Raw Multipart Data:

```text
--34b21
Content-Disposition: form-data; name="text"
Content-Type: text/plain

Book
--34b21
Content-Disposition: form-data; name="file1"; filename="a.json"
Content-Type: application/json

{
  "title": "Java 8 in Action",
  "author": "Mario Fusco",
  "year": 2014
}
--34b21
Content-Disposition: form-data; name="file2"; filename="a.html"
Content-Type: text/html

<!DOCTYPE html>
<title>
  Available for download!
</title>
--34b21--
```

#### Source

The following DataWeave script uses the raw `multipart/form-data` payload as input to produce
`Book:a.json`.

Reading Multipart Content:

```dataweave
%dw 2.0
output text/plain
---
payload.parts.text.content ++ ':' ++ payload.parts[1].headers.'Content-Disposition'.filename
```

### Example: Generate Multipart Content

You can generate multipart content that DataWeave uses to build an object with a list of parts, each
containing its headers and content. The following DataWeave script produces the raw multipart data
(previously analyzed) if the HTML data is available in the payload.

Writing Multipart Content:

```dataweave
%dw 2.0
output multipart/form-data
boundary='34b21'
---
{
  parts : {
    text : {
      headers : {
        "Content-Type": "text/plain"
      },
      content : "Book"
    },
    file1 : {
      headers : {
        "Content-Disposition" : {
            "name": "file1",
            "filename": "a.json"
        },
        "Content-Type" : "application/json"
      },
      content : {
        title: "Java 8 in Action",
        author: "Mario Fusco",
        year: 2014
      }
    },
    file2 : {
      headers : {
        "Content-Disposition" : {
            "filename": "a.html"
        },
        "Content-Type" : payload.^mimeType
      },
      content : payload
    }
  }
}
```

Notice that the key determines the part’s name if the name is not explicitly provided in the
`Content-Disposition` header, and note that DataWeave can handle content from supported formats, as
well as references to unsupported ones, such as HTML.

The following example shows how to send the current payload as a file part in a multipart form-data.
You need to use a DataWeave script similar to the following:

```dataweave
%dw 2.0
input payload application/xml
output multipart/form-data boundary="----myboundary----"
---
{
  parts: {
    filePart: {
      headers: {
        "Content-Disposition": {
          "name": "<NAME>",
          "filename": "<FILE_NAME>.<FILE_EXTENSION>"
        },
        "Content-Type": "<FILE_CONTENT-TYPE>"
      },
      content: payload
    },
    otherJsonPart: {
      content: '{"name": "sampleFile.xml", "sampleFile": {"type": "sample"} }'
    }
  }
}
```

- `boundary` sets the boundary value, for example `"----myboundary----"`.

- `<NAME>` is the tag name of your file, for example `"sampleFile"`.

- `<FILE_NAME>.<FILE_EXTENSION>` is the filename to populate the payload content, for example
  `"sampleFile.xml"`.

- `<FILE_CONTENT-TYPE>` matches the content of the file you send, for example `"application/xml"`.

- The content of the file is the current payload.

This example contains two parts in the multipart which are the file and the `otherJsonPart`. In case
you want to add more parts, add them under the `parts:{}` section with the following format:

```dataweave
  <PART_NAME>: {
    content: <PART_CONTENT>
  }
```

- `<PART_NAME>` is the name of the part without quotes, for example `json`.

- `<PART_CONTENT>` is the content for that part, for example
  `'{"name": "sampleFile.xml", "sampleFile": {"type": "sample"} }'`.

Based on the following XML input:

```xml
<Customers>
	<Customer>
		<Number>1</Number>
		<FirstName>Fred</FirstName>
		<LastName>Landis</LastName>
		<Address>
			<Street>Oakstreet</Street>
			<City>Boston</City>
			<ZIP>23320</ZIP>
			<State>MA</State>
		</Address>
	</Customer>
	<Customer>
		<Number>2</Number>
		<FirstName>Michelle</FirstName>
		<LastName>Butler</LastName>
		<Address>
			<Street>First Avenue</Street>
			<City>San-Francisco</City>
			<ZIP>44324</ZIP>
			<State>CA</State>
		</Address>
	</Customer>
	<Customer>
		<Number>3</Number>
		<FirstName>Ted</FirstName>
		<LastName>Little</LastName>
		<Address>
			<Street>Long Way</Street>
			<City>Los-Angeles</City>
			<ZIP>34424</ZIP>
			<State>CA</State>
		</Address>
	</Customer>
</Customers>
```

The DataWeave script is:

```dataweave
%dw 2.0
output multipart/form-data  boundary="----myboundary----"
---
{
  parts: {
    filePart: {
      headers: {
        "Content-Disposition": {
          "name": "test",
          "filename": "sampleFile.xml"
        },
        "Content-Type": "application/xml"
      },
      content: payload
    },
    otherJsonPart: {
      content: '{"name": "sampleFile.xml", "sampleFile": {"type": "sample"} }'
    }
  }
}
```

The output multipart is:

```multipart
------myboundary----
Content-Type: application/xml
Content-Disposition: form-data; name="test"; filename="sampleFile.xml"

<Customers>
  <Customer>
    <Number>1</Number>
    <FirstName>Fred</FirstName>
    <LastName>Landis</LastName>
    <Address>
      <Street>Oakstreet</Street>
      <City>Boston</City>
      <ZIP>23320</ZIP>
      <State>MA</State>
    </Address>
  </Customer>
  <Customer>
    <Number>2</Number>
    <FirstName>Michelle</FirstName>
    <LastName>Butler</LastName>
    <Address>
      <Street>First Avenue</Street>
      <City>San-Francisco</City>
      <ZIP>44324</ZIP>
      <State>CA</State>
    </Address>
  </Customer>
  <Customer>
    <Number>3</Number>
    <FirstName>Ted</FirstName>
    <LastName>Little</LastName>
    <Address>
      <Street>Long Way</Street>
      <City>Los-Angeles</City>
      <ZIP>34424</ZIP>
      <State>CA</State>
    </Address>
  </Customer>
</Customers>
------myboundary----
Content-Disposition: form-data; name="otherJsonPart"

{"name": "sampleFile.xml", "sampleFile": {"type": "sample"} }
------myboundary------
```

### Example: Iterate through Multipart payload

This example shows how DataWeave iterates through all the parts of the payload and processes the
each part individually.

### Source

```dataweave
%dw 2.0
output application/json
var multi = '--34b21
Content-Disposition: form-data; name="text"
Content-Type: text/plain

Book
--34b21
Content-Disposition: form-data; name="file1"; filename="a.json"
Content-Type: application/json

{
"title":"Java 8 in Action",
"author":"Mario Fusco",
"year":2014
}
--34b21
Content-Disposition: form-data; name="file2"; filename="a.html"
Content-Type: text/html

<!DOCTYPE html>
<title>
Available for download!
</title>
--34b21--'
var parsed = read(multi, "multipart/form-data", {boundary:'34b21'})
---
parsed.parts mapObject ((value, key, index) -> {(index): key})
```

### Output

```json
{
  "0": "text",
  "1": "file1",
  "2": "file2"
}
```

### Example: Using ^mediaType and ^mimeType Metadata Selectors

The `^mimeType` selector returns the MIME type of a value without parameters, for example,
`application/json`. The `^mediaType` selector, by contrast, provides the MIME type and any other
parameters related to it, for example, `application/json;charset=UTF-16`.

The following example shows how to transform multipart inputs into multipart outputs with a
different format. The DataWeave script uses both the `^mimeType` and `^mediaType` selectors to
generate the new multipart content.

### Input

The multipart input has more than one Content-Type. In this case `application/json` and
`application/csv` including a non-standard separator:

```text
----------------------------049709565842371278701691
Content-Type: application/json
Content-Disposition: form-data; name="order"

{
"name": "order1",
"id": 123,
"content": "orderContent"
}
----------------------------049709565842371278701691
Content-Type: application/csv;separator=.
Content-Disposition: form-data; name="partner"

partnerName.id
mulesoft.1
----------------------------049709565842371278701691--
```

### Source

The DataWeave script transforms the multipart input into multipart output by defining
`output multipart/form-data` MIME type. The multipart output data contains two parts:

- `orderAck`

Contains a text with an acknowledgement of the receipt of an order. The Content-Type is
`text/plain`. The ^mimeType\` selector becomes useful to log the Content-Type as part of the
message.

- `partner`

Contains the original partner itself. Notice that this time, the Content-Type is
`payload.parts..^mediaType`. The ^mediaType selector includes also the separator, that parses the
`application/csv` content.

```dataweave
%dw 2.0
input payload multipart boundary='boundary1'
output multipart boundary='test2'
---
{
  parts : {
    orderAck : {
      headers : {
        "Content-Type": "text/plain"
      },
      content : "Order payload of type " ++ payload.parts.order.content.^mimeType ++ " and id " ++ (payload.parts.order.content.id as String) ++ " received. Receipt available."
    },
    partner: {
      headers : {
        "Content-Type": payload.parts.partner.content.^mediaType
      },
      content : payload.parts.partner.content
    }
  }
}
```

### Output

```text
--test2
Content-Type: text/plain
Content-Disposition: form-data; name="orderAck"

Order payload of type application/json and id 123 received. Receipt available.
--test2
Content-Type: application/csv;separator=.
Content-Disposition: form-data; name="partner"

partnerName.id
mulesoft.1
--test2--
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>boundary</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The multipart <code>boundary</code> value. A string to delimit parts.</p></div></div></td></tr><tr><td><p><code>defaultContentType</code></p></td><td><p><code>String</code></p></td><td><p>This property has no default value.</p></td><td><div><div><p>Sets the default Content-Type to use on parts of the <code>multipart/*</code> format. When set, this property takes precedence over the <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-system-properties">system property setting</a> for <code>com.mulesoft.dw.multipart.defaultContentType</code>. <em>Introduced in DataWeave 2.3 (2.3.0-20210720) for the August 2021 release of Mule 4.3.0-20210719.</em></p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>boundary</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The multipart <code>boundary</code> value, a string to delimit parts.</p></div></div></td></tr><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>multipart/*</code></p></td></tr></tbody></table>

<!-- document id=13d40bed806f6a7116870264315c990765cc40fc7179a1c709283e879bbb9f05 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-formats-multipart.md -->

---
product: DataWeave
version: 2.6
keywords: format, multipart, multipart/*, multipart/form-data
---

# Multipart (Form Data) Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `multipart/form-data`

ID: `multipart`

DataWeave supports Multipart subtypes, in particular `form-data`. These formats enable you to handle
several different data parts in a single payload, regardless of the format each part has. To
distinguish the beginning and end of a part, a boundary is used and metadata for each part can be
added through headers.

DataWeave represents a Multipart document with the given `Object` structure:

```weave
type Multipart = {
  preamble?: String,
  parts: {
    _?: MultipartPart
  }
}
type MultipartPart = {
  headers?: {
    "Content-Disposition"?: {
      name: String,
      filename?: String
    },
    "Content-Type"?: String
  },
  content: Any
}
```

## Examples

The following examples show uses of the Multipart format.

- [Example: Multipart](#example1)

- [Example: Access and Transform Data from Parts](#example2)

- [Example: Generate Multipart Content](#example3)

- [Example: Iterate through Multipart payload](#example4)

- [Example: Using ^mediaType and ^mimeType Metadata Selectors](#example5)

### Example: Multipart

This example shows how DataWeave reads simple Multipart content.

#### Input

The Multipart input serves as the payload to the DataWeave source.

```text
--34b21
Content-Disposition: form-data; name="text"
Content-Type: text/plain
Book
--34b21
Content-Disposition: form-data; name="file1"; filename="a.json"
Content-Type: application/json
{
"title": "Java 8 in Action",
"author": "Mario Fusco",
"year": 2014
}
--34b21
Content-Disposition: form-data; name="file2"; filename="a.html"
Content-Type: text/html

<title> Available for download! </title>
--34b21--
```

#### Source

The DataWeave script transforms the Multipart input payload to the DataWeave (dw) format.

```weave
%dw 2.0
output application/dw
---
payload
```

#### Output

The output shows how the DataWeave (dw) format represents the Multipart input. Note that the `raw`
and `content` values are shortened for brevity. The full values are longer.

```weave
{
    parts: {
        text: {
            headers: {
                "Content-Disposition": {
                    name: "text",
                    subtype: "form-data"
                },
                "Content-Type": "text/plain"
            },
        content: "Book" as String {
            raw: "Qm9vaw==" as Binary {
                    base: "64"
                },
                encoding: null,
                mediaType: "text/plain",
                mimeType: "text/plain"
            }
        },
        file1: {
            headers: {
                "Content-Disposition": {
                    name: "file1",
                    filename: "a.json",
                    subtype: "form-data"
                },
                "Content-Type": "application/json"
            },
            content: {
                title: "Java 8 in Action",
                author: "Mario Fusco",
                year: 2014
            } as Object {
                raw: "ewogICJ0aXRsZSI6ICJKYXZhI...==" as Binary {
                    base: "64"
                },
                encoding: null,
                mediaType: "application/json",
                mimeType: "application/json"
            }
        },
        file2: {
            headers: {
                "Content-Disposition": {
                    name: "file2",
                    filename: "a.html",
                    subtype: "form-data"
                },
                "Content-Type": "text/html"
            },
            content: "PCFET0NUWVBFIGh0bWw+Cjx0aXRsZT4KI...==" as Binary {
                base: "64"
            }
       }
    }
}
----
```

### Example: Access and Transform Data from Parts

Within a DataWeave script, you can access and transform data from any of the parts by selecting the
`parts` element. Navigation can be array-based or key-based when parts feature a name to reference
them by. The part’s data can be accessed through the `content` keyword, while headers can be
accessed through the `headers` keyword.

#### Input

This example serves as input to separate DataWeave scripts. It shows a raw `multipart/form-data`
payload with a `34b21` boundary consisting of 3 parts:

- a `text/plain` one named `text`

- an `application/json` file (`a.json`) named `file1`

- a `text/html` file (`a.html`) named `file2`

Raw Multipart Data:

```text
--34b21
Content-Disposition: form-data; name="text"
Content-Type: text/plain

Book
--34b21
Content-Disposition: form-data; name="file1"; filename="a.json"
Content-Type: application/json

{
  "title": "Java 8 in Action",
  "author": "Mario Fusco",
  "year": 2014
}
--34b21
Content-Disposition: form-data; name="file2"; filename="a.html"
Content-Type: text/html

<!DOCTYPE html>
<title>
  Available for download!
</title>
--34b21--
```

#### Source

The following DataWeave script uses the raw `multipart/form-data` payload as input to produce
`Book:a.json`.

Reading Multipart Content:

```dataweave
%dw 2.0
output text/plain
---
payload.parts.text.content ++ ':' ++ payload.parts[1].headers.'Content-Disposition'.filename
```

### Example: Generate Multipart Content

You can generate multipart content that DataWeave uses to build an object with a list of parts, each
containing its headers and content. The following DataWeave script produces the raw multipart data
(previously analyzed) if the HTML data is available in the payload.

> [!NOTE] To provide a consistent output in the DataWeave documentation, the example hardcodes the
> `boundary` property. However, you do not need to hardcode this property in most cases because
> DataWeave generates a random boundary and adds it to the output MIME type.

Writing Multipart Content:

```dataweave
%dw 2.0
output multipart/form-data boundary='34b21'
---
{
  parts : {
    text : {
      headers : {
        "Content-Type": "text/plain"
      },
      content : "Book"
    },
    file1 : {
      headers : {
        "Content-Disposition" : {
            "name": "file1",
            "filename": "a.json"
        },
        "Content-Type" : "application/json"
      },
      content : {
        title: "Java 8 in Action",
        author: "Mario Fusco",
        year: 2014
      }
    },
    file2 : {
      headers : {
        "Content-Disposition" : {
            "filename": "a.html"
        },
        "Content-Type" : payload.^mimeType
      },
      content : payload
    }
  }
}
```

Notice that the key determines the part’s name if the name is not explicitly provided in the
`Content-Disposition` header, and note that DataWeave can handle content from supported formats, as
well as references to unsupported ones, such as HTML.

The following example shows how to send the current payload as a file part in a multipart form-data.
You need to use a DataWeave script similar to the following:

```dataweave
%dw 2.0
input payload application/xml
output multipart/form-data boundary="----myboundary----"
---
{
  parts: {
    filePart: {
      headers: {
        "Content-Disposition": {
          "name": "<NAME>",
          "filename": "<FILE_NAME>.<FILE_EXTENSION>"
        },
        "Content-Type": "<FILE_CONTENT-TYPE>"
      },
      content: payload
    },
    otherJsonPart: {
      content: '{"name": "sampleFile.xml", "sampleFile": {"type": "sample"} }'
    }
  }
}
```

- `boundary` sets the boundary value, for example `"----myboundary----"`.

- `<NAME>` is the tag name of your file, for example `"sampleFile"`.

- `<FILE_NAME>.<FILE_EXTENSION>` is the filename to populate the payload content, for example
  `"sampleFile.xml"`.

- `<FILE_CONTENT-TYPE>` matches the content of the file you send, for example `"application/xml"`.

- The content of the file is the current payload.

This example contains two parts in the multipart which are the file and the `otherJsonPart`. In case
you want to add more parts, add them under the `parts:{}` section with the following format:

```dataweave
  <PART_NAME>: {
    content: <PART_CONTENT>
  }
```

- `<PART_NAME>` is the name of the part without quotes, for example `json`.

- `<PART_CONTENT>` is the content for that part, for example
  `'{"name": "sampleFile.xml", "sampleFile": {"type": "sample"} }'`.

Based on the following XML input:

```xml
<Customers>
	<Customer>
		<Number>1</Number>
		<FirstName>Fred</FirstName>
		<LastName>Landis</LastName>
		<Address>
			<Street>Oakstreet</Street>
			<City>Boston</City>
			<ZIP>23320</ZIP>
			<State>MA</State>
		</Address>
	</Customer>
	<Customer>
		<Number>2</Number>
		<FirstName>Michelle</FirstName>
		<LastName>Butler</LastName>
		<Address>
			<Street>First Avenue</Street>
			<City>San-Francisco</City>
			<ZIP>44324</ZIP>
			<State>CA</State>
		</Address>
	</Customer>
	<Customer>
		<Number>3</Number>
		<FirstName>Ted</FirstName>
		<LastName>Little</LastName>
		<Address>
			<Street>Long Way</Street>
			<City>Los-Angeles</City>
			<ZIP>34424</ZIP>
			<State>CA</State>
		</Address>
	</Customer>
</Customers>
```

The DataWeave script is:

```dataweave
%dw 2.0
output multipart/form-data  boundary="----myboundary----"
---
{
  parts: {
    filePart: {
      headers: {
        "Content-Disposition": {
          "name": "test",
          "filename": "sampleFile.xml"
        },
        "Content-Type": "application/xml"
      },
      content: payload
    },
    otherJsonPart: {
      content: '{"name": "sampleFile.xml", "sampleFile": {"type": "sample"} }'
    }
  }
}
```

The output multipart is:

```multipart
------myboundary----
Content-Type: application/xml
Content-Disposition: form-data; name="test"; filename="sampleFile.xml"

<Customers>
  <Customer>
    <Number>1</Number>
    <FirstName>Fred</FirstName>
    <LastName>Landis</LastName>
    <Address>
      <Street>Oakstreet</Street>
      <City>Boston</City>
      <ZIP>23320</ZIP>
      <State>MA</State>
    </Address>
  </Customer>
  <Customer>
    <Number>2</Number>
    <FirstName>Michelle</FirstName>
    <LastName>Butler</LastName>
    <Address>
      <Street>First Avenue</Street>
      <City>San-Francisco</City>
      <ZIP>44324</ZIP>
      <State>CA</State>
    </Address>
  </Customer>
  <Customer>
    <Number>3</Number>
    <FirstName>Ted</FirstName>
    <LastName>Little</LastName>
    <Address>
      <Street>Long Way</Street>
      <City>Los-Angeles</City>
      <ZIP>34424</ZIP>
      <State>CA</State>
    </Address>
  </Customer>
</Customers>
------myboundary----
Content-Disposition: form-data; name="otherJsonPart"

{"name": "sampleFile.xml", "sampleFile": {"type": "sample"} }
------myboundary------
```

### Example: Iterate through Multipart payload

This example shows how DataWeave iterates through all the parts of the payload and processes the
each part individually.

### Source

```dataweave
%dw 2.0
output application/json
var multi = '--34b21
Content-Disposition: form-data; name="text"
Content-Type: text/plain

Book
--34b21
Content-Disposition: form-data; name="file1"; filename="a.json"
Content-Type: application/json

{
"title":"Java 8 in Action",
"author":"Mario Fusco",
"year":2014
}
--34b21
Content-Disposition: form-data; name="file2"; filename="a.html"
Content-Type: text/html

<!DOCTYPE html>
<title>
Available for download!
</title>
--34b21--'
var parsed = read(multi, "multipart/form-data", {boundary:'34b21'})
---
parsed.parts mapObject ((value, key, index) -> {(index): key})
```

### Output

```json
{
  "0": "text",
  "1": "file1",
  "2": "file2"
}
```

### Example: Using ^mediaType and ^mimeType Metadata Selectors

The `^mimeType` selector returns the MIME type of a value without parameters, for example,
`application/json`. The `^mediaType` selector, by contrast, provides the MIME type and any other
parameters related to it, for example, `application/json;charset=UTF-16`.

The following example shows how to transform multipart inputs into multipart outputs with a
different format. The DataWeave script uses both the `^mimeType` and `^mediaType` selectors to
generate the new multipart content.

### Input

The multipart input has more than one Content-Type. In this case `application/json` and
`application/csv` including a non-standard separator:

```text
----------------------------049709565842371278701691
Content-Type: application/json
Content-Disposition: form-data; name="order"

{
"name": "order1",
"id": 123,
"content": "orderContent"
}
----------------------------049709565842371278701691
Content-Type: application/csv;separator=.
Content-Disposition: form-data; name="partner"

partnerName.id
mulesoft.1
----------------------------049709565842371278701691--
```

### Source

The DataWeave script transforms the multipart input into multipart output by defining
`output multipart/form-data` MIME type. The multipart output data contains two parts:

- `orderAck`

Contains a text with an acknowledgement of the receipt of an order. The Content-Type is
`text/plain`. The ^mimeType\` selector becomes useful to log the Content-Type as part of the
message.

- `partner`

Contains the original partner itself. Notice that this time, the Content-Type is
`payload.parts..^mediaType`. The ^mediaType selector includes also the separator, that parses the
`application/csv` content.

```dataweave
%dw 2.0
input payload multipart boundary='boundary1'
output multipart boundary='test2'
---
{
  parts : {
    orderAck : {
      headers : {
        "Content-Type": "text/plain"
      },
      content : "Order payload of type " ++ payload.parts.order.content.^mimeType ++ " and id " ++ (payload.parts.order.content.id as String) ++ " received. Receipt available."
    },
    partner: {
      headers : {
        "Content-Type": payload.parts.partner.content.^mediaType
      },
      content : payload.parts.partner.content
    }
  }
}
```

### Output

```text
--test2
Content-Type: text/plain
Content-Disposition: form-data; name="orderAck"

Order payload of type application/json and id 123 received. Receipt available.
--test2
Content-Type: application/csv;separator=.
Content-Disposition: form-data; name="partner"

partnerName.id
mulesoft.1
--test2--
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>boundary</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The multipart <code>boundary</code> value, a string to delimit parts.</p></div></div></td></tr><tr><td><p><code>defaultContentType</code></p></td><td><p><code>String</code></p></td><td><p><code>'application/octet-stream'</code></p></td><td><div><div><p>Sets the default Content-Type to use on parts of the <code>multipart/*</code> format. When set, this property takes precedence over the setting for the <a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-system-properties">system property</a> <code>com.mulesoft.dw.multipart.defaultContentType</code>.</p></div><div><p><em>Introduced in DataWeave 2.3 (2.3.0-20210720) for the August 2021 release of Mule 4.3.0-20210719.</em></p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>boundary</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The multipart <code>boundary</code> value, a string to delimit parts.</p></div></div></td></tr><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>multipart/*</code></p></td></tr></tbody></table>

<!-- document id=762c77a018a6b43e6bcf9cbe795accd166e0f1d1a0789fd88c29be4f191740c4 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-formats-multipart.md -->

---
product: DataWeave
version: 2.9
keywords: format, multipart, multipart/*, multipart/form-data
---

# Multipart (Form Data) Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `multipart/form-data`

ID: `multipart`

DataWeave supports Multipart subtypes, in particular `form-data`. These formats enable you to handle
several different data parts in a single payload, regardless of the format each part has. To
distinguish the beginning and end of a part, a boundary is used and metadata for each part can be
added through headers.

DataWeave represents a Multipart document with the given `Object` structure:

```weave
type Multipart = {
  preamble?: String,
  parts: {
    _?: MultipartPart
  }
}
type MultipartPart = {
  headers?: {
    "Content-Disposition"?: {
      name: String,
      filename?: String
    },
    "Content-Type"?: String
  },
  content: Any
}
```

## Examples

The following examples show uses of the Multipart format.

- [Example: Multipart](#example1)

- [Example: Access and Transform Data from Parts](#example2)

- [Example: Generate Multipart Content](#example3)

- [Example: Iterate through Multipart payload](#example4)

- [Example: Using ^mediaType and ^mimeType Metadata Selectors](#example5)

### Example: Multipart

This example shows how DataWeave reads simple Multipart content.

#### Input

The Multipart input serves as the payload to the DataWeave source.

```text
--34b21
Content-Disposition: form-data; name="text"
Content-Type: text/plain
Book
--34b21
Content-Disposition: form-data; name="file1"; filename="a.json"
Content-Type: application/json
{
"title": "Java 8 in Action",
"author": "Mario Fusco",
"year": 2014
}
--34b21
Content-Disposition: form-data; name="file2"; filename="a.html"
Content-Type: text/html

<title> Available for download! </title>
--34b21--
```

#### Source

The DataWeave script transforms the Multipart input payload to the DataWeave (dw) format.

```weave
%dw 2.0
output application/dw
---
payload
```

#### Output

The output shows how the DataWeave (dw) format represents the Multipart input. Note that the `raw`
and `content` values are shortened for brevity. The full values are longer.

```weave
{
    parts: {
        text: {
            headers: {
                "Content-Disposition": {
                    name: "text",
                    subtype: "form-data"
                },
                "Content-Type": "text/plain"
            },
        content: "Book" as String {
            raw: "Qm9vaw==" as Binary {
                    base: "64"
                },
                encoding: null,
                mediaType: "text/plain",
                mimeType: "text/plain"
            }
        },
        file1: {
            headers: {
                "Content-Disposition": {
                    name: "file1",
                    filename: "a.json",
                    subtype: "form-data"
                },
                "Content-Type": "application/json"
            },
            content: {
                title: "Java 8 in Action",
                author: "Mario Fusco",
                year: 2014
            } as Object {
                raw: "ewogICJ0aXRsZSI6ICJKYXZhI...==" as Binary {
                    base: "64"
                },
                encoding: null,
                mediaType: "application/json",
                mimeType: "application/json"
            }
        },
        file2: {
            headers: {
                "Content-Disposition": {
                    name: "file2",
                    filename: "a.html",
                    subtype: "form-data"
                },
                "Content-Type": "text/html"
            },
            content: "PCFET0NUWVBFIGh0bWw+Cjx0aXRsZT4KI...==" as Binary {
                base: "64"
            }
       }
    }
}
----
```

### Example: Access and Transform Data from Parts

Within a DataWeave script, you can access and transform data from any of the parts by selecting the
`parts` element. Navigation can be array-based or key-based when parts feature a name to reference
them by. The part’s data can be accessed through the `content` keyword, while headers can be
accessed through the `headers` keyword.

#### Input

This example serves as input to separate DataWeave scripts. It shows a raw `multipart/form-data`
payload with a `34b21` boundary consisting of 3 parts:

- a `text/plain` one named `text`

- an `application/json` file (`a.json`) named `file1`

- a `text/html` file (`a.html`) named `file2`

Raw Multipart Data:

```text
--34b21
Content-Disposition: form-data; name="text"
Content-Type: text/plain

Book
--34b21
Content-Disposition: form-data; name="file1"; filename="a.json"
Content-Type: application/json

{
  "title": "Java 8 in Action",
  "author": "Mario Fusco",
  "year": 2014
}
--34b21
Content-Disposition: form-data; name="file2"; filename="a.html"
Content-Type: text/html

<!DOCTYPE html>
<title>
  Available for download!
</title>
--34b21--
```

#### Source

The following DataWeave script uses the raw `multipart/form-data` payload as input to produce
`Book:a.json`.

Reading Multipart Content:

```dataweave
%dw 2.0
output text/plain
---
payload.parts.text.content ++ ':' ++ payload.parts[1].headers.'Content-Disposition'.filename
```

### Example: Generate Multipart Content

You can generate multipart content that DataWeave uses to build an object with a list of parts, each
containing its headers and content. The following DataWeave script produces the raw multipart data
(previously analyzed) if the HTML data is available in the payload.

> [!NOTE] To provide a consistent output in the DataWeave documentation, the example hardcodes the
> `boundary` property. However, you do not need to hardcode this property in most cases because
> DataWeave generates a random boundary and adds it to the output MIME type.

Writing Multipart Content:

```dataweave
%dw 2.0
output multipart/form-data boundary='34b21'
---
{
  parts : {
    text : {
      headers : {
        "Content-Type": "text/plain"
      },
      content : "Book"
    },
    file1 : {
      headers : {
        "Content-Disposition" : {
            "name": "file1",
            "filename": "a.json"
        },
        "Content-Type" : "application/json"
      },
      content : {
        title: "Java 8 in Action",
        author: "Mario Fusco",
        year: 2014
      }
    },
    file2 : {
      headers : {
        "Content-Disposition" : {
            "filename": "a.html"
        },
        "Content-Type" : payload.^mimeType
      },
      content : payload
    }
  }
}
```

Notice that the key determines the part’s name if the name is not explicitly provided in the
`Content-Disposition` header, and note that DataWeave can handle content from supported formats, as
well as references to unsupported ones, such as HTML.

The following example shows how to send the current payload as a file part in a multipart form-data.
You need to use a DataWeave script similar to the following:

```dataweave
%dw 2.0
input payload application/xml
output multipart/form-data boundary="----myboundary----"
---
{
  parts: {
    filePart: {
      headers: {
        "Content-Disposition": {
          "name": "<NAME>",
          "filename": "<FILE_NAME>.<FILE_EXTENSION>"
        },
        "Content-Type": "<FILE_CONTENT-TYPE>"
      },
      content: payload
    },
    otherJsonPart: {
      content: '{"name": "sampleFile.xml", "sampleFile": {"type": "sample"} }'
    }
  }
}
```

- `boundary` sets the boundary value, for example `"----myboundary----"`.

- `<NAME>` is the tag name of your file, for example `"sampleFile"`.

- `<FILE_NAME>.<FILE_EXTENSION>` is the filename to populate the payload content, for example
  `"sampleFile.xml"`.

- `<FILE_CONTENT-TYPE>` matches the content of the file you send, for example `"application/xml"`.

- The content of the file is the current payload.

This example contains two parts in the multipart which are the file and the `otherJsonPart`. In case
you want to add more parts, add them under the `parts:{}` section with the following format:

```dataweave
  <PART_NAME>: {
    content: <PART_CONTENT>
  }
```

- `<PART_NAME>` is the name of the part without quotes, for example `json`.

- `<PART_CONTENT>` is the content for that part, for example
  `'{"name": "sampleFile.xml", "sampleFile": {"type": "sample"} }'`.

Based on the following XML input:

```xml
<Customers>
	<Customer>
		<Number>1</Number>
		<FirstName>Fred</FirstName>
		<LastName>Landis</LastName>
		<Address>
			<Street>Oakstreet</Street>
			<City>Boston</City>
			<ZIP>23320</ZIP>
			<State>MA</State>
		</Address>
	</Customer>
	<Customer>
		<Number>2</Number>
		<FirstName>Michelle</FirstName>
		<LastName>Butler</LastName>
		<Address>
			<Street>First Avenue</Street>
			<City>San-Francisco</City>
			<ZIP>44324</ZIP>
			<State>CA</State>
		</Address>
	</Customer>
	<Customer>
		<Number>3</Number>
		<FirstName>Ted</FirstName>
		<LastName>Little</LastName>
		<Address>
			<Street>Long Way</Street>
			<City>Los-Angeles</City>
			<ZIP>34424</ZIP>
			<State>CA</State>
		</Address>
	</Customer>
</Customers>
```

The DataWeave script is:

```dataweave
%dw 2.0
output multipart/form-data  boundary="----myboundary----"
---
{
  parts: {
    filePart: {
      headers: {
        "Content-Disposition": {
          "name": "test",
          "filename": "sampleFile.xml"
        },
        "Content-Type": "application/xml"
      },
      content: payload
    },
    otherJsonPart: {
      content: '{"name": "sampleFile.xml", "sampleFile": {"type": "sample"} }'
    }
  }
}
```

The output multipart is:

```multipart
------myboundary----
Content-Type: application/xml
Content-Disposition: form-data; name="test"; filename="sampleFile.xml"

<Customers>
  <Customer>
    <Number>1</Number>
    <FirstName>Fred</FirstName>
    <LastName>Landis</LastName>
    <Address>
      <Street>Oakstreet</Street>
      <City>Boston</City>
      <ZIP>23320</ZIP>
      <State>MA</State>
    </Address>
  </Customer>
  <Customer>
    <Number>2</Number>
    <FirstName>Michelle</FirstName>
    <LastName>Butler</LastName>
    <Address>
      <Street>First Avenue</Street>
      <City>San-Francisco</City>
      <ZIP>44324</ZIP>
      <State>CA</State>
    </Address>
  </Customer>
  <Customer>
    <Number>3</Number>
    <FirstName>Ted</FirstName>
    <LastName>Little</LastName>
    <Address>
      <Street>Long Way</Street>
      <City>Los-Angeles</City>
      <ZIP>34424</ZIP>
      <State>CA</State>
    </Address>
  </Customer>
</Customers>
------myboundary----
Content-Disposition: form-data; name="otherJsonPart"

{"name": "sampleFile.xml", "sampleFile": {"type": "sample"} }
------myboundary------
```

### Example: Iterate through Multipart payload

This example shows how DataWeave iterates through all the parts of the payload and processes the
each part individually.

### Source

```dataweave
%dw 2.0
output application/json
var multi = '--34b21
Content-Disposition: form-data; name="text"
Content-Type: text/plain

Book
--34b21
Content-Disposition: form-data; name="file1"; filename="a.json"
Content-Type: application/json

{
"title":"Java 8 in Action",
"author":"Mario Fusco",
"year":2014
}
--34b21
Content-Disposition: form-data; name="file2"; filename="a.html"
Content-Type: text/html

<!DOCTYPE html>
<title>
Available for download!
</title>
--34b21--'
var parsed = read(multi, "multipart/form-data", {boundary:'34b21'})
---
parsed.parts mapObject ((value, key, index) -> {(index): key})
```

### Output

```json
{
  "0": "text",
  "1": "file1",
  "2": "file2"
}
```

### Example: Using ^mediaType and ^mimeType Metadata Selectors

The `^mimeType` selector returns the MIME type of a value without parameters, for example,
`application/json`. The `^mediaType` selector, by contrast, provides the MIME type and any other
parameters related to it, for example, `application/json;charset=UTF-16`.

The following example shows how to transform multipart inputs into multipart outputs with a
different format. The DataWeave script uses both the `^mimeType` and `^mediaType` selectors to
generate the new multipart content.

### Input

The multipart input has more than one Content-Type. In this case `application/json` and
`application/csv` including a non-standard separator:

```text
----------------------------049709565842371278701691
Content-Type: application/json
Content-Disposition: form-data; name="order"

{
"name": "order1",
"id": 123,
"content": "orderContent"
}
----------------------------049709565842371278701691
Content-Type: application/csv;separator=.
Content-Disposition: form-data; name="partner"

partnerName.id
mulesoft.1
----------------------------049709565842371278701691--
```

### Source

The DataWeave script transforms the multipart input into multipart output by defining
`output multipart/form-data` MIME type. The multipart output data contains two parts:

- `orderAck`

Contains a text with an acknowledgement of the receipt of an order. The Content-Type is
`text/plain`. The ^mimeType\` selector becomes useful to log the Content-Type as part of the
message.

- `partner`

Contains the original partner itself. Notice that this time, the Content-Type is
`payload.parts..^mediaType`. The ^mediaType selector includes also the separator, that parses the
`application/csv` content.

```dataweave
%dw 2.0
input payload multipart boundary='boundary1'
output multipart boundary='test2'
---
{
  parts : {
    orderAck : {
      headers : {
        "Content-Type": "text/plain"
      },
      content : "Order payload of type " ++ payload.parts.order.content.^mimeType ++ " and id " ++ (payload.parts.order.content.id as String) ++ " received. Receipt available."
    },
    partner: {
      headers : {
        "Content-Type": payload.parts.partner.content.^mediaType
      },
      content : payload.parts.partner.content
    }
  }
}
```

### Output

```text
--test2
Content-Type: text/plain
Content-Disposition: form-data; name="orderAck"

Order payload of type application/json and id 123 received. Receipt available.
--test2
Content-Type: application/csv;separator=.
Content-Disposition: form-data; name="partner"

partnerName.id
mulesoft.1
--test2--
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>boundary</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The multipart <code>boundary</code> value, a string to delimit parts.</p></div></div></td></tr><tr><td><p><code>defaultContentType</code></p></td><td><p><code>String</code></p></td><td><p><code>'application/octet-stream'</code></p></td><td><div><div><p>Sets the default Content-Type to use on parts of the <code>multipart/*</code> format. When set, this property takes precedence over the setting for the <a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-system-properties">system property</a> <code>com.mulesoft.dw.multipart.defaultContentType</code>.</p></div><div><p><em>Introduced in DataWeave 2.3 (2.3.0-20210720) for the August 2021 release of Mule 4.3.0-20210719.</em></p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>boundary</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The multipart <code>boundary</code> value, a string to delimit parts.</p></div></div></td></tr><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>multipart/*</code></p></td></tr></tbody></table>

<!-- document id=c1b0ec3236f17d076a4b57a16960472807467da611a473129ba674458865aa27 url=/mulesoft/current/en-us/dataweave/latest/dataweave-formats-multipart.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: format, multipart, multipart/*, multipart/form-data
---

# Multipart (Form Data) Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `multipart/form-data`

ID: `multipart`

DataWeave supports Multipart subtypes, in particular `form-data`. These formats enable you to handle
several different data parts in a single payload, regardless of the format each part has. To
distinguish the beginning and end of a part, a boundary is used and metadata for each part can be
added through headers.

DataWeave represents a Multipart document with the given `Object` structure:

```weave
type Multipart = {
  preamble?: String,
  parts: {
    _?: MultipartPart
  }
}
type MultipartPart = {
  headers?: {
    "Content-Disposition"?: {
      name: String,
      filename?: String
    },
    "Content-Type"?: String
  },
  content: Any
}
```

## Examples

The following examples show uses of the Multipart format.

- [Example: Multipart](#example1)

- [Example: Access and Transform Data from Parts](#example2)

- [Example: Generate Multipart Content](#example3)

- [Example: Iterate through Multipart payload](#example4)

- [Example: Using ^mediaType and ^mimeType Metadata Selectors](#example5)

### Example: Multipart

This example shows how DataWeave reads simple Multipart content.

#### Input

The Multipart input serves as the payload to the DataWeave source.

```text
--34b21
Content-Disposition: form-data; name="text"
Content-Type: text/plain
Book
--34b21
Content-Disposition: form-data; name="file1"; filename="a.json"
Content-Type: application/json
{
"title": "Java 8 in Action",
"author": "Mario Fusco",
"year": 2014
}
--34b21
Content-Disposition: form-data; name="file2"; filename="a.html"
Content-Type: text/html

<title> Available for download! </title>
--34b21--
```

#### Source

The DataWeave script transforms the Multipart input payload to the DataWeave (dw) format.

```weave
%dw 2.0
output application/dw
---
payload
```

#### Output

The output shows how the DataWeave (dw) format represents the Multipart input. Note that the `raw`
and `content` values are shortened for brevity. The full values are longer.

```weave
{
    parts: {
        text: {
            headers: {
                "Content-Disposition": {
                    name: "text",
                    subtype: "form-data"
                },
                "Content-Type": "text/plain"
            },
        content: "Book" as String {
            raw: "Qm9vaw==" as Binary {
                    base: "64"
                },
                encoding: null,
                mediaType: "text/plain",
                mimeType: "text/plain"
            }
        },
        file1: {
            headers: {
                "Content-Disposition": {
                    name: "file1",
                    filename: "a.json",
                    subtype: "form-data"
                },
                "Content-Type": "application/json"
            },
            content: {
                title: "Java 8 in Action",
                author: "Mario Fusco",
                year: 2014
            } as Object {
                raw: "ewogICJ0aXRsZSI6ICJKYXZhI...==" as Binary {
                    base: "64"
                },
                encoding: null,
                mediaType: "application/json",
                mimeType: "application/json"
            }
        },
        file2: {
            headers: {
                "Content-Disposition": {
                    name: "file2",
                    filename: "a.html",
                    subtype: "form-data"
                },
                "Content-Type": "text/html"
            },
            content: "PCFET0NUWVBFIGh0bWw+Cjx0aXRsZT4KI...==" as Binary {
                base: "64"
            }
       }
    }
}
----
```

### Example: Access and Transform Data from Parts

Within a DataWeave script, you can access and transform data from any of the parts by selecting the
`parts` element. Navigation can be array-based or key-based when parts feature a name to reference
them by. The part’s data can be accessed through the `content` keyword, while headers can be
accessed through the `headers` keyword.

#### Input

This example serves as input to separate DataWeave scripts. It shows a raw `multipart/form-data`
payload with a `34b21` boundary consisting of 3 parts:

- a `text/plain` one named `text`

- an `application/json` file (`a.json`) named `file1`

- a `text/html` file (`a.html`) named `file2`

Raw Multipart Data:

```text
--34b21
Content-Disposition: form-data; name="text"
Content-Type: text/plain

Book
--34b21
Content-Disposition: form-data; name="file1"; filename="a.json"
Content-Type: application/json

{
  "title": "Java 8 in Action",
  "author": "Mario Fusco",
  "year": 2014
}
--34b21
Content-Disposition: form-data; name="file2"; filename="a.html"
Content-Type: text/html

<!DOCTYPE html>
<title>
  Available for download!
</title>
--34b21--
```

#### Source

The following DataWeave script uses the raw `multipart/form-data` payload as input to produce
`Book:a.json`.

Reading Multipart Content:

```dataweave
%dw 2.0
output text/plain
---
payload.parts.text.content ++ ':' ++ payload.parts[1].headers.'Content-Disposition'.filename
```

### Example: Generate Multipart Content

You can generate multipart content that DataWeave uses to build an object with a list of parts, each
containing its headers and content. The following DataWeave script produces the raw multipart data
(previously analyzed) if the HTML data is available in the payload.

> [!NOTE] To provide a consistent output in the DataWeave documentation, the example hardcodes the
> `boundary` property. However, you do not need to hardcode this property in most cases because
> DataWeave generates a random boundary and adds it to the output MIME type.

Writing Multipart Content:

```dataweave
%dw 2.0
output multipart/form-data boundary='34b21'
---
{
  parts : {
    text : {
      headers : {
        "Content-Type": "text/plain"
      },
      content : "Book"
    },
    file1 : {
      headers : {
        "Content-Disposition" : {
            "name": "file1",
            "filename": "a.json"
        },
        "Content-Type" : "application/json"
      },
      content : {
        title: "Java 8 in Action",
        author: "Mario Fusco",
        year: 2014
      }
    },
    file2 : {
      headers : {
        "Content-Disposition" : {
            "filename": "a.html"
        },
        "Content-Type" : payload.^mimeType
      },
      content : payload
    }
  }
}
```

Notice that the key determines the part’s name if the name is not explicitly provided in the
`Content-Disposition` header, and note that DataWeave can handle content from supported formats, as
well as references to unsupported ones, such as HTML.

The following example shows how to send the current payload as a file part in a multipart form-data.
You need to use a DataWeave script similar to the following:

```dataweave
%dw 2.0
input payload application/xml
output multipart/form-data boundary="----myboundary----"
---
{
  parts: {
    filePart: {
      headers: {
        "Content-Disposition": {
          "name": "<NAME>",
          "filename": "<FILE_NAME>.<FILE_EXTENSION>"
        },
        "Content-Type": "<FILE_CONTENT-TYPE>"
      },
      content: payload
    },
    otherJsonPart: {
      content: '{"name": "sampleFile.xml", "sampleFile": {"type": "sample"} }'
    }
  }
}
```

- `boundary` sets the boundary value, for example `"----myboundary----"`.

- `<NAME>` is the tag name of your file, for example `"sampleFile"`.

- `<FILE_NAME>.<FILE_EXTENSION>` is the filename to populate the payload content, for example
  `"sampleFile.xml"`.

- `<FILE_CONTENT-TYPE>` matches the content of the file you send, for example `"application/xml"`.

- The content of the file is the current payload.

This example contains two parts in the multipart which are the file and the `otherJsonPart`. In case
you want to add more parts, add them under the `parts:{}` section with the following format:

```dataweave
  <PART_NAME>: {
    content: <PART_CONTENT>
  }
```

- `<PART_NAME>` is the name of the part without quotes, for example `json`.

- `<PART_CONTENT>` is the content for that part, for example
  `'{"name": "sampleFile.xml", "sampleFile": {"type": "sample"} }'`.

Based on the following XML input:

```xml
<Customers>
	<Customer>
		<Number>1</Number>
		<FirstName>Fred</FirstName>
		<LastName>Landis</LastName>
		<Address>
			<Street>Oakstreet</Street>
			<City>Boston</City>
			<ZIP>23320</ZIP>
			<State>MA</State>
		</Address>
	</Customer>
	<Customer>
		<Number>2</Number>
		<FirstName>Michelle</FirstName>
		<LastName>Butler</LastName>
		<Address>
			<Street>First Avenue</Street>
			<City>San-Francisco</City>
			<ZIP>44324</ZIP>
			<State>CA</State>
		</Address>
	</Customer>
	<Customer>
		<Number>3</Number>
		<FirstName>Ted</FirstName>
		<LastName>Little</LastName>
		<Address>
			<Street>Long Way</Street>
			<City>Los-Angeles</City>
			<ZIP>34424</ZIP>
			<State>CA</State>
		</Address>
	</Customer>
</Customers>
```

The DataWeave script is:

```dataweave
%dw 2.0
output multipart/form-data  boundary="----myboundary----"
---
{
  parts: {
    filePart: {
      headers: {
        "Content-Disposition": {
          "name": "test",
          "filename": "sampleFile.xml"
        },
        "Content-Type": "application/xml"
      },
      content: payload
    },
    otherJsonPart: {
      content: '{"name": "sampleFile.xml", "sampleFile": {"type": "sample"} }'
    }
  }
}
```

The output multipart is:

```multipart
------myboundary----
Content-Type: application/xml
Content-Disposition: form-data; name="test"; filename="sampleFile.xml"

<Customers>
  <Customer>
    <Number>1</Number>
    <FirstName>Fred</FirstName>
    <LastName>Landis</LastName>
    <Address>
      <Street>Oakstreet</Street>
      <City>Boston</City>
      <ZIP>23320</ZIP>
      <State>MA</State>
    </Address>
  </Customer>
  <Customer>
    <Number>2</Number>
    <FirstName>Michelle</FirstName>
    <LastName>Butler</LastName>
    <Address>
      <Street>First Avenue</Street>
      <City>San-Francisco</City>
      <ZIP>44324</ZIP>
      <State>CA</State>
    </Address>
  </Customer>
  <Customer>
    <Number>3</Number>
    <FirstName>Ted</FirstName>
    <LastName>Little</LastName>
    <Address>
      <Street>Long Way</Street>
      <City>Los-Angeles</City>
      <ZIP>34424</ZIP>
      <State>CA</State>
    </Address>
  </Customer>
</Customers>
------myboundary----
Content-Disposition: form-data; name="otherJsonPart"

{"name": "sampleFile.xml", "sampleFile": {"type": "sample"} }
------myboundary------
```

### Example: Iterate through Multipart payload

This example shows how DataWeave iterates through all the parts of the payload and processes the
each part individually.

### Source

```dataweave
%dw 2.0
output application/json
var multi = '--34b21
Content-Disposition: form-data; name="text"
Content-Type: text/plain

Book
--34b21
Content-Disposition: form-data; name="file1"; filename="a.json"
Content-Type: application/json

{
"title":"Java 8 in Action",
"author":"Mario Fusco",
"year":2014
}
--34b21
Content-Disposition: form-data; name="file2"; filename="a.html"
Content-Type: text/html

<!DOCTYPE html>
<title>
Available for download!
</title>
--34b21--'
var parsed = read(multi, "multipart/form-data", {boundary:'34b21'})
---
parsed.parts mapObject ((value, key, index) -> {(index): key})
```

### Output

```json
{
  "0": "text",
  "1": "file1",
  "2": "file2"
}
```

### Example: Using ^mediaType and ^mimeType Metadata Selectors

The `^mimeType` selector returns the MIME type of a value without parameters, for example,
`application/json`. The `^mediaType` selector, by contrast, provides the MIME type and any other
parameters related to it, for example, `application/json;charset=UTF-16`.

The following example shows how to transform multipart inputs into multipart outputs with a
different format. The DataWeave script uses both the `^mimeType` and `^mediaType` selectors to
generate the new multipart content.

### Input

The multipart input has more than one Content-Type. In this case `application/json` and
`application/csv` including a non-standard separator:

```text
----------------------------049709565842371278701691
Content-Type: application/json
Content-Disposition: form-data; name="order"

{
"name": "order1",
"id": 123,
"content": "orderContent"
}
----------------------------049709565842371278701691
Content-Type: application/csv;separator=.
Content-Disposition: form-data; name="partner"

partnerName.id
mulesoft.1
----------------------------049709565842371278701691--
```

### Source

The DataWeave script transforms the multipart input into multipart output by defining
`output multipart/form-data` MIME type. The multipart output data contains two parts:

- `orderAck`

Contains a text with an acknowledgement of the receipt of an order. The Content-Type is
`text/plain`. The ^mimeType\` selector becomes useful to log the Content-Type as part of the
message.

- `partner`

Contains the original partner itself. Notice that this time, the Content-Type is
`payload.parts..^mediaType`. The ^mediaType selector includes also the separator, that parses the
`application/csv` content.

```dataweave
%dw 2.0
input payload multipart boundary='boundary1'
output multipart boundary='test2'
---
{
  parts : {
    orderAck : {
      headers : {
        "Content-Type": "text/plain"
      },
      content : "Order payload of type " ++ payload.parts.order.content.^mimeType ++ " and id " ++ (payload.parts.order.content.id as String) ++ " received. Receipt available."
    },
    partner: {
      headers : {
        "Content-Type": payload.parts.partner.content.^mediaType
      },
      content : payload.parts.partner.content
    }
  }
}
```

### Output

```text
--test2
Content-Type: text/plain
Content-Disposition: form-data; name="orderAck"

Order payload of type application/json and id 123 received. Receipt available.
--test2
Content-Type: application/csv;separator=.
Content-Disposition: form-data; name="partner"

partnerName.id
mulesoft.1
--test2--
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>boundary</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The multipart <code>boundary</code> value, a string to delimit parts.</p></div></div></td></tr><tr><td><p><code>defaultContentType</code></p></td><td><p><code>String</code></p></td><td><p><code>'application/octet-stream'</code></p></td><td><div><div><p>Sets the default Content-Type to use on parts of the <code>multipart/*</code> format. When set, this property takes precedence over the setting for the <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-system-properties">system property</a> <code>com.mulesoft.dw.multipart.defaultContentType</code>.</p></div><div><p><em>Introduced in DataWeave 2.3 (2.3.0-20210720) for the August 2021 release of Mule 4.3.0-20210719.</em></p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>boundary</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The multipart <code>boundary</code> value, a string to delimit parts.</p></div></div></td></tr><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>multipart/*</code></p></td></tr></tbody></table>

<!-- document id=08321cc552ec2695239d6138225493fbf83ecac1bc82ffdd70dc5fa1f675c68d url=/mulesoft/current/en-us/dataweave/2.3/dataweave-formats-multipart.md -->

---
product: DataWeave
version: 2.3
---

# Multipart Format (Form Data)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME Type: `multipart/form-data`

ID: `multipart`

DataWeave supports Multipart subtypes, in particular `form-data`. These formats enable you to handle
several different data parts in a single payload, regardless of the format each part has. To
distinguish the beginning and end of a part, a boundary is used and metadata for each part can be
added through headers.

DataWeeave represents a Multipart document with the given `Object` structure:

```weave
type Multipart = {
  preamble?: String,
  parts: {
    _?: MultipartPart
  }
}
type MultipartPart = {
  headers?: {
    "Content-Disposition"?: {
      name: String,
      filename?: String
    },
    "Content-Type"?: String
  },
  content: Any
}
```

## Examples

The following examples show uses of the Multipart format.

- [Example: Multipart](#example1)

- [Example: Access and Transform Data from Parts](#example2)

- [Example: Generate Multipart Content](#example3)

### Example: Multipart

This example shows how DataWeave reads simple Multipart content.

#### Input

The Multipart input serves as the payload to the DataWeave source.

```text
--34b21
Content-Disposition: form-data; name="text"
Content-Type: text/plain

Book
--34b21
Content-Disposition: form-data; name="file1"; filename="a.json"
Content-Type: application/json

{
"title": "Java 8 in Action",
"author": "Mario Fusco",
"year": 2014
}
--34b21
Content-Disposition: form-data; name="file2"; filename="a.html"
Content-Type: text/html

<title> Available for download! </title>
--34b21--
```

#### Source

The DataWeave script transforms the Multipart input payload to the DataWeave (dw) format.

```weave
%dw 2.0
output application/dw
---
payload
```

#### Output

The output shows how the DataWeave (dw) format represents the Multipart input. Note that the `raw`
and `content` values are shortened for brevity. The full values are longer.

```weave
{
    parts: {
        text: {
            headers: {
                "Content-Disposition": {
                    name: "text",
                    subtype: "form-data"
                },
                "Content-Type": "text/plain"
            },
        content: "Book" as String {
            raw: "Qm9vaw==" as Binary {
                    base: "64"
                },
                encoding: null,
                mediaType: "text/plain",
                mimeType: "text/plain"
            }
        },
        file1: {
            headers: {
                "Content-Disposition": {
                    name: "file1",
                    filename: "a.json",
                    subtype: "form-data"
                },
                "Content-Type": "application/json"
            },
            content: {
                title: "Java 8 in Action",
                author: "Mario Fusco",
                year: 2014
            } as Object {
                raw: "ewogICJ0aXRsZSI6ICJKYXZhI...==" as Binary {
                    base: "64"
                },
                encoding: null,
                mediaType: "application/json",
                mimeType: "application/json"
            }
        },
        file2: {
            headers: {
                "Content-Disposition": {
                    name: "file2",
                    filename: "a.html",
                    subtype: "form-data"
                },
                "Content-Type": "text/html"
            },
            content: "PCFET0NUWVBFIGh0bWw+Cjx0aXRsZT4KI...==" as Binary {
                base: "64"
            }
       }
    }
}
```

### Example: Access and Transform Data from Parts

Within a DataWeave script, you can access and transform data from any of the parts by selecting the
`parts` element. Navigation can be array-based or key-based when parts feature a name to reference
them by. The part’s data can be accessed through the `content` keyword, while headers can be
accessed through the `headers` keyword.

#### Input

This example serves as input to separate DataWeave scripts. shows a raw `multipart/form-data`
payload with a `34b21` boundary consisting of 3 parts:

- a `text/plain` one named `text`

- an `application/json` file (`a.json`) named `file1`

- a `text/html` file (`a.html`) named `file2`

Raw Multipart Data:

```text
--34b21
Content-Disposition: form-data; name="text"
Content-Type: text/plain

Book
--34b21
Content-Disposition: form-data; name="file1"; filename="a.json"
Content-Type: application/json

{
  "title": "Java 8 in Action",
  "author": "Mario Fusco",
  "year": 2014
}
--34b21
Content-Disposition: form-data; name="file2"; filename="a.html"
Content-Type: text/html

<!DOCTYPE html>
<title>
  Available for download!
</title>
--34b21--
```

#### Source

The following DataWeave script uses the raw `multipart/form-data` payload as input to produce
`Book:a.json`.

Reading Multipart Content:

```dataweave
%dw 2.0
output text/plain
---
payload.parts.text.content ++ ':' ++ payload.parts[1].headers.'Content-Disposition'.filename
```

### Example: Generate Multipart Content

You can generate multipart content that DataWeave uses to build an object with a list of parts, each
containing its headers and content. The following DataWeave script produces the raw multipart data
(previously analyzed) if the HTML data is available in the payload.

Writing Multipart Content:

```dataweave
%dw 2.0
output multipart/form-data
boundary='34b21'
---
{
  parts : {
    text : {
      headers : {
        "Content-Type": "text/plain"
      },
      content : "Book"
    },
    file1 : {
      headers : {
        "Content-Disposition" : {
            "name": "file1",
            "filename": "a.json"
        },
        "Content-Type" : "application/json"
      },
      content : {
        title: "Java 8 in Action",
        author: "Mario Fusco",
        year: 2014
      }
    },
    file2 : {
      headers : {
        "Content-Disposition" : {
            "filename": "a.html"
        },
        "Content-Type" : payload.^mimeType
      },
      content : payload
    }
  }
}
```

Notice that the key determines the part’s name if the name is not explicitly provided in the
`Content-Disposition` header, and note that DataWeave can handle content from supported formats, as
well as references to unsupported ones, such as HTML.

## Configuration Properties

DataWeave supports the following configuration properties for the Multipart format.

### Reader Properties

The Multipart format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>boundary</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The multipart <code>boundary</code> value. A string to delimit parts.</p></div></div></td></tr><tr><td><p><code>defaultContentType</code></p></td><td><p><code>String</code></p></td><td><p>This property has no default value.</p></td><td><div><div><p>Sets the default Content-Type to use on parts of the <code>multipart/*</code> format. When set, this property takes precedence over the <a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-system-properties">system property setting</a> for <code>com.mulesoft.dw.multipart.defaultContentType</code>. <em>Introduced in DataWeave 2.3 (2.3.0-20210720) for the August 2021 release of Mule 4.3.0-20210719.</em></p></div></div></td></tr></tbody></table>

### Writer Properties

The Multipart format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>boundary</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The multipart boundary value. A String to delimit parts.</p></div></div></td></tr><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>When set to <code>true</code>, DataWeave generates the output as a data stream, and the script’s execution is deferred until it is consumed. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types (for Multipart)

The Multipart format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>multipart/*</code></p></td></tr></tbody></table>

<!-- document id=39e8dfbbd483babff07f18c1a7f3fb26f72652e3ecc249759a15cbca5469d8f5 url=/mulesoft/current/en-us/dataweave/2.11/dw-multipart-types.md -->

---
product: DataWeave
version: 2.11
---

# Multipart Types (dw::module::Multipart)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>Multipart</p></td><td><div><div><p><code>type Multipart = { preamble?: String, parts: { _?: MultipartPart } }</code></p></div></div></td><td><div><div><p><code>MultiPart</code> type, a data structure for a complete <code>Multipart</code> format. See the output example for the Multipart <code>form</code> function <a href="https://docs.mulesoft.com/dataweave/latest/dw-multipart-functions-form">documentation</a>.</p></div></div></td></tr><tr><td><p>MultipartPart</p></td><td><div><div><p><code>type MultipartPart = { headers?: { "Content-Disposition"?: { name: String, filename?: String }, "Content-Type"?: String }, content: Any }</code></p></div></div></td><td><div><div><p><code>MultipartPart</code> type, a data structure for a part within a <code>MultiPart</code> format. See the output examples for the Multipart <code>field</code> function <a href="https://docs.mulesoft.com/dataweave/latest/dw-multipart-functions-field">documentation</a>.</p></div></div></td></tr></tbody></table>

<!-- document id=aaff79a8c00cfcdfa111b22389edc077a403c14f137fe86590ad45cc5d485745 url=/mulesoft/current/en-us/dataweave/2.12/dw-multipart-types.md -->

---
product: DataWeave
version: 2.12
---

# Multipart Types (dw::module::Multipart)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>Multipart</p></td><td><div><div><p><code>type Multipart = { preamble?: String, parts: { _?: MultipartPart } }</code></p></div></div></td><td><div><div><p><code>MultiPart</code> type, a data structure for a complete <code>Multipart</code> format. See the output example for the Multipart <code>form</code> function <a href="https://docs.mulesoft.com/dataweave/latest/dw-multipart-functions-form">documentation</a>.</p></div></div></td></tr><tr><td><p>MultipartPart</p></td><td><div><div><p><code>type MultipartPart = { headers?: { "Content-Disposition"?: { name: String, filename?: String }, "Content-Type"?: String }, content: Any }</code></p></div></div></td><td><div><div><p><code>MultipartPart</code> type, a data structure for a part within a <code>MultiPart</code> format. See the output examples for the Multipart <code>field</code> function <a href="https://docs.mulesoft.com/dataweave/latest/dw-multipart-functions-field">documentation</a>.</p></div></div></td></tr></tbody></table>

<!-- document id=bca14390d75b612cbafadc461141c10b69197e9cbaee0a804a07d986e36e7a46 url=/mulesoft/current/en-us/dataweave/2.3/dw-multipart-types.md -->

---
product: DataWeave
version: 2.3
---

# Multipart Types (dw::module::Multipart)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>Multipart</p></td><td><p><code>type Multipart = { preamble?: String, parts: { _?: MultipartPart } }</code></p></td><td><p><code>MultiPart</code> type, a data structure for a complete <code>Multipart</code> format. See the output example for the Multipart <code>form</code> function <a href="https://docs.mulesoft.com/dataweave/2.3/dw-multipart-functions-form">documentation</a>.</p></td></tr><tr><td><p>MultipartPart</p></td><td><p><code>type MultipartPart = { headers?: { "Content-Disposition"?: { name: String, filename?: String }, "Content-Type"?: String }, content: Any }</code></p></td><td><p><code>MultipartPart</code> type, a data structure for a part within a <code>MultiPart</code> format. See the output examples for the Multipart <code>field</code> function <a href="https://docs.mulesoft.com/dataweave/2.3/dw-multipart-functions-field">documentation</a>.</p></td></tr></tbody></table>

<!-- document id=d6ac5acef6da6c8e4361582e91229dbf1b245f588719e74992a3e700a1e4e84b url=/mulesoft/current/en-us/dataweave/2.4/dw-multipart-types.md -->

---
product: DataWeave
version: 2.4
---

# Multipart Types (dw::module::Multipart)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>Multipart</p></td><td><div><div><p><code>type Multipart = { preamble?: String, parts: { _?: MultipartPart } }</code></p></div></div></td><td><div><div><p><code>MultiPart</code> type, a data structure for a complete <code>Multipart</code> format. See the output example for the Multipart <code>form</code> function <a href="https://docs.mulesoft.com/dataweave/latest/dw-multipart-functions-form">documentation</a>.</p></div></div></td></tr><tr><td><p>MultipartPart</p></td><td><div><div><p><code>type MultipartPart = { headers?: { "Content-Disposition"?: { name: String, filename?: String }, "Content-Type"?: String }, content: Any }</code></p></div></div></td><td><div><div><p><code>MultipartPart</code> type, a data structure for a part within a <code>MultiPart</code> format. See the output examples for the Multipart <code>field</code> function <a href="https://docs.mulesoft.com/dataweave/latest/dw-multipart-functions-field">documentation</a>.</p></div></div></td></tr></tbody></table>

<!-- document id=90f8a826cee9b5cd8e6e166a15e55ba5f320623039a536a138daf821ee6e8749 url=/mulesoft/current/en-us/dataweave/2.6/dw-multipart-types.md -->

---
product: DataWeave
version: 2.6
---

# Multipart Types (dw::module::Multipart)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>Multipart</p></td><td><div><div><p><code>type Multipart = { preamble?: String, parts: { _?: MultipartPart } }</code></p></div></div></td><td><div><div><p><code>MultiPart</code> type, a data structure for a complete <code>Multipart</code> format. See the output example for the Multipart <code>form</code> function <a href="https://docs.mulesoft.com/dataweave/latest/dw-multipart-functions-form">documentation</a>.</p></div></div></td></tr><tr><td><p>MultipartPart</p></td><td><div><div><p><code>type MultipartPart = { headers?: { "Content-Disposition"?: { name: String, filename?: String }, "Content-Type"?: String }, content: Any }</code></p></div></div></td><td><div><div><p><code>MultipartPart</code> type, a data structure for a part within a <code>MultiPart</code> format. See the output examples for the Multipart <code>field</code> function <a href="https://docs.mulesoft.com/dataweave/latest/dw-multipart-functions-field">documentation</a>.</p></div></div></td></tr></tbody></table>

<!-- document id=fe8b01ad45bab0f3931234cf926eef3006a8045be66a016a9b55173c8abb14ba url=/mulesoft/current/en-us/dataweave/2.9/dw-multipart-types.md -->

---
product: DataWeave
version: 2.9
---

# Multipart Types (dw::module::Multipart)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>Multipart</p></td><td><div><div><p><code>type Multipart = { preamble?: String, parts: { _?: MultipartPart } }</code></p></div></div></td><td><div><div><p><code>MultiPart</code> type, a data structure for a complete <code>Multipart</code> format. See the output example for the Multipart <code>form</code> function <a href="https://docs.mulesoft.com/dataweave/latest/dw-multipart-functions-form">documentation</a>.</p></div></div></td></tr><tr><td><p>MultipartPart</p></td><td><div><div><p><code>type MultipartPart = { headers?: { "Content-Disposition"?: { name: String, filename?: String }, "Content-Type"?: String }, content: Any }</code></p></div></div></td><td><div><div><p><code>MultipartPart</code> type, a data structure for a part within a <code>MultiPart</code> format. See the output examples for the Multipart <code>field</code> function <a href="https://docs.mulesoft.com/dataweave/latest/dw-multipart-functions-field">documentation</a>.</p></div></div></td></tr></tbody></table>

<!-- document id=a87cfa8f1042f6c8f6b71329c7937febf3fc9b1332be2e6bc14e2e8972023933 url=/mulesoft/current/en-us/dataweave/latest/dw-multipart-types.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Multipart Types (dw::module::Multipart)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>Multipart</p></td><td><div><div><p><code>type Multipart = { preamble?: String, parts: { _?: MultipartPart } }</code></p></div></div></td><td><div><div><p><code>MultiPart</code> type, a data structure for a complete <code>Multipart</code> format. See the output example for the Multipart <code>form</code> function <a href="https://docs.mulesoft.com/dataweave/latest/dw-multipart-functions-form">documentation</a>.</p></div></div></td></tr><tr><td><p>MultipartPart</p></td><td><div><div><p><code>type MultipartPart = { headers?: { "Content-Disposition"?: { name: String, filename?: String }, "Content-Type"?: String }, content: Any }</code></p></div></div></td><td><div><div><p><code>MultipartPart</code> type, a data structure for a part within a <code>MultiPart</code> format. See the output examples for the Multipart <code>field</code> function <a href="https://docs.mulesoft.com/dataweave/latest/dw-multipart-functions-field">documentation</a>.</p></div></div></td></tr></tbody></table>

<!-- document id=a4a61d26a182debfee5191f694c06f6c1437efd35e3cdd402217ec2ceb59e92b url=/mulesoft/current/en-us/dataweave/2.11/dw-types-functions-nameof.md -->

---
product: DataWeave
version: 2.11
---

# nameOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## nameOf(t: Type): String

Returns the name of the input type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to query</p></td></tr></tbody></table>

### Example

This example shows how `nameOf` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::core::Types
type AArray = Array<String> {n: 1}
type AArray2 = Array<String>
---
 {
     a: nameOf(AArray),
     b: nameOf(AArray2),
     c: nameOf(String)
 }
```

#### Output

```Json
{
   "a": "AArray",
   "b": "AArray2",
   "c": "String"
 }
```

<!-- document id=cc598099ca017606b720b36fd8596eae566a5700c9c9201beff8ef65e57b7ae3 url=/mulesoft/current/en-us/dataweave/2.12/dw-types-functions-nameof.md -->

---
product: DataWeave
version: 2.12
---

# nameOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## nameOf(t: Type): String

Returns the name of the input type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to query</p></td></tr></tbody></table>

### Example

This example shows how `nameOf` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::core::Types
type AArray = Array<String> {n: 1}
type AArray2 = Array<String>
---
 {
     a: nameOf(AArray),
     b: nameOf(AArray2),
     c: nameOf(String)
 }
```

#### Output

```Json
{
   "a": "AArray",
   "b": "AArray2",
   "c": "String"
 }
```

<!-- document id=733634c46bcc6902823aefe4e155750b924e11a638c6cffe8ad5acf0b7d96894 url=/mulesoft/current/en-us/dataweave/2.3/dw-types-functions-nameof.md -->

---
product: DataWeave
version: 2.3
---

# nameOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## nameOf(Type): String

Returns the name of the input type.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>t</p></td><td><p>The type to query</p></td></tr></tbody></table>

### Example

This example shows how `nameOf` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::core::Types
type AArray = Array<String> {n: 1}
type AArray2 = Array<String>
---
 {
     a: nameOf(AArray),
     b: nameOf(AArray2),
     c: nameOf(String)
 }
```

#### Output

```Json
{
   "a": "AArray",
   "b": "AArray2",
   "c": "String"
 }
```

<!-- document id=e8dc0c8f3bd3057f7267f73e87210301b12b9e669974df46430cc834f294b4d1 url=/mulesoft/current/en-us/dataweave/2.4/dw-types-functions-nameof.md -->

---
product: DataWeave
version: 2.4
---

# nameOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## nameOf(t: Type): String

Returns the name of the input type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to query</p></td></tr></tbody></table>

### Example

This example shows how `nameOf` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::core::Types
type AArray = Array<String> {n: 1}
type AArray2 = Array<String>
---
 {
     a: nameOf(AArray),
     b: nameOf(AArray2),
     c: nameOf(String)
 }
```

#### Output

```Json
{
   "a": "AArray",
   "b": "AArray2",
   "c": "String"
 }
```

<!-- document id=2a914214ea4d945d1cebb6afad2e0c8b5146c68c782433f4f686b08862153ce0 url=/mulesoft/current/en-us/dataweave/2.6/dw-types-functions-nameof.md -->

---
product: DataWeave
version: 2.6
---

# nameOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## nameOf(t: Type): String

Returns the name of the input type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to query</p></td></tr></tbody></table>

### Example

This example shows how `nameOf` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::core::Types
type AArray = Array<String> {n: 1}
type AArray2 = Array<String>
---
 {
     a: nameOf(AArray),
     b: nameOf(AArray2),
     c: nameOf(String)
 }
```

#### Output

```Json
{
   "a": "AArray",
   "b": "AArray2",
   "c": "String"
 }
```

<!-- document id=4a692df2f95248c6da6fc439c56bf81bd462a799eed6c50c1e1c1d908b880d4c url=/mulesoft/current/en-us/dataweave/2.9/dw-types-functions-nameof.md -->

---
product: DataWeave
version: 2.9
---

# nameOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## nameOf(t: Type): String

Returns the name of the input type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to query</p></td></tr></tbody></table>

### Example

This example shows how `nameOf` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::core::Types
type AArray = Array<String> {n: 1}
type AArray2 = Array<String>
---
 {
     a: nameOf(AArray),
     b: nameOf(AArray2),
     c: nameOf(String)
 }
```

#### Output

```Json
{
   "a": "AArray",
   "b": "AArray2",
   "c": "String"
 }
```

<!-- document id=4831aac62b3c8aaafc644b45499c59ea395a54daaf664d416e573a065e0aaceb url=/mulesoft/current/en-us/dataweave/latest/dw-types-functions-nameof.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# nameOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## nameOf(t: Type): String

Returns the name of the input type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to query</p></td></tr></tbody></table>

### Example

This example shows how `nameOf` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::core::Types
type AArray = Array<String> {n: 1}
type AArray2 = Array<String>
---
 {
     a: nameOf(AArray),
     b: nameOf(AArray2),
     c: nameOf(String)
 }
```

#### Output

```Json
{
   "a": "AArray",
   "b": "AArray2",
   "c": "String"
 }
```

<!-- document id=daf4f2cf48b4097bfa4dea08bdee5bd0cec1a40ce9a6cfd1a5e420011489a2d2 url=/mulesoft/current/en-us/dataweave/2.11/dw-objects-functions-nameset.md -->

---
product: DataWeave
version: 2.11
---

# nameSet

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## nameSet(obj: Object): Array<String>

Returns an array of keys from an object.

_This function is **Deprecated**. Use [dw::Core::namesOf](https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-namesof), instead._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the keys from the input object.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Objects
output application/json
---
{ "nameSet" : nameSet({ "a" : true, "b" : 1}) }
```

#### Output

```JSON
{ "nameSet" : ["a","b"] }
```

<!-- document id=255fcafe0c7bb5c26ba604c538a83ccc2312354d466547748f28c6ebf045c37b url=/mulesoft/current/en-us/dataweave/2.12/dw-objects-functions-nameset.md -->

---
product: DataWeave
version: 2.12
---

# nameSet

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## nameSet(obj: Object): Array<String>

Returns an array of keys from an object.

_This function is **Deprecated**. Use [dw::Core::namesOf](https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-namesof), instead._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the keys from the input object.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Objects
output application/json
---
{ "nameSet" : nameSet({ "a" : true, "b" : 1}) }
```

#### Output

```JSON
{ "nameSet" : ["a","b"] }
```

<!-- document id=7f88ba701b04ad89f2470dc8c12def83a0105a4001f54936b4667aad0d58fa87 url=/mulesoft/current/en-us/dataweave/2.3/dw-objects-functions-nameset.md -->

---
product: DataWeave
version: 2.3
---

# nameSet

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## nameSet(Object): Array<String>

Returns an array of keys from an object.

This method is **Deprecated**. Use `namesOf` from Core module, instead.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the keys from the input object.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Objects
output application/json
---
{ "nameSet" : nameSet({ "a" : true, "b" : 1}) }
```

#### Output

```JSON
{ "nameSet" : ["a","b"] }
```

<!-- document id=95d1bb3cb87495d77382508a2fbff1fe77ecbcb23ff2b0ac07a54fd3d9ecac47 url=/mulesoft/current/en-us/dataweave/2.4/dw-objects-functions-nameset.md -->

---
product: DataWeave
version: 2.4
---

# nameSet

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## nameSet(obj: Object): Array<String>

Returns an array of keys from an object.

_This function is **Deprecated**. Use [dw::Core::namesOf](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-namesof), instead._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the keys from the input object.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Objects
output application/json
---
{ "nameSet" : nameSet({ "a" : true, "b" : 1}) }
```

#### Output

```JSON
{ "nameSet" : ["a","b"] }
```

<!-- document id=b41382d776187d50ecff14552c96629b9173df888ff6e5337b4ef2c691e6c225 url=/mulesoft/current/en-us/dataweave/2.6/dw-objects-functions-nameset.md -->

---
product: DataWeave
version: 2.6
---

# nameSet

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## nameSet(obj: Object): Array<String>

Returns an array of keys from an object.

_This function is **Deprecated**. Use [dw::Core::namesOf](https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-namesof), instead._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the keys from the input object.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Objects
output application/json
---
{ "nameSet" : nameSet({ "a" : true, "b" : 1}) }
```

#### Output

```JSON
{ "nameSet" : ["a","b"] }
```

<!-- document id=e0834688e7f1e27581fff917b74122efe3a86c4a159d455a883cefa278d28066 url=/mulesoft/current/en-us/dataweave/2.9/dw-objects-functions-nameset.md -->

---
product: DataWeave
version: 2.9
---

# nameSet

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## nameSet(obj: Object): Array<String>

Returns an array of keys from an object.

_This function is **Deprecated**. Use [dw::Core::namesOf](https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-namesof), instead._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the keys from the input object.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Objects
output application/json
---
{ "nameSet" : nameSet({ "a" : true, "b" : 1}) }
```

#### Output

```JSON
{ "nameSet" : ["a","b"] }
```

<!-- document id=9b93e5ae21454562e6d0a619f0ef68471c3a8d5cd9beaedeecfb6ccb890dcb99 url=/mulesoft/current/en-us/dataweave/latest/dw-objects-functions-nameset.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# nameSet

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## nameSet(obj: Object): Array<String>

Returns an array of keys from an object.

_This function is **Deprecated**. Use [dw::Core::namesOf](https://docs.mulesoft.com/dataweave/latest/dw-core-functions-namesof), instead._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the keys from the input object.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Objects
output application/json
---
{ "nameSet" : nameSet({ "a" : true, "b" : 1}) }
```

#### Output

```JSON
{ "nameSet" : ["a","b"] }
```

<!-- document id=66dd20c60c58bc77efc63b2e6aa3f3c70f7f0b19292fcecf094b04e0e8eb985d url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-namesof.md -->

---
product: DataWeave
version: 2.11
---

# namesOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## namesOf(obj: Object): Array<String>

Returns an array of strings with the names of all the keys within the given object.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the keys from the key-value pairs within the input object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "namesOf" : namesOf({ "a" : true, "b" : 1}) }
```

#### Output

```JSON
{ "namesOf" : ["a","b"] }
```

## namesOf(obj: Null): Null

Helper function that enables `namesOf` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=fb511c551e882bd909b46247170628e37566c87633540a51881bd3184bf4292b url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-namesof.md -->

---
product: DataWeave
version: 2.12
---

# namesOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## namesOf(obj: Object): Array<String>

Returns an array of strings with the names of all the keys within the given object.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the keys from the key-value pairs within the input object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "namesOf" : namesOf({ "a" : true, "b" : 1}) }
```

#### Output

```JSON
{ "namesOf" : ["a","b"] }
```

## namesOf(obj: Null): Null

Helper function that enables `namesOf` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=31386532ffb7a7107d4ebfe2e7cfc8b19ea6e08c9b16275c969f18ff23a07729 url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-namesof.md -->

---
product: DataWeave
version: 2.3
---

# namesOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## namesOf(Object): Array<String>

Returns an array of strings with the names of all the keys within the given object.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the keys from the key-value pairs within the input object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "namesOf" : namesOf({ "a" : true, "b" : 1}) }
```

#### Output

```JSON
{ "namesOf" : ["a","b"] }
```

<!-- document id=502b16fc275e701b10fb450c472b81640de93197b79cc1179916c45ee3d72d35 url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-namesof.md -->

---
product: DataWeave
version: 2.4
---

# namesOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## namesOf(obj: Object): Array<String>

Returns an array of strings with the names of all the keys within the given object.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the keys from the key-value pairs within the input object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "namesOf" : namesOf({ "a" : true, "b" : 1}) }
```

#### Output

```JSON
{ "namesOf" : ["a","b"] }
```

## namesOf(obj: Null): Null

Helper function that enables `namesOf` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=fdeb7fad1ab4adfc115e6a5f8805569d44fee25bdb2c91e1fddcfdaf18b566f0 url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-namesof.md -->

---
product: DataWeave
version: 2.6
---

# namesOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## namesOf(obj: Object): Array<String>

Returns an array of strings with the names of all the keys within the given object.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the keys from the key-value pairs within the input object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "namesOf" : namesOf({ "a" : true, "b" : 1}) }
```

#### Output

```JSON
{ "namesOf" : ["a","b"] }
```

## namesOf(obj: Null): Null

Helper function that enables `namesOf` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=47751903ec6a2dd1b12bfe47824a4c7dad41db47eb8971df15fe1538c5fad8f6 url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-namesof.md -->

---
product: DataWeave
version: 2.9
---

# namesOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## namesOf(obj: Object): Array<String>

Returns an array of strings with the names of all the keys within the given object.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the keys from the key-value pairs within the input object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "namesOf" : namesOf({ "a" : true, "b" : 1}) }
```

#### Output

```JSON
{ "namesOf" : ["a","b"] }
```

## namesOf(obj: Null): Null

Helper function that enables `namesOf` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=47d0f9d8bc7572b994f6d7e77a5e96a3501fc9a91acdd116e1f10283485a5f2c url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-namesof.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# namesOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## namesOf(obj: Object): Array<String>

Returns an array of strings with the names of all the keys within the given object.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the keys from the key-value pairs within the input object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "namesOf" : namesOf({ "a" : true, "b" : 1}) }
```

#### Output

```JSON
{ "namesOf" : ["a","b"] }
```

## namesOf(obj: Null): Null

Helper function that enables `namesOf` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=4295461f7a3575202918cfcbdf502aeb6efa15cb01842b65d6661d427060c1d6 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-native.md -->

---
product: DataWeave
version: 2.11
---

# native

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## native(String): Nothing

Internal method used to indicate that a function implementation is not written in DataWeave but in
Scala.

<!-- document id=bf387e31d97f5b9fd809965b07e4ded51778a7738552bd4118bb6153133d3ceb url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-native.md -->

---
product: DataWeave
version: 2.12
---

# native

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## native(String): Nothing

Internal method used to indicate that a function implementation is not written in DataWeave but in
Scala.

<!-- document id=aed270869dcbd1e47f5041b81e9aa521de0eca0f90a4b5e04dca6cd1a987bba1 url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-native.md -->

---
product: DataWeave
version: 2.3
---

# native

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## native(String): Nothing

Internal method used to indicate that a function implementation is not written in DataWeave but in
Scala.

<!-- document id=7054036ab8d4d87dd1bcb00311982d4bb6839d9f3db305832fe89e97ad1fcdd8 url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-native.md -->

---
product: DataWeave
version: 2.4
---

# native

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## native(String): Nothing

Internal method used to indicate that a function implementation is not written in DataWeave but in
Scala.

<!-- document id=eba0796ebe4c729ad77e0e7125ab67096feda294511e7cdbc54c044c8666dcd2 url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-native.md -->

---
product: DataWeave
version: 2.6
---

# native

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## native(String): Nothing

Internal method used to indicate that a function implementation is not written in DataWeave but in
Scala.

<!-- document id=452dae9620d6c93ed088e82a45d76b422922f36a53e0a2352c19705812f84fd5 url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-native.md -->

---
product: DataWeave
version: 2.9
---

# native

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## native(String): Nothing

Internal method used to indicate that a function implementation is not written in DataWeave but in
Scala.

<!-- document id=02cdd1f505dac076124bc41492a0249422cbe23de9d054089d7ad76227d3cde2 url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-native.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# native

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## native(String): Nothing

Internal method used to indicate that a function implementation is not written in DataWeave but in
Scala.

<!-- document id=3542938d5454ba57f9aa46c2264500acb34db04ba237e03e81201d73c665ed10 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-formats-ndjson.md -->

---
product: DataWeave
version: 2.11
keywords: format, ndjson, application/x-ndjson, application/x-ldjson, application/x-ndjson
---

# Newline Delimited JSON (ndjson) Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/x-ndjson`

ID: `ndjson`

DataWeave represents the Newline Delimited JSON format (ndjson) as an array of objects. Each line of
the ndjson format is mapped to one object in the array.

These parser strategies are supported by the ndjson reader:

- In-memory

- Streaming

For details, see [DataWeave Readers](https://docs.mulesoft.com/dataweave/2.11/dataweave-formats#dw_readers_writers).

## Examples

The following examples show uses of the ndjson format.

- [Example](#example1)

- [Example](#example2)

### Example

This example shows how DataWeave represents a simple ndjson input.

#### Input

```ndjson
{"name": "Leandro","lastName": "Shokida"}
{"name": "Mariano","lastName": "De Achaval"}
```

#### Source

The DataWeave script transforms the ndjson input to the DataWeave (dw) format and MIME type.

```dataweave
%dw 2.0
output application/dw
---
payload
```

#### Output

The DataWeave (dw) format outputs the ndjson input into an array of comma-separated objects.

```weave
[
    {"name": "Leandro","lastName": "Shokida"},
    {"name": "Mariano","lastName": "De Achaval"}
]
```

### Example

This example shows that the ndjson reader ignores all lines of ndjson data that are invalid if
`skipInvalid=true`.

#### Input

The input to the DataWeave source includes valid and invalid lines of ndjson data. Assume that the
input is from a file `myInput.ndjson`.

myInput.ndjson:

```ndjson
{"name": "Christian"
{"name": "Mariano"}
{"name": "Tomo"
{"name": "Shoki"}
```

#### Source

The DataWeave script inputs the contents of the input file `myInput.ndjson`, applies the
`skipInvalid=true` reader property, and transforms the input to the JSON format and MIME type.

```dataweave
%dw 2.0
var myInput = readUrl('classpath://myInput.ndjson', 'application/x-ndjson, {skipInvalid=true})
output application/json
---
myInput
```

#### Output

The JSON output is an array of the valid objects from the ndjson input.

```weave
[
  {
    "name": "Mariano"
  },
  {
    "name": "Shoki"
  }
]
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>ignoreEmptyLine</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Ignores empty lines.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>skipInvalid</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Skips invalid records and ignores values that aren’t valid in this format.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>'UTF-8'</code></p></td><td><div><div><p>Encoding that the writer uses for output. Defaults to "UTF-8".</p></div></div></td></tr><tr><td><p><code>skipNullOn</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Skips <code>null</code> values. By default, DataWeave does not skip.</p></div><div><ul><li><p><code>arrays</code><br>Ignore and omit <code>null</code> values inside arrays from the JSON output, for example, with <code>output application/x-ndjson skipNullOn="arrays"</code>.</p></li><li><p><code>objects</code><br>Ignore key-value pairs that have <code>null</code> as the value, for example, with <code>output application/x-ndjson skipNullOn="objects"</code>.</p></li><li><p><code>everywhere</code><br>Apply <code>skipNullOn</code> to arrays and objects, for example, <code>output application/x-ndjson skipNullOn="everywhere"</code>.</p></li></ul></div><div><p>Valid values are <code>arrays</code> or <code>objects</code> or <code>everywhere</code>.</p></div></div></td></tr><tr><td><p><code>writeAttributes</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Converts attributes of a key into child key-value pairs of that key. The attribute key name starts with <code>@</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports these MIME types:

- `application/x-ndjson`

- `application/x-ldjson`

<!-- document id=8ed0d91285cabc05fd9288d4d8797205e0beb81b558f4309a53f1928b2de610a url=/mulesoft/current/en-us/dataweave/2.12/dataweave-formats-ndjson.md -->

---
product: DataWeave
version: 2.12
keywords: format, ndjson, application/x-ndjson, application/x-ldjson, application/x-ndjson
---

# Newline Delimited JSON (ndjson) Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/x-ndjson`

ID: `ndjson`

DataWeave represents the Newline Delimited JSON format (ndjson) as an array of objects. Each line of
the ndjson format is mapped to one object in the array.

These parser strategies are supported by the ndjson reader:

- In-memory

- Streaming

For details, see [DataWeave Readers](https://docs.mulesoft.com/dataweave/2.12/dataweave-formats#dw_readers_writers).

## Examples

The following examples show uses of the ndjson format.

- [Example](#example1)

- [Example](#example2)

### Example

This example shows how DataWeave represents a simple ndjson input.

#### Input

```ndjson
{"name": "Leandro","lastName": "Shokida"}
{"name": "Mariano","lastName": "De Achaval"}
```

#### Source

The DataWeave script transforms the ndjson input to the DataWeave (dw) format and MIME type.

```dataweave
%dw 2.0
output application/dw
---
payload
```

#### Output

The DataWeave (dw) format outputs the ndjson input into an array of comma-separated objects.

```weave
[
    {"name": "Leandro","lastName": "Shokida"},
    {"name": "Mariano","lastName": "De Achaval"}
]
```

### Example

This example shows that the ndjson reader ignores all lines of ndjson data that are invalid if
`skipInvalid=true`.

#### Input

The input to the DataWeave source includes valid and invalid lines of ndjson data. Assume that the
input is from a file `myInput.ndjson`.

myInput.ndjson:

```ndjson
{"name": "Christian"
{"name": "Mariano"}
{"name": "Tomo"
{"name": "Shoki"}
```

#### Source

The DataWeave script inputs the contents of the input file `myInput.ndjson`, applies the
`skipInvalid=true` reader property, and transforms the input to the JSON format and MIME type.

```dataweave
%dw 2.0
var myInput = readUrl('classpath://myInput.ndjson', 'application/x-ndjson, {skipInvalid=true})
output application/json
---
myInput
```

#### Output

The JSON output is an array of the valid objects from the ndjson input.

```weave
[
  {
    "name": "Mariano"
  },
  {
    "name": "Shoki"
  }
]
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>ignoreEmptyLine</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Ignores empty lines.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>skipInvalid</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Skips invalid records and ignores values that aren’t valid in this format.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>'UTF-8'</code></p></td><td><div><div><p>Encoding that the writer uses for output. Defaults to "UTF-8".</p></div></div></td></tr><tr><td><p><code>skipNullOn</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Skips <code>null</code> values. By default, DataWeave does not skip.</p></div><div><ul><li><p><code>arrays</code><br>Ignore and omit <code>null</code> values inside arrays from the JSON output, for example, with <code>output application/x-ndjson skipNullOn="arrays"</code>.</p></li><li><p><code>objects</code><br>Ignore key-value pairs that have <code>null</code> as the value, for example, with <code>output application/x-ndjson skipNullOn="objects"</code>.</p></li><li><p><code>everywhere</code><br>Apply <code>skipNullOn</code> to arrays and objects, for example, <code>output application/x-ndjson skipNullOn="everywhere"</code>.</p></li></ul></div><div><p>Valid values are <code>arrays</code> or <code>objects</code> or <code>everywhere</code>.</p></div></div></td></tr><tr><td><p><code>writeAttributes</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Converts attributes of a key into child key-value pairs of that key. The attribute key name starts with <code>@</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports these MIME types:

- `application/x-ndjson`

- `application/x-ldjson`

<!-- document id=d1b5428f225c63f72664e8c912d5dfcc73454dd52126f39c9ad29d437d7fe439 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-formats-ndjson.md -->

---
product: DataWeave
version: 2.4
keywords: format, ndjson, application/x-ndjson, application/x-ldjson, application/x-ndjson
---

# Newline Delimited JSON (ndjson) Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/x-ndjson`

ID: `ndjson`

DataWeave represents the Newline Delimited JSON format (ndjson) as an array of objects. Each line of
the ndjson format is mapped to one object in the array.

The following parser strategies are supported by the ndjson reader:

- In-memory

- Streaming

For details, see [DataWeave Readers](https://docs.mulesoft.com/dataweave/2.4/dataweave-formats#dw_readers_writers).

## Examples

The following examples show uses of the ndjson format.

- [Example](#example1)

- [Example](#example2)

### Example

This example shows how DataWeave represents a simple ndjson input.

#### Input

```ndjson
{"name": "Leandro","lastName": "Shokida"}
{"name": "Mariano","lastName": "De Achaval"}
```

#### Source

The DataWeave script transforms the ndjson input to the DataWeave (dw) format and MIME type.

```dataweave
%dw 2.0
output application/dw
---
payload
```

#### Output

The DataWeave (dw) format outputs the ndjson input into an array of comma-separated objects.

```weave
[
    {"name": "Leandro","lastName": "Shokida"},
    {"name": "Mariano","lastName": "De Achaval"}
]
```

### Example

This example shows that the ndjson reader ignores all lines of ndjson data that are invalid if
`skipInvalid=true`.

#### Input

The input to the DataWeave source includes valid and invalid lines of ndjson data. Assume that the
input is from a file `myInput.ndjson`.

myInput.ndjson:

```ndjson
{"name": "Christian"
{"name": "Mariano"}
{"name": "Tomo"
{"name": "Shoki"}
```

#### Source

The DataWeave script inputs the contents of the input file `myInput.ndjson`, applies the
`skipInvalid=true` reader property, and transforms the input to the JSON format and MIME type.

```dataweave
%dw 2.0
var myInput = readUrl('classpath://myInput.ndjson', 'application/x-ndjson, {skipInvalid=true})
output application/json
---
myInput
```

#### Output

The JSON output is an array of the valid objects from the ndjson input.

```weave
[
  {
    "name": "Mariano"
  },
  {
    "name": "Shoki"
  }
]
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>ignoreEmptyLine</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Ignores empty lines.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>skipInvalid</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Skips invalid records and ignores values that are not valid in this format.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>'UTF-8'</code></p></td><td><div><div><p>The character set to use for the output, such as UTF-8.</p></div></div></td></tr><tr><td><p><code>skipNullOn</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Skips <code>null</code> values. By default, DataWeave does not skip.</p></div><div><ul><li><p><code>arrays</code><br>Ignore and omit <code>null</code> values inside arrays from the JSON output, for example, with <code>output application/x-ndjson skipNullOn="arrays"</code>.</p></li><li><p><code>objects</code><br>Ignore key-value pairs that have <code>null</code> as the value, for example, with <code>output application/x-ndjson skipNullOn="objects"</code>.</p></li><li><p><code>everywhere</code><br>Apply <code>skipNullOn</code> to arrays and objects, for example, <code>output application/x-ndjson skipNullOn="everywhere"</code>.</p></li></ul></div><div><p>Valid values are <code>arrays</code> or <code>objects</code> or <code>everywhere</code>.</p></div></div></td></tr><tr><td><p><code>writeAttributes</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Converts attributes of a key into child key-value pairs of that key. The attribute key name starts with <code>@</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>application/x-ndjson</code></p></td></tr><tr><td><p><code>application/x-ldjson</code></p></td></tr></tbody></table>

<!-- document id=bbe300dda52c8c6db9ce91520ebc5b344171b3ccc3a23222c193685a6de0acdc url=/mulesoft/current/en-us/dataweave/2.6/dataweave-formats-ndjson.md -->

---
product: DataWeave
version: 2.6
keywords: format, ndjson, application/x-ndjson, application/x-ldjson, application/x-ndjson
---

# Newline Delimited JSON (ndjson) Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/x-ndjson`

ID: `ndjson`

DataWeave represents the Newline Delimited JSON format (ndjson) as an array of objects. Each line of
the ndjson format is mapped to one object in the array.

The following parser strategies are supported by the ndjson reader:

- In-memory

- Streaming

For details, see [DataWeave Readers](https://docs.mulesoft.com/dataweave/2.6/dataweave-formats#dw_readers_writers).

## Examples

The following examples show uses of the ndjson format.

- [Example](#example1)

- [Example](#example2)

### Example

This example shows how DataWeave represents a simple ndjson input.

#### Input

```ndjson
{"name": "Leandro","lastName": "Shokida"}
{"name": "Mariano","lastName": "De Achaval"}
```

#### Source

The DataWeave script transforms the ndjson input to the DataWeave (dw) format and MIME type.

```dataweave
%dw 2.0
output application/dw
---
payload
```

#### Output

The DataWeave (dw) format outputs the ndjson input into an array of comma-separated objects.

```weave
[
    {"name": "Leandro","lastName": "Shokida"},
    {"name": "Mariano","lastName": "De Achaval"}
]
```

### Example

This example shows that the ndjson reader ignores all lines of ndjson data that are invalid if
`skipInvalid=true`.

#### Input

The input to the DataWeave source includes valid and invalid lines of ndjson data. Assume that the
input is from a file `myInput.ndjson`.

myInput.ndjson:

```ndjson
{"name": "Christian"
{"name": "Mariano"}
{"name": "Tomo"
{"name": "Shoki"}
```

#### Source

The DataWeave script inputs the contents of the input file `myInput.ndjson`, applies the
`skipInvalid=true` reader property, and transforms the input to the JSON format and MIME type.

```dataweave
%dw 2.0
var myInput = readUrl('classpath://myInput.ndjson', 'application/x-ndjson, {skipInvalid=true})
output application/json
---
myInput
```

#### Output

The JSON output is an array of the valid objects from the ndjson input.

```weave
[
  {
    "name": "Mariano"
  },
  {
    "name": "Shoki"
  }
]
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>ignoreEmptyLine</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Ignores empty lines.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>skipInvalid</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Skips invalid records and ignores values that are not valid in this format.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>'UTF-8'</code></p></td><td><div><div><p>Encoding that the writer uses for output. Defaults to "UTF-8".</p></div></div></td></tr><tr><td><p><code>skipNullOn</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Skips <code>null</code> values. By default, DataWeave does not skip.</p></div><div><ul><li><p><code>arrays</code><br>Ignore and omit <code>null</code> values inside arrays from the JSON output, for example, with <code>output application/x-ndjson skipNullOn="arrays"</code>.</p></li><li><p><code>objects</code><br>Ignore key-value pairs that have <code>null</code> as the value, for example, with <code>output application/x-ndjson skipNullOn="objects"</code>.</p></li><li><p><code>everywhere</code><br>Apply <code>skipNullOn</code> to arrays and objects, for example, <code>output application/x-ndjson skipNullOn="everywhere"</code>.</p></li></ul></div><div><p>Valid values are <code>arrays</code> or <code>objects</code> or <code>everywhere</code>.</p></div></div></td></tr><tr><td><p><code>writeAttributes</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Converts attributes of a key into child key-value pairs of that key. The attribute key name starts with <code>@</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>application/x-ndjson</code></p></td></tr><tr><td><p><code>application/x-ldjson</code></p></td></tr></tbody></table>

<!-- document id=ce0574e618f083de3bb1b09e7154401970828e85362daa02e4c251191a193b7c url=/mulesoft/current/en-us/dataweave/2.9/dataweave-formats-ndjson.md -->

---
product: DataWeave
version: 2.9
keywords: format, ndjson, application/x-ndjson, application/x-ldjson, application/x-ndjson
---

# Newline Delimited JSON (ndjson) Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/x-ndjson`

ID: `ndjson`

DataWeave represents the Newline Delimited JSON format (ndjson) as an array of objects. Each line of
the ndjson format is mapped to one object in the array.

The following parser strategies are supported by the ndjson reader:

- In-memory

- Streaming

For details, see [DataWeave Readers](https://docs.mulesoft.com/dataweave/2.9/dataweave-formats#dw_readers_writers).

## Examples

The following examples show uses of the ndjson format.

- [Example](#example1)

- [Example](#example2)

### Example

This example shows how DataWeave represents a simple ndjson input.

#### Input

```ndjson
{"name": "Leandro","lastName": "Shokida"}
{"name": "Mariano","lastName": "De Achaval"}
```

#### Source

The DataWeave script transforms the ndjson input to the DataWeave (dw) format and MIME type.

```dataweave
%dw 2.0
output application/dw
---
payload
```

#### Output

The DataWeave (dw) format outputs the ndjson input into an array of comma-separated objects.

```weave
[
    {"name": "Leandro","lastName": "Shokida"},
    {"name": "Mariano","lastName": "De Achaval"}
]
```

### Example

This example shows that the ndjson reader ignores all lines of ndjson data that are invalid if
`skipInvalid=true`.

#### Input

The input to the DataWeave source includes valid and invalid lines of ndjson data. Assume that the
input is from a file `myInput.ndjson`.

myInput.ndjson:

```ndjson
{"name": "Christian"
{"name": "Mariano"}
{"name": "Tomo"
{"name": "Shoki"}
```

#### Source

The DataWeave script inputs the contents of the input file `myInput.ndjson`, applies the
`skipInvalid=true` reader property, and transforms the input to the JSON format and MIME type.

```dataweave
%dw 2.0
var myInput = readUrl('classpath://myInput.ndjson', 'application/x-ndjson, {skipInvalid=true})
output application/json
---
myInput
```

#### Output

The JSON output is an array of the valid objects from the ndjson input.

```weave
[
  {
    "name": "Mariano"
  },
  {
    "name": "Shoki"
  }
]
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>ignoreEmptyLine</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Ignores empty lines.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>skipInvalid</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Skips invalid records and ignores values that are not valid in this format.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>'UTF-8'</code></p></td><td><div><div><p>Encoding that the writer uses for output. Defaults to "UTF-8".</p></div></div></td></tr><tr><td><p><code>skipNullOn</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Skips <code>null</code> values. By default, DataWeave does not skip.</p></div><div><ul><li><p><code>arrays</code><br>Ignore and omit <code>null</code> values inside arrays from the JSON output, for example, with <code>output application/x-ndjson skipNullOn="arrays"</code>.</p></li><li><p><code>objects</code><br>Ignore key-value pairs that have <code>null</code> as the value, for example, with <code>output application/x-ndjson skipNullOn="objects"</code>.</p></li><li><p><code>everywhere</code><br>Apply <code>skipNullOn</code> to arrays and objects, for example, <code>output application/x-ndjson skipNullOn="everywhere"</code>.</p></li></ul></div><div><p>Valid values are <code>arrays</code> or <code>objects</code> or <code>everywhere</code>.</p></div></div></td></tr><tr><td><p><code>writeAttributes</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Converts attributes of a key into child key-value pairs of that key. The attribute key name starts with <code>@</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>application/x-ndjson</code></p></td></tr><tr><td><p><code>application/x-ldjson</code></p></td></tr></tbody></table>

<!-- document id=d38c80fe424beee47c7ca81db2bc7a2d9a575f19a1b3b226d261c2a01f8512f2 url=/mulesoft/current/en-us/dataweave/latest/dataweave-formats-ndjson.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: format, ndjson, application/x-ndjson, application/x-ldjson, application/x-ndjson
---

# Newline Delimited JSON (ndjson) Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/x-ndjson`

ID: `ndjson`

DataWeave represents the Newline Delimited JSON format (ndjson) as an array of objects. Each line of
the ndjson format is mapped to one object in the array.

These parser strategies are supported by the ndjson reader:

- In-memory

- Streaming

For details, see [DataWeave Readers](https://docs.mulesoft.com/dataweave/latest/dataweave-formats#dw_readers_writers).

## Examples

The following examples show uses of the ndjson format.

- [Example](#example1)

- [Example](#example2)

### Example

This example shows how DataWeave represents a simple ndjson input.

#### Input

```ndjson
{"name": "Leandro","lastName": "Shokida"}
{"name": "Mariano","lastName": "De Achaval"}
```

#### Source

The DataWeave script transforms the ndjson input to the DataWeave (dw) format and MIME type.

```dataweave
%dw 2.0
output application/dw
---
payload
```

#### Output

The DataWeave (dw) format outputs the ndjson input into an array of comma-separated objects.

```weave
[
    {"name": "Leandro","lastName": "Shokida"},
    {"name": "Mariano","lastName": "De Achaval"}
]
```

### Example

This example shows that the ndjson reader ignores all lines of ndjson data that are invalid if
`skipInvalid=true`.

#### Input

The input to the DataWeave source includes valid and invalid lines of ndjson data. Assume that the
input is from a file `myInput.ndjson`.

myInput.ndjson:

```ndjson
{"name": "Christian"
{"name": "Mariano"}
{"name": "Tomo"
{"name": "Shoki"}
```

#### Source

The DataWeave script inputs the contents of the input file `myInput.ndjson`, applies the
`skipInvalid=true` reader property, and transforms the input to the JSON format and MIME type.

```dataweave
%dw 2.0
var myInput = readUrl('classpath://myInput.ndjson', 'application/x-ndjson, {skipInvalid=true})
output application/json
---
myInput
```

#### Output

The JSON output is an array of the valid objects from the ndjson input.

```weave
[
  {
    "name": "Mariano"
  },
  {
    "name": "Shoki"
  }
]
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>ignoreEmptyLine</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Ignores empty lines.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>skipInvalid</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Skips invalid records and ignores values that aren’t valid in this format.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>'UTF-8'</code></p></td><td><div><div><p>Encoding that the writer uses for output. Defaults to "UTF-8".</p></div></div></td></tr><tr><td><p><code>skipNullOn</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Skips <code>null</code> values. By default, DataWeave does not skip.</p></div><div><ul><li><p><code>arrays</code><br>Ignore and omit <code>null</code> values inside arrays from the JSON output, for example, with <code>output application/x-ndjson skipNullOn="arrays"</code>.</p></li><li><p><code>objects</code><br>Ignore key-value pairs that have <code>null</code> as the value, for example, with <code>output application/x-ndjson skipNullOn="objects"</code>.</p></li><li><p><code>everywhere</code><br>Apply <code>skipNullOn</code> to arrays and objects, for example, <code>output application/x-ndjson skipNullOn="everywhere"</code>.</p></li></ul></div><div><p>Valid values are <code>arrays</code> or <code>objects</code> or <code>everywhere</code>.</p></div></div></td></tr><tr><td><p><code>writeAttributes</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Converts attributes of a key into child key-value pairs of that key. The attribute key name starts with <code>@</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports these MIME types:

- `application/x-ndjson`

- `application/x-ldjson`

<!-- document id=8b3bff868e03fe6322592dec00d9c5d9c64e0fd0df461669786e63adffb4815b url=/mulesoft/current/en-us/dataweave/2.3/dataweave-formats-ndjson.md -->

---
product: DataWeave
version: 2.3
---

# Newline Delimited JSON Format (ndjson)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/x-ndjson`

ID: `ndjson`

DataWeave represents the Newline Delimited JSON format (ndjson) as an array of objects. Each line of
the ndjson format is mapped to one object in the array.

The following parser strategies are supported by the ndjson reader:

- In-memory

- Streaming

For details, see [DataWeave Readers](https://docs.mulesoft.com/dataweave/2.3/dataweave-formats#dw_readers_writers).

## Examples

The following examples show uses of the ndjson format.

- [Example: Transform ndjson to the DataWeave Format (dw)](#example1)

- [Example: Use the `skipInvalid`](#example2)

### Example: Transform ndjson to the DataWeave Format (dw)

This example shows how DataWeave represents simple ndjson input.

#### Input

```ndjson
{"name": "Leandro","lastName": "Shokida"}
{"name": "Mariano","lastName": "De Achaval"}
```

#### Source

The DataWeave script transforms the ndjson input to the DataWeave (dw) format and MIME type.

```ndjson
%dw 2.0
output application/dw
---
payload
```

#### Output

The DataWeave (dw) format outputs the ndjson input into an array of comma-separated objects.

```weave
[
    {"name": "Leandro","lastName": "Shokida"},
    {"name": "Mariano","lastName": "De Achaval"}
]
```

### Example: Use the `skipInvalid`

This example shows that the ndjson reader ignores all lines of ndjson data that are invalid if
`skipInvalid=true`.

#### Input

The input to the DataWeave source includes valid and invalid lines of ndjson data. Assume that the
input is from a file `myInput.ndjson`.

myInput.ndjson:

```ndjson
{"name": "Christian"
{"name": "Mariano"}
{"name": "Tomo"
{"name": "Shoki"}
```

#### Source

The DataWeave script inputs the contents of the input file `myInput.ndjson`, applies the
`skipInvalid=true` reader property, and transforms the input to the JSON format and MIME type.

```dataweave
%dw 2.0
var myInput = readUrl('classpath://myInput.ndjson', 'application/x-ndjson, {skipInvalid=true})
output application/json
---
myInput
```

#### Output

The JSON output is an array of the valid objects from the ndjson input.

```weave
[
  {
    "name": "Mariano"
  },
  {
    "name": "Shoki"
  }
]
```

## Configuration Properties

DataWeave supports the following configuration properties for the Newline Delimited JSON format
(ndjson).

### Reader Properties

The ndjson format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>ignoreEmptyLine</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Ignores any empty line. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>skipInvalid</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Skips data that is not valid ndjson. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

The ndjson format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the writer buffer.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>When set to <code>true</code>, DataWeave generates the output as a data stream, and the script’s execution is deferred until it is consumed. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>'UTF-8'</code></p></td><td><div><div><p>Encoding for the ndjson reader to use.</p></div></div></td></tr><tr><td><p><code>skipNullOn</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Valid values are <code>arrays</code> or <code>objects</code>.</p></div></div></td></tr><tr><td><p><code>writeAttributes</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

The Newline Delimited JSON format (ndjson) supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>application/x-ndjson</code></p></td></tr><tr><td><p><code>application/x-ldjson</code></p></td></tr></tbody></table>

<!-- document id=5b1343d9738fc15601e4ef500ab47bc758c06eaae8b51c49cd43a4934df8d94d url=/mulesoft/current/en-us/dataweave/2.11/dw-tree-functions-nodeexists.md -->

---
product: DataWeave
version: 2.11
---

# nodeExists

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## nodeExists(value: Any, callback: (value: Any, path: Path) -> Boolean): Boolean

Returns `true` if any node in a given tree validates against the specified criteria.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The value to search.</p></td></tr><tr><td><p><code>callback</code></p></td><td><p>The criteria to apply to the input <code>value</code>.</p></td></tr></tbody></table>

### Example

This example checks for each user by name and last name. Notice that you can also reference a
`value` with `$` and the `path` with `$$`.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
var myObject =  {
     user: [{
         name: "mariano",
         lastName: "achaval",
         friends: [
             {
                 name: "julian"
             },
             {
                 name: "tom"
             }
         ]
     },
     {
         name: "leandro",
         lastName: "shokida",
         friends: [
             {
                 name: "peter"
             },
             {
                 name: "robert"
             }
         ]

     }
     ]
 }
output application/json
---
{
    mariano : myObject nodeExists ((value, path) -> path[-1].selector == "name" and value == "mariano"),
    julian : myObject nodeExists ((value, path) -> path[-1].selector == "name" and value == "julian"),
    tom : myObject nodeExists ($$[-1].selector == "name" and $ == "tom"),
    leandro : myObject nodeExists ($$[-1].selector == "name" and $ ==  "leandro"),
    peter : myObject nodeExists ($$[-1].selector == "name" and $ == "peter"),
    wrongField: myObject nodeExists ($$[-1].selector == "wrongField"),
    teo: myObject nodeExists ($$[-1].selector == "name" and $ == "teo")
}
```

#### Output

```Json
{
  "mariano": true,
  "julian": true,
  "tom": true,
  "leandro": true,
  "peter": true,
  "wrongField": false,
  "teo": false
}
```

<!-- document id=4eea971f21864d8189e1859ea985757e8bef52a528f9ba5488a6f707e4b8d1d3 url=/mulesoft/current/en-us/dataweave/2.12/dw-tree-functions-nodeexists.md -->

---
product: DataWeave
version: 2.12
---

# nodeExists

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## nodeExists(value: Any, callback: (value: Any, path: Path) -> Boolean): Boolean

Returns `true` if any node in a given tree validates against the specified criteria.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The value to search.</p></td></tr><tr><td><p><code>callback</code></p></td><td><p>The criteria to apply to the input <code>value</code>.</p></td></tr></tbody></table>

### Example

This example checks for each user by name and last name. Notice that you can also reference a
`value` with `$` and the `path` with `$$`.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
var myObject =  {
     user: [{
         name: "mariano",
         lastName: "achaval",
         friends: [
             {
                 name: "julian"
             },
             {
                 name: "tom"
             }
         ]
     },
     {
         name: "leandro",
         lastName: "shokida",
         friends: [
             {
                 name: "peter"
             },
             {
                 name: "robert"
             }
         ]

     }
     ]
 }
output application/json
---
{
    mariano : myObject nodeExists ((value, path) -> path[-1].selector == "name" and value == "mariano"),
    julian : myObject nodeExists ((value, path) -> path[-1].selector == "name" and value == "julian"),
    tom : myObject nodeExists ($$[-1].selector == "name" and $ == "tom"),
    leandro : myObject nodeExists ($$[-1].selector == "name" and $ ==  "leandro"),
    peter : myObject nodeExists ($$[-1].selector == "name" and $ == "peter"),
    wrongField: myObject nodeExists ($$[-1].selector == "wrongField"),
    teo: myObject nodeExists ($$[-1].selector == "name" and $ == "teo")
}
```

#### Output

```Json
{
  "mariano": true,
  "julian": true,
  "tom": true,
  "leandro": true,
  "peter": true,
  "wrongField": false,
  "teo": false
}
```

<!-- document id=60db0e9bd14a334e3d94fc520aac413aeeda56247de809727a2462cd6777eff1 url=/mulesoft/current/en-us/dataweave/2.3/dw-tree-functions-nodeexists.md -->

---
product: DataWeave
version: 2.3
---

# nodeExists

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## nodeExists(Any, (value: Any, path: Path) -> Boolean): Boolean

Returns `true` if any node in the tree validates against the specified criteria.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The value to search.</p></td></tr><tr><td><p><code>callback</code></p></td><td><p>The criteria.</p></td></tr></tbody></table>

### Example

This example checks for any user with the name `peter`.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
output application/json
---
 {
     user: [{
         name: "mariano",
         lastName: "achaval",
         friends: [
             {
                 name: "julian"
             },
             {
                 name: "tom"
             }
         ]
     },
     {
         name: "leandro",
         lastName: "shokida",
         friends: [
             {
                 name: "peter"
             },
             {
                 name: "robert"
             }
         ]

     }
     ],

 } nodeExists ((value, path) -> path[-1].selector == "name" and value == "peter")
```

#### Output

```Json
true
```

<!-- document id=08ca52fb28cd5eb284c71c2da03409a7b2f9f367ffbbbc20fcab20ce41340bc6 url=/mulesoft/current/en-us/dataweave/2.4/dw-tree-functions-nodeexists.md -->

---
product: DataWeave
version: 2.4
---

# nodeExists

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## nodeExists(value: Any, callback: (value: Any, path: Path) -> Boolean): Boolean

Returns `true` if any node in a given tree validates against the specified criteria.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The value to search.</p></td></tr><tr><td><p><code>callback</code></p></td><td><p>The criteria to apply to the input <code>value</code>.</p></td></tr></tbody></table>

### Example

This example checks for each user by name and last name. Notice that you can also reference a
`value` with `$` and the `path` with `$$`.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
var myObject =  {
     user: [{
         name: "mariano",
         lastName: "achaval",
         friends: [
             {
                 name: "julian"
             },
             {
                 name: "tom"
             }
         ]
     },
     {
         name: "leandro",
         lastName: "shokida",
         friends: [
             {
                 name: "peter"
             },
             {
                 name: "robert"
             }
         ]

     }
     ]
 }
output application/json
---
{
    mariano : myObject nodeExists ((value, path) -> path[-1].selector == "name" and value == "mariano"),
    julian : myObject nodeExists ((value, path) -> path[-1].selector == "name" and value == "julian"),
    tom : myObject nodeExists ($$[-1].selector == "name" and $ == "tom"),
    leandro : myObject nodeExists ($$[-1].selector == "name" and $ ==  "leandro"),
    peter : myObject nodeExists ($$[-1].selector == "name" and $ == "peter"),
    wrongField: myObject nodeExists ($$[-1].selector == "wrongField"),
    teo: myObject nodeExists ($$[-1].selector == "name" and $ == "teo")
}
```

#### Output

```Json
{
  "mariano": true,
  "julian": true,
  "tom": true,
  "leandro": true,
  "peter": true,
  "wrongField": false,
  "teo": false
}
```

<!-- document id=17f29517a437fd95b2f678b95257d862bfaed98d93a4b7bf20792880907c09b3 url=/mulesoft/current/en-us/dataweave/2.6/dw-tree-functions-nodeexists.md -->

---
product: DataWeave
version: 2.6
---

# nodeExists

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## nodeExists(value: Any, callback: (value: Any, path: Path) -> Boolean): Boolean

Returns `true` if any node in a given tree validates against the specified criteria.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The value to search.</p></td></tr><tr><td><p><code>callback</code></p></td><td><p>The criteria to apply to the input <code>value</code>.</p></td></tr></tbody></table>

### Example

This example checks for each user by name and last name. Notice that you can also reference a
`value` with `$` and the `path` with `$$`.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
var myObject =  {
     user: [{
         name: "mariano",
         lastName: "achaval",
         friends: [
             {
                 name: "julian"
             },
             {
                 name: "tom"
             }
         ]
     },
     {
         name: "leandro",
         lastName: "shokida",
         friends: [
             {
                 name: "peter"
             },
             {
                 name: "robert"
             }
         ]

     }
     ]
 }
output application/json
---
{
    mariano : myObject nodeExists ((value, path) -> path[-1].selector == "name" and value == "mariano"),
    julian : myObject nodeExists ((value, path) -> path[-1].selector == "name" and value == "julian"),
    tom : myObject nodeExists ($$[-1].selector == "name" and $ == "tom"),
    leandro : myObject nodeExists ($$[-1].selector == "name" and $ ==  "leandro"),
    peter : myObject nodeExists ($$[-1].selector == "name" and $ == "peter"),
    wrongField: myObject nodeExists ($$[-1].selector == "wrongField"),
    teo: myObject nodeExists ($$[-1].selector == "name" and $ == "teo")
}
```

#### Output

```Json
{
  "mariano": true,
  "julian": true,
  "tom": true,
  "leandro": true,
  "peter": true,
  "wrongField": false,
  "teo": false
}
```

<!-- document id=c3c7c592d87590b20c19c384cd3e51f3a566bdc2b149f1f2db18eb67f11b6f10 url=/mulesoft/current/en-us/dataweave/2.9/dw-tree-functions-nodeexists.md -->

---
product: DataWeave
version: 2.9
---

# nodeExists

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## nodeExists(value: Any, callback: (value: Any, path: Path) -> Boolean): Boolean

Returns `true` if any node in a given tree validates against the specified criteria.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The value to search.</p></td></tr><tr><td><p><code>callback</code></p></td><td><p>The criteria to apply to the input <code>value</code>.</p></td></tr></tbody></table>

### Example

This example checks for each user by name and last name. Notice that you can also reference a
`value` with `$` and the `path` with `$$`.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
var myObject =  {
     user: [{
         name: "mariano",
         lastName: "achaval",
         friends: [
             {
                 name: "julian"
             },
             {
                 name: "tom"
             }
         ]
     },
     {
         name: "leandro",
         lastName: "shokida",
         friends: [
             {
                 name: "peter"
             },
             {
                 name: "robert"
             }
         ]

     }
     ]
 }
output application/json
---
{
    mariano : myObject nodeExists ((value, path) -> path[-1].selector == "name" and value == "mariano"),
    julian : myObject nodeExists ((value, path) -> path[-1].selector == "name" and value == "julian"),
    tom : myObject nodeExists ($$[-1].selector == "name" and $ == "tom"),
    leandro : myObject nodeExists ($$[-1].selector == "name" and $ ==  "leandro"),
    peter : myObject nodeExists ($$[-1].selector == "name" and $ == "peter"),
    wrongField: myObject nodeExists ($$[-1].selector == "wrongField"),
    teo: myObject nodeExists ($$[-1].selector == "name" and $ == "teo")
}
```

#### Output

```Json
{
  "mariano": true,
  "julian": true,
  "tom": true,
  "leandro": true,
  "peter": true,
  "wrongField": false,
  "teo": false
}
```

<!-- document id=a9a87b2ff5c2c03a64e5670566c20a0ad0420447007a1520befada629e6e8551 url=/mulesoft/current/en-us/dataweave/latest/dw-tree-functions-nodeexists.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# nodeExists

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## nodeExists(value: Any, callback: (value: Any, path: Path) -> Boolean): Boolean

Returns `true` if any node in a given tree validates against the specified criteria.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The value to search.</p></td></tr><tr><td><p><code>callback</code></p></td><td><p>The criteria to apply to the input <code>value</code>.</p></td></tr></tbody></table>

### Example

This example checks for each user by name and last name. Notice that you can also reference a
`value` with `$` and the `path` with `$$`.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Tree
var myObject =  {
     user: [{
         name: "mariano",
         lastName: "achaval",
         friends: [
             {
                 name: "julian"
             },
             {
                 name: "tom"
             }
         ]
     },
     {
         name: "leandro",
         lastName: "shokida",
         friends: [
             {
                 name: "peter"
             },
             {
                 name: "robert"
             }
         ]

     }
     ]
 }
output application/json
---
{
    mariano : myObject nodeExists ((value, path) -> path[-1].selector == "name" and value == "mariano"),
    julian : myObject nodeExists ((value, path) -> path[-1].selector == "name" and value == "julian"),
    tom : myObject nodeExists ($$[-1].selector == "name" and $ == "tom"),
    leandro : myObject nodeExists ($$[-1].selector == "name" and $ ==  "leandro"),
    peter : myObject nodeExists ($$[-1].selector == "name" and $ == "peter"),
    wrongField: myObject nodeExists ($$[-1].selector == "wrongField"),
    teo: myObject nodeExists ($$[-1].selector == "name" and $ == "teo")
}
```

#### Output

```Json
{
  "mariano": true,
  "julian": true,
  "tom": true,
  "leandro": true,
  "peter": true,
  "wrongField": false,
  "teo": false
}
```

<!-- document id=d208ab8b1003bf1891abb49fd770caa681400982fde867a8a019dd2b1c63dc85 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-now.md -->

---
product: DataWeave
version: 2.11
---

# now

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## now(): DateTime

Returns a `DateTime` value for the current date and time. DataWeave delegates to Java
`ZonedDateTime.now()`, so the precision of the returned value depends on the underlying JVM and
operating system.

### Example

This example uses `now()` to return the current date and time as a `DateTime` value. It also shows
how to return a date and time in a specific time zone. Java 17 time zones are supported.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
   nowCalled: now(),
   nowCalledSpecificTimeZone: now() >> "America/New_York"
}
```

#### Output

```JSON
{
  "nowCalled": "2019-08-26T13:32:10.64-07:00",
  "nowCalledSpecificTimeZone": "2019-08-26T16:32:10.643-04:00"
}
```

### Example

This example shows uses of the `now()` function with valid selectors. It also shows how to get the
epoch time with `now() as Number`. For additional examples, see
[Date and Time (dw::Core Types)](https://docs.mulesoft.com/dataweave/latest/dataweave-types#dw_type_dates).

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  now: now(),
  epochTime : now() as Number,
  nanoseconds: now().nanoseconds,
  milliseconds: now().milliseconds,
  seconds: now().seconds,
  minutes: now().minutes,
  hour: now().hour,
  day: now().day,
  month: now().month,
  year: now().year,
  quarter: now().quarter,
  dayOfWeek: now().dayOfWeek,
  dayOfYear: now().dayOfYear,
  offsetSeconds: now().offsetSeconds,
  formattedDate: now() as String {format: "y-MM-dd"},
  formattedTime: now() as String {format: "hh:m:s"}
}
```

#### Output

```JSON
{
  "now": "2019-06-18T16:55:46.678-07:00",
  "epochTime": 1560902146,
  "nanoseconds": 678000000,
  "milliseconds": 678,
  "seconds": 46,
  "minutes": 55,
  "hour": 16,
  "day": 18,
  "month": 6,
  "year": 2019,
  "quarter": 2,
  "dayOfWeek": 2,
  "dayOfYear": 169,
  "offsetSeconds": -25200,
  "formattedDate": "2019-06-18",
  "formattedTime": "04:55:46"
}
```

<!-- document id=450ed68ba6ccc3215f13b55af4667973ed23d66d644c26371609b7a4e7ea91ae url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-now.md -->

---
product: DataWeave
version: 2.12
---

# now

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## now(): DateTime

Returns a `DateTime` value for the current date and time. DataWeave delegates to Java
`ZonedDateTime.now()`, so the precision of the returned value depends on the underlying JVM and
operating system.

### Example

This example uses `now()` to return the current date and time as a `DateTime` value. It also shows
how to return a date and time in a specific time zone. Java 17 time zones are supported.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
   nowCalled: now(),
   nowCalledSpecificTimeZone: now() >> "America/New_York"
}
```

#### Output

```JSON
{
  "nowCalled": "2019-08-26T13:32:10.64-07:00",
  "nowCalledSpecificTimeZone": "2019-08-26T16:32:10.643-04:00"
}
```

### Example

This example shows uses of the `now()` function with valid selectors. It also shows how to get the
epoch time with `now() as Number`. For additional examples, see
[Date and Time (dw::Core Types)](https://docs.mulesoft.com/dataweave/latest/dataweave-types#dw_type_dates).

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  now: now(),
  epochTime : now() as Number,
  nanoseconds: now().nanoseconds,
  milliseconds: now().milliseconds,
  seconds: now().seconds,
  minutes: now().minutes,
  hour: now().hour,
  day: now().day,
  month: now().month,
  year: now().year,
  quarter: now().quarter,
  dayOfWeek: now().dayOfWeek,
  dayOfYear: now().dayOfYear,
  offsetSeconds: now().offsetSeconds,
  formattedDate: now() as String {format: "y-MM-dd"},
  formattedTime: now() as String {format: "hh:m:s"}
}
```

#### Output

```JSON
{
  "now": "2019-06-18T16:55:46.678-07:00",
  "epochTime": 1560902146,
  "nanoseconds": 678000000,
  "milliseconds": 678,
  "seconds": 46,
  "minutes": 55,
  "hour": 16,
  "day": 18,
  "month": 6,
  "year": 2019,
  "quarter": 2,
  "dayOfWeek": 2,
  "dayOfYear": 169,
  "offsetSeconds": -25200,
  "formattedDate": "2019-06-18",
  "formattedTime": "04:55:46"
}
```

<!-- document id=b8e1350bb3319f9169e5d057849c27ed8e2476d8a226155b54ec0da5af11dc4f url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-now.md -->

---
product: DataWeave
version: 2.3
---

# now

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## now(): DateTime

Returns a `DateTime` value for the current date and time.

### Example

This example uses `now()` to return the current date and time as a `DateTime` value. It also shows
how to return a date and time in a specific time zone. Java 8 time zones are supported.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
   nowCalled: now(),
   nowCalledSpecificTimeZone: now() >> "America/New_York"
}
```

#### Output

```JSON
{
  "nowCalled": "2019-08-26T13:32:10.64-07:00",
  "nowCalledSpecificTimeZone": "2019-08-26T16:32:10.643-04:00"
}
```

### Example

This example shows uses of the `now()` function with valid selectors. It also shows how to get the
epoch time with `now() as Number`. For additional examples, see
[Date and Time (dw::Core Types)](https://docs.mulesoft.com/dataweave/2.3/dataweave-types#dw_type_dates).

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  now: now(),
  epochTime : now() as Number,
  nanoseconds: now().nanoseconds,
  milliseconds: now().milliseconds,
  seconds: now().seconds,
  minutes: now().minutes,
  hour: now().hour,
  day: now().day,
  month: now().month,
  year: now().year,
  quarter: now().quarter,
  dayOfWeek: now().dayOfWeek,
  dayOfYear: now().dayOfYear,
  offsetSeconds: now().offsetSeconds,
  formattedDate: now() as String {format: "y-MM-dd"},
  formattedTime: now() as String {format: "hh:m:s"}
}
```

#### Output

```JSON
{
  "now": "2019-06-18T16:55:46.678-07:00",
  "epochTime": 1560902146,
  "nanoseconds": 678000000,
  "milliseconds": 678,
  "seconds": 46,
  "minutes": 55,
  "hour": 16,
  "day": 18,
  "month": 6,
  "year": 2019,
  "quarter": 2,
  "dayOfWeek": 2,
  "dayOfYear": 169,
  "offsetSeconds": -25200,
  "formattedDate": "2019-06-18",
  "formattedTime": "04:55:46"
}
```

<!-- document id=fac529bac23c4f7f4b02a512db791bb8a23278abf73423474050d045e6857b22 url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-now.md -->

---
product: DataWeave
version: 2.4
---

# now

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## now(): DateTime

Returns a `DateTime` value for the current date and time.

### Example

This example uses `now()` to return the current date and time as a `DateTime` value. It also shows
how to return a date and time in a specific time zone. Java 8 time zones are supported.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
   nowCalled: now(),
   nowCalledSpecificTimeZone: now() >> "America/New_York"
}
```

#### Output

```JSON
{
  "nowCalled": "2019-08-26T13:32:10.64-07:00",
  "nowCalledSpecificTimeZone": "2019-08-26T16:32:10.643-04:00"
}
```

### Example

This example shows uses of the `now()` function with valid selectors. It also shows how to get the
epoch time with `now() as Number`. For additional examples, see
[Date and Time (dw::Core Types)](https://docs.mulesoft.com/dataweave/latest/dataweave-types#dw_type_dates).

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  now: now(),
  epochTime : now() as Number,
  nanoseconds: now().nanoseconds,
  milliseconds: now().milliseconds,
  seconds: now().seconds,
  minutes: now().minutes,
  hour: now().hour,
  day: now().day,
  month: now().month,
  year: now().year,
  quarter: now().quarter,
  dayOfWeek: now().dayOfWeek,
  dayOfYear: now().dayOfYear,
  offsetSeconds: now().offsetSeconds,
  formattedDate: now() as String {format: "y-MM-dd"},
  formattedTime: now() as String {format: "hh:m:s"}
}
```

#### Output

```JSON
{
  "now": "2019-06-18T16:55:46.678-07:00",
  "epochTime": 1560902146,
  "nanoseconds": 678000000,
  "milliseconds": 678,
  "seconds": 46,
  "minutes": 55,
  "hour": 16,
  "day": 18,
  "month": 6,
  "year": 2019,
  "quarter": 2,
  "dayOfWeek": 2,
  "dayOfYear": 169,
  "offsetSeconds": -25200,
  "formattedDate": "2019-06-18",
  "formattedTime": "04:55:46"
}
```

<!-- document id=7601f9df0feba2de6bb66e16495153d55ed0720b86cdb9cc38d8ac7bbeb9ab5c url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-now.md -->

---
product: DataWeave
version: 2.6
---

# now

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## now(): DateTime

Returns a `DateTime` value for the current date and time.

### Example

This example uses `now()` to return the current date and time as a `DateTime` value. It also shows
how to return a date and time in a specific time zone. Java 8 time zones are supported.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
   nowCalled: now(),
   nowCalledSpecificTimeZone: now() >> "America/New_York"
}
```

#### Output

```JSON
{
  "nowCalled": "2019-08-26T13:32:10.64-07:00",
  "nowCalledSpecificTimeZone": "2019-08-26T16:32:10.643-04:00"
}
```

### Example

This example shows uses of the `now()` function with valid selectors. It also shows how to get the
epoch time with `now() as Number`. For additional examples, see
[Date and Time (dw::Core Types)](https://docs.mulesoft.com/dataweave/latest/dataweave-types#dw_type_dates).

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  now: now(),
  epochTime : now() as Number,
  nanoseconds: now().nanoseconds,
  milliseconds: now().milliseconds,
  seconds: now().seconds,
  minutes: now().minutes,
  hour: now().hour,
  day: now().day,
  month: now().month,
  year: now().year,
  quarter: now().quarter,
  dayOfWeek: now().dayOfWeek,
  dayOfYear: now().dayOfYear,
  offsetSeconds: now().offsetSeconds,
  formattedDate: now() as String {format: "y-MM-dd"},
  formattedTime: now() as String {format: "hh:m:s"}
}
```

#### Output

```JSON
{
  "now": "2019-06-18T16:55:46.678-07:00",
  "epochTime": 1560902146,
  "nanoseconds": 678000000,
  "milliseconds": 678,
  "seconds": 46,
  "minutes": 55,
  "hour": 16,
  "day": 18,
  "month": 6,
  "year": 2019,
  "quarter": 2,
  "dayOfWeek": 2,
  "dayOfYear": 169,
  "offsetSeconds": -25200,
  "formattedDate": "2019-06-18",
  "formattedTime": "04:55:46"
}
```

<!-- document id=dfa7cfe82e6dcddb2f027cb58e7b165dc14e52b4fcc6df217858183b319b1759 url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-now.md -->

---
product: DataWeave
version: 2.9
---

# now

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## now(): DateTime

Returns a `DateTime` value for the current date and time. DataWeave delegates to Java
`ZonedDateTime.now()`, so the precision of the returned value depends on the underlying JVM and
operating system.

### Example

This example uses `now()` to return the current date and time as a `DateTime` value. It also shows
how to return a date and time in a specific time zone. Java 17 time zones are supported.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
   nowCalled: now(),
   nowCalledSpecificTimeZone: now() >> "America/New_York"
}
```

#### Output

```JSON
{
  "nowCalled": "2019-08-26T13:32:10.64-07:00",
  "nowCalledSpecificTimeZone": "2019-08-26T16:32:10.643-04:00"
}
```

### Example

This example shows uses of the `now()` function with valid selectors. It also shows how to get the
epoch time with `now() as Number`. For additional examples, see
[Date and Time (dw::Core Types)](https://docs.mulesoft.com/dataweave/latest/dataweave-types#dw_type_dates).

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  now: now(),
  epochTime : now() as Number,
  nanoseconds: now().nanoseconds,
  milliseconds: now().milliseconds,
  seconds: now().seconds,
  minutes: now().minutes,
  hour: now().hour,
  day: now().day,
  month: now().month,
  year: now().year,
  quarter: now().quarter,
  dayOfWeek: now().dayOfWeek,
  dayOfYear: now().dayOfYear,
  offsetSeconds: now().offsetSeconds,
  formattedDate: now() as String {format: "y-MM-dd"},
  formattedTime: now() as String {format: "hh:m:s"}
}
```

#### Output

```JSON
{
  "now": "2019-06-18T16:55:46.678-07:00",
  "epochTime": 1560902146,
  "nanoseconds": 678000000,
  "milliseconds": 678,
  "seconds": 46,
  "minutes": 55,
  "hour": 16,
  "day": 18,
  "month": 6,
  "year": 2019,
  "quarter": 2,
  "dayOfWeek": 2,
  "dayOfYear": 169,
  "offsetSeconds": -25200,
  "formattedDate": "2019-06-18",
  "formattedTime": "04:55:46"
}
```

<!-- document id=33d113e884f0cfb69f7c2dc156b0258c9c74af17987ea37d720a22e4bd3763dc url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-now.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# now

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## now(): DateTime

Returns a `DateTime` value for the current date and time. DataWeave delegates to Java
`ZonedDateTime.now()`, so the precision of the returned value depends on the underlying JVM and
operating system.

### Example

This example uses `now()` to return the current date and time as a `DateTime` value. It also shows
how to return a date and time in a specific time zone. Java 17 time zones are supported.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
   nowCalled: now(),
   nowCalledSpecificTimeZone: now() >> "America/New_York"
}
```

#### Output

```JSON
{
  "nowCalled": "2019-08-26T13:32:10.64-07:00",
  "nowCalledSpecificTimeZone": "2019-08-26T16:32:10.643-04:00"
}
```

### Example

This example shows uses of the `now()` function with valid selectors. It also shows how to get the
epoch time with `now() as Number`. For additional examples, see
[Date and Time (dw::Core Types)](https://docs.mulesoft.com/dataweave/latest/dataweave-types#dw_type_dates).

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  now: now(),
  epochTime : now() as Number,
  nanoseconds: now().nanoseconds,
  milliseconds: now().milliseconds,
  seconds: now().seconds,
  minutes: now().minutes,
  hour: now().hour,
  day: now().day,
  month: now().month,
  year: now().year,
  quarter: now().quarter,
  dayOfWeek: now().dayOfWeek,
  dayOfYear: now().dayOfYear,
  offsetSeconds: now().offsetSeconds,
  formattedDate: now() as String {format: "y-MM-dd"},
  formattedTime: now() as String {format: "hh:m:s"}
}
```

#### Output

```JSON
{
  "now": "2019-06-18T16:55:46.678-07:00",
  "epochTime": 1560902146,
  "nanoseconds": 678000000,
  "milliseconds": 678,
  "seconds": 46,
  "minutes": 55,
  "hour": 16,
  "day": 18,
  "month": 6,
  "year": 2019,
  "quarter": 2,
  "dayOfWeek": 2,
  "dayOfYear": 169,
  "offsetSeconds": -25200,
  "formattedDate": "2019-06-18",
  "formattedTime": "04:55:46"
}
```

<!-- document id=76a8e81db2ec10f126dbe5116aa94b1a58be9304ced9d210f9e3416dda80680e url=/mulesoft/current/en-us/dataweave/2.11/dw-numbers.md -->

---
product: DataWeave
version: 2.11
---

# Numbers (dw::core::Numbers)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions for working with numbers.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Numbers` to the header of your DataWeave script.

_Introduced in DataWeave version 2.2.0._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-numbers-functions-frombinary">fromBinary</a></p></td><td><p>Transforms from a binary number into a decimal number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-numbers-functions-fromhex">fromHex</a></p></td><td><p>Transforms a hexadecimal number into decimal number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-numbers-functions-fromradixnumber">fromRadixNumber</a></p></td><td><p>Transforms a number in the specified radix into decimal number</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-numbers-functions-tobinary">toBinary</a></p></td><td><p>Transforms a decimal number into a binary number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-numbers-functions-tohex">toHex</a></p></td><td><p>Transforms a decimal number into a hexadecimal number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-numbers-functions-toradixnumber">toRadixNumber</a></p></td><td><p>Transforms a decimal number into a number string in other radix.</p></td></tr></tbody></table>

<!-- document id=33684145518edf4824e2aac614d915a12ade47f778f90ad3f3fa95bf7e6da1b2 url=/mulesoft/current/en-us/dataweave/2.12/dw-numbers.md -->

---
product: DataWeave
version: 2.12
---

# Numbers (dw::core::Numbers)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions for working with numbers.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Numbers` to the header of your DataWeave script.

_Introduced in DataWeave version 2.2.0._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-numbers-functions-frombinary">fromBinary</a></p></td><td><p>Transforms from a binary number into a decimal number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-numbers-functions-fromhex">fromHex</a></p></td><td><p>Transforms a hexadecimal number into decimal number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-numbers-functions-fromradixnumber">fromRadixNumber</a></p></td><td><p>Transforms a number in the specified radix into decimal number</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-numbers-functions-tobinary">toBinary</a></p></td><td><p>Transforms a decimal number into a binary number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-numbers-functions-tohex">toHex</a></p></td><td><p>Transforms a decimal number into a hexadecimal number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-numbers-functions-toradixnumber">toRadixNumber</a></p></td><td><p>Transforms a decimal number into a number string in other radix.</p></td></tr></tbody></table>

<!-- document id=96326fa25ba0eefff4ab0ff1b18588e4bc4dc3eaf1407033afd0d0543d627cb5 url=/mulesoft/current/en-us/dataweave/2.3/dw-numbers.md -->

---
product: DataWeave
version: 2.3
---

# Numbers (dw::core::Numbers)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions to work with Numbers.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Numbers` to the header of your DataWeave script.

_Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-numbers-functions-frombinary">fromBinary</a></p></td><td><p>Transforms from a binary number into a decimal number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-numbers-functions-fromhex">fromHex</a></p></td><td><p>Transforms a hexadecimal number into decimal number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-numbers-functions-fromradixnumber">fromRadixNumber</a></p></td><td><p>Transforms a number in the specified radix into decimal number</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-numbers-functions-tobinary">toBinary</a></p></td><td><p>Transforms a decimal number into a binary number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-numbers-functions-tohex">toHex</a></p></td><td><p>Transforms a decimal number into a hexadecimal number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-numbers-functions-toradixnumber">toRadixNumber</a></p></td><td><p>Transforms a decimal number into a number string in other radix.</p></td></tr></tbody></table>

<!-- document id=64fe41d2e05206e3ddfd731f918293f62b4b575c04603a266093be82e2bb76de url=/mulesoft/current/en-us/dataweave/2.4/dw-numbers.md -->

---
product: DataWeave
version: 2.4
---

# Numbers (dw::core::Numbers)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions for working with numbers.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Numbers` to the header of your DataWeave script.

_Introduced in DataWeave version 2.2.0._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-numbers-functions-frombinary">fromBinary</a></p></td><td><p>Transforms from a binary number into a decimal number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-numbers-functions-fromhex">fromHex</a></p></td><td><p>Transforms a hexadecimal number into decimal number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-numbers-functions-fromradixnumber">fromRadixNumber</a></p></td><td><p>Transforms a number in the specified radix into decimal number</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-numbers-functions-tobinary">toBinary</a></p></td><td><p>Transforms a decimal number into a binary number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-numbers-functions-tohex">toHex</a></p></td><td><p>Transforms a decimal number into a hexadecimal number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-numbers-functions-toradixnumber">toRadixNumber</a></p></td><td><p>Transforms a decimal number into a number string in other radix.</p></td></tr></tbody></table>

<!-- document id=a6e532ff07cfb7624ad4d6841befcb2a7fdf3c5f2072afda8140d74c6903d373 url=/mulesoft/current/en-us/dataweave/2.6/dw-numbers.md -->

---
product: DataWeave
version: 2.6
---

# Numbers (dw::core::Numbers)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions for working with numbers.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Numbers` to the header of your DataWeave script.

_Introduced in DataWeave version 2.2.0._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-numbers-functions-frombinary">fromBinary</a></p></td><td><p>Transforms from a binary number into a decimal number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-numbers-functions-fromhex">fromHex</a></p></td><td><p>Transforms a hexadecimal number into decimal number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-numbers-functions-fromradixnumber">fromRadixNumber</a></p></td><td><p>Transforms a number in the specified radix into decimal number</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-numbers-functions-tobinary">toBinary</a></p></td><td><p>Transforms a decimal number into a binary number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-numbers-functions-tohex">toHex</a></p></td><td><p>Transforms a decimal number into a hexadecimal number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-numbers-functions-toradixnumber">toRadixNumber</a></p></td><td><p>Transforms a decimal number into a number string in other radix.</p></td></tr></tbody></table>

<!-- document id=bf9e15f410a727a45ac7e1f6dce9c47db2c10fa3c51cf85b7e732b7f2124b2e0 url=/mulesoft/current/en-us/dataweave/2.9/dw-numbers.md -->

---
product: DataWeave
version: 2.9
---

# Numbers (dw::core::Numbers)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions for working with numbers.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Numbers` to the header of your DataWeave script.

_Introduced in DataWeave version 2.2.0._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-numbers-functions-frombinary">fromBinary</a></p></td><td><p>Transforms from a binary number into a decimal number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-numbers-functions-fromhex">fromHex</a></p></td><td><p>Transforms a hexadecimal number into decimal number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-numbers-functions-fromradixnumber">fromRadixNumber</a></p></td><td><p>Transforms a number in the specified radix into decimal number</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-numbers-functions-tobinary">toBinary</a></p></td><td><p>Transforms a decimal number into a binary number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-numbers-functions-tohex">toHex</a></p></td><td><p>Transforms a decimal number into a hexadecimal number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-numbers-functions-toradixnumber">toRadixNumber</a></p></td><td><p>Transforms a decimal number into a number string in other radix.</p></td></tr></tbody></table>

<!-- document id=ea8b26573a6fcb82044cdad8ed7f19478c013f5300f719124d3028253ca7d849 url=/mulesoft/current/en-us/dataweave/latest/dw-numbers.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Numbers (dw::core::Numbers)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions for working with numbers.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Numbers` to the header of your DataWeave script.

_Introduced in DataWeave version 2.2.0._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-numbers-functions-frombinary">fromBinary</a></p></td><td><p>Transforms from a binary number into a decimal number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-numbers-functions-fromhex">fromHex</a></p></td><td><p>Transforms a hexadecimal number into decimal number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-numbers-functions-fromradixnumber">fromRadixNumber</a></p></td><td><p>Transforms a number in the specified radix into decimal number</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-numbers-functions-tobinary">toBinary</a></p></td><td><p>Transforms a decimal number into a binary number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-numbers-functions-tohex">toHex</a></p></td><td><p>Transforms a decimal number into a hexadecimal number.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-numbers-functions-toradixnumber">toRadixNumber</a></p></td><td><p>Transforms a decimal number into a number string in other radix.</p></td></tr></tbody></table>

<!-- document id=05d05718e15b884cd81d55da17518cc8f155174dbdf12394f053e31568bee9bd url=/mulesoft/current/en-us/dataweave/2.11/dw-types-functions-objectfields.md -->

---
product: DataWeave
version: 2.11
---

# objectFields

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## objectFields(t: Type): Array<Field>

Returns the array of fields from the given Object type. This function fails if the type is not an
Object type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The function type.</p></td></tr></tbody></table>

### Example

This example shows how `objectFields` behaves with different inputs.

#### Source

```DataWeave
import * from dw::core::Types
ns ns0 http://acme.com
type ADictionary = {_ : String}
type ASchema = {ns0#name @(ns0#foo: String): {}}
type AUser = {name @(foo?: String,l: Number)?: String, lastName*: Number}
---
{
    a: objectFields(ADictionary),
    b: objectFields(ASchema),
    c: objectFields(Object),
    d: objectFields(AUser)
}
```

#### Output

```Json
{
  "a": [
    {
      "key": {
        "name": {
          "localName": "_",
          "namespace": null
        },
        "attributes": [

        ]
      },
      "required": true,
      "repeated": false,
      "value": "String"
    }
  ],
  "b": [
    {
      "key": {
        "name": {
          "localName": "name",
          "namespace": "http://acme.com"
        },
        "attributes": [
          {
            "name": {
              "localName": "foo",
              "namespace": "http://acme.com"
            },
            "value": "String",
            "required": true
          }
        ]
      },
      "required": true,
      "repeated": false,
      "value": "Object"
    }
  ],
  "c": [

  ],
  "d": [
    {
      "key": {
        "name": {
          "localName": "name",
          "namespace": null
        },
        "attributes": [
          {
            "name": {
              "localName": "foo",
              "namespace": null
            },
            "value": "String",
            "required": false
          },
          {
            "name": {
              "localName": "l",
              "namespace": null
            },
            "value": "Number",
            "required": true
          }
        ]
      },
      "required": false,
      "repeated": false,
      "value": "String"
    },
    {
      "key": {
        "name": {
          "localName": "lastName",
          "namespace": null
        },
        "attributes": [

        ]
      },
      "required": true,
      "repeated": true,
      "value": "Number"
    }
  ]
}
```

<!-- document id=ac272763c710136731cbf4da2b6e7d97996d6d4680df7c2e48a21a7d4572c720 url=/mulesoft/current/en-us/dataweave/2.12/dw-types-functions-objectfields.md -->

---
product: DataWeave
version: 2.12
---

# objectFields

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## objectFields(t: Type): Array<Field>

Returns the array of fields from the given Object type. This function fails if the type is not an
Object type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The function type.</p></td></tr></tbody></table>

### Example

This example shows how `objectFields` behaves with different inputs.

#### Source

```DataWeave
import * from dw::core::Types
ns ns0 http://acme.com
type ADictionary = {_ : String}
type ASchema = {ns0#name @(ns0#foo: String): {}}
type AUser = {name @(foo?: String,l: Number)?: String, lastName*: Number}
---
{
    a: objectFields(ADictionary),
    b: objectFields(ASchema),
    c: objectFields(Object),
    d: objectFields(AUser)
}
```

#### Output

```Json
{
  "a": [
    {
      "key": {
        "name": {
          "localName": "_",
          "namespace": null
        },
        "attributes": [

        ]
      },
      "required": true,
      "repeated": false,
      "value": "String"
    }
  ],
  "b": [
    {
      "key": {
        "name": {
          "localName": "name",
          "namespace": "http://acme.com"
        },
        "attributes": [
          {
            "name": {
              "localName": "foo",
              "namespace": "http://acme.com"
            },
            "value": "String",
            "required": true
          }
        ]
      },
      "required": true,
      "repeated": false,
      "value": "Object"
    }
  ],
  "c": [

  ],
  "d": [
    {
      "key": {
        "name": {
          "localName": "name",
          "namespace": null
        },
        "attributes": [
          {
            "name": {
              "localName": "foo",
              "namespace": null
            },
            "value": "String",
            "required": false
          },
          {
            "name": {
              "localName": "l",
              "namespace": null
            },
            "value": "Number",
            "required": true
          }
        ]
      },
      "required": false,
      "repeated": false,
      "value": "String"
    },
    {
      "key": {
        "name": {
          "localName": "lastName",
          "namespace": null
        },
        "attributes": [

        ]
      },
      "required": true,
      "repeated": true,
      "value": "Number"
    }
  ]
}
```

<!-- document id=74e8a92ac645c9d77e854e3d32231b43c09e58263070283e7736a38c3a7b3d73 url=/mulesoft/current/en-us/dataweave/2.3/dw-types-functions-objectfields.md -->

---
product: DataWeave
version: 2.3
---

# objectFields

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## objectFields(Type): Array<Field>

Returns the array of fields from the given Object type. This function fails if the type is not an
Object type.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>t</p></td><td><p>The function type.</p></td></tr></tbody></table>

### Example

This example shows how `objectFields` behaves with different inputs.

#### Source

```DataWeave
import * from dw::core::Types
ns ns0 http://acme.com
type ADictionary = {_ : String}
type ASchema = {ns0#name @(ns0#foo: String): {}}
type AUser = {name @(foo?: String,l: Number)?: String, lastName*: Number}
---
{
    a: objectFields(ADictionary),
    b: objectFields(ASchema),
    c: objectFields(Object),
    d: objectFields(AUser)
}
```

#### Output

```Json
{
  "a": [
    {
      "key": {
        "name": {
          "localName": "_",
          "namespace": null
        },
        "attributes": [

        ]
      },
      "required": true,
      "repeated": false,
      "value": "String"
    }
  ],
  "b": [
    {
      "key": {
        "name": {
          "localName": "name",
          "namespace": "http://acme.com"
        },
        "attributes": [
          {
            "name": {
              "localName": "foo",
              "namespace": "http://acme.com"
            },
            "value": "String",
            "required": true
          }
        ]
      },
      "required": true,
      "repeated": false,
      "value": "Object"
    }
  ],
  "c": [

  ],
  "d": [
    {
      "key": {
        "name": {
          "localName": "name",
          "namespace": null
        },
        "attributes": [
          {
            "name": {
              "localName": "foo",
              "namespace": null
            },
            "value": "String",
            "required": false
          },
          {
            "name": {
              "localName": "l",
              "namespace": null
            },
            "value": "Number",
            "required": true
          }
        ]
      },
      "required": false,
      "repeated": false,
      "value": "String"
    },
    {
      "key": {
        "name": {
          "localName": "lastName",
          "namespace": null
        },
        "attributes": [

        ]
      },
      "required": true,
      "repeated": true,
      "value": "Number"
    }
  ]
}
```

<!-- document id=ecb6e57b60722aab4da2f235c63d0b6c4531eb022a4083782902531e1c427aab url=/mulesoft/current/en-us/dataweave/2.4/dw-types-functions-objectfields.md -->

---
product: DataWeave
version: 2.4
---

# objectFields

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## objectFields(t: Type): Array<Field>

Returns the array of fields from the given Object type. This function fails if the type is not an
Object type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The function type.</p></td></tr></tbody></table>

### Example

This example shows how `objectFields` behaves with different inputs.

#### Source

```DataWeave
import * from dw::core::Types
ns ns0 http://acme.com
type ADictionary = {_ : String}
type ASchema = {ns0#name @(ns0#foo: String): {}}
type AUser = {name @(foo?: String,l: Number)?: String, lastName*: Number}
---
{
    a: objectFields(ADictionary),
    b: objectFields(ASchema),
    c: objectFields(Object),
    d: objectFields(AUser)
}
```

#### Output

```Json
{
  "a": [
    {
      "key": {
        "name": {
          "localName": "_",
          "namespace": null
        },
        "attributes": [

        ]
      },
      "required": true,
      "repeated": false,
      "value": "String"
    }
  ],
  "b": [
    {
      "key": {
        "name": {
          "localName": "name",
          "namespace": "http://acme.com"
        },
        "attributes": [
          {
            "name": {
              "localName": "foo",
              "namespace": "http://acme.com"
            },
            "value": "String",
            "required": true
          }
        ]
      },
      "required": true,
      "repeated": false,
      "value": "Object"
    }
  ],
  "c": [

  ],
  "d": [
    {
      "key": {
        "name": {
          "localName": "name",
          "namespace": null
        },
        "attributes": [
          {
            "name": {
              "localName": "foo",
              "namespace": null
            },
            "value": "String",
            "required": false
          },
          {
            "name": {
              "localName": "l",
              "namespace": null
            },
            "value": "Number",
            "required": true
          }
        ]
      },
      "required": false,
      "repeated": false,
      "value": "String"
    },
    {
      "key": {
        "name": {
          "localName": "lastName",
          "namespace": null
        },
        "attributes": [

        ]
      },
      "required": true,
      "repeated": true,
      "value": "Number"
    }
  ]
}
```

<!-- document id=d20f80c6fe68b5577b5cbbb149436a13230af6f04d6c12c675520630f82f0672 url=/mulesoft/current/en-us/dataweave/2.6/dw-types-functions-objectfields.md -->

---
product: DataWeave
version: 2.6
---

# objectFields

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## objectFields(t: Type): Array<Field>

Returns the array of fields from the given Object type. This function fails if the type is not an
Object type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The function type.</p></td></tr></tbody></table>

### Example

This example shows how `objectFields` behaves with different inputs.

#### Source

```DataWeave
import * from dw::core::Types
ns ns0 http://acme.com
type ADictionary = {_ : String}
type ASchema = {ns0#name @(ns0#foo: String): {}}
type AUser = {name @(foo?: String,l: Number)?: String, lastName*: Number}
---
{
    a: objectFields(ADictionary),
    b: objectFields(ASchema),
    c: objectFields(Object),
    d: objectFields(AUser)
}
```

#### Output

```Json
{
  "a": [
    {
      "key": {
        "name": {
          "localName": "_",
          "namespace": null
        },
        "attributes": [

        ]
      },
      "required": true,
      "repeated": false,
      "value": "String"
    }
  ],
  "b": [
    {
      "key": {
        "name": {
          "localName": "name",
          "namespace": "http://acme.com"
        },
        "attributes": [
          {
            "name": {
              "localName": "foo",
              "namespace": "http://acme.com"
            },
            "value": "String",
            "required": true
          }
        ]
      },
      "required": true,
      "repeated": false,
      "value": "Object"
    }
  ],
  "c": [

  ],
  "d": [
    {
      "key": {
        "name": {
          "localName": "name",
          "namespace": null
        },
        "attributes": [
          {
            "name": {
              "localName": "foo",
              "namespace": null
            },
            "value": "String",
            "required": false
          },
          {
            "name": {
              "localName": "l",
              "namespace": null
            },
            "value": "Number",
            "required": true
          }
        ]
      },
      "required": false,
      "repeated": false,
      "value": "String"
    },
    {
      "key": {
        "name": {
          "localName": "lastName",
          "namespace": null
        },
        "attributes": [

        ]
      },
      "required": true,
      "repeated": true,
      "value": "Number"
    }
  ]
}
```

<!-- document id=03e1d134c34563191ee67677587eed154d953701d977d881a4dbc397821a6a7b url=/mulesoft/current/en-us/dataweave/2.9/dw-types-functions-objectfields.md -->

---
product: DataWeave
version: 2.9
---

# objectFields

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## objectFields(t: Type): Array<Field>

Returns the array of fields from the given Object type. This function fails if the type is not an
Object type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The function type.</p></td></tr></tbody></table>

### Example

This example shows how `objectFields` behaves with different inputs.

#### Source

```DataWeave
import * from dw::core::Types
ns ns0 http://acme.com
type ADictionary = {_ : String}
type ASchema = {ns0#name @(ns0#foo: String): {}}
type AUser = {name @(foo?: String,l: Number)?: String, lastName*: Number}
---
{
    a: objectFields(ADictionary),
    b: objectFields(ASchema),
    c: objectFields(Object),
    d: objectFields(AUser)
}
```

#### Output

```Json
{
  "a": [
    {
      "key": {
        "name": {
          "localName": "_",
          "namespace": null
        },
        "attributes": [

        ]
      },
      "required": true,
      "repeated": false,
      "value": "String"
    }
  ],
  "b": [
    {
      "key": {
        "name": {
          "localName": "name",
          "namespace": "http://acme.com"
        },
        "attributes": [
          {
            "name": {
              "localName": "foo",
              "namespace": "http://acme.com"
            },
            "value": "String",
            "required": true
          }
        ]
      },
      "required": true,
      "repeated": false,
      "value": "Object"
    }
  ],
  "c": [

  ],
  "d": [
    {
      "key": {
        "name": {
          "localName": "name",
          "namespace": null
        },
        "attributes": [
          {
            "name": {
              "localName": "foo",
              "namespace": null
            },
            "value": "String",
            "required": false
          },
          {
            "name": {
              "localName": "l",
              "namespace": null
            },
            "value": "Number",
            "required": true
          }
        ]
      },
      "required": false,
      "repeated": false,
      "value": "String"
    },
    {
      "key": {
        "name": {
          "localName": "lastName",
          "namespace": null
        },
        "attributes": [

        ]
      },
      "required": true,
      "repeated": true,
      "value": "Number"
    }
  ]
}
```

<!-- document id=4c321b39f9f080a072962847fffeaf508cc56da545ffe7945244984bb61463f9 url=/mulesoft/current/en-us/dataweave/latest/dw-types-functions-objectfields.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# objectFields

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## objectFields(t: Type): Array<Field>

Returns the array of fields from the given Object type. This function fails if the type is not an
Object type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The function type.</p></td></tr></tbody></table>

### Example

This example shows how `objectFields` behaves with different inputs.

#### Source

```DataWeave
import * from dw::core::Types
ns ns0 http://acme.com
type ADictionary = {_ : String}
type ASchema = {ns0#name @(ns0#foo: String): {}}
type AUser = {name @(foo?: String,l: Number)?: String, lastName*: Number}
---
{
    a: objectFields(ADictionary),
    b: objectFields(ASchema),
    c: objectFields(Object),
    d: objectFields(AUser)
}
```

#### Output

```Json
{
  "a": [
    {
      "key": {
        "name": {
          "localName": "_",
          "namespace": null
        },
        "attributes": [

        ]
      },
      "required": true,
      "repeated": false,
      "value": "String"
    }
  ],
  "b": [
    {
      "key": {
        "name": {
          "localName": "name",
          "namespace": "http://acme.com"
        },
        "attributes": [
          {
            "name": {
              "localName": "foo",
              "namespace": "http://acme.com"
            },
            "value": "String",
            "required": true
          }
        ]
      },
      "required": true,
      "repeated": false,
      "value": "Object"
    }
  ],
  "c": [

  ],
  "d": [
    {
      "key": {
        "name": {
          "localName": "name",
          "namespace": null
        },
        "attributes": [
          {
            "name": {
              "localName": "foo",
              "namespace": null
            },
            "value": "String",
            "required": false
          },
          {
            "name": {
              "localName": "l",
              "namespace": null
            },
            "value": "Number",
            "required": true
          }
        ]
      },
      "required": false,
      "repeated": false,
      "value": "String"
    },
    {
      "key": {
        "name": {
          "localName": "lastName",
          "namespace": null
        },
        "attributes": [

        ]
      },
      "required": true,
      "repeated": true,
      "value": "Number"
    }
  ]
}
```

<!-- document id=f367b341716c68c93d1a0668ad770383372827e365135e48055716dda1215df1 url=/mulesoft/current/en-us/dataweave/2.11/dw-objects.md -->

---
product: DataWeave
version: 2.11
---

# Objects (dw::core::Objects)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions for working with objects.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Objects` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-objects-functions-divideby">divideBy</a></p></td><td><p>Breaks up an object into sub-objects that contain the specified number of key-value pairs.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-objects-functions-entryset">entrySet</a></p></td><td><p>Returns an array of key-value pairs that describe the key, value, and any attributes in the input object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-objects-functions-everyentry">everyEntry</a></p></td><td><p>Returns <code>true</code> if every entry in the object matches the condition.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-objects-functions-keyset">keySet</a></p></td><td><p>Returns an array of key names from an object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-objects-functions-mergewith">mergeWith</a></p></td><td><p>Appends any key-value pairs from a source object to a target object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-objects-functions-nameset">nameSet</a></p></td><td><p>Returns an array of keys from an object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-objects-functions-someentry">someEntry</a></p></td><td><p>Returns <code>true</code> if at least one entry in the object matches the specified condition.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-objects-functions-takewhile">takeWhile</a></p></td><td><p>Selects key-value pairs from the object while the condition is met.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-objects-functions-valueset">valueSet</a></p></td><td><p>Returns an array of the values from key-value pairs in an object.</p></td></tr></tbody></table>

<!-- document id=9222b8e02a6c2e7c6cf00dbd990a5ab20419aff5133f8bd4dc6e0ec461f2c0a7 url=/mulesoft/current/en-us/dataweave/2.12/dw-objects.md -->

---
product: DataWeave
version: 2.12
---

# Objects (dw::core::Objects)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions for working with objects.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Objects` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-objects-functions-divideby">divideBy</a></p></td><td><p>Breaks up an object into sub-objects that contain the specified number of key-value pairs.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-objects-functions-entryset">entrySet</a></p></td><td><p>Returns an array of key-value pairs that describe the key, value, and any attributes in the input object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-objects-functions-everyentry">everyEntry</a></p></td><td><p>Returns <code>true</code> if every entry in the object matches the condition.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-objects-functions-keyset">keySet</a></p></td><td><p>Returns an array of key names from an object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-objects-functions-mergewith">mergeWith</a></p></td><td><p>Appends any key-value pairs from a source object to a target object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-objects-functions-nameset">nameSet</a></p></td><td><p>Returns an array of keys from an object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-objects-functions-someentry">someEntry</a></p></td><td><p>Returns <code>true</code> if at least one entry in the object matches the specified condition.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-objects-functions-takewhile">takeWhile</a></p></td><td><p>Selects key-value pairs from the object while the condition is met.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-objects-functions-valueset">valueSet</a></p></td><td><p>Returns an array of the values from key-value pairs in an object.</p></td></tr></tbody></table>

<!-- document id=68a34de08ecd3a3ef5afa79590a1552b70d41bb87104e9468c456efd933b2ed6 url=/mulesoft/current/en-us/dataweave/2.3/dw-objects.md -->

---
product: DataWeave
version: 2.3
---

# Objects (dw::core::Objects)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions to work with Objects.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Objects` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-objects-functions-divideby">divideBy</a></p></td><td><p>Breaks up an object into sub-objects that contain the specified number of key-value pairs.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-objects-functions-entryset">entrySet</a></p></td><td><p>Returns an array of key-value pairs that describe the key, value, and any attributes in the input object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-objects-functions-everyentry">everyEntry</a></p></td><td><p>Returns <code>true</code> if every entry in the object matches the condition.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-objects-functions-keyset">keySet</a></p></td><td><p>Returns an array of key names from an object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-objects-functions-mergewith">mergeWith</a></p></td><td><p>Appends any key-value pairs from a source object to a target object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-objects-functions-nameset">nameSet</a></p></td><td><p>Returns an array of keys from an object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-objects-functions-someentry">someEntry</a></p></td><td><p>Returns <code>true</code> if at least one entry in the object matches the specified condition.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-objects-functions-takewhile">takeWhile</a></p></td><td><p>Selects key-value pairs from the object while the condition is met.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-objects-functions-valueset">valueSet</a></p></td><td><p>Returns an array of the values from key-value pairs in an object.</p></td></tr></tbody></table>

<!-- document id=53906b2d882553d435439686644539f279d2daf22374e787bded430e7dbdb696 url=/mulesoft/current/en-us/dataweave/2.4/dw-objects.md -->

---
product: DataWeave
version: 2.4
---

# Objects (dw::core::Objects)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions for working with objects.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Objects` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-objects-functions-divideby">divideBy</a></p></td><td><p>Breaks up an object into sub-objects that contain the specified number of key-value pairs.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-objects-functions-entryset">entrySet</a></p></td><td><p>Returns an array of key-value pairs that describe the key, value, and any attributes in the input object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-objects-functions-everyentry">everyEntry</a></p></td><td><p>Returns <code>true</code> if every entry in the object matches the condition.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-objects-functions-keyset">keySet</a></p></td><td><p>Returns an array of key names from an object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-objects-functions-mergewith">mergeWith</a></p></td><td><p>Appends any key-value pairs from a source object to a target object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-objects-functions-nameset">nameSet</a></p></td><td><p>Returns an array of keys from an object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-objects-functions-someentry">someEntry</a></p></td><td><p>Returns <code>true</code> if at least one entry in the object matches the specified condition.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-objects-functions-takewhile">takeWhile</a></p></td><td><p>Selects key-value pairs from the object while the condition is met.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-objects-functions-valueset">valueSet</a></p></td><td><p>Returns an array of the values from key-value pairs in an object.</p></td></tr></tbody></table>

<!-- document id=e371ad67c66b0d8d64138d83060fedb835f14a5661995731a743cb50360ea40f url=/mulesoft/current/en-us/dataweave/2.6/dw-objects.md -->

---
product: DataWeave
version: 2.6
---

# Objects (dw::core::Objects)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions for working with objects.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Objects` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-objects-functions-divideby">divideBy</a></p></td><td><p>Breaks up an object into sub-objects that contain the specified number of key-value pairs.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-objects-functions-entryset">entrySet</a></p></td><td><p>Returns an array of key-value pairs that describe the key, value, and any attributes in the input object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-objects-functions-everyentry">everyEntry</a></p></td><td><p>Returns <code>true</code> if every entry in the object matches the condition.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-objects-functions-keyset">keySet</a></p></td><td><p>Returns an array of key names from an object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-objects-functions-mergewith">mergeWith</a></p></td><td><p>Appends any key-value pairs from a source object to a target object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-objects-functions-nameset">nameSet</a></p></td><td><p>Returns an array of keys from an object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-objects-functions-someentry">someEntry</a></p></td><td><p>Returns <code>true</code> if at least one entry in the object matches the specified condition.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-objects-functions-takewhile">takeWhile</a></p></td><td><p>Selects key-value pairs from the object while the condition is met.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-objects-functions-valueset">valueSet</a></p></td><td><p>Returns an array of the values from key-value pairs in an object.</p></td></tr></tbody></table>

<!-- document id=5ba7ef6cce83f436b1b6d5f8bb7ee259a0879141c1ada4a771b938d7b1ff292a url=/mulesoft/current/en-us/dataweave/2.9/dw-objects.md -->

---
product: DataWeave
version: 2.9
---

# Objects (dw::core::Objects)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions for working with objects.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Objects` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-objects-functions-divideby">divideBy</a></p></td><td><p>Breaks up an object into sub-objects that contain the specified number of key-value pairs.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-objects-functions-entryset">entrySet</a></p></td><td><p>Returns an array of key-value pairs that describe the key, value, and any attributes in the input object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-objects-functions-everyentry">everyEntry</a></p></td><td><p>Returns <code>true</code> if every entry in the object matches the condition.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-objects-functions-keyset">keySet</a></p></td><td><p>Returns an array of key names from an object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-objects-functions-mergewith">mergeWith</a></p></td><td><p>Appends any key-value pairs from a source object to a target object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-objects-functions-nameset">nameSet</a></p></td><td><p>Returns an array of keys from an object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-objects-functions-someentry">someEntry</a></p></td><td><p>Returns <code>true</code> if at least one entry in the object matches the specified condition.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-objects-functions-takewhile">takeWhile</a></p></td><td><p>Selects key-value pairs from the object while the condition is met.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-objects-functions-valueset">valueSet</a></p></td><td><p>Returns an array of the values from key-value pairs in an object.</p></td></tr></tbody></table>

<!-- document id=bd9a41c004ec98c1fe05050afc5934dba79d2a5be21881032e8dbcb0e795110b url=/mulesoft/current/en-us/dataweave/latest/dw-objects.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Objects (dw::core::Objects)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions for working with objects.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Objects` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-objects-functions-divideby">divideBy</a></p></td><td><p>Breaks up an object into sub-objects that contain the specified number of key-value pairs.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-objects-functions-entryset">entrySet</a></p></td><td><p>Returns an array of key-value pairs that describe the key, value, and any attributes in the input object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-objects-functions-everyentry">everyEntry</a></p></td><td><p>Returns <code>true</code> if every entry in the object matches the condition.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-objects-functions-keyset">keySet</a></p></td><td><p>Returns an array of key names from an object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-objects-functions-mergewith">mergeWith</a></p></td><td><p>Appends any key-value pairs from a source object to a target object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-objects-functions-nameset">nameSet</a></p></td><td><p>Returns an array of keys from an object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-objects-functions-someentry">someEntry</a></p></td><td><p>Returns <code>true</code> if at least one entry in the object matches the specified condition.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-objects-functions-takewhile">takeWhile</a></p></td><td><p>Selects key-value pairs from the object while the condition is met.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-objects-functions-valueset">valueSet</a></p></td><td><p>Returns an array of the values from key-value pairs in an object.</p></td></tr></tbody></table>

<!-- document id=a729b63504c8b8e598e8a4c6c4345830b17098a65e41c649ce1928a55c6fa742 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-onnull.md -->

---
product: DataWeave
version: 2.11
---

# onNull

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## onNull<R>(previous: Null, callback: () -> R): R

Executes a callback function if the preceding expression returns a `null` value and then replaces
the `null` value with the result of the callback.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>previous</code></p></td><td><p>The value of the preceding expression.</p></td></tr><tr><td><p><code>callback</code></p></td><td><p>Callback that generates a new value if <code>previous</code> returns <code>null</code>.</p></td></tr></tbody></table>

### Example

This example shows how `onNull` behaves when it receives a `null` value.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
     "onNull": []
             reduce ((item, accumulator) -> item ++ accumulator)
             then ((result) -> sizeOf(result))
             onNull "Empty Text"
 }
```

#### Output

```Json
{
  "onNull": "Empty Text"
}
```

## onNull<T>(previous: T, callback: () -> Any): T

Helper function that enables `onNull` to work with a _non-null_ value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=95f84e0d1a2b5a863862d0464be3a88d451718ad8c2ab1185063f07a64c54f81 url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-onnull.md -->

---
product: DataWeave
version: 2.12
---

# onNull

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## onNull<R>(previous: Null, callback: () -> R): R

Executes a callback function if the preceding expression returns a `null` value and then replaces
the `null` value with the result of the callback.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>previous</code></p></td><td><p>The value of the preceding expression.</p></td></tr><tr><td><p><code>callback</code></p></td><td><p>Callback that generates a new value if <code>previous</code> returns <code>null</code>.</p></td></tr></tbody></table>

### Example

This example shows how `onNull` behaves when it receives a `null` value.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
     "onNull": []
             reduce ((item, accumulator) -> item ++ accumulator)
             then ((result) -> sizeOf(result))
             onNull "Empty Text"
 }
```

#### Output

```Json
{
  "onNull": "Empty Text"
}
```

## onNull<T>(previous: T, callback: () -> Any): T

Helper function that enables `onNull` to work with a _non-null_ value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=601a6fea72b4556e49c34480604eb136d368d457cdf818f13bd04a1a5de4bbb9 url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-onnull.md -->

---
product: DataWeave
version: 2.4
---

# onNull

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## onNull<R>(previous: Null, callback: () -> R): R

Executes a callback function if the preceding expression returns a `null` value and then replaces
the `null` value with the result of the callback.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>previous</code></p></td><td><p>The value of the preceding expression.</p></td></tr><tr><td><p><code>callback</code></p></td><td><p>Callback that generates a new value if <code>previous</code> returns <code>null</code>.</p></td></tr></tbody></table>

### Example

This example shows how `onNull` behaves when it receives a `null` value.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
     "onNull": []
             reduce ((item, accumulator) -> item ++ accumulator)
             then ((result) -> sizeOf(result))
             onNull "Empty Text"
 }
```

#### Output

```Json
{
  "onNull": "Empty Text"
}
```

## onNull<T>(previous: T, callback: () -> Any): T

Helper function that enables `onNull` to work with a _non-null_ value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=526eb342203a6a28ff8835392f8f88bcaecc6130271456c88a0cbaa6f13eac7e url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-onnull.md -->

---
product: DataWeave
version: 2.6
---

# onNull

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## onNull<R>(previous: Null, callback: () -> R): R

Executes a callback function if the preceding expression returns a `null` value and then replaces
the `null` value with the result of the callback.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>previous</code></p></td><td><p>The value of the preceding expression.</p></td></tr><tr><td><p><code>callback</code></p></td><td><p>Callback that generates a new value if <code>previous</code> returns <code>null</code>.</p></td></tr></tbody></table>

### Example

This example shows how `onNull` behaves when it receives a `null` value.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
     "onNull": []
             reduce ((item, accumulator) -> item ++ accumulator)
             then ((result) -> sizeOf(result))
             onNull "Empty Text"
 }
```

#### Output

```Json
{
  "onNull": "Empty Text"
}
```

## onNull<T>(previous: T, callback: () -> Any): T

Helper function that enables `onNull` to work with a _non-null_ value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=bb84298357f0bf3d17f7e5a277be38fa1cf56f484666d840a9f1383e5a9912e8 url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-onnull.md -->

---
product: DataWeave
version: 2.9
---

# onNull

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## onNull<R>(previous: Null, callback: () -> R): R

Executes a callback function if the preceding expression returns a `null` value and then replaces
the `null` value with the result of the callback.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>previous</code></p></td><td><p>The value of the preceding expression.</p></td></tr><tr><td><p><code>callback</code></p></td><td><p>Callback that generates a new value if <code>previous</code> returns <code>null</code>.</p></td></tr></tbody></table>

### Example

This example shows how `onNull` behaves when it receives a `null` value.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
     "onNull": []
             reduce ((item, accumulator) -> item ++ accumulator)
             then ((result) -> sizeOf(result))
             onNull "Empty Text"
 }
```

#### Output

```Json
{
  "onNull": "Empty Text"
}
```

## onNull<T>(previous: T, callback: () -> Any): T

Helper function that enables `onNull` to work with a _non-null_ value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=4b75eaefdedf996187beb28208b22aeaba0c952e7de1f22c6abe5341aee40c9d url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-onnull.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# onNull

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## onNull<R>(previous: Null, callback: () -> R): R

Executes a callback function if the preceding expression returns a `null` value and then replaces
the `null` value with the result of the callback.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>previous</code></p></td><td><p>The value of the preceding expression.</p></td></tr><tr><td><p><code>callback</code></p></td><td><p>Callback that generates a new value if <code>previous</code> returns <code>null</code>.</p></td></tr></tbody></table>

### Example

This example shows how `onNull` behaves when it receives a `null` value.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
     "onNull": []
             reduce ((item, accumulator) -> item ++ accumulator)
             then ((result) -> sizeOf(result))
             onNull "Empty Text"
 }
```

#### Output

```Json
{
  "onNull": "Empty Text"
}
```

## onNull<T>(previous: T, callback: () -> Any): T

Helper function that enables `onNull` to work with a _non-null_ value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=19944981197658c65292baf35fb85a7f5a18a742735c7d5c239e3e775d15d15e url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-orderby.md -->

---
product: DataWeave
version: 2.11
---

# orderBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## orderBy<K, V, R, O <: { (K)?: V }>(object: O, criteria: (value: V, key: K) -> R): O

Reorders the elements of an input using criteria that acts on selected elements of that input.

This version of `orderBy` takes an object as input. Other versions act on an input array or handle a
`null` value.

Note that you can reference the index with the anonymous parameter `$$` and the value with `$`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object to reorder.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The result of the function is used as the criteria to reorder the object.</p></td></tr></tbody></table>

### Example

This example alphabetically orders the values of each object in the input array. Note that
`orderBy($.letter)` produces the same result as `orderBy($[0])`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[{ letter: "e" }, { letter: "d" }] orderBy($.letter)
```

#### Output

```JSON
[
  {
    "letter": "d"
  },
  {
    "letter": "e"
  }
]
```

### Example

The `orderBy` function doesn’t have an option to sort the result in a descending order. In these
cases, invert the order of the resulting array using `[-1 to 0]`:

#### Source

```DataWeave
%dw 2.0
output application/json
---
orderDescending: ([3,8,1] orderBy $)[-1 to 0]
```

#### Output

```JSON
{ "orderDescending": [8,3,1] }
```

## orderBy<T, R>(array: Array<T>, criteria: (item: T, index: Number) -> R): Array<T>

Sorts an array using the specified criteria.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array to sort.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The result of the function serves as criteria for sorting the array. It should return a simple value (<code>String</code>, <code>Number</code>, and so on).</p></td></tr></tbody></table>

### Example

This example sorts an array of numbers based on the numeric values.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[3,2,3] orderBy $
```

#### Output

```JSON
[ 2, 3, 3 ]
```

### Example

This example sorts an array of people based on their age.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[{name: "Santiago", age: 42},{name: "Leandro", age: 29}, {name: "Mariano", age: 35}] orderBy (person) -> person.age
```

#### Output

```JSON
[
  {
    name: "Leandro",
    age: 29
  },
  {
    name: "Mariano",
    age: 35
  },
  {
    name: "Santiago",
    age: 42
  }
]
```

### Example

This example sorts an array of DateTime in descending order.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[|2020-10-01T23:57:59.017Z|, |2022-12-22T12:12:12.011Z|, |2020-10-01T12:40:10.012Z|, |2020-10-01T23:57:59.021Z|]
  orderBy -($ as Number {unit: "milliseconds"})
```

#### Output

```JSON
[
  "2022-12-22T12:12:12.011Z",
  "2020-10-01T23:57:59.021Z",
  "2020-10-01T23:57:59.017Z",
  "2020-10-01T12:40:10.012Z"
]
```

### Example

This example changes the order of the objects in a JSON array. The expression first orders them
alphabetically by the value of the `Type` key, then reverses the order based on the `[-1 to 0]`.

#### Source

```DataWeave
%dw 2.0
var myInput = [
    {
        "AccountNumber": "987999321",
        "NameOnAccount": "QA",
        "Type": "AAAA",
        "CDetail": {
            "Status": "Open"
        }
    },
    {
        "AccountNumber": "12399978",
        "NameOnAccount": "QA",
        "Type": "BBBB",
        "CDetail": {}
    },
    {
        "AccountNumber": "32199974",
        "NameOnAccount": "QA",
        "Type": "CCCC",
        "CDetail": {}
    }
]
output application/json
---
(myInput orderBy $.Type)[-1 to 0]
```

#### Output

```JSON
[
  {
    "AccountNumber": "32199974",
    "NameOnAccount": "QA",
    "Type": "CCCC",
    "CDetail": {

    }
  },
  {
    "AccountNumber": "12399978",
    "NameOnAccount": "QA",
    "Type": "BBBB",
    "CDetail": {

    }
  },
  {
    "AccountNumber": "987999321",
    "NameOnAccount": "QA",
    "Type": "AAAA",
    "CDetail": {
      "Status": "Open"
    }
  }
]
```

## orderBy(value: Null, criteria: (item: Nothing, index: Nothing) -> Null): Null

Helper function that enables `orderBy` to work with a `null` value.

<!-- document id=c8578a972558888bc0b7b3e25bc92cf66a8b59f6c6ec275b64c8f6949be2f9cd url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-orderby.md -->

---
product: DataWeave
version: 2.12
---

# orderBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## orderBy<K, V, R, O <: { (K)?: V }>(object: O, criteria: (value: V, key: K) -> R): O

Reorders the elements of an input using criteria that acts on selected elements of that input.

This version of `orderBy` takes an object as input. Other versions act on an input array or handle a
`null` value.

Note that you can reference the index with the anonymous parameter `$$` and the value with `$`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object to reorder.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The result of the function is used as the criteria to reorder the object.</p></td></tr></tbody></table>

### Example

This example alphabetically orders the values of each object in the input array. Note that
`orderBy($.letter)` produces the same result as `orderBy($[0])`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[{ letter: "e" }, { letter: "d" }] orderBy($.letter)
```

#### Output

```JSON
[
  {
    "letter": "d"
  },
  {
    "letter": "e"
  }
]
```

### Example

The `orderBy` function doesn’t have an option to sort the result in a descending order. In these
cases, invert the order of the resulting array using `[-1 to 0]`:

#### Source

```DataWeave
%dw 2.0
output application/json
---
orderDescending: ([3,8,1] orderBy $)[-1 to 0]
```

#### Output

```JSON
{ "orderDescending": [8,3,1] }
```

## orderBy<T, R>(array: Array<T>, criteria: (item: T, index: Number) -> R): Array<T>

Sorts an array using the specified criteria.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array to sort.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The result of the function serves as criteria for sorting the array. It should return a simple value (<code>String</code>, <code>Number</code>, and so on).</p></td></tr></tbody></table>

### Example

This example sorts an array of numbers based on the numeric values.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[3,2,3] orderBy $
```

#### Output

```JSON
[ 2, 3, 3 ]
```

### Example

This example sorts an array of people based on their age.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[{name: "Santiago", age: 42},{name: "Leandro", age: 29}, {name: "Mariano", age: 35}] orderBy (person) -> person.age
```

#### Output

```JSON
[
  {
    name: "Leandro",
    age: 29
  },
  {
    name: "Mariano",
    age: 35
  },
  {
    name: "Santiago",
    age: 42
  }
]
```

### Example

This example sorts an array of DateTime in descending order.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[|2020-10-01T23:57:59.017Z|, |2022-12-22T12:12:12.011Z|, |2020-10-01T12:40:10.012Z|, |2020-10-01T23:57:59.021Z|]
  orderBy -($ as Number {unit: "milliseconds"})
```

#### Output

```JSON
[
  "2022-12-22T12:12:12.011Z",
  "2020-10-01T23:57:59.021Z",
  "2020-10-01T23:57:59.017Z",
  "2020-10-01T12:40:10.012Z"
]
```

### Example

This example changes the order of the objects in a JSON array. The expression first orders them
alphabetically by the value of the `Type` key, then reverses the order based on the `[-1 to 0]`.

#### Source

```DataWeave
%dw 2.0
var myInput = [
    {
        "AccountNumber": "987999321",
        "NameOnAccount": "QA",
        "Type": "AAAA",
        "CDetail": {
            "Status": "Open"
        }
    },
    {
        "AccountNumber": "12399978",
        "NameOnAccount": "QA",
        "Type": "BBBB",
        "CDetail": {}
    },
    {
        "AccountNumber": "32199974",
        "NameOnAccount": "QA",
        "Type": "CCCC",
        "CDetail": {}
    }
]
output application/json
---
(myInput orderBy $.Type)[-1 to 0]
```

#### Output

```JSON
[
  {
    "AccountNumber": "32199974",
    "NameOnAccount": "QA",
    "Type": "CCCC",
    "CDetail": {

    }
  },
  {
    "AccountNumber": "12399978",
    "NameOnAccount": "QA",
    "Type": "BBBB",
    "CDetail": {

    }
  },
  {
    "AccountNumber": "987999321",
    "NameOnAccount": "QA",
    "Type": "AAAA",
    "CDetail": {
      "Status": "Open"
    }
  }
]
```

## orderBy(value: Null, criteria: (item: Nothing, index: Nothing) -> Null): Null

Helper function that enables `orderBy` to work with a `null` value.

<!-- document id=f6fa48da1dc5596312a387bb3a8e0f8f7ea4e9eb825eb1119a8e774a0198f02b url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-orderby.md -->

---
product: DataWeave
version: 2.3
---

# orderBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## orderBy(O, (value: V, key: K) -> R): O

Reorders the elements of an input using criteria that acts on selected elements of that input.

This version of `orderBy` takes an object as input. Other versions act on an input array or handle a
null value.

Note that you can reference the index with the anonymous parameter `$$` and the value with `$`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object to reorder.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The result of the function is used as the criteria to reorder the object.</p></td></tr></tbody></table>

### Example

This example alphabetically orders the values of each object in the input array. Note that
`orderBy($.letter)` produces the same result as `orderBy($[0])`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[{ letter: "e" }, { letter: "d" }] orderBy($.letter)
```

#### Output

```JSON
[
  {
    "letter": "d"
  },
  {
    "letter": "e"
  }
]
```

### Example

The `orderBy` function does not have an option to order in descending order instead of ascending. In
these cases, you can simply invert the order of the resulting array using `-`, for example:

#### Source

```DataWeave
%dw 2.0
output application/json
---
orderDescending: ([3,8,1] orderBy -$)
```

#### Output

```JSON
{ "orderDescending": [8,3,1] }
```

## orderBy(Array<T>, (item: T, index: Number) -> R): Array<T>

Sorts an array using the specified criteria.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array to sort.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The result of the function will be used as the criteria to sort the list. It should return a simple value (String, Number, etc)</p></td></tr></tbody></table>

### Example

This example sorts an array of numbers based on the numeric values.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[3,2,3] orderBy $
```

#### Output

```JSON
[ 2, 3, 3 ]
```

### Example

This example sorts an array of people based on their age.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[{name: "Santiago", age: 42},{name: "Leandro", age: 29}, {name: "Mariano", age: 35}] orderBy (person) -> person.age
```

#### Output

```JSON
[
  {
    name: "Leandro",
    age: 29
  },
  {
    name: "Mariano",
    age: 35
  },
  {
    name: "Santiago",
    age: 42
  }
]
```

### Example

This example changes the order of the objects in a JSON array. The expression first orders them
alphabetically by the value of the `Type` key, then reverses the order based on the `[-1 to 0]`.

#### Source

```DataWeave
%dw 2.0
var myInput = [
    {
        "AccountNumber": "987999321",
        "NameOnAccount": "QA",
        "Type": "AAAA",
        "CDetail": {
            "Status": "Open"
        }
    },
    {
        "AccountNumber": "12399978",
        "NameOnAccount": "QA",
        "Type": "BBBB",
        "CDetail": {}
    },
    {
        "AccountNumber": "32199974",
        "NameOnAccount": "QA",
        "Type": "CCCC",
        "CDetail": {}
    }
]
output application/json
---
(myInput orderBy $.Type)[-1 to 0]
```

#### Output

```JSON
[
  {
    "AccountNumber": "32199974",
    "NameOnAccount": "QA",
    "Type": "CCCC",
    "CDetail": {

    }
  },
  {
    "AccountNumber": "12399978",
    "NameOnAccount": "QA",
    "Type": "BBBB",
    "CDetail": {

    }
  },
  {
    "AccountNumber": "987999321",
    "NameOnAccount": "QA",
    "Type": "AAAA",
    "CDetail": {
      "Status": "Open"
    }
  }
]
```

## orderBy(Null, (item: Nothing, index: Nothing) -> Null): Null

Helper function that enables `orderBy` to work with a `null` value.

<!-- document id=43a482c5a6a44c9983a79ddb0a572968378c81650ac476272c75835887c4dc54 url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-orderby.md -->

---
product: DataWeave
version: 2.4
---

# orderBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## orderBy<K, V, R, O <: { (K)?: V }>(object: O, criteria: (value: V, key: K) -> R): O

Reorders the elements of an input using criteria that acts on selected elements of that input.

This version of `orderBy` takes an object as input. Other versions act on an input array or handle a
`null` value.

Note that you can reference the index with the anonymous parameter `$$` and the value with `$`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object to reorder.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The result of the function is used as the criteria to reorder the object.</p></td></tr></tbody></table>

### Example

This example alphabetically orders the values of each object in the input array. Note that
`orderBy($.letter)` produces the same result as `orderBy($[0])`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ letter: "b", letter: "c", letter: "a" } orderBy ((value, key) -> value)
```

#### Output

```JSON
{
  "letter": "a",
  "letter": "b",
  "letter": "c"
}
```

## orderBy<T, R>(array: Array<T>, criteria: (item: T, index: Number) -> R): Array<T>

Sorts an array using the specified criteria.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array to sort.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The result of the function serves as criteria for sorting the array. It should return a simple value (<code>String</code>, <code>Number</code>, and so on).</p></td></tr></tbody></table>

### Example

This example sorts an array of numbers based on the numeric values.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[3,2,3] orderBy $
```

#### Output

```JSON
[ 2, 3, 3 ]
```

### Example

The `orderBy` function does not have an option to order in descending order instead of ascending. In
these cases, you can simply invert the order of the resulting array using `[-1 to 0]`:

#### Source

```DataWeave
%dw 2.0
output application/json
---
orderDescending: ([3,8,1] orderBy $)[-1 to 0]
```

#### Output

```JSON
{ "orderDescending": [8,3,1] }
```

### Example

This example sorts an array of people based on their age.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[{name: "Santiago", age: 42},{name: "Leandro", age: 29}, {name: "Mariano", age: 35}] orderBy (person) -> person.age
```

#### Output

```JSON
[
  {
    name: "Leandro",
    age: 29
  },
  {
    name: "Mariano",
    age: 35
  },
  {
    name: "Santiago",
    age: 42
  }
]
```

### Example

This example sorts an array of DateTime in descending order.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[|2020-10-01T23:57:59.017Z|, |2022-12-22T12:12:12.011Z|, |2020-10-01T12:40:10.012Z|, |2020-10-01T23:57:59.021Z|]
  orderBy -($ as Number {unit: "milliseconds"})
```

#### Output

```JSON
[
  "2022-12-22T12:12:12.011Z",
  "2020-10-01T23:57:59.021Z",
  "2020-10-01T23:57:59.017Z",
  "2020-10-01T12:40:10.012Z"
]
```

### Example

This example changes the order of the objects in a JSON array. The expression first orders them
alphabetically by the value of the `Type` key, then reverses the order based on the `[-1 to 0]`.

#### Source

```DataWeave
%dw 2.0
var myInput = [
    {
        "AccountNumber": "987999321",
        "NameOnAccount": "QA",
        "Type": "AAAA",
        "CDetail": {
            "Status": "Open"
        }
    },
    {
        "AccountNumber": "12399978",
        "NameOnAccount": "QA",
        "Type": "BBBB",
        "CDetail": {}
    },
    {
        "AccountNumber": "32199974",
        "NameOnAccount": "QA",
        "Type": "CCCC",
        "CDetail": {}
    }
]
output application/json
---
(myInput orderBy $.Type)[-1 to 0]
```

#### Output

```JSON
[
  {
    "AccountNumber": "32199974",
    "NameOnAccount": "QA",
    "Type": "CCCC",
    "CDetail": {

    }
  },
  {
    "AccountNumber": "12399978",
    "NameOnAccount": "QA",
    "Type": "BBBB",
    "CDetail": {

    }
  },
  {
    "AccountNumber": "987999321",
    "NameOnAccount": "QA",
    "Type": "AAAA",
    "CDetail": {
      "Status": "Open"
    }
  }
]
```

## orderBy(value: Null, criteria: (item: Nothing, index: Nothing) -> Null): Null

Helper function that enables `orderBy` to work with a `null` value.

<!-- document id=c5d04e58c2269be3d33640a6c74d00cb853808f726485b3cff20b9ced0f7c232 url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-orderby.md -->

---
product: DataWeave
version: 2.6
---

# orderBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## orderBy<K, V, R, O <: { (K)?: V }>(object: O, criteria: (value: V, key: K) -> R): O

Reorders the elements of an input using criteria that acts on selected elements of that input.

This version of `orderBy` takes an object as input. Other versions act on an input array or handle a
`null` value.

Note that you can reference the index with the anonymous parameter `$$` and the value with `$`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object to reorder.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The result of the function is used as the criteria to reorder the object.</p></td></tr></tbody></table>

### Example

This example alphabetically orders the values of each object in the input array. Note that
`orderBy($.letter)` produces the same result as `orderBy($[0])`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ letter: "b", letter: "c", letter: "a" } orderBy ((value, key) -> value)
[{ letter: "e" }, { letter: "d" }] orderBy($.letter)
```

#### Output

```JSON
[
  {
    "letter": "d"
  },
  {
    "letter": "e"
  }
]
```

### Example

The `orderBy` function doesn’t have an option to sort the result in a descending order. In these
cases, invert the order of the resulting array using `[-1 to 0]`:

#### Source

```DataWeave
%dw 2.0
output application/json
---
orderDescending: ([3,8,1] orderBy $)[-1 to 0]
```

#### Output

```JSON
{ "orderDescending": [8,3,1] }
```

## orderBy<T, R>(array: Array<T>, criteria: (item: T, index: Number) -> R): Array<T>

Sorts an array using the specified criteria.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array to sort.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The result of the function serves as criteria for sorting the array. It should return a simple value (<code>String</code>, <code>Number</code>, and so on).</p></td></tr></tbody></table>

### Example

This example sorts an array of numbers based on the numeric values.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[3,2,3] orderBy $
```

#### Output

```JSON
[ 2, 3, 3 ]
```

### Example

This example sorts an array of people based on their age.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[{name: "Santiago", age: 42},{name: "Leandro", age: 29}, {name: "Mariano", age: 35}] orderBy (person) -> person.age
```

#### Output

```JSON
[
  {
    name: "Leandro",
    age: 29
  },
  {
    name: "Mariano",
    age: 35
  },
  {
    name: "Santiago",
    age: 42
  }
]
```

### Example

This example sorts an array of DateTime in descending order.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[|2020-10-01T23:57:59.017Z|, |2022-12-22T12:12:12.011Z|, |2020-10-01T12:40:10.012Z|, |2020-10-01T23:57:59.021Z|]
  orderBy -($ as Number {unit: "milliseconds"})
```

#### Output

```JSON
[
  "2022-12-22T12:12:12.011Z",
  "2020-10-01T23:57:59.021Z",
  "2020-10-01T23:57:59.017Z",
  "2020-10-01T12:40:10.012Z"
]
```

### Example

This example changes the order of the objects in a JSON array. The expression first orders them
alphabetically by the value of the `Type` key, then reverses the order based on the `[-1 to 0]`.

#### Source

```DataWeave
%dw 2.0
var myInput = [
    {
        "AccountNumber": "987999321",
        "NameOnAccount": "QA",
        "Type": "AAAA",
        "CDetail": {
            "Status": "Open"
        }
    },
    {
        "AccountNumber": "12399978",
        "NameOnAccount": "QA",
        "Type": "BBBB",
        "CDetail": {}
    },
    {
        "AccountNumber": "32199974",
        "NameOnAccount": "QA",
        "Type": "CCCC",
        "CDetail": {}
    }
]
output application/json
---
(myInput orderBy $.Type)[-1 to 0]
```

#### Output

```JSON
[
  {
    "AccountNumber": "32199974",
    "NameOnAccount": "QA",
    "Type": "CCCC",
    "CDetail": {

    }
  },
  {
    "AccountNumber": "12399978",
    "NameOnAccount": "QA",
    "Type": "BBBB",
    "CDetail": {

    }
  },
  {
    "AccountNumber": "987999321",
    "NameOnAccount": "QA",
    "Type": "AAAA",
    "CDetail": {
      "Status": "Open"
    }
  }
]
```

## orderBy(value: Null, criteria: (item: Nothing, index: Nothing) -> Null): Null

Helper function that enables `orderBy` to work with a `null` value.

<!-- document id=de4533a5ec119a9f2d37a236a3ba4d5a21daa42474ec26dfa4c5c99b41861dc2 url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-orderby.md -->

---
product: DataWeave
version: 2.9
---

# orderBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## orderBy<K, V, R, O <: { (K)?: V }>(object: O, criteria: (value: V, key: K) -> R): O

Reorders the elements of an input using criteria that acts on selected elements of that input.

This version of `orderBy` takes an object as input. Other versions act on an input array or handle a
`null` value.

Note that you can reference the index with the anonymous parameter `$$` and the value with `$`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object to reorder.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The result of the function is used as the criteria to reorder the object.</p></td></tr></tbody></table>

### Example

This example alphabetically orders the values of each object in the input array. Note that
`orderBy($.letter)` produces the same result as `orderBy($[0])`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[{ letter: "e" }, { letter: "d" }] orderBy($.letter)
```

#### Output

```JSON
[
  {
    "letter": "d"
  },
  {
    "letter": "e"
  }
]
```

### Example

The `orderBy` function doesn’t have an option to sort the result in a descending order. In these
cases, invert the order of the resulting array using `[-1 to 0]`:

#### Source

```DataWeave
%dw 2.0
output application/json
---
orderDescending: ([3,8,1] orderBy $)[-1 to 0]
```

#### Output

```JSON
{ "orderDescending": [8,3,1] }
```

## orderBy<T, R>(array: Array<T>, criteria: (item: T, index: Number) -> R): Array<T>

Sorts an array using the specified criteria.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array to sort.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The result of the function serves as criteria for sorting the array. It should return a simple value (<code>String</code>, <code>Number</code>, and so on).</p></td></tr></tbody></table>

### Example

This example sorts an array of numbers based on the numeric values.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[3,2,3] orderBy $
```

#### Output

```JSON
[ 2, 3, 3 ]
```

### Example

This example sorts an array of people based on their age.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[{name: "Santiago", age: 42},{name: "Leandro", age: 29}, {name: "Mariano", age: 35}] orderBy (person) -> person.age
```

#### Output

```JSON
[
  {
    name: "Leandro",
    age: 29
  },
  {
    name: "Mariano",
    age: 35
  },
  {
    name: "Santiago",
    age: 42
  }
]
```

### Example

This example sorts an array of DateTime in descending order.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[|2020-10-01T23:57:59.017Z|, |2022-12-22T12:12:12.011Z|, |2020-10-01T12:40:10.012Z|, |2020-10-01T23:57:59.021Z|]
  orderBy -($ as Number {unit: "milliseconds"})
```

#### Output

```JSON
[
  "2022-12-22T12:12:12.011Z",
  "2020-10-01T23:57:59.021Z",
  "2020-10-01T23:57:59.017Z",
  "2020-10-01T12:40:10.012Z"
]
```

### Example

This example changes the order of the objects in a JSON array. The expression first orders them
alphabetically by the value of the `Type` key, then reverses the order based on the `[-1 to 0]`.

#### Source

```DataWeave
%dw 2.0
var myInput = [
    {
        "AccountNumber": "987999321",
        "NameOnAccount": "QA",
        "Type": "AAAA",
        "CDetail": {
            "Status": "Open"
        }
    },
    {
        "AccountNumber": "12399978",
        "NameOnAccount": "QA",
        "Type": "BBBB",
        "CDetail": {}
    },
    {
        "AccountNumber": "32199974",
        "NameOnAccount": "QA",
        "Type": "CCCC",
        "CDetail": {}
    }
]
output application/json
---
(myInput orderBy $.Type)[-1 to 0]
```

#### Output

```JSON
[
  {
    "AccountNumber": "32199974",
    "NameOnAccount": "QA",
    "Type": "CCCC",
    "CDetail": {

    }
  },
  {
    "AccountNumber": "12399978",
    "NameOnAccount": "QA",
    "Type": "BBBB",
    "CDetail": {

    }
  },
  {
    "AccountNumber": "987999321",
    "NameOnAccount": "QA",
    "Type": "AAAA",
    "CDetail": {
      "Status": "Open"
    }
  }
]
```

## orderBy(value: Null, criteria: (item: Nothing, index: Nothing) -> Null): Null

Helper function that enables `orderBy` to work with a `null` value.

<!-- document id=af2879ad14c9e0c29baebcde5ac9c96df03834e79fb34cd3756a09986cc764d6 url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-orderby.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# orderBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## orderBy<K, V, R, O <: { (K)?: V }>(object: O, criteria: (value: V, key: K) -> R): O

Reorders the elements of an input using criteria that acts on selected elements of that input.

This version of `orderBy` takes an object as input. Other versions act on an input array or handle a
`null` value.

Note that you can reference the index with the anonymous parameter `$$` and the value with `$`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object to reorder.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The result of the function is used as the criteria to reorder the object.</p></td></tr></tbody></table>

### Example

This example alphabetically orders the values of each object in the input array. Note that
`orderBy($.letter)` produces the same result as `orderBy($[0])`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[{ letter: "e" }, { letter: "d" }] orderBy($.letter)
```

#### Output

```JSON
[
  {
    "letter": "d"
  },
  {
    "letter": "e"
  }
]
```

### Example

The `orderBy` function doesn’t have an option to sort the result in a descending order. In these
cases, invert the order of the resulting array using `[-1 to 0]`:

#### Source

```DataWeave
%dw 2.0
output application/json
---
orderDescending: ([3,8,1] orderBy $)[-1 to 0]
```

#### Output

```JSON
{ "orderDescending": [8,3,1] }
```

## orderBy<T, R>(array: Array<T>, criteria: (item: T, index: Number) -> R): Array<T>

Sorts an array using the specified criteria.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array to sort.</p></td></tr><tr><td><p><code>criteria</code></p></td><td><p>The result of the function serves as criteria for sorting the array. It should return a simple value (<code>String</code>, <code>Number</code>, and so on).</p></td></tr></tbody></table>

### Example

This example sorts an array of numbers based on the numeric values.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[3,2,3] orderBy $
```

#### Output

```JSON
[ 2, 3, 3 ]
```

### Example

This example sorts an array of people based on their age.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[{name: "Santiago", age: 42},{name: "Leandro", age: 29}, {name: "Mariano", age: 35}] orderBy (person) -> person.age
```

#### Output

```JSON
[
  {
    name: "Leandro",
    age: 29
  },
  {
    name: "Mariano",
    age: 35
  },
  {
    name: "Santiago",
    age: 42
  }
]
```

### Example

This example sorts an array of DateTime in descending order.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[|2020-10-01T23:57:59.017Z|, |2022-12-22T12:12:12.011Z|, |2020-10-01T12:40:10.012Z|, |2020-10-01T23:57:59.021Z|]
  orderBy -($ as Number {unit: "milliseconds"})
```

#### Output

```JSON
[
  "2022-12-22T12:12:12.011Z",
  "2020-10-01T23:57:59.021Z",
  "2020-10-01T23:57:59.017Z",
  "2020-10-01T12:40:10.012Z"
]
```

### Example

This example changes the order of the objects in a JSON array. The expression first orders them
alphabetically by the value of the `Type` key, then reverses the order based on the `[-1 to 0]`.

#### Source

```DataWeave
%dw 2.0
var myInput = [
    {
        "AccountNumber": "987999321",
        "NameOnAccount": "QA",
        "Type": "AAAA",
        "CDetail": {
            "Status": "Open"
        }
    },
    {
        "AccountNumber": "12399978",
        "NameOnAccount": "QA",
        "Type": "BBBB",
        "CDetail": {}
    },
    {
        "AccountNumber": "32199974",
        "NameOnAccount": "QA",
        "Type": "CCCC",
        "CDetail": {}
    }
]
output application/json
---
(myInput orderBy $.Type)[-1 to 0]
```

#### Output

```JSON
[
  {
    "AccountNumber": "32199974",
    "NameOnAccount": "QA",
    "Type": "CCCC",
    "CDetail": {

    }
  },
  {
    "AccountNumber": "12399978",
    "NameOnAccount": "QA",
    "Type": "BBBB",
    "CDetail": {

    }
  },
  {
    "AccountNumber": "987999321",
    "NameOnAccount": "QA",
    "Type": "AAAA",
    "CDetail": {
      "Status": "Open"
    }
  }
]
```

## orderBy(value: Null, criteria: (item: Nothing, index: Nothing) -> Null): Null

Helper function that enables `orderBy` to work with a `null` value.

<!-- document id=a8aabdefbe9c4ddf3fb15f815ea403c4470d295f204bdbf4e124d6e988e4e2c9 url=/mulesoft/current/en-us/dataweave/2.11/dw-strings-functions-ordinalize.md -->

---
product: DataWeave
version: 2.11
---

# ordinalize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## ordinalize(num: Number): String

Returns a number as an ordinal, such as `1st` or `2nd`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>num</code></p></td><td><p>An input number to return as an ordinal.</p></td></tr></tbody></table>

### Example

This example returns a variety of input numbers as ordinals.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a" : ordinalize(1),
  "b": ordinalize(2),
  "c": ordinalize(5),
  "d": ordinalize(103)
}
```

#### Output

```JSON
{
   "a": "1st",
   "b": "2nd",
   "c": "5th",
   "d": "103rd"
}
```

## ordinalize(num: Null): Null

Helper function that enables `ordinalize` to work with a `null` value.

<!-- document id=6eeee76287805733247f9db3c42bcb97b38a0af84974e14276fed0e23d133ea2 url=/mulesoft/current/en-us/dataweave/2.12/dw-strings-functions-ordinalize.md -->

---
product: DataWeave
version: 2.12
---

# ordinalize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## ordinalize(num: Number): String

Returns a number as an ordinal, such as `1st` or `2nd`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>num</code></p></td><td><p>An input number to return as an ordinal.</p></td></tr></tbody></table>

### Example

This example returns a variety of input numbers as ordinals.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a" : ordinalize(1),
  "b": ordinalize(2),
  "c": ordinalize(5),
  "d": ordinalize(103)
}
```

#### Output

```JSON
{
   "a": "1st",
   "b": "2nd",
   "c": "5th",
   "d": "103rd"
}
```

## ordinalize(num: Null): Null

Helper function that enables `ordinalize` to work with a `null` value.

<!-- document id=e3313b0d95acee50ed466c71c9d2e20908e61938981deb10e65ada77c2788e5e url=/mulesoft/current/en-us/dataweave/2.3/dw-strings-functions-ordinalize.md -->

---
product: DataWeave
version: 2.3
---

# ordinalize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## ordinalize(Number): String

Returns a number as an ordinal, such as `1st` or `2nd`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>num</code></p></td><td><p>An input number to return as an ordinal.</p></td></tr></tbody></table>

### Example

This example returns a variety of input numbers as ordinals.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a" : ordinalize(1),
  "b": ordinalize(2),
  "c": ordinalize(5),
  "d": ordinalize(103)
}
```

#### Output

```JSON
{
   "a": "1st",
   "b": "2nd",
   "c": "5th",
   "d": "103rd"
}
```

## ordinalize(Null): Null

Helper function that enables `ordinalize` to work with a `null` value.

<!-- document id=31f9d152d77f46e4a762a8050e677d681ddd5c9412295284609f4a64784277e1 url=/mulesoft/current/en-us/dataweave/2.4/dw-strings-functions-ordinalize.md -->

---
product: DataWeave
version: 2.4
---

# ordinalize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## ordinalize(num: Number): String

Returns a number as an ordinal, such as `1st` or `2nd`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>num</code></p></td><td><p>An input number to return as an ordinal.</p></td></tr></tbody></table>

### Example

This example returns a variety of input numbers as ordinals.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a" : ordinalize(1),
  "b": ordinalize(2),
  "c": ordinalize(5),
  "d": ordinalize(103)
}
```

#### Output

```JSON
{
   "a": "1st",
   "b": "2nd",
   "c": "5th",
   "d": "103rd"
}
```

## ordinalize(num: Null): Null

Helper function that enables `ordinalize` to work with a `null` value.

<!-- document id=24c656ed69161508259b564eafae8f66e05bde8b2c56ff674ee4fde5f06a121c url=/mulesoft/current/en-us/dataweave/2.6/dw-strings-functions-ordinalize.md -->

---
product: DataWeave
version: 2.6
---

# ordinalize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## ordinalize(num: Number): String

Returns a number as an ordinal, such as `1st` or `2nd`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>num</code></p></td><td><p>An input number to return as an ordinal.</p></td></tr></tbody></table>

### Example

This example returns a variety of input numbers as ordinals.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a" : ordinalize(1),
  "b": ordinalize(2),
  "c": ordinalize(5),
  "d": ordinalize(103)
}
```

#### Output

```JSON
{
   "a": "1st",
   "b": "2nd",
   "c": "5th",
   "d": "103rd"
}
```

## ordinalize(num: Null): Null

Helper function that enables `ordinalize` to work with a `null` value.

<!-- document id=cbf0a87352eacdf5a8e1ec5290cdd8b619c73a72841549d0bfc543bf4bfcfa90 url=/mulesoft/current/en-us/dataweave/2.9/dw-strings-functions-ordinalize.md -->

---
product: DataWeave
version: 2.9
---

# ordinalize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## ordinalize(num: Number): String

Returns a number as an ordinal, such as `1st` or `2nd`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>num</code></p></td><td><p>An input number to return as an ordinal.</p></td></tr></tbody></table>

### Example

This example returns a variety of input numbers as ordinals.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a" : ordinalize(1),
  "b": ordinalize(2),
  "c": ordinalize(5),
  "d": ordinalize(103)
}
```

#### Output

```JSON
{
   "a": "1st",
   "b": "2nd",
   "c": "5th",
   "d": "103rd"
}
```

## ordinalize(num: Null): Null

Helper function that enables `ordinalize` to work with a `null` value.

<!-- document id=cbd5db2dc0a15de619bb7a07d3fcad49554e61e0b5563e95c9c93ef41903d47b url=/mulesoft/current/en-us/dataweave/latest/dw-strings-functions-ordinalize.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# ordinalize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## ordinalize(num: Number): String

Returns a number as an ordinal, such as `1st` or `2nd`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>num</code></p></td><td><p>An input number to return as an ordinal.</p></td></tr></tbody></table>

### Example

This example returns a variety of input numbers as ordinals.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a" : ordinalize(1),
  "b": ordinalize(2),
  "c": ordinalize(5),
  "d": ordinalize(103)
}
```

#### Output

```JSON
{
   "a": "1st",
   "b": "2nd",
   "c": "5th",
   "d": "103rd"
}
```

## ordinalize(num: Null): Null

Helper function that enables `ordinalize` to work with a `null` value.

<!-- document id=324ac173d338d5ad2b42554743a3f5fb2eef49d926f908bc4f33737e83f689bf url=/mulesoft/current/en-us/dataweave/2.11/dw-runtime-functions-orelse.md -->

---
product: DataWeave
version: 2.11
---

# orElse

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## orElse<T, E, R>(previous: Result<T, E>, orElse: () -> R): T | R

Returns the result of the `orElse` argument if the `previous` argument to `try` fails. Otherwise,
the function returns the value of the `previous` argument.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>previous</code></p></td><td><p>Result from a previous call to <code>try</code>.</p></td></tr><tr><td><p><code>orElse</code></p></td><td><p>Argument to return if the <code>previous</code> argument fails.</p></td></tr></tbody></table>

### Example

This example waits shows how to chain different try

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
var user = {}
var otherUser = {name: "DW"}
output application/json
---
{
    a: try(() -> user.name!) orElse "No User Name",
    b: try(() -> otherUser.name) orElse "No User Name"
}
```

#### Output

```JSON
{
  "a": "No User Name",
  "b": "DW"
}
```

<!-- document id=77cfee68d9547dc41bae113fbda24d374576853263d8f92d380ca32e2435f1c7 url=/mulesoft/current/en-us/dataweave/2.12/dw-runtime-functions-orelse.md -->

---
product: DataWeave
version: 2.12
---

# orElse

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## orElse<T, E, R>(previous: Result<T, E>, orElse: () -> R): T | R

Returns the result of the `orElse` argument if the `previous` argument to `try` fails. Otherwise,
the function returns the value of the `previous` argument.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>previous</code></p></td><td><p>Result from a previous call to <code>try</code>.</p></td></tr><tr><td><p><code>orElse</code></p></td><td><p>Argument to return if the <code>previous</code> argument fails.</p></td></tr></tbody></table>

### Example

This example waits shows how to chain different try

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
var user = {}
var otherUser = {name: "DW"}
output application/json
---
{
    a: try(() -> user.name!) orElse "No User Name",
    b: try(() -> otherUser.name) orElse "No User Name"
}
```

#### Output

```JSON
{
  "a": "No User Name",
  "b": "DW"
}
```

<!-- document id=04c4d3806d6a3bde1eea0e3d71878b91af66b549996ccf327d6f4f9d8b7623cf url=/mulesoft/current/en-us/dataweave/2.3/dw-runtime-functions-orelse.md -->

---
product: DataWeave
version: 2.3
---

# orElse

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## orElse(TryResult<T>, () -> R): T | R

Returns the result of the `orElse` if the `previous` try result failed if not returns the result of
the `previous`

_Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>previous</code></p></td><td><p>Previous try result</p></td></tr><tr><td><p><code>orElse</code></p></td><td><p>The next option to try if the previous fails</p></td></tr></tbody></table>

### Example

This example demonstrates how to specify the next expression to evaluate after a call to `try`
fails.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
var user = {}
var otherUser = {name: "DW"}
output application/json
---
{
    a: try(() -> user.name!) orElse "No User Name",
    b: try(() -> otherUser.name) orElse "No User Name"
}
```

#### Output

```JSON
{
  "a": "No User Name",
  "b": "DW"
}
```

<!-- document id=b1c49a565508df1a7a36dbb6152943cb23a8823b276d7a6ae31623fcf7838aa9 url=/mulesoft/current/en-us/dataweave/2.4/dw-runtime-functions-orelse.md -->

---
product: DataWeave
version: 2.4
---

# orElse

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## orElse<T, R>(previous: TryResult<T>, orElse: () -> R): T | R

Returns the result of the `orElse` argument if the `previous` argument to `try` fails. Otherwise,
the function returns the value of the `previous` argument.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>previous</code></p></td><td><p>Result from a previous call to <code>try</code>.</p></td></tr><tr><td><p><code>orElse</code></p></td><td><p>Argument to return if the <code>previous</code> argument fails.</p></td></tr></tbody></table>

### Example

This example waits shows how to chain different try

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
var user = {}
var otherUser = {name: "DW"}
output application/json
---
{
    a: try(() -> user.name!) orElse "No User Name",
    b: try(() -> otherUser.name) orElse "No User Name"
}
```

#### Output

```JSON
{
  "a": "No User Name",
  "b": "DW"
}
```

<!-- document id=44549ae77b9b4f334d0b859ef222563a880fce96597dc8e70a1a1c144ee9aefe url=/mulesoft/current/en-us/dataweave/2.6/dw-runtime-functions-orelse.md -->

---
product: DataWeave
version: 2.6
---

# orElse

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## orElse<T, R>(previous: TryResult<T>, orElse: () -> R): T | R

Returns the result of the `orElse` argument if the `previous` argument to `try` fails. Otherwise,
the function returns the value of the `previous` argument.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>previous</code></p></td><td><p>Result from a previous call to <code>try</code>.</p></td></tr><tr><td><p><code>orElse</code></p></td><td><p>Argument to return if the <code>previous</code> argument fails.</p></td></tr></tbody></table>

### Example

This example waits shows how to chain different try

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
var user = {}
var otherUser = {name: "DW"}
output application/json
---
{
    a: try(() -> user.name!) orElse "No User Name",
    b: try(() -> otherUser.name) orElse "No User Name"
}
```

#### Output

```JSON
{
  "a": "No User Name",
  "b": "DW"
}
```

<!-- document id=89e5f835d47c93c3169d1a51a7c040509444124f62575745c81d464baf5031d5 url=/mulesoft/current/en-us/dataweave/2.9/dw-runtime-functions-orelse.md -->

---
product: DataWeave
version: 2.9
---

# orElse

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## orElse<T, E, R>(previous: Result<T, E>, orElse: () -> R): T | R

Returns the result of the `orElse` argument if the `previous` argument to `try` fails. Otherwise,
the function returns the value of the `previous` argument.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>previous</code></p></td><td><p>Result from a previous call to <code>try</code>.</p></td></tr><tr><td><p><code>orElse</code></p></td><td><p>Argument to return if the <code>previous</code> argument fails.</p></td></tr></tbody></table>

### Example

This example waits shows how to chain different try

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
var user = {}
var otherUser = {name: "DW"}
output application/json
---
{
    a: try(() -> user.name!) orElse "No User Name",
    b: try(() -> otherUser.name) orElse "No User Name"
}
```

#### Output

```JSON
{
  "a": "No User Name",
  "b": "DW"
}
```

<!-- document id=993c2310eea301f8c410b53fd35c5752e924a0ec7da6ad9497026b75b3d1d62f url=/mulesoft/current/en-us/dataweave/latest/dw-runtime-functions-orelse.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# orElse

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## orElse<T, E, R>(previous: Result<T, E>, orElse: () -> R): T | R

Returns the result of the `orElse` argument if the `previous` argument to `try` fails. Otherwise,
the function returns the value of the `previous` argument.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>previous</code></p></td><td><p>Result from a previous call to <code>try</code>.</p></td></tr><tr><td><p><code>orElse</code></p></td><td><p>Argument to return if the <code>previous</code> argument fails.</p></td></tr></tbody></table>

### Example

This example waits shows how to chain different try

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
var user = {}
var otherUser = {name: "DW"}
output application/json
---
{
    a: try(() -> user.name!) orElse "No User Name",
    b: try(() -> otherUser.name) orElse "No User Name"
}
```

#### Output

```JSON
{
  "a": "No User Name",
  "b": "DW"
}
```

<!-- document id=6fbc3ae3728bf81fe58d9f066cdbc3134fd988efd53d8bc065245ec5c30d4929 url=/mulesoft/current/en-us/dataweave/2.11/dw-runtime-functions-orelsetry.md -->

---
product: DataWeave
version: 2.11
---

# orElseTry

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## orElseTry<T, R>(previous: TryResult<T>, orElse: () -> R): TryResult<T | R>

Function to use with `try` to chain multiple `try` requests.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>previous</code></p></td><td><p>Result from a previous call to <code>try</code>.</p></td></tr><tr><td><p><code>orElseTry</code></p></td><td><p>Argument to try if the <code>previous</code> argument fails.</p></td></tr></tbody></table>

### Example

This example waits shows how to chain different try

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
var user = {}
var otherUser = {}
output application/json
---
{
    a: try(() -> user.name!) orElseTry otherUser.name!,
    b: try(() -> user.name!) orElseTry "No User Name"
}
```

#### Output

```JSON
{
  "a": {
    "success": false,
    "error": {
      "kind": "KeyNotFoundException",
      "message": "There is no key named 'name'",
      "location": "\n9|     a: try(() -> user.name!) orElseTry otherUser.name!,\n                                          ^^^^^^^^^^^^^^",
      "stack": [
        "main (org::mule::weave::v2::engine::transform:9:40)"
      ]
    }
  },
  "b": {
    "success": true,
    "result": "No User Name"
  }
}
```

<!-- document id=7f859a896f57ddaaf4ba53fa0e669adc8a26c58aa838cb3afa4c15e1cf2cde32 url=/mulesoft/current/en-us/dataweave/2.12/dw-runtime-functions-orelsetry.md -->

---
product: DataWeave
version: 2.12
---

# orElseTry

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## orElseTry<T, R>(previous: TryResult<T>, orElse: () -> R): TryResult<T | R>

Function to use with `try` to chain multiple `try` requests.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>previous</code></p></td><td><p>Result from a previous call to <code>try</code>.</p></td></tr><tr><td><p><code>orElseTry</code></p></td><td><p>Argument to try if the <code>previous</code> argument fails.</p></td></tr></tbody></table>

### Example

This example waits shows how to chain different try

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
var user = {}
var otherUser = {}
output application/json
---
{
    a: try(() -> user.name!) orElseTry otherUser.name!,
    b: try(() -> user.name!) orElseTry "No User Name"
}
```

#### Output

```JSON
{
  "a": {
    "success": false,
    "error": {
      "kind": "KeyNotFoundException",
      "message": "There is no key named 'name'",
      "location": "\n9|     a: try(() -> user.name!) orElseTry otherUser.name!,\n                                          ^^^^^^^^^^^^^^",
      "stack": [
        "main (org::mule::weave::v2::engine::transform:9:40)"
      ]
    }
  },
  "b": {
    "success": true,
    "result": "No User Name"
  }
}
```

<!-- document id=fe8f96edd1a98aff733688c699ad47a01f127f4f2a4e011e06b1f77d8a1a550a url=/mulesoft/current/en-us/dataweave/2.3/dw-runtime-functions-orelsetry.md -->

---
product: DataWeave
version: 2.3
---

# orElseTry

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## orElseTry(TryResult<T>, () -> R): TryResult<T | R>

Function to be use with try in order to chain multiple `try`

_Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>previous</code></p></td><td><p>Previous try result</p></td></tr><tr><td><p><code>orElse</code></p></td><td><p>The next option to try if the previous fails</p></td></tr></tbody></table>

### Example

This example waits shows how to chain different try

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
var user = {}
var otherUser = {}
output application/json
---
{
    a: try(() -> user.name!) orElseTry otherUser.name!,
    b: try(() -> user.name!) orElseTry "No User Name"
}
```

#### Output

```JSON
{
  "a": {
    "success": false,
    "error": {
      "kind": "KeyNotFoundException",
      "message": "There is no key named 'name'",
      "location": "\n9|     a: try(() -> user.name!) orElseTry otherUser.name!,\n                                          ^^^^^^^^^^^^^^",
      "stack": [
        "main (org::mule::weave::v2::engine::transform:9:40)"
      ]
    }
  },
  "b": {
    "success": true,
    "result": "No User Name"
  }
}
```

<!-- document id=f328af0bcde80fce2b9120918a5f017a20c7a9326e23b8d2ad493da3ad85675a url=/mulesoft/current/en-us/dataweave/2.4/dw-runtime-functions-orelsetry.md -->

---
product: DataWeave
version: 2.4
---

# orElseTry

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## orElseTry<T, R>(previous: TryResult<T>, orElse: () -> R): TryResult<T | R>

Function to use with `try` to chain multiple `try` requests.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>previous</code></p></td><td><p>Result from a previous call to <code>try</code>.</p></td></tr><tr><td><p><code>orElseTry</code></p></td><td><p>Argument to try if the <code>previous</code> argument fails.</p></td></tr></tbody></table>

### Example

This example waits shows how to chain different try

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
var user = {}
var otherUser = {}
output application/json
---
{
    a: try(() -> user.name!) orElseTry otherUser.name!,
    b: try(() -> user.name!) orElseTry "No User Name"
}
```

#### Output

```JSON
{
  "a": {
    "success": false,
    "error": {
      "kind": "KeyNotFoundException",
      "message": "There is no key named 'name'",
      "location": "\n9|     a: try(() -> user.name!) orElseTry otherUser.name!,\n                                          ^^^^^^^^^^^^^^",
      "stack": [
        "main (org::mule::weave::v2::engine::transform:9:40)"
      ]
    }
  },
  "b": {
    "success": true,
    "result": "No User Name"
  }
}
```

<!-- document id=f0360a6a7e6b132378fd8db0f030aabcb8044f36d70df0664e7dcc97aa604baf url=/mulesoft/current/en-us/dataweave/2.6/dw-runtime-functions-orelsetry.md -->

---
product: DataWeave
version: 2.6
---

# orElseTry

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## orElseTry<T, R>(previous: TryResult<T>, orElse: () -> R): TryResult<T | R>

Function to use with `try` to chain multiple `try` requests.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>previous</code></p></td><td><p>Result from a previous call to <code>try</code>.</p></td></tr><tr><td><p><code>orElseTry</code></p></td><td><p>Argument to try if the <code>previous</code> argument fails.</p></td></tr></tbody></table>

### Example

This example waits shows how to chain different try

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
var user = {}
var otherUser = {}
output application/json
---
{
    a: try(() -> user.name!) orElseTry otherUser.name!,
    b: try(() -> user.name!) orElseTry "No User Name"
}
```

#### Output

```JSON
{
  "a": {
    "success": false,
    "error": {
      "kind": "KeyNotFoundException",
      "message": "There is no key named 'name'",
      "location": "\n9|     a: try(() -> user.name!) orElseTry otherUser.name!,\n                                          ^^^^^^^^^^^^^^",
      "stack": [
        "main (org::mule::weave::v2::engine::transform:9:40)"
      ]
    }
  },
  "b": {
    "success": true,
    "result": "No User Name"
  }
}
```

<!-- document id=d8fa4052bdee8d58185b2df59e1043385f762b13371fd2473c121c4e7b882d32 url=/mulesoft/current/en-us/dataweave/2.9/dw-runtime-functions-orelsetry.md -->

---
product: DataWeave
version: 2.9
---

# orElseTry

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## orElseTry<T, R>(previous: TryResult<T>, orElse: () -> R): TryResult<T | R>

Function to use with `try` to chain multiple `try` requests.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>previous</code></p></td><td><p>Result from a previous call to <code>try</code>.</p></td></tr><tr><td><p><code>orElseTry</code></p></td><td><p>Argument to try if the <code>previous</code> argument fails.</p></td></tr></tbody></table>

### Example

This example waits shows how to chain different try

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
var user = {}
var otherUser = {}
output application/json
---
{
    a: try(() -> user.name!) orElseTry otherUser.name!,
    b: try(() -> user.name!) orElseTry "No User Name"
}
```

#### Output

```JSON
{
  "a": {
    "success": false,
    "error": {
      "kind": "KeyNotFoundException",
      "message": "There is no key named 'name'",
      "location": "\n9|     a: try(() -> user.name!) orElseTry otherUser.name!,\n                                          ^^^^^^^^^^^^^^",
      "stack": [
        "main (org::mule::weave::v2::engine::transform:9:40)"
      ]
    }
  },
  "b": {
    "success": true,
    "result": "No User Name"
  }
}
```

<!-- document id=0fefb3fb4b90f7832cb7543cae8fe31658a97d807838603a2092c6fca816263d url=/mulesoft/current/en-us/dataweave/latest/dw-runtime-functions-orelsetry.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# orElseTry

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## orElseTry<T, R>(previous: TryResult<T>, orElse: () -> R): TryResult<T | R>

Function to use with `try` to chain multiple `try` requests.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>previous</code></p></td><td><p>Result from a previous call to <code>try</code>.</p></td></tr><tr><td><p><code>orElseTry</code></p></td><td><p>Argument to try if the <code>previous</code> argument fails.</p></td></tr></tbody></table>

### Example

This example waits shows how to chain different try

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
var user = {}
var otherUser = {}
output application/json
---
{
    a: try(() -> user.name!) orElseTry otherUser.name!,
    b: try(() -> user.name!) orElseTry "No User Name"
}
```

#### Output

```JSON
{
  "a": {
    "success": false,
    "error": {
      "kind": "KeyNotFoundException",
      "message": "There is no key named 'name'",
      "location": "\n9|     a: try(() -> user.name!) orElseTry otherUser.name!,\n                                          ^^^^^^^^^^^^^^",
      "stack": [
        "main (org::mule::weave::v2::engine::transform:9:40)"
      ]
    }
  },
  "b": {
    "success": true,
    "result": "No User Name"
  }
}
```

<!-- document id=686a212a8728f14610b7d13659c0b8e4daf75c534d10cb8ef1acadfab3ae4d30 url=/mulesoft/current/en-us/dataweave/2.11/dw-arrays-functions-outerjoin.md -->

---
product: DataWeave
version: 2.11
---

# outerJoin

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## outerJoin<L <: Object, R <: Object>(left: Array<L>, right: Array<R>, leftCriteria: (leftValue: L) -> String, rightCriteria: (rightValue: R) -> String): Array<{ l?: L, r?: R }>

Joins two array of objects by a given `ID` criteria.

`outerJoin` returns an array with all the `left` items, merged by ID with the `right` items in cases
where any exist, and it returns `right` items that are not present in the `left`.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>left</code></p></td><td><p>The left-side array of objects.</p></td></tr><tr><td><p><code>right</code></p></td><td><p>The right-side array of objects.</p></td></tr><tr><td><p><code>leftCriteria</code></p></td><td><p>The criteria used to extract the ID for the left collection.</p></td></tr><tr><td><p><code>rightCriteria</code></p></td><td><p>The criteria used to extract the ID for the right collection.</p></td></tr></tbody></table>

### Example

This example shows how join behaves. Notice that the output includes objects where the values of the
input `user.id` and `product.ownerId` match, and it includes objects where there is no match for the
value of the `user.id` or `product.ownerId`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
var users = [{id: "1", name:"Mariano"},{id: "2", name:"Leandro"},{id: "3", name:"Julian"},{id: "5", name:"Julian"}]
var products = [{ownerId: "1", name:"DataWeave"},{ownerId: "1", name:"BAT"}, {ownerId: "3", name:"DataSense"}, {ownerId: "4", name:"SmartConnectors"}]
output application/json
---
outerJoin(users, products, (user) -> user.id, (product) -> product.ownerId)
```

#### Output

```json
[
  {
    "l": {
      "id": "1",
      "name": "Mariano"
    },
    "r": {
      "ownerId": "1",
      "name": "DataWeave"
    }
  },
  {
    "l": {
      "id": "1",
      "name": "Mariano"
    },
    "r": {
      "ownerId": "1",
      "name": "BAT"
    }
  },
  {
    "l": {
      "id": "2",
      "name": "Leandro"
    }
  },
  {
    "l": {
      "id": "3",
      "name": "Julian"
    },
    "r": {
      "ownerId": "3",
      "name": "DataSense"
    }
  },
  {
    "l": {
      "id": "5",
      "name": "Julian"
    }
  },
  {
    "r": {
      "ownerId": "4",
      "name": "SmartConnectors"
    }
  }
]
```

<!-- document id=c8f52b7aea25b697cf82fe8719c9fbbffec06afdb84d5f661e8a0c95b056e4f8 url=/mulesoft/current/en-us/dataweave/2.12/dw-arrays-functions-outerjoin.md -->

---
product: DataWeave
version: 2.12
---

# outerJoin

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## outerJoin<L <: Object, R <: Object>(left: Array<L>, right: Array<R>, leftCriteria: (leftValue: L) -> String, rightCriteria: (rightValue: R) -> String): Array<{ l?: L, r?: R }>

Joins two array of objects by a given `ID` criteria.

`outerJoin` returns an array with all the `left` items, merged by ID with the `right` items in cases
where any exist, and it returns `right` items that are not present in the `left`.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>left</code></p></td><td><p>The left-side array of objects.</p></td></tr><tr><td><p><code>right</code></p></td><td><p>The right-side array of objects.</p></td></tr><tr><td><p><code>leftCriteria</code></p></td><td><p>The criteria used to extract the ID for the left collection.</p></td></tr><tr><td><p><code>rightCriteria</code></p></td><td><p>The criteria used to extract the ID for the right collection.</p></td></tr></tbody></table>

### Example

This example shows how join behaves. Notice that the output includes objects where the values of the
input `user.id` and `product.ownerId` match, and it includes objects where there is no match for the
value of the `user.id` or `product.ownerId`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
var users = [{id: "1", name:"Mariano"},{id: "2", name:"Leandro"},{id: "3", name:"Julian"},{id: "5", name:"Julian"}]
var products = [{ownerId: "1", name:"DataWeave"},{ownerId: "1", name:"BAT"}, {ownerId: "3", name:"DataSense"}, {ownerId: "4", name:"SmartConnectors"}]
output application/json
---
outerJoin(users, products, (user) -> user.id, (product) -> product.ownerId)
```

#### Output

```json
[
  {
    "l": {
      "id": "1",
      "name": "Mariano"
    },
    "r": {
      "ownerId": "1",
      "name": "DataWeave"
    }
  },
  {
    "l": {
      "id": "1",
      "name": "Mariano"
    },
    "r": {
      "ownerId": "1",
      "name": "BAT"
    }
  },
  {
    "l": {
      "id": "2",
      "name": "Leandro"
    }
  },
  {
    "l": {
      "id": "3",
      "name": "Julian"
    },
    "r": {
      "ownerId": "3",
      "name": "DataSense"
    }
  },
  {
    "l": {
      "id": "5",
      "name": "Julian"
    }
  },
  {
    "r": {
      "ownerId": "4",
      "name": "SmartConnectors"
    }
  }
]
```

<!-- document id=2493ae6fa0f97e8c905aa4fa552d633e31ee1ba56eded73de9da16e9a284ca08 url=/mulesoft/current/en-us/dataweave/2.3/dw-arrays-functions-outerjoin.md -->

---
product: DataWeave
version: 2.3
---

# outerJoin

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## outerJoin(Array<L>, Array<R>, (leftValue: L) -> String, (rightValue: R) -> String): Array<{ l?: L, r?: R }>

Joins two array of objects by a given `ID` criteria.

`outerJoin` returns an array with all the `left` items, merged by ID with the `right` items in cases
where any exist, and it returns `right` items that are not present in the `left`.

_Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>left</code></p></td><td><p>The left-side array of objects.</p></td></tr><tr><td><p><code>right</code></p></td><td><p>The right-side array of objects.</p></td></tr><tr><td><p><code>leftCriteria</code></p></td><td><p>The criteria used to extract the ID for the left collection.</p></td></tr><tr><td><p><code>rightCriteria</code></p></td><td><p>The criteria used to extract the ID for the right collection.</p></td></tr></tbody></table>

### Example

This example shows how join behaves. Notice that the output includes objects where the values of the
input `user.id` and `product.ownerId` match, and it includes objects where there is no match for the
value of the `user.id` or `product.ownerId`.

#### Source

```DataWeave
 %dw 2.0
 import * from dw::core::Arrays
 var users = [{id: "1", name:"Mariano"},{id: "2", name:"Leandro"},{id: "3", name:"Julian"},{id: "5", name:"Julian"}]
 var products = [{ownerId: "1", name:"DataWeave"},{ownerId: "1", name:"BAT"}, {ownerId: "3", name:"DataSense"}, {ownerId: "4", name:"SmartConnectors"}]
 output application/json
 ---
 outerJoin(users, products, (user) -> user.id, (product) -> product.ownerId)
```

#### Output

```json
[
  {
    "l": {
      "id": "1",
      "name": "Mariano"
    },
    "r": {
      "ownerId": "1",
      "name": "DataWeave"
    }
  },
  {
    "l": {
      "id": "1",
      "name": "Mariano"
    },
    "r": {
      "ownerId": "1",
      "name": "BAT"
    }
  },
  {
    "l": {
      "id": "2",
      "name": "Leandro"
    }
  },
  {
    "l": {
      "id": "3",
      "name": "Julian"
    },
    "r": {
      "ownerId": "3",
      "name": "DataSense"
    }
  },
  {
    "l": {
      "id": "5",
      "name": "Julian"
    }
  },
  {
    "r": {
      "ownerId": "4",
      "name": "SmartConnectors"
    }
  }
]
```

<!-- document id=629d3b1bbfe18dd2f74fa0caebf60298d49155aa422ca7021180e0391db8b3c8 url=/mulesoft/current/en-us/dataweave/2.4/dw-arrays-functions-outerjoin.md -->

---
product: DataWeave
version: 2.4
---

# outerJoin

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## outerJoin<L <: Object, R <: Object>(left: Array<L>, right: Array<R>, leftCriteria: (leftValue: L) -> String, rightCriteria: (rightValue: R) -> String): Array<{ l?: L, r?: R }>

Joins two array of objects by a given `ID` criteria.

`outerJoin` returns an array with all the `left` items, merged by ID with the `right` items in cases
where any exist, and it returns `right` items that are not present in the `left`.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>left</code></p></td><td><p>The left-side array of objects.</p></td></tr><tr><td><p><code>right</code></p></td><td><p>The right-side array of objects.</p></td></tr><tr><td><p><code>leftCriteria</code></p></td><td><p>The criteria used to extract the ID for the left collection.</p></td></tr><tr><td><p><code>rightCriteria</code></p></td><td><p>The criteria used to extract the ID for the right collection.</p></td></tr></tbody></table>

### Example

This example shows how join behaves. Notice that the output includes objects where the values of the
input `user.id` and `product.ownerId` match, and it includes objects where there is no match for the
value of the `user.id` or `product.ownerId`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
var users = [{id: "1", name:"Mariano"},{id: "2", name:"Leandro"},{id: "3", name:"Julian"},{id: "5", name:"Julian"}]
var products = [{ownerId: "1", name:"DataWeave"},{ownerId: "1", name:"BAT"}, {ownerId: "3", name:"DataSense"}, {ownerId: "4", name:"SmartConnectors"}]
output application/json
---
outerJoin(users, products, (user) -> user.id, (product) -> product.ownerId)
```

#### Output

```json
[
  {
    "l": {
      "id": "1",
      "name": "Mariano"
    },
    "r": {
      "ownerId": "1",
      "name": "DataWeave"
    }
  },
  {
    "l": {
      "id": "1",
      "name": "Mariano"
    },
    "r": {
      "ownerId": "1",
      "name": "BAT"
    }
  },
  {
    "l": {
      "id": "2",
      "name": "Leandro"
    }
  },
  {
    "l": {
      "id": "3",
      "name": "Julian"
    },
    "r": {
      "ownerId": "3",
      "name": "DataSense"
    }
  },
  {
    "l": {
      "id": "5",
      "name": "Julian"
    }
  },
  {
    "r": {
      "ownerId": "4",
      "name": "SmartConnectors"
    }
  }
]
```

<!-- document id=2aa36dd5387991082d9f1c0e8329d3eadb0decc1c76a82621674eb214550b672 url=/mulesoft/current/en-us/dataweave/2.6/dw-arrays-functions-outerjoin.md -->

---
product: DataWeave
version: 2.6
---

# outerJoin

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## outerJoin<L <: Object, R <: Object>(left: Array<L>, right: Array<R>, leftCriteria: (leftValue: L) -> String, rightCriteria: (rightValue: R) -> String): Array<{ l?: L, r?: R }>

Joins two array of objects by a given `ID` criteria.

`outerJoin` returns an array with all the `left` items, merged by ID with the `right` items in cases
where any exist, and it returns `right` items that are not present in the `left`.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>left</code></p></td><td><p>The left-side array of objects.</p></td></tr><tr><td><p><code>right</code></p></td><td><p>The right-side array of objects.</p></td></tr><tr><td><p><code>leftCriteria</code></p></td><td><p>The criteria used to extract the ID for the left collection.</p></td></tr><tr><td><p><code>rightCriteria</code></p></td><td><p>The criteria used to extract the ID for the right collection.</p></td></tr></tbody></table>

### Example

This example shows how join behaves. Notice that the output includes objects where the values of the
input `user.id` and `product.ownerId` match, and it includes objects where there is no match for the
value of the `user.id` or `product.ownerId`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
var users = [{id: "1", name:"Mariano"},{id: "2", name:"Leandro"},{id: "3", name:"Julian"},{id: "5", name:"Julian"}]
var products = [{ownerId: "1", name:"DataWeave"},{ownerId: "1", name:"BAT"}, {ownerId: "3", name:"DataSense"}, {ownerId: "4", name:"SmartConnectors"}]
output application/json
---
outerJoin(users, products, (user) -> user.id, (product) -> product.ownerId)
```

#### Output

```json
[
  {
    "l": {
      "id": "1",
      "name": "Mariano"
    },
    "r": {
      "ownerId": "1",
      "name": "DataWeave"
    }
  },
  {
    "l": {
      "id": "1",
      "name": "Mariano"
    },
    "r": {
      "ownerId": "1",
      "name": "BAT"
    }
  },
  {
    "l": {
      "id": "2",
      "name": "Leandro"
    }
  },
  {
    "l": {
      "id": "3",
      "name": "Julian"
    },
    "r": {
      "ownerId": "3",
      "name": "DataSense"
    }
  },
  {
    "l": {
      "id": "5",
      "name": "Julian"
    }
  },
  {
    "r": {
      "ownerId": "4",
      "name": "SmartConnectors"
    }
  }
]
```

<!-- document id=8eb8af922a5dc4a0e3a55e303f903ff0c66d73102df9dbc47bafd5f942e28c4e url=/mulesoft/current/en-us/dataweave/2.9/dw-arrays-functions-outerjoin.md -->

---
product: DataWeave
version: 2.9
---

# outerJoin

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## outerJoin<L <: Object, R <: Object>(left: Array<L>, right: Array<R>, leftCriteria: (leftValue: L) -> String, rightCriteria: (rightValue: R) -> String): Array<{ l?: L, r?: R }>

Joins two array of objects by a given `ID` criteria.

`outerJoin` returns an array with all the `left` items, merged by ID with the `right` items in cases
where any exist, and it returns `right` items that are not present in the `left`.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>left</code></p></td><td><p>The left-side array of objects.</p></td></tr><tr><td><p><code>right</code></p></td><td><p>The right-side array of objects.</p></td></tr><tr><td><p><code>leftCriteria</code></p></td><td><p>The criteria used to extract the ID for the left collection.</p></td></tr><tr><td><p><code>rightCriteria</code></p></td><td><p>The criteria used to extract the ID for the right collection.</p></td></tr></tbody></table>

### Example

This example shows how join behaves. Notice that the output includes objects where the values of the
input `user.id` and `product.ownerId` match, and it includes objects where there is no match for the
value of the `user.id` or `product.ownerId`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
var users = [{id: "1", name:"Mariano"},{id: "2", name:"Leandro"},{id: "3", name:"Julian"},{id: "5", name:"Julian"}]
var products = [{ownerId: "1", name:"DataWeave"},{ownerId: "1", name:"BAT"}, {ownerId: "3", name:"DataSense"}, {ownerId: "4", name:"SmartConnectors"}]
output application/json
---
outerJoin(users, products, (user) -> user.id, (product) -> product.ownerId)
```

#### Output

```json
[
  {
    "l": {
      "id": "1",
      "name": "Mariano"
    },
    "r": {
      "ownerId": "1",
      "name": "DataWeave"
    }
  },
  {
    "l": {
      "id": "1",
      "name": "Mariano"
    },
    "r": {
      "ownerId": "1",
      "name": "BAT"
    }
  },
  {
    "l": {
      "id": "2",
      "name": "Leandro"
    }
  },
  {
    "l": {
      "id": "3",
      "name": "Julian"
    },
    "r": {
      "ownerId": "3",
      "name": "DataSense"
    }
  },
  {
    "l": {
      "id": "5",
      "name": "Julian"
    }
  },
  {
    "r": {
      "ownerId": "4",
      "name": "SmartConnectors"
    }
  }
]
```

<!-- document id=9f54ec306a5ea90949d07e765c4a2f7b7983e6e427f62be900edf3ddaf7bfd83 url=/mulesoft/current/en-us/dataweave/latest/dw-arrays-functions-outerjoin.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# outerJoin

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## outerJoin<L <: Object, R <: Object>(left: Array<L>, right: Array<R>, leftCriteria: (leftValue: L) -> String, rightCriteria: (rightValue: R) -> String): Array<{ l?: L, r?: R }>

Joins two array of objects by a given `ID` criteria.

`outerJoin` returns an array with all the `left` items, merged by ID with the `right` items in cases
where any exist, and it returns `right` items that are not present in the `left`.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>left</code></p></td><td><p>The left-side array of objects.</p></td></tr><tr><td><p><code>right</code></p></td><td><p>The right-side array of objects.</p></td></tr><tr><td><p><code>leftCriteria</code></p></td><td><p>The criteria used to extract the ID for the left collection.</p></td></tr><tr><td><p><code>rightCriteria</code></p></td><td><p>The criteria used to extract the ID for the right collection.</p></td></tr></tbody></table>

### Example

This example shows how join behaves. Notice that the output includes objects where the values of the
input `user.id` and `product.ownerId` match, and it includes objects where there is no match for the
value of the `user.id` or `product.ownerId`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
var users = [{id: "1", name:"Mariano"},{id: "2", name:"Leandro"},{id: "3", name:"Julian"},{id: "5", name:"Julian"}]
var products = [{ownerId: "1", name:"DataWeave"},{ownerId: "1", name:"BAT"}, {ownerId: "3", name:"DataSense"}, {ownerId: "4", name:"SmartConnectors"}]
output application/json
---
outerJoin(users, products, (user) -> user.id, (product) -> product.ownerId)
```

#### Output

```json
[
  {
    "l": {
      "id": "1",
      "name": "Mariano"
    },
    "r": {
      "ownerId": "1",
      "name": "DataWeave"
    }
  },
  {
    "l": {
      "id": "1",
      "name": "Mariano"
    },
    "r": {
      "ownerId": "1",
      "name": "BAT"
    }
  },
  {
    "l": {
      "id": "2",
      "name": "Leandro"
    }
  },
  {
    "l": {
      "id": "3",
      "name": "Julian"
    },
    "r": {
      "ownerId": "3",
      "name": "DataSense"
    }
  },
  {
    "l": {
      "id": "5",
      "name": "Julian"
    }
  },
  {
    "r": {
      "ownerId": "4",
      "name": "SmartConnectors"
    }
  }
]
```

<!-- document id=fcbe695f25b383e2587349f0c84da813cec92fe56fb23085c48a49209d4f0d7d url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook-output-a-field-when-present.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Output a Field When Present

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example outputs a field if it is present in the input, a JSON array. The first object
in the array contains `"insurance"`, while the second does not. The XML output mirrors this
structure.

The example uses these functions:

- `map` to go through every element within the input array.

- `if($.insurance?)` to determine when to output an `insurance` field.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
users: { (payload map
        user: {
          name: $.name,
          (insurance: $.insurance) if($.insurance?)
        } )
}
```

Input JSON Payload:

```json
[
  {
    "name": "Julian",
    "gender": "Male",
    "age": 41,
    "insurance": "Osde"
  },
  {
    "name": "Mariano",
    "gender": "Male",
    "age": 33
  }
]
```

Output XML:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<users>
  <user>
    <name>Julian</name>
    <insurance>Osde</insurance>
  </user>
  <user>
    <name>Mariano</name>
  </user>
</users>
```

## Related Examples

- [Map Data with DataWeave](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-map)

- [Exclude Fields from the Output](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-exclude-field)

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-insert-attribute)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-conditional-list-reduction-via-function)

- [Change Format According to Type](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-format-according-to-type)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.11/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.11/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook)

<!-- document id=4214d300cb480a13b2e08f27f26a84334729471c3ab995aa8fbc4ae47a93273d url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook-output-a-field-when-present.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Output a Field When Present

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example outputs a field if it is present in the input, a JSON array. The first object
in the array contains `"insurance"`, while the second does not. The XML output mirrors this
structure.

The example uses these functions:

- `map` to go through every element within the input array.

- `if($.insurance?)` to determine when to output an `insurance` field.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
users: { (payload map
        user: {
          name: $.name,
          (insurance: $.insurance) if($.insurance?)
        } )
}
```

Input JSON Payload:

```json
[
  {
    "name": "Julian",
    "gender": "Male",
    "age": 41,
    "insurance": "Osde"
  },
  {
    "name": "Mariano",
    "gender": "Male",
    "age": 33
  }
]
```

Output XML:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<users>
  <user>
    <name>Julian</name>
    <insurance>Osde</insurance>
  </user>
  <user>
    <name>Mariano</name>
  </user>
</users>
```

## Related Examples

- [Map Data with DataWeave](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-map)

- [Exclude Fields from the Output](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-exclude-field)

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-insert-attribute)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-conditional-list-reduction-via-function)

- [Change Format According to Type](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-format-according-to-type)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.12/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.12/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook)

<!-- document id=8011e074aaa8670ef7453ed675c6cba8c646e05be1352a9e0ef7845d2cee946b url=/mulesoft/current/en-us/dataweave/2.3/dataweave-cookbook-output-a-field-when-present.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Output a Field When Present

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example outputs a field if it is present in the input, a JSON array. The first object
in the array contains `"insurance"`, while the second does not. The XML output mirrors this
structure.

The example uses these functions:

- `map` to go through every element within the input array.

- `if($.insurance?)` to determine when to output an `insurance` field.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
users: { (payload map
        user: {
          name: $.name,
          (insurance: $.insurance) if($.insurance?)
        } )
}
```

Input JSON Payload:

```json
[
  {
    "name": "Julian",
    "gender": "Male",
    "age": 41,
    "insurance": "Osde"
  },
  {
    "name": "Mariano",
    "gender": "Male",
    "age": 33
  }
]
```

Output XML:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<users>
  <user>
    <name>Julian</name>
    <insurance>Osde</insurance>
  </user>
  <user>
    <name>Mariano</name>
  </user>
</users>
```

## Related Examples

- [Map Data with DataWeave](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-map)

- [Exclude Fields from the Output](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-exclude-field)

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-insert-attribute)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-conditional-list-reduction-via-function)

- [Change Format According to Type](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-format-according-to-type)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.3/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.3/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook)

<!-- document id=22984e248c13f927a8740f289425bed3a19e019ef7c30e243acd251511512fd8 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook-output-a-field-when-present.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Output a Field When Present

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example outputs a field if it is present in the input, a JSON array. The first object
in the array contains `"insurance"`, while the second does not. The XML output mirrors this
structure.

The example uses these functions:

- `map` to go through every element within the input array.

- `if($.insurance?)` to determine when to output an `insurance` field.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
users: { (payload map
        user: {
          name: $.name,
          (insurance: $.insurance) if($.insurance?)
        } )
}
```

Input JSON Payload:

```json
[
  {
    "name": "Julian",
    "gender": "Male",
    "age": 41,
    "insurance": "Osde"
  },
  {
    "name": "Mariano",
    "gender": "Male",
    "age": 33
  }
]
```

Output XML:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<users>
  <user>
    <name>Julian</name>
    <insurance>Osde</insurance>
  </user>
  <user>
    <name>Mariano</name>
  </user>
</users>
```

## Related Examples

- [Map Data with DataWeave](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-map)

- [Exclude Fields from the Output](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-exclude-field)

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-insert-attribute)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-conditional-list-reduction-via-function)

- [Change Format According to Type](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-format-according-to-type)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.4/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.4/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook)

<!-- document id=7a45915f36e2a5b95606de14c60dd7cac81cf2cc6151b956222301eb5b3d2052 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook-output-a-field-when-present.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Output a Field When Present

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example outputs a field if it is present in the input, a JSON array. The first object
in the array contains `"insurance"`, while the second does not. The XML output mirrors this
structure.

The example uses these functions:

- `map` to go through every element within the input array.

- `if($.insurance?)` to determine when to output an `insurance` field.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
users: { (payload map
        user: {
          name: $.name,
          (insurance: $.insurance) if($.insurance?)
        } )
}
```

Input JSON Payload:

```json
[
  {
    "name": "Julian",
    "gender": "Male",
    "age": 41,
    "insurance": "Osde"
  },
  {
    "name": "Mariano",
    "gender": "Male",
    "age": 33
  }
]
```

Output XML:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<users>
  <user>
    <name>Julian</name>
    <insurance>Osde</insurance>
  </user>
  <user>
    <name>Mariano</name>
  </user>
</users>
```

## Related Examples

- [Map Data with DataWeave](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-map)

- [Exclude Fields from the Output](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-exclude-field)

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-insert-attribute)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-conditional-list-reduction-via-function)

- [Change Format According to Type](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-format-according-to-type)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.6/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.6/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook)

<!-- document id=c69e4006fed9ab5a34db658775640f6e8394dfc7b86339252f0a471a9554d7cd url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook-output-a-field-when-present.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Output a Field When Present

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example outputs a field if it is present in the input, a JSON array. The first object
in the array contains `"insurance"`, while the second does not. The XML output mirrors this
structure.

The example uses these functions:

- `map` to go through every element within the input array.

- `if($.insurance?)` to determine when to output an `insurance` field.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
users: { (payload map
        user: {
          name: $.name,
          (insurance: $.insurance) if($.insurance?)
        } )
}
```

Input JSON Payload:

```json
[
  {
    "name": "Julian",
    "gender": "Male",
    "age": 41,
    "insurance": "Osde"
  },
  {
    "name": "Mariano",
    "gender": "Male",
    "age": 33
  }
]
```

Output XML:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<users>
  <user>
    <name>Julian</name>
    <insurance>Osde</insurance>
  </user>
  <user>
    <name>Mariano</name>
  </user>
</users>
```

## Related Examples

- [Map Data with DataWeave](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-map)

- [Exclude Fields from the Output](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-exclude-field)

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-insert-attribute)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-conditional-list-reduction-via-function)

- [Change Format According to Type](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-format-according-to-type)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.9/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.9/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook)

<!-- document id=b928023f0014b1da73a82df169045eac04570cc2c6f9e53391c41b0a3143ee62 url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook-output-a-field-when-present.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Output a Field When Present

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example outputs a field if it is present in the input, a JSON array. The first object
in the array contains `"insurance"`, while the second does not. The XML output mirrors this
structure.

The example uses these functions:

- `map` to go through every element within the input array.

- `if($.insurance?)` to determine when to output an `insurance` field.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
users: { (payload map
        user: {
          name: $.name,
          (insurance: $.insurance) if($.insurance?)
        } )
}
```

Input JSON Payload:

```json
[
  {
    "name": "Julian",
    "gender": "Male",
    "age": 41,
    "insurance": "Osde"
  },
  {
    "name": "Mariano",
    "gender": "Male",
    "age": 33
  }
]
```

Output XML:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<users>
  <user>
    <name>Julian</name>
    <insurance>Osde</insurance>
  </user>
  <user>
    <name>Mariano</name>
  </user>
</users>
```

## Related Examples

- [Map Data with DataWeave](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-map)

- [Exclude Fields from the Output](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-exclude-field)

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-insert-attribute)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-conditional-list-reduction-via-function)

- [Change Format According to Type](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-format-according-to-type)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/latest/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook)

<!-- document id=04dddd53842bd59bb18b476f5ad9070a7d7d82095b258bee140d10c1578960d8 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook-output-self-closing-xml-tags.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Output Self-closing XML Tags

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

For XML, DataWeave by default outputs every value within an opening and closing tag, even if the tag
contains no value (for example, `<element2></element2>`).

To output empty tags as a self-closing XML element (for example, `<element2/>`), you can set the
`inlineCloseOn="empty"` output directive in the DataWeave header.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml inlineCloseOn="empty"
---
payload
```

Input JSON Payload:

```json
{
  "customer": {
    "userName": "John Doe",
    "password": {},
    "status": "active",
    "lastLogin": {}
  }
}
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<customer>
  <userName>John Doe</userName>
  <password/>
  <status>active</status>
  <lastLogin/>
</customer>
```

## Related Examples

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-insert-attribute)

- [Remove Specified XML Attributes](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-remove-certain-xml-attributes)

- [Include XML Namespaces](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-include-xml-namespaces)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.11/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook)

<!-- document id=2e6783b914da743927b4074dfce1fcfb0a61fb0fde0498c921e0351bbb86e0b6 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook-output-self-closing-xml-tags.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Output Self-closing XML Tags

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

For XML, DataWeave by default outputs every value within an opening and closing tag, even if the tag
contains no value (for example, `<element2></element2>`).

To output empty tags as a self-closing XML element (for example, `<element2/>`), you can set the
`inlineCloseOn="empty"` output directive in the DataWeave header.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml inlineCloseOn="empty"
---
payload
```

Input JSON Payload:

```json
{
  "customer": {
    "userName": "John Doe",
    "password": {},
    "status": "active",
    "lastLogin": {}
  }
}
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<customer>
  <userName>John Doe</userName>
  <password/>
  <status>active</status>
  <lastLogin/>
</customer>
```

## Related Examples

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-insert-attribute)

- [Remove Specified XML Attributes](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-remove-certain-xml-attributes)

- [Include XML Namespaces](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-include-xml-namespaces)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.12/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook)

<!-- document id=cb114022811c31d66c0a592b1ef858506f971a67d0913c8cc1a61af1d016eac0 url=/mulesoft/current/en-us/dataweave/2.3/dataweave-cookbook-output-self-closing-xml-tags.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Output Self-closing XML Tags

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

For XML, DataWeave by default outputs every value within an opening and closing tag, even if the tag
contains no value (for example, `<element2></element2>`).

To output empty tags as a self-closing XML element (for example, `<element2/>`), you can set the
`inlineCloseOn="empty"` output directive in the DataWeave header.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml inlineCloseOn="empty"
---
payload
```

Input JSON Payload:

```json
{
  "customer": {
    "userName": "John Doe",
    "password": {},
    "status": "active",
    "lastLogin": {}
  }
}
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<customer>
  <userName>John Doe</userName>
  <password/>
  <status>active</status>
  <lastLogin/>
</customer>
```

## Related Examples

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-insert-attribute)

- [Remove Specified XML Attributes](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-remove-certain-xml-attributes)

- [Include XML Namespaces](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-include-xml-namespaces)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.3/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook)

<!-- document id=430e19a1d81e3c7a9a5fa7ae33b6be74024c5c526a7df160451b2a84f5c1fcf1 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook-output-self-closing-xml-tags.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Output Self-closing XML Tags

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

For XML, DataWeave by default outputs every value within an opening and closing tag, even if the tag
contains no value (for example, `<element2></element2>`).

To output empty tags as a self-closing XML element (for example, `<element2/>`), you can set the
`inlineCloseOn="empty"` output directive in the DataWeave header.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml inlineCloseOn="empty"
---
payload
```

Input JSON Payload:

```json
{
  "customer": {
    "userName": "John Doe",
    "password": {},
    "status": "active",
    "lastLogin": {}
  }
}
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<customer>
  <userName>John Doe</userName>
  <password/>
  <status>active</status>
  <lastLogin/>
</customer>
```

## Related Examples

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-insert-attribute)

- [Remove Specified XML Attributes](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-remove-certain-xml-attributes)

- [Include XML Namespaces](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-include-xml-namespaces)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.4/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook)

<!-- document id=2c7c7e68e022406a89795eb8a6d5c1712fc81bdb6fd10b61f62d92e900c01e6c url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook-output-self-closing-xml-tags.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Output Self-closing XML Tags

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

For XML, DataWeave by default outputs every value within an opening and closing tag, even if the tag
contains no value (for example, `<element2></element2>`).

To output empty tags as a self-closing XML element (for example, `<element2/>`), you can set the
`inlineCloseOn="empty"` output directive in the DataWeave header.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml inlineCloseOn="empty"
---
payload
```

Input JSON Payload:

```json
{
  "customer": {
    "userName": "John Doe",
    "password": {},
    "status": "active",
    "lastLogin": {}
  }
}
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<customer>
  <userName>John Doe</userName>
  <password/>
  <status>active</status>
  <lastLogin/>
</customer>
```

## Related Examples

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-insert-attribute)

- [Remove Specified XML Attributes](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-remove-certain-xml-attributes)

- [Include XML Namespaces](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-include-xml-namespaces)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.6/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook)

<!-- document id=50bb4aacbe7f2c8e5851d217d96f62f3ce024cf26169dbdd560e3fbac85a00d6 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook-output-self-closing-xml-tags.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Output Self-closing XML Tags

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

For XML, DataWeave by default outputs every value within an opening and closing tag, even if the tag
contains no value (for example, `<element2></element2>`).

To output empty tags as a self-closing XML element (for example, `<element2/>`), you can set the
`inlineCloseOn="empty"` output directive in the DataWeave header.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml inlineCloseOn="empty"
---
payload
```

Input JSON Payload:

```json
{
  "customer": {
    "userName": "John Doe",
    "password": {},
    "status": "active",
    "lastLogin": {}
  }
}
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<customer>
  <userName>John Doe</userName>
  <password/>
  <status>active</status>
  <lastLogin/>
</customer>
```

## Related Examples

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-insert-attribute)

- [Remove Specified XML Attributes](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-remove-certain-xml-attributes)

- [Include XML Namespaces](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-include-xml-namespaces)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.9/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook)

<!-- document id=f17e1ba6d51a571184c8a29c654709cc49033365ca81f75b3548839392b9a141 url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook-output-self-closing-xml-tags.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Output Self-closing XML Tags

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

For XML, DataWeave by default outputs every value within an opening and closing tag, even if the tag
contains no value (for example, `<element2></element2>`).

To output empty tags as a self-closing XML element (for example, `<element2/>`), you can set the
`inlineCloseOn="empty"` output directive in the DataWeave header.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml inlineCloseOn="empty"
---
payload
```

Input JSON Payload:

```json
{
  "customer": {
    "userName": "John Doe",
    "password": {},
    "status": "active",
    "lastLogin": {}
  }
}
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<customer>
  <userName>John Doe</userName>
  <password/>
  <status>active</status>
  <lastLogin/>
</customer>
```

## Related Examples

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-insert-attribute)

- [Remove Specified XML Attributes](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-remove-certain-xml-attributes)

- [Include XML Namespaces](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-include-xml-namespaces)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook)

<!-- document id=b6a0abe0876422563f2a6c01dbf6e91c49284bd01d7029631bf9970a8b1104e8 url=/mulesoft/current/en-us/dataweave/2.11/dw-mule-functions-p.md -->

---
product: DataWeave
version: 2.11
---

# p

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## p(propertyName: String): String

This function returns a string that identifies the value of one of these input properties: Mule
property placeholders, System properties, or Environment variables.

For more on this topic, see
[Configure Properties](https://docs.mulesoft.com/mule-runtime/latest/configuring-properties).

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>propertyName</code></p></td><td><p>A string that identifies property.</p></td></tr></tbody></table>

### Example

This example logs the value of the property `http.port` in a Logger component.

#### Source

```xml
<flow name="simple">
 <logger level="INFO" doc:name="Logger"
   message="#[Mule::p('http.port')]"/>
</flow>
```

<!-- document id=9a5464ee1e7b4b3ea8621ca2d5d725190fa6e5517820bbd0942a3a72659e5ea8 url=/mulesoft/current/en-us/dataweave/2.12/dw-mule-functions-p.md -->

---
product: DataWeave
version: 2.12
---

# p

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## p(propertyName: String): String

This function returns a string that identifies the value of one of these input properties: Mule
property placeholders, System properties, or Environment variables.

For more on this topic, see
[Configure Properties](https://docs.mulesoft.com/mule-runtime/latest/configuring-properties).

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>propertyName</code></p></td><td><p>A string that identifies property.</p></td></tr></tbody></table>

### Example

This example logs the value of the property `http.port` in a Logger component.

#### Source

```xml
<flow name="simple">
 <logger level="INFO" doc:name="Logger"
   message="#[Mule::p('http.port')]"/>
</flow>
```

<!-- document id=c531e2ba87e6b42b8db72286baaa31b8d3f16f3a8aa312cddd22ce1315da208f url=/mulesoft/current/en-us/dataweave/2.3/dw-mule-functions-p.md -->

---
product: DataWeave
version: 2.3
---

# p

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## p(String): String

This function returns a string that identifies the value of one of these input properties: Mule
property placeholders, System properties, or Environment variables.

The `p` function returns a `null` value if the property is not set or if the function does not find
the property.

For more on this topic, see
[Configure Properties](https://docs.mulesoft.com/mule-runtime/latest/configuring-properties).

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>propertyName</code></p></td><td><p>A string that identifies property.</p></td></tr></tbody></table>

### Example

This example logs the value of the property `http.port` in a Logger component.

#### Source

```xml
<flow name="simple">
 <logger level="INFO" doc:name="Logger"
   message="#[Mule::p('http.port')]"/>
</flow>
```

### Example

This example shows the password configuration for an Amazon S3 Connector connection to get an image
from Amazon S3. The `p` function returns a string that identifies the value of `secure::accessKey`
and `secure::secretKey` properties. The `secure::` prefix is used to access Mule secure
configuration properties.

#### Source

```xml
<flow name="simple">
 <s3:config name="Amazon_S3_Configuration" doc:name="Amazon S3 Configuration">
     <s3:basic-connection
       accessKey="#[Mule::p('secure::accessKey')]"
       secretKey="#[Mule::p('secure::secretKey')]"/>
   </s3:config>
 <s3:get-object config-ref="Amazon_S3_Configuration" bucketName="myBucket" key="maxImages/maxthemule.jpg"
     doc:name="Get object"/>
</flow>
```

<!-- document id=35c1ef7bc417e184c14669e8b3f2bd8e41b0b6919ab284f7402ef5877e693320 url=/mulesoft/current/en-us/dataweave/2.4/dw-mule-functions-p.md -->

---
product: DataWeave
version: 2.4
---

# p

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## p(propertyName: String): String

This function returns a string that identifies the value of one of these input properties: Mule
property placeholders, System properties, or Environment variables.

For more on this topic, see
[Configure Properties](https://docs.mulesoft.com/mule-runtime/latest/configuring-properties).

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>propertyName</code></p></td><td><p>A string that identifies property.</p></td></tr></tbody></table>

### Example

This example logs the value of the property `http.port` in a Logger component.

#### Source

```xml
<flow name="simple">
 <logger level="INFO" doc:name="Logger"
   message="#[Mule::p('http.port')]"/>
</flow>
```

<!-- document id=b48e7af78eae28372fe0853ea1d06d3744bbced8b1e73d8a54c709bb04ccc889 url=/mulesoft/current/en-us/dataweave/2.6/dw-mule-functions-p.md -->

---
product: DataWeave
version: 2.6
---

# p

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## p(propertyName: String): String

This function returns a string that identifies the value of one of these input properties: Mule
property placeholders, System properties, or Environment variables.

For more on this topic, see
[Configure Properties](https://docs.mulesoft.com/mule-runtime/latest/configuring-properties).

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>propertyName</code></p></td><td><p>A string that identifies property.</p></td></tr></tbody></table>

### Example

This example logs the value of the property `http.port` in a Logger component.

#### Source

```xml
<flow name="simple">
 <logger level="INFO" doc:name="Logger"
   message="#[Mule::p('http.port')]"/>
</flow>
```

<!-- document id=be21c2170e23b9d4111ef141e811562fe2ed0882a1423096c00fbc707f3304a3 url=/mulesoft/current/en-us/dataweave/2.9/dw-mule-functions-p.md -->

---
product: DataWeave
version: 2.9
---

# p

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## p(propertyName: String): String

This function returns a string that identifies the value of one of these input properties: Mule
property placeholders, System properties, or Environment variables.

For more on this topic, see
[Configure Properties](https://docs.mulesoft.com/mule-runtime/latest/configuring-properties).

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>propertyName</code></p></td><td><p>A string that identifies property.</p></td></tr></tbody></table>

### Example

This example logs the value of the property `http.port` in a Logger component.

#### Source

```xml
<flow name="simple">
 <logger level="INFO" doc:name="Logger"
   message="#[Mule::p('http.port')]"/>
</flow>
```

<!-- document id=f0cd00196ada57ffea9bc823f1c7ed0d612fb180c139a1805f49f27de85036f0 url=/mulesoft/current/en-us/dataweave/latest/dw-mule-functions-p.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# p

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## p(propertyName: String): String

This function returns a string that identifies the value of one of these input properties: Mule
property placeholders, System properties, or Environment variables.

For more on this topic, see
[Configure Properties](https://docs.mulesoft.com/mule-runtime/latest/configuring-properties).

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>propertyName</code></p></td><td><p>A string that identifies property.</p></td></tr></tbody></table>

### Example

This example logs the value of the property `http.port` in a Logger component.

#### Source

```xml
<flow name="simple">
 <logger level="INFO" doc:name="Logger"
   message="#[Mule::p('http.port')]"/>
</flow>
```

<!-- document id=415b1613262cda10b4bcef646e66bde776d61fd274caba6301808ccd093f9063 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-maven-plugin.md -->

---
product: DataWeave
version: 2.11
---

# Packaging and Deploying DataWeave Libraries

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Use the Apache Maven plugin for DataWeave to integrate the packaging and deployment of your
DataWeave libraries with your Maven lifecycle.

The plugin enables you to run six main goals:

- `compile`  
  Compiles the source code for your DataWeave library.

- `test`  
  Tests the compiled source code using the
  [DataWeave testing framework](https://docs.mulesoft.com/dataweave/2.11/dataweave-testing-framework).

- `data-weave:generate-docs`  
  Automatically generates the documentation for your DataWeave library.

- `package`  
  Packages the compiled code in a `.jar` file.

- `data-weave:deploy-docs`  
  Uploads the auto-generated documentation for your DataWeave library to Anypoint Exchange.

- `deploy`  
  Automatically uploads your DataWeave library to the deployment target and uploads the
  auto-generated documentation to Exchange.

## Add the Maven Plugin to a Project

To enable the Maven plugin for DataWeave in your project:

- Add the following Maven dependency to your project’s `pom.xml` file:

  ```xml
  <plugin>
    <groupId>org.mule.weave</groupId>
    <artifactId>data-weave-maven-plugin</artifactId>
    <version>2.9.0</version>
    <extensions>true</extensions>
  </plugin>
  ```

- Add the following repositories to your project’s `pom.xml` file::

  ```xml
  <pluginRepositories>
      <pluginRepository>
          <id>mule-releases</id>
          <url>https://repository-master.mulesoft.org/nexus/content/repositories/releases</url>
      </pluginRepository>
      <pluginRepository>
          <id>mule-snapshots</id>
          <url>https://repository-master.mulesoft.org/nexus/content/repositories/snapshots</url>
      </pluginRepository>
  </pluginRepositories>
  ```

## Compile a DataWeave Library

Run the `compile` goal to compile your DataWeave library from source code, for example:

```console
mvn compile
```

## Test a DataWeave Library

Run the `test` goal to execute the DataWeave test suite included in your library, for example:

```console
mvn test
```

The Maven plugin for DataWeave uses the [DataWeave testing framework](https://docs.mulesoft.com/dataweave/2.11/dataweave-testing-framework)
to run your test suite, which supports configuring additional parameters when you run the `test`
goal.

### Configure the Test Suite

Inside the `plugin` configuration, add a `tests` element configured to use parameters that meet your
testing needs:

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>output</code></p></div></div></td><td><div><div><p><code>String</code></p></div></div></td><td><div><div><p><code>${project.build.directory}/data-weave-test-reports</code></p></div></div></td><td><div><div><p>Specifies the path for the directory in which all the auto-generated reports are created when the test runs.</p></div></div></td></tr><tr><td><div><div><p><code>htmlReport</code></p></div></div></td><td><div><div><p><code>boolean</code></p></div></div></td><td><div><div><p><code>true</code></p></div></div></td><td><div><div><p>When this property is set to <code>true</code>, the test suite generates an HTML report about the execution.</p></div></div></td></tr><tr><td><div><div><p><code>coverageEnabled</code></p></div></div></td><td><div><div><p><code>boolean</code></p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div><div><p>When this property is set to <code>true</code>, the test suite generates a coverage report about the execution.</p></div></div></td></tr><tr><td><div><div><p><code>coverageFormat</code></p></div></div></td><td><div><div><p><code>String</code></p></div></div></td><td><div><div><p><code>sonar</code></p></div></div></td><td><div><div><p>Specifies the format for the coverage report, one of:</p></div><div><ul><li><p><code>sonar</code><br>Generates a valid <a href="https://www.sonarsource.com/products/sonarqube/" target="_blank" rel="noopener">Sonar</a> coverage report for your test suite.</p></li><li><p><code>html</code><br>Generates an HTML coverage report for your test suite.</p></li></ul></div></div></td></tr><tr><td><div><div><p><code>runnerLogForkedProcessCommand</code></p></div></div></td><td><div><div><p><code>boolean</code></p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div><div><p>When set to <code>true</code>, logs the command used to launch the test runner process.</p></div></div></td></tr><tr><td><div><div><p><code>runnerEnvironmentVariables</code></p></div></div></td><td><div><div><p><code>Map</code></p></div></div></td><td><div><div><p><code>null</code></p></div></div></td><td><div><div><p>A set of additional environment variables to pass to the test runner process.</p></div></div></td></tr><tr><td><div><div><p><code>runnerSystemProperties</code></p></div></div></td><td><div><div><p><code>Map</code></p></div></div></td><td><div><div><p><code>null</code></p></div></div></td><td><div><div><p>A set of additional system properties to pass to the test runner process.</p></div></div></td></tr><tr><td><div><div><p><code>runnerArgLine</code></p></div></div></td><td><div><div><p><code>boolean</code></p></div></div></td><td><div><div><p><code>null</code></p></div></div></td><td><div><div><p>A set of additional JVM options to pass to the test runner process.</p></div></div></td></tr><tr><td><div><div><p><code>runnerJvmDebug</code></p></div></div></td><td><div><div><p><code>boolean</code></p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div><div><p>When set to <code>true</code>, enables remote debugging for the test runner JVM.</p></div></div></td></tr></tbody></table>

### Test Configuration Example

The following example enables the `sonar` coverage report and disables `htmlReport` in a project.

Example `pom.xml` file

```xml
<plugin>
  <groupId>org.mule.weave</groupId>
  <artifactId>data-weave-maven-plugin</artifactId>
  <version>2.9.0</version>
  <extensions>true</extensions>
  <configuration>
    ...
    <tests>
      <htmlReport>false</htmlReport>
      <coverageEnabled>true</coverageEnabled>
      <coverageFormat>sonar</coverageFormat>
    </tests>
    ...
  </configuration>
</plugin>
```

## Generate Documentation for a DataWeave Library

Run the `data-weave:generate-docs` goal to auto-generate the documentation for your DataWeave
library, for example:

```console
mvn prepare-package
```

Alternatively, you can also run:

```console
mvn data-weave:generate-docs
```

### Configure the Automated Docs Generation

Inside the `plugin` configuration, add a `docs` element configured with parameters that meet your
documentation needs:

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>output</code></p></div></div></td><td><div><div><p><code>String</code></p></div></div></td><td><div><div><p><code>${project.build.directory}/data-weave-docs</code></p></div></div></td><td><div><div><p>The output directory in which the documentation files are created.</p></div></div></td></tr><tr><td><div><div><p><code>template</code></p></div></div></td><td><div><div><p><code>String</code></p></div></div></td><td><div><div><p><code>exchange_markdown</code></p></div></div></td><td><div><div><p>The template to use for the auto-generated documentation, one of:</p></div><div><ul><li><p><code>exchange_markdown</code><br>Generates the documentation in a Markdown format that is compliant with <a href="https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/exchange-experience-api/" target="_blank" rel="noopener">Exchange</a>.</p></li><li><p><code>markdown</code><br>Generates the documentation in Markdown format.</p></li><li><p><code>asciidoc</code><br>Generates the documentation in AsciiDoc format.</p></li></ul></div><div><p>Valid values are <code>exchange_markdown</code>, <code>markdown</code>, or <code>asciidoc</code>.</p></div></div></td></tr><tr><td><div><div><p><code>homePage</code></p></div></div></td><td><div><div><p><code>String</code></p></div></div></td><td><div><div><p><code>null</code></p></div></div></td><td><div><div><p>Specifies the path to a custom Markdown file to add in the home page. The file must be generated by the <code>markdown</code> or <code>exchange_markdown</code> template.</p></div></div></td></tr><tr><td><div><div><p><code>favicon</code></p></div></div></td><td><div><div><p><code>String</code></p></div></div></td><td><div><div><p><code>null</code></p></div></div></td><td><div><div><p>Specifies the path to the image file (<code>png</code> or <code>jpg</code>) to use as the asset icon in the Exchange portal.</p></div></div></td></tr></tbody></table>

### Docs Generation Example

The following example shows how to configure both a custom home page and a specific favicon to
include in the Exchange portal home page of your DataWeave library:

Example `pom.xml` file:

```xml
<plugin>
  <groupId>org.mule.weave</groupId>
  <artifactId>data-weave-maven-plugin</artifactId>
  <version>2.9.0</version>
  <extensions>true</extensions>
  <configuration>
    ...
    <docs>
      <homePage>${project.basedir}/README.md</homePage>
      <favicon>${project.basedir}/src/main/resources/favicon/parrot.jpg</favicon>
    </docs>
    ...
  </configuration>
</plugin>
```

## Deploy DataWeave Libraries and Upload Documentation to Exchange

Before uploading DataWeave libraries to Exchange, ensure that the `pom.xml` file includes all
MuleSoft repositories and your credentials for Maven to access the enterprise repository. See
[Publish an Asset to Exchange Using Maven](https://docs.mulesoft.com/exchange/to-publish-assets-maven#publish-an-asset-to-exchange-using-maven)
for instructions to set up your DataWeave library.

After reviewing the `pom.xml` file, run the `deploy` goal to deploy the DataWeave library to the
deployment target, and upload the generated documentation to Exchange, for example:

```console
mvn deploy
```

### Skip Exchange Documentation Upload

You can skip the Exchange documentation upload when deploying a DataWeave project by setting the
`skipDeployDocs` system property to `true`:

```console
mvn deploy -DskipDeployDocs=true
```

### Upload the Documentation to Exchange

Alternatively, you can run the `data-weave:deploy-docs` goal to upload the generated documentation
to Exchange without deploying the DataWeave library, for example:

```console
mvn data-weave:deploy-docs
```

## DataWeave Library Structure Reference

When designing your DataWeave library, use the basic components `src` and `pom.xml`:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Component</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>src</code></p></div></div></td><td><div><div><p>Folder</p></div></div></td><td><div><div><p>The source directory for your DataWeave library’s production source code and tests.</p></div></div></td></tr><tr><td><div><div><p><code>pom.xml</code></p></div></div></td><td><div><div><p>Descriptor</p></div></div></td><td><div><div><p>The POM file of your DataWeave library. This file describes all of your library’s required dependencies.</p></div></div></td></tr></tbody></table>

## Source Directory Reference

The directory structure of a DataWeave library comprises the `src/main` and `src/test` folders.

### src/main

`src/main` is the root folder for all the production source code of the DataWeave library.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Folder</th><th>Folder Type</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>src/main/dw</code></p></div></div></td><td><div><div><p>source</p></div></div></td><td><div><div><p>The root folder of the DataWeave library source code files.</p></div></div></td></tr><tr><td><div><div><p><code>src/main/resources</code></p></div></div></td><td><div><div><p>resource</p></div></div></td><td><div><div><p>Contains the application resources, such as XML, JSON, and properties files.</p></div></div></td></tr></tbody></table>

### src/test

`src/test` is the root folder for all the test source code of the DataWeave library.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Folder</th><th>Folder Type</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>src/test/dw</code></p></div></div></td><td><div><div><p>source</p></div></div></td><td><div><div><p>The root folder of the test cases used to validate the DataWeave library.</p></div></div></td></tr><tr><td><div><div><p><code>src/test/resources</code></p></div></div></td><td><div><div><p>resource</p></div></div></td><td><div><div><p>Contains resources, such as XML, JSON, and properties files. This folder also contains files required to run your test suite.</p></div></div></td></tr></tbody></table>

## See Also

- [DataWeave Extension](https://docs.mulesoft.com/dataweave/2.11/dataweave-extension)

- [Testing DataWeave Libraries and Modules](https://docs.mulesoft.com/dataweave/2.11/dataweave-testing-framework)

- [Installing and Using the DataWeave Extension](https://docs.mulesoft.com/dataweave/2.11/dataweave-extension-plugin)

<!-- document id=ec3aad6c7de5dcc9408d88059e555450ee23f10891a2323cd9dad5d9680278a4 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-maven-plugin.md -->

---
product: DataWeave
version: 2.12
---

# Packaging and Deploying DataWeave Libraries

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Use the Apache Maven plugin for DataWeave to integrate the packaging and deployment of your
DataWeave libraries with your Maven lifecycle.

The plugin enables you to run six main goals:

- `compile`  
  Compiles the source code for your DataWeave library.

- `test`  
  Tests the compiled source code using the
  [DataWeave testing framework](https://docs.mulesoft.com/dataweave/2.12/dataweave-testing-framework).

- `data-weave:generate-docs`  
  Automatically generates the documentation for your DataWeave library.

- `package`  
  Packages the compiled code in a `.jar` file.

- `data-weave:deploy-docs`  
  Uploads the auto-generated documentation for your DataWeave library to Anypoint Exchange.

- `deploy`  
  Automatically uploads your DataWeave library to the deployment target and uploads the
  auto-generated documentation to Exchange.

## Add the Maven Plugin to a Project

To enable the Maven plugin for DataWeave in your project:

- Add the following Maven dependency to your project’s `pom.xml` file:

  ```xml
  <plugin>
    <groupId>org.mule.weave</groupId>
    <artifactId>data-weave-maven-plugin</artifactId>
    <version>2.9.0</version>
    <extensions>true</extensions>
  </plugin>
  ```

- Add the following repositories to your project’s `pom.xml` file::

  ```xml
  <pluginRepositories>
      <pluginRepository>
          <id>mule-releases</id>
          <url>https://repository-master.mulesoft.org/nexus/content/repositories/releases</url>
      </pluginRepository>
      <pluginRepository>
          <id>mule-snapshots</id>
          <url>https://repository-master.mulesoft.org/nexus/content/repositories/snapshots</url>
      </pluginRepository>
  </pluginRepositories>
  ```

## Compile a DataWeave Library

Run the `compile` goal to compile your DataWeave library from source code, for example:

```console
mvn compile
```

## Test a DataWeave Library

Run the `test` goal to execute the DataWeave test suite included in your library, for example:

```console
mvn test
```

The Maven plugin for DataWeave uses the [DataWeave testing framework](https://docs.mulesoft.com/dataweave/2.12/dataweave-testing-framework)
to run your test suite, which supports configuring additional parameters when you run the `test`
goal.

### Configure the Test Suite

Inside the `plugin` configuration, add a `tests` element configured to use parameters that meet your
testing needs:

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>output</code></p></div></div></td><td><div><div><p><code>String</code></p></div></div></td><td><div><div><p><code>${project.build.directory}/data-weave-test-reports</code></p></div></div></td><td><div><div><p>Specifies the path for the directory in which all the auto-generated reports are created when the test runs.</p></div></div></td></tr><tr><td><div><div><p><code>htmlReport</code></p></div></div></td><td><div><div><p><code>boolean</code></p></div></div></td><td><div><div><p><code>true</code></p></div></div></td><td><div><div><p>When this property is set to <code>true</code>, the test suite generates an HTML report about the execution.</p></div></div></td></tr><tr><td><div><div><p><code>coverageEnabled</code></p></div></div></td><td><div><div><p><code>boolean</code></p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div><div><p>When this property is set to <code>true</code>, the test suite generates a coverage report about the execution.</p></div></div></td></tr><tr><td><div><div><p><code>coverageFormat</code></p></div></div></td><td><div><div><p><code>String</code></p></div></div></td><td><div><div><p><code>sonar</code></p></div></div></td><td><div><div><p>Specifies the format for the coverage report, one of:</p></div><div><ul><li><p><code>sonar</code><br>Generates a valid <a href="https://www.sonarsource.com/products/sonarqube/" target="_blank" rel="noopener">Sonar</a> coverage report for your test suite.</p></li><li><p><code>html</code><br>Generates an HTML coverage report for your test suite.</p></li></ul></div></div></td></tr><tr><td><div><div><p><code>runnerLogForkedProcessCommand</code></p></div></div></td><td><div><div><p><code>boolean</code></p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div><div><p>When set to <code>true</code>, logs the command used to launch the test runner process.</p></div></div></td></tr><tr><td><div><div><p><code>runnerEnvironmentVariables</code></p></div></div></td><td><div><div><p><code>Map</code></p></div></div></td><td><div><div><p><code>null</code></p></div></div></td><td><div><div><p>A set of additional environment variables to pass to the test runner process.</p></div></div></td></tr><tr><td><div><div><p><code>runnerSystemProperties</code></p></div></div></td><td><div><div><p><code>Map</code></p></div></div></td><td><div><div><p><code>null</code></p></div></div></td><td><div><div><p>A set of additional system properties to pass to the test runner process.</p></div></div></td></tr><tr><td><div><div><p><code>runnerArgLine</code></p></div></div></td><td><div><div><p><code>boolean</code></p></div></div></td><td><div><div><p><code>null</code></p></div></div></td><td><div><div><p>A set of additional JVM options to pass to the test runner process.</p></div></div></td></tr><tr><td><div><div><p><code>runnerJvmDebug</code></p></div></div></td><td><div><div><p><code>boolean</code></p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div><div><p>When set to <code>true</code>, enables remote debugging for the test runner JVM.</p></div></div></td></tr></tbody></table>

### Test Configuration Example

The following example enables the `sonar` coverage report and disables `htmlReport` in a project.

Example `pom.xml` file

```xml
<plugin>
  <groupId>org.mule.weave</groupId>
  <artifactId>data-weave-maven-plugin</artifactId>
  <version>2.9.0</version>
  <extensions>true</extensions>
  <configuration>
    ...
    <tests>
      <htmlReport>false</htmlReport>
      <coverageEnabled>true</coverageEnabled>
      <coverageFormat>sonar</coverageFormat>
    </tests>
    ...
  </configuration>
</plugin>
```

## Configure Cryptographic Taint Analysis

The Maven plugin for DataWeave can run cryptographic taint analysis at compile time to help identify
potential security vulnerabilities in your DataWeave code. The analysis tracks literal algorithm
values that flow into parameters annotated with [`@CryptographicSink`](https://docs.mulesoft.com/dataweave/2.12/dw-crypto-annotations) and
causes the build to fail when an algorithm matches your configured insecure list. For more details
about the annotation, see [Crypto Annotations](https://docs.mulesoft.com/dataweave/2.12/dw-crypto-annotations).

Inside the plugin configuration, add `cryptoTaintAnalysisSettings` with values that match your
security requirements:

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>enabled</code></p></div></div></td><td><div><div><p><code>boolean</code></p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div><div><p>When set to <code>true</code>, the plugin runs cryptographic taint analysis during compilation.</p></div></div></td></tr><tr><td><div><div><p><code>insecureAlgorithms</code></p></div></div></td><td><div><div><p><code>String</code></p></div></div></td><td><div><div><p><code>""</code></p></div></div></td><td><div><div><p>Comma-separated list of cryptographic algorithms that your organization considers insecure. The plugin reports a compilation error when one of these algorithms reaches a <code>@CryptographicSink</code> parameter. For example, <code>MD5,SHA1,DES,RC4</code>.</p></div></div></td></tr><tr><td><div><div><p><code>sensitiveModules</code></p></div></div></td><td><div><div><p><code>String</code></p></div></div></td><td><div><div><p><code>""</code></p></div></div></td><td><div><div><p>Comma-separated list of DataWeave modules to flag as sensitive. Use DataWeave module notation with the <code>::</code> separator. For example, <code>dw::crypto::CryptoModule,dw::security::HashModule</code>.</p></div></div></td></tr></tbody></table>

### Cryptographic Taint Analysis Example

This example enables taint analysis and configures both insecure algorithms and sensitive modules:

Example `pom.xml` file

```xml
<plugin>
  <groupId>org.mule.weave</groupId>
  <artifactId>data-weave-maven-plugin</artifactId>
  <version>2.9.0</version>
  <extensions>true</extensions>
  <configuration>
    ...
    <cryptoTaintAnalysisSettings>
      <enabled>true</enabled>
      <insecureAlgorithms>MD5,SHA1,DES,RC4</insecureAlgorithms>
      <sensitiveModules>dw::crypto::CryptoModule,dw::security::HashModule,dw::util::SecurityModule</sensitiveModules>
    </cryptoTaintAnalysisSettings>
    ...
  </configuration>
</plugin>
```

## Generate Documentation for a DataWeave Library

Run the `data-weave:generate-docs` goal to auto-generate the documentation for your DataWeave
library, for example:

```console
mvn prepare-package
```

Alternatively, you can also run:

```console
mvn data-weave:generate-docs
```

### Configure the Automated Docs Generation

Inside the `plugin` configuration, add a `docs` element configured with parameters that meet your
documentation needs:

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>output</code></p></div></div></td><td><div><div><p><code>String</code></p></div></div></td><td><div><div><p><code>${project.build.directory}/data-weave-docs</code></p></div></div></td><td><div><div><p>The output directory in which the documentation files are created.</p></div></div></td></tr><tr><td><div><div><p><code>template</code></p></div></div></td><td><div><div><p><code>String</code></p></div></div></td><td><div><div><p><code>exchange_markdown</code></p></div></div></td><td><div><div><p>The template to use for the auto-generated documentation, one of:</p></div><div><ul><li><p><code>exchange_markdown</code><br>Generates the documentation in a Markdown format that is compliant with <a href="https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/exchange-experience-api/" target="_blank" rel="noopener">Exchange</a>.</p></li><li><p><code>markdown</code><br>Generates the documentation in Markdown format.</p></li><li><p><code>asciidoc</code><br>Generates the documentation in AsciiDoc format.</p></li></ul></div><div><p>Valid values are <code>exchange_markdown</code>, <code>markdown</code>, or <code>asciidoc</code>.</p></div></div></td></tr><tr><td><div><div><p><code>homePage</code></p></div></div></td><td><div><div><p><code>String</code></p></div></div></td><td><div><div><p><code>null</code></p></div></div></td><td><div><div><p>Specifies the path to a custom Markdown file to add in the home page. The file must be generated by the <code>markdown</code> or <code>exchange_markdown</code> template.</p></div></div></td></tr><tr><td><div><div><p><code>favicon</code></p></div></div></td><td><div><div><p><code>String</code></p></div></div></td><td><div><div><p><code>null</code></p></div></div></td><td><div><div><p>Specifies the path to the image file (<code>png</code> or <code>jpg</code>) to use as the asset icon in the Exchange portal.</p></div></div></td></tr></tbody></table>

### Docs Generation Example

The following example shows how to configure both a custom home page and a specific favicon to
include in the Exchange portal home page of your DataWeave library:

Example `pom.xml` file:

```xml
<plugin>
  <groupId>org.mule.weave</groupId>
  <artifactId>data-weave-maven-plugin</artifactId>
  <version>2.9.0</version>
  <extensions>true</extensions>
  <configuration>
    ...
    <docs>
      <homePage>${project.basedir}/README.md</homePage>
      <favicon>${project.basedir}/src/main/resources/favicon/parrot.jpg</favicon>
    </docs>
    ...
  </configuration>
</plugin>
```

## Deploy DataWeave Libraries and Upload Documentation to Exchange

Before uploading DataWeave libraries to Exchange, ensure that the `pom.xml` file includes all
MuleSoft repositories and your credentials for Maven to access the enterprise repository. See
[Publish an Asset to Exchange Using Maven](https://docs.mulesoft.com/exchange/to-publish-assets-maven#publish-an-asset-to-exchange-using-maven)
for instructions to set up your DataWeave library.

After reviewing the `pom.xml` file, run the `deploy` goal to deploy the DataWeave library to the
deployment target, and upload the generated documentation to Exchange, for example:

```console
mvn deploy
```

### Skip Exchange Documentation Upload

You can skip the Exchange documentation upload when deploying a DataWeave project by setting the
`skipDeployDocs` system property to `true`:

```console
mvn deploy -DskipDeployDocs=true
```

### Upload the Documentation to Exchange

Alternatively, you can run the `data-weave:deploy-docs` goal to upload the generated documentation
to Exchange without deploying the DataWeave library, for example:

```console
mvn data-weave:deploy-docs
```

## DataWeave Library Structure Reference

When designing your DataWeave library, use the basic components `src` and `pom.xml`:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Component</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>src</code></p></div></div></td><td><div><div><p>Folder</p></div></div></td><td><div><div><p>The source directory for your DataWeave library’s production source code and tests.</p></div></div></td></tr><tr><td><div><div><p><code>pom.xml</code></p></div></div></td><td><div><div><p>Descriptor</p></div></div></td><td><div><div><p>The POM file of your DataWeave library. This file describes all of your library’s required dependencies.</p></div></div></td></tr></tbody></table>

## Source Directory Reference

The directory structure of a DataWeave library comprises the `src/main` and `src/test` folders.

### src/main

`src/main` is the root folder for all the production source code of the DataWeave library.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Folder</th><th>Folder Type</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>src/main/dw</code></p></div></div></td><td><div><div><p>source</p></div></div></td><td><div><div><p>The root folder of the DataWeave library source code files.</p></div></div></td></tr><tr><td><div><div><p><code>src/main/resources</code></p></div></div></td><td><div><div><p>resource</p></div></div></td><td><div><div><p>Contains the application resources, such as XML, JSON, and properties files.</p></div></div></td></tr></tbody></table>

### src/test

`src/test` is the root folder for all the test source code of the DataWeave library.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Folder</th><th>Folder Type</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>src/test/dw</code></p></div></div></td><td><div><div><p>source</p></div></div></td><td><div><div><p>The root folder of the test cases used to validate the DataWeave library.</p></div></div></td></tr><tr><td><div><div><p><code>src/test/resources</code></p></div></div></td><td><div><div><p>resource</p></div></div></td><td><div><div><p>Contains resources, such as XML, JSON, and properties files. This folder also contains files required to run your test suite.</p></div></div></td></tr></tbody></table>

## See Also

- [DataWeave Extension](https://docs.mulesoft.com/dataweave/2.12/dataweave-extension)

- [Testing DataWeave Libraries and Modules](https://docs.mulesoft.com/dataweave/2.12/dataweave-testing-framework)

- [Installing and Using the DataWeave Extension](https://docs.mulesoft.com/dataweave/2.12/dataweave-extension-plugin)

<!-- document id=b115f9be7bff87ca25839bcb3f15fe46a660b58f2a4c03571250888aabc2e454 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-maven-plugin.md -->

---
product: DataWeave
version: 2.4
---

# Packaging and Deploying DataWeave Libraries

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Use the Apache Maven plugin for DataWeave to integrate the packaging and deployment of your
DataWeave libraries with your Maven lifecycle.

The plugin enables you to run six main goals:

- `compile`  
  Compiles the source code for your DataWeave library.

- `test`  
  Tests the compiled source code using the
  [DataWeave testing framework](https://docs.mulesoft.com/dataweave/2.4/dataweave-testing-framework).

- `data-weave:generate-docs`  
  Automatically generates the documentation for your DataWeave library.

- `package`  
  Packages the compiled code in a `.jar` file.

- `data-weave:deploy-docs`  
  Uploads the auto-generated documentation for your DataWeave library to Anypoint Exchange.

- `deploy`  
  Automatically uploads your DataWeave library to the deployment target and uploads the
  auto-generated documentation to Exchange.

## Add the Maven Plugin to a Project

To enable the Maven plugin for DataWeave in your project:

- Add the following Maven dependency to your project’s `pom.xml` file:

  ```xml
  <plugin>
    <groupId>org.mule.weave</groupId>
    <artifactId>data-weave-maven-plugin</artifactId>
    <version>2.9.0</version>
    <extensions>true</extensions>
  </plugin>
  ```

- Add the following repositories to your project’s `pom.xml` file::

  ```xml
  <pluginRepositories>
      <pluginRepository>
          <id>mule-releases</id>
          <url>https://repository-master.mulesoft.org/nexus/content/repositories/releases</url>
      </pluginRepository>
      <pluginRepository>
          <id>mule-snapshots</id>
          <url>https://repository-master.mulesoft.org/nexus/content/repositories/snapshots</url>
      </pluginRepository>
  </pluginRepositories>
  ```

## Compile a DataWeave Library

Run the `compile` goal to compile your DataWeave library from source code, for example:

```console
mvn compile
```

## Test a DataWeave Library

Run the `test` goal to execute the DataWeave test suite included in your library, for example:

```console
mvn test
```

The Maven plugin for DataWeave uses the [DataWeave testing framework](https://docs.mulesoft.com/dataweave/2.4/dataweave-testing-framework)
to run your test suite, which supports configuring additional parameters when you run the `test`
goal.

### Configure the Test Suite

Inside the `plugin` configuration, add a `tests` element configured to use parameters that meet your
testing needs:

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>output</code></p></div></div></td><td><div><div><p><code>String</code></p></div></div></td><td><div><div><p><code>${project.build.directory}/data-weave-test-reports</code></p></div></div></td><td><div><div><p>Specifies the path for the directory in which all the auto-generated reports are created when the test runs.</p></div></div></td></tr><tr><td><div><div><p><code>htmlReport</code></p></div></div></td><td><div><div><p><code>boolean</code></p></div></div></td><td><div><div><p><code>true</code></p></div></div></td><td><div><div><p>When this property is set to <code>true</code>, the test suite generates an HTML report about the execution.</p></div></div></td></tr><tr><td><div><div><p><code>coverageEnabled</code></p></div></div></td><td><div><div><p><code>boolean</code></p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div><div><p>When this property is set to <code>true</code>, the test suite generates a coverage report about the execution.</p></div></div></td></tr><tr><td><div><div><p><code>coverageFormat</code></p></div></div></td><td><div><div><p><code>String</code></p></div></div></td><td><div><div><p><code>sonar</code></p></div></div></td><td><div><div><p>Specifies the format for the coverage report, one of:</p></div><div><ul><li><p><code>sonar</code><br>Generates a valid <a href="https://www.sonarsource.com/products/sonarqube/" target="_blank" rel="noopener">Sonar</a> coverage report for your test suite.</p></li><li><p><code>html</code><br>Generates an HTML coverage report for your test suite.</p></li></ul></div></div></td></tr><tr><td><div><div><p><code>runnerLogForkedProcessCommand</code></p></div></div></td><td><div><div><p><code>boolean</code></p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div><div><p>When set to <code>true</code>, logs the command used to launch the test runner process.</p></div></div></td></tr><tr><td><div><div><p><code>runnerEnvironmentVariables</code></p></div></div></td><td><div><div><p><code>Map</code></p></div></div></td><td><div><div><p><code>null</code></p></div></div></td><td><div><div><p>A set of additional environment variables to pass to the test runner process.</p></div></div></td></tr><tr><td><div><div><p><code>runnerSystemProperties</code></p></div></div></td><td><div><div><p><code>Map</code></p></div></div></td><td><div><div><p><code>null</code></p></div></div></td><td><div><div><p>A set of additional system properties to pass to the test runner process.</p></div></div></td></tr><tr><td><div><div><p><code>runnerArgLine</code></p></div></div></td><td><div><div><p><code>boolean</code></p></div></div></td><td><div><div><p><code>null</code></p></div></div></td><td><div><div><p>A set of additional JVM options to pass to the test runner process.</p></div></div></td></tr><tr><td><div><div><p><code>runnerJvmDebug</code></p></div></div></td><td><div><div><p><code>boolean</code></p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div><div><p>When set to <code>true</code>, enables remote debugging for the test runner JVM.</p></div></div></td></tr></tbody></table>

### Test Configuration Example

The following example enables the `sonar` coverage report and disables `htmlReport` in a project.

Example `pom.xml` file

```xml
<plugin>
  <groupId>org.mule.weave</groupId>
  <artifactId>data-weave-maven-plugin</artifactId>
  <version>2.9.0</version>
  <extensions>true</extensions>
  <configuration>
    ...
    <tests>
      <htmlReport>false</htmlReport>
      <coverageEnabled>true</coverageEnabled>
      <coverageFormat>sonar</coverageFormat>
    </tests>
    ...
  </configuration>
</plugin>
```

## Generate Documentation for a DataWeave Library

Run the `data-weave:generate-docs` goal to auto-generate the documentation for your DataWeave
library, for example:

```console
mvn prepare-package
```

Alternatively, you can also run:

```console
mvn data-weave:generate-docs
```

### Configure the Automated Docs Generation

Inside the `plugin` configuration, add a `docs` element configured with parameters that meet your
documentation needs:

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>output</code></p></div></div></td><td><div><div><p><code>String</code></p></div></div></td><td><div><div><p><code>${project.build.directory}/data-weave-docs</code></p></div></div></td><td><div><div><p>The output directory in which the documentation files are created.</p></div></div></td></tr><tr><td><div><div><p><code>template</code></p></div></div></td><td><div><div><p><code>String</code></p></div></div></td><td><div><div><p><code>exchange_markdown</code></p></div></div></td><td><div><div><p>The template to use for the auto-generated documentation, one of:</p></div><div><ul><li><p><code>exchange_markdown</code><br>Generates the documentation in a Markdown format that is compliant with <a href="https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/exchange-experience-api/" target="_blank" rel="noopener">Exchange</a>.</p></li><li><p><code>markdown</code><br>Generates the documentation in Markdown format.</p></li><li><p><code>asciidoc</code><br>Generates the documentation in AsciiDoc format.</p></li></ul></div><div><p>Valid values are <code>exchange_markdown</code>, <code>markdown</code>, or <code>asciidoc</code>.</p></div></div></td></tr><tr><td><div><div><p><code>homePage</code></p></div></div></td><td><div><div><p><code>String</code></p></div></div></td><td><div><div><p><code>null</code></p></div></div></td><td><div><div><p>Specifies the path to a custom Markdown file to add in the home page. The file must be generated by the <code>markdown</code> or <code>exchange_markdown</code> template.</p></div></div></td></tr><tr><td><div><div><p><code>favicon</code></p></div></div></td><td><div><div><p><code>String</code></p></div></div></td><td><div><div><p><code>null</code></p></div></div></td><td><div><div><p>Specifies the path to the image file (<code>png</code> or <code>jpg</code>) to use as the asset icon in the Exchange portal.</p></div></div></td></tr></tbody></table>

### Docs Generation Example

The following example shows how to configure both a custom home page and a specific favicon to
include in the Exchange portal home page of your DataWeave library:

Example `pom.xml` file:

```xml
<plugin>
  <groupId>org.mule.weave</groupId>
  <artifactId>data-weave-maven-plugin</artifactId>
  <version>2.9.0</version>
  <extensions>true</extensions>
  <configuration>
    ...
    <docs>
      <homePage>${project.basedir}/README.md</homePage>
      <favicon>${project.basedir}/src/main/resources/favicon/parrot.jpg</favicon>
    </docs>
    ...
  </configuration>
</plugin>
```

## Deploy DataWeave Libraries and Upload Documentation to Exchange

Before uploading DataWeave libraries to Exchange, ensure that the `pom.xml` file includes all
MuleSoft repositories and your credentials for Maven to access the enterprise repository. See
[Publish an Asset to Exchange Using Maven](https://docs.mulesoft.com/exchange/to-publish-assets-maven#publish-an-asset-to-exchange-using-maven)
for instructions to set up your DataWeave library.

After reviewing the `pom.xml` file, run the `deploy` goal to deploy the DataWeave library to the
deployment target, and upload the generated documentation to Exchange, for example:

```console
mvn deploy
```

### Skip Exchange Documentation Upload

You can skip the Exchange documentation upload when deploying a DataWeave project by setting the
`skipDeployDocs` system property to `true`:

```console
mvn deploy -DskipDeployDocs=true
```

### Upload the Documentation to Exchange

Alternatively, you can run the `data-weave:deploy-docs` goal to upload the generated documentation
to Exchange without deploying the DataWeave library, for example:

```console
mvn data-weave:deploy-docs
```

## DataWeave Library Structure Reference

When designing your DataWeave library, use the basic components `src` and `pom.xml`:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Component</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>src</code></p></div></div></td><td><div><div><p>Folder</p></div></div></td><td><div><div><p>The source directory for your DataWeave library’s production source code and tests.</p></div></div></td></tr><tr><td><div><div><p><code>pom.xml</code></p></div></div></td><td><div><div><p>Descriptor</p></div></div></td><td><div><div><p>The POM file of your DataWeave library. This file describes all of your library’s required dependencies.</p></div></div></td></tr></tbody></table>

## Source Directory Reference

The directory structure of a DataWeave library comprises the `src/main` and `src/test` folders.

### src/main

`src/main` is the root folder for all the production source code of the DataWeave library.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Folder</th><th>Folder Type</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>src/main/dw</code></p></div></div></td><td><div><div><p>source</p></div></div></td><td><div><div><p>The root folder of the DataWeave library source code files.</p></div></div></td></tr><tr><td><div><div><p><code>src/main/resources</code></p></div></div></td><td><div><div><p>resource</p></div></div></td><td><div><div><p>Contains the application resources, such as XML, JSON, and properties files.</p></div></div></td></tr></tbody></table>

### src/test

`src/test` is the root folder for all the test source code of the DataWeave library.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Folder</th><th>Folder Type</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>src/test/dw</code></p></div></div></td><td><div><div><p>source</p></div></div></td><td><div><div><p>The root folder of the test cases used to validate the DataWeave library.</p></div></div></td></tr><tr><td><div><div><p><code>src/test/resources</code></p></div></div></td><td><div><div><p>resource</p></div></div></td><td><div><div><p>Contains resources, such as XML, JSON, and properties files. This folder also contains files required to run your test suite.</p></div></div></td></tr></tbody></table>

## See Also

- [DataWeave Extension](https://docs.mulesoft.com/dataweave/2.4/dataweave-extension)

- [Testing DataWeave Libraries and Modules](https://docs.mulesoft.com/dataweave/2.4/dataweave-testing-framework)

- [Installing and Using the DataWeave Extension](https://docs.mulesoft.com/dataweave/2.4/dataweave-extension-plugin)

<!-- document id=fe4acf865d6557dc03b54c74ab64a51ec37ca023af09fddeac0a08695791086d url=/mulesoft/current/en-us/dataweave/2.6/dataweave-maven-plugin.md -->

---
product: DataWeave
version: 2.6
---

# Packaging and Deploying DataWeave Libraries

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Use the Apache Maven plugin for DataWeave to integrate the packaging and deployment of your
DataWeave libraries with your Maven lifecycle.

The plugin enables you to run six main goals:

- `compile`  
  Compiles the source code for your DataWeave library.

- `test`  
  Tests the compiled source code using the
  [DataWeave testing framework](https://docs.mulesoft.com/dataweave/2.6/dataweave-testing-framework).

- `data-weave:generate-docs`  
  Automatically generates the documentation for your DataWeave library.

- `package`  
  Packages the compiled code in a `.jar` file.

- `data-weave:deploy-docs`  
  Uploads the auto-generated documentation for your DataWeave library to Anypoint Exchange.

- `deploy`  
  Automatically uploads your DataWeave library to the deployment target and uploads the
  auto-generated documentation to Exchange.

## Add the Maven Plugin to a Project

To enable the Maven plugin for DataWeave in your project:

- Add the following Maven dependency to your project’s `pom.xml` file:

  ```xml
  <plugin>
    <groupId>org.mule.weave</groupId>
    <artifactId>data-weave-maven-plugin</artifactId>
    <version>2.9.0</version>
    <extensions>true</extensions>
  </plugin>
  ```

- Add the following repositories to your project’s `pom.xml` file::

  ```xml
  <pluginRepositories>
      <pluginRepository>
          <id>mule-releases</id>
          <url>https://repository-master.mulesoft.org/nexus/content/repositories/releases</url>
      </pluginRepository>
      <pluginRepository>
          <id>mule-snapshots</id>
          <url>https://repository-master.mulesoft.org/nexus/content/repositories/snapshots</url>
      </pluginRepository>
  </pluginRepositories>
  ```

## Compile a DataWeave Library

Run the `compile` goal to compile your DataWeave library from source code, for example:

```console
mvn compile
```

## Test a DataWeave Library

Run the `test` goal to execute the DataWeave test suite included in your library, for example:

```console
mvn test
```

The Maven plugin for DataWeave uses the [DataWeave testing framework](https://docs.mulesoft.com/dataweave/2.6/dataweave-testing-framework)
to run your test suite, which supports configuring additional parameters when you run the `test`
goal.

### Configure the Test Suite

Inside the `plugin` configuration, add a `tests` element configured to use parameters that meet your
testing needs:

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>output</code></p></div></div></td><td><div><div><p><code>String</code></p></div></div></td><td><div><div><p><code>${project.build.directory}/data-weave-test-reports</code></p></div></div></td><td><div><div><p>Specifies the path for the directory in which all the auto-generated reports are created when the test runs.</p></div></div></td></tr><tr><td><div><div><p><code>htmlReport</code></p></div></div></td><td><div><div><p><code>boolean</code></p></div></div></td><td><div><div><p><code>true</code></p></div></div></td><td><div><div><p>When this property is set to <code>true</code>, the test suite generates an HTML report about the execution.</p></div></div></td></tr><tr><td><div><div><p><code>coverageEnabled</code></p></div></div></td><td><div><div><p><code>boolean</code></p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div><div><p>When this property is set to <code>true</code>, the test suite generates a coverage report about the execution.</p></div></div></td></tr><tr><td><div><div><p><code>coverageFormat</code></p></div></div></td><td><div><div><p><code>String</code></p></div></div></td><td><div><div><p><code>sonar</code></p></div></div></td><td><div><div><p>Specifies the format for the coverage report, one of:</p></div><div><ul><li><p><code>sonar</code><br>Generates a valid <a href="https://www.sonarsource.com/products/sonarqube/" target="_blank" rel="noopener">Sonar</a> coverage report for your test suite.</p></li><li><p><code>html</code><br>Generates an HTML coverage report for your test suite.</p></li></ul></div></div></td></tr><tr><td><div><div><p><code>runnerLogForkedProcessCommand</code></p></div></div></td><td><div><div><p><code>boolean</code></p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div><div><p>When set to <code>true</code>, logs the command used to launch the test runner process.</p></div></div></td></tr><tr><td><div><div><p><code>runnerEnvironmentVariables</code></p></div></div></td><td><div><div><p><code>Map</code></p></div></div></td><td><div><div><p><code>null</code></p></div></div></td><td><div><div><p>A set of additional environment variables to pass to the test runner process.</p></div></div></td></tr><tr><td><div><div><p><code>runnerSystemProperties</code></p></div></div></td><td><div><div><p><code>Map</code></p></div></div></td><td><div><div><p><code>null</code></p></div></div></td><td><div><div><p>A set of additional system properties to pass to the test runner process.</p></div></div></td></tr><tr><td><div><div><p><code>runnerArgLine</code></p></div></div></td><td><div><div><p><code>boolean</code></p></div></div></td><td><div><div><p><code>null</code></p></div></div></td><td><div><div><p>A set of additional JVM options to pass to the test runner process.</p></div></div></td></tr><tr><td><div><div><p><code>runnerJvmDebug</code></p></div></div></td><td><div><div><p><code>boolean</code></p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div><div><p>When set to <code>true</code>, enables remote debugging for the test runner JVM.</p></div></div></td></tr></tbody></table>

### Test Configuration Example

The following example enables the `sonar` coverage report and disables `htmlReport` in a project.

Example `pom.xml` file

```xml
<plugin>
  <groupId>org.mule.weave</groupId>
  <artifactId>data-weave-maven-plugin</artifactId>
  <version>2.9.0</version>
  <extensions>true</extensions>
  <configuration>
    ...
    <tests>
      <htmlReport>false</htmlReport>
      <coverageEnabled>true</coverageEnabled>
      <coverageFormat>sonar</coverageFormat>
    </tests>
    ...
  </configuration>
</plugin>
```

## Generate Documentation for a DataWeave Library

Run the `data-weave:generate-docs` goal to auto-generate the documentation for your DataWeave
library, for example:

```console
mvn prepare-package
```

Alternatively, you can also run:

```console
mvn data-weave:generate-docs
```

### Configure the Automated Docs Generation

Inside the `plugin` configuration, add a `docs` element configured with parameters that meet your
documentation needs:

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>output</code></p></div></div></td><td><div><div><p><code>String</code></p></div></div></td><td><div><div><p><code>${project.build.directory}/data-weave-docs</code></p></div></div></td><td><div><div><p>The output directory in which the documentation files are created.</p></div></div></td></tr><tr><td><div><div><p><code>template</code></p></div></div></td><td><div><div><p><code>String</code></p></div></div></td><td><div><div><p><code>exchange_markdown</code></p></div></div></td><td><div><div><p>The template to use for the auto-generated documentation, one of:</p></div><div><ul><li><p><code>exchange_markdown</code><br>Generates the documentation in a Markdown format that is compliant with <a href="https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/exchange-experience-api/" target="_blank" rel="noopener">Exchange</a>.</p></li><li><p><code>markdown</code><br>Generates the documentation in Markdown format.</p></li><li><p><code>asciidoc</code><br>Generates the documentation in AsciiDoc format.</p></li></ul></div><div><p>Valid values are <code>exchange_markdown</code>, <code>markdown</code>, or <code>asciidoc</code>.</p></div></div></td></tr><tr><td><div><div><p><code>homePage</code></p></div></div></td><td><div><div><p><code>String</code></p></div></div></td><td><div><div><p><code>null</code></p></div></div></td><td><div><div><p>Specifies the path to a custom Markdown file to add in the home page. The file must be generated by the <code>markdown</code> or <code>exchange_markdown</code> template.</p></div></div></td></tr><tr><td><div><div><p><code>favicon</code></p></div></div></td><td><div><div><p><code>String</code></p></div></div></td><td><div><div><p><code>null</code></p></div></div></td><td><div><div><p>Specifies the path to the image file (<code>png</code> or <code>jpg</code>) to use as the asset icon in the Exchange portal.</p></div></div></td></tr></tbody></table>

### Docs Generation Example

The following example shows how to configure both a custom home page and a specific favicon to
include in the Exchange portal home page of your DataWeave library:

Example `pom.xml` file:

```xml
<plugin>
  <groupId>org.mule.weave</groupId>
  <artifactId>data-weave-maven-plugin</artifactId>
  <version>2.9.0</version>
  <extensions>true</extensions>
  <configuration>
    ...
    <docs>
      <homePage>${project.basedir}/README.md</homePage>
      <favicon>${project.basedir}/src/main/resources/favicon/parrot.jpg</favicon>
    </docs>
    ...
  </configuration>
</plugin>
```

## Deploy DataWeave Libraries and Upload Documentation to Exchange

Before uploading DataWeave libraries to Exchange, ensure that the `pom.xml` file includes all
MuleSoft repositories and your credentials for Maven to access the enterprise repository. See
[Publish an Asset to Exchange Using Maven](https://docs.mulesoft.com/exchange/to-publish-assets-maven#publish-an-asset-to-exchange-using-maven)
for instructions to set up your DataWeave library.

After reviewing the `pom.xml` file, run the `deploy` goal to deploy the DataWeave library to the
deployment target, and upload the generated documentation to Exchange, for example:

```console
mvn deploy
```

### Skip Exchange Documentation Upload

You can skip the Exchange documentation upload when deploying a DataWeave project by setting the
`skipDeployDocs` system property to `true`:

```console
mvn deploy -DskipDeployDocs=true
```

### Upload the Documentation to Exchange

Alternatively, you can run the `data-weave:deploy-docs` goal to upload the generated documentation
to Exchange without deploying the DataWeave library, for example:

```console
mvn data-weave:deploy-docs
```

## DataWeave Library Structure Reference

When designing your DataWeave library, use the basic components `src` and `pom.xml`:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Component</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>src</code></p></div></div></td><td><div><div><p>Folder</p></div></div></td><td><div><div><p>The source directory for your DataWeave library’s production source code and tests.</p></div></div></td></tr><tr><td><div><div><p><code>pom.xml</code></p></div></div></td><td><div><div><p>Descriptor</p></div></div></td><td><div><div><p>The POM file of your DataWeave library. This file describes all of your library’s required dependencies.</p></div></div></td></tr></tbody></table>

## Source Directory Reference

The directory structure of a DataWeave library comprises the `src/main` and `src/test` folders.

### src/main

`src/main` is the root folder for all the production source code of the DataWeave library.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Folder</th><th>Folder Type</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>src/main/dw</code></p></div></div></td><td><div><div><p>source</p></div></div></td><td><div><div><p>The root folder of the DataWeave library source code files.</p></div></div></td></tr><tr><td><div><div><p><code>src/main/resources</code></p></div></div></td><td><div><div><p>resource</p></div></div></td><td><div><div><p>Contains the application resources, such as XML, JSON, and properties files.</p></div></div></td></tr></tbody></table>

### src/test

`src/test` is the root folder for all the test source code of the DataWeave library.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Folder</th><th>Folder Type</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>src/test/dw</code></p></div></div></td><td><div><div><p>source</p></div></div></td><td><div><div><p>The root folder of the test cases used to validate the DataWeave library.</p></div></div></td></tr><tr><td><div><div><p><code>src/test/resources</code></p></div></div></td><td><div><div><p>resource</p></div></div></td><td><div><div><p>Contains resources, such as XML, JSON, and properties files. This folder also contains files required to run your test suite.</p></div></div></td></tr></tbody></table>

## See Also

- [DataWeave Extension](https://docs.mulesoft.com/dataweave/2.6/dataweave-extension)

- [Testing DataWeave Libraries and Modules](https://docs.mulesoft.com/dataweave/2.6/dataweave-testing-framework)

- [Installing and Using the DataWeave Extension](https://docs.mulesoft.com/dataweave/2.6/dataweave-extension-plugin)

<!-- document id=6301e982bbbda8eef820dd682327a5e03d2f06989d79af5779708fbd97fedf38 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-maven-plugin.md -->

---
product: DataWeave
version: 2.9
---

# Packaging and Deploying DataWeave Libraries

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Use the Apache Maven plugin for DataWeave to integrate the packaging and deployment of your
DataWeave libraries with your Maven lifecycle.

The plugin enables you to run six main goals:

- `compile`  
  Compiles the source code for your DataWeave library.

- `test`  
  Tests the compiled source code using the
  [DataWeave testing framework](https://docs.mulesoft.com/dataweave/2.9/dataweave-testing-framework).

- `data-weave:generate-docs`  
  Automatically generates the documentation for your DataWeave library.

- `package`  
  Packages the compiled code in a `.jar` file.

- `data-weave:deploy-docs`  
  Uploads the auto-generated documentation for your DataWeave library to Anypoint Exchange.

- `deploy`  
  Automatically uploads your DataWeave library to the deployment target and uploads the
  auto-generated documentation to Exchange.

## Add the Maven Plugin to a Project

To enable the Maven plugin for DataWeave in your project:

- Add the following Maven dependency to your project’s `pom.xml` file:

  ```xml
  <plugin>
    <groupId>org.mule.weave</groupId>
    <artifactId>data-weave-maven-plugin</artifactId>
    <version>2.9.0</version>
    <extensions>true</extensions>
  </plugin>
  ```

- Add the following repositories to your project’s `pom.xml` file::

  ```xml
  <pluginRepositories>
      <pluginRepository>
          <id>mule-releases</id>
          <url>https://repository-master.mulesoft.org/nexus/content/repositories/releases</url>
      </pluginRepository>
      <pluginRepository>
          <id>mule-snapshots</id>
          <url>https://repository-master.mulesoft.org/nexus/content/repositories/snapshots</url>
      </pluginRepository>
  </pluginRepositories>
  ```

## Compile a DataWeave Library

Run the `compile` goal to compile your DataWeave library from source code, for example:

```console
mvn compile
```

## Test a DataWeave Library

Run the `test` goal to execute the DataWeave test suite included in your library, for example:

```console
mvn test
```

The Maven plugin for DataWeave uses the [DataWeave testing framework](https://docs.mulesoft.com/dataweave/2.9/dataweave-testing-framework)
to run your test suite, which supports configuring additional parameters when you run the `test`
goal.

### Configure the Test Suite

Inside the `plugin` configuration, add a `tests` element configured to use parameters that meet your
testing needs:

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>output</code></p></div></div></td><td><div><div><p><code>String</code></p></div></div></td><td><div><div><p><code>${project.build.directory}/data-weave-test-reports</code></p></div></div></td><td><div><div><p>Specifies the path for the directory in which all the auto-generated reports are created when the test runs.</p></div></div></td></tr><tr><td><div><div><p><code>htmlReport</code></p></div></div></td><td><div><div><p><code>boolean</code></p></div></div></td><td><div><div><p><code>true</code></p></div></div></td><td><div><div><p>When this property is set to <code>true</code>, the test suite generates an HTML report about the execution.</p></div></div></td></tr><tr><td><div><div><p><code>coverageEnabled</code></p></div></div></td><td><div><div><p><code>boolean</code></p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div><div><p>When this property is set to <code>true</code>, the test suite generates a coverage report about the execution.</p></div></div></td></tr><tr><td><div><div><p><code>coverageFormat</code></p></div></div></td><td><div><div><p><code>String</code></p></div></div></td><td><div><div><p><code>sonar</code></p></div></div></td><td><div><div><p>Specifies the format for the coverage report, one of:</p></div><div><ul><li><p><code>sonar</code><br>Generates a valid <a href="https://www.sonarsource.com/products/sonarqube/" target="_blank" rel="noopener">Sonar</a> coverage report for your test suite.</p></li><li><p><code>html</code><br>Generates an HTML coverage report for your test suite.</p></li></ul></div></div></td></tr><tr><td><div><div><p><code>runnerLogForkedProcessCommand</code></p></div></div></td><td><div><div><p><code>boolean</code></p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div><div><p>When set to <code>true</code>, logs the command used to launch the test runner process.</p></div></div></td></tr><tr><td><div><div><p><code>runnerEnvironmentVariables</code></p></div></div></td><td><div><div><p><code>Map</code></p></div></div></td><td><div><div><p><code>null</code></p></div></div></td><td><div><div><p>A set of additional environment variables to pass to the test runner process.</p></div></div></td></tr><tr><td><div><div><p><code>runnerSystemProperties</code></p></div></div></td><td><div><div><p><code>Map</code></p></div></div></td><td><div><div><p><code>null</code></p></div></div></td><td><div><div><p>A set of additional system properties to pass to the test runner process.</p></div></div></td></tr><tr><td><div><div><p><code>runnerArgLine</code></p></div></div></td><td><div><div><p><code>boolean</code></p></div></div></td><td><div><div><p><code>null</code></p></div></div></td><td><div><div><p>A set of additional JVM options to pass to the test runner process.</p></div></div></td></tr><tr><td><div><div><p><code>runnerJvmDebug</code></p></div></div></td><td><div><div><p><code>boolean</code></p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div><div><p>When set to <code>true</code>, enables remote debugging for the test runner JVM.</p></div></div></td></tr></tbody></table>

### Test Configuration Example

The following example enables the `sonar` coverage report and disables `htmlReport` in a project.

Example `pom.xml` file

```xml
<plugin>
  <groupId>org.mule.weave</groupId>
  <artifactId>data-weave-maven-plugin</artifactId>
  <version>2.9.0</version>
  <extensions>true</extensions>
  <configuration>
    ...
    <tests>
      <htmlReport>false</htmlReport>
      <coverageEnabled>true</coverageEnabled>
      <coverageFormat>sonar</coverageFormat>
    </tests>
    ...
  </configuration>
</plugin>
```

## Generate Documentation for a DataWeave Library

Run the `data-weave:generate-docs` goal to auto-generate the documentation for your DataWeave
library, for example:

```console
mvn prepare-package
```

Alternatively, you can also run:

```console
mvn data-weave:generate-docs
```

### Configure the Automated Docs Generation

Inside the `plugin` configuration, add a `docs` element configured with parameters that meet your
documentation needs:

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>output</code></p></div></div></td><td><div><div><p><code>String</code></p></div></div></td><td><div><div><p><code>${project.build.directory}/data-weave-docs</code></p></div></div></td><td><div><div><p>The output directory in which the documentation files are created.</p></div></div></td></tr><tr><td><div><div><p><code>template</code></p></div></div></td><td><div><div><p><code>String</code></p></div></div></td><td><div><div><p><code>exchange_markdown</code></p></div></div></td><td><div><div><p>The template to use for the auto-generated documentation, one of:</p></div><div><ul><li><p><code>exchange_markdown</code><br>Generates the documentation in a Markdown format that is compliant with <a href="https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/exchange-experience-api/" target="_blank" rel="noopener">Exchange</a>.</p></li><li><p><code>markdown</code><br>Generates the documentation in Markdown format.</p></li><li><p><code>asciidoc</code><br>Generates the documentation in AsciiDoc format.</p></li></ul></div><div><p>Valid values are <code>exchange_markdown</code>, <code>markdown</code>, or <code>asciidoc</code>.</p></div></div></td></tr><tr><td><div><div><p><code>homePage</code></p></div></div></td><td><div><div><p><code>String</code></p></div></div></td><td><div><div><p><code>null</code></p></div></div></td><td><div><div><p>Specifies the path to a custom Markdown file to add in the home page. The file must be generated by the <code>markdown</code> or <code>exchange_markdown</code> template.</p></div></div></td></tr><tr><td><div><div><p><code>favicon</code></p></div></div></td><td><div><div><p><code>String</code></p></div></div></td><td><div><div><p><code>null</code></p></div></div></td><td><div><div><p>Specifies the path to the image file (<code>png</code> or <code>jpg</code>) to use as the asset icon in the Exchange portal.</p></div></div></td></tr></tbody></table>

### Docs Generation Example

The following example shows how to configure both a custom home page and a specific favicon to
include in the Exchange portal home page of your DataWeave library:

Example `pom.xml` file:

```xml
<plugin>
  <groupId>org.mule.weave</groupId>
  <artifactId>data-weave-maven-plugin</artifactId>
  <version>2.9.0</version>
  <extensions>true</extensions>
  <configuration>
    ...
    <docs>
      <homePage>${project.basedir}/README.md</homePage>
      <favicon>${project.basedir}/src/main/resources/favicon/parrot.jpg</favicon>
    </docs>
    ...
  </configuration>
</plugin>
```

## Deploy DataWeave Libraries and Upload Documentation to Exchange

Before uploading DataWeave libraries to Exchange, ensure that the `pom.xml` file includes all
MuleSoft repositories and your credentials for Maven to access the enterprise repository. See
[Publish an Asset to Exchange Using Maven](https://docs.mulesoft.com/exchange/to-publish-assets-maven#publish-an-asset-to-exchange-using-maven)
for instructions to set up your DataWeave library.

After reviewing the `pom.xml` file, run the `deploy` goal to deploy the DataWeave library to the
deployment target, and upload the generated documentation to Exchange, for example:

```console
mvn deploy
```

### Skip Exchange Documentation Upload

You can skip the Exchange documentation upload when deploying a DataWeave project by setting the
`skipDeployDocs` system property to `true`:

```console
mvn deploy -DskipDeployDocs=true
```

### Upload the Documentation to Exchange

Alternatively, you can run the `data-weave:deploy-docs` goal to upload the generated documentation
to Exchange without deploying the DataWeave library, for example:

```console
mvn data-weave:deploy-docs
```

## DataWeave Library Structure Reference

When designing your DataWeave library, use the basic components `src` and `pom.xml`:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Component</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>src</code></p></div></div></td><td><div><div><p>Folder</p></div></div></td><td><div><div><p>The source directory for your DataWeave library’s production source code and tests.</p></div></div></td></tr><tr><td><div><div><p><code>pom.xml</code></p></div></div></td><td><div><div><p>Descriptor</p></div></div></td><td><div><div><p>The POM file of your DataWeave library. This file describes all of your library’s required dependencies.</p></div></div></td></tr></tbody></table>

## Source Directory Reference

The directory structure of a DataWeave library comprises the `src/main` and `src/test` folders.

### src/main

`src/main` is the root folder for all the production source code of the DataWeave library.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Folder</th><th>Folder Type</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>src/main/dw</code></p></div></div></td><td><div><div><p>source</p></div></div></td><td><div><div><p>The root folder of the DataWeave library source code files.</p></div></div></td></tr><tr><td><div><div><p><code>src/main/resources</code></p></div></div></td><td><div><div><p>resource</p></div></div></td><td><div><div><p>Contains the application resources, such as XML, JSON, and properties files.</p></div></div></td></tr></tbody></table>

### src/test

`src/test` is the root folder for all the test source code of the DataWeave library.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Folder</th><th>Folder Type</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>src/test/dw</code></p></div></div></td><td><div><div><p>source</p></div></div></td><td><div><div><p>The root folder of the test cases used to validate the DataWeave library.</p></div></div></td></tr><tr><td><div><div><p><code>src/test/resources</code></p></div></div></td><td><div><div><p>resource</p></div></div></td><td><div><div><p>Contains resources, such as XML, JSON, and properties files. This folder also contains files required to run your test suite.</p></div></div></td></tr></tbody></table>

## See Also

- [DataWeave Extension](https://docs.mulesoft.com/dataweave/2.9/dataweave-extension)

- [Testing DataWeave Libraries and Modules](https://docs.mulesoft.com/dataweave/2.9/dataweave-testing-framework)

- [Installing and Using the DataWeave Extension](https://docs.mulesoft.com/dataweave/2.9/dataweave-extension-plugin)

<!-- document id=0c7f2066fb81dd8ab18cb6020bea5593f78d1a08ac40b936415534f1b8af86c0 url=/mulesoft/current/en-us/dataweave/latest/dataweave-maven-plugin.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Packaging and Deploying DataWeave Libraries

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Use the Apache Maven plugin for DataWeave to integrate the packaging and deployment of your
DataWeave libraries with your Maven lifecycle.

The plugin enables you to run six main goals:

- `compile`  
  Compiles the source code for your DataWeave library.

- `test`  
  Tests the compiled source code using the
  [DataWeave testing framework](https://docs.mulesoft.com/dataweave/latest/dataweave-testing-framework).

- `data-weave:generate-docs`  
  Automatically generates the documentation for your DataWeave library.

- `package`  
  Packages the compiled code in a `.jar` file.

- `data-weave:deploy-docs`  
  Uploads the auto-generated documentation for your DataWeave library to Anypoint Exchange.

- `deploy`  
  Automatically uploads your DataWeave library to the deployment target and uploads the
  auto-generated documentation to Exchange.

## Add the Maven Plugin to a Project

To enable the Maven plugin for DataWeave in your project:

- Add the following Maven dependency to your project’s `pom.xml` file:

  ```xml
  <plugin>
    <groupId>org.mule.weave</groupId>
    <artifactId>data-weave-maven-plugin</artifactId>
    <version>2.9.0</version>
    <extensions>true</extensions>
  </plugin>
  ```

- Add the following repositories to your project’s `pom.xml` file::

  ```xml
  <pluginRepositories>
      <pluginRepository>
          <id>mule-releases</id>
          <url>https://repository-master.mulesoft.org/nexus/content/repositories/releases</url>
      </pluginRepository>
      <pluginRepository>
          <id>mule-snapshots</id>
          <url>https://repository-master.mulesoft.org/nexus/content/repositories/snapshots</url>
      </pluginRepository>
  </pluginRepositories>
  ```

## Compile a DataWeave Library

Run the `compile` goal to compile your DataWeave library from source code, for example:

```console
mvn compile
```

## Test a DataWeave Library

Run the `test` goal to execute the DataWeave test suite included in your library, for example:

```console
mvn test
```

The Maven plugin for DataWeave uses the [DataWeave testing framework](https://docs.mulesoft.com/dataweave/latest/dataweave-testing-framework)
to run your test suite, which supports configuring additional parameters when you run the `test`
goal.

### Configure the Test Suite

Inside the `plugin` configuration, add a `tests` element configured to use parameters that meet your
testing needs:

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>output</code></p></div></div></td><td><div><div><p><code>String</code></p></div></div></td><td><div><div><p><code>${project.build.directory}/data-weave-test-reports</code></p></div></div></td><td><div><div><p>Specifies the path for the directory in which all the auto-generated reports are created when the test runs.</p></div></div></td></tr><tr><td><div><div><p><code>htmlReport</code></p></div></div></td><td><div><div><p><code>boolean</code></p></div></div></td><td><div><div><p><code>true</code></p></div></div></td><td><div><div><p>When this property is set to <code>true</code>, the test suite generates an HTML report about the execution.</p></div></div></td></tr><tr><td><div><div><p><code>coverageEnabled</code></p></div></div></td><td><div><div><p><code>boolean</code></p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div><div><p>When this property is set to <code>true</code>, the test suite generates a coverage report about the execution.</p></div></div></td></tr><tr><td><div><div><p><code>coverageFormat</code></p></div></div></td><td><div><div><p><code>String</code></p></div></div></td><td><div><div><p><code>sonar</code></p></div></div></td><td><div><div><p>Specifies the format for the coverage report, one of:</p></div><div><ul><li><p><code>sonar</code><br>Generates a valid <a href="https://www.sonarsource.com/products/sonarqube/" target="_blank" rel="noopener">Sonar</a> coverage report for your test suite.</p></li><li><p><code>html</code><br>Generates an HTML coverage report for your test suite.</p></li></ul></div></div></td></tr><tr><td><div><div><p><code>runnerLogForkedProcessCommand</code></p></div></div></td><td><div><div><p><code>boolean</code></p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div><div><p>When set to <code>true</code>, logs the command used to launch the test runner process.</p></div></div></td></tr><tr><td><div><div><p><code>runnerEnvironmentVariables</code></p></div></div></td><td><div><div><p><code>Map</code></p></div></div></td><td><div><div><p><code>null</code></p></div></div></td><td><div><div><p>A set of additional environment variables to pass to the test runner process.</p></div></div></td></tr><tr><td><div><div><p><code>runnerSystemProperties</code></p></div></div></td><td><div><div><p><code>Map</code></p></div></div></td><td><div><div><p><code>null</code></p></div></div></td><td><div><div><p>A set of additional system properties to pass to the test runner process.</p></div></div></td></tr><tr><td><div><div><p><code>runnerArgLine</code></p></div></div></td><td><div><div><p><code>boolean</code></p></div></div></td><td><div><div><p><code>null</code></p></div></div></td><td><div><div><p>A set of additional JVM options to pass to the test runner process.</p></div></div></td></tr><tr><td><div><div><p><code>runnerJvmDebug</code></p></div></div></td><td><div><div><p><code>boolean</code></p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div><div><p>When set to <code>true</code>, enables remote debugging for the test runner JVM.</p></div></div></td></tr></tbody></table>

### Test Configuration Example

The following example enables the `sonar` coverage report and disables `htmlReport` in a project.

Example `pom.xml` file

```xml
<plugin>
  <groupId>org.mule.weave</groupId>
  <artifactId>data-weave-maven-plugin</artifactId>
  <version>2.9.0</version>
  <extensions>true</extensions>
  <configuration>
    ...
    <tests>
      <htmlReport>false</htmlReport>
      <coverageEnabled>true</coverageEnabled>
      <coverageFormat>sonar</coverageFormat>
    </tests>
    ...
  </configuration>
</plugin>
```

## Configure Cryptographic Taint Analysis

The Maven plugin for DataWeave can run cryptographic taint analysis at compile time to help identify
potential security vulnerabilities in your DataWeave code. The analysis tracks literal algorithm
values that flow into parameters annotated with [`@CryptographicSink`](https://docs.mulesoft.com/dataweave/latest/dw-crypto-annotations) and
causes the build to fail when an algorithm matches your configured insecure list. For more details
about the annotation, see [Crypto Annotations](https://docs.mulesoft.com/dataweave/latest/dw-crypto-annotations).

Inside the plugin configuration, add `cryptoTaintAnalysisSettings` with values that match your
security requirements:

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>enabled</code></p></div></div></td><td><div><div><p><code>boolean</code></p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div><div><p>When set to <code>true</code>, the plugin runs cryptographic taint analysis during compilation.</p></div></div></td></tr><tr><td><div><div><p><code>insecureAlgorithms</code></p></div></div></td><td><div><div><p><code>String</code></p></div></div></td><td><div><div><p><code>""</code></p></div></div></td><td><div><div><p>Comma-separated list of cryptographic algorithms that your organization considers insecure. The plugin reports a compilation error when one of these algorithms reaches a <code>@CryptographicSink</code> parameter. For example, <code>MD5,SHA1,DES,RC4</code>.</p></div></div></td></tr><tr><td><div><div><p><code>sensitiveModules</code></p></div></div></td><td><div><div><p><code>String</code></p></div></div></td><td><div><div><p><code>""</code></p></div></div></td><td><div><div><p>Comma-separated list of DataWeave modules to flag as sensitive. Use DataWeave module notation with the <code>::</code> separator. For example, <code>dw::crypto::CryptoModule,dw::security::HashModule</code>.</p></div></div></td></tr></tbody></table>

### Cryptographic Taint Analysis Example

This example enables taint analysis and configures both insecure algorithms and sensitive modules:

Example `pom.xml` file

```xml
<plugin>
  <groupId>org.mule.weave</groupId>
  <artifactId>data-weave-maven-plugin</artifactId>
  <version>2.9.0</version>
  <extensions>true</extensions>
  <configuration>
    ...
    <cryptoTaintAnalysisSettings>
      <enabled>true</enabled>
      <insecureAlgorithms>MD5,SHA1,DES,RC4</insecureAlgorithms>
      <sensitiveModules>dw::crypto::CryptoModule,dw::security::HashModule,dw::util::SecurityModule</sensitiveModules>
    </cryptoTaintAnalysisSettings>
    ...
  </configuration>
</plugin>
```

## Generate Documentation for a DataWeave Library

Run the `data-weave:generate-docs` goal to auto-generate the documentation for your DataWeave
library, for example:

```console
mvn prepare-package
```

Alternatively, you can also run:

```console
mvn data-weave:generate-docs
```

### Configure the Automated Docs Generation

Inside the `plugin` configuration, add a `docs` element configured with parameters that meet your
documentation needs:

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>output</code></p></div></div></td><td><div><div><p><code>String</code></p></div></div></td><td><div><div><p><code>${project.build.directory}/data-weave-docs</code></p></div></div></td><td><div><div><p>The output directory in which the documentation files are created.</p></div></div></td></tr><tr><td><div><div><p><code>template</code></p></div></div></td><td><div><div><p><code>String</code></p></div></div></td><td><div><div><p><code>exchange_markdown</code></p></div></div></td><td><div><div><p>The template to use for the auto-generated documentation, one of:</p></div><div><ul><li><p><code>exchange_markdown</code><br>Generates the documentation in a Markdown format that is compliant with <a href="https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/exchange-experience-api/" target="_blank" rel="noopener">Exchange</a>.</p></li><li><p><code>markdown</code><br>Generates the documentation in Markdown format.</p></li><li><p><code>asciidoc</code><br>Generates the documentation in AsciiDoc format.</p></li></ul></div><div><p>Valid values are <code>exchange_markdown</code>, <code>markdown</code>, or <code>asciidoc</code>.</p></div></div></td></tr><tr><td><div><div><p><code>homePage</code></p></div></div></td><td><div><div><p><code>String</code></p></div></div></td><td><div><div><p><code>null</code></p></div></div></td><td><div><div><p>Specifies the path to a custom Markdown file to add in the home page. The file must be generated by the <code>markdown</code> or <code>exchange_markdown</code> template.</p></div></div></td></tr><tr><td><div><div><p><code>favicon</code></p></div></div></td><td><div><div><p><code>String</code></p></div></div></td><td><div><div><p><code>null</code></p></div></div></td><td><div><div><p>Specifies the path to the image file (<code>png</code> or <code>jpg</code>) to use as the asset icon in the Exchange portal.</p></div></div></td></tr></tbody></table>

### Docs Generation Example

The following example shows how to configure both a custom home page and a specific favicon to
include in the Exchange portal home page of your DataWeave library:

Example `pom.xml` file:

```xml
<plugin>
  <groupId>org.mule.weave</groupId>
  <artifactId>data-weave-maven-plugin</artifactId>
  <version>2.9.0</version>
  <extensions>true</extensions>
  <configuration>
    ...
    <docs>
      <homePage>${project.basedir}/README.md</homePage>
      <favicon>${project.basedir}/src/main/resources/favicon/parrot.jpg</favicon>
    </docs>
    ...
  </configuration>
</plugin>
```

## Deploy DataWeave Libraries and Upload Documentation to Exchange

Before uploading DataWeave libraries to Exchange, ensure that the `pom.xml` file includes all
MuleSoft repositories and your credentials for Maven to access the enterprise repository. See
[Publish an Asset to Exchange Using Maven](https://docs.mulesoft.com/exchange/to-publish-assets-maven#publish-an-asset-to-exchange-using-maven)
for instructions to set up your DataWeave library.

After reviewing the `pom.xml` file, run the `deploy` goal to deploy the DataWeave library to the
deployment target, and upload the generated documentation to Exchange, for example:

```console
mvn deploy
```

### Skip Exchange Documentation Upload

You can skip the Exchange documentation upload when deploying a DataWeave project by setting the
`skipDeployDocs` system property to `true`:

```console
mvn deploy -DskipDeployDocs=true
```

### Upload the Documentation to Exchange

Alternatively, you can run the `data-weave:deploy-docs` goal to upload the generated documentation
to Exchange without deploying the DataWeave library, for example:

```console
mvn data-weave:deploy-docs
```

## DataWeave Library Structure Reference

When designing your DataWeave library, use the basic components `src` and `pom.xml`:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Component</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>src</code></p></div></div></td><td><div><div><p>Folder</p></div></div></td><td><div><div><p>The source directory for your DataWeave library’s production source code and tests.</p></div></div></td></tr><tr><td><div><div><p><code>pom.xml</code></p></div></div></td><td><div><div><p>Descriptor</p></div></div></td><td><div><div><p>The POM file of your DataWeave library. This file describes all of your library’s required dependencies.</p></div></div></td></tr></tbody></table>

## Source Directory Reference

The directory structure of a DataWeave library comprises the `src/main` and `src/test` folders.

### src/main

`src/main` is the root folder for all the production source code of the DataWeave library.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Folder</th><th>Folder Type</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>src/main/dw</code></p></div></div></td><td><div><div><p>source</p></div></div></td><td><div><div><p>The root folder of the DataWeave library source code files.</p></div></div></td></tr><tr><td><div><div><p><code>src/main/resources</code></p></div></div></td><td><div><div><p>resource</p></div></div></td><td><div><div><p>Contains the application resources, such as XML, JSON, and properties files.</p></div></div></td></tr></tbody></table>

### src/test

`src/test` is the root folder for all the test source code of the DataWeave library.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Folder</th><th>Folder Type</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>src/test/dw</code></p></div></div></td><td><div><div><p>source</p></div></div></td><td><div><div><p>The root folder of the test cases used to validate the DataWeave library.</p></div></div></td></tr><tr><td><div><div><p><code>src/test/resources</code></p></div></div></td><td><div><div><p>resource</p></div></div></td><td><div><div><p>Contains resources, such as XML, JSON, and properties files. This folder also contains files required to run your test suite.</p></div></div></td></tr></tbody></table>

## See Also

- [DataWeave Extension](https://docs.mulesoft.com/dataweave/latest/dataweave-extension)

- [Testing DataWeave Libraries and Modules](https://docs.mulesoft.com/dataweave/latest/dataweave-testing-framework)

- [Installing and Using the DataWeave Extension](https://docs.mulesoft.com/dataweave/latest/dataweave-extension-plugin)

<!-- document id=fce059e4f9c13d5712ebfdb7ce36e57abf14d2b404ff76fb0cef64d856d4eae9 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook-parse-dates.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, transform, transformer, format, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Parse Dates with DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

These DataWeave examples define a function (`fun`) in the DataWeave header to normalize date
separators (`/`, `.`, and `-`) within different date formats so that all of them use the same
separator (`-`).

The examples use these functions:

- `replace` so that all dates match a single pattern.

- `mapObject` to run through the `date` elements. The script applies the normalizing function to
  each `date`.

- `as` (in the second DataWeave script) to change the data type of the values to a Date type with a
  specific date format.

## Example: Returns Dates as String Types

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
fun normalize(date) = (date) replace "/" with "-" replace "." with "-"
---
dates: (payload.dates mapObject {
    normalized_as_string: normalize($)
})
```

Input XML Payload:

```xml
<dates>
  <date>26-JUL-16</date>
  <date>27/JUL/16</date>
  <date>28.JUL.16</date>
</dates>
```

Output XML:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<dates>
  <normalized_as_string>26-JUL-16</normalized_as_string>
  <normalized_as_string>27-JUL-16</normalized_as_string>
  <normalized_as_string>28-JUL-16</normalized_as_string>
</dates>
```

## Example: Returns Dates as Date Types

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
fun normalize(date) = (date) replace "/" with "-" replace "." with "-"
---
// Outputs date values as Date types in the specified format
dates: (payload.dates mapObject {
    normalized_as_date: (normalize($) as Date {format: "d-MMM-yy"})
})
```

Input XML Payload:

```xml
<dates>
  <date>26-JUL-16</date>
  <date>27/JUL/16</date>
  <date>28.JUL.16</date>
</dates>
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<dates>
  <normalized_as_date>2016-07-26</normalized_as_date>
  <normalized_as_date>2016-07-27</normalized_as_date>
  <normalized_as_date>2016-07-28</normalized_as_date>
</dates>
```

## Related Examples

- [Add and Subtract Dates](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-add-and-subtract-time)

- [Reference Multiple Inputs](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-reference-multiple-inputs)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.11/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.11/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook)

<!-- document id=5bfe7aae3f3acf9477202ca4936607e25fee9a62d06a3d90022c00e67eeacec1 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook-parse-dates.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, transform, transformer, format, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Parse Dates with DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

These DataWeave examples define a function (`fun`) in the DataWeave header to normalize date
separators (`/`, `.`, and `-`) within different date formats so that all of them use the same
separator (`-`).

The examples use these functions:

- `replace` so that all dates match a single pattern.

- `mapObject` to run through the `date` elements. The script applies the normalizing function to
  each `date`.

- `as` (in the second DataWeave script) to change the data type of the values to a Date type with a
  specific date format.

## Example: Returns Dates as String Types

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
fun normalize(date) = (date) replace "/" with "-" replace "." with "-"
---
dates: (payload.dates mapObject {
    normalized_as_string: normalize($)
})
```

Input XML Payload:

```xml
<dates>
  <date>26-JUL-16</date>
  <date>27/JUL/16</date>
  <date>28.JUL.16</date>
</dates>
```

Output XML:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<dates>
  <normalized_as_string>26-JUL-16</normalized_as_string>
  <normalized_as_string>27-JUL-16</normalized_as_string>
  <normalized_as_string>28-JUL-16</normalized_as_string>
</dates>
```

## Example: Returns Dates as Date Types

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
fun normalize(date) = (date) replace "/" with "-" replace "." with "-"
---
// Outputs date values as Date types in the specified format
dates: (payload.dates mapObject {
    normalized_as_date: (normalize($) as Date {format: "d-MMM-yy"})
})
```

Input XML Payload:

```xml
<dates>
  <date>26-JUL-16</date>
  <date>27/JUL/16</date>
  <date>28.JUL.16</date>
</dates>
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<dates>
  <normalized_as_date>2016-07-26</normalized_as_date>
  <normalized_as_date>2016-07-27</normalized_as_date>
  <normalized_as_date>2016-07-28</normalized_as_date>
</dates>
```

## Related Examples

- [Add and Subtract Dates](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-add-and-subtract-time)

- [Reference Multiple Inputs](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-reference-multiple-inputs)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.12/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.12/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook)

<!-- document id=5edb00f67bdbac337577833446fbe3f0f0549b6b6de915ba5bed535787f2d7eb url=/mulesoft/current/en-us/dataweave/2.3/dataweave-cookbook-parse-dates.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, transform, transformer, format, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Parse Dates with DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

These DataWeave examples define a function (`fun`) in the DataWeave header to normalize date
separators (`/`, `.`, and `-`) within different date formats so that all of them use the same
separator (`-`).

The examples use these functions:

- `replace` so that all dates match a single pattern.

- `mapObject` to run through the the `date` elements. The script applies the normalizing function to
  each `date`.

- `as` (in the second DataWeave script) to change the data type of the values to a Date type with a
  specific date format.

## Example: Returns Dates as String Types

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
fun normalize(date) = (date) replace "/" with "-" replace "." with "-"
---
dates: (payload.dates mapObject {
    normalized_as_string: normalize($)
})
```

Input XML Payload:

```xml
<dates>
  <date>26-JUL-16</date>
  <date>27/JUL/16</date>
  <date>28.JUL.16</date>
</dates>
```

Output XML:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<dates>
  <normalized_as_string>26-JUL-16</normalized_as_string>
  <normalized_as_string>27-JUL-16</normalized_as_string>
  <normalized_as_string>28-JUL-16</normalized_as_string>
</dates>
```

## Example: Returns Dates as Date Types

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
fun normalize(date) = (date) replace "/" with "-" replace "." with "-"
---
// Outputs date values as Date types in the specified format
dates: (payload.dates mapObject {
    normalized_as_date: (normalize($) as Date {format: "d-MMM-yy"})
})
```

Input XML Payload:

```xml
<dates>
  <date>26-JUL-16</date>
  <date>27/JUL/16</date>
  <date>28.JUL.16</date>
</dates>
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<dates>
  <normalized_as_date>2016-07-26</normalized_as_date>
  <normalized_as_date>2016-07-27</normalized_as_date>
  <normalized_as_date>2016-07-28</normalized_as_date>
</dates>
```

## Related Examples

- [Add and Subtract Dates](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-add-and-subtract-time)

- [Reference Multiple Inputs](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-reference-multiple-inputs)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.3/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.3/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook)

<!-- document id=6ceda8ca874ec98c70274b30f6ac0ddd807b07d37409ee3f052a1823c7ee87b1 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook-parse-dates.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, transform, transformer, format, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Parse Dates with DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

These DataWeave examples define a function (`fun`) in the DataWeave header to normalize date
separators (`/`, `.`, and `-`) within different date formats so that all of them use the same
separator (`-`).

The examples use these functions:

- `replace` so that all dates match a single pattern.

- `mapObject` to run through the the `date` elements. The script applies the normalizing function to
  each `date`.

- `as` (in the second DataWeave script) to change the data type of the values to a Date type with a
  specific date format.

## Example: Returns Dates as String Types

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
fun normalize(date) = (date) replace "/" with "-" replace "." with "-"
---
dates: (payload.dates mapObject {
    normalized_as_string: normalize($)
})
```

Input XML Payload:

```xml
<dates>
  <date>26-JUL-16</date>
  <date>27/JUL/16</date>
  <date>28.JUL.16</date>
</dates>
```

Output XML:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<dates>
  <normalized_as_string>26-JUL-16</normalized_as_string>
  <normalized_as_string>27-JUL-16</normalized_as_string>
  <normalized_as_string>28-JUL-16</normalized_as_string>
</dates>
```

## Example: Returns Dates as Date Types

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
fun normalize(date) = (date) replace "/" with "-" replace "." with "-"
---
// Outputs date values as Date types in the specified format
dates: (payload.dates mapObject {
    normalized_as_date: (normalize($) as Date {format: "d-MMM-yy"})
})
```

Input XML Payload:

```xml
<dates>
  <date>26-JUL-16</date>
  <date>27/JUL/16</date>
  <date>28.JUL.16</date>
</dates>
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<dates>
  <normalized_as_date>2016-07-26</normalized_as_date>
  <normalized_as_date>2016-07-27</normalized_as_date>
  <normalized_as_date>2016-07-28</normalized_as_date>
</dates>
```

## Related Examples

- [Add and Subtract Dates](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-add-and-subtract-time)

- [Reference Multiple Inputs](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-reference-multiple-inputs)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.4/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.4/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook)

<!-- document id=65ba53b7c91228204fe89f995e0f38c169a8cafd844380fd55e5d2dd277d02a6 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook-parse-dates.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, transform, transformer, format, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Parse Dates with DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

These DataWeave examples define a function (`fun`) in the DataWeave header to normalize date
separators (`/`, `.`, and `-`) within different date formats so that all of them use the same
separator (`-`).

The examples use these functions:

- `replace` so that all dates match a single pattern.

- `mapObject` to run through the the `date` elements. The script applies the normalizing function to
  each `date`.

- `as` (in the second DataWeave script) to change the data type of the values to a Date type with a
  specific date format.

## Example: Returns Dates as String Types

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
fun normalize(date) = (date) replace "/" with "-" replace "." with "-"
---
dates: (payload.dates mapObject {
    normalized_as_string: normalize($)
})
```

Input XML Payload:

```xml
<dates>
  <date>26-JUL-16</date>
  <date>27/JUL/16</date>
  <date>28.JUL.16</date>
</dates>
```

Output XML:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<dates>
  <normalized_as_string>26-JUL-16</normalized_as_string>
  <normalized_as_string>27-JUL-16</normalized_as_string>
  <normalized_as_string>28-JUL-16</normalized_as_string>
</dates>
```

## Example: Returns Dates as Date Types

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
fun normalize(date) = (date) replace "/" with "-" replace "." with "-"
---
// Outputs date values as Date types in the specified format
dates: (payload.dates mapObject {
    normalized_as_date: (normalize($) as Date {format: "d-MMM-yy"})
})
```

Input XML Payload:

```xml
<dates>
  <date>26-JUL-16</date>
  <date>27/JUL/16</date>
  <date>28.JUL.16</date>
</dates>
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<dates>
  <normalized_as_date>2016-07-26</normalized_as_date>
  <normalized_as_date>2016-07-27</normalized_as_date>
  <normalized_as_date>2016-07-28</normalized_as_date>
</dates>
```

## Related Examples

- [Add and Subtract Dates](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-add-and-subtract-time)

- [Reference Multiple Inputs](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-reference-multiple-inputs)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.6/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.6/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook)

<!-- document id=1b733f168041e30caa59e9c4d68bd2bb38a34789008c77164b626708c2adf8da url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook-parse-dates.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, transform, transformer, format, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Parse Dates with DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

These DataWeave examples define a function (`fun`) in the DataWeave header to normalize date
separators (`/`, `.`, and `-`) within different date formats so that all of them use the same
separator (`-`).

The examples use these functions:

- `replace` so that all dates match a single pattern.

- `mapObject` to run through the `date` elements. The script applies the normalizing function to
  each `date`.

- `as` (in the second DataWeave script) to change the data type of the values to a Date type with a
  specific date format.

## Example: Returns Dates as String Types

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
fun normalize(date) = (date) replace "/" with "-" replace "." with "-"
---
dates: (payload.dates mapObject {
    normalized_as_string: normalize($)
})
```

Input XML Payload:

```xml
<dates>
  <date>26-JUL-16</date>
  <date>27/JUL/16</date>
  <date>28.JUL.16</date>
</dates>
```

Output XML:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<dates>
  <normalized_as_string>26-JUL-16</normalized_as_string>
  <normalized_as_string>27-JUL-16</normalized_as_string>
  <normalized_as_string>28-JUL-16</normalized_as_string>
</dates>
```

## Example: Returns Dates as Date Types

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
fun normalize(date) = (date) replace "/" with "-" replace "." with "-"
---
// Outputs date values as Date types in the specified format
dates: (payload.dates mapObject {
    normalized_as_date: (normalize($) as Date {format: "d-MMM-yy"})
})
```

Input XML Payload:

```xml
<dates>
  <date>26-JUL-16</date>
  <date>27/JUL/16</date>
  <date>28.JUL.16</date>
</dates>
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<dates>
  <normalized_as_date>2016-07-26</normalized_as_date>
  <normalized_as_date>2016-07-27</normalized_as_date>
  <normalized_as_date>2016-07-28</normalized_as_date>
</dates>
```

## Related Examples

- [Add and Subtract Dates](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-add-and-subtract-time)

- [Reference Multiple Inputs](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-reference-multiple-inputs)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.9/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.9/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook)

<!-- document id=0d6ef4d545378544de0e2d1b002f3456eaf1d0407a08250f6c69b732718f579f url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook-parse-dates.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, transform, transformer, format, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Parse Dates with DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

These DataWeave examples define a function (`fun`) in the DataWeave header to normalize date
separators (`/`, `.`, and `-`) within different date formats so that all of them use the same
separator (`-`).

The examples use these functions:

- `replace` so that all dates match a single pattern.

- `mapObject` to run through the `date` elements. The script applies the normalizing function to
  each `date`.

- `as` (in the second DataWeave script) to change the data type of the values to a Date type with a
  specific date format.

## Example: Returns Dates as String Types

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
fun normalize(date) = (date) replace "/" with "-" replace "." with "-"
---
dates: (payload.dates mapObject {
    normalized_as_string: normalize($)
})
```

Input XML Payload:

```xml
<dates>
  <date>26-JUL-16</date>
  <date>27/JUL/16</date>
  <date>28.JUL.16</date>
</dates>
```

Output XML:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<dates>
  <normalized_as_string>26-JUL-16</normalized_as_string>
  <normalized_as_string>27-JUL-16</normalized_as_string>
  <normalized_as_string>28-JUL-16</normalized_as_string>
</dates>
```

## Example: Returns Dates as Date Types

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
fun normalize(date) = (date) replace "/" with "-" replace "." with "-"
---
// Outputs date values as Date types in the specified format
dates: (payload.dates mapObject {
    normalized_as_date: (normalize($) as Date {format: "d-MMM-yy"})
})
```

Input XML Payload:

```xml
<dates>
  <date>26-JUL-16</date>
  <date>27/JUL/16</date>
  <date>28.JUL.16</date>
</dates>
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<dates>
  <normalized_as_date>2016-07-26</normalized_as_date>
  <normalized_as_date>2016-07-27</normalized_as_date>
  <normalized_as_date>2016-07-28</normalized_as_date>
</dates>
```

## Related Examples

- [Add and Subtract Dates](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-add-and-subtract-time)

- [Reference Multiple Inputs](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-reference-multiple-inputs)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/latest/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook)

<!-- document id=8e35d12cf3fba6d8410a56e89177f87180ef9f18b2e0bae52bb99ba8e2569127 url=/mulesoft/current/en-us/dataweave/2.11/dw-url-functions-parseuri.md -->

---
product: DataWeave
version: 2.11
---

# parseURI

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## parseURI(uri: String): URI

Parses a URL and returns a `URI` object.

The `isValid: Boolean` property in the output `URI` object indicates whether the parsing process
succeeded. Every field in this object is optional, and a field will appear in the output only if it
was present in the URL input.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>uri</code></p></td><td><p>The URI input.</p></td></tr></tbody></table>

### Example

This example parses a URL.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::URL
output application/json
---
{
  'composition': parseURI('https://en.wikipedia.org/wiki/Uniform_Resource_Identifier#footer')
}
```

#### Output

```JSON
{
  "composition": {
    "isValid": true,
    "raw": "https://en.wikipedia.org/wiki/Uniform_Resource_Identifier#footer",
    "host": "en.wikipedia.org",
    "authority": "en.wikipedia.org",
    "fragment": "footer",
    "path": "/wiki/Uniform_Resource_Identifier",
    "scheme": "https",
    "isAbsolute": true,
    "isOpaque": false
  }
}
```

<!-- document id=fd66238518db74d9d96328e05058d403b22b441efa2efa81f0af87ce46025950 url=/mulesoft/current/en-us/dataweave/2.12/dw-url-functions-parseuri.md -->

---
product: DataWeave
version: 2.12
---

# parseURI

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## parseURI(uri: String): URI

Parses a URL and returns a `URI` object.

The `isValid: Boolean` property in the output `URI` object indicates whether the parsing process
succeeded. Every field in this object is optional, and a field will appear in the output only if it
was present in the URL input.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>uri</code></p></td><td><p>The URI input.</p></td></tr></tbody></table>

### Example

This example parses a URL.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::URL
output application/json
---
{
  'composition': parseURI('https://en.wikipedia.org/wiki/Uniform_Resource_Identifier#footer')
}
```

#### Output

```JSON
{
  "composition": {
    "isValid": true,
    "raw": "https://en.wikipedia.org/wiki/Uniform_Resource_Identifier#footer",
    "host": "en.wikipedia.org",
    "authority": "en.wikipedia.org",
    "fragment": "footer",
    "path": "/wiki/Uniform_Resource_Identifier",
    "scheme": "https",
    "isAbsolute": true,
    "isOpaque": false
  }
}
```

<!-- document id=a38417a8eff58756956483755215f5394425b962d135513180d439de62c2633a url=/mulesoft/current/en-us/dataweave/2.3/dw-url-functions-parseuri.md -->

---
product: DataWeave
version: 2.3
---

# parseURI

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## parseURI(String): URI

Parses a URL and returns a `URI` object.

The `isValid: Boolean` property in the output `URI` object indicates whether the parsing process
succeeded. Every field in this object is optional, and a field will appear in the output only if it
was present in the URL input.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>uri</code></p></td><td><p>The URI input.</p></td></tr></tbody></table>

### Example

This example parses a URL.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::URL
output application/json
---
{
  'composition': parseURI('https://en.wikipedia.org/wiki/Uniform_Resource_Identifier#footer')
}
```

#### Output

```JSON
{
  "composition": {
    "isValid": true,
    "raw": "https://en.wikipedia.org/wiki/Uniform_Resource_Identifier#footer",
    "host": "en.wikipedia.org",
    "authority": "en.wikipedia.org",
    "fragment": "footer",
    "path": "/wiki/Uniform_Resource_Identifier",
    "scheme": "https",
    "isAbsolute": true,
    "isOpaque": false
  }
}
```

<!-- document id=cef0d8d8e029c2c806eb1b65ce8488571149910c2e4ff13dee534a74c72ce333 url=/mulesoft/current/en-us/dataweave/2.4/dw-url-functions-parseuri.md -->

---
product: DataWeave
version: 2.4
---

# parseURI

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## parseURI(uri: String): URI

Parses a URL and returns a `URI` object.

The `isValid: Boolean` property in the output `URI` object indicates whether the parsing process
succeeded. Every field in this object is optional, and a field will appear in the output only if it
was present in the URL input.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>uri</code></p></td><td><p>The URI input.</p></td></tr></tbody></table>

### Example

This example parses a URL.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::URL
output application/json
---
{
  'composition': parseURI('https://en.wikipedia.org/wiki/Uniform_Resource_Identifier#footer')
}
```

#### Output

```JSON
{
  "composition": {
    "isValid": true,
    "raw": "https://en.wikipedia.org/wiki/Uniform_Resource_Identifier#footer",
    "host": "en.wikipedia.org",
    "authority": "en.wikipedia.org",
    "fragment": "footer",
    "path": "/wiki/Uniform_Resource_Identifier",
    "scheme": "https",
    "isAbsolute": true,
    "isOpaque": false
  }
}
```

<!-- document id=704c496aaac61fb24d2ebbbe7e46ce5fc0c9a4913bff86b74ae4203e99773b0c url=/mulesoft/current/en-us/dataweave/2.6/dw-url-functions-parseuri.md -->

---
product: DataWeave
version: 2.6
---

# parseURI

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## parseURI(uri: String): URI

Parses a URL and returns a `URI` object.

The `isValid: Boolean` property in the output `URI` object indicates whether the parsing process
succeeded. Every field in this object is optional, and a field will appear in the output only if it
was present in the URL input.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>uri</code></p></td><td><p>The URI input.</p></td></tr></tbody></table>

### Example

This example parses a URL.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::URL
output application/json
---
{
  'composition': parseURI('https://en.wikipedia.org/wiki/Uniform_Resource_Identifier#footer')
}
```

#### Output

```JSON
{
  "composition": {
    "isValid": true,
    "raw": "https://en.wikipedia.org/wiki/Uniform_Resource_Identifier#footer",
    "host": "en.wikipedia.org",
    "authority": "en.wikipedia.org",
    "fragment": "footer",
    "path": "/wiki/Uniform_Resource_Identifier",
    "scheme": "https",
    "isAbsolute": true,
    "isOpaque": false
  }
}
```

<!-- document id=58c8c4b1f8e4566ab8b68f26101f350b439568d0764e0bc50c1725b76f529031 url=/mulesoft/current/en-us/dataweave/2.9/dw-url-functions-parseuri.md -->

---
product: DataWeave
version: 2.9
---

# parseURI

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## parseURI(uri: String): URI

Parses a URL and returns a `URI` object.

The `isValid: Boolean` property in the output `URI` object indicates whether the parsing process
succeeded. Every field in this object is optional, and a field will appear in the output only if it
was present in the URL input.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>uri</code></p></td><td><p>The URI input.</p></td></tr></tbody></table>

### Example

This example parses a URL.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::URL
output application/json
---
{
  'composition': parseURI('https://en.wikipedia.org/wiki/Uniform_Resource_Identifier#footer')
}
```

#### Output

```JSON
{
  "composition": {
    "isValid": true,
    "raw": "https://en.wikipedia.org/wiki/Uniform_Resource_Identifier#footer",
    "host": "en.wikipedia.org",
    "authority": "en.wikipedia.org",
    "fragment": "footer",
    "path": "/wiki/Uniform_Resource_Identifier",
    "scheme": "https",
    "isAbsolute": true,
    "isOpaque": false
  }
}
```

<!-- document id=725388e35ecef29f94732d534abbafc404b98b373634df86b6ae0a0ae1090d15 url=/mulesoft/current/en-us/dataweave/latest/dw-url-functions-parseuri.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# parseURI

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## parseURI(uri: String): URI

Parses a URL and returns a `URI` object.

The `isValid: Boolean` property in the output `URI` object indicates whether the parsing process
succeeded. Every field in this object is optional, and a field will appear in the output only if it
was present in the URL input.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>uri</code></p></td><td><p>The URI input.</p></td></tr></tbody></table>

### Example

This example parses a URL.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::URL
output application/json
---
{
  'composition': parseURI('https://en.wikipedia.org/wiki/Uniform_Resource_Identifier#footer')
}
```

#### Output

```JSON
{
  "composition": {
    "isValid": true,
    "raw": "https://en.wikipedia.org/wiki/Uniform_Resource_Identifier#footer",
    "host": "en.wikipedia.org",
    "authority": "en.wikipedia.org",
    "fragment": "footer",
    "path": "/wiki/Uniform_Resource_Identifier",
    "scheme": "https",
    "isAbsolute": true,
    "isOpaque": false
  }
}
```

<!-- document id=5a429198d8b243e6f78b55692c327d411db2d1cbc9fd658de3ebb53b7c2e4b98 url=/mulesoft/current/en-us/dataweave/2.11/dw-arrays-functions-partition.md -->

---
product: DataWeave
version: 2.11
---

# partition

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## partition<T>(array: Array<T>, condition: (item: T) -> Boolean): { success: Array<T>, failure: Array<T> }

Separates the array into the elements that satisfy the condition from those that do not.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements to split.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition (or expression) used to match an element in the array.</p></td></tr></tbody></table>

### Example

This example partitions numbers found within an input array. The even numbers match the criteria set
by the lambda expression `(item) → isEven(item)`. The odd do not. The function generates the
`"success"` and `"failure"` keys within the output object.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var arr = [0,1,2,3,4,5]
---
arr partition (item) -> isEven(item)
```

#### Output

```json
{
  "success": [0, 2, 4],
  "failure": [1, 3, 5]
}
```

## partition(array: Null, condition: (item: Nothing) -> Any): Null

Helper function that enables `partition` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=8c674bdb572e96733d596624ed49054415a5449b54087683a0f30ee5e2bad162 url=/mulesoft/current/en-us/dataweave/2.12/dw-arrays-functions-partition.md -->

---
product: DataWeave
version: 2.12
---

# partition

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## partition<T>(array: Array<T>, condition: (item: T) -> Boolean): { success: Array<T>, failure: Array<T> }

Separates the array into the elements that satisfy the condition from those that do not.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements to split.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition (or expression) used to match an element in the array.</p></td></tr></tbody></table>

### Example

This example partitions numbers found within an input array. The even numbers match the criteria set
by the lambda expression `(item) → isEven(item)`. The odd do not. The function generates the
`"success"` and `"failure"` keys within the output object.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var arr = [0,1,2,3,4,5]
---
arr partition (item) -> isEven(item)
```

#### Output

```json
{
  "success": [0, 2, 4],
  "failure": [1, 3, 5]
}
```

## partition(array: Null, condition: (item: Nothing) -> Any): Null

Helper function that enables `partition` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=75d8440ec21b5dba0d1942a045c112864525cacc90a09e880b88d0edaba93620 url=/mulesoft/current/en-us/dataweave/2.3/dw-arrays-functions-partition.md -->

---
product: DataWeave
version: 2.3
---

# partition

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## partition(Array<T>, (item: T) -> Boolean): { success: Array<T>, failure: Array<T> }

Separates the array into the elements that satisfy the condition from those that do not.

_Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements to split.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition (or expression) used to match an element in the array.</p></td></tr></tbody></table>

### Example

This example partitions numbers found within an input array. The even numbers match the criteria set
by the lambda expression `(item) → isEven(item)`. The odd do not. The function generates the
`"success"` and `"failure"` keys within the output object.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var arr = [0,1,2,3,4,5]
---
arr partition (item) -> isEven(item)
```

#### Output

```json
{
  "success": [0, 2, 4],
  "failure": [1, 3, 5]
}
```

<!-- document id=dfedd351e7f98f043dde7759aab401a6668736989ea86985e30ee43368b36852 url=/mulesoft/current/en-us/dataweave/2.4/dw-arrays-functions-partition.md -->

---
product: DataWeave
version: 2.4
---

# partition

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## partition<T>(array: Array<T>, condition: (item: T) -> Boolean): { success: Array<T>, failure: Array<T> }

Separates the array into the elements that satisfy the condition from those that do not.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements to split.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition (or expression) used to match an element in the array.</p></td></tr></tbody></table>

### Example

This example partitions numbers found within an input array. The even numbers match the criteria set
by the lambda expression `(item) → isEven(item)`. The odd do not. The function generates the
`"success"` and `"failure"` keys within the output object.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var arr = [0,1,2,3,4,5]
---
arr partition (item) -> isEven(item)
```

#### Output

```json
{
  "success": [0, 2, 4],
  "failure": [1, 3, 5]
}
```

## partition(array: Null, condition: (item: Nothing) -> Any): Null

Helper function that enables `partition` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=36ff9154fc8c2296fae457e0cbe75490aef779de9e782f62ae9a41a8aa5dcd4f url=/mulesoft/current/en-us/dataweave/2.6/dw-arrays-functions-partition.md -->

---
product: DataWeave
version: 2.6
---

# partition

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## partition<T>(array: Array<T>, condition: (item: T) -> Boolean): { success: Array<T>, failure: Array<T> }

Separates the array into the elements that satisfy the condition from those that do not.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements to split.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition (or expression) used to match an element in the array.</p></td></tr></tbody></table>

### Example

This example partitions numbers found within an input array. The even numbers match the criteria set
by the lambda expression `(item) → isEven(item)`. The odd do not. The function generates the
`"success"` and `"failure"` keys within the output object.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var arr = [0,1,2,3,4,5]
---
arr partition (item) -> isEven(item)
```

#### Output

```json
{
  "success": [0, 2, 4],
  "failure": [1, 3, 5]
}
```

## partition(array: Null, condition: (item: Nothing) -> Any): Null

Helper function that enables `partition` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=950100be51b884822f84821fa77422befe501021d735c7088c5eb1864e31a1a4 url=/mulesoft/current/en-us/dataweave/2.9/dw-arrays-functions-partition.md -->

---
product: DataWeave
version: 2.9
---

# partition

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## partition<T>(array: Array<T>, condition: (item: T) -> Boolean): { success: Array<T>, failure: Array<T> }

Separates the array into the elements that satisfy the condition from those that do not.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements to split.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition (or expression) used to match an element in the array.</p></td></tr></tbody></table>

### Example

This example partitions numbers found within an input array. The even numbers match the criteria set
by the lambda expression `(item) → isEven(item)`. The odd do not. The function generates the
`"success"` and `"failure"` keys within the output object.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var arr = [0,1,2,3,4,5]
---
arr partition (item) -> isEven(item)
```

#### Output

```json
{
  "success": [0, 2, 4],
  "failure": [1, 3, 5]
}
```

## partition(array: Null, condition: (item: Nothing) -> Any): Null

Helper function that enables `partition` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=6db1795a165a5b3370e274ce584601923322edfc20629f545ec9bf4f393b1a1f url=/mulesoft/current/en-us/dataweave/latest/dw-arrays-functions-partition.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# partition

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## partition<T>(array: Array<T>, condition: (item: T) -> Boolean): { success: Array<T>, failure: Array<T> }

Separates the array into the elements that satisfy the condition from those that do not.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements to split.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition (or expression) used to match an element in the array.</p></td></tr></tbody></table>

### Example

This example partitions numbers found within an input array. The even numbers match the criteria set
by the lambda expression `(item) → isEven(item)`. The odd do not. The function generates the
`"success"` and `"failure"` keys within the output object.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var arr = [0,1,2,3,4,5]
---
arr partition (item) -> isEven(item)
```

#### Output

```json
{
  "success": [0, 2, 4],
  "failure": [1, 3, 5]
}
```

## partition(array: Null, condition: (item: Nothing) -> Any): Null

Helper function that enables `partition` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=e032706ab1aab0913d19af48e8e091728edcb5aae0a4764604f299a222026b84 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook-pass-functions-as-arguments.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Pass Functions as Arguments

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example defines a base function in the header that receives two arguments: a function
and an element to apply it on. The base function the applies the received function onto the keys of
the received element and also to every one of its child elements recursively. In this case, the
function sent sets all keys to lower case.

The example uses the following:

- A custom function that is applied recursively, ie: it calls itself for each child in the element
  it receives originally.

- `mapObject` to sort through each child of the element.

- `lower` from the Strings library to make every Key in the input lower case.

- `is` to check if the passed element is of type `Object` (and therefore has children).

- `if` and `else` to only have the function call itself when a condition is met, and to otherwise
  end the recursive loop for that branch.

DataWeave Script:

```dataweave
%dw 2.0
import * from dw::core::Strings
output application/xml
fun applyToKeys(element, func) =
    if (element is Object)
        element mapObject (value, key) -> {
        (func(key)) : applyToKeys( value, func)
        }
    else element
---
applyToKeys(payload, (key) -> lower(key))
```

Input XML Payload:

```xml
<CATALOG>
  <CD>
    <TITLE>Empire Burlesque</TITLE>
    <ARTIST>Bob Dylan</ARTIST>
    <COUNTRY>USA</COUNTRY>
    <COMPANY>Columbia</COMPANY>
    <PRICE>10.90</PRICE>
    <YEAR>1985</YEAR>
  </CD>
  <CD>
    <TITLE>Hide your heart</TITLE>
    <ARTIST>Bonnie Tyler</ARTIST>
    <COUNTRY>UK</COUNTRY>
    <COMPANY>CBS Records</COMPANY>
    <PRICE>9.90</PRICE>
    <YEAR>1988</YEAR>
  </CD>
</CATALOG>
```

Output XML:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<catalog>
  <cd>
    <title>Empire Burlesque</title>
    <artist>Bob Dylan</artist>
    <country>USA</country>
    <company>Columbia</company>
    <price>10.90</price>
    <year>1985</year>
  </cd>
  <cd>
    <title>Hide your heart</title>
    <artist>Bonnie Tyler</artist>
    <country>UK</country>
    <company>CBS Records</company>
    <price>9.90</price>
    <year>1988</year>
  </cd>
</catalog>
```

## Related Examples

- [Define a Custom Addition Function](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-define-a-custom-addition-function)

- [Dynamically Map Based On a Definition](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-map-based-on-an-external-definition)

- [Define a Function that Flattens Data in a List](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-define-function-to-flatten-list)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-conditional-list-reduction-via-function)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.11/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook)

<!-- document id=af5ba30ca7413b662ca515d452de2201a3bb0f07553e77e5496b1973d159063d url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook-pass-functions-as-arguments.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Pass Functions as Arguments

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example defines a base function in the header that receives two arguments: a function
and an element to apply it on. The base function the applies the received function onto the keys of
the received element and also to every one of its child elements recursively. In this case, the
function sent sets all keys to lower case.

The example uses the following:

- A custom function that is applied recursively, ie: it calls itself for each child in the element
  it receives originally.

- `mapObject` to sort through each child of the element.

- `lower` from the Strings library to make every Key in the input lower case.

- `is` to check if the passed element is of type `Object` (and therefore has children).

- `if` and `else` to only have the function call itself when a condition is met, and to otherwise
  end the recursive loop for that branch.

DataWeave Script:

```dataweave
%dw 2.0
import * from dw::core::Strings
output application/xml
fun applyToKeys(element, func) =
    if (element is Object)
        element mapObject (value, key) -> {
        (func(key)) : applyToKeys( value, func)
        }
    else element
---
applyToKeys(payload, (key) -> lower(key))
```

Input XML Payload:

```xml
<CATALOG>
  <CD>
    <TITLE>Empire Burlesque</TITLE>
    <ARTIST>Bob Dylan</ARTIST>
    <COUNTRY>USA</COUNTRY>
    <COMPANY>Columbia</COMPANY>
    <PRICE>10.90</PRICE>
    <YEAR>1985</YEAR>
  </CD>
  <CD>
    <TITLE>Hide your heart</TITLE>
    <ARTIST>Bonnie Tyler</ARTIST>
    <COUNTRY>UK</COUNTRY>
    <COMPANY>CBS Records</COMPANY>
    <PRICE>9.90</PRICE>
    <YEAR>1988</YEAR>
  </CD>
</CATALOG>
```

Output XML:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<catalog>
  <cd>
    <title>Empire Burlesque</title>
    <artist>Bob Dylan</artist>
    <country>USA</country>
    <company>Columbia</company>
    <price>10.90</price>
    <year>1985</year>
  </cd>
  <cd>
    <title>Hide your heart</title>
    <artist>Bonnie Tyler</artist>
    <country>UK</country>
    <company>CBS Records</company>
    <price>9.90</price>
    <year>1988</year>
  </cd>
</catalog>
```

## Related Examples

- [Define a Custom Addition Function](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-define-a-custom-addition-function)

- [Dynamically Map Based On a Definition](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-map-based-on-an-external-definition)

- [Define a Function that Flattens Data in a List](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-define-function-to-flatten-list)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-conditional-list-reduction-via-function)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.12/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook)

<!-- document id=fdc595367e457fd896255b12198e9ea33ff868e0aec7cc0d995042bfdeb70250 url=/mulesoft/current/en-us/dataweave/2.3/dataweave-cookbook-pass-functions-as-arguments.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Pass Functions as Arguments

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example defines a base function in the header that receives two arguments: a function
and an element to apply it on. The base function the applies the received function onto the keys of
the received element and also to every one of its child elements recursively. In this case, the
function sent sets all keys to lower case.

The example uses the following:

- A custom function that is applied recursively, ie: it calls itself for each child in the element
  it receives originally.

- `mapObject` to sort through each child of the element.

- `lower` from the Strings library to make every Key in the input lower case.

- `is` to check if the passed element is of type `Object` (and therefore has children).

- `if` and `else` to only have the function call itself when a condition is met, and to otherwise
  end the recursive loop for that branch.

DataWeave Script:

```dataweave
%dw 2.0
import * from dw::core::Strings
output application/xml
fun applyToKeys(element, func) =
    if (element is Object)
        element mapObject (value, key) -> {
        (func(key)) : applyToKeys( value, func)
        }
    else element
---
applyToKeys(payload, (key) -> lower(key))
```

Input XML Payload:

```xml
<CATALOG>
  <CD>
    <TITLE>Empire Burlesque</TITLE>
    <ARTIST>Bob Dylan</ARTIST>
    <COUNTRY>USA</COUNTRY>
    <COMPANY>Columbia</COMPANY>
    <PRICE>10.90</PRICE>
    <YEAR>1985</YEAR>
  </CD>
  <CD>
    <TITLE>Hide your heart</TITLE>
    <ARTIST>Bonnie Tyler</ARTIST>
    <COUNTRY>UK</COUNTRY>
    <COMPANY>CBS Records</COMPANY>
    <PRICE>9.90</PRICE>
    <YEAR>1988</YEAR>
  </CD>
</CATALOG>
```

Output XML:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<catalog>
  <cd>
    <title>Empire Burlesque</title>
    <artist>Bob Dylan</artist>
    <country>USA</country>
    <company>Columbia</company>
    <price>10.90</price>
    <year>1985</year>
  </cd>
  <cd>
    <title>Hide your heart</title>
    <artist>Bonnie Tyler</artist>
    <country>UK</country>
    <company>CBS Records</company>
    <price>9.90</price>
    <year>1988</year>
  </cd>
</catalog>
```

## Related Examples

- [Define a Custom Addition Function](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-define-a-custom-addition-function)

- [Dynamically Map Based On a Definition](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-map-based-on-an-external-definition)

- [Define a Function that Flattens Data in a List](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-define-function-to-flatten-list)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-conditional-list-reduction-via-function)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.3/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook)

<!-- document id=7a779d60cc395bd41a4722b05e049441831cd7e638bd547a6c15331bdef95e2e url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook-pass-functions-as-arguments.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Pass Functions as Arguments

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example defines a base function in the header that receives two arguments: a function
and an element to apply it on. The base function the applies the received function onto the keys of
the received element and also to every one of its child elements recursively. In this case, the
function sent sets all keys to lower case.

The example uses the following:

- A custom function that is applied recursively, ie: it calls itself for each child in the element
  it receives originally.

- `mapObject` to sort through each child of the element.

- `lower` from the Strings library to make every Key in the input lower case.

- `is` to check if the passed element is of type `Object` (and therefore has children).

- `if` and `else` to only have the function call itself when a condition is met, and to otherwise
  end the recursive loop for that branch.

DataWeave Script:

```dataweave
%dw 2.0
import * from dw::core::Strings
output application/xml
fun applyToKeys(element, func) =
    if (element is Object)
        element mapObject (value, key) -> {
        (func(key)) : applyToKeys( value, func)
        }
    else element
---
applyToKeys(payload, (key) -> lower(key))
```

Input XML Payload:

```xml
<CATALOG>
  <CD>
    <TITLE>Empire Burlesque</TITLE>
    <ARTIST>Bob Dylan</ARTIST>
    <COUNTRY>USA</COUNTRY>
    <COMPANY>Columbia</COMPANY>
    <PRICE>10.90</PRICE>
    <YEAR>1985</YEAR>
  </CD>
  <CD>
    <TITLE>Hide your heart</TITLE>
    <ARTIST>Bonnie Tyler</ARTIST>
    <COUNTRY>UK</COUNTRY>
    <COMPANY>CBS Records</COMPANY>
    <PRICE>9.90</PRICE>
    <YEAR>1988</YEAR>
  </CD>
</CATALOG>
```

Output XML:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<catalog>
  <cd>
    <title>Empire Burlesque</title>
    <artist>Bob Dylan</artist>
    <country>USA</country>
    <company>Columbia</company>
    <price>10.90</price>
    <year>1985</year>
  </cd>
  <cd>
    <title>Hide your heart</title>
    <artist>Bonnie Tyler</artist>
    <country>UK</country>
    <company>CBS Records</company>
    <price>9.90</price>
    <year>1988</year>
  </cd>
</catalog>
```

## Related Examples

- [Define a Custom Addition Function](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-define-a-custom-addition-function)

- [Dynamically Map Based On a Definition](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-map-based-on-an-external-definition)

- [Define a Function that Flattens Data in a List](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-define-function-to-flatten-list)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-conditional-list-reduction-via-function)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.4/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook)

<!-- document id=16a4c105c6c5ed60464c4a56037cd1884fa8cce0e809e5db11d0b2606193f8d8 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook-pass-functions-as-arguments.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Pass Functions as Arguments

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example defines a base function in the header that receives two arguments: a function
and an element to apply it on. The base function the applies the received function onto the keys of
the received element and also to every one of its child elements recursively. In this case, the
function sent sets all keys to lower case.

The example uses the following:

- A custom function that is applied recursively, ie: it calls itself for each child in the element
  it receives originally.

- `mapObject` to sort through each child of the element.

- `lower` from the Strings library to make every Key in the input lower case.

- `is` to check if the passed element is of type `Object` (and therefore has children).

- `if` and `else` to only have the function call itself when a condition is met, and to otherwise
  end the recursive loop for that branch.

DataWeave Script:

```dataweave
%dw 2.0
import * from dw::core::Strings
output application/xml
fun applyToKeys(element, func) =
    if (element is Object)
        element mapObject (value, key) -> {
        (func(key)) : applyToKeys( value, func)
        }
    else element
---
applyToKeys(payload, (key) -> lower(key))
```

Input XML Payload:

```xml
<CATALOG>
  <CD>
    <TITLE>Empire Burlesque</TITLE>
    <ARTIST>Bob Dylan</ARTIST>
    <COUNTRY>USA</COUNTRY>
    <COMPANY>Columbia</COMPANY>
    <PRICE>10.90</PRICE>
    <YEAR>1985</YEAR>
  </CD>
  <CD>
    <TITLE>Hide your heart</TITLE>
    <ARTIST>Bonnie Tyler</ARTIST>
    <COUNTRY>UK</COUNTRY>
    <COMPANY>CBS Records</COMPANY>
    <PRICE>9.90</PRICE>
    <YEAR>1988</YEAR>
  </CD>
</CATALOG>
```

Output XML:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<catalog>
  <cd>
    <title>Empire Burlesque</title>
    <artist>Bob Dylan</artist>
    <country>USA</country>
    <company>Columbia</company>
    <price>10.90</price>
    <year>1985</year>
  </cd>
  <cd>
    <title>Hide your heart</title>
    <artist>Bonnie Tyler</artist>
    <country>UK</country>
    <company>CBS Records</company>
    <price>9.90</price>
    <year>1988</year>
  </cd>
</catalog>
```

## Related Examples

- [Define a Custom Addition Function](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-define-a-custom-addition-function)

- [Dynamically Map Based On a Definition](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-map-based-on-an-external-definition)

- [Define a Function that Flattens Data in a List](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-define-function-to-flatten-list)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-conditional-list-reduction-via-function)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.6/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook)

<!-- document id=23c2f8a203a40e4988cace9ce1839e00beada65845924fae877379f6a456e536 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook-pass-functions-as-arguments.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Pass Functions as Arguments

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example defines a base function in the header that receives two arguments: a function
and an element to apply it on. The base function the applies the received function onto the keys of
the received element and also to every one of its child elements recursively. In this case, the
function sent sets all keys to lower case.

The example uses the following:

- A custom function that is applied recursively, ie: it calls itself for each child in the element
  it receives originally.

- `mapObject` to sort through each child of the element.

- `lower` from the Strings library to make every Key in the input lower case.

- `is` to check if the passed element is of type `Object` (and therefore has children).

- `if` and `else` to only have the function call itself when a condition is met, and to otherwise
  end the recursive loop for that branch.

DataWeave Script:

```dataweave
%dw 2.0
import * from dw::core::Strings
output application/xml
fun applyToKeys(element, func) =
    if (element is Object)
        element mapObject (value, key) -> {
        (func(key)) : applyToKeys( value, func)
        }
    else element
---
applyToKeys(payload, (key) -> lower(key))
```

Input XML Payload:

```xml
<CATALOG>
  <CD>
    <TITLE>Empire Burlesque</TITLE>
    <ARTIST>Bob Dylan</ARTIST>
    <COUNTRY>USA</COUNTRY>
    <COMPANY>Columbia</COMPANY>
    <PRICE>10.90</PRICE>
    <YEAR>1985</YEAR>
  </CD>
  <CD>
    <TITLE>Hide your heart</TITLE>
    <ARTIST>Bonnie Tyler</ARTIST>
    <COUNTRY>UK</COUNTRY>
    <COMPANY>CBS Records</COMPANY>
    <PRICE>9.90</PRICE>
    <YEAR>1988</YEAR>
  </CD>
</CATALOG>
```

Output XML:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<catalog>
  <cd>
    <title>Empire Burlesque</title>
    <artist>Bob Dylan</artist>
    <country>USA</country>
    <company>Columbia</company>
    <price>10.90</price>
    <year>1985</year>
  </cd>
  <cd>
    <title>Hide your heart</title>
    <artist>Bonnie Tyler</artist>
    <country>UK</country>
    <company>CBS Records</company>
    <price>9.90</price>
    <year>1988</year>
  </cd>
</catalog>
```

## Related Examples

- [Define a Custom Addition Function](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-define-a-custom-addition-function)

- [Dynamically Map Based On a Definition](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-map-based-on-an-external-definition)

- [Define a Function that Flattens Data in a List](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-define-function-to-flatten-list)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-conditional-list-reduction-via-function)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.9/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook)

<!-- document id=7eee1e44cdb5304b52c621a62556d17793448edb6a6b8377a6d48a2fb556e530 url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook-pass-functions-as-arguments.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Pass Functions as Arguments

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example defines a base function in the header that receives two arguments: a function
and an element to apply it on. The base function the applies the received function onto the keys of
the received element and also to every one of its child elements recursively. In this case, the
function sent sets all keys to lower case.

The example uses the following:

- A custom function that is applied recursively, ie: it calls itself for each child in the element
  it receives originally.

- `mapObject` to sort through each child of the element.

- `lower` from the Strings library to make every Key in the input lower case.

- `is` to check if the passed element is of type `Object` (and therefore has children).

- `if` and `else` to only have the function call itself when a condition is met, and to otherwise
  end the recursive loop for that branch.

DataWeave Script:

```dataweave
%dw 2.0
import * from dw::core::Strings
output application/xml
fun applyToKeys(element, func) =
    if (element is Object)
        element mapObject (value, key) -> {
        (func(key)) : applyToKeys( value, func)
        }
    else element
---
applyToKeys(payload, (key) -> lower(key))
```

Input XML Payload:

```xml
<CATALOG>
  <CD>
    <TITLE>Empire Burlesque</TITLE>
    <ARTIST>Bob Dylan</ARTIST>
    <COUNTRY>USA</COUNTRY>
    <COMPANY>Columbia</COMPANY>
    <PRICE>10.90</PRICE>
    <YEAR>1985</YEAR>
  </CD>
  <CD>
    <TITLE>Hide your heart</TITLE>
    <ARTIST>Bonnie Tyler</ARTIST>
    <COUNTRY>UK</COUNTRY>
    <COMPANY>CBS Records</COMPANY>
    <PRICE>9.90</PRICE>
    <YEAR>1988</YEAR>
  </CD>
</CATALOG>
```

Output XML:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<catalog>
  <cd>
    <title>Empire Burlesque</title>
    <artist>Bob Dylan</artist>
    <country>USA</country>
    <company>Columbia</company>
    <price>10.90</price>
    <year>1985</year>
  </cd>
  <cd>
    <title>Hide your heart</title>
    <artist>Bonnie Tyler</artist>
    <country>UK</country>
    <company>CBS Records</company>
    <price>9.90</price>
    <year>1988</year>
  </cd>
</catalog>
```

## Related Examples

- [Define a Custom Addition Function](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-define-a-custom-addition-function)

- [Dynamically Map Based On a Definition](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-map-based-on-an-external-definition)

- [Define a Function that Flattens Data in a List](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-define-function-to-flatten-list)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-conditional-list-reduction-via-function)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook)

<!-- document id=0ed8cfa1b4cfe72b3261258464b538faaab86276cff4b9ef1a8edea601f1c3bf url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook-pass-xml-attributes.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Pass XML Attributes

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave enables you to pass attributes from within an XML tag input source to the target output
XML. The DataWeave example shows how to pass the XML attributes in the `NameDetail` field of the
input source payload to the `TargetName` field of the XML output.

This example uses: - `.*` multivalue selector that returns an array of `NameDetail` elements. -
`map` function to iterate over the array of NameDetail elements of the input. - The dynamic
attribute expression `@dynamicAttributes` to create the attributes of the new output tag by
selecting the attributes dynamically from the input.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
{
    Result: {
        (payload.Names.*NameDetail  map ( nameDetail , indexOfNameDetail ) -> {
            TargetName @((nameDetail.@)): {
                item: nameDetail.item
            }
        })
    }
}
```

Input XML Payload:

```xml
<?xml version="1.0" encoding="UTF-8"?>
      <Names>
         <NameDetail NameId="11111" NameType="Person" Name="Richarson" GivenNames="John" PreferredLanguage="English" CompanyNumber="" Gender="Male" Title="" >
            <item>doo</item>
         </NameDetail>
         <NameDetail NameId="22222" NameType="Person" Name="Richarson" GivenNames="Susan" PreferredLanguage="Spanish" CompanyNumber="" Gender="Female" Title="" >
            <item>dah</item>
         </NameDetail>
         <NameDetail NameId="33333" NameType="Person" Name="Knox" GivenNames="Frances" PreferredLanguage="English" CompanyNumber="" Gender="Male" Title="" >
            <item>dab</item>
         </NameDetail>
      </Names>
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<Result>
  <TargetName NameId="11111" NameType="Person" Name="Richarson" GivenNames="John" PreferredLanguage="English" CompanyNumber="" Gender="Male" Title="">
    <item>doo</item>
  </TargetName>
  <TargetName NameId="22222" NameType="Person" Name="Richarson" GivenNames="Susan" PreferredLanguage="Spanish" CompanyNumber="" Gender="Female" Title="">
    <item>dah</item>
  </TargetName>
  <TargetName NameId="33333" NameType="Person" Name="Knox" GivenNames="Frances" PreferredLanguage="English" CompanyNumber="" Gender="Male" Title="">
    <item>dab</item>
  </TargetName>
</Result>
```

## Related Examples

- [Output Self-closing XML tags](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-output-self-closing-xml-tags)

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-insert-attribute)

- [Include XML Namespaces](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-include-xml-namespaces)

- [Exclude Fields from the Output](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-exclude-field)

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-output-a-field-when-present)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-conditional-list-reduction-via-function)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.11/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook)

<!-- document id=b12650419687ed271f336cbe0ae77682de8a0346434e775baba9a99d4f4c6057 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook-pass-xml-attributes.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Pass XML Attributes

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave enables you to pass attributes from within an XML tag input source to the target output
XML. The DataWeave example shows how to pass the XML attributes in the `NameDetail` field of the
input source payload to the `TargetName` field of the XML output.

This example uses: - `.*` multivalue selector that returns an array of `NameDetail` elements. -
`map` function to iterate over the array of NameDetail elements of the input. - The dynamic
attribute expression `@dynamicAttributes` to create the attributes of the new output tag by
selecting the attributes dynamically from the input.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
{
    Result: {
        (payload.Names.*NameDetail  map ( nameDetail , indexOfNameDetail ) -> {
            TargetName @((nameDetail.@)): {
                item: nameDetail.item
            }
        })
    }
}
```

Input XML Payload:

```xml
<?xml version="1.0" encoding="UTF-8"?>
      <Names>
         <NameDetail NameId="11111" NameType="Person" Name="Richarson" GivenNames="John" PreferredLanguage="English" CompanyNumber="" Gender="Male" Title="" >
            <item>doo</item>
         </NameDetail>
         <NameDetail NameId="22222" NameType="Person" Name="Richarson" GivenNames="Susan" PreferredLanguage="Spanish" CompanyNumber="" Gender="Female" Title="" >
            <item>dah</item>
         </NameDetail>
         <NameDetail NameId="33333" NameType="Person" Name="Knox" GivenNames="Frances" PreferredLanguage="English" CompanyNumber="" Gender="Male" Title="" >
            <item>dab</item>
         </NameDetail>
      </Names>
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<Result>
  <TargetName NameId="11111" NameType="Person" Name="Richarson" GivenNames="John" PreferredLanguage="English" CompanyNumber="" Gender="Male" Title="">
    <item>doo</item>
  </TargetName>
  <TargetName NameId="22222" NameType="Person" Name="Richarson" GivenNames="Susan" PreferredLanguage="Spanish" CompanyNumber="" Gender="Female" Title="">
    <item>dah</item>
  </TargetName>
  <TargetName NameId="33333" NameType="Person" Name="Knox" GivenNames="Frances" PreferredLanguage="English" CompanyNumber="" Gender="Male" Title="">
    <item>dab</item>
  </TargetName>
</Result>
```

## Related Examples

- [Output Self-closing XML tags](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-output-self-closing-xml-tags)

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-insert-attribute)

- [Include XML Namespaces](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-include-xml-namespaces)

- [Exclude Fields from the Output](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-exclude-field)

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-output-a-field-when-present)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-conditional-list-reduction-via-function)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.12/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook)

<!-- document id=c929703cdccf27d01129e1f163be3ae3e7ab80ce6f51c4b98c7ff352d0fbf775 url=/mulesoft/current/en-us/dataweave/2.3/dataweave-cookbook-pass-xml-attributes.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Pass XML Attributes

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave enables you to pass attributes from within an XML tag input source to the target output
XML. The DataWeave example shows how to pass the XML attributes in the `NameDetail` field of the
input source payload to the `TargetName` field of the XML output.

This example uses: - `.*` multivalue selector that returns an array of `NameDetail` elements. -
`map` function to iterate over the array of NameDetail elements of the input. - The dynamic
attribute expression `@dynamicAttributes` to create the attributes of the new output tag by
selecting the attributes dynamically from the input.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
{
    Result: {
        (payload.Names.*NameDetail  map ( nameDetail , indexOfNameDetail ) -> {
            TargetName @((nameDetail.@)): {
                item: nameDetail.item
            }
        })
    }
}
```

Input XML Payload:

```xml
<?xml version="1.0" encoding="UTF-8"?>
      <Names>
         <NameDetail NameId="11111" NameType="Person" Name="Richarson" GivenNames="John" PreferredLanguage="English" CompanyNumber="" Gender="Male" Title="" >
            <item>doo</item>
         </NameDetail>
         <NameDetail NameId="22222" NameType="Person" Name="Richarson" GivenNames="Susan" PreferredLanguage="Spanish" CompanyNumber="" Gender="Female" Title="" >
            <item>dah</item>
         </NameDetail>
         <NameDetail NameId="33333" NameType="Person" Name="Knox" GivenNames="Frances" PreferredLanguage="English" CompanyNumber="" Gender="Male" Title="" >
            <item>dab</item>
         </NameDetail>
      </Names>
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<Result>
  <TargetName NameId="11111" NameType="Person" Name="Richarson" GivenNames="John" PreferredLanguage="English" CompanyNumber="" Gender="Male" Title="">
    <item>doo</item>
  </TargetName>
  <TargetName NameId="22222" NameType="Person" Name="Richarson" GivenNames="Susan" PreferredLanguage="Spanish" CompanyNumber="" Gender="Female" Title="">
    <item>dah</item>
  </TargetName>
  <TargetName NameId="33333" NameType="Person" Name="Knox" GivenNames="Frances" PreferredLanguage="English" CompanyNumber="" Gender="Male" Title="">
    <item>dab</item>
  </TargetName>
</Result>
```

## Related Examples

- [Output Self-closing XML tags](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-output-self-closing-xml-tags)

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-insert-attribute)

- [Include XML Namespaces](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-include-xml-namespaces)

- [Exclude Fields from the Output](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-exclude-field)

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-output-a-field-when-present)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-conditional-list-reduction-via-function)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.3/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook)

<!-- document id=296bdb6b3edd4d1fdc3f1b0795c4cf5effdb0af8542c60c74c9a420674c0d9fe url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook-pass-xml-attributes.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Pass XML Attributes

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave enables you to pass attributes from within an XML tag input source to the target output
XML. The DataWeave example shows how to pass the XML attributes in the `NameDetail` field of the
input source payload to the `TargetName` field of the XML output.

This example uses: - `.*` multivalue selector that returns an array of `NameDetail` elements. -
`map` function to iterate over the array of NameDetail elements of the input. - The dynamic
attribute expression `@dynamicAttributes` to create the attributes of the new output tag by
selecting the attributes dynamically from the input.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
{
    Result: {
        (payload.Names.*NameDetail  map ( nameDetail , indexOfNameDetail ) -> {
            TargetName @((nameDetail.@)): {
                item: nameDetail.item
            }
        })
    }
}
```

Input XML Payload:

```xml
<?xml version="1.0" encoding="UTF-8"?>
      <Names>
         <NameDetail NameId="11111" NameType="Person" Name="Richarson" GivenNames="John" PreferredLanguage="English" CompanyNumber="" Gender="Male" Title="" >
            <item>doo</item>
         </NameDetail>
         <NameDetail NameId="22222" NameType="Person" Name="Richarson" GivenNames="Susan" PreferredLanguage="Spanish" CompanyNumber="" Gender="Female" Title="" >
            <item>dah</item>
         </NameDetail>
         <NameDetail NameId="33333" NameType="Person" Name="Knox" GivenNames="Frances" PreferredLanguage="English" CompanyNumber="" Gender="Male" Title="" >
            <item>dab</item>
         </NameDetail>
      </Names>
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<Result>
  <TargetName NameId="11111" NameType="Person" Name="Richarson" GivenNames="John" PreferredLanguage="English" CompanyNumber="" Gender="Male" Title="">
    <item>doo</item>
  </TargetName>
  <TargetName NameId="22222" NameType="Person" Name="Richarson" GivenNames="Susan" PreferredLanguage="Spanish" CompanyNumber="" Gender="Female" Title="">
    <item>dah</item>
  </TargetName>
  <TargetName NameId="33333" NameType="Person" Name="Knox" GivenNames="Frances" PreferredLanguage="English" CompanyNumber="" Gender="Male" Title="">
    <item>dab</item>
  </TargetName>
</Result>
```

## Related Examples

- [Output Self-closing XML tags](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-output-self-closing-xml-tags)

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-insert-attribute)

- [Include XML Namespaces](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-include-xml-namespaces)

- [Exclude Fields from the Output](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-exclude-field)

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-output-a-field-when-present)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-conditional-list-reduction-via-function)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.4/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook)

<!-- document id=aaf56b30924e2fd3b753beaa0e25c705606aab2480e5b11463c79c80359bda21 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook-pass-xml-attributes.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Pass XML Attributes

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave enables you to pass attributes from within an XML tag input source to the target output
XML. The DataWeave example shows how to pass the XML attributes in the `NameDetail` field of the
input source payload to the `TargetName` field of the XML output.

This example uses: - `.*` multivalue selector that returns an array of `NameDetail` elements. -
`map` function to iterate over the array of NameDetail elements of the input. - The dynamic
attribute expression `@dynamicAttributes` to create the attributes of the new output tag by
selecting the attributes dynamically from the input.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
{
    Result: {
        (payload.Names.*NameDetail  map ( nameDetail , indexOfNameDetail ) -> {
            TargetName @((nameDetail.@)): {
                item: nameDetail.item
            }
        })
    }
}
```

Input XML Payload:

```xml
<?xml version="1.0" encoding="UTF-8"?>
      <Names>
         <NameDetail NameId="11111" NameType="Person" Name="Richarson" GivenNames="John" PreferredLanguage="English" CompanyNumber="" Gender="Male" Title="" >
            <item>doo</item>
         </NameDetail>
         <NameDetail NameId="22222" NameType="Person" Name="Richarson" GivenNames="Susan" PreferredLanguage="Spanish" CompanyNumber="" Gender="Female" Title="" >
            <item>dah</item>
         </NameDetail>
         <NameDetail NameId="33333" NameType="Person" Name="Knox" GivenNames="Frances" PreferredLanguage="English" CompanyNumber="" Gender="Male" Title="" >
            <item>dab</item>
         </NameDetail>
      </Names>
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<Result>
  <TargetName NameId="11111" NameType="Person" Name="Richarson" GivenNames="John" PreferredLanguage="English" CompanyNumber="" Gender="Male" Title="">
    <item>doo</item>
  </TargetName>
  <TargetName NameId="22222" NameType="Person" Name="Richarson" GivenNames="Susan" PreferredLanguage="Spanish" CompanyNumber="" Gender="Female" Title="">
    <item>dah</item>
  </TargetName>
  <TargetName NameId="33333" NameType="Person" Name="Knox" GivenNames="Frances" PreferredLanguage="English" CompanyNumber="" Gender="Male" Title="">
    <item>dab</item>
  </TargetName>
</Result>
```

## Related Examples

- [Output Self-closing XML tags](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-output-self-closing-xml-tags)

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-insert-attribute)

- [Include XML Namespaces](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-include-xml-namespaces)

- [Exclude Fields from the Output](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-exclude-field)

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-output-a-field-when-present)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-conditional-list-reduction-via-function)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.6/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook)

<!-- document id=7acbcfd8721ec7fff6d6be347835acda562c65801f6a63a91f117f3760114aa2 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook-pass-xml-attributes.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Pass XML Attributes

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave enables you to pass attributes from within an XML tag input source to the target output
XML. The DataWeave example shows how to pass the XML attributes in the `NameDetail` field of the
input source payload to the `TargetName` field of the XML output.

This example uses: - `.*` multivalue selector that returns an array of `NameDetail` elements. -
`map` function to iterate over the array of NameDetail elements of the input. - The dynamic
attribute expression `@dynamicAttributes` to create the attributes of the new output tag by
selecting the attributes dynamically from the input.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
{
    Result: {
        (payload.Names.*NameDetail  map ( nameDetail , indexOfNameDetail ) -> {
            TargetName @((nameDetail.@)): {
                item: nameDetail.item
            }
        })
    }
}
```

Input XML Payload:

```xml
<?xml version="1.0" encoding="UTF-8"?>
      <Names>
         <NameDetail NameId="11111" NameType="Person" Name="Richarson" GivenNames="John" PreferredLanguage="English" CompanyNumber="" Gender="Male" Title="" >
            <item>doo</item>
         </NameDetail>
         <NameDetail NameId="22222" NameType="Person" Name="Richarson" GivenNames="Susan" PreferredLanguage="Spanish" CompanyNumber="" Gender="Female" Title="" >
            <item>dah</item>
         </NameDetail>
         <NameDetail NameId="33333" NameType="Person" Name="Knox" GivenNames="Frances" PreferredLanguage="English" CompanyNumber="" Gender="Male" Title="" >
            <item>dab</item>
         </NameDetail>
      </Names>
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<Result>
  <TargetName NameId="11111" NameType="Person" Name="Richarson" GivenNames="John" PreferredLanguage="English" CompanyNumber="" Gender="Male" Title="">
    <item>doo</item>
  </TargetName>
  <TargetName NameId="22222" NameType="Person" Name="Richarson" GivenNames="Susan" PreferredLanguage="Spanish" CompanyNumber="" Gender="Female" Title="">
    <item>dah</item>
  </TargetName>
  <TargetName NameId="33333" NameType="Person" Name="Knox" GivenNames="Frances" PreferredLanguage="English" CompanyNumber="" Gender="Male" Title="">
    <item>dab</item>
  </TargetName>
</Result>
```

## Related Examples

- [Output Self-closing XML tags](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-output-self-closing-xml-tags)

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-insert-attribute)

- [Include XML Namespaces](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-include-xml-namespaces)

- [Exclude Fields from the Output](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-exclude-field)

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-output-a-field-when-present)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-conditional-list-reduction-via-function)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.9/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook)

<!-- document id=de813aaaa85076cdb6d129bc8c802c54798df5f50243770ce26544f49fe16f14 url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook-pass-xml-attributes.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Pass XML Attributes

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave enables you to pass attributes from within an XML tag input source to the target output
XML. The DataWeave example shows how to pass the XML attributes in the `NameDetail` field of the
input source payload to the `TargetName` field of the XML output.

This example uses: - `.*` multivalue selector that returns an array of `NameDetail` elements. -
`map` function to iterate over the array of NameDetail elements of the input. - The dynamic
attribute expression `@dynamicAttributes` to create the attributes of the new output tag by
selecting the attributes dynamically from the input.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
{
    Result: {
        (payload.Names.*NameDetail  map ( nameDetail , indexOfNameDetail ) -> {
            TargetName @((nameDetail.@)): {
                item: nameDetail.item
            }
        })
    }
}
```

Input XML Payload:

```xml
<?xml version="1.0" encoding="UTF-8"?>
      <Names>
         <NameDetail NameId="11111" NameType="Person" Name="Richarson" GivenNames="John" PreferredLanguage="English" CompanyNumber="" Gender="Male" Title="" >
            <item>doo</item>
         </NameDetail>
         <NameDetail NameId="22222" NameType="Person" Name="Richarson" GivenNames="Susan" PreferredLanguage="Spanish" CompanyNumber="" Gender="Female" Title="" >
            <item>dah</item>
         </NameDetail>
         <NameDetail NameId="33333" NameType="Person" Name="Knox" GivenNames="Frances" PreferredLanguage="English" CompanyNumber="" Gender="Male" Title="" >
            <item>dab</item>
         </NameDetail>
      </Names>
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<Result>
  <TargetName NameId="11111" NameType="Person" Name="Richarson" GivenNames="John" PreferredLanguage="English" CompanyNumber="" Gender="Male" Title="">
    <item>doo</item>
  </TargetName>
  <TargetName NameId="22222" NameType="Person" Name="Richarson" GivenNames="Susan" PreferredLanguage="Spanish" CompanyNumber="" Gender="Female" Title="">
    <item>dah</item>
  </TargetName>
  <TargetName NameId="33333" NameType="Person" Name="Knox" GivenNames="Frances" PreferredLanguage="English" CompanyNumber="" Gender="Male" Title="">
    <item>dab</item>
  </TargetName>
</Result>
```

## Related Examples

- [Output Self-closing XML tags](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-output-self-closing-xml-tags)

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-insert-attribute)

- [Include XML Namespaces](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-include-xml-namespaces)

- [Exclude Fields from the Output](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-exclude-field)

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-output-a-field-when-present)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-conditional-list-reduction-via-function)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook)

<!-- document id=9a54d8e38524c35dac9f36aecc7dbd373e751d0941708f2f686dadd9f03c9024 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-pattern-matching.md -->

---
product: DataWeave
version: 2.11
---

# Pattern Matching in DataWeave Through match Statements

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The `match` statement behaves like a `match` or `switch` statement in other languages, like Java or
C++, and routes an input expression to a particular output expression based on some conditions.

match Statement Syntax:

```dataweave
inputExpression match {
  case <condition> -> <routing expression>
  case <condition> -> <routing expression>
  else -> <default routing expression>
}
```

As in other languages, the DataWeave `match` statement provides a compact way to organize multiple,
chained `if-else` statements. A `match` expression consists of a list of `case` statements that
optionally end with an `else` statement. Each `case` statement consists of a conditional selector
expression that must evaluate to `true` or `false`. This conditional expression corresponds to the
condition expressed by an `if` statement, followed by a corresponding DataWeave routing expression
that can include the `match` statement’s input expression.

Each `case` statement can be an `if` statement, or the `case` statement can use other
pattern-matching shortcuts to define the `case` statement’s condition. If a `case` statement is
`false`, its routing expression is ignored.

DataWeave supports four different types of patterns for a `case` statement’s condition:

- [Expressions](#pattern_match_expressions)

- [Literal values](#pattern_match_literals)

- [Data types](#pattern_match_data_types)

- [Regular expressions](#pattern_match_regex)

Each case can be named or unnamed. If the case is named, the name stores the input expression as a
local variable that can be used both in that case statement’s conditional expression and in the
corresponding routing expression.

match Statement Structure

```dataweave
value match {
  case (<name>:) <condition> -> <routing expression>
  case (<name>:) <condition> -> <routing expression>
  else -> <when none of them matched>
}
```

As this example shows, the expression returns the results of the first matching `case` statement:

match Statement Example

```dataweave
%dw 2.0
output application/json
---
"hello world" match {
	case word matches /(hello)\s\w+/ ->  word[1] as String ++ " was matched"
	case literalMatch: "hello world" -> upper(literalMatch)
	case hasOne if( hasOne is Object and hasOne.three? ) -> hasOne.three
	else -> $
}
```

Output

```json
"hello was matched"
```

Notice that you can refer to the input expression ("hello world") through each `case` statement’s
local variable name (that is, `word` or `literalMatch`), while the `else` statement can refer to the
input expression using the default parameter name `$`, an unnamed parameter.

To name the input expression in the `else` statement, you can replace the `else` statement with a
`case` statement that is always `true`:

match Statement Example

```dataweave
%dw 2.0
output application/json
---
"hello world" match {
	case word matches  /(hello)\s\w+/ ->  word[1] ++ " was matched"
	case literalMatch: "hello world" -> upper(literalMatch)
	case last if(true) -> last
}
```

For use cases in which the input is of type String, you can also use the
[match](https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-match) _function_ in the `dw::Core` module to test the string against a
regex pattern. The function returns an array with the strings that match the entire regex and any
capture groups.

For use cases that require a Boolean result based on whether a string matches a regex pattern, you
can use the [matches](https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-matches) _function_ in the `dw::Core` module instead of
using pattern matching or the module’s `match` function.

## Pattern Matching to Literal Values

Matches when the evaluated value equals a simple literal value.

In this example, the first field matches the value in `myInput.string` and returns a boolean. The
second field performs the same match, but it returns an object that contains both a boolean and a
reference to the validated value.

DataWeave Script

```dataweave
%dw 2.0
var myInput = {
  "string": "Emiliano"
}
output application/json
---
{
  a: myInput.string match {
    case "Emiliano" -> true
    case "Mariano" -> false
  },
  b: myInput.string match {
    case str: "Emiliano" -> { "matches": true, value: str }
    case str: "Mariano" -> { "matches": false, value: str }
  }
}
```

Output

```json
{
  "a": true,
  "b": {
    "matches": true,
    "value": "Emiliano"
  }
}
```

## Pattern Matching on Expressions

Matches when a given expression returns `true`.

In this example, the first field matches the value of `myInput.string` against two alternatives and
conditionally appends a different string to it. The second field evaluates if the value in
`myInput.number` is greater than (`>`), less than (`<`), or equal to (`==`) 3 and returns the
corresponding string.

DataWeave Script

```dataweave
%dw 2.0
var myInput = {
  "string": "Emiliano",
  "number": 3.14
}
output application/json
---
{
  a: myInput.string match {
    case str if str == "Mariano" -> str ++ " de Achaval"
    case str if str == "Emiliano" -> str ++ " Lesende"
  },
  b: myInput.number match {
    case num if num == 3 -> "equal"
    case num if num > 3 -> "greater than"
    case num if num < 3 -> "less than"
  }
}
```

Output

```json
{
  "a": "Emiliano Lesende",
  "b": "greater than"
}
```

## Pattern Matching on the Data Type

Matches when the evaluated value is the specified data type.

In this example, the first field evaluates the data type of `myInput.a` and returns a string with
the corresponding type name. The second field is similar but also returns the value of the
`myInput.b`.

DataWeave Script

```dataweave
%dw 2.0
var myInput =
{
  "a": "Emiliano",
  "b": 3.14
}
output application/json
---
{
  a: myInput.a match {
    case is Object -> 'OBJECT'
    case is String -> 'STRING'
    case is Number -> 'NUMBER'
    case is Boolean -> 'BOOLEAN'
    case is Array -> 'ARRAY'
    case is Null -> 'NULL'
    else -> 'ANOTHER TYPE'
  },
  b: myInput.b match {
    case y is Object -> { 'Type': { 'OBJECT' : y} }
    case y is String -> { 'Type': { 'STRING' : y} }
    case y is Number -> { 'Type': { 'NUMBER' : y} }
    case y is Boolean -> { 'Type': { 'BOOLEAN' : y} }
    case y is Array -> { 'Type': { 'ARRAY' : y} }
    case y is Null -> { 'Type': { 'NULL' : y} }
    else -> { 'Type': { 'ANOTHER TYPE' : myInput.b} }
  }
}
```

Output

```json
{
  "a": "STRING",
  "b": {
    "Type": {
      "NUMBER": 3.14
    }
  }
}
```

## Pattern Matching on Regular Expressions

Matches when the evaluated value fits a given regular expression (regex), specifically a regex
"flavor" supported by Java. In this example, the input variable (`myInput`) includes an array of
strings. The script uses the `map` function to iterate through the array. It evaluates each element
against a Java regex and outputs an object based on matches to the input.

DataWeave Script

```dataweave
%dw 2.0
var myInput = {
  "phones": [
    "+1 (415) 229-2009",
    "(647) 456-7008"
  ]
}
output application/json
---
{
  a: myInput.phones map ($ match {
     case phone matches /\+(\d+)\s\((\d+)\)\s(\d+\-\d+)/ -> { country: phone[1]}
     case phone matches /\((\d+)\)\s(\d+\-\d+)/ -> { area: phone[1], number: phone[2] }
   }),
 b: myInput.phones map ($ match {
   case phone matches /\+(\d+)\s\((\d+)\)\s(\d+\-\d+)/ -> { country: phone[1], area: phone[2], number: phone[3] }
   case phone matches /\((\d+)\)\s(\d+\-\d+)/ -> { area: phone[1], number: phone[2] }
 })
}
```

Output

```json
{
  "a": [
    {
      "country": "1"
    },
    {
      "area": "647",
      "number": "456-7008"
    }
  ],
  "b": [
    {
      "country": "1",
      "area": "415",
      "number": "229-2009"
    },
    {
      "area": "647",
      "number": "456-7008"
    }
  ]
}
```

## Deconstructors on Collections in DataWeave

DataWeave supports two types of collections: Arrays and Objects. Arrays are a sequence of values,
while Objects are a sequence of key-value pairs.

### Deconstruction on Arrays

An Array can be seen as a head (the first element of the Array) and a tail (a new Array with the
reminder of the elements). For example, in the array `[1,2,3,4]`, `1` is the head and `2,3,4` is the
tail.

To match over an array, use the following syntax, where the script gets the first element of an
array or returns null if the array is empty:

DataWeave Script

```dataweave
[1,2,3,4] match {
	case [head ~ tail] -> head
	case [] -> null
}
```

This kind of deconstruction is useful when used with recursive functions.

#### Example: Build a `joinBy` Function

This example builds a `joinBy` function that takes an array of string and returns a string with all
the elements of the Array concatenated with the given separator:

DataWeave Script

```dataweave
fun joinBy(elements: Array<String>, separator: String): String =
	elements match {
		case [head ~ tail] -> head ++ separator ++ joinBy(tail, separator) //When head and tail append and recursively
		case [] -> "" //When the array is empty return empty array
	}
```

#### Example: Build a Filter Function

This example builds a higher-order filter function:

DataWeave Script

```dataweave
fun filter<T>(elements: Array<T>, predicate: (item:T) -> Boolean): Array<T> =
	elements match {
		case [head ~ tail] ->
			if(predicate(head))
				[head] ++ filter(tail, predicate)
			else
				filter(tail, predicate)
		case [] -> []
	}
```

### Deconstruction on Objects

Objects in DataWeave are similar to Arrays but each element consists of a key and a value. An Object
can also be seen as a head (the first key-value pair) and a tail (a new Object with the rest of the
key-value pairs).

To match over an object, use the following syntax, where the script gets the first value of an
object, which in this case is "Word":

DataWeave Script

```dataweave
{hello: "world", test: true} match {
    case {headKey: headValue ~ tail} -> headValue
    case {} -> null
}
```

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.11/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.11/dataweave-selectors)

- [DataWeave Quickstart](https://docs.mulesoft.com/dataweave/2.11/dataweave-quickstart)

<!-- document id=a2243182bf0fdd2eed9a70e059bfc0459db6d4ded3d71b2e3fc549cd4291c835 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-pattern-matching.md -->

---
product: DataWeave
version: 2.12
---

# Pattern Matching in DataWeave Through match Statements

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The `match` statement behaves like a `match` or `switch` statement in other languages, like Java or
C++, and routes an input expression to a particular output expression based on some conditions.

match Statement Syntax:

```dataweave
inputExpression match {
  case <condition> -> <routing expression>
  case <condition> -> <routing expression>
  else -> <default routing expression>
}
```

As in other languages, the DataWeave `match` statement provides a compact way to organize multiple,
chained `if-else` statements. A `match` expression consists of a list of `case` statements that
optionally end with an `else` statement. Each `case` statement consists of a conditional selector
expression that must evaluate to `true` or `false`. This conditional expression corresponds to the
condition expressed by an `if` statement, followed by a corresponding DataWeave routing expression
that can include the `match` statement’s input expression.

Each `case` statement can be an `if` statement, or the `case` statement can use other
pattern-matching shortcuts to define the `case` statement’s condition. If a `case` statement is
`false`, its routing expression is ignored.

DataWeave supports four different types of patterns for a `case` statement’s condition:

- [Expressions](#pattern_match_expressions)

- [Literal values](#pattern_match_literals)

- [Data types](#pattern_match_data_types)

- [Regular expressions](#pattern_match_regex)

Each case can be named or unnamed. If the case is named, the name stores the input expression as a
local variable that can be used both in that case statement’s conditional expression and in the
corresponding routing expression.

match Statement Structure

```dataweave
value match {
  case (<name>:) <condition> -> <routing expression>
  case (<name>:) <condition> -> <routing expression>
  else -> <when none of them matched>
}
```

As this example shows, the expression returns the results of the first matching `case` statement:

match Statement Example

```dataweave
%dw 2.0
output application/json
---
"hello world" match {
	case word matches /(hello)\s\w+/ ->  word[1] as String ++ " was matched"
	case literalMatch: "hello world" -> upper(literalMatch)
	case hasOne if( hasOne is Object and hasOne.three? ) -> hasOne.three
	else -> $
}
```

Output

```json
"hello was matched"
```

Notice that you can refer to the input expression ("hello world") through each `case` statement’s
local variable name (that is, `word` or `literalMatch`), while the `else` statement can refer to the
input expression using the default parameter name `$`, an unnamed parameter.

To name the input expression in the `else` statement, you can replace the `else` statement with a
`case` statement that is always `true`:

match Statement Example

```dataweave
%dw 2.0
output application/json
---
"hello world" match {
	case word matches  /(hello)\s\w+/ ->  word[1] ++ " was matched"
	case literalMatch: "hello world" -> upper(literalMatch)
	case last if(true) -> last
}
```

For use cases in which the input is of type String, you can also use the
[match](https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-match) _function_ in the `dw::Core` module to test the string against a
regex pattern. The function returns an array with the strings that match the entire regex and any
capture groups.

For use cases that require a Boolean result based on whether a string matches a regex pattern, you
can use the [matches](https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-matches) _function_ in the `dw::Core` module instead of
using pattern matching or the module’s `match` function.

## Pattern Matching to Literal Values

Matches when the evaluated value equals a simple literal value.

In this example, the first field matches the value in `myInput.string` and returns a boolean. The
second field performs the same match, but it returns an object that contains both a boolean and a
reference to the validated value.

DataWeave Script

```dataweave
%dw 2.0
var myInput = {
  "string": "Emiliano"
}
output application/json
---
{
  a: myInput.string match {
    case "Emiliano" -> true
    case "Mariano" -> false
  },
  b: myInput.string match {
    case str: "Emiliano" -> { "matches": true, value: str }
    case str: "Mariano" -> { "matches": false, value: str }
  }
}
```

Output

```json
{
  "a": true,
  "b": {
    "matches": true,
    "value": "Emiliano"
  }
}
```

## Pattern Matching on Expressions

Matches when a given expression returns `true`.

In this example, the first field matches the value of `myInput.string` against two alternatives and
conditionally appends a different string to it. The second field evaluates if the value in
`myInput.number` is greater than (`>`), less than (`<`), or equal to (`==`) 3 and returns the
corresponding string.

DataWeave Script

```dataweave
%dw 2.0
var myInput = {
  "string": "Emiliano",
  "number": 3.14
}
output application/json
---
{
  a: myInput.string match {
    case str if str == "Mariano" -> str ++ " de Achaval"
    case str if str == "Emiliano" -> str ++ " Lesende"
  },
  b: myInput.number match {
    case num if num == 3 -> "equal"
    case num if num > 3 -> "greater than"
    case num if num < 3 -> "less than"
  }
}
```

Output

```json
{
  "a": "Emiliano Lesende",
  "b": "greater than"
}
```

## Pattern Matching on the Data Type

Matches when the evaluated value is the specified data type.

In this example, the first field evaluates the data type of `myInput.a` and returns a string with
the corresponding type name. The second field is similar but also returns the value of the
`myInput.b`.

DataWeave Script

```dataweave
%dw 2.0
var myInput =
{
  "a": "Emiliano",
  "b": 3.14
}
output application/json
---
{
  a: myInput.a match {
    case is Object -> 'OBJECT'
    case is String -> 'STRING'
    case is Number -> 'NUMBER'
    case is Boolean -> 'BOOLEAN'
    case is Array -> 'ARRAY'
    case is Null -> 'NULL'
    else -> 'ANOTHER TYPE'
  },
  b: myInput.b match {
    case y is Object -> { 'Type': { 'OBJECT' : y} }
    case y is String -> { 'Type': { 'STRING' : y} }
    case y is Number -> { 'Type': { 'NUMBER' : y} }
    case y is Boolean -> { 'Type': { 'BOOLEAN' : y} }
    case y is Array -> { 'Type': { 'ARRAY' : y} }
    case y is Null -> { 'Type': { 'NULL' : y} }
    else -> { 'Type': { 'ANOTHER TYPE' : myInput.b} }
  }
}
```

Output

```json
{
  "a": "STRING",
  "b": {
    "Type": {
      "NUMBER": 3.14
    }
  }
}
```

## Pattern Matching on Regular Expressions

Matches when the evaluated value fits a given regular expression (regex), specifically a regex
"flavor" supported by Java. In this example, the input variable (`myInput`) includes an array of
strings. The script uses the `map` function to iterate through the array. It evaluates each element
against a Java regex and outputs an object based on matches to the input.

DataWeave Script

```dataweave
%dw 2.0
var myInput = {
  "phones": [
    "+1 (415) 229-2009",
    "(647) 456-7008"
  ]
}
output application/json
---
{
  a: myInput.phones map ($ match {
     case phone matches /\+(\d+)\s\((\d+)\)\s(\d+\-\d+)/ -> { country: phone[1]}
     case phone matches /\((\d+)\)\s(\d+\-\d+)/ -> { area: phone[1], number: phone[2] }
   }),
 b: myInput.phones map ($ match {
   case phone matches /\+(\d+)\s\((\d+)\)\s(\d+\-\d+)/ -> { country: phone[1], area: phone[2], number: phone[3] }
   case phone matches /\((\d+)\)\s(\d+\-\d+)/ -> { area: phone[1], number: phone[2] }
 })
}
```

Output

```json
{
  "a": [
    {
      "country": "1"
    },
    {
      "area": "647",
      "number": "456-7008"
    }
  ],
  "b": [
    {
      "country": "1",
      "area": "415",
      "number": "229-2009"
    },
    {
      "area": "647",
      "number": "456-7008"
    }
  ]
}
```

## Deconstructors on Collections in DataWeave

DataWeave supports two types of collections: Arrays and Objects. Arrays are a sequence of values,
while Objects are a sequence of key-value pairs.

### Deconstruction on Arrays

An Array can be seen as a head (the first element of the Array) and a tail (a new Array with the
reminder of the elements). For example, in the array `[1,2,3,4]`, `1` is the head and `2,3,4` is the
tail.

To match over an array, use the following syntax, where the script gets the first element of an
array or returns null if the array is empty:

DataWeave Script

```dataweave
[1,2,3,4] match {
	case [head ~ tail] -> head
	case [] -> null
}
```

This kind of deconstruction is useful when used with recursive functions.

#### Example: Build a `joinBy` Function

This example builds a `joinBy` function that takes an array of string and returns a string with all
the elements of the Array concatenated with the given separator:

DataWeave Script

```dataweave
fun joinBy(elements: Array<String>, separator: String): String =
	elements match {
		case [head ~ tail] -> head ++ separator ++ joinBy(tail, separator) //When head and tail append and recursively
		case [] -> "" //When the array is empty return empty array
	}
```

#### Example: Build a Filter Function

This example builds a higher-order filter function:

DataWeave Script

```dataweave
fun filter<T>(elements: Array<T>, predicate: (item:T) -> Boolean): Array<T> =
	elements match {
		case [head ~ tail] ->
			if(predicate(head))
				[head] ++ filter(tail, predicate)
			else
				filter(tail, predicate)
		case [] -> []
	}
```

### Deconstruction on Objects

Objects in DataWeave are similar to Arrays but each element consists of a key and a value. An Object
can also be seen as a head (the first key-value pair) and a tail (a new Object with the rest of the
key-value pairs).

To match over an object, use the following syntax, where the script gets the first value of an
object, which in this case is "Word":

DataWeave Script

```dataweave
{hello: "world", test: true} match {
    case {headKey: headValue ~ tail} -> headValue
    case {} -> null
}
```

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.12/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.12/dataweave-selectors)

- [DataWeave Quickstart](https://docs.mulesoft.com/dataweave/2.12/dataweave-quickstart)

<!-- document id=16f9359d793e0bdef5cc89c682bd9497f1ba9946da998c9e9561b2a45ea5d07f url=/mulesoft/current/en-us/dataweave/2.3/dataweave-pattern-matching.md -->

---
product: DataWeave
version: 2.3
---

# Pattern Matching in DataWeave Through match Statements

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The `match` statement behaves like a `match` or `switch` statement in other languages, like Java or
C++, and routes an input expression to a particular output expression based on some conditions.

match Statement Syntax:

```dataweave
inputExpression match {
  case <condition> -> <routing expression>
  case <condition> -> <routing expression>
  else -> <default routing expression>
}
```

As in other languages, the DataWeave `match` statement provides a compact way to organize multiple,
chained `if-else` statements. A `match` expression consists of a list of `case` statements that
optionally end with an `else` statement. Each `case` statement consists of a conditional selector
expression that must evaluate to `true` or `false`. This conditional expression corresponds to the
condition expressed by an `if` statement, followed by a corresponding DataWeave routing expression
that can include the `match` statement’s input expression.

Each `case` statement can be an `if` statement, or the `case` statement can use other
pattern-matching shortcuts to define the `case` statement’s condition. If a `case` statement is
`false`, its routing expression is ignored.

DataWeave supports four different types of patterns for a `case` statement’s condition:

- [Expressions](#pattern_match_expressions)

- [Literal values](#pattern_match_literals)

- [Data types](#pattern_match_data_types)

- [Regular expressions](#pattern_match_regex)

Each case can be named or unnamed. If the case is named, the name stores the input expression as a
local variable that can be used both in that case statement’s conditional expression and in the
corresponding routing expression.

match Statement Structure

```dataweave
value match {
  case (<name>:) <condition> -> <routing expression>
  case (<name>:) <condition> -> <routing expression>
  else -> <when none of them matched>
}
```

As this example shows, the expression returns the results of the first matching `case` statement:

match Statement Example

```dataweave
%dw 2.0
output application/json
---
"hello world" match {
	case word matches /(hello)\s\w+/ ->  word[1] as String ++ " was matched"
	case literalMatch: "hello world" -> upper(literalMatch)
	case hasOne if( hasOne is Object and hasOne.three? ) -> hasOne.three
	else -> $
}
```

Output

```json
"hello was matched"
```

Notice that you can refer to the input expression ("hello world") through each `case` statement’s
local variable name (that is, `word` or `literalMatch`), while the `else` statement can refer to the
input expression using the default parameter name `$`, an unnamed parameter.

To name the input expression in the `else` statement, you can replace the `else` statement with a
`case` statement that is always `true`:

match Statement Example

```dataweave
%dw 2.0
output application/json
---
"hello world" match {
	case word matches  /(hello)\s\w+/ ->  word[1] ++ " was matched"
	case literalMatch: "hello world" -> upper(literalMatch)
	case last if(true) -> last
}
```

For use cases in which the input is of type String, you can also use the
[match](https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-match) _function_ in the `dw::Core` module to test the string against a
regex pattern. The function returns an array with the strings that match the entire regex and any
capture groups.

For use cases that require a Boolean result based on whether a string matches a regex pattern, you
can use the [matches](https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-matches) _function_ in the `dw::Core` module instead of
using pattern matching or the module’s `match` function.

## Pattern Matching to Literal Values

Matches when the evaluated value equals a simple literal value.

In this example, the first field matches the value in `myInput.string` and returns a boolean. The
second field performs the same match, but it returns an object that contains both a boolean and a
reference to the validated value.

DataWeave Script

```dataweave
%dw 2.0
var myInput = {
  "string": "Emiliano"
}
output application/json
---
{
  a: myInput.string match {
    case "Emiliano" -> true
    case "Mariano" -> false
  },
  b: myInput.string match {
    case str: "Emiliano" -> { "matches": true, value: str }
    case str: "Mariano" -> { "matches": false, value: str }
  }
}
```

Output

```json
{
  "a": true,
  "b": {
    "matches": true,
    "value": "Emiliano"
  }
}
```

## Pattern Matching on Expressions

Matches when a given expression returns `true`.

In this example, the first field matches the value of `myInput.string` against two alternatives and
conditionally appends a different string to it. The second field evaluates if the value in
`myInput.number` is greater than (`>`), less than (`<`), or equal to (`==`) 3 and returns the
corresponding string.

DataWeave Script

```dataweave
%dw 2.0
var myInput = {
  "string": "Emiliano",
  "number": 3.14
}
output application/json
---
{
  a: myInput.string match {
    case str if str == "Mariano" -> str ++ " de Achaval"
    case str if str == "Emiliano" -> str ++ " Lesende"
  },
  b: myInput.number match {
    case num if num == 3 -> "equal"
    case num if num > 3 -> "greater than"
    case num if num < 3 -> "less than"
  }
}
```

Output

```json
{
  "a": "Emiliano Lesende",
  "b": "greater than"
}
```

## Pattern Matching on the Data Type

Matches when the evaluated value is the specified data type.

In this example, the first field evaluates the data type of `myInput.a` and returns a string with
the corresponding type name. The second field is similar but also returns the value of the
`myInput.b`.

DataWeave Script

```dataweave
%dw 2.0
var myInput =
{
  "a": "Emiliano",
  "b": 3.14
}
output application/json
---
{
  a: myInput.a match {
    case is Object -> 'OBJECT'
    case is String -> 'STRING'
    case is Number -> 'NUMBER'
    case is Boolean -> 'BOOLEAN'
    case is Array -> 'ARRAY'
    case is Null -> 'NULL'
    else -> 'ANOTHER TYPE'
  },
  b: myInput.b match {
    case y is Object -> { 'Type': { 'OBJECT' : y} }
    case y is String -> { 'Type': { 'STRING' : y} }
    case y is Number -> { 'Type': { 'NUMBER' : y} }
    case y is Boolean -> { 'Type': { 'BOOLEAN' : y} }
    case y is Array -> { 'Type': { 'ARRAY' : y} }
    case y is Null -> { 'Type': { 'NULL' : y} }
    else -> { 'Type': { 'ANOTHER TYPE' : myInput.b} }
  }
}
```

Output

```json
{
  "a": "STRING",
  "b": {
    "Type": {
      "NUMBER": 3.14
    }
  }
}
```

## Pattern Matching on Regular Expressions

Matches when the evaluated value fits a given regular expression (regex), specifically a regex
"flavor" supported by Java. In this example, the input variable (`myInput`) includes an array of
strings. The script uses the `map` function to iterate through the array. It evaluates each element
against a Java regex and outputs an object based on matches to the input.

DataWeave Script

```dataweave
%dw 2.0
var myInput = {
  "phones": [
    "+1 (415) 229-2009",
    "(647) 456-7008"
  ]
}
output application/json
---
{
  a: myInput.phones map ($ match {
     case phone matches /\+(\d+)\s\((\d+)\)\s(\d+\-\d+)/ -> { country: phone[1]}
     case phone matches /\((\d+)\)\s(\d+\-\d+)/ -> { area: phone[1], number: phone[2] }
   }),
 b: myInput.phones map ($ match {
   case phone matches /\+(\d+)\s\((\d+)\)\s(\d+\-\d+)/ -> { country: phone[1], area: phone[2], number: phone[3] }
   case phone matches /\((\d+)\)\s(\d+\-\d+)/ -> { area: phone[1], number: phone[2] }
 })
}
```

Output

```json
{
  "a": [
    {
      "country": "1"
    },
    {
      "area": "647",
      "number": "456-7008"
    }
  ],
  "b": [
    {
      "country": "1",
      "area": "415",
      "number": "229-2009"
    },
    {
      "area": "647",
      "number": "456-7008"
    }
  ]
}
```

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.3/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.3/dataweave-selectors)

- [DataWeave Quickstart](https://docs.mulesoft.com/dataweave/2.3/dataweave-quickstart)

<!-- document id=e56e4c6e31413bb232e5b9daf55b00426d7af19a17393a823ec740caf8eab2a4 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-pattern-matching.md -->

---
product: DataWeave
version: 2.4
---

# Pattern Matching in DataWeave Through match Statements

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The `match` statement behaves like a `match` or `switch` statement in other languages, like Java or
C++, and routes an input expression to a particular output expression based on some conditions.

match Statement Syntax:

```dataweave
inputExpression match {
  case <condition> -> <routing expression>
  case <condition> -> <routing expression>
  else -> <default routing expression>
}
```

As in other languages, the DataWeave `match` statement provides a compact way to organize multiple,
chained `if-else` statements. A `match` expression consists of a list of `case` statements that
optionally end with an `else` statement. Each `case` statement consists of a conditional selector
expression that must evaluate to `true` or `false`. This conditional expression corresponds to the
condition expressed by an `if` statement, followed by a corresponding DataWeave routing expression
that can include the `match` statement’s input expression.

Each `case` statement can be an `if` statement, or the `case` statement can use other
pattern-matching shortcuts to define the `case` statement’s condition. If a `case` statement is
`false`, its routing expression is ignored.

DataWeave supports four different types of patterns for a `case` statement’s condition:

- [Expressions](#pattern_match_expressions)

- [Literal values](#pattern_match_literals)

- [Data types](#pattern_match_data_types)

- [Regular expressions](#pattern_match_regex)

Each case can be named or unnamed. If the case is named, the name stores the input expression as a
local variable that can be used both in that case statement’s conditional expression and in the
corresponding routing expression.

match Statement Structure

```dataweave
value match {
  case (<name>:) <condition> -> <routing expression>
  case (<name>:) <condition> -> <routing expression>
  else -> <when none of them matched>
}
```

As this example shows, the expression returns the results of the first matching `case` statement:

match Statement Example

```dataweave
%dw 2.0
output application/json
---
"hello world" match {
	case word matches /(hello)\s\w+/ ->  word[1] as String ++ " was matched"
	case literalMatch: "hello world" -> upper(literalMatch)
	case hasOne if( hasOne is Object and hasOne.three? ) -> hasOne.three
	else -> $
}
```

Output

```json
"hello was matched"
```

Notice that you can refer to the input expression ("hello world") through each `case` statement’s
local variable name (that is, `word` or `literalMatch`), while the `else` statement can refer to the
input expression using the default parameter name `$`, an unnamed parameter.

To name the input expression in the `else` statement, you can replace the `else` statement with a
`case` statement that is always `true`:

match Statement Example

```dataweave
%dw 2.0
output application/json
---
"hello world" match {
	case word matches  /(hello)\s\w+/ ->  word[1] ++ " was matched"
	case literalMatch: "hello world" -> upper(literalMatch)
	case last if(true) -> last
}
```

For use cases in which the input is of type String, you can also use the
[match](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-match) _function_ in the `dw::Core` module to test the string against a
regex pattern. The function returns an array with the strings that match the entire regex and any
capture groups.

For use cases that require a Boolean result based on whether a string matches a regex pattern, you
can use the [matches](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-matches) _function_ in the `dw::Core` module instead of
using pattern matching or the module’s `match` function.

## Pattern Matching to Literal Values

Matches when the evaluated value equals a simple literal value.

In this example, the first field matches the value in `myInput.string` and returns a boolean. The
second field performs the same match, but it returns an object that contains both a boolean and a
reference to the validated value.

DataWeave Script

```dataweave
%dw 2.0
var myInput = {
  "string": "Emiliano"
}
output application/json
---
{
  a: myInput.string match {
    case "Emiliano" -> true
    case "Mariano" -> false
  },
  b: myInput.string match {
    case str: "Emiliano" -> { "matches": true, value: str }
    case str: "Mariano" -> { "matches": false, value: str }
  }
}
```

Output

```json
{
  "a": true,
  "b": {
    "matches": true,
    "value": "Emiliano"
  }
}
```

## Pattern Matching on Expressions

Matches when a given expression returns `true`.

In this example, the first field matches the value of `myInput.string` against two alternatives and
conditionally appends a different string to it. The second field evaluates if the value in
`myInput.number` is greater than (`>`), less than (`<`), or equal to (`==`) 3 and returns the
corresponding string.

DataWeave Script

```dataweave
%dw 2.0
var myInput = {
  "string": "Emiliano",
  "number": 3.14
}
output application/json
---
{
  a: myInput.string match {
    case str if str == "Mariano" -> str ++ " de Achaval"
    case str if str == "Emiliano" -> str ++ " Lesende"
  },
  b: myInput.number match {
    case num if num == 3 -> "equal"
    case num if num > 3 -> "greater than"
    case num if num < 3 -> "less than"
  }
}
```

Output

```json
{
  "a": "Emiliano Lesende",
  "b": "greater than"
}
```

## Pattern Matching on the Data Type

Matches when the evaluated value is the specified data type.

In this example, the first field evaluates the data type of `myInput.a` and returns a string with
the corresponding type name. The second field is similar but also returns the value of the
`myInput.b`.

DataWeave Script

```dataweave
%dw 2.0
var myInput =
{
  "a": "Emiliano",
  "b": 3.14
}
output application/json
---
{
  a: myInput.a match {
    case is Object -> 'OBJECT'
    case is String -> 'STRING'
    case is Number -> 'NUMBER'
    case is Boolean -> 'BOOLEAN'
    case is Array -> 'ARRAY'
    case is Null -> 'NULL'
    else -> 'ANOTHER TYPE'
  },
  b: myInput.b match {
    case y is Object -> { 'Type': { 'OBJECT' : y} }
    case y is String -> { 'Type': { 'STRING' : y} }
    case y is Number -> { 'Type': { 'NUMBER' : y} }
    case y is Boolean -> { 'Type': { 'BOOLEAN' : y} }
    case y is Array -> { 'Type': { 'ARRAY' : y} }
    case y is Null -> { 'Type': { 'NULL' : y} }
    else -> { 'Type': { 'ANOTHER TYPE' : myInput.b} }
  }
}
```

Output

```json
{
  "a": "STRING",
  "b": {
    "Type": {
      "NUMBER": 3.14
    }
  }
}
```

## Pattern Matching on Regular Expressions

Matches when the evaluated value fits a given regular expression (regex), specifically a regex
"flavor" supported by Java. In this example, the input variable (`myInput`) includes an array of
strings. The script uses the `map` function to iterate through the array. It evaluates each element
against a Java regex and outputs an object based on matches to the input.

DataWeave Script

```dataweave
%dw 2.0
var myInput = {
  "phones": [
    "+1 (415) 229-2009",
    "(647) 456-7008"
  ]
}
output application/json
---
{
  a: myInput.phones map ($ match {
     case phone matches /\+(\d+)\s\((\d+)\)\s(\d+\-\d+)/ -> { country: phone[1]}
     case phone matches /\((\d+)\)\s(\d+\-\d+)/ -> { area: phone[1], number: phone[2] }
   }),
 b: myInput.phones map ($ match {
   case phone matches /\+(\d+)\s\((\d+)\)\s(\d+\-\d+)/ -> { country: phone[1], area: phone[2], number: phone[3] }
   case phone matches /\((\d+)\)\s(\d+\-\d+)/ -> { area: phone[1], number: phone[2] }
 })
}
```

Output

```json
{
  "a": [
    {
      "country": "1"
    },
    {
      "area": "647",
      "number": "456-7008"
    }
  ],
  "b": [
    {
      "country": "1",
      "area": "415",
      "number": "229-2009"
    },
    {
      "area": "647",
      "number": "456-7008"
    }
  ]
}
```

## Deconstructors on Collections in DataWeave

DataWeave supports two types of collections: Arrays and Objects. Arrays are a sequence of values,
while Objects are a sequence of key-value pairs.

### Deconstruction on Arrays

An Array can be seen as a head (the first element of the Array) and a tail (a new Array with the
reminder of the elements). For example, in the array `[1,2,3,4]`, `1` is the head and `2,3,4` is the
tail.

To match over an array, use the following syntax, where the script gets the first element of an
array or returns null if the array is empty:

DataWeave Script

```dataweave
[1,2,3,4] match {
	case [head ~ tail] -> head
	case [] -> null
}
```

This kind of deconstruction is useful when used with recursive functions.

#### Example: Build a `joinBy` Function

This example builds a `joinBy` function that takes an array of string and returns a string with all
the elements of the Array concatenated with the given separator:

DataWeave Script

```dataweave
fun joinBy(elements: Array<String>, separator: String): String =
	elements match {
		case [head ~ tail] -> head ++ separator ++ joinBy(tail, separator) //When head and tail append and recursively
		case [] -> "" //When the array is empty return empty array
	}
```

#### Example: Build a Filter Function

This example builds a higher-order filter function:

DataWeave Script

```dataweave
fun filter<T>(elements: Array<T>, predicate: (item:T) -> Boolean): Array<T> =
	elements match {
		case [head ~ tail] ->
			if(predicate(head))
				[head] ++ filter(tail, predicate)
			else
				filter(tail, predicate)
		case [] -> []
	}
```

### Deconstruction on Objects

Objects in DataWeave are similar to Arrays but each element consists of a key and a value. An Object
can also be seen as a head (the first key-value pair) and a tail (a new Object with the rest of the
key-value pairs).

To match over an object, use the following syntax, where the script gets the first value of an
object, which in this case is "Word":

DataWeave Script

```dataweave
{hello: "world", test: true} match {
    case {headKey: headValue ~ tail} -> headValue
    case {} -> null
}
```

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.4/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.4/dataweave-selectors)

- [DataWeave Quickstart](https://docs.mulesoft.com/dataweave/2.4/dataweave-quickstart)

<!-- document id=57129ed5909a2cc882d27aaf94bfdb74b4c35e221edc56cf83b1288d28f759d1 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-pattern-matching.md -->

---
product: DataWeave
version: 2.6
---

# Pattern Matching in DataWeave Through match Statements

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The `match` statement behaves like a `match` or `switch` statement in other languages, like Java or
C++, and routes an input expression to a particular output expression based on some conditions.

match Statement Syntax:

```dataweave
inputExpression match {
  case <condition> -> <routing expression>
  case <condition> -> <routing expression>
  else -> <default routing expression>
}
```

As in other languages, the DataWeave `match` statement provides a compact way to organize multiple,
chained `if-else` statements. A `match` expression consists of a list of `case` statements that
optionally end with an `else` statement. Each `case` statement consists of a conditional selector
expression that must evaluate to `true` or `false`. This conditional expression corresponds to the
condition expressed by an `if` statement, followed by a corresponding DataWeave routing expression
that can include the `match` statement’s input expression.

Each `case` statement can be an `if` statement, or the `case` statement can use other
pattern-matching shortcuts to define the `case` statement’s condition. If a `case` statement is
`false`, its routing expression is ignored.

DataWeave supports four different types of patterns for a `case` statement’s condition:

- [Expressions](#pattern_match_expressions)

- [Literal values](#pattern_match_literals)

- [Data types](#pattern_match_data_types)

- [Regular expressions](#pattern_match_regex)

Each case can be named or unnamed. If the case is named, the name stores the input expression as a
local variable that can be used both in that case statement’s conditional expression and in the
corresponding routing expression.

match Statement Structure

```dataweave
value match {
  case (<name>:) <condition> -> <routing expression>
  case (<name>:) <condition> -> <routing expression>
  else -> <when none of them matched>
}
```

As this example shows, the expression returns the results of the first matching `case` statement:

match Statement Example

```dataweave
%dw 2.0
output application/json
---
"hello world" match {
	case word matches /(hello)\s\w+/ ->  word[1] as String ++ " was matched"
	case literalMatch: "hello world" -> upper(literalMatch)
	case hasOne if( hasOne is Object and hasOne.three? ) -> hasOne.three
	else -> $
}
```

Output

```json
"hello was matched"
```

Notice that you can refer to the input expression ("hello world") through each `case` statement’s
local variable name (that is, `word` or `literalMatch`), while the `else` statement can refer to the
input expression using the default parameter name `$`, an unnamed parameter.

To name the input expression in the `else` statement, you can replace the `else` statement with a
`case` statement that is always `true`:

match Statement Example

```dataweave
%dw 2.0
output application/json
---
"hello world" match {
	case word matches  /(hello)\s\w+/ ->  word[1] ++ " was matched"
	case literalMatch: "hello world" -> upper(literalMatch)
	case last if(true) -> last
}
```

For use cases in which the input is of type String, you can also use the
[match](https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-match) _function_ in the `dw::Core` module to test the string against a
regex pattern. The function returns an array with the strings that match the entire regex and any
capture groups.

For use cases that require a Boolean result based on whether a string matches a regex pattern, you
can use the [matches](https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-matches) _function_ in the `dw::Core` module instead of
using pattern matching or the module’s `match` function.

## Pattern Matching to Literal Values

Matches when the evaluated value equals a simple literal value.

In this example, the first field matches the value in `myInput.string` and returns a boolean. The
second field performs the same match, but it returns an object that contains both a boolean and a
reference to the validated value.

DataWeave Script

```dataweave
%dw 2.0
var myInput = {
  "string": "Emiliano"
}
output application/json
---
{
  a: myInput.string match {
    case "Emiliano" -> true
    case "Mariano" -> false
  },
  b: myInput.string match {
    case str: "Emiliano" -> { "matches": true, value: str }
    case str: "Mariano" -> { "matches": false, value: str }
  }
}
```

Output

```json
{
  "a": true,
  "b": {
    "matches": true,
    "value": "Emiliano"
  }
}
```

## Pattern Matching on Expressions

Matches when a given expression returns `true`.

In this example, the first field matches the value of `myInput.string` against two alternatives and
conditionally appends a different string to it. The second field evaluates if the value in
`myInput.number` is greater than (`>`), less than (`<`), or equal to (`==`) 3 and returns the
corresponding string.

DataWeave Script

```dataweave
%dw 2.0
var myInput = {
  "string": "Emiliano",
  "number": 3.14
}
output application/json
---
{
  a: myInput.string match {
    case str if str == "Mariano" -> str ++ " de Achaval"
    case str if str == "Emiliano" -> str ++ " Lesende"
  },
  b: myInput.number match {
    case num if num == 3 -> "equal"
    case num if num > 3 -> "greater than"
    case num if num < 3 -> "less than"
  }
}
```

Output

```json
{
  "a": "Emiliano Lesende",
  "b": "greater than"
}
```

## Pattern Matching on the Data Type

Matches when the evaluated value is the specified data type.

In this example, the first field evaluates the data type of `myInput.a` and returns a string with
the corresponding type name. The second field is similar but also returns the value of the
`myInput.b`.

DataWeave Script

```dataweave
%dw 2.0
var myInput =
{
  "a": "Emiliano",
  "b": 3.14
}
output application/json
---
{
  a: myInput.a match {
    case is Object -> 'OBJECT'
    case is String -> 'STRING'
    case is Number -> 'NUMBER'
    case is Boolean -> 'BOOLEAN'
    case is Array -> 'ARRAY'
    case is Null -> 'NULL'
    else -> 'ANOTHER TYPE'
  },
  b: myInput.b match {
    case y is Object -> { 'Type': { 'OBJECT' : y} }
    case y is String -> { 'Type': { 'STRING' : y} }
    case y is Number -> { 'Type': { 'NUMBER' : y} }
    case y is Boolean -> { 'Type': { 'BOOLEAN' : y} }
    case y is Array -> { 'Type': { 'ARRAY' : y} }
    case y is Null -> { 'Type': { 'NULL' : y} }
    else -> { 'Type': { 'ANOTHER TYPE' : myInput.b} }
  }
}
```

Output

```json
{
  "a": "STRING",
  "b": {
    "Type": {
      "NUMBER": 3.14
    }
  }
}
```

## Pattern Matching on Regular Expressions

Matches when the evaluated value fits a given regular expression (regex), specifically a regex
"flavor" supported by Java. In this example, the input variable (`myInput`) includes an array of
strings. The script uses the `map` function to iterate through the array. It evaluates each element
against a Java regex and outputs an object based on matches to the input.

DataWeave Script

```dataweave
%dw 2.0
var myInput = {
  "phones": [
    "+1 (415) 229-2009",
    "(647) 456-7008"
  ]
}
output application/json
---
{
  a: myInput.phones map ($ match {
     case phone matches /\+(\d+)\s\((\d+)\)\s(\d+\-\d+)/ -> { country: phone[1]}
     case phone matches /\((\d+)\)\s(\d+\-\d+)/ -> { area: phone[1], number: phone[2] }
   }),
 b: myInput.phones map ($ match {
   case phone matches /\+(\d+)\s\((\d+)\)\s(\d+\-\d+)/ -> { country: phone[1], area: phone[2], number: phone[3] }
   case phone matches /\((\d+)\)\s(\d+\-\d+)/ -> { area: phone[1], number: phone[2] }
 })
}
```

Output

```json
{
  "a": [
    {
      "country": "1"
    },
    {
      "area": "647",
      "number": "456-7008"
    }
  ],
  "b": [
    {
      "country": "1",
      "area": "415",
      "number": "229-2009"
    },
    {
      "area": "647",
      "number": "456-7008"
    }
  ]
}
```

## Deconstructors on Collections in DataWeave

DataWeave supports two types of collections: Arrays and Objects. Arrays are a sequence of values,
while Objects are a sequence of key-value pairs.

### Deconstruction on Arrays

An Array can be seen as a head (the first element of the Array) and a tail (a new Array with the
reminder of the elements). For example, in the array `[1,2,3,4]`, `1` is the head and `2,3,4` is the
tail.

To match over an array, use the following syntax, where the script gets the first element of an
array or returns null if the array is empty:

DataWeave Script

```dataweave
[1,2,3,4] match {
	case [head ~ tail] -> head
	case [] -> null
}
```

This kind of deconstruction is useful when used with recursive functions.

#### Example: Build a `joinBy` Function

This example builds a `joinBy` function that takes an array of string and returns a string with all
the elements of the Array concatenated with the given separator:

DataWeave Script

```dataweave
fun joinBy(elements: Array<String>, separator: String): String =
	elements match {
		case [head ~ tail] -> head ++ separator ++ joinBy(tail, separator) //When head and tail append and recursively
		case [] -> "" //When the array is empty return empty array
	}
```

#### Example: Build a Filter Function

This example builds a higher-order filter function:

DataWeave Script

```dataweave
fun filter<T>(elements: Array<T>, predicate: (item:T) -> Boolean): Array<T> =
	elements match {
		case [head ~ tail] ->
			if(predicate(head))
				[head] ++ filter(tail, predicate)
			else
				filter(tail, predicate)
		case [] -> []
	}
```

### Deconstruction on Objects

Objects in DataWeave are similar to Arrays but each element consists of a key and a value. An Object
can also be seen as a head (the first key-value pair) and a tail (a new Object with the rest of the
key-value pairs).

To match over an object, use the following syntax, where the script gets the first value of an
object, which in this case is "Word":

DataWeave Script

```dataweave
{hello: "world", test: true} match {
    case {headKey: headValue ~ tail} -> headValue
    case {} -> null
}
```

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.6/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.6/dataweave-selectors)

- [DataWeave Quickstart](https://docs.mulesoft.com/dataweave/2.6/dataweave-quickstart)

<!-- document id=481695c887d13565109104ac529c36a369fa1450d50209f3ef0d0e4375d08e8a url=/mulesoft/current/en-us/dataweave/2.9/dataweave-pattern-matching.md -->

---
product: DataWeave
version: 2.9
---

# Pattern Matching in DataWeave Through match Statements

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The `match` statement behaves like a `match` or `switch` statement in other languages, like Java or
C++, and routes an input expression to a particular output expression based on some conditions.

match Statement Syntax:

```dataweave
inputExpression match {
  case <condition> -> <routing expression>
  case <condition> -> <routing expression>
  else -> <default routing expression>
}
```

As in other languages, the DataWeave `match` statement provides a compact way to organize multiple,
chained `if-else` statements. A `match` expression consists of a list of `case` statements that
optionally end with an `else` statement. Each `case` statement consists of a conditional selector
expression that must evaluate to `true` or `false`. This conditional expression corresponds to the
condition expressed by an `if` statement, followed by a corresponding DataWeave routing expression
that can include the `match` statement’s input expression.

Each `case` statement can be an `if` statement, or the `case` statement can use other
pattern-matching shortcuts to define the `case` statement’s condition. If a `case` statement is
`false`, its routing expression is ignored.

DataWeave supports four different types of patterns for a `case` statement’s condition:

- [Expressions](#pattern_match_expressions)

- [Literal values](#pattern_match_literals)

- [Data types](#pattern_match_data_types)

- [Regular expressions](#pattern_match_regex)

Each case can be named or unnamed. If the case is named, the name stores the input expression as a
local variable that can be used both in that case statement’s conditional expression and in the
corresponding routing expression.

match Statement Structure

```dataweave
value match {
  case (<name>:) <condition> -> <routing expression>
  case (<name>:) <condition> -> <routing expression>
  else -> <when none of them matched>
}
```

As this example shows, the expression returns the results of the first matching `case` statement:

match Statement Example

```dataweave
%dw 2.0
output application/json
---
"hello world" match {
	case word matches /(hello)\s\w+/ ->  word[1] as String ++ " was matched"
	case literalMatch: "hello world" -> upper(literalMatch)
	case hasOne if( hasOne is Object and hasOne.three? ) -> hasOne.three
	else -> $
}
```

Output

```json
"hello was matched"
```

Notice that you can refer to the input expression ("hello world") through each `case` statement’s
local variable name (that is, `word` or `literalMatch`), while the `else` statement can refer to the
input expression using the default parameter name `$`, an unnamed parameter.

To name the input expression in the `else` statement, you can replace the `else` statement with a
`case` statement that is always `true`:

match Statement Example

```dataweave
%dw 2.0
output application/json
---
"hello world" match {
	case word matches  /(hello)\s\w+/ ->  word[1] ++ " was matched"
	case literalMatch: "hello world" -> upper(literalMatch)
	case last if(true) -> last
}
```

For use cases in which the input is of type String, you can also use the
[match](https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-match) _function_ in the `dw::Core` module to test the string against a
regex pattern. The function returns an array with the strings that match the entire regex and any
capture groups.

For use cases that require a Boolean result based on whether a string matches a regex pattern, you
can use the [matches](https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-matches) _function_ in the `dw::Core` module instead of
using pattern matching or the module’s `match` function.

## Pattern Matching to Literal Values

Matches when the evaluated value equals a simple literal value.

In this example, the first field matches the value in `myInput.string` and returns a boolean. The
second field performs the same match, but it returns an object that contains both a boolean and a
reference to the validated value.

DataWeave Script

```dataweave
%dw 2.0
var myInput = {
  "string": "Emiliano"
}
output application/json
---
{
  a: myInput.string match {
    case "Emiliano" -> true
    case "Mariano" -> false
  },
  b: myInput.string match {
    case str: "Emiliano" -> { "matches": true, value: str }
    case str: "Mariano" -> { "matches": false, value: str }
  }
}
```

Output

```json
{
  "a": true,
  "b": {
    "matches": true,
    "value": "Emiliano"
  }
}
```

## Pattern Matching on Expressions

Matches when a given expression returns `true`.

In this example, the first field matches the value of `myInput.string` against two alternatives and
conditionally appends a different string to it. The second field evaluates if the value in
`myInput.number` is greater than (`>`), less than (`<`), or equal to (`==`) 3 and returns the
corresponding string.

DataWeave Script

```dataweave
%dw 2.0
var myInput = {
  "string": "Emiliano",
  "number": 3.14
}
output application/json
---
{
  a: myInput.string match {
    case str if str == "Mariano" -> str ++ " de Achaval"
    case str if str == "Emiliano" -> str ++ " Lesende"
  },
  b: myInput.number match {
    case num if num == 3 -> "equal"
    case num if num > 3 -> "greater than"
    case num if num < 3 -> "less than"
  }
}
```

Output

```json
{
  "a": "Emiliano Lesende",
  "b": "greater than"
}
```

## Pattern Matching on the Data Type

Matches when the evaluated value is the specified data type.

In this example, the first field evaluates the data type of `myInput.a` and returns a string with
the corresponding type name. The second field is similar but also returns the value of the
`myInput.b`.

DataWeave Script

```dataweave
%dw 2.0
var myInput =
{
  "a": "Emiliano",
  "b": 3.14
}
output application/json
---
{
  a: myInput.a match {
    case is Object -> 'OBJECT'
    case is String -> 'STRING'
    case is Number -> 'NUMBER'
    case is Boolean -> 'BOOLEAN'
    case is Array -> 'ARRAY'
    case is Null -> 'NULL'
    else -> 'ANOTHER TYPE'
  },
  b: myInput.b match {
    case y is Object -> { 'Type': { 'OBJECT' : y} }
    case y is String -> { 'Type': { 'STRING' : y} }
    case y is Number -> { 'Type': { 'NUMBER' : y} }
    case y is Boolean -> { 'Type': { 'BOOLEAN' : y} }
    case y is Array -> { 'Type': { 'ARRAY' : y} }
    case y is Null -> { 'Type': { 'NULL' : y} }
    else -> { 'Type': { 'ANOTHER TYPE' : myInput.b} }
  }
}
```

Output

```json
{
  "a": "STRING",
  "b": {
    "Type": {
      "NUMBER": 3.14
    }
  }
}
```

## Pattern Matching on Regular Expressions

Matches when the evaluated value fits a given regular expression (regex), specifically a regex
"flavor" supported by Java. In this example, the input variable (`myInput`) includes an array of
strings. The script uses the `map` function to iterate through the array. It evaluates each element
against a Java regex and outputs an object based on matches to the input.

DataWeave Script

```dataweave
%dw 2.0
var myInput = {
  "phones": [
    "+1 (415) 229-2009",
    "(647) 456-7008"
  ]
}
output application/json
---
{
  a: myInput.phones map ($ match {
     case phone matches /\+(\d+)\s\((\d+)\)\s(\d+\-\d+)/ -> { country: phone[1]}
     case phone matches /\((\d+)\)\s(\d+\-\d+)/ -> { area: phone[1], number: phone[2] }
   }),
 b: myInput.phones map ($ match {
   case phone matches /\+(\d+)\s\((\d+)\)\s(\d+\-\d+)/ -> { country: phone[1], area: phone[2], number: phone[3] }
   case phone matches /\((\d+)\)\s(\d+\-\d+)/ -> { area: phone[1], number: phone[2] }
 })
}
```

Output

```json
{
  "a": [
    {
      "country": "1"
    },
    {
      "area": "647",
      "number": "456-7008"
    }
  ],
  "b": [
    {
      "country": "1",
      "area": "415",
      "number": "229-2009"
    },
    {
      "area": "647",
      "number": "456-7008"
    }
  ]
}
```

## Deconstructors on Collections in DataWeave

DataWeave supports two types of collections: Arrays and Objects. Arrays are a sequence of values,
while Objects are a sequence of key-value pairs.

### Deconstruction on Arrays

An Array can be seen as a head (the first element of the Array) and a tail (a new Array with the
reminder of the elements). For example, in the array `[1,2,3,4]`, `1` is the head and `2,3,4` is the
tail.

To match over an array, use the following syntax, where the script gets the first element of an
array or returns null if the array is empty:

DataWeave Script

```dataweave
[1,2,3,4] match {
	case [head ~ tail] -> head
	case [] -> null
}
```

This kind of deconstruction is useful when used with recursive functions.

#### Example: Build a `joinBy` Function

This example builds a `joinBy` function that takes an array of string and returns a string with all
the elements of the Array concatenated with the given separator:

DataWeave Script

```dataweave
fun joinBy(elements: Array<String>, separator: String): String =
	elements match {
		case [head ~ tail] -> head ++ separator ++ joinBy(tail, separator) //When head and tail append and recursively
		case [] -> "" //When the array is empty return empty array
	}
```

#### Example: Build a Filter Function

This example builds a higher-order filter function:

DataWeave Script

```dataweave
fun filter<T>(elements: Array<T>, predicate: (item:T) -> Boolean): Array<T> =
	elements match {
		case [head ~ tail] ->
			if(predicate(head))
				[head] ++ filter(tail, predicate)
			else
				filter(tail, predicate)
		case [] -> []
	}
```

### Deconstruction on Objects

Objects in DataWeave are similar to Arrays but each element consists of a key and a value. An Object
can also be seen as a head (the first key-value pair) and a tail (a new Object with the rest of the
key-value pairs).

To match over an object, use the following syntax, where the script gets the first value of an
object, which in this case is "Word":

DataWeave Script

```dataweave
{hello: "world", test: true} match {
    case {headKey: headValue ~ tail} -> headValue
    case {} -> null
}
```

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.9/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.9/dataweave-selectors)

- [DataWeave Quickstart](https://docs.mulesoft.com/dataweave/2.9/dataweave-quickstart)

<!-- document id=9a954d550df9cc35cba5b1ba65173deacb9ec564b7a3f30dfe2d36e391d05074 url=/mulesoft/current/en-us/dataweave/latest/dataweave-pattern-matching.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Pattern Matching in DataWeave Through match Statements

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The `match` statement behaves like a `match` or `switch` statement in other languages, like Java or
C++, and routes an input expression to a particular output expression based on some conditions.

match Statement Syntax:

```dataweave
inputExpression match {
  case <condition> -> <routing expression>
  case <condition> -> <routing expression>
  else -> <default routing expression>
}
```

As in other languages, the DataWeave `match` statement provides a compact way to organize multiple,
chained `if-else` statements. A `match` expression consists of a list of `case` statements that
optionally end with an `else` statement. Each `case` statement consists of a conditional selector
expression that must evaluate to `true` or `false`. This conditional expression corresponds to the
condition expressed by an `if` statement, followed by a corresponding DataWeave routing expression
that can include the `match` statement’s input expression.

Each `case` statement can be an `if` statement, or the `case` statement can use other
pattern-matching shortcuts to define the `case` statement’s condition. If a `case` statement is
`false`, its routing expression is ignored.

DataWeave supports four different types of patterns for a `case` statement’s condition:

- [Expressions](#pattern_match_expressions)

- [Literal values](#pattern_match_literals)

- [Data types](#pattern_match_data_types)

- [Regular expressions](#pattern_match_regex)

Each case can be named or unnamed. If the case is named, the name stores the input expression as a
local variable that can be used both in that case statement’s conditional expression and in the
corresponding routing expression.

match Statement Structure

```dataweave
value match {
  case (<name>:) <condition> -> <routing expression>
  case (<name>:) <condition> -> <routing expression>
  else -> <when none of them matched>
}
```

As this example shows, the expression returns the results of the first matching `case` statement:

match Statement Example

```dataweave
%dw 2.0
output application/json
---
"hello world" match {
	case word matches /(hello)\s\w+/ ->  word[1] as String ++ " was matched"
	case literalMatch: "hello world" -> upper(literalMatch)
	case hasOne if( hasOne is Object and hasOne.three? ) -> hasOne.three
	else -> $
}
```

Output

```json
"hello was matched"
```

Notice that you can refer to the input expression ("hello world") through each `case` statement’s
local variable name (that is, `word` or `literalMatch`), while the `else` statement can refer to the
input expression using the default parameter name `$`, an unnamed parameter.

To name the input expression in the `else` statement, you can replace the `else` statement with a
`case` statement that is always `true`:

match Statement Example

```dataweave
%dw 2.0
output application/json
---
"hello world" match {
	case word matches  /(hello)\s\w+/ ->  word[1] ++ " was matched"
	case literalMatch: "hello world" -> upper(literalMatch)
	case last if(true) -> last
}
```

For use cases in which the input is of type String, you can also use the
[match](https://docs.mulesoft.com/dataweave/latest/dw-core-functions-match) _function_ in the `dw::Core` module to test the string against a
regex pattern. The function returns an array with the strings that match the entire regex and any
capture groups.

For use cases that require a Boolean result based on whether a string matches a regex pattern, you
can use the [matches](https://docs.mulesoft.com/dataweave/latest/dw-core-functions-matches) _function_ in the `dw::Core` module instead of
using pattern matching or the module’s `match` function.

## Pattern Matching to Literal Values

Matches when the evaluated value equals a simple literal value.

In this example, the first field matches the value in `myInput.string` and returns a boolean. The
second field performs the same match, but it returns an object that contains both a boolean and a
reference to the validated value.

DataWeave Script

```dataweave
%dw 2.0
var myInput = {
  "string": "Emiliano"
}
output application/json
---
{
  a: myInput.string match {
    case "Emiliano" -> true
    case "Mariano" -> false
  },
  b: myInput.string match {
    case str: "Emiliano" -> { "matches": true, value: str }
    case str: "Mariano" -> { "matches": false, value: str }
  }
}
```

Output

```json
{
  "a": true,
  "b": {
    "matches": true,
    "value": "Emiliano"
  }
}
```

## Pattern Matching on Expressions

Matches when a given expression returns `true`.

In this example, the first field matches the value of `myInput.string` against two alternatives and
conditionally appends a different string to it. The second field evaluates if the value in
`myInput.number` is greater than (`>`), less than (`<`), or equal to (`==`) 3 and returns the
corresponding string.

DataWeave Script

```dataweave
%dw 2.0
var myInput = {
  "string": "Emiliano",
  "number": 3.14
}
output application/json
---
{
  a: myInput.string match {
    case str if str == "Mariano" -> str ++ " de Achaval"
    case str if str == "Emiliano" -> str ++ " Lesende"
  },
  b: myInput.number match {
    case num if num == 3 -> "equal"
    case num if num > 3 -> "greater than"
    case num if num < 3 -> "less than"
  }
}
```

Output

```json
{
  "a": "Emiliano Lesende",
  "b": "greater than"
}
```

## Pattern Matching on the Data Type

Matches when the evaluated value is the specified data type.

In this example, the first field evaluates the data type of `myInput.a` and returns a string with
the corresponding type name. The second field is similar but also returns the value of the
`myInput.b`.

DataWeave Script

```dataweave
%dw 2.0
var myInput =
{
  "a": "Emiliano",
  "b": 3.14
}
output application/json
---
{
  a: myInput.a match {
    case is Object -> 'OBJECT'
    case is String -> 'STRING'
    case is Number -> 'NUMBER'
    case is Boolean -> 'BOOLEAN'
    case is Array -> 'ARRAY'
    case is Null -> 'NULL'
    else -> 'ANOTHER TYPE'
  },
  b: myInput.b match {
    case y is Object -> { 'Type': { 'OBJECT' : y} }
    case y is String -> { 'Type': { 'STRING' : y} }
    case y is Number -> { 'Type': { 'NUMBER' : y} }
    case y is Boolean -> { 'Type': { 'BOOLEAN' : y} }
    case y is Array -> { 'Type': { 'ARRAY' : y} }
    case y is Null -> { 'Type': { 'NULL' : y} }
    else -> { 'Type': { 'ANOTHER TYPE' : myInput.b} }
  }
}
```

Output

```json
{
  "a": "STRING",
  "b": {
    "Type": {
      "NUMBER": 3.14
    }
  }
}
```

## Pattern Matching on Regular Expressions

Matches when the evaluated value fits a given regular expression (regex), specifically a regex
"flavor" supported by Java. In this example, the input variable (`myInput`) includes an array of
strings. The script uses the `map` function to iterate through the array. It evaluates each element
against a Java regex and outputs an object based on matches to the input.

DataWeave Script

```dataweave
%dw 2.0
var myInput = {
  "phones": [
    "+1 (415) 229-2009",
    "(647) 456-7008"
  ]
}
output application/json
---
{
  a: myInput.phones map ($ match {
     case phone matches /\+(\d+)\s\((\d+)\)\s(\d+\-\d+)/ -> { country: phone[1]}
     case phone matches /\((\d+)\)\s(\d+\-\d+)/ -> { area: phone[1], number: phone[2] }
   }),
 b: myInput.phones map ($ match {
   case phone matches /\+(\d+)\s\((\d+)\)\s(\d+\-\d+)/ -> { country: phone[1], area: phone[2], number: phone[3] }
   case phone matches /\((\d+)\)\s(\d+\-\d+)/ -> { area: phone[1], number: phone[2] }
 })
}
```

Output

```json
{
  "a": [
    {
      "country": "1"
    },
    {
      "area": "647",
      "number": "456-7008"
    }
  ],
  "b": [
    {
      "country": "1",
      "area": "415",
      "number": "229-2009"
    },
    {
      "area": "647",
      "number": "456-7008"
    }
  ]
}
```

## Deconstructors on Collections in DataWeave

DataWeave supports two types of collections: Arrays and Objects. Arrays are a sequence of values,
while Objects are a sequence of key-value pairs.

### Deconstruction on Arrays

An Array can be seen as a head (the first element of the Array) and a tail (a new Array with the
reminder of the elements). For example, in the array `[1,2,3,4]`, `1` is the head and `2,3,4` is the
tail.

To match over an array, use the following syntax, where the script gets the first element of an
array or returns null if the array is empty:

DataWeave Script

```dataweave
[1,2,3,4] match {
	case [head ~ tail] -> head
	case [] -> null
}
```

This kind of deconstruction is useful when used with recursive functions.

#### Example: Build a `joinBy` Function

This example builds a `joinBy` function that takes an array of string and returns a string with all
the elements of the Array concatenated with the given separator:

DataWeave Script

```dataweave
fun joinBy(elements: Array<String>, separator: String): String =
	elements match {
		case [head ~ tail] -> head ++ separator ++ joinBy(tail, separator) //When head and tail append and recursively
		case [] -> "" //When the array is empty return empty array
	}
```

#### Example: Build a Filter Function

This example builds a higher-order filter function:

DataWeave Script

```dataweave
fun filter<T>(elements: Array<T>, predicate: (item:T) -> Boolean): Array<T> =
	elements match {
		case [head ~ tail] ->
			if(predicate(head))
				[head] ++ filter(tail, predicate)
			else
				filter(tail, predicate)
		case [] -> []
	}
```

### Deconstruction on Objects

Objects in DataWeave are similar to Arrays but each element consists of a key and a value. An Object
can also be seen as a head (the first key-value pair) and a tail (a new Object with the rest of the
key-value pairs).

To match over an object, use the following syntax, where the script gets the first value of an
object, which in this case is "Word":

DataWeave Script

```dataweave
{hello: "world", test: true} match {
    case {headKey: headValue ~ tail} -> headValue
    case {} -> null
}
```

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/latest/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors)

- [DataWeave Quickstart](https://docs.mulesoft.com/dataweave/latest/dataweave-quickstart)

<!-- document id=9d417889f7049ba70f3cb6f0ae6b6ee36bf7c945432185e400c182120d862327 url=/mulesoft/current/en-us/dataweave/2.11/dw-periods-functions-period.md -->

---
product: DataWeave
version: 2.11
---

# period

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## period(period: { years?: Number, months?: Number, days?: Number }): Period

Creates a Period value as a date-based number of years, months, and days in the ISO-8601 calendar
system.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>period</code></p></td><td><p>An object such as <code>{years:4, months:11, days:28}</code>. The key-value pairs are optional and can be specified in any order. An empty object (<code>{}</code>) returns the Period value <code>"P0D"</code> (zero days). The default value of each key is <code>0</code>. Valid values are whole numbers, which can be positive or negative. Decimal values produce an error message. Key names are selectable.</p></td></tr></tbody></table>

### Example

This example shows how `period` behaves with different inputs. The example add a subtracts and adds
the result of a `period` function to DateTime and Date values. It also constructs a Period value
from `period` objects and selects a `months` value from the object.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::core::Periods
---
{
   dayBeforeDateTime: |2020-10-05T20:22:34.385Z| - period({days:1}),
   dayAfterDate: |2020-10-05| + period({days:1}),
   yearMonthDayAfterDate: |2020-10-05| + period({years:1, months:1, days:1}),
   emptyPeriod: period({}),
   constructPeriod: period({years:4, months:11, days:28}),
   selectMonthsFromPeriod: period({years:4, months:11, days:28}).months
}
```

#### Output

```Json
{
    "dayBeforeDateTime": "2020-10-04T20:22:34.385Z",
    "dayAfterDate": "2020-10-06",
    "yearMonthDayAfterDate": "2021-11-06",
    "emptyPeriod": "P0D",
    "constructPeriod": "P4Y11M28D",
    "selectMonthsFromPeriod": 11
}
```

<!-- document id=e26a44f4db7b1fe1dd6ea57c1d9050461e56e5d89178f233db6f8c5a1987b60e url=/mulesoft/current/en-us/dataweave/2.12/dw-periods-functions-period.md -->

---
product: DataWeave
version: 2.12
---

# period

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## period(period: { years?: Number, months?: Number, days?: Number }): Period

Creates a Period value as a date-based number of years, months, and days in the ISO-8601 calendar
system.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>period</code></p></td><td><p>An object such as <code>{years:4, months:11, days:28}</code>. The key-value pairs are optional and can be specified in any order. An empty object (<code>{}</code>) returns the Period value <code>"P0D"</code> (zero days). The default value of each key is <code>0</code>. Valid values are whole numbers, which can be positive or negative. Decimal values produce an error message. Key names are selectable.</p></td></tr></tbody></table>

### Example

This example shows how `period` behaves with different inputs. The example add a subtracts and adds
the result of a `period` function to DateTime and Date values. It also constructs a Period value
from `period` objects and selects a `months` value from the object.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::core::Periods
---
{
   dayBeforeDateTime: |2020-10-05T20:22:34.385Z| - period({days:1}),
   dayAfterDate: |2020-10-05| + period({days:1}),
   yearMonthDayAfterDate: |2020-10-05| + period({years:1, months:1, days:1}),
   emptyPeriod: period({}),
   constructPeriod: period({years:4, months:11, days:28}),
   selectMonthsFromPeriod: period({years:4, months:11, days:28}).months
}
```

#### Output

```Json
{
    "dayBeforeDateTime": "2020-10-04T20:22:34.385Z",
    "dayAfterDate": "2020-10-06",
    "yearMonthDayAfterDate": "2021-11-06",
    "emptyPeriod": "P0D",
    "constructPeriod": "P4Y11M28D",
    "selectMonthsFromPeriod": 11
}
```

<!-- document id=cb230597088575af90842571287590da8db90702ce8bf16e78ce599e965e98f0 url=/mulesoft/current/en-us/dataweave/2.4/dw-periods-functions-period.md -->

---
product: DataWeave
version: 2.4
---

# period

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## period(period: { years?: Number, months?: Number, days?: Number }): Period

Creates a Period value as a date-based number of years, months, and days in the ISO-8601 calendar
system.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>period</code></p></td><td><p>An object such as <code>{years:4, months:11, days:28}</code>. The key-value pairs are optional and can be specified in any order. An empty object (<code>{}</code>) returns the Period value <code>"P0D"</code> (zero days). The default value of each key is <code>0</code>. Valid values are whole numbers, which can be positive or negative. Decimal values produce an error message. Key names are selectable.</p></td></tr></tbody></table>

### Example

This example shows how `period` behaves with different inputs. The example add a subtracts and adds
the result of a `period` function to DateTime and Date values. It also constructs a Period value
from `period` objects and selects a `months` value from the object.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::core::Periods
---
{
   dayBeforeDateTime: |2020-10-05T20:22:34.385Z| - period({days:1}),
   dayAfterDate: |2020-10-05| + period({days:1}),
   yearMonthDayAfterDate: |2020-10-05| + period({years:1, months:1, days:1}),
   emptyPeriod: period({}),
   constructPeriod: period({years:4, months:11, days:28}),
   selectMonthsFromPeriod: period({years:4, months:11, days:28}).months
}
```

#### Output

```Json
{
    "dayBeforeDateTime": "2020-10-04T20:22:34.385Z",
    "dayAfterDate": "2020-10-06",
    "yearMonthDayAfterDate": "2021-11-06",
    "emptyPeriod": "P0D",
    "constructPeriod": "P4Y11M28D",
    "selectMonthsFromPeriod": 11
}
```

<!-- document id=f23bf74a7a84d220ebc47d51a4d71f8164dcbafa001bcbc262f5cbc1143155f4 url=/mulesoft/current/en-us/dataweave/2.6/dw-periods-functions-period.md -->

---
product: DataWeave
version: 2.6
---

# period

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## period(period: { years?: Number, months?: Number, days?: Number }): Period

Creates a Period value as a date-based number of years, months, and days in the ISO-8601 calendar
system.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>period</code></p></td><td><p>An object such as <code>{years:4, months:11, days:28}</code>. The key-value pairs are optional and can be specified in any order. An empty object (<code>{}</code>) returns the Period value <code>"P0D"</code> (zero days). The default value of each key is <code>0</code>. Valid values are whole numbers, which can be positive or negative. Decimal values produce an error message. Key names are selectable.</p></td></tr></tbody></table>

### Example

This example shows how `period` behaves with different inputs. The example add a subtracts and adds
the result of a `period` function to DateTime and Date values. It also constructs a Period value
from `period` objects and selects a `months` value from the object.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::core::Periods
---
{
   dayBeforeDateTime: |2020-10-05T20:22:34.385Z| - period({days:1}),
   dayAfterDate: |2020-10-05| + period({days:1}),
   yearMonthDayAfterDate: |2020-10-05| + period({years:1, months:1, days:1}),
   emptyPeriod: period({}),
   constructPeriod: period({years:4, months:11, days:28}),
   selectMonthsFromPeriod: period({years:4, months:11, days:28}).months
}
```

#### Output

```Json
{
    "dayBeforeDateTime": "2020-10-04T20:22:34.385Z",
    "dayAfterDate": "2020-10-06",
    "yearMonthDayAfterDate": "2021-11-06",
    "emptyPeriod": "P0D",
    "constructPeriod": "P4Y11M28D",
    "selectMonthsFromPeriod": 11
}
```

<!-- document id=b11b4a46ca40f2fa6d45458d553d853f4c2f5a83047ff4613aacf33d74108071 url=/mulesoft/current/en-us/dataweave/2.9/dw-periods-functions-period.md -->

---
product: DataWeave
version: 2.9
---

# period

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## period(period: { years?: Number, months?: Number, days?: Number }): Period

Creates a Period value as a date-based number of years, months, and days in the ISO-8601 calendar
system.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>period</code></p></td><td><p>An object such as <code>{years:4, months:11, days:28}</code>. The key-value pairs are optional and can be specified in any order. An empty object (<code>{}</code>) returns the Period value <code>"P0D"</code> (zero days). The default value of each key is <code>0</code>. Valid values are whole numbers, which can be positive or negative. Decimal values produce an error message. Key names are selectable.</p></td></tr></tbody></table>

### Example

This example shows how `period` behaves with different inputs. The example add a subtracts and adds
the result of a `period` function to DateTime and Date values. It also constructs a Period value
from `period` objects and selects a `months` value from the object.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::core::Periods
---
{
   dayBeforeDateTime: |2020-10-05T20:22:34.385Z| - period({days:1}),
   dayAfterDate: |2020-10-05| + period({days:1}),
   yearMonthDayAfterDate: |2020-10-05| + period({years:1, months:1, days:1}),
   emptyPeriod: period({}),
   constructPeriod: period({years:4, months:11, days:28}),
   selectMonthsFromPeriod: period({years:4, months:11, days:28}).months
}
```

#### Output

```Json
{
    "dayBeforeDateTime": "2020-10-04T20:22:34.385Z",
    "dayAfterDate": "2020-10-06",
    "yearMonthDayAfterDate": "2021-11-06",
    "emptyPeriod": "P0D",
    "constructPeriod": "P4Y11M28D",
    "selectMonthsFromPeriod": 11
}
```

<!-- document id=bd67d95a17df098a3d6357e1d5a210d90608a1fa5c34db9b18631f28c9c2cf55 url=/mulesoft/current/en-us/dataweave/latest/dw-periods-functions-period.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# period

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## period(period: { years?: Number, months?: Number, days?: Number }): Period

Creates a Period value as a date-based number of years, months, and days in the ISO-8601 calendar
system.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>period</code></p></td><td><p>An object such as <code>{years:4, months:11, days:28}</code>. The key-value pairs are optional and can be specified in any order. An empty object (<code>{}</code>) returns the Period value <code>"P0D"</code> (zero days). The default value of each key is <code>0</code>. Valid values are whole numbers, which can be positive or negative. Decimal values produce an error message. Key names are selectable.</p></td></tr></tbody></table>

### Example

This example shows how `period` behaves with different inputs. The example add a subtracts and adds
the result of a `period` function to DateTime and Date values. It also constructs a Period value
from `period` objects and selects a `months` value from the object.

#### Source

```DataWeave
%dw 2.0
output application/json
import * from dw::core::Periods
---
{
   dayBeforeDateTime: |2020-10-05T20:22:34.385Z| - period({days:1}),
   dayAfterDate: |2020-10-05| + period({days:1}),
   yearMonthDayAfterDate: |2020-10-05| + period({years:1, months:1, days:1}),
   emptyPeriod: period({}),
   constructPeriod: period({years:4, months:11, days:28}),
   selectMonthsFromPeriod: period({years:4, months:11, days:28}).months
}
```

#### Output

```Json
{
    "dayBeforeDateTime": "2020-10-04T20:22:34.385Z",
    "dayAfterDate": "2020-10-06",
    "yearMonthDayAfterDate": "2021-11-06",
    "emptyPeriod": "P0D",
    "constructPeriod": "P4Y11M28D",
    "selectMonthsFromPeriod": 11
}
```

<!-- document id=3627631bf6e506307bdac922416c2bf0dc5618f1124335441b2290c7e6fbe20e url=/mulesoft/current/en-us/dataweave/2.11/dw-periods.md -->

---
product: DataWeave
version: 2.11
---

# Periods (dw::core::Periods)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains functions for working with and creating Period values.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Periods` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-periods-functions-between">between</a></p></td><td><p>Returns a Period (P) value consisting of the number of years, months, and days between two Date values.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-periods-functions-days">days</a></p></td><td><p>Creates a Period value from the provided number of days.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-periods-functions-duration">duration</a></p></td><td><p>Creates a Period value that represents a number of days, hours, minutes, or seconds.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-periods-functions-hours">hours</a></p></td><td><p>Creates a Period value from the provided number of hours.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-periods-functions-minutes">minutes</a></p></td><td><p>Creates a Period value from the provided number of minutes.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-periods-functions-months">months</a></p></td><td><p>Creates a Period value from the provided number of months.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-periods-functions-period">period</a></p></td><td><p>Creates a Period value as a date-based number of years, months, and days in the ISO-8601 calendar system.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-periods-functions-seconds">seconds</a></p></td><td><p>Creates a Period value from the provided number of seconds.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-periods-functions-years">years</a></p></td><td><p>Creates a Period value from the provided number of years.</p></td></tr></tbody></table>

<!-- document id=27b723ff8e5423749c95a63159288747d2996c4f5f90ed7b945125de954a34b8 url=/mulesoft/current/en-us/dataweave/2.12/dw-periods.md -->

---
product: DataWeave
version: 2.12
---

# Periods (dw::core::Periods)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains functions for working with and creating Period values.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Periods` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-periods-functions-between">between</a></p></td><td><p>Returns a Period (P) value consisting of the number of years, months, and days between two Date values.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-periods-functions-days">days</a></p></td><td><p>Creates a Period value from the provided number of days.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-periods-functions-duration">duration</a></p></td><td><p>Creates a Period value that represents a number of days, hours, minutes, or seconds.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-periods-functions-hours">hours</a></p></td><td><p>Creates a Period value from the provided number of hours.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-periods-functions-minutes">minutes</a></p></td><td><p>Creates a Period value from the provided number of minutes.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-periods-functions-months">months</a></p></td><td><p>Creates a Period value from the provided number of months.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-periods-functions-period">period</a></p></td><td><p>Creates a Period value as a date-based number of years, months, and days in the ISO-8601 calendar system.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-periods-functions-seconds">seconds</a></p></td><td><p>Creates a Period value from the provided number of seconds.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-periods-functions-years">years</a></p></td><td><p>Creates a Period value from the provided number of years.</p></td></tr></tbody></table>

<!-- document id=b8a5f0b661d1fd5e4b42998370417414b3ddd2d463ecb11182d05289e0f39206 url=/mulesoft/current/en-us/dataweave/2.4/dw-periods.md -->

---
product: DataWeave
version: 2.4
---

# Periods (dw::core::Periods)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains functions for working with and creating Period values.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Periods` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-periods-functions-between">between</a></p></td><td><p>Returns a Period (P) value consisting of the number of years, months, and days between two Date values.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-periods-functions-days">days</a></p></td><td><p>Creates a Period value from the provided number of days.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-periods-functions-duration">duration</a></p></td><td><p>Creates a Period value that represents a number of days, hours, minutes, or seconds.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-periods-functions-hours">hours</a></p></td><td><p>Creates a Period value from the provided number of hours.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-periods-functions-minutes">minutes</a></p></td><td><p>Creates a Period value from the provided number of minutes.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-periods-functions-months">months</a></p></td><td><p>Creates a Period value from the provided number of months.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-periods-functions-period">period</a></p></td><td><p>Creates a Period value as a date-based number of years, months, and days in the ISO-8601 calendar system.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-periods-functions-seconds">seconds</a></p></td><td><p>Creates a Period value from the provided number of seconds.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-periods-functions-years">years</a></p></td><td><p>Creates a Period value from the provided number of years.</p></td></tr></tbody></table>

<!-- document id=4a8379e5ac3ddfea17e2d741a64d8223c2c1795b8ff15b89b0c9306d478a484a url=/mulesoft/current/en-us/dataweave/2.6/dw-periods.md -->

---
product: DataWeave
version: 2.6
---

# Periods (dw::core::Periods)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains functions for working with and creating Period values.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Periods` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-periods-functions-between">between</a></p></td><td><p>Returns a Period (P) value consisting of the number of years, months, and days between two Date values.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-periods-functions-days">days</a></p></td><td><p>Creates a Period value from the provided number of days.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-periods-functions-duration">duration</a></p></td><td><p>Creates a Period value that represents a number of days, hours, minutes, or seconds.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-periods-functions-hours">hours</a></p></td><td><p>Creates a Period value from the provided number of hours.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-periods-functions-minutes">minutes</a></p></td><td><p>Creates a Period value from the provided number of minutes.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-periods-functions-months">months</a></p></td><td><p>Creates a Period value from the provided number of months.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-periods-functions-period">period</a></p></td><td><p>Creates a Period value as a date-based number of years, months, and days in the ISO-8601 calendar system.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-periods-functions-seconds">seconds</a></p></td><td><p>Creates a Period value from the provided number of seconds.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-periods-functions-years">years</a></p></td><td><p>Creates a Period value from the provided number of years.</p></td></tr></tbody></table>

<!-- document id=02d83249a8b29ac0dbb446e0a17338f1ffaef8fa55b9ab2f28615981abb6e9df url=/mulesoft/current/en-us/dataweave/2.9/dw-periods.md -->

---
product: DataWeave
version: 2.9
---

# Periods (dw::core::Periods)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains functions for working with and creating Period values.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Periods` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-periods-functions-between">between</a></p></td><td><p>Returns a Period (P) value consisting of the number of years, months, and days between two Date values.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-periods-functions-days">days</a></p></td><td><p>Creates a Period value from the provided number of days.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-periods-functions-duration">duration</a></p></td><td><p>Creates a Period value that represents a number of days, hours, minutes, or seconds.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-periods-functions-hours">hours</a></p></td><td><p>Creates a Period value from the provided number of hours.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-periods-functions-minutes">minutes</a></p></td><td><p>Creates a Period value from the provided number of minutes.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-periods-functions-months">months</a></p></td><td><p>Creates a Period value from the provided number of months.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-periods-functions-period">period</a></p></td><td><p>Creates a Period value as a date-based number of years, months, and days in the ISO-8601 calendar system.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-periods-functions-seconds">seconds</a></p></td><td><p>Creates a Period value from the provided number of seconds.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-periods-functions-years">years</a></p></td><td><p>Creates a Period value from the provided number of years.</p></td></tr></tbody></table>

<!-- document id=67ff91a1ca9030ba3226eadafa863d81d9f41406a53c68b564db0114d76eb2f2 url=/mulesoft/current/en-us/dataweave/latest/dw-periods.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Periods (dw::core::Periods)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains functions for working with and creating Period values.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Periods` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-periods-functions-between">between</a></p></td><td><p>Returns a Period (P) value consisting of the number of years, months, and days between two Date values.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-periods-functions-days">days</a></p></td><td><p>Creates a Period value from the provided number of days.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-periods-functions-duration">duration</a></p></td><td><p>Creates a Period value that represents a number of days, hours, minutes, or seconds.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-periods-functions-hours">hours</a></p></td><td><p>Creates a Period value from the provided number of hours.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-periods-functions-minutes">minutes</a></p></td><td><p>Creates a Period value from the provided number of minutes.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-periods-functions-months">months</a></p></td><td><p>Creates a Period value from the provided number of months.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-periods-functions-period">period</a></p></td><td><p>Creates a Period value as a date-based number of years, months, and days in the ISO-8601 calendar system.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-periods-functions-seconds">seconds</a></p></td><td><p>Creates a Period value from the provided number of seconds.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-periods-functions-years">years</a></p></td><td><p>Creates a Period value from the provided number of years.</p></td></tr></tbody></table>

<!-- document id=c8d55d807db62b5b0ef5f6497c518dc54ed28227525ea1b0e39db9bc21c29b2c url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook-pick-top-elements.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, transform, transformer, format, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Pick Top Elements

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example sorts an array of candidates by the score they got in a test, then picks only
the ones with the best score, as many as there are open positions to fill.

This example uses the following:

- `map` to go through each of the candidates in the input.

- `orderBy` to order the list of candidates according to their score.

- `[n to n]` to select only a section of the full array of candidates. As the array in ordered in
  ascending order, the top candidates are at the end of the array, so you must use negative indexes.
  With the provided input, it selects from -3 to -1, -1 being the last index in the array.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
    TopCandidateList: (payload.candidates map ((candidate) -> {
        firstName: candidate.name,
        rank: candidate.score
    }) orderBy $.rank) [ -payload.availablePositions to -1]
}
```

Input JSON Payload:

```json
{
  "availablePositions": 3,
  "candidates": [
    {
      "name": "Gunther Govan",
      "score": 99
    },
    {
      "name": "Michael Patrick",
      "score": 35
    },
    {
      "name": "Amalia Silva",
      "score": 96
    },
    {
      "name": "Tom Mathews",
      "score": 40
    },
    {
      "name": "Simon Wilson",
      "score": 84
    },
    {
      "name": "Janet Nguyen",
      "score": 52
    }
  ]
}
```

Output JSON:

```json
{
  "TopCandidateList": [
    {
      "firstName": "Simon Wilson",
      "rank": 84
    },
    {
      "firstName": "Amalia Silva",
      "rank": 96
    },
    {
      "firstName": "Gunther Govan",
      "rank": 99
    }
  ]
}
```

## Related Examples

- [Output Self-closing XML tags](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-output-self-closing-xml-tags)

- [Remove Specified XML Attributes](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-remove-certain-xml-attributes)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.11/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook)

<!-- document id=a4f1b77798025b56ae0e2bfd17ed80602dad171eb6d8a055d04ff2dce54bd176 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook-pick-top-elements.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, transform, transformer, format, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Pick Top Elements

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example sorts an array of candidates by the score they got in a test, then picks only
the ones with the best score, as many as there are open positions to fill.

This example uses the following:

- `map` to go through each of the candidates in the input.

- `orderBy` to order the list of candidates according to their score.

- `[n to n]` to select only a section of the full array of candidates. As the array in ordered in
  ascending order, the top candidates are at the end of the array, so you must use negative indexes.
  With the provided input, it selects from -3 to -1, -1 being the last index in the array.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
    TopCandidateList: (payload.candidates map ((candidate) -> {
        firstName: candidate.name,
        rank: candidate.score
    }) orderBy $.rank) [ -payload.availablePositions to -1]
}
```

Input JSON Payload:

```json
{
  "availablePositions": 3,
  "candidates": [
    {
      "name": "Gunther Govan",
      "score": 99
    },
    {
      "name": "Michael Patrick",
      "score": 35
    },
    {
      "name": "Amalia Silva",
      "score": 96
    },
    {
      "name": "Tom Mathews",
      "score": 40
    },
    {
      "name": "Simon Wilson",
      "score": 84
    },
    {
      "name": "Janet Nguyen",
      "score": 52
    }
  ]
}
```

Output JSON:

```json
{
  "TopCandidateList": [
    {
      "firstName": "Simon Wilson",
      "rank": 84
    },
    {
      "firstName": "Amalia Silva",
      "rank": 96
    },
    {
      "firstName": "Gunther Govan",
      "rank": 99
    }
  ]
}
```

## Related Examples

- [Output Self-closing XML tags](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-output-self-closing-xml-tags)

- [Remove Specified XML Attributes](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-remove-certain-xml-attributes)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.12/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook)

<!-- document id=82d3b3d72547f682e6862422a9db45de40434950323e1dfb114006e17991e419 url=/mulesoft/current/en-us/dataweave/2.3/dataweave-cookbook-pick-top-elements.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, transform, transformer, format, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Pick Top Elements

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example sorts an array of candidates by the score they got in a test, then picks only
the ones with the best score, as many as there are open positions to fill.

This example uses the following:

- `map` to go through each of the candidates in the input.

- `orderBy` to order the list of candidates according to their score.

- `[n to n]` to select only a section of the full array of candidates. As the array in ordered in
  ascending order, the top candidates are at the end of the array, so you must use negative indexes.
  With the provided input, it selects from -3 to -1, -1 being the last index in the array.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
    TopCandidateList: (payload.candidates map ((candidate) -> {
        firstName: candidate.name,
        rank: candidate.score
    }) orderBy $.rank) [ -payload.availablePositions to -1]
}
```

Input JSON Payload:

```json
{
  "availablePositions": 3,
  "candidates": [
    {
      "name": "Gunther Govan",
      "score": 99
    },
    {
      "name": "Michael Patrick",
      "score": 35
    },
    {
      "name": "Amalia Silva",
      "score": 96
    },
    {
      "name": "Tom Mathews",
      "score": 40
    },
    {
      "name": "Simon Wilson",
      "score": 84
    },
    {
      "name": "Janet Nguyen",
      "score": 52
    }
  ]
}
```

Output JSON:

```json
{
  "TopCandidateList": [
    {
      "firstName": "Simon Wilson",
      "rank": 84
    },
    {
      "firstName": "Amalia Silva",
      "rank": 96
    },
    {
      "firstName": "Gunther Govan",
      "rank": 99
    }
  ]
}
```

## Related Examples

- [Output Self-closing XML tags](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-output-self-closing-xml-tags)

- [Remove Specified XML Attributes](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-remove-certain-xml-attributes)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.3/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook)

<!-- document id=96ac6eaa9c0378c9016d3f2dba8cb0592e5737ad80ab28caee562537fcb8c4de url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook-pick-top-elements.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, transform, transformer, format, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Pick Top Elements

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example sorts an array of candidates by the score they got in a test, then picks only
the ones with the best score, as many as there are open positions to fill.

This example uses the following:

- `map` to go through each of the candidates in the input.

- `orderBy` to order the list of candidates according to their score.

- `[n to n]` to select only a section of the full array of candidates. As the array in ordered in
  ascending order, the top candidates are at the end of the array, so you must use negative indexes.
  With the provided input, it selects from -3 to -1, -1 being the last index in the array.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
    TopCandidateList: (payload.candidates map ((candidate) -> {
        firstName: candidate.name,
        rank: candidate.score
    }) orderBy $.rank) [ -payload.availablePositions to -1]
}
```

Input JSON Payload:

```json
{
  "availablePositions": 3,
  "candidates": [
    {
      "name": "Gunther Govan",
      "score": 99
    },
    {
      "name": "Michael Patrick",
      "score": 35
    },
    {
      "name": "Amalia Silva",
      "score": 96
    },
    {
      "name": "Tom Mathews",
      "score": 40
    },
    {
      "name": "Simon Wilson",
      "score": 84
    },
    {
      "name": "Janet Nguyen",
      "score": 52
    }
  ]
}
```

Output JSON:

```json
{
  "TopCandidateList": [
    {
      "firstName": "Simon Wilson",
      "rank": 84
    },
    {
      "firstName": "Amalia Silva",
      "rank": 96
    },
    {
      "firstName": "Gunther Govan",
      "rank": 99
    }
  ]
}
```

## Related Examples

- [Output Self-closing XML tags](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-output-self-closing-xml-tags)

- [Remove Specified XML Attributes](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-remove-certain-xml-attributes)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.4/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook)

<!-- document id=5ef6c9b679d3b05f4f1e338ee84ed02b461d6858d1cccbbd53d98abfdec626ba url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook-pick-top-elements.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, transform, transformer, format, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Pick Top Elements

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example sorts an array of candidates by the score they got in a test, then picks only
the ones with the best score, as many as there are open positions to fill.

This example uses the following:

- `map` to go through each of the candidates in the input.

- `orderBy` to order the list of candidates according to their score.

- `[n to n]` to select only a section of the full array of candidates. As the array in ordered in
  ascending order, the top candidates are at the end of the array, so you must use negative indexes.
  With the provided input, it selects from -3 to -1, -1 being the last index in the array.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
    TopCandidateList: (payload.candidates map ((candidate) -> {
        firstName: candidate.name,
        rank: candidate.score
    }) orderBy $.rank) [ -payload.availablePositions to -1]
}
```

Input JSON Payload:

```json
{
  "availablePositions": 3,
  "candidates": [
    {
      "name": "Gunther Govan",
      "score": 99
    },
    {
      "name": "Michael Patrick",
      "score": 35
    },
    {
      "name": "Amalia Silva",
      "score": 96
    },
    {
      "name": "Tom Mathews",
      "score": 40
    },
    {
      "name": "Simon Wilson",
      "score": 84
    },
    {
      "name": "Janet Nguyen",
      "score": 52
    }
  ]
}
```

Output JSON:

```json
{
  "TopCandidateList": [
    {
      "firstName": "Simon Wilson",
      "rank": 84
    },
    {
      "firstName": "Amalia Silva",
      "rank": 96
    },
    {
      "firstName": "Gunther Govan",
      "rank": 99
    }
  ]
}
```

## Related Examples

- [Output Self-closing XML tags](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-output-self-closing-xml-tags)

- [Remove Specified XML Attributes](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-remove-certain-xml-attributes)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.6/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook)

<!-- document id=d559f42b91b6a276e32f65409b6ca3d721becf876d1e7e85e4282b6722f5ef40 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook-pick-top-elements.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, transform, transformer, format, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Pick Top Elements

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example sorts an array of candidates by the score they got in a test, then picks only
the ones with the best score, as many as there are open positions to fill.

This example uses the following:

- `map` to go through each of the candidates in the input.

- `orderBy` to order the list of candidates according to their score.

- `[n to n]` to select only a section of the full array of candidates. As the array in ordered in
  ascending order, the top candidates are at the end of the array, so you must use negative indexes.
  With the provided input, it selects from -3 to -1, -1 being the last index in the array.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
    TopCandidateList: (payload.candidates map ((candidate) -> {
        firstName: candidate.name,
        rank: candidate.score
    }) orderBy $.rank) [ -payload.availablePositions to -1]
}
```

Input JSON Payload:

```json
{
  "availablePositions": 3,
  "candidates": [
    {
      "name": "Gunther Govan",
      "score": 99
    },
    {
      "name": "Michael Patrick",
      "score": 35
    },
    {
      "name": "Amalia Silva",
      "score": 96
    },
    {
      "name": "Tom Mathews",
      "score": 40
    },
    {
      "name": "Simon Wilson",
      "score": 84
    },
    {
      "name": "Janet Nguyen",
      "score": 52
    }
  ]
}
```

Output JSON:

```json
{
  "TopCandidateList": [
    {
      "firstName": "Simon Wilson",
      "rank": 84
    },
    {
      "firstName": "Amalia Silva",
      "rank": 96
    },
    {
      "firstName": "Gunther Govan",
      "rank": 99
    }
  ]
}
```

## Related Examples

- [Output Self-closing XML tags](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-output-self-closing-xml-tags)

- [Remove Specified XML Attributes](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-remove-certain-xml-attributes)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.9/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook)

<!-- document id=65a14c42fc24249655b848d5f352903e1124138495f1c745b5cf6ed0c2303662 url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook-pick-top-elements.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, transform, transformer, format, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Pick Top Elements

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example sorts an array of candidates by the score they got in a test, then picks only
the ones with the best score, as many as there are open positions to fill.

This example uses the following:

- `map` to go through each of the candidates in the input.

- `orderBy` to order the list of candidates according to their score.

- `[n to n]` to select only a section of the full array of candidates. As the array in ordered in
  ascending order, the top candidates are at the end of the array, so you must use negative indexes.
  With the provided input, it selects from -3 to -1, -1 being the last index in the array.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
    TopCandidateList: (payload.candidates map ((candidate) -> {
        firstName: candidate.name,
        rank: candidate.score
    }) orderBy $.rank) [ -payload.availablePositions to -1]
}
```

Input JSON Payload:

```json
{
  "availablePositions": 3,
  "candidates": [
    {
      "name": "Gunther Govan",
      "score": 99
    },
    {
      "name": "Michael Patrick",
      "score": 35
    },
    {
      "name": "Amalia Silva",
      "score": 96
    },
    {
      "name": "Tom Mathews",
      "score": 40
    },
    {
      "name": "Simon Wilson",
      "score": 84
    },
    {
      "name": "Janet Nguyen",
      "score": 52
    }
  ]
}
```

Output JSON:

```json
{
  "TopCandidateList": [
    {
      "firstName": "Simon Wilson",
      "rank": 84
    },
    {
      "firstName": "Amalia Silva",
      "rank": 96
    },
    {
      "firstName": "Gunther Govan",
      "rank": 99
    }
  ]
}
```

## Related Examples

- [Output Self-closing XML tags](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-output-self-closing-xml-tags)

- [Remove Specified XML Attributes](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-remove-certain-xml-attributes)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook)

<!-- document id=d1fbb9e463aea45533206934a1fd6e3df6b0e13b43ad549f70a8effd34ab58c7 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-pluck.md -->

---
product: DataWeave
version: 2.11
---

# pluck

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## pluck<K, V, R>(@StreamCapable object: { (K)?: V }, mapper: (value: V, key: K, index: Number) -> R): Array<R>

Useful for mapping an object into an array, `pluck` iterates over an object and returns an array of
keys, values, or indices from the object.

It is an alternative to `mapObject`, which is similar but returns an object, instead of an array.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object to map.</p></td></tr><tr><td><p><code>mapper</code></p></td><td><p>Expression or selector that provides the <code>key</code>, <code>value</code>, and/or <code>index</code> (optional) used for mapping the specified object into an array.</p></td></tr></tbody></table>

### Example

This example iterates over `{ "a":"b","c":"d"}` using the anonymous mapper function
(`(value,key,index) → { (index) : { (value):key} }`) to invert each key-value pair in the specified
object and to return their indices as keys. The mapper uses named parameters to identify the keys,
values, and indices of the object. Note that you can write the same expression using anonymous
parameters, like this: `{"a":"b","c":"d"} pluck { ($$$) : { ($):$$} }` Unlike the almost identical
example that uses `mapObject`, `pluck` returns the output as an array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{"a":"b","c":"d"} pluck (value,key,index) -> { (index) : { (value):key} }
```

#### Output

```JSON
[ { "0": { "b": "a" } }, { "1": { "d": "c" } } ]
```

### Example

This example uses `pluck` to iterate over each element within `<prices/>` and returns arrays of
their keys, values, and indices. It uses anonymous parameters to capture them. Note that it uses
`as Number` to convert the values to numbers. Otherwise, they would return as strings.

#### Source

```DataWeave
%dw 2.0
output application/json
var readXml = read("<prices>
    <basic>9.99</basic>
    <premium>53.00</premium>
    <vip>398.99</vip>
    </prices>", "application/xml")
---
"result" : {
  "keys" : readXml.prices pluck($$),
  "values" : readXml.prices pluck($) as Number,
  "indices" : readXml.prices pluck($$$)
}
```

#### Output

```JSON
{
   "result": {
     "keys": [ "basic", "premium", "vip" ],
     "values": [ 9.99, 53, 398.99 ],
     "indices": [ 0, 1, 2 ]
   }
}
```

## pluck(value: Null, mapper: (value: Nothing, key: Nothing, index: Nothing) -> Any): Null

Helper function that enables `pluck` to work with a `null` value.

<!-- document id=8ed28dc892ca69f40f4c6c6a55dbfea45b41121688c2d14155efc4c627db57ca url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-pluck.md -->

---
product: DataWeave
version: 2.12
---

# pluck

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## pluck<K, V, R>(@StreamCapable object: { (K)?: V }, mapper: (value: V, key: K, index: Number) -> R): Array<R>

Useful for mapping an object into an array, `pluck` iterates over an object and returns an array of
keys, values, or indices from the object.

It is an alternative to `mapObject`, which is similar but returns an object, instead of an array.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object to map.</p></td></tr><tr><td><p><code>mapper</code></p></td><td><p>Expression or selector that provides the <code>key</code>, <code>value</code>, and/or <code>index</code> (optional) used for mapping the specified object into an array.</p></td></tr></tbody></table>

### Example

This example iterates over `{ "a":"b","c":"d"}` using the anonymous mapper function
(`(value,key,index) → { (index) : { (value):key} }`) to invert each key-value pair in the specified
object and to return their indices as keys. The mapper uses named parameters to identify the keys,
values, and indices of the object. Note that you can write the same expression using anonymous
parameters, like this: `{"a":"b","c":"d"} pluck { ($$$) : { ($):$$} }` Unlike the almost identical
example that uses `mapObject`, `pluck` returns the output as an array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{"a":"b","c":"d"} pluck (value,key,index) -> { (index) : { (value):key} }
```

#### Output

```JSON
[ { "0": { "b": "a" } }, { "1": { "d": "c" } } ]
```

### Example

This example uses `pluck` to iterate over each element within `<prices/>` and returns arrays of
their keys, values, and indices. It uses anonymous parameters to capture them. Note that it uses
`as Number` to convert the values to numbers. Otherwise, they would return as strings.

#### Source

```DataWeave
%dw 2.0
output application/json
var readXml = read("<prices>
    <basic>9.99</basic>
    <premium>53.00</premium>
    <vip>398.99</vip>
    </prices>", "application/xml")
---
"result" : {
  "keys" : readXml.prices pluck($$),
  "values" : readXml.prices pluck($) as Number,
  "indices" : readXml.prices pluck($$$)
}
```

#### Output

```JSON
{
   "result": {
     "keys": [ "basic", "premium", "vip" ],
     "values": [ 9.99, 53, 398.99 ],
     "indices": [ 0, 1, 2 ]
   }
}
```

## pluck(value: Null, mapper: (value: Nothing, key: Nothing, index: Nothing) -> Any): Null

Helper function that enables `pluck` to work with a `null` value.

<!-- document id=16ab992eb72f2a22afc7afd278bf81cfe498016d3e72e2236503a3b596844a90 url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-pluck.md -->

---
product: DataWeave
version: 2.3
---

# pluck

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## pluck({ (K)?: V }, (value: V, key: K, index: Number) -> R): Array<R>

Useful for mapping an object into an array, `pluck` iterates over an object and returns an array of
keys, values, or indices from the object.

It is an alternative to `mapObject`, which is similar but returns an object, instead of an array.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object to map.</p></td></tr><tr><td><p><code>mapper</code></p></td><td><p>Expression or selector that provides the <code>key</code>, <code>value</code>, and/or <code>index</code> (optional) used for mapping the specified object into an array.</p></td></tr></tbody></table>

### Example

This example iterates over `{ "a":"b","c":"d"}` using the anonymous mapper function
(`(value,key,index) → { (index) : { (value):key} }`) to invert each key-value pair in the specified
object and to return their indices as keys. The mapper uses named parameters to identify the keys,
values, and indices of the object. Note that you can write the same expression using anonymous
parameters, like this: `{"a":"b","c":"d"} pluck { ($$$) : { ($):$$} }` Unlike the almost identical
example that uses `mapObject`, `pluck` returns the output as an array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{"a":"b","c":"d"} pluck (value,key,index) -> { (index) : { (value):key} }
```

#### Output

```JSON
[ { "0": { "b": "a" } }, { "1": { "d": "c" } } ]
```

### Example

This example uses `pluck` to iterate over each element within `<prices/>` and returns arrays of
their keys, values, and indices. It uses anonymous parameters to capture them. Note that it uses
`as Number` to convert the values to numbers. Otherwise, they would return as strings.

#### Source

```DataWeave
%dw 2.0
output application/json
var readXml = read("<prices>
    <basic>9.99</basic>
    <premium>53.00</premium>
    <vip>398.99</vip>
    </prices>", "application/xml")
---
"result" : {
  "keys" : readXml.prices pluck($$),
  "values" : readXml.prices pluck($) as Number,
  "indices" : readXml.prices pluck($$$)
}
```

#### Output

```JSON
{
   "result": {
     "keys": [ "basic", "premium", "vip" ],
     "values": [ 9.99, 53, 398.99 ],
     "indices": [ 0, 1, 2 ]
   }
}
```

## pluck(Null, (value: Nothing, key: Nothing, index: Nothing) -> Any): Null

Helper function that enables `pluck` to work with a `null` value.

<!-- document id=8b19f2f0f1a453b88feb428a593ec8c1cac9366132d9b2531572c974922ed346 url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-pluck.md -->

---
product: DataWeave
version: 2.4
---

# pluck

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## pluck<K, V, R>(@StreamCapable object: { (K)?: V }, mapper: (value: V, key: K, index: Number) -> R): Array<R>

Useful for mapping an object into an array, `pluck` iterates over an object and returns an array of
keys, values, or indices from the object.

It is an alternative to `mapObject`, which is similar but returns an object, instead of an array.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object to map.</p></td></tr><tr><td><p><code>mapper</code></p></td><td><p>Expression or selector that provides the <code>key</code>, <code>value</code>, and/or <code>index</code> (optional) used for mapping the specified object into an array.</p></td></tr></tbody></table>

### Example

This example iterates over `{ "a":"b","c":"d"}` using the anonymous mapper function
(`(value,key,index) → { (index) : { (value):key} }`) to invert each key-value pair in the specified
object and to return their indices as keys. The mapper uses named parameters to identify the keys,
values, and indices of the object. Note that you can write the same expression using anonymous
parameters, like this: `{"a":"b","c":"d"} pluck { ($$$) : { ($):$$} }` Unlike the almost identical
example that uses `mapObject`, `pluck` returns the output as an array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{"a":"b","c":"d"} pluck (value,key,index) -> { (index) : { (value):key} }
```

#### Output

```JSON
[ { "0": { "b": "a" } }, { "1": { "d": "c" } } ]
```

### Example

This example uses `pluck` to iterate over each element within `<prices/>` and returns arrays of
their keys, values, and indices. It uses anonymous parameters to capture them. Note that it uses
`as Number` to convert the values to numbers. Otherwise, they would return as strings.

#### Source

```DataWeave
%dw 2.0
output application/json
var readXml = read("<prices>
    <basic>9.99</basic>
    <premium>53.00</premium>
    <vip>398.99</vip>
    </prices>", "application/xml")
---
"result" : {
  "keys" : readXml.prices pluck($$),
  "values" : readXml.prices pluck($) as Number,
  "indices" : readXml.prices pluck($$$)
}
```

#### Output

```JSON
{
   "result": {
     "keys": [ "basic", "premium", "vip" ],
     "values": [ 9.99, 53, 398.99 ],
     "indices": [ 0, 1, 2 ]
   }
}
```

## pluck(value: Null, mapper: (value: Nothing, key: Nothing, index: Nothing) -> Any): Null

Helper function that enables `pluck` to work with a `null` value.

<!-- document id=bb7d73572ecdd0deed84e2e0900b7f640503f902d15eaea971806506796d6296 url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-pluck.md -->

---
product: DataWeave
version: 2.6
---

# pluck

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## pluck<K, V, R>(@StreamCapable object: { (K)?: V }, mapper: (value: V, key: K, index: Number) -> R): Array<R>

Useful for mapping an object into an array, `pluck` iterates over an object and returns an array of
keys, values, or indices from the object.

It is an alternative to `mapObject`, which is similar but returns an object, instead of an array.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object to map.</p></td></tr><tr><td><p><code>mapper</code></p></td><td><p>Expression or selector that provides the <code>key</code>, <code>value</code>, and/or <code>index</code> (optional) used for mapping the specified object into an array.</p></td></tr></tbody></table>

### Example

This example iterates over `{ "a":"b","c":"d"}` using the anonymous mapper function
(`(value,key,index) → { (index) : { (value):key} }`) to invert each key-value pair in the specified
object and to return their indices as keys. The mapper uses named parameters to identify the keys,
values, and indices of the object. Note that you can write the same expression using anonymous
parameters, like this: `{"a":"b","c":"d"} pluck { ($$$) : { ($):$$} }` Unlike the almost identical
example that uses `mapObject`, `pluck` returns the output as an array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{"a":"b","c":"d"} pluck (value,key,index) -> { (index) : { (value):key} }
```

#### Output

```JSON
[ { "0": { "b": "a" } }, { "1": { "d": "c" } } ]
```

### Example

This example uses `pluck` to iterate over each element within `<prices/>` and returns arrays of
their keys, values, and indices. It uses anonymous parameters to capture them. Note that it uses
`as Number` to convert the values to numbers. Otherwise, they would return as strings.

#### Source

```DataWeave
%dw 2.0
output application/json
var readXml = read("<prices>
    <basic>9.99</basic>
    <premium>53.00</premium>
    <vip>398.99</vip>
    </prices>", "application/xml")
---
"result" : {
  "keys" : readXml.prices pluck($$),
  "values" : readXml.prices pluck($) as Number,
  "indices" : readXml.prices pluck($$$)
}
```

#### Output

```JSON
{
   "result": {
     "keys": [ "basic", "premium", "vip" ],
     "values": [ 9.99, 53, 398.99 ],
     "indices": [ 0, 1, 2 ]
   }
}
```

## pluck(value: Null, mapper: (value: Nothing, key: Nothing, index: Nothing) -> Any): Null

Helper function that enables `pluck` to work with a `null` value.

<!-- document id=fa4a83c042d3a41355754f7f8e9d3558f352ebd86067015c83b68de99fc10d04 url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-pluck.md -->

---
product: DataWeave
version: 2.9
---

# pluck

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## pluck<K, V, R>(@StreamCapable object: { (K)?: V }, mapper: (value: V, key: K, index: Number) -> R): Array<R>

Useful for mapping an object into an array, `pluck` iterates over an object and returns an array of
keys, values, or indices from the object.

It is an alternative to `mapObject`, which is similar but returns an object, instead of an array.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object to map.</p></td></tr><tr><td><p><code>mapper</code></p></td><td><p>Expression or selector that provides the <code>key</code>, <code>value</code>, and/or <code>index</code> (optional) used for mapping the specified object into an array.</p></td></tr></tbody></table>

### Example

This example iterates over `{ "a":"b","c":"d"}` using the anonymous mapper function
(`(value,key,index) → { (index) : { (value):key} }`) to invert each key-value pair in the specified
object and to return their indices as keys. The mapper uses named parameters to identify the keys,
values, and indices of the object. Note that you can write the same expression using anonymous
parameters, like this: `{"a":"b","c":"d"} pluck { ($$$) : { ($):$$} }` Unlike the almost identical
example that uses `mapObject`, `pluck` returns the output as an array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{"a":"b","c":"d"} pluck (value,key,index) -> { (index) : { (value):key} }
```

#### Output

```JSON
[ { "0": { "b": "a" } }, { "1": { "d": "c" } } ]
```

### Example

This example uses `pluck` to iterate over each element within `<prices/>` and returns arrays of
their keys, values, and indices. It uses anonymous parameters to capture them. Note that it uses
`as Number` to convert the values to numbers. Otherwise, they would return as strings.

#### Source

```DataWeave
%dw 2.0
output application/json
var readXml = read("<prices>
    <basic>9.99</basic>
    <premium>53.00</premium>
    <vip>398.99</vip>
    </prices>", "application/xml")
---
"result" : {
  "keys" : readXml.prices pluck($$),
  "values" : readXml.prices pluck($) as Number,
  "indices" : readXml.prices pluck($$$)
}
```

#### Output

```JSON
{
   "result": {
     "keys": [ "basic", "premium", "vip" ],
     "values": [ 9.99, 53, 398.99 ],
     "indices": [ 0, 1, 2 ]
   }
}
```

## pluck(value: Null, mapper: (value: Nothing, key: Nothing, index: Nothing) -> Any): Null

Helper function that enables `pluck` to work with a `null` value.

<!-- document id=80250759aafb3ca3b722a7bf31911babb045f83b845ae9f090134282110798ec url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-pluck.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# pluck

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## pluck<K, V, R>(@StreamCapable object: { (K)?: V }, mapper: (value: V, key: K, index: Number) -> R): Array<R>

Useful for mapping an object into an array, `pluck` iterates over an object and returns an array of
keys, values, or indices from the object.

It is an alternative to `mapObject`, which is similar but returns an object, instead of an array.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The object to map.</p></td></tr><tr><td><p><code>mapper</code></p></td><td><p>Expression or selector that provides the <code>key</code>, <code>value</code>, and/or <code>index</code> (optional) used for mapping the specified object into an array.</p></td></tr></tbody></table>

### Example

This example iterates over `{ "a":"b","c":"d"}` using the anonymous mapper function
(`(value,key,index) → { (index) : { (value):key} }`) to invert each key-value pair in the specified
object and to return their indices as keys. The mapper uses named parameters to identify the keys,
values, and indices of the object. Note that you can write the same expression using anonymous
parameters, like this: `{"a":"b","c":"d"} pluck { ($$$) : { ($):$$} }` Unlike the almost identical
example that uses `mapObject`, `pluck` returns the output as an array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{"a":"b","c":"d"} pluck (value,key,index) -> { (index) : { (value):key} }
```

#### Output

```JSON
[ { "0": { "b": "a" } }, { "1": { "d": "c" } } ]
```

### Example

This example uses `pluck` to iterate over each element within `<prices/>` and returns arrays of
their keys, values, and indices. It uses anonymous parameters to capture them. Note that it uses
`as Number` to convert the values to numbers. Otherwise, they would return as strings.

#### Source

```DataWeave
%dw 2.0
output application/json
var readXml = read("<prices>
    <basic>9.99</basic>
    <premium>53.00</premium>
    <vip>398.99</vip>
    </prices>", "application/xml")
---
"result" : {
  "keys" : readXml.prices pluck($$),
  "values" : readXml.prices pluck($) as Number,
  "indices" : readXml.prices pluck($$$)
}
```

#### Output

```JSON
{
   "result": {
     "keys": [ "basic", "premium", "vip" ],
     "values": [ 9.99, 53, 398.99 ],
     "indices": [ 0, 1, 2 ]
   }
}
```

## pluck(value: Null, mapper: (value: Nothing, key: Nothing, index: Nothing) -> Any): Null

Helper function that enables `pluck` to work with a `null` value.

<!-- document id=a0d2cb0854322b8882ce539f8fc5cd770fde6b29c4b612b64147ca8093d3b06a url=/mulesoft/current/en-us/dataweave/2.11/dw-strings-functions-pluralize.md -->

---
product: DataWeave
version: 2.11
---

# pluralize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## pluralize(text: String): String

Pluralizes a singular string.

If the input is already plural (for example, "boxes"), the output will match the input.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to pluralize.</p></td></tr></tbody></table>

### Example

This example pluralizes the input string "box" to return "boxes".

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
 { "pluralize" : pluralize("box") }
```

#### Output

```JSON
{ "pluralize" : "boxes" }
```

## pluralize(text: Null): Null

Helper function that enables `pluralize` to work with a `null` value.

<!-- document id=73f11f1baab2dfbf4205062c9d47bd09bf1fd870d890633ef051cc70139909e5 url=/mulesoft/current/en-us/dataweave/2.12/dw-strings-functions-pluralize.md -->

---
product: DataWeave
version: 2.12
---

# pluralize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## pluralize(text: String): String

Pluralizes a singular string.

If the input is already plural (for example, "boxes"), the output will match the input.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to pluralize.</p></td></tr></tbody></table>

### Example

This example pluralizes the input string "box" to return "boxes".

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
 { "pluralize" : pluralize("box") }
```

#### Output

```JSON
{ "pluralize" : "boxes" }
```

## pluralize(text: Null): Null

Helper function that enables `pluralize` to work with a `null` value.

<!-- document id=63fab0490a4999647e05b054693ba079a4fd5d7f558ece0cf0ac850e803f377e url=/mulesoft/current/en-us/dataweave/2.3/dw-strings-functions-pluralize.md -->

---
product: DataWeave
version: 2.3
---

# pluralize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## pluralize(String): String

Pluralizes a singular string.

If the input is already plural (for example, "boxes"), the output will match the input.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to pluralize.</p></td></tr></tbody></table>

### Example

This example pluralizes the input string "box" to return "boxes".

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
 { "pluralize" : pluralize("box") }
```

#### Output

```JSON
{ "pluralize" : "boxes" }
```

## pluralize(Null): Null

Helper function that enables `pluralize` to work with a `null` value.

<!-- document id=48196a7556d48c27fd2fe8e7c43cc6655ce79f5515dbdf9518968a67f11a4e52 url=/mulesoft/current/en-us/dataweave/2.4/dw-strings-functions-pluralize.md -->

---
product: DataWeave
version: 2.4
---

# pluralize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## pluralize(text: String): String

Pluralizes a singular string.

If the input is already plural (for example, "boxes"), the output will match the input.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to pluralize.</p></td></tr></tbody></table>

### Example

This example pluralizes the input string "box" to return "boxes".

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
 { "pluralize" : pluralize("box") }
```

#### Output

```JSON
{ "pluralize" : "boxes" }
```

## pluralize(text: Null): Null

Helper function that enables `pluralize` to work with a `null` value.

<!-- document id=28e70d7a63955a87e78e045ab26867cc85b914195ff2d973f3be2d2b5b3115ca url=/mulesoft/current/en-us/dataweave/2.6/dw-strings-functions-pluralize.md -->

---
product: DataWeave
version: 2.6
---

# pluralize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## pluralize(text: String): String

Pluralizes a singular string.

If the input is already plural (for example, "boxes"), the output will match the input.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to pluralize.</p></td></tr></tbody></table>

### Example

This example pluralizes the input string "box" to return "boxes".

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
 { "pluralize" : pluralize("box") }
```

#### Output

```JSON
{ "pluralize" : "boxes" }
```

## pluralize(text: Null): Null

Helper function that enables `pluralize` to work with a `null` value.

<!-- document id=98003057ed433b9e1a1fa36ef5855b149c56ab25a476a19748b890d6a5969ceb url=/mulesoft/current/en-us/dataweave/2.9/dw-strings-functions-pluralize.md -->

---
product: DataWeave
version: 2.9
---

# pluralize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## pluralize(text: String): String

Pluralizes a singular string.

If the input is already plural (for example, "boxes"), the output will match the input.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to pluralize.</p></td></tr></tbody></table>

### Example

This example pluralizes the input string "box" to return "boxes".

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
 { "pluralize" : pluralize("box") }
```

#### Output

```JSON
{ "pluralize" : "boxes" }
```

## pluralize(text: Null): Null

Helper function that enables `pluralize` to work with a `null` value.

<!-- document id=4e078887e095518d013a4817bd702d1eef42805f0ad7704eb18a7ccff83eeb64 url=/mulesoft/current/en-us/dataweave/latest/dw-strings-functions-pluralize.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# pluralize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## pluralize(text: String): String

Pluralizes a singular string.

If the input is already plural (for example, "boxes"), the output will match the input.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to pluralize.</p></td></tr></tbody></table>

### Example

This example pluralizes the input string "box" to return "boxes".

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
 { "pluralize" : pluralize("box") }
```

#### Output

```JSON
{ "pluralize" : "boxes" }
```

## pluralize(text: Null): Null

Helper function that enables `pluralize` to work with a `null` value.

<!-- document id=333d2c20bd45ae25a9fe10c89190e4b9fd3103a4b5a74b8927265b7083ae8ddc url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-pow.md -->

---
product: DataWeave
version: 2.11
---

# pow

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## pow(base: Number, power: Number): Number

Raises the value of a `base` number to the specified `power`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>base</code></p></td><td><p>A number (<code>Number</code> type) that serves as the base.</p></td></tr><tr><td><p><code>power</code></p></td><td><p>A number (<code>Number</code> type) that serves as the power.</p></td></tr></tbody></table>

### Example

This example raises the value a `base` number to the specified `power`. Note that you can also use
the `pow(base,power)` notation (for example, `pow(2,3)` to return `8`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ (2 pow 3), (3 pow 2), (7 pow 3) ]
```

#### Output

```JSON
[ 8, 9, 343 ]
```

<!-- document id=3678f583003b32435e263e11e6537d7c43bf11d2cd4cffc7371a2ba67fbfc003 url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-pow.md -->

---
product: DataWeave
version: 2.12
---

# pow

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## pow(base: Number, power: Number): Number

Raises the value of a `base` number to the specified `power`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>base</code></p></td><td><p>A number (<code>Number</code> type) that serves as the base.</p></td></tr><tr><td><p><code>power</code></p></td><td><p>A number (<code>Number</code> type) that serves as the power.</p></td></tr></tbody></table>

### Example

This example raises the value a `base` number to the specified `power`. Note that you can also use
the `pow(base,power)` notation (for example, `pow(2,3)` to return `8`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ (2 pow 3), (3 pow 2), (7 pow 3) ]
```

#### Output

```JSON
[ 8, 9, 343 ]
```

<!-- document id=6b733a90c92489aad7afa88fea2ea0fab4dc822291a779b5a6ae694c5a84d41a url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-pow.md -->

---
product: DataWeave
version: 2.3
---

# pow

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## pow(Number, Number): Number

Raises the value of a `base` number to the specified `power`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>base</code></p></td><td><p>A number (<code>Number</code> type) that serves as the base.</p></td></tr><tr><td><p><code>power</code></p></td><td><p>A number (<code>Number</code> type) that serves as the power.</p></td></tr></tbody></table>

### Example

This example raises the value a `base` number to the specified `power`. Note that you can also use
the `pow(base,power)` notation (for example, `pow(2,3)` to return `8`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ (2 pow 3), (3 pow 2), (7 pow 3) ]
```

#### Output

```JSON
[ 8, 9, 343 ]
```

<!-- document id=9b15be01f2237482296a48b755457922e061b9df85ac14f2bb09fc021c9910ea url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-pow.md -->

---
product: DataWeave
version: 2.4
---

# pow

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## pow(base: Number, power: Number): Number

Raises the value of a `base` number to the specified `power`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>base</code></p></td><td><p>A number (<code>Number</code> type) that serves as the base.</p></td></tr><tr><td><p><code>power</code></p></td><td><p>A number (<code>Number</code> type) that serves as the power.</p></td></tr></tbody></table>

### Example

This example raises the value a `base` number to the specified `power`. Note that you can also use
the `pow(base,power)` notation (for example, `pow(2,3)` to return `8`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ (2 pow 3), (3 pow 2), (7 pow 3) ]
```

#### Output

```JSON
[ 8, 9, 343 ]
```

<!-- document id=2b09f55919c0aeb7e82398516f0f8e3afa051ab9251dbb70758e705b1bdbe6f6 url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-pow.md -->

---
product: DataWeave
version: 2.6
---

# pow

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## pow(base: Number, power: Number): Number

Raises the value of a `base` number to the specified `power`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>base</code></p></td><td><p>A number (<code>Number</code> type) that serves as the base.</p></td></tr><tr><td><p><code>power</code></p></td><td><p>A number (<code>Number</code> type) that serves as the power.</p></td></tr></tbody></table>

### Example

This example raises the value a `base` number to the specified `power`. Note that you can also use
the `pow(base,power)` notation (for example, `pow(2,3)` to return `8`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ (2 pow 3), (3 pow 2), (7 pow 3) ]
```

#### Output

```JSON
[ 8, 9, 343 ]
```

<!-- document id=e9334a822b4c373e46a5c052a55a39680670795a1ff56b0b51afb6fc5a993c05 url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-pow.md -->

---
product: DataWeave
version: 2.9
---

# pow

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## pow(base: Number, power: Number): Number

Raises the value of a `base` number to the specified `power`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>base</code></p></td><td><p>A number (<code>Number</code> type) that serves as the base.</p></td></tr><tr><td><p><code>power</code></p></td><td><p>A number (<code>Number</code> type) that serves as the power.</p></td></tr></tbody></table>

### Example

This example raises the value a `base` number to the specified `power`. Note that you can also use
the `pow(base,power)` notation (for example, `pow(2,3)` to return `8`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ (2 pow 3), (3 pow 2), (7 pow 3) ]
```

#### Output

```JSON
[ 8, 9, 343 ]
```

<!-- document id=093974bd09927fc43587b37ff9a1c24e9d69ce4384c2a05202047303ed51d6ad url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-pow.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# pow

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## pow(base: Number, power: Number): Number

Raises the value of a `base` number to the specified `power`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>base</code></p></td><td><p>A number (<code>Number</code> type) that serves as the base.</p></td></tr><tr><td><p><code>power</code></p></td><td><p>A number (<code>Number</code> type) that serves as the power.</p></td></tr></tbody></table>

### Example

This example raises the value a `base` number to the specified `power`. Note that you can also use
the `pow(base,power)` notation (for example, `pow(2,3)` to return `8`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ (2 pow 3), (3 pow 2), (7 pow 3) ]
```

#### Output

```JSON
[ 8, 9, 343 ]
```

<!-- document id=a65b3c20c571e04a19c2d844a73e3578ef3d2c12de45763fa1187d2f4c37f590 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-flow-control-precedence.md -->

---
product: DataWeave
version: 2.11
---

# Precedence in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave expressions are compiled in a specific order. The result of a compilation of something at
one level can serve as input for expressions in higher levels, but not at lower levels.

## Order of Compilation

The following table orders operators and functions from first compiled (1) to last compiled (10):

<table><colgroup><col> <col></colgroup><thead><tr><th>Level</th><th>Operator or Function</th></tr></thead><tbody><tr><td><p>1</p></td><td><div><div><ul><li><p><code>using</code>: For initializing local variables in a DataWeave script.</p></li><li><p>Unary DataWeave operators at this level:</p><div><ul><li><p><code>.^</code>: Schema selector.</p></li><li><p><code>.#</code>: Namespace selector.</p></li><li><p><code>..</code>: Descendants selector.</p></li><li><p><code>not</code>: Logical operator for negation.</p></li><li><p><code>.@</code>: All attribute selector, for example, in a case that uses the expression <code>payload.root.a.@</code> to return the attributes and values of the input payload <code>&lt;root&gt; &lt;a attr1="foo" attr2="bar" /&gt;&lt;/root&gt;</code> within the array of objects <code>{ "attr1": "foo", "attr2": "bar" }</code>.</p></li></ul></div></li></ul></div></div></td></tr><tr><td><p>2</p></td><td><div><div><ul><li><p><code>as</code>: Used for type coercion.</p></li></ul></div></div></td></tr><tr><td><p>3</p></td><td><div><div><ul><li><p><code>*</code>: Multiply.</p></li><li><p><code>/</code>: Divide.</p></li></ul></div></div></td></tr><tr><td><p>4</p></td><td><div><div><ul><li><p><code>+</code>: Add.</p></li><li><p><code>-</code>: Subtract.</p></li><li><p><code>&gt;&gt;</code>: Prepend data.</p></li><li><p><code>&lt;&lt;</code>: Append data.</p></li></ul></div></div></td></tr><tr><td><p>5</p></td><td><div><div><ul><li><p><code>&gt;</code>: Greater than or equal to.</p></li><li><p><code>=</code>: Equal to.</p></li><li><p><code>&lt;</code>: Less than or equal to.</p></li><li><p><code>&lt;</code>: Less than.</p></li><li><p><code>&gt;</code>: Greater than.</p></li><li><p><code>is</code>: Compare type, for example, used in <a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-remove-certain-xml-attributes">Remove Specified XML Attributes</a>.</p></li></ul></div></div></td></tr><tr><td><p>6</p></td><td><div><div><ul><li><p><code>!=</code>: Not equal to.</p></li><li><p><code>~=</code>: Contains.</p></li><li><p><code>==</code>: Equality operator that tries to coerce one value to the type of the other when the types are different.</p></li></ul></div></div></td></tr><tr><td><p>7</p></td><td><div><div><ul><li><p><code>and</code>: Logical <code>and</code> operator.</p></li></ul></div></div></td></tr><tr><td><p>8</p></td><td><div><div><ul><li><p><code>or</code>: Logical <code>or</code> operator.</p></li></ul></div></div></td></tr><tr><td><p>9</p></td><td><div><div><ul><li><p><code>default</code>: For setting a default value.</p></li><li><p><code>case</code> and <code>else</code>: For pattern matching.</p></li><li><p>DataWeave functions at this level:</p><div><ul><li><p><code>matches</code></p></li><li><p><code>match</code></p></li><li><p><code>map</code></p></li><li><p><code>mapObject</code></p></li><li><p><code>groupBy</code></p></li><li><p><code>filter</code></p></li></ul></div></li><li><p>Binary DataWeave selectors at this level:</p><div><ul><li><p><code>.@keyName</code> and <code>.*@</code>: Binary DataWeave attribute selectors.</p></li><li><p><code>.*</code>: Multi-value selector.</p></li><li><p><code>.^</code>: Metadata selector.</p></li><li><p><code>.&amp;</code>: Key-value pair selector.</p></li><li><p><code>[?()]</code>: Filter selector.</p></li></ul></div></li><li><p><code>.keyName</code>: Value selector.</p></li><li><p><code>[&lt;index&gt; to &lt;index&gt;]</code>: Range selector</p></li></ul></div></div></td></tr><tr><td><p>10</p></td><td><div><div><ul><li><p><code>if else</code>: Conditional expression used for flow control in DataWeave.</p></li></ul></div></div></td></tr></tbody></table>

## Order of Chained Function Calls

When functions are chained together in a series, the functions are processed in order from the first
to the last function specified in the chain.

For example, the following script acts on the input array of objects defined by the variable
`flights`. The script first calls `filter` to return an array that accepts all `price` values that
are less than 500. Then it calls `orderBy` to return an array that reorders the objects found in the
input from the lowest to the highest `price` value. Finally, it calls `groupBy` to group the input
array of objects alphabetically by `toAirport` value.

DataWeave Script:

```DataWeave
%dw 2.0
output application/json
var flights = [
  { "toAirport": "SFO", "price": 550, "airline": "American" },
  { "toAirport": "MUA", "price": 200, "airline": "American" },
  { "toAirport": "SFO", "price": 300, "airline": "American" },
  { "toAirport": "CLE", "price": 600, "airline": "American" },
  { "toAirport": "CLE", "price": 190, "airline": "American" },
  { "toAirport": "SFO", "price": 400, "airline": "American" }
]
---
flights filter $.price < 500 orderBy $.price groupBy $.toAirport
```

The result is an object that contains a collection of key-value pairs:

Output:

{ "CLE": \[ { "toAirport": "CLE", "price": 190, "airline": "American" } \], "SFO": \[ { "toAirport":
"SFO", "price": 300, "airline": "United" }, { "toAirport": "SFO", "price": 400, "airline":
"American" } \], "MUA": \[ { "toAirport": "MUA", "price": 200, "airline": "American" } \] }

You can force the evaluation order by inserting evaluation parentheses `(` and `)` into the
DataWeave expression. This example returns the same output as the previous example:

DataWeave Script:

```DataWeave
%dw 2.0
output application/json
var flights = [
  { "toAirport": "SFO", "price": 550, "airline": "American" },
  { "toAirport": "MUA", "price": 200, "airline": "American" },
  { "toAirport": "SFO", "price": 300, "airline": "American" },
  { "toAirport": "CLE", "price": 600, "airline": "American" },
  { "toAirport": "CLE", "price": 190, "airline": "American" },
  { "toAirport": "SFO", "price": 400, "airline": "American" }
]
---
( ( ( flights filter $.price < 500 ) orderBy $.price ) groupBy $.toAirport )
```

The result is an object that contains a collection of key-value pairs:

Output:

{ "CLE": \[ { "toAirport": "CLE", "price": 190, "airline": "American" } \], "SFO": \[ { "toAirport":
"SFO", "price": 300, "airline": "United" }, { "toAirport": "SFO", "price": 400, "airline":
"American" } \], "MUA": \[ { "toAirport": "MUA", "price": 200, "airline": "American" } \] }

The order of the function calls is important. For example, the rearranged expression
`flights groupBy $.toAirport filter $.price < 500 orderBy $.price` returns an error because
`groupBy` returns an object, and `filter` expects an array. The resulting error is
`Expecting Type: Array>T<, but got: {String: Array<{|toA…​ airline: String|}>}`.

## See Also

- [Core (dw::Core) functions](https://docs.mulesoft.com/dataweave/2.11/dw-core)

- [DataWeave Operators](https://docs.mulesoft.com/dataweave/2.11/dw-operators)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.11/dataweave-selectors)

- [DataWeave Variables](https://docs.mulesoft.com/dataweave/2.11/dataweave-variables)

- [Flow Control in DataWeave](https://docs.mulesoft.com/dataweave/2.11/dataweave-flow-control)

- [Pattern Matching in DataWeave](https://docs.mulesoft.com/dataweave/2.11/dataweave-pattern-matching)

- [Type Coercion with DataWeave](https://docs.mulesoft.com/dataweave/2.11/dataweave-types-coercion)

<!-- document id=7129370f43cc9a5d16668119a1b1741d54dc3ec359ac57600522d9461f92de77 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-flow-control-precedence.md -->

---
product: DataWeave
version: 2.12
---

# Precedence in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave expressions are compiled in a specific order. The result of a compilation of something at
one level can serve as input for expressions in higher levels, but not at lower levels.

## Order of Compilation

The following table orders operators and functions from first compiled (1) to last compiled (10):

<table><colgroup><col> <col></colgroup><thead><tr><th>Level</th><th>Operator or Function</th></tr></thead><tbody><tr><td><p>1</p></td><td><div><div><ul><li><p><code>using</code>: For initializing local variables in a DataWeave script.</p></li><li><p>Unary DataWeave operators at this level:</p><div><ul><li><p><code>.^</code>: Schema selector.</p></li><li><p><code>.#</code>: Namespace selector.</p></li><li><p><code>..</code>: Descendants selector.</p></li><li><p><code>not</code>: Logical operator for negation.</p></li><li><p><code>.@</code>: All attribute selector, for example, in a case that uses the expression <code>payload.root.a.@</code> to return the attributes and values of the input payload <code>&lt;root&gt; &lt;a attr1="foo" attr2="bar" /&gt;&lt;/root&gt;</code> within the array of objects <code>{ "attr1": "foo", "attr2": "bar" }</code>.</p></li></ul></div></li></ul></div></div></td></tr><tr><td><p>2</p></td><td><div><div><ul><li><p><code>as</code>: Used for type coercion.</p></li></ul></div></div></td></tr><tr><td><p>3</p></td><td><div><div><ul><li><p><code>*</code>: Multiply.</p></li><li><p><code>/</code>: Divide.</p></li></ul></div></div></td></tr><tr><td><p>4</p></td><td><div><div><ul><li><p><code>+</code>: Add.</p></li><li><p><code>-</code>: Subtract.</p></li><li><p><code>&gt;&gt;</code>: Prepend data.</p></li><li><p><code>&lt;&lt;</code>: Append data.</p></li></ul></div></div></td></tr><tr><td><p>5</p></td><td><div><div><ul><li><p><code>&gt;</code>: Greater than or equal to.</p></li><li><p><code>=</code>: Equal to.</p></li><li><p><code>&lt;</code>: Less than or equal to.</p></li><li><p><code>&lt;</code>: Less than.</p></li><li><p><code>&gt;</code>: Greater than.</p></li><li><p><code>is</code>: Compare type, for example, used in <a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-remove-certain-xml-attributes">Remove Specified XML Attributes</a>.</p></li></ul></div></div></td></tr><tr><td><p>6</p></td><td><div><div><ul><li><p><code>!=</code>: Not equal to.</p></li><li><p><code>~=</code>: Contains.</p></li><li><p><code>==</code>: Equality operator that tries to coerce one value to the type of the other when the types are different.</p></li></ul></div></div></td></tr><tr><td><p>7</p></td><td><div><div><ul><li><p><code>and</code>: Logical <code>and</code> operator.</p></li></ul></div></div></td></tr><tr><td><p>8</p></td><td><div><div><ul><li><p><code>or</code>: Logical <code>or</code> operator.</p></li></ul></div></div></td></tr><tr><td><p>9</p></td><td><div><div><ul><li><p><code>default</code>: For setting a default value.</p></li><li><p><code>case</code> and <code>else</code>: For pattern matching.</p></li><li><p>DataWeave functions at this level:</p><div><ul><li><p><code>matches</code></p></li><li><p><code>match</code></p></li><li><p><code>map</code></p></li><li><p><code>mapObject</code></p></li><li><p><code>groupBy</code></p></li><li><p><code>filter</code></p></li></ul></div></li><li><p>Binary DataWeave selectors at this level:</p><div><ul><li><p><code>.@keyName</code> and <code>.*@</code>: Binary DataWeave attribute selectors.</p></li><li><p><code>.*</code>: Multi-value selector.</p></li><li><p><code>.^</code>: Metadata selector.</p></li><li><p><code>.&amp;</code>: Key-value pair selector.</p></li><li><p><code>[?()]</code>: Filter selector.</p></li></ul></div></li><li><p><code>.keyName</code>: Value selector.</p></li><li><p><code>[&lt;index&gt; to &lt;index&gt;]</code>: Range selector</p></li></ul></div></div></td></tr><tr><td><p>10</p></td><td><div><div><ul><li><p><code>if else</code>: Conditional expression used for flow control in DataWeave.</p></li></ul></div></div></td></tr></tbody></table>

## Order of Chained Function Calls

When functions are chained together in a series, the functions are processed in order from the first
to the last function specified in the chain.

For example, the following script acts on the input array of objects defined by the variable
`flights`. The script first calls `filter` to return an array that accepts all `price` values that
are less than 500. Then it calls `orderBy` to return an array that reorders the objects found in the
input from the lowest to the highest `price` value. Finally, it calls `groupBy` to group the input
array of objects alphabetically by `toAirport` value.

DataWeave Script:

```DataWeave
%dw 2.0
output application/json
var flights = [
  { "toAirport": "SFO", "price": 550, "airline": "American" },
  { "toAirport": "MUA", "price": 200, "airline": "American" },
  { "toAirport": "SFO", "price": 300, "airline": "American" },
  { "toAirport": "CLE", "price": 600, "airline": "American" },
  { "toAirport": "CLE", "price": 190, "airline": "American" },
  { "toAirport": "SFO", "price": 400, "airline": "American" }
]
---
flights filter $.price < 500 orderBy $.price groupBy $.toAirport
```

The result is an object that contains a collection of key-value pairs:

Output:

{ "CLE": \[ { "toAirport": "CLE", "price": 190, "airline": "American" } \], "SFO": \[ { "toAirport":
"SFO", "price": 300, "airline": "United" }, { "toAirport": "SFO", "price": 400, "airline":
"American" } \], "MUA": \[ { "toAirport": "MUA", "price": 200, "airline": "American" } \] }

You can force the evaluation order by inserting evaluation parentheses `(` and `)` into the
DataWeave expression. This example returns the same output as the previous example:

DataWeave Script:

```DataWeave
%dw 2.0
output application/json
var flights = [
  { "toAirport": "SFO", "price": 550, "airline": "American" },
  { "toAirport": "MUA", "price": 200, "airline": "American" },
  { "toAirport": "SFO", "price": 300, "airline": "American" },
  { "toAirport": "CLE", "price": 600, "airline": "American" },
  { "toAirport": "CLE", "price": 190, "airline": "American" },
  { "toAirport": "SFO", "price": 400, "airline": "American" }
]
---
( ( ( flights filter $.price < 500 ) orderBy $.price ) groupBy $.toAirport )
```

The result is an object that contains a collection of key-value pairs:

Output:

{ "CLE": \[ { "toAirport": "CLE", "price": 190, "airline": "American" } \], "SFO": \[ { "toAirport":
"SFO", "price": 300, "airline": "United" }, { "toAirport": "SFO", "price": 400, "airline":
"American" } \], "MUA": \[ { "toAirport": "MUA", "price": 200, "airline": "American" } \] }

The order of the function calls is important. For example, the rearranged expression
`flights groupBy $.toAirport filter $.price < 500 orderBy $.price` returns an error because
`groupBy` returns an object, and `filter` expects an array. The resulting error is
`Expecting Type: Array>T<, but got: {String: Array<{|toA…​ airline: String|}>}`.

## See Also

- [Core (dw::Core) functions](https://docs.mulesoft.com/dataweave/2.12/dw-core)

- [DataWeave Operators](https://docs.mulesoft.com/dataweave/2.12/dw-operators)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.12/dataweave-selectors)

- [DataWeave Variables](https://docs.mulesoft.com/dataweave/2.12/dataweave-variables)

- [Flow Control in DataWeave](https://docs.mulesoft.com/dataweave/2.12/dataweave-flow-control)

- [Pattern Matching in DataWeave](https://docs.mulesoft.com/dataweave/2.12/dataweave-pattern-matching)

- [Type Coercion with DataWeave](https://docs.mulesoft.com/dataweave/2.12/dataweave-types-coercion)

<!-- document id=e620bb71cb6a10e4d0d10cd83b539b0a1a5ae665675c64c2fd21c956cd04d088 url=/mulesoft/current/en-us/dataweave/2.3/dataweave-flow-control-precedence.md -->

---
product: DataWeave
version: 2.3
---

# Precedence in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave expressions are compiled in a specific order. The result of a compilation of something at
one level can serve as input for expressions in higher levels, but not at lower levels.

## Order of Compilation

The following table orders operators and functions from first compiled (1) to last compiled (10):

<table><colgroup><col> <col></colgroup><thead><tr><th>Level</th><th>Operator or Function</th></tr></thead><tbody><tr><td><p>1</p></td><td><div><div><ul><li><p><code>using</code>: For initializing local variables in a DataWeave script.</p></li><li><p>Unary DataWeave operators at this level:</p><div><ul><li><p><code>.^</code>: Schema selector.</p></li><li><p><code>.#</code>: Namespace selector.</p></li><li><p><code>..</code>: Descendants selector.</p></li><li><p><code>not</code>: Logical operator for negation.</p></li><li><p><code>.@</code>: All attribute selector, for example, in a case that uses the expression <code>payload.root.a.@</code> to return the attributes and values of the input payload <code>&lt;root&gt; &lt;a attr1="foo" attr2="bar" /&gt;&lt;/root&gt;</code> within the array of objects <code>{ "attr1": "foo", "attr2": "bar" }</code>.</p></li></ul></div></li></ul></div></div></td></tr><tr><td><p>2</p></td><td><div><div><ul><li><p><code>as</code>: Used for type coercion.</p></li></ul></div></div></td></tr><tr><td><p>3</p></td><td><div><div><ul><li><p><code>*</code>: Multiply.</p></li><li><p><code>/</code>: Divide.</p></li></ul></div></div></td></tr><tr><td><p>4</p></td><td><div><div><ul><li><p><code>+</code>: Add.</p></li><li><p><code>-</code>: Subtract.</p></li><li><p><code>&gt;&gt;</code>: Prepend data.</p></li><li><p><code>&lt;&lt;</code>: Append data.</p></li></ul></div></div></td></tr><tr><td><p>5</p></td><td><div><div><ul><li><p><code>&gt;</code>: Greater than or equal to.</p></li><li><p><code>=</code>: Equal to.</p></li><li><p><code>&lt;</code>: Less than or equal to.</p></li><li><p><code>&lt;</code>: Less than.</p></li><li><p><code>&gt;</code>: Greater than.</p></li><li><p><code>is</code>: Compare type, for example, used in <a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-remove-certain-xml-attributes">Remove Specified XML Attributes</a>.</p></li></ul></div></div></td></tr><tr><td><p>6</p></td><td><div><div><ul><li><p><code>!=</code>: Not equal to.</p></li><li><p><code>~=</code>: Contains.</p></li><li><p><code>==</code>: Equality operator that tries to coerce one value to the type of the other when the types are different.</p></li></ul></div></div></td></tr><tr><td><p>7</p></td><td><div><div><ul><li><p><code>and</code>: Logical <code>and</code> operator.</p></li></ul></div></div></td></tr><tr><td><p>8</p></td><td><div><div><ul><li><p><code>or</code>: Logical <code>or</code> operator.</p></li></ul></div></div></td></tr><tr><td><p>9</p></td><td><div><div><ul><li><p><code>default</code>: For setting a default value.</p></li><li><p><code>case</code> and <code>else</code>: For pattern matching.</p></li><li><p>DataWeave functions at this level:</p><div><ul><li><p><code>matches</code></p></li><li><p><code>match</code></p></li><li><p><code>map</code></p></li><li><p><code>mapObject</code></p></li><li><p><code>groupBy</code></p></li><li><p><code>filter</code></p></li></ul></div></li><li><p>Binary DataWeave selectors at this level:</p><div><ul><li><p><code>.@keyName</code> and <code>.*@</code>: Binary DataWeave attribute selectors.</p></li><li><p><code>.*</code>: Multi-value selector.</p></li><li><p><code>.^</code>: Metadata selector.</p></li><li><p><code>.&amp;</code>: Key-value pair selector.</p></li><li><p><code>[?()]</code>: Filter selector.</p></li></ul></div></li><li><p><code>.keyName</code>: Value selector.</p></li><li><p><code>[&lt;index&gt; to &lt;index&gt;]</code>: Range selector</p></li></ul></div></div></td></tr><tr><td><p>10</p></td><td><div><div><ul><li><p><code>if else</code>: Conditional expression used for flow control in DataWeave.</p></li></ul></div></div></td></tr></tbody></table>

## Order of Chained Function Calls

When functions are chained together in a series, the functions are processed in order from the first
to the last function specified in the chain.

For example, the following script acts on the input array of objects defined by the variable
`flights`. The script first calls `filter` to return an array that accepts all `price` values that
are less than 500. Then it calls `orderBy` to return an array that reorders the objects found in the
input from the lowest to the highest `price` value. Finally, it calls `groupBy` to group the input
array of objects alphabetically by `toAirport` value.

DataWeave Script:

```DataWeave
%dw 2.0
output application/json
var flights = [
  { "toAirport": "SFO", "price": 550, "airline": "American" },
  { "toAirport": "MUA", "price": 200, "airline": "American" },
  { "toAirport": "SFO", "price": 300, "airline": "American" },
  { "toAirport": "CLE", "price": 600, "airline": "American" },
  { "toAirport": "CLE", "price": 190, "airline": "American" },
  { "toAirport": "SFO", "price": 400, "airline": "American" }
]
---
flights filter $.price < 500 orderBy $.price groupBy $.toAirport
```

The result is an object that contains a collection of key-value pairs:

Output:

{ "CLE": \[ { "toAirport": "CLE", "price": 190, "airline": "American" } \], "SFO": \[ { "toAirport":
"SFO", "price": 300, "airline": "United" }, { "toAirport": "SFO", "price": 400, "airline":
"American" } \], "MUA": \[ { "toAirport": "MUA", "price": 200, "airline": "American" } \] }

You can force the evaluation order by inserting evaluation parentheses `(` and `)` into the
DataWeave expression. This example returns the same output as the previous example:

DataWeave Script:

```DataWeave
%dw 2.0
output application/json
var flights = [
  { "toAirport": "SFO", "price": 550, "airline": "American" },
  { "toAirport": "MUA", "price": 200, "airline": "American" },
  { "toAirport": "SFO", "price": 300, "airline": "American" },
  { "toAirport": "CLE", "price": 600, "airline": "American" },
  { "toAirport": "CLE", "price": 190, "airline": "American" },
  { "toAirport": "SFO", "price": 400, "airline": "American" }
]
---
( ( ( flights filter $.price < 500 ) orderBy $.price ) groupBy $.toAirport )
```

The result is an object that contains a collection of key-value pairs:

Output:

{ "CLE": \[ { "toAirport": "CLE", "price": 190, "airline": "American" } \], "SFO": \[ { "toAirport":
"SFO", "price": 300, "airline": "United" }, { "toAirport": "SFO", "price": 400, "airline":
"American" } \], "MUA": \[ { "toAirport": "MUA", "price": 200, "airline": "American" } \] }

The order of the function calls is important. For example, the rearranged expression
`flights groupBy $.toAirport filter $.price < 500 orderBy $.price` returns an error because
`groupBy` returns an object, and `filter` expects an array. The resulting error is
`Expecting Type: Array>T<, but got: {String: Array<{|toA…​ airline: String|}>}`.

## See Also

- [Core (dw::Core) functions](https://docs.mulesoft.com/dataweave/2.3/dw-core)

- [DataWeave Operators](https://docs.mulesoft.com/dataweave/2.3/dw-operators)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.3/dataweave-selectors)

- [DataWeave Variables](https://docs.mulesoft.com/dataweave/2.3/dataweave-variables)

- [Flow Control in DataWeave](https://docs.mulesoft.com/dataweave/2.3/dataweave-flow-control)

- [Pattern Matching in DataWeave](https://docs.mulesoft.com/dataweave/2.3/dataweave-pattern-matching)

- [Type Coercion with DataWeave](https://docs.mulesoft.com/dataweave/2.3/dataweave-types-coercion)

<!-- document id=a46153e0aa81bdb1a3a67cab8df283edd43a8b8fe10abaf8f58b42f891b2a81e url=/mulesoft/current/en-us/dataweave/2.4/dataweave-flow-control-precedence.md -->

---
product: DataWeave
version: 2.4
---

# Precedence in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave expressions are compiled in a specific order. The result of a compilation of something at
one level can serve as input for expressions in higher levels, but not at lower levels.

## Order of Compilation

The following table orders operators and functions from first compiled (1) to last compiled (10):

<table><colgroup><col> <col></colgroup><thead><tr><th>Level</th><th>Operator or Function</th></tr></thead><tbody><tr><td><p>1</p></td><td><div><div><ul><li><p><code>using</code>: For initializing local variables in a DataWeave script.</p></li><li><p>Unary DataWeave operators at this level:</p><div><ul><li><p><code>.^</code>: Schema selector.</p></li><li><p><code>.#</code>: Namespace selector.</p></li><li><p><code>..</code>: Descendants selector.</p></li><li><p><code>not</code>: Logical operator for negation.</p></li><li><p><code>.@</code>: All attribute selector, for example, in a case that uses the expression <code>payload.root.a.@</code> to return the attributes and values of the input payload <code>&lt;root&gt; &lt;a attr1="foo" attr2="bar" /&gt;&lt;/root&gt;</code> within the array of objects <code>{ "attr1": "foo", "attr2": "bar" }</code>.</p></li></ul></div></li></ul></div></div></td></tr><tr><td><p>2</p></td><td><div><div><ul><li><p><code>as</code>: Used for type coercion.</p></li></ul></div></div></td></tr><tr><td><p>3</p></td><td><div><div><ul><li><p><code>*</code>: Multiply.</p></li><li><p><code>/</code>: Divide.</p></li></ul></div></div></td></tr><tr><td><p>4</p></td><td><div><div><ul><li><p><code>+</code>: Add.</p></li><li><p><code>-</code>: Subtract.</p></li><li><p><code>&gt;&gt;</code>: Prepend data.</p></li><li><p><code>&lt;&lt;</code>: Append data.</p></li></ul></div></div></td></tr><tr><td><p>5</p></td><td><div><div><ul><li><p><code>&gt;</code>: Greater than or equal to.</p></li><li><p><code>=</code>: Equal to.</p></li><li><p><code>&lt;</code>: Less than or equal to.</p></li><li><p><code>&lt;</code>: Less than.</p></li><li><p><code>&gt;</code>: Greater than.</p></li><li><p><code>is</code>: Compare type, for example, used in <a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-remove-certain-xml-attributes">Remove Specified XML Attributes</a>.</p></li></ul></div></div></td></tr><tr><td><p>6</p></td><td><div><div><ul><li><p><code>!=</code>: Not equal to.</p></li><li><p><code>~=</code>: Contains.</p></li><li><p><code>==</code>: Equality operator that tries to coerce one value to the type of the other when the types are different.</p></li></ul></div></div></td></tr><tr><td><p>7</p></td><td><div><div><ul><li><p><code>and</code>: Logical <code>and</code> operator.</p></li></ul></div></div></td></tr><tr><td><p>8</p></td><td><div><div><ul><li><p><code>or</code>: Logical <code>or</code> operator.</p></li></ul></div></div></td></tr><tr><td><p>9</p></td><td><div><div><ul><li><p><code>default</code>: For setting a default value.</p></li><li><p><code>case</code> and <code>else</code>: For pattern matching.</p></li><li><p>DataWeave functions at this level:</p><div><ul><li><p><code>matches</code></p></li><li><p><code>match</code></p></li><li><p><code>map</code></p></li><li><p><code>mapObject</code></p></li><li><p><code>groupBy</code></p></li><li><p><code>filter</code></p></li></ul></div></li><li><p>Binary DataWeave selectors at this level:</p><div><ul><li><p><code>.@keyName</code> and <code>.*@</code>: Binary DataWeave attribute selectors.</p></li><li><p><code>.*</code>: Multi-value selector.</p></li><li><p><code>.^</code>: Metadata selector.</p></li><li><p><code>.&amp;</code>: Key-value pair selector.</p></li><li><p><code>[?()]</code>: Filter selector.</p></li></ul></div></li><li><p><code>.keyName</code>: Value selector.</p></li><li><p><code>[&lt;index&gt; to &lt;index&gt;]</code>: Range selector</p></li></ul></div></div></td></tr><tr><td><p>10</p></td><td><div><div><ul><li><p><code>if else</code>: Conditional expression used for flow control in DataWeave.</p></li></ul></div></div></td></tr></tbody></table>

## Order of Chained Function Calls

When functions are chained together in a series, the functions are processed in order from the first
to the last function specified in the chain.

For example, the following script acts on the input array of objects defined by the variable
`flights`. The script first calls `filter` to return an array that accepts all `price` values that
are less than 500. Then it calls `orderBy` to return an array that reorders the objects found in the
input from the lowest to the highest `price` value. Finally, it calls `groupBy` to group the input
array of objects alphabetically by `toAirport` value.

DataWeave Script:

```DataWeave
%dw 2.0
output application/json
var flights = [
  { "toAirport": "SFO", "price": 550, "airline": "American" },
  { "toAirport": "MUA", "price": 200, "airline": "American" },
  { "toAirport": "SFO", "price": 300, "airline": "American" },
  { "toAirport": "CLE", "price": 600, "airline": "American" },
  { "toAirport": "CLE", "price": 190, "airline": "American" },
  { "toAirport": "SFO", "price": 400, "airline": "American" }
]
---
flights filter $.price < 500 orderBy $.price groupBy $.toAirport
```

The result is an object that contains a collection of key-value pairs:

Output:

{ "CLE": \[ { "toAirport": "CLE", "price": 190, "airline": "American" } \], "SFO": \[ { "toAirport":
"SFO", "price": 300, "airline": "United" }, { "toAirport": "SFO", "price": 400, "airline":
"American" } \], "MUA": \[ { "toAirport": "MUA", "price": 200, "airline": "American" } \] }

You can force the evaluation order by inserting evaluation parentheses `(` and `)` into the
DataWeave expression. This example returns the same output as the previous example:

DataWeave Script:

```DataWeave
%dw 2.0
output application/json
var flights = [
  { "toAirport": "SFO", "price": 550, "airline": "American" },
  { "toAirport": "MUA", "price": 200, "airline": "American" },
  { "toAirport": "SFO", "price": 300, "airline": "American" },
  { "toAirport": "CLE", "price": 600, "airline": "American" },
  { "toAirport": "CLE", "price": 190, "airline": "American" },
  { "toAirport": "SFO", "price": 400, "airline": "American" }
]
---
( ( ( flights filter $.price < 500 ) orderBy $.price ) groupBy $.toAirport )
```

The result is an object that contains a collection of key-value pairs:

Output:

{ "CLE": \[ { "toAirport": "CLE", "price": 190, "airline": "American" } \], "SFO": \[ { "toAirport":
"SFO", "price": 300, "airline": "United" }, { "toAirport": "SFO", "price": 400, "airline":
"American" } \], "MUA": \[ { "toAirport": "MUA", "price": 200, "airline": "American" } \] }

The order of the function calls is important. For example, the rearranged expression
`flights groupBy $.toAirport filter $.price < 500 orderBy $.price` returns an error because
`groupBy` returns an object, and `filter` expects an array. The resulting error is
`Expecting Type: Array>T<, but got: {String: Array<{|toA…​ airline: String|}>}`.

## See Also

- [Core (dw::Core) functions](https://docs.mulesoft.com/dataweave/2.4/dw-core)

- [DataWeave Operators](https://docs.mulesoft.com/dataweave/2.4/dw-operators)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.4/dataweave-selectors)

- [DataWeave Variables](https://docs.mulesoft.com/dataweave/2.4/dataweave-variables)

- [Flow Control in DataWeave](https://docs.mulesoft.com/dataweave/2.4/dataweave-flow-control)

- [Pattern Matching in DataWeave](https://docs.mulesoft.com/dataweave/2.4/dataweave-pattern-matching)

- [Type Coercion with DataWeave](https://docs.mulesoft.com/dataweave/2.4/dataweave-types-coercion)

<!-- document id=8b1f67244213d50d0012f1895ac001d398126fced4dd0342641405864ccd9fc2 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-flow-control-precedence.md -->

---
product: DataWeave
version: 2.6
---

# Precedence in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave expressions are compiled in a specific order. The result of a compilation of something at
one level can serve as input for expressions in higher levels, but not at lower levels.

## Order of Compilation

The following table orders operators and functions from first compiled (1) to last compiled (10):

<table><colgroup><col> <col></colgroup><thead><tr><th>Level</th><th>Operator or Function</th></tr></thead><tbody><tr><td><p>1</p></td><td><div><div><ul><li><p><code>using</code>: For initializing local variables in a DataWeave script.</p></li><li><p>Unary DataWeave operators at this level:</p><div><ul><li><p><code>.^</code>: Schema selector.</p></li><li><p><code>.#</code>: Namespace selector.</p></li><li><p><code>..</code>: Descendants selector.</p></li><li><p><code>not</code>: Logical operator for negation.</p></li><li><p><code>.@</code>: All attribute selector, for example, in a case that uses the expression <code>payload.root.a.@</code> to return the attributes and values of the input payload <code>&lt;root&gt; &lt;a attr1="foo" attr2="bar" /&gt;&lt;/root&gt;</code> within the array of objects <code>{ "attr1": "foo", "attr2": "bar" }</code>.</p></li></ul></div></li></ul></div></div></td></tr><tr><td><p>2</p></td><td><div><div><ul><li><p><code>as</code>: Used for type coercion.</p></li></ul></div></div></td></tr><tr><td><p>3</p></td><td><div><div><ul><li><p><code>*</code>: Multiply.</p></li><li><p><code>/</code>: Divide.</p></li></ul></div></div></td></tr><tr><td><p>4</p></td><td><div><div><ul><li><p><code>+</code>: Add.</p></li><li><p><code>-</code>: Subtract.</p></li><li><p><code>&gt;&gt;</code>: Prepend data.</p></li><li><p><code>&lt;&lt;</code>: Append data.</p></li></ul></div></div></td></tr><tr><td><p>5</p></td><td><div><div><ul><li><p><code>&gt;</code>: Greater than or equal to.</p></li><li><p><code>=</code>: Equal to.</p></li><li><p><code>&lt;</code>: Less than or equal to.</p></li><li><p><code>&lt;</code>: Less than.</p></li><li><p><code>&gt;</code>: Greater than.</p></li><li><p><code>is</code>: Compare type, for example, used in <a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-remove-certain-xml-attributes">Remove Specified XML Attributes</a>.</p></li></ul></div></div></td></tr><tr><td><p>6</p></td><td><div><div><ul><li><p><code>!=</code>: Not equal to.</p></li><li><p><code>~=</code>: Contains.</p></li><li><p><code>==</code>: Equality operator that tries to coerce one value to the type of the other when the types are different.</p></li></ul></div></div></td></tr><tr><td><p>7</p></td><td><div><div><ul><li><p><code>and</code>: Logical <code>and</code> operator.</p></li></ul></div></div></td></tr><tr><td><p>8</p></td><td><div><div><ul><li><p><code>or</code>: Logical <code>or</code> operator.</p></li></ul></div></div></td></tr><tr><td><p>9</p></td><td><div><div><ul><li><p><code>default</code>: For setting a default value.</p></li><li><p><code>case</code> and <code>else</code>: For pattern matching.</p></li><li><p>DataWeave functions at this level:</p><div><ul><li><p><code>matches</code></p></li><li><p><code>match</code></p></li><li><p><code>map</code></p></li><li><p><code>mapObject</code></p></li><li><p><code>groupBy</code></p></li><li><p><code>filter</code></p></li></ul></div></li><li><p>Binary DataWeave selectors at this level:</p><div><ul><li><p><code>.@keyName</code> and <code>.*@</code>: Binary DataWeave attribute selectors.</p></li><li><p><code>.*</code>: Multi-value selector.</p></li><li><p><code>.^</code>: Metadata selector.</p></li><li><p><code>.&amp;</code>: Key-value pair selector.</p></li><li><p><code>[?()]</code>: Filter selector.</p></li></ul></div></li><li><p><code>.keyName</code>: Value selector.</p></li><li><p><code>[&lt;index&gt; to &lt;index&gt;]</code>: Range selector</p></li></ul></div></div></td></tr><tr><td><p>10</p></td><td><div><div><ul><li><p><code>if else</code>: Conditional expression used for flow control in DataWeave.</p></li></ul></div></div></td></tr></tbody></table>

## Order of Chained Function Calls

When functions are chained together in a series, the functions are processed in order from the first
to the last function specified in the chain.

For example, the following script acts on the input array of objects defined by the variable
`flights`. The script first calls `filter` to return an array that accepts all `price` values that
are less than 500. Then it calls `orderBy` to return an array that reorders the objects found in the
input from the lowest to the highest `price` value. Finally, it calls `groupBy` to group the input
array of objects alphabetically by `toAirport` value.

DataWeave Script:

```DataWeave
%dw 2.0
output application/json
var flights = [
  { "toAirport": "SFO", "price": 550, "airline": "American" },
  { "toAirport": "MUA", "price": 200, "airline": "American" },
  { "toAirport": "SFO", "price": 300, "airline": "American" },
  { "toAirport": "CLE", "price": 600, "airline": "American" },
  { "toAirport": "CLE", "price": 190, "airline": "American" },
  { "toAirport": "SFO", "price": 400, "airline": "American" }
]
---
flights filter $.price < 500 orderBy $.price groupBy $.toAirport
```

The result is an object that contains a collection of key-value pairs:

Output:

{ "CLE": \[ { "toAirport": "CLE", "price": 190, "airline": "American" } \], "SFO": \[ { "toAirport":
"SFO", "price": 300, "airline": "United" }, { "toAirport": "SFO", "price": 400, "airline":
"American" } \], "MUA": \[ { "toAirport": "MUA", "price": 200, "airline": "American" } \] }

You can force the evaluation order by inserting evaluation parentheses `(` and `)` into the
DataWeave expression. This example returns the same output as the previous example:

DataWeave Script:

```DataWeave
%dw 2.0
output application/json
var flights = [
  { "toAirport": "SFO", "price": 550, "airline": "American" },
  { "toAirport": "MUA", "price": 200, "airline": "American" },
  { "toAirport": "SFO", "price": 300, "airline": "American" },
  { "toAirport": "CLE", "price": 600, "airline": "American" },
  { "toAirport": "CLE", "price": 190, "airline": "American" },
  { "toAirport": "SFO", "price": 400, "airline": "American" }
]
---
( ( ( flights filter $.price < 500 ) orderBy $.price ) groupBy $.toAirport )
```

The result is an object that contains a collection of key-value pairs:

Output:

{ "CLE": \[ { "toAirport": "CLE", "price": 190, "airline": "American" } \], "SFO": \[ { "toAirport":
"SFO", "price": 300, "airline": "United" }, { "toAirport": "SFO", "price": 400, "airline":
"American" } \], "MUA": \[ { "toAirport": "MUA", "price": 200, "airline": "American" } \] }

The order of the function calls is important. For example, the rearranged expression
`flights groupBy $.toAirport filter $.price < 500 orderBy $.price` returns an error because
`groupBy` returns an object, and `filter` expects an array. The resulting error is
`Expecting Type: Array>T<, but got: {String: Array<{|toA…​ airline: String|}>}`.

## See Also

- [Core (dw::Core) functions](https://docs.mulesoft.com/dataweave/2.6/dw-core)

- [DataWeave Operators](https://docs.mulesoft.com/dataweave/2.6/dw-operators)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.6/dataweave-selectors)

- [DataWeave Variables](https://docs.mulesoft.com/dataweave/2.6/dataweave-variables)

- [Flow Control in DataWeave](https://docs.mulesoft.com/dataweave/2.6/dataweave-flow-control)

- [Pattern Matching in DataWeave](https://docs.mulesoft.com/dataweave/2.6/dataweave-pattern-matching)

- [Type Coercion with DataWeave](https://docs.mulesoft.com/dataweave/2.6/dataweave-types-coercion)

<!-- document id=de1a90fea53681b1322b6e116535e308cb5d0504cd8923ca258db54da9dde5d3 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-flow-control-precedence.md -->

---
product: DataWeave
version: 2.9
---

# Precedence in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave expressions are compiled in a specific order. The result of a compilation of something at
one level can serve as input for expressions in higher levels, but not at lower levels.

## Order of Compilation

The following table orders operators and functions from first compiled (1) to last compiled (10):

<table><colgroup><col> <col></colgroup><thead><tr><th>Level</th><th>Operator or Function</th></tr></thead><tbody><tr><td><p>1</p></td><td><div><div><ul><li><p><code>using</code>: For initializing local variables in a DataWeave script.</p></li><li><p>Unary DataWeave operators at this level:</p><div><ul><li><p><code>.^</code>: Schema selector.</p></li><li><p><code>.#</code>: Namespace selector.</p></li><li><p><code>..</code>: Descendants selector.</p></li><li><p><code>not</code>: Logical operator for negation.</p></li><li><p><code>.@</code>: All attribute selector, for example, in a case that uses the expression <code>payload.root.a.@</code> to return the attributes and values of the input payload <code>&lt;root&gt; &lt;a attr1="foo" attr2="bar" /&gt;&lt;/root&gt;</code> within the array of objects <code>{ "attr1": "foo", "attr2": "bar" }</code>.</p></li></ul></div></li></ul></div></div></td></tr><tr><td><p>2</p></td><td><div><div><ul><li><p><code>as</code>: Used for type coercion.</p></li></ul></div></div></td></tr><tr><td><p>3</p></td><td><div><div><ul><li><p><code>*</code>: Multiply.</p></li><li><p><code>/</code>: Divide.</p></li></ul></div></div></td></tr><tr><td><p>4</p></td><td><div><div><ul><li><p><code>+</code>: Add.</p></li><li><p><code>-</code>: Subtract.</p></li><li><p><code>&gt;&gt;</code>: Prepend data.</p></li><li><p><code>&lt;&lt;</code>: Append data.</p></li></ul></div></div></td></tr><tr><td><p>5</p></td><td><div><div><ul><li><p><code>&gt;</code>: Greater than or equal to.</p></li><li><p><code>=</code>: Equal to.</p></li><li><p><code>&lt;</code>: Less than or equal to.</p></li><li><p><code>&lt;</code>: Less than.</p></li><li><p><code>&gt;</code>: Greater than.</p></li><li><p><code>is</code>: Compare type, for example, used in <a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-remove-certain-xml-attributes">Remove Specified XML Attributes</a>.</p></li></ul></div></div></td></tr><tr><td><p>6</p></td><td><div><div><ul><li><p><code>!=</code>: Not equal to.</p></li><li><p><code>~=</code>: Contains.</p></li><li><p><code>==</code>: Equality operator that tries to coerce one value to the type of the other when the types are different.</p></li></ul></div></div></td></tr><tr><td><p>7</p></td><td><div><div><ul><li><p><code>and</code>: Logical <code>and</code> operator.</p></li></ul></div></div></td></tr><tr><td><p>8</p></td><td><div><div><ul><li><p><code>or</code>: Logical <code>or</code> operator.</p></li></ul></div></div></td></tr><tr><td><p>9</p></td><td><div><div><ul><li><p><code>default</code>: For setting a default value.</p></li><li><p><code>case</code> and <code>else</code>: For pattern matching.</p></li><li><p>DataWeave functions at this level:</p><div><ul><li><p><code>matches</code></p></li><li><p><code>match</code></p></li><li><p><code>map</code></p></li><li><p><code>mapObject</code></p></li><li><p><code>groupBy</code></p></li><li><p><code>filter</code></p></li></ul></div></li><li><p>Binary DataWeave selectors at this level:</p><div><ul><li><p><code>.@keyName</code> and <code>.*@</code>: Binary DataWeave attribute selectors.</p></li><li><p><code>.*</code>: Multi-value selector.</p></li><li><p><code>.^</code>: Metadata selector.</p></li><li><p><code>.&amp;</code>: Key-value pair selector.</p></li><li><p><code>[?()]</code>: Filter selector.</p></li></ul></div></li><li><p><code>.keyName</code>: Value selector.</p></li><li><p><code>[&lt;index&gt; to &lt;index&gt;]</code>: Range selector</p></li></ul></div></div></td></tr><tr><td><p>10</p></td><td><div><div><ul><li><p><code>if else</code>: Conditional expression used for flow control in DataWeave.</p></li></ul></div></div></td></tr></tbody></table>

## Order of Chained Function Calls

When functions are chained together in a series, the functions are processed in order from the first
to the last function specified in the chain.

For example, the following script acts on the input array of objects defined by the variable
`flights`. The script first calls `filter` to return an array that accepts all `price` values that
are less than 500. Then it calls `orderBy` to return an array that reorders the objects found in the
input from the lowest to the highest `price` value. Finally, it calls `groupBy` to group the input
array of objects alphabetically by `toAirport` value.

DataWeave Script:

```DataWeave
%dw 2.0
output application/json
var flights = [
  { "toAirport": "SFO", "price": 550, "airline": "American" },
  { "toAirport": "MUA", "price": 200, "airline": "American" },
  { "toAirport": "SFO", "price": 300, "airline": "American" },
  { "toAirport": "CLE", "price": 600, "airline": "American" },
  { "toAirport": "CLE", "price": 190, "airline": "American" },
  { "toAirport": "SFO", "price": 400, "airline": "American" }
]
---
flights filter $.price < 500 orderBy $.price groupBy $.toAirport
```

The result is an object that contains a collection of key-value pairs:

Output:

{ "CLE": \[ { "toAirport": "CLE", "price": 190, "airline": "American" } \], "SFO": \[ { "toAirport":
"SFO", "price": 300, "airline": "United" }, { "toAirport": "SFO", "price": 400, "airline":
"American" } \], "MUA": \[ { "toAirport": "MUA", "price": 200, "airline": "American" } \] }

You can force the evaluation order by inserting evaluation parentheses `(` and `)` into the
DataWeave expression. This example returns the same output as the previous example:

DataWeave Script:

```DataWeave
%dw 2.0
output application/json
var flights = [
  { "toAirport": "SFO", "price": 550, "airline": "American" },
  { "toAirport": "MUA", "price": 200, "airline": "American" },
  { "toAirport": "SFO", "price": 300, "airline": "American" },
  { "toAirport": "CLE", "price": 600, "airline": "American" },
  { "toAirport": "CLE", "price": 190, "airline": "American" },
  { "toAirport": "SFO", "price": 400, "airline": "American" }
]
---
( ( ( flights filter $.price < 500 ) orderBy $.price ) groupBy $.toAirport )
```

The result is an object that contains a collection of key-value pairs:

Output:

{ "CLE": \[ { "toAirport": "CLE", "price": 190, "airline": "American" } \], "SFO": \[ { "toAirport":
"SFO", "price": 300, "airline": "United" }, { "toAirport": "SFO", "price": 400, "airline":
"American" } \], "MUA": \[ { "toAirport": "MUA", "price": 200, "airline": "American" } \] }

The order of the function calls is important. For example, the rearranged expression
`flights groupBy $.toAirport filter $.price < 500 orderBy $.price` returns an error because
`groupBy` returns an object, and `filter` expects an array. The resulting error is
`Expecting Type: Array>T<, but got: {String: Array<{|toA…​ airline: String|}>}`.

## See Also

- [Core (dw::Core) functions](https://docs.mulesoft.com/dataweave/2.9/dw-core)

- [DataWeave Operators](https://docs.mulesoft.com/dataweave/2.9/dw-operators)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.9/dataweave-selectors)

- [DataWeave Variables](https://docs.mulesoft.com/dataweave/2.9/dataweave-variables)

- [Flow Control in DataWeave](https://docs.mulesoft.com/dataweave/2.9/dataweave-flow-control)

- [Pattern Matching in DataWeave](https://docs.mulesoft.com/dataweave/2.9/dataweave-pattern-matching)

- [Type Coercion with DataWeave](https://docs.mulesoft.com/dataweave/2.9/dataweave-types-coercion)

<!-- document id=5caea5451e1f3feb37989db8090cc141e95e1e938c0d7443962ee0684abcf003 url=/mulesoft/current/en-us/dataweave/latest/dataweave-flow-control-precedence.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Precedence in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave expressions are compiled in a specific order. The result of a compilation of something at
one level can serve as input for expressions in higher levels, but not at lower levels.

## Order of Compilation

The following table orders operators and functions from first compiled (1) to last compiled (10):

<table><colgroup><col> <col></colgroup><thead><tr><th>Level</th><th>Operator or Function</th></tr></thead><tbody><tr><td><p>1</p></td><td><div><div><ul><li><p><code>using</code>: For initializing local variables in a DataWeave script.</p></li><li><p>Unary DataWeave operators at this level:</p><div><ul><li><p><code>.^</code>: Schema selector.</p></li><li><p><code>.#</code>: Namespace selector.</p></li><li><p><code>..</code>: Descendants selector.</p></li><li><p><code>not</code>: Logical operator for negation.</p></li><li><p><code>.@</code>: All attribute selector, for example, in a case that uses the expression <code>payload.root.a.@</code> to return the attributes and values of the input payload <code>&lt;root&gt; &lt;a attr1="foo" attr2="bar" /&gt;&lt;/root&gt;</code> within the array of objects <code>{ "attr1": "foo", "attr2": "bar" }</code>.</p></li></ul></div></li></ul></div></div></td></tr><tr><td><p>2</p></td><td><div><div><ul><li><p><code>as</code>: Used for type coercion.</p></li></ul></div></div></td></tr><tr><td><p>3</p></td><td><div><div><ul><li><p><code>*</code>: Multiply.</p></li><li><p><code>/</code>: Divide.</p></li></ul></div></div></td></tr><tr><td><p>4</p></td><td><div><div><ul><li><p><code>+</code>: Add.</p></li><li><p><code>-</code>: Subtract.</p></li><li><p><code>&gt;&gt;</code>: Prepend data.</p></li><li><p><code>&lt;&lt;</code>: Append data.</p></li></ul></div></div></td></tr><tr><td><p>5</p></td><td><div><div><ul><li><p><code>&gt;</code>: Greater than or equal to.</p></li><li><p><code>=</code>: Equal to.</p></li><li><p><code>&lt;</code>: Less than or equal to.</p></li><li><p><code>&lt;</code>: Less than.</p></li><li><p><code>&gt;</code>: Greater than.</p></li><li><p><code>is</code>: Compare type, for example, used in <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-remove-certain-xml-attributes">Remove Specified XML Attributes</a>.</p></li></ul></div></div></td></tr><tr><td><p>6</p></td><td><div><div><ul><li><p><code>!=</code>: Not equal to.</p></li><li><p><code>~=</code>: Contains.</p></li><li><p><code>==</code>: Equality operator that tries to coerce one value to the type of the other when the types are different.</p></li></ul></div></div></td></tr><tr><td><p>7</p></td><td><div><div><ul><li><p><code>and</code>: Logical <code>and</code> operator.</p></li></ul></div></div></td></tr><tr><td><p>8</p></td><td><div><div><ul><li><p><code>or</code>: Logical <code>or</code> operator.</p></li></ul></div></div></td></tr><tr><td><p>9</p></td><td><div><div><ul><li><p><code>default</code>: For setting a default value.</p></li><li><p><code>case</code> and <code>else</code>: For pattern matching.</p></li><li><p>DataWeave functions at this level:</p><div><ul><li><p><code>matches</code></p></li><li><p><code>match</code></p></li><li><p><code>map</code></p></li><li><p><code>mapObject</code></p></li><li><p><code>groupBy</code></p></li><li><p><code>filter</code></p></li></ul></div></li><li><p>Binary DataWeave selectors at this level:</p><div><ul><li><p><code>.@keyName</code> and <code>.*@</code>: Binary DataWeave attribute selectors.</p></li><li><p><code>.*</code>: Multi-value selector.</p></li><li><p><code>.^</code>: Metadata selector.</p></li><li><p><code>.&amp;</code>: Key-value pair selector.</p></li><li><p><code>[?()]</code>: Filter selector.</p></li></ul></div></li><li><p><code>.keyName</code>: Value selector.</p></li><li><p><code>[&lt;index&gt; to &lt;index&gt;]</code>: Range selector</p></li></ul></div></div></td></tr><tr><td><p>10</p></td><td><div><div><ul><li><p><code>if else</code>: Conditional expression used for flow control in DataWeave.</p></li></ul></div></div></td></tr></tbody></table>

## Order of Chained Function Calls

When functions are chained together in a series, the functions are processed in order from the first
to the last function specified in the chain.

For example, the following script acts on the input array of objects defined by the variable
`flights`. The script first calls `filter` to return an array that accepts all `price` values that
are less than 500. Then it calls `orderBy` to return an array that reorders the objects found in the
input from the lowest to the highest `price` value. Finally, it calls `groupBy` to group the input
array of objects alphabetically by `toAirport` value.

DataWeave Script:

```DataWeave
%dw 2.0
output application/json
var flights = [
  { "toAirport": "SFO", "price": 550, "airline": "American" },
  { "toAirport": "MUA", "price": 200, "airline": "American" },
  { "toAirport": "SFO", "price": 300, "airline": "American" },
  { "toAirport": "CLE", "price": 600, "airline": "American" },
  { "toAirport": "CLE", "price": 190, "airline": "American" },
  { "toAirport": "SFO", "price": 400, "airline": "American" }
]
---
flights filter $.price < 500 orderBy $.price groupBy $.toAirport
```

The result is an object that contains a collection of key-value pairs:

Output:

{ "CLE": \[ { "toAirport": "CLE", "price": 190, "airline": "American" } \], "SFO": \[ { "toAirport":
"SFO", "price": 300, "airline": "United" }, { "toAirport": "SFO", "price": 400, "airline":
"American" } \], "MUA": \[ { "toAirport": "MUA", "price": 200, "airline": "American" } \] }

You can force the evaluation order by inserting evaluation parentheses `(` and `)` into the
DataWeave expression. This example returns the same output as the previous example:

DataWeave Script:

```DataWeave
%dw 2.0
output application/json
var flights = [
  { "toAirport": "SFO", "price": 550, "airline": "American" },
  { "toAirport": "MUA", "price": 200, "airline": "American" },
  { "toAirport": "SFO", "price": 300, "airline": "American" },
  { "toAirport": "CLE", "price": 600, "airline": "American" },
  { "toAirport": "CLE", "price": 190, "airline": "American" },
  { "toAirport": "SFO", "price": 400, "airline": "American" }
]
---
( ( ( flights filter $.price < 500 ) orderBy $.price ) groupBy $.toAirport )
```

The result is an object that contains a collection of key-value pairs:

Output:

{ "CLE": \[ { "toAirport": "CLE", "price": 190, "airline": "American" } \], "SFO": \[ { "toAirport":
"SFO", "price": 300, "airline": "United" }, { "toAirport": "SFO", "price": 400, "airline":
"American" } \], "MUA": \[ { "toAirport": "MUA", "price": 200, "airline": "American" } \] }

The order of the function calls is important. For example, the rearranged expression
`flights groupBy $.toAirport filter $.price < 500 orderBy $.price` returns an error because
`groupBy` returns an object, and `filter` expects an array. The resulting error is
`Expecting Type: Array>T<, but got: {String: Array<{|toA…​ airline: String|}>}`.

## See Also

- [Core (dw::Core) functions](https://docs.mulesoft.com/dataweave/latest/dw-core)

- [DataWeave Operators](https://docs.mulesoft.com/dataweave/latest/dw-operators)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors)

- [DataWeave Variables](https://docs.mulesoft.com/dataweave/latest/dataweave-variables)

- [Flow Control in DataWeave](https://docs.mulesoft.com/dataweave/latest/dataweave-flow-control)

- [Pattern Matching in DataWeave](https://docs.mulesoft.com/dataweave/latest/dataweave-pattern-matching)

- [Type Coercion with DataWeave](https://docs.mulesoft.com/dataweave/latest/dataweave-types-coercion)

<!-- document id=840b2d2ae7036d3d9d200e4cff0da8388991e92e3426eeff851bdebf2277c7b3 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-variables-context.md -->

---
product: DataWeave
version: 2.11
---

# Predefined Variables

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave expressions accept variables that can retrieve values from a variety of Mule Runtime
engine objects.

Commonly used variables include `attributes`, `payload`, and `vars`, the main parts of the Mule
event.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Variables</th><th>Description</th><th>Fields and Examples</th></tr></thead><tbody><tr><td><p><strong><code>app</code></strong></p></td><td><p>The Mule artifact in context.</p></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>encoding</code>: Encoding used by the Mule message processor.</p></li><li><p><code>name</code>: Name of your project and Mule app.</p></li><li><p><code>standalone</code>: Returns <code>true</code> or <code>false</code>.</p></li><li><p><code>workDir</code>: Working directory for the Mule app. For Studio, this is an Eclipse plugin directory.</p></li><li><p><code>registry</code>: Map of Mule registry entries.</p></li></ul></div></li><li><p>Example: <code>#[app.encoding]</code> might return <code>UTF-8</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>attributes</code></strong></p></td><td><p>Attributes (metadata) of a Mule Message object (<code>message</code>).</p></td><td><div><div><ul><li><p>Fields: Depends on the message type, such as HTTP request attributes.</p></li><li><p>Example: <code>#[attributes]</code> returns message attributes. For an HTTP request, <code>#[attributes.header]</code> returns HTTP header metadata, and <code>#[attributes.version]</code> might return <code>HTTP/1.1</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>authentication</code></strong></p></td><td><p>Provides access to the authentication information.</p></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>principal</code>: The main part of the authentication, such as the user or subject.</p></li><li><p><code>credentials</code>: The credentials for the authentication.</p></li><li><p><code>properties</code>: A map of properties for the authentication.</p></li></ul></div></li><li><p>Example: <code>#[authentication.principal]</code></p></li></ul></div></div></td></tr><tr><td><p><strong><code>correlationId</code></strong></p></td><td><p>The <code>correlationId</code> of the message being processed.</p></td><td><div><div><ul><li><p>Fields: No fields.</p></li><li><p>Example: <code>#[correlationId]</code> might return <code>0-f77404d0-e699-11e7-a217-38c9864c2f8f</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>dataType</code></strong></p></td><td><p>Data type of the message payload.</p></td><td><div><div><ul><li><p>Fields: No fields.</p></li><li><p>Example: <code>#[dataType]</code> might return <code>SimpleDataType</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>error</code></strong></p></td><td><p>Error associated with a Mule message object.</p></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>description</code>: Concise description of the error.</p></li><li><p><code>detailedDescription</code>: Can provide a more thorough description.</p></li><li><p><code>failingComponent</code>: The component where the error occurred.</p></li><li><p><code>errorType</code>: The type of error. The <code>errorType</code> is composed of <code>identifier</code> and <code>namespace</code>.</p></li><li><p><code>cause</code>: The internal Java <code>Throwable</code> that caused the error.</p></li><li><p><code>errorMessage</code>: An optional Mule Message provided by the failing component (used by components like HTTP when a response is invalid).</p></li><li><p><code>childErrors</code>: An optional list of internal errors (provided by components that aggregate errors, such as scatter-gather).</p></li></ul></div></li><li><p>Example: <code>#[error.description]</code></p></li></ul></div></div></td></tr><tr><td><p><strong><code>flow</code></strong></p></td><td><p>Deprecated: The name of the current flow. Because flow names are static, this field is deprecated and only available through the Logger component.</p></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>name</code></p></li></ul></div></li><li><p>Example: <code>#[flow.name]</code> returns <code>testFlow</code> in the Studio console when executed within a Flow with the name <code>testFlow</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>message</code></strong></p></td><td><p>Package (<code>payload</code> and <code>attributes</code>) being processed.</p></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>payload</code>: The message payload, or <code>null</code> if the payload is null.</p></li><li><p><code>dataType</code>: The message payload’s data type.</p></li><li><p><code>attributes</code>: The message attributes, or <code>null</code> if the attributes are null.</p></li></ul></div></li><li><p>Example: <code>#[message]</code></p></li></ul></div></div></td></tr><tr><td><p><strong><code>mule</code></strong></p></td><td><p>The Mule instance on which the application is currently running.</p></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>clusterId</code>: The ID of the cluster when the Mule runtime is part of a High Availability cluster.</p></li><li><p><code>home</code>: Home directory.</p></li><li><p><code>nodeId</code>: Cluster Node ID.</p></li><li><p><code>version</code>: Mule version.</p></li></ul></div></li><li><p>Example: <code>#[mule.version]</code> might return <code>4.0.0</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>payload</code></strong></p></td><td><p>The body of the current Mule message object (<code>message</code>) being processed.</p></td><td><div><div><ul><li><p>Fields: Depends on the current payload.</p></li><li><p>Example: <code>#[payload]</code> returns the body of the message.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>server</code></strong></p></td><td><div><div><p>The operating system on which the Mule instance is running. Exposes information about both the physical server and the JVM on which Mule runs.</p></div><div><ul><li><p>Note that the ability to select system properties, like <code>user.name</code>, depends on the behavior of the JVM on your operating system.</p></li></ul></div></div></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>env</code>: Map of operating system environment variables.</p></li><li><p><code>fileSeparator</code>: Character that separates components of a file path, which is <code>/</code> on UNIX and <code>\</code> on Windows.</p></li><li><p><code>host</code>: Fully qualified domain name for the server.</p></li><li><p><code>ip</code>: IP address of the server.</p></li><li><p><code>locale</code>: Default locale (<code>java.util.Locale</code>) of the JRE. Can be used language (<code>locale.language</code>), country (<code>locale.country</code>).</p></li><li><p><code>javaVendor</code>: JRE vendor name</p></li><li><p><code>javaVersion</code>: JRE version</p></li><li><p><code>osArch</code>: Operating system architecture.</p></li><li><p><code>osName</code>: Operating system name.</p></li><li><p><code>osVersion</code>: Operating system version.</p></li><li><p><code>systemProperties</code>: Map of Java system properties.</p></li><li><p><code>timeZone</code>: Default time zone (<code>java.util.TimeZone</code>) of the JRE.</p></li><li><p><code>tmpDir</code>: Temporary directory for use by the JRE.</p></li><li><p><code>userDir</code>: User directory.</p></li><li><p><code>userHome</code>: User home directory.</p></li><li><p><code>userName</code>: User name.</p></li></ul></div></li><li><p>Example: <code>#[server.osName]</code> might return <code>Mac OS X</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>vars</code></strong></p></td><td><p>All variables currently set on the current Mule event being processed.</p></td><td><div><div><ul><li><p>Fields: No fields.</p></li><li><p>Example: <code>#[vars.myVar]</code> returns the value of <code>myVar</code>.</p></li></ul></div></div></td></tr></tbody></table>

<!-- document id=92b843bb14d400b5b9fb1e57ee7e0e0369dfd585e80c00d5666be53ee107cc82 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-variables-context.md -->

---
product: DataWeave
version: 2.12
---

# Predefined Variables

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave expressions accept variables that can retrieve values from a variety of Mule Runtime
engine objects.

Commonly used variables include `attributes`, `payload`, and `vars`, the main parts of the Mule
event.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Variables</th><th>Description</th><th>Fields and Examples</th></tr></thead><tbody><tr><td><p><strong><code>app</code></strong></p></td><td><p>The Mule artifact in context.</p></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>encoding</code>: Encoding used by the Mule message processor.</p></li><li><p><code>name</code>: Name of your project and Mule app.</p></li><li><p><code>standalone</code>: Returns <code>true</code> or <code>false</code>.</p></li><li><p><code>workDir</code>: Working directory for the Mule app. For Studio, this is an Eclipse plugin directory.</p></li><li><p><code>registry</code>: Map of Mule registry entries.</p></li></ul></div></li><li><p>Example: <code>#[app.encoding]</code> might return <code>UTF-8</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>attributes</code></strong></p></td><td><p>Attributes (metadata) of a Mule Message object (<code>message</code>).</p></td><td><div><div><ul><li><p>Fields: Depends on the message type, such as HTTP request attributes.</p></li><li><p>Example: <code>#[attributes]</code> returns message attributes. For an HTTP request, <code>#[attributes.header]</code> returns HTTP header metadata, and <code>#[attributes.version]</code> might return <code>HTTP/1.1</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>authentication</code></strong></p></td><td><p>Provides access to the authentication information.</p></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>principal</code>: The main part of the authentication, such as the user or subject.</p></li><li><p><code>credentials</code>: The credentials for the authentication.</p></li><li><p><code>properties</code>: A map of properties for the authentication.</p></li></ul></div></li><li><p>Example: <code>#[authentication.principal]</code></p></li></ul></div></div></td></tr><tr><td><p><strong><code>correlationId</code></strong></p></td><td><p>The <code>correlationId</code> of the message being processed.</p></td><td><div><div><ul><li><p>Fields: No fields.</p></li><li><p>Example: <code>#[correlationId]</code> might return <code>0-f77404d0-e699-11e7-a217-38c9864c2f8f</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>dataType</code></strong></p></td><td><p>Data type of the message payload.</p></td><td><div><div><ul><li><p>Fields: No fields.</p></li><li><p>Example: <code>#[dataType]</code> might return <code>SimpleDataType</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>error</code></strong></p></td><td><p>Error associated with a Mule message object.</p></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>description</code>: Concise description of the error.</p></li><li><p><code>detailedDescription</code>: Can provide a more thorough description.</p></li><li><p><code>failingComponent</code>: The component where the error occurred.</p></li><li><p><code>errorType</code>: The type of error. The <code>errorType</code> is composed of <code>identifier</code> and <code>namespace</code>.</p></li><li><p><code>cause</code>: The internal Java <code>Throwable</code> that caused the error.</p></li><li><p><code>errorMessage</code>: An optional Mule Message provided by the failing component (used by components like HTTP when a response is invalid).</p></li><li><p><code>childErrors</code>: An optional list of internal errors (provided by components that aggregate errors, such as scatter-gather).</p></li></ul></div></li><li><p>Example: <code>#[error.description]</code></p></li></ul></div></div></td></tr><tr><td><p><strong><code>flow</code></strong></p></td><td><p>Deprecated: The name of the current flow. Because flow names are static, this field is deprecated and only available through the Logger component.</p></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>name</code></p></li></ul></div></li><li><p>Example: <code>#[flow.name]</code> returns <code>testFlow</code> in the Studio console when executed within a Flow with the name <code>testFlow</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>message</code></strong></p></td><td><p>Package (<code>payload</code> and <code>attributes</code>) being processed.</p></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>payload</code>: The message payload, or <code>null</code> if the payload is null.</p></li><li><p><code>dataType</code>: The message payload’s data type.</p></li><li><p><code>attributes</code>: The message attributes, or <code>null</code> if the attributes are null.</p></li></ul></div></li><li><p>Example: <code>#[message]</code></p></li></ul></div></div></td></tr><tr><td><p><strong><code>mule</code></strong></p></td><td><p>The Mule instance on which the application is currently running.</p></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>clusterId</code>: The ID of the cluster when the Mule runtime is part of a High Availability cluster.</p></li><li><p><code>home</code>: Home directory.</p></li><li><p><code>nodeId</code>: Cluster Node ID.</p></li><li><p><code>version</code>: Mule version.</p></li></ul></div></li><li><p>Example: <code>#[mule.version]</code> might return <code>4.0.0</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>payload</code></strong></p></td><td><p>The body of the current Mule message object (<code>message</code>) being processed.</p></td><td><div><div><ul><li><p>Fields: Depends on the current payload.</p></li><li><p>Example: <code>#[payload]</code> returns the body of the message.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>server</code></strong></p></td><td><div><div><p>The operating system on which the Mule instance is running. Exposes information about both the physical server and the JVM on which Mule runs.</p></div><div><ul><li><p>Note that the ability to select system properties, like <code>user.name</code>, depends on the behavior of the JVM on your operating system.</p></li></ul></div></div></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>env</code>: Map of operating system environment variables.</p></li><li><p><code>fileSeparator</code>: Character that separates components of a file path, which is <code>/</code> on UNIX and <code>\</code> on Windows.</p></li><li><p><code>host</code>: Fully qualified domain name for the server.</p></li><li><p><code>ip</code>: IP address of the server.</p></li><li><p><code>locale</code>: Default locale (<code>java.util.Locale</code>) of the JRE. Can be used language (<code>locale.language</code>), country (<code>locale.country</code>).</p></li><li><p><code>javaVendor</code>: JRE vendor name</p></li><li><p><code>javaVersion</code>: JRE version</p></li><li><p><code>osArch</code>: Operating system architecture.</p></li><li><p><code>osName</code>: Operating system name.</p></li><li><p><code>osVersion</code>: Operating system version.</p></li><li><p><code>systemProperties</code>: Map of Java system properties.</p></li><li><p><code>timeZone</code>: Default time zone (<code>java.util.TimeZone</code>) of the JRE.</p></li><li><p><code>tmpDir</code>: Temporary directory for use by the JRE.</p></li><li><p><code>userDir</code>: User directory.</p></li><li><p><code>userHome</code>: User home directory.</p></li><li><p><code>userName</code>: User name.</p></li></ul></div></li><li><p>Example: <code>#[server.osName]</code> might return <code>Mac OS X</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>vars</code></strong></p></td><td><p>All variables currently set on the current Mule event being processed.</p></td><td><div><div><ul><li><p>Fields: No fields.</p></li><li><p>Example: <code>#[vars.myVar]</code> returns the value of <code>myVar</code>.</p></li></ul></div></div></td></tr></tbody></table>

<!-- document id=0e13334d488ec9d703d59e5f435b76dc7f69a508d00dd64785d65856aadb7dad url=/mulesoft/current/en-us/dataweave/2.3/dataweave-variables-context.md -->

---
product: DataWeave
version: 2.3
---

# Predefined Variables

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave expressions accept variables that can retrieve values from a variety of Mule Runtime
engine objects.

Commonly used variables include `attributes`, `payload`, and `vars`, the main parts of the Mule
event.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Variables</th><th>Description</th><th>Fields and Examples</th></tr></thead><tbody><tr><td><p><strong><code>app</code></strong></p></td><td><p>The Mule artifact in context.</p></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>encoding</code>: Encoding used by the Mule message processor.</p></li><li><p><code>name</code>: Name of your project and Mule app.</p></li><li><p><code>standalone</code>: Returns <code>true</code> or <code>false</code>.</p></li><li><p><code>workDir</code>: Working directory for the Mule app. For Studio, this is an Eclipse plugin directory.</p></li><li><p><code>registry</code>: Map of Mule registry entries.</p></li></ul></div></li><li><p>Example: <code>#[app.encoding]</code> might return <code>UTF-8</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>attributes</code></strong></p></td><td><p>Attributes (metadata) of a Mule Message object (<code>message</code>).</p></td><td><div><div><ul><li><p>Fields: Depends on the message type, such as HTTP request attributes.</p></li><li><p>Example: <code>#[attributes]</code> returns message attributes. For an HTTP request, <code>#[attributes.header]</code> returns HTTP header metadata, and <code>#[attributes.version]</code> might return <code>HTTP/1.1</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>authentication</code></strong></p></td><td><p>Provides access to the authentication information.</p></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>principal</code>: The main part of the authentication, such as the user or subject.</p></li><li><p><code>credentials</code>: The credentials for the authentication.</p></li><li><p><code>properties</code>: A map of properties for the authentication.</p></li></ul></div></li><li><p>Example: <code>#[authentication.principal]</code></p></li></ul></div></div></td></tr><tr><td><p><strong><code>correlationId</code></strong></p></td><td><p>The <code>correlationId</code> of the message being processed.</p></td><td><div><div><ul><li><p>Fields: No fields.</p></li><li><p>Example: <code>#[correlationId]</code> might return <code>0-f77404d0-e699-11e7-a217-38c9864c2f8f</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>dataType</code></strong></p></td><td><p>Data type of the message payload.</p></td><td><div><div><ul><li><p>Fields: No fields.</p></li><li><p>Example: <code>#[dataType]</code> might return <code>SimpleDataType</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>error</code></strong></p></td><td><p>Error associated with a Mule message object.</p></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>description</code>: Concise description of the error.</p></li><li><p><code>detailedDescription</code>: Can provide a more thorough description.</p></li><li><p><code>errorType</code>: The type of error.</p></li><li><p><code>cause</code>: The internal Java <code>Throwable</code> that caused the error.</p></li><li><p><code>errorMessage</code>: An optional Mule Message provided by the failing component (used by components like HTTP when a response is invalid).</p></li><li><p><code>childErrors</code>: An optional list of internal errors (provided by components that aggregate errors, such as scatter-gather).</p></li></ul></div></li><li><p>Example: <code>#[error.description]</code></p></li></ul></div></div></td></tr><tr><td><p><strong><code>flow</code></strong></p></td><td><p>Deprecated: The name of the current flow. Because flow names are static, this field is deprecated and only available through the Logger component.</p></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>name</code></p></li></ul></div></li><li><p>Example: <code>#[flow.name]</code> returns <code>testFlow</code> in the Studio console when executed within a Flow with the name <code>testFlow</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>message</code></strong></p></td><td><p>Package (<code>payload</code> and <code>attributes</code>) being processed.</p></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>payload</code>: The message payload, or <code>null</code> if the payload is null.</p></li><li><p><code>dataType</code>: The message payload’s data type.</p></li><li><p><code>attributes</code>: The message attributes, or <code>null</code> if the attributes are null.</p></li></ul></div></li><li><p>Example: <code>#[message]</code></p></li></ul></div></div></td></tr><tr><td><p><strong><code>mule</code></strong></p></td><td><p>The Mule instance on which the application is currently running.</p></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>clusterId</code>: The ID of the cluster when the Mule runtime is part of a High Availability cluster.</p></li><li><p><code>home</code>: Home directory.</p></li><li><p><code>nodeId</code>: Cluster Node ID.</p></li><li><p><code>version</code>: Mule version.</p></li></ul></div></li><li><p>Example: <code>#[mule.version]</code> might return <code>4.0.0</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>payload</code></strong></p></td><td><p>The body of the current Mule message object (<code>message</code>) being processed.</p></td><td><div><div><ul><li><p>Fields: Depends on the current payload.</p></li><li><p>Example: <code>#[payload]</code> returns the body of the message.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>server</code></strong></p></td><td><div><div><p>The operating system on which the Mule instance is running. Exposes information about both the physical server and the JVM on which Mule runs.</p></div><div><ul><li><p>Note that the ability to select system properties, like <code>user.name</code>, depends on the behavior of the JVM on your operating system.</p></li></ul></div></div></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>env</code>: Map of operating system environment variables.</p></li><li><p><code>fileSeparator</code>: Character that separates components of a file path, which is <code>/</code> on UNIX and <code>\</code> on Windows.</p></li><li><p><code>host</code>: Fully qualified domain name for the server.</p></li><li><p><code>ip</code>: IP address of the server.</p></li><li><p><code>locale</code>: Default locale (<code>java.util.Locale</code>) of the JRE. Can be used language (<code>locale.language</code>), country (<code>locale.country</code>).</p></li><li><p><code>javaVendor</code>: JRE vendor name</p></li><li><p><code>javaVersion</code>: JRE version</p></li><li><p><code>osArch</code>: Operating system architecture.</p></li><li><p><code>osName</code>: Operating system name.</p></li><li><p><code>osVersion</code>: Operating system version.</p></li><li><p><code>systemProperties</code>: Map of Java system properties.</p></li><li><p><code>timeZone</code>: Default time zone (<code>java.util.TimeZone</code>) of the JRE.</p></li><li><p><code>tmpDir</code>: Temporary directory for use by the JRE.</p></li><li><p><code>userDir</code>: User directory.</p></li><li><p><code>userHome</code>: User home directory.</p></li><li><p><code>userName</code>: User name.</p></li></ul></div></li><li><p>Example: <code>#[server.osName]</code> might return <code>Mac OS X</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>vars</code></strong></p></td><td><p>All variables currently set on the current Mule event being processed.</p></td><td><div><div><ul><li><p>Fields: No fields.</p></li><li><p>Example: <code>#[vars.myVar]</code> returns the value of <code>myVar</code>.</p></li></ul></div></div></td></tr></tbody></table>

<!-- document id=921432c7dbe980e779a83df151ee3d971584b11bf8fba4f8bc602f35b52e966f url=/mulesoft/current/en-us/dataweave/2.4/dataweave-variables-context.md -->

---
product: DataWeave
version: 2.4
---

# Predefined Variables

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave expressions accept variables that can retrieve values from a variety of Mule Runtime
engine objects.

Commonly used variables include `attributes`, `payload`, and `vars`, the main parts of the Mule
event.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Variables</th><th>Description</th><th>Fields and Examples</th></tr></thead><tbody><tr><td><p><strong><code>app</code></strong></p></td><td><p>The Mule artifact in context.</p></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>encoding</code>: Encoding used by the Mule message processor.</p></li><li><p><code>name</code>: Name of your project and Mule app.</p></li><li><p><code>standalone</code>: Returns <code>true</code> or <code>false</code>.</p></li><li><p><code>workDir</code>: Working directory for the Mule app. For Studio, this is an Eclipse plugin directory.</p></li><li><p><code>registry</code>: Map of Mule registry entries.</p></li></ul></div></li><li><p>Example: <code>#[app.encoding]</code> might return <code>UTF-8</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>attributes</code></strong></p></td><td><p>Attributes (metadata) of a Mule Message object (<code>message</code>).</p></td><td><div><div><ul><li><p>Fields: Depends on the message type, such as HTTP request attributes.</p></li><li><p>Example: <code>#[attributes]</code> returns message attributes. For an HTTP request, <code>#[attributes.header]</code> returns HTTP header metadata, and <code>#[attributes.version]</code> might return <code>HTTP/1.1</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>authentication</code></strong></p></td><td><p>Provides access to the authentication information.</p></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>principal</code>: The main part of the authentication, such as the user or subject.</p></li><li><p><code>credentials</code>: The credentials for the authentication.</p></li><li><p><code>properties</code>: A map of properties for the authentication.</p></li></ul></div></li><li><p>Example: <code>#[authentication.principal]</code></p></li></ul></div></div></td></tr><tr><td><p><strong><code>correlationId</code></strong></p></td><td><p>The <code>correlationId</code> of the message being processed.</p></td><td><div><div><ul><li><p>Fields: No fields.</p></li><li><p>Example: <code>#[correlationId]</code> might return <code>0-f77404d0-e699-11e7-a217-38c9864c2f8f</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>dataType</code></strong></p></td><td><p>Data type of the message payload.</p></td><td><div><div><ul><li><p>Fields: No fields.</p></li><li><p>Example: <code>#[dataType]</code> might return <code>SimpleDataType</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>error</code></strong></p></td><td><p>Error associated with a Mule message object.</p></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>description</code>: Concise description of the error.</p></li><li><p><code>detailedDescription</code>: Can provide a more thorough description.</p></li><li><p><code>failingComponent</code>: The component where the error occurred.</p></li><li><p><code>errorType</code>: The type of error. The <code>errorType</code> is composed of <code>identifier</code> and <code>namespace</code>.</p></li><li><p><code>cause</code>: The internal Java <code>Throwable</code> that caused the error.</p></li><li><p><code>errorMessage</code>: An optional Mule Message provided by the failing component (used by components like HTTP when a response is invalid).</p></li><li><p><code>childErrors</code>: An optional list of internal errors (provided by components that aggregate errors, such as scatter-gather).</p></li></ul></div></li><li><p>Example: <code>#[error.description]</code></p></li></ul></div></div></td></tr><tr><td><p><strong><code>flow</code></strong></p></td><td><p>Deprecated: The name of the current flow. Because flow names are static, this field is deprecated and only available through the Logger component.</p></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>name</code></p></li></ul></div></li><li><p>Example: <code>#[flow.name]</code> returns <code>testFlow</code> in the Studio console when executed within a Flow with the name <code>testFlow</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>message</code></strong></p></td><td><p>Package (<code>payload</code> and <code>attributes</code>) being processed.</p></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>payload</code>: The message payload, or <code>null</code> if the payload is null.</p></li><li><p><code>dataType</code>: The message payload’s data type.</p></li><li><p><code>attributes</code>: The message attributes, or <code>null</code> if the attributes are null.</p></li></ul></div></li><li><p>Example: <code>#[message]</code></p></li></ul></div></div></td></tr><tr><td><p><strong><code>mule</code></strong></p></td><td><p>The Mule instance on which the application is currently running.</p></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>clusterId</code>: The ID of the cluster when the Mule runtime is part of a High Availability cluster.</p></li><li><p><code>home</code>: Home directory.</p></li><li><p><code>nodeId</code>: Cluster Node ID.</p></li><li><p><code>version</code>: Mule version.</p></li></ul></div></li><li><p>Example: <code>#[mule.version]</code> might return <code>4.0.0</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>payload</code></strong></p></td><td><p>The body of the current Mule message object (<code>message</code>) being processed.</p></td><td><div><div><ul><li><p>Fields: Depends on the current payload.</p></li><li><p>Example: <code>#[payload]</code> returns the body of the message.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>server</code></strong></p></td><td><div><div><p>The operating system on which the Mule instance is running. Exposes information about both the physical server and the JVM on which Mule runs.</p></div><div><ul><li><p>Note that the ability to select system properties, like <code>user.name</code>, depends on the behavior of the JVM on your operating system.</p></li></ul></div></div></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>env</code>: Map of operating system environment variables.</p></li><li><p><code>fileSeparator</code>: Character that separates components of a file path, which is <code>/</code> on UNIX and <code>\</code> on Windows.</p></li><li><p><code>host</code>: Fully qualified domain name for the server.</p></li><li><p><code>ip</code>: IP address of the server.</p></li><li><p><code>locale</code>: Default locale (<code>java.util.Locale</code>) of the JRE. Can be used language (<code>locale.language</code>), country (<code>locale.country</code>).</p></li><li><p><code>javaVendor</code>: JRE vendor name</p></li><li><p><code>javaVersion</code>: JRE version</p></li><li><p><code>osArch</code>: Operating system architecture.</p></li><li><p><code>osName</code>: Operating system name.</p></li><li><p><code>osVersion</code>: Operating system version.</p></li><li><p><code>systemProperties</code>: Map of Java system properties.</p></li><li><p><code>timeZone</code>: Default time zone (<code>java.util.TimeZone</code>) of the JRE.</p></li><li><p><code>tmpDir</code>: Temporary directory for use by the JRE.</p></li><li><p><code>userDir</code>: User directory.</p></li><li><p><code>userHome</code>: User home directory.</p></li><li><p><code>userName</code>: User name.</p></li></ul></div></li><li><p>Example: <code>#[server.osName]</code> might return <code>Mac OS X</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>vars</code></strong></p></td><td><p>All variables currently set on the current Mule event being processed.</p></td><td><div><div><ul><li><p>Fields: No fields.</p></li><li><p>Example: <code>#[vars.myVar]</code> returns the value of <code>myVar</code>.</p></li></ul></div></div></td></tr></tbody></table>

<!-- document id=cb5542c146637e076c5936a6dd102ae512b1cc411c51892ca95815666d54d940 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-variables-context.md -->

---
product: DataWeave
version: 2.6
---

# Predefined Variables

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave expressions accept variables that can retrieve values from a variety of Mule Runtime
engine objects.

Commonly used variables include `attributes`, `payload`, and `vars`, the main parts of the Mule
event.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Variables</th><th>Description</th><th>Fields and Examples</th></tr></thead><tbody><tr><td><p><strong><code>app</code></strong></p></td><td><p>The Mule artifact in context.</p></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>encoding</code>: Encoding used by the Mule message processor.</p></li><li><p><code>name</code>: Name of your project and Mule app.</p></li><li><p><code>standalone</code>: Returns <code>true</code> or <code>false</code>.</p></li><li><p><code>workDir</code>: Working directory for the Mule app. For Studio, this is an Eclipse plugin directory.</p></li><li><p><code>registry</code>: Map of Mule registry entries.</p></li></ul></div></li><li><p>Example: <code>#[app.encoding]</code> might return <code>UTF-8</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>attributes</code></strong></p></td><td><p>Attributes (metadata) of a Mule Message object (<code>message</code>).</p></td><td><div><div><ul><li><p>Fields: Depends on the message type, such as HTTP request attributes.</p></li><li><p>Example: <code>#[attributes]</code> returns message attributes. For an HTTP request, <code>#[attributes.header]</code> returns HTTP header metadata, and <code>#[attributes.version]</code> might return <code>HTTP/1.1</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>authentication</code></strong></p></td><td><p>Provides access to the authentication information.</p></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>principal</code>: The main part of the authentication, such as the user or subject.</p></li><li><p><code>credentials</code>: The credentials for the authentication.</p></li><li><p><code>properties</code>: A map of properties for the authentication.</p></li></ul></div></li><li><p>Example: <code>#[authentication.principal]</code></p></li></ul></div></div></td></tr><tr><td><p><strong><code>correlationId</code></strong></p></td><td><p>The <code>correlationId</code> of the message being processed.</p></td><td><div><div><ul><li><p>Fields: No fields.</p></li><li><p>Example: <code>#[correlationId]</code> might return <code>0-f77404d0-e699-11e7-a217-38c9864c2f8f</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>dataType</code></strong></p></td><td><p>Data type of the message payload.</p></td><td><div><div><ul><li><p>Fields: No fields.</p></li><li><p>Example: <code>#[dataType]</code> might return <code>SimpleDataType</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>error</code></strong></p></td><td><p>Error associated with a Mule message object.</p></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>description</code>: Concise description of the error.</p></li><li><p><code>detailedDescription</code>: Can provide a more thorough description.</p></li><li><p><code>failingComponent</code>: The component where the error occurred.</p></li><li><p><code>errorType</code>: The type of error. The <code>errorType</code> is composed of <code>identifier</code> and <code>namespace</code>.</p></li><li><p><code>cause</code>: The internal Java <code>Throwable</code> that caused the error.</p></li><li><p><code>errorMessage</code>: An optional Mule Message provided by the failing component (used by components like HTTP when a response is invalid).</p></li><li><p><code>childErrors</code>: An optional list of internal errors (provided by components that aggregate errors, such as scatter-gather).</p></li></ul></div></li><li><p>Example: <code>#[error.description]</code></p></li></ul></div></div></td></tr><tr><td><p><strong><code>flow</code></strong></p></td><td><p>Deprecated: The name of the current flow. Because flow names are static, this field is deprecated and only available through the Logger component.</p></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>name</code></p></li></ul></div></li><li><p>Example: <code>#[flow.name]</code> returns <code>testFlow</code> in the Studio console when executed within a Flow with the name <code>testFlow</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>message</code></strong></p></td><td><p>Package (<code>payload</code> and <code>attributes</code>) being processed.</p></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>payload</code>: The message payload, or <code>null</code> if the payload is null.</p></li><li><p><code>dataType</code>: The message payload’s data type.</p></li><li><p><code>attributes</code>: The message attributes, or <code>null</code> if the attributes are null.</p></li></ul></div></li><li><p>Example: <code>#[message]</code></p></li></ul></div></div></td></tr><tr><td><p><strong><code>mule</code></strong></p></td><td><p>The Mule instance on which the application is currently running.</p></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>clusterId</code>: The ID of the cluster when the Mule runtime is part of a High Availability cluster.</p></li><li><p><code>home</code>: Home directory.</p></li><li><p><code>nodeId</code>: Cluster Node ID.</p></li><li><p><code>version</code>: Mule version.</p></li></ul></div></li><li><p>Example: <code>#[mule.version]</code> might return <code>4.0.0</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>payload</code></strong></p></td><td><p>The body of the current Mule message object (<code>message</code>) being processed.</p></td><td><div><div><ul><li><p>Fields: Depends on the current payload.</p></li><li><p>Example: <code>#[payload]</code> returns the body of the message.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>server</code></strong></p></td><td><div><div><p>The operating system on which the Mule instance is running. Exposes information about both the physical server and the JVM on which Mule runs.</p></div><div><ul><li><p>Note that the ability to select system properties, like <code>user.name</code>, depends on the behavior of the JVM on your operating system.</p></li></ul></div></div></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>env</code>: Map of operating system environment variables.</p></li><li><p><code>fileSeparator</code>: Character that separates components of a file path, which is <code>/</code> on UNIX and <code>\</code> on Windows.</p></li><li><p><code>host</code>: Fully qualified domain name for the server.</p></li><li><p><code>ip</code>: IP address of the server.</p></li><li><p><code>locale</code>: Default locale (<code>java.util.Locale</code>) of the JRE. Can be used language (<code>locale.language</code>), country (<code>locale.country</code>).</p></li><li><p><code>javaVendor</code>: JRE vendor name</p></li><li><p><code>javaVersion</code>: JRE version</p></li><li><p><code>osArch</code>: Operating system architecture.</p></li><li><p><code>osName</code>: Operating system name.</p></li><li><p><code>osVersion</code>: Operating system version.</p></li><li><p><code>systemProperties</code>: Map of Java system properties.</p></li><li><p><code>timeZone</code>: Default time zone (<code>java.util.TimeZone</code>) of the JRE.</p></li><li><p><code>tmpDir</code>: Temporary directory for use by the JRE.</p></li><li><p><code>userDir</code>: User directory.</p></li><li><p><code>userHome</code>: User home directory.</p></li><li><p><code>userName</code>: User name.</p></li></ul></div></li><li><p>Example: <code>#[server.osName]</code> might return <code>Mac OS X</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>vars</code></strong></p></td><td><p>All variables currently set on the current Mule event being processed.</p></td><td><div><div><ul><li><p>Fields: No fields.</p></li><li><p>Example: <code>#[vars.myVar]</code> returns the value of <code>myVar</code>.</p></li></ul></div></div></td></tr></tbody></table>

<!-- document id=0abea7ec4d0692a8f20a7f15400cebe8139fe66873440bac8fa358116c5cef8f url=/mulesoft/current/en-us/dataweave/2.9/dataweave-variables-context.md -->

---
product: DataWeave
version: 2.9
---

# Predefined Variables

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave expressions accept variables that can retrieve values from a variety of Mule Runtime
engine objects.

Commonly used variables include `attributes`, `payload`, and `vars`, the main parts of the Mule
event.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Variables</th><th>Description</th><th>Fields and Examples</th></tr></thead><tbody><tr><td><p><strong><code>app</code></strong></p></td><td><p>The Mule artifact in context.</p></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>encoding</code>: Encoding used by the Mule message processor.</p></li><li><p><code>name</code>: Name of your project and Mule app.</p></li><li><p><code>standalone</code>: Returns <code>true</code> or <code>false</code>.</p></li><li><p><code>workDir</code>: Working directory for the Mule app. For Studio, this is an Eclipse plugin directory.</p></li><li><p><code>registry</code>: Map of Mule registry entries.</p></li></ul></div></li><li><p>Example: <code>#[app.encoding]</code> might return <code>UTF-8</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>attributes</code></strong></p></td><td><p>Attributes (metadata) of a Mule Message object (<code>message</code>).</p></td><td><div><div><ul><li><p>Fields: Depends on the message type, such as HTTP request attributes.</p></li><li><p>Example: <code>#[attributes]</code> returns message attributes. For an HTTP request, <code>#[attributes.header]</code> returns HTTP header metadata, and <code>#[attributes.version]</code> might return <code>HTTP/1.1</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>authentication</code></strong></p></td><td><p>Provides access to the authentication information.</p></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>principal</code>: The main part of the authentication, such as the user or subject.</p></li><li><p><code>credentials</code>: The credentials for the authentication.</p></li><li><p><code>properties</code>: A map of properties for the authentication.</p></li></ul></div></li><li><p>Example: <code>#[authentication.principal]</code></p></li></ul></div></div></td></tr><tr><td><p><strong><code>correlationId</code></strong></p></td><td><p>The <code>correlationId</code> of the message being processed.</p></td><td><div><div><ul><li><p>Fields: No fields.</p></li><li><p>Example: <code>#[correlationId]</code> might return <code>0-f77404d0-e699-11e7-a217-38c9864c2f8f</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>dataType</code></strong></p></td><td><p>Data type of the message payload.</p></td><td><div><div><ul><li><p>Fields: No fields.</p></li><li><p>Example: <code>#[dataType]</code> might return <code>SimpleDataType</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>error</code></strong></p></td><td><p>Error associated with a Mule message object.</p></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>description</code>: Concise description of the error.</p></li><li><p><code>detailedDescription</code>: Can provide a more thorough description.</p></li><li><p><code>failingComponent</code>: The component where the error occurred.</p></li><li><p><code>errorType</code>: The type of error. The <code>errorType</code> is composed of <code>identifier</code> and <code>namespace</code>.</p></li><li><p><code>cause</code>: The internal Java <code>Throwable</code> that caused the error.</p></li><li><p><code>errorMessage</code>: An optional Mule Message provided by the failing component (used by components like HTTP when a response is invalid).</p></li><li><p><code>childErrors</code>: An optional list of internal errors (provided by components that aggregate errors, such as scatter-gather).</p></li></ul></div></li><li><p>Example: <code>#[error.description]</code></p></li></ul></div></div></td></tr><tr><td><p><strong><code>flow</code></strong></p></td><td><p>Deprecated: The name of the current flow. Because flow names are static, this field is deprecated and only available through the Logger component.</p></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>name</code></p></li></ul></div></li><li><p>Example: <code>#[flow.name]</code> returns <code>testFlow</code> in the Studio console when executed within a Flow with the name <code>testFlow</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>message</code></strong></p></td><td><p>Package (<code>payload</code> and <code>attributes</code>) being processed.</p></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>payload</code>: The message payload, or <code>null</code> if the payload is null.</p></li><li><p><code>dataType</code>: The message payload’s data type.</p></li><li><p><code>attributes</code>: The message attributes, or <code>null</code> if the attributes are null.</p></li></ul></div></li><li><p>Example: <code>#[message]</code></p></li></ul></div></div></td></tr><tr><td><p><strong><code>mule</code></strong></p></td><td><p>The Mule instance on which the application is currently running.</p></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>clusterId</code>: The ID of the cluster when the Mule runtime is part of a High Availability cluster.</p></li><li><p><code>home</code>: Home directory.</p></li><li><p><code>nodeId</code>: Cluster Node ID.</p></li><li><p><code>version</code>: Mule version.</p></li></ul></div></li><li><p>Example: <code>#[mule.version]</code> might return <code>4.0.0</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>payload</code></strong></p></td><td><p>The body of the current Mule message object (<code>message</code>) being processed.</p></td><td><div><div><ul><li><p>Fields: Depends on the current payload.</p></li><li><p>Example: <code>#[payload]</code> returns the body of the message.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>server</code></strong></p></td><td><div><div><p>The operating system on which the Mule instance is running. Exposes information about both the physical server and the JVM on which Mule runs.</p></div><div><ul><li><p>Note that the ability to select system properties, like <code>user.name</code>, depends on the behavior of the JVM on your operating system.</p></li></ul></div></div></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>env</code>: Map of operating system environment variables.</p></li><li><p><code>fileSeparator</code>: Character that separates components of a file path, which is <code>/</code> on UNIX and <code>\</code> on Windows.</p></li><li><p><code>host</code>: Fully qualified domain name for the server.</p></li><li><p><code>ip</code>: IP address of the server.</p></li><li><p><code>locale</code>: Default locale (<code>java.util.Locale</code>) of the JRE. Can be used language (<code>locale.language</code>), country (<code>locale.country</code>).</p></li><li><p><code>javaVendor</code>: JRE vendor name</p></li><li><p><code>javaVersion</code>: JRE version</p></li><li><p><code>osArch</code>: Operating system architecture.</p></li><li><p><code>osName</code>: Operating system name.</p></li><li><p><code>osVersion</code>: Operating system version.</p></li><li><p><code>systemProperties</code>: Map of Java system properties.</p></li><li><p><code>timeZone</code>: Default time zone (<code>java.util.TimeZone</code>) of the JRE.</p></li><li><p><code>tmpDir</code>: Temporary directory for use by the JRE.</p></li><li><p><code>userDir</code>: User directory.</p></li><li><p><code>userHome</code>: User home directory.</p></li><li><p><code>userName</code>: User name.</p></li></ul></div></li><li><p>Example: <code>#[server.osName]</code> might return <code>Mac OS X</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>vars</code></strong></p></td><td><p>All variables currently set on the current Mule event being processed.</p></td><td><div><div><ul><li><p>Fields: No fields.</p></li><li><p>Example: <code>#[vars.myVar]</code> returns the value of <code>myVar</code>.</p></li></ul></div></div></td></tr></tbody></table>

<!-- document id=d2d7eaad5329e97ce0755697c5cc4e144754ef2d051f3c54084f848345c77e26 url=/mulesoft/current/en-us/dataweave/latest/dataweave-variables-context.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Predefined Variables

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave expressions accept variables that can retrieve values from a variety of Mule Runtime
engine objects.

Commonly used variables include `attributes`, `payload`, and `vars`, the main parts of the Mule
event.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Variables</th><th>Description</th><th>Fields and Examples</th></tr></thead><tbody><tr><td><p><strong><code>app</code></strong></p></td><td><p>The Mule artifact in context.</p></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>encoding</code>: Encoding used by the Mule message processor.</p></li><li><p><code>name</code>: Name of your project and Mule app.</p></li><li><p><code>standalone</code>: Returns <code>true</code> or <code>false</code>.</p></li><li><p><code>workDir</code>: Working directory for the Mule app. For Studio, this is an Eclipse plugin directory.</p></li><li><p><code>registry</code>: Map of Mule registry entries.</p></li></ul></div></li><li><p>Example: <code>#[app.encoding]</code> might return <code>UTF-8</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>attributes</code></strong></p></td><td><p>Attributes (metadata) of a Mule Message object (<code>message</code>).</p></td><td><div><div><ul><li><p>Fields: Depends on the message type, such as HTTP request attributes.</p></li><li><p>Example: <code>#[attributes]</code> returns message attributes. For an HTTP request, <code>#[attributes.header]</code> returns HTTP header metadata, and <code>#[attributes.version]</code> might return <code>HTTP/1.1</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>authentication</code></strong></p></td><td><p>Provides access to the authentication information.</p></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>principal</code>: The main part of the authentication, such as the user or subject.</p></li><li><p><code>credentials</code>: The credentials for the authentication.</p></li><li><p><code>properties</code>: A map of properties for the authentication.</p></li></ul></div></li><li><p>Example: <code>#[authentication.principal]</code></p></li></ul></div></div></td></tr><tr><td><p><strong><code>correlationId</code></strong></p></td><td><p>The <code>correlationId</code> of the message being processed.</p></td><td><div><div><ul><li><p>Fields: No fields.</p></li><li><p>Example: <code>#[correlationId]</code> might return <code>0-f77404d0-e699-11e7-a217-38c9864c2f8f</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>dataType</code></strong></p></td><td><p>Data type of the message payload.</p></td><td><div><div><ul><li><p>Fields: No fields.</p></li><li><p>Example: <code>#[dataType]</code> might return <code>SimpleDataType</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>error</code></strong></p></td><td><p>Error associated with a Mule message object.</p></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>description</code>: Concise description of the error.</p></li><li><p><code>detailedDescription</code>: Can provide a more thorough description.</p></li><li><p><code>failingComponent</code>: The component where the error occurred.</p></li><li><p><code>errorType</code>: The type of error. The <code>errorType</code> is composed of <code>identifier</code> and <code>namespace</code>.</p></li><li><p><code>cause</code>: The internal Java <code>Throwable</code> that caused the error.</p></li><li><p><code>errorMessage</code>: An optional Mule Message provided by the failing component (used by components like HTTP when a response is invalid).</p></li><li><p><code>childErrors</code>: An optional list of internal errors (provided by components that aggregate errors, such as scatter-gather).</p></li></ul></div></li><li><p>Example: <code>#[error.description]</code></p></li></ul></div></div></td></tr><tr><td><p><strong><code>flow</code></strong></p></td><td><p>Deprecated: The name of the current flow. Because flow names are static, this field is deprecated and only available through the Logger component.</p></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>name</code></p></li></ul></div></li><li><p>Example: <code>#[flow.name]</code> returns <code>testFlow</code> in the Studio console when executed within a Flow with the name <code>testFlow</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>message</code></strong></p></td><td><p>Package (<code>payload</code> and <code>attributes</code>) being processed.</p></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>payload</code>: The message payload, or <code>null</code> if the payload is null.</p></li><li><p><code>dataType</code>: The message payload’s data type.</p></li><li><p><code>attributes</code>: The message attributes, or <code>null</code> if the attributes are null.</p></li></ul></div></li><li><p>Example: <code>#[message]</code></p></li></ul></div></div></td></tr><tr><td><p><strong><code>mule</code></strong></p></td><td><p>The Mule instance on which the application is currently running.</p></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>clusterId</code>: The ID of the cluster when the Mule runtime is part of a High Availability cluster.</p></li><li><p><code>home</code>: Home directory.</p></li><li><p><code>nodeId</code>: Cluster Node ID.</p></li><li><p><code>version</code>: Mule version.</p></li></ul></div></li><li><p>Example: <code>#[mule.version]</code> might return <code>4.0.0</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>payload</code></strong></p></td><td><p>The body of the current Mule message object (<code>message</code>) being processed.</p></td><td><div><div><ul><li><p>Fields: Depends on the current payload.</p></li><li><p>Example: <code>#[payload]</code> returns the body of the message.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>server</code></strong></p></td><td><div><div><p>The operating system on which the Mule instance is running. Exposes information about both the physical server and the JVM on which Mule runs.</p></div><div><ul><li><p>Note that the ability to select system properties, like <code>user.name</code>, depends on the behavior of the JVM on your operating system.</p></li></ul></div></div></td><td><div><div><ul><li><p>Fields:</p><div><ul><li><p><code>env</code>: Map of operating system environment variables.</p></li><li><p><code>fileSeparator</code>: Character that separates components of a file path, which is <code>/</code> on UNIX and <code>\</code> on Windows.</p></li><li><p><code>host</code>: Fully qualified domain name for the server.</p></li><li><p><code>ip</code>: IP address of the server.</p></li><li><p><code>locale</code>: Default locale (<code>java.util.Locale</code>) of the JRE. Can be used language (<code>locale.language</code>), country (<code>locale.country</code>).</p></li><li><p><code>javaVendor</code>: JRE vendor name</p></li><li><p><code>javaVersion</code>: JRE version</p></li><li><p><code>osArch</code>: Operating system architecture.</p></li><li><p><code>osName</code>: Operating system name.</p></li><li><p><code>osVersion</code>: Operating system version.</p></li><li><p><code>systemProperties</code>: Map of Java system properties.</p></li><li><p><code>timeZone</code>: Default time zone (<code>java.util.TimeZone</code>) of the JRE.</p></li><li><p><code>tmpDir</code>: Temporary directory for use by the JRE.</p></li><li><p><code>userDir</code>: User directory.</p></li><li><p><code>userHome</code>: User home directory.</p></li><li><p><code>userName</code>: User name.</p></li></ul></div></li><li><p>Example: <code>#[server.osName]</code> might return <code>Mac OS X</code>.</p></li></ul></div></div></td></tr><tr><td><p><strong><code>vars</code></strong></p></td><td><p>All variables currently set on the current Mule event being processed.</p></td><td><div><div><ul><li><p>Fields: No fields.</p></li><li><p>Example: <code>#[vars.myVar]</code> returns the value of <code>myVar</code>.</p></li></ul></div></div></td></tr></tbody></table>

<!-- document id=046c4d6307df9d40b343d0d40121bb047c284f8e59601e243eaa41ec7b34cd64 url=/mulesoft/current/en-us/dataweave/2.11/dw-strings-functions-prependifmissing.md -->

---
product: DataWeave
version: 2.11
---

# prependIfMissing

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## prependIfMissing(text: String, prefix: String): String

Prepends the `prefix` to the beginning of the string if the `text` does not already start with that
prefix.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>prefix</code></p></td><td><p>The text to use as prefix.</p></td></tr></tbody></table>

### Example

This example shows how `prependIfMissing` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import prependIfMissing from dw::core::Strings
output application/json
---
{
  "a": prependIfMissing(null, ""),
  "b": prependIfMissing("abc", ""),
  "c": prependIfMissing("", "xyz"),
  "d": prependIfMissing("abc", "xyz"),
  "e": prependIfMissing("xyzabc", "xyz")
}
```

#### Output

```JSON
{
  "a": null,
  "b": "abc",
  "c": "xyz",
  "d": "xyzabc",
  "e": "xyzabc"
}
```

## prependIfMissing(text: Null, prefix: String): Null

Helper function that enables `prependIfMissing` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=e58cbf108389908909efe9c1990a1acc4ccb56462b6df6f52501f1df70b7397e url=/mulesoft/current/en-us/dataweave/2.12/dw-strings-functions-prependifmissing.md -->

---
product: DataWeave
version: 2.12
---

# prependIfMissing

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## prependIfMissing(text: String, prefix: String): String

Prepends the `prefix` to the beginning of the string if the `text` does not already start with that
prefix.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>prefix</code></p></td><td><p>The text to use as prefix.</p></td></tr></tbody></table>

### Example

This example shows how `prependIfMissing` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import prependIfMissing from dw::core::Strings
output application/json
---
{
  "a": prependIfMissing(null, ""),
  "b": prependIfMissing("abc", ""),
  "c": prependIfMissing("", "xyz"),
  "d": prependIfMissing("abc", "xyz"),
  "e": prependIfMissing("xyzabc", "xyz")
}
```

#### Output

```JSON
{
  "a": null,
  "b": "abc",
  "c": "xyz",
  "d": "xyzabc",
  "e": "xyzabc"
}
```

## prependIfMissing(text: Null, prefix: String): Null

Helper function that enables `prependIfMissing` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=ca677950f264dfac9d7a3d3d22120fe1346a1679cf1990473e9ef659c1a58b39 url=/mulesoft/current/en-us/dataweave/2.3/dw-strings-functions-prependifmissing.md -->

---
product: DataWeave
version: 2.3
---

# prependIfMissing

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## prependIfMissing(String, String): String

Prepends the `prefix` to the beginning of the string if the `text` does not already start with that
prefix.

_Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>prefix</code></p></td><td><p>The text to use as prefix.</p></td></tr></tbody></table>

### Example

This example shows how `prependIfMissing` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import prependIfMissing from dw::core::Strings
output application/json
---
{
  "a": prependIfMissing(null, ""),
  "b": prependIfMissing("abc", ""),
  "c": prependIfMissing("", "xyz"),
  "d": prependIfMissing("abc", "xyz"),
  "e": prependIfMissing("xyzabc", "xyz")
}
```

#### Output

```JSON
{
  "a": null,
  "b": "abc",
  "c": "xyz",
  "d": "xyzabc",
  "e": "xyzabc"
}
```

## prependIfMissing(Null, String): Null

Helper function that enables `prependIfMissing` to work with a `null` value.

<!-- document id=c54be810538e00fca72ee51a1d0edadeb9be440a98ff9a7a48da83e4d88284e5 url=/mulesoft/current/en-us/dataweave/2.4/dw-strings-functions-prependifmissing.md -->

---
product: DataWeave
version: 2.4
---

# prependIfMissing

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## prependIfMissing(text: String, prefix: String): String

Prepends the `prefix` to the beginning of the string if the `text` does not already start with that
prefix.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>prefix</code></p></td><td><p>The text to use as prefix.</p></td></tr></tbody></table>

### Example

This example shows how `prependIfMissing` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import prependIfMissing from dw::core::Strings
output application/json
---
{
  "a": prependIfMissing(null, ""),
  "b": prependIfMissing("abc", ""),
  "c": prependIfMissing("", "xyz"),
  "d": prependIfMissing("abc", "xyz"),
  "e": prependIfMissing("xyzabc", "xyz")
}
```

#### Output

```JSON
{
  "a": null,
  "b": "abc",
  "c": "xyz",
  "d": "xyzabc",
  "e": "xyzabc"
}
```

## prependIfMissing(text: Null, prefix: String): Null

Helper function that enables `prependIfMissing` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=4c40f00ef3a2005273adbff2c43593a63c3d75ad71e0059b8fd55a37eba34095 url=/mulesoft/current/en-us/dataweave/2.6/dw-strings-functions-prependifmissing.md -->

---
product: DataWeave
version: 2.6
---

# prependIfMissing

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## prependIfMissing(text: String, prefix: String): String

Prepends the `prefix` to the beginning of the string if the `text` does not already start with that
prefix.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>prefix</code></p></td><td><p>The text to use as prefix.</p></td></tr></tbody></table>

### Example

This example shows how `prependIfMissing` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import prependIfMissing from dw::core::Strings
output application/json
---
{
  "a": prependIfMissing(null, ""),
  "b": prependIfMissing("abc", ""),
  "c": prependIfMissing("", "xyz"),
  "d": prependIfMissing("abc", "xyz"),
  "e": prependIfMissing("xyzabc", "xyz")
}
```

#### Output

```JSON
{
  "a": null,
  "b": "abc",
  "c": "xyz",
  "d": "xyzabc",
  "e": "xyzabc"
}
```

## prependIfMissing(text: Null, prefix: String): Null

Helper function that enables `prependIfMissing` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=3ba0b7056cdf4bdbcd4b5c8fcfdcae492ad84db8520c1573771034e5a7f9ef61 url=/mulesoft/current/en-us/dataweave/2.9/dw-strings-functions-prependifmissing.md -->

---
product: DataWeave
version: 2.9
---

# prependIfMissing

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## prependIfMissing(text: String, prefix: String): String

Prepends the `prefix` to the beginning of the string if the `text` does not already start with that
prefix.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>prefix</code></p></td><td><p>The text to use as prefix.</p></td></tr></tbody></table>

### Example

This example shows how `prependIfMissing` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import prependIfMissing from dw::core::Strings
output application/json
---
{
  "a": prependIfMissing(null, ""),
  "b": prependIfMissing("abc", ""),
  "c": prependIfMissing("", "xyz"),
  "d": prependIfMissing("abc", "xyz"),
  "e": prependIfMissing("xyzabc", "xyz")
}
```

#### Output

```JSON
{
  "a": null,
  "b": "abc",
  "c": "xyz",
  "d": "xyzabc",
  "e": "xyzabc"
}
```

## prependIfMissing(text: Null, prefix: String): Null

Helper function that enables `prependIfMissing` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=ba780d60ac25cdbcbcba2df2a0c6740e46d69a3b411a0f65d9dcebc4c1bb30b1 url=/mulesoft/current/en-us/dataweave/latest/dw-strings-functions-prependifmissing.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# prependIfMissing

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## prependIfMissing(text: String, prefix: String): String

Prepends the `prefix` to the beginning of the string if the `text` does not already start with that
prefix.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>prefix</code></p></td><td><p>The text to use as prefix.</p></td></tr></tbody></table>

### Example

This example shows how `prependIfMissing` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import prependIfMissing from dw::core::Strings
output application/json
---
{
  "a": prependIfMissing(null, ""),
  "b": prependIfMissing("abc", ""),
  "c": prependIfMissing("", "xyz"),
  "d": prependIfMissing("abc", "xyz"),
  "e": prependIfMissing("xyzabc", "xyz")
}
```

#### Output

```JSON
{
  "a": null,
  "b": "abc",
  "c": "xyz",
  "d": "xyzabc",
  "e": "xyzabc"
}
```

## prependIfMissing(text: Null, prefix: String): Null

Helper function that enables `prependIfMissing` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=2c23d00ba7738eeb9bd01871539c67ebe6cad4a8e6233fc5fdd30e984710964e url=/mulesoft/current/en-us/dataweave/2.11/dw-runtime-functions-prop.md -->

---
product: DataWeave
version: 2.11
---

# prop

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## prop(propertyName: String): String | Null

Returns the value of the property with the specified name or `null` if the property is not defined.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>propertyName</code></p></td><td><p>The property to retrieve.</p></td></tr></tbody></table>

### Example

This example gets the `user.timezone` property.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
output application/dw
---
{ "props" : prop("user.timezone") }
```

#### Output

```JSON
{ props: "America/Los_Angeles" as String {class: "java.lang.String"} }
```

<!-- document id=678783cc5e6fb37a63562f69635cc4fd1b802e4ab2446a2f870057061a313bd7 url=/mulesoft/current/en-us/dataweave/2.12/dw-runtime-functions-prop.md -->

---
product: DataWeave
version: 2.12
---

# prop

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## prop(propertyName: String): String | Null

Returns the value of the property with the specified name or `null` if the property is not defined.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>propertyName</code></p></td><td><p>The property to retrieve.</p></td></tr></tbody></table>

### Example

This example gets the `user.timezone` property.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
output application/dw
---
{ "props" : prop("user.timezone") }
```

#### Output

```JSON
{ props: "America/Los_Angeles" as String {class: "java.lang.String"} }
```

<!-- document id=5ca011535b56e6ee44b18451dc947a0a4081e7215d7d124b0e6bf98485a51554 url=/mulesoft/current/en-us/dataweave/2.3/dw-runtime-functions-prop.md -->

---
product: DataWeave
version: 2.3
---

# prop

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## prop(String): String | Null

Returns the value of the property with the specified name or `null` if the property is not defined.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>propertyName</code></p></td><td><p>The property to retrieve.</p></td></tr></tbody></table>

### Example

This example gets the `user.timezone` property.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
output application/dw
---
{ "props" : prop("user.timezone") }
```

#### Output

```JSON
{ props: "America/Los_Angeles" as String {class: "java.lang.String"} }
```

<!-- document id=7071a6a9a7ca2e6c3f6708612f2d1a3cfe8bf5cf346d159debc7409c123ae869 url=/mulesoft/current/en-us/dataweave/2.4/dw-runtime-functions-prop.md -->

---
product: DataWeave
version: 2.4
---

# prop

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## prop(propertyName: String): String | Null

Returns the value of the property with the specified name or `null` if the property is not defined.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>propertyName</code></p></td><td><p>The property to retrieve.</p></td></tr></tbody></table>

### Example

This example gets the `user.timezone` property.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
output application/dw
---
{ "props" : prop("user.timezone") }
```

#### Output

```JSON
{ props: "America/Los_Angeles" as String {class: "java.lang.String"} }
```

<!-- document id=24a9d473042538bc9e4dea548482553a66baa0a27a7c763f21beb04f1024ac6a url=/mulesoft/current/en-us/dataweave/2.6/dw-runtime-functions-prop.md -->

---
product: DataWeave
version: 2.6
---

# prop

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## prop(propertyName: String): String | Null

Returns the value of the property with the specified name or `null` if the property is not defined.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>propertyName</code></p></td><td><p>The property to retrieve.</p></td></tr></tbody></table>

### Example

This example gets the `user.timezone` property.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
output application/dw
---
{ "props" : prop("user.timezone") }
```

#### Output

```JSON
{ props: "America/Los_Angeles" as String {class: "java.lang.String"} }
```

<!-- document id=2d8bd0baca2a2d92d2f02a6f4e3916bb6570786d3a383ecd24d9509d8706e956 url=/mulesoft/current/en-us/dataweave/2.9/dw-runtime-functions-prop.md -->

---
product: DataWeave
version: 2.9
---

# prop

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## prop(propertyName: String): String | Null

Returns the value of the property with the specified name or `null` if the property is not defined.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>propertyName</code></p></td><td><p>The property to retrieve.</p></td></tr></tbody></table>

### Example

This example gets the `user.timezone` property.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
output application/dw
---
{ "props" : prop("user.timezone") }
```

#### Output

```JSON
{ props: "America/Los_Angeles" as String {class: "java.lang.String"} }
```

<!-- document id=2ff58608eab8f9adf6552fd62930c05c0d1142bc9fbbce96f10438b5a901f730 url=/mulesoft/current/en-us/dataweave/latest/dw-runtime-functions-prop.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# prop

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## prop(propertyName: String): String | Null

Returns the value of the property with the specified name or `null` if the property is not defined.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>propertyName</code></p></td><td><p>The property to retrieve.</p></td></tr></tbody></table>

### Example

This example gets the `user.timezone` property.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
output application/dw
---
{ "props" : prop("user.timezone") }
```

#### Output

```JSON
{ props: "America/Los_Angeles" as String {class: "java.lang.String"} }
```

<!-- document id=d643cc15a7d83d33a34056ddce359cda8659327267c6f9adcef8c372eb992030 url=/mulesoft/current/en-us/dataweave/2.11/dw-runtime-functions-props.md -->

---
product: DataWeave
version: 2.11
---

# props

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## props(): Dictionary<String>

Returns all the properties configured for the DataWeave runtime, which executes the language.

### Example

This example returns all properties from the `java.util.Properties` class.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
output application/dw
---
{ "props" : props() }
```

#### Output

```JSON
{
 props: {
   "java.vendor": "Oracle Corporation" as String {class: "java.lang.String"},
   "sun.java.launcher": "SUN_STANDARD" as String {class: "java.lang.String"},
   "sun.management.compiler": "HotSpot 64-Bit Tiered Compilers" as String ..., *    "os.name": "Mac OS X" as String {class: "java.lang.String"},
   "sun.boot.class.path": "/Library/Java/JavaVirtualMachines/ ...,
   "org.glassfish.grizzly.nio.transport.TCPNIOTransport...": "1048576" ...,
   "java.vm.specification.vendor": "Oracle Corporation" as String ...,
   "java.runtime.version": "1.8.0_111-b14" as String {class: "java.lang.String"},
   "wrapper.native_library": "wrapper" as String {class: "java.lang.String"},
   "wrapper.key": "XlIl4YartmfEU3oKu7o81kNQbwhveXi-" as String ...,
   "user.name": "me" as String {class: "java.lang.String"},
   "mvel2.disable.jit": "TRUE" as String {class: "java.lang.String"},
   "user.language": "en" as String {class: "java.lang.String"} ...,
   "sun.boot.library.path": "/Library/Java/JavaVirtualMachines ...
   "xpath.provider": "com.mulesoft.licm.DefaultXPathProvider" ...,
   "wrapper.backend": "pipe" as String {class: "java.lang.String"},
   "java.version": "1.8.0_111" as String {class: "java.lang.String"},
   "user.timezone": "America/Los_Angeles" as String {class: "java.lang.String"},
   "java.net.preferIPv4Stack": "TRUE" as String {class: "java.lang.String"},
   "sun.arch.data.model": "64" as String {class: "java.lang.String"},
   "java.endorsed.dirs": "/Library/Java/JavaVirtualMachines/...,
   "sun.cpu.isalist": "" as String {class: "java.lang.String"},
   "sun.jnu.encoding": "UTF-8" as String {class: "java.lang.String"},
   "mule.testingMode": "" as String {class: "java.lang.String"},
   "file.encoding.pkg": "sun.io" as String {class: "java.lang.String"},
   "file.separator": "/" as String {class: "java.lang.String"},
   "java.specification.name": "Java Platform API Specification" ...,
   "java.class.version": "52.0" as String {class: "java.lang.String"},
   "jetty.git.hash": "82b8fb23f757335bb3329d540ce37a2a2615f0a8" ...,
   "user.country": "US" as String {class: "java.lang.String"},
   "mule.agent.configuration.folder": "/Applications/AnypointStudio.app/ ...,
   "log4j.configurationFactory": "org.apache.logging.log4j.core...",
   "java.home": "/Library/Java/JavaVirtualMachines/...,
   "java.vm.info": "mixed mode" as String {class: "java.lang.String"},
   "wrapper.version": "3.5.34-st" as String {class: "java.lang.String"},
   "os.version": "10.13.4" as String {class: "java.lang.String"},
   "org.eclipse.jetty.LEVEL": "WARN" as String {class: "java.lang.String"},
   "path.separator": ":" as String {class: "java.lang.String"},
   "java.vm.version": "25.111-b14" as String {class: "java.lang.String"},
   "wrapper.pid": "5212" as String {class: "java.lang.String"},
   "java.util.prefs.PreferencesFactory": "com.mulesoft.licm..."},
   "wrapper.java.pid": "5213" as String {class: "java.lang.String"},
   "mule.home": "/Applications/AnypointStudio.app/...,
   "java.awt.printerjob": "sun.lwawt.macosx.CPrinterJob" ...,
   "sun.io.unicode.encoding": "UnicodeBig" as String {class: "java.lang.String"},
   "awt.toolkit": "sun.lwawt.macosx.LWCToolkit" ...,
   "org.glassfish.grizzly.nio.transport...": "1048576" ...,
   "user.home": "/Users/me" as String {class: "java.lang.String"},
   "java.specification.vendor": "Oracle Corporation" ...,
   "java.library.path": "/Applications/AnypointStudio.app/...,
   "java.vendor.url": "http://java.oracle.com/" as String ...,
   "java.vm.vendor": "Oracle Corporation" as String {class: "java.lang.String"},
   gopherProxySet: "false" as String {class: "java.lang.String"},
   "wrapper.jvmid": "1" as String {class: "java.lang.String"},
   "java.runtime.name": "Java(TM) SE Runtime Environment" ...,
   "mule.encoding": "UTF-8" as String {class: "java.lang.String"},
   "sun.java.command": "org.mule.runtime.module.reboot....",
   "java.class.path": "%MULE_LIB%:/Applications/AnypointStudio.app...",
   "log4j2.loggerContextFactory": "org.mule.runtime.module.launcher...,
   "java.vm.specification.name": "Java Virtual Machine Specification" ,
   "java.vm.specification.version": "1.8" as String {class: "java.lang.String"},
   "sun.cpu.endian": "little" as String {class: "java.lang.String"},
   "sun.os.patch.level": "unknown" as String {class: "java.lang.String"},
   "com.ning.http.client.AsyncHttpClientConfig.useProxyProperties": "true" ...,
   "wrapper.cpu.timeout": "10" as String {class: "java.lang.String"},
   "java.io.tmpdir": "/var/folders/42/dd73l3rx7qz0n625hr29kty80000gn/T/" ...,
   "anypoint.platform.analytics_base_uri": ...,
   "java.vendor.url.bug": "http://bugreport.sun.com/bugreport/" ...,
   "os.arch": "x86_64" as String {class: "java.lang.String"},
   "java.awt.graphicsenv": "sun.awt.CGraphicsEnvironment" ...,
   "mule.base": "/Applications/AnypointStudio.app...",
   "java.ext.dirs": "/Users/staceyduke/Library/Java/Extensions: ..."},
   "user.dir": "/Applications/AnypointStudio.app/..."},
   "line.separator": "\n" as String {class: "java.lang.String"},
   "java.vm.name": "Java HotSpot(TM) 64-Bit Server VM" ...,
   "org.quartz.scheduler.skipUpdateCheck": "true" ...,
   "file.encoding": "UTF-8" as String {class: "java.lang.String"},
   "mule.forceConsoleLog": "" as String {class: "java.lang.String"},
   "java.specification.version": "1.8" as String {class: "java.lang.String"},
   "wrapper.arch": "universal" as String {class: "java.lang.String"}
 } as Object {class: "java.util.Properties"}
```

<!-- document id=a6e6696de5e826888dc741f2d06f2ea4d4d11daf47875cf2da00037ea388812b url=/mulesoft/current/en-us/dataweave/2.12/dw-runtime-functions-props.md -->

---
product: DataWeave
version: 2.12
---

# props

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## props(): Dictionary<String>

Returns all the properties configured for the DataWeave runtime, which executes the language.

### Example

This example returns all properties from the `java.util.Properties` class.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
output application/dw
---
{ "props" : props() }
```

#### Output

```JSON
{
 props: {
   "java.vendor": "Oracle Corporation" as String {class: "java.lang.String"},
   "sun.java.launcher": "SUN_STANDARD" as String {class: "java.lang.String"},
   "sun.management.compiler": "HotSpot 64-Bit Tiered Compilers" as String ..., *    "os.name": "Mac OS X" as String {class: "java.lang.String"},
   "sun.boot.class.path": "/Library/Java/JavaVirtualMachines/ ...,
   "org.glassfish.grizzly.nio.transport.TCPNIOTransport...": "1048576" ...,
   "java.vm.specification.vendor": "Oracle Corporation" as String ...,
   "java.runtime.version": "1.8.0_111-b14" as String {class: "java.lang.String"},
   "wrapper.native_library": "wrapper" as String {class: "java.lang.String"},
   "wrapper.key": "XlIl4YartmfEU3oKu7o81kNQbwhveXi-" as String ...,
   "user.name": "me" as String {class: "java.lang.String"},
   "mvel2.disable.jit": "TRUE" as String {class: "java.lang.String"},
   "user.language": "en" as String {class: "java.lang.String"} ...,
   "sun.boot.library.path": "/Library/Java/JavaVirtualMachines ...
   "xpath.provider": "com.mulesoft.licm.DefaultXPathProvider" ...,
   "wrapper.backend": "pipe" as String {class: "java.lang.String"},
   "java.version": "1.8.0_111" as String {class: "java.lang.String"},
   "user.timezone": "America/Los_Angeles" as String {class: "java.lang.String"},
   "java.net.preferIPv4Stack": "TRUE" as String {class: "java.lang.String"},
   "sun.arch.data.model": "64" as String {class: "java.lang.String"},
   "java.endorsed.dirs": "/Library/Java/JavaVirtualMachines/...,
   "sun.cpu.isalist": "" as String {class: "java.lang.String"},
   "sun.jnu.encoding": "UTF-8" as String {class: "java.lang.String"},
   "mule.testingMode": "" as String {class: "java.lang.String"},
   "file.encoding.pkg": "sun.io" as String {class: "java.lang.String"},
   "file.separator": "/" as String {class: "java.lang.String"},
   "java.specification.name": "Java Platform API Specification" ...,
   "java.class.version": "52.0" as String {class: "java.lang.String"},
   "jetty.git.hash": "82b8fb23f757335bb3329d540ce37a2a2615f0a8" ...,
   "user.country": "US" as String {class: "java.lang.String"},
   "mule.agent.configuration.folder": "/Applications/AnypointStudio.app/ ...,
   "log4j.configurationFactory": "org.apache.logging.log4j.core...",
   "java.home": "/Library/Java/JavaVirtualMachines/...,
   "java.vm.info": "mixed mode" as String {class: "java.lang.String"},
   "wrapper.version": "3.5.34-st" as String {class: "java.lang.String"},
   "os.version": "10.13.4" as String {class: "java.lang.String"},
   "org.eclipse.jetty.LEVEL": "WARN" as String {class: "java.lang.String"},
   "path.separator": ":" as String {class: "java.lang.String"},
   "java.vm.version": "25.111-b14" as String {class: "java.lang.String"},
   "wrapper.pid": "5212" as String {class: "java.lang.String"},
   "java.util.prefs.PreferencesFactory": "com.mulesoft.licm..."},
   "wrapper.java.pid": "5213" as String {class: "java.lang.String"},
   "mule.home": "/Applications/AnypointStudio.app/...,
   "java.awt.printerjob": "sun.lwawt.macosx.CPrinterJob" ...,
   "sun.io.unicode.encoding": "UnicodeBig" as String {class: "java.lang.String"},
   "awt.toolkit": "sun.lwawt.macosx.LWCToolkit" ...,
   "org.glassfish.grizzly.nio.transport...": "1048576" ...,
   "user.home": "/Users/me" as String {class: "java.lang.String"},
   "java.specification.vendor": "Oracle Corporation" ...,
   "java.library.path": "/Applications/AnypointStudio.app/...,
   "java.vendor.url": "http://java.oracle.com/" as String ...,
   "java.vm.vendor": "Oracle Corporation" as String {class: "java.lang.String"},
   gopherProxySet: "false" as String {class: "java.lang.String"},
   "wrapper.jvmid": "1" as String {class: "java.lang.String"},
   "java.runtime.name": "Java(TM) SE Runtime Environment" ...,
   "mule.encoding": "UTF-8" as String {class: "java.lang.String"},
   "sun.java.command": "org.mule.runtime.module.reboot....",
   "java.class.path": "%MULE_LIB%:/Applications/AnypointStudio.app...",
   "log4j2.loggerContextFactory": "org.mule.runtime.module.launcher...,
   "java.vm.specification.name": "Java Virtual Machine Specification" ,
   "java.vm.specification.version": "1.8" as String {class: "java.lang.String"},
   "sun.cpu.endian": "little" as String {class: "java.lang.String"},
   "sun.os.patch.level": "unknown" as String {class: "java.lang.String"},
   "com.ning.http.client.AsyncHttpClientConfig.useProxyProperties": "true" ...,
   "wrapper.cpu.timeout": "10" as String {class: "java.lang.String"},
   "java.io.tmpdir": "/var/folders/42/dd73l3rx7qz0n625hr29kty80000gn/T/" ...,
   "anypoint.platform.analytics_base_uri": ...,
   "java.vendor.url.bug": "http://bugreport.sun.com/bugreport/" ...,
   "os.arch": "x86_64" as String {class: "java.lang.String"},
   "java.awt.graphicsenv": "sun.awt.CGraphicsEnvironment" ...,
   "mule.base": "/Applications/AnypointStudio.app...",
   "java.ext.dirs": "/Users/staceyduke/Library/Java/Extensions: ..."},
   "user.dir": "/Applications/AnypointStudio.app/..."},
   "line.separator": "\n" as String {class: "java.lang.String"},
   "java.vm.name": "Java HotSpot(TM) 64-Bit Server VM" ...,
   "org.quartz.scheduler.skipUpdateCheck": "true" ...,
   "file.encoding": "UTF-8" as String {class: "java.lang.String"},
   "mule.forceConsoleLog": "" as String {class: "java.lang.String"},
   "java.specification.version": "1.8" as String {class: "java.lang.String"},
   "wrapper.arch": "universal" as String {class: "java.lang.String"}
 } as Object {class: "java.util.Properties"}
```

<!-- document id=f231f512b702a95f2f6c064fa6a35e5004bc2ad995be76127c44ee57848ddad0 url=/mulesoft/current/en-us/dataweave/2.3/dw-runtime-functions-props.md -->

---
product: DataWeave
version: 2.3
---

# props

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## props(): Dictionary<String>

Returns all the properties configured for Mule runtime.

### Example

This example returns all properties from the `java.util.Properties` class.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
output application/dw
---
{ "props" : props() }
```

#### Output

```JSON
{
 props: {
   "java.vendor": "Oracle Corporation" as String {class: "java.lang.String"},
   "sun.java.launcher": "SUN_STANDARD" as String {class: "java.lang.String"},
   "sun.management.compiler": "HotSpot 64-Bit Tiered Compilers" as String ..., *    "os.name": "Mac OS X" as String {class: "java.lang.String"},
   "sun.boot.class.path": "/Library/Java/JavaVirtualMachines/ ...,
   "org.glassfish.grizzly.nio.transport.TCPNIOTransport...": "1048576" ...,
   "java.vm.specification.vendor": "Oracle Corporation" as String ...,
   "java.runtime.version": "1.8.0_111-b14" as String {class: "java.lang.String"},
   "wrapper.native_library": "wrapper" as String {class: "java.lang.String"},
   "wrapper.key": "XlIl4YartmfEU3oKu7o81kNQbwhveXi-" as String ...,
   "user.name": "me" as String {class: "java.lang.String"},
   "mvel2.disable.jit": "TRUE" as String {class: "java.lang.String"},
   "user.language": "en" as String {class: "java.lang.String"} ...,
   "sun.boot.library.path": "/Library/Java/JavaVirtualMachines ...
   "xpath.provider": "com.mulesoft.licm.DefaultXPathProvider" ...,
   "wrapper.backend": "pipe" as String {class: "java.lang.String"},
   "java.version": "1.8.0_111" as String {class: "java.lang.String"},
   "user.timezone": "America/Los_Angeles" as String {class: "java.lang.String"},
   "java.net.preferIPv4Stack": "TRUE" as String {class: "java.lang.String"},
   "sun.arch.data.model": "64" as String {class: "java.lang.String"},
   "java.endorsed.dirs": "/Library/Java/JavaVirtualMachines/...,
   "sun.cpu.isalist": "" as String {class: "java.lang.String"},
   "sun.jnu.encoding": "UTF-8" as String {class: "java.lang.String"},
   "mule.testingMode": "" as String {class: "java.lang.String"},
   "file.encoding.pkg": "sun.io" as String {class: "java.lang.String"},
   "file.separator": "/" as String {class: "java.lang.String"},
   "java.specification.name": "Java Platform API Specification" ...,
   "java.class.version": "52.0" as String {class: "java.lang.String"},
   "jetty.git.hash": "82b8fb23f757335bb3329d540ce37a2a2615f0a8" ...,
   "user.country": "US" as String {class: "java.lang.String"},
   "mule.agent.configuration.folder": "/Applications/AnypointStudio.app/ ...,
   "log4j.configurationFactory": "org.apache.logging.log4j.core...",
   "java.home": "/Library/Java/JavaVirtualMachines/...,
   "java.vm.info": "mixed mode" as String {class: "java.lang.String"},
   "wrapper.version": "3.5.34-st" as String {class: "java.lang.String"},
   "os.version": "10.13.4" as String {class: "java.lang.String"},
   "org.eclipse.jetty.LEVEL": "WARN" as String {class: "java.lang.String"},
   "path.separator": ":" as String {class: "java.lang.String"},
   "java.vm.version": "25.111-b14" as String {class: "java.lang.String"},
   "wrapper.pid": "5212" as String {class: "java.lang.String"},
   "java.util.prefs.PreferencesFactory": "com.mulesoft.licm..."},
   "wrapper.java.pid": "5213" as String {class: "java.lang.String"},
   "mule.home": "/Applications/AnypointStudio.app/...,
   "java.awt.printerjob": "sun.lwawt.macosx.CPrinterJob" ...,
   "sun.io.unicode.encoding": "UnicodeBig" as String {class: "java.lang.String"},
   "awt.toolkit": "sun.lwawt.macosx.LWCToolkit" ...,
   "org.glassfish.grizzly.nio.transport...": "1048576" ...,
   "user.home": "/Users/me" as String {class: "java.lang.String"},
   "java.specification.vendor": "Oracle Corporation" ...,
   "java.library.path": "/Applications/AnypointStudio.app/...,
   "java.vendor.url": "http://java.oracle.com/" as String ...,
   "java.vm.vendor": "Oracle Corporation" as String {class: "java.lang.String"},
   gopherProxySet: "false" as String {class: "java.lang.String"},
   "wrapper.jvmid": "1" as String {class: "java.lang.String"},
   "java.runtime.name": "Java(TM) SE Runtime Environment" ...,
   "mule.encoding": "UTF-8" as String {class: "java.lang.String"},
   "sun.java.command": "org.mule.runtime.module.reboot....",
   "java.class.path": "%MULE_LIB%:/Applications/AnypointStudio.app...",
   "log4j2.loggerContextFactory": "org.mule.runtime.module.launcher...,
   "java.vm.specification.name": "Java Virtual Machine Specification" ,
   "java.vm.specification.version": "1.8" as String {class: "java.lang.String"},
   "sun.cpu.endian": "little" as String {class: "java.lang.String"},
   "sun.os.patch.level": "unknown" as String {class: "java.lang.String"},
   "com.ning.http.client.AsyncHttpClientConfig.useProxyProperties": "true" ...,
   "wrapper.cpu.timeout": "10" as String {class: "java.lang.String"},
   "java.io.tmpdir": "/var/folders/42/dd73l3rx7qz0n625hr29kty80000gn/T/" ...,
   "anypoint.platform.analytics_base_uri": ...,
   "java.vendor.url.bug": "http://bugreport.sun.com/bugreport/" ...,
   "os.arch": "x86_64" as String {class: "java.lang.String"},
   "java.awt.graphicsenv": "sun.awt.CGraphicsEnvironment" ...,
   "mule.base": "/Applications/AnypointStudio.app...",
   "java.ext.dirs": "/Users/staceyduke/Library/Java/Extensions: ..."},
   "user.dir": "/Applications/AnypointStudio.app/..."},
   "line.separator": "\n" as String {class: "java.lang.String"},
   "java.vm.name": "Java HotSpot(TM) 64-Bit Server VM" ...,
   "org.quartz.scheduler.skipUpdateCheck": "true" ...,
   "file.encoding": "UTF-8" as String {class: "java.lang.String"},
   "mule.forceConsoleLog": "" as String {class: "java.lang.String"},
   "java.specification.version": "1.8" as String {class: "java.lang.String"},
   "wrapper.arch": "universal" as String {class: "java.lang.String"}
 } as Object {class: "java.util.Properties"}
```

<!-- document id=f66cc6861f91022bc3e82a94c9335eee4cef5b8ec4633f13e5e04eb737b8895c url=/mulesoft/current/en-us/dataweave/2.4/dw-runtime-functions-props.md -->

---
product: DataWeave
version: 2.4
---

# props

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## props(): Dictionary<String>

Returns all the properties configured for the DataWeave runtime, which executes the language.

### Example

This example returns all properties from the `java.util.Properties` class.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
output application/dw
---
{ "props" : props() }
```

#### Output

```JSON
{
 props: {
   "java.vendor": "Oracle Corporation" as String {class: "java.lang.String"},
   "sun.java.launcher": "SUN_STANDARD" as String {class: "java.lang.String"},
   "sun.management.compiler": "HotSpot 64-Bit Tiered Compilers" as String ..., *    "os.name": "Mac OS X" as String {class: "java.lang.String"},
   "sun.boot.class.path": "/Library/Java/JavaVirtualMachines/ ...,
   "org.glassfish.grizzly.nio.transport.TCPNIOTransport...": "1048576" ...,
   "java.vm.specification.vendor": "Oracle Corporation" as String ...,
   "java.runtime.version": "1.8.0_111-b14" as String {class: "java.lang.String"},
   "wrapper.native_library": "wrapper" as String {class: "java.lang.String"},
   "wrapper.key": "XlIl4YartmfEU3oKu7o81kNQbwhveXi-" as String ...,
   "user.name": "me" as String {class: "java.lang.String"},
   "mvel2.disable.jit": "TRUE" as String {class: "java.lang.String"},
   "user.language": "en" as String {class: "java.lang.String"} ...,
   "sun.boot.library.path": "/Library/Java/JavaVirtualMachines ...
   "xpath.provider": "com.mulesoft.licm.DefaultXPathProvider" ...,
   "wrapper.backend": "pipe" as String {class: "java.lang.String"},
   "java.version": "1.8.0_111" as String {class: "java.lang.String"},
   "user.timezone": "America/Los_Angeles" as String {class: "java.lang.String"},
   "java.net.preferIPv4Stack": "TRUE" as String {class: "java.lang.String"},
   "sun.arch.data.model": "64" as String {class: "java.lang.String"},
   "java.endorsed.dirs": "/Library/Java/JavaVirtualMachines/...,
   "sun.cpu.isalist": "" as String {class: "java.lang.String"},
   "sun.jnu.encoding": "UTF-8" as String {class: "java.lang.String"},
   "mule.testingMode": "" as String {class: "java.lang.String"},
   "file.encoding.pkg": "sun.io" as String {class: "java.lang.String"},
   "file.separator": "/" as String {class: "java.lang.String"},
   "java.specification.name": "Java Platform API Specification" ...,
   "java.class.version": "52.0" as String {class: "java.lang.String"},
   "jetty.git.hash": "82b8fb23f757335bb3329d540ce37a2a2615f0a8" ...,
   "user.country": "US" as String {class: "java.lang.String"},
   "mule.agent.configuration.folder": "/Applications/AnypointStudio.app/ ...,
   "log4j.configurationFactory": "org.apache.logging.log4j.core...",
   "java.home": "/Library/Java/JavaVirtualMachines/...,
   "java.vm.info": "mixed mode" as String {class: "java.lang.String"},
   "wrapper.version": "3.5.34-st" as String {class: "java.lang.String"},
   "os.version": "10.13.4" as String {class: "java.lang.String"},
   "org.eclipse.jetty.LEVEL": "WARN" as String {class: "java.lang.String"},
   "path.separator": ":" as String {class: "java.lang.String"},
   "java.vm.version": "25.111-b14" as String {class: "java.lang.String"},
   "wrapper.pid": "5212" as String {class: "java.lang.String"},
   "java.util.prefs.PreferencesFactory": "com.mulesoft.licm..."},
   "wrapper.java.pid": "5213" as String {class: "java.lang.String"},
   "mule.home": "/Applications/AnypointStudio.app/...,
   "java.awt.printerjob": "sun.lwawt.macosx.CPrinterJob" ...,
   "sun.io.unicode.encoding": "UnicodeBig" as String {class: "java.lang.String"},
   "awt.toolkit": "sun.lwawt.macosx.LWCToolkit" ...,
   "org.glassfish.grizzly.nio.transport...": "1048576" ...,
   "user.home": "/Users/me" as String {class: "java.lang.String"},
   "java.specification.vendor": "Oracle Corporation" ...,
   "java.library.path": "/Applications/AnypointStudio.app/...,
   "java.vendor.url": "http://java.oracle.com/" as String ...,
   "java.vm.vendor": "Oracle Corporation" as String {class: "java.lang.String"},
   gopherProxySet: "false" as String {class: "java.lang.String"},
   "wrapper.jvmid": "1" as String {class: "java.lang.String"},
   "java.runtime.name": "Java(TM) SE Runtime Environment" ...,
   "mule.encoding": "UTF-8" as String {class: "java.lang.String"},
   "sun.java.command": "org.mule.runtime.module.reboot....",
   "java.class.path": "%MULE_LIB%:/Applications/AnypointStudio.app...",
   "log4j2.loggerContextFactory": "org.mule.runtime.module.launcher...,
   "java.vm.specification.name": "Java Virtual Machine Specification" ,
   "java.vm.specification.version": "1.8" as String {class: "java.lang.String"},
   "sun.cpu.endian": "little" as String {class: "java.lang.String"},
   "sun.os.patch.level": "unknown" as String {class: "java.lang.String"},
   "com.ning.http.client.AsyncHttpClientConfig.useProxyProperties": "true" ...,
   "wrapper.cpu.timeout": "10" as String {class: "java.lang.String"},
   "java.io.tmpdir": "/var/folders/42/dd73l3rx7qz0n625hr29kty80000gn/T/" ...,
   "anypoint.platform.analytics_base_uri": ...,
   "java.vendor.url.bug": "http://bugreport.sun.com/bugreport/" ...,
   "os.arch": "x86_64" as String {class: "java.lang.String"},
   "java.awt.graphicsenv": "sun.awt.CGraphicsEnvironment" ...,
   "mule.base": "/Applications/AnypointStudio.app...",
   "java.ext.dirs": "/Users/staceyduke/Library/Java/Extensions: ..."},
   "user.dir": "/Applications/AnypointStudio.app/..."},
   "line.separator": "\n" as String {class: "java.lang.String"},
   "java.vm.name": "Java HotSpot(TM) 64-Bit Server VM" ...,
   "org.quartz.scheduler.skipUpdateCheck": "true" ...,
   "file.encoding": "UTF-8" as String {class: "java.lang.String"},
   "mule.forceConsoleLog": "" as String {class: "java.lang.String"},
   "java.specification.version": "1.8" as String {class: "java.lang.String"},
   "wrapper.arch": "universal" as String {class: "java.lang.String"}
 } as Object {class: "java.util.Properties"}
```

<!-- document id=f0c3f6e3be7947a94e8f793a44f8c7f61d7e6078cd4ee5110ee0ee0a753fe0b1 url=/mulesoft/current/en-us/dataweave/2.6/dw-runtime-functions-props.md -->

---
product: DataWeave
version: 2.6
---

# props

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## props(): Dictionary<String>

Returns all the properties configured for the DataWeave runtime, which executes the language.

### Example

This example returns all properties from the `java.util.Properties` class.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
output application/dw
---
{ "props" : props() }
```

#### Output

```JSON
{
 props: {
   "java.vendor": "Oracle Corporation" as String {class: "java.lang.String"},
   "sun.java.launcher": "SUN_STANDARD" as String {class: "java.lang.String"},
   "sun.management.compiler": "HotSpot 64-Bit Tiered Compilers" as String ..., *    "os.name": "Mac OS X" as String {class: "java.lang.String"},
   "sun.boot.class.path": "/Library/Java/JavaVirtualMachines/ ...,
   "org.glassfish.grizzly.nio.transport.TCPNIOTransport...": "1048576" ...,
   "java.vm.specification.vendor": "Oracle Corporation" as String ...,
   "java.runtime.version": "1.8.0_111-b14" as String {class: "java.lang.String"},
   "wrapper.native_library": "wrapper" as String {class: "java.lang.String"},
   "wrapper.key": "XlIl4YartmfEU3oKu7o81kNQbwhveXi-" as String ...,
   "user.name": "me" as String {class: "java.lang.String"},
   "mvel2.disable.jit": "TRUE" as String {class: "java.lang.String"},
   "user.language": "en" as String {class: "java.lang.String"} ...,
   "sun.boot.library.path": "/Library/Java/JavaVirtualMachines ...
   "xpath.provider": "com.mulesoft.licm.DefaultXPathProvider" ...,
   "wrapper.backend": "pipe" as String {class: "java.lang.String"},
   "java.version": "1.8.0_111" as String {class: "java.lang.String"},
   "user.timezone": "America/Los_Angeles" as String {class: "java.lang.String"},
   "java.net.preferIPv4Stack": "TRUE" as String {class: "java.lang.String"},
   "sun.arch.data.model": "64" as String {class: "java.lang.String"},
   "java.endorsed.dirs": "/Library/Java/JavaVirtualMachines/...,
   "sun.cpu.isalist": "" as String {class: "java.lang.String"},
   "sun.jnu.encoding": "UTF-8" as String {class: "java.lang.String"},
   "mule.testingMode": "" as String {class: "java.lang.String"},
   "file.encoding.pkg": "sun.io" as String {class: "java.lang.String"},
   "file.separator": "/" as String {class: "java.lang.String"},
   "java.specification.name": "Java Platform API Specification" ...,
   "java.class.version": "52.0" as String {class: "java.lang.String"},
   "jetty.git.hash": "82b8fb23f757335bb3329d540ce37a2a2615f0a8" ...,
   "user.country": "US" as String {class: "java.lang.String"},
   "mule.agent.configuration.folder": "/Applications/AnypointStudio.app/ ...,
   "log4j.configurationFactory": "org.apache.logging.log4j.core...",
   "java.home": "/Library/Java/JavaVirtualMachines/...,
   "java.vm.info": "mixed mode" as String {class: "java.lang.String"},
   "wrapper.version": "3.5.34-st" as String {class: "java.lang.String"},
   "os.version": "10.13.4" as String {class: "java.lang.String"},
   "org.eclipse.jetty.LEVEL": "WARN" as String {class: "java.lang.String"},
   "path.separator": ":" as String {class: "java.lang.String"},
   "java.vm.version": "25.111-b14" as String {class: "java.lang.String"},
   "wrapper.pid": "5212" as String {class: "java.lang.String"},
   "java.util.prefs.PreferencesFactory": "com.mulesoft.licm..."},
   "wrapper.java.pid": "5213" as String {class: "java.lang.String"},
   "mule.home": "/Applications/AnypointStudio.app/...,
   "java.awt.printerjob": "sun.lwawt.macosx.CPrinterJob" ...,
   "sun.io.unicode.encoding": "UnicodeBig" as String {class: "java.lang.String"},
   "awt.toolkit": "sun.lwawt.macosx.LWCToolkit" ...,
   "org.glassfish.grizzly.nio.transport...": "1048576" ...,
   "user.home": "/Users/me" as String {class: "java.lang.String"},
   "java.specification.vendor": "Oracle Corporation" ...,
   "java.library.path": "/Applications/AnypointStudio.app/...,
   "java.vendor.url": "http://java.oracle.com/" as String ...,
   "java.vm.vendor": "Oracle Corporation" as String {class: "java.lang.String"},
   gopherProxySet: "false" as String {class: "java.lang.String"},
   "wrapper.jvmid": "1" as String {class: "java.lang.String"},
   "java.runtime.name": "Java(TM) SE Runtime Environment" ...,
   "mule.encoding": "UTF-8" as String {class: "java.lang.String"},
   "sun.java.command": "org.mule.runtime.module.reboot....",
   "java.class.path": "%MULE_LIB%:/Applications/AnypointStudio.app...",
   "log4j2.loggerContextFactory": "org.mule.runtime.module.launcher...,
   "java.vm.specification.name": "Java Virtual Machine Specification" ,
   "java.vm.specification.version": "1.8" as String {class: "java.lang.String"},
   "sun.cpu.endian": "little" as String {class: "java.lang.String"},
   "sun.os.patch.level": "unknown" as String {class: "java.lang.String"},
   "com.ning.http.client.AsyncHttpClientConfig.useProxyProperties": "true" ...,
   "wrapper.cpu.timeout": "10" as String {class: "java.lang.String"},
   "java.io.tmpdir": "/var/folders/42/dd73l3rx7qz0n625hr29kty80000gn/T/" ...,
   "anypoint.platform.analytics_base_uri": ...,
   "java.vendor.url.bug": "http://bugreport.sun.com/bugreport/" ...,
   "os.arch": "x86_64" as String {class: "java.lang.String"},
   "java.awt.graphicsenv": "sun.awt.CGraphicsEnvironment" ...,
   "mule.base": "/Applications/AnypointStudio.app...",
   "java.ext.dirs": "/Users/staceyduke/Library/Java/Extensions: ..."},
   "user.dir": "/Applications/AnypointStudio.app/..."},
   "line.separator": "\n" as String {class: "java.lang.String"},
   "java.vm.name": "Java HotSpot(TM) 64-Bit Server VM" ...,
   "org.quartz.scheduler.skipUpdateCheck": "true" ...,
   "file.encoding": "UTF-8" as String {class: "java.lang.String"},
   "mule.forceConsoleLog": "" as String {class: "java.lang.String"},
   "java.specification.version": "1.8" as String {class: "java.lang.String"},
   "wrapper.arch": "universal" as String {class: "java.lang.String"}
 } as Object {class: "java.util.Properties"}
```

<!-- document id=0267f2823eba9e3ad9ff76410f9484b116ae747271907ae26be312dc9e07234e url=/mulesoft/current/en-us/dataweave/2.9/dw-runtime-functions-props.md -->

---
product: DataWeave
version: 2.9
---

# props

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## props(): Dictionary<String>

Returns all the properties configured for the DataWeave runtime, which executes the language.

### Example

This example returns all properties from the `java.util.Properties` class.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
output application/dw
---
{ "props" : props() }
```

#### Output

```JSON
{
 props: {
   "java.vendor": "Oracle Corporation" as String {class: "java.lang.String"},
   "sun.java.launcher": "SUN_STANDARD" as String {class: "java.lang.String"},
   "sun.management.compiler": "HotSpot 64-Bit Tiered Compilers" as String ..., *    "os.name": "Mac OS X" as String {class: "java.lang.String"},
   "sun.boot.class.path": "/Library/Java/JavaVirtualMachines/ ...,
   "org.glassfish.grizzly.nio.transport.TCPNIOTransport...": "1048576" ...,
   "java.vm.specification.vendor": "Oracle Corporation" as String ...,
   "java.runtime.version": "1.8.0_111-b14" as String {class: "java.lang.String"},
   "wrapper.native_library": "wrapper" as String {class: "java.lang.String"},
   "wrapper.key": "XlIl4YartmfEU3oKu7o81kNQbwhveXi-" as String ...,
   "user.name": "me" as String {class: "java.lang.String"},
   "mvel2.disable.jit": "TRUE" as String {class: "java.lang.String"},
   "user.language": "en" as String {class: "java.lang.String"} ...,
   "sun.boot.library.path": "/Library/Java/JavaVirtualMachines ...
   "xpath.provider": "com.mulesoft.licm.DefaultXPathProvider" ...,
   "wrapper.backend": "pipe" as String {class: "java.lang.String"},
   "java.version": "1.8.0_111" as String {class: "java.lang.String"},
   "user.timezone": "America/Los_Angeles" as String {class: "java.lang.String"},
   "java.net.preferIPv4Stack": "TRUE" as String {class: "java.lang.String"},
   "sun.arch.data.model": "64" as String {class: "java.lang.String"},
   "java.endorsed.dirs": "/Library/Java/JavaVirtualMachines/...,
   "sun.cpu.isalist": "" as String {class: "java.lang.String"},
   "sun.jnu.encoding": "UTF-8" as String {class: "java.lang.String"},
   "mule.testingMode": "" as String {class: "java.lang.String"},
   "file.encoding.pkg": "sun.io" as String {class: "java.lang.String"},
   "file.separator": "/" as String {class: "java.lang.String"},
   "java.specification.name": "Java Platform API Specification" ...,
   "java.class.version": "52.0" as String {class: "java.lang.String"},
   "jetty.git.hash": "82b8fb23f757335bb3329d540ce37a2a2615f0a8" ...,
   "user.country": "US" as String {class: "java.lang.String"},
   "mule.agent.configuration.folder": "/Applications/AnypointStudio.app/ ...,
   "log4j.configurationFactory": "org.apache.logging.log4j.core...",
   "java.home": "/Library/Java/JavaVirtualMachines/...,
   "java.vm.info": "mixed mode" as String {class: "java.lang.String"},
   "wrapper.version": "3.5.34-st" as String {class: "java.lang.String"},
   "os.version": "10.13.4" as String {class: "java.lang.String"},
   "org.eclipse.jetty.LEVEL": "WARN" as String {class: "java.lang.String"},
   "path.separator": ":" as String {class: "java.lang.String"},
   "java.vm.version": "25.111-b14" as String {class: "java.lang.String"},
   "wrapper.pid": "5212" as String {class: "java.lang.String"},
   "java.util.prefs.PreferencesFactory": "com.mulesoft.licm..."},
   "wrapper.java.pid": "5213" as String {class: "java.lang.String"},
   "mule.home": "/Applications/AnypointStudio.app/...,
   "java.awt.printerjob": "sun.lwawt.macosx.CPrinterJob" ...,
   "sun.io.unicode.encoding": "UnicodeBig" as String {class: "java.lang.String"},
   "awt.toolkit": "sun.lwawt.macosx.LWCToolkit" ...,
   "org.glassfish.grizzly.nio.transport...": "1048576" ...,
   "user.home": "/Users/me" as String {class: "java.lang.String"},
   "java.specification.vendor": "Oracle Corporation" ...,
   "java.library.path": "/Applications/AnypointStudio.app/...,
   "java.vendor.url": "http://java.oracle.com/" as String ...,
   "java.vm.vendor": "Oracle Corporation" as String {class: "java.lang.String"},
   gopherProxySet: "false" as String {class: "java.lang.String"},
   "wrapper.jvmid": "1" as String {class: "java.lang.String"},
   "java.runtime.name": "Java(TM) SE Runtime Environment" ...,
   "mule.encoding": "UTF-8" as String {class: "java.lang.String"},
   "sun.java.command": "org.mule.runtime.module.reboot....",
   "java.class.path": "%MULE_LIB%:/Applications/AnypointStudio.app...",
   "log4j2.loggerContextFactory": "org.mule.runtime.module.launcher...,
   "java.vm.specification.name": "Java Virtual Machine Specification" ,
   "java.vm.specification.version": "1.8" as String {class: "java.lang.String"},
   "sun.cpu.endian": "little" as String {class: "java.lang.String"},
   "sun.os.patch.level": "unknown" as String {class: "java.lang.String"},
   "com.ning.http.client.AsyncHttpClientConfig.useProxyProperties": "true" ...,
   "wrapper.cpu.timeout": "10" as String {class: "java.lang.String"},
   "java.io.tmpdir": "/var/folders/42/dd73l3rx7qz0n625hr29kty80000gn/T/" ...,
   "anypoint.platform.analytics_base_uri": ...,
   "java.vendor.url.bug": "http://bugreport.sun.com/bugreport/" ...,
   "os.arch": "x86_64" as String {class: "java.lang.String"},
   "java.awt.graphicsenv": "sun.awt.CGraphicsEnvironment" ...,
   "mule.base": "/Applications/AnypointStudio.app...",
   "java.ext.dirs": "/Users/staceyduke/Library/Java/Extensions: ..."},
   "user.dir": "/Applications/AnypointStudio.app/..."},
   "line.separator": "\n" as String {class: "java.lang.String"},
   "java.vm.name": "Java HotSpot(TM) 64-Bit Server VM" ...,
   "org.quartz.scheduler.skipUpdateCheck": "true" ...,
   "file.encoding": "UTF-8" as String {class: "java.lang.String"},
   "mule.forceConsoleLog": "" as String {class: "java.lang.String"},
   "java.specification.version": "1.8" as String {class: "java.lang.String"},
   "wrapper.arch": "universal" as String {class: "java.lang.String"}
 } as Object {class: "java.util.Properties"}
```

<!-- document id=db143df51576a3e03cef517749faff2d68e8b478822425c32cb0372019585f95 url=/mulesoft/current/en-us/dataweave/latest/dw-runtime-functions-props.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# props

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## props(): Dictionary<String>

Returns all the properties configured for the DataWeave runtime, which executes the language.

### Example

This example returns all properties from the `java.util.Properties` class.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
output application/dw
---
{ "props" : props() }
```

#### Output

```JSON
{
 props: {
   "java.vendor": "Oracle Corporation" as String {class: "java.lang.String"},
   "sun.java.launcher": "SUN_STANDARD" as String {class: "java.lang.String"},
   "sun.management.compiler": "HotSpot 64-Bit Tiered Compilers" as String ..., *    "os.name": "Mac OS X" as String {class: "java.lang.String"},
   "sun.boot.class.path": "/Library/Java/JavaVirtualMachines/ ...,
   "org.glassfish.grizzly.nio.transport.TCPNIOTransport...": "1048576" ...,
   "java.vm.specification.vendor": "Oracle Corporation" as String ...,
   "java.runtime.version": "1.8.0_111-b14" as String {class: "java.lang.String"},
   "wrapper.native_library": "wrapper" as String {class: "java.lang.String"},
   "wrapper.key": "XlIl4YartmfEU3oKu7o81kNQbwhveXi-" as String ...,
   "user.name": "me" as String {class: "java.lang.String"},
   "mvel2.disable.jit": "TRUE" as String {class: "java.lang.String"},
   "user.language": "en" as String {class: "java.lang.String"} ...,
   "sun.boot.library.path": "/Library/Java/JavaVirtualMachines ...
   "xpath.provider": "com.mulesoft.licm.DefaultXPathProvider" ...,
   "wrapper.backend": "pipe" as String {class: "java.lang.String"},
   "java.version": "1.8.0_111" as String {class: "java.lang.String"},
   "user.timezone": "America/Los_Angeles" as String {class: "java.lang.String"},
   "java.net.preferIPv4Stack": "TRUE" as String {class: "java.lang.String"},
   "sun.arch.data.model": "64" as String {class: "java.lang.String"},
   "java.endorsed.dirs": "/Library/Java/JavaVirtualMachines/...,
   "sun.cpu.isalist": "" as String {class: "java.lang.String"},
   "sun.jnu.encoding": "UTF-8" as String {class: "java.lang.String"},
   "mule.testingMode": "" as String {class: "java.lang.String"},
   "file.encoding.pkg": "sun.io" as String {class: "java.lang.String"},
   "file.separator": "/" as String {class: "java.lang.String"},
   "java.specification.name": "Java Platform API Specification" ...,
   "java.class.version": "52.0" as String {class: "java.lang.String"},
   "jetty.git.hash": "82b8fb23f757335bb3329d540ce37a2a2615f0a8" ...,
   "user.country": "US" as String {class: "java.lang.String"},
   "mule.agent.configuration.folder": "/Applications/AnypointStudio.app/ ...,
   "log4j.configurationFactory": "org.apache.logging.log4j.core...",
   "java.home": "/Library/Java/JavaVirtualMachines/...,
   "java.vm.info": "mixed mode" as String {class: "java.lang.String"},
   "wrapper.version": "3.5.34-st" as String {class: "java.lang.String"},
   "os.version": "10.13.4" as String {class: "java.lang.String"},
   "org.eclipse.jetty.LEVEL": "WARN" as String {class: "java.lang.String"},
   "path.separator": ":" as String {class: "java.lang.String"},
   "java.vm.version": "25.111-b14" as String {class: "java.lang.String"},
   "wrapper.pid": "5212" as String {class: "java.lang.String"},
   "java.util.prefs.PreferencesFactory": "com.mulesoft.licm..."},
   "wrapper.java.pid": "5213" as String {class: "java.lang.String"},
   "mule.home": "/Applications/AnypointStudio.app/...,
   "java.awt.printerjob": "sun.lwawt.macosx.CPrinterJob" ...,
   "sun.io.unicode.encoding": "UnicodeBig" as String {class: "java.lang.String"},
   "awt.toolkit": "sun.lwawt.macosx.LWCToolkit" ...,
   "org.glassfish.grizzly.nio.transport...": "1048576" ...,
   "user.home": "/Users/me" as String {class: "java.lang.String"},
   "java.specification.vendor": "Oracle Corporation" ...,
   "java.library.path": "/Applications/AnypointStudio.app/...,
   "java.vendor.url": "http://java.oracle.com/" as String ...,
   "java.vm.vendor": "Oracle Corporation" as String {class: "java.lang.String"},
   gopherProxySet: "false" as String {class: "java.lang.String"},
   "wrapper.jvmid": "1" as String {class: "java.lang.String"},
   "java.runtime.name": "Java(TM) SE Runtime Environment" ...,
   "mule.encoding": "UTF-8" as String {class: "java.lang.String"},
   "sun.java.command": "org.mule.runtime.module.reboot....",
   "java.class.path": "%MULE_LIB%:/Applications/AnypointStudio.app...",
   "log4j2.loggerContextFactory": "org.mule.runtime.module.launcher...,
   "java.vm.specification.name": "Java Virtual Machine Specification" ,
   "java.vm.specification.version": "1.8" as String {class: "java.lang.String"},
   "sun.cpu.endian": "little" as String {class: "java.lang.String"},
   "sun.os.patch.level": "unknown" as String {class: "java.lang.String"},
   "com.ning.http.client.AsyncHttpClientConfig.useProxyProperties": "true" ...,
   "wrapper.cpu.timeout": "10" as String {class: "java.lang.String"},
   "java.io.tmpdir": "/var/folders/42/dd73l3rx7qz0n625hr29kty80000gn/T/" ...,
   "anypoint.platform.analytics_base_uri": ...,
   "java.vendor.url.bug": "http://bugreport.sun.com/bugreport/" ...,
   "os.arch": "x86_64" as String {class: "java.lang.String"},
   "java.awt.graphicsenv": "sun.awt.CGraphicsEnvironment" ...,
   "mule.base": "/Applications/AnypointStudio.app...",
   "java.ext.dirs": "/Users/staceyduke/Library/Java/Extensions: ..."},
   "user.dir": "/Applications/AnypointStudio.app/..."},
   "line.separator": "\n" as String {class: "java.lang.String"},
   "java.vm.name": "Java HotSpot(TM) 64-Bit Server VM" ...,
   "org.quartz.scheduler.skipUpdateCheck": "true" ...,
   "file.encoding": "UTF-8" as String {class: "java.lang.String"},
   "mule.forceConsoleLog": "" as String {class: "java.lang.String"},
   "java.specification.version": "1.8" as String {class: "java.lang.String"},
   "wrapper.arch": "universal" as String {class: "java.lang.String"}
 } as Object {class: "java.util.Properties"}
```

<!-- document id=33bb26e987760a49f2bbca0304ba09ec2ccc822a6420f90cd6242f0d0f6a4033 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-formats-protobuf.md -->

---
product: DataWeave
version: 2.11
keywords: format, protobuf, application/protobuf, application/x-protobuf, application/protobuf
---

# Protobuf Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/protobuf`

ID: `protobuf`

Protobuf is a data format that can be mapped to DataWeave values natively. From a user perspective,
always specify the location of the descriptor file and the fully qualified name of the message for
DataWeave to read or write. When specifying the configuration properties, use the `descriptorUrl`
and the `messageType` properties, respectively.

## Example: Specify the Descriptor when Reading a Protobuf Message

The following example shows how to specify the descriptor location and the message type to parse a
Protobuf message and transform it into JSON.

### Schema

The following schema specifies the protocol used in this example.

```protobuf
syntax = "proto3";

package examples.descriptor;

message MyMessage {
  int32 myInt = 3;
  bool myBool = 13;
  string myString = 23;
}
```

### Input

The Protobuf message serves as input payload to the DataWeave source. It contains a `myInt` field
with the value `42`, a `myBool` field with the value `false`, and a `myString` field with the value
`DW + Proto`. We omit showing the Protobuf messages since their representation is not user-friendly.

### Source

The DataWeave script reads a Protobuf message that has an `int` field, a `bool` field, and a
`string` field, and transforms the input into JSON format. `messageType` points to the fully
qualified name of the message being read, in this case `examples.descriptor.MyMessage`.
`descriptorUrl` points to the descriptor, a compiled version of the `.proto` schema previously
presented.

```dataweave
%dw 2.0
output application/json
input payload application/x-protobuf messageType='examples.descriptor.MyMessage',descriptorUrl="descriptors/examples.dsc"
---
payload
```

### Output

The DataWeave script outputs the following JSON object containing the three values.

```json
{
  "myInt": 42.0,
  "myBool": false,
  "myString": "DW <3 Proto"
}
```

## Protobuf Features

Protobuf supports the following features which are not common in other formats.

### Enumerations

[Protobuf enumerations](https://protobuf.dev/programming-guides/proto3/#enum), or enums, are read as
a `String` with a particular schema that specifies the enum index. When parsing a `proto` message,
the schema is used to extract the label of the enum value. If many labels share the same index, the
first one is used. If the index does not have a matching label, the special label `"-UNRECOGNIZED"`
is used. When writing a `proto` message, the schema specifies the protocol used to get the index
corresponding to the given label.

### Example: Use DataWeave to Write Protobuf Enumerations

The following example shows how to generate a `proto` message with some enum values, given a
particular schema.

#### Schema

The following schema specifies the protocol used in this example.

```protobuf
syntax = "proto3";

package examples.enumerations;


message Langs {
  enum Languages {
    DataWeave = 0;
    Scala = 2;
    Java = 343049039;
  }

  Languages okayLanguage = 10;
  Languages bestLanguage = 11;
}
```

#### Source

The DataWeave script outputs a Protobuf message containing `okayLanguage` and `bestLanguage` values.

```dataweave
%dw 2.0
output application/x-protobuf messageType='examples.enumerations.Langs',descriptorUrl="descriptors/examples.dsc"
---
{
  okayLanguage : "Scala",
  bestLanguage : "DataWeave"
}
```

#### Output

The DataWeave script outputs a Protobuf message with two fields specified with the encoded values.

### Example: Use DataWeave to Read Protobuf Enumerations

The following example shows how to read a `proto` message with some enum values, given a particular
schema, and what to expect when the value present in the message is not specified in the schema.

#### Schema

The following schema specifies the protocol used in this example.

```protobuf
syntax = "proto3";

package examples.enumerations;


message Langs {
  enum Languages {
    DataWeave = 0;
    Scala = 2;
    Java = 343049039;
  }

  Languages okayLanguage = 10;
  Languages bestLanguage = 11;
}
```

#### Input

The Protobuf message which serves as input payload to the DataWeave source is not shown since it’s
binary. It contains a `okayLanguage` field with enum index 3, an index not specified on the schema,
while the `bestLanguage` field has the expected value.

#### Source

The DataWeave script just reads a Protobuf message and outputs it as a DataWeave output.

```dataweave
%dw 2.0
input payload application/x-protobuf messageType='examples.enumerations.Langs',descriptorUrl="descriptors/examples.dsc"
output application/dw
---
payload
```

#### Output

The DataWeave script shows how the Protobuf message input is represented in the DataWeave (`dw`)
format.

```dataweave
{
  okayLanguage: "-UNRECOGNIZED" as String {protobufEnumIndex: 3},
  bestLanguage: "DataWeave" as String {protobufEnumIndex: 0},
}
```

### Oneof

[Oneof](https://protobuf.dev/programming-guides/proto3/#oneof) fields, a Protobuf particularity, are
represented as regular fields on DataWeave. When writing a `proto` message, a particular schema
specifies what the DataWeave script needs to validate. If more than one of the fields defined is
present, the script fails.

### Example: An Invalid Attempt to Write Two Exclusive Fields

The following example shows what happens when you try to write two exclusive fields according to the
schema.

#### Schema

The following schema specifies the protocol used in this example.

```protobuf
syntax = "proto3";

package examples.oneof;

message ThisOrThat {
  oneof thisOrThat {
    bool this = 2;
    bool that = 4;
  }
}
```

#### Source

The DataWeave script outputs a Protobuf message containing both `this` and `that` fields set.

```dataweave
%dw 2.0
output application/x-protobuf messageType='examples.oneof.ThisOrThat',descriptorUrl="descriptors/examples.dsc"
---
{
  this: true,
  that: false,
}
```

#### Output

The DataWeave script outputs a `ProtoBufWritingException` specifying which `oneof` is being wrongly
used.

### Repeated Fields

Since DataWeave admits repeated fields, Protobuf repeated fields are matched to DataWeave repeated
fields, and vice versa. Note that the DataWeave object being written has to match the schema being
used. If the schema does not specify a field as repeated and the DataWeave script has that field
more than once, the script fails.

### Example: Transform a JSON Array to a Protobuf Repeated Field

The following example shows how to generate a `proto` message with a repeated field obtained from a
JSON array.

#### Schema

The following schema specifies the protocol used in this example.

```protobuf
syntax = "proto3";
package examples.repeated;
message People {
  repeated string names = 1;
}
```

#### Input

The JSON input serves as the payload to the DataWeave source.

```json
{
  "names": ["Mariano", "Shoki", "Tomo", "Ana"]
}
```

#### Source

The DataWeave script uses the `reduce` function to generate a new field for each name in the array.

```dataweave
%dw 2.0
output application/x-protobuf messageType='examples.repeated.People',descriptorUrl="descriptors/examples.dsc"
---
reduce(payload.names, (item, acc = {}) ->  acc ++ {names: item})
```

#### Output

The DataWeave script outputs a Protobuf message with the repeated field containing all the names
from the JSON array.

### Example: Transform a Protobuf Repeated Field to a JSON Array

The following example shows how to transform a `proto` message with a repeated field to a JSON
array.

#### Schema

The following schema specifies the protocol used in this example.

```protobuf
syntax = "proto3";
package examples.repeated;
message People {
  repeated string names = 1;
}
```

#### Source

The DataWeave script outputs a JSON message containing an array of names.

```dataweave
%dw 2.0
input payload application/x-protobuf messageType='examples.repeated.People',descriptorUrl="descriptors/examples.dsc"
output application/json
---
names: payload.people.*names
```

#### Output

The DataWeave script outputs a JSON message containing an array of names.

```json
{
  "names": ["Mariano", "Shoki", "Tomo", "Ana"]
}
```

### Unknowns

Protobuf offers capabilities for forward and backward compatibility of protocols. In order to
achieve this, readers and writers accept
[unknown fields](https://protobuf.dev/programming-guides/proto3/#unknowns) on messages. DataWeave
adapts to this functionality by using certain key names.

When reading a Protobuf message, if a field not present in the schema is found, it is read into
something similar to `"-35": 111111 as Number {wireType: "Varint"},`, where `"-35"` means that the
field index is `35`, and `wireType: "Varint"` specifies the wire type the field has in the message.
The `wireType` can be `"Varint"`, `"64Bit"`, `"LengthDelimited"`, `"Group"`, or `"32Bit"`.

### Semantic Parsing (Or Commonly Used Message Types)

Protobuf offers a collection of
[commonly used message types](https://protobuf.dev/reference/protobuf/google.protobuf/). DataWeave
parses some of these as the value they represent instead of as the underlying message. For example,
a `google.protobuf.Duration` is read into DataWeave as a `Period`, while a
`google.protobuf.NullValue` is read as `Null`.

The following table describes the correspondence between Protobuf types and DataWeave types.

<table><colgroup><col> <col></colgroup><thead><tr><th>Protobuf type</th><th>DataWeave type</th></tr></thead><tbody><tr><td><p>BoolValue</p></td><td><p>Boolean</p></td></tr><tr><td><p>BytesValue</p></td><td><p>Binary</p></td></tr><tr><td><p>DoubleValue</p></td><td><p>Number</p></td></tr><tr><td><p>Duration</p></td><td><p>a Duration Period</p></td></tr><tr><td><p>Empty</p></td><td><p>{}</p></td></tr><tr><td><p>FloatValue</p></td><td><p>Number</p></td></tr><tr><td><p>Int32Value</p></td><td><p>Number</p></td></tr><tr><td><p>Int64Value</p></td><td><p>Number</p></td></tr><tr><td><p>ListValue</p></td><td><p>Array</p></td></tr><tr><td><p>NullValue</p></td><td><p>Null</p></td></tr><tr><td><p>StringValue</p></td><td><p>String</p></td></tr><tr><td><p>Struct</p></td><td><p>Object</p></td></tr><tr><td><p>Timestamp</p></td><td><p>LocalDateTime</p></td></tr><tr><td><p>UInt32Value</p></td><td><p>Number</p></td></tr><tr><td><p>UInt64Value</p></td><td><p>Number</p></td></tr><tr><td><p>Value</p></td><td><p>ProtoBufValue</p></td></tr></tbody></table>

Where:

```dataweave
type ProtoBufValue  = Null
                    | Number
                    | String
                    | Boolean
                    | { _?: ProtoBufValue }
                    | Array<ProtoBufValue>
```

### Maps

[Protobuf maps](https://protobuf.dev/programming-guides/proto3/#maps) enable you to have a structure
without a predefined set of keys, but with every field sharing the same value type. A
`map<keyType, valueType>` is mapped to a DataWeave object with the keys represented as strings and
the values mapped to their corresponding value. When writing a `proto` message, the key is casted to
the `keyType` specified on the descriptor. If it’s not possible to execute the cast, the script
fails.

## Compiling Schemas into Descriptors

DataWeave is not able to directly use `*.proto` files and expects an already compiled version called
descriptor. Generate descriptors by using the `protoc` compiler as in
`protoc --descriptor_set_out=./out.dsc file1.proto file2.proto …​`, where `out.dsc` is the output
file for the descriptor (the one that DataWeave expects on the `descriptorUrl` property), while
`file1.proto` and `file2.proto` are the actual protocol specifications that the descriptor needs to
compile.

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>descriptorUrl</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>''</code></p></td><td><div><div><p>The URL for the ProtoBuf descriptor. Valid values are <code>classpath://</code>, <code>file://</code>, or <code>http://</code>.</p></div></div></td></tr><tr><td><p><code>messageType</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The message type’s full name taken from the given descriptor, including the package where it’s located.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>descriptorUrl</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>''</code></p></td><td><div><div><p>The URL for the ProtoBuf descriptor. Valid values are <code>classpath://</code>, <code>file://</code>, or <code>http://</code>.</p></div></div></td></tr><tr><td><p><code>messageType</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The message type’s full name taken from the given descriptor, including the package where it’s located.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>application/protobuf</code></p></td></tr><tr><td><p><code>application/x-protobuf</code></p></td></tr></tbody></table>

<!-- document id=94511f9c3ab4230bb83c6eace5f6e8d6dceebcc64c33380fedf0e28373f88d73 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-formats-protobuf.md -->

---
product: DataWeave
version: 2.12
keywords: format, protobuf, application/protobuf, application/x-protobuf, application/protobuf
---

# Protobuf Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/protobuf`

ID: `protobuf`

Protobuf is a data format that can be mapped to DataWeave values natively. From a user perspective,
always specify the location of the descriptor file and the fully qualified name of the message for
DataWeave to read or write. When specifying the configuration properties, use the `descriptorUrl`
and the `messageType` properties, respectively.

## Example: Specify the Descriptor when Reading a Protobuf Message

The following example shows how to specify the descriptor location and the message type to parse a
Protobuf message and transform it into JSON.

### Schema

The following schema specifies the protocol used in this example.

```protobuf
syntax = "proto3";

package examples.descriptor;

message MyMessage {
  int32 myInt = 3;
  bool myBool = 13;
  string myString = 23;
}
```

### Input

The Protobuf message serves as input payload to the DataWeave source. It contains a `myInt` field
with the value `42`, a `myBool` field with the value `false`, and a `myString` field with the value
`DW + Proto`. We omit showing the Protobuf messages since their representation is not user-friendly.

### Source

The DataWeave script reads a Protobuf message that has an `int` field, a `bool` field, and a
`string` field, and transforms the input into JSON format. `messageType` points to the fully
qualified name of the message being read, in this case `examples.descriptor.MyMessage`.
`descriptorUrl` points to the descriptor, a compiled version of the `.proto` schema previously
presented.

```dataweave
%dw 2.0
output application/json
input payload application/x-protobuf messageType='examples.descriptor.MyMessage',descriptorUrl="descriptors/examples.dsc"
---
payload
```

### Output

The DataWeave script outputs the following JSON object containing the three values.

```json
{
  "myInt": 42.0,
  "myBool": false,
  "myString": "DW <3 Proto"
}
```

## Protobuf Features

Protobuf supports the following features which are not common in other formats.

### Enumerations

[Protobuf enumerations](https://protobuf.dev/programming-guides/proto3/#enum), or enums, are read as
a `String` with a particular schema that specifies the enum index. When parsing a `proto` message,
the schema is used to extract the label of the enum value. If many labels share the same index, the
first one is used. If the index does not have a matching label, the special label `"-UNRECOGNIZED"`
is used. When writing a `proto` message, the schema specifies the protocol used to get the index
corresponding to the given label.

### Example: Use DataWeave to Write Protobuf Enumerations

The following example shows how to generate a `proto` message with some enum values, given a
particular schema.

#### Schema

The following schema specifies the protocol used in this example.

```protobuf
syntax = "proto3";

package examples.enumerations;


message Langs {
  enum Languages {
    DataWeave = 0;
    Scala = 2;
    Java = 343049039;
  }

  Languages okayLanguage = 10;
  Languages bestLanguage = 11;
}
```

#### Source

The DataWeave script outputs a Protobuf message containing `okayLanguage` and `bestLanguage` values.

```dataweave
%dw 2.0
output application/x-protobuf messageType='examples.enumerations.Langs',descriptorUrl="descriptors/examples.dsc"
---
{
  okayLanguage : "Scala",
  bestLanguage : "DataWeave"
}
```

#### Output

The DataWeave script outputs a Protobuf message with two fields specified with the encoded values.

### Example: Use DataWeave to Read Protobuf Enumerations

The following example shows how to read a `proto` message with some enum values, given a particular
schema, and what to expect when the value present in the message is not specified in the schema.

#### Schema

The following schema specifies the protocol used in this example.

```protobuf
syntax = "proto3";

package examples.enumerations;


message Langs {
  enum Languages {
    DataWeave = 0;
    Scala = 2;
    Java = 343049039;
  }

  Languages okayLanguage = 10;
  Languages bestLanguage = 11;
}
```

#### Input

The Protobuf message which serves as input payload to the DataWeave source is not shown since it’s
binary. It contains a `okayLanguage` field with enum index 3, an index not specified on the schema,
while the `bestLanguage` field has the expected value.

#### Source

The DataWeave script just reads a Protobuf message and outputs it as a DataWeave output.

```dataweave
%dw 2.0
input payload application/x-protobuf messageType='examples.enumerations.Langs',descriptorUrl="descriptors/examples.dsc"
output application/dw
---
payload
```

#### Output

The DataWeave script shows how the Protobuf message input is represented in the DataWeave (`dw`)
format.

```dataweave
{
  okayLanguage: "-UNRECOGNIZED" as String {protobufEnumIndex: 3},
  bestLanguage: "DataWeave" as String {protobufEnumIndex: 0},
}
```

### Oneof

[Oneof](https://protobuf.dev/programming-guides/proto3/#oneof) fields, a Protobuf particularity, are
represented as regular fields on DataWeave. When writing a `proto` message, a particular schema
specifies what the DataWeave script needs to validate. If more than one of the fields defined is
present, the script fails.

### Example: An Invalid Attempt to Write Two Exclusive Fields

The following example shows what happens when you try to write two exclusive fields according to the
schema.

#### Schema

The following schema specifies the protocol used in this example.

```protobuf
syntax = "proto3";

package examples.oneof;

message ThisOrThat {
  oneof thisOrThat {
    bool this = 2;
    bool that = 4;
  }
}
```

#### Source

The DataWeave script outputs a Protobuf message containing both `this` and `that` fields set.

```dataweave
%dw 2.0
output application/x-protobuf messageType='examples.oneof.ThisOrThat',descriptorUrl="descriptors/examples.dsc"
---
{
  this: true,
  that: false,
}
```

#### Output

The DataWeave script outputs a `ProtoBufWritingException` specifying which `oneof` is being wrongly
used.

### Repeated Fields

Since DataWeave admits repeated fields, Protobuf repeated fields are matched to DataWeave repeated
fields, and vice versa. Note that the DataWeave object being written has to match the schema being
used. If the schema does not specify a field as repeated and the DataWeave script has that field
more than once, the script fails.

### Example: Transform a JSON Array to a Protobuf Repeated Field

The following example shows how to generate a `proto` message with a repeated field obtained from a
JSON array.

#### Schema

The following schema specifies the protocol used in this example.

```protobuf
syntax = "proto3";
package examples.repeated;
message People {
  repeated string names = 1;
}
```

#### Input

The JSON input serves as the payload to the DataWeave source.

```json
{
  "names": ["Mariano", "Shoki", "Tomo", "Ana"]
}
```

#### Source

The DataWeave script uses the `reduce` function to generate a new field for each name in the array.

```dataweave
%dw 2.0
output application/x-protobuf messageType='examples.repeated.People',descriptorUrl="descriptors/examples.dsc"
---
reduce(payload.names, (item, acc = {}) ->  acc ++ {names: item})
```

#### Output

The DataWeave script outputs a Protobuf message with the repeated field containing all the names
from the JSON array.

### Example: Transform a Protobuf Repeated Field to a JSON Array

The following example shows how to transform a `proto` message with a repeated field to a JSON
array.

#### Schema

The following schema specifies the protocol used in this example.

```protobuf
syntax = "proto3";
package examples.repeated;
message People {
  repeated string names = 1;
}
```

#### Source

The DataWeave script outputs a JSON message containing an array of names.

```dataweave
%dw 2.0
input payload application/x-protobuf messageType='examples.repeated.People',descriptorUrl="descriptors/examples.dsc"
output application/json
---
names: payload.people.*names
```

#### Output

The DataWeave script outputs a JSON message containing an array of names.

```json
{
  "names": ["Mariano", "Shoki", "Tomo", "Ana"]
}
```

### Unknowns

Protobuf offers capabilities for forward and backward compatibility of protocols. In order to
achieve this, readers and writers accept
[unknown fields](https://protobuf.dev/programming-guides/proto3/#unknowns) on messages. DataWeave
adapts to this functionality by using certain key names.

When reading a Protobuf message, if a field not present in the schema is found, it is read into
something similar to `"-35": 111111 as Number {wireType: "Varint"},`, where `"-35"` means that the
field index is `35`, and `wireType: "Varint"` specifies the wire type the field has in the message.
The `wireType` can be `"Varint"`, `"64Bit"`, `"LengthDelimited"`, `"Group"`, or `"32Bit"`.

### Semantic Parsing (Or Commonly Used Message Types)

Protobuf offers a collection of
[commonly used message types](https://protobuf.dev/reference/protobuf/google.protobuf/). DataWeave
parses some of these as the value they represent instead of as the underlying message. For example,
a `google.protobuf.Duration` is read into DataWeave as a `Period`, while a
`google.protobuf.NullValue` is read as `Null`.

The following table describes the correspondence between Protobuf types and DataWeave types.

<table><colgroup><col> <col></colgroup><thead><tr><th>Protobuf type</th><th>DataWeave type</th></tr></thead><tbody><tr><td><p>BoolValue</p></td><td><p>Boolean</p></td></tr><tr><td><p>BytesValue</p></td><td><p>Binary</p></td></tr><tr><td><p>DoubleValue</p></td><td><p>Number</p></td></tr><tr><td><p>Duration</p></td><td><p>a Duration Period</p></td></tr><tr><td><p>Empty</p></td><td><p>{}</p></td></tr><tr><td><p>FloatValue</p></td><td><p>Number</p></td></tr><tr><td><p>Int32Value</p></td><td><p>Number</p></td></tr><tr><td><p>Int64Value</p></td><td><p>Number</p></td></tr><tr><td><p>ListValue</p></td><td><p>Array</p></td></tr><tr><td><p>NullValue</p></td><td><p>Null</p></td></tr><tr><td><p>StringValue</p></td><td><p>String</p></td></tr><tr><td><p>Struct</p></td><td><p>Object</p></td></tr><tr><td><p>Timestamp</p></td><td><p>LocalDateTime</p></td></tr><tr><td><p>UInt32Value</p></td><td><p>Number</p></td></tr><tr><td><p>UInt64Value</p></td><td><p>Number</p></td></tr><tr><td><p>Value</p></td><td><p>ProtoBufValue</p></td></tr></tbody></table>

Where:

```dataweave
type ProtoBufValue  = Null
                    | Number
                    | String
                    | Boolean
                    | { _?: ProtoBufValue }
                    | Array<ProtoBufValue>
```

### Maps

[Protobuf maps](https://protobuf.dev/programming-guides/proto3/#maps) enable you to have a structure
without a predefined set of keys, but with every field sharing the same value type. A
`map<keyType, valueType>` is mapped to a DataWeave object with the keys represented as strings and
the values mapped to their corresponding value. When writing a `proto` message, the key is casted to
the `keyType` specified on the descriptor. If it’s not possible to execute the cast, the script
fails.

## Compiling Schemas into Descriptors

DataWeave is not able to directly use `*.proto` files and expects an already compiled version called
descriptor. Generate descriptors by using the `protoc` compiler as in
`protoc --descriptor_set_out=./out.dsc file1.proto file2.proto …​`, where `out.dsc` is the output
file for the descriptor (the one that DataWeave expects on the `descriptorUrl` property), while
`file1.proto` and `file2.proto` are the actual protocol specifications that the descriptor needs to
compile.

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>descriptorUrl</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>''</code></p></td><td><div><div><p>The URL for the ProtoBuf descriptor. Valid values are <code>classpath://</code>, <code>file://</code>, or <code>http://</code>.</p></div></div></td></tr><tr><td><p><code>messageType</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The message type’s full name taken from the given descriptor, including the package where it’s located.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>descriptorUrl</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>''</code></p></td><td><div><div><p>The URL for the ProtoBuf descriptor. Valid values are <code>classpath://</code>, <code>file://</code>, or <code>http://</code>.</p></div></div></td></tr><tr><td><p><code>messageType</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The message type’s full name taken from the given descriptor, including the package where it’s located.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>application/protobuf</code></p></td></tr><tr><td><p><code>application/x-protobuf</code></p></td></tr></tbody></table>

<!-- document id=6e923377935cbf174aa06b584d1df62360aedca889dca4f64e11f05a26774386 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-formats-protobuf.md -->

---
product: DataWeave
version: 2.6
keywords: format, protobuf, application/protobuf, application/x-protobuf, application/protobuf
---

# Protobuf Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/protobuf`

ID: `protobuf`

Protobuf is a data format that can be mapped to DataWeave values natively. From a user perspective,
always specify the location of the descriptor file and the fully qualified name of the message for
DataWeave to read or write. When specifying the configuration properties, use the `descriptorUrl`
and the `messageType` properties, respectively.

## Example: Specify the Descriptor when Reading a Protobuf Message

The following example shows how to specify the descriptor location and the message type to parse a
Protobuf message and transform it into JSON.

### Schema

The following schema specifies the protocol used in this example.

```protobuf
syntax = "proto3";

package examples.descriptor;

message MyMessage {
  int32 myInt = 3;
  bool myBool = 13;
  string myString = 23;
}
```

### Input

The Protobuf message serves as input payload to the DataWeave source. It contains a `myInt` field
with the value `42`, a `myBool` field with the value `false`, and a `myString` field with the value
`DW + Proto`. We omit showing the Protobuf messages since their representation is not user-friendly.

### Source

The DataWeave script reads a Protobuf message that has an `int` field, a `bool` field, and a
`string` field, and transforms the input into JSON format. `messageType` points to the fully
qualified name of the message being read, in this case `examples.descriptor.MyMessage`.
`descriptorUrl` points to the descriptor, a compiled version of the `.proto` schema previously
presented.

```dataweave
%dw 2.0
output application/json
input payload application/x-protobuf messageType='examples.descriptor.MyMessage',descriptorUrl="descriptors/examples.dsc"
---
payload
```

### Output

The DataWeave script outputs the following JSON object containing the three values.

```json
{
  "myInt": 42.0,
  "myBool": false,
  "myString": "DW <3 Proto"
}
```

## Protobuf Features

Protobuf supports the following features which are not common in other formats.

### Enumerations

[Protobuf enumerations](https://protobuf.dev/programming-guides/proto3/#enum), or enums, are read as
a `String` with a particular schema that specifies the enum index. When parsing a `proto` message,
the schema is used to extract the label of the enum value. If many labels share the same index, the
first one is used. If the index does not have a matching label, the special label `"-UNRECOGNIZED"`
is used. When writing a `proto` message, the schema specifies the protocol used to get the index
corresponding to the given label.

### Example: Use DataWeave to Write Protobuf Enumerations

The following example shows how to generate a `proto` message with some enum values, given a
particular schema.

#### Schema

The following schema specifies the protocol used in this example.

```protobuf
syntax = "proto3";

package examples.enumerations;


message Langs {
  enum Languages {
    DataWeave = 0;
    Scala = 2;
    Java = 343049039;
  }

  Languages okayLanguage = 10;
  Languages bestLanguage = 11;
}
```

#### Source

The DataWeave script outputs a Protobuf message containing `okayLanguage` and `bestLanguage` values.

```dataweave
%dw 2.0
output application/x-protobuf messageType='examples.enumerations.Langs',descriptorUrl="descriptors/examples.dsc"
---
{
  okayLanguage : "Scala",
  bestLanguage : "DataWeave"
}
```

#### Output

The DataWeave script outputs a Protobuf message with two fields specified with the encoded values.

### Example: Use DataWeave to Read Protobuf Enumerations

The following example shows how to read a `proto` message with some enum values, given a particular
schema, and what to expect when the value present in the message is not specified in the schema.

#### Schema

The following schema specifies the protocol used in this example.

```protobuf
syntax = "proto3";

package examples.enumerations;


message Langs {
  enum Languages {
    DataWeave = 0;
    Scala = 2;
    Java = 343049039;
  }

  Languages okayLanguage = 10;
  Languages bestLanguage = 11;
}
```

#### Input

The Protobuf message which serves as input payload to the DataWeave source is not shown since it’s
binary. It contains a `okayLanguage` field with enum index 3, an index not specified on the schema,
while the `bestLanguage` field has the expected value.

#### Source

The DataWeave script just reads a Protobuf message and outputs it as a DataWeave output.

```dataweave
%dw 2.0
input payload application/x-protobuf messageType='examples.enumerations.Langs',descriptorUrl="descriptors/examples.dsc"
output application/dw
---
payload
```

#### Output

The DataWeave script shows how the Protobuf message input is represented in the DataWeave (`dw`)
format.

```dataweave
{
  okayLanguage: "-UNRECOGNIZED" as String {protobufEnumIndex: 3},
  bestLanguage: "DataWeave" as String {protobufEnumIndex: 0},
}
```

### Oneof

[Oneof](https://protobuf.dev/programming-guides/proto3/#oneof) fields, a Protobuf particularity, are
represented as regular fields on DataWeave. When writing a `proto` message, a particular schema
specifies what the DataWeave script needs to validate. If more than one of the fields defined is
present, the script fails.

### Example: An Invalid Attempt to Write Two Exclusive Fields

The following example shows what happens when you try to write two exclusive fields according to the
schema.

#### Schema

The following schema specifies the protocol used in this example.

```protobuf
syntax = "proto3";

package examples.oneof;

message ThisOrThat {
  oneof thisOrThat {
    bool this = 2;
    bool that = 4;
  }
}
```

#### Source

The DataWeave script outputs a Protobuf message containing both `this` and `that` fields set.

```dataweave
%dw 2.0
output application/x-protobuf messageType='examples.oneof.ThisOrThat',descriptorUrl="descriptors/examples.dsc"
---
{
  this: true,
  that: false,
}
```

#### Output

The DataWeave script outputs a `ProtoBufWritingException` specifying which `oneof` is being wrongly
used.

### Repeated Fields

Since DataWeave admits repeated fields, Protobuf repeated fields are matched to DataWeave repeated
fields, and vice versa. Note that the DataWeave object being written has to match the schema being
used. If the schema does not specify a field as repeated and the DataWeave script has that field
more than once, the script fails.

### Example: Transform a JSON Array to a Protobuf Repeated Field

The following example shows how to generate a `proto` message with a repeated field obtained from a
JSON array.

#### Schema

The following schema specifies the protocol used in this example.

```protobuf
syntax = "proto3";
package examples.repeated;
message People {
  repeated string names = 1;
}
```

#### Input

The JSON input serves as the payload to the DataWeave source.

```json
{
  "names": ["Mariano", "Shoki", "Tomo", "Ana"]
}
```

#### Source

The DataWeave script uses the `reduce` function to generate a new field for each name in the array.

```dataweave
%dw 2.0
output application/x-protobuf messageType='examples.repeated.People',descriptorUrl="descriptors/examples.dsc"
---
reduce(payload.names, (item, acc = {}) ->  acc ++ {names: item})
```

#### Output

The DataWeave script outputs a Protobuf message with the repeated field containing all the names
from the JSON array.

### Example: Transform a Protobuf Repeated Field to a JSON Array

The following example shows how to transform a `proto` message with a repeated field to a JSON
array.

#### Schema

The following schema specifies the protocol used in this example.

```protobuf
syntax = "proto3";
package examples.repeated;
message People {
  repeated string names = 1;
}
```

#### Source

The DataWeave script outputs a JSON message containing an array of names.

```dataweave
%dw 2.0
input payload application/x-protobuf messageType='examples.repeated.People',descriptorUrl="descriptors/examples.dsc"
output application/json
---
names: payload.people.*names
```

#### Output

The DataWeave script outputs a JSON message containing an array of names.

```json
{
  "names": ["Mariano", "Shoki", "Tomo", "Ana"]
}
```

### Unknowns

Protobuf offers capabilities for forward and backward compatibility of protocols. In order to
achieve this, readers and writers accept
[unknown fields](https://protobuf.dev/programming-guides/proto3/#unknowns) on messages. DataWeave
adapts to this functionality by using certain key names.

When reading a Protobuf message, if a field not present in the schema is found, it is read into
something similar to `"-35": 111111 as Number {wireType: "Varint"},`, where `"-35"` means that the
field index is `35`, and `wireType: "Varint"` specifies the wire type the field has in the message.
The `wireType` can be `"Varint"`, `"64Bit"`, `"LengthDelimited"`, `"Group"`, or `"32Bit"`.

### Semantic Parsing (Or Commonly Used Message Types)

Protobuf offers a collection of
[commonly used message types](https://protobuf.dev/reference/protobuf/google.protobuf/). DataWeave
parses some of these as the value they represent instead of as the underlying message. For example,
a `google.protobuf.Duration` is read into DataWeave as a `Period`, while a
`google.protobuf.NullValue` is read as `Null`.

The following table describes the correspondence between Protobuf types and DataWeave types.

<table><colgroup><col> <col></colgroup><thead><tr><th>Protobuf type</th><th>DataWeave type</th></tr></thead><tbody><tr><td><p>BoolValue</p></td><td><p>Boolean</p></td></tr><tr><td><p>BytesValue</p></td><td><p>Binary</p></td></tr><tr><td><p>DoubleValue</p></td><td><p>Number</p></td></tr><tr><td><p>Duration</p></td><td><p>a Duration Period</p></td></tr><tr><td><p>Empty</p></td><td><p>{}</p></td></tr><tr><td><p>FloatValue</p></td><td><p>Number</p></td></tr><tr><td><p>Int32Value</p></td><td><p>Number</p></td></tr><tr><td><p>Int64Value</p></td><td><p>Number</p></td></tr><tr><td><p>ListValue</p></td><td><p>Array</p></td></tr><tr><td><p>NullValue</p></td><td><p>Null</p></td></tr><tr><td><p>StringValue</p></td><td><p>String</p></td></tr><tr><td><p>Struct</p></td><td><p>Object</p></td></tr><tr><td><p>Timestamp</p></td><td><p>LocalDateTime</p></td></tr><tr><td><p>UInt32Value</p></td><td><p>Number</p></td></tr><tr><td><p>UInt64Value</p></td><td><p>Number</p></td></tr><tr><td><p>Value</p></td><td><p>ProtoBufValue</p></td></tr></tbody></table>

Where:

```dataweave
type ProtoBufValue  = Null
                    | Number
                    | String
                    | Boolean
                    | { _?: ProtoBufValue }
                    | Array<ProtoBufValue>
```

### Maps

[Protobuf maps](https://protobuf.dev/programming-guides/proto3/#maps) enable you to have a structure
without a predefined set of keys, but with every field sharing the same value type. A
`map<keyType, valueType>` is mapped to a DataWeave object with the keys represented as strings and
the values mapped to their corresponding value. When writing a `proto` message, the key is casted to
the `keyType` specified on the descriptor. If it’s not possible to execute the cast, the script
fails.

## Compiling Schemas into Descriptors

DataWeave is not able to directly use `*.proto` files and expects an already compiled version called
descriptor. Generate descriptors by using the `protoc` compiler as in
`protoc --descriptor_set_out=./out.dsc file1.proto file2.proto …​`, where `out.dsc` is the output
file for the descriptor (the one that DataWeave expects on the `descriptorUrl` property), while
`file1.proto` and `file2.proto` are the actual protocol specifications that the descriptor needs to
compile.

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>descriptorUrl</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>''</code></p></td><td><div><div><p>The URL for the ProtoBuf descriptor. Valid values are <code>classpath://</code>, <code>file://</code>, or <code>http://</code>.</p></div></div></td></tr><tr><td><p><code>messageType</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The message type’s full name taken from the given descriptor, including the package where it’s located.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>descriptorUrl</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>''</code></p></td><td><div><div><p>The URL for the ProtoBuf descriptor. Valid values are <code>classpath://</code>, <code>file://</code>, or <code>http://</code>.</p></div></div></td></tr><tr><td><p><code>messageType</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The message type’s full name taken from the given descriptor, including the package where it’s located.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>application/protobuf</code></p></td></tr><tr><td><p><code>application/x-protobuf</code></p></td></tr></tbody></table>

<!-- document id=14e23a27a52452bc6263dca1c1287f2b93d395a16a870d4f3b4be7af996fb958 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-formats-protobuf.md -->

---
product: DataWeave
version: 2.9
keywords: format, protobuf, application/protobuf, application/x-protobuf, application/protobuf
---

# Protobuf Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/protobuf`

ID: `protobuf`

Protobuf is a data format that can be mapped to DataWeave values natively. From a user perspective,
always specify the location of the descriptor file and the fully qualified name of the message for
DataWeave to read or write. When specifying the configuration properties, use the `descriptorUrl`
and the `messageType` properties, respectively.

## Example: Specify the Descriptor when Reading a Protobuf Message

The following example shows how to specify the descriptor location and the message type to parse a
Protobuf message and transform it into JSON.

### Schema

The following schema specifies the protocol used in this example.

```protobuf
syntax = "proto3";

package examples.descriptor;

message MyMessage {
  int32 myInt = 3;
  bool myBool = 13;
  string myString = 23;
}
```

### Input

The Protobuf message serves as input payload to the DataWeave source. It contains a `myInt` field
with the value `42`, a `myBool` field with the value `false`, and a `myString` field with the value
`DW + Proto`. We omit showing the Protobuf messages since their representation is not user-friendly.

### Source

The DataWeave script reads a Protobuf message that has an `int` field, a `bool` field, and a
`string` field, and transforms the input into JSON format. `messageType` points to the fully
qualified name of the message being read, in this case `examples.descriptor.MyMessage`.
`descriptorUrl` points to the descriptor, a compiled version of the `.proto` schema previously
presented.

```dataweave
%dw 2.0
output application/json
input payload application/x-protobuf messageType='examples.descriptor.MyMessage',descriptorUrl="descriptors/examples.dsc"
---
payload
```

### Output

The DataWeave script outputs the following JSON object containing the three values.

```json
{
  "myInt": 42.0,
  "myBool": false,
  "myString": "DW <3 Proto"
}
```

## Protobuf Features

Protobuf supports the following features which are not common in other formats.

### Enumerations

[Protobuf enumerations](https://protobuf.dev/programming-guides/proto3/#enum), or enums, are read as
a `String` with a particular schema that specifies the enum index. When parsing a `proto` message,
the schema is used to extract the label of the enum value. If many labels share the same index, the
first one is used. If the index does not have a matching label, the special label `"-UNRECOGNIZED"`
is used. When writing a `proto` message, the schema specifies the protocol used to get the index
corresponding to the given label.

### Example: Use DataWeave to Write Protobuf Enumerations

The following example shows how to generate a `proto` message with some enum values, given a
particular schema.

#### Schema

The following schema specifies the protocol used in this example.

```protobuf
syntax = "proto3";

package examples.enumerations;


message Langs {
  enum Languages {
    DataWeave = 0;
    Scala = 2;
    Java = 343049039;
  }

  Languages okayLanguage = 10;
  Languages bestLanguage = 11;
}
```

#### Source

The DataWeave script outputs a Protobuf message containing `okayLanguage` and `bestLanguage` values.

```dataweave
%dw 2.0
output application/x-protobuf messageType='examples.enumerations.Langs',descriptorUrl="descriptors/examples.dsc"
---
{
  okayLanguage : "Scala",
  bestLanguage : "DataWeave"
}
```

#### Output

The DataWeave script outputs a Protobuf message with two fields specified with the encoded values.

### Example: Use DataWeave to Read Protobuf Enumerations

The following example shows how to read a `proto` message with some enum values, given a particular
schema, and what to expect when the value present in the message is not specified in the schema.

#### Schema

The following schema specifies the protocol used in this example.

```protobuf
syntax = "proto3";

package examples.enumerations;


message Langs {
  enum Languages {
    DataWeave = 0;
    Scala = 2;
    Java = 343049039;
  }

  Languages okayLanguage = 10;
  Languages bestLanguage = 11;
}
```

#### Input

The Protobuf message which serves as input payload to the DataWeave source is not shown since it’s
binary. It contains a `okayLanguage` field with enum index 3, an index not specified on the schema,
while the `bestLanguage` field has the expected value.

#### Source

The DataWeave script just reads a Protobuf message and outputs it as a DataWeave output.

```dataweave
%dw 2.0
input payload application/x-protobuf messageType='examples.enumerations.Langs',descriptorUrl="descriptors/examples.dsc"
output application/dw
---
payload
```

#### Output

The DataWeave script shows how the Protobuf message input is represented in the DataWeave (`dw`)
format.

```dataweave
{
  okayLanguage: "-UNRECOGNIZED" as String {protobufEnumIndex: 3},
  bestLanguage: "DataWeave" as String {protobufEnumIndex: 0},
}
```

### Oneof

[Oneof](https://protobuf.dev/programming-guides/proto3/#oneof) fields, a Protobuf particularity, are
represented as regular fields on DataWeave. When writing a `proto` message, a particular schema
specifies what the DataWeave script needs to validate. If more than one of the fields defined is
present, the script fails.

### Example: An Invalid Attempt to Write Two Exclusive Fields

The following example shows what happens when you try to write two exclusive fields according to the
schema.

#### Schema

The following schema specifies the protocol used in this example.

```protobuf
syntax = "proto3";

package examples.oneof;

message ThisOrThat {
  oneof thisOrThat {
    bool this = 2;
    bool that = 4;
  }
}
```

#### Source

The DataWeave script outputs a Protobuf message containing both `this` and `that` fields set.

```dataweave
%dw 2.0
output application/x-protobuf messageType='examples.oneof.ThisOrThat',descriptorUrl="descriptors/examples.dsc"
---
{
  this: true,
  that: false,
}
```

#### Output

The DataWeave script outputs a `ProtoBufWritingException` specifying which `oneof` is being wrongly
used.

### Repeated Fields

Since DataWeave admits repeated fields, Protobuf repeated fields are matched to DataWeave repeated
fields, and vice versa. Note that the DataWeave object being written has to match the schema being
used. If the schema does not specify a field as repeated and the DataWeave script has that field
more than once, the script fails.

### Example: Transform a JSON Array to a Protobuf Repeated Field

The following example shows how to generate a `proto` message with a repeated field obtained from a
JSON array.

#### Schema

The following schema specifies the protocol used in this example.

```protobuf
syntax = "proto3";
package examples.repeated;
message People {
  repeated string names = 1;
}
```

#### Input

The JSON input serves as the payload to the DataWeave source.

```json
{
  "names": ["Mariano", "Shoki", "Tomo", "Ana"]
}
```

#### Source

The DataWeave script uses the `reduce` function to generate a new field for each name in the array.

```dataweave
%dw 2.0
output application/x-protobuf messageType='examples.repeated.People',descriptorUrl="descriptors/examples.dsc"
---
reduce(payload.names, (item, acc = {}) ->  acc ++ {names: item})
```

#### Output

The DataWeave script outputs a Protobuf message with the repeated field containing all the names
from the JSON array.

### Example: Transform a Protobuf Repeated Field to a JSON Array

The following example shows how to transform a `proto` message with a repeated field to a JSON
array.

#### Schema

The following schema specifies the protocol used in this example.

```protobuf
syntax = "proto3";
package examples.repeated;
message People {
  repeated string names = 1;
}
```

#### Source

The DataWeave script outputs a JSON message containing an array of names.

```dataweave
%dw 2.0
input payload application/x-protobuf messageType='examples.repeated.People',descriptorUrl="descriptors/examples.dsc"
output application/json
---
names: payload.people.*names
```

#### Output

The DataWeave script outputs a JSON message containing an array of names.

```json
{
  "names": ["Mariano", "Shoki", "Tomo", "Ana"]
}
```

### Unknowns

Protobuf offers capabilities for forward and backward compatibility of protocols. In order to
achieve this, readers and writers accept
[unknown fields](https://protobuf.dev/programming-guides/proto3/#unknowns) on messages. DataWeave
adapts to this functionality by using certain key names.

When reading a Protobuf message, if a field not present in the schema is found, it is read into
something similar to `"-35": 111111 as Number {wireType: "Varint"},`, where `"-35"` means that the
field index is `35`, and `wireType: "Varint"` specifies the wire type the field has in the message.
The `wireType` can be `"Varint"`, `"64Bit"`, `"LengthDelimited"`, `"Group"`, or `"32Bit"`.

### Semantic Parsing (Or Commonly Used Message Types)

Protobuf offers a collection of
[commonly used message types](https://protobuf.dev/reference/protobuf/google.protobuf/). DataWeave
parses some of these as the value they represent instead of as the underlying message. For example,
a `google.protobuf.Duration` is read into DataWeave as a `Period`, while a
`google.protobuf.NullValue` is read as `Null`.

The following table describes the correspondence between Protobuf types and DataWeave types.

<table><colgroup><col> <col></colgroup><thead><tr><th>Protobuf type</th><th>DataWeave type</th></tr></thead><tbody><tr><td><p>BoolValue</p></td><td><p>Boolean</p></td></tr><tr><td><p>BytesValue</p></td><td><p>Binary</p></td></tr><tr><td><p>DoubleValue</p></td><td><p>Number</p></td></tr><tr><td><p>Duration</p></td><td><p>a Duration Period</p></td></tr><tr><td><p>Empty</p></td><td><p>{}</p></td></tr><tr><td><p>FloatValue</p></td><td><p>Number</p></td></tr><tr><td><p>Int32Value</p></td><td><p>Number</p></td></tr><tr><td><p>Int64Value</p></td><td><p>Number</p></td></tr><tr><td><p>ListValue</p></td><td><p>Array</p></td></tr><tr><td><p>NullValue</p></td><td><p>Null</p></td></tr><tr><td><p>StringValue</p></td><td><p>String</p></td></tr><tr><td><p>Struct</p></td><td><p>Object</p></td></tr><tr><td><p>Timestamp</p></td><td><p>LocalDateTime</p></td></tr><tr><td><p>UInt32Value</p></td><td><p>Number</p></td></tr><tr><td><p>UInt64Value</p></td><td><p>Number</p></td></tr><tr><td><p>Value</p></td><td><p>ProtoBufValue</p></td></tr></tbody></table>

Where:

```dataweave
type ProtoBufValue  = Null
                    | Number
                    | String
                    | Boolean
                    | { _?: ProtoBufValue }
                    | Array<ProtoBufValue>
```

### Maps

[Protobuf maps](https://protobuf.dev/programming-guides/proto3/#maps) enable you to have a structure
without a predefined set of keys, but with every field sharing the same value type. A
`map<keyType, valueType>` is mapped to a DataWeave object with the keys represented as strings and
the values mapped to their corresponding value. When writing a `proto` message, the key is casted to
the `keyType` specified on the descriptor. If it’s not possible to execute the cast, the script
fails.

## Compiling Schemas into Descriptors

DataWeave is not able to directly use `*.proto` files and expects an already compiled version called
descriptor. Generate descriptors by using the `protoc` compiler as in
`protoc --descriptor_set_out=./out.dsc file1.proto file2.proto …​`, where `out.dsc` is the output
file for the descriptor (the one that DataWeave expects on the `descriptorUrl` property), while
`file1.proto` and `file2.proto` are the actual protocol specifications that the descriptor needs to
compile.

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>descriptorUrl</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>''</code></p></td><td><div><div><p>The URL for the ProtoBuf descriptor. Valid values are <code>classpath://</code>, <code>file://</code>, or <code>http://</code>.</p></div></div></td></tr><tr><td><p><code>messageType</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The message type’s full name taken from the given descriptor, including the package where it’s located.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>descriptorUrl</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>''</code></p></td><td><div><div><p>The URL for the ProtoBuf descriptor. Valid values are <code>classpath://</code>, <code>file://</code>, or <code>http://</code>.</p></div></div></td></tr><tr><td><p><code>messageType</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The message type’s full name taken from the given descriptor, including the package where it’s located.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>application/protobuf</code></p></td></tr><tr><td><p><code>application/x-protobuf</code></p></td></tr></tbody></table>

<!-- document id=27d91ac27a348b8cbe1f365cac672ebb6c89d58d629db5d1e5d4cbe11c7373dd url=/mulesoft/current/en-us/dataweave/latest/dataweave-formats-protobuf.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: format, protobuf, application/protobuf, application/x-protobuf, application/protobuf
---

# Protobuf Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/protobuf`

ID: `protobuf`

Protobuf is a data format that can be mapped to DataWeave values natively. From a user perspective,
always specify the location of the descriptor file and the fully qualified name of the message for
DataWeave to read or write. When specifying the configuration properties, use the `descriptorUrl`
and the `messageType` properties, respectively.

## Example: Specify the Descriptor when Reading a Protobuf Message

The following example shows how to specify the descriptor location and the message type to parse a
Protobuf message and transform it into JSON.

### Schema

The following schema specifies the protocol used in this example.

```protobuf
syntax = "proto3";

package examples.descriptor;

message MyMessage {
  int32 myInt = 3;
  bool myBool = 13;
  string myString = 23;
}
```

### Input

The Protobuf message serves as input payload to the DataWeave source. It contains a `myInt` field
with the value `42`, a `myBool` field with the value `false`, and a `myString` field with the value
`DW + Proto`. We omit showing the Protobuf messages since their representation is not user-friendly.

### Source

The DataWeave script reads a Protobuf message that has an `int` field, a `bool` field, and a
`string` field, and transforms the input into JSON format. `messageType` points to the fully
qualified name of the message being read, in this case `examples.descriptor.MyMessage`.
`descriptorUrl` points to the descriptor, a compiled version of the `.proto` schema previously
presented.

```dataweave
%dw 2.0
output application/json
input payload application/x-protobuf messageType='examples.descriptor.MyMessage',descriptorUrl="descriptors/examples.dsc"
---
payload
```

### Output

The DataWeave script outputs the following JSON object containing the three values.

```json
{
  "myInt": 42.0,
  "myBool": false,
  "myString": "DW <3 Proto"
}
```

## Protobuf Features

Protobuf supports the following features which are not common in other formats.

### Enumerations

[Protobuf enumerations](https://protobuf.dev/programming-guides/proto3/#enum), or enums, are read as
a `String` with a particular schema that specifies the enum index. When parsing a `proto` message,
the schema is used to extract the label of the enum value. If many labels share the same index, the
first one is used. If the index does not have a matching label, the special label `"-UNRECOGNIZED"`
is used. When writing a `proto` message, the schema specifies the protocol used to get the index
corresponding to the given label.

### Example: Use DataWeave to Write Protobuf Enumerations

The following example shows how to generate a `proto` message with some enum values, given a
particular schema.

#### Schema

The following schema specifies the protocol used in this example.

```protobuf
syntax = "proto3";

package examples.enumerations;


message Langs {
  enum Languages {
    DataWeave = 0;
    Scala = 2;
    Java = 343049039;
  }

  Languages okayLanguage = 10;
  Languages bestLanguage = 11;
}
```

#### Source

The DataWeave script outputs a Protobuf message containing `okayLanguage` and `bestLanguage` values.

```dataweave
%dw 2.0
output application/x-protobuf messageType='examples.enumerations.Langs',descriptorUrl="descriptors/examples.dsc"
---
{
  okayLanguage : "Scala",
  bestLanguage : "DataWeave"
}
```

#### Output

The DataWeave script outputs a Protobuf message with two fields specified with the encoded values.

### Example: Use DataWeave to Read Protobuf Enumerations

The following example shows how to read a `proto` message with some enum values, given a particular
schema, and what to expect when the value present in the message is not specified in the schema.

#### Schema

The following schema specifies the protocol used in this example.

```protobuf
syntax = "proto3";

package examples.enumerations;


message Langs {
  enum Languages {
    DataWeave = 0;
    Scala = 2;
    Java = 343049039;
  }

  Languages okayLanguage = 10;
  Languages bestLanguage = 11;
}
```

#### Input

The Protobuf message which serves as input payload to the DataWeave source is not shown since it’s
binary. It contains a `okayLanguage` field with enum index 3, an index not specified on the schema,
while the `bestLanguage` field has the expected value.

#### Source

The DataWeave script just reads a Protobuf message and outputs it as a DataWeave output.

```dataweave
%dw 2.0
input payload application/x-protobuf messageType='examples.enumerations.Langs',descriptorUrl="descriptors/examples.dsc"
output application/dw
---
payload
```

#### Output

The DataWeave script shows how the Protobuf message input is represented in the DataWeave (`dw`)
format.

```dataweave
{
  okayLanguage: "-UNRECOGNIZED" as String {protobufEnumIndex: 3},
  bestLanguage: "DataWeave" as String {protobufEnumIndex: 0},
}
```

### Oneof

[Oneof](https://protobuf.dev/programming-guides/proto3/#oneof) fields, a Protobuf particularity, are
represented as regular fields on DataWeave. When writing a `proto` message, a particular schema
specifies what the DataWeave script needs to validate. If more than one of the fields defined is
present, the script fails.

### Example: An Invalid Attempt to Write Two Exclusive Fields

The following example shows what happens when you try to write two exclusive fields according to the
schema.

#### Schema

The following schema specifies the protocol used in this example.

```protobuf
syntax = "proto3";

package examples.oneof;

message ThisOrThat {
  oneof thisOrThat {
    bool this = 2;
    bool that = 4;
  }
}
```

#### Source

The DataWeave script outputs a Protobuf message containing both `this` and `that` fields set.

```dataweave
%dw 2.0
output application/x-protobuf messageType='examples.oneof.ThisOrThat',descriptorUrl="descriptors/examples.dsc"
---
{
  this: true,
  that: false,
}
```

#### Output

The DataWeave script outputs a `ProtoBufWritingException` specifying which `oneof` is being wrongly
used.

### Repeated Fields

Since DataWeave admits repeated fields, Protobuf repeated fields are matched to DataWeave repeated
fields, and vice versa. Note that the DataWeave object being written has to match the schema being
used. If the schema does not specify a field as repeated and the DataWeave script has that field
more than once, the script fails.

### Example: Transform a JSON Array to a Protobuf Repeated Field

The following example shows how to generate a `proto` message with a repeated field obtained from a
JSON array.

#### Schema

The following schema specifies the protocol used in this example.

```protobuf
syntax = "proto3";
package examples.repeated;
message People {
  repeated string names = 1;
}
```

#### Input

The JSON input serves as the payload to the DataWeave source.

```json
{
  "names": ["Mariano", "Shoki", "Tomo", "Ana"]
}
```

#### Source

The DataWeave script uses the `reduce` function to generate a new field for each name in the array.

```dataweave
%dw 2.0
output application/x-protobuf messageType='examples.repeated.People',descriptorUrl="descriptors/examples.dsc"
---
reduce(payload.names, (item, acc = {}) ->  acc ++ {names: item})
```

#### Output

The DataWeave script outputs a Protobuf message with the repeated field containing all the names
from the JSON array.

### Example: Transform a Protobuf Repeated Field to a JSON Array

The following example shows how to transform a `proto` message with a repeated field to a JSON
array.

#### Schema

The following schema specifies the protocol used in this example.

```protobuf
syntax = "proto3";
package examples.repeated;
message People {
  repeated string names = 1;
}
```

#### Source

The DataWeave script outputs a JSON message containing an array of names.

```dataweave
%dw 2.0
input payload application/x-protobuf messageType='examples.repeated.People',descriptorUrl="descriptors/examples.dsc"
output application/json
---
names: payload.people.*names
```

#### Output

The DataWeave script outputs a JSON message containing an array of names.

```json
{
  "names": ["Mariano", "Shoki", "Tomo", "Ana"]
}
```

### Unknowns

Protobuf offers capabilities for forward and backward compatibility of protocols. In order to
achieve this, readers and writers accept
[unknown fields](https://protobuf.dev/programming-guides/proto3/#unknowns) on messages. DataWeave
adapts to this functionality by using certain key names.

When reading a Protobuf message, if a field not present in the schema is found, it is read into
something similar to `"-35": 111111 as Number {wireType: "Varint"},`, where `"-35"` means that the
field index is `35`, and `wireType: "Varint"` specifies the wire type the field has in the message.
The `wireType` can be `"Varint"`, `"64Bit"`, `"LengthDelimited"`, `"Group"`, or `"32Bit"`.

### Semantic Parsing (Or Commonly Used Message Types)

Protobuf offers a collection of
[commonly used message types](https://protobuf.dev/reference/protobuf/google.protobuf/). DataWeave
parses some of these as the value they represent instead of as the underlying message. For example,
a `google.protobuf.Duration` is read into DataWeave as a `Period`, while a
`google.protobuf.NullValue` is read as `Null`.

The following table describes the correspondence between Protobuf types and DataWeave types.

<table><colgroup><col> <col></colgroup><thead><tr><th>Protobuf type</th><th>DataWeave type</th></tr></thead><tbody><tr><td><p>BoolValue</p></td><td><p>Boolean</p></td></tr><tr><td><p>BytesValue</p></td><td><p>Binary</p></td></tr><tr><td><p>DoubleValue</p></td><td><p>Number</p></td></tr><tr><td><p>Duration</p></td><td><p>a Duration Period</p></td></tr><tr><td><p>Empty</p></td><td><p>{}</p></td></tr><tr><td><p>FloatValue</p></td><td><p>Number</p></td></tr><tr><td><p>Int32Value</p></td><td><p>Number</p></td></tr><tr><td><p>Int64Value</p></td><td><p>Number</p></td></tr><tr><td><p>ListValue</p></td><td><p>Array</p></td></tr><tr><td><p>NullValue</p></td><td><p>Null</p></td></tr><tr><td><p>StringValue</p></td><td><p>String</p></td></tr><tr><td><p>Struct</p></td><td><p>Object</p></td></tr><tr><td><p>Timestamp</p></td><td><p>LocalDateTime</p></td></tr><tr><td><p>UInt32Value</p></td><td><p>Number</p></td></tr><tr><td><p>UInt64Value</p></td><td><p>Number</p></td></tr><tr><td><p>Value</p></td><td><p>ProtoBufValue</p></td></tr></tbody></table>

Where:

```dataweave
type ProtoBufValue  = Null
                    | Number
                    | String
                    | Boolean
                    | { _?: ProtoBufValue }
                    | Array<ProtoBufValue>
```

### Maps

[Protobuf maps](https://protobuf.dev/programming-guides/proto3/#maps) enable you to have a structure
without a predefined set of keys, but with every field sharing the same value type. A
`map<keyType, valueType>` is mapped to a DataWeave object with the keys represented as strings and
the values mapped to their corresponding value. When writing a `proto` message, the key is casted to
the `keyType` specified on the descriptor. If it’s not possible to execute the cast, the script
fails.

## Compiling Schemas into Descriptors

DataWeave is not able to directly use `*.proto` files and expects an already compiled version called
descriptor. Generate descriptors by using the `protoc` compiler as in
`protoc --descriptor_set_out=./out.dsc file1.proto file2.proto …​`, where `out.dsc` is the output
file for the descriptor (the one that DataWeave expects on the `descriptorUrl` property), while
`file1.proto` and `file2.proto` are the actual protocol specifications that the descriptor needs to
compile.

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>descriptorUrl</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>''</code></p></td><td><div><div><p>The URL for the ProtoBuf descriptor. Valid values are <code>classpath://</code>, <code>file://</code>, or <code>http://</code>.</p></div></div></td></tr><tr><td><p><code>messageType</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The message type’s full name taken from the given descriptor, including the package where it’s located.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>descriptorUrl</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>''</code></p></td><td><div><div><p>The URL for the ProtoBuf descriptor. Valid values are <code>classpath://</code>, <code>file://</code>, or <code>http://</code>.</p></div></div></td></tr><tr><td><p><code>messageType</code> (Required)</p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The message type’s full name taken from the given descriptor, including the package where it’s located.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>application/protobuf</code></p></td></tr><tr><td><p><code>application/x-protobuf</code></p></td></tr></tbody></table>

<!-- document id=123331ad51cd6d5bc2e9643be76a12d246f5f2032eeb2f43be3ffb31e7a6d1a9 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-random.md -->

---
product: DataWeave
version: 2.11
---

# random

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## random(): Number

Returns a pseudo-random number greater than or equal to `0.0` and less than `1.0`.

### Example

This example generates a pseudo-random number and multiplies it by 1000.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ price: random() * 1000 }
```

#### Output

```JSON
{ "price": 65.02770292248383 }
```

<!-- document id=541fc1d5f1b5f014119e247adc21fbadc084e53ea4396716b9f177c51715a0af url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-random.md -->

---
product: DataWeave
version: 2.12
---

# random

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## random(): Number

Returns a pseudo-random number greater than or equal to `0.0` and less than `1.0`.

### Example

This example generates a pseudo-random number and multiplies it by 1000.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ price: random() * 1000 }
```

#### Output

```JSON
{ "price": 65.02770292248383 }
```

<!-- document id=d0349666c2c08dd0acd1645131aa3a35151b88a26b41dc0bc57481d97fc6c19b url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-random.md -->

---
product: DataWeave
version: 2.3
---

# random

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## random(): Number

Returns a pseudo-random number greater than or equal to `0.0` and less than `1.0`.

### Example

This example generates a pseudo-random number and multiplies it by 1000.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ price: random() * 1000 }
```

#### Output

```JSON
{ "price": 65.02770292248383 }
```

<!-- document id=74ed08601edbe0922e96121053f946b84270ab76cefea244db94aa90e8d272db url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-random.md -->

---
product: DataWeave
version: 2.4
---

# random

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## random(): Number

Returns a pseudo-random number greater than or equal to `0.0` and less than `1.0`.

### Example

This example generates a pseudo-random number and multiplies it by 1000.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ price: random() * 1000 }
```

#### Output

```JSON
{ "price": 65.02770292248383 }
```

<!-- document id=a4cb4ee8c5940b0aefc579c0fe9b72c949bd64318a7097c9cdf7cfb40d16d1bd url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-random.md -->

---
product: DataWeave
version: 2.6
---

# random

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## random(): Number

Returns a pseudo-random number greater than or equal to `0.0` and less than `1.0`.

### Example

This example generates a pseudo-random number and multiplies it by 1000.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ price: random() * 1000 }
```

#### Output

```JSON
{ "price": 65.02770292248383 }
```

<!-- document id=bd37f34925e9007249206cf402f252f6963ebc3ccc74dfa43f4b00936e1d2ba6 url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-random.md -->

---
product: DataWeave
version: 2.9
---

# random

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## random(): Number

Returns a pseudo-random number greater than or equal to `0.0` and less than `1.0`.

### Example

This example generates a pseudo-random number and multiplies it by 1000.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ price: random() * 1000 }
```

#### Output

```JSON
{ "price": 65.02770292248383 }
```

<!-- document id=f0c2ef1a3139ff81c1b7c6e99d0d244e1459f3b0feb43d73fd8455c46ae75464 url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-random.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# random

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## random(): Number

Returns a pseudo-random number greater than or equal to `0.0` and less than `1.0`.

### Example

This example generates a pseudo-random number and multiplies it by 1000.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ price: random() * 1000 }
```

#### Output

```JSON
{ "price": 65.02770292248383 }
```

<!-- document id=418494fd6051598bbc72737a3f52adb10788b2f8a58dd0542ee4b94cc90e9455 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-randomint.md -->

---
product: DataWeave
version: 2.11
---

# randomInt

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## randomInt(upperBound: Number): Number

Returns a pseudo-random whole number from `0` to the specified number (exclusive).

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>upperBound</code></p></td><td><p>A number that sets the upper bound of the random number.</p></td></tr></tbody></table>

### Example

This example returns an integer from 0 to 1000 (exclusive).

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ price: randomInt(1000) }
```

#### Output

```JSON
{ "price": 442.0 }
```

<!-- document id=5ff5715a6789a611bc5bc07cbd5ce70622d44a92f3a6398744a22cb8125632e8 url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-randomint.md -->

---
product: DataWeave
version: 2.12
---

# randomInt

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## randomInt(upperBound: Number): Number

Returns a pseudo-random whole number from `0` to the specified number (exclusive).

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>upperBound</code></p></td><td><p>A number that sets the upper bound of the random number.</p></td></tr></tbody></table>

### Example

This example returns an integer from 0 to 1000 (exclusive).

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ price: randomInt(1000) }
```

#### Output

```JSON
{ "price": 442.0 }
```

<!-- document id=fb94edfe600f91db7f4a3a851ead3510b6572dc8bacc079f93fb19e58965517e url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-randomint.md -->

---
product: DataWeave
version: 2.3
---

# randomInt

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## randomInt(Number): Number

Returns a pseudo-random whole number from `0` to the specified number (exclusive).

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>upperBound</code></p></td><td><p>A number that sets the upper bound of the random number.</p></td></tr></tbody></table>

### Example

This example returns an integer from 0 to 1000 (exclusive).

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ price: randomInt(1000) }
```

#### Output

```JSON
{ "price": 442.0 }
```

<!-- document id=e7e641ce4c1963fa5b6e3d1823351671d414a697406381070fb477035cb65bb4 url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-randomint.md -->

---
product: DataWeave
version: 2.4
---

# randomInt

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## randomInt(upperBound: Number): Number

Returns a pseudo-random whole number from `0` to the specified number (exclusive).

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>upperBound</code></p></td><td><p>A number that sets the upper bound of the random number.</p></td></tr></tbody></table>

### Example

This example returns an integer from 0 to 1000 (exclusive).

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ price: randomInt(1000) }
```

#### Output

```JSON
{ "price": 442.0 }
```

<!-- document id=e37ac06e4c6cf078b59672b6ced8e0b763c9a01fa6465a3d47f44c5d7a45fbf3 url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-randomint.md -->

---
product: DataWeave
version: 2.6
---

# randomInt

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## randomInt(upperBound: Number): Number

Returns a pseudo-random whole number from `0` to the specified number (exclusive).

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>upperBound</code></p></td><td><p>A number that sets the upper bound of the random number.</p></td></tr></tbody></table>

### Example

This example returns an integer from 0 to 1000 (exclusive).

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ price: randomInt(1000) }
```

#### Output

```JSON
{ "price": 442.0 }
```

<!-- document id=b9fdec9a5d3ad7a67406e08fc1de43921de6907f521ed0e6948ef5cc1d7f8db8 url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-randomint.md -->

---
product: DataWeave
version: 2.9
---

# randomInt

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## randomInt(upperBound: Number): Number

Returns a pseudo-random whole number from `0` to the specified number (exclusive).

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>upperBound</code></p></td><td><p>A number that sets the upper bound of the random number.</p></td></tr></tbody></table>

### Example

This example returns an integer from 0 to 1000 (exclusive).

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ price: randomInt(1000) }
```

#### Output

```JSON
{ "price": 442.0 }
```

<!-- document id=99dbd2f5db1d3a665829b92eb97e82357e357e4ff5f3b25a81a08367aed080b2 url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-randomint.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# randomInt

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## randomInt(upperBound: Number): Number

Returns a pseudo-random whole number from `0` to the specified number (exclusive).

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>upperBound</code></p></td><td><p>A number that sets the upper bound of the random number.</p></td></tr></tbody></table>

### Example

This example returns an integer from 0 to 1000 (exclusive).

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ price: randomInt(1000) }
```

#### Output

```JSON
{ "price": 442.0 }
```

<!-- document id=e49ecccc0ccf35ab913b1add9a9d0c0f637076846d8b494bccfe5cdffc8733f8 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-read.md -->

---
product: DataWeave
version: 2.11
---

# read

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## read(stringToParse: String | Binary, contentType: String = "application/dw", readerProperties: Object = {}): Any

Reads a string or binary and returns parsed content.

This function can be useful if the reader cannot determine the content type by default.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>stringToParse</code></p></td><td><p>The string or binary to read.</p></td></tr><tr><td><p><code>contentType</code></p></td><td><p>A supported format (or content type). Default: <code>application/dw</code>.</p></td></tr><tr><td><p><code>readerProperties</code></p></td><td><p>Optional: Sets reader configuration properties. For other formats and reader configuration properties, see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats">Supported Data Formats</a>.</p></td></tr></tbody></table>

### Example

This example reads a JSON object `{ "hello" : "world" }'`, and it uses the `"application/json"`
argument to indicate _input_ content type. By contrast, the `output application/xml` directive in
the header of the script tells the script to transform the JSON content into XML output. Notice that
the XML output uses `hello` as the root XML element and `world` as the value of that element. The
`hello` in the XML corresponds to the key `"hello"` in the JSON object, and `world` corresponds to
the JSON value `"world"`.

#### Source

```dw
%dw 2.0
output application/xml
---
read('{ "hello" : "world" }','application/json')
```

#### Output

```JSON
<?xml version='1.0' encoding='UTF-8'?><hello>world</hello>
```

### Example

This example reads a string as a CSV format without a header and transforms it to JSON. Notice that
it adds column names as keys to the output object. Also, it appends `[0]` to the function call here
to select the first index of the resulting array, which avoids producing the results within an array
(with square brackets surrounding the entire output object).

#### Source

```DataWeave
%dw 2.0
var myVar = "Some, Body"
output application/json
---
read(myVar,"application/csv",{header:false})[0]
```

#### Output

```JSON
{ "column_0": "Some", "column_1": " Body" }
```

### Example

This example reads the specified XML and shows the syntax for a reader property, in this case,
`{ indexedReader: "false" }`.

#### Source

```DataWeave
%dw 2.0
output application/xml
---
{
   "XML" : read("<prices><basic>9.99</basic></prices>",
                "application/xml",
                { indexedReader: "false" })."prices"
}
```

#### Output

```XML
<?xml version='1.0' encoding='UTF-8'?>
<XML>
  <basic>9.99</basic>
</XML>
```

<!-- document id=a0c8873e52d13f75261238258fa21adb4216b908124c8676ac4a0e00b595daa1 url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-read.md -->

---
product: DataWeave
version: 2.12
---

# read

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## read(stringToParse: String | Binary, contentType: String = "application/dw", readerProperties: Object = {}): Any

Reads a string or binary and returns parsed content.

This function can be useful if the reader cannot determine the content type by default.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>stringToParse</code></p></td><td><p>The string or binary to read.</p></td></tr><tr><td><p><code>contentType</code></p></td><td><p>A supported format (or content type). Default: <code>application/dw</code>.</p></td></tr><tr><td><p><code>readerProperties</code></p></td><td><p>Optional: Sets reader configuration properties. For other formats and reader configuration properties, see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats">Supported Data Formats</a>.</p></td></tr></tbody></table>

### Example

This example reads a JSON object `{ "hello" : "world" }'`, and it uses the `"application/json"`
argument to indicate _input_ content type. By contrast, the `output application/xml` directive in
the header of the script tells the script to transform the JSON content into XML output. Notice that
the XML output uses `hello` as the root XML element and `world` as the value of that element. The
`hello` in the XML corresponds to the key `"hello"` in the JSON object, and `world` corresponds to
the JSON value `"world"`.

#### Source

```dw
%dw 2.0
output application/xml
---
read('{ "hello" : "world" }','application/json')
```

#### Output

```JSON
<?xml version='1.0' encoding='UTF-8'?><hello>world</hello>
```

### Example

This example reads a string as a CSV format without a header and transforms it to JSON. Notice that
it adds column names as keys to the output object. Also, it appends `[0]` to the function call here
to select the first index of the resulting array, which avoids producing the results within an array
(with square brackets surrounding the entire output object).

#### Source

```DataWeave
%dw 2.0
var myVar = "Some, Body"
output application/json
---
read(myVar,"application/csv",{header:false})[0]
```

#### Output

```JSON
{ "column_0": "Some", "column_1": " Body" }
```

### Example

This example reads the specified XML and shows the syntax for a reader property, in this case,
`{ indexedReader: "false" }`.

#### Source

```DataWeave
%dw 2.0
output application/xml
---
{
   "XML" : read("<prices><basic>9.99</basic></prices>",
                "application/xml",
                { indexedReader: "false" })."prices"
}
```

#### Output

```XML
<?xml version='1.0' encoding='UTF-8'?>
<XML>
  <basic>9.99</basic>
</XML>
```

<!-- document id=3cda66008e2747cfd43be703388520df71b222cada8f7e94e749a214f67c5d5e url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-read.md -->

---
product: DataWeave
version: 2.3
---

# read

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## read(String | Binary, String, Object): Any

Reads a string or binary and returns parsed content.

This function can be useful if the reader cannot determine the content type by default.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>stringToParse</code></p></td><td><p>The string or binary to read.</p></td></tr><tr><td><p><code>contentType</code></p></td><td><p>A supported format (or content type). Default: <code>application/dw</code>.</p></td></tr><tr><td><p><code>readerProperties</code></p></td><td><p>Optional: Sets reader configuration properties. For other formats and reader configuration properties, see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats">Supported Data Formats</a>.</p></td></tr></tbody></table>

### Example

This example reads a JSON object `{ "hello" : "world" }'`, and it uses the `"application/json"`
argument to indicate _input_ content type. By contrast, the `output application/xml` directive in
the header of the script tells the script to transform the JSON content into XML output. Notice that
the XML output uses `hello` as the root XML element and `world` as the value of that element. The
`hello` in the XML corresponds to the key `"hello"` in the JSON object, and `world` corresponds to
the JSON value `"world"`.

#### Source

```dw
%dw 2.0
output application/xml
---
read('{ "hello" : "world" }','application/json')
```

#### Output

```JSON
<?xml version='1.0' encoding='UTF-8'?><hello>world</hello>
```

### Example

This example reads a string as a CSV format without a header and transforms it to JSON. Notice that
it adds column names as keys to the output object. Also, it appends `[0]` to the function call here
to select the first index of the resulting array, which avoids producing the results within an array
(with square brackets surrounding the entire output object).

#### Source

%dw 2.0 var myVar = "Some, Body" output application/json
---

read(myVar,"application/csv",{header:false})\[0\]

#### Output

```JSON
{ "column_0": "Some", "column_1": " Body" }
```

### Example

This example reads the specified XML and shows the syntax for a reader property, in this case,
`{ indexedReader: "false" }`.

#### Source

```DataWeave
%dw 2.0
output application/xml
---
{
   "XML" : read("<prices><basic>9.99</basic></prices>",
                "application/xml",
                { indexedReader: "false" })."prices"
}
```

#### Output

```XML
<?xml version='1.0' encoding='UTF-8'?>
<XML>
  <basic>9.99</basic>
</XML>
```

### Example

This example returns the input parameter if it is in XML or JSON format, otherwise, it returns the
message `Not XML or JSON`. The example uses the `read` function to verify if the specified input
string is in XML or JSON.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
output application/dw
var xmlInput = "<Input><name>Max the Mule</name><ID>123</ID><Type>XML</Type></Input>"
var jsonInput = '{"Input": {"name": "Max the Mule", "ID": 123, "Type": "JSON"}}'
var stringInput = "name: Max the Mule, ID: 123, Type: String"
//This function returns the input parameter if it is in XML or JSON format, otherwise, it returns a static message
fun testType(inputMessage) =
    // Reads the input only if the data is in JSON format
    try(() -> read(inputMessage,"application/json"))
    // Reads the input only if the data is in XML format
    orElseTry(() -> read(inputMessage,"application/xml"))
    // Return this message if the input data is not either in XML or JSON format
    orElse("Not XML or JSON")
---
{
    "Test 'xmlInput' ": testType(xmlInput),
    "Test 'jsonInput' ": testType(jsonInput),
    "Test 'stringInput' ": testType(stringInput),
}
```

#### Output

```dataweave
{
  "Test 'xmlInput' ": {
    Input: {
      name: "Max the Mule",
      ID: "123",
      Type: "XML"
    }
  },
  "Test 'jsonInput' ": {
    Input: {
      name: "Max the Mule",
      ID: 123,
      Type: "JSON"
    }
  },
  "Test 'stringInput' ": "Not XML or JSON"
}
```

<!-- document id=c2c5e88e14007de4f04cafd01e1bb36330c32f2617803f371064b6abecf9833c url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-read.md -->

---
product: DataWeave
version: 2.4
---

# read

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## read(stringToParse: String | Binary, contentType: String = "application/dw", readerProperties: Object = {}): Any

Reads a string or binary and returns parsed content.

This function can be useful if the reader cannot determine the content type by default.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>stringToParse</code></p></td><td><p>The string or binary to read.</p></td></tr><tr><td><p><code>contentType</code></p></td><td><p>A supported format (or content type). Default: <code>application/dw</code>.</p></td></tr><tr><td><p><code>readerProperties</code></p></td><td><p>Optional: Sets reader configuration properties. For other formats and reader configuration properties, see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats">Supported Data Formats</a>.</p></td></tr></tbody></table>

### Example

This example reads a JSON object `{ "hello" : "world" }'`, and it uses the `"application/json"`
argument to indicate _input_ content type. By contrast, the `output application/xml` directive in
the header of the script tells the script to transform the JSON content into XML output. Notice that
the XML output uses `hello` as the root XML element and `world` as the value of that element. The
`hello` in the XML corresponds to the key `"hello"` in the JSON object, and `world` corresponds to
the JSON value `"world"`.

#### Source

```dw
%dw 2.0
output application/xml
---
read('{ "hello" : "world" }','application/json')
```

#### Output

```JSON
<?xml version='1.0' encoding='UTF-8'?><hello>world</hello>
```

### Example

This example reads a string as a CSV format without a header and transforms it to JSON. Notice that
it adds column names as keys to the output object. Also, it appends `[0]` to the function call here
to select the first index of the resulting array, which avoids producing the results within an array
(with square brackets surrounding the entire output object).

#### Source

```DataWeave
%dw 2.0
var myVar = "Some, Body"
output application/json
---
read(myVar,"application/csv",{header:false})[0]
```

#### Output

```JSON
{ "column_0": "Some", "column_1": " Body" }
```

### Example

This example reads the specified XML and shows the syntax for a reader property, in this case,
`{ indexedReader: "false" }`.

#### Source

```DataWeave
%dw 2.0
output application/xml
---
{
   "XML" : read("<prices><basic>9.99</basic></prices>",
                "application/xml",
                { indexedReader: "false" })."prices"
}
```

#### Output

```XML
<?xml version='1.0' encoding='UTF-8'?>
<XML>
  <basic>9.99</basic>
</XML>
```

<!-- document id=3e6a76ca4e1c6d4cee04b1fdc8abb5a402db3cbfaf59f141c54917fff05911c6 url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-read.md -->

---
product: DataWeave
version: 2.6
---

# read

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## read(stringToParse: String | Binary, contentType: String = "application/dw", readerProperties: Object = {}): Any

Reads a string or binary and returns parsed content.

This function can be useful if the reader cannot determine the content type by default.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>stringToParse</code></p></td><td><p>The string or binary to read.</p></td></tr><tr><td><p><code>contentType</code></p></td><td><p>A supported format (or content type). Default: <code>application/dw</code>.</p></td></tr><tr><td><p><code>readerProperties</code></p></td><td><p>Optional: Sets reader configuration properties. For other formats and reader configuration properties, see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats">Supported Data Formats</a>.</p></td></tr></tbody></table>

### Example

This example reads a JSON object `{ "hello" : "world" }'`, and it uses the `"application/json"`
argument to indicate _input_ content type. By contrast, the `output application/xml` directive in
the header of the script tells the script to transform the JSON content into XML output. Notice that
the XML output uses `hello` as the root XML element and `world` as the value of that element. The
`hello` in the XML corresponds to the key `"hello"` in the JSON object, and `world` corresponds to
the JSON value `"world"`.

#### Source

```dw
%dw 2.0
output application/xml
---
read('{ "hello" : "world" }','application/json')
```

#### Output

```JSON
<?xml version='1.0' encoding='UTF-8'?><hello>world</hello>
```

### Example

This example reads a string as a CSV format without a header and transforms it to JSON. Notice that
it adds column names as keys to the output object. Also, it appends `[0]` to the function call here
to select the first index of the resulting array, which avoids producing the results within an array
(with square brackets surrounding the entire output object).

#### Source

```DataWeave
%dw 2.0
var myVar = "Some, Body"
output application/json
---
read(myVar,"application/csv",{header:false})[0]
```

#### Output

```JSON
{ "column_0": "Some", "column_1": " Body" }
```

### Example

This example reads the specified XML and shows the syntax for a reader property, in this case,
`{ indexedReader: "false" }`.

#### Source

```DataWeave
%dw 2.0
output application/xml
---
{
   "XML" : read("<prices><basic>9.99</basic></prices>",
                "application/xml",
                { indexedReader: "false" })."prices"
}
```

#### Output

```XML
<?xml version='1.0' encoding='UTF-8'?>
<XML>
  <basic>9.99</basic>
</XML>
```

<!-- document id=b8a62536bea96c3f0f78a72630f5aecc8dbf459fb8b82064eedfe78008dc9e0c url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-read.md -->

---
product: DataWeave
version: 2.9
---

# read

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## read(stringToParse: String | Binary, contentType: String = "application/dw", readerProperties: Object = {}): Any

Reads a string or binary and returns parsed content.

This function can be useful if the reader cannot determine the content type by default.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>stringToParse</code></p></td><td><p>The string or binary to read.</p></td></tr><tr><td><p><code>contentType</code></p></td><td><p>A supported format (or content type). Default: <code>application/dw</code>.</p></td></tr><tr><td><p><code>readerProperties</code></p></td><td><p>Optional: Sets reader configuration properties. For other formats and reader configuration properties, see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats">Supported Data Formats</a>.</p></td></tr></tbody></table>

### Example

This example reads a JSON object `{ "hello" : "world" }'`, and it uses the `"application/json"`
argument to indicate _input_ content type. By contrast, the `output application/xml` directive in
the header of the script tells the script to transform the JSON content into XML output. Notice that
the XML output uses `hello` as the root XML element and `world` as the value of that element. The
`hello` in the XML corresponds to the key `"hello"` in the JSON object, and `world` corresponds to
the JSON value `"world"`.

#### Source

```dw
%dw 2.0
output application/xml
---
read('{ "hello" : "world" }','application/json')
```

#### Output

```JSON
<?xml version='1.0' encoding='UTF-8'?><hello>world</hello>
```

### Example

This example reads a string as a CSV format without a header and transforms it to JSON. Notice that
it adds column names as keys to the output object. Also, it appends `[0]` to the function call here
to select the first index of the resulting array, which avoids producing the results within an array
(with square brackets surrounding the entire output object).

#### Source

```DataWeave
%dw 2.0
var myVar = "Some, Body"
output application/json
---
read(myVar,"application/csv",{header:false})[0]
```

#### Output

```JSON
{ "column_0": "Some", "column_1": " Body" }
```

### Example

This example reads the specified XML and shows the syntax for a reader property, in this case,
`{ indexedReader: "false" }`.

#### Source

```DataWeave
%dw 2.0
output application/xml
---
{
   "XML" : read("<prices><basic>9.99</basic></prices>",
                "application/xml",
                { indexedReader: "false" })."prices"
}
```

#### Output

```XML
<?xml version='1.0' encoding='UTF-8'?>
<XML>
  <basic>9.99</basic>
</XML>
```

<!-- document id=188d9f99784de2971b80a559bd5771c96726471383b2040963a1de548f68d73e url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-read.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# read

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## read(stringToParse: String | Binary, contentType: String = "application/dw", readerProperties: Object = {}): Any

Reads a string or binary and returns parsed content.

This function can be useful if the reader cannot determine the content type by default.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>stringToParse</code></p></td><td><p>The string or binary to read.</p></td></tr><tr><td><p><code>contentType</code></p></td><td><p>A supported format (or content type). Default: <code>application/dw</code>.</p></td></tr><tr><td><p><code>readerProperties</code></p></td><td><p>Optional: Sets reader configuration properties. For other formats and reader configuration properties, see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats">Supported Data Formats</a>.</p></td></tr></tbody></table>

### Example

This example reads a JSON object `{ "hello" : "world" }'`, and it uses the `"application/json"`
argument to indicate _input_ content type. By contrast, the `output application/xml` directive in
the header of the script tells the script to transform the JSON content into XML output. Notice that
the XML output uses `hello` as the root XML element and `world` as the value of that element. The
`hello` in the XML corresponds to the key `"hello"` in the JSON object, and `world` corresponds to
the JSON value `"world"`.

#### Source

```dw
%dw 2.0
output application/xml
---
read('{ "hello" : "world" }','application/json')
```

#### Output

```JSON
<?xml version='1.0' encoding='UTF-8'?><hello>world</hello>
```

### Example

This example reads a string as a CSV format without a header and transforms it to JSON. Notice that
it adds column names as keys to the output object. Also, it appends `[0]` to the function call here
to select the first index of the resulting array, which avoids producing the results within an array
(with square brackets surrounding the entire output object).

#### Source

```DataWeave
%dw 2.0
var myVar = "Some, Body"
output application/json
---
read(myVar,"application/csv",{header:false})[0]
```

#### Output

```JSON
{ "column_0": "Some", "column_1": " Body" }
```

### Example

This example reads the specified XML and shows the syntax for a reader property, in this case,
`{ indexedReader: "false" }`.

#### Source

```DataWeave
%dw 2.0
output application/xml
---
{
   "XML" : read("<prices><basic>9.99</basic></prices>",
                "application/xml",
                { indexedReader: "false" })."prices"
}
```

#### Output

```XML
<?xml version='1.0' encoding='UTF-8'?>
<XML>
  <basic>9.99</basic>
</XML>
```

<!-- document id=15fa3213d93283119a54425e1c4be4367b8799ced678a2020716e1a50e1323e2 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook-flat-file-read-and-write.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, transform, transformer, format, xml, json, dataweave, data weave, datamapper, dwl, dfl, dw, flat file
---

# Read and Write a Flat File

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following examples show you how to read the contents of a flat file, and also how to write a
flat file following the specified schema. Each example consists of a Mule application that uses
DataWeave to read and write flat files.

When you work with flat files, configure the flat file schema to use for reading and writing flat
file content. The flat file schema defines the structure of a flat file, and this enables Mule to
write and read in this format.

These example applications are configured to work with the sample flat file data and the example
flat file schema provided in [Flat File Schemas](https://docs.mulesoft.com/dataweave/2.11/dataweave-flat-file-schemas#full_schema_ex).

## Example of Reading a Flat File

The following example application consists of:

1.  A Scheduler component that triggers the flow

2.  A File Read operation that reads a flat file from the specified path

3.  A Transform Message component that transforms the content read from the flat file to JSON format

4.  A Logger component that outputs the current payload

![A flow showing the process of reading and transforming a flat file to JSON](/mulesoft/current/en-us/dataweave/2.11/_images/mruntime-read-flat-file.png)

Application XML File

```xml
<mule xmlns:file="http://www.mulesoft.org/schema/mule/file"
  xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
  xmlns="http://www.mulesoft.org/schema/mule/core"
  xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
http://www.mulesoft.org/schema/mule/file http://www.mulesoft.org/schema/mule/file/current/mule-file.xsd">
  <file:config name="File_Config" doc:name="File Config" >
    <file:connection workingDir="${fileWorkingDir}" />
  </file:config>
  <configuration-properties doc:name="Configuration properties" file="flatfileconfig.properties" />
  <flow name="ReadFlatfileFlow" >
    <scheduler doc:name="Scheduler">
      <scheduling-strategy>
        <fixed-frequency frequency="10000" />
      </scheduling-strategy>
    </scheduler>
    <file:read doc:name="Read flat file" config-ref="File_Config"
    path="${fileReadPath}"
    outputMimeType='application/flatfile; schemapath=${schemaPath}'/> (1)
    <ee:transform doc:name="Transform to JSON"  >
      <ee:message >
        <ee:set-payload ><![CDATA[%dw 2.0
        output application/json
        ---
        payload]]>
        </ee:set-payload>
      </ee:message>
    </ee:transform>
    <logger level="INFO" doc:name="Logger" message='#["\n"]Reading flat file from: ${mule.home}/apps/${app.name}/${fileReadPath}#["\n"]#[payload]' />
  </flow>
</mule>
```

<table><tbody><tr><td><i data-value="1"></i><b>1</b></td><td>Note that the File Read operation configures the following attributes:<div><ul><li><p><code>path</code>: The path of the flat file to read</p></li><li><p><code>outputMimeType</code>: The output MIME type of the content, in this case, <code>application/flatfile</code></p></li><li><p><code>schemapath</code>: The reader property that specifies the path to the flat file schema (<code>.ffd</code> file)</p></li></ul></div></td></tr></tbody></table>

After its execution, the example application generates the following output:

```json
{
  "Batch": [
    {
      "TDR": [
        {
          "Record Type": "BAT",
          "Sequence Number": 2,
          "Amount": 32876,
          "Account Number": "0123456789",
          "Batch Function": "D",
          "Type": "CR"
        },
        {
          "Record Type": "BAT",
          "Sequence Number": 3,
          "Amount": 87326,
          "Account Number": "0123456788",
          "Batch Function": "D",
          "Type": "CR"
        }
      ],
      "BCF": {
        "Record Type": "BAT",
        "Sequence Number": 4,
        "Batch Transaction Count": 2,
        "Batch Transaction Amount": 120202,
        "Unique Batch Identifier": "A000000001",
        "Batch Function": "T",
        "Type": "CR"
      },
      "BCH": {
        "Record Type": "BAT",
        "Company Name": "ACME RESEARCH",
        "Sequence Number": 1,
        "Unique Batch Identifier": "A000000001",
        "Batch Function": "H"
      }
    },
    {
      "TDR": [
        {
          "Record Type": "BAT",
          "Sequence Number": 6,
          "Amount": 3582,
          "Account Number": "1234567890",
          "Batch Function": "D",
          "Type": "DB"
        },
        {
          "Record Type": "BAT",
          "Sequence Number": 7,
          "Amount": 256,
          "Account Number": "1234567891",
          "Batch Function": "D",
          "Type": "CR"
        }
      ],
      "BCF": {
        "Record Type": "BAT",
        "Sequence Number": 8,
        "Batch Transaction Count": 2,
        "Batch Transaction Amount": 3326,
        "Unique Batch Identifier": "A000000002",
        "Batch Function": "T",
        "Type": "DB"
      },
      "BCH": {
        "Record Type": "BAT",
        "Company Name": "AJAX EXPLOSIVES",
        "Sequence Number": 5,
        "Unique Batch Identifier": "A000000002",
        "Batch Function": "H"
      }
    }
  ],
  "RQF": {
    "Record Type": "RQF",
    "File Batch Count": 2,
    "File Transaction Count": 8,
    "File Transaction Amount": 116876,
    "Unique File Identifier": "A000000001",
    "Type": "CR"
  },
  "RQH": {
    "Record Type": "RQH",
    "File Creation Time": "10:10:00",
    "File Creation Date": "2018-09-01",
    "Currency": "USD",
    "Unique File Identifier": "A000000001"
  }
}
```

## Example of Writing a Flat File

The following example application contains:

1.  A Scheduler component that triggers the flow

2.  A File Read operation that reads a file containing the JSON output from the previous example

3.  A Transform Message component that transforms the JSON payload to the specified flat file format

4.  A Logger component that outputs the current payload

5.  A File Write operation that outputs the payload to a flat file in the specified target path

![A flow showing the process of writing a flat file](/mulesoft/current/en-us/dataweave/2.11/_images/mruntime-write-flat-file.png)

Application XML File

```xml
<mule xmlns:file="http://www.mulesoft.org/schema/mule/file"
  xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
  xmlns="http://www.mulesoft.org/schema/mule/core"
  xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
http://www.mulesoft.org/schema/mule/file http://www.mulesoft.org/schema/mule/file/current/mule-file.xsd">
  <file:config name="File_Config" doc:name="File Config" >
    <file:connection workingDir="${fileWorkingDir}" />
  </file:config>
  <configuration-properties doc:name="Configuration properties" file="flatfileconfig.properties" />
  <flow name="WriteFlatFile" >
    <scheduler doc:name="Scheduler" >
    	<scheduling-strategy >
        <fixed-frequency frequency="10000" />
    	</scheduling-strategy>
    </scheduler>
    <file:read doc:name="Read JSON file" config-ref="File_Config" path="${jsonFileReadPath}"/>
    <ee:transform doc:name="Transform to flat file"> (1)
    	<ee:message>
        <ee:set-payload><![CDATA[%dw 2.0
output application/flatfile schemaPath = "flatfileschema.ffd"
%dw 2.0
---
{
	RQH: {
		"Record Type": payload.RQH."Record Type",
		"File Creation Date": payload.RQH."File Creation Date" as Date {format: "yyyy-MM-dd"},
		"File Creation Time": payload.RQH."File Creation Time" as Time,
		"Unique File Identifier": payload.RQH."Unique File Identifier",
		Currency: payload.RQH.Currency
	},
	Batch: payload.Batch map ( batch , indexOfBatch ) -> {
		BCH: {
			"Record Type": batch.BCH."Record Type",
			"Sequence Number": batch.BCH."Sequence Number",
			"Batch Function": batch.BCH."Batch Function",
			"Company Name": batch.BCH."Company Name",
			"Unique Batch Identifier": batch.BCH."Unique Batch Identifier"},
		TDR: batch.TDR map (tdr, indexOfTdr) ->
			{
			"Record Type": tdr.TDR."Record Type",
			"Sequence Number": tdr.TDR."Sequence Number",
			"Batch Function": tdr.TDR."Batch Function",
			"Account Number": tdr.TDR."Account Number",
			"Amount": tdr.TDR.Amount,
			"Type": tdr.TDR.'Type'
			},
		BCF: {
			"Record Type": batch.BCF."Record Type",
			"Sequence Number": batch.BCF."Sequence Number",
			"Batch Function": batch.BCF."Batch Function",
			"Batch Transaction Amount": batch.BCF."Batch Transaction Amount",
			"Type": batch.BCF.'Type',
			"Batch Transaction Count": batch.BCF."Batch Transaction Count",
			"Unique Batch Identifier": batch.BCF."Unique Batch Identifier"}
		},
	RQF: {
		"Record Type": payload.RQF."Record Type",
		"File Batch Count": payload.RQF."File Batch Count",
		"File Transaction Count": payload.RQF."File Transaction Count",
		"File Transaction Amount": payload.RQF."File Transaction Amount",
		Type: payload.RQF.Type,
		"Unique File Identifier": payload.RQF."Unique File Identifier"
	}
}
]]>
      </ee:set-payload>
    	</ee:message>
    </ee:transform>
    <logger level="INFO" doc:name="Logger" message='#["\n"]Writing flat file to: ${mule.home}/apps/${app.name}/${fileWritePath}#["\n"]#[payload]'/>
    <file:write doc:name="Write flat file" config-ref="File_Config" path="${fileWritePath}" /> (2)
	</flow>
</mule>
```

<table><tbody><tr><td><i data-value="1"></i><b>1</b></td><td>Note that the Transform component specifies the following writer properties in the script header:<div><ul><li><p><code>output</code>: The output MIME type of the transformation, in this case, <code>application/flatfile</code></p></li><li><p><code>schemapath</code>: The writer property that specifies the path to the flat file schema (<code>.ffd</code> file)</p></li></ul></div></td></tr><tr><td><i data-value="2"></i><b>2</b></td><td>Note that the File Write operation specifies the <code>path</code> property to define where to write the flat file</td></tr></tbody></table>

After its execution, the example application generates the following output:

RQH201809011010A000000001USD BAT000001HACME RESEARCH A000000001 BAT000000D 0000000000 BAT000000D
0000000000 BAT000004T0000120202CR000002A000000001 BAT000005HAJAX EXPLOSIVES A000000002 BAT000000D
0000000000 BAT000000D 0000000000 BAT000008T0000003326DB000002A000000002
RQF0002000008000000116876CRA000000001

## Test the Examples Locally

If you want to test the examples locally, follow these steps to create and configure your example
Mule application:

1.  Create a new **Mule Project** in Anypoint Studio.

2.  Copy the XML code of the application you want to test into the **Configuration XML** view of
    your project.

3.  Use [Add Modules](https://docs.mulesoft.com/studio/add-modules-in-studio-to) to add the Anypoint Connector for File
    (File Connector) to your project.

4.  Create a file named `flatfileconfig.properties` in the `src/main/resources` folder of your Mule
    application, and set its content with the following properties:

    fileReadPath=flatfile schemaPath=flatfileschema.ffd fileWritePath=flatfilenew
    jsonFileReadPath=flatFileJson.json fileWorkingDir=#\["${mule.home}/apps/${app.name}/"\]

5.  Create a file named `flatfile` in the `src/main/resources` folder of your Mule application, and
    set its content with the
    [flat file sample data](https://docs.mulesoft.com/dataweave/2.11/%3Cdataweave-flat-file-schemas#flat-file-sample-data >) from the DataWeave
    flat file schema example.

6.  Create a file named `flatfileschema.ffd` in the `src/main/resources` folder of your Mule
    application, and set its content with the
    [full schema example](https://docs.mulesoft.com/dataweave/2.11/dataweave-flat-file-schemas#full_schema_ex) from the DataWeave flat file
    schema example.

7.  Create a file named `flatFileJson.json` in the `src/main/resources` folder of your Mule
    application and set its content with the
    [JSON transformation output](#json-transformation-output) from the example that reads a flat
    file.

## See Also

- [Flat File Format](https://docs.mulesoft.com/dataweave/2.11/dataweave-formats-flatfile)

- [Flat File Schemas](https://docs.mulesoft.com/dataweave/2.11/dataweave-flat-file-schemas)

- [Set Reader and Writer Properties](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-set-reader-writer-props)

- [Configure Properties](https://docs.mulesoft.com/mule-runtime/latest/configuring-properties)

<!-- document id=2b53f767cc6f3f297f2e26c7ad43498e2db3b8be3845b16da2ec819fcc249ec8 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook-flat-file-read-and-write.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, transform, transformer, format, xml, json, dataweave, data weave, datamapper, dwl, dfl, dw, flat file
---

# Read and Write a Flat File

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following examples show you how to read the contents of a flat file, and also how to write a
flat file following the specified schema. Each example consists of a Mule application that uses
DataWeave to read and write flat files.

When you work with flat files, configure the flat file schema to use for reading and writing flat
file content. The flat file schema defines the structure of a flat file, and this enables Mule to
write and read in this format.

These example applications are configured to work with the sample flat file data and the example
flat file schema provided in [Flat File Schemas](https://docs.mulesoft.com/dataweave/2.12/dataweave-flat-file-schemas#full_schema_ex).

## Example of Reading a Flat File

The following example application consists of:

1.  A Scheduler component that triggers the flow

2.  A File Read operation that reads a flat file from the specified path

3.  A Transform Message component that transforms the content read from the flat file to JSON format

4.  A Logger component that outputs the current payload

![A flow showing the process of reading and transforming a flat file to JSON](/mulesoft/current/en-us/dataweave/2.12/_images/mruntime-read-flat-file.png)

Application XML File

```xml
<mule xmlns:file="http://www.mulesoft.org/schema/mule/file"
  xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
  xmlns="http://www.mulesoft.org/schema/mule/core"
  xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
http://www.mulesoft.org/schema/mule/file http://www.mulesoft.org/schema/mule/file/current/mule-file.xsd">
  <file:config name="File_Config" doc:name="File Config" >
    <file:connection workingDir="${fileWorkingDir}" />
  </file:config>
  <configuration-properties doc:name="Configuration properties" file="flatfileconfig.properties" />
  <flow name="ReadFlatfileFlow" >
    <scheduler doc:name="Scheduler">
      <scheduling-strategy>
        <fixed-frequency frequency="10000" />
      </scheduling-strategy>
    </scheduler>
    <file:read doc:name="Read flat file" config-ref="File_Config"
    path="${fileReadPath}"
    outputMimeType='application/flatfile; schemapath=${schemaPath}'/> (1)
    <ee:transform doc:name="Transform to JSON"  >
      <ee:message >
        <ee:set-payload ><![CDATA[%dw 2.0
        output application/json
        ---
        payload]]>
        </ee:set-payload>
      </ee:message>
    </ee:transform>
    <logger level="INFO" doc:name="Logger" message='#["\n"]Reading flat file from: ${mule.home}/apps/${app.name}/${fileReadPath}#["\n"]#[payload]' />
  </flow>
</mule>
```

<table><tbody><tr><td><i data-value="1"></i><b>1</b></td><td>Note that the File Read operation configures the following attributes:<div><ul><li><p><code>path</code>: The path of the flat file to read</p></li><li><p><code>outputMimeType</code>: The output MIME type of the content, in this case, <code>application/flatfile</code></p></li><li><p><code>schemapath</code>: The reader property that specifies the path to the flat file schema (<code>.ffd</code> file)</p></li></ul></div></td></tr></tbody></table>

After its execution, the example application generates the following output:

```json
{
  "Batch": [
    {
      "TDR": [
        {
          "Record Type": "BAT",
          "Sequence Number": 2,
          "Amount": 32876,
          "Account Number": "0123456789",
          "Batch Function": "D",
          "Type": "CR"
        },
        {
          "Record Type": "BAT",
          "Sequence Number": 3,
          "Amount": 87326,
          "Account Number": "0123456788",
          "Batch Function": "D",
          "Type": "CR"
        }
      ],
      "BCF": {
        "Record Type": "BAT",
        "Sequence Number": 4,
        "Batch Transaction Count": 2,
        "Batch Transaction Amount": 120202,
        "Unique Batch Identifier": "A000000001",
        "Batch Function": "T",
        "Type": "CR"
      },
      "BCH": {
        "Record Type": "BAT",
        "Company Name": "ACME RESEARCH",
        "Sequence Number": 1,
        "Unique Batch Identifier": "A000000001",
        "Batch Function": "H"
      }
    },
    {
      "TDR": [
        {
          "Record Type": "BAT",
          "Sequence Number": 6,
          "Amount": 3582,
          "Account Number": "1234567890",
          "Batch Function": "D",
          "Type": "DB"
        },
        {
          "Record Type": "BAT",
          "Sequence Number": 7,
          "Amount": 256,
          "Account Number": "1234567891",
          "Batch Function": "D",
          "Type": "CR"
        }
      ],
      "BCF": {
        "Record Type": "BAT",
        "Sequence Number": 8,
        "Batch Transaction Count": 2,
        "Batch Transaction Amount": 3326,
        "Unique Batch Identifier": "A000000002",
        "Batch Function": "T",
        "Type": "DB"
      },
      "BCH": {
        "Record Type": "BAT",
        "Company Name": "AJAX EXPLOSIVES",
        "Sequence Number": 5,
        "Unique Batch Identifier": "A000000002",
        "Batch Function": "H"
      }
    }
  ],
  "RQF": {
    "Record Type": "RQF",
    "File Batch Count": 2,
    "File Transaction Count": 8,
    "File Transaction Amount": 116876,
    "Unique File Identifier": "A000000001",
    "Type": "CR"
  },
  "RQH": {
    "Record Type": "RQH",
    "File Creation Time": "10:10:00",
    "File Creation Date": "2018-09-01",
    "Currency": "USD",
    "Unique File Identifier": "A000000001"
  }
}
```

## Example of Writing a Flat File

The following example application contains:

1.  A Scheduler component that triggers the flow

2.  A File Read operation that reads a file containing the JSON output from the previous example

3.  A Transform Message component that transforms the JSON payload to the specified flat file format

4.  A Logger component that outputs the current payload

5.  A File Write operation that outputs the payload to a flat file in the specified target path

![A flow showing the process of writing a flat file](/mulesoft/current/en-us/dataweave/2.12/_images/mruntime-write-flat-file.png)

Application XML File

```xml
<mule xmlns:file="http://www.mulesoft.org/schema/mule/file"
  xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
  xmlns="http://www.mulesoft.org/schema/mule/core"
  xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
http://www.mulesoft.org/schema/mule/file http://www.mulesoft.org/schema/mule/file/current/mule-file.xsd">
  <file:config name="File_Config" doc:name="File Config" >
    <file:connection workingDir="${fileWorkingDir}" />
  </file:config>
  <configuration-properties doc:name="Configuration properties" file="flatfileconfig.properties" />
  <flow name="WriteFlatFile" >
    <scheduler doc:name="Scheduler" >
    	<scheduling-strategy >
        <fixed-frequency frequency="10000" />
    	</scheduling-strategy>
    </scheduler>
    <file:read doc:name="Read JSON file" config-ref="File_Config" path="${jsonFileReadPath}"/>
    <ee:transform doc:name="Transform to flat file"> (1)
    	<ee:message>
        <ee:set-payload><![CDATA[%dw 2.0
output application/flatfile schemaPath = "flatfileschema.ffd"
%dw 2.0
---
{
	RQH: {
		"Record Type": payload.RQH."Record Type",
		"File Creation Date": payload.RQH."File Creation Date" as Date {format: "yyyy-MM-dd"},
		"File Creation Time": payload.RQH."File Creation Time" as Time,
		"Unique File Identifier": payload.RQH."Unique File Identifier",
		Currency: payload.RQH.Currency
	},
	Batch: payload.Batch map ( batch , indexOfBatch ) -> {
		BCH: {
			"Record Type": batch.BCH."Record Type",
			"Sequence Number": batch.BCH."Sequence Number",
			"Batch Function": batch.BCH."Batch Function",
			"Company Name": batch.BCH."Company Name",
			"Unique Batch Identifier": batch.BCH."Unique Batch Identifier"},
		TDR: batch.TDR map (tdr, indexOfTdr) ->
			{
			"Record Type": tdr.TDR."Record Type",
			"Sequence Number": tdr.TDR."Sequence Number",
			"Batch Function": tdr.TDR."Batch Function",
			"Account Number": tdr.TDR."Account Number",
			"Amount": tdr.TDR.Amount,
			"Type": tdr.TDR.'Type'
			},
		BCF: {
			"Record Type": batch.BCF."Record Type",
			"Sequence Number": batch.BCF."Sequence Number",
			"Batch Function": batch.BCF."Batch Function",
			"Batch Transaction Amount": batch.BCF."Batch Transaction Amount",
			"Type": batch.BCF.'Type',
			"Batch Transaction Count": batch.BCF."Batch Transaction Count",
			"Unique Batch Identifier": batch.BCF."Unique Batch Identifier"}
		},
	RQF: {
		"Record Type": payload.RQF."Record Type",
		"File Batch Count": payload.RQF."File Batch Count",
		"File Transaction Count": payload.RQF."File Transaction Count",
		"File Transaction Amount": payload.RQF."File Transaction Amount",
		Type: payload.RQF.Type,
		"Unique File Identifier": payload.RQF."Unique File Identifier"
	}
}
]]>
      </ee:set-payload>
    	</ee:message>
    </ee:transform>
    <logger level="INFO" doc:name="Logger" message='#["\n"]Writing flat file to: ${mule.home}/apps/${app.name}/${fileWritePath}#["\n"]#[payload]'/>
    <file:write doc:name="Write flat file" config-ref="File_Config" path="${fileWritePath}" /> (2)
	</flow>
</mule>
```

<table><tbody><tr><td><i data-value="1"></i><b>1</b></td><td>Note that the Transform component specifies the following writer properties in the script header:<div><ul><li><p><code>output</code>: The output MIME type of the transformation, in this case, <code>application/flatfile</code></p></li><li><p><code>schemapath</code>: The writer property that specifies the path to the flat file schema (<code>.ffd</code> file)</p></li></ul></div></td></tr><tr><td><i data-value="2"></i><b>2</b></td><td>Note that the File Write operation specifies the <code>path</code> property to define where to write the flat file</td></tr></tbody></table>

After its execution, the example application generates the following output:

RQH201809011010A000000001USD BAT000001HACME RESEARCH A000000001 BAT000000D 0000000000 BAT000000D
0000000000 BAT000004T0000120202CR000002A000000001 BAT000005HAJAX EXPLOSIVES A000000002 BAT000000D
0000000000 BAT000000D 0000000000 BAT000008T0000003326DB000002A000000002
RQF0002000008000000116876CRA000000001

## Test the Examples Locally

If you want to test the examples locally, follow these steps to create and configure your example
Mule application:

1.  Create a new **Mule Project** in Anypoint Studio.

2.  Copy the XML code of the application you want to test into the **Configuration XML** view of
    your project.

3.  Use [Add Modules](https://docs.mulesoft.com/studio/add-modules-in-studio-to) to add the Anypoint Connector for File
    (File Connector) to your project.

4.  Create a file named `flatfileconfig.properties` in the `src/main/resources` folder of your Mule
    application, and set its content with the following properties:

    fileReadPath=flatfile schemaPath=flatfileschema.ffd fileWritePath=flatfilenew
    jsonFileReadPath=flatFileJson.json fileWorkingDir=#\["${mule.home}/apps/${app.name}/"\]

5.  Create a file named `flatfile` in the `src/main/resources` folder of your Mule application, and
    set its content with the
    [flat file sample data](https://docs.mulesoft.com/dataweave/2.12/%3Cdataweave-flat-file-schemas#flat-file-sample-data >) from the DataWeave
    flat file schema example.

6.  Create a file named `flatfileschema.ffd` in the `src/main/resources` folder of your Mule
    application, and set its content with the
    [full schema example](https://docs.mulesoft.com/dataweave/2.12/dataweave-flat-file-schemas#full_schema_ex) from the DataWeave flat file
    schema example.

7.  Create a file named `flatFileJson.json` in the `src/main/resources` folder of your Mule
    application and set its content with the
    [JSON transformation output](#json-transformation-output) from the example that reads a flat
    file.

## See Also

- [Flat File Format](https://docs.mulesoft.com/dataweave/2.12/dataweave-formats-flatfile)

- [Flat File Schemas](https://docs.mulesoft.com/dataweave/2.12/dataweave-flat-file-schemas)

- [Set Reader and Writer Properties](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-set-reader-writer-props)

- [Configure Properties](https://docs.mulesoft.com/mule-runtime/latest/configuring-properties)

<!-- document id=9cdf099244a4c33d6491b48e7b26200e7902d2aa5bf5150bd2afc5e4b136aef5 url=/mulesoft/current/en-us/dataweave/2.3/dataweave-cookbook-flat-file-read-and-write.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, transform, transformer, format, xml, json, dataweave, data weave, datamapper, dwl, dfl, dw, flat file
---

# Read and Write a Flat File

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following examples show you how to read the contents of a flat file, and also how to write a
flat file following the specified schema. Each example consists of a Mule application that uses
DataWeave to read and write flat files.

When you work with flat files, configure the flat file schema to use for reading and writing flat
file content. The flat file schema defines the structure of a flat file, and this enables Mule to
write and read in this format.

These example applications are configured to work with the sample flat file data and the example
flat file schema provided in [Flat File Schemas](https://docs.mulesoft.com/dataweave/2.3/dataweave-flat-file-schemas#full_schema_ex).

## Example of Reading a Flat File

The following example application consists of:

1.  A Scheduler component that triggers the flow

2.  A File Read operation that reads a flat file from the specified path

3.  A Transform Message component that transforms the content read from the flat file to JSON format

4.  A Logger component that outputs the current payload

![A flow showing the process of reading and transforming a flat file to JSON](/mulesoft/current/en-us/dataweave/2.3/_images/mruntime-read-flat-file.png)

Application XML File

```xml
<mule xmlns:file="http://www.mulesoft.org/schema/mule/file"
  xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
  xmlns="http://www.mulesoft.org/schema/mule/core"
  xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
http://www.mulesoft.org/schema/mule/file http://www.mulesoft.org/schema/mule/file/current/mule-file.xsd">
  <file:config name="File_Config" doc:name="File Config" >
    <file:connection workingDir="${fileWorkingDir}" />
  </file:config>
  <configuration-properties doc:name="Configuration properties" file="flatfileconfig.properties" />
  <flow name="ReadFlatfileFlow" >
    <scheduler doc:name="Scheduler">
      <scheduling-strategy>
        <fixed-frequency frequency="10000" />
      </scheduling-strategy>
    </scheduler>
    <file:read doc:name="Read flat file" config-ref="File_Config"
    path="${fileReadPath}"
    outputMimeType='application/flatfile; schemapath=${schemaPath}'/> (1)
    <ee:transform doc:name="Transform to JSON"  >
      <ee:message >
        <ee:set-payload ><![CDATA[%dw 2.0
        output application/json
        ---
        payload]]>
        </ee:set-payload>
      </ee:message>
    </ee:transform>
    <logger level="INFO" doc:name="Logger" message='#["\n"]Reading flat file from: ${mule.home}/apps/${app.name}/${fileReadPath}#["\n"]#[payload]' />
  </flow>
</mule>
```

<table><tbody><tr><td><i data-value="1"></i><b>1</b></td><td>Note that the File Read operation configures the following attributes:<div><ul><li><p><code>path</code>: The path of the flat file to read</p></li><li><p><code>outputMimeType</code>: The output MIME type of the content, in this case, <code>application/flatfile</code></p></li><li><p><code>schemapath</code>: The reader property that specifies the path to the flat file schema (<code>.ffd</code> file)</p></li></ul></div></td></tr></tbody></table>

After its execution, the example application generates the following output:

```json
{
  "Batch": [
    {
      "TDR": [
        {
          "Record Type": "BAT",
          "Sequence Number": 2,
          "Amount": 32876,
          "Account Number": "0123456789",
          "Batch Function": "D",
          "Type": "CR"
        },
        {
          "Record Type": "BAT",
          "Sequence Number": 3,
          "Amount": 87326,
          "Account Number": "0123456788",
          "Batch Function": "D",
          "Type": "CR"
        }
      ],
      "BCF": {
        "Record Type": "BAT",
        "Sequence Number": 4,
        "Batch Transaction Count": 2,
        "Batch Transaction Amount": 120202,
        "Unique Batch Identifier": "A000000001",
        "Batch Function": "T",
        "Type": "CR"
      },
      "BCH": {
        "Record Type": "BAT",
        "Company Name": "ACME RESEARCH",
        "Sequence Number": 1,
        "Unique Batch Identifier": "A000000001",
        "Batch Function": "H"
      }
    },
    {
      "TDR": [
        {
          "Record Type": "BAT",
          "Sequence Number": 6,
          "Amount": 3582,
          "Account Number": "1234567890",
          "Batch Function": "D",
          "Type": "DB"
        },
        {
          "Record Type": "BAT",
          "Sequence Number": 7,
          "Amount": 256,
          "Account Number": "1234567891",
          "Batch Function": "D",
          "Type": "CR"
        }
      ],
      "BCF": {
        "Record Type": "BAT",
        "Sequence Number": 8,
        "Batch Transaction Count": 2,
        "Batch Transaction Amount": 3326,
        "Unique Batch Identifier": "A000000002",
        "Batch Function": "T",
        "Type": "DB"
      },
      "BCH": {
        "Record Type": "BAT",
        "Company Name": "AJAX EXPLOSIVES",
        "Sequence Number": 5,
        "Unique Batch Identifier": "A000000002",
        "Batch Function": "H"
      }
    }
  ],
  "RQF": {
    "Record Type": "RQF",
    "File Batch Count": 2,
    "File Transaction Count": 8,
    "File Transaction Amount": 116876,
    "Unique File Identifier": "A000000001",
    "Type": "CR"
  },
  "RQH": {
    "Record Type": "RQH",
    "File Creation Time": "10:10:00",
    "File Creation Date": "2018-09-01",
    "Currency": "USD",
    "Unique File Identifier": "A000000001"
  }
}
```

## Example of Writing a Flat File

The following example application contains:

1.  A Scheduler component that triggers the flow

2.  A File Read operation that reads a file containing the JSON output from the previous example

3.  A Transform Message component that transforms the JSON payload to the specified flat file format

4.  A Logger component that outputs the current payload

5.  A File Write operation that outputs the payload to a flat file in the specified target path

![A flow showing the process of writing a flat file](/mulesoft/current/en-us/dataweave/2.3/_images/mruntime-write-flat-file.png)

Application XML File

```xml
<mule xmlns:file="http://www.mulesoft.org/schema/mule/file"
  xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
  xmlns="http://www.mulesoft.org/schema/mule/core"
  xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
http://www.mulesoft.org/schema/mule/file http://www.mulesoft.org/schema/mule/file/current/mule-file.xsd">
  <file:config name="File_Config" doc:name="File Config" >
    <file:connection workingDir="${fileWorkingDir}" />
  </file:config>
  <configuration-properties doc:name="Configuration properties" file="flatfileconfig.properties" />
  <flow name="WriteFlatFile" >
    <scheduler doc:name="Scheduler" >
    	<scheduling-strategy >
        <fixed-frequency frequency="10000" />
    	</scheduling-strategy>
    </scheduler>
    <file:read doc:name="Read JSON file" config-ref="File_Config" path="${jsonFileReadPath}"/>
    <ee:transform doc:name="Transform to flat file"> (1)
    	<ee:message>
        <ee:set-payload><![CDATA[%dw 2.0
output application/flatfile schemaPath = "flatfileschema.ffd"
%dw 2.0
---
{
	RQH: {
		"Record Type": payload.RQH."Record Type",
		"File Creation Date": payload.RQH."File Creation Date" as Date {format: "yyyy-MM-dd"},
		"File Creation Time": payload.RQH."File Creation Time" as Time,
		"Unique File Identifier": payload.RQH."Unique File Identifier",
		Currency: payload.RQH.Currency
	},
	Batch: payload.Batch map ( batch , indexOfBatch ) -> {
		BCH: {
			"Record Type": batch.BCH."Record Type",
			"Sequence Number": batch.BCH."Sequence Number",
			"Batch Function": batch.BCH."Batch Function",
			"Company Name": batch.BCH."Company Name",
			"Unique Batch Identifier": batch.BCH."Unique Batch Identifier"},
		TDR: batch.TDR map (tdr, indexOfTdr) ->
			{
			"Record Type": tdr.TDR."Record Type",
			"Sequence Number": tdr.TDR."Sequence Number",
			"Batch Function": tdr.TDR."Batch Function",
			"Account Number": tdr.TDR."Account Number",
			"Amount": tdr.TDR.Amount,
			"Type": tdr.TDR.'Type'
			},
		BCF: {
			"Record Type": batch.BCF."Record Type",
			"Sequence Number": batch.BCF."Sequence Number",
			"Batch Function": batch.BCF."Batch Function",
			"Batch Transaction Amount": batch.BCF."Batch Transaction Amount",
			"Type": batch.BCF.'Type',
			"Batch Transaction Count": batch.BCF."Batch Transaction Count",
			"Unique Batch Identifier": batch.BCF."Unique Batch Identifier"}
		},
	RQF: {
		"Record Type": payload.RQF."Record Type",
		"File Batch Count": payload.RQF."File Batch Count",
		"File Transaction Count": payload.RQF."File Transaction Count",
		"File Transaction Amount": payload.RQF."File Transaction Amount",
		Type: payload.RQF.Type,
		"Unique File Identifier": payload.RQF."Unique File Identifier"
	}
}
]]>
      </ee:set-payload>
    	</ee:message>
    </ee:transform>
    <logger level="INFO" doc:name="Logger" message='#["\n"]Writing flat file to: ${mule.home}/apps/${app.name}/${fileWritePath}#["\n"]#[payload]'/>
    <file:write doc:name="Write flat file" config-ref="File_Config" path="${fileWritePath}" /> (2)
	</flow>
</mule>
```

<table><tbody><tr><td><i data-value="1"></i><b>1</b></td><td>Note that the Transform component specifies the following writer properties in the script header:<div><ul><li><p><code>output</code>: The output MIME type of the transformation, in this case, <code>application/flatfile</code></p></li><li><p><code>schemapath</code>: The writer property that specifies the path to the flat file schema (<code>.ffd</code> file)</p></li></ul></div></td></tr><tr><td><i data-value="2"></i><b>2</b></td><td>Note that the File Write operation specifies the <code>path</code> property to define where to write the flat file</td></tr></tbody></table>

After its execution, the example application generates the following output:

RQH201809011010A000000001USD BAT000001HACME RESEARCH A000000001 BAT000000D 0000000000 BAT000000D
0000000000 BAT000004T0000120202CR000002A000000001 BAT000005HAJAX EXPLOSIVES A000000002 BAT000000D
0000000000 BAT000000D 0000000000 BAT000008T0000003326DB000002A000000002
RQF0002000008000000116876CRA000000001

## Test the Examples Locally

If you want to test the examples locally, follow these steps to create and configure your example
Mule application:

1.  Create a new **Mule Project** in Anypoint Studio.

2.  Copy the XML code of the application you want to test into the **Configuration XML** view of
    your project.

3.  Use [Add Modules](https://docs.mulesoft.com/studio/add-modules-in-studio-to) to add the Anypoint Connector for File
    (File Connector) to your project.

4.  Create a file named `flatfileconfig.properties` in the `src/main/resources` folder of your Mule
    application, and set its content with the following properties:

    fileReadPath=flatfile schemaPath=flatfileschema.ffd fileWritePath=flatfilenew
    jsonFileReadPath=flatFileJson.json fileWorkingDir=#\["${mule.home}/apps/${app.name}/"\]

5.  Create a file named `flatfile` in the \`sr:page-aliases:

6.  Create a file named `flatfileschema.ffd` in the \`sr:page-aliases:

7.  Create a file named `flatFileJson.json` in the `src/main/resources` folder of your Mule
    application and set its content with the
    [JSON transformation output](#json-transformation-output) from the example that reads a flat
    file.

## See Also

- [Flat File Format](https://docs.mulesoft.com/dataweave/2.3/dataweave-formats-flatfile)

- [Flat File Schemas](https://docs.mulesoft.com/dataweave/2.3/dataweave-flat-file-schemas)

- [Set Reader and Writer Properties](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-set-reader-writer-props)

- [Configure Properties](https://docs.mulesoft.com/mule-runtime/4.3/configuring-properties)

<!-- document id=5fa854242ae3e638b64acb3662d966523ac00408e36d80d9a5edf7fb979e2956 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook-flat-file-read-and-write.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, transform, transformer, format, xml, json, dataweave, data weave, datamapper, dwl, dfl, dw, flat file
---

# Read and Write a Flat File

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following examples show you how to read the contents of a flat file, and also how to write a
flat file following the specified schema. Each example consists of a Mule application that uses
DataWeave to read and write flat files.

When you work with flat files, configure the flat file schema to use for reading and writing flat
file content. The flat file schema defines the structure of a flat file, and this enables Mule to
write and read in this format.

These example applications are configured to work with the sample flat file data and the example
flat file schema provided in [Flat File Schemas](https://docs.mulesoft.com/dataweave/2.4/dataweave-flat-file-schemas#full_schema_ex).

## Example of Reading a Flat File

The following example application consists of:

1.  A Scheduler component that triggers the flow

2.  A File Read operation that reads a flat file from the specified path

3.  A Transform Message component that transforms the content read from the flat file to JSON format

4.  A Logger component that outputs the current payload

![A flow showing the process of reading and transforming a flat file to JSON](/mulesoft/current/en-us/dataweave/2.4/_images/mruntime-read-flat-file.png)

Application XML File

```xml
<mule xmlns:file="http://www.mulesoft.org/schema/mule/file"
  xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
  xmlns="http://www.mulesoft.org/schema/mule/core"
  xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
http://www.mulesoft.org/schema/mule/file http://www.mulesoft.org/schema/mule/file/current/mule-file.xsd">
  <file:config name="File_Config" doc:name="File Config" >
    <file:connection workingDir="${fileWorkingDir}" />
  </file:config>
  <configuration-properties doc:name="Configuration properties" file="flatfileconfig.properties" />
  <flow name="ReadFlatfileFlow" >
    <scheduler doc:name="Scheduler">
      <scheduling-strategy>
        <fixed-frequency frequency="10000" />
      </scheduling-strategy>
    </scheduler>
    <file:read doc:name="Read flat file" config-ref="File_Config"
    path="${fileReadPath}"
    outputMimeType='application/flatfile; schemapath=${schemaPath}'/> (1)
    <ee:transform doc:name="Transform to JSON"  >
      <ee:message >
        <ee:set-payload ><![CDATA[%dw 2.0
        output application/json
        ---
        payload]]>
        </ee:set-payload>
      </ee:message>
    </ee:transform>
    <logger level="INFO" doc:name="Logger" message='#["\n"]Reading flat file from: ${mule.home}/apps/${app.name}/${fileReadPath}#["\n"]#[payload]' />
  </flow>
</mule>
```

<table><tbody><tr><td><i data-value="1"></i><b>1</b></td><td>Note that the File Read operation configures the following attributes:<div><ul><li><p><code>path</code>: The path of the flat file to read</p></li><li><p><code>outputMimeType</code>: The output MIME type of the content, in this case, <code>application/flatfile</code></p></li><li><p><code>schemapath</code>: The reader property that specifies the path to the flat file schema (<code>.ffd</code> file)</p></li></ul></div></td></tr></tbody></table>

After its execution, the example application generates the following output:

```json
{
  "Batch": [
    {
      "TDR": [
        {
          "Record Type": "BAT",
          "Sequence Number": 2,
          "Amount": 32876,
          "Account Number": "0123456789",
          "Batch Function": "D",
          "Type": "CR"
        },
        {
          "Record Type": "BAT",
          "Sequence Number": 3,
          "Amount": 87326,
          "Account Number": "0123456788",
          "Batch Function": "D",
          "Type": "CR"
        }
      ],
      "BCF": {
        "Record Type": "BAT",
        "Sequence Number": 4,
        "Batch Transaction Count": 2,
        "Batch Transaction Amount": 120202,
        "Unique Batch Identifier": "A000000001",
        "Batch Function": "T",
        "Type": "CR"
      },
      "BCH": {
        "Record Type": "BAT",
        "Company Name": "ACME RESEARCH",
        "Sequence Number": 1,
        "Unique Batch Identifier": "A000000001",
        "Batch Function": "H"
      }
    },
    {
      "TDR": [
        {
          "Record Type": "BAT",
          "Sequence Number": 6,
          "Amount": 3582,
          "Account Number": "1234567890",
          "Batch Function": "D",
          "Type": "DB"
        },
        {
          "Record Type": "BAT",
          "Sequence Number": 7,
          "Amount": 256,
          "Account Number": "1234567891",
          "Batch Function": "D",
          "Type": "CR"
        }
      ],
      "BCF": {
        "Record Type": "BAT",
        "Sequence Number": 8,
        "Batch Transaction Count": 2,
        "Batch Transaction Amount": 3326,
        "Unique Batch Identifier": "A000000002",
        "Batch Function": "T",
        "Type": "DB"
      },
      "BCH": {
        "Record Type": "BAT",
        "Company Name": "AJAX EXPLOSIVES",
        "Sequence Number": 5,
        "Unique Batch Identifier": "A000000002",
        "Batch Function": "H"
      }
    }
  ],
  "RQF": {
    "Record Type": "RQF",
    "File Batch Count": 2,
    "File Transaction Count": 8,
    "File Transaction Amount": 116876,
    "Unique File Identifier": "A000000001",
    "Type": "CR"
  },
  "RQH": {
    "Record Type": "RQH",
    "File Creation Time": "10:10:00",
    "File Creation Date": "2018-09-01",
    "Currency": "USD",
    "Unique File Identifier": "A000000001"
  }
}
```

## Example of Writing a Flat File

The following example application contains:

1.  A Scheduler component that triggers the flow

2.  A File Read operation that reads a file containing the JSON output from the previous example

3.  A Transform Message component that transforms the JSON payload to the specified flat file format

4.  A Logger component that outputs the current payload

5.  A File Write operation that outputs the payload to a flat file in the specified target path

![A flow showing the process of writing a flat file](/mulesoft/current/en-us/dataweave/2.4/_images/mruntime-write-flat-file.png)

Application XML File

```xml
<mule xmlns:file="http://www.mulesoft.org/schema/mule/file"
  xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
  xmlns="http://www.mulesoft.org/schema/mule/core"
  xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
http://www.mulesoft.org/schema/mule/file http://www.mulesoft.org/schema/mule/file/current/mule-file.xsd">
  <file:config name="File_Config" doc:name="File Config" >
    <file:connection workingDir="${fileWorkingDir}" />
  </file:config>
  <configuration-properties doc:name="Configuration properties" file="flatfileconfig.properties" />
  <flow name="WriteFlatFile" >
    <scheduler doc:name="Scheduler" >
    	<scheduling-strategy >
        <fixed-frequency frequency="10000" />
    	</scheduling-strategy>
    </scheduler>
    <file:read doc:name="Read JSON file" config-ref="File_Config" path="${jsonFileReadPath}"/>
    <ee:transform doc:name="Transform to flat file"> (1)
    	<ee:message>
        <ee:set-payload><![CDATA[%dw 2.0
output application/flatfile schemaPath = "flatfileschema.ffd"
%dw 2.0
---
{
	RQH: {
		"Record Type": payload.RQH."Record Type",
		"File Creation Date": payload.RQH."File Creation Date" as Date {format: "yyyy-MM-dd"},
		"File Creation Time": payload.RQH."File Creation Time" as Time,
		"Unique File Identifier": payload.RQH."Unique File Identifier",
		Currency: payload.RQH.Currency
	},
	Batch: payload.Batch map ( batch , indexOfBatch ) -> {
		BCH: {
			"Record Type": batch.BCH."Record Type",
			"Sequence Number": batch.BCH."Sequence Number",
			"Batch Function": batch.BCH."Batch Function",
			"Company Name": batch.BCH."Company Name",
			"Unique Batch Identifier": batch.BCH."Unique Batch Identifier"},
		TDR: batch.TDR map (tdr, indexOfTdr) ->
			{
			"Record Type": tdr.TDR."Record Type",
			"Sequence Number": tdr.TDR."Sequence Number",
			"Batch Function": tdr.TDR."Batch Function",
			"Account Number": tdr.TDR."Account Number",
			"Amount": tdr.TDR.Amount,
			"Type": tdr.TDR.'Type'
			},
		BCF: {
			"Record Type": batch.BCF."Record Type",
			"Sequence Number": batch.BCF."Sequence Number",
			"Batch Function": batch.BCF."Batch Function",
			"Batch Transaction Amount": batch.BCF."Batch Transaction Amount",
			"Type": batch.BCF.'Type',
			"Batch Transaction Count": batch.BCF."Batch Transaction Count",
			"Unique Batch Identifier": batch.BCF."Unique Batch Identifier"}
		},
	RQF: {
		"Record Type": payload.RQF."Record Type",
		"File Batch Count": payload.RQF."File Batch Count",
		"File Transaction Count": payload.RQF."File Transaction Count",
		"File Transaction Amount": payload.RQF."File Transaction Amount",
		Type: payload.RQF.Type,
		"Unique File Identifier": payload.RQF."Unique File Identifier"
	}
}
]]>
      </ee:set-payload>
    	</ee:message>
    </ee:transform>
    <logger level="INFO" doc:name="Logger" message='#["\n"]Writing flat file to: ${mule.home}/apps/${app.name}/${fileWritePath}#["\n"]#[payload]'/>
    <file:write doc:name="Write flat file" config-ref="File_Config" path="${fileWritePath}" /> (2)
	</flow>
</mule>
```

<table><tbody><tr><td><i data-value="1"></i><b>1</b></td><td>Note that the Transform component specifies the following writer properties in the script header:<div><ul><li><p><code>output</code>: The output MIME type of the transformation, in this case, <code>application/flatfile</code></p></li><li><p><code>schemapath</code>: The writer property that specifies the path to the flat file schema (<code>.ffd</code> file)</p></li></ul></div></td></tr><tr><td><i data-value="2"></i><b>2</b></td><td>Note that the File Write operation specifies the <code>path</code> property to define where to write the flat file</td></tr></tbody></table>

After its execution, the example application generates the following output:

RQH201809011010A000000001USD BAT000001HACME RESEARCH A000000001 BAT000000D 0000000000 BAT000000D
0000000000 BAT000004T0000120202CR000002A000000001 BAT000005HAJAX EXPLOSIVES A000000002 BAT000000D
0000000000 BAT000000D 0000000000 BAT000008T0000003326DB000002A000000002
RQF0002000008000000116876CRA000000001

## Test the Examples Locally

If you want to test the examples locally, follow these steps to create and configure your example
Mule application:

1.  Create a new **Mule Project** in Anypoint Studio.

2.  Copy the XML code of the application you want to test into the **Configuration XML** view of
    your project.

3.  Use [Add Modules](https://docs.mulesoft.com/studio/add-modules-in-studio-to) to add the Anypoint Connector for File
    (File Connector) to your project.

4.  Create a file named `flatfileconfig.properties` in the `src/main/resources` folder of your Mule
    application, and set its content with the following properties:

    fileReadPath=flatfile schemaPath=flatfileschema.ffd fileWritePath=flatfilenew
    jsonFileReadPath=flatFileJson.json fileWorkingDir=#\["${mule.home}/apps/${app.name}/"\]

5.  Create a file named `flatfile` in the `src/main/resources` folder of your Mule application, and
    set its content with the
    [flat file sample data](https://docs.mulesoft.com/dataweave/2.4/%3Cdataweave-flat-file-schemas#flat-file-sample-data >) from the DataWeave
    flat file schema example.

6.  Create a file named `flatfileschema.ffd` in the `src/main/resources` folder of your Mule
    application, and set its content with the
    [full schema example](https://docs.mulesoft.com/dataweave/2.4/dataweave-flat-file-schemas#full_schema_ex) from the DataWeave flat file
    schema example.

7.  Create a file named `flatFileJson.json` in the `src/main/resources` folder of your Mule
    application and set its content with the
    [JSON transformation output](#json-transformation-output) from the example that reads a flat
    file.

## See Also

- [Flat File Format](https://docs.mulesoft.com/dataweave/2.4/dataweave-formats-flatfile)

- [Flat File Schemas](https://docs.mulesoft.com/dataweave/2.4/dataweave-flat-file-schemas)

- [Set Reader and Writer Properties](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-set-reader-writer-props)

- [Configure Properties](https://docs.mulesoft.com/mule-runtime/latest/configuring-properties)

<!-- document id=9c3319966169aadabdd261d0e47815b4567b016163aaf2ae30da7f84d5219d30 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook-flat-file-read-and-write.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, transform, transformer, format, xml, json, dataweave, data weave, datamapper, dwl, dfl, dw, flat file
---

# Read and Write a Flat File

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following examples show you how to read the contents of a flat file, and also how to write a
flat file following the specified schema. Each example consists of a Mule application that uses
DataWeave to read and write flat files.

When you work with flat files, configure the flat file schema to use for reading and writing flat
file content. The flat file schema defines the structure of a flat file, and this enables Mule to
write and read in this format.

These example applications are configured to work with the sample flat file data and the example
flat file schema provided in [Flat File Schemas](https://docs.mulesoft.com/dataweave/2.6/dataweave-flat-file-schemas#full_schema_ex).

## Example of Reading a Flat File

The following example application consists of:

1.  A Scheduler component that triggers the flow

2.  A File Read operation that reads a flat file from the specified path

3.  A Transform Message component that transforms the content read from the flat file to JSON format

4.  A Logger component that outputs the current payload

![A flow showing the process of reading and transforming a flat file to JSON](/mulesoft/current/en-us/dataweave/2.6/_images/mruntime-read-flat-file.png)

Application XML File

```xml
<mule xmlns:file="http://www.mulesoft.org/schema/mule/file"
  xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
  xmlns="http://www.mulesoft.org/schema/mule/core"
  xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
http://www.mulesoft.org/schema/mule/file http://www.mulesoft.org/schema/mule/file/current/mule-file.xsd">
  <file:config name="File_Config" doc:name="File Config" >
    <file:connection workingDir="${fileWorkingDir}" />
  </file:config>
  <configuration-properties doc:name="Configuration properties" file="flatfileconfig.properties" />
  <flow name="ReadFlatfileFlow" >
    <scheduler doc:name="Scheduler">
      <scheduling-strategy>
        <fixed-frequency frequency="10000" />
      </scheduling-strategy>
    </scheduler>
    <file:read doc:name="Read flat file" config-ref="File_Config"
    path="${fileReadPath}"
    outputMimeType='application/flatfile; schemapath=${schemaPath}'/> (1)
    <ee:transform doc:name="Transform to JSON"  >
      <ee:message >
        <ee:set-payload ><![CDATA[%dw 2.0
        output application/json
        ---
        payload]]>
        </ee:set-payload>
      </ee:message>
    </ee:transform>
    <logger level="INFO" doc:name="Logger" message='#["\n"]Reading flat file from: ${mule.home}/apps/${app.name}/${fileReadPath}#["\n"]#[payload]' />
  </flow>
</mule>
```

<table><tbody><tr><td><i data-value="1"></i><b>1</b></td><td>Note that the File Read operation configures the following attributes:<div><ul><li><p><code>path</code>: The path of the flat file to read</p></li><li><p><code>outputMimeType</code>: The output MIME type of the content, in this case, <code>application/flatfile</code></p></li><li><p><code>schemapath</code>: The reader property that specifies the path to the flat file schema (<code>.ffd</code> file)</p></li></ul></div></td></tr></tbody></table>

After its execution, the example application generates the following output:

```json
{
  "Batch": [
    {
      "TDR": [
        {
          "Record Type": "BAT",
          "Sequence Number": 2,
          "Amount": 32876,
          "Account Number": "0123456789",
          "Batch Function": "D",
          "Type": "CR"
        },
        {
          "Record Type": "BAT",
          "Sequence Number": 3,
          "Amount": 87326,
          "Account Number": "0123456788",
          "Batch Function": "D",
          "Type": "CR"
        }
      ],
      "BCF": {
        "Record Type": "BAT",
        "Sequence Number": 4,
        "Batch Transaction Count": 2,
        "Batch Transaction Amount": 120202,
        "Unique Batch Identifier": "A000000001",
        "Batch Function": "T",
        "Type": "CR"
      },
      "BCH": {
        "Record Type": "BAT",
        "Company Name": "ACME RESEARCH",
        "Sequence Number": 1,
        "Unique Batch Identifier": "A000000001",
        "Batch Function": "H"
      }
    },
    {
      "TDR": [
        {
          "Record Type": "BAT",
          "Sequence Number": 6,
          "Amount": 3582,
          "Account Number": "1234567890",
          "Batch Function": "D",
          "Type": "DB"
        },
        {
          "Record Type": "BAT",
          "Sequence Number": 7,
          "Amount": 256,
          "Account Number": "1234567891",
          "Batch Function": "D",
          "Type": "CR"
        }
      ],
      "BCF": {
        "Record Type": "BAT",
        "Sequence Number": 8,
        "Batch Transaction Count": 2,
        "Batch Transaction Amount": 3326,
        "Unique Batch Identifier": "A000000002",
        "Batch Function": "T",
        "Type": "DB"
      },
      "BCH": {
        "Record Type": "BAT",
        "Company Name": "AJAX EXPLOSIVES",
        "Sequence Number": 5,
        "Unique Batch Identifier": "A000000002",
        "Batch Function": "H"
      }
    }
  ],
  "RQF": {
    "Record Type": "RQF",
    "File Batch Count": 2,
    "File Transaction Count": 8,
    "File Transaction Amount": 116876,
    "Unique File Identifier": "A000000001",
    "Type": "CR"
  },
  "RQH": {
    "Record Type": "RQH",
    "File Creation Time": "10:10:00",
    "File Creation Date": "2018-09-01",
    "Currency": "USD",
    "Unique File Identifier": "A000000001"
  }
}
```

## Example of Writing a Flat File

The following example application contains:

1.  A Scheduler component that triggers the flow

2.  A File Read operation that reads a file containing the JSON output from the previous example

3.  A Transform Message component that transforms the JSON payload to the specified flat file format

4.  A Logger component that outputs the current payload

5.  A File Write operation that outputs the payload to a flat file in the specified target path

![A flow showing the process of writing a flat file](/mulesoft/current/en-us/dataweave/2.6/_images/mruntime-write-flat-file.png)

Application XML File

```xml
<mule xmlns:file="http://www.mulesoft.org/schema/mule/file"
  xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
  xmlns="http://www.mulesoft.org/schema/mule/core"
  xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
http://www.mulesoft.org/schema/mule/file http://www.mulesoft.org/schema/mule/file/current/mule-file.xsd">
  <file:config name="File_Config" doc:name="File Config" >
    <file:connection workingDir="${fileWorkingDir}" />
  </file:config>
  <configuration-properties doc:name="Configuration properties" file="flatfileconfig.properties" />
  <flow name="WriteFlatFile" >
    <scheduler doc:name="Scheduler" >
    	<scheduling-strategy >
        <fixed-frequency frequency="10000" />
    	</scheduling-strategy>
    </scheduler>
    <file:read doc:name="Read JSON file" config-ref="File_Config" path="${jsonFileReadPath}"/>
    <ee:transform doc:name="Transform to flat file"> (1)
    	<ee:message>
        <ee:set-payload><![CDATA[%dw 2.0
output application/flatfile schemaPath = "flatfileschema.ffd"
%dw 2.0
---
{
	RQH: {
		"Record Type": payload.RQH."Record Type",
		"File Creation Date": payload.RQH."File Creation Date" as Date {format: "yyyy-MM-dd"},
		"File Creation Time": payload.RQH."File Creation Time" as Time,
		"Unique File Identifier": payload.RQH."Unique File Identifier",
		Currency: payload.RQH.Currency
	},
	Batch: payload.Batch map ( batch , indexOfBatch ) -> {
		BCH: {
			"Record Type": batch.BCH."Record Type",
			"Sequence Number": batch.BCH."Sequence Number",
			"Batch Function": batch.BCH."Batch Function",
			"Company Name": batch.BCH."Company Name",
			"Unique Batch Identifier": batch.BCH."Unique Batch Identifier"},
		TDR: batch.TDR map (tdr, indexOfTdr) ->
			{
			"Record Type": tdr.TDR."Record Type",
			"Sequence Number": tdr.TDR."Sequence Number",
			"Batch Function": tdr.TDR."Batch Function",
			"Account Number": tdr.TDR."Account Number",
			"Amount": tdr.TDR.Amount,
			"Type": tdr.TDR.'Type'
			},
		BCF: {
			"Record Type": batch.BCF."Record Type",
			"Sequence Number": batch.BCF."Sequence Number",
			"Batch Function": batch.BCF."Batch Function",
			"Batch Transaction Amount": batch.BCF."Batch Transaction Amount",
			"Type": batch.BCF.'Type',
			"Batch Transaction Count": batch.BCF."Batch Transaction Count",
			"Unique Batch Identifier": batch.BCF."Unique Batch Identifier"}
		},
	RQF: {
		"Record Type": payload.RQF."Record Type",
		"File Batch Count": payload.RQF."File Batch Count",
		"File Transaction Count": payload.RQF."File Transaction Count",
		"File Transaction Amount": payload.RQF."File Transaction Amount",
		Type: payload.RQF.Type,
		"Unique File Identifier": payload.RQF."Unique File Identifier"
	}
}
]]>
      </ee:set-payload>
    	</ee:message>
    </ee:transform>
    <logger level="INFO" doc:name="Logger" message='#["\n"]Writing flat file to: ${mule.home}/apps/${app.name}/${fileWritePath}#["\n"]#[payload]'/>
    <file:write doc:name="Write flat file" config-ref="File_Config" path="${fileWritePath}" /> (2)
	</flow>
</mule>
```

<table><tbody><tr><td><i data-value="1"></i><b>1</b></td><td>Note that the Transform component specifies the following writer properties in the script header:<div><ul><li><p><code>output</code>: The output MIME type of the transformation, in this case, <code>application/flatfile</code></p></li><li><p><code>schemapath</code>: The writer property that specifies the path to the flat file schema (<code>.ffd</code> file)</p></li></ul></div></td></tr><tr><td><i data-value="2"></i><b>2</b></td><td>Note that the File Write operation specifies the <code>path</code> property to define where to write the flat file</td></tr></tbody></table>

After its execution, the example application generates the following output:

RQH201809011010A000000001USD BAT000001HACME RESEARCH A000000001 BAT000000D 0000000000 BAT000000D
0000000000 BAT000004T0000120202CR000002A000000001 BAT000005HAJAX EXPLOSIVES A000000002 BAT000000D
0000000000 BAT000000D 0000000000 BAT000008T0000003326DB000002A000000002
RQF0002000008000000116876CRA000000001

## Test the Examples Locally

If you want to test the examples locally, follow these steps to create and configure your example
Mule application:

1.  Create a new **Mule Project** in Anypoint Studio.

2.  Copy the XML code of the application you want to test into the **Configuration XML** view of
    your project.

3.  Use [Add Modules](https://docs.mulesoft.com/studio/add-modules-in-studio-to) to add the Anypoint Connector for File
    (File Connector) to your project.

4.  Create a file named `flatfileconfig.properties` in the `src/main/resources` folder of your Mule
    application, and set its content with the following properties:

    fileReadPath=flatfile schemaPath=flatfileschema.ffd fileWritePath=flatfilenew
    jsonFileReadPath=flatFileJson.json fileWorkingDir=#\["${mule.home}/apps/${app.name}/"\]

5.  Create a file named `flatfile` in the `src/main/resources` folder of your Mule application, and
    set its content with the
    [flat file sample data](https://docs.mulesoft.com/dataweave/2.6/%3Cdataweave-flat-file-schemas#flat-file-sample-data >) from the DataWeave
    flat file schema example.

6.  Create a file named `flatfileschema.ffd` in the `src/main/resources` folder of your Mule
    application, and set its content with the
    [full schema example](https://docs.mulesoft.com/dataweave/2.6/dataweave-flat-file-schemas#full_schema_ex) from the DataWeave flat file
    schema example.

7.  Create a file named `flatFileJson.json` in the `src/main/resources` folder of your Mule
    application and set its content with the
    [JSON transformation output](#json-transformation-output) from the example that reads a flat
    file.

## See Also

- [Flat File Format](https://docs.mulesoft.com/dataweave/2.6/dataweave-formats-flatfile)

- [Flat File Schemas](https://docs.mulesoft.com/dataweave/2.6/dataweave-flat-file-schemas)

- [Set Reader and Writer Properties](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-set-reader-writer-props)

- [Configure Properties](https://docs.mulesoft.com/mule-runtime/latest/configuring-properties)

<!-- document id=0f9893858dc1575531a49aa9c10f18faeaad907aae06b358032b8ec1a616c687 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook-flat-file-read-and-write.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, transform, transformer, format, xml, json, dataweave, data weave, datamapper, dwl, dfl, dw, flat file
---

# Read and Write a Flat File

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following examples show you how to read the contents of a flat file, and also how to write a
flat file following the specified schema. Each example consists of a Mule application that uses
DataWeave to read and write flat files.

When you work with flat files, configure the flat file schema to use for reading and writing flat
file content. The flat file schema defines the structure of a flat file, and this enables Mule to
write and read in this format.

These example applications are configured to work with the sample flat file data and the example
flat file schema provided in [Flat File Schemas](https://docs.mulesoft.com/dataweave/2.9/dataweave-flat-file-schemas#full_schema_ex).

## Example of Reading a Flat File

The following example application consists of:

1.  A Scheduler component that triggers the flow

2.  A File Read operation that reads a flat file from the specified path

3.  A Transform Message component that transforms the content read from the flat file to JSON format

4.  A Logger component that outputs the current payload

![A flow showing the process of reading and transforming a flat file to JSON](/mulesoft/current/en-us/dataweave/2.9/_images/mruntime-read-flat-file.png)

Application XML File

```xml
<mule xmlns:file="http://www.mulesoft.org/schema/mule/file"
  xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
  xmlns="http://www.mulesoft.org/schema/mule/core"
  xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
http://www.mulesoft.org/schema/mule/file http://www.mulesoft.org/schema/mule/file/current/mule-file.xsd">
  <file:config name="File_Config" doc:name="File Config" >
    <file:connection workingDir="${fileWorkingDir}" />
  </file:config>
  <configuration-properties doc:name="Configuration properties" file="flatfileconfig.properties" />
  <flow name="ReadFlatfileFlow" >
    <scheduler doc:name="Scheduler">
      <scheduling-strategy>
        <fixed-frequency frequency="10000" />
      </scheduling-strategy>
    </scheduler>
    <file:read doc:name="Read flat file" config-ref="File_Config"
    path="${fileReadPath}"
    outputMimeType='application/flatfile; schemapath=${schemaPath}'/> (1)
    <ee:transform doc:name="Transform to JSON"  >
      <ee:message >
        <ee:set-payload ><![CDATA[%dw 2.0
        output application/json
        ---
        payload]]>
        </ee:set-payload>
      </ee:message>
    </ee:transform>
    <logger level="INFO" doc:name="Logger" message='#["\n"]Reading flat file from: ${mule.home}/apps/${app.name}/${fileReadPath}#["\n"]#[payload]' />
  </flow>
</mule>
```

<table><tbody><tr><td><i data-value="1"></i><b>1</b></td><td>Note that the File Read operation configures the following attributes:<div><ul><li><p><code>path</code>: The path of the flat file to read</p></li><li><p><code>outputMimeType</code>: The output MIME type of the content, in this case, <code>application/flatfile</code></p></li><li><p><code>schemapath</code>: The reader property that specifies the path to the flat file schema (<code>.ffd</code> file)</p></li></ul></div></td></tr></tbody></table>

After its execution, the example application generates the following output:

```json
{
  "Batch": [
    {
      "TDR": [
        {
          "Record Type": "BAT",
          "Sequence Number": 2,
          "Amount": 32876,
          "Account Number": "0123456789",
          "Batch Function": "D",
          "Type": "CR"
        },
        {
          "Record Type": "BAT",
          "Sequence Number": 3,
          "Amount": 87326,
          "Account Number": "0123456788",
          "Batch Function": "D",
          "Type": "CR"
        }
      ],
      "BCF": {
        "Record Type": "BAT",
        "Sequence Number": 4,
        "Batch Transaction Count": 2,
        "Batch Transaction Amount": 120202,
        "Unique Batch Identifier": "A000000001",
        "Batch Function": "T",
        "Type": "CR"
      },
      "BCH": {
        "Record Type": "BAT",
        "Company Name": "ACME RESEARCH",
        "Sequence Number": 1,
        "Unique Batch Identifier": "A000000001",
        "Batch Function": "H"
      }
    },
    {
      "TDR": [
        {
          "Record Type": "BAT",
          "Sequence Number": 6,
          "Amount": 3582,
          "Account Number": "1234567890",
          "Batch Function": "D",
          "Type": "DB"
        },
        {
          "Record Type": "BAT",
          "Sequence Number": 7,
          "Amount": 256,
          "Account Number": "1234567891",
          "Batch Function": "D",
          "Type": "CR"
        }
      ],
      "BCF": {
        "Record Type": "BAT",
        "Sequence Number": 8,
        "Batch Transaction Count": 2,
        "Batch Transaction Amount": 3326,
        "Unique Batch Identifier": "A000000002",
        "Batch Function": "T",
        "Type": "DB"
      },
      "BCH": {
        "Record Type": "BAT",
        "Company Name": "AJAX EXPLOSIVES",
        "Sequence Number": 5,
        "Unique Batch Identifier": "A000000002",
        "Batch Function": "H"
      }
    }
  ],
  "RQF": {
    "Record Type": "RQF",
    "File Batch Count": 2,
    "File Transaction Count": 8,
    "File Transaction Amount": 116876,
    "Unique File Identifier": "A000000001",
    "Type": "CR"
  },
  "RQH": {
    "Record Type": "RQH",
    "File Creation Time": "10:10:00",
    "File Creation Date": "2018-09-01",
    "Currency": "USD",
    "Unique File Identifier": "A000000001"
  }
}
```

## Example of Writing a Flat File

The following example application contains:

1.  A Scheduler component that triggers the flow

2.  A File Read operation that reads a file containing the JSON output from the previous example

3.  A Transform Message component that transforms the JSON payload to the specified flat file format

4.  A Logger component that outputs the current payload

5.  A File Write operation that outputs the payload to a flat file in the specified target path

![A flow showing the process of writing a flat file](/mulesoft/current/en-us/dataweave/2.9/_images/mruntime-write-flat-file.png)

Application XML File

```xml
<mule xmlns:file="http://www.mulesoft.org/schema/mule/file"
  xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
  xmlns="http://www.mulesoft.org/schema/mule/core"
  xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
http://www.mulesoft.org/schema/mule/file http://www.mulesoft.org/schema/mule/file/current/mule-file.xsd">
  <file:config name="File_Config" doc:name="File Config" >
    <file:connection workingDir="${fileWorkingDir}" />
  </file:config>
  <configuration-properties doc:name="Configuration properties" file="flatfileconfig.properties" />
  <flow name="WriteFlatFile" >
    <scheduler doc:name="Scheduler" >
    	<scheduling-strategy >
        <fixed-frequency frequency="10000" />
    	</scheduling-strategy>
    </scheduler>
    <file:read doc:name="Read JSON file" config-ref="File_Config" path="${jsonFileReadPath}"/>
    <ee:transform doc:name="Transform to flat file"> (1)
    	<ee:message>
        <ee:set-payload><![CDATA[%dw 2.0
output application/flatfile schemaPath = "flatfileschema.ffd"
%dw 2.0
---
{
	RQH: {
		"Record Type": payload.RQH."Record Type",
		"File Creation Date": payload.RQH."File Creation Date" as Date {format: "yyyy-MM-dd"},
		"File Creation Time": payload.RQH."File Creation Time" as Time,
		"Unique File Identifier": payload.RQH."Unique File Identifier",
		Currency: payload.RQH.Currency
	},
	Batch: payload.Batch map ( batch , indexOfBatch ) -> {
		BCH: {
			"Record Type": batch.BCH."Record Type",
			"Sequence Number": batch.BCH."Sequence Number",
			"Batch Function": batch.BCH."Batch Function",
			"Company Name": batch.BCH."Company Name",
			"Unique Batch Identifier": batch.BCH."Unique Batch Identifier"},
		TDR: batch.TDR map (tdr, indexOfTdr) ->
			{
			"Record Type": tdr.TDR."Record Type",
			"Sequence Number": tdr.TDR."Sequence Number",
			"Batch Function": tdr.TDR."Batch Function",
			"Account Number": tdr.TDR."Account Number",
			"Amount": tdr.TDR.Amount,
			"Type": tdr.TDR.'Type'
			},
		BCF: {
			"Record Type": batch.BCF."Record Type",
			"Sequence Number": batch.BCF."Sequence Number",
			"Batch Function": batch.BCF."Batch Function",
			"Batch Transaction Amount": batch.BCF."Batch Transaction Amount",
			"Type": batch.BCF.'Type',
			"Batch Transaction Count": batch.BCF."Batch Transaction Count",
			"Unique Batch Identifier": batch.BCF."Unique Batch Identifier"}
		},
	RQF: {
		"Record Type": payload.RQF."Record Type",
		"File Batch Count": payload.RQF."File Batch Count",
		"File Transaction Count": payload.RQF."File Transaction Count",
		"File Transaction Amount": payload.RQF."File Transaction Amount",
		Type: payload.RQF.Type,
		"Unique File Identifier": payload.RQF."Unique File Identifier"
	}
}
]]>
      </ee:set-payload>
    	</ee:message>
    </ee:transform>
    <logger level="INFO" doc:name="Logger" message='#["\n"]Writing flat file to: ${mule.home}/apps/${app.name}/${fileWritePath}#["\n"]#[payload]'/>
    <file:write doc:name="Write flat file" config-ref="File_Config" path="${fileWritePath}" /> (2)
	</flow>
</mule>
```

<table><tbody><tr><td><i data-value="1"></i><b>1</b></td><td>Note that the Transform component specifies the following writer properties in the script header:<div><ul><li><p><code>output</code>: The output MIME type of the transformation, in this case, <code>application/flatfile</code></p></li><li><p><code>schemapath</code>: The writer property that specifies the path to the flat file schema (<code>.ffd</code> file)</p></li></ul></div></td></tr><tr><td><i data-value="2"></i><b>2</b></td><td>Note that the File Write operation specifies the <code>path</code> property to define where to write the flat file</td></tr></tbody></table>

After its execution, the example application generates the following output:

RQH201809011010A000000001USD BAT000001HACME RESEARCH A000000001 BAT000000D 0000000000 BAT000000D
0000000000 BAT000004T0000120202CR000002A000000001 BAT000005HAJAX EXPLOSIVES A000000002 BAT000000D
0000000000 BAT000000D 0000000000 BAT000008T0000003326DB000002A000000002
RQF0002000008000000116876CRA000000001

## Test the Examples Locally

If you want to test the examples locally, follow these steps to create and configure your example
Mule application:

1.  Create a new **Mule Project** in Anypoint Studio.

2.  Copy the XML code of the application you want to test into the **Configuration XML** view of
    your project.

3.  Use [Add Modules](https://docs.mulesoft.com/studio/add-modules-in-studio-to) to add the Anypoint Connector for File
    (File Connector) to your project.

4.  Create a file named `flatfileconfig.properties` in the `src/main/resources` folder of your Mule
    application, and set its content with the following properties:

    fileReadPath=flatfile schemaPath=flatfileschema.ffd fileWritePath=flatfilenew
    jsonFileReadPath=flatFileJson.json fileWorkingDir=#\["${mule.home}/apps/${app.name}/"\]

5.  Create a file named `flatfile` in the `src/main/resources` folder of your Mule application, and
    set its content with the
    [flat file sample data](https://docs.mulesoft.com/dataweave/2.9/%3Cdataweave-flat-file-schemas#flat-file-sample-data >) from the DataWeave
    flat file schema example.

6.  Create a file named `flatfileschema.ffd` in the `src/main/resources` folder of your Mule
    application, and set its content with the
    [full schema example](https://docs.mulesoft.com/dataweave/2.9/dataweave-flat-file-schemas#full_schema_ex) from the DataWeave flat file
    schema example.

7.  Create a file named `flatFileJson.json` in the `src/main/resources` folder of your Mule
    application and set its content with the
    [JSON transformation output](#json-transformation-output) from the example that reads a flat
    file.

## See Also

- [Flat File Format](https://docs.mulesoft.com/dataweave/2.9/dataweave-formats-flatfile)

- [Flat File Schemas](https://docs.mulesoft.com/dataweave/2.9/dataweave-flat-file-schemas)

- [Set Reader and Writer Properties](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-set-reader-writer-props)

- [Configure Properties](https://docs.mulesoft.com/mule-runtime/latest/configuring-properties)

<!-- document id=95ba17c436833abf645c4fa0b8dbab723841379ac1ed9679d3543d5f9cb77320 url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook-flat-file-read-and-write.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, transform, transformer, format, xml, json, dataweave, data weave, datamapper, dwl, dfl, dw, flat file
---

# Read and Write a Flat File

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following examples show you how to read the contents of a flat file, and also how to write a
flat file following the specified schema. Each example consists of a Mule application that uses
DataWeave to read and write flat files.

When you work with flat files, configure the flat file schema to use for reading and writing flat
file content. The flat file schema defines the structure of a flat file, and this enables Mule to
write and read in this format.

These example applications are configured to work with the sample flat file data and the example
flat file schema provided in [Flat File Schemas](https://docs.mulesoft.com/dataweave/latest/dataweave-flat-file-schemas#full_schema_ex).

## Example of Reading a Flat File

The following example application consists of:

1.  A Scheduler component that triggers the flow

2.  A File Read operation that reads a flat file from the specified path

3.  A Transform Message component that transforms the content read from the flat file to JSON format

4.  A Logger component that outputs the current payload

![A flow showing the process of reading and transforming a flat file to JSON](/mulesoft/current/en-us/dataweave/latest/_images/mruntime-read-flat-file.png)

Application XML File

```xml
<mule xmlns:file="http://www.mulesoft.org/schema/mule/file"
  xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
  xmlns="http://www.mulesoft.org/schema/mule/core"
  xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
http://www.mulesoft.org/schema/mule/file http://www.mulesoft.org/schema/mule/file/current/mule-file.xsd">
  <file:config name="File_Config" doc:name="File Config" >
    <file:connection workingDir="${fileWorkingDir}" />
  </file:config>
  <configuration-properties doc:name="Configuration properties" file="flatfileconfig.properties" />
  <flow name="ReadFlatfileFlow" >
    <scheduler doc:name="Scheduler">
      <scheduling-strategy>
        <fixed-frequency frequency="10000" />
      </scheduling-strategy>
    </scheduler>
    <file:read doc:name="Read flat file" config-ref="File_Config"
    path="${fileReadPath}"
    outputMimeType='application/flatfile; schemapath=${schemaPath}'/> (1)
    <ee:transform doc:name="Transform to JSON"  >
      <ee:message >
        <ee:set-payload ><![CDATA[%dw 2.0
        output application/json
        ---
        payload]]>
        </ee:set-payload>
      </ee:message>
    </ee:transform>
    <logger level="INFO" doc:name="Logger" message='#["\n"]Reading flat file from: ${mule.home}/apps/${app.name}/${fileReadPath}#["\n"]#[payload]' />
  </flow>
</mule>
```

<table><tbody><tr><td><i data-value="1"></i><b>1</b></td><td>Note that the File Read operation configures the following attributes:<div><ul><li><p><code>path</code>: The path of the flat file to read</p></li><li><p><code>outputMimeType</code>: The output MIME type of the content, in this case, <code>application/flatfile</code></p></li><li><p><code>schemapath</code>: The reader property that specifies the path to the flat file schema (<code>.ffd</code> file)</p></li></ul></div></td></tr></tbody></table>

After its execution, the example application generates the following output:

```json
{
  "Batch": [
    {
      "TDR": [
        {
          "Record Type": "BAT",
          "Sequence Number": 2,
          "Amount": 32876,
          "Account Number": "0123456789",
          "Batch Function": "D",
          "Type": "CR"
        },
        {
          "Record Type": "BAT",
          "Sequence Number": 3,
          "Amount": 87326,
          "Account Number": "0123456788",
          "Batch Function": "D",
          "Type": "CR"
        }
      ],
      "BCF": {
        "Record Type": "BAT",
        "Sequence Number": 4,
        "Batch Transaction Count": 2,
        "Batch Transaction Amount": 120202,
        "Unique Batch Identifier": "A000000001",
        "Batch Function": "T",
        "Type": "CR"
      },
      "BCH": {
        "Record Type": "BAT",
        "Company Name": "ACME RESEARCH",
        "Sequence Number": 1,
        "Unique Batch Identifier": "A000000001",
        "Batch Function": "H"
      }
    },
    {
      "TDR": [
        {
          "Record Type": "BAT",
          "Sequence Number": 6,
          "Amount": 3582,
          "Account Number": "1234567890",
          "Batch Function": "D",
          "Type": "DB"
        },
        {
          "Record Type": "BAT",
          "Sequence Number": 7,
          "Amount": 256,
          "Account Number": "1234567891",
          "Batch Function": "D",
          "Type": "CR"
        }
      ],
      "BCF": {
        "Record Type": "BAT",
        "Sequence Number": 8,
        "Batch Transaction Count": 2,
        "Batch Transaction Amount": 3326,
        "Unique Batch Identifier": "A000000002",
        "Batch Function": "T",
        "Type": "DB"
      },
      "BCH": {
        "Record Type": "BAT",
        "Company Name": "AJAX EXPLOSIVES",
        "Sequence Number": 5,
        "Unique Batch Identifier": "A000000002",
        "Batch Function": "H"
      }
    }
  ],
  "RQF": {
    "Record Type": "RQF",
    "File Batch Count": 2,
    "File Transaction Count": 8,
    "File Transaction Amount": 116876,
    "Unique File Identifier": "A000000001",
    "Type": "CR"
  },
  "RQH": {
    "Record Type": "RQH",
    "File Creation Time": "10:10:00",
    "File Creation Date": "2018-09-01",
    "Currency": "USD",
    "Unique File Identifier": "A000000001"
  }
}
```

## Example of Writing a Flat File

The following example application contains:

1.  A Scheduler component that triggers the flow

2.  A File Read operation that reads a file containing the JSON output from the previous example

3.  A Transform Message component that transforms the JSON payload to the specified flat file format

4.  A Logger component that outputs the current payload

5.  A File Write operation that outputs the payload to a flat file in the specified target path

![A flow showing the process of writing a flat file](/mulesoft/current/en-us/dataweave/latest/_images/mruntime-write-flat-file.png)

Application XML File

```xml
<mule xmlns:file="http://www.mulesoft.org/schema/mule/file"
  xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
  xmlns="http://www.mulesoft.org/schema/mule/core"
  xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
http://www.mulesoft.org/schema/mule/file http://www.mulesoft.org/schema/mule/file/current/mule-file.xsd">
  <file:config name="File_Config" doc:name="File Config" >
    <file:connection workingDir="${fileWorkingDir}" />
  </file:config>
  <configuration-properties doc:name="Configuration properties" file="flatfileconfig.properties" />
  <flow name="WriteFlatFile" >
    <scheduler doc:name="Scheduler" >
    	<scheduling-strategy >
        <fixed-frequency frequency="10000" />
    	</scheduling-strategy>
    </scheduler>
    <file:read doc:name="Read JSON file" config-ref="File_Config" path="${jsonFileReadPath}"/>
    <ee:transform doc:name="Transform to flat file"> (1)
    	<ee:message>
        <ee:set-payload><![CDATA[%dw 2.0
output application/flatfile schemaPath = "flatfileschema.ffd"
%dw 2.0
---
{
	RQH: {
		"Record Type": payload.RQH."Record Type",
		"File Creation Date": payload.RQH."File Creation Date" as Date {format: "yyyy-MM-dd"},
		"File Creation Time": payload.RQH."File Creation Time" as Time,
		"Unique File Identifier": payload.RQH."Unique File Identifier",
		Currency: payload.RQH.Currency
	},
	Batch: payload.Batch map ( batch , indexOfBatch ) -> {
		BCH: {
			"Record Type": batch.BCH."Record Type",
			"Sequence Number": batch.BCH."Sequence Number",
			"Batch Function": batch.BCH."Batch Function",
			"Company Name": batch.BCH."Company Name",
			"Unique Batch Identifier": batch.BCH."Unique Batch Identifier"},
		TDR: batch.TDR map (tdr, indexOfTdr) ->
			{
			"Record Type": tdr.TDR."Record Type",
			"Sequence Number": tdr.TDR."Sequence Number",
			"Batch Function": tdr.TDR."Batch Function",
			"Account Number": tdr.TDR."Account Number",
			"Amount": tdr.TDR.Amount,
			"Type": tdr.TDR.'Type'
			},
		BCF: {
			"Record Type": batch.BCF."Record Type",
			"Sequence Number": batch.BCF."Sequence Number",
			"Batch Function": batch.BCF."Batch Function",
			"Batch Transaction Amount": batch.BCF."Batch Transaction Amount",
			"Type": batch.BCF.'Type',
			"Batch Transaction Count": batch.BCF."Batch Transaction Count",
			"Unique Batch Identifier": batch.BCF."Unique Batch Identifier"}
		},
	RQF: {
		"Record Type": payload.RQF."Record Type",
		"File Batch Count": payload.RQF."File Batch Count",
		"File Transaction Count": payload.RQF."File Transaction Count",
		"File Transaction Amount": payload.RQF."File Transaction Amount",
		Type: payload.RQF.Type,
		"Unique File Identifier": payload.RQF."Unique File Identifier"
	}
}
]]>
      </ee:set-payload>
    	</ee:message>
    </ee:transform>
    <logger level="INFO" doc:name="Logger" message='#["\n"]Writing flat file to: ${mule.home}/apps/${app.name}/${fileWritePath}#["\n"]#[payload]'/>
    <file:write doc:name="Write flat file" config-ref="File_Config" path="${fileWritePath}" /> (2)
	</flow>
</mule>
```

<table><tbody><tr><td><i data-value="1"></i><b>1</b></td><td>Note that the Transform component specifies the following writer properties in the script header:<div><ul><li><p><code>output</code>: The output MIME type of the transformation, in this case, <code>application/flatfile</code></p></li><li><p><code>schemapath</code>: The writer property that specifies the path to the flat file schema (<code>.ffd</code> file)</p></li></ul></div></td></tr><tr><td><i data-value="2"></i><b>2</b></td><td>Note that the File Write operation specifies the <code>path</code> property to define where to write the flat file</td></tr></tbody></table>

After its execution, the example application generates the following output:

RQH201809011010A000000001USD BAT000001HACME RESEARCH A000000001 BAT000000D 0000000000 BAT000000D
0000000000 BAT000004T0000120202CR000002A000000001 BAT000005HAJAX EXPLOSIVES A000000002 BAT000000D
0000000000 BAT000000D 0000000000 BAT000008T0000003326DB000002A000000002
RQF0002000008000000116876CRA000000001

## Test the Examples Locally

If you want to test the examples locally, follow these steps to create and configure your example
Mule application:

1.  Create a new **Mule Project** in Anypoint Studio.

2.  Copy the XML code of the application you want to test into the **Configuration XML** view of
    your project.

3.  Use [Add Modules](https://docs.mulesoft.com/studio/add-modules-in-studio-to) to add the Anypoint Connector for File
    (File Connector) to your project.

4.  Create a file named `flatfileconfig.properties` in the `src/main/resources` folder of your Mule
    application, and set its content with the following properties:

    fileReadPath=flatfile schemaPath=flatfileschema.ffd fileWritePath=flatfilenew
    jsonFileReadPath=flatFileJson.json fileWorkingDir=#\["${mule.home}/apps/${app.name}/"\]

5.  Create a file named `flatfile` in the `src/main/resources` folder of your Mule application, and
    set its content with the
    [flat file sample data](https://docs.mulesoft.com/dataweave/latest/%3Cdataweave-flat-file-schemas#flat-file-sample-data >) from the DataWeave
    flat file schema example.

6.  Create a file named `flatfileschema.ffd` in the `src/main/resources` folder of your Mule
    application, and set its content with the
    [full schema example](https://docs.mulesoft.com/dataweave/latest/dataweave-flat-file-schemas#full_schema_ex) from the DataWeave flat file
    schema example.

7.  Create a file named `flatFileJson.json` in the `src/main/resources` folder of your Mule
    application and set its content with the
    [JSON transformation output](#json-transformation-output) from the example that reads a flat
    file.

## See Also

- [Flat File Format](https://docs.mulesoft.com/dataweave/latest/dataweave-formats-flatfile)

- [Flat File Schemas](https://docs.mulesoft.com/dataweave/latest/dataweave-flat-file-schemas)

- [Set Reader and Writer Properties](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-set-reader-writer-props)

- [Configure Properties](https://docs.mulesoft.com/mule-runtime/latest/configuring-properties)

<!-- document id=c86ad4aee94577d1d9c315d62e49a147e61b9e74a085f3e18894100836ffd9d4 url=/mulesoft/current/en-us/dataweave/2.11/dw-binaries-functions-readlineswith.md -->

---
product: DataWeave
version: 2.11
---

# readLinesWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## readLinesWith(content: Binary, charset: String): Array<String>

Splits the specified binary content into lines and returns the results in an array.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>Binary data to read and split.</p></td></tr><tr><td><p><code>charset</code></p></td><td><p>String representing the encoding to read.</p></td></tr></tbody></table>

### Example

This example transforms binary content, which is separated into new lines (`\n`), in a
comma-separated array.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Binaries
var content = read("Line 1\nLine 2\nLine 3\nLine 4\nLine 5\n", "application/octet-stream")
output application/json
---
{
   lines : (content readLinesWith "UTF-8"),
   showType: typeOf(content)
}
```

#### Output

```JSON
{
   "lines": [ "Line 1", "Line 2", "Line 3", "Line 4", "Line 5" ],
   "showType": "Binary"
}
```

<!-- document id=a4e7b38aa6d08c665cfae4021b482fb13d631b627895a981b32c66a7bbddb973 url=/mulesoft/current/en-us/dataweave/2.12/dw-binaries-functions-readlineswith.md -->

---
product: DataWeave
version: 2.12
---

# readLinesWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## readLinesWith(content: Binary, charset: String): Array<String>

Splits the specified binary content into lines and returns the results in an array.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>Binary data to read and split.</p></td></tr><tr><td><p><code>charset</code></p></td><td><p>String representing the encoding to read.</p></td></tr></tbody></table>

### Example

This example transforms binary content, which is separated into new lines (`\n`), in a
comma-separated array.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Binaries
var content = read("Line 1\nLine 2\nLine 3\nLine 4\nLine 5\n", "application/octet-stream")
output application/json
---
{
   lines : (content readLinesWith "UTF-8"),
   showType: typeOf(content)
}
```

#### Output

```JSON
{
   "lines": [ "Line 1", "Line 2", "Line 3", "Line 4", "Line 5" ],
   "showType": "Binary"
}
```

<!-- document id=f6635eddfa2dcbdeee3586ec507911b8eb1cd811e49d1d0090b59a053c89cb6d url=/mulesoft/current/en-us/dataweave/2.3/dw-binaries-functions-readlineswith.md -->

---
product: DataWeave
version: 2.3
---

# readLinesWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## readLinesWith(Binary, String): Array<String>

Splits the specified binary content into lines and returns the results in an array.

_Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>Binary data to read and split.</p></td></tr><tr><td><p><code>charset</code></p></td><td><p>String representing the encoding to read.</p></td></tr></tbody></table>

### Example

This example transforms binary content, which is separated into new lines (`\n`), in a
comma-separated array.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Binaries
var content = read("Line 1\nLine 2\nLine 3\nLine 4\nLine 5\n", "application/octet-stream")
output application/json
---
{
   lines : (content readLinesWith "UTF-8"),
   showType: typeOf(content)
}
```

#### Output

```JSON
{
   "lines": [ "Line 1", "Line 2", "Line 3", "Line 4", "Line 5" ],
   "showType": "Binary"
}
```

<!-- document id=d743ce19d47bfab24f8a03582f66f03b3494c3d143fff3730c5b3152dc64979b url=/mulesoft/current/en-us/dataweave/2.4/dw-binaries-functions-readlineswith.md -->

---
product: DataWeave
version: 2.4
---

# readLinesWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## readLinesWith(content: Binary, charset: String): Array<String>

Splits the specified binary content into lines and returns the results in an array.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>Binary data to read and split.</p></td></tr><tr><td><p><code>charset</code></p></td><td><p>String representing the encoding to read.</p></td></tr></tbody></table>

### Example

This example transforms binary content, which is separated into new lines (`\n`), in a
comma-separated array.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Binaries
var content = read("Line 1\nLine 2\nLine 3\nLine 4\nLine 5\n", "application/octet-stream")
output application/json
---
{
   lines : (content readLinesWith "UTF-8"),
   showType: typeOf(content)
}
```

#### Output

```JSON
{
   "lines": [ "Line 1", "Line 2", "Line 3", "Line 4", "Line 5" ],
   "showType": "Binary"
}
```

<!-- document id=a1892d9dea4879e4de5c8c3c915bc2abcce27e9e0804e4a0e6eea5fe98aea2e3 url=/mulesoft/current/en-us/dataweave/2.6/dw-binaries-functions-readlineswith.md -->

---
product: DataWeave
version: 2.6
---

# readLinesWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## readLinesWith(content: Binary, charset: String): Array<String>

Splits the specified binary content into lines and returns the results in an array.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>Binary data to read and split.</p></td></tr><tr><td><p><code>charset</code></p></td><td><p>String representing the encoding to read.</p></td></tr></tbody></table>

### Example

This example transforms binary content, which is separated into new lines (`\n`), in a
comma-separated array.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Binaries
var content = read("Line 1\nLine 2\nLine 3\nLine 4\nLine 5\n", "application/octet-stream")
output application/json
---
{
   lines : (content readLinesWith "UTF-8"),
   showType: typeOf(content)
}
```

#### Output

```JSON
{
   "lines": [ "Line 1", "Line 2", "Line 3", "Line 4", "Line 5" ],
   "showType": "Binary"
}
```

<!-- document id=9e22823ef690e90f700c717f9717b9d766a271541ba0427ce2baf8700a1d534e url=/mulesoft/current/en-us/dataweave/2.9/dw-binaries-functions-readlineswith.md -->

---
product: DataWeave
version: 2.9
---

# readLinesWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## readLinesWith(content: Binary, charset: String): Array<String>

Splits the specified binary content into lines and returns the results in an array.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>Binary data to read and split.</p></td></tr><tr><td><p><code>charset</code></p></td><td><p>String representing the encoding to read.</p></td></tr></tbody></table>

### Example

This example transforms binary content, which is separated into new lines (`\n`), in a
comma-separated array.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Binaries
var content = read("Line 1\nLine 2\nLine 3\nLine 4\nLine 5\n", "application/octet-stream")
output application/json
---
{
   lines : (content readLinesWith "UTF-8"),
   showType: typeOf(content)
}
```

#### Output

```JSON
{
   "lines": [ "Line 1", "Line 2", "Line 3", "Line 4", "Line 5" ],
   "showType": "Binary"
}
```

<!-- document id=c6946ff7b0f3283cf9b480f720e735a0c12668c7ee10fb5f5042b99192e847ef url=/mulesoft/current/en-us/dataweave/latest/dw-binaries-functions-readlineswith.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# readLinesWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## readLinesWith(content: Binary, charset: String): Array<String>

Splits the specified binary content into lines and returns the results in an array.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>Binary data to read and split.</p></td></tr><tr><td><p><code>charset</code></p></td><td><p>String representing the encoding to read.</p></td></tr></tbody></table>

### Example

This example transforms binary content, which is separated into new lines (`\n`), in a
comma-separated array.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Binaries
var content = read("Line 1\nLine 2\nLine 3\nLine 4\nLine 5\n", "application/octet-stream")
output application/json
---
{
   lines : (content readLinesWith "UTF-8"),
   showType: typeOf(content)
}
```

#### Output

```JSON
{
   "lines": [ "Line 1", "Line 2", "Line 3", "Line 4", "Line 5" ],
   "showType": "Binary"
}
```

<!-- document id=ee90fd4002c41b26a4846288b7e71c5a3d9dd46bddba40a54f7662c4ecf31da9 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-readurl.md -->

---
product: DataWeave
version: 2.11
---

# readUrl

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## readUrl(url: String, contentType: String = "application/dw", readerProperties: Object = {}): Any

Reads a URL, including a classpath-based URL, and returns parsed content. This function works
similar to the `read` function.

The classpath-based URL uses the `classpath:` protocol prefix, for example:
`classpath://myfolder/myFile.txt` where `myFolder` is located under `src/main/resources` in a Mule
project. Other than the URL, `readURL` accepts the same arguments as `read`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>url</code></p></td><td><p>The URL string to read. It also accepts a classpath-based URL.</p></td></tr><tr><td><p><code>contentType</code></p></td><td><p>A supported format (or MIME type). Default: <code>application/dw</code>.</p></td></tr><tr><td><p><code>readerProperties</code></p></td><td><p>Optional: Sets reader configuration properties. For other formats and reader configuration properties, see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats">Supported Data Formats</a>.</p></td></tr></tbody></table>

### Example

This example reads a JSON object from a URL. (For readability, the output values shown below are
shortened with `…​`.)

#### Source

```DataWeave
%dw 2.0
output application/json
---
readUrl("https://jsonplaceholder.typicode.com/posts/1", "application/json")
```

#### Output

```JSON
{ "userId": 1, "id": 1, "title": "sunt aut ...", "body": "quia et ..." }
```

### Example

This example reads a JSON object from a `myJsonSnippet.json` file located in the
`src/main/resources` directory in Studio. (Sample JSON content for that file is shown in the Input
section below.) After reading the file contents, the script transforms selected fields from JSON to
CSV. Reading files in this way can be useful when trying out a DataWeave script on sample data,
especially when the source data is large and your script is complex.

#### Source

```DataWeave
%dw 2.0
var myJsonSnippet = readUrl("classpath://myJsonSnippet.json", "application/json")
output application/csv
---
(myJsonSnippet.results map(item) -> item.profile)
```

#### Input

```JSON
{
  "results": [
    {
      "profile": {
        "firstName": "john",
        "lastName": "doe",
        "email": "johndoe@demo.com"
      },
      "data": {
        "interests": [
          {
            "language": "English",
            "tags": [
              "digital-strategy:Digital Strategy",
              "innovation:Innovation"
            ],
            "contenttypes": []
          }
        ]
      }
    },
    {
      "profile": {
      "firstName": "jane",
        "lastName": "doe",
        "email": "janedoe@demo.com"
      },
      "data": {
        "interests": [
          {
            "language": "English",
            "tags": [
              "tax-reform:Tax Reform",
              "retail-health:Retail Health"
            ],
            "contenttypes": [
              "News",
              "Analysis",
              "Case studies",
              "Press releases"
            ]
          }
        ]
      }
    }
  ]
}
```

#### Output

```CSV
firstName,lastName,email
john,doe,johndoe@demo.com
jane,doe,janedoe@demo.com
```

### Example

This example reads a CSV file from a URL, sets reader properties to indicate that there’s no header,
and then transforms the data to JSON.

#### Source

```DataWeave
%dw 2.0
output application/json
---
readUrl("https://mywebsite.com/data.csv", "application/csv", {"header" : false})
```

#### Input

Max,the Mule,MuleSoft

#### Output

```JSON
[
 {
   "column_0": "Max",
   "column_1": "the Mule",
   "column_2": "MuleSoft"
 }
]
```

### Example

This example reads a simple `dwl` file from the `src/main/resources` directory in Studio, then
dynamically reads the value of the key `name` from it. (Sample content for the input file is shown
in the Input section below.)

#### Source

```DataWeave
%dw 2.0
output application/json
---
(readUrl("classpath://name.dwl", "application/dw")).firstName
```

#### Input

```JSON
{
  "firstName" : "Somebody",
  "lastName" : "Special"
}
```

#### Output

```CSV
"Somebody"
```

<!-- document id=280a3231d4e7121c14a6bfabb67864efc43e281fa1a6948f2f1cd9674a72d4d4 url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-readurl.md -->

---
product: DataWeave
version: 2.12
---

# readUrl

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## readUrl(url: String, contentType: String = "application/dw", readerProperties: Object = {}): Any

Reads a URL, including a classpath-based URL, and returns parsed content. This function works
similar to the `read` function.

The classpath-based URL uses the `classpath:` protocol prefix, for example:
`classpath://myfolder/myFile.txt` where `myFolder` is located under `src/main/resources` in a Mule
project. Other than the URL, `readURL` accepts the same arguments as `read`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>url</code></p></td><td><p>The URL string to read. It also accepts a classpath-based URL.</p></td></tr><tr><td><p><code>contentType</code></p></td><td><p>A supported format (or MIME type). Default: <code>application/dw</code>.</p></td></tr><tr><td><p><code>readerProperties</code></p></td><td><p>Optional: Sets reader configuration properties. For other formats and reader configuration properties, see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats">Supported Data Formats</a>.</p></td></tr></tbody></table>

### Example

This example reads a JSON object from a URL. (For readability, the output values shown below are
shortened with `…​`.)

#### Source

```DataWeave
%dw 2.0
output application/json
---
readUrl("https://jsonplaceholder.typicode.com/posts/1", "application/json")
```

#### Output

```JSON
{ "userId": 1, "id": 1, "title": "sunt aut ...", "body": "quia et ..." }
```

### Example

This example reads a JSON object from a `myJsonSnippet.json` file located in the
`src/main/resources` directory in Studio. (Sample JSON content for that file is shown in the Input
section below.) After reading the file contents, the script transforms selected fields from JSON to
CSV. Reading files in this way can be useful when trying out a DataWeave script on sample data,
especially when the source data is large and your script is complex.

#### Source

```DataWeave
%dw 2.0
var myJsonSnippet = readUrl("classpath://myJsonSnippet.json", "application/json")
output application/csv
---
(myJsonSnippet.results map(item) -> item.profile)
```

#### Input

```JSON
{
  "results": [
    {
      "profile": {
        "firstName": "john",
        "lastName": "doe",
        "email": "johndoe@demo.com"
      },
      "data": {
        "interests": [
          {
            "language": "English",
            "tags": [
              "digital-strategy:Digital Strategy",
              "innovation:Innovation"
            ],
            "contenttypes": []
          }
        ]
      }
    },
    {
      "profile": {
      "firstName": "jane",
        "lastName": "doe",
        "email": "janedoe@demo.com"
      },
      "data": {
        "interests": [
          {
            "language": "English",
            "tags": [
              "tax-reform:Tax Reform",
              "retail-health:Retail Health"
            ],
            "contenttypes": [
              "News",
              "Analysis",
              "Case studies",
              "Press releases"
            ]
          }
        ]
      }
    }
  ]
}
```

#### Output

```CSV
firstName,lastName,email
john,doe,johndoe@demo.com
jane,doe,janedoe@demo.com
```

### Example

This example reads a CSV file from a URL, sets reader properties to indicate that there’s no header,
and then transforms the data to JSON.

#### Source

```DataWeave
%dw 2.0
output application/json
---
readUrl("https://mywebsite.com/data.csv", "application/csv", {"header" : false})
```

#### Input

Max,the Mule,MuleSoft

#### Output

```JSON
[
 {
   "column_0": "Max",
   "column_1": "the Mule",
   "column_2": "MuleSoft"
 }
]
```

### Example

This example reads a simple `dwl` file from the `src/main/resources` directory in Studio, then
dynamically reads the value of the key `name` from it. (Sample content for the input file is shown
in the Input section below.)

#### Source

```DataWeave
%dw 2.0
output application/json
---
(readUrl("classpath://name.dwl", "application/dw")).firstName
```

#### Input

```JSON
{
  "firstName" : "Somebody",
  "lastName" : "Special"
}
```

#### Output

```CSV
"Somebody"
```

<!-- document id=fb0c2104448e452f95b9d3c4efd3beb3086441938f193d88be54f46c07f2cb29 url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-readurl.md -->

---
product: DataWeave
version: 2.3
---

# readUrl

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## readUrl(String, String, Object): Any

Reads a URL, including a classpath-based URL, and returns parsed content. This function works
similar to the `read` function.

The classpath-based URL uses the `` classpath:` `` protocol prefix, for example,
`classpath://myfolder/myFile.txt` where `myFolder` is located under `src/main/resources` in a Mule
project. Other than the URL, `readURL` accepts the same arguments as `read`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>url</code></p></td><td><p>The URL string to read. It also accepts a classpath-based URL.</p></td></tr><tr><td><p><code>contentType</code></p></td><td><p>A supported format (or MIME type). Default: <code>application/dw</code>.</p></td></tr><tr><td><p><code>readerProperties</code></p></td><td><p>Optional: Sets reader configuration properties. For other formats and reader configuration properties, see <a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-formats">Supported Data Formats</a>.</p></td></tr></tbody></table>

### Example

This example reads a JSON object from a URL. (For readability, the output values shown below are
shortened with `…​`.)

#### Source

```DataWeave
%dw 2.0
output application/json
---
readUrl("https://jsonplaceholder.typicode.com/posts/1", "application/json")
```

#### Output

```JSON
{ "userId": 1, "id": 1, "title": "sunt aut ...", "body": "quia et ..." }
```

### Example

This example reads a JSON object from a `myJsonSnippet.json` file located in the
`src/main/resources` directory in Studio. (Sample JSON content for that file is shown in the Input
section below.) After reading the file contents, the script transforms selected fields from JSON to
CSV. Reading files in this way can be useful when trying out a DataWeave script on sample data,
especially when the source data is large and your script is complex.

#### Source

```DataWeave
%dw 2.0
var myJsonSnippet = readUrl("classpath://myJsonSnippet.json", "application/json")
output application/csv
---
(myJsonSnippet.results map(item) -> item.profile)
```

#### Input

```JSON
{
  "results": [
    {
      "profile": {
        "firstName": "john",
        "lastName": "doe",
        "email": "johndoe@demo.com"
      },
      "data": {
        "interests": [
          {
            "language": "English",
            "tags": [
              "digital-strategy:Digital Strategy",
              "innovation:Innovation"
            ],
            "contenttypes": []
          }
        ]
      }
    },
    {
      "profile": {
      "firstName": "jane",
        "lastName": "doe",
        "email": "janedoe@demo.com"
      },
      "data": {
        "interests": [
          {
            "language": "English",
            "tags": [
              "tax-reform:Tax Reform",
              "retail-health:Retail Health"
            ],
            "contenttypes": [
              "News",
              "Analysis",
              "Case studies",
              "Press releases"
            ]
          }
        ]
      }
    }
  ]
}
```

#### Output

```CSV
firstName,lastName,email
john,doe,johndoe@demo.com
jane,doe,janedoe@demo.com
```

### Example

This example reads a CSV file from a URL, sets reader properties to indicate that there’s no header,
and then transforms the data to JSON.

#### Source

```DataWeave
%dw 2.0
output application/json
---
readUrl("https://mywebsite.com/data.csv", "application/csv", {"header" : false})
```

#### Input

Max,the Mule,MuleSoft

#### Output

```JSON
[
 {
   "column_0": "Max",
   "column_1": "the Mule",
   "column_2": "MuleSoft"
 }
]
```

### Example

This example reads a simple `dwl` file from the `src/main/resources` directory in Studio, then
dynamically reads the value of the key `name` from it. (Sample content for the input file is shown
in the Input section below.)

#### Source

```DataWeave
%dw 2.0
output application/json
---
(readUrl("classpath://name.dwl", "application/dw")).firstName
```

#### Input

```JSON
{
  "firstName" : "Somebody",
  "lastName" : "Special"
}
```

#### Output

```CSV
"Somebody"
```

<!-- document id=2eae1f6f73c26d2c9ac1575b070bb13d07c2ae93ecad30417ea434c5f6cb6187 url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-readurl.md -->

---
product: DataWeave
version: 2.4
---

# readUrl

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## readUrl(url: String, contentType: String = "application/dw", readerProperties: Object = {}): Any

Reads a URL, including a classpath-based URL, and returns parsed content. This function works
similar to the `read` function.

The classpath-based URL uses the `classpath:` protocol prefix, for example:
`classpath://myfolder/myFile.txt` where `myFolder` is located under `src/main/resources` in a Mule
project. Other than the URL, `readURL` accepts the same arguments as `read`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>url</code></p></td><td><p>The URL string to read. It also accepts a classpath-based URL.</p></td></tr><tr><td><p><code>contentType</code></p></td><td><p>A supported format (or MIME type). Default: <code>application/dw</code>.</p></td></tr><tr><td><p><code>readerProperties</code></p></td><td><p>Optional: Sets reader configuration properties. For other formats and reader configuration properties, see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats">Supported Data Formats</a>.</p></td></tr></tbody></table>

### Example

This example reads a JSON object from a URL. (For readability, the output values shown below are
shortened with `…​`.)

#### Source

```DataWeave
%dw 2.0
output application/json
---
readUrl("https://jsonplaceholder.typicode.com/posts/1", "application/json")
```

#### Output

```JSON
{ "userId": 1, "id": 1, "title": "sunt aut ...", "body": "quia et ..." }
```

### Example

This example reads a JSON object from a `myJsonSnippet.json` file located in the
`src/main/resources` directory in Studio. (Sample JSON content for that file is shown in the Input
section below.) After reading the file contents, the script transforms selected fields from JSON to
CSV. Reading files in this way can be useful when trying out a DataWeave script on sample data,
especially when the source data is large and your script is complex.

#### Source

```DataWeave
%dw 2.0
var myJsonSnippet = readUrl("classpath://myJsonSnippet.json", "application/json")
output application/csv
---
(myJsonSnippet.results map(item) -> item.profile)
```

#### Input

```JSON
{
  "results": [
    {
      "profile": {
        "firstName": "john",
        "lastName": "doe",
        "email": "johndoe@demo.com"
      },
      "data": {
        "interests": [
          {
            "language": "English",
            "tags": [
              "digital-strategy:Digital Strategy",
              "innovation:Innovation"
            ],
            "contenttypes": []
          }
        ]
      }
    },
    {
      "profile": {
      "firstName": "jane",
        "lastName": "doe",
        "email": "janedoe@demo.com"
      },
      "data": {
        "interests": [
          {
            "language": "English",
            "tags": [
              "tax-reform:Tax Reform",
              "retail-health:Retail Health"
            ],
            "contenttypes": [
              "News",
              "Analysis",
              "Case studies",
              "Press releases"
            ]
          }
        ]
      }
    }
  ]
}
```

#### Output

```CSV
firstName,lastName,email
john,doe,johndoe@demo.com
jane,doe,janedoe@demo.com
```

### Example

This example reads a CSV file from a URL, sets reader properties to indicate that there’s no header,
and then transforms the data to JSON.

#### Source

```DataWeave
%dw 2.0
output application/json
---
readUrl("https://mywebsite.com/data.csv", "application/csv", {"header" : false})
```

#### Input

Max,the Mule,MuleSoft

#### Output

```JSON
[
 {
   "column_0": "Max",
   "column_1": "the Mule",
   "column_2": "MuleSoft"
 }
]
```

### Example

This example reads a simple `dwl` file from the `src/main/resources` directory in Studio, then
dynamically reads the value of the key `name` from it. (Sample content for the input file is shown
in the Input section below.)

#### Source

```DataWeave
%dw 2.0
output application/json
---
(readUrl("classpath://name.dwl", "application/dw")).firstName
```

#### Input

```JSON
{
  "firstName" : "Somebody",
  "lastName" : "Special"
}
```

#### Output

```CSV
"Somebody"
```

<!-- document id=832c6c470529f083be07f4b1d119cae0b6fe238a0fd57b4a81aad4de9a38df88 url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-readurl.md -->

---
product: DataWeave
version: 2.6
---

# readUrl

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## readUrl(url: String, contentType: String = "application/dw", readerProperties: Object = {}): Any

Reads a URL, including a classpath-based URL, and returns parsed content. This function works
similar to the `read` function.

The classpath-based URL uses the `classpath:` protocol prefix, for example:
`classpath://myfolder/myFile.txt` where `myFolder` is located under `src/main/resources` in a Mule
project. Other than the URL, `readURL` accepts the same arguments as `read`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>url</code></p></td><td><p>The URL string to read. It also accepts a classpath-based URL.</p></td></tr><tr><td><p><code>contentType</code></p></td><td><p>A supported format (or MIME type). Default: <code>application/dw</code>.</p></td></tr><tr><td><p><code>readerProperties</code></p></td><td><p>Optional: Sets reader configuration properties. For other formats and reader configuration properties, see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats">Supported Data Formats</a>.</p></td></tr></tbody></table>

### Example

This example reads a JSON object from a URL. (For readability, the output values shown below are
shortened with `…​`.)

#### Source

```DataWeave
%dw 2.0
output application/json
---
readUrl("https://jsonplaceholder.typicode.com/posts/1", "application/json")
```

#### Output

```JSON
{ "userId": 1, "id": 1, "title": "sunt aut ...", "body": "quia et ..." }
```

### Example

This example reads a JSON object from a `myJsonSnippet.json` file located in the
`src/main/resources` directory in Studio. (Sample JSON content for that file is shown in the Input
section below.) After reading the file contents, the script transforms selected fields from JSON to
CSV. Reading files in this way can be useful when trying out a DataWeave script on sample data,
especially when the source data is large and your script is complex.

#### Source

```DataWeave
%dw 2.0
var myJsonSnippet = readUrl("classpath://myJsonSnippet.json", "application/json")
output application/csv
---
(myJsonSnippet.results map(item) -> item.profile)
```

#### Input

```JSON
{
  "results": [
    {
      "profile": {
        "firstName": "john",
        "lastName": "doe",
        "email": "johndoe@demo.com"
      },
      "data": {
        "interests": [
          {
            "language": "English",
            "tags": [
              "digital-strategy:Digital Strategy",
              "innovation:Innovation"
            ],
            "contenttypes": []
          }
        ]
      }
    },
    {
      "profile": {
      "firstName": "jane",
        "lastName": "doe",
        "email": "janedoe@demo.com"
      },
      "data": {
        "interests": [
          {
            "language": "English",
            "tags": [
              "tax-reform:Tax Reform",
              "retail-health:Retail Health"
            ],
            "contenttypes": [
              "News",
              "Analysis",
              "Case studies",
              "Press releases"
            ]
          }
        ]
      }
    }
  ]
}
```

#### Output

```CSV
firstName,lastName,email
john,doe,johndoe@demo.com
jane,doe,janedoe@demo.com
```

### Example

This example reads a CSV file from a URL, sets reader properties to indicate that there’s no header,
and then transforms the data to JSON.

#### Source

```DataWeave
%dw 2.0
output application/json
---
readUrl("https://mywebsite.com/data.csv", "application/csv", {"header" : false})
```

#### Input

Max,the Mule,MuleSoft

#### Output

```JSON
[
 {
   "column_0": "Max",
   "column_1": "the Mule",
   "column_2": "MuleSoft"
 }
]
```

### Example

This example reads a simple `dwl` file from the `src/main/resources` directory in Studio, then
dynamically reads the value of the key `name` from it. (Sample content for the input file is shown
in the Input section below.)

#### Source

```DataWeave
%dw 2.0
output application/json
---
(readUrl("classpath://name.dwl", "application/dw")).firstName
```

#### Input

```JSON
{
  "firstName" : "Somebody",
  "lastName" : "Special"
}
```

#### Output

```CSV
"Somebody"
```

<!-- document id=2e8dfece842e611816e5614572313220f8d83c76c5730639d67fa73f2004e087 url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-readurl.md -->

---
product: DataWeave
version: 2.9
---

# readUrl

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## readUrl(url: String, contentType: String = "application/dw", readerProperties: Object = {}): Any

Reads a URL, including a classpath-based URL, and returns parsed content. This function works
similar to the `read` function.

The classpath-based URL uses the `classpath:` protocol prefix, for example:
`classpath://myfolder/myFile.txt` where `myFolder` is located under `src/main/resources` in a Mule
project. Other than the URL, `readURL` accepts the same arguments as `read`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>url</code></p></td><td><p>The URL string to read. It also accepts a classpath-based URL.</p></td></tr><tr><td><p><code>contentType</code></p></td><td><p>A supported format (or MIME type). Default: <code>application/dw</code>.</p></td></tr><tr><td><p><code>readerProperties</code></p></td><td><p>Optional: Sets reader configuration properties. For other formats and reader configuration properties, see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats">Supported Data Formats</a>.</p></td></tr></tbody></table>

### Example

This example reads a JSON object from a URL. (For readability, the output values shown below are
shortened with `…​`.)

#### Source

```DataWeave
%dw 2.0
output application/json
---
readUrl("https://jsonplaceholder.typicode.com/posts/1", "application/json")
```

#### Output

```JSON
{ "userId": 1, "id": 1, "title": "sunt aut ...", "body": "quia et ..." }
```

### Example

This example reads a JSON object from a `myJsonSnippet.json` file located in the
`src/main/resources` directory in Studio. (Sample JSON content for that file is shown in the Input
section below.) After reading the file contents, the script transforms selected fields from JSON to
CSV. Reading files in this way can be useful when trying out a DataWeave script on sample data,
especially when the source data is large and your script is complex.

#### Source

```DataWeave
%dw 2.0
var myJsonSnippet = readUrl("classpath://myJsonSnippet.json", "application/json")
output application/csv
---
(myJsonSnippet.results map(item) -> item.profile)
```

#### Input

```JSON
{
  "results": [
    {
      "profile": {
        "firstName": "john",
        "lastName": "doe",
        "email": "johndoe@demo.com"
      },
      "data": {
        "interests": [
          {
            "language": "English",
            "tags": [
              "digital-strategy:Digital Strategy",
              "innovation:Innovation"
            ],
            "contenttypes": []
          }
        ]
      }
    },
    {
      "profile": {
      "firstName": "jane",
        "lastName": "doe",
        "email": "janedoe@demo.com"
      },
      "data": {
        "interests": [
          {
            "language": "English",
            "tags": [
              "tax-reform:Tax Reform",
              "retail-health:Retail Health"
            ],
            "contenttypes": [
              "News",
              "Analysis",
              "Case studies",
              "Press releases"
            ]
          }
        ]
      }
    }
  ]
}
```

#### Output

```CSV
firstName,lastName,email
john,doe,johndoe@demo.com
jane,doe,janedoe@demo.com
```

### Example

This example reads a CSV file from a URL, sets reader properties to indicate that there’s no header,
and then transforms the data to JSON.

#### Source

```DataWeave
%dw 2.0
output application/json
---
readUrl("https://mywebsite.com/data.csv", "application/csv", {"header" : false})
```

#### Input

Max,the Mule,MuleSoft

#### Output

```JSON
[
 {
   "column_0": "Max",
   "column_1": "the Mule",
   "column_2": "MuleSoft"
 }
]
```

### Example

This example reads a simple `dwl` file from the `src/main/resources` directory in Studio, then
dynamically reads the value of the key `name` from it. (Sample content for the input file is shown
in the Input section below.)

#### Source

```DataWeave
%dw 2.0
output application/json
---
(readUrl("classpath://name.dwl", "application/dw")).firstName
```

#### Input

```JSON
{
  "firstName" : "Somebody",
  "lastName" : "Special"
}
```

#### Output

```CSV
"Somebody"
```

<!-- document id=de96c2f3100f11e2d69b40801b9dba430e3563bdeaa223cb4f900cf35420d03d url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-readurl.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# readUrl

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## readUrl(url: String, contentType: String = "application/dw", readerProperties: Object = {}): Any

Reads a URL, including a classpath-based URL, and returns parsed content. This function works
similar to the `read` function.

The classpath-based URL uses the `classpath:` protocol prefix, for example:
`classpath://myfolder/myFile.txt` where `myFolder` is located under `src/main/resources` in a Mule
project. Other than the URL, `readURL` accepts the same arguments as `read`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>url</code></p></td><td><p>The URL string to read. It also accepts a classpath-based URL.</p></td></tr><tr><td><p><code>contentType</code></p></td><td><p>A supported format (or MIME type). Default: <code>application/dw</code>.</p></td></tr><tr><td><p><code>readerProperties</code></p></td><td><p>Optional: Sets reader configuration properties. For other formats and reader configuration properties, see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats">Supported Data Formats</a>.</p></td></tr></tbody></table>

### Example

This example reads a JSON object from a URL. (For readability, the output values shown below are
shortened with `…​`.)

#### Source

```DataWeave
%dw 2.0
output application/json
---
readUrl("https://jsonplaceholder.typicode.com/posts/1", "application/json")
```

#### Output

```JSON
{ "userId": 1, "id": 1, "title": "sunt aut ...", "body": "quia et ..." }
```

### Example

This example reads a JSON object from a `myJsonSnippet.json` file located in the
`src/main/resources` directory in Studio. (Sample JSON content for that file is shown in the Input
section below.) After reading the file contents, the script transforms selected fields from JSON to
CSV. Reading files in this way can be useful when trying out a DataWeave script on sample data,
especially when the source data is large and your script is complex.

#### Source

```DataWeave
%dw 2.0
var myJsonSnippet = readUrl("classpath://myJsonSnippet.json", "application/json")
output application/csv
---
(myJsonSnippet.results map(item) -> item.profile)
```

#### Input

```JSON
{
  "results": [
    {
      "profile": {
        "firstName": "john",
        "lastName": "doe",
        "email": "johndoe@demo.com"
      },
      "data": {
        "interests": [
          {
            "language": "English",
            "tags": [
              "digital-strategy:Digital Strategy",
              "innovation:Innovation"
            ],
            "contenttypes": []
          }
        ]
      }
    },
    {
      "profile": {
      "firstName": "jane",
        "lastName": "doe",
        "email": "janedoe@demo.com"
      },
      "data": {
        "interests": [
          {
            "language": "English",
            "tags": [
              "tax-reform:Tax Reform",
              "retail-health:Retail Health"
            ],
            "contenttypes": [
              "News",
              "Analysis",
              "Case studies",
              "Press releases"
            ]
          }
        ]
      }
    }
  ]
}
```

#### Output

```CSV
firstName,lastName,email
john,doe,johndoe@demo.com
jane,doe,janedoe@demo.com
```

### Example

This example reads a CSV file from a URL, sets reader properties to indicate that there’s no header,
and then transforms the data to JSON.

#### Source

```DataWeave
%dw 2.0
output application/json
---
readUrl("https://mywebsite.com/data.csv", "application/csv", {"header" : false})
```

#### Input

Max,the Mule,MuleSoft

#### Output

```JSON
[
 {
   "column_0": "Max",
   "column_1": "the Mule",
   "column_2": "MuleSoft"
 }
]
```

### Example

This example reads a simple `dwl` file from the `src/main/resources` directory in Studio, then
dynamically reads the value of the key `name` from it. (Sample content for the input file is shown
in the Input section below.)

#### Source

```DataWeave
%dw 2.0
output application/json
---
(readUrl("classpath://name.dwl", "application/dw")).firstName
```

#### Input

```JSON
{
  "firstName" : "Somebody",
  "lastName" : "Special"
}
```

#### Output

```CSV
"Somebody"
```

<!-- document id=bc3ac5c0b55b5a0d8cc80c4578ed7106c1d58a06dbc34d649ecf125a05b9cf56 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-reduce.md -->

---
product: DataWeave
version: 2.11
---

# reduce

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## reduce<T>(@StreamCapable items: Array<T>, callback: (item: T, accumulator: T) -> T): T | Null

Applies a reduction expression to the elements in an array.

For each element of the input array, in order, `reduce` applies the reduction lambda expression
(function), then replaces the accumulator with the new result. The lambda expression can use both
the current input array element and the current accumulator value.

Note that if the array is empty and no default value is set on the accumulator parameter, a null
value is returned.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>item</code></p></td><td><p>Item in the input array. It provides the value to reduce. Can also be referenced as <code>$</code>.</p></td></tr><tr><td><p><code>acc</code></p></td><td><p>The accumulator. Can also be referenced as <code>$$</code>. Used to store the result of the lambda expression after each iteration of the <code>reduce</code> operation.</p><p>The accumulator parameter can be set to an initial value using the syntax <code>acc = initValue</code>. In this case, the lambda expression is called with the first element of the input array. Then the result is set as the new accumulator value.</p><p>If an initial value for the accumulator is not set, the accumulator is set to the first element of the input array. Then the lambda expression is called with the second element of the input array.</p><p>The initial value of the accumulator and the lambda expression dictate the type of result produced by the <code>reduce</code> function. If the accumulator is set to <code>acc = {}</code>, the result is usually of type <code>Object</code>. If the accumulator is set to <code>acc = []</code>, the result is usually of type <code>Array</code>. If the accumulator is set to <code>acc = ""</code>, the result is usually a <code>String</code>.</p></td></tr></tbody></table>

### Example

This example returns the sum of the numeric values in the first input array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[2, 3] reduce ($ + $$)
```

#### Output

```JSON
5
```

### Example

This example adds the numbers in the `sum` example, concatenates the same numbers in `concat`, and
shows that an empty array `[]` (defined in `myEmptyList`) returns `null` in `emptyList`.

#### Source

```DataWeave
%dw 2.0
var myNums = [1,2,3,4]
var myEmptyList = []
output application/json
---
{
   "sum" : myNums reduce ($$ + $),
   "concat" : myNums reduce ($$ ++ $),
   "emptyList" : myEmptyList reduce ($$ ++ $)
}
```

#### Output

```JSON
{ "sum": 10, "concat": "1234", "emptyList": null }
```

### Example

This example sets the first element from the first input array to `"z"`, and it adds `3` to the sum
of the second input array. In `multiply`, it shows how to multiply each value in an array by the
next (`[2,3,3] reduce ((item, acc) → acc * item)`) to produce a final result of `18` (=
`2 * 3 * 3`). The final example, `multiplyAcc`, sets the accumulator to `3` to multiply the result
of `acc * item` (= `12`) by `3` (that is, `3 (2 * 2 * 3) = 36`), as shown in the output.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
   "concat" : ["a", "b", "c", "d"] reduce ((item, acc = "z") -> acc ++ item),
   "sum": [0, 1, 2, 3, 4, 5] reduce ((item, acc = 3) -> acc + item),
   "multiply" : [2,3,3] reduce ((item, acc) -> acc * item),
   "multiplyAcc" : [2,2,3] reduce ((item, acc = 3) -> acc * item)
}
```

#### Output

```JSON
{ "concat": "zabcd", "sum": 18, "multiply": 18, "multiplyAcc": 36 }
```

### Example

This example shows a variety of uses of `reduce`, including its application to arrays of boolean
values and objects.

#### Source

```DataWeave
%dw 2.0
output application/json
var myVar =
{
  "a": [0, 1, 2, 3, 4, 5],
  "b": ["a", "b", "c", "d", "e"],
  "c": [{ "letter": "a" }, { "letter": "b" }, { "letter": "c" }],
  "d": [true, false, false, true, true]
}
---
{
  "a" : [0, 1, 2, 3, 4, 5] reduce $$,
  "b": ["a", "b", "c", "d", "e"] reduce $$,
  "c": [{ "letter": "a" }, { "letter": "b" }, { "letter": "c" }] reduce ((item, acc = "z") -> acc ++ item.letter),
  "d": [{ letter: "a" }, { letter: "b" }, { letter: "c" }] reduce $$,
  "e": [true, false, false, true, true] reduce ($$ and $),
  "f": [true, false, false, true, true] reduce ((item, acc) -> acc and item),
  "g": [true, false, false, true, true] reduce ((item, acc = false) -> acc and item),
  "h": [true, false, false, true, true] reduce $$,
  "i": myVar.a reduce ($$ + $),
  "j": myVar.a reduce ((item, acc) -> acc + item),
  "k": myVar.a reduce ((item, acc = 3) -> acc + item),
  "l": myVar.a reduce $$,
  "m": myVar.b reduce ($$ ++ $),
  "n": myVar.b reduce ((item, acc) -> acc ++ item),
  "o": myVar.b reduce ((item, acc = "z") -> acc ++ item),
  "p": myVar.b reduce $$,
  "q": myVar.c reduce ((item, acc = "z") -> acc ++ item.letter),
  "r": myVar.c reduce $$,
  "s": myVar.d reduce ($$ and $),
  "t": myVar.d reduce ((item, acc) -> acc and item),
  "u": myVar.d reduce ((item, acc = false) -> acc and item),
  "v": myVar.d reduce $$,
  "w": ([0, 1, 2, 3, 4] reduce ((item, acc = {}) -> acc ++ { a: item })) pluck $,
  "x": [] reduce $$,
  "y": [] reduce ((item,acc = 0) -> acc + item)
}
```

#### Output

```JSON
"a": 0,
"b": "a",
"c": "zabc",
"d": { "letter": "a" },
"e": false,
"f": false,
"g": false,
"h": true,
"i": 15,
"j": 15,
"k": 18,
"l": 0,
"m": "abcde",
"n": "abcde",
"o": "zabcde",
"p": "a",
"q": "zabc",
"r": { "letter": "a" },
"s": false,
"t": false,
"u": false,
"v": true,
"w": [ 0,1,2,3,4 ],
"x": null,
"y": 0
}
```

## reduce<T, A>(@StreamCapable items: Array<T>, callback: (item: T, accumulator: A) -> A): A

## reduce(@StreamCapable text: String, callback: (item: String, accumulator: String) -> String): String

Applies a reduction expression to the characters in a string.

For each character of the input string, in order, `reduce` applies the reduction lambda expression
(function), then replaces the accumulator with the new result. The lambda expression can use both
the current character and the current accumulator value.

Note that if the string is empty and no default value is set on the accumulator parameter, an empty
string is returned.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to reduce.</p></td></tr><tr><td><p><code>callback</code></p></td><td><p>The function to apply.</p></td></tr></tbody></table>

### Example

This example shows how `reduce` can be used to reverse a string.

#### Source

```DataWeave
%dw 2.0
output application/json
---
"hello world" reduce (item, acc = "") -> item ++ acc
```

#### Output

```Json
"dlrow olleh"
```

## reduce<A>(@StreamCapable text: String, callback: (item: String, accumulator: A) -> A): A

## reduce<T, A>(@StreamCapable items: Null, callback: (item: T, accumulator: A) -> A): Null

Helper function that enables `reduce` to work with a `null` value.

<!-- document id=64cf5a1e1f0b74d001eb6fe9e1fc6398f10c9ac5ccc223c31cec69aa7b1d7031 url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-reduce.md -->

---
product: DataWeave
version: 2.12
---

# reduce

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## reduce<T>(@StreamCapable items: Array<T>, callback: (item: T, accumulator: T) -> T): T | Null

Applies a reduction expression to the elements in an array.

For each element of the input array, in order, `reduce` applies the reduction lambda expression
(function), then replaces the accumulator with the new result. The lambda expression can use both
the current input array element and the current accumulator value.

Note that if the array is empty and no default value is set on the accumulator parameter, a null
value is returned.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>item</code></p></td><td><p>Item in the input array. It provides the value to reduce. Can also be referenced as <code>$</code>.</p></td></tr><tr><td><p><code>acc</code></p></td><td><p>The accumulator. Can also be referenced as <code>$$</code>. Used to store the result of the lambda expression after each iteration of the <code>reduce</code> operation.</p><p>The accumulator parameter can be set to an initial value using the syntax <code>acc = initValue</code>. In this case, the lambda expression is called with the first element of the input array. Then the result is set as the new accumulator value.</p><p>If an initial value for the accumulator is not set, the accumulator is set to the first element of the input array. Then the lambda expression is called with the second element of the input array.</p><p>The initial value of the accumulator and the lambda expression dictate the type of result produced by the <code>reduce</code> function. If the accumulator is set to <code>acc = {}</code>, the result is usually of type <code>Object</code>. If the accumulator is set to <code>acc = []</code>, the result is usually of type <code>Array</code>. If the accumulator is set to <code>acc = ""</code>, the result is usually a <code>String</code>.</p></td></tr></tbody></table>

### Example

This example returns the sum of the numeric values in the first input array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[2, 3] reduce ($ + $$)
```

#### Output

```JSON
5
```

### Example

This example adds the numbers in the `sum` example, concatenates the same numbers in `concat`, and
shows that an empty array `[]` (defined in `myEmptyList`) returns `null` in `emptyList`.

#### Source

```DataWeave
%dw 2.0
var myNums = [1,2,3,4]
var myEmptyList = []
output application/json
---
{
   "sum" : myNums reduce ($$ + $),
   "concat" : myNums reduce ($$ ++ $),
   "emptyList" : myEmptyList reduce ($$ ++ $)
}
```

#### Output

```JSON
{ "sum": 10, "concat": "1234", "emptyList": null }
```

### Example

This example sets the first element from the first input array to `"z"`, and it adds `3` to the sum
of the second input array. In `multiply`, it shows how to multiply each value in an array by the
next (`[2,3,3] reduce ((item, acc) → acc * item)`) to produce a final result of `18` (=
`2 * 3 * 3`). The final example, `multiplyAcc`, sets the accumulator to `3` to multiply the result
of `acc * item` (= `12`) by `3` (that is, `3 (2 * 2 * 3) = 36`), as shown in the output.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
   "concat" : ["a", "b", "c", "d"] reduce ((item, acc = "z") -> acc ++ item),
   "sum": [0, 1, 2, 3, 4, 5] reduce ((item, acc = 3) -> acc + item),
   "multiply" : [2,3,3] reduce ((item, acc) -> acc * item),
   "multiplyAcc" : [2,2,3] reduce ((item, acc = 3) -> acc * item)
}
```

#### Output

```JSON
{ "concat": "zabcd", "sum": 18, "multiply": 18, "multiplyAcc": 36 }
```

### Example

This example shows a variety of uses of `reduce`, including its application to arrays of boolean
values and objects.

#### Source

```DataWeave
%dw 2.0
output application/json
var myVar =
{
  "a": [0, 1, 2, 3, 4, 5],
  "b": ["a", "b", "c", "d", "e"],
  "c": [{ "letter": "a" }, { "letter": "b" }, { "letter": "c" }],
  "d": [true, false, false, true, true]
}
---
{
  "a" : [0, 1, 2, 3, 4, 5] reduce $$,
  "b": ["a", "b", "c", "d", "e"] reduce $$,
  "c": [{ "letter": "a" }, { "letter": "b" }, { "letter": "c" }] reduce ((item, acc = "z") -> acc ++ item.letter),
  "d": [{ letter: "a" }, { letter: "b" }, { letter: "c" }] reduce $$,
  "e": [true, false, false, true, true] reduce ($$ and $),
  "f": [true, false, false, true, true] reduce ((item, acc) -> acc and item),
  "g": [true, false, false, true, true] reduce ((item, acc = false) -> acc and item),
  "h": [true, false, false, true, true] reduce $$,
  "i": myVar.a reduce ($$ + $),
  "j": myVar.a reduce ((item, acc) -> acc + item),
  "k": myVar.a reduce ((item, acc = 3) -> acc + item),
  "l": myVar.a reduce $$,
  "m": myVar.b reduce ($$ ++ $),
  "n": myVar.b reduce ((item, acc) -> acc ++ item),
  "o": myVar.b reduce ((item, acc = "z") -> acc ++ item),
  "p": myVar.b reduce $$,
  "q": myVar.c reduce ((item, acc = "z") -> acc ++ item.letter),
  "r": myVar.c reduce $$,
  "s": myVar.d reduce ($$ and $),
  "t": myVar.d reduce ((item, acc) -> acc and item),
  "u": myVar.d reduce ((item, acc = false) -> acc and item),
  "v": myVar.d reduce $$,
  "w": ([0, 1, 2, 3, 4] reduce ((item, acc = {}) -> acc ++ { a: item })) pluck $,
  "x": [] reduce $$,
  "y": [] reduce ((item,acc = 0) -> acc + item)
}
```

#### Output

```JSON
"a": 0,
"b": "a",
"c": "zabc",
"d": { "letter": "a" },
"e": false,
"f": false,
"g": false,
"h": true,
"i": 15,
"j": 15,
"k": 18,
"l": 0,
"m": "abcde",
"n": "abcde",
"o": "zabcde",
"p": "a",
"q": "zabc",
"r": { "letter": "a" },
"s": false,
"t": false,
"u": false,
"v": true,
"w": [ 0,1,2,3,4 ],
"x": null,
"y": 0
}
```

## reduce<T, A>(@StreamCapable items: Array<T>, callback: (item: T, accumulator: A) -> A): A

## reduce(@StreamCapable text: String, callback: (item: String, accumulator: String) -> String): String

Applies a reduction expression to the characters in a string.

For each character of the input string, in order, `reduce` applies the reduction lambda expression
(function), then replaces the accumulator with the new result. The lambda expression can use both
the current character and the current accumulator value.

Note that if the string is empty and no default value is set on the accumulator parameter, an empty
string is returned.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to reduce.</p></td></tr><tr><td><p><code>callback</code></p></td><td><p>The function to apply.</p></td></tr></tbody></table>

### Example

This example shows how `reduce` can be used to reverse a string.

#### Source

```DataWeave
%dw 2.0
output application/json
---
"hello world" reduce (item, acc = "") -> item ++ acc
```

#### Output

```Json
"dlrow olleh"
```

## reduce<A>(@StreamCapable text: String, callback: (item: String, accumulator: A) -> A): A

## reduce<T, A>(@StreamCapable items: Null, callback: (item: T, accumulator: A) -> A): Null

Helper function that enables `reduce` to work with a `null` value.

<!-- document id=c1974839a4f1151206cc6d5ee6303a7fc5ba32346fee99810335383b94ee47af url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-reduce.md -->

---
product: DataWeave
version: 2.3
---

# reduce

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## reduce(Array<T>, (item: T, accumulator: T) -> T): T | Null

Applies a reduction expression to the elements in an array.

For each element of the input array, in order, `reduce` applies the reduction lambda expression
(function), then replaces the accumulator with the new result. The lambda expression can use both
the current input array element and the current accumulator value.

Note that if the array is empty and no default value is set on the accumulator parameter, a null
value is returned.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>item</code></p></td><td><p>Item in the input array. It provides the value to reduce. Can also be referenced as <code>$</code>.</p></td></tr><tr><td><p><code>acc</code></p></td><td><div><div><p>The accumulator. Can also be referenced as <code>$$</code>. Used to store the result of the lambda expression after each iteration of the reduce operation.</p></div><div><p>The accumulator parameter can be set to an initial value using the syntax <code>acc = initValue</code>. In this case, the lambda expression is called with the first element of the input array. Then the result is set as the new accumulator value.</p></div><div><p>If an initial value for the accumulator is not set, the accumulator is set to the first element of the input array. Then the lambda expression is called with the second element of the input array.</p></div><div><p>The initial value of the accumulator and the lambda expression dictate the type of result produced by the <code>reduce</code> function. If the accumulator is set to <code>acc = {}</code>, the result is usually of type <code>Object</code>. If the accumulator is set to <code>acc = []</code>, the result is usually of type <code>Array</code>. If the accumulator is set to <code>acc = ""</code>, the result is usually a <code>String</code>.</p></div></div></td></tr></tbody></table>

### Example

This example returns the sum of the numeric values in the first input array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[2, 3] reduce ($ + $$)
```

#### Output

```JSON
5
```

### Example

This example adds the numbers in the `sum` example, concatenates the same numbers in `concat`, and
shows that an empty array `[]` (defined in `myEmptyList`) returns `null` in `emptyList`.

#### Source

```DataWeave
%dw 2.0
var myNums = [1,2,3,4]
var myEmptyList = []
output application/json
---
{
   "sum" : myNums reduce ($$ + $),
   "concat" : myNums reduce ($$ ++ $),
   "emptyList" : myEmptyList reduce ($$ ++ $)
}
```

#### Output

```JSON
{ "sum": 10, "concat": "1234", "emptyList": null }
```

### Example

This example sets the first element from the first input array to `"z"`, and it adds `3` to the sum
of the second input array. In `multiply`, it shows how to multiply each value in an array by the
next (`[2,3,3] reduce ((item, acc) → acc * item)`) to produce a final result of `18` (=
`2 * 3 * 3`). The final example, `multiplyAcc`, sets the accumulator to `3` to multiply the result
of `acc * item` (= `12`) by `3` (that is, `3 (2 * 2 * 3) = 36`), as shown in the output.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
   "concat" : ["a", "b", "c", "d"] reduce ((item, acc = "z") -> acc ++ item),
   "sum": [0, 1, 2, 3, 4, 5] reduce ((item, acc = 3) -> acc + item),
   "multiply" : [2,3,3] reduce ((item, acc) -> acc * item),
   "multiplyAcc" : [2,2,3] reduce ((item, acc = 3) -> acc * item)
}
```

#### Output

```JSON
{ "concat": "zabcd", "sum": 18, "multiply": 18, "multiplyAcc": 36 }
```

### Example

This example shows a variety of uses of `reduce`, including its application to arrays of boolean
values and objects.

#### Source

```DataWeave
%dw 2.0
output application/json
var myVar =
{
  "a": [0, 1, 2, 3, 4, 5],
  "b": ["a", "b", "c", "d", "e"],
  "c": [{ "letter": "a" }, { "letter": "b" }, { "letter": "c" }],
  "d": [true, false, false, true, true]
}
---
{
  "a" : [0, 1, 2, 3, 4, 5] reduce $$,
  "b": ["a", "b", "c", "d", "e"] reduce $$,
  "c": [{ "letter": "a" }, { "letter": "b" }, { "letter": "c" }] reduce ((item, acc = "z") -> acc ++ item.letter),
  "d": [{ letter: "a" }, { letter: "b" }, { letter: "c" }] reduce $$,
  "e": [true, false, false, true, true] reduce ($$ and $),
  "f": [true, false, false, true, true] reduce ((item, acc) -> acc and item),
  "g": [true, false, false, true, true] reduce ((item, acc = false) -> acc and item),
  "h": [true, false, false, true, true] reduce $$,
  "i": myVar.a reduce ($$ + $),
  "j": myVar.a reduce ((item, acc) -> acc + item),
  "k": myVar.a reduce ((item, acc = 3) -> acc + item),
  "l": myVar.a reduce $$,
  "m": myVar.b reduce ($$ ++ $),
  "n": myVar.b reduce ((item, acc) -> acc ++ item),
  "o": myVar.b reduce ((item, acc = "z") -> acc ++ item),
  "p": myVar.b reduce $$,
  "q": myVar.c reduce ((item, acc = "z") -> acc ++ item.letter),
  "r": myVar.c reduce $$,
  "s": myVar.d reduce ($$ and $),
  "t": myVar.d reduce ((item, acc) -> acc and item),
  "u": myVar.d reduce ((item, acc = false) -> acc and item),
  "v": myVar.d reduce $$,
  "w": ([0, 1, 2, 3, 4] reduce ((item, acc = {}) -> acc ++ { a: item })) pluck $,
  "x": [] reduce $$,
  "y": [] reduce ((item,acc = 0) -> acc + item)
}
```

#### Output

```JSON
"a": 0,
"b": "a",
"c": "zabc",
"d": { "letter": "a" },
"e": false,
"f": false,
"g": false,
"h": true,
"i": 15,
"j": 15,
"k": 18,
"l": 0,
"m": "abcde",
"n": "abcde",
"o": "zabcde",
"p": "a",
"q": "zabc",
"r": { "letter": "a" },
"s": false,
"t": false,
"u": false,
"v": true,
"w": [ 0,1,2,3,4 ],
"x": null,
"y": 0
}
```

### Example

This example concatenates all XML node values to String.

#### Source

```xml
<root>
  <line>1</line>
  <line>2</line>
  <line>3</line>
  <line>4</line>
</root>
```

#### DataWeave Script

```DataWeave
%dw 2.0
output application/json
---
concat: payload.root.*line reduce ($$ ++ $)
```

#### Output

```JSON
{
  "concat": "1234"
}
```

## reduce(Array<T>, (item: T, accumulator: A) -> A): A

<!-- document id=35d287d4d4b5b22cfbebd0b7c986819848049803316158d2fbc44951b440b504 url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-reduce.md -->

---
product: DataWeave
version: 2.4
---

# reduce

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## reduce<T>(@StreamCapable items: Array<T>, callback: (item: T, accumulator: T) -> T): T | Null

Applies a reduction expression to the elements in an array.

For each element of the input array, in order, `reduce` applies the reduction lambda expression
(function), then replaces the accumulator with the new result. The lambda expression can use both
the current input array element and the current accumulator value.

Note that if the array is empty and no default value is set on the accumulator parameter, a null
value is returned.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>item</code></p></td><td><p>Item in the input array. It provides the value to reduce. Can also be referenced as <code>$</code>.</p></td></tr><tr><td><p><code>acc</code></p></td><td><p>The accumulator. Can also be referenced as <code>$$</code>. Used to store the result of the lambda expression after each iteration of the <code>reduce</code> operation.</p><p>The accumulator parameter can be set to an initial value using the syntax <code>acc = initValue</code>. In this case, the lambda expression is called with the first element of the input array. Then the result is set as the new accumulator value.</p><p>If an initial value for the accumulator is not set, the accumulator is set to the first element of the input array. Then the lambda expression is called with the second element of the input array.</p><p>The initial value of the accumulator and the lambda expression dictate the type of result produced by the <code>reduce</code> function. If the accumulator is set to <code>acc = {}</code>, the result is usually of type <code>Object</code>. If the accumulator is set to <code>acc = []</code>, the result is usually of type <code>Array</code>. If the accumulator is set to <code>acc = ""</code>, the result is usually a <code>String</code>.</p></td></tr></tbody></table>

### Example

This example returns the sum of the numeric values in the first input array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[2, 3] reduce ($ + $$)
```

#### Output

```JSON
5
```

### Example

This example adds the numbers in the `sum` example, concatenates the same numbers in `concat`, and
shows that an empty array `[]` (defined in `myEmptyList`) returns `null` in `emptyList`.

#### Source

```DataWeave
%dw 2.0
var myNums = [1,2,3,4]
var myEmptyList = []
output application/json
---
{
   "sum" : myNums reduce ($$ + $),
   "concat" : myNums reduce ($$ ++ $),
   "emptyList" : myEmptyList reduce ($$ ++ $)
}
```

#### Output

```JSON
{ "sum": 10, "concat": "1234", "emptyList": null }
```

### Example

This example sets the first element from the first input array to `"z"`, and it adds `3` to the sum
of the second input array. In `multiply`, it shows how to multiply each value in an array by the
next (`[2,3,3] reduce ((item, acc) → acc * item)`) to produce a final result of `18` (=
`2 * 3 * 3`). The final example, `multiplyAcc`, sets the accumulator to `3` to multiply the result
of `acc * item` (= `12`) by `3` (that is, `3 (2 * 2 * 3) = 36`), as shown in the output.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
   "concat" : ["a", "b", "c", "d"] reduce ((item, acc = "z") -> acc ++ item),
   "sum": [0, 1, 2, 3, 4, 5] reduce ((item, acc = 3) -> acc + item),
   "multiply" : [2,3,3] reduce ((item, acc) -> acc * item),
   "multiplyAcc" : [2,2,3] reduce ((item, acc = 3) -> acc * item)
}
```

#### Output

```JSON
{ "concat": "zabcd", "sum": 18, "multiply": 18, "multiplyAcc": 36 }
```

### Example

This example shows a variety of uses of `reduce`, including its application to arrays of boolean
values and objects.

#### Source

```DataWeave
%dw 2.0
output application/json
var myVar =
{
  "a": [0, 1, 2, 3, 4, 5],
  "b": ["a", "b", "c", "d", "e"],
  "c": [{ "letter": "a" }, { "letter": "b" }, { "letter": "c" }],
  "d": [true, false, false, true, true]
}
---
{
  "a" : [0, 1, 2, 3, 4, 5] reduce $$,
  "b": ["a", "b", "c", "d", "e"] reduce $$,
  "c": [{ "letter": "a" }, { "letter": "b" }, { "letter": "c" }] reduce ((item, acc = "z") -> acc ++ item.letter),
  "d": [{ letter: "a" }, { letter: "b" }, { letter: "c" }] reduce $$,
  "e": [true, false, false, true, true] reduce ($$ and $),
  "f": [true, false, false, true, true] reduce ((item, acc) -> acc and item),
  "g": [true, false, false, true, true] reduce ((item, acc = false) -> acc and item),
  "h": [true, false, false, true, true] reduce $$,
  "i": myVar.a reduce ($$ + $),
  "j": myVar.a reduce ((item, acc) -> acc + item),
  "k": myVar.a reduce ((item, acc = 3) -> acc + item),
  "l": myVar.a reduce $$,
  "m": myVar.b reduce ($$ ++ $),
  "n": myVar.b reduce ((item, acc) -> acc ++ item),
  "o": myVar.b reduce ((item, acc = "z") -> acc ++ item),
  "p": myVar.b reduce $$,
  "q": myVar.c reduce ((item, acc = "z") -> acc ++ item.letter),
  "r": myVar.c reduce $$,
  "s": myVar.d reduce ($$ and $),
  "t": myVar.d reduce ((item, acc) -> acc and item),
  "u": myVar.d reduce ((item, acc = false) -> acc and item),
  "v": myVar.d reduce $$,
  "w": ([0, 1, 2, 3, 4] reduce ((item, acc = {}) -> acc ++ { a: item })) pluck $,
  "x": [] reduce $$,
  "y": [] reduce ((item,acc = 0) -> acc + item)
}
```

#### Output

```JSON
"a": 0,
"b": "a",
"c": "zabc",
"d": { "letter": "a" },
"e": false,
"f": false,
"g": false,
"h": true,
"i": 15,
"j": 15,
"k": 18,
"l": 0,
"m": "abcde",
"n": "abcde",
"o": "zabcde",
"p": "a",
"q": "zabc",
"r": { "letter": "a" },
"s": false,
"t": false,
"u": false,
"v": true,
"w": [ 0,1,2,3,4 ],
"x": null,
"y": 0
}
```

## reduce<T, A>(@StreamCapable items: Array<T>, callback: (item: T, accumulator: A) -> A): A

## reduce(@StreamCapable text: String, callback: (item: String, accumulator: String) -> String): String

Applies a reduction expression to the characters in a string.

For each character of the input string, in order, `reduce` applies the reduction lambda expression
(function), then replaces the accumulator with the new result. The lambda expression can use both
the current character and the current accumulator value.

Note that if the string is empty and no default value is set on the accumulator parameter, an empty
string is returned.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to reduce.</p></td></tr><tr><td><p><code>callback</code></p></td><td><p>The function to apply.</p></td></tr></tbody></table>

### Example

This example shows how `reduce` can be used to reverse a string.

#### Source

```DataWeave
%dw 2.0
output application/json
---
"hello world" reduce (item, acc = "") -> item ++ acc
```

#### Output

```Json
"dlrow olleh"
```

## reduce<A>(@StreamCapable text: String, callback: (item: String, accumulator: A) -> A): A

## reduce<T, A>(@StreamCapable items: Null, callback: (item: T, accumulator: A) -> A): Null

Helper function that enables `reduce` to work with a `null` value.

<!-- document id=7d3eb52e8e50af248924c6c7e978abc2a8312b9712abc78c19665894f9271fdc url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-reduce.md -->

---
product: DataWeave
version: 2.6
---

# reduce

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## reduce<T>(@StreamCapable items: Array<T>, callback: (item: T, accumulator: T) -> T): T | Null

Applies a reduction expression to the elements in an array.

For each element of the input array, in order, `reduce` applies the reduction lambda expression
(function), then replaces the accumulator with the new result. The lambda expression can use both
the current input array element and the current accumulator value.

Note that if the array is empty and no default value is set on the accumulator parameter, a null
value is returned.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>item</code></p></td><td><p>Item in the input array. It provides the value to reduce. Can also be referenced as <code>$</code>.</p></td></tr><tr><td><p><code>acc</code></p></td><td><p>The accumulator. Can also be referenced as <code>$$</code>. Used to store the result of the lambda expression after each iteration of the <code>reduce</code> operation.</p><p>The accumulator parameter can be set to an initial value using the syntax <code>acc = initValue</code>. In this case, the lambda expression is called with the first element of the input array. Then the result is set as the new accumulator value.</p><p>If an initial value for the accumulator is not set, the accumulator is set to the first element of the input array. Then the lambda expression is called with the second element of the input array.</p><p>The initial value of the accumulator and the lambda expression dictate the type of result produced by the <code>reduce</code> function. If the accumulator is set to <code>acc = {}</code>, the result is usually of type <code>Object</code>. If the accumulator is set to <code>acc = []</code>, the result is usually of type <code>Array</code>. If the accumulator is set to <code>acc = ""</code>, the result is usually a <code>String</code>.</p></td></tr></tbody></table>

### Example

This example returns the sum of the numeric values in the first input array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[2, 3] reduce ($ + $$)
```

#### Output

```JSON
5
```

### Example

This example adds the numbers in the `sum` example, concatenates the same numbers in `concat`, and
shows that an empty array `[]` (defined in `myEmptyList`) returns `null` in `emptyList`.

#### Source

```DataWeave
%dw 2.0
var myNums = [1,2,3,4]
var myEmptyList = []
output application/json
---
{
   "sum" : myNums reduce ($$ + $),
   "concat" : myNums reduce ($$ ++ $),
   "emptyList" : myEmptyList reduce ($$ ++ $)
}
```

#### Output

```JSON
{ "sum": 10, "concat": "1234", "emptyList": null }
```

### Example

This example sets the first element from the first input array to `"z"`, and it adds `3` to the sum
of the second input array. In `multiply`, it shows how to multiply each value in an array by the
next (`[2,3,3] reduce ((item, acc) → acc * item)`) to produce a final result of `18` (=
`2 * 3 * 3`). The final example, `multiplyAcc`, sets the accumulator to `3` to multiply the result
of `acc * item` (= `12`) by `3` (that is, `3 (2 * 2 * 3) = 36`), as shown in the output.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
   "concat" : ["a", "b", "c", "d"] reduce ((item, acc = "z") -> acc ++ item),
   "sum": [0, 1, 2, 3, 4, 5] reduce ((item, acc = 3) -> acc + item),
   "multiply" : [2,3,3] reduce ((item, acc) -> acc * item),
   "multiplyAcc" : [2,2,3] reduce ((item, acc = 3) -> acc * item)
}
```

#### Output

```JSON
{ "concat": "zabcd", "sum": 18, "multiply": 18, "multiplyAcc": 36 }
```

### Example

This example shows a variety of uses of `reduce`, including its application to arrays of boolean
values and objects.

#### Source

```DataWeave
%dw 2.0
output application/json
var myVar =
{
  "a": [0, 1, 2, 3, 4, 5],
  "b": ["a", "b", "c", "d", "e"],
  "c": [{ "letter": "a" }, { "letter": "b" }, { "letter": "c" }],
  "d": [true, false, false, true, true]
}
---
{
  "a" : [0, 1, 2, 3, 4, 5] reduce $$,
  "b": ["a", "b", "c", "d", "e"] reduce $$,
  "c": [{ "letter": "a" }, { "letter": "b" }, { "letter": "c" }] reduce ((item, acc = "z") -> acc ++ item.letter),
  "d": [{ letter: "a" }, { letter: "b" }, { letter: "c" }] reduce $$,
  "e": [true, false, false, true, true] reduce ($$ and $),
  "f": [true, false, false, true, true] reduce ((item, acc) -> acc and item),
  "g": [true, false, false, true, true] reduce ((item, acc = false) -> acc and item),
  "h": [true, false, false, true, true] reduce $$,
  "i": myVar.a reduce ($$ + $),
  "j": myVar.a reduce ((item, acc) -> acc + item),
  "k": myVar.a reduce ((item, acc = 3) -> acc + item),
  "l": myVar.a reduce $$,
  "m": myVar.b reduce ($$ ++ $),
  "n": myVar.b reduce ((item, acc) -> acc ++ item),
  "o": myVar.b reduce ((item, acc = "z") -> acc ++ item),
  "p": myVar.b reduce $$,
  "q": myVar.c reduce ((item, acc = "z") -> acc ++ item.letter),
  "r": myVar.c reduce $$,
  "s": myVar.d reduce ($$ and $),
  "t": myVar.d reduce ((item, acc) -> acc and item),
  "u": myVar.d reduce ((item, acc = false) -> acc and item),
  "v": myVar.d reduce $$,
  "w": ([0, 1, 2, 3, 4] reduce ((item, acc = {}) -> acc ++ { a: item })) pluck $,
  "x": [] reduce $$,
  "y": [] reduce ((item,acc = 0) -> acc + item)
}
```

#### Output

```JSON
"a": 0,
"b": "a",
"c": "zabc",
"d": { "letter": "a" },
"e": false,
"f": false,
"g": false,
"h": true,
"i": 15,
"j": 15,
"k": 18,
"l": 0,
"m": "abcde",
"n": "abcde",
"o": "zabcde",
"p": "a",
"q": "zabc",
"r": { "letter": "a" },
"s": false,
"t": false,
"u": false,
"v": true,
"w": [ 0,1,2,3,4 ],
"x": null,
"y": 0
}
```

## reduce<T, A>(@StreamCapable items: Array<T>, callback: (item: T, accumulator: A) -> A): A

## reduce(@StreamCapable text: String, callback: (item: String, accumulator: String) -> String): String

Applies a reduction expression to the characters in a string.

For each character of the input string, in order, `reduce` applies the reduction lambda expression
(function), then replaces the accumulator with the new result. The lambda expression can use both
the current character and the current accumulator value.

Note that if the string is empty and no default value is set on the accumulator parameter, an empty
string is returned.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to reduce.</p></td></tr><tr><td><p><code>callback</code></p></td><td><p>The function to apply.</p></td></tr></tbody></table>

### Example

This example shows how `reduce` can be used to reverse a string.

#### Source

```DataWeave
%dw 2.0
output application/json
---
"hello world" reduce (item, acc = "") -> item ++ acc
```

#### Output

```Json
"dlrow olleh"
```

## reduce<A>(@StreamCapable text: String, callback: (item: String, accumulator: A) -> A): A

## reduce<T, A>(@StreamCapable items: Null, callback: (item: T, accumulator: A) -> A): Null

Helper function that enables `reduce` to work with a `null` value.

<!-- document id=431e84d20688ed44cea8aa889ab94bf9b1410eeaead20acc45fee7c279aabb62 url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-reduce.md -->

---
product: DataWeave
version: 2.9
---

# reduce

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## reduce<T>(@StreamCapable items: Array<T>, callback: (item: T, accumulator: T) -> T): T | Null

Applies a reduction expression to the elements in an array.

For each element of the input array, in order, `reduce` applies the reduction lambda expression
(function), then replaces the accumulator with the new result. The lambda expression can use both
the current input array element and the current accumulator value.

Note that if the array is empty and no default value is set on the accumulator parameter, a null
value is returned.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>item</code></p></td><td><p>Item in the input array. It provides the value to reduce. Can also be referenced as <code>$</code>.</p></td></tr><tr><td><p><code>acc</code></p></td><td><p>The accumulator. Can also be referenced as <code>$$</code>. Used to store the result of the lambda expression after each iteration of the <code>reduce</code> operation.</p><p>The accumulator parameter can be set to an initial value using the syntax <code>acc = initValue</code>. In this case, the lambda expression is called with the first element of the input array. Then the result is set as the new accumulator value.</p><p>If an initial value for the accumulator is not set, the accumulator is set to the first element of the input array. Then the lambda expression is called with the second element of the input array.</p><p>The initial value of the accumulator and the lambda expression dictate the type of result produced by the <code>reduce</code> function. If the accumulator is set to <code>acc = {}</code>, the result is usually of type <code>Object</code>. If the accumulator is set to <code>acc = []</code>, the result is usually of type <code>Array</code>. If the accumulator is set to <code>acc = ""</code>, the result is usually a <code>String</code>.</p></td></tr></tbody></table>

### Example

This example returns the sum of the numeric values in the first input array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[2, 3] reduce ($ + $$)
```

#### Output

```JSON
5
```

### Example

This example adds the numbers in the `sum` example, concatenates the same numbers in `concat`, and
shows that an empty array `[]` (defined in `myEmptyList`) returns `null` in `emptyList`.

#### Source

```DataWeave
%dw 2.0
var myNums = [1,2,3,4]
var myEmptyList = []
output application/json
---
{
   "sum" : myNums reduce ($$ + $),
   "concat" : myNums reduce ($$ ++ $),
   "emptyList" : myEmptyList reduce ($$ ++ $)
}
```

#### Output

```JSON
{ "sum": 10, "concat": "1234", "emptyList": null }
```

### Example

This example sets the first element from the first input array to `"z"`, and it adds `3` to the sum
of the second input array. In `multiply`, it shows how to multiply each value in an array by the
next (`[2,3,3] reduce ((item, acc) → acc * item)`) to produce a final result of `18` (=
`2 * 3 * 3`). The final example, `multiplyAcc`, sets the accumulator to `3` to multiply the result
of `acc * item` (= `12`) by `3` (that is, `3 (2 * 2 * 3) = 36`), as shown in the output.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
   "concat" : ["a", "b", "c", "d"] reduce ((item, acc = "z") -> acc ++ item),
   "sum": [0, 1, 2, 3, 4, 5] reduce ((item, acc = 3) -> acc + item),
   "multiply" : [2,3,3] reduce ((item, acc) -> acc * item),
   "multiplyAcc" : [2,2,3] reduce ((item, acc = 3) -> acc * item)
}
```

#### Output

```JSON
{ "concat": "zabcd", "sum": 18, "multiply": 18, "multiplyAcc": 36 }
```

### Example

This example shows a variety of uses of `reduce`, including its application to arrays of boolean
values and objects.

#### Source

```DataWeave
%dw 2.0
output application/json
var myVar =
{
  "a": [0, 1, 2, 3, 4, 5],
  "b": ["a", "b", "c", "d", "e"],
  "c": [{ "letter": "a" }, { "letter": "b" }, { "letter": "c" }],
  "d": [true, false, false, true, true]
}
---
{
  "a" : [0, 1, 2, 3, 4, 5] reduce $$,
  "b": ["a", "b", "c", "d", "e"] reduce $$,
  "c": [{ "letter": "a" }, { "letter": "b" }, { "letter": "c" }] reduce ((item, acc = "z") -> acc ++ item.letter),
  "d": [{ letter: "a" }, { letter: "b" }, { letter: "c" }] reduce $$,
  "e": [true, false, false, true, true] reduce ($$ and $),
  "f": [true, false, false, true, true] reduce ((item, acc) -> acc and item),
  "g": [true, false, false, true, true] reduce ((item, acc = false) -> acc and item),
  "h": [true, false, false, true, true] reduce $$,
  "i": myVar.a reduce ($$ + $),
  "j": myVar.a reduce ((item, acc) -> acc + item),
  "k": myVar.a reduce ((item, acc = 3) -> acc + item),
  "l": myVar.a reduce $$,
  "m": myVar.b reduce ($$ ++ $),
  "n": myVar.b reduce ((item, acc) -> acc ++ item),
  "o": myVar.b reduce ((item, acc = "z") -> acc ++ item),
  "p": myVar.b reduce $$,
  "q": myVar.c reduce ((item, acc = "z") -> acc ++ item.letter),
  "r": myVar.c reduce $$,
  "s": myVar.d reduce ($$ and $),
  "t": myVar.d reduce ((item, acc) -> acc and item),
  "u": myVar.d reduce ((item, acc = false) -> acc and item),
  "v": myVar.d reduce $$,
  "w": ([0, 1, 2, 3, 4] reduce ((item, acc = {}) -> acc ++ { a: item })) pluck $,
  "x": [] reduce $$,
  "y": [] reduce ((item,acc = 0) -> acc + item)
}
```

#### Output

```JSON
"a": 0,
"b": "a",
"c": "zabc",
"d": { "letter": "a" },
"e": false,
"f": false,
"g": false,
"h": true,
"i": 15,
"j": 15,
"k": 18,
"l": 0,
"m": "abcde",
"n": "abcde",
"o": "zabcde",
"p": "a",
"q": "zabc",
"r": { "letter": "a" },
"s": false,
"t": false,
"u": false,
"v": true,
"w": [ 0,1,2,3,4 ],
"x": null,
"y": 0
}
```

## reduce<T, A>(@StreamCapable items: Array<T>, callback: (item: T, accumulator: A) -> A): A

## reduce(@StreamCapable text: String, callback: (item: String, accumulator: String) -> String): String

Applies a reduction expression to the characters in a string.

For each character of the input string, in order, `reduce` applies the reduction lambda expression
(function), then replaces the accumulator with the new result. The lambda expression can use both
the current character and the current accumulator value.

Note that if the string is empty and no default value is set on the accumulator parameter, an empty
string is returned.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to reduce.</p></td></tr><tr><td><p><code>callback</code></p></td><td><p>The function to apply.</p></td></tr></tbody></table>

### Example

This example shows how `reduce` can be used to reverse a string.

#### Source

```DataWeave
%dw 2.0
output application/json
---
"hello world" reduce (item, acc = "") -> item ++ acc
```

#### Output

```Json
"dlrow olleh"
```

## reduce<A>(@StreamCapable text: String, callback: (item: String, accumulator: A) -> A): A

## reduce<T, A>(@StreamCapable items: Null, callback: (item: T, accumulator: A) -> A): Null

Helper function that enables `reduce` to work with a `null` value.

<!-- document id=8a839c48636606501d1b09043f24fca75c0889a610078711ff3468929542464b url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-reduce.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# reduce

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## reduce<T>(@StreamCapable items: Array<T>, callback: (item: T, accumulator: T) -> T): T | Null

Applies a reduction expression to the elements in an array.

For each element of the input array, in order, `reduce` applies the reduction lambda expression
(function), then replaces the accumulator with the new result. The lambda expression can use both
the current input array element and the current accumulator value.

Note that if the array is empty and no default value is set on the accumulator parameter, a null
value is returned.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>item</code></p></td><td><p>Item in the input array. It provides the value to reduce. Can also be referenced as <code>$</code>.</p></td></tr><tr><td><p><code>acc</code></p></td><td><p>The accumulator. Can also be referenced as <code>$$</code>. Used to store the result of the lambda expression after each iteration of the <code>reduce</code> operation.</p><p>The accumulator parameter can be set to an initial value using the syntax <code>acc = initValue</code>. In this case, the lambda expression is called with the first element of the input array. Then the result is set as the new accumulator value.</p><p>If an initial value for the accumulator is not set, the accumulator is set to the first element of the input array. Then the lambda expression is called with the second element of the input array.</p><p>The initial value of the accumulator and the lambda expression dictate the type of result produced by the <code>reduce</code> function. If the accumulator is set to <code>acc = {}</code>, the result is usually of type <code>Object</code>. If the accumulator is set to <code>acc = []</code>, the result is usually of type <code>Array</code>. If the accumulator is set to <code>acc = ""</code>, the result is usually a <code>String</code>.</p></td></tr></tbody></table>

### Example

This example returns the sum of the numeric values in the first input array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[2, 3] reduce ($ + $$)
```

#### Output

```JSON
5
```

### Example

This example adds the numbers in the `sum` example, concatenates the same numbers in `concat`, and
shows that an empty array `[]` (defined in `myEmptyList`) returns `null` in `emptyList`.

#### Source

```DataWeave
%dw 2.0
var myNums = [1,2,3,4]
var myEmptyList = []
output application/json
---
{
   "sum" : myNums reduce ($$ + $),
   "concat" : myNums reduce ($$ ++ $),
   "emptyList" : myEmptyList reduce ($$ ++ $)
}
```

#### Output

```JSON
{ "sum": 10, "concat": "1234", "emptyList": null }
```

### Example

This example sets the first element from the first input array to `"z"`, and it adds `3` to the sum
of the second input array. In `multiply`, it shows how to multiply each value in an array by the
next (`[2,3,3] reduce ((item, acc) → acc * item)`) to produce a final result of `18` (=
`2 * 3 * 3`). The final example, `multiplyAcc`, sets the accumulator to `3` to multiply the result
of `acc * item` (= `12`) by `3` (that is, `3 (2 * 2 * 3) = 36`), as shown in the output.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
   "concat" : ["a", "b", "c", "d"] reduce ((item, acc = "z") -> acc ++ item),
   "sum": [0, 1, 2, 3, 4, 5] reduce ((item, acc = 3) -> acc + item),
   "multiply" : [2,3,3] reduce ((item, acc) -> acc * item),
   "multiplyAcc" : [2,2,3] reduce ((item, acc = 3) -> acc * item)
}
```

#### Output

```JSON
{ "concat": "zabcd", "sum": 18, "multiply": 18, "multiplyAcc": 36 }
```

### Example

This example shows a variety of uses of `reduce`, including its application to arrays of boolean
values and objects.

#### Source

```DataWeave
%dw 2.0
output application/json
var myVar =
{
  "a": [0, 1, 2, 3, 4, 5],
  "b": ["a", "b", "c", "d", "e"],
  "c": [{ "letter": "a" }, { "letter": "b" }, { "letter": "c" }],
  "d": [true, false, false, true, true]
}
---
{
  "a" : [0, 1, 2, 3, 4, 5] reduce $$,
  "b": ["a", "b", "c", "d", "e"] reduce $$,
  "c": [{ "letter": "a" }, { "letter": "b" }, { "letter": "c" }] reduce ((item, acc = "z") -> acc ++ item.letter),
  "d": [{ letter: "a" }, { letter: "b" }, { letter: "c" }] reduce $$,
  "e": [true, false, false, true, true] reduce ($$ and $),
  "f": [true, false, false, true, true] reduce ((item, acc) -> acc and item),
  "g": [true, false, false, true, true] reduce ((item, acc = false) -> acc and item),
  "h": [true, false, false, true, true] reduce $$,
  "i": myVar.a reduce ($$ + $),
  "j": myVar.a reduce ((item, acc) -> acc + item),
  "k": myVar.a reduce ((item, acc = 3) -> acc + item),
  "l": myVar.a reduce $$,
  "m": myVar.b reduce ($$ ++ $),
  "n": myVar.b reduce ((item, acc) -> acc ++ item),
  "o": myVar.b reduce ((item, acc = "z") -> acc ++ item),
  "p": myVar.b reduce $$,
  "q": myVar.c reduce ((item, acc = "z") -> acc ++ item.letter),
  "r": myVar.c reduce $$,
  "s": myVar.d reduce ($$ and $),
  "t": myVar.d reduce ((item, acc) -> acc and item),
  "u": myVar.d reduce ((item, acc = false) -> acc and item),
  "v": myVar.d reduce $$,
  "w": ([0, 1, 2, 3, 4] reduce ((item, acc = {}) -> acc ++ { a: item })) pluck $,
  "x": [] reduce $$,
  "y": [] reduce ((item,acc = 0) -> acc + item)
}
```

#### Output

```JSON
"a": 0,
"b": "a",
"c": "zabc",
"d": { "letter": "a" },
"e": false,
"f": false,
"g": false,
"h": true,
"i": 15,
"j": 15,
"k": 18,
"l": 0,
"m": "abcde",
"n": "abcde",
"o": "zabcde",
"p": "a",
"q": "zabc",
"r": { "letter": "a" },
"s": false,
"t": false,
"u": false,
"v": true,
"w": [ 0,1,2,3,4 ],
"x": null,
"y": 0
}
```

## reduce<T, A>(@StreamCapable items: Array<T>, callback: (item: T, accumulator: A) -> A): A

## reduce(@StreamCapable text: String, callback: (item: String, accumulator: String) -> String): String

Applies a reduction expression to the characters in a string.

For each character of the input string, in order, `reduce` applies the reduction lambda expression
(function), then replaces the accumulator with the new result. The lambda expression can use both
the current character and the current accumulator value.

Note that if the string is empty and no default value is set on the accumulator parameter, an empty
string is returned.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to reduce.</p></td></tr><tr><td><p><code>callback</code></p></td><td><p>The function to apply.</p></td></tr></tbody></table>

### Example

This example shows how `reduce` can be used to reverse a string.

#### Source

```DataWeave
%dw 2.0
output application/json
---
"hello world" reduce (item, acc = "") -> item ++ acc
```

#### Output

```Json
"dlrow olleh"
```

## reduce<A>(@StreamCapable text: String, callback: (item: String, accumulator: A) -> A): A

## reduce<T, A>(@StreamCapable items: Null, callback: (item: T, accumulator: A) -> A): Null

Helper function that enables `reduce` to work with a `null` value.

<!-- document id=3bb822c601109bcea17a576e137d6900be3a3b9e1a79eb038be994d4997c5627 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook-reference-multiple-inputs.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, remove, mapobject
---

# Reference Multiple Inputs

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example takes three different input JSON files, one in the payload, another in a
variable and the third in an attribute. All of them are parts of the same Mule Event. The payload
contains an array of book objects, the variable has a set of currency exchange rates, and the
attribute specifies a year to be used as a query.

The example uses the following:

- `filter` to leave out the books that are older than the date specified in the incoming attribute.

- `map` to go through each book in the incoming array. Another `map` function then goes through the
  currencies in the variable to calculates the book’s price in each one. A third `map` function
  lists out all authors of a book in case there are more than one.

- `@` to define an XML attribute in the output.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
books: {
  (payload filter ($.properties.year > attributes.publishedAfter) map  (item)   ->  {
    book @(year: item.properties.year): {
      (vars.exchangeRate.USD map {
        price @(currency: $.currency): $.ratio * item.price
      }),
      title: item.properties.title,
      authors: { (item.properties.author map {
        author: $
      }) }
    }
  } )
}
```

Input JSON Payload:

```json
[
  {
    "type": "book",
    "price": 30,
    "properties": {
      "title": "Everyday Italian",
      "author": ["Giada De Laurentiis"],
      "year": 2005
    }
  },
  {
    "type": "book",
    "price": 29.99,
    "properties": {
      "title": "Harry Potter",
      "author": ["J K. Rowling"],
      "year": 2005
    }
  },
  {
    "type": "book",
    "price": 41.12,
    "properties": {
      "title": "Mule in Action",
      "author": ["David Dossot", "John D'Emic"],
      "year": 2009
    }
  },
  {
    "type": "book",
    "price": 49.99,
    "properties": {
      "title": "XQuery Kick Start",
      "author": [
        "James McGovern",
        "Per Bothner",
        "Kurt Cagle",
        "James Linn",
        "Kurt Cagle",
        "Vaidyanathan Nagarajan"
      ],
      "year": 2003
    }
  },
  {
    "type": "book",
    "price": 39.95,
    "properties": {
      "title": "Learning XML",
      "author": ["Erik T. Ray"],
      "year": 2003
    }
  }
]
```

Input Attributes:

```json
{
  "publishedAfter": 2004
}
```

Input Variable `exchangeRate`:

```json
{
  "USD": [
    { "currency": "EUR", "ratio": 0.92 },
    { "currency": "ARS", "ratio": 8.76 },
    { "currency": "GBP", "ratio": 0.66 }
  ]
}
```

Output XML:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<books>
  <book year="2005">
    <price currency="EUR">27.60</price>
    <price currency="ARS">262.80</price>
    <price currency="GBP">19.80</price>
    <title>Everyday Italian</title>
    <authors>
      <author>Giada De Laurentiis</author>
    </authors>
  </book>
  <book year="2005">
    <price currency="EUR">27.5908</price>
    <price currency="ARS">262.7124</price>
    <price currency="GBP">19.7934</price>
    <title>Harry Potter</title>
    <authors>
      <author>J K. Rowling</author>
    </authors>
  </book>
  <book year="2009">
    <price currency="EUR">37.8304</price>
    <price currency="ARS">360.2112</price>
    <price currency="GBP">27.1392</price>
    <title>Mule in Action</title>
    <authors>
      <author>David Dossot</author>
      <author>John D'Emic</author>
    </authors>
  </book>
</books>
```

## Related Examples

- [Extract Data](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-extract-data)

- [Merge Fields from Separate Objects](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-merge-multiple-payloads)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.11/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.11/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook)

<!-- document id=afc8415ed7192474dacf3bae5f232a2428179ce823922ab242f8b13694738465 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook-reference-multiple-inputs.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, remove, mapobject
---

# Reference Multiple Inputs

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example takes three different input JSON files, one in the payload, another in a
variable and the third in an attribute. All of them are parts of the same Mule Event. The payload
contains an array of book objects, the variable has a set of currency exchange rates, and the
attribute specifies a year to be used as a query.

The example uses the following:

- `filter` to leave out the books that are older than the date specified in the incoming attribute.

- `map` to go through each book in the incoming array. Another `map` function then goes through the
  currencies in the variable to calculates the book’s price in each one. A third `map` function
  lists out all authors of a book in case there are more than one.

- `@` to define an XML attribute in the output.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
books: {
  (payload filter ($.properties.year > attributes.publishedAfter) map  (item)   ->  {
    book @(year: item.properties.year): {
      (vars.exchangeRate.USD map {
        price @(currency: $.currency): $.ratio * item.price
      }),
      title: item.properties.title,
      authors: { (item.properties.author map {
        author: $
      }) }
    }
  } )
}
```

Input JSON Payload:

```json
[
  {
    "type": "book",
    "price": 30,
    "properties": {
      "title": "Everyday Italian",
      "author": ["Giada De Laurentiis"],
      "year": 2005
    }
  },
  {
    "type": "book",
    "price": 29.99,
    "properties": {
      "title": "Harry Potter",
      "author": ["J K. Rowling"],
      "year": 2005
    }
  },
  {
    "type": "book",
    "price": 41.12,
    "properties": {
      "title": "Mule in Action",
      "author": ["David Dossot", "John D'Emic"],
      "year": 2009
    }
  },
  {
    "type": "book",
    "price": 49.99,
    "properties": {
      "title": "XQuery Kick Start",
      "author": [
        "James McGovern",
        "Per Bothner",
        "Kurt Cagle",
        "James Linn",
        "Kurt Cagle",
        "Vaidyanathan Nagarajan"
      ],
      "year": 2003
    }
  },
  {
    "type": "book",
    "price": 39.95,
    "properties": {
      "title": "Learning XML",
      "author": ["Erik T. Ray"],
      "year": 2003
    }
  }
]
```

Input Attributes:

```json
{
  "publishedAfter": 2004
}
```

Input Variable `exchangeRate`:

```json
{
  "USD": [
    { "currency": "EUR", "ratio": 0.92 },
    { "currency": "ARS", "ratio": 8.76 },
    { "currency": "GBP", "ratio": 0.66 }
  ]
}
```

Output XML:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<books>
  <book year="2005">
    <price currency="EUR">27.60</price>
    <price currency="ARS">262.80</price>
    <price currency="GBP">19.80</price>
    <title>Everyday Italian</title>
    <authors>
      <author>Giada De Laurentiis</author>
    </authors>
  </book>
  <book year="2005">
    <price currency="EUR">27.5908</price>
    <price currency="ARS">262.7124</price>
    <price currency="GBP">19.7934</price>
    <title>Harry Potter</title>
    <authors>
      <author>J K. Rowling</author>
    </authors>
  </book>
  <book year="2009">
    <price currency="EUR">37.8304</price>
    <price currency="ARS">360.2112</price>
    <price currency="GBP">27.1392</price>
    <title>Mule in Action</title>
    <authors>
      <author>David Dossot</author>
      <author>John D'Emic</author>
    </authors>
  </book>
</books>
```

## Related Examples

- [Extract Data](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-extract-data)

- [Merge Fields from Separate Objects](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-merge-multiple-payloads)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.12/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.12/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook)

<!-- document id=248a14695b1af2fdbf68043cd990b2a7890fff8fff52d2d6202e231bc30ce1ac url=/mulesoft/current/en-us/dataweave/2.3/dataweave-cookbook-reference-multiple-inputs.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, remove, mapobject
---

# Reference Multiple Inputs

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example takes three different input JSON files, one in the payload, another in a
variable and the third in an attribute. All of them are parts of the same Mule Event. The payload
contains an array of book objects, the variable has a set of currency exchange rates, and the
attribute specifies a year to be used as a query.

The example uses the following:

- `filter` to leave out the books that are older than the date specified in the incoming attribute.

- `map` to go through each book in the incoming array. Another `map` function then goes through the
  currencies in the variable to calculates the book’s price in each one. A third `map` function
  lists out all authors of a book in case there are more than one.

- `@` to define an XML attribute in the output.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
books: {
  (payload filter ($.properties.year > attributes.publishedAfter) map  (item)   ->  {
    book @(year: item.properties.year): {
      (vars.exchangeRate.USD map {
        price @(currency: $.currency): $.ratio * item.price
      }),
      title: item.properties.title,
      authors: { (item.properties.author map {
        author: $
      }) }
    }
  } )
}
```

Input JSON Payload:

```json
[
  {
    "type": "book",
    "price": 30,
    "properties": {
      "title": "Everyday Italian",
      "author": ["Giada De Laurentiis"],
      "year": 2005
    }
  },
  {
    "type": "book",
    "price": 29.99,
    "properties": {
      "title": "Harry Potter",
      "author": ["J K. Rowling"],
      "year": 2005
    }
  },
  {
    "type": "book",
    "price": 41.12,
    "properties": {
      "title": "Mule in Action",
      "author": ["David Dossot", "John D'Emic"],
      "year": 2009
    }
  },
  {
    "type": "book",
    "price": 49.99,
    "properties": {
      "title": "XQuery Kick Start",
      "author": [
        "James McGovern",
        "Per Bothner",
        "Kurt Cagle",
        "James Linn",
        "Kurt Cagle",
        "Vaidyanathan Nagarajan"
      ],
      "year": 2003
    }
  },
  {
    "type": "book",
    "price": 39.95,
    "properties": {
      "title": "Learning XML",
      "author": ["Erik T. Ray"],
      "year": 2003
    }
  }
]
```

Input Attributes:

```json
{
  "publishedAfter": 2004
}
```

Input Variable `exchangeRate`:

```json
{
  "USD": [
    { "currency": "EUR", "ratio": 0.92 },
    { "currency": "ARS", "ratio": 8.76 },
    { "currency": "GBP", "ratio": 0.66 }
  ]
}
```

Output XML:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<books>
  <book year="2005">
    <price currency="EUR">27.60</price>
    <price currency="ARS">262.80</price>
    <price currency="GBP">19.80</price>
    <title>Everyday Italian</title>
    <authors>
      <author>Giada De Laurentiis</author>
    </authors>
  </book>
  <book year="2005">
    <price currency="EUR">27.5908</price>
    <price currency="ARS">262.7124</price>
    <price currency="GBP">19.7934</price>
    <title>Harry Potter</title>
    <authors>
      <author>J K. Rowling</author>
    </authors>
  </book>
  <book year="2009">
    <price currency="EUR">37.8304</price>
    <price currency="ARS">360.2112</price>
    <price currency="GBP">27.1392</price>
    <title>Mule in Action</title>
    <authors>
      <author>David Dossot</author>
      <author>John D'Emic</author>
    </authors>
  </book>
</books>
```

## Related Examples

- [Extract Data](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-extract-data)

- [Merge Fields from Separate Objects](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-merge-multiple-payloads)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.3/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.3/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook)

<!-- document id=7da4f4680e654937238a03de464bed19a98535957f5cec6f6f8df5bce02e4d2e url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook-reference-multiple-inputs.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, remove, mapobject
---

# Reference Multiple Inputs

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example takes three different input JSON files, one in the payload, another in a
variable and the third in an attribute. All of them are parts of the same Mule Event. The payload
contains an array of book objects, the variable has a set of currency exchange rates, and the
attribute specifies a year to be used as a query.

The example uses the following:

- `filter` to leave out the books that are older than the date specified in the incoming attribute.

- `map` to go through each book in the incoming array. Another `map` function then goes through the
  currencies in the variable to calculates the book’s price in each one. A third `map` function
  lists out all authors of a book in case there are more than one.

- `@` to define an XML attribute in the output.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
books: {
  (payload filter ($.properties.year > attributes.publishedAfter) map  (item)   ->  {
    book @(year: item.properties.year): {
      (vars.exchangeRate.USD map {
        price @(currency: $.currency): $.ratio * item.price
      }),
      title: item.properties.title,
      authors: { (item.properties.author map {
        author: $
      }) }
    }
  } )
}
```

Input JSON Payload:

```json
[
  {
    "type": "book",
    "price": 30,
    "properties": {
      "title": "Everyday Italian",
      "author": ["Giada De Laurentiis"],
      "year": 2005
    }
  },
  {
    "type": "book",
    "price": 29.99,
    "properties": {
      "title": "Harry Potter",
      "author": ["J K. Rowling"],
      "year": 2005
    }
  },
  {
    "type": "book",
    "price": 41.12,
    "properties": {
      "title": "Mule in Action",
      "author": ["David Dossot", "John D'Emic"],
      "year": 2009
    }
  },
  {
    "type": "book",
    "price": 49.99,
    "properties": {
      "title": "XQuery Kick Start",
      "author": [
        "James McGovern",
        "Per Bothner",
        "Kurt Cagle",
        "James Linn",
        "Kurt Cagle",
        "Vaidyanathan Nagarajan"
      ],
      "year": 2003
    }
  },
  {
    "type": "book",
    "price": 39.95,
    "properties": {
      "title": "Learning XML",
      "author": ["Erik T. Ray"],
      "year": 2003
    }
  }
]
```

Input Attributes:

```json
{
  "publishedAfter": 2004
}
```

Input Variable `exchangeRate`:

```json
{
  "USD": [
    { "currency": "EUR", "ratio": 0.92 },
    { "currency": "ARS", "ratio": 8.76 },
    { "currency": "GBP", "ratio": 0.66 }
  ]
}
```

Output XML:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<books>
  <book year="2005">
    <price currency="EUR">27.60</price>
    <price currency="ARS">262.80</price>
    <price currency="GBP">19.80</price>
    <title>Everyday Italian</title>
    <authors>
      <author>Giada De Laurentiis</author>
    </authors>
  </book>
  <book year="2005">
    <price currency="EUR">27.5908</price>
    <price currency="ARS">262.7124</price>
    <price currency="GBP">19.7934</price>
    <title>Harry Potter</title>
    <authors>
      <author>J K. Rowling</author>
    </authors>
  </book>
  <book year="2009">
    <price currency="EUR">37.8304</price>
    <price currency="ARS">360.2112</price>
    <price currency="GBP">27.1392</price>
    <title>Mule in Action</title>
    <authors>
      <author>David Dossot</author>
      <author>John D'Emic</author>
    </authors>
  </book>
</books>
```

## Related Examples

- [Extract Data](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-extract-data)

- [Merge Fields from Separate Objects](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-merge-multiple-payloads)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.4/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.4/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook)

<!-- document id=4e0c87d331668dd0df463df830f1e8ad05697460af85a31d6c2eb885112797fc url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook-reference-multiple-inputs.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, remove, mapobject
---

# Reference Multiple Inputs

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example takes three different input JSON files, one in the payload, another in a
variable and the third in an attribute. All of them are parts of the same Mule Event. The payload
contains an array of book objects, the variable has a set of currency exchange rates, and the
attribute specifies a year to be used as a query.

The example uses the following:

- `filter` to leave out the books that are older than the date specified in the incoming attribute.

- `map` to go through each book in the incoming array. Another `map` function then goes through the
  currencies in the variable to calculates the book’s price in each one. A third `map` function
  lists out all authors of a book in case there are more than one.

- `@` to define an XML attribute in the output.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
books: {
  (payload filter ($.properties.year > attributes.publishedAfter) map  (item)   ->  {
    book @(year: item.properties.year): {
      (vars.exchangeRate.USD map {
        price @(currency: $.currency): $.ratio * item.price
      }),
      title: item.properties.title,
      authors: { (item.properties.author map {
        author: $
      }) }
    }
  } )
}
```

Input JSON Payload:

```json
[
  {
    "type": "book",
    "price": 30,
    "properties": {
      "title": "Everyday Italian",
      "author": ["Giada De Laurentiis"],
      "year": 2005
    }
  },
  {
    "type": "book",
    "price": 29.99,
    "properties": {
      "title": "Harry Potter",
      "author": ["J K. Rowling"],
      "year": 2005
    }
  },
  {
    "type": "book",
    "price": 41.12,
    "properties": {
      "title": "Mule in Action",
      "author": ["David Dossot", "John D'Emic"],
      "year": 2009
    }
  },
  {
    "type": "book",
    "price": 49.99,
    "properties": {
      "title": "XQuery Kick Start",
      "author": [
        "James McGovern",
        "Per Bothner",
        "Kurt Cagle",
        "James Linn",
        "Kurt Cagle",
        "Vaidyanathan Nagarajan"
      ],
      "year": 2003
    }
  },
  {
    "type": "book",
    "price": 39.95,
    "properties": {
      "title": "Learning XML",
      "author": ["Erik T. Ray"],
      "year": 2003
    }
  }
]
```

Input Attributes:

```json
{
  "publishedAfter": 2004
}
```

Input Variable `exchangeRate`:

```json
{
  "USD": [
    { "currency": "EUR", "ratio": 0.92 },
    { "currency": "ARS", "ratio": 8.76 },
    { "currency": "GBP", "ratio": 0.66 }
  ]
}
```

Output XML:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<books>
  <book year="2005">
    <price currency="EUR">27.60</price>
    <price currency="ARS">262.80</price>
    <price currency="GBP">19.80</price>
    <title>Everyday Italian</title>
    <authors>
      <author>Giada De Laurentiis</author>
    </authors>
  </book>
  <book year="2005">
    <price currency="EUR">27.5908</price>
    <price currency="ARS">262.7124</price>
    <price currency="GBP">19.7934</price>
    <title>Harry Potter</title>
    <authors>
      <author>J K. Rowling</author>
    </authors>
  </book>
  <book year="2009">
    <price currency="EUR">37.8304</price>
    <price currency="ARS">360.2112</price>
    <price currency="GBP">27.1392</price>
    <title>Mule in Action</title>
    <authors>
      <author>David Dossot</author>
      <author>John D'Emic</author>
    </authors>
  </book>
</books>
```

## Related Examples

- [Extract Data](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-extract-data)

- [Merge Fields from Separate Objects](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-merge-multiple-payloads)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.6/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.6/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook)

<!-- document id=aaa8ff692702f162de1a517bd1d55e86ca4cfc6ada0991337ed4fce3c9211511 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook-reference-multiple-inputs.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, remove, mapobject
---

# Reference Multiple Inputs

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example takes three different input JSON files, one in the payload, another in a
variable and the third in an attribute. All of them are parts of the same Mule Event. The payload
contains an array of book objects, the variable has a set of currency exchange rates, and the
attribute specifies a year to be used as a query.

The example uses the following:

- `filter` to leave out the books that are older than the date specified in the incoming attribute.

- `map` to go through each book in the incoming array. Another `map` function then goes through the
  currencies in the variable to calculates the book’s price in each one. A third `map` function
  lists out all authors of a book in case there are more than one.

- `@` to define an XML attribute in the output.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
books: {
  (payload filter ($.properties.year > attributes.publishedAfter) map  (item)   ->  {
    book @(year: item.properties.year): {
      (vars.exchangeRate.USD map {
        price @(currency: $.currency): $.ratio * item.price
      }),
      title: item.properties.title,
      authors: { (item.properties.author map {
        author: $
      }) }
    }
  } )
}
```

Input JSON Payload:

```json
[
  {
    "type": "book",
    "price": 30,
    "properties": {
      "title": "Everyday Italian",
      "author": ["Giada De Laurentiis"],
      "year": 2005
    }
  },
  {
    "type": "book",
    "price": 29.99,
    "properties": {
      "title": "Harry Potter",
      "author": ["J K. Rowling"],
      "year": 2005
    }
  },
  {
    "type": "book",
    "price": 41.12,
    "properties": {
      "title": "Mule in Action",
      "author": ["David Dossot", "John D'Emic"],
      "year": 2009
    }
  },
  {
    "type": "book",
    "price": 49.99,
    "properties": {
      "title": "XQuery Kick Start",
      "author": [
        "James McGovern",
        "Per Bothner",
        "Kurt Cagle",
        "James Linn",
        "Kurt Cagle",
        "Vaidyanathan Nagarajan"
      ],
      "year": 2003
    }
  },
  {
    "type": "book",
    "price": 39.95,
    "properties": {
      "title": "Learning XML",
      "author": ["Erik T. Ray"],
      "year": 2003
    }
  }
]
```

Input Attributes:

```json
{
  "publishedAfter": 2004
}
```

Input Variable `exchangeRate`:

```json
{
  "USD": [
    { "currency": "EUR", "ratio": 0.92 },
    { "currency": "ARS", "ratio": 8.76 },
    { "currency": "GBP", "ratio": 0.66 }
  ]
}
```

Output XML:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<books>
  <book year="2005">
    <price currency="EUR">27.60</price>
    <price currency="ARS">262.80</price>
    <price currency="GBP">19.80</price>
    <title>Everyday Italian</title>
    <authors>
      <author>Giada De Laurentiis</author>
    </authors>
  </book>
  <book year="2005">
    <price currency="EUR">27.5908</price>
    <price currency="ARS">262.7124</price>
    <price currency="GBP">19.7934</price>
    <title>Harry Potter</title>
    <authors>
      <author>J K. Rowling</author>
    </authors>
  </book>
  <book year="2009">
    <price currency="EUR">37.8304</price>
    <price currency="ARS">360.2112</price>
    <price currency="GBP">27.1392</price>
    <title>Mule in Action</title>
    <authors>
      <author>David Dossot</author>
      <author>John D'Emic</author>
    </authors>
  </book>
</books>
```

## Related Examples

- [Extract Data](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-extract-data)

- [Merge Fields from Separate Objects](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-merge-multiple-payloads)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.9/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.9/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook)

<!-- document id=1ebf71a81ab53e06698c96474619536b78a68d92d5b23d61e655a267a62e5298 url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook-reference-multiple-inputs.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, remove, mapobject
---

# Reference Multiple Inputs

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example takes three different input JSON files, one in the payload, another in a
variable and the third in an attribute. All of them are parts of the same Mule Event. The payload
contains an array of book objects, the variable has a set of currency exchange rates, and the
attribute specifies a year to be used as a query.

The example uses the following:

- `filter` to leave out the books that are older than the date specified in the incoming attribute.

- `map` to go through each book in the incoming array. Another `map` function then goes through the
  currencies in the variable to calculates the book’s price in each one. A third `map` function
  lists out all authors of a book in case there are more than one.

- `@` to define an XML attribute in the output.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
books: {
  (payload filter ($.properties.year > attributes.publishedAfter) map  (item)   ->  {
    book @(year: item.properties.year): {
      (vars.exchangeRate.USD map {
        price @(currency: $.currency): $.ratio * item.price
      }),
      title: item.properties.title,
      authors: { (item.properties.author map {
        author: $
      }) }
    }
  } )
}
```

Input JSON Payload:

```json
[
  {
    "type": "book",
    "price": 30,
    "properties": {
      "title": "Everyday Italian",
      "author": ["Giada De Laurentiis"],
      "year": 2005
    }
  },
  {
    "type": "book",
    "price": 29.99,
    "properties": {
      "title": "Harry Potter",
      "author": ["J K. Rowling"],
      "year": 2005
    }
  },
  {
    "type": "book",
    "price": 41.12,
    "properties": {
      "title": "Mule in Action",
      "author": ["David Dossot", "John D'Emic"],
      "year": 2009
    }
  },
  {
    "type": "book",
    "price": 49.99,
    "properties": {
      "title": "XQuery Kick Start",
      "author": [
        "James McGovern",
        "Per Bothner",
        "Kurt Cagle",
        "James Linn",
        "Kurt Cagle",
        "Vaidyanathan Nagarajan"
      ],
      "year": 2003
    }
  },
  {
    "type": "book",
    "price": 39.95,
    "properties": {
      "title": "Learning XML",
      "author": ["Erik T. Ray"],
      "year": 2003
    }
  }
]
```

Input Attributes:

```json
{
  "publishedAfter": 2004
}
```

Input Variable `exchangeRate`:

```json
{
  "USD": [
    { "currency": "EUR", "ratio": 0.92 },
    { "currency": "ARS", "ratio": 8.76 },
    { "currency": "GBP", "ratio": 0.66 }
  ]
}
```

Output XML:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<books>
  <book year="2005">
    <price currency="EUR">27.60</price>
    <price currency="ARS">262.80</price>
    <price currency="GBP">19.80</price>
    <title>Everyday Italian</title>
    <authors>
      <author>Giada De Laurentiis</author>
    </authors>
  </book>
  <book year="2005">
    <price currency="EUR">27.5908</price>
    <price currency="ARS">262.7124</price>
    <price currency="GBP">19.7934</price>
    <title>Harry Potter</title>
    <authors>
      <author>J K. Rowling</author>
    </authors>
  </book>
  <book year="2009">
    <price currency="EUR">37.8304</price>
    <price currency="ARS">360.2112</price>
    <price currency="GBP">27.1392</price>
    <title>Mule in Action</title>
    <authors>
      <author>David Dossot</author>
      <author>John D'Emic</author>
    </authors>
  </book>
</books>
```

## Related Examples

- [Extract Data](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-extract-data)

- [Merge Fields from Separate Objects](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-merge-multiple-payloads)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/latest/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook)

<!-- document id=e1fe59276faa44c77276ac95efacde5faa15e0316a034a690e93268a525be154 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook-regroup-fields.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, transform, transformer, format, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, groupby, mapobject
---

# Regroup Fields

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

These DataWeave examples take input that is grouped under one field and transform it into a new
structure that groups data under another field.

Both examples use these functions:

- `groupBy` to organize the fields by `subject`

- `mapObject` and `map` to map the fields from the input to the new hierarchy.

## Example: XML to JSON

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
classrooms: payload..*teacher groupBy $.subject mapObject ((teacherGroup, subject) -> {
   class: {
     name: subject,
     teachers: { (teacherGroup map {
       teacher:{
           name: $.name,
           lastName: $.lastName
       }
     })
   }
  }
})
```

Input XML Payload:

```xml
<school>
    <teachers>
        <teacher>
            <name>Mariano</name>
            <lastName>De Achaval</lastName>
            <subject>DW</subject>
        </teacher>
        <teacher>
            <name>Emiliano</name>
            <lastName>Lesende</lastName>
            <subject>DW</subject>
        </teacher>
        <teacher>
            <name>Leandro</name>
            <lastName>Shokida</lastName>
            <subject>Scala</subject>
        </teacher>
    </teachers>
</school>
```

Output JSON:

```json
{
  "classrooms": {
    "class": {
      "name": "DW",
      "teachers": {
        "teacher": {
          "name": "Mariano",
          "lastName": "De Achaval"
        },
        "teacher": {
          "name": "Emiliano",
          "lastName": "Lesende"
        }
      }
    },
    "class": {
      "name": "Scala",
      "teachers": {
        "teacher": {
          "name": "Leandro",
          "lastName": "Shokida"
        }
      }
    }
  }
}
```

## Example: JSON to JSON

This DataWeave example changes the hierarchy of a JSON object. The output groups fields by
`language` and adds a new element, `attendees`, that contains the names of attendees for each
course.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
    "langs" :
        payload.langs groupBy $.language
            mapObject ((nameGroup, language) -> {
                 (language): {
                    "attendees" : nameGroup map {
                        name: $.name
                    }
                 }
            })
}
```

Input JSON Payload:

```json
{
  "langs": [
    {
      "name": "Alex",
      "language": "Java"
    },
    {
      "name": "Kris",
      "language": "Scala"
    },
    {
      "name": "Jorge",
      "language": "Java"
    }
  ]
}
```

Output JSON:

```json
{
  "langs": {
    "Java": {
      "attendees": [
        {
          "name": "Alex"
        },
        {
          "name": "Jorge"
        }
      ]
    },
    "Scala": {
      "attendees": [
        {
          "name": "Kris"
        }
      ]
    }
  }
}
```

## Related Examples

- [Map Data](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-map)

- [Reference Multiple Inputs](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-reference-multiple-inputs)

- [Define a Function that Flattens Data in a List](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-define-function-to-flatten-list)

- [Zip Arrays Together](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-zip-arrays-together)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.11/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.11/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook)

<!-- document id=14fb06ef0f64c063491390cb2851ced5542878384cbce170d3bdb2bb042762d6 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook-regroup-fields.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, transform, transformer, format, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, groupby, mapobject
---

# Regroup Fields

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

These DataWeave examples take input that is grouped under one field and transform it into a new
structure that groups data under another field.

Both examples use these functions:

- `groupBy` to organize the fields by `subject`

- `mapObject` and `map` to map the fields from the input to the new hierarchy.

## Example: XML to JSON

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
classrooms: payload..*teacher groupBy $.subject mapObject ((teacherGroup, subject) -> {
   class: {
     name: subject,
     teachers: { (teacherGroup map {
       teacher:{
           name: $.name,
           lastName: $.lastName
       }
     })
   }
  }
})
```

Input XML Payload:

```xml
<school>
    <teachers>
        <teacher>
            <name>Mariano</name>
            <lastName>De Achaval</lastName>
            <subject>DW</subject>
        </teacher>
        <teacher>
            <name>Emiliano</name>
            <lastName>Lesende</lastName>
            <subject>DW</subject>
        </teacher>
        <teacher>
            <name>Leandro</name>
            <lastName>Shokida</lastName>
            <subject>Scala</subject>
        </teacher>
    </teachers>
</school>
```

Output JSON:

```json
{
  "classrooms": {
    "class": {
      "name": "DW",
      "teachers": {
        "teacher": {
          "name": "Mariano",
          "lastName": "De Achaval"
        },
        "teacher": {
          "name": "Emiliano",
          "lastName": "Lesende"
        }
      }
    },
    "class": {
      "name": "Scala",
      "teachers": {
        "teacher": {
          "name": "Leandro",
          "lastName": "Shokida"
        }
      }
    }
  }
}
```

## Example: JSON to JSON

This DataWeave example changes the hierarchy of a JSON object. The output groups fields by
`language` and adds a new element, `attendees`, that contains the names of attendees for each
course.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
    "langs" :
        payload.langs groupBy $.language
            mapObject ((nameGroup, language) -> {
                 (language): {
                    "attendees" : nameGroup map {
                        name: $.name
                    }
                 }
            })
}
```

Input JSON Payload:

```json
{
  "langs": [
    {
      "name": "Alex",
      "language": "Java"
    },
    {
      "name": "Kris",
      "language": "Scala"
    },
    {
      "name": "Jorge",
      "language": "Java"
    }
  ]
}
```

Output JSON:

```json
{
  "langs": {
    "Java": {
      "attendees": [
        {
          "name": "Alex"
        },
        {
          "name": "Jorge"
        }
      ]
    },
    "Scala": {
      "attendees": [
        {
          "name": "Kris"
        }
      ]
    }
  }
}
```

## Related Examples

- [Map Data](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-map)

- [Reference Multiple Inputs](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-reference-multiple-inputs)

- [Define a Function that Flattens Data in a List](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-define-function-to-flatten-list)

- [Zip Arrays Together](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-zip-arrays-together)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.12/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.12/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook)

<!-- document id=b160bf7db5c087c0e0c1bd199fd1e0aa2c5988a8db7a9b84aa3212dc419e0207 url=/mulesoft/current/en-us/dataweave/2.3/dataweave-cookbook-regroup-fields.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, transform, transformer, format, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, groupby, mapobject
---

# Regroup Fields

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

These DataWeave examples take input that is grouped under one field and transform it into a new
structure that groups data under another field.

Both examples use these functions:

- `groupBy` to organize the fields by `subject`

- `mapObject` and `map` to map the fields from the input to the new hierarchy.

## Example: XML to JSON

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
classrooms: payload..*teacher groupBy $.subject mapObject ((teacherGroup, subject) -> {
   class: {
     name: subject,
     teachers: { (teacherGroup map {
       teacher:{
           name: $.name,
           lastName: $.lastName
       }
     })
   }
  }
})
```

Input XML Payload:

```xml
<school>
    <teachers>
        <teacher>
            <name>Mariano</name>
            <lastName>De Achaval</lastName>
            <subject>DW</subject>
        </teacher>
        <teacher>
            <name>Emiliano</name>
            <lastName>Lesende</lastName>
            <subject>DW</subject>
        </teacher>
        <teacher>
            <name>Leandro</name>
            <lastName>Shokida</lastName>
            <subject>Scala</subject>
        </teacher>
    </teachers>
</school>
```

Output JSON:

```json
{
  "classrooms": {
    "class": {
      "name": "DW",
      "teachers": {
        "teacher": {
          "name": "Mariano",
          "lastName": "De Achaval"
        },
        "teacher": {
          "name": "Emiliano",
          "lastName": "Lesende"
        }
      }
    },
    "class": {
      "name": "Scala",
      "teachers": {
        "teacher": {
          "name": "Leandro",
          "lastName": "Shokida"
        }
      }
    }
  }
}
```

## Example: JSON to JSON

This DataWeave example changes the hierarchy of a JSON object. The output groups fields by
`language` and adds a new element, `attendees`, that contains the names of attendees for each
course.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
    "langs" :
        payload.langs groupBy $.language
            mapObject ((nameGroup, language) -> {
                 (language): {
                    "attendees" : nameGroup map {
                        name: $.name
                    }
                 }
            })
}
```

Input JSON Payload:

```json
{
  "langs": [
    {
      "name": "Alex",
      "language": "Java"
    },
    {
      "name": "Kris",
      "language": "Scala"
    },
    {
      "name": "Jorge",
      "language": "Java"
    }
  ]
}
```

Output JSON:

```json
{
  "langs": {
    "Java": {
      "attendees": [
        {
          "name": "Alex"
        },
        {
          "name": "Jorge"
        }
      ]
    },
    "Scala": {
      "attendees": [
        {
          "name": "Kris"
        }
      ]
    }
  }
}
```

## Related Examples

- [Map Data](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-map)

- [Reference Multiple Inputs](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-reference-multiple-inputs)

- [Define a Function that Flattens Data in a List](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-define-function-to-flatten-list)

- [Zip Arrays Together](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-zip-arrays-together)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.3/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.3/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook)

<!-- document id=4f66bc155ddf1d79bdd20b05c625410b25adf98303198b0da1e687a44a954998 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook-regroup-fields.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, transform, transformer, format, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, groupby, mapobject
---

# Regroup Fields

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

These DataWeave examples take input that is grouped under one field and transform it into a new
structure that groups data under another field.

Both examples use these functions:

- `groupBy` to organize the fields by `subject`

- `mapObject` and `map` to map the fields from the input to the new hierarchy.

## Example: XML to JSON

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
classrooms: payload..*teacher groupBy $.subject mapObject ((teacherGroup, subject) -> {
   class: {
     name: subject,
     teachers: { (teacherGroup map {
       teacher:{
           name: $.name,
           lastName: $.lastName
       }
     })
   }
  }
})
```

Input XML Payload:

```xml
<school>
    <teachers>
        <teacher>
            <name>Mariano</name>
            <lastName>De Achaval</lastName>
            <subject>DW</subject>
        </teacher>
        <teacher>
            <name>Emiliano</name>
            <lastName>Lesende</lastName>
            <subject>DW</subject>
        </teacher>
        <teacher>
            <name>Leandro</name>
            <lastName>Shokida</lastName>
            <subject>Scala</subject>
        </teacher>
    </teachers>
</school>
```

Output JSON:

```json
{
  "classrooms": {
    "class": {
      "name": "DW",
      "teachers": {
        "teacher": {
          "name": "Mariano",
          "lastName": "De Achaval"
        },
        "teacher": {
          "name": "Emiliano",
          "lastName": "Lesende"
        }
      }
    },
    "class": {
      "name": "Scala",
      "teachers": {
        "teacher": {
          "name": "Leandro",
          "lastName": "Shokida"
        }
      }
    }
  }
}
```

## Example: JSON to JSON

This DataWeave example changes the hierarchy of a JSON object. The output groups fields by
`language` and adds a new element, `attendees`, that contains the names of attendees for each
course.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
    "langs" :
        payload.langs groupBy $.language
            mapObject ((nameGroup, language) -> {
                 (language): {
                    "attendees" : nameGroup map {
                        name: $.name
                    }
                 }
            })
}
```

Input JSON Payload:

```json
{
  "langs": [
    {
      "name": "Alex",
      "language": "Java"
    },
    {
      "name": "Kris",
      "language": "Scala"
    },
    {
      "name": "Jorge",
      "language": "Java"
    }
  ]
}
```

Output JSON:

```json
{
  "langs": {
    "Java": {
      "attendees": [
        {
          "name": "Alex"
        },
        {
          "name": "Jorge"
        }
      ]
    },
    "Scala": {
      "attendees": [
        {
          "name": "Kris"
        }
      ]
    }
  }
}
```

## Related Examples

- [Map Data](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-map)

- [Reference Multiple Inputs](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-reference-multiple-inputs)

- [Define a Function that Flattens Data in a List](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-define-function-to-flatten-list)

- [Zip Arrays Together](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-zip-arrays-together)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.4/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.4/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook)

<!-- document id=e6fc40ecb7db30dd89479d08f256cb5000541811e022aa47da775f73622d0d03 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook-regroup-fields.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, transform, transformer, format, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, groupby, mapobject
---

# Regroup Fields

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

These DataWeave examples take input that is grouped under one field and transform it into a new
structure that groups data under another field.

Both examples use these functions:

- `groupBy` to organize the fields by `subject`

- `mapObject` and `map` to map the fields from the input to the new hierarchy.

## Example: XML to JSON

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
classrooms: payload..*teacher groupBy $.subject mapObject ((teacherGroup, subject) -> {
   class: {
     name: subject,
     teachers: { (teacherGroup map {
       teacher:{
           name: $.name,
           lastName: $.lastName
       }
     })
   }
  }
})
```

Input XML Payload:

```xml
<school>
    <teachers>
        <teacher>
            <name>Mariano</name>
            <lastName>De Achaval</lastName>
            <subject>DW</subject>
        </teacher>
        <teacher>
            <name>Emiliano</name>
            <lastName>Lesende</lastName>
            <subject>DW</subject>
        </teacher>
        <teacher>
            <name>Leandro</name>
            <lastName>Shokida</lastName>
            <subject>Scala</subject>
        </teacher>
    </teachers>
</school>
```

Output JSON:

```json
{
  "classrooms": {
    "class": {
      "name": "DW",
      "teachers": {
        "teacher": {
          "name": "Mariano",
          "lastName": "De Achaval"
        },
        "teacher": {
          "name": "Emiliano",
          "lastName": "Lesende"
        }
      }
    },
    "class": {
      "name": "Scala",
      "teachers": {
        "teacher": {
          "name": "Leandro",
          "lastName": "Shokida"
        }
      }
    }
  }
}
```

## Example: JSON to JSON

This DataWeave example changes the hierarchy of a JSON object. The output groups fields by
`language` and adds a new element, `attendees`, that contains the names of attendees for each
course.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
    "langs" :
        payload.langs groupBy $.language
            mapObject ((nameGroup, language) -> {
                 (language): {
                    "attendees" : nameGroup map {
                        name: $.name
                    }
                 }
            })
}
```

Input JSON Payload:

```json
{
  "langs": [
    {
      "name": "Alex",
      "language": "Java"
    },
    {
      "name": "Kris",
      "language": "Scala"
    },
    {
      "name": "Jorge",
      "language": "Java"
    }
  ]
}
```

Output JSON:

```json
{
  "langs": {
    "Java": {
      "attendees": [
        {
          "name": "Alex"
        },
        {
          "name": "Jorge"
        }
      ]
    },
    "Scala": {
      "attendees": [
        {
          "name": "Kris"
        }
      ]
    }
  }
}
```

## Related Examples

- [Map Data](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-map)

- [Reference Multiple Inputs](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-reference-multiple-inputs)

- [Define a Function that Flattens Data in a List](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-define-function-to-flatten-list)

- [Zip Arrays Together](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-zip-arrays-together)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.6/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.6/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook)

<!-- document id=7baeec3abc5e6a39e539029c620f1dad83e1ae7ca8b129c28ddeb2dfedd61e99 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook-regroup-fields.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, transform, transformer, format, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, groupby, mapobject
---

# Regroup Fields

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

These DataWeave examples take input that is grouped under one field and transform it into a new
structure that groups data under another field.

Both examples use these functions:

- `groupBy` to organize the fields by `subject`

- `mapObject` and `map` to map the fields from the input to the new hierarchy.

## Example: XML to JSON

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
classrooms: payload..*teacher groupBy $.subject mapObject ((teacherGroup, subject) -> {
   class: {
     name: subject,
     teachers: { (teacherGroup map {
       teacher:{
           name: $.name,
           lastName: $.lastName
       }
     })
   }
  }
})
```

Input XML Payload:

```xml
<school>
    <teachers>
        <teacher>
            <name>Mariano</name>
            <lastName>De Achaval</lastName>
            <subject>DW</subject>
        </teacher>
        <teacher>
            <name>Emiliano</name>
            <lastName>Lesende</lastName>
            <subject>DW</subject>
        </teacher>
        <teacher>
            <name>Leandro</name>
            <lastName>Shokida</lastName>
            <subject>Scala</subject>
        </teacher>
    </teachers>
</school>
```

Output JSON:

```json
{
  "classrooms": {
    "class": {
      "name": "DW",
      "teachers": {
        "teacher": {
          "name": "Mariano",
          "lastName": "De Achaval"
        },
        "teacher": {
          "name": "Emiliano",
          "lastName": "Lesende"
        }
      }
    },
    "class": {
      "name": "Scala",
      "teachers": {
        "teacher": {
          "name": "Leandro",
          "lastName": "Shokida"
        }
      }
    }
  }
}
```

## Example: JSON to JSON

This DataWeave example changes the hierarchy of a JSON object. The output groups fields by
`language` and adds a new element, `attendees`, that contains the names of attendees for each
course.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
    "langs" :
        payload.langs groupBy $.language
            mapObject ((nameGroup, language) -> {
                 (language): {
                    "attendees" : nameGroup map {
                        name: $.name
                    }
                 }
            })
}
```

Input JSON Payload:

```json
{
  "langs": [
    {
      "name": "Alex",
      "language": "Java"
    },
    {
      "name": "Kris",
      "language": "Scala"
    },
    {
      "name": "Jorge",
      "language": "Java"
    }
  ]
}
```

Output JSON:

```json
{
  "langs": {
    "Java": {
      "attendees": [
        {
          "name": "Alex"
        },
        {
          "name": "Jorge"
        }
      ]
    },
    "Scala": {
      "attendees": [
        {
          "name": "Kris"
        }
      ]
    }
  }
}
```

## Related Examples

- [Map Data](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-map)

- [Reference Multiple Inputs](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-reference-multiple-inputs)

- [Define a Function that Flattens Data in a List](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-define-function-to-flatten-list)

- [Zip Arrays Together](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-zip-arrays-together)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.9/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.9/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook)

<!-- document id=17367c9cba6fd8615c90b9d8458232f43acf67f6761aff84f9d5564afc001740 url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook-regroup-fields.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, transform, transformer, format, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, groupby, mapobject
---

# Regroup Fields

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

These DataWeave examples take input that is grouped under one field and transform it into a new
structure that groups data under another field.

Both examples use these functions:

- `groupBy` to organize the fields by `subject`

- `mapObject` and `map` to map the fields from the input to the new hierarchy.

## Example: XML to JSON

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
classrooms: payload..*teacher groupBy $.subject mapObject ((teacherGroup, subject) -> {
   class: {
     name: subject,
     teachers: { (teacherGroup map {
       teacher:{
           name: $.name,
           lastName: $.lastName
       }
     })
   }
  }
})
```

Input XML Payload:

```xml
<school>
    <teachers>
        <teacher>
            <name>Mariano</name>
            <lastName>De Achaval</lastName>
            <subject>DW</subject>
        </teacher>
        <teacher>
            <name>Emiliano</name>
            <lastName>Lesende</lastName>
            <subject>DW</subject>
        </teacher>
        <teacher>
            <name>Leandro</name>
            <lastName>Shokida</lastName>
            <subject>Scala</subject>
        </teacher>
    </teachers>
</school>
```

Output JSON:

```json
{
  "classrooms": {
    "class": {
      "name": "DW",
      "teachers": {
        "teacher": {
          "name": "Mariano",
          "lastName": "De Achaval"
        },
        "teacher": {
          "name": "Emiliano",
          "lastName": "Lesende"
        }
      }
    },
    "class": {
      "name": "Scala",
      "teachers": {
        "teacher": {
          "name": "Leandro",
          "lastName": "Shokida"
        }
      }
    }
  }
}
```

## Example: JSON to JSON

This DataWeave example changes the hierarchy of a JSON object. The output groups fields by
`language` and adds a new element, `attendees`, that contains the names of attendees for each
course.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
    "langs" :
        payload.langs groupBy $.language
            mapObject ((nameGroup, language) -> {
                 (language): {
                    "attendees" : nameGroup map {
                        name: $.name
                    }
                 }
            })
}
```

Input JSON Payload:

```json
{
  "langs": [
    {
      "name": "Alex",
      "language": "Java"
    },
    {
      "name": "Kris",
      "language": "Scala"
    },
    {
      "name": "Jorge",
      "language": "Java"
    }
  ]
}
```

Output JSON:

```json
{
  "langs": {
    "Java": {
      "attendees": [
        {
          "name": "Alex"
        },
        {
          "name": "Jorge"
        }
      ]
    },
    "Scala": {
      "attendees": [
        {
          "name": "Kris"
        }
      ]
    }
  }
}
```

## Related Examples

- [Map Data](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-map)

- [Reference Multiple Inputs](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-reference-multiple-inputs)

- [Define a Function that Flattens Data in a List](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-define-function-to-flatten-list)

- [Zip Arrays Together](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-zip-arrays-together)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/latest/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook)

<!-- document id=69591cb7f11586e8ab0743eab9a1d6de8a426083a4b25b66e6c23994ceee5eaf url=/mulesoft/current/en-us/dataweave/2.11/dw-strings-functions-remove.md -->

---
product: DataWeave
version: 2.11
---

# remove

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## remove(text: String, toRemove: String): String

Removes all occurrences of a specified pattern from a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The text to remove from.</p></td></tr><tr><td><p><code>toRemove</code></p></td><td><p>The pattern to remove.</p></td></tr></tbody></table>

### Example

This example shows how the `remove` can be used to remove some unwanted properties.

#### Source

```DataWeave
%dw 2.0
import remove from dw::core::Strings
output application/json
---
"lazyness purity state higher-order stateful" remove "state"
```

#### Output

```Json
"lazyness purity  higher-order ful"
```

## remove(text: Null, toRemove: Any): Null

Helper function that enables `remove` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=262ee20f886a5c6261cead7c17aa9e043eaeb3b2f5ec262bf55cfeb6d7026738 url=/mulesoft/current/en-us/dataweave/2.12/dw-strings-functions-remove.md -->

---
product: DataWeave
version: 2.12
---

# remove

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## remove(text: String, toRemove: String): String

Removes all occurrences of a specified pattern from a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The text to remove from.</p></td></tr><tr><td><p><code>toRemove</code></p></td><td><p>The pattern to remove.</p></td></tr></tbody></table>

### Example

This example shows how the `remove` can be used to remove some unwanted properties.

#### Source

```DataWeave
%dw 2.0
import remove from dw::core::Strings
output application/json
---
"lazyness purity state higher-order stateful" remove "state"
```

#### Output

```Json
"lazyness purity  higher-order ful"
```

## remove(text: Null, toRemove: Any): Null

Helper function that enables `remove` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=d4b9f721043da4ebea266a908fe6938b10d785f6162539c72751e7b816150cfe url=/mulesoft/current/en-us/dataweave/2.4/dw-strings-functions-remove.md -->

---
product: DataWeave
version: 2.4
---

# remove

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## remove(text: String, toRemove: String): String

Removes all occurrences of a specified pattern from a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The text to remove from.</p></td></tr><tr><td><p><code>toRemove</code></p></td><td><p>The pattern to remove.</p></td></tr></tbody></table>

### Example

This example shows how the `remove` can be used to remove some unwanted properties.

#### Source

```DataWeave
%dw 2.0
import remove from dw::core::Strings
output application/json
---
"lazyness purity state higher-order stateful" remove "state"
```

#### Output

```Json
"lazyness purity  higher-order ful"
```

## remove(text: Null, toRemove: Any): Null

Helper function that enables `remove` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=451d79733a5b3fff7a156c2c415f12820868efb051b2fe9816e8ddc279e3120a url=/mulesoft/current/en-us/dataweave/2.6/dw-strings-functions-remove.md -->

---
product: DataWeave
version: 2.6
---

# remove

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## remove(text: String, toRemove: String): String

Removes all occurrences of a specified pattern from a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The text to remove from.</p></td></tr><tr><td><p><code>toRemove</code></p></td><td><p>The pattern to remove.</p></td></tr></tbody></table>

### Example

This example shows how the `remove` can be used to remove some unwanted properties.

#### Source

```DataWeave
%dw 2.0
import remove from dw::core::Strings
output application/json
---
"lazyness purity state higher-order stateful" remove "state"
```

#### Output

```Json
"lazyness purity  higher-order ful"
```

## remove(text: Null, toRemove: Any): Null

Helper function that enables `remove` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=5549baae719f65cf84ddf96d8f812cf3f111aa0b174ad8ef9f1079991b31c242 url=/mulesoft/current/en-us/dataweave/2.9/dw-strings-functions-remove.md -->

---
product: DataWeave
version: 2.9
---

# remove

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## remove(text: String, toRemove: String): String

Removes all occurrences of a specified pattern from a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The text to remove from.</p></td></tr><tr><td><p><code>toRemove</code></p></td><td><p>The pattern to remove.</p></td></tr></tbody></table>

### Example

This example shows how the `remove` can be used to remove some unwanted properties.

#### Source

```DataWeave
%dw 2.0
import remove from dw::core::Strings
output application/json
---
"lazyness purity state higher-order stateful" remove "state"
```

#### Output

```Json
"lazyness purity  higher-order ful"
```

## remove(text: Null, toRemove: Any): Null

Helper function that enables `remove` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=7c44f860ebac5b63ee2fe9bb47ce9d52bd0a8ee583a8d1164f2a8e046b9d21f6 url=/mulesoft/current/en-us/dataweave/latest/dw-strings-functions-remove.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# remove

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## remove(text: String, toRemove: String): String

Removes all occurrences of a specified pattern from a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The text to remove from.</p></td></tr><tr><td><p><code>toRemove</code></p></td><td><p>The pattern to remove.</p></td></tr></tbody></table>

### Example

This example shows how the `remove` can be used to remove some unwanted properties.

#### Source

```DataWeave
%dw 2.0
import remove from dw::core::Strings
output application/json
---
"lazyness purity state higher-order stateful" remove "state"
```

#### Output

```Json
"lazyness purity  higher-order ful"
```

## remove(text: Null, toRemove: Any): Null

Helper function that enables `remove` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=54d08af6633866b4c8c068c16f527589a65e0ed49f6c6f34013f4953847478b5 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook-remove-objects.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Remove Objects Containing Specified Key-Value Pairs

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example removes all objects that contain a set of key-value pairs from an array of
objects.

This example uses the following functions:

- `filter` iterates over the objects within the input array to return an array with the objects that
  return `true` as the result of an expression. Each object in the input array contains a set of
  key-value pairs. The expression uses the `contains` function and the `not` operator.

- `contains` identifies the key-value pairs specified in the `dropThese` variable. This variable is
  an array of objects containing the key-value pairs to remove.

  `not` negates the result of the `contains` function to make `filter` remove the key-value pairs
  identified in `dropThese` from the final output. (Without `not`, the result is an array of objects
  containing only the _undesired_ key-value pairs.)

DataWeave Script:

```dataweave
%dw 2.0
var dropThese = [
{"type" : "secondary", "space" : "rgb"},
{"type" : "primary", "space" : "cmyk"}
]
output application/json
---
payload filter (not (dropThese contains {"type": $."type", "space": $."space"}))
```

Input JSON Payload:

```json
[
  { "sequence": "1", "color": "red", "type": "primary", "space": "rgb" },
  { "sequence": "2", "color": "green", "type": "primary", "space": "rgb" },
  { "sequence": "3", "color": "blue", "type": "primary", "space": "rgb" },
  { "sequence": "4", "color": "yellow", "type": "secondary", "space": "rgb" },
  { "sequence": "5", "color": "magenta", "type": "secondary", "space": "rgb" },
  { "sequence": "6", "color": "cyan", "type": "secondary", "space": "rgb" },
  { "sequence": "7", "color": "cyan", "type": "primary", "space": "cmyk" },
  { "sequence": "8", "color": "magenta", "type": "primary", "space": "cmyk" },
  { "sequence": "9", "color": "yellow", "type": "primary", "space": "cmyk" },
  { "sequence": "10", "color": "red", "type": "secondary", "space": "cmyk" },
  { "sequence": "11", "color": "green", "type": "secondary", "space": "cmyk" },
  { "sequence": "12", "color": "blue", "type": "secondary", "space": "cmyk" }
]
```

Output JSON:

```json
[
  {
    "sequence": "1",
    "color": "red",
    "type": "primary",
    "space": "rgb"
  },
  {
    "sequence": "2",
    "color": "green",
    "type": "primary",
    "space": "rgb"
  },
  {
    "sequence": "3",
    "color": "blue",
    "type": "primary",
    "space": "rgb"
  },
  {
    "sequence": "10",
    "color": "red",
    "type": "secondary",
    "space": "cmyk"
  },
  {
    "sequence": "11",
    "color": "green",
    "type": "secondary",
    "space": "cmyk"
  },
  {
    "sequence": "12",
    "color": "blue",
    "type": "secondary",
    "space": "cmyk"
  }
]
```

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.11/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook)

<!-- document id=33b15fea2a844288467440fe3c9ddfed435bad84973abeb28325de7d0f900a3b url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook-remove-objects.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Remove Objects Containing Specified Key-Value Pairs

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example removes all objects that contain a set of key-value pairs from an array of
objects.

This example uses the following functions:

- `filter` iterates over the objects within the input array to return an array with the objects that
  return `true` as the result of an expression. Each object in the input array contains a set of
  key-value pairs. The expression uses the `contains` function and the `not` operator.

- `contains` identifies the key-value pairs specified in the `dropThese` variable. This variable is
  an array of objects containing the key-value pairs to remove.

  `not` negates the result of the `contains` function to make `filter` remove the key-value pairs
  identified in `dropThese` from the final output. (Without `not`, the result is an array of objects
  containing only the _undesired_ key-value pairs.)

DataWeave Script:

```dataweave
%dw 2.0
var dropThese = [
{"type" : "secondary", "space" : "rgb"},
{"type" : "primary", "space" : "cmyk"}
]
output application/json
---
payload filter (not (dropThese contains {"type": $."type", "space": $."space"}))
```

Input JSON Payload:

```json
[
  { "sequence": "1", "color": "red", "type": "primary", "space": "rgb" },
  { "sequence": "2", "color": "green", "type": "primary", "space": "rgb" },
  { "sequence": "3", "color": "blue", "type": "primary", "space": "rgb" },
  { "sequence": "4", "color": "yellow", "type": "secondary", "space": "rgb" },
  { "sequence": "5", "color": "magenta", "type": "secondary", "space": "rgb" },
  { "sequence": "6", "color": "cyan", "type": "secondary", "space": "rgb" },
  { "sequence": "7", "color": "cyan", "type": "primary", "space": "cmyk" },
  { "sequence": "8", "color": "magenta", "type": "primary", "space": "cmyk" },
  { "sequence": "9", "color": "yellow", "type": "primary", "space": "cmyk" },
  { "sequence": "10", "color": "red", "type": "secondary", "space": "cmyk" },
  { "sequence": "11", "color": "green", "type": "secondary", "space": "cmyk" },
  { "sequence": "12", "color": "blue", "type": "secondary", "space": "cmyk" }
]
```

Output JSON:

```json
[
  {
    "sequence": "1",
    "color": "red",
    "type": "primary",
    "space": "rgb"
  },
  {
    "sequence": "2",
    "color": "green",
    "type": "primary",
    "space": "rgb"
  },
  {
    "sequence": "3",
    "color": "blue",
    "type": "primary",
    "space": "rgb"
  },
  {
    "sequence": "10",
    "color": "red",
    "type": "secondary",
    "space": "cmyk"
  },
  {
    "sequence": "11",
    "color": "green",
    "type": "secondary",
    "space": "cmyk"
  },
  {
    "sequence": "12",
    "color": "blue",
    "type": "secondary",
    "space": "cmyk"
  }
]
```

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.12/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook)

<!-- document id=13a102fea894065e86383fc7ae203443a7716b146727211707b8a1b3174b2895 url=/mulesoft/current/en-us/dataweave/2.3/dataweave-cookbook-remove-objects.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Remove Objects Containing Specified Key-Value Pairs

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example removes all objects that contain a set of key-value pairs from an array of
objects.

This example uses the following functions:

- `filter` iterates over the objects within the input array to return an array with the objects that
  return `true` as the result of an expression. Each object in the input array contains a set of
  key-value pairs. The expression uses the `contains` function and the `not` operator.

- `contains` identifies the key-value pairs specified in the `dropThese` variable. This variable is
  an array of objects containing the key-value pairs to remove.

  `not` negates the result of the `contains` function to make `filter` remove the key-value pairs
  identified in `dropThese` from the final output. (Without `not`, the result is an array of objects
  containing only the _undesired_ key-value pairs.)

DataWeave Script:

```dataweave
%dw 2.0
var dropThese = [
{"type" : "secondary", "space" : "rgb"},
{"type" : "primary", "space" : "cmyk"}
]
output application/json
---
payload filter (not (dropThese contains {"type": $."type", "space": $."space"}))
```

Input XML Payload:

```xml
[
    {"sequence": "1", "color": "red", "type": "primary", "space": "rgb"}
    {"sequence": "2", "color": "green", "type": "primary", "space": "rgb"},
    {"sequence": "3", "color": "blue", "type": "primary", "space": "rgb"},
    {"sequence": "4", "color": "yellow", "type": "secondary", "space": "rgb"},
    {"sequence": "5", "color": "magenta", "type": "secondary", "space": "rgb"},
    {"sequence": "6", "color": "cyan", "type": "secondary", "space": "rgb"},
    {"sequence": "7", "color": "cyan", "type": "primary", "space": "cmyk"},
    {"sequence": "8", "color": "magenta", "type": "primary", "space": "cmyk"},
    {"sequence": "9", "color": "yellow", "type": "primary", "space": "cmyk"},
    {"sequence": "10", "color": "red", "type": "secondary", "space": "cmyk"},
    {"sequence": "11", "color": "green", "type": "secondary", "space": "cmyk"},
    {"sequence": "12", "color": "blue", "type": "secondary", "space": "cmyk"}
]
```

Output XML:

```xml
[
  {
    "sequence": "1",
    "color": "red",
    "type": "primary",
    "space": "rgb"
  },
  {
    "sequence": "2",
    "color": "green",
    "type": "primary",
    "space": "rgb"
  },
  {
    "sequence": "3",
    "color": "blue",
    "type": "primary",
    "space": "rgb"
  },
  {
    "sequence": "10",
    "color": "red",
    "type": "secondary",
    "space": "cmyk"
  },
  {
    "sequence": "11",
    "color": "green",
    "type": "secondary",
    "space": "cmyk"
  },
  {
    "sequence": "12",
    "color": "blue",
    "type": "secondary",
    "space": "cmyk"
  }
]
```

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.3/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook)

<!-- document id=3aff499b8478df0af0f452db7f28aa86f8be75a61e03482ee418b0cfd0952432 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook-remove-objects.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Remove Objects Containing Specified Key-Value Pairs

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example removes all objects that contain a set of key-value pairs from an array of
objects.

This example uses the following functions:

- `filter` iterates over the objects within the input array to return an array with the objects that
  return `true` as the result of an expression. Each object in the input array contains a set of
  key-value pairs. The expression uses the `contains` function and the `not` operator.

- `contains` identifies the key-value pairs specified in the `dropThese` variable. This variable is
  an array of objects containing the key-value pairs to remove.

  `not` negates the result of the `contains` function to make `filter` remove the key-value pairs
  identified in `dropThese` from the final output. (Without `not`, the result is an array of objects
  containing only the _undesired_ key-value pairs.)

DataWeave Script:

```dataweave
%dw 2.0
var dropThese = [
{"type" : "secondary", "space" : "rgb"},
{"type" : "primary", "space" : "cmyk"}
]
output application/json
---
payload filter (not (dropThese contains {"type": $."type", "space": $."space"}))
```

Input JSON Payload:

```json
[
  { "sequence": "1", "color": "red", "type": "primary", "space": "rgb" },
  { "sequence": "2", "color": "green", "type": "primary", "space": "rgb" },
  { "sequence": "3", "color": "blue", "type": "primary", "space": "rgb" },
  { "sequence": "4", "color": "yellow", "type": "secondary", "space": "rgb" },
  { "sequence": "5", "color": "magenta", "type": "secondary", "space": "rgb" },
  { "sequence": "6", "color": "cyan", "type": "secondary", "space": "rgb" },
  { "sequence": "7", "color": "cyan", "type": "primary", "space": "cmyk" },
  { "sequence": "8", "color": "magenta", "type": "primary", "space": "cmyk" },
  { "sequence": "9", "color": "yellow", "type": "primary", "space": "cmyk" },
  { "sequence": "10", "color": "red", "type": "secondary", "space": "cmyk" },
  { "sequence": "11", "color": "green", "type": "secondary", "space": "cmyk" },
  { "sequence": "12", "color": "blue", "type": "secondary", "space": "cmyk" }
]
```

Output JSON:

```json
[
  {
    "sequence": "1",
    "color": "red",
    "type": "primary",
    "space": "rgb"
  },
  {
    "sequence": "2",
    "color": "green",
    "type": "primary",
    "space": "rgb"
  },
  {
    "sequence": "3",
    "color": "blue",
    "type": "primary",
    "space": "rgb"
  },
  {
    "sequence": "10",
    "color": "red",
    "type": "secondary",
    "space": "cmyk"
  },
  {
    "sequence": "11",
    "color": "green",
    "type": "secondary",
    "space": "cmyk"
  },
  {
    "sequence": "12",
    "color": "blue",
    "type": "secondary",
    "space": "cmyk"
  }
]
```

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.4/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook)

<!-- document id=5b556fe88d70da626f2fa061b4709bf97658eb98ff27f66721507fd7bb7f613f url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook-remove-objects.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Remove Objects Containing Specified Key-Value Pairs

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example removes all objects that contain a set of key-value pairs from an array of
objects.

This example uses the following functions:

- `filter` iterates over the objects within the input array to return an array with the objects that
  return `true` as the result of an expression. Each object in the input array contains a set of
  key-value pairs. The expression uses the `contains` function and the `not` operator.

- `contains` identifies the key-value pairs specified in the `dropThese` variable. This variable is
  an array of objects containing the key-value pairs to remove.

  `not` negates the result of the `contains` function to make `filter` remove the key-value pairs
  identified in `dropThese` from the final output. (Without `not`, the result is an array of objects
  containing only the _undesired_ key-value pairs.)

DataWeave Script:

```dataweave
%dw 2.0
var dropThese = [
{"type" : "secondary", "space" : "rgb"},
{"type" : "primary", "space" : "cmyk"}
]
output application/json
---
payload filter (not (dropThese contains {"type": $."type", "space": $."space"}))
```

Input JSON Payload:

```json
[
  { "sequence": "1", "color": "red", "type": "primary", "space": "rgb" },
  { "sequence": "2", "color": "green", "type": "primary", "space": "rgb" },
  { "sequence": "3", "color": "blue", "type": "primary", "space": "rgb" },
  { "sequence": "4", "color": "yellow", "type": "secondary", "space": "rgb" },
  { "sequence": "5", "color": "magenta", "type": "secondary", "space": "rgb" },
  { "sequence": "6", "color": "cyan", "type": "secondary", "space": "rgb" },
  { "sequence": "7", "color": "cyan", "type": "primary", "space": "cmyk" },
  { "sequence": "8", "color": "magenta", "type": "primary", "space": "cmyk" },
  { "sequence": "9", "color": "yellow", "type": "primary", "space": "cmyk" },
  { "sequence": "10", "color": "red", "type": "secondary", "space": "cmyk" },
  { "sequence": "11", "color": "green", "type": "secondary", "space": "cmyk" },
  { "sequence": "12", "color": "blue", "type": "secondary", "space": "cmyk" }
]
```

Output JSON:

```json
[
  {
    "sequence": "1",
    "color": "red",
    "type": "primary",
    "space": "rgb"
  },
  {
    "sequence": "2",
    "color": "green",
    "type": "primary",
    "space": "rgb"
  },
  {
    "sequence": "3",
    "color": "blue",
    "type": "primary",
    "space": "rgb"
  },
  {
    "sequence": "10",
    "color": "red",
    "type": "secondary",
    "space": "cmyk"
  },
  {
    "sequence": "11",
    "color": "green",
    "type": "secondary",
    "space": "cmyk"
  },
  {
    "sequence": "12",
    "color": "blue",
    "type": "secondary",
    "space": "cmyk"
  }
]
```

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.6/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook)

<!-- document id=0f946940f40c2137d24fd47fa97b2b8d8d96293ae4ef7220d1f6dd86688e34ca url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook-remove-objects.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Remove Objects Containing Specified Key-Value Pairs

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example removes all objects that contain a set of key-value pairs from an array of
objects.

This example uses the following functions:

- `filter` iterates over the objects within the input array to return an array with the objects that
  return `true` as the result of an expression. Each object in the input array contains a set of
  key-value pairs. The expression uses the `contains` function and the `not` operator.

- `contains` identifies the key-value pairs specified in the `dropThese` variable. This variable is
  an array of objects containing the key-value pairs to remove.

  `not` negates the result of the `contains` function to make `filter` remove the key-value pairs
  identified in `dropThese` from the final output. (Without `not`, the result is an array of objects
  containing only the _undesired_ key-value pairs.)

DataWeave Script:

```dataweave
%dw 2.0
var dropThese = [
{"type" : "secondary", "space" : "rgb"},
{"type" : "primary", "space" : "cmyk"}
]
output application/json
---
payload filter (not (dropThese contains {"type": $."type", "space": $."space"}))
```

Input JSON Payload:

```json
[
  { "sequence": "1", "color": "red", "type": "primary", "space": "rgb" },
  { "sequence": "2", "color": "green", "type": "primary", "space": "rgb" },
  { "sequence": "3", "color": "blue", "type": "primary", "space": "rgb" },
  { "sequence": "4", "color": "yellow", "type": "secondary", "space": "rgb" },
  { "sequence": "5", "color": "magenta", "type": "secondary", "space": "rgb" },
  { "sequence": "6", "color": "cyan", "type": "secondary", "space": "rgb" },
  { "sequence": "7", "color": "cyan", "type": "primary", "space": "cmyk" },
  { "sequence": "8", "color": "magenta", "type": "primary", "space": "cmyk" },
  { "sequence": "9", "color": "yellow", "type": "primary", "space": "cmyk" },
  { "sequence": "10", "color": "red", "type": "secondary", "space": "cmyk" },
  { "sequence": "11", "color": "green", "type": "secondary", "space": "cmyk" },
  { "sequence": "12", "color": "blue", "type": "secondary", "space": "cmyk" }
]
```

Output JSON:

```json
[
  {
    "sequence": "1",
    "color": "red",
    "type": "primary",
    "space": "rgb"
  },
  {
    "sequence": "2",
    "color": "green",
    "type": "primary",
    "space": "rgb"
  },
  {
    "sequence": "3",
    "color": "blue",
    "type": "primary",
    "space": "rgb"
  },
  {
    "sequence": "10",
    "color": "red",
    "type": "secondary",
    "space": "cmyk"
  },
  {
    "sequence": "11",
    "color": "green",
    "type": "secondary",
    "space": "cmyk"
  },
  {
    "sequence": "12",
    "color": "blue",
    "type": "secondary",
    "space": "cmyk"
  }
]
```

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.9/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook)

<!-- document id=e10c254aed47abe76a856e5a88d6c4d2caafb20d414be77f7720e4c0d79c460b url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook-remove-objects.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Remove Objects Containing Specified Key-Value Pairs

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example removes all objects that contain a set of key-value pairs from an array of
objects.

This example uses the following functions:

- `filter` iterates over the objects within the input array to return an array with the objects that
  return `true` as the result of an expression. Each object in the input array contains a set of
  key-value pairs. The expression uses the `contains` function and the `not` operator.

- `contains` identifies the key-value pairs specified in the `dropThese` variable. This variable is
  an array of objects containing the key-value pairs to remove.

  `not` negates the result of the `contains` function to make `filter` remove the key-value pairs
  identified in `dropThese` from the final output. (Without `not`, the result is an array of objects
  containing only the _undesired_ key-value pairs.)

DataWeave Script:

```dataweave
%dw 2.0
var dropThese = [
{"type" : "secondary", "space" : "rgb"},
{"type" : "primary", "space" : "cmyk"}
]
output application/json
---
payload filter (not (dropThese contains {"type": $."type", "space": $."space"}))
```

Input JSON Payload:

```json
[
  { "sequence": "1", "color": "red", "type": "primary", "space": "rgb" },
  { "sequence": "2", "color": "green", "type": "primary", "space": "rgb" },
  { "sequence": "3", "color": "blue", "type": "primary", "space": "rgb" },
  { "sequence": "4", "color": "yellow", "type": "secondary", "space": "rgb" },
  { "sequence": "5", "color": "magenta", "type": "secondary", "space": "rgb" },
  { "sequence": "6", "color": "cyan", "type": "secondary", "space": "rgb" },
  { "sequence": "7", "color": "cyan", "type": "primary", "space": "cmyk" },
  { "sequence": "8", "color": "magenta", "type": "primary", "space": "cmyk" },
  { "sequence": "9", "color": "yellow", "type": "primary", "space": "cmyk" },
  { "sequence": "10", "color": "red", "type": "secondary", "space": "cmyk" },
  { "sequence": "11", "color": "green", "type": "secondary", "space": "cmyk" },
  { "sequence": "12", "color": "blue", "type": "secondary", "space": "cmyk" }
]
```

Output JSON:

```json
[
  {
    "sequence": "1",
    "color": "red",
    "type": "primary",
    "space": "rgb"
  },
  {
    "sequence": "2",
    "color": "green",
    "type": "primary",
    "space": "rgb"
  },
  {
    "sequence": "3",
    "color": "blue",
    "type": "primary",
    "space": "rgb"
  },
  {
    "sequence": "10",
    "color": "red",
    "type": "secondary",
    "space": "cmyk"
  },
  {
    "sequence": "11",
    "color": "green",
    "type": "secondary",
    "space": "cmyk"
  },
  {
    "sequence": "12",
    "color": "blue",
    "type": "secondary",
    "space": "cmyk"
  }
]
```

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook)

<!-- document id=2c622ee1d257f45a9713b092a019912be1483088ddca85f19350ed85926a9613 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook-remove-certain-xml-attributes.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Remove Specified XML Attributes

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You might want to remove specific attributes from within an XML tag that are known to contain
sensitive data. The DataWeave example defines a function in the DataWeave header that removes a
specific XML attribute from the passed element and its children.

This example uses:

- `mapObject` to go through each element.

- `@` to refer to the attributes in an XML element.

- `if` and `else` to conditionally only list XML attributes when they are present, and also to only
  recursively call the function when a child element is an object.

- `is` to check if each child is of type `Object` .

- `-` to remove an element from the list of XML attributes.

- `inlineCloseOn="empty"` on the output directive, so that the output XML displays self-closing tags
  when there are no values.

If the parent `users` object or child `user` objects within the input contain an attribute with the
key `password`, `removeAttributes` removes that attribute from the object.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml inlineCloseOn="empty"
var removeAttribute = (element,attrName) ->
  element mapObject (value, key) -> {
    // Pass the name of the key of the input object,
    // for example, whether the key is "users" or "user",
    // and use @() to remap the XML attributes.
    (key) @(
        (
          // If the element contains attributes (key.@?),
          // remove any attribute that has the provided key,
          // "password".
          if (key.@?)
            (key.@ - attrName)
          // Otherwise, do nothing.
          else {}
        )
    ) :
    // If the value of the input object contains one or
    // more objects, apply removeAttribute to remove any
    // attribute with the key "password" from those objects.
    if (value is Object)
      removeAttribute(value, attrName)
    // Otherwise, return the value of the input object.
    else value
  }
---
removeAttribute(payload, "password")
```

Input XML Payload:

```xml
<users>
  <user username="Julian" password="1234"/>
  <user username="Mariano" password="4321"/>
</users>
```

Output XML:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<users>
  <user username="Julian"/>
  <user username="Mariano"/>
</users>
```

## Related Examples

- [Output Self-closing XML tags](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-output-self-closing-xml-tags)

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-insert-attribute)

- [Include XML Namespaces](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-include-xml-namespaces)

- [Exclude Fields from the Output](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-exclude-field)

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-output-a-field-when-present)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-conditional-list-reduction-via-function)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.11/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook)

<!-- document id=16c74db1be865ecf7cf96688a0f327c8ac8a7382c5da5d1b8f39d92029d1ab46 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook-remove-certain-xml-attributes.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Remove Specified XML Attributes

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You might want to remove specific attributes from within an XML tag that are known to contain
sensitive data. The DataWeave example defines a function in the DataWeave header that removes a
specific XML attribute from the passed element and its children.

This example uses:

- `mapObject` to go through each element.

- `@` to refer to the attributes in an XML element.

- `if` and `else` to conditionally only list XML attributes when they are present, and also to only
  recursively call the function when a child element is an object.

- `is` to check if each child is of type `Object` .

- `-` to remove an element from the list of XML attributes.

- `inlineCloseOn="empty"` on the output directive, so that the output XML displays self-closing tags
  when there are no values.

If the parent `users` object or child `user` objects within the input contain an attribute with the
key `password`, `removeAttributes` removes that attribute from the object.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml inlineCloseOn="empty"
var removeAttribute = (element,attrName) ->
  element mapObject (value, key) -> {
    // Pass the name of the key of the input object,
    // for example, whether the key is "users" or "user",
    // and use @() to remap the XML attributes.
    (key) @(
        (
          // If the element contains attributes (key.@?),
          // remove any attribute that has the provided key,
          // "password".
          if (key.@?)
            (key.@ - attrName)
          // Otherwise, do nothing.
          else {}
        )
    ) :
    // If the value of the input object contains one or
    // more objects, apply removeAttribute to remove any
    // attribute with the key "password" from those objects.
    if (value is Object)
      removeAttribute(value, attrName)
    // Otherwise, return the value of the input object.
    else value
  }
---
removeAttribute(payload, "password")
```

Input XML Payload:

```xml
<users>
  <user username="Julian" password="1234"/>
  <user username="Mariano" password="4321"/>
</users>
```

Output XML:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<users>
  <user username="Julian"/>
  <user username="Mariano"/>
</users>
```

## Related Examples

- [Output Self-closing XML tags](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-output-self-closing-xml-tags)

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-insert-attribute)

- [Include XML Namespaces](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-include-xml-namespaces)

- [Exclude Fields from the Output](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-exclude-field)

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-output-a-field-when-present)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-conditional-list-reduction-via-function)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.12/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook)

<!-- document id=3e2ad93d1ff4a0cabe00514e831f1f3eddab2dbf59432004d9aad688477b0b1b url=/mulesoft/current/en-us/dataweave/2.3/dataweave-cookbook-remove-certain-xml-attributes.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Remove Specified XML Attributes

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You might want to remove specific attributes from within an XML tag that are known to contain
sensitive data. The DataWeave example defines a function in the DataWeave header that removes a
specific XML attribute from the passed element and its children.

This example uses:

- `mapObject` to go through each element.

- `@` to refer to the attributes in an XML element.

- `if` and `else` to conditionally only list XML attributes when they are present, and also to only
  recursively call the function when a child element is an object.

- `is` to check if each child is of type `Object` .

- `-` to remove an element from the list of XML attributes.

- `inlineCloseOn="empty"` on the output directive, so that the output XML displays self-closing tags
  when there are no values.

If the parent `users` object or child `user` objects within the input contain an attribute with the
key `password`, `removeAttributes` removes that attribute from the object.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml inlineCloseOn="empty"
var removeAttribute = (element,attrName) ->
  element mapObject (value, key) -> {
    // Pass the name of the key of the input object,
    // for example, whether the key is "users" or "user",
    // and use @() to remap the XML attributes.
    (key) @(
        (
          // If the element contains attributes (key.@?),
          // remove any attribute that has the provided key,
          // "password".
          if (key.@?)
            (key.@ - attrName)
          // Otherwise, do nothing.
          else {}
        )
    ) :
    // If the value of the input object contains one or
    // more objects, apply removeAttribute to remove any
    // attribute with the key "password" from those objects.
    if (value is Object)
      removeAttribute(value, attrName)
    // Otherwise, return the value of the input object.
    else value
  }
---
removeAttribute(payload, "password")
```

Input XML Payload:

```xml
<users>
  <user username="Julian" password="1234"/>
  <user username="Mariano" password="4321"/>
</users>
```

Output XML:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<users>
  <user username="Julian"/>
  <user username="Mariano"/>
</users>
```

## Related Examples

- [Output Self-closing XML tags](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-output-self-closing-xml-tags)

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-insert-attribute)

- [Include XML Namespaces](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-include-xml-namespaces)

- [Exclude Fields from the Output](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-exclude-field)

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-output-a-field-when-present)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-conditional-list-reduction-via-function)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.3/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook)

<!-- document id=2c6e4e51bc9710536467398670d15abe421fc66cdcb76c2eef4bbaef6fc039ff url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook-remove-certain-xml-attributes.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Remove Specified XML Attributes

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You might want to remove specific attributes from within an XML tag that are known to contain
sensitive data. The DataWeave example defines a function in the DataWeave header that removes a
specific XML attribute from the passed element and its children.

This example uses:

- `mapObject` to go through each element.

- `@` to refer to the attributes in an XML element.

- `if` and `else` to conditionally only list XML attributes when they are present, and also to only
  recursively call the function when a child element is an object.

- `is` to check if each child is of type `Object` .

- `-` to remove an element from the list of XML attributes.

- `inlineCloseOn="empty"` on the output directive, so that the output XML displays self-closing tags
  when there are no values.

If the parent `users` object or child `user` objects within the input contain an attribute with the
key `password`, `removeAttributes` removes that attribute from the object.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml inlineCloseOn="empty"
var removeAttribute = (element,attrName) ->
  element mapObject (value, key) -> {
    // Pass the name of the key of the input object,
    // for example, whether the key is "users" or "user",
    // and use @() to remap the XML attributes.
    (key) @(
        (
          // If the element contains attributes (key.@?),
          // remove any attribute that has the provided key,
          // "password".
          if (key.@?)
            (key.@ - attrName)
          // Otherwise, do nothing.
          else {}
        )
    ) :
    // If the value of the input object contains one or
    // more objects, apply removeAttribute to remove any
    // attribute with the key "password" from those objects.
    if (value is Object)
      removeAttribute(value, attrName)
    // Otherwise, return the value of the input object.
    else value
  }
---
removeAttribute(payload, "password")
```

Input XML Payload:

```xml
<users>
  <user username="Julian" password="1234"/>
  <user username="Mariano" password="4321"/>
</users>
```

Output XML:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<users>
  <user username="Julian"/>
  <user username="Mariano"/>
</users>
```

## Related Examples

- [Output Self-closing XML tags](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-output-self-closing-xml-tags)

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-insert-attribute)

- [Include XML Namespaces](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-include-xml-namespaces)

- [Exclude Fields from the Output](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-exclude-field)

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-output-a-field-when-present)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-conditional-list-reduction-via-function)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.4/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook)

<!-- document id=d9822a82b41bf5ae1fd54b684409d4e6d88e9e1e6c492824082b7ab14f00b02c url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook-remove-certain-xml-attributes.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Remove Specified XML Attributes

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You might want to remove specific attributes from within an XML tag that are known to contain
sensitive data. The DataWeave example defines a function in the DataWeave header that removes a
specific XML attribute from the passed element and its children.

This example uses:

- `mapObject` to go through each element.

- `@` to refer to the attributes in an XML element.

- `if` and `else` to conditionally only list XML attributes when they are present, and also to only
  recursively call the function when a child element is an object.

- `is` to check if each child is of type `Object` .

- `-` to remove an element from the list of XML attributes.

- `inlineCloseOn="empty"` on the output directive, so that the output XML displays self-closing tags
  when there are no values.

If the parent `users` object or child `user` objects within the input contain an attribute with the
key `password`, `removeAttributes` removes that attribute from the object.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml inlineCloseOn="empty"
var removeAttribute = (element,attrName) ->
  element mapObject (value, key) -> {
    // Pass the name of the key of the input object,
    // for example, whether the key is "users" or "user",
    // and use @() to remap the XML attributes.
    (key) @(
        (
          // If the element contains attributes (key.@?),
          // remove any attribute that has the provided key,
          // "password".
          if (key.@?)
            (key.@ - attrName)
          // Otherwise, do nothing.
          else {}
        )
    ) :
    // If the value of the input object contains one or
    // more objects, apply removeAttribute to remove any
    // attribute with the key "password" from those objects.
    if (value is Object)
      removeAttribute(value, attrName)
    // Otherwise, return the value of the input object.
    else value
  }
---
removeAttribute(payload, "password")
```

Input XML Payload:

```xml
<users>
  <user username="Julian" password="1234"/>
  <user username="Mariano" password="4321"/>
</users>
```

Output XML:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<users>
  <user username="Julian"/>
  <user username="Mariano"/>
</users>
```

## Related Examples

- [Output Self-closing XML tags](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-output-self-closing-xml-tags)

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-insert-attribute)

- [Include XML Namespaces](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-include-xml-namespaces)

- [Exclude Fields from the Output](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-exclude-field)

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-output-a-field-when-present)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-conditional-list-reduction-via-function)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.6/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook)

<!-- document id=4e66a22cde53a774a08ed32eaef10d7cbca5fcfcc4a5b4b089cb78c77e82b5e6 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook-remove-certain-xml-attributes.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Remove Specified XML Attributes

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You might want to remove specific attributes from within an XML tag that are known to contain
sensitive data. The DataWeave example defines a function in the DataWeave header that removes a
specific XML attribute from the passed element and its children.

This example uses:

- `mapObject` to go through each element.

- `@` to refer to the attributes in an XML element.

- `if` and `else` to conditionally only list XML attributes when they are present, and also to only
  recursively call the function when a child element is an object.

- `is` to check if each child is of type `Object` .

- `-` to remove an element from the list of XML attributes.

- `inlineCloseOn="empty"` on the output directive, so that the output XML displays self-closing tags
  when there are no values.

If the parent `users` object or child `user` objects within the input contain an attribute with the
key `password`, `removeAttributes` removes that attribute from the object.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml inlineCloseOn="empty"
var removeAttribute = (element,attrName) ->
  element mapObject (value, key) -> {
    // Pass the name of the key of the input object,
    // for example, whether the key is "users" or "user",
    // and use @() to remap the XML attributes.
    (key) @(
        (
          // If the element contains attributes (key.@?),
          // remove any attribute that has the provided key,
          // "password".
          if (key.@?)
            (key.@ - attrName)
          // Otherwise, do nothing.
          else {}
        )
    ) :
    // If the value of the input object contains one or
    // more objects, apply removeAttribute to remove any
    // attribute with the key "password" from those objects.
    if (value is Object)
      removeAttribute(value, attrName)
    // Otherwise, return the value of the input object.
    else value
  }
---
removeAttribute(payload, "password")
```

Input XML Payload:

```xml
<users>
  <user username="Julian" password="1234"/>
  <user username="Mariano" password="4321"/>
</users>
```

Output XML:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<users>
  <user username="Julian"/>
  <user username="Mariano"/>
</users>
```

## Related Examples

- [Output Self-closing XML tags](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-output-self-closing-xml-tags)

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-insert-attribute)

- [Include XML Namespaces](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-include-xml-namespaces)

- [Exclude Fields from the Output](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-exclude-field)

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-output-a-field-when-present)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-conditional-list-reduction-via-function)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.9/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook)

<!-- document id=77fa7b43fdee711b90d8ae44b36eaa5276b825166df0f3fe92722c11bb3f3bd0 url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook-remove-certain-xml-attributes.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Remove Specified XML Attributes

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You might want to remove specific attributes from within an XML tag that are known to contain
sensitive data. The DataWeave example defines a function in the DataWeave header that removes a
specific XML attribute from the passed element and its children.

This example uses:

- `mapObject` to go through each element.

- `@` to refer to the attributes in an XML element.

- `if` and `else` to conditionally only list XML attributes when they are present, and also to only
  recursively call the function when a child element is an object.

- `is` to check if each child is of type `Object` .

- `-` to remove an element from the list of XML attributes.

- `inlineCloseOn="empty"` on the output directive, so that the output XML displays self-closing tags
  when there are no values.

If the parent `users` object or child `user` objects within the input contain an attribute with the
key `password`, `removeAttributes` removes that attribute from the object.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml inlineCloseOn="empty"
var removeAttribute = (element,attrName) ->
  element mapObject (value, key) -> {
    // Pass the name of the key of the input object,
    // for example, whether the key is "users" or "user",
    // and use @() to remap the XML attributes.
    (key) @(
        (
          // If the element contains attributes (key.@?),
          // remove any attribute that has the provided key,
          // "password".
          if (key.@?)
            (key.@ - attrName)
          // Otherwise, do nothing.
          else {}
        )
    ) :
    // If the value of the input object contains one or
    // more objects, apply removeAttribute to remove any
    // attribute with the key "password" from those objects.
    if (value is Object)
      removeAttribute(value, attrName)
    // Otherwise, return the value of the input object.
    else value
  }
---
removeAttribute(payload, "password")
```

Input XML Payload:

```xml
<users>
  <user username="Julian" password="1234"/>
  <user username="Mariano" password="4321"/>
</users>
```

Output XML:

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<users>
  <user username="Julian"/>
  <user username="Mariano"/>
</users>
```

## Related Examples

- [Output Self-closing XML tags](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-output-self-closing-xml-tags)

- [Insert an Attribute into an XML Tag](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-insert-attribute)

- [Include XML Namespaces](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-include-xml-namespaces)

- [Exclude Fields from the Output](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-exclude-field)

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-output-a-field-when-present)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-conditional-list-reduction-via-function)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook)

<!-- document id=b8c9616b55255205fc3c00a2bd2b67f6de0927138d659e02fd637829f2cc56eb url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook-rename-keys.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Rename JSON Keys

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example renames some keys in a JSON object, while retaining the names of all others
in the output.

The example uses these functions:

- `mapObject` to go through the `key:value` pairs in a JSON object.

- `if` by itself to determine when to change the name of a key.

- `if` with `and` to retain the name of all keys except the two with new names.

- `as` to coerce the type of the keys into a String.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
payload.flights map (flight) -> {
    (flight mapObject (value, key) -> {
        (emptySeats: value) if(key as String == 'availableSeats'),
        (airline: value) if(key as String == 'airlineName'),
        ((key):value) if(key as String !='availableSeats' and key as String != 'airlineName')
    })
}
```

Input JSON Payload:

```json
{
  "flights": [
    {
      "availableSeats": 45,
      "airlineName": "Ryan Air",
      "aircraftBrand": "Boeing",
      "aircraftType": "737",
      "departureDate": "12/14/2017",
      "origin": "BCN",
      "destination": "FCO"
    },
    {
      "availableSeats": 15,
      "airlineName": "Ryan Air",
      "aircraftBrand": "Boeing",
      "aircraftType": "747",
      "departureDate": "08/03/2017",
      "origin": "FCO",
      "destination": "DFW"
    }
  ]
}
```

Output JSON:

```json
[
  {
    "emptySeats": 45,
    "airline": "Ryan Air",
    "aircraftBrand": "Boeing",
    "aircraftType": "737",
    "departureDate": "12/14/2017",
    "origin": "BCN",
    "destination": "FCO"
  },
  {
    "emptySeats": 15,
    "airline": "Ryan Air",
    "aircraftBrand": "Boeing",
    "aircraftType": "747",
    "departureDate": "08/03/2017",
    "origin": "FCO",
    "destination": "DFW"
  }
]
```

A more maintainable way to produce the same output uses DataWeave pattern matching.

The example uses the following functions and statements:

- `mapObject` to go through the `key:value` pairs in a JSON object.

- `match` on each key in the input.

- `case` statements to change the name of matching keys in the input.

- `else` statement to retain the name of keys that do not require a name change.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
fun renameKey(key: Key) = key match {
    case "availableSeats" -> "emptySeats"
    case "airlineName" -> "airline"
    else -> (key)
}
---
payload.flights map (flight) ->
flight mapObject (value, key) -> {
    (renameKey(key)) : value
}
```

Input JSON Payload:

```json
{
  "flights": [
    {
      "availableSeats": 45,
      "airlineName": "Ryan Air",
      "aircraftBrand": "Boeing",
      "aircraftType": "737",
      "departureDate": "12/14/2017",
      "origin": "BCN",
      "destination": "FCO"
    },
    {
      "availableSeats": 15,
      "airlineName": "Ryan Air",
      "aircraftBrand": "Boeing",
      "aircraftType": "747",
      "departureDate": "08/03/2017",
      "origin": "FCO",
      "destination": "DFW"
    }
  ]
}
```

Output JSON:

```json
[
  {
    "emptySeats": 45,
    "airline": "Ryan Air",
    "aircraftBrand": "Boeing",
    "aircraftType": "737",
    "departureDate": "12/14/2017",
    "origin": "BCN",
    "destination": "FCO"
  },
  {
    "emptySeats": 15,
    "airline": "Ryan Air",
    "aircraftBrand": "Boeing",
    "aircraftType": "747",
    "departureDate": "08/03/2017",
    "origin": "FCO",
    "destination": "DFW"
  }
]
```

## Related Examples

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-output-a-field-when-present)

- [Dynamically Map Based on a Definition](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-map-based-on-an-external-definition)

- [Pass Functions as Arguments](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-pass-functions-as-arguments)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.11/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook)

<!-- document id=6c74afb95e7e64651e12ef87e75eac0611812413190f75a90e774bd6c8bc4f5d url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook-rename-keys.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Rename JSON Keys

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example renames some keys in a JSON object, while retaining the names of all others
in the output.

The example uses these functions:

- `mapObject` to go through the `key:value` pairs in a JSON object.

- `if` by itself to determine when to change the name of a key.

- `if` with `and` to retain the name of all keys except the two with new names.

- `as` to coerce the type of the keys into a String.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
payload.flights map (flight) -> {
    (flight mapObject (value, key) -> {
        (emptySeats: value) if(key as String == 'availableSeats'),
        (airline: value) if(key as String == 'airlineName'),
        ((key):value) if(key as String !='availableSeats' and key as String != 'airlineName')
    })
}
```

Input JSON Payload:

```json
{
  "flights": [
    {
      "availableSeats": 45,
      "airlineName": "Ryan Air",
      "aircraftBrand": "Boeing",
      "aircraftType": "737",
      "departureDate": "12/14/2017",
      "origin": "BCN",
      "destination": "FCO"
    },
    {
      "availableSeats": 15,
      "airlineName": "Ryan Air",
      "aircraftBrand": "Boeing",
      "aircraftType": "747",
      "departureDate": "08/03/2017",
      "origin": "FCO",
      "destination": "DFW"
    }
  ]
}
```

Output JSON:

```json
[
  {
    "emptySeats": 45,
    "airline": "Ryan Air",
    "aircraftBrand": "Boeing",
    "aircraftType": "737",
    "departureDate": "12/14/2017",
    "origin": "BCN",
    "destination": "FCO"
  },
  {
    "emptySeats": 15,
    "airline": "Ryan Air",
    "aircraftBrand": "Boeing",
    "aircraftType": "747",
    "departureDate": "08/03/2017",
    "origin": "FCO",
    "destination": "DFW"
  }
]
```

A more maintainable way to produce the same output uses DataWeave pattern matching.

The example uses the following functions and statements:

- `mapObject` to go through the `key:value` pairs in a JSON object.

- `match` on each key in the input.

- `case` statements to change the name of matching keys in the input.

- `else` statement to retain the name of keys that do not require a name change.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
fun renameKey(key: Key) = key match {
    case "availableSeats" -> "emptySeats"
    case "airlineName" -> "airline"
    else -> (key)
}
---
payload.flights map (flight) ->
flight mapObject (value, key) -> {
    (renameKey(key)) : value
}
```

Input JSON Payload:

```json
{
  "flights": [
    {
      "availableSeats": 45,
      "airlineName": "Ryan Air",
      "aircraftBrand": "Boeing",
      "aircraftType": "737",
      "departureDate": "12/14/2017",
      "origin": "BCN",
      "destination": "FCO"
    },
    {
      "availableSeats": 15,
      "airlineName": "Ryan Air",
      "aircraftBrand": "Boeing",
      "aircraftType": "747",
      "departureDate": "08/03/2017",
      "origin": "FCO",
      "destination": "DFW"
    }
  ]
}
```

Output JSON:

```json
[
  {
    "emptySeats": 45,
    "airline": "Ryan Air",
    "aircraftBrand": "Boeing",
    "aircraftType": "737",
    "departureDate": "12/14/2017",
    "origin": "BCN",
    "destination": "FCO"
  },
  {
    "emptySeats": 15,
    "airline": "Ryan Air",
    "aircraftBrand": "Boeing",
    "aircraftType": "747",
    "departureDate": "08/03/2017",
    "origin": "FCO",
    "destination": "DFW"
  }
]
```

## Related Examples

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-output-a-field-when-present)

- [Dynamically Map Based on a Definition](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-map-based-on-an-external-definition)

- [Pass Functions as Arguments](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-pass-functions-as-arguments)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.12/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook)

<!-- document id=97ed00d8c39c5e3b70244301fbff7fee5d7c6491763fbaad60381a63866ecb08 url=/mulesoft/current/en-us/dataweave/2.3/dataweave-cookbook-rename-keys.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Rename JSON Keys

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example renames some keys in a JSON object, while retaining the names of all others
in the output.

The example uses these functions:

- `mapObject` to go through the `key:value` pairs in a JSON object.

- `if` by itself to determine when to change the name of a key.

- `if` with `and` to retain the name of all keys except the two with new names.

- `as` to coerce the type of the keys into a String.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
payload.flights map (flight) -> {
    (flight mapObject (value, key) -> {
        (emptySeats: value) if(key as String == 'availableSeats'),
        (airline: value) if(key as String == 'airlineName'),
        ((key):value) if(key as String !='availableSeats' and key as String != 'airlineName')
    })
}
```

Input JSON Payload:

```json
{
  "flights": [
    {
      "availableSeats": 45,
      "airlineName": "Ryan Air",
      "aircraftBrand": "Boeing",
      "aircraftType": "737",
      "departureDate": "12/14/2017",
      "origin": "BCN",
      "destination": "FCO"
    },
    {
      "availableSeats": 15,
      "airlineName": "Ryan Air",
      "aircraftBrand": "Boeing",
      "aircraftType": "747",
      "departureDate": "08/03/2017",
      "origin": "FCO",
      "destination": "DFW"
    }
  ]
}
```

Output JSON:

```json
[
  {
    "emptySeats": 45,
    "airline": "Ryan Air",
    "aircraftBrand": "Boeing",
    "aircraftType": "737",
    "departureDate": "12/14/2017",
    "origin": "BCN",
    "destination": "FCO"
  },
  {
    "emptySeats": 15,
    "airline": "Ryan Air",
    "aircraftBrand": "Boeing",
    "aircraftType": "747",
    "departureDate": "08/03/2017",
    "origin": "FCO",
    "destination": "DFW"
  }
]
```

A more maintainable way to produce the same output uses DataWeave pattern matching.

The example uses the following functions and statements:

- `mapObject` to go through the `key:value` pairs in a JSON object.

- `match` on each key in the input.

- `case` statements to change the name of matching keys in the input.

- `else` statement to retain the name of keys that do not require a name change.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
fun renameKey(key: Key) = key match {
    case "availableSeats" -> "emptySeats"
    case "airlineName" -> "airline"
    else -> (key)
}
---
payload.flights map (flight) ->
flight mapObject (value, key) -> {
    (renameKey(key)) : value
}
```

Input JSON Payload:

```json
{
  "flights": [
    {
      "availableSeats": 45,
      "airlineName": "Ryan Air",
      "aircraftBrand": "Boeing",
      "aircraftType": "737",
      "departureDate": "12/14/2017",
      "origin": "BCN",
      "destination": "FCO"
    },
    {
      "availableSeats": 15,
      "airlineName": "Ryan Air",
      "aircraftBrand": "Boeing",
      "aircraftType": "747",
      "departureDate": "08/03/2017",
      "origin": "FCO",
      "destination": "DFW"
    }
  ]
}
```

Output JSON:

```json
[
  {
    "emptySeats": 45,
    "airline": "Ryan Air",
    "aircraftBrand": "Boeing",
    "aircraftType": "737",
    "departureDate": "12/14/2017",
    "origin": "BCN",
    "destination": "FCO"
  },
  {
    "emptySeats": 15,
    "airline": "Ryan Air",
    "aircraftBrand": "Boeing",
    "aircraftType": "747",
    "departureDate": "08/03/2017",
    "origin": "FCO",
    "destination": "DFW"
  }
]
```

## Related Examples

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-output-a-field-when-present)

- [Dynamically Map Based on a Definition](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-map-based-on-an-external-definition)

- [Pass Functions as Arguments](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-pass-functions-as-arguments)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.3/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook)

<!-- document id=608bf6f455b22a0ba9217aeddc02ea24ac86a524ee36f9a9a046ebcff7f6ef92 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook-rename-keys.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Rename JSON Keys

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example renames some keys in a JSON object, while retaining the names of all others
in the output.

The example uses these functions:

- `mapObject` to go through the `key:value` pairs in a JSON object.

- `if` by itself to determine when to change the name of a key.

- `if` with `and` to retain the name of all keys except the two with new names.

- `as` to coerce the type of the keys into a String.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
payload.flights map (flight) -> {
    (flight mapObject (value, key) -> {
        (emptySeats: value) if(key as String == 'availableSeats'),
        (airline: value) if(key as String == 'airlineName'),
        ((key):value) if(key as String !='availableSeats' and key as String != 'airlineName')
    })
}
```

Input JSON Payload:

```json
{
  "flights": [
    {
      "availableSeats": 45,
      "airlineName": "Ryan Air",
      "aircraftBrand": "Boeing",
      "aircraftType": "737",
      "departureDate": "12/14/2017",
      "origin": "BCN",
      "destination": "FCO"
    },
    {
      "availableSeats": 15,
      "airlineName": "Ryan Air",
      "aircraftBrand": "Boeing",
      "aircraftType": "747",
      "departureDate": "08/03/2017",
      "origin": "FCO",
      "destination": "DFW"
    }
  ]
}
```

Output JSON:

```json
[
  {
    "emptySeats": 45,
    "airline": "Ryan Air",
    "aircraftBrand": "Boeing",
    "aircraftType": "737",
    "departureDate": "12/14/2017",
    "origin": "BCN",
    "destination": "FCO"
  },
  {
    "emptySeats": 15,
    "airline": "Ryan Air",
    "aircraftBrand": "Boeing",
    "aircraftType": "747",
    "departureDate": "08/03/2017",
    "origin": "FCO",
    "destination": "DFW"
  }
]
```

A more maintainable way to produce the same output uses DataWeave pattern matching.

The example uses the following functions and statements:

- `mapObject` to go through the `key:value` pairs in a JSON object.

- `match` on each key in the input.

- `case` statements to change the name of matching keys in the input.

- `else` statement to retain the name of keys that do not require a name change.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
fun renameKey(key: Key) = key match {
    case "availableSeats" -> "emptySeats"
    case "airlineName" -> "airline"
    else -> (key)
}
---
payload.flights map (flight) ->
flight mapObject (value, key) -> {
    (renameKey(key)) : value
}
```

Input JSON Payload:

```json
{
  "flights": [
    {
      "availableSeats": 45,
      "airlineName": "Ryan Air",
      "aircraftBrand": "Boeing",
      "aircraftType": "737",
      "departureDate": "12/14/2017",
      "origin": "BCN",
      "destination": "FCO"
    },
    {
      "availableSeats": 15,
      "airlineName": "Ryan Air",
      "aircraftBrand": "Boeing",
      "aircraftType": "747",
      "departureDate": "08/03/2017",
      "origin": "FCO",
      "destination": "DFW"
    }
  ]
}
```

Output JSON:

```json
[
  {
    "emptySeats": 45,
    "airline": "Ryan Air",
    "aircraftBrand": "Boeing",
    "aircraftType": "737",
    "departureDate": "12/14/2017",
    "origin": "BCN",
    "destination": "FCO"
  },
  {
    "emptySeats": 15,
    "airline": "Ryan Air",
    "aircraftBrand": "Boeing",
    "aircraftType": "747",
    "departureDate": "08/03/2017",
    "origin": "FCO",
    "destination": "DFW"
  }
]
```

## Related Examples

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-output-a-field-when-present)

- [Dynamically Map Based on a Definition](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-map-based-on-an-external-definition)

- [Pass Functions as Arguments](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-pass-functions-as-arguments)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.4/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook)

<!-- document id=a8a18aac4e25a3a6c545e2b319ecbdd1892c3de95e4b3a68e937324943cdbedf url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook-rename-keys.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Rename JSON Keys

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example renames some keys in a JSON object, while retaining the names of all others
in the output.

The example uses these functions:

- `mapObject` to go through the `key:value` pairs in a JSON object.

- `if` by itself to determine when to change the name of a key.

- `if` with `and` to retain the name of all keys except the two with new names.

- `as` to coerce the type of the keys into a String.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
payload.flights map (flight) -> {
    (flight mapObject (value, key) -> {
        (emptySeats: value) if(key as String == 'availableSeats'),
        (airline: value) if(key as String == 'airlineName'),
        ((key):value) if(key as String !='availableSeats' and key as String != 'airlineName')
    })
}
```

Input JSON Payload:

```json
{
  "flights": [
    {
      "availableSeats": 45,
      "airlineName": "Ryan Air",
      "aircraftBrand": "Boeing",
      "aircraftType": "737",
      "departureDate": "12/14/2017",
      "origin": "BCN",
      "destination": "FCO"
    },
    {
      "availableSeats": 15,
      "airlineName": "Ryan Air",
      "aircraftBrand": "Boeing",
      "aircraftType": "747",
      "departureDate": "08/03/2017",
      "origin": "FCO",
      "destination": "DFW"
    }
  ]
}
```

Output JSON:

```json
[
  {
    "emptySeats": 45,
    "airline": "Ryan Air",
    "aircraftBrand": "Boeing",
    "aircraftType": "737",
    "departureDate": "12/14/2017",
    "origin": "BCN",
    "destination": "FCO"
  },
  {
    "emptySeats": 15,
    "airline": "Ryan Air",
    "aircraftBrand": "Boeing",
    "aircraftType": "747",
    "departureDate": "08/03/2017",
    "origin": "FCO",
    "destination": "DFW"
  }
]
```

A more maintainable way to produce the same output uses DataWeave pattern matching.

The example uses the following functions and statements:

- `mapObject` to go through the `key:value` pairs in a JSON object.

- `match` on each key in the input.

- `case` statements to change the name of matching keys in the input.

- `else` statement to retain the name of keys that do not require a name change.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
fun renameKey(key: Key) = key match {
    case "availableSeats" -> "emptySeats"
    case "airlineName" -> "airline"
    else -> (key)
}
---
payload.flights map (flight) ->
flight mapObject (value, key) -> {
    (renameKey(key)) : value
}
```

Input JSON Payload:

```json
{
  "flights": [
    {
      "availableSeats": 45,
      "airlineName": "Ryan Air",
      "aircraftBrand": "Boeing",
      "aircraftType": "737",
      "departureDate": "12/14/2017",
      "origin": "BCN",
      "destination": "FCO"
    },
    {
      "availableSeats": 15,
      "airlineName": "Ryan Air",
      "aircraftBrand": "Boeing",
      "aircraftType": "747",
      "departureDate": "08/03/2017",
      "origin": "FCO",
      "destination": "DFW"
    }
  ]
}
```

Output JSON:

```json
[
  {
    "emptySeats": 45,
    "airline": "Ryan Air",
    "aircraftBrand": "Boeing",
    "aircraftType": "737",
    "departureDate": "12/14/2017",
    "origin": "BCN",
    "destination": "FCO"
  },
  {
    "emptySeats": 15,
    "airline": "Ryan Air",
    "aircraftBrand": "Boeing",
    "aircraftType": "747",
    "departureDate": "08/03/2017",
    "origin": "FCO",
    "destination": "DFW"
  }
]
```

## Related Examples

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-output-a-field-when-present)

- [Dynamically Map Based on a Definition](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-map-based-on-an-external-definition)

- [Pass Functions as Arguments](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-pass-functions-as-arguments)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.6/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook)

<!-- document id=027b315fe8768187cdf1519a4ac695e1eea2a0c888ca6500b587f5d809256643 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook-rename-keys.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Rename JSON Keys

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example renames some keys in a JSON object, while retaining the names of all others
in the output.

The example uses these functions:

- `mapObject` to go through the `key:value` pairs in a JSON object.

- `if` by itself to determine when to change the name of a key.

- `if` with `and` to retain the name of all keys except the two with new names.

- `as` to coerce the type of the keys into a String.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
payload.flights map (flight) -> {
    (flight mapObject (value, key) -> {
        (emptySeats: value) if(key as String == 'availableSeats'),
        (airline: value) if(key as String == 'airlineName'),
        ((key):value) if(key as String !='availableSeats' and key as String != 'airlineName')
    })
}
```

Input JSON Payload:

```json
{
  "flights": [
    {
      "availableSeats": 45,
      "airlineName": "Ryan Air",
      "aircraftBrand": "Boeing",
      "aircraftType": "737",
      "departureDate": "12/14/2017",
      "origin": "BCN",
      "destination": "FCO"
    },
    {
      "availableSeats": 15,
      "airlineName": "Ryan Air",
      "aircraftBrand": "Boeing",
      "aircraftType": "747",
      "departureDate": "08/03/2017",
      "origin": "FCO",
      "destination": "DFW"
    }
  ]
}
```

Output JSON:

```json
[
  {
    "emptySeats": 45,
    "airline": "Ryan Air",
    "aircraftBrand": "Boeing",
    "aircraftType": "737",
    "departureDate": "12/14/2017",
    "origin": "BCN",
    "destination": "FCO"
  },
  {
    "emptySeats": 15,
    "airline": "Ryan Air",
    "aircraftBrand": "Boeing",
    "aircraftType": "747",
    "departureDate": "08/03/2017",
    "origin": "FCO",
    "destination": "DFW"
  }
]
```

A more maintainable way to produce the same output uses DataWeave pattern matching.

The example uses the following functions and statements:

- `mapObject` to go through the `key:value` pairs in a JSON object.

- `match` on each key in the input.

- `case` statements to change the name of matching keys in the input.

- `else` statement to retain the name of keys that do not require a name change.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
fun renameKey(key: Key) = key match {
    case "availableSeats" -> "emptySeats"
    case "airlineName" -> "airline"
    else -> (key)
}
---
payload.flights map (flight) ->
flight mapObject (value, key) -> {
    (renameKey(key)) : value
}
```

Input JSON Payload:

```json
{
  "flights": [
    {
      "availableSeats": 45,
      "airlineName": "Ryan Air",
      "aircraftBrand": "Boeing",
      "aircraftType": "737",
      "departureDate": "12/14/2017",
      "origin": "BCN",
      "destination": "FCO"
    },
    {
      "availableSeats": 15,
      "airlineName": "Ryan Air",
      "aircraftBrand": "Boeing",
      "aircraftType": "747",
      "departureDate": "08/03/2017",
      "origin": "FCO",
      "destination": "DFW"
    }
  ]
}
```

Output JSON:

```json
[
  {
    "emptySeats": 45,
    "airline": "Ryan Air",
    "aircraftBrand": "Boeing",
    "aircraftType": "737",
    "departureDate": "12/14/2017",
    "origin": "BCN",
    "destination": "FCO"
  },
  {
    "emptySeats": 15,
    "airline": "Ryan Air",
    "aircraftBrand": "Boeing",
    "aircraftType": "747",
    "departureDate": "08/03/2017",
    "origin": "FCO",
    "destination": "DFW"
  }
]
```

## Related Examples

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-output-a-field-when-present)

- [Dynamically Map Based on a Definition](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-map-based-on-an-external-definition)

- [Pass Functions as Arguments](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-pass-functions-as-arguments)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.9/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook)

<!-- document id=1309f6e11a5247dd794090a0d2fa1322d091aeceba24e60ccf49f5b364b5f0ba url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook-rename-keys.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Rename JSON Keys

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example renames some keys in a JSON object, while retaining the names of all others
in the output.

The example uses these functions:

- `mapObject` to go through the `key:value` pairs in a JSON object.

- `if` by itself to determine when to change the name of a key.

- `if` with `and` to retain the name of all keys except the two with new names.

- `as` to coerce the type of the keys into a String.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
payload.flights map (flight) -> {
    (flight mapObject (value, key) -> {
        (emptySeats: value) if(key as String == 'availableSeats'),
        (airline: value) if(key as String == 'airlineName'),
        ((key):value) if(key as String !='availableSeats' and key as String != 'airlineName')
    })
}
```

Input JSON Payload:

```json
{
  "flights": [
    {
      "availableSeats": 45,
      "airlineName": "Ryan Air",
      "aircraftBrand": "Boeing",
      "aircraftType": "737",
      "departureDate": "12/14/2017",
      "origin": "BCN",
      "destination": "FCO"
    },
    {
      "availableSeats": 15,
      "airlineName": "Ryan Air",
      "aircraftBrand": "Boeing",
      "aircraftType": "747",
      "departureDate": "08/03/2017",
      "origin": "FCO",
      "destination": "DFW"
    }
  ]
}
```

Output JSON:

```json
[
  {
    "emptySeats": 45,
    "airline": "Ryan Air",
    "aircraftBrand": "Boeing",
    "aircraftType": "737",
    "departureDate": "12/14/2017",
    "origin": "BCN",
    "destination": "FCO"
  },
  {
    "emptySeats": 15,
    "airline": "Ryan Air",
    "aircraftBrand": "Boeing",
    "aircraftType": "747",
    "departureDate": "08/03/2017",
    "origin": "FCO",
    "destination": "DFW"
  }
]
```

A more maintainable way to produce the same output uses DataWeave pattern matching.

The example uses the following functions and statements:

- `mapObject` to go through the `key:value` pairs in a JSON object.

- `match` on each key in the input.

- `case` statements to change the name of matching keys in the input.

- `else` statement to retain the name of keys that do not require a name change.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
fun renameKey(key: Key) = key match {
    case "availableSeats" -> "emptySeats"
    case "airlineName" -> "airline"
    else -> (key)
}
---
payload.flights map (flight) ->
flight mapObject (value, key) -> {
    (renameKey(key)) : value
}
```

Input JSON Payload:

```json
{
  "flights": [
    {
      "availableSeats": 45,
      "airlineName": "Ryan Air",
      "aircraftBrand": "Boeing",
      "aircraftType": "737",
      "departureDate": "12/14/2017",
      "origin": "BCN",
      "destination": "FCO"
    },
    {
      "availableSeats": 15,
      "airlineName": "Ryan Air",
      "aircraftBrand": "Boeing",
      "aircraftType": "747",
      "departureDate": "08/03/2017",
      "origin": "FCO",
      "destination": "DFW"
    }
  ]
}
```

Output JSON:

```json
[
  {
    "emptySeats": 45,
    "airline": "Ryan Air",
    "aircraftBrand": "Boeing",
    "aircraftType": "737",
    "departureDate": "12/14/2017",
    "origin": "BCN",
    "destination": "FCO"
  },
  {
    "emptySeats": 15,
    "airline": "Ryan Air",
    "aircraftBrand": "Boeing",
    "aircraftType": "747",
    "departureDate": "08/03/2017",
    "origin": "FCO",
    "destination": "DFW"
  }
]
```

## Related Examples

- [Output a Field When Present](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-output-a-field-when-present)

- [Dynamically Map Based on a Definition](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-map-based-on-an-external-definition)

- [Pass Functions as Arguments](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-pass-functions-as-arguments)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook)

<!-- document id=8c3334e29a67ba8a3f99f18875354830273bfaba8d891caec85001a7c4800d9d url=/mulesoft/current/en-us/dataweave/2.11/dw-strings-functions-repeat.md -->

---
product: DataWeave
version: 2.11
---

# repeat

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## repeat(text: String, times: Number): String

Repeats a `text` the number of specified `times`.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>times</code></p></td><td><p>Number of times to repeat char. Negative is treated as zero.</p></td></tr></tbody></table>

### Example

This example shows how `repeat` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": repeat("e", 0),
  "b": repeat("e", 3),
  "c": repeat("e", -2)
}
```

#### Output

```JSON
{
  "a": "",
  "b": "eee",
  "c": ""
}
```

## repeat(text: Null, times: Any): Null

Helper function that enables `repeat` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=fa5ac496b058319b0ed74151c0e28cc4c040cd425f55b6c23d273638a6b9169b url=/mulesoft/current/en-us/dataweave/2.12/dw-strings-functions-repeat.md -->

---
product: DataWeave
version: 2.12
---

# repeat

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## repeat(text: String, times: Number): String

Repeats a `text` the number of specified `times`.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>times</code></p></td><td><p>Number of times to repeat char. Negative is treated as zero.</p></td></tr></tbody></table>

### Example

This example shows how `repeat` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": repeat("e", 0),
  "b": repeat("e", 3),
  "c": repeat("e", -2)
}
```

#### Output

```JSON
{
  "a": "",
  "b": "eee",
  "c": ""
}
```

## repeat(text: Null, times: Any): Null

Helper function that enables `repeat` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=640295de59d3bf61fca3f75ff7c1862299a9d03e0e180e0e150367eb5bd326b4 url=/mulesoft/current/en-us/dataweave/2.3/dw-strings-functions-repeat.md -->

---
product: DataWeave
version: 2.3
---

# repeat

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## repeat(String, Number): String

Repeats a `text` the number of specified `times`.

_Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>times</code></p></td><td><p>Number of times to repeat char. Negative is treated as zero.</p></td></tr></tbody></table>

### Example

This example shows how `repeat` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": repeat("e", 0),
  "b": repeat("e", 3),
  "c": repeat("e", -2)
}
```

#### Output

```JSON
{
  "a": "",
  "b": "eee",
  "c": ""
}
```

<!-- document id=ff6d547c398b582c32bf84282022a5bd72341a6236025a110833933f4f52f8a7 url=/mulesoft/current/en-us/dataweave/2.4/dw-strings-functions-repeat.md -->

---
product: DataWeave
version: 2.4
---

# repeat

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## repeat(text: String, times: Number): String

Repeats a `text` the number of specified `times`.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>times</code></p></td><td><p>Number of times to repeat char. Negative is treated as zero.</p></td></tr></tbody></table>

### Example

This example shows how `repeat` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": repeat("e", 0),
  "b": repeat("e", 3),
  "c": repeat("e", -2)
}
```

#### Output

```JSON
{
  "a": "",
  "b": "eee",
  "c": ""
}
```

## repeat(text: Null, times: Any): Null

Helper function that enables `repeat` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=91c30f47145694582dbc3f43eaabf3a2752974f017873f6e3ab5d97d51cbb452 url=/mulesoft/current/en-us/dataweave/2.6/dw-strings-functions-repeat.md -->

---
product: DataWeave
version: 2.6
---

# repeat

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## repeat(text: String, times: Number): String

Repeats a `text` the number of specified `times`.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>times</code></p></td><td><p>Number of times to repeat char. Negative is treated as zero.</p></td></tr></tbody></table>

### Example

This example shows how `repeat` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": repeat("e", 0),
  "b": repeat("e", 3),
  "c": repeat("e", -2)
}
```

#### Output

```JSON
{
  "a": "",
  "b": "eee",
  "c": ""
}
```

## repeat(text: Null, times: Any): Null

Helper function that enables `repeat` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=b104e84e3faf6a30f16333097adf496053a96e845a819836bb1ea075f13e317d url=/mulesoft/current/en-us/dataweave/2.9/dw-strings-functions-repeat.md -->

---
product: DataWeave
version: 2.9
---

# repeat

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## repeat(text: String, times: Number): String

Repeats a `text` the number of specified `times`.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>times</code></p></td><td><p>Number of times to repeat char. Negative is treated as zero.</p></td></tr></tbody></table>

### Example

This example shows how `repeat` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": repeat("e", 0),
  "b": repeat("e", 3),
  "c": repeat("e", -2)
}
```

#### Output

```JSON
{
  "a": "",
  "b": "eee",
  "c": ""
}
```

## repeat(text: Null, times: Any): Null

Helper function that enables `repeat` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=c2fd45750d427961fe006cd82750ae389bb9a476a71a716d2253db71d25868bc url=/mulesoft/current/en-us/dataweave/latest/dw-strings-functions-repeat.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# repeat

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## repeat(text: String, times: Number): String

Repeats a `text` the number of specified `times`.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>times</code></p></td><td><p>Number of times to repeat char. Negative is treated as zero.</p></td></tr></tbody></table>

### Example

This example shows how `repeat` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": repeat("e", 0),
  "b": repeat("e", 3),
  "c": repeat("e", -2)
}
```

#### Output

```JSON
{
  "a": "",
  "b": "eee",
  "c": ""
}
```

## repeat(text: Null, times: Any): Null

Helper function that enables `repeat` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=da178c1675c01e9059946ae569077764bc97e592ec1f440ae7239f01b1f991e7 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-replace.md -->

---
product: DataWeave
version: 2.11
---

# replace

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## replace(text: String, matcher: Regex): ((Array<String>, Number) -> String) -> String

Performs string replacement.

This version of `replace` accepts a Java regular expression for matching part of a string. It
requires the use of the `with` helper function to specify a replacement string for the matching part
of the input string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>A string to match.</p></td></tr><tr><td><p><code>matcher</code></p></td><td><p>A Java regular expression for matching characters in the input <code>text</code> string.</p></td></tr></tbody></table>

### Example

The first example in the source replaces all characters up to and including the second hyphen
(`123-456-`) with an empty value, so it returns the last four digits. The second replaces the
characters `b13e` in the input string with a hyphen (`-`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
["123-456-7890" replace /.*-/ with(""), "abc123def" replace /[b13e]/ with("-")]
```

#### Output

```JSON
[ 7890, "a-c-2-d-f" ]
```

### Example

This example replaces the numbers `123` in the input strings with `ID`. It uses the regular
expression `(\d+)`, where the `\d` metacharacter means any digit from 0-9, and
`` ` means that the digit can occur one or more times. Without the ` ``, the output would contain
one `ID` per digit. The example also shows how to write the expression using infix notation, then
using prefix notation.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ "my123" replace /(\d+)/ with("ID"), replace("myOther123", /(\d+)/) with("ID") ]
```

#### Output

```JSON
[ "myID", "myOtherID" ]
```

## replace(text: String, matcher: String): ((Array<String>, Number) -> String) -> String

Performs string replacement.

This version of `replace` accepts a string that matches part of a specified string. It requires the
use of the `with` helper function to pass in a replacement string for the matching part of the input
string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to match.</p></td></tr><tr><td><p><code>matcher</code></p></td><td><p>The string for matching characters in the input <code>text</code> string.</p></td></tr></tbody></table>

### Example

This example replaces the numbers `123` from the input string with the characters `ID`, which are
passed through the `with` function.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "replace": "admin123" replace "123" with("ID") }
```

#### Output

```JSON
{ "replace": "adminID" }
```

## replace(text: Null, matcher: Any): ((Nothing, Nothing) -> Any) -> Null

Helper function that enables `replace` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=8f554d6714836a649f72fcc1fe5fb807b392ab0ee1e2d8f0d7717db8f761964a url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-replace.md -->

---
product: DataWeave
version: 2.12
---

# replace

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## replace(text: String, matcher: Regex): ((Array<String>, Number) -> String) -> String

Performs string replacement.

This version of `replace` accepts a Java regular expression for matching part of a string. It
requires the use of the `with` helper function to specify a replacement string for the matching part
of the input string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>A string to match.</p></td></tr><tr><td><p><code>matcher</code></p></td><td><p>A Java regular expression for matching characters in the input <code>text</code> string.</p></td></tr></tbody></table>

### Example

The first example in the source replaces all characters up to and including the second hyphen
(`123-456-`) with an empty value, so it returns the last four digits. The second replaces the
characters `b13e` in the input string with a hyphen (`-`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
["123-456-7890" replace /.*-/ with(""), "abc123def" replace /[b13e]/ with("-")]
```

#### Output

```JSON
[ 7890, "a-c-2-d-f" ]
```

### Example

This example replaces the numbers `123` in the input strings with `ID`. It uses the regular
expression `(\d+)`, where the `\d` metacharacter means any digit from 0-9, and
`` ` means that the digit can occur one or more times. Without the ` ``, the output would contain
one `ID` per digit. The example also shows how to write the expression using infix notation, then
using prefix notation.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ "my123" replace /(\d+)/ with("ID"), replace("myOther123", /(\d+)/) with("ID") ]
```

#### Output

```JSON
[ "myID", "myOtherID" ]
```

## replace(text: String, matcher: String): ((Array<String>, Number) -> String) -> String

Performs string replacement.

This version of `replace` accepts a string that matches part of a specified string. It requires the
use of the `with` helper function to pass in a replacement string for the matching part of the input
string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to match.</p></td></tr><tr><td><p><code>matcher</code></p></td><td><p>The string for matching characters in the input <code>text</code> string.</p></td></tr></tbody></table>

### Example

This example replaces the numbers `123` from the input string with the characters `ID`, which are
passed through the `with` function.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "replace": "admin123" replace "123" with("ID") }
```

#### Output

```JSON
{ "replace": "adminID" }
```

## replace(text: Null, matcher: Any): ((Nothing, Nothing) -> Any) -> Null

Helper function that enables `replace` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=b79699499d7fb133acec7cdb1687723007975765a0f8de0a21f885224b677ee5 url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-replace.md -->

---
product: DataWeave
version: 2.3
---

# replace

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## replace(String, Regex): ((Array<String>, Number) -> String) -> String

Performs string replacement.

This version of `replace` accepts a Java regular expression for matching part of a string. It
requires the use of the `with` helper function to specify a replacement string for the matching part
of the input string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>A string to match.</p></td></tr><tr><td><p><code>matcher</code></p></td><td><p>A Java regular expression for matching characters in the input <code>text</code> string.</p></td></tr></tbody></table>

### Example

The first example in the source replaces all characters up to and including the second hyphen
(`123-456-`) with an empty value, so it returns the last four digits. The second replaces the
characters `b13e` in the input string with a hyphen (`-`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
["123-456-7890" replace /.*-/ with(""), "abc123def" replace /[b13e]/ with("-")]
```

#### Output

```JSON
[ 7890, "a-c-2-d-f" ]
```

### Example

This example replaces the numbers `123` in the input strings with `ID`. It uses the regular
expression `(\d+)`, where the `\d` metacharacter means any digit from 0-9, and
`` ` means that the digit can occur one or more times. Without the ` ``, the output would contain
one `ID` per digit. The example also shows how to write the expression using infix notation, then
using prefix notation.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ "my123" replace /(\d+)/ with("ID"), replace("myOther123", /(\d+)/) with("ID") ]
```

#### Output

```JSON
[ "myID", "myOtherID" ]
```

## replace(String, String): ((Array<String>, Number) -> String) -> String

Performs string replacement.

This version of `replace` accepts a string that matches part of a specified string. It requires the
use of the `with` helper function to pass in a replacement string for the matching part of the input
string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to match.</p></td></tr><tr><td><p><code>matcher</code></p></td><td><p>The string for matching characters in the input <code>text</code> string.</p></td></tr></tbody></table>

### Example

This example replaces the numbers `123` from the input string with the characters `ID`, which are
passed through the `with` function.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "replace": "admin123" replace "123" with("ID") }
```

#### Output

```JSON
{ "replace": "adminID" }
```

<!-- document id=9b5231d047ca2d597a1cedd484aea99d2821b90580d150773aa9df7199f1a8cc url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-replace.md -->

---
product: DataWeave
version: 2.4
---

# replace

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## replace(text: String, matcher: Regex): ((Array<String>, Number) -> String) -> String

Performs string replacement.

This version of `replace` accepts a Java regular expression for matching part of a string. It
requires the use of the `with` helper function to specify a replacement string for the matching part
of the input string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>A string to match.</p></td></tr><tr><td><p><code>matcher</code></p></td><td><p>A Java regular expression for matching characters in the input <code>text</code> string.</p></td></tr></tbody></table>

### Example

The first example in the source replaces all characters up to and including the second hyphen
(`123-456-`) with an empty value, so it returns the last four digits. The second replaces the
characters `b13e` in the input string with a hyphen (`-`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
["123-456-7890" replace /.*-/ with(""), "abc123def" replace /[b13e]/ with("-")]
```

#### Output

```JSON
[ 7890, "a-c-2-d-f" ]
```

### Example

This example replaces the numbers `123` in the input strings with `ID`. It uses the regular
expression `(\d+)`, where the `\d` metacharacter means any digit from 0-9, and
`` ` means that the digit can occur one or more times. Without the ` ``, the output would contain
one `ID` per digit. The example also shows how to write the expression using infix notation, then
using prefix notation.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ "my123" replace /(\d+)/ with("ID"), replace("myOther123", /(\d+)/) with("ID") ]
```

#### Output

```JSON
[ "myID", "myOtherID" ]
```

## replace(text: String, matcher: String): ((Array<String>, Number) -> String) -> String

Performs string replacement.

This version of `replace` accepts a string that matches part of a specified string. It requires the
use of the `with` helper function to pass in a replacement string for the matching part of the input
string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to match.</p></td></tr><tr><td><p><code>matcher</code></p></td><td><p>The string for matching characters in the input <code>text</code> string.</p></td></tr></tbody></table>

### Example

This example replaces the numbers `123` from the input string with the characters `ID`, which are
passed through the `with` function.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "replace": "admin123" replace "123" with("ID") }
```

#### Output

```JSON
{ "replace": "adminID" }
```

## replace(text: Null, matcher: Any): ((Nothing, Nothing) -> Any) -> Null

Helper function that enables `replace` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=c9ca6c70a6be2a0ee35fcff688957ea54a8e05f6d5bfc605c89ee4e5e84dc605 url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-replace.md -->

---
product: DataWeave
version: 2.6
---

# replace

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## replace(text: String, matcher: Regex): ((Array<String>, Number) -> String) -> String

Performs string replacement.

This version of `replace` accepts a Java regular expression for matching part of a string. It
requires the use of the `with` helper function to specify a replacement string for the matching part
of the input string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>A string to match.</p></td></tr><tr><td><p><code>matcher</code></p></td><td><p>A Java regular expression for matching characters in the input <code>text</code> string.</p></td></tr></tbody></table>

### Example

The first example in the source replaces all characters up to and including the second hyphen
(`123-456-`) with an empty value, so it returns the last four digits. The second replaces the
characters `b13e` in the input string with a hyphen (`-`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
["123-456-7890" replace /.*-/ with(""), "abc123def" replace /[b13e]/ with("-")]
```

#### Output

```JSON
[ 7890, "a-c-2-d-f" ]
```

### Example

This example replaces the numbers `123` in the input strings with `ID`. It uses the regular
expression `(\d+)`, where the `\d` metacharacter means any digit from 0-9, and
`` ` means that the digit can occur one or more times. Without the ` ``, the output would contain
one `ID` per digit. The example also shows how to write the expression using infix notation, then
using prefix notation.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ "my123" replace /(\d+)/ with("ID"), replace("myOther123", /(\d+)/) with("ID") ]
```

#### Output

```JSON
[ "myID", "myOtherID" ]
```

## replace(text: String, matcher: String): ((Array<String>, Number) -> String) -> String

Performs string replacement.

This version of `replace` accepts a string that matches part of a specified string. It requires the
use of the `with` helper function to pass in a replacement string for the matching part of the input
string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to match.</p></td></tr><tr><td><p><code>matcher</code></p></td><td><p>The string for matching characters in the input <code>text</code> string.</p></td></tr></tbody></table>

### Example

This example replaces the numbers `123` from the input string with the characters `ID`, which are
passed through the `with` function.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "replace": "admin123" replace "123" with("ID") }
```

#### Output

```JSON
{ "replace": "adminID" }
```

## replace(text: Null, matcher: Any): ((Nothing, Nothing) -> Any) -> Null

Helper function that enables `replace` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=6dde88864370abf0602516b7067d1b63ca890c4b0c78177347b8897c066e116d url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-replace.md -->

---
product: DataWeave
version: 2.9
---

# replace

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## replace(text: String, matcher: Regex): ((Array<String>, Number) -> String) -> String

Performs string replacement.

This version of `replace` accepts a Java regular expression for matching part of a string. It
requires the use of the `with` helper function to specify a replacement string for the matching part
of the input string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>A string to match.</p></td></tr><tr><td><p><code>matcher</code></p></td><td><p>A Java regular expression for matching characters in the input <code>text</code> string.</p></td></tr></tbody></table>

### Example

The first example in the source replaces all characters up to and including the second hyphen
(`123-456-`) with an empty value, so it returns the last four digits. The second replaces the
characters `b13e` in the input string with a hyphen (`-`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
["123-456-7890" replace /.*-/ with(""), "abc123def" replace /[b13e]/ with("-")]
```

#### Output

```JSON
[ 7890, "a-c-2-d-f" ]
```

### Example

This example replaces the numbers `123` in the input strings with `ID`. It uses the regular
expression `(\d+)`, where the `\d` metacharacter means any digit from 0-9, and
`` ` means that the digit can occur one or more times. Without the ` ``, the output would contain
one `ID` per digit. The example also shows how to write the expression using infix notation, then
using prefix notation.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ "my123" replace /(\d+)/ with("ID"), replace("myOther123", /(\d+)/) with("ID") ]
```

#### Output

```JSON
[ "myID", "myOtherID" ]
```

## replace(text: String, matcher: String): ((Array<String>, Number) -> String) -> String

Performs string replacement.

This version of `replace` accepts a string that matches part of a specified string. It requires the
use of the `with` helper function to pass in a replacement string for the matching part of the input
string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to match.</p></td></tr><tr><td><p><code>matcher</code></p></td><td><p>The string for matching characters in the input <code>text</code> string.</p></td></tr></tbody></table>

### Example

This example replaces the numbers `123` from the input string with the characters `ID`, which are
passed through the `with` function.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "replace": "admin123" replace "123" with("ID") }
```

#### Output

```JSON
{ "replace": "adminID" }
```

## replace(text: Null, matcher: Any): ((Nothing, Nothing) -> Any) -> Null

Helper function that enables `replace` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=659e0f7d380efae1b2809f7181b1b230cd3506a1e74bdaea13a57ec34f3c27fa url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-replace.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# replace

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## replace(text: String, matcher: Regex): ((Array<String>, Number) -> String) -> String

Performs string replacement.

This version of `replace` accepts a Java regular expression for matching part of a string. It
requires the use of the `with` helper function to specify a replacement string for the matching part
of the input string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>A string to match.</p></td></tr><tr><td><p><code>matcher</code></p></td><td><p>A Java regular expression for matching characters in the input <code>text</code> string.</p></td></tr></tbody></table>

### Example

The first example in the source replaces all characters up to and including the second hyphen
(`123-456-`) with an empty value, so it returns the last four digits. The second replaces the
characters `b13e` in the input string with a hyphen (`-`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
["123-456-7890" replace /.*-/ with(""), "abc123def" replace /[b13e]/ with("-")]
```

#### Output

```JSON
[ 7890, "a-c-2-d-f" ]
```

### Example

This example replaces the numbers `123` in the input strings with `ID`. It uses the regular
expression `(\d+)`, where the `\d` metacharacter means any digit from 0-9, and
`` ` means that the digit can occur one or more times. Without the ` ``, the output would contain
one `ID` per digit. The example also shows how to write the expression using infix notation, then
using prefix notation.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ "my123" replace /(\d+)/ with("ID"), replace("myOther123", /(\d+)/) with("ID") ]
```

#### Output

```JSON
[ "myID", "myOtherID" ]
```

## replace(text: String, matcher: String): ((Array<String>, Number) -> String) -> String

Performs string replacement.

This version of `replace` accepts a string that matches part of a specified string. It requires the
use of the `with` helper function to pass in a replacement string for the matching part of the input
string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to match.</p></td></tr><tr><td><p><code>matcher</code></p></td><td><p>The string for matching characters in the input <code>text</code> string.</p></td></tr></tbody></table>

### Example

This example replaces the numbers `123` from the input string with the characters `ID`, which are
passed through the `with` function.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "replace": "admin123" replace "123" with("ID") }
```

#### Output

```JSON
{ "replace": "adminID" }
```

## replace(text: Null, matcher: Any): ((Nothing, Nothing) -> Any) -> Null

Helper function that enables `replace` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=473d59cf80a3c6f4ab4e59e3eaf8281e565efe197ee57db62c68940bb47b64bc url=/mulesoft/current/en-us/dataweave/2.11/dw-strings-functions-replaceall.md -->

---
product: DataWeave
version: 2.11
---

# replaceAll

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## replaceAll(text: String, target: String, replacement: String): String

Replaces all substrings that match a literal search string with a specified replacement string.

Replacement proceeds from the beginning of the string to the end. For example, the result of
replacing `"aa"` with `"b"` in the string\` `"aaa"` is `"ba"`, rather than `"ab"`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to search.</p></td></tr><tr><td><p><code>target</code></p></td><td><p>The string to find and replace in <code>text</code>.</p></td></tr><tr><td><p><code>replacement</code></p></td><td><p>The replacement string.</p></td></tr></tbody></table>

### Example

This example shows how `replaceAll` behaves with different inputs.

#### Source

```DataWeave
import * from dw::core::Strings
output application/json
---
{
    a: replaceAll("Mariano", "a" , "A"),
    b: replaceAll("AAAA", "AAA" , "B"),
    c: replaceAll(null, "aria" , "A"),
    d: replaceAll("Mariano", "j" , "Test"),
}
```

#### Output

```Json
{
   "a": "MAriAno",
   "b": "BA",
   "c": null,
   "d": "Mariano"
 }
```

## replaceAll(text: Null, oldValue: String, newValue: String): Null

Helper function that enables `replaceAll` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=44a316c992ca4bce035de8f378a2521332d846a6f823eacfd524b1ae13eeb872 url=/mulesoft/current/en-us/dataweave/2.12/dw-strings-functions-replaceall.md -->

---
product: DataWeave
version: 2.12
---

# replaceAll

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## replaceAll(text: String, target: String, replacement: String): String

Replaces all substrings that match a literal search string with a specified replacement string.

Replacement proceeds from the beginning of the string to the end. For example, the result of
replacing `"aa"` with `"b"` in the string\` `"aaa"` is `"ba"`, rather than `"ab"`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to search.</p></td></tr><tr><td><p><code>target</code></p></td><td><p>The string to find and replace in <code>text</code>.</p></td></tr><tr><td><p><code>replacement</code></p></td><td><p>The replacement string.</p></td></tr></tbody></table>

### Example

This example shows how `replaceAll` behaves with different inputs.

#### Source

```DataWeave
import * from dw::core::Strings
output application/json
---
{
    a: replaceAll("Mariano", "a" , "A"),
    b: replaceAll("AAAA", "AAA" , "B"),
    c: replaceAll(null, "aria" , "A"),
    d: replaceAll("Mariano", "j" , "Test"),
}
```

#### Output

```Json
{
   "a": "MAriAno",
   "b": "BA",
   "c": null,
   "d": "Mariano"
 }
```

## replaceAll(text: Null, oldValue: String, newValue: String): Null

Helper function that enables `replaceAll` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=55c233d920a68f67a9aadfb0902043574d962d65daf1a80ec74c2b8406f03fbd url=/mulesoft/current/en-us/dataweave/2.4/dw-strings-functions-replaceall.md -->

---
product: DataWeave
version: 2.4
---

# replaceAll

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## replaceAll(text: String, target: String, replacement: String): String

Replaces all substrings that match a literal search string with a specified replacement string.

Replacement proceeds from the beginning of the string to the end. For example, the result of
replacing `"aa"` with `"b"` in the string\` `"aaa"` is `"ba"`, rather than `"ab"`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to search.</p></td></tr><tr><td><p><code>target</code></p></td><td><p>The string to find and replace in <code>text</code>.</p></td></tr><tr><td><p><code>replacement</code></p></td><td><p>The replacement string.</p></td></tr></tbody></table>

### Example

This example shows how `replaceAll` behaves with different inputs.

#### Source

```DataWeave
import * from dw::core::Strings
output application/json
---
{
    a: replaceAll("Mariano", "a" , "A"),
    b: replaceAll("AAAA", "AAA" , "B"),
    c: replaceAll(null, "aria" , "A"),
    d: replaceAll("Mariano", "j" , "Test"),
}
```

#### Output

```Json
{
   "a": "MAriAno",
   "b": "BA",
   "c": null,
   "d": "Mariano"
 }
```

## replaceAll(text: Null, oldValue: String, newValue: String): Null

Helper function that enables `replaceAll` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=ee43e426c0f0dcaf5079ace873119a3c8638fe511347753faeb8190dbbaa1cb8 url=/mulesoft/current/en-us/dataweave/2.6/dw-strings-functions-replaceall.md -->

---
product: DataWeave
version: 2.6
---

# replaceAll

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## replaceAll(text: String, target: String, replacement: String): String

Replaces all substrings that match a literal search string with a specified replacement string.

Replacement proceeds from the beginning of the string to the end. For example, the result of
replacing `"aa"` with `"b"` in the string\` `"aaa"` is `"ba"`, rather than `"ab"`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to search.</p></td></tr><tr><td><p><code>target</code></p></td><td><p>The string to find and replace in <code>text</code>.</p></td></tr><tr><td><p><code>replacement</code></p></td><td><p>The replacement string.</p></td></tr></tbody></table>

### Example

This example shows how `replaceAll` behaves with different inputs.

#### Source

```DataWeave
import * from dw::core::Strings
output application/json
---
{
    a: replaceAll("Mariano", "a" , "A"),
    b: replaceAll("AAAA", "AAA" , "B"),
    c: replaceAll(null, "aria" , "A"),
    d: replaceAll("Mariano", "j" , "Test"),
}
```

#### Output

```Json
{
   "a": "MAriAno",
   "b": "BA",
   "c": null,
   "d": "Mariano"
 }
```

## replaceAll(text: Null, oldValue: String, newValue: String): Null

Helper function that enables `replaceAll` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=f8aa829c50e72a4b82fa84d7156514af159f2c67536b0d1e66478f6e80461ae3 url=/mulesoft/current/en-us/dataweave/2.9/dw-strings-functions-replaceall.md -->

---
product: DataWeave
version: 2.9
---

# replaceAll

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## replaceAll(text: String, target: String, replacement: String): String

Replaces all substrings that match a literal search string with a specified replacement string.

Replacement proceeds from the beginning of the string to the end. For example, the result of
replacing `"aa"` with `"b"` in the string\` `"aaa"` is `"ba"`, rather than `"ab"`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to search.</p></td></tr><tr><td><p><code>target</code></p></td><td><p>The string to find and replace in <code>text</code>.</p></td></tr><tr><td><p><code>replacement</code></p></td><td><p>The replacement string.</p></td></tr></tbody></table>

### Example

This example shows how `replaceAll` behaves with different inputs.

#### Source

```DataWeave
import * from dw::core::Strings
output application/json
---
{
    a: replaceAll("Mariano", "a" , "A"),
    b: replaceAll("AAAA", "AAA" , "B"),
    c: replaceAll(null, "aria" , "A"),
    d: replaceAll("Mariano", "j" , "Test"),
}
```

#### Output

```Json
{
   "a": "MAriAno",
   "b": "BA",
   "c": null,
   "d": "Mariano"
 }
```

## replaceAll(text: Null, oldValue: String, newValue: String): Null

Helper function that enables `replaceAll` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=794f756d1dd61cf4eb32982aa08b4e13d8d29ff77cb6557e184eac79db0a3c00 url=/mulesoft/current/en-us/dataweave/latest/dw-strings-functions-replaceall.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# replaceAll

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## replaceAll(text: String, target: String, replacement: String): String

Replaces all substrings that match a literal search string with a specified replacement string.

Replacement proceeds from the beginning of the string to the end. For example, the result of
replacing `"aa"` with `"b"` in the string\` `"aaa"` is `"ba"`, rather than `"ab"`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to search.</p></td></tr><tr><td><p><code>target</code></p></td><td><p>The string to find and replace in <code>text</code>.</p></td></tr><tr><td><p><code>replacement</code></p></td><td><p>The replacement string.</p></td></tr></tbody></table>

### Example

This example shows how `replaceAll` behaves with different inputs.

#### Source

```DataWeave
import * from dw::core::Strings
output application/json
---
{
    a: replaceAll("Mariano", "a" , "A"),
    b: replaceAll("AAAA", "AAA" , "B"),
    c: replaceAll(null, "aria" , "A"),
    d: replaceAll("Mariano", "j" , "Test"),
}
```

#### Output

```Json
{
   "a": "MAriAno",
   "b": "BA",
   "c": null,
   "d": "Mariano"
 }
```

## replaceAll(text: Null, oldValue: String, newValue: String): Null

Helper function that enables `replaceAll` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=cc007b520b565d8eeba5feea737b51b05648e8113140caa017f0f0e51cdb6dd3 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-type-reuse-xml-schema.md -->

---
product: DataWeave
version: 2.11
---

# Reusing an XML Schema

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You can import XML schema files (`.xsd`) in your DataWeave script as modules by using the
`xmlschema!` module loader. This loader enables you to use types that are declared in your schema in
DataWeave directly. DataWeave loads your XSD file and translates declarations in your file into
DataWeave type directives that you can access in the same way as types from any other DataWeave
module. Use the directives to build new types, type-check your variables, match patterns, or declare
new functions that use types. DataWeave places no restrictions on how to use these types.

The following example shows how to look for an XSD file in the path `org/weave/myfolder/User.xsd` in
your DataWeave script:

import \* from xmlschema!org::weave::myfolder::User

## Import Syntax

To import the XML schema types, use the following syntax, where:

- `typeToImport`: You can use `*` to import all types defined in the schema, or to import a single
  type from the schema, for example, `Root`. You can also import XML schema types with a different
  name, for example, `Root as Person`. This way you can reference the type with that name in the
  script.

- `pathToXsdSchemaFile`: To specify the path to the schema file, replace the file separators with
  `::` and remove the `.xsd` extension from the file name. For example, if the path to the schema is
  `example/schema/Person.xsd`, use `example::schema::Person`.

import \_typesToImport\_ from xmlschema!\_pathToXsdSchemaFile\_

The following example shows how to import a type:

import \* from xmlschema!example::schema::Person

## Use Your Types in a DataWeave Script

This example shows how to use types to import XML schema files into your DataWeave script.

XSD File (`User.xsd`):

```XML
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"
           xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="Root">
        <xs:complexType>
            <xs:choice>
                <xs:element name="employee" type="employee"/>
                <xs:element name="member" type="member"/>
            </xs:choice>
            <xs:attribute name="id" use="required"/>
        </xs:complexType>
    </xs:element>
    <xs:complexType name="employee">
        <xs:sequence>
            <xs:element name="name" type="xs:string"/>
        </xs:sequence>
    </xs:complexType>


    <xs:complexType name="member">
        <xs:sequence>
            <xs:element name="id" type="xs:string"/>
        </xs:sequence>
    </xs:complexType>
</xs:schema>
```

DataWeave Script:

```dataweave
%dw 2.0
import * from xmlschema!org::weave::myfolder::User


{
      Root @(id:"test") :{
        employee: {
            "name": "Mariano"
        }
      } match {
             case is Root -> true
             else -> false
        }
}
```

## From the XML Model to DataWeave Types

Because the XML schema type system translates to DataWeave type directives and the two type models
are different, the resulting DataWeave type might not represent exactly the same XML model. The
following files illustrate how XSD translates to DataWeave code. These files are generated
dynamically and are not visible, though they are useful for learning how to consume types from
generated XSD files.

### Built-in XML Schema Types

DataWeave supports the following XSD types where `xs` is the XMLSchema default namespace:

<table><colgroup><col> <col></colgroup><thead><tr><th>XSD Type</th><th>Dataweave Type</th></tr></thead><tbody><tr><td><p><code>xs:number</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:int</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:integer</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:long</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:short</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:byte</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:double</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:decimal</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:unsignedLong</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:unsignedInt</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:unsignedShort</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:unsignedByte</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:positiveInteger</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:negativeInteger</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:nonNegativeInteger</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:nonPositiveInteger</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:hexBinary</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>xs:base64Binary</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>xs:boolean</code></p></td><td><p><code>Boolean</code></p></td></tr><tr><td><p><code>xs:any</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>xs:string</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>xs:normalizedString</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>xs:datetime</code></p></td><td><p><code>DateTime</code></p></td></tr><tr><td><p><code>xs:time</code></p></td><td><p><code>Time</code></p></td></tr><tr><td><p><code>xs:date</code></p></td><td><p><code>LocalDateTime</code></p></td></tr></tbody></table>

XSD:

```XML
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"  xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="Root">
        <xs:complexType>
            <xs:all>
                <xs:element name="string" type="xs:string"/>
                <xs:element name="normalizedString" type="xs:normalizedString"/>


                <xs:element name="integer" type="xs:integer"/>
                <xs:element name="negativeInteger" type="xs:negativeInteger"/>
                <xs:element name="int" type="xs:int"/>
                <xs:element name="unsignedInt" type="xs:unsignedInt"/>
                <xs:element name="unsignedLong" type="xs:unsignedLong"/>
                <xs:element name="unsignedShort" type="xs:unsignedShort"/>
                <xs:element name="float" type="xs:float"/>
                <xs:element name="double" type="xs:double"/>


                <xs:element name="date" type="xs:date"/>
                <xs:element name="dateTime" type="xs:dateTime"/>
                <xs:element name="time" type="xs:time"/>


                <xs:element name="boolean" type="xs:boolean"/>


                <xs:element name="hexBinary" type="xs:hexBinary"/>
                <xs:element name="base64Binary" type="xs:base64Binary"/>
                <xs:element name="decimal" type="xs:decimal"/>








            </xs:all>
        </xs:complexType>
    </xs:element>
</xs:schema>
```

Generated DataWeave Module:

```dataweave
%dw 2.0


type RootElementDefinition = {| Root: { string: String, normalizedString: String, integer: Number, negativeInteger: Number, int: Number, unsignedInt: Number, unsignedLong: Number, unsignedShort: Number, float: Number, double: Number, date: LocalDateTime, dateTime: DateTime, time: Time, boolean: Boolean, hexBinary: Binary, base64Binary: Binary, decimal: Number } |}


type Root = RootElementDefinition
```

### Root Elements Declaration

Each root element (`<xs:element>`) declared in your XSD file generates the following:

- A DataWeave `type` directive with the element name followed by the `ElementDefinition` extension

- A `type` directive named `Root` as a `Union` type that consists of all the root elements in the
  XSD.

The following example shows how to declare root elements:

XSD:

```XML
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">


    <xs:element name="Root">
        <xs:complexType>
            <xs:sequence>
                <xs:element type="xs:string" name="color" default="Red"/>
                <xs:element type="xs:integer" name="age" default="12"/>
            </xs:sequence>
            <xs:attribute type="xs:string" name="type" default="ALBA"/>
        </xs:complexType>
    </xs:element>


    <xs:element name="AnotherRoot">
        <xs:complexType>
            <xs:sequence>
                <xs:element type="xs:string" name="name" default="Red"/>
            </xs:sequence>
            <xs:attribute type="xs:string" name="type"/>
        </xs:complexType>
    </xs:element>
</xs:schema>
```

Generated DataWeave Module:

```dataweave
%dw 2.0


type AnotherRootElementDefinition = {| AnotherRoot @("type"?: String): {- name: String -} |}


type RootElementDefinition = {| Root @("type"?: String): {- color: String, age: Number -} |}


type Root = AnotherRootElementDefinition | RootElementDefinition
```

### Complex Types

Named complex types declared as top-level elements on the schema which are referenced in your schema
or are available for reuse on other structures generate their own type directive. These type
directive names include `complextype` name followed by the `Definition` extension.

The following example shows how to declare complex types:

XSD:

```XML
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"
           xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="Root">
        <xs:complexType>
            <xs:choice>
                <xs:element name="employee" type="employee"/>
                <xs:element name="member" type="member"/>
            </xs:choice>
            <xs:attribute name="id" default="foo"/>
        </xs:complexType>
    </xs:element>
    <xs:complexType name="employee">
        <xs:sequence>
            <xs:element name="name" type="xs:string"/>
        </xs:sequence>
    </xs:complexType>


    <xs:complexType name="member">
        <xs:sequence>
            <xs:element name="id" type="xs:string"/>
        </xs:sequence>
    </xs:complexType>
</xs:schema>
```

Generated DataWeave Module:

```dataweave
%dw 2.0


type EmployeeDefinition = { employee: {- name: String -} }


type MemberDefinition = { member: {- id: String -} }


type RootElementDefinition = {| Root @(id?: String): {| employee: EmployeeDefinition.employee |} | {| member: MemberDefinition.member |} |}


type Root = RootElementDefinition
```

### Imports/Includes

The use of imports or includes in an XSD schema file results in a DataWeave module which contains an
`import` directive that uses the XML schema module loader to point to the schema file located at the
specified `schemaLocation`. This location must be declared relative to the main schema. Notice how
the following examples use [Selecting Types](https://docs.mulesoft.com/dataweave/2.11/dataweave-selecting-types):

XSD:

```XML
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
						xmlns:common="http://common.com/COMMON">


	<xsd:import schemaLocation="common.xsd" namespace="http://common.com/COMMON" />


	<xsd:element name="Root" type="common:RequestHeader"/>


</xsd:schema>
```

Generated DataWeave Module:

```dataweave
%dw 2.0


ns ns0 http://common.com/COMMON


import xmlschema!org::mule::weave::v2::module::xmlschema::moduleloader::imports::common


type RootElementDefinition = {| Root: common::RequestHeaderDefinition.ns0#RequestHeader |}


type Root = RootElementDefinition
```

### Choice

You can map this XML schema structure to `UnionType` in DataWeave:

XSD:

```XML
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"
           xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="Root">
        <xs:complexType>
            <xs:choice>
                <xs:element name="employee" type="employee"/>
                <xs:element name="member" type="member"/>
            </xs:choice>
        </xs:complexType>
    </xs:element>
    <xs:complexType name="employee">
        <xs:sequence>
            <xs:element name="name" type="xs:string"/>
        </xs:sequence>
    </xs:complexType>


    <xs:complexType name="member">
        <xs:sequence>
            <xs:element name="id" type="xs:string"/>
        </xs:sequence>
    </xs:complexType>
</xs:schema>
```

Generated DataWeave Module:

```dataweave
%dw 2.0


type EmployeeDefinition = { employee: {- name: String -} }


type MemberDefinition = { member: {- id: String -} }


type RootElementDefinition = {| Root: {| employee: EmployeeDefinition.employee |} | {| member: MemberDefinition.member |} |}


type Root = RootElementDefinition
```

### Namespaces

Namespaces in your XML schema file translate directly to DataWeave type directives.

The following example shows how to set the specific `targetNamespace` attribute where your elements
exist. This namespace, which translates to DataWeave, is required to select and navigate these
types.

XSD:

```XML
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xs:schema attributeFormDefault="unqualified" targetNamespace="http://NamespaceTest.com/CommonTypes" elementFormDefault="qualified"  xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="Root">
        <xs:complexType>
            <xs:all>
                <xs:element name="string" type="xs:string"/>
                <xs:element name="normalizedString" type="xs:normalizedString"/>
                <xs:element name="integer" type="xs:integer"/>
                <xs:element name="negativeInteger" type="xs:negativeInteger"/>
                <xs:element name="int" type="xs:int"/>
                <xs:element name="unsignedInt" type="xs:unsignedInt"/>
                <xs:element name="unsignedLong" type="xs:unsignedLong"/>
                <xs:element name="unsignedShort" type="xs:unsignedShort"/>
                <xs:element name="float" type="xs:float"/>
                <xs:element name="double" type="xs:double"/>
                <xs:element name="date" type="xs:date"/>
                <xs:element name="dateTime" type="xs:dateTime"/>
                <xs:element name="time" type="xs:time"/>
                <xs:element name="boolean" type="xs:boolean"/>
                <xs:element name="hexBinary" type="xs:hexBinary"/>
                <xs:element name="base64Binary" type="xs:base64Binary"/>
                <xs:element name="decimal" type="xs:decimal"/>
            </xs:all>
        </xs:complexType>
    </xs:element>
</xs:schema>
```

Generated DataWeave Module:

```dataweave
%dw 2.0


ns ns0 http://NamespaceTest.com/CommonTypes


type RootElementDefinition = {| ns0#Root: { ns0#string: String, ns0#normalizedString: String, ns0#integer: Number, ns0#negativeInteger: Number, ns0#int: Number, ns0#unsignedInt: Number, ns0#unsignedLong: Number, ns0#unsignedShort: Number, ns0#float: Number, ns0#double: Number, ns0#date: LocalDateTime, ns0#dateTime: DateTime, ns0#time: Time, ns0#boolean: Boolean, ns0#hexBinary: Binary, ns0#base64Binary: Binary, ns0#decimal: Number } |}


type Root = RootElementDefinition
```

<!-- document id=8ba4224f4f9b1faa391a493e9051542670be065477197f17cc209bcb32d2836b url=/mulesoft/current/en-us/dataweave/2.12/dataweave-type-reuse-xml-schema.md -->

---
product: DataWeave
version: 2.12
---

# Reusing an XML Schema

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You can import XML schema files (`.xsd`) in your DataWeave script as modules by using the
`xmlschema!` module loader. This loader enables you to use types that are declared in your schema in
DataWeave directly. DataWeave loads your XSD file and translates declarations in your file into
DataWeave type directives that you can access in the same way as types from any other DataWeave
module. Use the directives to build new types, type-check your variables, match patterns, or declare
new functions that use types. DataWeave places no restrictions on how to use these types.

The following example shows how to look for an XSD file in the path `org/weave/myfolder/User.xsd` in
your DataWeave script:

import \* from xmlschema!org::weave::myfolder::User

## Import Syntax

To import the XML schema types, use the following syntax, where:

- `typeToImport`: You can use `*` to import all types defined in the schema, or to import a single
  type from the schema, for example, `Root`. You can also import XML schema types with a different
  name, for example, `Root as Person`. This way you can reference the type with that name in the
  script.

- `pathToXsdSchemaFile`: To specify the path to the schema file, replace the file separators with
  `::` and remove the `.xsd` extension from the file name. For example, if the path to the schema is
  `example/schema/Person.xsd`, use `example::schema::Person`.

import \_typesToImport\_ from xmlschema!\_pathToXsdSchemaFile\_

The following example shows how to import a type:

import \* from xmlschema!example::schema::Person

## Use Your Types in a DataWeave Script

This example shows how to use types to import XML schema files into your DataWeave script.

XSD File (`User.xsd`):

```XML
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"
           xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="Root">
        <xs:complexType>
            <xs:choice>
                <xs:element name="employee" type="employee"/>
                <xs:element name="member" type="member"/>
            </xs:choice>
            <xs:attribute name="id" use="required"/>
        </xs:complexType>
    </xs:element>
    <xs:complexType name="employee">
        <xs:sequence>
            <xs:element name="name" type="xs:string"/>
        </xs:sequence>
    </xs:complexType>


    <xs:complexType name="member">
        <xs:sequence>
            <xs:element name="id" type="xs:string"/>
        </xs:sequence>
    </xs:complexType>
</xs:schema>
```

DataWeave Script:

```dataweave
%dw 2.0
import * from xmlschema!org::weave::myfolder::User


{
      Root @(id:"test") :{
        employee: {
            "name": "Mariano"
        }
      } match {
             case is Root -> true
             else -> false
        }
}
```

## From the XML Model to DataWeave Types

Because the XML schema type system translates to DataWeave type directives and the two type models
are different, the resulting DataWeave type might not represent exactly the same XML model. The
following files illustrate how XSD translates to DataWeave code. These files are generated
dynamically and are not visible, though they are useful for learning how to consume types from
generated XSD files.

### Built-in XML Schema Types

DataWeave supports the following XSD types where `xs` is the XMLSchema default namespace:

<table><colgroup><col> <col></colgroup><thead><tr><th>XSD Type</th><th>Dataweave Type</th></tr></thead><tbody><tr><td><p><code>xs:number</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:int</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:integer</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:long</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:short</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:byte</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:double</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:decimal</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:unsignedLong</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:unsignedInt</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:unsignedShort</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:unsignedByte</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:positiveInteger</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:negativeInteger</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:nonNegativeInteger</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:nonPositiveInteger</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:hexBinary</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>xs:base64Binary</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>xs:boolean</code></p></td><td><p><code>Boolean</code></p></td></tr><tr><td><p><code>xs:any</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>xs:string</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>xs:normalizedString</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>xs:datetime</code></p></td><td><p><code>DateTime</code></p></td></tr><tr><td><p><code>xs:time</code></p></td><td><p><code>Time</code></p></td></tr><tr><td><p><code>xs:date</code></p></td><td><p><code>LocalDateTime</code></p></td></tr></tbody></table>

XSD:

```XML
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"  xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="Root">
        <xs:complexType>
            <xs:all>
                <xs:element name="string" type="xs:string"/>
                <xs:element name="normalizedString" type="xs:normalizedString"/>


                <xs:element name="integer" type="xs:integer"/>
                <xs:element name="negativeInteger" type="xs:negativeInteger"/>
                <xs:element name="int" type="xs:int"/>
                <xs:element name="unsignedInt" type="xs:unsignedInt"/>
                <xs:element name="unsignedLong" type="xs:unsignedLong"/>
                <xs:element name="unsignedShort" type="xs:unsignedShort"/>
                <xs:element name="float" type="xs:float"/>
                <xs:element name="double" type="xs:double"/>


                <xs:element name="date" type="xs:date"/>
                <xs:element name="dateTime" type="xs:dateTime"/>
                <xs:element name="time" type="xs:time"/>


                <xs:element name="boolean" type="xs:boolean"/>


                <xs:element name="hexBinary" type="xs:hexBinary"/>
                <xs:element name="base64Binary" type="xs:base64Binary"/>
                <xs:element name="decimal" type="xs:decimal"/>








            </xs:all>
        </xs:complexType>
    </xs:element>
</xs:schema>
```

Generated DataWeave Module:

```dataweave
%dw 2.0


type RootElementDefinition = {| Root: { string: String, normalizedString: String, integer: Number, negativeInteger: Number, int: Number, unsignedInt: Number, unsignedLong: Number, unsignedShort: Number, float: Number, double: Number, date: LocalDateTime, dateTime: DateTime, time: Time, boolean: Boolean, hexBinary: Binary, base64Binary: Binary, decimal: Number } |}


type Root = RootElementDefinition
```

### Root Elements Declaration

Each root element (`<xs:element>`) declared in your XSD file generates the following:

- A DataWeave `type` directive with the element name followed by the `ElementDefinition` extension

- A `type` directive named `Root` as a `Union` type that consists of all the root elements in the
  XSD.

The following example shows how to declare root elements:

XSD:

```XML
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">


    <xs:element name="Root">
        <xs:complexType>
            <xs:sequence>
                <xs:element type="xs:string" name="color" default="Red"/>
                <xs:element type="xs:integer" name="age" default="12"/>
            </xs:sequence>
            <xs:attribute type="xs:string" name="type" default="ALBA"/>
        </xs:complexType>
    </xs:element>


    <xs:element name="AnotherRoot">
        <xs:complexType>
            <xs:sequence>
                <xs:element type="xs:string" name="name" default="Red"/>
            </xs:sequence>
            <xs:attribute type="xs:string" name="type"/>
        </xs:complexType>
    </xs:element>
</xs:schema>
```

Generated DataWeave Module:

```dataweave
%dw 2.0


type AnotherRootElementDefinition = {| AnotherRoot @("type"?: String): {- name: String -} |}


type RootElementDefinition = {| Root @("type"?: String): {- color: String, age: Number -} |}


type Root = AnotherRootElementDefinition | RootElementDefinition
```

### Complex Types

Named complex types declared as top-level elements on the schema which are referenced in your schema
or are available for reuse on other structures generate their own type directive. These type
directive names include `complextype` name followed by the `Definition` extension.

The following example shows how to declare complex types:

XSD:

```XML
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"
           xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="Root">
        <xs:complexType>
            <xs:choice>
                <xs:element name="employee" type="employee"/>
                <xs:element name="member" type="member"/>
            </xs:choice>
            <xs:attribute name="id" default="foo"/>
        </xs:complexType>
    </xs:element>
    <xs:complexType name="employee">
        <xs:sequence>
            <xs:element name="name" type="xs:string"/>
        </xs:sequence>
    </xs:complexType>


    <xs:complexType name="member">
        <xs:sequence>
            <xs:element name="id" type="xs:string"/>
        </xs:sequence>
    </xs:complexType>
</xs:schema>
```

Generated DataWeave Module:

```dataweave
%dw 2.0


type EmployeeDefinition = { employee: {- name: String -} }


type MemberDefinition = { member: {- id: String -} }


type RootElementDefinition = {| Root @(id?: String): {| employee: EmployeeDefinition.employee |} | {| member: MemberDefinition.member |} |}


type Root = RootElementDefinition
```

### Imports/Includes

The use of imports or includes in an XSD schema file results in a DataWeave module which contains an
`import` directive that uses the XML schema module loader to point to the schema file located at the
specified `schemaLocation`. This location must be declared relative to the main schema. Notice how
the following examples use [Selecting Types](https://docs.mulesoft.com/dataweave/2.12/dataweave-selecting-types):

XSD:

```XML
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
						xmlns:common="http://common.com/COMMON">


	<xsd:import schemaLocation="common.xsd" namespace="http://common.com/COMMON" />


	<xsd:element name="Root" type="common:RequestHeader"/>


</xsd:schema>
```

Generated DataWeave Module:

```dataweave
%dw 2.0


ns ns0 http://common.com/COMMON


import xmlschema!org::mule::weave::v2::module::xmlschema::moduleloader::imports::common


type RootElementDefinition = {| Root: common::RequestHeaderDefinition.ns0#RequestHeader |}


type Root = RootElementDefinition
```

### Choice

You can map this XML schema structure to `UnionType` in DataWeave:

XSD:

```XML
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"
           xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="Root">
        <xs:complexType>
            <xs:choice>
                <xs:element name="employee" type="employee"/>
                <xs:element name="member" type="member"/>
            </xs:choice>
        </xs:complexType>
    </xs:element>
    <xs:complexType name="employee">
        <xs:sequence>
            <xs:element name="name" type="xs:string"/>
        </xs:sequence>
    </xs:complexType>


    <xs:complexType name="member">
        <xs:sequence>
            <xs:element name="id" type="xs:string"/>
        </xs:sequence>
    </xs:complexType>
</xs:schema>
```

Generated DataWeave Module:

```dataweave
%dw 2.0


type EmployeeDefinition = { employee: {- name: String -} }


type MemberDefinition = { member: {- id: String -} }


type RootElementDefinition = {| Root: {| employee: EmployeeDefinition.employee |} | {| member: MemberDefinition.member |} |}


type Root = RootElementDefinition
```

### Namespaces

Namespaces in your XML schema file translate directly to DataWeave type directives.

The following example shows how to set the specific `targetNamespace` attribute where your elements
exist. This namespace, which translates to DataWeave, is required to select and navigate these
types.

XSD:

```XML
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xs:schema attributeFormDefault="unqualified" targetNamespace="http://NamespaceTest.com/CommonTypes" elementFormDefault="qualified"  xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="Root">
        <xs:complexType>
            <xs:all>
                <xs:element name="string" type="xs:string"/>
                <xs:element name="normalizedString" type="xs:normalizedString"/>
                <xs:element name="integer" type="xs:integer"/>
                <xs:element name="negativeInteger" type="xs:negativeInteger"/>
                <xs:element name="int" type="xs:int"/>
                <xs:element name="unsignedInt" type="xs:unsignedInt"/>
                <xs:element name="unsignedLong" type="xs:unsignedLong"/>
                <xs:element name="unsignedShort" type="xs:unsignedShort"/>
                <xs:element name="float" type="xs:float"/>
                <xs:element name="double" type="xs:double"/>
                <xs:element name="date" type="xs:date"/>
                <xs:element name="dateTime" type="xs:dateTime"/>
                <xs:element name="time" type="xs:time"/>
                <xs:element name="boolean" type="xs:boolean"/>
                <xs:element name="hexBinary" type="xs:hexBinary"/>
                <xs:element name="base64Binary" type="xs:base64Binary"/>
                <xs:element name="decimal" type="xs:decimal"/>
            </xs:all>
        </xs:complexType>
    </xs:element>
</xs:schema>
```

Generated DataWeave Module:

```dataweave
%dw 2.0


ns ns0 http://NamespaceTest.com/CommonTypes


type RootElementDefinition = {| ns0#Root: { ns0#string: String, ns0#normalizedString: String, ns0#integer: Number, ns0#negativeInteger: Number, ns0#int: Number, ns0#unsignedInt: Number, ns0#unsignedLong: Number, ns0#unsignedShort: Number, ns0#float: Number, ns0#double: Number, ns0#date: LocalDateTime, ns0#dateTime: DateTime, ns0#time: Time, ns0#boolean: Boolean, ns0#hexBinary: Binary, ns0#base64Binary: Binary, ns0#decimal: Number } |}


type Root = RootElementDefinition
```

<!-- document id=e7b4a93796366516e0820699840154a102a381184ac510d597a5fa79c35f192c url=/mulesoft/current/en-us/dataweave/2.6/dataweave-type-reuse-xml-schema.md -->

---
product: DataWeave
version: 2.6
---

# Reusing an XML Schema

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You can import XML schema files (`.xsd`) in your DataWeave script as modules by using the
`xmlschema!` module loader. This loader enables you to use types that are declared in your schema in
DataWeave directly. DataWeave loads your XSD file and translates declarations in your file into
DataWeave type directives that you can access in the same way as types from any other DataWeave
module. Use the directives to build new types, type-check your variables, match patterns, or declare
new functions that use types. DataWeave places no restrictions on how to use these types.

The following example shows how to look for an XSD file in the path `org/weave/myfolder/User.xsd` in
your DataWeave script:

import \* from xmlschema!org::weave::myfolder::User

## Import Syntax

To import the XML schema types, use the following syntax, where:

- `typeToImport`: You can use `*` to import all types defined in the schema, or to import a single
  type from the schema, for example, `Root`. You can also import XML schema types with a different
  name, for example, `Root as Person`. This way you can reference the type with that name in the
  script.

- `pathToXsdSchemaFile`: To specify the path to the schema file, replace the file separators with
  `::` and remove the `.xsd` extension from the file name. For example, if the path to the schema is
  `example/schema/Person.xsd`, use `example::schema::Person`.

import \_typesToImport\_ from xmlschema!\_pathToXsdSchemaFile\_

The following example shows how to import a type:

import \* from xmlschema!example::schema::Person

## Use Your Types in a DataWeave Script

This example shows how to use types to import XML schema files into your DataWeave script.

XSD File (`User.xsd`):

```XML
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"
           xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="Root">
        <xs:complexType>
            <xs:choice>
                <xs:element name="employee" type="employee"/>
                <xs:element name="member" type="member"/>
            </xs:choice>
            <xs:attribute name="id" use="required"/>
        </xs:complexType>
    </xs:element>
    <xs:complexType name="employee">
        <xs:sequence>
            <xs:element name="name" type="xs:string"/>
        </xs:sequence>
    </xs:complexType>


    <xs:complexType name="member">
        <xs:sequence>
            <xs:element name="id" type="xs:string"/>
        </xs:sequence>
    </xs:complexType>
</xs:schema>
```

DataWeave Script:

```dataweave
%dw 2.0
import * from xmlschema!org::weave::myfolder::User


{
      Root @(id:"test") :{
        employee: {
            "name": "Mariano"
        }
      } match {
             case is Root -> true
             else -> false
        }
}
```

## From the XML Model to DataWeave Types

Because the XML schema type system translates to DataWeave type directives and the two type models
are different, the resulting DataWeave type might not represent exactly the same XML model. The
following files illustrate how XSD translates to DataWeave code. These files are generated
dynamically and are not visible, though they are useful for learning how to consume types from
generated XSD files.

### Built-in XML Schema Types

DataWeave supports the following XSD types where `xs` is the XMLSchema default namespace:

<table><colgroup><col> <col></colgroup><thead><tr><th>XSD Type</th><th>Dataweave Type</th></tr></thead><tbody><tr><td><p><code>xs:number</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:int</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:integer</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:long</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:short</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:byte</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:double</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:decimal</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:unsignedLong</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:unsignedInt</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:unsignedShort</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:unsignedByte</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:positiveInteger</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:negativeInteger</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:nonNegativeInteger</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:nonPositiveInteger</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:hexBinary</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>xs:base64Binary</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>xs:boolean</code></p></td><td><p><code>Boolean</code></p></td></tr><tr><td><p><code>xs:any</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>xs:string</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>xs:normalizedString</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>xs:datetime</code></p></td><td><p><code>DateTime</code></p></td></tr><tr><td><p><code>xs:time</code></p></td><td><p><code>Time</code></p></td></tr><tr><td><p><code>xs:date</code></p></td><td><p><code>LocalDateTime</code></p></td></tr></tbody></table>

XSD:

```XML
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"  xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="Root">
        <xs:complexType>
            <xs:all>
                <xs:element name="string" type="xs:string"/>
                <xs:element name="normalizedString" type="xs:normalizedString"/>


                <xs:element name="integer" type="xs:integer"/>
                <xs:element name="negativeInteger" type="xs:negativeInteger"/>
                <xs:element name="int" type="xs:int"/>
                <xs:element name="unsignedInt" type="xs:unsignedInt"/>
                <xs:element name="unsignedLong" type="xs:unsignedLong"/>
                <xs:element name="unsignedShort" type="xs:unsignedShort"/>
                <xs:element name="float" type="xs:float"/>
                <xs:element name="double" type="xs:double"/>


                <xs:element name="date" type="xs:date"/>
                <xs:element name="dateTime" type="xs:dateTime"/>
                <xs:element name="time" type="xs:time"/>


                <xs:element name="boolean" type="xs:boolean"/>


                <xs:element name="hexBinary" type="xs:hexBinary"/>
                <xs:element name="base64Binary" type="xs:base64Binary"/>
                <xs:element name="decimal" type="xs:decimal"/>








            </xs:all>
        </xs:complexType>
    </xs:element>
</xs:schema>
```

Generated DataWeave Module:

```dataweave
%dw 2.0


type RootElementDefinition = {| Root: { string: String, normalizedString: String, integer: Number, negativeInteger: Number, int: Number, unsignedInt: Number, unsignedLong: Number, unsignedShort: Number, float: Number, double: Number, date: LocalDateTime, dateTime: DateTime, time: Time, boolean: Boolean, hexBinary: Binary, base64Binary: Binary, decimal: Number } |}


type Root = RootElementDefinition
```

### Root Elements Declaration

Each root element (`<xs:element>`) declared in your XSD file generates the following:

- A DataWeave `type` directive with the element name followed by the `ElementDefinition` extension

- A `type` directive named `Root` as a `Union` type that consists of all the root elements in the
  XSD.

The following example shows how to declare root elements:

XSD:

```XML
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">


    <xs:element name="Root">
        <xs:complexType>
            <xs:sequence>
                <xs:element type="xs:string" name="color" default="Red"/>
                <xs:element type="xs:integer" name="age" default="12"/>
            </xs:sequence>
            <xs:attribute type="xs:string" name="type" default="ALBA"/>
        </xs:complexType>
    </xs:element>


    <xs:element name="AnotherRoot">
        <xs:complexType>
            <xs:sequence>
                <xs:element type="xs:string" name="name" default="Red"/>
            </xs:sequence>
            <xs:attribute type="xs:string" name="type"/>
        </xs:complexType>
    </xs:element>
</xs:schema>
```

Generated DataWeave Module:

```dataweave
%dw 2.0


type AnotherRootElementDefinition = {| AnotherRoot @("type"?: String): {- name: String -} |}


type RootElementDefinition = {| Root @("type"?: String): {- color: String, age: Number -} |}


type Root = AnotherRootElementDefinition | RootElementDefinition
```

### Complex Types

Named complex types declared as top-level elements on the schema which are referenced in your schema
or are available for reuse on other structures generate their own type directive. These type
directive names include `complextype` name followed by the `Definition` extension.

The following example shows how to declare complex types:

XSD:

```XML
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"
           xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="Root">
        <xs:complexType>
            <xs:choice>
                <xs:element name="employee" type="employee"/>
                <xs:element name="member" type="member"/>
            </xs:choice>
            <xs:attribute name="id" default="foo"/>
        </xs:complexType>
    </xs:element>
    <xs:complexType name="employee">
        <xs:sequence>
            <xs:element name="name" type="xs:string"/>
        </xs:sequence>
    </xs:complexType>


    <xs:complexType name="member">
        <xs:sequence>
            <xs:element name="id" type="xs:string"/>
        </xs:sequence>
    </xs:complexType>
</xs:schema>
```

Generated DataWeave Module:

```dataweave
%dw 2.0


type EmployeeDefinition = { employee: {- name: String -} }


type MemberDefinition = { member: {- id: String -} }


type RootElementDefinition = {| Root @(id?: String): {| employee: EmployeeDefinition.employee |} | {| member: MemberDefinition.member |} |}


type Root = RootElementDefinition
```

### Imports/Includes

The use of imports or includes in an XSD schema file results in a DataWeave module which contains an
`import` directive that uses the XML schema module loader to point to the schema file located at the
specified `schemaLocation`. This location must be declared relative to the main schema. Notice how
the following examples use [Selecting Types](https://docs.mulesoft.com/dataweave/2.6/dataweave-selecting-types):

XSD:

```XML
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
						xmlns:common="http://common.com/COMMON">


	<xsd:import schemaLocation="common.xsd" namespace="http://common.com/COMMON" />


	<xsd:element name="Root" type="common:RequestHeader"/>


</xsd:schema>
```

Generated DataWeave Module:

```dataweave
%dw 2.0


ns ns0 http://common.com/COMMON


import xmlschema!org::mule::weave::v2::module::xmlschema::moduleloader::imports::common


type RootElementDefinition = {| Root: common::RequestHeaderDefinition.ns0#RequestHeader |}


type Root = RootElementDefinition
```

### Choice

You can map this XML schema structure to `UnionType` in DataWeave:

XSD:

```XML
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"
           xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="Root">
        <xs:complexType>
            <xs:choice>
                <xs:element name="employee" type="employee"/>
                <xs:element name="member" type="member"/>
            </xs:choice>
        </xs:complexType>
    </xs:element>
    <xs:complexType name="employee">
        <xs:sequence>
            <xs:element name="name" type="xs:string"/>
        </xs:sequence>
    </xs:complexType>


    <xs:complexType name="member">
        <xs:sequence>
            <xs:element name="id" type="xs:string"/>
        </xs:sequence>
    </xs:complexType>
</xs:schema>
```

Generated DataWeave Module:

```dataweave
%dw 2.0


type EmployeeDefinition = { employee: {- name: String -} }


type MemberDefinition = { member: {- id: String -} }


type RootElementDefinition = {| Root: {| employee: EmployeeDefinition.employee |} | {| member: MemberDefinition.member |} |}


type Root = RootElementDefinition
```

### Namespaces

Namespaces in your XML schema file translate directly to DataWeave type directives.

The following example shows how to set the specific `targetNamespace` attribute where your elements
exist. This namespace, which translates to DataWeave, is required to select and navigate these
types.

XSD:

```XML
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xs:schema attributeFormDefault="unqualified" targetNamespace="http://NamespaceTest.com/CommonTypes" elementFormDefault="qualified"  xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="Root">
        <xs:complexType>
            <xs:all>
                <xs:element name="string" type="xs:string"/>
                <xs:element name="normalizedString" type="xs:normalizedString"/>
                <xs:element name="integer" type="xs:integer"/>
                <xs:element name="negativeInteger" type="xs:negativeInteger"/>
                <xs:element name="int" type="xs:int"/>
                <xs:element name="unsignedInt" type="xs:unsignedInt"/>
                <xs:element name="unsignedLong" type="xs:unsignedLong"/>
                <xs:element name="unsignedShort" type="xs:unsignedShort"/>
                <xs:element name="float" type="xs:float"/>
                <xs:element name="double" type="xs:double"/>
                <xs:element name="date" type="xs:date"/>
                <xs:element name="dateTime" type="xs:dateTime"/>
                <xs:element name="time" type="xs:time"/>
                <xs:element name="boolean" type="xs:boolean"/>
                <xs:element name="hexBinary" type="xs:hexBinary"/>
                <xs:element name="base64Binary" type="xs:base64Binary"/>
                <xs:element name="decimal" type="xs:decimal"/>
            </xs:all>
        </xs:complexType>
    </xs:element>
</xs:schema>
```

Generated DataWeave Module:

```dataweave
%dw 2.0


ns ns0 http://NamespaceTest.com/CommonTypes


type RootElementDefinition = {| ns0#Root: { ns0#string: String, ns0#normalizedString: String, ns0#integer: Number, ns0#negativeInteger: Number, ns0#int: Number, ns0#unsignedInt: Number, ns0#unsignedLong: Number, ns0#unsignedShort: Number, ns0#float: Number, ns0#double: Number, ns0#date: LocalDateTime, ns0#dateTime: DateTime, ns0#time: Time, ns0#boolean: Boolean, ns0#hexBinary: Binary, ns0#base64Binary: Binary, ns0#decimal: Number } |}


type Root = RootElementDefinition
```

<!-- document id=871d0270cf9f96fcaae42c31a9b0386631e8de7249f63358d8cc361ccfe625af url=/mulesoft/current/en-us/dataweave/2.9/dataweave-type-reuse-xml-schema.md -->

---
product: DataWeave
version: 2.9
---

# Reusing an XML Schema

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You can import XML schema files (`.xsd`) in your DataWeave script as modules by using the
`xmlschema!` module loader. This loader enables you to use types that are declared in your schema in
DataWeave directly. DataWeave loads your XSD file and translates declarations in your file into
DataWeave type directives that you can access in the same way as types from any other DataWeave
module. Use the directives to build new types, type-check your variables, match patterns, or declare
new functions that use types. DataWeave places no restrictions on how to use these types.

The following example shows how to look for an XSD file in the path `org/weave/myfolder/User.xsd` in
your DataWeave script:

import \* from xmlschema!org::weave::myfolder::User

## Import Syntax

To import the XML schema types, use the following syntax, where:

- `typeToImport`: You can use `*` to import all types defined in the schema, or to import a single
  type from the schema, for example, `Root`. You can also import XML schema types with a different
  name, for example, `Root as Person`. This way you can reference the type with that name in the
  script.

- `pathToXsdSchemaFile`: To specify the path to the schema file, replace the file separators with
  `::` and remove the `.xsd` extension from the file name. For example, if the path to the schema is
  `example/schema/Person.xsd`, use `example::schema::Person`.

import \_typesToImport\_ from xmlschema!\_pathToXsdSchemaFile\_

The following example shows how to import a type:

import \* from xmlschema!example::schema::Person

## Use Your Types in a DataWeave Script

This example shows how to use types to import XML schema files into your DataWeave script.

XSD File (`User.xsd`):

```XML
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"
           xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="Root">
        <xs:complexType>
            <xs:choice>
                <xs:element name="employee" type="employee"/>
                <xs:element name="member" type="member"/>
            </xs:choice>
            <xs:attribute name="id" use="required"/>
        </xs:complexType>
    </xs:element>
    <xs:complexType name="employee">
        <xs:sequence>
            <xs:element name="name" type="xs:string"/>
        </xs:sequence>
    </xs:complexType>


    <xs:complexType name="member">
        <xs:sequence>
            <xs:element name="id" type="xs:string"/>
        </xs:sequence>
    </xs:complexType>
</xs:schema>
```

DataWeave Script:

```dataweave
%dw 2.0
import * from xmlschema!org::weave::myfolder::User


{
      Root @(id:"test") :{
        employee: {
            "name": "Mariano"
        }
      } match {
             case is Root -> true
             else -> false
        }
}
```

## From the XML Model to DataWeave Types

Because the XML schema type system translates to DataWeave type directives and the two type models
are different, the resulting DataWeave type might not represent exactly the same XML model. The
following files illustrate how XSD translates to DataWeave code. These files are generated
dynamically and are not visible, though they are useful for learning how to consume types from
generated XSD files.

### Built-in XML Schema Types

DataWeave supports the following XSD types where `xs` is the XMLSchema default namespace:

<table><colgroup><col> <col></colgroup><thead><tr><th>XSD Type</th><th>Dataweave Type</th></tr></thead><tbody><tr><td><p><code>xs:number</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:int</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:integer</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:long</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:short</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:byte</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:double</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:decimal</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:unsignedLong</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:unsignedInt</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:unsignedShort</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:unsignedByte</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:positiveInteger</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:negativeInteger</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:nonNegativeInteger</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:nonPositiveInteger</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:hexBinary</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>xs:base64Binary</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>xs:boolean</code></p></td><td><p><code>Boolean</code></p></td></tr><tr><td><p><code>xs:any</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>xs:string</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>xs:normalizedString</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>xs:datetime</code></p></td><td><p><code>DateTime</code></p></td></tr><tr><td><p><code>xs:time</code></p></td><td><p><code>Time</code></p></td></tr><tr><td><p><code>xs:date</code></p></td><td><p><code>LocalDateTime</code></p></td></tr></tbody></table>

XSD:

```XML
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"  xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="Root">
        <xs:complexType>
            <xs:all>
                <xs:element name="string" type="xs:string"/>
                <xs:element name="normalizedString" type="xs:normalizedString"/>


                <xs:element name="integer" type="xs:integer"/>
                <xs:element name="negativeInteger" type="xs:negativeInteger"/>
                <xs:element name="int" type="xs:int"/>
                <xs:element name="unsignedInt" type="xs:unsignedInt"/>
                <xs:element name="unsignedLong" type="xs:unsignedLong"/>
                <xs:element name="unsignedShort" type="xs:unsignedShort"/>
                <xs:element name="float" type="xs:float"/>
                <xs:element name="double" type="xs:double"/>


                <xs:element name="date" type="xs:date"/>
                <xs:element name="dateTime" type="xs:dateTime"/>
                <xs:element name="time" type="xs:time"/>


                <xs:element name="boolean" type="xs:boolean"/>


                <xs:element name="hexBinary" type="xs:hexBinary"/>
                <xs:element name="base64Binary" type="xs:base64Binary"/>
                <xs:element name="decimal" type="xs:decimal"/>








            </xs:all>
        </xs:complexType>
    </xs:element>
</xs:schema>
```

Generated DataWeave Module:

```dataweave
%dw 2.0


type RootElementDefinition = {| Root: { string: String, normalizedString: String, integer: Number, negativeInteger: Number, int: Number, unsignedInt: Number, unsignedLong: Number, unsignedShort: Number, float: Number, double: Number, date: LocalDateTime, dateTime: DateTime, time: Time, boolean: Boolean, hexBinary: Binary, base64Binary: Binary, decimal: Number } |}


type Root = RootElementDefinition
```

### Root Elements Declaration

Each root element (`<xs:element>`) declared in your XSD file generates the following:

- A DataWeave `type` directive with the element name followed by the `ElementDefinition` extension

- A `type` directive named `Root` as a `Union` type that consists of all the root elements in the
  XSD.

The following example shows how to declare root elements:

XSD:

```XML
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">


    <xs:element name="Root">
        <xs:complexType>
            <xs:sequence>
                <xs:element type="xs:string" name="color" default="Red"/>
                <xs:element type="xs:integer" name="age" default="12"/>
            </xs:sequence>
            <xs:attribute type="xs:string" name="type" default="ALBA"/>
        </xs:complexType>
    </xs:element>


    <xs:element name="AnotherRoot">
        <xs:complexType>
            <xs:sequence>
                <xs:element type="xs:string" name="name" default="Red"/>
            </xs:sequence>
            <xs:attribute type="xs:string" name="type"/>
        </xs:complexType>
    </xs:element>
</xs:schema>
```

Generated DataWeave Module:

```dataweave
%dw 2.0


type AnotherRootElementDefinition = {| AnotherRoot @("type"?: String): {- name: String -} |}


type RootElementDefinition = {| Root @("type"?: String): {- color: String, age: Number -} |}


type Root = AnotherRootElementDefinition | RootElementDefinition
```

### Complex Types

Named complex types declared as top-level elements on the schema which are referenced in your schema
or are available for reuse on other structures generate their own type directive. These type
directive names include `complextype` name followed by the `Definition` extension.

The following example shows how to declare complex types:

XSD:

```XML
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"
           xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="Root">
        <xs:complexType>
            <xs:choice>
                <xs:element name="employee" type="employee"/>
                <xs:element name="member" type="member"/>
            </xs:choice>
            <xs:attribute name="id" default="foo"/>
        </xs:complexType>
    </xs:element>
    <xs:complexType name="employee">
        <xs:sequence>
            <xs:element name="name" type="xs:string"/>
        </xs:sequence>
    </xs:complexType>


    <xs:complexType name="member">
        <xs:sequence>
            <xs:element name="id" type="xs:string"/>
        </xs:sequence>
    </xs:complexType>
</xs:schema>
```

Generated DataWeave Module:

```dataweave
%dw 2.0


type EmployeeDefinition = { employee: {- name: String -} }


type MemberDefinition = { member: {- id: String -} }


type RootElementDefinition = {| Root @(id?: String): {| employee: EmployeeDefinition.employee |} | {| member: MemberDefinition.member |} |}


type Root = RootElementDefinition
```

### Imports/Includes

The use of imports or includes in an XSD schema file results in a DataWeave module which contains an
`import` directive that uses the XML schema module loader to point to the schema file located at the
specified `schemaLocation`. This location must be declared relative to the main schema. Notice how
the following examples use [Selecting Types](https://docs.mulesoft.com/dataweave/2.9/dataweave-selecting-types):

XSD:

```XML
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
						xmlns:common="http://common.com/COMMON">


	<xsd:import schemaLocation="common.xsd" namespace="http://common.com/COMMON" />


	<xsd:element name="Root" type="common:RequestHeader"/>


</xsd:schema>
```

Generated DataWeave Module:

```dataweave
%dw 2.0


ns ns0 http://common.com/COMMON


import xmlschema!org::mule::weave::v2::module::xmlschema::moduleloader::imports::common


type RootElementDefinition = {| Root: common::RequestHeaderDefinition.ns0#RequestHeader |}


type Root = RootElementDefinition
```

### Choice

You can map this XML schema structure to `UnionType` in DataWeave:

XSD:

```XML
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"
           xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="Root">
        <xs:complexType>
            <xs:choice>
                <xs:element name="employee" type="employee"/>
                <xs:element name="member" type="member"/>
            </xs:choice>
        </xs:complexType>
    </xs:element>
    <xs:complexType name="employee">
        <xs:sequence>
            <xs:element name="name" type="xs:string"/>
        </xs:sequence>
    </xs:complexType>


    <xs:complexType name="member">
        <xs:sequence>
            <xs:element name="id" type="xs:string"/>
        </xs:sequence>
    </xs:complexType>
</xs:schema>
```

Generated DataWeave Module:

```dataweave
%dw 2.0


type EmployeeDefinition = { employee: {- name: String -} }


type MemberDefinition = { member: {- id: String -} }


type RootElementDefinition = {| Root: {| employee: EmployeeDefinition.employee |} | {| member: MemberDefinition.member |} |}


type Root = RootElementDefinition
```

### Namespaces

Namespaces in your XML schema file translate directly to DataWeave type directives.

The following example shows how to set the specific `targetNamespace` attribute where your elements
exist. This namespace, which translates to DataWeave, is required to select and navigate these
types.

XSD:

```XML
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xs:schema attributeFormDefault="unqualified" targetNamespace="http://NamespaceTest.com/CommonTypes" elementFormDefault="qualified"  xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="Root">
        <xs:complexType>
            <xs:all>
                <xs:element name="string" type="xs:string"/>
                <xs:element name="normalizedString" type="xs:normalizedString"/>
                <xs:element name="integer" type="xs:integer"/>
                <xs:element name="negativeInteger" type="xs:negativeInteger"/>
                <xs:element name="int" type="xs:int"/>
                <xs:element name="unsignedInt" type="xs:unsignedInt"/>
                <xs:element name="unsignedLong" type="xs:unsignedLong"/>
                <xs:element name="unsignedShort" type="xs:unsignedShort"/>
                <xs:element name="float" type="xs:float"/>
                <xs:element name="double" type="xs:double"/>
                <xs:element name="date" type="xs:date"/>
                <xs:element name="dateTime" type="xs:dateTime"/>
                <xs:element name="time" type="xs:time"/>
                <xs:element name="boolean" type="xs:boolean"/>
                <xs:element name="hexBinary" type="xs:hexBinary"/>
                <xs:element name="base64Binary" type="xs:base64Binary"/>
                <xs:element name="decimal" type="xs:decimal"/>
            </xs:all>
        </xs:complexType>
    </xs:element>
</xs:schema>
```

Generated DataWeave Module:

```dataweave
%dw 2.0


ns ns0 http://NamespaceTest.com/CommonTypes


type RootElementDefinition = {| ns0#Root: { ns0#string: String, ns0#normalizedString: String, ns0#integer: Number, ns0#negativeInteger: Number, ns0#int: Number, ns0#unsignedInt: Number, ns0#unsignedLong: Number, ns0#unsignedShort: Number, ns0#float: Number, ns0#double: Number, ns0#date: LocalDateTime, ns0#dateTime: DateTime, ns0#time: Time, ns0#boolean: Boolean, ns0#hexBinary: Binary, ns0#base64Binary: Binary, ns0#decimal: Number } |}


type Root = RootElementDefinition
```

<!-- document id=2a000e1ce185d41deb7ffe0503c937ea71581b0736337363484bd8895eb9d9a8 url=/mulesoft/current/en-us/dataweave/latest/dataweave-type-reuse-xml-schema.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Reusing an XML Schema

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You can import XML schema files (`.xsd`) in your DataWeave script as modules by using the
`xmlschema!` module loader. This loader enables you to use types that are declared in your schema in
DataWeave directly. DataWeave loads your XSD file and translates declarations in your file into
DataWeave type directives that you can access in the same way as types from any other DataWeave
module. Use the directives to build new types, type-check your variables, match patterns, or declare
new functions that use types. DataWeave places no restrictions on how to use these types.

The following example shows how to look for an XSD file in the path `org/weave/myfolder/User.xsd` in
your DataWeave script:

import \* from xmlschema!org::weave::myfolder::User

## Import Syntax

To import the XML schema types, use the following syntax, where:

- `typeToImport`: You can use `*` to import all types defined in the schema, or to import a single
  type from the schema, for example, `Root`. You can also import XML schema types with a different
  name, for example, `Root as Person`. This way you can reference the type with that name in the
  script.

- `pathToXsdSchemaFile`: To specify the path to the schema file, replace the file separators with
  `::` and remove the `.xsd` extension from the file name. For example, if the path to the schema is
  `example/schema/Person.xsd`, use `example::schema::Person`.

import \_typesToImport\_ from xmlschema!\_pathToXsdSchemaFile\_

The following example shows how to import a type:

import \* from xmlschema!example::schema::Person

## Use Your Types in a DataWeave Script

This example shows how to use types to import XML schema files into your DataWeave script.

XSD File (`User.xsd`):

```XML
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"
           xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="Root">
        <xs:complexType>
            <xs:choice>
                <xs:element name="employee" type="employee"/>
                <xs:element name="member" type="member"/>
            </xs:choice>
            <xs:attribute name="id" use="required"/>
        </xs:complexType>
    </xs:element>
    <xs:complexType name="employee">
        <xs:sequence>
            <xs:element name="name" type="xs:string"/>
        </xs:sequence>
    </xs:complexType>


    <xs:complexType name="member">
        <xs:sequence>
            <xs:element name="id" type="xs:string"/>
        </xs:sequence>
    </xs:complexType>
</xs:schema>
```

DataWeave Script:

```dataweave
%dw 2.0
import * from xmlschema!org::weave::myfolder::User


{
      Root @(id:"test") :{
        employee: {
            "name": "Mariano"
        }
      } match {
             case is Root -> true
             else -> false
        }
}
```

## From the XML Model to DataWeave Types

Because the XML schema type system translates to DataWeave type directives and the two type models
are different, the resulting DataWeave type might not represent exactly the same XML model. The
following files illustrate how XSD translates to DataWeave code. These files are generated
dynamically and are not visible, though they are useful for learning how to consume types from
generated XSD files.

### Built-in XML Schema Types

DataWeave supports the following XSD types where `xs` is the XMLSchema default namespace:

<table><colgroup><col> <col></colgroup><thead><tr><th>XSD Type</th><th>Dataweave Type</th></tr></thead><tbody><tr><td><p><code>xs:number</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:int</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:integer</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:long</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:short</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:byte</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:double</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:decimal</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:unsignedLong</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:unsignedInt</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:unsignedShort</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:unsignedByte</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:positiveInteger</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:negativeInteger</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:nonNegativeInteger</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:nonPositiveInteger</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>xs:hexBinary</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>xs:base64Binary</code></p></td><td><p><code>Binary</code></p></td></tr><tr><td><p><code>xs:boolean</code></p></td><td><p><code>Boolean</code></p></td></tr><tr><td><p><code>xs:any</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>xs:string</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>xs:normalizedString</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>xs:datetime</code></p></td><td><p><code>DateTime</code></p></td></tr><tr><td><p><code>xs:time</code></p></td><td><p><code>Time</code></p></td></tr><tr><td><p><code>xs:date</code></p></td><td><p><code>LocalDateTime</code></p></td></tr></tbody></table>

XSD:

```XML
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"  xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="Root">
        <xs:complexType>
            <xs:all>
                <xs:element name="string" type="xs:string"/>
                <xs:element name="normalizedString" type="xs:normalizedString"/>


                <xs:element name="integer" type="xs:integer"/>
                <xs:element name="negativeInteger" type="xs:negativeInteger"/>
                <xs:element name="int" type="xs:int"/>
                <xs:element name="unsignedInt" type="xs:unsignedInt"/>
                <xs:element name="unsignedLong" type="xs:unsignedLong"/>
                <xs:element name="unsignedShort" type="xs:unsignedShort"/>
                <xs:element name="float" type="xs:float"/>
                <xs:element name="double" type="xs:double"/>


                <xs:element name="date" type="xs:date"/>
                <xs:element name="dateTime" type="xs:dateTime"/>
                <xs:element name="time" type="xs:time"/>


                <xs:element name="boolean" type="xs:boolean"/>


                <xs:element name="hexBinary" type="xs:hexBinary"/>
                <xs:element name="base64Binary" type="xs:base64Binary"/>
                <xs:element name="decimal" type="xs:decimal"/>








            </xs:all>
        </xs:complexType>
    </xs:element>
</xs:schema>
```

Generated DataWeave Module:

```dataweave
%dw 2.0


type RootElementDefinition = {| Root: { string: String, normalizedString: String, integer: Number, negativeInteger: Number, int: Number, unsignedInt: Number, unsignedLong: Number, unsignedShort: Number, float: Number, double: Number, date: LocalDateTime, dateTime: DateTime, time: Time, boolean: Boolean, hexBinary: Binary, base64Binary: Binary, decimal: Number } |}


type Root = RootElementDefinition
```

### Root Elements Declaration

Each root element (`<xs:element>`) declared in your XSD file generates the following:

- A DataWeave `type` directive with the element name followed by the `ElementDefinition` extension

- A `type` directive named `Root` as a `Union` type that consists of all the root elements in the
  XSD.

The following example shows how to declare root elements:

XSD:

```XML
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">


    <xs:element name="Root">
        <xs:complexType>
            <xs:sequence>
                <xs:element type="xs:string" name="color" default="Red"/>
                <xs:element type="xs:integer" name="age" default="12"/>
            </xs:sequence>
            <xs:attribute type="xs:string" name="type" default="ALBA"/>
        </xs:complexType>
    </xs:element>


    <xs:element name="AnotherRoot">
        <xs:complexType>
            <xs:sequence>
                <xs:element type="xs:string" name="name" default="Red"/>
            </xs:sequence>
            <xs:attribute type="xs:string" name="type"/>
        </xs:complexType>
    </xs:element>
</xs:schema>
```

Generated DataWeave Module:

```dataweave
%dw 2.0


type AnotherRootElementDefinition = {| AnotherRoot @("type"?: String): {- name: String -} |}


type RootElementDefinition = {| Root @("type"?: String): {- color: String, age: Number -} |}


type Root = AnotherRootElementDefinition | RootElementDefinition
```

### Complex Types

Named complex types declared as top-level elements on the schema which are referenced in your schema
or are available for reuse on other structures generate their own type directive. These type
directive names include `complextype` name followed by the `Definition` extension.

The following example shows how to declare complex types:

XSD:

```XML
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"
           xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="Root">
        <xs:complexType>
            <xs:choice>
                <xs:element name="employee" type="employee"/>
                <xs:element name="member" type="member"/>
            </xs:choice>
            <xs:attribute name="id" default="foo"/>
        </xs:complexType>
    </xs:element>
    <xs:complexType name="employee">
        <xs:sequence>
            <xs:element name="name" type="xs:string"/>
        </xs:sequence>
    </xs:complexType>


    <xs:complexType name="member">
        <xs:sequence>
            <xs:element name="id" type="xs:string"/>
        </xs:sequence>
    </xs:complexType>
</xs:schema>
```

Generated DataWeave Module:

```dataweave
%dw 2.0


type EmployeeDefinition = { employee: {- name: String -} }


type MemberDefinition = { member: {- id: String -} }


type RootElementDefinition = {| Root @(id?: String): {| employee: EmployeeDefinition.employee |} | {| member: MemberDefinition.member |} |}


type Root = RootElementDefinition
```

### Imports/Includes

The use of imports or includes in an XSD schema file results in a DataWeave module which contains an
`import` directive that uses the XML schema module loader to point to the schema file located at the
specified `schemaLocation`. This location must be declared relative to the main schema. Notice how
the following examples use [Selecting Types](https://docs.mulesoft.com/dataweave/latest/dataweave-selecting-types):

XSD:

```XML
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
						xmlns:common="http://common.com/COMMON">


	<xsd:import schemaLocation="common.xsd" namespace="http://common.com/COMMON" />


	<xsd:element name="Root" type="common:RequestHeader"/>


</xsd:schema>
```

Generated DataWeave Module:

```dataweave
%dw 2.0


ns ns0 http://common.com/COMMON


import xmlschema!org::mule::weave::v2::module::xmlschema::moduleloader::imports::common


type RootElementDefinition = {| Root: common::RequestHeaderDefinition.ns0#RequestHeader |}


type Root = RootElementDefinition
```

### Choice

You can map this XML schema structure to `UnionType` in DataWeave:

XSD:

```XML
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"
           xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="Root">
        <xs:complexType>
            <xs:choice>
                <xs:element name="employee" type="employee"/>
                <xs:element name="member" type="member"/>
            </xs:choice>
        </xs:complexType>
    </xs:element>
    <xs:complexType name="employee">
        <xs:sequence>
            <xs:element name="name" type="xs:string"/>
        </xs:sequence>
    </xs:complexType>


    <xs:complexType name="member">
        <xs:sequence>
            <xs:element name="id" type="xs:string"/>
        </xs:sequence>
    </xs:complexType>
</xs:schema>
```

Generated DataWeave Module:

```dataweave
%dw 2.0


type EmployeeDefinition = { employee: {- name: String -} }


type MemberDefinition = { member: {- id: String -} }


type RootElementDefinition = {| Root: {| employee: EmployeeDefinition.employee |} | {| member: MemberDefinition.member |} |}


type Root = RootElementDefinition
```

### Namespaces

Namespaces in your XML schema file translate directly to DataWeave type directives.

The following example shows how to set the specific `targetNamespace` attribute where your elements
exist. This namespace, which translates to DataWeave, is required to select and navigate these
types.

XSD:

```XML
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xs:schema attributeFormDefault="unqualified" targetNamespace="http://NamespaceTest.com/CommonTypes" elementFormDefault="qualified"  xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="Root">
        <xs:complexType>
            <xs:all>
                <xs:element name="string" type="xs:string"/>
                <xs:element name="normalizedString" type="xs:normalizedString"/>
                <xs:element name="integer" type="xs:integer"/>
                <xs:element name="negativeInteger" type="xs:negativeInteger"/>
                <xs:element name="int" type="xs:int"/>
                <xs:element name="unsignedInt" type="xs:unsignedInt"/>
                <xs:element name="unsignedLong" type="xs:unsignedLong"/>
                <xs:element name="unsignedShort" type="xs:unsignedShort"/>
                <xs:element name="float" type="xs:float"/>
                <xs:element name="double" type="xs:double"/>
                <xs:element name="date" type="xs:date"/>
                <xs:element name="dateTime" type="xs:dateTime"/>
                <xs:element name="time" type="xs:time"/>
                <xs:element name="boolean" type="xs:boolean"/>
                <xs:element name="hexBinary" type="xs:hexBinary"/>
                <xs:element name="base64Binary" type="xs:base64Binary"/>
                <xs:element name="decimal" type="xs:decimal"/>
            </xs:all>
        </xs:complexType>
    </xs:element>
</xs:schema>
```

Generated DataWeave Module:

```dataweave
%dw 2.0


ns ns0 http://NamespaceTest.com/CommonTypes


type RootElementDefinition = {| ns0#Root: { ns0#string: String, ns0#normalizedString: String, ns0#integer: Number, ns0#negativeInteger: Number, ns0#int: Number, ns0#unsignedInt: Number, ns0#unsignedLong: Number, ns0#unsignedShort: Number, ns0#float: Number, ns0#double: Number, ns0#date: LocalDateTime, ns0#dateTime: DateTime, ns0#time: Time, ns0#boolean: Boolean, ns0#hexBinary: Binary, ns0#base64Binary: Binary, ns0#decimal: Number } |}


type Root = RootElementDefinition
```

<!-- document id=91f5dd0fd8b36b4028887432977f23256551f7966054d14398e8ea6d02813f0a url=/mulesoft/current/en-us/dataweave/2.11/dataweave-type-reuse-json-schema.md -->

---
product: DataWeave
version: 2.11
---

# Reusing Types from a JSON Schema

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

JSON Schema is a standard that provides a format for the JSON data required for a given application
and how to interact with it. Many existing data formats or types are expressed using this standard.
In particular, REST APIs described by RAML files are likely to have their types defined in JSON
schemas.

To reuse predefined types, you can load the JSON schema into DataWeave to make the types structure
available for use in your scripts.

The JSON schema loader parses schemas using the
[JSON Schema Draft 7ˆ](https://json-schema.org/specification-links#draft-7).

## Import a Type from a JSON Schema

The following example shows a JSON schema (`Person.json`) in the resources directory:

JSON Schema (`example/schema/Person.json`):

```JSON
{
  "$id": "https://example.com/person.schema.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Person",
  "type": "object",
  "properties": {
    "firstName": {
      "type": "string",
      "description": "The person's first name."
    },
    "lastName": {
      "type": "string",
      "description": "The person's last name."
    },
    "age": {
      "description": "Age in years, which must be equal to or greater than zero.",
      "type": "integer",
      "minimum": 0
    }
  },
  "required": ["firstName", "lastName"]
}
```

The following example shows how to import the type using the JSON schema loader:

DataWeave Script Header:

import \* from jsonschema!example::schema::Person

## Import Syntax

To import JSON schema types, use the following syntax, where:

- `typeToImport`: You can use `*` alone to import all types defined in the schema or you can import
  a single type from the schema using, for example, `Root`. You can also import JSON schema types
  with a different name, for example, `Root as Person`, which enables you to reference the type with
  that name in the script.

- `pathToJsonSchema`: To specify the path to the schema file, replace the file separators with `::`
  and remove the `.json` extension from the file name. For example, if the path to the schema is
  `example/schema/Person.json`, use `example::schema::Person`.

import \_typesToImport\_ from jsonschema!\_pathToJsonSchema\_

The following example shows how to import a type:

import \* from jsonschema!example::schema::Person

## Use Your Types in a DataWeave Script

Including the import directive from the above example in the script header loads all the existing
types in the JSON schema. In `import * from jsonschema!example::schema::Person`, the only existing
type is the `Root` type, specified at the root which describes an Object that can have three
properties (`firstName`, `lastName`, and `age`). This is equivalent to declaring the following type
in your DataWeave script:

DataWeave Script:

```dataweave
%dw 2.0
type Root = { firstName: String, lastName: String, age?: Number }
```

Notice that `age` is the only optional field, as indicated by the `?`.

You can use the type to determine if a value follows the structure defined by the JSON schema. The
following example outputs the value `true` because the object contains the required fields,
`firstName` and `lastName`:

DataWeave Script:

```dataweave
%dw 2.0
import * from jsonschema!example::schema::Person
---
{
 firstName: "John",
 lastName: "Doe"
} is Root
```

Output:

"true"

The following example outputs the value `false` because the object doesn’t contain the required
fields, `firstName` and `lastName`:

DataWeave Script:

```dataweave
%dw 2.0
import * from jsonschema!example::schema::Person
---
{
 firstName: "John",
 age: 20
} is Root
```

Output:

"false"

## Use Definitions inside Schemas

DataWave loads the definitions inside JSON schemas when the module is imported:

JSON Schema (`example/schema/Account.json`):

```JSON
{
 "$schema": "http://json-schema.org/draft-04/schema#",
 "definitions": {
   "address": {
     "type": "object",
     "properties": {
       "street_address": {
         "type": "string"
       },
       "city": {
         "type": "string"
       },
       "state": {
         "type": "string"
       }
     },
     "required": [
       "street_address",
       "city",
       "state"
     ]
   },
   "person": {
     "type": "object",
     "properties": {
       "firstName": {
         "type": "string",
         "description": "The person's first name."
       },
       "lastName": {
         "type": "string",
         "description": "The person's last name."
       },
       "age": {
         "description": "Age in years, which must be equal to or greater than zero.",
         "type": "integer",
         "minimum": 0
       }
     },
     "required": [
       "firstName",
       "lastName"
     ]
   }
 },
 "type": "object",
 "properties": {
   "person": {
     "$ref": "#/definitions/person"
   },
   "address": {
     "$ref": "#/definitions/address"
   }
 }
}
```

You can import the types from that schema with the following directive:

import \* from jsonschema!example::schema::Account

The types defined in the schema have the same effect as declaring the following types:

type Root = { address?: address, person?: person }

type address = { street\_address: String, city: String, state: String }

type person = { firstName: String, lastName: String, age?: Number }

Use the import directive to import a single type from the schema:

import address from jsonschema!example::schema::Account

To avoid type-name collision, you can use the `as` keyword to change the imported type name to
another name:

import address as Account\_Address from jsonschema!example::schema::Account

## Facilitate Usage with Pattern Matching

You can use the types imported from the JSON schemas to take a specific action when an input is of a
certain type. These imported types are useful for pattern matching.

The following example outputs the value `person` because the object is importing that type
definition:

DataWeave Script:

```dataweave
%dw 2.0
import * from jsonschema!example::schema::Account
---
{
 firstName: "John",
 lastName: "Doe"
} match {
case is person -> "PERSON"
case is address -> "ADDRESS"
else -> "NO TYPE MATCHED"
}
```

Output:

"PERSON"

The following example outputs the value `address` because the object is importing that type
definition:

DataWeave Script:

```dataweave
%dw 2.0
import * from jsonschema!example::schema::Account
---
{
 street_address: "742 Evergreen Terrace",
 city: "Gotham",
 State: "OH"
} match {
case is person -> "PERSON"
case is address -> "ADDRESS"
else -> "NO TYPE MATCHED"
}
```

Output:

"ADDRESS"

### Built-in JSON Schema Types

DataWeave supports the following JSON schema types transformed into DataWeave types:

<table><colgroup><col> <col></colgroup><thead><tr><th>JSON Schema Type</th><th>DataWeave Type</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>integer</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>string</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>boolean</code></p></td><td><p><code>Boolean</code></p></td></tr><tr><td><p><code>array</code></p></td><td><p><code>Array</code></p></td></tr><tr><td><p><code>enums</code></p></td><td><p><code>Union</code></p></td></tr><tr><td><p><code>null</code></p></td><td><p><code>Null</code></p></td></tr><tr><td><p><code>object</code></p></td><td><p><code>Object</code></p></td></tr></tbody></table>

### Limitations

- DataWeave doesn’t support formats on JSON schema string types and transforms these types to
  `String` without any validation or restriction.

- DataWeave doesn’t support restrictions on number types such as maximums or minimums and transforms
  these types to `Number` without any validation or restriction.

- DataWeave doesn’t support patterns.

### Object types

DataWeave marks non-required properties in JSON Schema object types as optional properties in the
DataWeave Object type.

The following example outputs a DataWeave type:

JSON schema:

```JSON
{
  "type": "object",
  "properties": {
    "name":      { "type": "string" },
    "email":     { "type": "string" },
    "address":   { "type": "string" },
    "telephone": { "type": "string" }
  },
  "required": ["name", "email"]
}
```

Output:

```dataweave
%dw 2.0
type Root = { address?: String, name: String, telephone?: String, email: String }
```

If additional properties are allowed, DataWeave produces an open Object definition.

The following example outputs a DataWeave type:

JSON schema:

```JSON
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "number":      { "type": "number" },
    "street_name": { "type": "string" },
    "street_type": { "type": "string",
      "enum": ["Street", "Avenue", "Boulevard"]
    }
  },
  "required": ["number"],
  "additionalProperties": true
}
```

Output:

```dataweave
%dw 2.0
type Root = { number: Number, street_type?: "Street" | "Avenue" | "Boulevard", street_name?: String }
```

If, on the contrary, additional properties aren’t allowed, DataWeave produces a closed Object
definition.

The following example outputs a DataWeave type:

JSON schema:

```JSON
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "number":      { "type": "number" },
    "street_name": { "type": "string" },
    "street_type": { "type": "string",
      "enum": ["Street", "Avenue", "Boulevard"]
    }
  },
  "required": ["number"],
  "additionalProperties": false
}
```

Output:

```dataweave
%dw 2.0
type Root = {| number: Number, street_type?: "Street" | "Avenue" | "Boulevard", street_name?: String |}
```

### Built-in JSON Schema Support for Subschema Keywords

Using subschema keywords in JSON schema produces complex types based on the provided subschemas.

<table><colgroup><col> <col></colgroup><thead><tr><th>JSON Schema Keyword</th><th>DataWeave Type</th></tr></thead><tbody><tr><td><p><code>allOf</code></p></td><td><p><code>Intersection</code></p></td></tr><tr><td><p><code>anyOf</code></p></td><td><p><code>Union</code></p></td></tr><tr><td><p><code>oneOf</code></p></td><td><p><code>Union</code></p></td></tr></tbody></table>

The following example outputs a DataWeave type: .JSON schema:

```JSON
{
  "anyOf": [
    { "type": "string" },
    { "type": "number" }
  ]
}
```

Output:

```dataweave
%dw 2.0
type Root = (String | Number)
```

<!-- document id=edb3ffe134fb242dde6a6a15853737638c1b2baf8df49c3a4ffdfda79c4d361b url=/mulesoft/current/en-us/dataweave/2.12/dataweave-type-reuse-json-schema.md -->

---
product: DataWeave
version: 2.12
---

# Reusing Types from a JSON Schema

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

JSON Schema is a standard that provides a format for the JSON data required for a given application
and how to interact with it. Many existing data formats or types are expressed using this standard.
In particular, REST APIs described by RAML files are likely to have their types defined in JSON
schemas.

To reuse predefined types, you can load the JSON schema into DataWeave to make the types structure
available for use in your scripts.

The JSON schema loader parses schemas using the
[JSON Schema Draft 7ˆ](https://json-schema.org/specification-links#draft-7).

## Import a Type from a JSON Schema

The following example shows a JSON schema (`Person.json`) in the resources directory:

JSON Schema (`example/schema/Person.json`):

```JSON
{
  "$id": "https://example.com/person.schema.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Person",
  "type": "object",
  "properties": {
    "firstName": {
      "type": "string",
      "description": "The person's first name."
    },
    "lastName": {
      "type": "string",
      "description": "The person's last name."
    },
    "age": {
      "description": "Age in years, which must be equal to or greater than zero.",
      "type": "integer",
      "minimum": 0
    }
  },
  "required": ["firstName", "lastName"]
}
```

The following example shows how to import the type using the JSON schema loader:

DataWeave Script Header:

import \* from jsonschema!example::schema::Person

## Import Syntax

To import JSON schema types, use the following syntax, where:

- `typeToImport`: You can use `*` alone to import all types defined in the schema or you can import
  a single type from the schema using, for example, `Root`. You can also import JSON schema types
  with a different name, for example, `Root as Person`, which enables you to reference the type with
  that name in the script.

- `pathToJsonSchema`: To specify the path to the schema file, replace the file separators with `::`
  and remove the `.json` extension from the file name. For example, if the path to the schema is
  `example/schema/Person.json`, use `example::schema::Person`.

import \_typesToImport\_ from jsonschema!\_pathToJsonSchema\_

The following example shows how to import a type:

import \* from jsonschema!example::schema::Person

## Use Your Types in a DataWeave Script

Including the import directive from the above example in the script header loads all the existing
types in the JSON schema. In `import * from jsonschema!example::schema::Person`, the only existing
type is the `Root` type, specified at the root which describes an Object that can have three
properties (`firstName`, `lastName`, and `age`). This is equivalent to declaring the following type
in your DataWeave script:

DataWeave Script:

```dataweave
%dw 2.0
type Root = { firstName: String, lastName: String, age?: Number }
```

Notice that `age` is the only optional field, as indicated by the `?`.

You can use the type to determine if a value follows the structure defined by the JSON schema. The
following example outputs the value `true` because the object contains the required fields,
`firstName` and `lastName`:

DataWeave Script:

```dataweave
%dw 2.0
import * from jsonschema!example::schema::Person
---
{
 firstName: "John",
 lastName: "Doe"
} is Root
```

Output:

"true"

The following example outputs the value `false` because the object doesn’t contain the required
fields, `firstName` and `lastName`:

DataWeave Script:

```dataweave
%dw 2.0
import * from jsonschema!example::schema::Person
---
{
 firstName: "John",
 age: 20
} is Root
```

Output:

"false"

## Use Definitions inside Schemas

DataWave loads the definitions inside JSON schemas when the module is imported:

JSON Schema (`example/schema/Account.json`):

```JSON
{
 "$schema": "http://json-schema.org/draft-04/schema#",
 "definitions": {
   "address": {
     "type": "object",
     "properties": {
       "street_address": {
         "type": "string"
       },
       "city": {
         "type": "string"
       },
       "state": {
         "type": "string"
       }
     },
     "required": [
       "street_address",
       "city",
       "state"
     ]
   },
   "person": {
     "type": "object",
     "properties": {
       "firstName": {
         "type": "string",
         "description": "The person's first name."
       },
       "lastName": {
         "type": "string",
         "description": "The person's last name."
       },
       "age": {
         "description": "Age in years, which must be equal to or greater than zero.",
         "type": "integer",
         "minimum": 0
       }
     },
     "required": [
       "firstName",
       "lastName"
     ]
   }
 },
 "type": "object",
 "properties": {
   "person": {
     "$ref": "#/definitions/person"
   },
   "address": {
     "$ref": "#/definitions/address"
   }
 }
}
```

You can import the types from that schema with the following directive:

import \* from jsonschema!example::schema::Account

The types defined in the schema have the same effect as declaring the following types:

type Root = { address?: address, person?: person }

type address = { street\_address: String, city: String, state: String }

type person = { firstName: String, lastName: String, age?: Number }

Use the import directive to import a single type from the schema:

import address from jsonschema!example::schema::Account

To avoid type-name collision, you can use the `as` keyword to change the imported type name to
another name:

import address as Account\_Address from jsonschema!example::schema::Account

## Facilitate Usage with Pattern Matching

You can use the types imported from the JSON schemas to take a specific action when an input is of a
certain type. These imported types are useful for pattern matching.

The following example outputs the value `person` because the object is importing that type
definition:

DataWeave Script:

```dataweave
%dw 2.0
import * from jsonschema!example::schema::Account
---
{
 firstName: "John",
 lastName: "Doe"
} match {
case is person -> "PERSON"
case is address -> "ADDRESS"
else -> "NO TYPE MATCHED"
}
```

Output:

"PERSON"

The following example outputs the value `address` because the object is importing that type
definition:

DataWeave Script:

```dataweave
%dw 2.0
import * from jsonschema!example::schema::Account
---
{
 street_address: "742 Evergreen Terrace",
 city: "Gotham",
 State: "OH"
} match {
case is person -> "PERSON"
case is address -> "ADDRESS"
else -> "NO TYPE MATCHED"
}
```

Output:

"ADDRESS"

### Built-in JSON Schema Types

DataWeave supports the following JSON schema types transformed into DataWeave types:

<table><colgroup><col> <col></colgroup><thead><tr><th>JSON Schema Type</th><th>DataWeave Type</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>integer</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>string</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>boolean</code></p></td><td><p><code>Boolean</code></p></td></tr><tr><td><p><code>array</code></p></td><td><p><code>Array</code></p></td></tr><tr><td><p><code>enums</code></p></td><td><p><code>Union</code></p></td></tr><tr><td><p><code>null</code></p></td><td><p><code>Null</code></p></td></tr><tr><td><p><code>object</code></p></td><td><p><code>Object</code></p></td></tr></tbody></table>

### Limitations

- DataWeave doesn’t support formats on JSON schema string types and transforms these types to
  `String` without any validation or restriction.

- DataWeave doesn’t support restrictions on number types such as maximums or minimums and transforms
  these types to `Number` without any validation or restriction.

- DataWeave doesn’t support patterns.

### Object types

DataWeave marks non-required properties in JSON Schema object types as optional properties in the
DataWeave Object type.

The following example outputs a DataWeave type:

JSON schema:

```JSON
{
  "type": "object",
  "properties": {
    "name":      { "type": "string" },
    "email":     { "type": "string" },
    "address":   { "type": "string" },
    "telephone": { "type": "string" }
  },
  "required": ["name", "email"]
}
```

Output:

```dataweave
%dw 2.0
type Root = { address?: String, name: String, telephone?: String, email: String }
```

If additional properties are allowed, DataWeave produces an open Object definition.

The following example outputs a DataWeave type:

JSON schema:

```JSON
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "number":      { "type": "number" },
    "street_name": { "type": "string" },
    "street_type": { "type": "string",
      "enum": ["Street", "Avenue", "Boulevard"]
    }
  },
  "required": ["number"],
  "additionalProperties": true
}
```

Output:

```dataweave
%dw 2.0
type Root = { number: Number, street_type?: "Street" | "Avenue" | "Boulevard", street_name?: String }
```

If, on the contrary, additional properties aren’t allowed, DataWeave produces a closed Object
definition.

The following example outputs a DataWeave type:

JSON schema:

```JSON
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "number":      { "type": "number" },
    "street_name": { "type": "string" },
    "street_type": { "type": "string",
      "enum": ["Street", "Avenue", "Boulevard"]
    }
  },
  "required": ["number"],
  "additionalProperties": false
}
```

Output:

```dataweave
%dw 2.0
type Root = {| number: Number, street_type?: "Street" | "Avenue" | "Boulevard", street_name?: String |}
```

### Built-in JSON Schema Support for Subschema Keywords

Using subschema keywords in JSON schema produces complex types based on the provided subschemas.

<table><colgroup><col> <col></colgroup><thead><tr><th>JSON Schema Keyword</th><th>DataWeave Type</th></tr></thead><tbody><tr><td><p><code>allOf</code></p></td><td><p><code>Intersection</code></p></td></tr><tr><td><p><code>anyOf</code></p></td><td><p><code>Union</code></p></td></tr><tr><td><p><code>oneOf</code></p></td><td><p><code>Union</code></p></td></tr></tbody></table>

The following example outputs a DataWeave type: .JSON schema:

```JSON
{
  "anyOf": [
    { "type": "string" },
    { "type": "number" }
  ]
}
```

Output:

```dataweave
%dw 2.0
type Root = (String | Number)
```

<!-- document id=af074cba5b71e8ddb39b9a5670a93988cfbd33e1537a5f1abedb86a90931834e url=/mulesoft/current/en-us/dataweave/2.6/dataweave-type-reuse-json-schema.md -->

---
product: DataWeave
version: 2.6
---

# Reusing Types from a JSON Schema

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

JSON Schema is a standard that provides a format for the JSON data required for a given application
and how to interact with it. Many existing data formats or types are expressed using this standard.
In particular, REST APIs described by RAML files are likely to have their types defined in JSON
schemas.

To reuse predefined types, you can load the JSON schema into DataWeave to make the types structure
available for use in your scripts.

The JSON schema loader parses schemas using the
[JSON Schema Draft 7ˆ](https://json-schema.org/specification-links#draft-7).

## Import a Type from a JSON Schema

The following example shows a JSON schema (`Person.json`) in the resources directory:

JSON Schema (`example/schema/Person.json`):

```JSON
{
  "$id": "https://example.com/person.schema.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Person",
  "type": "object",
  "properties": {
    "firstName": {
      "type": "string",
      "description": "The person's first name."
    },
    "lastName": {
      "type": "string",
      "description": "The person's last name."
    },
    "age": {
      "description": "Age in years, which must be equal to or greater than zero.",
      "type": "integer",
      "minimum": 0
    }
  },
  "required": ["firstName", "lastName"]
}
```

The following example shows how to import the type using the JSON schema loader:

DataWeave Script Header:

import \* from jsonschema!example::schema::Person

## Import Syntax

To import JSON schema types, use the following syntax, where:

- `typeToImport`: You can use `*` alone to import all types defined in the schema or you can import
  a single type from the schema using, for example, `Root`. You can also import JSON schema types
  with a different name, for example, `Root as Person`, which enables you to reference the type with
  that name in the script.

- `pathToJsonSchema`: To specify the path to the schema file, replace the file separators with `::`
  and remove the `.json` extension from the file name. For example, if the path to the schema is
  `example/schema/Person.json`, use `example::schema::Person`.

import \_typesToImport\_ from jsonschema!\_pathToJsonSchema\_

The following example shows how to import a type:

import \* from jsonschema!example::schema::Person

## Use Your Types in a DataWeave Script

Including the import directive from the above example in the script header loads all the existing
types in the JSON schema. In `import * from jsonschema!example::schema::Person`, the only existing
type is the `Root` type, specified at the root which describes an Object that can have three
properties (`firstName`, `lastName`, and `age`). This is equivalent to declaring the following type
in your DataWeave script:

DataWeave Script:

```dataweave
%dw 2.0
type Root = { firstName: String, lastName: String, age?: Number }
```

Notice that `age` is the only optional field, as indicated by the `?`.

You can use the type to determine if a value follows the structure defined by the JSON schema. The
following example outputs the value `true` because the object contains the required fields,
`firstName` and `lastName`:

DataWeave Script:

```dataweave
%dw 2.0
import * from jsonschema!example::schema::Person
---
{
 firstName: "John",
 lastName: "Doe"
} is Root
```

Output:

"true"

The following example outputs the value `false` because the object doesn’t contain the required
fields, `firstName` and `lastName`:

DataWeave Script:

```dataweave
%dw 2.0
import * from jsonschema!example::schema::Person
---
{
 firstName: "John",
 age: 20
} is Root
```

Output:

"false"

## Use Definitions inside Schemas

DataWave loads the definitions inside JSON schemas when the module is imported:

JSON Schema (`example/schema/Account.json`):

```JSON
{
 "$schema": "http://json-schema.org/draft-04/schema#",
 "definitions": {
   "address": {
     "type": "object",
     "properties": {
       "street_address": {
         "type": "string"
       },
       "city": {
         "type": "string"
       },
       "state": {
         "type": "string"
       }
     },
     "required": [
       "street_address",
       "city",
       "state"
     ]
   },
   "person": {
     "type": "object",
     "properties": {
       "firstName": {
         "type": "string",
         "description": "The person's first name."
       },
       "lastName": {
         "type": "string",
         "description": "The person's last name."
       },
       "age": {
         "description": "Age in years, which must be equal to or greater than zero.",
         "type": "integer",
         "minimum": 0
       }
     },
     "required": [
       "firstName",
       "lastName"
     ]
   }
 },
 "type": "object",
 "properties": {
   "person": {
     "$ref": "#/definitions/person"
   },
   "address": {
     "$ref": "#/definitions/address"
   }
 }
}
```

You can import the types from that schema with the following directive:

import \* from jsonschema!example::schema::Account

The types defined in the schema have the same effect as declaring the following types:

type Root = { address?: address, person?: person }

type address = { street\_address: String, city: String, state: String }

type person = { firstName: String, lastName: String, age?: Number }

Use the import directive to import a single type from the schema:

import address from jsonschema!example::schema::Account

To avoid type-name collision, you can use the `as` keyword to change the imported type name to
another name:

import address as Account\_Address from jsonschema!example::schema::Account

## Facilitate Usage with Pattern Matching

You can use the types imported from the JSON schemas to take a specific action when an input is of a
certain type. These imported types are useful for pattern matching.

The following example outputs the value `person` because the object is importing that type
definition:

DataWeave Script:

```dataweave
%dw 2.0
import * from jsonschema!example::schema::Account
---
{
 firstName: "John",
 lastName: "Doe"
} match {
case is person -> "PERSON"
case is address -> "ADDRESS"
else -> "NO TYPE MATCHED"
}
```

Output:

"PERSON"

The following example outputs the value `address` because the object is importing that type
definition:

DataWeave Script:

```dataweave
%dw 2.0
import * from jsonschema!example::schema::Account
---
{
 street_address: "742 Evergreen Terrace",
 city: "Gotham",
 State: "OH"
} match {
case is person -> "PERSON"
case is address -> "ADDRESS"
else -> "NO TYPE MATCHED"
}
```

Output:

"ADDRESS"

### Built-in JSON Schema Types

DataWeave supports the following JSON schema types transformed into DataWeave types:

<table><colgroup><col> <col></colgroup><thead><tr><th>JSON Schema Type</th><th>DataWeave Type</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>integer</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>string</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>boolean</code></p></td><td><p><code>Boolean</code></p></td></tr><tr><td><p><code>array</code></p></td><td><p><code>Array</code></p></td></tr><tr><td><p><code>enums</code></p></td><td><p><code>Union</code></p></td></tr><tr><td><p><code>null</code></p></td><td><p><code>Null</code></p></td></tr><tr><td><p><code>object</code></p></td><td><p><code>Object</code></p></td></tr></tbody></table>

### Limitations

- DataWeave doesn’t support formats on JSON schema string types and transforms these types to
  `String` without any validation or restriction.

- DataWeave doesn’t support restrictions on number types such as maximums or minimums and transforms
  these types to `Number` without any validation or restriction.

- DataWeave doesn’t support patterns.

### Object types

DataWeave marks non-required properties in JSON Schema object types as optional properties in the
DataWeave Object type.

The following example outputs a DataWeave type:

JSON schema:

```JSON
{
  "type": "object",
  "properties": {
    "name":      { "type": "string" },
    "email":     { "type": "string" },
    "address":   { "type": "string" },
    "telephone": { "type": "string" }
  },
  "required": ["name", "email"]
}
```

Output:

```dataweave
%dw 2.0
type Root = { address?: String, name: String, telephone?: String, email: String }
```

If additional properties are allowed, DataWeave produces an open Object definition.

The following example outputs a DataWeave type:

JSON schema:

```JSON
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "number":      { "type": "number" },
    "street_name": { "type": "string" },
    "street_type": { "type": "string",
      "enum": ["Street", "Avenue", "Boulevard"]
    }
  },
  "required": ["number"],
  "additionalProperties": true
}
```

Output:

```dataweave
%dw 2.0
type Root = { number: Number, street_type?: "Street" | "Avenue" | "Boulevard", street_name?: String }
```

If, on the contrary, additional properties aren’t allowed, DataWeave produces a closed Object
definition.

The following example outputs a DataWeave type:

JSON schema:

```JSON
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "number":      { "type": "number" },
    "street_name": { "type": "string" },
    "street_type": { "type": "string",
      "enum": ["Street", "Avenue", "Boulevard"]
    }
  },
  "required": ["number"],
  "additionalProperties": false
}
```

Output:

```dataweave
%dw 2.0
type Root = {| number: Number, street_type?: "Street" | "Avenue" | "Boulevard", street_name?: String |}
```

### Built-in JSON Schema Support for Subschema Keywords

Using subschema keywords in JSON schema produces complex types based on the provided subschemas.

<table><colgroup><col> <col></colgroup><thead><tr><th>JSON Schema Keyword</th><th>DataWeave Type</th></tr></thead><tbody><tr><td><p><code>allOf</code></p></td><td><p><code>Intersection</code></p></td></tr><tr><td><p><code>anyOf</code></p></td><td><p><code>Union</code></p></td></tr><tr><td><p><code>oneOf</code></p></td><td><p><code>Union</code></p></td></tr></tbody></table>

The following example outputs a DataWeave type:

JSON schema:

```JSON
{
  "anyOf": [
    { "type": "string" },
    { "type": "number" }
  ]
}
```

Output:

```dataweave
%dw 2.0
type Root = (String | Number)
```

<!-- document id=d888ca3cb7cb03e8331e1d2723b1bd5c92d183d8921af0131a54309e172b4c17 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-type-reuse-json-schema.md -->

---
product: DataWeave
version: 2.9
---

# Reusing Types from a JSON Schema

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

JSON Schema is a standard that provides a format for the JSON data required for a given application
and how to interact with it. Many existing data formats or types are expressed using this standard.
In particular, REST APIs described by RAML files are likely to have their types defined in JSON
schemas.

To reuse predefined types, you can load the JSON schema into DataWeave to make the types structure
available for use in your scripts.

The JSON schema loader parses schemas using the
[JSON Schema Draft 7ˆ](https://json-schema.org/specification-links#draft-7).

## Import a Type from a JSON Schema

The following example shows a JSON schema (`Person.json`) in the resources directory:

JSON Schema (`example/schema/Person.json`):

```JSON
{
  "$id": "https://example.com/person.schema.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Person",
  "type": "object",
  "properties": {
    "firstName": {
      "type": "string",
      "description": "The person's first name."
    },
    "lastName": {
      "type": "string",
      "description": "The person's last name."
    },
    "age": {
      "description": "Age in years, which must be equal to or greater than zero.",
      "type": "integer",
      "minimum": 0
    }
  },
  "required": ["firstName", "lastName"]
}
```

The following example shows how to import the type using the JSON schema loader:

DataWeave Script Header:

import \* from jsonschema!example::schema::Person

## Import Syntax

To import JSON schema types, use the following syntax, where:

- `typeToImport`: You can use `*` alone to import all types defined in the schema or you can import
  a single type from the schema using, for example, `Root`. You can also import JSON schema types
  with a different name, for example, `Root as Person`, which enables you to reference the type with
  that name in the script.

- `pathToJsonSchema`: To specify the path to the schema file, replace the file separators with `::`
  and remove the `.json` extension from the file name. For example, if the path to the schema is
  `example/schema/Person.json`, use `example::schema::Person`.

import \_typesToImport\_ from jsonschema!\_pathToJsonSchema\_

The following example shows how to import a type:

import \* from jsonschema!example::schema::Person

## Use Your Types in a DataWeave Script

Including the import directive from the above example in the script header loads all the existing
types in the JSON schema. In `import * from jsonschema!example::schema::Person`, the only existing
type is the `Root` type, specified at the root which describes an Object that can have three
properties (`firstName`, `lastName`, and `age`). This is equivalent to declaring the following type
in your DataWeave script:

DataWeave Script:

```dataweave
%dw 2.0
type Root = { firstName: String, lastName: String, age?: Number }
```

Notice that `age` is the only optional field, as indicated by the `?`.

You can use the type to determine if a value follows the structure defined by the JSON schema. The
following example outputs the value `true` because the object contains the required fields,
`firstName` and `lastName`:

DataWeave Script:

```dataweave
%dw 2.0
import * from jsonschema!example::schema::Person
---
{
 firstName: "John",
 lastName: "Doe"
} is Root
```

Output:

"true"

The following example outputs the value `false` because the object doesn’t contain the required
fields, `firstName` and `lastName`:

DataWeave Script:

```dataweave
%dw 2.0
import * from jsonschema!example::schema::Person
---
{
 firstName: "John",
 age: 20
} is Root
```

Output:

"false"

## Use Definitions inside Schemas

DataWave loads the definitions inside JSON schemas when the module is imported:

JSON Schema (`example/schema/Account.json`):

```JSON
{
 "$schema": "http://json-schema.org/draft-04/schema#",
 "definitions": {
   "address": {
     "type": "object",
     "properties": {
       "street_address": {
         "type": "string"
       },
       "city": {
         "type": "string"
       },
       "state": {
         "type": "string"
       }
     },
     "required": [
       "street_address",
       "city",
       "state"
     ]
   },
   "person": {
     "type": "object",
     "properties": {
       "firstName": {
         "type": "string",
         "description": "The person's first name."
       },
       "lastName": {
         "type": "string",
         "description": "The person's last name."
       },
       "age": {
         "description": "Age in years, which must be equal to or greater than zero.",
         "type": "integer",
         "minimum": 0
       }
     },
     "required": [
       "firstName",
       "lastName"
     ]
   }
 },
 "type": "object",
 "properties": {
   "person": {
     "$ref": "#/definitions/person"
   },
   "address": {
     "$ref": "#/definitions/address"
   }
 }
}
```

You can import the types from that schema with the following directive:

import \* from jsonschema!example::schema::Account

The types defined in the schema have the same effect as declaring the following types:

type Root = { address?: address, person?: person }

type address = { street\_address: String, city: String, state: String }

type person = { firstName: String, lastName: String, age?: Number }

Use the import directive to import a single type from the schema:

import address from jsonschema!example::schema::Account

To avoid type-name collision, you can use the `as` keyword to change the imported type name to
another name:

import address as Account\_Address from jsonschema!example::schema::Account

## Facilitate Usage with Pattern Matching

You can use the types imported from the JSON schemas to take a specific action when an input is of a
certain type. These imported types are useful for pattern matching.

The following example outputs the value `person` because the object is importing that type
definition:

DataWeave Script:

```dataweave
%dw 2.0
import * from jsonschema!example::schema::Account
---
{
 firstName: "John",
 lastName: "Doe"
} match {
case is person -> "PERSON"
case is address -> "ADDRESS"
else -> "NO TYPE MATCHED"
}
```

Output:

"PERSON"

The following example outputs the value `address` because the object is importing that type
definition:

DataWeave Script:

```dataweave
%dw 2.0
import * from jsonschema!example::schema::Account
---
{
 street_address: "742 Evergreen Terrace",
 city: "Gotham",
 State: "OH"
} match {
case is person -> "PERSON"
case is address -> "ADDRESS"
else -> "NO TYPE MATCHED"
}
```

Output:

"ADDRESS"

### Built-in JSON Schema Types

DataWeave supports the following JSON schema types transformed into DataWeave types:

<table><colgroup><col> <col></colgroup><thead><tr><th>JSON Schema Type</th><th>DataWeave Type</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>integer</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>string</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>boolean</code></p></td><td><p><code>Boolean</code></p></td></tr><tr><td><p><code>array</code></p></td><td><p><code>Array</code></p></td></tr><tr><td><p><code>enums</code></p></td><td><p><code>Union</code></p></td></tr><tr><td><p><code>null</code></p></td><td><p><code>Null</code></p></td></tr><tr><td><p><code>object</code></p></td><td><p><code>Object</code></p></td></tr></tbody></table>

### Limitations

- DataWeave doesn’t support formats on JSON schema string types and transforms these types to
  `String` without any validation or restriction.

- DataWeave doesn’t support restrictions on number types such as maximums or minimums and transforms
  these types to `Number` without any validation or restriction.

- DataWeave doesn’t support patterns.

### Object types

DataWeave marks non-required properties in JSON Schema object types as optional properties in the
DataWeave Object type.

The following example outputs a DataWeave type:

JSON schema:

```JSON
{
  "type": "object",
  "properties": {
    "name":      { "type": "string" },
    "email":     { "type": "string" },
    "address":   { "type": "string" },
    "telephone": { "type": "string" }
  },
  "required": ["name", "email"]
}
```

Output:

```dataweave
%dw 2.0
type Root = { address?: String, name: String, telephone?: String, email: String }
```

If additional properties are allowed, DataWeave produces an open Object definition.

The following example outputs a DataWeave type:

JSON schema:

```JSON
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "number":      { "type": "number" },
    "street_name": { "type": "string" },
    "street_type": { "type": "string",
      "enum": ["Street", "Avenue", "Boulevard"]
    }
  },
  "required": ["number"],
  "additionalProperties": true
}
```

Output:

```dataweave
%dw 2.0
type Root = { number: Number, street_type?: "Street" | "Avenue" | "Boulevard", street_name?: String }
```

If, on the contrary, additional properties aren’t allowed, DataWeave produces a closed Object
definition.

The following example outputs a DataWeave type:

JSON schema:

```JSON
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "number":      { "type": "number" },
    "street_name": { "type": "string" },
    "street_type": { "type": "string",
      "enum": ["Street", "Avenue", "Boulevard"]
    }
  },
  "required": ["number"],
  "additionalProperties": false
}
```

Output:

```dataweave
%dw 2.0
type Root = {| number: Number, street_type?: "Street" | "Avenue" | "Boulevard", street_name?: String |}
```

### Built-in JSON Schema Support for Subschema Keywords

Using subschema keywords in JSON schema produces complex types based on the provided subschemas.

<table><colgroup><col> <col></colgroup><thead><tr><th>JSON Schema Keyword</th><th>DataWeave Type</th></tr></thead><tbody><tr><td><p><code>allOf</code></p></td><td><p><code>Intersection</code></p></td></tr><tr><td><p><code>anyOf</code></p></td><td><p><code>Union</code></p></td></tr><tr><td><p><code>oneOf</code></p></td><td><p><code>Union</code></p></td></tr></tbody></table>

The following example outputs a DataWeave type: .JSON schema:

```JSON
{
  "anyOf": [
    { "type": "string" },
    { "type": "number" }
  ]
}
```

Output:

```dataweave
%dw 2.0
type Root = (String | Number)
```

<!-- document id=bade9ce581d02aca380eab8bbb229ffcb3b165a9e27ea5fade725925945b020e url=/mulesoft/current/en-us/dataweave/latest/dataweave-type-reuse-json-schema.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Reusing Types from a JSON Schema

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

JSON Schema is a standard that provides a format for the JSON data required for a given application
and how to interact with it. Many existing data formats or types are expressed using this standard.
In particular, REST APIs described by RAML files are likely to have their types defined in JSON
schemas.

To reuse predefined types, you can load the JSON schema into DataWeave to make the types structure
available for use in your scripts.

The JSON schema loader parses schemas using the
[JSON Schema Draft 7ˆ](https://json-schema.org/specification-links#draft-7).

## Import a Type from a JSON Schema

The following example shows a JSON schema (`Person.json`) in the resources directory:

JSON Schema (`example/schema/Person.json`):

```JSON
{
  "$id": "https://example.com/person.schema.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Person",
  "type": "object",
  "properties": {
    "firstName": {
      "type": "string",
      "description": "The person's first name."
    },
    "lastName": {
      "type": "string",
      "description": "The person's last name."
    },
    "age": {
      "description": "Age in years, which must be equal to or greater than zero.",
      "type": "integer",
      "minimum": 0
    }
  },
  "required": ["firstName", "lastName"]
}
```

The following example shows how to import the type using the JSON schema loader:

DataWeave Script Header:

import \* from jsonschema!example::schema::Person

## Import Syntax

To import JSON schema types, use the following syntax, where:

- `typeToImport`: You can use `*` alone to import all types defined in the schema or you can import
  a single type from the schema using, for example, `Root`. You can also import JSON schema types
  with a different name, for example, `Root as Person`, which enables you to reference the type with
  that name in the script.

- `pathToJsonSchema`: To specify the path to the schema file, replace the file separators with `::`
  and remove the `.json` extension from the file name. For example, if the path to the schema is
  `example/schema/Person.json`, use `example::schema::Person`.

import \_typesToImport\_ from jsonschema!\_pathToJsonSchema\_

The following example shows how to import a type:

import \* from jsonschema!example::schema::Person

## Use Your Types in a DataWeave Script

Including the import directive from the above example in the script header loads all the existing
types in the JSON schema. In `import * from jsonschema!example::schema::Person`, the only existing
type is the `Root` type, specified at the root which describes an Object that can have three
properties (`firstName`, `lastName`, and `age`). This is equivalent to declaring the following type
in your DataWeave script:

DataWeave Script:

```dataweave
%dw 2.0
type Root = { firstName: String, lastName: String, age?: Number }
```

Notice that `age` is the only optional field, as indicated by the `?`.

You can use the type to determine if a value follows the structure defined by the JSON schema. The
following example outputs the value `true` because the object contains the required fields,
`firstName` and `lastName`:

DataWeave Script:

```dataweave
%dw 2.0
import * from jsonschema!example::schema::Person
---
{
 firstName: "John",
 lastName: "Doe"
} is Root
```

Output:

"true"

The following example outputs the value `false` because the object doesn’t contain the required
fields, `firstName` and `lastName`:

DataWeave Script:

```dataweave
%dw 2.0
import * from jsonschema!example::schema::Person
---
{
 firstName: "John",
 age: 20
} is Root
```

Output:

"false"

## Use Definitions inside Schemas

DataWave loads the definitions inside JSON schemas when the module is imported:

JSON Schema (`example/schema/Account.json`):

```JSON
{
 "$schema": "http://json-schema.org/draft-04/schema#",
 "definitions": {
   "address": {
     "type": "object",
     "properties": {
       "street_address": {
         "type": "string"
       },
       "city": {
         "type": "string"
       },
       "state": {
         "type": "string"
       }
     },
     "required": [
       "street_address",
       "city",
       "state"
     ]
   },
   "person": {
     "type": "object",
     "properties": {
       "firstName": {
         "type": "string",
         "description": "The person's first name."
       },
       "lastName": {
         "type": "string",
         "description": "The person's last name."
       },
       "age": {
         "description": "Age in years, which must be equal to or greater than zero.",
         "type": "integer",
         "minimum": 0
       }
     },
     "required": [
       "firstName",
       "lastName"
     ]
   }
 },
 "type": "object",
 "properties": {
   "person": {
     "$ref": "#/definitions/person"
   },
   "address": {
     "$ref": "#/definitions/address"
   }
 }
}
```

You can import the types from that schema with the following directive:

import \* from jsonschema!example::schema::Account

The types defined in the schema have the same effect as declaring the following types:

type Root = { address?: address, person?: person }

type address = { street\_address: String, city: String, state: String }

type person = { firstName: String, lastName: String, age?: Number }

Use the import directive to import a single type from the schema:

import address from jsonschema!example::schema::Account

To avoid type-name collision, you can use the `as` keyword to change the imported type name to
another name:

import address as Account\_Address from jsonschema!example::schema::Account

## Facilitate Usage with Pattern Matching

You can use the types imported from the JSON schemas to take a specific action when an input is of a
certain type. These imported types are useful for pattern matching.

The following example outputs the value `person` because the object is importing that type
definition:

DataWeave Script:

```dataweave
%dw 2.0
import * from jsonschema!example::schema::Account
---
{
 firstName: "John",
 lastName: "Doe"
} match {
case is person -> "PERSON"
case is address -> "ADDRESS"
else -> "NO TYPE MATCHED"
}
```

Output:

"PERSON"

The following example outputs the value `address` because the object is importing that type
definition:

DataWeave Script:

```dataweave
%dw 2.0
import * from jsonschema!example::schema::Account
---
{
 street_address: "742 Evergreen Terrace",
 city: "Gotham",
 State: "OH"
} match {
case is person -> "PERSON"
case is address -> "ADDRESS"
else -> "NO TYPE MATCHED"
}
```

Output:

"ADDRESS"

### Built-in JSON Schema Types

DataWeave supports the following JSON schema types transformed into DataWeave types:

<table><colgroup><col> <col></colgroup><thead><tr><th>JSON Schema Type</th><th>DataWeave Type</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>integer</code></p></td><td><p><code>Number</code></p></td></tr><tr><td><p><code>string</code></p></td><td><p><code>String</code></p></td></tr><tr><td><p><code>boolean</code></p></td><td><p><code>Boolean</code></p></td></tr><tr><td><p><code>array</code></p></td><td><p><code>Array</code></p></td></tr><tr><td><p><code>enums</code></p></td><td><p><code>Union</code></p></td></tr><tr><td><p><code>null</code></p></td><td><p><code>Null</code></p></td></tr><tr><td><p><code>object</code></p></td><td><p><code>Object</code></p></td></tr></tbody></table>

### Limitations

- DataWeave doesn’t support formats on JSON schema string types and transforms these types to
  `String` without any validation or restriction.

- DataWeave doesn’t support restrictions on number types such as maximums or minimums and transforms
  these types to `Number` without any validation or restriction.

- DataWeave doesn’t support patterns.

### Object types

DataWeave marks non-required properties in JSON Schema object types as optional properties in the
DataWeave Object type.

The following example outputs a DataWeave type:

JSON schema:

```JSON
{
  "type": "object",
  "properties": {
    "name":      { "type": "string" },
    "email":     { "type": "string" },
    "address":   { "type": "string" },
    "telephone": { "type": "string" }
  },
  "required": ["name", "email"]
}
```

Output:

```dataweave
%dw 2.0
type Root = { address?: String, name: String, telephone?: String, email: String }
```

If additional properties are allowed, DataWeave produces an open Object definition.

The following example outputs a DataWeave type:

JSON schema:

```JSON
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "number":      { "type": "number" },
    "street_name": { "type": "string" },
    "street_type": { "type": "string",
      "enum": ["Street", "Avenue", "Boulevard"]
    }
  },
  "required": ["number"],
  "additionalProperties": true
}
```

Output:

```dataweave
%dw 2.0
type Root = { number: Number, street_type?: "Street" | "Avenue" | "Boulevard", street_name?: String }
```

If, on the contrary, additional properties aren’t allowed, DataWeave produces a closed Object
definition.

The following example outputs a DataWeave type:

JSON schema:

```JSON
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "number":      { "type": "number" },
    "street_name": { "type": "string" },
    "street_type": { "type": "string",
      "enum": ["Street", "Avenue", "Boulevard"]
    }
  },
  "required": ["number"],
  "additionalProperties": false
}
```

Output:

```dataweave
%dw 2.0
type Root = {| number: Number, street_type?: "Street" | "Avenue" | "Boulevard", street_name?: String |}
```

### Built-in JSON Schema Support for Subschema Keywords

Using subschema keywords in JSON schema produces complex types based on the provided subschemas.

<table><colgroup><col> <col></colgroup><thead><tr><th>JSON Schema Keyword</th><th>DataWeave Type</th></tr></thead><tbody><tr><td><p><code>allOf</code></p></td><td><p><code>Intersection</code></p></td></tr><tr><td><p><code>anyOf</code></p></td><td><p><code>Union</code></p></td></tr><tr><td><p><code>oneOf</code></p></td><td><p><code>Union</code></p></td></tr></tbody></table>

The following example outputs a DataWeave type: .JSON schema:

```JSON
{
  "anyOf": [
    { "type": "string" },
    { "type": "number" }
  ]
}
```

Output:

```dataweave
%dw 2.0
type Root = (String | Number)
```

<!-- document id=e60110730bf132c8403bbe176a9246e0d4e61e88c94c4cd4489245898a8c6178 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-type-reuse-avro-schema.md -->

---
product: DataWeave
version: 2.11
---

# Reusing Types from an Avro Schema

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

An Avro schema is a formal specification that defines the structure and data types for records
stored in the Apache Avro format. The Apache Avro format is a data serialization system commonly
used in big data systems like Apache Hadoop and Apache Kafka. The Avro schema ensures that data
written in Avro can be easily understood and processed across different systems, regardless of the
programming languages or platforms involved.

Avro schemas are defined in JSON data format. You can import Avro schema files (`.json` or `.avsc`)
in your DataWeave script as modules by using the `avroschema!` module loader. This loader enables
you to use types that are declared in your schema in DataWeave directly. DataWeave loads your Avro
schema file and translates declarations in your file into DataWeave type directives that you can
access in the same way as types from any other DataWeave module. Use the directives to build new
types, type-check your variables, match patterns, or declare new functions that use types. DataWeave
places no restrictions on how to use these types.

## Import Syntax

To import the types defined by an Avro schema, use the following syntax, where:

- `typeToImport`: Use `*` to import all types defined in the schema, or to import a single type from
  the schema, for example, `Root`. The schema uses the provided name in the schema for Avro named
  types like `record` and `enum`. You can also import Avro schema types with a different name, for
  example, `Root as Country`. You can reference the type with that name in the script.

- `pathToAvroSchemaFile`: To specify the path to the schema file, replace the file separators with
  `::` and remove the extension (either `.json` or `.avsc`) from the file name. For example, if the
  path to the schema is `example/schema/User.json`, use `example::schema::User`.

import \_typesToImport\_ from avroschema!\_pathToAvroSchemaFile\_

The following example shows how to import a type:

import \* from avroschema!example::schema::User

## Use Your Types in a DataWeave Script

The following example uses the Avro schema:

User.json (`example/schema/User.json`)

```JSON
{
  "name": "User",
  "type": "record",
  "fields": [
    {"name": "name", "type": "string" },
    {"name": "email", "type": "string" },
    {"name": "address", "type": ["null", "string"]},
    {"name": "telephone", "type": ["null", "string"]}
  ]
}
```

Include the import directive from the previous example in the script header to load the existing
types in the Avro schema. In `import * from avroschema!example::schema::User`, the only existing
type is the `User` type, specified at the root. This type describes an object with four properties:
`name`, `email`, `address`, and `telephone`. This directive is equivalent to declaring the following
type in your DataWeave script:

DataWeave Script:

```dataweave
%dw 2.0
type User = {| name: String, email: String, address?: Null | String, telephone?: Null | String |}
```

Notice that `address` and `telephone` are optional fields, as indicated by the `?`.

You can use the type `User` to determine if a value follows the structure defined by the Avro
schema. The following example outputs the value `true` because the object contains the required
fields, `name` and `email`:

DataWeave Script:

```dataweave
%dw 2.0
import * from avroschema!example::schema::User
---
{
 name: "John",
 email: "john@acme.org"
} is User
```

Output:

"true"

The following example outputs the value `false` because the object doesn’t contain the required
field `name`:

DataWeave Script:

```dataweave
%dw 2.0
import * from avroschema!example::schema::User
---
{
 email: "john@acme.org",
 address: "123 Evergreen St.",
 telephone: "555 555 555"
} is User
```

Output:

"false"

## Use Named Types Inside Schemas

DataWeave generates a separate type for each named type defined in the schema. Named types include
records, enums, and fixed types.

Address.json (`example/schema/Address.json`)

```JSON
{
  "name": "Address",
  "type": "record",
  "fields" : [
    {"name": "city", "type": "string"},
    {"name": "state", "type": "string"},
    {
      "name": "country",
      "type": {
        "name": "Country",
        "type": "record",
        "fields": [
          {"name":  "isoCode", "type": "string"},
          {"name":  "name", "type": "string"}
        ]
      }
    }
  ]
}
```

You can import the types from the previous schema with the following directive:

import \* from avroschema!example::schema::Address

The types defined in the schema have the same effect as declaring the following types:

type Address = {| city: String, state: String, country: Country |}

type Country = {| isoCode: String, name: String |}

Use the import directive to import a single type from the schema:

import Country from avrochema!example::schema::Address

To avoid a type-name collision, you can use the `as` keyword to change the imported type name to
another name:

import Country as Address\_Country from avroschema!example::schema::Address

<!-- document id=1d295284e09465733f12dbe80cf8ddf68df699db0e16e78cb0e55a1259bdbb2a url=/mulesoft/current/en-us/dataweave/2.12/dataweave-type-reuse-avro-schema.md -->

---
product: DataWeave
version: 2.12
---

# Reusing Types from an Avro Schema

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

An Avro schema is a formal specification that defines the structure and data types for records
stored in the Apache Avro format. The Apache Avro format is a data serialization system commonly
used in big data systems like Apache Hadoop and Apache Kafka. The Avro schema ensures that data
written in Avro can be easily understood and processed across different systems, regardless of the
programming languages or platforms involved.

Avro schemas are defined in JSON data format. You can import Avro schema files (`.json` or `.avsc`)
in your DataWeave script as modules by using the `avroschema!` module loader. This loader enables
you to use types that are declared in your schema in DataWeave directly. DataWeave loads your Avro
schema file and translates declarations in your file into DataWeave type directives that you can
access in the same way as types from any other DataWeave module. Use the directives to build new
types, type-check your variables, match patterns, or declare new functions that use types. DataWeave
places no restrictions on how to use these types.

## Import Syntax

To import the types defined by an Avro schema, use the following syntax, where:

- `typeToImport`: Use `*` to import all types defined in the schema, or to import a single type from
  the schema, for example, `Root`. The schema uses the provided name in the schema for Avro named
  types like `record` and `enum`. You can also import Avro schema types with a different name, for
  example, `Root as Country`. You can reference the type with that name in the script.

- `pathToAvroSchemaFile`: To specify the path to the schema file, replace the file separators with
  `::` and remove the extension (either `.json` or `.avsc`) from the file name. For example, if the
  path to the schema is `example/schema/User.json`, use `example::schema::User`.

import \_typesToImport\_ from avroschema!\_pathToAvroSchemaFile\_

The following example shows how to import a type:

import \* from avroschema!example::schema::User

## Use Your Types in a DataWeave Script

The following example uses the Avro schema:

User.json (`example/schema/User.json`)

```JSON
{
  "name": "User",
  "type": "record",
  "fields": [
    {"name": "name", "type": "string" },
    {"name": "email", "type": "string" },
    {"name": "address", "type": ["null", "string"]},
    {"name": "telephone", "type": ["null", "string"]}
  ]
}
```

Include the import directive from the previous example in the script header to load the existing
types in the Avro schema. In `import * from avroschema!example::schema::User`, the only existing
type is the `User` type, specified at the root. This type describes an object with four properties:
`name`, `email`, `address`, and `telephone`. This directive is equivalent to declaring the following
type in your DataWeave script:

DataWeave Script:

```dataweave
%dw 2.0
type User = {| name: String, email: String, address?: Null | String, telephone?: Null | String |}
```

Notice that `address` and `telephone` are optional fields, as indicated by the `?`.

You can use the type `User` to determine if a value follows the structure defined by the Avro
schema. The following example outputs the value `true` because the object contains the required
fields, `name` and `email`:

DataWeave Script:

```dataweave
%dw 2.0
import * from avroschema!example::schema::User
---
{
 name: "John",
 email: "john@acme.org"
} is User
```

Output:

"true"

The following example outputs the value `false` because the object doesn’t contain the required
field `name`:

DataWeave Script:

```dataweave
%dw 2.0
import * from avroschema!example::schema::User
---
{
 email: "john@acme.org",
 address: "123 Evergreen St.",
 telephone: "555 555 555"
} is User
```

Output:

"false"

## Use Named Types Inside Schemas

DataWeave generates a separate type for each named type defined in the schema. Named types include
records, enums, and fixed types.

Address.json (`example/schema/Address.json`)

```JSON
{
  "name": "Address",
  "type": "record",
  "fields" : [
    {"name": "city", "type": "string"},
    {"name": "state", "type": "string"},
    {
      "name": "country",
      "type": {
        "name": "Country",
        "type": "record",
        "fields": [
          {"name":  "isoCode", "type": "string"},
          {"name":  "name", "type": "string"}
        ]
      }
    }
  ]
}
```

You can import the types from the previous schema with the following directive:

import \* from avroschema!example::schema::Address

The types defined in the schema have the same effect as declaring the following types:

type Address = {| city: String, state: String, country: Country |}

type Country = {| isoCode: String, name: String |}

Use the import directive to import a single type from the schema:

import Country from avrochema!example::schema::Address

To avoid a type-name collision, you can use the `as` keyword to change the imported type name to
another name:

import Country as Address\_Country from avroschema!example::schema::Address

<!-- document id=bd0f05f037d3df126173269a8dfa559a772c7de8ac3a39a69a7ae61d0855d8b4 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-type-reuse-avro-schema.md -->

---
product: DataWeave
version: 2.9
---

# Reusing Types from an Avro Schema

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

An Avro schema is a formal specification that defines the structure and data types for records
stored in the Apache Avro format. The Apache Avro format is a data serialization system commonly
used in big data systems like Apache Hadoop and Apache Kafka. The Avro schema ensures that data
written in Avro can be easily understood and processed across different systems, regardless of the
programming languages or platforms involved.

Avro schemas are defined in JSON data format. You can import Avro schema files (`.json` or `.avsc`)
in your DataWeave script as modules by using the `avroschema!` module loader. This loader enables
you to use types that are declared in your schema in DataWeave directly. DataWeave loads your Avro
schema file and translates declarations in your file into DataWeave type directives that you can
access in the same way as types from any other DataWeave module. Use the directives to build new
types, type-check your variables, match patterns, or declare new functions that use types. DataWeave
places no restrictions on how to use these types.

## Import Syntax

To import the types defined by an Avro schema, use the following syntax, where:

- `typeToImport`: Use `*` to import all types defined in the schema, or to import a single type from
  the schema, for example, `Root`. The schema uses the provided name in the schema for Avro named
  types like `record` and `enum`. You can also import Avro schema types with a different name, for
  example, `Root as Country`. You can reference the type with that name in the script.

- `pathToAvroSchemaFile`: To specify the path to the schema file, replace the file separators with
  `::` and remove the extension (either `.json` or `.avsc`) from the file name. For example, if the
  path to the schema is `example/schema/User.json`, use `example::schema::User`.

import \_typesToImport\_ from avroschema!\_pathToAvroSchemaFile\_

The following example shows how to import a type:

import \* from avroschema!example::schema::User

## Use Your Types in a DataWeave Script

The following example uses the Avro schema:

User.json (`example/schema/User.json`)

```JSON
{
  "name": "User",
  "type": "record",
  "fields": [
    {"name": "name", "type": "string" },
    {"name": "email", "type": "string" },
    {"name": "address", "type": ["null", "string"]},
    {"name": "telephone", "type": ["null", "string"]}
  ]
}
```

Include the import directive from the previous example in the script header to load the existing
types in the Avro schema. In `import * from avroschema!example::schema::User`, the only existing
type is the `User` type, specified at the root. This type describes an object with four properties:
`name`, `email`, `address`, and `telephone`. This directive is equivalent to declaring the following
type in your DataWeave script:

DataWeave Script:

```dataweave
%dw 2.0
type User = {| name: String, email: String, address?: Null | String, telephone?: Null | String |}
```

Notice that `address` and `telephone` are optional fields, as indicated by the `?`.

You can use the type `User` to determine if a value follows the structure defined by the Avro
schema. The following example outputs the value `true` because the object contains the required
fields, `name` and `email`:

DataWeave Script:

```dataweave
%dw 2.0
import * from avroschema!example::schema::User
---
{
 name: "John",
 email: "john@acme.org"
} is User
```

Output:

"true"

The following example outputs the value `false` because the object doesn’t contain the required
field `name`:

DataWeave Script:

```dataweave
%dw 2.0
import * from avroschema!example::schema::User
---
{
 email: "john@acme.org",
 address: "123 Evergreen St.",
 telephone: "555 555 555"
} is User
```

Output:

"false"

## Use Named Types Inside Schemas

DataWeave generates a separate type for each named type defined in the schema. Named types include
records, enums, and fixed types.

Address.json (`example/schema/Address.json`)

```JSON
{
  "name": "Address",
  "type": "record",
  "fields" : [
    {"name": "city", "type": "string"},
    {"name": "state", "type": "string"},
    {
      "name": "country",
      "type": {
        "name": "Country",
        "type": "record",
        "fields": [
          {"name":  "isoCode", "type": "string"},
          {"name":  "name", "type": "string"}
        ]
      }
    }
  ]
}
```

You can import the types from the previous schema with the following directive:

import \* from avroschema!example::schema::Address

The types defined in the schema have the same effect as declaring the following types:

type Address = {| city: String, state: String, country: Country |}

type Country = {| isoCode: String, name: String |}

Use the import directive to import a single type from the schema:

import Country from avrochema!example::schema::Address

To avoid a type-name collision, you can use the `as` keyword to change the imported type name to
another name:

import Country as Address\_Country from avroschema!example::schema::Address

<!-- document id=814d9a1ec26a1cb1e064293595ba102aa4979ce89d16a7d8f0d0270d6c9da4a6 url=/mulesoft/current/en-us/dataweave/latest/dataweave-type-reuse-avro-schema.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Reusing Types from an Avro Schema

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

An Avro schema is a formal specification that defines the structure and data types for records
stored in the Apache Avro format. The Apache Avro format is a data serialization system commonly
used in big data systems like Apache Hadoop and Apache Kafka. The Avro schema ensures that data
written in Avro can be easily understood and processed across different systems, regardless of the
programming languages or platforms involved.

Avro schemas are defined in JSON data format. You can import Avro schema files (`.json` or `.avsc`)
in your DataWeave script as modules by using the `avroschema!` module loader. This loader enables
you to use types that are declared in your schema in DataWeave directly. DataWeave loads your Avro
schema file and translates declarations in your file into DataWeave type directives that you can
access in the same way as types from any other DataWeave module. Use the directives to build new
types, type-check your variables, match patterns, or declare new functions that use types. DataWeave
places no restrictions on how to use these types.

## Import Syntax

To import the types defined by an Avro schema, use the following syntax, where:

- `typeToImport`: Use `*` to import all types defined in the schema, or to import a single type from
  the schema, for example, `Root`. The schema uses the provided name in the schema for Avro named
  types like `record` and `enum`. You can also import Avro schema types with a different name, for
  example, `Root as Country`. You can reference the type with that name in the script.

- `pathToAvroSchemaFile`: To specify the path to the schema file, replace the file separators with
  `::` and remove the extension (either `.json` or `.avsc`) from the file name. For example, if the
  path to the schema is `example/schema/User.json`, use `example::schema::User`.

import \_typesToImport\_ from avroschema!\_pathToAvroSchemaFile\_

The following example shows how to import a type:

import \* from avroschema!example::schema::User

## Use Your Types in a DataWeave Script

The following example uses the Avro schema:

User.json (`example/schema/User.json`)

```JSON
{
  "name": "User",
  "type": "record",
  "fields": [
    {"name": "name", "type": "string" },
    {"name": "email", "type": "string" },
    {"name": "address", "type": ["null", "string"]},
    {"name": "telephone", "type": ["null", "string"]}
  ]
}
```

Include the import directive from the previous example in the script header to load the existing
types in the Avro schema. In `import * from avroschema!example::schema::User`, the only existing
type is the `User` type, specified at the root. This type describes an object with four properties:
`name`, `email`, `address`, and `telephone`. This directive is equivalent to declaring the following
type in your DataWeave script:

DataWeave Script:

```dataweave
%dw 2.0
type User = {| name: String, email: String, address?: Null | String, telephone?: Null | String |}
```

Notice that `address` and `telephone` are optional fields, as indicated by the `?`.

You can use the type `User` to determine if a value follows the structure defined by the Avro
schema. The following example outputs the value `true` because the object contains the required
fields, `name` and `email`:

DataWeave Script:

```dataweave
%dw 2.0
import * from avroschema!example::schema::User
---
{
 name: "John",
 email: "john@acme.org"
} is User
```

Output:

"true"

The following example outputs the value `false` because the object doesn’t contain the required
field `name`:

DataWeave Script:

```dataweave
%dw 2.0
import * from avroschema!example::schema::User
---
{
 email: "john@acme.org",
 address: "123 Evergreen St.",
 telephone: "555 555 555"
} is User
```

Output:

"false"

## Use Named Types Inside Schemas

DataWeave generates a separate type for each named type defined in the schema. Named types include
records, enums, and fixed types.

Address.json (`example/schema/Address.json`)

```JSON
{
  "name": "Address",
  "type": "record",
  "fields" : [
    {"name": "city", "type": "string"},
    {"name": "state", "type": "string"},
    {
      "name": "country",
      "type": {
        "name": "Country",
        "type": "record",
        "fields": [
          {"name":  "isoCode", "type": "string"},
          {"name":  "name", "type": "string"}
        ]
      }
    }
  ]
}
```

You can import the types from the previous schema with the following directive:

import \* from avroschema!example::schema::Address

The types defined in the schema have the same effect as declaring the following types:

type Address = {| city: String, state: String, country: Country |}

type Country = {| isoCode: String, name: String |}

Use the import directive to import a single type from the schema:

import Country from avrochema!example::schema::Address

To avoid a type-name collision, you can use the `as` keyword to change the imported type name to
another name:

import Country as Address\_Country from avroschema!example::schema::Address

<!-- document id=2550f8ad903b666df163d8995f1efba88b340b4ea67180d5af5ae18489e1eb17 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-type-reuse-modules.md -->

---
product: DataWeave
version: 2.11
---

# Reusing Types from DataWeave Modules

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

To reuse types declared in other DataWeave modules, use the `import` directive:

DataWeave Module (`dw/Weather.dwl`):

```dataweave
%dw 2.0
type Weather = "cloudy" | "sunny" | "rainy" | "stormy"
type DetailedWeather = {temperature: Number, weather: Weather}
```

You can use those imported types as any other type in DataWeave, as constraints for variables and
functions or for pattern matching and checking types at runtime:

DataWeave Script:

```dataweave
%dw 2.0
output json
import * from dw::Weather


fun weatherMessage(todayWeather: Weather) =
    "The weather for today is: " ++ todayWeather
var worstPossibleWeather: DetailedWeather = {temperature: -10, weather: "stormy"}
---
{
    a: weatherMessage("sunny"),
    b: worstPossibleWeather.weather is Weather
}
```

## See Also

- [Create Custom Modules and Mappings](https://docs.mulesoft.com/dataweave/2.11/dataweave-create-module)

<!-- document id=2e3008589335d712b98e6a34734b3b6d8874e9f8d8ae8f41aa053a450fcf1305 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-type-reuse-modules.md -->

---
product: DataWeave
version: 2.12
---

# Reusing Types from DataWeave Modules

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

To reuse types declared in other DataWeave modules, use the `import` directive:

DataWeave Module (`dw/Weather.dwl`):

```dataweave
%dw 2.0
type Weather = "cloudy" | "sunny" | "rainy" | "stormy"
type DetailedWeather = {temperature: Number, weather: Weather}
```

You can use those imported types as any other type in DataWeave, as constraints for variables and
functions or for pattern matching and checking types at runtime:

DataWeave Script:

```dataweave
%dw 2.0
output json
import * from dw::Weather


fun weatherMessage(todayWeather: Weather) =
    "The weather for today is: " ++ todayWeather
var worstPossibleWeather: DetailedWeather = {temperature: -10, weather: "stormy"}
---
{
    a: weatherMessage("sunny"),
    b: worstPossibleWeather.weather is Weather
}
```

## See Also

- [Create Custom Modules and Mappings](https://docs.mulesoft.com/dataweave/2.12/dataweave-create-module)

<!-- document id=98becfd30a27d1c5789d03cf441dd6e9841c9ca3c392aa303f7b40bc7cc0acf5 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-type-reuse-modules.md -->

---
product: DataWeave
version: 2.6
---

# Reusing Types from DataWeave Modules

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

To reuse types declared in other DataWeave modules, use the `import` directive:

DataWeave Module (`dw/Weather.dwl`):

```dataweave
%dw 2.0
type Weather = "cloudy" | "sunny" | "rainy" | "stormy"
type DetailedWeather = {temperature: Number, weather: Weather}
```

You can use those imported types as any other type in DataWeave, as constraints for variables and
functions or for pattern matching and checking types at runtime:

DataWeave Script:

```dataweave
%dw 2.0
output json
import * from dw::Weather


fun weatherMessage(todayWeather: Weather) =
    "The weather for today is: " ++ todayWeather
var worstPossibleWeather: DetailedWeather = {temperature: -10, weather: "stormy"}
---
{
    a: weatherMessage("sunny"),
    b: worstPossibleWeather.weather is Weather
}
```

## See Also

- [Create Custom Modules and Mappings](https://docs.mulesoft.com/dataweave/2.6/dataweave-create-module)

<!-- document id=74292e4bcb05f6ae02f3a39403f1dc988798cb22e931b02e3328879f1eab5165 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-type-reuse-modules.md -->

---
product: DataWeave
version: 2.9
---

# Reusing Types from DataWeave Modules

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

To reuse types declared in other DataWeave modules, use the `import` directive:

DataWeave Module (`dw/Weather.dwl`):

```dataweave
%dw 2.0
type Weather = "cloudy" | "sunny" | "rainy" | "stormy"
type DetailedWeather = {temperature: Number, weather: Weather}
```

You can use those imported types as any other type in DataWeave, as constraints for variables and
functions or for pattern matching and checking types at runtime:

DataWeave Script:

```dataweave
%dw 2.0
output json
import * from dw::Weather


fun weatherMessage(todayWeather: Weather) =
    "The weather for today is: " ++ todayWeather
var worstPossibleWeather: DetailedWeather = {temperature: -10, weather: "stormy"}
---
{
    a: weatherMessage("sunny"),
    b: worstPossibleWeather.weather is Weather
}
```

## See Also

- [Create Custom Modules and Mappings](https://docs.mulesoft.com/dataweave/2.9/dataweave-create-module)

<!-- document id=fb1f98de31493d3e170c2e0b0a07b4e888f94d07df61b667736a9013b3238d52 url=/mulesoft/current/en-us/dataweave/latest/dataweave-type-reuse-modules.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Reusing Types from DataWeave Modules

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

To reuse types declared in other DataWeave modules, use the `import` directive:

DataWeave Module (`dw/Weather.dwl`):

```dataweave
%dw 2.0
type Weather = "cloudy" | "sunny" | "rainy" | "stormy"
type DetailedWeather = {temperature: Number, weather: Weather}
```

You can use those imported types as any other type in DataWeave, as constraints for variables and
functions or for pattern matching and checking types at runtime:

DataWeave Script:

```dataweave
%dw 2.0
output json
import * from dw::Weather


fun weatherMessage(todayWeather: Weather) =
    "The weather for today is: " ++ todayWeather
var worstPossibleWeather: DetailedWeather = {temperature: -10, weather: "stormy"}
---
{
    a: weatherMessage("sunny"),
    b: worstPossibleWeather.weather is Weather
}
```

## See Also

- [Create Custom Modules and Mappings](https://docs.mulesoft.com/dataweave/latest/dataweave-create-module)

<!-- document id=b11693f1debda8ea7588b1a1aa916962f53583ef75f5fe6f78fc12d91777a445 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-type-reuse-java-classes.md -->

---
product: DataWeave
version: 2.11
---

# Reusing Types from Java Classes

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Use the import directive with the `java!` prefix when loading a Java class. The prefix `java!` tells
DataWeave to use the Java module loader. After the module loads, you can call constructors,
variables, and functions (see [Call Java Methods with DataWeave](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-java-methods)).
The class type is also available. DataWeave exposes the type of the Java class with the type name
`Class`.

Java classes are mapped to the DataWeave types listed in
[Java Value Mapping](https://docs.mulesoft.com/dataweave/2.11/dataweave-formats-java#java-value-mapping). If a Java class is not specified in
the table, DataWeave treats the class as `JavaBean` and maps it to a DataWeave `Object` type. The
keys in that object match the names of the properties in the Java class and their values correspond
to the DataWeave type that matches the property class. The following example shows how DataWeave
takes all properties from the Java getters:

Product Class:

package org.mycompany;

public class Product { private String name; private int price;

    public Product(String name, int price) {
        this.name = name;
        this.price = price;
    }

    public String getName() {return name;}
    public void setName(String name) {this.name = name;}
    public int getPrice() {return price;}
    public void setPrice(int price) {this.price = price;}

}

Loading the type for this Java class has the same effect as declaring this DataWeave type:

type Class = { name?: String | Null, price?: Number | Null }

The following example uses the type `Product::Class` as any other type in DataWeave. Creating a
DataWeave object by calling the function `Product::new` (which calls the constructor of the Java
class) also matches the type `Product::Class`. Notice that the import directive lacks `from` and
instead uses the type `Class` prefix `Product::`. The prefix enables more declarative use of the
type and avoids collisions with any other imported `Class` types:

DataWeave Script:

```dataweave
%dw 2.0
output json
import java!org::mycompany::Product

var aBook: Product::Class = {name: "Learn DW", price: 123}
fun description(p: Product::Class) = "The product: $(p.name), costs: $(p.price)"

type Order = {
    product: Product::Class,
    date: LocalDateTime
}
---
{
    a: Product::new("DW lang", 321) is Product::Class,
    b: description(aBook),
    c: {product: aBook, date: |2022-12-18T14:00:00|} is Order
}
```

Output:

{ a: true, b: "The product: Learn DW, costs: 123", c: true }

<!-- document id=083c5e5efe029b2101b429af0c4db0c60dd4f3a54ea5b86a2b42c86412b5b38f url=/mulesoft/current/en-us/dataweave/2.12/dataweave-type-reuse-java-classes.md -->

---
product: DataWeave
version: 2.12
---

# Reusing Types from Java Classes

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Use the import directive with the `java!` prefix when loading a Java class. The prefix `java!` tells
DataWeave to use the Java module loader. After the module loads, you can call constructors,
variables, and functions (see [Call Java Methods with DataWeave](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-java-methods)).
The class type is also available. DataWeave exposes the type of the Java class with the type name
`Class`.

Java classes are mapped to the DataWeave types listed in
[Java Value Mapping](https://docs.mulesoft.com/dataweave/2.12/dataweave-formats-java#java-value-mapping). If a Java class is not specified in
the table, DataWeave treats the class as `JavaBean` and maps it to a DataWeave `Object` type. The
keys in that object match the names of the properties in the Java class and their values correspond
to the DataWeave type that matches the property class. The following example shows how DataWeave
takes all properties from the Java getters:

Product Class:

package org.mycompany;

public class Product { private String name; private int price;

    public Product(String name, int price) {
        this.name = name;
        this.price = price;
    }

    public String getName() {return name;}
    public void setName(String name) {this.name = name;}
    public int getPrice() {return price;}
    public void setPrice(int price) {this.price = price;}

}

Loading the type for this Java class has the same effect as declaring this DataWeave type:

type Class = { name?: String | Null, price?: Number | Null }

The following example uses the type `Product::Class` as any other type in DataWeave. Creating a
DataWeave object by calling the function `Product::new` (which calls the constructor of the Java
class) also matches the type `Product::Class`. Notice that the import directive lacks `from` and
instead uses the type `Class` prefix `Product::`. The prefix enables more declarative use of the
type and avoids collisions with any other imported `Class` types:

DataWeave Script:

```dataweave
%dw 2.0
output json
import java!org::mycompany::Product

var aBook: Product::Class = {name: "Learn DW", price: 123}
fun description(p: Product::Class) = "The product: $(p.name), costs: $(p.price)"

type Order = {
    product: Product::Class,
    date: LocalDateTime
}
---
{
    a: Product::new("DW lang", 321) is Product::Class,
    b: description(aBook),
    c: {product: aBook, date: |2022-12-18T14:00:00|} is Order
}
```

Output:

{ a: true, b: "The product: Learn DW, costs: 123", c: true }

<!-- document id=8352d8c03b407e0ed0092b61616c844c2a00a9f5a6c83df2a5084cd2702ff4c1 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-type-reuse-java-classes.md -->

---
product: DataWeave
version: 2.6
---

# Reusing Types from Java Classes

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Use the import directive with the `java!` prefix when loading a Java class. The prefix `java!` tells
DataWeave to use the Java module loader. After the module loads, you can call constructors,
variables, and functions (see [Call Java Methods with DataWeave](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-java-methods)).
The class type is also available. DataWeave exposes the type of the Java class with the type name
`Class`.

Java classes are mapped to the DataWeave types listed in
[Java Value Mapping](https://docs.mulesoft.com/dataweave/2.6/dataweave-formats-java#java-value-mapping). If a Java class is not specified in
the table, DataWeave treats the class as `JavaBean` and maps it to a DataWeave `Object` type. The
keys in that object match the names of the properties in the Java class and their values correspond
to the DataWeave type that matches the property class. The following example shows how DataWeave
takes all properties from the Java getters:

Product Class:

package org.mycompany;

public class Product { private String name; private int price;

    public Product(String name, int price) {
        this.name = name;
        this.price = price;
    }

    public String getName() {return name;}
    public void setName(String name) {this.name = name;}
    public int getPrice() {return price;}
    public void setPrice(int price) {this.price = price;}

}

Loading the type for this Java class has the same effect as declaring this DataWeave type:

type Class = { name?: String | Null, price?: Number | Null }

The following example uses the type `Product::Class` as any other type in DataWeave. Creating a
DataWeave object by calling the function `Product::new` (which calls the constructor of the Java
class) also matches the type `Product::Class`. Notice that the import directive lacks `from` and
instead uses the type `Class` prefix `Product::`. The prefix enables more declarative use of the
type and avoids collisions with any other imported `Class` types:

DataWeave Script:

```dataweave
%dw 2.0
output json
import java!org::mycompany::Product

var aBook: Product::Class = {name: "Learn DW", price: 123}
fun description(p: Product::Class) = "The product: $(p.name), costs: $(p.price)"

type Order = {
    product: Product::Class,
    date: LocalDateTime
}
---
{
    a: Product::new("DW lang", 321) is Product::Class,
    b: description(aBook),
    c: {product: aBook, date: |2022-12-18T14:00:00|} is Order
}
```

Output:

{ a: true, b: "The product: Learn DW, costs: 123", c: true }

<!-- document id=3fe7c19c79c5a9e79130e5b834e235e081d47ef2529205446b0dcdbbb84f0221 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-type-reuse-java-classes.md -->

---
product: DataWeave
version: 2.9
---

# Reusing Types from Java Classes

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Use the import directive with the `java!` prefix when loading a Java class. The prefix `java!` tells
DataWeave to use the Java module loader. After the module loads, you can call constructors,
variables, and functions (see [Call Java Methods with DataWeave](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-java-methods)).
The class type is also available. DataWeave exposes the type of the Java class with the type name
`Class`.

Java classes are mapped to the DataWeave types listed in
[Java Value Mapping](https://docs.mulesoft.com/dataweave/2.9/dataweave-formats-java#java-value-mapping). If a Java class is not specified in
the table, DataWeave treats the class as `JavaBean` and maps it to a DataWeave `Object` type. The
keys in that object match the names of the properties in the Java class and their values correspond
to the DataWeave type that matches the property class. The following example shows how DataWeave
takes all properties from the Java getters:

Product Class:

package org.mycompany;

public class Product { private String name; private int price;

    public Product(String name, int price) {
        this.name = name;
        this.price = price;
    }

    public String getName() {return name;}
    public void setName(String name) {this.name = name;}
    public int getPrice() {return price;}
    public void setPrice(int price) {this.price = price;}

}

Loading the type for this Java class has the same effect as declaring this DataWeave type:

type Class = { name?: String | Null, price?: Number | Null }

The following example uses the type `Product::Class` as any other type in DataWeave. Creating a
DataWeave object by calling the function `Product::new` (which calls the constructor of the Java
class) also matches the type `Product::Class`. Notice that the import directive lacks `from` and
instead uses the type `Class` prefix `Product::`. The prefix enables more declarative use of the
type and avoids collisions with any other imported `Class` types:

DataWeave Script:

```dataweave
%dw 2.0
output json
import java!org::mycompany::Product

var aBook: Product::Class = {name: "Learn DW", price: 123}
fun description(p: Product::Class) = "The product: $(p.name), costs: $(p.price)"

type Order = {
    product: Product::Class,
    date: LocalDateTime
}
---
{
    a: Product::new("DW lang", 321) is Product::Class,
    b: description(aBook),
    c: {product: aBook, date: |2022-12-18T14:00:00|} is Order
}
```

Output:

{ a: true, b: "The product: Learn DW, costs: 123", c: true }

<!-- document id=6e9a869f3f5f7fc01347f8c7786779257f69d185d0d4737a5466f3345af1b984 url=/mulesoft/current/en-us/dataweave/latest/dataweave-type-reuse-java-classes.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Reusing Types from Java Classes

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Use the import directive with the `java!` prefix when loading a Java class. The prefix `java!` tells
DataWeave to use the Java module loader. After the module loads, you can call constructors,
variables, and functions (see [Call Java Methods with DataWeave](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-java-methods)).
The class type is also available. DataWeave exposes the type of the Java class with the type name
`Class`.

Java classes are mapped to the DataWeave types listed in
[Java Value Mapping](https://docs.mulesoft.com/dataweave/latest/dataweave-formats-java#java-value-mapping). If a Java class is not specified in
the table, DataWeave treats the class as `JavaBean` and maps it to a DataWeave `Object` type. The
keys in that object match the names of the properties in the Java class and their values correspond
to the DataWeave type that matches the property class. The following example shows how DataWeave
takes all properties from the Java getters:

Product Class:

package org.mycompany;

public class Product { private String name; private int price;

    public Product(String name, int price) {
        this.name = name;
        this.price = price;
    }

    public String getName() {return name;}
    public void setName(String name) {this.name = name;}
    public int getPrice() {return price;}
    public void setPrice(int price) {this.price = price;}

}

Loading the type for this Java class has the same effect as declaring this DataWeave type:

type Class = { name?: String | Null, price?: Number | Null }

The following example uses the type `Product::Class` as any other type in DataWeave. Creating a
DataWeave object by calling the function `Product::new` (which calls the constructor of the Java
class) also matches the type `Product::Class`. Notice that the import directive lacks `from` and
instead uses the type `Class` prefix `Product::`. The prefix enables more declarative use of the
type and avoids collisions with any other imported `Class` types:

DataWeave Script:

```dataweave
%dw 2.0
output json
import java!org::mycompany::Product

var aBook: Product::Class = {name: "Learn DW", price: 123}
fun description(p: Product::Class) = "The product: $(p.name), costs: $(p.price)"

type Order = {
    product: Product::Class,
    date: LocalDateTime
}
---
{
    a: Product::new("DW lang", 321) is Product::Class,
    b: description(aBook),
    c: {product: aBook, date: |2022-12-18T14:00:00|} is Order
}
```

Output:

{ a: true, b: "The product: Learn DW, costs: 123", c: true }

<!-- document id=fde69c67eee73c302522c0b2b1430310fc10cb7ac7bd09376cc0ad2ea444ee73 url=/mulesoft/current/en-us/dataweave/2.11/dw-strings-functions-reverse.md -->

---
product: DataWeave
version: 2.11
---

# reverse

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## reverse(text: String): String

Reverses sequence of characters in a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to reverse.</p></td></tr></tbody></table>

### Example

This example shows how `reverse` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
 {
     a: reverse("Mariano"),
     b: reverse(null),
     c: reverse("")
 }
```

#### Output

```Json
{
  "a": "onairaM",
  "b": null,
  "c": ""
}
```

## reverse(text: Null): Null

Helper function that enables `reverse` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=4e2c6fd3bbe8f7e5edee1e0bda16d66390ca9e514161efd1705cda0077af5889 url=/mulesoft/current/en-us/dataweave/2.12/dw-strings-functions-reverse.md -->

---
product: DataWeave
version: 2.12
---

# reverse

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## reverse(text: String): String

Reverses sequence of characters in a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to reverse.</p></td></tr></tbody></table>

### Example

This example shows how `reverse` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
 {
     a: reverse("Mariano"),
     b: reverse(null),
     c: reverse("")
 }
```

#### Output

```Json
{
  "a": "onairaM",
  "b": null,
  "c": ""
}
```

## reverse(text: Null): Null

Helper function that enables `reverse` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=9824259d357fa62a96a62f13fbad89331ae57e23188c515724ba3b70fae05323 url=/mulesoft/current/en-us/dataweave/2.4/dw-strings-functions-reverse.md -->

---
product: DataWeave
version: 2.4
---

# reverse

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## reverse(text: String): String

Reverses sequence of characters in a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to reverse.</p></td></tr></tbody></table>

### Example

This example shows how `reverse` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
 {
     a: reverse("Mariano"),
     b: reverse(null),
     c: reverse("")
 }
```

#### Output

```Json
{
  "a": "onairaM",
  "b": null,
  "c": ""
}
```

## reverse(text: Null): Null

Helper function that enables `reverse` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=2b4804b1b07d6adf45caf0df4af7b280dae6b87aacf9ed1abe913325f55fbef1 url=/mulesoft/current/en-us/dataweave/2.6/dw-strings-functions-reverse.md -->

---
product: DataWeave
version: 2.6
---

# reverse

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## reverse(text: String): String

Reverses sequence of characters in a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to reverse.</p></td></tr></tbody></table>

### Example

This example shows how `reverse` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
 {
     a: reverse("Mariano"),
     b: reverse(null),
     c: reverse("")
 }
```

#### Output

```Json
{
  "a": "onairaM",
  "b": null,
  "c": ""
}
```

## reverse(text: Null): Null

Helper function that enables `reverse` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=bbc0871b8453dd0bff9628c06d7e7895c2e6c471ffc7bb764d4a3efe8dcfadc7 url=/mulesoft/current/en-us/dataweave/2.9/dw-strings-functions-reverse.md -->

---
product: DataWeave
version: 2.9
---

# reverse

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## reverse(text: String): String

Reverses sequence of characters in a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to reverse.</p></td></tr></tbody></table>

### Example

This example shows how `reverse` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
 {
     a: reverse("Mariano"),
     b: reverse(null),
     c: reverse("")
 }
```

#### Output

```Json
{
  "a": "onairaM",
  "b": null,
  "c": ""
}
```

## reverse(text: Null): Null

Helper function that enables `reverse` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=1c67cd1ae57b16d505beec93d75add7ea772b13c65761aa7edb4d90515391dd2 url=/mulesoft/current/en-us/dataweave/latest/dw-strings-functions-reverse.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# reverse

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## reverse(text: String): String

Reverses sequence of characters in a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to reverse.</p></td></tr></tbody></table>

### Example

This example shows how `reverse` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
 {
     a: reverse("Mariano"),
     b: reverse(null),
     c: reverse("")
 }
```

#### Output

```Json
{
  "a": "onairaM",
  "b": null,
  "c": ""
}
```

## reverse(text: Null): Null

Helper function that enables `reverse` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=c301468314fcee510f1c8456c1e8ae8f3c6d611573551166de419f5612cf9e45 url=/mulesoft/current/en-us/dataweave/2.11/dw-strings-functions-rightpad.md -->

---
product: DataWeave
version: 2.11
---

# rightPad

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## rightPad(text: String, size: Number, padChar: String = " "): String

The specified `text` is _right_\-padded to the `size` using the `padText`. By default `padText` is
`" "`.

Returns right padded `String` or original `String` if no padding is necessary.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>size</code></p></td><td><p>The size to pad to.</p></td></tr><tr><td><p><code>padText</code></p></td><td><p>The text to pad with. It defaults to one space if not specified.</p></td></tr></tbody></table>

### Example

This example shows how `rightPad` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": rightPad(null, 3),
  "b": rightPad("", 3),
  "c": rightPad("bat", 5),
  "d": rightPad("bat", 3),
  "e": rightPad("bat", -1)
}
```

#### Output

```JSON
{
  "a": null,
  "b": "   ",
  "c": "bat  ",
  "d": "bat",
  "e": "bat"
}
```

## rightPad(text: Null, size: Any, padText: Any = " "): Null

Helper function that enables `rightPad` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=017ab0f9093950ee365fffaa334d9313f1b077f4cc27d45d9a193f0d58777dc4 url=/mulesoft/current/en-us/dataweave/2.12/dw-strings-functions-rightpad.md -->

---
product: DataWeave
version: 2.12
---

# rightPad

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## rightPad(text: String, size: Number, padChar: String = " "): String

The specified `text` is _right_\-padded to the `size` using the `padText`. By default `padText` is
`" "`.

Returns right padded `String` or original `String` if no padding is necessary.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>size</code></p></td><td><p>The size to pad to.</p></td></tr><tr><td><p><code>padText</code></p></td><td><p>The text to pad with. It defaults to one space if not specified.</p></td></tr></tbody></table>

### Example

This example shows how `rightPad` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": rightPad(null, 3),
  "b": rightPad("", 3),
  "c": rightPad("bat", 5),
  "d": rightPad("bat", 3),
  "e": rightPad("bat", -1)
}
```

#### Output

```JSON
{
  "a": null,
  "b": "   ",
  "c": "bat  ",
  "d": "bat",
  "e": "bat"
}
```

## rightPad(text: Null, size: Any, padText: Any = " "): Null

Helper function that enables `rightPad` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=d486bff962e959966189822eb7aa5b4f5b6c06701abd77d385d1373f0a1cb2c3 url=/mulesoft/current/en-us/dataweave/2.3/dw-strings-functions-rightpad.md -->

---
product: DataWeave
version: 2.3
---

# rightPad

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## rightPad(String, Number, String): String

The specified `text` is _right_\-padded to the `size` using the `padText`. By default `padText` is
`" "`.

Returns right padded `String` or original `String` if no padding is necessary.

_Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>size</code></p></td><td><p>The size to pad to.</p></td></tr><tr><td><p><code>padText</code></p></td><td><p>The text to pad with. It defaults to one space if not specified.</p></td></tr></tbody></table>

### Example

This example shows how `rightPad` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": rightPad(null, 3),
  "b": rightPad("", 3),
  "c": rightPad("bat", 5),
  "d": rightPad("bat", 3),
  "e": rightPad("bat", -1)
}
```

#### Output

```JSON
{
  "a": null,
  "b": "   ",
  "c": "bat  ",
  "d": "bat",
  "e": "bat"
}
```

## rightPad(Null, Number, String): Null

Helper function that enables `rightPad` to work with a `null` value.

<!-- document id=5277e02de3a50f119311fec76aad83a35b96fe000a1d2202a112ee54f546734b url=/mulesoft/current/en-us/dataweave/2.4/dw-strings-functions-rightpad.md -->

---
product: DataWeave
version: 2.4
---

# rightPad

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## rightPad(text: String, size: Number, padChar: String = " "): String

The specified `text` is _right_\-padded to the `size` using the `padText`. By default `padText` is
`" "`.

Returns right padded `String` or original `String` if no padding is necessary.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>size</code></p></td><td><p>The size to pad to.</p></td></tr><tr><td><p><code>padText</code></p></td><td><p>The text to pad with. It defaults to one space if not specified.</p></td></tr></tbody></table>

### Example

This example shows how `rightPad` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": rightPad(null, 3),
  "b": rightPad("", 3),
  "c": rightPad("bat", 5),
  "d": rightPad("bat", 3),
  "e": rightPad("bat", -1)
}
```

#### Output

```JSON
{
  "a": null,
  "b": "   ",
  "c": "bat  ",
  "d": "bat",
  "e": "bat"
}
```

## rightPad(text: Null, size: Any, padText: Any = " "): Null

Helper function that enables `rightPad` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=0c30a6e23dda41735ddd8d86a8a6f60d52f34291bbb992fb7ab85e8533692e88 url=/mulesoft/current/en-us/dataweave/2.6/dw-strings-functions-rightpad.md -->

---
product: DataWeave
version: 2.6
---

# rightPad

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## rightPad(text: String, size: Number, padChar: String = " "): String

The specified `text` is _right_\-padded to the `size` using the `padText`. By default `padText` is
`" "`.

Returns right padded `String` or original `String` if no padding is necessary.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>size</code></p></td><td><p>The size to pad to.</p></td></tr><tr><td><p><code>padText</code></p></td><td><p>The text to pad with. It defaults to one space if not specified.</p></td></tr></tbody></table>

### Example

This example shows how `rightPad` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": rightPad(null, 3),
  "b": rightPad("", 3),
  "c": rightPad("bat", 5),
  "d": rightPad("bat", 3),
  "e": rightPad("bat", -1)
}
```

#### Output

```JSON
{
  "a": null,
  "b": "   ",
  "c": "bat  ",
  "d": "bat",
  "e": "bat"
}
```

## rightPad(text: Null, size: Any, padText: Any = " "): Null

Helper function that enables `rightPad` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=462f347c180ffbd52b2ea1b40e2207c37258fdb69d76c07f100cd78da39504c3 url=/mulesoft/current/en-us/dataweave/2.9/dw-strings-functions-rightpad.md -->

---
product: DataWeave
version: 2.9
---

# rightPad

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## rightPad(text: String, size: Number, padChar: String = " "): String

The specified `text` is _right_\-padded to the `size` using the `padText`. By default `padText` is
`" "`.

Returns right padded `String` or original `String` if no padding is necessary.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>size</code></p></td><td><p>The size to pad to.</p></td></tr><tr><td><p><code>padText</code></p></td><td><p>The text to pad with. It defaults to one space if not specified.</p></td></tr></tbody></table>

### Example

This example shows how `rightPad` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": rightPad(null, 3),
  "b": rightPad("", 3),
  "c": rightPad("bat", 5),
  "d": rightPad("bat", 3),
  "e": rightPad("bat", -1)
}
```

#### Output

```JSON
{
  "a": null,
  "b": "   ",
  "c": "bat  ",
  "d": "bat",
  "e": "bat"
}
```

## rightPad(text: Null, size: Any, padText: Any = " "): Null

Helper function that enables `rightPad` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=cc248b1bfbceaa011d465ac1a2b070b9b7e002ae3baaff32d220316ea2dc065e url=/mulesoft/current/en-us/dataweave/latest/dw-strings-functions-rightpad.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# rightPad

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## rightPad(text: String, size: Number, padChar: String = " "): String

The specified `text` is _right_\-padded to the `size` using the `padText`. By default `padText` is
`" "`.

Returns right padded `String` or original `String` if no padding is necessary.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>size</code></p></td><td><p>The size to pad to.</p></td></tr><tr><td><p><code>padText</code></p></td><td><p>The text to pad with. It defaults to one space if not specified.</p></td></tr></tbody></table>

### Example

This example shows how `rightPad` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": rightPad(null, 3),
  "b": rightPad("", 3),
  "c": rightPad("bat", 5),
  "d": rightPad("bat", 3),
  "e": rightPad("bat", -1)
}
```

#### Output

```JSON
{
  "a": null,
  "b": "   ",
  "c": "bat  ",
  "d": "bat",
  "e": "bat"
}
```

## rightPad(text: Null, size: Any, padText: Any = " "): Null

Helper function that enables `rightPad` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=0eef010c0c3b45335a18289727cad60ee0e6c1676781fa47f93e005eb4e24d9a url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-round.md -->

---
product: DataWeave
version: 2.11
---

# round

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## round(number: Number): Number

Rounds a number up or down to the nearest whole number.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Example

This example rounds decimal numbers to the nearest whole numbers.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ round(1.2), round(4.6), round(3.5) ]
```

#### Output

```JSON
[ 1, 5, 4 ]
```

<!-- document id=c6d916a36febf1a5f9b8c6d360825d09c0f43e992856c09f10d16586d6916794 url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-round.md -->

---
product: DataWeave
version: 2.12
---

# round

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## round(number: Number): Number

Rounds a number up or down to the nearest whole number.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Example

This example rounds decimal numbers to the nearest whole numbers.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ round(1.2), round(4.6), round(3.5) ]
```

#### Output

```JSON
[ 1, 5, 4 ]
```

<!-- document id=ecc7595412971c3fe01c19c388426024deb873a6eee14a4f7d5b95c5eebb044f url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-round.md -->

---
product: DataWeave
version: 2.3
---

# round

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## round(Number): Number

Rounds a number up or down to the nearest whole number.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to round.</p></td></tr></tbody></table>

### Example

This example rounds decimal numbers to the nearest whole numbers.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ round(1.2), round(4.6), round(3.5) ]
```

#### Output

```JSON
[ 1, 5, 4 ]
```

<!-- document id=fc527532a8229efacd404add9d28c5f179cbe8f638d97c6aed8dea0214093d64 url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-round.md -->

---
product: DataWeave
version: 2.4
---

# round

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## round(number: Number): Number

Rounds a number up or down to the nearest whole number.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Example

This example rounds decimal numbers to the nearest whole numbers.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ round(1.2), round(4.6), round(3.5) ]
```

#### Output

```JSON
[ 1, 5, 4 ]
```

<!-- document id=d12281db16e0273e0370b74bfc50b92657968941e3ca0be33f094b1caf0411dd url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-round.md -->

---
product: DataWeave
version: 2.6
---

# round

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## round(number: Number): Number

Rounds a number up or down to the nearest whole number.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Example

This example rounds decimal numbers to the nearest whole numbers.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ round(1.2), round(4.6), round(3.5) ]
```

#### Output

```JSON
[ 1, 5, 4 ]
```

<!-- document id=5d57496e6fdf3b8e0d4452fbdbff708c6863fd61753961238777fd6a69b6cd0f url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-round.md -->

---
product: DataWeave
version: 2.9
---

# round

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## round(number: Number): Number

Rounds a number up or down to the nearest whole number.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Example

This example rounds decimal numbers to the nearest whole numbers.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ round(1.2), round(4.6), round(3.5) ]
```

#### Output

```JSON
[ 1, 5, 4 ]
```

<!-- document id=b025e32c0e6c51540c2abcbf23f11e2295705fc570f6d7573847547881f203a1 url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-round.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# round

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## round(number: Number): Number

Rounds a number up or down to the nearest whole number.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Example

This example rounds decimal numbers to the nearest whole numbers.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ round(1.2), round(4.6), round(3.5) ]
```

#### Output

```JSON
[ 1, 5, 4 ]
```

<!-- document id=d83c4180b4e381121325931627f265366b2d71b0fd18e1b19a4d6648b35b25f4 url=/mulesoft/current/en-us/dataweave/latest/dw-rsa.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# RSA (dw::util::jwt::RSA)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module provides functionality to create signed JSON Web Tokens using RSA signatures.

The supported RSA algorithms are:

- RS256

- RS384

- RS512

RSA private keys must be unencrypted `PKCS#1` or `PKCS#8` PEM keys with a modulus of at least 2048
bits.

To use this module, import it to your DataWeave code. For example, by adding the line
`import * from dw::util::jwt::RSA` to the header of your DataWeave script.

_Introduced in DataWeave version 2.6.0._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-rsa-functions-jwt">JWT</a></p></td><td><p>Generate JWT with header, payload, and signature by specific algorithm.</p></td></tr></tbody></table>

## Variables

- [RSA Variables](https://docs.mulesoft.com/dataweave/latest/dw-rsa-variables)

<!-- document id=2a606d28ad32d174c990cd268b5839193bd27d8e63053303e676b22a25d5433e url=/mulesoft/current/en-us/dataweave/latest/dw-rsa-variables.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# RSA Variables (dw::util::jwt::RSA)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Variable</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>algMapping</p></td><td><div><div><p><code>algMapping</code></p></div></div></td><td><div><div><p>Supported RSA algorithms.</p></div><div><p><em>Introduced in DataWeave version 2.6.0.</em></p></div></div></td></tr></tbody></table>

<!-- document id=cda26545537241fd6154f928b4870e44d0bd1d99f3390a6a2ef3d1b0795ae3b7 url=/mulesoft/current/en-us/dataweave/2.11/dw-runtime-functions-run.md -->

---
product: DataWeave
version: 2.11
---

# run

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## run(fileToExecute: String, fs: Dictionary<String>, readerInputs: Dictionary<ReaderInput> = {}, inputValues: Dictionary<Any> = {}, configuration: RuntimeExecutionConfiguration = {}): RunResult

Runs the input script under the provided context and executes the script in the current runtime.

_Experimental:_ This function is an experimental feature that is subject to change or removal from
future versions of DataWeave.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>fileToExecute</code></p></td><td><p>Name of the file to execute.</p></td></tr><tr><td><p><code>fs</code></p></td><td><p>File system that contains the file to execute.</p></td></tr><tr><td><p><code>readerInput</code></p></td><td><p>Inputs to read and bind to the execution.</p></td></tr><tr><td><p><code>inputValues</code></p></td><td><p>Inputs to bind directly to the execution.</p></td></tr><tr><td><p><code>configuration</code></p></td><td><p>The runtime configuration.</p></td></tr></tbody></table>

### Example

This example shows how `run` behaves with different inputs.

#### Source

```DataWeave
import * from dw::Runtime
var jsonValue = {
  value: '{"name": "Mariano"}' as Binary {encoding: "UTF-8"},
  encoding: "UTF-8",
  properties: {},
  mimeType: "application/json"
}

var jsonValue2 = {
  value: '{"name": "Mariano", "lastName": "achaval"}' as Binary {encoding: "UTF-8"},
  encoding: "UTF-8",
  properties: {},
  mimeType: "application/json"
}

var invalidJsonValue = {
  value: '{"name": "Mariano' as Binary {encoding: "UTF-8"},
  encoding: "UTF-8",
  properties: {},
  mimeType: "application/json"
}

var Utils = "fun sum(a,b) = a +b"
---
{
  "execute_ok" : run("main.dwl", {"main.dwl": "{a: 1}"}, {"payload": jsonValue }),
  "logs" : do {
    var execResult = run("main.dwl", {"main.dwl": "{a: log(1)}"}, {"payload": jsonValue })
    ---
    {
        m: execResult.logs.message,
        l: execResult.logs.level
    }
  },
  "grant" : run("main.dwl", {"main.dwl": "{a: readUrl(`http://google.com`)}"}, {"payload": jsonValue }, { securityManager: (grant, args) -> false }),
  "library" : run("main.dwl", {"main.dwl": "Utils::sum(1,2)", "/Utils.dwl": Utils }, {"payload": jsonValue }),
  "timeout" : run("main.dwl", {"main.dwl": "(1 to 1000000000000) map \$ + 1" }, {"payload": jsonValue }, {timeOut: 2}).success,
  "execFail" : run("main.dwl", {"main.dwl": "dw::Runtime::fail('My Bad')" }, {"payload": jsonValue }),
  "parseFail" : run("main.dwl", {"main.dwl": "(1 + " }, {"payload": jsonValue }),
  "writerFail" : run("main.dwl", {"main.dwl": "output application/xml --- 2" }, {"payload": jsonValue }),
  "readerFail" : run("main.dwl", {"main.dwl": "output application/xml --- payload" }, {"payload": invalidJsonValue }),
  "defaultOutput" : run("main.dwl", {"main.dwl": "payload" }, {"payload": jsonValue2}, {outputMimeType: "application/csv", writerProperties: {"separator": "|"}}),
}
```

#### Output

```Json
{
  "execute_ok": {
    "success": true,
    "value": "{\n  a: 1\n}",
    "mimeType": "application/dw",
    "encoding": "UTF-8",
    "logs": [

    ]
  },
  "logs": {
    "m": [
      "1"
    ],
    "l": [
      "INFO"
    ]
  },
  "grant": {
    "success": false,
    "message": "The given required permissions: `Resource` are not being granted for this execution.\nTrace:\n  at readUrl (Unknown)\n  at main::main (line: 1, column: 5)",
    "location": {
      "start": {
        "index": 0,
        "line": 0,
        "column": 0
      },
      "end": {
        "index": 0,
        "line": 0,
        "column": 0
      },
      "content": "Unknown location"
    },
    "stack": [
      "readUrl (anonymous:0:0)",
      "main (main:1:5)"
    ],
    "logs": [

    ]
  },
  "library": {
    "success": true,
    "value": "3",
    "mimeType": "application/dw",
    "encoding": "UTF-8",
    "logs": [

    ]
  },
  "timeout": false,
  "execFail": {
    "success": false,
    "message": "My Bad\nTrace:\n  at fail (Unknown)\n  at main::main (line: 1, column: 1)",
    "location": {
      "start": {
        "index": 0,
        "line": 0,
        "column": 0
      },
      "end": {
        "index": 0,
        "line": 0,
        "column": 0
      },
      "content": "Unknown location"
    },
    "stack": [
      "fail (anonymous:0:0)",
      "main (main:1:1)"
    ],
    "logs": [

    ]
  },
  "parseFail": {
    "success": false,
    "message": "Invalid input \"1 + \", expected parameter or parenEnd (line 1, column 2):\n\n\n1| (1 + \n    ^^^^\nLocation:\nmain (line: 1, column:2)",
    "location": {
      "start": {
        "index": 0,
        "line": 1,
        "column": 2
      },
      "end": {
        "index": 4,
        "line": 1,
        "column": 6
      },
      "content": "\n1| (1 + \n    ^^^^"
    },
    "logs": [

    ]
  },
  "writerFail": {
    "success": false,
    "message": "Trying to output non-whitespace characters outside main element tree (in prolog or epilog), while writing Xml at .",
    "location": {
      "content": ""
    },
    "stack": [

    ],
    "logs": [

    ]
  },
  "readerFail": {
    "success": false,
    "message": "Unexpected end-of-input at payload@[1:18] (line:column), expected '\"', while reading `payload` as Json.\n \n1| {\"name\": \"Mariano\n                    ^",
    "location": {
      "content": "\n1| {\"name\": \"Mariano\n                    ^"
    },
    "stack": [

    ],
    "logs": [

    ]
  },
  "defaultOutput": {
    "success": true,
    "value": "name|lastName\nMariano|achaval\n",
    "mimeType": "application/csv",
    "encoding": "UTF-8",
    "logs": [

    ]
  }
}
```

<!-- document id=fda8ae9503d219acfda87746d808d6ed4715f5a1ba289735f03f807a300a94fc url=/mulesoft/current/en-us/dataweave/2.12/dw-runtime-functions-run.md -->

---
product: DataWeave
version: 2.12
---

# run

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## run(fileToExecute: String, fs: Dictionary<String>, readerInputs: Dictionary<ReaderInput> = {}, inputValues: Dictionary<Any> = {}, configuration: RuntimeExecutionConfiguration = {}): RunResult

Runs the input script under the provided context and executes the script in the current runtime.

_Experimental:_ This function is an experimental feature that is subject to change or removal from
future versions of DataWeave.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>fileToExecute</code></p></td><td><p>Name of the file to execute.</p></td></tr><tr><td><p><code>fs</code></p></td><td><p>File system that contains the file to execute.</p></td></tr><tr><td><p><code>readerInput</code></p></td><td><p>Inputs to read and bind to the execution.</p></td></tr><tr><td><p><code>inputValues</code></p></td><td><p>Inputs to bind directly to the execution.</p></td></tr><tr><td><p><code>configuration</code></p></td><td><p>The runtime configuration.</p></td></tr></tbody></table>

### Example

This example shows how `run` behaves with different inputs.

#### Source

```DataWeave
import * from dw::Runtime
var jsonValue = {
  value: '{"name": "Mariano"}' as Binary {encoding: "UTF-8"},
  encoding: "UTF-8",
  properties: {},
  mimeType: "application/json"
}

var jsonValue2 = {
  value: '{"name": "Mariano", "lastName": "achaval"}' as Binary {encoding: "UTF-8"},
  encoding: "UTF-8",
  properties: {},
  mimeType: "application/json"
}

var invalidJsonValue = {
  value: '{"name": "Mariano' as Binary {encoding: "UTF-8"},
  encoding: "UTF-8",
  properties: {},
  mimeType: "application/json"
}

var Utils = "fun sum(a,b) = a +b"
---
{
  "execute_ok" : run("main.dwl", {"main.dwl": "{a: 1}"}, {"payload": jsonValue }),
  "logs" : do {
    var execResult = run("main.dwl", {"main.dwl": "{a: log(1)}"}, {"payload": jsonValue })
    ---
    {
        m: execResult.logs.message,
        l: execResult.logs.level
    }
  },
  "grant" : run("main.dwl", {"main.dwl": "{a: readUrl(`http://google.com`)}"}, {"payload": jsonValue }, { securityManager: (grant, args) -> false }),
  "library" : run("main.dwl", {"main.dwl": "Utils::sum(1,2)", "/Utils.dwl": Utils }, {"payload": jsonValue }),
  "timeout" : run("main.dwl", {"main.dwl": "(1 to 1000000000000) map \$ + 1" }, {"payload": jsonValue }, {timeOut: 2}).success,
  "execFail" : run("main.dwl", {"main.dwl": "dw::Runtime::fail('My Bad')" }, {"payload": jsonValue }),
  "parseFail" : run("main.dwl", {"main.dwl": "(1 + " }, {"payload": jsonValue }),
  "writerFail" : run("main.dwl", {"main.dwl": "output application/xml --- 2" }, {"payload": jsonValue }),
  "readerFail" : run("main.dwl", {"main.dwl": "output application/xml --- payload" }, {"payload": invalidJsonValue }),
  "defaultOutput" : run("main.dwl", {"main.dwl": "payload" }, {"payload": jsonValue2}, {outputMimeType: "application/csv", writerProperties: {"separator": "|"}}),
}
```

#### Output

```Json
{
  "execute_ok": {
    "success": true,
    "value": "{\n  a: 1\n}",
    "mimeType": "application/dw",
    "encoding": "UTF-8",
    "logs": [

    ]
  },
  "logs": {
    "m": [
      "1"
    ],
    "l": [
      "INFO"
    ]
  },
  "grant": {
    "success": false,
    "message": "The given required permissions: `Resource` are not being granted for this execution.\nTrace:\n  at readUrl (Unknown)\n  at main::main (line: 1, column: 5)",
    "location": {
      "start": {
        "index": 0,
        "line": 0,
        "column": 0
      },
      "end": {
        "index": 0,
        "line": 0,
        "column": 0
      },
      "content": "Unknown location"
    },
    "stack": [
      "readUrl (anonymous:0:0)",
      "main (main:1:5)"
    ],
    "logs": [

    ]
  },
  "library": {
    "success": true,
    "value": "3",
    "mimeType": "application/dw",
    "encoding": "UTF-8",
    "logs": [

    ]
  },
  "timeout": false,
  "execFail": {
    "success": false,
    "message": "My Bad\nTrace:\n  at fail (Unknown)\n  at main::main (line: 1, column: 1)",
    "location": {
      "start": {
        "index": 0,
        "line": 0,
        "column": 0
      },
      "end": {
        "index": 0,
        "line": 0,
        "column": 0
      },
      "content": "Unknown location"
    },
    "stack": [
      "fail (anonymous:0:0)",
      "main (main:1:1)"
    ],
    "logs": [

    ]
  },
  "parseFail": {
    "success": false,
    "message": "Invalid input \"1 + \", expected parameter or parenEnd (line 1, column 2):\n\n\n1| (1 + \n    ^^^^\nLocation:\nmain (line: 1, column:2)",
    "location": {
      "start": {
        "index": 0,
        "line": 1,
        "column": 2
      },
      "end": {
        "index": 4,
        "line": 1,
        "column": 6
      },
      "content": "\n1| (1 + \n    ^^^^"
    },
    "logs": [

    ]
  },
  "writerFail": {
    "success": false,
    "message": "Trying to output non-whitespace characters outside main element tree (in prolog or epilog), while writing Xml at .",
    "location": {
      "content": ""
    },
    "stack": [

    ],
    "logs": [

    ]
  },
  "readerFail": {
    "success": false,
    "message": "Unexpected end-of-input at payload@[1:18] (line:column), expected '\"', while reading `payload` as Json.\n \n1| {\"name\": \"Mariano\n                    ^",
    "location": {
      "content": "\n1| {\"name\": \"Mariano\n                    ^"
    },
    "stack": [

    ],
    "logs": [

    ]
  },
  "defaultOutput": {
    "success": true,
    "value": "name|lastName\nMariano|achaval\n",
    "mimeType": "application/csv",
    "encoding": "UTF-8",
    "logs": [

    ]
  }
}
```

<!-- document id=6cfe090b42ad8c01db083415fd7a4ffe0f0da333ed5203dc88ad8810aa16741c url=/mulesoft/current/en-us/dataweave/2.4/dw-runtime-functions-run.md -->

---
product: DataWeave
version: 2.4
---

# run

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## run(fileToExecute: String, fs: Dictionary<String>, readerInputs: Dictionary<ReaderInput> = {}, inputValues: Dictionary<Any> = {}, configuration: RuntimeExecutionConfiguration = {}): RunSuccess | ExecutionFailure

Runs the input script under the provided context and executes the script in the current runtime.

_Experimental:_ This function is an experimental feature that is subject to change or removal from
future versions of DataWeave.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>fileToExecute</code></p></td><td><p>Name of the file to execute.</p></td></tr><tr><td><p><code>fs</code></p></td><td><p>File system that contains the file to execute.</p></td></tr><tr><td><p><code>readerInput</code></p></td><td><p>Inputs to read and bind to the execution.</p></td></tr><tr><td><p><code>inputValues</code></p></td><td><p>Inputs to bind directly to the execution.</p></td></tr><tr><td><p><code>configuration</code></p></td><td><p>The runtime configuration.</p></td></tr></tbody></table>

### Example

This example shows how `run` behaves with different inputs.

#### Source

```DataWeave
import * from dw::Runtime
var jsonValue = {
  value: '{"name": "Mariano"}' as Binary {encoding: "UTF-8"},
  encoding: "UTF-8",
  properties: {},
  mimeType: "application/json"
}

var jsonValue2 = {
  value: '{"name": "Mariano", "lastName": "achaval"}' as Binary {encoding: "UTF-8"},
  encoding: "UTF-8",
  properties: {},
  mimeType: "application/json"
}

var invalidJsonValue = {
  value: '{"name": "Mariano' as Binary {encoding: "UTF-8"},
  encoding: "UTF-8",
  properties: {},
  mimeType: "application/json"
}

var Utils = "fun sum(a,b) = a +b"
---
{
  "execute_ok" : run("main.dwl", {"main.dwl": "{a: 1}"}, {"payload": jsonValue }),
  "logs" : do {
    var execResult = run("main.dwl", {"main.dwl": "{a: log(1)}"}, {"payload": jsonValue })
    ---
    {
        m: execResult.logs.message,
        l: execResult.logs.level
    }
  },
  "grant" : run("main.dwl", {"main.dwl": "{a: readUrl(`http://google.com`)}"}, {"payload": jsonValue }, { securityManager: (grant, args) -> false }),
  "library" : run("main.dwl", {"main.dwl": "Utils::sum(1,2)", "/Utils.dwl": Utils }, {"payload": jsonValue }),
  "timeout" : run("main.dwl", {"main.dwl": "(1 to 1000000000000) map \$ + 1" }, {"payload": jsonValue }, {timeOut: 2}).success,
  "execFail" : run("main.dwl", {"main.dwl": "dw::Runtime::fail('My Bad')" }, {"payload": jsonValue }),
  "parseFail" : run("main.dwl", {"main.dwl": "(1 + " }, {"payload": jsonValue }),
  "writerFail" : run("main.dwl", {"main.dwl": "output application/xml --- 2" }, {"payload": jsonValue }),
  "readerFail" : run("main.dwl", {"main.dwl": "output application/xml --- payload" }, {"payload": invalidJsonValue }),
  "defaultOutput" : run("main.dwl", {"main.dwl": "payload" }, {"payload": jsonValue2}, {outputMimeType: "application/csv", writerProperties: {"separator": "|"}}),
}
```

#### Output

```Json
{
  "execute_ok": {
    "success": true,
    "value": "{\n  a: 1\n}",
    "mimeType": "application/dw",
    "encoding": "UTF-8",
    "logs": [

    ]
  },
  "logs": {
    "m": [
      "1"
    ],
    "l": [
      "INFO"
    ]
  },
  "grant": {
    "success": false,
    "message": "The given required permissions: `Resource` are not being granted for this execution.\nTrace:\n  at readUrl (Unknown)\n  at main::main (line: 1, column: 5)",
    "location": {
      "start": {
        "index": 0,
        "line": 0,
        "column": 0
      },
      "end": {
        "index": 0,
        "line": 0,
        "column": 0
      },
      "content": "Unknown location"
    },
    "stack": [
      "readUrl (anonymous:0:0)",
      "main (main:1:5)"
    ],
    "logs": [

    ]
  },
  "library": {
    "success": true,
    "value": "3",
    "mimeType": "application/dw",
    "encoding": "UTF-8",
    "logs": [

    ]
  },
  "timeout": false,
  "execFail": {
    "success": false,
    "message": "My Bad\nTrace:\n  at fail (Unknown)\n  at main::main (line: 1, column: 1)",
    "location": {
      "start": {
        "index": 0,
        "line": 0,
        "column": 0
      },
      "end": {
        "index": 0,
        "line": 0,
        "column": 0
      },
      "content": "Unknown location"
    },
    "stack": [
      "fail (anonymous:0:0)",
      "main (main:1:1)"
    ],
    "logs": [

    ]
  },
  "parseFail": {
    "success": false,
    "message": "Invalid input \"1 + \", expected parameter or parenEnd (line 1, column 2):\n\n\n1| (1 + \n    ^^^^\nLocation:\nmain (line: 1, column:2)",
    "location": {
      "start": {
        "index": 0,
        "line": 1,
        "column": 2
      },
      "end": {
        "index": 4,
        "line": 1,
        "column": 6
      },
      "content": "\n1| (1 + \n    ^^^^"
    },
    "logs": [

    ]
  },
  "writerFail": {
    "success": false,
    "message": "Trying to output non-whitespace characters outside main element tree (in prolog or epilog), while writing Xml at .",
    "location": {
      "content": ""
    },
    "stack": [

    ],
    "logs": [

    ]
  },
  "readerFail": {
    "success": false,
    "message": "Unexpected end-of-input at payload@[1:18] (line:column), expected '\"', while reading `payload` as Json.\n \n1| {\"name\": \"Mariano\n                    ^",
    "location": {
      "content": "\n1| {\"name\": \"Mariano\n                    ^"
    },
    "stack": [

    ],
    "logs": [

    ]
  },
  "defaultOutput": {
    "success": true,
    "value": "name|lastName\nMariano|achaval\n",
    "mimeType": "application/csv",
    "encoding": "UTF-8",
    "logs": [

    ]
  }
}
```

<!-- document id=f8d912ef4372f50b970a33d2e50b13271a55413d9b795898e1a6888ddf1eabac url=/mulesoft/current/en-us/dataweave/2.6/dw-runtime-functions-run.md -->

---
product: DataWeave
version: 2.6
---

# run

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## run(fileToExecute: String, fs: Dictionary<String>, readerInputs: Dictionary<ReaderInput> = {}, inputValues: Dictionary<Any> = {}, configuration: RuntimeExecutionConfiguration = {}): RunSuccess | ExecutionFailure

Runs the input script under the provided context and executes the script in the current runtime.

_Experimental:_ This function is an experimental feature that is subject to change or removal from
future versions of DataWeave.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>fileToExecute</code></p></td><td><p>Name of the file to execute.</p></td></tr><tr><td><p><code>fs</code></p></td><td><p>File system that contains the file to execute.</p></td></tr><tr><td><p><code>readerInput</code></p></td><td><p>Inputs to read and bind to the execution.</p></td></tr><tr><td><p><code>inputValues</code></p></td><td><p>Inputs to bind directly to the execution.</p></td></tr><tr><td><p><code>configuration</code></p></td><td><p>The runtime configuration.</p></td></tr></tbody></table>

### Example

This example shows how `run` behaves with different inputs.

#### Source

```DataWeave
import * from dw::Runtime
var jsonValue = {
  value: '{"name": "Mariano"}' as Binary {encoding: "UTF-8"},
  encoding: "UTF-8",
  properties: {},
  mimeType: "application/json"
}

var jsonValue2 = {
  value: '{"name": "Mariano", "lastName": "achaval"}' as Binary {encoding: "UTF-8"},
  encoding: "UTF-8",
  properties: {},
  mimeType: "application/json"
}

var invalidJsonValue = {
  value: '{"name": "Mariano' as Binary {encoding: "UTF-8"},
  encoding: "UTF-8",
  properties: {},
  mimeType: "application/json"
}

var Utils = "fun sum(a,b) = a +b"
---
{
  "execute_ok" : run("main.dwl", {"main.dwl": "{a: 1}"}, {"payload": jsonValue }),
  "logs" : do {
    var execResult = run("main.dwl", {"main.dwl": "{a: log(1)}"}, {"payload": jsonValue })
    ---
    {
        m: execResult.logs.message,
        l: execResult.logs.level
    }
  },
  "grant" : run("main.dwl", {"main.dwl": "{a: readUrl(`http://google.com`)}"}, {"payload": jsonValue }, { securityManager: (grant, args) -> false }),
  "library" : run("main.dwl", {"main.dwl": "Utils::sum(1,2)", "/Utils.dwl": Utils }, {"payload": jsonValue }),
  "timeout" : run("main.dwl", {"main.dwl": "(1 to 1000000000000) map \$ + 1" }, {"payload": jsonValue }, {timeOut: 2}).success,
  "execFail" : run("main.dwl", {"main.dwl": "dw::Runtime::fail('My Bad')" }, {"payload": jsonValue }),
  "parseFail" : run("main.dwl", {"main.dwl": "(1 + " }, {"payload": jsonValue }),
  "writerFail" : run("main.dwl", {"main.dwl": "output application/xml --- 2" }, {"payload": jsonValue }),
  "readerFail" : run("main.dwl", {"main.dwl": "output application/xml --- payload" }, {"payload": invalidJsonValue }),
  "defaultOutput" : run("main.dwl", {"main.dwl": "payload" }, {"payload": jsonValue2}, {outputMimeType: "application/csv", writerProperties: {"separator": "|"}}),
}
```

#### Output

```Json
{
  "execute_ok": {
    "success": true,
    "value": "{\n  a: 1\n}",
    "mimeType": "application/dw",
    "encoding": "UTF-8",
    "logs": [

    ]
  },
  "logs": {
    "m": [
      "1"
    ],
    "l": [
      "INFO"
    ]
  },
  "grant": {
    "success": false,
    "message": "The given required permissions: `Resource` are not being granted for this execution.\nTrace:\n  at readUrl (Unknown)\n  at main::main (line: 1, column: 5)",
    "location": {
      "start": {
        "index": 0,
        "line": 0,
        "column": 0
      },
      "end": {
        "index": 0,
        "line": 0,
        "column": 0
      },
      "content": "Unknown location"
    },
    "stack": [
      "readUrl (anonymous:0:0)",
      "main (main:1:5)"
    ],
    "logs": [

    ]
  },
  "library": {
    "success": true,
    "value": "3",
    "mimeType": "application/dw",
    "encoding": "UTF-8",
    "logs": [

    ]
  },
  "timeout": false,
  "execFail": {
    "success": false,
    "message": "My Bad\nTrace:\n  at fail (Unknown)\n  at main::main (line: 1, column: 1)",
    "location": {
      "start": {
        "index": 0,
        "line": 0,
        "column": 0
      },
      "end": {
        "index": 0,
        "line": 0,
        "column": 0
      },
      "content": "Unknown location"
    },
    "stack": [
      "fail (anonymous:0:0)",
      "main (main:1:1)"
    ],
    "logs": [

    ]
  },
  "parseFail": {
    "success": false,
    "message": "Invalid input \"1 + \", expected parameter or parenEnd (line 1, column 2):\n\n\n1| (1 + \n    ^^^^\nLocation:\nmain (line: 1, column:2)",
    "location": {
      "start": {
        "index": 0,
        "line": 1,
        "column": 2
      },
      "end": {
        "index": 4,
        "line": 1,
        "column": 6
      },
      "content": "\n1| (1 + \n    ^^^^"
    },
    "logs": [

    ]
  },
  "writerFail": {
    "success": false,
    "message": "Trying to output non-whitespace characters outside main element tree (in prolog or epilog), while writing Xml at .",
    "location": {
      "content": ""
    },
    "stack": [

    ],
    "logs": [

    ]
  },
  "readerFail": {
    "success": false,
    "message": "Unexpected end-of-input at payload@[1:18] (line:column), expected '\"', while reading `payload` as Json.\n \n1| {\"name\": \"Mariano\n                    ^",
    "location": {
      "content": "\n1| {\"name\": \"Mariano\n                    ^"
    },
    "stack": [

    ],
    "logs": [

    ]
  },
  "defaultOutput": {
    "success": true,
    "value": "name|lastName\nMariano|achaval\n",
    "mimeType": "application/csv",
    "encoding": "UTF-8",
    "logs": [

    ]
  }
}
```

<!-- document id=615c604bdf81f94c5e683dc226bce2a39442a5143203d0fcc1e513073b5179e2 url=/mulesoft/current/en-us/dataweave/2.9/dw-runtime-functions-run.md -->

---
product: DataWeave
version: 2.9
---

# run

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## run(fileToExecute: String, fs: Dictionary<String>, readerInputs: Dictionary<ReaderInput> = {}, inputValues: Dictionary<Any> = {}, configuration: RuntimeExecutionConfiguration = {}): RunResult

Runs the input script under the provided context and executes the script in the current runtime.

_Experimental:_ This function is an experimental feature that is subject to change or removal from
future versions of DataWeave.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>fileToExecute</code></p></td><td><p>Name of the file to execute.</p></td></tr><tr><td><p><code>fs</code></p></td><td><p>File system that contains the file to execute.</p></td></tr><tr><td><p><code>readerInput</code></p></td><td><p>Inputs to read and bind to the execution.</p></td></tr><tr><td><p><code>inputValues</code></p></td><td><p>Inputs to bind directly to the execution.</p></td></tr><tr><td><p><code>configuration</code></p></td><td><p>The runtime configuration.</p></td></tr></tbody></table>

### Example

This example shows how `run` behaves with different inputs.

#### Source

```DataWeave
import * from dw::Runtime
var jsonValue = {
  value: '{"name": "Mariano"}' as Binary {encoding: "UTF-8"},
  encoding: "UTF-8",
  properties: {},
  mimeType: "application/json"
}

var jsonValue2 = {
  value: '{"name": "Mariano", "lastName": "achaval"}' as Binary {encoding: "UTF-8"},
  encoding: "UTF-8",
  properties: {},
  mimeType: "application/json"
}

var invalidJsonValue = {
  value: '{"name": "Mariano' as Binary {encoding: "UTF-8"},
  encoding: "UTF-8",
  properties: {},
  mimeType: "application/json"
}

var Utils = "fun sum(a,b) = a +b"
---
{
  "execute_ok" : run("main.dwl", {"main.dwl": "{a: 1}"}, {"payload": jsonValue }),
  "logs" : do {
    var execResult = run("main.dwl", {"main.dwl": "{a: log(1)}"}, {"payload": jsonValue })
    ---
    {
        m: execResult.logs.message,
        l: execResult.logs.level
    }
  },
  "grant" : run("main.dwl", {"main.dwl": "{a: readUrl(`http://google.com`)}"}, {"payload": jsonValue }, { securityManager: (grant, args) -> false }),
  "library" : run("main.dwl", {"main.dwl": "Utils::sum(1,2)", "/Utils.dwl": Utils }, {"payload": jsonValue }),
  "timeout" : run("main.dwl", {"main.dwl": "(1 to 1000000000000) map \$ + 1" }, {"payload": jsonValue }, {timeOut: 2}).success,
  "execFail" : run("main.dwl", {"main.dwl": "dw::Runtime::fail('My Bad')" }, {"payload": jsonValue }),
  "parseFail" : run("main.dwl", {"main.dwl": "(1 + " }, {"payload": jsonValue }),
  "writerFail" : run("main.dwl", {"main.dwl": "output application/xml --- 2" }, {"payload": jsonValue }),
  "readerFail" : run("main.dwl", {"main.dwl": "output application/xml --- payload" }, {"payload": invalidJsonValue }),
  "defaultOutput" : run("main.dwl", {"main.dwl": "payload" }, {"payload": jsonValue2}, {outputMimeType: "application/csv", writerProperties: {"separator": "|"}}),
}
```

#### Output

```Json
{
  "execute_ok": {
    "success": true,
    "value": "{\n  a: 1\n}",
    "mimeType": "application/dw",
    "encoding": "UTF-8",
    "logs": [

    ]
  },
  "logs": {
    "m": [
      "1"
    ],
    "l": [
      "INFO"
    ]
  },
  "grant": {
    "success": false,
    "message": "The given required permissions: `Resource` are not being granted for this execution.\nTrace:\n  at readUrl (Unknown)\n  at main::main (line: 1, column: 5)",
    "location": {
      "start": {
        "index": 0,
        "line": 0,
        "column": 0
      },
      "end": {
        "index": 0,
        "line": 0,
        "column": 0
      },
      "content": "Unknown location"
    },
    "stack": [
      "readUrl (anonymous:0:0)",
      "main (main:1:5)"
    ],
    "logs": [

    ]
  },
  "library": {
    "success": true,
    "value": "3",
    "mimeType": "application/dw",
    "encoding": "UTF-8",
    "logs": [

    ]
  },
  "timeout": false,
  "execFail": {
    "success": false,
    "message": "My Bad\nTrace:\n  at fail (Unknown)\n  at main::main (line: 1, column: 1)",
    "location": {
      "start": {
        "index": 0,
        "line": 0,
        "column": 0
      },
      "end": {
        "index": 0,
        "line": 0,
        "column": 0
      },
      "content": "Unknown location"
    },
    "stack": [
      "fail (anonymous:0:0)",
      "main (main:1:1)"
    ],
    "logs": [

    ]
  },
  "parseFail": {
    "success": false,
    "message": "Invalid input \"1 + \", expected parameter or parenEnd (line 1, column 2):\n\n\n1| (1 + \n    ^^^^\nLocation:\nmain (line: 1, column:2)",
    "location": {
      "start": {
        "index": 0,
        "line": 1,
        "column": 2
      },
      "end": {
        "index": 4,
        "line": 1,
        "column": 6
      },
      "content": "\n1| (1 + \n    ^^^^"
    },
    "logs": [

    ]
  },
  "writerFail": {
    "success": false,
    "message": "Trying to output non-whitespace characters outside main element tree (in prolog or epilog), while writing Xml at .",
    "location": {
      "content": ""
    },
    "stack": [

    ],
    "logs": [

    ]
  },
  "readerFail": {
    "success": false,
    "message": "Unexpected end-of-input at payload@[1:18] (line:column), expected '\"', while reading `payload` as Json.\n \n1| {\"name\": \"Mariano\n                    ^",
    "location": {
      "content": "\n1| {\"name\": \"Mariano\n                    ^"
    },
    "stack": [

    ],
    "logs": [

    ]
  },
  "defaultOutput": {
    "success": true,
    "value": "name|lastName\nMariano|achaval\n",
    "mimeType": "application/csv",
    "encoding": "UTF-8",
    "logs": [

    ]
  }
}
```

<!-- document id=e2cb7d8b9596d3fedd076b8b92fdcb1379e0c438c515cc035f813b4789541ca8 url=/mulesoft/current/en-us/dataweave/latest/dw-runtime-functions-run.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# run

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## run(fileToExecute: String, fs: Dictionary<String>, readerInputs: Dictionary<ReaderInput> = {}, inputValues: Dictionary<Any> = {}, configuration: RuntimeExecutionConfiguration = {}): RunResult

Runs the input script under the provided context and executes the script in the current runtime.

_Experimental:_ This function is an experimental feature that is subject to change or removal from
future versions of DataWeave.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>fileToExecute</code></p></td><td><p>Name of the file to execute.</p></td></tr><tr><td><p><code>fs</code></p></td><td><p>File system that contains the file to execute.</p></td></tr><tr><td><p><code>readerInput</code></p></td><td><p>Inputs to read and bind to the execution.</p></td></tr><tr><td><p><code>inputValues</code></p></td><td><p>Inputs to bind directly to the execution.</p></td></tr><tr><td><p><code>configuration</code></p></td><td><p>The runtime configuration.</p></td></tr></tbody></table>

### Example

This example shows how `run` behaves with different inputs.

#### Source

```DataWeave
import * from dw::Runtime
var jsonValue = {
  value: '{"name": "Mariano"}' as Binary {encoding: "UTF-8"},
  encoding: "UTF-8",
  properties: {},
  mimeType: "application/json"
}

var jsonValue2 = {
  value: '{"name": "Mariano", "lastName": "achaval"}' as Binary {encoding: "UTF-8"},
  encoding: "UTF-8",
  properties: {},
  mimeType: "application/json"
}

var invalidJsonValue = {
  value: '{"name": "Mariano' as Binary {encoding: "UTF-8"},
  encoding: "UTF-8",
  properties: {},
  mimeType: "application/json"
}

var Utils = "fun sum(a,b) = a +b"
---
{
  "execute_ok" : run("main.dwl", {"main.dwl": "{a: 1}"}, {"payload": jsonValue }),
  "logs" : do {
    var execResult = run("main.dwl", {"main.dwl": "{a: log(1)}"}, {"payload": jsonValue })
    ---
    {
        m: execResult.logs.message,
        l: execResult.logs.level
    }
  },
  "grant" : run("main.dwl", {"main.dwl": "{a: readUrl(`http://google.com`)}"}, {"payload": jsonValue }, { securityManager: (grant, args) -> false }),
  "library" : run("main.dwl", {"main.dwl": "Utils::sum(1,2)", "/Utils.dwl": Utils }, {"payload": jsonValue }),
  "timeout" : run("main.dwl", {"main.dwl": "(1 to 1000000000000) map \$ + 1" }, {"payload": jsonValue }, {timeOut: 2}).success,
  "execFail" : run("main.dwl", {"main.dwl": "dw::Runtime::fail('My Bad')" }, {"payload": jsonValue }),
  "parseFail" : run("main.dwl", {"main.dwl": "(1 + " }, {"payload": jsonValue }),
  "writerFail" : run("main.dwl", {"main.dwl": "output application/xml --- 2" }, {"payload": jsonValue }),
  "readerFail" : run("main.dwl", {"main.dwl": "output application/xml --- payload" }, {"payload": invalidJsonValue }),
  "defaultOutput" : run("main.dwl", {"main.dwl": "payload" }, {"payload": jsonValue2}, {outputMimeType: "application/csv", writerProperties: {"separator": "|"}}),
}
```

#### Output

```Json
{
  "execute_ok": {
    "success": true,
    "value": "{\n  a: 1\n}",
    "mimeType": "application/dw",
    "encoding": "UTF-8",
    "logs": [

    ]
  },
  "logs": {
    "m": [
      "1"
    ],
    "l": [
      "INFO"
    ]
  },
  "grant": {
    "success": false,
    "message": "The given required permissions: `Resource` are not being granted for this execution.\nTrace:\n  at readUrl (Unknown)\n  at main::main (line: 1, column: 5)",
    "location": {
      "start": {
        "index": 0,
        "line": 0,
        "column": 0
      },
      "end": {
        "index": 0,
        "line": 0,
        "column": 0
      },
      "content": "Unknown location"
    },
    "stack": [
      "readUrl (anonymous:0:0)",
      "main (main:1:5)"
    ],
    "logs": [

    ]
  },
  "library": {
    "success": true,
    "value": "3",
    "mimeType": "application/dw",
    "encoding": "UTF-8",
    "logs": [

    ]
  },
  "timeout": false,
  "execFail": {
    "success": false,
    "message": "My Bad\nTrace:\n  at fail (Unknown)\n  at main::main (line: 1, column: 1)",
    "location": {
      "start": {
        "index": 0,
        "line": 0,
        "column": 0
      },
      "end": {
        "index": 0,
        "line": 0,
        "column": 0
      },
      "content": "Unknown location"
    },
    "stack": [
      "fail (anonymous:0:0)",
      "main (main:1:1)"
    ],
    "logs": [

    ]
  },
  "parseFail": {
    "success": false,
    "message": "Invalid input \"1 + \", expected parameter or parenEnd (line 1, column 2):\n\n\n1| (1 + \n    ^^^^\nLocation:\nmain (line: 1, column:2)",
    "location": {
      "start": {
        "index": 0,
        "line": 1,
        "column": 2
      },
      "end": {
        "index": 4,
        "line": 1,
        "column": 6
      },
      "content": "\n1| (1 + \n    ^^^^"
    },
    "logs": [

    ]
  },
  "writerFail": {
    "success": false,
    "message": "Trying to output non-whitespace characters outside main element tree (in prolog or epilog), while writing Xml at .",
    "location": {
      "content": ""
    },
    "stack": [

    ],
    "logs": [

    ]
  },
  "readerFail": {
    "success": false,
    "message": "Unexpected end-of-input at payload@[1:18] (line:column), expected '\"', while reading `payload` as Json.\n \n1| {\"name\": \"Mariano\n                    ^",
    "location": {
      "content": "\n1| {\"name\": \"Mariano\n                    ^"
    },
    "stack": [

    ],
    "logs": [

    ]
  },
  "defaultOutput": {
    "success": true,
    "value": "name|lastName\nMariano|achaval\n",
    "mimeType": "application/csv",
    "encoding": "UTF-8",
    "logs": [

    ]
  }
}
```

<!-- document id=3fa4be451c02894d53932e6169ab43317deb3a0b3d5aa14a2011da4c9fff995c url=/mulesoft/current/en-us/dataweave/2.11/dw-runtime.md -->

---
product: DataWeave
version: 2.11
---

# Runtime (dw::Runtime)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains functions for interacting with the DataWeave runtime, which executes the
language.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::Runtime` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-runtime-functions-dataformatsdescriptor">dataFormatsDescriptor</a></p></td><td><p>Returns an array of all <code>DataFormatDescriptor</code> values that are installed in the current instance of DataWeave.</p><p><em>Experimental:</em> This function is an experimental feature that is subject to change or removal from future versions.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-runtime-functions-eval">eval</a></p></td><td><p>Evaluates a script with the specified context and returns the result of that evaluation.</p><p><em>Experimental:</em> This function is an experimental feature that is subject to change or removal from future versions.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-runtime-functions-evalurl">evalUrl</a></p></td><td><p>Evaluates the script at the specified URL.</p><p><em>Experimental:</em> This function is an experimental feature that is subject to change or removal from future versions.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-runtime-functions-fail">fail</a></p></td><td><p>Throws an exception with the specified message.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-runtime-functions-failif">failIf</a></p></td><td><p>Produces an error with the specified message if the expression in the evaluator returns <code>true</code>. Otherwise, the function returns the value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-runtime-functions-finddataformatdescriptorbymime">findDataFormatDescriptorByMime</a></p></td><td><p>Returns the <code>DataFormatDescriptor</code> based on the <code>dw::module::Mime::MimeType</code> specified or <code>null</code> if there is no <code>DataFormatDescriptor</code> for the given <code>MimeType</code>.</p><p><em>Experimental:</em> This function is an experimental feature that is subject to change or removal from future versions.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-runtime-functions-location">location</a></p></td><td><p>Returns the location of a given value, or <code>null</code> if the location can’t be traced back to a DataWeave file.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-runtime-functions-locationstring">locationString</a></p></td><td><p>Returns the location string of a given value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-runtime-functions-orelse">orElse</a></p></td><td><p>Returns the result of the <code>orElse</code> argument if the <code>previous</code> argument to <code>try</code> fails. Otherwise, the function returns the value of the <code>previous</code> argument.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-runtime-functions-orelsetry">orElseTry</a></p></td><td><p>Function to use with <code>try</code> to chain multiple <code>try</code> requests.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-runtime-functions-prop">prop</a></p></td><td><p>Returns the value of the property with the specified name or <code>null</code> if the property is not defined.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-runtime-functions-props">props</a></p></td><td><p>Returns all the properties configured for the DataWeave runtime, which executes the language.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-runtime-functions-run">run</a></p></td><td><p>Runs the input script under the provided context and executes the script in the current runtime.</p><p><em>Experimental:</em> This function is an experimental feature that is subject to change or removal from future versions.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-runtime-functions-runurl">runUrl</a></p></td><td><p>Runs the script at the specified URL.</p><p><em>Experimental:</em> This function is an experimental feature that is subject to change or removal from future versions.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-runtime-functions-try">try</a></p></td><td><p>Evaluates the delegate function and returns an object with <code>success: true</code> and <code>result</code> if the delegate function succeeds, or an object with <code>success: false</code> and <code>error</code> if the delegate function throws an exception.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-runtime-functions-version">version</a></p></td><td><p>Returns the DataWeave version that is currently running.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-runtime-functions-wait">wait</a></p></td><td><p>Stops the execution for the specified timeout period (in milliseconds).</p></td></tr></tbody></table>

## Types

- [Runtime Types](https://docs.mulesoft.com/dataweave/2.11/dw-runtime-types)

<!-- document id=0025d544163cb4945ff80818edd50ae9cbf88e17ece279660705b94b76d662e0 url=/mulesoft/current/en-us/dataweave/2.12/dw-runtime.md -->

---
product: DataWeave
version: 2.12
---

# Runtime (dw::Runtime)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains functions for interacting with the DataWeave runtime, which executes the
language.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::Runtime` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-runtime-functions-dataformatsdescriptor">dataFormatsDescriptor</a></p></td><td><p>Returns an array of all <code>DataFormatDescriptor</code> values that are installed in the current instance of DataWeave.</p><p><em>Experimental:</em> This function is an experimental feature that is subject to change or removal from future versions.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-runtime-functions-eval">eval</a></p></td><td><p>Evaluates a script with the specified context and returns the result of that evaluation.</p><p><em>Experimental:</em> This function is an experimental feature that is subject to change or removal from future versions.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-runtime-functions-evalurl">evalUrl</a></p></td><td><p>Evaluates the script at the specified URL.</p><p><em>Experimental:</em> This function is an experimental feature that is subject to change or removal from future versions.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-runtime-functions-fail">fail</a></p></td><td><p>Throws an exception with the specified message.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-runtime-functions-failif">failIf</a></p></td><td><p>Produces an error with the specified message if the expression in the evaluator returns <code>true</code>. Otherwise, the function returns the value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-runtime-functions-finddataformatdescriptorbymime">findDataFormatDescriptorByMime</a></p></td><td><p>Returns the <code>DataFormatDescriptor</code> based on the <code>dw::module::Mime::MimeType</code> specified or <code>null</code> if there is no <code>DataFormatDescriptor</code> for the given <code>MimeType</code>.</p><p><em>Experimental:</em> This function is an experimental feature that is subject to change or removal from future versions.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-runtime-functions-location">location</a></p></td><td><p>Returns the location of a given value, or <code>null</code> if the location can’t be traced back to a DataWeave file.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-runtime-functions-locationstring">locationString</a></p></td><td><p>Returns the location string of a given value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-runtime-functions-orelse">orElse</a></p></td><td><p>Returns the result of the <code>orElse</code> argument if the <code>previous</code> argument to <code>try</code> fails. Otherwise, the function returns the value of the <code>previous</code> argument.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-runtime-functions-orelsetry">orElseTry</a></p></td><td><p>Function to use with <code>try</code> to chain multiple <code>try</code> requests.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-runtime-functions-prop">prop</a></p></td><td><p>Returns the value of the property with the specified name or <code>null</code> if the property is not defined.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-runtime-functions-props">props</a></p></td><td><p>Returns all the properties configured for the DataWeave runtime, which executes the language.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-runtime-functions-run">run</a></p></td><td><p>Runs the input script under the provided context and executes the script in the current runtime.</p><p><em>Experimental:</em> This function is an experimental feature that is subject to change or removal from future versions.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-runtime-functions-runurl">runUrl</a></p></td><td><p>Runs the script at the specified URL.</p><p><em>Experimental:</em> This function is an experimental feature that is subject to change or removal from future versions.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-runtime-functions-try">try</a></p></td><td><p>Evaluates the delegate function and returns an object with <code>success: true</code> and <code>result</code> if the delegate function succeeds, or an object with <code>success: false</code> and <code>error</code> if the delegate function throws an exception.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-runtime-functions-version">version</a></p></td><td><p>Returns the DataWeave version that is currently running.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-runtime-functions-wait">wait</a></p></td><td><p>Stops the execution for the specified timeout period (in milliseconds).</p></td></tr></tbody></table>

## Types

- [Runtime Types](https://docs.mulesoft.com/dataweave/2.12/dw-runtime-types)

<!-- document id=82d1953b6a6cd4b27afb4b137d1e69ed2d6162142f78db6013d1172820b00cbf url=/mulesoft/current/en-us/dataweave/2.3/dw-runtime.md -->

---
product: DataWeave
version: 2.3
---

# Runtime (dw::Runtime)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains functions that allow you to interact with the DataWeave engine.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::Runtime` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-runtime-functions-fail">fail</a></p></td><td><p>Throws an exception with the specified message.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-runtime-functions-failif">failIf</a></p></td><td><p>Produces an error with the specified message if the expression in the evaluator returns <code>true</code>, otherwise returns the value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-runtime-functions-locationstring">locationString</a></p></td><td><p>Returns the location string of a given value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-runtime-functions-orelse">orElse</a></p></td><td><p>Returns the result of the <code>orElse</code> if the <code>previous</code> try result failed if not returns the result of the <code>previous</code></p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-runtime-functions-orelsetry">orElseTry</a></p></td><td><p>Function to be use with try in order to chain multiple <code>try</code></p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-runtime-functions-prop">prop</a></p></td><td><p>Returns the value of the property with the specified name or <code>null</code> if the property is not defined.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-runtime-functions-props">props</a></p></td><td><p>Returns all the properties configured for Mule runtime.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-runtime-functions-try">try</a></p></td><td><p>Evaluates the delegate function and returns an object with <code>success: true</code> and <code>result</code> if the delegate function succeeds, or an object with <code>success: false</code> and <code>error</code> if the delegate function throws an exception.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-runtime-functions-wait">wait</a></p></td><td><p>Stops the execution for the specified timeout (in milliseconds).</p></td></tr></tbody></table>

## Types

- [Runtime Types](https://docs.mulesoft.com/dataweave/2.3/dw-runtime-types)

<!-- document id=7da6d7b29ea70899fac87b0a4f1567d733c571d7dd241a3d90a67d271cbf9543 url=/mulesoft/current/en-us/dataweave/2.4/dw-runtime.md -->

---
product: DataWeave
version: 2.4
---

# Runtime (dw::Runtime)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains functions for interacting with the DataWeave runtime, which executes the
language.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::Runtime` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-runtime-functions-dataformatsdescriptor">dataFormatsDescriptor</a></p></td><td><p>Returns an array of all <code>DataFormatDescriptor</code> values that are installed in the current instance of DataWeave.</p><p><em>Experimental:</em> This function is an experimental feature that is subject to change or removal from future versions</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-runtime-functions-eval">eval</a></p></td><td><p>Evaluates a script with the specified context and returns the result of that evaluation.</p><p><em>Experimental:</em> This function is an experimental feature that is subject to change or removal from future versions</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-runtime-functions-evalurl">evalUrl</a></p></td><td><p>Evaluates the script at the specified URL.</p><p><em>Experimental:</em> This function is an experimental feature that is subject to change or removal from future versions</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-runtime-functions-fail">fail</a></p></td><td><p>Throws an exception with the specified message.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-runtime-functions-failif">failIf</a></p></td><td><p>Produces an error with the specified message if the expression in the evaluator returns <code>true</code>. Otherwise, the function returns the value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-runtime-functions-location">location</a></p></td><td><p>Returns the location of a given value, or <code>null</code> if the location can’t be traced back to a DataWeave file.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-runtime-functions-locationstring">locationString</a></p></td><td><p>Returns the location string of a given value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-runtime-functions-orelse">orElse</a></p></td><td><p>Returns the result of the <code>orElse</code> argument if the <code>previous</code> argument to <code>try</code> fails. Otherwise, the function returns the value of the <code>previous</code> argument.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-runtime-functions-orelsetry">orElseTry</a></p></td><td><p>Function to use with <code>try</code> to chain multiple <code>try</code> requests.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-runtime-functions-prop">prop</a></p></td><td><p>Returns the value of the property with the specified name or <code>null</code> if the property is not defined.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-runtime-functions-props">props</a></p></td><td><p>Returns all the properties configured for the DataWeave runtime, which executes the language.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-runtime-functions-run">run</a></p></td><td><p>Runs the input script under the provided context and executes the script in the current runtime.</p><p><em>Experimental:</em> This function is an experimental feature that is subject to change or removal from future versions</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-runtime-functions-runurl">runUrl</a></p></td><td><p>Runs the script at the specified URL.</p><p><em>Experimental:</em> This function is an experimental feature that is subject to change or removal from future versions</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-runtime-functions-try">try</a></p></td><td><p>Evaluates the delegate function and returns an object with <code>success: true</code> and <code>result</code> if the delegate function succeeds, or an object with <code>success: false</code> and <code>error</code> if the delegate function throws an exception.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-runtime-functions-wait">wait</a></p></td><td><p>Stops the execution for the specified timeout period (in milliseconds).</p></td></tr></tbody></table>

## Types

- [Runtime Types](https://docs.mulesoft.com/dataweave/2.4/dw-runtime-types)

<!-- document id=ea6d33440f27240f12af1f667321e3806437cc8b4f2f54059859103d5a23e48b url=/mulesoft/current/en-us/dataweave/2.6/dw-runtime.md -->

---
product: DataWeave
version: 2.6
---

# Runtime (dw::Runtime)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains functions for interacting with the DataWeave runtime, which executes the
language.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::Runtime` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-runtime-functions-dataformatsdescriptor">dataFormatsDescriptor</a></p></td><td><p>Returns an array of all <code>DataFormatDescriptor</code> values that are installed in the current instance of DataWeave.</p><p><em>Experimental:</em> This function is an experimental feature that is subject to change or removal from future versions.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-runtime-functions-eval">eval</a></p></td><td><p>Evaluates a script with the specified context and returns the result of that evaluation.</p><p><em>Experimental:</em> This function is an experimental feature that is subject to change or removal from future versions.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-runtime-functions-evalurl">evalUrl</a></p></td><td><p>Evaluates the script at the specified URL.</p><p><em>Experimental:</em> This function is an experimental feature that is subject to change or removal from future versions.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-runtime-functions-fail">fail</a></p></td><td><p>Throws an exception with the specified message.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-runtime-functions-failif">failIf</a></p></td><td><p>Produces an error with the specified message if the expression in the evaluator returns <code>true</code>. Otherwise, the function returns the value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-runtime-functions-location">location</a></p></td><td><p>Returns the location of a given value, or <code>null</code> if the location can’t be traced back to a DataWeave file.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-runtime-functions-locationstring">locationString</a></p></td><td><p>Returns the location string of a given value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-runtime-functions-orelse">orElse</a></p></td><td><p>Returns the result of the <code>orElse</code> argument if the <code>previous</code> argument to <code>try</code> fails. Otherwise, the function returns the value of the <code>previous</code> argument.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-runtime-functions-orelsetry">orElseTry</a></p></td><td><p>Function to use with <code>try</code> to chain multiple <code>try</code> requests.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-runtime-functions-prop">prop</a></p></td><td><p>Returns the value of the property with the specified name or <code>null</code> if the property is not defined.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-runtime-functions-props">props</a></p></td><td><p>Returns all the properties configured for the DataWeave runtime, which executes the language.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-runtime-functions-run">run</a></p></td><td><p>Runs the input script under the provided context and executes the script in the current runtime.</p><p><em>Experimental:</em> This function is an experimental feature that is subject to change or removal from future versions.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-runtime-functions-runurl">runUrl</a></p></td><td><p>Runs the script at the specified URL.</p><p><em>Experimental:</em> This function is an experimental feature that is subject to change or removal from future versions.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-runtime-functions-try">try</a></p></td><td><p>Evaluates the delegate function and returns an object with <code>success: true</code> and <code>result</code> if the delegate function succeeds, or an object with <code>success: false</code> and <code>error</code> if the delegate function throws an exception.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-runtime-functions-version">version</a></p></td><td><p>Returns the DataWeave version that is currently running.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-runtime-functions-wait">wait</a></p></td><td><p>Stops the execution for the specified timeout period (in milliseconds).</p></td></tr></tbody></table>

## Types

- [Runtime Types](https://docs.mulesoft.com/dataweave/2.6/dw-runtime-types)

<!-- document id=4cf64f5d217e4d3b4c46e7c840325a1a2ba132ab3e9de6fede5dae4e162b4f71 url=/mulesoft/current/en-us/dataweave/2.9/dw-runtime.md -->

---
product: DataWeave
version: 2.9
---

# Runtime (dw::Runtime)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains functions for interacting with the DataWeave runtime, which executes the
language.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::Runtime` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-runtime-functions-dataformatsdescriptor">dataFormatsDescriptor</a></p></td><td><p>Returns an array of all <code>DataFormatDescriptor</code> values that are installed in the current instance of DataWeave.</p><p><em>Experimental:</em> This function is an experimental feature that is subject to change or removal from future versions.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-runtime-functions-eval">eval</a></p></td><td><p>Evaluates a script with the specified context and returns the result of that evaluation.</p><p><em>Experimental:</em> This function is an experimental feature that is subject to change or removal from future versions.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-runtime-functions-evalurl">evalUrl</a></p></td><td><p>Evaluates the script at the specified URL.</p><p><em>Experimental:</em> This function is an experimental feature that is subject to change or removal from future versions.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-runtime-functions-fail">fail</a></p></td><td><p>Throws an exception with the specified message.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-runtime-functions-failif">failIf</a></p></td><td><p>Produces an error with the specified message if the expression in the evaluator returns <code>true</code>. Otherwise, the function returns the value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-runtime-functions-finddataformatdescriptorbymime">findDataFormatDescriptorByMime</a></p></td><td><p>Returns the <code>DataFormatDescriptor</code> based on the <code>dw::module::Mime::MimeType</code> specified or <code>null</code> if there is no <code>DataFormatDescriptor</code> for the given <code>MimeType</code>.</p><p><em>Experimental:</em> This function is an experimental feature that is subject to change or removal from future versions.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-runtime-functions-location">location</a></p></td><td><p>Returns the location of a given value, or <code>null</code> if the location can’t be traced back to a DataWeave file.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-runtime-functions-locationstring">locationString</a></p></td><td><p>Returns the location string of a given value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-runtime-functions-orelse">orElse</a></p></td><td><p>Returns the result of the <code>orElse</code> argument if the <code>previous</code> argument to <code>try</code> fails. Otherwise, the function returns the value of the <code>previous</code> argument.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-runtime-functions-orelsetry">orElseTry</a></p></td><td><p>Function to use with <code>try</code> to chain multiple <code>try</code> requests.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-runtime-functions-prop">prop</a></p></td><td><p>Returns the value of the property with the specified name or <code>null</code> if the property is not defined.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-runtime-functions-props">props</a></p></td><td><p>Returns all the properties configured for the DataWeave runtime, which executes the language.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-runtime-functions-run">run</a></p></td><td><p>Runs the input script under the provided context and executes the script in the current runtime.</p><p><em>Experimental:</em> This function is an experimental feature that is subject to change or removal from future versions.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-runtime-functions-runurl">runUrl</a></p></td><td><p>Runs the script at the specified URL.</p><p><em>Experimental:</em> This function is an experimental feature that is subject to change or removal from future versions.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-runtime-functions-try">try</a></p></td><td><p>Evaluates the delegate function and returns an object with <code>success: true</code> and <code>result</code> if the delegate function succeeds, or an object with <code>success: false</code> and <code>error</code> if the delegate function throws an exception.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-runtime-functions-version">version</a></p></td><td><p>Returns the DataWeave version that is currently running.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-runtime-functions-wait">wait</a></p></td><td><p>Stops the execution for the specified timeout period (in milliseconds).</p></td></tr></tbody></table>

## Types

- [Runtime Types](https://docs.mulesoft.com/dataweave/2.9/dw-runtime-types)

<!-- document id=9c1c625547728838232d3f2288ff323a178d76c3dca828d06dfce5ad65c1d966 url=/mulesoft/current/en-us/dataweave/latest/dw-runtime.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Runtime (dw::Runtime)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains functions for interacting with the DataWeave runtime, which executes the
language.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::Runtime` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-runtime-functions-dataformatsdescriptor">dataFormatsDescriptor</a></p></td><td><p>Returns an array of all <code>DataFormatDescriptor</code> values that are installed in the current instance of DataWeave.</p><p><em>Experimental:</em> This function is an experimental feature that is subject to change or removal from future versions.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-runtime-functions-eval">eval</a></p></td><td><p>Evaluates a script with the specified context and returns the result of that evaluation.</p><p><em>Experimental:</em> This function is an experimental feature that is subject to change or removal from future versions.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-runtime-functions-evalurl">evalUrl</a></p></td><td><p>Evaluates the script at the specified URL.</p><p><em>Experimental:</em> This function is an experimental feature that is subject to change or removal from future versions.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-runtime-functions-fail">fail</a></p></td><td><p>Throws an exception with the specified message.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-runtime-functions-failif">failIf</a></p></td><td><p>Produces an error with the specified message if the expression in the evaluator returns <code>true</code>. Otherwise, the function returns the value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-runtime-functions-finddataformatdescriptorbymime">findDataFormatDescriptorByMime</a></p></td><td><p>Returns the <code>DataFormatDescriptor</code> based on the <code>dw::module::Mime::MimeType</code> specified or <code>null</code> if there is no <code>DataFormatDescriptor</code> for the given <code>MimeType</code>.</p><p><em>Experimental:</em> This function is an experimental feature that is subject to change or removal from future versions.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-runtime-functions-location">location</a></p></td><td><p>Returns the location of a given value, or <code>null</code> if the location can’t be traced back to a DataWeave file.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-runtime-functions-locationstring">locationString</a></p></td><td><p>Returns the location string of a given value.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-runtime-functions-orelse">orElse</a></p></td><td><p>Returns the result of the <code>orElse</code> argument if the <code>previous</code> argument to <code>try</code> fails. Otherwise, the function returns the value of the <code>previous</code> argument.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-runtime-functions-orelsetry">orElseTry</a></p></td><td><p>Function to use with <code>try</code> to chain multiple <code>try</code> requests.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-runtime-functions-prop">prop</a></p></td><td><p>Returns the value of the property with the specified name or <code>null</code> if the property is not defined.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-runtime-functions-props">props</a></p></td><td><p>Returns all the properties configured for the DataWeave runtime, which executes the language.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-runtime-functions-run">run</a></p></td><td><p>Runs the input script under the provided context and executes the script in the current runtime.</p><p><em>Experimental:</em> This function is an experimental feature that is subject to change or removal from future versions.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-runtime-functions-runurl">runUrl</a></p></td><td><p>Runs the script at the specified URL.</p><p><em>Experimental:</em> This function is an experimental feature that is subject to change or removal from future versions.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-runtime-functions-try">try</a></p></td><td><p>Evaluates the delegate function and returns an object with <code>success: true</code> and <code>result</code> if the delegate function succeeds, or an object with <code>success: false</code> and <code>error</code> if the delegate function throws an exception.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-runtime-functions-version">version</a></p></td><td><p>Returns the DataWeave version that is currently running.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-runtime-functions-wait">wait</a></p></td><td><p>Stops the execution for the specified timeout period (in milliseconds).</p></td></tr></tbody></table>

## Types

- [Runtime Types](https://docs.mulesoft.com/dataweave/latest/dw-runtime-types)

<!-- document id=c72af72f9c2bdb390e3f2df90b02574867d4f2bafdbf0c3245ee25d7983573ec url=/mulesoft/current/en-us/dataweave/2.11/dw-runtime-types.md -->

---
product: DataWeave
version: 2.11
---

# Runtime Types (dw::Runtime)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>DataFormatDescriptor</p></td><td><div><div><p><code>type DataFormatDescriptor = { name: String, binary: Boolean, defaultEncoding?: String, extensions: Array&lt;String&gt;, defaultMimeType: String, acceptedMimeTypes: Array&lt;String&gt;, readerProperties: Array&lt;DataFormatProperty&gt;, writerProperties: Array&lt;DataFormatProperty&gt; }</code></p></div></div></td><td><div><div><p>Description of a <code>DataFormat</code> that provides all metadata information.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>DataFormatProperty</p></td><td><div><div><p><code>type DataFormatProperty = { name: String, optional: Boolean, defaultValue?: Any, description: String, possibleValues: Array&lt;Any&gt; }</code></p></div></div></td><td><div><div><p>Type that describes a data format property. The fields include a <code>name</code>, <code>description</code>, array of possible values (<code>possibleValues</code>), an optional default value (<code>defaultValue</code>), and an <code>optional</code> flag that indicates whether the property is required or not.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>EvalResult</p></td><td><div><div><p><code>type EvalResult = Result&lt;EvalSuccess, ExecutionFailure&gt;</code></p></div></div></td><td><div><div><p>Data type of the data that returns when an <code>eval</code> function executes successfully.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div><div><p><em>Introduced in DataWeave version 2.7.0.</em></p></div></div></td></tr><tr><td><p>EvalSuccess</p></td><td><div><div><p><code>type EvalSuccess = { value: Any, logs: Array&lt;LogEntry&gt; }</code></p></div></div></td><td><div><div><p>Data type of the data that returns when an <code>eval</code> function executes successfully.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>ExecutionFailure</p></td><td><div><div><p><code>type ExecutionFailure = { message: String, kind: String, stack?: Array&lt;String&gt;, location: Location, logs: Array&lt;LogEntry&gt; }</code></p></div></div></td><td><div><div><p>Data type of the data that returns when a <code>run</code> or <code>eval</code> function fails.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>Location</p></td><td><div><div><p><code>type Location = { start?: Position, end?: Position, locationString: String, text?: String, sourceIdentifier?: String }</code></p></div></div></td><td><div><div><p>Type that represents the location of an expression in a DataWeave file.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>LogEntry</p></td><td><div><div><p><code>type LogEntry = { level: LogLevel, timestamp: String, message: String }</code></p></div></div></td><td><div><div><p>Type for a log entry, which consists of a <code>level</code> for a <code>LogLevel</code> value, a <code>timestamp</code>, and <code>message</code>.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>LogLevel</p></td><td><div><div><p><code>type LogLevel = "INFO" | "ERROR" | "WARN"</code></p></div></div></td><td><div><div><p>Identifies the different kinds of log levels (<code>INFO</code>, <code>ERROR</code>, or <code>WARN</code>).</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>LoggerService</p></td><td><div><div><p><code>type LoggerService = { initialize?: () -&gt; Object, log: (level: LogLevel, msg: String, context: Object) -&gt; Any, shutdown?: () -&gt; Boolean }</code></p></div></div></td><td><div><div><p>Service that handles all logging:</p></div><div><ul><li><p><code>initialize</code>: Function called when the execution starts. DataWeave sends the result to every <code>log</code> call through the <code>context</code> parameter, so that, for example, a logging header can be sent at initialization and recovered in each log.</p></li><li><p><code>log</code>: Function that is called on every log message.</p></li><li><p><code>shutdown</code>: Function called when the execution completes, which is a common time to flush any buffer or to log out gracefully.</p></li></ul></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>MimeType</p></td><td><div><div><p><code>type MimeType = String</code></p></div></div></td><td><div><div><p>A String representation of a MIME type.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>Position</p></td><td><div><div><p><code>type Position = { index: Number, line: Number, column: Number }</code></p></div></div></td><td><div><div><p>Type that represents a position in a file by its index and its line and column.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>ReaderInput</p></td><td><div><div><p><code>type ReaderInput = { value: Binary, encoding?: String, properties?: Dictionary&lt;SimpleType&gt;, mimeType: MimeType }</code></p></div></div></td><td><div><div><p>Input to the DataWeave reader created for the specified MIME type, which includes the Binary input and MIME type, as well as optional encoding and properties values.</p></div><div><ul><li><p><code>value</code>: The input, in Binary format.</p></li><li><p><code>encoding</code>: The encoding for the reader to use.</p></li><li><p><code>properties</code>: The reader properties used to parse the input.</p></li><li><p><code>mimeType</code>: The MIME type of the input.</p></li></ul></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>RunResult</p></td><td><div><div><p><code>type RunResult = Result&lt;RunSuccess, ExecutionFailure&gt;</code></p></div></div></td><td><div><div><p>Data type of the data that returns when a <code>run</code> function executes successfully.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div><div><p><em>Introduced in DataWeave version 2.7.0.</em></p></div></div></td></tr><tr><td><p>RunSuccess</p></td><td><div><div><p><code>type RunSuccess = { value: Binary, mimeType: MimeType, encoding?: String, logs: Array&lt;LogEntry&gt; }</code></p></div></div></td><td><div><div><p>Data type of the data that returns when a <code>run</code> function executes successfully.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>RuntimeExecutionConfiguration</p></td><td><div><div><p><code>type RuntimeExecutionConfiguration = { timeOut?: Number, outputMimeType?: MimeType, writerProperties?: Dictionary&lt;SimpleType&gt;, onException?: "HANDLE" | "FAIL", securityManager?: SecurityManager, loggerService?: LoggerService, maxStackSize?: Number, onUnhandledTimeout?: (threadName: String, javaStackTrace: String, code: String) -&gt; Any }</code></p></div></div></td><td><div><div><p>Configuration of the runtime execution that has advanced parameters.</p></div><div><ul><li><p><code>timeOut</code>: Maximum amount of time the DataWeave script takes before timing out.</p></li><li><p><code>outputMimeType</code>: Default output MIME type if not specified in the DataWeave script.</p></li><li><p><code>writerProperties</code>: Writer properties to use with the specified the <code>outputMimeType</code> property.</p></li><li><p><code>onException</code> Specifies the behavior that occurs when the execution fails:</p><div><ul><li><p><code>HANDLE</code> (default value) returns <code>ExecutionFailure</code>.</p></li><li><p><code>FAIL</code> propagates an exception.</p></li></ul></div></li><li><p><code>securityManager</code>: Identifies the <code>SecurityManager</code> to use in this execution. This security manager is composed by the current <code>SecurityManager</code>.</p></li><li><p><code>loggerService</code>: The <code>LoggerService</code> to use in this execution.</p></li><li><p><code>maxStackSize</code>: The maximum stack size.</p></li><li><p><code>onUnhandledTimeout</code>: Callback that is called when the watchdog was not able to stop the execution after a timeout, which is useful for logging or reporting the problem. The callback is called with the following:</p><div><ul><li><p><code>threadName</code>: Name of the thread that hanged.</p></li><li><p><code>javaStackTrace</code>: Java stack trace where the hang occurred.</p></li><li><p><code>code</code>: The DataWeave code that caused the hang.</p></li></ul></div></li></ul></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>SecurityManager</p></td><td><div><div><p><code>type SecurityManager = (grant: String, args: Array&lt;Any&gt;) -&gt; Boolean</code></p></div></div></td><td><div><div><p>Function that is called when a privilege must be granted to the current execution.</p></div><div><ul><li><p><code>grant</code> is the name of the privilege, such as <code>Resource</code>.</p></li><li><p><code>args</code> provides a list of parameters that the function requesting the privilege calls.</p></li></ul></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>TryResult</p></td><td><div><div><p><code>type TryResult = Result&lt;T, TryResultFailure&gt;</code></p></div></div></td><td><div><div><p>Object with a result or error message. If <code>success</code> is <code>false</code>, data type provides the <code>error</code>. If <code>true</code>, the data type provides the <code>result</code>.</p></div></div></td></tr><tr><td><p>TryResultFailure</p></td><td><div><div><p><code>type TryResultFailure = { kind: String, message: String, stack?: Array&lt;String&gt;, stackTrace?: String, location?: String }</code></p></div></div></td><td><div><div><p>A type for representing failed execution from <code>try</code>.</p></div><div><p>Supports the following fields:</p></div><div><ul><li><p><code>kind</code>: The error kind.</p></li><li><p><code>message</code>: The error message.</p></li><li><p><code>stack</code>: The stacktrace error (optional).</p></li><li><p><code>stackTrace</code>: The stacktrace string value representation (optional).</p></li><li><p><code>location</code>: The error location (optional).</p></li></ul></div><div><p>Starting in Mule 4.4.0, if the stack is not present, the <code>stackTrace</code> field is available with the native Java stack trace.</p></div><div><p><em>Introduced in DataWeave version 2.7.0.</em></p></div></div></td></tr></tbody></table>

<!-- document id=bb6c9d48ce4edf2f34dda8873f41ac25f124898fb79b62d923382b8763e61ee4 url=/mulesoft/current/en-us/dataweave/2.12/dw-runtime-types.md -->

---
product: DataWeave
version: 2.12
---

# Runtime Types (dw::Runtime)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>DataFormatDescriptor</p></td><td><div><div><p><code>type DataFormatDescriptor = { name: String, binary: Boolean, defaultEncoding?: String, extensions: Array&lt;String&gt;, defaultMimeType: String, acceptedMimeTypes: Array&lt;String&gt;, readerProperties: Array&lt;DataFormatProperty&gt;, writerProperties: Array&lt;DataFormatProperty&gt; }</code></p></div></div></td><td><div><div><p>Description of a <code>DataFormat</code> that provides all metadata information.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>DataFormatProperty</p></td><td><div><div><p><code>type DataFormatProperty = { name: String, optional: Boolean, defaultValue?: Any, description: String, possibleValues: Array&lt;Any&gt; }</code></p></div></div></td><td><div><div><p>Type that describes a data format property. The fields include a <code>name</code>, <code>description</code>, array of possible values (<code>possibleValues</code>), an optional default value (<code>defaultValue</code>), and an <code>optional</code> flag that indicates whether the property is required or not.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>EvalResult</p></td><td><div><div><p><code>type EvalResult = Result&lt;EvalSuccess, ExecutionFailure&gt;</code></p></div></div></td><td><div><div><p>Data type of the data that returns when an <code>eval</code> function executes successfully.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div><div><p><em>Introduced in DataWeave version 2.7.0.</em></p></div></div></td></tr><tr><td><p>EvalSuccess</p></td><td><div><div><p><code>type EvalSuccess = { value: Any, logs: Array&lt;LogEntry&gt; }</code></p></div></div></td><td><div><div><p>Data type of the data that returns when an <code>eval</code> function executes successfully.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>ExecutionFailure</p></td><td><div><div><p><code>type ExecutionFailure = { message: String, kind: String, stack?: Array&lt;String&gt;, location: Location, logs: Array&lt;LogEntry&gt; }</code></p></div></div></td><td><div><div><p>Data type of the data that returns when a <code>run</code> or <code>eval</code> function fails.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>Location</p></td><td><div><div><p><code>type Location = { start?: Position, end?: Position, locationString: String, text?: String, sourceIdentifier?: String }</code></p></div></div></td><td><div><div><p>Type that represents the location of an expression in a DataWeave file.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>LogEntry</p></td><td><div><div><p><code>type LogEntry = { level: LogLevel, timestamp: String, message: String }</code></p></div></div></td><td><div><div><p>Type for a log entry, which consists of a <code>level</code> for a <code>LogLevel</code> value, a <code>timestamp</code>, and <code>message</code>.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>LogLevel</p></td><td><div><div><p><code>type LogLevel = "INFO" | "ERROR" | "WARN"</code></p></div></div></td><td><div><div><p>Identifies the different kinds of log levels (<code>INFO</code>, <code>ERROR</code>, or <code>WARN</code>).</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>LoggerService</p></td><td><div><div><p><code>type LoggerService = { initialize?: () -&gt; Object, log: (level: LogLevel, msg: String, context: Object) -&gt; Any, shutdown?: () -&gt; Boolean }</code></p></div></div></td><td><div><div><p>Service that handles all logging:</p></div><div><ul><li><p><code>initialize</code>: Function called when the execution starts. DataWeave sends the result to every <code>log</code> call through the <code>context</code> parameter, so that, for example, a logging header can be sent at initialization and recovered in each log.</p></li><li><p><code>log</code>: Function that is called on every log message.</p></li><li><p><code>shutdown</code>: Function called when the execution completes, which is a common time to flush any buffer or to log out gracefully.</p></li></ul></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>MimeType</p></td><td><div><div><p><code>type MimeType = String</code></p></div></div></td><td><div><div><p>A String representation of a MIME type.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>Position</p></td><td><div><div><p><code>type Position = { index: Number, line: Number, column: Number }</code></p></div></div></td><td><div><div><p>Type that represents a position in a file by its index and its line and column.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>ReaderInput</p></td><td><div><div><p><code>type ReaderInput = { value: Binary, encoding?: String, properties?: Dictionary&lt;SimpleType&gt;, mimeType: MimeType }</code></p></div></div></td><td><div><div><p>Input to the DataWeave reader created for the specified MIME type, which includes the Binary input and MIME type, as well as optional encoding and properties values.</p></div><div><ul><li><p><code>value</code>: The input, in Binary format.</p></li><li><p><code>encoding</code>: The encoding for the reader to use.</p></li><li><p><code>properties</code>: The reader properties used to parse the input.</p></li><li><p><code>mimeType</code>: The MIME type of the input.</p></li></ul></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>RunResult</p></td><td><div><div><p><code>type RunResult = Result&lt;RunSuccess, ExecutionFailure&gt;</code></p></div></div></td><td><div><div><p>Data type of the data that returns when a <code>run</code> function executes successfully.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div><div><p><em>Introduced in DataWeave version 2.7.0.</em></p></div></div></td></tr><tr><td><p>RunSuccess</p></td><td><div><div><p><code>type RunSuccess = { value: Binary, mimeType: MimeType, encoding?: String, logs: Array&lt;LogEntry&gt; }</code></p></div></div></td><td><div><div><p>Data type of the data that returns when a <code>run</code> function executes successfully.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>RuntimeExecutionConfiguration</p></td><td><div><div><p><code>type RuntimeExecutionConfiguration = { timeOut?: Number, outputMimeType?: MimeType, writerProperties?: Dictionary&lt;SimpleType&gt;, onException?: "HANDLE" | "FAIL", securityManager?: SecurityManager, loggerService?: LoggerService, maxStackSize?: Number, onUnhandledTimeout?: (threadName: String, javaStackTrace: String, code: String) -&gt; Any }</code></p></div></div></td><td><div><div><p>Configuration of the runtime execution that has advanced parameters.</p></div><div><ul><li><p><code>timeOut</code>: Maximum amount of time the DataWeave script takes before timing out.</p></li><li><p><code>outputMimeType</code>: Default output MIME type if not specified in the DataWeave script.</p></li><li><p><code>writerProperties</code>: Writer properties to use with the specified the <code>outputMimeType</code> property.</p></li><li><p><code>onException</code> Specifies the behavior that occurs when the execution fails:</p><div><ul><li><p><code>HANDLE</code> (default value) returns <code>ExecutionFailure</code>.</p></li><li><p><code>FAIL</code> propagates an exception.</p></li></ul></div></li><li><p><code>securityManager</code>: Identifies the <code>SecurityManager</code> to use in this execution. This security manager is composed by the current <code>SecurityManager</code>.</p></li><li><p><code>loggerService</code>: The <code>LoggerService</code> to use in this execution.</p></li><li><p><code>maxStackSize</code>: The maximum stack size.</p></li><li><p><code>onUnhandledTimeout</code>: Callback that is called when the watchdog was not able to stop the execution after a timeout, which is useful for logging or reporting the problem. The callback is called with the following:</p><div><ul><li><p><code>threadName</code>: Name of the thread that hanged.</p></li><li><p><code>javaStackTrace</code>: Java stack trace where the hang occurred.</p></li><li><p><code>code</code>: The DataWeave code that caused the hang.</p></li></ul></div></li></ul></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>SecurityManager</p></td><td><div><div><p><code>type SecurityManager = (grant: String, args: Array&lt;Any&gt;) -&gt; Boolean</code></p></div></div></td><td><div><div><p>Function that is called when a privilege must be granted to the current execution.</p></div><div><ul><li><p><code>grant</code> is the name of the privilege, such as <code>Resource</code>.</p></li><li><p><code>args</code> provides a list of parameters that the function requesting the privilege calls.</p></li></ul></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>TryResult</p></td><td><div><div><p><code>type TryResult = Result&lt;T, TryResultFailure&gt;</code></p></div></div></td><td><div><div><p>Object with a result or error message. If <code>success</code> is <code>false</code>, data type provides the <code>error</code>. If <code>true</code>, the data type provides the <code>result</code>.</p></div></div></td></tr><tr><td><p>TryResultFailure</p></td><td><div><div><p><code>type TryResultFailure = { kind: String, message: String, stack?: Array&lt;String&gt;, stackTrace?: String, location?: String }</code></p></div></div></td><td><div><div><p>A type for representing failed execution from <code>try</code>.</p></div><div><p>Supports the following fields:</p></div><div><ul><li><p><code>kind</code>: The error kind.</p></li><li><p><code>message</code>: The error message.</p></li><li><p><code>stack</code>: The stacktrace error (optional).</p></li><li><p><code>stackTrace</code>: The stacktrace string value representation (optional).</p></li><li><p><code>location</code>: The error location (optional).</p></li></ul></div><div><p>Starting in Mule 4.4.0, if the stack is not present, the <code>stackTrace</code> field is available with the native Java stack trace.</p></div><div><p><em>Introduced in DataWeave version 2.7.0.</em></p></div></div></td></tr></tbody></table>

<!-- document id=a4ece57d7a8c864d7b7df26e973546d7af2d85c701c6c625258fc607ac20fd51 url=/mulesoft/current/en-us/dataweave/2.3/dw-runtime-types.md -->

---
product: DataWeave
version: 2.3
---

# Runtime Types (dw::Runtime)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>TryResult</p></td><td><p><code>type TryResult = { success: Boolean, result?: T, error?: { kind: String, message: String, stack?: Array&lt;String&gt;, location?: String } }</code></p></td><td><p>Object with a result or error message. If <code>success</code> is <code>false</code>, it contains the <code>error</code>. If <code>true</code>, it provides the <code>result</code>.</p></td></tr></tbody></table>

<!-- document id=75126905d3e5df7387bdb2b65144255c558327ce10f1f1d7272e7c696da52eca url=/mulesoft/current/en-us/dataweave/2.4/dw-runtime-types.md -->

---
product: DataWeave
version: 2.4
---

# Runtime Types (dw::Runtime)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>DataFormatDescriptor</p></td><td><div><div><p><code>type DataFormatDescriptor = { name: String, binary: Boolean, defaultEncoding?: String, extensions: Array&lt;String&gt;, defaultMimeType: String, acceptedMimeTypes: Array&lt;String&gt;, readerProperties: Array&lt;DataFormatProperty&gt;, writerProperties: Array&lt;DataFormatProperty&gt; }</code></p></div></div></td><td><div><div><p>Description of a <code>DataFormat</code> that provides all metadata information.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>DataFormatProperty</p></td><td><div><div><p><code>type DataFormatProperty = { name: String, optional: Boolean, defaultValue?: Any, description: String, possibleValues: Array&lt;Any&gt; }</code></p></div></div></td><td><div><div><p>Type that describes a data format property. The fields include a <code>name</code>, <code>description</code>, array of possible values (<code>possibleValues</code>), an optional default value (<code>defaultValue</code>), and an <code>optional</code> flag that indicates whether the property is required or not.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>EvalSuccess</p></td><td><div><div><p><code>type EvalSuccess = { success: true, value: Any, logs: Array&lt;LogEntry&gt; }</code></p></div></div></td><td><div><div><p>Data type of the data that returns when an <code>eval</code> function executes successfully.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>ExecutionFailure</p></td><td><div><div><p><code>type ExecutionFailure = { success: false, message: String, kind: String, stack?: Array&lt;String&gt;, location: Location, logs: Array&lt;LogEntry&gt; }</code></p></div></div></td><td><div><div><p>Data type of the data that returns when a <code>run</code> or <code>eval</code> function fails.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>Location</p></td><td><div><div><p><code>type Location = { start?: Position, end?: Position, locationString: String, text?: String, sourceIdentifier?: String }</code></p></div></div></td><td><div><div><p>Type that represents the location of an expression in a DataWeave file.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>LogEntry</p></td><td><div><div><p><code>type LogEntry = { level: LogLevel, timestamp: String, message: String }</code></p></div></div></td><td><div><div><p>Type for a log entry, which consists of a <code>level</code> for a <code>LogLevel</code> value, a <code>timestamp</code>, and <code>message</code>.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>LogLevel</p></td><td><div><div><p><code>type LogLevel = "INFO" | "ERROR" | "WARN"</code></p></div></div></td><td><div><div><p>Identifies the different kinds of log levels (<code>INFO</code>, <code>ERROR</code>, or <code>WARN</code>).</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>LoggerService</p></td><td><div><div><p><code>type LoggerService = { initialize?: () -&gt; Object, log: (level: LogLevel, msg: String, context: Object) -&gt; Any, shutdown?: () -&gt; Boolean }</code></p></div></div></td><td><div><div><p>Service that handles all logging.</p></div><div><ul><li><p><code>initialize</code> : Function called when the execution starts. DataWeave sends the result to every <code>log</code> call through the <code>context</code> parameter, so that, for example, a logging header can be sent at initialization and recovered in each log.</p></li><li><p><code>log</code>: Function that is called on every log message.</p></li><li><p><code>shutdown</code>: Function called when the execution completes, which is a time to flush any buffer or to log out gracefully.</p></li></ul></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>MimeType</p></td><td><div><div><p><code>type MimeType = String</code></p></div></div></td><td><div><div><p>A String representation of a MIME type.</p></div></div></td></tr><tr><td><p>Position</p></td><td><div><div><p><code>type Position = { index: Number, line: Number, column: Number }</code></p></div></div></td><td><div><div><p>Type that represents a position in a file by its index and its line and column.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>ReaderInput</p></td><td><div><div><p><code>type ReaderInput = { value: Binary, encoding?: String, properties?: Dictionary&lt;SimpleType&gt;, mimeType: MimeType }</code></p></div></div></td><td><div><div><p>Input to the DataWeave reader created for the specified MIME type, which includes the Binary input and MIME type, as well as optional encoding and properties values.</p></div><div><ul><li><p><code>value</code>: The input, in Binary format.</p></li><li><p><code>encoding</code>: The encoding for the reader to use.</p></li><li><p><code>properties</code>: The reader properties used to parse the input.</p></li><li><p><code>mimeType</code>: The MIME type of the input.</p></li></ul></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>RunSuccess</p></td><td><div><div><p><code>type RunSuccess = { success: true, value: Binary, mimeType: MimeType, encoding?: String, logs: Array&lt;LogEntry&gt; }</code></p></div></div></td><td><div><div><p>Data type of the data that returns when a <code>run</code> function executes successfully.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>RuntimeExecutionConfiguration</p></td><td><div><div><p><code>type RuntimeExecutionConfiguration = { timeOut?: Number, outputMimeType?: MimeType, writerProperties?: Dictionary&lt;SimpleType&gt;, onException?: "HANDLE" | "FAIL", securityManager?: SecurityManager, loggerService?: LoggerService, maxStackSize?: Number }</code></p></div></div></td><td><div><div><p>Configuration of the runtime execution that has advanced parameters.</p></div><div><ul><li><p><code>timeOut</code>: Maximum amount of time the DataWeave script takes before timing out.</p></li><li><p><code>outputMimeType</code>: Default output MIME type if not specified in the DataWeave script.</p></li><li><p><code>writerProperties</code>: Writer properties to use with the specified the <code>outputMimeType</code> property.</p></li><li><p>onException: Specifies the behavior that occurs when the execution fails:</p><div><ul><li><p><code>HANDLE</code> (default value) returns <code>ExecutionFailure</code>.</p></li><li><p><code>FAIL</code> propagates an exception.</p></li></ul></div></li><li><p><code>securityManager</code>: Identifies the <code>SecurityManager</code> to use in this execution. This security manager is composed by the current <code>SecurityManager</code>.</p></li><li><p><code>loggerService</code>: The <code>LoggerService</code> to use in this execution.</p></li><li><p><code>maxStackSize</code>: The maximum stack size.</p></li></ul></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>SecurityManager</p></td><td><div><div><p><code>type SecurityManager = (grant: String, args: Array&lt;Any&gt;) -&gt; Boolean</code></p></div></div></td><td><div><div><p>Function that is called when a privilege must be granted to the current execution.</p></div><div><ul><li><p><code>grant</code> is the name of the privilege, such as <code>Resource</code>.</p></li><li><p><code>args</code> provides a list of parameters that the function requesting the privilege calls.</p></li></ul></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>TryResult</p></td><td><div><div><p><code>type TryResult = { success: Boolean, result?: T, error?: { kind: String, message: String, stack?: Array&lt;String&gt;, stackTrace?: String, location?: String } }</code></p></div></div></td><td><div><div><p>Object with a result or error message. If <code>success</code> is <code>false</code>, data type provides the <code>error</code>. If <code>true</code>, the data type provides the <code>result</code>.</p></div><div><p>Starting in Mule version 4.3.1 (DataWeave version 2.3.1), <code>stackTrace</code> is available only when <code>stack</code> is not present. The <code>stackTrace</code> field provides the native Java stack trace.</p></div></div></td></tr></tbody></table>

<!-- document id=95bfd2a9aafd0ffcaffd892853186439d743374558767a221935ec806e6cedd8 url=/mulesoft/current/en-us/dataweave/2.6/dw-runtime-types.md -->

---
product: DataWeave
version: 2.6
---

# Runtime Types (dw::Runtime)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>DataFormatDescriptor</p></td><td><div><div><p><code>type DataFormatDescriptor = { name: String, binary: Boolean, defaultEncoding?: String, extensions: Array&lt;String&gt;, defaultMimeType: String, acceptedMimeTypes: Array&lt;String&gt;, readerProperties: Array&lt;DataFormatProperty&gt;, writerProperties: Array&lt;DataFormatProperty&gt; }</code></p></div></div></td><td><div><div><p>Description of a <code>DataFormat</code> that provides all metadata information.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>DataFormatProperty</p></td><td><div><div><p><code>type DataFormatProperty = { name: String, optional: Boolean, defaultValue?: Any, description: String, possibleValues: Array&lt;Any&gt; }</code></p></div></div></td><td><div><div><p>Type that describes a data format property. The fields include a <code>name</code>, <code>description</code>, array of possible values (<code>possibleValues</code>), an optional default value (<code>defaultValue</code>), and an <code>optional</code> flag that indicates whether the property is required or not.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>EvalSuccess</p></td><td><div><div><p><code>type EvalSuccess = { success: true, value: Any, logs: Array&lt;LogEntry&gt; }</code></p></div></div></td><td><div><div><p>Data type of the data that returns when an <code>eval</code> function executes successfully.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>ExecutionFailure</p></td><td><div><div><p><code>type ExecutionFailure = { success: false, message: String, kind: String, stack?: Array&lt;String&gt;, location: Location, logs: Array&lt;LogEntry&gt; }</code></p></div></div></td><td><div><div><p>Data type of the data that returns when a <code>run</code> or <code>eval</code> function fails.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>Location</p></td><td><div><div><p><code>type Location = { start?: Position, end?: Position, locationString: String, text?: String, sourceIdentifier?: String }</code></p></div></div></td><td><div><div><p>Type that represents the location of an expression in a DataWeave file.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>LogEntry</p></td><td><div><div><p><code>type LogEntry = { level: LogLevel, timestamp: String, message: String }</code></p></div></div></td><td><div><div><p>Type for a log entry, which consists of a <code>level</code> for a <code>LogLevel</code> value, a <code>timestamp</code>, and <code>message</code>.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>LogLevel</p></td><td><div><div><p><code>type LogLevel = "INFO" | "ERROR" | "WARN"</code></p></div></div></td><td><div><div><p>Identifies the different kinds of log levels (<code>INFO</code>, <code>ERROR</code>, or <code>WARN</code>).</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>LoggerService</p></td><td><div><div><p><code>type LoggerService = { initialize?: () -&gt; Object, log: (level: LogLevel, msg: String, context: Object) -&gt; Any, shutdown?: () -&gt; Boolean }</code></p></div></div></td><td><div><div><p>Service that handles all logging:</p></div><div><ul><li><p><code>initialize</code>: Function called when the execution starts. DataWeave sends the result to every <code>log</code> call through the <code>context</code> parameter, so that, for example, a logging header can be sent at initialization and recovered in each log.</p></li><li><p><code>log</code>: Function that is called on every log message.</p></li><li><p><code>shutdown</code>: Function called when the execution completes, which is a common time to flush any buffer or to log out gracefully.</p></li></ul></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>MimeType</p></td><td><div><div><p><code>type MimeType = String</code></p></div></div></td><td><div><div><p>A String representation of a MIME type.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>Position</p></td><td><div><div><p><code>type Position = { index: Number, line: Number, column: Number }</code></p></div></div></td><td><div><div><p>Type that represents a position in a file by its index and its line and column.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>ReaderInput</p></td><td><div><div><p><code>type ReaderInput = { value: Binary, encoding?: String, properties?: Dictionary&lt;SimpleType&gt;, mimeType: MimeType }</code></p></div></div></td><td><div><div><p>Input to the DataWeave reader created for the specified MIME type, which includes the Binary input and MIME type, as well as optional encoding and properties values.</p></div><div><ul><li><p><code>value</code>: The input, in Binary format.</p></li><li><p><code>encoding</code>: The encoding for the reader to use.</p></li><li><p><code>properties</code>: The reader properties used to parse the input.</p></li><li><p><code>mimeType</code>: The MIME type of the input.</p></li></ul></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>RunSuccess</p></td><td><div><div><p><code>type RunSuccess = { success: true, value: Binary, mimeType: MimeType, encoding?: String, logs: Array&lt;LogEntry&gt; }</code></p></div></div></td><td><div><div><p>Data type of the data that returns when a <code>run</code> function executes successfully.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>RuntimeExecutionConfiguration</p></td><td><div><div><p><code>type RuntimeExecutionConfiguration = { timeOut?: Number, outputMimeType?: MimeType, writerProperties?: Dictionary&lt;SimpleType&gt;, onException?: "HANDLE" | "FAIL", securityManager?: SecurityManager, loggerService?: LoggerService, maxStackSize?: Number, onUnhandledTimeout?: (threadName: String, javaStackTrace: String, code: String) -&gt; Any }</code></p></div></div></td><td><div><div><p>Configuration of the runtime execution that has advanced parameters.</p></div><div><ul><li><p><code>timeOut</code>: Maximum amount of time the DataWeave script takes before timing out.</p></li><li><p><code>outputMimeType</code>: Default output MIME type if not specified in the DataWeave script.</p></li><li><p><code>writerProperties</code>: Writer properties to use with the specified the <code>outputMimeType</code> property.</p></li><li><p><code>onException</code> Specifies the behavior that occurs when the execution fails:</p><div><ul><li><p><code>HANDLE</code> (default value) returns <code>ExecutionFailure</code>.</p></li><li><p><code>FAIL</code> propagates an exception.</p></li></ul></div></li><li><p><code>securityManager</code>: Identifies the <code>SecurityManager</code> to use in this execution. This security manager is composed by the current <code>SecurityManager</code>.</p></li><li><p><code>loggerService</code>: The <code>LoggerService</code> to use in this execution.</p></li><li><p><code>maxStackSize</code>: The maximum stack size.</p></li><li><p><code>onUnhandledTimeout</code>: Callback that is called when the watchdog was not able to stop the execution after a timeout, which is useful for logging or reporting the problem. The callback is called with the following:</p><div><ul><li><p><code>threadName</code>: Name of the thread that hanged.</p></li><li><p><code>javaStackTrace</code>: Java stack trace where the hang occurred.</p></li><li><p><code>code</code>: The DataWeave code that caused the hang.</p></li></ul></div></li></ul></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>SecurityManager</p></td><td><div><div><p><code>type SecurityManager = (grant: String, args: Array&lt;Any&gt;) -&gt; Boolean</code></p></div></div></td><td><div><div><p>Function that is called when a privilege must be granted to the current execution.</p></div><div><ul><li><p><code>grant</code> is the name of the privilege, such as <code>Resource</code>.</p></li><li><p><code>args</code> provides a list of parameters that the function requesting the privilege calls.</p></li></ul></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>TryResult</p></td><td><div><div><p><code>type TryResult = { success: Boolean, result?: T, error?: { kind: String, message: String, stack?: Array&lt;String&gt;, stackTrace?: String, location?: String } }</code></p></div></div></td><td><div><div><p>Object with a result or error message. If <code>success</code> is <code>false</code>, data type provides the <code>error</code>. If <code>true</code>, the data type provides the <code>result</code>.</p></div><div><p>Starting in Mule 4.4.0, if the stack is not present, the <code>stackTrace</code> field is available with the native Java stack trace.</p></div></div></td></tr></tbody></table>

<!-- document id=456a2dc878efc4105033f3f19b94447688d00c647fc2de67434997ceae86b663 url=/mulesoft/current/en-us/dataweave/2.9/dw-runtime-types.md -->

---
product: DataWeave
version: 2.9
---

# Runtime Types (dw::Runtime)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>DataFormatDescriptor</p></td><td><div><div><p><code>type DataFormatDescriptor = { name: String, binary: Boolean, defaultEncoding?: String, extensions: Array&lt;String&gt;, defaultMimeType: String, acceptedMimeTypes: Array&lt;String&gt;, readerProperties: Array&lt;DataFormatProperty&gt;, writerProperties: Array&lt;DataFormatProperty&gt; }</code></p></div></div></td><td><div><div><p>Description of a <code>DataFormat</code> that provides all metadata information.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>DataFormatProperty</p></td><td><div><div><p><code>type DataFormatProperty = { name: String, optional: Boolean, defaultValue?: Any, description: String, possibleValues: Array&lt;Any&gt; }</code></p></div></div></td><td><div><div><p>Type that describes a data format property. The fields include a <code>name</code>, <code>description</code>, array of possible values (<code>possibleValues</code>), an optional default value (<code>defaultValue</code>), and an <code>optional</code> flag that indicates whether the property is required or not.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>EvalResult</p></td><td><div><div><p><code>type EvalResult = Result&lt;EvalSuccess, ExecutionFailure&gt;</code></p></div></div></td><td><div><div><p>Data type of the data that returns when an <code>eval</code> function executes successfully.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div><div><p><em>Introduced in DataWeave version 2.7.0.</em></p></div></div></td></tr><tr><td><p>EvalSuccess</p></td><td><div><div><p><code>type EvalSuccess = { value: Any, logs: Array&lt;LogEntry&gt; }</code></p></div></div></td><td><div><div><p>Data type of the data that returns when an <code>eval</code> function executes successfully.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>ExecutionFailure</p></td><td><div><div><p><code>type ExecutionFailure = { message: String, kind: String, stack?: Array&lt;String&gt;, location: Location, logs: Array&lt;LogEntry&gt; }</code></p></div></div></td><td><div><div><p>Data type of the data that returns when a <code>run</code> or <code>eval</code> function fails.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>Location</p></td><td><div><div><p><code>type Location = { start?: Position, end?: Position, locationString: String, text?: String, sourceIdentifier?: String }</code></p></div></div></td><td><div><div><p>Type that represents the location of an expression in a DataWeave file.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>LogEntry</p></td><td><div><div><p><code>type LogEntry = { level: LogLevel, timestamp: String, message: String }</code></p></div></div></td><td><div><div><p>Type for a log entry, which consists of a <code>level</code> for a <code>LogLevel</code> value, a <code>timestamp</code>, and <code>message</code>.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>LogLevel</p></td><td><div><div><p><code>type LogLevel = "INFO" | "ERROR" | "WARN"</code></p></div></div></td><td><div><div><p>Identifies the different kinds of log levels (<code>INFO</code>, <code>ERROR</code>, or <code>WARN</code>).</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>LoggerService</p></td><td><div><div><p><code>type LoggerService = { initialize?: () -&gt; Object, log: (level: LogLevel, msg: String, context: Object) -&gt; Any, shutdown?: () -&gt; Boolean }</code></p></div></div></td><td><div><div><p>Service that handles all logging:</p></div><div><ul><li><p><code>initialize</code>: Function called when the execution starts. DataWeave sends the result to every <code>log</code> call through the <code>context</code> parameter, so that, for example, a logging header can be sent at initialization and recovered in each log.</p></li><li><p><code>log</code>: Function that is called on every log message.</p></li><li><p><code>shutdown</code>: Function called when the execution completes, which is a common time to flush any buffer or to log out gracefully.</p></li></ul></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>MimeType</p></td><td><div><div><p><code>type MimeType = String</code></p></div></div></td><td><div><div><p>A String representation of a MIME type.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>Position</p></td><td><div><div><p><code>type Position = { index: Number, line: Number, column: Number }</code></p></div></div></td><td><div><div><p>Type that represents a position in a file by its index and its line and column.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>ReaderInput</p></td><td><div><div><p><code>type ReaderInput = { value: Binary, encoding?: String, properties?: Dictionary&lt;SimpleType&gt;, mimeType: MimeType }</code></p></div></div></td><td><div><div><p>Input to the DataWeave reader created for the specified MIME type, which includes the Binary input and MIME type, as well as optional encoding and properties values.</p></div><div><ul><li><p><code>value</code>: The input, in Binary format.</p></li><li><p><code>encoding</code>: The encoding for the reader to use.</p></li><li><p><code>properties</code>: The reader properties used to parse the input.</p></li><li><p><code>mimeType</code>: The MIME type of the input.</p></li></ul></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>RunResult</p></td><td><div><div><p><code>type RunResult = Result&lt;RunSuccess, ExecutionFailure&gt;</code></p></div></div></td><td><div><div><p>Data type of the data that returns when a <code>run</code> function executes successfully.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div><div><p><em>Introduced in DataWeave version 2.7.0.</em></p></div></div></td></tr><tr><td><p>RunSuccess</p></td><td><div><div><p><code>type RunSuccess = { value: Binary, mimeType: MimeType, encoding?: String, logs: Array&lt;LogEntry&gt; }</code></p></div></div></td><td><div><div><p>Data type of the data that returns when a <code>run</code> function executes successfully.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>RuntimeExecutionConfiguration</p></td><td><div><div><p><code>type RuntimeExecutionConfiguration = { timeOut?: Number, outputMimeType?: MimeType, writerProperties?: Dictionary&lt;SimpleType&gt;, onException?: "HANDLE" | "FAIL", securityManager?: SecurityManager, loggerService?: LoggerService, maxStackSize?: Number, onUnhandledTimeout?: (threadName: String, javaStackTrace: String, code: String) -&gt; Any }</code></p></div></div></td><td><div><div><p>Configuration of the runtime execution that has advanced parameters.</p></div><div><ul><li><p><code>timeOut</code>: Maximum amount of time the DataWeave script takes before timing out.</p></li><li><p><code>outputMimeType</code>: Default output MIME type if not specified in the DataWeave script.</p></li><li><p><code>writerProperties</code>: Writer properties to use with the specified the <code>outputMimeType</code> property.</p></li><li><p><code>onException</code> Specifies the behavior that occurs when the execution fails:</p><div><ul><li><p><code>HANDLE</code> (default value) returns <code>ExecutionFailure</code>.</p></li><li><p><code>FAIL</code> propagates an exception.</p></li></ul></div></li><li><p><code>securityManager</code>: Identifies the <code>SecurityManager</code> to use in this execution. This security manager is composed by the current <code>SecurityManager</code>.</p></li><li><p><code>loggerService</code>: The <code>LoggerService</code> to use in this execution.</p></li><li><p><code>maxStackSize</code>: The maximum stack size.</p></li><li><p><code>onUnhandledTimeout</code>: Callback that is called when the watchdog was not able to stop the execution after a timeout, which is useful for logging or reporting the problem. The callback is called with the following:</p><div><ul><li><p><code>threadName</code>: Name of the thread that hanged.</p></li><li><p><code>javaStackTrace</code>: Java stack trace where the hang occurred.</p></li><li><p><code>code</code>: The DataWeave code that caused the hang.</p></li></ul></div></li></ul></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>SecurityManager</p></td><td><div><div><p><code>type SecurityManager = (grant: String, args: Array&lt;Any&gt;) -&gt; Boolean</code></p></div></div></td><td><div><div><p>Function that is called when a privilege must be granted to the current execution.</p></div><div><ul><li><p><code>grant</code> is the name of the privilege, such as <code>Resource</code>.</p></li><li><p><code>args</code> provides a list of parameters that the function requesting the privilege calls.</p></li></ul></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>TryResult</p></td><td><div><div><p><code>type TryResult = Result&lt;T, TryResultFailure&gt;</code></p></div></div></td><td><div><div><p>Object with a result or error message. If <code>success</code> is <code>false</code>, data type provides the <code>error</code>. If <code>true</code>, the data type provides the <code>result</code>.</p></div></div></td></tr><tr><td><p>TryResultFailure</p></td><td><div><div><p><code>type TryResultFailure = { kind: String, message: String, stack?: Array&lt;String&gt;, stackTrace?: String, location?: String }</code></p></div></div></td><td><div><div><p>A type for representing failed execution from <code>try</code>.</p></div><div><p>Supports the following fields:</p></div><div><ul><li><p><code>kind</code>: The error kind.</p></li><li><p><code>message</code>: The error message.</p></li><li><p><code>stack</code>: The stacktrace error (optional).</p></li><li><p><code>stackTrace</code>: The stacktrace string value representation (optional).</p></li><li><p><code>location</code>: The error location (optional).</p></li></ul></div><div><p>Starting in Mule 4.4.0, if the stack is not present, the <code>stackTrace</code> field is available with the native Java stack trace.</p></div><div><p><em>Introduced in DataWeave version 2.7.0.</em></p></div></div></td></tr></tbody></table>

<!-- document id=18c36c7ceacd1810f676820a2c0d4fa2edaf81503054774fd955e16e0fe31b3d url=/mulesoft/current/en-us/dataweave/latest/dw-runtime-types.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Runtime Types (dw::Runtime)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>DataFormatDescriptor</p></td><td><div><div><p><code>type DataFormatDescriptor = { name: String, binary: Boolean, defaultEncoding?: String, extensions: Array&lt;String&gt;, defaultMimeType: String, acceptedMimeTypes: Array&lt;String&gt;, readerProperties: Array&lt;DataFormatProperty&gt;, writerProperties: Array&lt;DataFormatProperty&gt; }</code></p></div></div></td><td><div><div><p>Description of a <code>DataFormat</code> that provides all metadata information.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>DataFormatProperty</p></td><td><div><div><p><code>type DataFormatProperty = { name: String, optional: Boolean, defaultValue?: Any, description: String, possibleValues: Array&lt;Any&gt; }</code></p></div></div></td><td><div><div><p>Type that describes a data format property. The fields include a <code>name</code>, <code>description</code>, array of possible values (<code>possibleValues</code>), an optional default value (<code>defaultValue</code>), and an <code>optional</code> flag that indicates whether the property is required or not.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>EvalResult</p></td><td><div><div><p><code>type EvalResult = Result&lt;EvalSuccess, ExecutionFailure&gt;</code></p></div></div></td><td><div><div><p>Data type of the data that returns when an <code>eval</code> function executes successfully.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div><div><p><em>Introduced in DataWeave version 2.7.0.</em></p></div></div></td></tr><tr><td><p>EvalSuccess</p></td><td><div><div><p><code>type EvalSuccess = { value: Any, logs: Array&lt;LogEntry&gt; }</code></p></div></div></td><td><div><div><p>Data type of the data that returns when an <code>eval</code> function executes successfully.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>ExecutionFailure</p></td><td><div><div><p><code>type ExecutionFailure = { message: String, kind: String, stack?: Array&lt;String&gt;, location: Location, logs: Array&lt;LogEntry&gt; }</code></p></div></div></td><td><div><div><p>Data type of the data that returns when a <code>run</code> or <code>eval</code> function fails.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>Location</p></td><td><div><div><p><code>type Location = { start?: Position, end?: Position, locationString: String, text?: String, sourceIdentifier?: String }</code></p></div></div></td><td><div><div><p>Type that represents the location of an expression in a DataWeave file.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>LogEntry</p></td><td><div><div><p><code>type LogEntry = { level: LogLevel, timestamp: String, message: String }</code></p></div></div></td><td><div><div><p>Type for a log entry, which consists of a <code>level</code> for a <code>LogLevel</code> value, a <code>timestamp</code>, and <code>message</code>.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>LogLevel</p></td><td><div><div><p><code>type LogLevel = "INFO" | "ERROR" | "WARN"</code></p></div></div></td><td><div><div><p>Identifies the different kinds of log levels (<code>INFO</code>, <code>ERROR</code>, or <code>WARN</code>).</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>LoggerService</p></td><td><div><div><p><code>type LoggerService = { initialize?: () -&gt; Object, log: (level: LogLevel, msg: String, context: Object) -&gt; Any, shutdown?: () -&gt; Boolean }</code></p></div></div></td><td><div><div><p>Service that handles all logging:</p></div><div><ul><li><p><code>initialize</code>: Function called when the execution starts. DataWeave sends the result to every <code>log</code> call through the <code>context</code> parameter, so that, for example, a logging header can be sent at initialization and recovered in each log.</p></li><li><p><code>log</code>: Function that is called on every log message.</p></li><li><p><code>shutdown</code>: Function called when the execution completes, which is a common time to flush any buffer or to log out gracefully.</p></li></ul></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>MimeType</p></td><td><div><div><p><code>type MimeType = String</code></p></div></div></td><td><div><div><p>A String representation of a MIME type.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>Position</p></td><td><div><div><p><code>type Position = { index: Number, line: Number, column: Number }</code></p></div></div></td><td><div><div><p>Type that represents a position in a file by its index and its line and column.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>ReaderInput</p></td><td><div><div><p><code>type ReaderInput = { value: Binary, encoding?: String, properties?: Dictionary&lt;SimpleType&gt;, mimeType: MimeType }</code></p></div></div></td><td><div><div><p>Input to the DataWeave reader created for the specified MIME type, which includes the Binary input and MIME type, as well as optional encoding and properties values.</p></div><div><ul><li><p><code>value</code>: The input, in Binary format.</p></li><li><p><code>encoding</code>: The encoding for the reader to use.</p></li><li><p><code>properties</code>: The reader properties used to parse the input.</p></li><li><p><code>mimeType</code>: The MIME type of the input.</p></li></ul></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>RunResult</p></td><td><div><div><p><code>type RunResult = Result&lt;RunSuccess, ExecutionFailure&gt;</code></p></div></div></td><td><div><div><p>Data type of the data that returns when a <code>run</code> function executes successfully.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div><div><p><em>Introduced in DataWeave version 2.7.0.</em></p></div></div></td></tr><tr><td><p>RunSuccess</p></td><td><div><div><p><code>type RunSuccess = { value: Binary, mimeType: MimeType, encoding?: String, logs: Array&lt;LogEntry&gt; }</code></p></div></div></td><td><div><div><p>Data type of the data that returns when a <code>run</code> function executes successfully.</p></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>RuntimeExecutionConfiguration</p></td><td><div><div><p><code>type RuntimeExecutionConfiguration = { timeOut?: Number, outputMimeType?: MimeType, writerProperties?: Dictionary&lt;SimpleType&gt;, onException?: "HANDLE" | "FAIL", securityManager?: SecurityManager, loggerService?: LoggerService, maxStackSize?: Number, onUnhandledTimeout?: (threadName: String, javaStackTrace: String, code: String) -&gt; Any }</code></p></div></div></td><td><div><div><p>Configuration of the runtime execution that has advanced parameters.</p></div><div><ul><li><p><code>timeOut</code>: Maximum amount of time the DataWeave script takes before timing out.</p></li><li><p><code>outputMimeType</code>: Default output MIME type if not specified in the DataWeave script.</p></li><li><p><code>writerProperties</code>: Writer properties to use with the specified the <code>outputMimeType</code> property.</p></li><li><p><code>onException</code> Specifies the behavior that occurs when the execution fails:</p><div><ul><li><p><code>HANDLE</code> (default value) returns <code>ExecutionFailure</code>.</p></li><li><p><code>FAIL</code> propagates an exception.</p></li></ul></div></li><li><p><code>securityManager</code>: Identifies the <code>SecurityManager</code> to use in this execution. This security manager is composed by the current <code>SecurityManager</code>.</p></li><li><p><code>loggerService</code>: The <code>LoggerService</code> to use in this execution.</p></li><li><p><code>maxStackSize</code>: The maximum stack size.</p></li><li><p><code>onUnhandledTimeout</code>: Callback that is called when the watchdog was not able to stop the execution after a timeout, which is useful for logging or reporting the problem. The callback is called with the following:</p><div><ul><li><p><code>threadName</code>: Name of the thread that hanged.</p></li><li><p><code>javaStackTrace</code>: Java stack trace where the hang occurred.</p></li><li><p><code>code</code>: The DataWeave code that caused the hang.</p></li></ul></div></li></ul></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>SecurityManager</p></td><td><div><div><p><code>type SecurityManager = (grant: String, args: Array&lt;Any&gt;) -&gt; Boolean</code></p></div></div></td><td><div><div><p>Function that is called when a privilege must be granted to the current execution.</p></div><div><ul><li><p><code>grant</code> is the name of the privilege, such as <code>Resource</code>.</p></li><li><p><code>args</code> provides a list of parameters that the function requesting the privilege calls.</p></li></ul></div><div><p><em>Experimental:</em> This type is an experimental feature that is subject to change or removal from future versions of DataWeave.</p></div></div></td></tr><tr><td><p>TryResult</p></td><td><div><div><p><code>type TryResult = Result&lt;T, TryResultFailure&gt;</code></p></div></div></td><td><div><div><p>Object with a result or error message. If <code>success</code> is <code>false</code>, data type provides the <code>error</code>. If <code>true</code>, the data type provides the <code>result</code>.</p></div></div></td></tr><tr><td><p>TryResultFailure</p></td><td><div><div><p><code>type TryResultFailure = { kind: String, message: String, stack?: Array&lt;String&gt;, stackTrace?: String, location?: String }</code></p></div></div></td><td><div><div><p>A type for representing failed execution from <code>try</code>.</p></div><div><p>Supports the following fields:</p></div><div><ul><li><p><code>kind</code>: The error kind.</p></li><li><p><code>message</code>: The error message.</p></li><li><p><code>stack</code>: The stacktrace error (optional).</p></li><li><p><code>stackTrace</code>: The stacktrace string value representation (optional).</p></li><li><p><code>location</code>: The error location (optional).</p></li></ul></div><div><p>Starting in Mule 4.4.0, if the stack is not present, the <code>stackTrace</code> field is available with the native Java stack trace.</p></div><div><p><em>Introduced in DataWeave version 2.7.0.</em></p></div></div></td></tr></tbody></table>

<!-- document id=d922dfb6bc371d66507f02d0597c2e1193664a07c618cab5c7d5adb824caf430 url=/mulesoft/current/en-us/dataweave/2.11/dw-runtime-functions-runurl.md -->

---
product: DataWeave
version: 2.11
---

# runUrl

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## runUrl(url: String, readerInputs: Dictionary<ReaderInput> = {}, inputValues: Dictionary<Any> = {}, configuration: RuntimeExecutionConfiguration = {}): RunResult

Runs the script at the specified URL.

_Experimental:_ This function is an experimental feature that is subject to change or removal from
future versions of DataWeave.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>url</code></p></td><td><p>The name of the file to execute.</p></td></tr><tr><td><p><code>readerInputs</code></p></td><td><p>Inputs to read and bind to the execution.</p></td></tr><tr><td><p><code>inputValues</code></p></td><td><p>Inputs to be bind directly to the execution.</p></td></tr><tr><td><p><code>configuration</code></p></td><td><p>The runtime configuration.</p></td></tr></tbody></table>

### Example

This example shows how `runUrl` behaves with different inputs.

#### Source

```DataWeave
import * from dw::Runtime
var jsonValue = {
  value: '{"name": "Mariano"}' as Binary {encoding: "UTF-8"},
  encoding: "UTF-8",
  properties: {},
  mimeType: "application/json"
}

var Utils = "fun sum(a,b) = a +b"
---
{
  "execute_ok" : runUrl("classpath://org/mule/weave/v2/engine/runtime_runUrl/example.dwl", {"payload": jsonValue })
}
```

#### Output

```Json
{
   "execute_ok": {
     "success": true,
     "value": "\"Mariano\"",
     "mimeType": "application/dw",
     "encoding": "UTF-8",
     "logs": [

     ]
   }
 }
```

<!-- document id=efcb7f21fda48a46e93c403b273d0037f7a38fb04ec7476ddbc51968174d67e9 url=/mulesoft/current/en-us/dataweave/2.12/dw-runtime-functions-runurl.md -->

---
product: DataWeave
version: 2.12
---

# runUrl

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## runUrl(url: String, readerInputs: Dictionary<ReaderInput> = {}, inputValues: Dictionary<Any> = {}, configuration: RuntimeExecutionConfiguration = {}): RunResult

Runs the script at the specified URL.

_Experimental:_ This function is an experimental feature that is subject to change or removal from
future versions of DataWeave.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>url</code></p></td><td><p>The name of the file to execute.</p></td></tr><tr><td><p><code>readerInputs</code></p></td><td><p>Inputs to read and bind to the execution.</p></td></tr><tr><td><p><code>inputValues</code></p></td><td><p>Inputs to be bind directly to the execution.</p></td></tr><tr><td><p><code>configuration</code></p></td><td><p>The runtime configuration.</p></td></tr></tbody></table>

### Example

This example shows how `runUrl` behaves with different inputs.

#### Source

```DataWeave
import * from dw::Runtime
var jsonValue = {
  value: '{"name": "Mariano"}' as Binary {encoding: "UTF-8"},
  encoding: "UTF-8",
  properties: {},
  mimeType: "application/json"
}

var Utils = "fun sum(a,b) = a +b"
---
{
  "execute_ok" : runUrl("classpath://org/mule/weave/v2/engine/runtime_runUrl/example.dwl", {"payload": jsonValue })
}
```

#### Output

```Json
{
   "execute_ok": {
     "success": true,
     "value": "\"Mariano\"",
     "mimeType": "application/dw",
     "encoding": "UTF-8",
     "logs": [

     ]
   }
 }
```

<!-- document id=7a7222f91ae5d5ee86bae3319863f48030bbc79832021a08fb6626adb4e59357 url=/mulesoft/current/en-us/dataweave/2.4/dw-runtime-functions-runurl.md -->

---
product: DataWeave
version: 2.4
---

# runUrl

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## runUrl(url: String, readerInputs: Dictionary<ReaderInput> = {}, inputValues: Dictionary<Any> = {}, configuration: RuntimeExecutionConfiguration = {}): RunSuccess | ExecutionFailure

Runs the script at the specified URL.

_Experimental:_ This function is an experimental feature that is subject to change or removal from
future versions of DataWeave.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>url</code></p></td><td><p>The name of the file to execute.</p></td></tr><tr><td><p><code>readerInputs</code></p></td><td><p>Inputs to read and bind to the execution.</p></td></tr><tr><td><p><code>inputValues</code></p></td><td><p>Inputs to be bind directly to the execution.</p></td></tr><tr><td><p><code>configuration</code></p></td><td><p>The runtime configuration.</p></td></tr></tbody></table>

### Example

This example shows how `runUrl` behaves with different inputs.

#### Source

```DataWeave
import * from dw::Runtime
var jsonValue = {
  value: '{"name": "Mariano"}' as Binary {encoding: "UTF-8"},
  encoding: "UTF-8",
  properties: {},
  mimeType: "application/json"
}

var Utils = "fun sum(a,b) = a +b"
---
{
  "execute_ok" : runUrl("classpath://org/mule/weave/v2/engine/runtime_runUrl/example.dwl", {"payload": jsonValue })
}
```

#### Output

```Json
{
   "execute_ok": {
     "success": true,
     "value": "\"Mariano\"",
     "mimeType": "application/dw",
     "encoding": "UTF-8",
     "logs": [

     ]
   }
 }
```

<!-- document id=395ec4a7daec5679d7669a6e7249724d66785c52bcc7e4b9b75c4388a39261bc url=/mulesoft/current/en-us/dataweave/2.6/dw-runtime-functions-runurl.md -->

---
product: DataWeave
version: 2.6
---

# runUrl

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## runUrl(url: String, readerInputs: Dictionary<ReaderInput> = {}, inputValues: Dictionary<Any> = {}, configuration: RuntimeExecutionConfiguration = {}): RunSuccess | ExecutionFailure

Runs the script at the specified URL.

_Experimental:_ This function is an experimental feature that is subject to change or removal from
future versions of DataWeave.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>url</code></p></td><td><p>The name of the file to execute.</p></td></tr><tr><td><p><code>readerInputs</code></p></td><td><p>Inputs to read and bind to the execution.</p></td></tr><tr><td><p><code>inputValues</code></p></td><td><p>Inputs to be bind directly to the execution.</p></td></tr><tr><td><p><code>configuration</code></p></td><td><p>The runtime configuration.</p></td></tr></tbody></table>

### Example

This example shows how `runUrl` behaves with different inputs.

#### Source

```DataWeave
import * from dw::Runtime
var jsonValue = {
  value: '{"name": "Mariano"}' as Binary {encoding: "UTF-8"},
  encoding: "UTF-8",
  properties: {},
  mimeType: "application/json"
}

var Utils = "fun sum(a,b) = a +b"
---
{
  "execute_ok" : runUrl("classpath://org/mule/weave/v2/engine/runtime_runUrl/example.dwl", {"payload": jsonValue })
}
```

#### Output

```Json
{
   "execute_ok": {
     "success": true,
     "value": "\"Mariano\"",
     "mimeType": "application/dw",
     "encoding": "UTF-8",
     "logs": [

     ]
   }
 }
```

<!-- document id=8846bfc184188c7a29dc58196a22668e2a252e5c92e3b0ab95fdd68886f17282 url=/mulesoft/current/en-us/dataweave/2.9/dw-runtime-functions-runurl.md -->

---
product: DataWeave
version: 2.9
---

# runUrl

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## runUrl(url: String, readerInputs: Dictionary<ReaderInput> = {}, inputValues: Dictionary<Any> = {}, configuration: RuntimeExecutionConfiguration = {}): RunResult

Runs the script at the specified URL.

_Experimental:_ This function is an experimental feature that is subject to change or removal from
future versions of DataWeave.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>url</code></p></td><td><p>The name of the file to execute.</p></td></tr><tr><td><p><code>readerInputs</code></p></td><td><p>Inputs to read and bind to the execution.</p></td></tr><tr><td><p><code>inputValues</code></p></td><td><p>Inputs to be bind directly to the execution.</p></td></tr><tr><td><p><code>configuration</code></p></td><td><p>The runtime configuration.</p></td></tr></tbody></table>

### Example

This example shows how `runUrl` behaves with different inputs.

#### Source

```DataWeave
import * from dw::Runtime
var jsonValue = {
  value: '{"name": "Mariano"}' as Binary {encoding: "UTF-8"},
  encoding: "UTF-8",
  properties: {},
  mimeType: "application/json"
}

var Utils = "fun sum(a,b) = a +b"
---
{
  "execute_ok" : runUrl("classpath://org/mule/weave/v2/engine/runtime_runUrl/example.dwl", {"payload": jsonValue })
}
```

#### Output

```Json
{
   "execute_ok": {
     "success": true,
     "value": "\"Mariano\"",
     "mimeType": "application/dw",
     "encoding": "UTF-8",
     "logs": [

     ]
   }
 }
```

<!-- document id=f1b879e4b000cd2eafd0b5ddaa6c6690e67547a857d6d1877bad15750075fc88 url=/mulesoft/current/en-us/dataweave/latest/dw-runtime-functions-runurl.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# runUrl

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## runUrl(url: String, readerInputs: Dictionary<ReaderInput> = {}, inputValues: Dictionary<Any> = {}, configuration: RuntimeExecutionConfiguration = {}): RunResult

Runs the script at the specified URL.

_Experimental:_ This function is an experimental feature that is subject to change or removal from
future versions of DataWeave.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>url</code></p></td><td><p>The name of the file to execute.</p></td></tr><tr><td><p><code>readerInputs</code></p></td><td><p>Inputs to read and bind to the execution.</p></td></tr><tr><td><p><code>inputValues</code></p></td><td><p>Inputs to be bind directly to the execution.</p></td></tr><tr><td><p><code>configuration</code></p></td><td><p>The runtime configuration.</p></td></tr></tbody></table>

### Example

This example shows how `runUrl` behaves with different inputs.

#### Source

```DataWeave
import * from dw::Runtime
var jsonValue = {
  value: '{"name": "Mariano"}' as Binary {encoding: "UTF-8"},
  encoding: "UTF-8",
  properties: {},
  mimeType: "application/json"
}

var Utils = "fun sum(a,b) = a +b"
---
{
  "execute_ok" : runUrl("classpath://org/mule/weave/v2/engine/runtime_runUrl/example.dwl", {"payload": jsonValue })
}
```

#### Output

```Json
{
   "execute_ok": {
     "success": true,
     "value": "\"Mariano\"",
     "mimeType": "application/dw",
     "encoding": "UTF-8",
     "logs": [

     ]
   }
 }
```

<!-- document id=92512773dc36c01dafb6cc06fc77cf673a55027b2f70c516dd99b3ba7bbbdc9b url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-scan.md -->

---
product: DataWeave
version: 2.11
---

# scan

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## scan(text: String, matcher: Regex): Array<Array<String>>

Returns an array with all of the matches found in an input string.

Each match is returned as an array that contains the complete match followed by any capture groups
in your regular expression (if present).

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string to scan.</p></td></tr><tr><td><p><code>regex</code></p></td><td><p>A Java regular expression that describes the pattern match in the <code>text</code>.</p></td></tr></tbody></table>

### Example

In this example, the `regex` describes a URL. It contains three capture groups within the
parentheses, the characters before and after the period (`.`). It produces an array of matches to
the input URL and the capture groups. It uses `flatten` to change the output from an array of arrays
into a simple array. Note that a `regex` is specified within forward slashes (`//`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
flatten("www.mulesoft.com" scan(/([w]*)\.([a-z]*)\.([a-z]*)/))
```

#### Output

```JSON
[ "www.mulesoft.com", "www", "mulesoft", "com" ]
```

### Example

In the example, the `regex` describes an email address. It contains two capture groups, the
characters before and after the `@`. It produces an array matches to the email addresses and capture
groups in the input string.

#### Source

```DataWeave
%dw 2.0
output application/json
---
"anypt@mulesoft.com,max@mulesoft.com" scan(/([a-z]*)@([a-z]*).com/)
```

#### Output

```JSON
[
  [ "anypt@mulesoft.com", "anypt", "mulesoft" ],
  [ "max@mulesoft.com", "max", "mulesoft" ]
]
```

## scan(text: Null, matcher: Any): Null

Helper function that enables `scan` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=b4cf464eab16e6d81f9633769da6b6194f5b3c2a2bb1ef4a5713f5345bb7cc7d url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-scan.md -->

---
product: DataWeave
version: 2.12
---

# scan

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## scan(text: String, matcher: Regex): Array<Array<String>>

Returns an array with all of the matches found in an input string.

Each match is returned as an array that contains the complete match followed by any capture groups
in your regular expression (if present).

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string to scan.</p></td></tr><tr><td><p><code>regex</code></p></td><td><p>A Java regular expression that describes the pattern match in the <code>text</code>.</p></td></tr></tbody></table>

### Example

In this example, the `regex` describes a URL. It contains three capture groups within the
parentheses, the characters before and after the period (`.`). It produces an array of matches to
the input URL and the capture groups. It uses `flatten` to change the output from an array of arrays
into a simple array. Note that a `regex` is specified within forward slashes (`//`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
flatten("www.mulesoft.com" scan(/([w]*)\.([a-z]*)\.([a-z]*)/))
```

#### Output

```JSON
[ "www.mulesoft.com", "www", "mulesoft", "com" ]
```

### Example

In the example, the `regex` describes an email address. It contains two capture groups, the
characters before and after the `@`. It produces an array matches to the email addresses and capture
groups in the input string.

#### Source

```DataWeave
%dw 2.0
output application/json
---
"anypt@mulesoft.com,max@mulesoft.com" scan(/([a-z]*)@([a-z]*).com/)
```

#### Output

```JSON
[
  [ "anypt@mulesoft.com", "anypt", "mulesoft" ],
  [ "max@mulesoft.com", "max", "mulesoft" ]
]
```

## scan(text: Null, matcher: Any): Null

Helper function that enables `scan` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=f3903aee8496be5655f1144414d6f710e7330896c223ad08d131f14652ac93e2 url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-scan.md -->

---
product: DataWeave
version: 2.3
---

# scan

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## scan(String, Regex): Array<Array<String>>

Returns an array with all of the matches found in an input string.

Each match is returned as an array that contains the complete match followed by any capture groups
in your regular expression (if present).

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string to scan.</p></td></tr><tr><td><p><code>regex</code></p></td><td><p>A Java regular expression that describes the pattern match in the <code>text</code>.</p></td></tr></tbody></table>

### Example

In this example, the `regex` describes a URL. It contains three capture groups within the
parentheses, the characters before and after the period (`.`). It produces an array of matches to
the input URL and the capture groups. It uses `flatten` to change the output from an array of arrays
into a simple array. Note that a `regex` is specified within forward slashes (`//`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
flatten("www.mulesoft.com" scan(/([w]*).([a-z]*).([a-z]*)/))
```

#### Output

```JSON
[ "www.mulesoft.com", "www", "mulesoft", "com" ]
```

### Example

In the example, the `regex` describes an email address. It contains two capture groups, the
characters before and after the `@`. It produces an array matches to the email addresses and capture
groups in the input string.

#### Source

```DataWeave
%dw 2.0
output application/json
---
"anypt@mulesoft.com,max@mulesoft.com" scan(/([a-z]*)@([a-z]*).com/)
```

#### Output

```JSON
[
  [ "anypt@mulesoft.com", "anypt", "mulesoft" ],
  [ "max@mulesoft.com", "max", "mulesoft" ]
]
```

<!-- document id=59eb7884e2b67a174b5beae34e845d703984807389e338ce47aa0e9ba6ea328b url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-scan.md -->

---
product: DataWeave
version: 2.4
---

# scan

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## scan(text: String, matcher: Regex): Array<Array<String>>

Returns an array with all of the matches found in an input string.

Each match is returned as an array that contains the complete match followed by any capture groups
in your regular expression (if present).

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string to scan.</p></td></tr><tr><td><p><code>regex</code></p></td><td><p>A Java regular expression that describes the pattern match in the <code>text</code>.</p></td></tr></tbody></table>

### Example

In this example, the `regex` describes a URL. It contains three capture groups within the
parentheses, the characters before and after the period (`.`). It produces an array of matches to
the input URL and the capture groups. It uses `flatten` to change the output from an array of arrays
into a simple array. Note that a `regex` is specified within forward slashes (`//`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
flatten("www.mulesoft.com" scan(/([w]*)\.([a-z]*)\.([a-z]*)/))
```

#### Output

```JSON
[ "www.mulesoft.com", "www", "mulesoft", "com" ]
```

### Example

In the example, the `regex` describes an email address. It contains two capture groups, the
characters before and after the `@`. It produces an array matches to the email addresses and capture
groups in the input string.

#### Source

```DataWeave
%dw 2.0
output application/json
---
"anypt@mulesoft.com,max@mulesoft.com" scan(/([a-z]*)@([a-z]*).com/)
```

#### Output

```JSON
[
  [ "anypt@mulesoft.com", "anypt", "mulesoft" ],
  [ "max@mulesoft.com", "max", "mulesoft" ]
]
```

## scan(text: Null, matcher: Any): Null

Helper function that enables `scan` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=ddd55c2c552f3b2abc2ee920b10b4e76cdb95f8dc99f3660f91371c973c438a1 url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-scan.md -->

---
product: DataWeave
version: 2.6
---

# scan

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## scan(text: String, matcher: Regex): Array<Array<String>>

Returns an array with all of the matches found in an input string.

Each match is returned as an array that contains the complete match followed by any capture groups
in your regular expression (if present).

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string to scan.</p></td></tr><tr><td><p><code>regex</code></p></td><td><p>A Java regular expression that describes the pattern match in the <code>text</code>.</p></td></tr></tbody></table>

### Example

In this example, the `regex` describes a URL. It contains three capture groups within the
parentheses, the characters before and after the period (`.`). It produces an array of matches to
the input URL and the capture groups. It uses `flatten` to change the output from an array of arrays
into a simple array. Note that a `regex` is specified within forward slashes (`//`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
flatten("www.mulesoft.com" scan(/([w]*)\.([a-z]*)\.([a-z]*)/))
```

#### Output

```JSON
[ "www.mulesoft.com", "www", "mulesoft", "com" ]
```

### Example

In the example, the `regex` describes an email address. It contains two capture groups, the
characters before and after the `@`. It produces an array matches to the email addresses and capture
groups in the input string.

#### Source

```DataWeave
%dw 2.0
output application/json
---
"anypt@mulesoft.com,max@mulesoft.com" scan(/([a-z]*)@([a-z]*).com/)
```

#### Output

```JSON
[
  [ "anypt@mulesoft.com", "anypt", "mulesoft" ],
  [ "max@mulesoft.com", "max", "mulesoft" ]
]
```

## scan(text: Null, matcher: Any): Null

Helper function that enables `scan` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=7162b63dc60c49289d67f1691abc41d7092bdae42881121f96c432c11ee4087c url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-scan.md -->

---
product: DataWeave
version: 2.9
---

# scan

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## scan(text: String, matcher: Regex): Array<Array<String>>

Returns an array with all of the matches found in an input string.

Each match is returned as an array that contains the complete match followed by any capture groups
in your regular expression (if present).

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string to scan.</p></td></tr><tr><td><p><code>regex</code></p></td><td><p>A Java regular expression that describes the pattern match in the <code>text</code>.</p></td></tr></tbody></table>

### Example

In this example, the `regex` describes a URL. It contains three capture groups within the
parentheses, the characters before and after the period (`.`). It produces an array of matches to
the input URL and the capture groups. It uses `flatten` to change the output from an array of arrays
into a simple array. Note that a `regex` is specified within forward slashes (`//`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
flatten("www.mulesoft.com" scan(/([w]*)\.([a-z]*)\.([a-z]*)/))
```

#### Output

```JSON
[ "www.mulesoft.com", "www", "mulesoft", "com" ]
```

### Example

In the example, the `regex` describes an email address. It contains two capture groups, the
characters before and after the `@`. It produces an array matches to the email addresses and capture
groups in the input string.

#### Source

```DataWeave
%dw 2.0
output application/json
---
"anypt@mulesoft.com,max@mulesoft.com" scan(/([a-z]*)@([a-z]*).com/)
```

#### Output

```JSON
[
  [ "anypt@mulesoft.com", "anypt", "mulesoft" ],
  [ "max@mulesoft.com", "max", "mulesoft" ]
]
```

## scan(text: Null, matcher: Any): Null

Helper function that enables `scan` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=4fd09f365ee343a7eb1f9f96d59b6530ae6e58d9d2a38b5fd44613caca0dddc7 url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-scan.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# scan

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## scan(text: String, matcher: Regex): Array<Array<String>>

Returns an array with all of the matches found in an input string.

Each match is returned as an array that contains the complete match followed by any capture groups
in your regular expression (if present).

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string to scan.</p></td></tr><tr><td><p><code>regex</code></p></td><td><p>A Java regular expression that describes the pattern match in the <code>text</code>.</p></td></tr></tbody></table>

### Example

In this example, the `regex` describes a URL. It contains three capture groups within the
parentheses, the characters before and after the period (`.`). It produces an array of matches to
the input URL and the capture groups. It uses `flatten` to change the output from an array of arrays
into a simple array. Note that a `regex` is specified within forward slashes (`//`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
flatten("www.mulesoft.com" scan(/([w]*)\.([a-z]*)\.([a-z]*)/))
```

#### Output

```JSON
[ "www.mulesoft.com", "www", "mulesoft", "com" ]
```

### Example

In the example, the `regex` describes an email address. It contains two capture groups, the
characters before and after the `@`. It produces an array matches to the email addresses and capture
groups in the input string.

#### Source

```DataWeave
%dw 2.0
output application/json
---
"anypt@mulesoft.com,max@mulesoft.com" scan(/([a-z]*)@([a-z]*).com/)
```

#### Output

```JSON
[
  [ "anypt@mulesoft.com", "anypt", "mulesoft" ],
  [ "max@mulesoft.com", "max", "mulesoft" ]
]
```

## scan(text: Null, matcher: Any): Null

Helper function that enables `scan` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=67851c7d91f4ed73f84da821c38a80b83acc4a533cef6dd3cb290ddfd45bbef7 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-scope-visibility.md -->

---
product: DataWeave
version: 2.12
---

# Scope Visibility in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave 2.12.0 introduces scope visibility so you can control which directives in a DataWeave file
are accessible from other files. Visibility rules apply to module-level declarations: `fun`, `var`,
`type`, `ns`, and `annotation`.

Scope visibility is primarily for DataWeave library authors. If you write Mule transformation
mappings (the `%dw 2.0` script in a Transform Message component), you can ignore this feature
because a mapping is a single, self-contained file that doesn’t export directives to other files.
Visibility becomes relevant when you publish a `.jar` that other DataWeave code imports.

## Visibility Levels

DataWeave 2.12.0 supports three visibility levels:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Level</th><th>Keyword</th><th>Accessible From</th></tr></thead><tbody><tr><td><p>Public</p></td><td><p><em>(none)</em></p></td><td><p>Anywhere. Default and only behavior in versions before 2.12.0.</p></td></tr><tr><td><p>Private</p></td><td><p><code>private</code></p></td><td><p>The same file only.</p></td></tr><tr><td><p>Internal</p></td><td><p><code>internal</code></p></td><td><p>Any file in the same <a href="#components">component</a>. Can be widened with <code>@VisibleTo</code>.</p></td></tr></tbody></table>

> [!NOTE] Visibility checks run only at compile time. Once a script is compiled, no runtime
> visibility check is performed. This keeps execution overhead at zero and ensures pre-compiled
> (`.bdwl`) modules behave the same as source modules.

## Syntax

Place the visibility keyword before the directive keyword (`fun`, `var`, `type`, `ns`, and
`annotation`).

```dataweave
%dw 2.0

// Public (default) — accessible from anywhere
fun greet(name: String) = "Hello, $(name)!"

// Private — accessible only inside this file
private fun normalize(name: String) = upper(name)

// Internal — accessible from any file in the same component
internal var defaultGreeting = "Hello"

// Type and namespace declarations also support visibility
private type UserName = String
internal ns http https://schemas.example.org/http
```

The `@VisibleTo` annotation widens an `internal` directive to a fixed list of additional components:

```dataweave
%dw 2.0
import * from dw::Core

@VisibleTo(components = ["analytics", "reporting"])
internal fun computeStats(records: Array) = sizeOf(records)
```

`@VisibleTo` is only valid on `internal` directives. Applying it to a `private` directive or to a
directive without a visibility keyword raises a compile-time error:
`The @VisibleTo annotation can only be applied to 'internal' directives`.

## What Is a Component?

DataWeave doesn’t provide a `module` or `package` keyword to group files. Until 2.12.0, every `.dwl`
file lived in one global namespace. To make `internal` meaningful, the language now uses the
component concept, which is a named set of DataWeave resources (modules) that are compiled and
packaged together.

A component is described by a component descriptor, a `.dwl` resource located at
`META-INF/dw-components.dwl` inside a `.jar` file. The descriptor is an array of components, and
each component lists the resources it owns:

```dataweave
%dw 2.0
---
[
    {
        name: "wlang",
        resources: {
            "dw::Core": {},
            "dw::Crypto": {},
            "dw::core::Arrays": {},
            "dw::core::Strings": {}
            // ...
        }
    }
]
```

When the compiler resolves a reference to a symbol declared in another module, it consults the
descriptors on the classpath to determine the components that own the declaring module and the
caller module.

### Generating the Descriptor

You don’t write the descriptor manually. The [Maven plugin for DataWeave](https://docs.mulesoft.com/dataweave/2.12/dataweave-maven-plugin)
generates it automatically:

- For a production build (`data-weave:package`), the plugin scans `src/main/dw`, derives the
  resource names of every `.dwl` file, and writes
  `target/generated-dataweave-metadata/dw-components.dwl`. The file is added to the produced JAR at
  `META-INF/dw-components.dwl`.

- For a test build (`data-weave:test`), the plugin scans both `src/main/dw` and `src/test/dw`, so
  test files belong to the same component as the production sources they exercise. This lets tests
  call `internal` directives without further configuration.

The component name defaults to the Maven `artifactId` of the project.

### Component Resolution Algorithm

Given a reference from caller `A` to symbol `s` declared in module `B`, the compiler looks up
`componentOf(B)` from the descriptors on the classpath. Access is allowed based on the visibility of
`s`:

- If `s` is `private`, access is allowed only when `A == B`.

- If `s` is `internal`, access is allowed when `componentOf(A) == componentOf(B)`, or when
  `componentOf(A)` appears in the `@VisibleTo` list on `s`.

- If `s` is `public`, access is always allowed.

If a module declares `internal` directives and no descriptor on the classpath claims it, the
compiler emits the `Module 'X' declares 'internal' members but has no component descriptor` error.
In that case, package the module with the Maven plugin for DataWeave or add a component descriptor
that lists it.

## Compile-Time Validation

The compiler reports four new errors:

<table><colgroup><col> <col></colgroup><thead><tr><th>Error Kind</th><th>Triggered When</th></tr></thead><tbody><tr><td><p><code>PrivateAccessViolation</code></p></td><td><p>A reference targets a <code>private</code> directive declared in a different file.</p></td></tr><tr><td><p><code>InternalAccessViolation</code></p></td><td><p>A reference targets an <code>internal</code> directive declared in a different component, when the caller’s component isn’t in the directive’s <code>@VisibleTo</code> list.</p></td></tr><tr><td><p><code>VisibleToRequiresInternal</code></p></td><td><p><code>@VisibleTo</code> is applied to a directive that isn’t <code>internal</code>.</p></td></tr><tr><td><p><code>MissingComponentForInternalDirective</code></p></td><td><p>A module declares <code>internal</code> directives but no component descriptor on the classpath claims it.</p></td></tr></tbody></table>

## Function Overloads and Visibility

Function overloads must use the same visibility. Mixing `internal fun foo(x: String) = …​` and
`fun foo(x: Number) = …​` is rejected with an error that indicates the expected visibility (from the
first overload). This guarantees that callers see a single, consistent visibility for any given
function name.

## Structural Types and Visibility Propagation

DataWeave uses a structural type system. Visibility on a type controls who can reference the type by
name and doesn’t propagate to functions or variables that use that type in their signature. A caller
can invoke a function whose signature mentions a `private` type as long as the caller doesn’t name
that type.

```dataweave
// In component A
private type Account = { id: String }

@VisibleTo(components = ["bat"])
internal fun createAccount(account: Account) = account

// In component B (bat)
import createAccount from componentA::Accounts

// OK — structural call, no explicit reference to `Account`
createAccount({ id: "abc" })

// Error — explicit reference to private type `Account`
createAccount({ id: "abc" }) as Account
```

The same rule applies to type annotations on variables (`var x: Account = …​`) and pattern matches
that name a type.

## Examples

These examples demonstrate common visibility patterns for DataWeave library authors.

### File-Local Helper

Use `private` to restrict a helper function to a single file.

```dataweave
// dw/core/Core.dwl

%dw 2.0

private fun isLegacyMode(): Boolean =
    evaluateCompatibilityFlag("com.mulesoft.dw.legacyMode")

fun sizeOf(value) =
    if (isLegacyMode()) legacyImpl(value) else newImpl(value)
```

`isLegacyMode` is reachable only inside `Core.dwl`.

### Component-Internal Helper

Use `internal` to share helper functions across files within the same component while preventing
external access.

```dataweave
// dw/core/Internal.dwl   (component: wlang)
%dw 2.0
internal fun dropFrame(): Boolean = ...

// dw/core/Core.dwl   (component: wlang)
%dw 2.0
import dropFrame from dw::core::Internal
fun process() = if (dropFrame()) ... else ...   // OK — same component

// com/acme/App.dwl   (component: acme-app)
%dw 2.0
import dropFrame from dw::core::Internal         // Error: internal to `wlang`
```

### Sharing Internals With a Specific Component

Use `@VisibleTo` with `internal` to allow specific external components to access a directive.

```dataweave
// dw/native/Native.dwl   (component: wlang)
%dw 2.0

@VisibleTo(components = ["bat", "dataweave-io"])
internal fun nativeImpl() = ...

// bat/core/Runner.dwl   (component: bat)
import nativeImpl from dw::native::Native        // OK — bat is permitted

// com/paypal/Connector.dwl   (component: paypal-connector)
import nativeImpl from dw::native::Native        // Error — not permitted
```

## Migrating From `@Internal(permits=…​)`

In versions before 2.12.0, the only way to constrain visibility was the experimental
`@Internal(permits = […​])` annotation, which matched callers by `NameIdentifier` prefix.
`@Internal` is still accepted in 2.12.0 but is deprecated in favor of the new keywords:

<table><colgroup><col> <col></colgroup><thead><tr><th>Old Form</th><th>Replacement</th></tr></thead><tbody><tr><td><p><code>@Internal(permits = [])</code></p></td><td><p><code>private</code></p></td></tr><tr><td><p><code>@Internal(permits = ["dw::"])</code></p></td><td><p><code>internal</code> (the consuming component must also be migrated to a 2.12.0 build so a descriptor exists)</p></td></tr><tr><td><p><code>@Internal(permits = ["bat::", "dw::"])</code></p></td><td><p><code>@VisibleTo(components = ["bat"])</code> <code>internal</code></p></td></tr></tbody></table>

Files that don’t use any visibility keyword behave exactly as in earlier versions: every directive
is public.

## Setting a Per-Component Language Level

When a host application embeds the DataWeave engine, it can pin a specific language level for each
component using the new `componentLanguageLevels` parameter on `DWScriptingEngine.compileDWScript`:

```scala
def compileDWScript(
    script: String,
    languageLevel: String,
    componentLanguageLevels: util.Map[String, String] = new util.HashMap()
): DWScript
```

This is used together with `@Since` on function overloads to dispatch to the correct overload when a
library evolves, ensuring backward compatibility for existing scripts.

## See Also

- [`dw::meta::Component` Module](https://docs.mulesoft.com/dataweave/2.12/dw-component)

- [`@VisibleTo` Annotation](https://docs.mulesoft.com/dataweave/2.12/dw-core-annotations)

- [Maven plugin for DataWeave](https://docs.mulesoft.com/dataweave/2.12/dataweave-maven-plugin)

- [DataWeave extension plugin](https://docs.mulesoft.com/dataweave/2.12/dataweave-extension-plugin)

<!-- document id=7ae36313142b4fe1a8a6890cd775ada0be7ab359114fda20572d82618253a75f url=/mulesoft/current/en-us/dataweave/latest/dataweave-scope-visibility.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Scope Visibility in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave 2.12.0 introduces scope visibility so you can control which directives in a DataWeave file
are accessible from other files. Visibility rules apply to module-level declarations: `fun`, `var`,
`type`, `ns`, and `annotation`.

Scope visibility is primarily for DataWeave library authors. If you write Mule transformation
mappings (the `%dw 2.0` script in a Transform Message component), you can ignore this feature
because a mapping is a single, self-contained file that doesn’t export directives to other files.
Visibility becomes relevant when you publish a `.jar` that other DataWeave code imports.

## Visibility Levels

DataWeave 2.12.0 supports three visibility levels:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Level</th><th>Keyword</th><th>Accessible From</th></tr></thead><tbody><tr><td><p>Public</p></td><td><p><em>(none)</em></p></td><td><p>Anywhere. Default and only behavior in versions before 2.12.0.</p></td></tr><tr><td><p>Private</p></td><td><p><code>private</code></p></td><td><p>The same file only.</p></td></tr><tr><td><p>Internal</p></td><td><p><code>internal</code></p></td><td><p>Any file in the same <a href="#components">component</a>. Can be widened with <code>@VisibleTo</code>.</p></td></tr></tbody></table>

> [!NOTE] Visibility checks run only at compile time. Once a script is compiled, no runtime
> visibility check is performed. This keeps execution overhead at zero and ensures pre-compiled
> (`.bdwl`) modules behave the same as source modules.

## Syntax

Place the visibility keyword before the directive keyword (`fun`, `var`, `type`, `ns`, and
`annotation`).

```dataweave
%dw 2.0

// Public (default) — accessible from anywhere
fun greet(name: String) = "Hello, $(name)!"

// Private — accessible only inside this file
private fun normalize(name: String) = upper(name)

// Internal — accessible from any file in the same component
internal var defaultGreeting = "Hello"

// Type and namespace declarations also support visibility
private type UserName = String
internal ns http https://schemas.example.org/http
```

The `@VisibleTo` annotation widens an `internal` directive to a fixed list of additional components:

```dataweave
%dw 2.0
import * from dw::Core

@VisibleTo(components = ["analytics", "reporting"])
internal fun computeStats(records: Array) = sizeOf(records)
```

`@VisibleTo` is only valid on `internal` directives. Applying it to a `private` directive or to a
directive without a visibility keyword raises a compile-time error:
`The @VisibleTo annotation can only be applied to 'internal' directives`.

## What Is a Component?

DataWeave doesn’t provide a `module` or `package` keyword to group files. Until 2.12.0, every `.dwl`
file lived in one global namespace. To make `internal` meaningful, the language now uses the
component concept, which is a named set of DataWeave resources (modules) that are compiled and
packaged together.

A component is described by a component descriptor, a `.dwl` resource located at
`META-INF/dw-components.dwl` inside a `.jar` file. The descriptor is an array of components, and
each component lists the resources it owns:

```dataweave
%dw 2.0
---
[
    {
        name: "wlang",
        resources: {
            "dw::Core": {},
            "dw::Crypto": {},
            "dw::core::Arrays": {},
            "dw::core::Strings": {}
            // ...
        }
    }
]
```

When the compiler resolves a reference to a symbol declared in another module, it consults the
descriptors on the classpath to determine the components that own the declaring module and the
caller module.

### Generating the Descriptor

You don’t write the descriptor manually. The [Maven plugin for DataWeave](https://docs.mulesoft.com/dataweave/latest/dataweave-maven-plugin)
generates it automatically:

- For a production build (`data-weave:package`), the plugin scans `src/main/dw`, derives the
  resource names of every `.dwl` file, and writes
  `target/generated-dataweave-metadata/dw-components.dwl`. The file is added to the produced JAR at
  `META-INF/dw-components.dwl`.

- For a test build (`data-weave:test`), the plugin scans both `src/main/dw` and `src/test/dw`, so
  test files belong to the same component as the production sources they exercise. This lets tests
  call `internal` directives without further configuration.

The component name defaults to the Maven `artifactId` of the project.

### Component Resolution Algorithm

Given a reference from caller `A` to symbol `s` declared in module `B`, the compiler looks up
`componentOf(B)` from the descriptors on the classpath. Access is allowed based on the visibility of
`s`:

- If `s` is `private`, access is allowed only when `A == B`.

- If `s` is `internal`, access is allowed when `componentOf(A) == componentOf(B)`, or when
  `componentOf(A)` appears in the `@VisibleTo` list on `s`.

- If `s` is `public`, access is always allowed.

If a module declares `internal` directives and no descriptor on the classpath claims it, the
compiler emits the `Module 'X' declares 'internal' members but has no component descriptor` error.
In that case, package the module with the Maven plugin for DataWeave or add a component descriptor
that lists it.

## Compile-Time Validation

The compiler reports four new errors:

<table><colgroup><col> <col></colgroup><thead><tr><th>Error Kind</th><th>Triggered When</th></tr></thead><tbody><tr><td><p><code>PrivateAccessViolation</code></p></td><td><p>A reference targets a <code>private</code> directive declared in a different file.</p></td></tr><tr><td><p><code>InternalAccessViolation</code></p></td><td><p>A reference targets an <code>internal</code> directive declared in a different component, when the caller’s component isn’t in the directive’s <code>@VisibleTo</code> list.</p></td></tr><tr><td><p><code>VisibleToRequiresInternal</code></p></td><td><p><code>@VisibleTo</code> is applied to a directive that isn’t <code>internal</code>.</p></td></tr><tr><td><p><code>MissingComponentForInternalDirective</code></p></td><td><p>A module declares <code>internal</code> directives but no component descriptor on the classpath claims it.</p></td></tr></tbody></table>

## Function Overloads and Visibility

Function overloads must use the same visibility. Mixing `internal fun foo(x: String) = …​` and
`fun foo(x: Number) = …​` is rejected with an error that indicates the expected visibility (from the
first overload). This guarantees that callers see a single, consistent visibility for any given
function name.

## Structural Types and Visibility Propagation

DataWeave uses a structural type system. Visibility on a type controls who can reference the type by
name and doesn’t propagate to functions or variables that use that type in their signature. A caller
can invoke a function whose signature mentions a `private` type as long as the caller doesn’t name
that type.

```dataweave
// In component A
private type Account = { id: String }

@VisibleTo(components = ["bat"])
internal fun createAccount(account: Account) = account

// In component B (bat)
import createAccount from componentA::Accounts

// OK — structural call, no explicit reference to `Account`
createAccount({ id: "abc" })

// Error — explicit reference to private type `Account`
createAccount({ id: "abc" }) as Account
```

The same rule applies to type annotations on variables (`var x: Account = …​`) and pattern matches
that name a type.

## Examples

These examples demonstrate common visibility patterns for DataWeave library authors.

### File-Local Helper

Use `private` to restrict a helper function to a single file.

```dataweave
// dw/core/Core.dwl

%dw 2.0

private fun isLegacyMode(): Boolean =
    evaluateCompatibilityFlag("com.mulesoft.dw.legacyMode")

fun sizeOf(value) =
    if (isLegacyMode()) legacyImpl(value) else newImpl(value)
```

`isLegacyMode` is reachable only inside `Core.dwl`.

### Component-Internal Helper

Use `internal` to share helper functions across files within the same component while preventing
external access.

```dataweave
// dw/core/Internal.dwl   (component: wlang)
%dw 2.0
internal fun dropFrame(): Boolean = ...

// dw/core/Core.dwl   (component: wlang)
%dw 2.0
import dropFrame from dw::core::Internal
fun process() = if (dropFrame()) ... else ...   // OK — same component

// com/acme/App.dwl   (component: acme-app)
%dw 2.0
import dropFrame from dw::core::Internal         // Error: internal to `wlang`
```

### Sharing Internals With a Specific Component

Use `@VisibleTo` with `internal` to allow specific external components to access a directive.

```dataweave
// dw/native/Native.dwl   (component: wlang)
%dw 2.0

@VisibleTo(components = ["bat", "dataweave-io"])
internal fun nativeImpl() = ...

// bat/core/Runner.dwl   (component: bat)
import nativeImpl from dw::native::Native        // OK — bat is permitted

// com/paypal/Connector.dwl   (component: paypal-connector)
import nativeImpl from dw::native::Native        // Error — not permitted
```

## Migrating From `@Internal(permits=…​)`

In versions before 2.12.0, the only way to constrain visibility was the experimental
`@Internal(permits = […​])` annotation, which matched callers by `NameIdentifier` prefix.
`@Internal` is still accepted in 2.12.0 but is deprecated in favor of the new keywords:

<table><colgroup><col> <col></colgroup><thead><tr><th>Old Form</th><th>Replacement</th></tr></thead><tbody><tr><td><p><code>@Internal(permits = [])</code></p></td><td><p><code>private</code></p></td></tr><tr><td><p><code>@Internal(permits = ["dw::"])</code></p></td><td><p><code>internal</code> (the consuming component must also be migrated to a 2.12.0 build so a descriptor exists)</p></td></tr><tr><td><p><code>@Internal(permits = ["bat::", "dw::"])</code></p></td><td><p><code>@VisibleTo(components = ["bat"])</code> <code>internal</code></p></td></tr></tbody></table>

Files that don’t use any visibility keyword behave exactly as in earlier versions: every directive
is public.

## Setting a Per-Component Language Level

When a host application embeds the DataWeave engine, it can pin a specific language level for each
component using the new `componentLanguageLevels` parameter on `DWScriptingEngine.compileDWScript`:

```scala
def compileDWScript(
    script: String,
    languageLevel: String,
    componentLanguageLevels: util.Map[String, String] = new util.HashMap()
): DWScript
```

This is used together with `@Since` on function overloads to dispatch to the correct overload when a
library evolves, ensuring backward compatibility for existing scripts.

## See Also

- [`dw::meta::Component` Module](https://docs.mulesoft.com/dataweave/latest/dw-component)

- [`@VisibleTo` Annotation](https://docs.mulesoft.com/dataweave/latest/dw-core-annotations)

- [Maven plugin for DataWeave](https://docs.mulesoft.com/dataweave/latest/dataweave-maven-plugin)

- [DataWeave extension plugin](https://docs.mulesoft.com/dataweave/latest/dataweave-extension-plugin)

<!-- document id=885ccd867ec0c88d6e15d16823d8167bbbb40c413c9a5724be8b00505419bbde url=/mulesoft/current/en-us/dataweave/2.11/dw-periods-functions-seconds.md -->

---
product: DataWeave
version: 2.11
---

# seconds

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## seconds(nSecs: Number): Period

Creates a Period value from the provided number of seconds.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>nSecs</code></p></td><td><p>The number of seconds as a whole or decimal number. A positive or negative number is valid.</p></td></tr></tbody></table>

### Example

This example shows how `seconds` behaves with different inputs. It adds and subtracts seconds from
DateTime values. It also converts the decimal value `4.555` into the Period format (`PT4.555S`) and
and the whole number `4` into the Period format (`PT4S`)

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Periods
output application/json
---
{
  nextSecond: |2020-10-05T20:22:34.385Z| + seconds(1),
  previousSecond: |2020-10-05T20:22:34.385Z| - seconds(1),
  decimalInputPeriod: seconds(4.555),
  wholeNumberInputPeriod: seconds(4),
  addNegativeValue: seconds(-1) + seconds(2)
}
```

#### Output

```Json
{
  "nextSecond": "2020-10-05T20:22:35.385Z",
  "previousSecond": "2020-10-05T20:22:33.385Z",
  "decimalInputPeriod": "PT4.555S",
  "wholeNumberInputPeriod": "PT4S",
  "addNegativeValue": 1
}
```

<!-- document id=ad2dcfb78cb04a178df77fb525c20a6953d88849969db6cdf59d0430c4ba7d15 url=/mulesoft/current/en-us/dataweave/2.12/dw-periods-functions-seconds.md -->

---
product: DataWeave
version: 2.12
---

# seconds

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## seconds(nSecs: Number): Period

Creates a Period value from the provided number of seconds.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>nSecs</code></p></td><td><p>The number of seconds as a whole or decimal number. A positive or negative number is valid.</p></td></tr></tbody></table>

### Example

This example shows how `seconds` behaves with different inputs. It adds and subtracts seconds from
DateTime values. It also converts the decimal value `4.555` into the Period format (`PT4.555S`) and
and the whole number `4` into the Period format (`PT4S`)

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Periods
output application/json
---
{
  nextSecond: |2020-10-05T20:22:34.385Z| + seconds(1),
  previousSecond: |2020-10-05T20:22:34.385Z| - seconds(1),
  decimalInputPeriod: seconds(4.555),
  wholeNumberInputPeriod: seconds(4),
  addNegativeValue: seconds(-1) + seconds(2)
}
```

#### Output

```Json
{
  "nextSecond": "2020-10-05T20:22:35.385Z",
  "previousSecond": "2020-10-05T20:22:33.385Z",
  "decimalInputPeriod": "PT4.555S",
  "wholeNumberInputPeriod": "PT4S",
  "addNegativeValue": 1
}
```

<!-- document id=78b893dcc36ed9568b7f3b2d7bb57da2ee7abf0379cf059e2628d64ba557aa14 url=/mulesoft/current/en-us/dataweave/2.4/dw-periods-functions-seconds.md -->

---
product: DataWeave
version: 2.4
---

# seconds

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## seconds(nSecs: Number): Period

Creates a Period value from the provided number of seconds.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>nSecs</code></p></td><td><p>The number of seconds as a whole or decimal number. A positive or negative number is valid.</p></td></tr></tbody></table>

### Example

This example shows how `seconds` behaves with different inputs. It adds and subtracts seconds from
DateTime values. It also converts the decimal value `4.555` into the Period format (`PT4.555S`) and
and the whole number `4` into the Period format (`PT4S`)

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Periods
output application/json
---
{
  nextSecond: |2020-10-05T20:22:34.385Z| + seconds(1),
  previousSecond: |2020-10-05T20:22:34.385Z| - seconds(1),
  decimalInputPeriod: seconds(4.555),
  wholeNumberInputPeriod: seconds(4),
  addNegativeValue: seconds(-1) + seconds(2)
}
```

#### Output

```Json
{
  "nextSecond": "2020-10-05T20:22:35.385Z",
  "previousSecond": "2020-10-05T20:22:33.385Z",
  "decimalInputPeriod": "PT4.555S",
  "wholeNumberInputPeriod": "PT4S",
  "addNegativeValue": 1
}
```

<!-- document id=aeb50b6774664faaa5a2d7ba3b2496c73afed81b4aec1092dde0ec3af7cd4a26 url=/mulesoft/current/en-us/dataweave/2.6/dw-periods-functions-seconds.md -->

---
product: DataWeave
version: 2.6
---

# seconds

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## seconds(nSecs: Number): Period

Creates a Period value from the provided number of seconds.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>nSecs</code></p></td><td><p>The number of seconds as a whole or decimal number. A positive or negative number is valid.</p></td></tr></tbody></table>

### Example

This example shows how `seconds` behaves with different inputs. It adds and subtracts seconds from
DateTime values. It also converts the decimal value `4.555` into the Period format (`PT4.555S`) and
and the whole number `4` into the Period format (`PT4S`)

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Periods
output application/json
---
{
  nextSecond: |2020-10-05T20:22:34.385Z| + seconds(1),
  previousSecond: |2020-10-05T20:22:34.385Z| - seconds(1),
  decimalInputPeriod: seconds(4.555),
  wholeNumberInputPeriod: seconds(4),
  addNegativeValue: seconds(-1) + seconds(2)
}
```

#### Output

```Json
{
  "nextSecond": "2020-10-05T20:22:35.385Z",
  "previousSecond": "2020-10-05T20:22:33.385Z",
  "decimalInputPeriod": "PT4.555S",
  "wholeNumberInputPeriod": "PT4S",
  "addNegativeValue": 1
}
```

<!-- document id=63a5ece0c21ca8ef788b4adc6e1f7793ce64cc20b1770deedde39ad15a7b8b9a url=/mulesoft/current/en-us/dataweave/2.9/dw-periods-functions-seconds.md -->

---
product: DataWeave
version: 2.9
---

# seconds

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## seconds(nSecs: Number): Period

Creates a Period value from the provided number of seconds.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>nSecs</code></p></td><td><p>The number of seconds as a whole or decimal number. A positive or negative number is valid.</p></td></tr></tbody></table>

### Example

This example shows how `seconds` behaves with different inputs. It adds and subtracts seconds from
DateTime values. It also converts the decimal value `4.555` into the Period format (`PT4.555S`) and
and the whole number `4` into the Period format (`PT4S`)

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Periods
output application/json
---
{
  nextSecond: |2020-10-05T20:22:34.385Z| + seconds(1),
  previousSecond: |2020-10-05T20:22:34.385Z| - seconds(1),
  decimalInputPeriod: seconds(4.555),
  wholeNumberInputPeriod: seconds(4),
  addNegativeValue: seconds(-1) + seconds(2)
}
```

#### Output

```Json
{
  "nextSecond": "2020-10-05T20:22:35.385Z",
  "previousSecond": "2020-10-05T20:22:33.385Z",
  "decimalInputPeriod": "PT4.555S",
  "wholeNumberInputPeriod": "PT4S",
  "addNegativeValue": 1
}
```

<!-- document id=61baea6d10f0cd0e7d515812194d22b6f0ff2fc5a556178da282f4fe59cbb50e url=/mulesoft/current/en-us/dataweave/latest/dw-periods-functions-seconds.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# seconds

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## seconds(nSecs: Number): Period

Creates a Period value from the provided number of seconds.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>nSecs</code></p></td><td><p>The number of seconds as a whole or decimal number. A positive or negative number is valid.</p></td></tr></tbody></table>

### Example

This example shows how `seconds` behaves with different inputs. It adds and subtracts seconds from
DateTime values. It also converts the decimal value `4.555` into the Period format (`PT4.555S`) and
and the whole number `4` into the Period format (`PT4S`)

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Periods
output application/json
---
{
  nextSecond: |2020-10-05T20:22:34.385Z| + seconds(1),
  previousSecond: |2020-10-05T20:22:34.385Z| - seconds(1),
  decimalInputPeriod: seconds(4.555),
  wholeNumberInputPeriod: seconds(4),
  addNegativeValue: seconds(-1) + seconds(2)
}
```

#### Output

```Json
{
  "nextSecond": "2020-10-05T20:22:35.385Z",
  "previousSecond": "2020-10-05T20:22:33.385Z",
  "decimalInputPeriod": "PT4.555S",
  "wholeNumberInputPeriod": "PT4S",
  "addNegativeValue": 1
}
```

<!-- document id=3559ab57ba909469af70eb7eb729ee8586a669ddf3cc2ed10c595e9af0f1565b url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook-select-xml-elements.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, transform, transformer, format, xml, json, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure
---

# Select XML Elements

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave provides a number of [selectors](https://docs.mulesoft.com/dataweave/2.11/dataweave-selectors) for traversing the structure of
input data and returning matching values. The following examples use a single-value DataWeave
selector (`.`) to extract data from XML elements.

The XML markup language requires a single root element. In the following example, the selector on
the root (`language`) is able to extract the child element because the child has no siblings.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
payload.language
```

Input XML Payload:

```xml
<language>
    <name>DataWeave</name>
</language>
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<name>DataWeave</name>
```

To return all subelements of the root element in a valid XML structure with a single root, the
following script uses a DataWeave key to specify a new element name (`myroot`) and selects the root
(`root`) to return its value. A script that fails to return a single XML root produces the following
error:
`Trying to output non-whitespace characters outside main element tree (in prolog or epilog)…​`.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
{ myroot: payload.root }
```

Input XML Payload:

```xml
<root>
    <element>
        <subelement1>SE1</subelement1>
    </element>
    <element>E2</element>
</root>
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<myroot>
  <element>
    <subelement1>SE1</subelement1>
  </element>
  <element>E2</element>
</myroot>
```

The following example uses the name of the child element (`name`) with the single-value selector to
select its value. Notice how `payload.language.name` navigates to the child element. The script also
provides a root element for the value so that DataWeave can construct valid XML.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
{ newname : payload.language.name }
```

Input XML Payload:

```xml
<language>
    <name>DataWeave</name>
    <version>2.0</version>
</language>
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<newname>DataWeave</newname>
```

The following example uses an index to return the value of the second child element from the input
XML. Notice that DataWeave treats child elements as indices of an array, so it can select the second
child by using the index `language[1]`. The result is a single XML element.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
{ version : payload.language[1] }
```

Input XML Payload:

```xml
<language>
    <name>DataWeave</name>
    <version>2.0</version>
</language>
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<version>2.0</version>
```

If multiple child elements of the input have the same name, use the index to select the value of the
child. The following example selects a subelement of a child element.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
{ mysubelement : payload.root[0].subelement1 }
```

Input XML Payload:

```xml
<root>
    <element>
        <subelement1>SE1</subelement1>
    </element>
    <element>E2</element>
</root>
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<mysubelement>SE1</mysubelement>
```

<!-- document id=9c29c51884553a28670bced541e7439ce15d7266fd86a057baf876b35c11fc57 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook-select-xml-elements.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, transform, transformer, format, xml, json, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure
---

# Select XML Elements

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave provides a number of [selectors](https://docs.mulesoft.com/dataweave/2.12/dataweave-selectors) for traversing the structure of
input data and returning matching values. The following examples use a single-value DataWeave
selector (`.`) to extract data from XML elements.

The XML markup language requires a single root element. In the following example, the selector on
the root (`language`) is able to extract the child element because the child has no siblings.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
payload.language
```

Input XML Payload:

```xml
<language>
    <name>DataWeave</name>
</language>
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<name>DataWeave</name>
```

To return all subelements of the root element in a valid XML structure with a single root, the
following script uses a DataWeave key to specify a new element name (`myroot`) and selects the root
(`root`) to return its value. A script that fails to return a single XML root produces the following
error:
`Trying to output non-whitespace characters outside main element tree (in prolog or epilog)…​`.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
{ myroot: payload.root }
```

Input XML Payload:

```xml
<root>
    <element>
        <subelement1>SE1</subelement1>
    </element>
    <element>E2</element>
</root>
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<myroot>
  <element>
    <subelement1>SE1</subelement1>
  </element>
  <element>E2</element>
</myroot>
```

The following example uses the name of the child element (`name`) with the single-value selector to
select its value. Notice how `payload.language.name` navigates to the child element. The script also
provides a root element for the value so that DataWeave can construct valid XML.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
{ newname : payload.language.name }
```

Input XML Payload:

```xml
<language>
    <name>DataWeave</name>
    <version>2.0</version>
</language>
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<newname>DataWeave</newname>
```

The following example uses an index to return the value of the second child element from the input
XML. Notice that DataWeave treats child elements as indices of an array, so it can select the second
child by using the index `language[1]`. The result is a single XML element.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
{ version : payload.language[1] }
```

Input XML Payload:

```xml
<language>
    <name>DataWeave</name>
    <version>2.0</version>
</language>
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<version>2.0</version>
```

If multiple child elements of the input have the same name, use the index to select the value of the
child. The following example selects a subelement of a child element.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
{ mysubelement : payload.root[0].subelement1 }
```

Input XML Payload:

```xml
<root>
    <element>
        <subelement1>SE1</subelement1>
    </element>
    <element>E2</element>
</root>
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<mysubelement>SE1</mysubelement>
```

<!-- document id=85a23d39600707ab21f61a779aa492a92cbced8b0b56e64edb094927a64a66dd url=/mulesoft/current/en-us/dataweave/2.3/dataweave-cookbook-select-xml-elements.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, transform, transformer, format, xml, json, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure
---

# Select XML Elements

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave provides a number of [selectors](https://docs.mulesoft.com/dataweave/2.3/dataweave-selectors) for traversing the structure of
input data and returning matching values. The following examples use a single-value DataWeave
selector (`.`) to extract data from XML elements.

The XML markup language requires a single root element. In the following example, the selector on
the root (`language`) is able to extract the child element because the child has no siblings.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
payload.language
```

Input XML Payload:

```json
<language>
    <name>DataWeave</name>
</language>
```

Output XML:

```json
<?xml version='1.0' encoding='UTF-8'?>
<name>DataWeave</name>
```

To return all subelements of the root element in a valid XML structure with a single root, the
following script uses a DataWeave key to specify a new element name (`myroot`) and selects the root
(`root`) to return its value. A script that fails to return a single XML root produces the following
error:
`Trying to output non-whitespace characters outside main element tree (in prolog or epilog)…​`.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
{ myroot: payload.root }
```

Input XML Payload:

```json
<root>
    <element>
        <subelement1>SE1</subelement1>
    </element>
    <element>E2</element>
</root>
```

Output XML:

```json
<?xml version='1.0' encoding='UTF-8'?>
<myroot>
  <element>
    <subelement1>SE1</subelement1>
  </element>
  <element>E2</element>
</myroot>
```

The following example uses the name of the child element (`name`) with the single-value selector to
select its value. Notice how `payload.language.name` navigates to the child element. The script also
provides a root element for the value so that DataWeave can construct valid XML.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
{ newname : payload.language.name }
```

Input XML Payload:

```json
<language>
    <name>DataWeave</name>
    <version>2.0</version>
</language>
```

Output XML:

```json
<?xml version='1.0' encoding='UTF-8'?>
<newname>DataWeave</newname>
```

The following example uses an index to return the value of the second child element from the input
XML. Notice that DataWeave treats child elements as indices of an array, so it can select the second
child by using the index `language[1]`. The result is a single XML element.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
{ version : payload.language[1] }
```

Input XML Payload:

```json
<language>
    <name>DataWeave</name>
    <version>2.0</version>
</language>
```

Output XML:

```json
<?xml version='1.0' encoding='UTF-8'?>
<version>2.0</version>
```

If multiple child elements of the input have the same name, use the index to select the value of the
child. The following example selects a subelement of a child element.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
{ mysubelement : payload.root[0].subelement1 }
```

Input XML Payload:

```json
<root>
    <element>
        <subelement1>SE1</subelement1>
    </element>
    <element>E2</element>
</root>
```

Output XML:

```json
<?xml version='1.0' encoding='UTF-8'?>
<mysubelement>SE1</mysubelement>
```

<!-- document id=236ed66252950a1a8a0570513a61fa349f2312a9de3eebdec7246d13df28cc0e url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook-select-xml-elements.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, transform, transformer, format, xml, json, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure
---

# Select XML Elements

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave provides a number of [selectors](https://docs.mulesoft.com/dataweave/2.4/dataweave-selectors) for traversing the structure of
input data and returning matching values. The following examples use a single-value DataWeave
selector (`.`) to extract data from XML elements.

The XML markup language requires a single root element. In the following example, the selector on
the root (`language`) is able to extract the child element because the child has no siblings.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
payload.language
```

Input XML Payload:

```xml
<language>
    <name>DataWeave</name>
</language>
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<name>DataWeave</name>
```

To return all subelements of the root element in a valid XML structure with a single root, the
following script uses a DataWeave key to specify a new element name (`myroot`) and selects the root
(`root`) to return its value. A script that fails to return a single XML root produces the following
error:
`Trying to output non-whitespace characters outside main element tree (in prolog or epilog)…​`.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
{ myroot: payload.root }
```

Input XML Payload:

```xml
<root>
    <element>
        <subelement1>SE1</subelement1>
    </element>
    <element>E2</element>
</root>
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<myroot>
  <element>
    <subelement1>SE1</subelement1>
  </element>
  <element>E2</element>
</myroot>
```

The following example uses the name of the child element (`name`) with the single-value selector to
select its value. Notice how `payload.language.name` navigates to the child element. The script also
provides a root element for the value so that DataWeave can construct valid XML.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
{ newname : payload.language.name }
```

Input XML Payload:

```xml
<language>
    <name>DataWeave</name>
    <version>2.0</version>
</language>
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<newname>DataWeave</newname>
```

The following example uses an index to return the value of the second child element from the input
XML. Notice that DataWeave treats child elements as indices of an array, so it can select the second
child by using the index `language[1]`. The result is a single XML element.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
{ version : payload.language[1] }
```

Input XML Payload:

```xml
<language>
    <name>DataWeave</name>
    <version>2.0</version>
</language>
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<version>2.0</version>
```

If multiple child elements of the input have the same name, use the index to select the value of the
child. The following example selects a subelement of a child element.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
{ mysubelement : payload.root[0].subelement1 }
```

Input XML Payload:

```xml
<root>
    <element>
        <subelement1>SE1</subelement1>
    </element>
    <element>E2</element>
</root>
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<mysubelement>SE1</mysubelement>
```

<!-- document id=f25a684c65bbbceae2116808aeddd8131b882156a034648c6c4a898b85cfbc62 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook-select-xml-elements.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, transform, transformer, format, xml, json, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure
---

# Select XML Elements

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave provides a number of [selectors](https://docs.mulesoft.com/dataweave/2.6/dataweave-selectors) for traversing the structure of
input data and returning matching values. The following examples use a single-value DataWeave
selector (`.`) to extract data from XML elements.

The XML markup language requires a single root element. In the following example, the selector on
the root (`language`) is able to extract the child element because the child has no siblings.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
payload.language
```

Input XML Payload:

```xml
<language>
    <name>DataWeave</name>
</language>
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<name>DataWeave</name>
```

To return all subelements of the root element in a valid XML structure with a single root, the
following script uses a DataWeave key to specify a new element name (`myroot`) and selects the root
(`root`) to return its value. A script that fails to return a single XML root produces the following
error:
`Trying to output non-whitespace characters outside main element tree (in prolog or epilog)…​`.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
{ myroot: payload.root }
```

Input XML Payload:

```xml
<root>
    <element>
        <subelement1>SE1</subelement1>
    </element>
    <element>E2</element>
</root>
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<myroot>
  <element>
    <subelement1>SE1</subelement1>
  </element>
  <element>E2</element>
</myroot>
```

The following example uses the name of the child element (`name`) with the single-value selector to
select its value. Notice how `payload.language.name` navigates to the child element. The script also
provides a root element for the value so that DataWeave can construct valid XML.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
{ newname : payload.language.name }
```

Input XML Payload:

```xml
<language>
    <name>DataWeave</name>
    <version>2.0</version>
</language>
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<newname>DataWeave</newname>
```

The following example uses an index to return the value of the second child element from the input
XML. Notice that DataWeave treats child elements as indices of an array, so it can select the second
child by using the index `language[1]`. The result is a single XML element.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
{ version : payload.language[1] }
```

Input XML Payload:

```xml
<language>
    <name>DataWeave</name>
    <version>2.0</version>
</language>
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<version>2.0</version>
```

If multiple child elements of the input have the same name, use the index to select the value of the
child. The following example selects a subelement of a child element.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
{ mysubelement : payload.root[0].subelement1 }
```

Input XML Payload:

```xml
<root>
    <element>
        <subelement1>SE1</subelement1>
    </element>
    <element>E2</element>
</root>
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<mysubelement>SE1</mysubelement>
```

<!-- document id=aa9e863fb542175edb7f7d87578295c7d27abb1107f97210fdc6f9da769f0473 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook-select-xml-elements.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, transform, transformer, format, xml, json, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure
---

# Select XML Elements

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave provides a number of [selectors](https://docs.mulesoft.com/dataweave/2.9/dataweave-selectors) for traversing the structure of
input data and returning matching values. The following examples use a single-value DataWeave
selector (`.`) to extract data from XML elements.

The XML markup language requires a single root element. In the following example, the selector on
the root (`language`) is able to extract the child element because the child has no siblings.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
payload.language
```

Input XML Payload:

```xml
<language>
    <name>DataWeave</name>
</language>
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<name>DataWeave</name>
```

To return all subelements of the root element in a valid XML structure with a single root, the
following script uses a DataWeave key to specify a new element name (`myroot`) and selects the root
(`root`) to return its value. A script that fails to return a single XML root produces the following
error:
`Trying to output non-whitespace characters outside main element tree (in prolog or epilog)…​`.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
{ myroot: payload.root }
```

Input XML Payload:

```xml
<root>
    <element>
        <subelement1>SE1</subelement1>
    </element>
    <element>E2</element>
</root>
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<myroot>
  <element>
    <subelement1>SE1</subelement1>
  </element>
  <element>E2</element>
</myroot>
```

The following example uses the name of the child element (`name`) with the single-value selector to
select its value. Notice how `payload.language.name` navigates to the child element. The script also
provides a root element for the value so that DataWeave can construct valid XML.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
{ newname : payload.language.name }
```

Input XML Payload:

```xml
<language>
    <name>DataWeave</name>
    <version>2.0</version>
</language>
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<newname>DataWeave</newname>
```

The following example uses an index to return the value of the second child element from the input
XML. Notice that DataWeave treats child elements as indices of an array, so it can select the second
child by using the index `language[1]`. The result is a single XML element.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
{ version : payload.language[1] }
```

Input XML Payload:

```xml
<language>
    <name>DataWeave</name>
    <version>2.0</version>
</language>
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<version>2.0</version>
```

If multiple child elements of the input have the same name, use the index to select the value of the
child. The following example selects a subelement of a child element.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
{ mysubelement : payload.root[0].subelement1 }
```

Input XML Payload:

```xml
<root>
    <element>
        <subelement1>SE1</subelement1>
    </element>
    <element>E2</element>
</root>
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<mysubelement>SE1</mysubelement>
```

<!-- document id=b07cdac24635a89fa50fb95aa962925be69fe3fb4a1c0e470a406bb62b962ba2 url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook-select-xml-elements.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, transform, transformer, format, xml, json, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure
---

# Select XML Elements

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave provides a number of [selectors](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors) for traversing the structure of
input data and returning matching values. The following examples use a single-value DataWeave
selector (`.`) to extract data from XML elements.

The XML markup language requires a single root element. In the following example, the selector on
the root (`language`) is able to extract the child element because the child has no siblings.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
payload.language
```

Input XML Payload:

```xml
<language>
    <name>DataWeave</name>
</language>
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<name>DataWeave</name>
```

To return all subelements of the root element in a valid XML structure with a single root, the
following script uses a DataWeave key to specify a new element name (`myroot`) and selects the root
(`root`) to return its value. A script that fails to return a single XML root produces the following
error:
`Trying to output non-whitespace characters outside main element tree (in prolog or epilog)…​`.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
{ myroot: payload.root }
```

Input XML Payload:

```xml
<root>
    <element>
        <subelement1>SE1</subelement1>
    </element>
    <element>E2</element>
</root>
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<myroot>
  <element>
    <subelement1>SE1</subelement1>
  </element>
  <element>E2</element>
</myroot>
```

The following example uses the name of the child element (`name`) with the single-value selector to
select its value. Notice how `payload.language.name` navigates to the child element. The script also
provides a root element for the value so that DataWeave can construct valid XML.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
{ newname : payload.language.name }
```

Input XML Payload:

```xml
<language>
    <name>DataWeave</name>
    <version>2.0</version>
</language>
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<newname>DataWeave</newname>
```

The following example uses an index to return the value of the second child element from the input
XML. Notice that DataWeave treats child elements as indices of an array, so it can select the second
child by using the index `language[1]`. The result is a single XML element.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
{ version : payload.language[1] }
```

Input XML Payload:

```xml
<language>
    <name>DataWeave</name>
    <version>2.0</version>
</language>
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<version>2.0</version>
```

If multiple child elements of the input have the same name, use the index to select the value of the
child. The following example selects a subelement of a child element.

DataWeave Script:

```dataweave
%dw 2.0
output application/xml
---
{ mysubelement : payload.root[0].subelement1 }
```

Input XML Payload:

```xml
<root>
    <element>
        <subelement1>SE1</subelement1>
    </element>
    <element>E2</element>
</root>
```

Output XML:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<mysubelement>SE1</mysubelement>
```

<!-- document id=670d6685447aac5ed7b4ee22df743f64f8ee5c28168a0652b01df26ea3fe53a2 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-selecting-types.md -->

---
product: DataWeave
version: 2.11
---

# Selecting Types

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Using the dot selector (`.`) over DataWeave [types](https://docs.mulesoft.com/dataweave/2.11/dataweave-type-system#composite-types) enables
you to declare new types from existing ones. Combined with the
[module loader](https://docs.mulesoft.com/dataweave/2.11/dataweave-type-system#reuse_types), DataWeave can also load and translate
declarations from a custom module file into DataWeave type directives that can be accessed in the
same way as types from any other DataWeave module.

## Declare a New Type from an Existing Type

The following example declares the `NameType` from the `User` type. Using the dot selector in
`User.name` to declare the `name` variable as `NameType` enables the `typeOf()` function to return
the primitive type, `"String"`. The DataWeave variable `name` is declared as a `NameType` value
"Seba":

DataWeave script:

```dataweave
%dw 2.0
type User = {name: String}
type NameType = User.name
var name: NameType = "Seba"
---
typeOf(name)
```

Output:

"String"

## Compose a Type from an Existing Type’s Field

The following example uses the dot selector (`.`) to declare a new type `Address` from one key in
the complex type `User`:

DataWeave script:

```dataweave
%dw 2.0
output application/json
type User = {
 address : {country: String, city: String, street: String, number: Number},
 userName : String
}
type Address = User.address

var userAddress: Address = {country: "Argentina", city: "Rosario", street: "Calle Falsa", number: 123}
---
userAddress
```

Output:

```json
{
  "country": "Argentina",
  "city": "Rosario",
  "street": "Calle Falsa",
  "number": 123
}
```

## Select Types from Union Types

The following example shows how you can use type selection with `Union` types that consist of
`Object` types:

DataWeave script:

```dataweave
%dw 2.0
output application/json
type ID = {id: String, firstName: String, age: Number} | {id: Number, firstName: String, secondName: String}

var nameAge: ID = {firstName: "Seba", id: "123", age: 28}
var fullName: ID = {id: 38123, firstName: "Seba", secondName: "Elizalde"}

var nameString: ID.firstName = "Seba"
var idNumber: ID.id = 38123
---
[nameAge, fullName, nameString ++ " is of type " ++ typeOf(nameString), idNumber ++ " is of type " ++ typeOf(idNumber)]
```

Output:

```json
[
  {
    "firstName": "Seba",
    "id": "123",
    "age": 28
  },
  {
    "id": 38123,
    "firstName": "Seba",
    "secondName": "Elizalde"
  },
  "Seba is of type String",
  "38123 is of type Number"
]
```

The following script fails because the second type is not an `Object` type and there is no way to
reference it with the selector:

DataWeave script:

```dataweave
%dw 2.0
output application/json
type UnionType = {name: String} | Number
type Fail = UnionType.name
---
{}
```

Output:

```json
Cannot do selection on Type: Number

4| type Fail = UnionType.name
```

## Select Types from Namespaces

The following example shows type selection of a namespace:

DataWeave script:

```dataweave
%dw 2.0
output application/json
ns ns1 http://acme.com
type User = {
 ns1#name : String,
 name : Number,
}
var nameString: User.ns1#name = "Seba"
var nameNumber: User.name = 123
---
{
   "NameString" : typeOf(nameString),
   "NameNumber" : typeOf(nameNumber)
}
```

Output:

```json
{
  "NameString": "String",
  "NameNumber": "Number"
}
```

## Select Types with Type Parameters

This example shows how type selection works with type parameters, which are similar to generics in
other programming languages:

DataWeave script:

```dataweave
%dw 2.0
output application/json
type WithParameters<A, B> = {first: A, second: B, nestedObject: {message: A}}
---
{
 a: true is WithParameters<Boolean, Number>.first,
 b: 4592 is WithParameters<String, Number>.second,
 c: "sdf" is WithParameters<String, Number>.nestedObject.message,
}
```

Output:

```json
{
  "a": true,
  "b": true,
  "c": true
}
```

## Preserve Metadata of a Type

This example shows that type selection preserves metadata associated with the type:

DataWeave script:

```dataweave
%dw 2.0
output application/json
type User = {
 birthDate: Date {format: "dd-MMM-yy"},
 userName : String {schema: "value"}
}
type FormattedDate = User.birthDate
type UserName = User.userName
var formattedDate: FormattedDate = "10-SEP-15" as Date {format: "dd-MMM-yy"}
var otherFormatDate = "23-10-2022" as Date {format: "dd-MM-yyyy"}
var userName = "Messi" as String {schema: "value"}
var otherUserName = "Di María" as String {schema: "otherValue"}
---
{
formattedDate: formattedDate is FormattedDate,
userName: userName is UserName,
otherFormatDate: otherFormatDate is FormattedDate,
otherUserName: otherUserName is UserName
}
```

Output:

```json
{
  "formattedDate": true,
  "userName": true,
  "otherFormatDate": false,
  "otherUserName": false
}
```

<!-- document id=d34d96810c868bbf6851c3aab474b77e7ae88934c7c766afb00bae7c81126737 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-selecting-types.md -->

---
product: DataWeave
version: 2.12
---

# Selecting Types

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Using the dot selector (`.`) over DataWeave [types](https://docs.mulesoft.com/dataweave/2.12/dataweave-type-system#composite-types) enables
you to declare new types from existing ones. Combined with the
[module loader](https://docs.mulesoft.com/dataweave/2.12/dataweave-type-system#reuse_types), DataWeave can also load and translate
declarations from a custom module file into DataWeave type directives that can be accessed in the
same way as types from any other DataWeave module.

## Declare a New Type from an Existing Type

The following example declares the `NameType` from the `User` type. Using the dot selector in
`User.name` to declare the `name` variable as `NameType` enables the `typeOf()` function to return
the primitive type, `"String"`. The DataWeave variable `name` is declared as a `NameType` value
"Seba":

DataWeave script:

```dataweave
%dw 2.0
type User = {name: String}
type NameType = User.name
var name: NameType = "Seba"
---
typeOf(name)
```

Output:

"String"

## Compose a Type from an Existing Type’s Field

The following example uses the dot selector (`.`) to declare a new type `Address` from one key in
the complex type `User`:

DataWeave script:

```dataweave
%dw 2.0
output application/json
type User = {
 address : {country: String, city: String, street: String, number: Number},
 userName : String
}
type Address = User.address

var userAddress: Address = {country: "Argentina", city: "Rosario", street: "Calle Falsa", number: 123}
---
userAddress
```

Output:

```json
{
  "country": "Argentina",
  "city": "Rosario",
  "street": "Calle Falsa",
  "number": 123
}
```

## Select Types from Union Types

The following example shows how you can use type selection with `Union` types that consist of
`Object` types:

DataWeave script:

```dataweave
%dw 2.0
output application/json
type ID = {id: String, firstName: String, age: Number} | {id: Number, firstName: String, secondName: String}

var nameAge: ID = {firstName: "Seba", id: "123", age: 28}
var fullName: ID = {id: 38123, firstName: "Seba", secondName: "Elizalde"}

var nameString: ID.firstName = "Seba"
var idNumber: ID.id = 38123
---
[nameAge, fullName, nameString ++ " is of type " ++ typeOf(nameString), idNumber ++ " is of type " ++ typeOf(idNumber)]
```

Output:

```json
[
  {
    "firstName": "Seba",
    "id": "123",
    "age": 28
  },
  {
    "id": 38123,
    "firstName": "Seba",
    "secondName": "Elizalde"
  },
  "Seba is of type String",
  "38123 is of type Number"
]
```

The following script fails because the second type is not an `Object` type and there is no way to
reference it with the selector:

DataWeave script:

```dataweave
%dw 2.0
output application/json
type UnionType = {name: String} | Number
type Fail = UnionType.name
---
{}
```

Output:

```json
Cannot do selection on Type: Number

4| type Fail = UnionType.name
```

## Select Types from Namespaces

The following example shows type selection of a namespace:

DataWeave script:

```dataweave
%dw 2.0
output application/json
ns ns1 http://acme.com
type User = {
 ns1#name : String,
 name : Number,
}
var nameString: User.ns1#name = "Seba"
var nameNumber: User.name = 123
---
{
   "NameString" : typeOf(nameString),
   "NameNumber" : typeOf(nameNumber)
}
```

Output:

```json
{
  "NameString": "String",
  "NameNumber": "Number"
}
```

## Select Types with Type Parameters

This example shows how type selection works with type parameters, which are similar to generics in
other programming languages:

DataWeave script:

```dataweave
%dw 2.0
output application/json
type WithParameters<A, B> = {first: A, second: B, nestedObject: {message: A}}
---
{
 a: true is WithParameters<Boolean, Number>.first,
 b: 4592 is WithParameters<String, Number>.second,
 c: "sdf" is WithParameters<String, Number>.nestedObject.message,
}
```

Output:

```json
{
  "a": true,
  "b": true,
  "c": true
}
```

## Preserve Metadata of a Type

This example shows that type selection preserves metadata associated with the type:

DataWeave script:

```dataweave
%dw 2.0
output application/json
type User = {
 birthDate: Date {format: "dd-MMM-yy"},
 userName : String {schema: "value"}
}
type FormattedDate = User.birthDate
type UserName = User.userName
var formattedDate: FormattedDate = "10-SEP-15" as Date {format: "dd-MMM-yy"}
var otherFormatDate = "23-10-2022" as Date {format: "dd-MM-yyyy"}
var userName = "Messi" as String {schema: "value"}
var otherUserName = "Di María" as String {schema: "otherValue"}
---
{
formattedDate: formattedDate is FormattedDate,
userName: userName is UserName,
otherFormatDate: otherFormatDate is FormattedDate,
otherUserName: otherUserName is UserName
}
```

Output:

```json
{
  "formattedDate": true,
  "userName": true,
  "otherFormatDate": false,
  "otherUserName": false
}
```

<!-- document id=9c8ef6fa24b1ecba8ef6eda9d416de0cfe3663e50160b8d6877a9b7bea9f3b93 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-selecting-types.md -->

---
product: DataWeave
version: 2.6
---

# Selecting Types

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Using the dot selector (`.`) over DataWeave [types](https://docs.mulesoft.com/dataweave/2.6/dataweave-type-system#composite-types) enables
you to declare new types from existing ones. Combined with the
[module loader](https://docs.mulesoft.com/dataweave/2.6/dataweave-type-system#reuse_types), DataWeave can also load and translate
declarations from a custom module file into DataWeave type directives that can be accessed in the
same way as types from any other DataWeave module.

## Declare a New Type from an Existing Type

The following example declares the `NameType` from the `User` type. Using the dot selector in
`User.name` to declare the `name` variable as `NameType` enables the `typeOf()` function to return
the primitive type, `"String"`. The DataWeave variable `name` is declared as a `NameType` value
"Seba":

DataWeave script:

```dataweave
%dw 2.0
type User = {name: String}
type NameType = User.name
var name: NameType = "Seba"
---
typeOf(name)
```

Output:

"String"

## Compose a Type from an Existing Type’s Field

The following example uses the dot selector (`.`) to declare a new type `Address` from one key in
the complex type `User`:

DataWeave script:

```dataweave
%dw 2.0
output application/json
type User = {
 address : {country: String, city: String, street: String, number: Number},
 userName : String
}
type Address = User.address

var userAddress: Address = {country: "Argentina", city: "Rosario", street: "Calle Falsa", number: 123}
---
userAddress
```

Output:

```json
{
  "country": "Argentina",
  "city": "Rosario",
  "street": "Calle Falsa",
  "number": 123
}
```

## Select Types from Union Types

The following example shows how you can use type selection with `Union` types that consist of
`Object` types:

DataWeave script:

```dataweave
%dw 2.0
output application/json
type ID = {id: String, firstName: String, age: Number} | {id: Number, firstName: String, secondName: String}

var nameAge: ID = {firstName: "Seba", id: "123", age: 28}
var fullName: ID = {id: 38123, firstName: "Seba", secondName: "Elizalde"}

var nameString: ID.firstName = "Seba"
var idNumber: ID.id = 38123
---
[nameAge, fullName, nameString ++ " is of type " ++ typeOf(nameString), idNumber ++ " is of type " ++ typeOf(idNumber)]
```

Output:

```json
[
  {
    "firstName": "Seba",
    "id": "123",
    "age": 28
  },
  {
    "id": 38123,
    "firstName": "Seba",
    "secondName": "Elizalde"
  },
  "Seba is of type String",
  "38123 is of type Number"
]
```

The following script fails because the second type is not an `Object` type and there is no way to
reference it with the selector:

DataWeave script:

```dataweave
%dw 2.0
output application/json
type UnionType = {name: String} | Number
type Fail = UnionType.name
---
{}
```

Output:

```json
Cannot do selection on Type: Number

4| type Fail = UnionType.name
```

## Select Types from Namespaces

The following example shows type selection of a namespace:

DataWeave script:

```dataweave
%dw 2.0
output application/json
ns ns1 http://acme.com
type User = {
 ns1#name : String,
 name : Number,
}
var nameString: User.ns1#name = "Seba"
var nameNumber: User.name = 123
---
{
   "NameString" : typeOf(nameString),
   "NameNumber" : typeOf(nameNumber)
}
```

Output:

```json
{
  "NameString": "String",
  "NameNumber": "Number"
}
```

## Select Types with Type Parameters

This example shows how type selection works with type parameters, which are similar to generics in
other programming languages:

DataWeave script:

```dataweave
%dw 2.0
output application/json
type WithParameters<A, B> = {first: A, second: B, nestedObject: {message: A}}
---
{
 a: true is WithParameters<Boolean, Number>.first,
 b: 4592 is WithParameters<String, Number>.second,
 c: "sdf" is WithParameters<String, Number>.nestedObject.message,
}
```

Output:

```json
{
  "a": true,
  "b": true,
  "c": true
}
```

## Preserve Metadata of a Type

This example shows that type selection preserves metadata associated with the type:

DataWeave script:

```dataweave
%dw 2.0
output application/json
type User = {
 birthDate: Date {format: "dd-MMM-yy"},
 userName : String {schema: "value"}
}
type FormattedDate = User.birthDate
type UserName = User.userName
var formattedDate: FormattedDate = "10-SEP-15" as Date {format: "dd-MMM-yy"}
var otherFormatDate = "23-10-2022" as Date {format: "dd-MM-yyyy"}
var userName = "Messi" as String {schema: "value"}
var otherUserName = "Di María" as String {schema: "otherValue"}
---
{
formattedDate: formattedDate is FormattedDate,
userName: userName is UserName,
otherFormatDate: otherFormatDate is FormattedDate,
otherUserName: otherUserName is UserName
}
```

Output:

```json
{
  "formattedDate": true,
  "userName": true,
  "otherFormatDate": false,
  "otherUserName": false
}
```

<!-- document id=8a0dbb25f0ba1528b41dc165fad51eeea54ed7d5560848fcbce683ec6c17f45e url=/mulesoft/current/en-us/dataweave/2.9/dataweave-selecting-types.md -->

---
product: DataWeave
version: 2.9
---

# Selecting Types

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Using the dot selector (`.`) over DataWeave [types](https://docs.mulesoft.com/dataweave/2.9/dataweave-type-system#composite-types) enables
you to declare new types from existing ones. Combined with the
[module loader](https://docs.mulesoft.com/dataweave/2.9/dataweave-type-system#reuse_types), DataWeave can also load and translate
declarations from a custom module file into DataWeave type directives that can be accessed in the
same way as types from any other DataWeave module.

## Declare a New Type from an Existing Type

The following example declares the `NameType` from the `User` type. Using the dot selector in
`User.name` to declare the `name` variable as `NameType` enables the `typeOf()` function to return
the primitive type, `"String"`. The DataWeave variable `name` is declared as a `NameType` value
"Seba":

DataWeave script:

```dataweave
%dw 2.0
type User = {name: String}
type NameType = User.name
var name: NameType = "Seba"
---
typeOf(name)
```

Output:

"String"

## Compose a Type from an Existing Type’s Field

The following example uses the dot selector (`.`) to declare a new type `Address` from one key in
the complex type `User`:

DataWeave script:

```dataweave
%dw 2.0
output application/json
type User = {
 address : {country: String, city: String, street: String, number: Number},
 userName : String
}
type Address = User.address

var userAddress: Address = {country: "Argentina", city: "Rosario", street: "Calle Falsa", number: 123}
---
userAddress
```

Output:

```json
{
  "country": "Argentina",
  "city": "Rosario",
  "street": "Calle Falsa",
  "number": 123
}
```

## Select Types from Union Types

The following example shows how you can use type selection with `Union` types that consist of
`Object` types:

DataWeave script:

```dataweave
%dw 2.0
output application/json
type ID = {id: String, firstName: String, age: Number} | {id: Number, firstName: String, secondName: String}

var nameAge: ID = {firstName: "Seba", id: "123", age: 28}
var fullName: ID = {id: 38123, firstName: "Seba", secondName: "Elizalde"}

var nameString: ID.firstName = "Seba"
var idNumber: ID.id = 38123
---
[nameAge, fullName, nameString ++ " is of type " ++ typeOf(nameString), idNumber ++ " is of type " ++ typeOf(idNumber)]
```

Output:

```json
[
  {
    "firstName": "Seba",
    "id": "123",
    "age": 28
  },
  {
    "id": 38123,
    "firstName": "Seba",
    "secondName": "Elizalde"
  },
  "Seba is of type String",
  "38123 is of type Number"
]
```

The following script fails because the second type is not an `Object` type and there is no way to
reference it with the selector:

DataWeave script:

```dataweave
%dw 2.0
output application/json
type UnionType = {name: String} | Number
type Fail = UnionType.name
---
{}
```

Output:

```json
Cannot do selection on Type: Number

4| type Fail = UnionType.name
```

## Select Types from Namespaces

The following example shows type selection of a namespace:

DataWeave script:

```dataweave
%dw 2.0
output application/json
ns ns1 http://acme.com
type User = {
 ns1#name : String,
 name : Number,
}
var nameString: User.ns1#name = "Seba"
var nameNumber: User.name = 123
---
{
   "NameString" : typeOf(nameString),
   "NameNumber" : typeOf(nameNumber)
}
```

Output:

```json
{
  "NameString": "String",
  "NameNumber": "Number"
}
```

## Select Types with Type Parameters

This example shows how type selection works with type parameters, which are similar to generics in
other programming languages:

DataWeave script:

```dataweave
%dw 2.0
output application/json
type WithParameters<A, B> = {first: A, second: B, nestedObject: {message: A}}
---
{
 a: true is WithParameters<Boolean, Number>.first,
 b: 4592 is WithParameters<String, Number>.second,
 c: "sdf" is WithParameters<String, Number>.nestedObject.message,
}
```

Output:

```json
{
  "a": true,
  "b": true,
  "c": true
}
```

## Preserve Metadata of a Type

This example shows that type selection preserves metadata associated with the type:

DataWeave script:

```dataweave
%dw 2.0
output application/json
type User = {
 birthDate: Date {format: "dd-MMM-yy"},
 userName : String {schema: "value"}
}
type FormattedDate = User.birthDate
type UserName = User.userName
var formattedDate: FormattedDate = "10-SEP-15" as Date {format: "dd-MMM-yy"}
var otherFormatDate = "23-10-2022" as Date {format: "dd-MM-yyyy"}
var userName = "Messi" as String {schema: "value"}
var otherUserName = "Di María" as String {schema: "otherValue"}
---
{
formattedDate: formattedDate is FormattedDate,
userName: userName is UserName,
otherFormatDate: otherFormatDate is FormattedDate,
otherUserName: otherUserName is UserName
}
```

Output:

```json
{
  "formattedDate": true,
  "userName": true,
  "otherFormatDate": false,
  "otherUserName": false
}
```

<!-- document id=f712b39cc59731ef6caa0ca6e11e6f6085d3a0d707fcec5e6faefee83fdefaf7 url=/mulesoft/current/en-us/dataweave/latest/dataweave-selecting-types.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Selecting Types

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Using the dot selector (`.`) over DataWeave [types](https://docs.mulesoft.com/dataweave/latest/dataweave-type-system#composite-types) enables
you to declare new types from existing ones. Combined with the
[module loader](https://docs.mulesoft.com/dataweave/latest/dataweave-type-system#reuse_types), DataWeave can also load and translate
declarations from a custom module file into DataWeave type directives that can be accessed in the
same way as types from any other DataWeave module.

## Declare a New Type from an Existing Type

The following example declares the `NameType` from the `User` type. Using the dot selector in
`User.name` to declare the `name` variable as `NameType` enables the `typeOf()` function to return
the primitive type, `"String"`. The DataWeave variable `name` is declared as a `NameType` value
"Seba":

DataWeave script:

```dataweave
%dw 2.0
type User = {name: String}
type NameType = User.name
var name: NameType = "Seba"
---
typeOf(name)
```

Output:

"String"

## Compose a Type from an Existing Type’s Field

The following example uses the dot selector (`.`) to declare a new type `Address` from one key in
the complex type `User`:

DataWeave script:

```dataweave
%dw 2.0
output application/json
type User = {
 address : {country: String, city: String, street: String, number: Number},
 userName : String
}
type Address = User.address

var userAddress: Address = {country: "Argentina", city: "Rosario", street: "Calle Falsa", number: 123}
---
userAddress
```

Output:

```json
{
  "country": "Argentina",
  "city": "Rosario",
  "street": "Calle Falsa",
  "number": 123
}
```

## Select Types from Union Types

The following example shows how you can use type selection with `Union` types that consist of
`Object` types:

DataWeave script:

```dataweave
%dw 2.0
output application/json
type ID = {id: String, firstName: String, age: Number} | {id: Number, firstName: String, secondName: String}

var nameAge: ID = {firstName: "Seba", id: "123", age: 28}
var fullName: ID = {id: 38123, firstName: "Seba", secondName: "Elizalde"}

var nameString: ID.firstName = "Seba"
var idNumber: ID.id = 38123
---
[nameAge, fullName, nameString ++ " is of type " ++ typeOf(nameString), idNumber ++ " is of type " ++ typeOf(idNumber)]
```

Output:

```json
[
  {
    "firstName": "Seba",
    "id": "123",
    "age": 28
  },
  {
    "id": 38123,
    "firstName": "Seba",
    "secondName": "Elizalde"
  },
  "Seba is of type String",
  "38123 is of type Number"
]
```

The following script fails because the second type is not an `Object` type and there is no way to
reference it with the selector:

DataWeave script:

```dataweave
%dw 2.0
output application/json
type UnionType = {name: String} | Number
type Fail = UnionType.name
---
{}
```

Output:

```json
Cannot do selection on Type: Number

4| type Fail = UnionType.name
```

## Select Types from Namespaces

The following example shows type selection of a namespace:

DataWeave script:

```dataweave
%dw 2.0
output application/json
ns ns1 http://acme.com
type User = {
 ns1#name : String,
 name : Number,
}
var nameString: User.ns1#name = "Seba"
var nameNumber: User.name = 123
---
{
   "NameString" : typeOf(nameString),
   "NameNumber" : typeOf(nameNumber)
}
```

Output:

```json
{
  "NameString": "String",
  "NameNumber": "Number"
}
```

## Select Types with Type Parameters

This example shows how type selection works with type parameters, which are similar to generics in
other programming languages:

DataWeave script:

```dataweave
%dw 2.0
output application/json
type WithParameters<A, B> = {first: A, second: B, nestedObject: {message: A}}
---
{
 a: true is WithParameters<Boolean, Number>.first,
 b: 4592 is WithParameters<String, Number>.second,
 c: "sdf" is WithParameters<String, Number>.nestedObject.message,
}
```

Output:

```json
{
  "a": true,
  "b": true,
  "c": true
}
```

## Preserve Metadata of a Type

This example shows that type selection preserves metadata associated with the type:

DataWeave script:

```dataweave
%dw 2.0
output application/json
type User = {
 birthDate: Date {format: "dd-MMM-yy"},
 userName : String {schema: "value"}
}
type FormattedDate = User.birthDate
type UserName = User.userName
var formattedDate: FormattedDate = "10-SEP-15" as Date {format: "dd-MMM-yy"}
var otherFormatDate = "23-10-2022" as Date {format: "dd-MM-yyyy"}
var userName = "Messi" as String {schema: "value"}
var otherUserName = "Di María" as String {schema: "otherValue"}
---
{
formattedDate: formattedDate is FormattedDate,
userName: userName is UserName,
otherFormatDate: otherFormatDate is FormattedDate,
otherUserName: otherUserName is UserName
}
```

Output:

```json
{
  "formattedDate": true,
  "userName": true,
  "otherFormatDate": false,
  "otherUserName": false
}
```

<!-- document id=3931df307e749bd9c69e5e4885a54573a98605ce069bbc99d1e5ff598cc6f454 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook-defaults.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, examples
---

# Set Default Values with DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Use one of the following methods to set default values when a payload value is absent or when the
value is `null`:

- Using the `default` keyword

- Setting the default in an `if-else` or `else-if` statement

- Using `else` when pattern matching

## Example of Using the Keyword default to Set a Default Value

Consider an application that expects a JSON input with fields `id` and `name` to do a
transformation. You can configure default values for these fields in case the fields are not
present, or their value is `null`. For example:

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
  "userId": payload.id default "0000",
  "userName": payload.name default "Undefined"
}
```

If the application receives a JSON message with values set for the `id` and `name` fields, then the
DataWeave transformation matches field `id` to `userId` and field `name` to `userName`.

Input JSON Payload:

```json
{
  "id": "123",
  "name": "Max the Mule"
}
```

Output JSON:

```json
{
  "userId": "123",
  "userName": "Max the Mule"
}
```

However, if the application receives a JSON message without the expected fields, or the fields have
`null` values, then the transformation uses the configured default values for fields `userId` and
`userName`.

Input JSON Payload:

```json
{
  "id": null
}
```

Output JSON:

```json
{
  "userId": "0000",
  "userName": "Undefined"
}
```

## Example of Using if-else and else-if Statements to Set Default Values

Another method for providing a default value is using
[if-else](https://docs.mulesoft.com/dataweave/2.11/dataweave-flow-control#control_flow_if_else) and
[else-if](https://docs.mulesoft.com/dataweave/2.11/dataweave-flow-control#control_flow_else_if).

The following example sets `United States` as the default value for `userLocation` if it is not
present, or its value is `null`, in the JSON input message:

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
if (payload.location != null) {
	"userLocation" : payload.location
} else {
	"userLocation" : "United States"
}
```

If the application receives a JSON message with a value set for the `location` field, then the
DataWeave transformation matches field `location` to `userLocation`.

Input JSON Payload:

```json
{
  "location": "Argentina"
}
```

Output JSON:

```json
{
  "userLocation": "Argentina"
}
```

However, if the application receives a JSON message without the expected field, or the field is
`null`, then the transformation uses the configured default value for field `userLocation`.

Input JSON Payload:

```json
{}
```

Output JSON:

```json
{
  "userLocation": "United States"
}
```

## Example of Using Matching Patterns to Set Default Values

In [pattern-matching scripts](https://docs.mulesoft.com/dataweave/2.11/dataweave-pattern-matching), DataWeave `case` statements end with an
`else` expression that can serve as the default to return if all preceding `case` expressions return
`false`.

DataWeave Script:

```dataweave
%dw 2.0
var myVar = "someString"
output application/json
---
myVar match {
    case myVarOne if (myVar == "some") -> ("some" ++ "is myVar")
    case myVarOne if (myVar == "strings") -> ("strings" ++ "is myVar")
    else -> myVar ++ " is myVar"
}
```

Output JSON:

```json
"someString is myVar"
```

<!-- document id=c75238957481f28813c8a71d10e792921c3a1df16d631db561abe255846dbd3c url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook-defaults.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, examples
---

# Set Default Values with DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Use one of the following methods to set default values when a payload value is absent or when the
value is `null`:

- Using the `default` keyword

- Setting the default in an `if-else` or `else-if` statement

- Using `else` when pattern matching

## Example of Using the Keyword default to Set a Default Value

Consider an application that expects a JSON input with fields `id` and `name` to do a
transformation. You can configure default values for these fields in case the fields are not
present, or their value is `null`. For example:

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
  "userId": payload.id default "0000",
  "userName": payload.name default "Undefined"
}
```

If the application receives a JSON message with values set for the `id` and `name` fields, then the
DataWeave transformation matches field `id` to `userId` and field `name` to `userName`.

Input JSON Payload:

```json
{
  "id": "123",
  "name": "Max the Mule"
}
```

Output JSON:

```json
{
  "userId": "123",
  "userName": "Max the Mule"
}
```

However, if the application receives a JSON message without the expected fields, or the fields have
`null` values, then the transformation uses the configured default values for fields `userId` and
`userName`.

Input JSON Payload:

```json
{
  "id": null
}
```

Output JSON:

```json
{
  "userId": "0000",
  "userName": "Undefined"
}
```

## Example of Using if-else and else-if Statements to Set Default Values

Another method for providing a default value is using
[if-else](https://docs.mulesoft.com/dataweave/2.12/dataweave-flow-control#control_flow_if_else) and
[else-if](https://docs.mulesoft.com/dataweave/2.12/dataweave-flow-control#control_flow_else_if).

The following example sets `United States` as the default value for `userLocation` if it is not
present, or its value is `null`, in the JSON input message:

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
if (payload.location != null) {
	"userLocation" : payload.location
} else {
	"userLocation" : "United States"
}
```

If the application receives a JSON message with a value set for the `location` field, then the
DataWeave transformation matches field `location` to `userLocation`.

Input JSON Payload:

```json
{
  "location": "Argentina"
}
```

Output JSON:

```json
{
  "userLocation": "Argentina"
}
```

However, if the application receives a JSON message without the expected field, or the field is
`null`, then the transformation uses the configured default value for field `userLocation`.

Input JSON Payload:

```json
{}
```

Output JSON:

```json
{
  "userLocation": "United States"
}
```

## Example of Using Matching Patterns to Set Default Values

In [pattern-matching scripts](https://docs.mulesoft.com/dataweave/2.12/dataweave-pattern-matching), DataWeave `case` statements end with an
`else` expression that can serve as the default to return if all preceding `case` expressions return
`false`.

DataWeave Script:

```dataweave
%dw 2.0
var myVar = "someString"
output application/json
---
myVar match {
    case myVarOne if (myVar == "some") -> ("some" ++ "is myVar")
    case myVarOne if (myVar == "strings") -> ("strings" ++ "is myVar")
    else -> myVar ++ " is myVar"
}
```

Output JSON:

```json
"someString is myVar"
```

<!-- document id=683fa7fda3d7afb3acdfada427fa669d72173f8a806b3544308efbac438bd044 url=/mulesoft/current/en-us/dataweave/2.3/dataweave-cookbook-defaults.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, examples
---

# Set Default Values with DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Use one of the following methods to set default values when a payload value is absent or when the
value is `null`:

- Using the `default` keyword

- Setting the default in an `if-else` or `else-if` statement

- Using `else` when pattern matching

## Example of Using the Keyword default to Set a Default Value

Consider a Mule application that expects a JSON input with fields `id` and `name` to do a
transformation. You can configure default values for these fields in case the fields are not
present, or their value is `null`. For example:

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
  "userId": payload.id default "0000",
  "userName": payload.name default "Undefined"
}
```

If the Mule application receives a JSON message with values set for the `id` and `name` fields, then
the DataWeave transformation matches field `id` to `userId` and field `name` to `userName`.

Input JSON Payload:

```json
{
  "id": "123",
  "name": "Max the Mule"
}
```

Output JSON:

```json
{
  "userId": "123",
  "userName": "Max the Mule"
}
```

However, if the Mule application receives a JSON message without the expected fields, or the fields
have `null` values, then the transformation uses the configured default values for fields `userId`
and `userName`.

Input JSON Payload:

```json
{
  "id": null
}
```

Output JSON:

```json
{
  "userId": "0000",
  "userName": "Undefined"
}
```

## Example of Using if-else and else-if Statements to Set Default Values

Another method for providing a default value is using
[if-else](https://docs.mulesoft.com/dataweave/2.3/dataweave-flow-control#control_flow_if_else) and
[else-if](https://docs.mulesoft.com/dataweave/2.3/dataweave-flow-control#control_flow_else_if).

The following example sets `United States` as the default value for `userLocation` if it is not
present, or its value is `null`, in the JSON input message:

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
if (payload.location != null) {
	"userLocation" : payload.location
} else {
	"userLocation" : "United States"
}
```

If the Mule application receives a JSON message with a value set for the `location` field, then the
DataWeave transformation matches field `location` to `userLocation`.

Input JSON Payload:

```json
{
  "location": "Argentina"
}
```

Output JSON:

```json
{
  "userLocation": "Argentina"
}
```

However, if the Mule application receives a JSON message without the expected field, or the field is
`null`, then the transformation uses the configured default value for field `userLocation`.

Input JSON Payload:

```json
{}
```

Output JSON:

```json
{
  "userLocation": "United States"
}
```

## Example of Using Matching Patterns to Set Default Values

In [pattern-matching scripts](https://docs.mulesoft.com/dataweave/2.3/dataweave-pattern-matching), DataWeave `case` statements end with an
`else` expression that can serve as the default to return if all preceding `case` expressions return
`false`.

DataWeave Script:

```dataweave
%dw 2.0
var myVar = "someString"
output application/json
---
myVar match {
    case myVarOne if (myVar == "some") -> ("some" ++ "is myVar")
    case myVarOne if (myVar == "strings") -> ("strings" ++ "is myVar")
    else -> myVar ++ " is myVar"
}
```

Output JSON:

```json
"someString is myVar"
```

<!-- document id=8fa438eacefdc428f162e1776cb809e7a4de9e12b5bb879262afffb121b70e39 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook-defaults.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, examples
---

# Set Default Values with DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Use one of the following methods to set default values when a payload value is absent or when the
value is `null`:

- Using the `default` keyword

- Setting the default in an `if-else` or `else-if` statement

- Using `else` when pattern matching

## Example of Using the Keyword default to Set a Default Value

Consider an application that expects a JSON input with fields `id` and `name` to do a
transformation. You can configure default values for these fields in case the fields are not
present, or their value is `null`. For example:

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
  "userId": payload.id default "0000",
  "userName": payload.name default "Undefined"
}
```

If the application receives a JSON message with values set for the `id` and `name` fields, then the
DataWeave transformation matches field `id` to `userId` and field `name` to `userName`.

Input JSON Payload:

```json
{
  "id": "123",
  "name": "Max the Mule"
}
```

Output JSON:

```json
{
  "userId": "123",
  "userName": "Max the Mule"
}
```

However, if the application receives a JSON message without the expected fields, or the fields have
`null` values, then the transformation uses the configured default values for fields `userId` and
`userName`.

Input JSON Payload:

```json
{
  "id": null
}
```

Output JSON:

```json
{
  "userId": "0000",
  "userName": "Undefined"
}
```

## Example of Using if-else and else-if Statements to Set Default Values

Another method for providing a default value is using
[if-else](https://docs.mulesoft.com/dataweave/2.4/dataweave-flow-control#control_flow_if_else) and
[else-if](https://docs.mulesoft.com/dataweave/2.4/dataweave-flow-control#control_flow_else_if).

The following example sets `United States` as the default value for `userLocation` if it is not
present, or its value is `null`, in the JSON input message:

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
if (payload.location != null) {
	"userLocation" : payload.location
} else {
	"userLocation" : "United States"
}
```

If the application receives a JSON message with a value set for the `location` field, then the
DataWeave transformation matches field `location` to `userLocation`.

Input JSON Payload:

```json
{
  "location": "Argentina"
}
```

Output JSON:

```json
{
  "userLocation": "Argentina"
}
```

However, if the application receives a JSON message without the expected field, or the field is
`null`, then the transformation uses the configured default value for field `userLocation`.

Input JSON Payload:

```json
{}
```

Output JSON:

```json
{
  "userLocation": "United States"
}
```

## Example of Using Matching Patterns to Set Default Values

In [pattern-matching scripts](https://docs.mulesoft.com/dataweave/2.4/dataweave-pattern-matching), DataWeave `case` statements end with an
`else` expression that can serve as the default to return if all preceding `case` expressions return
`false`.

DataWeave Script:

```dataweave
%dw 2.0
var myVar = "someString"
output application/json
---
myVar match {
    case myVarOne if (myVar == "some") -> ("some" ++ "is myVar")
    case myVarOne if (myVar == "strings") -> ("strings" ++ "is myVar")
    else -> myVar ++ " is myVar"
}
```

Output JSON:

```json
"someString is myVar"
```

<!-- document id=37405de475e86138dacaa919e2a5fe5500debb8643c21659efb3842aead99cb3 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook-defaults.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, examples
---

# Set Default Values with DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Use one of the following methods to set default values when a payload value is absent or when the
value is `null`:

- Using the `default` keyword

- Setting the default in an `if-else` or `else-if` statement

- Using `else` when pattern matching

## Example of Using the Keyword default to Set a Default Value

Consider an application that expects a JSON input with fields `id` and `name` to do a
transformation. You can configure default values for these fields in case the fields are not
present, or their value is `null`. For example:

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
  "userId": payload.id default "0000",
  "userName": payload.name default "Undefined"
}
```

If the application receives a JSON message with values set for the `id` and `name` fields, then the
DataWeave transformation matches field `id` to `userId` and field `name` to `userName`.

Input JSON Payload:

```json
{
  "id": "123",
  "name": "Max the Mule"
}
```

Output JSON:

```json
{
  "userId": "123",
  "userName": "Max the Mule"
}
```

However, if the application receives a JSON message without the expected fields, or the fields have
`null` values, then the transformation uses the configured default values for fields `userId` and
`userName`.

Input JSON Payload:

```json
{
  "id": null
}
```

Output JSON:

```json
{
  "userId": "0000",
  "userName": "Undefined"
}
```

## Example of Using if-else and else-if Statements to Set Default Values

Another method for providing a default value is using
[if-else](https://docs.mulesoft.com/dataweave/2.6/dataweave-flow-control#control_flow_if_else) and
[else-if](https://docs.mulesoft.com/dataweave/2.6/dataweave-flow-control#control_flow_else_if).

The following example sets `United States` as the default value for `userLocation` if it is not
present, or its value is `null`, in the JSON input message:

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
if (payload.location != null) {
	"userLocation" : payload.location
} else {
	"userLocation" : "United States"
}
```

If the application receives a JSON message with a value set for the `location` field, then the
DataWeave transformation matches field `location` to `userLocation`.

Input JSON Payload:

```json
{
  "location": "Argentina"
}
```

Output JSON:

```json
{
  "userLocation": "Argentina"
}
```

However, if the application receives a JSON message without the expected field, or the field is
`null`, then the transformation uses the configured default value for field `userLocation`.

Input JSON Payload:

```json
{}
```

Output JSON:

```json
{
  "userLocation": "United States"
}
```

## Example of Using Matching Patterns to Set Default Values

In [pattern-matching scripts](https://docs.mulesoft.com/dataweave/2.6/dataweave-pattern-matching), DataWeave `case` statements end with an
`else` expression that can serve as the default to return if all preceding `case` expressions return
`false`.

DataWeave Script:

```dataweave
%dw 2.0
var myVar = "someString"
output application/json
---
myVar match {
    case myVarOne if (myVar == "some") -> ("some" ++ "is myVar")
    case myVarOne if (myVar == "strings") -> ("strings" ++ "is myVar")
    else -> myVar ++ " is myVar"
}
```

Output JSON:

```json
"someString is myVar"
```

<!-- document id=7c8463a7be76ecda1cb3fedcd74023fd7c412a960c117a4ad8a5c40b66223681 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook-defaults.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, examples
---

# Set Default Values with DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Use one of the following methods to set default values when a payload value is absent or when the
value is `null`:

- Using the `default` keyword

- Setting the default in an `if-else` or `else-if` statement

- Using `else` when pattern matching

## Example of Using the Keyword default to Set a Default Value

Consider an application that expects a JSON input with fields `id` and `name` to do a
transformation. You can configure default values for these fields in case the fields are not
present, or their value is `null`. For example:

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
  "userId": payload.id default "0000",
  "userName": payload.name default "Undefined"
}
```

If the application receives a JSON message with values set for the `id` and `name` fields, then the
DataWeave transformation matches field `id` to `userId` and field `name` to `userName`.

Input JSON Payload:

```json
{
  "id": "123",
  "name": "Max the Mule"
}
```

Output JSON:

```json
{
  "userId": "123",
  "userName": "Max the Mule"
}
```

However, if the application receives a JSON message without the expected fields, or the fields have
`null` values, then the transformation uses the configured default values for fields `userId` and
`userName`.

Input JSON Payload:

```json
{
  "id": null
}
```

Output JSON:

```json
{
  "userId": "0000",
  "userName": "Undefined"
}
```

## Example of Using if-else and else-if Statements to Set Default Values

Another method for providing a default value is using
[if-else](https://docs.mulesoft.com/dataweave/2.9/dataweave-flow-control#control_flow_if_else) and
[else-if](https://docs.mulesoft.com/dataweave/2.9/dataweave-flow-control#control_flow_else_if).

The following example sets `United States` as the default value for `userLocation` if it is not
present, or its value is `null`, in the JSON input message:

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
if (payload.location != null) {
	"userLocation" : payload.location
} else {
	"userLocation" : "United States"
}
```

If the application receives a JSON message with a value set for the `location` field, then the
DataWeave transformation matches field `location` to `userLocation`.

Input JSON Payload:

```json
{
  "location": "Argentina"
}
```

Output JSON:

```json
{
  "userLocation": "Argentina"
}
```

However, if the application receives a JSON message without the expected field, or the field is
`null`, then the transformation uses the configured default value for field `userLocation`.

Input JSON Payload:

```json
{}
```

Output JSON:

```json
{
  "userLocation": "United States"
}
```

## Example of Using Matching Patterns to Set Default Values

In [pattern-matching scripts](https://docs.mulesoft.com/dataweave/2.9/dataweave-pattern-matching), DataWeave `case` statements end with an
`else` expression that can serve as the default to return if all preceding `case` expressions return
`false`.

DataWeave Script:

```dataweave
%dw 2.0
var myVar = "someString"
output application/json
---
myVar match {
    case myVarOne if (myVar == "some") -> ("some" ++ "is myVar")
    case myVarOne if (myVar == "strings") -> ("strings" ++ "is myVar")
    else -> myVar ++ " is myVar"
}
```

Output JSON:

```json
"someString is myVar"
```

<!-- document id=44c555c1ccd7d095e77a29c16a57ad74aaf8c13beea94712fd72e93ab6762bc1 url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook-defaults.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, examples
---

# Set Default Values with DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Use one of the following methods to set default values when a payload value is absent or when the
value is `null`:

- Using the `default` keyword

- Setting the default in an `if-else` or `else-if` statement

- Using `else` when pattern matching

## Example of Using the Keyword default to Set a Default Value

Consider an application that expects a JSON input with fields `id` and `name` to do a
transformation. You can configure default values for these fields in case the fields are not
present, or their value is `null`. For example:

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
  "userId": payload.id default "0000",
  "userName": payload.name default "Undefined"
}
```

If the application receives a JSON message with values set for the `id` and `name` fields, then the
DataWeave transformation matches field `id` to `userId` and field `name` to `userName`.

Input JSON Payload:

```json
{
  "id": "123",
  "name": "Max the Mule"
}
```

Output JSON:

```json
{
  "userId": "123",
  "userName": "Max the Mule"
}
```

However, if the application receives a JSON message without the expected fields, or the fields have
`null` values, then the transformation uses the configured default values for fields `userId` and
`userName`.

Input JSON Payload:

```json
{
  "id": null
}
```

Output JSON:

```json
{
  "userId": "0000",
  "userName": "Undefined"
}
```

## Example of Using if-else and else-if Statements to Set Default Values

Another method for providing a default value is using
[if-else](https://docs.mulesoft.com/dataweave/latest/dataweave-flow-control#control_flow_if_else) and
[else-if](https://docs.mulesoft.com/dataweave/latest/dataweave-flow-control#control_flow_else_if).

The following example sets `United States` as the default value for `userLocation` if it is not
present, or its value is `null`, in the JSON input message:

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
if (payload.location != null) {
	"userLocation" : payload.location
} else {
	"userLocation" : "United States"
}
```

If the application receives a JSON message with a value set for the `location` field, then the
DataWeave transformation matches field `location` to `userLocation`.

Input JSON Payload:

```json
{
  "location": "Argentina"
}
```

Output JSON:

```json
{
  "userLocation": "Argentina"
}
```

However, if the application receives a JSON message without the expected field, or the field is
`null`, then the transformation uses the configured default value for field `userLocation`.

Input JSON Payload:

```json
{}
```

Output JSON:

```json
{
  "userLocation": "United States"
}
```

## Example of Using Matching Patterns to Set Default Values

In [pattern-matching scripts](https://docs.mulesoft.com/dataweave/latest/dataweave-pattern-matching), DataWeave `case` statements end with an
`else` expression that can serve as the default to return if all preceding `case` expressions return
`false`.

DataWeave Script:

```dataweave
%dw 2.0
var myVar = "someString"
output application/json
---
myVar match {
    case myVarOne if (myVar == "some") -> ("some" ++ "is myVar")
    case myVarOne if (myVar == "strings") -> ("strings" ++ "is myVar")
    else -> myVar ++ " is myVar"
}
```

Output JSON:

```json
"someString is myVar"
```

<!-- document id=b942dbee1091529f40eca6e987226d8cd9739a3102929bad520d48fe22defd3b url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook-set-reader-writer-props.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, transform, transformer, format, dataweave, data weave, output structure, mime type, mime
---

# Set Reader and Writer Configuration Properties

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave provides configuration properties for data formats, such as JSON (`application/json`), XML
(`application/xml`), and (`application/csv`). The properties change the behavior of DataWeave
readers and writers for those formats. For example, the default separator for a CSV reader is a
comma (`,`). You can use the format’s `separator` property to specify a different separator for CSV
content.

Refer to [DataWeave Formats](https://docs.mulesoft.com/dataweave/2.11/dataweave-formats) for more details on available reader and writer
properties for various data formats.

## Use a Writer Property in an Output Directive

The following example shows how to append writer properties to the DataWeave `output` directive. The
script uses `indent = false` to compress the JSON output into a single line.

DataWeave Script:

```dataweave
%dw 2.0
output application/json indent = false
---
{
	hello : "world",
	bello : "world",
	mello : "world"
}
```

Output JSON:

```json
{ "hello": "world", "bello": "world", "mello": "world" }
```

The following examples also append writer configuration properties to the `output` directive:

- [Avro example](https://docs.mulesoft.com/dataweave/2.11/dataweave-formats-avro#examples) that uses `schemaUrl`

- [Excel (XLSX) example](https://docs.mulesoft.com/dataweave/2.11/dataweave-formats-excel#example2) that uses `header=true`

- [Flat File](https://docs.mulesoft.com/dataweave/2.11/dataweave-formats-flatfile#examples) example that sets a `schemaPath`

- [XML](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-remove-certain-xml-attributes) example that uses `inlineCloseOn="empty"`
  to close any empty XML elements

## Use Reader and Writer Properties in DataWeave Functions

The DataWeave `read`, `readUrl`, and `write` functions accept one or more comma-separated property
configurations within curly braces.

In the header of the following script, the value of `myVar` is a `read` function that inputs an XML
sample with an empty child element (`<ex1></ex1>`). The function passes an XML reader property
`{nullValueOn: "empty"}` that converts the value of the empty element to `null`.

In the body of the script, a `write` function accepts the value of `myVar` as input. The function
passes the JSON writer properties `{skipNullOn:"objects", writeAttributes:true}` to skip the object
with the `null` value (`<ex1>null</ex1>`) and to write the attribute and value of
`<ex3 a='greeting'>hello</ex3>`.

DataWeave Script:

```dataweave
%dw 2.0
var myVar = read("<greeting><ex1></ex1><ex2>hello</ex2><ex3 a='greeting'>hello</ex3></greeting>", "application/xml", {nullValueOn: "empty"})
output application/json with binary
---
write(myVar.greeting, "application/json", {skipNullOn:"objects", writeAttributes:true})
```

Output JSON:

```json
{
  "ex2": "hello",
  "ex3": {
    "@a": "greeting",
    "__text": "hello"
  }
}
```

The following examples pass reader properties to `readUrl`:

- [XML example](https://docs.mulesoft.com/dataweave/2.11/dataweave-formats-xml#example1)

- [ndjson example](https://docs.mulesoft.com/dataweave/2.11/dataweave-formats-ndjson#example2)

## See Also

- [DataWeave Formats](https://docs.mulesoft.com/dataweave/2.11/dataweave-formats)

- [Core Components](https://docs.mulesoft.com/mule-runtime/latest/about-components)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook)

<!-- document id=cde421508a6d4681d5fd9b349b7d21c66efd91189477e1e1e3898c7ea4966c9e url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook-set-reader-writer-props.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, transform, transformer, format, dataweave, data weave, output structure, mime type, mime
---

# Set Reader and Writer Configuration Properties

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave provides configuration properties for data formats, such as JSON (`application/json`), XML
(`application/xml`), and (`application/csv`). The properties change the behavior of DataWeave
readers and writers for those formats. For example, the default separator for a CSV reader is a
comma (`,`). You can use the format’s `separator` property to specify a different separator for CSV
content.

Refer to [DataWeave Formats](https://docs.mulesoft.com/dataweave/2.12/dataweave-formats) for more details on available reader and writer
properties for various data formats.

## Use a Writer Property in an Output Directive

The following example shows how to append writer properties to the DataWeave `output` directive. The
script uses `indent = false` to compress the JSON output into a single line.

DataWeave Script:

```dataweave
%dw 2.0
output application/json indent = false
---
{
	hello : "world",
	bello : "world",
	mello : "world"
}
```

Output JSON:

```json
{ "hello": "world", "bello": "world", "mello": "world" }
```

The following examples also append writer configuration properties to the `output` directive:

- [Avro example](https://docs.mulesoft.com/dataweave/2.12/dataweave-formats-avro#examples) that uses `schemaUrl`

- [Excel (XLSX) example](https://docs.mulesoft.com/dataweave/2.12/dataweave-formats-excel#example2) that uses `header=true`

- [Flat File](https://docs.mulesoft.com/dataweave/2.12/dataweave-formats-flatfile#examples) example that sets a `schemaPath`

- [XML](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-remove-certain-xml-attributes) example that uses `inlineCloseOn="empty"`
  to close any empty XML elements

## Use Reader and Writer Properties in DataWeave Functions

The DataWeave `read`, `readUrl`, and `write` functions accept one or more comma-separated property
configurations within curly braces.

In the header of the following script, the value of `myVar` is a `read` function that inputs an XML
sample with an empty child element (`<ex1></ex1>`). The function passes an XML reader property
`{nullValueOn: "empty"}` that converts the value of the empty element to `null`.

In the body of the script, a `write` function accepts the value of `myVar` as input. The function
passes the JSON writer properties `{skipNullOn:"objects", writeAttributes:true}` to skip the object
with the `null` value (`<ex1>null</ex1>`) and to write the attribute and value of
`<ex3 a='greeting'>hello</ex3>`.

DataWeave Script:

```dataweave
%dw 2.0
var myVar = read("<greeting><ex1></ex1><ex2>hello</ex2><ex3 a='greeting'>hello</ex3></greeting>", "application/xml", {nullValueOn: "empty"})
output application/json with binary
---
write(myVar.greeting, "application/json", {skipNullOn:"objects", writeAttributes:true})
```

Output JSON:

```json
{
  "ex2": "hello",
  "ex3": {
    "@a": "greeting",
    "__text": "hello"
  }
}
```

The following examples pass reader properties to `readUrl`:

- [XML example](https://docs.mulesoft.com/dataweave/2.12/dataweave-formats-xml#example1)

- [ndjson example](https://docs.mulesoft.com/dataweave/2.12/dataweave-formats-ndjson#example2)

## See Also

- [DataWeave Formats](https://docs.mulesoft.com/dataweave/2.12/dataweave-formats)

- [Core Components](https://docs.mulesoft.com/mule-runtime/latest/about-components)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook)

<!-- document id=8ce5a1ae68f5cc9bd6b89d03af657f5d227ad28d868ba4cc25028786fa00e888 url=/mulesoft/current/en-us/dataweave/2.3/dataweave-cookbook-set-reader-writer-props.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, transform, transformer, format, dataweave, data weave, output structure, mime type, mime
---

# Set Reader and Writer Configuration Properties

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave provides configuration properties for data formats, such as JSON (`application/json`), XML
(`application/xml`), and (`application/csv`). The properties change the behavior of DataWeave
readers and writers for those formats. For example, the default separator for a CSV reader is a
comma (`,`). You can use the format’s `separator` property to specify a different separator for CSV
content.

## Use a Writer Property in an Output Directive

The following example shows how to append writer properties to the DataWeave `output` directive. The
script uses `indent = false` to compress the JSON output into a single line.

DataWeave Script:

```dataweave
%dw 2.0
output application/json indent = false
---
{
	hello : "world",
	bello : "world",
	mello : "world"
}
```

Output JSON:

```json
{ "hello": "world", "bello": "world", "mello": "world" }
```

The following examples also append writer configuration properties to the `output` directive:

- [Avro example](https://docs.mulesoft.com/dataweave/2.3/dataweave-formats-avro#examples) that uses `schemaUrl`

- [Excel (XLSX) example](https://docs.mulesoft.com/dataweave/2.3/dataweave-formats-excel#example2) that uses `header=true`

- [Flat File](https://docs.mulesoft.com/dataweave/2.3/dataweave-formats-flatfile#examples) example that sets a `schemaPath`

- [XML](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-remove-certain-xml-attributes) example that uses `inlineCloseOn="empty"`
  to close any empty XML elements

## Use Reader and Writer Properties in DataWeave Functions

The DataWeave `read`, `readUrl`, and `write` functions accept one or more comma-separated property
configurations within curly braces.

In the header of the following script, the value of `myVar` is a `read` function that inputs an XML
sample with an empty child element (`<ex1></ex1>`). The function passes an XML reader property
`{nullValueOn: "empty"}` that converts the value of the empty element to `null`.

In the body of the script, a `write` function accepts the value of `myVar` as input. The function
passes the JSON writer properties `{skipNullOn:"objects", writeAttributes:true}` to skip the object
with the `null` value (`<ex1>null</ex1>`) and to write the attribute and value of
`<ex3 a='greeting'>hello</ex3>`.

DataWeave Script:

```dataweave
%dw 2.0
var myVar = read("<greeting><ex1></ex1><ex2>hello</ex2><ex3 a='greeting'>hello</ex3></greeting>", "application/xml", {nullValueOn: "empty"})
output application/json with binary
---
write(myVar.greeting, "application/json", {skipNullOn:"objects", writeAttributes:true})
```

Output JSON:

```json
{
  "ex2": "hello",
  "ex3": {
    "@a": "greeting",
    "__text": "hello"
  }
}
```

The following examples pass reader properties to `readUrl`:

- [XML example](https://docs.mulesoft.com/dataweave/2.3/dataweave-formats-xml#example1)

- [ndjson example](https://docs.mulesoft.com/dataweave/2.3/dataweave-formats-ndjson#example2)

## Use a Reader Property through a Connector Operation

Connector operations that read input data provide an `outpuMimeType` field that you can use to
identify the _input_ MIME type. This field also accepts one or more reader properties, which is
useful for helping DataWeave read the input correctly.

By default, the DataWeave reader treats a comma (`,`) as a separator. However, assume that a CSV
input is separated by the pipe (`|`) but that the content also contains commas. You can set a CSV
reader property to recognize the pipe as the separator.

Pipe-separated CSV Input

```csv
id | name | role
1234 | Shokida,Mr. | dev
2345 | Achaval,Mr. | arch
3456 | Felisatti,Ms. | mngr
4567 | Chibana,Mr. | dev
```

The following example uses the Read operation in the File connector to read the pipe-separated (`|`)
CSV input, and it uses a DataWeave script in the Transform Message component to output a row of the
input in comma-separated format.

Mule Flow:

```xml
<flow name="ex-use-csv-reader-props" >
	<scheduler doc:name="Scheduler" >
		<scheduling-strategy >
			<fixed-frequency frequency="90" timeUnit="SECONDS"/>
		</scheduling-strategy>
	</scheduler>
	<file:read doc:name="Read" config-ref="File_Config" path="staff.csv"
	           outputMimeType='application/csv; separator=|; header=true'/>
	<ee:transform doc:name="Transform Message" >
		<ee:message>
			<ee:set-payload><![CDATA[%dw 2.0
output application/csv header = false
---
payload[1]]]></ee:set-payload>
		</ee:message>
	</ee:transform>
	<logger level="INFO" doc:name="Logger" message="#[payload]"/>
</flow>
```

The Scheduler component (`<scheduler/>`) in the example generates a Mule event each time it triggers
the flow.

The Read operation (`<file:read/>`) uses
`outputMimeType='application/csv; separator=|; header=true'` to identify the input MIME type
(`application/csv`), the CSV separator (`|`), and the header setting (`true`).

The script in the Transform Message component (`<ee:transform-message/>`) returns the second row
from the input CSV (`2345 , Achaval\,Mr. , arch`). The script uses `payload[1]` to select that row
because DataWeave treats each row in the CSV as an index of an array. The output is comma-separated
because the default CSV separator is a comma. The script omits the CSV header from the output by
using the `output` directive (`output application/csv header = false`).

The Logger component (`<logger/>`), which is set to `payload`, writes the comma-separated output as
INFO in its `LoggerMessageProcessor` message: `2345 , Achaval\,Mr. , arch`. To avoid treating the
comma before "Mr." as a separator, the CSV output escapes the comma with a backslash
(`Achaval\,Mr.`).

The following examples pass reader properties through the `outputMimeType` field:

- [CSV example](https://docs.mulesoft.com/dataweave/2.3/dataweave-formats-csv#example2) that uses `streaming=true; header=true`

- [JSON example](https://docs.mulesoft.com/dataweave/2.3/dataweave-formats-json#example3) that uses `streaming=true`

## Use a Mule Variable as a Configuration Value

The following Mule flow transforms comma-separated CSV data into pipe-separated (`|`) CSV data.
Instead of setting a literal value in the script, the example selects the pipe value from a
[Mule variable](https://docs.mulesoft.com/mule-runtime/4.3/about-mule-variables), which is part of a Mule event that
travels through data-processing components in the flow.

The Scheduler component (`<scheduler/>`) in the example generates a Mule event each time it triggers
the flow.

The Set Variable component (`<set-variable/>`) creates a Mule variable named `delimiter` with the
value `'|'`. In Studio, the value is created as an **fx** expression (`value="#['|']"`), rather than
a simple string (`value="'|'"`).

The Transform Message component (`<ee:transform-message/>`) contains a DataWeave script that reads
comma-separated CSV input and uses the Mule variable to write pipe-separated CSV output.

The Logger component (`<logger/>`), which is set to `payload`, writes the pipe-separated output as
INFO in its `LoggerMessageProcessor` message: `macaroni | rigatoni | ravioli | spaghetti`.

Mule Flow:

```xml
<flow name="ex-use-mule-var-as-prop-config-val" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="45" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <set-variable value="#['|']" doc:name="Set Variable" variableName="delimiter" />
  <ee:transform doc:name="Transform Message" >
    <ee:message>
      <ee:set-payload><![CDATA[%dw 2.0
var myVar = read("macaroni , rigatoni , ravioli , spaghetti", "application/csv" , {"header":false, separator:','})
output application/csv with binary
---
write(myVar, "application/csv", {"header":false, "separator":vars.delimiter})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
  <logger level="INFO" doc:name="Logger" message="#[payload]"/>
</flow>
```

To provide comma-separated input for the example, the script in the Transform Message component uses
a [read](https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-read) function as a value to a DataWeave variable, `myVar`:

`var myVar = read("macaroni , rigatoni , ravioli , spaghetti", "application/csv" , {"header":false, separator:','})`

To write pipe-separated output, the DataWeave [write](https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-write) function in the body
of the script changes the comma-separated input to pipe-separated output. To select the pipe value
from the Mule variable (`delimiter`), the function passes the writer property configuration
`"separator":vars.delimiter` as an argument:

`write(myVar, "application/csv", {"header":false, "separator":vars.delimiter})`

The script uses the following DataWeave `output` directive in the script’s header: \`output
applicatio:page-aliases:

Note that if you want to see pipe-separated content from the Tranform Message component’s
**Preview** screen in the Studio UI, you must create sample data for it:

1.  Double-click the Transform Message component from the **Message Flow** area of the Studio app.

2.  Right-click **delimiter: _String_** in the **Context** tab, which is located on the bottom left
    of the configuration UI for the component.

3.  Select **Edit Sample Data** to open a **vars-delimiter** tab.

4.  Replace any content in the **vars-delimiter** with the following sample data for the `delimiter`
    value: `"|"`. You must put the delimiter in quotation marks.

For further guidance with sample data, see
[Previewing the Output of a Transformation](https://docs.mulesoft.com/mule-runtime/4.3/transform-preview-transformation-output-studio-task).

## See Also

- [DataWeave Formats](https://docs.mulesoft.com/dataweave/2.3/dataweave-formats)

- [Core Components](https://docs.mulesoft.com/mule-runtime/4.3/about-components)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook)

<!-- document id=b67acc1b2e84c75fb5a405e6ece823945e6a773ddc579f4195260c52c7b8144e url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook-set-reader-writer-props.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, transform, transformer, format, dataweave, data weave, output structure, mime type, mime
---

# Set Reader and Writer Configuration Properties

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave provides configuration properties for data formats, such as JSON (`application/json`), XML
(`application/xml`), and (`application/csv`). The properties change the behavior of DataWeave
readers and writers for those formats. For example, the default separator for a CSV reader is a
comma (`,`). You can use the format’s `separator` property to specify a different separator for CSV
content.

Refer to [DataWeave Formats](https://docs.mulesoft.com/dataweave/2.4/dataweave-formats) for more details on available reader and writer
properties for various data formats.

## Use a Writer Property in an Output Directive

The following example shows how to append writer properties to the DataWeave `output` directive. The
script uses `indent = false` to compress the JSON output into a single line.

DataWeave Script:

```dataweave
%dw 2.0
output application/json indent = false
---
{
	hello : "world",
	bello : "world",
	mello : "world"
}
```

Output JSON:

```json
{ "hello": "world", "bello": "world", "mello": "world" }
```

The following examples also append writer configuration properties to the `output` directive:

- [Avro example](https://docs.mulesoft.com/dataweave/2.4/dataweave-formats-avro#examples) that uses `schemaUrl`

- [Excel (XLSX) example](https://docs.mulesoft.com/dataweave/2.4/dataweave-formats-excel#example2) that uses `header=true`

- [Flat File](https://docs.mulesoft.com/dataweave/2.4/dataweave-formats-flatfile#examples) example that sets a `schemaPath`

- [XML](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-remove-certain-xml-attributes) example that uses `inlineCloseOn="empty"`
  to close any empty XML elements

## Use Reader and Writer Properties in DataWeave Functions

The DataWeave `read`, `readUrl`, and `write` functions accept one or more comma-separated property
configurations within curly braces.

In the header of the following script, the value of `myVar` is a `read` function that inputs an XML
sample with an empty child element (`<ex1></ex1>`). The function passes an XML reader property
`{nullValueOn: "empty"}` that converts the value of the empty element to `null`.

In the body of the script, a `write` function accepts the value of `myVar` as input. The function
passes the JSON writer properties `{skipNullOn:"objects", writeAttributes:true}` to skip the object
with the `null` value (`<ex1>null</ex1>`) and to write the attribute and value of
`<ex3 a='greeting'>hello</ex3>`.

DataWeave Script:

```dataweave
%dw 2.0
var myVar = read("<greeting><ex1></ex1><ex2>hello</ex2><ex3 a='greeting'>hello</ex3></greeting>", "application/xml", {nullValueOn: "empty"})
output application/json with binary
---
write(myVar.greeting, "application/json", {skipNullOn:"objects", writeAttributes:true})
```

Output JSON:

```json
{
  "ex2": "hello",
  "ex3": {
    "@a": "greeting",
    "__text": "hello"
  }
}
```

The following examples pass reader properties to `readUrl`:

- [XML example](https://docs.mulesoft.com/dataweave/2.4/dataweave-formats-xml#example1)

- [ndjson example](https://docs.mulesoft.com/dataweave/2.4/dataweave-formats-ndjson#example2)

## See Also

- [DataWeave Formats](https://docs.mulesoft.com/dataweave/2.4/dataweave-formats)

- [Core Components](https://docs.mulesoft.com/mule-runtime/latest/about-components)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook)

<!-- document id=942608ba609968f292f9f26280955845f48fa0a707c4348eb4b0f66fe6f84310 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook-set-reader-writer-props.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, transform, transformer, format, dataweave, data weave, output structure, mime type, mime
---

# Set Reader and Writer Configuration Properties

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave provides configuration properties for data formats, such as JSON (`application/json`), XML
(`application/xml`), and (`application/csv`). The properties change the behavior of DataWeave
readers and writers for those formats. For example, the default separator for a CSV reader is a
comma (`,`). You can use the format’s `separator` property to specify a different separator for CSV
content.

Refer to [DataWeave Formats](https://docs.mulesoft.com/dataweave/2.6/dataweave-formats) for more details on available reader and writer
properties for various data formats.

## Use a Writer Property in an Output Directive

The following example shows how to append writer properties to the DataWeave `output` directive. The
script uses `indent = false` to compress the JSON output into a single line.

DataWeave Script:

```dataweave
%dw 2.0
output application/json indent = false
---
{
	hello : "world",
	bello : "world",
	mello : "world"
}
```

Output JSON:

```json
{ "hello": "world", "bello": "world", "mello": "world" }
```

The following examples also append writer configuration properties to the `output` directive:

- [Avro example](https://docs.mulesoft.com/dataweave/2.6/dataweave-formats-avro#examples) that uses `schemaUrl`

- [Excel (XLSX) example](https://docs.mulesoft.com/dataweave/2.6/dataweave-formats-excel#example2) that uses `header=true`

- [Flat File](https://docs.mulesoft.com/dataweave/2.6/dataweave-formats-flatfile#examples) example that sets a `schemaPath`

- [XML](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-remove-certain-xml-attributes) example that uses `inlineCloseOn="empty"`
  to close any empty XML elements

## Use Reader and Writer Properties in DataWeave Functions

The DataWeave `read`, `readUrl`, and `write` functions accept one or more comma-separated property
configurations within curly braces.

In the header of the following script, the value of `myVar` is a `read` function that inputs an XML
sample with an empty child element (`<ex1></ex1>`). The function passes an XML reader property
`{nullValueOn: "empty"}` that converts the value of the empty element to `null`.

In the body of the script, a `write` function accepts the value of `myVar` as input. The function
passes the JSON writer properties `{skipNullOn:"objects", writeAttributes:true}` to skip the object
with the `null` value (`<ex1>null</ex1>`) and to write the attribute and value of
`<ex3 a='greeting'>hello</ex3>`.

DataWeave Script:

```dataweave
%dw 2.0
var myVar = read("<greeting><ex1></ex1><ex2>hello</ex2><ex3 a='greeting'>hello</ex3></greeting>", "application/xml", {nullValueOn: "empty"})
output application/json with binary
---
write(myVar.greeting, "application/json", {skipNullOn:"objects", writeAttributes:true})
```

Output JSON:

```json
{
  "ex2": "hello",
  "ex3": {
    "@a": "greeting",
    "__text": "hello"
  }
}
```

The following examples pass reader properties to `readUrl`:

- [XML example](https://docs.mulesoft.com/dataweave/2.6/dataweave-formats-xml#example1)

- [ndjson example](https://docs.mulesoft.com/dataweave/2.6/dataweave-formats-ndjson#example2)

## See Also

- [DataWeave Formats](https://docs.mulesoft.com/dataweave/2.6/dataweave-formats)

- [Core Components](https://docs.mulesoft.com/mule-runtime/latest/about-components)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook)

<!-- document id=8044234694751c6bfa1d30eb3afe099c00e5d5dbfef825a9d1fc2099447c3063 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook-set-reader-writer-props.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, transform, transformer, format, dataweave, data weave, output structure, mime type, mime
---

# Set Reader and Writer Configuration Properties

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave provides configuration properties for data formats, such as JSON (`application/json`), XML
(`application/xml`), and (`application/csv`). The properties change the behavior of DataWeave
readers and writers for those formats. For example, the default separator for a CSV reader is a
comma (`,`). You can use the format’s `separator` property to specify a different separator for CSV
content.

Refer to [DataWeave Formats](https://docs.mulesoft.com/dataweave/2.9/dataweave-formats) for more details on available reader and writer
properties for various data formats.

## Use a Writer Property in an Output Directive

The following example shows how to append writer properties to the DataWeave `output` directive. The
script uses `indent = false` to compress the JSON output into a single line.

DataWeave Script:

```dataweave
%dw 2.0
output application/json indent = false
---
{
	hello : "world",
	bello : "world",
	mello : "world"
}
```

Output JSON:

```json
{ "hello": "world", "bello": "world", "mello": "world" }
```

The following examples also append writer configuration properties to the `output` directive:

- [Avro example](https://docs.mulesoft.com/dataweave/2.9/dataweave-formats-avro#examples) that uses `schemaUrl`

- [Excel (XLSX) example](https://docs.mulesoft.com/dataweave/2.9/dataweave-formats-excel#example2) that uses `header=true`

- [Flat File](https://docs.mulesoft.com/dataweave/2.9/dataweave-formats-flatfile#examples) example that sets a `schemaPath`

- [XML](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-remove-certain-xml-attributes) example that uses `inlineCloseOn="empty"`
  to close any empty XML elements

## Use Reader and Writer Properties in DataWeave Functions

The DataWeave `read`, `readUrl`, and `write` functions accept one or more comma-separated property
configurations within curly braces.

In the header of the following script, the value of `myVar` is a `read` function that inputs an XML
sample with an empty child element (`<ex1></ex1>`). The function passes an XML reader property
`{nullValueOn: "empty"}` that converts the value of the empty element to `null`.

In the body of the script, a `write` function accepts the value of `myVar` as input. The function
passes the JSON writer properties `{skipNullOn:"objects", writeAttributes:true}` to skip the object
with the `null` value (`<ex1>null</ex1>`) and to write the attribute and value of
`<ex3 a='greeting'>hello</ex3>`.

DataWeave Script:

```dataweave
%dw 2.0
var myVar = read("<greeting><ex1></ex1><ex2>hello</ex2><ex3 a='greeting'>hello</ex3></greeting>", "application/xml", {nullValueOn: "empty"})
output application/json with binary
---
write(myVar.greeting, "application/json", {skipNullOn:"objects", writeAttributes:true})
```

Output JSON:

```json
{
  "ex2": "hello",
  "ex3": {
    "@a": "greeting",
    "__text": "hello"
  }
}
```

The following examples pass reader properties to `readUrl`:

- [XML example](https://docs.mulesoft.com/dataweave/2.9/dataweave-formats-xml#example1)

- [ndjson example](https://docs.mulesoft.com/dataweave/2.9/dataweave-formats-ndjson#example2)

## See Also

- [DataWeave Formats](https://docs.mulesoft.com/dataweave/2.9/dataweave-formats)

- [Core Components](https://docs.mulesoft.com/mule-runtime/latest/about-components)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook)

<!-- document id=cbcacc3fc9a967a9fd537d5d75525e5bb23362078d9477f3ce6802645a64eee2 url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook-set-reader-writer-props.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, transform, transformer, format, dataweave, data weave, output structure, mime type, mime
---

# Set Reader and Writer Configuration Properties

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave provides configuration properties for data formats, such as JSON (`application/json`), XML
(`application/xml`), and (`application/csv`). The properties change the behavior of DataWeave
readers and writers for those formats. For example, the default separator for a CSV reader is a
comma (`,`). You can use the format’s `separator` property to specify a different separator for CSV
content.

Refer to [DataWeave Formats](https://docs.mulesoft.com/dataweave/latest/dataweave-formats) for more details on available reader and writer
properties for various data formats.

## Use a Writer Property in an Output Directive

The following example shows how to append writer properties to the DataWeave `output` directive. The
script uses `indent = false` to compress the JSON output into a single line.

DataWeave Script:

```dataweave
%dw 2.0
output application/json indent = false
---
{
	hello : "world",
	bello : "world",
	mello : "world"
}
```

Output JSON:

```json
{ "hello": "world", "bello": "world", "mello": "world" }
```

The following examples also append writer configuration properties to the `output` directive:

- [Avro example](https://docs.mulesoft.com/dataweave/latest/dataweave-formats-avro#examples) that uses `schemaUrl`

- [Excel (XLSX) example](https://docs.mulesoft.com/dataweave/latest/dataweave-formats-excel#example2) that uses `header=true`

- [Flat File](https://docs.mulesoft.com/dataweave/latest/dataweave-formats-flatfile#examples) example that sets a `schemaPath`

- [XML](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-remove-certain-xml-attributes) example that uses `inlineCloseOn="empty"`
  to close any empty XML elements

## Use Reader and Writer Properties in DataWeave Functions

The DataWeave `read`, `readUrl`, and `write` functions accept one or more comma-separated property
configurations within curly braces.

In the header of the following script, the value of `myVar` is a `read` function that inputs an XML
sample with an empty child element (`<ex1></ex1>`). The function passes an XML reader property
`{nullValueOn: "empty"}` that converts the value of the empty element to `null`.

In the body of the script, a `write` function accepts the value of `myVar` as input. The function
passes the JSON writer properties `{skipNullOn:"objects", writeAttributes:true}` to skip the object
with the `null` value (`<ex1>null</ex1>`) and to write the attribute and value of
`<ex3 a='greeting'>hello</ex3>`.

DataWeave Script:

```dataweave
%dw 2.0
var myVar = read("<greeting><ex1></ex1><ex2>hello</ex2><ex3 a='greeting'>hello</ex3></greeting>", "application/xml", {nullValueOn: "empty"})
output application/json with binary
---
write(myVar.greeting, "application/json", {skipNullOn:"objects", writeAttributes:true})
```

Output JSON:

```json
{
  "ex2": "hello",
  "ex3": {
    "@a": "greeting",
    "__text": "hello"
  }
}
```

The following examples pass reader properties to `readUrl`:

- [XML example](https://docs.mulesoft.com/dataweave/latest/dataweave-formats-xml#example1)

- [ndjson example](https://docs.mulesoft.com/dataweave/latest/dataweave-formats-ndjson#example2)

## See Also

- [DataWeave Formats](https://docs.mulesoft.com/dataweave/latest/dataweave-formats)

- [Core Components](https://docs.mulesoft.com/mule-runtime/latest/about-components)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook)

<!-- document id=b2069697f2bdac31cc7d1a6024b47c7012eba82133c709d0128aead37c4adea6 url=/mulesoft/current/en-us/dataweave/2.11/dw-crypto-functions-sha1.md -->

---
product: DataWeave
version: 2.11
---

# SHA1

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## SHA1(content: Binary): String

Computes the SHA1 hash and transforms the result into a hexadecimal, lowercase string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>A binary input value to encrypt.</p></td></tr></tbody></table>

### Example

This example uses the SHA1 algorithm to encrypt a binary value.

#### Source

```DataWeave
%dw 2.0
import dw::Crypto
output application/json
---
{ "sha1" : Crypto::SHA1("dsasd" as Binary) }
```

#### Output

```JSON
{ "sha1": "2fa183839c954e6366c206367c9be5864e4f4a65" }
```

<!-- document id=004c93c4a5c9b8b5524b1f4450289bc1fd3ca8f5bd5510c92ac22bf67bc600ae url=/mulesoft/current/en-us/dataweave/2.12/dw-crypto-functions-sha1.md -->

---
product: DataWeave
version: 2.12
---

# SHA1

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## SHA1(content: Binary): String

Computes the SHA1 hash and transforms the result into a hexadecimal, lowercase string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>A binary input value to encrypt.</p></td></tr></tbody></table>

### Example

This example uses the SHA1 algorithm to encrypt a binary value.

#### Source

```DataWeave
%dw 2.0
import dw::Crypto
output application/json
---
{ "sha1" : Crypto::SHA1("dsasd" as Binary) }
```

#### Output

```JSON
{ "sha1": "2fa183839c954e6366c206367c9be5864e4f4a65" }
```

<!-- document id=c8a704bf865d517b3cadc3e396d51f33cfcbc9370799fed0a7e1a99eaef7dc93 url=/mulesoft/current/en-us/dataweave/2.3/dw-crypto-functions-sha1.md -->

---
product: DataWeave
version: 2.3
---

# SHA1

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## SHA1(Binary): String

Computes the SHA1 hash and transforms the result into a hexadecimal, lowercase string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>A binary input value to encrypt.</p></td></tr></tbody></table>

### Example

This example uses the SHA1 algorithm to encrypt a binary value.

#### Source

```DataWeave
%dw 2.0
import dw::Crypto
output application/json
---
{ "sha1" : Crypto::SHA1("dsasd" as Binary) }
```

#### Output

```JSON
{ "sha1": "2fa183839c954e6366c206367c9be5864e4f4a65" }
```

<!-- document id=878ff8c770cc5144a19af36d03cb0ab95cf8da6a1e5ce4c339447fcffa31435e url=/mulesoft/current/en-us/dataweave/2.4/dw-crypto-functions-sha1.md -->

---
product: DataWeave
version: 2.4
---

# SHA1

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## SHA1(content: Binary): String

Computes the SHA1 hash and transforms the result into a hexadecimal, lowercase string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>A binary input value to encrypt.</p></td></tr></tbody></table>

### Example

This example uses the SHA1 algorithm to encrypt a binary value.

#### Source

```DataWeave
%dw 2.0
import dw::Crypto
output application/json
---
{ "sha1" : Crypto::SHA1("dsasd" as Binary) }
```

#### Output

```JSON
{ "sha1": "2fa183839c954e6366c206367c9be5864e4f4a65" }
```

<!-- document id=ce5833be3d76f6e00a48e45d7b325fe2ab546ca249e2bc6aea530e3634563386 url=/mulesoft/current/en-us/dataweave/2.6/dw-crypto-functions-sha1.md -->

---
product: DataWeave
version: 2.6
---

# SHA1

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## SHA1(content: Binary): String

Computes the SHA1 hash and transforms the result into a hexadecimal, lowercase string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>A binary input value to encrypt.</p></td></tr></tbody></table>

### Example

This example uses the SHA1 algorithm to encrypt a binary value.

#### Source

```DataWeave
%dw 2.0
import dw::Crypto
output application/json
---
{ "sha1" : Crypto::SHA1("dsasd" as Binary) }
```

#### Output

```JSON
{ "sha1": "2fa183839c954e6366c206367c9be5864e4f4a65" }
```

<!-- document id=f8ae08a2b48a131313b1ccae260980f2ff82ecce84781c8db6057299813107f9 url=/mulesoft/current/en-us/dataweave/2.9/dw-crypto-functions-sha1.md -->

---
product: DataWeave
version: 2.9
---

# SHA1

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## SHA1(content: Binary): String

Computes the SHA1 hash and transforms the result into a hexadecimal, lowercase string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>A binary input value to encrypt.</p></td></tr></tbody></table>

### Example

This example uses the SHA1 algorithm to encrypt a binary value.

#### Source

```DataWeave
%dw 2.0
import dw::Crypto
output application/json
---
{ "sha1" : Crypto::SHA1("dsasd" as Binary) }
```

#### Output

```JSON
{ "sha1": "2fa183839c954e6366c206367c9be5864e4f4a65" }
```

<!-- document id=7d3dcdf80756e204d7816d9b2d25551f88c06df73d42a249e4a72af7789e0ebe url=/mulesoft/current/en-us/dataweave/latest/dw-crypto-functions-sha1.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# SHA1

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## SHA1(content: Binary): String

Computes the SHA1 hash and transforms the result into a hexadecimal, lowercase string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>A binary input value to encrypt.</p></td></tr></tbody></table>

### Example

This example uses the SHA1 algorithm to encrypt a binary value.

#### Source

```DataWeave
%dw 2.0
import dw::Crypto
output application/json
---
{ "sha1" : Crypto::SHA1("dsasd" as Binary) }
```

#### Output

```JSON
{ "sha1": "2fa183839c954e6366c206367c9be5864e4f4a65" }
```

<!-- document id=79a347dc56ebec15c0f9ee06f326ad4a274eb996abd4ff8bf1c74ed86e9f703d url=/mulesoft/current/en-us/dataweave/2.11/dw-math-functions-sin.md -->

---
product: DataWeave
version: 2.11
---

# sin

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## sin(angle: Number): Number

Returns the trigonometric sine of an angle from a given number of radians.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>angle</code></p></td><td><div><div><p>Number of radians in an angle.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `sin` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
  "sin0": sin(0),
  "sin13": sin(0.13),
  "sin-1": sin(-1)
}
```

#### Output

```Json
{
  "sin0": 0.0,
  "sin13": 0.12963414261969486,
  "sin-1": -0.8414709848078965
}
```

<!-- document id=42dc9db8c01b337252278a83419a7fb69fce4637ca67f2120e67d78d7056751f url=/mulesoft/current/en-us/dataweave/2.12/dw-math-functions-sin.md -->

---
product: DataWeave
version: 2.12
---

# sin

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## sin(angle: Number): Number

Returns the trigonometric sine of an angle from a given number of radians.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>angle</code></p></td><td><div><div><p>Number of radians in an angle.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `sin` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
  "sin0": sin(0),
  "sin13": sin(0.13),
  "sin-1": sin(-1)
}
```

#### Output

```Json
{
  "sin0": 0.0,
  "sin13": 0.12963414261969486,
  "sin-1": -0.8414709848078965
}
```

<!-- document id=b48abde636d71b6333965f0a565bd19c6830827812fcdbca565fe2906ba6ad5c url=/mulesoft/current/en-us/dataweave/2.4/dw-math-functions-sin.md -->

---
product: DataWeave
version: 2.4
---

# sin

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## sin(angle: Number): Number

Returns the trigonometric sine of an angle from a given number of radians.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>angle</code></p></td><td><div><div><p>Number of radians in an angle.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `sin` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
  "sin0": sin(0),
  "sin13": sin(0.13),
  "sin-1": sin(-1)
}
```

#### Output

```Json
{
  "sin0": 0.0,
  "sin13": 0.12963414261969486,
  "sin-1": -0.8414709848078965
}
```

<!-- document id=6ba321e63bf7f11aa97e51426235eb003073994e08ad238cb0a53f6d5e8f1b52 url=/mulesoft/current/en-us/dataweave/2.6/dw-math-functions-sin.md -->

---
product: DataWeave
version: 2.6
---

# sin

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## sin(angle: Number): Number

Returns the trigonometric sine of an angle from a given number of radians.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>angle</code></p></td><td><div><div><p>Number of radians in an angle.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `sin` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
  "sin0": sin(0),
  "sin13": sin(0.13),
  "sin-1": sin(-1)
}
```

#### Output

```Json
{
  "sin0": 0.0,
  "sin13": 0.12963414261969486,
  "sin-1": -0.8414709848078965
}
```

<!-- document id=4eb652992c64eb69b01088e0fcdda067c64381730e766a44cd257cd04e51b2c8 url=/mulesoft/current/en-us/dataweave/2.9/dw-math-functions-sin.md -->

---
product: DataWeave
version: 2.9
---

# sin

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## sin(angle: Number): Number

Returns the trigonometric sine of an angle from a given number of radians.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>angle</code></p></td><td><div><div><p>Number of radians in an angle.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `sin` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
  "sin0": sin(0),
  "sin13": sin(0.13),
  "sin-1": sin(-1)
}
```

#### Output

```Json
{
  "sin0": 0.0,
  "sin13": 0.12963414261969486,
  "sin-1": -0.8414709848078965
}
```

<!-- document id=0753af57957ade8507aeb28afbe394b916e6631bb3dbe40d51fbf94ae88e8fd5 url=/mulesoft/current/en-us/dataweave/latest/dw-math-functions-sin.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# sin

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## sin(angle: Number): Number

Returns the trigonometric sine of an angle from a given number of radians.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>angle</code></p></td><td><div><div><p>Number of radians in an angle.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `sin` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
  "sin0": sin(0),
  "sin13": sin(0.13),
  "sin-1": sin(-1)
}
```

#### Output

```Json
{
  "sin0": 0.0,
  "sin13": 0.12963414261969486,
  "sin-1": -0.8414709848078965
}
```

<!-- document id=2ec7b2e448615042e6166be5638f76b7c41e94252cd186ee0507a63d5b00bcdc url=/mulesoft/current/en-us/dataweave/2.11/dw-strings-functions-singularize.md -->

---
product: DataWeave
version: 2.11
---

# singularize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## singularize(text: String): String

Converts a plural string to its singular form.

If the input is already singular (for example, "box"), the output will match the input.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to convert to singular form.</p></td></tr></tbody></table>

### Example

This example converts the input string "boxes" to return "box".

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{ "singularize" : singularize("boxes") }
```

#### Output

```JSON
{ "singularize" : "box" }
```

## singularize(text: Null): Null

Helper function that enables `singularize` to work with a `null` value.

<!-- document id=4829a07d0b51c99fd244d291b748dcd731d749d32618387d4718c81b28e2c77f url=/mulesoft/current/en-us/dataweave/2.12/dw-strings-functions-singularize.md -->

---
product: DataWeave
version: 2.12
---

# singularize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## singularize(text: String): String

Converts a plural string to its singular form.

If the input is already singular (for example, "box"), the output will match the input.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to convert to singular form.</p></td></tr></tbody></table>

### Example

This example converts the input string "boxes" to return "box".

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{ "singularize" : singularize("boxes") }
```

#### Output

```JSON
{ "singularize" : "box" }
```

## singularize(text: Null): Null

Helper function that enables `singularize` to work with a `null` value.

<!-- document id=f0306923f0e776f307782b6a0dbd32844071c390d2192364f7da06928f3cf00a url=/mulesoft/current/en-us/dataweave/2.3/dw-strings-functions-singularize.md -->

---
product: DataWeave
version: 2.3
---

# singularize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## singularize(String): String

Converts a plural string to its singular form.

If the input is already singular (for example, "box"), the output will match the input.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to convert to singular form.</p></td></tr></tbody></table>

### Example

This example converts the input string "boxes" to return "box".

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{ "singularize" : singularize("boxes") }
```

#### Output

```JSON
{ "singularize" : "box" }
```

## singularize(Null): Null

Helper function that enables `singularize` to work with a `null` value.

<!-- document id=060637f75f38d3576528d081f399d28588bf4c01b097765af138e3f728cebdbf url=/mulesoft/current/en-us/dataweave/2.4/dw-strings-functions-singularize.md -->

---
product: DataWeave
version: 2.4
---

# singularize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## singularize(text: String): String

Converts a plural string to its singular form.

If the input is already singular (for example, "box"), the output will match the input.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to convert to singular form.</p></td></tr></tbody></table>

### Example

This example converts the input string "boxes" to return "box".

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{ "singularize" : singularize("boxes") }
```

#### Output

```JSON
{ "singularize" : "box" }
```

## singularize(text: Null): Null

Helper function that enables `singularize` to work with a `null` value.

<!-- document id=b8e3256d834c52438e721f66d5a996965f9436b7adc9dd1e7192e7a19eebf73e url=/mulesoft/current/en-us/dataweave/2.6/dw-strings-functions-singularize.md -->

---
product: DataWeave
version: 2.6
---

# singularize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## singularize(text: String): String

Converts a plural string to its singular form.

If the input is already singular (for example, "box"), the output will match the input.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to convert to singular form.</p></td></tr></tbody></table>

### Example

This example converts the input string "boxes" to return "box".

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{ "singularize" : singularize("boxes") }
```

#### Output

```JSON
{ "singularize" : "box" }
```

## singularize(text: Null): Null

Helper function that enables `singularize` to work with a `null` value.

<!-- document id=c12380cb9fbf24086a6d9e5c4bd4baa0ee9edca086321cf551c8803eb1be34cd url=/mulesoft/current/en-us/dataweave/2.9/dw-strings-functions-singularize.md -->

---
product: DataWeave
version: 2.9
---

# singularize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## singularize(text: String): String

Converts a plural string to its singular form.

If the input is already singular (for example, "box"), the output will match the input.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to convert to singular form.</p></td></tr></tbody></table>

### Example

This example converts the input string "boxes" to return "box".

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{ "singularize" : singularize("boxes") }
```

#### Output

```JSON
{ "singularize" : "box" }
```

## singularize(text: Null): Null

Helper function that enables `singularize` to work with a `null` value.

<!-- document id=04022a51721d748ff93037cb7fe8c367d1f956a9124c0e8b7f890b899fdb5fdc url=/mulesoft/current/en-us/dataweave/latest/dw-strings-functions-singularize.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# singularize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## singularize(text: String): String

Converts a plural string to its singular form.

If the input is already singular (for example, "box"), the output will match the input.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to convert to singular form.</p></td></tr></tbody></table>

### Example

This example converts the input string "boxes" to return "box".

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{ "singularize" : singularize("boxes") }
```

#### Output

```JSON
{ "singularize" : "box" }
```

## singularize(text: Null): Null

Helper function that enables `singularize` to work with a `null` value.

<!-- document id=78d5b342f8403f5dcf88a6011a9d7ba5c0364303e8bc622ae7c913bb11023c8a url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-sizeof.md -->

---
product: DataWeave
version: 2.11
---

# sizeOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## sizeOf(array: Array<Any>): Number

Returns the number of elements in an array. It returns `0` if the array is empty.

This version of `sizeOf` takes an array or an array of arrays as input. Other versions act on arrays
of objects, strings, or binary values.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The input array. The elements in the array can be any supported type.</p></td></tr></tbody></table>

### Example

This example counts the number of elements in the input array. It returns `3`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
sizeOf([ "a", "b", "c"])
```

#### Output

```JSON
3
```

### Example

This example returns a count of elements in the input array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  "arraySizes": {
     size3: sizeOf([1,2,3]),
     size2: sizeOf([[1,2,3],[4]]),
     size0: sizeOf([])
   }
}
```

#### Output

```JSON
{
   "arraySizes": {
     "size3": 3,
     "size2": 2,
     "size0": 0
   }
}
```

## sizeOf(object: Object): Number

Returns the number of key-value pairs in an object.

This function accepts an array of objects. Returns `0` if the input object is empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The input object that contains one or more key-value pairs.</p></td></tr></tbody></table>

### Example

This example counts the key-value pairs in the input object, so it returns `2`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
sizeOf({a: 1, b: 2})
```

#### Output

```JSON
2
```

### Example

This example counts the key-value pairs in an object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
   objectSizes : {
     sizeIs2: sizeOf({a:1,b:2}),
     sizeIs0: sizeOf({})
   }
}
```

#### Output

```JSON
{
  "objectSize": {
    "sizeIs2": 2,
    "sizeIs0": 0
  }
}
```

## sizeOf(binary: Binary): Number

Returns the size of a binary payload in bytes. Returns 0 if the payload is empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>binary</code></p></td><td><p>The input array of binary values.</p></td></tr></tbody></table>

### Example

This example returns the number of bytes in the binary payload. Notice how multi-byte UTF-8
characters take up more than one byte.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{

BinarySizeOf: sizeOf("'my word'" as Binary) ++ " " ++ sizeOf("'my word'" as Binary),

StringSizeOf: sizeOf("'my word'") ++ " " ++ sizeOf("'my word'")

}
```

#### Output

```JSON
{

"BinarySizeOf": "9 9",

"StringSizeOf": "9 9"

}
```

## sizeOf(text: String): Number

Returns the number of characters (including white space) in an string.

Returns `0` if the string is empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input text.</p></td></tr></tbody></table>

### Example

This example returns the number of characters in the input string `"abc"`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
sizeOf("abc")
```

#### Output

```JSON
3
```

### Example

This example returns the number of characters in the input strings. Notice it counts blank spaces in
the string `"my string"` and that `sizeOf("123" as Number)` returns `1` because `123` is coerced
into a number, so it’s not a string.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  sizeOfSting2 : sizeOf("my string"),
  sizeOfEmptyString: sizeOf(""),
  sizeOfNumber : sizeOf("123" as Number)
}
```

#### Output

```JSON
{
  "sizeOfSting2": 9,
  "sizeOfEmptyString": 0,
  "sizeOfNumber": 1
}
```

## sizeOf(value: Period): Number

Returns the number of characters in a `Period` value.

_Introduced in DataWeave version 2.6.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The input <code>Period</code>.</p></td></tr></tbody></table>

### Example

This example returns the number of characters in the `Period` value.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  a: sizeOf(|P3D|)
}
```

#### Output

```JSON
{ "a": 3 }
```

## sizeOf(value: DateTime): Number

Returns the number of characters in a `DateTime` value.

_Introduced in DataWeave version 2.6.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The input <code>DateTime</code>.</p></td></tr></tbody></table>

### Example

This example returns the number of characters in the `DateTime` value.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  a: sizeOf(|2025-07-13T18:06:59.314033Z|)
}
```

#### Output

```JSON
{ "a": 27 }
```

## sizeOf(value: LocalDateTime): Number

Returns the number of characters in a `LocalDateTime` value.

_Introduced in DataWeave version 2.6.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The input <code>LocalDateTime</code>.</p></td></tr></tbody></table>

### Example

This example returns the number of characters in the `LocalDateTime` value.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  a: sizeOf(|2025-07-13T18:06:59.314033|)
}
```

#### Output

```JSON
{ "a": 26 }
```

## sizeOf(number: Number): Number

Returns the number of characters in a `Number` value.

To keep backward compatibility with 2.4, this function returns `1` for any `Number` value when the
flag `com.mulesoft.dw.legacySizeOfNumber` is enabled.

_Introduced in DataWeave version 2.6.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The input number.</p></td></tr></tbody></table>

### Example

This example returns the number of characters in the `Number` value.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  a: sizeOf(123),
  b: sizeOf(123.45)
}
```

#### Output

```JSON
{ "a": 3, "b": 6 }
```

### Example

This example shows how the `sizeOf` function works when the flag
`com.mulesoft.dw.legacySizeOfNumber` is enabled. Notice it returns `1` for any given input.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  a: sizeOf(123)
  b: sizeOf(123.45)
}
```

#### Output

```JSON
{ "a": 1, "b": 1 }
```

## sizeOf(n: Null): Null

Helper function that enables `sizeOf` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=d61f6a5041310055bafd479eca97fead9cd23104aa74b91029c39d43626a420a url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-sizeof.md -->

---
product: DataWeave
version: 2.12
---

# sizeOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## sizeOf(array: Array<Any>): Number

Returns the number of elements in an array. It returns `0` if the array is empty.

This version of `sizeOf` takes an array or an array of arrays as input. Other versions act on arrays
of objects, strings, or binary values.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The input array. The elements in the array can be any supported type.</p></td></tr></tbody></table>

### Example

This example counts the number of elements in the input array. It returns `3`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
sizeOf([ "a", "b", "c"])
```

#### Output

```JSON
3
```

### Example

This example returns a count of elements in the input array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  "arraySizes": {
     size3: sizeOf([1,2,3]),
     size2: sizeOf([[1,2,3],[4]]),
     size0: sizeOf([])
   }
}
```

#### Output

```JSON
{
   "arraySizes": {
     "size3": 3,
     "size2": 2,
     "size0": 0
   }
}
```

## sizeOf(object: Object): Number

Returns the number of key-value pairs in an object.

This function accepts an array of objects. Returns `0` if the input object is empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The input object that contains one or more key-value pairs.</p></td></tr></tbody></table>

### Example

This example counts the key-value pairs in the input object, so it returns `2`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
sizeOf({a: 1, b: 2})
```

#### Output

```JSON
2
```

### Example

This example counts the key-value pairs in an object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
   objectSizes : {
     sizeIs2: sizeOf({a:1,b:2}),
     sizeIs0: sizeOf({})
   }
}
```

#### Output

```JSON
{
  "objectSize": {
    "sizeIs2": 2,
    "sizeIs0": 0
  }
}
```

## sizeOf(binary: Binary): Number

Returns the size of a binary payload in bytes. Returns 0 if the payload is empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>binary</code></p></td><td><p>The input array of binary values.</p></td></tr></tbody></table>

### Example

This example returns the number of bytes in the binary payload. Notice how multi-byte UTF-8
characters take up more than one byte.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{

BinarySizeOf: sizeOf("'my word'" as Binary) ++ " " ++ sizeOf("'my word'" as Binary),

StringSizeOf: sizeOf("'my word'") ++ " " ++ sizeOf("'my word'")

}
```

#### Output

```JSON
{

"BinarySizeOf": "9 9",

"StringSizeOf": "9 9"

}
```

## sizeOf(text: String): Number

Returns the number of characters (including white space) in an string.

Returns `0` if the string is empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input text.</p></td></tr></tbody></table>

### Example

This example returns the number of characters in the input string `"abc"`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
sizeOf("abc")
```

#### Output

```JSON
3
```

### Example

This example returns the number of characters in the input strings. Notice it counts blank spaces in
the string `"my string"` and that `sizeOf("123" as Number)` returns `1` because `123` is coerced
into a number, so it’s not a string.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  sizeOfSting2 : sizeOf("my string"),
  sizeOfEmptyString: sizeOf(""),
  sizeOfNumber : sizeOf("123" as Number)
}
```

#### Output

```JSON
{
  "sizeOfSting2": 9,
  "sizeOfEmptyString": 0,
  "sizeOfNumber": 1
}
```

## sizeOf(value: Period): Number

Returns the number of characters in a `Period` value.

_Introduced in DataWeave version 2.6.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The input <code>Period</code>.</p></td></tr></tbody></table>

### Example

This example returns the number of characters in the `Period` value.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  a: sizeOf(|P3D|)
}
```

#### Output

```JSON
{ "a": 3 }
```

## sizeOf(value: DateTime): Number

Returns the number of characters in a `DateTime` value.

_Introduced in DataWeave version 2.6.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The input <code>DateTime</code>.</p></td></tr></tbody></table>

### Example

This example returns the number of characters in the `DateTime` value.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  a: sizeOf(|2025-07-13T18:06:59.314033Z|)
}
```

#### Output

```JSON
{ "a": 27 }
```

## sizeOf(value: LocalDateTime): Number

Returns the number of characters in a `LocalDateTime` value.

_Introduced in DataWeave version 2.6.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The input <code>LocalDateTime</code>.</p></td></tr></tbody></table>

### Example

This example returns the number of characters in the `LocalDateTime` value.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  a: sizeOf(|2025-07-13T18:06:59.314033|)
}
```

#### Output

```JSON
{ "a": 26 }
```

## sizeOf(number: Number): Number

Returns the number of characters in a `Number` value.

To keep backward compatibility with 2.4, this function returns `1` for any `Number` value when the
flag `com.mulesoft.dw.legacySizeOfNumber` is enabled.

_Introduced in DataWeave version 2.6.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The input number.</p></td></tr></tbody></table>

### Example

This example returns the number of characters in the `Number` value.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  a: sizeOf(123),
  b: sizeOf(123.45)
}
```

#### Output

```JSON
{ "a": 3, "b": 6 }
```

### Example

This example shows how the `sizeOf` function works when the flag
`com.mulesoft.dw.legacySizeOfNumber` is enabled. Notice it returns `1` for any given input.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  a: sizeOf(123)
  b: sizeOf(123.45)
}
```

#### Output

```JSON
{ "a": 1, "b": 1 }
```

## sizeOf(n: Null): Null

Helper function that enables `sizeOf` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=3d446b40d34c4c26fdb4f676a8ada50be4aa86f9a8cf9b02e5851d377f8df41e url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-sizeof.md -->

---
product: DataWeave
version: 2.3
---

# sizeOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## sizeOf(Array<Any>): Number

Returns the number of elements in an array. It returns `0` if the array is empty.

This version of `sizeOf` takes an array or an array of arrays as input. Other versions act on arrays
of objects, strings, or binary values.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The input array. The elements in the array can be any supported type.</p></td></tr></tbody></table>

### Example

This example counts the number of elements in the input array. It returns `3`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
sizeOf([ "a", "b", "c"])
```

#### Output

```JSON
3
```

### Example

This example returns a count of elements in the input array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  "arraySizes": {
     size3: sizeOf([1,2,3]),
     size2: sizeOf([[1,2,3],[4]]),
     size0: sizeOf([])
   }
}
```

#### Output

```JSON
{
   "arraySizes": {
     "size3": 3,
     "size2": 2,
     "size0": 0
   }
}
```

## sizeOf(Object): Number

Returns the number of key-value pairs in an object.

This function accepts an array of objects. Returns `0` if the input object is empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The input object that contains one or more key-value pairs.</p></td></tr></tbody></table>

### Example

This example counts the key-value pairs in the input object, so it returns `2`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
sizeOf({a: 1, b: 2})
```

#### Output

```JSON
2
```

### Example

This example counts the key-value pairs in an object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
   objectSizes : {
     sizeIs2: sizeOf({a:1,b:2}),
     sizeIs0: sizeOf({})
   }
}
```

#### Output

```JSON
{
  "objectSize": {
    "sizeIs2": 2,
    "sizeIs0": 0
  }
}
```

## sizeOf(Binary): Number

Returns the number of elements in an array of binary values.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>binary</code></p></td><td><p>The input array of binary values.</p></td></tr></tbody></table>

### Example

This example returns the size of an array of binary values.

#### Source

```DataWeave
%dw 2.0
output application/json
---
sizeOf(["\u0000" as Binary, "\u0001" as Binary, "\u0002" as Binary])
```

#### Output

```JSON
3
```

## sizeOf(String): Number

Returns the number of characters (including white space) in an string.

Returns `0` if the string is empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input text.</p></td></tr></tbody></table>

### Example

This example returns the number of characters in the input string `"abc"`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
sizeOf("abc")
```

#### Output

```JSON
3
```

### Example

This example returns the number of characters in the input strings. Notice it counts blank spaces in
the string `"my string"` and that `sizeOf("123" as Number)` returns `1` because `123` is coerced
into a number, so it is not a string.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  sizeOfSting2 : sizeOf("my string"),
  sizeOfEmptyString: sizeOf(""),
  sizeOfNumber : sizeOf("123" as Number)
}
```

#### Output

```JSON
{
  "sizeOfSting2": 9,
  "sizeOfEmptyString": 0,
  "sizeOfNumber": 1
}
```

<!-- document id=919c7a8a129daf721222e972948889b317ff3f6eb706a85b51050b0808e8aacd url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-sizeof.md -->

---
product: DataWeave
version: 2.4
---

# sizeOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## sizeOf(array: Array<Any>): Number

Returns the number of elements in an array. It returns `0` if the array is empty.

This version of `sizeOf` takes an array or an array of arrays as input. Other versions act on arrays
of objects, strings, or binary values.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The input array. The elements in the array can be any supported type.</p></td></tr></tbody></table>

### Example

This example counts the number of elements in the input array. It returns `3`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
sizeOf([ "a", "b", "c"])
```

#### Output

```JSON
3
```

### Example

This example returns a count of elements in the input array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  "arraySizes": {
     size3: sizeOf([1,2,3]),
     size2: sizeOf([[1,2,3],[4]]),
     size0: sizeOf([])
   }
}
```

#### Output

```JSON
{
   "arraySizes": {
     "size3": 3,
     "size2": 2,
     "size0": 0
   }
}
```

## sizeOf(object: Object): Number

Returns the number of key-value pairs in an object.

This function accepts an array of objects. Returns `0` if the input object is empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The input object that contains one or more key-value pairs.</p></td></tr></tbody></table>

### Example

This example counts the key-value pairs in the input object, so it returns `2`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
sizeOf({a: 1, b: 2})
```

#### Output

```JSON
2
```

### Example

This example counts the key-value pairs in an object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
   objectSizes : {
     sizeIs2: sizeOf({a:1,b:2}),
     sizeIs0: sizeOf({})
   }
}
```

#### Output

```JSON
{
  "objectSize": {
    "sizeIs2": 2,
    "sizeIs0": 0
  }
}
```

## sizeOf(binary: Binary): Number

Returns the size of a binary payload in bytes. Returns 0 if the payload is empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>binary</code></p></td><td><p>The input array of binary values.</p></td></tr></tbody></table>

### Example

This example returns the number of bytes in the binary payload. Notice how multi-byte UTF-8
characters take up more than one byte.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{

BinarySizeOf: sizeOf("'my word'" as Binary) ++ " " ++ sizeOf("'my word'" as Binary),

StringSizeOf: sizeOf("'my word'") ++ " " ++ sizeOf("'my word'")

}
```

#### Output

```JSON
{

"BinarySizeOf": "9 9",

"StringSizeOf": "9 9"

}
```

## sizeOf(text: String): Number

Returns the number of characters (including white space) in an string.

Returns `0` if the string is empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input text.</p></td></tr></tbody></table>

### Example

This example returns the number of characters in the input string `"abc"`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
sizeOf("abc")
```

#### Output

```JSON
3
```

### Example

This example returns the number of characters in the input strings. Notice it counts blank spaces in
the string `"my string"` and that `sizeOf("123" as Number)` returns `1` because `123` is coerced
into a number, so it is not a string.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  sizeOfSting2 : sizeOf("my string"),
  sizeOfEmptyString: sizeOf(""),
  sizeOfNumber : sizeOf("123" as Number)
}
```

#### Output

```JSON
{
  "sizeOfSting2": 9,
  "sizeOfEmptyString": 0,
  "sizeOfNumber": 1
}
```

## sizeOf(n: Null): Null

Helper function that enables `sizeOf` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=364d3f64b00573791b20626d1e945acc2bf0623e2f9e4cdcb5c88cd92eb8e3c8 url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-sizeof.md -->

---
product: DataWeave
version: 2.6
---

# sizeOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## sizeOf(array: Array<Any>): Number

Returns the number of elements in an array. It returns `0` if the array is empty.

This version of `sizeOf` takes an array or an array of arrays as input. Other versions act on arrays
of objects, strings, or binary values.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The input array. The elements in the array can be any supported type.</p></td></tr></tbody></table>

### Example

This example counts the number of elements in the input array. It returns `3`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
sizeOf([ "a", "b", "c"])
```

#### Output

```JSON
3
```

### Example

This example returns a count of elements in the input array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  "arraySizes": {
     size3: sizeOf([1,2,3]),
     size2: sizeOf([[1,2,3],[4]]),
     size0: sizeOf([])
   }
}
```

#### Output

```JSON
{
   "arraySizes": {
     "size3": 3,
     "size2": 2,
     "size0": 0
   }
}
```

## sizeOf(object: Object): Number

Returns the number of key-value pairs in an object.

This function accepts an array of objects. Returns `0` if the input object is empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The input object that contains one or more key-value pairs.</p></td></tr></tbody></table>

### Example

This example counts the key-value pairs in the input object, so it returns `2`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
sizeOf({a: 1, b: 2})
```

#### Output

```JSON
2
```

### Example

This example counts the key-value pairs in an object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
   objectSizes : {
     sizeIs2: sizeOf({a:1,b:2}),
     sizeIs0: sizeOf({})
   }
}
```

#### Output

```JSON
{
  "objectSize": {
    "sizeIs2": 2,
    "sizeIs0": 0
  }
}
```

## sizeOf(binary: Binary): Number

Returns the size of a binary payload in bytes. Returns 0 if the payload is empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>binary</code></p></td><td><p>The input array of binary values.</p></td></tr></tbody></table>

### Example

This example returns the number of bytes in the binary payload. Notice how multi-byte UTF-8
characters take up more than one byte.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{

BinarySizeOf: sizeOf("'my word'" as Binary) ++ " " ++ sizeOf("'my word'" as Binary),

StringSizeOf: sizeOf("'my word'") ++ " " ++ sizeOf("'my word'")

}
```

#### Output

```JSON
{

"BinarySizeOf": "9 9",

"StringSizeOf": "9 9"

}
```

## sizeOf(text: String): Number

Returns the number of characters (including white space) in an string.

Returns `0` if the string is empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input text.</p></td></tr></tbody></table>

### Example

This example returns the number of characters in the input string `"abc"`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
sizeOf("abc")
```

#### Output

```JSON
3
```

### Example

This example returns the number of characters in the input strings. Notice it counts blank spaces in
the string `"my string"` and that `sizeOf("123" as Number)` returns `1` because `123` is coerced
into a number, so it is not a string.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  sizeOfSting2 : sizeOf("my string"),
  sizeOfEmptyString: sizeOf(""),
  sizeOfNumber : sizeOf("123" as Number)
}
```

#### Output

```JSON
{
  "sizeOfSting2": 9,
  "sizeOfEmptyString": 0,
  "sizeOfNumber": 1
}
```

## sizeOf(n: Null): Null

Helper function that enables `sizeOf` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=b9ac581de991757e0ab4fba6a479d342db700ebb4baa17022947f61b8d5c9940 url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-sizeof.md -->

---
product: DataWeave
version: 2.9
---

# sizeOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## sizeOf(array: Array<Any>): Number

Returns the number of elements in an array. It returns `0` if the array is empty.

This version of `sizeOf` takes an array or an array of arrays as input. Other versions act on arrays
of objects, strings, or binary values.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The input array. The elements in the array can be any supported type.</p></td></tr></tbody></table>

### Example

This example counts the number of elements in the input array. It returns `3`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
sizeOf([ "a", "b", "c"])
```

#### Output

```JSON
3
```

### Example

This example returns a count of elements in the input array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  "arraySizes": {
     size3: sizeOf([1,2,3]),
     size2: sizeOf([[1,2,3],[4]]),
     size0: sizeOf([])
   }
}
```

#### Output

```JSON
{
   "arraySizes": {
     "size3": 3,
     "size2": 2,
     "size0": 0
   }
}
```

## sizeOf(object: Object): Number

Returns the number of key-value pairs in an object.

This function accepts an array of objects. Returns `0` if the input object is empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The input object that contains one or more key-value pairs.</p></td></tr></tbody></table>

### Example

This example counts the key-value pairs in the input object, so it returns `2`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
sizeOf({a: 1, b: 2})
```

#### Output

```JSON
2
```

### Example

This example counts the key-value pairs in an object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
   objectSizes : {
     sizeIs2: sizeOf({a:1,b:2}),
     sizeIs0: sizeOf({})
   }
}
```

#### Output

```JSON
{
  "objectSize": {
    "sizeIs2": 2,
    "sizeIs0": 0
  }
}
```

## sizeOf(binary: Binary): Number

Returns the size of a binary payload in bytes. Returns 0 if the payload is empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>binary</code></p></td><td><p>The input array of binary values.</p></td></tr></tbody></table>

### Example

This example returns the number of bytes in the binary payload. Notice how multi-byte UTF-8
characters take up more than one byte.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{

BinarySizeOf: sizeOf("'my word'" as Binary) ++ " " ++ sizeOf("'my word'" as Binary),

StringSizeOf: sizeOf("'my word'") ++ " " ++ sizeOf("'my word'")

}
```

#### Output

```JSON
{

"BinarySizeOf": "9 9",

"StringSizeOf": "9 9"

}
```

## sizeOf(text: String): Number

Returns the number of characters (including white space) in an string.

Returns `0` if the string is empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input text.</p></td></tr></tbody></table>

### Example

This example returns the number of characters in the input string `"abc"`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
sizeOf("abc")
```

#### Output

```JSON
3
```

### Example

This example returns the number of characters in the input strings. Notice it counts blank spaces in
the string `"my string"` and that `sizeOf("123" as Number)` returns `1` because `123` is coerced
into a number, so it is not a string.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  sizeOfSting2 : sizeOf("my string"),
  sizeOfEmptyString: sizeOf(""),
  sizeOfNumber : sizeOf("123" as Number)
}
```

#### Output

```JSON
{
  "sizeOfSting2": 9,
  "sizeOfEmptyString": 0,
  "sizeOfNumber": 1
}
```

## sizeOf(n: Null): Null

Helper function that enables `sizeOf` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=8c8706a81dfd630bceeb1bb5e90e808949139870d70460e2dab5b8b53bd8dcb1 url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-sizeof.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# sizeOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## sizeOf(array: Array<Any>): Number

Returns the number of elements in an array. It returns `0` if the array is empty.

This version of `sizeOf` takes an array or an array of arrays as input. Other versions act on arrays
of objects, strings, or binary values.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The input array. The elements in the array can be any supported type.</p></td></tr></tbody></table>

### Example

This example counts the number of elements in the input array. It returns `3`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
sizeOf([ "a", "b", "c"])
```

#### Output

```JSON
3
```

### Example

This example returns a count of elements in the input array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  "arraySizes": {
     size3: sizeOf([1,2,3]),
     size2: sizeOf([[1,2,3],[4]]),
     size0: sizeOf([])
   }
}
```

#### Output

```JSON
{
   "arraySizes": {
     "size3": 3,
     "size2": 2,
     "size0": 0
   }
}
```

## sizeOf(object: Object): Number

Returns the number of key-value pairs in an object.

This function accepts an array of objects. Returns `0` if the input object is empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>object</code></p></td><td><p>The input object that contains one or more key-value pairs.</p></td></tr></tbody></table>

### Example

This example counts the key-value pairs in the input object, so it returns `2`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
sizeOf({a: 1, b: 2})
```

#### Output

```JSON
2
```

### Example

This example counts the key-value pairs in an object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
   objectSizes : {
     sizeIs2: sizeOf({a:1,b:2}),
     sizeIs0: sizeOf({})
   }
}
```

#### Output

```JSON
{
  "objectSize": {
    "sizeIs2": 2,
    "sizeIs0": 0
  }
}
```

## sizeOf(binary: Binary): Number

Returns the size of a binary payload in bytes. Returns 0 if the payload is empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>binary</code></p></td><td><p>The input array of binary values.</p></td></tr></tbody></table>

### Example

This example returns the number of bytes in the binary payload. Notice how multi-byte UTF-8
characters take up more than one byte.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{

BinarySizeOf: sizeOf("'my word'" as Binary) ++ " " ++ sizeOf("'my word'" as Binary),

StringSizeOf: sizeOf("'my word'") ++ " " ++ sizeOf("'my word'")

}
```

#### Output

```JSON
{

"BinarySizeOf": "9 9",

"StringSizeOf": "9 9"

}
```

## sizeOf(text: String): Number

Returns the number of characters (including white space) in an string.

Returns `0` if the string is empty.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input text.</p></td></tr></tbody></table>

### Example

This example returns the number of characters in the input string `"abc"`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
sizeOf("abc")
```

#### Output

```JSON
3
```

### Example

This example returns the number of characters in the input strings. Notice it counts blank spaces in
the string `"my string"` and that `sizeOf("123" as Number)` returns `1` because `123` is coerced
into a number, so it’s not a string.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  sizeOfSting2 : sizeOf("my string"),
  sizeOfEmptyString: sizeOf(""),
  sizeOfNumber : sizeOf("123" as Number)
}
```

#### Output

```JSON
{
  "sizeOfSting2": 9,
  "sizeOfEmptyString": 0,
  "sizeOfNumber": 1
}
```

## sizeOf(value: Period): Number

Returns the number of characters in a `Period` value.

_Introduced in DataWeave version 2.6.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The input <code>Period</code>.</p></td></tr></tbody></table>

### Example

This example returns the number of characters in the `Period` value.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  a: sizeOf(|P3D|)
}
```

#### Output

```JSON
{ "a": 3 }
```

## sizeOf(value: DateTime): Number

Returns the number of characters in a `DateTime` value.

_Introduced in DataWeave version 2.6.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The input <code>DateTime</code>.</p></td></tr></tbody></table>

### Example

This example returns the number of characters in the `DateTime` value.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  a: sizeOf(|2025-07-13T18:06:59.314033Z|)
}
```

#### Output

```JSON
{ "a": 27 }
```

## sizeOf(value: LocalDateTime): Number

Returns the number of characters in a `LocalDateTime` value.

_Introduced in DataWeave version 2.6.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The input <code>LocalDateTime</code>.</p></td></tr></tbody></table>

### Example

This example returns the number of characters in the `LocalDateTime` value.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  a: sizeOf(|2025-07-13T18:06:59.314033|)
}
```

#### Output

```JSON
{ "a": 26 }
```

## sizeOf(number: Number): Number

Returns the number of characters in a `Number` value.

To keep backward compatibility with 2.4, this function returns `1` for any `Number` value when the
flag `com.mulesoft.dw.legacySizeOfNumber` is enabled.

_Introduced in DataWeave version 2.6.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The input number.</p></td></tr></tbody></table>

### Example

This example returns the number of characters in the `Number` value.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  a: sizeOf(123),
  b: sizeOf(123.45)
}
```

#### Output

```JSON
{ "a": 3, "b": 6 }
```

### Example

This example shows how the `sizeOf` function works when the flag
`com.mulesoft.dw.legacySizeOfNumber` is enabled. Notice it returns `1` for any given input.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  a: sizeOf(123)
  b: sizeOf(123.45)
}
```

#### Output

```JSON
{ "a": 1, "b": 1 }
```

## sizeOf(n: Null): Null

Helper function that enables `sizeOf` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=0ddb836e609e6ffe6a30c55d59e3844005ced745b5097ec3c8c10f1d09055c9a url=/mulesoft/current/en-us/dataweave/2.11/dw-arrays-functions-slice.md -->

---
product: DataWeave
version: 2.11
---

# slice

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## slice<T>(array: Array<T>, from: Number, until: Number): Array<T>

Selects the interval of elements that satisfy the condition: `from <= indexOf(array) < until`

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>from</code></p></td><td><p>The starting index of the interval of elements to include from the array.<br>If this value is negative, the function starts including from the first element of the array. If this value is higher than the last index of the array, the function returns an empty array (<code>[]</code>).</p></td></tr><tr><td><p><code>until</code></p></td><td><p>The ending index of the interval of elements to include from the array.<br>If this value is higher than the last index of the array, the function includes up to the last element of the array. If this value is lower than the first index of the array, the function returns an empty array (<code>[]</code>).</p></td></tr></tbody></table>

### Example

This example returns an array that contains the values of indices 1, 2, and 3 from the input array.
It excludes the values of indices 0, 4, and 5.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var arr = [0,1,2,3,4,5]
---
slice(arr, 1, 4)
```

#### Output

```json
[1, 2, 3]
```

## slice(array: Null, from: Any, until: Any): Null

Helper function that enables `slice` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=a818593aee130b93171617d527a49e221e7b3f098fc13574948bc95ef048e480 url=/mulesoft/current/en-us/dataweave/2.12/dw-arrays-functions-slice.md -->

---
product: DataWeave
version: 2.12
---

# slice

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## slice<T>(array: Array<T>, from: Number, until: Number): Array<T>

Selects the interval of elements that satisfy the condition: `from <= indexOf(array) < until`

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>from</code></p></td><td><p>The starting index of the interval of elements to include from the array.<br>If this value is negative, the function starts including from the first element of the array. If this value is higher than the last index of the array, the function returns an empty array (<code>[]</code>).</p></td></tr><tr><td><p><code>until</code></p></td><td><p>The ending index of the interval of elements to include from the array.<br>If this value is higher than the last index of the array, the function includes up to the last element of the array. If this value is lower than the first index of the array, the function returns an empty array (<code>[]</code>).</p></td></tr></tbody></table>

### Example

This example returns an array that contains the values of indices 1, 2, and 3 from the input array.
It excludes the values of indices 0, 4, and 5.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var arr = [0,1,2,3,4,5]
---
slice(arr, 1, 4)
```

#### Output

```json
[1, 2, 3]
```

## slice(array: Null, from: Any, until: Any): Null

Helper function that enables `slice` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=8bef5c4d3a0e62dff57901eaff144b459a3e92f9657f8cf189d76aba7c6adca5 url=/mulesoft/current/en-us/dataweave/2.3/dw-arrays-functions-slice.md -->

---
product: DataWeave
version: 2.3
---

# slice

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## slice(Array<T>, Number, Number): Array<T>

Selects the interval of elements that satisfy the condition: `from <= indexOf(array) < until`

_Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>from</code></p></td><td><p>The starting index of the interval of elements to include from the array.<br>If this value is negative, the function starts including from the first element of the array. If this value is higher than the last index of the array, the function returns an empty array (<code>[]</code>).</p></td></tr><tr><td><p><code>until</code></p></td><td><p>The ending index of the interval of elements to include from the array.<br>If this value is higher than the last index of the array, the function includes up to the last element of the array. If this value is lower than the first index of the array, the function returns an empty array (<code>[]</code>).</p></td></tr></tbody></table>

### Example

This example returns an array that contains the values of indices 1, 2, and 3 from the input array.
It excludes the values of indices 0, 4, and 5.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var arr = [0,1,2,3,4,5]
---
slice(arr, 1, 4)
```

#### Output

```json
[1, 2, 3]
```

<!-- document id=d8a21af70ce9650ad1f0afaebe7d6c7d2ec269cfa1716ce6bd1bd03b1d10d023 url=/mulesoft/current/en-us/dataweave/2.4/dw-arrays-functions-slice.md -->

---
product: DataWeave
version: 2.4
---

# slice

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## slice<T>(array: Array<T>, from: Number, until: Number): Array<T>

Selects the interval of elements that satisfy the condition: `from <= indexOf(array) < until`

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>from</code></p></td><td><p>The starting index of the interval of elements to include from the array.<br>If this value is negative, the function starts including from the first element of the array. If this value is higher than the last index of the array, the function returns an empty array (<code>[]</code>).</p></td></tr><tr><td><p><code>until</code></p></td><td><p>The ending index of the interval of elements to include from the array.<br>If this value is higher than the last index of the array, the function includes up to the last element of the array. If this value is lower than the first index of the array, the function returns an empty array (<code>[]</code>).</p></td></tr></tbody></table>

### Example

This example returns an array that contains the values of indices 1, 2, and 3 from the input array.
It excludes the values of indices 0, 4, and 5.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var arr = [0,1,2,3,4,5]
---
slice(arr, 1, 4)
```

#### Output

```json
[1, 2, 3]
```

## slice(array: Null, from: Any, until: Any): Null

Helper function that enables `slice` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=2903f95bed51c156a8faacc49b6256d8a783ce4b7b7ef61007c0b3995a735fdc url=/mulesoft/current/en-us/dataweave/2.6/dw-arrays-functions-slice.md -->

---
product: DataWeave
version: 2.6
---

# slice

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## slice<T>(array: Array<T>, from: Number, until: Number): Array<T>

Selects the interval of elements that satisfy the condition: `from <= indexOf(array) < until`

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>from</code></p></td><td><p>The starting index of the interval of elements to include from the array.<br>If this value is negative, the function starts including from the first element of the array. If this value is higher than the last index of the array, the function returns an empty array (<code>[]</code>).</p></td></tr><tr><td><p><code>until</code></p></td><td><p>The ending index of the interval of elements to include from the array.<br>If this value is higher than the last index of the array, the function includes up to the last element of the array. If this value is lower than the first index of the array, the function returns an empty array (<code>[]</code>).</p></td></tr></tbody></table>

### Example

This example returns an array that contains the values of indices 1, 2, and 3 from the input array.
It excludes the values of indices 0, 4, and 5.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var arr = [0,1,2,3,4,5]
---
slice(arr, 1, 4)
```

#### Output

```json
[1, 2, 3]
```

## slice(array: Null, from: Any, until: Any): Null

Helper function that enables `slice` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=8e5186008054426a24a9523f608e94da01e4b6c38bf8f246fdbf03d135647522 url=/mulesoft/current/en-us/dataweave/2.9/dw-arrays-functions-slice.md -->

---
product: DataWeave
version: 2.9
---

# slice

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## slice<T>(array: Array<T>, from: Number, until: Number): Array<T>

Selects the interval of elements that satisfy the condition: `from <= indexOf(array) < until`

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>from</code></p></td><td><p>The starting index of the interval of elements to include from the array.<br>If this value is negative, the function starts including from the first element of the array. If this value is higher than the last index of the array, the function returns an empty array (<code>[]</code>).</p></td></tr><tr><td><p><code>until</code></p></td><td><p>The ending index of the interval of elements to include from the array.<br>If this value is higher than the last index of the array, the function includes up to the last element of the array. If this value is lower than the first index of the array, the function returns an empty array (<code>[]</code>).</p></td></tr></tbody></table>

### Example

This example returns an array that contains the values of indices 1, 2, and 3 from the input array.
It excludes the values of indices 0, 4, and 5.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var arr = [0,1,2,3,4,5]
---
slice(arr, 1, 4)
```

#### Output

```json
[1, 2, 3]
```

## slice(array: Null, from: Any, until: Any): Null

Helper function that enables `slice` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=31beae68493604c6256d4ee957f9ee55142bf244dfb9cab3d5793b9b50ba2949 url=/mulesoft/current/en-us/dataweave/latest/dw-arrays-functions-slice.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# slice

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## slice<T>(array: Array<T>, from: Number, until: Number): Array<T>

Selects the interval of elements that satisfy the condition: `from <= indexOf(array) < until`

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>from</code></p></td><td><p>The starting index of the interval of elements to include from the array.<br>If this value is negative, the function starts including from the first element of the array. If this value is higher than the last index of the array, the function returns an empty array (<code>[]</code>).</p></td></tr><tr><td><p><code>until</code></p></td><td><p>The ending index of the interval of elements to include from the array.<br>If this value is higher than the last index of the array, the function includes up to the last element of the array. If this value is lower than the first index of the array, the function returns an empty array (<code>[]</code>).</p></td></tr></tbody></table>

### Example

This example returns an array that contains the values of indices 1, 2, and 3 from the input array.
It excludes the values of indices 0, 4, and 5.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var arr = [0,1,2,3,4,5]
---
slice(arr, 1, 4)
```

#### Output

```json
[1, 2, 3]
```

## slice(array: Null, from: Any, until: Any): Null

Helper function that enables `slice` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=8d1df1d0ee3ddea4e7bf9c6e993e82be57459a235e5647750ddcb9dad9d5cf62 url=/mulesoft/current/en-us/dataweave/2.11/dw-arrays-functions-some.md -->

---
product: DataWeave
version: 2.11
---

# some

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## some<T>(list: Array<T>, condition: (T) -> Boolean): Boolean

Returns `true` if at least one element in the array matches the specified condition.

The function stops iterating after the first element that matches the condition is found.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>list</code></p></td><td><p>The input array.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>A condition (or expression) used to match elements in the array.</p></td></tr></tbody></table>

### Example

This example applies a variety of expressions to elements of several input arrays. The `$` in the
condition is the default parameter for the current element of the array that the condition
evaluates. Note that you can replace the default `$` parameter with a lambda expression that
contains a named parameter for the current array element.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
---
{ "results" : [
    "ok" : [
      [1,2,3] some (($ mod 2) == 0),
      [1,2,3] some ((nextNum) -> (nextNum mod 2) == 0),
      [1,2,3] some (($ mod 2) == 1),
      [1,2,3,4,5,6,7,8] some (log('should stop at 2 ==', $) == 2),
      [1,2,3] some ($ == 1),
      [1,1,1] some ($ == 1),
      [1] some ($ == 1)
    ],
    "err" : [
      [1,2,3] some ($ == 100),
      [1] some ($ == 2)
    ]
  ]
}
```

#### Output

```JSON
{
   "results": [
     {
       "ok": [ true, true, true, true, true, true, true ]
     },
     {
       "err": [ false, false ]
     }
   ]
 }
```

## some(list: Null, condition: (Nothing) -> Any): Boolean

Helper function that enables `some` to work with a `null` value.

_Introduced in DataWeave version 2.3.0._

<!-- document id=7e5318265a7db95b17a13342f21abc6c4d3df8ae8f077ea913aa72fc92e307a8 url=/mulesoft/current/en-us/dataweave/2.12/dw-arrays-functions-some.md -->

---
product: DataWeave
version: 2.12
---

# some

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## some<T>(list: Array<T>, condition: (T) -> Boolean): Boolean

Returns `true` if at least one element in the array matches the specified condition.

The function stops iterating after the first element that matches the condition is found.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>list</code></p></td><td><p>The input array.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>A condition (or expression) used to match elements in the array.</p></td></tr></tbody></table>

### Example

This example applies a variety of expressions to elements of several input arrays. The `$` in the
condition is the default parameter for the current element of the array that the condition
evaluates. Note that you can replace the default `$` parameter with a lambda expression that
contains a named parameter for the current array element.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
---
{ "results" : [
    "ok" : [
      [1,2,3] some (($ mod 2) == 0),
      [1,2,3] some ((nextNum) -> (nextNum mod 2) == 0),
      [1,2,3] some (($ mod 2) == 1),
      [1,2,3,4,5,6,7,8] some (log('should stop at 2 ==', $) == 2),
      [1,2,3] some ($ == 1),
      [1,1,1] some ($ == 1),
      [1] some ($ == 1)
    ],
    "err" : [
      [1,2,3] some ($ == 100),
      [1] some ($ == 2)
    ]
  ]
}
```

#### Output

```JSON
{
   "results": [
     {
       "ok": [ true, true, true, true, true, true, true ]
     },
     {
       "err": [ false, false ]
     }
   ]
 }
```

## some(list: Null, condition: (Nothing) -> Any): Boolean

Helper function that enables `some` to work with a `null` value.

_Introduced in DataWeave version 2.3.0._

<!-- document id=cc358c813d9bb04a06e5d37b01a152e149d33a9f759fca6fe910a22bc861e983 url=/mulesoft/current/en-us/dataweave/2.3/dw-arrays-functions-some.md -->

---
product: DataWeave
version: 2.3
---

# some

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## some(Array<T>, (T) -> Boolean): Boolean

Returns `true` if at least one element in the array matches the specified condition.

The function stops iterating after the first element that matches the condition is found.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>list</code></p></td><td><p>The input array.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>A condition (or expression) used to match elements in the array.</p></td></tr></tbody></table>

### Example

This example applies a variety of expressions to elements of several input arrays. The `$` in the
condition is the default parameter for the current element of the array that the condition
evaluates. Note that you can replace the default `$` parameter with a lambda expression that
contains a named parameter for the current array element.

#### Source

```DataWeave
 %dw 2.0
 import * from dw::core::Arrays
 output application/json
 ---
 { "results" : [
     "ok" : [
       [1,2,3] some (($ mod 2) == 0),
       [1,2,3] some ((nextNum) -> (nextNum mod 2) == 0),
       [1,2,3] some (($ mod 2) == 1),
       [1,2,3,4,5,6,7,8] some (log('should stop at 2 ==', $) == 2),
       [1,2,3] some ($ == 1),
       [1,1,1] some ($ == 1),
       [1] some ($ == 1)
     ],
     "err" : [
       [1,2,3] some ($ == 100),
       [1] some ($ == 2)
     ]
   ]
}
```

#### Output

```JSON
{
   "results": [
     {
       "ok": [ true, true, true, true, true, true, true ]
     },
     {
       "err": [ false, false ]
     }
   ]
 }
```

## some(Null, (Nothing) -> Boolean): Boolean

Helper function that enables `some` to work with a `null` value.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

<!-- document id=6809ae7f9f5e1be1c5669e5f03f803ae5a278d46d66386f87a71612af012a592 url=/mulesoft/current/en-us/dataweave/2.4/dw-arrays-functions-some.md -->

---
product: DataWeave
version: 2.4
---

# some

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## some<T>(list: Array<T>, condition: (T) -> Boolean): Boolean

Returns `true` if at least one element in the array matches the specified condition.

The function stops iterating after the first element that matches the condition is found.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>list</code></p></td><td><p>The input array.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>A condition (or expression) used to match elements in the array.</p></td></tr></tbody></table>

### Example

This example applies a variety of expressions to elements of several input arrays. The `$` in the
condition is the default parameter for the current element of the array that the condition
evaluates. Note that you can replace the default `$` parameter with a lambda expression that
contains a named parameter for the current array element.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
---
{ "results" : [
    "ok" : [
      [1,2,3] some (($ mod 2) == 0),
      [1,2,3] some ((nextNum) -> (nextNum mod 2) == 0),
      [1,2,3] some (($ mod 2) == 1),
      [1,2,3,4,5,6,7,8] some (log('should stop at 2 ==', $) == 2),
      [1,2,3] some ($ == 1),
      [1,1,1] some ($ == 1),
      [1] some ($ == 1)
    ],
    "err" : [
      [1,2,3] some ($ == 100),
      [1] some ($ == 2)
    ]
  ]
}
```

#### Output

```JSON
{
   "results": [
     {
       "ok": [ true, true, true, true, true, true, true ]
     },
     {
       "err": [ false, false ]
     }
   ]
 }
```

## some(list: Null, condition: (Nothing) -> Any): Boolean

Helper function that enables `some` to work with a `null` value.

_Introduced in DataWeave version 2.3.0._

<!-- document id=6c10d09e6bf33d5e526dd9dce87ebe210f45ef2da6e8b6b67aa731bd83143d4b url=/mulesoft/current/en-us/dataweave/2.6/dw-arrays-functions-some.md -->

---
product: DataWeave
version: 2.6
---

# some

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## some<T>(list: Array<T>, condition: (T) -> Boolean): Boolean

Returns `true` if at least one element in the array matches the specified condition.

The function stops iterating after the first element that matches the condition is found.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>list</code></p></td><td><p>The input array.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>A condition (or expression) used to match elements in the array.</p></td></tr></tbody></table>

### Example

This example applies a variety of expressions to elements of several input arrays. The `$` in the
condition is the default parameter for the current element of the array that the condition
evaluates. Note that you can replace the default `$` parameter with a lambda expression that
contains a named parameter for the current array element.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
---
{ "results" : [
    "ok" : [
      [1,2,3] some (($ mod 2) == 0),
      [1,2,3] some ((nextNum) -> (nextNum mod 2) == 0),
      [1,2,3] some (($ mod 2) == 1),
      [1,2,3,4,5,6,7,8] some (log('should stop at 2 ==', $) == 2),
      [1,2,3] some ($ == 1),
      [1,1,1] some ($ == 1),
      [1] some ($ == 1)
    ],
    "err" : [
      [1,2,3] some ($ == 100),
      [1] some ($ == 2)
    ]
  ]
}
```

#### Output

```JSON
{
   "results": [
     {
       "ok": [ true, true, true, true, true, true, true ]
     },
     {
       "err": [ false, false ]
     }
   ]
 }
```

## some(list: Null, condition: (Nothing) -> Any): Boolean

Helper function that enables `some` to work with a `null` value.

_Introduced in DataWeave version 2.3.0._

<!-- document id=033509e99ec991b4d5d188361f165b0a80261f21bd4fc50717051684f76ea464 url=/mulesoft/current/en-us/dataweave/2.9/dw-arrays-functions-some.md -->

---
product: DataWeave
version: 2.9
---

# some

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## some<T>(list: Array<T>, condition: (T) -> Boolean): Boolean

Returns `true` if at least one element in the array matches the specified condition.

The function stops iterating after the first element that matches the condition is found.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>list</code></p></td><td><p>The input array.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>A condition (or expression) used to match elements in the array.</p></td></tr></tbody></table>

### Example

This example applies a variety of expressions to elements of several input arrays. The `$` in the
condition is the default parameter for the current element of the array that the condition
evaluates. Note that you can replace the default `$` parameter with a lambda expression that
contains a named parameter for the current array element.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
---
{ "results" : [
    "ok" : [
      [1,2,3] some (($ mod 2) == 0),
      [1,2,3] some ((nextNum) -> (nextNum mod 2) == 0),
      [1,2,3] some (($ mod 2) == 1),
      [1,2,3,4,5,6,7,8] some (log('should stop at 2 ==', $) == 2),
      [1,2,3] some ($ == 1),
      [1,1,1] some ($ == 1),
      [1] some ($ == 1)
    ],
    "err" : [
      [1,2,3] some ($ == 100),
      [1] some ($ == 2)
    ]
  ]
}
```

#### Output

```JSON
{
   "results": [
     {
       "ok": [ true, true, true, true, true, true, true ]
     },
     {
       "err": [ false, false ]
     }
   ]
 }
```

## some(list: Null, condition: (Nothing) -> Any): Boolean

Helper function that enables `some` to work with a `null` value.

_Introduced in DataWeave version 2.3.0._

<!-- document id=2aa74c6aa21101058adb1ea161ee78dee6f51d9c0bd252a4b6fbb22294b9b2d9 url=/mulesoft/current/en-us/dataweave/latest/dw-arrays-functions-some.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# some

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## some<T>(list: Array<T>, condition: (T) -> Boolean): Boolean

Returns `true` if at least one element in the array matches the specified condition.

The function stops iterating after the first element that matches the condition is found.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>list</code></p></td><td><p>The input array.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>A condition (or expression) used to match elements in the array.</p></td></tr></tbody></table>

### Example

This example applies a variety of expressions to elements of several input arrays. The `$` in the
condition is the default parameter for the current element of the array that the condition
evaluates. Note that you can replace the default `$` parameter with a lambda expression that
contains a named parameter for the current array element.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
---
{ "results" : [
    "ok" : [
      [1,2,3] some (($ mod 2) == 0),
      [1,2,3] some ((nextNum) -> (nextNum mod 2) == 0),
      [1,2,3] some (($ mod 2) == 1),
      [1,2,3,4,5,6,7,8] some (log('should stop at 2 ==', $) == 2),
      [1,2,3] some ($ == 1),
      [1,1,1] some ($ == 1),
      [1] some ($ == 1)
    ],
    "err" : [
      [1,2,3] some ($ == 100),
      [1] some ($ == 2)
    ]
  ]
}
```

#### Output

```JSON
{
   "results": [
     {
       "ok": [ true, true, true, true, true, true, true ]
     },
     {
       "err": [ false, false ]
     }
   ]
 }
```

## some(list: Null, condition: (Nothing) -> Any): Boolean

Helper function that enables `some` to work with a `null` value.

_Introduced in DataWeave version 2.3.0._

<!-- document id=81752e17e1a2bbe421779380081a72e20c56e1928d1f3c1f4ad4f807b9081229 url=/mulesoft/current/en-us/dataweave/2.11/dw-strings-functions-somecharacter.md -->

---
product: DataWeave
version: 2.11
---

# someCharacter

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## someCharacter(text: String, condition: (character: String) -> Boolean): Boolean

Checks whether a condition is valid for at least one of the characters or blank spaces in a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to check.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>Expression that iterates through the characters and spaces in the string and returns a Boolean value.</p></td></tr></tbody></table>

### Example

This example determines whether a string has any uppercase characters.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
"someCharacter" someCharacter isUpperCase($)
```

#### Output

```Json
true
```

## someCharacter(text: Null, condition: (character: Nothing) -> Any): false

Helper function that enables `someCharacter` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=ad8f2d1758d871e351ea58e3e36688b77f4d814c4f33eea01e9caac044a2ffde url=/mulesoft/current/en-us/dataweave/2.12/dw-strings-functions-somecharacter.md -->

---
product: DataWeave
version: 2.12
---

# someCharacter

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## someCharacter(text: String, condition: (character: String) -> Boolean): Boolean

Checks whether a condition is valid for at least one of the characters or blank spaces in a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to check.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>Expression that iterates through the characters and spaces in the string and returns a Boolean value.</p></td></tr></tbody></table>

### Example

This example determines whether a string has any uppercase characters.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
"someCharacter" someCharacter isUpperCase($)
```

#### Output

```Json
true
```

## someCharacter(text: Null, condition: (character: Nothing) -> Any): false

Helper function that enables `someCharacter` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=4cf089d79335093213cd4c7ce5e7cdf213e86897e962da88d6fa6d5264772728 url=/mulesoft/current/en-us/dataweave/2.4/dw-strings-functions-somecharacter.md -->

---
product: DataWeave
version: 2.4
---

# someCharacter

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## someCharacter(text: String, condition: (character: String) -> Boolean): Boolean

Checks whether a condition is valid for at least one of the characters or blank spaces in a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to check.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>Expression that iterates through the characters and spaces in the string and returns a Boolean value.</p></td></tr></tbody></table>

### Example

This example determines whether a string has any uppercase characters.

#### Source

```DataWeave
%dw 2.0
import someCharacter from dw::core::Strings
output application/json
---
"someCharacter" someCharacter isUpperCase($)
```

#### Output

```Json
true
```

## someCharacter(text: Null, condition: (character: Nothing) -> Any): false

Helper function that enables `someCharacter` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=3eac44467d9560e1808d5800d87018335b964c7d725b2ee88c01a9ec2cb4e151 url=/mulesoft/current/en-us/dataweave/2.6/dw-strings-functions-somecharacter.md -->

---
product: DataWeave
version: 2.6
---

# someCharacter

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## someCharacter(text: String, condition: (character: String) -> Boolean): Boolean

Checks whether a condition is valid for at least one of the characters or blank spaces in a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to check.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>Expression that iterates through the characters and spaces in the string and returns a Boolean value.</p></td></tr></tbody></table>

### Example

This example determines whether a string has any uppercase characters.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
"someCharacter" someCharacter isUpperCase($)
```

#### Output

```Json
true
```

## someCharacter(text: Null, condition: (character: Nothing) -> Any): false

Helper function that enables `someCharacter` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=6fbc9bd06bd7d9098f0183fdefaae545d677d5f0dbad4355183228124c9e1228 url=/mulesoft/current/en-us/dataweave/2.9/dw-strings-functions-somecharacter.md -->

---
product: DataWeave
version: 2.9
---

# someCharacter

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## someCharacter(text: String, condition: (character: String) -> Boolean): Boolean

Checks whether a condition is valid for at least one of the characters or blank spaces in a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to check.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>Expression that iterates through the characters and spaces in the string and returns a Boolean value.</p></td></tr></tbody></table>

### Example

This example determines whether a string has any uppercase characters.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
"someCharacter" someCharacter isUpperCase($)
```

#### Output

```Json
true
```

## someCharacter(text: Null, condition: (character: Nothing) -> Any): false

Helper function that enables `someCharacter` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=5622996b01e8efb406279576cd84174cb16268405b95cfd77c2a8f45344411df url=/mulesoft/current/en-us/dataweave/latest/dw-strings-functions-somecharacter.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# someCharacter

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## someCharacter(text: String, condition: (character: String) -> Boolean): Boolean

Checks whether a condition is valid for at least one of the characters or blank spaces in a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to check.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>Expression that iterates through the characters and spaces in the string and returns a Boolean value.</p></td></tr></tbody></table>

### Example

This example determines whether a string has any uppercase characters.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
"someCharacter" someCharacter isUpperCase($)
```

#### Output

```Json
true
```

## someCharacter(text: Null, condition: (character: Nothing) -> Any): false

Helper function that enables `someCharacter` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=8e249a922f860042ba6d6dab07cab49a030c243d6c34eefdbd06dcfa73cfe016 url=/mulesoft/current/en-us/dataweave/2.11/dw-objects-functions-someentry.md -->

---
product: DataWeave
version: 2.11
---

# someEntry

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## someEntry(obj: Object, condition: (value: Any, key: Key) -> Boolean): Boolean

Returns `true` if at least one entry in the object matches the specified condition.

The function stops iterating after the first element that matches the condition is found.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to evaluate.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition to use when evaluating elements in the object.</p></td></tr></tbody></table>

### Example

This example shows how the `someEntry` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import someEntry from dw::core::Objects
output application/json
---
{
    a: {} someEntry (value, key) -> value is String,
    b: {a: "", b: "123"} someEntry (value, key) -> value is String,
    c: {a: "", b: 123} someEntry (value, key) -> value is String,
    d: {a: "", b: 123} someEntry (value, key) -> key as String == "a",
    e: {a: ""} someEntry (value, key) -> key as String == "b",
    f: null someEntry (value, key) -> key as String == "a"
}
```

#### Output

```Json
{
  "a": false,
  "b": true,
  "c": true,
  "d": true,
  "e": false,
  "f": false
}
```

## someEntry(obj: Null, condition: (value: Nothing, key: Nothing) -> Boolean): Boolean

Helper function that enables `someEntry` to work with a `null` value.

_Introduced in DataWeave version 2.3.0._

<!-- document id=4e22501b4d409efdfd396d59db8df812ccd45963310bb5a1d5c7b6733a3bb167 url=/mulesoft/current/en-us/dataweave/2.12/dw-objects-functions-someentry.md -->

---
product: DataWeave
version: 2.12
---

# someEntry

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## someEntry(obj: Object, condition: (value: Any, key: Key) -> Boolean): Boolean

Returns `true` if at least one entry in the object matches the specified condition.

The function stops iterating after the first element that matches the condition is found.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to evaluate.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition to use when evaluating elements in the object.</p></td></tr></tbody></table>

### Example

This example shows how the `someEntry` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import someEntry from dw::core::Objects
output application/json
---
{
    a: {} someEntry (value, key) -> value is String,
    b: {a: "", b: "123"} someEntry (value, key) -> value is String,
    c: {a: "", b: 123} someEntry (value, key) -> value is String,
    d: {a: "", b: 123} someEntry (value, key) -> key as String == "a",
    e: {a: ""} someEntry (value, key) -> key as String == "b",
    f: null someEntry (value, key) -> key as String == "a"
}
```

#### Output

```Json
{
  "a": false,
  "b": true,
  "c": true,
  "d": true,
  "e": false,
  "f": false
}
```

## someEntry(obj: Null, condition: (value: Nothing, key: Nothing) -> Boolean): Boolean

Helper function that enables `someEntry` to work with a `null` value.

_Introduced in DataWeave version 2.3.0._

<!-- document id=4d25bd9e0cc35231e40292fad784d2e1536e50c94329bc425e2970db49be6990 url=/mulesoft/current/en-us/dataweave/2.3/dw-objects-functions-someentry.md -->

---
product: DataWeave
version: 2.3
---

# someEntry

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## someEntry(Object, (value: Any, key: Key) -> Boolean): Boolean

Returns `true` if at least one entry in the object matches the specified condition.

The function stops iterating after the first element that matches the condition is found.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to evaluate.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition to use when evaluating elements in the object.</p></td></tr></tbody></table>

### Example

This example shows how the `someEntry` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import someEntry from dw::core::Objects
output application/json
---
{
    a: {} someEntry (value, key) -> value is String,
    b: {a: "", b: "123"} someEntry (value, key) -> value is String,
    c: {a: "", b: 123} someEntry (value, key) -> value is String,
    d: {a: "", b: 123} someEntry (value, key) -> key as String == "a",
    e: {a: ""} someEntry (value, key) -> key as String == "b",
    f: null someEntry (value, key) -> key as String == "a"
}
```

#### Output

```Json
{
  "a": false,
  "b": true,
  "c": true,
  "d": true,
  "e": false,
  "f": false
}
```

## someEntry(Null, (value: Nothing, key: Nothing) -> Boolean): Boolean

Helper function that enables `someEntry` to work with a `null` value.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

<!-- document id=095a502bfc87cffa7a8148a41aed47560b5bef45a6d4f14434ffe2db372a55e5 url=/mulesoft/current/en-us/dataweave/2.4/dw-objects-functions-someentry.md -->

---
product: DataWeave
version: 2.4
---

# someEntry

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## someEntry(obj: Object, condition: (value: Any, key: Key) -> Boolean): Boolean

Returns `true` if at least one entry in the object matches the specified condition.

The function stops iterating after the first element that matches the condition is found.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to evaluate.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition to use when evaluating elements in the object.</p></td></tr></tbody></table>

### Example

This example shows how the `someEntry` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import someEntry from dw::core::Objects
output application/json
---
{
    a: {} someEntry (value, key) -> value is String,
    b: {a: "", b: "123"} someEntry (value, key) -> value is String,
    c: {a: "", b: 123} someEntry (value, key) -> value is String,
    d: {a: "", b: 123} someEntry (value, key) -> key as String == "a",
    e: {a: ""} someEntry (value, key) -> key as String == "b",
    f: null someEntry (value, key) -> key as String == "a"
}
```

#### Output

```Json
{
  "a": false,
  "b": true,
  "c": true,
  "d": true,
  "e": false,
  "f": false
}
```

## someEntry(obj: Null, condition: (value: Nothing, key: Nothing) -> Boolean): Boolean

Helper function that enables `someEntry` to work with a `null` value.

_Introduced in DataWeave version 2.3.0._

<!-- document id=404951696f6b4b407048eb0460d2a4732a98c54d65408135fcf95b843c0d7d9d url=/mulesoft/current/en-us/dataweave/2.6/dw-objects-functions-someentry.md -->

---
product: DataWeave
version: 2.6
---

# someEntry

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## someEntry(obj: Object, condition: (value: Any, key: Key) -> Boolean): Boolean

Returns `true` if at least one entry in the object matches the specified condition.

The function stops iterating after the first element that matches the condition is found.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to evaluate.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition to use when evaluating elements in the object.</p></td></tr></tbody></table>

### Example

This example shows how the `someEntry` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import someEntry from dw::core::Objects
output application/json
---
{
    a: {} someEntry (value, key) -> value is String,
    b: {a: "", b: "123"} someEntry (value, key) -> value is String,
    c: {a: "", b: 123} someEntry (value, key) -> value is String,
    d: {a: "", b: 123} someEntry (value, key) -> key as String == "a",
    e: {a: ""} someEntry (value, key) -> key as String == "b",
    f: null someEntry (value, key) -> key as String == "a"
}
```

#### Output

```Json
{
  "a": false,
  "b": true,
  "c": true,
  "d": true,
  "e": false,
  "f": false
}
```

## someEntry(obj: Null, condition: (value: Nothing, key: Nothing) -> Boolean): Boolean

Helper function that enables `someEntry` to work with a `null` value.

_Introduced in DataWeave version 2.3.0._

<!-- document id=d86a410ee57838009c8fa26df83e167620958ad94c4cb92b453a7a7fb1b62058 url=/mulesoft/current/en-us/dataweave/2.9/dw-objects-functions-someentry.md -->

---
product: DataWeave
version: 2.9
---

# someEntry

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## someEntry(obj: Object, condition: (value: Any, key: Key) -> Boolean): Boolean

Returns `true` if at least one entry in the object matches the specified condition.

The function stops iterating after the first element that matches the condition is found.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to evaluate.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition to use when evaluating elements in the object.</p></td></tr></tbody></table>

### Example

This example shows how the `someEntry` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import someEntry from dw::core::Objects
output application/json
---
{
    a: {} someEntry (value, key) -> value is String,
    b: {a: "", b: "123"} someEntry (value, key) -> value is String,
    c: {a: "", b: 123} someEntry (value, key) -> value is String,
    d: {a: "", b: 123} someEntry (value, key) -> key as String == "a",
    e: {a: ""} someEntry (value, key) -> key as String == "b",
    f: null someEntry (value, key) -> key as String == "a"
}
```

#### Output

```Json
{
  "a": false,
  "b": true,
  "c": true,
  "d": true,
  "e": false,
  "f": false
}
```

## someEntry(obj: Null, condition: (value: Nothing, key: Nothing) -> Boolean): Boolean

Helper function that enables `someEntry` to work with a `null` value.

_Introduced in DataWeave version 2.3.0._

<!-- document id=e1cafcbf59bff8d06ac77dd2e8008b1097c148a2da4a93df0d8c9cf599eadf2c url=/mulesoft/current/en-us/dataweave/latest/dw-objects-functions-someentry.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# someEntry

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## someEntry(obj: Object, condition: (value: Any, key: Key) -> Boolean): Boolean

Returns `true` if at least one entry in the object matches the specified condition.

The function stops iterating after the first element that matches the condition is found.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to evaluate.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition to use when evaluating elements in the object.</p></td></tr></tbody></table>

### Example

This example shows how the `someEntry` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import someEntry from dw::core::Objects
output application/json
---
{
    a: {} someEntry (value, key) -> value is String,
    b: {a: "", b: "123"} someEntry (value, key) -> value is String,
    c: {a: "", b: 123} someEntry (value, key) -> value is String,
    d: {a: "", b: 123} someEntry (value, key) -> key as String == "a",
    e: {a: ""} someEntry (value, key) -> key as String == "b",
    f: null someEntry (value, key) -> key as String == "a"
}
```

#### Output

```Json
{
  "a": false,
  "b": true,
  "c": true,
  "d": true,
  "e": false,
  "f": false
}
```

## someEntry(obj: Null, condition: (value: Nothing, key: Nothing) -> Boolean): Boolean

Helper function that enables `someEntry` to work with a `null` value.

_Introduced in DataWeave version 2.3.0._

<!-- document id=ce48817e78ad95a92ca1d35f5bc126fd5dbaee4759e58fae11a6543d66957884 url=/mulesoft/current/en-us/dataweave/2.11/dw-arrays-functions-splitat.md -->

---
product: DataWeave
version: 2.11
---

# splitAt

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## splitAt<T>(array: Array<T>, n: Number): Pair<Array<T>, Array<T>>

Splits an array into two at a given position.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>n</code></p></td><td><p>The index at which to split the array.</p></td></tr></tbody></table>

### Example

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var users = ["Mariano", "Leandro", "Julian"]
---
users splitAt 1
```

#### Output

```json
{
  "l": ["Mariano"],
  "r": ["Leandro", "Julian"]
}
```

## splitAt(array: Null, n: Any): Null

Helper function that enables `splitAt` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=fee73fd4627e379e1dd1e364b3e2abcb670a20f3b030859bff99bf617e281db6 url=/mulesoft/current/en-us/dataweave/2.12/dw-arrays-functions-splitat.md -->

---
product: DataWeave
version: 2.12
---

# splitAt

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## splitAt<T>(array: Array<T>, n: Number): Pair<Array<T>, Array<T>>

Splits an array into two at a given position.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>n</code></p></td><td><p>The index at which to split the array.</p></td></tr></tbody></table>

### Example

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var users = ["Mariano", "Leandro", "Julian"]
---
users splitAt 1
```

#### Output

```json
{
  "l": ["Mariano"],
  "r": ["Leandro", "Julian"]
}
```

## splitAt(array: Null, n: Any): Null

Helper function that enables `splitAt` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=2146b3f3abf2a0c2355716cc5175317a0a99d478e609bab86b61eb87bef644ee url=/mulesoft/current/en-us/dataweave/2.3/dw-arrays-functions-splitat.md -->

---
product: DataWeave
version: 2.3
---

# splitAt

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## splitAt(Array<T>, Number): Pair<Array<T>, Array<T>>

Splits an array into two at a given position.

_Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>n</code></p></td><td><p>The index at which to split the array.</p></td></tr></tbody></table>

### Example

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var users = ["Mariano", "Leandro", "Julian"]
---
users splitAt 1
```

#### Output

```json
{
  "l": ["Mariano"],
  "r": ["Leandro", "Julian"]
}
```

<!-- document id=794c784178e63f22bb2806bd92955c0a1c09897a85ff52d8985374cb4641df36 url=/mulesoft/current/en-us/dataweave/2.4/dw-arrays-functions-splitat.md -->

---
product: DataWeave
version: 2.4
---

# splitAt

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## splitAt<T>(array: Array<T>, n: Number): Pair<Array<T>, Array<T>>

Splits an array into two at a given position.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>n</code></p></td><td><p>The index at which to split the array.</p></td></tr></tbody></table>

### Example

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var users = ["Mariano", "Leandro", "Julian"]
---
users splitAt 1
```

#### Output

```json
{
  "l": ["Mariano"],
  "r": ["Leandro", "Julian"]
}
```

## splitAt(array: Null, n: Any): Null

Helper function that enables `splitAt` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=78a71f01fb1ce437180e1fd3935cb19436b73ea5080a54e0e5ba0e73a8b3e817 url=/mulesoft/current/en-us/dataweave/2.6/dw-arrays-functions-splitat.md -->

---
product: DataWeave
version: 2.6
---

# splitAt

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## splitAt<T>(array: Array<T>, n: Number): Pair<Array<T>, Array<T>>

Splits an array into two at a given position.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>n</code></p></td><td><p>The index at which to split the array.</p></td></tr></tbody></table>

### Example

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var users = ["Mariano", "Leandro", "Julian"]
---
users splitAt 1
```

#### Output

```json
{
  "l": ["Mariano"],
  "r": ["Leandro", "Julian"]
}
```

## splitAt(array: Null, n: Any): Null

Helper function that enables `splitAt` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=5dae3955f75d41ba6902628d5d093d5c757c3c7d716a3b03b5f3a93a33901388 url=/mulesoft/current/en-us/dataweave/2.9/dw-arrays-functions-splitat.md -->

---
product: DataWeave
version: 2.9
---

# splitAt

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## splitAt<T>(array: Array<T>, n: Number): Pair<Array<T>, Array<T>>

Splits an array into two at a given position.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>n</code></p></td><td><p>The index at which to split the array.</p></td></tr></tbody></table>

### Example

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var users = ["Mariano", "Leandro", "Julian"]
---
users splitAt 1
```

#### Output

```json
{
  "l": ["Mariano"],
  "r": ["Leandro", "Julian"]
}
```

## splitAt(array: Null, n: Any): Null

Helper function that enables `splitAt` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=4b70b39ae564168393276e5c7f75fa246dab8abec6b728501b6e394b0f99cb87 url=/mulesoft/current/en-us/dataweave/latest/dw-arrays-functions-splitat.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# splitAt

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## splitAt<T>(array: Array<T>, n: Number): Pair<Array<T>, Array<T>>

Splits an array into two at a given position.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>n</code></p></td><td><p>The index at which to split the array.</p></td></tr></tbody></table>

### Example

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var users = ["Mariano", "Leandro", "Julian"]
---
users splitAt 1
```

#### Output

```json
{
  "l": ["Mariano"],
  "r": ["Leandro", "Julian"]
}
```

## splitAt(array: Null, n: Any): Null

Helper function that enables `splitAt` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=34dfc1b2b8c97413d7ea112f98617222d06f035b47d06d5d852ed81e0b889e06 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-splitby.md -->

---
product: DataWeave
version: 2.11
---

# splitBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## splitBy(text: String, regex: Regex): Array<String>

Splits a string into a string array based on a value that matches part of that string. It filters
out the matching part from the returned array.

This version of `splitBy` accepts a Java regular expression (regex) to match the input string. The
regex can match any character in the input string. Note that `splitBy` performs the opposite
operation of `joinBy`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string to split.</p></td></tr><tr><td><p><code>regex</code></p></td><td><p>A Java regular expression used to split the string. If it does not match some part of the string, the function will return the original, unsplit string in the array.</p></td></tr></tbody></table>

### Example

This example uses a Java regular expression to split an address block by the periods and forward
slash in it. Notice that the regular expression goes between forward slashes.

#### Source

```DataWeave
%dw 2.0
output application/json
---
"192.88.99.0/24" splitBy(/[.\/]/)
```

#### Output

```JSON
["192", "88", "99", "0", "24"]
```

### Example

This example uses several regular expressions to split input strings. The first uses `/.b./` to
split the string by `-b-`. The second uses `/\s/` to split by a space. The third example returns the
original input string in an array (`[ "no match"]`) because the regex `/^s/` (for matching the first
character if it is `s`) does not match the first character in the input string (`"no match"`). The
fourth, which uses `/^n../`, matches the first characters in `"no match"`, so it returns
`[ "", "match"]`. The last removes all numbers and capital letters from a string, leaving each of
the lower case letters in the array. Notice that the separator is omitted from the output.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "splitters" : {
   "split1" : "a-b-c" splitBy(/.b./),
   "split2" : "hello world" splitBy(/\s/),
   "split3" : "no match" splitBy(/^s/),
   "split4" : "no match" splitBy(/^n../),
   "split5" : "a1b2c3d4A1B2C3D" splitBy(/[0-9A-Z]/)
  }
}
```

#### Output

```JSON
{
  splitters: {
    split1: [ "a", "c" ],
    split2: [ "hello", "world" ],
    split3: [ "no match" ],
    split4: [ "", "match" ],
    split5: [ "a", "b", "c", "d" ]
  }
}
```

### Example

This example splits the number by `.` and applies the index selector `[0]` to the result of the
splitBy function. The splitBy returns `["192", "88", "99", "0"]` so the index \* selector `[0]` just
returns the first element in the array ("192").

#### Source

```DataWeave
%dw 2.0
output application/json
---
("192.88.99.0" splitBy("."))[0]
```

#### Output

```JSON
"192"
```

### Example

This example uses a Java regular expression to split a string by `.` at every point the input string
matches the regex. Note that the regular expression does not consider the periods between the
backticks `` ` ``.

#### Source

```DataWeave
%dw 2.0
output application/json
---
'root.sources.data.`test.branch.BranchSource`.source.traits' splitBy(/[.](?=(?:[^`]*`[^`]*`)*[^`]*$)/)
```

#### Output

```JSON
[
 "root",
 "sources",
 "data",
 "`test.branch.BranchSource`",
 "source",
 "traits"
]
```

## splitBy(text: String, separator: String): Array<String>

Splits a string into a string array based on a separating string that matches part of the input
string. It also filters out the matching string from the returned array.

The separator can match any character in the input. Note that `splitBy` performs the opposite
operation of `joinBy`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to split.</p></td></tr><tr><td><p><code>separator</code></p></td><td><p>A string used to separate the input string. If it does not match some part of the string, the function will return the original, unsplit string in the array.</p></td></tr></tbody></table>

### Example

This example splits a string containing an IP address by its periods.

#### Source

```DataWeave
%dw 2.0
output application/json
---
"192.88.99.0" splitBy(".")
```

#### Output

```JSON
["192", "88", "99", "0"]
```

### Example

The first example (`splitter1`) uses a hyphen (`-`) in `"a-b-c"` to split the string. The second
uses an empty string (`""`) to split each character (including the blank space) in the string. The
third example splits based on a comma (`,`) in the input string. The last example does not split the
input because the function is case sensitive, so the upper case `NO` does not match the lower case
`no` in the input string. Notice that the separator is omitted from the output.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "splitters" : {
    "split1" : "a-b-c" splitBy("-"),
    "split2" : "hello world" splitBy(""),
    "split3" : "first,middle,last" splitBy(","),
    "split4" : "no split" splitBy("NO")
   }
}
```

#### Output

```JSON
{
  splitters: {
    split1: [ "a","b","c" ],
    split2: [ "h","e","l","l","o","","w","o","r","l","d" ],
    split3: [ "first","middle","last"],
    split4: [ "no split"]
  }
}
```

## splitBy(text: Null, separator: Any)

Helper function that enables `splitBy` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=774bf2d5fe9dc4bd34ec1e7fd6f1bcaf228a0254c7f407a88ad19ff3f1922e06 url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-splitby.md -->

---
product: DataWeave
version: 2.12
---

# splitBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## splitBy(text: String, regex: Regex): Array<String>

Splits a string into a string array based on a value that matches part of that string. It filters
out the matching part from the returned array.

This version of `splitBy` accepts a Java regular expression (regex) to match the input string. The
regex can match any character in the input string. Note that `splitBy` performs the opposite
operation of `joinBy`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string to split.</p></td></tr><tr><td><p><code>regex</code></p></td><td><p>A Java regular expression used to split the string. If it does not match some part of the string, the function will return the original, unsplit string in the array.</p></td></tr></tbody></table>

### Example

This example uses a Java regular expression to split an address block by the periods and forward
slash in it. Notice that the regular expression goes between forward slashes.

#### Source

```DataWeave
%dw 2.0
output application/json
---
"192.88.99.0/24" splitBy(/[.\/]/)
```

#### Output

```JSON
["192", "88", "99", "0", "24"]
```

### Example

This example uses several regular expressions to split input strings. The first uses `/.b./` to
split the string by `-b-`. The second uses `/\s/` to split by a space. The third example returns the
original input string in an array (`[ "no match"]`) because the regex `/^s/` (for matching the first
character if it is `s`) does not match the first character in the input string (`"no match"`). The
fourth, which uses `/^n../`, matches the first characters in `"no match"`, so it returns
`[ "", "match"]`. The last removes all numbers and capital letters from a string, leaving each of
the lower case letters in the array. Notice that the separator is omitted from the output.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "splitters" : {
   "split1" : "a-b-c" splitBy(/.b./),
   "split2" : "hello world" splitBy(/\s/),
   "split3" : "no match" splitBy(/^s/),
   "split4" : "no match" splitBy(/^n../),
   "split5" : "a1b2c3d4A1B2C3D" splitBy(/[0-9A-Z]/)
  }
}
```

#### Output

```JSON
{
  splitters: {
    split1: [ "a", "c" ],
    split2: [ "hello", "world" ],
    split3: [ "no match" ],
    split4: [ "", "match" ],
    split5: [ "a", "b", "c", "d" ]
  }
}
```

### Example

This example splits the number by `.` and applies the index selector `[0]` to the result of the
splitBy function. The splitBy returns `["192", "88", "99", "0"]` so the index \* selector `[0]` just
returns the first element in the array ("192").

#### Source

```DataWeave
%dw 2.0
output application/json
---
("192.88.99.0" splitBy("."))[0]
```

#### Output

```JSON
"192"
```

### Example

This example uses a Java regular expression to split a string by `.` at every point the input string
matches the regex. Note that the regular expression does not consider the periods between the
backticks `` ` ``.

#### Source

```DataWeave
%dw 2.0
output application/json
---
'root.sources.data.`test.branch.BranchSource`.source.traits' splitBy(/[.](?=(?:[^`]*`[^`]*`)*[^`]*$)/)
```

#### Output

```JSON
[
 "root",
 "sources",
 "data",
 "`test.branch.BranchSource`",
 "source",
 "traits"
]
```

## splitBy(text: String, separator: String): Array<String>

Splits a string into a string array based on a separating string that matches part of the input
string. It also filters out the matching string from the returned array.

The separator can match any character in the input. Note that `splitBy` performs the opposite
operation of `joinBy`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to split.</p></td></tr><tr><td><p><code>separator</code></p></td><td><p>A string used to separate the input string. If it does not match some part of the string, the function will return the original, unsplit string in the array.</p></td></tr></tbody></table>

### Example

This example splits a string containing an IP address by its periods.

#### Source

```DataWeave
%dw 2.0
output application/json
---
"192.88.99.0" splitBy(".")
```

#### Output

```JSON
["192", "88", "99", "0"]
```

### Example

The first example (`splitter1`) uses a hyphen (`-`) in `"a-b-c"` to split the string. The second
uses an empty string (`""`) to split each character (including the blank space) in the string. The
third example splits based on a comma (`,`) in the input string. The last example does not split the
input because the function is case sensitive, so the upper case `NO` does not match the lower case
`no` in the input string. Notice that the separator is omitted from the output.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "splitters" : {
    "split1" : "a-b-c" splitBy("-"),
    "split2" : "hello world" splitBy(""),
    "split3" : "first,middle,last" splitBy(","),
    "split4" : "no split" splitBy("NO")
   }
}
```

#### Output

```JSON
{
  splitters: {
    split1: [ "a","b","c" ],
    split2: [ "h","e","l","l","o","","w","o","r","l","d" ],
    split3: [ "first","middle","last"],
    split4: [ "no split"]
  }
}
```

## splitBy(text: Null, separator: Any)

Helper function that enables `splitBy` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=edae557912ec01f46ec606996a6978dae5822f15996212fae1c8e67cb4c431ce url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-splitby.md -->

---
product: DataWeave
version: 2.3
---

# splitBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## splitBy(String, Regex): Array<String>

Splits a string into a string array based on a value that matches part of that string. It filters
out the matching part from the returned array.

This version of `splitBy` accepts a Java regular expression (regex) to match the input string. The
regex can match any character in the input string. Note that `splitBy` performs the opposite
operation of `joinBy`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string to split.</p></td></tr><tr><td><p><code>regex</code></p></td><td><p>A Java regular expression used to split the string. If it does not match some part of the string, the function will return the original, unsplit string in the array.</p></td></tr></tbody></table>

### Example

This example uses a Java regular expression to split an address block by the periods and forward
slash in it. Notice that the regular expression goes between forward slashes.

#### Source

```DataWeave
%dw 2.0
output application/json
---
"192.88.99.0/24" splitBy(/[.\/]/)
```

#### Output

```JSON
["192", "88", "99", "0", "24"]
```

### Example

This example uses several regular expressions to split input strings. The first uses `\/^*.b./\` to
split the string by `-b-`. The second uses `/\s/` to split by a space. The third example returns the
original input string in an array (`[ "no match"]`) because the regex `/^s/` (for matching the first
character if it is `s`) does not match the first character in the input string (`"no match"`). The
fourth, which uses `/^n../`, matches the first characters in `"no match"`, so it returns
`[ "", "match"]`. The last removes all numbers and capital letters from a string, leaving each of
the lower case letters in the array. Notice that the separator is omitted from the output.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "splitters" : {
   "split1" : "a-b-c" splitBy(/^*.b./),
   "split2" : "hello world" splitBy(/\s/),
   "split3" : "no match" splitBy(/^s/),
   "split4" : "no match" splitBy(/^n../),
   "split5" : "a1b2c3d4A1B2C3D" splitBy(/^*[0-9A-Z]/)
  }
}
```

#### Output

```JSON
{
  splitters: {
    split1: [ "a", "c" ],
    split2: [ "hello", "world" ],
    split3: [ "no match" ],
    split4: [ "", "match" ],
    split5: [ "a", "b", "c", "d" ]
  }
}
```

### Example

This example splits the number by `.` and applies the index selector `[0]` to the result of the
splitBy function. The splitBy returns `["192", "88", "99", "0"]` so the index selector `[0]` just
returns the first element in the array ("192").

#### Source

```DataWeave
%dw 2.0
output application/json
---
("192.88.99.0" splitBy("."))[0]
```

#### Output

```JSON
"192"
```

### Example

This example uses a Java regular expression to split a string by `.` at every point the input string
matches the regex. Note that the regular expression does not consider the periods between the
backticks `` ` ``.

#### Source

```DataWeave
%dw 2.0
output application/json
---
'root.sources.data.`test.branch.BranchSource`.source.traits' splitBy(/[.](?=(?:[^`]*`[^`]*`)*[^`]*$)/)
```

#### Output

```JSON
[
  "root",
  "sources",
  "data",
  "`test.branch.BranchSource`",
  "source",
  "traits"
]
```

## splitBy(String, String): Array<String>

Splits a string into a string array based on a separating string that matches part of the input
string. It also filters out the matching string from the returned array.

The separator can match any character in the input. Note that `splitBy` performs the opposite
operation of `joinBy`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to split.</p></td></tr><tr><td><p><code>separator</code></p></td><td><p>A string used to separate the input string. If it does not match some part of the string, the function will return the original, unsplit string in the array.</p></td></tr></tbody></table>

### Example

This example splits a string containing an IP address by its periods.

#### Source

```DataWeave
%dw 2.0
output application/json
---
"192.88.99.0" splitBy(".")
```

#### Output

```JSON
["192", "88", "99", "0"]
```

### Example

The first example (`splitter1`) uses a hyphen (`-`) in `"a-b-c"` to split the string. The second
uses an empty string (`""`) to split each character (including the blank space) in the string. The
third example splits based on a comma (`,`) in the input string. The last example does not split the
input because the function is case sensitive, so the upper case `NO` does not match the lower case
`no` in the input string. Notice that the separator is omitted from the output.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "splitters" : {
    "split1" : "a-b-c" splitBy("-"),
    "split2" : "hello world" splitBy(""),
    "split3" : "first,middle,last" splitBy(","),
    "split4" : "no split" splitBy("NO")
   }
}
```

#### Output

```JSON
{
  splitters: {
    split1: [ "a","b","c" ],
    split2: [ "h","e","l","l","o","","w","o","r","l","d" ],
    split3: [ "first","middle","last"],
    split4: [ "no split"]
  }
}
```

<!-- document id=ddfd705b2c5fa02b9188c23f36412f8e6843b4a2ac2bc19529d0c6f6e7605254 url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-splitby.md -->

---
product: DataWeave
version: 2.4
---

# splitBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## splitBy(text: String, regex: Regex): Array<String>

Splits a string into a string array based on a value that matches part of that string. It filters
out the matching part from the returned array.

This version of `splitBy` accepts a Java regular expression (regex) to match the input string. The
regex can match any character in the input string. Note that `splitBy` performs the opposite
operation of `joinBy`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string to split.</p></td></tr><tr><td><p><code>regex</code></p></td><td><p>A Java regular expression used to split the string. If it does not match some part of the string, the function will return the original, unsplit string in the array.</p></td></tr></tbody></table>

### Example

This example uses a Java regular expression to split an address block by the periods and forward
slash in it. Notice that the regular expression goes between forward slashes.

#### Source

```DataWeave
%dw 2.0
output application/json
---
"192.88.99.0/24" splitBy(/[.\/]/)
```

#### Output

```JSON
["192", "88", "99", "0", "24"]
```

### Example

This example uses several regular expressions to split input strings. The first uses `/.b./` to
split the string by `-b-`. The second uses `/\s/` to split by a space. The third example returns the
original input string in an array (`[ "no match"]`) because the regex `/^s/` (for matching the first
character if it is `s`) does not match the first character in the input string (`"no match"`). The
fourth, which uses `/^n../`, matches the first characters in `"no match"`, so it returns
`[ "", "match"]`. The last removes all numbers and capital letters from a string, leaving each of
the lower case letters in the array. Notice that the separator is omitted from the output.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "splitters" : {
   "split1" : "a-b-c" splitBy(/.b./),
   "split2" : "hello world" splitBy(/\s/),
   "split3" : "no match" splitBy(/^s/),
   "split4" : "no match" splitBy(/^n../),
   "split5" : "a1b2c3d4A1B2C3D" splitBy(/[0-9A-Z]/)
  }
}
```

#### Output

```JSON
{
  splitters: {
    split1: [ "a", "c" ],
    split2: [ "hello", "world" ],
    split3: [ "no match" ],
    split4: [ "", "match" ],
    split5: [ "a", "b", "c", "d" ]
  }
}
```

### Example

This example splits the number by `.` and applies the index selector `[0]` to the result of the
splitBy function. The splitBy returns `["192", "88", "99", "0"]` so the index \* selector `[0]` just
returns the first element in the array ("192").

#### Source

```DataWeave
%dw 2.0
output application/json
---
("192.88.99.0" splitBy("."))[0]
```

#### Output

```JSON
"192"
```

### Example

This example uses a Java regular expression to split a string by `.` at every point the input string
matches the regex. Note that the regular expression does not consider the periods between the
backticks `` ` ``.

#### Source

```DataWeave
%dw 2.0
output application/json
---
'root.sources.data.`test.branch.BranchSource`.source.traits' splitBy(/[.](?=(?:[^`]*`[^`]*`)*[^`]*$)/)
```

#### Output

```JSON
[
 "root",
 "sources",
 "data",
 "`test.branch.BranchSource`",
 "source",
 "traits"
]
```

## splitBy(text: String, separator: String): Array<String>

Splits a string into a string array based on a separating string that matches part of the input
string. It also filters out the matching string from the returned array.

The separator can match any character in the input. Note that `splitBy` performs the opposite
operation of `joinBy`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to split.</p></td></tr><tr><td><p><code>separator</code></p></td><td><p>A string used to separate the input string. If it does not match some part of the string, the function will return the original, unsplit string in the array.</p></td></tr></tbody></table>

### Example

This example splits a string containing an IP address by its periods.

#### Source

```DataWeave
%dw 2.0
output application/json
---
"192.88.99.0" splitBy(".")
```

#### Output

```JSON
["192", "88", "99", "0"]
```

### Example

The first example (`splitter1`) uses a hyphen (`-`) in `"a-b-c"` to split the string. The second
uses an empty string (`""`) to split each character (including the blank space) in the string. The
third example splits based on a comma (`,`) in the input string. The last example does not split the
input because the function is case sensitive, so the upper case `NO` does not match the lower case
`no` in the input string. Notice that the separator is omitted from the output.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "splitters" : {
    "split1" : "a-b-c" splitBy("-"),
    "split2" : "hello world" splitBy(""),
    "split3" : "first,middle,last" splitBy(","),
    "split4" : "no split" splitBy("NO")
   }
}
```

#### Output

```JSON
{
  splitters: {
    split1: [ "a","b","c" ],
    split2: [ "h","e","l","l","o","","w","o","r","l","d" ],
    split3: [ "first","middle","last"],
    split4: [ "no split"]
  }
}
```

## splitBy(text: Null, separator: Any)

Helper function that enables `splitBy` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=3483ecb1ded976261844e9ad4509cb6ce4b43aa65e4766f49d6e41842446d58d url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-splitby.md -->

---
product: DataWeave
version: 2.6
---

# splitBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## splitBy(text: String, regex: Regex): Array<String>

Splits a string into a string array based on a value that matches part of that string. It filters
out the matching part from the returned array.

This version of `splitBy` accepts a Java regular expression (regex) to match the input string. The
regex can match any character in the input string. Note that `splitBy` performs the opposite
operation of `joinBy`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string to split.</p></td></tr><tr><td><p><code>regex</code></p></td><td><p>A Java regular expression used to split the string. If it does not match some part of the string, the function will return the original, unsplit string in the array.</p></td></tr></tbody></table>

### Example

This example uses a Java regular expression to split an address block by the periods and forward
slash in it. Notice that the regular expression goes between forward slashes.

#### Source

```DataWeave
%dw 2.0
output application/json
---
"192.88.99.0/24" splitBy(/[.\/]/)
```

#### Output

```JSON
["192", "88", "99", "0", "24"]
```

### Example

This example uses several regular expressions to split input strings. The first uses `/.b./` to
split the string by `-b-`. The second uses `/\s/` to split by a space. The third example returns the
original input string in an array (`[ "no match"]`) because the regex `/^s/` (for matching the first
character if it is `s`) does not match the first character in the input string (`"no match"`). The
fourth, which uses `/^n../`, matches the first characters in `"no match"`, so it returns
`[ "", "match"]`. The last removes all numbers and capital letters from a string, leaving each of
the lower case letters in the array. Notice that the separator is omitted from the output.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "splitters" : {
   "split1" : "a-b-c" splitBy(/.b./),
   "split2" : "hello world" splitBy(/\s/),
   "split3" : "no match" splitBy(/^s/),
   "split4" : "no match" splitBy(/^n../),
   "split5" : "a1b2c3d4A1B2C3D" splitBy(/[0-9A-Z]/)
  }
}
```

#### Output

```JSON
{
  splitters: {
    split1: [ "a", "c" ],
    split2: [ "hello", "world" ],
    split3: [ "no match" ],
    split4: [ "", "match" ],
    split5: [ "a", "b", "c", "d" ]
  }
}
```

### Example

This example splits the number by `.` and applies the index selector `[0]` to the result of the
splitBy function. The splitBy returns `["192", "88", "99", "0"]` so the index \* selector `[0]` just
returns the first element in the array ("192").

#### Source

```DataWeave
%dw 2.0
output application/json
---
("192.88.99.0" splitBy("."))[0]
```

#### Output

```JSON
"192"
```

### Example

This example uses a Java regular expression to split a string by `.` at every point the input string
matches the regex. Note that the regular expression does not consider the periods between the
backticks `` ` ``.

#### Source

```DataWeave
%dw 2.0
output application/json
---
'root.sources.data.`test.branch.BranchSource`.source.traits' splitBy(/[.](?=(?:[^`]*`[^`]*`)*[^`]*$)/)
```

#### Output

```JSON
[
 "root",
 "sources",
 "data",
 "`test.branch.BranchSource`",
 "source",
 "traits"
]
```

## splitBy(text: String, separator: String): Array<String>

Splits a string into a string array based on a separating string that matches part of the input
string. It also filters out the matching string from the returned array.

The separator can match any character in the input. Note that `splitBy` performs the opposite
operation of `joinBy`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to split.</p></td></tr><tr><td><p><code>separator</code></p></td><td><p>A string used to separate the input string. If it does not match some part of the string, the function will return the original, unsplit string in the array.</p></td></tr></tbody></table>

### Example

This example splits a string containing an IP address by its periods.

#### Source

```DataWeave
%dw 2.0
output application/json
---
"192.88.99.0" splitBy(".")
```

#### Output

```JSON
["192", "88", "99", "0"]
```

### Example

The first example (`splitter1`) uses a hyphen (`-`) in `"a-b-c"` to split the string. The second
uses an empty string (`""`) to split each character (including the blank space) in the string. The
third example splits based on a comma (`,`) in the input string. The last example does not split the
input because the function is case sensitive, so the upper case `NO` does not match the lower case
`no` in the input string. Notice that the separator is omitted from the output.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "splitters" : {
    "split1" : "a-b-c" splitBy("-"),
    "split2" : "hello world" splitBy(""),
    "split3" : "first,middle,last" splitBy(","),
    "split4" : "no split" splitBy("NO")
   }
}
```

#### Output

```JSON
{
  splitters: {
    split1: [ "a","b","c" ],
    split2: [ "h","e","l","l","o","","w","o","r","l","d" ],
    split3: [ "first","middle","last"],
    split4: [ "no split"]
  }
}
```

## splitBy(text: Null, separator: Any)

Helper function that enables `splitBy` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=3a997b6c64c881b3be255f0787142035e2476e92d07f00cdf7eb33ab0804f96c url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-splitby.md -->

---
product: DataWeave
version: 2.9
---

# splitBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## splitBy(text: String, regex: Regex): Array<String>

Splits a string into a string array based on a value that matches part of that string. It filters
out the matching part from the returned array.

This version of `splitBy` accepts a Java regular expression (regex) to match the input string. The
regex can match any character in the input string. Note that `splitBy` performs the opposite
operation of `joinBy`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string to split.</p></td></tr><tr><td><p><code>regex</code></p></td><td><p>A Java regular expression used to split the string. If it does not match some part of the string, the function will return the original, unsplit string in the array.</p></td></tr></tbody></table>

### Example

This example uses a Java regular expression to split an address block by the periods and forward
slash in it. Notice that the regular expression goes between forward slashes.

#### Source

```DataWeave
%dw 2.0
output application/json
---
"192.88.99.0/24" splitBy(/[.\/]/)
```

#### Output

```JSON
["192", "88", "99", "0", "24"]
```

### Example

This example uses several regular expressions to split input strings. The first uses `/.b./` to
split the string by `-b-`. The second uses `/\s/` to split by a space. The third example returns the
original input string in an array (`[ "no match"]`) because the regex `/^s/` (for matching the first
character if it is `s`) does not match the first character in the input string (`"no match"`). The
fourth, which uses `/^n../`, matches the first characters in `"no match"`, so it returns
`[ "", "match"]`. The last removes all numbers and capital letters from a string, leaving each of
the lower case letters in the array. Notice that the separator is omitted from the output.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "splitters" : {
   "split1" : "a-b-c" splitBy(/.b./),
   "split2" : "hello world" splitBy(/\s/),
   "split3" : "no match" splitBy(/^s/),
   "split4" : "no match" splitBy(/^n../),
   "split5" : "a1b2c3d4A1B2C3D" splitBy(/[0-9A-Z]/)
  }
}
```

#### Output

```JSON
{
  splitters: {
    split1: [ "a", "c" ],
    split2: [ "hello", "world" ],
    split3: [ "no match" ],
    split4: [ "", "match" ],
    split5: [ "a", "b", "c", "d" ]
  }
}
```

### Example

This example splits the number by `.` and applies the index selector `[0]` to the result of the
splitBy function. The splitBy returns `["192", "88", "99", "0"]` so the index \* selector `[0]` just
returns the first element in the array ("192").

#### Source

```DataWeave
%dw 2.0
output application/json
---
("192.88.99.0" splitBy("."))[0]
```

#### Output

```JSON
"192"
```

### Example

This example uses a Java regular expression to split a string by `.` at every point the input string
matches the regex. Note that the regular expression does not consider the periods between the
backticks `` ` ``.

#### Source

```DataWeave
%dw 2.0
output application/json
---
'root.sources.data.`test.branch.BranchSource`.source.traits' splitBy(/[.](?=(?:[^`]*`[^`]*`)*[^`]*$)/)
```

#### Output

```JSON
[
 "root",
 "sources",
 "data",
 "`test.branch.BranchSource`",
 "source",
 "traits"
]
```

## splitBy(text: String, separator: String): Array<String>

Splits a string into a string array based on a separating string that matches part of the input
string. It also filters out the matching string from the returned array.

The separator can match any character in the input. Note that `splitBy` performs the opposite
operation of `joinBy`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to split.</p></td></tr><tr><td><p><code>separator</code></p></td><td><p>A string used to separate the input string. If it does not match some part of the string, the function will return the original, unsplit string in the array.</p></td></tr></tbody></table>

### Example

This example splits a string containing an IP address by its periods.

#### Source

```DataWeave
%dw 2.0
output application/json
---
"192.88.99.0" splitBy(".")
```

#### Output

```JSON
["192", "88", "99", "0"]
```

### Example

The first example (`splitter1`) uses a hyphen (`-`) in `"a-b-c"` to split the string. The second
uses an empty string (`""`) to split each character (including the blank space) in the string. The
third example splits based on a comma (`,`) in the input string. The last example does not split the
input because the function is case sensitive, so the upper case `NO` does not match the lower case
`no` in the input string. Notice that the separator is omitted from the output.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "splitters" : {
    "split1" : "a-b-c" splitBy("-"),
    "split2" : "hello world" splitBy(""),
    "split3" : "first,middle,last" splitBy(","),
    "split4" : "no split" splitBy("NO")
   }
}
```

#### Output

```JSON
{
  splitters: {
    split1: [ "a","b","c" ],
    split2: [ "h","e","l","l","o","","w","o","r","l","d" ],
    split3: [ "first","middle","last"],
    split4: [ "no split"]
  }
}
```

## splitBy(text: Null, separator: Any)

Helper function that enables `splitBy` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=9682496de8305c52328d2542e220717a7b2661a2efcfdae5947cc33188864b92 url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-splitby.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# splitBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## splitBy(text: String, regex: Regex): Array<String>

Splits a string into a string array based on a value that matches part of that string. It filters
out the matching part from the returned array.

This version of `splitBy` accepts a Java regular expression (regex) to match the input string. The
regex can match any character in the input string. Note that `splitBy` performs the opposite
operation of `joinBy`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string to split.</p></td></tr><tr><td><p><code>regex</code></p></td><td><p>A Java regular expression used to split the string. If it does not match some part of the string, the function will return the original, unsplit string in the array.</p></td></tr></tbody></table>

### Example

This example uses a Java regular expression to split an address block by the periods and forward
slash in it. Notice that the regular expression goes between forward slashes.

#### Source

```DataWeave
%dw 2.0
output application/json
---
"192.88.99.0/24" splitBy(/[.\/]/)
```

#### Output

```JSON
["192", "88", "99", "0", "24"]
```

### Example

This example uses several regular expressions to split input strings. The first uses `/.b./` to
split the string by `-b-`. The second uses `/\s/` to split by a space. The third example returns the
original input string in an array (`[ "no match"]`) because the regex `/^s/` (for matching the first
character if it is `s`) does not match the first character in the input string (`"no match"`). The
fourth, which uses `/^n../`, matches the first characters in `"no match"`, so it returns
`[ "", "match"]`. The last removes all numbers and capital letters from a string, leaving each of
the lower case letters in the array. Notice that the separator is omitted from the output.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "splitters" : {
   "split1" : "a-b-c" splitBy(/.b./),
   "split2" : "hello world" splitBy(/\s/),
   "split3" : "no match" splitBy(/^s/),
   "split4" : "no match" splitBy(/^n../),
   "split5" : "a1b2c3d4A1B2C3D" splitBy(/[0-9A-Z]/)
  }
}
```

#### Output

```JSON
{
  splitters: {
    split1: [ "a", "c" ],
    split2: [ "hello", "world" ],
    split3: [ "no match" ],
    split4: [ "", "match" ],
    split5: [ "a", "b", "c", "d" ]
  }
}
```

### Example

This example splits the number by `.` and applies the index selector `[0]` to the result of the
splitBy function. The splitBy returns `["192", "88", "99", "0"]` so the index \* selector `[0]` just
returns the first element in the array ("192").

#### Source

```DataWeave
%dw 2.0
output application/json
---
("192.88.99.0" splitBy("."))[0]
```

#### Output

```JSON
"192"
```

### Example

This example uses a Java regular expression to split a string by `.` at every point the input string
matches the regex. Note that the regular expression does not consider the periods between the
backticks `` ` ``.

#### Source

```DataWeave
%dw 2.0
output application/json
---
'root.sources.data.`test.branch.BranchSource`.source.traits' splitBy(/[.](?=(?:[^`]*`[^`]*`)*[^`]*$)/)
```

#### Output

```JSON
[
 "root",
 "sources",
 "data",
 "`test.branch.BranchSource`",
 "source",
 "traits"
]
```

## splitBy(text: String, separator: String): Array<String>

Splits a string into a string array based on a separating string that matches part of the input
string. It also filters out the matching string from the returned array.

The separator can match any character in the input. Note that `splitBy` performs the opposite
operation of `joinBy`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to split.</p></td></tr><tr><td><p><code>separator</code></p></td><td><p>A string used to separate the input string. If it does not match some part of the string, the function will return the original, unsplit string in the array.</p></td></tr></tbody></table>

### Example

This example splits a string containing an IP address by its periods.

#### Source

```DataWeave
%dw 2.0
output application/json
---
"192.88.99.0" splitBy(".")
```

#### Output

```JSON
["192", "88", "99", "0"]
```

### Example

The first example (`splitter1`) uses a hyphen (`-`) in `"a-b-c"` to split the string. The second
uses an empty string (`""`) to split each character (including the blank space) in the string. The
third example splits based on a comma (`,`) in the input string. The last example does not split the
input because the function is case sensitive, so the upper case `NO` does not match the lower case
`no` in the input string. Notice that the separator is omitted from the output.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "splitters" : {
    "split1" : "a-b-c" splitBy("-"),
    "split2" : "hello world" splitBy(""),
    "split3" : "first,middle,last" splitBy(","),
    "split4" : "no split" splitBy("NO")
   }
}
```

#### Output

```JSON
{
  splitters: {
    split1: [ "a","b","c" ],
    split2: [ "h","e","l","l","o","","w","o","r","l","d" ],
    split3: [ "first","middle","last"],
    split4: [ "no split"]
  }
}
```

## splitBy(text: Null, separator: Any)

Helper function that enables `splitBy` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=97a409897a40a2b1ece3285db7319b0098147f64fb3f0406aee92590856745f4 url=/mulesoft/current/en-us/dataweave/2.11/dw-arrays-functions-splitwhere.md -->

---
product: DataWeave
version: 2.11
---

# splitWhere

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## splitWhere<T>(array: Array<T>, condition: (item: T) -> Boolean): Pair<Array<T>, Array<T>>

Splits an array into two at the first position where the condition is met.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements to split.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition (or expression) used to match an element in the array.</p></td></tr></tbody></table>

### Example

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var users = ["Mariano", "Leandro", "Julian", "Tomo"]
---
users splitWhere (item) -> item startsWith "Jul"
```

#### Output

```json
{
  "l": ["Mariano", "Leandro"],
  "r": ["Julian", "Tomo"]
}
```

## splitWhere(array: Null, condition: (item: Nothing) -> Any): Null

Helper function that enables `splitWhere` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=de5e1ea17fea610c637d80bb6da96c8b23ff856ea22f4a4c29c222c17cbbcd8d url=/mulesoft/current/en-us/dataweave/2.12/dw-arrays-functions-splitwhere.md -->

---
product: DataWeave
version: 2.12
---

# splitWhere

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## splitWhere<T>(array: Array<T>, condition: (item: T) -> Boolean): Pair<Array<T>, Array<T>>

Splits an array into two at the first position where the condition is met.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements to split.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition (or expression) used to match an element in the array.</p></td></tr></tbody></table>

### Example

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var users = ["Mariano", "Leandro", "Julian", "Tomo"]
---
users splitWhere (item) -> item startsWith "Jul"
```

#### Output

```json
{
  "l": ["Mariano", "Leandro"],
  "r": ["Julian", "Tomo"]
}
```

## splitWhere(array: Null, condition: (item: Nothing) -> Any): Null

Helper function that enables `splitWhere` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=ba383016d23af30c7ed6ae12a552067ad05804fae66d6f0e87e0eb3643e9717f url=/mulesoft/current/en-us/dataweave/2.3/dw-arrays-functions-splitwhere.md -->

---
product: DataWeave
version: 2.3
---

# splitWhere

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## splitWhere(Array<T>, (item: T) -> Boolean): Pair<Array<T>, Array<T>>

Splits an array into two at the first position where the condition is met.

_Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements to split.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition (or expression) used to match an element in the array.</p></td></tr></tbody></table>

### Example

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var users = ["Mariano", "Leandro", "Julian", "Tomo"]
---
users splitWhere (item) -> item startsWith "Jul"
```

#### Output

```json
{
  "l": ["Mariano", "Leandro"],
  "r": ["Julian", "Tomo"]
}
```

<!-- document id=9566d4b082f45979217ed7a405c21686e298c735e010c55a92ed88d868ea7f5a url=/mulesoft/current/en-us/dataweave/2.4/dw-arrays-functions-splitwhere.md -->

---
product: DataWeave
version: 2.4
---

# splitWhere

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## splitWhere<T>(array: Array<T>, condition: (item: T) -> Boolean): Pair<Array<T>, Array<T>>

Splits an array into two at the first position where the condition is met.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements to split.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition (or expression) used to match an element in the array.</p></td></tr></tbody></table>

### Example

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var users = ["Mariano", "Leandro", "Julian", "Tomo"]
---
users splitWhere (item) -> item startsWith "Jul"
```

#### Output

```json
{
  "l": ["Mariano", "Leandro"],
  "r": ["Julian", "Tomo"]
}
```

## splitWhere(array: Null, condition: (item: Nothing) -> Any): Null

Helper function that enables `splitWhere` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=e946fe73be1021781b0a17493bf2ed54493543c60c938e6678db7f1184f5dee7 url=/mulesoft/current/en-us/dataweave/2.6/dw-arrays-functions-splitwhere.md -->

---
product: DataWeave
version: 2.6
---

# splitWhere

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## splitWhere<T>(array: Array<T>, condition: (item: T) -> Boolean): Pair<Array<T>, Array<T>>

Splits an array into two at the first position where the condition is met.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements to split.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition (or expression) used to match an element in the array.</p></td></tr></tbody></table>

### Example

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var users = ["Mariano", "Leandro", "Julian", "Tomo"]
---
users splitWhere (item) -> item startsWith "Jul"
```

#### Output

```json
{
  "l": ["Mariano", "Leandro"],
  "r": ["Julian", "Tomo"]
}
```

## splitWhere(array: Null, condition: (item: Nothing) -> Any): Null

Helper function that enables `splitWhere` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=32fee1716ca0c099089643f63959dc052a466ceb9ff8cde052f92ff4ec051ac0 url=/mulesoft/current/en-us/dataweave/2.9/dw-arrays-functions-splitwhere.md -->

---
product: DataWeave
version: 2.9
---

# splitWhere

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## splitWhere<T>(array: Array<T>, condition: (item: T) -> Boolean): Pair<Array<T>, Array<T>>

Splits an array into two at the first position where the condition is met.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements to split.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition (or expression) used to match an element in the array.</p></td></tr></tbody></table>

### Example

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var users = ["Mariano", "Leandro", "Julian", "Tomo"]
---
users splitWhere (item) -> item startsWith "Jul"
```

#### Output

```json
{
  "l": ["Mariano", "Leandro"],
  "r": ["Julian", "Tomo"]
}
```

## splitWhere(array: Null, condition: (item: Nothing) -> Any): Null

Helper function that enables `splitWhere` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=1a7f983d9bdf9bbaca11ebf61d6c9c82fe31623d16b29649914f43230c8147e8 url=/mulesoft/current/en-us/dataweave/latest/dw-arrays-functions-splitwhere.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# splitWhere

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## splitWhere<T>(array: Array<T>, condition: (item: T) -> Boolean): Pair<Array<T>, Array<T>>

Splits an array into two at the first position where the condition is met.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements to split.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition (or expression) used to match an element in the array.</p></td></tr></tbody></table>

### Example

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var users = ["Mariano", "Leandro", "Julian", "Tomo"]
---
users splitWhere (item) -> item startsWith "Jul"
```

#### Output

```json
{
  "l": ["Mariano", "Leandro"],
  "r": ["Julian", "Tomo"]
}
```

## splitWhere(array: Null, condition: (item: Nothing) -> Any): Null

Helper function that enables `splitWhere` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=e82020d3242d4e2991e04e5675a5e2108dfea606970378b81c92af99f4cd17f2 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-sqrt.md -->

---
product: DataWeave
version: 2.11
---

# sqrt

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## sqrt(number: Number): Number

Returns the square root of a number.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the square root of a number.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ sqrt(4), sqrt(25), sqrt(100) ]
```

#### Output

```JSON
[ 2, 5, 10 ]
```

<!-- document id=57590e7ee6cc7841907e501619a2521fdcae4f4e22d9cb719fb8ca3b428d9a3d url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-sqrt.md -->

---
product: DataWeave
version: 2.12
---

# sqrt

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## sqrt(number: Number): Number

Returns the square root of a number.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the square root of a number.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ sqrt(4), sqrt(25), sqrt(100) ]
```

#### Output

```JSON
[ 2, 5, 10 ]
```

<!-- document id=40df9eb3b9564e0eb6c2aa5b2e88ae6b25bc36196f7665d5531abd44ed1267d1 url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-sqrt.md -->

---
product: DataWeave
version: 2.3
---

# sqrt

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## sqrt(Number): Number

Returns the square root of a number.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the square root of a number.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ sqrt(4), sqrt(25), sqrt(100) ]
```

#### Output

```JSON
[ 2.0, 5.0, 10.0 ]
```

<!-- document id=6610391a66939ba3594cb5777334eb75370e81b3ec00645190607d8ad0fce243 url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-sqrt.md -->

---
product: DataWeave
version: 2.4
---

# sqrt

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## sqrt(number: Number): Number

Returns the square root of a number.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the square root of a number.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ sqrt(4), sqrt(25), sqrt(100) ]
```

#### Output

```JSON
[ 2, 5, 10 ]
```

<!-- document id=d41677401c3973fdb97d869bda1b39f7159e5492b6fc05fa9ae55089fe4f23e7 url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-sqrt.md -->

---
product: DataWeave
version: 2.6
---

# sqrt

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## sqrt(number: Number): Number

Returns the square root of a number.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the square root of a number.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ sqrt(4), sqrt(25), sqrt(100) ]
```

#### Output

```JSON
[ 2, 5, 10 ]
```

<!-- document id=13a176b233d09ca9124a5a3fc6636654d4eda671abd8d63cca23b09c6f2d4837 url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-sqrt.md -->

---
product: DataWeave
version: 2.9
---

# sqrt

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## sqrt(number: Number): Number

Returns the square root of a number.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the square root of a number.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ sqrt(4), sqrt(25), sqrt(100) ]
```

#### Output

```JSON
[ 2, 5, 10 ]
```

<!-- document id=a2168ed82f90abde0c6f7461148a70225117b474186209775459ab6f78e21a17 url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-sqrt.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# sqrt

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## sqrt(number: Number): Number

Returns the square root of a number.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The number to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the square root of a number.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ sqrt(4), sqrt(25), sqrt(100) ]
```

#### Output

```JSON
[ 2, 5, 10 ]
```

<!-- document id=b46e68249fee8d329b38dcef92a1ac84acd0a197cab0e6f215f5db0dfcfd0e95 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-startswith.md -->

---
product: DataWeave
version: 2.11
---

# startsWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## startsWith(text: String, prefix: String): Boolean

Returns `true` or `false` depending on whether the input string starts with a matching prefix.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>prefix</code></p></td><td><p>A string that identifies the prefix.</p></td></tr></tbody></table>

### Example

This example indicates whether the strings start with a given prefix. Note that you can use the
`startsWith(text,prefix)` or `text startsWith(prefix)` notation (for example,
`startsWith("Mari","Mar")` or `"Mari" startsWith("Mar")`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ "Mari" startsWith("Mar"), "Mari" startsWith("Em") ]
```

#### Output

```JSON
[ true, false ]
```

## startsWith(text: Null, prefix: Any): false

Helper function that enables `startsWith` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=879baba2380ff5d01d118f01091bfa5dc0031a7248d9abbb26a2c9cbba9f2f47 url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-startswith.md -->

---
product: DataWeave
version: 2.12
---

# startsWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## startsWith(text: String, prefix: String): Boolean

Returns `true` or `false` depending on whether the input string starts with a matching prefix.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>prefix</code></p></td><td><p>A string that identifies the prefix.</p></td></tr></tbody></table>

### Example

This example indicates whether the strings start with a given prefix. Note that you can use the
`startsWith(text,prefix)` or `text startsWith(prefix)` notation (for example,
`startsWith("Mari","Mar")` or `"Mari" startsWith("Mar")`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ "Mari" startsWith("Mar"), "Mari" startsWith("Em") ]
```

#### Output

```JSON
[ true, false ]
```

## startsWith(text: Null, prefix: Any): false

Helper function that enables `startsWith` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=50c114242c84b8bb6cb75a83885545194490cba44b88d62e63a1faaee9fefd18 url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-startswith.md -->

---
product: DataWeave
version: 2.3
---

# startsWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## startsWith(String, String): Boolean

Returns `true` or `false` depending on whether the input string starts with a matching prefix.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>prefix</code></p></td><td><p>A string that identifies the prefix.</p></td></tr></tbody></table>

### Example

This example indicates whether the strings start with a given prefix. Note that you can use the
`startsWith(text,prefix)` or `text startsWith(prefix)` notation (for example,
`startsWith("Mari","Mar")` or `"Mari" startsWith("Mar")`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ "Mari" startsWith("Mar"), "Mari" startsWith("Em") ]
```

#### Output

```JSON
[ true, false ]
```

<!-- document id=65907563e6cf565c8dd4efa0a75ecb10a515a17224711ade7661205bdf381ee4 url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-startswith.md -->

---
product: DataWeave
version: 2.4
---

# startsWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## startsWith(text: String, prefix: String): Boolean

Returns `true` or `false` depending on whether the input string starts with a matching prefix.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>prefix</code></p></td><td><p>A string that identifies the prefix.</p></td></tr></tbody></table>

### Example

This example indicates whether the strings start with a given prefix. Note that you can use the
`startsWith(text,prefix)` or `text startsWith(prefix)` notation (for example,
`startsWith("Mari","Mar")` or `"Mari" startsWith("Mar")`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ "Mari" startsWith("Mar"), "Mari" startsWith("Em") ]
```

#### Output

```JSON
[ true, false ]
```

## startsWith(text: Null, prefix: Any): false

Helper function that enables `startsWith` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=4cb7781b963e45df768ae19ecb422e2e1166a51fd562eb72b8d20cf805aba0c5 url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-startswith.md -->

---
product: DataWeave
version: 2.6
---

# startsWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## startsWith(text: String, prefix: String): Boolean

Returns `true` or `false` depending on whether the input string starts with a matching prefix.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>prefix</code></p></td><td><p>A string that identifies the prefix.</p></td></tr></tbody></table>

### Example

This example indicates whether the strings start with a given prefix. Note that you can use the
`startsWith(text,prefix)` or `text startsWith(prefix)` notation (for example,
`startsWith("Mari","Mar")` or `"Mari" startsWith("Mar")`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ "Mari" startsWith("Mar"), "Mari" startsWith("Em") ]
```

#### Output

```JSON
[ true, false ]
```

## startsWith(text: Null, prefix: Any): false

Helper function that enables `startsWith` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=cb954757fc9259a67f519245d18f178b79557d0e9e89348c996efcd01cf020d5 url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-startswith.md -->

---
product: DataWeave
version: 2.9
---

# startsWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## startsWith(text: String, prefix: String): Boolean

Returns `true` or `false` depending on whether the input string starts with a matching prefix.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>prefix</code></p></td><td><p>A string that identifies the prefix.</p></td></tr></tbody></table>

### Example

This example indicates whether the strings start with a given prefix. Note that you can use the
`startsWith(text,prefix)` or `text startsWith(prefix)` notation (for example,
`startsWith("Mari","Mar")` or `"Mari" startsWith("Mar")`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ "Mari" startsWith("Mar"), "Mari" startsWith("Em") ]
```

#### Output

```JSON
[ true, false ]
```

## startsWith(text: Null, prefix: Any): false

Helper function that enables `startsWith` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=f67934bb61885887b6e8b83ee18c7ddcd30e7c0c18280d62ea7de6ca9f537aea url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-startswith.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# startsWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## startsWith(text: String, prefix: String): Boolean

Returns `true` or `false` depending on whether the input string starts with a matching prefix.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>prefix</code></p></td><td><p>A string that identifies the prefix.</p></td></tr></tbody></table>

### Example

This example indicates whether the strings start with a given prefix. Note that you can use the
`startsWith(text,prefix)` or `text startsWith(prefix)` notation (for example,
`startsWith("Mari","Mar")` or `"Mari" startsWith("Mar")`).

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ "Mari" startsWith("Mar"), "Mari" startsWith("Em") ]
```

#### Output

```JSON
[ true, false ]
```

## startsWith(text: Null, prefix: Any): false

Helper function that enables `startsWith` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=591e504186644d66a66c72f48df91f02a94464f2bd8426a6878a357d8947ab59 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-streaming.md -->

---
product: DataWeave
version: 2.11
---

# Streaming in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave supports end-to-end streaming through a flow in a Mule application. Streaming speeds the
processing of large documents without overloading memory.

DataWeave processes streamed data as its bytes arrive instead of scanning the entire document to
index it. When in deferred mode, DataWeave can also pass streamed output data directly to a message
processor without saving it to the disk. This behavior enables DataWeave and Mule to process data
faster and consume fewer resources than the default processes for reading and writing data.

To stream successfully, it is important to understand the following:

- The basic unit of the stream is specific to the data format.  
  The unit is a record in a CSV document, an element of an array in a JSON document, or a collection
  in an XML document.

- Streaming accesses each unit of the stream sequentially.  
  Streaming doesn’t support random access to a document.

## Enabling Streaming

Streaming isn’t enabled by default. You can use two configuration properties to stream data in a
supported data format:

- `streaming` property, for reading source data as a stream

- `deferred` writer property, for passing an output stream directly to the next message processor in
  a flow

For DataWeave to read source data as a stream, you must set the `streaming` reader property to
`true` on the data source. Within a Mule application, you append this setting to the value of the
**MIME Type** property `outputMimeType` or `mimeType`. You can set the property in any connector
operation or Mule component that generates data, such as an HTTP Listener operation, HTTP Request
operation, On New or Updated File operation, or a Set Payload component. DataWeave reads data as
streamed data from the point in the application where you set the streaming property through all
downstream components and connector operations that contain DataWeave expressions and scripts.

```XML
<flow name="dw-streaming-example" >
  <http:listener doc:name="Listener"
      outputMimeType="application/json; streaming=true"
      config-ref="HTTP_Listener_config" path="/input"/>
</flow>
```

Notice that `streaming=true` is part of the `outputMimeType` value. Many other Mule components, such
as the File and FTP components, also support the MIME Type setting.

To pass the streamed output to the next message processor, you can use the `output` directive in a
DataWeave script, for example:

```XML
output application/json deferred=true
```

For more detail on use of the `deferred` property. see [Streaming Output](#stream_output).

## Streaming CSV

CSV is simplest format for streaming because of its structure. Each row below the CSV header is a
streamable record. The following CSV example consists of records that contain `name`, `lastName`,
and `age` values: ​

```CSV
name,lastName,age
mariano,achaval,37
leandro,shokida,30
pedro,achaval,4
christian,chibana,25
sara,achaval,2
matias,achaval,8
```

​ To stream this CSV example, the following script selects values from each record. It uses the
`map` function to iterate over each record in the document. ​

```DataWeave
payload map (record) ->
    {
        FullName: record.lastName ++ "," ++ record.name,
        Age: record.age
    }
```

Although streaming doesn’t support random access to the entire document, a DataWeave script can
access data randomly _within each record_ because each record is loaded into memory. For example,
the expression `record.lastName "," record.name,` can access a `lastName` value before it accesses a
`name` value even though the order of values is reversed in the input.

However, streaming doesn’t work in the following script. The script requires random access to the
entire document to return the elements in a different order than they are given in the input. ​

```DataWeave
[payload[-2], payload[-1], payload[3]]
```

​

## Streaming JSON

​ The unit of a JSON stream is each element in an array.

Note that DataWeave 2.2.0 support for JSON streaming for Mule 4.2 was limited by the requirement
that the root be an array. DataWeave support in Mule 4.3 includes streaming to arrays that aren’t at
the root of the input.

```JSON
{
    "name" : "Mariano",
    "lastName": "Achaval",
    "family": [
        {"name": "Sara", "age": 2},
        {"name": "Pedro", "age": 4},
        {"name": "Matias", "age": 8}
    ],
    "age": 37
}
```

​ In this example, DataWeave can stream `payload.family` and perform random access within each
element of that array. However, DataWeave cannot randomly access the container object. For example,
it isn’t possible to stream `{ a: payload.age , b: payload.family}` because `age` follows `family`,
and DataWeave cannot go backwards. ​

## Streaming XML

​ XML is more complicated than JSON because there are no arrays in the document.

To enable XML streaming, DataWeave provides the following reader property to define the location in
the document to stream:

- `collectionPath`

For example, assume the following XML input: ​

```XML
<order>
    <header>
        <date>Wed Nov 15 13:45:28 EST 2006</date>
        <customer number="123123">Joe</customer>
    </header>
    <order-items>
        <order-item id="31">
            <product>111</product>
            <quantity>2</quantity>
            <price>8.90</price>
        </order-item>
        <order-item id="31">
            <product>222</product>
            <quantity>7</quantity>
            <price>5.20</price>
        </order-item>
        <order-item id="31">
            <product>111</product>
            <quantity>2</quantity>
            <price>8.90</price>
        </order-item>
        <order-item id="31">
            <product>222</product>
            <quantity>7</quantity>
            <price>5.20</price>
        </order-item>
        <order-item id="31">
            <product>222</product>
            <quantity>7</quantity>
            <price>5.20</price>
        </order-item>
    </order-items>
</order>
```

​ Given this XML source data, you can set the unit of the stream to `<order-item/>` by setting
`collectionPath=order.order-items` in the `outputMimeType` value:

```XML
<flow name="dw-streaming-example" >
  <http:listener doc:name="Listener"
      outputMimeType="application/xml; collectionpath=order.order-items; streaming=true"
      config-ref="HTTP_Listener_config" path="/input"/>
</flow>
```

Note that you need to set both `streaming=true` and the `collectionPath` value. If either is
missing, DataWeave doesn’t stream the content. The following DataWeave script streams the XML input
using each `<order-items/>` element as the streamable unit.

```DataWeave
%dw 2.0
output application/xml
---
{
  salesorder: {
    itemList: payload.order."order-items".*"order-item" map {
      ("i_" ++ $$) : {
        id: $.@id,
        productId: $.product,
        quantity: $.quantity,
        price: $.price
      }
    }
  }
}
```

The script produces the following XML output:

```XML
<?xml version='1.0' encoding='UTF-8'?>
<salesorder>
  <itemList>
    <i_0>
      <id>31</id>
      <quantity>2</quantity>
      <productId>111</productId>
      <price>8.90</price>
    </i_0>
  </itemList>
  <itemList>
    <i_1>
      <id>31</id>
      <quantity>7</quantity>
      <productId>222</productId>
      <price>5.20</price>
    </i_1>
  </itemList>
  <itemList>
    <i_2>
      <id>31</id>
      <quantity>2</quantity>
      <productId>111</productId>
      <price>8.90</price>
    </i_2>
  </itemList>
  <itemList>
    <i_3>
      <id>31</id>
      <quantity>7</quantity>
      <productId>222</productId>
      <price>5.20</price>
    </i_3>
  </itemList>
  <itemList>
    <i_4>
      <id>31</id>
      <quantity>7</quantity>
      <productId>222</productId>
      <price>5.20</price>
    </i_4>
  </itemList>
</salesorder>
```

## Validate a Script for Streamed Data (Experimental Feature)

To check that your code can process an input stream successfully, DataWeave provides the following
_advanced, experimental_ annotation and a related directive:

- `@StreamCapable()`  
  Use this annotation to validate whether the script can sequentially access a variable (typically
  the `payload` variable).

- `input` directive:  
  The `@StreamCapable()` annotation requires the use of an input directive in the DataWeave script
  that identifies the MIME type of the data source, for example, `input payload application/xml`.

The DataWeave validator (which is triggered by the `@StreamCapable` annotation in the script) checks
a script against the following criteria:

- The variable is referenced only once.

- No index selector is set for negative access, such as `[-1]`.

- No reference to the variable is found in a nested lambda.

If all criteria are met, the selected data is streamable.

The following example validates successfully. The script is designed to act on the
[JSON input](#example_json) from the [JSON streaming](#stream_json) section:

```DataWeave
%dw 2.0

@StreamCapable()
input payload application/json
output application/json
---
payload.family filter (member) -> member.age > 3
```

The script successfully validates and returns the following output:

```JSON
[
  {
    "name": "Pedro",
    "age": 4
  },
  {
    "name": "Matias",
    "age": 8
  }
]
```

### Validation Failures

If any of the criteria that the validator checks is false, the validation fails.

Before proceeding, note that validation can fail in some cases when streaming works. If you write a
script in a way that sequentially accesses the input variable in a given data source, streaming
works, but that script might not work in all cases. For example, JSON doesn’t place a restriction on
the order of the keys in an object. If the keys in some JSON documents arrive in a different order
than the script expects, streaming will fail in those cases. The annotation processor follows the
rules of the format and cannot assume that the keys always arrive in the same order.

#### Error: Variable Is Referenced More Than Once

Validation fails if a script attempts to reference the same variable more than once.

The following script is designed to act on the [JSON input](#example_json) from the
[JSON streaming](#stream_json) section. Validation fails because the script attempts to reference
the `payload` variable more than once:

```DataWeave
%dw 2.0

@StreamCapable()
input payload application/json
output application/json
---
 {
     family: payload.family filter (member) -> member.age > 3,
     name: payload.name
 }
```

The script fails with the following error:

```error
4| input payload application/json streaming=true
         ^^^^^^^
Parameter `payload` is not stream capable.
Reasons:
 - Variable payload is referenced more than once. Locations:
 ---------------------------

8|      family: payload.family filter (member) -> member.age > 3,
                ^^^^^^^
 ---------------------------

9|      name: payload.name
              ^^^^^^^ at
4| input payload application/json streaming=true
```

#### Error: Wrong Scope Reference

Validation fails if a script attempts to reference a variable from a scope that is different from
the scope in which the variable is defined.

The following script fails because the `payload` variable is referenced from within the lambda
expression `[1,2,3] map ((item, index) → payload)`. Even if the expression is
`[1] map ((item, index) → payload`, streaming fails because `payload` is in the wrong scope.

```DataWeave
%dw 2.0

@StreamCapable()
input payload application/json
output application/json
---
[1,2,3] map ((item, index) -> payload)
```

The example fails with the following error:

```error
4| input payload application/json
         ^^^^^^^
Parameter `payload` is not stream capable.
Reasons:
 - Variable payload is referenced in a different scope from where it was defined. Locations:
 ---------------------------

9| [1,2,3] map ((item, index) -> payload)
                ^^^^^^^^^^^^^^^^^^^^^^^^ at
4| input payload application/json
```

## Streaming Output

After processing streamed data, you can stream the output directly to another message processor. To
facilitate this behavior, use the `deferred` writer property in the output directive of the
DataWeave script, for example, `output application/json deferred=true`.

NOTE

Exceptions aren’t handled when you set `deferred = true`. For example, you can see this behavior in
Studio when a flow throws an exception. If you are running an application in Studio debug mode and
an exception occurs in a Transform Message component when `deferred = true`, the console logs the
error, but the flow doesn’t stop at the Transform Message component.

Building on the example in [JSON Streaming](#stream_json), the following flow uses a DataWeave
script to filter streamed input and then streams the output directly to a Write operation:

```XML
<flow name="dw-streamingexample">
  <file:listener doc:name="On New or Updated File"
    config-ref="File_Config" directory="/Users/me/testing/json" recursive="false" outputMimeType="application/json;
    streaming=true">
    <scheduling-strategy>
      <fixed-frequency timeUnit="SECONDS" />
    </scheduling-strategy>
    <file:matcher />
  </file:listener>
  <ee:transform doc:name="Transform Message">
    <ee:message>
      <ee:set-payload><![CDATA[%dw 2.0

@StreamCapable()
input payload application/json
output application/json deferred = true
---
{
   family: payload.family filter (member) -> member.age > 1
}]]></ee:set-payload>
    </ee:message>
  </ee:transform>
  <file:write doc:name="Write"
      config-ref="File_Config2"
      path="/Users/me/testing/output.json"/>
</flow>
```

The flow provides the following configuration:

1.  The listener (`<file:listener>`) uses `streaming=true` to stream the incoming JSON data.

2.  The DataWeave script in `<ee:transform/>` filters records in the streamed data and uses the
    `deferred = true` property to stream the resulting records directly to the next processor in the
    flow.

3.  The next component in the flow, `<file:write/>`, receives the filtered stream directly and
    writes the records to a file.

## See Also

- [CSV Format](https://docs.mulesoft.com/dataweave/2.11/dataweave-formats-csv)

- [JSON Format](https://docs.mulesoft.com/dataweave/2.11/dataweave-formats-json)

- [XML Format](https://docs.mulesoft.com/dataweave/2.11/dataweave-formats-xml)

- [Supported DataWeave Formats](https://docs.mulesoft.com/dataweave/2.11/dataweave-formats)

<!-- document id=3faf5c91936651a85b2a1d0b12b61363c4b2f54529c30e594a5fedcaf683afed url=/mulesoft/current/en-us/dataweave/2.12/dataweave-streaming.md -->

---
product: DataWeave
version: 2.12
---

# Streaming in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave supports end-to-end streaming through a flow in a Mule application. Streaming speeds the
processing of large documents without overloading memory.

DataWeave processes streamed data as its bytes arrive instead of scanning the entire document to
index it. When in deferred mode, DataWeave can also pass streamed output data directly to a message
processor without saving it to the disk. This behavior enables DataWeave and Mule to process data
faster and consume fewer resources than the default processes for reading and writing data.

To stream successfully, it is important to understand the following:

- The basic unit of the stream is specific to the data format.  
  The unit is a record in a CSV document, an element of an array in a JSON document, or a collection
  in an XML document.

- Streaming accesses each unit of the stream sequentially.  
  Streaming doesn’t support random access to a document.

## Enabling Streaming

Streaming isn’t enabled by default. You can use two configuration properties to stream data in a
supported data format:

- `streaming` property, for reading source data as a stream

- `deferred` writer property, for passing an output stream directly to the next message processor in
  a flow

For DataWeave to read source data as a stream, you must set the `streaming` reader property to
`true` on the data source. Within a Mule application, you append this setting to the value of the
**MIME Type** property `outputMimeType` or `mimeType`. You can set the property in any connector
operation or Mule component that generates data, such as an HTTP Listener operation, HTTP Request
operation, On New or Updated File operation, or a Set Payload component. DataWeave reads data as
streamed data from the point in the application where you set the streaming property through all
downstream components and connector operations that contain DataWeave expressions and scripts.

```XML
<flow name="dw-streaming-example" >
  <http:listener doc:name="Listener"
      outputMimeType="application/json; streaming=true"
      config-ref="HTTP_Listener_config" path="/input"/>
</flow>
```

Notice that `streaming=true` is part of the `outputMimeType` value. Many other Mule components, such
as the File and FTP components, also support the MIME Type setting.

To pass the streamed output to the next message processor, you can use the `output` directive in a
DataWeave script, for example:

```XML
output application/json deferred=true
```

For more detail on use of the `deferred` property. see [Streaming Output](#stream_output).

## Streaming CSV

CSV is simplest format for streaming because of its structure. Each row below the CSV header is a
streamable record. The following CSV example consists of records that contain `name`, `lastName`,
and `age` values: ​

```CSV
name,lastName,age
mariano,achaval,37
leandro,shokida,30
pedro,achaval,4
christian,chibana,25
sara,achaval,2
matias,achaval,8
```

​ To stream this CSV example, the following script selects values from each record. It uses the
`map` function to iterate over each record in the document. ​

```DataWeave
payload map (record) ->
    {
        FullName: record.lastName ++ "," ++ record.name,
        Age: record.age
    }
```

Although streaming doesn’t support random access to the entire document, a DataWeave script can
access data randomly _within each record_ because each record is loaded into memory. For example,
the expression `record.lastName "," record.name,` can access a `lastName` value before it accesses a
`name` value even though the order of values is reversed in the input.

However, streaming doesn’t work in the following script. The script requires random access to the
entire document to return the elements in a different order than they are given in the input. ​

```DataWeave
[payload[-2], payload[-1], payload[3]]
```

​

## Streaming JSON

​ The unit of a JSON stream is each element in an array.

Note that DataWeave 2.2.0 support for JSON streaming for Mule 4.2 was limited by the requirement
that the root be an array. DataWeave support in Mule 4.3 includes streaming to arrays that aren’t at
the root of the input.

```JSON
{
    "name" : "Mariano",
    "lastName": "Achaval",
    "family": [
        {"name": "Sara", "age": 2},
        {"name": "Pedro", "age": 4},
        {"name": "Matias", "age": 8}
    ],
    "age": 37
}
```

​ In this example, DataWeave can stream `payload.family` and perform random access within each
element of that array. However, DataWeave cannot randomly access the container object. For example,
it isn’t possible to stream `{ a: payload.age , b: payload.family}` because `age` follows `family`,
and DataWeave cannot go backwards. ​

## Streaming XML

​ XML is more complicated than JSON because there are no arrays in the document.

To enable XML streaming, DataWeave provides the following reader property to define the location in
the document to stream:

- `collectionPath`

For example, assume the following XML input: ​

```XML
<order>
    <header>
        <date>Wed Nov 15 13:45:28 EST 2006</date>
        <customer number="123123">Joe</customer>
    </header>
    <order-items>
        <order-item id="31">
            <product>111</product>
            <quantity>2</quantity>
            <price>8.90</price>
        </order-item>
        <order-item id="31">
            <product>222</product>
            <quantity>7</quantity>
            <price>5.20</price>
        </order-item>
        <order-item id="31">
            <product>111</product>
            <quantity>2</quantity>
            <price>8.90</price>
        </order-item>
        <order-item id="31">
            <product>222</product>
            <quantity>7</quantity>
            <price>5.20</price>
        </order-item>
        <order-item id="31">
            <product>222</product>
            <quantity>7</quantity>
            <price>5.20</price>
        </order-item>
    </order-items>
</order>
```

​ Given this XML source data, you can set the unit of the stream to `<order-item/>` by setting
`collectionPath=order.order-items` in the `outputMimeType` value:

```XML
<flow name="dw-streaming-example" >
  <http:listener doc:name="Listener"
      outputMimeType="application/xml; collectionpath=order.order-items; streaming=true"
      config-ref="HTTP_Listener_config" path="/input"/>
</flow>
```

Note that you need to set both `streaming=true` and the `collectionPath` value. If either is
missing, DataWeave doesn’t stream the content. The following DataWeave script streams the XML input
using each `<order-items/>` element as the streamable unit.

```DataWeave
%dw 2.0
output application/xml
---
{
  salesorder: {
    itemList: payload.order."order-items".*"order-item" map {
      ("i_" ++ $$) : {
        id: $.@id,
        productId: $.product,
        quantity: $.quantity,
        price: $.price
      }
    }
  }
}
```

The script produces the following XML output:

```XML
<?xml version='1.0' encoding='UTF-8'?>
<salesorder>
  <itemList>
    <i_0>
      <id>31</id>
      <quantity>2</quantity>
      <productId>111</productId>
      <price>8.90</price>
    </i_0>
  </itemList>
  <itemList>
    <i_1>
      <id>31</id>
      <quantity>7</quantity>
      <productId>222</productId>
      <price>5.20</price>
    </i_1>
  </itemList>
  <itemList>
    <i_2>
      <id>31</id>
      <quantity>2</quantity>
      <productId>111</productId>
      <price>8.90</price>
    </i_2>
  </itemList>
  <itemList>
    <i_3>
      <id>31</id>
      <quantity>7</quantity>
      <productId>222</productId>
      <price>5.20</price>
    </i_3>
  </itemList>
  <itemList>
    <i_4>
      <id>31</id>
      <quantity>7</quantity>
      <productId>222</productId>
      <price>5.20</price>
    </i_4>
  </itemList>
</salesorder>
```

## Validate a Script for Streamed Data (Experimental Feature)

To check that your code can process an input stream successfully, DataWeave provides the following
_advanced, experimental_ annotation and a related directive:

- `@StreamCapable()`  
  Use this annotation to validate whether the script can sequentially access a variable (typically
  the `payload` variable).

- `input` directive:  
  The `@StreamCapable()` annotation requires the use of an input directive in the DataWeave script
  that identifies the MIME type of the data source, for example, `input payload application/xml`.

The DataWeave validator (which is triggered by the `@StreamCapable` annotation in the script) checks
a script against the following criteria:

- The variable is referenced only once.

- No index selector is set for negative access, such as `[-1]`.

- No reference to the variable is found in a nested lambda.

If all criteria are met, the selected data is streamable.

The following example validates successfully. The script is designed to act on the
[JSON input](#example_json) from the [JSON streaming](#stream_json) section:

```DataWeave
%dw 2.0

@StreamCapable()
input payload application/json
output application/json
---
payload.family filter (member) -> member.age > 3
```

The script successfully validates and returns the following output:

```JSON
[
  {
    "name": "Pedro",
    "age": 4
  },
  {
    "name": "Matias",
    "age": 8
  }
]
```

### Validation Failures

If any of the criteria that the validator checks is false, the validation fails.

Before proceeding, note that validation can fail in some cases when streaming works. If you write a
script in a way that sequentially accesses the input variable in a given data source, streaming
works, but that script might not work in all cases. For example, JSON doesn’t place a restriction on
the order of the keys in an object. If the keys in some JSON documents arrive in a different order
than the script expects, streaming will fail in those cases. The annotation processor follows the
rules of the format and cannot assume that the keys always arrive in the same order.

#### Error: Variable Is Referenced More Than Once

Validation fails if a script attempts to reference the same variable more than once.

The following script is designed to act on the [JSON input](#example_json) from the
[JSON streaming](#stream_json) section. Validation fails because the script attempts to reference
the `payload` variable more than once:

```DataWeave
%dw 2.0

@StreamCapable()
input payload application/json
output application/json
---
 {
     family: payload.family filter (member) -> member.age > 3,
     name: payload.name
 }
```

The script fails with the following error:

```error
4| input payload application/json streaming=true
         ^^^^^^^
Parameter `payload` is not stream capable.
Reasons:
 - Variable payload is referenced more than once. Locations:
 ---------------------------

8|      family: payload.family filter (member) -> member.age > 3,
                ^^^^^^^
 ---------------------------

9|      name: payload.name
              ^^^^^^^ at
4| input payload application/json streaming=true
```

#### Error: Wrong Scope Reference

Validation fails if a script attempts to reference a variable from a scope that is different from
the scope in which the variable is defined.

The following script fails because the `payload` variable is referenced from within the lambda
expression `[1,2,3] map ((item, index) → payload)`. Even if the expression is
`[1] map ((item, index) → payload`, streaming fails because `payload` is in the wrong scope.

```DataWeave
%dw 2.0

@StreamCapable()
input payload application/json
output application/json
---
[1,2,3] map ((item, index) -> payload)
```

The example fails with the following error:

```error
4| input payload application/json
         ^^^^^^^
Parameter `payload` is not stream capable.
Reasons:
 - Variable payload is referenced in a different scope from where it was defined. Locations:
 ---------------------------

9| [1,2,3] map ((item, index) -> payload)
                ^^^^^^^^^^^^^^^^^^^^^^^^ at
4| input payload application/json
```

## Streaming Output

After processing streamed data, you can stream the output directly to another message processor. To
facilitate this behavior, use the `deferred` writer property in the output directive of the
DataWeave script, for example, `output application/json deferred=true`.

NOTE

Exceptions aren’t handled when you set `deferred = true`. For example, you can see this behavior in
Studio when a flow throws an exception. If you are running an application in Studio debug mode and
an exception occurs in a Transform Message component when `deferred = true`, the console logs the
error, but the flow doesn’t stop at the Transform Message component.

Building on the example in [JSON Streaming](#stream_json), the following flow uses a DataWeave
script to filter streamed input and then streams the output directly to a Write operation:

```XML
<flow name="dw-streamingexample">
  <file:listener doc:name="On New or Updated File"
    config-ref="File_Config" directory="/Users/me/testing/json" recursive="false" outputMimeType="application/json;
    streaming=true">
    <scheduling-strategy>
      <fixed-frequency timeUnit="SECONDS" />
    </scheduling-strategy>
    <file:matcher />
  </file:listener>
  <ee:transform doc:name="Transform Message">
    <ee:message>
      <ee:set-payload><![CDATA[%dw 2.0

@StreamCapable()
input payload application/json
output application/json deferred = true
---
{
   family: payload.family filter (member) -> member.age > 1
}]]></ee:set-payload>
    </ee:message>
  </ee:transform>
  <file:write doc:name="Write"
      config-ref="File_Config2"
      path="/Users/me/testing/output.json"/>
</flow>
```

The flow provides the following configuration:

1.  The listener (`<file:listener>`) uses `streaming=true` to stream the incoming JSON data.

2.  The DataWeave script in `<ee:transform/>` filters records in the streamed data and uses the
    `deferred = true` property to stream the resulting records directly to the next processor in the
    flow.

3.  The next component in the flow, `<file:write/>`, receives the filtered stream directly and
    writes the records to a file.

## See Also

- [CSV Format](https://docs.mulesoft.com/dataweave/2.12/dataweave-formats-csv)

- [JSON Format](https://docs.mulesoft.com/dataweave/2.12/dataweave-formats-json)

- [XML Format](https://docs.mulesoft.com/dataweave/2.12/dataweave-formats-xml)

- [Supported DataWeave Formats](https://docs.mulesoft.com/dataweave/2.12/dataweave-formats)

<!-- document id=d77c1bdc2ea8c8de2bfba80841d1aacee909c3d0f1d9cb5ef06df0abace2d0ec url=/mulesoft/current/en-us/dataweave/2.3/dataweave-streaming.md -->

---
product: DataWeave
version: 2.3
---

# Streaming in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave supports end-to-end streaming through a flow in a Mule application. Streaming speeds the
processing of large documents without overloading memory.

DataWeave processes streamed data as its bytes arrive instead of scanning the entire document to
index it. When in deferred mode, DataWeave can also pass streamed output data directly to a message
processor without saving it to the disk. This behavior enables DataWeave and Mule to process data
faster and consume fewer resources than the default processes for reading and writing data.

To stream successfully, it is important to understand the following:

- The basic unit of the stream is specific to the data format.  
  The unit is a record in a CSV document, an element of an array in a JSON document, or a collection
  in an XML document.

- Streaming accesses each unit of the stream sequentially.  
  Streaming does not support random access to a document.

## Enabling Streaming

Streaming is not enabled by default. You can use two configuration properties to stream data in a
supported data format:

- `streaming` property, for reading source data as a stream

- `deferred` writer property, for passing an output stream directly to the next message processor in
  a flow

To enable streaming when reading source data, you must set the `streaming` reader property to `true`
on the data source. You can enable streaming on a data source through the **MIME Type** setting
`outputMimeType`. You can set the property in a Mule component that accepts source data, such as an
HTTP listener or an On New or Updated File operation.

```XML
<flow name="dw-streaming-example" >
  <http:listener doc:name="Listener"
      outputMimeType="application/json; streaming=true"
      config-ref="HTTP_Listener_config" path="/input"/>
</flow>
```

Notice that `streaming=true` is part of the `outputMimeType` value. Other Mule components, such as
the File and FTP components, also support the MIME Type setting.

To pass the streamed output to the next message processor, you can use the `output` directive in a
DataWeave script, for example:

```XML
output application/json deferred=true
```

For more detail on use of the `deferred` property. see [Streaming Output](#stream_output).

## Streaming CSV

CSV is simplest format for streaming because of its structure. Each row below the CSV header is a
streamable record. The following CSV example consists of records that contain `name`, `lastName`,
and `age` values: ​

```CSV
name,lastName,age
mariano,achaval,37
leandro,shokida,30
pedro,achaval,4
christian,chibana,25
sara,achaval,2
matias,achaval,8
```

​ To stream this CSV example, the following script selects values from each record. It uses the
`map` function to iterate over each record in the document. ​

```DataWeave
payload map (record) ->
    {
        FullName: record.lastName ++ "," ++ record.name,
        Age: record.age
    }
```

Although streaming does not support random access to the entire document, a DataWeave script can
access data randomly _within each record_ because each record is loaded into memory. For example,
the expression `record.lastName "," record.name,` can access a `lastName` value before it accesses a
`name` value even though the order of values is reversed in the input.

However, streaming does not work in the following script. The script requires random access to the
entire document to return the elements in a different order than they are given in the input. ​

```DataWeave
[payload[-2], payload[-1], payload[3]]
```

​

## Streaming JSON

​ The unit of a JSON stream is each element in an array.

Note that DataWeave 2.2.0 support for JSON streaming for Mule 4.2 was limited by the requirement
that the root be an array. DataWeave support in Mule 4.3 includes streaming to arrays that are not
at the root of the input.

```JSON
{
    "name" : "Mariano",
    "lastName": "Achaval",
    "family": [
        {"name": "Sara", "age": 2},
        {"name": "Pedro", "age": 4},
        {"name": "Matias", "age": 8}
    ],
    "age": 37
}
```

​ In this example, DataWeave can stream `payload.family` and perform random access within each
element of that array. However, DataWeave cannot randomly access the container object. For example,
it is not possible to stream `{ a: payload.age , b: payload.family}` because `age` follows `family`,
and DataWeave cannot go backwards. ​

## Streaming XML

​ XML is more complicated than JSON because there are no arrays in the document.

To enable XML streaming, DataWeave provides the following reader property to define the location in
the document to stream:

- `collectionPath`

For example, assume the following XML input: ​

```XML
<order>
    <header>
        <date>Wed Nov 15 13:45:28 EST 2006</date>
        <customer number="123123">Joe</customer>
    </header>
    <order-items>
        <order-item id="31">
            <product>111</product>
            <quantity>2</quantity>
            <price>8.90</price>
        </order-item>
        <order-item id="31">
            <product>222</product>
            <quantity>7</quantity>
            <price>5.20</price>
        </order-item>
        <order-item id="31">
            <product>111</product>
            <quantity>2</quantity>
            <price>8.90</price>
        </order-item>
        <order-item id="31">
            <product>222</product>
            <quantity>7</quantity>
            <price>5.20</price>
        </order-item>
        <order-item id="31">
            <product>222</product>
            <quantity>7</quantity>
            <price>5.20</price>
        </order-item>
    </order-items>
</order>
```

​ Given this XML source data, you can set the unit of the stream to `<order-item/>` by setting
`collectionPath=order.order-items` in the `outputMimeType` value:

```XML
<flow name="dw-streaming-example" >
  <http:listener doc:name="Listener"
      outputMimeType="application/xml; collectionpath=order.order-items; streaming=true"
      config-ref="HTTP_Listener_config" path="/input"/>
</flow>
```

Note that you need to set both `streaming=true` and the `collectionPath` value. If either is
missing, DataWeave will not stream the content. The following DataWeave script streams the XML input
using each `<order-items/>` element as the streamable unit.

```DataWeave
%dw 2.0
output application/xml
---
{
  salesorder: {
    itemList: payload.order."order-items".*"order-item" map {
      ("i_" ++ $$) : {
        id: $.@id,
        productId: $.product,
        quantity: $.quantity,
        price: $.price
      }
    }
  }
}
```

The script produces the following XML output:

```XML
<?xml version='1.0' encoding='UTF-8'?>
<salesorder>
  <itemList>
    <i_0>
      <id>31</id>
      <quantity>2</quantity>
      <productId>111</productId>
      <price>8.90</price>
    </i_0>
  </itemList>
  <itemList>
    <i_1>
      <id>31</id>
      <quantity>7</quantity>
      <productId>222</productId>
      <price>5.20</price>
    </i_1>
  </itemList>
  <itemList>
    <i_2>
      <id>31</id>
      <quantity>2</quantity>
      <productId>111</productId>
      <price>8.90</price>
    </i_2>
  </itemList>
  <itemList>
    <i_3>
      <id>31</id>
      <quantity>7</quantity>
      <productId>222</productId>
      <price>5.20</price>
    </i_3>
  </itemList>
  <itemList>
    <i_4>
      <id>31</id>
      <quantity>7</quantity>
      <productId>222</productId>
      <price>5.20</price>
    </i_4>
  </itemList>
</salesorder>
```

## Validate a Script for Streamed Data (Experimental Feature)

To check that your code can process an input stream successfully, DataWeave provides the following
_advanced, experimental_ annotation and a related directive:

- `@StreamCapable()`  
  Use this annotation to validate whether the script can sequentially access a variable (typically
  the `payload` variable).

- `input` directive:  
  The `@StreamCapable()` annotation requires the use of an input directive in the DataWeave script
  that identifies the MIME type of the data source, for example, `input payload application/xml`.

The DataWeave validator (which is triggered by the `@StreamCapable` annotation in the script) checks
a script against the following criteria:

- The variable is referenced only once.

- No index selector is set for negative access, such as `[-1]`.

- No reference to the variable is found in a nested lambda.

If all criteria are met, the selected data is streamable.

The following example validates successfully. The script is designed to act on the
[JSON input](#example_json) from the [JSON streaming](#stream_json) section:

```DataWeave
%dw 2.0

@StreamCapable()
input payload application/json
output application/json
---
payload.family filter (member) -> member.age > 3
```

The script successfully validates and returns the following output:

```JSON
[
  {
    "name": "Pedro",
    "age": 4
  },
  {
    "name": "Matias",
    "age": 8
  }
]
```

### Validation Failures

If any of the criteria that the validator checks is false, the validation fails.

Before proceeding, note that validation can fail in some cases when streaming works. If you write a
script in a way that sequentially accesses the input variable in a given data source, streaming
works, but that script might not work in all cases. For example, JSON does not place a restriction
on the order of the keys in an object. If the keys in some JSON documents arrive in a different
order than the script expects, streaming will fail in those cases. The annotation processor follows
the rules of the format and cannot assume that the keys always arrive in the same order.

#### Error: Variable Is Referenced More Than Once

Validation fails if a script attempts to reference the same variable more than once.

The following script is designed to act on the [JSON input](#example_json) from the
[JSON streaming](#stream_json) section. Validation fails because the script attempts to reference
the `payload` variable more than once:

```DataWeave
%dw 2.0

@StreamCapable()
input payload application/json
output application/json
---
 {
     family: payload.family filter (member) -> member.age > 3,
     name: payload.name
 }
```

The script fails with the following error:

```error
4| input payload application/json streaming=true
         ^^^^^^^
Parameter `payload` is not stream capable.
Reasons:
 - Variable payload is referenced more than once. Locations:
 ---------------------------

8|      family: payload.family filter (member) -> member.age > 3,
                ^^^^^^^
 ---------------------------

9|      name: payload.name
              ^^^^^^^ at
4| input payload application/json streaming=true
```

#### Error: Wrong Scope Reference

Validation fails if a script attempts to reference a variable from a scope that is different from
the scope in which the variable is defined.

The following script fails because the `payload` variable is referenced from within the lambda
expression `[1,2,3] map ((item, index) → payload)`. Even if the expression is
`[1] map ((item, index) → payload`, streaming fails because `payload` is in the wrong scope.

```DataWeave
%dw 2.0

@StreamCapable()
input payload application/json
output application/json
---
[1,2,3] map ((item, index) -> payload)
```

The example fails with the following error:

```error
4| input payload application/json
         ^^^^^^^
Parameter `payload` is not stream capable.
Reasons:
 - Variable payload is referenced in a different scope from where it was defined. Locations:
 ---------------------------

9| [1,2,3] map ((item, index) -> payload)
                ^^^^^^^^^^^^^^^^^^^^^^^^ at
4| input payload application/json
```

## Streaming Output

After processing streamed data, you can stream the output directly to another message processor. To
facilitate this behavior, use the `deferred` writer property in the output directive of the
DataWeave script, for example, `output application/json deferred=true`.

NOTE

Exceptions are not handled when you set `deferred = true`. For example, you can see this behavior in
Studio when a flow throws an exception. If you are running an application in Studio debug mode and
an exception occurs in a Transform Message component when `deferred = true`, the console logs the
error, but the flow does not stop at the Tranform Message component.

Building on the example in [JSON Streaming](#stream_json), the following flow uses a DataWeave
script to filter streamed input and then streams the output directly to a Write operation:

```XML
<flow name="dw-streamingexample">
  <file:listener doc:name="On New or Updated File"
    config-ref="File_Config" directory="/Users/me/testing/json" recursive="false" outputMimeType="application/json;
    streaming=true">
    <scheduling-strategy>
      <fixed-frequency timeUnit="SECONDS" />
    </scheduling-strategy>
    <file:matcher />
  </file:listener>
  <ee:transform doc:name="Transform Message">
    <ee:message>
      <ee:set-payload><![CDATA[%dw 2.0

@StreamCapable()
input payload application/json
output application/json deferred = true
---
{
   family: payload.family filter (member) -> member.age > 1
}]]></ee:set-payload>
    </ee:message>
  </ee:transform>
  <file:write doc:name="Write"
      config-ref="File_Config2"
      path="/Users/me/testing/output.json"/>
</flow>
```

The flow provides the following configuration:

1.  The listener (`<file:listener>`) uses `streaming=true` to stream the incoming JSON data.

2.  The DataWeave script in `<ee:transform/>` filters records in the streamed data and uses the
    `deferred = true` property to stream the resulting records directly to the next processor in the
    flow.

3.  The next component in the flow, `<file:write/>`, receives the filtered stream directly and
    writes the records to a file.

## See Also

- [CSV Format](https://docs.mulesoft.com/dataweave/2.3/dataweave-formats-csv)

- [JSON Format](https://docs.mulesoft.com/dataweave/2.3/dataweave-formats-json)

- [XML Format](https://docs.mulesoft.com/dataweave/2.3/dataweave-formats-xml)

- [Supported DataWeave Formats](https://docs.mulesoft.com/dataweave/2.3/dataweave-formats)

<!-- document id=f9acca8d3b0b4ef3b7a12d2841349fc089dfe14b5e1ae5132213c9e5db9a1cbc url=/mulesoft/current/en-us/dataweave/2.4/dataweave-streaming.md -->

---
product: DataWeave
version: 2.4
---

# Streaming in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave supports end-to-end streaming through a flow in a Mule application. Streaming speeds the
processing of large documents without overloading memory.

DataWeave processes streamed data as its bytes arrive instead of scanning the entire document to
index it. When in deferred mode, DataWeave can also pass streamed output data directly to a message
processor without saving it to the disk. This behavior enables DataWeave and Mule to process data
faster and consume fewer resources than the default processes for reading and writing data.

To stream successfully, it is important to understand the following:

- The basic unit of the stream is specific to the data format.  
  The unit is a record in a CSV document, an element of an array in a JSON document, or a collection
  in an XML document.

- Streaming accesses each unit of the stream sequentially.  
  Streaming doesn’t support random access to a document.

## Enabling Streaming

Streaming isn’t enabled by default. You can use two configuration properties to stream data in a
supported data format:

- `streaming` property, for reading source data as a stream

- `deferred` writer property, for passing an output stream directly to the next message processor in
  a flow

For DataWeave to read source data as a stream, you must set the `streaming` reader property to
`true` on the data source. Within a Mule application, you append this setting to the value of the
**MIME Type** property `outputMimeType` or `mimeType`. You can set the property in any connector
operation or Mule component that generates data, such as an HTTP Listener operation, HTTP Request
operation, On New or Updated File operation, or a Set Payload component. DataWeave reads data as
streamed data from the point in the application where you set the streaming property through all
downstream components and connector operations that contain DataWeave expressions and scripts.

```XML
<flow name="dw-streaming-example" >
  <http:listener doc:name="Listener"
      outputMimeType="application/json; streaming=true"
      config-ref="HTTP_Listener_config" path="/input"/>
</flow>
```

Notice that `streaming=true` is part of the `outputMimeType` value. Many other Mule components, such
as the File and FTP components, also support the MIME Type setting.

To pass the streamed output to the next message processor, you can use the `output` directive in a
DataWeave script, for example:

```XML
output application/json deferred=true
```

For more detail on use of the `deferred` property. see [Streaming Output](#stream_output).

## Streaming CSV

CSV is simplest format for streaming because of its structure. Each row below the CSV header is a
streamable record. The following CSV example consists of records that contain `name`, `lastName`,
and `age` values: ​

```CSV
name,lastName,age
mariano,achaval,37
leandro,shokida,30
pedro,achaval,4
christian,chibana,25
sara,achaval,2
matias,achaval,8
```

​ To stream this CSV example, the following script selects values from each record. It uses the
`map` function to iterate over each record in the document. ​

```DataWeave
payload map (record) ->
    {
        FullName: record.lastName ++ "," ++ record.name,
        Age: record.age
    }
```

Although streaming doesn’t support random access to the entire document, a DataWeave script can
access data randomly _within each record_ because each record is loaded into memory. For example,
the expression `record.lastName "," record.name,` can access a `lastName` value before it accesses a
`name` value even though the order of values is reversed in the input.

However, streaming doesn’t work in the following script. The script requires random access to the
entire document to return the elements in a different order than they are given in the input. ​

```DataWeave
[payload[-2], payload[-1], payload[3]]
```

​

## Streaming JSON

​ The unit of a JSON stream is each element in an array.

Note that DataWeave 2.2.0 support for JSON streaming for Mule 4.2 was limited by the requirement
that the root be an array. DataWeave support in Mule 4.3 includes streaming to arrays that aren’t at
the root of the input.

```JSON
{
    "name" : "Mariano",
    "lastName": "Achaval",
    "family": [
        {"name": "Sara", "age": 2},
        {"name": "Pedro", "age": 4},
        {"name": "Matias", "age": 8}
    ],
    "age": 37
}
```

​ In this example, DataWeave can stream `payload.family` and perform random access within each
element of that array. However, DataWeave cannot randomly access the container object. For example,
it isn’t possible to stream `{ a: payload.age , b: payload.family}` because `age` follows `family`,
and DataWeave cannot go backwards. ​

## Streaming XML

​ XML is more complicated than JSON because there are no arrays in the document.

To enable XML streaming, DataWeave provides the following reader property to define the location in
the document to stream:

- `collectionPath`

For example, assume the following XML input: ​

```XML
<order>
    <header>
        <date>Wed Nov 15 13:45:28 EST 2006</date>
        <customer number="123123">Joe</customer>
    </header>
    <order-items>
        <order-item id="31">
            <product>111</product>
            <quantity>2</quantity>
            <price>8.90</price>
        </order-item>
        <order-item id="31">
            <product>222</product>
            <quantity>7</quantity>
            <price>5.20</price>
        </order-item>
        <order-item id="31">
            <product>111</product>
            <quantity>2</quantity>
            <price>8.90</price>
        </order-item>
        <order-item id="31">
            <product>222</product>
            <quantity>7</quantity>
            <price>5.20</price>
        </order-item>
        <order-item id="31">
            <product>222</product>
            <quantity>7</quantity>
            <price>5.20</price>
        </order-item>
    </order-items>
</order>
```

​ Given this XML source data, you can set the unit of the stream to `<order-item/>` by setting
`collectionPath=order.order-items` in the `outputMimeType` value:

```XML
<flow name="dw-streaming-example" >
  <http:listener doc:name="Listener"
      outputMimeType="application/xml; collectionpath=order.order-items; streaming=true"
      config-ref="HTTP_Listener_config" path="/input"/>
</flow>
```

Note that you need to set both `streaming=true` and the `collectionPath` value. If either is
missing, DataWeave doesn’t stream the content. The following DataWeave script streams the XML input
using each `<order-items/>` element as the streamable unit.

```DataWeave
%dw 2.0
output application/xml
---
{
  salesorder: {
    itemList: payload.order."order-items".*"order-item" map {
      ("i_" ++ $$) : {
        id: $.@id,
        productId: $.product,
        quantity: $.quantity,
        price: $.price
      }
    }
  }
}
```

The script produces the following XML output:

```XML
<?xml version='1.0' encoding='UTF-8'?>
<salesorder>
  <itemList>
    <i_0>
      <id>31</id>
      <quantity>2</quantity>
      <productId>111</productId>
      <price>8.90</price>
    </i_0>
  </itemList>
  <itemList>
    <i_1>
      <id>31</id>
      <quantity>7</quantity>
      <productId>222</productId>
      <price>5.20</price>
    </i_1>
  </itemList>
  <itemList>
    <i_2>
      <id>31</id>
      <quantity>2</quantity>
      <productId>111</productId>
      <price>8.90</price>
    </i_2>
  </itemList>
  <itemList>
    <i_3>
      <id>31</id>
      <quantity>7</quantity>
      <productId>222</productId>
      <price>5.20</price>
    </i_3>
  </itemList>
  <itemList>
    <i_4>
      <id>31</id>
      <quantity>7</quantity>
      <productId>222</productId>
      <price>5.20</price>
    </i_4>
  </itemList>
</salesorder>
```

## Validate a Script for Streamed Data (Experimental Feature)

To check that your code can process an input stream successfully, DataWeave provides the following
_advanced, experimental_ annotation and a related directive:

- `@StreamCapable()`  
  Use this annotation to validate whether the script can sequentially access a variable (typically
  the `payload` variable).

- `input` directive:  
  The `@StreamCapable()` annotation requires the use of an input directive in the DataWeave script
  that identifies the MIME type of the data source, for example, `input payload application/xml`.

The DataWeave validator (which is triggered by the `@StreamCapable` annotation in the script) checks
a script against the following criteria:

- The variable is referenced only once.

- No index selector is set for negative access, such as `[-1]`.

- No reference to the variable is found in a nested lambda.

If all criteria are met, the selected data is streamable.

The following example validates successfully. The script is designed to act on the
[JSON input](#example_json) from the [JSON streaming](#stream_json) section:

```DataWeave
%dw 2.0

@StreamCapable()
input payload application/json
output application/json
---
payload.family filter (member) -> member.age > 3
```

The script successfully validates and returns the following output:

```JSON
[
  {
    "name": "Pedro",
    "age": 4
  },
  {
    "name": "Matias",
    "age": 8
  }
]
```

### Validation Failures

If any of the criteria that the validator checks is false, the validation fails.

Before proceeding, note that validation can fail in some cases when streaming works. If you write a
script in a way that sequentially accesses the input variable in a given data source, streaming
works, but that script might not work in all cases. For example, JSON doesn’t place a restriction on
the order of the keys in an object. If the keys in some JSON documents arrive in a different order
than the script expects, streaming will fail in those cases. The annotation processor follows the
rules of the format and cannot assume that the keys always arrive in the same order.

#### Error: Variable Is Referenced More Than Once

Validation fails if a script attempts to reference the same variable more than once.

The following script is designed to act on the [JSON input](#example_json) from the
[JSON streaming](#stream_json) section. Validation fails because the script attempts to reference
the `payload` variable more than once:

```DataWeave
%dw 2.0

@StreamCapable()
input payload application/json
output application/json
---
 {
     family: payload.family filter (member) -> member.age > 3,
     name: payload.name
 }
```

The script fails with the following error:

```error
4| input payload application/json streaming=true
         ^^^^^^^
Parameter `payload` is not stream capable.
Reasons:
 - Variable payload is referenced more than once. Locations:
 ---------------------------

8|      family: payload.family filter (member) -> member.age > 3,
                ^^^^^^^
 ---------------------------

9|      name: payload.name
              ^^^^^^^ at
4| input payload application/json streaming=true
```

#### Error: Wrong Scope Reference

Validation fails if a script attempts to reference a variable from a scope that is different from
the scope in which the variable is defined.

The following script fails because the `payload` variable is referenced from within the lambda
expression `[1,2,3] map ((item, index) → payload)`. Even if the expression is
`[1] map ((item, index) → payload`, streaming fails because `payload` is in the wrong scope.

```DataWeave
%dw 2.0

@StreamCapable()
input payload application/json
output application/json
---
[1,2,3] map ((item, index) -> payload)
```

The example fails with the following error:

```error
4| input payload application/json
         ^^^^^^^
Parameter `payload` is not stream capable.
Reasons:
 - Variable payload is referenced in a different scope from where it was defined. Locations:
 ---------------------------

9| [1,2,3] map ((item, index) -> payload)
                ^^^^^^^^^^^^^^^^^^^^^^^^ at
4| input payload application/json
```

## Streaming Output

After processing streamed data, you can stream the output directly to another message processor. To
facilitate this behavior, use the `deferred` writer property in the output directive of the
DataWeave script, for example, `output application/json deferred=true`.

NOTE

Exceptions aren’t handled when you set `deferred = true`. For example, you can see this behavior in
Studio when a flow throws an exception. If you are running an application in Studio debug mode and
an exception occurs in a Transform Message component when `deferred = true`, the console logs the
error, but the flow doesn’t stop at the Transform Message component.

Building on the example in [JSON Streaming](#stream_json), the following flow uses a DataWeave
script to filter streamed input and then streams the output directly to a Write operation:

```XML
<flow name="dw-streamingexample">
  <file:listener doc:name="On New or Updated File"
    config-ref="File_Config" directory="/Users/me/testing/json" recursive="false" outputMimeType="application/json;
    streaming=true">
    <scheduling-strategy>
      <fixed-frequency timeUnit="SECONDS" />
    </scheduling-strategy>
    <file:matcher />
  </file:listener>
  <ee:transform doc:name="Transform Message">
    <ee:message>
      <ee:set-payload><![CDATA[%dw 2.0

@StreamCapable()
input payload application/json
output application/json deferred = true
---
{
   family: payload.family filter (member) -> member.age > 1
}]]></ee:set-payload>
    </ee:message>
  </ee:transform>
  <file:write doc:name="Write"
      config-ref="File_Config2"
      path="/Users/me/testing/output.json"/>
</flow>
```

The flow provides the following configuration:

1.  The listener (`<file:listener>`) uses `streaming=true` to stream the incoming JSON data.

2.  The DataWeave script in `<ee:transform/>` filters records in the streamed data and uses the
    `deferred = true` property to stream the resulting records directly to the next processor in the
    flow.

3.  The next component in the flow, `<file:write/>`, receives the filtered stream directly and
    writes the records to a file.

## See Also

- [CSV Format](https://docs.mulesoft.com/dataweave/2.4/dataweave-formats-csv)

- [JSON Format](https://docs.mulesoft.com/dataweave/2.4/dataweave-formats-json)

- [XML Format](https://docs.mulesoft.com/dataweave/2.4/dataweave-formats-xml)

- [Supported DataWeave Formats](https://docs.mulesoft.com/dataweave/2.4/dataweave-formats)

<!-- document id=5effced08d03893e4b53db6dedc322d6dd80a1c9c70f197f3af2aed1be7f397c url=/mulesoft/current/en-us/dataweave/2.6/dataweave-streaming.md -->

---
product: DataWeave
version: 2.6
---

# Streaming in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave supports end-to-end streaming through a flow in a Mule application. Streaming speeds the
processing of large documents without overloading memory.

DataWeave processes streamed data as its bytes arrive instead of scanning the entire document to
index it. When in deferred mode, DataWeave can also pass streamed output data directly to a message
processor without saving it to the disk. This behavior enables DataWeave and Mule to process data
faster and consume fewer resources than the default processes for reading and writing data.

To stream successfully, it is important to understand the following:

- The basic unit of the stream is specific to the data format.  
  The unit is a record in a CSV document, an element of an array in a JSON document, or a collection
  in an XML document.

- Streaming accesses each unit of the stream sequentially.  
  Streaming doesn´t support random access to a document.

## Enabling Streaming

Streaming isn’t enabled by default. You can use two configuration properties to stream data in a
supported data format:

- `streaming` property, for reading source data as a stream

- `deferred` writer property, for passing an output stream directly to the next message processor in
  a flow

For DataWeave to read source data as a stream, you must set the `streaming` reader property to
`true` on the data source. Within a Mule application, you append this setting to the value of the
**MIME Type** property `outputMimeType` or `mimeType`. You can set the property in any connector
operation or Mule component that generates data, such as an HTTP Listener operation, HTTP Request
operation, On New or Updated File operation, or a Set Payload component. DataWeave reads data as
streamed data from the point in the application where you set the streaming property through all
downstream components and connector operations that contain DataWeave expressions and scripts.

```XML
<flow name="dw-streaming-example" >
  <http:listener doc:name="Listener"
      outputMimeType="application/json; streaming=true"
      config-ref="HTTP_Listener_config" path="/input"/>
</flow>
```

Notice that `streaming=true` is part of the `outputMimeType` value. Many other Mule components, such
as the File and FTP components, also support the MIME Type setting.

To pass the streamed output to the next message processor, you can use the `output` directive in a
DataWeave script, for example:

```XML
output application/json deferred=true
```

For more detail on use of the `deferred` property. see [Streaming Output](#stream_output).

## Streaming CSV

CSV is simplest format for streaming because of its structure. Each row below the CSV header is a
streamable record. The following CSV example consists of records that contain `name`, `lastName`,
and `age` values: ​

```CSV
name,lastName,age
mariano,achaval,37
leandro,shokida,30
pedro,achaval,4
christian,chibana,25
sara,achaval,2
matias,achaval,8
```

​ To stream this CSV example, the following script selects values from each record. It uses the
`map` function to iterate over each record in the document. ​

```DataWeave
payload map (record) ->
    {
        FullName: record.lastName ++ "," ++ record.name,
        Age: record.age
    }
```

Although streaming doesn’t support random access to the entire document, a DataWeave script can
access data randomly _within each record_ because each record is loaded into memory. For example,
the expression `record.lastName "," record.name,` can access a `lastName` value before it accesses a
`name` value even though the order of values is reversed in the input.

However, streaming doesn’t work in the following script. The script requires random access to the
entire document to return the elements in a different order than they are given in the input. ​

```DataWeave
[payload[-2], payload[-1], payload[3]]
```

​

## Streaming JSON

​ The unit of a JSON stream is each element in an array.

Note that DataWeave 2.2.0 support for JSON streaming for Mule 4.2 was limited by the requirement
that the root be an array. DataWeave support in Mule 4.3 includes streaming to arrays that aren’t at
the root of the input.

```JSON
{
    "name" : "Mariano",
    "lastName": "Achaval",
    "family": [
        {"name": "Sara", "age": 2},
        {"name": "Pedro", "age": 4},
        {"name": "Matias", "age": 8}
    ],
    "age": 37
}
```

​ In this example, DataWeave can stream `payload.family` and perform random access within each
element of that array. However, DataWeave cannot randomly access the container object. For example,
it isn’t possible to stream `{ a: payload.age , b: payload.family}` because `age` follows `family`,
and DataWeave cannot go backwards. ​

## Streaming XML

​ XML is more complicated than JSON because there are no arrays in the document.

To enable XML streaming, DataWeave provides the following reader property to define the location in
the document to stream:

- `collectionPath`

For example, assume the following XML input: ​

```XML
<order>
    <header>
        <date>Wed Nov 15 13:45:28 EST 2006</date>
        <customer number="123123">Joe</customer>
    </header>
    <order-items>
        <order-item id="31">
            <product>111</product>
            <quantity>2</quantity>
            <price>8.90</price>
        </order-item>
        <order-item id="31">
            <product>222</product>
            <quantity>7</quantity>
            <price>5.20</price>
        </order-item>
        <order-item id="31">
            <product>111</product>
            <quantity>2</quantity>
            <price>8.90</price>
        </order-item>
        <order-item id="31">
            <product>222</product>
            <quantity>7</quantity>
            <price>5.20</price>
        </order-item>
        <order-item id="31">
            <product>222</product>
            <quantity>7</quantity>
            <price>5.20</price>
        </order-item>
    </order-items>
</order>
```

​ Given this XML source data, you can set the unit of the stream to `<order-item/>` by setting
`collectionPath=order.order-items` in the `outputMimeType` value:

```XML
<flow name="dw-streaming-example" >
  <http:listener doc:name="Listener"
      outputMimeType="application/xml; collectionpath=order.order-items; streaming=true"
      config-ref="HTTP_Listener_config" path="/input"/>
</flow>
```

Note that you need to set both `streaming=true` and the `collectionPath` value. If either is
missing, DataWeave doesn’t stream the content. The following DataWeave script streams the XML input
using each `<order-items/>` element as the streamable unit.

```DataWeave
%dw 2.0
output application/xml
---
{
  salesorder: {
    itemList: payload.order."order-items".*"order-item" map {
      ("i_" ++ $$) : {
        id: $.@id,
        productId: $.product,
        quantity: $.quantity,
        price: $.price
      }
    }
  }
}
```

The script produces the following XML output:

```XML
<?xml version='1.0' encoding='UTF-8'?>
<salesorder>
  <itemList>
    <i_0>
      <id>31</id>
      <quantity>2</quantity>
      <productId>111</productId>
      <price>8.90</price>
    </i_0>
  </itemList>
  <itemList>
    <i_1>
      <id>31</id>
      <quantity>7</quantity>
      <productId>222</productId>
      <price>5.20</price>
    </i_1>
  </itemList>
  <itemList>
    <i_2>
      <id>31</id>
      <quantity>2</quantity>
      <productId>111</productId>
      <price>8.90</price>
    </i_2>
  </itemList>
  <itemList>
    <i_3>
      <id>31</id>
      <quantity>7</quantity>
      <productId>222</productId>
      <price>5.20</price>
    </i_3>
  </itemList>
  <itemList>
    <i_4>
      <id>31</id>
      <quantity>7</quantity>
      <productId>222</productId>
      <price>5.20</price>
    </i_4>
  </itemList>
</salesorder>
```

## Validate a Script for Streamed Data (Experimental Feature)

To check that your code can process an input stream successfully, DataWeave provides the following
_advanced, experimental_ annotation and a related directive:

- `@StreamCapable()`  
  Use this annotation to validate whether the script can sequentially access a variable (typically
  the `payload` variable).

- `input` directive:  
  The `@StreamCapable()` annotation requires the use of an input directive in the DataWeave script
  that identifies the MIME type of the data source, for example, `input payload application/xml`.

The DataWeave validator (which is triggered by the `@StreamCapable` annotation in the script) checks
a script against the following criteria:

- The variable is referenced only once.

- No index selector is set for negative access, such as `[-1]`.

- No reference to the variable is found in a nested lambda.

If all criteria are met, the selected data is streamable.

The following example validates successfully. The script is designed to act on the
[JSON input](#example_json) from the [JSON streaming](#stream_json) section:

```DataWeave
%dw 2.0

@StreamCapable()
input payload application/json
output application/json
---
payload.family filter (member) -> member.age > 3
```

The script successfully validates and returns the following output:

```JSON
[
  {
    "name": "Pedro",
    "age": 4
  },
  {
    "name": "Matias",
    "age": 8
  }
]
```

### Validation Failures

If any of the criteria that the validator checks is false, the validation fails.

Before proceeding, note that validation can fail in some cases when streaming works. If you write a
script in a way that sequentially accesses the input variable in a given data source, streaming
works, but that script might not work in all cases. For example, JSON doesn’t place a restriction on
the order of the keys in an object. If the keys in some JSON documents arrive in a different order
than the script expects, streaming will fail in those cases. The annotation processor follows the
rules of the format and cannot assume that the keys always arrive in the same order.

#### Error: Variable Is Referenced More Than Once

Validation fails if a script attempts to reference the same variable more than once.

The following script is designed to act on the [JSON input](#example_json) from the
[JSON streaming](#stream_json) section. Validation fails because the script attempts to reference
the `payload` variable more than once:

```DataWeave
%dw 2.0

@StreamCapable()
input payload application/json
output application/json
---
 {
     family: payload.family filter (member) -> member.age > 3,
     name: payload.name
 }
```

The script fails with the following error:

```error
4| input payload application/json streaming=true
         ^^^^^^^
Parameter `payload` is not stream capable.
Reasons:
 - Variable payload is referenced more than once. Locations:
 ---------------------------

8|      family: payload.family filter (member) -> member.age > 3,
                ^^^^^^^
 ---------------------------

9|      name: payload.name
              ^^^^^^^ at
4| input payload application/json streaming=true
```

#### Error: Wrong Scope Reference

Validation fails if a script attempts to reference a variable from a scope that is different from
the scope in which the variable is defined.

The following script fails because the `payload` variable is referenced from within the lambda
expression `[1,2,3] map ((item, index) → payload)`. Even if the expression is
`[1] map ((item, index) → payload`, streaming fails because `payload` is in the wrong scope.

```DataWeave
%dw 2.0

@StreamCapable()
input payload application/json
output application/json
---
[1,2,3] map ((item, index) -> payload)
```

The example fails with the following error:

```error
4| input payload application/json
         ^^^^^^^
Parameter `payload` is not stream capable.
Reasons:
 - Variable payload is referenced in a different scope from where it was defined. Locations:
 ---------------------------

9| [1,2,3] map ((item, index) -> payload)
                ^^^^^^^^^^^^^^^^^^^^^^^^ at
4| input payload application/json
```

## Streaming Output

After processing streamed data, you can stream the output directly to another message processor. To
facilitate this behavior, use the `deferred` writer property in the output directive of the
DataWeave script, for example, `output application/json deferred=true`.

NOTE

Exceptions aren’t handled when you set `deferred = true`. For example, you can see this behavior in
Studio when a flow throws an exception. If you are running an application in Studio debug mode and
an exception occurs in a Transform Message component when `deferred = true`, the console logs the
error, but the flow doesn’t stop at the Transform Message component.

Building on the example in [JSON Streaming](#stream_json), the following flow uses a DataWeave
script to filter streamed input and then streams the output directly to a Write operation:

```XML
<flow name="dw-streamingexample">
  <file:listener doc:name="On New or Updated File"
    config-ref="File_Config" directory="/Users/me/testing/json" recursive="false" outputMimeType="application/json;
    streaming=true">
    <scheduling-strategy>
      <fixed-frequency timeUnit="SECONDS" />
    </scheduling-strategy>
    <file:matcher />
  </file:listener>
  <ee:transform doc:name="Transform Message">
    <ee:message>
      <ee:set-payload><![CDATA[%dw 2.0

@StreamCapable()
input payload application/json
output application/json deferred = true
---
{
   family: payload.family filter (member) -> member.age > 1
}]]></ee:set-payload>
    </ee:message>
  </ee:transform>
  <file:write doc:name="Write"
      config-ref="File_Config2"
      path="/Users/me/testing/output.json"/>
</flow>
```

The flow provides the following configuration:

1.  The listener (`<file:listener>`) uses `streaming=true` to stream the incoming JSON data.

2.  The DataWeave script in `<ee:transform/>` filters records in the streamed data and uses the
    `deferred = true` property to stream the resulting records directly to the next processor in the
    flow.

3.  The next component in the flow, `<file:write/>`, receives the filtered stream directly and
    writes the records to a file.

## See Also

- [CSV Format](https://docs.mulesoft.com/dataweave/2.6/dataweave-formats-csv)

- [JSON Format](https://docs.mulesoft.com/dataweave/2.6/dataweave-formats-json)

- [XML Format](https://docs.mulesoft.com/dataweave/2.6/dataweave-formats-xml)

- [Supported DataWeave Formats](https://docs.mulesoft.com/dataweave/2.6/dataweave-formats)

<!-- document id=6002f8a7f726a0b9c57b5e1a591a5e4f333d9c94baedf63859b88c0576e4674f url=/mulesoft/current/en-us/dataweave/2.9/dataweave-streaming.md -->

---
product: DataWeave
version: 2.9
---

# Streaming in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave supports end-to-end streaming through a flow in a Mule application. Streaming speeds the
processing of large documents without overloading memory.

DataWeave processes streamed data as its bytes arrive instead of scanning the entire document to
index it. When in deferred mode, DataWeave can also pass streamed output data directly to a message
processor without saving it to the disk. This behavior enables DataWeave and Mule to process data
faster and consume fewer resources than the default processes for reading and writing data.

To stream successfully, it is important to understand the following:

- The basic unit of the stream is specific to the data format.  
  The unit is a record in a CSV document, an element of an array in a JSON document, or a collection
  in an XML document.

- Streaming accesses each unit of the stream sequentially.  
  Streaming doesn’t support random access to a document.

## Enabling Streaming

Streaming isn’t enabled by default. You can use two configuration properties to stream data in a
supported data format:

- `streaming` property, for reading source data as a stream

- `deferred` writer property, for passing an output stream directly to the next message processor in
  a flow

For DataWeave to read source data as a stream, you must set the `streaming` reader property to
`true` on the data source. Within a Mule application, you append this setting to the value of the
**MIME Type** property `outputMimeType` or `mimeType`. You can set the property in any connector
operation or Mule component that generates data, such as an HTTP Listener operation, HTTP Request
operation, On New or Updated File operation, or a Set Payload component. DataWeave reads data as
streamed data from the point in the application where you set the streaming property through all
downstream components and connector operations that contain DataWeave expressions and scripts.

```XML
<flow name="dw-streaming-example" >
  <http:listener doc:name="Listener"
      outputMimeType="application/json; streaming=true"
      config-ref="HTTP_Listener_config" path="/input"/>
</flow>
```

Notice that `streaming=true` is part of the `outputMimeType` value. Many other Mule components, such
as the File and FTP components, also support the MIME Type setting.

To pass the streamed output to the next message processor, you can use the `output` directive in a
DataWeave script, for example:

```XML
output application/json deferred=true
```

For more detail on use of the `deferred` property. see [Streaming Output](#stream_output).

## Streaming CSV

CSV is simplest format for streaming because of its structure. Each row below the CSV header is a
streamable record. The following CSV example consists of records that contain `name`, `lastName`,
and `age` values: ​

```CSV
name,lastName,age
mariano,achaval,37
leandro,shokida,30
pedro,achaval,4
christian,chibana,25
sara,achaval,2
matias,achaval,8
```

​ To stream this CSV example, the following script selects values from each record. It uses the
`map` function to iterate over each record in the document. ​

```DataWeave
payload map (record) ->
    {
        FullName: record.lastName ++ "," ++ record.name,
        Age: record.age
    }
```

Although streaming doesn’t support random access to the entire document, a DataWeave script can
access data randomly _within each record_ because each record is loaded into memory. For example,
the expression `record.lastName "," record.name,` can access a `lastName` value before it accesses a
`name` value even though the order of values is reversed in the input.

However, streaming doesn’t work in the following script. The script requires random access to the
entire document to return the elements in a different order than they are given in the input. ​

```DataWeave
[payload[-2], payload[-1], payload[3]]
```

​

## Streaming JSON

​ The unit of a JSON stream is each element in an array.

Note that DataWeave 2.2.0 support for JSON streaming for Mule 4.2 was limited by the requirement
that the root be an array. DataWeave support in Mule 4.3 includes streaming to arrays that aren’t at
the root of the input.

```JSON
{
    "name" : "Mariano",
    "lastName": "Achaval",
    "family": [
        {"name": "Sara", "age": 2},
        {"name": "Pedro", "age": 4},
        {"name": "Matias", "age": 8}
    ],
    "age": 37
}
```

​ In this example, DataWeave can stream `payload.family` and perform random access within each
element of that array. However, DataWeave cannot randomly access the container object. For example,
it isn’t possible to stream `{ a: payload.age , b: payload.family}` because `age` follows `family`,
and DataWeave cannot go backwards. ​

## Streaming XML

​ XML is more complicated than JSON because there are no arrays in the document.

To enable XML streaming, DataWeave provides the following reader property to define the location in
the document to stream:

- `collectionPath`

For example, assume the following XML input: ​

```XML
<order>
    <header>
        <date>Wed Nov 15 13:45:28 EST 2006</date>
        <customer number="123123">Joe</customer>
    </header>
    <order-items>
        <order-item id="31">
            <product>111</product>
            <quantity>2</quantity>
            <price>8.90</price>
        </order-item>
        <order-item id="31">
            <product>222</product>
            <quantity>7</quantity>
            <price>5.20</price>
        </order-item>
        <order-item id="31">
            <product>111</product>
            <quantity>2</quantity>
            <price>8.90</price>
        </order-item>
        <order-item id="31">
            <product>222</product>
            <quantity>7</quantity>
            <price>5.20</price>
        </order-item>
        <order-item id="31">
            <product>222</product>
            <quantity>7</quantity>
            <price>5.20</price>
        </order-item>
    </order-items>
</order>
```

​ Given this XML source data, you can set the unit of the stream to `<order-item/>` by setting
`collectionPath=order.order-items` in the `outputMimeType` value:

```XML
<flow name="dw-streaming-example" >
  <http:listener doc:name="Listener"
      outputMimeType="application/xml; collectionpath=order.order-items; streaming=true"
      config-ref="HTTP_Listener_config" path="/input"/>
</flow>
```

Note that you need to set both `streaming=true` and the `collectionPath` value. If either is
missing, DataWeave doesn’t stream the content. The following DataWeave script streams the XML input
using each `<order-items/>` element as the streamable unit.

```DataWeave
%dw 2.0
output application/xml
---
{
  salesorder: {
    itemList: payload.order."order-items".*"order-item" map {
      ("i_" ++ $$) : {
        id: $.@id,
        productId: $.product,
        quantity: $.quantity,
        price: $.price
      }
    }
  }
}
```

The script produces the following XML output:

```XML
<?xml version='1.0' encoding='UTF-8'?>
<salesorder>
  <itemList>
    <i_0>
      <id>31</id>
      <quantity>2</quantity>
      <productId>111</productId>
      <price>8.90</price>
    </i_0>
  </itemList>
  <itemList>
    <i_1>
      <id>31</id>
      <quantity>7</quantity>
      <productId>222</productId>
      <price>5.20</price>
    </i_1>
  </itemList>
  <itemList>
    <i_2>
      <id>31</id>
      <quantity>2</quantity>
      <productId>111</productId>
      <price>8.90</price>
    </i_2>
  </itemList>
  <itemList>
    <i_3>
      <id>31</id>
      <quantity>7</quantity>
      <productId>222</productId>
      <price>5.20</price>
    </i_3>
  </itemList>
  <itemList>
    <i_4>
      <id>31</id>
      <quantity>7</quantity>
      <productId>222</productId>
      <price>5.20</price>
    </i_4>
  </itemList>
</salesorder>
```

## Validate a Script for Streamed Data (Experimental Feature)

To check that your code can process an input stream successfully, DataWeave provides the following
_advanced, experimental_ annotation and a related directive:

- `@StreamCapable()`  
  Use this annotation to validate whether the script can sequentially access a variable (typically
  the `payload` variable).

- `input` directive:  
  The `@StreamCapable()` annotation requires the use of an input directive in the DataWeave script
  that identifies the MIME type of the data source, for example, `input payload application/xml`.

The DataWeave validator (which is triggered by the `@StreamCapable` annotation in the script) checks
a script against the following criteria:

- The variable is referenced only once.

- No index selector is set for negative access, such as `[-1]`.

- No reference to the variable is found in a nested lambda.

If all criteria are met, the selected data is streamable.

The following example validates successfully. The script is designed to act on the
[JSON input](#example_json) from the [JSON streaming](#stream_json) section:

```DataWeave
%dw 2.0

@StreamCapable()
input payload application/json
output application/json
---
payload.family filter (member) -> member.age > 3
```

The script successfully validates and returns the following output:

```JSON
[
  {
    "name": "Pedro",
    "age": 4
  },
  {
    "name": "Matias",
    "age": 8
  }
]
```

### Validation Failures

If any of the criteria that the validator checks is false, the validation fails.

Before proceeding, note that validation can fail in some cases when streaming works. If you write a
script in a way that sequentially accesses the input variable in a given data source, streaming
works, but that script might not work in all cases. For example, JSON doesn’t place a restriction on
the order of the keys in an object. If the keys in some JSON documents arrive in a different order
than the script expects, streaming will fail in those cases. The annotation processor follows the
rules of the format and cannot assume that the keys always arrive in the same order.

#### Error: Variable Is Referenced More Than Once

Validation fails if a script attempts to reference the same variable more than once.

The following script is designed to act on the [JSON input](#example_json) from the
[JSON streaming](#stream_json) section. Validation fails because the script attempts to reference
the `payload` variable more than once:

```DataWeave
%dw 2.0

@StreamCapable()
input payload application/json
output application/json
---
 {
     family: payload.family filter (member) -> member.age > 3,
     name: payload.name
 }
```

The script fails with the following error:

```error
4| input payload application/json streaming=true
         ^^^^^^^
Parameter `payload` is not stream capable.
Reasons:
 - Variable payload is referenced more than once. Locations:
 ---------------------------

8|      family: payload.family filter (member) -> member.age > 3,
                ^^^^^^^
 ---------------------------

9|      name: payload.name
              ^^^^^^^ at
4| input payload application/json streaming=true
```

#### Error: Wrong Scope Reference

Validation fails if a script attempts to reference a variable from a scope that is different from
the scope in which the variable is defined.

The following script fails because the `payload` variable is referenced from within the lambda
expression `[1,2,3] map ((item, index) → payload)`. Even if the expression is
`[1] map ((item, index) → payload`, streaming fails because `payload` is in the wrong scope.

```DataWeave
%dw 2.0

@StreamCapable()
input payload application/json
output application/json
---
[1,2,3] map ((item, index) -> payload)
```

The example fails with the following error:

```error
4| input payload application/json
         ^^^^^^^
Parameter `payload` is not stream capable.
Reasons:
 - Variable payload is referenced in a different scope from where it was defined. Locations:
 ---------------------------

9| [1,2,3] map ((item, index) -> payload)
                ^^^^^^^^^^^^^^^^^^^^^^^^ at
4| input payload application/json
```

## Streaming Output

After processing streamed data, you can stream the output directly to another message processor. To
facilitate this behavior, use the `deferred` writer property in the output directive of the
DataWeave script, for example, `output application/json deferred=true`.

NOTE

Exceptions aren’t handled when you set `deferred = true`. For example, you can see this behavior in
Studio when a flow throws an exception. If you are running an application in Studio debug mode and
an exception occurs in a Transform Message component when `deferred = true`, the console logs the
error, but the flow doesn’t stop at the Transform Message component.

Building on the example in [JSON Streaming](#stream_json), the following flow uses a DataWeave
script to filter streamed input and then streams the output directly to a Write operation:

```XML
<flow name="dw-streamingexample">
  <file:listener doc:name="On New or Updated File"
    config-ref="File_Config" directory="/Users/me/testing/json" recursive="false" outputMimeType="application/json;
    streaming=true">
    <scheduling-strategy>
      <fixed-frequency timeUnit="SECONDS" />
    </scheduling-strategy>
    <file:matcher />
  </file:listener>
  <ee:transform doc:name="Transform Message">
    <ee:message>
      <ee:set-payload><![CDATA[%dw 2.0

@StreamCapable()
input payload application/json
output application/json deferred = true
---
{
   family: payload.family filter (member) -> member.age > 1
}]]></ee:set-payload>
    </ee:message>
  </ee:transform>
  <file:write doc:name="Write"
      config-ref="File_Config2"
      path="/Users/me/testing/output.json"/>
</flow>
```

The flow provides the following configuration:

1.  The listener (`<file:listener>`) uses `streaming=true` to stream the incoming JSON data.

2.  The DataWeave script in `<ee:transform/>` filters records in the streamed data and uses the
    `deferred = true` property to stream the resulting records directly to the next processor in the
    flow.

3.  The next component in the flow, `<file:write/>`, receives the filtered stream directly and
    writes the records to a file.

## See Also

- [CSV Format](https://docs.mulesoft.com/dataweave/2.9/dataweave-formats-csv)

- [JSON Format](https://docs.mulesoft.com/dataweave/2.9/dataweave-formats-json)

- [XML Format](https://docs.mulesoft.com/dataweave/2.9/dataweave-formats-xml)

- [Supported DataWeave Formats](https://docs.mulesoft.com/dataweave/2.9/dataweave-formats)

<!-- document id=15fb0e1c8959cdbc9a29bb1e2f4cda86b01f0a47a8248a59d0267aa8e810d46f url=/mulesoft/current/en-us/dataweave/latest/dataweave-streaming.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Streaming in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave supports end-to-end streaming through a flow in a Mule application. Streaming speeds the
processing of large documents without overloading memory.

DataWeave processes streamed data as its bytes arrive instead of scanning the entire document to
index it. When in deferred mode, DataWeave can also pass streamed output data directly to a message
processor without saving it to the disk. This behavior enables DataWeave and Mule to process data
faster and consume fewer resources than the default processes for reading and writing data.

To stream successfully, it is important to understand the following:

- The basic unit of the stream is specific to the data format.  
  The unit is a record in a CSV document, an element of an array in a JSON document, or a collection
  in an XML document.

- Streaming accesses each unit of the stream sequentially.  
  Streaming doesn’t support random access to a document.

## Enabling Streaming

Streaming isn’t enabled by default. You can use two configuration properties to stream data in a
supported data format:

- `streaming` property, for reading source data as a stream

- `deferred` writer property, for passing an output stream directly to the next message processor in
  a flow

For DataWeave to read source data as a stream, you must set the `streaming` reader property to
`true` on the data source. Within a Mule application, you append this setting to the value of the
**MIME Type** property `outputMimeType` or `mimeType`. You can set the property in any connector
operation or Mule component that generates data, such as an HTTP Listener operation, HTTP Request
operation, On New or Updated File operation, or a Set Payload component. DataWeave reads data as
streamed data from the point in the application where you set the streaming property through all
downstream components and connector operations that contain DataWeave expressions and scripts.

```XML
<flow name="dw-streaming-example" >
  <http:listener doc:name="Listener"
      outputMimeType="application/json; streaming=true"
      config-ref="HTTP_Listener_config" path="/input"/>
</flow>
```

Notice that `streaming=true` is part of the `outputMimeType` value. Many other Mule components, such
as the File and FTP components, also support the MIME Type setting.

To pass the streamed output to the next message processor, you can use the `output` directive in a
DataWeave script, for example:

```XML
output application/json deferred=true
```

For more detail on use of the `deferred` property. see [Streaming Output](#stream_output).

## Streaming CSV

CSV is simplest format for streaming because of its structure. Each row below the CSV header is a
streamable record. The following CSV example consists of records that contain `name`, `lastName`,
and `age` values: ​

```CSV
name,lastName,age
mariano,achaval,37
leandro,shokida,30
pedro,achaval,4
christian,chibana,25
sara,achaval,2
matias,achaval,8
```

​ To stream this CSV example, the following script selects values from each record. It uses the
`map` function to iterate over each record in the document. ​

```DataWeave
payload map (record) ->
    {
        FullName: record.lastName ++ "," ++ record.name,
        Age: record.age
    }
```

Although streaming doesn’t support random access to the entire document, a DataWeave script can
access data randomly _within each record_ because each record is loaded into memory. For example,
the expression `record.lastName "," record.name,` can access a `lastName` value before it accesses a
`name` value even though the order of values is reversed in the input.

However, streaming doesn’t work in the following script. The script requires random access to the
entire document to return the elements in a different order than they are given in the input. ​

```DataWeave
[payload[-2], payload[-1], payload[3]]
```

​

## Streaming JSON

​ The unit of a JSON stream is each element in an array.

Note that DataWeave 2.2.0 support for JSON streaming for Mule 4.2 was limited by the requirement
that the root be an array. DataWeave support in Mule 4.3 includes streaming to arrays that aren’t at
the root of the input.

```JSON
{
    "name" : "Mariano",
    "lastName": "Achaval",
    "family": [
        {"name": "Sara", "age": 2},
        {"name": "Pedro", "age": 4},
        {"name": "Matias", "age": 8}
    ],
    "age": 37
}
```

​ In this example, DataWeave can stream `payload.family` and perform random access within each
element of that array. However, DataWeave cannot randomly access the container object. For example,
it isn’t possible to stream `{ a: payload.age , b: payload.family}` because `age` follows `family`,
and DataWeave cannot go backwards. ​

## Streaming XML

​ XML is more complicated than JSON because there are no arrays in the document.

To enable XML streaming, DataWeave provides the following reader property to define the location in
the document to stream:

- `collectionPath`

For example, assume the following XML input: ​

```XML
<order>
    <header>
        <date>Wed Nov 15 13:45:28 EST 2006</date>
        <customer number="123123">Joe</customer>
    </header>
    <order-items>
        <order-item id="31">
            <product>111</product>
            <quantity>2</quantity>
            <price>8.90</price>
        </order-item>
        <order-item id="31">
            <product>222</product>
            <quantity>7</quantity>
            <price>5.20</price>
        </order-item>
        <order-item id="31">
            <product>111</product>
            <quantity>2</quantity>
            <price>8.90</price>
        </order-item>
        <order-item id="31">
            <product>222</product>
            <quantity>7</quantity>
            <price>5.20</price>
        </order-item>
        <order-item id="31">
            <product>222</product>
            <quantity>7</quantity>
            <price>5.20</price>
        </order-item>
    </order-items>
</order>
```

​ Given this XML source data, you can set the unit of the stream to `<order-item/>` by setting
`collectionPath=order.order-items` in the `outputMimeType` value:

```XML
<flow name="dw-streaming-example" >
  <http:listener doc:name="Listener"
      outputMimeType="application/xml; collectionpath=order.order-items; streaming=true"
      config-ref="HTTP_Listener_config" path="/input"/>
</flow>
```

Note that you need to set both `streaming=true` and the `collectionPath` value. If either is
missing, DataWeave doesn’t stream the content. The following DataWeave script streams the XML input
using each `<order-items/>` element as the streamable unit.

```DataWeave
%dw 2.0
output application/xml
---
{
  salesorder: {
    itemList: payload.order."order-items".*"order-item" map {
      ("i_" ++ $$) : {
        id: $.@id,
        productId: $.product,
        quantity: $.quantity,
        price: $.price
      }
    }
  }
}
```

The script produces the following XML output:

```XML
<?xml version='1.0' encoding='UTF-8'?>
<salesorder>
  <itemList>
    <i_0>
      <id>31</id>
      <quantity>2</quantity>
      <productId>111</productId>
      <price>8.90</price>
    </i_0>
  </itemList>
  <itemList>
    <i_1>
      <id>31</id>
      <quantity>7</quantity>
      <productId>222</productId>
      <price>5.20</price>
    </i_1>
  </itemList>
  <itemList>
    <i_2>
      <id>31</id>
      <quantity>2</quantity>
      <productId>111</productId>
      <price>8.90</price>
    </i_2>
  </itemList>
  <itemList>
    <i_3>
      <id>31</id>
      <quantity>7</quantity>
      <productId>222</productId>
      <price>5.20</price>
    </i_3>
  </itemList>
  <itemList>
    <i_4>
      <id>31</id>
      <quantity>7</quantity>
      <productId>222</productId>
      <price>5.20</price>
    </i_4>
  </itemList>
</salesorder>
```

## Validate a Script for Streamed Data (Experimental Feature)

To check that your code can process an input stream successfully, DataWeave provides the following
_advanced, experimental_ annotation and a related directive:

- `@StreamCapable()`  
  Use this annotation to validate whether the script can sequentially access a variable (typically
  the `payload` variable).

- `input` directive:  
  The `@StreamCapable()` annotation requires the use of an input directive in the DataWeave script
  that identifies the MIME type of the data source, for example, `input payload application/xml`.

The DataWeave validator (which is triggered by the `@StreamCapable` annotation in the script) checks
a script against the following criteria:

- The variable is referenced only once.

- No index selector is set for negative access, such as `[-1]`.

- No reference to the variable is found in a nested lambda.

If all criteria are met, the selected data is streamable.

The following example validates successfully. The script is designed to act on the
[JSON input](#example_json) from the [JSON streaming](#stream_json) section:

```DataWeave
%dw 2.0

@StreamCapable()
input payload application/json
output application/json
---
payload.family filter (member) -> member.age > 3
```

The script successfully validates and returns the following output:

```JSON
[
  {
    "name": "Pedro",
    "age": 4
  },
  {
    "name": "Matias",
    "age": 8
  }
]
```

### Validation Failures

If any of the criteria that the validator checks is false, the validation fails.

Before proceeding, note that validation can fail in some cases when streaming works. If you write a
script in a way that sequentially accesses the input variable in a given data source, streaming
works, but that script might not work in all cases. For example, JSON doesn’t place a restriction on
the order of the keys in an object. If the keys in some JSON documents arrive in a different order
than the script expects, streaming will fail in those cases. The annotation processor follows the
rules of the format and cannot assume that the keys always arrive in the same order.

#### Error: Variable Is Referenced More Than Once

Validation fails if a script attempts to reference the same variable more than once.

The following script is designed to act on the [JSON input](#example_json) from the
[JSON streaming](#stream_json) section. Validation fails because the script attempts to reference
the `payload` variable more than once:

```DataWeave
%dw 2.0

@StreamCapable()
input payload application/json
output application/json
---
 {
     family: payload.family filter (member) -> member.age > 3,
     name: payload.name
 }
```

The script fails with the following error:

```error
4| input payload application/json streaming=true
         ^^^^^^^
Parameter `payload` is not stream capable.
Reasons:
 - Variable payload is referenced more than once. Locations:
 ---------------------------

8|      family: payload.family filter (member) -> member.age > 3,
                ^^^^^^^
 ---------------------------

9|      name: payload.name
              ^^^^^^^ at
4| input payload application/json streaming=true
```

#### Error: Wrong Scope Reference

Validation fails if a script attempts to reference a variable from a scope that is different from
the scope in which the variable is defined.

The following script fails because the `payload` variable is referenced from within the lambda
expression `[1,2,3] map ((item, index) → payload)`. Even if the expression is
`[1] map ((item, index) → payload`, streaming fails because `payload` is in the wrong scope.

```DataWeave
%dw 2.0

@StreamCapable()
input payload application/json
output application/json
---
[1,2,3] map ((item, index) -> payload)
```

The example fails with the following error:

```error
4| input payload application/json
         ^^^^^^^
Parameter `payload` is not stream capable.
Reasons:
 - Variable payload is referenced in a different scope from where it was defined. Locations:
 ---------------------------

9| [1,2,3] map ((item, index) -> payload)
                ^^^^^^^^^^^^^^^^^^^^^^^^ at
4| input payload application/json
```

## Streaming Output

After processing streamed data, you can stream the output directly to another message processor. To
facilitate this behavior, use the `deferred` writer property in the output directive of the
DataWeave script, for example, `output application/json deferred=true`.

NOTE

Exceptions aren’t handled when you set `deferred = true`. For example, you can see this behavior in
Studio when a flow throws an exception. If you are running an application in Studio debug mode and
an exception occurs in a Transform Message component when `deferred = true`, the console logs the
error, but the flow doesn’t stop at the Transform Message component.

Building on the example in [JSON Streaming](#stream_json), the following flow uses a DataWeave
script to filter streamed input and then streams the output directly to a Write operation:

```XML
<flow name="dw-streamingexample">
  <file:listener doc:name="On New or Updated File"
    config-ref="File_Config" directory="/Users/me/testing/json" recursive="false" outputMimeType="application/json;
    streaming=true">
    <scheduling-strategy>
      <fixed-frequency timeUnit="SECONDS" />
    </scheduling-strategy>
    <file:matcher />
  </file:listener>
  <ee:transform doc:name="Transform Message">
    <ee:message>
      <ee:set-payload><![CDATA[%dw 2.0

@StreamCapable()
input payload application/json
output application/json deferred = true
---
{
   family: payload.family filter (member) -> member.age > 1
}]]></ee:set-payload>
    </ee:message>
  </ee:transform>
  <file:write doc:name="Write"
      config-ref="File_Config2"
      path="/Users/me/testing/output.json"/>
</flow>
```

The flow provides the following configuration:

1.  The listener (`<file:listener>`) uses `streaming=true` to stream the incoming JSON data.

2.  The DataWeave script in `<ee:transform/>` filters records in the streamed data and uses the
    `deferred = true` property to stream the resulting records directly to the next processor in the
    flow.

3.  The next component in the flow, `<file:write/>`, receives the filtered stream directly and
    writes the records to a file.

## See Also

- [CSV Format](https://docs.mulesoft.com/dataweave/latest/dataweave-formats-csv)

- [JSON Format](https://docs.mulesoft.com/dataweave/latest/dataweave-formats-json)

- [XML Format](https://docs.mulesoft.com/dataweave/latest/dataweave-formats-xml)

- [Supported DataWeave Formats](https://docs.mulesoft.com/dataweave/latest/dataweave-formats)

<!-- document id=0a3a39b9714e9d96449f7f443783438663454cf4554719e9185f1fe0783fd88b url=/mulesoft/current/en-us/dataweave/2.11/dw-strings.md -->

---
product: DataWeave
version: 2.11
---

# Strings (dw::core::Strings)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions for working with strings.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Strings` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-strings-functions-appendifmissing">appendIfMissing</a></p></td><td><p>Appends the <code>suffix</code> to the end of the <code>text</code> if the <code>text</code> does not already ends with the <code>suffix</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-strings-functions-camelize">camelize</a></p></td><td><p>Returns a string in camel case based on underscores in the string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-strings-functions-capitalize">capitalize</a></p></td><td><p>Capitalizes the first letter of each word in a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-strings-functions-charcode">charCode</a></p></td><td><p>Returns the Unicode for the first character in an input string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-strings-functions-charcodeat">charCodeAt</a></p></td><td><p>Returns the Unicode for a character at the specified index.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-strings-functions-collapse">collapse</a></p></td><td><p>Collapses the string into substrings of equal characters.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-strings-functions-countcharactersby">countCharactersBy</a></p></td><td><p>Counts the number of times an expression that iterates through each character in a string returns <code>true</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-strings-functions-countmatches">countMatches</a></p></td><td><p>Counts the number of matches in a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-strings-functions-dasherize">dasherize</a></p></td><td><p>Replaces spaces, underscores, and camel-casing in a string with dashes (hyphens).</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-strings-functions-everycharacter">everyCharacter</a></p></td><td><p>Checks whether a condition is valid for <em>every</em> character in a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-strings-functions-first">first</a></p></td><td><p>Returns characters from the beginning of a string to the specified number of characters in the string, for example, the first two characters of a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-strings-functions-fromcharcode">fromCharCode</a></p></td><td><p>Returns a character that matches the specified Unicode.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-strings-functions-hammingdistance">hammingDistance</a></p></td><td><p>Returns the Hamming distance between two strings.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-strings-functions-isalpha">isAlpha</a></p></td><td><p>Checks if the <code>text</code> contains only Unicode digits. A decimal point is not a Unicode digit and returns <code>false</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-strings-functions-isalphanumeric">isAlphanumeric</a></p></td><td><p>Checks if the <code>text</code> contains only Unicode letters or digits.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-strings-functions-islowercase">isLowerCase</a></p></td><td><p>Checks if the <code>text</code> contains only lowercase characters.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-strings-functions-isnumeric">isNumeric</a></p></td><td><p>Checks if the <code>text</code> contains only Unicode digits.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-strings-functions-isuppercase">isUpperCase</a></p></td><td><p>Checks if the <code>text</code> contains only uppercase characters.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-strings-functions-iswhitespace">isWhitespace</a></p></td><td><p>Checks if the <code>text</code> contains only whitespace.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-strings-functions-last">last</a></p></td><td><p>Returns characters from the end of string to a specified number of characters, for example, the last two characters of a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-strings-functions-leftpad">leftPad</a></p></td><td><p>The specified <code>text</code> is <em>left</em>-padded to the <code>size</code> using the <code>padText</code>. By default <code>padText</code> is <code>" "</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-strings-functions-levenshteindistance">levenshteinDistance</a></p></td><td><p>Returns the Levenshtein distance (or edit distance) between two strings.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-strings-functions-lines">lines</a></p></td><td><p>Returns an array of lines from a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-strings-functions-mapstring">mapString</a></p></td><td><p>Applies an expression to every character of a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-strings-functions-ordinalize">ordinalize</a></p></td><td><p>Returns a number as an ordinal, such as <code>1st</code> or <code>2nd</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-strings-functions-pluralize">pluralize</a></p></td><td><p>Pluralizes a singular string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-strings-functions-prependifmissing">prependIfMissing</a></p></td><td><p>Prepends the <code>prefix</code> to the beginning of the string if the <code>text</code> does not already start with that prefix.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-strings-functions-remove">remove</a></p></td><td><p>Removes all occurrences of a specified pattern from a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-strings-functions-repeat">repeat</a></p></td><td><p>Repeats a <code>text</code> the number of specified <code>times</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-strings-functions-replaceall">replaceAll</a></p></td><td><p>Replaces all substrings that match a literal search string with a specified replacement string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-strings-functions-reverse">reverse</a></p></td><td><p>Reverses sequence of characters in a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-strings-functions-rightpad">rightPad</a></p></td><td><p>The specified <code>text</code> is <em>right</em>-padded to the <code>size</code> using the <code>padText</code>. By default <code>padText</code> is <code>" "</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-strings-functions-singularize">singularize</a></p></td><td><p>Converts a plural string to its singular form.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-strings-functions-somecharacter">someCharacter</a></p></td><td><p>Checks whether a condition is valid for at least one of the characters or blank spaces in a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-strings-functions-substring">substring</a></p></td><td><p>Returns a substring that spans from the character at the specified <code>from</code> index to the last character before the <code>until</code> index.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-strings-functions-substringafter">substringAfter</a></p></td><td><p>Gets the substring after the first occurrence of a separator. The separator is not returned.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-strings-functions-substringafterlast">substringAfterLast</a></p></td><td><p>Gets the substring after the last occurrence of a separator. The separator is not returned.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-strings-functions-substringbefore">substringBefore</a></p></td><td><p>Gets the substring before the first occurrence of a separator. The separator is not returned.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-strings-functions-substringbeforelast">substringBeforeLast</a></p></td><td><p>Gets the substring before the last occurrence of a separator. The separator is not returned.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-strings-functions-substringby">substringBy</a></p></td><td><p>Splits a string at each character where the <code>predicate</code> expression returns <code>true</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-strings-functions-substringevery">substringEvery</a></p></td><td><p>Splits a string into an array of substrings equal to a specified length.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-strings-functions-underscore">underscore</a></p></td><td><p>Replaces hyphens, spaces, and camel-casing in a string with underscores.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-strings-functions-unwrap">unwrap</a></p></td><td><p>Unwraps a given <code>text</code> from a <code>wrapper</code> text.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-strings-functions-withmaxsize">withMaxSize</a></p></td><td><p>Checks that the string length is no larger than the specified <code>maxLength</code>. If the string’s length is larger than the <code>maxLength</code>, the function cuts characters from left to right, until the string length meets the length limit.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-strings-functions-words">words</a></p></td><td><p>Returns an array of words from a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-strings-functions-wrapifmissing">wrapIfMissing</a></p></td><td><p>Wraps <code>text</code> with <code>wrapper</code> if that <code>wrapper</code> is missing from the start or end of the given string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-strings-functions-wrapwith">wrapWith</a></p></td><td><p>Wraps the specified <code>text</code> with the given <code>wrapper</code>.</p></td></tr></tbody></table>

<!-- document id=2ed973ddc36aaebb4c98aa05f0e6511bd1ab147fd82627bbb9d5760f57a205f9 url=/mulesoft/current/en-us/dataweave/2.12/dw-strings.md -->

---
product: DataWeave
version: 2.12
---

# Strings (dw::core::Strings)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions for working with strings.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Strings` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-strings-functions-appendifmissing">appendIfMissing</a></p></td><td><p>Appends the <code>suffix</code> to the end of the <code>text</code> if the <code>text</code> does not already ends with the <code>suffix</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-strings-functions-camelize">camelize</a></p></td><td><p>Returns a string in camel case based on underscores in the string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-strings-functions-capitalize">capitalize</a></p></td><td><p>Capitalizes the first letter of each word in a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-strings-functions-charcode">charCode</a></p></td><td><p>Returns the Unicode for the first character in an input string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-strings-functions-charcodeat">charCodeAt</a></p></td><td><p>Returns the Unicode for a character at the specified index.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-strings-functions-collapse">collapse</a></p></td><td><p>Collapses the string into substrings of equal characters.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-strings-functions-countcharactersby">countCharactersBy</a></p></td><td><p>Counts the number of times an expression that iterates through each character in a string returns <code>true</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-strings-functions-countmatches">countMatches</a></p></td><td><p>Counts the number of matches in a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-strings-functions-dasherize">dasherize</a></p></td><td><p>Replaces spaces, underscores, and camel-casing in a string with dashes (hyphens).</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-strings-functions-everycharacter">everyCharacter</a></p></td><td><p>Checks whether a condition is valid for <em>every</em> character in a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-strings-functions-first">first</a></p></td><td><p>Returns characters from the beginning of a string to the specified number of characters in the string, for example, the first two characters of a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-strings-functions-fromcharcode">fromCharCode</a></p></td><td><p>Returns a character that matches the specified Unicode.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-strings-functions-hammingdistance">hammingDistance</a></p></td><td><p>Returns the Hamming distance between two strings.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-strings-functions-isalpha">isAlpha</a></p></td><td><p>Checks if the <code>text</code> contains only Unicode digits. A decimal point is not a Unicode digit and returns <code>false</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-strings-functions-isalphanumeric">isAlphanumeric</a></p></td><td><p>Checks if the <code>text</code> contains only Unicode letters or digits.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-strings-functions-islowercase">isLowerCase</a></p></td><td><p>Checks if the <code>text</code> contains only lowercase characters.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-strings-functions-isnumeric">isNumeric</a></p></td><td><p>Checks if the <code>text</code> contains only Unicode digits.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-strings-functions-isuppercase">isUpperCase</a></p></td><td><p>Checks if the <code>text</code> contains only uppercase characters.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-strings-functions-iswhitespace">isWhitespace</a></p></td><td><p>Checks if the <code>text</code> contains only whitespace.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-strings-functions-last">last</a></p></td><td><p>Returns characters from the end of string to a specified number of characters, for example, the last two characters of a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-strings-functions-leftpad">leftPad</a></p></td><td><p>The specified <code>text</code> is <em>left</em>-padded to the <code>size</code> using the <code>padText</code>. By default <code>padText</code> is <code>" "</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-strings-functions-levenshteindistance">levenshteinDistance</a></p></td><td><p>Returns the Levenshtein distance (or edit distance) between two strings.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-strings-functions-lines">lines</a></p></td><td><p>Returns an array of lines from a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-strings-functions-mapstring">mapString</a></p></td><td><p>Applies an expression to every character of a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-strings-functions-ordinalize">ordinalize</a></p></td><td><p>Returns a number as an ordinal, such as <code>1st</code> or <code>2nd</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-strings-functions-pluralize">pluralize</a></p></td><td><p>Pluralizes a singular string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-strings-functions-prependifmissing">prependIfMissing</a></p></td><td><p>Prepends the <code>prefix</code> to the beginning of the string if the <code>text</code> does not already start with that prefix.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-strings-functions-remove">remove</a></p></td><td><p>Removes all occurrences of a specified pattern from a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-strings-functions-repeat">repeat</a></p></td><td><p>Repeats a <code>text</code> the number of specified <code>times</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-strings-functions-replaceall">replaceAll</a></p></td><td><p>Replaces all substrings that match a literal search string with a specified replacement string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-strings-functions-reverse">reverse</a></p></td><td><p>Reverses sequence of characters in a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-strings-functions-rightpad">rightPad</a></p></td><td><p>The specified <code>text</code> is <em>right</em>-padded to the <code>size</code> using the <code>padText</code>. By default <code>padText</code> is <code>" "</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-strings-functions-singularize">singularize</a></p></td><td><p>Converts a plural string to its singular form.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-strings-functions-somecharacter">someCharacter</a></p></td><td><p>Checks whether a condition is valid for at least one of the characters or blank spaces in a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-strings-functions-substring">substring</a></p></td><td><p>Returns a substring that spans from the character at the specified <code>from</code> index to the last character before the <code>until</code> index.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-strings-functions-substringafter">substringAfter</a></p></td><td><p>Gets the substring after the first occurrence of a separator. The separator is not returned.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-strings-functions-substringafterlast">substringAfterLast</a></p></td><td><p>Gets the substring after the last occurrence of a separator. The separator is not returned.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-strings-functions-substringbefore">substringBefore</a></p></td><td><p>Gets the substring before the first occurrence of a separator. The separator is not returned.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-strings-functions-substringbeforelast">substringBeforeLast</a></p></td><td><p>Gets the substring before the last occurrence of a separator. The separator is not returned.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-strings-functions-substringby">substringBy</a></p></td><td><p>Splits a string at each character where the <code>predicate</code> expression returns <code>true</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-strings-functions-substringevery">substringEvery</a></p></td><td><p>Splits a string into an array of substrings equal to a specified length.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-strings-functions-underscore">underscore</a></p></td><td><p>Replaces hyphens, spaces, and camel-casing in a string with underscores.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-strings-functions-unwrap">unwrap</a></p></td><td><p>Unwraps a given <code>text</code> from a <code>wrapper</code> text.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-strings-functions-withmaxsize">withMaxSize</a></p></td><td><p>Checks that the string length is no larger than the specified <code>maxLength</code>. If the string’s length is larger than the <code>maxLength</code>, the function cuts characters from left to right, until the string length meets the length limit.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-strings-functions-words">words</a></p></td><td><p>Returns an array of words from a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-strings-functions-wrapifmissing">wrapIfMissing</a></p></td><td><p>Wraps <code>text</code> with <code>wrapper</code> if that <code>wrapper</code> is missing from the start or end of the given string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-strings-functions-wrapwith">wrapWith</a></p></td><td><p>Wraps the specified <code>text</code> with the given <code>wrapper</code>.</p></td></tr></tbody></table>

<!-- document id=73293b77d2257f4a1a40f88d23bad90ca253f9a34db78232ff2bae4ba918970c url=/mulesoft/current/en-us/dataweave/2.3/dw-strings.md -->

---
product: DataWeave
version: 2.3
---

# Strings (dw::core::Strings)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions to work with Strings.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Strings` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-strings-functions-appendifmissing">appendIfMissing</a></p></td><td><p>Appends the <code>suffix</code> to the end of the <code>text</code> if the <code>text</code> does not already ends with the <code>suffix</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-strings-functions-camelize">camelize</a></p></td><td><p>Returns a string in camel case based on underscores in the string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-strings-functions-capitalize">capitalize</a></p></td><td><p>Capitalizes the first letter of each word in a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-strings-functions-charcode">charCode</a></p></td><td><p>Returns the Unicode for the first character in an input string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-strings-functions-charcodeat">charCodeAt</a></p></td><td><p>Returns the Unicode for a character at the specified index.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-strings-functions-dasherize">dasherize</a></p></td><td><p>Replaces spaces, underscores, and camel-casing in a string with dashes (hyphens).</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-strings-functions-fromcharcode">fromCharCode</a></p></td><td><p>Returns a character that matches the specified Unicode.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-strings-functions-isalpha">isAlpha</a></p></td><td><p>Checks if the <code>text</code> contains only Unicode digits. A decimal point is not a Unicode digit and returns <code>false</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-strings-functions-isalphanumeric">isAlphanumeric</a></p></td><td><p>Checks if the <code>text</code> contains only Unicode letters or digits.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-strings-functions-islowercase">isLowerCase</a></p></td><td><p>Checks if the <code>text</code> contains only lowercase characters.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-strings-functions-isnumeric">isNumeric</a></p></td><td><p>Checks if the <code>text</code> contains only Unicode digits.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-strings-functions-isuppercase">isUpperCase</a></p></td><td><p>Checks if the <code>text</code> contains only uppercase characters.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-strings-functions-iswhitespace">isWhitespace</a></p></td><td><p>Checks if the <code>text</code> contains only whitespace.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-strings-functions-leftpad">leftPad</a></p></td><td><p>The specified <code>text</code> is <em>left</em>-padded to the <code>size</code> using the <code>padText</code>. By default <code>padText</code> is <code>" "</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-strings-functions-ordinalize">ordinalize</a></p></td><td><p>Returns a number as an ordinal, such as <code>1st</code> or <code>2nd</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-strings-functions-pluralize">pluralize</a></p></td><td><p>Pluralizes a singular string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-strings-functions-prependifmissing">prependIfMissing</a></p></td><td><p>Prepends the <code>prefix</code> to the beginning of the string if the <code>text</code> does not already start with that prefix.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-strings-functions-repeat">repeat</a></p></td><td><p>Repeats a <code>text</code> the number of specified <code>times</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-strings-functions-rightpad">rightPad</a></p></td><td><p>The specified <code>text</code> is <em>right</em>-padded to the <code>size</code> using the <code>padText</code>. By default <code>padText</code> is <code>" "</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-strings-functions-singularize">singularize</a></p></td><td><p>Converts a plural string to its singular form.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-strings-functions-substringafter">substringAfter</a></p></td><td><p>Gets the substring after the first occurrence of a separator. The separator is not returned.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-strings-functions-substringafterlast">substringAfterLast</a></p></td><td><p>Gets the substring after the last occurrence of a separator. The separator is not returned.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-strings-functions-substringbefore">substringBefore</a></p></td><td><p>Gets the substring before the first occurrence of a separator. The separator is not returned.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-strings-functions-substringbeforelast">substringBeforeLast</a></p></td><td><p>Gets the substring before the last occurrence of a separator. The separator is not returned.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-strings-functions-underscore">underscore</a></p></td><td><p>Replaces hyphens, spaces, and camel-casing in a string with underscores.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-strings-functions-unwrap">unwrap</a></p></td><td><p>Unwraps a given <code>text</code> from a <code>wrapper</code> text.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-strings-functions-withmaxsize">withMaxSize</a></p></td><td><p>Checks that the string length is no larger than the specified <code>maxLength</code>. If the string’s length is larger than the <code>maxLength</code>, the function cuts characters from left to right, until the string length meets the length limit.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-strings-functions-wrapifmissing">wrapIfMissing</a></p></td><td><p>Wraps <code>text</code> with <code>wrapper</code> if that <code>wrapper</code> is missing from the start or end of the given string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-strings-functions-wrapwith">wrapWith</a></p></td><td><p>Wraps the specified <code>text</code> with the given <code>wrapper</code>.</p></td></tr></tbody></table>

<!-- document id=fa520b09c35119f7858193941f608b4cc8a329fa2d073d9b0418fc1c598d35ec url=/mulesoft/current/en-us/dataweave/2.4/dw-strings.md -->

---
product: DataWeave
version: 2.4
---

# Strings (dw::core::Strings)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions for working with strings.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Strings` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-appendifmissing">appendIfMissing</a></p></td><td><p>Appends the <code>suffix</code> to the end of the <code>text</code> if the <code>text</code> does not already ends with the <code>suffix</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-camelize">camelize</a></p></td><td><p>Returns a string in camel case based on underscores in the string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-capitalize">capitalize</a></p></td><td><p>Capitalizes the first letter of each word in a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-charcode">charCode</a></p></td><td><p>Returns the Unicode for the first character in an input string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-charcodeat">charCodeAt</a></p></td><td><p>Returns the Unicode for a character at the specified index.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-collapse">collapse</a></p></td><td><p>Collapses the string into substrings of equal characters.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-countcharactersby">countCharactersBy</a></p></td><td><p>Counts the number of times an expression that iterates through each character in a string returns <code>true</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-countmatches">countMatches</a></p></td><td><p>Counts the number of matches in a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-dasherize">dasherize</a></p></td><td><p>Replaces spaces, underscores, and camel-casing in a string with dashes (hyphens).</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-everycharacter">everyCharacter</a></p></td><td><p>Checks whether a condition is valid for <em>every</em> character in a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-first">first</a></p></td><td><p>Returns characters from the beginning of a string to the specified number of characters in the string, for example, the first two characters of a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-fromcharcode">fromCharCode</a></p></td><td><p>Returns a character that matches the specified Unicode.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-hammingdistance">hammingDistance</a></p></td><td><p>Returns the Hamming distance between two strings.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-isalpha">isAlpha</a></p></td><td><p>Checks if the <code>text</code> contains only Unicode digits. A decimal point is not a Unicode digit and returns <code>false</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-isalphanumeric">isAlphanumeric</a></p></td><td><p>Checks if the <code>text</code> contains only Unicode letters or digits.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-islowercase">isLowerCase</a></p></td><td><p>Checks if the <code>text</code> contains only lowercase characters.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-isnumeric">isNumeric</a></p></td><td><p>Checks if the <code>text</code> contains only Unicode digits.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-isuppercase">isUpperCase</a></p></td><td><p>Checks if the <code>text</code> contains only uppercase characters.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-iswhitespace">isWhitespace</a></p></td><td><p>Checks if the <code>text</code> contains only whitespace.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-last">last</a></p></td><td><p>Returns characters from the end of string to a specified number of characters, for example, the last two characters of a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-leftpad">leftPad</a></p></td><td><p>The specified <code>text</code> is <em>left</em>-padded to the <code>size</code> using the <code>padText</code>. By default <code>padText</code> is <code>" "</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-levenshteindistance">levenshteinDistance</a></p></td><td><p>Returns the Levenshtein distance (or edit distance) between two strings.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-lines">lines</a></p></td><td><p>Returns an array of lines from a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-mapstring">mapString</a></p></td><td><p>Applies an expression to every character of a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-ordinalize">ordinalize</a></p></td><td><p>Returns a number as an ordinal, such as <code>1st</code> or <code>2nd</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-pluralize">pluralize</a></p></td><td><p>Pluralizes a singular string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-prependifmissing">prependIfMissing</a></p></td><td><p>Prepends the <code>prefix</code> to the beginning of the string if the <code>text</code> does not already start with that prefix.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-remove">remove</a></p></td><td><p>Removes all occurrences of a specified pattern from a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-repeat">repeat</a></p></td><td><p>Repeats a <code>text</code> the number of specified <code>times</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-replaceall">replaceAll</a></p></td><td><p>Replaces all substrings that match a literal search string with a specified replacement string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-reverse">reverse</a></p></td><td><p>Reverses sequence of characters in a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-rightpad">rightPad</a></p></td><td><p>The specified <code>text</code> is <em>right</em>-padded to the <code>size</code> using the <code>padText</code>. By default <code>padText</code> is <code>" "</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-singularize">singularize</a></p></td><td><p>Converts a plural string to its singular form.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-somecharacter">someCharacter</a></p></td><td><p>Checks whether a condition is valid for at least one of the characters or blank spaces in a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-substring">substring</a></p></td><td><p>Returns a substring that spans from the character at the specified <code>from</code> index to the last character before the <code>until</code> index.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-substringafter">substringAfter</a></p></td><td><p>Gets the substring after the first occurrence of a separator. The separator is not returned.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-substringafterlast">substringAfterLast</a></p></td><td><p>Gets the substring after the last occurrence of a separator. The separator is not returned.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-substringbefore">substringBefore</a></p></td><td><p>Gets the substring before the first occurrence of a separator. The separator is not returned.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-substringbeforelast">substringBeforeLast</a></p></td><td><p>Gets the substring before the last occurrence of a separator. The separator is not returned.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-substringby">substringBy</a></p></td><td><p>Splits a string at each character where the <code>predicate</code> expression returns <code>true</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-substringevery">substringEvery</a></p></td><td><p>Splits a string into an array of substrings equal to a specified length.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-underscore">underscore</a></p></td><td><p>Replaces hyphens, spaces, and camel-casing in a string with underscores.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-unwrap">unwrap</a></p></td><td><p>Unwraps a given <code>text</code> from a <code>wrapper</code> text.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-withmaxsize">withMaxSize</a></p></td><td><p>Checks that the string length is no larger than the specified <code>maxLength</code>. If the string’s length is larger than the <code>maxLength</code>, the function cuts characters from left to right, until the string length meets the length limit.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-words">words</a></p></td><td><p>Returns an array of words from a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-wrapifmissing">wrapIfMissing</a></p></td><td><p>Wraps <code>text</code> with <code>wrapper</code> if that <code>wrapper</code> is missing from the start or end of the given string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-wrapwith">wrapWith</a></p></td><td><p>Wraps the specified <code>text</code> with the given <code>wrapper</code>.</p></td></tr></tbody></table>

<!-- document id=a1dfb33ec3819dd83831777d5bdf1fc7815d0b9d48df7d39576ffa1bdc1f8445 url=/mulesoft/current/en-us/dataweave/2.6/dw-strings.md -->

---
product: DataWeave
version: 2.6
---

# Strings (dw::core::Strings)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions for working with strings.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Strings` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-strings-functions-appendifmissing">appendIfMissing</a></p></td><td><p>Appends the <code>suffix</code> to the end of the <code>text</code> if the <code>text</code> does not already ends with the <code>suffix</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-strings-functions-camelize">camelize</a></p></td><td><p>Returns a string in camel case based on underscores in the string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-strings-functions-capitalize">capitalize</a></p></td><td><p>Capitalizes the first letter of each word in a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-strings-functions-charcode">charCode</a></p></td><td><p>Returns the Unicode for the first character in an input string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-strings-functions-charcodeat">charCodeAt</a></p></td><td><p>Returns the Unicode for a character at the specified index.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-strings-functions-collapse">collapse</a></p></td><td><p>Collapses the string into substrings of equal characters.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-strings-functions-countcharactersby">countCharactersBy</a></p></td><td><p>Counts the number of times an expression that iterates through each character in a string returns <code>true</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-strings-functions-countmatches">countMatches</a></p></td><td><p>Counts the number of matches in a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-strings-functions-dasherize">dasherize</a></p></td><td><p>Replaces spaces, underscores, and camel-casing in a string with dashes (hyphens).</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-strings-functions-everycharacter">everyCharacter</a></p></td><td><p>Checks whether a condition is valid for <em>every</em> character in a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-strings-functions-first">first</a></p></td><td><p>Returns characters from the beginning of a string to the specified number of characters in the string, for example, the first two characters of a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-strings-functions-fromcharcode">fromCharCode</a></p></td><td><p>Returns a character that matches the specified Unicode.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-strings-functions-hammingdistance">hammingDistance</a></p></td><td><p>Returns the Hamming distance between two strings.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-strings-functions-isalpha">isAlpha</a></p></td><td><p>Checks if the <code>text</code> contains only Unicode digits. A decimal point is not a Unicode digit and returns <code>false</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-strings-functions-isalphanumeric">isAlphanumeric</a></p></td><td><p>Checks if the <code>text</code> contains only Unicode letters or digits.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-strings-functions-islowercase">isLowerCase</a></p></td><td><p>Checks if the <code>text</code> contains only lowercase characters.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-strings-functions-isnumeric">isNumeric</a></p></td><td><p>Checks if the <code>text</code> contains only Unicode digits.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-strings-functions-isuppercase">isUpperCase</a></p></td><td><p>Checks if the <code>text</code> contains only uppercase characters.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-strings-functions-iswhitespace">isWhitespace</a></p></td><td><p>Checks if the <code>text</code> contains only whitespace.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-strings-functions-last">last</a></p></td><td><p>Returns characters from the end of string to a specified number of characters, for example, the last two characters of a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-strings-functions-leftpad">leftPad</a></p></td><td><p>The specified <code>text</code> is <em>left</em>-padded to the <code>size</code> using the <code>padText</code>. By default <code>padText</code> is <code>" "</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-strings-functions-levenshteindistance">levenshteinDistance</a></p></td><td><p>Returns the Levenshtein distance (or edit distance) between two strings.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-strings-functions-lines">lines</a></p></td><td><p>Returns an array of lines from a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-strings-functions-mapstring">mapString</a></p></td><td><p>Applies an expression to every character of a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-strings-functions-ordinalize">ordinalize</a></p></td><td><p>Returns a number as an ordinal, such as <code>1st</code> or <code>2nd</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-strings-functions-pluralize">pluralize</a></p></td><td><p>Pluralizes a singular string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-strings-functions-prependifmissing">prependIfMissing</a></p></td><td><p>Prepends the <code>prefix</code> to the beginning of the string if the <code>text</code> does not already start with that prefix.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-strings-functions-remove">remove</a></p></td><td><p>Removes all occurrences of a specified pattern from a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-strings-functions-repeat">repeat</a></p></td><td><p>Repeats a <code>text</code> the number of specified <code>times</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-strings-functions-replaceall">replaceAll</a></p></td><td><p>Replaces all substrings that match a literal search string with a specified replacement string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-strings-functions-reverse">reverse</a></p></td><td><p>Reverses sequence of characters in a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-strings-functions-rightpad">rightPad</a></p></td><td><p>The specified <code>text</code> is <em>right</em>-padded to the <code>size</code> using the <code>padText</code>. By default <code>padText</code> is <code>" "</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-strings-functions-singularize">singularize</a></p></td><td><p>Converts a plural string to its singular form.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-strings-functions-somecharacter">someCharacter</a></p></td><td><p>Checks whether a condition is valid for at least one of the characters or blank spaces in a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-strings-functions-substring">substring</a></p></td><td><p>Returns a substring that spans from the character at the specified <code>from</code> index to the last character before the <code>until</code> index.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-strings-functions-substringafter">substringAfter</a></p></td><td><p>Gets the substring after the first occurrence of a separator. The separator is not returned.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-strings-functions-substringafterlast">substringAfterLast</a></p></td><td><p>Gets the substring after the last occurrence of a separator. The separator is not returned.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-strings-functions-substringbefore">substringBefore</a></p></td><td><p>Gets the substring before the first occurrence of a separator. The separator is not returned.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-strings-functions-substringbeforelast">substringBeforeLast</a></p></td><td><p>Gets the substring before the last occurrence of a separator. The separator is not returned.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-strings-functions-substringby">substringBy</a></p></td><td><p>Splits a string at each character where the <code>predicate</code> expression returns <code>true</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-strings-functions-substringevery">substringEvery</a></p></td><td><p>Splits a string into an array of substrings equal to a specified length.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-strings-functions-underscore">underscore</a></p></td><td><p>Replaces hyphens, spaces, and camel-casing in a string with underscores.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-strings-functions-unwrap">unwrap</a></p></td><td><p>Unwraps a given <code>text</code> from a <code>wrapper</code> text.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-strings-functions-withmaxsize">withMaxSize</a></p></td><td><p>Checks that the string length is no larger than the specified <code>maxLength</code>. If the string’s length is larger than the <code>maxLength</code>, the function cuts characters from left to right, until the string length meets the length limit.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-strings-functions-words">words</a></p></td><td><p>Returns an array of words from a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-strings-functions-wrapifmissing">wrapIfMissing</a></p></td><td><p>Wraps <code>text</code> with <code>wrapper</code> if that <code>wrapper</code> is missing from the start or end of the given string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-strings-functions-wrapwith">wrapWith</a></p></td><td><p>Wraps the specified <code>text</code> with the given <code>wrapper</code>.</p></td></tr></tbody></table>

<!-- document id=2e559d05d70602da116d2dba903c7b9a78763f66a4b7c1a57336ebe7ae88a132 url=/mulesoft/current/en-us/dataweave/2.9/dw-strings.md -->

---
product: DataWeave
version: 2.9
---

# Strings (dw::core::Strings)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions for working with strings.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Strings` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-strings-functions-appendifmissing">appendIfMissing</a></p></td><td><p>Appends the <code>suffix</code> to the end of the <code>text</code> if the <code>text</code> does not already ends with the <code>suffix</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-strings-functions-camelize">camelize</a></p></td><td><p>Returns a string in camel case based on underscores in the string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-strings-functions-capitalize">capitalize</a></p></td><td><p>Capitalizes the first letter of each word in a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-strings-functions-charcode">charCode</a></p></td><td><p>Returns the Unicode for the first character in an input string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-strings-functions-charcodeat">charCodeAt</a></p></td><td><p>Returns the Unicode for a character at the specified index.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-strings-functions-collapse">collapse</a></p></td><td><p>Collapses the string into substrings of equal characters.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-strings-functions-countcharactersby">countCharactersBy</a></p></td><td><p>Counts the number of times an expression that iterates through each character in a string returns <code>true</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-strings-functions-countmatches">countMatches</a></p></td><td><p>Counts the number of matches in a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-strings-functions-dasherize">dasherize</a></p></td><td><p>Replaces spaces, underscores, and camel-casing in a string with dashes (hyphens).</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-strings-functions-everycharacter">everyCharacter</a></p></td><td><p>Checks whether a condition is valid for <em>every</em> character in a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-strings-functions-first">first</a></p></td><td><p>Returns characters from the beginning of a string to the specified number of characters in the string, for example, the first two characters of a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-strings-functions-fromcharcode">fromCharCode</a></p></td><td><p>Returns a character that matches the specified Unicode.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-strings-functions-hammingdistance">hammingDistance</a></p></td><td><p>Returns the Hamming distance between two strings.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-strings-functions-isalpha">isAlpha</a></p></td><td><p>Checks if the <code>text</code> contains only Unicode digits. A decimal point is not a Unicode digit and returns <code>false</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-strings-functions-isalphanumeric">isAlphanumeric</a></p></td><td><p>Checks if the <code>text</code> contains only Unicode letters or digits.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-strings-functions-islowercase">isLowerCase</a></p></td><td><p>Checks if the <code>text</code> contains only lowercase characters.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-strings-functions-isnumeric">isNumeric</a></p></td><td><p>Checks if the <code>text</code> contains only Unicode digits.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-strings-functions-isuppercase">isUpperCase</a></p></td><td><p>Checks if the <code>text</code> contains only uppercase characters.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-strings-functions-iswhitespace">isWhitespace</a></p></td><td><p>Checks if the <code>text</code> contains only whitespace.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-strings-functions-last">last</a></p></td><td><p>Returns characters from the end of string to a specified number of characters, for example, the last two characters of a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-strings-functions-leftpad">leftPad</a></p></td><td><p>The specified <code>text</code> is <em>left</em>-padded to the <code>size</code> using the <code>padText</code>. By default <code>padText</code> is <code>" "</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-strings-functions-levenshteindistance">levenshteinDistance</a></p></td><td><p>Returns the Levenshtein distance (or edit distance) between two strings.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-strings-functions-lines">lines</a></p></td><td><p>Returns an array of lines from a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-strings-functions-mapstring">mapString</a></p></td><td><p>Applies an expression to every character of a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-strings-functions-ordinalize">ordinalize</a></p></td><td><p>Returns a number as an ordinal, such as <code>1st</code> or <code>2nd</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-strings-functions-pluralize">pluralize</a></p></td><td><p>Pluralizes a singular string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-strings-functions-prependifmissing">prependIfMissing</a></p></td><td><p>Prepends the <code>prefix</code> to the beginning of the string if the <code>text</code> does not already start with that prefix.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-strings-functions-remove">remove</a></p></td><td><p>Removes all occurrences of a specified pattern from a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-strings-functions-repeat">repeat</a></p></td><td><p>Repeats a <code>text</code> the number of specified <code>times</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-strings-functions-replaceall">replaceAll</a></p></td><td><p>Replaces all substrings that match a literal search string with a specified replacement string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-strings-functions-reverse">reverse</a></p></td><td><p>Reverses sequence of characters in a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-strings-functions-rightpad">rightPad</a></p></td><td><p>The specified <code>text</code> is <em>right</em>-padded to the <code>size</code> using the <code>padText</code>. By default <code>padText</code> is <code>" "</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-strings-functions-singularize">singularize</a></p></td><td><p>Converts a plural string to its singular form.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-strings-functions-somecharacter">someCharacter</a></p></td><td><p>Checks whether a condition is valid for at least one of the characters or blank spaces in a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-strings-functions-substring">substring</a></p></td><td><p>Returns a substring that spans from the character at the specified <code>from</code> index to the last character before the <code>until</code> index.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-strings-functions-substringafter">substringAfter</a></p></td><td><p>Gets the substring after the first occurrence of a separator. The separator is not returned.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-strings-functions-substringafterlast">substringAfterLast</a></p></td><td><p>Gets the substring after the last occurrence of a separator. The separator is not returned.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-strings-functions-substringbefore">substringBefore</a></p></td><td><p>Gets the substring before the first occurrence of a separator. The separator is not returned.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-strings-functions-substringbeforelast">substringBeforeLast</a></p></td><td><p>Gets the substring before the last occurrence of a separator. The separator is not returned.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-strings-functions-substringby">substringBy</a></p></td><td><p>Splits a string at each character where the <code>predicate</code> expression returns <code>true</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-strings-functions-substringevery">substringEvery</a></p></td><td><p>Splits a string into an array of substrings equal to a specified length.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-strings-functions-underscore">underscore</a></p></td><td><p>Replaces hyphens, spaces, and camel-casing in a string with underscores.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-strings-functions-unwrap">unwrap</a></p></td><td><p>Unwraps a given <code>text</code> from a <code>wrapper</code> text.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-strings-functions-withmaxsize">withMaxSize</a></p></td><td><p>Checks that the string length is no larger than the specified <code>maxLength</code>. If the string’s length is larger than the <code>maxLength</code>, the function cuts characters from left to right, until the string length meets the length limit.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-strings-functions-words">words</a></p></td><td><p>Returns an array of words from a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-strings-functions-wrapifmissing">wrapIfMissing</a></p></td><td><p>Wraps <code>text</code> with <code>wrapper</code> if that <code>wrapper</code> is missing from the start or end of the given string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-strings-functions-wrapwith">wrapWith</a></p></td><td><p>Wraps the specified <code>text</code> with the given <code>wrapper</code>.</p></td></tr></tbody></table>

<!-- document id=8a83669b0d415f726c5c94fe2b0aae6ae3e9f14cdd09f9a1a40e972b222b776a url=/mulesoft/current/en-us/dataweave/latest/dw-strings.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Strings (dw::core::Strings)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions for working with strings.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Strings` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-strings-functions-appendifmissing">appendIfMissing</a></p></td><td><p>Appends the <code>suffix</code> to the end of the <code>text</code> if the <code>text</code> does not already ends with the <code>suffix</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-strings-functions-camelize">camelize</a></p></td><td><p>Returns a string in camel case based on underscores in the string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-strings-functions-capitalize">capitalize</a></p></td><td><p>Capitalizes the first letter of each word in a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-strings-functions-charcode">charCode</a></p></td><td><p>Returns the Unicode for the first character in an input string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-strings-functions-charcodeat">charCodeAt</a></p></td><td><p>Returns the Unicode for a character at the specified index.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-strings-functions-collapse">collapse</a></p></td><td><p>Collapses the string into substrings of equal characters.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-strings-functions-countcharactersby">countCharactersBy</a></p></td><td><p>Counts the number of times an expression that iterates through each character in a string returns <code>true</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-strings-functions-countmatches">countMatches</a></p></td><td><p>Counts the number of matches in a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-strings-functions-dasherize">dasherize</a></p></td><td><p>Replaces spaces, underscores, and camel-casing in a string with dashes (hyphens).</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-strings-functions-everycharacter">everyCharacter</a></p></td><td><p>Checks whether a condition is valid for <em>every</em> character in a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-strings-functions-first">first</a></p></td><td><p>Returns characters from the beginning of a string to the specified number of characters in the string, for example, the first two characters of a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-strings-functions-fromcharcode">fromCharCode</a></p></td><td><p>Returns a character that matches the specified Unicode.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-strings-functions-hammingdistance">hammingDistance</a></p></td><td><p>Returns the Hamming distance between two strings.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-strings-functions-isalpha">isAlpha</a></p></td><td><p>Checks if the <code>text</code> contains only Unicode digits. A decimal point is not a Unicode digit and returns <code>false</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-strings-functions-isalphanumeric">isAlphanumeric</a></p></td><td><p>Checks if the <code>text</code> contains only Unicode letters or digits.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-strings-functions-islowercase">isLowerCase</a></p></td><td><p>Checks if the <code>text</code> contains only lowercase characters.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-strings-functions-isnumeric">isNumeric</a></p></td><td><p>Checks if the <code>text</code> contains only Unicode digits.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-strings-functions-isuppercase">isUpperCase</a></p></td><td><p>Checks if the <code>text</code> contains only uppercase characters.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-strings-functions-iswhitespace">isWhitespace</a></p></td><td><p>Checks if the <code>text</code> contains only whitespace.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-strings-functions-last">last</a></p></td><td><p>Returns characters from the end of string to a specified number of characters, for example, the last two characters of a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-strings-functions-leftpad">leftPad</a></p></td><td><p>The specified <code>text</code> is <em>left</em>-padded to the <code>size</code> using the <code>padText</code>. By default <code>padText</code> is <code>" "</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-strings-functions-levenshteindistance">levenshteinDistance</a></p></td><td><p>Returns the Levenshtein distance (or edit distance) between two strings.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-strings-functions-lines">lines</a></p></td><td><p>Returns an array of lines from a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-strings-functions-mapstring">mapString</a></p></td><td><p>Applies an expression to every character of a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-strings-functions-ordinalize">ordinalize</a></p></td><td><p>Returns a number as an ordinal, such as <code>1st</code> or <code>2nd</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-strings-functions-pluralize">pluralize</a></p></td><td><p>Pluralizes a singular string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-strings-functions-prependifmissing">prependIfMissing</a></p></td><td><p>Prepends the <code>prefix</code> to the beginning of the string if the <code>text</code> does not already start with that prefix.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-strings-functions-remove">remove</a></p></td><td><p>Removes all occurrences of a specified pattern from a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-strings-functions-repeat">repeat</a></p></td><td><p>Repeats a <code>text</code> the number of specified <code>times</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-strings-functions-replaceall">replaceAll</a></p></td><td><p>Replaces all substrings that match a literal search string with a specified replacement string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-strings-functions-reverse">reverse</a></p></td><td><p>Reverses sequence of characters in a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-strings-functions-rightpad">rightPad</a></p></td><td><p>The specified <code>text</code> is <em>right</em>-padded to the <code>size</code> using the <code>padText</code>. By default <code>padText</code> is <code>" "</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-strings-functions-singularize">singularize</a></p></td><td><p>Converts a plural string to its singular form.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-strings-functions-somecharacter">someCharacter</a></p></td><td><p>Checks whether a condition is valid for at least one of the characters or blank spaces in a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-strings-functions-substring">substring</a></p></td><td><p>Returns a substring that spans from the character at the specified <code>from</code> index to the last character before the <code>until</code> index.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-strings-functions-substringafter">substringAfter</a></p></td><td><p>Gets the substring after the first occurrence of a separator. The separator is not returned.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-strings-functions-substringafterlast">substringAfterLast</a></p></td><td><p>Gets the substring after the last occurrence of a separator. The separator is not returned.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-strings-functions-substringbefore">substringBefore</a></p></td><td><p>Gets the substring before the first occurrence of a separator. The separator is not returned.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-strings-functions-substringbeforelast">substringBeforeLast</a></p></td><td><p>Gets the substring before the last occurrence of a separator. The separator is not returned.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-strings-functions-substringby">substringBy</a></p></td><td><p>Splits a string at each character where the <code>predicate</code> expression returns <code>true</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-strings-functions-substringevery">substringEvery</a></p></td><td><p>Splits a string into an array of substrings equal to a specified length.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-strings-functions-underscore">underscore</a></p></td><td><p>Replaces hyphens, spaces, and camel-casing in a string with underscores.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-strings-functions-unwrap">unwrap</a></p></td><td><p>Unwraps a given <code>text</code> from a <code>wrapper</code> text.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-strings-functions-withmaxsize">withMaxSize</a></p></td><td><p>Checks that the string length is no larger than the specified <code>maxLength</code>. If the string’s length is larger than the <code>maxLength</code>, the function cuts characters from left to right, until the string length meets the length limit.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-strings-functions-words">words</a></p></td><td><p>Returns an array of words from a string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-strings-functions-wrapifmissing">wrapIfMissing</a></p></td><td><p>Wraps <code>text</code> with <code>wrapper</code> if that <code>wrapper</code> is missing from the start or end of the given string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-strings-functions-wrapwith">wrapWith</a></p></td><td><p>Wraps the specified <code>text</code> with the given <code>wrapper</code>.</p></td></tr></tbody></table>

<!-- document id=869e9751c676cdaf708adf8f57ff20d1f3bb627058e9668a3e939b5aa3aee731 url=/mulesoft/current/en-us/dataweave/2.11/dw-strings-functions-substring.md -->

---
product: DataWeave
version: 2.11
---

# substring

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## substring(text: String, from: Number, until: Number): String

Returns a substring that spans from the character at the specified `from` index to the last
character before the `until` index.

The characters in the substring satisfy the condition `from <= indexOf(string) < until`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string, treated as an array of characters.</p></td></tr><tr><td><p><code>from</code></p></td><td><p>The lowest index to include from the character array.</p></td></tr><tr><td><p><code>until</code></p></td><td><p>The lowest index to exclude from the character array.</p></td></tr></tbody></table>

### Example

This example returns the substring with characters at indices `1` through `4` in the input string.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
var text = "hello world!"
---
substring(text, 1, 5)
```

#### Output

```json
"ello"
```

## substring(text: Null, from: Any, until: Any): Null

Helper function that enables `substring` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=7ed345b89f75f2d2395e908948a392e18a3b5c301b34c902750d3333187b9171 url=/mulesoft/current/en-us/dataweave/2.12/dw-strings-functions-substring.md -->

---
product: DataWeave
version: 2.12
---

# substring

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## substring(text: String, from: Number, until: Number): String

Returns a substring that spans from the character at the specified `from` index to the last
character before the `until` index.

The characters in the substring satisfy the condition `from <= indexOf(string) < until`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string, treated as an array of characters.</p></td></tr><tr><td><p><code>from</code></p></td><td><p>The lowest index to include from the character array.</p></td></tr><tr><td><p><code>until</code></p></td><td><p>The lowest index to exclude from the character array.</p></td></tr></tbody></table>

### Example

This example returns the substring with characters at indices `1` through `4` in the input string.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
var text = "hello world!"
---
substring(text, 1, 5)
```

#### Output

```json
"ello"
```

## substring(text: Null, from: Any, until: Any): Null

Helper function that enables `substring` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=cc4648f4a7073f869a2b4a698aebf46b577c2c388bbe51d7a69c755f364afbf2 url=/mulesoft/current/en-us/dataweave/2.4/dw-strings-functions-substring.md -->

---
product: DataWeave
version: 2.4
---

# substring

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## substring(text: String, from: Number, until: Number): String

Returns a substring that spans from the character at the specified `from` index to the last
character before the `until` index.

The characters in the substring satisfy the condition `from <= indexOf(string) < until`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string, treated as an array of characters.</p></td></tr><tr><td><p><code>from</code></p></td><td><p>The lowest index to include from the character array.</p></td></tr><tr><td><p><code>until</code></p></td><td><p>The lowest index to exclude from the character array.</p></td></tr></tbody></table>

### Example

This example returns the substring with characters at indices `1` through `4` in the input string.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
var text = "hello world!"
---
substring(text, 1, 5)
```

#### Output

```json
"ello"
```

## substring(text: Null, from: Any, until: Any): Null

Helper function that enables `substring` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=49e90d308d4514e2e6e4272cee87c2fb9189971950a7b93cc4bf97e37c2baa9d url=/mulesoft/current/en-us/dataweave/2.6/dw-strings-functions-substring.md -->

---
product: DataWeave
version: 2.6
---

# substring

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## substring(text: String, from: Number, until: Number): String

Returns a substring that spans from the character at the specified `from` index to the last
character before the `until` index.

The characters in the substring satisfy the condition `from <= indexOf(string) < until`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string, treated as an array of characters.</p></td></tr><tr><td><p><code>from</code></p></td><td><p>The lowest index to include from the character array.</p></td></tr><tr><td><p><code>until</code></p></td><td><p>The lowest index to exclude from the character array.</p></td></tr></tbody></table>

### Example

This example returns the substring with characters at indices `1` through `4` in the input string.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
var text = "hello world!"
---
substring(text, 1, 5)
```

#### Output

```json
"ello"
```

## substring(text: Null, from: Any, until: Any): Null

Helper function that enables `substring` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=22f7947cd36883cf321071fcbd1239c2a614a64dc5c364f33c720fc65ff6da61 url=/mulesoft/current/en-us/dataweave/2.9/dw-strings-functions-substring.md -->

---
product: DataWeave
version: 2.9
---

# substring

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## substring(text: String, from: Number, until: Number): String

Returns a substring that spans from the character at the specified `from` index to the last
character before the `until` index.

The characters in the substring satisfy the condition `from <= indexOf(string) < until`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string, treated as an array of characters.</p></td></tr><tr><td><p><code>from</code></p></td><td><p>The lowest index to include from the character array.</p></td></tr><tr><td><p><code>until</code></p></td><td><p>The lowest index to exclude from the character array.</p></td></tr></tbody></table>

### Example

This example returns the substring with characters at indices `1` through `4` in the input string.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
var text = "hello world!"
---
substring(text, 1, 5)
```

#### Output

```json
"ello"
```

## substring(text: Null, from: Any, until: Any): Null

Helper function that enables `substring` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=b2bfbdbdd6e4f72f2f0d6263613126c7abf13336fa1d981cff84bf79baf2c821 url=/mulesoft/current/en-us/dataweave/latest/dw-strings-functions-substring.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# substring

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## substring(text: String, from: Number, until: Number): String

Returns a substring that spans from the character at the specified `from` index to the last
character before the `until` index.

The characters in the substring satisfy the condition `from <= indexOf(string) < until`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string, treated as an array of characters.</p></td></tr><tr><td><p><code>from</code></p></td><td><p>The lowest index to include from the character array.</p></td></tr><tr><td><p><code>until</code></p></td><td><p>The lowest index to exclude from the character array.</p></td></tr></tbody></table>

### Example

This example returns the substring with characters at indices `1` through `4` in the input string.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
var text = "hello world!"
---
substring(text, 1, 5)
```

#### Output

```json
"ello"
```

## substring(text: Null, from: Any, until: Any): Null

Helper function that enables `substring` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=36674b3f5f66427f38b840da186e90cacc960b54359612a66866df653cfa8938 url=/mulesoft/current/en-us/dataweave/2.11/dw-strings-functions-substringafter.md -->

---
product: DataWeave
version: 2.11
---

# substringAfter

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## substringAfter(text: String, separator: String): String

Gets the substring after the first occurrence of a separator. The separator is not returned.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>separator</code></p></td><td><p>String to search for.</p></td></tr></tbody></table>

### Example

This example shows how `substringAfter` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": substringAfter(null, "'"),
  "b": substringAfter("", "-"),
  "c": substringAfter("abc", "b"),
  "d": substringAfter("abcba", "b"),
  "e": substringAfter("abc", "d"),
  "f": substringAfter("abc", "")
}
```

#### Output

```JSON
{

  "a": null,
  "b": "",
  "c": "c",
  "d": "cba",
  "e": "",
  "f": "abc"
}
```

## substringAfter(text: Null, separator: String): Null

Helper function that enables `substringAfter` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=4a6efa088688bd76477f363c4372ed5273c11213fcfc4337883dbbac2bfa4c90 url=/mulesoft/current/en-us/dataweave/2.12/dw-strings-functions-substringafter.md -->

---
product: DataWeave
version: 2.12
---

# substringAfter

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## substringAfter(text: String, separator: String): String

Gets the substring after the first occurrence of a separator. The separator is not returned.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>separator</code></p></td><td><p>String to search for.</p></td></tr></tbody></table>

### Example

This example shows how `substringAfter` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": substringAfter(null, "'"),
  "b": substringAfter("", "-"),
  "c": substringAfter("abc", "b"),
  "d": substringAfter("abcba", "b"),
  "e": substringAfter("abc", "d"),
  "f": substringAfter("abc", "")
}
```

#### Output

```JSON
{

  "a": null,
  "b": "",
  "c": "c",
  "d": "cba",
  "e": "",
  "f": "abc"
}
```

## substringAfter(text: Null, separator: String): Null

Helper function that enables `substringAfter` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=e68765160d6863365cdfde41a9ef1c1f70db49ef6b60da502ad05ea84db1096c url=/mulesoft/current/en-us/dataweave/2.3/dw-strings-functions-substringafter.md -->

---
product: DataWeave
version: 2.3
---

# substringAfter

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## substringAfter(String, String): String

Gets the substring after the first occurrence of a separator. The separator is not returned.

_Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>separator</code></p></td><td><p>String to search for.</p></td></tr></tbody></table>

### Example

This example shows how `substringAfter` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": substringAfter(null, "'"),
  "b": substringAfter("", "-"),
  "c": substringAfter("abc", "b"),
  "d": substringAfter("abcba", "b"),
  "e": substringAfter("abc", "d"),
  "f": substringAfter("abc", "")
}
```

#### Output

```JSON
{

  "a": null,
  "b": "",
  "c": "c",
  "d": "cba",
  "e": "",
  "f": "bc"
}
```

## substringAfter(Null, String): Null

Helper function that enables `substringAfter` to work with a `null` value.

<!-- document id=d06c874d66cea9274bee2416efe4ee582737e05cb6080c4e125b5dc9a235405e url=/mulesoft/current/en-us/dataweave/2.4/dw-strings-functions-substringafter.md -->

---
product: DataWeave
version: 2.4
---

# substringAfter

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## substringAfter(text: String, separator: String): String

Gets the substring after the first occurrence of a separator. The separator is not returned.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>separator</code></p></td><td><p>String to search for.</p></td></tr></tbody></table>

### Example

This example shows how `substringAfter` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": substringAfter(null, "'"),
  "b": substringAfter("", "-"),
  "c": substringAfter("abc", "b"),
  "d": substringAfter("abcba", "b"),
  "e": substringAfter("abc", "d"),
  "f": substringAfter("abc", "")
}
```

#### Output

```JSON
{

  "a": null,
  "b": "",
  "c": "c",
  "d": "cba",
  "e": "",
  "f": "bc"
}
```

## substringAfter(text: Null, separator: String): Null

Helper function that enables `substringAfter` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=06c2005134919a78aa5dbfd943cf1ca4104229744d726842b5eb07f1fef4de03 url=/mulesoft/current/en-us/dataweave/2.6/dw-strings-functions-substringafter.md -->

---
product: DataWeave
version: 2.6
---

# substringAfter

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## substringAfter(text: String, separator: String): String

Gets the substring after the first occurrence of a separator. The separator is not returned.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>separator</code></p></td><td><p>String to search for.</p></td></tr></tbody></table>

### Example

This example shows how `substringAfter` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": substringAfter(null, "'"),
  "b": substringAfter("", "-"),
  "c": substringAfter("abc", "b"),
  "d": substringAfter("abcba", "b"),
  "e": substringAfter("abc", "d"),
  "f": substringAfter("abc", "")
}
```

#### Output

```JSON
{

  "a": null,
  "b": "",
  "c": "c",
  "d": "cba",
  "e": "",
  "f": "bc"
}
```

## substringAfter(text: Null, separator: String): Null

Helper function that enables `substringAfter` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=76004314ee7ddef8dd532df30217f9404fc537ede38b7e78ac1b59cdca7097b8 url=/mulesoft/current/en-us/dataweave/2.9/dw-strings-functions-substringafter.md -->

---
product: DataWeave
version: 2.9
---

# substringAfter

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## substringAfter(text: String, separator: String): String

Gets the substring after the first occurrence of a separator. The separator is not returned.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>separator</code></p></td><td><p>String to search for.</p></td></tr></tbody></table>

### Example

This example shows how `substringAfter` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": substringAfter(null, "'"),
  "b": substringAfter("", "-"),
  "c": substringAfter("abc", "b"),
  "d": substringAfter("abcba", "b"),
  "e": substringAfter("abc", "d"),
  "f": substringAfter("abc", "")
}
```

#### Output

```JSON
{

  "a": null,
  "b": "",
  "c": "c",
  "d": "cba",
  "e": "",
  "f": "abc"
}
```

## substringAfter(text: Null, separator: String): Null

Helper function that enables `substringAfter` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=d704095492b1ba097b31485f7fc95e1b51dd9ebda39845bac4682fa1f6b945ed url=/mulesoft/current/en-us/dataweave/latest/dw-strings-functions-substringafter.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# substringAfter

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## substringAfter(text: String, separator: String): String

Gets the substring after the first occurrence of a separator. The separator is not returned.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>separator</code></p></td><td><p>String to search for.</p></td></tr></tbody></table>

### Example

This example shows how `substringAfter` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": substringAfter(null, "'"),
  "b": substringAfter("", "-"),
  "c": substringAfter("abc", "b"),
  "d": substringAfter("abcba", "b"),
  "e": substringAfter("abc", "d"),
  "f": substringAfter("abc", "")
}
```

#### Output

```JSON
{

  "a": null,
  "b": "",
  "c": "c",
  "d": "cba",
  "e": "",
  "f": "abc"
}
```

## substringAfter(text: Null, separator: String): Null

Helper function that enables `substringAfter` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=dd7a9b7da2110b9cc90c3a5bc56a31faa7cbc87cf91336f445d10702b45c15f3 url=/mulesoft/current/en-us/dataweave/2.11/dw-strings-functions-substringafterlast.md -->

---
product: DataWeave
version: 2.11
---

# substringAfterLast

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## substringAfterLast(text: String, separator: String): String

Gets the substring after the last occurrence of a separator. The separator is not returned.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>separator</code></p></td><td><p>String to search for.</p></td></tr></tbody></table>

### Example

This example shows how `substringAfterLast` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": substringAfterLast(null, "'"),
  "b": substringAfterLast("", "-"),
  "c": substringAfterLast("abc", "b"),
  "d": substringAfterLast("abcba", "b"),
  "e": substringAfterLast("abc", "d"),
  "f": substringAfterLast("abc", "")
}
```

#### Output

```JSON
{
 "a": null,
 "b": "",
 "c": "c",
 "d": "a",
 "e": "",
 "f": null
}
```

## substringAfterLast(text: Null, separator: String): Null

Helper function that enables `substringAfterLast` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=843a709b54fee9dd9bdc6ad45f9ab838b78f88994d3523eab13c0dfd163717be url=/mulesoft/current/en-us/dataweave/2.12/dw-strings-functions-substringafterlast.md -->

---
product: DataWeave
version: 2.12
---

# substringAfterLast

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## substringAfterLast(text: String, separator: String): String

Gets the substring after the last occurrence of a separator. The separator is not returned.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>separator</code></p></td><td><p>String to search for.</p></td></tr></tbody></table>

### Example

This example shows how `substringAfterLast` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": substringAfterLast(null, "'"),
  "b": substringAfterLast("", "-"),
  "c": substringAfterLast("abc", "b"),
  "d": substringAfterLast("abcba", "b"),
  "e": substringAfterLast("abc", "d"),
  "f": substringAfterLast("abc", "")
}
```

#### Output

```JSON
{
 "a": null,
 "b": "",
 "c": "c",
 "d": "a",
 "e": "",
 "f": null
}
```

## substringAfterLast(text: Null, separator: String): Null

Helper function that enables `substringAfterLast` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=10fe4465fe7c1395aa5e4388fe94b65d753cb049ae5834b66848c220b2c521a9 url=/mulesoft/current/en-us/dataweave/2.3/dw-strings-functions-substringafterlast.md -->

---
product: DataWeave
version: 2.3
---

# substringAfterLast

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## substringAfterLast(String, String): String

Gets the substring after the last occurrence of a separator. The separator is not returned.

_Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>separator</code></p></td><td><p>String to search for.</p></td></tr></tbody></table>

### Example

This example shows how `substringAfterLast` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": substringAfterLast(null, "'"),
  "b": substringAfterLast("", "-"),
  "c": substringAfterLast("abc", "b"),
  "d": substringAfterLast("abcba", "b"),
  "e": substringAfterLast("abc", "d"),
  "f": substringAfterLast("abc", "")
}
```

#### Output

```JSON
{
 "a": null,
 "b": "",
 "c": "c",
 "d": "a",
 "e": "",
 "f": null
}
```

## substringAfterLast(Null, String): Null

Helper function that enables `substringAfterLast` to work with a `null` value.

<!-- document id=da4375cd5d9c87579fdc69794e4e979f4a1d8c89cb58b5f35421fef046df15b8 url=/mulesoft/current/en-us/dataweave/2.4/dw-strings-functions-substringafterlast.md -->

---
product: DataWeave
version: 2.4
---

# substringAfterLast

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## substringAfterLast(text: String, separator: String): String

Gets the substring after the last occurrence of a separator. The separator is not returned.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>separator</code></p></td><td><p>String to search for.</p></td></tr></tbody></table>

### Example

This example shows how `substringAfterLast` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": substringAfterLast(null, "'"),
  "b": substringAfterLast("", "-"),
  "c": substringAfterLast("abc", "b"),
  "d": substringAfterLast("abcba", "b"),
  "e": substringAfterLast("abc", "d"),
  "f": substringAfterLast("abc", "")
}
```

#### Output

```JSON
{
 "a": null,
 "b": "",
 "c": "c",
 "d": "a",
 "e": "",
 "f": null
}
```

## substringAfterLast(text: Null, separator: String): Null

Helper function that enables `substringAfterLast` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=995bbf6f2937ba945f171fffd509273f345df56111ce6ff0fbabaff8e47816cf url=/mulesoft/current/en-us/dataweave/2.6/dw-strings-functions-substringafterlast.md -->

---
product: DataWeave
version: 2.6
---

# substringAfterLast

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## substringAfterLast(text: String, separator: String): String

Gets the substring after the last occurrence of a separator. The separator is not returned.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>separator</code></p></td><td><p>String to search for.</p></td></tr></tbody></table>

### Example

This example shows how `substringAfterLast` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": substringAfterLast(null, "'"),
  "b": substringAfterLast("", "-"),
  "c": substringAfterLast("abc", "b"),
  "d": substringAfterLast("abcba", "b"),
  "e": substringAfterLast("abc", "d"),
  "f": substringAfterLast("abc", "")
}
```

#### Output

```JSON
{
 "a": null,
 "b": "",
 "c": "c",
 "d": "a",
 "e": "",
 "f": null
}
```

## substringAfterLast(text: Null, separator: String): Null

Helper function that enables `substringAfterLast` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=a08ef5a4b0bca8e256118544ca6eb21cadd20d3d682fd8605fb6bc1f7c4144db url=/mulesoft/current/en-us/dataweave/2.9/dw-strings-functions-substringafterlast.md -->

---
product: DataWeave
version: 2.9
---

# substringAfterLast

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## substringAfterLast(text: String, separator: String): String

Gets the substring after the last occurrence of a separator. The separator is not returned.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>separator</code></p></td><td><p>String to search for.</p></td></tr></tbody></table>

### Example

This example shows how `substringAfterLast` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": substringAfterLast(null, "'"),
  "b": substringAfterLast("", "-"),
  "c": substringAfterLast("abc", "b"),
  "d": substringAfterLast("abcba", "b"),
  "e": substringAfterLast("abc", "d"),
  "f": substringAfterLast("abc", "")
}
```

#### Output

```JSON
{
 "a": null,
 "b": "",
 "c": "c",
 "d": "a",
 "e": "",
 "f": null
}
```

## substringAfterLast(text: Null, separator: String): Null

Helper function that enables `substringAfterLast` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=76271efaf76db389926ea5c43c9a13d7770d137122019be3a1246551511f335d url=/mulesoft/current/en-us/dataweave/latest/dw-strings-functions-substringafterlast.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# substringAfterLast

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## substringAfterLast(text: String, separator: String): String

Gets the substring after the last occurrence of a separator. The separator is not returned.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>separator</code></p></td><td><p>String to search for.</p></td></tr></tbody></table>

### Example

This example shows how `substringAfterLast` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": substringAfterLast(null, "'"),
  "b": substringAfterLast("", "-"),
  "c": substringAfterLast("abc", "b"),
  "d": substringAfterLast("abcba", "b"),
  "e": substringAfterLast("abc", "d"),
  "f": substringAfterLast("abc", "")
}
```

#### Output

```JSON
{
 "a": null,
 "b": "",
 "c": "c",
 "d": "a",
 "e": "",
 "f": null
}
```

## substringAfterLast(text: Null, separator: String): Null

Helper function that enables `substringAfterLast` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=36c3b2e34d85318305d9073119a8af02402eb434524e402546b145fc908811a0 url=/mulesoft/current/en-us/dataweave/2.11/dw-strings-functions-substringbefore.md -->

---
product: DataWeave
version: 2.11
---

# substringBefore

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## substringBefore(text: String, separator: String): String

Gets the substring before the first occurrence of a separator. The separator is not returned.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>separator</code></p></td><td><p>String to search for.</p></td></tr></tbody></table>

### Example

This example shows how `substringBefore` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": substringBefore(null, "'"),
  "b": substringBefore("", "-"),
  "c": substringBefore("abc", "b"),
  "d": substringBefore("abc", "c"),
  "e": substringBefore("abc", "d"),
  "f": substringBefore("abc", "")
}
```

#### Output

```JSON
{
  "a": null,
  "b": "",
  "c": "a",
  "d": "ab",
  "e": "",
  "f": ""
}
```

## substringBefore(text: Null, separator: String): Null

Helper function that enables `substringBefore` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=b4743c87026cd5e64fc257c0ec91772b0b852505e454745ebc52aaf439700e8b url=/mulesoft/current/en-us/dataweave/2.12/dw-strings-functions-substringbefore.md -->

---
product: DataWeave
version: 2.12
---

# substringBefore

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## substringBefore(text: String, separator: String): String

Gets the substring before the first occurrence of a separator. The separator is not returned.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>separator</code></p></td><td><p>String to search for.</p></td></tr></tbody></table>

### Example

This example shows how `substringBefore` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": substringBefore(null, "'"),
  "b": substringBefore("", "-"),
  "c": substringBefore("abc", "b"),
  "d": substringBefore("abc", "c"),
  "e": substringBefore("abc", "d"),
  "f": substringBefore("abc", "")
}
```

#### Output

```JSON
{
  "a": null,
  "b": "",
  "c": "a",
  "d": "ab",
  "e": "",
  "f": ""
}
```

## substringBefore(text: Null, separator: String): Null

Helper function that enables `substringBefore` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=ee916ba5147ecb0bc73299fd027c592c0c273382bb419c6381073342029ef987 url=/mulesoft/current/en-us/dataweave/2.3/dw-strings-functions-substringbefore.md -->

---
product: DataWeave
version: 2.3
---

# substringBefore

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## substringBefore(String, String): String

Gets the substring before the first occurrence of a separator. The separator is not returned.

_Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>separator</code></p></td><td><p>String to search for.</p></td></tr></tbody></table>

### Example

This example shows how `substringBefore` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": substringBefore(null, "'"),
  "b": substringBefore("", "-"),
  "c": substringBefore("abc", "b"),
  "d": substringBefore("abc", "c"),
  "e": substringBefore("abc", "d"),
  "f": substringBefore("abc", "")
}
```

#### Output

```JSON
{
  "a": null,
  "b": "",
  "c": "a",
  "d": "ab",
  "e": "",
  "f": ""
}
```

## substringBefore(Null, String): Null

Helper function that enables `substringBefore` to work with a `null` value.

<!-- document id=5c39f82c1a1e73d713dd00b6382995ea44a58799010a877c77b71fab60a0fceb url=/mulesoft/current/en-us/dataweave/2.4/dw-strings-functions-substringbefore.md -->

---
product: DataWeave
version: 2.4
---

# substringBefore

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## substringBefore(text: String, separator: String): String

Gets the substring before the first occurrence of a separator. The separator is not returned.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>separator</code></p></td><td><p>String to search for.</p></td></tr></tbody></table>

### Example

This example shows how `substringBefore` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": substringBefore(null, "'"),
  "b": substringBefore("", "-"),
  "c": substringBefore("abc", "b"),
  "d": substringBefore("abc", "c"),
  "e": substringBefore("abc", "d"),
  "f": substringBefore("abc", "")
}
```

#### Output

```JSON
{
  "a": null,
  "b": "",
  "c": "a",
  "d": "ab",
  "e": "",
  "f": ""
}
```

## substringBefore(text: Null, separator: String): Null

Helper function that enables `substringBefore` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=c1b7fc2e8e4b0529d7458525f9bbaa72d0a418309593a0b42d1f4e55b45fe1a2 url=/mulesoft/current/en-us/dataweave/2.6/dw-strings-functions-substringbefore.md -->

---
product: DataWeave
version: 2.6
---

# substringBefore

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## substringBefore(text: String, separator: String): String

Gets the substring before the first occurrence of a separator. The separator is not returned.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>separator</code></p></td><td><p>String to search for.</p></td></tr></tbody></table>

### Example

This example shows how `substringBefore` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": substringBefore(null, "'"),
  "b": substringBefore("", "-"),
  "c": substringBefore("abc", "b"),
  "d": substringBefore("abc", "c"),
  "e": substringBefore("abc", "d"),
  "f": substringBefore("abc", "")
}
```

#### Output

```JSON
{
  "a": null,
  "b": "",
  "c": "a",
  "d": "ab",
  "e": "",
  "f": ""
}
```

## substringBefore(text: Null, separator: String): Null

Helper function that enables `substringBefore` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=7d0909a8a8a447a777121d0c4f78aabbf4b3fa655d9157ab51fe3e614fc42d11 url=/mulesoft/current/en-us/dataweave/2.9/dw-strings-functions-substringbefore.md -->

---
product: DataWeave
version: 2.9
---

# substringBefore

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## substringBefore(text: String, separator: String): String

Gets the substring before the first occurrence of a separator. The separator is not returned.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>separator</code></p></td><td><p>String to search for.</p></td></tr></tbody></table>

### Example

This example shows how `substringBefore` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": substringBefore(null, "'"),
  "b": substringBefore("", "-"),
  "c": substringBefore("abc", "b"),
  "d": substringBefore("abc", "c"),
  "e": substringBefore("abc", "d"),
  "f": substringBefore("abc", "")
}
```

#### Output

```JSON
{
  "a": null,
  "b": "",
  "c": "a",
  "d": "ab",
  "e": "",
  "f": ""
}
```

## substringBefore(text: Null, separator: String): Null

Helper function that enables `substringBefore` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=8d2c60c9d722ecef657f2090cb72ec4d928c4443202d06c424e96847443e1d5b url=/mulesoft/current/en-us/dataweave/latest/dw-strings-functions-substringbefore.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# substringBefore

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## substringBefore(text: String, separator: String): String

Gets the substring before the first occurrence of a separator. The separator is not returned.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>separator</code></p></td><td><p>String to search for.</p></td></tr></tbody></table>

### Example

This example shows how `substringBefore` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": substringBefore(null, "'"),
  "b": substringBefore("", "-"),
  "c": substringBefore("abc", "b"),
  "d": substringBefore("abc", "c"),
  "e": substringBefore("abc", "d"),
  "f": substringBefore("abc", "")
}
```

#### Output

```JSON
{
  "a": null,
  "b": "",
  "c": "a",
  "d": "ab",
  "e": "",
  "f": ""
}
```

## substringBefore(text: Null, separator: String): Null

Helper function that enables `substringBefore` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=ed81b3f8504fd3628be2f509faafb1ab5d39dd925c982d56e8c8ce7ae2bdfa21 url=/mulesoft/current/en-us/dataweave/2.11/dw-strings-functions-substringbeforelast.md -->

---
product: DataWeave
version: 2.11
---

# substringBeforeLast

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## substringBeforeLast(text: String, separator: String): String

Gets the substring before the last occurrence of a separator. The separator is not returned.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>separator</code></p></td><td><p>String to search for.</p></td></tr></tbody></table>

### Example

This example shows how `substringBeforeLast` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": substringBeforeLast(null, "'"),
  "b": substringBeforeLast("", "-"),
  "c": substringBeforeLast("abc", "b"),
  "d": substringBeforeLast("abcba", "b"),
  "e": substringBeforeLast("abc", "d"),
  "f": substringBeforeLast("abc", "")
}
```

#### Output

```JSON
{
  "a": null,
  "b": "",
  "c": "a",
  "d": "abc",
  "e": "",
  "f": "ab"
}
```

## substringBeforeLast(text: Null, separator: String): Null

Helper function that enables `substringBeforeLast` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=fc64ea09aaddd92cf8e8a9b45415395c5b289ae9da15256f5f4adc429837b229 url=/mulesoft/current/en-us/dataweave/2.12/dw-strings-functions-substringbeforelast.md -->

---
product: DataWeave
version: 2.12
---

# substringBeforeLast

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## substringBeforeLast(text: String, separator: String): String

Gets the substring before the last occurrence of a separator. The separator is not returned.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>separator</code></p></td><td><p>String to search for.</p></td></tr></tbody></table>

### Example

This example shows how `substringBeforeLast` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": substringBeforeLast(null, "'"),
  "b": substringBeforeLast("", "-"),
  "c": substringBeforeLast("abc", "b"),
  "d": substringBeforeLast("abcba", "b"),
  "e": substringBeforeLast("abc", "d"),
  "f": substringBeforeLast("abc", "")
}
```

#### Output

```JSON
{
  "a": null,
  "b": "",
  "c": "a",
  "d": "abc",
  "e": "",
  "f": "ab"
}
```

## substringBeforeLast(text: Null, separator: String): Null

Helper function that enables `substringBeforeLast` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=64fa8cf9d0f76554743380d7ef89d7198dd57462d4ecd95dd5dbcf5e7afb33c8 url=/mulesoft/current/en-us/dataweave/2.3/dw-strings-functions-substringbeforelast.md -->

---
product: DataWeave
version: 2.3
---

# substringBeforeLast

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## substringBeforeLast(String, String): String

Gets the substring before the last occurrence of a separator. The separator is not returned.

_Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>separator</code></p></td><td><p>String to search for.</p></td></tr></tbody></table>

### Example

This example shows how `substringBeforeLast` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": substringBeforeLast(null, "'"),
  "b": substringBeforeLast("", "-"),
  "c": substringBeforeLast("abc", "b"),
  "d": substringBeforeLast("abcba", "b"),
  "e": substringBeforeLast("abc", "d"),
  "f": substringBeforeLast("abc", "")
}
```

#### Output

```JSON
{
  "a": null,
  "b": "",
  "c": "a",
  "d": "abc",
  "e": "",
  "f": "ab"
}
```

## substringBeforeLast(Null, String): Null

Helper function that enables `substringBeforeLast` to work with a `null` value.

<!-- document id=963ef7142fdb4112ef1c03b35c0bc1d43fcf4d34c2c7dc6c8982f10924cda4e8 url=/mulesoft/current/en-us/dataweave/2.4/dw-strings-functions-substringbeforelast.md -->

---
product: DataWeave
version: 2.4
---

# substringBeforeLast

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## substringBeforeLast(text: String, separator: String): String

Gets the substring before the last occurrence of a separator. The separator is not returned.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>separator</code></p></td><td><p>String to search for.</p></td></tr></tbody></table>

### Example

This example shows how `substringBeforeLast` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": substringBeforeLast(null, "'"),
  "b": substringBeforeLast("", "-"),
  "c": substringBeforeLast("abc", "b"),
  "d": substringBeforeLast("abcba", "b"),
  "e": substringBeforeLast("abc", "d"),
  "f": substringBeforeLast("abc", "")
}
```

#### Output

```JSON
{
  "a": null,
  "b": "",
  "c": "a",
  "d": "abc",
  "e": "",
  "f": "ab"
}
```

## substringBeforeLast(text: Null, separator: String): Null

Helper function that enables `substringBeforeLast` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=f7706a2c968182ef9397f3716177d6bc8704f9a5b8679a2ee6ca42de325544c8 url=/mulesoft/current/en-us/dataweave/2.6/dw-strings-functions-substringbeforelast.md -->

---
product: DataWeave
version: 2.6
---

# substringBeforeLast

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## substringBeforeLast(text: String, separator: String): String

Gets the substring before the last occurrence of a separator. The separator is not returned.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>separator</code></p></td><td><p>String to search for.</p></td></tr></tbody></table>

### Example

This example shows how `substringBeforeLast` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": substringBeforeLast(null, "'"),
  "b": substringBeforeLast("", "-"),
  "c": substringBeforeLast("abc", "b"),
  "d": substringBeforeLast("abcba", "b"),
  "e": substringBeforeLast("abc", "d"),
  "f": substringBeforeLast("abc", "")
}
```

#### Output

```JSON
{
  "a": null,
  "b": "",
  "c": "a",
  "d": "abc",
  "e": "",
  "f": "ab"
}
```

## substringBeforeLast(text: Null, separator: String): Null

Helper function that enables `substringBeforeLast` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=d681873318048a7a51c4fd1e89f2f272430dd8b77dcc2dcb11b0a54323cba5ff url=/mulesoft/current/en-us/dataweave/2.9/dw-strings-functions-substringbeforelast.md -->

---
product: DataWeave
version: 2.9
---

# substringBeforeLast

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## substringBeforeLast(text: String, separator: String): String

Gets the substring before the last occurrence of a separator. The separator is not returned.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>separator</code></p></td><td><p>String to search for.</p></td></tr></tbody></table>

### Example

This example shows how `substringBeforeLast` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": substringBeforeLast(null, "'"),
  "b": substringBeforeLast("", "-"),
  "c": substringBeforeLast("abc", "b"),
  "d": substringBeforeLast("abcba", "b"),
  "e": substringBeforeLast("abc", "d"),
  "f": substringBeforeLast("abc", "")
}
```

#### Output

```JSON
{
  "a": null,
  "b": "",
  "c": "a",
  "d": "abc",
  "e": "",
  "f": "ab"
}
```

## substringBeforeLast(text: Null, separator: String): Null

Helper function that enables `substringBeforeLast` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=34d511d586a86b68ede9342c4627966cd8b745f729de0c5ce9ee117f726f4dc1 url=/mulesoft/current/en-us/dataweave/latest/dw-strings-functions-substringbeforelast.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# substringBeforeLast

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## substringBeforeLast(text: String, separator: String): String

Gets the substring before the last occurrence of a separator. The separator is not returned.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>separator</code></p></td><td><p>String to search for.</p></td></tr></tbody></table>

### Example

This example shows how `substringBeforeLast` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": substringBeforeLast(null, "'"),
  "b": substringBeforeLast("", "-"),
  "c": substringBeforeLast("abc", "b"),
  "d": substringBeforeLast("abcba", "b"),
  "e": substringBeforeLast("abc", "d"),
  "f": substringBeforeLast("abc", "")
}
```

#### Output

```JSON
{
  "a": null,
  "b": "",
  "c": "a",
  "d": "abc",
  "e": "",
  "f": "ab"
}
```

## substringBeforeLast(text: Null, separator: String): Null

Helper function that enables `substringBeforeLast` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=50c9adb31811eee2faab1dee46a8f187dea1ac98db9c52fc09085e6d6cac20c1 url=/mulesoft/current/en-us/dataweave/2.11/dw-strings-functions-substringby.md -->

---
product: DataWeave
version: 2.11
---

# substringBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## substringBy(text: String, predicate: (character: String, index: Number) -> Boolean): Array<String>

Splits a string at each character where the `predicate` expression returns `true`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to split. The string is treated as an array of characters.</p></td></tr><tr><td><p><code>predicate</code></p></td><td><p>Expression that tests each character and returns a Boolean value. The expression can iterate over each character and index of the string.</p></td></tr></tbody></table>

### Example

This example splits a string where any of the specified characters (`"~"`, `"="`, or `"_"`) are
present.

#### Source

```DataWeave
%dw 2.0
import substringBy from dw::core::Strings
output application/json
---
"hello~world=here_data-weave" substringBy $ == "~" or $ == "=" or $ == "_"
```

#### Output

```Json
["hello", "world", "here", "data-weave"]
```

## substringBy(text: Null, predicate: (character: Nothing, index: Nothing) -> Any): Null

Helper function that enables `substringBy` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=a11d17d704c2af72e6228c8eb2da8720cbce75bc7684c779a05161b10adc4ab1 url=/mulesoft/current/en-us/dataweave/2.12/dw-strings-functions-substringby.md -->

---
product: DataWeave
version: 2.12
---

# substringBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## substringBy(text: String, predicate: (character: String, index: Number) -> Boolean): Array<String>

Splits a string at each character where the `predicate` expression returns `true`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to split. The string is treated as an array of characters.</p></td></tr><tr><td><p><code>predicate</code></p></td><td><p>Expression that tests each character and returns a Boolean value. The expression can iterate over each character and index of the string.</p></td></tr></tbody></table>

### Example

This example splits a string where any of the specified characters (`"~"`, `"="`, or `"_"`) are
present.

#### Source

```DataWeave
%dw 2.0
import substringBy from dw::core::Strings
output application/json
---
"hello~world=here_data-weave" substringBy $ == "~" or $ == "=" or $ == "_"
```

#### Output

```Json
["hello", "world", "here", "data-weave"]
```

## substringBy(text: Null, predicate: (character: Nothing, index: Nothing) -> Any): Null

Helper function that enables `substringBy` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=2ed4197354f84ef174b8473b8c65d62a648357bca536f93d22b4f91ec4e6223e url=/mulesoft/current/en-us/dataweave/2.4/dw-strings-functions-substringby.md -->

---
product: DataWeave
version: 2.4
---

# substringBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## substringBy(text: String, predicate: (character: String, index: Number) -> Boolean): Array<String>

Splits a string at each character where the `predicate` expression returns `true`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to split. The string is treated as an array of characters.</p></td></tr><tr><td><p><code>predicate</code></p></td><td><p>Expression that tests each character and returns a Boolean value. The expression can iterate over each character and index of the string.</p></td></tr></tbody></table>

### Example

This example splits a string where any of the specified characters (`"~"`, `"="`, or `"_"`) are
present.

#### Source

```DataWeave
%dw 2.0
import substringBy from dw::core::Strings
output application/json
---
"hello~world=here_data-weave" substringBy $ == "~" or $ == "=" or $ == "_"
```

#### Output

```Json
["hello", "world", "here", "data-weave"]
```

## substringBy(text: Null, predicate: (character: Nothing, index: Nothing) -> Any): Null

Helper function that enables `substringBy` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=9aa3817ba3ce84c46d867e9727de465426f2f8f69025747adac77882abe2e6ac url=/mulesoft/current/en-us/dataweave/2.6/dw-strings-functions-substringby.md -->

---
product: DataWeave
version: 2.6
---

# substringBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## substringBy(text: String, predicate: (character: String, index: Number) -> Boolean): Array<String>

Splits a string at each character where the `predicate` expression returns `true`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to split. The string is treated as an array of characters.</p></td></tr><tr><td><p><code>predicate</code></p></td><td><p>Expression that tests each character and returns a Boolean value. The expression can iterate over each character and index of the string.</p></td></tr></tbody></table>

### Example

This example splits a string where any of the specified characters (`"~"`, `"="`, or `"_"`) are
present.

#### Source

```DataWeave
%dw 2.0
import substringBy from dw::core::Strings
output application/json
---
"hello~world=here_data-weave" substringBy $ == "~" or $ == "=" or $ == "_"
```

#### Output

```Json
["hello", "world", "here", "data-weave"]
```

## substringBy(text: Null, predicate: (character: Nothing, index: Nothing) -> Any): Null

Helper function that enables `substringBy` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=22bc4fd404a9c9a8045f40e39a0c8165db95bdf1822c83975778ffec81829a4b url=/mulesoft/current/en-us/dataweave/2.9/dw-strings-functions-substringby.md -->

---
product: DataWeave
version: 2.9
---

# substringBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## substringBy(text: String, predicate: (character: String, index: Number) -> Boolean): Array<String>

Splits a string at each character where the `predicate` expression returns `true`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to split. The string is treated as an array of characters.</p></td></tr><tr><td><p><code>predicate</code></p></td><td><p>Expression that tests each character and returns a Boolean value. The expression can iterate over each character and index of the string.</p></td></tr></tbody></table>

### Example

This example splits a string where any of the specified characters (`"~"`, `"="`, or `"_"`) are
present.

#### Source

```DataWeave
%dw 2.0
import substringBy from dw::core::Strings
output application/json
---
"hello~world=here_data-weave" substringBy $ == "~" or $ == "=" or $ == "_"
```

#### Output

```Json
["hello", "world", "here", "data-weave"]
```

## substringBy(text: Null, predicate: (character: Nothing, index: Nothing) -> Any): Null

Helper function that enables `substringBy` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=65aeacdfa6e33fd2363353e97ff948db972eea71ff4425392b451d9464c79acc url=/mulesoft/current/en-us/dataweave/latest/dw-strings-functions-substringby.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# substringBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## substringBy(text: String, predicate: (character: String, index: Number) -> Boolean): Array<String>

Splits a string at each character where the `predicate` expression returns `true`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to split. The string is treated as an array of characters.</p></td></tr><tr><td><p><code>predicate</code></p></td><td><p>Expression that tests each character and returns a Boolean value. The expression can iterate over each character and index of the string.</p></td></tr></tbody></table>

### Example

This example splits a string where any of the specified characters (`"~"`, `"="`, or `"_"`) are
present.

#### Source

```DataWeave
%dw 2.0
import substringBy from dw::core::Strings
output application/json
---
"hello~world=here_data-weave" substringBy $ == "~" or $ == "=" or $ == "_"
```

#### Output

```Json
["hello", "world", "here", "data-weave"]
```

## substringBy(text: Null, predicate: (character: Nothing, index: Nothing) -> Any): Null

Helper function that enables `substringBy` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=cb2cfe0f1be10c0e98d62e91a8375a6bc0b914e5e40b1f239241797d25cbe0a6 url=/mulesoft/current/en-us/dataweave/2.11/dw-strings-functions-substringevery.md -->

---
product: DataWeave
version: 2.11
---

# substringEvery

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## substringEvery(text: String, amount: Number): Array<String>

Splits a string into an array of substrings equal to a specified length.

The last substring can be shorter than that length. If the length is greater than or equal to the
length of the string to split, the function returns the entire string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to split.</p></td></tr><tr><td><p><code>amount</code></p></td><td><p>The desired length of each substring.</p></td></tr></tbody></table>

### Example

This example shows how `substringEvery` behaves when splitting an input string. The last returned
substring is shorter than the others.

#### Source

```DataWeave
%dw 2.0
import substringEvery from dw::core::Strings
output application/json
---
substringEvery("substringEvery", 3)
```

#### Output

```Json
["sub", "str", "ing", "Eve", "ry"]
```

## substringEvery(text: Null, amount: Any): Null

Helper function that enables `substringEvery` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=4046ead54f3866be3ee48d75f62c9514d1e8a99270efcf857ab5e82bb9f0d10e url=/mulesoft/current/en-us/dataweave/2.12/dw-strings-functions-substringevery.md -->

---
product: DataWeave
version: 2.12
---

# substringEvery

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## substringEvery(text: String, amount: Number): Array<String>

Splits a string into an array of substrings equal to a specified length.

The last substring can be shorter than that length. If the length is greater than or equal to the
length of the string to split, the function returns the entire string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to split.</p></td></tr><tr><td><p><code>amount</code></p></td><td><p>The desired length of each substring.</p></td></tr></tbody></table>

### Example

This example shows how `substringEvery` behaves when splitting an input string. The last returned
substring is shorter than the others.

#### Source

```DataWeave
%dw 2.0
import substringEvery from dw::core::Strings
output application/json
---
substringEvery("substringEvery", 3)
```

#### Output

```Json
["sub", "str", "ing", "Eve", "ry"]
```

## substringEvery(text: Null, amount: Any): Null

Helper function that enables `substringEvery` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=a53e1e32a756141beccb1ba1dbbc8847f5498d9bb1618a8654dcf6ff04c494d0 url=/mulesoft/current/en-us/dataweave/2.4/dw-strings-functions-substringevery.md -->

---
product: DataWeave
version: 2.4
---

# substringEvery

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## substringEvery(text: String, amount: Number): Array<String>

Splits a string into an array of substrings equal to a specified length.

The last substring can be shorter than that length. If the length is greater than or equal to the
length of the string to split, the function returns the entire string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to split.</p></td></tr><tr><td><p><code>amount</code></p></td><td><p>The desired length of each substring.</p></td></tr></tbody></table>

### Example

This example shows how `substringEvery` behaves when splitting an input string. The last returned
substring is shorter than the others.

#### Source

```DataWeave
%dw 2.0
import substringEvery from dw::core::Strings
output application/json
---
substringEvery("substringEvery", 3)
```

#### Output

```Json
["sub", "str", "ing", "Eve", "ry"]
```

## substringEvery(text: Null, amount: Any): Null

Helper function that enables `substringEvery` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=cf407f98871070f84cbb8a0d2d323af15722a62aff65b8047d1b71450d92314f url=/mulesoft/current/en-us/dataweave/2.6/dw-strings-functions-substringevery.md -->

---
product: DataWeave
version: 2.6
---

# substringEvery

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## substringEvery(text: String, amount: Number): Array<String>

Splits a string into an array of substrings equal to a specified length.

The last substring can be shorter than that length. If the length is greater than or equal to the
length of the string to split, the function returns the entire string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to split.</p></td></tr><tr><td><p><code>amount</code></p></td><td><p>The desired length of each substring.</p></td></tr></tbody></table>

### Example

This example shows how `substringEvery` behaves when splitting an input string. The last returned
substring is shorter than the others.

#### Source

```DataWeave
%dw 2.0
import substringEvery from dw::core::Strings
output application/json
---
substringEvery("substringEvery", 3)
```

#### Output

```Json
["sub", "str", "ing", "Eve", "ry"]
```

## substringEvery(text: Null, amount: Any): Null

Helper function that enables `substringEvery` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=b86fa88af6b3fc27d4b8df7373240d40d2bae572dedc2cd14b4f2a5005045461 url=/mulesoft/current/en-us/dataweave/2.9/dw-strings-functions-substringevery.md -->

---
product: DataWeave
version: 2.9
---

# substringEvery

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## substringEvery(text: String, amount: Number): Array<String>

Splits a string into an array of substrings equal to a specified length.

The last substring can be shorter than that length. If the length is greater than or equal to the
length of the string to split, the function returns the entire string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to split.</p></td></tr><tr><td><p><code>amount</code></p></td><td><p>The desired length of each substring.</p></td></tr></tbody></table>

### Example

This example shows how `substringEvery` behaves when splitting an input string. The last returned
substring is shorter than the others.

#### Source

```DataWeave
%dw 2.0
import substringEvery from dw::core::Strings
output application/json
---
substringEvery("substringEvery", 3)
```

#### Output

```Json
["sub", "str", "ing", "Eve", "ry"]
```

## substringEvery(text: Null, amount: Any): Null

Helper function that enables `substringEvery` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=95a948437a7760daaec24b0f93026ee8f94beb2ac4283bdb8f3ff4e265393324 url=/mulesoft/current/en-us/dataweave/latest/dw-strings-functions-substringevery.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# substringEvery

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## substringEvery(text: String, amount: Number): Array<String>

Splits a string into an array of substrings equal to a specified length.

The last substring can be shorter than that length. If the length is greater than or equal to the
length of the string to split, the function returns the entire string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to split.</p></td></tr><tr><td><p><code>amount</code></p></td><td><p>The desired length of each substring.</p></td></tr></tbody></table>

### Example

This example shows how `substringEvery` behaves when splitting an input string. The last returned
substring is shorter than the others.

#### Source

```DataWeave
%dw 2.0
import substringEvery from dw::core::Strings
output application/json
---
substringEvery("substringEvery", 3)
```

#### Output

```Json
["sub", "str", "ing", "Eve", "ry"]
```

## substringEvery(text: Null, amount: Any): Null

Helper function that enables `substringEvery` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=dfd2df00e9d52d0e3444d121af64f9d660460c4d87ecbbdf4358d851e1924e68 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-sum.md -->

---
product: DataWeave
version: 2.11
---

# sum

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## sum(@StreamCapable values: Array<Number>): Number

Returns the sum of numeric values in an array.

Returns `0` if the array is empty and produces an error when non-numeric values are in the array.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>values</code></p></td><td><p>The input array of numbers.</p></td></tr></tbody></table>

### Example

This example returns the sum of the values in the input array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
sum([1, 2, 3])
```

#### Output

```JSON
6
```

<!-- document id=7b3de5851113d6e1e9c8b0973c1b42d07de00d1ccd1f637722e21c6cfdd4f9ed url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-sum.md -->

---
product: DataWeave
version: 2.12
---

# sum

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## sum(@StreamCapable values: Array<Number>): Number

Returns the sum of numeric values in an array.

Returns `0` if the array is empty and produces an error when non-numeric values are in the array.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>values</code></p></td><td><p>The input array of numbers.</p></td></tr></tbody></table>

### Example

This example returns the sum of the values in the input array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
sum([1, 2, 3])
```

#### Output

```JSON
6
```

<!-- document id=548818afaedaa2622649d79d24ea9424275ebf83430f9569aed81c22ecd5fbc5 url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-sum.md -->

---
product: DataWeave
version: 2.3
---

# sum

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## sum(Array<Number>): Number

Returns the sum of numeric values in an array.

Returns `0` if the array is empty and produces an error when non-numeric values are in the array.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>values</code></p></td><td><p>The input array of numbers.</p></td></tr></tbody></table>

### Example

This example returns the sum of the values in the input array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
sum([1, 2, 3])
```

#### Output

```JSON
6
```

<!-- document id=9793fa8e4eb46e4a5ecfebb7ad8fe12dc873b8d43cb9c78cbda1be92d6ea238e url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-sum.md -->

---
product: DataWeave
version: 2.4
---

# sum

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## sum(values: Array<Number>): Number

Returns the sum of numeric values in an array.

Returns `0` if the array is empty and produces an error when non-numeric values are in the array.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>values</code></p></td><td><p>The input array of numbers.</p></td></tr></tbody></table>

### Example

This example returns the sum of the values in the input array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
sum([1, 2, 3])
```

#### Output

```JSON
6
```

<!-- document id=ee517e2e834cd7b6a5cdc8a701cad49ca6a8aa09d6ca0a7648c734901214097d url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-sum.md -->

---
product: DataWeave
version: 2.6
---

# sum

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## sum(values: Array<Number>): Number

Returns the sum of numeric values in an array.

Returns `0` if the array is empty and produces an error when non-numeric values are in the array.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>values</code></p></td><td><p>The input array of numbers.</p></td></tr></tbody></table>

### Example

This example returns the sum of the values in the input array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
sum([1, 2, 3])
```

#### Output

```JSON
6
```

<!-- document id=6d2a153467799ca7c3a3c3f07158ffb330f4c452ad6bb05cd60f5fb3bf20c12a url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-sum.md -->

---
product: DataWeave
version: 2.9
---

# sum

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## sum(@StreamCapable values: Array<Number>): Number

Returns the sum of numeric values in an array.

Returns `0` if the array is empty and produces an error when non-numeric values are in the array.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>values</code></p></td><td><p>The input array of numbers.</p></td></tr></tbody></table>

### Example

This example returns the sum of the values in the input array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
sum([1, 2, 3])
```

#### Output

```JSON
6
```

<!-- document id=ce52ba89f0d85c3fcf01584801c111cb6e6f3ac317eb55fdc405afcb138be697 url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-sum.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# sum

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## sum(@StreamCapable values: Array<Number>): Number

Returns the sum of numeric values in an array.

Returns `0` if the array is empty and produces an error when non-numeric values are in the array.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>values</code></p></td><td><p>The input array of numbers.</p></td></tr></tbody></table>

### Example

This example returns the sum of the values in the input array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
sum([1, 2, 3])
```

#### Output

```JSON
6
```

<!-- document id=faff6dd058e4cb0b00fc7cde4455c81c821d39cfbc74a13b1aa588e3fe9f180d url=/mulesoft/current/en-us/dataweave/2.11/dw-arrays-functions-sumby.md -->

---
product: DataWeave
version: 2.11
---

# sumBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## sumBy<T>(@StreamCapable array: Array<T>, numberSelector: (T) -> Number): Number

Returns the sum of the values of the elements in an array.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The input array.</p></td></tr><tr><td><p><code>numberSelector</code></p></td><td><p>A DataWeave selector that selects the values of the numbers in the input array.</p></td></tr></tbody></table>

### Example

This example calculates the sum of the values of elements some arrays. Notice that both of the
`sumBy` function calls produce the same result.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
---
{
  "sumBy" : [
    [ { a: 1 }, { a: 2 }, { a: 3 } ] sumBy $.a,
    sumBy([ { a: 1 }, { a: 2 }, { a: 3 } ], (item) -> item.a)
  ]
}
```

#### Output

```json
{ "sumBy": [6, 6] }
```

## sumBy(array: Null, numberSelector: (Nothing) -> Any): Null

Helper function that enables `sumBy` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=a0c396af9b645417285b91f08ffaeeb136e2d53360f6dc03f42b796a23e7f1a7 url=/mulesoft/current/en-us/dataweave/2.12/dw-arrays-functions-sumby.md -->

---
product: DataWeave
version: 2.12
---

# sumBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## sumBy<T>(@StreamCapable array: Array<T>, numberSelector: (T) -> Number): Number

Returns the sum of the values of the elements in an array.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The input array.</p></td></tr><tr><td><p><code>numberSelector</code></p></td><td><p>A DataWeave selector that selects the values of the numbers in the input array.</p></td></tr></tbody></table>

### Example

This example calculates the sum of the values of elements some arrays. Notice that both of the
`sumBy` function calls produce the same result.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
---
{
  "sumBy" : [
    [ { a: 1 }, { a: 2 }, { a: 3 } ] sumBy $.a,
    sumBy([ { a: 1 }, { a: 2 }, { a: 3 } ], (item) -> item.a)
  ]
}
```

#### Output

```json
{ "sumBy": [6, 6] }
```

## sumBy(array: Null, numberSelector: (Nothing) -> Any): Null

Helper function that enables `sumBy` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=4220d6e0d54d895101273027e77ca16f09c7b48422bd1a2c9af962712866e3a0 url=/mulesoft/current/en-us/dataweave/2.3/dw-arrays-functions-sumby.md -->

---
product: DataWeave
version: 2.3
---

# sumBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## sumBy(Array<T>, (T) -> Number): Number

Returns the sum of the values of the elements in an array.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The input array.</p></td></tr><tr><td><p><code>numberSelector</code></p></td><td><p>A DataWeave selector that selects the values of the numbers in the input array.</p></td></tr></tbody></table>

### Example

This example calculates the sum of the values of elements some arrays. Notice that both of the
`sumBy` function calls produce the same result.

#### Source

```DataWeave
 %dw 2.0
 import * from dw::core::Arrays
 output application/json
 ---
{
  "sumBy" : [
    [ { a: 1 }, { a: 2 }, { a: 3 } ] sumBy $.a,
    sumBy([ { a: 1 }, { a: 2 }, { a: 3 } ], (item) -> item.a)
  ]
}
```

#### Output

```json
{ "sumBy": [6, 6] }
```

<!-- document id=92e6fcc9485004bb6ee9948f85685830bd06cfa828ae02d7d9f058c543a607fd url=/mulesoft/current/en-us/dataweave/2.4/dw-arrays-functions-sumby.md -->

---
product: DataWeave
version: 2.4
---

# sumBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## sumBy<T>(array: Array<T>, numberSelector: (T) -> Number): Number

Returns the sum of the values of the elements in an array.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The input array.</p></td></tr><tr><td><p><code>numberSelector</code></p></td><td><p>A DataWeave selector that selects the values of the numbers in the input array.</p></td></tr></tbody></table>

### Example

This example calculates the sum of the values of elements some arrays. Notice that both of the
`sumBy` function calls produce the same result.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
---
{
  "sumBy" : [
    [ { a: 1 }, { a: 2 }, { a: 3 } ] sumBy $.a,
    sumBy([ { a: 1 }, { a: 2 }, { a: 3 } ], (item) -> item.a)
  ]
}
```

#### Output

```json
{ "sumBy": [6, 6] }
```

## sumBy(array: Null, numberSelector: (Nothing) -> Any): Null

Helper function that enables `sumBy` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=80212511c4218e1a0e1432c216527daea6c4cbed4dc3351586a0e2bf0495c902 url=/mulesoft/current/en-us/dataweave/2.6/dw-arrays-functions-sumby.md -->

---
product: DataWeave
version: 2.6
---

# sumBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## sumBy<T>(array: Array<T>, numberSelector: (T) -> Number): Number

Returns the sum of the values of the elements in an array.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The input array.</p></td></tr><tr><td><p><code>numberSelector</code></p></td><td><p>A DataWeave selector that selects the values of the numbers in the input array.</p></td></tr></tbody></table>

### Example

This example calculates the sum of the values of elements some arrays. Notice that both of the
`sumBy` function calls produce the same result.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
---
{
  "sumBy" : [
    [ { a: 1 }, { a: 2 }, { a: 3 } ] sumBy $.a,
    sumBy([ { a: 1 }, { a: 2 }, { a: 3 } ], (item) -> item.a)
  ]
}
```

#### Output

```json
{ "sumBy": [6, 6] }
```

## sumBy(array: Null, numberSelector: (Nothing) -> Any): Null

Helper function that enables `sumBy` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=5a858b7c9ff180899aa61112e47032f777a4332b394f9af36f022da164773507 url=/mulesoft/current/en-us/dataweave/2.9/dw-arrays-functions-sumby.md -->

---
product: DataWeave
version: 2.9
---

# sumBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## sumBy<T>(@StreamCapable array: Array<T>, numberSelector: (T) -> Number): Number

Returns the sum of the values of the elements in an array.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The input array.</p></td></tr><tr><td><p><code>numberSelector</code></p></td><td><p>A DataWeave selector that selects the values of the numbers in the input array.</p></td></tr></tbody></table>

### Example

This example calculates the sum of the values of elements some arrays. Notice that both of the
`sumBy` function calls produce the same result.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
---
{
  "sumBy" : [
    [ { a: 1 }, { a: 2 }, { a: 3 } ] sumBy $.a,
    sumBy([ { a: 1 }, { a: 2 }, { a: 3 } ], (item) -> item.a)
  ]
}
```

#### Output

```json
{ "sumBy": [6, 6] }
```

## sumBy(array: Null, numberSelector: (Nothing) -> Any): Null

Helper function that enables `sumBy` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=26af4537749b14bb07a7caebeb6a49364bfa7cad33b0cd1e7e398f666f6b7692 url=/mulesoft/current/en-us/dataweave/latest/dw-arrays-functions-sumby.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# sumBy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## sumBy<T>(@StreamCapable array: Array<T>, numberSelector: (T) -> Number): Number

Returns the sum of the values of the elements in an array.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The input array.</p></td></tr><tr><td><p><code>numberSelector</code></p></td><td><p>A DataWeave selector that selects the values of the numbers in the input array.</p></td></tr></tbody></table>

### Example

This example calculates the sum of the values of elements some arrays. Notice that both of the
`sumBy` function calls produce the same result.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
---
{
  "sumBy" : [
    [ { a: 1 }, { a: 2 }, { a: 3 } ] sumBy $.a,
    sumBy([ { a: 1 }, { a: 2 }, { a: 3 } ], (item) -> item.a)
  ]
}
```

#### Output

```json
{ "sumBy": [6, 6] }
```

## sumBy(array: Null, numberSelector: (Nothing) -> Any): Null

Helper function that enables `sumBy` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=bc6b406602f74b3c71975f4fdfd180f97b3fbd67e3217347d54e617f1b75be01 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-formats.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Supported Data Formats

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave can read and write many types of data formats, such as JSON, XML, and many others.

DataWeave supports the following formats as input and output:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>MIME Type</th><th>ID</th><th>Supported Formats</th></tr></thead><tbody><tr><td><p><code>application/avro</code></p></td><td><p><code>avro</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-formats-avro">Avro Format</a></p></td></tr><tr><td><p><code>application/csv</code></p></td><td><p><code>csv</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-formats-csv">CSV Format</a></p></td></tr><tr><td><p><code>application/dw</code></p></td><td><p><code>dw</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-formats-dw">DataWeave Format (dw)</a> for testing a DataWeave expression</p></td></tr><tr><td><p><code>application/flatfile</code></p></td><td><p><code>flatfile</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-formats-flatfile">Flat File Format</a>, <a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-formats-copybook">COBOL Copybook Format</a>, <a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-formats-fixedwidth">Fixed Width Format</a></p></td></tr><tr><td><p><code>application/java</code></p></td><td><p><code>java</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-formats-java">Java Format</a>, <a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-formats-java#format_enum">Enum Format for Java</a></p></td></tr><tr><td><p><code>application/json</code></p></td><td><p><code>json</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-formats-json">JSON Format</a></p></td></tr><tr><td><p><code>application/octet-stream</code></p></td><td><p><code>binary</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-formats-binary">Binary Format</a></p></td></tr><tr><td><p><code>application/protobuf</code>, <code>application/x-protobuf</code></p></td><td><p><code>protobuf</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-formats-protobuf">Protobuf Format</a></p></td></tr><tr><td><p><code>application/xlsx</code></p></td><td><p><code>excel</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-formats-excel">Excel Format</a></p></td></tr><tr><td><p><code>application/xml</code></p></td><td><p><code>xml</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-formats-xml">XML Format</a>, <a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-formats-xml#format_xml_cdata">CData Custom Type</a></p></td></tr><tr><td><p><code>application/x-ndjson</code></p></td><td><p><code>ndjson</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-formats-ndjson">Newline Delimited JSON Format (ndjson)</a></p></td></tr><tr><td><p><code>application/x-www-form-urlencoded</code></p></td><td><p><code>urlencoded</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-formats-urlencoded">URL Encoded Format</a></p></td></tr><tr><td><p><code>application/yaml</code></p></td><td><p><code>yaml</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-formats-yaml">YAML Format</a></p></td></tr><tr><td><p><code>multipart/form-data</code></p></td><td><p><code>multipart</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-formats-multipart">Multipart Format</a></p></td></tr><tr><td><p><code>text/plain</code></p></td><td><p><code>text</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-formats-text">Text Plain Format</a></p></td></tr><tr><td><p><code>text/x-java-properties</code></p></td><td><p><code>properties</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-formats-properties">Text Java Properties</a></p></td></tr></tbody></table>

## DataWeave Readers

DataWeave can read input data as a whole by loading it into memory or by indexing it in local
storage and, for some data formats, DataWeave can read data sequentially in parts by streaming the
input. The indexed reading strategy implements a mechanism to avoid out-of-memory issues when
processing large files. The streaming strategy can improve performance but restricts file access to
sequential access (which disallows random access) because you can access only the part of the file
that is being read and stored in memory.

<table id="streaming"><colgroup><col> <col> <col></colgroup><thead><tr><th>Read Strategy</th><th>Description</th><th>Supported Formats</th></tr></thead><tbody><tr><td><div><div><p>In-Memory</p></div></div></td><td><div><div><p>This strategy parses the entire document and loads it into memory, enabling random access to data. When using this strategy, a DataWeave script can access any part of the resulting value at any time.</p></div></div></td><td><div><div><p>DataWeave can read all supported formats using this strategy.</p></div></div></td></tr><tr><td><div><div><p>Indexed</p></div></div></td><td><div><div><p>This strategy parses the entire document and uses disk space to avoid out-of-memory issues on large files, enabling random access to data. When using this strategy, a DataWeave script can access any part of the resulting value at any time.</p></div><div><p>When processing a <code>String</code> with a size larger than 1.5 MB, DataWeave automatically splits the value in chunks to avoid out-of-memory issues. This feature works only with <code>JSON</code> and <code>XML</code> input data.</p></div><div><p>For additional details, see <a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-indexed-readers">Indexed Readers in DataWeave</a></p></div></div></td><td><div><div><ul><li><p><code>CSV</code></p></li><li><p><code>JSON</code></p></li><li><p><code>XML</code></p></li></ul></div></div></td></tr><tr><td><div><div><p>Streaming</p></div></div></td><td><div><div><p>This strategy partitions the input document into smaller items and accesses the data sequentially, storing the current item in memory. A DataWeave selector can access only the portion of the file that is getting read.</p></div><div><p>For additional details, see <a href="https://docs.mulesoft.com/dataweave/2.11/dataweave-streaming">Streaming in DataWeave</a></p></div></div></td><td><div><div><ul><li><p><code>CSV</code></p></li><li><p><code>JSON</code></p></li><li><p><code>Excel</code> (XLSX)</p></li><li><p><code>XML</code></p></li></ul></div></div></td></tr></tbody></table>

## Using Reader and Writer Properties

In some cases, it is necessary to modify or specify aspects of the format through format-specific
properties. For example, you can specify CSV input and output properties, such as the `separator`
(or delimiter) to use in the CSV file. For Cobol copybook, you need to specify the path to a schema
file using the `schemaPath` property.

You can append reader properties to the MIME type (`outputMimeType`) attribute for certain
components in your Mule app. Listeners and Read operations accept these settings. For example, this
On New File listener example identifies the `,` separator for a CSV input file:

Example: Properties for the CSV Reader

```xml
<file:listener doc:name="On New File" config-ref="File_Config" outputMimeType='application/csv; separator=","'>
  <scheduling-strategy >
    <fixed-frequency frequency="45" timeUnit="SECONDS"/>
  </scheduling-strategy>
  <file:matcher filenamePattern="comma_separated.csv" />
</file:listener>
```

Note that the `outputMimeType` setting above helps the CSV _reader_ interpret the format and
delimiter of the input `comma_separated.csv` file, not the writer.

To specify the output format, you can provide the MIME type and any writer properties for the
writer, such as the CSV or JSON writer used by a File Write operation. For example, you might need
to write a pipe (`|`) delimiter in your CSV output payload, instead of some other delimiter used in
the input. To do this, you append the property and its value to the `output` directive of a
DataWeave expression. For example, this Write operation specifies the pipe as a `separator`:

Example: output Directive for the CSV Writer

```xml
<file:write doc:name="Write" config-ref="File_Config" path="my_transform">
  <file:content ><![CDATA[#[output application/csv separator="|" --- payload]]]></file:content>
</file:write>
```

The following example shows a DataWeave script in which the `output` directive specifies two writer
properties, one for the CSV field separator, another to indicate that there is no header.

```json
%dw 2.0
output application/csv separator=";", header=false
---
payload
```

Writer properties depend on the format. The following example uses the JSON writer property,
`skipNullOn`:

```json
%dw 2.0
output application/json skipNullOn="everywhere"
---
payload
```

The following example shows a DataWeave script that uses an invisible ASCII character as a separator
for the CSV output. The separator property value is `\u001E`. `\u` is the escape sequence
representation and `001E` is the hexadecimal representation of the record separator (RS) ASCII
character.

```DataWeave
%dw 2.0
output application/csv separator = "\u001E"
---
[
	{
		"Name" : "Tom",
		"UID" : 2569,
		"ShipOrderID" : "ui-288188"
	},
	{
		"Name" : "Alan",
		"UID" : 7756,
		"ShipOrderID" : "xj-232142"
	},
	{
		"Name" : "Dan",
		"UID" : 7821,
		"ShipOrderID" : "uk-259459"
	}
]
```

The CSV example produces the following output:

```csv
NameUIDShipOrderID
Tom2569ui-288188
Alan7756xj-232142
Dan7821uk-259459
```

Scripts that use the `read` or `readUrl` methods can also specify reader properties through the
`readerProperties` parameter. See examples in [read](https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-read). However, note that use
of reader properties is more common in message sources, such as the HTTP listener, as shown in the
[CSV reader example](#example_csv_reader).

It is also possible to use a Mule variable as a value of a configuration property. For more complete
examples, see
[Set Reader and Writer Configuration Properties](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-set-reader-writer-props).

## Setting MIME Types

You can specify the MIME type for the input and output data that flows through a Mule app.

For DataWeave transformations, you can specify the MIME type for the output data. For example, you
might set the `output` header directive of an expression in the Transform Message component or a
Write operation to `output application/json` or `output application/csv`.

This example sets the MIME type through a File Write operation to ensure that a format-specific
writer, the CSV writer, outputs the payload in CSV format:

Example: MIME Type for the CSV Writer

```xml
<file:write doc:name="Write" config-ref="File_Config" path="my_transform">
  <file:content ><![CDATA[#[output application/csv --- payload]]]></file:content>
</file:write>
```

Starting in Mule 4.3.0, you can set the `output` directive using the format ID alone, instead of
using the MIME type. For example, you might set the `output` header directive of an expression in
the Transform Message component or a Write operation to `output json` or `output csv`. You can also
use the format ID to differentiate the format of the output data from the MIME type in the output
header, and you can use a custom MIME type. For example, you can write JSON data but customize the
MIME type to `application/problem+json` by using the DataWeave directive
`output application/problem+json with json`. See
[Change a Script’s MIME Type Output](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-change-script-output-mime) for examples that
customize the MIME type output of a script.

The `with` keyword separates the output MIME type from the DataWeave writer for the script’s output.
For example, you can specify 'output application/csv with binary' to output the `application/csv`
MIME type when using the `binary` writer. This setting is necessary in cases shown in
[Use Dynamic Writer Properties](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-writer-prop-mule) and
[Use Reader and Writer Properties in DataWeave Functions](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-set-reader-writer-props#use-reader-and-writer-properties-in-dataweave-functions).
It is also possible to append writer properties, such as in the use case
`output application/my-custom-type with json indent=false`.

For input data, format-specific readers for Mule sources (such as the On New File listener), Mule
operations (such as Read and HTTP Request operations), and DataWeave expressions attempt to infer
the MIME type from metadata that is associated with input payloads, attributes, and variables in the
Mule event. When the MIME type cannot be inferred from the metadata (and when that metadata is not
static), Mule sources and operations allow you to specify the MIME type for the reader. For example,
you might set the MIME type for the On New File listener to `outputMimeType='application/csv'` for
CSV file _input_. This setting provides information about the file format to the CSV reader.

Example: MIME Type for the CSV Reader

```xml
<file:listener doc:name="On New File"
  config-ref="File_Config"
  outputMimeType='application/csv'>
</file:listener>
```

Note that reader settings _are not_ used to perform a transformation from one format to another.
They simply help the reader interpret the format of the input.

You can also set special reader and writer properties for use by the format-specific reader or
writer of a source, operation, or component. See
[Using Reader and Writer Properties](#reader_writer_properties).

## See Also

[Transform Message Component](https://docs.mulesoft.com/studio/transform-message-component-concept-studio)

[Flat File Schemas](https://docs.mulesoft.com/dataweave/2.11/dataweave-flat-file-schemas)

<!-- document id=af29718cf916b1931ab700f09509e8d258b8f8d8d5969561811b575a0cfcd4f1 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-formats.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Supported Data Formats

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave can read and write many types of data formats, such as JSON, XML, and many others.

DataWeave supports the following formats as input and output:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>MIME Type</th><th>ID</th><th>Supported Formats</th></tr></thead><tbody><tr><td><p><code>application/avro</code></p></td><td><p><code>avro</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-formats-avro">Avro Format</a></p></td></tr><tr><td><p><code>application/csv</code></p></td><td><p><code>csv</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-formats-csv">CSV Format</a></p></td></tr><tr><td><p><code>application/dw</code></p></td><td><p><code>dw</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-formats-dw">DataWeave Format (dw)</a> for testing a DataWeave expression</p></td></tr><tr><td><p><code>application/flatfile</code></p></td><td><p><code>flatfile</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-formats-flatfile">Flat File Format</a>, <a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-formats-copybook">COBOL Copybook Format</a>, <a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-formats-fixedwidth">Fixed Width Format</a></p></td></tr><tr><td><p><code>application/java</code></p></td><td><p><code>java</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-formats-java">Java Format</a>, <a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-formats-java#format_enum">Enum Format for Java</a></p></td></tr><tr><td><p><code>application/json</code></p></td><td><p><code>json</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-formats-json">JSON Format</a></p></td></tr><tr><td><p><code>application/octet-stream</code></p></td><td><p><code>binary</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-formats-binary">Binary Format</a></p></td></tr><tr><td><p><code>application/protobuf</code>, <code>application/x-protobuf</code></p></td><td><p><code>protobuf</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-formats-protobuf">Protobuf Format</a></p></td></tr><tr><td><p><code>application/xlsx</code></p></td><td><p><code>excel</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-formats-excel">Excel Format</a></p></td></tr><tr><td><p><code>application/xml</code></p></td><td><p><code>xml</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-formats-xml">XML Format</a>, <a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-formats-xml#format_xml_cdata">CData Custom Type</a></p></td></tr><tr><td><p><code>application/x-ndjson</code></p></td><td><p><code>ndjson</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-formats-ndjson">Newline Delimited JSON Format (ndjson)</a></p></td></tr><tr><td><p><code>application/x-www-form-urlencoded</code></p></td><td><p><code>urlencoded</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-formats-urlencoded">URL Encoded Format</a></p></td></tr><tr><td><p><code>application/yaml</code></p></td><td><p><code>yaml</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-formats-yaml">YAML Format</a></p></td></tr><tr><td><p><code>multipart/form-data</code></p></td><td><p><code>multipart</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-formats-multipart">Multipart Format</a></p></td></tr><tr><td><p><code>text/plain</code></p></td><td><p><code>text</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-formats-text">Text Plain Format</a></p></td></tr><tr><td><p><code>text/x-java-properties</code></p></td><td><p><code>properties</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-formats-properties">Text Java Properties</a></p></td></tr></tbody></table>

## DataWeave Readers

DataWeave can read input data as a whole by loading it into memory or by indexing it in local
storage and, for some data formats, DataWeave can read data sequentially in parts by streaming the
input. The indexed reading strategy implements a mechanism to avoid out-of-memory issues when
processing large files. The streaming strategy can improve performance but restricts file access to
sequential access (which disallows random access) because you can access only the part of the file
that is being read and stored in memory.

<table id="streaming"><colgroup><col> <col> <col></colgroup><thead><tr><th>Read Strategy</th><th>Description</th><th>Supported Formats</th></tr></thead><tbody><tr><td><div><div><p>In-Memory</p></div></div></td><td><div><div><p>This strategy parses the entire document and loads it into memory, enabling random access to data. When using this strategy, a DataWeave script can access any part of the resulting value at any time.</p></div></div></td><td><div><div><p>DataWeave can read all supported formats using this strategy.</p></div></div></td></tr><tr><td><div><div><p>Indexed</p></div></div></td><td><div><div><p>This strategy parses the entire document and uses disk space to avoid out-of-memory issues on large files, enabling random access to data. When using this strategy, a DataWeave script can access any part of the resulting value at any time.</p></div><div><p>When processing a <code>String</code> with a size larger than 1.5 MB, DataWeave automatically splits the value in chunks to avoid out-of-memory issues. This feature works only with <code>JSON</code> and <code>XML</code> input data.</p></div><div><p>For additional details, see <a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-indexed-readers">Indexed Readers in DataWeave</a></p></div></div></td><td><div><div><ul><li><p><code>CSV</code></p></li><li><p><code>JSON</code></p></li><li><p><code>XML</code></p></li></ul></div></div></td></tr><tr><td><div><div><p>Streaming</p></div></div></td><td><div><div><p>This strategy partitions the input document into smaller items and accesses the data sequentially, storing the current item in memory. A DataWeave selector can access only the portion of the file that is getting read.</p></div><div><p>For additional details, see <a href="https://docs.mulesoft.com/dataweave/2.12/dataweave-streaming">Streaming in DataWeave</a></p></div></div></td><td><div><div><ul><li><p><code>CSV</code></p></li><li><p><code>JSON</code></p></li><li><p><code>Excel</code> (XLSX)</p></li><li><p><code>XML</code></p></li></ul></div></div></td></tr></tbody></table>

## Using Reader and Writer Properties

In some cases, it is necessary to modify or specify aspects of the format through format-specific
properties. For example, you can specify CSV input and output properties, such as the `separator`
(or delimiter) to use in the CSV file. For Cobol copybook, you need to specify the path to a schema
file using the `schemaPath` property.

You can append reader properties to the MIME type (`outputMimeType`) attribute for certain
components in your Mule app. Listeners and Read operations accept these settings. For example, this
On New File listener example identifies the `,` separator for a CSV input file:

Example: Properties for the CSV Reader

```xml
<file:listener doc:name="On New File" config-ref="File_Config" outputMimeType='application/csv; separator=","'>
  <scheduling-strategy >
    <fixed-frequency frequency="45" timeUnit="SECONDS"/>
  </scheduling-strategy>
  <file:matcher filenamePattern="comma_separated.csv" />
</file:listener>
```

Note that the `outputMimeType` setting above helps the CSV _reader_ interpret the format and
delimiter of the input `comma_separated.csv` file, not the writer.

To specify the output format, you can provide the MIME type and any writer properties for the
writer, such as the CSV or JSON writer used by a File Write operation. For example, you might need
to write a pipe (`|`) delimiter in your CSV output payload, instead of some other delimiter used in
the input. To do this, you append the property and its value to the `output` directive of a
DataWeave expression. For example, this Write operation specifies the pipe as a `separator`:

Example: output Directive for the CSV Writer

```xml
<file:write doc:name="Write" config-ref="File_Config" path="my_transform">
  <file:content ><![CDATA[#[output application/csv separator="|" --- payload]]]></file:content>
</file:write>
```

The following example shows a DataWeave script in which the `output` directive specifies two writer
properties, one for the CSV field separator, another to indicate that there is no header.

```json
%dw 2.0
output application/csv separator=";", header=false
---
payload
```

Writer properties depend on the format. The following example uses the JSON writer property,
`skipNullOn`:

```json
%dw 2.0
output application/json skipNullOn="everywhere"
---
payload
```

The following example shows a DataWeave script that uses an invisible ASCII character as a separator
for the CSV output. The separator property value is `\u001E`. `\u` is the escape sequence
representation and `001E` is the hexadecimal representation of the record separator (RS) ASCII
character.

```DataWeave
%dw 2.0
output application/csv separator = "\u001E"
---
[
	{
		"Name" : "Tom",
		"UID" : 2569,
		"ShipOrderID" : "ui-288188"
	},
	{
		"Name" : "Alan",
		"UID" : 7756,
		"ShipOrderID" : "xj-232142"
	},
	{
		"Name" : "Dan",
		"UID" : 7821,
		"ShipOrderID" : "uk-259459"
	}
]
```

The CSV example produces the following output:

```csv
NameUIDShipOrderID
Tom2569ui-288188
Alan7756xj-232142
Dan7821uk-259459
```

Scripts that use the `read` or `readUrl` methods can also specify reader properties through the
`readerProperties` parameter. See examples in [read](https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-read). However, note that use
of reader properties is more common in message sources, such as the HTTP listener, as shown in the
[CSV reader example](#example_csv_reader).

It is also possible to use a Mule variable as a value of a configuration property. For more complete
examples, see
[Set Reader and Writer Configuration Properties](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-set-reader-writer-props).

## Setting MIME Types

You can specify the MIME type for the input and output data that flows through a Mule app.

For DataWeave transformations, you can specify the MIME type for the output data. For example, you
might set the `output` header directive of an expression in the Transform Message component or a
Write operation to `output application/json` or `output application/csv`.

This example sets the MIME type through a File Write operation to ensure that a format-specific
writer, the CSV writer, outputs the payload in CSV format:

Example: MIME Type for the CSV Writer

```xml
<file:write doc:name="Write" config-ref="File_Config" path="my_transform">
  <file:content ><![CDATA[#[output application/csv --- payload]]]></file:content>
</file:write>
```

Starting in Mule 4.3.0, you can set the `output` directive using the format ID alone, instead of
using the MIME type. For example, you might set the `output` header directive of an expression in
the Transform Message component or a Write operation to `output json` or `output csv`. You can also
use the format ID to differentiate the format of the output data from the MIME type in the output
header, and you can use a custom MIME type. For example, you can write JSON data but customize the
MIME type to `application/problem+json` by using the DataWeave directive
`output application/problem+json with json`. See
[Change a Script’s MIME Type Output](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-change-script-output-mime) for examples that
customize the MIME type output of a script.

The `with` keyword separates the output MIME type from the DataWeave writer for the script’s output.
For example, you can specify 'output application/csv with binary' to output the `application/csv`
MIME type when using the `binary` writer. This setting is necessary in cases shown in
[Use Dynamic Writer Properties](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-writer-prop-mule) and
[Use Reader and Writer Properties in DataWeave Functions](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-set-reader-writer-props#use-reader-and-writer-properties-in-dataweave-functions).
It is also possible to append writer properties, such as in the use case
`output application/my-custom-type with json indent=false`.

For input data, format-specific readers for Mule sources (such as the On New File listener), Mule
operations (such as Read and HTTP Request operations), and DataWeave expressions attempt to infer
the MIME type from metadata that is associated with input payloads, attributes, and variables in the
Mule event. When the MIME type cannot be inferred from the metadata (and when that metadata is not
static), Mule sources and operations allow you to specify the MIME type for the reader. For example,
you might set the MIME type for the On New File listener to `outputMimeType='application/csv'` for
CSV file _input_. This setting provides information about the file format to the CSV reader.

Example: MIME Type for the CSV Reader

```xml
<file:listener doc:name="On New File"
  config-ref="File_Config"
  outputMimeType='application/csv'>
</file:listener>
```

Note that reader settings _are not_ used to perform a transformation from one format to another.
They simply help the reader interpret the format of the input.

You can also set special reader and writer properties for use by the format-specific reader or
writer of a source, operation, or component. See
[Using Reader and Writer Properties](#reader_writer_properties).

## See Also

[Transform Message Component](https://docs.mulesoft.com/studio/transform-message-component-concept-studio)

[Flat File Schemas](https://docs.mulesoft.com/dataweave/2.12/dataweave-flat-file-schemas)

<!-- document id=c09d786f55b42e65bc1713a05f49c00fd43fc0357a8cc35fc1625656dfdea029 url=/mulesoft/current/en-us/dataweave/2.3/dataweave-formats.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Supported Data Formats

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave can read and write many types of data formats, such as JSON, XML, and many others.

DataWeave supports the following formats as input and output:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>MIME Type</th><th>ID</th><th>Supported Formats</th></tr></thead><tbody><tr><td><p><code>application/avro</code></p></td><td><p><code>avro</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-formats-avro">Avro Format</a></p></td></tr><tr><td><p><code>application/csv</code></p></td><td><p><code>csv</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-formats-csv">CSV Format</a></p></td></tr><tr><td><p><code>application/dw</code></p></td><td><p><code>dw</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-formats-dw">DataWeave Format (dw)</a> for testing a DataWeave expression</p></td></tr><tr><td><p><code>application/flatfile</code></p></td><td><p><code>flatfile</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-formats-flatfile">Flat File Format</a>, <a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-formats-copybook">COBOL Copybook Format</a>, <a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-formats-fixedwidth">Fixed Width Format</a></p></td></tr><tr><td><p><code>application/java</code></p></td><td><p><code>java</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-formats-java">Java Format</a>, <a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-formats-java#format_enum">Enum Format for Java</a></p></td></tr><tr><td><p><code>application/json</code></p></td><td><p><code>json</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-formats-json">JSON Format</a></p></td></tr><tr><td><p><code>application/octet-stream</code></p></td><td><p><code>binary</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-formats-binary">Binary Format</a></p></td></tr><tr><td><p><code>application/xlsx</code></p></td><td><p><code>excel</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-formats-excel">Excel Format</a></p></td></tr><tr><td><p><code>application/xml</code></p></td><td><p><code>xml</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-formats-xml">XML Format</a>, <a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-formats-xml#format_xml_cdata">CData Custom Type</a></p></td></tr><tr><td><p><code>application/x-ndjson</code></p></td><td><p><code>ndjson</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-formats-ndjson">Newline Delimited JSON Format (ndjson)</a></p></td></tr><tr><td><p><code>application/x-www-form-urlencoded</code></p></td><td><p><code>urlencoded</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-formats-urlencoded">URL Encoded Format</a></p></td></tr><tr><td><p><code>application/yaml</code></p></td><td><p><code>yaml</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-formats-yaml">YAML Format</a></p></td></tr><tr><td><p><code>multipart/form-data</code></p></td><td><p><code>multipart</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-formats-multipart">Multipart Format</a></p></td></tr><tr><td><p><code>text/plain</code></p></td><td><p><code>text</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-formats-text">Text Plain Format</a></p></td></tr><tr><td><p><code>text/x-java-properties</code></p></td><td><p><code>properties</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-formats-properties">Text Java Properties</a></p></td></tr></tbody></table>

## DataWeave Readers

DataWeave can read input data as a whole in-memory, in indexed fashion, and for some data formats,
part-by-part by streaming the input. When attempting to read a large file, it is possible to run out
of memory or to impact performance negatively. Streaming can improve performance but impacts access
to file.

- Indexed and In-Memory:  
  Allow for random access to data because both strategies parse the entire document. When using
  these strategies, a DataWeave script can access any part of the resulting value at any time.

  - Indexed:  
    Uses indexes over the disk.

    DataWeave can only read the following formats in the indexed mode:

    CSV, JSON, XML (starting in Mule 4.3.0)

    Note that DataWeave _does not_ support reading Excel (XLSX) input in the indexed mode.

  - In-Memory:  
    Parses the entire document in memory.

    DataWeave can read all supported formats using the in-memory mode.

- Streaming:  
  Allows for sequential access to the file. This strategy partitions the input document into smaller
  items and accesses its data sequentially, storing the current item in memory. A DataWeave selector
  can access the portion of the file that is getting read.

  DataWeave supports streaming only for the following formats:

  CSV, JSON, Excel (XLSX, starting in Mule 4.2.2), XML (starting in Mule 4.3.0)

For details, see [Streaming in DataWeave](https://docs.mulesoft.com/dataweave/2.3/dataweave-streaming).

## Using Reader and Writer Properties

In some cases, it is necessary to modify or specify aspects of the format through format-specific
properties. For example, you can specify CSV input and output properties, such as the `separator`
(or delimiter) to use in the CSV file. For Cobol copybook, you need to specify the path to a schema
file using the `schemaPath` property.

You can append reader properties to the MIME type (`outputMimeType`) attribute for certain
components in your Mule app. Listeners and Read operations accept these settings. For example, this
On New File listener example identifies the `,` separator for a CSV input file:

Example: Properties for the CSV Reader

```xml
<file:listener doc:name="On New File" config-ref="File_Config" outputMimeType='application/csv; separator=","'>
  <scheduling-strategy >
    <fixed-frequency frequency="45" timeUnit="SECONDS"/>
  </scheduling-strategy>
  <file:matcher filenamePattern="comma_separated.csv" />
</file:listener>
```

Note that the `outputMimeType` setting above helps the CSV _reader_ interpret the format and
delimiter of the input `comma_separated.csv` file, not the writer.

To specify the output format, you can provide the MIME type and any writer properties for the
writer, such as the CSV or JSON writer used by a File Write operation. For example, you might need
to write a pipe (`|`) delimiter in your CSV output payload, instead of some other delimiter used in
the input. To do this, you append the property and its value to the `output` directive of a
DataWeave expression. For example, this Write operation specifies the pipe as a `separator`:

Example: output Directive for the CSV Writer

```xml
<file:write doc:name="Write" config-ref="File_Config" path="my_transform">
  <file:content ><![CDATA[#[output application/csv separator="|" --- payload]]]></file:content>
</file:write>
```

The following example shows a DataWeave script in which the `output` directive specifies two writer
properties, one for the CSV field separator, another to indicate that there is no header.

```json
%dw 2.0
output application/csv separator=";", header=false
---
payload
```

Writer properties depend on the format. The following example uses the JSON writer property,
`skipNullOn`:

```json
%dw 2.0
output application/json skipNullOn="everywhere"
---
payload
```

The following example shows a DataWeave script that uses an invisible ASCII character as a separator
for the CSV output. The separator property value is `\u001E`. `\u` is the escape sequence
representation and `001E` is the hexadecimal representation of the record separator (RS) ASCII
character.

```DataWeave
%dw 2.0
output application/csv separator = "\u001E"
---
[
	{
		"Name" : "Tom",
		"UID" : 2569,
		"ShipOrderID" : "ui-288188"
	},
	{
		"Name" : "Alan",
		"UID" : 7756,
		"ShipOrderID" : "xj-232142"
	},
	{
		"Name" : "Dan",
		"UID" : 7821,
		"ShipOrderID" : "uk-259459"
	}
]
```

The CSV example produces the following output:

```csv
NameUIDShipOrderID
Tom2569ui-288188
Alan7756xj-232142
Dan7821uk-259459
```

Scripts that use the `read` or `readUrl` methods can also specify reader properties through the
`readerProperties` parameter. See examples in [read](https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-read). However, note that use
of reader properties is more common in message sources, such as the HTTP listener, as shown in the
[CSV reader example](#example_csv_reader).

It is also possible to use a Mule variable as a value of a configuration property. For more complete
examples, see
[Set Reader and Writer Configuration Properties](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-set-reader-writer-props).

## Setting MIME Types

You can specify the MIME type for the input and output data that flows through a Mule app.

For DataWeave transformations, you can specify the MIME type for the output data. For example, you
might set the `output` header directive of an expression in the Transform Message component or a
Write operation to `output application/json` or `output application/csv`.

This example sets the MIME type through a File Write operation to ensure that a format-specific
writer, the CSV writer, outputs the payload in CSV format:

Example: MIME Type for the CSV Writer

```xml
<file:write doc:name="Write" config-ref="File_Config" path="my_transform">
  <file:content ><![CDATA[#[output application/csv --- payload]]]></file:content>
</file:write>
```

Starting in Mule 4.3.0, you can set the `output` directive using the format ID alone, instead of
using the MIME type. For example, you might set the `output` header directive of an expression in
the Transform Message component or a Write operation to `output json` or `output csv`. You can also
use the format ID to differentiate the format of the output data from the MIME type in the output
header, and you can use a custom MIME type. For example, you can write JSON data but customize the
MIME type to `application/problem+json` by using the DataWeave directive
`output application/problem+json with json`. See
[Change a Script’s MIME Type Output](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-change-script-output-mime) for examples that
customize the MIME type output of a script.

The `with` keyword separates the output MIME type from the DataWeave writer for the script’s output.
For example, you can specify 'output applicatio:page-aliases:

For input data, format-specific readers for Mule sources (such as the On New File listener), Mule
operations (such as Read and HTTP Request operations), and DataWeave expressions attempt to infer
the MIME type from metadata that is associated with input payloads, attributes, and variables in the
Mule event. When the MIME type cannot be inferred from the metadata (and when that metadata is not
static), Mule sources and operations allow you to specify the MIME type for the reader. For example,
you might set the MIME type for the On New File listener to `outputMimeType='application/csv'` for
CSV file _input_. This setting provides information about the file format to the CSV reader.

Example: MIME Type for the CSV Reader

```xml
<file:listener doc:name="On New File"
  config-ref="File_Config"
  outputMimeType='application/csv'>
</file:listener>
```

Note that reader settings _are not_ used to perform a transformation from one format to another.
They simply help the reader interpret the format of the input.

You can also set special reader and writer properties for use by the format-specific reader or
writer of a source, operation, or component. See
[Using Reader and Writer Properties](#reader_writer_properties).

## See Also

[Transform Message Component](https://docs.mulesoft.com/studio/transform-message-component-concept-studio)

[Flat File Schemas](https://docs.mulesoft.com/dataweave/2.3/dataweave-flat-file-schemas)

<!-- document id=ebe1b100869285e95d82ecf46fceb0e2331ac8faa178aa11d7eb2acbf02b20a0 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-formats.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Supported Data Formats

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave can read and write many types of data formats, such as JSON, XML, and many others.

DataWeave supports the following formats as input and output:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>MIME Type</th><th>ID</th><th>Supported Formats</th></tr></thead><tbody><tr><td><p><code>application/avro</code></p></td><td><p><code>avro</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-formats-avro">Avro Format</a></p></td></tr><tr><td><p><code>application/csv</code></p></td><td><p><code>csv</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-formats-csv">CSV Format</a></p></td></tr><tr><td><p><code>application/dw</code></p></td><td><p><code>dw</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-formats-dw">DataWeave Format (dw)</a> for testing a DataWeave expression</p></td></tr><tr><td><p><code>application/flatfile</code></p></td><td><p><code>flatfile</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-formats-flatfile">Flat File Format</a>, <a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-formats-copybook">COBOL Copybook Format</a>, <a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-formats-fixedwidth">Fixed Width Format</a></p></td></tr><tr><td><p><code>application/java</code></p></td><td><p><code>java</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-formats-java">Java Format</a>, <a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-formats-java#format_enum">Enum Format for Java</a></p></td></tr><tr><td><p><code>application/json</code></p></td><td><p><code>json</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-formats-json">JSON Format</a></p></td></tr><tr><td><p><code>application/octet-stream</code></p></td><td><p><code>binary</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-formats-binary">Binary Format</a></p></td></tr><tr><td><p><code>application/xlsx</code></p></td><td><p><code>excel</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-formats-excel">Excel Format</a></p></td></tr><tr><td><p><code>application/xml</code></p></td><td><p><code>xml</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-formats-xml">XML Format</a>, <a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-formats-xml#format_xml_cdata">CData Custom Type</a></p></td></tr><tr><td><p><code>application/x-ndjson</code></p></td><td><p><code>ndjson</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-formats-ndjson">Newline Delimited JSON Format (ndjson)</a></p></td></tr><tr><td><p><code>application/x-www-form-urlencoded</code></p></td><td><p><code>urlencoded</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-formats-urlencoded">URL Encoded Format</a></p></td></tr><tr><td><p><code>application/yaml</code></p></td><td><p><code>yaml</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-formats-yaml">YAML Format</a></p></td></tr><tr><td><p><code>multipart/form-data</code></p></td><td><p><code>multipart</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-formats-multipart">Multipart Format</a></p></td></tr><tr><td><p><code>text/plain</code></p></td><td><p><code>text</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-formats-text">Text Plain Format</a></p></td></tr><tr><td><p><code>text/x-java-properties</code></p></td><td><p><code>properties</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-formats-properties">Text Java Properties</a></p></td></tr></tbody></table>

## DataWeave Readers

DataWeave can read input data as a whole by loading it into memory or by indexing it in local
storage and, for some data formats, DataWeave can read data sequentially in parts by streaming the
input. The indexed reading strategy implements a mechanism to avoid out-of-memory issues when
processing large files. The streaming strategy can improve performance but restricts file access to
sequential access (which disallows random access) because you can access only the part of the file
that is being read and stored in memory.

<table id="streaming"><colgroup><col> <col> <col></colgroup><thead><tr><th>Read Strategy</th><th>Description</th><th>Supported Formats</th></tr></thead><tbody><tr><td><div><div><p>In-Memory</p></div></div></td><td><div><div><p>This strategy parses the entire document and loads it into memory, enabling random access to data. When using this strategy, a DataWeave script can access any part of the resulting value at any time.</p></div></div></td><td><div><div><p>DataWeave can read all supported formats using this strategy.</p></div></div></td></tr><tr><td><div><div><p>Indexed</p></div></div></td><td><div><div><p>This strategy parses the entire document and uses disk space to avoid out-of-memory issues on large files, enabling random access to data. When using this strategy, a DataWeave script can access any part of the resulting value at any time.</p></div><div><p>When processing a <code>String</code> with a size larger than 1.5 MB, DataWeave automatically splits the value in chunks to avoid out-of-memory issues. This feature works only with <code>JSON</code> and <code>XML</code> input data.</p></div><div><p>For additional details, see <a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-indexed-readers">Indexed Readers in DataWeave</a></p></div></div></td><td><div><div><ul><li><p><code>CSV</code></p></li><li><p><code>JSON</code></p></li><li><p><code>XML</code></p></li></ul></div></div></td></tr><tr><td><div><div><p>Streaming</p></div></div></td><td><div><div><p>This strategy partitions the input document into smaller items and accesses the data sequentially, storing the current item in memory. A DataWeave selector can access only the portion of the file that is getting read.</p></div><div><p>For additional details, see <a href="https://docs.mulesoft.com/dataweave/2.4/dataweave-streaming">Streaming in DataWeave</a></p></div></div></td><td><div><div><ul><li><p><code>CSV</code></p></li><li><p><code>JSON</code></p></li><li><p><code>Excel</code> (XLSX)</p></li><li><p><code>XML</code></p></li></ul></div></div></td></tr></tbody></table>

## Using Reader and Writer Properties

In some cases, it is necessary to modify or specify aspects of the format through format-specific
properties. For example, you can specify CSV input and output properties, such as the `separator`
(or delimiter) to use in the CSV file. For Cobol copybook, you need to specify the path to a schema
file using the `schemaPath` property.

You can append reader properties to the MIME type (`outputMimeType`) attribute for certain
components in your Mule app. Listeners and Read operations accept these settings. For example, this
On New File listener example identifies the `,` separator for a CSV input file:

Example: Properties for the CSV Reader

```xml
<file:listener doc:name="On New File" config-ref="File_Config" outputMimeType='application/csv; separator=","'>
  <scheduling-strategy >
    <fixed-frequency frequency="45" timeUnit="SECONDS"/>
  </scheduling-strategy>
  <file:matcher filenamePattern="comma_separated.csv" />
</file:listener>
```

Note that the `outputMimeType` setting above helps the CSV _reader_ interpret the format and
delimiter of the input `comma_separated.csv` file, not the writer.

To specify the output format, you can provide the MIME type and any writer properties for the
writer, such as the CSV or JSON writer used by a File Write operation. For example, you might need
to write a pipe (`|`) delimiter in your CSV output payload, instead of some other delimiter used in
the input. To do this, you append the property and its value to the `output` directive of a
DataWeave expression. For example, this Write operation specifies the pipe as a `separator`:

Example: output Directive for the CSV Writer

```xml
<file:write doc:name="Write" config-ref="File_Config" path="my_transform">
  <file:content ><![CDATA[#[output application/csv separator="|" --- payload]]]></file:content>
</file:write>
```

The following example shows a DataWeave script in which the `output` directive specifies two writer
properties, one for the CSV field separator, another to indicate that there is no header.

```json
%dw 2.0
output application/csv separator=";", header=false
---
payload
```

Writer properties depend on the format. The following example uses the JSON writer property,
`skipNullOn`:

```json
%dw 2.0
output application/json skipNullOn="everywhere"
---
payload
```

The following example shows a DataWeave script that uses an invisible ASCII character as a separator
for the CSV output. The separator property value is `\u001E`. `\u` is the escape sequence
representation and `001E` is the hexadecimal representation of the record separator (RS) ASCII
character.

```DataWeave
%dw 2.0
output application/csv separator = "\u001E"
---
[
	{
		"Name" : "Tom",
		"UID" : 2569,
		"ShipOrderID" : "ui-288188"
	},
	{
		"Name" : "Alan",
		"UID" : 7756,
		"ShipOrderID" : "xj-232142"
	},
	{
		"Name" : "Dan",
		"UID" : 7821,
		"ShipOrderID" : "uk-259459"
	}
]
```

The CSV example produces the following output:

```csv
NameUIDShipOrderID
Tom2569ui-288188
Alan7756xj-232142
Dan7821uk-259459
```

Scripts that use the `read` or `readUrl` methods can also specify reader properties through the
`readerProperties` parameter. See examples in [read](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-read). However, note that use
of reader properties is more common in message sources, such as the HTTP listener, as shown in the
[CSV reader example](#example_csv_reader).

It is also possible to use a Mule variable as a value of a configuration property. For more complete
examples, see
[Set Reader and Writer Configuration Properties](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-set-reader-writer-props).

## Setting MIME Types

You can specify the MIME type for the input and output data that flows through a Mule app.

For DataWeave transformations, you can specify the MIME type for the output data. For example, you
might set the `output` header directive of an expression in the Transform Message component or a
Write operation to `output application/json` or `output application/csv`.

This example sets the MIME type through a File Write operation to ensure that a format-specific
writer, the CSV writer, outputs the payload in CSV format:

Example: MIME Type for the CSV Writer

```xml
<file:write doc:name="Write" config-ref="File_Config" path="my_transform">
  <file:content ><![CDATA[#[output application/csv --- payload]]]></file:content>
</file:write>
```

Starting in Mule 4.3.0, you can set the `output` directive using the format ID alone, instead of
using the MIME type. For example, you might set the `output` header directive of an expression in
the Transform Message component or a Write operation to `output json` or `output csv`. You can also
use the format ID to differentiate the format of the output data from the MIME type in the output
header, and you can use a custom MIME type. For example, you can write JSON data but customize the
MIME type to `application/problem+json` by using the DataWeave directive
`output application/problem+json with json`. See
[Change a Script’s MIME Type Output](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-change-script-output-mime) for examples that
customize the MIME type output of a script.

The `with` keyword separates the output MIME type from the DataWeave writer for the script’s output.
For example, you can specify 'output application/csv with binary' to output the `application/csv`
MIME type when using the `binary` writer. This setting is necessary in cases shown in
[Use Dynamic Writer Properties](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-writer-prop-mule) and
[Use Reader and Writer Properties in DataWeave Functions](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-set-reader-writer-props#use-reader-and-writer-properties-in-dataweave-functions).
It is also possible to append writer properties, such as in the use case
`output application/my-custom-type with json indent=false`.

For input data, format-specific readers for Mule sources (such as the On New File listener), Mule
operations (such as Read and HTTP Request operations), and DataWeave expressions attempt to infer
the MIME type from metadata that is associated with input payloads, attributes, and variables in the
Mule event. When the MIME type cannot be inferred from the metadata (and when that metadata is not
static), Mule sources and operations allow you to specify the MIME type for the reader. For example,
you might set the MIME type for the On New File listener to `outputMimeType='application/csv'` for
CSV file _input_. This setting provides information about the file format to the CSV reader.

Example: MIME Type for the CSV Reader

```xml
<file:listener doc:name="On New File"
  config-ref="File_Config"
  outputMimeType='application/csv'>
</file:listener>
```

Note that reader settings _are not_ used to perform a transformation from one format to another.
They simply help the reader interpret the format of the input.

You can also set special reader and writer properties for use by the format-specific reader or
writer of a source, operation, or component. See
[Using Reader and Writer Properties](#reader_writer_properties).

## See Also

[Transform Message Component](https://docs.mulesoft.com/studio/transform-message-component-concept-studio)

[Flat File Schemas](https://docs.mulesoft.com/dataweave/2.4/dataweave-flat-file-schemas)

<!-- document id=6d8eaf2ff97397d320c0ee55debeef84d7cff90c1c0fd9d532c92558da9b1ff6 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-formats.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Supported Data Formats

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave can read and write many types of data formats, such as JSON, XML, and many others.

DataWeave supports the following formats as input and output:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>MIME Type</th><th>ID</th><th>Supported Formats</th></tr></thead><tbody><tr><td><p><code>application/avro</code></p></td><td><p><code>avro</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-formats-avro">Avro Format</a></p></td></tr><tr><td><p><code>application/csv</code></p></td><td><p><code>csv</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-formats-csv">CSV Format</a></p></td></tr><tr><td><p><code>application/dw</code></p></td><td><p><code>dw</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-formats-dw">DataWeave Format (dw)</a> for testing a DataWeave expression</p></td></tr><tr><td><p><code>application/flatfile</code></p></td><td><p><code>flatfile</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-formats-flatfile">Flat File Format</a>, <a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-formats-copybook">COBOL Copybook Format</a>, <a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-formats-fixedwidth">Fixed Width Format</a></p></td></tr><tr><td><p><code>application/java</code></p></td><td><p><code>java</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-formats-java">Java Format</a>, <a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-formats-java#format_enum">Enum Format for Java</a></p></td></tr><tr><td><p><code>application/json</code></p></td><td><p><code>json</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-formats-json">JSON Format</a></p></td></tr><tr><td><p><code>application/octet-stream</code></p></td><td><p><code>binary</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-formats-binary">Binary Format</a></p></td></tr><tr><td><p><code>application/protobuf</code>, <code>application/x-protobuf</code></p></td><td><p><code>protobuf</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-formats-protobuf">Protobuf Format</a></p></td></tr><tr><td><p><code>application/xlsx</code></p></td><td><p><code>excel</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-formats-excel">Excel Format</a></p></td></tr><tr><td><p><code>application/xml</code></p></td><td><p><code>xml</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-formats-xml">XML Format</a>, <a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-formats-xml#format_xml_cdata">CData Custom Type</a></p></td></tr><tr><td><p><code>application/x-ndjson</code></p></td><td><p><code>ndjson</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-formats-ndjson">Newline Delimited JSON Format (ndjson)</a></p></td></tr><tr><td><p><code>application/x-www-form-urlencoded</code></p></td><td><p><code>urlencoded</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-formats-urlencoded">URL Encoded Format</a></p></td></tr><tr><td><p><code>application/yaml</code></p></td><td><p><code>yaml</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-formats-yaml">YAML Format</a></p></td></tr><tr><td><p><code>multipart/form-data</code></p></td><td><p><code>multipart</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-formats-multipart">Multipart Format</a></p></td></tr><tr><td><p><code>text/plain</code></p></td><td><p><code>text</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-formats-text">Text Plain Format</a></p></td></tr><tr><td><p><code>text/x-java-properties</code></p></td><td><p><code>properties</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-formats-properties">Text Java Properties</a></p></td></tr></tbody></table>

## DataWeave Readers

DataWeave can read input data as a whole by loading it into memory or by indexing it in local
storage and, for some data formats, DataWeave can read data sequentially in parts by streaming the
input. The indexed reading strategy implements a mechanism to avoid out-of-memory issues when
processing large files. The streaming strategy can improve performance but restricts file access to
sequential access (which disallows random access) because you can access only the part of the file
that is being read and stored in memory.

<table id="streaming"><colgroup><col> <col> <col></colgroup><thead><tr><th>Read Strategy</th><th>Description</th><th>Supported Formats</th></tr></thead><tbody><tr><td><div><div><p>In-Memory</p></div></div></td><td><div><div><p>This strategy parses the entire document and loads it into memory, enabling random access to data. When using this strategy, a DataWeave script can access any part of the resulting value at any time.</p></div></div></td><td><div><div><p>DataWeave can read all supported formats using this strategy.</p></div></div></td></tr><tr><td><div><div><p>Indexed</p></div></div></td><td><div><div><p>This strategy parses the entire document and uses disk space to avoid out-of-memory issues on large files, enabling random access to data. When using this strategy, a DataWeave script can access any part of the resulting value at any time.</p></div><div><p>When processing a <code>String</code> with a size larger than 1.5 MB, DataWeave automatically splits the value in chunks to avoid out-of-memory issues. This feature works only with <code>JSON</code> and <code>XML</code> input data.</p></div><div><p>For additional details, see <a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-indexed-readers">Indexed Readers in DataWeave</a></p></div></div></td><td><div><div><ul><li><p><code>CSV</code></p></li><li><p><code>JSON</code></p></li><li><p><code>XML</code></p></li></ul></div></div></td></tr><tr><td><div><div><p>Streaming</p></div></div></td><td><div><div><p>This strategy partitions the input document into smaller items and accesses the data sequentially, storing the current item in memory. A DataWeave selector can access only the portion of the file that is getting read.</p></div><div><p>For additional details, see <a href="https://docs.mulesoft.com/dataweave/2.6/dataweave-streaming">Streaming in DataWeave</a></p></div></div></td><td><div><div><ul><li><p><code>CSV</code></p></li><li><p><code>JSON</code></p></li><li><p><code>Excel</code> (XLSX)</p></li><li><p><code>XML</code></p></li></ul></div></div></td></tr></tbody></table>

## Using Reader and Writer Properties

In some cases, it is necessary to modify or specify aspects of the format through format-specific
properties. For example, you can specify CSV input and output properties, such as the `separator`
(or delimiter) to use in the CSV file. For Cobol copybook, you need to specify the path to a schema
file using the `schemaPath` property.

You can append reader properties to the MIME type (`outputMimeType`) attribute for certain
components in your Mule app. Listeners and Read operations accept these settings. For example, this
On New File listener example identifies the `,` separator for a CSV input file:

Example: Properties for the CSV Reader

```xml
<file:listener doc:name="On New File" config-ref="File_Config" outputMimeType='application/csv; separator=","'>
  <scheduling-strategy >
    <fixed-frequency frequency="45" timeUnit="SECONDS"/>
  </scheduling-strategy>
  <file:matcher filenamePattern="comma_separated.csv" />
</file:listener>
```

Note that the `outputMimeType` setting above helps the CSV _reader_ interpret the format and
delimiter of the input `comma_separated.csv` file, not the writer.

To specify the output format, you can provide the MIME type and any writer properties for the
writer, such as the CSV or JSON writer used by a File Write operation. For example, you might need
to write a pipe (`|`) delimiter in your CSV output payload, instead of some other delimiter used in
the input. To do this, you append the property and its value to the `output` directive of a
DataWeave expression. For example, this Write operation specifies the pipe as a `separator`:

Example: output Directive for the CSV Writer

```xml
<file:write doc:name="Write" config-ref="File_Config" path="my_transform">
  <file:content ><![CDATA[#[output application/csv separator="|" --- payload]]]></file:content>
</file:write>
```

The following example shows a DataWeave script in which the `output` directive specifies two writer
properties, one for the CSV field separator, another to indicate that there is no header.

```json
%dw 2.0
output application/csv separator=";", header=false
---
payload
```

Writer properties depend on the format. The following example uses the JSON writer property,
`skipNullOn`:

```json
%dw 2.0
output application/json skipNullOn="everywhere"
---
payload
```

The following example shows a DataWeave script that uses an invisible ASCII character as a separator
for the CSV output. The separator property value is `\u001E`. `\u` is the escape sequence
representation and `001E` is the hexadecimal representation of the record separator (RS) ASCII
character.

```DataWeave
%dw 2.0
output application/csv separator = "\u001E"
---
[
	{
		"Name" : "Tom",
		"UID" : 2569,
		"ShipOrderID" : "ui-288188"
	},
	{
		"Name" : "Alan",
		"UID" : 7756,
		"ShipOrderID" : "xj-232142"
	},
	{
		"Name" : "Dan",
		"UID" : 7821,
		"ShipOrderID" : "uk-259459"
	}
]
```

The CSV example produces the following output:

```csv
NameUIDShipOrderID
Tom2569ui-288188
Alan7756xj-232142
Dan7821uk-259459
```

Scripts that use the `read` or `readUrl` methods can also specify reader properties through the
`readerProperties` parameter. See examples in [read](https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-read). However, note that use
of reader properties is more common in message sources, such as the HTTP listener, as shown in the
[CSV reader example](#example_csv_reader).

It is also possible to use a Mule variable as a value of a configuration property. For more complete
examples, see
[Set Reader and Writer Configuration Properties](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-set-reader-writer-props).

## Setting MIME Types

You can specify the MIME type for the input and output data that flows through a Mule app.

For DataWeave transformations, you can specify the MIME type for the output data. For example, you
might set the `output` header directive of an expression in the Transform Message component or a
Write operation to `output application/json` or `output application/csv`.

This example sets the MIME type through a File Write operation to ensure that a format-specific
writer, the CSV writer, outputs the payload in CSV format:

Example: MIME Type for the CSV Writer

```xml
<file:write doc:name="Write" config-ref="File_Config" path="my_transform">
  <file:content ><![CDATA[#[output application/csv --- payload]]]></file:content>
</file:write>
```

Starting in Mule 4.3.0, you can set the `output` directive using the format ID alone, instead of
using the MIME type. For example, you might set the `output` header directive of an expression in
the Transform Message component or a Write operation to `output json` or `output csv`. You can also
use the format ID to differentiate the format of the output data from the MIME type in the output
header, and you can use a custom MIME type. For example, you can write JSON data but customize the
MIME type to `application/problem+json` by using the DataWeave directive
`output application/problem+json with json`. See
[Change a Script’s MIME Type Output](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-change-script-output-mime) for examples that
customize the MIME type output of a script.

The `with` keyword separates the output MIME type from the DataWeave writer for the script’s output.
For example, you can specify 'output application/csv with binary' to output the `application/csv`
MIME type when using the `binary` writer. This setting is necessary in cases shown in
[Use Dynamic Writer Properties](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-writer-prop-mule) and
[Use Reader and Writer Properties in DataWeave Functions](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-set-reader-writer-props#use-reader-and-writer-properties-in-dataweave-functions).
It is also possible to append writer properties, such as in the use case
`output application/my-custom-type with json indent=false`.

For input data, format-specific readers for Mule sources (such as the On New File listener), Mule
operations (such as Read and HTTP Request operations), and DataWeave expressions attempt to infer
the MIME type from metadata that is associated with input payloads, attributes, and variables in the
Mule event. When the MIME type cannot be inferred from the metadata (and when that metadata is not
static), Mule sources and operations allow you to specify the MIME type for the reader. For example,
you might set the MIME type for the On New File listener to `outputMimeType='application/csv'` for
CSV file _input_. This setting provides information about the file format to the CSV reader.

Example: MIME Type for the CSV Reader

```xml
<file:listener doc:name="On New File"
  config-ref="File_Config"
  outputMimeType='application/csv'>
</file:listener>
```

Note that reader settings _are not_ used to perform a transformation from one format to another.
They simply help the reader interpret the format of the input.

You can also set special reader and writer properties for use by the format-specific reader or
writer of a source, operation, or component. See
[Using Reader and Writer Properties](#reader_writer_properties).

## See Also

[Transform Message Component](https://docs.mulesoft.com/studio/transform-message-component-concept-studio)

[Flat File Schemas](https://docs.mulesoft.com/dataweave/2.6/dataweave-flat-file-schemas)

<!-- document id=af2f66631ec49d09546c7a1c5909abf145121b39b9244e4586cb61a2b207026c url=/mulesoft/current/en-us/dataweave/2.9/dataweave-formats.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Supported Data Formats

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave can read and write many types of data formats, such as JSON, XML, and many others.

DataWeave supports the following formats as input and output:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>MIME Type</th><th>ID</th><th>Supported Formats</th></tr></thead><tbody><tr><td><p><code>application/avro</code></p></td><td><p><code>avro</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-formats-avro">Avro Format</a></p></td></tr><tr><td><p><code>application/csv</code></p></td><td><p><code>csv</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-formats-csv">CSV Format</a></p></td></tr><tr><td><p><code>application/dw</code></p></td><td><p><code>dw</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-formats-dw">DataWeave Format (dw)</a> for testing a DataWeave expression</p></td></tr><tr><td><p><code>application/flatfile</code></p></td><td><p><code>flatfile</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-formats-flatfile">Flat File Format</a>, <a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-formats-copybook">COBOL Copybook Format</a>, <a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-formats-fixedwidth">Fixed Width Format</a></p></td></tr><tr><td><p><code>application/java</code></p></td><td><p><code>java</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-formats-java">Java Format</a>, <a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-formats-java#format_enum">Enum Format for Java</a></p></td></tr><tr><td><p><code>application/json</code></p></td><td><p><code>json</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-formats-json">JSON Format</a></p></td></tr><tr><td><p><code>application/octet-stream</code></p></td><td><p><code>binary</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-formats-binary">Binary Format</a></p></td></tr><tr><td><p><code>application/protobuf</code>, <code>application/x-protobuf</code></p></td><td><p><code>protobuf</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-formats-protobuf">Protobuf Format</a></p></td></tr><tr><td><p><code>application/xlsx</code></p></td><td><p><code>excel</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-formats-excel">Excel Format</a></p></td></tr><tr><td><p><code>application/xml</code></p></td><td><p><code>xml</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-formats-xml">XML Format</a>, <a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-formats-xml#format_xml_cdata">CData Custom Type</a></p></td></tr><tr><td><p><code>application/x-ndjson</code></p></td><td><p><code>ndjson</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-formats-ndjson">Newline Delimited JSON Format (ndjson)</a></p></td></tr><tr><td><p><code>application/x-www-form-urlencoded</code></p></td><td><p><code>urlencoded</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-formats-urlencoded">URL Encoded Format</a></p></td></tr><tr><td><p><code>application/yaml</code></p></td><td><p><code>yaml</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-formats-yaml">YAML Format</a></p></td></tr><tr><td><p><code>multipart/form-data</code></p></td><td><p><code>multipart</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-formats-multipart">Multipart Format</a></p></td></tr><tr><td><p><code>text/plain</code></p></td><td><p><code>text</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-formats-text">Text Plain Format</a></p></td></tr><tr><td><p><code>text/x-java-properties</code></p></td><td><p><code>properties</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-formats-properties">Text Java Properties</a></p></td></tr></tbody></table>

## DataWeave Readers

DataWeave can read input data as a whole by loading it into memory or by indexing it in local
storage and, for some data formats, DataWeave can read data sequentially in parts by streaming the
input. The indexed reading strategy implements a mechanism to avoid out-of-memory issues when
processing large files. The streaming strategy can improve performance but restricts file access to
sequential access (which disallows random access) because you can access only the part of the file
that is being read and stored in memory.

<table id="streaming"><colgroup><col> <col> <col></colgroup><thead><tr><th>Read Strategy</th><th>Description</th><th>Supported Formats</th></tr></thead><tbody><tr><td><div><div><p>In-Memory</p></div></div></td><td><div><div><p>This strategy parses the entire document and loads it into memory, enabling random access to data. When using this strategy, a DataWeave script can access any part of the resulting value at any time.</p></div></div></td><td><div><div><p>DataWeave can read all supported formats using this strategy.</p></div></div></td></tr><tr><td><div><div><p>Indexed</p></div></div></td><td><div><div><p>This strategy parses the entire document and uses disk space to avoid out-of-memory issues on large files, enabling random access to data. When using this strategy, a DataWeave script can access any part of the resulting value at any time.</p></div><div><p>When processing a <code>String</code> with a size larger than 1.5 MB, DataWeave automatically splits the value in chunks to avoid out-of-memory issues. This feature works only with <code>JSON</code> and <code>XML</code> input data.</p></div><div><p>For additional details, see <a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-indexed-readers">Indexed Readers in DataWeave</a></p></div></div></td><td><div><div><ul><li><p><code>CSV</code></p></li><li><p><code>JSON</code></p></li><li><p><code>XML</code></p></li></ul></div></div></td></tr><tr><td><div><div><p>Streaming</p></div></div></td><td><div><div><p>This strategy partitions the input document into smaller items and accesses the data sequentially, storing the current item in memory. A DataWeave selector can access only the portion of the file that is getting read.</p></div><div><p>For additional details, see <a href="https://docs.mulesoft.com/dataweave/2.9/dataweave-streaming">Streaming in DataWeave</a></p></div></div></td><td><div><div><ul><li><p><code>CSV</code></p></li><li><p><code>JSON</code></p></li><li><p><code>Excel</code> (XLSX)</p></li><li><p><code>XML</code></p></li></ul></div></div></td></tr></tbody></table>

## Using Reader and Writer Properties

In some cases, it is necessary to modify or specify aspects of the format through format-specific
properties. For example, you can specify CSV input and output properties, such as the `separator`
(or delimiter) to use in the CSV file. For Cobol copybook, you need to specify the path to a schema
file using the `schemaPath` property.

You can append reader properties to the MIME type (`outputMimeType`) attribute for certain
components in your Mule app. Listeners and Read operations accept these settings. For example, this
On New File listener example identifies the `,` separator for a CSV input file:

Example: Properties for the CSV Reader

```xml
<file:listener doc:name="On New File" config-ref="File_Config" outputMimeType='application/csv; separator=","'>
  <scheduling-strategy >
    <fixed-frequency frequency="45" timeUnit="SECONDS"/>
  </scheduling-strategy>
  <file:matcher filenamePattern="comma_separated.csv" />
</file:listener>
```

Note that the `outputMimeType` setting above helps the CSV _reader_ interpret the format and
delimiter of the input `comma_separated.csv` file, not the writer.

To specify the output format, you can provide the MIME type and any writer properties for the
writer, such as the CSV or JSON writer used by a File Write operation. For example, you might need
to write a pipe (`|`) delimiter in your CSV output payload, instead of some other delimiter used in
the input. To do this, you append the property and its value to the `output` directive of a
DataWeave expression. For example, this Write operation specifies the pipe as a `separator`:

Example: output Directive for the CSV Writer

```xml
<file:write doc:name="Write" config-ref="File_Config" path="my_transform">
  <file:content ><![CDATA[#[output application/csv separator="|" --- payload]]]></file:content>
</file:write>
```

The following example shows a DataWeave script in which the `output` directive specifies two writer
properties, one for the CSV field separator, another to indicate that there is no header.

```json
%dw 2.0
output application/csv separator=";", header=false
---
payload
```

Writer properties depend on the format. The following example uses the JSON writer property,
`skipNullOn`:

```json
%dw 2.0
output application/json skipNullOn="everywhere"
---
payload
```

The following example shows a DataWeave script that uses an invisible ASCII character as a separator
for the CSV output. The separator property value is `\u001E`. `\u` is the escape sequence
representation and `001E` is the hexadecimal representation of the record separator (RS) ASCII
character.

```DataWeave
%dw 2.0
output application/csv separator = "\u001E"
---
[
	{
		"Name" : "Tom",
		"UID" : 2569,
		"ShipOrderID" : "ui-288188"
	},
	{
		"Name" : "Alan",
		"UID" : 7756,
		"ShipOrderID" : "xj-232142"
	},
	{
		"Name" : "Dan",
		"UID" : 7821,
		"ShipOrderID" : "uk-259459"
	}
]
```

The CSV example produces the following output:

```csv
NameUIDShipOrderID
Tom2569ui-288188
Alan7756xj-232142
Dan7821uk-259459
```

Scripts that use the `read` or `readUrl` methods can also specify reader properties through the
`readerProperties` parameter. See examples in [read](https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-read). However, note that use
of reader properties is more common in message sources, such as the HTTP listener, as shown in the
[CSV reader example](#example_csv_reader).

It is also possible to use a Mule variable as a value of a configuration property. For more complete
examples, see
[Set Reader and Writer Configuration Properties](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-set-reader-writer-props).

## Setting MIME Types

You can specify the MIME type for the input and output data that flows through a Mule app.

For DataWeave transformations, you can specify the MIME type for the output data. For example, you
might set the `output` header directive of an expression in the Transform Message component or a
Write operation to `output application/json` or `output application/csv`.

This example sets the MIME type through a File Write operation to ensure that a format-specific
writer, the CSV writer, outputs the payload in CSV format:

Example: MIME Type for the CSV Writer

```xml
<file:write doc:name="Write" config-ref="File_Config" path="my_transform">
  <file:content ><![CDATA[#[output application/csv --- payload]]]></file:content>
</file:write>
```

Starting in Mule 4.3.0, you can set the `output` directive using the format ID alone, instead of
using the MIME type. For example, you might set the `output` header directive of an expression in
the Transform Message component or a Write operation to `output json` or `output csv`. You can also
use the format ID to differentiate the format of the output data from the MIME type in the output
header, and you can use a custom MIME type. For example, you can write JSON data but customize the
MIME type to `application/problem+json` by using the DataWeave directive
`output application/problem+json with json`. See
[Change a Script’s MIME Type Output](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-change-script-output-mime) for examples that
customize the MIME type output of a script.

The `with` keyword separates the output MIME type from the DataWeave writer for the script’s output.
For example, you can specify 'output application/csv with binary' to output the `application/csv`
MIME type when using the `binary` writer. This setting is necessary in cases shown in
[Use Dynamic Writer Properties](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-writer-prop-mule) and
[Use Reader and Writer Properties in DataWeave Functions](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-set-reader-writer-props#use-reader-and-writer-properties-in-dataweave-functions).
It is also possible to append writer properties, such as in the use case
`output application/my-custom-type with json indent=false`.

For input data, format-specific readers for Mule sources (such as the On New File listener), Mule
operations (such as Read and HTTP Request operations), and DataWeave expressions attempt to infer
the MIME type from metadata that is associated with input payloads, attributes, and variables in the
Mule event. When the MIME type cannot be inferred from the metadata (and when that metadata is not
static), Mule sources and operations allow you to specify the MIME type for the reader. For example,
you might set the MIME type for the On New File listener to `outputMimeType='application/csv'` for
CSV file _input_. This setting provides information about the file format to the CSV reader.

Example: MIME Type for the CSV Reader

```xml
<file:listener doc:name="On New File"
  config-ref="File_Config"
  outputMimeType='application/csv'>
</file:listener>
```

Note that reader settings _are not_ used to perform a transformation from one format to another.
They simply help the reader interpret the format of the input.

You can also set special reader and writer properties for use by the format-specific reader or
writer of a source, operation, or component. See
[Using Reader and Writer Properties](#reader_writer_properties).

## See Also

[Transform Message Component](https://docs.mulesoft.com/studio/transform-message-component-concept-studio)

[Flat File Schemas](https://docs.mulesoft.com/dataweave/2.9/dataweave-flat-file-schemas)

<!-- document id=13a22250606a5751aeff4094bd7ab93b824bcff57c6ff5e46c1993b2d1c11016 url=/mulesoft/current/en-us/dataweave/latest/dataweave-formats.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Supported Data Formats

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave can read and write many types of data formats, such as JSON, XML, and many others.

DataWeave supports the following formats as input and output:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>MIME Type</th><th>ID</th><th>Supported Formats</th></tr></thead><tbody><tr><td><p><code>application/avro</code></p></td><td><p><code>avro</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats-avro">Avro Format</a></p></td></tr><tr><td><p><code>application/csv</code></p></td><td><p><code>csv</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats-csv">CSV Format</a></p></td></tr><tr><td><p><code>application/dw</code></p></td><td><p><code>dw</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats-dw">DataWeave Format (dw)</a> for testing a DataWeave expression</p></td></tr><tr><td><p><code>application/flatfile</code></p></td><td><p><code>flatfile</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats-flatfile">Flat File Format</a>, <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats-copybook">COBOL Copybook Format</a>, <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats-fixedwidth">Fixed Width Format</a></p></td></tr><tr><td><p><code>application/java</code></p></td><td><p><code>java</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats-java">Java Format</a>, <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats-java#format_enum">Enum Format for Java</a></p></td></tr><tr><td><p><code>application/json</code></p></td><td><p><code>json</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats-json">JSON Format</a></p></td></tr><tr><td><p><code>application/octet-stream</code></p></td><td><p><code>binary</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats-binary">Binary Format</a></p></td></tr><tr><td><p><code>application/protobuf</code>, <code>application/x-protobuf</code></p></td><td><p><code>protobuf</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats-protobuf">Protobuf Format</a></p></td></tr><tr><td><p><code>application/xlsx</code></p></td><td><p><code>excel</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats-excel">Excel Format</a></p></td></tr><tr><td><p><code>application/xml</code></p></td><td><p><code>xml</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats-xml">XML Format</a>, <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats-xml#format_xml_cdata">CData Custom Type</a></p></td></tr><tr><td><p><code>application/x-ndjson</code></p></td><td><p><code>ndjson</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats-ndjson">Newline Delimited JSON Format (ndjson)</a></p></td></tr><tr><td><p><code>application/x-www-form-urlencoded</code></p></td><td><p><code>urlencoded</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats-urlencoded">URL Encoded Format</a></p></td></tr><tr><td><p><code>application/yaml</code></p></td><td><p><code>yaml</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats-yaml">YAML Format</a></p></td></tr><tr><td><p><code>multipart/form-data</code></p></td><td><p><code>multipart</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats-multipart">Multipart Format</a></p></td></tr><tr><td><p><code>text/plain</code></p></td><td><p><code>text</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats-text">Text Plain Format</a></p></td></tr><tr><td><p><code>text/x-java-properties</code></p></td><td><p><code>properties</code></p></td><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats-properties">Text Java Properties</a></p></td></tr></tbody></table>

## DataWeave Readers

DataWeave can read input data as a whole by loading it into memory or by indexing it in local
storage and, for some data formats, DataWeave can read data sequentially in parts by streaming the
input. The indexed reading strategy implements a mechanism to avoid out-of-memory issues when
processing large files. The streaming strategy can improve performance but restricts file access to
sequential access (which disallows random access) because you can access only the part of the file
that is being read and stored in memory.

<table id="streaming"><colgroup><col> <col> <col></colgroup><thead><tr><th>Read Strategy</th><th>Description</th><th>Supported Formats</th></tr></thead><tbody><tr><td><div><div><p>In-Memory</p></div></div></td><td><div><div><p>This strategy parses the entire document and loads it into memory, enabling random access to data. When using this strategy, a DataWeave script can access any part of the resulting value at any time.</p></div></div></td><td><div><div><p>DataWeave can read all supported formats using this strategy.</p></div></div></td></tr><tr><td><div><div><p>Indexed</p></div></div></td><td><div><div><p>This strategy parses the entire document and uses disk space to avoid out-of-memory issues on large files, enabling random access to data. When using this strategy, a DataWeave script can access any part of the resulting value at any time.</p></div><div><p>When processing a <code>String</code> with a size larger than 1.5 MB, DataWeave automatically splits the value in chunks to avoid out-of-memory issues. This feature works only with <code>JSON</code> and <code>XML</code> input data.</p></div><div><p>For additional details, see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-indexed-readers">Indexed Readers in DataWeave</a></p></div></div></td><td><div><div><ul><li><p><code>CSV</code></p></li><li><p><code>JSON</code></p></li><li><p><code>XML</code></p></li></ul></div></div></td></tr><tr><td><div><div><p>Streaming</p></div></div></td><td><div><div><p>This strategy partitions the input document into smaller items and accesses the data sequentially, storing the current item in memory. A DataWeave selector can access only the portion of the file that is getting read.</p></div><div><p>For additional details, see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-streaming">Streaming in DataWeave</a></p></div></div></td><td><div><div><ul><li><p><code>CSV</code></p></li><li><p><code>JSON</code></p></li><li><p><code>Excel</code> (XLSX)</p></li><li><p><code>XML</code></p></li></ul></div></div></td></tr></tbody></table>

## Using Reader and Writer Properties

In some cases, it is necessary to modify or specify aspects of the format through format-specific
properties. For example, you can specify CSV input and output properties, such as the `separator`
(or delimiter) to use in the CSV file. For Cobol copybook, you need to specify the path to a schema
file using the `schemaPath` property.

You can append reader properties to the MIME type (`outputMimeType`) attribute for certain
components in your Mule app. Listeners and Read operations accept these settings. For example, this
On New File listener example identifies the `,` separator for a CSV input file:

Example: Properties for the CSV Reader

```xml
<file:listener doc:name="On New File" config-ref="File_Config" outputMimeType='application/csv; separator=","'>
  <scheduling-strategy >
    <fixed-frequency frequency="45" timeUnit="SECONDS"/>
  </scheduling-strategy>
  <file:matcher filenamePattern="comma_separated.csv" />
</file:listener>
```

Note that the `outputMimeType` setting above helps the CSV _reader_ interpret the format and
delimiter of the input `comma_separated.csv` file, not the writer.

To specify the output format, you can provide the MIME type and any writer properties for the
writer, such as the CSV or JSON writer used by a File Write operation. For example, you might need
to write a pipe (`|`) delimiter in your CSV output payload, instead of some other delimiter used in
the input. To do this, you append the property and its value to the `output` directive of a
DataWeave expression. For example, this Write operation specifies the pipe as a `separator`:

Example: output Directive for the CSV Writer

```xml
<file:write doc:name="Write" config-ref="File_Config" path="my_transform">
  <file:content ><![CDATA[#[output application/csv separator="|" --- payload]]]></file:content>
</file:write>
```

The following example shows a DataWeave script in which the `output` directive specifies two writer
properties, one for the CSV field separator, another to indicate that there is no header.

```json
%dw 2.0
output application/csv separator=";", header=false
---
payload
```

Writer properties depend on the format. The following example uses the JSON writer property,
`skipNullOn`:

```json
%dw 2.0
output application/json skipNullOn="everywhere"
---
payload
```

The following example shows a DataWeave script that uses an invisible ASCII character as a separator
for the CSV output. The separator property value is `\u001E`. `\u` is the escape sequence
representation and `001E` is the hexadecimal representation of the record separator (RS) ASCII
character.

```DataWeave
%dw 2.0
output application/csv separator = "\u001E"
---
[
	{
		"Name" : "Tom",
		"UID" : 2569,
		"ShipOrderID" : "ui-288188"
	},
	{
		"Name" : "Alan",
		"UID" : 7756,
		"ShipOrderID" : "xj-232142"
	},
	{
		"Name" : "Dan",
		"UID" : 7821,
		"ShipOrderID" : "uk-259459"
	}
]
```

The CSV example produces the following output:

```csv
NameUIDShipOrderID
Tom2569ui-288188
Alan7756xj-232142
Dan7821uk-259459
```

Scripts that use the `read` or `readUrl` methods can also specify reader properties through the
`readerProperties` parameter. See examples in [read](https://docs.mulesoft.com/dataweave/latest/dw-core-functions-read). However, note that use
of reader properties is more common in message sources, such as the HTTP listener, as shown in the
[CSV reader example](#example_csv_reader).

It is also possible to use a Mule variable as a value of a configuration property. For more complete
examples, see
[Set Reader and Writer Configuration Properties](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-set-reader-writer-props).

## Setting MIME Types

You can specify the MIME type for the input and output data that flows through a Mule app.

For DataWeave transformations, you can specify the MIME type for the output data. For example, you
might set the `output` header directive of an expression in the Transform Message component or a
Write operation to `output application/json` or `output application/csv`.

This example sets the MIME type through a File Write operation to ensure that a format-specific
writer, the CSV writer, outputs the payload in CSV format:

Example: MIME Type for the CSV Writer

```xml
<file:write doc:name="Write" config-ref="File_Config" path="my_transform">
  <file:content ><![CDATA[#[output application/csv --- payload]]]></file:content>
</file:write>
```

Starting in Mule 4.3.0, you can set the `output` directive using the format ID alone, instead of
using the MIME type. For example, you might set the `output` header directive of an expression in
the Transform Message component or a Write operation to `output json` or `output csv`. You can also
use the format ID to differentiate the format of the output data from the MIME type in the output
header, and you can use a custom MIME type. For example, you can write JSON data but customize the
MIME type to `application/problem+json` by using the DataWeave directive
`output application/problem+json with json`. See
[Change a Script’s MIME Type Output](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-change-script-output-mime) for examples that
customize the MIME type output of a script.

The `with` keyword separates the output MIME type from the DataWeave writer for the script’s output.
For example, you can specify 'output application/csv with binary' to output the `application/csv`
MIME type when using the `binary` writer. This setting is necessary in cases shown in
[Use Dynamic Writer Properties](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-writer-prop-mule) and
[Use Reader and Writer Properties in DataWeave Functions](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-set-reader-writer-props#use-reader-and-writer-properties-in-dataweave-functions).
It is also possible to append writer properties, such as in the use case
`output application/my-custom-type with json indent=false`.

For input data, format-specific readers for Mule sources (such as the On New File listener), Mule
operations (such as Read and HTTP Request operations), and DataWeave expressions attempt to infer
the MIME type from metadata that is associated with input payloads, attributes, and variables in the
Mule event. When the MIME type cannot be inferred from the metadata (and when that metadata is not
static), Mule sources and operations allow you to specify the MIME type for the reader. For example,
you might set the MIME type for the On New File listener to `outputMimeType='application/csv'` for
CSV file _input_. This setting provides information about the file format to the CSV reader.

Example: MIME Type for the CSV Reader

```xml
<file:listener doc:name="On New File"
  config-ref="File_Config"
  outputMimeType='application/csv'>
</file:listener>
```

Note that reader settings _are not_ used to perform a transformation from one format to another.
They simply help the reader interpret the format of the input.

You can also set special reader and writer properties for use by the format-specific reader or
writer of a source, operation, or component. See
[Using Reader and Writer Properties](#reader_writer_properties).

## See Also

[Transform Message Component](https://docs.mulesoft.com/studio/transform-message-component-concept-studio)

[Flat File Schemas](https://docs.mulesoft.com/dataweave/latest/dataweave-flat-file-schemas)

<!-- document id=c3f093323c8c5aa1d71d606820388dee56a867e7843e50c155aafe7988826818 url=/mulesoft/current/en-us/dataweave/2.11/dw-system.md -->

---
product: DataWeave
version: 2.11
---

# System (dw::System)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains functions that allow you to interact with the underlying system.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::System` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-system-functions-envvar">envVar</a></p></td><td><p>Returns an environment variable with the specified name or <code>null</code> if the environment variable is not defined.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-system-functions-envvars">envVars</a></p></td><td><p>Returns all the environment variables defined in the host system as an array of strings.</p></td></tr></tbody></table>

<!-- document id=1029511bd853ae6d1b3a0c23313ce1066976043e3479cd5f05194e5d41b8ba37 url=/mulesoft/current/en-us/dataweave/2.12/dw-system.md -->

---
product: DataWeave
version: 2.12
---

# System (dw::System)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains functions that allow you to interact with the underlying system.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::System` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-system-functions-envvar">envVar</a></p></td><td><p>Returns an environment variable with the specified name or <code>null</code> if the environment variable is not defined.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-system-functions-envvars">envVars</a></p></td><td><p>Returns all the environment variables defined in the host system as an array of strings.</p></td></tr></tbody></table>

<!-- document id=b867b6faf5dde27cc133e7db9b9246a5dac24447014c29c117583475776795b7 url=/mulesoft/current/en-us/dataweave/2.3/dw-system.md -->

---
product: DataWeave
version: 2.3
---

# System (dw::System)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains functions that allow you to interact with the underlying system.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::System` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-system-functions-envvar">envVar</a></p></td><td><p>Returns an environment variable with the specified name or <code>null</code> if the environment variable is not defined.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-system-functions-envvars">envVars</a></p></td><td><p>Returns all of the environment variables defined in the host system.</p></td></tr></tbody></table>

<!-- document id=9ac95bb5b267a92e14d075eb5abb35d766c6f2739856c5b33877128d31c62ea3 url=/mulesoft/current/en-us/dataweave/2.4/dw-system.md -->

---
product: DataWeave
version: 2.4
---

# System (dw::System)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains functions that allow you to interact with the underlying system.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::System` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-system-functions-envvar">envVar</a></p></td><td><p>Returns an environment variable with the specified name or <code>null</code> if the environment variable is not defined.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-system-functions-envvars">envVars</a></p></td><td><p>Returns all the environment variables defined in the host system as an array of strings.</p></td></tr></tbody></table>

<!-- document id=d86a43671f36027a1932aabe7ef479a06c96a85e7937838f2844e89ce1d64c48 url=/mulesoft/current/en-us/dataweave/2.6/dw-system.md -->

---
product: DataWeave
version: 2.6
---

# System (dw::System)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains functions that allow you to interact with the underlying system.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::System` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-system-functions-envvar">envVar</a></p></td><td><p>Returns an environment variable with the specified name or <code>null</code> if the environment variable is not defined.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-system-functions-envvars">envVars</a></p></td><td><p>Returns all the environment variables defined in the host system as an array of strings.</p></td></tr></tbody></table>

<!-- document id=451b1b6c34e4a3ba8fdffac5e934eea4b76a2d8f8c61e007aff85c4b247de6ab url=/mulesoft/current/en-us/dataweave/2.9/dw-system.md -->

---
product: DataWeave
version: 2.9
---

# System (dw::System)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains functions that allow you to interact with the underlying system.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::System` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-system-functions-envvar">envVar</a></p></td><td><p>Returns an environment variable with the specified name or <code>null</code> if the environment variable is not defined.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-system-functions-envvars">envVars</a></p></td><td><p>Returns all the environment variables defined in the host system as an array of strings.</p></td></tr></tbody></table>

<!-- document id=283c5f9e2268a5c3a36160b0fed4bce9be12f8af7e26369e74ae7c7a7188d9c2 url=/mulesoft/current/en-us/dataweave/latest/dw-system.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# System (dw::System)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains functions that allow you to interact with the underlying system.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::System` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-system-functions-envvar">envVar</a></p></td><td><p>Returns an environment variable with the specified name or <code>null</code> if the environment variable is not defined.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-system-functions-envvars">envVars</a></p></td><td><p>Returns all the environment variables defined in the host system as an array of strings.</p></td></tr></tbody></table>

<!-- document id=0d50ddb34fc26a6795102ba57efdd5f43a5b356c1f846a577885810d5022a2e5 url=/mulesoft/current/en-us/dataweave/2.11/dw-arrays-functions-take.md -->

---
product: DataWeave
version: 2.11
---

# take

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## take<T>(array: Array<T>, n: Number): Array<T>

Selects the first `n` elements. It returns an empty array when `n <= 0` and the original array when
`n > sizeOf(array)`.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>n</code></p></td><td><p>The number of elements to select.</p></td></tr></tbody></table>

### Example

This example outputs an array that contains the values of first two elements of the input array.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
var users = ["Mariano", "Leandro", "Julian"]
output application/json
---
take(users, 2)
```

#### Output

```json
["Mariano", "Leandro"]
```

## take(array: Null, n: Any): Null

Helper function that enables `take` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=2ee00d15b8cfe287873b9d865a29049fed9fc40bd266c27aa98e8fee43a126bd url=/mulesoft/current/en-us/dataweave/2.12/dw-arrays-functions-take.md -->

---
product: DataWeave
version: 2.12
---

# take

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## take<T>(array: Array<T>, n: Number): Array<T>

Selects the first `n` elements. It returns an empty array when `n <= 0` and the original array when
`n > sizeOf(array)`.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>n</code></p></td><td><p>The number of elements to select.</p></td></tr></tbody></table>

### Example

This example outputs an array that contains the values of first two elements of the input array.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
var users = ["Mariano", "Leandro", "Julian"]
output application/json
---
take(users, 2)
```

#### Output

```json
["Mariano", "Leandro"]
```

## take(array: Null, n: Any): Null

Helper function that enables `take` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=a4ccfc69e3f9a9fdf28a7dbcc60f15ea794c8756e974a12fa6f77adb61d264a2 url=/mulesoft/current/en-us/dataweave/2.3/dw-arrays-functions-take.md -->

---
product: DataWeave
version: 2.3
---

# take

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## take(Array<T>, Number): Array<T>

Selects the first `n` elements. It returns an empty array when `n <= 0` and the original array when
`n > sizeOf(array)`.

_Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>n</code></p></td><td><p>The number of elements to select.</p></td></tr></tbody></table>

### Example

This example outputs an array that contains the values of first two elements of the input array.

#### Source

```DataWeave
 %dw 2.0
 import * from dw::core::Arrays
 var users = ["Mariano", "Leandro", "Julian"]
 output application/json
 ---
 take(users, 2)
```

#### Output

```json
["Mariano", "Leandro"]
```

<!-- document id=67961b90a3c4636ae92d67861a203d2f0a2391493bda399ab49246c94a628469 url=/mulesoft/current/en-us/dataweave/2.4/dw-arrays-functions-take.md -->

---
product: DataWeave
version: 2.4
---

# take

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## take<T>(array: Array<T>, n: Number): Array<T>

Selects the first `n` elements. It returns an empty array when `n <= 0` and the original array when
`n > sizeOf(array)`.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>n</code></p></td><td><p>The number of elements to select.</p></td></tr></tbody></table>

### Example

This example outputs an array that contains the values of first two elements of the input array.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
var users = ["Mariano", "Leandro", "Julian"]
output application/json
---
take(users, 2)
```

#### Output

```json
["Mariano", "Leandro"]
```

## take(array: Null, n: Any): Null

Helper function that enables `take` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=0dbf4cd16f7e2f4705e5a6f1aa57a92881e93c4bfb520471fe547e7433c4cce9 url=/mulesoft/current/en-us/dataweave/2.6/dw-arrays-functions-take.md -->

---
product: DataWeave
version: 2.6
---

# take

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## take<T>(array: Array<T>, n: Number): Array<T>

Selects the first `n` elements. It returns an empty array when `n <= 0` and the original array when
`n > sizeOf(array)`.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>n</code></p></td><td><p>The number of elements to select.</p></td></tr></tbody></table>

### Example

This example outputs an array that contains the values of first two elements of the input array.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
var users = ["Mariano", "Leandro", "Julian"]
output application/json
---
take(users, 2)
```

#### Output

```json
["Mariano", "Leandro"]
```

## take(array: Null, n: Any): Null

Helper function that enables `take` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=b69ad9bf63ec83361315a7821fd15c051f93809935d0ce1caea97a1ba1be023f url=/mulesoft/current/en-us/dataweave/2.9/dw-arrays-functions-take.md -->

---
product: DataWeave
version: 2.9
---

# take

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## take<T>(array: Array<T>, n: Number): Array<T>

Selects the first `n` elements. It returns an empty array when `n <= 0` and the original array when
`n > sizeOf(array)`.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>n</code></p></td><td><p>The number of elements to select.</p></td></tr></tbody></table>

### Example

This example outputs an array that contains the values of first two elements of the input array.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
var users = ["Mariano", "Leandro", "Julian"]
output application/json
---
take(users, 2)
```

#### Output

```json
["Mariano", "Leandro"]
```

## take(array: Null, n: Any): Null

Helper function that enables `take` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=e9b7b0003200fbc789ee7ad2c14bd6390540b39f37e4b9254412cfbc5b5e7f7a url=/mulesoft/current/en-us/dataweave/latest/dw-arrays-functions-take.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# take

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## take<T>(array: Array<T>, n: Number): Array<T>

Selects the first `n` elements. It returns an empty array when `n <= 0` and the original array when
`n > sizeOf(array)`.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>n</code></p></td><td><p>The number of elements to select.</p></td></tr></tbody></table>

### Example

This example outputs an array that contains the values of first two elements of the input array.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
var users = ["Mariano", "Leandro", "Julian"]
output application/json
---
take(users, 2)
```

#### Output

```json
["Mariano", "Leandro"]
```

## take(array: Null, n: Any): Null

Helper function that enables `take` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=5ff9b11fe410a4d4b6dcccff52258a5d8fc749d345e56e0334c9f5d24f24631f url=/mulesoft/current/en-us/dataweave/2.11/dw-arrays-functions-takewhile.md -->

---
product: DataWeave
version: 2.11
---

# takeWhile

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## takeWhile<T>(array: Array<T>, condition: (item: T) -> Boolean): Array<T>

Selects elements from the array while the condition is met but stops the selection process when it
reaches an element that fails to satisfy the condition.

To select all elements that meet the condition, use the `filter` function.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition (or expression) used to match an element in the array.</p></td></tr></tbody></table>

### Example

This example iterates over the elements in the array and selects only those with an index that is
`<= 1` and stops selecting elements when it reaches one that is greater than `2`. Notice that it
does not select the second `1` because of the `2` that precedes it in the array. The function
outputs the result into an array.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var arr = [0,1,2,1]
---
arr takeWhile $ <= 1
```

#### Output

```json
[0, 1]
```

## takeWhile(array: Null, condition: (item: Nothing) -> Any): Null

Helper function that enables `takeWhile` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=2e32114c33032d8f011f176e64d530939094217264d7119c55148c290b5a27e3 url=/mulesoft/current/en-us/dataweave/2.11/dw-objects-functions-takewhile.md -->

---
product: DataWeave
version: 2.11
---

# takeWhile

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## takeWhile<T>(obj: Object, condition: (value: Any, key: Key) -> Boolean): Object

Selects key-value pairs from the object while the condition is met.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to filter.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition (or expression) used to match a key-value pairs in the object.</p></td></tr></tbody></table>

### Example

This example iterates over the key-value pairs in the object and selects the elements while the
condition is met. It outputs the result into an object.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Objects
output application/json
var obj = {
  "a": 1,
  "b": 2,
  "c": 5,
  "d": 1
}
---
obj takeWhile ((value, key) ->  value < 3)
```

#### Output

```json
{
  "a": 1,
  "b": 2
}
```

<!-- document id=40ef4790c0db6731a3d4439ff5ca058f8ec45867f939aac4d321ae1ecb9f8014 url=/mulesoft/current/en-us/dataweave/2.12/dw-arrays-functions-takewhile.md -->

---
product: DataWeave
version: 2.12
---

# takeWhile

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## takeWhile<T>(array: Array<T>, condition: (item: T) -> Boolean): Array<T>

Selects elements from the array while the condition is met but stops the selection process when it
reaches an element that fails to satisfy the condition.

To select all elements that meet the condition, use the `filter` function.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition (or expression) used to match an element in the array.</p></td></tr></tbody></table>

### Example

This example iterates over the elements in the array and selects only those with an index that is
`<= 1` and stops selecting elements when it reaches one that is greater than `2`. Notice that it
does not select the second `1` because of the `2` that precedes it in the array. The function
outputs the result into an array.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var arr = [0,1,2,1]
---
arr takeWhile $ <= 1
```

#### Output

```json
[0, 1]
```

## takeWhile(array: Null, condition: (item: Nothing) -> Any): Null

Helper function that enables `takeWhile` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=de442346386e8bef29bb4018de0fe521a048118cc669bbaca4756b2840d05565 url=/mulesoft/current/en-us/dataweave/2.12/dw-objects-functions-takewhile.md -->

---
product: DataWeave
version: 2.12
---

# takeWhile

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## takeWhile<T>(obj: Object, condition: (value: Any, key: Key) -> Boolean): Object

Selects key-value pairs from the object while the condition is met.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to filter.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition (or expression) used to match a key-value pairs in the object.</p></td></tr></tbody></table>

### Example

This example iterates over the key-value pairs in the object and selects the elements while the
condition is met. It outputs the result into an object.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Objects
output application/json
var obj = {
  "a": 1,
  "b": 2,
  "c": 5,
  "d": 1
}
---
obj takeWhile ((value, key) ->  value < 3)
```

#### Output

```json
{
  "a": 1,
  "b": 2
}
```

<!-- document id=7006351d2410c758a747ce39fa23e5c69898b58ff669f02bde4ed4fc44e2c395 url=/mulesoft/current/en-us/dataweave/2.3/dw-arrays-functions-takewhile.md -->

---
product: DataWeave
version: 2.3
---

# takeWhile

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## takeWhile(Array<T>, (item: T) -> Boolean): Array<T>

Selects elements from the array while the condition is met but stops the selection process when it
reaches an element that fails to satisfy the condition.

To select all elements that meet the condition, use the `filter` function.

_Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition (or expression) used to match an element in the array.</p></td></tr></tbody></table>

### Example

This example iterates over the elements in the array and selects only those with an index that is
`<= 1` and stops selecting elements when it reaches one that is greater than `2`. Notice that it
does not select the second `1` because of the `2` that precedes it in the array. The function
outputs the result into an array.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var arr = [0,1,2,1]
---
arr takeWhile $ <= 1
```

#### Output

```json
[0, 1]
```

<!-- document id=b5110dd52365eb808c94f1e5dd17cfa793048858c045c403b02f8a8a344eda50 url=/mulesoft/current/en-us/dataweave/2.3/dw-objects-functions-takewhile.md -->

---
product: DataWeave
version: 2.3
---

# takeWhile

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## takeWhile(Object, (value: Any, key: Key) -> Boolean): Object

Selects key-value pairs from the object while the condition is met.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to filter.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition (or expression) used to match a key-value pairs in the object.</p></td></tr></tbody></table>

### Example

This example iterates over the key-value pairs in the object and selects the elements while the
condition is met. It outputs the result into an object.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Objects
output application/json
var obj = {
  "a": 1,
  "b": 2,
  "c": 5,
  "d": 1
}
---
obj takeWhile ((value, key) ->  value < 3)
```

#### Output

```json
{
  "a": 1,
  "b": 2
}
```

<!-- document id=d6948887befb37378a3cd003974ae991d8ca848327a31f524bf8ac1f482bbe68 url=/mulesoft/current/en-us/dataweave/2.4/dw-arrays-functions-takewhile.md -->

---
product: DataWeave
version: 2.4
---

# takeWhile

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## takeWhile<T>(array: Array<T>, condition: (item: T) -> Boolean): Array<T>

Selects elements from the array while the condition is met but stops the selection process when it
reaches an element that fails to satisfy the condition.

To select all elements that meet the condition, use the `filter` function.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition (or expression) used to match an element in the array.</p></td></tr></tbody></table>

### Example

This example iterates over the elements in the array and selects only those with an index that is
`<= 1` and stops selecting elements when it reaches one that is greater than `2`. Notice that it
does not select the second `1` because of the `2` that precedes it in the array. The function
outputs the result into an array.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var arr = [0,1,2,1]
---
arr takeWhile $ <= 1
```

#### Output

```json
[0, 1]
```

## takeWhile(array: Null, condition: (item: Nothing) -> Any): Null

Helper function that enables `takeWhile` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=b684b9ad30fdda80ac7ab08841483cd6ab0bb2548e926401d146b7114929f831 url=/mulesoft/current/en-us/dataweave/2.4/dw-objects-functions-takewhile.md -->

---
product: DataWeave
version: 2.4
---

# takeWhile

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## takeWhile<T>(obj: Object, condition: (value: Any, key: Key) -> Boolean): Object

Selects key-value pairs from the object while the condition is met.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to filter.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition (or expression) used to match a key-value pairs in the object.</p></td></tr></tbody></table>

### Example

This example iterates over the key-value pairs in the object and selects the elements while the
condition is met. It outputs the result into an object.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Objects
output application/json
var obj = {
  "a": 1,
  "b": 2,
  "c": 5,
  "d": 1
}
---
obj takeWhile ((value, key) ->  value < 3)
```

#### Output

```json
{
  "a": 1,
  "b": 2
}
```

<!-- document id=aa4771847e63781a88a33823d76c7c84a78bc888525fe7ec23002d854aec0097 url=/mulesoft/current/en-us/dataweave/2.6/dw-arrays-functions-takewhile.md -->

---
product: DataWeave
version: 2.6
---

# takeWhile

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## takeWhile<T>(array: Array<T>, condition: (item: T) -> Boolean): Array<T>

Selects elements from the array while the condition is met but stops the selection process when it
reaches an element that fails to satisfy the condition.

To select all elements that meet the condition, use the `filter` function.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition (or expression) used to match an element in the array.</p></td></tr></tbody></table>

### Example

This example iterates over the elements in the array and selects only those with an index that is
`<= 1` and stops selecting elements when it reaches one that is greater than `2`. Notice that it
does not select the second `1` because of the `2` that precedes it in the array. The function
outputs the result into an array.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var arr = [0,1,2,1]
---
arr takeWhile $ <= 1
```

#### Output

```json
[0, 1]
```

## takeWhile(array: Null, condition: (item: Nothing) -> Any): Null

Helper function that enables `takeWhile` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=571561d65a66074f4b2215b87592c9aee642f651f927a5f83bc7272d9a7791c9 url=/mulesoft/current/en-us/dataweave/2.6/dw-objects-functions-takewhile.md -->

---
product: DataWeave
version: 2.6
---

# takeWhile

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## takeWhile<T>(obj: Object, condition: (value: Any, key: Key) -> Boolean): Object

Selects key-value pairs from the object while the condition is met.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to filter.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition (or expression) used to match a key-value pairs in the object.</p></td></tr></tbody></table>

### Example

This example iterates over the key-value pairs in the object and selects the elements while the
condition is met. It outputs the result into an object.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Objects
output application/json
var obj = {
  "a": 1,
  "b": 2,
  "c": 5,
  "d": 1
}
---
obj takeWhile ((value, key) ->  value < 3)
```

#### Output

```json
{
  "a": 1,
  "b": 2
}
```

<!-- document id=8bd8131e2d08deb1eaf8c079e66d80a3947ee608ccaf746ccd6b2ff63d16277b url=/mulesoft/current/en-us/dataweave/2.9/dw-arrays-functions-takewhile.md -->

---
product: DataWeave
version: 2.9
---

# takeWhile

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## takeWhile<T>(array: Array<T>, condition: (item: T) -> Boolean): Array<T>

Selects elements from the array while the condition is met but stops the selection process when it
reaches an element that fails to satisfy the condition.

To select all elements that meet the condition, use the `filter` function.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition (or expression) used to match an element in the array.</p></td></tr></tbody></table>

### Example

This example iterates over the elements in the array and selects only those with an index that is
`<= 1` and stops selecting elements when it reaches one that is greater than `2`. Notice that it
does not select the second `1` because of the `2` that precedes it in the array. The function
outputs the result into an array.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var arr = [0,1,2,1]
---
arr takeWhile $ <= 1
```

#### Output

```json
[0, 1]
```

## takeWhile(array: Null, condition: (item: Nothing) -> Any): Null

Helper function that enables `takeWhile` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=1e7621e03684dfc06dc3dac594bff8ec99365aa850745162cbf374c16e1c8a9d url=/mulesoft/current/en-us/dataweave/2.9/dw-objects-functions-takewhile.md -->

---
product: DataWeave
version: 2.9
---

# takeWhile

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## takeWhile<T>(obj: Object, condition: (value: Any, key: Key) -> Boolean): Object

Selects key-value pairs from the object while the condition is met.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to filter.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition (or expression) used to match a key-value pairs in the object.</p></td></tr></tbody></table>

### Example

This example iterates over the key-value pairs in the object and selects the elements while the
condition is met. It outputs the result into an object.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Objects
output application/json
var obj = {
  "a": 1,
  "b": 2,
  "c": 5,
  "d": 1
}
---
obj takeWhile ((value, key) ->  value < 3)
```

#### Output

```json
{
  "a": 1,
  "b": 2
}
```

<!-- document id=2f8bca74dde6ec69714775dffadae87e9d176a33e40f006a6eccfb61a6383ede url=/mulesoft/current/en-us/dataweave/latest/dw-arrays-functions-takewhile.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# takeWhile

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## takeWhile<T>(array: Array<T>, condition: (item: T) -> Boolean): Array<T>

Selects elements from the array while the condition is met but stops the selection process when it
reaches an element that fails to satisfy the condition.

To select all elements that meet the condition, use the `filter` function.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>array</code></p></td><td><p>The array of elements.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition (or expression) used to match an element in the array.</p></td></tr></tbody></table>

### Example

This example iterates over the elements in the array and selects only those with an index that is
`<= 1` and stops selecting elements when it reaches one that is greater than `2`. Notice that it
does not select the second `1` because of the `2` that precedes it in the array. The function
outputs the result into an array.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Arrays
output application/json
var arr = [0,1,2,1]
---
arr takeWhile $ <= 1
```

#### Output

```json
[0, 1]
```

## takeWhile(array: Null, condition: (item: Nothing) -> Any): Null

Helper function that enables `takeWhile` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=5326921d3735b0d195e7c84b2238871190385dc2f9c750164d3e63beeea706a7 url=/mulesoft/current/en-us/dataweave/latest/dw-objects-functions-takewhile.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# takeWhile

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## takeWhile<T>(obj: Object, condition: (value: Any, key: Key) -> Boolean): Object

Selects key-value pairs from the object while the condition is met.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to filter.</p></td></tr><tr><td><p><code>condition</code></p></td><td><p>The condition (or expression) used to match a key-value pairs in the object.</p></td></tr></tbody></table>

### Example

This example iterates over the key-value pairs in the object and selects the elements while the
condition is met. It outputs the result into an object.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Objects
output application/json
var obj = {
  "a": 1,
  "b": 2,
  "c": 5,
  "d": 1
}
---
obj takeWhile ((value, key) ->  value < 3)
```

#### Output

```json
{
  "a": 1,
  "b": 2
}
```

<!-- document id=47eff2b949d7d038bc3ca199dea51198a9ce5ded99679c0a9c8fe21357e74627 url=/mulesoft/current/en-us/dataweave/2.11/dw-math-functions-tan.md -->

---
product: DataWeave
version: 2.11
---

# tan

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## tan(angle: Number): Number

Returns the trigonometric tangent of an angle from a given number of radians.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>angle</code></p></td><td><div><div><p>Number of radians in an angle.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `tan` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
   "tan0": tan(0),
   "tan13": tan(0.13),
   "tan-1": tan(-1)
}
```

#### Output

```Json
{
   "tan0": 0.0,
   "tan13": 0.13073731800446006,
   "tan-1": -1.5574077246549023
 }
```

<!-- document id=ed07125c132401cd31508d34f40a4be0356a2149f3c151c85e62affed2af9175 url=/mulesoft/current/en-us/dataweave/2.12/dw-math-functions-tan.md -->

---
product: DataWeave
version: 2.12
---

# tan

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## tan(angle: Number): Number

Returns the trigonometric tangent of an angle from a given number of radians.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>angle</code></p></td><td><div><div><p>Number of radians in an angle.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `tan` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
   "tan0": tan(0),
   "tan13": tan(0.13),
   "tan-1": tan(-1)
}
```

#### Output

```Json
{
   "tan0": 0.0,
   "tan13": 0.13073731800446006,
   "tan-1": -1.5574077246549023
 }
```

<!-- document id=d855d657f5424fa872f9b6ed759934e675375a71e6dab038eb10df28c3aef20f url=/mulesoft/current/en-us/dataweave/2.4/dw-math-functions-tan.md -->

---
product: DataWeave
version: 2.4
---

# tan

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## tan(angle: Number): Number

Returns the trigonometric tangent of an angle from a given number of radians.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>angle</code></p></td><td><div><div><p>Number of radians in an angle.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `tan` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
   "tan0": tan(0),
   "tan13": tan(0.13),
   "tan-1": tan(-1)
}
```

#### Output

```Json
{
   "tan0": 0.0,
   "tan13": 0.13073731800446006,
   "tan-1": -1.5574077246549023
 }
```

<!-- document id=d0d46fc7be8897cc64080563bfcba59ff294b3345c39e805290a24e4825e6176 url=/mulesoft/current/en-us/dataweave/2.6/dw-math-functions-tan.md -->

---
product: DataWeave
version: 2.6
---

# tan

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## tan(angle: Number): Number

Returns the trigonometric tangent of an angle from a given number of radians.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>angle</code></p></td><td><div><div><p>Number of radians in an angle.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `tan` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
   "tan0": tan(0),
   "tan13": tan(0.13),
   "tan-1": tan(-1)
}
```

#### Output

```Json
{
   "tan0": 0.0,
   "tan13": 0.13073731800446006,
   "tan-1": -1.5574077246549023
 }
```

<!-- document id=a78a007827c00ce10f2b30eda57a2903cd6d83703d6690dd4f3fcbf9a4751920 url=/mulesoft/current/en-us/dataweave/2.9/dw-math-functions-tan.md -->

---
product: DataWeave
version: 2.9
---

# tan

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## tan(angle: Number): Number

Returns the trigonometric tangent of an angle from a given number of radians.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>angle</code></p></td><td><div><div><p>Number of radians in an angle.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `tan` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
   "tan0": tan(0),
   "tan13": tan(0.13),
   "tan-1": tan(-1)
}
```

#### Output

```Json
{
   "tan0": 0.0,
   "tan13": 0.13073731800446006,
   "tan-1": -1.5574077246549023
 }
```

<!-- document id=d8d678bdda4fb2be2a3a79c33f11b577f195276bb03a652f8c0f58eb33f5722d url=/mulesoft/current/en-us/dataweave/latest/dw-math-functions-tan.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# tan

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## tan(angle: Number): Number

Returns the trigonometric tangent of an angle from a given number of radians.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>angle</code></p></td><td><div><div><p>Number of radians in an angle.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `tan` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
   "tan0": tan(0),
   "tan13": tan(0.13),
   "tan-1": tan(-1)
}
```

#### Output

```Json
{
   "tan0": 0.0,
   "tan13": 0.13073731800446006,
   "tan-1": -1.5574077246549023
 }
```

<!-- document id=8490bf7b822061d0ea007bed39be20308ad62acb6590f6aae6af1dd9d301f51d url=/mulesoft/current/en-us/dataweave/2.11/dataweave-testing-framework.md -->

---
product: DataWeave
version: 2.11
---

# Testing DataWeave Libraries and Modules

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The DataWeave testing framework enables you to build automated unit and integration tests for your
DataWeave libraries and mappings. You can run tests to evaluate `.dwl` files and compare them to the
output produced by the system you’re testing. The framework provides a full suite of integration and
unit test capabilities with a built-in set of assertion functions, and it is completely integrated
with Maven and Surefire for your continuous deployment environment.

Use snapshot testing for your integration tests by storing the expected outputs as a separate file
rather than as a string literal inside the test code.

You can create tests for your DataWeave mappings and modules either by using the Visual Studio Code
(VS Code) plugin, see [Installing and Using the DataWeave Extension](https://docs.mulesoft.com/dataweave/2.11/dataweave-extension-plugin) for
instructions, or manually by modifying your project’s `pom.xml` file.

## Add the DataWeave Testing Framework to Your Project

To enable the DataWeave Testing Framework in your project:

- Add the following Maven dependency to your project’s `pom.xml` file:

  ```xml
   <dependency>
     <groupId>org.mule.weave</groupId>
     <artifactId>data-weave-testing-framework</artifactId>
     <version>${data.weave.testing.framework.version}</version>
     <scope>test</scope>
   </dependency>
  ```

## Tests Structure

The following table shows the different files that compose a test, a description of their
functionalities, and their default locations:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>File</th><th>Description</th><th>Location</th></tr></thead><tbody><tr><td><div><div><p>DataWeave Mapping</p></div></div></td><td><div><div><p>The <code>.dwl</code> file that contains the mapping to test.</p></div></div></td><td><div><div><p><code>src/main/dw/&lt;package&gt;/&lt;mappingFileName&gt;</code></p></div></div></td></tr><tr><td><div><div><p>DataWeave Test</p></div></div></td><td><div><div><p>The <code>.dwl</code> file that contains the tests and assertions to execute.</p></div></div></td><td><div><div><p><code>src/test/dw/&lt;package&gt;/&lt;testFileName&gt;</code></p></div></div></td></tr><tr><td><div><div><p>Input</p></div></div></td><td><div><div><p>The file that contains the input to evaluate against the mapping. Depending on the test, this file is optional.</p></div></div></td><td><div><div><p><code>src/test/resources/&lt;mappingPath&gt;/&lt;scenario&gt;/inputs/&lt;inputFile&gt;</code></p></div></div></td></tr><tr><td><div><div><p>Output</p></div></div></td><td><div><div><p>The file that contains the output to check against the results of the mapping.</p></div></div></td><td><div><div><p><code>src/test/resources/&lt;mappingPath&gt;/&lt;scenario&gt;/&lt;outputFile&gt;</code></p></div></div></td></tr></tbody></table>

## Create an Integration Test for a Mapping

To test a DataWeave mapping, create an integration test by following these steps:

1.  Create a `.dwl` file with a name ending in `Test` in the `src/test/dw/<package>/<testFileName>`
    folder.

2.  In the test file’s header, import the `dw::test::Tests` and `dw::test::Asserts` modules.

3.  In the test file’s body, nest any number of sections (`“sectionName”`), followed by
    `describedBy`, and specify the test name at the end (`“testName”`), followed by
    `in do {<codeExecution/assertion>}`.

4.  In the code execution and assertion part of the test file, specify the following:

    - The `inputsFrom(<inputPath>)` function, to get the inputs to evaluate against the mapping

    - The `evalPath(<mapping/scenario>)` function, to specify the mapping path

    - The `must equalTo` matcher to check the results against the expected output specified by
      function `outputFrom(<mapping/scenario>)`

5.  Add the expected inputs and outputs to the `src/test/resources/<mappingPath>` folder.

6.  If you want to configure the reader properties for the inputs, create a properties file with
    suffix `{fileName}-config.properties` in the `src/test/resources/<mappingPath>/inputs/` folder.

### Example Mapping Test

The following example shows a DataWeave test that contains a DataWeave mapping file, an input file,
a reader properties configuration file, an output file, and a test file, respectively:

- DataWeave mapping in `src/main/dw/myPackage/MyMapping.dwl`

  ```dataweave
  %dw 2.0
  output application/json
  ---
  {
    hello: "world"
  }
  ```

- Input file in `src/test/resources/myPackage/MyMapping/NewScenario/inputs/payload.json`

  ```dataweave
  {
    "message": "Hello world!"
  }
  ```

- Reader properties configuration file in
  `src/test/resources/myPackage/MyMapping/NewScenario/inputs/payload-config.properties`

  ```dataweave
  streaming=false
  ```

- Expected output file in `src/test/resources/myPackage/MyMapping/NewScenario/out.json`

  ```dataweave
  {
    "hello": "world"
  }
  ```

- Test file in `src/test/dw/myPackage/MyMappingTest.dwl`

  ```dataweave
  %dw 2.0
  import * from dw::test::Tests
  import * from dw::test::Asserts
  ---
  "Test MyMapping" describedBy [
     "Assert NewScenario" in do {
         evalPath("myPackage/MyMapping.dwl", inputsFrom("myPackage/MyMapping/NewScenario"),"application/json") must
                   equalTo(outputFrom("myPackage/MyMapping/NewScenario"))
     }
  ]
  ```

## Create a Unit Test for a Module

To create a unit test for a module:

1.  Create a `.dwl` file with a name ending in `Test` in the `src/test/dw/<package>/<testFileName>`
    folder.

2.  In the test file’s header, import `dw::test::Tests`, `dw::test::Asserts`, and the custom module
    you want to test, for example, `"MyModule"`.

3.  In the test file’s body, nest any number of sections (`“sectionName”`) followed by
    `describedBy`, and specify the test name at the end (`“testName”`).

4.  In the code execution and assertion part of the test, call the function you want to test
    (`functionToTest()`) and add an assertion against its result, for example, `must beObject()`.

### Example Unit Test for a Module

Example `src/test/dw/MyModuleTest.dwl` file:

```dataweave
%dw 2.0
import * from dw::test::Tests
import * from dw::test::Asserts

import * from MyModule
---
"MyModule" describedBy [
   "something" describedBy [
       "It should do something" in do {
           something() must beObject()
       },
   ],
]
```

## Create an Integration Test for a Module

To create an integration test for a module:

1.  In your test folder, create a DataWeave mapping that uses the module you want to test.

2.  Follow the steps in [Creating an Integration Test for a Mapping](#create-test).

## Run the Tests from the Command Line

You can run the tests from the command line by running the `mvn test` command:

- To run a single test, use `mvn -Dtest=<MyMappingTest> test`.

- To skip a test, use `mvn install -DskipTests`.

## Matchers

The testing framework includes a set of matchers to use in your tests. See the
[DataWeave assertions module](https://docs.mulesoft.com/dataweave/2.11/dw-test-asserts) for reference information.

## See Also

- [DataWeave Extension](https://docs.mulesoft.com/dataweave/2.11/dataweave-extension)

- [Packaging and Deploying DataWeave Libraries](https://docs.mulesoft.com/dataweave/2.11/dataweave-maven-plugin)

- [Installing and Using the DataWeave Extension](https://docs.mulesoft.com/dataweave/2.11/dataweave-extension-plugin)

<!-- document id=5b4f30f02f2326431aa00c842e7e2310dde1bebb89ba0272fca1aa15f566a469 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-testing-framework.md -->

---
product: DataWeave
version: 2.12
---

# Testing DataWeave Libraries and Modules

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The DataWeave testing framework enables you to build automated unit and integration tests for your
DataWeave libraries and mappings. You can run tests to evaluate `.dwl` files and compare them to the
output produced by the system you’re testing. The framework provides a full suite of integration and
unit test capabilities with a built-in set of assertion functions, and it is completely integrated
with Maven and Surefire for your continuous deployment environment.

Use snapshot testing for your integration tests by storing the expected outputs as a separate file
rather than as a string literal inside the test code.

You can create tests for your DataWeave mappings and modules either by using the Visual Studio Code
(VS Code) plugin, see [Installing and Using the DataWeave Extension](https://docs.mulesoft.com/dataweave/2.12/dataweave-extension-plugin) for
instructions, or manually by modifying your project’s `pom.xml` file.

## Add the DataWeave Testing Framework to Your Project

To enable the DataWeave Testing Framework in your project:

- Add the following Maven dependency to your project’s `pom.xml` file:

  ```xml
   <dependency>
     <groupId>org.mule.weave</groupId>
     <artifactId>data-weave-testing-framework</artifactId>
     <version>${data.weave.testing.framework.version}</version>
     <scope>test</scope>
   </dependency>
  ```

## Tests Structure

The following table shows the different files that compose a test, a description of their
functionalities, and their default locations:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>File</th><th>Description</th><th>Location</th></tr></thead><tbody><tr><td><div><div><p>DataWeave Mapping</p></div></div></td><td><div><div><p>The <code>.dwl</code> file that contains the mapping to test.</p></div></div></td><td><div><div><p><code>src/main/dw/&lt;package&gt;/&lt;mappingFileName&gt;</code></p></div></div></td></tr><tr><td><div><div><p>DataWeave Test</p></div></div></td><td><div><div><p>The <code>.dwl</code> file that contains the tests and assertions to execute.</p></div></div></td><td><div><div><p><code>src/test/dw/&lt;package&gt;/&lt;testFileName&gt;</code></p></div></div></td></tr><tr><td><div><div><p>Input</p></div></div></td><td><div><div><p>The file that contains the input to evaluate against the mapping. Depending on the test, this file is optional.</p></div></div></td><td><div><div><p><code>src/test/resources/&lt;mappingPath&gt;/&lt;scenario&gt;/inputs/&lt;inputFile&gt;</code></p></div></div></td></tr><tr><td><div><div><p>Output</p></div></div></td><td><div><div><p>The file that contains the output to check against the results of the mapping.</p></div></div></td><td><div><div><p><code>src/test/resources/&lt;mappingPath&gt;/&lt;scenario&gt;/&lt;outputFile&gt;</code></p></div></div></td></tr></tbody></table>

## Create an Integration Test for a Mapping

To test a DataWeave mapping, create an integration test by following these steps:

1.  Create a `.dwl` file with a name ending in `Test` in the `src/test/dw/<package>/<testFileName>`
    folder.

2.  In the test file’s header, import the `dw::test::Tests` and `dw::test::Asserts` modules.

3.  In the test file’s body, nest any number of sections (`“sectionName”`), followed by
    `describedBy`, and specify the test name at the end (`“testName”`), followed by
    `in do {<codeExecution/assertion>}`.

4.  In the code execution and assertion part of the test file, specify the following:

    - The `inputsFrom(<inputPath>)` function, to get the inputs to evaluate against the mapping

    - The `evalPath(<mapping/scenario>)` function, to specify the mapping path

    - The `must equalTo` matcher to check the results against the expected output specified by
      function `outputFrom(<mapping/scenario>)`

5.  Add the expected inputs and outputs to the `src/test/resources/<mappingPath>` folder.

6.  If you want to configure the reader properties for the inputs, create a properties file with
    suffix `{fileName}-config.properties` in the `src/test/resources/<mappingPath>/inputs/` folder.

### Example Mapping Test

The following example shows a DataWeave test that contains a DataWeave mapping file, an input file,
a reader properties configuration file, an output file, and a test file, respectively:

- DataWeave mapping in `src/main/dw/myPackage/MyMapping.dwl`

  ```dataweave
  %dw 2.0
  output application/json
  ---
  {
    hello: "world"
  }
  ```

- Input file in `src/test/resources/myPackage/MyMapping/NewScenario/inputs/payload.json`

  ```dataweave
  {
    "message": "Hello world!"
  }
  ```

- Reader properties configuration file in
  `src/test/resources/myPackage/MyMapping/NewScenario/inputs/payload-config.properties`

  ```dataweave
  streaming=false
  ```

- Expected output file in `src/test/resources/myPackage/MyMapping/NewScenario/out.json`

  ```dataweave
  {
    "hello": "world"
  }
  ```

- Test file in `src/test/dw/myPackage/MyMappingTest.dwl`

  ```dataweave
  %dw 2.0
  import * from dw::test::Tests
  import * from dw::test::Asserts
  ---
  "Test MyMapping" describedBy [
     "Assert NewScenario" in do {
         evalPath("myPackage/MyMapping.dwl", inputsFrom("myPackage/MyMapping/NewScenario"),"application/json") must
                   equalTo(outputFrom("myPackage/MyMapping/NewScenario"))
     }
  ]
  ```

## Create a Unit Test for a Module

To create a unit test for a module:

1.  Create a `.dwl` file with a name ending in `Test` in the `src/test/dw/<package>/<testFileName>`
    folder.

2.  In the test file’s header, import `dw::test::Tests`, `dw::test::Asserts`, and the custom module
    you want to test, for example, `"MyModule"`.

3.  In the test file’s body, nest any number of sections (`“sectionName”`) followed by
    `describedBy`, and specify the test name at the end (`“testName”`).

4.  In the code execution and assertion part of the test, call the function you want to test
    (`functionToTest()`) and add an assertion against its result, for example, `must beObject()`.

### Example Unit Test for a Module

Example `src/test/dw/MyModuleTest.dwl` file:

```dataweave
%dw 2.0
import * from dw::test::Tests
import * from dw::test::Asserts

import * from MyModule
---
"MyModule" describedBy [
   "something" describedBy [
       "It should do something" in do {
           something() must beObject()
       },
   ],
]
```

## Create an Integration Test for a Module

To create an integration test for a module:

1.  In your test folder, create a DataWeave mapping that uses the module you want to test.

2.  Follow the steps in [Creating an Integration Test for a Mapping](#create-test).

## Run the Tests from the Command Line

You can run the tests from the command line by running the `mvn test` command:

- To run a single test, use `mvn -Dtest=<MyMappingTest> test`.

- To skip a test, use `mvn install -DskipTests`.

## Matchers

The testing framework includes a set of matchers to use in your tests. See the
[DataWeave assertions module](https://docs.mulesoft.com/dataweave/2.12/dw-test-asserts) for reference information.

## See Also

- [DataWeave Extension](https://docs.mulesoft.com/dataweave/2.12/dataweave-extension)

- [Packaging and Deploying DataWeave Libraries](https://docs.mulesoft.com/dataweave/2.12/dataweave-maven-plugin)

- [Installing and Using the DataWeave Extension](https://docs.mulesoft.com/dataweave/2.12/dataweave-extension-plugin)

<!-- document id=f8a56ea3cfaa6a8088e31f37a0fea0f9580411ea04f85ee81b1a55b0ca94fb50 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-testing-framework.md -->

---
product: DataWeave
version: 2.4
---

# Testing DataWeave Libraries and Modules

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The DataWeave testing framework enables you to build automated unit and integration tests for your
DataWeave libraries and mappings. You can run tests to evaluate `.dwl` files and compare them to the
output produced by the system you’re testing. The framework provides a full suite of integration and
unit test capabilities with a built-in set of assertion functions, and it is completely integrated
with Maven and Surefire for your continuous deployment environment.

Use snapshot testing for your integration tests by storing the expected outputs as a separate file
rather than as a string literal inside the test code.

You can create tests for your DataWeave mappings and modules either by using the Visual Studio Code
(VS Code) plugin, see [Installing and Using the DataWeave Extension](https://docs.mulesoft.com/dataweave/2.4/dataweave-extension-plugin) for
instructions, or manually by modifying your project’s `pom.xml` file.

## Add the DataWeave Testing Framework to Your Project

To enable the DataWeave Testing Framework in your project:

- Add the following Maven dependency to your project’s `pom.xml` file:

  ```xml
   <dependency>
     <groupId>org.mule.weave</groupId>
     <artifactId>data-weave-testing-framework</artifactId>
     <version>${data.weave.testing.framework.version}</version>
     <scope>test</scope>
   </dependency>
  ```

## Tests Structure

The following table shows the different files that compose a test, a description of their
functionalities, and their default locations:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>File</th><th>Description</th><th>Location</th></tr></thead><tbody><tr><td><div><div><p>DataWeave Mapping</p></div></div></td><td><div><div><p>The <code>.dwl</code> file that contains the mapping to test.</p></div></div></td><td><div><div><p><code>src/main/dw/&lt;package&gt;/&lt;mappingFileName&gt;</code></p></div></div></td></tr><tr><td><div><div><p>DataWeave Test</p></div></div></td><td><div><div><p>The <code>.dwl</code> file that contains the tests and assertions to execute.</p></div></div></td><td><div><div><p><code>src/test/dw/&lt;package&gt;/&lt;testFileName&gt;</code></p></div></div></td></tr><tr><td><div><div><p>Input</p></div></div></td><td><div><div><p>The file that contains the input to evaluate against the mapping. Depending on the test, this file is optional.</p></div></div></td><td><div><div><p><code>src/test/resources/&lt;mappingPath&gt;/&lt;scenario&gt;/inputs/&lt;inputFile&gt;</code></p></div></div></td></tr><tr><td><div><div><p>Output</p></div></div></td><td><div><div><p>The file that contains the output to check against the results of the mapping.</p></div></div></td><td><div><div><p><code>src/test/resources/&lt;mappingPath&gt;/&lt;scenario&gt;/&lt;outputFile&gt;</code></p></div></div></td></tr></tbody></table>

## Create an Integration Test for a Mapping

To test a DataWeave mapping, create an integration test by following these steps:

1.  Create a `.dwl` file with a name ending in `Test` in the `src/test/dw/<package>/<testFileName>`
    folder.

2.  In the test file’s header, import the `dw::test::Tests` and `dw::test::Asserts` modules.

3.  In the test file’s body, nest any number of sections (`“sectionName”`), followed by
    `describedBy`, and specify the test name at the end (`“testName”`), followed by
    `in do {<codeExecution/assertion>}`.

4.  In the code execution and assertion part of the test file, specify the following:

    - The `inputsFrom(<inputPath>)` function, to get the inputs to evaluate against the mapping

    - The `evalPath(<mapping/scenario>)` function, to specify the mapping path

    - The `must equalTo` matcher to check the results against the expected output specified by
      function `outputFrom(<mapping/scenario>)`

5.  Add the expected inputs and outputs to the `src/test/resources/<mappingPath>` folder.

6.  If you want to configure the reader properties for the inputs, create a properties file with
    suffix `{fileName}-config.properties` in the `src/test/resources/<mappingPath>/inputs/` folder.

### Example Mapping Test

The following example shows a DataWeave test that contains a DataWeave mapping file, an input file,
a reader properties configuration file, an output file, and a test file, respectively:

- DataWeave mapping in `src/main/dw/myPackage/MyMapping.dwl`

  ```dataweave
  %dw 2.0
  output application/json
  ---
  {
    hello: "world"
  }
  ```

- Input file in `src/test/resources/myPackage/MyMapping/NewScenario/inputs/payload.json`

  ```dataweave
  {
    "message": "Hello world!"
  }
  ```

- Reader properties configuration file in
  `src/test/resources/myPackage/MyMapping/NewScenario/inputs/payload-config.properties`

  ```dataweave
  streaming=false
  ```

- Expected output file in `src/test/resources/myPackage/MyMapping/NewScenario/out.json`

  ```dataweave
  {
    "hello": "world"
  }
  ```

- Test file in `src/test/dw/myPackage/MyMappingTest.dwl`

  ```dataweave
  %dw 2.0
  import * from dw::test::Tests
  import * from dw::test::Asserts
  ---
  "Test MyMapping" describedBy [
     "Assert NewScenario" in do {
         evalPath("myPackage/MyMapping.dwl", inputsFrom("myPackage/MyMapping/NewScenario"),"application/json") must
                   equalTo(outputFrom("myPackage/MyMapping/NewScenario"))
     }
  ]
  ```

## Create a Unit Test for a Module

To create a unit test for a module:

1.  Create a `.dwl` file with a name ending in `Test` in the `src/test/dw/<package>/<testFileName>`
    folder.

2.  In the test file’s header, import `dw::test::Tests`, `dw::test::Asserts`, and the custom module
    you want to test, for example, `"MyModule"`.

3.  In the test file’s body, nest any number of sections (`“sectionName”`) followed by
    `describedBy`, and specify the test name at the end (`“testName”`).

4.  In the code execution and assertion part of the test, call the function you want to test
    (`functionToTest()`) and add an assertion against its result, for example, `must beObject()`.

### Example Unit Test for a Module

Example `src/test/dw/MyModuleTest.dwl` file:

```dataweave
%dw 2.0
import * from dw::test::Tests
import * from dw::test::Asserts

import * from MyModule
---
"MyModule" describedBy [
   "something" describedBy [
       "It should do something" in do {
           something() must beObject()
       },
   ],
]
```

## Create an Integration Test for a Module

To create an integration test for a module:

1.  In your test folder, create a DataWeave mapping that uses the module you want to test.

2.  Follow the steps in [Creating an Integration Test for a Mapping](#create-test).

## Run the Tests from the Command Line

You can run the tests from the command line by running the `mvn test` command:

- To run a single test, use `mvn -Dtest=<MyMappingTest> test`.

- To skip a test, use `mvn install -DskipTests`.

## Matchers

The testing framework includes a set of matchers to use in your tests. See the
[DataWeave assertions module](https://docs.mulesoft.com/dataweave/2.4/dw-test-asserts) for reference information.

## See Also

- [DataWeave Extension](https://docs.mulesoft.com/dataweave/2.4/dataweave-extension)

- [Packaging and Deploying DataWeave Libraries](https://docs.mulesoft.com/dataweave/2.4/dataweave-maven-plugin)

- [Installing and Using the DataWeave Extension](https://docs.mulesoft.com/dataweave/2.4/dataweave-extension-plugin)

<!-- document id=af12bdde86407fb050e101238a0bed5cb45b67bd5a49d904730c980312086858 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-testing-framework.md -->

---
product: DataWeave
version: 2.6
---

# Testing DataWeave Libraries and Modules

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The DataWeave testing framework enables you to build automated unit and integration tests for your
DataWeave libraries and mappings. You can run tests to evaluate `.dwl` files and compare them to the
output produced by the system you’re testing. The framework provides a full suite of integration and
unit test capabilities with a built-in set of assertion functions, and it is completely integrated
with Maven and Surefire for your continuous deployment environment.

Use snapshot testing for your integration tests by storing the expected outputs as a separate file
rather than as a string literal inside the test code.

You can create tests for your DataWeave mappings and modules either by using the Visual Studio Code
(VS Code) plugin, see [Installing and Using the DataWeave Extension](https://docs.mulesoft.com/dataweave/2.6/dataweave-extension-plugin) for
instructions, or manually by modifying your project’s `pom.xml` file.

## Add the DataWeave Testing Framework to Your Project

To enable the DataWeave Testing Framework in your project:

- Add the following Maven dependency to your project’s `pom.xml` file:

  ```xml
   <dependency>
     <groupId>org.mule.weave</groupId>
     <artifactId>data-weave-testing-framework</artifactId>
     <version>${data.weave.testing.framework.version}</version>
     <scope>test</scope>
   </dependency>
  ```

## Tests Structure

The following table shows the different files that compose a test, a description of their
functionalities, and their default locations:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>File</th><th>Description</th><th>Location</th></tr></thead><tbody><tr><td><div><div><p>DataWeave Mapping</p></div></div></td><td><div><div><p>The <code>.dwl</code> file that contains the mapping to test.</p></div></div></td><td><div><div><p><code>src/main/dw/&lt;package&gt;/&lt;mappingFileName&gt;</code></p></div></div></td></tr><tr><td><div><div><p>DataWeave Test</p></div></div></td><td><div><div><p>The <code>.dwl</code> file that contains the tests and assertions to execute.</p></div></div></td><td><div><div><p><code>src/test/dw/&lt;package&gt;/&lt;testFileName&gt;</code></p></div></div></td></tr><tr><td><div><div><p>Input</p></div></div></td><td><div><div><p>The file that contains the input to evaluate against the mapping. Depending on the test, this file is optional.</p></div></div></td><td><div><div><p><code>src/test/resources/&lt;mappingPath&gt;/&lt;scenario&gt;/inputs/&lt;inputFile&gt;</code></p></div></div></td></tr><tr><td><div><div><p>Output</p></div></div></td><td><div><div><p>The file that contains the output to check against the results of the mapping.</p></div></div></td><td><div><div><p><code>src/test/resources/&lt;mappingPath&gt;/&lt;scenario&gt;/&lt;outputFile&gt;</code></p></div></div></td></tr></tbody></table>

## Create an Integration Test for a Mapping

To test a DataWeave mapping, create an integration test by following these steps:

1.  Create a `.dwl` file with a name ending in `Test` in the `src/test/dw/<package>/<testFileName>`
    folder.

2.  In the test file’s header, import the `dw::test::Tests` and `dw::test::Asserts` modules.

3.  In the test file’s body, nest any number of sections (`“sectionName”`), followed by
    `describedBy`, and specify the test name at the end (`“testName”`), followed by
    `in do {<codeExecution/assertion>}`.

4.  In the code execution and assertion part of the test file, specify the following:

    - The `inputsFrom(<inputPath>)` function, to get the inputs to evaluate against the mapping

    - The `evalPath(<mapping/scenario>)` function, to specify the mapping path

    - The `must equalTo` matcher to check the results against the expected output specified by
      function `outputFrom(<mapping/scenario>)`

5.  Add the expected inputs and outputs to the `src/test/resources/<mappingPath>` folder.

6.  If you want to configure the reader properties for the inputs, create a properties file with
    suffix `{fileName}-config.properties` in the `src/test/resources/<mappingPath>/inputs/` folder.

### Example Mapping Test

The following example shows a DataWeave test that contains a DataWeave mapping file, an input file,
a reader properties configuration file, an output file, and a test file, respectively:

- DataWeave mapping in `src/main/dw/myPackage/MyMapping.dwl`

  ```dataweave
  %dw 2.0
  output application/json
  ---
  {
    hello: "world"
  }
  ```

- Input file in `src/test/resources/myPackage/MyMapping/NewScenario/inputs/payload.json`

  ```dataweave
  {
    "message": "Hello world!"
  }
  ```

- Reader properties configuration file in
  `src/test/resources/myPackage/MyMapping/NewScenario/inputs/payload-config.properties`

  ```dataweave
  streaming=false
  ```

- Expected output file in `src/test/resources/myPackage/MyMapping/NewScenario/out.json`

  ```dataweave
  {
    "hello": "world"
  }
  ```

- Test file in `src/test/dw/myPackage/MyMappingTest.dwl`

  ```dataweave
  %dw 2.0
  import * from dw::test::Tests
  import * from dw::test::Asserts
  ---
  "Test MyMapping" describedBy [
     "Assert NewScenario" in do {
         evalPath("myPackage/MyMapping.dwl", inputsFrom("myPackage/MyMapping/NewScenario"),"application/json") must
                   equalTo(outputFrom("myPackage/MyMapping/NewScenario"))
     }
  ]
  ```

## Create a Unit Test for a Module

To create a unit test for a module:

1.  Create a `.dwl` file with a name ending in `Test` in the `src/test/dw/<package>/<testFileName>`
    folder.

2.  In the test file’s header, import `dw::test::Tests`, `dw::test::Asserts`, and the custom module
    you want to test, for example, `"MyModule"`.

3.  In the test file’s body, nest any number of sections (`“sectionName”`) followed by
    `describedBy`, and specify the test name at the end (`“testName”`).

4.  In the code execution and assertion part of the test, call the function you want to test
    (`functionToTest()`) and add an assertion against its result, for example, `must beObject()`.

### Example Unit Test for a Module

Example `src/test/dw/MyModuleTest.dwl` file:

```dataweave
%dw 2.0
import * from dw::test::Tests
import * from dw::test::Asserts

import * from MyModule
---
"MyModule" describedBy [
   "something" describedBy [
       "It should do something" in do {
           something() must beObject()
       },
   ],
]
```

## Create an Integration Test for a Module

To create an integration test for a module:

1.  In your test folder, create a DataWeave mapping that uses the module you want to test.

2.  Follow the steps in [Creating an Integration Test for a Mapping](#create-test).

## Run the Tests from the Command Line

You can run the tests from the command line by running the `mvn test` command:

- To run a single test, use `mvn -Dtest=<MyMappingTest> test`.

- To skip a test, use `mvn install -DskipTests`.

## Matchers

The testing framework includes a set of matchers to use in your tests. See the
[DataWeave assertions module](https://docs.mulesoft.com/dataweave/2.6/dw-test-asserts) for reference information.

## See Also

- [DataWeave Extension](https://docs.mulesoft.com/dataweave/2.6/dataweave-extension)

- [Packaging and Deploying DataWeave Libraries](https://docs.mulesoft.com/dataweave/2.6/dataweave-maven-plugin)

- [Installing and Using the DataWeave Extension](https://docs.mulesoft.com/dataweave/2.6/dataweave-extension-plugin)

<!-- document id=00f945f031e8d296795a492adff38f862c546aa778593bf037503622bdd237e6 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-testing-framework.md -->

---
product: DataWeave
version: 2.9
---

# Testing DataWeave Libraries and Modules

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The DataWeave testing framework enables you to build automated unit and integration tests for your
DataWeave libraries and mappings. You can run tests to evaluate `.dwl` files and compare them to the
output produced by the system you’re testing. The framework provides a full suite of integration and
unit test capabilities with a built-in set of assertion functions, and it is completely integrated
with Maven and Surefire for your continuous deployment environment.

Use snapshot testing for your integration tests by storing the expected outputs as a separate file
rather than as a string literal inside the test code.

You can create tests for your DataWeave mappings and modules either by using the Visual Studio Code
(VS Code) plugin, see [Installing and Using the DataWeave Extension](https://docs.mulesoft.com/dataweave/2.9/dataweave-extension-plugin) for
instructions, or manually by modifying your project’s `pom.xml` file.

## Add the DataWeave Testing Framework to Your Project

To enable the DataWeave Testing Framework in your project:

- Add the following Maven dependency to your project’s `pom.xml` file:

  ```xml
   <dependency>
     <groupId>org.mule.weave</groupId>
     <artifactId>data-weave-testing-framework</artifactId>
     <version>${data.weave.testing.framework.version}</version>
     <scope>test</scope>
   </dependency>
  ```

## Tests Structure

The following table shows the different files that compose a test, a description of their
functionalities, and their default locations:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>File</th><th>Description</th><th>Location</th></tr></thead><tbody><tr><td><div><div><p>DataWeave Mapping</p></div></div></td><td><div><div><p>The <code>.dwl</code> file that contains the mapping to test.</p></div></div></td><td><div><div><p><code>src/main/dw/&lt;package&gt;/&lt;mappingFileName&gt;</code></p></div></div></td></tr><tr><td><div><div><p>DataWeave Test</p></div></div></td><td><div><div><p>The <code>.dwl</code> file that contains the tests and assertions to execute.</p></div></div></td><td><div><div><p><code>src/test/dw/&lt;package&gt;/&lt;testFileName&gt;</code></p></div></div></td></tr><tr><td><div><div><p>Input</p></div></div></td><td><div><div><p>The file that contains the input to evaluate against the mapping. Depending on the test, this file is optional.</p></div></div></td><td><div><div><p><code>src/test/resources/&lt;mappingPath&gt;/&lt;scenario&gt;/inputs/&lt;inputFile&gt;</code></p></div></div></td></tr><tr><td><div><div><p>Output</p></div></div></td><td><div><div><p>The file that contains the output to check against the results of the mapping.</p></div></div></td><td><div><div><p><code>src/test/resources/&lt;mappingPath&gt;/&lt;scenario&gt;/&lt;outputFile&gt;</code></p></div></div></td></tr></tbody></table>

## Create an Integration Test for a Mapping

To test a DataWeave mapping, create an integration test by following these steps:

1.  Create a `.dwl` file with a name ending in `Test` in the `src/test/dw/<package>/<testFileName>`
    folder.

2.  In the test file’s header, import the `dw::test::Tests` and `dw::test::Asserts` modules.

3.  In the test file’s body, nest any number of sections (`“sectionName”`), followed by
    `describedBy`, and specify the test name at the end (`“testName”`), followed by
    `in do {<codeExecution/assertion>}`.

4.  In the code execution and assertion part of the test file, specify the following:

    - The `inputsFrom(<inputPath>)` function, to get the inputs to evaluate against the mapping

    - The `evalPath(<mapping/scenario>)` function, to specify the mapping path

    - The `must equalTo` matcher to check the results against the expected output specified by
      function `outputFrom(<mapping/scenario>)`

5.  Add the expected inputs and outputs to the `src/test/resources/<mappingPath>` folder.

6.  If you want to configure the reader properties for the inputs, create a properties file with
    suffix `{fileName}-config.properties` in the `src/test/resources/<mappingPath>/inputs/` folder.

### Example Mapping Test

The following example shows a DataWeave test that contains a DataWeave mapping file, an input file,
a reader properties configuration file, an output file, and a test file, respectively:

- DataWeave mapping in `src/main/dw/myPackage/MyMapping.dwl`

  ```dataweave
  %dw 2.0
  output application/json
  ---
  {
    hello: "world"
  }
  ```

- Input file in `src/test/resources/myPackage/MyMapping/NewScenario/inputs/payload.json`

  ```dataweave
  {
    "message": "Hello world!"
  }
  ```

- Reader properties configuration file in
  `src/test/resources/myPackage/MyMapping/NewScenario/inputs/payload-config.properties`

  ```dataweave
  streaming=false
  ```

- Expected output file in `src/test/resources/myPackage/MyMapping/NewScenario/out.json`

  ```dataweave
  {
    "hello": "world"
  }
  ```

- Test file in `src/test/dw/myPackage/MyMappingTest.dwl`

  ```dataweave
  %dw 2.0
  import * from dw::test::Tests
  import * from dw::test::Asserts
  ---
  "Test MyMapping" describedBy [
     "Assert NewScenario" in do {
         evalPath("myPackage/MyMapping.dwl", inputsFrom("myPackage/MyMapping/NewScenario"),"application/json") must
                   equalTo(outputFrom("myPackage/MyMapping/NewScenario"))
     }
  ]
  ```

## Create a Unit Test for a Module

To create a unit test for a module:

1.  Create a `.dwl` file with a name ending in `Test` in the `src/test/dw/<package>/<testFileName>`
    folder.

2.  In the test file’s header, import `dw::test::Tests`, `dw::test::Asserts`, and the custom module
    you want to test, for example, `"MyModule"`.

3.  In the test file’s body, nest any number of sections (`“sectionName”`) followed by
    `describedBy`, and specify the test name at the end (`“testName”`).

4.  In the code execution and assertion part of the test, call the function you want to test
    (`functionToTest()`) and add an assertion against its result, for example, `must beObject()`.

### Example Unit Test for a Module

Example `src/test/dw/MyModuleTest.dwl` file:

```dataweave
%dw 2.0
import * from dw::test::Tests
import * from dw::test::Asserts

import * from MyModule
---
"MyModule" describedBy [
   "something" describedBy [
       "It should do something" in do {
           something() must beObject()
       },
   ],
]
```

## Create an Integration Test for a Module

To create an integration test for a module:

1.  In your test folder, create a DataWeave mapping that uses the module you want to test.

2.  Follow the steps in [Creating an Integration Test for a Mapping](#create-test).

## Run the Tests from the Command Line

You can run the tests from the command line by running the `mvn test` command:

- To run a single test, use `mvn -Dtest=<MyMappingTest> test`.

- To skip a test, use `mvn install -DskipTests`.

## Matchers

The testing framework includes a set of matchers to use in your tests. See the
[DataWeave assertions module](https://docs.mulesoft.com/dataweave/2.9/dw-test-asserts) for reference information.

## See Also

- [DataWeave Extension](https://docs.mulesoft.com/dataweave/2.9/dataweave-extension)

- [Packaging and Deploying DataWeave Libraries](https://docs.mulesoft.com/dataweave/2.9/dataweave-maven-plugin)

- [Installing and Using the DataWeave Extension](https://docs.mulesoft.com/dataweave/2.9/dataweave-extension-plugin)

<!-- document id=5c920f43bfcf7e1ae7cd2acdcc8a8b41d27d7c89eed0821d699cb3852ba9cb68 url=/mulesoft/current/en-us/dataweave/latest/dataweave-testing-framework.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Testing DataWeave Libraries and Modules

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The DataWeave testing framework enables you to build automated unit and integration tests for your
DataWeave libraries and mappings. You can run tests to evaluate `.dwl` files and compare them to the
output produced by the system you’re testing. The framework provides a full suite of integration and
unit test capabilities with a built-in set of assertion functions, and it is completely integrated
with Maven and Surefire for your continuous deployment environment.

Use snapshot testing for your integration tests by storing the expected outputs as a separate file
rather than as a string literal inside the test code.

You can create tests for your DataWeave mappings and modules either by using the Visual Studio Code
(VS Code) plugin, see [Installing and Using the DataWeave Extension](https://docs.mulesoft.com/dataweave/latest/dataweave-extension-plugin) for
instructions, or manually by modifying your project’s `pom.xml` file.

## Add the DataWeave Testing Framework to Your Project

To enable the DataWeave Testing Framework in your project:

- Add the following Maven dependency to your project’s `pom.xml` file:

  ```xml
   <dependency>
     <groupId>org.mule.weave</groupId>
     <artifactId>data-weave-testing-framework</artifactId>
     <version>${data.weave.testing.framework.version}</version>
     <scope>test</scope>
   </dependency>
  ```

## Tests Structure

The following table shows the different files that compose a test, a description of their
functionalities, and their default locations:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>File</th><th>Description</th><th>Location</th></tr></thead><tbody><tr><td><div><div><p>DataWeave Mapping</p></div></div></td><td><div><div><p>The <code>.dwl</code> file that contains the mapping to test.</p></div></div></td><td><div><div><p><code>src/main/dw/&lt;package&gt;/&lt;mappingFileName&gt;</code></p></div></div></td></tr><tr><td><div><div><p>DataWeave Test</p></div></div></td><td><div><div><p>The <code>.dwl</code> file that contains the tests and assertions to execute.</p></div></div></td><td><div><div><p><code>src/test/dw/&lt;package&gt;/&lt;testFileName&gt;</code></p></div></div></td></tr><tr><td><div><div><p>Input</p></div></div></td><td><div><div><p>The file that contains the input to evaluate against the mapping. Depending on the test, this file is optional.</p></div></div></td><td><div><div><p><code>src/test/resources/&lt;mappingPath&gt;/&lt;scenario&gt;/inputs/&lt;inputFile&gt;</code></p></div></div></td></tr><tr><td><div><div><p>Output</p></div></div></td><td><div><div><p>The file that contains the output to check against the results of the mapping.</p></div></div></td><td><div><div><p><code>src/test/resources/&lt;mappingPath&gt;/&lt;scenario&gt;/&lt;outputFile&gt;</code></p></div></div></td></tr></tbody></table>

## Create an Integration Test for a Mapping

To test a DataWeave mapping, create an integration test by following these steps:

1.  Create a `.dwl` file with a name ending in `Test` in the `src/test/dw/<package>/<testFileName>`
    folder.

2.  In the test file’s header, import the `dw::test::Tests` and `dw::test::Asserts` modules.

3.  In the test file’s body, nest any number of sections (`“sectionName”`), followed by
    `describedBy`, and specify the test name at the end (`“testName”`), followed by
    `in do {<codeExecution/assertion>}`.

4.  In the code execution and assertion part of the test file, specify the following:

    - The `inputsFrom(<inputPath>)` function, to get the inputs to evaluate against the mapping

    - The `evalPath(<mapping/scenario>)` function, to specify the mapping path

    - The `must equalTo` matcher to check the results against the expected output specified by
      function `outputFrom(<mapping/scenario>)`

5.  Add the expected inputs and outputs to the `src/test/resources/<mappingPath>` folder.

6.  If you want to configure the reader properties for the inputs, create a properties file with
    suffix `{fileName}-config.properties` in the `src/test/resources/<mappingPath>/inputs/` folder.

### Example Mapping Test

The following example shows a DataWeave test that contains a DataWeave mapping file, an input file,
a reader properties configuration file, an output file, and a test file, respectively:

- DataWeave mapping in `src/main/dw/myPackage/MyMapping.dwl`

  ```dataweave
  %dw 2.0
  output application/json
  ---
  {
    hello: "world"
  }
  ```

- Input file in `src/test/resources/myPackage/MyMapping/NewScenario/inputs/payload.json`

  ```dataweave
  {
    "message": "Hello world!"
  }
  ```

- Reader properties configuration file in
  `src/test/resources/myPackage/MyMapping/NewScenario/inputs/payload-config.properties`

  ```dataweave
  streaming=false
  ```

- Expected output file in `src/test/resources/myPackage/MyMapping/NewScenario/out.json`

  ```dataweave
  {
    "hello": "world"
  }
  ```

- Test file in `src/test/dw/myPackage/MyMappingTest.dwl`

  ```dataweave
  %dw 2.0
  import * from dw::test::Tests
  import * from dw::test::Asserts
  ---
  "Test MyMapping" describedBy [
     "Assert NewScenario" in do {
         evalPath("myPackage/MyMapping.dwl", inputsFrom("myPackage/MyMapping/NewScenario"),"application/json") must
                   equalTo(outputFrom("myPackage/MyMapping/NewScenario"))
     }
  ]
  ```

## Create a Unit Test for a Module

To create a unit test for a module:

1.  Create a `.dwl` file with a name ending in `Test` in the `src/test/dw/<package>/<testFileName>`
    folder.

2.  In the test file’s header, import `dw::test::Tests`, `dw::test::Asserts`, and the custom module
    you want to test, for example, `"MyModule"`.

3.  In the test file’s body, nest any number of sections (`“sectionName”`) followed by
    `describedBy`, and specify the test name at the end (`“testName”`).

4.  In the code execution and assertion part of the test, call the function you want to test
    (`functionToTest()`) and add an assertion against its result, for example, `must beObject()`.

### Example Unit Test for a Module

Example `src/test/dw/MyModuleTest.dwl` file:

```dataweave
%dw 2.0
import * from dw::test::Tests
import * from dw::test::Asserts

import * from MyModule
---
"MyModule" describedBy [
   "something" describedBy [
       "It should do something" in do {
           something() must beObject()
       },
   ],
]
```

## Create an Integration Test for a Module

To create an integration test for a module:

1.  In your test folder, create a DataWeave mapping that uses the module you want to test.

2.  Follow the steps in [Creating an Integration Test for a Mapping](#create-test).

## Run the Tests from the Command Line

You can run the tests from the command line by running the `mvn test` command:

- To run a single test, use `mvn -Dtest=<MyMappingTest> test`.

- To skip a test, use `mvn install -DskipTests`.

## Matchers

The testing framework includes a set of matchers to use in your tests. See the
[DataWeave assertions module](https://docs.mulesoft.com/dataweave/latest/dw-test-asserts) for reference information.

## See Also

- [DataWeave Extension](https://docs.mulesoft.com/dataweave/latest/dataweave-extension)

- [Packaging and Deploying DataWeave Libraries](https://docs.mulesoft.com/dataweave/latest/dataweave-maven-plugin)

- [Installing and Using the DataWeave Extension](https://docs.mulesoft.com/dataweave/latest/dataweave-extension-plugin)

<!-- document id=8fbb4dcb3bc8df91ef316016f222dc02ae464ae2c2f057a8146a0dc591b37e4d url=/mulesoft/current/en-us/dataweave/2.11/dataweave-formats-properties.md -->

---
product: DataWeave
version: 2.11
keywords: format, properties, */x-java-properties, */properties, text/x-java-properties
---

# Text Java Properties Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `text/x-java-properties`

ID: `properties`

The Text Java Properties format parses any Java properties file. This format represents simple
key-value pairs. DataWeave represents these pairs as an object with string values.

## Example: Represent a properties File in the DataWeave Format (dw)

This example shows how DataWeave represents a properties file.

### Input

The following `text/x-java-properties` data is from a properties file. The file contains key-value
pairs that provide host and port values. This content serves as the input payload to the DataWeave
script.

```properties
host=localhost
port=1234
```

### Source

The DataWeave script transforms the `text/x-java-properties` input payload to the DataWeave (dw)
format and MIME type. It returns a string.

```dataweave
%dw 2.0
output application/dw
---
payload
```

### Output

The output is an object in the DataWeave (dw) format. The object contains a collection of key-value
pairs that match the `text/x-java-properties` input. Notice that the output wraps the values in
quotation marks.

```dataweave
{
    host: "localhost",
    port: "1234"
}
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

There are no reader properties for this format.

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/x-java-properties</code></p></td></tr><tr><td><p><code>*/properties</code></p></td></tr></tbody></table>

<!-- document id=5a62422de952f1e3d1b6708d4596e2d0a30b5691e5c9e9168e26f231fd4be258 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-formats-properties.md -->

---
product: DataWeave
version: 2.12
keywords: format, properties, */x-java-properties, */properties, text/x-java-properties
---

# Text Java Properties Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `text/x-java-properties`

ID: `properties`

The Text Java Properties format parses any Java properties file. This format represents simple
key-value pairs. DataWeave represents these pairs as an object with string values.

## Example: Represent a properties File in the DataWeave Format (dw)

This example shows how DataWeave represents a properties file.

### Input

The following `text/x-java-properties` data is from a properties file. The file contains key-value
pairs that provide host and port values. This content serves as the input payload to the DataWeave
script.

```properties
host=localhost
port=1234
```

### Source

The DataWeave script transforms the `text/x-java-properties` input payload to the DataWeave (dw)
format and MIME type. It returns a string.

```dataweave
%dw 2.0
output application/dw
---
payload
```

### Output

The output is an object in the DataWeave (dw) format. The object contains a collection of key-value
pairs that match the `text/x-java-properties` input. Notice that the output wraps the values in
quotation marks.

```dataweave
{
    host: "localhost",
    port: "1234"
}
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

There are no reader properties for this format.

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/x-java-properties</code></p></td></tr><tr><td><p><code>*/properties</code></p></td></tr></tbody></table>

<!-- document id=0f311c0e964911c0ec1277e8bfa4510f5e8463584e2abe6d0fb30e5f1b540c2c url=/mulesoft/current/en-us/dataweave/2.3/dataweave-formats-properties.md -->

---
product: DataWeave
version: 2.3
---

# Text Java Properties Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME Type: `text/x-java-properties`

ID: `properties`

The Text Java Properties format parses any Java properties file. This format represents simple
key-value pairs. DataWeave represents these pairs as an object with string values.

## Example: Represent a properties File in the DataWeave Format (dw)

This example shows how DataWeave represents a properties file.

### Input

The following `text/x-java-properties` data is from a properties file. The file contains key-value
pairs that provide host and port values. This content serves as the input payload to the DataWeaave
script.

```properties
host=localhost
port=1234
```

### Source

The DataWeave script transforms the `text/x-java-properties` input payload to the DataWeave (dw)
format and MIME type. It returns a string.

```dataweave
%dw 2.0
output application/dw
---
payload
```

### Output

The output is an object in the DataWeave (dw) format. The object contains a collection of key-value
pairs that match the `text/x-java-properties` input. Notice that the output wraps the values in
quotation marks.

```dataweave
{
    host: "localhost",
    port: "1234"
}
```

## Configuration Properties

DataWeave supports the following configuration properties for the Text Java Properties format.

### Reader Properties

There are no reader properties for this format.

### Writer Properties

The Text Java Properties format accepts properties that provide instructions for writing output
data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the writer buffer.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>When set to <code>true</code>, DataWeave generates the output as a data stream, and the script’s execution is deferred until it is consumed. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Encoding for the writer to use.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

The Java Properties format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/x-java-properties</code></p></td></tr><tr><td><p><code>*/properties</code></p></td></tr></tbody></table>

<!-- document id=ed07fcb4260eec63e125d2491af24802487ab5825170c5d0dc586dd774277f86 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-formats-properties.md -->

---
product: DataWeave
version: 2.4
keywords: format, properties, */x-java-properties, */properties, text/x-java-properties
---

# Text Java Properties Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `text/x-java-properties`

ID: `properties`

The Text Java Properties format parses any Java properties file. This format represents simple
key-value pairs. DataWeave represents these pairs as an object with string values.

## Example: Represent a properties File in the DataWeave Format (dw)

This example shows how DataWeave represents a properties file.

### Input

The following `text/x-java-properties` data is from a properties file. The file contains key-value
pairs that provide host and port values. This content serves as the input payload to the DataWeave
script.

```properties
host=localhost
port=1234
```

### Source

The DataWeave script transforms the `text/x-java-properties` input payload to the DataWeave (dw)
format and MIME type. It returns a string.

```dataweave
%dw 2.0
output application/dw
---
payload
```

### Output

The output is an object in the DataWeave (dw) format. The object contains a collection of key-value
pairs that match the `text/x-java-properties` input. Notice that the output wraps the values in
quotation marks.

```dataweave
{
    host: "localhost",
    port: "1234"
}
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

There are no reader properties for this format.

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The character set to use for the output, such as UTF-8.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/x-java-properties</code></p></td></tr><tr><td><p><code>*/properties</code></p></td></tr></tbody></table>

<!-- document id=c3ee5c3e2e389da5b89044c224a814281d98ef680b616494cd81f070ff0bd410 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-formats-properties.md -->

---
product: DataWeave
version: 2.6
keywords: format, properties, */x-java-properties, */properties, text/x-java-properties
---

# Text Java Properties Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `text/x-java-properties`

ID: `properties`

The Text Java Properties format parses any Java properties file. This format represents simple
key-value pairs. DataWeave represents these pairs as an object with string values.

## Example: Represent a properties File in the DataWeave Format (dw)

This example shows how DataWeave represents a properties file.

### Input

The following `text/x-java-properties` data is from a properties file. The file contains key-value
pairs that provide host and port values. This content serves as the input payload to the DataWeave
script.

```properties
host=localhost
port=1234
```

### Source

The DataWeave script transforms the `text/x-java-properties` input payload to the DataWeave (dw)
format and MIME type. It returns a string.

```dataweave
%dw 2.0
output application/dw
---
payload
```

### Output

The output is an object in the DataWeave (dw) format. The object contains a collection of key-value
pairs that match the `text/x-java-properties` input. Notice that the output wraps the values in
quotation marks.

```dataweave
{
    host: "localhost",
    port: "1234"
}
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

There are no reader properties for this format.

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/x-java-properties</code></p></td></tr><tr><td><p><code>*/properties</code></p></td></tr></tbody></table>

<!-- document id=6da56f1c837649fa4588dc783ac0468a023b0dbe92e65cbb3a3fd99642095635 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-formats-properties.md -->

---
product: DataWeave
version: 2.9
keywords: format, properties, */x-java-properties, */properties, text/x-java-properties
---

# Text Java Properties Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `text/x-java-properties`

ID: `properties`

The Text Java Properties format parses any Java properties file. This format represents simple
key-value pairs. DataWeave represents these pairs as an object with string values.

## Example: Represent a properties File in the DataWeave Format (dw)

This example shows how DataWeave represents a properties file.

### Input

The following `text/x-java-properties` data is from a properties file. The file contains key-value
pairs that provide host and port values. This content serves as the input payload to the DataWeave
script.

```properties
host=localhost
port=1234
```

### Source

The DataWeave script transforms the `text/x-java-properties` input payload to the DataWeave (dw)
format and MIME type. It returns a string.

```dataweave
%dw 2.0
output application/dw
---
payload
```

### Output

The output is an object in the DataWeave (dw) format. The object contains a collection of key-value
pairs that match the `text/x-java-properties` input. Notice that the output wraps the values in
quotation marks.

```dataweave
{
    host: "localhost",
    port: "1234"
}
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

There are no reader properties for this format.

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/x-java-properties</code></p></td></tr><tr><td><p><code>*/properties</code></p></td></tr></tbody></table>

<!-- document id=bdae80b4f6396d0933a97de1d0334cd9820844594b5231d636b19bfb36ca3811 url=/mulesoft/current/en-us/dataweave/latest/dataweave-formats-properties.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: format, properties, */x-java-properties, */properties, text/x-java-properties
---

# Text Java Properties Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `text/x-java-properties`

ID: `properties`

The Text Java Properties format parses any Java properties file. This format represents simple
key-value pairs. DataWeave represents these pairs as an object with string values.

## Example: Represent a properties File in the DataWeave Format (dw)

This example shows how DataWeave represents a properties file.

### Input

The following `text/x-java-properties` data is from a properties file. The file contains key-value
pairs that provide host and port values. This content serves as the input payload to the DataWeave
script.

```properties
host=localhost
port=1234
```

### Source

The DataWeave script transforms the `text/x-java-properties` input payload to the DataWeave (dw)
format and MIME type. It returns a string.

```dataweave
%dw 2.0
output application/dw
---
payload
```

### Output

The output is an object in the DataWeave (dw) format. The object contains a collection of key-value
pairs that match the `text/x-java-properties` input. Notice that the output wraps the values in
quotation marks.

```dataweave
{
    host: "localhost",
    port: "1234"
}
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

There are no reader properties for this format.

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/x-java-properties</code></p></td></tr><tr><td><p><code>*/properties</code></p></td></tr></tbody></table>

<!-- document id=ea9289a780bbcdc17c98bba05b2112087f7cec965a8c2b3ba7458af86569e6d8 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-formats-text.md -->

---
product: DataWeave
version: 2.11
keywords: format, text, text/plain, text/plain
---

# Text Plain Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `text/plain`

ID: `text`

The Text Plain format represents text as a string.

Note that DataWeave parses, encodes, and stores this format into RAM memory.

## Example

This example shows how DataWeave represents Text Plain data.

### Input

The Plain Text data serves as the input payload to the DataWeave source.

```txt
This is text plain
```

### Source

The DataWeave script transforms the Text PLain input payload to the DataWeave (dw) format and MIME
type. It returns a string.

```dataweave
output application/dw
---
payload
```

### Output

Because the DataWeave (dw) output is a string, it is wrapped in quotation marks.

```dataweave
"This is text plain"
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

There are no reader properties for this format.

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>text/plain</code></p></td></tr></tbody></table>

<!-- document id=56d81103bb3acde5437269247eaafbd573ac7861d8834128f465e96ee3208d5f url=/mulesoft/current/en-us/dataweave/2.12/dataweave-formats-text.md -->

---
product: DataWeave
version: 2.12
keywords: format, text, text/plain, text/plain
---

# Text Plain Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `text/plain`

ID: `text`

The Text Plain format represents text as a string.

Note that DataWeave parses, encodes, and stores this format into RAM memory.

## Example

This example shows how DataWeave represents Text Plain data.

### Input

The Plain Text data serves as the input payload to the DataWeave source.

```txt
This is text plain
```

### Source

The DataWeave script transforms the Text PLain input payload to the DataWeave (dw) format and MIME
type. It returns a string.

```dataweave
output application/dw
---
payload
```

### Output

Because the DataWeave (dw) output is a string, it is wrapped in quotation marks.

```dataweave
"This is text plain"
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

There are no reader properties for this format.

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>text/plain</code></p></td></tr></tbody></table>

<!-- document id=0b5127b0d8601bd5e4c58e65979a52dd0f9c93de2801c4c4a9805e0232fc5611 url=/mulesoft/current/en-us/dataweave/2.3/dataweave-formats-text.md -->

---
product: DataWeave
version: 2.3
---

# Text Plain Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME Type: `text/plain`

ID: `text`

The Text Plain format represents text as a string.

Note that DataWeave parses, encodes, and stores this format into RAM memory.

## Example

This example shows how DataWeave represents Text Plain data.

### Input

The Plain Text data serves as the input payload to the DataWeave source.

```txt
This is text plain
```

### Source

The DataWeave script transforms the Text PLain input payload to the DataWeave (dw) format and MIME
type. It returns a string.

```dataweave
output application/dw
---
payload
```

### Output

Because the DataWeave (dw) output is a string, it is wrapped in quotation marks.

```dataweave
"This is text plain"
```

## Configuration Properties

DataWeave supports the following configuration properties for the Text Plain format.

### Reader Properties

There are no reader properties for Text Plain data.

### Writer Properties

The Text Plain format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the writer buffer.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>When set to <code>true</code>, DataWeave generates the output as a data stream, and the script’s execution is deferred until it is consumed. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Encoding for the writer to use.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

The Text Plain format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>text/plain</code></p></td></tr></tbody></table>

<!-- document id=7a57bfe90062b3b3737304bcea7eafe6b712335a42326bfef5cc64603aa7f431 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-formats-text.md -->

---
product: DataWeave
version: 2.4
keywords: format, text, text/plain, text/plain
---

# Text Plain Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `text/plain`

ID: `text`

The Text Plain format represents text as a string.

Note that DataWeave parses, encodes, and stores this format into RAM memory.

## Example

This example shows how DataWeave represents Text Plain data.

### Input

The Plain Text data serves as the input payload to the DataWeave source.

```txt
This is text plain
```

### Source

The DataWeave script transforms the Text PLain input payload to the DataWeave (dw) format and MIME
type. It returns a string.

```dataweave
output application/dw
---
payload
```

### Output

Because the DataWeave (dw) output is a string, it is wrapped in quotation marks.

```dataweave
"This is text plain"
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

There are no reader properties for this format.

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The character set to use for the output, such as UTF-8.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>text/plain</code></p></td></tr></tbody></table>

<!-- document id=3bc33efda80f6cdd56ae4caf158fca625a4da4d1d87b715d8772ff54c69288e4 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-formats-text.md -->

---
product: DataWeave
version: 2.6
keywords: format, text, text/plain, text/plain
---

# Text Plain Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `text/plain`

ID: `text`

The Text Plain format represents text as a string.

Note that DataWeave parses, encodes, and stores this format into RAM memory.

## Example

This example shows how DataWeave represents Text Plain data.

### Input

The Plain Text data serves as the input payload to the DataWeave source.

```txt
This is text plain
```

### Source

The DataWeave script transforms the Text PLain input payload to the DataWeave (dw) format and MIME
type. It returns a string.

```dataweave
output application/dw
---
payload
```

### Output

Because the DataWeave (dw) output is a string, it is wrapped in quotation marks.

```dataweave
"This is text plain"
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

There are no reader properties for this format.

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>text/plain</code></p></td></tr></tbody></table>

<!-- document id=85d7cf8092a80dd099825fa1251c7175cd91656ae63ac55fb61a41c4db5a024c url=/mulesoft/current/en-us/dataweave/2.9/dataweave-formats-text.md -->

---
product: DataWeave
version: 2.9
keywords: format, text, text/plain, text/plain
---

# Text Plain Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `text/plain`

ID: `text`

The Text Plain format represents text as a string.

Note that DataWeave parses, encodes, and stores this format into RAM memory.

## Example

This example shows how DataWeave represents Text Plain data.

### Input

The Plain Text data serves as the input payload to the DataWeave source.

```txt
This is text plain
```

### Source

The DataWeave script transforms the Text PLain input payload to the DataWeave (dw) format and MIME
type. It returns a string.

```dataweave
output application/dw
---
payload
```

### Output

Because the DataWeave (dw) output is a string, it is wrapped in quotation marks.

```dataweave
"This is text plain"
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

There are no reader properties for this format.

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>text/plain</code></p></td></tr></tbody></table>

<!-- document id=c803b62177c95ff94de2d9f5315f7da1e530070cfccf01e99355e68ff1ed646c url=/mulesoft/current/en-us/dataweave/latest/dataweave-formats-text.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: format, text, text/plain, text/plain
---

# Text Plain Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `text/plain`

ID: `text`

The Text Plain format represents text as a string.

Note that DataWeave parses, encodes, and stores this format into RAM memory.

## Example

This example shows how DataWeave represents Text Plain data.

### Input

The Plain Text data serves as the input payload to the DataWeave source.

```txt
This is text plain
```

### Source

The DataWeave script transforms the Text PLain input payload to the DataWeave (dw) format and MIME
type. It returns a string.

```dataweave
output application/dw
---
payload
```

### Output

Because the DataWeave (dw) output is a string, it is wrapped in quotation marks.

```dataweave
"This is text plain"
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

There are no reader properties for this format.

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>text/plain</code></p></td></tr></tbody></table>

<!-- document id=6515227575707a4e97fc14dda69b3b1e92f4eb9f9261835084b0a5a966c50586 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-then.md -->

---
product: DataWeave
version: 2.11
---

# then

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## then(value: Null, callback: (previousResult: Nothing) -> Any): Null

Helper function that enables `then` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

## then<T, R>(previous: T, callback: (result: T) -> R): R

This function works as a pipe that passes the value returned from the preceding expression to the
next (a callback) only if the value returned by the preceding expression is not `null`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>previous</code></p></td><td><p>The value of the preceding expression.</p></td></tr><tr><td><p><code>callback</code></p></td><td><p>Callback that processes the result of <code>previous</code> if the result is not <code>null</code>.</p></td></tr></tbody></table>

### Example

This example shows how to use `then` to chain and continue processing the result of the previous
expression.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
    "chainResult": ["mariano", "de Achaval"]
            reduce ((item, accumulator) -> item ++ accumulator)
            then ((result) -> sizeOf(result)),
    "referenceResult" : ["mariano", "de Achaval"]
                         map ((item, index) -> upper(item))
                         then {
                            name: $[0],
                            lastName: $[1],
                            length: sizeOf($)
                        },
    "onNullReturnNull": []
                reduce ((item, accumulator) -> item ++ accumulator)
                then ((result) -> sizeOf(result))
}
```

#### Output

```Json
{
   "chainResult": 17,
   "referenceResult": {
     "name": "MARIANO",
     "lastName": "DE ACHAVAL",
     "length": 2
   },
   "onNullReturnNull": null
 }
```

<!-- document id=6fa6b010cc2e6638574692df1daefa408690bec9f94290dd671a472850025067 url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-then.md -->

---
product: DataWeave
version: 2.12
---

# then

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## then(value: Null, callback: (previousResult: Nothing) -> Any): Null

Helper function that enables `then` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

## then<T, R>(previous: T, callback: (result: T) -> R): R

This function works as a pipe that passes the value returned from the preceding expression to the
next (a callback) only if the value returned by the preceding expression is not `null`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>previous</code></p></td><td><p>The value of the preceding expression.</p></td></tr><tr><td><p><code>callback</code></p></td><td><p>Callback that processes the result of <code>previous</code> if the result is not <code>null</code>.</p></td></tr></tbody></table>

### Example

This example shows how to use `then` to chain and continue processing the result of the previous
expression.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
    "chainResult": ["mariano", "de Achaval"]
            reduce ((item, accumulator) -> item ++ accumulator)
            then ((result) -> sizeOf(result)),
    "referenceResult" : ["mariano", "de Achaval"]
                         map ((item, index) -> upper(item))
                         then {
                            name: $[0],
                            lastName: $[1],
                            length: sizeOf($)
                        },
    "onNullReturnNull": []
                reduce ((item, accumulator) -> item ++ accumulator)
                then ((result) -> sizeOf(result))
}
```

#### Output

```Json
{
   "chainResult": 17,
   "referenceResult": {
     "name": "MARIANO",
     "lastName": "DE ACHAVAL",
     "length": 2
   },
   "onNullReturnNull": null
 }
```

<!-- document id=0ae0d06b8418959c533f2d0c2556335ebdf5bae0370af6d54baf6a2bc461baae url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-then.md -->

---
product: DataWeave
version: 2.4
---

# then

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## then(value: Null, callback: (previousResult: Nothing) -> Any): Null

Helper function that enables `then` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

## then<T, R>(previous: T, callback: (result: T) -> R): R

This function works as a pipe that passes the value returned from the preceding expression to the
next (a callback) only if the value returned by the preceding expression is not `null`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>previous</code></p></td><td><p>The value of the preceding expression.</p></td></tr><tr><td><p><code>callback</code></p></td><td><p>Callback that processes the result of <code>previous</code> if the result is not <code>null</code>.</p></td></tr></tbody></table>

### Example

This example shows how to use `then` to chain and continue processing the result of the previous
expression.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
    "chainResult": ["mariano", "de Achaval"]
            reduce ((item, accumulator) -> item ++ accumulator)
            then ((result) -> sizeOf(result)),
    "referenceResult" : ["mariano", "de Achaval"]
                         map ((item, index) -> upper(item))
                         then {
                            name: $[0],
                            lastName: $[1],
                            length: sizeOf($)
                        },
    "onNullReturnNull": []
                reduce ((item, accumulator) -> item ++ accumulator)
                then ((result) -> sizeOf(result))
}
```

#### Output

```Json
{
   "chainResult": 17,
   "referenceResult": {
     "name": "MARIANO",
     "lastName": "DE ACHAVAL",
     "length": 2
   },
   "onNullReturnNull": null
 }
```

<!-- document id=c8ab2b4973f7c90f7b9f315ebc67514d9b157c1342faa90bbd197c6e9c34ec40 url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-then.md -->

---
product: DataWeave
version: 2.6
---

# then

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## then(value: Null, callback: (previousResult: Nothing) -> Any): Null

Helper function that enables `then` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

## then<T, R>(previous: T, callback: (result: T) -> R): R

This function works as a pipe that passes the value returned from the preceding expression to the
next (a callback) only if the value returned by the preceding expression is not `null`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>previous</code></p></td><td><p>The value of the preceding expression.</p></td></tr><tr><td><p><code>callback</code></p></td><td><p>Callback that processes the result of <code>previous</code> if the result is not <code>null</code>.</p></td></tr></tbody></table>

### Example

This example shows how to use `then` to chain and continue processing the result of the previous
expression.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
    "chainResult": ["mariano", "de Achaval"]
            reduce ((item, accumulator) -> item ++ accumulator)
            then ((result) -> sizeOf(result)),
    "referenceResult" : ["mariano", "de Achaval"]
                         map ((item, index) -> upper(item))
                         then {
                            name: $[0],
                            lastName: $[1],
                            length: sizeOf($)
                        },
    "onNullReturnNull": []
                reduce ((item, accumulator) -> item ++ accumulator)
                then ((result) -> sizeOf(result))
}
```

#### Output

```Json
{
   "chainResult": 17,
   "referenceResult": {
     "name": "MARIANO",
     "lastName": "DE ACHAVAL",
     "length": 2
   },
   "onNullReturnNull": null
 }
```

<!-- document id=016c8d103046a90e5693e3d00695fef98c050cff7866caca4889a27f09627f6d url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-then.md -->

---
product: DataWeave
version: 2.9
---

# then

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## then(value: Null, callback: (previousResult: Nothing) -> Any): Null

Helper function that enables `then` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

## then<T, R>(previous: T, callback: (result: T) -> R): R

This function works as a pipe that passes the value returned from the preceding expression to the
next (a callback) only if the value returned by the preceding expression is not `null`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>previous</code></p></td><td><p>The value of the preceding expression.</p></td></tr><tr><td><p><code>callback</code></p></td><td><p>Callback that processes the result of <code>previous</code> if the result is not <code>null</code>.</p></td></tr></tbody></table>

### Example

This example shows how to use `then` to chain and continue processing the result of the previous
expression.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
    "chainResult": ["mariano", "de Achaval"]
            reduce ((item, accumulator) -> item ++ accumulator)
            then ((result) -> sizeOf(result)),
    "referenceResult" : ["mariano", "de Achaval"]
                         map ((item, index) -> upper(item))
                         then {
                            name: $[0],
                            lastName: $[1],
                            length: sizeOf($)
                        },
    "onNullReturnNull": []
                reduce ((item, accumulator) -> item ++ accumulator)
                then ((result) -> sizeOf(result))
}
```

#### Output

```Json
{
   "chainResult": 17,
   "referenceResult": {
     "name": "MARIANO",
     "lastName": "DE ACHAVAL",
     "length": 2
   },
   "onNullReturnNull": null
 }
```

<!-- document id=0f63bfdf11d702b52076df773cfba7e826280b675741f834e15b7388cb7202f6 url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-then.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# then

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## then(value: Null, callback: (previousResult: Nothing) -> Any): Null

Helper function that enables `then` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

## then<T, R>(previous: T, callback: (result: T) -> R): R

This function works as a pipe that passes the value returned from the preceding expression to the
next (a callback) only if the value returned by the preceding expression is not `null`.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>previous</code></p></td><td><p>The value of the preceding expression.</p></td></tr><tr><td><p><code>callback</code></p></td><td><p>Callback that processes the result of <code>previous</code> if the result is not <code>null</code>.</p></td></tr></tbody></table>

### Example

This example shows how to use `then` to chain and continue processing the result of the previous
expression.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
    "chainResult": ["mariano", "de Achaval"]
            reduce ((item, accumulator) -> item ++ accumulator)
            then ((result) -> sizeOf(result)),
    "referenceResult" : ["mariano", "de Achaval"]
                         map ((item, index) -> upper(item))
                         then {
                            name: $[0],
                            lastName: $[1],
                            length: sizeOf($)
                        },
    "onNullReturnNull": []
                reduce ((item, accumulator) -> item ++ accumulator)
                then ((result) -> sizeOf(result))
}
```

#### Output

```Json
{
   "chainResult": 17,
   "referenceResult": {
     "name": "MARIANO",
     "lastName": "DE ACHAVAL",
     "length": 2
   },
   "onNullReturnNull": null
 }
```

<!-- document id=d227bfe5fc2d0d5833339d02f6ae79cd233d62ef69ef8a8906b0de7e3dc8332b url=/mulesoft/current/en-us/dataweave/2.11/dw-dates-functions-time.md -->

---
product: DataWeave
version: 2.11
---

# time

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## time(parts: TimeFactory): Time

Creates a `Time` value from values specified for `hour`, `minutes`, `seconds`, and `timezone`
fields.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>parts</code></p></td><td><div><div><p><code>Number</code> values for <code>hour</code>, <code>minutes</code>, and <code>seconds</code> fields, and a <code>TimeZone</code> value for the <code>timezone</code> field. Valid values are 0 through 23 for the <code>hour</code>, 0 through 59 for <code>minutes</code>, and 0 through 59 (including decimals, such as 59.99) for <code>seconds</code> fields. The <code>timezone</code> must be a valid <code>TimeZone</code> value, such as <code>|-03:00|</code> You can specify the name-value pairs in any order, but the output is ordered as a default <code>Time</code> value, such as <code>10:10:10-03:00</code>. The input fields are parts of a <code>TimeFactory</code> type.</p></div></div></td></tr></tbody></table>

### Example

This example shows how to create a value of type `Time`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  newTime: time({ hour: 12, minutes: 30, seconds: 40 , timeZone: |-03:00| })
}
```

#### Output

```Json
{
   "newTime": "12:30:40-03:00"
}
```

<!-- document id=630600c0b2a173efd6b2b293dcdc775542764b81fd5709e12085f16faa9742a5 url=/mulesoft/current/en-us/dataweave/2.11/dw-timer-functions-time.md -->

---
product: DataWeave
version: 2.11
---

# time

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## time<T>(valueToMeasure: () -> T): TimeMeasurement<T>

Executes the input function and returns a `TimeMeasurement` object that contains the start and end
time for the execution of that function, as well the result of the function.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>valueToMeasure</code></p></td><td><p>A function to pass to <code>time</code>.</p></td></tr></tbody></table>

### Example

This example passes `wait` and `sum` functions (defined in the header), which return their results
in `TimeMeasurement` objects.

```Dataweave
%dw 2.0
output application/json
fun myFunction() = dw::Runtime::wait("My result",100)
fun myFunction2() = sum([1,2,3,4])
---
{ testing: [
    dw::util::Timer::time(() -> myFunction()),
    dw::util::Timer::time(() -> myFunction2())
  ]
}
```

#### Output

```XML
{
  "testing": [
    {
      "start": "2018-10-05T19:23:01.49Z",
      "result": "My result",
      "end": "2018-10-05T19:23:01.591Z"
    },
    {
      "start": "2018-10-05T19:23:01.591Z",
      "result": 10,
      "end": "2018-10-05T19:23:01.591Z"
    }
  ]
}
```

<!-- document id=ff2ec0356f5c2e09a1ee600f0ecf8f0cf5425725278b4e8e914e532db73be517 url=/mulesoft/current/en-us/dataweave/2.12/dw-dates-functions-time.md -->

---
product: DataWeave
version: 2.12
---

# time

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## time(parts: TimeFactory): Time

Creates a `Time` value from values specified for `hour`, `minutes`, `seconds`, and `timezone`
fields.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>parts</code></p></td><td><div><div><p><code>Number</code> values for <code>hour</code>, <code>minutes</code>, and <code>seconds</code> fields, and a <code>TimeZone</code> value for the <code>timezone</code> field. Valid values are 0 through 23 for the <code>hour</code>, 0 through 59 for <code>minutes</code>, and 0 through 59 (including decimals, such as 59.99) for <code>seconds</code> fields. The <code>timezone</code> must be a valid <code>TimeZone</code> value, such as <code>|-03:00|</code> You can specify the name-value pairs in any order, but the output is ordered as a default <code>Time</code> value, such as <code>10:10:10-03:00</code>. The input fields are parts of a <code>TimeFactory</code> type.</p></div></div></td></tr></tbody></table>

### Example

This example shows how to create a value of type `Time`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  newTime: time({ hour: 12, minutes: 30, seconds: 40 , timeZone: |-03:00| })
}
```

#### Output

```Json
{
   "newTime": "12:30:40-03:00"
}
```

<!-- document id=2fc0babdb38503d6e7e013743bc9dc2e8863dadf5f27e150bb74870a5baaf321 url=/mulesoft/current/en-us/dataweave/2.12/dw-timer-functions-time.md -->

---
product: DataWeave
version: 2.12
---

# time

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## time<T>(valueToMeasure: () -> T): TimeMeasurement<T>

Executes the input function and returns a `TimeMeasurement` object that contains the start and end
time for the execution of that function, as well the result of the function.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>valueToMeasure</code></p></td><td><p>A function to pass to <code>time</code>.</p></td></tr></tbody></table>

### Example

This example passes `wait` and `sum` functions (defined in the header), which return their results
in `TimeMeasurement` objects.

```Dataweave
%dw 2.0
output application/json
fun myFunction() = dw::Runtime::wait("My result",100)
fun myFunction2() = sum([1,2,3,4])
---
{ testing: [
    dw::util::Timer::time(() -> myFunction()),
    dw::util::Timer::time(() -> myFunction2())
  ]
}
```

#### Output

```XML
{
  "testing": [
    {
      "start": "2018-10-05T19:23:01.49Z",
      "result": "My result",
      "end": "2018-10-05T19:23:01.591Z"
    },
    {
      "start": "2018-10-05T19:23:01.591Z",
      "result": 10,
      "end": "2018-10-05T19:23:01.591Z"
    }
  ]
}
```

<!-- document id=5964ab1b61d76f188125b95c690cc48bba1b1b6e7d1c76134886fbdb97fb53be url=/mulesoft/current/en-us/dataweave/2.3/dw-timer-functions-time.md -->

---
product: DataWeave
version: 2.3
---

# time

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## time(() -> T): TimeMeasurement<T>

Executes the input function and returns a `TimeMeasurement` object that contains the start and end
time for the execution of that function, as well the result of the function.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>valueToMeasure</code></p></td><td><p>A function to pass to <code>time</code>.</p></td></tr></tbody></table>

### Example

This example passes `wait` and `sum` functions (defined in the header), which return their results
in `TimeMeasurement` objects.

```Dataweave
%dw 2.0
output application/json
fun myFunction() = dw::Runtime::wait("My result",100)
fun myFunction2() = sum([1,2,3,4])
---
{ testing: [
    dw::util::Timer::time(() -> myFunction()),
    dw::util::Timer::time(() -> myFunction2())
  ]
}
```

#### Output

```XML
{
  "testing": [
    {
      "start": "2018-10-05T19:23:01.49Z",
      "result": "My result",
      "end": "2018-10-05T19:23:01.591Z"
    },
    {
      "start": "2018-10-05T19:23:01.591Z",
      "result": 10,
      "end": "2018-10-05T19:23:01.591Z"
    }
  ]
}
```

<!-- document id=2c5dcd025be9a26fe0e0a750f4c171c8a93770f5a1c6e8739146122d9672c5af url=/mulesoft/current/en-us/dataweave/2.4/dw-dates-functions-time.md -->

---
product: DataWeave
version: 2.4
---

# time

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## time(parts: TimeFactory): Time

Creates a `Time` value from values specified for `hour`, `minutes`, `seconds`, and `timezone`
fields.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>parts</code></p></td><td><div><div><p><code>Number</code> values for <code>hour</code>, <code>minutes</code>, and <code>seconds</code> fields, and a <code>TimeZone</code> value for the <code>timezone</code> field. Valid values are 0 through 23 for the <code>hour</code>, 0 through 59 for <code>minutes</code>, and 0 through 59 (including decimals, such as 59.99) for <code>seconds</code> fields. The <code>timezone</code> must be a valid <code>TimeZone</code> value, such as <code>|-03:00|</code> You can specify the name-value pairs in any order, but the output is ordered as a default <code>Time</code> value, such as <code>10:10:10-03:00</code>. The input fields are parts of a <code>TimeFactory</code> type.</p></div></div></td></tr></tbody></table>

### Example

This example shows how to create a value of type `Time`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  newTime: time({ hour: 12, minutes: 30, seconds: 40 , timeZone: |-03:00|})
}
```

#### Output

```Json
{
   "newTime": "12:30:40-03:00"
}
```

<!-- document id=bc5972c8da0a090ec5d4aa8259244f16487c406fba9975606b238b2437e1c765 url=/mulesoft/current/en-us/dataweave/2.4/dw-timer-functions-time.md -->

---
product: DataWeave
version: 2.4
---

# time

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## time<T>(valueToMeasure: () -> T): TimeMeasurement<T>

Executes the input function and returns a `TimeMeasurement` object that contains the start and end
time for the execution of that function, as well the result of the function.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>valueToMeasure</code></p></td><td><p>A function to pass to <code>time</code>.</p></td></tr></tbody></table>

### Example

This example passes `wait` and `sum` functions (defined in the header), which return their results
in `TimeMeasurement` objects.

```Dataweave
%dw 2.0
output application/json
fun myFunction() = dw::Runtime::wait("My result",100)
fun myFunction2() = sum([1,2,3,4])
---
{ testing: [
    dw::util::Timer::time(() -> myFunction()),
    dw::util::Timer::time(() -> myFunction2())
  ]
}
```

#### Output

```XML
{
  "testing": [
    {
      "start": "2018-10-05T19:23:01.49Z",
      "result": "My result",
      "end": "2018-10-05T19:23:01.591Z"
    },
    {
      "start": "2018-10-05T19:23:01.591Z",
      "result": 10,
      "end": "2018-10-05T19:23:01.591Z"
    }
  ]
}
```

<!-- document id=c6f6a61d3620f9dcbc308bb11c32f219e71865aabba0eedc1c6d79dd22634115 url=/mulesoft/current/en-us/dataweave/2.6/dw-dates-functions-time.md -->

---
product: DataWeave
version: 2.6
---

# time

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## time(parts: TimeFactory): Time

Creates a `Time` value from values specified for `hour`, `minutes`, `seconds`, and `timezone`
fields.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>parts</code></p></td><td><div><div><p><code>Number</code> values for <code>hour</code>, <code>minutes</code>, and <code>seconds</code> fields, and a <code>TimeZone</code> value for the <code>timezone</code> field. Valid values are 0 through 23 for the <code>hour</code>, 0 through 59 for <code>minutes</code>, and 0 through 59 (including decimals, such as 59.99) for <code>seconds</code> fields. The <code>timezone</code> must be a valid <code>TimeZone</code> value, such as <code>|-03:00|</code> You can specify the name-value pairs in any order, but the output is ordered as a default <code>Time</code> value, such as <code>10:10:10-03:00</code>. The input fields are parts of a <code>TimeFactory</code> type.</p></div></div></td></tr></tbody></table>

### Example

This example shows how to create a value of type `Time`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  newTime: time({ hour: 12, minutes: 30, seconds: 40 , timeZone: |-03:00| })
}
```

#### Output

```Json
{
   "newTime": "12:30:40-03:00"
}
```

<!-- document id=4ba41d7eef78f1406bc9bf5768deaa5d3d1ae2fec34ef544c184a2258ef3c400 url=/mulesoft/current/en-us/dataweave/2.6/dw-timer-functions-time.md -->

---
product: DataWeave
version: 2.6
---

# time

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## time<T>(valueToMeasure: () -> T): TimeMeasurement<T>

Executes the input function and returns a `TimeMeasurement` object that contains the start and end
time for the execution of that function, as well the result of the function.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>valueToMeasure</code></p></td><td><p>A function to pass to <code>time</code>.</p></td></tr></tbody></table>

### Example

This example passes `wait` and `sum` functions (defined in the header), which return their results
in `TimeMeasurement` objects.

```Dataweave
%dw 2.0
output application/json
fun myFunction() = dw::Runtime::wait("My result",100)
fun myFunction2() = sum([1,2,3,4])
---
{ testing: [
    dw::util::Timer::time(() -> myFunction()),
    dw::util::Timer::time(() -> myFunction2())
  ]
}
```

#### Output

```XML
{
  "testing": [
    {
      "start": "2018-10-05T19:23:01.49Z",
      "result": "My result",
      "end": "2018-10-05T19:23:01.591Z"
    },
    {
      "start": "2018-10-05T19:23:01.591Z",
      "result": 10,
      "end": "2018-10-05T19:23:01.591Z"
    }
  ]
}
```

<!-- document id=e0ca55a850b1c11873c83fd43cc0d1d7d4c50cc561eef0cc59b4da0d1eea6f33 url=/mulesoft/current/en-us/dataweave/2.9/dw-dates-functions-time.md -->

---
product: DataWeave
version: 2.9
---

# time

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## time(parts: TimeFactory): Time

Creates a `Time` value from values specified for `hour`, `minutes`, `seconds`, and `timezone`
fields.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>parts</code></p></td><td><div><div><p><code>Number</code> values for <code>hour</code>, <code>minutes</code>, and <code>seconds</code> fields, and a <code>TimeZone</code> value for the <code>timezone</code> field. Valid values are 0 through 23 for the <code>hour</code>, 0 through 59 for <code>minutes</code>, and 0 through 59 (including decimals, such as 59.99) for <code>seconds</code> fields. The <code>timezone</code> must be a valid <code>TimeZone</code> value, such as <code>|-03:00|</code> You can specify the name-value pairs in any order, but the output is ordered as a default <code>Time</code> value, such as <code>10:10:10-03:00</code>. The input fields are parts of a <code>TimeFactory</code> type.</p></div></div></td></tr></tbody></table>

### Example

This example shows how to create a value of type `Time`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  newTime: time({ hour: 12, minutes: 30, seconds: 40 , timeZone: |-03:00| })
}
```

#### Output

```Json
{
   "newTime": "12:30:40-03:00"
}
```

<!-- document id=4fe077a8e3aac265ad70c9ce957fd9b43c7d8647528c1e0488b40d51105a35a6 url=/mulesoft/current/en-us/dataweave/2.9/dw-timer-functions-time.md -->

---
product: DataWeave
version: 2.9
---

# time

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## time<T>(valueToMeasure: () -> T): TimeMeasurement<T>

Executes the input function and returns a `TimeMeasurement` object that contains the start and end
time for the execution of that function, as well the result of the function.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>valueToMeasure</code></p></td><td><p>A function to pass to <code>time</code>.</p></td></tr></tbody></table>

### Example

This example passes `wait` and `sum` functions (defined in the header), which return their results
in `TimeMeasurement` objects.

```Dataweave
%dw 2.0
output application/json
fun myFunction() = dw::Runtime::wait("My result",100)
fun myFunction2() = sum([1,2,3,4])
---
{ testing: [
    dw::util::Timer::time(() -> myFunction()),
    dw::util::Timer::time(() -> myFunction2())
  ]
}
```

#### Output

```XML
{
  "testing": [
    {
      "start": "2018-10-05T19:23:01.49Z",
      "result": "My result",
      "end": "2018-10-05T19:23:01.591Z"
    },
    {
      "start": "2018-10-05T19:23:01.591Z",
      "result": 10,
      "end": "2018-10-05T19:23:01.591Z"
    }
  ]
}
```

<!-- document id=ece75f11759f4a28dd0b41bc6623248da0f1dcaa1c8b03e4ad56b977dcab0a63 url=/mulesoft/current/en-us/dataweave/latest/dw-dates-functions-time.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# time

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## time(parts: TimeFactory): Time

Creates a `Time` value from values specified for `hour`, `minutes`, `seconds`, and `timezone`
fields.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>parts</code></p></td><td><div><div><p><code>Number</code> values for <code>hour</code>, <code>minutes</code>, and <code>seconds</code> fields, and a <code>TimeZone</code> value for the <code>timezone</code> field. Valid values are 0 through 23 for the <code>hour</code>, 0 through 59 for <code>minutes</code>, and 0 through 59 (including decimals, such as 59.99) for <code>seconds</code> fields. The <code>timezone</code> must be a valid <code>TimeZone</code> value, such as <code>|-03:00|</code> You can specify the name-value pairs in any order, but the output is ordered as a default <code>Time</code> value, such as <code>10:10:10-03:00</code>. The input fields are parts of a <code>TimeFactory</code> type.</p></div></div></td></tr></tbody></table>

### Example

This example shows how to create a value of type `Time`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
{
  newTime: time({ hour: 12, minutes: 30, seconds: 40 , timeZone: |-03:00| })
}
```

#### Output

```Json
{
   "newTime": "12:30:40-03:00"
}
```

<!-- document id=c61206e036608a1c3421f3f1b226dfbf4d9eaef932a294c8c304ed72d096c770 url=/mulesoft/current/en-us/dataweave/latest/dw-timer-functions-time.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# time

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## time<T>(valueToMeasure: () -> T): TimeMeasurement<T>

Executes the input function and returns a `TimeMeasurement` object that contains the start and end
time for the execution of that function, as well the result of the function.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>valueToMeasure</code></p></td><td><p>A function to pass to <code>time</code>.</p></td></tr></tbody></table>

### Example

This example passes `wait` and `sum` functions (defined in the header), which return their results
in `TimeMeasurement` objects.

```Dataweave
%dw 2.0
output application/json
fun myFunction() = dw::Runtime::wait("My result",100)
fun myFunction2() = sum([1,2,3,4])
---
{ testing: [
    dw::util::Timer::time(() -> myFunction()),
    dw::util::Timer::time(() -> myFunction2())
  ]
}
```

#### Output

```XML
{
  "testing": [
    {
      "start": "2018-10-05T19:23:01.49Z",
      "result": "My result",
      "end": "2018-10-05T19:23:01.591Z"
    },
    {
      "start": "2018-10-05T19:23:01.591Z",
      "result": 10,
      "end": "2018-10-05T19:23:01.591Z"
    }
  ]
}
```

<!-- document id=8d8d230caee90c00242f27424ecd8dae88f8030694bfe83a3bfb6378d034f9ce url=/mulesoft/current/en-us/dataweave/2.11/dw-timer.md -->

---
product: DataWeave
version: 2.11
---

# Timer (dw::util::Timer)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This utility module contains functions for measuring time.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::util::Timer` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-timer-functions-currentmilliseconds">currentMilliseconds</a></p></td><td><p>Returns the current time in milliseconds.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-timer-functions-duration">duration</a></p></td><td><p>Executes the input function and returns an object with execution time in milliseconds and result of that function.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-timer-functions-time">time</a></p></td><td><p>Executes the input function and returns a <code>TimeMeasurement</code> object that contains the start and end time for the execution of that function, as well the result of the function.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-timer-functions-tomilliseconds">toMilliseconds</a></p></td><td><p>Returns the representation of a specified date-time in milliseconds.</p></td></tr></tbody></table>

## Types

- [Timer Types](https://docs.mulesoft.com/dataweave/2.11/dw-timer-types)

<!-- document id=8cfd4d5fdb046d20363df1f8a7f42b86258174b51521df08fe1885ad785d0947 url=/mulesoft/current/en-us/dataweave/2.12/dw-timer.md -->

---
product: DataWeave
version: 2.12
---

# Timer (dw::util::Timer)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This utility module contains functions for measuring time.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::util::Timer` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-timer-functions-currentmilliseconds">currentMilliseconds</a></p></td><td><p>Returns the current time in milliseconds.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-timer-functions-duration">duration</a></p></td><td><p>Executes the input function and returns an object with execution time in milliseconds and result of that function.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-timer-functions-time">time</a></p></td><td><p>Executes the input function and returns a <code>TimeMeasurement</code> object that contains the start and end time for the execution of that function, as well the result of the function.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-timer-functions-tomilliseconds">toMilliseconds</a></p></td><td><p>Returns the representation of a specified date-time in milliseconds.</p></td></tr></tbody></table>

## Types

- [Timer Types](https://docs.mulesoft.com/dataweave/2.12/dw-timer-types)

<!-- document id=3cf42745f8762f8966de80f596f0c21b987e79a62b2a60430ecd9b17eeb2654d url=/mulesoft/current/en-us/dataweave/2.3/dw-timer.md -->

---
product: DataWeave
version: 2.3
---

# Timer (dw::util::Timer)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This is a utility module.

The module is included with Mule runtime. To use it, you must import it into your DataWeave code,
for example, by adding the line `import * from dw::util::Timer` to the header of your script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-timer-functions-currentmilliseconds">currentMilliseconds</a></p></td><td><p>Returns the current time in milliseconds.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-timer-functions-duration">duration</a></p></td><td><p>Executes the input function and returns an object with execution time in milliseconds and result of that function.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-timer-functions-time">time</a></p></td><td><p>Executes the input function and returns a <code>TimeMeasurement</code> object that contains the start and end time for the execution of that function, as well the result of the function.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-timer-functions-tomilliseconds">toMilliseconds</a></p></td><td><p>Returns the representation of a specified date-time in milliseconds.</p></td></tr></tbody></table>

## Types

- [Timer Types](https://docs.mulesoft.com/dataweave/2.3/dw-timer-types)

<!-- document id=a82025d449a279c302848ef92cb62facba31df07dd35786be13c82249c2bcaf3 url=/mulesoft/current/en-us/dataweave/2.4/dw-timer.md -->

---
product: DataWeave
version: 2.4
---

# Timer (dw::util::Timer)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This utility module contains functions for measuring time.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::util::Timer` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-timer-functions-currentmilliseconds">currentMilliseconds</a></p></td><td><p>Returns the current time in milliseconds.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-timer-functions-duration">duration</a></p></td><td><p>Executes the input function and returns an object with execution time in milliseconds and result of that function.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-timer-functions-time">time</a></p></td><td><p>Executes the input function and returns a <code>TimeMeasurement</code> object that contains the start and end time for the execution of that function, as well the result of the function.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-timer-functions-tomilliseconds">toMilliseconds</a></p></td><td><p>Returns the representation of a specified date-time in milliseconds.</p></td></tr></tbody></table>

## Types

- [Timer Types](https://docs.mulesoft.com/dataweave/2.4/dw-timer-types)

<!-- document id=374c714076fa561337a85b19503bafb4021b56410c68177587658389c7e9068d url=/mulesoft/current/en-us/dataweave/2.6/dw-timer.md -->

---
product: DataWeave
version: 2.6
---

# Timer (dw::util::Timer)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This utility module contains functions for measuring time.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::util::Timer` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-timer-functions-currentmilliseconds">currentMilliseconds</a></p></td><td><p>Returns the current time in milliseconds.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-timer-functions-duration">duration</a></p></td><td><p>Executes the input function and returns an object with execution time in milliseconds and result of that function.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-timer-functions-time">time</a></p></td><td><p>Executes the input function and returns a <code>TimeMeasurement</code> object that contains the start and end time for the execution of that function, as well the result of the function.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-timer-functions-tomilliseconds">toMilliseconds</a></p></td><td><p>Returns the representation of a specified date-time in milliseconds.</p></td></tr></tbody></table>

## Types

- [Timer Types](https://docs.mulesoft.com/dataweave/2.6/dw-timer-types)

<!-- document id=db784ddbe381dba25000e3a507e0f29d64edabaf34545a5e62650a030d420017 url=/mulesoft/current/en-us/dataweave/2.9/dw-timer.md -->

---
product: DataWeave
version: 2.9
---

# Timer (dw::util::Timer)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This utility module contains functions for measuring time.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::util::Timer` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-timer-functions-currentmilliseconds">currentMilliseconds</a></p></td><td><p>Returns the current time in milliseconds.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-timer-functions-duration">duration</a></p></td><td><p>Executes the input function and returns an object with execution time in milliseconds and result of that function.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-timer-functions-time">time</a></p></td><td><p>Executes the input function and returns a <code>TimeMeasurement</code> object that contains the start and end time for the execution of that function, as well the result of the function.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-timer-functions-tomilliseconds">toMilliseconds</a></p></td><td><p>Returns the representation of a specified date-time in milliseconds.</p></td></tr></tbody></table>

## Types

- [Timer Types](https://docs.mulesoft.com/dataweave/2.9/dw-timer-types)

<!-- document id=0763c7f6f80d015a187d93b1c201e982755645bf65e0c0f5b2a730b7ace08283 url=/mulesoft/current/en-us/dataweave/latest/dw-timer.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Timer (dw::util::Timer)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This utility module contains functions for measuring time.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::util::Timer` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-timer-functions-currentmilliseconds">currentMilliseconds</a></p></td><td><p>Returns the current time in milliseconds.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-timer-functions-duration">duration</a></p></td><td><p>Executes the input function and returns an object with execution time in milliseconds and result of that function.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-timer-functions-time">time</a></p></td><td><p>Executes the input function and returns a <code>TimeMeasurement</code> object that contains the start and end time for the execution of that function, as well the result of the function.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-timer-functions-tomilliseconds">toMilliseconds</a></p></td><td><p>Returns the representation of a specified date-time in milliseconds.</p></td></tr></tbody></table>

## Types

- [Timer Types](https://docs.mulesoft.com/dataweave/latest/dw-timer-types)

<!-- document id=0edc315fec3826c2553d7f5d9f6220b8f68f8c76d0fc516d2130c522120009f6 url=/mulesoft/current/en-us/dataweave/2.11/dw-timer-types.md -->

---
product: DataWeave
version: 2.11
---

# Timer Types (dw::util::Timer)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>DurationMeasurement</p></td><td><div><div><p><code>type DurationMeasurement = { time: Number, result: T }</code></p></div></div></td><td><div><div><p>A return type that contains the execution time and result of a function call.</p></div></div></td></tr><tr><td><p>TimeMeasurement</p></td><td><div><div><p><code>type TimeMeasurement = { start: DateTime, result: T, end: DateTime }</code></p></div></div></td><td><div><div><p>A return type that contains a start time, end time, and result of a function call.</p></div></div></td></tr></tbody></table>

<!-- document id=7f051563a457c6bdb55cd58ef66aca9b605d59214838691051f845aaf906c742 url=/mulesoft/current/en-us/dataweave/2.12/dw-timer-types.md -->

---
product: DataWeave
version: 2.12
---

# Timer Types (dw::util::Timer)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>DurationMeasurement</p></td><td><div><div><p><code>type DurationMeasurement = { time: Number, result: T }</code></p></div></div></td><td><div><div><p>A return type that contains the execution time and result of a function call.</p></div></div></td></tr><tr><td><p>TimeMeasurement</p></td><td><div><div><p><code>type TimeMeasurement = { start: DateTime, result: T, end: DateTime }</code></p></div></div></td><td><div><div><p>A return type that contains a start time, end time, and result of a function call.</p></div></div></td></tr></tbody></table>

<!-- document id=022dfbbe44c344825f0c19ac38aed5bfc8963e1f41458642a8474d5f4b35b161 url=/mulesoft/current/en-us/dataweave/2.3/dw-timer-types.md -->

---
product: DataWeave
version: 2.3
---

# Timer Types (dw::util::Timer)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>DurationMeasurement</p></td><td><p><code>type DurationMeasurement = { time: Number, result: T }</code></p></td><td><p>A return type that contains the execution time and result of a function call.</p></td></tr><tr><td><p>TimeMeasurement</p></td><td><p><code>type TimeMeasurement = { start: DateTime, result: T, end: DateTime }</code></p></td><td><p>A return type that contains a start time, end time, and result of a function call.</p></td></tr></tbody></table>

<!-- document id=0cf56a11892c3849133623b32504fde79886794adaf73a3b95e9fcbfa21b09b7 url=/mulesoft/current/en-us/dataweave/2.4/dw-timer-types.md -->

---
product: DataWeave
version: 2.4
---

# Timer Types (dw::util::Timer)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>DurationMeasurement</p></td><td><div><div><p><code>type DurationMeasurement = { time: Number, result: T }</code></p></div></div></td><td><div><div><p>A return type that contains the execution time and result of a function call.</p></div></div></td></tr><tr><td><p>TimeMeasurement</p></td><td><div><div><p><code>type TimeMeasurement = { start: DateTime, result: T, end: DateTime }</code></p></div></div></td><td><div><div><p>A return type that contains a start time, end time, and result of a function call.</p></div></div></td></tr></tbody></table>

<!-- document id=dc889af1e616f64e14a295976a657ca3fabeebbdb77341de61f800493617c609 url=/mulesoft/current/en-us/dataweave/2.6/dw-timer-types.md -->

---
product: DataWeave
version: 2.6
---

# Timer Types (dw::util::Timer)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>DurationMeasurement</p></td><td><div><div><p><code>type DurationMeasurement = { time: Number, result: T }</code></p></div></div></td><td><div><div><p>A return type that contains the execution time and result of a function call.</p></div></div></td></tr><tr><td><p>TimeMeasurement</p></td><td><div><div><p><code>type TimeMeasurement = { start: DateTime, result: T, end: DateTime }</code></p></div></div></td><td><div><div><p>A return type that contains a start time, end time, and result of a function call.</p></div></div></td></tr></tbody></table>

<!-- document id=364de62b17323f6a7b359161764857d82f43b79b818a0138ba57113d905a7e5b url=/mulesoft/current/en-us/dataweave/2.9/dw-timer-types.md -->

---
product: DataWeave
version: 2.9
---

# Timer Types (dw::util::Timer)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>DurationMeasurement</p></td><td><div><div><p><code>type DurationMeasurement = { time: Number, result: T }</code></p></div></div></td><td><div><div><p>A return type that contains the execution time and result of a function call.</p></div></div></td></tr><tr><td><p>TimeMeasurement</p></td><td><div><div><p><code>type TimeMeasurement = { start: DateTime, result: T, end: DateTime }</code></p></div></div></td><td><div><div><p>A return type that contains a start time, end time, and result of a function call.</p></div></div></td></tr></tbody></table>

<!-- document id=f4740fc20eb6091970da0ab8d7b70c0a0bce02a20e3577637e4a40680b5c39c1 url=/mulesoft/current/en-us/dataweave/latest/dw-timer-types.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Timer Types (dw::util::Timer)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>DurationMeasurement</p></td><td><div><div><p><code>type DurationMeasurement = { time: Number, result: T }</code></p></div></div></td><td><div><div><p>A return type that contains the execution time and result of a function call.</p></div></div></td></tr><tr><td><p>TimeMeasurement</p></td><td><div><div><p><code>type TimeMeasurement = { start: DateTime, result: T, end: DateTime }</code></p></div></div></td><td><div><div><p>A return type that contains a start time, end time, and result of a function call.</p></div></div></td></tr></tbody></table>

<!-- document id=94292f6b590f4b635c9676f4689cd8d112f18921f0bfb9fcdc81e8644929f4d7 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-to.md -->

---
product: DataWeave
version: 2.11
---

# to

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## to(from: Number, to: Number): Range

Returns a range with the specified boundaries.

The upper boundary is inclusive.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>from</code></p></td><td><p><code>Number</code> value that starts the range. The output includes the <code>from</code> value.</p></td></tr><tr><td><p><code>to</code></p></td><td><p><code>Number</code> value that ends the range. The output includes the <code>from</code> value.</p></td></tr></tbody></table>

### Example

This example lists a range of numbers from 1 to 10.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "myRange": 1 to 10 }
```

#### Output

```JSON
{ "myRange": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10] }
```

### Example

DataWeave treats a string as an array of characters. This example applies `to` to a string.

#### Source

```DataWeave
%dw 2.0
var myVar = "Hello World!"
output application/json
---
{
  indices2to6 : myVar[2 to 6],
  indicesFromEnd : myVar[6 to -1],
  reversal : myVar[11 to -0]
}
```

#### Output

```JSON
{
  "indices2to6": "llo W",
  "indicesFromEnd": "World!",
  "reversal": "!dlroW olleH"
}
```

<!-- document id=331bbaee8954dabd38fabcde2335205227b72396200047cef9f523323e6b6a7a url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-to.md -->

---
product: DataWeave
version: 2.12
---

# to

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## to(from: Number, to: Number): Range

Returns a range with the specified boundaries.

The upper boundary is inclusive.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>from</code></p></td><td><p><code>Number</code> value that starts the range. The output includes the <code>from</code> value.</p></td></tr><tr><td><p><code>to</code></p></td><td><p><code>Number</code> value that ends the range. The output includes the <code>from</code> value.</p></td></tr></tbody></table>

### Example

This example lists a range of numbers from 1 to 10.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "myRange": 1 to 10 }
```

#### Output

```JSON
{ "myRange": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10] }
```

### Example

DataWeave treats a string as an array of characters. This example applies `to` to a string.

#### Source

```DataWeave
%dw 2.0
var myVar = "Hello World!"
output application/json
---
{
  indices2to6 : myVar[2 to 6],
  indicesFromEnd : myVar[6 to -1],
  reversal : myVar[11 to -0]
}
```

#### Output

```JSON
{
  "indices2to6": "llo W",
  "indicesFromEnd": "World!",
  "reversal": "!dlroW olleH"
}
```

<!-- document id=fbaddb8d5f14e7ca5d0156a8dba180a7539032b6da5e5a1c6a8aab8aedfbcea8 url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-to.md -->

---
product: DataWeave
version: 2.3
---

# to

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## to(Number, Number): Range

Returns a range with the specified boundaries.

The upper boundary is inclusive.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>from</code></p></td><td><p>A number (<code>Number</code> type) that starts the range. The output includes the <code>from</code> value.</p></td></tr><tr><td><p><code>to</code></p></td><td><p>A number (<code>Number</code> type) that ends the range. The output includes the <code>to</code> value.</p></td></tr></tbody></table>

### Example

This example lists a range of numbers from 1 to 10.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "myRange": 1 to 10 }
```

#### Output

```JSON
{ "myRange": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10] }
```

### Example

DataWeave treats a string as an array of characters. This example applies `to` to a string.

#### Source

```DataWeave
%dw 2.0
var myVar = "Hello World!"
output application/json
---
{
  indices2to6 : myVar[2 to 6],
  indicesFromEnd : myVar[6 to -1],
  reversal : myVar[11 to -0]
}
```

#### Output

```JSON
{
  "indices2to6": "llo W",
  "indicesFromEnd": "World!",
  "reversal": "!dlroW olleH"
}
```

<!-- document id=2abe8633e3ea41ae4566147bab3254319feb3074ff795a514d6f11201d54a3c8 url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-to.md -->

---
product: DataWeave
version: 2.4
---

# to

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## to(from: Number, to: Number): Range

Returns a range with the specified boundaries.

The upper boundary is inclusive.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>from</code></p></td><td><p><code>Number</code> value that starts the range. The output includes the <code>from</code> value.</p></td></tr><tr><td><p><code>to</code></p></td><td><p><code>Number</code> value that ends the range. The output includes the <code>from</code> value.</p></td></tr></tbody></table>

### Example

This example lists a range of numbers from 1 to 10.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "myRange": 1 to 10 }
```

#### Output

```JSON
{ "myRange": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10] }
```

### Example

DataWeave treats a string as an array of characters. This example applies `to` to a string.

#### Source

```DataWeave
%dw 2.0
var myVar = "Hello World!"
output application/json
---
{
  indices2to6 : myVar[2 to 6],
  indicesFromEnd : myVar[6 to -1],
  reversal : myVar[11 to -0]
}
```

#### Output

```JSON
{
  "indices2to6": "llo W",
  "indicesFromEnd": "World!",
  "reversal": "!dlroW olleH"
}
```

<!-- document id=07d532499d6a83a42235e4f2e78015de683b4f5dca3334c8aae86a2c2eeac484 url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-to.md -->

---
product: DataWeave
version: 2.6
---

# to

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## to(from: Number, to: Number): Range

Returns a range with the specified boundaries.

The upper boundary is inclusive.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>from</code></p></td><td><p><code>Number</code> value that starts the range. The output includes the <code>from</code> value.</p></td></tr><tr><td><p><code>to</code></p></td><td><p><code>Number</code> value that ends the range. The output includes the <code>from</code> value.</p></td></tr></tbody></table>

### Example

This example lists a range of numbers from 1 to 10.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "myRange": 1 to 10 }
```

#### Output

```JSON
{ "myRange": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10] }
```

### Example

DataWeave treats a string as an array of characters. This example applies `to` to a string.

#### Source

```DataWeave
%dw 2.0
var myVar = "Hello World!"
output application/json
---
{
  indices2to6 : myVar[2 to 6],
  indicesFromEnd : myVar[6 to -1],
  reversal : myVar[11 to -0]
}
```

#### Output

```JSON
{
  "indices2to6": "llo W",
  "indicesFromEnd": "World!",
  "reversal": "!dlroW olleH"
}
```

<!-- document id=ab8f84286c1d547e6222a42c2050b5cc4402a769c06c6448070062dd895ac3b2 url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-to.md -->

---
product: DataWeave
version: 2.9
---

# to

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## to(from: Number, to: Number): Range

Returns a range with the specified boundaries.

The upper boundary is inclusive.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>from</code></p></td><td><p><code>Number</code> value that starts the range. The output includes the <code>from</code> value.</p></td></tr><tr><td><p><code>to</code></p></td><td><p><code>Number</code> value that ends the range. The output includes the <code>from</code> value.</p></td></tr></tbody></table>

### Example

This example lists a range of numbers from 1 to 10.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "myRange": 1 to 10 }
```

#### Output

```JSON
{ "myRange": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10] }
```

### Example

DataWeave treats a string as an array of characters. This example applies `to` to a string.

#### Source

```DataWeave
%dw 2.0
var myVar = "Hello World!"
output application/json
---
{
  indices2to6 : myVar[2 to 6],
  indicesFromEnd : myVar[6 to -1],
  reversal : myVar[11 to -0]
}
```

#### Output

```JSON
{
  "indices2to6": "llo W",
  "indicesFromEnd": "World!",
  "reversal": "!dlroW olleH"
}
```

<!-- document id=7a672b9b625478c9c4e74768b527e025aa412bdc8809caf777f8486d3d2be38e url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-to.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# to

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## to(from: Number, to: Number): Range

Returns a range with the specified boundaries.

The upper boundary is inclusive.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>from</code></p></td><td><p><code>Number</code> value that starts the range. The output includes the <code>from</code> value.</p></td></tr><tr><td><p><code>to</code></p></td><td><p><code>Number</code> value that ends the range. The output includes the <code>from</code> value.</p></td></tr></tbody></table>

### Example

This example lists a range of numbers from 1 to 10.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "myRange": 1 to 10 }
```

#### Output

```JSON
{ "myRange": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10] }
```

### Example

DataWeave treats a string as an array of characters. This example applies `to` to a string.

#### Source

```DataWeave
%dw 2.0
var myVar = "Hello World!"
output application/json
---
{
  indices2to6 : myVar[2 to 6],
  indicesFromEnd : myVar[6 to -1],
  reversal : myVar[11 to -0]
}
```

#### Output

```JSON
{
  "indices2to6": "llo W",
  "indicesFromEnd": "World!",
  "reversal": "!dlroW olleH"
}
```

<!-- document id=9caedd800527651bd4b1759ef5682c65c91041eb1bbebd73ef07f93b2e33f592 url=/mulesoft/current/en-us/dataweave/2.11/dw-coercions-functions-toarray.md -->

---
product: DataWeave
version: 2.11
---

# toArray

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toArray(@StreamCapable text: String): Array<String>

Splits a `String` value into an `Array` of characters.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The <code>String</code> value to transform into an <code>Array</code> of characters (a <code>Array&lt;String&gt;</code> type).</p></td></tr></tbody></table>

### Example

This example shows how `toArray` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json indent=false
---
{
  a: toArray(""),
  b: toArray("hola")
}
```

#### Output

```Json
{"a": [],"b": ["h","o","l","a"]}
```

<!-- document id=7a8f67b816b8632b835b1733dc248cd0eb83ff06d5d530882fc29f6bdb2535c2 url=/mulesoft/current/en-us/dataweave/2.12/dw-coercions-functions-toarray.md -->

---
product: DataWeave
version: 2.12
---

# toArray

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toArray(@StreamCapable text: String): Array<String>

Splits a `String` value into an `Array` of characters.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The <code>String</code> value to transform into an <code>Array</code> of characters (a <code>Array&lt;String&gt;</code> type).</p></td></tr></tbody></table>

### Example

This example shows how `toArray` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json indent=false
---
{
  a: toArray(""),
  b: toArray("hola")
}
```

#### Output

```Json
{"a": [],"b": ["h","o","l","a"]}
```

<!-- document id=6fcd863512989db0d526b5fb9082d32879371a470be4f08f31aa234fd7c01e8f url=/mulesoft/current/en-us/dataweave/2.4/dw-coercions-functions-toarray.md -->

---
product: DataWeave
version: 2.4
---

# toArray

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toArray(@StreamCapable text: String): Array<String>

Splits a `String` value into an `Array` of characters.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The <code>String</code> value to transform into an <code>Array</code> of characters (a <code>Array&lt;String&gt;</code> type).</p></td></tr></tbody></table>

### Example

This example shows how `toArray` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json indent=false
---
{
  a: toArray(""),
  b: toArray("hola")
}
```

#### Output

```Json
{"a": [],"b": ["h","o","l","a"]}
```

<!-- document id=e76c587da33b468cb938cc6ff935435af368549d7244d7ab45563de614197de5 url=/mulesoft/current/en-us/dataweave/2.6/dw-coercions-functions-toarray.md -->

---
product: DataWeave
version: 2.6
---

# toArray

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toArray(@StreamCapable text: String): Array<String>

Splits a `String` value into an `Array` of characters.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The <code>String</code> value to transform into an <code>Array</code> of characters (a <code>Array&lt;String&gt;</code> type).</p></td></tr></tbody></table>

### Example

This example shows how `toArray` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json indent=false
---
{
  a: toArray(""),
  b: toArray("hola")
}
```

#### Output

```Json
{"a": [],"b": ["h","o","l","a"]}
```

<!-- document id=32fdaa7c16dbe1e1e0681e8272297fa01a9641e7fe7673b67ed5b8d77a4208df url=/mulesoft/current/en-us/dataweave/2.9/dw-coercions-functions-toarray.md -->

---
product: DataWeave
version: 2.9
---

# toArray

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toArray(@StreamCapable text: String): Array<String>

Splits a `String` value into an `Array` of characters.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The <code>String</code> value to transform into an <code>Array</code> of characters (a <code>Array&lt;String&gt;</code> type).</p></td></tr></tbody></table>

### Example

This example shows how `toArray` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json indent=false
---
{
  a: toArray(""),
  b: toArray("hola")
}
```

#### Output

```Json
{"a": [],"b": ["h","o","l","a"]}
```

<!-- document id=cd6e60eea201a44749eeafddcbe5896c4c9a6238a53e34281db3f86b9ec858c1 url=/mulesoft/current/en-us/dataweave/latest/dw-coercions-functions-toarray.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# toArray

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toArray(@StreamCapable text: String): Array<String>

Splits a `String` value into an `Array` of characters.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The <code>String</code> value to transform into an <code>Array</code> of characters (a <code>Array&lt;String&gt;</code> type).</p></td></tr></tbody></table>

### Example

This example shows how `toArray` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json indent=false
---
{
  a: toArray(""),
  b: toArray("hola")
}
```

#### Output

```Json
{"a": [],"b": ["h","o","l","a"]}
```

<!-- document id=0d853b9d1a301c1570897c9f489ed8988e2c8a5cead500428f7a33b981c0603a url=/mulesoft/current/en-us/dataweave/2.11/dw-binaries-functions-tobase64.md -->

---
product: DataWeave
version: 2.11
---

# toBase64

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toBase64(content: Binary): String

Transforms a binary value into a Base64 string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>The binary value to transform.</p></td></tr></tbody></table>

### Example

This example transforms a binary value into a Base64 encoded string. In this case, the binary value
represents an image.

#### Source

```DataWeave
%dw 2.0

import dw::Crypto
import toBase64 from dw::core::Binaries

var emailChecksum = Crypto::MD5("achaval@gmail.com" as Binary)
var image = readUrl(log("https://www.gravatar.com/avatar/$(emailChecksum)"), "application/octet-stream")

output application/json
---
toBase64(image)
```

#### Output

This example outputs a Base64 encoded string. The resulting string was shortened for readability
purposes:

```JSON
"/9j/4AAQSkZJRgABAQEAYABgAAD//..."
```

<!-- document id=9ccb16cebcfe88edc80d915b81f5e4852c57590a734fdf899848e7d5fb460320 url=/mulesoft/current/en-us/dataweave/2.12/dw-binaries-functions-tobase64.md -->

---
product: DataWeave
version: 2.12
---

# toBase64

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toBase64(content: Binary): String

Transforms a binary value into a Base64 string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>The binary value to transform.</p></td></tr></tbody></table>

### Example

This example transforms a binary value into a Base64 encoded string. In this case, the binary value
represents an image.

#### Source

```DataWeave
%dw 2.0

import dw::Crypto
import toBase64 from dw::core::Binaries

var emailChecksum = Crypto::MD5("achaval@gmail.com" as Binary)
var image = readUrl(log("https://www.gravatar.com/avatar/$(emailChecksum)"), "application/octet-stream")

output application/json
---
toBase64(image)
```

#### Output

This example outputs a Base64 encoded string. The resulting string was shortened for readability
purposes:

```JSON
"/9j/4AAQSkZJRgABAQEAYABgAAD//..."
```

<!-- document id=139ed004fa319ee0b87a6f2271ef0b093a349ab87ea8317a04c62be96dbee75a url=/mulesoft/current/en-us/dataweave/2.3/dw-binaries-functions-tobase64.md -->

---
product: DataWeave
version: 2.3
---

# toBase64

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toBase64(Binary): String

Transforms a binary value into a Base64 string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>The binary value to transform.</p></td></tr></tbody></table>

### Example

This example transforms a binary value into a Base64 encoded string. In this case, the binary value
represents an image.

#### Source

```DataWeave
%dw 2.0

import dw::Crypto
import toBase64 from dw::core::Binaries

var emailChecksum = Crypto::MD5("achaval@gmail.com" as Binary)
var image = readUrl(log("https://www.gravatar.com/avatar/$(emailChecksum)"), "application/octet-stream")

output application/json
---
toBase64(image)
```

#### Output

This example outputs a Base64 encoded string. The resulting string was shortened for readability
purposes:

```JSON
"/9j/4AAQSkZJRgABAQEAYABgAAD//..."
```

<!-- document id=2f3e55b95b3337bc5b48fcc0bec0e1f14f3bd6853a6c1a7ab235ce2eefa6c97c url=/mulesoft/current/en-us/dataweave/2.4/dw-binaries-functions-tobase64.md -->

---
product: DataWeave
version: 2.4
---

# toBase64

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toBase64(content: Binary): String

Transforms a binary value into a Base64 string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>The binary value to transform.</p></td></tr></tbody></table>

### Example

This example transforms a binary value into a Base64 encoded string. In this case, the binary value
represents an image.

#### Source

```DataWeave
%dw 2.0

import dw::Crypto
import toBase64 from dw::core::Binaries

var emailChecksum = Crypto::MD5("achaval@gmail.com" as Binary)
var image = readUrl(log("https://www.gravatar.com/avatar/$(emailChecksum)"), "application/octet-stream")

output application/json
---
toBase64(image)
```

#### Output

This example outputs a Base64 encoded string. The resulting string was shortened for readability
purposes:

```JSON
"/9j/4AAQSkZJRgABAQEAYABgAAD//..."
```

<!-- document id=5f8555adf2aa1fd06d5d42f6bc9a6ae081a214156e7123ac0b14adb014c81f23 url=/mulesoft/current/en-us/dataweave/2.6/dw-binaries-functions-tobase64.md -->

---
product: DataWeave
version: 2.6
---

# toBase64

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toBase64(content: Binary): String

Transforms a binary value into a Base64 string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>The binary value to transform.</p></td></tr></tbody></table>

### Example

This example transforms a binary value into a Base64 encoded string. In this case, the binary value
represents an image.

#### Source

```DataWeave
%dw 2.0

import dw::Crypto
import toBase64 from dw::core::Binaries

var emailChecksum = Crypto::MD5("achaval@gmail.com" as Binary)
var image = readUrl(log("https://www.gravatar.com/avatar/$(emailChecksum)"), "application/octet-stream")

output application/json
---
toBase64(image)
```

#### Output

This example outputs a Base64 encoded string. The resulting string was shortened for readability
purposes:

```JSON
"/9j/4AAQSkZJRgABAQEAYABgAAD//..."
```

<!-- document id=a3b8e732a3fa93fa4555019a88902a320f66aadfd0b1c0f1c4362fe1c1a59b11 url=/mulesoft/current/en-us/dataweave/2.9/dw-binaries-functions-tobase64.md -->

---
product: DataWeave
version: 2.9
---

# toBase64

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toBase64(content: Binary): String

Transforms a binary value into a Base64 string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>The binary value to transform.</p></td></tr></tbody></table>

### Example

This example transforms a binary value into a Base64 encoded string. In this case, the binary value
represents an image.

#### Source

```DataWeave
%dw 2.0

import dw::Crypto
import toBase64 from dw::core::Binaries

var emailChecksum = Crypto::MD5("achaval@gmail.com" as Binary)
var image = readUrl(log("https://www.gravatar.com/avatar/$(emailChecksum)"), "application/octet-stream")

output application/json
---
toBase64(image)
```

#### Output

This example outputs a Base64 encoded string. The resulting string was shortened for readability
purposes:

```JSON
"/9j/4AAQSkZJRgABAQEAYABgAAD//..."
```

<!-- document id=3a5c98dd9e3777136fc465284eb67c21bfd16a04fe9a686a036d23b27d4e288a url=/mulesoft/current/en-us/dataweave/latest/dw-binaries-functions-tobase64.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# toBase64

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toBase64(content: Binary): String

Transforms a binary value into a Base64 string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>The binary value to transform.</p></td></tr></tbody></table>

### Example

This example transforms a binary value into a Base64 encoded string. In this case, the binary value
represents an image.

#### Source

```DataWeave
%dw 2.0

import dw::Crypto
import toBase64 from dw::core::Binaries

var emailChecksum = Crypto::MD5("achaval@gmail.com" as Binary)
var image = readUrl(log("https://www.gravatar.com/avatar/$(emailChecksum)"), "application/octet-stream")

output application/json
---
toBase64(image)
```

#### Output

This example outputs a Base64 encoded string. The resulting string was shortened for readability
purposes:

```JSON
"/9j/4AAQSkZJRgABAQEAYABgAAD//..."
```

<!-- document id=65e08526012bbcaa0508ad219d5940f07ab00ed2a1610d8280f78694b2991a99 url=/mulesoft/current/en-us/dataweave/2.11/dw-coercions-functions-tobinary.md -->

---
product: DataWeave
version: 2.11
---

# toBinary

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toBinary(str: String, encoding: String): Binary

Transform a `String` value into a `Binary` value using the specified encoding.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>Binary</code> value.</p></td></tr><tr><td><p><code>encoding</code></p></td><td><p>The encoding to apply to the <code>String</code> value. Accepts encodings that are supported by your JDK. For example, <code>encoding</code> accepts Java canonical names and aliases for the basic and extended encoding sets in Oracle JDK 8 and JDK 11.</p></td></tr></tbody></table>

### Example

This example shows how `toBinary` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  'UTF-16Ex': toBinary("DW", "UTF-16"),
  'utf16Ex': toBinary("DW", "utf16"),
  'UnicodeBigEx': toBinary("DW", "UnicodeBig"),
  'UTF-32Ex': toBinary("DW", "UTF-32"),
  'UTF_32Ex': toBinary("DW", "UTF_32")
}
```

#### Output

```Json
{
  "UTF-16Ex": "/v8ARABX" as Binary {base: "64"},
  utf16Ex: "/v8ARABX" as Binary {base: "64"},
  UnicodeBigEx: "/v8ARABX" as Binary {base: "64"},
  "UTF-32Ex": "AAAARAAAAFc=" as Binary {base: "64"},
  UTF_32Ex: "AAAARAAAAFc=" as Binary {base: "64"}
}
```

<!-- document id=634f28c690a8fffaaf114e086e77e6ad1ad91e282a9199c34f991d5111c247a8 url=/mulesoft/current/en-us/dataweave/2.11/dw-numbers-functions-tobinary.md -->

---
product: DataWeave
version: 2.11
---

# toBinary

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toBinary(number: Number): String

Transforms a decimal number into a binary number.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The input number.</p></td></tr></tbody></table>

### Example

This example shows how the `toBinary` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import toBinary from dw::core::Numbers
output application/json
---
{
    a: toBinary(-2),
    b: toBinary(100000000000000000000000000000000000000000000000000000000000000),
    c: toBinary(0),
    d: toBinary(null),
    e: toBinary(2),
}
```

#### Output

```JSON
{
  "a": "-10",
  "b": "11111000111010111010110100101011100001001110000011010101100010111101001011100000100010011000011101100101101001111101111010110010010100110010100100000000000000000000000000000000000000000000000000000000000000",
  "c": "0",
  "d": null,
  "e": "10"
}
```

## toBinary(number: Null): Null

Helper function that enables `toBinary` to work with null value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=502fd0ab7caec726dfa54de42ef3467c18d8c67ef077de6018637fa259019466 url=/mulesoft/current/en-us/dataweave/2.12/dw-coercions-functions-tobinary.md -->

---
product: DataWeave
version: 2.12
---

# toBinary

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toBinary(str: String, encoding: String): Binary

Transform a `String` value into a `Binary` value using the specified encoding.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>Binary</code> value.</p></td></tr><tr><td><p><code>encoding</code></p></td><td><p>The encoding to apply to the <code>String</code> value. Accepts encodings that are supported by your JDK. For example, <code>encoding</code> accepts Java canonical names and aliases for the basic and extended encoding sets in Oracle JDK 8 and JDK 11.</p></td></tr></tbody></table>

### Example

This example shows how `toBinary` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  'UTF-16Ex': toBinary("DW", "UTF-16"),
  'utf16Ex': toBinary("DW", "utf16"),
  'UnicodeBigEx': toBinary("DW", "UnicodeBig"),
  'UTF-32Ex': toBinary("DW", "UTF-32"),
  'UTF_32Ex': toBinary("DW", "UTF_32")
}
```

#### Output

```Json
{
  "UTF-16Ex": "/v8ARABX" as Binary {base: "64"},
  utf16Ex: "/v8ARABX" as Binary {base: "64"},
  UnicodeBigEx: "/v8ARABX" as Binary {base: "64"},
  "UTF-32Ex": "AAAARAAAAFc=" as Binary {base: "64"},
  UTF_32Ex: "AAAARAAAAFc=" as Binary {base: "64"}
}
```

<!-- document id=014a2d68c829ffdc69bd4fecee48982265ada029b172fc3e3a4be0a00805c019 url=/mulesoft/current/en-us/dataweave/2.12/dw-numbers-functions-tobinary.md -->

---
product: DataWeave
version: 2.12
---

# toBinary

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toBinary(number: Number): String

Transforms a decimal number into a binary number.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The input number.</p></td></tr></tbody></table>

### Example

This example shows how the `toBinary` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import toBinary from dw::core::Numbers
output application/json
---
{
    a: toBinary(-2),
    b: toBinary(100000000000000000000000000000000000000000000000000000000000000),
    c: toBinary(0),
    d: toBinary(null),
    e: toBinary(2),
}
```

#### Output

```JSON
{
  "a": "-10",
  "b": "11111000111010111010110100101011100001001110000011010101100010111101001011100000100010011000011101100101101001111101111010110010010100110010100100000000000000000000000000000000000000000000000000000000000000",
  "c": "0",
  "d": null,
  "e": "10"
}
```

## toBinary(number: Null): Null

Helper function that enables `toBinary` to work with null value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=87847eeea20532a2776846da8a2680b78657b12b951f99cb019683ca453feb7c url=/mulesoft/current/en-us/dataweave/2.3/dw-numbers-functions-tobinary.md -->

---
product: DataWeave
version: 2.3
---

# toBinary

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toBinary(Number): String

Transforms a decimal number into a binary number.

_Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The input number.</p></td></tr></tbody></table>

### Example

This example shows how the `toBinary` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import toBinary from dw::core::Numbers
output application/json
---
{
    a: toBinary(-2),
    b: toBinary(100000000000000000000000000000000000000000000000000000000000000),
    c: toBinary(0),
    d: toBinary(null),
    e: toBinary(2),
}
```

#### Output

```JSON
{
  "a": "-10",
  "b": "11111000111010111010110100101011100001001110000011010101100010111101001011100000100010011000011101100101101001111101111010110010010100110010100100000000000000000000000000000000000000000000000000000000000000",
  "c": "0",
  "d": null,
  "e": "10"
}
```

## toBinary(Null): Null

Helper function that enables `toBinary` to work with null value.

<!-- document id=dae541606da4832be8669a3d178faef4e4f3a611886d436fe2758a7ec7d7b0e9 url=/mulesoft/current/en-us/dataweave/2.4/dw-coercions-functions-tobinary.md -->

---
product: DataWeave
version: 2.4
---

# toBinary

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toBinary(str: String, encoding: String): Binary

Transform a `String` value into a `Binary` value using the specified encoding.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>Binary</code> value.</p></td></tr><tr><td><p><code>encoding</code></p></td><td><p>The encoding to apply to the <code>String</code> value. Accepts encodings that are supported by your JDK. For example, <code>encoding</code> accepts Java canonical names and aliases for the basic and extended encoding sets in Oracle JDK 8 and JDK 11.</p></td></tr></tbody></table>

### Example

This example shows how `toBinary` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  'UTF-16Ex': toBinary("DW", "UTF-16"),
  'utf16Ex': toBinary("DW", "utf16"),
  'UnicodeBigEx': toBinary("DW", "UnicodeBig"),
  'UTF-32Ex': toBinary("DW", "UTF-32"),
  'UTF_32Ex': toBinary("DW", "UTF_32")
}
```

#### Output

```Json
{
  "UTF-16Ex": "/v8ARABX" as Binary {base: "64"},
  utf16Ex: "/v8ARABX" as Binary {base: "64"},
  UnicodeBigEx: "/v8ARABX" as Binary {base: "64"},
  "UTF-32Ex": "AAAARAAAAFc=" as Binary {base: "64"},
  UTF_32Ex: "AAAARAAAAFc=" as Binary {base: "64"}
}
```

<!-- document id=fa8020b9f6a39389b28e21e8c5649437f09b10addf1c11412807028a6b60174c url=/mulesoft/current/en-us/dataweave/2.4/dw-numbers-functions-tobinary.md -->

---
product: DataWeave
version: 2.4
---

# toBinary

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toBinary(number: Number): String

Transforms a decimal number into a binary number.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The input number.</p></td></tr></tbody></table>

### Example

This example shows how the `toBinary` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import toBinary from dw::core::Numbers
output application/json
---
{
    a: toBinary(-2),
    b: toBinary(100000000000000000000000000000000000000000000000000000000000000),
    c: toBinary(0),
    d: toBinary(null),
    e: toBinary(2),
}
```

#### Output

```JSON
{
  "a": "-10",
  "b": "11111000111010111010110100101011100001001110000011010101100010111101001011100000100010011000011101100101101001111101111010110010010100110010100100000000000000000000000000000000000000000000000000000000000000",
  "c": "0",
  "d": null,
  "e": "10"
}
```

## toBinary(number: Null): Null

Helper function that enables `toBinary` to work with null value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=cbc849d78d70a3f7d6d85c5a4153d03a2cccba6220ec832377f7b2e5771db936 url=/mulesoft/current/en-us/dataweave/2.6/dw-coercions-functions-tobinary.md -->

---
product: DataWeave
version: 2.6
---

# toBinary

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toBinary(str: String, encoding: String): Binary

Transform a `String` value into a `Binary` value using the specified encoding.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>Binary</code> value.</p></td></tr><tr><td><p><code>encoding</code></p></td><td><p>The encoding to apply to the <code>String</code> value. Accepts encodings that are supported by your JDK. For example, <code>encoding</code> accepts Java canonical names and aliases for the basic and extended encoding sets in Oracle JDK 8 and JDK 11.</p></td></tr></tbody></table>

### Example

This example shows how `toBinary` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  'UTF-16Ex': toBinary("DW", "UTF-16"),
  'utf16Ex': toBinary("DW", "utf16"),
  'UnicodeBigEx': toBinary("DW", "UnicodeBig"),
  'UTF-32Ex': toBinary("DW", "UTF-32"),
  'UTF_32Ex': toBinary("DW", "UTF_32")
}
```

#### Output

```Json
{
  "UTF-16Ex": "/v8ARABX" as Binary {base: "64"},
  utf16Ex: "/v8ARABX" as Binary {base: "64"},
  UnicodeBigEx: "/v8ARABX" as Binary {base: "64"},
  "UTF-32Ex": "AAAARAAAAFc=" as Binary {base: "64"},
  UTF_32Ex: "AAAARAAAAFc=" as Binary {base: "64"}
}
```

<!-- document id=6f0893ff815eb9a58397c8dbe0cce5bfa6ac7ddcf68f72d78832158d945eebd9 url=/mulesoft/current/en-us/dataweave/2.6/dw-numbers-functions-tobinary.md -->

---
product: DataWeave
version: 2.6
---

# toBinary

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toBinary(number: Number): String

Transforms a decimal number into a binary number.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The input number.</p></td></tr></tbody></table>

### Example

This example shows how the `toBinary` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import toBinary from dw::core::Numbers
output application/json
---
{
    a: toBinary(-2),
    b: toBinary(100000000000000000000000000000000000000000000000000000000000000),
    c: toBinary(0),
    d: toBinary(null),
    e: toBinary(2),
}
```

#### Output

```JSON
{
  "a": "-10",
  "b": "11111000111010111010110100101011100001001110000011010101100010111101001011100000100010011000011101100101101001111101111010110010010100110010100100000000000000000000000000000000000000000000000000000000000000",
  "c": "0",
  "d": null,
  "e": "10"
}
```

## toBinary(number: Null): Null

Helper function that enables `toBinary` to work with null value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=dcc434c0d7be1240edfd75f347ec9780bdb8c09c7b45f25edc880498e5a5e69a url=/mulesoft/current/en-us/dataweave/2.9/dw-coercions-functions-tobinary.md -->

---
product: DataWeave
version: 2.9
---

# toBinary

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toBinary(str: String, encoding: String): Binary

Transform a `String` value into a `Binary` value using the specified encoding.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>Binary</code> value.</p></td></tr><tr><td><p><code>encoding</code></p></td><td><p>The encoding to apply to the <code>String</code> value. Accepts encodings that are supported by your JDK. For example, <code>encoding</code> accepts Java canonical names and aliases for the basic and extended encoding sets in Oracle JDK 8 and JDK 11.</p></td></tr></tbody></table>

### Example

This example shows how `toBinary` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  'UTF-16Ex': toBinary("DW", "UTF-16"),
  'utf16Ex': toBinary("DW", "utf16"),
  'UnicodeBigEx': toBinary("DW", "UnicodeBig"),
  'UTF-32Ex': toBinary("DW", "UTF-32"),
  'UTF_32Ex': toBinary("DW", "UTF_32")
}
```

#### Output

```Json
{
  "UTF-16Ex": "/v8ARABX" as Binary {base: "64"},
  utf16Ex: "/v8ARABX" as Binary {base: "64"},
  UnicodeBigEx: "/v8ARABX" as Binary {base: "64"},
  "UTF-32Ex": "AAAARAAAAFc=" as Binary {base: "64"},
  UTF_32Ex: "AAAARAAAAFc=" as Binary {base: "64"}
}
```

<!-- document id=19587c2a70beea30b25c93c1f4fc74328746404d3996f3049076e70dc1bbc5f6 url=/mulesoft/current/en-us/dataweave/2.9/dw-numbers-functions-tobinary.md -->

---
product: DataWeave
version: 2.9
---

# toBinary

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toBinary(number: Number): String

Transforms a decimal number into a binary number.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The input number.</p></td></tr></tbody></table>

### Example

This example shows how the `toBinary` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import toBinary from dw::core::Numbers
output application/json
---
{
    a: toBinary(-2),
    b: toBinary(100000000000000000000000000000000000000000000000000000000000000),
    c: toBinary(0),
    d: toBinary(null),
    e: toBinary(2),
}
```

#### Output

```JSON
{
  "a": "-10",
  "b": "11111000111010111010110100101011100001001110000011010101100010111101001011100000100010011000011101100101101001111101111010110010010100110010100100000000000000000000000000000000000000000000000000000000000000",
  "c": "0",
  "d": null,
  "e": "10"
}
```

## toBinary(number: Null): Null

Helper function that enables `toBinary` to work with null value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=55e5a56e69c47429eb89a1b36ab95489853f5ca898e39f8d0fb667d65cecf4aa url=/mulesoft/current/en-us/dataweave/latest/dw-coercions-functions-tobinary.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# toBinary

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toBinary(str: String, encoding: String): Binary

Transform a `String` value into a `Binary` value using the specified encoding.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>Binary</code> value.</p></td></tr><tr><td><p><code>encoding</code></p></td><td><p>The encoding to apply to the <code>String</code> value. Accepts encodings that are supported by your JDK. For example, <code>encoding</code> accepts Java canonical names and aliases for the basic and extended encoding sets in Oracle JDK 8 and JDK 11.</p></td></tr></tbody></table>

### Example

This example shows how `toBinary` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  'UTF-16Ex': toBinary("DW", "UTF-16"),
  'utf16Ex': toBinary("DW", "utf16"),
  'UnicodeBigEx': toBinary("DW", "UnicodeBig"),
  'UTF-32Ex': toBinary("DW", "UTF-32"),
  'UTF_32Ex': toBinary("DW", "UTF_32")
}
```

#### Output

```Json
{
  "UTF-16Ex": "/v8ARABX" as Binary {base: "64"},
  utf16Ex: "/v8ARABX" as Binary {base: "64"},
  UnicodeBigEx: "/v8ARABX" as Binary {base: "64"},
  "UTF-32Ex": "AAAARAAAAFc=" as Binary {base: "64"},
  UTF_32Ex: "AAAARAAAAFc=" as Binary {base: "64"}
}
```

<!-- document id=de99dec4530ef9194962ff31c18df5637152888782c5f98969e4300cb5d3a672 url=/mulesoft/current/en-us/dataweave/latest/dw-numbers-functions-tobinary.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# toBinary

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toBinary(number: Number): String

Transforms a decimal number into a binary number.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The input number.</p></td></tr></tbody></table>

### Example

This example shows how the `toBinary` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import toBinary from dw::core::Numbers
output application/json
---
{
    a: toBinary(-2),
    b: toBinary(100000000000000000000000000000000000000000000000000000000000000),
    c: toBinary(0),
    d: toBinary(null),
    e: toBinary(2),
}
```

#### Output

```JSON
{
  "a": "-10",
  "b": "11111000111010111010110100101011100001001110000011010101100010111101001011100000100010011000011101100101101001111101111010110010010100110010100100000000000000000000000000000000000000000000000000000000000000",
  "c": "0",
  "d": null,
  "e": "10"
}
```

## toBinary(number: Null): Null

Helper function that enables `toBinary` to work with null value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=ddea37d1843c75ce447a58c6ff22b4ead30de31993909f35022e53c2590ff854 url=/mulesoft/current/en-us/dataweave/2.11/dw-coercions-functions-toboolean.md -->

---
product: DataWeave
version: 2.11
---

# toBoolean

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toBoolean(str: String): Boolean

Transform a `String` value into a `Boolean` value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>Boolean</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toBoolean` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
  a: toBoolean("true"),
  b: toBoolean("false"),
  c: toBoolean("FALSE"),
  d: toBoolean("TrUe")
}
```

#### Output

```Json
{
  "a": true,
  "b": false,
  "c": false,
  "d": true
}
```

<!-- document id=42d2f002882c4c377bcdf4171c96e1d36194c7592e1624e09722f60cc9c052bb url=/mulesoft/current/en-us/dataweave/2.12/dw-coercions-functions-toboolean.md -->

---
product: DataWeave
version: 2.12
---

# toBoolean

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toBoolean(str: String): Boolean

Transform a `String` value into a `Boolean` value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>Boolean</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toBoolean` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
  a: toBoolean("true"),
  b: toBoolean("false"),
  c: toBoolean("FALSE"),
  d: toBoolean("TrUe")
}
```

#### Output

```Json
{
  "a": true,
  "b": false,
  "c": false,
  "d": true
}
```

<!-- document id=21a5e04df1eb5fdb7c1f4c1067cd2a12044775ab78ac1387db832d30c6de8b72 url=/mulesoft/current/en-us/dataweave/2.4/dw-coercions-functions-toboolean.md -->

---
product: DataWeave
version: 2.4
---

# toBoolean

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toBoolean(str: String): Boolean

Transform a `String` value into a `Boolean` value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>Boolean</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toBoolean` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
  a: toBoolean("true"),
  b: toBoolean("false"),
  c: toBoolean("FALSE"),
  d: toBoolean("TrUe")
}
```

#### Output

```Json
{
  "a": true,
  "b": false,
  "c": false,
  "d": true
}
```

<!-- document id=8ef2b760c2181b3a12e1b5cd73dd13e525ae5d21f24da30e57c8f5799b228054 url=/mulesoft/current/en-us/dataweave/2.6/dw-coercions-functions-toboolean.md -->

---
product: DataWeave
version: 2.6
---

# toBoolean

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toBoolean(str: String): Boolean

Transform a `String` value into a `Boolean` value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>Boolean</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toBoolean` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
  a: toBoolean("true"),
  b: toBoolean("false"),
  c: toBoolean("FALSE"),
  d: toBoolean("TrUe")
}
```

#### Output

```Json
{
  "a": true,
  "b": false,
  "c": false,
  "d": true
}
```

<!-- document id=89e1d6b1e62649841ef4e828af647fe681216073b5fc8aaf50884243cf81321d url=/mulesoft/current/en-us/dataweave/2.9/dw-coercions-functions-toboolean.md -->

---
product: DataWeave
version: 2.9
---

# toBoolean

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toBoolean(str: String): Boolean

Transform a `String` value into a `Boolean` value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>Boolean</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toBoolean` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
  a: toBoolean("true"),
  b: toBoolean("false"),
  c: toBoolean("FALSE"),
  d: toBoolean("TrUe")
}
```

#### Output

```Json
{
  "a": true,
  "b": false,
  "c": false,
  "d": true
}
```

<!-- document id=d6ac766680dea7c9e62070805b925d14f756aa65e929804eb1003c2f0967b2b4 url=/mulesoft/current/en-us/dataweave/latest/dw-coercions-functions-toboolean.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# toBoolean

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toBoolean(str: String): Boolean

Transform a `String` value into a `Boolean` value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>Boolean</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toBoolean` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
  a: toBoolean("true"),
  b: toBoolean("false"),
  c: toBoolean("FALSE"),
  d: toBoolean("TrUe")
}
```

#### Output

```Json
{
  "a": true,
  "b": false,
  "c": false,
  "d": true
}
```

<!-- document id=6295e963ffdac6a7d8ebc44ab872d5524ebb523de10259ee1491c4bba00e03d9 url=/mulesoft/current/en-us/dataweave/2.11/dw-coercions-functions-todate.md -->

---
product: DataWeave
version: 2.11
---

# toDate

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toDate(str: String, formatters: Array<Formatter>): Date

Transforms a `String` value into a `Date` value using the first `Formatter` that matches with the
given value to transform.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>Date</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>Date</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toDate` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
import * from dw::Runtime
output application/dw
---
{
  a: toDate("2023-28-03", [{format: "yyyy/MM/dd"}, {format: "yyyy-dd-MM", locale: "en_US"}]),
  b: try(() -> toDate("2023-28-03", [{format: "yyyy/MM/dd"}])).error.message
}
```

#### Output

```DataWeave
{
  a: |2023-03-28| as Date {format: "yyyy-dd-MM", locale: "en_US"},
  b: "Could not find a valid formatter for '2023-28-03'"
}
```

## toDate(str: String, format: String | Null = null, locale: String | Null = null): Date

Transforms a `String` value into a `Date` value and accepts a format and locale.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>Date</code> value.</p></td></tr><tr><td><p><code>format</code></p></td><td><p>The formatting to use on the <code>Date</code> value. A <code>null</code> value has no effect on the <code>Date</code> value. This parameter accepts Java character patterns based on ISO-8601. A <code>Date</code> value, such as <code>2011-12-03</code>, has the format <code>uuuu-MM-dd</code>.</p></td></tr><tr><td><p><code>locale</code></p></td><td><p>Optional ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default.</p></td></tr></tbody></table>

### Example

This example shows how `toDate` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  a: toDate("2015-10-01"),
  b: toDate("2003/10/01","uuuu/MM/dd")
}
```

#### Output

```DataWeave
{
  a: |2015-10-01|,
  b: |2003-10-01| as Date {format: "uuuu/MM/dd"}
}
```

<!-- document id=d3c301e3e771da7f6b692a510f9caf0b309c283dcf94f80e87e0c221fe218913 url=/mulesoft/current/en-us/dataweave/2.12/dw-coercions-functions-todate.md -->

---
product: DataWeave
version: 2.12
---

# toDate

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toDate(str: String, formatters: Array<Formatter>): Date

Transforms a `String` value into a `Date` value using the first `Formatter` that matches with the
given value to transform.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>Date</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>Date</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toDate` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
import * from dw::Runtime
output application/dw
---
{
  a: toDate("2023-28-03", [{format: "yyyy/MM/dd"}, {format: "yyyy-dd-MM", locale: "en_US"}]),
  b: try(() -> toDate("2023-28-03", [{format: "yyyy/MM/dd"}])).error.message
}
```

#### Output

```DataWeave
{
  a: |2023-03-28| as Date {format: "yyyy-dd-MM", locale: "en_US"},
  b: "Could not find a valid formatter for '2023-28-03'"
}
```

## toDate(str: String, format: String | Null = null, locale: String | Null = null): Date

Transforms a `String` value into a `Date` value and accepts a format and locale.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>Date</code> value.</p></td></tr><tr><td><p><code>format</code></p></td><td><p>The formatting to use on the <code>Date</code> value. A <code>null</code> value has no effect on the <code>Date</code> value. This parameter accepts Java character patterns based on ISO-8601. A <code>Date</code> value, such as <code>2011-12-03</code>, has the format <code>uuuu-MM-dd</code>.</p></td></tr><tr><td><p><code>locale</code></p></td><td><p>Optional ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default.</p></td></tr></tbody></table>

### Example

This example shows how `toDate` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  a: toDate("2015-10-01"),
  b: toDate("2003/10/01","uuuu/MM/dd")
}
```

#### Output

```DataWeave
{
  a: |2015-10-01|,
  b: |2003-10-01| as Date {format: "uuuu/MM/dd"}
}
```

<!-- document id=9addc02eaf1162f729516e86cf0c9dab2d3c7f653dc03d33cacafcc068fce2b7 url=/mulesoft/current/en-us/dataweave/2.4/dw-coercions-functions-todate.md -->

---
product: DataWeave
version: 2.4
---

# toDate

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toDate(str: String, format: String | Null = null, locale: String | Null = null): Date

Transforms a `String` value into a `Date` value and accepts a format and locale.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>Date</code> value.</p></td></tr><tr><td><p><code>format</code></p></td><td><p>The formatting to use on the <code>Date</code> value. A <code>null</code> value has no effect on the <code>Date</code> value. This parameter accepts Java character patterns based on ISO-8601. A <code>Date</code> value, such as <code>2011-12-03</code>, has the format <code>uuuu-MM-dd</code>.</p></td></tr><tr><td><p><code>locale</code></p></td><td><p>Optional ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default.</p></td></tr></tbody></table>

### Example

This example shows how `toDate` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  a: toDate("2015-10-01"),
  b: toDate("2003/10/01","uuuu/MM/dd")
}
```

#### Output

```DataWeave
{
  a: |2015-10-01|,
  b: |2003-10-01| as Date {format: "uuuu/MM/dd"}
}
```

<!-- document id=d69ccb9b27e5a2dc2eb46ee511157992678f4441b9df9396156d7c7c77a583a1 url=/mulesoft/current/en-us/dataweave/2.6/dw-coercions-functions-todate.md -->

---
product: DataWeave
version: 2.6
---

# toDate

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toDate(str: String, formatters: Array<Formatter>): Date

Transforms a `String` value into a `Date` value using the first `Formatter` that matches with the
given value to transform.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>Date</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>Date</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toDate` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
import * from dw::Runtime
output application/dw
---
{
  a: toDate("2023-28-03", [{format: "yyyy/MM/dd"}, {format: "yyyy-dd-MM", locale: "en_US"}]),
  b: try(() -> toDate("2023-28-03", [{format: "yyyy/MM/dd"}])).error.message
}
```

#### Output

```DataWeave
{
  a: |2023-03-28| as Date {format: "yyyy-dd-MM", locale: "en_US"},
  b: "Could not find a valid formatter for '2023-28-03'"
}
```

## toDate(str: String, format: String | Null = null, locale: String | Null = null): Date

Transforms a `String` value into a `Date` value and accepts a format and locale.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>Date</code> value.</p></td></tr><tr><td><p><code>format</code></p></td><td><p>The formatting to use on the <code>Date</code> value. A <code>null</code> value has no effect on the <code>Date</code> value. This parameter accepts Java character patterns based on ISO-8601. A <code>Date</code> value, such as <code>2011-12-03</code>, has the format <code>uuuu-MM-dd</code>.</p></td></tr><tr><td><p><code>locale</code></p></td><td><p>Optional ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default.</p></td></tr></tbody></table>

### Example

This example shows how `toDate` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  a: toDate("2015-10-01"),
  b: toDate("2003/10/01","uuuu/MM/dd")
}
```

#### Output

```DataWeave
{
  a: |2015-10-01|,
  b: |2003-10-01| as Date {format: "uuuu/MM/dd"}
}
```

<!-- document id=fc17e5e2710fc46febf71bfc592843a0965c1f10682df7d5f87b7e13b7dca48b url=/mulesoft/current/en-us/dataweave/2.9/dw-coercions-functions-todate.md -->

---
product: DataWeave
version: 2.9
---

# toDate

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toDate(str: String, formatters: Array<Formatter>): Date

Transforms a `String` value into a `Date` value using the first `Formatter` that matches with the
given value to transform.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>Date</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>Date</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toDate` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
import * from dw::Runtime
output application/dw
---
{
  a: toDate("2023-28-03", [{format: "yyyy/MM/dd"}, {format: "yyyy-dd-MM", locale: "en_US"}]),
  b: try(() -> toDate("2023-28-03", [{format: "yyyy/MM/dd"}])).error.message
}
```

#### Output

```DataWeave
{
  a: |2023-03-28| as Date {format: "yyyy-dd-MM", locale: "en_US"},
  b: "Could not find a valid formatter for '2023-28-03'"
}
```

## toDate(str: String, format: String | Null = null, locale: String | Null = null): Date

Transforms a `String` value into a `Date` value and accepts a format and locale.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>Date</code> value.</p></td></tr><tr><td><p><code>format</code></p></td><td><p>The formatting to use on the <code>Date</code> value. A <code>null</code> value has no effect on the <code>Date</code> value. This parameter accepts Java character patterns based on ISO-8601. A <code>Date</code> value, such as <code>2011-12-03</code>, has the format <code>uuuu-MM-dd</code>.</p></td></tr><tr><td><p><code>locale</code></p></td><td><p>Optional ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default.</p></td></tr></tbody></table>

### Example

This example shows how `toDate` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  a: toDate("2015-10-01"),
  b: toDate("2003/10/01","uuuu/MM/dd")
}
```

#### Output

```DataWeave
{
  a: |2015-10-01|,
  b: |2003-10-01| as Date {format: "uuuu/MM/dd"}
}
```

<!-- document id=f20fc7b19ad1cfee443ae770993cf0aceb713f9fd26c9dcb519f5cb1031b4f57 url=/mulesoft/current/en-us/dataweave/latest/dw-coercions-functions-todate.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# toDate

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toDate(str: String, formatters: Array<Formatter>): Date

Transforms a `String` value into a `Date` value using the first `Formatter` that matches with the
given value to transform.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>Date</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>Date</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toDate` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
import * from dw::Runtime
output application/dw
---
{
  a: toDate("2023-28-03", [{format: "yyyy/MM/dd"}, {format: "yyyy-dd-MM", locale: "en_US"}]),
  b: try(() -> toDate("2023-28-03", [{format: "yyyy/MM/dd"}])).error.message
}
```

#### Output

```DataWeave
{
  a: |2023-03-28| as Date {format: "yyyy-dd-MM", locale: "en_US"},
  b: "Could not find a valid formatter for '2023-28-03'"
}
```

## toDate(str: String, format: String | Null = null, locale: String | Null = null): Date

Transforms a `String` value into a `Date` value and accepts a format and locale.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>Date</code> value.</p></td></tr><tr><td><p><code>format</code></p></td><td><p>The formatting to use on the <code>Date</code> value. A <code>null</code> value has no effect on the <code>Date</code> value. This parameter accepts Java character patterns based on ISO-8601. A <code>Date</code> value, such as <code>2011-12-03</code>, has the format <code>uuuu-MM-dd</code>.</p></td></tr><tr><td><p><code>locale</code></p></td><td><p>Optional ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default.</p></td></tr></tbody></table>

### Example

This example shows how `toDate` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  a: toDate("2015-10-01"),
  b: toDate("2003/10/01","uuuu/MM/dd")
}
```

#### Output

```DataWeave
{
  a: |2015-10-01|,
  b: |2003-10-01| as Date {format: "uuuu/MM/dd"}
}
```

<!-- document id=839bc3d0d8e31baf568f9cc591ca33cd0a0e79be5ab1f8092a1a31e956750d61 url=/mulesoft/current/en-us/dataweave/2.11/dw-coercions-functions-todateornull.md -->

---
product: DataWeave
version: 2.11
---

# toDateOrNull

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toDateOrNull(str: String, formatters: Array<Formatter>): Date | Null

Transforms a `String` value into a `Date` value using the first `Formatter` that matches with the
given value to transform.

If none of the `Formatter` matches with the given value, the function returns a `null` value.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>Date</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>Date</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toDateOrNull` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  a: toDateOrNull("2023-28-03", [{format: "yyyy/MM/dd"}, {format: "yyyy-dd-MM", locale: "en_US"}]),
  b: toDateOrNull("2023-28-03", [{format: "yyyy/MM/dd"}])
}
```

#### Output

```DataWeave
{
  a: |2023-03-28| as Date {format: "yyyy-dd-MM", locale: "en_US"},
  b: null
}
```

<!-- document id=5eec49a10856abbac710ae459a2a5abdcb7f0961959fc35bd96e309e1e3d55fb url=/mulesoft/current/en-us/dataweave/2.12/dw-coercions-functions-todateornull.md -->

---
product: DataWeave
version: 2.12
---

# toDateOrNull

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toDateOrNull(str: String, formatters: Array<Formatter>): Date | Null

Transforms a `String` value into a `Date` value using the first `Formatter` that matches with the
given value to transform.

If none of the `Formatter` matches with the given value, the function returns a `null` value.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>Date</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>Date</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toDateOrNull` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  a: toDateOrNull("2023-28-03", [{format: "yyyy/MM/dd"}, {format: "yyyy-dd-MM", locale: "en_US"}]),
  b: toDateOrNull("2023-28-03", [{format: "yyyy/MM/dd"}])
}
```

#### Output

```DataWeave
{
  a: |2023-03-28| as Date {format: "yyyy-dd-MM", locale: "en_US"},
  b: null
}
```

<!-- document id=5ca9663637db660e24e437a41a56190c7573b0d8009b18391e93dfacc4d9e451 url=/mulesoft/current/en-us/dataweave/2.6/dw-coercions-functions-todateornull.md -->

---
product: DataWeave
version: 2.6
---

# toDateOrNull

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toDateOrNull(str: String, formatters: Array<Formatter>): Date | Null

Transforms a `String` value into a `Date` value using the first `Formatter` that matches with the
given value to transform.

If none of the `Formatter` matches with the given value, the function returns a `null` value.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>Date</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>Date</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toDateOrNull` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  a: toDateOrNull("2023-28-03", [{format: "yyyy/MM/dd"}, {format: "yyyy-dd-MM", locale: "en_US"}]),
  b: toDateOrNull("2023-28-03", [{format: "yyyy/MM/dd"}])
}
```

#### Output

```DataWeave
{
  a: |2023-03-28| as Date {format: "yyyy-dd-MM", locale: "en_US"},
  b: null
}
```

<!-- document id=d42d85b8e590f142fba6fe492db5df4630718ce953ec4e959c6b4e6c8ab4e77e url=/mulesoft/current/en-us/dataweave/2.9/dw-coercions-functions-todateornull.md -->

---
product: DataWeave
version: 2.9
---

# toDateOrNull

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toDateOrNull(str: String, formatters: Array<Formatter>): Date | Null

Transforms a `String` value into a `Date` value using the first `Formatter` that matches with the
given value to transform.

If none of the `Formatter` matches with the given value, the function returns a `null` value.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>Date</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>Date</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toDateOrNull` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  a: toDateOrNull("2023-28-03", [{format: "yyyy/MM/dd"}, {format: "yyyy-dd-MM", locale: "en_US"}]),
  b: toDateOrNull("2023-28-03", [{format: "yyyy/MM/dd"}])
}
```

#### Output

```DataWeave
{
  a: |2023-03-28| as Date {format: "yyyy-dd-MM", locale: "en_US"},
  b: null
}
```

<!-- document id=cdb94b0ca4636cab57d8b499a638a937bc3d944e2417bc75a6b4262490799a74 url=/mulesoft/current/en-us/dataweave/latest/dw-coercions-functions-todateornull.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# toDateOrNull

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toDateOrNull(str: String, formatters: Array<Formatter>): Date | Null

Transforms a `String` value into a `Date` value using the first `Formatter` that matches with the
given value to transform.

If none of the `Formatter` matches with the given value, the function returns a `null` value.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>Date</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>Date</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toDateOrNull` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  a: toDateOrNull("2023-28-03", [{format: "yyyy/MM/dd"}, {format: "yyyy-dd-MM", locale: "en_US"}]),
  b: toDateOrNull("2023-28-03", [{format: "yyyy/MM/dd"}])
}
```

#### Output

```DataWeave
{
  a: |2023-03-28| as Date {format: "yyyy-dd-MM", locale: "en_US"},
  b: null
}
```

<!-- document id=43b3c31b282270492aff0aad7c6a33bcc00f8f8e598951fbfa582094ba50916e url=/mulesoft/current/en-us/dataweave/2.11/dw-coercions-functions-todatetime.md -->

---
product: DataWeave
version: 2.11
---

# toDateTime

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toDateTime(str: String, formatters: Array<Formatter>): DateTime

Transforms a `String` value into a `DateTime` value using the first `Formatter` that matches with
the given value to transform.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>DateTime</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>DateTime</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toDateTime` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
import * from dw::Runtime
output application/dw
---
{
  a: toDateTime("2003-10-01 23:57:59Z", [{format: "uuuu/MM/dd HH:mm:ssz"}, {format: "uuuu-MM-dd HH:mm:ssz"}]),
  b: try(() -> toDateTime("2003-10-01 23:57:59Z", [{format: "uuuu/MM/dd HH:mm:ssz"}])).error.message
}
```

#### Output

```DataWeave
{
  a: |2003-10-01T23:57:59Z| as DateTime {format: "uuuu-MM-dd HH:mm:ssz"},
  b: "Could not find a valid formatter for '2003-10-01 23:57:59Z'"
}
```

## toDateTime(number: Number, unit: MillisOrSecs | Null = null): DateTime

Transforms a `Number` value into a `DateTime` value using `milliseconds` or `seconds` as the unit.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The <code>Number</code> value to transform into a <code>DateTime</code> value.</p></td></tr><tr><td><p><code>unit</code></p></td><td><p>The unit to use for the conversion: <code>"milliseconds"</code> or <code>"seconds"</code>. A <code>null</code> value for the <code>unit</code> field defaults to <code>"seconds"</code>.</p></td></tr></tbody></table>

### Example

This example shows how `toDateTime` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
    fromEpoch: toDateTime(1443743879),
    fromMillis: toDateTime(1443743879000, "milliseconds")
}
```

#### Output

```DataWeave
{
  fromEpoch: |2015-10-01T23:57:59Z|,
  fromMillis: |2015-10-01T23:57:59Z| as DateTime {unit: "milliseconds"}
}
```

## toDateTime(str: String, format: String | Null = null, locale: String | Null = null): DateTime

Transforms a `String` value into a `DateTime` value and accepts a format and locale.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>DateTime</code> value.</p></td></tr><tr><td><p><code>format</code></p></td><td><p>The formatting to use on the <code>DateTime</code> value. A <code>null</code> value has no effect on the <code>DateTime</code> value. This parameter accepts Java character patterns based on ISO-8601. A <code>DateTime</code> value, such as <code>2011-12-03T10:15:30.000000+01:00</code>, has the format <code>uuuu-MM-dd HH:mm:ssz</code>.</p></td></tr><tr><td><p><code>locale</code></p></td><td><p>Optional ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default.</p></td></tr></tbody></table>

### Example

This example shows how `toDateTime` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
   a: toDateTime("2015-10-01T23:57:59Z"),
   b: toDateTime("2003-10-01 23:57:59Z","uuuu-MM-dd HH:mm:ssz")
}
```

#### Output

```DataWeave
{
  a: |2015-10-01T23:57:59Z|,
  b: |2003-10-01T23:57:59Z| as DateTime {format: "uuuu-MM-dd HH:mm:ssz"}
}
```

<!-- document id=4217e4b65f671f33433dd698cb7e739c39788f38c4c89656c19e757f9520cf52 url=/mulesoft/current/en-us/dataweave/2.12/dw-coercions-functions-todatetime.md -->

---
product: DataWeave
version: 2.12
---

# toDateTime

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toDateTime(str: String, formatters: Array<Formatter>): DateTime

Transforms a `String` value into a `DateTime` value using the first `Formatter` that matches with
the given value to transform.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>DateTime</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>DateTime</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toDateTime` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
import * from dw::Runtime
output application/dw
---
{
  a: toDateTime("2003-10-01 23:57:59Z", [{format: "uuuu/MM/dd HH:mm:ssz"}, {format: "uuuu-MM-dd HH:mm:ssz"}]),
  b: try(() -> toDateTime("2003-10-01 23:57:59Z", [{format: "uuuu/MM/dd HH:mm:ssz"}])).error.message
}
```

#### Output

```DataWeave
{
  a: |2003-10-01T23:57:59Z| as DateTime {format: "uuuu-MM-dd HH:mm:ssz"},
  b: "Could not find a valid formatter for '2003-10-01 23:57:59Z'"
}
```

## toDateTime(number: Number, unit: MillisOrSecs | Null = null): DateTime

Transforms a `Number` value into a `DateTime` value using `milliseconds` or `seconds` as the unit.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The <code>Number</code> value to transform into a <code>DateTime</code> value.</p></td></tr><tr><td><p><code>unit</code></p></td><td><p>The unit to use for the conversion: <code>"milliseconds"</code> or <code>"seconds"</code>. A <code>null</code> value for the <code>unit</code> field defaults to <code>"seconds"</code>.</p></td></tr></tbody></table>

### Example

This example shows how `toDateTime` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
    fromEpoch: toDateTime(1443743879),
    fromMillis: toDateTime(1443743879000, "milliseconds")
}
```

#### Output

```DataWeave
{
  fromEpoch: |2015-10-01T23:57:59Z|,
  fromMillis: |2015-10-01T23:57:59Z| as DateTime {unit: "milliseconds"}
}
```

## toDateTime(str: String, format: String | Null = null, locale: String | Null = null): DateTime

Transforms a `String` value into a `DateTime` value and accepts a format and locale.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>DateTime</code> value.</p></td></tr><tr><td><p><code>format</code></p></td><td><p>The formatting to use on the <code>DateTime</code> value. A <code>null</code> value has no effect on the <code>DateTime</code> value. This parameter accepts Java character patterns based on ISO-8601. A <code>DateTime</code> value, such as <code>2011-12-03T10:15:30.000000+01:00</code>, has the format <code>uuuu-MM-dd HH:mm:ssz</code>.</p></td></tr><tr><td><p><code>locale</code></p></td><td><p>Optional ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default.</p></td></tr></tbody></table>

### Example

This example shows how `toDateTime` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
   a: toDateTime("2015-10-01T23:57:59Z"),
   b: toDateTime("2003-10-01 23:57:59Z","uuuu-MM-dd HH:mm:ssz")
}
```

#### Output

```DataWeave
{
  a: |2015-10-01T23:57:59Z|,
  b: |2003-10-01T23:57:59Z| as DateTime {format: "uuuu-MM-dd HH:mm:ssz"}
}
```

<!-- document id=de8d48806ed946b3173e912851a38d0d8acfeb10a7d483755cb185b5484280b5 url=/mulesoft/current/en-us/dataweave/2.4/dw-coercions-functions-todatetime.md -->

---
product: DataWeave
version: 2.4
---

# toDateTime

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toDateTime(number: Number, unit: MillisOrSecs | Null = null): DateTime

Transforms a `Number` value into a `DateTime` value using `milliseconds` or `seconds` as the unit.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The <code>Number</code> value to transform into a <code>DateTime</code> value.</p></td></tr><tr><td><p><code>unit</code></p></td><td><p>The unit to use for the conversion: <code>"milliseconds"</code> or <code>"seconds"</code>. A <code>null</code> value for the <code>unit</code> field defaults to <code>"seconds"</code>.</p></td></tr></tbody></table>

### Example

This example shows how `toDateTime` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
    fromEpoch: toDateTime(1443743879),
    fromMillis: toDateTime(1443743879000, "milliseconds")
}
```

#### Output

```DataWeave
{
  fromEpoch: |2015-10-01T23:57:59Z|,
  fromMillis: |2015-10-01T23:57:59Z| as DateTime {unit: "milliseconds"}
}
```

## toDateTime(str: String, format: String | Null = null, locale: String | Null = null): DateTime

Transforms a `String` value into a `DateTime` value and accepts a format and locale.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>DateTime</code> value.</p></td></tr><tr><td><p><code>format</code></p></td><td><p>The formatting to use on the <code>DateTime</code> value. A <code>null</code> value has no effect on the <code>DateTime</code> value. This parameter accepts Java character patterns based on ISO-8601. A <code>DateTime</code> value, such as <code>2011-12-03T10:15:30.000000+01:00</code>, has the format <code>uuuu-MM-dd HH:mm:ssz</code>.</p></td></tr><tr><td><p><code>locale</code></p></td><td><p>Optional ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default.</p></td></tr></tbody></table>

### Example

This example shows how `toDateTime` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
   a: toDateTime("2015-10-01T23:57:59Z"),
   b: toDateTime("2003-10-01 23:57:59Z","uuuu-MM-dd HH:mm:ssz")
}
```

#### Output

```DataWeave
{
  a: |2015-10-01T23:57:59Z|,
  b: |2003-10-01T23:57:59Z| as DateTime {format: "uuuu-MM-dd HH:mm:ssz"}
}
```

<!-- document id=8800a846174ff35d9266a5cc0dc96f508c4566ceb225c3aa5e54c31fc27e41a6 url=/mulesoft/current/en-us/dataweave/2.6/dw-coercions-functions-todatetime.md -->

---
product: DataWeave
version: 2.6
---

# toDateTime

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toDateTime(str: String, formatters: Array<Formatter>): DateTime

Transforms a `String` value into a `DateTime` value using the first `Formatter` that matches with
the given value to transform.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>DateTime</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>DateTime</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toDateTime` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
import * from dw::Runtime
output application/dw
---
{
  a: toDateTime("2003-10-01 23:57:59Z", [{format: "uuuu/MM/dd HH:mm:ssz"}, {format: "uuuu-MM-dd HH:mm:ssz"}]),
  b: try(() -> toDateTime("2003-10-01 23:57:59Z", [{format: "uuuu/MM/dd HH:mm:ssz"}])).error.message
}
```

#### Output

```DataWeave
{
  a: |2003-10-01T23:57:59Z| as DateTime {format: "uuuu-MM-dd HH:mm:ssz"},
  b: "Could not find a valid formatter for '2003-10-01 23:57:59Z'"
}
```

## toDateTime(number: Number, unit: MillisOrSecs | Null = null): DateTime

Transforms a `Number` value into a `DateTime` value using `milliseconds` or `seconds` as the unit.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The <code>Number</code> value to transform into a <code>DateTime</code> value.</p></td></tr><tr><td><p><code>unit</code></p></td><td><p>The unit to use for the conversion: <code>"milliseconds"</code> or <code>"seconds"</code>. A <code>null</code> value for the <code>unit</code> field defaults to <code>"seconds"</code>.</p></td></tr></tbody></table>

### Example

This example shows how `toDateTime` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
    fromEpoch: toDateTime(1443743879),
    fromMillis: toDateTime(1443743879000, "milliseconds")
}
```

#### Output

```DataWeave
{
  fromEpoch: |2015-10-01T23:57:59Z|,
  fromMillis: |2015-10-01T23:57:59Z| as DateTime {unit: "milliseconds"}
}
```

## toDateTime(str: String, format: String | Null = null, locale: String | Null = null): DateTime

Transforms a `String` value into a `DateTime` value and accepts a format and locale.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>DateTime</code> value.</p></td></tr><tr><td><p><code>format</code></p></td><td><p>The formatting to use on the <code>DateTime</code> value. A <code>null</code> value has no effect on the <code>DateTime</code> value. This parameter accepts Java character patterns based on ISO-8601. A <code>DateTime</code> value, such as <code>2011-12-03T10:15:30.000000+01:00</code>, has the format <code>uuuu-MM-dd HH:mm:ssz</code>.</p></td></tr><tr><td><p><code>locale</code></p></td><td><p>Optional ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default.</p></td></tr></tbody></table>

### Example

This example shows how `toDateTime` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
   a: toDateTime("2015-10-01T23:57:59Z"),
   b: toDateTime("2003-10-01 23:57:59Z","uuuu-MM-dd HH:mm:ssz")
}
```

#### Output

```DataWeave
{
  a: |2015-10-01T23:57:59Z|,
  b: |2003-10-01T23:57:59Z| as DateTime {format: "uuuu-MM-dd HH:mm:ssz"}
}
```

<!-- document id=f7facd9ebe773105789c8ed5ce66374530301c19d02f0c599a9f3e476919b2cb url=/mulesoft/current/en-us/dataweave/2.9/dw-coercions-functions-todatetime.md -->

---
product: DataWeave
version: 2.9
---

# toDateTime

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toDateTime(str: String, formatters: Array<Formatter>): DateTime

Transforms a `String` value into a `DateTime` value using the first `Formatter` that matches with
the given value to transform.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>DateTime</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>DateTime</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toDateTime` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
import * from dw::Runtime
output application/dw
---
{
  a: toDateTime("2003-10-01 23:57:59Z", [{format: "uuuu/MM/dd HH:mm:ssz"}, {format: "uuuu-MM-dd HH:mm:ssz"}]),
  b: try(() -> toDateTime("2003-10-01 23:57:59Z", [{format: "uuuu/MM/dd HH:mm:ssz"}])).error.message
}
```

#### Output

```DataWeave
{
  a: |2003-10-01T23:57:59Z| as DateTime {format: "uuuu-MM-dd HH:mm:ssz"},
  b: "Could not find a valid formatter for '2003-10-01 23:57:59Z'"
}
```

## toDateTime(number: Number, unit: MillisOrSecs | Null = null): DateTime

Transforms a `Number` value into a `DateTime` value using `milliseconds` or `seconds` as the unit.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The <code>Number</code> value to transform into a <code>DateTime</code> value.</p></td></tr><tr><td><p><code>unit</code></p></td><td><p>The unit to use for the conversion: <code>"milliseconds"</code> or <code>"seconds"</code>. A <code>null</code> value for the <code>unit</code> field defaults to <code>"seconds"</code>.</p></td></tr></tbody></table>

### Example

This example shows how `toDateTime` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
    fromEpoch: toDateTime(1443743879),
    fromMillis: toDateTime(1443743879000, "milliseconds")
}
```

#### Output

```DataWeave
{
  fromEpoch: |2015-10-01T23:57:59Z|,
  fromMillis: |2015-10-01T23:57:59Z| as DateTime {unit: "milliseconds"}
}
```

## toDateTime(str: String, format: String | Null = null, locale: String | Null = null): DateTime

Transforms a `String` value into a `DateTime` value and accepts a format and locale.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>DateTime</code> value.</p></td></tr><tr><td><p><code>format</code></p></td><td><p>The formatting to use on the <code>DateTime</code> value. A <code>null</code> value has no effect on the <code>DateTime</code> value. This parameter accepts Java character patterns based on ISO-8601. A <code>DateTime</code> value, such as <code>2011-12-03T10:15:30.000000+01:00</code>, has the format <code>uuuu-MM-dd HH:mm:ssz</code>.</p></td></tr><tr><td><p><code>locale</code></p></td><td><p>Optional ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default.</p></td></tr></tbody></table>

### Example

This example shows how `toDateTime` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
   a: toDateTime("2015-10-01T23:57:59Z"),
   b: toDateTime("2003-10-01 23:57:59Z","uuuu-MM-dd HH:mm:ssz")
}
```

#### Output

```DataWeave
{
  a: |2015-10-01T23:57:59Z|,
  b: |2003-10-01T23:57:59Z| as DateTime {format: "uuuu-MM-dd HH:mm:ssz"}
}
```

<!-- document id=6f32ac87041f93d55f835ae32147691871504566f9a898a4a9eeba957311b456 url=/mulesoft/current/en-us/dataweave/latest/dw-coercions-functions-todatetime.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# toDateTime

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toDateTime(str: String, formatters: Array<Formatter>): DateTime

Transforms a `String` value into a `DateTime` value using the first `Formatter` that matches with
the given value to transform.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>DateTime</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>DateTime</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toDateTime` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
import * from dw::Runtime
output application/dw
---
{
  a: toDateTime("2003-10-01 23:57:59Z", [{format: "uuuu/MM/dd HH:mm:ssz"}, {format: "uuuu-MM-dd HH:mm:ssz"}]),
  b: try(() -> toDateTime("2003-10-01 23:57:59Z", [{format: "uuuu/MM/dd HH:mm:ssz"}])).error.message
}
```

#### Output

```DataWeave
{
  a: |2003-10-01T23:57:59Z| as DateTime {format: "uuuu-MM-dd HH:mm:ssz"},
  b: "Could not find a valid formatter for '2003-10-01 23:57:59Z'"
}
```

## toDateTime(number: Number, unit: MillisOrSecs | Null = null): DateTime

Transforms a `Number` value into a `DateTime` value using `milliseconds` or `seconds` as the unit.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The <code>Number</code> value to transform into a <code>DateTime</code> value.</p></td></tr><tr><td><p><code>unit</code></p></td><td><p>The unit to use for the conversion: <code>"milliseconds"</code> or <code>"seconds"</code>. A <code>null</code> value for the <code>unit</code> field defaults to <code>"seconds"</code>.</p></td></tr></tbody></table>

### Example

This example shows how `toDateTime` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
    fromEpoch: toDateTime(1443743879),
    fromMillis: toDateTime(1443743879000, "milliseconds")
}
```

#### Output

```DataWeave
{
  fromEpoch: |2015-10-01T23:57:59Z|,
  fromMillis: |2015-10-01T23:57:59Z| as DateTime {unit: "milliseconds"}
}
```

## toDateTime(str: String, format: String | Null = null, locale: String | Null = null): DateTime

Transforms a `String` value into a `DateTime` value and accepts a format and locale.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>DateTime</code> value.</p></td></tr><tr><td><p><code>format</code></p></td><td><p>The formatting to use on the <code>DateTime</code> value. A <code>null</code> value has no effect on the <code>DateTime</code> value. This parameter accepts Java character patterns based on ISO-8601. A <code>DateTime</code> value, such as <code>2011-12-03T10:15:30.000000+01:00</code>, has the format <code>uuuu-MM-dd HH:mm:ssz</code>.</p></td></tr><tr><td><p><code>locale</code></p></td><td><p>Optional ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default.</p></td></tr></tbody></table>

### Example

This example shows how `toDateTime` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
   a: toDateTime("2015-10-01T23:57:59Z"),
   b: toDateTime("2003-10-01 23:57:59Z","uuuu-MM-dd HH:mm:ssz")
}
```

#### Output

```DataWeave
{
  a: |2015-10-01T23:57:59Z|,
  b: |2003-10-01T23:57:59Z| as DateTime {format: "uuuu-MM-dd HH:mm:ssz"}
}
```

<!-- document id=8120de615ab99728db66b6a140b185439a2f6b8f3414b3a07a95c0619f854bbb url=/mulesoft/current/en-us/dataweave/2.11/dw-coercions-functions-todatetimeornull.md -->

---
product: DataWeave
version: 2.11
---

# toDateTimeOrNull

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toDateTimeOrNull(str: String, formatters: Array<Formatter>): DateTime | Null

Transforms a `String` value into a `DateTime` value using the first `Formatter` that matches with
the given value to transform.

If none of the `Formatter` matches with the given value, the function returns a `null` value.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>DateTime</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>DateTime</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toDateTimeOrNull` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  a: toDateTimeOrNull("2003-10-01 23:57:59Z", [{format: "uuuu/MM/dd HH:mm:ssz"}, {format: "uuuu-MM-dd HH:mm:ssz"}]),
  b: toDateTimeOrNull("2003-10-01 23:57:59Z", [{format: "uuuu/MM/dd HH:mm:ssz"}])
}
```

#### Output

```DataWeave
{
  a: |2003-10-01T23:57:59Z| as DateTime {format: "uuuu-MM-dd HH:mm:ssz"},
  b: null
}
```

<!-- document id=4a9da2cee782425b76f185152ef948131d6a91a115ff2887d4582f095d33c209 url=/mulesoft/current/en-us/dataweave/2.12/dw-coercions-functions-todatetimeornull.md -->

---
product: DataWeave
version: 2.12
---

# toDateTimeOrNull

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toDateTimeOrNull(str: String, formatters: Array<Formatter>): DateTime | Null

Transforms a `String` value into a `DateTime` value using the first `Formatter` that matches with
the given value to transform.

If none of the `Formatter` matches with the given value, the function returns a `null` value.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>DateTime</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>DateTime</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toDateTimeOrNull` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  a: toDateTimeOrNull("2003-10-01 23:57:59Z", [{format: "uuuu/MM/dd HH:mm:ssz"}, {format: "uuuu-MM-dd HH:mm:ssz"}]),
  b: toDateTimeOrNull("2003-10-01 23:57:59Z", [{format: "uuuu/MM/dd HH:mm:ssz"}])
}
```

#### Output

```DataWeave
{
  a: |2003-10-01T23:57:59Z| as DateTime {format: "uuuu-MM-dd HH:mm:ssz"},
  b: null
}
```

<!-- document id=c2662c1cf32ea1ee9a6e88c70a7aec8642ae7d8a7023d4c153f9d8680fd6d456 url=/mulesoft/current/en-us/dataweave/2.6/dw-coercions-functions-todatetimeornull.md -->

---
product: DataWeave
version: 2.6
---

# toDateTimeOrNull

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toDateTimeOrNull(str: String, formatters: Array<Formatter>): DateTime | Null

Transforms a `String` value into a `DateTime` value using the first `Formatter` that matches with
the given value to transform.

If none of the `Formatter` matches with the given value, the function returns a `null` value.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>DateTime</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>DateTime</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toDateTimeOrNull` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  a: toDateTimeOrNull("2003-10-01 23:57:59Z", [{format: "uuuu/MM/dd HH:mm:ssz"}, {format: "uuuu-MM-dd HH:mm:ssz"}]),
  b: toDateTimeOrNull("2003-10-01 23:57:59Z", [{format: "uuuu/MM/dd HH:mm:ssz"}])
}
```

#### Output

```DataWeave
{
  a: |2003-10-01T23:57:59Z| as DateTime {format: "uuuu-MM-dd HH:mm:ssz"},
  b: null
}
```

<!-- document id=19c564d89ece5947f96e1d3cbced3533fb6e290c2b923b75030a95e28eac3a46 url=/mulesoft/current/en-us/dataweave/2.9/dw-coercions-functions-todatetimeornull.md -->

---
product: DataWeave
version: 2.9
---

# toDateTimeOrNull

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toDateTimeOrNull(str: String, formatters: Array<Formatter>): DateTime | Null

Transforms a `String` value into a `DateTime` value using the first `Formatter` that matches with
the given value to transform.

If none of the `Formatter` matches with the given value, the function returns a `null` value.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>DateTime</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>DateTime</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toDateTimeOrNull` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  a: toDateTimeOrNull("2003-10-01 23:57:59Z", [{format: "uuuu/MM/dd HH:mm:ssz"}, {format: "uuuu-MM-dd HH:mm:ssz"}]),
  b: toDateTimeOrNull("2003-10-01 23:57:59Z", [{format: "uuuu/MM/dd HH:mm:ssz"}])
}
```

#### Output

```DataWeave
{
  a: |2003-10-01T23:57:59Z| as DateTime {format: "uuuu-MM-dd HH:mm:ssz"},
  b: null
}
```

<!-- document id=b66e1c65410985a7a22d359cec9e6176a4178309a69bf8712e0c54b57e4cabcb url=/mulesoft/current/en-us/dataweave/latest/dw-coercions-functions-todatetimeornull.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# toDateTimeOrNull

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toDateTimeOrNull(str: String, formatters: Array<Formatter>): DateTime | Null

Transforms a `String` value into a `DateTime` value using the first `Formatter` that matches with
the given value to transform.

If none of the `Formatter` matches with the given value, the function returns a `null` value.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>DateTime</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>DateTime</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toDateTimeOrNull` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  a: toDateTimeOrNull("2003-10-01 23:57:59Z", [{format: "uuuu/MM/dd HH:mm:ssz"}, {format: "uuuu-MM-dd HH:mm:ssz"}]),
  b: toDateTimeOrNull("2003-10-01 23:57:59Z", [{format: "uuuu/MM/dd HH:mm:ssz"}])
}
```

#### Output

```DataWeave
{
  a: |2003-10-01T23:57:59Z| as DateTime {format: "uuuu-MM-dd HH:mm:ssz"},
  b: null
}
```

<!-- document id=79247ee0df9f3cad963e189dc81a7eea7eeeed408581a05226abaced7fd6a0f6 url=/mulesoft/current/en-us/dataweave/2.11/dw-dates-functions-today.md -->

---
product: DataWeave
version: 2.11
---

# today

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## today(): Date

Returns the date for today as a `Date` type.

_Introduced in DataWeave version 2.4.0._

### Example

This example shows the output of `today` function.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
today()
```

#### Output

```Json
"2021-05-15"
```

<!-- document id=c8ba109b8885790a3cfd69a86d1d5c1c344c60f752e8dd3f7ee4d4dc949896b2 url=/mulesoft/current/en-us/dataweave/2.12/dw-dates-functions-today.md -->

---
product: DataWeave
version: 2.12
---

# today

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## today(): Date

Returns the date for today as a `Date` type.

_Introduced in DataWeave version 2.4.0._

### Example

This example shows the output of `today` function.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
today()
```

#### Output

```Json
"2021-05-15"
```

<!-- document id=94921334a30f5288dbae525fe34a0d2bdae34353ee6c5f1ae537fa401be8c7bb url=/mulesoft/current/en-us/dataweave/2.4/dw-dates-functions-today.md -->

---
product: DataWeave
version: 2.4
---

# today

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## today(): Date

Returns the date for today as a `Date` type.

_Introduced in DataWeave version 2.4.0._

### Example

This example shows the output of `today` function.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
today()
```

#### Output

```Json
"2021-05-15"
```

<!-- document id=f9af6c0cca79f513106dd9c7be8f2411874257ac5b0e1249994e12c8ed1761a1 url=/mulesoft/current/en-us/dataweave/2.6/dw-dates-functions-today.md -->

---
product: DataWeave
version: 2.6
---

# today

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## today(): Date

Returns the date for today as a `Date` type.

_Introduced in DataWeave version 2.4.0._

### Example

This example shows the output of `today` function.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
today()
```

#### Output

```Json
"2021-05-15"
```

<!-- document id=0ffc73cdd1881065f911f931d97010b8f28fe0e611f5cd6c0dce9bb2975e0859 url=/mulesoft/current/en-us/dataweave/2.9/dw-dates-functions-today.md -->

---
product: DataWeave
version: 2.9
---

# today

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## today(): Date

Returns the date for today as a `Date` type.

_Introduced in DataWeave version 2.4.0._

### Example

This example shows the output of `today` function.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
today()
```

#### Output

```Json
"2021-05-15"
```

<!-- document id=6dc450c47f9583a0d9fcad7202d834b881d97897428ab5c4e274f009bdb29527 url=/mulesoft/current/en-us/dataweave/latest/dw-dates-functions-today.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# today

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## today(): Date

Returns the date for today as a `Date` type.

_Introduced in DataWeave version 2.4.0._

### Example

This example shows the output of `today` function.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
today()
```

#### Output

```Json
"2021-05-15"
```

<!-- document id=e17781429d96dc6d3f38eef05e7311ff8f14b25e0b789a945ed37f0a2360be7e url=/mulesoft/current/en-us/dataweave/2.11/dw-math-functions-todegrees.md -->

---
product: DataWeave
version: 2.11
---

# toDegrees

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toDegrees(angrad: Number): Number

Converts an angle measured in radians to an approximately equivalent number of degrees.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>angrad</code></p></td><td><div><div><p>Number of radians to convert to degrees.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `toDegrees` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
  "toDegrees0.17":  toDegrees(0.174),
  "toDegrees0": toDegrees(0),
  "toDegrees-20": toDegrees(-0.20)
}
```

#### Output

```Json
{
   "toDegrees0.17": 9.969465635276323832571267395889251,
   "toDegrees0": 0E+19,
   "toDegrees-20": -11.45915590261646417536927286883822
 }
```

<!-- document id=38bb0a3cb762ea36386b4e71905c033af1f46199ba1ada1f0dc5224604f06845 url=/mulesoft/current/en-us/dataweave/2.12/dw-math-functions-todegrees.md -->

---
product: DataWeave
version: 2.12
---

# toDegrees

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toDegrees(angrad: Number): Number

Converts an angle measured in radians to an approximately equivalent number of degrees.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>angrad</code></p></td><td><div><div><p>Number of radians to convert to degrees.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `toDegrees` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
  "toDegrees0.17":  toDegrees(0.174),
  "toDegrees0": toDegrees(0),
  "toDegrees-20": toDegrees(-0.20)
}
```

#### Output

```Json
{
   "toDegrees0.17": 9.969465635276323832571267395889251,
   "toDegrees0": 0E+19,
   "toDegrees-20": -11.45915590261646417536927286883822
 }
```

<!-- document id=49e019e8d2f1223c66dbedbe8993ce2c56284dd89752c837bafb30d589610628 url=/mulesoft/current/en-us/dataweave/2.4/dw-math-functions-todegrees.md -->

---
product: DataWeave
version: 2.4
---

# toDegrees

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toDegrees(angrad: Number): Number

Converts an angle measured in radians to an approximately equivalent number of degrees.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>angrad</code></p></td><td><div><div><p>Number of radians to convert to degrees.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `toDegrees` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
  "toDegrees0.17":  toDegrees(0.174),
  "toDegrees0": toDegrees(0),
  "toDegrees-20": toDegrees(-0.20)
}
```

#### Output

```Json
{
   "toDegrees0.17": 9.969465635276323832571267395889251,
   "toDegrees0": 0E+19,
   "toDegrees-20": -11.45915590261646417536927286883822
 }
```

<!-- document id=ded1c1e33800aa15e3d251875a7513cbd49029d5808844425cdfaa92a80eee2e url=/mulesoft/current/en-us/dataweave/2.6/dw-math-functions-todegrees.md -->

---
product: DataWeave
version: 2.6
---

# toDegrees

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toDegrees(angrad: Number): Number

Converts an angle measured in radians to an approximately equivalent number of degrees.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>angrad</code></p></td><td><div><div><p>Number of radians to convert to degrees.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `toDegrees` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
  "toDegrees0.17":  toDegrees(0.174),
  "toDegrees0": toDegrees(0),
  "toDegrees-20": toDegrees(-0.20)
}
```

#### Output

```Json
{
   "toDegrees0.17": 9.969465635276323832571267395889251,
   "toDegrees0": 0E+19,
   "toDegrees-20": -11.45915590261646417536927286883822
 }
```

<!-- document id=b21326f4aec2c23e667c114d79e8d9923b0d55f7ca120cfe33d9c1562a3fcafe url=/mulesoft/current/en-us/dataweave/2.9/dw-math-functions-todegrees.md -->

---
product: DataWeave
version: 2.9
---

# toDegrees

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toDegrees(angrad: Number): Number

Converts an angle measured in radians to an approximately equivalent number of degrees.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>angrad</code></p></td><td><div><div><p>Number of radians to convert to degrees.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `toDegrees` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
  "toDegrees0.17":  toDegrees(0.174),
  "toDegrees0": toDegrees(0),
  "toDegrees-20": toDegrees(-0.20)
}
```

#### Output

```Json
{
   "toDegrees0.17": 9.969465635276323832571267395889251,
   "toDegrees0": 0E+19,
   "toDegrees-20": -11.45915590261646417536927286883822
 }
```

<!-- document id=9f4f64df9f17fc95f86992cdfc396b01e4c2f2624ddfcf376fc5c29ffed46d61 url=/mulesoft/current/en-us/dataweave/latest/dw-math-functions-todegrees.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# toDegrees

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toDegrees(angrad: Number): Number

Converts an angle measured in radians to an approximately equivalent number of degrees.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>angrad</code></p></td><td><div><div><p>Number of radians to convert to degrees.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `toDegrees` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
  "toDegrees0.17":  toDegrees(0.174),
  "toDegrees0": toDegrees(0),
  "toDegrees-20": toDegrees(-0.20)
}
```

#### Output

```Json
{
   "toDegrees0.17": 9.969465635276323832571267395889251,
   "toDegrees0": 0E+19,
   "toDegrees-20": -11.45915590261646417536927286883822
 }
```

<!-- document id=fc51ddcdcf40bd5d9e2d35ef3e26ab7e7af6544d4caf102a9c6e703216849ca2 url=/mulesoft/current/en-us/dataweave/2.11/dw-binaries-functions-tohex.md -->

---
product: DataWeave
version: 2.11
---

# toHex

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toHex(content: Binary): String

Transforms a binary value into a hexadecimal string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>The <code>Binary</code> value to transform.</p></td></tr></tbody></table>

### Example

This example transforms a binary version of "Mule" (defined in the variable, `myBinary`) to
hexadecimal.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Binaries
output application/json
var myBinary = "Mule" as Binary
var testType = typeOf(myBinary)
---
{
   "binaryToHex" : toHex(myBinary)
}
```

#### Output

```JSON
{ "binaryToHex": "4D756C65" }
```

<!-- document id=34e65b5763fc498f0aa7b49c877c30cc6df98963893128994400c01fe8bed115 url=/mulesoft/current/en-us/dataweave/2.11/dw-numbers-functions-tohex.md -->

---
product: DataWeave
version: 2.11
---

# toHex

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toHex(number: Number): String

Transforms a decimal number into a hexadecimal number.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The input number.</p></td></tr></tbody></table>

### Example

This example shows how `toHex` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import toHex from dw::core::Numbers
output application/json
---
{
    a: toHex(-1),
    b: toHex(100000000000000000000000000000000000000000000000000000000000000),
    c: toHex(0),
    d: toHex(null),
    e: toHex(15),
}
```

#### Output

```JSON
{
  "a": "-1",
  "b": "3e3aeb4ae1383562f4b82261d969f7ac94ca4000000000000000",
  "c": "0",
  "d": null,
  "e": "f"
}
```

## toHex(number: Null): Null

Helper function that enables `toHex` to work with null value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=f145f63a5adcea9637e075eea24c339d623a3d32b2296b395bc2286bcbb20450 url=/mulesoft/current/en-us/dataweave/2.12/dw-binaries-functions-tohex.md -->

---
product: DataWeave
version: 2.12
---

# toHex

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toHex(content: Binary): String

Transforms a binary value into a hexadecimal string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>The <code>Binary</code> value to transform.</p></td></tr></tbody></table>

### Example

This example transforms a binary version of "Mule" (defined in the variable, `myBinary`) to
hexadecimal.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Binaries
output application/json
var myBinary = "Mule" as Binary
var testType = typeOf(myBinary)
---
{
   "binaryToHex" : toHex(myBinary)
}
```

#### Output

```JSON
{ "binaryToHex": "4D756C65" }
```

<!-- document id=a510e23e67e5b5925ab2d6dab194457935f854d537a1a6abcdf5d7e612d2e5a2 url=/mulesoft/current/en-us/dataweave/2.12/dw-numbers-functions-tohex.md -->

---
product: DataWeave
version: 2.12
---

# toHex

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toHex(number: Number): String

Transforms a decimal number into a hexadecimal number.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The input number.</p></td></tr></tbody></table>

### Example

This example shows how `toHex` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import toHex from dw::core::Numbers
output application/json
---
{
    a: toHex(-1),
    b: toHex(100000000000000000000000000000000000000000000000000000000000000),
    c: toHex(0),
    d: toHex(null),
    e: toHex(15),
}
```

#### Output

```JSON
{
  "a": "-1",
  "b": "3e3aeb4ae1383562f4b82261d969f7ac94ca4000000000000000",
  "c": "0",
  "d": null,
  "e": "f"
}
```

## toHex(number: Null): Null

Helper function that enables `toHex` to work with null value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=4bdc58f590a0e08f2778db2eea267437b9c3df0e3acdf5dabe255555af6f8d1b url=/mulesoft/current/en-us/dataweave/2.3/dw-binaries-functions-tohex.md -->

---
product: DataWeave
version: 2.3
---

# toHex

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toHex(Binary): String

Transforms a binary value into a hexadecimal string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>The <code>Binary</code> value to transform.</p></td></tr></tbody></table>

### Example

This example transforms a binary version of "Mule" (defined in the variable, `myBinary`) to
hexadecimal.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Binaries
output application/json
var myBinary = "Mule" as Binary
var testType = typeOf(myBinary)
---
{
   "binaryToHex" : toHex(myBinary)
}
```

#### Output

```JSON
{ "binaryToHex": "4D756C65" }
```

<!-- document id=02c4aeec574019da14a238cb90f3de513fd3cf06b0e4209503f7ce2ac441bd26 url=/mulesoft/current/en-us/dataweave/2.3/dw-numbers-functions-tohex.md -->

---
product: DataWeave
version: 2.3
---

# toHex

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toHex(Number): String

Transforms a decimal number into a hexadecimal number.

_Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The input number.</p></td></tr></tbody></table>

### Example

This example shows how `toHex` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import toHex from dw::core::Numbers
output application/json
---
{
    a: toHex(-1),
    b: toHex(100000000000000000000000000000000000000000000000000000000000000),
    c: toHex(0),
    d: toHex(null),
    e: toHex(15),
}
```

#### Output

```JSON
{
  "a": "-1",
  "b": "3e3aeb4ae1383562f4b82261d969f7ac94ca4000000000000000",
  "c": "0",
  "d": null,
  "e": "f"
}
```

## toHex(Null): Null

Helper function that enables `toHex` to work with null value.

<!-- document id=2ea22baf1d050ba5445df9f33972d633e073eddcc61c2a3c25aa5535aaffda3e url=/mulesoft/current/en-us/dataweave/2.4/dw-binaries-functions-tohex.md -->

---
product: DataWeave
version: 2.4
---

# toHex

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toHex(content: Binary): String

Transforms a binary value into a hexadecimal string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>The <code>Binary</code> value to transform.</p></td></tr></tbody></table>

### Example

This example transforms a binary version of "Mule" (defined in the variable, `myBinary`) to
hexadecimal.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Binaries
output application/json
var myBinary = "Mule" as Binary
var testType = typeOf(myBinary)
---
{
   "binaryToHex" : toHex(myBinary)
}
```

#### Output

```JSON
{ "binaryToHex": "4D756C65" }
```

<!-- document id=22a9c0cfacea934c570af618f2b07be2c56989d5a8c96acc13fea6c1f3522dde url=/mulesoft/current/en-us/dataweave/2.4/dw-numbers-functions-tohex.md -->

---
product: DataWeave
version: 2.4
---

# toHex

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toHex(number: Number): String

Transforms a decimal number into a hexadecimal number.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The input number.</p></td></tr></tbody></table>

### Example

This example shows how `toHex` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import toHex from dw::core::Numbers
output application/json
---
{
    a: toHex(-1),
    b: toHex(100000000000000000000000000000000000000000000000000000000000000),
    c: toHex(0),
    d: toHex(null),
    e: toHex(15),
}
```

#### Output

```JSON
{
  "a": "-1",
  "b": "3e3aeb4ae1383562f4b82261d969f7ac94ca4000000000000000",
  "c": "0",
  "d": null,
  "e": "f"
}
```

## toHex(number: Null): Null

Helper function that enables `toHex` to work with null value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=82f83ea1eb18fdad95d0e80602c86412a1674ec152389e85628591acf19ca4b3 url=/mulesoft/current/en-us/dataweave/2.6/dw-binaries-functions-tohex.md -->

---
product: DataWeave
version: 2.6
---

# toHex

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toHex(content: Binary): String

Transforms a binary value into a hexadecimal string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>The <code>Binary</code> value to transform.</p></td></tr></tbody></table>

### Example

This example transforms a binary version of "Mule" (defined in the variable, `myBinary`) to
hexadecimal.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Binaries
output application/json
var myBinary = "Mule" as Binary
var testType = typeOf(myBinary)
---
{
   "binaryToHex" : toHex(myBinary)
}
```

#### Output

```JSON
{ "binaryToHex": "4D756C65" }
```

<!-- document id=b39e898d8784cac04f832eb7819a89bb1589b21269188373c8983464e0b26554 url=/mulesoft/current/en-us/dataweave/2.6/dw-numbers-functions-tohex.md -->

---
product: DataWeave
version: 2.6
---

# toHex

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toHex(number: Number): String

Transforms a decimal number into a hexadecimal number.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The input number.</p></td></tr></tbody></table>

### Example

This example shows how `toHex` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import toHex from dw::core::Numbers
output application/json
---
{
    a: toHex(-1),
    b: toHex(100000000000000000000000000000000000000000000000000000000000000),
    c: toHex(0),
    d: toHex(null),
    e: toHex(15),
}
```

#### Output

```JSON
{
  "a": "-1",
  "b": "3e3aeb4ae1383562f4b82261d969f7ac94ca4000000000000000",
  "c": "0",
  "d": null,
  "e": "f"
}
```

## toHex(number: Null): Null

Helper function that enables `toHex` to work with null value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=af05b4219585ad0160d11759ec2aff42effa526f659480e7c14aafaca94c2382 url=/mulesoft/current/en-us/dataweave/2.9/dw-binaries-functions-tohex.md -->

---
product: DataWeave
version: 2.9
---

# toHex

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toHex(content: Binary): String

Transforms a binary value into a hexadecimal string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>The <code>Binary</code> value to transform.</p></td></tr></tbody></table>

### Example

This example transforms a binary version of "Mule" (defined in the variable, `myBinary`) to
hexadecimal.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Binaries
output application/json
var myBinary = "Mule" as Binary
var testType = typeOf(myBinary)
---
{
   "binaryToHex" : toHex(myBinary)
}
```

#### Output

```JSON
{ "binaryToHex": "4D756C65" }
```

<!-- document id=981fe9e0246fadc76f10db451356f072fcc3742aafad783ba2e5f191f8201172 url=/mulesoft/current/en-us/dataweave/2.9/dw-numbers-functions-tohex.md -->

---
product: DataWeave
version: 2.9
---

# toHex

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toHex(number: Number): String

Transforms a decimal number into a hexadecimal number.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The input number.</p></td></tr></tbody></table>

### Example

This example shows how `toHex` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import toHex from dw::core::Numbers
output application/json
---
{
    a: toHex(-1),
    b: toHex(100000000000000000000000000000000000000000000000000000000000000),
    c: toHex(0),
    d: toHex(null),
    e: toHex(15),
}
```

#### Output

```JSON
{
  "a": "-1",
  "b": "3e3aeb4ae1383562f4b82261d969f7ac94ca4000000000000000",
  "c": "0",
  "d": null,
  "e": "f"
}
```

## toHex(number: Null): Null

Helper function that enables `toHex` to work with null value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=c307a17556c1b83ca53f61fa110fb2bdeb3a3dde44349961a6dc275d772a8689 url=/mulesoft/current/en-us/dataweave/latest/dw-binaries-functions-tohex.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# toHex

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toHex(content: Binary): String

Transforms a binary value into a hexadecimal string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>The <code>Binary</code> value to transform.</p></td></tr></tbody></table>

### Example

This example transforms a binary version of "Mule" (defined in the variable, `myBinary`) to
hexadecimal.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Binaries
output application/json
var myBinary = "Mule" as Binary
var testType = typeOf(myBinary)
---
{
   "binaryToHex" : toHex(myBinary)
}
```

#### Output

```JSON
{ "binaryToHex": "4D756C65" }
```

<!-- document id=29c47c6839d6253fdb12ab9dcff48423d750cb833348dac486a34c544514391b url=/mulesoft/current/en-us/dataweave/latest/dw-numbers-functions-tohex.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# toHex

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toHex(number: Number): String

Transforms a decimal number into a hexadecimal number.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The input number.</p></td></tr></tbody></table>

### Example

This example shows how `toHex` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import toHex from dw::core::Numbers
output application/json
---
{
    a: toHex(-1),
    b: toHex(100000000000000000000000000000000000000000000000000000000000000),
    c: toHex(0),
    d: toHex(null),
    e: toHex(15),
}
```

#### Output

```JSON
{
  "a": "-1",
  "b": "3e3aeb4ae1383562f4b82261d969f7ac94ca4000000000000000",
  "c": "0",
  "d": null,
  "e": "f"
}
```

## toHex(number: Null): Null

Helper function that enables `toHex` to work with null value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=eeea1a897a13135263355555669409843e6960935658f3a7f61c89f296a9f0ba url=/mulesoft/current/en-us/dataweave/2.11/dw-coercions-functions-tolocaldatetime.md -->

---
product: DataWeave
version: 2.11
---

# toLocalDateTime

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toLocalDateTime(str: String, formatters: Array<Formatter>): LocalDateTime

Transforms a `String` value into a `LocalDateTime` value using the first `Formatter` that matches
with the given value to transform.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>LocalDateTime</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>LocalDateTime</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toLocalDateTime` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
import * from dw::Runtime
output application/dw
---
{
  a: toLocalDateTime("2003-10-01 23:57:59", [{format: "uuuu/MM/dd HH:mm:ss"}, {format: "uuuu-MM-dd HH:mm:ss"}]),
  b: try(() -> toLocalDateTime("2003-10-01 23:57:59", [{format: "uuuu/MM/dd HH:mm:ss"}])).error.message
}
```

#### Output

```DataWeave
{
  a: |2003-10-01T23:57:59| as LocalDateTime {format: "uuuu-MM-dd HH:mm:ss"},
  b: "Could not find a valid formatter for '2003-10-01 23:57:59'"
}
```

## toLocalDateTime(str: String, format: String | Null = null, locale: String | Null = null): LocalDateTime

Transforms a `String` value into a `LocalDateTime` value and accepts a format and locale.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>LocalDateTime</code> value.</p></td></tr><tr><td><p><code>format</code></p></td><td><p>The formatting to use on the <code>LocalDateTime</code> value. A <code>null</code> value has no effect on the <code>LocalDateTime</code> value. This parameter accepts Java character patterns based on ISO-8601. A <code>LocalDateTime</code> value, such as <code>2011-12-03T10:15:30.000000</code> has the format <code>uuuu-MM-dd HH:mm:ss</code>.</p></td></tr><tr><td><p><code>locale</code></p></td><td><p>Optional ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default.</p></td></tr></tbody></table>

### Example

This example shows how `toLocalDateTime` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  a: toLocalDateTime("2015-10-01T23:57:59"),
  b: toLocalDateTime("2003-10-01 23:57:59","uuuu-MM-dd HH:mm:ss")
}
```

#### Output

```DataWeave
{
  a: |2015-10-01T23:57:59|,
  b: |2003-10-01T23:57:59| as LocalDateTime {format: "uuuu-MM-dd HH:mm:ss"}
}
```

<!-- document id=7c9258e918eb2b41eb3f8ae4e38d0cecbbf0fb8ef1455123381cf619f9a74e76 url=/mulesoft/current/en-us/dataweave/2.12/dw-coercions-functions-tolocaldatetime.md -->

---
product: DataWeave
version: 2.12
---

# toLocalDateTime

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toLocalDateTime(str: String, formatters: Array<Formatter>): LocalDateTime

Transforms a `String` value into a `LocalDateTime` value using the first `Formatter` that matches
with the given value to transform.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>LocalDateTime</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>LocalDateTime</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toLocalDateTime` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
import * from dw::Runtime
output application/dw
---
{
  a: toLocalDateTime("2003-10-01 23:57:59", [{format: "uuuu/MM/dd HH:mm:ss"}, {format: "uuuu-MM-dd HH:mm:ss"}]),
  b: try(() -> toLocalDateTime("2003-10-01 23:57:59", [{format: "uuuu/MM/dd HH:mm:ss"}])).error.message
}
```

#### Output

```DataWeave
{
  a: |2003-10-01T23:57:59| as LocalDateTime {format: "uuuu-MM-dd HH:mm:ss"},
  b: "Could not find a valid formatter for '2003-10-01 23:57:59'"
}
```

## toLocalDateTime(str: String, format: String | Null = null, locale: String | Null = null): LocalDateTime

Transforms a `String` value into a `LocalDateTime` value and accepts a format and locale.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>LocalDateTime</code> value.</p></td></tr><tr><td><p><code>format</code></p></td><td><p>The formatting to use on the <code>LocalDateTime</code> value. A <code>null</code> value has no effect on the <code>LocalDateTime</code> value. This parameter accepts Java character patterns based on ISO-8601. A <code>LocalDateTime</code> value, such as <code>2011-12-03T10:15:30.000000</code> has the format <code>uuuu-MM-dd HH:mm:ss</code>.</p></td></tr><tr><td><p><code>locale</code></p></td><td><p>Optional ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default.</p></td></tr></tbody></table>

### Example

This example shows how `toLocalDateTime` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  a: toLocalDateTime("2015-10-01T23:57:59"),
  b: toLocalDateTime("2003-10-01 23:57:59","uuuu-MM-dd HH:mm:ss")
}
```

#### Output

```DataWeave
{
  a: |2015-10-01T23:57:59|,
  b: |2003-10-01T23:57:59| as LocalDateTime {format: "uuuu-MM-dd HH:mm:ss"}
}
```

<!-- document id=d7be8a200d4fedf6cbb485f6284390a264f04921bced2283e6bebb7512c1897e url=/mulesoft/current/en-us/dataweave/2.4/dw-coercions-functions-tolocaldatetime.md -->

---
product: DataWeave
version: 2.4
---

# toLocalDateTime

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toLocalDateTime(str: String, format: String | Null = null, locale: String | Null = null): LocalDateTime

Transforms a `String` value into a `LocalDateTime` value and accepts a format and locale.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>LocalDateTime</code> value.</p></td></tr><tr><td><p><code>format</code></p></td><td><p>The formatting to use on the <code>LocalDateTime</code> value. A <code>null</code> value has no effect on the <code>LocalDateTime</code> value. This parameter accepts Java character patterns based on ISO-8601. A <code>LocalDateTime</code> value, such as <code>2011-12-03T10:15:30.000000</code> has the format <code>uuuu-MM-dd HH:mm:ss</code>.</p></td></tr><tr><td><p><code>locale</code></p></td><td><p>Optional ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default.</p></td></tr></tbody></table>

### Example

This example shows how `toLocalDateTime` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  a: toLocalDateTime("2015-10-01T23:57:59"),
  b: toLocalDateTime("2003-10-01 23:57:59","uuuu-MM-dd HH:mm:ss")
}
```

#### Output

```DataWeave
{
  a: |2015-10-01T23:57:59|,
  b: |2003-10-01T23:57:59| as LocalDateTime {format: "uuuu-MM-dd HH:mm:ss"}
}
```

<!-- document id=6829193943d14ded3f29811bfdc5a3de6526bf87ff1b37d8cfd63f4b1e3d48f3 url=/mulesoft/current/en-us/dataweave/2.6/dw-coercions-functions-tolocaldatetime.md -->

---
product: DataWeave
version: 2.6
---

# toLocalDateTime

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toLocalDateTime(str: String, formatters: Array<Formatter>): LocalDateTime

Transforms a `String` value into a `LocalDateTime` value using the first `Formatter` that matches
with the given value to transform.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>LocalDateTime</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>LocalDateTime</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toLocalDateTime` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
import * from dw::Runtime
output application/dw
---
{
  a: toLocalDateTime("2003-10-01 23:57:59", [{format: "uuuu/MM/dd HH:mm:ss"}, {format: "uuuu-MM-dd HH:mm:ss"}]),
  b: try(() -> toLocalDateTime("2003-10-01 23:57:59", [{format: "uuuu/MM/dd HH:mm:ss"}])).error.message
}
```

#### Output

```DataWeave
{
  a: |2003-10-01T23:57:59| as LocalDateTime {format: "uuuu-MM-dd HH:mm:ss"},
  b: "Could not find a valid formatter for '2003-10-01 23:57:59'"
}
```

## toLocalDateTime(str: String, format: String | Null = null, locale: String | Null = null): LocalDateTime

Transforms a `String` value into a `LocalDateTime` value and accepts a format and locale.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>LocalDateTime</code> value.</p></td></tr><tr><td><p><code>format</code></p></td><td><p>The formatting to use on the <code>LocalDateTime</code> value. A <code>null</code> value has no effect on the <code>LocalDateTime</code> value. This parameter accepts Java character patterns based on ISO-8601. A <code>LocalDateTime</code> value, such as <code>2011-12-03T10:15:30.000000</code> has the format <code>uuuu-MM-dd HH:mm:ss</code>.</p></td></tr><tr><td><p><code>locale</code></p></td><td><p>Optional ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default.</p></td></tr></tbody></table>

### Example

This example shows how `toLocalDateTime` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  a: toLocalDateTime("2015-10-01T23:57:59"),
  b: toLocalDateTime("2003-10-01 23:57:59","uuuu-MM-dd HH:mm:ss")
}
```

#### Output

```DataWeave
{
  a: |2015-10-01T23:57:59|,
  b: |2003-10-01T23:57:59| as LocalDateTime {format: "uuuu-MM-dd HH:mm:ss"}
}
```

<!-- document id=691074cd671f5c788720d99fe013cdf83cebdd4f1c435022fa002c491140e9ca url=/mulesoft/current/en-us/dataweave/2.9/dw-coercions-functions-tolocaldatetime.md -->

---
product: DataWeave
version: 2.9
---

# toLocalDateTime

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toLocalDateTime(str: String, formatters: Array<Formatter>): LocalDateTime

Transforms a `String` value into a `LocalDateTime` value using the first `Formatter` that matches
with the given value to transform.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>LocalDateTime</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>LocalDateTime</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toLocalDateTime` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
import * from dw::Runtime
output application/dw
---
{
  a: toLocalDateTime("2003-10-01 23:57:59", [{format: "uuuu/MM/dd HH:mm:ss"}, {format: "uuuu-MM-dd HH:mm:ss"}]),
  b: try(() -> toLocalDateTime("2003-10-01 23:57:59", [{format: "uuuu/MM/dd HH:mm:ss"}])).error.message
}
```

#### Output

```DataWeave
{
  a: |2003-10-01T23:57:59| as LocalDateTime {format: "uuuu-MM-dd HH:mm:ss"},
  b: "Could not find a valid formatter for '2003-10-01 23:57:59'"
}
```

## toLocalDateTime(str: String, format: String | Null = null, locale: String | Null = null): LocalDateTime

Transforms a `String` value into a `LocalDateTime` value and accepts a format and locale.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>LocalDateTime</code> value.</p></td></tr><tr><td><p><code>format</code></p></td><td><p>The formatting to use on the <code>LocalDateTime</code> value. A <code>null</code> value has no effect on the <code>LocalDateTime</code> value. This parameter accepts Java character patterns based on ISO-8601. A <code>LocalDateTime</code> value, such as <code>2011-12-03T10:15:30.000000</code> has the format <code>uuuu-MM-dd HH:mm:ss</code>.</p></td></tr><tr><td><p><code>locale</code></p></td><td><p>Optional ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default.</p></td></tr></tbody></table>

### Example

This example shows how `toLocalDateTime` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  a: toLocalDateTime("2015-10-01T23:57:59"),
  b: toLocalDateTime("2003-10-01 23:57:59","uuuu-MM-dd HH:mm:ss")
}
```

#### Output

```DataWeave
{
  a: |2015-10-01T23:57:59|,
  b: |2003-10-01T23:57:59| as LocalDateTime {format: "uuuu-MM-dd HH:mm:ss"}
}
```

<!-- document id=ebd2f954b78cbfaae77f667e78078463e32d6c8a0f7d854f7cda64265acc984e url=/mulesoft/current/en-us/dataweave/latest/dw-coercions-functions-tolocaldatetime.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# toLocalDateTime

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toLocalDateTime(str: String, formatters: Array<Formatter>): LocalDateTime

Transforms a `String` value into a `LocalDateTime` value using the first `Formatter` that matches
with the given value to transform.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>LocalDateTime</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>LocalDateTime</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toLocalDateTime` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
import * from dw::Runtime
output application/dw
---
{
  a: toLocalDateTime("2003-10-01 23:57:59", [{format: "uuuu/MM/dd HH:mm:ss"}, {format: "uuuu-MM-dd HH:mm:ss"}]),
  b: try(() -> toLocalDateTime("2003-10-01 23:57:59", [{format: "uuuu/MM/dd HH:mm:ss"}])).error.message
}
```

#### Output

```DataWeave
{
  a: |2003-10-01T23:57:59| as LocalDateTime {format: "uuuu-MM-dd HH:mm:ss"},
  b: "Could not find a valid formatter for '2003-10-01 23:57:59'"
}
```

## toLocalDateTime(str: String, format: String | Null = null, locale: String | Null = null): LocalDateTime

Transforms a `String` value into a `LocalDateTime` value and accepts a format and locale.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>LocalDateTime</code> value.</p></td></tr><tr><td><p><code>format</code></p></td><td><p>The formatting to use on the <code>LocalDateTime</code> value. A <code>null</code> value has no effect on the <code>LocalDateTime</code> value. This parameter accepts Java character patterns based on ISO-8601. A <code>LocalDateTime</code> value, such as <code>2011-12-03T10:15:30.000000</code> has the format <code>uuuu-MM-dd HH:mm:ss</code>.</p></td></tr><tr><td><p><code>locale</code></p></td><td><p>Optional ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default.</p></td></tr></tbody></table>

### Example

This example shows how `toLocalDateTime` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  a: toLocalDateTime("2015-10-01T23:57:59"),
  b: toLocalDateTime("2003-10-01 23:57:59","uuuu-MM-dd HH:mm:ss")
}
```

#### Output

```DataWeave
{
  a: |2015-10-01T23:57:59|,
  b: |2003-10-01T23:57:59| as LocalDateTime {format: "uuuu-MM-dd HH:mm:ss"}
}
```

<!-- document id=447a073e7286ac62928214730196a36f8fa3304bd40e056f1218cb19a4317677 url=/mulesoft/current/en-us/dataweave/2.11/dw-coercions-functions-tolocaldatetimeornull.md -->

---
product: DataWeave
version: 2.11
---

# toLocalDateTimeOrNull

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toLocalDateTimeOrNull(str: String, formatters: Array<Formatter>): LocalDateTime | Null

Transforms a `String` value into a `LocalDateTime` value using the first `Formatter` that matches
with the given value to transform.

If none of the `Formatter` matches with the given value, the function returns a `null` value.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>LocalDateTime</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>LocalDateTime</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toLocalDateTimeOrNull` behaves with different inputs. It produces output in
the `application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  a: toLocalDateTimeOrNull("2003-10-01 23:57:59", [{format: "uuuu/MM/dd HH:mm:ss"}, {format: "uuuu-MM-dd HH:mm:ss"}]),
  b: toLocalDateTimeOrNull("2003-10-01 23:57:59", [{format: "uuuu/MM/dd HH:mm:ss"}])
}
```

#### Output

```DataWeave
{
  a: |2003-10-01T23:57:59| as LocalDateTime {format: "uuuu-MM-dd HH:mm:ss"},
  b: null
}
```

<!-- document id=cc8d94e16caad51ed0793bf49bb94134cfe4410acf9d7e764c4329a8d35f4884 url=/mulesoft/current/en-us/dataweave/2.12/dw-coercions-functions-tolocaldatetimeornull.md -->

---
product: DataWeave
version: 2.12
---

# toLocalDateTimeOrNull

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toLocalDateTimeOrNull(str: String, formatters: Array<Formatter>): LocalDateTime | Null

Transforms a `String` value into a `LocalDateTime` value using the first `Formatter` that matches
with the given value to transform.

If none of the `Formatter` matches with the given value, the function returns a `null` value.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>LocalDateTime</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>LocalDateTime</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toLocalDateTimeOrNull` behaves with different inputs. It produces output in
the `application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  a: toLocalDateTimeOrNull("2003-10-01 23:57:59", [{format: "uuuu/MM/dd HH:mm:ss"}, {format: "uuuu-MM-dd HH:mm:ss"}]),
  b: toLocalDateTimeOrNull("2003-10-01 23:57:59", [{format: "uuuu/MM/dd HH:mm:ss"}])
}
```

#### Output

```DataWeave
{
  a: |2003-10-01T23:57:59| as LocalDateTime {format: "uuuu-MM-dd HH:mm:ss"},
  b: null
}
```

<!-- document id=56ddc111353248ffd98136edbc18ffae4605f3093d97633967aa57e680238920 url=/mulesoft/current/en-us/dataweave/2.6/dw-coercions-functions-tolocaldatetimeornull.md -->

---
product: DataWeave
version: 2.6
---

# toLocalDateTimeOrNull

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toLocalDateTimeOrNull(str: String, formatters: Array<Formatter>): LocalDateTime | Null

Transforms a `String` value into a `LocalDateTime` value using the first `Formatter` that matches
with the given value to transform.

If none of the `Formatter` matches with the given value, the function returns a `null` value.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>LocalDateTime</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>LocalDateTime</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toLocalDateTimeOrNull` behaves with different inputs. It produces output in
the `application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  a: toLocalDateTimeOrNull("2003-10-01 23:57:59", [{format: "uuuu/MM/dd HH:mm:ss"}, {format: "uuuu-MM-dd HH:mm:ss"}]),
  b: toLocalDateTimeOrNull("2003-10-01 23:57:59", [{format: "uuuu/MM/dd HH:mm:ss"}])
}
```

#### Output

```DataWeave
{
  a: |2003-10-01T23:57:59| as LocalDateTime {format: "uuuu-MM-dd HH:mm:ss"},
  b: null
}
```

<!-- document id=5fcf80ff3d8a54c86d74fac6bb0a4ee9d8b1bb720e0d49caaf71c4d885fab1a7 url=/mulesoft/current/en-us/dataweave/2.9/dw-coercions-functions-tolocaldatetimeornull.md -->

---
product: DataWeave
version: 2.9
---

# toLocalDateTimeOrNull

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toLocalDateTimeOrNull(str: String, formatters: Array<Formatter>): LocalDateTime | Null

Transforms a `String` value into a `LocalDateTime` value using the first `Formatter` that matches
with the given value to transform.

If none of the `Formatter` matches with the given value, the function returns a `null` value.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>LocalDateTime</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>LocalDateTime</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toLocalDateTimeOrNull` behaves with different inputs. It produces output in
the `application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  a: toLocalDateTimeOrNull("2003-10-01 23:57:59", [{format: "uuuu/MM/dd HH:mm:ss"}, {format: "uuuu-MM-dd HH:mm:ss"}]),
  b: toLocalDateTimeOrNull("2003-10-01 23:57:59", [{format: "uuuu/MM/dd HH:mm:ss"}])
}
```

#### Output

```DataWeave
{
  a: |2003-10-01T23:57:59| as LocalDateTime {format: "uuuu-MM-dd HH:mm:ss"},
  b: null
}
```

<!-- document id=df0eac903aac6c3435e4720f08b932fae122b6101e60a9a96651b05357075f4a url=/mulesoft/current/en-us/dataweave/latest/dw-coercions-functions-tolocaldatetimeornull.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# toLocalDateTimeOrNull

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toLocalDateTimeOrNull(str: String, formatters: Array<Formatter>): LocalDateTime | Null

Transforms a `String` value into a `LocalDateTime` value using the first `Formatter` that matches
with the given value to transform.

If none of the `Formatter` matches with the given value, the function returns a `null` value.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>LocalDateTime</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>LocalDateTime</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toLocalDateTimeOrNull` behaves with different inputs. It produces output in
the `application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  a: toLocalDateTimeOrNull("2003-10-01 23:57:59", [{format: "uuuu/MM/dd HH:mm:ss"}, {format: "uuuu-MM-dd HH:mm:ss"}]),
  b: toLocalDateTimeOrNull("2003-10-01 23:57:59", [{format: "uuuu/MM/dd HH:mm:ss"}])
}
```

#### Output

```DataWeave
{
  a: |2003-10-01T23:57:59| as LocalDateTime {format: "uuuu-MM-dd HH:mm:ss"},
  b: null
}
```

<!-- document id=c51277a43be30af370aa00bd2b91ba2ee44eada54a95428d79a61571960c4ea8 url=/mulesoft/current/en-us/dataweave/2.11/dw-coercions-functions-tolocaltime.md -->

---
product: DataWeave
version: 2.11
---

# toLocalTime

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toLocalTime(str: String, formatters: Array<Formatter>): LocalTime

Transforms a `String` value into a `LocalTime` value using the first `Formatter` that matches with
the given value to transform.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>LocalTime</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>LocalTime</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toLocalTime` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
import * from dw::Runtime
output application/dw
---
{
  a: toLocalTime("23:57:59", [{format: "HH:mm:ss.n"}, {format: "HH:mm:ss"}]),
  b: try(() -> toLocalTime("23:57:59", [{format: "HH:mm:ss.n"}])).error.message
}
```

#### Output

```DataWeave
{
  a: |23:57:59| as LocalTime {format: "HH:mm:ss"},
  b: "Could not find a valid formatter for '23:57:59'"
}
```

## toLocalTime(str: String, format: String | Null = null, locale: String | Null = null): LocalTime

Transforms a `String` value into a `LocalTime` value and accepts a format and locale.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>LocalTime</code> value.</p></td></tr><tr><td><p><code>format</code></p></td><td><p>The formatting to use on the <code>LocalTime</code> value. A <code>null</code> value has no effect on the <code>LocalTime</code> value. This parameter accepts Java character patterns based on ISO-8601. A <code>LocalTime</code> value, such as <code>22:15:30.000000</code>, has the format <code>HH:mm:ss.n</code>.</p></td></tr><tr><td><p><code>locale</code></p></td><td><p>Optional ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default.</p></td></tr></tbody></table>

### Example

This example shows how `toLocalTime` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
   toLocalTimeEx: toLocalTime("23:57:59"),
   toLocalTimeEx2: toLocalTime("13:44:12.283","HH:mm:ss.n")
}
```

#### Output

```DataWeave
{
  "toLocalTimeEx": "23:57:59",
  "toLocalTimeEx2": "13:44:12.283"
}
```

<!-- document id=22b455eee709bc865a88ea4feb66ec345a9b33c363811f323f4df82ffc4b6f08 url=/mulesoft/current/en-us/dataweave/2.12/dw-coercions-functions-tolocaltime.md -->

---
product: DataWeave
version: 2.12
---

# toLocalTime

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toLocalTime(str: String, formatters: Array<Formatter>): LocalTime

Transforms a `String` value into a `LocalTime` value using the first `Formatter` that matches with
the given value to transform.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>LocalTime</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>LocalTime</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toLocalTime` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
import * from dw::Runtime
output application/dw
---
{
  a: toLocalTime("23:57:59", [{format: "HH:mm:ss.n"}, {format: "HH:mm:ss"}]),
  b: try(() -> toLocalTime("23:57:59", [{format: "HH:mm:ss.n"}])).error.message
}
```

#### Output

```DataWeave
{
  a: |23:57:59| as LocalTime {format: "HH:mm:ss"},
  b: "Could not find a valid formatter for '23:57:59'"
}
```

## toLocalTime(str: String, format: String | Null = null, locale: String | Null = null): LocalTime

Transforms a `String` value into a `LocalTime` value and accepts a format and locale.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>LocalTime</code> value.</p></td></tr><tr><td><p><code>format</code></p></td><td><p>The formatting to use on the <code>LocalTime</code> value. A <code>null</code> value has no effect on the <code>LocalTime</code> value. This parameter accepts Java character patterns based on ISO-8601. A <code>LocalTime</code> value, such as <code>22:15:30.000000</code>, has the format <code>HH:mm:ss.n</code>.</p></td></tr><tr><td><p><code>locale</code></p></td><td><p>Optional ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default.</p></td></tr></tbody></table>

### Example

This example shows how `toLocalTime` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
   toLocalTimeEx: toLocalTime("23:57:59"),
   toLocalTimeEx2: toLocalTime("13:44:12.283","HH:mm:ss.n")
}
```

#### Output

```DataWeave
{
  "toLocalTimeEx": "23:57:59",
  "toLocalTimeEx2": "13:44:12.283"
}
```

<!-- document id=99256e4a7862c3cad57e6a555e2fcc96bf58f40655e3303e8135f363fa4ebae7 url=/mulesoft/current/en-us/dataweave/2.4/dw-coercions-functions-tolocaltime.md -->

---
product: DataWeave
version: 2.4
---

# toLocalTime

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toLocalTime(str: String, format: String | Null = null, locale: String | Null = null): LocalTime

Transforms a `String` value into a `LocalTime` value and accepts a format and locale.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>LocalTime</code> value.</p></td></tr><tr><td><p><code>format</code></p></td><td><p>The formatting to use on the <code>LocalTime</code> value. A <code>null</code> value has no effect on the <code>LocalTime</code> value. This parameter accepts Java character patterns based on ISO-8601. A <code>LocalTime</code> value, such as <code>22:15:30.000000</code>, has the format <code>HH:mm:ss.n</code>.</p></td></tr><tr><td><p><code>locale</code></p></td><td><p>Optional ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default.</p></td></tr></tbody></table>

### Example

This example shows how `toLocalTime` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
   toLocalTimeEx: toLocalTime("23:57:59"),
   toLocalTimeEx2: toLocalTime("13:44:12.283","HH:mm:ss.n")
}
```

#### Output

```DataWeave
{
  "toLocalTimeEx": "23:57:59",
  "toLocalTimeEx2": "13:44:12.283"
}
```

<!-- document id=5c54410fafa89dc6b388b08f9b351251fa8db3b6182d5cd366d800df1090b1fa url=/mulesoft/current/en-us/dataweave/2.6/dw-coercions-functions-tolocaltime.md -->

---
product: DataWeave
version: 2.6
---

# toLocalTime

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toLocalTime(str: String, formatters: Array<Formatter>): LocalTime

Transforms a `String` value into a `LocalTime` value using the first `Formatter` that matches with
the given value to transform.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>LocalTime</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>LocalTime</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toLocalTime` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
import * from dw::Runtime
output application/dw
---
{
  a: toLocalTime("23:57:59", [{format: "HH:mm:ss.n"}, {format: "HH:mm:ss"}]),
  b: try(() -> toLocalTime("23:57:59", [{format: "HH:mm:ss.n"}])).error.message
}
```

#### Output

```DataWeave
{
  a: |23:57:59| as LocalTime {format: "HH:mm:ss"},
  b: "Could not find a valid formatter for '23:57:59'"
}
```

## toLocalTime(str: String, format: String | Null = null, locale: String | Null = null): LocalTime

Transforms a `String` value into a `LocalTime` value and accepts a format and locale.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>LocalTime</code> value.</p></td></tr><tr><td><p><code>format</code></p></td><td><p>The formatting to use on the <code>LocalTime</code> value. A <code>null</code> value has no effect on the <code>LocalTime</code> value. This parameter accepts Java character patterns based on ISO-8601. A <code>LocalTime</code> value, such as <code>22:15:30.000000</code>, has the format <code>HH:mm:ss.n</code>.</p></td></tr><tr><td><p><code>locale</code></p></td><td><p>Optional ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default.</p></td></tr></tbody></table>

### Example

This example shows how `toLocalTime` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
   toLocalTimeEx: toLocalTime("23:57:59"),
   toLocalTimeEx2: toLocalTime("13:44:12.283","HH:mm:ss.n")
}
```

#### Output

```DataWeave
{
  "toLocalTimeEx": "23:57:59",
  "toLocalTimeEx2": "13:44:12.283"
}
```

<!-- document id=36b078bcc01bfb3281de5d05485fb07728613943d86c21f712a4f040d955e058 url=/mulesoft/current/en-us/dataweave/2.9/dw-coercions-functions-tolocaltime.md -->

---
product: DataWeave
version: 2.9
---

# toLocalTime

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toLocalTime(str: String, formatters: Array<Formatter>): LocalTime

Transforms a `String` value into a `LocalTime` value using the first `Formatter` that matches with
the given value to transform.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>LocalTime</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>LocalTime</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toLocalTime` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
import * from dw::Runtime
output application/dw
---
{
  a: toLocalTime("23:57:59", [{format: "HH:mm:ss.n"}, {format: "HH:mm:ss"}]),
  b: try(() -> toLocalTime("23:57:59", [{format: "HH:mm:ss.n"}])).error.message
}
```

#### Output

```DataWeave
{
  a: |23:57:59| as LocalTime {format: "HH:mm:ss"},
  b: "Could not find a valid formatter for '23:57:59'"
}
```

## toLocalTime(str: String, format: String | Null = null, locale: String | Null = null): LocalTime

Transforms a `String` value into a `LocalTime` value and accepts a format and locale.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>LocalTime</code> value.</p></td></tr><tr><td><p><code>format</code></p></td><td><p>The formatting to use on the <code>LocalTime</code> value. A <code>null</code> value has no effect on the <code>LocalTime</code> value. This parameter accepts Java character patterns based on ISO-8601. A <code>LocalTime</code> value, such as <code>22:15:30.000000</code>, has the format <code>HH:mm:ss.n</code>.</p></td></tr><tr><td><p><code>locale</code></p></td><td><p>Optional ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default.</p></td></tr></tbody></table>

### Example

This example shows how `toLocalTime` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
   toLocalTimeEx: toLocalTime("23:57:59"),
   toLocalTimeEx2: toLocalTime("13:44:12.283","HH:mm:ss.n")
}
```

#### Output

```DataWeave
{
  "toLocalTimeEx": "23:57:59",
  "toLocalTimeEx2": "13:44:12.283"
}
```

<!-- document id=98d008c5d380b940e5d095bacc6f1e6fd043213e542894edcfd83b4c271efe15 url=/mulesoft/current/en-us/dataweave/latest/dw-coercions-functions-tolocaltime.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# toLocalTime

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toLocalTime(str: String, formatters: Array<Formatter>): LocalTime

Transforms a `String` value into a `LocalTime` value using the first `Formatter` that matches with
the given value to transform.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>LocalTime</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>LocalTime</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toLocalTime` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
import * from dw::Runtime
output application/dw
---
{
  a: toLocalTime("23:57:59", [{format: "HH:mm:ss.n"}, {format: "HH:mm:ss"}]),
  b: try(() -> toLocalTime("23:57:59", [{format: "HH:mm:ss.n"}])).error.message
}
```

#### Output

```DataWeave
{
  a: |23:57:59| as LocalTime {format: "HH:mm:ss"},
  b: "Could not find a valid formatter for '23:57:59'"
}
```

## toLocalTime(str: String, format: String | Null = null, locale: String | Null = null): LocalTime

Transforms a `String` value into a `LocalTime` value and accepts a format and locale.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>LocalTime</code> value.</p></td></tr><tr><td><p><code>format</code></p></td><td><p>The formatting to use on the <code>LocalTime</code> value. A <code>null</code> value has no effect on the <code>LocalTime</code> value. This parameter accepts Java character patterns based on ISO-8601. A <code>LocalTime</code> value, such as <code>22:15:30.000000</code>, has the format <code>HH:mm:ss.n</code>.</p></td></tr><tr><td><p><code>locale</code></p></td><td><p>Optional ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default.</p></td></tr></tbody></table>

### Example

This example shows how `toLocalTime` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
   toLocalTimeEx: toLocalTime("23:57:59"),
   toLocalTimeEx2: toLocalTime("13:44:12.283","HH:mm:ss.n")
}
```

#### Output

```DataWeave
{
  "toLocalTimeEx": "23:57:59",
  "toLocalTimeEx2": "13:44:12.283"
}
```

<!-- document id=da4c3a71df84a6f9529296b3123458bbd65cbf3894ff64833ced7fb2e44afcb9 url=/mulesoft/current/en-us/dataweave/2.11/dw-coercions-functions-tolocaltimeornull.md -->

---
product: DataWeave
version: 2.11
---

# toLocalTimeOrNull

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toLocalTimeOrNull(str: String, formatters: Array<Formatter>): LocalTime | Null

Transforms a `String` value into a `LocalTime` value using the first `Formatter` that matches with
the given value to transform.

If none of the `Formatter` matches with the given value, the function returns a `null` value.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>LocalTime</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>LocalTime</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toLocalTimeOrNull` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  a: toLocalTimeOrNull("23:57:59", [{format: "HH:mm:ss.n"}, {format: "HH:mm:ss"}]),
  b: toLocalTimeOrNull("23:57:59", [{format: "HH:mm:ss.n"}])
}
```

#### Output

```DataWeave
{
  a: |23:57:59| as LocalTime {format: "HH:mm:ss"},
  b: null
}
```

<!-- document id=641c455a5becf4ef33541b940a3efa5e03f30edc9f544969bae58b0b135e3bf8 url=/mulesoft/current/en-us/dataweave/2.12/dw-coercions-functions-tolocaltimeornull.md -->

---
product: DataWeave
version: 2.12
---

# toLocalTimeOrNull

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toLocalTimeOrNull(str: String, formatters: Array<Formatter>): LocalTime | Null

Transforms a `String` value into a `LocalTime` value using the first `Formatter` that matches with
the given value to transform.

If none of the `Formatter` matches with the given value, the function returns a `null` value.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>LocalTime</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>LocalTime</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toLocalTimeOrNull` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  a: toLocalTimeOrNull("23:57:59", [{format: "HH:mm:ss.n"}, {format: "HH:mm:ss"}]),
  b: toLocalTimeOrNull("23:57:59", [{format: "HH:mm:ss.n"}])
}
```

#### Output

```DataWeave
{
  a: |23:57:59| as LocalTime {format: "HH:mm:ss"},
  b: null
}
```

<!-- document id=26c8654667d4e286601729e16d6b650e0a20d08662554fc64ea565029abfe445 url=/mulesoft/current/en-us/dataweave/2.6/dw-coercions-functions-tolocaltimeornull.md -->

---
product: DataWeave
version: 2.6
---

# toLocalTimeOrNull

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toLocalTimeOrNull(str: String, formatters: Array<Formatter>): LocalTime | Null

Transforms a `String` value into a `LocalTime` value using the first `Formatter` that matches with
the given value to transform.

If none of the `Formatter` matches with the given value, the function returns a `null` value.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>LocalTime</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>LocalTime</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toLocalTimeOrNull` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  a: toLocalTimeOrNull("23:57:59", [{format: "HH:mm:ss.n"}, {format: "HH:mm:ss"}]),
  b: toLocalTimeOrNull("23:57:59", [{format: "HH:mm:ss.n"}])
}
```

#### Output

```DataWeave
{
  a: |23:57:59| as LocalTime {format: "HH:mm:ss"},
  b: null
}
```

<!-- document id=e1428bcf486e4b901a4dd094cef4ae79edfc86d6060265a9ab9213658ae3d78c url=/mulesoft/current/en-us/dataweave/2.9/dw-coercions-functions-tolocaltimeornull.md -->

---
product: DataWeave
version: 2.9
---

# toLocalTimeOrNull

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toLocalTimeOrNull(str: String, formatters: Array<Formatter>): LocalTime | Null

Transforms a `String` value into a `LocalTime` value using the first `Formatter` that matches with
the given value to transform.

If none of the `Formatter` matches with the given value, the function returns a `null` value.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>LocalTime</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>LocalTime</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toLocalTimeOrNull` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  a: toLocalTimeOrNull("23:57:59", [{format: "HH:mm:ss.n"}, {format: "HH:mm:ss"}]),
  b: toLocalTimeOrNull("23:57:59", [{format: "HH:mm:ss.n"}])
}
```

#### Output

```DataWeave
{
  a: |23:57:59| as LocalTime {format: "HH:mm:ss"},
  b: null
}
```

<!-- document id=7ec1f42a7ddd2beca66fc93cca51b0c6a5aa95bafe4ad79bbf8fa6e6748c161d url=/mulesoft/current/en-us/dataweave/latest/dw-coercions-functions-tolocaltimeornull.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# toLocalTimeOrNull

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toLocalTimeOrNull(str: String, formatters: Array<Formatter>): LocalTime | Null

Transforms a `String` value into a `LocalTime` value using the first `Formatter` that matches with
the given value to transform.

If none of the `Formatter` matches with the given value, the function returns a `null` value.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>LocalTime</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>LocalTime</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toLocalTimeOrNull` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  a: toLocalTimeOrNull("23:57:59", [{format: "HH:mm:ss.n"}, {format: "HH:mm:ss"}]),
  b: toLocalTimeOrNull("23:57:59", [{format: "HH:mm:ss.n"}])
}
```

#### Output

```DataWeave
{
  a: |23:57:59| as LocalTime {format: "HH:mm:ss"},
  b: null
}
```

<!-- document id=d7c0f00f591ca04009dbeae7601616ebbd674e56b8bfdaaebaf4ca9e5df4f12e url=/mulesoft/current/en-us/dataweave/2.11/dw-timer-functions-tomilliseconds.md -->

---
product: DataWeave
version: 2.11
---

# toMilliseconds

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toMilliseconds(date: DateTime): Number

Returns the representation of a specified date-time in milliseconds.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><p>A <code>DateTime</code> to evaluate.</p></td></tr></tbody></table>

### Example

This example shows a date-time in milliseconds.

#### Source

```Dataweave
%dw 2.0
import * from dw::util::Timer
output application/json
---
{ "toMilliseconds" : toMilliseconds(|2018-07-23T22:03:04.829Z|) }
```

#### Output

```XML
{ "toMilliseconds": 1532383384829 }
```

<!-- document id=ac4000773ca2e083e6e163de3adcd0dcc1e3a4a9662dc90b14135852c0e3bf35 url=/mulesoft/current/en-us/dataweave/2.12/dw-timer-functions-tomilliseconds.md -->

---
product: DataWeave
version: 2.12
---

# toMilliseconds

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toMilliseconds(date: DateTime): Number

Returns the representation of a specified date-time in milliseconds.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><p>A <code>DateTime</code> to evaluate.</p></td></tr></tbody></table>

### Example

This example shows a date-time in milliseconds.

#### Source

```Dataweave
%dw 2.0
import * from dw::util::Timer
output application/json
---
{ "toMilliseconds" : toMilliseconds(|2018-07-23T22:03:04.829Z|) }
```

#### Output

```XML
{ "toMilliseconds": 1532383384829 }
```

<!-- document id=7e230b876f5532d70d7b5066cce886d42252a5f9bc11c2bfbbf0b5f6d58198d8 url=/mulesoft/current/en-us/dataweave/2.3/dw-timer-functions-tomilliseconds.md -->

---
product: DataWeave
version: 2.3
---

# toMilliseconds

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toMilliseconds(DateTime): Number

Returns the representation of a specified date-time in milliseconds.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><p>A <code>DateTime</code> to evaluate.</p></td></tr></tbody></table>

### Example

This example shows a date-time in milliseconds.

#### Source

```Dataweave
%dw 2.0
import * from dw::util::Timer
output application/json
---
{ "toMilliseconds" : toMilliseconds(|2018-07-23T22:03:04.829Z|) }
```

#### Output

```XML
{ "toMilliseconds": 1532383384829 }
```

<!-- document id=f138e94d412e7d52cbbdbfeb1b6cd0b0ce1ab056bb69a88711d31390d4106f9d url=/mulesoft/current/en-us/dataweave/2.4/dw-timer-functions-tomilliseconds.md -->

---
product: DataWeave
version: 2.4
---

# toMilliseconds

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toMilliseconds(date: DateTime): Number

Returns the representation of a specified date-time in milliseconds.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><p>A <code>DateTime</code> to evaluate.</p></td></tr></tbody></table>

### Example

This example shows a date-time in milliseconds.

#### Source

```Dataweave
%dw 2.0
import * from dw::util::Timer
output application/json
---
{ "toMilliseconds" : toMilliseconds(|2018-07-23T22:03:04.829Z|) }
```

#### Output

```XML
{ "toMilliseconds": 1532383384829 }
```

<!-- document id=33c4270700f65240c789ea7986b704ce1dde53a9477adbf4545e3f0534a40401 url=/mulesoft/current/en-us/dataweave/2.6/dw-timer-functions-tomilliseconds.md -->

---
product: DataWeave
version: 2.6
---

# toMilliseconds

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toMilliseconds(date: DateTime): Number

Returns the representation of a specified date-time in milliseconds.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><p>A <code>DateTime</code> to evaluate.</p></td></tr></tbody></table>

### Example

This example shows a date-time in milliseconds.

#### Source

```Dataweave
%dw 2.0
import * from dw::util::Timer
output application/json
---
{ "toMilliseconds" : toMilliseconds(|2018-07-23T22:03:04.829Z|) }
```

#### Output

```XML
{ "toMilliseconds": 1532383384829 }
```

<!-- document id=82bac749ffcaec4dd53cbe7fb9b35d7c17c2d27a5acf5b8656e2489dfb57c00f url=/mulesoft/current/en-us/dataweave/2.9/dw-timer-functions-tomilliseconds.md -->

---
product: DataWeave
version: 2.9
---

# toMilliseconds

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toMilliseconds(date: DateTime): Number

Returns the representation of a specified date-time in milliseconds.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><p>A <code>DateTime</code> to evaluate.</p></td></tr></tbody></table>

### Example

This example shows a date-time in milliseconds.

#### Source

```Dataweave
%dw 2.0
import * from dw::util::Timer
output application/json
---
{ "toMilliseconds" : toMilliseconds(|2018-07-23T22:03:04.829Z|) }
```

#### Output

```XML
{ "toMilliseconds": 1532383384829 }
```

<!-- document id=ba2d07f76071ef8fed57a2815c8297aec5412c018acc42753443b432de099383 url=/mulesoft/current/en-us/dataweave/latest/dw-timer-functions-tomilliseconds.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# toMilliseconds

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toMilliseconds(date: DateTime): Number

Returns the representation of a specified date-time in milliseconds.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><p>A <code>DateTime</code> to evaluate.</p></td></tr></tbody></table>

### Example

This example shows a date-time in milliseconds.

#### Source

```Dataweave
%dw 2.0
import * from dw::util::Timer
output application/json
---
{ "toMilliseconds" : toMilliseconds(|2018-07-23T22:03:04.829Z|) }
```

#### Output

```XML
{ "toMilliseconds": 1532383384829 }
```

<!-- document id=46b3fc2311b0537cc88e6a5409d2b9b3fbdbd47c10d342f7f1f188b2b1c28ab3 url=/mulesoft/current/en-us/dataweave/2.11/dw-dates-functions-tomorrow.md -->

---
product: DataWeave
version: 2.11
---

# tomorrow

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## tomorrow(): Date

Returns the date for tomorrow as a `Date` type.

_Introduced in DataWeave version 2.4.0._

### Example

This example shows the output of `tomorrow` function.

#### Source

```DataWeave
%dw 2.0
import tomorrow from dw::core::Dates
output application/json
---
tomorrow()
```

#### Output

```Json
"2021-05-16"
```

<!-- document id=174a22408e984f0d6a79deff5f6fdfb052b5435d718bc1b3aa8313127faf01c1 url=/mulesoft/current/en-us/dataweave/2.12/dw-dates-functions-tomorrow.md -->

---
product: DataWeave
version: 2.12
---

# tomorrow

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## tomorrow(): Date

Returns the date for tomorrow as a `Date` type.

_Introduced in DataWeave version 2.4.0._

### Example

This example shows the output of `tomorrow` function.

#### Source

```DataWeave
%dw 2.0
import tomorrow from dw::core::Dates
output application/json
---
tomorrow()
```

#### Output

```Json
"2021-05-16"
```

<!-- document id=5ebd3f1725215cd39538855be9a74f5f4d2fd0d3a212b4fa43f99d02becfd57f url=/mulesoft/current/en-us/dataweave/2.4/dw-dates-functions-tomorrow.md -->

---
product: DataWeave
version: 2.4
---

# tomorrow

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## tomorrow(): Date

Returns the date for tomorrow as a `Date` type.

_Introduced in DataWeave version 2.4.0._

### Example

This example shows the output of `tomorrow` function.

#### Source

```DataWeave
%dw 2.0
import tomorrow from dw::core::Dates
output application/json
---
tomorrow()
```

#### Output

```Json
"2021-05-16"
```

<!-- document id=d764bf0fa897f5d91852854f4f8057f34bd546ede259923ff91385c161c15625 url=/mulesoft/current/en-us/dataweave/2.6/dw-dates-functions-tomorrow.md -->

---
product: DataWeave
version: 2.6
---

# tomorrow

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## tomorrow(): Date

Returns the date for tomorrow as a `Date` type.

_Introduced in DataWeave version 2.4.0._

### Example

This example shows the output of `tomorrow` function.

#### Source

```DataWeave
%dw 2.0
import tomorrow from dw::core::Dates
output application/json
---
tomorrow()
```

#### Output

```Json
"2021-05-16"
```

<!-- document id=0e017213f9b6492e5df0525eafeda84ffde6002d07aa59200e715e8339f0fee3 url=/mulesoft/current/en-us/dataweave/2.9/dw-dates-functions-tomorrow.md -->

---
product: DataWeave
version: 2.9
---

# tomorrow

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## tomorrow(): Date

Returns the date for tomorrow as a `Date` type.

_Introduced in DataWeave version 2.4.0._

### Example

This example shows the output of `tomorrow` function.

#### Source

```DataWeave
%dw 2.0
import tomorrow from dw::core::Dates
output application/json
---
tomorrow()
```

#### Output

```Json
"2021-05-16"
```

<!-- document id=911088e658e8e2a2838cf4a9f4d150093b09d659a06f4567d753a599bb9b2e1f url=/mulesoft/current/en-us/dataweave/latest/dw-dates-functions-tomorrow.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# tomorrow

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## tomorrow(): Date

Returns the date for tomorrow as a `Date` type.

_Introduced in DataWeave version 2.4.0._

### Example

This example shows the output of `tomorrow` function.

#### Source

```DataWeave
%dw 2.0
import tomorrow from dw::core::Dates
output application/json
---
tomorrow()
```

#### Output

```Json
"2021-05-16"
```

<!-- document id=e3410398064e866a6b47af300d0bfc3bedad24048cfb93e4a8f2bab21082431a url=/mulesoft/current/en-us/dataweave/2.11/dw-coercions-functions-tonumber.md -->

---
product: DataWeave
version: 2.11
---

# toNumber

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toNumber(str: String, formatters: Array<Formatter>): Number

Transforms a `String` value into a `Number` value using the first `Formatter` that matches with the
given value to transform.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>Number</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;DatesFormatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>Number</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toNumber` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
import * from dw::Runtime
output application/dw
---
{
  a: toNumber("0.005", [{format: "seconds"}, {format: ".00"}]),
  b: try(() -> toNumber("0.005", [{format: "seconds"}])).error.message
}
```

#### Output

```DataWeave
{
  a: 0.005 as Number {format: ".00"},
  b: "Could not find a valid formatter for '0.005'"
}
```

## toNumber(dateTime: DateTime, unit: MillisOrSecs | Null = null): Number

A variant of `toNumber` that transforms a `DateTime` value into a number of seconds or milliseconds,
depending on the selected unit.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><p>The <code>DateTime</code> value to transform into a <code>Number</code> value.</p></td></tr><tr><td><p><code>unit</code></p></td><td><p>The unit of time (<code>"milliseconds"</code> or <code>"seconds"</code>) to use Given a <code>null</code> value, the function uses <code>"seconds"</code>.</p></td></tr></tbody></table>

### Example

This example shows how `toNumber` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
    epoch: toNumber(|2015-10-01T23:57:59Z|),
    millis: toNumber(|2015-10-01T23:57:59Z|, "milliseconds")
}
```

#### Output

```DataWeave
{
  "epoch": 1443743879,
  "millis": 1443743879000
}
```

## toNumber(period: Period, unit: PeriodUnits | Null = null): Number

A variant of `toNumber` that transforms a `Period` value into a number of hours, minutes, seconds,
milliseconds or nanoseconds (`nanos`).

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>period</code></p></td><td><p>The <code>Period</code> value to transform into a <code>Number</code> value.</p></td></tr><tr><td><p><code>unit</code></p></td><td><p>The unit to apply to the specified <code>period</code>: <code>hours</code>, <code>minutes</code>, <code>seconds</code>, <code>milliseconds</code>, or <code>nanos</code>.</p></td></tr></tbody></table>

### Example

This example shows how `toNumber` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
    toSecondsEx1: toNumber(|PT1H10M|, "seconds"),
    toSecondsEx2: toNumber(|PT1M7S|, "milliseconds")
}
```

#### Output

```Json
{
  "toSecondsEx1": 4200,
  "toSecondsEx2": 67000
}
```

## toNumber(value: String | Key, format: String | Null = null, locale: String | Null = null): Number

A variant of `toNumber` that transforms a `String` or `Key` value into a `Number` value and that
accepts a format and locale.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The <code>String</code> or <code>Key</code> value to transform into a <code>Number</code> value.</p></td></tr><tr><td><p><code>format</code></p></td><td><p>Optional formatting to apply to the <code>value</code>. A <code>format</code> accepts <code>#</code> or <code>0</code> (but not both) as placeholders for <em>decimal</em> values and a single whole number that is less than <code>10</code>. Only one decimal point is permitted. A <code>null</code> or empty <code>String</code> value has no effect on the <code>Number</code> value. Other characters produce an error.</p></td></tr><tr><td><p><code>locale</code></p></td><td><p>Optional ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default.</p></td></tr></tbody></table>

### Example

This example shows how `toNumber` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
var myKey = keysOf({"123" : "myValue"})
output application/json
---
 {
     "default": toNumber("1.0"),
     "withFormat": toNumber("0.005",".00"),
     "withLocal": toNumber("1,25","#.##","ES"),
     "withExtraPlaceholders": toNumber("5.55","####.####"),
     "keyToNumber": toNumber(myKey[0])
 }
```

#### Output

```Json
{
  "default": 1.0,
  "withFormat": 0.005,
  "withLocal": 1.25,
  "withExtraPlaceholders": 5.55,
  "keyToNumber": 123
}
```

<!-- document id=50c92e9f3efb69418205c5f51dd364d252e31adb786a984e52712db08ac06ed1 url=/mulesoft/current/en-us/dataweave/2.12/dw-coercions-functions-tonumber.md -->

---
product: DataWeave
version: 2.12
---

# toNumber

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toNumber(str: String, formatters: Array<Formatter>): Number

Transforms a `String` value into a `Number` value using the first `Formatter` that matches with the
given value to transform.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>Number</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;DatesFormatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>Number</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toNumber` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
import * from dw::Runtime
output application/dw
---
{
  a: toNumber("0.005", [{format: "seconds"}, {format: ".00"}]),
  b: try(() -> toNumber("0.005", [{format: "seconds"}])).error.message
}
```

#### Output

```DataWeave
{
  a: 0.005 as Number {format: ".00"},
  b: "Could not find a valid formatter for '0.005'"
}
```

## toNumber(dateTime: DateTime, unit: MillisOrSecs | Null = null): Number

A variant of `toNumber` that transforms a `DateTime` value into a number of seconds or milliseconds,
depending on the selected unit.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><p>The <code>DateTime</code> value to transform into a <code>Number</code> value.</p></td></tr><tr><td><p><code>unit</code></p></td><td><p>The unit of time (<code>"milliseconds"</code> or <code>"seconds"</code>) to use Given a <code>null</code> value, the function uses <code>"seconds"</code>.</p></td></tr></tbody></table>

### Example

This example shows how `toNumber` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
    epoch: toNumber(|2015-10-01T23:57:59Z|),
    millis: toNumber(|2015-10-01T23:57:59Z|, "milliseconds")
}
```

#### Output

```DataWeave
{
  "epoch": 1443743879,
  "millis": 1443743879000
}
```

## toNumber(period: Period, unit: PeriodUnits | Null = null): Number

A variant of `toNumber` that transforms a `Period` value into a number of hours, minutes, seconds,
milliseconds or nanoseconds (`nanos`).

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>period</code></p></td><td><p>The <code>Period</code> value to transform into a <code>Number</code> value.</p></td></tr><tr><td><p><code>unit</code></p></td><td><p>The unit to apply to the specified <code>period</code>: <code>hours</code>, <code>minutes</code>, <code>seconds</code>, <code>milliseconds</code>, or <code>nanos</code>.</p></td></tr></tbody></table>

### Example

This example shows how `toNumber` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
    toSecondsEx1: toNumber(|PT1H10M|, "seconds"),
    toSecondsEx2: toNumber(|PT1M7S|, "milliseconds")
}
```

#### Output

```Json
{
  "toSecondsEx1": 4200,
  "toSecondsEx2": 67000
}
```

## toNumber(value: String | Key, format: String | Null = null, locale: String | Null = null): Number

A variant of `toNumber` that transforms a `String` or `Key` value into a `Number` value and that
accepts a format and locale.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The <code>String</code> or <code>Key</code> value to transform into a <code>Number</code> value.</p></td></tr><tr><td><p><code>format</code></p></td><td><p>Optional formatting to apply to the <code>value</code>. A <code>format</code> accepts <code>#</code> or <code>0</code> (but not both) as placeholders for <em>decimal</em> values and a single whole number that is less than <code>10</code>. Only one decimal point is permitted. A <code>null</code> or empty <code>String</code> value has no effect on the <code>Number</code> value. Other characters produce an error.</p></td></tr><tr><td><p><code>locale</code></p></td><td><p>Optional ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default.</p></td></tr></tbody></table>

### Example

This example shows how `toNumber` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
var myKey = keysOf({"123" : "myValue"})
output application/json
---
 {
     "default": toNumber("1.0"),
     "withFormat": toNumber("0.005",".00"),
     "withLocal": toNumber("1,25","#.##","ES"),
     "withExtraPlaceholders": toNumber("5.55","####.####"),
     "keyToNumber": toNumber(myKey[0])
 }
```

#### Output

```Json
{
  "default": 1.0,
  "withFormat": 0.005,
  "withLocal": 1.25,
  "withExtraPlaceholders": 5.55,
  "keyToNumber": 123
}
```

<!-- document id=97238ee6e9bbe9dc0b7e3d1adc75be40c36d29f1a25068b4bbbcf2914bf0eef2 url=/mulesoft/current/en-us/dataweave/2.4/dw-coercions-functions-tonumber.md -->

---
product: DataWeave
version: 2.4
---

# toNumber

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toNumber(dateTime: DateTime, unit: MillisOrSecs | Null = null): Number

A variant of `toNumber` that transforms a `DateTime` value into a number of seconds or milliseconds,
depending on the selected unit.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><p>The <code>DateTime</code> value to transform into a <code>Number</code> value.</p></td></tr><tr><td><p><code>unit</code></p></td><td><p>The unit of time (<code>"milliseconds"</code> or <code>"seconds"</code>) to use Given a <code>null</code> value, the function uses <code>"seconds"</code>.</p></td></tr></tbody></table>

### Example

This example shows how `toNumber` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
    epoch: toNumber(|2015-10-01T23:57:59Z|),
    millis: toNumber(|2015-10-01T23:57:59Z|, "milliseconds")
}
```

#### Output

```DataWeave
{
  "epoch": 1443743879,
  "millis": 1443743879000
}
```

## toNumber(period: Period, unit: PeriodUnits | Null = null): Number

A variant of `toNumber` that transforms a `Period` value into a number of hours, minutes, seconds,
milliseconds or nanoseconds (`nanos`).

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>period</code></p></td><td><p>The <code>Period</code> value to transform into a <code>Number</code> value.</p></td></tr><tr><td><p><code>unit</code></p></td><td><p>The unit to apply to the specified <code>period</code>: <code>hours</code>, <code>minutes</code>, <code>seconds</code>, <code>milliseconds</code>, or <code>nanos</code>.</p></td></tr></tbody></table>

### Example

This example shows how `toNumber` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
    toSecondsEx1: toNumber(|PT1H10M|, "seconds"),
    toSecondsEx2: toNumber(|PT1M7S|, "milliseconds")
}
```

#### Output

```Json
{
  "toSecondsEx1": 4200,
  "toSecondsEx2": 67000
}
```

## toNumber(value: String | Key, format: String | Null = null, locale: String | Null = null): Number

A variant of `toNumber` that transforms a `String` or `Key` value into a `Number` value and that
accepts a format and locale.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The <code>String</code> or <code>Key</code> value to transform into a <code>Number</code> value.</p></td></tr><tr><td><p><code>format</code></p></td><td><p>Optional formatting to apply to the <code>value</code>. A <code>format</code> accepts <code>#</code> or <code>0</code> (but not both) as placeholders for <em>decimal</em> values and a single whole number that is less than <code>10</code>. Only one decimal point is permitted. A <code>null</code> or empty <code>String</code> value has no effect on the <code>Number</code> value. Other characters produce an error.</p></td></tr><tr><td><p><code>locale</code></p></td><td><p>Optional ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default.</p></td></tr></tbody></table>

### Example

This example shows how `toNumber` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
var myKey = keysOf({"123" : "myValue"})
output application/json
---
 {
     "default": toNumber("1.0"),
     "withFormat": toNumber("0.005",".00"),
     "withLocal": toNumber("1,25","#.##","ES"),
     "withExtraPlaceholders": toNumber("5.55","####.####"),
     "keyToNumber": toNumber(myKey[0])
 }
```

#### Output

```Json
{
  "default": 1.0,
  "withFormat": 0.005,
  "withLocal": 1.25,
  "withExtraPlaceholders": 5.55,
  "keyToNumber": 123
}
```

<!-- document id=bcdbffa5a89611b35147dec1e36ddaf8aee82e13c156b7368c4b299274707f2e url=/mulesoft/current/en-us/dataweave/2.6/dw-coercions-functions-tonumber.md -->

---
product: DataWeave
version: 2.6
---

# toNumber

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toNumber(str: String, formatters: Array<Formatter>): Number

Transforms a `String` value into a `Number` value using the first `Formatter` that matches with the
given value to transform.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>Number</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;DatesFormatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>Number</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toNumber` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
import * from dw::Runtime
output application/dw
---
{
  a: toNumber("0.005", [{format: "seconds"}, {format: ".00"}]),
  b: try(() -> toNumber("0.005", [{format: "seconds"}])).error.message
}
```

#### Output

```DataWeave
{
  a: 0.005 as Number {format: ".00"},
  b: "Could not find a valid formatter for '0.005'"
}
```

## toNumber(dateTime: DateTime, unit: MillisOrSecs | Null = null): Number

A variant of `toNumber` that transforms a `DateTime` value into a number of seconds or milliseconds,
depending on the selected unit.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><p>The <code>DateTime</code> value to transform into a <code>Number</code> value.</p></td></tr><tr><td><p><code>unit</code></p></td><td><p>The unit of time (<code>"milliseconds"</code> or <code>"seconds"</code>) to use Given a <code>null</code> value, the function uses <code>"seconds"</code>.</p></td></tr></tbody></table>

### Example

This example shows how `toNumber` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
    epoch: toNumber(|2015-10-01T23:57:59Z|),
    millis: toNumber(|2015-10-01T23:57:59Z|, "milliseconds")
}
```

#### Output

```DataWeave
{
  "epoch": 1443743879,
  "millis": 1443743879000
}
```

## toNumber(period: Period, unit: PeriodUnits | Null = null): Number

A variant of `toNumber` that transforms a `Period` value into a number of hours, minutes, seconds,
milliseconds or nanoseconds (`nanos`).

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>period</code></p></td><td><p>The <code>Period</code> value to transform into a <code>Number</code> value.</p></td></tr><tr><td><p><code>unit</code></p></td><td><p>The unit to apply to the specified <code>period</code>: <code>hours</code>, <code>minutes</code>, <code>seconds</code>, <code>milliseconds</code>, or <code>nanos</code>.</p></td></tr></tbody></table>

### Example

This example shows how `toNumber` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
    toSecondsEx1: toNumber(|PT1H10M|, "seconds"),
    toSecondsEx2: toNumber(|PT1M7S|, "milliseconds")
}
```

#### Output

```Json
{
  "toSecondsEx1": 4200,
  "toSecondsEx2": 67000
}
```

## toNumber(value: String | Key, format: String | Null = null, locale: String | Null = null): Number

A variant of `toNumber` that transforms a `String` or `Key` value into a `Number` value and that
accepts a format and locale.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The <code>String</code> or <code>Key</code> value to transform into a <code>Number</code> value.</p></td></tr><tr><td><p><code>format</code></p></td><td><p>Optional formatting to apply to the <code>value</code>. A <code>format</code> accepts <code>#</code> or <code>0</code> (but not both) as placeholders for <em>decimal</em> values and a single whole number that is less than <code>10</code>. Only one decimal point is permitted. A <code>null</code> or empty <code>String</code> value has no effect on the <code>Number</code> value. Other characters produce an error.</p></td></tr><tr><td><p><code>locale</code></p></td><td><p>Optional ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default.</p></td></tr></tbody></table>

### Example

This example shows how `toNumber` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
var myKey = keysOf({"123" : "myValue"})
output application/json
---
 {
     "default": toNumber("1.0"),
     "withFormat": toNumber("0.005",".00"),
     "withLocal": toNumber("1,25","#.##","ES"),
     "withExtraPlaceholders": toNumber("5.55","####.####"),
     "keyToNumber": toNumber(myKey[0])
 }
```

#### Output

```Json
{
  "default": 1.0,
  "withFormat": 0.005,
  "withLocal": 1.25,
  "withExtraPlaceholders": 5.55,
  "keyToNumber": 123
}
```

<!-- document id=73ff14e950c507cf65a5eeb4a63f0360ffdb836c3d32fb3e32e16f2662ca0535 url=/mulesoft/current/en-us/dataweave/2.9/dw-coercions-functions-tonumber.md -->

---
product: DataWeave
version: 2.9
---

# toNumber

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toNumber(str: String, formatters: Array<Formatter>): Number

Transforms a `String` value into a `Number` value using the first `Formatter` that matches with the
given value to transform.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>Number</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;DatesFormatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>Number</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toNumber` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
import * from dw::Runtime
output application/dw
---
{
  a: toNumber("0.005", [{format: "seconds"}, {format: ".00"}]),
  b: try(() -> toNumber("0.005", [{format: "seconds"}])).error.message
}
```

#### Output

```DataWeave
{
  a: 0.005 as Number {format: ".00"},
  b: "Could not find a valid formatter for '0.005'"
}
```

## toNumber(dateTime: DateTime, unit: MillisOrSecs | Null = null): Number

A variant of `toNumber` that transforms a `DateTime` value into a number of seconds or milliseconds,
depending on the selected unit.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><p>The <code>DateTime</code> value to transform into a <code>Number</code> value.</p></td></tr><tr><td><p><code>unit</code></p></td><td><p>The unit of time (<code>"milliseconds"</code> or <code>"seconds"</code>) to use Given a <code>null</code> value, the function uses <code>"seconds"</code>.</p></td></tr></tbody></table>

### Example

This example shows how `toNumber` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
    epoch: toNumber(|2015-10-01T23:57:59Z|),
    millis: toNumber(|2015-10-01T23:57:59Z|, "milliseconds")
}
```

#### Output

```DataWeave
{
  "epoch": 1443743879,
  "millis": 1443743879000
}
```

## toNumber(period: Period, unit: PeriodUnits | Null = null): Number

A variant of `toNumber` that transforms a `Period` value into a number of hours, minutes, seconds,
milliseconds or nanoseconds (`nanos`).

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>period</code></p></td><td><p>The <code>Period</code> value to transform into a <code>Number</code> value.</p></td></tr><tr><td><p><code>unit</code></p></td><td><p>The unit to apply to the specified <code>period</code>: <code>hours</code>, <code>minutes</code>, <code>seconds</code>, <code>milliseconds</code>, or <code>nanos</code>.</p></td></tr></tbody></table>

### Example

This example shows how `toNumber` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
    toSecondsEx1: toNumber(|PT1H10M|, "seconds"),
    toSecondsEx2: toNumber(|PT1M7S|, "milliseconds")
}
```

#### Output

```Json
{
  "toSecondsEx1": 4200,
  "toSecondsEx2": 67000
}
```

## toNumber(value: String | Key, format: String | Null = null, locale: String | Null = null): Number

A variant of `toNumber` that transforms a `String` or `Key` value into a `Number` value and that
accepts a format and locale.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The <code>String</code> or <code>Key</code> value to transform into a <code>Number</code> value.</p></td></tr><tr><td><p><code>format</code></p></td><td><p>Optional formatting to apply to the <code>value</code>. A <code>format</code> accepts <code>#</code> or <code>0</code> (but not both) as placeholders for <em>decimal</em> values and a single whole number that is less than <code>10</code>. Only one decimal point is permitted. A <code>null</code> or empty <code>String</code> value has no effect on the <code>Number</code> value. Other characters produce an error.</p></td></tr><tr><td><p><code>locale</code></p></td><td><p>Optional ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default.</p></td></tr></tbody></table>

### Example

This example shows how `toNumber` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
var myKey = keysOf({"123" : "myValue"})
output application/json
---
 {
     "default": toNumber("1.0"),
     "withFormat": toNumber("0.005",".00"),
     "withLocal": toNumber("1,25","#.##","ES"),
     "withExtraPlaceholders": toNumber("5.55","####.####"),
     "keyToNumber": toNumber(myKey[0])
 }
```

#### Output

```Json
{
  "default": 1.0,
  "withFormat": 0.005,
  "withLocal": 1.25,
  "withExtraPlaceholders": 5.55,
  "keyToNumber": 123
}
```

<!-- document id=0aec51a1db32bf21eb6e2f3e4ffb314a03d963e72c83e22471c55a9a6624a9a9 url=/mulesoft/current/en-us/dataweave/latest/dw-coercions-functions-tonumber.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# toNumber

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toNumber(str: String, formatters: Array<Formatter>): Number

Transforms a `String` value into a `Number` value using the first `Formatter` that matches with the
given value to transform.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>Number</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;DatesFormatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>Number</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toNumber` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
import * from dw::Runtime
output application/dw
---
{
  a: toNumber("0.005", [{format: "seconds"}, {format: ".00"}]),
  b: try(() -> toNumber("0.005", [{format: "seconds"}])).error.message
}
```

#### Output

```DataWeave
{
  a: 0.005 as Number {format: ".00"},
  b: "Could not find a valid formatter for '0.005'"
}
```

## toNumber(dateTime: DateTime, unit: MillisOrSecs | Null = null): Number

A variant of `toNumber` that transforms a `DateTime` value into a number of seconds or milliseconds,
depending on the selected unit.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>dateTime</code></p></td><td><p>The <code>DateTime</code> value to transform into a <code>Number</code> value.</p></td></tr><tr><td><p><code>unit</code></p></td><td><p>The unit of time (<code>"milliseconds"</code> or <code>"seconds"</code>) to use Given a <code>null</code> value, the function uses <code>"seconds"</code>.</p></td></tr></tbody></table>

### Example

This example shows how `toNumber` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
    epoch: toNumber(|2015-10-01T23:57:59Z|),
    millis: toNumber(|2015-10-01T23:57:59Z|, "milliseconds")
}
```

#### Output

```DataWeave
{
  "epoch": 1443743879,
  "millis": 1443743879000
}
```

## toNumber(period: Period, unit: PeriodUnits | Null = null): Number

A variant of `toNumber` that transforms a `Period` value into a number of hours, minutes, seconds,
milliseconds or nanoseconds (`nanos`).

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>period</code></p></td><td><p>The <code>Period</code> value to transform into a <code>Number</code> value.</p></td></tr><tr><td><p><code>unit</code></p></td><td><p>The unit to apply to the specified <code>period</code>: <code>hours</code>, <code>minutes</code>, <code>seconds</code>, <code>milliseconds</code>, or <code>nanos</code>.</p></td></tr></tbody></table>

### Example

This example shows how `toNumber` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
    toSecondsEx1: toNumber(|PT1H10M|, "seconds"),
    toSecondsEx2: toNumber(|PT1M7S|, "milliseconds")
}
```

#### Output

```Json
{
  "toSecondsEx1": 4200,
  "toSecondsEx2": 67000
}
```

## toNumber(value: String | Key, format: String | Null = null, locale: String | Null = null): Number

A variant of `toNumber` that transforms a `String` or `Key` value into a `Number` value and that
accepts a format and locale.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The <code>String</code> or <code>Key</code> value to transform into a <code>Number</code> value.</p></td></tr><tr><td><p><code>format</code></p></td><td><p>Optional formatting to apply to the <code>value</code>. A <code>format</code> accepts <code>#</code> or <code>0</code> (but not both) as placeholders for <em>decimal</em> values and a single whole number that is less than <code>10</code>. Only one decimal point is permitted. A <code>null</code> or empty <code>String</code> value has no effect on the <code>Number</code> value. Other characters produce an error.</p></td></tr><tr><td><p><code>locale</code></p></td><td><p>Optional ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default.</p></td></tr></tbody></table>

### Example

This example shows how `toNumber` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
var myKey = keysOf({"123" : "myValue"})
output application/json
---
 {
     "default": toNumber("1.0"),
     "withFormat": toNumber("0.005",".00"),
     "withLocal": toNumber("1,25","#.##","ES"),
     "withExtraPlaceholders": toNumber("5.55","####.####"),
     "keyToNumber": toNumber(myKey[0])
 }
```

#### Output

```Json
{
  "default": 1.0,
  "withFormat": 0.005,
  "withLocal": 1.25,
  "withExtraPlaceholders": 5.55,
  "keyToNumber": 123
}
```

<!-- document id=d15d4e95ea52bddd1e9d1af8c648d08f4d7cab656b277ebded5abc63ab314f32 url=/mulesoft/current/en-us/dataweave/2.11/dw-coercions-functions-tonumberornull.md -->

---
product: DataWeave
version: 2.11
---

# toNumberOrNull

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toNumberOrNull(str: String, formatters: Array<Formatter>): Number | Null

Transforms a `String` value into a `Number` value using the first `Formatter` that matches with the
given value to transform.

If none of the `Formatter` matches with the given value, the function returns a `null` value.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>Number</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>Number</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toNumberOrNull` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  a: toNumberOrNull("0.005", [{format: "seconds"}, {format: ".00"}]),
  b: toNumberOrNull("0.005", [{format: "seconds"}])
}
```

#### Output

```DataWeave
{
  a: 0.005 as Number {format: ".00"},
  b: null
}
```

<!-- document id=41f9f10b15fcf6078992f606dd41a24b2172cca36b0927d22a68ab078d670208 url=/mulesoft/current/en-us/dataweave/2.12/dw-coercions-functions-tonumberornull.md -->

---
product: DataWeave
version: 2.12
---

# toNumberOrNull

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toNumberOrNull(str: String, formatters: Array<Formatter>): Number | Null

Transforms a `String` value into a `Number` value using the first `Formatter` that matches with the
given value to transform.

If none of the `Formatter` matches with the given value, the function returns a `null` value.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>Number</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>Number</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toNumberOrNull` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  a: toNumberOrNull("0.005", [{format: "seconds"}, {format: ".00"}]),
  b: toNumberOrNull("0.005", [{format: "seconds"}])
}
```

#### Output

```DataWeave
{
  a: 0.005 as Number {format: ".00"},
  b: null
}
```

<!-- document id=c3bb6b517a7735594da1e68e1fc14b68af6cbd0f88278c85e55ff90d6ecdb271 url=/mulesoft/current/en-us/dataweave/2.6/dw-coercions-functions-tonumberornull.md -->

---
product: DataWeave
version: 2.6
---

# toNumberOrNull

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toNumberOrNull(str: String, formatters: Array<Formatter>): Number | Null

Transforms a `String` value into a `Number` value using the first `Formatter` that matches with the
given value to transform.

If none of the `Formatter` matches with the given value, the function returns a `null` value.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>Number</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>Number</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toNumberOrNull` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  a: toNumberOrNull("0.005", [{format: "seconds"}, {format: ".00"}]),
  b: toNumberOrNull("0.005", [{format: "seconds"}])
}
```

#### Output

```DataWeave
{
  a: 0.005 as Number {format: ".00"},
  b: null
}
```

<!-- document id=2e9fe25de40b09feb8c27616f3a62c70c635a5d4d85d72404accb5c6b0e6f760 url=/mulesoft/current/en-us/dataweave/2.9/dw-coercions-functions-tonumberornull.md -->

---
product: DataWeave
version: 2.9
---

# toNumberOrNull

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toNumberOrNull(str: String, formatters: Array<Formatter>): Number | Null

Transforms a `String` value into a `Number` value using the first `Formatter` that matches with the
given value to transform.

If none of the `Formatter` matches with the given value, the function returns a `null` value.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>Number</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>Number</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toNumberOrNull` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  a: toNumberOrNull("0.005", [{format: "seconds"}, {format: ".00"}]),
  b: toNumberOrNull("0.005", [{format: "seconds"}])
}
```

#### Output

```DataWeave
{
  a: 0.005 as Number {format: ".00"},
  b: null
}
```

<!-- document id=288b06c886a54e8fb0f47625d268fb0acef229ed9a89f350f28c7a4e58a89082 url=/mulesoft/current/en-us/dataweave/latest/dw-coercions-functions-tonumberornull.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# toNumberOrNull

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toNumberOrNull(str: String, formatters: Array<Formatter>): Number | Null

Transforms a `String` value into a `Number` value using the first `Formatter` that matches with the
given value to transform.

If none of the `Formatter` matches with the given value, the function returns a `null` value.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>Number</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>Number</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toNumberOrNull` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  a: toNumberOrNull("0.005", [{format: "seconds"}, {format: ".00"}]),
  b: toNumberOrNull("0.005", [{format: "seconds"}])
}
```

#### Output

```DataWeave
{
  a: 0.005 as Number {format: ".00"},
  b: null
}
```

<!-- document id=e3f567db04e69ad646bcd9db192c444212ca0787faae575ce4012ee775ddc373 url=/mulesoft/current/en-us/dataweave/2.11/dw-coercions-functions-toperiod.md -->

---
product: DataWeave
version: 2.11
---

# toPeriod

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toPeriod(str: String): Period

Transform a `String` value into a `Period` value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>Period</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toPeriod` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  toPeriodEx1: toPeriod("P1D"),
  toPeriodEx2: toPeriod("PT1H1M")
}
```

#### Output

```Json
{
  toPeriodEx1: |P1D|,
  toPeriodEx2: |PT1H1M|
}
```

<!-- document id=de23887c9fd01d2f2632651e52eb50801d42c586f8faa19eead4e3533c3f6119 url=/mulesoft/current/en-us/dataweave/2.12/dw-coercions-functions-toperiod.md -->

---
product: DataWeave
version: 2.12
---

# toPeriod

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toPeriod(str: String): Period

Transform a `String` value into a `Period` value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>Period</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toPeriod` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  toPeriodEx1: toPeriod("P1D"),
  toPeriodEx2: toPeriod("PT1H1M")
}
```

#### Output

```Json
{
  toPeriodEx1: |P1D|,
  toPeriodEx2: |PT1H1M|
}
```

<!-- document id=412f3e9b779561ce8fadd7db35878e33f513a976f42fa175ca84ac48675035b8 url=/mulesoft/current/en-us/dataweave/2.4/dw-coercions-functions-toperiod.md -->

---
product: DataWeave
version: 2.4
---

# toPeriod

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toPeriod(str: String): Period

Transform a `String` value into a `Period` value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>Period</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toPeriod` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  toPeriodEx1: toPeriod("P1D"),
  toPeriodEx2: toPeriod("PT1H1M")
}
```

#### Output

```Json
{
  toPeriodEx1: |P1D|,
  toPeriodEx2: |PT1H1M|
}
```

<!-- document id=6e60b9f57124cee2f032189cba5edbb248fd49e5891f5416c40132b6b13de823 url=/mulesoft/current/en-us/dataweave/2.6/dw-coercions-functions-toperiod.md -->

---
product: DataWeave
version: 2.6
---

# toPeriod

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toPeriod(str: String): Period

Transform a `String` value into a `Period` value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>Period</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toPeriod` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  toPeriodEx1: toPeriod("P1D"),
  toPeriodEx2: toPeriod("PT1H1M")
}
```

#### Output

```Json
{
  toPeriodEx1: |P1D|,
  toPeriodEx2: |PT1H1M|
}
```

<!-- document id=1f22d0ffb714dfd6d02620b8aa10b34edcbbcdb7cfdbecc8f2b8c0a1c2ea5075 url=/mulesoft/current/en-us/dataweave/2.9/dw-coercions-functions-toperiod.md -->

---
product: DataWeave
version: 2.9
---

# toPeriod

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toPeriod(str: String): Period

Transform a `String` value into a `Period` value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>Period</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toPeriod` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  toPeriodEx1: toPeriod("P1D"),
  toPeriodEx2: toPeriod("PT1H1M")
}
```

#### Output

```Json
{
  toPeriodEx1: |P1D|,
  toPeriodEx2: |PT1H1M|
}
```

<!-- document id=41fdf12d6d977a3c4cce23e19823679bc6fb0ea0a626433a805959974a30590c url=/mulesoft/current/en-us/dataweave/latest/dw-coercions-functions-toperiod.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# toPeriod

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toPeriod(str: String): Period

Transform a `String` value into a `Period` value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>Period</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toPeriod` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  toPeriodEx1: toPeriod("P1D"),
  toPeriodEx2: toPeriod("PT1H1M")
}
```

#### Output

```Json
{
  toPeriodEx1: |P1D|,
  toPeriodEx2: |PT1H1M|
}
```

<!-- document id=30730a03636fc3ea17a4d0adea81d920e7487a261f279a108f09ce298af49c00 url=/mulesoft/current/en-us/dataweave/2.11/dw-math-functions-toradians.md -->

---
product: DataWeave
version: 2.11
---

# toRadians

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toRadians(angdeg: Number): Number

Converts a given number of degrees in an angle to an approximately equivalent number of radians.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>angdeg</code></p></td><td><div><div><p>Number of degrees to convert into radians.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `toRadians` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
  "toRadians10":  toRadians(10),
  "toRadians013": toRadians(0.13),
  "toRadians-20": toRadians(-20)
}
```

#### Output

```Json
{
   "toRadians10": 0.1745329251994329576922222222222222,
   "toRadians013": 0.002268928027592628449998888888888889,
   "toRadians-20": -0.3490658503988659153844444444444444
 }
```

<!-- document id=c30cc690c32d69f9083d199ba96772ef0a200dacc0d9b9cc8ffce8f1055f1f94 url=/mulesoft/current/en-us/dataweave/2.12/dw-math-functions-toradians.md -->

---
product: DataWeave
version: 2.12
---

# toRadians

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toRadians(angdeg: Number): Number

Converts a given number of degrees in an angle to an approximately equivalent number of radians.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>angdeg</code></p></td><td><div><div><p>Number of degrees to convert into radians.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `toRadians` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
  "toRadians10":  toRadians(10),
  "toRadians013": toRadians(0.13),
  "toRadians-20": toRadians(-20)
}
```

#### Output

```Json
{
   "toRadians10": 0.1745329251994329576922222222222222,
   "toRadians013": 0.002268928027592628449998888888888889,
   "toRadians-20": -0.3490658503988659153844444444444444
 }
```

<!-- document id=e5011b3c95dc9df9585b9c33c9a08e5607f08df7bc7afa547896d36f721de552 url=/mulesoft/current/en-us/dataweave/2.4/dw-math-functions-toradians.md -->

---
product: DataWeave
version: 2.4
---

# toRadians

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toRadians(angdeg: Number): Number

Converts a given number of degrees in an angle to an approximately equivalent number of radians.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>angdeg</code></p></td><td><div><div><p>Number of degrees to convert into radians.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `toRadians` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
  "toRadians10":  toRadians(10),
  "toRadians013": toRadians(0.13),
  "toRadians-20": toRadians(-20)
}
```

#### Output

```Json
{
   "toRadians10": 0.1745329251994329576922222222222222,
   "toRadians013": 0.002268928027592628449998888888888889,
   "toRadians-20": -0.3490658503988659153844444444444444
 }
```

<!-- document id=63dbe0c379b44a0b697e686c8b6ffc1cacae708e8df1d29ace2faca17af685a0 url=/mulesoft/current/en-us/dataweave/2.6/dw-math-functions-toradians.md -->

---
product: DataWeave
version: 2.6
---

# toRadians

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toRadians(angdeg: Number): Number

Converts a given number of degrees in an angle to an approximately equivalent number of radians.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>angdeg</code></p></td><td><div><div><p>Number of degrees to convert into radians.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `toRadians` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
  "toRadians10":  toRadians(10),
  "toRadians013": toRadians(0.13),
  "toRadians-20": toRadians(-20)
}
```

#### Output

```Json
{
   "toRadians10": 0.1745329251994329576922222222222222,
   "toRadians013": 0.002268928027592628449998888888888889,
   "toRadians-20": -0.3490658503988659153844444444444444
 }
```

<!-- document id=0f364fb85c2c34b77c44ade9ec0d9e17041fc62b867d561d2c659117c197f835 url=/mulesoft/current/en-us/dataweave/2.9/dw-math-functions-toradians.md -->

---
product: DataWeave
version: 2.9
---

# toRadians

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toRadians(angdeg: Number): Number

Converts a given number of degrees in an angle to an approximately equivalent number of radians.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>angdeg</code></p></td><td><div><div><p>Number of degrees to convert into radians.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `toRadians` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
  "toRadians10":  toRadians(10),
  "toRadians013": toRadians(0.13),
  "toRadians-20": toRadians(-20)
}
```

#### Output

```Json
{
   "toRadians10": 0.1745329251994329576922222222222222,
   "toRadians013": 0.002268928027592628449998888888888889,
   "toRadians-20": -0.3490658503988659153844444444444444
 }
```

<!-- document id=5baec7c244de93810f84638df34ac8fd62e30649cf6379a3126d1d86854dfce9 url=/mulesoft/current/en-us/dataweave/latest/dw-math-functions-toradians.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# toRadians

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toRadians(angdeg: Number): Number

Converts a given number of degrees in an angle to an approximately equivalent number of radians.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>angdeg</code></p></td><td><div><div><p>Number of degrees to convert into radians.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `toRadians` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Math
output application/json
---
{
  "toRadians10":  toRadians(10),
  "toRadians013": toRadians(0.13),
  "toRadians-20": toRadians(-20)
}
```

#### Output

```Json
{
   "toRadians10": 0.1745329251994329576922222222222222,
   "toRadians013": 0.002268928027592628449998888888888889,
   "toRadians-20": -0.3490658503988659153844444444444444
 }
```

<!-- document id=d347a6a573bcf270efc66d379f02aba0f5c4bc957d0c20189326fd54a1355ee6 url=/mulesoft/current/en-us/dataweave/2.11/dw-numbers-functions-toradixnumber.md -->

---
product: DataWeave
version: 2.11
---

# toRadixNumber

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toRadixNumber(number: Number, radix: Number): String

Transforms a decimal number into a number string in other radix.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The decimal number.</p></td></tr><tr><td><p><code>radix</code></p></td><td><p>The radix of the result number.</p></td></tr></tbody></table>

### Example

This example shows how the `toRadixNumber` behaves under different inputs.

#### Source

```DataWeave
%dw 2.0
import toRadixNumber from dw::core::Numbers
output application/json
---
{
    a: toRadixNumber(2, 2),
    b: toRadixNumber(255, 16)
}
```

#### Output

```JSON
{
  "a": "10",
  "b": "ff"
}
```

<!-- document id=5121e27f3457111961e63bb9b5d40c9bf72fd45b6ab9b90365f540d6ff69ee1b url=/mulesoft/current/en-us/dataweave/2.12/dw-numbers-functions-toradixnumber.md -->

---
product: DataWeave
version: 2.12
---

# toRadixNumber

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toRadixNumber(number: Number, radix: Number): String

Transforms a decimal number into a number string in other radix.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The decimal number.</p></td></tr><tr><td><p><code>radix</code></p></td><td><p>The radix of the result number.</p></td></tr></tbody></table>

### Example

This example shows how the `toRadixNumber` behaves under different inputs.

#### Source

```DataWeave
%dw 2.0
import toRadixNumber from dw::core::Numbers
output application/json
---
{
    a: toRadixNumber(2, 2),
    b: toRadixNumber(255, 16)
}
```

#### Output

```JSON
{
  "a": "10",
  "b": "ff"
}
```

<!-- document id=7c8cb92083e091f72ed511a91c841b6e84dcedbc8149b571717130b20a5a61a2 url=/mulesoft/current/en-us/dataweave/2.3/dw-numbers-functions-toradixnumber.md -->

---
product: DataWeave
version: 2.3
---

# toRadixNumber

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toRadixNumber(Number, Number): String

Transforms a decimal number into a number string in other radix.

_Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The decimal number.</p></td></tr><tr><td><p><code>radix</code></p></td><td><p>The radix of the result number.</p></td></tr></tbody></table>

### Example

This example shows how the `toRadixNumber` behaves under different inputs.

#### Source

```DataWeave
%dw 2.0
import toRadixNumber from dw::core::Numbers
output application/json
---
{
    a: toRadixNumber(2, 2),
    b: toRadixNumber(255, 16)
}
```

#### Output

```JSON
{
  "a": "10",
  "b": "ff"
}
```

<!-- document id=ea69aed5ceaddc7040fb085ffd5c10bfb5982eab4ae1a21c54cb734ca30dc091 url=/mulesoft/current/en-us/dataweave/2.4/dw-numbers-functions-toradixnumber.md -->

---
product: DataWeave
version: 2.4
---

# toRadixNumber

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toRadixNumber(number: Number, radix: Number): String

Transforms a decimal number into a number string in other radix.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The decimal number.</p></td></tr><tr><td><p><code>radix</code></p></td><td><p>The radix of the result number.</p></td></tr></tbody></table>

### Example

This example shows how the `toRadixNumber` behaves under different inputs.

#### Source

```DataWeave
%dw 2.0
import toRadixNumber from dw::core::Numbers
output application/json
---
{
    a: toRadixNumber(2, 2),
    b: toRadixNumber(255, 16)
}
```

#### Output

```JSON
{
  "a": "10",
  "b": "ff"
}
```

<!-- document id=6da0e220e6be543dc506295a92ddfb8fe8d2b9d655e6ef9a73439ef7f8417152 url=/mulesoft/current/en-us/dataweave/2.6/dw-numbers-functions-toradixnumber.md -->

---
product: DataWeave
version: 2.6
---

# toRadixNumber

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toRadixNumber(number: Number, radix: Number): String

Transforms a decimal number into a number string in other radix.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The decimal number.</p></td></tr><tr><td><p><code>radix</code></p></td><td><p>The radix of the result number.</p></td></tr></tbody></table>

### Example

This example shows how the `toRadixNumber` behaves under different inputs.

#### Source

```DataWeave
%dw 2.0
import toRadixNumber from dw::core::Numbers
output application/json
---
{
    a: toRadixNumber(2, 2),
    b: toRadixNumber(255, 16)
}
```

#### Output

```JSON
{
  "a": "10",
  "b": "ff"
}
```

<!-- document id=7f07f735aa5705670198cca5cf30625c5049b4a858998349c81d01d69eced32d url=/mulesoft/current/en-us/dataweave/2.9/dw-numbers-functions-toradixnumber.md -->

---
product: DataWeave
version: 2.9
---

# toRadixNumber

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toRadixNumber(number: Number, radix: Number): String

Transforms a decimal number into a number string in other radix.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The decimal number.</p></td></tr><tr><td><p><code>radix</code></p></td><td><p>The radix of the result number.</p></td></tr></tbody></table>

### Example

This example shows how the `toRadixNumber` behaves under different inputs.

#### Source

```DataWeave
%dw 2.0
import toRadixNumber from dw::core::Numbers
output application/json
---
{
    a: toRadixNumber(2, 2),
    b: toRadixNumber(255, 16)
}
```

#### Output

```JSON
{
  "a": "10",
  "b": "ff"
}
```

<!-- document id=9ab55b1b6dcd3c8ad102d928cd683997d700178f9f9a720733ef722fe0608f47 url=/mulesoft/current/en-us/dataweave/latest/dw-numbers-functions-toradixnumber.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# toRadixNumber

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toRadixNumber(number: Number, radix: Number): String

Transforms a decimal number into a number string in other radix.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><p>The decimal number.</p></td></tr><tr><td><p><code>radix</code></p></td><td><p>The radix of the result number.</p></td></tr></tbody></table>

### Example

This example shows how the `toRadixNumber` behaves under different inputs.

#### Source

```DataWeave
%dw 2.0
import toRadixNumber from dw::core::Numbers
output application/json
---
{
    a: toRadixNumber(2, 2),
    b: toRadixNumber(255, 16)
}
```

#### Output

```JSON
{
  "a": "10",
  "b": "ff"
}
```

<!-- document id=236c780946377a46ab6d0fbc3365b7c9d000c994a523cb04d6266f173b21d7fe url=/mulesoft/current/en-us/dataweave/2.11/dw-coercions-functions-toregex.md -->

---
product: DataWeave
version: 2.11
---

# toRegex

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toRegex(str: String): Regex

Transforms a `String` value into a `Regex` value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>Regex</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toRegex` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  toRegexEx1: toRegex("a-Z"),
  toRegexEx2: toRegex("0-9+")
}
```

#### Output

```DataWeave
{
  toRegexEx1: /a-Z/,
  toRegexEx2: /0-9+/
}
```

<!-- document id=638625ce7dc5ed9c66b474fc5cf43e9d15dacd4c4e808766814963d37b11f34d url=/mulesoft/current/en-us/dataweave/2.12/dw-coercions-functions-toregex.md -->

---
product: DataWeave
version: 2.12
---

# toRegex

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toRegex(str: String): Regex

Transforms a `String` value into a `Regex` value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>Regex</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toRegex` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  toRegexEx1: toRegex("a-Z"),
  toRegexEx2: toRegex("0-9+")
}
```

#### Output

```DataWeave
{
  toRegexEx1: /a-Z/,
  toRegexEx2: /0-9+/
}
```

<!-- document id=c9bb3a4d0dcee088db06b91a6bc41e349a0ca486ade38e51c1f1955b628cc9cb url=/mulesoft/current/en-us/dataweave/2.4/dw-coercions-functions-toregex.md -->

---
product: DataWeave
version: 2.4
---

# toRegex

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toRegex(str: String): Regex

Transforms a `String` value into a `Regex` value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>Regex</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toRegex` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  toRegexEx1: toRegex("a-Z"),
  toRegexEx2: toRegex("0-9+")
}
```

#### Output

```DataWeave
{
  toRegexEx1: /a-Z/,
  toRegexEx2: /0-9+/
}
```

<!-- document id=a4b893d8051aa17970ac1776f948ce6a4d3dfcb2b396318950b8c151ba67544d url=/mulesoft/current/en-us/dataweave/2.6/dw-coercions-functions-toregex.md -->

---
product: DataWeave
version: 2.6
---

# toRegex

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toRegex(str: String): Regex

Transforms a `String` value into a `Regex` value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>Regex</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toRegex` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  toRegexEx1: toRegex("a-Z"),
  toRegexEx2: toRegex("0-9+")
}
```

#### Output

```DataWeave
{
  toRegexEx1: /a-Z/,
  toRegexEx2: /0-9+/
}
```

<!-- document id=975a4d7c0d23ec2ad8bf48482aaa0846c856391fb233037981076cd0919f6c79 url=/mulesoft/current/en-us/dataweave/2.9/dw-coercions-functions-toregex.md -->

---
product: DataWeave
version: 2.9
---

# toRegex

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toRegex(str: String): Regex

Transforms a `String` value into a `Regex` value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>Regex</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toRegex` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  toRegexEx1: toRegex("a-Z"),
  toRegexEx2: toRegex("0-9+")
}
```

#### Output

```DataWeave
{
  toRegexEx1: /a-Z/,
  toRegexEx2: /0-9+/
}
```

<!-- document id=13ab959db9c83c472adca5eeeb5ef5cb609a77b2ea8bf5796f877301cbb8157e url=/mulesoft/current/en-us/dataweave/latest/dw-coercions-functions-toregex.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# toRegex

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toRegex(str: String): Regex

Transforms a `String` value into a `Regex` value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>Regex</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toRegex` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  toRegexEx1: toRegex("a-Z"),
  toRegexEx2: toRegex("0-9+")
}
```

#### Output

```DataWeave
{
  toRegexEx1: /a-Z/,
  toRegexEx2: /0-9+/
}
```

<!-- document id=2f6965dc842fa13965eb1db5256edac4b2391adf7424d816b71713ccaa872271 url=/mulesoft/current/en-us/dataweave/2.11/dw-coercions-functions-tostring.md -->

---
product: DataWeave
version: 2.11
---

# toString

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toString(number: Number, format: String | Null = null, locale: String | Null = null, roundMode: RoundingMode | Null = null): String

A variant of `toString` that transforms a `Number` value (whole or decimal) into a `String` value
and accepts a format, locale, and rounding mode value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><div><div><p>The <code>Number</code> value to format.</p></div></div></td></tr><tr><td><p><code>format</code></p></td><td><div><div><p>The formatting to apply to the <code>Number</code> value. A <code>format</code> accepts <code>#</code> or <code>0</code> (but not both) as placeholders for <em>decimal</em> values, and only one decimal point is permitted. A <code>null</code> or empty <code>String</code> value has no effect on the <code>Number</code> value. Most other values are treated as literals, but you must escape special characters, such as a dollar sign (for example, <code>\$</code>). Inner quotations must be closed and differ from the surrounding quotations.</p></div></div></td></tr><tr><td><p><code>locale</code></p></td><td><div><div><p>Optional ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default. When you pass a translatable format, such as <code>eeee</code> and <code>MMMM</code>, a <code>locale</code> (such as <code>ES</code>) transforms the corresponding numeric values to a localized string.</p></div></div></td></tr><tr><td><p><code>roundMode</code></p></td><td><div><div><p>Optional parameter for rounding decimal values when the formatting presents a rounding choice, such as a format of <code>0.#</code> for the decimal <code>0.15</code>. The default is <code>HALF_UP</code>, and a <code>null</code> value behaves like <code>HALF_UP</code>. Only one of the following values is permitted:</p></div><div><ul><li><p><code>UP</code>: Always rounds away from zero (for example, <code>0.01</code> to <code>"0.1"</code> and <code>-0.01</code> to <code>"-0.1"</code>). Increments the preceding digit to a non-zero fraction and never decreases the magnitude of the calculated value.</p></li><li><p><code>DOWN</code>: Always rounds towards zero (for example, <code>0.19</code> to <code>"0.1"</code> and <code>-0.19</code> to <code>"-0.1"</code>). Never increments the digit before a discarded fraction (which truncates to the preceding digit) and never increases the magnitude of the calculated value.</p></li><li><p><code>CEILING</code>: Rounds towards positive infinity and behaves like <code>UP</code> if the result is positive (for example, <code>0.35</code> to <code>"0.4"</code>). If the result is negative, this mode behaves like <code>DOWN</code> (for example, <code>-0.35</code> to <code>"-0.3"</code>). This mode never decreases the calculated value.</p></li><li><p><code>FLOOR</code>: Rounds towards negative infinity and behaves like DOWN if the result is positive (for example, <code>0.35</code> to <code>"0.3"</code>). If the result is negative, this mode behaves like <code>UP</code> (for example, <code>-0.35</code> to <code>"-0.4"</code>). The mode never increases the calculated value.</p></li><li><p><code>HALF_UP</code>: Default mode, which rounds towards the nearest "neighbor" unless both neighbors are equidistant, in which case, this mode rounds up. For example, <code>0.35</code> rounds to <code>"0.4"</code>, <code>0.34</code> rounds to <code>"0.3"</code>, and <code>0.36</code> rounds to <code>"0.4"</code>. Negative decimals numbers round similarly. For example, <code>-0.35</code> rounds to `"-0.4`".</p></li><li><p><code>HALF_DOWN</code>: Rounds towards the nearest numeric "neighbor" unless both neighbors are equidistant, in which case, this mode rounds down. For example, <code>0.35</code> rounds to <code>"0.3"</code>, <code>0.34</code> rounds to <code>"0.3"</code>, and <code>0.36</code> rounds to <code>"0.4"</code>. Negative decimals numbers round similarly. For example, <code>-0.35</code> rounds to <code>"-0.3"</code>.</p></li><li><p><code>HALF_EVEN</code>: For decimals that end in a <code>5</code> (such as, <code>1.125</code> and <code>1.135</code>), the behavior depends on the number that precedes the <code>5</code>. <code>HALF_EVEN</code> rounds up when the next-to-last digit before the <code>5</code> is an odd number but rounds down when the next-to-last digit is even. For example, <code>0.225</code> rounds to <code>"0.22"</code>, <code>0.235</code> <em>and</em> <code>0.245</code> round to <code>"0.24"</code>, and <code>0.255</code> rounds to <code>"0.26"</code>. Negative decimals round similarly, for example, <code>-0.225</code> to <code>"-0.22"</code>. When the last digit is not <code>5</code>, the setting behaves like <code>HALF_UP</code>. Rounding of monetary values sometimes follows the <code>HALF_EVEN</code> pattern.</p></li></ul></div></div></td></tr></tbody></table>

### Example

This example shows how `toString` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
    a: toString(1.0),
    b: toString(0.005,".00"),
    c: toString(0.035,"#.##","ES"),
    d: toString(0.005,"#.##","ES","HALF_EVEN"),
    e: toString(0.035,"#.00",null,"HALF_EVEN"),
    f: toString(1.1234,"\$.## 'in my account'")
}
```

#### Output

```Json
{
  "a": "1",
  "b": ".01",
  "c": "0,04",
  "d": "0",
  "e": ".04",
  "f": "$1.12 in my account"
}
```

## toString(date: Date | DateTime | LocalDateTime | LocalTime | Time, format: String | Null = null, locale: String | Null = null): String

A variant of `toString` that transforms a `Date`, `DateTime`, `LocalTime`, `LocalDateTime`, or
`Time` value into a `String` value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><div><div><p>The <code>Date</code>, <code>DateTime</code>, <code>LocalTime</code>, <code>LocalDateTime</code>, or <code>Time</code> value to coerce to a <code>String</code> type.</p></div></div></td></tr><tr><td><p><code>format</code></p></td><td><div><div><p>The ISO-8601 formatting to use on the date or time. For example, this parameter accepts character patterns based on the Java 8 <code>java.time.format</code>. A <code>null</code> value has no effect on the value. Defaults:</p></div><div><ul><li><p><code>Date</code> example: <code>2011-12-03</code> (equivalent format: <code>uuuu-MM-dd</code>)</p></li><li><p><code>DateTime</code> example: <code>2011-12-03T10:15:30.000000+01:00</code> (equivalent format: <code>uuuu-MM-dd HH:mm:ssz</code>)</p></li><li><p><code>LocalDateTime</code> example: <code>2011-12-03T10:15:30.000000</code> (equivalent format: <code>uuuu-MM-dd HH:mm:ss</code>)</p></li><li><p><code>LocalTime</code> example: <code>10:15:30.000000</code> (equivalent format: <code>HH:mm:ss.n</code>)</p></li><li><p><code>Time</code> example: <code>10:15:30.000000Z</code> (equivalent format: <code>HH:mm:ss.nxxxz</code>)</p></li></ul></div></div></td></tr><tr><td><p><code>locale</code></p></td><td><div><div><p>Optional ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default. When you pass a translatable format, such as <code>eeee</code> and <code>MMMM</code>, a <code>locale</code> (such as <code>ES</code>) transforms the corresponding numeric values to a localized string.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `toString` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
   aDate: toString(|2003-10-01|, "uuuu/MM/dd"),
   aDateTime: toString(|2018-09-17T22:13:00-03:00|),
   aLocalTime: toString(|23:57:59|, "HH-mm-ss"),
   aLocalDateTime : toString(|2015-10-01T23:57:59|),
   aLocalDateTimeFormatted: toString(|2003-10-01T23:57:59|, "uuuu-MM-dd HH:mm:ss a"),
   aLocalDateTimeFormattedAndLocalizedSpain: toString(|2003-01-01T23:57:59|, "eeee, dd MMMM, uuuu HH:mm:ss a", "ES"),
   aTime: typeOf(|22:10:18Z|),
   aTimeZone: toString(|-03:00|)
}
```

#### Output

```Json
{
  "aDate": "2003/10/01",
  "aDateTime": "2018-09-17T22:13:00-03:00",
  "aLocalTime": "23-57-59",
  "aLocalDateTime": "2015-10-01T23:57:59",
  "aLocalDateTimeFormatted": "2003-10-01 23:57:59 PM",
  "aLocalDateTimeFormattedAndLocalizedSpain": "miércoles, 01 enero, 2003 23:57:59 p. m.",
  "aTime": "Time",
  "aTimeZone": "-03:00"
}
```

## toString(binary: Binary, encoding: String): String

A variant of `toString` that transforms a `Binary` value into a `String` value with the specified
encoding.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>binary</code></p></td><td><p>The <code>Binary</code> value to coerce to a <code>String</code> value.</p></td></tr><tr><td><p><code>encoding</code></p></td><td><p>The encoding to apply to the <code>String</code> value. Accepts encodings that are supported by your JDK. For example, <code>encoding</code> accepts Java canonical names and aliases for the basic and extended encoding sets in Oracle JDK 8 and JDK 11.</p></td></tr></tbody></table>

### Example

This example shows how `toString` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
var binaryData= "DW Test" as Binary {encoding: "UTF-32"}
output application/json
---
{
  a: toString(binaryData, "UTF-32"),
}
```

#### Output

```Json
{
  "a": "DW Test"
}
```

## toString(data: TimeZone | Uri | Boolean | Period | Regex | Key): String

A variant of `toString` that transforms a `TimeZone`, `Uri`, `Boolean`, `Period`, `Regex`, or `Key`
value into a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>data</code></p></td><td><p>The <code>TimeZone</code>, <code>Uri</code>, <code>Boolean</code>, <code>Period</code>, <code>Regex</code>, or <code>Key</code> value to coerce to a <code>String</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toString` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
  transformTimeZone: toString(|Z|),
  transformBoolean: toString(true),
  transformPeriod: toString(|P1D|),
  transformRegex: toString(/a-Z/),
  transformPeriod: toString(|PT8M10S|),
  transformUri: toString("https://docs.mulesoft.com/" as Uri)
}  ++
{ transformKey : toString((keysOf({ "aKeyToString" : "aValue"})[0])) }
```

#### Output

```Json
{
  "transformTimeZone": "Z",
  "transformBoolean": "true",
  "transformPeriod": "P1D",
  "transformRegex": "a-Z",
  "transformPeriod": "PT8M10S",
  "transformUri": "https://docs.mulesoft.com/",
  "transformKey": "aKeyToString"
}
```

## toString(arr: Array<String>): String

A variant of `toString` that joins an `Array` of characters into a single `String` value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>arr</code></p></td><td><p>The <code>Array</code> of characters to transform into a <code>String</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toString` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
  a: toString([]),
  b: toString(["h", "o", "l", "a"])
}
```

#### Output

```Json
{
  "a": "",
  "b": "hola"
}
```

<!-- document id=29249a07e17e8dc8716062edbf52c5db99639a367c3f9a5d0c72e15a4d72cedb url=/mulesoft/current/en-us/dataweave/2.11/dw-mime-functions-tostring.md -->

---
product: DataWeave
version: 2.11
---

# toString

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toString(mimeType: MimeType): String

Transforms a `MimeType` value to a string representation.

_Introduced in DataWeave version 2.7.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>mimeType</code></p></td><td><p><code>MimeType</code></p></td><td><p>The MIME type value to transform to a <code>String</code>.</p></td></tr></tbody></table>

### Example

This example transforms a `MimeType` value without `parameters` to a string representation.

#### Source

```DataWeave
%dw 2.0
import * from dw::module::Mime
output application/json
---
toString({'type': "application", subtype: "json", parameters: {}})
```

#### Output

```Json
"application/json"
```

### Example

This example transforms a `MimeType` value that includes a `parameters` to a string representation.

#### Source

```DataWeave
%dw 2.0
import * from dw::module::Mime
output application/json
---
toString({'type': "multipart", subtype: "form-data", parameters: {boundary: "my-boundary"}})
```

#### Output

```Json
"multipart/form-data;boundary=my-boundary"
```

<!-- document id=c21cc48031729ba298620cd86086b7f702aaa927192f8c3b658362264b86c754 url=/mulesoft/current/en-us/dataweave/2.12/dw-coercions-functions-tostring.md -->

---
product: DataWeave
version: 2.12
---

# toString

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toString(number: Number, format: String | Null = null, locale: String | Null = null, roundMode: RoundingMode | Null = null): String

A variant of `toString` that transforms a `Number` value (whole or decimal) into a `String` value
and accepts a format, locale, and rounding mode value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><div><div><p>The <code>Number</code> value to format.</p></div></div></td></tr><tr><td><p><code>format</code></p></td><td><div><div><p>The formatting to apply to the <code>Number</code> value. A <code>format</code> accepts <code>#</code> or <code>0</code> (but not both) as placeholders for <em>decimal</em> values, and only one decimal point is permitted. A <code>null</code> or empty <code>String</code> value has no effect on the <code>Number</code> value. Most other values are treated as literals, but you must escape special characters, such as a dollar sign (for example, <code>\$</code>). Inner quotations must be closed and differ from the surrounding quotations.</p></div></div></td></tr><tr><td><p><code>locale</code></p></td><td><div><div><p>Optional ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default. When you pass a translatable format, such as <code>eeee</code> and <code>MMMM</code>, a <code>locale</code> (such as <code>ES</code>) transforms the corresponding numeric values to a localized string.</p></div></div></td></tr><tr><td><p><code>roundMode</code></p></td><td><div><div><p>Optional parameter for rounding decimal values when the formatting presents a rounding choice, such as a format of <code>0.#</code> for the decimal <code>0.15</code>. The default is <code>HALF_UP</code>, and a <code>null</code> value behaves like <code>HALF_UP</code>. Only one of the following values is permitted:</p></div><div><ul><li><p><code>UP</code>: Always rounds away from zero (for example, <code>0.01</code> to <code>"0.1"</code> and <code>-0.01</code> to <code>"-0.1"</code>). Increments the preceding digit to a non-zero fraction and never decreases the magnitude of the calculated value.</p></li><li><p><code>DOWN</code>: Always rounds towards zero (for example, <code>0.19</code> to <code>"0.1"</code> and <code>-0.19</code> to <code>"-0.1"</code>). Never increments the digit before a discarded fraction (which truncates to the preceding digit) and never increases the magnitude of the calculated value.</p></li><li><p><code>CEILING</code>: Rounds towards positive infinity and behaves like <code>UP</code> if the result is positive (for example, <code>0.35</code> to <code>"0.4"</code>). If the result is negative, this mode behaves like <code>DOWN</code> (for example, <code>-0.35</code> to <code>"-0.3"</code>). This mode never decreases the calculated value.</p></li><li><p><code>FLOOR</code>: Rounds towards negative infinity and behaves like DOWN if the result is positive (for example, <code>0.35</code> to <code>"0.3"</code>). If the result is negative, this mode behaves like <code>UP</code> (for example, <code>-0.35</code> to <code>"-0.4"</code>). The mode never increases the calculated value.</p></li><li><p><code>HALF_UP</code>: Default mode, which rounds towards the nearest "neighbor" unless both neighbors are equidistant, in which case, this mode rounds up. For example, <code>0.35</code> rounds to <code>"0.4"</code>, <code>0.34</code> rounds to <code>"0.3"</code>, and <code>0.36</code> rounds to <code>"0.4"</code>. Negative decimals numbers round similarly. For example, <code>-0.35</code> rounds to `"-0.4`".</p></li><li><p><code>HALF_DOWN</code>: Rounds towards the nearest numeric "neighbor" unless both neighbors are equidistant, in which case, this mode rounds down. For example, <code>0.35</code> rounds to <code>"0.3"</code>, <code>0.34</code> rounds to <code>"0.3"</code>, and <code>0.36</code> rounds to <code>"0.4"</code>. Negative decimals numbers round similarly. For example, <code>-0.35</code> rounds to <code>"-0.3"</code>.</p></li><li><p><code>HALF_EVEN</code>: For decimals that end in a <code>5</code> (such as, <code>1.125</code> and <code>1.135</code>), the behavior depends on the number that precedes the <code>5</code>. <code>HALF_EVEN</code> rounds up when the next-to-last digit before the <code>5</code> is an odd number but rounds down when the next-to-last digit is even. For example, <code>0.225</code> rounds to <code>"0.22"</code>, <code>0.235</code> <em>and</em> <code>0.245</code> round to <code>"0.24"</code>, and <code>0.255</code> rounds to <code>"0.26"</code>. Negative decimals round similarly, for example, <code>-0.225</code> to <code>"-0.22"</code>. When the last digit is not <code>5</code>, the setting behaves like <code>HALF_UP</code>. Rounding of monetary values sometimes follows the <code>HALF_EVEN</code> pattern.</p></li></ul></div></div></td></tr></tbody></table>

### Example

This example shows how `toString` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
    a: toString(1.0),
    b: toString(0.005,".00"),
    c: toString(0.035,"#.##","ES"),
    d: toString(0.005,"#.##","ES","HALF_EVEN"),
    e: toString(0.035,"#.00",null,"HALF_EVEN"),
    f: toString(1.1234,"\$.## 'in my account'")
}
```

#### Output

```Json
{
  "a": "1",
  "b": ".01",
  "c": "0,04",
  "d": "0",
  "e": ".04",
  "f": "$1.12 in my account"
}
```

## toString(date: Date | DateTime | LocalDateTime | LocalTime | Time, format: String | Null = null, locale: String | Null = null): String

A variant of `toString` that transforms a `Date`, `DateTime`, `LocalTime`, `LocalDateTime`, or
`Time` value into a `String` value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><div><div><p>The <code>Date</code>, <code>DateTime</code>, <code>LocalTime</code>, <code>LocalDateTime</code>, or <code>Time</code> value to coerce to a <code>String</code> type.</p></div></div></td></tr><tr><td><p><code>format</code></p></td><td><div><div><p>The ISO-8601 formatting to use on the date or time. For example, this parameter accepts character patterns based on the Java 8 <code>java.time.format</code>. A <code>null</code> value has no effect on the value. Defaults:</p></div><div><ul><li><p><code>Date</code> example: <code>2011-12-03</code> (equivalent format: <code>uuuu-MM-dd</code>)</p></li><li><p><code>DateTime</code> example: <code>2011-12-03T10:15:30.000000+01:00</code> (equivalent format: <code>uuuu-MM-dd HH:mm:ssz</code>)</p></li><li><p><code>LocalDateTime</code> example: <code>2011-12-03T10:15:30.000000</code> (equivalent format: <code>uuuu-MM-dd HH:mm:ss</code>)</p></li><li><p><code>LocalTime</code> example: <code>10:15:30.000000</code> (equivalent format: <code>HH:mm:ss.n</code>)</p></li><li><p><code>Time</code> example: <code>10:15:30.000000Z</code> (equivalent format: <code>HH:mm:ss.nxxxz</code>)</p></li></ul></div></div></td></tr><tr><td><p><code>locale</code></p></td><td><div><div><p>Optional ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default. When you pass a translatable format, such as <code>eeee</code> and <code>MMMM</code>, a <code>locale</code> (such as <code>ES</code>) transforms the corresponding numeric values to a localized string.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `toString` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
   aDate: toString(|2003-10-01|, "uuuu/MM/dd"),
   aDateTime: toString(|2018-09-17T22:13:00-03:00|),
   aLocalTime: toString(|23:57:59|, "HH-mm-ss"),
   aLocalDateTime : toString(|2015-10-01T23:57:59|),
   aLocalDateTimeFormatted: toString(|2003-10-01T23:57:59|, "uuuu-MM-dd HH:mm:ss a"),
   aLocalDateTimeFormattedAndLocalizedSpain: toString(|2003-01-01T23:57:59|, "eeee, dd MMMM, uuuu HH:mm:ss a", "ES"),
   aTime: typeOf(|22:10:18Z|),
   aTimeZone: toString(|-03:00|)
}
```

#### Output

```Json
{
  "aDate": "2003/10/01",
  "aDateTime": "2018-09-17T22:13:00-03:00",
  "aLocalTime": "23-57-59",
  "aLocalDateTime": "2015-10-01T23:57:59",
  "aLocalDateTimeFormatted": "2003-10-01 23:57:59 PM",
  "aLocalDateTimeFormattedAndLocalizedSpain": "miércoles, 01 enero, 2003 23:57:59 p. m.",
  "aTime": "Time",
  "aTimeZone": "-03:00"
}
```

## toString(binary: Binary, encoding: String): String

A variant of `toString` that transforms a `Binary` value into a `String` value with the specified
encoding.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>binary</code></p></td><td><p>The <code>Binary</code> value to coerce to a <code>String</code> value.</p></td></tr><tr><td><p><code>encoding</code></p></td><td><p>The encoding to apply to the <code>String</code> value. Accepts encodings that are supported by your JDK. For example, <code>encoding</code> accepts Java canonical names and aliases for the basic and extended encoding sets in Oracle JDK 8 and JDK 11.</p></td></tr></tbody></table>

### Example

This example shows how `toString` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
var binaryData= "DW Test" as Binary {encoding: "UTF-32"}
output application/json
---
{
  a: toString(binaryData, "UTF-32"),
}
```

#### Output

```Json
{
  "a": "DW Test"
}
```

## toString(data: TimeZone | Uri | Boolean | Period | Regex | Key): String

A variant of `toString` that transforms a `TimeZone`, `Uri`, `Boolean`, `Period`, `Regex`, or `Key`
value into a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>data</code></p></td><td><p>The <code>TimeZone</code>, <code>Uri</code>, <code>Boolean</code>, <code>Period</code>, <code>Regex</code>, or <code>Key</code> value to coerce to a <code>String</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toString` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
  transformTimeZone: toString(|Z|),
  transformBoolean: toString(true),
  transformPeriod: toString(|P1D|),
  transformRegex: toString(/a-Z/),
  transformPeriod: toString(|PT8M10S|),
  transformUri: toString("https://docs.mulesoft.com/" as Uri)
}  ++
{ transformKey : toString((keysOf({ "aKeyToString" : "aValue"})[0])) }
```

#### Output

```Json
{
  "transformTimeZone": "Z",
  "transformBoolean": "true",
  "transformPeriod": "P1D",
  "transformRegex": "a-Z",
  "transformPeriod": "PT8M10S",
  "transformUri": "https://docs.mulesoft.com/",
  "transformKey": "aKeyToString"
}
```

## toString(arr: Array<String>): String

A variant of `toString` that joins an `Array` of characters into a single `String` value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>arr</code></p></td><td><p>The <code>Array</code> of characters to transform into a <code>String</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toString` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
  a: toString([]),
  b: toString(["h", "o", "l", "a"])
}
```

#### Output

```Json
{
  "a": "",
  "b": "hola"
}
```

<!-- document id=f867e3c42689baec983827978efa563d4d3544d627f254a62d0bdc7251ec5d1f url=/mulesoft/current/en-us/dataweave/2.12/dw-mime-functions-tostring.md -->

---
product: DataWeave
version: 2.12
---

# toString

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toString(mimeType: MimeType): String

Transforms a `MimeType` value to a string representation.

_Introduced in DataWeave version 2.7.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>mimeType</code></p></td><td><p><code>MimeType</code></p></td><td><p>The MIME type value to transform to a <code>String</code>.</p></td></tr></tbody></table>

### Example

This example transforms a `MimeType` value without `parameters` to a string representation.

#### Source

```DataWeave
%dw 2.0
import * from dw::module::Mime
output application/json
---
toString({'type': "application", subtype: "json", parameters: {}})
```

#### Output

```Json
"application/json"
```

### Example

This example transforms a `MimeType` value that includes a `parameters` to a string representation.

#### Source

```DataWeave
%dw 2.0
import * from dw::module::Mime
output application/json
---
toString({'type': "multipart", subtype: "form-data", parameters: {boundary: "my-boundary"}})
```

#### Output

```Json
"multipart/form-data;boundary=my-boundary"
```

<!-- document id=d14af35091d72b44ca297d91c4a89186c512bc81e7b59d9c6377545ad2b56209 url=/mulesoft/current/en-us/dataweave/2.4/dw-coercions-functions-tostring.md -->

---
product: DataWeave
version: 2.4
---

# toString

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toString(number: Number, format: String | Null = null, locale: String | Null = null, roundMode: RoundingMode | Null = null): String

A variant of `toString` that transforms a `Number` value (whole or decimal) into a `String` value
and accepts a format, locale, and rounding mode value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><div><div><p>The <code>Number</code> value to format.</p></div></div></td></tr><tr><td><p><code>format</code></p></td><td><div><div><p>The formatting to apply to the <code>Number</code> value. A <code>format</code> accepts <code>#</code> or <code>0</code> (but not both) as placeholders for <em>decimal</em> values, and only one decimal point is permitted. A <code>null</code> or empty <code>String</code> value has no effect on the <code>Number</code> value. Most other values are treated as literals, but you must escape special characters, such as a dollar sign (for example, <code>\$</code>). Inner quotations must be closed and differ from the surrounding quotations.</p></div></div></td></tr><tr><td><p><code>roundMode</code></p></td><td><div><div><p>Optional parameter for rounding decimal values when the formatting presents a rounding choice, such as a format of <code>0.#</code> for the decimal <code>0.15</code>. The default is <code>HALF_UP</code>, and a <code>null</code> value returns behaves like <code>HALF_UP</code>. Only one of the following values is permitted:</p></div><div><ul><li><p><code>UP</code>: Always rounds away from zero (for example, <code>0.01</code> to <code>"0.1"</code> and <code>-0.01</code> to <code>"-0.1"</code>). Increments the preceding digit to a non-zero fraction and never decreases the magnitude of the calculated value.</p></li><li><p><code>DOWN</code>: Always rounds towards zero (for example, <code>0.19</code> to <code>"0.1"</code> and <code>-0.19</code> to <code>"-0.1"</code>). Never increments the digit before a discarded fraction (which truncates to the preceding digit) and never increases the magnitude of the calculated value.</p></li><li><p><code>CEILING</code>: Rounds towards positive infinity and behaves like <code>UP</code> if the result is positive (for example, <code>0.35</code> to <code>"0.4"</code>). If the result is negative, this mode behaves like <code>DOWN</code> (for example, <code>-0.35</code> to <code>"-0.3"</code>). This mode never decreases the calculated value.</p></li><li><p><code>FLOOR</code>: Rounds towards negative infinity and behaves like DOWN if the result is positive (for example, <code>0.35</code> to <code>"0.3"</code>). If the result is negative, this mode behaves like <code>UP</code> (for example, <code>-0.35</code> to <code>"-0.4"</code>). The mode never increases the calculated value.</p></li><li><p><code>HALF_UP</code>: Default mode, which rounds towards the nearest "neighbor" unless both neighbors are equidistant, in which case, this mode rounds up. For example, <code>0.35</code> rounds to <code>"0.4"</code>, <code>0.34</code> rounds to <code>"0.3"</code>, and <code>0.36</code> rounds to <code>"0.4"</code>. Negative decimals numbers round similarly. For example, <code>-0.35</code> rounds to `"-0.4`".</p></li><li><p><code>HALF_DOWN</code>: Rounds towards the nearest numeric "neighbor" unless both neighbors are equidistant, in which case, this mode rounds down. For example, <code>0.35</code> rounds to <code>"0.3"</code>, <code>0.34</code> rounds to <code>"0.3"</code>, and <code>0.36</code> rounds to <code>"0.4"</code>. Negative decimals numbers round similarly. For example, <code>-0.35</code> rounds to <code>"-0.3"</code>.</p></li><li><p><code>HALF_EVEN</code>: For decimals that end in a <code>5</code> (such as, <code>1.125</code> and <code>1.135</code>), the behavior depends on the number that precedes the <code>5</code>. <code>HALF_EVEN</code> rounds up when the next-to-last digit before the <code>5</code> is an odd number but rounds down when the next-to-last digit is even. For example, <code>0.225</code> rounds to <code>"0.22"</code>, <code>0.235</code> <em>and</em> <code>0.245</code> round to <code>"0.24"</code>, and <code>0.255</code> rounds to <code>"0.26"</code>. Negative decimals round similarly, for example, <code>-0.225</code> to <code>"-0.22"</code>. When the last digit is not <code>5</code>, the setting behaves like <code>HALF_UP</code>. Rounding of monetary values sometimes follows the <code>HALF_EVEN</code> pattern.</p></li></ul></div></div></td></tr></tbody></table>

### Example

This example shows how `toString` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
    a: toString(1.0),
    b: toString(0.005,".00"),
    c: toString(0.035,"#.##","ES"),
    d: toString(0.005,"#.##","ES","HALF_EVEN"),
    e: toString(0.035,"#.00",null,"HALF_EVEN"),
    f: toString(1.1234,"\$.## 'in my account'")
}
```

#### Output

```Json
{
  "a": "1",
  "b": ".01",
  "c": "0,04",
  "d": "0",
  "e": ".04",
  "f": "$1.12 in my account"
}
```

## toString(date: Date | DateTime | LocalDateTime | LocalTime | Time, format: String | Null = null, locale: String | Null = null): String

A variant of `toString` that transforms a `Date`, `DateTime`, `LocalTime`, `LocalDateTime`, or
`Time` value into a `String` value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><div><div><p>The <code>Date</code>, <code>DateTime</code>, <code>LocalTime</code>, <code>LocalDateTime</code>, or <code>Time</code> value to coerce to a <code>String</code> type.</p></div></div></td></tr><tr><td><p><code>format</code></p></td><td><div><div><p>The ISO-8601 formatting to use on the date or time. For example, this parameter accepts character patterns based on the Java 8 <code>java.time.format</code>. A <code>null</code> value has no effect on the value. Defaults:</p></div><div><ul><li><p><code>Date</code> example: <code>2011-12-03</code> (equivalent format: <code>uuuu-MM-dd</code>)</p></li><li><p><code>DateTime</code> example: <code>2011-12-03T10:15:30.000000+01:00</code> (equivalent format: <code>uuuu-MM-dd HH:mm:ssz</code>)</p></li><li><p><code>LocalDateTime</code> example: <code>2011-12-03T10:15:30.000000</code> (equivalent format: <code>uuuu-MM-dd HH:mm:ss</code>)</p></li><li><p><code>LocalTime</code> example: <code>10:15:30.000000</code> (equivalent format: <code>HH:mm:ss.n</code>)</p></li><li><p><code>Time</code> example: <code>10:15:30.000000Z</code> (equivalent format: <code>HH:mm:ss.nxxxz</code>)</p></li></ul></div></div></td></tr><tr><td><p><code>locale</code></p></td><td><div><div><p>Optional ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default. When you pass a translatable format, such as <code>eeee</code> and <code>MMMM</code>, a <code>locale</code> (such as <code>"ES</code>) transforms the corresponding numeric values to a localized string.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `toString` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
   aDate: toString(|2003-10-01|, "uuuu/MM/dd"),
   aDateTime: toString(|2018-09-17T22:13:00-03:00|),
   aLocalTime: toString(|23:57:59|, "HH-mm-ss"),
   aLocalDateTime : toString(|2015-10-01T23:57:59|),
   aLocalDateTimeFormatted: toString(|2003-10-01T23:57:59|, "uuuu-MM-dd HH:mm:ss a"),
   aLocalDateTimeFormattedAndLocalizedSpain: toString(|2003-01-01T23:57:59|, "eeee, dd MMMM, uuuu HH:mm:ss a", "ES"),
   aTime: typeOf(|22:10:18Z|),
   aTimeZone: toString(|-03:00|)
}
```

#### Output

```Json
{
  "aDate": "2003/10/01",
  "aDateTime": "2018-09-17T22:13:00-03:00",
  "aLocalTime": "23-57-59",
  "aLocalDateTime": "2015-10-01T23:57:59",
  "aLocalDateTimeFormatted": "2003-10-01 23:57:59 PM",
  "aLocalDateTimeFormattedAndLocalizedSpain": "miércoles, 01 enero, 2003 23:57:59 p. m.",
  "aTime": "Time",
  "aTimeZone": "-03:00"
}
```

## toString(binary: Binary, encoding: String): String

A variant of `toString` that transforms a `Binary` value into a `String` value with the specified
encoding.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>binary</code></p></td><td><p>The <code>Binary</code> value to coerce to a <code>String</code> value.</p></td></tr><tr><td><p><code>encoding</code></p></td><td><p>The encoding to apply to the <code>String</code> value. Accepts encodings that are supported by your JDK. For example, <code>encoding</code> accepts Java canonical names and aliases for the basic and extended encoding sets in Oracle JDK 8 and JDK 11.</p></td></tr></tbody></table>

### Example

This example shows how `toString` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
var binaryData= "DW Test" as Binary {encoding: "UTF-32"}
output application/json
---
{
  a: toString(binaryData, "UTF-32"),
}
```

#### Output

```Json
{
  "a": "DW Test"
}
```

## toString(data: TimeZone | Uri | Boolean | Period | Regex | Key): String

A variant of `toString` that transforms a `TimeZone`, `Uri`, `Boolean`, `Period`, `Regex`, or `Key`
value into a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>data</code></p></td><td><p>The <code>TimeZone</code>, <code>Uri</code>, <code>Boolean</code>, <code>Period</code>, <code>Regex</code>, or <code>Key</code> value to coerce to a <code>String</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toString` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
  transformTimeZone: toString(|Z|),
  transformBoolean: toString(true),
  transformPeriod: toString(|P1D|),
  transformRegex: toString(/a-Z/),
  transformPeriod: toString(|PT8M10S|),
  transformUri: toString("https://docs.mulesoft.com/" as Uri)
}  ++
{ transformKey : toString((keysOf({ "aKeyToString" : "aValue"})[0])) }
```

#### Output

```Json
{
  "transformTimeZone": "Z",
  "transformBoolean": "true",
  "transformPeriod": "P1D",
  "transformRegex": "a-Z",
  "transformPeriod": "PT8M10S",
  "transformUri": "https://docs.mulesoft.com/",
  "transformKey": "aKeyToString"
}
```

## toString(arr: Array<String>): String

A variant of `toString` that joins an `Array` of characters into a single `String` value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>arr</code></p></td><td><p>The <code>Array</code> of characters to transform into a <code>String</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toString` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
  a: toString([]),
  b: toString(["h", "o", "l", "a"])
}
```

#### Output

```Json
{
  "a": "",
  "b": "hola"
}
```

<!-- document id=10dea4c35f091631088ba617c543a35206b8a62730352884744b6ea3dff12576 url=/mulesoft/current/en-us/dataweave/2.6/dw-coercions-functions-tostring.md -->

---
product: DataWeave
version: 2.6
---

# toString

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toString(number: Number, format: String | Null = null, locale: String | Null = null, roundMode: RoundingMode | Null = null): String

A variant of `toString` that transforms a `Number` value (whole or decimal) into a `String` value
and accepts a format, locale, and rounding mode value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><div><div><p>The <code>Number</code> value to format.</p></div></div></td></tr><tr><td><p><code>format</code></p></td><td><div><div><p>The formatting to apply to the <code>Number</code> value. A <code>format</code> accepts <code>#</code> or <code>0</code> (but not both) as placeholders for <em>decimal</em> values, and only one decimal point is permitted. A <code>null</code> or empty <code>String</code> value has no effect on the <code>Number</code> value. Most other values are treated as literals, but you must escape special characters, such as a dollar sign (for example, <code>\$</code>). Inner quotations must be closed and differ from the surrounding quotations.</p></div></div></td></tr><tr><td><p><code>locale</code></p></td><td><div><div><p>Optional ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default. When you pass a translatable format, such as <code>eeee</code> and <code>MMMM</code>, a <code>locale</code> (such as <code>"ES</code>) transforms the corresponding numeric values to a localized string.</p></div></div></td></tr><tr><td><p><code>roundMode</code></p></td><td><div><div><p>Optional parameter for rounding decimal values when the formatting presents a rounding choice, such as a format of <code>0.#</code> for the decimal <code>0.15</code>. The default is <code>HALF_UP</code>, and a <code>null</code> value behaves like <code>HALF_UP</code>. Only one of the following values is permitted:</p></div><div><ul><li><p><code>UP</code>: Always rounds away from zero (for example, <code>0.01</code> to <code>"0.1"</code> and <code>-0.01</code> to <code>"-0.1"</code>). Increments the preceding digit to a non-zero fraction and never decreases the magnitude of the calculated value.</p></li><li><p><code>DOWN</code>: Always rounds towards zero (for example, <code>0.19</code> to <code>"0.1"</code> and <code>-0.19</code> to <code>"-0.1"</code>). Never increments the digit before a discarded fraction (which truncates to the preceding digit) and never increases the magnitude of the calculated value.</p></li><li><p><code>CEILING</code>: Rounds towards positive infinity and behaves like <code>UP</code> if the result is positive (for example, <code>0.35</code> to <code>"0.4"</code>). If the result is negative, this mode behaves like <code>DOWN</code> (for example, <code>-0.35</code> to <code>"-0.3"</code>). This mode never decreases the calculated value.</p></li><li><p><code>FLOOR</code>: Rounds towards negative infinity and behaves like DOWN if the result is positive (for example, <code>0.35</code> to <code>"0.3"</code>). If the result is negative, this mode behaves like <code>UP</code> (for example, <code>-0.35</code> to <code>"-0.4"</code>). The mode never increases the calculated value.</p></li><li><p><code>HALF_UP</code>: Default mode, which rounds towards the nearest "neighbor" unless both neighbors are equidistant, in which case, this mode rounds up. For example, <code>0.35</code> rounds to <code>"0.4"</code>, <code>0.34</code> rounds to <code>"0.3"</code>, and <code>0.36</code> rounds to <code>"0.4"</code>. Negative decimals numbers round similarly. For example, <code>-0.35</code> rounds to `"-0.4`".</p></li><li><p><code>HALF_DOWN</code>: Rounds towards the nearest numeric "neighbor" unless both neighbors are equidistant, in which case, this mode rounds down. For example, <code>0.35</code> rounds to <code>"0.3"</code>, <code>0.34</code> rounds to <code>"0.3"</code>, and <code>0.36</code> rounds to <code>"0.4"</code>. Negative decimals numbers round similarly. For example, <code>-0.35</code> rounds to <code>"-0.3"</code>.</p></li><li><p><code>HALF_EVEN</code>: For decimals that end in a <code>5</code> (such as, <code>1.125</code> and <code>1.135</code>), the behavior depends on the number that precedes the <code>5</code>. <code>HALF_EVEN</code> rounds up when the next-to-last digit before the <code>5</code> is an odd number but rounds down when the next-to-last digit is even. For example, <code>0.225</code> rounds to <code>"0.22"</code>, <code>0.235</code> <em>and</em> <code>0.245</code> round to <code>"0.24"</code>, and <code>0.255</code> rounds to <code>"0.26"</code>. Negative decimals round similarly, for example, <code>-0.225</code> to <code>"-0.22"</code>. When the last digit is not <code>5</code>, the setting behaves like <code>HALF_UP</code>. Rounding of monetary values sometimes follows the <code>HALF_EVEN</code> pattern.</p></li></ul></div></div></td></tr></tbody></table>

### Example

This example shows how `toString` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
    a: toString(1.0),
    b: toString(0.005,".00"),
    c: toString(0.035,"#.##","ES"),
    d: toString(0.005,"#.##","ES","HALF_EVEN"),
    e: toString(0.035,"#.00",null,"HALF_EVEN"),
    f: toString(1.1234,"\$.## 'in my account'")
}
```

#### Output

```Json
{
  "a": "1",
  "b": ".01",
  "c": "0,04",
  "d": "0",
  "e": ".04",
  "f": "$1.12 in my account"
}
```

## toString(date: Date | DateTime | LocalDateTime | LocalTime | Time, format: String | Null = null, locale: String | Null = null): String

A variant of `toString` that transforms a `Date`, `DateTime`, `LocalTime`, `LocalDateTime`, or
`Time` value into a `String` value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><div><div><p>The <code>Date</code>, <code>DateTime</code>, <code>LocalTime</code>, <code>LocalDateTime</code>, or <code>Time</code> value to coerce to a <code>String</code> type.</p></div></div></td></tr><tr><td><p><code>format</code></p></td><td><div><div><p>The ISO-8601 formatting to use on the date or time. For example, this parameter accepts character patterns based on the Java 8 <code>java.time.format</code>. A <code>null</code> value has no effect on the value. Defaults:</p></div><div><ul><li><p><code>Date</code> example: <code>2011-12-03</code> (equivalent format: <code>uuuu-MM-dd</code>)</p></li><li><p><code>DateTime</code> example: <code>2011-12-03T10:15:30.000000+01:00</code> (equivalent format: <code>uuuu-MM-dd HH:mm:ssz</code>)</p></li><li><p><code>LocalDateTime</code> example: <code>2011-12-03T10:15:30.000000</code> (equivalent format: <code>uuuu-MM-dd HH:mm:ss</code>)</p></li><li><p><code>LocalTime</code> example: <code>10:15:30.000000</code> (equivalent format: <code>HH:mm:ss.n</code>)</p></li><li><p><code>Time</code> example: <code>10:15:30.000000Z</code> (equivalent format: <code>HH:mm:ss.nxxxz</code>)</p></li></ul></div></div></td></tr><tr><td><p><code>locale</code></p></td><td><div><div><p>Optional ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default. When you pass a translatable format, such as <code>eeee</code> and <code>MMMM</code>, a <code>locale</code> (such as <code>"ES</code>) transforms the corresponding numeric values to a localized string.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `toString` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
   aDate: toString(|2003-10-01|, "uuuu/MM/dd"),
   aDateTime: toString(|2018-09-17T22:13:00-03:00|),
   aLocalTime: toString(|23:57:59|, "HH-mm-ss"),
   aLocalDateTime : toString(|2015-10-01T23:57:59|),
   aLocalDateTimeFormatted: toString(|2003-10-01T23:57:59|, "uuuu-MM-dd HH:mm:ss a"),
   aLocalDateTimeFormattedAndLocalizedSpain: toString(|2003-01-01T23:57:59|, "eeee, dd MMMM, uuuu HH:mm:ss a", "ES"),
   aTime: typeOf(|22:10:18Z|),
   aTimeZone: toString(|-03:00|)
}
```

#### Output

```Json
{
  "aDate": "2003/10/01",
  "aDateTime": "2018-09-17T22:13:00-03:00",
  "aLocalTime": "23-57-59",
  "aLocalDateTime": "2015-10-01T23:57:59",
  "aLocalDateTimeFormatted": "2003-10-01 23:57:59 PM",
  "aLocalDateTimeFormattedAndLocalizedSpain": "miércoles, 01 enero, 2003 23:57:59 p. m.",
  "aTime": "Time",
  "aTimeZone": "-03:00"
}
```

## toString(binary: Binary, encoding: String): String

A variant of `toString` that transforms a `Binary` value into a `String` value with the specified
encoding.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>binary</code></p></td><td><p>The <code>Binary</code> value to coerce to a <code>String</code> value.</p></td></tr><tr><td><p><code>encoding</code></p></td><td><p>The encoding to apply to the <code>String</code> value. Accepts encodings that are supported by your JDK. For example, <code>encoding</code> accepts Java canonical names and aliases for the basic and extended encoding sets in Oracle JDK 8 and JDK 11.</p></td></tr></tbody></table>

### Example

This example shows how `toString` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
var binaryData= "DW Test" as Binary {encoding: "UTF-32"}
output application/json
---
{
  a: toString(binaryData, "UTF-32"),
}
```

#### Output

```Json
{
  "a": "DW Test"
}
```

## toString(data: TimeZone | Uri | Boolean | Period | Regex | Key): String

A variant of `toString` that transforms a `TimeZone`, `Uri`, `Boolean`, `Period`, `Regex`, or `Key`
value into a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>data</code></p></td><td><p>The <code>TimeZone</code>, <code>Uri</code>, <code>Boolean</code>, <code>Period</code>, <code>Regex</code>, or <code>Key</code> value to coerce to a <code>String</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toString` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
  transformTimeZone: toString(|Z|),
  transformBoolean: toString(true),
  transformPeriod: toString(|P1D|),
  transformRegex: toString(/a-Z/),
  transformPeriod: toString(|PT8M10S|),
  transformUri: toString("https://docs.mulesoft.com/" as Uri)
}  ++
{ transformKey : toString((keysOf({ "aKeyToString" : "aValue"})[0])) }
```

#### Output

```Json
{
  "transformTimeZone": "Z",
  "transformBoolean": "true",
  "transformPeriod": "P1D",
  "transformRegex": "a-Z",
  "transformPeriod": "PT8M10S",
  "transformUri": "https://docs.mulesoft.com/",
  "transformKey": "aKeyToString"
}
```

## toString(arr: Array<String>): String

A variant of `toString` that joins an `Array` of characters into a single `String` value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>arr</code></p></td><td><p>The <code>Array</code> of characters to transform into a <code>String</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toString` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
  a: toString([]),
  b: toString(["h", "o", "l", "a"])
}
```

#### Output

```Json
{
  "a": "",
  "b": "hola"
}
```

<!-- document id=c40389861c603b145ba5951de92ea4707b89878df6d841b7824ae126f0cf161f url=/mulesoft/current/en-us/dataweave/2.9/dw-coercions-functions-tostring.md -->

---
product: DataWeave
version: 2.9
---

# toString

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toString(number: Number, format: String | Null = null, locale: String | Null = null, roundMode: RoundingMode | Null = null): String

A variant of `toString` that transforms a `Number` value (whole or decimal) into a `String` value
and accepts a format, locale, and rounding mode value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><div><div><p>The <code>Number</code> value to format.</p></div></div></td></tr><tr><td><p><code>format</code></p></td><td><div><div><p>The formatting to apply to the <code>Number</code> value. A <code>format</code> accepts <code>#</code> or <code>0</code> (but not both) as placeholders for <em>decimal</em> values, and only one decimal point is permitted. A <code>null</code> or empty <code>String</code> value has no effect on the <code>Number</code> value. Most other values are treated as literals, but you must escape special characters, such as a dollar sign (for example, <code>\$</code>). Inner quotations must be closed and differ from the surrounding quotations.</p></div></div></td></tr><tr><td><p><code>locale</code></p></td><td><div><div><p>Optional ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default. When you pass a translatable format, such as <code>eeee</code> and <code>MMMM</code>, a <code>locale</code> (such as <code>ES</code>) transforms the corresponding numeric values to a localized string.</p></div></div></td></tr><tr><td><p><code>roundMode</code></p></td><td><div><div><p>Optional parameter for rounding decimal values when the formatting presents a rounding choice, such as a format of <code>0.#</code> for the decimal <code>0.15</code>. The default is <code>HALF_UP</code>, and a <code>null</code> value behaves like <code>HALF_UP</code>. Only one of the following values is permitted:</p></div><div><ul><li><p><code>UP</code>: Always rounds away from zero (for example, <code>0.01</code> to <code>"0.1"</code> and <code>-0.01</code> to <code>"-0.1"</code>). Increments the preceding digit to a non-zero fraction and never decreases the magnitude of the calculated value.</p></li><li><p><code>DOWN</code>: Always rounds towards zero (for example, <code>0.19</code> to <code>"0.1"</code> and <code>-0.19</code> to <code>"-0.1"</code>). Never increments the digit before a discarded fraction (which truncates to the preceding digit) and never increases the magnitude of the calculated value.</p></li><li><p><code>CEILING</code>: Rounds towards positive infinity and behaves like <code>UP</code> if the result is positive (for example, <code>0.35</code> to <code>"0.4"</code>). If the result is negative, this mode behaves like <code>DOWN</code> (for example, <code>-0.35</code> to <code>"-0.3"</code>). This mode never decreases the calculated value.</p></li><li><p><code>FLOOR</code>: Rounds towards negative infinity and behaves like DOWN if the result is positive (for example, <code>0.35</code> to <code>"0.3"</code>). If the result is negative, this mode behaves like <code>UP</code> (for example, <code>-0.35</code> to <code>"-0.4"</code>). The mode never increases the calculated value.</p></li><li><p><code>HALF_UP</code>: Default mode, which rounds towards the nearest "neighbor" unless both neighbors are equidistant, in which case, this mode rounds up. For example, <code>0.35</code> rounds to <code>"0.4"</code>, <code>0.34</code> rounds to <code>"0.3"</code>, and <code>0.36</code> rounds to <code>"0.4"</code>. Negative decimals numbers round similarly. For example, <code>-0.35</code> rounds to `"-0.4`".</p></li><li><p><code>HALF_DOWN</code>: Rounds towards the nearest numeric "neighbor" unless both neighbors are equidistant, in which case, this mode rounds down. For example, <code>0.35</code> rounds to <code>"0.3"</code>, <code>0.34</code> rounds to <code>"0.3"</code>, and <code>0.36</code> rounds to <code>"0.4"</code>. Negative decimals numbers round similarly. For example, <code>-0.35</code> rounds to <code>"-0.3"</code>.</p></li><li><p><code>HALF_EVEN</code>: For decimals that end in a <code>5</code> (such as, <code>1.125</code> and <code>1.135</code>), the behavior depends on the number that precedes the <code>5</code>. <code>HALF_EVEN</code> rounds up when the next-to-last digit before the <code>5</code> is an odd number but rounds down when the next-to-last digit is even. For example, <code>0.225</code> rounds to <code>"0.22"</code>, <code>0.235</code> <em>and</em> <code>0.245</code> round to <code>"0.24"</code>, and <code>0.255</code> rounds to <code>"0.26"</code>. Negative decimals round similarly, for example, <code>-0.225</code> to <code>"-0.22"</code>. When the last digit is not <code>5</code>, the setting behaves like <code>HALF_UP</code>. Rounding of monetary values sometimes follows the <code>HALF_EVEN</code> pattern.</p></li></ul></div></div></td></tr></tbody></table>

### Example

This example shows how `toString` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
    a: toString(1.0),
    b: toString(0.005,".00"),
    c: toString(0.035,"#.##","ES"),
    d: toString(0.005,"#.##","ES","HALF_EVEN"),
    e: toString(0.035,"#.00",null,"HALF_EVEN"),
    f: toString(1.1234,"\$.## 'in my account'")
}
```

#### Output

```Json
{
  "a": "1",
  "b": ".01",
  "c": "0,04",
  "d": "0",
  "e": ".04",
  "f": "$1.12 in my account"
}
```

## toString(date: Date | DateTime | LocalDateTime | LocalTime | Time, format: String | Null = null, locale: String | Null = null): String

A variant of `toString` that transforms a `Date`, `DateTime`, `LocalTime`, `LocalDateTime`, or
`Time` value into a `String` value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><div><div><p>The <code>Date</code>, <code>DateTime</code>, <code>LocalTime</code>, <code>LocalDateTime</code>, or <code>Time</code> value to coerce to a <code>String</code> type.</p></div></div></td></tr><tr><td><p><code>format</code></p></td><td><div><div><p>The ISO-8601 formatting to use on the date or time. For example, this parameter accepts character patterns based on the Java 8 <code>java.time.format</code>. A <code>null</code> value has no effect on the value. Defaults:</p></div><div><ul><li><p><code>Date</code> example: <code>2011-12-03</code> (equivalent format: <code>uuuu-MM-dd</code>)</p></li><li><p><code>DateTime</code> example: <code>2011-12-03T10:15:30.000000+01:00</code> (equivalent format: <code>uuuu-MM-dd HH:mm:ssz</code>)</p></li><li><p><code>LocalDateTime</code> example: <code>2011-12-03T10:15:30.000000</code> (equivalent format: <code>uuuu-MM-dd HH:mm:ss</code>)</p></li><li><p><code>LocalTime</code> example: <code>10:15:30.000000</code> (equivalent format: <code>HH:mm:ss.n</code>)</p></li><li><p><code>Time</code> example: <code>10:15:30.000000Z</code> (equivalent format: <code>HH:mm:ss.nxxxz</code>)</p></li></ul></div></div></td></tr><tr><td><p><code>locale</code></p></td><td><div><div><p>Optional ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default. When you pass a translatable format, such as <code>eeee</code> and <code>MMMM</code>, a <code>locale</code> (such as <code>ES</code>) transforms the corresponding numeric values to a localized string.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `toString` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
   aDate: toString(|2003-10-01|, "uuuu/MM/dd"),
   aDateTime: toString(|2018-09-17T22:13:00-03:00|),
   aLocalTime: toString(|23:57:59|, "HH-mm-ss"),
   aLocalDateTime : toString(|2015-10-01T23:57:59|),
   aLocalDateTimeFormatted: toString(|2003-10-01T23:57:59|, "uuuu-MM-dd HH:mm:ss a"),
   aLocalDateTimeFormattedAndLocalizedSpain: toString(|2003-01-01T23:57:59|, "eeee, dd MMMM, uuuu HH:mm:ss a", "ES"),
   aTime: typeOf(|22:10:18Z|),
   aTimeZone: toString(|-03:00|)
}
```

#### Output

```Json
{
  "aDate": "2003/10/01",
  "aDateTime": "2018-09-17T22:13:00-03:00",
  "aLocalTime": "23-57-59",
  "aLocalDateTime": "2015-10-01T23:57:59",
  "aLocalDateTimeFormatted": "2003-10-01 23:57:59 PM",
  "aLocalDateTimeFormattedAndLocalizedSpain": "miércoles, 01 enero, 2003 23:57:59 p. m.",
  "aTime": "Time",
  "aTimeZone": "-03:00"
}
```

## toString(binary: Binary, encoding: String): String

A variant of `toString` that transforms a `Binary` value into a `String` value with the specified
encoding.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>binary</code></p></td><td><p>The <code>Binary</code> value to coerce to a <code>String</code> value.</p></td></tr><tr><td><p><code>encoding</code></p></td><td><p>The encoding to apply to the <code>String</code> value. Accepts encodings that are supported by your JDK. For example, <code>encoding</code> accepts Java canonical names and aliases for the basic and extended encoding sets in Oracle JDK 8 and JDK 11.</p></td></tr></tbody></table>

### Example

This example shows how `toString` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
var binaryData= "DW Test" as Binary {encoding: "UTF-32"}
output application/json
---
{
  a: toString(binaryData, "UTF-32"),
}
```

#### Output

```Json
{
  "a": "DW Test"
}
```

## toString(data: TimeZone | Uri | Boolean | Period | Regex | Key): String

A variant of `toString` that transforms a `TimeZone`, `Uri`, `Boolean`, `Period`, `Regex`, or `Key`
value into a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>data</code></p></td><td><p>The <code>TimeZone</code>, <code>Uri</code>, <code>Boolean</code>, <code>Period</code>, <code>Regex</code>, or <code>Key</code> value to coerce to a <code>String</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toString` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
  transformTimeZone: toString(|Z|),
  transformBoolean: toString(true),
  transformPeriod: toString(|P1D|),
  transformRegex: toString(/a-Z/),
  transformPeriod: toString(|PT8M10S|),
  transformUri: toString("https://docs.mulesoft.com/" as Uri)
}  ++
{ transformKey : toString((keysOf({ "aKeyToString" : "aValue"})[0])) }
```

#### Output

```Json
{
  "transformTimeZone": "Z",
  "transformBoolean": "true",
  "transformPeriod": "P1D",
  "transformRegex": "a-Z",
  "transformPeriod": "PT8M10S",
  "transformUri": "https://docs.mulesoft.com/",
  "transformKey": "aKeyToString"
}
```

## toString(arr: Array<String>): String

A variant of `toString` that joins an `Array` of characters into a single `String` value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>arr</code></p></td><td><p>The <code>Array</code> of characters to transform into a <code>String</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toString` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
  a: toString([]),
  b: toString(["h", "o", "l", "a"])
}
```

#### Output

```Json
{
  "a": "",
  "b": "hola"
}
```

<!-- document id=90fc7c8cfb08041137d4bc4ed269f9bff1d4e8718bf2076604919d35274a359a url=/mulesoft/current/en-us/dataweave/2.9/dw-mime-functions-tostring.md -->

---
product: DataWeave
version: 2.9
---

# toString

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toString(mimeType: MimeType): String

Transforms a `MimeType` value to a string representation.

_Introduced in DataWeave version 2.7.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>mimeType</code></p></td><td><p><code>MimeType</code></p></td><td><p>The MIME type value to transform to a <code>String</code>.</p></td></tr></tbody></table>

### Example

This example transforms a `MimeType` value without `parameters` to a string representation.

#### Source

```DataWeave
%dw 2.0
import * from dw::module::Mime
output application/json
---
toString({'type': "application", subtype: "json", parameters: {}})
```

#### Output

```Json
"application/json"
```

### Example

This example transforms a `MimeType` value that includes a `parameters` to a string representation.

#### Source

```DataWeave
%dw 2.0
import * from dw::module::Mime
output application/json
---
toString({'type': "multipart", subtype: "form-data", parameters: {boundary: "my-boundary"}})
```

#### Output

```Json
"multipart/form-data;boundary=my-boundary"
```

<!-- document id=a7f7bf5972f42b821e7f7a448e0f9ad407f2ce783a1d12348eda437c5ba2f551 url=/mulesoft/current/en-us/dataweave/latest/dw-coercions-functions-tostring.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# toString

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toString(number: Number, format: String | Null = null, locale: String | Null = null, roundMode: RoundingMode | Null = null): String

A variant of `toString` that transforms a `Number` value (whole or decimal) into a `String` value
and accepts a format, locale, and rounding mode value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>number</code></p></td><td><div><div><p>The <code>Number</code> value to format.</p></div></div></td></tr><tr><td><p><code>format</code></p></td><td><div><div><p>The formatting to apply to the <code>Number</code> value. A <code>format</code> accepts <code>#</code> or <code>0</code> (but not both) as placeholders for <em>decimal</em> values, and only one decimal point is permitted. A <code>null</code> or empty <code>String</code> value has no effect on the <code>Number</code> value. Most other values are treated as literals, but you must escape special characters, such as a dollar sign (for example, <code>\$</code>). Inner quotations must be closed and differ from the surrounding quotations.</p></div></div></td></tr><tr><td><p><code>locale</code></p></td><td><div><div><p>Optional ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default. When you pass a translatable format, such as <code>eeee</code> and <code>MMMM</code>, a <code>locale</code> (such as <code>ES</code>) transforms the corresponding numeric values to a localized string.</p></div></div></td></tr><tr><td><p><code>roundMode</code></p></td><td><div><div><p>Optional parameter for rounding decimal values when the formatting presents a rounding choice, such as a format of <code>0.#</code> for the decimal <code>0.15</code>. The default is <code>HALF_UP</code>, and a <code>null</code> value behaves like <code>HALF_UP</code>. Only one of the following values is permitted:</p></div><div><ul><li><p><code>UP</code>: Always rounds away from zero (for example, <code>0.01</code> to <code>"0.1"</code> and <code>-0.01</code> to <code>"-0.1"</code>). Increments the preceding digit to a non-zero fraction and never decreases the magnitude of the calculated value.</p></li><li><p><code>DOWN</code>: Always rounds towards zero (for example, <code>0.19</code> to <code>"0.1"</code> and <code>-0.19</code> to <code>"-0.1"</code>). Never increments the digit before a discarded fraction (which truncates to the preceding digit) and never increases the magnitude of the calculated value.</p></li><li><p><code>CEILING</code>: Rounds towards positive infinity and behaves like <code>UP</code> if the result is positive (for example, <code>0.35</code> to <code>"0.4"</code>). If the result is negative, this mode behaves like <code>DOWN</code> (for example, <code>-0.35</code> to <code>"-0.3"</code>). This mode never decreases the calculated value.</p></li><li><p><code>FLOOR</code>: Rounds towards negative infinity and behaves like DOWN if the result is positive (for example, <code>0.35</code> to <code>"0.3"</code>). If the result is negative, this mode behaves like <code>UP</code> (for example, <code>-0.35</code> to <code>"-0.4"</code>). The mode never increases the calculated value.</p></li><li><p><code>HALF_UP</code>: Default mode, which rounds towards the nearest "neighbor" unless both neighbors are equidistant, in which case, this mode rounds up. For example, <code>0.35</code> rounds to <code>"0.4"</code>, <code>0.34</code> rounds to <code>"0.3"</code>, and <code>0.36</code> rounds to <code>"0.4"</code>. Negative decimals numbers round similarly. For example, <code>-0.35</code> rounds to `"-0.4`".</p></li><li><p><code>HALF_DOWN</code>: Rounds towards the nearest numeric "neighbor" unless both neighbors are equidistant, in which case, this mode rounds down. For example, <code>0.35</code> rounds to <code>"0.3"</code>, <code>0.34</code> rounds to <code>"0.3"</code>, and <code>0.36</code> rounds to <code>"0.4"</code>. Negative decimals numbers round similarly. For example, <code>-0.35</code> rounds to <code>"-0.3"</code>.</p></li><li><p><code>HALF_EVEN</code>: For decimals that end in a <code>5</code> (such as, <code>1.125</code> and <code>1.135</code>), the behavior depends on the number that precedes the <code>5</code>. <code>HALF_EVEN</code> rounds up when the next-to-last digit before the <code>5</code> is an odd number but rounds down when the next-to-last digit is even. For example, <code>0.225</code> rounds to <code>"0.22"</code>, <code>0.235</code> <em>and</em> <code>0.245</code> round to <code>"0.24"</code>, and <code>0.255</code> rounds to <code>"0.26"</code>. Negative decimals round similarly, for example, <code>-0.225</code> to <code>"-0.22"</code>. When the last digit is not <code>5</code>, the setting behaves like <code>HALF_UP</code>. Rounding of monetary values sometimes follows the <code>HALF_EVEN</code> pattern.</p></li></ul></div></div></td></tr></tbody></table>

### Example

This example shows how `toString` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
    a: toString(1.0),
    b: toString(0.005,".00"),
    c: toString(0.035,"#.##","ES"),
    d: toString(0.005,"#.##","ES","HALF_EVEN"),
    e: toString(0.035,"#.00",null,"HALF_EVEN"),
    f: toString(1.1234,"\$.## 'in my account'")
}
```

#### Output

```Json
{
  "a": "1",
  "b": ".01",
  "c": "0,04",
  "d": "0",
  "e": ".04",
  "f": "$1.12 in my account"
}
```

## toString(date: Date | DateTime | LocalDateTime | LocalTime | Time, format: String | Null = null, locale: String | Null = null): String

A variant of `toString` that transforms a `Date`, `DateTime`, `LocalTime`, `LocalDateTime`, or
`Time` value into a `String` value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>date</code></p></td><td><div><div><p>The <code>Date</code>, <code>DateTime</code>, <code>LocalTime</code>, <code>LocalDateTime</code>, or <code>Time</code> value to coerce to a <code>String</code> type.</p></div></div></td></tr><tr><td><p><code>format</code></p></td><td><div><div><p>The ISO-8601 formatting to use on the date or time. For example, this parameter accepts character patterns based on the Java 8 <code>java.time.format</code>. A <code>null</code> value has no effect on the value. Defaults:</p></div><div><ul><li><p><code>Date</code> example: <code>2011-12-03</code> (equivalent format: <code>uuuu-MM-dd</code>)</p></li><li><p><code>DateTime</code> example: <code>2011-12-03T10:15:30.000000+01:00</code> (equivalent format: <code>uuuu-MM-dd HH:mm:ssz</code>)</p></li><li><p><code>LocalDateTime</code> example: <code>2011-12-03T10:15:30.000000</code> (equivalent format: <code>uuuu-MM-dd HH:mm:ss</code>)</p></li><li><p><code>LocalTime</code> example: <code>10:15:30.000000</code> (equivalent format: <code>HH:mm:ss.n</code>)</p></li><li><p><code>Time</code> example: <code>10:15:30.000000Z</code> (equivalent format: <code>HH:mm:ss.nxxxz</code>)</p></li></ul></div></div></td></tr><tr><td><p><code>locale</code></p></td><td><div><div><p>Optional ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default. When you pass a translatable format, such as <code>eeee</code> and <code>MMMM</code>, a <code>locale</code> (such as <code>ES</code>) transforms the corresponding numeric values to a localized string.</p></div></div></td></tr></tbody></table>

### Example

This example shows how `toString` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
   aDate: toString(|2003-10-01|, "uuuu/MM/dd"),
   aDateTime: toString(|2018-09-17T22:13:00-03:00|),
   aLocalTime: toString(|23:57:59|, "HH-mm-ss"),
   aLocalDateTime : toString(|2015-10-01T23:57:59|),
   aLocalDateTimeFormatted: toString(|2003-10-01T23:57:59|, "uuuu-MM-dd HH:mm:ss a"),
   aLocalDateTimeFormattedAndLocalizedSpain: toString(|2003-01-01T23:57:59|, "eeee, dd MMMM, uuuu HH:mm:ss a", "ES"),
   aTime: typeOf(|22:10:18Z|),
   aTimeZone: toString(|-03:00|)
}
```

#### Output

```Json
{
  "aDate": "2003/10/01",
  "aDateTime": "2018-09-17T22:13:00-03:00",
  "aLocalTime": "23-57-59",
  "aLocalDateTime": "2015-10-01T23:57:59",
  "aLocalDateTimeFormatted": "2003-10-01 23:57:59 PM",
  "aLocalDateTimeFormattedAndLocalizedSpain": "miércoles, 01 enero, 2003 23:57:59 p. m.",
  "aTime": "Time",
  "aTimeZone": "-03:00"
}
```

## toString(binary: Binary, encoding: String): String

A variant of `toString` that transforms a `Binary` value into a `String` value with the specified
encoding.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>binary</code></p></td><td><p>The <code>Binary</code> value to coerce to a <code>String</code> value.</p></td></tr><tr><td><p><code>encoding</code></p></td><td><p>The encoding to apply to the <code>String</code> value. Accepts encodings that are supported by your JDK. For example, <code>encoding</code> accepts Java canonical names and aliases for the basic and extended encoding sets in Oracle JDK 8 and JDK 11.</p></td></tr></tbody></table>

### Example

This example shows how `toString` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
var binaryData= "DW Test" as Binary {encoding: "UTF-32"}
output application/json
---
{
  a: toString(binaryData, "UTF-32"),
}
```

#### Output

```Json
{
  "a": "DW Test"
}
```

## toString(data: TimeZone | Uri | Boolean | Period | Regex | Key): String

A variant of `toString` that transforms a `TimeZone`, `Uri`, `Boolean`, `Period`, `Regex`, or `Key`
value into a string.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>data</code></p></td><td><p>The <code>TimeZone</code>, <code>Uri</code>, <code>Boolean</code>, <code>Period</code>, <code>Regex</code>, or <code>Key</code> value to coerce to a <code>String</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toString` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
  transformTimeZone: toString(|Z|),
  transformBoolean: toString(true),
  transformPeriod: toString(|P1D|),
  transformRegex: toString(/a-Z/),
  transformPeriod: toString(|PT8M10S|),
  transformUri: toString("https://docs.mulesoft.com/" as Uri)
}  ++
{ transformKey : toString((keysOf({ "aKeyToString" : "aValue"})[0])) }
```

#### Output

```Json
{
  "transformTimeZone": "Z",
  "transformBoolean": "true",
  "transformPeriod": "P1D",
  "transformRegex": "a-Z",
  "transformPeriod": "PT8M10S",
  "transformUri": "https://docs.mulesoft.com/",
  "transformKey": "aKeyToString"
}
```

## toString(arr: Array<String>): String

A variant of `toString` that joins an `Array` of characters into a single `String` value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>arr</code></p></td><td><p>The <code>Array</code> of characters to transform into a <code>String</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toString` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
  a: toString([]),
  b: toString(["h", "o", "l", "a"])
}
```

#### Output

```Json
{
  "a": "",
  "b": "hola"
}
```

<!-- document id=26060ff00a58c68918cba55757913d902f6d1c0f7ae0afabb994052ae43be14b url=/mulesoft/current/en-us/dataweave/latest/dw-mime-functions-tostring.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# toString

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toString(mimeType: MimeType): String

Transforms a `MimeType` value to a string representation.

_Introduced in DataWeave version 2.7.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>mimeType</code></p></td><td><p><code>MimeType</code></p></td><td><p>The MIME type value to transform to a <code>String</code>.</p></td></tr></tbody></table>

### Example

This example transforms a `MimeType` value without `parameters` to a string representation.

#### Source

```DataWeave
%dw 2.0
import * from dw::module::Mime
output application/json
---
toString({'type': "application", subtype: "json", parameters: {}})
```

#### Output

```Json
"application/json"
```

### Example

This example transforms a `MimeType` value that includes a `parameters` to a string representation.

#### Source

```DataWeave
%dw 2.0
import * from dw::module::Mime
output application/json
---
toString({'type': "multipart", subtype: "form-data", parameters: {boundary: "my-boundary"}})
```

#### Output

```Json
"multipart/form-data;boundary=my-boundary"
```

<!-- document id=8973eea6fe432023679b4c294c7ef9741868e56d95ccd15a21cbbf420a35bfec url=/mulesoft/current/en-us/dataweave/2.11/dw-coercions-functions-totime.md -->

---
product: DataWeave
version: 2.11
---

# toTime

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toTime(str: String, formatters: Array<Formatter>): Time

Transforms a `String` value into a `Time` value using the first `Formatter` that matches with the
given value to transform.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>Time</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>Time</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toTime` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
import * from dw::Runtime
output application/dw
---
{
  a: toTime("13:44:12.283-08:00", [{format: "HH:mm:ss.xxx"}, {format: "HH:mm:ss.nxxx"}]),
  b: try(() -> toTime("13:44:12.283-08:00", [{format: "HH:mm:ss.xxx"}]).error.message
}
```

#### Output

```DataWeave
{
  a: |13:44:12.000000283-08:00| as Time {format: "HH:mm:ss.nxxx"},
  b: "Could not find a valid formatter for '13:44:12.283-08:00'"
}
```

## toTime(str: String, format: String | Null = null, locale: String | Null = null): Time

Transforms a `String` value into a `Time` value and accepts a format and locale.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>Time</code> value.</p></td></tr><tr><td><p><code>format</code></p></td><td><p>The formatting to use on the <code>Time</code> value. A <code>null</code> value has no effect on the <code>Time</code> value. This parameter accepts Java character patterns based on ISO-8601. A <code>Time</code> value, such as <code>10:15:30.000000</code>, has the format <code>HH:mm:ss.nxxx</code>.</p></td></tr><tr><td><p><code>locale</code></p></td><td><p>Optional ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default.</p></td></tr></tbody></table>

### Example

This example shows how `toTime` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
   a: toTime("23:57:59Z"),
   b: toTime("13:44:12.283-08:00","HH:mm:ss.nxxx")
}
```

#### Output

```DataWeave
{
  a: |23:57:59Z|,
  b: |13:44:12.000000283-08:00| as Time {format: "HH:mm:ss.nxxx"}
}
```

<!-- document id=456f8e2165af6afdfc93e8603312a7499fdc0e8d6f60a1967f9726d955a67c15 url=/mulesoft/current/en-us/dataweave/2.12/dw-coercions-functions-totime.md -->

---
product: DataWeave
version: 2.12
---

# toTime

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toTime(str: String, formatters: Array<Formatter>): Time

Transforms a `String` value into a `Time` value using the first `Formatter` that matches with the
given value to transform.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>Time</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>Time</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toTime` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
import * from dw::Runtime
output application/dw
---
{
  a: toTime("13:44:12.283-08:00", [{format: "HH:mm:ss.xxx"}, {format: "HH:mm:ss.nxxx"}]),
  b: try(() -> toTime("13:44:12.283-08:00", [{format: "HH:mm:ss.xxx"}]).error.message
}
```

#### Output

```DataWeave
{
  a: |13:44:12.000000283-08:00| as Time {format: "HH:mm:ss.nxxx"},
  b: "Could not find a valid formatter for '13:44:12.283-08:00'"
}
```

## toTime(str: String, format: String | Null = null, locale: String | Null = null): Time

Transforms a `String` value into a `Time` value and accepts a format and locale.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>Time</code> value.</p></td></tr><tr><td><p><code>format</code></p></td><td><p>The formatting to use on the <code>Time</code> value. A <code>null</code> value has no effect on the <code>Time</code> value. This parameter accepts Java character patterns based on ISO-8601. A <code>Time</code> value, such as <code>10:15:30.000000</code>, has the format <code>HH:mm:ss.nxxx</code>.</p></td></tr><tr><td><p><code>locale</code></p></td><td><p>Optional ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default.</p></td></tr></tbody></table>

### Example

This example shows how `toTime` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
   a: toTime("23:57:59Z"),
   b: toTime("13:44:12.283-08:00","HH:mm:ss.nxxx")
}
```

#### Output

```DataWeave
{
  a: |23:57:59Z|,
  b: |13:44:12.000000283-08:00| as Time {format: "HH:mm:ss.nxxx"}
}
```

<!-- document id=54e4f2394d888bb90ab8c9c18c79455bf922da85f33772f8590f7b92bf098ce6 url=/mulesoft/current/en-us/dataweave/2.4/dw-coercions-functions-totime.md -->

---
product: DataWeave
version: 2.4
---

# toTime

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toTime(str: String, format: String | Null = null, locale: String | Null = null): Time

Transforms a `String` value into a `Time` value and accepts a format and locale.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>Time</code> value.</p></td></tr><tr><td><p><code>format</code></p></td><td><p>The formatting to use on the <code>Time</code> value. A <code>null</code> value has no effect on the <code>Time</code> value. This parameter accepts Java character patterns based on ISO-8601. A <code>Time</code> value, such as <code>10:15:30.000000</code>, has the format <code>HH:mm:ss.nxxx</code>.</p></td></tr><tr><td><p><code>locale</code></p></td><td><p>Optional ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default.</p></td></tr></tbody></table>

### Example

This example shows how `toTime` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
   a: toTime("23:57:59Z"),
   b: toTime("13:44:12.283-08:00","HH:mm:ss.nxxx")
}
```

#### Output

```DataWeave
{
  a: |23:57:59Z|,
  b: |13:44:12.000000283-08:00| as Time {format: "HH:mm:ss.nxxx"}
}
```

<!-- document id=f0b65cb20fb742d65678e555d21bbe5fd4f9ddafa60d8686ee9fbef1070982b8 url=/mulesoft/current/en-us/dataweave/2.6/dw-coercions-functions-totime.md -->

---
product: DataWeave
version: 2.6
---

# toTime

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toTime(str: String, formatters: Array<Formatter>): Time

Transforms a `String` value into a `Time` value using the first `Formatter` that matches with the
given value to transform.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>Time</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>Time</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toTime` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
import * from dw::Runtime
output application/dw
---
{
  a: toTime("13:44:12.283-08:00", [{format: "HH:mm:ss.xxx"}, {format: "HH:mm:ss.nxxx"}]),
  b: try(() -> toTime("13:44:12.283-08:00", [{format: "HH:mm:ss.xxx"}]).error.message
}
```

#### Output

```DataWeave
{
  a: |13:44:12.000000283-08:00| as Time {format: "HH:mm:ss.nxxx"},
  b: "Could not find a valid formatter for '13:44:12.283-08:00'"
}
```

## toTime(str: String, format: String | Null = null, locale: String | Null = null): Time

Transforms a `String` value into a `Time` value and accepts a format and locale.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>Time</code> value.</p></td></tr><tr><td><p><code>format</code></p></td><td><p>The formatting to use on the <code>Time</code> value. A <code>null</code> value has no effect on the <code>Time</code> value. This parameter accepts Java character patterns based on ISO-8601. A <code>Time</code> value, such as <code>10:15:30.000000</code>, has the format <code>HH:mm:ss.nxxx</code>.</p></td></tr><tr><td><p><code>locale</code></p></td><td><p>Optional ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default.</p></td></tr></tbody></table>

### Example

This example shows how `toTime` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
   a: toTime("23:57:59Z"),
   b: toTime("13:44:12.283-08:00","HH:mm:ss.nxxx")
}
```

#### Output

```DataWeave
{
  a: |23:57:59Z|,
  b: |13:44:12.000000283-08:00| as Time {format: "HH:mm:ss.nxxx"}
}
```

<!-- document id=800f9c18207f475fa9abcb03d4f9f024f3e848ca45fda500d8bd24257b52791f url=/mulesoft/current/en-us/dataweave/2.9/dw-coercions-functions-totime.md -->

---
product: DataWeave
version: 2.9
---

# toTime

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toTime(str: String, formatters: Array<Formatter>): Time

Transforms a `String` value into a `Time` value using the first `Formatter` that matches with the
given value to transform.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>Time</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>Time</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toTime` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
import * from dw::Runtime
output application/dw
---
{
  a: toTime("13:44:12.283-08:00", [{format: "HH:mm:ss.xxx"}, {format: "HH:mm:ss.nxxx"}]),
  b: try(() -> toTime("13:44:12.283-08:00", [{format: "HH:mm:ss.xxx"}]).error.message
}
```

#### Output

```DataWeave
{
  a: |13:44:12.000000283-08:00| as Time {format: "HH:mm:ss.nxxx"},
  b: "Could not find a valid formatter for '13:44:12.283-08:00'"
}
```

## toTime(str: String, format: String | Null = null, locale: String | Null = null): Time

Transforms a `String` value into a `Time` value and accepts a format and locale.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>Time</code> value.</p></td></tr><tr><td><p><code>format</code></p></td><td><p>The formatting to use on the <code>Time</code> value. A <code>null</code> value has no effect on the <code>Time</code> value. This parameter accepts Java character patterns based on ISO-8601. A <code>Time</code> value, such as <code>10:15:30.000000</code>, has the format <code>HH:mm:ss.nxxx</code>.</p></td></tr><tr><td><p><code>locale</code></p></td><td><p>Optional ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default.</p></td></tr></tbody></table>

### Example

This example shows how `toTime` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
   a: toTime("23:57:59Z"),
   b: toTime("13:44:12.283-08:00","HH:mm:ss.nxxx")
}
```

#### Output

```DataWeave
{
  a: |23:57:59Z|,
  b: |13:44:12.000000283-08:00| as Time {format: "HH:mm:ss.nxxx"}
}
```

<!-- document id=679324c1056644329698acf6e864b1198f4587172b3d73bddef7198648668241 url=/mulesoft/current/en-us/dataweave/latest/dw-coercions-functions-totime.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# toTime

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toTime(str: String, formatters: Array<Formatter>): Time

Transforms a `String` value into a `Time` value using the first `Formatter` that matches with the
given value to transform.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>Time</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>Time</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toTime` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
import * from dw::Runtime
output application/dw
---
{
  a: toTime("13:44:12.283-08:00", [{format: "HH:mm:ss.xxx"}, {format: "HH:mm:ss.nxxx"}]),
  b: try(() -> toTime("13:44:12.283-08:00", [{format: "HH:mm:ss.xxx"}]).error.message
}
```

#### Output

```DataWeave
{
  a: |13:44:12.000000283-08:00| as Time {format: "HH:mm:ss.nxxx"},
  b: "Could not find a valid formatter for '13:44:12.283-08:00'"
}
```

## toTime(str: String, format: String | Null = null, locale: String | Null = null): Time

Transforms a `String` value into a `Time` value and accepts a format and locale.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>Time</code> value.</p></td></tr><tr><td><p><code>format</code></p></td><td><p>The formatting to use on the <code>Time</code> value. A <code>null</code> value has no effect on the <code>Time</code> value. This parameter accepts Java character patterns based on ISO-8601. A <code>Time</code> value, such as <code>10:15:30.000000</code>, has the format <code>HH:mm:ss.nxxx</code>.</p></td></tr><tr><td><p><code>locale</code></p></td><td><p>Optional ISO 3166 country code to use, such as <code>US</code>, <code>AR</code>, or <code>ES</code>. A <code>null</code> or absent value uses your JVM default.</p></td></tr></tbody></table>

### Example

This example shows how `toTime` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
   a: toTime("23:57:59Z"),
   b: toTime("13:44:12.283-08:00","HH:mm:ss.nxxx")
}
```

#### Output

```DataWeave
{
  a: |23:57:59Z|,
  b: |13:44:12.000000283-08:00| as Time {format: "HH:mm:ss.nxxx"}
}
```

<!-- document id=0c26bdfafee417c4a7b76af88d5bb65b3c0fb8c7a809461947f0fa09647005a8 url=/mulesoft/current/en-us/dataweave/2.11/dw-coercions-functions-totimeornull.md -->

---
product: DataWeave
version: 2.11
---

# toTimeOrNull

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toTimeOrNull(str: String, formatters: Array<Formatter>): Time | Null

Transforms a `String` value into a `Time` value using the first `Formatter` that matches with the
given value to transform.

If none of the `Formatter` matches with the given value, the function returns a `null` value.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>Time</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>Time</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toTimeOrNull` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  a: toTimeOrNull("13:44:12.283-08:00", [{format: "HH:mm:ss.xxx"}, {format: "HH:mm:ss.nxxx"}]),
  b: toTimeOrNull("13:44:12.283-08:00", [{format: "HH:mm:ss.xxx"}])
}
```

#### Output

```DataWeave
{
  a: |13:44:12.000000283-08:00| as Time {format: "HH:mm:ss.nxxx"},
  b: null
}
```

<!-- document id=32b7f36093d4e20df959a8a47b29c808fa6ae4637c7233ea3be3e5e50b5f6377 url=/mulesoft/current/en-us/dataweave/2.12/dw-coercions-functions-totimeornull.md -->

---
product: DataWeave
version: 2.12
---

# toTimeOrNull

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toTimeOrNull(str: String, formatters: Array<Formatter>): Time | Null

Transforms a `String` value into a `Time` value using the first `Formatter` that matches with the
given value to transform.

If none of the `Formatter` matches with the given value, the function returns a `null` value.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>Time</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>Time</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toTimeOrNull` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  a: toTimeOrNull("13:44:12.283-08:00", [{format: "HH:mm:ss.xxx"}, {format: "HH:mm:ss.nxxx"}]),
  b: toTimeOrNull("13:44:12.283-08:00", [{format: "HH:mm:ss.xxx"}])
}
```

#### Output

```DataWeave
{
  a: |13:44:12.000000283-08:00| as Time {format: "HH:mm:ss.nxxx"},
  b: null
}
```

<!-- document id=60b3fe037546fd9aa47aa17484c7bec9864158b7486255b346255f9d4d5c59b5 url=/mulesoft/current/en-us/dataweave/2.6/dw-coercions-functions-totimeornull.md -->

---
product: DataWeave
version: 2.6
---

# toTimeOrNull

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toTimeOrNull(str: String, formatters: Array<Formatter>): Time | Null

Transforms a `String` value into a `Time` value using the first `Formatter` that matches with the
given value to transform.

If none of the `Formatter` matches with the given value, the function returns a `null` value.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>Time</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>Time</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toTimeOrNull` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  a: toTimeOrNull("13:44:12.283-08:00", [{format: "HH:mm:ss.xxx"}, {format: "HH:mm:ss.nxxx"}]),
  b: toTimeOrNull("13:44:12.283-08:00", [{format: "HH:mm:ss.xxx"}])
}
```

#### Output

```DataWeave
{
  a: |13:44:12.000000283-08:00| as Time {format: "HH:mm:ss.nxxx"},
  b: null
}
```

<!-- document id=b3b4e5de8e8988df6a2e037e5367f081dfde81028ec89842e8b449c65f56a66a url=/mulesoft/current/en-us/dataweave/2.9/dw-coercions-functions-totimeornull.md -->

---
product: DataWeave
version: 2.9
---

# toTimeOrNull

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toTimeOrNull(str: String, formatters: Array<Formatter>): Time | Null

Transforms a `String` value into a `Time` value using the first `Formatter` that matches with the
given value to transform.

If none of the `Formatter` matches with the given value, the function returns a `null` value.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>Time</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>Time</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toTimeOrNull` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  a: toTimeOrNull("13:44:12.283-08:00", [{format: "HH:mm:ss.xxx"}, {format: "HH:mm:ss.nxxx"}]),
  b: toTimeOrNull("13:44:12.283-08:00", [{format: "HH:mm:ss.xxx"}])
}
```

#### Output

```DataWeave
{
  a: |13:44:12.000000283-08:00| as Time {format: "HH:mm:ss.nxxx"},
  b: null
}
```

<!-- document id=e5973678012954da86d6952b810de82cf7143513e93d972d6dc270d182cffb11 url=/mulesoft/current/en-us/dataweave/latest/dw-coercions-functions-totimeornull.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# toTimeOrNull

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toTimeOrNull(str: String, formatters: Array<Formatter>): Time | Null

Transforms a `String` value into a `Time` value using the first `Formatter` that matches with the
given value to transform.

If none of the `Formatter` matches with the given value, the function returns a `null` value.

_Introduced in DataWeave version 2.5.0._

### Parameters

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>String</p></td><td><p>The <code>String</code> value to transform into a <code>Time</code> value.</p></td></tr><tr><td><p><code>formatters</code></p></td><td><p>Array&lt;Formatter&gt;</p></td><td><p>The <code>array</code> of formatting to use on the <code>Time</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toTimeOrNull` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
  a: toTimeOrNull("13:44:12.283-08:00", [{format: "HH:mm:ss.xxx"}, {format: "HH:mm:ss.nxxx"}]),
  b: toTimeOrNull("13:44:12.283-08:00", [{format: "HH:mm:ss.xxx"}])
}
```

#### Output

```DataWeave
{
  a: |13:44:12.000000283-08:00| as Time {format: "HH:mm:ss.nxxx"},
  b: null
}
```

<!-- document id=38ff904d74e04074c5312301eb8a741ddb7b7ee96e707eb8bc9447dbe6566690 url=/mulesoft/current/en-us/dataweave/2.11/dw-coercions-functions-totimezone.md -->

---
product: DataWeave
version: 2.11
---

# toTimeZone

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toTimeZone(str: String): TimeZone

Transform a `String` value into a `TimeZone` value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>TimeZone</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toTimeZone` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
   toTimeZoneOffset: toTimeZone("-03:00"),
   toTimeZoneAbbreviation: toTimeZone("Z"),
   toTimeZoneName: toTimeZone("America/Argentina/Buenos_Aires")
}
```

#### Output

```DataWeave
{
  toTimeZoneOffset: |-03:00|,
  toTimeZoneAbbreviation: |Z|,
  toTimeZoneName: |America/Argentina/Buenos_Aires|
}
```

<!-- document id=b9eee0a49b11fcf3ed3337fef9ce135a149232dc4a00de2fa3177c6338a2903a url=/mulesoft/current/en-us/dataweave/2.12/dw-coercions-functions-totimezone.md -->

---
product: DataWeave
version: 2.12
---

# toTimeZone

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toTimeZone(str: String): TimeZone

Transform a `String` value into a `TimeZone` value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>TimeZone</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toTimeZone` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
   toTimeZoneOffset: toTimeZone("-03:00"),
   toTimeZoneAbbreviation: toTimeZone("Z"),
   toTimeZoneName: toTimeZone("America/Argentina/Buenos_Aires")
}
```

#### Output

```DataWeave
{
  toTimeZoneOffset: |-03:00|,
  toTimeZoneAbbreviation: |Z|,
  toTimeZoneName: |America/Argentina/Buenos_Aires|
}
```

<!-- document id=539f06ff1ac180b7e0d5ae13f7b1580f7a6e9cabb289d159915a4cddb4b65ab7 url=/mulesoft/current/en-us/dataweave/2.4/dw-coercions-functions-totimezone.md -->

---
product: DataWeave
version: 2.4
---

# toTimeZone

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toTimeZone(str: String): TimeZone

Transform a `String` value into a `TimeZone` value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>TimeZone</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toTimeZone` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
   toTimeZoneOffset: toTimeZone("-03:00"),
   toTimeZoneAbbreviation: toTimeZone("Z"),
   toTimeZoneName: toTimeZone("America/Argentina/Buenos_Aires")
}
```

#### Output

```DataWeave
{
  toTimeZoneOffset: |-03:00|,
  toTimeZoneAbbreviation: |Z|,
  toTimeZoneName: |America/Argentina/Buenos_Aires|
}
```

<!-- document id=5ff7438202786f36682e330af0e633447be5d5bb07f69a31109d31967bdb82f9 url=/mulesoft/current/en-us/dataweave/2.6/dw-coercions-functions-totimezone.md -->

---
product: DataWeave
version: 2.6
---

# toTimeZone

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toTimeZone(str: String): TimeZone

Transform a `String` value into a `TimeZone` value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>TimeZone</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toTimeZone` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
   toTimeZoneOffset: toTimeZone("-03:00"),
   toTimeZoneAbbreviation: toTimeZone("Z"),
   toTimeZoneName: toTimeZone("America/Argentina/Buenos_Aires")
}
```

#### Output

```DataWeave
{
  toTimeZoneOffset: |-03:00|,
  toTimeZoneAbbreviation: |Z|,
  toTimeZoneName: |America/Argentina/Buenos_Aires|
}
```

<!-- document id=33a37a56417d5c57a5de77d80d28c9b51fb4f96d803f6bc3e2bd1894be4bd7fe url=/mulesoft/current/en-us/dataweave/2.9/dw-coercions-functions-totimezone.md -->

---
product: DataWeave
version: 2.9
---

# toTimeZone

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toTimeZone(str: String): TimeZone

Transform a `String` value into a `TimeZone` value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>TimeZone</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toTimeZone` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
   toTimeZoneOffset: toTimeZone("-03:00"),
   toTimeZoneAbbreviation: toTimeZone("Z"),
   toTimeZoneName: toTimeZone("America/Argentina/Buenos_Aires")
}
```

#### Output

```DataWeave
{
  toTimeZoneOffset: |-03:00|,
  toTimeZoneAbbreviation: |Z|,
  toTimeZoneName: |America/Argentina/Buenos_Aires|
}
```

<!-- document id=35142b4f74d72b80da21e6525931a08a6a1ce3d89b7030e2634152f670a8e112 url=/mulesoft/current/en-us/dataweave/latest/dw-coercions-functions-totimezone.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# toTimeZone

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toTimeZone(str: String): TimeZone

Transform a `String` value into a `TimeZone` value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>TimeZone</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toTimeZone` behaves with different inputs. It produces output in the
`application/dw` format.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/dw
---
{
   toTimeZoneOffset: toTimeZone("-03:00"),
   toTimeZoneAbbreviation: toTimeZone("Z"),
   toTimeZoneName: toTimeZone("America/Argentina/Buenos_Aires")
}
```

#### Output

```DataWeave
{
  toTimeZoneOffset: |-03:00|,
  toTimeZoneAbbreviation: |Z|,
  toTimeZoneName: |America/Argentina/Buenos_Aires|
}
```

<!-- document id=94d44a2477fb21439a4036e7fafe57f36241c6b7cdd464826916a95bbda9ae08 url=/mulesoft/current/en-us/dataweave/2.11/dw-coercions-functions-touri.md -->

---
product: DataWeave
version: 2.11
---

# toUri

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toUri(str: String): Uri

Transforms a `String` value into a `Uri` value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>Uri</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toUri` behaves.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
  toUriExample: toUri("https://www.google.com/")
}
```

#### Output

```DataWeave
{
  "toUriExample": "https://www.google.com/"
}
```

<!-- document id=f15841caf5e7e13519f5271f4829a886a04381fc0254f0ed418e24796635f6e8 url=/mulesoft/current/en-us/dataweave/2.12/dw-coercions-functions-touri.md -->

---
product: DataWeave
version: 2.12
---

# toUri

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toUri(str: String): Uri

Transforms a `String` value into a `Uri` value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>Uri</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toUri` behaves.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
  toUriExample: toUri("https://www.google.com/")
}
```

#### Output

```DataWeave
{
  "toUriExample": "https://www.google.com/"
}
```

<!-- document id=2f465c918da00d19cdf384112d918e0e213a19bb6151ae9000e2489872075b80 url=/mulesoft/current/en-us/dataweave/2.4/dw-coercions-functions-touri.md -->

---
product: DataWeave
version: 2.4
---

# toUri

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toUri(str: String): Uri

Transforms a `String` value into a `Uri` value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>Uri</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toUri` behaves.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
  toUriExample: toUri("https://www.google.com/")
}
```

#### Output

```DataWeave
{
  "toUriExample": "https://www.google.com/"
}
```

<!-- document id=3f8e8abaf9b22b12c4bfdf18f37779e64a50c506bfec6d174d3246fc50192554 url=/mulesoft/current/en-us/dataweave/2.6/dw-coercions-functions-touri.md -->

---
product: DataWeave
version: 2.6
---

# toUri

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toUri(str: String): Uri

Transforms a `String` value into a `Uri` value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>Uri</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toUri` behaves.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
  toUriExample: toUri("https://www.google.com/")
}
```

#### Output

```DataWeave
{
  "toUriExample": "https://www.google.com/"
}
```

<!-- document id=2105638e156247b9e380854479416626d5dfe7202b08489c413e1bc94982e7d4 url=/mulesoft/current/en-us/dataweave/2.9/dw-coercions-functions-touri.md -->

---
product: DataWeave
version: 2.9
---

# toUri

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toUri(str: String): Uri

Transforms a `String` value into a `Uri` value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>Uri</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toUri` behaves.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
  toUriExample: toUri("https://www.google.com/")
}
```

#### Output

```DataWeave
{
  "toUriExample": "https://www.google.com/"
}
```

<!-- document id=9426dfd1df4446155ec07cc70dbd284efb60d208244e483f45be4aa461cb813a url=/mulesoft/current/en-us/dataweave/latest/dw-coercions-functions-touri.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# toUri

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## toUri(str: String): Uri

Transforms a `String` value into a `Uri` value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>str</code></p></td><td><p>The <code>String</code> value to transform into a <code>Uri</code> value.</p></td></tr></tbody></table>

### Example

This example shows how `toUri` behaves.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Coercions
output application/json
---
{
  toUriExample: toUri("https://www.google.com/")
}
```

#### Output

```DataWeave
{
  "toUriExample": "https://www.google.com/"
}
```

<!-- document id=004e88550856a4734d1cbabdda161e519347a113af88f5cf4f358f4f0af604eb url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook-perform-basic-transformation.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, transform, transformer, format, xml, json, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure
---

# Transform XML to JSON

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

These simple DataWeave examples change the XML input to JSON output. Note that more complex
transformations usually require the use of the `map` or `mapObject` function.

The following DataWeave script maps the names (or keys) for the output fields to values of the input
fields. The input fields are specified with selector expressions without any functions. The script
also changes the order and names of some of the fields.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
        address1: payload.order.buyer.address,
        city: payload.order.buyer.city,
        country: payload.order.buyer.nationality,
        email: payload.order.buyer.email,
        name: payload.order.buyer.name,
        postalCode: payload.order.buyer.postCode,
        stateOrProvince: payload.order.buyer.state
}
```

Input XML Payload:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<order>
  <product>
    <price>5</price>
    <model>MuleSoft Connect 2016</model>
  </product>
  <item_amount>3</item_amount>
  <payment>
    <payment-type>credit-card</payment-type>
    <currency>USD</currency>
    <installments>1</installments>
  </payment>
  <buyer>
    <email>mike@hotmail.com</email>
    <name>Michael</name>
    <address>Koala Boulevard 314</address>
    <city>San Diego</city>
    <state>CA</state>
    <postCode>1345</postCode>
    <nationality>USA</nationality>
  </buyer>
  <shop>main branch</shop>
  <salesperson>Mathew Chow</salesperson>
</order>
```

Output JSON:

```json
{
  "address1": "Koala Boulevard 314",
  "city": "San Diego",
  "country": "USA",
  "email": "mike@hotmail.com",
  "name": "Michael",
  "postalCode": "1345",
  "stateOrProvince": "CA"
}
```

In the following example, the DataWeave script transforms the XML containing multiple XML nodes with
the same key into a valid JSON creating an array instead of creating JSON nodes with the same key.

DataWeave Script:

```dataweave
%dw 2.0
output application/json duplicateKeyAsArray=true
---
payload
```

Input XML Payload:

```xml
<order>
  <product-lineitems>
	<product-lineitem>
	   <net-price>100.0</net-price>
	</product-lineitem>
	<product-lineitem>
	     <net-price>498.00</net-price>
	</product-lineitem>
  </product-lineitems>
</order>
```

Output JSON:

```json
{
  "order": {
    "product-lineitems": {
      "product-lineitem": [
        {
          "net-price": "100.0"
        },
        {
          "net-price": "498.00"
        }
      ]
    }
  }
}
```

## Related Examples

- [Extract Data](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-extract-data)

- [Map Data with DataWeave](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-map)

- [Rename Keys](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-rename-keys)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.11/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.11/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook)

<!-- document id=51c26df0b44b706eb66496fef5442fa9cd8c0799385035c155534310be76d644 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook-perform-basic-transformation.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, transform, transformer, format, xml, json, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure
---

# Transform XML to JSON

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

These simple DataWeave examples change the XML input to JSON output. Note that more complex
transformations usually require the use of the `map` or `mapObject` function.

The following DataWeave script maps the names (or keys) for the output fields to values of the input
fields. The input fields are specified with selector expressions without any functions. The script
also changes the order and names of some of the fields.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
        address1: payload.order.buyer.address,
        city: payload.order.buyer.city,
        country: payload.order.buyer.nationality,
        email: payload.order.buyer.email,
        name: payload.order.buyer.name,
        postalCode: payload.order.buyer.postCode,
        stateOrProvince: payload.order.buyer.state
}
```

Input XML Payload:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<order>
  <product>
    <price>5</price>
    <model>MuleSoft Connect 2016</model>
  </product>
  <item_amount>3</item_amount>
  <payment>
    <payment-type>credit-card</payment-type>
    <currency>USD</currency>
    <installments>1</installments>
  </payment>
  <buyer>
    <email>mike@hotmail.com</email>
    <name>Michael</name>
    <address>Koala Boulevard 314</address>
    <city>San Diego</city>
    <state>CA</state>
    <postCode>1345</postCode>
    <nationality>USA</nationality>
  </buyer>
  <shop>main branch</shop>
  <salesperson>Mathew Chow</salesperson>
</order>
```

Output JSON:

```json
{
  "address1": "Koala Boulevard 314",
  "city": "San Diego",
  "country": "USA",
  "email": "mike@hotmail.com",
  "name": "Michael",
  "postalCode": "1345",
  "stateOrProvince": "CA"
}
```

In the following example, the DataWeave script transforms the XML containing multiple XML nodes with
the same key into a valid JSON creating an array instead of creating JSON nodes with the same key.

DataWeave Script:

```dataweave
%dw 2.0
output application/json duplicateKeyAsArray=true
---
payload
```

Input XML Payload:

```xml
<order>
  <product-lineitems>
	<product-lineitem>
	   <net-price>100.0</net-price>
	</product-lineitem>
	<product-lineitem>
	     <net-price>498.00</net-price>
	</product-lineitem>
  </product-lineitems>
</order>
```

Output JSON:

```json
{
  "order": {
    "product-lineitems": {
      "product-lineitem": [
        {
          "net-price": "100.0"
        },
        {
          "net-price": "498.00"
        }
      ]
    }
  }
}
```

## Related Examples

- [Extract Data](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-extract-data)

- [Map Data with DataWeave](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-map)

- [Rename Keys](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-rename-keys)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.12/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.12/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook)

<!-- document id=61027e15a216ca65c9691c8536aad0af00035c20ad57da59de4c58d828f09911 url=/mulesoft/current/en-us/dataweave/2.3/dataweave-cookbook-perform-basic-transformation.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, transform, transformer, format, xml, json, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure
---

# Transform XML to JSON

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

These simple DataWeave examples change the XML input to JSON output. Note that more complex
transformations usually require the use of the `map` or `mapObject` function.

The following DataWeave script maps the names (or keys) for the output fields to values of the input
fields. The input fields are specified with selector expressions without any functions. The script
also changes the order and names of some of the fields.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
        address1: payload.order.buyer.address,
        city: payload.order.buyer.city,
        country: payload.order.buyer.nationality,
        email: payload.order.buyer.email,
        name: payload.order.buyer.name,
        postalCode: payload.order.buyer.postCode,
        stateOrProvince: payload.order.buyer.state
}
```

Input XML Payload:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<order>
  <product>
    <price>5</price>
    <model>MuleSoft Connect 2016</model>
  </product>
  <item_amount>3</item_amount>
  <payment>
    <payment-type>credit-card</payment-type>
    <currency>USD</currency>
    <installments>1</installments>
  </payment>
  <buyer>
    <email>mike@hotmail.com</email>
    <name>Michael</name>
    <address>Koala Boulevard 314</address>
    <city>San Diego</city>
    <state>CA</state>
    <postCode>1345</postCode>
    <nationality>USA</nationality>
  </buyer>
  <shop>main branch</shop>
  <salesperson>Mathew Chow</salesperson>
</order>
```

Output JSON:

```json
{
  "address1": "Koala Boulevard 314",
  "city": "San Diego",
  "country": "USA",
  "email": "mike@hotmail.com",
  "name": "Michael",
  "postalCode": "1345",
  "stateOrProvince": "CA"
}
```

In the following example, the DataWeave script transforms the XML containing multiple XML nodes with
the same key into a valid JSON creating an array instead of creating JSON nodes with the same key.

DataWeave Script:

```dataweave
%dw 2.0
output application/json duplicateKeyAsArray=true
---
payload
```

Input XML Payload:

```xml
<order>
  <product-lineitems>
	<product-lineitem>
	   <net-price>100.0</net-price>
	</product-lineitem>
	<product-lineitem>
	     <net-price>498.00</net-price>
	</product-lineitem>
  </product-lineitems>
</order>
```

Output JSON:

```json
{
  "order": {
    "product-lineitems": {
      "product-lineitem": [
        {
          "net-price": "100.0"
        },
        {
          "net-price": "498.00"
        }
      ]
    }
  }
}
```

## Related Examples

- [Extract Data](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-extract-data)

- [Map Data with DataWeave](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-map)

- [Rename Keys](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-rename-keys)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.3/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.3/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook)

<!-- document id=146987eacb0bad90286dc43c6646386e5e8fb78494dc9180edabbe7986fc4e59 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook-perform-basic-transformation.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, transform, transformer, format, xml, json, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure
---

# Transform XML to JSON

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

These simple DataWeave examples change the XML input to JSON output. Note that more complex
transformations usually require the use of the `map` or `mapObject` function.

The following DataWeave script maps the names (or keys) for the output fields to values of the input
fields. The input fields are specified with selector expressions without any functions. The script
also changes the order and names of some of the fields.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
        address1: payload.order.buyer.address,
        city: payload.order.buyer.city,
        country: payload.order.buyer.nationality,
        email: payload.order.buyer.email,
        name: payload.order.buyer.name,
        postalCode: payload.order.buyer.postCode,
        stateOrProvince: payload.order.buyer.state
}
```

Input XML Payload:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<order>
  <product>
    <price>5</price>
    <model>MuleSoft Connect 2016</model>
  </product>
  <item_amount>3</item_amount>
  <payment>
    <payment-type>credit-card</payment-type>
    <currency>USD</currency>
    <installments>1</installments>
  </payment>
  <buyer>
    <email>mike@hotmail.com</email>
    <name>Michael</name>
    <address>Koala Boulevard 314</address>
    <city>San Diego</city>
    <state>CA</state>
    <postCode>1345</postCode>
    <nationality>USA</nationality>
  </buyer>
  <shop>main branch</shop>
  <salesperson>Mathew Chow</salesperson>
</order>
```

Output JSON:

```json
{
  "address1": "Koala Boulevard 314",
  "city": "San Diego",
  "country": "USA",
  "email": "mike@hotmail.com",
  "name": "Michael",
  "postalCode": "1345",
  "stateOrProvince": "CA"
}
```

In the following example, the DataWeave script transforms the XML containing multiple XML nodes with
the same key into a valid JSON creating an array instead of creating JSON nodes with the same key.

DataWeave Script:

```dataweave
%dw 2.0
output application/json duplicateKeyAsArray=true
---
payload
```

Input XML Payload:

```xml
<order>
  <product-lineitems>
	<product-lineitem>
	   <net-price>100.0</net-price>
	</product-lineitem>
	<product-lineitem>
	     <net-price>498.00</net-price>
	</product-lineitem>
  </product-lineitems>
</order>
```

Output JSON:

```json
{
  "order": {
    "product-lineitems": {
      "product-lineitem": [
        {
          "net-price": "100.0"
        },
        {
          "net-price": "498.00"
        }
      ]
    }
  }
}
```

## Related Examples

- [Extract Data](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-extract-data)

- [Map Data with DataWeave](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-map)

- [Rename Keys](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-rename-keys)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.4/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.4/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook)

<!-- document id=028431aa5234296f6555f950e82d14e5ab9c820297733836f1afd2723b43dd3f url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook-perform-basic-transformation.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, transform, transformer, format, xml, json, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure
---

# Transform XML to JSON

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

These simple DataWeave examples change the XML input to JSON output. Note that more complex
transformations usually require the use of the `map` or `mapObject` function.

The following DataWeave script maps the names (or keys) for the output fields to values of the input
fields. The input fields are specified with selector expressions without any functions. The script
also changes the order and names of some of the fields.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
        address1: payload.order.buyer.address,
        city: payload.order.buyer.city,
        country: payload.order.buyer.nationality,
        email: payload.order.buyer.email,
        name: payload.order.buyer.name,
        postalCode: payload.order.buyer.postCode,
        stateOrProvince: payload.order.buyer.state
}
```

Input XML Payload:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<order>
  <product>
    <price>5</price>
    <model>MuleSoft Connect 2016</model>
  </product>
  <item_amount>3</item_amount>
  <payment>
    <payment-type>credit-card</payment-type>
    <currency>USD</currency>
    <installments>1</installments>
  </payment>
  <buyer>
    <email>mike@hotmail.com</email>
    <name>Michael</name>
    <address>Koala Boulevard 314</address>
    <city>San Diego</city>
    <state>CA</state>
    <postCode>1345</postCode>
    <nationality>USA</nationality>
  </buyer>
  <shop>main branch</shop>
  <salesperson>Mathew Chow</salesperson>
</order>
```

Output JSON:

```json
{
  "address1": "Koala Boulevard 314",
  "city": "San Diego",
  "country": "USA",
  "email": "mike@hotmail.com",
  "name": "Michael",
  "postalCode": "1345",
  "stateOrProvince": "CA"
}
```

In the following example, the DataWeave script transforms the XML containing multiple XML nodes with
the same key into a valid JSON creating an array instead of creating JSON nodes with the same key.

DataWeave Script:

```dataweave
%dw 2.0
output application/json duplicateKeyAsArray=true
---
payload
```

Input XML Payload:

```xml
<order>
  <product-lineitems>
	<product-lineitem>
	   <net-price>100.0</net-price>
	</product-lineitem>
	<product-lineitem>
	     <net-price>498.00</net-price>
	</product-lineitem>
  </product-lineitems>
</order>
```

Output JSON:

```json
{
  "order": {
    "product-lineitems": {
      "product-lineitem": [
        {
          "net-price": "100.0"
        },
        {
          "net-price": "498.00"
        }
      ]
    }
  }
}
```

## Related Examples

- [Extract Data](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-extract-data)

- [Map Data with DataWeave](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-map)

- [Rename Keys](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-rename-keys)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.6/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.6/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook)

<!-- document id=977ba78a18f689339a6f7dba51ba0235240194626bf2cd5696ed2419666376f3 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook-perform-basic-transformation.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, transform, transformer, format, xml, json, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure
---

# Transform XML to JSON

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

These simple DataWeave examples change the XML input to JSON output. Note that more complex
transformations usually require the use of the `map` or `mapObject` function.

The following DataWeave script maps the names (or keys) for the output fields to values of the input
fields. The input fields are specified with selector expressions without any functions. The script
also changes the order and names of some of the fields.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
        address1: payload.order.buyer.address,
        city: payload.order.buyer.city,
        country: payload.order.buyer.nationality,
        email: payload.order.buyer.email,
        name: payload.order.buyer.name,
        postalCode: payload.order.buyer.postCode,
        stateOrProvince: payload.order.buyer.state
}
```

Input XML Payload:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<order>
  <product>
    <price>5</price>
    <model>MuleSoft Connect 2016</model>
  </product>
  <item_amount>3</item_amount>
  <payment>
    <payment-type>credit-card</payment-type>
    <currency>USD</currency>
    <installments>1</installments>
  </payment>
  <buyer>
    <email>mike@hotmail.com</email>
    <name>Michael</name>
    <address>Koala Boulevard 314</address>
    <city>San Diego</city>
    <state>CA</state>
    <postCode>1345</postCode>
    <nationality>USA</nationality>
  </buyer>
  <shop>main branch</shop>
  <salesperson>Mathew Chow</salesperson>
</order>
```

Output JSON:

```json
{
  "address1": "Koala Boulevard 314",
  "city": "San Diego",
  "country": "USA",
  "email": "mike@hotmail.com",
  "name": "Michael",
  "postalCode": "1345",
  "stateOrProvince": "CA"
}
```

In the following example, the DataWeave script transforms the XML containing multiple XML nodes with
the same key into a valid JSON creating an array instead of creating JSON nodes with the same key.

DataWeave Script:

```dataweave
%dw 2.0
output application/json duplicateKeyAsArray=true
---
payload
```

Input XML Payload:

```xml
<order>
  <product-lineitems>
	<product-lineitem>
	   <net-price>100.0</net-price>
	</product-lineitem>
	<product-lineitem>
	     <net-price>498.00</net-price>
	</product-lineitem>
  </product-lineitems>
</order>
```

Output JSON:

```json
{
  "order": {
    "product-lineitems": {
      "product-lineitem": [
        {
          "net-price": "100.0"
        },
        {
          "net-price": "498.00"
        }
      ]
    }
  }
}
```

## Related Examples

- [Extract Data](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-extract-data)

- [Map Data with DataWeave](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-map)

- [Rename Keys](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-rename-keys)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.9/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.9/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook)

<!-- document id=253c9fdc024479fc70ada272ae3b98c9f125e91fb93979e0e8a7eac94d030eba url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook-perform-basic-transformation.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, transform, transformer, format, xml, json, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure
---

# Transform XML to JSON

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

These simple DataWeave examples change the XML input to JSON output. Note that more complex
transformations usually require the use of the `map` or `mapObject` function.

The following DataWeave script maps the names (or keys) for the output fields to values of the input
fields. The input fields are specified with selector expressions without any functions. The script
also changes the order and names of some of the fields.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
{
        address1: payload.order.buyer.address,
        city: payload.order.buyer.city,
        country: payload.order.buyer.nationality,
        email: payload.order.buyer.email,
        name: payload.order.buyer.name,
        postalCode: payload.order.buyer.postCode,
        stateOrProvince: payload.order.buyer.state
}
```

Input XML Payload:

```xml
<?xml version='1.0' encoding='UTF-8'?>
<order>
  <product>
    <price>5</price>
    <model>MuleSoft Connect 2016</model>
  </product>
  <item_amount>3</item_amount>
  <payment>
    <payment-type>credit-card</payment-type>
    <currency>USD</currency>
    <installments>1</installments>
  </payment>
  <buyer>
    <email>mike@hotmail.com</email>
    <name>Michael</name>
    <address>Koala Boulevard 314</address>
    <city>San Diego</city>
    <state>CA</state>
    <postCode>1345</postCode>
    <nationality>USA</nationality>
  </buyer>
  <shop>main branch</shop>
  <salesperson>Mathew Chow</salesperson>
</order>
```

Output JSON:

```json
{
  "address1": "Koala Boulevard 314",
  "city": "San Diego",
  "country": "USA",
  "email": "mike@hotmail.com",
  "name": "Michael",
  "postalCode": "1345",
  "stateOrProvince": "CA"
}
```

In the following example, the DataWeave script transforms the XML containing multiple XML nodes with
the same key into a valid JSON creating an array instead of creating JSON nodes with the same key.

DataWeave Script:

```dataweave
%dw 2.0
output application/json duplicateKeyAsArray=true
---
payload
```

Input XML Payload:

```xml
<order>
  <product-lineitems>
	<product-lineitem>
	   <net-price>100.0</net-price>
	</product-lineitem>
	<product-lineitem>
	     <net-price>498.00</net-price>
	</product-lineitem>
  </product-lineitems>
</order>
```

Output JSON:

```json
{
  "order": {
    "product-lineitems": {
      "product-lineitem": [
        {
          "net-price": "100.0"
        },
        {
          "net-price": "498.00"
        }
      ]
    }
  }
}
```

## Related Examples

- [Extract Data](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-extract-data)

- [Map Data with DataWeave](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-map)

- [Rename Keys](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-rename-keys)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/latest/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook)

<!-- document id=aa6b4cff7a9dbef5f0b9b1ff3889f22bbccaf8a1537ffe37886e84f8af5ffaaa url=/mulesoft/current/en-us/dataweave/2.11/dw-tree.md -->

---
product: DataWeave
version: 2.11
---

# Tree (dw::util::Tree)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This utility module provides functions for handling values as tree-data structures.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::util::Tree` to the header of your DataWeave script.

_Introduced in DataWeave version 2.2.2._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-tree-functions-asexpressionstring">asExpressionString</a></p></td><td><p>Transforms a <code>Path</code> value into a string representation of the path.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-tree-functions-filterarrayleafs">filterArrayLeafs</a></p></td><td><p>Applies a filtering expression to leaf or <code>Path</code> values of an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-tree-functions-filterobjectleafs">filterObjectLeafs</a></p></td><td><p>Applies a filtering expression to leaf or <code>Path</code> values of keys in an object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-tree-functions-filtertree">filterTree</a></p></td><td><p>Filters the value or path of nodes in an input based on a specified <code>criteria</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-tree-functions-isarraytype">isArrayType</a></p></td><td><p>Returns <code>true</code> if the provided <code>Path</code> value is an <code>ARRAY_TYPE</code> expression.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-tree-functions-isattributetype">isAttributeType</a></p></td><td><p>Returns <code>true</code> if the provided <code>Path</code> value is an <code>ATTRIBUTE_TYPE</code> expression.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-tree-functions-isobjecttype">isObjectType</a></p></td><td><p>Returns <code>true</code> if the provided <code>Path</code> value is an <code>OBJECT_TYPE</code> expression.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-tree-functions-mapleafvalues">mapLeafValues</a></p></td><td><p>Maps the terminal (leaf) nodes in the tree.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-tree-functions-nodeexists">nodeExists</a></p></td><td><p>Returns <code>true</code> if any node in a given tree validates against the specified criteria.</p></td></tr></tbody></table>

## Variables

- [Tree Variables](https://docs.mulesoft.com/dataweave/2.11/dw-tree-variables)

## Types

- [Tree Types](https://docs.mulesoft.com/dataweave/2.11/dw-tree-types)

<!-- document id=803bf81605bdbf624525829e5d17f0170f00e3d575048b1606c18268b9c1cf23 url=/mulesoft/current/en-us/dataweave/2.12/dw-tree.md -->

---
product: DataWeave
version: 2.12
---

# Tree (dw::util::Tree)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This utility module provides functions for handling values as tree-data structures.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::util::Tree` to the header of your DataWeave script.

_Introduced in DataWeave version 2.2.2._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-tree-functions-asexpressionstring">asExpressionString</a></p></td><td><p>Transforms a <code>Path</code> value into a string representation of the path.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-tree-functions-filterarrayleafs">filterArrayLeafs</a></p></td><td><p>Applies a filtering expression to leaf or <code>Path</code> values of an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-tree-functions-filterobjectleafs">filterObjectLeafs</a></p></td><td><p>Applies a filtering expression to leaf or <code>Path</code> values of keys in an object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-tree-functions-filtertree">filterTree</a></p></td><td><p>Filters the value or path of nodes in an input based on a specified <code>criteria</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-tree-functions-isarraytype">isArrayType</a></p></td><td><p>Returns <code>true</code> if the provided <code>Path</code> value is an <code>ARRAY_TYPE</code> expression.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-tree-functions-isattributetype">isAttributeType</a></p></td><td><p>Returns <code>true</code> if the provided <code>Path</code> value is an <code>ATTRIBUTE_TYPE</code> expression.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-tree-functions-isobjecttype">isObjectType</a></p></td><td><p>Returns <code>true</code> if the provided <code>Path</code> value is an <code>OBJECT_TYPE</code> expression.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-tree-functions-mapleafvalues">mapLeafValues</a></p></td><td><p>Maps the terminal (leaf) nodes in the tree.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-tree-functions-nodeexists">nodeExists</a></p></td><td><p>Returns <code>true</code> if any node in a given tree validates against the specified criteria.</p></td></tr></tbody></table>

## Variables

- [Tree Variables](https://docs.mulesoft.com/dataweave/2.12/dw-tree-variables)

## Types

- [Tree Types](https://docs.mulesoft.com/dataweave/2.12/dw-tree-types)

<!-- document id=3145d34284b62694ab55e98d51f3bbde118e1a0f6ae619ce7f3925e1e1cb32de url=/mulesoft/current/en-us/dataweave/2.3/dw-tree.md -->

---
product: DataWeave
version: 2.3
---

# Tree (dw::util::Tree)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This utility module provides functions that enable you to handle values as though they are tree data
structures.

The module is included with Mule runtime. To use it, you must import it into your DataWeave code,
for example, by adding the line `import * from dw::util::Tree` to the header of your script.

_Introduced in DataWeave 2.2.2. Supported by Mule 4.2.2 and later._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-tree-functions-asexpressionstring">asExpressionString</a></p></td><td><p>Transforms a path to a string representation.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-tree-functions-mapleafvalues">mapLeafValues</a></p></td><td><p>Maps the terminal (leaf) nodes in the tree.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-tree-functions-nodeexists">nodeExists</a></p></td><td><p>Returns <code>true</code> if any node in the tree validates against the specified criteria.</p></td></tr></tbody></table>

## Variables

- [Tree Variables](https://docs.mulesoft.com/dataweave/2.3/dw-tree-variables)

## Types

- [Tree Types](https://docs.mulesoft.com/dataweave/2.3/dw-tree-types)

<!-- document id=94b27c230ff2f2db0cda72bfb564fab5dae2579338562a244b5e602367265a9c url=/mulesoft/current/en-us/dataweave/2.4/dw-tree.md -->

---
product: DataWeave
version: 2.4
---

# Tree (dw::util::Tree)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This utility module provides functions for handling values as tree-data structures.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::util::Tree` to the header of your DataWeave script.

_Introduced in DataWeave version 2.2.2._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-tree-functions-asexpressionstring">asExpressionString</a></p></td><td><p>Transforms a <code>Path</code> value into a string representation of the path.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-tree-functions-filterarrayleafs">filterArrayLeafs</a></p></td><td><p>Applies a filtering expression to leaf or <code>Path</code> values of an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-tree-functions-filterobjectleafs">filterObjectLeafs</a></p></td><td><p>Applies a filtering expression to leaf or <code>Path</code> values of keys in an object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-tree-functions-filtertree">filterTree</a></p></td><td><p>Filters the value or path of nodes in an input based on a specified <code>criteria</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-tree-functions-isarraytype">isArrayType</a></p></td><td><p>Returns <code>true</code> if the provided <code>Path</code> value is an <code>ARRAY_TYPE</code> expression.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-tree-functions-isattributetype">isAttributeType</a></p></td><td><p>Returns <code>true</code> if the provided <code>Path</code> value is an <code>ATTRIBUTE_TYPE</code> expression.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-tree-functions-isobjecttype">isObjectType</a></p></td><td><p>Returns <code>true</code> if the provided <code>Path</code> value is an <code>OBJECT_TYPE</code> expression.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-tree-functions-mapleafvalues">mapLeafValues</a></p></td><td><p>Maps the terminal (leaf) nodes in the tree.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-tree-functions-nodeexists">nodeExists</a></p></td><td><p>Returns <code>true</code> if any node in a given tree validates against the specified criteria.</p></td></tr></tbody></table>

## Variables

- [Tree Variables](https://docs.mulesoft.com/dataweave/2.4/dw-tree-variables)

## Types

- [Tree Types](https://docs.mulesoft.com/dataweave/2.4/dw-tree-types)

<!-- document id=04768c57252f55a41421b94ff859017c190dfde0d86b221b75a63590750c3dd9 url=/mulesoft/current/en-us/dataweave/2.6/dw-tree.md -->

---
product: DataWeave
version: 2.6
---

# Tree (dw::util::Tree)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This utility module provides functions for handling values as tree-data structures.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::util::Tree` to the header of your DataWeave script.

_Introduced in DataWeave version 2.2.2._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-tree-functions-asexpressionstring">asExpressionString</a></p></td><td><p>Transforms a <code>Path</code> value into a string representation of the path.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-tree-functions-filterarrayleafs">filterArrayLeafs</a></p></td><td><p>Applies a filtering expression to leaf or <code>Path</code> values of an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-tree-functions-filterobjectleafs">filterObjectLeafs</a></p></td><td><p>Applies a filtering expression to leaf or <code>Path</code> values of keys in an object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-tree-functions-filtertree">filterTree</a></p></td><td><p>Filters the value or path of nodes in an input based on a specified <code>criteria</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-tree-functions-isarraytype">isArrayType</a></p></td><td><p>Returns <code>true</code> if the provided <code>Path</code> value is an <code>ARRAY_TYPE</code> expression.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-tree-functions-isattributetype">isAttributeType</a></p></td><td><p>Returns <code>true</code> if the provided <code>Path</code> value is an <code>ATTRIBUTE_TYPE</code> expression.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-tree-functions-isobjecttype">isObjectType</a></p></td><td><p>Returns <code>true</code> if the provided <code>Path</code> value is an <code>OBJECT_TYPE</code> expression.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-tree-functions-mapleafvalues">mapLeafValues</a></p></td><td><p>Maps the terminal (leaf) nodes in the tree.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-tree-functions-nodeexists">nodeExists</a></p></td><td><p>Returns <code>true</code> if any node in a given tree validates against the specified criteria.</p></td></tr></tbody></table>

## Variables

- [Tree Variables](https://docs.mulesoft.com/dataweave/2.6/dw-tree-variables)

## Types

- [Tree Types](https://docs.mulesoft.com/dataweave/2.6/dw-tree-types)

<!-- document id=48952152d387e70c6a243ba67e546c932f176caf9720b6996de8cb90a60c9bbc url=/mulesoft/current/en-us/dataweave/2.9/dw-tree.md -->

---
product: DataWeave
version: 2.9
---

# Tree (dw::util::Tree)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This utility module provides functions for handling values as tree-data structures.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::util::Tree` to the header of your DataWeave script.

_Introduced in DataWeave version 2.2.2._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-tree-functions-asexpressionstring">asExpressionString</a></p></td><td><p>Transforms a <code>Path</code> value into a string representation of the path.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-tree-functions-filterarrayleafs">filterArrayLeafs</a></p></td><td><p>Applies a filtering expression to leaf or <code>Path</code> values of an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-tree-functions-filterobjectleafs">filterObjectLeafs</a></p></td><td><p>Applies a filtering expression to leaf or <code>Path</code> values of keys in an object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-tree-functions-filtertree">filterTree</a></p></td><td><p>Filters the value or path of nodes in an input based on a specified <code>criteria</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-tree-functions-isarraytype">isArrayType</a></p></td><td><p>Returns <code>true</code> if the provided <code>Path</code> value is an <code>ARRAY_TYPE</code> expression.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-tree-functions-isattributetype">isAttributeType</a></p></td><td><p>Returns <code>true</code> if the provided <code>Path</code> value is an <code>ATTRIBUTE_TYPE</code> expression.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-tree-functions-isobjecttype">isObjectType</a></p></td><td><p>Returns <code>true</code> if the provided <code>Path</code> value is an <code>OBJECT_TYPE</code> expression.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-tree-functions-mapleafvalues">mapLeafValues</a></p></td><td><p>Maps the terminal (leaf) nodes in the tree.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-tree-functions-nodeexists">nodeExists</a></p></td><td><p>Returns <code>true</code> if any node in a given tree validates against the specified criteria.</p></td></tr></tbody></table>

## Variables

- [Tree Variables](https://docs.mulesoft.com/dataweave/2.9/dw-tree-variables)

## Types

- [Tree Types](https://docs.mulesoft.com/dataweave/2.9/dw-tree-types)

<!-- document id=7e12a5772950879337b2018c3392e9553f9260d38f7b865c525c257878c44dc7 url=/mulesoft/current/en-us/dataweave/latest/dw-tree.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Tree (dw::util::Tree)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This utility module provides functions for handling values as tree-data structures.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::util::Tree` to the header of your DataWeave script.

_Introduced in DataWeave version 2.2.2._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-tree-functions-asexpressionstring">asExpressionString</a></p></td><td><p>Transforms a <code>Path</code> value into a string representation of the path.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-tree-functions-filterarrayleafs">filterArrayLeafs</a></p></td><td><p>Applies a filtering expression to leaf or <code>Path</code> values of an array.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-tree-functions-filterobjectleafs">filterObjectLeafs</a></p></td><td><p>Applies a filtering expression to leaf or <code>Path</code> values of keys in an object.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-tree-functions-filtertree">filterTree</a></p></td><td><p>Filters the value or path of nodes in an input based on a specified <code>criteria</code>.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-tree-functions-isarraytype">isArrayType</a></p></td><td><p>Returns <code>true</code> if the provided <code>Path</code> value is an <code>ARRAY_TYPE</code> expression.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-tree-functions-isattributetype">isAttributeType</a></p></td><td><p>Returns <code>true</code> if the provided <code>Path</code> value is an <code>ATTRIBUTE_TYPE</code> expression.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-tree-functions-isobjecttype">isObjectType</a></p></td><td><p>Returns <code>true</code> if the provided <code>Path</code> value is an <code>OBJECT_TYPE</code> expression.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-tree-functions-mapleafvalues">mapLeafValues</a></p></td><td><p>Maps the terminal (leaf) nodes in the tree.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-tree-functions-nodeexists">nodeExists</a></p></td><td><p>Returns <code>true</code> if any node in a given tree validates against the specified criteria.</p></td></tr></tbody></table>

## Variables

- [Tree Variables](https://docs.mulesoft.com/dataweave/latest/dw-tree-variables)

## Types

- [Tree Types](https://docs.mulesoft.com/dataweave/latest/dw-tree-types)

<!-- document id=d0c037c9460ac74bd080799d0bd469822716c7a34ab2364bd09c8ee2f0283dc4 url=/mulesoft/current/en-us/dataweave/2.11/dw-tree-types.md -->

---
product: DataWeave
version: 2.11
---

# Tree Types (dw::util::Tree)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>Path</p></td><td><div><div><p><code>type Path = Array&lt;PathElement&gt;</code></p></div></div></td><td><div><div><p>Type that consists of an array of <code>PathElement</code> values that identify the location of a node in a tree. An example is <code>[{kind: OBJECT_TYPE, selector: "user", namespace: null}, {kind: ATTRIBUTE_TYPE, selector: "name", namespace: null}] as Path</code>.</p></div><div><p><em>Introduced in DataWeave version 2.2.2.</em></p></div></div></td></tr><tr><td><p>PathElement</p></td><td><div><div><p><code>type PathElement = {| kind: "Object" | "Attribute" | "Array", selector: String | Number, namespace: Namespace | Null |}</code></p></div></div></td><td><div><div><p>Type that represents a selection of a node in a path. An example is <code>{kind: ARRAY_TYPE, selector: "name", namespace: null} as PathElement</code>.</p></div><div><p><em>Introduced in DataWeave version 2.2.2.</em></p></div></div></td></tr></tbody></table>

<!-- document id=28e1ac4c00a8053fc2edf5272bc983e92cf8aa68e006a65c5fc47d9ee08ab231 url=/mulesoft/current/en-us/dataweave/2.12/dw-tree-types.md -->

---
product: DataWeave
version: 2.12
---

# Tree Types (dw::util::Tree)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>Path</p></td><td><div><div><p><code>type Path = Array&lt;PathElement&gt;</code></p></div></div></td><td><div><div><p>Type that consists of an array of <code>PathElement</code> values that identify the location of a node in a tree. An example is <code>[{kind: OBJECT_TYPE, selector: "user", namespace: null}, {kind: ATTRIBUTE_TYPE, selector: "name", namespace: null}] as Path</code>.</p></div><div><p><em>Introduced in DataWeave version 2.2.2.</em></p></div></div></td></tr><tr><td><p>PathElement</p></td><td><div><div><p><code>type PathElement = {| kind: "Object" | "Attribute" | "Array", selector: String | Number, namespace: Namespace | Null |}</code></p></div></div></td><td><div><div><p>Type that represents a selection of a node in a path. An example is <code>{kind: ARRAY_TYPE, selector: "name", namespace: null} as PathElement</code>.</p></div><div><p><em>Introduced in DataWeave version 2.2.2.</em></p></div></div></td></tr></tbody></table>

<!-- document id=8bcbdabdc0e9808f46345e4965e63a3534abd045f3e0cf07c81d47f51c52d356 url=/mulesoft/current/en-us/dataweave/2.3/dw-tree-types.md -->

---
product: DataWeave
version: 2.3
---

# Tree Types (dw::util::Tree)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>Path</p></td><td><p><code>type Path = Array&lt;PathElement&gt;</code></p></td><td><p>Represents an array of <code>PathElement</code> types that identify the location of a node in a tree.</p></td></tr><tr><td><p>PathElement</p></td><td><p><code>type PathElement = {| // {options: ["Object","Attribute","Array"]} kind: String, selector: String | Number, namespace: Namespace | Null |}</code></p></td><td><p>Represents a specific selection of a node in a path.</p></td></tr></tbody></table>

<!-- document id=574157446c691ce839245914b0ce8ba36c9f8d5c5c7ada4651f2a188987e97fd url=/mulesoft/current/en-us/dataweave/2.4/dw-tree-types.md -->

---
product: DataWeave
version: 2.4
---

# Tree Types (dw::util::Tree)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>Path</p></td><td><div><div><p><code>type Path = Array&lt;PathElement&gt;</code></p></div></div></td><td><div><div><p>Type that consists of an array of <code>PathElement</code> values that identify the location of a node in a tree. An example is <code>[{kind: OBJECT_TYPE, selector: "user", namespace: null}, {kind: ATTRIBUTE_TYPE, selector: "name", namespace: null}] as Path</code>.</p></div><div><p><em>Introduced in DataWeave version 2.2.2.</em></p></div></div></td></tr><tr><td><p>PathElement</p></td><td><div><div><p><code>type PathElement = {| kind: "Object" | "Attribute" | "Array", selector: String | Number, namespace: Namespace | Null |}</code></p></div></div></td><td><div><div><p>Type that represents a selection of a node in a path. An example is <code>{kind: ARRAY_TYPE, selector: "name", namespace: null} as PathElement</code>.</p></div><div><p><em>Introduced in DataWeave version 2.2.2.</em></p></div></div></td></tr></tbody></table>

<!-- document id=a29613d048664bb9af5fc15fe0e8ca00347d531d0f7054bf9bee11cfda215ca9 url=/mulesoft/current/en-us/dataweave/2.6/dw-tree-types.md -->

---
product: DataWeave
version: 2.6
---

# Tree Types (dw::util::Tree)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>Path</p></td><td><div><div><p><code>type Path = Array&lt;PathElement&gt;</code></p></div></div></td><td><div><div><p>Type that consists of an array of <code>PathElement</code> values that identify the location of a node in a tree. An example is <code>[{kind: OBJECT_TYPE, selector: "user", namespace: null}, {kind: ATTRIBUTE_TYPE, selector: "name", namespace: null}] as Path</code>.</p></div><div><p><em>Introduced in DataWeave version 2.2.2.</em></p></div></div></td></tr><tr><td><p>PathElement</p></td><td><div><div><p><code>type PathElement = {| kind: "Object" | "Attribute" | "Array", selector: String | Number, namespace: Namespace | Null |}</code></p></div></div></td><td><div><div><p>Type that represents a selection of a node in a path. An example is <code>{kind: ARRAY_TYPE, selector: "name", namespace: null} as PathElement</code>.</p></div><div><p><em>Introduced in DataWeave version 2.2.2.</em></p></div></div></td></tr></tbody></table>

<!-- document id=1859e65b43ceb33e0da8383fe8f30a3f9d3cf97f57ca77389effa415eecabedf url=/mulesoft/current/en-us/dataweave/2.9/dw-tree-types.md -->

---
product: DataWeave
version: 2.9
---

# Tree Types (dw::util::Tree)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>Path</p></td><td><div><div><p><code>type Path = Array&lt;PathElement&gt;</code></p></div></div></td><td><div><div><p>Type that consists of an array of <code>PathElement</code> values that identify the location of a node in a tree. An example is <code>[{kind: OBJECT_TYPE, selector: "user", namespace: null}, {kind: ATTRIBUTE_TYPE, selector: "name", namespace: null}] as Path</code>.</p></div><div><p><em>Introduced in DataWeave version 2.2.2.</em></p></div></div></td></tr><tr><td><p>PathElement</p></td><td><div><div><p><code>type PathElement = {| kind: "Object" | "Attribute" | "Array", selector: String | Number, namespace: Namespace | Null |}</code></p></div></div></td><td><div><div><p>Type that represents a selection of a node in a path. An example is <code>{kind: ARRAY_TYPE, selector: "name", namespace: null} as PathElement</code>.</p></div><div><p><em>Introduced in DataWeave version 2.2.2.</em></p></div></div></td></tr></tbody></table>

<!-- document id=9675f28a0c8a488974a64e12fed4bbf5ea7d74349cc8f51abd2ee18f85cb0b94 url=/mulesoft/current/en-us/dataweave/latest/dw-tree-types.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Tree Types (dw::util::Tree)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>Path</p></td><td><div><div><p><code>type Path = Array&lt;PathElement&gt;</code></p></div></div></td><td><div><div><p>Type that consists of an array of <code>PathElement</code> values that identify the location of a node in a tree. An example is <code>[{kind: OBJECT_TYPE, selector: "user", namespace: null}, {kind: ATTRIBUTE_TYPE, selector: "name", namespace: null}] as Path</code>.</p></div><div><p><em>Introduced in DataWeave version 2.2.2.</em></p></div></div></td></tr><tr><td><p>PathElement</p></td><td><div><div><p><code>type PathElement = {| kind: "Object" | "Attribute" | "Array", selector: String | Number, namespace: Namespace | Null |}</code></p></div></div></td><td><div><div><p>Type that represents a selection of a node in a path. An example is <code>{kind: ARRAY_TYPE, selector: "name", namespace: null} as PathElement</code>.</p></div><div><p><em>Introduced in DataWeave version 2.2.2.</em></p></div></div></td></tr></tbody></table>

<!-- document id=a6a7bbf1a1a973e048d66187fd3b90c81141f6991f4078e5a77e7bdeccab2410 url=/mulesoft/current/en-us/dataweave/2.11/dw-tree-variables.md -->

---
product: DataWeave
version: 2.11
---

# Tree Variables (dw::util::Tree)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Variable</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>ARRAY_TYPE</p></td><td><div><div><p><code>ARRAY_TYPE</code></p></div></div></td><td><div><div><p>Variable used to identify a <code>PathElement</code> value as an array.</p></div><div><p><em>Introduced in DataWeave version 2.2.2.</em></p></div></div></td></tr><tr><td><p>ATTRIBUTE_TYPE</p></td><td><div><div><p><code>ATTRIBUTE_TYPE</code></p></div></div></td><td><div><div><p>Variable used to identify a <code>PathElement</code> value as an attribute.</p></div><div><p><em>Introduced in DataWeave version 2.2.2.</em></p></div></div></td></tr><tr><td><p>OBJECT_TYPE</p></td><td><div><div><p><code>OBJECT_TYPE</code></p></div></div></td><td><div><div><p>Variable used to identify a <code>PathElement</code> value as an object.</p></div><div><p><em>Introduced in DataWeave version 2.2.2.</em></p></div></div></td></tr></tbody></table>

<!-- document id=6413f184a8926543dd560b7e7f77e4fd295a4564915dede243da0deab6a06b8c url=/mulesoft/current/en-us/dataweave/2.12/dw-tree-variables.md -->

---
product: DataWeave
version: 2.12
---

# Tree Variables (dw::util::Tree)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Variable</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>ARRAY_TYPE</p></td><td><div><div><p><code>ARRAY_TYPE</code></p></div></div></td><td><div><div><p>Variable used to identify a <code>PathElement</code> value as an array.</p></div><div><p><em>Introduced in DataWeave version 2.2.2.</em></p></div></div></td></tr><tr><td><p>ATTRIBUTE_TYPE</p></td><td><div><div><p><code>ATTRIBUTE_TYPE</code></p></div></div></td><td><div><div><p>Variable used to identify a <code>PathElement</code> value as an attribute.</p></div><div><p><em>Introduced in DataWeave version 2.2.2.</em></p></div></div></td></tr><tr><td><p>OBJECT_TYPE</p></td><td><div><div><p><code>OBJECT_TYPE</code></p></div></div></td><td><div><div><p>Variable used to identify a <code>PathElement</code> value as an object.</p></div><div><p><em>Introduced in DataWeave version 2.2.2.</em></p></div></div></td></tr></tbody></table>

<!-- document id=98e8e1653e48d6508083adbb3824c98b847b0ab428f79250d5565b2eb1ddf26d url=/mulesoft/current/en-us/dataweave/2.3/dw-tree-variables.md -->

---
product: DataWeave
version: 2.3
---

# Tree Variables (dw::util::Tree)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Variable</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>ARRAY_TYPE</p></td><td><p><code>ARRAY_TYPE</code></p></td><td><p>Variable used to identify a <code>PathElement</code> value as an array.</p><p><em>Introduced in DataWeave version 2.2.2.</em></p></td></tr><tr><td><p>ATTRIBUTE_TYPE</p></td><td><p><code>ATTRIBUTE_TYPE</code></p></td><td><p>Variable used to identify a <code>PathElement</code> value as an attribute.</p><p><em>Introduced in DataWeave version 2.2.2.</em></p></td></tr><tr><td><p>OBJECT_TYPE</p></td><td><p><code>OBJECT_TYPE</code></p></td><td><p>Variable used to identify a <code>PathElement</code> value as an object.</p><p><em>Introduced in DataWeave version 2.2.2.</em></p></td></tr></tbody></table>

<!-- document id=6cf31c6514d6faad2934c93784edf754890b6e9d48bb66f633c08926595f0305 url=/mulesoft/current/en-us/dataweave/2.4/dw-tree-variables.md -->

---
product: DataWeave
version: 2.4
---

# Tree Variables (dw::util::Tree)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Variable</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>ARRAY_TYPE</p></td><td><div><div><p><code>ARRAY_TYPE</code></p></div></div></td><td><div><div><p>Variable used to identify a <code>PathElement</code> value as an array.</p></div><div><p><em>Introduced in DataWeave version 2.2.2.</em></p></div></div></td></tr><tr><td><p>ATTRIBUTE_TYPE</p></td><td><div><div><p><code>ATTRIBUTE_TYPE</code></p></div></div></td><td><div><div><p>Variable used to identify a <code>PathElement</code> value as an attribute.</p></div><div><p><em>Introduced in DataWeave version 2.2.2.</em></p></div></div></td></tr><tr><td><p>OBJECT_TYPE</p></td><td><div><div><p><code>OBJECT_TYPE</code></p></div></div></td><td><div><div><p>Variable used to identify a <code>PathElement</code> value as an object.</p></div><div><p><em>Introduced in DataWeave version 2.2.2.</em></p></div></div></td></tr></tbody></table>

<!-- document id=dd9edbfbb2eb2caba859627907a41c4704df25b10909ad55b4932c2b1b910652 url=/mulesoft/current/en-us/dataweave/2.6/dw-tree-variables.md -->

---
product: DataWeave
version: 2.6
---

# Tree Variables (dw::util::Tree)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Variable</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>ARRAY_TYPE</p></td><td><div><div><p><code>ARRAY_TYPE</code></p></div></div></td><td><div><div><p>Variable used to identify a <code>PathElement</code> value as an array.</p></div><div><p><em>Introduced in DataWeave version 2.2.2.</em></p></div></div></td></tr><tr><td><p>ATTRIBUTE_TYPE</p></td><td><div><div><p><code>ATTRIBUTE_TYPE</code></p></div></div></td><td><div><div><p>Variable used to identify a <code>PathElement</code> value as an attribute.</p></div><div><p><em>Introduced in DataWeave version 2.2.2.</em></p></div></div></td></tr><tr><td><p>OBJECT_TYPE</p></td><td><div><div><p><code>OBJECT_TYPE</code></p></div></div></td><td><div><div><p>Variable used to identify a <code>PathElement</code> value as an object.</p></div><div><p><em>Introduced in DataWeave version 2.2.2.</em></p></div></div></td></tr></tbody></table>

<!-- document id=24cba7277e868e3d14b9573d83c3cb59aa1880193730261ef040103b045fc277 url=/mulesoft/current/en-us/dataweave/2.9/dw-tree-variables.md -->

---
product: DataWeave
version: 2.9
---

# Tree Variables (dw::util::Tree)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Variable</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>ARRAY_TYPE</p></td><td><div><div><p><code>ARRAY_TYPE</code></p></div></div></td><td><div><div><p>Variable used to identify a <code>PathElement</code> value as an array.</p></div><div><p><em>Introduced in DataWeave version 2.2.2.</em></p></div></div></td></tr><tr><td><p>ATTRIBUTE_TYPE</p></td><td><div><div><p><code>ATTRIBUTE_TYPE</code></p></div></div></td><td><div><div><p>Variable used to identify a <code>PathElement</code> value as an attribute.</p></div><div><p><em>Introduced in DataWeave version 2.2.2.</em></p></div></div></td></tr><tr><td><p>OBJECT_TYPE</p></td><td><div><div><p><code>OBJECT_TYPE</code></p></div></div></td><td><div><div><p>Variable used to identify a <code>PathElement</code> value as an object.</p></div><div><p><em>Introduced in DataWeave version 2.2.2.</em></p></div></div></td></tr></tbody></table>

<!-- document id=1fc3d9972e9d7057e6ff240308d11b0515d9425ce1eebd07b6d4ab9b292ed4d7 url=/mulesoft/current/en-us/dataweave/latest/dw-tree-variables.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Tree Variables (dw::util::Tree)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Variable</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>ARRAY_TYPE</p></td><td><div><div><p><code>ARRAY_TYPE</code></p></div></div></td><td><div><div><p>Variable used to identify a <code>PathElement</code> value as an array.</p></div><div><p><em>Introduced in DataWeave version 2.2.2.</em></p></div></div></td></tr><tr><td><p>ATTRIBUTE_TYPE</p></td><td><div><div><p><code>ATTRIBUTE_TYPE</code></p></div></div></td><td><div><div><p>Variable used to identify a <code>PathElement</code> value as an attribute.</p></div><div><p><em>Introduced in DataWeave version 2.2.2.</em></p></div></div></td></tr><tr><td><p>OBJECT_TYPE</p></td><td><div><div><p><code>OBJECT_TYPE</code></p></div></div></td><td><div><div><p>Variable used to identify a <code>PathElement</code> value as an object.</p></div><div><p><em>Introduced in DataWeave version 2.2.2.</em></p></div></div></td></tr></tbody></table>

<!-- document id=67fbe19db6bb1a7b4466df0d1feddb908a245e1441b0fcf5329afa92c6319396 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-trim.md -->

---
product: DataWeave
version: 2.11
---

# trim

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## trim(text: String): String

Removes any blank spaces from the beginning and end of a string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string from which to remove any blank spaces.</p></td></tr></tbody></table>

### Example

This example trims a string. Notice that it does not remove any spaces from the middle of the
string, only the beginning and end.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "trim": trim("   my really long  text     ") }
```

#### Output

```JSON
{ "trim": "my really long  text" }
```

### Example

This example shows how `trim` handles a variety strings and how it handles a null value.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  "null": trim(null),
  "empty": trim(""),
  "blank": trim("     "),
  "noBlankSpaces": trim("abc"),
  "withSpaces": trim("    abc    ")
}
```

#### Output

```JSON
{
  "null": null,
  "empty": "",
  "blank": "",
  "noBlankSpaces": "abc",
  "withSpaces": "abc"
}
```

## trim(value: Null): Null

Helper function that enables `trim` to work with a `null` value.

<!-- document id=5f36e73555b302bfbfb2074dfb6efcdd4d4faed272c9485f00bb5e0f6b53fe95 url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-trim.md -->

---
product: DataWeave
version: 2.12
---

# trim

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## trim(text: String): String

Removes any blank spaces from the beginning and end of a string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string from which to remove any blank spaces.</p></td></tr></tbody></table>

### Example

This example trims a string. Notice that it does not remove any spaces from the middle of the
string, only the beginning and end.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "trim": trim("   my really long  text     ") }
```

#### Output

```JSON
{ "trim": "my really long  text" }
```

### Example

This example shows how `trim` handles a variety strings and how it handles a null value.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  "null": trim(null),
  "empty": trim(""),
  "blank": trim("     "),
  "noBlankSpaces": trim("abc"),
  "withSpaces": trim("    abc    ")
}
```

#### Output

```JSON
{
  "null": null,
  "empty": "",
  "blank": "",
  "noBlankSpaces": "abc",
  "withSpaces": "abc"
}
```

## trim(value: Null): Null

Helper function that enables `trim` to work with a `null` value.

<!-- document id=838688984aaf31b4ee8a41a82da5a982f609d4a17961ae385bdaee6f0c07ec1d url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-trim.md -->

---
product: DataWeave
version: 2.3
---

# trim

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## trim(String): String

Removes any blank spaces from the beginning and end of a string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string from which to remove any blank spaces.</p></td></tr></tbody></table>

### Example

This example trims a string. Notice that it does not remove any spaces from the middle of the
string, only the beginning and end.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "trim": trim("   my really long  text     ") }
```

#### Output

```JSON
{ "trim": "my really long  text" }
```

### Example

This example shows how `trim` handles a variety strings and how it handles a null value.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  "null": trim(null),
  "empty": trim(""),
  "blank": trim("     "),
  "noBlankSpaces": trim("abc"),
  "withSpaces": trim("    abc    ")
}
```

#### Output

```JSON
{
  "null": null,
  "empty": "",
  "blank": "",
  "noBlankSpaces": "abc",
  "withSpaces": "abc"
}
```

## trim(Null): Null

Helper function that enables `trim` to work with a `null` value.

<!-- document id=10724c2b6c0c7d3cce95bd4e53132fa78a41fdc05c40b560d8ba1e3c1159aa8b url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-trim.md -->

---
product: DataWeave
version: 2.4
---

# trim

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## trim(text: String): String

Removes any blank spaces from the beginning and end of a string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string from which to remove any blank spaces.</p></td></tr></tbody></table>

### Example

This example trims a string. Notice that it does not remove any spaces from the middle of the
string, only the beginning and end.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "trim": trim("   my really long  text     ") }
```

#### Output

```JSON
{ "trim": "my really long  text" }
```

### Example

This example shows how `trim` handles a variety strings and how it handles a null value.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  "null": trim(null),
  "empty": trim(""),
  "blank": trim("     "),
  "noBlankSpaces": trim("abc"),
  "withSpaces": trim("    abc    ")
}
```

#### Output

```JSON
{
  "null": null,
  "empty": "",
  "blank": "",
  "noBlankSpaces": "abc",
  "withSpaces": "abc"
}
```

## trim(value: Null): Null

Helper function that enables `trim` to work with a `null` value.

<!-- document id=6682c130a7cdc63e24b78f6e3c986488a8db0411e398c5c1b1690295442981fd url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-trim.md -->

---
product: DataWeave
version: 2.6
---

# trim

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## trim(text: String): String

Removes any blank spaces from the beginning and end of a string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string from which to remove any blank spaces.</p></td></tr></tbody></table>

### Example

This example trims a string. Notice that it does not remove any spaces from the middle of the
string, only the beginning and end.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "trim": trim("   my really long  text     ") }
```

#### Output

```JSON
{ "trim": "my really long  text" }
```

### Example

This example shows how `trim` handles a variety strings and how it handles a null value.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  "null": trim(null),
  "empty": trim(""),
  "blank": trim("     "),
  "noBlankSpaces": trim("abc"),
  "withSpaces": trim("    abc    ")
}
```

#### Output

```JSON
{
  "null": null,
  "empty": "",
  "blank": "",
  "noBlankSpaces": "abc",
  "withSpaces": "abc"
}
```

## trim(value: Null): Null

Helper function that enables `trim` to work with a `null` value.

<!-- document id=e2a1a7ae1e2024eecb68b9821e5ef0bf76edeae61f05df00b7d84f4be7f3b496 url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-trim.md -->

---
product: DataWeave
version: 2.9
---

# trim

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## trim(text: String): String

Removes any blank spaces from the beginning and end of a string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string from which to remove any blank spaces.</p></td></tr></tbody></table>

### Example

This example trims a string. Notice that it does not remove any spaces from the middle of the
string, only the beginning and end.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "trim": trim("   my really long  text     ") }
```

#### Output

```JSON
{ "trim": "my really long  text" }
```

### Example

This example shows how `trim` handles a variety strings and how it handles a null value.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  "null": trim(null),
  "empty": trim(""),
  "blank": trim("     "),
  "noBlankSpaces": trim("abc"),
  "withSpaces": trim("    abc    ")
}
```

#### Output

```JSON
{
  "null": null,
  "empty": "",
  "blank": "",
  "noBlankSpaces": "abc",
  "withSpaces": "abc"
}
```

## trim(value: Null): Null

Helper function that enables `trim` to work with a `null` value.

<!-- document id=9e12494e1d367c34eb0e677df52f35f0bf2d9e2eebd009f4320f4c9167790e76 url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-trim.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# trim

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## trim(text: String): String

Removes any blank spaces from the beginning and end of a string.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string from which to remove any blank spaces.</p></td></tr></tbody></table>

### Example

This example trims a string. Notice that it does not remove any spaces from the middle of the
string, only the beginning and end.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "trim": trim("   my really long  text     ") }
```

#### Output

```JSON
{ "trim": "my really long  text" }
```

### Example

This example shows how `trim` handles a variety strings and how it handles a null value.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  "null": trim(null),
  "empty": trim(""),
  "blank": trim("     "),
  "noBlankSpaces": trim("abc"),
  "withSpaces": trim("    abc    ")
}
```

#### Output

```JSON
{
  "null": null,
  "empty": "",
  "blank": "",
  "noBlankSpaces": "abc",
  "withSpaces": "abc"
}
```

## trim(value: Null): Null

Helper function that enables `trim` to work with a `null` value.

<!-- document id=e59c78ce00665c462990aa7fba3cf5739aca41cbad3579b3dd644724942c7f5e url=/mulesoft/current/en-us/dataweave/2.11/dataweave-troubleshoot.md -->

---
product: DataWeave
version: 2.11
---

# Troubleshooting a Failing DataWeave Script

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

When you troubleshoot a failing script, one challenge to reproducing an error is having the same
inputs the script had when it executed, especially in production environments where inputs can
change unexpectedly. Therefore, it’s important to capture the inputs going into a script debugging
or using loggers. Often, the failures occur because the input coming from another component upstream
is not valid. You can find here a listing of the most common DataWeave errors and how to overcome
them.

## Dump Input Context and the Script into a Folder

In Mule 4.2.1, DataWeave introduced an experimental feature that enables you to dump the input
context and the failing script into a folder so that you can track the failing script along with the
data that makes the script fail. This tool is particularly useful for checking that received input
data is valid because incorrect scripts often fail when an upstream component generates invalid
data.

To use this feature:

1.  Set the following system property to enable the dump feature:

    `-M-Dcom.mulesoft.dw.dump_files=true`

2.  \[Optional\] Specify the path in which to generate the dump files:

    `-M-Dcom.mulesoft.dw.dump_folder=<path_to_folder>`

    The default directory is set in the `java.io.tmpdir` property.

## DataWeave Exceptions

The following are some common DataWeave exceptions that you can find in your dump file, along with
some details to troubleshoot these errors.

### Incorrect Arguments

When a function is called with the incorrect kind of argument, it throws the exception,
`org.mule.weave.v2.exception.UnsupportedTypeCoercionException`. Causes of this exception include:

- [Function Does Not Accept Null Argument](#null_arg_not_accepted)

- [MIME Type Is Not Set](#mimetype_unset)

#### Function Does Not Accept Null Argument

The most common cause of this exception occurs when one of the arguments is `Null` and the function
does not accept `Null` as an argument. This issue results in an error message similar to the
following:

```weave
You called the function '++' with these arguments:
  1: Null (null)
  2: String (" A text")

But it expects one of these combinations:
  (Array, Array)
  (Date, Time)
  (Date, LocalTime)
  (Date, TimeZone)
  (LocalDateTime, TimeZone)
  (LocalTime, Date)
  (LocalTime, TimeZone)
  (Object, Object)
  (String, String)
  (Time, Date)
  (TimeZone, LocalDateTime)
  (TimeZone, Date)
  (TimeZone, LocalTime)

1| payload.message ++ " A text"
   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Trace:
  at ++ (line: 1, column: 1)
  at main (line: 1, column: 17)
```

One way to resolve this issue uses the `default` operator. For example, using
`payload.message default "" ++ " A text"` appends empty text when the message is null.

#### MIME Type Is Not Set

When the MIME type is not set, you receive an error message similar to the following:

```weave
You called the function 'Value Selector' with these arguments:

  1: String ("{ \"message\": 123}")
  2: Name ("message")

But it expects one of these combinations:
  (Array, Name)
  (Array, String)
  (Date, Name)
  (DateTime, Name)
  (LocalDateTime, Name)
  (LocalTime, Name)
  (Object, Name)
  (Object, String)
  (Period, Name)
  (Time, Name)

1| payload.message
   ^^^^^^^^^^^^^^^
Trace:
  at main (line: 1, column: 1)
```

When no MIME type is set on the payload, the MIME type defaults to `application/java`, and the
content is handled as a `String` instead of a JSON object.

### Reader Properties Not Working In a Mule Application

In a Mule application, the `input` directive to a DataWeave script does not work. Unlike Mule
runtime, a standalone DataWeave runtime, such as the one in the
[DataWeave Playground+](https://dataweave.mulesoft.com/learn/), can process a valid MIME type set
through the `input` directive in the same DataWeave script. To input reader properties to a script
in a Mule application, configure the `outputMimeType` attribute for the data source to produce the
same results. See
[Using Reader and Writer Properties](https://docs.mulesoft.com/dataweave/2.11/dataweave-formats#using-reader-and-writer-properties) for
further details.

### Stack Overflow

When a function recurses too deeply, an error like the following one is thrown:

```weave
Stack Overflow. Max stack is 256
```

You can configure the maximum stack size by using the property `com.mulesoft.dw.stacksize`.

### No space left on device

To handle large payloads, DataWeave generates data that is handled in memory unless the payload
exceeds a configurable limit. If the payload exceeds the limit, the data is stored on disk as
output, input, and buffer files in a temporary directory. See
[DataWeave Memory Management](https://docs.mulesoft.com/dataweave/2.11/dataweave-memory-management) for further details.

When the streams that reference the files are closed, the files are released. Closure normally
occurs when flows complete their execution, so many buffer files in the temporary folder can remain
in use during long-running and concurrent executions.

To avoid the exception `No space left on device`, try to provide more resources to run the
application, or determine whether you can reduce the application’s resource consumption.

Sometimes bugs prevent the release of the files even after the flow has completed. If the latest
Mule release does not fix this issue, please report the issue to the MuleSoft support team.

### Closed Streams

Input data that reaches DataWeave is usually a stream. Mule handles the stream and adds auto-closing
and repeatable capabilities to it by generating “cursors” over the stream. Sometimes a stream closes
prematurely, before it reaches the DataWeave script, and it can be difficult to understand what
closed it. In these circumstances, the script fails with an error similar to
`Cannot open a new cursor on a closed stream`.

If this error occurs in latest Mule update, please report it to the MuleSoft support team. It is not
possible to work around the issue, but you can use the `com.mulesoft.dw.track.cursor.close` system
property to determine which component closed the stream prematurely. With the property set, the
error shows the stack trace from the moment that the stream was closed, which points to the
component that triggered the closure.

### Output Mismatch When Undefined

Unlike transformations, DataWeave expressions do not require you to define an output format because
DataWeave can infer the output based on the expression and the variables you use. Occasionally, the
inference process results in a mismatch between the inferred type and the expected type. To resolve
this issue, you must make the output explicit. Common examples of this situation occur when:

- [Extract Data from XML](#xml_extraction)

- [Handle Multipart Entries](#multipart_handling)

- [Manipulate Text Data](#manipulating_text)

#### Extract Data from XML

When extracting a String, for example, from an XML payload with the expression
`payload.order.product.model`, DataWeave infers an XML output based on the payload format. In such
cases, an error similar to the following one occurs:

```weave
"Trying to output non-whitespace characters outside main element tree (in prolog or epilog), while writing Xml at ." evaluating expression: "payload.order.product.model".
```

For such an error, you must make the output format explicit, for example:
`output text/plain --- payload.order.product.model`.

#### Handle Multipart Entries

A common inference error occurs with multipart data, which has a very specific structure. Consider a
multipart payload and the expression `dw::core::Objects::keySet(payload.parts)`. Without an explicit
output format, DataWeave must infer, based on the payload type, that you intend to output multipart
content. In this case, an error similar to the following is thrown:

```weave
"Expecting type is {
  preamble?: String,
  parts: {
    _*: {
      headers: Object,
      content: Any
    }
  }
} but got Array, while writing MultiPart.
Trace:
  at main (Unknown)" evaluating expression: "dw::core::Objects::keySet(payload.parts)".
```

To resolve this issue, you must define an output format, for example:
`output application/json --- dw::core::Objects::keySet(payload.parts)`

#### Manipulate Text Data

You can use text data to create a more complex object. However, if you do not define the output
format for the input text data, DataWeave infers that it must use the plain text writer for the
output. The expression `payload splitBy ' '`, for example, will fail with an error similar to:

```weave
"Text plain writer is unable to write Array.
Reason:
Cannot coerce Array (org.mule.weave.v2.model.values.ArrayValue$ArraySeqArrayValue@1331b353) to String
Trace:
  at main (Unknown), while writing TextPlain.
Trace:
  at main (Unknown)" evaluating expression: "payload splitBy ' '".
```

Making the output explicit solves the issue: `output application/java --- payload splitBy ' '`

### Encoding Issues

Encoding issues can occur because of a mismatch between encodings used to read and write a file or
when the encoding to write some text does not support some of the characters. Common examples
include the following:

- [Incorrect Encoding for the Reader](#reader_encoding)

- [Encoding Used by the Writer Does Not Support Some Characters](#writer_encoding)

- [Multipart/Form-Data Reader Does Not Support UTF-8 Characters by Default](#multipart_reader)

#### Incorrect Encoding for the Reader

In Mule, when you use components or connector operations that provide a `MIME Type` configuration
(such as `Set Payload`, `File Read`, `HTTP Listener`), check that the encoding you set corresponds
to the encoding used to write the payload. DataWeave reads the encoding that you set in the
`MIME Type` configuration.

If you do not set the MIME type, DataWeave uses the default encoding provided by Mule through the
`mule.encoding` system property.

#### Encoding Used by the Writer Does Not Support Some Characters

Check that your writer encoding supports the characters that you are trying to write.

For example, writing the text `"～―－＄￠￡㈱①"` with the encoding `sjis` outputs `"???＄????"`
because many of the input characters are not supported in that encoding (unlike UTF-8, for example).

```weave
%dw 2.0
output application/json encoding="sjis"
---
"～―－＄￠￡㈱①"
```

#### Multipart/Form-Data Reader Does Not Support UTF-8 Characters by Default

If you use UTF-8 characters in the multipart filenames, the non-ASCII characters in the names are
corrupted.

Set the following system property to enable support for UTF-8 in multipart:
`-M-Dmail.mime.allowutf8=true`

For example, posting a multipart payload with filename=`不明.txt` without setting the `allowutf8`
property to `true` produces the following unreadable text for the `filename` field:

```weave
{
  "Content-Disposition": {
    name: "file",
    filename: "ä\ufffd\ufffd明.txt",
    subtype: "form-data"
  },
  "Content-Type": "text/plain"
}
```

## DataWeave Warnings

The following are some common DataWeave warnings that appear in your dump file, along with some
details to address these warnings.

### End of Input Was Reached

This warning appears because DataWeave treats the Unicode non-character `U+FFFF` as a special
character that indicates the end of input.

To avoid this warning, replace the special character in the raw payload and then proceed as usual.

```weave
read(payload.^raw replace "\uFFFF" with "NonChar")
```

## Low Performance Issues

### application/dw Format

Using `output application/dw` format can impact the performance of transformations. This format is
intended to help you debug the results of DataWeave transformations. It is significantly slower than
other formats, so avoid using this format in production applications.

### multipart/form-data Content Parsing

For `multipart/form-data` inputs, accessing content of a large part can cause performance
degradation, especially for high-memory formats like `application/xlsx`, because the interpreter
attempts to parse the content of the part for further querying and analysis.

You can use the `^raw` selector to avoid parsing binary contents of parts.

The following example uses the `^raw` selector on specific operations over each part.

#### Input

```text
--myboundary
Content-Disposition: form-data; name="file1"; filename="a.json"
Content-Type: application/json

{
"title": "Java 8 in Action",
"author": "Mario Fusco",
"year": 2014
}
--myboundary
Content-Disposition: form-data; name="file2"; filename="a.xml"
Content-Type: application/xml

<doc>
    <title> Available for download! </title>
    <content> Really large content </content>
</doc>
--myboundary--
```

#### Source

```weave
%dw 2.0
input payload multipart boundary='myboundary'
output application/json
---
payload.parts mapObject ((value, key, index) ->
{
    (key): {
	fileName: payload.parts[index].headers.'Content-Disposition'.filename,
    rawContent: payload.parts[index].content.^raw
    }
})
```

## See Also

- [Known Issues](https://help.salesforce.com/s/issues)

<!-- document id=b025a02665fa323c51d223c47576175c9b4695b5024f1f64bd7840e7a28c8be9 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-troubleshoot.md -->

---
product: DataWeave
version: 2.12
---

# Troubleshooting a Failing DataWeave Script

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

When you troubleshoot a failing script, one challenge to reproducing an error is having the same
inputs the script had when it executed, especially in production environments where inputs can
change unexpectedly. Therefore, it’s important to capture the inputs going into a script debugging
or using loggers. Often, the failures occur because the input coming from another component upstream
is not valid. You can find here a listing of the most common DataWeave errors and how to overcome
them.

## Dump Input Context and the Script into a Folder

In Mule 4.2.1, DataWeave introduced an experimental feature that enables you to dump the input
context and the failing script into a folder so that you can track the failing script along with the
data that makes the script fail. This tool is particularly useful for checking that received input
data is valid because incorrect scripts often fail when an upstream component generates invalid
data.

To use this feature:

1.  Set the following system property to enable the dump feature:

    `-M-Dcom.mulesoft.dw.dump_files=true`

2.  \[Optional\] Specify the path in which to generate the dump files:

    `-M-Dcom.mulesoft.dw.dump_folder=<path_to_folder>`

    The default directory is set in the `java.io.tmpdir` property.

## DataWeave Exceptions

The following are some common DataWeave exceptions that you can find in your dump file, along with
some details to troubleshoot these errors.

### Incorrect Arguments

When a function is called with the incorrect kind of argument, it throws the exception,
`org.mule.weave.v2.exception.UnsupportedTypeCoercionException`. Causes of this exception include:

- [Function Does Not Accept Null Argument](#null_arg_not_accepted)

- [MIME Type Is Not Set](#mimetype_unset)

#### Function Does Not Accept Null Argument

The most common cause of this exception occurs when one of the arguments is `Null` and the function
does not accept `Null` as an argument. This issue results in an error message similar to the
following:

```weave
You called the function '++' with these arguments:
  1: Null (null)
  2: String (" A text")

But it expects one of these combinations:
  (Array, Array)
  (Date, Time)
  (Date, LocalTime)
  (Date, TimeZone)
  (LocalDateTime, TimeZone)
  (LocalTime, Date)
  (LocalTime, TimeZone)
  (Object, Object)
  (String, String)
  (Time, Date)
  (TimeZone, LocalDateTime)
  (TimeZone, Date)
  (TimeZone, LocalTime)

1| payload.message ++ " A text"
   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Trace:
  at ++ (line: 1, column: 1)
  at main (line: 1, column: 17)
```

One way to resolve this issue uses the `default` operator. For example, using
`payload.message default "" ++ " A text"` appends empty text when the message is null.

#### MIME Type Is Not Set

When the MIME type is not set, you receive an error message similar to the following:

```weave
You called the function 'Value Selector' with these arguments:

  1: String ("{ \"message\": 123}")
  2: Name ("message")

But it expects one of these combinations:
  (Array, Name)
  (Array, String)
  (Date, Name)
  (DateTime, Name)
  (LocalDateTime, Name)
  (LocalTime, Name)
  (Object, Name)
  (Object, String)
  (Period, Name)
  (Time, Name)

1| payload.message
   ^^^^^^^^^^^^^^^
Trace:
  at main (line: 1, column: 1)
```

When no MIME type is set on the payload, the MIME type defaults to `application/java`, and the
content is handled as a `String` instead of a JSON object.

### Reader Properties Not Working In a Mule Application

In a Mule application, the `input` directive to a DataWeave script does not work. Unlike Mule
runtime, a standalone DataWeave runtime, such as the one in the
[DataWeave Playground+](https://dataweave.mulesoft.com/learn/), can process a valid MIME type set
through the `input` directive in the same DataWeave script. To input reader properties to a script
in a Mule application, configure the `outputMimeType` attribute for the data source to produce the
same results. See
[Using Reader and Writer Properties](https://docs.mulesoft.com/dataweave/2.12/dataweave-formats#using-reader-and-writer-properties) for
further details.

### Stack Overflow

When a function recurses too deeply, an error like the following one is thrown:

```weave
Stack Overflow. Max stack is 256
```

You can configure the maximum stack size by using the property `com.mulesoft.dw.stacksize`.

### No space left on device

To handle large payloads, DataWeave generates data that is handled in memory unless the payload
exceeds a configurable limit. If the payload exceeds the limit, the data is stored on disk as
output, input, and buffer files in a temporary directory. See
[DataWeave Memory Management](https://docs.mulesoft.com/dataweave/2.12/dataweave-memory-management) for further details.

When the streams that reference the files are closed, the files are released. Closure normally
occurs when flows complete their execution, so many buffer files in the temporary folder can remain
in use during long-running and concurrent executions.

To avoid the exception `No space left on device`, try to provide more resources to run the
application, or determine whether you can reduce the application’s resource consumption.

Sometimes bugs prevent the release of the files even after the flow has completed. If the latest
Mule release does not fix this issue, please report the issue to the MuleSoft support team.

### Closed Streams

Input data that reaches DataWeave is usually a stream. Mule handles the stream and adds auto-closing
and repeatable capabilities to it by generating “cursors” over the stream. Sometimes a stream closes
prematurely, before it reaches the DataWeave script, and it can be difficult to understand what
closed it. In these circumstances, the script fails with an error similar to
`Cannot open a new cursor on a closed stream`.

If this error occurs in latest Mule update, please report it to the MuleSoft support team. It is not
possible to work around the issue, but you can use the `com.mulesoft.dw.track.cursor.close` system
property to determine which component closed the stream prematurely. With the property set, the
error shows the stack trace from the moment that the stream was closed, which points to the
component that triggered the closure.

### Output Mismatch When Undefined

Unlike transformations, DataWeave expressions do not require you to define an output format because
DataWeave can infer the output based on the expression and the variables you use. Occasionally, the
inference process results in a mismatch between the inferred type and the expected type. To resolve
this issue, you must make the output explicit. Common examples of this situation occur when:

- [Extract Data from XML](#xml_extraction)

- [Handle Multipart Entries](#multipart_handling)

- [Manipulate Text Data](#manipulating_text)

#### Extract Data from XML

When extracting a String, for example, from an XML payload with the expression
`payload.order.product.model`, DataWeave infers an XML output based on the payload format. In such
cases, an error similar to the following one occurs:

```weave
"Trying to output non-whitespace characters outside main element tree (in prolog or epilog), while writing Xml at ." evaluating expression: "payload.order.product.model".
```

For such an error, you must make the output format explicit, for example:
`output text/plain --- payload.order.product.model`.

#### Handle Multipart Entries

A common inference error occurs with multipart data, which has a very specific structure. Consider a
multipart payload and the expression `dw::core::Objects::keySet(payload.parts)`. Without an explicit
output format, DataWeave must infer, based on the payload type, that you intend to output multipart
content. In this case, an error similar to the following is thrown:

```weave
"Expecting type is {
  preamble?: String,
  parts: {
    _*: {
      headers: Object,
      content: Any
    }
  }
} but got Array, while writing MultiPart.
Trace:
  at main (Unknown)" evaluating expression: "dw::core::Objects::keySet(payload.parts)".
```

To resolve this issue, you must define an output format, for example:
`output application/json --- dw::core::Objects::keySet(payload.parts)`

#### Manipulate Text Data

You can use text data to create a more complex object. However, if you do not define the output
format for the input text data, DataWeave infers that it must use the plain text writer for the
output. The expression `payload splitBy ' '`, for example, will fail with an error similar to:

```weave
"Text plain writer is unable to write Array.
Reason:
Cannot coerce Array (org.mule.weave.v2.model.values.ArrayValue$ArraySeqArrayValue@1331b353) to String
Trace:
  at main (Unknown), while writing TextPlain.
Trace:
  at main (Unknown)" evaluating expression: "payload splitBy ' '".
```

Making the output explicit solves the issue: `output application/java --- payload splitBy ' '`

### Encoding Issues

Encoding issues can occur because of a mismatch between encodings used to read and write a file or
when the encoding to write some text does not support some of the characters. Common examples
include the following:

- [Incorrect Encoding for the Reader](#reader_encoding)

- [Encoding Used by the Writer Does Not Support Some Characters](#writer_encoding)

- [Multipart/Form-Data Reader Does Not Support UTF-8 Characters by Default](#multipart_reader)

#### Incorrect Encoding for the Reader

In Mule, when you use components or connector operations that provide a `MIME Type` configuration
(such as `Set Payload`, `File Read`, `HTTP Listener`), check that the encoding you set corresponds
to the encoding used to write the payload. DataWeave reads the encoding that you set in the
`MIME Type` configuration.

If you do not set the MIME type, DataWeave uses the default encoding provided by Mule through the
`mule.encoding` system property.

#### Encoding Used by the Writer Does Not Support Some Characters

Check that your writer encoding supports the characters that you are trying to write.

For example, writing the text `"～―－＄￠￡㈱①"` with the encoding `sjis` outputs `"???＄????"`
because many of the input characters are not supported in that encoding (unlike UTF-8, for example).

```weave
%dw 2.0
output application/json encoding="sjis"
---
"～―－＄￠￡㈱①"
```

#### Multipart/Form-Data Reader Does Not Support UTF-8 Characters by Default

If you use UTF-8 characters in the multipart filenames, the non-ASCII characters in the names are
corrupted.

Set the following system property to enable support for UTF-8 in multipart:
`-M-Dmail.mime.allowutf8=true`

For example, posting a multipart payload with filename=`不明.txt` without setting the `allowutf8`
property to `true` produces the following unreadable text for the `filename` field:

```weave
{
  "Content-Disposition": {
    name: "file",
    filename: "ä\ufffd\ufffd明.txt",
    subtype: "form-data"
  },
  "Content-Type": "text/plain"
}
```

## DataWeave Warnings

The following are some common DataWeave warnings that appear in your dump file, along with some
details to address these warnings.

### End of Input Was Reached

This warning appears because DataWeave treats the Unicode non-character `U+FFFF` as a special
character that indicates the end of input.

To avoid this warning, replace the special character in the raw payload and then proceed as usual.

```weave
read(payload.^raw replace "\uFFFF" with "NonChar")
```

## Low Performance Issues

### application/dw Format

Using `output application/dw` format can impact the performance of transformations. This format is
intended to help you debug the results of DataWeave transformations. It is significantly slower than
other formats, so avoid using this format in production applications.

### multipart/form-data Content Parsing

For `multipart/form-data` inputs, accessing content of a large part can cause performance
degradation, especially for high-memory formats like `application/xlsx`, because the interpreter
attempts to parse the content of the part for further querying and analysis.

You can use the `^raw` selector to avoid parsing binary contents of parts.

The following example uses the `^raw` selector on specific operations over each part.

#### Input

```text
--myboundary
Content-Disposition: form-data; name="file1"; filename="a.json"
Content-Type: application/json

{
"title": "Java 8 in Action",
"author": "Mario Fusco",
"year": 2014
}
--myboundary
Content-Disposition: form-data; name="file2"; filename="a.xml"
Content-Type: application/xml

<doc>
    <title> Available for download! </title>
    <content> Really large content </content>
</doc>
--myboundary--
```

#### Source

```weave
%dw 2.0
input payload multipart boundary='myboundary'
output application/json
---
payload.parts mapObject ((value, key, index) ->
{
    (key): {
	fileName: payload.parts[index].headers.'Content-Disposition'.filename,
    rawContent: payload.parts[index].content.^raw
    }
})
```

## See Also

- [Known Issues](https://help.salesforce.com/s/issues)

<!-- document id=1e1d49b652b727dd5e46e32f54c3d57768943f4f707ab1d044d8b39db537d3e8 url=/mulesoft/current/en-us/dataweave/2.3/dataweave-troubleshoot.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Troubleshooting a Failing DataWeave Script

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

When you troubleshoot a failing script, one challenge to reproducing an error is having the same
inputs the script had when it executed, especially in production environments where inputs can
change unexpectedly. Therefore, it’s important to capture the inputs going into a script debugging
or using loggers. Often, the failures occur because the input coming from another component upstream
is not valid. You can find here a listing of the most common DataWeave errors and how to overcome
them.

## Dump Input Context and the Script into a Folder

In Mule 4.2.1, DataWeave introduced an experimental feature that enables you to dump the input
context and the failing script into a folder so that you can track the failing script along with the
data that makes the script fail. This tool is particularly useful for checking that received input
data is valid because incorrect scripts often fail when an upstream component generates invalid
data.

To use this feature:

1.  Set the following system property to enable the dump feature:

    `-M-Dcom.mulesoft.dw.dump_files=true`

2.  \[Optional\] Specify the path in which to generate the dump files:

    `-M-Dcom.mulesoft.dw.dump_folder=<path_to_folder>`

    The default directory is `/tmp`.

## DataWeave Exceptions

The following are some common DataWeave exceptions that you can find in your dump file, along with
some details to troubleshoot these errors.

### Incorrect Arguments

When a function is called with the incorrect kind of argument, it throws the exception,
`org.mule.weave.v2.exception.UnsupportedTypeCoercionException`. Causes of this exception include:

- [Function Does Not Accept Null Argument](#null_arg_not_accepted)

- [MIME Type Is Not Set](#mimetype_unset)

#### Function Does Not Accept Null Argument

The most common cause of this exception occurs when one of the arguments is `Null` and the function
does not accept `Null` as an argument. This issue results in an error message similar to the
following:

```weave
You called the function '++' with these arguments:
  1: Null (null)
  2: String (" A text")

But it expects one of these combinations:
  (Array, Array)
  (Date, Time)
  (Date, LocalTime)
  (Date, TimeZone)
  (LocalDateTime, TimeZone)
  (LocalTime, Date)
  (LocalTime, TimeZone)
  (Object, Object)
  (String, String)
  (Time, Date)
  (TimeZone, LocalDateTime)
  (TimeZone, Date)
  (TimeZone, LocalTime)

1| payload.message ++ " A text"
   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Trace:
  at ++ (line: 1, column: 1)
  at main (line: 1, column: 17)
```

One way to resolve this issue uses the `default` operator. For example, using
`payload.message default "" ++ " A text"` appends empty text when the message is null.

#### MIME Type Is Not Set

When the MIME type is not set, you receive an error message similar to the following:

```weave
You called the function 'Value Selector' with these arguments:

  1: String ("{ \"message\": 123}")
  2: Name ("message")

But it expects one of these combinations:
  (Array, Name)
  (Array, String)
  (Date, Name)
  (DateTime, Name)
  (LocalDateTime, Name)
  (LocalTime, Name)
  (Object, Name)
  (Object, String)
  (Period, Name)
  (Time, Name)

1| payload.message
   ^^^^^^^^^^^^^^^
Trace:
  at main (line: 1, column: 1)
```

When no MIME type is set on the payload, the MIME type defaults to `application/java`, and the
content is handled as a `String` instead of a JSON object.

### Stack Overflow

When a function recurses too deeply, an error like the following one is thrown:

```weave
Stack Overflow. Max stack is 256
```

You can configure the maximum stack size by using the property `com.mulesoft.dw.stacksize`.

## DataWeave Warnings

The following are some common DataWeave warnings that you can find in your dump file, along with
some details to address these warnings.

### End of Input Was Reached

This warning shows because DataWeave treats the Unicode non-character `U+FFFF` as a special
character that indicates the end of input.

To avoid this warning, replace the special character in the raw payload and then proceed as usual.

```weave
read(payload.^raw replace "\uFFFF" with "NonChar")
```

## Output Mismatch When Undefined

Unlike transformations, DataWeave expressions do not require you to define an output format because
DataWeave can infer the output based on the expression and the variables you use. Occasionally, the
inference process results in a mismatch between the inferred type and the expected type. To resolve
this issue, you must make the output explicit. Common examples of this situation occur when:

- [Extract Data from XML](#xml_extraction)

- [Handle Multipart Entries](#multipart_handling)

- [Manipulate Text Data](#manipulating_text)

### Extract Data from XML

When extracting a String, for example, from an XML payload with the expression
`payload.order.product.model`, DataWeave infers an XML output based on the payload format. In such
cases, an error similar to the following one occurs:

```weave
"Trying to output non-whitespace characters outside main element tree (in prolog or epilog), while writing Xml at ." evaluating expression: "payload.order.product.model".
```

For such an error, you must make the output format explicit, for example:
`output text/plain --- payload.order.product.model`.

### Handle Multipart Entries

A common inference error occurs with multipart data, which has a very specific structure. Consider a
multipart payload and the expression `dw::core::Objects::keySet(payload.parts)`. Without an explicit
output format, DataWeave must infer, based on the payload type, that you intend to output multipart
content. In this case, an error similar to the following is thrown:

```weave
"Expecting type is {
  preamble?: String,
  parts: {
    _*: {
      headers: Object,
      content: Any
    }
  }
} but got Array, while writing MultiPart.
Trace:
  at main (Unknown)" evaluating expression: "dw::core::Objects::keySet(payload.parts)".
```

To resolve this issue, you must define an output format, for example:
`output application/json --- dw::core::Objects::keySet(payload.parts)`

### Manipulate Text Data

You can use text data to create a more complex object. However, if you do not define the output
format for the input text data, DataWeave infers that it must use the plain text writer for the
output. The expression `payload splitBy ' '`, for example, will fail with an error similar to:

```weave
"Text plain writer is unable to write Array.
Reason:
Cannot coerce Array (org.mule.weave.v2.model.values.ArrayValue$ArraySeqArrayValue@1331b353) to String
Trace:
  at main (Unknown), while writing TextPlain.
Trace:
  at main (Unknown)" evaluating expression: "payload splitBy ' '".
```

Making the output explicit solves the issue: `output application/java --- payload splitBy ' '`

## See Also

- [Known Issues](https://help.salesforce.com/s/issues)

<!-- document id=6219500da3321afad418069ed0c484f3a4e6adc5c6b5b07dbbd2a506f9c44862 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-troubleshoot.md -->

---
product: DataWeave
version: 2.4
---

# Troubleshooting a Failing DataWeave Script

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

When you troubleshoot a failing script, one challenge to reproducing an error is having the same
inputs the script had when it executed, especially in production environments where inputs can
change unexpectedly. Therefore, it’s important to capture the inputs going into a script debugging
or using loggers. Often, the failures occur because the input coming from another component upstream
is not valid. You can find here a listing of the most common DataWeave errors and how to overcome
them.

## Dump Input Context and the Script into a Folder

In Mule 4.2.1, DataWeave introduced an experimental feature that enables you to dump the input
context and the failing script into a folder so that you can track the failing script along with the
data that makes the script fail. This tool is particularly useful for checking that received input
data is valid because incorrect scripts often fail when an upstream component generates invalid
data.

To use this feature:

1.  Set the following system property to enable the dump feature:

    `-M-Dcom.mulesoft.dw.dump_files=true`

2.  \[Optional\] Specify the path in which to generate the dump files:

    `-M-Dcom.mulesoft.dw.dump_folder=<path_to_folder>`

    The default directory is set in the `java.io.tmpdir` property.

## DataWeave Exceptions

The following are some common DataWeave exceptions that you can find in your dump file, along with
some details to troubleshoot these errors.

### Incorrect Arguments

When a function is called with the incorrect kind of argument, it throws the exception,
`org.mule.weave.v2.exception.UnsupportedTypeCoercionException`. Causes of this exception include:

- [Function Does Not Accept Null Argument](#null_arg_not_accepted)

- [MIME Type Is Not Set](#mimetype_unset)

#### Function Does Not Accept Null Argument

The most common cause of this exception occurs when one of the arguments is `Null` and the function
does not accept `Null` as an argument. This issue results in an error message similar to the
following:

```weave
You called the function '++' with these arguments:
  1: Null (null)
  2: String (" A text")

But it expects one of these combinations:
  (Array, Array)
  (Date, Time)
  (Date, LocalTime)
  (Date, TimeZone)
  (LocalDateTime, TimeZone)
  (LocalTime, Date)
  (LocalTime, TimeZone)
  (Object, Object)
  (String, String)
  (Time, Date)
  (TimeZone, LocalDateTime)
  (TimeZone, Date)
  (TimeZone, LocalTime)

1| payload.message ++ " A text"
   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Trace:
  at ++ (line: 1, column: 1)
  at main (line: 1, column: 17)
```

One way to resolve this issue uses the `default` operator. For example, using
`payload.message default "" ++ " A text"` appends empty text when the message is null.

#### MIME Type Is Not Set

When the MIME type is not set, you receive an error message similar to the following:

```weave
You called the function 'Value Selector' with these arguments:

  1: String ("{ \"message\": 123}")
  2: Name ("message")

But it expects one of these combinations:
  (Array, Name)
  (Array, String)
  (Date, Name)
  (DateTime, Name)
  (LocalDateTime, Name)
  (LocalTime, Name)
  (Object, Name)
  (Object, String)
  (Period, Name)
  (Time, Name)

1| payload.message
   ^^^^^^^^^^^^^^^
Trace:
  at main (line: 1, column: 1)
```

When no MIME type is set on the payload, the MIME type defaults to `application/java`, and the
content is handled as a `String` instead of a JSON object.

### Reader Properties Not Working In a Mule Application

In a Mule application, the `input` directive to a DataWeave script does not work. Unlike Mule
runtime, a standalone DataWeave runtime, such as the one in the
[DataWeave Playground+](https://dataweave.mulesoft.com/learn/), can process a valid MIME type set
through the `input` directive in the same DataWeave script. To input reader properties to a script
in a Mule application, configure the `outputMimeType` attribute for the data source to produce the
same results. See
[Using Reader and Writer Properties](https://docs.mulesoft.com/dataweave/2.4/dataweave-formats#using-reader-and-writer-properties) for
further details.

### Stack Overflow

When a function recurses too deeply, an error like the following one is thrown:

```weave
Stack Overflow. Max stack is 256
```

You can configure the maximum stack size by using the property `com.mulesoft.dw.stacksize`.

### No space left on device

To handle large payloads, DataWeave generates data that is handled in memory unless the payload
exceeds a configurable limit. If the payload exceeds the limit, the data is stored on disk as
output, input, and buffer files in a temporary directory. See
[DataWeave Memory Management](https://docs.mulesoft.com/dataweave/2.4/dataweave-memory-management) for further details.

When the streams that reference the files are closed, the files are released. Closure normally
occurs when flows complete their execution, so many buffer files in the temporary folder can remain
in use during long-running and concurrent executions.

To avoid the exception `No space left on device`, try to provide more resources to run the
application, or determine whether you can reduce the application’s resource consumption.

Sometimes bugs prevent the release of the files even after the flow has completed. If the latest
Mule release does not fix this issue, please report the issue to the MuleSoft support team.

### Closed Streams

Input data that reaches DataWeave is usually a stream. Mule handles the stream and adds auto-closing
and repeatable capabilities to it by generating “cursors” over the stream. Sometimes a stream closes
prematurely, before it reaches the DataWeave script, and it can be difficult to understand what
closed it. In these circumstances, the script fails with an error similar to
`Cannot open a new cursor on a closed stream`.

If this error occurs in latest Mule update, please report it to the MuleSoft support team. It is not
possible to work around the issue, but you can use the `com.mulesoft.dw.track.cursor.close` system
property to determine which component closed the stream prematurely. With the property set, the
error shows the stack trace from the moment that the stream was closed, which points to the
component that triggered the closure.

### Output Mismatch When Undefined

Unlike transformations, DataWeave expressions do not require you to define an output format because
DataWeave can infer the output based on the expression and the variables you use. Occasionally, the
inference process results in a mismatch between the inferred type and the expected type. To resolve
this issue, you must make the output explicit. Common examples of this situation occur when:

- [Extract Data from XML](#xml_extraction)

- [Handle Multipart Entries](#multipart_handling)

- [Manipulate Text Data](#manipulating_text)

#### Extract Data from XML

When extracting a String, for example, from an XML payload with the expression
`payload.order.product.model`, DataWeave infers an XML output based on the payload format. In such
cases, an error similar to the following one occurs:

```weave
"Trying to output non-whitespace characters outside main element tree (in prolog or epilog), while writing Xml at ." evaluating expression: "payload.order.product.model".
```

For such an error, you must make the output format explicit, for example:
`output text/plain --- payload.order.product.model`.

#### Handle Multipart Entries

A common inference error occurs with multipart data, which has a very specific structure. Consider a
multipart payload and the expression `dw::core::Objects::keySet(payload.parts)`. Without an explicit
output format, DataWeave must infer, based on the payload type, that you intend to output multipart
content. In this case, an error similar to the following is thrown:

```weave
"Expecting type is {
  preamble?: String,
  parts: {
    _*: {
      headers: Object,
      content: Any
    }
  }
} but got Array, while writing MultiPart.
Trace:
  at main (Unknown)" evaluating expression: "dw::core::Objects::keySet(payload.parts)".
```

To resolve this issue, you must define an output format, for example:
`output application/json --- dw::core::Objects::keySet(payload.parts)`

#### Manipulate Text Data

You can use text data to create a more complex object. However, if you do not define the output
format for the input text data, DataWeave infers that it must use the plain text writer for the
output. The expression `payload splitBy ' '`, for example, will fail with an error similar to:

```weave
"Text plain writer is unable to write Array.
Reason:
Cannot coerce Array (org.mule.weave.v2.model.values.ArrayValue$ArraySeqArrayValue@1331b353) to String
Trace:
  at main (Unknown), while writing TextPlain.
Trace:
  at main (Unknown)" evaluating expression: "payload splitBy ' '".
```

Making the output explicit solves the issue: `output application/java --- payload splitBy ' '`

### Encoding Issues

Encoding issues can occur because of a mismatch between encodings used to read and write a file or
when the encoding to write some text does not support some of the characters. Common examples
include the following:

- [Incorrect Encoding for the Reader](#reader_encoding)

- [Encoding Used by the Writer Does Not Support Some Characters](#writer_encoding)

- [Multipart/Form-Data Reader Does Not Support UTF-8 Characters by Default](#multipart_reader)

#### Incorrect Encoding for the Reader

In Mule, when you use components or connector operations that provide a `MIME Type` configuration
(such as `Set Payload`, `File Read`, `HTTP Listener`), check that the encoding you set corresponds
to the encoding used to write the payload. DataWeave reads the encoding that you set in the
`MIME Type` configuration.

If you do not set the MIME type, DataWeave uses the default encoding provided by Mule through the
`mule.encoding` system property.

#### Encoding Used by the Writer Does Not Support Some Characters

Check that your writer encoding supports the characters that you are trying to write.

For example, writing the text `"～―－＄￠￡㈱①"` with the encoding `sjis` outputs `"???＄????"`
because many of the input characters are not supported in that encoding (unlike UTF-8, for example).

```weave
%dw 2.0
output application/json encoding="sjis"
---
"～―－＄￠￡㈱①"
```

#### Multipart/Form-Data Reader Does Not Support UTF-8 Characters by Default

If you use UTF-8 characters in the multipart filenames, the non-ASCII characters in the names are
corrupted.

Set the following system property to enable support for UTF-8 in multipart:
`-M-Dmail.mime.allowutf8=true`

For example, posting a multipart payload with filename=`不明.txt` without setting the `allowutf8`
property to `true` produces the following unreadable text for the `filename` field:

```weave
{
  "Content-Disposition": {
    name: "file",
    filename: "ä\ufffd\ufffd明.txt",
    subtype: "form-data"
  },
  "Content-Type": "text/plain"
}
```

## DataWeave Warnings

The following are some common DataWeave warnings that appear in your dump file, along with some
details to address these warnings.

### End of Input Was Reached

This warning appears because DataWeave treats the Unicode non-character `U+FFFF` as a special
character that indicates the end of input.

To avoid this warning, replace the special character in the raw payload and then proceed as usual.

```weave
read(payload.^raw replace "\uFFFF" with "NonChar")
```

## Low Performance Issues

### application/dw Format

Using `output application/dw` format can impact the performance of transformations. This format is
intended to help you debug the results of DataWeave transformations. It is significantly slower than
other formats, so avoid using this format in production applications.

### multipart/form-data Content Parsing

For `multipart/form-data` inputs, accessing content of a large part can cause performance
degradation, especially for high-memory formats like `application/xlsx`, because the interpreter
attempts to parse the content of the part for further querying and analysis.

You can use the `^raw` selector to avoid parsing binary contents of parts.

The following example uses the `^raw` selector on specific operations over each part.

#### Input

```text
--myboundary
Content-Disposition: form-data; name="file1"; filename="a.json"
Content-Type: application/json

{
"title": "Java 8 in Action",
"author": "Mario Fusco",
"year": 2014
}
--myboundary
Content-Disposition: form-data; name="file2"; filename="a.xml"
Content-Type: application/xml

<doc>
    <title> Available for download! </title>
    <content> Really large content </content>
</doc>
--myboundary--
```

#### Source

```weave
%dw 2.0
input payload multipart boundary='myboundary'
output application/json
---
payload.parts mapObject ((value, key, index) ->
{
    (key): {
	fileName: payload.parts[index].headers.'Content-Disposition'.filename,
    rawContent: payload.parts[index].content.^raw
    }
})
```

## See Also

- [Known Issues](https://help.salesforce.com/s/issues)

<!-- document id=2bb6d5f904c7843cba42674d1fcb078d7a08374c70ebb2181e25d411bf9333cd url=/mulesoft/current/en-us/dataweave/2.6/dataweave-troubleshoot.md -->

---
product: DataWeave
version: 2.6
---

# Troubleshooting a Failing DataWeave Script

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

When you troubleshoot a failing script, one challenge to reproducing an error is having the same
inputs the script had when it executed, especially in production environments where inputs can
change unexpectedly. Therefore, it’s important to capture the inputs going into a script debugging
or using loggers. Often, the failures occur because the input coming from another component upstream
is not valid. You can find here a listing of the most common DataWeave errors and how to overcome
them.

## Dump Input Context and the Script into a Folder

In Mule 4.2.1, DataWeave introduced an experimental feature that enables you to dump the input
context and the failing script into a folder so that you can track the failing script along with the
data that makes the script fail. This tool is particularly useful for checking that received input
data is valid because incorrect scripts often fail when an upstream component generates invalid
data.

To use this feature:

1.  Set the following system property to enable the dump feature:

    `-M-Dcom.mulesoft.dw.dump_files=true`

2.  \[Optional\] Specify the path in which to generate the dump files:

    `-M-Dcom.mulesoft.dw.dump_folder=<path_to_folder>`

    The default directory is set in the `java.io.tmpdir` property.

## DataWeave Exceptions

The following are some common DataWeave exceptions that you can find in your dump file, along with
some details to troubleshoot these errors.

### Incorrect Arguments

When a function is called with the incorrect kind of argument, it throws the exception,
`org.mule.weave.v2.exception.UnsupportedTypeCoercionException`. Causes of this exception include:

- [Function Does Not Accept Null Argument](#null_arg_not_accepted)

- [MIME Type Is Not Set](#mimetype_unset)

#### Function Does Not Accept Null Argument

The most common cause of this exception occurs when one of the arguments is `Null` and the function
does not accept `Null` as an argument. This issue results in an error message similar to the
following:

```weave
You called the function '++' with these arguments:
  1: Null (null)
  2: String (" A text")

But it expects one of these combinations:
  (Array, Array)
  (Date, Time)
  (Date, LocalTime)
  (Date, TimeZone)
  (LocalDateTime, TimeZone)
  (LocalTime, Date)
  (LocalTime, TimeZone)
  (Object, Object)
  (String, String)
  (Time, Date)
  (TimeZone, LocalDateTime)
  (TimeZone, Date)
  (TimeZone, LocalTime)

1| payload.message ++ " A text"
   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Trace:
  at ++ (line: 1, column: 1)
  at main (line: 1, column: 17)
```

One way to resolve this issue uses the `default` operator. For example, using
`payload.message default "" ++ " A text"` appends empty text when the message is null.

#### MIME Type Is Not Set

When the MIME type is not set, you receive an error message similar to the following:

```weave
You called the function 'Value Selector' with these arguments:

  1: String ("{ \"message\": 123}")
  2: Name ("message")

But it expects one of these combinations:
  (Array, Name)
  (Array, String)
  (Date, Name)
  (DateTime, Name)
  (LocalDateTime, Name)
  (LocalTime, Name)
  (Object, Name)
  (Object, String)
  (Period, Name)
  (Time, Name)

1| payload.message
   ^^^^^^^^^^^^^^^
Trace:
  at main (line: 1, column: 1)
```

When no MIME type is set on the payload, the MIME type defaults to `application/java`, and the
content is handled as a `String` instead of a JSON object.

### Reader Properties Not Working In a Mule Application

In a Mule application, the `input` directive to a DataWeave script does not work. Unlike Mule
runtime, a standalone DataWeave runtime, such as the one in the
[DataWeave Playground+](https://dataweave.mulesoft.com/learn/), can process a valid MIME type set
through the `input` directive in the same DataWeave script. To input reader properties to a script
in a Mule application, configure the `outputMimeType` attribute for the data source to produce the
same results. See
[Using Reader and Writer Properties](https://docs.mulesoft.com/dataweave/2.6/dataweave-formats#using-reader-and-writer-properties) for
further details.

### Stack Overflow

When a function recurses too deeply, an error like the following one is thrown:

```weave
Stack Overflow. Max stack is 256
```

You can configure the maximum stack size by using the property `com.mulesoft.dw.stacksize`.

### No space left on device

To handle large payloads, DataWeave generates data that is handled in memory unless the payload
exceeds a configurable limit. If the payload exceeds the limit, the data is stored on disk as
output, input, and buffer files in a temporary directory. See
[DataWeave Memory Management](https://docs.mulesoft.com/dataweave/2.6/dataweave-memory-management) for further details.

When the streams that reference the files are closed, the files are released. Closure normally
occurs when flows complete their execution, so many buffer files in the temporary folder can remain
in use during long-running and concurrent executions.

To avoid the exception `No space left on device`, try to provide more resources to run the
application, or determine whether you can reduce the application’s resource consumption.

Sometimes bugs prevent the release of the files even after the flow has completed. If the latest
Mule release does not fix this issue, please report the issue to the MuleSoft support team.

### Closed Streams

Input data that reaches DataWeave is usually a stream. Mule handles the stream and adds auto-closing
and repeatable capabilities to it by generating “cursors” over the stream. Sometimes a stream closes
prematurely, before it reaches the DataWeave script, and it can be difficult to understand what
closed it. In these circumstances, the script fails with an error similar to
`Cannot open a new cursor on a closed stream`.

If this error occurs in latest Mule update, please report it to the MuleSoft support team. It is not
possible to work around the issue, but you can use the `com.mulesoft.dw.track.cursor.close` system
property to determine which component closed the stream prematurely. With the property set, the
error shows the stack trace from the moment that the stream was closed, which points to the
component that triggered the closure.

### Output Mismatch When Undefined

Unlike transformations, DataWeave expressions do not require you to define an output format because
DataWeave can infer the output based on the expression and the variables you use. Occasionally, the
inference process results in a mismatch between the inferred type and the expected type. To resolve
this issue, you must make the output explicit. Common examples of this situation occur when:

- [Extract Data from XML](#xml_extraction)

- [Handle Multipart Entries](#multipart_handling)

- [Manipulate Text Data](#manipulating_text)

#### Extract Data from XML

When extracting a String, for example, from an XML payload with the expression
`payload.order.product.model`, DataWeave infers an XML output based on the payload format. In such
cases, an error similar to the following one occurs:

```weave
"Trying to output non-whitespace characters outside main element tree (in prolog or epilog), while writing Xml at ." evaluating expression: "payload.order.product.model".
```

For such an error, you must make the output format explicit, for example:
`output text/plain --- payload.order.product.model`.

#### Handle Multipart Entries

A common inference error occurs with multipart data, which has a very specific structure. Consider a
multipart payload and the expression `dw::core::Objects::keySet(payload.parts)`. Without an explicit
output format, DataWeave must infer, based on the payload type, that you intend to output multipart
content. In this case, an error similar to the following is thrown:

```weave
"Expecting type is {
  preamble?: String,
  parts: {
    _*: {
      headers: Object,
      content: Any
    }
  }
} but got Array, while writing MultiPart.
Trace:
  at main (Unknown)" evaluating expression: "dw::core::Objects::keySet(payload.parts)".
```

To resolve this issue, you must define an output format, for example:
`output application/json --- dw::core::Objects::keySet(payload.parts)`

#### Manipulate Text Data

You can use text data to create a more complex object. However, if you do not define the output
format for the input text data, DataWeave infers that it must use the plain text writer for the
output. The expression `payload splitBy ' '`, for example, will fail with an error similar to:

```weave
"Text plain writer is unable to write Array.
Reason:
Cannot coerce Array (org.mule.weave.v2.model.values.ArrayValue$ArraySeqArrayValue@1331b353) to String
Trace:
  at main (Unknown), while writing TextPlain.
Trace:
  at main (Unknown)" evaluating expression: "payload splitBy ' '".
```

Making the output explicit solves the issue: `output application/java --- payload splitBy ' '`

### Encoding Issues

Encoding issues can occur because of a mismatch between encodings used to read and write a file or
when the encoding to write some text does not support some of the characters. Common examples
include the following:

- [Incorrect Encoding for the Reader](#reader_encoding)

- [Encoding Used by the Writer Does Not Support Some Characters](#writer_encoding)

- [Multipart/Form-Data Reader Does Not Support UTF-8 Characters by Default](#multipart_reader)

#### Incorrect Encoding for the Reader

In Mule, when you use components or connector operations that provide a `MIME Type` configuration
(such as `Set Payload`, `File Read`, `HTTP Listener`), check that the encoding you set corresponds
to the encoding used to write the payload. DataWeave reads the encoding that you set in the
`MIME Type` configuration.

If you do not set the MIME type, DataWeave uses the default encoding provided by Mule through the
`mule.encoding` system property.

#### Encoding Used by the Writer Does Not Support Some Characters

Check that your writer encoding supports the characters that you are trying to write.

For example, writing the text `"～―－＄￠￡㈱①"` with the encoding `sjis` outputs `"???＄????"`
because many of the input characters are not supported in that encoding (unlike UTF-8, for example).

```weave
%dw 2.0
output application/json encoding="sjis"
---
"～―－＄￠￡㈱①"
```

#### Multipart/Form-Data Reader Does Not Support UTF-8 Characters by Default

If you use UTF-8 characters in the multipart filenames, the non-ASCII characters in the names are
corrupted.

Set the following system property to enable support for UTF-8 in multipart:
`-M-Dmail.mime.allowutf8=true`

For example, posting a multipart payload with filename=`不明.txt` without setting the `allowutf8`
property to `true` produces the following unreadable text for the `filename` field:

```weave
{
  "Content-Disposition": {
    name: "file",
    filename: "ä\ufffd\ufffd明.txt",
    subtype: "form-data"
  },
  "Content-Type": "text/plain"
}
```

## DataWeave Warnings

The following are some common DataWeave warnings that appear in your dump file, along with some
details to address these warnings.

### End of Input Was Reached

This warning appears because DataWeave treats the Unicode non-character `U+FFFF` as a special
character that indicates the end of input.

To avoid this warning, replace the special character in the raw payload and then proceed as usual.

```weave
read(payload.^raw replace "\uFFFF" with "NonChar")
```

## Low Performance Issues

### application/dw Format

Using `output application/dw` format can impact the performance of transformations. This format is
intended to help you debug the results of DataWeave transformations. It is significantly slower than
other formats, so avoid using this format in production applications.

### multipart/form-data Content Parsing

For `multipart/form-data` inputs, accessing content of a large part can cause performance
degradation, especially for high-memory formats like `application/xlsx`, because the interpreter
attempts to parse the content of the part for further querying and analysis.

You can use the `^raw` selector to avoid parsing binary contents of parts.

The following example uses the `^raw` selector on specific operations over each part.

#### Input

```text
--myboundary
Content-Disposition: form-data; name="file1"; filename="a.json"
Content-Type: application/json

{
"title": "Java 8 in Action",
"author": "Mario Fusco",
"year": 2014
}
--myboundary
Content-Disposition: form-data; name="file2"; filename="a.xml"
Content-Type: application/xml

<doc>
    <title> Available for download! </title>
    <content> Really large content </content>
</doc>
--myboundary--
```

#### Source

```weave
%dw 2.0
input payload multipart boundary='myboundary'
output application/json
---
payload.parts mapObject ((value, key, index) ->
{
    (key): {
	fileName: payload.parts[index].headers.'Content-Disposition'.filename,
    rawContent: payload.parts[index].content.^raw
    }
})
```

## See Also

- [Known Issues](https://help.salesforce.com/s/issues)

<!-- document id=640b59ad52dd46b554456f21e253662c3c1d9b6c26baf14eb34c04f58602e076 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-troubleshoot.md -->

---
product: DataWeave
version: 2.9
---

# Troubleshooting a Failing DataWeave Script

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

When you troubleshoot a failing script, one challenge to reproducing an error is having the same
inputs the script had when it executed, especially in production environments where inputs can
change unexpectedly. Therefore, it’s important to capture the inputs going into a script debugging
or using loggers. Often, the failures occur because the input coming from another component upstream
is not valid. You can find here a listing of the most common DataWeave errors and how to overcome
them.

## Dump Input Context and the Script into a Folder

In Mule 4.2.1, DataWeave introduced an experimental feature that enables you to dump the input
context and the failing script into a folder so that you can track the failing script along with the
data that makes the script fail. This tool is particularly useful for checking that received input
data is valid because incorrect scripts often fail when an upstream component generates invalid
data.

To use this feature:

1.  Set the following system property to enable the dump feature:

    `-M-Dcom.mulesoft.dw.dump_files=true`

2.  \[Optional\] Specify the path in which to generate the dump files:

    `-M-Dcom.mulesoft.dw.dump_folder=<path_to_folder>`

    The default directory is set in the `java.io.tmpdir` property.

## DataWeave Exceptions

The following are some common DataWeave exceptions that you can find in your dump file, along with
some details to troubleshoot these errors.

### Incorrect Arguments

When a function is called with the incorrect kind of argument, it throws the exception,
`org.mule.weave.v2.exception.UnsupportedTypeCoercionException`. Causes of this exception include:

- [Function Does Not Accept Null Argument](#null_arg_not_accepted)

- [MIME Type Is Not Set](#mimetype_unset)

#### Function Does Not Accept Null Argument

The most common cause of this exception occurs when one of the arguments is `Null` and the function
does not accept `Null` as an argument. This issue results in an error message similar to the
following:

```weave
You called the function '++' with these arguments:
  1: Null (null)
  2: String (" A text")

But it expects one of these combinations:
  (Array, Array)
  (Date, Time)
  (Date, LocalTime)
  (Date, TimeZone)
  (LocalDateTime, TimeZone)
  (LocalTime, Date)
  (LocalTime, TimeZone)
  (Object, Object)
  (String, String)
  (Time, Date)
  (TimeZone, LocalDateTime)
  (TimeZone, Date)
  (TimeZone, LocalTime)

1| payload.message ++ " A text"
   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Trace:
  at ++ (line: 1, column: 1)
  at main (line: 1, column: 17)
```

One way to resolve this issue uses the `default` operator. For example, using
`payload.message default "" ++ " A text"` appends empty text when the message is null.

#### MIME Type Is Not Set

When the MIME type is not set, you receive an error message similar to the following:

```weave
You called the function 'Value Selector' with these arguments:

  1: String ("{ \"message\": 123}")
  2: Name ("message")

But it expects one of these combinations:
  (Array, Name)
  (Array, String)
  (Date, Name)
  (DateTime, Name)
  (LocalDateTime, Name)
  (LocalTime, Name)
  (Object, Name)
  (Object, String)
  (Period, Name)
  (Time, Name)

1| payload.message
   ^^^^^^^^^^^^^^^
Trace:
  at main (line: 1, column: 1)
```

When no MIME type is set on the payload, the MIME type defaults to `application/java`, and the
content is handled as a `String` instead of a JSON object.

### Reader Properties Not Working In a Mule Application

In a Mule application, the `input` directive to a DataWeave script does not work. Unlike Mule
runtime, a standalone DataWeave runtime, such as the one in the
[DataWeave Playground+](https://dataweave.mulesoft.com/learn/), can process a valid MIME type set
through the `input` directive in the same DataWeave script. To input reader properties to a script
in a Mule application, configure the `outputMimeType` attribute for the data source to produce the
same results. See
[Using Reader and Writer Properties](https://docs.mulesoft.com/dataweave/2.9/dataweave-formats#using-reader-and-writer-properties) for
further details.

### Stack Overflow

When a function recurses too deeply, an error like the following one is thrown:

```weave
Stack Overflow. Max stack is 256
```

You can configure the maximum stack size by using the property `com.mulesoft.dw.stacksize`.

### No space left on device

To handle large payloads, DataWeave generates data that is handled in memory unless the payload
exceeds a configurable limit. If the payload exceeds the limit, the data is stored on disk as
output, input, and buffer files in a temporary directory. See
[DataWeave Memory Management](https://docs.mulesoft.com/dataweave/2.9/dataweave-memory-management) for further details.

When the streams that reference the files are closed, the files are released. Closure normally
occurs when flows complete their execution, so many buffer files in the temporary folder can remain
in use during long-running and concurrent executions.

To avoid the exception `No space left on device`, try to provide more resources to run the
application, or determine whether you can reduce the application’s resource consumption.

Sometimes bugs prevent the release of the files even after the flow has completed. If the latest
Mule release does not fix this issue, please report the issue to the MuleSoft support team.

### Closed Streams

Input data that reaches DataWeave is usually a stream. Mule handles the stream and adds auto-closing
and repeatable capabilities to it by generating “cursors” over the stream. Sometimes a stream closes
prematurely, before it reaches the DataWeave script, and it can be difficult to understand what
closed it. In these circumstances, the script fails with an error similar to
`Cannot open a new cursor on a closed stream`.

If this error occurs in latest Mule update, please report it to the MuleSoft support team. It is not
possible to work around the issue, but you can use the `com.mulesoft.dw.track.cursor.close` system
property to determine which component closed the stream prematurely. With the property set, the
error shows the stack trace from the moment that the stream was closed, which points to the
component that triggered the closure.

### Output Mismatch When Undefined

Unlike transformations, DataWeave expressions do not require you to define an output format because
DataWeave can infer the output based on the expression and the variables you use. Occasionally, the
inference process results in a mismatch between the inferred type and the expected type. To resolve
this issue, you must make the output explicit. Common examples of this situation occur when:

- [Extract Data from XML](#xml_extraction)

- [Handle Multipart Entries](#multipart_handling)

- [Manipulate Text Data](#manipulating_text)

#### Extract Data from XML

When extracting a String, for example, from an XML payload with the expression
`payload.order.product.model`, DataWeave infers an XML output based on the payload format. In such
cases, an error similar to the following one occurs:

```weave
"Trying to output non-whitespace characters outside main element tree (in prolog or epilog), while writing Xml at ." evaluating expression: "payload.order.product.model".
```

For such an error, you must make the output format explicit, for example:
`output text/plain --- payload.order.product.model`.

#### Handle Multipart Entries

A common inference error occurs with multipart data, which has a very specific structure. Consider a
multipart payload and the expression `dw::core::Objects::keySet(payload.parts)`. Without an explicit
output format, DataWeave must infer, based on the payload type, that you intend to output multipart
content. In this case, an error similar to the following is thrown:

```weave
"Expecting type is {
  preamble?: String,
  parts: {
    _*: {
      headers: Object,
      content: Any
    }
  }
} but got Array, while writing MultiPart.
Trace:
  at main (Unknown)" evaluating expression: "dw::core::Objects::keySet(payload.parts)".
```

To resolve this issue, you must define an output format, for example:
`output application/json --- dw::core::Objects::keySet(payload.parts)`

#### Manipulate Text Data

You can use text data to create a more complex object. However, if you do not define the output
format for the input text data, DataWeave infers that it must use the plain text writer for the
output. The expression `payload splitBy ' '`, for example, will fail with an error similar to:

```weave
"Text plain writer is unable to write Array.
Reason:
Cannot coerce Array (org.mule.weave.v2.model.values.ArrayValue$ArraySeqArrayValue@1331b353) to String
Trace:
  at main (Unknown), while writing TextPlain.
Trace:
  at main (Unknown)" evaluating expression: "payload splitBy ' '".
```

Making the output explicit solves the issue: `output application/java --- payload splitBy ' '`

### Encoding Issues

Encoding issues can occur because of a mismatch between encodings used to read and write a file or
when the encoding to write some text does not support some of the characters. Common examples
include the following:

- [Incorrect Encoding for the Reader](#reader_encoding)

- [Encoding Used by the Writer Does Not Support Some Characters](#writer_encoding)

- [Multipart/Form-Data Reader Does Not Support UTF-8 Characters by Default](#multipart_reader)

#### Incorrect Encoding for the Reader

In Mule, when you use components or connector operations that provide a `MIME Type` configuration
(such as `Set Payload`, `File Read`, `HTTP Listener`), check that the encoding you set corresponds
to the encoding used to write the payload. DataWeave reads the encoding that you set in the
`MIME Type` configuration.

If you do not set the MIME type, DataWeave uses the default encoding provided by Mule through the
`mule.encoding` system property.

#### Encoding Used by the Writer Does Not Support Some Characters

Check that your writer encoding supports the characters that you are trying to write.

For example, writing the text `"～―－＄￠￡㈱①"` with the encoding `sjis` outputs `"???＄????"`
because many of the input characters are not supported in that encoding (unlike UTF-8, for example).

```weave
%dw 2.0
output application/json encoding="sjis"
---
"～―－＄￠￡㈱①"
```

#### Multipart/Form-Data Reader Does Not Support UTF-8 Characters by Default

If you use UTF-8 characters in the multipart filenames, the non-ASCII characters in the names are
corrupted.

Set the following system property to enable support for UTF-8 in multipart:
`-M-Dmail.mime.allowutf8=true`

For example, posting a multipart payload with filename=`不明.txt` without setting the `allowutf8`
property to `true` produces the following unreadable text for the `filename` field:

```weave
{
  "Content-Disposition": {
    name: "file",
    filename: "ä\ufffd\ufffd明.txt",
    subtype: "form-data"
  },
  "Content-Type": "text/plain"
}
```

## DataWeave Warnings

The following are some common DataWeave warnings that appear in your dump file, along with some
details to address these warnings.

### End of Input Was Reached

This warning appears because DataWeave treats the Unicode non-character `U+FFFF` as a special
character that indicates the end of input.

To avoid this warning, replace the special character in the raw payload and then proceed as usual.

```weave
read(payload.^raw replace "\uFFFF" with "NonChar")
```

## Low Performance Issues

### application/dw Format

Using `output application/dw` format can impact the performance of transformations. This format is
intended to help you debug the results of DataWeave transformations. It is significantly slower than
other formats, so avoid using this format in production applications.

### multipart/form-data Content Parsing

For `multipart/form-data` inputs, accessing content of a large part can cause performance
degradation, especially for high-memory formats like `application/xlsx`, because the interpreter
attempts to parse the content of the part for further querying and analysis.

You can use the `^raw` selector to avoid parsing binary contents of parts.

The following example uses the `^raw` selector on specific operations over each part.

#### Input

```text
--myboundary
Content-Disposition: form-data; name="file1"; filename="a.json"
Content-Type: application/json

{
"title": "Java 8 in Action",
"author": "Mario Fusco",
"year": 2014
}
--myboundary
Content-Disposition: form-data; name="file2"; filename="a.xml"
Content-Type: application/xml

<doc>
    <title> Available for download! </title>
    <content> Really large content </content>
</doc>
--myboundary--
```

#### Source

```weave
%dw 2.0
input payload multipart boundary='myboundary'
output application/json
---
payload.parts mapObject ((value, key, index) ->
{
    (key): {
	fileName: payload.parts[index].headers.'Content-Disposition'.filename,
    rawContent: payload.parts[index].content.^raw
    }
})
```

## See Also

- [Known Issues](https://help.salesforce.com/s/issues)

<!-- document id=96cd0cb98c0ffd44350b5f8b6934e72a5983a38dd3d0237a9bc2a8652f8f5691 url=/mulesoft/current/en-us/dataweave/latest/dataweave-troubleshoot.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Troubleshooting a Failing DataWeave Script

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

When you troubleshoot a failing script, one challenge to reproducing an error is having the same
inputs the script had when it executed, especially in production environments where inputs can
change unexpectedly. Therefore, it’s important to capture the inputs going into a script debugging
or using loggers. Often, the failures occur because the input coming from another component upstream
is not valid. You can find here a listing of the most common DataWeave errors and how to overcome
them.

## Dump Input Context and the Script into a Folder

In Mule 4.2.1, DataWeave introduced an experimental feature that enables you to dump the input
context and the failing script into a folder so that you can track the failing script along with the
data that makes the script fail. This tool is particularly useful for checking that received input
data is valid because incorrect scripts often fail when an upstream component generates invalid
data.

To use this feature:

1.  Set the following system property to enable the dump feature:

    `-M-Dcom.mulesoft.dw.dump_files=true`

2.  \[Optional\] Specify the path in which to generate the dump files:

    `-M-Dcom.mulesoft.dw.dump_folder=<path_to_folder>`

    The default directory is set in the `java.io.tmpdir` property.

## DataWeave Exceptions

The following are some common DataWeave exceptions that you can find in your dump file, along with
some details to troubleshoot these errors.

### Incorrect Arguments

When a function is called with the incorrect kind of argument, it throws the exception,
`org.mule.weave.v2.exception.UnsupportedTypeCoercionException`. Causes of this exception include:

- [Function Does Not Accept Null Argument](#null_arg_not_accepted)

- [MIME Type Is Not Set](#mimetype_unset)

#### Function Does Not Accept Null Argument

The most common cause of this exception occurs when one of the arguments is `Null` and the function
does not accept `Null` as an argument. This issue results in an error message similar to the
following:

```weave
You called the function '++' with these arguments:
  1: Null (null)
  2: String (" A text")

But it expects one of these combinations:
  (Array, Array)
  (Date, Time)
  (Date, LocalTime)
  (Date, TimeZone)
  (LocalDateTime, TimeZone)
  (LocalTime, Date)
  (LocalTime, TimeZone)
  (Object, Object)
  (String, String)
  (Time, Date)
  (TimeZone, LocalDateTime)
  (TimeZone, Date)
  (TimeZone, LocalTime)

1| payload.message ++ " A text"
   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Trace:
  at ++ (line: 1, column: 1)
  at main (line: 1, column: 17)
```

One way to resolve this issue uses the `default` operator. For example, using
`payload.message default "" ++ " A text"` appends empty text when the message is null.

#### MIME Type Is Not Set

When the MIME type is not set, you receive an error message similar to the following:

```weave
You called the function 'Value Selector' with these arguments:

  1: String ("{ \"message\": 123}")
  2: Name ("message")

But it expects one of these combinations:
  (Array, Name)
  (Array, String)
  (Date, Name)
  (DateTime, Name)
  (LocalDateTime, Name)
  (LocalTime, Name)
  (Object, Name)
  (Object, String)
  (Period, Name)
  (Time, Name)

1| payload.message
   ^^^^^^^^^^^^^^^
Trace:
  at main (line: 1, column: 1)
```

When no MIME type is set on the payload, the MIME type defaults to `application/java`, and the
content is handled as a `String` instead of a JSON object.

### Reader Properties Not Working In a Mule Application

In a Mule application, the `input` directive to a DataWeave script does not work. Unlike Mule
runtime, a standalone DataWeave runtime, such as the one in the
[DataWeave Playground+](https://dataweave.mulesoft.com/learn/), can process a valid MIME type set
through the `input` directive in the same DataWeave script. To input reader properties to a script
in a Mule application, configure the `outputMimeType` attribute for the data source to produce the
same results. See
[Using Reader and Writer Properties](https://docs.mulesoft.com/dataweave/latest/dataweave-formats#using-reader-and-writer-properties) for
further details.

### Stack Overflow

When a function recurses too deeply, an error like the following one is thrown:

```weave
Stack Overflow. Max stack is 256
```

You can configure the maximum stack size by using the property `com.mulesoft.dw.stacksize`.

### No space left on device

To handle large payloads, DataWeave generates data that is handled in memory unless the payload
exceeds a configurable limit. If the payload exceeds the limit, the data is stored on disk as
output, input, and buffer files in a temporary directory. See
[DataWeave Memory Management](https://docs.mulesoft.com/dataweave/latest/dataweave-memory-management) for further details.

When the streams that reference the files are closed, the files are released. Closure normally
occurs when flows complete their execution, so many buffer files in the temporary folder can remain
in use during long-running and concurrent executions.

To avoid the exception `No space left on device`, try to provide more resources to run the
application, or determine whether you can reduce the application’s resource consumption.

Sometimes bugs prevent the release of the files even after the flow has completed. If the latest
Mule release does not fix this issue, please report the issue to the MuleSoft support team.

### Closed Streams

Input data that reaches DataWeave is usually a stream. Mule handles the stream and adds auto-closing
and repeatable capabilities to it by generating “cursors” over the stream. Sometimes a stream closes
prematurely, before it reaches the DataWeave script, and it can be difficult to understand what
closed it. In these circumstances, the script fails with an error similar to
`Cannot open a new cursor on a closed stream`.

If this error occurs in latest Mule update, please report it to the MuleSoft support team. It is not
possible to work around the issue, but you can use the `com.mulesoft.dw.track.cursor.close` system
property to determine which component closed the stream prematurely. With the property set, the
error shows the stack trace from the moment that the stream was closed, which points to the
component that triggered the closure.

### Output Mismatch When Undefined

Unlike transformations, DataWeave expressions do not require you to define an output format because
DataWeave can infer the output based on the expression and the variables you use. Occasionally, the
inference process results in a mismatch between the inferred type and the expected type. To resolve
this issue, you must make the output explicit. Common examples of this situation occur when:

- [Extract Data from XML](#xml_extraction)

- [Handle Multipart Entries](#multipart_handling)

- [Manipulate Text Data](#manipulating_text)

#### Extract Data from XML

When extracting a String, for example, from an XML payload with the expression
`payload.order.product.model`, DataWeave infers an XML output based on the payload format. In such
cases, an error similar to the following one occurs:

```weave
"Trying to output non-whitespace characters outside main element tree (in prolog or epilog), while writing Xml at ." evaluating expression: "payload.order.product.model".
```

For such an error, you must make the output format explicit, for example:
`output text/plain --- payload.order.product.model`.

#### Handle Multipart Entries

A common inference error occurs with multipart data, which has a very specific structure. Consider a
multipart payload and the expression `dw::core::Objects::keySet(payload.parts)`. Without an explicit
output format, DataWeave must infer, based on the payload type, that you intend to output multipart
content. In this case, an error similar to the following is thrown:

```weave
"Expecting type is {
  preamble?: String,
  parts: {
    _*: {
      headers: Object,
      content: Any
    }
  }
} but got Array, while writing MultiPart.
Trace:
  at main (Unknown)" evaluating expression: "dw::core::Objects::keySet(payload.parts)".
```

To resolve this issue, you must define an output format, for example:
`output application/json --- dw::core::Objects::keySet(payload.parts)`

#### Manipulate Text Data

You can use text data to create a more complex object. However, if you do not define the output
format for the input text data, DataWeave infers that it must use the plain text writer for the
output. The expression `payload splitBy ' '`, for example, will fail with an error similar to:

```weave
"Text plain writer is unable to write Array.
Reason:
Cannot coerce Array (org.mule.weave.v2.model.values.ArrayValue$ArraySeqArrayValue@1331b353) to String
Trace:
  at main (Unknown), while writing TextPlain.
Trace:
  at main (Unknown)" evaluating expression: "payload splitBy ' '".
```

Making the output explicit solves the issue: `output application/java --- payload splitBy ' '`

### Encoding Issues

Encoding issues can occur because of a mismatch between encodings used to read and write a file or
when the encoding to write some text does not support some of the characters. Common examples
include the following:

- [Incorrect Encoding for the Reader](#reader_encoding)

- [Encoding Used by the Writer Does Not Support Some Characters](#writer_encoding)

- [Multipart/Form-Data Reader Does Not Support UTF-8 Characters by Default](#multipart_reader)

#### Incorrect Encoding for the Reader

In Mule, when you use components or connector operations that provide a `MIME Type` configuration
(such as `Set Payload`, `File Read`, `HTTP Listener`), check that the encoding you set corresponds
to the encoding used to write the payload. DataWeave reads the encoding that you set in the
`MIME Type` configuration.

If you do not set the MIME type, DataWeave uses the default encoding provided by Mule through the
`mule.encoding` system property.

#### Encoding Used by the Writer Does Not Support Some Characters

Check that your writer encoding supports the characters that you are trying to write.

For example, writing the text `"～―－＄￠￡㈱①"` with the encoding `sjis` outputs `"???＄????"`
because many of the input characters are not supported in that encoding (unlike UTF-8, for example).

```weave
%dw 2.0
output application/json encoding="sjis"
---
"～―－＄￠￡㈱①"
```

#### Multipart/Form-Data Reader Does Not Support UTF-8 Characters by Default

If you use UTF-8 characters in the multipart filenames, the non-ASCII characters in the names are
corrupted.

Set the following system property to enable support for UTF-8 in multipart:
`-M-Dmail.mime.allowutf8=true`

For example, posting a multipart payload with filename=`不明.txt` without setting the `allowutf8`
property to `true` produces the following unreadable text for the `filename` field:

```weave
{
  "Content-Disposition": {
    name: "file",
    filename: "ä\ufffd\ufffd明.txt",
    subtype: "form-data"
  },
  "Content-Type": "text/plain"
}
```

## DataWeave Warnings

The following are some common DataWeave warnings that appear in your dump file, along with some
details to address these warnings.

### End of Input Was Reached

This warning appears because DataWeave treats the Unicode non-character `U+FFFF` as a special
character that indicates the end of input.

To avoid this warning, replace the special character in the raw payload and then proceed as usual.

```weave
read(payload.^raw replace "\uFFFF" with "NonChar")
```

## Low Performance Issues

### application/dw Format

Using `output application/dw` format can impact the performance of transformations. This format is
intended to help you debug the results of DataWeave transformations. It is significantly slower than
other formats, so avoid using this format in production applications.

### multipart/form-data Content Parsing

For `multipart/form-data` inputs, accessing content of a large part can cause performance
degradation, especially for high-memory formats like `application/xlsx`, because the interpreter
attempts to parse the content of the part for further querying and analysis.

You can use the `^raw` selector to avoid parsing binary contents of parts.

The following example uses the `^raw` selector on specific operations over each part.

#### Input

```text
--myboundary
Content-Disposition: form-data; name="file1"; filename="a.json"
Content-Type: application/json

{
"title": "Java 8 in Action",
"author": "Mario Fusco",
"year": 2014
}
--myboundary
Content-Disposition: form-data; name="file2"; filename="a.xml"
Content-Type: application/xml

<doc>
    <title> Available for download! </title>
    <content> Really large content </content>
</doc>
--myboundary--
```

#### Source

```weave
%dw 2.0
input payload multipart boundary='myboundary'
output application/json
---
payload.parts mapObject ((value, key, index) ->
{
    (key): {
	fileName: payload.parts[index].headers.'Content-Disposition'.filename,
    rawContent: payload.parts[index].content.^raw
    }
})
```

## See Also

- [Known Issues](https://help.salesforce.com/s/issues)

<!-- document id=bfe9451efdbb34c2a4364463dc4d6f97f353874abfa28078913e5846e9e2613e url=/mulesoft/current/en-us/dataweave/2.11/dw-runtime-functions-try.md -->

---
product: DataWeave
version: 2.11
---

# try

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## try<T>(delegate: () -> T): TryResult<T>

Evaluates the delegate function and returns an object with `success: true` and `result` if the
delegate function succeeds, or an object with `success: false` and `error` if the delegate function
throws an exception.

The `orElseTry` and `orElse` functions will also continue processing if the `try` function fails.
See the `orElseTry` and `orElse` documentation for more complete examples of handling failing `try`
function expressions.

Note: Instead of using the `orElseTry` and `orElse` functions, based on the output of the `try`
function, you can add conditional logic to execute when the result is `success: true` or
`success: false`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>delegate</code></p></td><td><p>The function to evaluate.</p></td></tr></tbody></table>

### Example

This example calls the `try` function using the `randomNumber` function as argument. The function
`randomNumber` generates a random number and calls `fail` if the number is greater than 0.5. The
declaration of this function is in the script’s header.

#### Source

```DataWeave
%dw 2.0
import try, fail from dw::Runtime
output application/json
fun randomNumber() =
if(random() > 0.5)
  fail("This function is failing")
 else
  "OK"
---
try(() -> randomNumber())
```

#### Output

When `randomNumber` fails, the output is:

```JSON
{
  "success": false,
  "error": {
    "kind": "UserException",
    "message": "This function is failing",
    "location": "Unknown location",
    "stack": [
      "fail (anonymous:0:0)",
      "myFunction (anonymous:1:114)",
      "main (anonymous:1:179)"
    ]
  }
}
```

When `randomNumber` succeeds, the output is:

```JSON
{
  "success": true,
  "result": "OK"
}
```

<!-- document id=220a56101e925e50d4a7457aa524ef9abf3db7792c1031bf694b8c04ad47dfd2 url=/mulesoft/current/en-us/dataweave/2.12/dw-runtime-functions-try.md -->

---
product: DataWeave
version: 2.12
---

# try

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## try<T>(delegate: () -> T): TryResult<T>

Evaluates the delegate function and returns an object with `success: true` and `result` if the
delegate function succeeds, or an object with `success: false` and `error` if the delegate function
throws an exception.

The `orElseTry` and `orElse` functions will also continue processing if the `try` function fails.
See the `orElseTry` and `orElse` documentation for more complete examples of handling failing `try`
function expressions.

Note: Instead of using the `orElseTry` and `orElse` functions, based on the output of the `try`
function, you can add conditional logic to execute when the result is `success: true` or
`success: false`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>delegate</code></p></td><td><p>The function to evaluate.</p></td></tr></tbody></table>

### Example

This example calls the `try` function using the `randomNumber` function as argument. The function
`randomNumber` generates a random number and calls `fail` if the number is greater than 0.5. The
declaration of this function is in the script’s header.

#### Source

```DataWeave
%dw 2.0
import try, fail from dw::Runtime
output application/json
fun randomNumber() =
if(random() > 0.5)
  fail("This function is failing")
 else
  "OK"
---
try(() -> randomNumber())
```

#### Output

When `randomNumber` fails, the output is:

```JSON
{
  "success": false,
  "error": {
    "kind": "UserException",
    "message": "This function is failing",
    "location": "Unknown location",
    "stack": [
      "fail (anonymous:0:0)",
      "myFunction (anonymous:1:114)",
      "main (anonymous:1:179)"
    ]
  }
}
```

When `randomNumber` succeeds, the output is:

```JSON
{
  "success": true,
  "result": "OK"
}
```

<!-- document id=7b4f6fd484eea264cc19b457870976e4a1f7ec881c288c168825570ea598ea4f url=/mulesoft/current/en-us/dataweave/2.3/dw-runtime-functions-try.md -->

---
product: DataWeave
version: 2.3
---

# try

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## try(() -> T): TryResult<T>

Evaluates the delegate function and returns an object with `success: true` and `result` if the
delegate function succeeds, or an object with `success: false` and `error` if the delegate function
throws an exception.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>delegate</code></p></td><td><p>The function to evaluate.</p></td></tr></tbody></table>

### Example

This example calls the `try` function using the `randomNumber` function as argument.  
The function `randomNumber` generates a random number and calls `fail` if the number is higher than
0.5. The declaration of this function is in the script’s header.

#### Source

```DataWeave
%dw 2.0
import try, fail from dw::Runtime
output application/json
fun randomNumber() =
if(random() > 0.5)
  fail("This function is failing")
 else
  "OK"
---
try(() -> randomNumber())
```

#### Output

When `randomNumber` fails, the output is:

```JSON
{
  "success": false,
  "error": {
    "kind": "UserException",
    "message": "This function is failing",
    "location": "Unknown location",
    "stack": [
      "fail (anonymous:0:0)",
      "myFunction (anonymous:1:114)",
      "main (anonymous:1:179)"
    ]
  }
}
```

When `randomNumber` succeeds, the output is:

```JSON
{
  "success": true,
  "result": "OK"
}
```

The `orElseTry` and `orElse` functions will also continue processing if the `try` function fails.
See the `orElseTry` and `orElse` documentation for more complete examples of handling failing `try`
function expressions.

Note: Instead of using the `orElseTry` and `orElse` functions, based on the output of the `try`
function, you can add conditional logic to execute when the result is `success: true` or
`success: false`.

<!-- document id=c18d5a82cd8efd87ec4a05221aeba0fb9ffa0716488f7eaa43f2efea8fb04dba url=/mulesoft/current/en-us/dataweave/2.4/dw-runtime-functions-try.md -->

---
product: DataWeave
version: 2.4
---

# try

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## try<T>(delegate: () -> T): TryResult<T>

Evaluates the delegate function and returns an object with `success: true` and `result` if the
delegate function succeeds, or an object with `success: false` and `error` if the delegate function
throws an exception.

The `orElseTry` and `orElse` functions will also continue processing if the `try` function fails.
See the `orElseTry` and `orElse` documentation for more complete examples of handling failing `try`
function expressions.

Note: Instead of using the `orElseTry` and `orElse` functions, based on the output of the `try`
function, you can add conditional logic to execute when the result is `success: true` or
`success: false`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>delegate</code></p></td><td><p>The function to evaluate.</p></td></tr></tbody></table>

### Example

This example calls the `try` function using the `randomNumber` function as argument. The function
`randomNumber` generates a random number and calls `fail` if the number is greater than 0.5. The
declaration of this function is in the script’s header.

#### Source

```DataWeave
%dw 2.0
import try, fail from dw::Runtime
output application/json
fun randomNumber() =
if(random() > 0.5)
  fail("This function is failing")
 else
  "OK"
---
try(() -> randomNumber())
```

#### Output

When `randomNumber` fails, the output is:

```JSON
{
  "success": false,
  "error": {
    "kind": "UserException",
    "message": "This function is failing",
    "location": "Unknown location",
    "stack": [
      "fail (anonymous:0:0)",
      "myFunction (anonymous:1:114)",
      "main (anonymous:1:179)"
    ]
  }
}
```

When `randomNumber` succeeds, the output is:

```JSON
{
  "success": true,
  "result": "OK"
}
```

<!-- document id=e590ec8c625effef9a121c765f31d95ed56a9328a0b69d5019021f5798a0c29d url=/mulesoft/current/en-us/dataweave/2.6/dw-runtime-functions-try.md -->

---
product: DataWeave
version: 2.6
---

# try

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## try<T>(delegate: () -> T): TryResult<T>

Evaluates the delegate function and returns an object with `success: true` and `result` if the
delegate function succeeds, or an object with `success: false` and `error` if the delegate function
throws an exception.

The `orElseTry` and `orElse` functions will also continue processing if the `try` function fails.
See the `orElseTry` and `orElse` documentation for more complete examples of handling failing `try`
function expressions.

Note: Instead of using the `orElseTry` and `orElse` functions, based on the output of the `try`
function, you can add conditional logic to execute when the result is `success: true` or
`success: false`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>delegate</code></p></td><td><p>The function to evaluate.</p></td></tr></tbody></table>

### Example

This example calls the `try` function using the `randomNumber` function as argument. The function
`randomNumber` generates a random number and calls `fail` if the number is greater than 0.5. The
declaration of this function is in the script’s header.

#### Source

```DataWeave
%dw 2.0
import try, fail from dw::Runtime
output application/json
fun randomNumber() =
if(random() > 0.5)
  fail("This function is failing")
 else
  "OK"
---
try(() -> randomNumber())
```

#### Output

When `randomNumber` fails, the output is:

```JSON
{
  "success": false,
  "error": {
    "kind": "UserException",
    "message": "This function is failing",
    "location": "Unknown location",
    "stack": [
      "fail (anonymous:0:0)",
      "myFunction (anonymous:1:114)",
      "main (anonymous:1:179)"
    ]
  }
}
```

When `randomNumber` succeeds, the output is:

```JSON
{
  "success": true,
  "result": "OK"
}
```

<!-- document id=a6cb38cec19e50dd63ba244c7ef3cf75681a02e15ba1b48b8ce77951218ec59d url=/mulesoft/current/en-us/dataweave/2.9/dw-runtime-functions-try.md -->

---
product: DataWeave
version: 2.9
---

# try

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## try<T>(delegate: () -> T): TryResult<T>

Evaluates the delegate function and returns an object with `success: true` and `result` if the
delegate function succeeds, or an object with `success: false` and `error` if the delegate function
throws an exception.

The `orElseTry` and `orElse` functions will also continue processing if the `try` function fails.
See the `orElseTry` and `orElse` documentation for more complete examples of handling failing `try`
function expressions.

Note: Instead of using the `orElseTry` and `orElse` functions, based on the output of the `try`
function, you can add conditional logic to execute when the result is `success: true` or
`success: false`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>delegate</code></p></td><td><p>The function to evaluate.</p></td></tr></tbody></table>

### Example

This example calls the `try` function using the `randomNumber` function as argument. The function
`randomNumber` generates a random number and calls `fail` if the number is greater than 0.5. The
declaration of this function is in the script’s header.

#### Source

```DataWeave
%dw 2.0
import try, fail from dw::Runtime
output application/json
fun randomNumber() =
if(random() > 0.5)
  fail("This function is failing")
 else
  "OK"
---
try(() -> randomNumber())
```

#### Output

When `randomNumber` fails, the output is:

```JSON
{
  "success": false,
  "error": {
    "kind": "UserException",
    "message": "This function is failing",
    "location": "Unknown location",
    "stack": [
      "fail (anonymous:0:0)",
      "myFunction (anonymous:1:114)",
      "main (anonymous:1:179)"
    ]
  }
}
```

When `randomNumber` succeeds, the output is:

```JSON
{
  "success": true,
  "result": "OK"
}
```

<!-- document id=259566fa155b07f7da0ce37836194daf2f0fc8a3feadacce85d7ef2981612dc1 url=/mulesoft/current/en-us/dataweave/latest/dw-runtime-functions-try.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# try

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## try<T>(delegate: () -> T): TryResult<T>

Evaluates the delegate function and returns an object with `success: true` and `result` if the
delegate function succeeds, or an object with `success: false` and `error` if the delegate function
throws an exception.

The `orElseTry` and `orElse` functions will also continue processing if the `try` function fails.
See the `orElseTry` and `orElse` documentation for more complete examples of handling failing `try`
function expressions.

Note: Instead of using the `orElseTry` and `orElse` functions, based on the output of the `try`
function, you can add conditional logic to execute when the result is `success: true` or
`success: false`.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>delegate</code></p></td><td><p>The function to evaluate.</p></td></tr></tbody></table>

### Example

This example calls the `try` function using the `randomNumber` function as argument. The function
`randomNumber` generates a random number and calls `fail` if the number is greater than 0.5. The
declaration of this function is in the script’s header.

#### Source

```DataWeave
%dw 2.0
import try, fail from dw::Runtime
output application/json
fun randomNumber() =
if(random() > 0.5)
  fail("This function is failing")
 else
  "OK"
---
try(() -> randomNumber())
```

#### Output

When `randomNumber` fails, the output is:

```JSON
{
  "success": false,
  "error": {
    "kind": "UserException",
    "message": "This function is failing",
    "location": "Unknown location",
    "stack": [
      "fail (anonymous:0:0)",
      "myFunction (anonymous:1:114)",
      "main (anonymous:1:179)"
    ]
  }
}
```

When `randomNumber` succeeds, the output is:

```JSON
{
  "success": true,
  "result": "OK"
}
```

<!-- document id=dfc0b0837c97f13947ae2a669560de9f10e94cb26c82bdd75f57f98ceaccb5c8 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-types-coercion.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Type Coercion with DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

In DataWeave, types can be coerced from one type to other using the `as` operator. Type coercion
takes place at runtime.

Note that when you provide an operator with properties that do not match the expected types,
DataWeave automatically attempts to coerce the provided property to the required type.

## Defining DataWeave Types For Type Coercion

The DataWeave example defines the type `Currency` using the `String` type, formats the value with
the Java DecimalFormat pattern (`##`), and then uses `as` to coerce the `price` values to the
`Currency` type.

Input

```xml
<items>
    <item>
        <price>22.30</price>
    </item>
    <item>
        <price>20.31</price>
    </item>
</items>
```

DataWeave

```dataweave
%dw 2.0
output application/json
type Currency = String { format: "\$#,###.00"}
---
books: payload.items.*item map
    book:
        price: $.price as Currency
```

Output

```json
{
  "books": [
    {
      "book": {
        "price": "22.30"
      }
    },
    {
      "book": {
        "price": "20.31"
      }
    }
  ]
}
```

## Type Coercion Table

This table shows the possible combinations and the properties from the schema that are used in the
transformation.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Source</th><th>Target</th><th>Property</th></tr></thead><tbody><tr><td><p><code>Range</code></p></td><td><p><code>Array</code></p></td><td></td></tr><tr><td><p><code>Number</code></p></td><td><p><code>Binary</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>Binary</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>Boolean</code></p></td><td></td></tr><tr><td><p><code>Number</code></p></td><td><p><code>DateTime</code></p></td><td><p><code>unit</code></p></td></tr><tr><td><p><code>LocalDateTime</code></p></td><td><p><code>DateTime</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>DateTime</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>LocalDate</code></p></td><td></td></tr><tr><td><p><code>LocalDateTime</code></p></td><td><p><code>LocalDate</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>LocalDate</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>LocalDateTime</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>LocalDateTime</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>LocalTime</code></p></td><td></td></tr><tr><td><p><code>LocalDateTime</code></p></td><td><p><code>LocalTime</code></p></td><td></td></tr><tr><td><p><code>Time</code></p></td><td><p><code>LocalTime</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>LocalTime</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>Number</code></p></td><td><p><code>unit</code></p></td></tr><tr><td><p><code>String</code></p></td><td><p><code>Number</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>String</code></p></td><td><p><code>Period</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>Regex</code></p></td><td></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>String</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>LocalDateTime</code></p></td><td><p><code>String</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>LocalTime</code></p></td><td><p><code>String</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>LocalDate</code></p></td><td><p><code>String</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>Time</code></p></td><td><p><code>String</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>Period</code></p></td><td><p><code>String</code></p></td><td></td></tr><tr><td><p><code>TimeZone</code></p></td><td><p><code>String</code></p></td><td></td></tr><tr><td><p><code>Number</code></p></td><td><p><code>String</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>Boolean</code></p></td><td><p><code>String</code></p></td><td></td></tr><tr><td><p><code>Range</code></p></td><td><p><code>String</code></p></td><td><p>Returns a string with all the values of the range using <code>,</code> as the separator</p></td></tr><tr><td><p><code>Type</code></p></td><td><p><code>String</code></p></td><td></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>Time</code></p></td><td></td></tr><tr><td><p><code>LocalDateTime</code></p></td><td><p><code>Time</code></p></td><td></td></tr><tr><td><p><code>LocalTime</code></p></td><td><p><code>Time</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>Time</code></p></td><td><p><code>format</code></p></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>TimeZone</code></p></td><td></td></tr><tr><td><p><code>Time</code></p></td><td><p><code>TimeZone</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>TimeZone</code></p></td><td></td></tr></tbody></table>

### Properties for Type Coercion

<table><colgroup><col> <col></colgroup><thead><tr><th>Property</th><th>Description</th></tr></thead><tbody><tr><td><p><code>class</code></p></td><td><div><div><p>Accepts Java classes for Object types.</p></div></div></td></tr><tr><td><p><code>format</code></p></td><td><div><div><p>Accepts Java <code>DecimalFormat</code> patterns to format numbers and dates.</p></div></div></td></tr><tr><td><p><code>locale</code></p></td><td><div><div><p>Accepts Java locales. A Java <code>Locale</code> object represents a region (geographical, political, or cultural).</p></div></div></td></tr><tr><td><p><code>mode</code></p></td><td><div><div><p>Parsing mode for date and time values. Valid values: <code>SMART</code>, <code>STRICT</code>, <code>LENIENT</code></p></div><div><p>Note that <code>LENIENT</code> and <code>SMART</code> autocorrect invalid dates in different ways, but <code>STRICT</code> returns an error on the date. See <a href="#modeExamples">examples</a> that use <code>mode</code>.</p></div></div></td></tr><tr><td><p><code>unit</code></p></td><td><div><div><p>Value can be <code>milliseconds</code> or <code>seconds</code>. These are used for Number to DateTime conversions.</p></div></div></td></tr></tbody></table>

The following examples show uses of the `mode` property. Notice that `LENIENT` and `SMART` return
valid dates when they receive an invalid date such as `02/31/2020`, but the resulting dates differ.
`STRICT` returns an error on an invalid date. The examples use `uuuu` to represent the year instead
of `yyyy`.

DataWeave script:

```dataweave
%dw 2.0
output application/json
---
{
  examples : {

    badDateWithLenient: '02/31/2020' as Date {mode: "LENIENT", format: 'MM/dd/uuuu'},
    badDateWithSmart: '02/31/2020' as Date {mode: "SMART", format: 'MM/dd/uuuu'}
  }
}
```

Output:

```json
%dw 2.0
output application/json
---
{
  "examples": {
    "badDateWithLenient": "03/02/2020",
    "badDateWithSmart": "02/29/2020"
  }
}
```

Using STRICT on an invalid date returns an error. The following example is an error returned by
`badDateWithStrict: '02/31/2020' as Date {mode: "STRICT", format: 'MM/dd/uuuu'}`:

```txt
"Cannot coerce String (02/31/2020) to Date, caused by: Text '02/31/2020' could not be parsed: Invalid date 'FEBRUARY 31'

9| 	badDateWithSmart:
    '02/31/2020' as Date {mode: "STRICT", format: 'MM/dd/uuuu'}
                    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
```

The following example converts two strings into a date format and concatenates the result. The first
string represents the date, and the second string represents the time. The transformation uses `as`
to coerce the first string to `LocalDateTime`, and then to a `String` with the specified format. The
transformation also uses `++` to concatenate the result.

DataWeave script:

```dataweave
%dw 2.0
output application/json
var s1= 20201228 // (uuuuMMdd),
var s2= 1608 //(HHMM)
---
(s1 ++ s2)
as LocalDateTime {format:"uuuuMMddHHmm"}
as String {format:"MM-dd-uuuu HH:mm:ss"}
```

Output:

```json
"12-28-2020 16:08:00"
```

The following example also converts a string into a date format. First, the transformation uses `as`
to coerce the string into a `LocalDateTime` type, and then it coerces the result into a `String`
type with the specified output format.

DataWeave script:

```dataweave
%dw 2.0
output application/json
---
"8/30/2020 4:00:13 PM"
    as LocalDateTime {format: "M/dd/uuuu h:mm:ss a"}
    as String {format: "MM/dd/uuuu"}
```

Output:

```json
"08/30/2020"
```

This example converts a number to a string with a decimal representation:

DataWeave script:

```dataweave
%dw 2.0
output application/json
---
{
     data: 22 as String {format: ".00"}
}
```

Output:

```json
{
  "data": "22.00"
}
```

> [!NOTE] To maintain consistency across all formats, starting with DataWeave 2.5, writing number
> values directly doesn’t preserve formatting and strips trailing zeroes. Format metadata is only
> used to parse the provided string into the correct number representation. To retain this behavior,
> you can re-enable it by using the `stripTrailingZeroes` property. See
> [DataWeave System Properties](https://docs.mulesoft.com/dataweave/2.11/dataweave-system-properties).

The following example uses the `locale` property to format number and date values. First, you coerce
a number value into `String` type to the specified output format that uses the Java DecimalFormat
pattern (##) and also the `locale` property `en` (English) or `es` (Spanish). The `locale: "en"`
property, formats the output number decimal representation using a `.`, while the `locale: "es"`
property, formats the output using a `,`.  
Then, you coerce a date value into `Date` type and then to `String` type with the output format
`dd-MMM-yy` and the `locale` property `en` (English), or `es` (Spanish). The `locale: "en"`
property, formats the month `MMM` in English, while the `locale: "es"` property formats the month in
Spanish.

DataWeave script:

```dataweave
%dw 2.0
output application/json
---
{
    enNumber: 12.3 as String {format: "##.##", locale: "en"},
    esNumber: 12.3 as String {format: "##.##", locale: "es"},
    esDate: "2020-12-31" as Date as String {format: "dd-MMM-yy", locale: "es"},
    enDate: "2020-12-31" as Date as String {format: "dd-MMM-yy", locale: "en"}
}
```

Output:

```json
{
  "enNumber": "12.3",
  "esNumber": "12,3",
  "esDate": "31-dic.-20",
  "enDate": "31-Dec-20"
}
```

## See Also

- [Format Dates and Times](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-format-dates)

- [Supported Data Formats](https://docs.mulesoft.com/dataweave/2.11/dataweave-formats)

<!-- document id=f74eb21b2ed72ba4d404f2e315953401cef6d6fc906a793461d104ac8e913e49 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-types-coercion.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Type Coercion with DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

In DataWeave, types can be coerced from one type to other using the `as` operator. Type coercion
takes place at runtime.

Note that when you provide an operator with properties that do not match the expected types,
DataWeave automatically attempts to coerce the provided property to the required type.

## Defining DataWeave Types For Type Coercion

The DataWeave example defines the type `Currency` using the `String` type, formats the value with
the Java DecimalFormat pattern (`##`), and then uses `as` to coerce the `price` values to the
`Currency` type.

Input

```xml
<items>
    <item>
        <price>22.30</price>
    </item>
    <item>
        <price>20.31</price>
    </item>
</items>
```

DataWeave

```dataweave
%dw 2.0
output application/json
type Currency = String { format: "\$#,###.00"}
---
books: payload.items.*item map
    book:
        price: $.price as Currency
```

Output

```json
{
  "books": [
    {
      "book": {
        "price": "22.30"
      }
    },
    {
      "book": {
        "price": "20.31"
      }
    }
  ]
}
```

## Type Coercion Table

This table shows the possible combinations and the properties from the schema that are used in the
transformation.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Source</th><th>Target</th><th>Property</th></tr></thead><tbody><tr><td><p><code>Range</code></p></td><td><p><code>Array</code></p></td><td></td></tr><tr><td><p><code>Number</code></p></td><td><p><code>Binary</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>Binary</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>Boolean</code></p></td><td></td></tr><tr><td><p><code>Number</code></p></td><td><p><code>DateTime</code></p></td><td><p><code>unit</code></p></td></tr><tr><td><p><code>LocalDateTime</code></p></td><td><p><code>DateTime</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>DateTime</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>LocalDate</code></p></td><td></td></tr><tr><td><p><code>LocalDateTime</code></p></td><td><p><code>LocalDate</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>LocalDate</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>LocalDateTime</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>LocalDateTime</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>LocalTime</code></p></td><td></td></tr><tr><td><p><code>LocalDateTime</code></p></td><td><p><code>LocalTime</code></p></td><td></td></tr><tr><td><p><code>Time</code></p></td><td><p><code>LocalTime</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>LocalTime</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>Number</code></p></td><td><p><code>unit</code></p></td></tr><tr><td><p><code>Period</code></p></td><td><p><code>Number</code></p></td><td><p><code>unit</code></p></td></tr><tr><td><p><code>String</code></p></td><td><p><code>Number</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>String</code></p></td><td><p><code>Period</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>Regex</code></p></td><td></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>String</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>LocalDateTime</code></p></td><td><p><code>String</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>LocalTime</code></p></td><td><p><code>String</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>LocalDate</code></p></td><td><p><code>String</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>Time</code></p></td><td><p><code>String</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>Period</code></p></td><td><p><code>String</code></p></td><td></td></tr><tr><td><p><code>TimeZone</code></p></td><td><p><code>String</code></p></td><td></td></tr><tr><td><p><code>Number</code></p></td><td><p><code>String</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>Boolean</code></p></td><td><p><code>String</code></p></td><td></td></tr><tr><td><p><code>Range</code></p></td><td><p><code>String</code></p></td><td><p>Returns a string with all the values of the range using <code>,</code> as the separator</p></td></tr><tr><td><p><code>Type</code></p></td><td><p><code>String</code></p></td><td></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>Time</code></p></td><td></td></tr><tr><td><p><code>LocalDateTime</code></p></td><td><p><code>Time</code></p></td><td></td></tr><tr><td><p><code>LocalTime</code></p></td><td><p><code>Time</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>Time</code></p></td><td><p><code>format</code></p></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>TimeZone</code></p></td><td></td></tr><tr><td><p><code>Time</code></p></td><td><p><code>TimeZone</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>TimeZone</code></p></td><td></td></tr></tbody></table>

### Properties for Type Coercion

<table><colgroup><col> <col></colgroup><thead><tr><th>Property</th><th>Description</th></tr></thead><tbody><tr><td><p><code>class</code></p></td><td><div><div><p>Accepts Java classes for Object types.</p></div></div></td></tr><tr><td><p><code>format</code></p></td><td><div><div><p>Accepts Java <code>DecimalFormat</code> patterns to format numbers and dates.</p></div></div></td></tr><tr><td><p><code>locale</code></p></td><td><div><div><p>Accepts Java locales. A Java <code>Locale</code> object represents a region (geographical, political, or cultural).</p></div></div></td></tr><tr><td><p><code>mode</code></p></td><td><div><div><p>Parsing mode for date and time values. Valid values: <code>SMART</code>, <code>STRICT</code>, <code>LENIENT</code></p></div><div><p>Note that <code>LENIENT</code> and <code>SMART</code> autocorrect invalid dates in different ways, but <code>STRICT</code> returns an error on the date. See <a href="#modeExamples">examples</a> that use <code>mode</code>.</p></div></div></td></tr><tr><td><p><code>unit</code></p></td><td><div><div><p>Value can be <code>milliseconds</code> or <code>seconds</code>. These are used for Number to DateTime, DateTime to Number, and Period to Number conversions.</p></div></div></td></tr></tbody></table>

The following examples show uses of the `mode` property. Notice that `LENIENT` and `SMART` return
valid dates when they receive an invalid date such as `02/31/2020`, but the resulting dates differ.
`STRICT` returns an error on an invalid date. The examples use `uuuu` to represent the year instead
of `yyyy`.

DataWeave script:

```dataweave
%dw 2.0
output application/json
---
{
  examples : {

    badDateWithLenient: '02/31/2020' as Date {mode: "LENIENT", format: 'MM/dd/uuuu'},
    badDateWithSmart: '02/31/2020' as Date {mode: "SMART", format: 'MM/dd/uuuu'}
  }
}
```

Output:

```json
%dw 2.0
output application/json
---
{
  "examples": {
    "badDateWithLenient": "03/02/2020",
    "badDateWithSmart": "02/29/2020"
  }
}
```

Using STRICT on an invalid date returns an error. The following example is an error returned by
`badDateWithStrict: '02/31/2020' as Date {mode: "STRICT", format: 'MM/dd/uuuu'}`:

```txt
"Cannot coerce String (02/31/2020) to Date, caused by: Text '02/31/2020' could not be parsed: Invalid date 'FEBRUARY 31'

9| 	badDateWithSmart:
    '02/31/2020' as Date {mode: "STRICT", format: 'MM/dd/uuuu'}
                    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
```

The following example converts two strings into a date format and concatenates the result. The first
string represents the date, and the second string represents the time. The transformation uses `as`
to coerce the first string to `LocalDateTime`, and then to a `String` with the specified format. The
transformation also uses `++` to concatenate the result.

DataWeave script:

```dataweave
%dw 2.0
output application/json
var s1= 20201228 // (uuuuMMdd),
var s2= 1608 //(HHMM)
---
(s1 ++ s2)
as LocalDateTime {format:"uuuuMMddHHmm"}
as String {format:"MM-dd-uuuu HH:mm:ss"}
```

Output:

```json
"12-28-2020 16:08:00"
```

The following example also converts a string into a date format. First, the transformation uses `as`
to coerce the string into a `LocalDateTime` type, and then it coerces the result into a `String`
type with the specified output format.

DataWeave script:

```dataweave
%dw 2.0
output application/json
---
"8/30/2020 4:00:13 PM"
    as LocalDateTime {format: "M/dd/uuuu h:mm:ss a"}
    as String {format: "MM/dd/uuuu"}
```

Output:

```json
"08/30/2020"
```

This example converts a number to a string with a decimal representation:

DataWeave script:

```dataweave
%dw 2.0
output application/json
---
{
     data: 22 as String {format: ".00"}
}
```

Output:

```json
{
  "data": "22.00"
}
```

> [!NOTE] To maintain consistency across all formats, starting with DataWeave 2.5, writing number
> values directly doesn’t preserve formatting and strips trailing zeroes. Format metadata is only
> used to parse the provided string into the correct number representation. To retain this behavior,
> you can re-enable it by using the `stripTrailingZeroes` property. See
> [DataWeave System Properties](https://docs.mulesoft.com/dataweave/2.12/dataweave-system-properties).

The following example uses the `locale` property to format number and date values. First, you coerce
a number value into `String` type to the specified output format that uses the Java DecimalFormat
pattern (##) and also the `locale` property `en` (English) or `es` (Spanish). The `locale: "en"`
property, formats the output number decimal representation using a `.`, while the `locale: "es"`
property, formats the output using a `,`.  
Then, you coerce a date value into `Date` type and then to `String` type with the output format
`dd-MMM-yy` and the `locale` property `en` (English), or `es` (Spanish). The `locale: "en"`
property, formats the month `MMM` in English, while the `locale: "es"` property formats the month in
Spanish.

DataWeave script:

```dataweave
%dw 2.0
output application/json
---
{
    enNumber: 12.3 as String {format: "##.##", locale: "en"},
    esNumber: 12.3 as String {format: "##.##", locale: "es"},
    esDate: "2020-12-31" as Date as String {format: "dd-MMM-yy", locale: "es"},
    enDate: "2020-12-31" as Date as String {format: "dd-MMM-yy", locale: "en"}
}
```

Output:

```json
{
  "enNumber": "12.3",
  "esNumber": "12,3",
  "esDate": "31-dic.-20",
  "enDate": "31-Dec-20"
}
```

## See Also

- [Format Dates and Times](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-format-dates)

- [Supported Data Formats](https://docs.mulesoft.com/dataweave/2.12/dataweave-formats)

<!-- document id=2cfbcf17db0900e283a18787053226a9eebc2dfdc5268a68de8f60047e93ac38 url=/mulesoft/current/en-us/dataweave/2.3/dataweave-types-coercion.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Type Coercion with DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

In DataWeave, types can be coerced from one type to other using the `as` operator. Type coercion
takes place at runtime.

Note that when you provide an operator with properties that do not match the expected types,
DataWeave automatically attempts to coerce the provided property to the required type.

## Defining DataWeave Types For Type Coercion

The DataWeave example defines the type `Currency` using the `String` type, formats the value with
the Java DecimalFormat pattern (`##`), and then uses `as` to coerce the `price` values to the
`Currency` type.

Input

```xml
<items>
    <item>
        <price>22.30</price>
    </item>
    <item>
        <price>20.31</price>
    </item>
</items>
```

DataWeave

```dataweave
%dw 2.0
output application/json
type Currency = String { format: "\$#,###.00"}
---
books: payload.items.*item map
    book:
        price: $.price as Currency
```

Output

```json
{
  "books": [
    {
      "book": {
        "price": "22.30"
      }
    },
    {
      "book": {
        "price": "20.31"
      }
    }
  ]
}
```

## Type Coercion Table

This table shows the possible combinations and the properties from the schema that are used in the
transformation.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Source</th><th>Target</th><th>Property</th></tr></thead><tbody><tr><td><p><code>Range</code></p></td><td><p><code>Array</code></p></td><td></td></tr><tr><td><p><code>Number</code></p></td><td><p><code>Binary</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>Binary</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>Boolean</code></p></td><td></td></tr><tr><td><p><code>Number</code></p></td><td><p><code>DateTime</code></p></td><td><p><code>unit</code></p></td></tr><tr><td><p><code>LocalDateTime</code></p></td><td><p><code>DateTime</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>DateTime</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>LocalDate</code></p></td><td></td></tr><tr><td><p><code>LocalDateTime</code></p></td><td><p><code>LocalDate</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>LocalDate</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>LocalDateTime</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>LocalDateTime</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>LocalTime</code></p></td><td></td></tr><tr><td><p><code>LocalDateTime</code></p></td><td><p><code>LocalTime</code></p></td><td></td></tr><tr><td><p><code>Time</code></p></td><td><p><code>LocalTime</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>LocalTime</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>Number</code></p></td><td><p><code>unit</code></p></td></tr><tr><td><p><code>String</code></p></td><td><p><code>Number</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>String</code></p></td><td><p><code>Period</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>Regex</code></p></td><td></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>String</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>LocalDateTime</code></p></td><td><p><code>String</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>LocalTime</code></p></td><td><p><code>String</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>LocalDate</code></p></td><td><p><code>String</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>Time</code></p></td><td><p><code>String</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>Period</code></p></td><td><p><code>String</code></p></td><td></td></tr><tr><td><p><code>TimeZone</code></p></td><td><p><code>String</code></p></td><td></td></tr><tr><td><p><code>Number</code></p></td><td><p><code>String</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>Boolean</code></p></td><td><p><code>String</code></p></td><td></td></tr><tr><td><p><code>Range</code></p></td><td><p><code>String</code></p></td><td><p>Returns a string with all the values of the range using <code>,</code> as the separator</p></td></tr><tr><td><p><code>Type</code></p></td><td><p><code>String</code></p></td><td></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>Time</code></p></td><td></td></tr><tr><td><p><code>LocalDateTime</code></p></td><td><p><code>Time</code></p></td><td></td></tr><tr><td><p><code>LocalTime</code></p></td><td><p><code>Time</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>Time</code></p></td><td><p><code>format</code></p></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>TimeZone</code></p></td><td></td></tr><tr><td><p><code>Time</code></p></td><td><p><code>TimeZone`</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>TimeZone</code></p></td><td></td></tr></tbody></table>

### Properties for Type Coercion

<table><colgroup><col> <col></colgroup><thead><tr><th>Property</th><th>Description</th></tr></thead><tbody><tr><td><p><code>class</code></p></td><td><div><div><p>Accepts Java classes for Object types.</p></div></div></td></tr><tr><td><p><code>format</code></p></td><td><div><div><p>Accepts Java <code>DecimalFormat</code> patterns to format numbers and dates.</p></div></div></td></tr><tr><td><p><code>locale</code></p></td><td><div><div><p>Accepts Java locales. A Java <code>Locale</code> object represents a region (geographical, political, or cultural).</p></div></div></td></tr><tr><td><p><code>mode</code></p></td><td><div><div><p>Parsing mode for date and time values. Valid values: <code>SMART</code>, <code>STRICT</code>, <code>LENIENT</code></p></div><div><p>Note that <code>LENIENT</code> and <code>SMART</code> autocorrect invalid dates in different ways, but <code>STRICT</code> returns an error on the date. See <a href="#modeExamples">examples</a> that use <code>mode</code>.</p></div></div></td></tr><tr><td><p><code>unit</code></p></td><td><div><div><p>Value can be <code>milliseconds</code> or <code>seconds</code>. These are used for Number to DateTime conversions.</p></div></div></td></tr></tbody></table>

The following examples show uses of the `mode` property. Notice that `LENIENT` and `SMART` return
valid dates when they receive an invalid date such as `02/31/2020`, but the resulting dates differ.
`STRICT` returns an error on an invalid date. The examples use `uuuu` to represent the year instead
of `yyyy`.

DataWeave script:

```dataweave
%dw 2.0
output application/json
---
{
  examples : {

    badDateWithLenient: '02/31/2020' as Date {mode: "LENIENT", format: 'MM/dd/uuuu'},
    badDateWithSmart: '02/31/2020' as Date {mode: "SMART", format: 'MM/dd/uuuu'}
  }
}
```

Output:

```json
%dw 2.0
output application/json
---
{
  "examples": {
    "badDateWithLenient": "03/02/2020",
    "badDateWithSmart": "02/29/2020"
  }
}
```

Using STRICT on an invalid date returns an error. The following example is an error returned by
`badDateWithStrict: '02/31/2020' as Date {mode: "STRICT", format: 'MM/dd/uuuu'}`:

```txt
"Cannot coerce String (02/31/2020) to Date, caused by: Text '02/31/2020' could not be parsed: Invalid date 'FEBRUARY 31'

9| 	badDateWithSmart:
    '02/31/2020' as Date {mode: "STRICT", format: 'MM/dd/uuuu'}
                    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
```

The following example converts two strings into a date format and concatenates the result. The first
string represents the date, and the second string represents the time. The transformation uses `as`
to coerce the first string to `LocalDateTime`, and then to a `String` with the specified format. The
transformation also uses `++` to concatenate the result.

DataWeave script:

```dataweave
%dw 2.0
output application/json
var s1= 20201228 // (uuuuMMdd),
var s2= 1608 //(HHMM)
---
(s1 ++ s2)
as LocalDateTime {format:"uuuuMMddHHMM"}
as String {format:"MM-dd-uuuu HH:MM:ss"}
```

Output:

```json
"12-28-2020 16:08:00"
```

The following example also converts a string into a date format. First, the transformation uses `as`
to coerce the string into a `LocalDateTime` type, and then it coerces the result into a `String`
type with the specified output format.

DataWeave script:

```dataweave
%dw 2.0
output application/json
---
"8/30/2020 4:00:13 PM"
    as LocalDateTime {format: "M/dd/uuuu H:MM:ss a"}
    as String {format: "MM/dd/uuuu"}
```

Output:

```json
"08/30/2020"
```

The following example converts a string to a number with decimal representation. First, you
transform the string value `"22"` to `Number` and then to `String` again because `format` adds zeros
when converting from a number to a string. If the input data is the number `22`, it is not necessary
to perform the first `Number` conversion. The latter `Number` conversion makes the output a number
with the decimal representation.

DataWeave script:

```dataweave
%dw 2.0
output application/json
---
{
     data: "22" as Number as String {format: ".00"} as Number
}
```

Output:

```json
{
  "data": 22.0
}
```

The following example uses the `locale` property to format number and date values. First, you coerce
a number value into `String` type to the specified output format that uses the Java DecimalFormat
pattern (##) and also the `locale` property `en` (English) or `es` (Spanish). The `locale: "en"`
property, formats the output number decimal representation using a `.`, while the `locale: "es"`
property, formats the output using a `,`.  
Then, you coerce a date value into `Date` type and then to `String` type with the output format
`dd-MMM-yy` and the `locale` property `en` (English), or `es` (Spanish). The `locale: "en"`
property, formats the month `MMM` in English, while the `locale: "es"` property formats the month in
Spanish.

DataWeave script:

```dataweave
%dw 2.0
output application/json
---
{
    enNumber: 12.3 as String {format: "##.##", locale: "en"},
    esNumber: 12.3 as String {format: "##.##", locale: "es"},
    esDate: "2020-12-31" as Date as String {format: "dd-MMM-yy", locale: "es"},
    enDate: "2020-12-31" as Date as String {format: "dd-MMM-yy", locale: "en"}
}
```

Output:

```json
{
  "enNumber": "12.3",
  "esNumber": "12,3",
  "esDate": "31-dic.-20",
  "enDate": "31-Dec-20"
}
```

## See Also

- [Format Dates and Times](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-format-dates)

- [Supported Data Formats](https://docs.mulesoft.com/dataweave/2.3/dataweave-formats)

<!-- document id=f68254b880aeef4c21a04f5b063a464a58db4c490f74654812db48331cbcc546 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-types-coercion.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Type Coercion with DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

In DataWeave, types can be coerced from one type to other using the `as` operator. Type coercion
takes place at runtime.

Note that when you provide an operator with properties that do not match the expected types,
DataWeave automatically attempts to coerce the provided property to the required type.

## Defining DataWeave Types For Type Coercion

The DataWeave example defines the type `Currency` using the `String` type, formats the value with
the Java DecimalFormat pattern (`##`), and then uses `as` to coerce the `price` values to the
`Currency` type.

Input

```xml
<items>
    <item>
        <price>22.30</price>
    </item>
    <item>
        <price>20.31</price>
    </item>
</items>
```

DataWeave

```dataweave
%dw 2.0
output application/json
type Currency = String { format: "\$#,###.00"}
---
books: payload.items.*item map
    book:
        price: $.price as Currency
```

Output

```json
{
  "books": [
    {
      "book": {
        "price": "22.30"
      }
    },
    {
      "book": {
        "price": "20.31"
      }
    }
  ]
}
```

## Type Coercion Table

This table shows the possible combinations and the properties from the schema that are used in the
transformation.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Source</th><th>Target</th><th>Property</th></tr></thead><tbody><tr><td><p><code>Range</code></p></td><td><p><code>Array</code></p></td><td></td></tr><tr><td><p><code>Number</code></p></td><td><p><code>Binary</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>Binary</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>Boolean</code></p></td><td></td></tr><tr><td><p><code>Number</code></p></td><td><p><code>DateTime</code></p></td><td><p><code>unit</code></p></td></tr><tr><td><p><code>LocalDateTime</code></p></td><td><p><code>DateTime</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>DateTime</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>LocalDate</code></p></td><td></td></tr><tr><td><p><code>LocalDateTime</code></p></td><td><p><code>LocalDate</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>LocalDate</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>LocalDateTime</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>LocalDateTime</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>LocalTime</code></p></td><td></td></tr><tr><td><p><code>LocalDateTime</code></p></td><td><p><code>LocalTime</code></p></td><td></td></tr><tr><td><p><code>Time</code></p></td><td><p><code>LocalTime</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>LocalTime</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>Number</code></p></td><td><p><code>unit</code></p></td></tr><tr><td><p><code>String</code></p></td><td><p><code>Number</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>String</code></p></td><td><p><code>Period</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>Regex</code></p></td><td></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>String</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>LocalDateTime</code></p></td><td><p><code>String</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>LocalTime</code></p></td><td><p><code>String</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>LocalDate</code></p></td><td><p><code>String</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>Time</code></p></td><td><p><code>String</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>Period</code></p></td><td><p><code>String</code></p></td><td></td></tr><tr><td><p><code>TimeZone</code></p></td><td><p><code>String</code></p></td><td></td></tr><tr><td><p><code>Number</code></p></td><td><p><code>String</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>Boolean</code></p></td><td><p><code>String</code></p></td><td></td></tr><tr><td><p><code>Range</code></p></td><td><p><code>String</code></p></td><td><p>Returns a string with all the values of the range using <code>,</code> as the separator</p></td></tr><tr><td><p><code>Type</code></p></td><td><p><code>String</code></p></td><td></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>Time</code></p></td><td></td></tr><tr><td><p><code>LocalDateTime</code></p></td><td><p><code>Time</code></p></td><td></td></tr><tr><td><p><code>LocalTime</code></p></td><td><p><code>Time</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>Time</code></p></td><td><p><code>format</code></p></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>TimeZone</code></p></td><td></td></tr><tr><td><p><code>Time</code></p></td><td><p><code>TimeZone`</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>TimeZone</code></p></td><td></td></tr></tbody></table>

### Properties for Type Coercion

<table><colgroup><col> <col></colgroup><thead><tr><th>Property</th><th>Description</th></tr></thead><tbody><tr><td><p><code>class</code></p></td><td><div><div><p>Accepts Java classes for Object types.</p></div></div></td></tr><tr><td><p><code>format</code></p></td><td><div><div><p>Accepts Java <code>DecimalFormat</code> patterns to format numbers and dates.</p></div></div></td></tr><tr><td><p><code>locale</code></p></td><td><div><div><p>Accepts Java locales. A Java <code>Locale</code> object represents a region (geographical, political, or cultural).</p></div></div></td></tr><tr><td><p><code>mode</code></p></td><td><div><div><p>Parsing mode for date and time values. Valid values: <code>SMART</code>, <code>STRICT</code>, <code>LENIENT</code></p></div><div><p>Note that <code>LENIENT</code> and <code>SMART</code> autocorrect invalid dates in different ways, but <code>STRICT</code> returns an error on the date. See <a href="#modeExamples">examples</a> that use <code>mode</code>.</p></div></div></td></tr><tr><td><p><code>unit</code></p></td><td><div><div><p>Value can be <code>milliseconds</code> or <code>seconds</code>. These are used for Number to DateTime conversions.</p></div></div></td></tr></tbody></table>

The following examples show uses of the `mode` property. Notice that `LENIENT` and `SMART` return
valid dates when they receive an invalid date such as `02/31/2020`, but the resulting dates differ.
`STRICT` returns an error on an invalid date. The examples use `uuuu` to represent the year instead
of `yyyy`.

DataWeave script:

```dataweave
%dw 2.0
output application/json
---
{
  examples : {

    badDateWithLenient: '02/31/2020' as Date {mode: "LENIENT", format: 'MM/dd/uuuu'},
    badDateWithSmart: '02/31/2020' as Date {mode: "SMART", format: 'MM/dd/uuuu'}
  }
}
```

Output:

```json
%dw 2.0
output application/json
---
{
  "examples": {
    "badDateWithLenient": "03/02/2020",
    "badDateWithSmart": "02/29/2020"
  }
}
```

Using STRICT on an invalid date returns an error. The following example is an error returned by
`badDateWithStrict: '02/31/2020' as Date {mode: "STRICT", format: 'MM/dd/uuuu'}`:

```txt
"Cannot coerce String (02/31/2020) to Date, caused by: Text '02/31/2020' could not be parsed: Invalid date 'FEBRUARY 31'

9| 	badDateWithSmart:
    '02/31/2020' as Date {mode: "STRICT", format: 'MM/dd/uuuu'}
                    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
```

The following example converts two strings into a date format and concatenates the result. The first
string represents the date, and the second string represents the time. The transformation uses `as`
to coerce the first string to `LocalDateTime`, and then to a `String` with the specified format. The
transformation also uses `++` to concatenate the result.

DataWeave script:

```dataweave
%dw 2.0
output application/json
var s1= 20201228 // (uuuuMMdd),
var s2= 1608 //(HHMM)
---
(s1 ++ s2)
as LocalDateTime {format:"uuuuMMddHHmm"}
as String {format:"MM-dd-uuuu HH:mm:ss"}
```

Output:

```json
"12-28-2020 16:08:00"
```

The following example also converts a string into a date format. First, the transformation uses `as`
to coerce the string into a `LocalDateTime` type, and then it coerces the result into a `String`
type with the specified output format.

DataWeave script:

```dataweave
%dw 2.0
output application/json
---
"8/30/2020 4:00:13 PM"
    as LocalDateTime {format: "M/dd/uuuu h:mm:ss a"}
    as String {format: "MM/dd/uuuu"}
```

Output:

```json
"08/30/2020"
```

The following example converts a string to a number with decimal representation. First, you
transform the string value `"22"` to `Number` and then to `String` again because `format` adds zeros
when converting from a number to a string. If the input data is the number `22`, it is not necessary
to perform the first `Number` conversion. The latter `Number` conversion makes the output a number
with the decimal representation.

DataWeave script:

```dataweave
%dw 2.0
output application/json
---
{
     data: "22" as Number as String {format: ".00"} as Number
}
```

Output:

```json
{
  "data": 22.0
}
```

The following example uses the `locale` property to format number and date values. First, you coerce
a number value into `String` type to the specified output format that uses the Java DecimalFormat
pattern (##) and also the `locale` property `en` (English) or `es` (Spanish). The `locale: "en"`
property, formats the output number decimal representation using a `.`, while the `locale: "es"`
property, formats the output using a `,`.  
Then, you coerce a date value into `Date` type and then to `String` type with the output format
`dd-MMM-yy` and the `locale` property `en` (English), or `es` (Spanish). The `locale: "en"`
property, formats the month `MMM` in English, while the `locale: "es"` property formats the month in
Spanish.

DataWeave script:

```dataweave
%dw 2.0
output application/json
---
{
    enNumber: 12.3 as String {format: "##.##", locale: "en"},
    esNumber: 12.3 as String {format: "##.##", locale: "es"},
    esDate: "2020-12-31" as Date as String {format: "dd-MMM-yy", locale: "es"},
    enDate: "2020-12-31" as Date as String {format: "dd-MMM-yy", locale: "en"}
}
```

Output:

```json
{
  "enNumber": "12.3",
  "esNumber": "12,3",
  "esDate": "31-dic.-20",
  "enDate": "31-Dec-20"
}
```

## See Also

- [Format Dates and Times](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-format-dates)

- [Supported Data Formats](https://docs.mulesoft.com/dataweave/2.4/dataweave-formats)

<!-- document id=8dfc7e67d886e5c91439c30d3f0851f967f716124e40be964ebf45a79e0ede9c url=/mulesoft/current/en-us/dataweave/2.6/dataweave-types-coercion.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Type Coercion with DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

In DataWeave, types can be coerced from one type to other using the `as` operator. Type coercion
takes place at runtime.

Note that when you provide an operator with properties that do not match the expected types,
DataWeave automatically attempts to coerce the provided property to the required type.

## Defining DataWeave Types For Type Coercion

The DataWeave example defines the type `Currency` using the `String` type, formats the value with
the Java DecimalFormat pattern (`##`), and then uses `as` to coerce the `price` values to the
`Currency` type.

Input

```xml
<items>
    <item>
        <price>22.30</price>
    </item>
    <item>
        <price>20.31</price>
    </item>
</items>
```

DataWeave

```dataweave
%dw 2.0
output application/json
type Currency = String { format: "\$#,###.00"}
---
books: payload.items.*item map
    book:
        price: $.price as Currency
```

Output

```json
{
  "books": [
    {
      "book": {
        "price": "22.30"
      }
    },
    {
      "book": {
        "price": "20.31"
      }
    }
  ]
}
```

## Type Coercion Table

This table shows the possible combinations and the properties from the schema that are used in the
transformation.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Source</th><th>Target</th><th>Property</th></tr></thead><tbody><tr><td><p><code>Range</code></p></td><td><p><code>Array</code></p></td><td></td></tr><tr><td><p><code>Number</code></p></td><td><p><code>Binary</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>Binary</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>Boolean</code></p></td><td></td></tr><tr><td><p><code>Number</code></p></td><td><p><code>DateTime</code></p></td><td><p><code>unit</code></p></td></tr><tr><td><p><code>LocalDateTime</code></p></td><td><p><code>DateTime</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>DateTime</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>LocalDate</code></p></td><td></td></tr><tr><td><p><code>LocalDateTime</code></p></td><td><p><code>LocalDate</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>LocalDate</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>LocalDateTime</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>LocalDateTime</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>LocalTime</code></p></td><td></td></tr><tr><td><p><code>LocalDateTime</code></p></td><td><p><code>LocalTime</code></p></td><td></td></tr><tr><td><p><code>Time</code></p></td><td><p><code>LocalTime</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>LocalTime</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>Number</code></p></td><td><p><code>unit</code></p></td></tr><tr><td><p><code>String</code></p></td><td><p><code>Number</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>String</code></p></td><td><p><code>Period</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>Regex</code></p></td><td></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>String</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>LocalDateTime</code></p></td><td><p><code>String</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>LocalTime</code></p></td><td><p><code>String</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>LocalDate</code></p></td><td><p><code>String</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>Time</code></p></td><td><p><code>String</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>Period</code></p></td><td><p><code>String</code></p></td><td></td></tr><tr><td><p><code>TimeZone</code></p></td><td><p><code>String</code></p></td><td></td></tr><tr><td><p><code>Number</code></p></td><td><p><code>String</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>Boolean</code></p></td><td><p><code>String</code></p></td><td></td></tr><tr><td><p><code>Range</code></p></td><td><p><code>String</code></p></td><td><p>Returns a string with all the values of the range using <code>,</code> as the separator</p></td></tr><tr><td><p><code>Type</code></p></td><td><p><code>String</code></p></td><td></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>Time</code></p></td><td></td></tr><tr><td><p><code>LocalDateTime</code></p></td><td><p><code>Time</code></p></td><td></td></tr><tr><td><p><code>LocalTime</code></p></td><td><p><code>Time</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>Time</code></p></td><td><p><code>format</code></p></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>TimeZone</code></p></td><td></td></tr><tr><td><p><code>Time</code></p></td><td><p><code>TimeZone`</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>TimeZone</code></p></td><td></td></tr></tbody></table>

### Properties for Type Coercion

<table><colgroup><col> <col></colgroup><thead><tr><th>Property</th><th>Description</th></tr></thead><tbody><tr><td><p><code>class</code></p></td><td><div><div><p>Accepts Java classes for Object types.</p></div></div></td></tr><tr><td><p><code>format</code></p></td><td><div><div><p>Accepts Java <code>DecimalFormat</code> patterns to format numbers and dates.</p></div></div></td></tr><tr><td><p><code>locale</code></p></td><td><div><div><p>Accepts Java locales. A Java <code>Locale</code> object represents a region (geographical, political, or cultural).</p></div></div></td></tr><tr><td><p><code>mode</code></p></td><td><div><div><p>Parsing mode for date and time values. Valid values: <code>SMART</code>, <code>STRICT</code>, <code>LENIENT</code></p></div><div><p>Note that <code>LENIENT</code> and <code>SMART</code> autocorrect invalid dates in different ways, but <code>STRICT</code> returns an error on the date. See <a href="#modeExamples">examples</a> that use <code>mode</code>.</p></div></div></td></tr><tr><td><p><code>unit</code></p></td><td><div><div><p>Value can be <code>milliseconds</code> or <code>seconds</code>. These are used for Number to DateTime conversions.</p></div></div></td></tr></tbody></table>

The following examples show uses of the `mode` property. Notice that `LENIENT` and `SMART` return
valid dates when they receive an invalid date such as `02/31/2020`, but the resulting dates differ.
`STRICT` returns an error on an invalid date. The examples use `uuuu` to represent the year instead
of `yyyy`.

DataWeave script:

```dataweave
%dw 2.0
output application/json
---
{
  examples : {

    badDateWithLenient: '02/31/2020' as Date {mode: "LENIENT", format: 'MM/dd/uuuu'},
    badDateWithSmart: '02/31/2020' as Date {mode: "SMART", format: 'MM/dd/uuuu'}
  }
}
```

Output:

```json
%dw 2.0
output application/json
---
{
  "examples": {
    "badDateWithLenient": "03/02/2020",
    "badDateWithSmart": "02/29/2020"
  }
}
```

Using STRICT on an invalid date returns an error. The following example is an error returned by
`badDateWithStrict: '02/31/2020' as Date {mode: "STRICT", format: 'MM/dd/uuuu'}`:

```txt
"Cannot coerce String (02/31/2020) to Date, caused by: Text '02/31/2020' could not be parsed: Invalid date 'FEBRUARY 31'

9| 	badDateWithSmart:
    '02/31/2020' as Date {mode: "STRICT", format: 'MM/dd/uuuu'}
                    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
```

The following example converts two strings into a date format and concatenates the result. The first
string represents the date, and the second string represents the time. The transformation uses `as`
to coerce the first string to `LocalDateTime`, and then to a `String` with the specified format. The
transformation also uses `++` to concatenate the result.

DataWeave script:

```dataweave
%dw 2.0
output application/json
var s1= 20201228 // (uuuuMMdd),
var s2= 1608 //(HHMM)
---
(s1 ++ s2)
as LocalDateTime {format:"uuuuMMddHHmm"}
as String {format:"MM-dd-uuuu HH:mm:ss"}
```

Output:

```json
"12-28-2020 16:08:00"
```

The following example also converts a string into a date format. First, the transformation uses `as`
to coerce the string into a `LocalDateTime` type, and then it coerces the result into a `String`
type with the specified output format.

DataWeave script:

```dataweave
%dw 2.0
output application/json
---
"8/30/2020 4:00:13 PM"
    as LocalDateTime {format: "M/dd/uuuu h:mm:ss a"}
    as String {format: "MM/dd/uuuu"}
```

Output:

```json
"08/30/2020"
```

This example converts a number to a string with a decimal representation:

DataWeave script:

```dataweave
%dw 2.0
output application/json
---
{
      data: 22 as String {format: ".00"}
}
```

Output:

```json
{
  "data": "22.00"
}
```

> [!NOTE] To maintain consistency across all formats, starting with DataWeave 2.5, writing number
> values directly doesn’t preserve formatting and strips trailing zeroes. Format metadata is only
> used to parse the provided string into the correct number representation. To retain this behavior,
> you can re-enable it by using the `stripTrailingZeroes` property. See
> [DataWeave System Properties](https://docs.mulesoft.com/dataweave/2.6/dataweave-system-properties).

The following example uses the `locale` property to format number and date values. First, you coerce
a number value into `String` type to the specified output format that uses the Java DecimalFormat
pattern (##) and also the `locale` property `en` (English) or `es` (Spanish). The `locale: "en"`
property, formats the output number decimal representation using a `.`, while the `locale: "es"`
property, formats the output using a `,`.  
Then, you coerce a date value into `Date` type and then to `String` type with the output format
`dd-MMM-yy` and the `locale` property `en` (English), or `es` (Spanish). The `locale: "en"`
property, formats the month `MMM` in English, while the `locale: "es"` property formats the month in
Spanish.

DataWeave script:

```dataweave
%dw 2.0
output application/json
---
{
    enNumber: 12.3 as String {format: "##.##", locale: "en"},
    esNumber: 12.3 as String {format: "##.##", locale: "es"},
    esDate: "2020-12-31" as Date as String {format: "dd-MMM-yy", locale: "es"},
    enDate: "2020-12-31" as Date as String {format: "dd-MMM-yy", locale: "en"}
}
```

Output:

```json
{
  "enNumber": "12.3",
  "esNumber": "12,3",
  "esDate": "31-dic.-20",
  "enDate": "31-Dec-20"
}
```

## See Also

- [Format Dates and Times](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-format-dates)

- [Supported Data Formats](https://docs.mulesoft.com/dataweave/2.6/dataweave-formats)

<!-- document id=88e2c6fec5d55ddf8a0f1b8865c6599a014d9f24783198791b8101e3be56df34 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-types-coercion.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Type Coercion with DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

In DataWeave, types can be coerced from one type to other using the `as` operator. Type coercion
takes place at runtime.

Note that when you provide an operator with properties that do not match the expected types,
DataWeave automatically attempts to coerce the provided property to the required type.

## Defining DataWeave Types For Type Coercion

The DataWeave example defines the type `Currency` using the `String` type, formats the value with
the Java DecimalFormat pattern (`##`), and then uses `as` to coerce the `price` values to the
`Currency` type.

Input

```xml
<items>
    <item>
        <price>22.30</price>
    </item>
    <item>
        <price>20.31</price>
    </item>
</items>
```

DataWeave

```dataweave
%dw 2.0
output application/json
type Currency = String { format: "\$#,###.00"}
---
books: payload.items.*item map
    book:
        price: $.price as Currency
```

Output

```json
{
  "books": [
    {
      "book": {
        "price": "22.30"
      }
    },
    {
      "book": {
        "price": "20.31"
      }
    }
  ]
}
```

## Type Coercion Table

This table shows the possible combinations and the properties from the schema that are used in the
transformation.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Source</th><th>Target</th><th>Property</th></tr></thead><tbody><tr><td><p><code>Range</code></p></td><td><p><code>Array</code></p></td><td></td></tr><tr><td><p><code>Number</code></p></td><td><p><code>Binary</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>Binary</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>Boolean</code></p></td><td></td></tr><tr><td><p><code>Number</code></p></td><td><p><code>DateTime</code></p></td><td><p><code>unit</code></p></td></tr><tr><td><p><code>LocalDateTime</code></p></td><td><p><code>DateTime</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>DateTime</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>LocalDate</code></p></td><td></td></tr><tr><td><p><code>LocalDateTime</code></p></td><td><p><code>LocalDate</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>LocalDate</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>LocalDateTime</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>LocalDateTime</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>LocalTime</code></p></td><td></td></tr><tr><td><p><code>LocalDateTime</code></p></td><td><p><code>LocalTime</code></p></td><td></td></tr><tr><td><p><code>Time</code></p></td><td><p><code>LocalTime</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>LocalTime</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>Number</code></p></td><td><p><code>unit</code></p></td></tr><tr><td><p><code>String</code></p></td><td><p><code>Number</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>String</code></p></td><td><p><code>Period</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>Regex</code></p></td><td></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>String</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>LocalDateTime</code></p></td><td><p><code>String</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>LocalTime</code></p></td><td><p><code>String</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>LocalDate</code></p></td><td><p><code>String</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>Time</code></p></td><td><p><code>String</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>Period</code></p></td><td><p><code>String</code></p></td><td></td></tr><tr><td><p><code>TimeZone</code></p></td><td><p><code>String</code></p></td><td></td></tr><tr><td><p><code>Number</code></p></td><td><p><code>String</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>Boolean</code></p></td><td><p><code>String</code></p></td><td></td></tr><tr><td><p><code>Range</code></p></td><td><p><code>String</code></p></td><td><p>Returns a string with all the values of the range using <code>,</code> as the separator</p></td></tr><tr><td><p><code>Type</code></p></td><td><p><code>String</code></p></td><td></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>Time</code></p></td><td></td></tr><tr><td><p><code>LocalDateTime</code></p></td><td><p><code>Time</code></p></td><td></td></tr><tr><td><p><code>LocalTime</code></p></td><td><p><code>Time</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>Time</code></p></td><td><p><code>format</code></p></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>TimeZone</code></p></td><td></td></tr><tr><td><p><code>Time</code></p></td><td><p><code>TimeZone</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>TimeZone</code></p></td><td></td></tr></tbody></table>

### Properties for Type Coercion

<table><colgroup><col> <col></colgroup><thead><tr><th>Property</th><th>Description</th></tr></thead><tbody><tr><td><p><code>class</code></p></td><td><div><div><p>Accepts Java classes for Object types.</p></div></div></td></tr><tr><td><p><code>format</code></p></td><td><div><div><p>Accepts Java <code>DecimalFormat</code> patterns to format numbers and dates.</p></div></div></td></tr><tr><td><p><code>locale</code></p></td><td><div><div><p>Accepts Java locales. A Java <code>Locale</code> object represents a region (geographical, political, or cultural).</p></div></div></td></tr><tr><td><p><code>mode</code></p></td><td><div><div><p>Parsing mode for date and time values. Valid values: <code>SMART</code>, <code>STRICT</code>, <code>LENIENT</code></p></div><div><p>Note that <code>LENIENT</code> and <code>SMART</code> autocorrect invalid dates in different ways, but <code>STRICT</code> returns an error on the date. See <a href="#modeExamples">examples</a> that use <code>mode</code>.</p></div></div></td></tr><tr><td><p><code>unit</code></p></td><td><div><div><p>Value can be <code>milliseconds</code> or <code>seconds</code>. These are used for Number to DateTime conversions.</p></div></div></td></tr></tbody></table>

The following examples show uses of the `mode` property. Notice that `LENIENT` and `SMART` return
valid dates when they receive an invalid date such as `02/31/2020`, but the resulting dates differ.
`STRICT` returns an error on an invalid date. The examples use `uuuu` to represent the year instead
of `yyyy`.

DataWeave script:

```dataweave
%dw 2.0
output application/json
---
{
  examples : {

    badDateWithLenient: '02/31/2020' as Date {mode: "LENIENT", format: 'MM/dd/uuuu'},
    badDateWithSmart: '02/31/2020' as Date {mode: "SMART", format: 'MM/dd/uuuu'}
  }
}
```

Output:

```json
%dw 2.0
output application/json
---
{
  "examples": {
    "badDateWithLenient": "03/02/2020",
    "badDateWithSmart": "02/29/2020"
  }
}
```

Using STRICT on an invalid date returns an error. The following example is an error returned by
`badDateWithStrict: '02/31/2020' as Date {mode: "STRICT", format: 'MM/dd/uuuu'}`:

```txt
"Cannot coerce String (02/31/2020) to Date, caused by: Text '02/31/2020' could not be parsed: Invalid date 'FEBRUARY 31'

9| 	badDateWithSmart:
    '02/31/2020' as Date {mode: "STRICT", format: 'MM/dd/uuuu'}
                    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
```

The following example converts two strings into a date format and concatenates the result. The first
string represents the date, and the second string represents the time. The transformation uses `as`
to coerce the first string to `LocalDateTime`, and then to a `String` with the specified format. The
transformation also uses `++` to concatenate the result.

DataWeave script:

```dataweave
%dw 2.0
output application/json
var s1= 20201228 // (uuuuMMdd),
var s2= 1608 //(HHMM)
---
(s1 ++ s2)
as LocalDateTime {format:"uuuuMMddHHmm"}
as String {format:"MM-dd-uuuu HH:mm:ss"}
```

Output:

```json
"12-28-2020 16:08:00"
```

The following example also converts a string into a date format. First, the transformation uses `as`
to coerce the string into a `LocalDateTime` type, and then it coerces the result into a `String`
type with the specified output format.

DataWeave script:

```dataweave
%dw 2.0
output application/json
---
"8/30/2020 4:00:13 PM"
    as LocalDateTime {format: "M/dd/uuuu h:mm:ss a"}
    as String {format: "MM/dd/uuuu"}
```

Output:

```json
"08/30/2020"
```

This example converts a number to a string with a decimal representation:

DataWeave script:

```dataweave
%dw 2.0
output application/json
---
{
     data: 22 as String {format: ".00"}
}
```

Output:

```json
{
  "data": "22.00"
}
```

> [!NOTE] To maintain consistency across all formats, starting with DataWeave 2.5, writing number
> values directly doesn’t preserve formatting and strips trailing zeroes. Format metadata is only
> used to parse the provided string into the correct number representation. To retain this behavior,
> you can re-enable it by using the `stripTrailingZeroes` property. See
> [DataWeave System Properties](https://docs.mulesoft.com/dataweave/2.9/dataweave-system-properties).

The following example uses the `locale` property to format number and date values. First, you coerce
a number value into `String` type to the specified output format that uses the Java DecimalFormat
pattern (##) and also the `locale` property `en` (English) or `es` (Spanish). The `locale: "en"`
property, formats the output number decimal representation using a `.`, while the `locale: "es"`
property, formats the output using a `,`.  
Then, you coerce a date value into `Date` type and then to `String` type with the output format
`dd-MMM-yy` and the `locale` property `en` (English), or `es` (Spanish). The `locale: "en"`
property, formats the month `MMM` in English, while the `locale: "es"` property formats the month in
Spanish.

DataWeave script:

```dataweave
%dw 2.0
output application/json
---
{
    enNumber: 12.3 as String {format: "##.##", locale: "en"},
    esNumber: 12.3 as String {format: "##.##", locale: "es"},
    esDate: "2020-12-31" as Date as String {format: "dd-MMM-yy", locale: "es"},
    enDate: "2020-12-31" as Date as String {format: "dd-MMM-yy", locale: "en"}
}
```

Output:

```json
{
  "enNumber": "12.3",
  "esNumber": "12,3",
  "esDate": "31-dic.-20",
  "enDate": "31-Dec-20"
}
```

## See Also

- [Format Dates and Times](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-format-dates)

- [Supported Data Formats](https://docs.mulesoft.com/dataweave/2.9/dataweave-formats)

<!-- document id=5375f3b82b3df9fdec955fa4066c7d775403e912e56213adcb18f1c0ca98040e url=/mulesoft/current/en-us/dataweave/latest/dataweave-types-coercion.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Type Coercion with DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

In DataWeave, types can be coerced from one type to other using the `as` operator. Type coercion
takes place at runtime.

Note that when you provide an operator with properties that do not match the expected types,
DataWeave automatically attempts to coerce the provided property to the required type.

## Defining DataWeave Types For Type Coercion

The DataWeave example defines the type `Currency` using the `String` type, formats the value with
the Java DecimalFormat pattern (`##`), and then uses `as` to coerce the `price` values to the
`Currency` type.

Input

```xml
<items>
    <item>
        <price>22.30</price>
    </item>
    <item>
        <price>20.31</price>
    </item>
</items>
```

DataWeave

```dataweave
%dw 2.0
output application/json
type Currency = String { format: "\$#,###.00"}
---
books: payload.items.*item map
    book:
        price: $.price as Currency
```

Output

```json
{
  "books": [
    {
      "book": {
        "price": "22.30"
      }
    },
    {
      "book": {
        "price": "20.31"
      }
    }
  ]
}
```

## Type Coercion Table

This table shows the possible combinations and the properties from the schema that are used in the
transformation.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Source</th><th>Target</th><th>Property</th></tr></thead><tbody><tr><td><p><code>Range</code></p></td><td><p><code>Array</code></p></td><td></td></tr><tr><td><p><code>Number</code></p></td><td><p><code>Binary</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>Binary</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>Boolean</code></p></td><td></td></tr><tr><td><p><code>Number</code></p></td><td><p><code>DateTime</code></p></td><td><p><code>unit</code></p></td></tr><tr><td><p><code>LocalDateTime</code></p></td><td><p><code>DateTime</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>DateTime</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>LocalDate</code></p></td><td></td></tr><tr><td><p><code>LocalDateTime</code></p></td><td><p><code>LocalDate</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>LocalDate</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>LocalDateTime</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>LocalDateTime</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>LocalTime</code></p></td><td></td></tr><tr><td><p><code>LocalDateTime</code></p></td><td><p><code>LocalTime</code></p></td><td></td></tr><tr><td><p><code>Time</code></p></td><td><p><code>LocalTime</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>LocalTime</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>Number</code></p></td><td><p><code>unit</code></p></td></tr><tr><td><p><code>Period</code></p></td><td><p><code>Number</code></p></td><td><p><code>unit</code></p></td></tr><tr><td><p><code>String</code></p></td><td><p><code>Number</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>String</code></p></td><td><p><code>Period</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>Regex</code></p></td><td></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>String</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>LocalDateTime</code></p></td><td><p><code>String</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>LocalTime</code></p></td><td><p><code>String</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>LocalDate</code></p></td><td><p><code>String</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>Time</code></p></td><td><p><code>String</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>Period</code></p></td><td><p><code>String</code></p></td><td></td></tr><tr><td><p><code>TimeZone</code></p></td><td><p><code>String</code></p></td><td></td></tr><tr><td><p><code>Number</code></p></td><td><p><code>String</code></p></td><td><p><code>format</code> / <code>locale</code></p></td></tr><tr><td><p><code>Boolean</code></p></td><td><p><code>String</code></p></td><td></td></tr><tr><td><p><code>Range</code></p></td><td><p><code>String</code></p></td><td><p>Returns a string with all the values of the range using <code>,</code> as the separator</p></td></tr><tr><td><p><code>Type</code></p></td><td><p><code>String</code></p></td><td></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>Time</code></p></td><td></td></tr><tr><td><p><code>LocalDateTime</code></p></td><td><p><code>Time</code></p></td><td></td></tr><tr><td><p><code>LocalTime</code></p></td><td><p><code>Time</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>Time</code></p></td><td><p><code>format</code></p></td></tr><tr><td><p><code>DateTime</code></p></td><td><p><code>TimeZone</code></p></td><td></td></tr><tr><td><p><code>Time</code></p></td><td><p><code>TimeZone</code></p></td><td></td></tr><tr><td><p><code>String</code></p></td><td><p><code>TimeZone</code></p></td><td></td></tr></tbody></table>

### Properties for Type Coercion

<table><colgroup><col> <col></colgroup><thead><tr><th>Property</th><th>Description</th></tr></thead><tbody><tr><td><p><code>class</code></p></td><td><div><div><p>Accepts Java classes for Object types.</p></div></div></td></tr><tr><td><p><code>format</code></p></td><td><div><div><p>Accepts Java <code>DecimalFormat</code> patterns to format numbers and dates.</p></div></div></td></tr><tr><td><p><code>locale</code></p></td><td><div><div><p>Accepts Java locales. A Java <code>Locale</code> object represents a region (geographical, political, or cultural).</p></div></div></td></tr><tr><td><p><code>mode</code></p></td><td><div><div><p>Parsing mode for date and time values. Valid values: <code>SMART</code>, <code>STRICT</code>, <code>LENIENT</code></p></div><div><p>Note that <code>LENIENT</code> and <code>SMART</code> autocorrect invalid dates in different ways, but <code>STRICT</code> returns an error on the date. See <a href="#modeExamples">examples</a> that use <code>mode</code>.</p></div></div></td></tr><tr><td><p><code>unit</code></p></td><td><div><div><p>Value can be <code>milliseconds</code> or <code>seconds</code>. These are used for Number to DateTime, DateTime to Number, and Period to Number conversions.</p></div></div></td></tr></tbody></table>

The following examples show uses of the `mode` property. Notice that `LENIENT` and `SMART` return
valid dates when they receive an invalid date such as `02/31/2020`, but the resulting dates differ.
`STRICT` returns an error on an invalid date. The examples use `uuuu` to represent the year instead
of `yyyy`.

DataWeave script:

```dataweave
%dw 2.0
output application/json
---
{
  examples : {

    badDateWithLenient: '02/31/2020' as Date {mode: "LENIENT", format: 'MM/dd/uuuu'},
    badDateWithSmart: '02/31/2020' as Date {mode: "SMART", format: 'MM/dd/uuuu'}
  }
}
```

Output:

```json
%dw 2.0
output application/json
---
{
  "examples": {
    "badDateWithLenient": "03/02/2020",
    "badDateWithSmart": "02/29/2020"
  }
}
```

Using STRICT on an invalid date returns an error. The following example is an error returned by
`badDateWithStrict: '02/31/2020' as Date {mode: "STRICT", format: 'MM/dd/uuuu'}`:

```txt
"Cannot coerce String (02/31/2020) to Date, caused by: Text '02/31/2020' could not be parsed: Invalid date 'FEBRUARY 31'

9| 	badDateWithSmart:
    '02/31/2020' as Date {mode: "STRICT", format: 'MM/dd/uuuu'}
                    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
```

The following example converts two strings into a date format and concatenates the result. The first
string represents the date, and the second string represents the time. The transformation uses `as`
to coerce the first string to `LocalDateTime`, and then to a `String` with the specified format. The
transformation also uses `++` to concatenate the result.

DataWeave script:

```dataweave
%dw 2.0
output application/json
var s1= 20201228 // (uuuuMMdd),
var s2= 1608 //(HHMM)
---
(s1 ++ s2)
as LocalDateTime {format:"uuuuMMddHHmm"}
as String {format:"MM-dd-uuuu HH:mm:ss"}
```

Output:

```json
"12-28-2020 16:08:00"
```

The following example also converts a string into a date format. First, the transformation uses `as`
to coerce the string into a `LocalDateTime` type, and then it coerces the result into a `String`
type with the specified output format.

DataWeave script:

```dataweave
%dw 2.0
output application/json
---
"8/30/2020 4:00:13 PM"
    as LocalDateTime {format: "M/dd/uuuu h:mm:ss a"}
    as String {format: "MM/dd/uuuu"}
```

Output:

```json
"08/30/2020"
```

This example converts a number to a string with a decimal representation:

DataWeave script:

```dataweave
%dw 2.0
output application/json
---
{
     data: 22 as String {format: ".00"}
}
```

Output:

```json
{
  "data": "22.00"
}
```

> [!NOTE] To maintain consistency across all formats, starting with DataWeave 2.5, writing number
> values directly doesn’t preserve formatting and strips trailing zeroes. Format metadata is only
> used to parse the provided string into the correct number representation. To retain this behavior,
> you can re-enable it by using the `stripTrailingZeroes` property. See
> [DataWeave System Properties](https://docs.mulesoft.com/dataweave/latest/dataweave-system-properties).

The following example uses the `locale` property to format number and date values. First, you coerce
a number value into `String` type to the specified output format that uses the Java DecimalFormat
pattern (##) and also the `locale` property `en` (English) or `es` (Spanish). The `locale: "en"`
property, formats the output number decimal representation using a `.`, while the `locale: "es"`
property, formats the output using a `,`.  
Then, you coerce a date value into `Date` type and then to `String` type with the output format
`dd-MMM-yy` and the `locale` property `en` (English), or `es` (Spanish). The `locale: "en"`
property, formats the month `MMM` in English, while the `locale: "es"` property formats the month in
Spanish.

DataWeave script:

```dataweave
%dw 2.0
output application/json
---
{
    enNumber: 12.3 as String {format: "##.##", locale: "en"},
    esNumber: 12.3 as String {format: "##.##", locale: "es"},
    esDate: "2020-12-31" as Date as String {format: "dd-MMM-yy", locale: "es"},
    enDate: "2020-12-31" as Date as String {format: "dd-MMM-yy", locale: "en"}
}
```

Output:

```json
{
  "enNumber": "12.3",
  "esNumber": "12,3",
  "esDate": "31-dic.-20",
  "enDate": "31-Dec-20"
}
```

## See Also

- [Format Dates and Times](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-format-dates)

- [Supported Data Formats](https://docs.mulesoft.com/dataweave/latest/dataweave-formats)

<!-- document id=2da0f71efe6d2d026bf1d0ac0572e31cd29c0d5a92087aeb916a85fae4933eea url=/mulesoft/current/en-us/dataweave/2.11/dataweave-type-system.md -->

---
product: DataWeave
version: 2.11
---

# Type System

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

2.x versions of DataWeave support a type system. To take advantage of the type-checking that the
type system executes, you need to provide constraint expressions for variables and functions
described in this section. For information about how values for these types are defined, refer to
[Value Constructs for Types](https://docs.mulesoft.com/dataweave/2.11/dataweave-types).

A type system defines a set of constraints to a set of constructs, such as:

- Variables

- Function parameters

These constraints are used in the type-checking phase, when DataWeave ensures that the values
assigned to variables or the arguments for a function call respect its constraints, for example:

DataWeave Script:

%dw 2.0 import \* from dw::core::Strings output application/json

var userName: String = "John"

The variable definition for `userName` has the constraint of assigning a value of type `String`. If
some other value type is assigned, a type-checking error is raised.

DataWeave Script:

%dw 2.0 import \* from dw::core::Strings output application/json

fun toUser(id: Number, userName: String): String = "you called the function toUser!"

The constraints to call the function `toUser` are that the first argument has to be of type
`Number`, the second one of type `String` (to be coercible to those types). Another constraint is
that the result of the function has to be of type `String`. This constraint isn’t used in the call
for `toUser`; it’s applied to its definition to validate that the function body generates the proper
type.

toUser(123, "John") toUser("123", true)

Although you might expect the second call to fail, autocoercion enables the call to be successful,
and both calls work. In the case of the second function call, there is autocoercion of the `String`
value `"123"` to the `Number` value `123`, and the `Boolean` value `true` to the `String` value
`"true"`, which makes it possible to call the function.  
An example of a call that throws a type-checking error is `toUser("a 12", "John")`, because the
String value `"a 12"` isn’t coercible to a `Number` type.

DataWeave also uses a global type inference algorithm to validate your code even if no types are
specified as constraints.

> [!NOTE] Although the use of constraints is optional, they can be useful in big scripts or multiple
> scripts. The type system helps you to avoid bugs in your DataWeave logic because it causes the
> type-checking algorithm to run. Additionally, when you write your script in an IDE and define
> these constraints, the tooling helps you to find type checking errors, instead of when the script
> is running and fails.

The types supported by the DataWeave type system are divided into three categories:

- Simple Types

- Composite Types

- Complex Types

## Simple Types

Simple types represent values such as strings, Booleans, and so on. These values are atomic; they
are not composed of other values. These are the simple types:

- `String`

- `Boolean`

- `Number`

- `Regex`

- `Null`

- Temporal: `Date`, `DateTime`, `LocalDateTime`, `LocalTime`, `Time`, `Period`

### Null

`Null` is a type of only one value, the value `null`, which means that `null` cannot be assigned to
the type `String` or any other type except for the type `Null`.

For example, the `repeat` function in the String module has the signature
`repeat(String, Number): String`, which means that the function accepts as a first parameter only a
value of type `String`, and as a second parameter only a value of type `Number.` The function
returns a value of type `String`.

DataWeave Script:

%dw 2.0 import \* from dw::core::Strings output application/json
---

repeat("a", 3)

This returns `"aaa"`, but the following example throws an error because the value `null` cannot be
assigned to the parameter that expects a value of type `String`:

DataWeave Script:

%dw 2.0 import \* from dw::core::Strings output application/json
---

repeat(null, 3)

In the following example, the script assigns to the first parameter a value that is the type `Null`
(the type of this value is `Type<Null>`). It returns `"NullNullNull"` because autocoercion coerces
the value to the type `String` (`"Null"`).

DataWeave Script:

%dw 2.0 import \* from dw::core::Strings output application/json
---

repeat(Null, 3)

Some functions have an overloaded signature (the function has multiple definitions for different
parameter types) that let you call it with `null`.

For example, the `isNumeric` function from `dw::core::Strings` has the signature
`isNumeric(String): Boolean`, which receives a string and successfully returns a result if that
string is numeric, but the function is also defined as `isNumeric(Null): Boolean`.

So, if you call the function `isNumeric` with `null` (`isNumeric(null)`), the function does not
throw an exception. At runtime, the function that is dispatching algorithm selects the correct
function based on the types of the values you use. The function returns `false` because of the
definition of `isNumeric` for `null` as the argument.

## Composite Types

A composite type contains other values. The composite types are `Array`, `Object` and `Function`.

### Array Type

An array is of the type `Array<T>` in which `T` is a type parameter that defines the type of the
elements inside the array. For example, the syntax to define a variable with the type `Array` of
`Number` is:

var idsList: Array<Number> = \[1, 22, 333, 4444\]

The variable `idsList` passes the type-checking phase only when the array that is assigned to it
only contains values of the `Number` type.

### Object Type

You can define an `Object` type in two ways: `Object` or `{}`. Both define an open object and don’t
specify any constraint to their key-value pairs. See also
[Close and Open Objects](#close_open_objects).

The syntax for defining an `Object` type with a set of constraints for its key-value pairs is very
similar to the syntax for defining the value of an `Object` type:

{ keyName @(attrName: AttrType): valueType, ... }

For example, the syntax to define a `User` type with `firstName` `String`, `lastName` `String`, and
`age` `Number` is:

DataWeave Script:

%dw 2.0 output application/json

type User = { firstName: String, lastName: String, age: Number }

You can apply modifiers to each key-value pair to specify when a field is always present or when a
field can be repeated.

For repeated fields use `*`. For example, the following type allows you to have multiple `lastName`
fields:

DataWeave Script:

%dw 2.0 output application/json

type User = { firstName: String, lastName\*: String, age: Number }

For conditional fields, use `?`. For example, the following type allows the `age` field to be
present or not:

DataWeave Script:

%dw 2.0 output application/json

type User = { firstName: String, lastName\*: String, age?: Number }

#### Close and Open Objects

`Object` type can be either closed or open. A _closed_ object accepts an object value only if there
are no fields except the key-value pairs specified by the type.

An _open_ object only put constraints on the fields that are declared in the type, and if they are
all verified, then the type accepts the value. The type accepts objects that have other fields apart
of the ones mentioned in the declaration. All `object` types are open unless specified.

The following example succeeds even if `age` is not in the type declaration because the type of the
variable `user` is an open object:

DataWeave Script:

%dw 2.0 output application/json

var user: {firstName: String, lastName: String} = {firstName: "John", lastName: "Smith", age: 34}

The syntax to specify a closed object is `{| |}`. The following example makes the `User` type
support only the keys `firstName` and `lastName`. The script throws an exception because the `age`
field is not accepted.

DataWeave Script:

%dw 2.0 output application/json

var user: {|firstName: String, lastName: String|} = {firstName: "John", lastName: "Smith", age: 34}

### Function Type

DataWeave is a functional language, and functions are considered first class citizens, which means
that functions are values with associated types.

The syntax to define a function type is:

(paramType: ParamType,...) -> ReturnType

For example, if you want to define in a constraint a `Function` type that has a parameter of type
`String`, a second parameter of type `Number`, and a `Boolean` return value, the correct syntax is:

(paramA: String, paramB: Number) -> Boolean

In the following example, you define a function that receives another function as an argument:

DataWeave Script:

%dw 2.0 output application/json

fun applyIDsChange(ids: Array<Number>, changeTo: (Number) -> Number): Array<Number> = ???

If you call the function `applyIDsChange` with a function that does not match the `changeTo`
constraint `(Number) → Number`, DataWeave throws a type-checking error.

For example, the following call works because `abs` is a function that takes a value of the `Number`
type and returns a `Number`, which matches the `changeTo` parameter:

applyIDsChange(\[1,-6, 3, -8\], abs)

But the following call fails because `sum` is a function that takes an `Array` and returns a
`Number`, so it does not match the parameter constraint:

applyIDsChange(\[1,-6, 3, -8\], sum)

## Complex Types

Complex types include the `Any` and `Nothing` types, the `Union` type, the `Intersection` type, and
`Literal` types, each of which is named intuitively.

### Any and Nothing

In some cases, you cannot enforce a restriction because the type accepts all the value:

- `Any` type accepts all possible values.

- `Nothing` type accepts no value, but it can be assigned to all the types. This type is not
  frequently used explicitly, but it is used by the type inference algorithm.

### Union Type

The `Union` type is used to compose types. The syntax to define a `Union` type is:

TypeA | TypeB | ...

The following example defines a variable with a constraint that accepts a value of type `String` or
`Number`:

var age: String | Number = if (payload.allStrings) "32" else 32

A common pattern is to use `Null` type with a `Union` type to specify that a type accepts `null` as
a value. In the following example, the function `parseEmail` allows inputs of type `String` or
`Null`. In this case, you can have a object with a payload optional field `email` and you call the
function with `payload.email`.

fun parseEmail(email: String | Null) = "Code that handles email being of type String or Null"

### Intersection Type

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

The `Intersection` type intersects `Object` types. In this case, the intersection works as the
concatenation (`++`) of object types.

The syntax for the `Intersection` type is:

TypeA & TypeB & ...

In the following example, the `Intersection` concatenates the two `Object` types, resulting in the
type `{name: String, lastName: String}`. The type is an open object that can accept additional
key-value pairs. The variable accepts the value assigned to it:

var a: {name: String} & {lastName: String} = {name: "John", lastName: "Smith", age: 34}

In the case of closed objects, it returns the concatenation of the object types but results in a
closed object.  
In the following example, the intersection results in the type `{|name: String, lastName: String|}`,
which throws an exception because a closed object does not accept an `Object` value if there are
additional fields in the object (field `age`):

var a: {|name: String|} & {|lastName: String|} = {name: "John", lastName: "Smith", age: 34}

### Literal Types

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

A literal type represents exactly one value. For example, the `String` value `"foo"` can be
represented with the type `"foo"`.

The following literal types are included to the type system:

- `String` literal types

- `Number` literal types

- `Boolean` literal types

You can use literal types with `Union` types to declare a type as a finite set of allowed values.
For example, the following type declarations are aliases of `Union` and literal types:

type Weekdays = "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" type Days = Weekdays |
"Saturday" | "Sunday"

In the following example, the variable accepts only a value of the literal types `404` and `500`.
The type system ensures before runtime that the variable can be only one of those literal values:

DataWeave Script:

%dw 2.0 output application/json

var errorStatusCode: 404 | 500 = payload.statusCode match { case "error 404" -> 404 case "error 500"
-> 500 }

Function overloading enables you to define different behaviors based on the input argument’s value:

DataWeave Script:

%dw 2.0 import \* from dw::core::Strings output application/json

fun errorHandling(errorCode: 404 | 405, response): String = "Code for error 4XX handling here!" fun
errorHandling(errorCode: 500 | 501, response): String = "Code for error 5XX handling here!"
---

errorHandling(payload.statusCode, payload)

At runtime, the function-dispatching algorithm selects the correct function based on the type of the
value of `payload.statusCode`. It is not necessary to check the value of an argument with an `if`
statement to change the behavior of the function.

### Type Parameters

A type parameter enables you to write a function or data type generically so that you can handle
values identically, without depending on the type of the values.

For example, you can define a function that returns the first element of an array without losing its
type information. In the example, the variable definitions `firstString:String` and
`firstNumber:Number` specify the type of the item in the array that the `head` function takes as
input.

```DataWeave
%dw 2.0
fun head<ItemType>(elements: Array<ItemType>): ItemType = elements[0]!

var firstString:String = head(["DataWeave", "Java", "Scala", "Haskell"]) ++ " Rules!!!"
var firstNumber:Number = head([1,2,3])
output application/json
---
firstNumber
```

In the body of the script, `firstNumber` returns the number `1`. If you replace `firstNumber` with
`firstString`, the script returns the string `"DataWeave Rules!!!"`.

#### Binding Type Parameters

You can bind type parameters to require a value of a specific type. Appending `{name: "DataWeave"}`
in the following example is valid because `{name: String}` in the function definition indicates that
the value of the `name` key must be a string.

```DataWeave
%dw 2.0

fun addName<User <: {} >(user: User): User & {name: String} = user ++ {name: "DataWeave"}

var myUser: {name: String, developers: Number} = addName({developers: 3})
```

#### Parameterizing Type Definitions

You can use type parameters to parameterize type definitions. For example, assume that you define a
data structure that models file content, one for text files and the other for binary files. You can
use type parameters to construct new types that dispatch the correct implementation.

```DataWeave
%dw 2.0

type FileData<Content> = {
    data: Content,
    name: String
}

fun read(file: FileData<String>) =  "This is a text file with data " ++ file.data
fun read(file: FileData<Binary>) =  "This is a binary file with data " ++ (file.data as String {base: "64"})

---
{
  binary: read({data: "Hello World" as Binary, name: "myFile.bin"}),
  text: read({data: "Hello World", name: "myFile.txt"})
}
```

## Reuse Types

You can declare and use types within the same DataWeave script (see
[Type System](https://docs.mulesoft.com/dataweave/2.11/dataweave-type-system)), or you can reuse types from different sources by loading them
with a specific module loader. DataWeave currently supports loading types from:

- [Reusing Types from DataWeave Modules](https://docs.mulesoft.com/dataweave/2.11/dataweave-type-reuse-modules)

- [Reusing Types from a JSON Schema](https://docs.mulesoft.com/dataweave/2.11/dataweave-type-reuse-json-schema)

- [Reusing an XML Schema](https://docs.mulesoft.com/dataweave/2.11/dataweave-type-reuse-xml-schema)

- [Reusing Types from Java Classes](https://docs.mulesoft.com/dataweave/2.11/dataweave-type-reuse-java-classes)

- [Reusing Types from an Avro Schema](https://docs.mulesoft.com/dataweave/2.11/dataweave-type-reuse-avro-schema)

Module loaders are used to load files as DataWeave modules, in which different parts of those files
are loaded as DataWeave functions, variables, types, and namespace definitions. Using a prefix such
as `java!` or `xmlschema!` in the import directive tells DataWeave which module loader to use when
loading the Java class or the XML schema as a DataWeave module.

<!-- document id=1b376814a93cbc7cb79771c1de50174e39597512dc5555f2e60ce55c8a310b09 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-type-system.md -->

---
product: DataWeave
version: 2.12
---

# Type System

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

2.x versions of DataWeave support a type system. To take advantage of the type-checking that the
type system executes, you need to provide constraint expressions for variables and functions
described in this section. For information about how values for these types are defined, refer to
[Value Constructs for Types](https://docs.mulesoft.com/dataweave/2.12/dataweave-types).

A type system defines a set of constraints to a set of constructs, such as:

- Variables

- Function parameters

These constraints are used in the type-checking phase, when DataWeave ensures that the values
assigned to variables or the arguments for a function call respect its constraints, for example:

DataWeave Script:

%dw 2.0 import \* from dw::core::Strings output application/json

var userName: String = "John"

The variable definition for `userName` has the constraint of assigning a value of type `String`. If
some other value type is assigned, a type-checking error is raised.

DataWeave Script:

%dw 2.0 import \* from dw::core::Strings output application/json

fun toUser(id: Number, userName: String): String = "you called the function toUser!"

The constraints to call the function `toUser` are that the first argument has to be of type
`Number`, the second one of type `String` (to be coercible to those types). Another constraint is
that the result of the function has to be of type `String`. This constraint isn’t used in the call
for `toUser`; it’s applied to its definition to validate that the function body generates the proper
type.

toUser(123, "John") toUser("123", true)

Although you might expect the second call to fail, autocoercion enables the call to be successful,
and both calls work. In the case of the second function call, there is autocoercion of the `String`
value `"123"` to the `Number` value `123`, and the `Boolean` value `true` to the `String` value
`"true"`, which makes it possible to call the function.  
An example of a call that throws a type-checking error is `toUser("a 12", "John")`, because the
String value `"a 12"` isn’t coercible to a `Number` type.

DataWeave also uses a global type inference algorithm to validate your code even if no types are
specified as constraints.

> [!NOTE] Although the use of constraints is optional, they can be useful in big scripts or multiple
> scripts. The type system helps you to avoid bugs in your DataWeave logic because it causes the
> type-checking algorithm to run. Additionally, when you write your script in an IDE and define
> these constraints, the tooling helps you to find type checking errors, instead of when the script
> is running and fails.

The types supported by the DataWeave type system are divided into three categories:

- Simple Types

- Composite Types

- Complex Types

## Simple Types

Simple types represent values such as strings, Booleans, and so on. These values are atomic; they
are not composed of other values. These are the simple types:

- `String`

- `Boolean`

- `Number`

- `Regex`

- `Null`

- Temporal: `Date`, `DateTime`, `LocalDateTime`, `LocalTime`, `Time`, `Period`

### Null

`Null` is a type of only one value, the value `null`, which means that `null` cannot be assigned to
the type `String` or any other type except for the type `Null`.

For example, the `repeat` function in the String module has the signature
`repeat(String, Number): String`, which means that the function accepts as a first parameter only a
value of type `String`, and as a second parameter only a value of type `Number.` The function
returns a value of type `String`.

DataWeave Script:

%dw 2.0 import \* from dw::core::Strings output application/json
---

repeat("a", 3)

This returns `"aaa"`, but the following example throws an error because the value `null` cannot be
assigned to the parameter that expects a value of type `String`:

DataWeave Script:

%dw 2.0 import \* from dw::core::Strings output application/json
---

repeat(null, 3)

In the following example, the script assigns to the first parameter a value that is the type `Null`
(the type of this value is `Type<Null>`). It returns `"NullNullNull"` because autocoercion coerces
the value to the type `String` (`"Null"`).

DataWeave Script:

%dw 2.0 import \* from dw::core::Strings output application/json
---

repeat(Null, 3)

Some functions have an overloaded signature (the function has multiple definitions for different
parameter types) that let you call it with `null`.

For example, the `isNumeric` function from `dw::core::Strings` has the signature
`isNumeric(String): Boolean`, which receives a string and successfully returns a result if that
string is numeric, but the function is also defined as `isNumeric(Null): Boolean`.

So, if you call the function `isNumeric` with `null` (`isNumeric(null)`), the function does not
throw an exception. At runtime, the function that is dispatching algorithm selects the correct
function based on the types of the values you use. The function returns `false` because of the
definition of `isNumeric` for `null` as the argument.

## Composite Types

A composite type contains other values. The composite types are `Array`, `Object` and `Function`.

### Array Type

An array is of the type `Array<T>` in which `T` is a type parameter that defines the type of the
elements inside the array. For example, the syntax to define a variable with the type `Array` of
`Number` is:

var idsList: Array<Number> = \[1, 22, 333, 4444\]

The variable `idsList` passes the type-checking phase only when the array that is assigned to it
only contains values of the `Number` type.

### Object Type

You can define an `Object` type in two ways: `Object` or `{}`. Both define an open object and don’t
specify any constraint to their key-value pairs. See also
[Close and Open Objects](#close_open_objects).

The syntax for defining an `Object` type with a set of constraints for its key-value pairs is very
similar to the syntax for defining the value of an `Object` type:

{ keyName @(attrName: AttrType): valueType, ... }

For example, the syntax to define a `User` type with `firstName` `String`, `lastName` `String`, and
`age` `Number` is:

DataWeave Script:

%dw 2.0 output application/json

type User = { firstName: String, lastName: String, age: Number }

You can apply modifiers to each key-value pair to specify when a field is always present or when a
field can be repeated.

For repeated fields use `*`. For example, the following type allows you to have multiple `lastName`
fields:

DataWeave Script:

%dw 2.0 output application/json

type User = { firstName: String, lastName\*: String, age: Number }

For conditional fields, use `?`. For example, the following type allows the `age` field to be
present or not:

DataWeave Script:

%dw 2.0 output application/json

type User = { firstName: String, lastName\*: String, age?: Number }

#### Close and Open Objects

`Object` type can be either closed or open. A _closed_ object accepts an object value only if there
are no fields except the key-value pairs specified by the type.

An _open_ object only put constraints on the fields that are declared in the type, and if they are
all verified, then the type accepts the value. The type accepts objects that have other fields apart
of the ones mentioned in the declaration. All `object` types are open unless specified.

The following example succeeds even if `age` is not in the type declaration because the type of the
variable `user` is an open object:

DataWeave Script:

%dw 2.0 output application/json

var user: {firstName: String, lastName: String} = {firstName: "John", lastName: "Smith", age: 34}

The syntax to specify a closed object is `{| |}`. The following example makes the `User` type
support only the keys `firstName` and `lastName`. The script throws an exception because the `age`
field is not accepted.

DataWeave Script:

%dw 2.0 output application/json

var user: {|firstName: String, lastName: String|} = {firstName: "John", lastName: "Smith", age: 34}

### Function Type

DataWeave is a functional language, and functions are considered first class citizens, which means
that functions are values with associated types.

The syntax to define a function type is:

(paramType: ParamType,...) -> ReturnType

For example, if you want to define in a constraint a `Function` type that has a parameter of type
`String`, a second parameter of type `Number`, and a `Boolean` return value, the correct syntax is:

(paramA: String, paramB: Number) -> Boolean

In the following example, you define a function that receives another function as an argument:

DataWeave Script:

%dw 2.0 output application/json

fun applyIDsChange(ids: Array<Number>, changeTo: (Number) -> Number): Array<Number> = ???

If you call the function `applyIDsChange` with a function that does not match the `changeTo`
constraint `(Number) → Number`, DataWeave throws a type-checking error.

For example, the following call works because `abs` is a function that takes a value of the `Number`
type and returns a `Number`, which matches the `changeTo` parameter:

applyIDsChange(\[1,-6, 3, -8\], abs)

But the following call fails because `sum` is a function that takes an `Array` and returns a
`Number`, so it does not match the parameter constraint:

applyIDsChange(\[1,-6, 3, -8\], sum)

## Complex Types

Complex types include the `Any` and `Nothing` types, the `Union` type, the `Intersection` type, and
`Literal` types, each of which is named intuitively.

### Any and Nothing

In some cases, you cannot enforce a restriction because the type accepts all the value:

- `Any` type accepts all possible values.

- `Nothing` type accepts no value, but it can be assigned to all the types. This type is not
  frequently used explicitly, but it is used by the type inference algorithm.

### Union Type

The `Union` type is used to compose types. The syntax to define a `Union` type is:

TypeA | TypeB | ...

The following example defines a variable with a constraint that accepts a value of type `String` or
`Number`:

var age: String | Number = if (payload.allStrings) "32" else 32

A common pattern is to use `Null` type with a `Union` type to specify that a type accepts `null` as
a value. In the following example, the function `parseEmail` allows inputs of type `String` or
`Null`. In this case, you can have a object with a payload optional field `email` and you call the
function with `payload.email`.

fun parseEmail(email: String | Null) = "Code that handles email being of type String or Null"

### Intersection Type

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

The `Intersection` type intersects `Object` types. In this case, the intersection works as the
concatenation (`++`) of object types.

The syntax for the `Intersection` type is:

TypeA & TypeB & ...

In the following example, the `Intersection` concatenates the two `Object` types, resulting in the
type `{name: String, lastName: String}`. The type is an open object that can accept additional
key-value pairs. The variable accepts the value assigned to it:

var a: {name: String} & {lastName: String} = {name: "John", lastName: "Smith", age: 34}

In the case of closed objects, it returns the concatenation of the object types but results in a
closed object.  
In the following example, the intersection results in the type `{|name: String, lastName: String|}`,
which throws an exception because a closed object does not accept an `Object` value if there are
additional fields in the object (field `age`):

var a: {|name: String|} & {|lastName: String|} = {name: "John", lastName: "Smith", age: 34}

### Literal Types

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

A literal type represents exactly one value. For example, the `String` value `"foo"` can be
represented with the type `"foo"`.

The following literal types are included to the type system:

- `String` literal types

- `Number` literal types

- `Boolean` literal types

You can use literal types with `Union` types to declare a type as a finite set of allowed values.
For example, the following type declarations are aliases of `Union` and literal types:

type Weekdays = "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" type Days = Weekdays |
"Saturday" | "Sunday"

In the following example, the variable accepts only a value of the literal types `404` and `500`.
The type system ensures before runtime that the variable can be only one of those literal values:

DataWeave Script:

%dw 2.0 output application/json

var errorStatusCode: 404 | 500 = payload.statusCode match { case "error 404" -> 404 case "error 500"
-> 500 }

Function overloading enables you to define different behaviors based on the input argument’s value:

DataWeave Script:

%dw 2.0 import \* from dw::core::Strings output application/json

fun errorHandling(errorCode: 404 | 405, response): String = "Code for error 4XX handling here!" fun
errorHandling(errorCode: 500 | 501, response): String = "Code for error 5XX handling here!"
---

errorHandling(payload.statusCode, payload)

At runtime, the function-dispatching algorithm selects the correct function based on the type of the
value of `payload.statusCode`. It is not necessary to check the value of an argument with an `if`
statement to change the behavior of the function.

### Type Parameters

A type parameter enables you to write a function or data type generically so that you can handle
values identically, without depending on the type of the values.

For example, you can define a function that returns the first element of an array without losing its
type information. In the example, the variable definitions `firstString:String` and
`firstNumber:Number` specify the type of the item in the array that the `head` function takes as
input.

```DataWeave
%dw 2.0
fun head<ItemType>(elements: Array<ItemType>): ItemType = elements[0]!

var firstString:String = head(["DataWeave", "Java", "Scala", "Haskell"]) ++ " Rules!!!"
var firstNumber:Number = head([1,2,3])
output application/json
---
firstNumber
```

In the body of the script, `firstNumber` returns the number `1`. If you replace `firstNumber` with
`firstString`, the script returns the string `"DataWeave Rules!!!"`.

#### Binding Type Parameters

You can bind type parameters to require a value of a specific type. Appending `{name: "DataWeave"}`
in the following example is valid because `{name: String}` in the function definition indicates that
the value of the `name` key must be a string.

```DataWeave
%dw 2.0

fun addName<User <: {} >(user: User): User & {name: String} = user ++ {name: "DataWeave"}

var myUser: {name: String, developers: Number} = addName({developers: 3})
```

#### Parameterizing Type Definitions

You can use type parameters to parameterize type definitions. For example, assume that you define a
data structure that models file content, one for text files and the other for binary files. You can
use type parameters to construct new types that dispatch the correct implementation.

```DataWeave
%dw 2.0

type FileData<Content> = {
    data: Content,
    name: String
}

fun read(file: FileData<String>) =  "This is a text file with data " ++ file.data
fun read(file: FileData<Binary>) =  "This is a binary file with data " ++ (file.data as String {base: "64"})

---
{
  binary: read({data: "Hello World" as Binary, name: "myFile.bin"}),
  text: read({data: "Hello World", name: "myFile.txt"})
}
```

## Reuse Types

You can declare and use types within the same DataWeave script (see
[Type System](https://docs.mulesoft.com/dataweave/2.12/dataweave-type-system)), or you can reuse types from different sources by loading them
with a specific module loader. DataWeave currently supports loading types from:

- [Reusing Types from DataWeave Modules](https://docs.mulesoft.com/dataweave/2.12/dataweave-type-reuse-modules)

- [Reusing Types from a JSON Schema](https://docs.mulesoft.com/dataweave/2.12/dataweave-type-reuse-json-schema)

- [Reusing an XML Schema](https://docs.mulesoft.com/dataweave/2.12/dataweave-type-reuse-xml-schema)

- [Reusing Types from Java Classes](https://docs.mulesoft.com/dataweave/2.12/dataweave-type-reuse-java-classes)

- [Reusing Types from an Avro Schema](https://docs.mulesoft.com/dataweave/2.12/dataweave-type-reuse-avro-schema)

Module loaders are used to load files as DataWeave modules, in which different parts of those files
are loaded as DataWeave functions, variables, types, and namespace definitions. Using a prefix such
as `java!` or `xmlschema!` in the import directive tells DataWeave which module loader to use when
loading the Java class or the XML schema as a DataWeave module.

<!-- document id=0755c9cee5b26e0320ae6b43dbf78213ccf6f7f1b2b41f1493d648a4db09bcbc url=/mulesoft/current/en-us/dataweave/2.3/dataweave-type-system.md -->

---
product: DataWeave
version: 2.3
---

# Type System

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave version 2 supports a type system. To take advantage of the type-checking that the type
system executes, you need to provide constraint expressions for variables and functions described in
this section. For information about how values for these types are defined, refer to
[Value Constructs for Types](https://docs.mulesoft.com/dataweave/2.3/dataweave-types).

A type system defines a set of constraints to a set of constructs, such as:

- Variables

- Function parameters

These constraints are used in the type-checking phase, when DataWeave ensures that the values
assigned to variables or the arguments for a function call respect its constraints, for example:

DataWeave Script

%dw 2.0 import \* from dw::core::Strings output application/json

var userName: String = "John"

The variable definition for `userName` has the constraint of assigning a value of type `String`. If
some other value type is assigned, a type-checking error is raised.

DataWeave Script

%dw 2.0 import \* from dw::core::Strings output application/json

fun toUser(id: Number, userName: String): String = "you called the function toUser!"

The constraints to call the function `toUser` are that the first argument has to be of type
`Number`, the second one of type `String` (to be coercible to those types). Another constraint is
that the result of the function has to be of type `String`. This constraint isn’t used in the call
for `toUser`; it’s applied to its definition to validate that the function body generates the proper
type.

toUser(123, "John") toUser("123", true)

Although you might expect the second call to fail, autocoercion enables the call to be successful,
and both calls work. In the case of the second function call, there is autocoercion of the `String`
value `"123"` to the `Number` value `123`, and the `Boolean` value `true` to the `String` value
`"true"`, which makes it possible to call the function.  
An example of a call that throws a type-checking error is `toUser("a 12", "John")`, because the
String value `"a 12"` isn’t coercible to a `Number` type.

DataWeave also uses a global type inference algorithm to validate your code even if no types are
specified as constraints.

> [!NOTE] Although the use of constraints is optional, they can be useful in big scripts or multiple
> scripts. The type system helps you to avoid bugs in your DataWeave logic because it causes the
> type-checking algorithm to run. Additionally, when you write your script in an IDE and define
> these constraints, the tooling helps you to find type checking errors, instead of when the script
> is running and fails.

The types supported by the DataWeave type system are divided into three categories:

- Simple Types

- Composite Types

- Complex Types

## Simple Types

Simple types represent values such as strings, Booleans, and so on. These values are atomic; they
are not composed of other values. These are the simple types:

- `String`

- `Boolean`

- `Number`

- `Regex`

- `Null`

- Temporal: `Date`, `DateTime`, `LocalDateTime`, `LocalTime`, `Time`, `Period`

### Null

`Null` is a type of only one value, the value `null`, which means that `null` cannot be assigned to
the type `String` or any other type except for the type `Null`.

For example, the `repeat` function in the String module has the signature
`repeat(String, Number): String`, which means that the function accepts as a first parameter only a
value of type `String`, and as a second parameter only a value of type `Number.` The function
returns a value of type `String`.

DataWeave Script

%dw 2.0 import \* from dw::core::Strings output application/json
---

repeat("a", 3)

This returns `"aaa"`, but the following example throws an error because the value `null` cannot be
assigned to the parameter that expects a value of type `String`:

DataWeave Script

%dw 2.0 import \* from dw::core::Strings output application/json
---

repeat(null, 3)

In the following example, the script assigns to the first parameter a value that is the type `Null`
(the type of this value is `Type<Null>`). It returns `"NullNullNull"` because autocoercion coerces
the value to the type `String` (`"Null"`).

DataWeave Script

%dw 2.0 import \* from dw::core::Strings output application/json
---

repeat(Null, 3)

Some functions have an overloaded signature (the function has multiple definitions for different
parameter types) that let you call it with `null`.

For example, the `isNumeric` function from `dw::core::Strings` has the signature
`isNumeric(String): Boolean`, which receives a string and successfully returns a result if that
string is numeric, but the function is also defined as `isNumeric(Null): Boolean`.

So, if you call the function `isNumeric` with `null` (`isNumeric(null)`), the function does not
throw an exception. At runtime, the function that is dispatching algorithm selects the correct
function based on the types of the values you use. The function returns `false` because of the
definition of `isNumeric` for `null` as the argument.

## Composite Types

A composite type contains other values. The composite types are `Array`, `Object` and `Function`.

### Array Type

An array is of the type `Array<T>` in which `T` is a type parameter that defines the type of the
elements inside the array. For example, the syntax to define a variable with the type `Array` of
`Number` is:

var idsList: Array<Number> = \[1, 22, 333, 4444\]

The variable `idsList` passes the type-checking phase only when the array that is assigned to it
only contains values of the `Number` type.

### Object Type

You can define an `Object` type in two ways: `Object` or `{}`. Both define an open object and don’t
specify any constraint to their key-value pairs. See also
[Close and Open Objects](#close_open_objects).

The syntax for defining an `Object` type with a set of constraints for its key-value pairs is very
similar to the syntax for defining the value of an `Object` type:

{ keyName @(attrName: AttrType): valueType, ... }

For example, the syntax to define a `User` type with `firstName` `String`, `lastName` `String`, and
`age` `Number` is:

DataWeave Script

%dw 2.0 output application/json

type User = { firstName: String, lastName: String, age: Number }

You can apply modifiers to each key-value pair to specify when a field is always present or when a
field can be repeated.

For repeated fields use `*`. For example, the following type allows you to have multiple `lastName`
fields:

DataWeave Script

%dw 2.0 output application/json

{ firstName: String, lastName\*: String, age: Number }

For conditional fields, use `?`. For example, the following type allows the `age` field to be
present or not:

DataWeave Script

%dw 2.0 output application/json

{ firstName: String, lastName\*: String, age?: Number }

#### Close and Open Objects

`Object` type can be either closed or open. A _closed_ object accepts an object value only if there
are no fields except the key-value pairs specified by the type.

An _open_ object only put constraints on the fields that are declared in the type, and if they are
all verified, then the type accepts the value. The type accepts objects that have other fields apart
of the ones mentioned in the declaration. All `object` types are open unless specified.

The following example succeds even if `age` is not in the type declaration because the type of the
variable `user` is an open object:

DataWeave Script

%dw 2.0 output application/json

var user: {firstName: String, lastName: String} = {firstName: "John", lastName: "Smith", age: 34}

The syntax to specify a closed object is `{| |}`. The following example makes the `User` type
support only the keys `firstName` and `lastName`. The script throws an exception because the `age`
field is not accepted.

DataWeave Script

%dw 2.0 output application/json

var user: {|firstName: String, lastName: String|} = {firstName: "John", lastName: "Smith", age: 34}

### Function Type

DataWeave is a functional language, and functions are considered first class citizens, which means
that functions are values with associated types.

The syntax to define a function type is:

(paramType: ParamType,...) -> ReturnType

For example, if you want to define in a constraint a `Function` type that has a parameter of type
`String`, a second parameter of type `Number`, and a `Boolean` return value, the correct syntax is:

(paramA: String, paramB: Number) -> Boolean

In the following example, you define a function that receives another function as an argument:

DataWeave Script

%dw 2.0 output application/json

fun applyIDsChange(ids: Array<Number>, changeTo: (Number) -> Number): Array<Number> = ???

If you call the function `applyIDsChange` with a function that does not match the `changeTo`
constraint `(Number) → Number`, DataWeave throws a type-checking error.

For example, the following call works because `abs` is a function that takes a value of the `Number`
type and returns a `Number`, which matches the `changeTo` parameter:

applyIDsChange(\[1,-6, 3, -8\], abs)

But the following call fails because `sum` is a function that takes an `Array` and returns a
`Number`, so it does not match the parameter constraint:

applyIDsChange(\[1,-6, 3, -8\], sum)

## Complex Types

Complex types include the `Any` and `Nothing` types, the `Union` type, the `Intersection` type, and
`Literal` types, each of which is named intuitively.

### Any and Nothing

In some cases, you cannot enforce a restriction because the type accepts all the value:

- `Any` type accepts all possible values.

- `Nothing` type accepts no value, but it can be assigned to all the types. This type is not
  frequently used explicitly, but it is used by the type inference algorithm.

### Union Type

The `Union` type is used to compose types. The syntax to define a `Union` type is:

TypeA | TypeB | ...

The following example defines a variable with a constraint that accepts a value of type `String` or
`Number`:

var age: String | Number = if (payload.allStrings) "32" else 32

A common pattern is to use `Null` type with a `Union` type to specify that a type accepts `null` as
a value. In the following example, the function `parseEmail` allows inputs of type `String` or
`Null`. In this case, you can have a object with a payload optional field `email` and you call the
function with `payload.email`.

fun parseEmail(email: String | Null) = "Code that handles email being of type String or Null"

### Intersection Type

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

The `Intersection` type intersects `Object` types. In this case, the intersection works as the
concatenation (`++`) of object types.

The syntax for the `Intersection` type is:

TypeA & TypeB & ...

In the following example, the `Intersection` concatenates the two `Object` types, resulting in the
type `{name: String, lastName: String}`. The type is an open object that can accept additional
key-value pairs. The variable accepts the value assigned to it:

var a: {name: String} & {lastName: String} = {name: "John", lastName: "Smith", age: 34}

In the case of closed objects, it returns the concatenation of the object types but results in a
closed object.  
In the following example, the intersection results in the type `{|name: String, lastName: String|}`,
which throws an exception because a closed object does not accept an `Object` value if there are
additional fields in the object (field `age`):

var a: {|name: String|} & {|lastName: String|} = {name: "John", lastName: "Smith", age: 34}

### Literal Types

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

A literal type represents exactly one value. For example, the `String` value `"foo"` can be
represented with the type `"foo"`.

The following literal types are included to the type system:

- `String` literal types

- `Number` literal types

- `Boolean` literal types

You can use literal types with `Union` types to declare a type as a finite set of allowed values.
For example, the following type declarations are aliases of `Union` and literal types:

type Weekdays = "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" type Days = Weekdays |
"Saturday" | "Sunday"

In the following example, the variable accepts only a value of the literal types `404` and `500`.
The type system ensures before runtime that the variable can be only one of those literal values:

DataWeave Script

%dw 2.0 output application/json

var errorStatusCode: 404 | 500 = payload.statusCode match { case "error 404" -> 404 case "error 500"
-> 500 }

Function overloading enables you to define different behaviors based on the input argument’s value:

DataWeave Script

%dw 2.0 import \* from dw::core::Strings output application/json

fun errorHandling(errorCode: 404 | 405, response): String = "Code for error 4XX handling here!" fun
errorHandling(errorCode: 500 | 501, response): String = "Code for error 5XX handling here!"
---

errorHandling(payload.statusCode, payload)

At runtime, the function-dispatching algorithm selects the correct function based on the type of the
value of `payload.statusCode`. It is not necessary to check the value of an argument with an `if`
statement to change the behavior of the function.

### Type Parameters

A type parameter enables you to write a function or data type generically so that you can handle
values identically, without depending on the type of the values.

For example, you can define a function that returns the first element of an array without losing its
type information. In the example, the variable definitions `firstString:String` and
`firstNumber:Number` specify the type of the item in the array that the `head` function takes as
input.

```DataWeave
%dw 2.0
fun head<ItemType>(elements: Array<ItemType>): ItemType = elements[0]!

var firstString:String = head(["DataWeave", "Java", "Scala", "Haskell"]) ++ " Rules!!!"
var firstNumber:Number = head([1,2,3])
output application/json
---
firstNumber
```

In the body of the script, `firstNumber` returns the number `1`. If you replace `firstNumber` with
`firstString`, the script returns the string `"DataWeave Rules!!!"`.

#### Binding Type Parameters

You can bind type parameters to require a value of a specific type. Appending `{name: "DataWeave"}`
in the following example is valid because `{name: String}` in the function definition indicates that
the value of the `name` key must be a string.

```DataWeave
%dw 2.0

fun addName<User <: {} >(user: User): User & {name: String} = user ++ {name: "DataWeave"}

var myUser: {name: String, developers: Number} = addName({developers: 3})
```

#### Parameterizing Type Definitions

You can use type parameters to paramaterize type definitions. For example, assume that you define a
data structure that models file content, one for text files and the other for binary files. You can
use type parameters to construct new types that dispatch the correct implementation.

```DataWeave
%dw 2.0

type FileData<Content> = {
    data: Content,
    name: String
}

fun read(file: FileData<String>) =  "This is a text file with data " ++ file.data
fun read(file: FileData<Binary>) =  "This is a binary file with data " ++ (file.data as String {base: "64"})

---
{
  binary: read({data: "Hello World" as Binary, name: "myFile.bin"}),
  text: read({data: "Hello World", name: "myFile.txt"})
}
```

<!-- document id=133164717b55b52c7ee1e381dc425e2cfd46441bbf653fa2f9cca08c8af75520 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-type-system.md -->

---
product: DataWeave
version: 2.4
---

# Type System

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

2.x versions of DataWeave support a type system. To take advantage of the type-checking that the
type system executes, you need to provide constraint expressions for variables and functions
described in this section. For information about how values for these types are defined, refer to
[Value Constructs for Types](https://docs.mulesoft.com/dataweave/2.4/dataweave-types).

A type system defines a set of constraints to a set of constructs, such as:

- Variables

- Function parameters

These constraints are used in the type-checking phase, when DataWeave ensures that the values
assigned to variables or the arguments for a function call respect its constraints, for example:

DataWeave Script

%dw 2.0 import \* from dw::core::Strings output application/json

var userName: String = "John"

The variable definition for `userName` has the constraint of assigning a value of type `String`. If
some other value type is assigned, a type-checking error is raised.

DataWeave Script

%dw 2.0 import \* from dw::core::Strings output application/json

fun toUser(id: Number, userName: String): String = "you called the function toUser!"

The constraints to call the function `toUser` are that the first argument has to be of type
`Number`, the second one of type `String` (to be coercible to those types). Another constraint is
that the result of the function has to be of type `String`. This constraint isn’t used in the call
for `toUser`; it’s applied to its definition to validate that the function body generates the proper
type.

toUser(123, "John") toUser("123", true)

Although you might expect the second call to fail, autocoercion enables the call to be successful,
and both calls work. In the case of the second function call, there is autocoercion of the `String`
value `"123"` to the `Number` value `123`, and the `Boolean` value `true` to the `String` value
`"true"`, which makes it possible to call the function.  
An example of a call that throws a type-checking error is `toUser("a 12", "John")`, because the
String value `"a 12"` isn’t coercible to a `Number` type.

DataWeave also uses a global type inference algorithm to validate your code even if no types are
specified as constraints.

> [!NOTE] Although the use of constraints is optional, they can be useful in big scripts or multiple
> scripts. The type system helps you to avoid bugs in your DataWeave logic because it causes the
> type-checking algorithm to run. Additionally, when you write your script in an IDE and define
> these constraints, the tooling helps you to find type checking errors, instead of when the script
> is running and fails.

The types supported by the DataWeave type system are divided into three categories:

- Simple Types

- Composite Types

- Complex Types

## Simple Types

Simple types represent values such as strings, Booleans, and so on. These values are atomic; they
are not composed of other values. These are the simple types:

- `String`

- `Boolean`

- `Number`

- `Regex`

- `Null`

- Temporal: `Date`, `DateTime`, `LocalDateTime`, `LocalTime`, `Time`, `Period`

### Null

`Null` is a type of only one value, the value `null`, which means that `null` cannot be assigned to
the type `String` or any other type except for the type `Null`.

For example, the `repeat` function in the String module has the signature
`repeat(String, Number): String`, which means that the function accepts as a first parameter only a
value of type `String`, and as a second parameter only a value of type `Number.` The function
returns a value of type `String`.

DataWeave Script

%dw 2.0 import \* from dw::core::Strings output application/json
---

repeat("a", 3)

This returns `"aaa"`, but the following example throws an error because the value `null` cannot be
assigned to the parameter that expects a value of type `String`:

DataWeave Script

%dw 2.0 import \* from dw::core::Strings output application/json
---

repeat(null, 3)

In the following example, the script assigns to the first parameter a value that is the type `Null`
(the type of this value is `Type<Null>`). It returns `"NullNullNull"` because autocoercion coerces
the value to the type `String` (`"Null"`).

DataWeave Script

%dw 2.0 import \* from dw::core::Strings output application/json
---

repeat(Null, 3)

Some functions have an overloaded signature (the function has multiple definitions for different
parameter types) that let you call it with `null`.

For example, the `isNumeric` function from `dw::core::Strings` has the signature
`isNumeric(String): Boolean`, which receives a string and successfully returns a result if that
string is numeric, but the function is also defined as `isNumeric(Null): Boolean`.

So, if you call the function `isNumeric` with `null` (`isNumeric(null)`), the function does not
throw an exception. At runtime, the function that is dispatching algorithm selects the correct
function based on the types of the values you use. The function returns `false` because of the
definition of `isNumeric` for `null` as the argument.

## Composite Types

A composite type contains other values. The composite types are `Array`, `Object` and `Function`.

### Array Type

An array is of the type `Array<T>` in which `T` is a type parameter that defines the type of the
elements inside the array. For example, the syntax to define a variable with the type `Array` of
`Number` is:

var idsList: Array<Number> = \[1, 22, 333, 4444\]

The variable `idsList` passes the type-checking phase only when the array that is assigned to it
only contains values of the `Number` type.

### Object Type

You can define an `Object` type in two ways: `Object` or `{}`. Both define an open object and don’t
specify any constraint to their key-value pairs. See also
[Close and Open Objects](#close_open_objects).

The syntax for defining an `Object` type with a set of constraints for its key-value pairs is very
similar to the syntax for defining the value of an `Object` type:

{ keyName @(attrName: AttrType): valueType, ... }

For example, the syntax to define a `User` type with `firstName` `String`, `lastName` `String`, and
`age` `Number` is:

DataWeave Script

%dw 2.0 output application/json

type User = { firstName: String, lastName: String, age: Number }

You can apply modifiers to each key-value pair to specify when a field is always present or when a
field can be repeated.

For repeated fields use `*`. For example, the following type allows you to have multiple `lastName`
fields:

DataWeave Script

%dw 2.0 output application/json

type User = { firstName: String, lastName\*: String, age: Number }

For conditional fields, use `?`. For example, the following type allows the `age` field to be
present or not:

DataWeave Script

%dw 2.0 output application/json

type User = { firstName: String, lastName\*: String, age?: Number }

#### Close and Open Objects

`Object` type can be either closed or open. A _closed_ object accepts an object value only if there
are no fields except the key-value pairs specified by the type.

An _open_ object only put constraints on the fields that are declared in the type, and if they are
all verified, then the type accepts the value. The type accepts objects that have other fields apart
of the ones mentioned in the declaration. All `object` types are open unless specified.

The following example succeeds even if `age` is not in the type declaration because the type of the
variable `user` is an open object:

DataWeave Script

%dw 2.0 output application/json

var user: {firstName: String, lastName: String} = {firstName: "John", lastName: "Smith", age: 34}

The syntax to specify a closed object is `{| |}`. The following example makes the `User` type
support only the keys `firstName` and `lastName`. The script throws an exception because the `age`
field is not accepted.

DataWeave Script

%dw 2.0 output application/json

var user: {|firstName: String, lastName: String|} = {firstName: "John", lastName: "Smith", age: 34}

### Function Type

DataWeave is a functional language, and functions are considered first class citizens, which means
that functions are values with associated types.

The syntax to define a function type is:

(paramType: ParamType,...) -> ReturnType

For example, if you want to define in a constraint a `Function` type that has a parameter of type
`String`, a second parameter of type `Number`, and a `Boolean` return value, the correct syntax is:

(paramA: String, paramB: Number) -> Boolean

In the following example, you define a function that receives another function as an argument:

DataWeave Script

%dw 2.0 output application/json

fun applyIDsChange(ids: Array<Number>, changeTo: (Number) -> Number): Array<Number> = ???

If you call the function `applyIDsChange` with a function that does not match the `changeTo`
constraint `(Number) → Number`, DataWeave throws a type-checking error.

For example, the following call works because `abs` is a function that takes a value of the `Number`
type and returns a `Number`, which matches the `changeTo` parameter:

applyIDsChange(\[1,-6, 3, -8\], abs)

But the following call fails because `sum` is a function that takes an `Array` and returns a
`Number`, so it does not match the parameter constraint:

applyIDsChange(\[1,-6, 3, -8\], sum)

## Complex Types

Complex types include the `Any` and `Nothing` types, the `Union` type, the `Intersection` type, and
`Literal` types, each of which is named intuitively.

### Any and Nothing

In some cases, you cannot enforce a restriction because the type accepts all the value:

- `Any` type accepts all possible values.

- `Nothing` type accepts no value, but it can be assigned to all the types. This type is not
  frequently used explicitly, but it is used by the type inference algorithm.

### Union Type

The `Union` type is used to compose types. The syntax to define a `Union` type is:

TypeA | TypeB | ...

The following example defines a variable with a constraint that accepts a value of type `String` or
`Number`:

var age: String | Number = if (payload.allStrings) "32" else 32

A common pattern is to use `Null` type with a `Union` type to specify that a type accepts `null` as
a value. In the following example, the function `parseEmail` allows inputs of type `String` or
`Null`. In this case, you can have a object with a payload optional field `email` and you call the
function with `payload.email`.

fun parseEmail(email: String | Null) = "Code that handles email being of type String or Null"

### Intersection Type

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

The `Intersection` type intersects `Object` types. In this case, the intersection works as the
concatenation (`++`) of object types.

The syntax for the `Intersection` type is:

TypeA & TypeB & ...

In the following example, the `Intersection` concatenates the two `Object` types, resulting in the
type `{name: String, lastName: String}`. The type is an open object that can accept additional
key-value pairs. The variable accepts the value assigned to it:

var a: {name: String} & {lastName: String} = {name: "John", lastName: "Smith", age: 34}

In the case of closed objects, it returns the concatenation of the object types but results in a
closed object.  
In the following example, the intersection results in the type `{|name: String, lastName: String|}`,
which throws an exception because a closed object does not accept an `Object` value if there are
additional fields in the object (field `age`):

var a: {|name: String|} & {|lastName: String|} = {name: "John", lastName: "Smith", age: 34}

### Literal Types

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

A literal type represents exactly one value. For example, the `String` value `"foo"` can be
represented with the type `"foo"`.

The following literal types are included to the type system:

- `String` literal types

- `Number` literal types

- `Boolean` literal types

You can use literal types with `Union` types to declare a type as a finite set of allowed values.
For example, the following type declarations are aliases of `Union` and literal types:

type Weekdays = "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" type Days = Weekdays |
"Saturday" | "Sunday"

In the following example, the variable accepts only a value of the literal types `404` and `500`.
The type system ensures before runtime that the variable can be only one of those literal values:

DataWeave Script

%dw 2.0 output application/json

var errorStatusCode: 404 | 500 = payload.statusCode match { case "error 404" -> 404 case "error 500"
-> 500 }

Function overloading enables you to define different behaviors based on the input argument’s value:

DataWeave Script

%dw 2.0 import \* from dw::core::Strings output application/json

fun errorHandling(errorCode: 404 | 405, response): String = "Code for error 4XX handling here!" fun
errorHandling(errorCode: 500 | 501, response): String = "Code for error 5XX handling here!"
---

errorHandling(payload.statusCode, payload)

At runtime, the function-dispatching algorithm selects the correct function based on the type of the
value of `payload.statusCode`. It is not necessary to check the value of an argument with an `if`
statement to change the behavior of the function.

### Type Parameters

A type parameter enables you to write a function or data type generically so that you can handle
values identically, without depending on the type of the values.

For example, you can define a function that returns the first element of an array without losing its
type information. In the example, the variable definitions `firstString:String` and
`firstNumber:Number` specify the type of the item in the array that the `head` function takes as
input.

```DataWeave
%dw 2.0
fun head<ItemType>(elements: Array<ItemType>): ItemType = elements[0]!

var firstString:String = head(["DataWeave", "Java", "Scala", "Haskell"]) ++ " Rules!!!"
var firstNumber:Number = head([1,2,3])
output application/json
---
firstNumber
```

In the body of the script, `firstNumber` returns the number `1`. If you replace `firstNumber` with
`firstString`, the script returns the string `"DataWeave Rules!!!"`.

#### Binding Type Parameters

You can bind type parameters to require a value of a specific type. Appending `{name: "DataWeave"}`
in the following example is valid because `{name: String}` in the function definition indicates that
the value of the `name` key must be a string.

```DataWeave
%dw 2.0

fun addName<User <: {} >(user: User): User & {name: String} = user ++ {name: "DataWeave"}

var myUser: {name: String, developers: Number} = addName({developers: 3})
```

#### Parameterizing Type Definitions

You can use type parameters to parameterize type definitions. For example, assume that you define a
data structure that models file content, one for text files and the other for binary files. You can
use type parameters to construct new types that dispatch the correct implementation.

```DataWeave
%dw 2.0

type FileData<Content> = {
    data: Content,
    name: String
}

fun read(file: FileData<String>) =  "This is a text file with data " ++ file.data
fun read(file: FileData<Binary>) =  "This is a binary file with data " ++ (file.data as String {base: "64"})

---
{
  binary: read({data: "Hello World" as Binary, name: "myFile.bin"}),
  text: read({data: "Hello World", name: "myFile.txt"})
}
```

<!-- document id=9837a20363f3d0b9ff0f240f4b5e0a754977417e2bc86a23d67545b39163e411 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-type-system.md -->

---
product: DataWeave
version: 2.6
---

# Type System

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

2.x versions of DataWeave support a type system. To take advantage of the type-checking that the
type system executes, you need to provide constraint expressions for variables and functions
described in this section. For information about how values for these types are defined, refer to
[Value Constructs for Types](https://docs.mulesoft.com/dataweave/2.6/dataweave-types).

A type system defines a set of constraints to a set of constructs, such as:

- Variables

- Function parameters

These constraints are used in the type-checking phase, when DataWeave ensures that the values
assigned to variables or the arguments for a function call respect its constraints, for example:

DataWeave Script:

%dw 2.0 import \* from dw::core::Strings output application/json

var userName: String = "John"

The variable definition for `userName` has the constraint of assigning a value of type `String`. If
some other value type is assigned, a type-checking error is raised.

DataWeave Script:

%dw 2.0 import \* from dw::core::Strings output application/json

fun toUser(id: Number, userName: String): String = "you called the function toUser!"

The constraints to call the function `toUser` are that the first argument has to be of type
`Number`, the second one of type `String` (to be coercible to those types). Another constraint is
that the result of the function has to be of type `String`. This constraint isn’t used in the call
for `toUser`; it’s applied to its definition to validate that the function body generates the proper
type.

toUser(123, "John") toUser("123", true)

Although you might expect the second call to fail, autocoercion enables the call to be successful,
and both calls work. In the case of the second function call, there is autocoercion of the `String`
value `"123"` to the `Number` value `123`, and the `Boolean` value `true` to the `String` value
`"true"`, which makes it possible to call the function.  
An example of a call that throws a type-checking error is `toUser("a 12", "John")`, because the
String value `"a 12"` isn’t coercible to a `Number` type.

DataWeave also uses a global type inference algorithm to validate your code even if no types are
specified as constraints.

> [!NOTE] Although the use of constraints is optional, they can be useful in big scripts or multiple
> scripts. The type system helps you to avoid bugs in your DataWeave logic because it causes the
> type-checking algorithm to run. Additionally, when you write your script in an IDE and define
> these constraints, the tooling helps you to find type checking errors, instead of when the script
> is running and fails.

The types supported by the DataWeave type system are divided into three categories:

- Simple Types

- Composite Types

- Complex Types

## Simple Types

Simple types represent values such as strings, Booleans, and so on. These values are atomic; they
are not composed of other values. These are the simple types:

- `String`

- `Boolean`

- `Number`

- `Regex`

- `Null`

- Temporal: `Date`, `DateTime`, `LocalDateTime`, `LocalTime`, `Time`, `Period`

### Null

`Null` is a type of only one value, the value `null`, which means that `null` cannot be assigned to
the type `String` or any other type except for the type `Null`.

For example, the `repeat` function in the String module has the signature
`repeat(String, Number): String`, which means that the function accepts as a first parameter only a
value of type `String`, and as a second parameter only a value of type `Number.` The function
returns a value of type `String`.

DataWeave Script:

%dw 2.0 import \* from dw::core::Strings output application/json
---

repeat("a", 3)

This returns `"aaa"`, but the following example throws an error because the value `null` cannot be
assigned to the parameter that expects a value of type `String`:

DataWeave Script:

%dw 2.0 import \* from dw::core::Strings output application/json
---

repeat(null, 3)

In the following example, the script assigns to the first parameter a value that is the type `Null`
(the type of this value is `Type<Null>`). It returns `"NullNullNull"` because autocoercion coerces
the value to the type `String` (`"Null"`).

DataWeave Script:

%dw 2.0 import \* from dw::core::Strings output application/json
---

repeat(Null, 3)

Some functions have an overloaded signature (the function has multiple definitions for different
parameter types) that let you call it with `null`.

For example, the `isNumeric` function from `dw::core::Strings` has the signature
`isNumeric(String): Boolean`, which receives a string and successfully returns a result if that
string is numeric, but the function is also defined as `isNumeric(Null): Boolean`.

So, if you call the function `isNumeric` with `null` (`isNumeric(null)`), the function does not
throw an exception. At runtime, the function that is dispatching algorithm selects the correct
function based on the types of the values you use. The function returns `false` because of the
definition of `isNumeric` for `null` as the argument.

## Composite Types

A composite type contains other values. The composite types are `Array`, `Object` and `Function`.

### Array Type

An array is of the type `Array<T>` in which `T` is a type parameter that defines the type of the
elements inside the array. For example, the syntax to define a variable with the type `Array` of
`Number` is:

var idsList: Array<Number> = \[1, 22, 333, 4444\]

The variable `idsList` passes the type-checking phase only when the array that is assigned to it
only contains values of the `Number` type.

### Object Type

You can define an `Object` type in two ways: `Object` or `{}`. Both define an open object and don’t
specify any constraint to their key-value pairs. See also
[Close and Open Objects](#close_open_objects).

The syntax for defining an `Object` type with a set of constraints for its key-value pairs is very
similar to the syntax for defining the value of an `Object` type:

{ keyName @(attrName: AttrType): valueType, ... }

For example, the syntax to define a `User` type with `firstName` `String`, `lastName` `String`, and
`age` `Number` is:

DataWeave Script:

%dw 2.0 output application/json

type User = { firstName: String, lastName: String, age: Number }

You can apply modifiers to each key-value pair to specify when a field is always present or when a
field can be repeated.

For repeated fields use `*`. For example, the following type allows you to have multiple `lastName`
fields:

DataWeave Script:

%dw 2.0 output application/json

type User = { firstName: String, lastName\*: String, age: Number }

For conditional fields, use `?`. For example, the following type allows the `age` field to be
present or not:

DataWeave Script:

%dw 2.0 output application/json

type User = { firstName: String, lastName\*: String, age?: Number }

#### Close and Open Objects

`Object` type can be either closed or open. A _closed_ object accepts an object value only if there
are no fields except the key-value pairs specified by the type.

An _open_ object only put constraints on the fields that are declared in the type, and if they are
all verified, then the type accepts the value. The type accepts objects that have other fields apart
of the ones mentioned in the declaration. All `object` types are open unless specified.

The following example succeeds even if `age` is not in the type declaration because the type of the
variable `user` is an open object:

DataWeave Script:

%dw 2.0 output application/json

var user: {firstName: String, lastName: String} = {firstName: "John", lastName: "Smith", age: 34}

The syntax to specify a closed object is `{| |}`. The following example makes the `User` type
support only the keys `firstName` and `lastName`. The script throws an exception because the `age`
field is not accepted.

DataWeave Script:

%dw 2.0 output application/json

var user: {|firstName: String, lastName: String|} = {firstName: "John", lastName: "Smith", age: 34}

### Function Type

DataWeave is a functional language, and functions are considered first class citizens, which means
that functions are values with associated types.

The syntax to define a function type is:

(paramType: ParamType,...) -> ReturnType

For example, if you want to define in a constraint a `Function` type that has a parameter of type
`String`, a second parameter of type `Number`, and a `Boolean` return value, the correct syntax is:

(paramA: String, paramB: Number) -> Boolean

In the following example, you define a function that receives another function as an argument:

DataWeave Script:

%dw 2.0 output application/json

fun applyIDsChange(ids: Array<Number>, changeTo: (Number) -> Number): Array<Number> = ???

If you call the function `applyIDsChange` with a function that does not match the `changeTo`
constraint `(Number) → Number`, DataWeave throws a type-checking error.

For example, the following call works because `abs` is a function that takes a value of the `Number`
type and returns a `Number`, which matches the `changeTo` parameter:

applyIDsChange(\[1,-6, 3, -8\], abs)

But the following call fails because `sum` is a function that takes an `Array` and returns a
`Number`, so it does not match the parameter constraint:

applyIDsChange(\[1,-6, 3, -8\], sum)

## Complex Types

Complex types include the `Any` and `Nothing` types, the `Union` type, the `Intersection` type, and
`Literal` types, each of which is named intuitively.

### Any and Nothing

In some cases, you cannot enforce a restriction because the type accepts all the value:

- `Any` type accepts all possible values.

- `Nothing` type accepts no value, but it can be assigned to all the types. This type is not
  frequently used explicitly, but it is used by the type inference algorithm.

### Union Type

The `Union` type is used to compose types. The syntax to define a `Union` type is:

TypeA | TypeB | ...

The following example defines a variable with a constraint that accepts a value of type `String` or
`Number`:

var age: String | Number = if (payload.allStrings) "32" else 32

A common pattern is to use `Null` type with a `Union` type to specify that a type accepts `null` as
a value. In the following example, the function `parseEmail` allows inputs of type `String` or
`Null`. In this case, you can have a object with a payload optional field `email` and you call the
function with `payload.email`.

fun parseEmail(email: String | Null) = "Code that handles email being of type String or Null"

### Intersection Type

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

The `Intersection` type intersects `Object` types. In this case, the intersection works as the
concatenation (`++`) of object types.

The syntax for the `Intersection` type is:

TypeA & TypeB & ...

In the following example, the `Intersection` concatenates the two `Object` types, resulting in the
type `{name: String, lastName: String}`. The type is an open object that can accept additional
key-value pairs. The variable accepts the value assigned to it:

var a: {name: String} & {lastName: String} = {name: "John", lastName: "Smith", age: 34}

In the case of closed objects, it returns the concatenation of the object types but results in a
closed object.  
In the following example, the intersection results in the type `{|name: String, lastName: String|}`,
which throws an exception because a closed object does not accept an `Object` value if there are
additional fields in the object (field `age`):

var a: {|name: String|} & {|lastName: String|} = {name: "John", lastName: "Smith", age: 34}

### Literal Types

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

A literal type represents exactly one value. For example, the `String` value `"foo"` can be
represented with the type `"foo"`.

The following literal types are included to the type system:

- `String` literal types

- `Number` literal types

- `Boolean` literal types

You can use literal types with `Union` types to declare a type as a finite set of allowed values.
For example, the following type declarations are aliases of `Union` and literal types:

type Weekdays = "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" type Days = Weekdays |
"Saturday" | "Sunday"

In the following example, the variable accepts only a value of the literal types `404` and `500`.
The type system ensures before runtime that the variable can be only one of those literal values:

DataWeave Script:

%dw 2.0 output application/json

var errorStatusCode: 404 | 500 = payload.statusCode match { case "error 404" -> 404 case "error 500"
-> 500 }

Function overloading enables you to define different behaviors based on the input argument’s value:

DataWeave Script:

%dw 2.0 import \* from dw::core::Strings output application/json

fun errorHandling(errorCode: 404 | 405, response): String = "Code for error 4XX handling here!" fun
errorHandling(errorCode: 500 | 501, response): String = "Code for error 5XX handling here!"
---

errorHandling(payload.statusCode, payload)

At runtime, the function-dispatching algorithm selects the correct function based on the type of the
value of `payload.statusCode`. It is not necessary to check the value of an argument with an `if`
statement to change the behavior of the function.

### Type Parameters

A type parameter enables you to write a function or data type generically so that you can handle
values identically, without depending on the type of the values.

For example, you can define a function that returns the first element of an array without losing its
type information. In the example, the variable definitions `firstString:String` and
`firstNumber:Number` specify the type of the item in the array that the `head` function takes as
input.

```DataWeave
%dw 2.0
fun head<ItemType>(elements: Array<ItemType>): ItemType = elements[0]!

var firstString:String = head(["DataWeave", "Java", "Scala", "Haskell"]) ++ " Rules!!!"
var firstNumber:Number = head([1,2,3])
output application/json
---
firstNumber
```

In the body of the script, `firstNumber` returns the number `1`. If you replace `firstNumber` with
`firstString`, the script returns the string `"DataWeave Rules!!!"`.

#### Binding Type Parameters

You can bind type parameters to require a value of a specific type. Appending `{name: "DataWeave"}`
in the following example is valid because `{name: String}` in the function definition indicates that
the value of the `name` key must be a string.

```DataWeave
%dw 2.0

fun addName<User <: {} >(user: User): User & {name: String} = user ++ {name: "DataWeave"}

var myUser: {name: String, developers: Number} = addName({developers: 3})
```

#### Parameterizing Type Definitions

You can use type parameters to parameterize type definitions. For example, assume that you define a
data structure that models file content, one for text files and the other for binary files. You can
use type parameters to construct new types that dispatch the correct implementation.

```DataWeave
%dw 2.0

type FileData<Content> = {
    data: Content,
    name: String
}

fun read(file: FileData<String>) =  "This is a text file with data " ++ file.data
fun read(file: FileData<Binary>) =  "This is a binary file with data " ++ (file.data as String {base: "64"})

---
{
  binary: read({data: "Hello World" as Binary, name: "myFile.bin"}),
  text: read({data: "Hello World", name: "myFile.txt"})
}
```

## Reuse Types

You can declare and use types within the same DataWeave script (see
[Type System](https://docs.mulesoft.com/dataweave/2.6/dataweave-type-system)), or you can reuse types from different sources by loading them
with a specific module loader. DataWeave currently supports loading types from:

- [Reusing Types from DataWeave Modules](https://docs.mulesoft.com/dataweave/2.6/dataweave-type-reuse-modules)

- [Reusing Types from a JSON Schema](https://docs.mulesoft.com/dataweave/2.6/dataweave-type-reuse-json-schema)

- [Reusing an XML Schema](https://docs.mulesoft.com/dataweave/2.6/dataweave-type-reuse-xml-schema)

- [Reusing Types from Java Classes](https://docs.mulesoft.com/dataweave/2.6/dataweave-type-reuse-java-classes)

Module loaders are used to load files as DataWeave modules, in which different parts of those files
are loaded as DataWeave functions, variables, types, and namespace definitions. Using a prefix such
as `java!` or `xmlschema!` in the import directive tells DataWeave which module loader to use when
loading the Java class or the XML schema as a DataWeave module.

<!-- document id=169676776259f559a28cd9d13df7ff0e2bfffc6264a3a74744816ca6b860991e url=/mulesoft/current/en-us/dataweave/2.9/dataweave-type-system.md -->

---
product: DataWeave
version: 2.9
---

# Type System

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

2.x versions of DataWeave support a type system. To take advantage of the type-checking that the
type system executes, you need to provide constraint expressions for variables and functions
described in this section. For information about how values for these types are defined, refer to
[Value Constructs for Types](https://docs.mulesoft.com/dataweave/2.9/dataweave-types).

A type system defines a set of constraints to a set of constructs, such as:

- Variables

- Function parameters

These constraints are used in the type-checking phase, when DataWeave ensures that the values
assigned to variables or the arguments for a function call respect its constraints, for example:

DataWeave Script:

%dw 2.0 import \* from dw::core::Strings output application/json

var userName: String = "John"

The variable definition for `userName` has the constraint of assigning a value of type `String`. If
some other value type is assigned, a type-checking error is raised.

DataWeave Script:

%dw 2.0 import \* from dw::core::Strings output application/json

fun toUser(id: Number, userName: String): String = "you called the function toUser!"

The constraints to call the function `toUser` are that the first argument has to be of type
`Number`, the second one of type `String` (to be coercible to those types). Another constraint is
that the result of the function has to be of type `String`. This constraint isn’t used in the call
for `toUser`; it’s applied to its definition to validate that the function body generates the proper
type.

toUser(123, "John") toUser("123", true)

Although you might expect the second call to fail, autocoercion enables the call to be successful,
and both calls work. In the case of the second function call, there is autocoercion of the `String`
value `"123"` to the `Number` value `123`, and the `Boolean` value `true` to the `String` value
`"true"`, which makes it possible to call the function.  
An example of a call that throws a type-checking error is `toUser("a 12", "John")`, because the
String value `"a 12"` isn’t coercible to a `Number` type.

DataWeave also uses a global type inference algorithm to validate your code even if no types are
specified as constraints.

> [!NOTE] Although the use of constraints is optional, they can be useful in big scripts or multiple
> scripts. The type system helps you to avoid bugs in your DataWeave logic because it causes the
> type-checking algorithm to run. Additionally, when you write your script in an IDE and define
> these constraints, the tooling helps you to find type checking errors, instead of when the script
> is running and fails.

The types supported by the DataWeave type system are divided into three categories:

- Simple Types

- Composite Types

- Complex Types

## Simple Types

Simple types represent values such as strings, Booleans, and so on. These values are atomic; they
are not composed of other values. These are the simple types:

- `String`

- `Boolean`

- `Number`

- `Regex`

- `Null`

- Temporal: `Date`, `DateTime`, `LocalDateTime`, `LocalTime`, `Time`, `Period`

### Null

`Null` is a type of only one value, the value `null`, which means that `null` cannot be assigned to
the type `String` or any other type except for the type `Null`.

For example, the `repeat` function in the String module has the signature
`repeat(String, Number): String`, which means that the function accepts as a first parameter only a
value of type `String`, and as a second parameter only a value of type `Number.` The function
returns a value of type `String`.

DataWeave Script:

%dw 2.0 import \* from dw::core::Strings output application/json
---

repeat("a", 3)

This returns `"aaa"`, but the following example throws an error because the value `null` cannot be
assigned to the parameter that expects a value of type `String`:

DataWeave Script:

%dw 2.0 import \* from dw::core::Strings output application/json
---

repeat(null, 3)

In the following example, the script assigns to the first parameter a value that is the type `Null`
(the type of this value is `Type<Null>`). It returns `"NullNullNull"` because autocoercion coerces
the value to the type `String` (`"Null"`).

DataWeave Script:

%dw 2.0 import \* from dw::core::Strings output application/json
---

repeat(Null, 3)

Some functions have an overloaded signature (the function has multiple definitions for different
parameter types) that let you call it with `null`.

For example, the `isNumeric` function from `dw::core::Strings` has the signature
`isNumeric(String): Boolean`, which receives a string and successfully returns a result if that
string is numeric, but the function is also defined as `isNumeric(Null): Boolean`.

So, if you call the function `isNumeric` with `null` (`isNumeric(null)`), the function does not
throw an exception. At runtime, the function that is dispatching algorithm selects the correct
function based on the types of the values you use. The function returns `false` because of the
definition of `isNumeric` for `null` as the argument.

## Composite Types

A composite type contains other values. The composite types are `Array`, `Object` and `Function`.

### Array Type

An array is of the type `Array<T>` in which `T` is a type parameter that defines the type of the
elements inside the array. For example, the syntax to define a variable with the type `Array` of
`Number` is:

var idsList: Array<Number> = \[1, 22, 333, 4444\]

The variable `idsList` passes the type-checking phase only when the array that is assigned to it
only contains values of the `Number` type.

### Object Type

You can define an `Object` type in two ways: `Object` or `{}`. Both define an open object and don’t
specify any constraint to their key-value pairs. See also
[Close and Open Objects](#close_open_objects).

The syntax for defining an `Object` type with a set of constraints for its key-value pairs is very
similar to the syntax for defining the value of an `Object` type:

{ keyName @(attrName: AttrType): valueType, ... }

For example, the syntax to define a `User` type with `firstName` `String`, `lastName` `String`, and
`age` `Number` is:

DataWeave Script:

%dw 2.0 output application/json

type User = { firstName: String, lastName: String, age: Number }

You can apply modifiers to each key-value pair to specify when a field is always present or when a
field can be repeated.

For repeated fields use `*`. For example, the following type allows you to have multiple `lastName`
fields:

DataWeave Script:

%dw 2.0 output application/json

type User = { firstName: String, lastName\*: String, age: Number }

For conditional fields, use `?`. For example, the following type allows the `age` field to be
present or not:

DataWeave Script:

%dw 2.0 output application/json

type User = { firstName: String, lastName\*: String, age?: Number }

#### Close and Open Objects

`Object` type can be either closed or open. A _closed_ object accepts an object value only if there
are no fields except the key-value pairs specified by the type.

An _open_ object only put constraints on the fields that are declared in the type, and if they are
all verified, then the type accepts the value. The type accepts objects that have other fields apart
of the ones mentioned in the declaration. All `object` types are open unless specified.

The following example succeeds even if `age` is not in the type declaration because the type of the
variable `user` is an open object:

DataWeave Script:

%dw 2.0 output application/json

var user: {firstName: String, lastName: String} = {firstName: "John", lastName: "Smith", age: 34}

The syntax to specify a closed object is `{| |}`. The following example makes the `User` type
support only the keys `firstName` and `lastName`. The script throws an exception because the `age`
field is not accepted.

DataWeave Script:

%dw 2.0 output application/json

var user: {|firstName: String, lastName: String|} = {firstName: "John", lastName: "Smith", age: 34}

### Function Type

DataWeave is a functional language, and functions are considered first class citizens, which means
that functions are values with associated types.

The syntax to define a function type is:

(paramType: ParamType,...) -> ReturnType

For example, if you want to define in a constraint a `Function` type that has a parameter of type
`String`, a second parameter of type `Number`, and a `Boolean` return value, the correct syntax is:

(paramA: String, paramB: Number) -> Boolean

In the following example, you define a function that receives another function as an argument:

DataWeave Script:

%dw 2.0 output application/json

fun applyIDsChange(ids: Array<Number>, changeTo: (Number) -> Number): Array<Number> = ???

If you call the function `applyIDsChange` with a function that does not match the `changeTo`
constraint `(Number) → Number`, DataWeave throws a type-checking error.

For example, the following call works because `abs` is a function that takes a value of the `Number`
type and returns a `Number`, which matches the `changeTo` parameter:

applyIDsChange(\[1,-6, 3, -8\], abs)

But the following call fails because `sum` is a function that takes an `Array` and returns a
`Number`, so it does not match the parameter constraint:

applyIDsChange(\[1,-6, 3, -8\], sum)

## Complex Types

Complex types include the `Any` and `Nothing` types, the `Union` type, the `Intersection` type, and
`Literal` types, each of which is named intuitively.

### Any and Nothing

In some cases, you cannot enforce a restriction because the type accepts all the value:

- `Any` type accepts all possible values.

- `Nothing` type accepts no value, but it can be assigned to all the types. This type is not
  frequently used explicitly, but it is used by the type inference algorithm.

### Union Type

The `Union` type is used to compose types. The syntax to define a `Union` type is:

TypeA | TypeB | ...

The following example defines a variable with a constraint that accepts a value of type `String` or
`Number`:

var age: String | Number = if (payload.allStrings) "32" else 32

A common pattern is to use `Null` type with a `Union` type to specify that a type accepts `null` as
a value. In the following example, the function `parseEmail` allows inputs of type `String` or
`Null`. In this case, you can have a object with a payload optional field `email` and you call the
function with `payload.email`.

fun parseEmail(email: String | Null) = "Code that handles email being of type String or Null"

### Intersection Type

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

The `Intersection` type intersects `Object` types. In this case, the intersection works as the
concatenation (`++`) of object types.

The syntax for the `Intersection` type is:

TypeA & TypeB & ...

In the following example, the `Intersection` concatenates the two `Object` types, resulting in the
type `{name: String, lastName: String}`. The type is an open object that can accept additional
key-value pairs. The variable accepts the value assigned to it:

var a: {name: String} & {lastName: String} = {name: "John", lastName: "Smith", age: 34}

In the case of closed objects, it returns the concatenation of the object types but results in a
closed object.  
In the following example, the intersection results in the type `{|name: String, lastName: String|}`,
which throws an exception because a closed object does not accept an `Object` value if there are
additional fields in the object (field `age`):

var a: {|name: String|} & {|lastName: String|} = {name: "John", lastName: "Smith", age: 34}

### Literal Types

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

A literal type represents exactly one value. For example, the `String` value `"foo"` can be
represented with the type `"foo"`.

The following literal types are included to the type system:

- `String` literal types

- `Number` literal types

- `Boolean` literal types

You can use literal types with `Union` types to declare a type as a finite set of allowed values.
For example, the following type declarations are aliases of `Union` and literal types:

type Weekdays = "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" type Days = Weekdays |
"Saturday" | "Sunday"

In the following example, the variable accepts only a value of the literal types `404` and `500`.
The type system ensures before runtime that the variable can be only one of those literal values:

DataWeave Script:

%dw 2.0 output application/json

var errorStatusCode: 404 | 500 = payload.statusCode match { case "error 404" -> 404 case "error 500"
-> 500 }

Function overloading enables you to define different behaviors based on the input argument’s value:

DataWeave Script:

%dw 2.0 import \* from dw::core::Strings output application/json

fun errorHandling(errorCode: 404 | 405, response): String = "Code for error 4XX handling here!" fun
errorHandling(errorCode: 500 | 501, response): String = "Code for error 5XX handling here!"
---

errorHandling(payload.statusCode, payload)

At runtime, the function-dispatching algorithm selects the correct function based on the type of the
value of `payload.statusCode`. It is not necessary to check the value of an argument with an `if`
statement to change the behavior of the function.

### Type Parameters

A type parameter enables you to write a function or data type generically so that you can handle
values identically, without depending on the type of the values.

For example, you can define a function that returns the first element of an array without losing its
type information. In the example, the variable definitions `firstString:String` and
`firstNumber:Number` specify the type of the item in the array that the `head` function takes as
input.

```DataWeave
%dw 2.0
fun head<ItemType>(elements: Array<ItemType>): ItemType = elements[0]!

var firstString:String = head(["DataWeave", "Java", "Scala", "Haskell"]) ++ " Rules!!!"
var firstNumber:Number = head([1,2,3])
output application/json
---
firstNumber
```

In the body of the script, `firstNumber` returns the number `1`. If you replace `firstNumber` with
`firstString`, the script returns the string `"DataWeave Rules!!!"`.

#### Binding Type Parameters

You can bind type parameters to require a value of a specific type. Appending `{name: "DataWeave"}`
in the following example is valid because `{name: String}` in the function definition indicates that
the value of the `name` key must be a string.

```DataWeave
%dw 2.0

fun addName<User <: {} >(user: User): User & {name: String} = user ++ {name: "DataWeave"}

var myUser: {name: String, developers: Number} = addName({developers: 3})
```

#### Parameterizing Type Definitions

You can use type parameters to parameterize type definitions. For example, assume that you define a
data structure that models file content, one for text files and the other for binary files. You can
use type parameters to construct new types that dispatch the correct implementation.

```DataWeave
%dw 2.0

type FileData<Content> = {
    data: Content,
    name: String
}

fun read(file: FileData<String>) =  "This is a text file with data " ++ file.data
fun read(file: FileData<Binary>) =  "This is a binary file with data " ++ (file.data as String {base: "64"})

---
{
  binary: read({data: "Hello World" as Binary, name: "myFile.bin"}),
  text: read({data: "Hello World", name: "myFile.txt"})
}
```

## Reuse Types

You can declare and use types within the same DataWeave script (see
[Type System](https://docs.mulesoft.com/dataweave/2.9/dataweave-type-system)), or you can reuse types from different sources by loading them
with a specific module loader. DataWeave currently supports loading types from:

- [Reusing Types from DataWeave Modules](https://docs.mulesoft.com/dataweave/2.9/dataweave-type-reuse-modules)

- [Reusing Types from a JSON Schema](https://docs.mulesoft.com/dataweave/2.9/dataweave-type-reuse-json-schema)

- [Reusing an XML Schema](https://docs.mulesoft.com/dataweave/2.9/dataweave-type-reuse-xml-schema)

- [Reusing Types from Java Classes](https://docs.mulesoft.com/dataweave/2.9/dataweave-type-reuse-java-classes)

- [Reusing Types from an Avro Schema](https://docs.mulesoft.com/dataweave/2.9/dataweave-type-reuse-avro-schema)

Module loaders are used to load files as DataWeave modules, in which different parts of those files
are loaded as DataWeave functions, variables, types, and namespace definitions. Using a prefix such
as `java!` or `xmlschema!` in the import directive tells DataWeave which module loader to use when
loading the Java class or the XML schema as a DataWeave module.

<!-- document id=78b12b43ec4c43f8322e199a611b79e32bcf2f7732b748a2fb496f1e5d2874c0 url=/mulesoft/current/en-us/dataweave/latest/dataweave-type-system.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Type System

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

2.x versions of DataWeave support a type system. To take advantage of the type-checking that the
type system executes, you need to provide constraint expressions for variables and functions
described in this section. For information about how values for these types are defined, refer to
[Value Constructs for Types](https://docs.mulesoft.com/dataweave/latest/dataweave-types).

A type system defines a set of constraints to a set of constructs, such as:

- Variables

- Function parameters

These constraints are used in the type-checking phase, when DataWeave ensures that the values
assigned to variables or the arguments for a function call respect its constraints, for example:

DataWeave Script:

%dw 2.0 import \* from dw::core::Strings output application/json

var userName: String = "John"

The variable definition for `userName` has the constraint of assigning a value of type `String`. If
some other value type is assigned, a type-checking error is raised.

DataWeave Script:

%dw 2.0 import \* from dw::core::Strings output application/json

fun toUser(id: Number, userName: String): String = "you called the function toUser!"

The constraints to call the function `toUser` are that the first argument has to be of type
`Number`, the second one of type `String` (to be coercible to those types). Another constraint is
that the result of the function has to be of type `String`. This constraint isn’t used in the call
for `toUser`; it’s applied to its definition to validate that the function body generates the proper
type.

toUser(123, "John") toUser("123", true)

Although you might expect the second call to fail, autocoercion enables the call to be successful,
and both calls work. In the case of the second function call, there is autocoercion of the `String`
value `"123"` to the `Number` value `123`, and the `Boolean` value `true` to the `String` value
`"true"`, which makes it possible to call the function.  
An example of a call that throws a type-checking error is `toUser("a 12", "John")`, because the
String value `"a 12"` isn’t coercible to a `Number` type.

DataWeave also uses a global type inference algorithm to validate your code even if no types are
specified as constraints.

> [!NOTE] Although the use of constraints is optional, they can be useful in big scripts or multiple
> scripts. The type system helps you to avoid bugs in your DataWeave logic because it causes the
> type-checking algorithm to run. Additionally, when you write your script in an IDE and define
> these constraints, the tooling helps you to find type checking errors, instead of when the script
> is running and fails.

The types supported by the DataWeave type system are divided into three categories:

- Simple Types

- Composite Types

- Complex Types

## Simple Types

Simple types represent values such as strings, Booleans, and so on. These values are atomic; they
are not composed of other values. These are the simple types:

- `String`

- `Boolean`

- `Number`

- `Regex`

- `Null`

- Temporal: `Date`, `DateTime`, `LocalDateTime`, `LocalTime`, `Time`, `Period`

### Null

`Null` is a type of only one value, the value `null`, which means that `null` cannot be assigned to
the type `String` or any other type except for the type `Null`.

For example, the `repeat` function in the String module has the signature
`repeat(String, Number): String`, which means that the function accepts as a first parameter only a
value of type `String`, and as a second parameter only a value of type `Number.` The function
returns a value of type `String`.

DataWeave Script:

%dw 2.0 import \* from dw::core::Strings output application/json
---

repeat("a", 3)

This returns `"aaa"`, but the following example throws an error because the value `null` cannot be
assigned to the parameter that expects a value of type `String`:

DataWeave Script:

%dw 2.0 import \* from dw::core::Strings output application/json
---

repeat(null, 3)

In the following example, the script assigns to the first parameter a value that is the type `Null`
(the type of this value is `Type<Null>`). It returns `"NullNullNull"` because autocoercion coerces
the value to the type `String` (`"Null"`).

DataWeave Script:

%dw 2.0 import \* from dw::core::Strings output application/json
---

repeat(Null, 3)

Some functions have an overloaded signature (the function has multiple definitions for different
parameter types) that let you call it with `null`.

For example, the `isNumeric` function from `dw::core::Strings` has the signature
`isNumeric(String): Boolean`, which receives a string and successfully returns a result if that
string is numeric, but the function is also defined as `isNumeric(Null): Boolean`.

So, if you call the function `isNumeric` with `null` (`isNumeric(null)`), the function does not
throw an exception. At runtime, the function that is dispatching algorithm selects the correct
function based on the types of the values you use. The function returns `false` because of the
definition of `isNumeric` for `null` as the argument.

## Composite Types

A composite type contains other values. The composite types are `Array`, `Object` and `Function`.

### Array Type

An array is of the type `Array<T>` in which `T` is a type parameter that defines the type of the
elements inside the array. For example, the syntax to define a variable with the type `Array` of
`Number` is:

var idsList: Array<Number> = \[1, 22, 333, 4444\]

The variable `idsList` passes the type-checking phase only when the array that is assigned to it
only contains values of the `Number` type.

### Object Type

You can define an `Object` type in two ways: `Object` or `{}`. Both define an open object and don’t
specify any constraint to their key-value pairs. See also
[Close and Open Objects](#close_open_objects).

The syntax for defining an `Object` type with a set of constraints for its key-value pairs is very
similar to the syntax for defining the value of an `Object` type:

{ keyName @(attrName: AttrType): valueType, ... }

For example, the syntax to define a `User` type with `firstName` `String`, `lastName` `String`, and
`age` `Number` is:

DataWeave Script:

%dw 2.0 output application/json

type User = { firstName: String, lastName: String, age: Number }

You can apply modifiers to each key-value pair to specify when a field is always present or when a
field can be repeated.

For repeated fields use `*`. For example, the following type allows you to have multiple `lastName`
fields:

DataWeave Script:

%dw 2.0 output application/json

type User = { firstName: String, lastName\*: String, age: Number }

For conditional fields, use `?`. For example, the following type allows the `age` field to be
present or not:

DataWeave Script:

%dw 2.0 output application/json

type User = { firstName: String, lastName\*: String, age?: Number }

#### Close and Open Objects

`Object` type can be either closed or open. A _closed_ object accepts an object value only if there
are no fields except the key-value pairs specified by the type.

An _open_ object only put constraints on the fields that are declared in the type, and if they are
all verified, then the type accepts the value. The type accepts objects that have other fields apart
of the ones mentioned in the declaration. All `object` types are open unless specified.

The following example succeeds even if `age` is not in the type declaration because the type of the
variable `user` is an open object:

DataWeave Script:

%dw 2.0 output application/json

var user: {firstName: String, lastName: String} = {firstName: "John", lastName: "Smith", age: 34}

The syntax to specify a closed object is `{| |}`. The following example makes the `User` type
support only the keys `firstName` and `lastName`. The script throws an exception because the `age`
field is not accepted.

DataWeave Script:

%dw 2.0 output application/json

var user: {|firstName: String, lastName: String|} = {firstName: "John", lastName: "Smith", age: 34}

### Function Type

DataWeave is a functional language, and functions are considered first class citizens, which means
that functions are values with associated types.

The syntax to define a function type is:

(paramType: ParamType,...) -> ReturnType

For example, if you want to define in a constraint a `Function` type that has a parameter of type
`String`, a second parameter of type `Number`, and a `Boolean` return value, the correct syntax is:

(paramA: String, paramB: Number) -> Boolean

In the following example, you define a function that receives another function as an argument:

DataWeave Script:

%dw 2.0 output application/json

fun applyIDsChange(ids: Array<Number>, changeTo: (Number) -> Number): Array<Number> = ???

If you call the function `applyIDsChange` with a function that does not match the `changeTo`
constraint `(Number) → Number`, DataWeave throws a type-checking error.

For example, the following call works because `abs` is a function that takes a value of the `Number`
type and returns a `Number`, which matches the `changeTo` parameter:

applyIDsChange(\[1,-6, 3, -8\], abs)

But the following call fails because `sum` is a function that takes an `Array` and returns a
`Number`, so it does not match the parameter constraint:

applyIDsChange(\[1,-6, 3, -8\], sum)

## Complex Types

Complex types include the `Any` and `Nothing` types, the `Union` type, the `Intersection` type, and
`Literal` types, each of which is named intuitively.

### Any and Nothing

In some cases, you cannot enforce a restriction because the type accepts all the value:

- `Any` type accepts all possible values.

- `Nothing` type accepts no value, but it can be assigned to all the types. This type is not
  frequently used explicitly, but it is used by the type inference algorithm.

### Union Type

The `Union` type is used to compose types. The syntax to define a `Union` type is:

TypeA | TypeB | ...

The following example defines a variable with a constraint that accepts a value of type `String` or
`Number`:

var age: String | Number = if (payload.allStrings) "32" else 32

A common pattern is to use `Null` type with a `Union` type to specify that a type accepts `null` as
a value. In the following example, the function `parseEmail` allows inputs of type `String` or
`Null`. In this case, you can have a object with a payload optional field `email` and you call the
function with `payload.email`.

fun parseEmail(email: String | Null) = "Code that handles email being of type String or Null"

### Intersection Type

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

The `Intersection` type intersects `Object` types. In this case, the intersection works as the
concatenation (`++`) of object types.

The syntax for the `Intersection` type is:

TypeA & TypeB & ...

In the following example, the `Intersection` concatenates the two `Object` types, resulting in the
type `{name: String, lastName: String}`. The type is an open object that can accept additional
key-value pairs. The variable accepts the value assigned to it:

var a: {name: String} & {lastName: String} = {name: "John", lastName: "Smith", age: 34}

In the case of closed objects, it returns the concatenation of the object types but results in a
closed object.  
In the following example, the intersection results in the type `{|name: String, lastName: String|}`,
which throws an exception because a closed object does not accept an `Object` value if there are
additional fields in the object (field `age`):

var a: {|name: String|} & {|lastName: String|} = {name: "John", lastName: "Smith", age: 34}

### Literal Types

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

A literal type represents exactly one value. For example, the `String` value `"foo"` can be
represented with the type `"foo"`.

The following literal types are included to the type system:

- `String` literal types

- `Number` literal types

- `Boolean` literal types

You can use literal types with `Union` types to declare a type as a finite set of allowed values.
For example, the following type declarations are aliases of `Union` and literal types:

type Weekdays = "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" type Days = Weekdays |
"Saturday" | "Sunday"

In the following example, the variable accepts only a value of the literal types `404` and `500`.
The type system ensures before runtime that the variable can be only one of those literal values:

DataWeave Script:

%dw 2.0 output application/json

var errorStatusCode: 404 | 500 = payload.statusCode match { case "error 404" -> 404 case "error 500"
-> 500 }

Function overloading enables you to define different behaviors based on the input argument’s value:

DataWeave Script:

%dw 2.0 import \* from dw::core::Strings output application/json

fun errorHandling(errorCode: 404 | 405, response): String = "Code for error 4XX handling here!" fun
errorHandling(errorCode: 500 | 501, response): String = "Code for error 5XX handling here!"
---

errorHandling(payload.statusCode, payload)

At runtime, the function-dispatching algorithm selects the correct function based on the type of the
value of `payload.statusCode`. It is not necessary to check the value of an argument with an `if`
statement to change the behavior of the function.

### Type Parameters

A type parameter enables you to write a function or data type generically so that you can handle
values identically, without depending on the type of the values.

For example, you can define a function that returns the first element of an array without losing its
type information. In the example, the variable definitions `firstString:String` and
`firstNumber:Number` specify the type of the item in the array that the `head` function takes as
input.

```DataWeave
%dw 2.0
fun head<ItemType>(elements: Array<ItemType>): ItemType = elements[0]!

var firstString:String = head(["DataWeave", "Java", "Scala", "Haskell"]) ++ " Rules!!!"
var firstNumber:Number = head([1,2,3])
output application/json
---
firstNumber
```

In the body of the script, `firstNumber` returns the number `1`. If you replace `firstNumber` with
`firstString`, the script returns the string `"DataWeave Rules!!!"`.

#### Binding Type Parameters

You can bind type parameters to require a value of a specific type. Appending `{name: "DataWeave"}`
in the following example is valid because `{name: String}` in the function definition indicates that
the value of the `name` key must be a string.

```DataWeave
%dw 2.0

fun addName<User <: {} >(user: User): User & {name: String} = user ++ {name: "DataWeave"}

var myUser: {name: String, developers: Number} = addName({developers: 3})
```

#### Parameterizing Type Definitions

You can use type parameters to parameterize type definitions. For example, assume that you define a
data structure that models file content, one for text files and the other for binary files. You can
use type parameters to construct new types that dispatch the correct implementation.

```DataWeave
%dw 2.0

type FileData<Content> = {
    data: Content,
    name: String
}

fun read(file: FileData<String>) =  "This is a text file with data " ++ file.data
fun read(file: FileData<Binary>) =  "This is a binary file with data " ++ (file.data as String {base: "64"})

---
{
  binary: read({data: "Hello World" as Binary, name: "myFile.bin"}),
  text: read({data: "Hello World", name: "myFile.txt"})
}
```

## Reuse Types

You can declare and use types within the same DataWeave script (see
[Type System](https://docs.mulesoft.com/dataweave/latest/dataweave-type-system)), or you can reuse types from different sources by loading them
with a specific module loader. DataWeave currently supports loading types from:

- [Reusing Types from DataWeave Modules](https://docs.mulesoft.com/dataweave/latest/dataweave-type-reuse-modules)

- [Reusing Types from a JSON Schema](https://docs.mulesoft.com/dataweave/latest/dataweave-type-reuse-json-schema)

- [Reusing an XML Schema](https://docs.mulesoft.com/dataweave/latest/dataweave-type-reuse-xml-schema)

- [Reusing Types from Java Classes](https://docs.mulesoft.com/dataweave/latest/dataweave-type-reuse-java-classes)

- [Reusing Types from an Avro Schema](https://docs.mulesoft.com/dataweave/latest/dataweave-type-reuse-avro-schema)

Module loaders are used to load files as DataWeave modules, in which different parts of those files
are loaded as DataWeave functions, variables, types, and namespace definitions. Using a prefix such
as `java!` or `xmlschema!` in the import directive tells DataWeave which module loader to use when
loading the Java class or the XML schema as a DataWeave module.

<!-- document id=7ce8638115a557624649d0851a3d2f4f9204bd6f3df60a4966ef342342fa2970 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-typeof.md -->

---
product: DataWeave
version: 2.11
---

# typeOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## typeOf<T>(value: T): Type<T>

Returns the primitive data type of a value, such as `String`.

A value’s type is taken from its runtime representation and is never one of the arithmetic types
(intersection, union, `Any`, or `Nothing`) nor a type alias. If present, metadata of a value is
included in the result of `typeOf` (see
[metadataOf](https://docs.mulesoft.com/dataweave/latest/dw-types-functions-metadataof)).

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>Input value to evaluate.</p></td></tr></tbody></table>

### Example

This example identifies the type of several input values.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ typeOf("A b"), typeOf([1,2]), typeOf(34), typeOf(true), typeOf({ a : 5 }) ]
```

#### Output

```JSON
[ "String", "Array", "Number", "Boolean", "Object" ]
```

### Example

This example shows that the type of a value is independent of the type with which it is declared.

#### Source

```DataWeave
%dw 2.0
output application/json

var x: String | Number = "clearly a string"
var y: "because" = "because"
---
[typeOf(x), typeOf(y)]
```

#### Output

```JSON
["String", "String"]
```

<!-- document id=28bb3e42da13d52dcca5cc96b4723dd062cf801406c93733c49747e9404da092 url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-typeof.md -->

---
product: DataWeave
version: 2.12
---

# typeOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## typeOf<T>(value: T): Type<T>

Returns the primitive data type of a value, such as `String`.

A value’s type is taken from its runtime representation and is never one of the arithmetic types
(intersection, union, `Any`, or `Nothing`) nor a type alias. If present, metadata of a value is
included in the result of `typeOf` (see
[metadataOf](https://docs.mulesoft.com/dataweave/latest/dw-types-functions-metadataof)).

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>Input value to evaluate.</p></td></tr></tbody></table>

### Example

This example identifies the type of several input values.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ typeOf("A b"), typeOf([1,2]), typeOf(34), typeOf(true), typeOf({ a : 5 }) ]
```

#### Output

```JSON
[ "String", "Array", "Number", "Boolean", "Object" ]
```

### Example

This example shows that the type of a value is independent of the type with which it is declared.

#### Source

```DataWeave
%dw 2.0
output application/json

var x: String | Number = "clearly a string"
var y: "because" = "because"
---
[typeOf(x), typeOf(y)]
```

#### Output

```JSON
["String", "String"]
```

<!-- document id=93547a33bcfb1c1155d1e72f3af01c88b73541063bb9e068fdfbeb9637398435 url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-typeof.md -->

---
product: DataWeave
version: 2.3
---

# typeOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## typeOf(T): Type<T>

Returns the type of a value.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>A string, object, array, number, or other supported type.</p></td></tr></tbody></table>

### Example

This example identifies the type of several input values.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ typeOf("A b"), typeOf([1,2]), typeOf(34), typeOf(true), typeOf({ a : 5 }) ]
```

#### Output

```JSON
[ "String", "Array", "Number", "Boolean", "Object" ]
```

<!-- document id=ace21243f12675f1fe98e0aee1df64083fc314ded3c3615f9dff2e6d9d538e49 url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-typeof.md -->

---
product: DataWeave
version: 2.4
---

# typeOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## typeOf<T>(value: T): Type<T>

Returns the type of a value.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>A string, object, array, number, or other supported type.</p></td></tr></tbody></table>

### Example

This example identifies the type of several input values.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ typeOf("A b"), typeOf([1,2]), typeOf(34), typeOf(true), typeOf({ a : 5 }) ]
```

#### Output

```JSON
[ "String", "Array", "Number", "Boolean", "Object" ]
```

<!-- document id=4d20572c925a17b869c8b0e8c8cb0400818a6ceb8228f14d62436c016815a837 url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-typeof.md -->

---
product: DataWeave
version: 2.6
---

# typeOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## typeOf<T>(value: T): Type<T>

Returns the primitive data type of a value, such as `String`.

A value’s type is taken from its runtime representation and is never one of the arithmetic types
(intersection, union, `Any`, or `Nothing`) nor a type alias. If present, metadata of a value is
included in the result of `typeOf` (see
[metadataOf](https://docs.mulesoft.com/dataweave/latest/dw-types-functions-metadataof)).

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>Input value to evaluate.</p></td></tr></tbody></table>

### Example

This example identifies the type of several input values.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ typeOf("A b"), typeOf([1,2]), typeOf(34), typeOf(true), typeOf({ a : 5 }) ]
```

#### Output

```JSON
[ "String", "Array", "Number", "Boolean", "Object" ]
```

### Example

This example shows that the type of a value is independent of the type with which it is declared.

#### Source

```DataWeave
%dw 2.0
output application/json

var x: String | Number = "clearly a string"
var y: "because" = "because"
---
[typeOf(x), typeOf(y)]
```

#### Output

```JSON
["String", "String"]
```

<!-- document id=29565a867391242608f83d17958a5d254e3d2b973f8c204f7a59c21607577ed8 url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-typeof.md -->

---
product: DataWeave
version: 2.9
---

# typeOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## typeOf<T>(value: T): Type<T>

Returns the primitive data type of a value, such as `String`.

A value’s type is taken from its runtime representation and is never one of the arithmetic types
(intersection, union, `Any`, or `Nothing`) nor a type alias. If present, metadata of a value is
included in the result of `typeOf` (see
[metadataOf](https://docs.mulesoft.com/dataweave/latest/dw-types-functions-metadataof)).

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>Input value to evaluate.</p></td></tr></tbody></table>

### Example

This example identifies the type of several input values.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ typeOf("A b"), typeOf([1,2]), typeOf(34), typeOf(true), typeOf({ a : 5 }) ]
```

#### Output

```JSON
[ "String", "Array", "Number", "Boolean", "Object" ]
```

### Example

This example shows that the type of a value is independent of the type with which it is declared.

#### Source

```DataWeave
%dw 2.0
output application/json

var x: String | Number = "clearly a string"
var y: "because" = "because"
---
[typeOf(x), typeOf(y)]
```

#### Output

```JSON
["String", "String"]
```

<!-- document id=611c92213f35f9cd672a5fe8ad1967dca7b735a0dd54cfcc1464b6c6649a1867 url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-typeof.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# typeOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## typeOf<T>(value: T): Type<T>

Returns the primitive data type of a value, such as `String`.

A value’s type is taken from its runtime representation and is never one of the arithmetic types
(intersection, union, `Any`, or `Nothing`) nor a type alias. If present, metadata of a value is
included in the result of `typeOf` (see
[metadataOf](https://docs.mulesoft.com/dataweave/latest/dw-types-functions-metadataof)).

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>Input value to evaluate.</p></td></tr></tbody></table>

### Example

This example identifies the type of several input values.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[ typeOf("A b"), typeOf([1,2]), typeOf(34), typeOf(true), typeOf({ a : 5 }) ]
```

#### Output

```JSON
[ "String", "Array", "Number", "Boolean", "Object" ]
```

### Example

This example shows that the type of a value is independent of the type with which it is declared.

#### Source

```DataWeave
%dw 2.0
output application/json

var x: String | Number = "clearly a string"
var y: "because" = "because"
---
[typeOf(x), typeOf(y)]
```

#### Output

```JSON
["String", "String"]
```

<!-- document id=a987fc02df6c4d7272c944611495313d36c190d9a56e531d21aefe5aede3e688 url=/mulesoft/current/en-us/dataweave/2.11/dw-types.md -->

---
product: DataWeave
version: 2.11
---

# Types (dw::core::Types)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module enables you to perform type introspection.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Types` to the header of your DataWeave script.

_Introduced in DataWeave version 2.3.0._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-types-functions-arrayitem">arrayItem</a></p></td><td><p>Returns the type of the given array. This function fails if the input is not an Array type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-types-functions-basetypeof">baseTypeOf</a></p></td><td><p>Returns an the base type of the given type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-types-functions-functionparamtypes">functionParamTypes</a></p></td><td><p>Returns the list of parameters from the given function type. This function fails if the provided type is not a Function type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-types-functions-functionreturntype">functionReturnType</a></p></td><td><p>Returns the type of a function’s return type. This function fails if the input type is not a Function type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-types-functions-intersectionitems">intersectionItems</a></p></td><td><p>Returns an array of all the types that define a given Intersection type. This function fails if the input is not an Intersection type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-types-functions-isanytype">isAnyType</a></p></td><td><p>Returns <code>true</code> if the input is the Any type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-types-functions-isarraytype">isArrayType</a></p></td><td><p>Returns <code>true</code> if the input type is the Array type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-types-functions-isbinarytype">isBinaryType</a></p></td><td><p>Returns <code>true</code> if the input is the Binary type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-types-functions-isbooleantype">isBooleanType</a></p></td><td><p>Returns <code>true</code> if the input is the Boolean type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-types-functions-isdatetimetype">isDateTimeType</a></p></td><td><p>Returns <code>true</code> if the input is the DateTime type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-types-functions-isdatetype">isDateType</a></p></td><td><p>Returns <code>true</code> if the input is the Date type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-types-functions-isfunctiontype">isFunctionType</a></p></td><td><p>Returns <code>true</code> if the input is the Function type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-types-functions-isintersectiontype">isIntersectionType</a></p></td><td><p>Returns <code>true</code> if the input type is the Intersection type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-types-functions-iskeytype">isKeyType</a></p></td><td><p>Returns <code>true</code> if the input is the Key type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-types-functions-isliteraltype">isLiteralType</a></p></td><td><p>Returns <code>true</code> if the input is the Literal type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-types-functions-islocaldatetimetype">isLocalDateTimeType</a></p></td><td><p>Returns <code>true</code> if the input is the LocalDateTime type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-types-functions-islocaltimetype">isLocalTimeType</a></p></td><td><p>Returns <code>true</code> if the input is the LocalTime type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-types-functions-isnamespacetype">isNamespaceType</a></p></td><td><p>Returns <code>true</code> if the input is the Namespace type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-types-functions-isnothingtype">isNothingType</a></p></td><td><p>Returns <code>true</code> if the input is the Nothing type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-types-functions-isnulltype">isNullType</a></p></td><td><p>Returns <code>true</code> if the input is the Null type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-types-functions-isnumbertype">isNumberType</a></p></td><td><p>Returns <code>true</code> if the input is the Number type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-types-functions-isobjecttype">isObjectType</a></p></td><td><p>Returns <code>true</code> if the input is the Object type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-types-functions-isperiodtype">isPeriodType</a></p></td><td><p>Returns <code>true</code> if the input is the Period type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-types-functions-israngetype">isRangeType</a></p></td><td><p>Returns <code>true</code> if the input is the Range type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-types-functions-isreferencetype">isReferenceType</a></p></td><td><p>Returns <code>true</code> if the input type is a Reference type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-types-functions-isregextype">isRegexType</a></p></td><td><p>Returns <code>true</code> if the input is the Regex type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-types-functions-isstringtype">isStringType</a></p></td><td><p>Returns <code>true</code> if the input is the String type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-types-functions-istimetype">isTimeType</a></p></td><td><p>Returns <code>true</code> if the input is the Time type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-types-functions-istimezonetype">isTimeZoneType</a></p></td><td><p>Returns <code>true</code> if the input is the TimeZone type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-types-functions-istypetype">isTypeType</a></p></td><td><p>Returns <code>true</code> if the input is the Type type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-types-functions-isuniontype">isUnionType</a></p></td><td><p>Returns <code>true</code> if the input type is the Union type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-types-functions-isuritype">isUriType</a></p></td><td><p>Returns <code>true</code> if the input is the Uri type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-types-functions-literalvalueof">literalValueOf</a></p></td><td><p>Returns the value of an input belongs to the Literal type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-types-functions-metadataof">metadataOf</a></p></td><td><p>Returns metadata that is attached to the given type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-types-functions-nameof">nameOf</a></p></td><td><p>Returns the name of the input type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-types-functions-objectfields">objectFields</a></p></td><td><p>Returns the array of fields from the given Object type. This function fails if the type is not an Object type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-types-functions-unionitems">unionItems</a></p></td><td><p>Returns an array of all the types that define a given Union type. This function fails if the input is not a Union type.</p></td></tr></tbody></table>

## Types

- [Types Types](https://docs.mulesoft.com/dataweave/2.11/dw-types-types)

<!-- document id=af36c07a1c873a1a1c5729af0c20669267ad9a82bcf93735859351858460e2ed url=/mulesoft/current/en-us/dataweave/2.12/dw-types.md -->

---
product: DataWeave
version: 2.12
---

# Types (dw::core::Types)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module enables you to perform type introspection.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Types` to the header of your DataWeave script.

_Introduced in DataWeave version 2.3.0._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-types-functions-arrayitem">arrayItem</a></p></td><td><p>Returns the type of the given array. This function fails if the input is not an Array type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-types-functions-basetypeof">baseTypeOf</a></p></td><td><p>Returns an the base type of the given type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-types-functions-functionparamtypes">functionParamTypes</a></p></td><td><p>Returns the list of parameters from the given function type. This function fails if the provided type is not a Function type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-types-functions-functionreturntype">functionReturnType</a></p></td><td><p>Returns the type of a function’s return type. This function fails if the input type is not a Function type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-types-functions-intersectionitems">intersectionItems</a></p></td><td><p>Returns an array of all the types that define a given Intersection type. This function fails if the input is not an Intersection type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-types-functions-isanytype">isAnyType</a></p></td><td><p>Returns <code>true</code> if the input is the Any type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-types-functions-isarraytype">isArrayType</a></p></td><td><p>Returns <code>true</code> if the input type is the Array type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-types-functions-isbinarytype">isBinaryType</a></p></td><td><p>Returns <code>true</code> if the input is the Binary type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-types-functions-isbooleantype">isBooleanType</a></p></td><td><p>Returns <code>true</code> if the input is the Boolean type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-types-functions-isdatetimetype">isDateTimeType</a></p></td><td><p>Returns <code>true</code> if the input is the DateTime type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-types-functions-isdatetype">isDateType</a></p></td><td><p>Returns <code>true</code> if the input is the Date type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-types-functions-isfunctiontype">isFunctionType</a></p></td><td><p>Returns <code>true</code> if the input is the Function type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-types-functions-isintersectiontype">isIntersectionType</a></p></td><td><p>Returns <code>true</code> if the input type is the Intersection type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-types-functions-iskeytype">isKeyType</a></p></td><td><p>Returns <code>true</code> if the input is the Key type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-types-functions-isliteraltype">isLiteralType</a></p></td><td><p>Returns <code>true</code> if the input is the Literal type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-types-functions-islocaldatetimetype">isLocalDateTimeType</a></p></td><td><p>Returns <code>true</code> if the input is the LocalDateTime type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-types-functions-islocaltimetype">isLocalTimeType</a></p></td><td><p>Returns <code>true</code> if the input is the LocalTime type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-types-functions-isnamespacetype">isNamespaceType</a></p></td><td><p>Returns <code>true</code> if the input is the Namespace type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-types-functions-isnothingtype">isNothingType</a></p></td><td><p>Returns <code>true</code> if the input is the Nothing type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-types-functions-isnulltype">isNullType</a></p></td><td><p>Returns <code>true</code> if the input is the Null type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-types-functions-isnumbertype">isNumberType</a></p></td><td><p>Returns <code>true</code> if the input is the Number type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-types-functions-isobjecttype">isObjectType</a></p></td><td><p>Returns <code>true</code> if the input is the Object type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-types-functions-isperiodtype">isPeriodType</a></p></td><td><p>Returns <code>true</code> if the input is the Period type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-types-functions-israngetype">isRangeType</a></p></td><td><p>Returns <code>true</code> if the input is the Range type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-types-functions-isreferencetype">isReferenceType</a></p></td><td><p>Returns <code>true</code> if the input type is a Reference type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-types-functions-isregextype">isRegexType</a></p></td><td><p>Returns <code>true</code> if the input is the Regex type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-types-functions-isstringtype">isStringType</a></p></td><td><p>Returns <code>true</code> if the input is the String type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-types-functions-istimetype">isTimeType</a></p></td><td><p>Returns <code>true</code> if the input is the Time type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-types-functions-istimezonetype">isTimeZoneType</a></p></td><td><p>Returns <code>true</code> if the input is the TimeZone type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-types-functions-istypetype">isTypeType</a></p></td><td><p>Returns <code>true</code> if the input is the Type type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-types-functions-isuniontype">isUnionType</a></p></td><td><p>Returns <code>true</code> if the input type is the Union type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-types-functions-isuritype">isUriType</a></p></td><td><p>Returns <code>true</code> if the input is the Uri type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-types-functions-literalvalueof">literalValueOf</a></p></td><td><p>Returns the value of an input belongs to the Literal type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-types-functions-metadataof">metadataOf</a></p></td><td><p>Returns metadata that is attached to the given type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-types-functions-nameof">nameOf</a></p></td><td><p>Returns the name of the input type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-types-functions-objectfields">objectFields</a></p></td><td><p>Returns the array of fields from the given Object type. This function fails if the type is not an Object type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-types-functions-unionitems">unionItems</a></p></td><td><p>Returns an array of all the types that define a given Union type. This function fails if the input is not a Union type.</p></td></tr></tbody></table>

## Types

- [Types Types](https://docs.mulesoft.com/dataweave/2.12/dw-types-types)

<!-- document id=f5bd50db72e1ed13f761819971990573fd3d601dded8f3ab76dc92ac7211236b url=/mulesoft/current/en-us/dataweave/2.3/dw-types.md -->

---
product: DataWeave
version: 2.3
---

# Types (dw::core::Types)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module enables you to perform type introspection.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Types` to the header of your DataWeave script.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-types-functions-arrayitem">arrayItem</a></p></td><td><p>Returns the type of the given array. This function fails if the input is not an Array type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-types-functions-basetypeof">baseTypeOf</a></p></td><td><p>Returns an the base type of the given type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-types-functions-functionparamtypes">functionParamTypes</a></p></td><td><p>Returns the list of parameters from the given function type. This function fails if the provided type is not a Function type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-types-functions-functionreturntype">functionReturnType</a></p></td><td><p>Returns the type of a function’s return type. This function fails if the input type is not a Function type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-types-functions-intersectionitems">intersectionItems</a></p></td><td><p>Returns an array of all the types that define a given Intersection type. This function fails if the input is not an Intersection type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-types-functions-isanytype">isAnyType</a></p></td><td><p>Returns <code>true</code> if the input is the Any type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-types-functions-isarraytype">isArrayType</a></p></td><td><p>Returns <code>true</code> if the input type is the Array type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-types-functions-isbinarytype">isBinaryType</a></p></td><td><p>Returns <code>true</code> if the input is the Binary type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-types-functions-isbooleantype">isBooleanType</a></p></td><td><p>Returns <code>true</code> if the input is the Boolean type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-types-functions-isdatetimetype">isDateTimeType</a></p></td><td><p>Returns <code>true</code> if the input is the DateTime type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-types-functions-isdatetype">isDateType</a></p></td><td><p>Returns <code>true</code> if the input is the Date type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-types-functions-isfunctiontype">isFunctionType</a></p></td><td><p>Returns <code>true</code> if the input is the Function type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-types-functions-isintersectiontype">isIntersectionType</a></p></td><td><p>Returns <code>true</code> if the input type is the Intersection type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-types-functions-iskeytype">isKeyType</a></p></td><td><p>Returns <code>true</code> if the input is the Key type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-types-functions-isliteraltype">isLiteralType</a></p></td><td><p>Returns <code>true</code> if the input is the Literal type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-types-functions-islocaldatetimetype">isLocalDateTimeType</a></p></td><td><p>Returns <code>true</code> if the input is the LocalDateTime type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-types-functions-islocaltimetype">isLocalTimeType</a></p></td><td><p>Returns <code>true</code> if the input is the LocalTime type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-types-functions-isnamespacetype">isNamespaceType</a></p></td><td><p>Returns <code>true</code> if the input is the Namespace type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-types-functions-isnothingtype">isNothingType</a></p></td><td><p>Returns <code>true</code> if the input is the Nothing type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-types-functions-isnulltype">isNullType</a></p></td><td><p>Returns <code>true</code> if the input is the Null type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-types-functions-isnumbertype">isNumberType</a></p></td><td><p>Returns <code>true</code> if the input is the Number type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-types-functions-isobjecttype">isObjectType</a></p></td><td><p>Returns <code>true</code> if the input is the Object type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-types-functions-isperiodtype">isPeriodType</a></p></td><td><p>Returns <code>true</code> if the input is the Period type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-types-functions-israngetype">isRangeType</a></p></td><td><p>Returns <code>true</code> if the input is the Range type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-types-functions-isreferencetype">isReferenceType</a></p></td><td><p>Returns <code>true</code> if the input type is a Reference type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-types-functions-isregextype">isRegexType</a></p></td><td><p>Returns <code>true</code> if the input is the Regex type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-types-functions-isstringtype">isStringType</a></p></td><td><p>Returns <code>true</code> if the input is the String type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-types-functions-istimetype">isTimeType</a></p></td><td><p>Returns <code>true</code> if the input is the Time type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-types-functions-istimezonetype">isTimeZoneType</a></p></td><td><p>Returns <code>true</code> if the input is the TimeZone type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-types-functions-istypetype">isTypeType</a></p></td><td><p>Returns <code>true</code> if the input is the Type type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-types-functions-isuniontype">isUnionType</a></p></td><td><p>Returns <code>true</code> if the input type is the Union type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-types-functions-isuritype">isUriType</a></p></td><td><p>Returns <code>true</code> if the input is the Uri type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-types-functions-literalvalueof">literalValueOf</a></p></td><td><p>Returns the value of an input belongs to the Literal type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-types-functions-metadataof">metadataOf</a></p></td><td><p>Returns metadata that is attached to the given type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-types-functions-nameof">nameOf</a></p></td><td><p>Returns the name of the input type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-types-functions-objectfields">objectFields</a></p></td><td><p>Returns the array of fields from the given Object type. This function fails if the type is not an Object type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-types-functions-unionitems">unionItems</a></p></td><td><p>Returns an array of all the types that define a given Union type. This function fails if the input is not a Union type.</p></td></tr></tbody></table>

## Types

- [Types Types](https://docs.mulesoft.com/dataweave/2.3/dw-types-types)

<!-- document id=6b9dde63a0bac82e444ed0393475a517493a5e3bad64c1ee903a53c366b1fda2 url=/mulesoft/current/en-us/dataweave/2.4/dw-types.md -->

---
product: DataWeave
version: 2.4
---

# Types (dw::core::Types)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module enables you to perform type introspection.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Types` to the header of your DataWeave script.

_Introduced in DataWeave version 2.3.0._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-types-functions-arrayitem">arrayItem</a></p></td><td><p>Returns the type of the given array. This function fails if the input is not an Array type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-types-functions-basetypeof">baseTypeOf</a></p></td><td><p>Returns an the base type of the given type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-types-functions-functionparamtypes">functionParamTypes</a></p></td><td><p>Returns the list of parameters from the given function type. This function fails if the provided type is not a Function type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-types-functions-functionreturntype">functionReturnType</a></p></td><td><p>Returns the type of a function’s return type. This function fails if the input type is not a Function type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-types-functions-intersectionitems">intersectionItems</a></p></td><td><p>Returns an array of all the types that define a given Intersection type. This function fails if the input is not an Intersection type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-types-functions-isanytype">isAnyType</a></p></td><td><p>Returns <code>true</code> if the input is the Any type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-types-functions-isarraytype">isArrayType</a></p></td><td><p>Returns <code>true</code> if the input type is the Array type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-types-functions-isbinarytype">isBinaryType</a></p></td><td><p>Returns <code>true</code> if the input is the Binary type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-types-functions-isbooleantype">isBooleanType</a></p></td><td><p>Returns <code>true</code> if the input is the Boolean type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-types-functions-isdatetimetype">isDateTimeType</a></p></td><td><p>Returns <code>true</code> if the input is the DateTime type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-types-functions-isdatetype">isDateType</a></p></td><td><p>Returns <code>true</code> if the input is the Date type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-types-functions-isfunctiontype">isFunctionType</a></p></td><td><p>Returns <code>true</code> if the input is the Function type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-types-functions-isintersectiontype">isIntersectionType</a></p></td><td><p>Returns <code>true</code> if the input type is the Intersection type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-types-functions-iskeytype">isKeyType</a></p></td><td><p>Returns <code>true</code> if the input is the Key type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-types-functions-isliteraltype">isLiteralType</a></p></td><td><p>Returns <code>true</code> if the input is the Literal type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-types-functions-islocaldatetimetype">isLocalDateTimeType</a></p></td><td><p>Returns <code>true</code> if the input is the LocalDateTime type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-types-functions-islocaltimetype">isLocalTimeType</a></p></td><td><p>Returns <code>true</code> if the input is the LocalTime type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-types-functions-isnamespacetype">isNamespaceType</a></p></td><td><p>Returns <code>true</code> if the input is the Namespace type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-types-functions-isnothingtype">isNothingType</a></p></td><td><p>Returns <code>true</code> if the input is the Nothing type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-types-functions-isnulltype">isNullType</a></p></td><td><p>Returns <code>true</code> if the input is the Null type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-types-functions-isnumbertype">isNumberType</a></p></td><td><p>Returns <code>true</code> if the input is the Number type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-types-functions-isobjecttype">isObjectType</a></p></td><td><p>Returns <code>true</code> if the input is the Object type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-types-functions-isperiodtype">isPeriodType</a></p></td><td><p>Returns <code>true</code> if the input is the Period type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-types-functions-israngetype">isRangeType</a></p></td><td><p>Returns <code>true</code> if the input is the Range type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-types-functions-isreferencetype">isReferenceType</a></p></td><td><p>Returns <code>true</code> if the input type is a Reference type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-types-functions-isregextype">isRegexType</a></p></td><td><p>Returns <code>true</code> if the input is the Regex type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-types-functions-isstringtype">isStringType</a></p></td><td><p>Returns <code>true</code> if the input is the String type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-types-functions-istimetype">isTimeType</a></p></td><td><p>Returns <code>true</code> if the input is the Time type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-types-functions-istimezonetype">isTimeZoneType</a></p></td><td><p>Returns <code>true</code> if the input is the TimeZone type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-types-functions-istypetype">isTypeType</a></p></td><td><p>Returns <code>true</code> if the input is the Type type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-types-functions-isuniontype">isUnionType</a></p></td><td><p>Returns <code>true</code> if the input type is the Union type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-types-functions-isuritype">isUriType</a></p></td><td><p>Returns <code>true</code> if the input is the Uri type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-types-functions-literalvalueof">literalValueOf</a></p></td><td><p>Returns the value of an input belongs to the Literal type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-types-functions-metadataof">metadataOf</a></p></td><td><p>Returns metadata that is attached to the given type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-types-functions-nameof">nameOf</a></p></td><td><p>Returns the name of the input type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-types-functions-objectfields">objectFields</a></p></td><td><p>Returns the array of fields from the given Object type. This function fails if the type is not an Object type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-types-functions-unionitems">unionItems</a></p></td><td><p>Returns an array of all the types that define a given Union type. This function fails if the input is not a Union type.</p></td></tr></tbody></table>

## Types

- [Types Types](https://docs.mulesoft.com/dataweave/2.4/dw-types-types)

<!-- document id=3a69b81ac10de2ad523f7fd7e3edce484fd5114a65453def95b8962c21c2f14f url=/mulesoft/current/en-us/dataweave/2.6/dw-types.md -->

---
product: DataWeave
version: 2.6
---

# Types (dw::core::Types)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module enables you to perform type introspection.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Types` to the header of your DataWeave script.

_Introduced in DataWeave version 2.3.0._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-types-functions-arrayitem">arrayItem</a></p></td><td><p>Returns the type of the given array. This function fails if the input is not an Array type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-types-functions-basetypeof">baseTypeOf</a></p></td><td><p>Returns an the base type of the given type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-types-functions-functionparamtypes">functionParamTypes</a></p></td><td><p>Returns the list of parameters from the given function type. This function fails if the provided type is not a Function type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-types-functions-functionreturntype">functionReturnType</a></p></td><td><p>Returns the type of a function’s return type. This function fails if the input type is not a Function type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-types-functions-intersectionitems">intersectionItems</a></p></td><td><p>Returns an array of all the types that define a given Intersection type. This function fails if the input is not an Intersection type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-types-functions-isanytype">isAnyType</a></p></td><td><p>Returns <code>true</code> if the input is the Any type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-types-functions-isarraytype">isArrayType</a></p></td><td><p>Returns <code>true</code> if the input type is the Array type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-types-functions-isbinarytype">isBinaryType</a></p></td><td><p>Returns <code>true</code> if the input is the Binary type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-types-functions-isbooleantype">isBooleanType</a></p></td><td><p>Returns <code>true</code> if the input is the Boolean type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-types-functions-isdatetimetype">isDateTimeType</a></p></td><td><p>Returns <code>true</code> if the input is the DateTime type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-types-functions-isdatetype">isDateType</a></p></td><td><p>Returns <code>true</code> if the input is the Date type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-types-functions-isfunctiontype">isFunctionType</a></p></td><td><p>Returns <code>true</code> if the input is the Function type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-types-functions-isintersectiontype">isIntersectionType</a></p></td><td><p>Returns <code>true</code> if the input type is the Intersection type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-types-functions-iskeytype">isKeyType</a></p></td><td><p>Returns <code>true</code> if the input is the Key type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-types-functions-isliteraltype">isLiteralType</a></p></td><td><p>Returns <code>true</code> if the input is the Literal type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-types-functions-islocaldatetimetype">isLocalDateTimeType</a></p></td><td><p>Returns <code>true</code> if the input is the LocalDateTime type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-types-functions-islocaltimetype">isLocalTimeType</a></p></td><td><p>Returns <code>true</code> if the input is the LocalTime type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-types-functions-isnamespacetype">isNamespaceType</a></p></td><td><p>Returns <code>true</code> if the input is the Namespace type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-types-functions-isnothingtype">isNothingType</a></p></td><td><p>Returns <code>true</code> if the input is the Nothing type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-types-functions-isnulltype">isNullType</a></p></td><td><p>Returns <code>true</code> if the input is the Null type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-types-functions-isnumbertype">isNumberType</a></p></td><td><p>Returns <code>true</code> if the input is the Number type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-types-functions-isobjecttype">isObjectType</a></p></td><td><p>Returns <code>true</code> if the input is the Object type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-types-functions-isperiodtype">isPeriodType</a></p></td><td><p>Returns <code>true</code> if the input is the Period type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-types-functions-israngetype">isRangeType</a></p></td><td><p>Returns <code>true</code> if the input is the Range type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-types-functions-isreferencetype">isReferenceType</a></p></td><td><p>Returns <code>true</code> if the input type is a Reference type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-types-functions-isregextype">isRegexType</a></p></td><td><p>Returns <code>true</code> if the input is the Regex type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-types-functions-isstringtype">isStringType</a></p></td><td><p>Returns <code>true</code> if the input is the String type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-types-functions-istimetype">isTimeType</a></p></td><td><p>Returns <code>true</code> if the input is the Time type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-types-functions-istimezonetype">isTimeZoneType</a></p></td><td><p>Returns <code>true</code> if the input is the TimeZone type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-types-functions-istypetype">isTypeType</a></p></td><td><p>Returns <code>true</code> if the input is the Type type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-types-functions-isuniontype">isUnionType</a></p></td><td><p>Returns <code>true</code> if the input type is the Union type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-types-functions-isuritype">isUriType</a></p></td><td><p>Returns <code>true</code> if the input is the Uri type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-types-functions-literalvalueof">literalValueOf</a></p></td><td><p>Returns the value of an input belongs to the Literal type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-types-functions-metadataof">metadataOf</a></p></td><td><p>Returns metadata that is attached to the given type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-types-functions-nameof">nameOf</a></p></td><td><p>Returns the name of the input type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-types-functions-objectfields">objectFields</a></p></td><td><p>Returns the array of fields from the given Object type. This function fails if the type is not an Object type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-types-functions-unionitems">unionItems</a></p></td><td><p>Returns an array of all the types that define a given Union type. This function fails if the input is not a Union type.</p></td></tr></tbody></table>

## Types

- [Types Types](https://docs.mulesoft.com/dataweave/2.6/dw-types-types)

<!-- document id=8e55c7020e71edb8478212ebe3335f6979365b2c0817bd2edd116c49f628d04d url=/mulesoft/current/en-us/dataweave/2.9/dw-types.md -->

---
product: DataWeave
version: 2.9
---

# Types (dw::core::Types)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module enables you to perform type introspection.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Types` to the header of your DataWeave script.

_Introduced in DataWeave version 2.3.0._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-types-functions-arrayitem">arrayItem</a></p></td><td><p>Returns the type of the given array. This function fails if the input is not an Array type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-types-functions-basetypeof">baseTypeOf</a></p></td><td><p>Returns an the base type of the given type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-types-functions-functionparamtypes">functionParamTypes</a></p></td><td><p>Returns the list of parameters from the given function type. This function fails if the provided type is not a Function type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-types-functions-functionreturntype">functionReturnType</a></p></td><td><p>Returns the type of a function’s return type. This function fails if the input type is not a Function type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-types-functions-intersectionitems">intersectionItems</a></p></td><td><p>Returns an array of all the types that define a given Intersection type. This function fails if the input is not an Intersection type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-types-functions-isanytype">isAnyType</a></p></td><td><p>Returns <code>true</code> if the input is the Any type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-types-functions-isarraytype">isArrayType</a></p></td><td><p>Returns <code>true</code> if the input type is the Array type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-types-functions-isbinarytype">isBinaryType</a></p></td><td><p>Returns <code>true</code> if the input is the Binary type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-types-functions-isbooleantype">isBooleanType</a></p></td><td><p>Returns <code>true</code> if the input is the Boolean type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-types-functions-isdatetimetype">isDateTimeType</a></p></td><td><p>Returns <code>true</code> if the input is the DateTime type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-types-functions-isdatetype">isDateType</a></p></td><td><p>Returns <code>true</code> if the input is the Date type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-types-functions-isfunctiontype">isFunctionType</a></p></td><td><p>Returns <code>true</code> if the input is the Function type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-types-functions-isintersectiontype">isIntersectionType</a></p></td><td><p>Returns <code>true</code> if the input type is the Intersection type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-types-functions-iskeytype">isKeyType</a></p></td><td><p>Returns <code>true</code> if the input is the Key type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-types-functions-isliteraltype">isLiteralType</a></p></td><td><p>Returns <code>true</code> if the input is the Literal type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-types-functions-islocaldatetimetype">isLocalDateTimeType</a></p></td><td><p>Returns <code>true</code> if the input is the LocalDateTime type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-types-functions-islocaltimetype">isLocalTimeType</a></p></td><td><p>Returns <code>true</code> if the input is the LocalTime type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-types-functions-isnamespacetype">isNamespaceType</a></p></td><td><p>Returns <code>true</code> if the input is the Namespace type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-types-functions-isnothingtype">isNothingType</a></p></td><td><p>Returns <code>true</code> if the input is the Nothing type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-types-functions-isnulltype">isNullType</a></p></td><td><p>Returns <code>true</code> if the input is the Null type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-types-functions-isnumbertype">isNumberType</a></p></td><td><p>Returns <code>true</code> if the input is the Number type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-types-functions-isobjecttype">isObjectType</a></p></td><td><p>Returns <code>true</code> if the input is the Object type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-types-functions-isperiodtype">isPeriodType</a></p></td><td><p>Returns <code>true</code> if the input is the Period type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-types-functions-israngetype">isRangeType</a></p></td><td><p>Returns <code>true</code> if the input is the Range type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-types-functions-isreferencetype">isReferenceType</a></p></td><td><p>Returns <code>true</code> if the input type is a Reference type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-types-functions-isregextype">isRegexType</a></p></td><td><p>Returns <code>true</code> if the input is the Regex type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-types-functions-isstringtype">isStringType</a></p></td><td><p>Returns <code>true</code> if the input is the String type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-types-functions-istimetype">isTimeType</a></p></td><td><p>Returns <code>true</code> if the input is the Time type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-types-functions-istimezonetype">isTimeZoneType</a></p></td><td><p>Returns <code>true</code> if the input is the TimeZone type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-types-functions-istypetype">isTypeType</a></p></td><td><p>Returns <code>true</code> if the input is the Type type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-types-functions-isuniontype">isUnionType</a></p></td><td><p>Returns <code>true</code> if the input type is the Union type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-types-functions-isuritype">isUriType</a></p></td><td><p>Returns <code>true</code> if the input is the Uri type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-types-functions-literalvalueof">literalValueOf</a></p></td><td><p>Returns the value of an input belongs to the Literal type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-types-functions-metadataof">metadataOf</a></p></td><td><p>Returns metadata that is attached to the given type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-types-functions-nameof">nameOf</a></p></td><td><p>Returns the name of the input type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-types-functions-objectfields">objectFields</a></p></td><td><p>Returns the array of fields from the given Object type. This function fails if the type is not an Object type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-types-functions-unionitems">unionItems</a></p></td><td><p>Returns an array of all the types that define a given Union type. This function fails if the input is not a Union type.</p></td></tr></tbody></table>

## Types

- [Types Types](https://docs.mulesoft.com/dataweave/2.9/dw-types-types)

<!-- document id=5e25925b1d417aeff373b07d366db2ff20c243059753ce35ce33a968c8bb064a url=/mulesoft/current/en-us/dataweave/latest/dw-types.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Types (dw::core::Types)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module enables you to perform type introspection.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::Types` to the header of your DataWeave script.

_Introduced in DataWeave version 2.3.0._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-types-functions-arrayitem">arrayItem</a></p></td><td><p>Returns the type of the given array. This function fails if the input is not an Array type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-types-functions-basetypeof">baseTypeOf</a></p></td><td><p>Returns an the base type of the given type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-types-functions-functionparamtypes">functionParamTypes</a></p></td><td><p>Returns the list of parameters from the given function type. This function fails if the provided type is not a Function type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-types-functions-functionreturntype">functionReturnType</a></p></td><td><p>Returns the type of a function’s return type. This function fails if the input type is not a Function type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-types-functions-intersectionitems">intersectionItems</a></p></td><td><p>Returns an array of all the types that define a given Intersection type. This function fails if the input is not an Intersection type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-types-functions-isanytype">isAnyType</a></p></td><td><p>Returns <code>true</code> if the input is the Any type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-types-functions-isarraytype">isArrayType</a></p></td><td><p>Returns <code>true</code> if the input type is the Array type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-types-functions-isbinarytype">isBinaryType</a></p></td><td><p>Returns <code>true</code> if the input is the Binary type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-types-functions-isbooleantype">isBooleanType</a></p></td><td><p>Returns <code>true</code> if the input is the Boolean type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-types-functions-isdatetimetype">isDateTimeType</a></p></td><td><p>Returns <code>true</code> if the input is the DateTime type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-types-functions-isdatetype">isDateType</a></p></td><td><p>Returns <code>true</code> if the input is the Date type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-types-functions-isfunctiontype">isFunctionType</a></p></td><td><p>Returns <code>true</code> if the input is the Function type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-types-functions-isintersectiontype">isIntersectionType</a></p></td><td><p>Returns <code>true</code> if the input type is the Intersection type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-types-functions-iskeytype">isKeyType</a></p></td><td><p>Returns <code>true</code> if the input is the Key type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-types-functions-isliteraltype">isLiteralType</a></p></td><td><p>Returns <code>true</code> if the input is the Literal type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-types-functions-islocaldatetimetype">isLocalDateTimeType</a></p></td><td><p>Returns <code>true</code> if the input is the LocalDateTime type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-types-functions-islocaltimetype">isLocalTimeType</a></p></td><td><p>Returns <code>true</code> if the input is the LocalTime type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-types-functions-isnamespacetype">isNamespaceType</a></p></td><td><p>Returns <code>true</code> if the input is the Namespace type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-types-functions-isnothingtype">isNothingType</a></p></td><td><p>Returns <code>true</code> if the input is the Nothing type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-types-functions-isnulltype">isNullType</a></p></td><td><p>Returns <code>true</code> if the input is the Null type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-types-functions-isnumbertype">isNumberType</a></p></td><td><p>Returns <code>true</code> if the input is the Number type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-types-functions-isobjecttype">isObjectType</a></p></td><td><p>Returns <code>true</code> if the input is the Object type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-types-functions-isperiodtype">isPeriodType</a></p></td><td><p>Returns <code>true</code> if the input is the Period type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-types-functions-israngetype">isRangeType</a></p></td><td><p>Returns <code>true</code> if the input is the Range type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-types-functions-isreferencetype">isReferenceType</a></p></td><td><p>Returns <code>true</code> if the input type is a Reference type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-types-functions-isregextype">isRegexType</a></p></td><td><p>Returns <code>true</code> if the input is the Regex type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-types-functions-isstringtype">isStringType</a></p></td><td><p>Returns <code>true</code> if the input is the String type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-types-functions-istimetype">isTimeType</a></p></td><td><p>Returns <code>true</code> if the input is the Time type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-types-functions-istimezonetype">isTimeZoneType</a></p></td><td><p>Returns <code>true</code> if the input is the TimeZone type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-types-functions-istypetype">isTypeType</a></p></td><td><p>Returns <code>true</code> if the input is the Type type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-types-functions-isuniontype">isUnionType</a></p></td><td><p>Returns <code>true</code> if the input type is the Union type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-types-functions-isuritype">isUriType</a></p></td><td><p>Returns <code>true</code> if the input is the Uri type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-types-functions-literalvalueof">literalValueOf</a></p></td><td><p>Returns the value of an input belongs to the Literal type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-types-functions-metadataof">metadataOf</a></p></td><td><p>Returns metadata that is attached to the given type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-types-functions-nameof">nameOf</a></p></td><td><p>Returns the name of the input type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-types-functions-objectfields">objectFields</a></p></td><td><p>Returns the array of fields from the given Object type. This function fails if the type is not an Object type.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-types-functions-unionitems">unionItems</a></p></td><td><p>Returns an array of all the types that define a given Union type. This function fails if the input is not a Union type.</p></td></tr></tbody></table>

## Types

- [Types Types](https://docs.mulesoft.com/dataweave/latest/dw-types-types)

<!-- document id=f643b8456f97b3f07213270a2a33ad40f55260c8f9c135a85aa1e04dbbaa04d8 url=/mulesoft/current/en-us/dataweave/2.11/dw-types-types.md -->

---
product: DataWeave
version: 2.11
---

# Types Types (dw::core::Types)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>Attribute</p></td><td><div><div><p><code>type Attribute = { name: QName, required: Boolean, value: Type }</code></p></div></div></td><td><div><div><p>Represents an Attribute definition that is part of an Object field Key.</p></div><div><p><em>Introduced in DataWeave version 2.3.0.</em></p></div></div></td></tr><tr><td><p>Field</p></td><td><div><div><p><code>type Field = { key: { name: QName, attributes: Array&lt;Attribute&gt; }, required: Boolean, repeated: Boolean, value: Type }</code></p></div></div></td><td><div><div><p>Represents a Field description that is part of an Object.</p></div><div><p><em>Introduced in DataWeave version 2.3.0.</em></p></div></div></td></tr><tr><td><p>FunctionParam</p></td><td><div><div><p><code>type FunctionParam = { paramType: Type, optional: Boolean }</code></p></div></div></td><td><div><div><p>Represents a Function parameter that is part of a Function type.</p></div><div><p><em>Introduced in DataWeave version 2.3.0.</em></p></div></div></td></tr><tr><td><p>QName</p></td><td><div><div><p><code>type QName = { localName: String, namespace: Namespace | Null }</code></p></div></div></td><td><div><div><p>Represents a Qualified Name definition with a <code>localName</code> (a string) and a <code>namespace</code>. If the QName does not have a Namespace, its value is <code>null</code>.</p></div><div><p><em>Introduced in DataWeave version 2.3.0.</em></p></div></div></td></tr></tbody></table>

<!-- document id=c772e6cffb6017b3c5fc5c9821dc6932efb0c6ca5436f59168c9c694b170d863 url=/mulesoft/current/en-us/dataweave/2.12/dw-types-types.md -->

---
product: DataWeave
version: 2.12
---

# Types Types (dw::core::Types)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>Attribute</p></td><td><div><div><p><code>type Attribute = { name: QName, required: Boolean, value: Type }</code></p></div></div></td><td><div><div><p>Represents an Attribute definition that is part of an Object field Key.</p></div><div><p><em>Introduced in DataWeave version 2.3.0.</em></p></div></div></td></tr><tr><td><p>Field</p></td><td><div><div><p><code>type Field = { key: { name: QName, attributes: Array&lt;Attribute&gt; }, required: Boolean, repeated: Boolean, value: Type }</code></p></div></div></td><td><div><div><p>Represents a Field description that is part of an Object.</p></div><div><p><em>Introduced in DataWeave version 2.3.0.</em></p></div></div></td></tr><tr><td><p>FunctionParam</p></td><td><div><div><p><code>type FunctionParam = { paramType: Type, optional: Boolean }</code></p></div></div></td><td><div><div><p>Represents a Function parameter that is part of a Function type.</p></div><div><p><em>Introduced in DataWeave version 2.3.0.</em></p></div></div></td></tr><tr><td><p>QName</p></td><td><div><div><p><code>type QName = { localName: String, namespace: Namespace | Null }</code></p></div></div></td><td><div><div><p>Represents a Qualified Name definition with a <code>localName</code> (a string) and a <code>namespace</code>. If the QName does not have a Namespace, its value is <code>null</code>.</p></div><div><p><em>Introduced in DataWeave version 2.3.0.</em></p></div></div></td></tr></tbody></table>

<!-- document id=6efdec990c8bebfaf49b46828776a65014c7a31230dbf4116cb21cbdba8d6333 url=/mulesoft/current/en-us/dataweave/2.3/dw-types-types.md -->

---
product: DataWeave
version: 2.3
---

# Types Types (dw::core::Types)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>Attribute</p></td><td><p><code>type Attribute = { name: QName, required: Boolean, value: Type }</code></p></td><td><p>Represents an Attribute definition that is part of an Object field Key.</p></td></tr><tr><td><p>Field</p></td><td><p><code>type Field = { key: { name: QName, attributes: Array&lt;Attribute&gt; }, required: Boolean, repeated: Boolean, value: Type }</code></p></td><td><p>Represents a Field description that is part of an Object.</p></td></tr><tr><td><p>FunctionParam</p></td><td><p><code>type FunctionParam = { paramType: Type, optional: Boolean }</code></p></td><td><p>Represents a Function parameter that is part of a Function type.</p></td></tr><tr><td><p>QName</p></td><td><p><code>type QName = { localName: String, namespace: Namespace | Null }</code></p></td><td><p>Represents a Qualified Name definition with a <code>localName</code> (a string) and a <code>namespace</code>. If the QName does not have a Namespace, its value is <code>null</code>.</p></td></tr></tbody></table>

<!-- document id=9730e997910147161ad31316bb9b12b9d79648db3368aed984f401211ab721d0 url=/mulesoft/current/en-us/dataweave/2.4/dw-types-types.md -->

---
product: DataWeave
version: 2.4
---

# Types Types (dw::core::Types)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>Attribute</p></td><td><div><div><p><code>type Attribute = { name: QName, required: Boolean, value: Type }</code></p></div></div></td><td><div><div><p>Represents an Attribute definition that is part of an Object field Key.</p></div><div><p><em>Introduced in DataWeave version 2.3.0.</em></p></div></div></td></tr><tr><td><p>Field</p></td><td><div><div><p><code>type Field = { key: { name: QName, attributes: Array&lt;Attribute&gt; }, required: Boolean, repeated: Boolean, value: Type }</code></p></div></div></td><td><div><div><p>Represents a Field description that is part of an Object.</p></div><div><p><em>Introduced in DataWeave version 2.3.0.</em></p></div></div></td></tr><tr><td><p>FunctionParam</p></td><td><div><div><p><code>type FunctionParam = { paramType: Type, optional: Boolean }</code></p></div></div></td><td><div><div><p>Represents a Function parameter that is part of a Function type.</p></div><div><p><em>Introduced in DataWeave version 2.3.0.</em></p></div></div></td></tr><tr><td><p>QName</p></td><td><div><div><p><code>type QName = { localName: String, namespace: Namespace | Null }</code></p></div></div></td><td><div><div><p>Represents a Qualified Name definition with a <code>localName</code> (a string) and a <code>namespace</code>. If the QName does not have a Namespace, its value is <code>null</code>.</p></div><div><p><em>Introduced in DataWeave version 2.3.0.</em></p></div></div></td></tr></tbody></table>

<!-- document id=70a5eaf6fedf45d6e2fdc8a271faa242c904882c81856bad231b51f6cd428166 url=/mulesoft/current/en-us/dataweave/2.6/dw-types-types.md -->

---
product: DataWeave
version: 2.6
---

# Types Types (dw::core::Types)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>Attribute</p></td><td><div><div><p><code>type Attribute = { name: QName, required: Boolean, value: Type }</code></p></div></div></td><td><div><div><p>Represents an Attribute definition that is part of an Object field Key.</p></div><div><p><em>Introduced in DataWeave version 2.3.0.</em></p></div></div></td></tr><tr><td><p>Field</p></td><td><div><div><p><code>type Field = { key: { name: QName, attributes: Array&lt;Attribute&gt; }, required: Boolean, repeated: Boolean, value: Type }</code></p></div></div></td><td><div><div><p>Represents a Field description that is part of an Object.</p></div><div><p><em>Introduced in DataWeave version 2.3.0.</em></p></div></div></td></tr><tr><td><p>FunctionParam</p></td><td><div><div><p><code>type FunctionParam = { paramType: Type, optional: Boolean }</code></p></div></div></td><td><div><div><p>Represents a Function parameter that is part of a Function type.</p></div><div><p><em>Introduced in DataWeave version 2.3.0.</em></p></div></div></td></tr><tr><td><p>QName</p></td><td><div><div><p><code>type QName = { localName: String, namespace: Namespace | Null }</code></p></div></div></td><td><div><div><p>Represents a Qualified Name definition with a <code>localName</code> (a string) and a <code>namespace</code>. If the QName does not have a Namespace, its value is <code>null</code>.</p></div><div><p><em>Introduced in DataWeave version 2.3.0.</em></p></div></div></td></tr></tbody></table>

<!-- document id=d175725815bb72a82a3972ecffca574e15ea649e66cc62b45b40f3cf60331978 url=/mulesoft/current/en-us/dataweave/2.9/dw-types-types.md -->

---
product: DataWeave
version: 2.9
---

# Types Types (dw::core::Types)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>Attribute</p></td><td><div><div><p><code>type Attribute = { name: QName, required: Boolean, value: Type }</code></p></div></div></td><td><div><div><p>Represents an Attribute definition that is part of an Object field Key.</p></div><div><p><em>Introduced in DataWeave version 2.3.0.</em></p></div></div></td></tr><tr><td><p>Field</p></td><td><div><div><p><code>type Field = { key: { name: QName, attributes: Array&lt;Attribute&gt; }, required: Boolean, repeated: Boolean, value: Type }</code></p></div></div></td><td><div><div><p>Represents a Field description that is part of an Object.</p></div><div><p><em>Introduced in DataWeave version 2.3.0.</em></p></div></div></td></tr><tr><td><p>FunctionParam</p></td><td><div><div><p><code>type FunctionParam = { paramType: Type, optional: Boolean }</code></p></div></div></td><td><div><div><p>Represents a Function parameter that is part of a Function type.</p></div><div><p><em>Introduced in DataWeave version 2.3.0.</em></p></div></div></td></tr><tr><td><p>QName</p></td><td><div><div><p><code>type QName = { localName: String, namespace: Namespace | Null }</code></p></div></div></td><td><div><div><p>Represents a Qualified Name definition with a <code>localName</code> (a string) and a <code>namespace</code>. If the QName does not have a Namespace, its value is <code>null</code>.</p></div><div><p><em>Introduced in DataWeave version 2.3.0.</em></p></div></div></td></tr></tbody></table>

<!-- document id=e2ac55a7940fcc64ef41595a0cdab534273d548099c4b1bdee05d4053201647a url=/mulesoft/current/en-us/dataweave/latest/dw-types-types.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Types Types (dw::core::Types)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>Attribute</p></td><td><div><div><p><code>type Attribute = { name: QName, required: Boolean, value: Type }</code></p></div></div></td><td><div><div><p>Represents an Attribute definition that is part of an Object field Key.</p></div><div><p><em>Introduced in DataWeave version 2.3.0.</em></p></div></div></td></tr><tr><td><p>Field</p></td><td><div><div><p><code>type Field = { key: { name: QName, attributes: Array&lt;Attribute&gt; }, required: Boolean, repeated: Boolean, value: Type }</code></p></div></div></td><td><div><div><p>Represents a Field description that is part of an Object.</p></div><div><p><em>Introduced in DataWeave version 2.3.0.</em></p></div></div></td></tr><tr><td><p>FunctionParam</p></td><td><div><div><p><code>type FunctionParam = { paramType: Type, optional: Boolean }</code></p></div></div></td><td><div><div><p>Represents a Function parameter that is part of a Function type.</p></div><div><p><em>Introduced in DataWeave version 2.3.0.</em></p></div></div></td></tr><tr><td><p>QName</p></td><td><div><div><p><code>type QName = { localName: String, namespace: Namespace | Null }</code></p></div></div></td><td><div><div><p>Represents a Qualified Name definition with a <code>localName</code> (a string) and a <code>namespace</code>. If the QName does not have a Namespace, its value is <code>null</code>.</p></div><div><p><em>Introduced in DataWeave version 2.3.0.</em></p></div></div></td></tr></tbody></table>

<!-- document id=e09720223c7a64518a25b8a0ffeff16ccf16d12fdf4587b9e2cf482fc280166b url=/mulesoft/current/en-us/dataweave/2.11/dw-strings-functions-underscore.md -->

---
product: DataWeave
version: 2.11
---

# underscore

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## underscore(text: String): String

Replaces hyphens, spaces, and camel-casing in a string with underscores.

If no hyphens, spaces, and camel-casing are present, the output will match the input.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example replaces the hyphens and spaces in the input. Notice that the input "customer" is not
modified in the output.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
   "a" : underscore("customer"),
   "b" : underscore("customer-first-name"),
   "c" : underscore("customer NAME"),
   "d" : underscore("customerName")
}
```

#### Output

```JSON
{
   "a": "customer",
   "b": "customer_first_name",
   "c": "customer_name",
   "d": "customer_name"
}
```

## underscore(text: Null): Null

Helper function that enables `underscore` to work with a `null` value.

<!-- document id=40a920578750be255cfc6b67f21d104a4fd80455f0b7c19b94f5431de48fa433 url=/mulesoft/current/en-us/dataweave/2.12/dw-strings-functions-underscore.md -->

---
product: DataWeave
version: 2.12
---

# underscore

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## underscore(text: String): String

Replaces hyphens, spaces, and camel-casing in a string with underscores.

If no hyphens, spaces, and camel-casing are present, the output will match the input.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example replaces the hyphens and spaces in the input. Notice that the input "customer" is not
modified in the output.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
   "a" : underscore("customer"),
   "b" : underscore("customer-first-name"),
   "c" : underscore("customer NAME"),
   "d" : underscore("customerName")
}
```

#### Output

```JSON
{
   "a": "customer",
   "b": "customer_first_name",
   "c": "customer_name",
   "d": "customer_name"
}
```

## underscore(text: Null): Null

Helper function that enables `underscore` to work with a `null` value.

<!-- document id=8aa7d9abe2823ca365941a4c6dee1a0c57e69afa246d31c3b8bd183104d52f09 url=/mulesoft/current/en-us/dataweave/2.3/dw-strings-functions-underscore.md -->

---
product: DataWeave
version: 2.3
---

# underscore

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## underscore(String): String

Replaces hyphens, spaces, and camel-casing in a string with underscores.

If no hyphens, spaces, and camel-casing are present, the output will match the input.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example replaces the hyphens and spaces in the input. Notice that the input "customer" is not
modified in the output.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
   "a" : underscore("customer"),
   "b" : underscore("customer-first-name"),
   "c" : underscore("customer NAME"),
   "d" : underscore("customerName")
}
```

#### Output

```JSON
{
   "a": "customer",
   "b": "customer_first_name",
   "c": "customer_name",
   "d": "customer_name"
}
```

## underscore(Null): Null

Helper function that enables `underscore` to work with a `null` value.

<!-- document id=228c6479201e209f3cb01b827921db8d584fcc617c7103b3acef2488dc8f75bc url=/mulesoft/current/en-us/dataweave/2.4/dw-strings-functions-underscore.md -->

---
product: DataWeave
version: 2.4
---

# underscore

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## underscore(text: String): String

Replaces hyphens, spaces, and camel-casing in a string with underscores.

If no hyphens, spaces, and camel-casing are present, the output will match the input.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example replaces the hyphens and spaces in the input. Notice that the input "customer" is not
modified in the output.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
   "a" : underscore("customer"),
   "b" : underscore("customer-first-name"),
   "c" : underscore("customer NAME"),
   "d" : underscore("customerName")
}
```

#### Output

```JSON
{
   "a": "customer",
   "b": "customer_first_name",
   "c": "customer_name",
   "d": "customer_name"
}
```

## underscore(text: Null): Null

Helper function that enables `underscore` to work with a `null` value.

<!-- document id=0043ca5311626118d5c6df3d02ccc547e2f4ca6810b8138977f25f7f477a3a7c url=/mulesoft/current/en-us/dataweave/2.6/dw-strings-functions-underscore.md -->

---
product: DataWeave
version: 2.6
---

# underscore

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## underscore(text: String): String

Replaces hyphens, spaces, and camel-casing in a string with underscores.

If no hyphens, spaces, and camel-casing are present, the output will match the input.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example replaces the hyphens and spaces in the input. Notice that the input "customer" is not
modified in the output.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
   "a" : underscore("customer"),
   "b" : underscore("customer-first-name"),
   "c" : underscore("customer NAME"),
   "d" : underscore("customerName")
}
```

#### Output

```JSON
{
   "a": "customer",
   "b": "customer_first_name",
   "c": "customer_name",
   "d": "customer_name"
}
```

## underscore(text: Null): Null

Helper function that enables `underscore` to work with a `null` value.

<!-- document id=b3ceb4f46480579dac8fb888eab9d0a4c07e988e04575433826fb1519b14f4b2 url=/mulesoft/current/en-us/dataweave/2.9/dw-strings-functions-underscore.md -->

---
product: DataWeave
version: 2.9
---

# underscore

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## underscore(text: String): String

Replaces hyphens, spaces, and camel-casing in a string with underscores.

If no hyphens, spaces, and camel-casing are present, the output will match the input.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example replaces the hyphens and spaces in the input. Notice that the input "customer" is not
modified in the output.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
   "a" : underscore("customer"),
   "b" : underscore("customer-first-name"),
   "c" : underscore("customer NAME"),
   "d" : underscore("customerName")
}
```

#### Output

```JSON
{
   "a": "customer",
   "b": "customer_first_name",
   "c": "customer_name",
   "d": "customer_name"
}
```

## underscore(text: Null): Null

Helper function that enables `underscore` to work with a `null` value.

<!-- document id=e364d8324e8cb8bd266ce7ce9f23de8c80538fc5b363b034cc47507ee1da5545 url=/mulesoft/current/en-us/dataweave/latest/dw-strings-functions-underscore.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# underscore

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## underscore(text: String): String

Replaces hyphens, spaces, and camel-casing in a string with underscores.

If no hyphens, spaces, and camel-casing are present, the output will match the input.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr></tbody></table>

### Example

This example replaces the hyphens and spaces in the input. Notice that the input "customer" is not
modified in the output.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
   "a" : underscore("customer"),
   "b" : underscore("customer-first-name"),
   "c" : underscore("customer NAME"),
   "d" : underscore("customerName")
}
```

#### Output

```JSON
{
   "a": "customer",
   "b": "customer_first_name",
   "c": "customer_name",
   "d": "customer_name"
}
```

## underscore(text: Null): Null

Helper function that enables `underscore` to work with a `null` value.

<!-- document id=fa61ca3f99c089a54b580438152913f73198916fe344e22fb2594a90f64b778a url=/mulesoft/current/en-us/dataweave/2.11/dw-types-functions-unionitems.md -->

---
product: DataWeave
version: 2.11
---

# unionItems

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## unionItems(t: Type): Array<Type>

Returns an array of all the types that define a given Union type. This function fails if the input
is not a Union type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `unionItems` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = String | Number
output application/json
---
{
   a: unionItems(AType)
}
```

#### Output

```Json
{
  "a": ["String","Number"]
}
```

<!-- document id=aaf3aefeaed4c71dadb4d21ba036b4fd363608ff2f3d2da86d289df15a8c4e74 url=/mulesoft/current/en-us/dataweave/2.12/dw-types-functions-unionitems.md -->

---
product: DataWeave
version: 2.12
---

# unionItems

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## unionItems(t: Type): Array<Type>

Returns an array of all the types that define a given Union type. This function fails if the input
is not a Union type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `unionItems` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = String | Number
output application/json
---
{
   a: unionItems(AType)
}
```

#### Output

```Json
{
  "a": ["String","Number"]
}
```

<!-- document id=2893615849ad5458d4acd54300294e0cfb8c7ceb7e093f64ddee62c6c38c312c url=/mulesoft/current/en-us/dataweave/2.3/dw-types-functions-unionitems.md -->

---
product: DataWeave
version: 2.3
---

# unionItems

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## unionItems(Type): Array<Type>

Returns an array of all the types that define a given Union type. This function fails if the input
is not a Union type.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>t</p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `unionItems` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = String | Number
output application/json
---
{
   a: unionItems(AType)
}
```

#### Output

```Json
{
  "a": ["String","Number"]
}
```

<!-- document id=6dfea04faeb9149b502bfffd0ff817b06ae192ca24105dc83d056cdd78577bb4 url=/mulesoft/current/en-us/dataweave/2.4/dw-types-functions-unionitems.md -->

---
product: DataWeave
version: 2.4
---

# unionItems

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## unionItems(t: Type): Array<Type>

Returns an array of all the types that define a given Union type. This function fails if the input
is not a Union type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `unionItems` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = String | Number
output application/json
---
{
   a: unionItems(AType)
}
```

#### Output

```Json
{
  "a": ["String","Number"]
}
```

<!-- document id=4f9fb963bddedd73a3df89765a2704e0226505bf63d4f97c885bf4374b32dbaf url=/mulesoft/current/en-us/dataweave/2.6/dw-types-functions-unionitems.md -->

---
product: DataWeave
version: 2.6
---

# unionItems

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## unionItems(t: Type): Array<Type>

Returns an array of all the types that define a given Union type. This function fails if the input
is not a Union type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `unionItems` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = String | Number
output application/json
---
{
   a: unionItems(AType)
}
```

#### Output

```Json
{
  "a": ["String","Number"]
}
```

<!-- document id=502fad0a65e0f79e3db7f7b970087230f168603be9f9ae350929c9c2b97a4701 url=/mulesoft/current/en-us/dataweave/2.9/dw-types-functions-unionitems.md -->

---
product: DataWeave
version: 2.9
---

# unionItems

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## unionItems(t: Type): Array<Type>

Returns an array of all the types that define a given Union type. This function fails if the input
is not a Union type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `unionItems` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = String | Number
output application/json
---
{
   a: unionItems(AType)
}
```

#### Output

```Json
{
  "a": ["String","Number"]
}
```

<!-- document id=7c3dabc2b839ce2c6de78c46fefcbcff79d38ff3a4a7b1a64fb58fafe85bedbb url=/mulesoft/current/en-us/dataweave/latest/dw-types-functions-unionitems.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# unionItems

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## unionItems(t: Type): Array<Type>

Returns an array of all the types that define a given Union type. This function fails if the input
is not a Union type.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>t</code></p></td><td><p>The type to check.</p></td></tr></tbody></table>

### Example

This example shows how `unionItems` behaves with different inputs.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Types
type AType = String | Number
output application/json
---
{
   a: unionItems(AType)
}
```

#### Output

```Json
{
  "a": ["String","Number"]
}
```

<!-- document id=d5e8d1dafc87cdb0a6a50ef4704afc339222ec076d037dec0ae0463061fff2ba url=/mulesoft/current/en-us/dataweave/2.11/dw-strings-functions-unwrap.md -->

---
product: DataWeave
version: 2.11
---

# unwrap

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## unwrap(text: String, wrapper: String): String

Unwraps a given `text` from a `wrapper` text.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>wrapper</code></p></td><td><p>The text used to unwrap.</p></td></tr></tbody></table>

### Example

This example shows how `unwrap` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import unwrap from dw::core::Strings
output application/json
---
{
  "a": unwrap(null, ""),
  "b": unwrap(null, '\0'),
  "c": unwrap("'abc'", "'"),
  "d": unwrap("AABabcBAA", 'A'),
  "e": unwrap("A", '#'),
  "f": unwrap("#A", '#'),
  "g": unwrap("A#", '#')
}
```

#### Output

```JSON
{
   "a": null,
   "b": null,
   "c": "abc",
   "d": "ABabcBA",
   "e": "A",
   "f": "#A",
   "g": "A#"
 }
```

## unwrap(text: Null, wrapper: String): Null

Helper function that enables `unwrap` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=53a1c4553b4980f6fcbd3cc8c56b82a87253293992f908ee39bf8104b1e9311c url=/mulesoft/current/en-us/dataweave/2.12/dw-strings-functions-unwrap.md -->

---
product: DataWeave
version: 2.12
---

# unwrap

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## unwrap(text: String, wrapper: String): String

Unwraps a given `text` from a `wrapper` text.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>wrapper</code></p></td><td><p>The text used to unwrap.</p></td></tr></tbody></table>

### Example

This example shows how `unwrap` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import unwrap from dw::core::Strings
output application/json
---
{
  "a": unwrap(null, ""),
  "b": unwrap(null, '\0'),
  "c": unwrap("'abc'", "'"),
  "d": unwrap("AABabcBAA", 'A'),
  "e": unwrap("A", '#'),
  "f": unwrap("#A", '#'),
  "g": unwrap("A#", '#')
}
```

#### Output

```JSON
{
   "a": null,
   "b": null,
   "c": "abc",
   "d": "ABabcBA",
   "e": "A",
   "f": "#A",
   "g": "A#"
 }
```

## unwrap(text: Null, wrapper: String): Null

Helper function that enables `unwrap` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=516f5d6f8c2166dc6869a8f1110f73970808eabd8bb782438fef0950c5f1f44c url=/mulesoft/current/en-us/dataweave/2.3/dw-strings-functions-unwrap.md -->

---
product: DataWeave
version: 2.3
---

# unwrap

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## unwrap(String, String): String

Unwraps a given `text` from a `wrapper` text.

_Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>wrapper</code></p></td><td><p>The text used to unwrap.</p></td></tr></tbody></table>

### Example

This example shows how `unwrap` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import unwrap from dw::core::Strings
output application/json
---
{
  "a": unwrap(null, ""),
  "b": unwrap(null, '\0'),
  "c": unwrap("'abc'", "'"),
  "d": unwrap("AABabcBAA", 'A'),
  "e": unwrap("A", '#'),
  "f": unwrap("#A", '#'),
  "g": unwrap("A#", '#')
}
```

#### Output

```JSON
{
  "a": null,
  "b": null,
  "c": "abc",
  "d": "ABabcBA",
  "e": "A",
  "f": "A#",
  "g": "#A"
}
```

## unwrap(Null, String): Null

Helper function that enables `unwrap` to work with a `null` value.

<!-- document id=d41d5f293c1c75af7b7bd55dd7788dde952abe8429deccb6677d9ab3bb86952f url=/mulesoft/current/en-us/dataweave/2.4/dw-strings-functions-unwrap.md -->

---
product: DataWeave
version: 2.4
---

# unwrap

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## unwrap(text: String, wrapper: String): String

Unwraps a given `text` from a `wrapper` text.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>wrapper</code></p></td><td><p>The text used to unwrap.</p></td></tr></tbody></table>

### Example

This example shows how `unwrap` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import unwrap from dw::core::Strings
output application/json
---
{
  "a": unwrap(null, ""),
  "b": unwrap(null, '\0'),
  "c": unwrap("'abc'", "'"),
  "d": unwrap("AABabcBAA", 'A'),
  "e": unwrap("A", '#'),
  "f": unwrap("#A", '#'),
  "g": unwrap("A#", '#')
}
```

#### Output

```JSON
{
  "a": null,
  "b": null,
  "c": "abc",
  "d": "ABabcBA",
  "e": "A",
  "f": "A#",
  "g": "#A"
}
```

## unwrap(text: Null, wrapper: String): Null

Helper function that enables `unwrap` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=6aeee710c5d5a814d33028df0be78bdbe043f10697b0cad1473f65fba5a1653e url=/mulesoft/current/en-us/dataweave/2.6/dw-strings-functions-unwrap.md -->

---
product: DataWeave
version: 2.6
---

# unwrap

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## unwrap(text: String, wrapper: String): String

Unwraps a given `text` from a `wrapper` text.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>wrapper</code></p></td><td><p>The text used to unwrap.</p></td></tr></tbody></table>

### Example

This example shows how `unwrap` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import unwrap from dw::core::Strings
output application/json
---
{
  "a": unwrap(null, ""),
  "b": unwrap(null, '\0'),
  "c": unwrap("'abc'", "'"),
  "d": unwrap("AABabcBAA", 'A'),
  "e": unwrap("A", '#'),
  "f": unwrap("#A", '#'),
  "g": unwrap("A#", '#')
}
```

#### Output

```JSON
{
   "a": null,
   "b": null,
   "c": "abc",
   "d": "ABabcBA",
   "e": "A",
   "f": "#A",
   "g": "A#"
 }
```

## unwrap(text: Null, wrapper: String): Null

Helper function that enables `unwrap` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=83c2d3cfe9ea30752f8573fad9f29d41c2b7cb94f989319ab3b9cd9264cbb1b6 url=/mulesoft/current/en-us/dataweave/2.9/dw-strings-functions-unwrap.md -->

---
product: DataWeave
version: 2.9
---

# unwrap

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## unwrap(text: String, wrapper: String): String

Unwraps a given `text` from a `wrapper` text.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>wrapper</code></p></td><td><p>The text used to unwrap.</p></td></tr></tbody></table>

### Example

This example shows how `unwrap` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import unwrap from dw::core::Strings
output application/json
---
{
  "a": unwrap(null, ""),
  "b": unwrap(null, '\0'),
  "c": unwrap("'abc'", "'"),
  "d": unwrap("AABabcBAA", 'A'),
  "e": unwrap("A", '#'),
  "f": unwrap("#A", '#'),
  "g": unwrap("A#", '#')
}
```

#### Output

```JSON
{
   "a": null,
   "b": null,
   "c": "abc",
   "d": "ABabcBA",
   "e": "A",
   "f": "#A",
   "g": "A#"
 }
```

## unwrap(text: Null, wrapper: String): Null

Helper function that enables `unwrap` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=76fe273f07a36c2af85297518ad5d7129b9778bc177bdd263e05cbaa2355b90f url=/mulesoft/current/en-us/dataweave/latest/dw-strings-functions-unwrap.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# unwrap

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## unwrap(text: String, wrapper: String): String

Unwraps a given `text` from a `wrapper` text.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>wrapper</code></p></td><td><p>The text used to unwrap.</p></td></tr></tbody></table>

### Example

This example shows how `unwrap` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import unwrap from dw::core::Strings
output application/json
---
{
  "a": unwrap(null, ""),
  "b": unwrap(null, '\0'),
  "c": unwrap("'abc'", "'"),
  "d": unwrap("AABabcBAA", 'A'),
  "e": unwrap("A", '#'),
  "f": unwrap("#A", '#'),
  "g": unwrap("A#", '#')
}
```

#### Output

```JSON
{
   "a": null,
   "b": null,
   "c": "abc",
   "d": "ABabcBA",
   "e": "A",
   "f": "#A",
   "g": "A#"
 }
```

## unwrap(text: Null, wrapper: String): Null

Helper function that enables `unwrap` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=cde014c98042545cb335e3b61de98d6148a4dacf73c8980e3db8a719bd20965e url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-unzip.md -->

---
product: DataWeave
version: 2.11
---

# unzip

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## unzip<T>(items: Array<Array<T>>): Array<Array<T>>

Performs the opposite of `zip`. It takes an array of arrays as input.

The function groups the values of the input sub-arrays by matching indices, and it outputs new
sub-arrays with the values of those matching indices. No sub-arrays are produced for unmatching
indices. For example, if one input sub-array contains four elements (indices 0-3) and another only
contains three (indices 0-2), the function will not produce a sub-array for the value at index 3.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The input array of arrays.</p></td></tr></tbody></table>

### Example

This example unzips an array of arrays. It outputs the first index of each sub-array into one array
`[ 0, 1, 2, 3 ]`, and the second index of each into another `[ "a", "b", "c", "d" ]`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
unzip([ [0,"a"], [1,"b"], [2,"c"],[ 3,"d"] ])
```

#### Output

```JSON
[ [ 0, 1, 2, 3 ], [ "a", "b", "c", "d" ] ]
```

### Example

This example unzips an array of arrays. Notice that the number of elements in the input arrays is
not all the same. The function creates only as many full sub-arrays as it can, in this case, just
one.

#### Source

```DataWeave
%dw 2.0
output application/json
---
unzip([ [0,"a"], [1,"a","foo"], [2], [3,"a"] ])
```

#### Output

```JSON
[0,1,2,3]
```

### Example

This example unzips an array of arrays where each input subarray contains more than two elements. It
shows that `unzip` can produce more than two output subarrays when there are additional values at
each index.

#### Source

```DataWeave
%dw 2.0
output application/json
---
unzip([ [0,"a","W"], [1,"b","X"], [2,"c","Y"], [3,"d","Z"] ])
```

#### Output

```JSON
[
 [0,1,2,3],
 ["a","b","c","d"],
 ["W","X","Y","Z"]
]
```

<!-- document id=ad388ceb2ce76d7226c7090155cc02118430d5c9a6490d403f026ff3eff9f9df url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-unzip.md -->

---
product: DataWeave
version: 2.12
---

# unzip

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## unzip<T>(items: Array<Array<T>>): Array<Array<T>>

Performs the opposite of `zip`. It takes an array of arrays as input.

The function groups the values of the input sub-arrays by matching indices, and it outputs new
sub-arrays with the values of those matching indices. No sub-arrays are produced for unmatching
indices. For example, if one input sub-array contains four elements (indices 0-3) and another only
contains three (indices 0-2), the function will not produce a sub-array for the value at index 3.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The input array of arrays.</p></td></tr></tbody></table>

### Example

This example unzips an array of arrays. It outputs the first index of each sub-array into one array
`[ 0, 1, 2, 3 ]`, and the second index of each into another `[ "a", "b", "c", "d" ]`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
unzip([ [0,"a"], [1,"b"], [2,"c"],[ 3,"d"] ])
```

#### Output

```JSON
[ [ 0, 1, 2, 3 ], [ "a", "b", "c", "d" ] ]
```

### Example

This example unzips an array of arrays. Notice that the number of elements in the input arrays is
not all the same. The function creates only as many full sub-arrays as it can, in this case, just
one.

#### Source

```DataWeave
%dw 2.0
output application/json
---
unzip([ [0,"a"], [1,"a","foo"], [2], [3,"a"] ])
```

#### Output

```JSON
[0,1,2,3]
```

### Example

This example unzips an array of arrays where each input subarray contains more than two elements. It
shows that `unzip` can produce more than two output subarrays when there are additional values at
each index.

#### Source

```DataWeave
%dw 2.0
output application/json
---
unzip([ [0,"a","W"], [1,"b","X"], [2,"c","Y"], [3,"d","Z"] ])
```

#### Output

```JSON
[
 [0,1,2,3],
 ["a","b","c","d"],
 ["W","X","Y","Z"]
]
```

<!-- document id=c29aace3bb90ad163f1f3f615e7a6acf640b400929bc7917e1f54b57d369d2e7 url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-unzip.md -->

---
product: DataWeave
version: 2.3
---

# unzip

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## unzip(Array<Array<T>>): Array<Array<T>>

Performs the opposite of `zip`. It takes an array of arrays as input.

The function groups the values of the input sub-arrays by matching indices, and it outputs new
sub-arrays with the values of those matching indices. No sub-arrays are produced for unmatching
indices. For example, if one input sub-array contains four elements (indices 0-3) and another only
contains three (indices 0-2), the function will not produce a sub-array for the value at index 3.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The input array of arrays.</p></td></tr></tbody></table>

### Example

This example unzips an array of arrays. It outputs the first index of each sub-array into one array
`[ 0, 1, 2, 3 ]`, and the second index of each into another `[ "a", "b", "c", "d" ]`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
unzip([ [0,"a"], [1,"b"], [2,"c"],[ 3,"d"] ])
```

#### Output

```JSON
[ [ 0, 1, 2, 3 ], [ "a", "b", "c", "d" ] ]
```

### Example

This example unzips an array of arrays. Notice that the number of elements in the input arrays is
not all the same. The function creates only as many full sub-arrays as it can, in this case, just
one.

#### Source

```DataWeave
%dw 2.0
output application/json
---
unzip([ [0,"a"], [1,"a","foo"], [2], [3,"a"] ])
```

#### Output

```JSON
[0,1,2,3]
```

<!-- document id=393969b8be8ca272cd53285b8154a51ba518e8e1fbb5a952386bdbee5e6b686a url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-unzip.md -->

---
product: DataWeave
version: 2.4
---

# unzip

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## unzip<T>(items: Array<Array<T>>): Array<Array<T>>

Performs the opposite of `zip`. It takes an array of arrays as input.

The function groups the values of the input sub-arrays by matching indices, and it outputs new
sub-arrays with the values of those matching indices. No sub-arrays are produced for unmatching
indices. For example, if one input sub-array contains four elements (indices 0-3) and another only
contains three (indices 0-2), the function will not produce a sub-array for the value at index 3.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The input array of arrays.</p></td></tr></tbody></table>

### Example

This example unzips an array of arrays. It outputs the first index of each sub-array into one array
`[ 0, 1, 2, 3 ]`, and the second index of each into another `[ "a", "b", "c", "d" ]`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
unzip([ [0,"a"], [1,"b"], [2,"c"],[ 3,"d"] ])
```

#### Output

```JSON
[ [ 0, 1, 2, 3 ], [ "a", "b", "c", "d" ] ]
```

### Example

This example unzips an array of arrays. Notice that the number of elements in the input arrays is
not all the same. The function creates only as many full sub-arrays as it can, in this case, just
one.

#### Source

```DataWeave
%dw 2.0
output application/json
---
unzip([ [0,"a"], [1,"a","foo"], [2], [3,"a"] ])
```

#### Output

```JSON
[0,1,2,3]
```

### Example

This example unzips an array of arrays where each input subarray contains more than two elements. It
shows that `unzip` can produce more than two output subarrays when there are additional values at
each index.

#### Source

```DataWeave
%dw 2.0
output application/json
---
unzip([ [0,"a","W"], [1,"b","X"], [2,"c","Y"], [3,"d","Z"] ])
```

#### Output

```JSON
[
 [0,1,2,3],
 ["a","b","c","d"],
 ["W","X","Y","Z"]
]
```

<!-- document id=b3262ab2b3a9486776706a50ea11aef5b090977cdfcd97126123e9a051fb2f8d url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-unzip.md -->

---
product: DataWeave
version: 2.6
---

# unzip

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## unzip<T>(items: Array<Array<T>>): Array<Array<T>>

Performs the opposite of `zip`. It takes an array of arrays as input.

The function groups the values of the input sub-arrays by matching indices, and it outputs new
sub-arrays with the values of those matching indices. No sub-arrays are produced for unmatching
indices. For example, if one input sub-array contains four elements (indices 0-3) and another only
contains three (indices 0-2), the function will not produce a sub-array for the value at index 3.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The input array of arrays.</p></td></tr></tbody></table>

### Example

This example unzips an array of arrays. It outputs the first index of each sub-array into one array
`[ 0, 1, 2, 3 ]`, and the second index of each into another `[ "a", "b", "c", "d" ]`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
unzip([ [0,"a"], [1,"b"], [2,"c"],[ 3,"d"] ])
```

#### Output

```JSON
[ [ 0, 1, 2, 3 ], [ "a", "b", "c", "d" ] ]
```

### Example

This example unzips an array of arrays. Notice that the number of elements in the input arrays is
not all the same. The function creates only as many full sub-arrays as it can, in this case, just
one.

#### Source

```DataWeave
%dw 2.0
output application/json
---
unzip([ [0,"a"], [1,"a","foo"], [2], [3,"a"] ])
```

#### Output

```JSON
[0,1,2,3]
```

### Example

This example unzips an array of arrays where each input subarray contains more than two elements. It
shows that `unzip` can produce more than two output subarrays when there are additional values at
each index.

#### Source

```DataWeave
%dw 2.0
output application/json
---
unzip([ [0,"a","W"], [1,"b","X"], [2,"c","Y"], [3,"d","Z"] ])
```

#### Output

```JSON
[
 [0,1,2,3],
 ["a","b","c","d"],
 ["W","X","Y","Z"]
]
```

<!-- document id=d98b3d21fd56cd8d70b897b6f99cba8e912a55b0275c93b4acf5b3cb5e974f07 url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-unzip.md -->

---
product: DataWeave
version: 2.9
---

# unzip

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## unzip<T>(items: Array<Array<T>>): Array<Array<T>>

Performs the opposite of `zip`. It takes an array of arrays as input.

The function groups the values of the input sub-arrays by matching indices, and it outputs new
sub-arrays with the values of those matching indices. No sub-arrays are produced for unmatching
indices. For example, if one input sub-array contains four elements (indices 0-3) and another only
contains three (indices 0-2), the function will not produce a sub-array for the value at index 3.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The input array of arrays.</p></td></tr></tbody></table>

### Example

This example unzips an array of arrays. It outputs the first index of each sub-array into one array
`[ 0, 1, 2, 3 ]`, and the second index of each into another `[ "a", "b", "c", "d" ]`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
unzip([ [0,"a"], [1,"b"], [2,"c"],[ 3,"d"] ])
```

#### Output

```JSON
[ [ 0, 1, 2, 3 ], [ "a", "b", "c", "d" ] ]
```

### Example

This example unzips an array of arrays. Notice that the number of elements in the input arrays is
not all the same. The function creates only as many full sub-arrays as it can, in this case, just
one.

#### Source

```DataWeave
%dw 2.0
output application/json
---
unzip([ [0,"a"], [1,"a","foo"], [2], [3,"a"] ])
```

#### Output

```JSON
[0,1,2,3]
```

### Example

This example unzips an array of arrays where each input subarray contains more than two elements. It
shows that `unzip` can produce more than two output subarrays when there are additional values at
each index.

#### Source

```DataWeave
%dw 2.0
output application/json
---
unzip([ [0,"a","W"], [1,"b","X"], [2,"c","Y"], [3,"d","Z"] ])
```

#### Output

```JSON
[
 [0,1,2,3],
 ["a","b","c","d"],
 ["W","X","Y","Z"]
]
```

<!-- document id=5d916a75c38d9f63218ff7103241104c5f4a9112be627f5d3a753b4362bc0ab2 url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-unzip.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# unzip

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## unzip<T>(items: Array<Array<T>>): Array<Array<T>>

Performs the opposite of `zip`. It takes an array of arrays as input.

The function groups the values of the input sub-arrays by matching indices, and it outputs new
sub-arrays with the values of those matching indices. No sub-arrays are produced for unmatching
indices. For example, if one input sub-array contains four elements (indices 0-3) and another only
contains three (indices 0-2), the function will not produce a sub-array for the value at index 3.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>items</code></p></td><td><p>The input array of arrays.</p></td></tr></tbody></table>

### Example

This example unzips an array of arrays. It outputs the first index of each sub-array into one array
`[ 0, 1, 2, 3 ]`, and the second index of each into another `[ "a", "b", "c", "d" ]`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
unzip([ [0,"a"], [1,"b"], [2,"c"],[ 3,"d"] ])
```

#### Output

```JSON
[ [ 0, 1, 2, 3 ], [ "a", "b", "c", "d" ] ]
```

### Example

This example unzips an array of arrays. Notice that the number of elements in the input arrays is
not all the same. The function creates only as many full sub-arrays as it can, in this case, just
one.

#### Source

```DataWeave
%dw 2.0
output application/json
---
unzip([ [0,"a"], [1,"a","foo"], [2], [3,"a"] ])
```

#### Output

```JSON
[0,1,2,3]
```

### Example

This example unzips an array of arrays where each input subarray contains more than two elements. It
shows that `unzip` can produce more than two output subarrays when there are additional values at
each index.

#### Source

```DataWeave
%dw 2.0
output application/json
---
unzip([ [0,"a","W"], [1,"b","X"], [2,"c","Y"], [3,"d","Z"] ])
```

#### Output

```JSON
[
 [0,1,2,3],
 ["a","b","c","d"],
 ["W","X","Y","Z"]
]
```

<!-- document id=6bb10214e501dd7affe4cb634b56f1d2be4e12eb543c949eb12ed3ff053aaf7e url=/mulesoft/current/en-us/dataweave/2.11/dw-values-functions-update.md -->

---
product: DataWeave
version: 2.11
---

# update

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## update(objectValue: Object, fieldName: String): UpdaterValueProvider<Object>

This `update` function updates a field in an object with the specified string value.

The function returns a new object with the specified field and value.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>objectValue</code></p></td><td><p>The object to update.</p></td></tr><tr><td><p><code>fieldName</code></p></td><td><p>A string that provides the name of the field.</p></td></tr></tbody></table>

### Example

This example updates the `name` field in the object `{name: "Mariano"}` with the specified value.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Values
output application/json
---
{name: "Mariano"} update "name" with "Data Weave"
```

#### Output

```Json
{
  "name": "Data Weave"
}
```

## update(objectValue: Object, fieldName: PathElement): UpdaterValueProvider<Object>

This `update` function updates an object field with the specified `PathElement` value.

The function returns a new object with the specified field and value.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>objectValue</code></p></td><td><p>The object to update.</p></td></tr><tr><td><p><code>fieldName</code></p></td><td><p>A <code>PathElement</code> that specifies the field name.</p></td></tr></tbody></table>

### Example

This example updates the value of a `name` field in the object `{name: "Mariano"}`. It uses
`field("name")` to return the `PathElement` that it passes to `update`. It uses `with "Data Weave"`
to specify the value (`Data Weave`) of `name`.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Values
output application/json
---
{name: "Mariano"} update field("name") with "Data Weave"
```

#### Output

```Json
{
  "name": "Data Weave"
}
```

## update(arrayValue: Array, indexToUpdate: Number): UpdaterValueProvider<Array>

Updates an array index with the specified value.

This `update` function returns a new array that changes the value of the specified index.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>objectValue</code></p></td><td><p>The array to update.</p></td></tr><tr><td><p><code>indexToUpdate</code></p></td><td><p>The index of the array to update. The index must be a number.</p></td></tr></tbody></table>

### Example

This example replaces the value `2` (the index is `1`) with `5` in the the input array `[1,2,3]`.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Values
output application/json
---
[1,2,3] update 1 with 5
```

#### Output

```Json
[
   1,
   5,
   3
 ]
```

## update(arrayValue: Array, indexToUpdate: String): UpdaterValueProvider<Array>

This `update` function updates all objects within the specified array with the given string value.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>objectValue</code></p></td><td><p>The array of objects to update.</p></td></tr><tr><td><p><code>indexToUpdate</code></p></td><td><p>A string providing the name of the field to update.</p></td></tr></tbody></table>

### Example

This example updates value of the `role` fields in the array of objects.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Values
output application/json
---
[{role: "a", name: "spiderman"}, {role: "b", name: "batman"}] update "role" with "Super Hero"
```

#### Output

```Json
[{
   "role": "Super Hero",
   "name": "spiderman"
 },
 {
   "role": "Super Hero",
   "name": "batman"
}]
```

## update(arrayValue: Array, indexToUpdate: PathElement): UpdaterValueProvider<Array>

This `update` function updates the specified index of an array with the given `PathElement` value.

The function returns a new array that contains given value at the specified index.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>objectValue</code></p></td><td><p>The array to update.</p></td></tr><tr><td><p><code>indexToUpdate</code></p></td><td><p>The index of the array to update. The index must be specified as a <code>PathElement</code>.</p></td></tr></tbody></table>

### Example

This example updates the value of an element in the input array. Notice that it uses `index(1)` to
return the index as a `PathElement`, which it passes to `update`. It replaces the value `2` at that
index with `5`.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Values
output application/json
---
[1,2,3] update index(1) with 5
```

#### Output

```Json
[
   1,
   5,
   3
 ]
```

## update(value: Array | Object | Null, path: Array<String | Number | PathElement>): UpdaterValueProvider<Array | Object | Null>

Updates the value at the specified path with the given value.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>objectValue</code></p></td><td><p>The value to update. Accepts an array, object, or null value.</p></td></tr><tr><td><p><code>path</code></p></td><td><p>The path to update. The path must be an array of strings, numbers, or `PathElement`s.</p></td></tr></tbody></table>

### Example

This example updates the name of the user.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Values
output application/json
---
{user: {name: "Mariano"}} update ["user", field("name")] with "Data Weave"
```

#### Output

```Json
{
   "user": {
     "name": "Data Weave"
   }
 }
```

### Example

This example updates one of the recurring fields.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Values
output application/xml
---
payload update ["users", "user", "language"] with (if ($ == "English") "Gibberish" else $)
```

#### Input

```XML
<users>
  <user>
    <name>Phoebe</name>
    <language>French</language>
  </user>
  <user>
    <name>Joey</name>
    <language>English</language>
  </user>
</users>
```

#### Output

```XML
<users>
  <user>
    <name>Phoebe</name>
    <language>French</language>
  </user>
  <user>
    <name>Joey</name>
    <language>Gibberish</language>
  </user>
</users>
```

## update(value: Null, toUpdate: Number | String | PathElement): UpdaterValueProvider<Null>

Helper function that enables `update` to work with a `null` value.

_Introduced in DataWeave version 2.2.2._

<!-- document id=bd40cd12b81dcd62a9400fbe396ac26fda9276502ba912836d154c4c2e331bf5 url=/mulesoft/current/en-us/dataweave/2.12/dw-values-functions-update.md -->

---
product: DataWeave
version: 2.12
---

# update

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## update(objectValue: Object, fieldName: String): UpdaterValueProvider<Object>

This `update` function updates a field in an object with the specified string value.

The function returns a new object with the specified field and value.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>objectValue</code></p></td><td><p>The object to update.</p></td></tr><tr><td><p><code>fieldName</code></p></td><td><p>A string that provides the name of the field.</p></td></tr></tbody></table>

### Example

This example updates the `name` field in the object `{name: "Mariano"}` with the specified value.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Values
output application/json
---
{name: "Mariano"} update "name" with "Data Weave"
```

#### Output

```Json
{
  "name": "Data Weave"
}
```

## update(objectValue: Object, fieldName: PathElement): UpdaterValueProvider<Object>

This `update` function updates an object field with the specified `PathElement` value.

The function returns a new object with the specified field and value.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>objectValue</code></p></td><td><p>The object to update.</p></td></tr><tr><td><p><code>fieldName</code></p></td><td><p>A <code>PathElement</code> that specifies the field name.</p></td></tr></tbody></table>

### Example

This example updates the value of a `name` field in the object `{name: "Mariano"}`. It uses
`field("name")` to return the `PathElement` that it passes to `update`. It uses `with "Data Weave"`
to specify the value (`Data Weave`) of `name`.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Values
output application/json
---
{name: "Mariano"} update field("name") with "Data Weave"
```

#### Output

```Json
{
  "name": "Data Weave"
}
```

## update(arrayValue: Array, indexToUpdate: Number): UpdaterValueProvider<Array>

Updates an array index with the specified value.

This `update` function returns a new array that changes the value of the specified index.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>objectValue</code></p></td><td><p>The array to update.</p></td></tr><tr><td><p><code>indexToUpdate</code></p></td><td><p>The index of the array to update. The index must be a number.</p></td></tr></tbody></table>

### Example

This example replaces the value `2` (the index is `1`) with `5` in the the input array `[1,2,3]`.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Values
output application/json
---
[1,2,3] update 1 with 5
```

#### Output

```Json
[
   1,
   5,
   3
 ]
```

## update(arrayValue: Array, indexToUpdate: String): UpdaterValueProvider<Array>

This `update` function updates all objects within the specified array with the given string value.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>objectValue</code></p></td><td><p>The array of objects to update.</p></td></tr><tr><td><p><code>indexToUpdate</code></p></td><td><p>A string providing the name of the field to update.</p></td></tr></tbody></table>

### Example

This example updates value of the `role` fields in the array of objects.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Values
output application/json
---
[{role: "a", name: "spiderman"}, {role: "b", name: "batman"}] update "role" with "Super Hero"
```

#### Output

```Json
[{
   "role": "Super Hero",
   "name": "spiderman"
 },
 {
   "role": "Super Hero",
   "name": "batman"
}]
```

## update(arrayValue: Array, indexToUpdate: PathElement): UpdaterValueProvider<Array>

This `update` function updates the specified index of an array with the given `PathElement` value.

The function returns a new array that contains given value at the specified index.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>objectValue</code></p></td><td><p>The array to update.</p></td></tr><tr><td><p><code>indexToUpdate</code></p></td><td><p>The index of the array to update. The index must be specified as a <code>PathElement</code>.</p></td></tr></tbody></table>

### Example

This example updates the value of an element in the input array. Notice that it uses `index(1)` to
return the index as a `PathElement`, which it passes to `update`. It replaces the value `2` at that
index with `5`.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Values
output application/json
---
[1,2,3] update index(1) with 5
```

#### Output

```Json
[
   1,
   5,
   3
 ]
```

## update(value: Array | Object | Null, path: Array<String | Number | PathElement>): UpdaterValueProvider<Array | Object | Null>

Updates the value at the specified path with the given value.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>objectValue</code></p></td><td><p>The value to update. Accepts an array, object, or null value.</p></td></tr><tr><td><p><code>path</code></p></td><td><p>The path to update. The path must be an array of strings, numbers, or `PathElement`s.</p></td></tr></tbody></table>

### Example

This example updates the name of the user.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Values
output application/json
---
{user: {name: "Mariano"}} update ["user", field("name")] with "Data Weave"
```

#### Output

```Json
{
   "user": {
     "name": "Data Weave"
   }
 }
```

### Example

This example updates one of the recurring fields.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Values
output application/xml
---
payload update ["users", "user", "language"] with (if ($ == "English") "Gibberish" else $)
```

#### Input

```XML
<users>
  <user>
    <name>Phoebe</name>
    <language>French</language>
  </user>
  <user>
    <name>Joey</name>
    <language>English</language>
  </user>
</users>
```

#### Output

```XML
<users>
  <user>
    <name>Phoebe</name>
    <language>French</language>
  </user>
  <user>
    <name>Joey</name>
    <language>Gibberish</language>
  </user>
</users>
```

## update(value: Null, toUpdate: Number | String | PathElement): UpdaterValueProvider<Null>

Helper function that enables `update` to work with a `null` value.

_Introduced in DataWeave version 2.2.2._

<!-- document id=c23374960801371b22e9ae7d34e5b3abe90c3731a7203a14630e46d2c31e1d34 url=/mulesoft/current/en-us/dataweave/2.3/dw-values-functions-update.md -->

---
product: DataWeave
version: 2.3
---

# update

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## update(Object, String): Any

This `update` function updates a field in an object with the specified string value.

The function returns a new object with the specified field and value.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>objectValue</code></p></td><td><p>The object to update.</p></td></tr><tr><td><p><code>fieldName</code></p></td><td><p>A string that provides the name of the field.</p></td></tr></tbody></table>

### Example

This example updates the `name` field in the object `{name: "Mariano"}` with the specified value.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Values
output application/json
---
{name: "Mariano"} update "name" with "Data Weave"
```

#### Output

```Json
{
  "name": "Data Weave"
}
```

## update(Object, PathElement): Any

This `update` function updates an object field with the specified `PathElement` value.

The function returns a new object with the specified field and value.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>objectValue</code></p></td><td><p>The object to update.</p></td></tr><tr><td><p><code>fieldName</code></p></td><td><p>A <code>PathElement</code> that specifies the field name.</p></td></tr></tbody></table>

### Example

This example updates the value of a `name` field in the object `{name: "Mariano"}`. It uses
`field("name")` to return the `PathElement` that it passes to `update`. It uses `with "Data Weave"`
to specify the value (`Data Weave`) of `name`.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Values
output application/json
---
{name: "Mariano"} update field("name") with "Data Weave"
```

#### Output

```Json
{
  "name": "Data Weave"
}
```

## update(Array, Number): Any

Updates an array index with the specified value.

This `update` function returns a new array that changes the value of the specified index.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p>objectValue</p></td><td><p>The array to update.</p></td></tr><tr><td><p>indexToUpdate</p></td><td><p>The index of the array to update. The index must be a number.</p></td></tr></tbody></table>

### Example

This example replaces the value `2` (the index is `1`) with `5` in the the input array `[1,2,3]`.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Values
output application/json
---
[1,2,3] update 1 with 5
```

#### Output

```Json
[
   1,
   5,
   3
 ]
```

## update(Array, String): Any

This `update` function updates all objects within the specified array with the given string value.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>objectValue</code></p></td><td><p>The array of objects to update.</p></td></tr><tr><td><p><code>indexToUpdate</code></p></td><td><p>A string providing the name of the field to update.</p></td></tr></tbody></table>

### Example

This example updates value of the `role` fields in the array of objects.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Values
output application/json
---
[{role: "a", name: "spiderman"}, {role: "b", name: "batman"}] update "role" with "Super Hero"
```

#### Output

```Json
[{
   "role": "Super Hero",
   "name": "spiderman"
 },
 {
   "role": "Super Hero",
   "name": "batman"
}]
```

## update(Array, PathElement): Any

This `update` function updates the specified index of an array with the given `PathElement` value.

The function returns a new array that contains given value at the specified index.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>objectValue</code></p></td><td><p>The array to update.</p></td></tr><tr><td><p><code>indexToUpdate</code></p></td><td><p>The index of the array to update. The index must be specified as a <code>PathElement</code>.</p></td></tr></tbody></table>

### Example

This example updates the value of an element in the input array. Notice that it uses `index(1)` to
return the index as a `PathElement`, which it passes to `update`. It replaces the value `2` at that
index with `5`.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Values
output application/json
---
[1,2,3] update index(1) with 5
```

#### Output

```Json
[
   1,
   5,
   3
 ]
```

## update(Array | Object | Null, Array<String | Number | PathElement>): Any

Updates the value at the specified path with the given value.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>objectValue</code></p></td><td><p>The value to update. Accepts an array, object, or null value.</p></td></tr><tr><td><p><code>path</code></p></td><td><p>The path to update. The path must be an array of strings, numbers, or `PathElement`s.</p></td></tr></tbody></table>

### Example

This example updates the name of the user.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Values
output application/json
---
{user: {name: "Mariano"}} update ["user", field("name")] with "Data Weave"
```

#### Output

```Json
{
   "user": {
     "name": "Data Weave"
   }
 }
```

## update(Null, Number | String | PathElement): Any

Helper function that enables `update` to work with a `null` value.

<!-- document id=e010f80b277ae43ac7b2d8772a2f45fa38ae3dfa23bee067338c955951df6e01 url=/mulesoft/current/en-us/dataweave/2.4/dw-values-functions-update.md -->

---
product: DataWeave
version: 2.4
---

# update

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## update(objectValue: Object, fieldName: String): UpdaterValueProvider<Object>

This `update` function updates a field in an object with the specified string value.

The function returns a new object with the specified field and value.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>objectValue</code></p></td><td><p>The object to update.</p></td></tr><tr><td><p><code>fieldName</code></p></td><td><p>A string that provides the name of the field.</p></td></tr></tbody></table>

### Example

This example updates the `name` field in the object `{name: "Mariano"}` with the specified value.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Values
output application/json
---
{name: "Mariano"} update "name" with "Data Weave"
```

#### Output

```Json
{
  "name": "Data Weave"
}
```

## update(objectValue: Object, fieldName: PathElement): UpdaterValueProvider<Object>

This `update` function updates an object field with the specified `PathElement` value.

The function returns a new object with the specified field and value.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>objectValue</code></p></td><td><p>The object to update.</p></td></tr><tr><td><p><code>fieldName</code></p></td><td><p>A <code>PathElement</code> that specifies the field name.</p></td></tr></tbody></table>

### Example

This example updates the value of a `name` field in the object `{name: "Mariano"}`. It uses
`field("name")` to return the `PathElement` that it passes to `update`. It uses `with "Data Weave"`
to specify the value (`Data Weave`) of `name`.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Values
output application/json
---
{name: "Mariano"} update field("name") with "Data Weave"
```

#### Output

```Json
{
  "name": "Data Weave"
}
```

## update(arrayValue: Array, indexToUpdate: Number): UpdaterValueProvider<Array>

Updates an array index with the specified value.

This `update` function returns a new array that changes the value of the specified index.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>objectValue</code></p></td><td><p>The array to update.</p></td></tr><tr><td><p><code>indexToUpdate</code></p></td><td><p>The index of the array to update. The index must be a number.</p></td></tr></tbody></table>

### Example

This example replaces the value `2` (the index is `1`) with `5` in the the input array `[1,2,3]`.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Values
output application/json
---
[1,2,3] update 1 with 5
```

#### Output

```Json
[
   1,
   5,
   3
 ]
```

## update(arrayValue: Array, indexToUpdate: String): UpdaterValueProvider<Array>

This `update` function updates all objects within the specified array with the given string value.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>objectValue</code></p></td><td><p>The array of objects to update.</p></td></tr><tr><td><p><code>indexToUpdate</code></p></td><td><p>A string providing the name of the field to update.</p></td></tr></tbody></table>

### Example

This example updates value of the `role` fields in the array of objects.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Values
output application/json
---
[{role: "a", name: "spiderman"}, {role: "b", name: "batman"}] update "role" with "Super Hero"
```

#### Output

```Json
[{
   "role": "Super Hero",
   "name": "spiderman"
 },
 {
   "role": "Super Hero",
   "name": "batman"
}]
```

## update(arrayValue: Array, indexToUpdate: PathElement): UpdaterValueProvider<Array>

This `update` function updates the specified index of an array with the given `PathElement` value.

The function returns a new array that contains given value at the specified index.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>objectValue</code></p></td><td><p>The array to update.</p></td></tr><tr><td><p><code>indexToUpdate</code></p></td><td><p>The index of the array to update. The index must be specified as a <code>PathElement</code>.</p></td></tr></tbody></table>

### Example

This example updates the value of an element in the input array. Notice that it uses `index(1)` to
return the index as a `PathElement`, which it passes to `update`. It replaces the value `2` at that
index with `5`.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Values
output application/json
---
[1,2,3] update index(1) with 5
```

#### Output

```Json
[
   1,
   5,
   3
 ]
```

## update(value: Array | Object | Null, path: Array<String | Number | PathElement>): UpdaterValueProvider<Array | Object | Null>

Updates the value at the specified path with the given value.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>objectValue</code></p></td><td><p>The value to update. Accepts an array, object, or null value.</p></td></tr><tr><td><p><code>path</code></p></td><td><p>The path to update. The path must be an array of strings, numbers, or `PathElement`s.</p></td></tr></tbody></table>

### Example

This example updates the name of the user.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Values
output application/json
---
{user: {name: "Mariano"}} update ["user", field("name")] with "Data Weave"
```

#### Output

```Json
{
   "user": {
     "name": "Data Weave"
   }
 }
```

### Example

This example updates one of the recurring fields.

#### Input

```XML
<users>
  <user>
    <name>Phoebe</name>
    <language>French</language>
  </user>
  <user>
    <name>Joey</name>
    <language>English</language>
  </user>
</users>
```

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Values
output application/xml
---
payload update ["users", "user", "language"] with (if ($ == "English") "Gibberish" else $)
```

#### Output

```XML
<users>
  <user>
    <name>Phoebe</name>
    <language>French</language>
  </user>
  <user>
    <name>Joey</name>
    <language>Gibberish</language>
  </user>
</users>
```

## update(value: Null, toUpdate: Number | String | PathElement): UpdaterValueProvider<Null>

Helper function that enables `update` to work with a `null` value.

_Introduced in DataWeave version 2.2.2._

<!-- document id=077e172d693924890fd44cfcaf62db3925a6ca771f46ab6d9c06533dc8cbfd95 url=/mulesoft/current/en-us/dataweave/2.6/dw-values-functions-update.md -->

---
product: DataWeave
version: 2.6
---

# update

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## update(objectValue: Object, fieldName: String): UpdaterValueProvider<Object>

This `update` function updates a field in an object with the specified string value.

The function returns a new object with the specified field and value.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>objectValue</code></p></td><td><p>The object to update.</p></td></tr><tr><td><p><code>fieldName</code></p></td><td><p>A string that provides the name of the field.</p></td></tr></tbody></table>

### Example

This example updates the `name` field in the object `{name: "Mariano"}` with the specified value.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Values
output application/json
---
{name: "Mariano"} update "name" with "Data Weave"
```

#### Output

```Json
{
  "name": "Data Weave"
}
```

## update(objectValue: Object, fieldName: PathElement): UpdaterValueProvider<Object>

This `update` function updates an object field with the specified `PathElement` value.

The function returns a new object with the specified field and value.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>objectValue</code></p></td><td><p>The object to update.</p></td></tr><tr><td><p><code>fieldName</code></p></td><td><p>A <code>PathElement</code> that specifies the field name.</p></td></tr></tbody></table>

### Example

This example updates the value of a `name` field in the object `{name: "Mariano"}`. It uses
`field("name")` to return the `PathElement` that it passes to `update`. It uses `with "Data Weave"`
to specify the value (`Data Weave`) of `name`.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Values
output application/json
---
{name: "Mariano"} update field("name") with "Data Weave"
```

#### Output

```Json
{
  "name": "Data Weave"
}
```

## update(arrayValue: Array, indexToUpdate: Number): UpdaterValueProvider<Array>

Updates an array index with the specified value.

This `update` function returns a new array that changes the value of the specified index.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>objectValue</code></p></td><td><p>The array to update.</p></td></tr><tr><td><p><code>indexToUpdate</code></p></td><td><p>The index of the array to update. The index must be a number.</p></td></tr></tbody></table>

### Example

This example replaces the value `2` (the index is `1`) with `5` in the the input array `[1,2,3]`.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Values
output application/json
---
[1,2,3] update 1 with 5
```

#### Output

```Json
[
   1,
   5,
   3
 ]
```

## update(arrayValue: Array, indexToUpdate: String): UpdaterValueProvider<Array>

This `update` function updates all objects within the specified array with the given string value.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>objectValue</code></p></td><td><p>The array of objects to update.</p></td></tr><tr><td><p><code>indexToUpdate</code></p></td><td><p>A string providing the name of the field to update.</p></td></tr></tbody></table>

### Example

This example updates value of the `role` fields in the array of objects.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Values
output application/json
---
[{role: "a", name: "spiderman"}, {role: "b", name: "batman"}] update "role" with "Super Hero"
```

#### Output

```Json
[{
   "role": "Super Hero",
   "name": "spiderman"
 },
 {
   "role": "Super Hero",
   "name": "batman"
}]
```

## update(arrayValue: Array, indexToUpdate: PathElement): UpdaterValueProvider<Array>

This `update` function updates the specified index of an array with the given `PathElement` value.

The function returns a new array that contains given value at the specified index.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>objectValue</code></p></td><td><p>The array to update.</p></td></tr><tr><td><p><code>indexToUpdate</code></p></td><td><p>The index of the array to update. The index must be specified as a <code>PathElement</code>.</p></td></tr></tbody></table>

### Example

This example updates the value of an element in the input array. Notice that it uses `index(1)` to
return the index as a `PathElement`, which it passes to `update`. It replaces the value `2` at that
index with `5`.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Values
output application/json
---
[1,2,3] update index(1) with 5
```

#### Output

```Json
[
   1,
   5,
   3
 ]
```

## update(value: Array | Object | Null, path: Array<String | Number | PathElement>): UpdaterValueProvider<Array | Object | Null>

Updates the value at the specified path with the given value.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>objectValue</code></p></td><td><p>The value to update. Accepts an array, object, or null value.</p></td></tr><tr><td><p><code>path</code></p></td><td><p>The path to update. The path must be an array of strings, numbers, or `PathElement`s.</p></td></tr></tbody></table>

### Example

This example updates the name of the user.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Values
output application/json
---
{user: {name: "Mariano"}} update ["user", field("name")] with "Data Weave"
```

#### Output

```Json
{
   "user": {
     "name": "Data Weave"
   }
 }
```

### Example

This example updates one of the recurring fields.

#### Input

```XML
<users>
  <user>
    <name>Phoebe</name>
    <language>French</language>
  </user>
  <user>
    <name>Joey</name>
    <language>English</language>
  </user>
</users>
```

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Values
output application/xml
---
payload update ["users", "user", "language"] with (if ($ == "English") "Gibberish" else $)
```

#### Output

```XML
<users>
  <user>
    <name>Phoebe</name>
    <language>French</language>
  </user>
  <user>
    <name>Joey</name>
    <language>Gibberish</language>
  </user>
</users>
```

## update(value: Null, toUpdate: Number | String | PathElement): UpdaterValueProvider<Null>

Helper function that enables `update` to work with a `null` value.

_Introduced in DataWeave version 2.2.2._

<!-- document id=ab3cf562157b449eea88bdb856c4ebfeff6936ed8155a3551400c21bb7a45b82 url=/mulesoft/current/en-us/dataweave/2.9/dw-values-functions-update.md -->

---
product: DataWeave
version: 2.9
---

# update

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## update(objectValue: Object, fieldName: String): UpdaterValueProvider<Object>

This `update` function updates a field in an object with the specified string value.

The function returns a new object with the specified field and value.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>objectValue</code></p></td><td><p>The object to update.</p></td></tr><tr><td><p><code>fieldName</code></p></td><td><p>A string that provides the name of the field.</p></td></tr></tbody></table>

### Example

This example updates the `name` field in the object `{name: "Mariano"}` with the specified value.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Values
output application/json
---
{name: "Mariano"} update "name" with "Data Weave"
```

#### Output

```Json
{
  "name": "Data Weave"
}
```

## update(objectValue: Object, fieldName: PathElement): UpdaterValueProvider<Object>

This `update` function updates an object field with the specified `PathElement` value.

The function returns a new object with the specified field and value.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>objectValue</code></p></td><td><p>The object to update.</p></td></tr><tr><td><p><code>fieldName</code></p></td><td><p>A <code>PathElement</code> that specifies the field name.</p></td></tr></tbody></table>

### Example

This example updates the value of a `name` field in the object `{name: "Mariano"}`. It uses
`field("name")` to return the `PathElement` that it passes to `update`. It uses `with "Data Weave"`
to specify the value (`Data Weave`) of `name`.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Values
output application/json
---
{name: "Mariano"} update field("name") with "Data Weave"
```

#### Output

```Json
{
  "name": "Data Weave"
}
```

## update(arrayValue: Array, indexToUpdate: Number): UpdaterValueProvider<Array>

Updates an array index with the specified value.

This `update` function returns a new array that changes the value of the specified index.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>objectValue</code></p></td><td><p>The array to update.</p></td></tr><tr><td><p><code>indexToUpdate</code></p></td><td><p>The index of the array to update. The index must be a number.</p></td></tr></tbody></table>

### Example

This example replaces the value `2` (the index is `1`) with `5` in the the input array `[1,2,3]`.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Values
output application/json
---
[1,2,3] update 1 with 5
```

#### Output

```Json
[
   1,
   5,
   3
 ]
```

## update(arrayValue: Array, indexToUpdate: String): UpdaterValueProvider<Array>

This `update` function updates all objects within the specified array with the given string value.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>objectValue</code></p></td><td><p>The array of objects to update.</p></td></tr><tr><td><p><code>indexToUpdate</code></p></td><td><p>A string providing the name of the field to update.</p></td></tr></tbody></table>

### Example

This example updates value of the `role` fields in the array of objects.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Values
output application/json
---
[{role: "a", name: "spiderman"}, {role: "b", name: "batman"}] update "role" with "Super Hero"
```

#### Output

```Json
[{
   "role": "Super Hero",
   "name": "spiderman"
 },
 {
   "role": "Super Hero",
   "name": "batman"
}]
```

## update(arrayValue: Array, indexToUpdate: PathElement): UpdaterValueProvider<Array>

This `update` function updates the specified index of an array with the given `PathElement` value.

The function returns a new array that contains given value at the specified index.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>objectValue</code></p></td><td><p>The array to update.</p></td></tr><tr><td><p><code>indexToUpdate</code></p></td><td><p>The index of the array to update. The index must be specified as a <code>PathElement</code>.</p></td></tr></tbody></table>

### Example

This example updates the value of an element in the input array. Notice that it uses `index(1)` to
return the index as a `PathElement`, which it passes to `update`. It replaces the value `2` at that
index with `5`.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Values
output application/json
---
[1,2,3] update index(1) with 5
```

#### Output

```Json
[
   1,
   5,
   3
 ]
```

## update(value: Array | Object | Null, path: Array<String | Number | PathElement>): UpdaterValueProvider<Array | Object | Null>

Updates the value at the specified path with the given value.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>objectValue</code></p></td><td><p>The value to update. Accepts an array, object, or null value.</p></td></tr><tr><td><p><code>path</code></p></td><td><p>The path to update. The path must be an array of strings, numbers, or `PathElement`s.</p></td></tr></tbody></table>

### Example

This example updates the name of the user.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Values
output application/json
---
{user: {name: "Mariano"}} update ["user", field("name")] with "Data Weave"
```

#### Output

```Json
{
   "user": {
     "name": "Data Weave"
   }
 }
```

### Example

This example updates one of the recurring fields.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Values
output application/xml
---
payload update ["users", "user", "language"] with (if ($ == "English") "Gibberish" else $)
```

#### Input

```XML
<users>
  <user>
    <name>Phoebe</name>
    <language>French</language>
  </user>
  <user>
    <name>Joey</name>
    <language>English</language>
  </user>
</users>
```

#### Output

```XML
<users>
  <user>
    <name>Phoebe</name>
    <language>French</language>
  </user>
  <user>
    <name>Joey</name>
    <language>Gibberish</language>
  </user>
</users>
```

## update(value: Null, toUpdate: Number | String | PathElement): UpdaterValueProvider<Null>

Helper function that enables `update` to work with a `null` value.

_Introduced in DataWeave version 2.2.2._

<!-- document id=d7382d54e4d5d5b6f3d27c14c3cc913bc36c793979ac22bcb7ac5f7fe06fc3ec url=/mulesoft/current/en-us/dataweave/latest/dw-values-functions-update.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# update

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## update(objectValue: Object, fieldName: String): UpdaterValueProvider<Object>

This `update` function updates a field in an object with the specified string value.

The function returns a new object with the specified field and value.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>objectValue</code></p></td><td><p>The object to update.</p></td></tr><tr><td><p><code>fieldName</code></p></td><td><p>A string that provides the name of the field.</p></td></tr></tbody></table>

### Example

This example updates the `name` field in the object `{name: "Mariano"}` with the specified value.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Values
output application/json
---
{name: "Mariano"} update "name" with "Data Weave"
```

#### Output

```Json
{
  "name": "Data Weave"
}
```

## update(objectValue: Object, fieldName: PathElement): UpdaterValueProvider<Object>

This `update` function updates an object field with the specified `PathElement` value.

The function returns a new object with the specified field and value.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>objectValue</code></p></td><td><p>The object to update.</p></td></tr><tr><td><p><code>fieldName</code></p></td><td><p>A <code>PathElement</code> that specifies the field name.</p></td></tr></tbody></table>

### Example

This example updates the value of a `name` field in the object `{name: "Mariano"}`. It uses
`field("name")` to return the `PathElement` that it passes to `update`. It uses `with "Data Weave"`
to specify the value (`Data Weave`) of `name`.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Values
output application/json
---
{name: "Mariano"} update field("name") with "Data Weave"
```

#### Output

```Json
{
  "name": "Data Weave"
}
```

## update(arrayValue: Array, indexToUpdate: Number): UpdaterValueProvider<Array>

Updates an array index with the specified value.

This `update` function returns a new array that changes the value of the specified index.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>objectValue</code></p></td><td><p>The array to update.</p></td></tr><tr><td><p><code>indexToUpdate</code></p></td><td><p>The index of the array to update. The index must be a number.</p></td></tr></tbody></table>

### Example

This example replaces the value `2` (the index is `1`) with `5` in the the input array `[1,2,3]`.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Values
output application/json
---
[1,2,3] update 1 with 5
```

#### Output

```Json
[
   1,
   5,
   3
 ]
```

## update(arrayValue: Array, indexToUpdate: String): UpdaterValueProvider<Array>

This `update` function updates all objects within the specified array with the given string value.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>objectValue</code></p></td><td><p>The array of objects to update.</p></td></tr><tr><td><p><code>indexToUpdate</code></p></td><td><p>A string providing the name of the field to update.</p></td></tr></tbody></table>

### Example

This example updates value of the `role` fields in the array of objects.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Values
output application/json
---
[{role: "a", name: "spiderman"}, {role: "b", name: "batman"}] update "role" with "Super Hero"
```

#### Output

```Json
[{
   "role": "Super Hero",
   "name": "spiderman"
 },
 {
   "role": "Super Hero",
   "name": "batman"
}]
```

## update(arrayValue: Array, indexToUpdate: PathElement): UpdaterValueProvider<Array>

This `update` function updates the specified index of an array with the given `PathElement` value.

The function returns a new array that contains given value at the specified index.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>objectValue</code></p></td><td><p>The array to update.</p></td></tr><tr><td><p><code>indexToUpdate</code></p></td><td><p>The index of the array to update. The index must be specified as a <code>PathElement</code>.</p></td></tr></tbody></table>

### Example

This example updates the value of an element in the input array. Notice that it uses `index(1)` to
return the index as a `PathElement`, which it passes to `update`. It replaces the value `2` at that
index with `5`.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Values
output application/json
---
[1,2,3] update index(1) with 5
```

#### Output

```Json
[
   1,
   5,
   3
 ]
```

## update(value: Array | Object | Null, path: Array<String | Number | PathElement>): UpdaterValueProvider<Array | Object | Null>

Updates the value at the specified path with the given value.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>objectValue</code></p></td><td><p>The value to update. Accepts an array, object, or null value.</p></td></tr><tr><td><p><code>path</code></p></td><td><p>The path to update. The path must be an array of strings, numbers, or `PathElement`s.</p></td></tr></tbody></table>

### Example

This example updates the name of the user.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Values
output application/json
---
{user: {name: "Mariano"}} update ["user", field("name")] with "Data Weave"
```

#### Output

```Json
{
   "user": {
     "name": "Data Weave"
   }
 }
```

### Example

This example updates one of the recurring fields.

#### Source

```DataWeave
%dw 2.0
import * from dw::util::Values
output application/xml
---
payload update ["users", "user", "language"] with (if ($ == "English") "Gibberish" else $)
```

#### Input

```XML
<users>
  <user>
    <name>Phoebe</name>
    <language>French</language>
  </user>
  <user>
    <name>Joey</name>
    <language>English</language>
  </user>
</users>
```

#### Output

```XML
<users>
  <user>
    <name>Phoebe</name>
    <language>French</language>
  </user>
  <user>
    <name>Joey</name>
    <language>Gibberish</language>
  </user>
</users>
```

## update(value: Null, toUpdate: Number | String | PathElement): UpdaterValueProvider<Null>

Helper function that enables `update` to work with a `null` value.

_Introduced in DataWeave version 2.2.2._

<!-- document id=a716c2228c20c1ebaa26886c0a1ef0c5c8867ef172fc08f3a27a7e8b8532370f url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-upper.md -->

---
product: DataWeave
version: 2.11
---

# upper

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## upper(text: String): String

Returns the provided string in uppercase characters.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to convert to uppercase.</p></td></tr></tbody></table>

### Example

This example converts lowercase characters to uppercase.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "name" : upper("mulesoft") }
```

#### Output

```JSON
{ "name": "MULESOFT" }
```

## upper(value: Null): Null

Helper function that enables `upper` to work with a `null` value.

<!-- document id=f0bc74ec86622dc3d599346ba0cbbe5f5053f68874fe70a592c6ad323b10415d url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-upper.md -->

---
product: DataWeave
version: 2.12
---

# upper

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## upper(text: String): String

Returns the provided string in uppercase characters.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to convert to uppercase.</p></td></tr></tbody></table>

### Example

This example converts lowercase characters to uppercase.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "name" : upper("mulesoft") }
```

#### Output

```JSON
{ "name": "MULESOFT" }
```

## upper(value: Null): Null

Helper function that enables `upper` to work with a `null` value.

<!-- document id=8eec55b2e5e49ed5d2ee033eeefc873a5ae0ce7107809a7796218d6c02aeca40 url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-upper.md -->

---
product: DataWeave
version: 2.3
---

# upper

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## upper(String): String

Returns the provided string in uppercase characters.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to convert to uppercase.</p></td></tr></tbody></table>

### Example

This example converts lowercase characters to uppercase.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "name" : upper("mulesoft") }
```

#### Output

```JSON
{ "name": "MULESOFT" }
```

## upper(Null): Null

Helper function that enables `upper` to work with a `null` value.

<!-- document id=9161bc05585cd8f117086c3c069b9b5636c5a635481e05defa95e7e13456402b url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-upper.md -->

---
product: DataWeave
version: 2.4
---

# upper

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## upper(text: String): String

Returns the provided string in uppercase characters.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to convert to uppercase.</p></td></tr></tbody></table>

### Example

This example converts lowercase characters to uppercase.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "name" : upper("mulesoft") }
```

#### Output

```JSON
{ "name": "MULESOFT" }
```

## upper(value: Null): Null

Helper function that enables `upper` to work with a `null` value.

<!-- document id=3a70e637a9093d9db32e9d0bc1ac371a8ed9e2473c523be0a088e64cf44d6ab0 url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-upper.md -->

---
product: DataWeave
version: 2.6
---

# upper

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## upper(text: String): String

Returns the provided string in uppercase characters.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to convert to uppercase.</p></td></tr></tbody></table>

### Example

This example converts lowercase characters to uppercase.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "name" : upper("mulesoft") }
```

#### Output

```JSON
{ "name": "MULESOFT" }
```

## upper(value: Null): Null

Helper function that enables `upper` to work with a `null` value.

<!-- document id=56436826888f970059a5a4ca39b98e566ce8c6cd72d1e2694f38cd2543e0c6e5 url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-upper.md -->

---
product: DataWeave
version: 2.9
---

# upper

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## upper(text: String): String

Returns the provided string in uppercase characters.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to convert to uppercase.</p></td></tr></tbody></table>

### Example

This example converts lowercase characters to uppercase.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "name" : upper("mulesoft") }
```

#### Output

```JSON
{ "name": "MULESOFT" }
```

## upper(value: Null): Null

Helper function that enables `upper` to work with a `null` value.

<!-- document id=037931baa0b4a0a57df60088f9363288c400785077f0d3e5ae773d41a58b072c url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-upper.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# upper

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## upper(text: String): String

Returns the provided string in uppercase characters.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to convert to uppercase.</p></td></tr></tbody></table>

### Example

This example converts lowercase characters to uppercase.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "name" : upper("mulesoft") }
```

#### Output

```JSON
{ "name": "MULESOFT" }
```

## upper(value: Null): Null

Helper function that enables `upper` to work with a `null` value.

<!-- document id=ae8e7951dbf3925c0020bcc7d0ae3067c6efbac9c317c4f4cf00c10810f14a5c url=/mulesoft/current/en-us/dataweave/2.11/dw-url.md -->

---
product: DataWeave
version: 2.11
---

# URL (dw::core::URL)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions for working with URIs.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::URL` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-url-functions-compose">compose</a></p></td><td><p>Uses a custom string interpolator to replace URL components with a <code>encodeURIComponent</code> result. You can call this function using the standard call, or a simplified version.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-url-functions-decodeuri">decodeURI</a></p></td><td><p>Decodes the escape sequences (such as <code>%20</code>) in a URI.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-url-functions-decodeuricomponent">decodeURIComponent</a></p></td><td><p>Decodes a Uniform Resource Identifier (URI) component previously created by <code>encodeURIComponent</code> or a similar routine.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-url-functions-encodeuri">encodeURI</a></p></td><td><p>Encodes a URI with UTF-8 escape sequences.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-url-functions-encodeuricomponent">encodeURIComponent</a></p></td><td><p>Escapes certain characters in a URI component using UTF-8 encoding.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-url-functions-parseuri">parseURI</a></p></td><td><p>Parses a URL and returns a <code>URI</code> object.</p></td></tr></tbody></table>

## Types

- [URL Types](https://docs.mulesoft.com/dataweave/2.11/dw-url-types)

<!-- document id=5c7f314cc0e4ce787c3b37ca6f078815a99635cb346d81f67fc0fc8f48bc2da7 url=/mulesoft/current/en-us/dataweave/2.12/dw-url.md -->

---
product: DataWeave
version: 2.12
---

# URL (dw::core::URL)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions for working with URIs.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::URL` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-url-functions-compose">compose</a></p></td><td><p>Uses a custom string interpolator to replace URL components with a <code>encodeURIComponent</code> result. You can call this function using the standard call, or a simplified version.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-url-functions-decodeuri">decodeURI</a></p></td><td><p>Decodes the escape sequences (such as <code>%20</code>) in a URI.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-url-functions-decodeuricomponent">decodeURIComponent</a></p></td><td><p>Decodes a Uniform Resource Identifier (URI) component previously created by <code>encodeURIComponent</code> or a similar routine.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-url-functions-encodeuri">encodeURI</a></p></td><td><p>Encodes a URI with UTF-8 escape sequences.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-url-functions-encodeuricomponent">encodeURIComponent</a></p></td><td><p>Escapes certain characters in a URI component using UTF-8 encoding.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-url-functions-parseuri">parseURI</a></p></td><td><p>Parses a URL and returns a <code>URI</code> object.</p></td></tr></tbody></table>

## Types

- [URL Types](https://docs.mulesoft.com/dataweave/2.12/dw-url-types)

<!-- document id=93b500089eeb2007082cead9694a91a31434eaee8f3997a9d0444d37dc693f5a url=/mulesoft/current/en-us/dataweave/2.3/dw-url.md -->

---
product: DataWeave
version: 2.3
---

# URL (dw::core::URL)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions to work with Strings.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::URL` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-url-functions-compose">compose</a></p></td><td><p>Uses a custom interpolator to replace URL components with a <code>encodeURIComponent</code> result.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-url-functions-decodeuri">decodeURI</a></p></td><td><p>Decodes the escape sequences (such as <code>%20</code>) in a URI.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-url-functions-decodeuricomponent">decodeURIComponent</a></p></td><td><p>Decodes a Uniform Resource Identifier (URI) component previously created by <code>encodeURIComponent</code> or a similar routine.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-url-functions-encodeuri">encodeURI</a></p></td><td><p>Encodes a URI with UTF-8 escape sequences.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-url-functions-encodeuricomponent">encodeURIComponent</a></p></td><td><p>Escapes certain characters in a URI component using UTF-8 encoding.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-url-functions-parseuri">parseURI</a></p></td><td><p>Parses a URL and returns a <code>URI</code> object.</p></td></tr></tbody></table>

## Types

- [URL Types](https://docs.mulesoft.com/dataweave/2.3/dw-url-types)

<!-- document id=4b1a34a9f64b2da3671f281d6c5e04d0a76725b98433a0e80d6c165043cda1dc url=/mulesoft/current/en-us/dataweave/2.4/dw-url.md -->

---
product: DataWeave
version: 2.4
---

# URL (dw::core::URL)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions for working with URIs.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::URL` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-url-functions-compose">compose</a></p></td><td><p>Uses a custom string interpolator to replace URL components with a <code>encodeURIComponent</code> result. You can call this function using the standard call, or a simplified version.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-url-functions-decodeuri">decodeURI</a></p></td><td><p>Decodes the escape sequences (such as <code>%20</code>) in a URI.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-url-functions-decodeuricomponent">decodeURIComponent</a></p></td><td><p>Decodes a Uniform Resource Identifier (URI) component previously created by <code>encodeURIComponent</code> or a similar routine.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-url-functions-encodeuri">encodeURI</a></p></td><td><p>Encodes a URI with UTF-8 escape sequences.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-url-functions-encodeuricomponent">encodeURIComponent</a></p></td><td><p>Escapes certain characters in a URI component using UTF-8 encoding.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-url-functions-parseuri">parseURI</a></p></td><td><p>Parses a URL and returns a <code>URI</code> object.</p></td></tr></tbody></table>

## Types

- [URL Types](https://docs.mulesoft.com/dataweave/2.4/dw-url-types)

<!-- document id=313f8db3cef16a918e935d2267ab5122f8eb9f20741a74d17a3a3e2927edf043 url=/mulesoft/current/en-us/dataweave/2.6/dw-url.md -->

---
product: DataWeave
version: 2.6
---

# URL (dw::core::URL)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions for working with URIs.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::URL` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-url-functions-compose">compose</a></p></td><td><p>Uses a custom string interpolator to replace URL components with a <code>encodeURIComponent</code> result. You can call this function using the standard call, or a simplified version.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-url-functions-decodeuri">decodeURI</a></p></td><td><p>Decodes the escape sequences (such as <code>%20</code>) in a URI.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-url-functions-decodeuricomponent">decodeURIComponent</a></p></td><td><p>Decodes a Uniform Resource Identifier (URI) component previously created by <code>encodeURIComponent</code> or a similar routine.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-url-functions-encodeuri">encodeURI</a></p></td><td><p>Encodes a URI with UTF-8 escape sequences.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-url-functions-encodeuricomponent">encodeURIComponent</a></p></td><td><p>Escapes certain characters in a URI component using UTF-8 encoding.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-url-functions-parseuri">parseURI</a></p></td><td><p>Parses a URL and returns a <code>URI</code> object.</p></td></tr></tbody></table>

## Types

- [URL Types](https://docs.mulesoft.com/dataweave/2.6/dw-url-types)

<!-- document id=7e084a87e3871c32853e61802f728ac2d0c7e48f92fc1c224ee032fc48b23e30 url=/mulesoft/current/en-us/dataweave/2.9/dw-url.md -->

---
product: DataWeave
version: 2.9
---

# URL (dw::core::URL)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions for working with URIs.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::URL` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-url-functions-compose">compose</a></p></td><td><p>Uses a custom string interpolator to replace URL components with a <code>encodeURIComponent</code> result. You can call this function using the standard call, or a simplified version.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-url-functions-decodeuri">decodeURI</a></p></td><td><p>Decodes the escape sequences (such as <code>%20</code>) in a URI.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-url-functions-decodeuricomponent">decodeURIComponent</a></p></td><td><p>Decodes a Uniform Resource Identifier (URI) component previously created by <code>encodeURIComponent</code> or a similar routine.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-url-functions-encodeuri">encodeURI</a></p></td><td><p>Encodes a URI with UTF-8 escape sequences.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-url-functions-encodeuricomponent">encodeURIComponent</a></p></td><td><p>Escapes certain characters in a URI component using UTF-8 encoding.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-url-functions-parseuri">parseURI</a></p></td><td><p>Parses a URL and returns a <code>URI</code> object.</p></td></tr></tbody></table>

## Types

- [URL Types](https://docs.mulesoft.com/dataweave/2.9/dw-url-types)

<!-- document id=6584aba98a9418d28daff19a118311e33a648eca0e6bf59bc55e12eb1d09bd76 url=/mulesoft/current/en-us/dataweave/latest/dw-url.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# URL (dw::core::URL)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module contains helper functions for working with URIs.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::core::URL` to the header of your DataWeave script.

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-url-functions-compose">compose</a></p></td><td><p>Uses a custom string interpolator to replace URL components with a <code>encodeURIComponent</code> result. You can call this function using the standard call, or a simplified version.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-url-functions-decodeuri">decodeURI</a></p></td><td><p>Decodes the escape sequences (such as <code>%20</code>) in a URI.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-url-functions-decodeuricomponent">decodeURIComponent</a></p></td><td><p>Decodes a Uniform Resource Identifier (URI) component previously created by <code>encodeURIComponent</code> or a similar routine.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-url-functions-encodeuri">encodeURI</a></p></td><td><p>Encodes a URI with UTF-8 escape sequences.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-url-functions-encodeuricomponent">encodeURIComponent</a></p></td><td><p>Escapes certain characters in a URI component using UTF-8 encoding.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-url-functions-parseuri">parseURI</a></p></td><td><p>Parses a URL and returns a <code>URI</code> object.</p></td></tr></tbody></table>

## Types

- [URL Types](https://docs.mulesoft.com/dataweave/latest/dw-url-types)

<!-- document id=cd63a177d9ae2d6cd80464e88414cd6f7665ba3ea590fa44bcb27e79cf7ab62f url=/mulesoft/current/en-us/dataweave/2.11/dataweave-formats-urlencoded.md -->

---
product: DataWeave
version: 2.11
keywords: format, urlencoded, application/x-www-form-urlencoded, application/x-www-form-urlencoded
---

# URL Encoded Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/x-www-form-urlencoded`

ID: `urlencoded`

URL encoded data represents a collection of key-value pairs. DataWeave represents these values as an
object in which each value is a string.

## Examples

The following examples show uses of the URL Encoded format:

- [Example: Represent URL Encoded Data in the DataWeave (dw) Format](#example1)

- [Example: Generate URL Encoded Data from a JSON Object](#example2)

- [Example: Generate URL Encoded Data from a Collection of Key-Value Pairs](#example3)

- [Example: Transform URL Encoded Data to the Text Plain Format](#example4)

### Example: Represent URL Encoded Data in the DataWeave (dw) Format

This example shows how DataWeave represents simple URL encoded data.

#### Input

The URL encoded data serves as input payload to the DataWeave source.

```form-urlencoded
name=Mariano&lastName=de+Achaval
```

#### Source

The DataWeave script transforms the URL encoded input payload to the DataWeave (dw) format and MIME
type.

```dataweave
%dw 2.0
output application/dw
---
payload
```

#### Output

The output is a DataWeave object that contains a collection of key-value pairs from the input.

```dataweave
{
    "name": "Mariano",
    "lastName": "de Achaval"
}
```

### Example: Generate URL Encoded Data from a JSON Object

This example shows how to generate URL Encoded data.

#### Input

The JSON object serves as the input payload to the DataWeave source.

```json
{
  "name": "Mariano"
}
```

#### Source

The DataWeave script selects the value of the `name` key in the input payload and transforms all
values of the object in the body of the script to the `urlencoded` format.

```dataweave
%dw 2.0
output urlencoded
---
{
    name: payload.name,
    age: 37
}
```

#### Output

The output is URL encoded data that is constructed from the key-value pairs in the body of the
DataWeave script.

```form-urlencoded
name=Mariano&age=37
```

### Example: Generate URL Encoded Data from a Collection of Key-Value Pairs

This DataWeave script produces the URL encoded output.

#### Source

The DataWeave script transforms the format of the JSON input found within the body of the script
into the URL Encoded format.

```dataweave
%dw 2.0
output application/x-www-form-urlencoded
---
{
  "key" : "value",
  "key 1": "@here",
  "key" : "other value",
  "key 2%": null
}
```

#### Output

The output shows the input data in the URL Encoded format.

```text
key=value&key+1=%40here&key=other+value&key+2%25
```

### Example: Transform URL Encoded Data to the Text Plain Format

This example transforms URL Encoded input into the Text Plain format and MIME type.

#### Source

The DataWeave script reads the URL Encoded data and concatenates values of the selected keys.

```dataweave
%dw 2.0
var myData  read('key=value&key+1=%40here&key=other+value&key+2%25', 'application/x-www-form-urlencoded')
output text/plain
---
myData.*key[0] ++ myData.'key 1'
```

#### Output

The output is in Text Plain format.

```text
value@here
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

There are no reader properties for this format.

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>application/x-www-form-urlencoded</code></p></td></tr></tbody></table>

<!-- document id=3558e3b73ae0683265a08dc2ef81865f1afa1ceaab25a6af8139d61b593446f7 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-formats-urlencoded.md -->

---
product: DataWeave
version: 2.12
keywords: format, urlencoded, application/x-www-form-urlencoded, application/x-www-form-urlencoded
---

# URL Encoded Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/x-www-form-urlencoded`

ID: `urlencoded`

URL encoded data represents a collection of key-value pairs. DataWeave represents these values as an
object in which each value is a string.

## Examples

The following examples show uses of the URL Encoded format:

- [Example: Represent URL Encoded Data in the DataWeave (dw) Format](#example1)

- [Example: Generate URL Encoded Data from a JSON Object](#example2)

- [Example: Generate URL Encoded Data from a Collection of Key-Value Pairs](#example3)

- [Example: Transform URL Encoded Data to the Text Plain Format](#example4)

### Example: Represent URL Encoded Data in the DataWeave (dw) Format

This example shows how DataWeave represents simple URL encoded data.

#### Input

The URL encoded data serves as input payload to the DataWeave source.

```form-urlencoded
name=Mariano&lastName=de+Achaval
```

#### Source

The DataWeave script transforms the URL encoded input payload to the DataWeave (dw) format and MIME
type.

```dataweave
%dw 2.0
output application/dw
---
payload
```

#### Output

The output is a DataWeave object that contains a collection of key-value pairs from the input.

```dataweave
{
    "name": "Mariano",
    "lastName": "de Achaval"
}
```

### Example: Generate URL Encoded Data from a JSON Object

This example shows how to generate URL Encoded data.

#### Input

The JSON object serves as the input payload to the DataWeave source.

```json
{
  "name": "Mariano"
}
```

#### Source

The DataWeave script selects the value of the `name` key in the input payload and transforms all
values of the object in the body of the script to the `urlencoded` format.

```dataweave
%dw 2.0
output urlencoded
---
{
    name: payload.name,
    age: 37
}
```

#### Output

The output is URL encoded data that is constructed from the key-value pairs in the body of the
DataWeave script.

```form-urlencoded
name=Mariano&age=37
```

### Example: Generate URL Encoded Data from a Collection of Key-Value Pairs

This DataWeave script produces the URL encoded output.

#### Source

The DataWeave script transforms the format of the JSON input found within the body of the script
into the URL Encoded format.

```dataweave
%dw 2.0
output application/x-www-form-urlencoded
---
{
  "key" : "value",
  "key 1": "@here",
  "key" : "other value",
  "key 2%": null
}
```

#### Output

The output shows the input data in the URL Encoded format.

```text
key=value&key+1=%40here&key=other+value&key+2%25
```

### Example: Transform URL Encoded Data to the Text Plain Format

This example transforms URL Encoded input into the Text Plain format and MIME type.

#### Source

The DataWeave script reads the URL Encoded data and concatenates values of the selected keys.

```dataweave
%dw 2.0
var myData  read('key=value&key+1=%40here&key=other+value&key+2%25', 'application/x-www-form-urlencoded')
output text/plain
---
myData.*key[0] ++ myData.'key 1'
```

#### Output

The output is in Text Plain format.

```text
value@here
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

There are no reader properties for this format.

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>application/x-www-form-urlencoded</code></p></td></tr></tbody></table>

<!-- document id=d2f8b2d6ecd7b195cee6e70fec77e8d29d84652cc3a8c40f83846f6e916a385a url=/mulesoft/current/en-us/dataweave/2.3/dataweave-formats-urlencoded.md -->

---
product: DataWeave
version: 2.3
---

# URL Encoded Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME Type: `application/x-www-form-urlencoded`

ID: `urlencoded`

URL encoded data represents a collection of key-value pairs. DataWeave represents these values as an
object in which each value is a string.

## Examples

The following examples show uses of the URL Encoded format:

- [Example: Represent URL Encoded Data in the DataWeave (dw) Format](#example1)

- [Example: Generate URL Encoded Data from a JSON Object](#example2)

- [Example: Generate URL Encoded Data from a Collection of Key-Value Pairs](#example3)

- [Example: Transform URL Encoded Data to the Text Plain Format](#example4)

### Example: Represent URL Encoded Data in the DataWeave (dw) Format

This example shows how DataWeave represents simple URL encoded data.

#### Input

The URL encoded data serves as input payload to the DataWeave source.

```form-urlencoded
name=Mariano&lastName=de+Achaval
```

#### Source

The DataWeave script transforms the URL encoded input payload to the DataWeave (dw) format and MIME
type.

```dataweave
%dw 2.0
output application/dw
---
payload
```

#### Output

The output is a DataWeave object that contains a collection of key-value pairs from the input.

```dataweave
{
    "name": "Mariano",
    "lastName": "de Achaval"
}
```

### Example: Generate URL Encoded Data from a JSON Object

This example shows how to generate URL Encoded data.

### Input

The JSON object serves as the input payload to the DataWeave source.

```json
{
  "name": "Mariano"
}
```

#### Source

The DataWeave script selects the value of the `name` key in the input payload and transforms all
values of the object in the body of the script to the `urlencoded` format.

```dataweave
%dw 2.0
output urlencoded
---
{
    name: payload.name,
    age: 37
}
```

#### Output

The output is URL encoded data that is constructed from the key-value pairs in the body of the
DataWeave script.

```form-urlencoded
name=Mariano&age=37
```

### Example: Generate URL Encoded Data from a Collection of Key-Value Pairs

This DataWeave script produces the URL encoded output.

#### Source

The DataWeave script transforms the format of the JSON input found within the body of the script
into the URL Encoded format.

```dataweave
%dw 2.0
output application/x-www-form-urlencoded
---
{
  "key" : "value",
  "key 1": "@here",
  "key" : "other value",
  "key 2%": null
}
```

#### Output

The output shows the input data in the URL Encoded format.

```text
key=value&key+1=%40here&key=other+value&key+2%25
```

### Example: Transform URL Encoded Data to the Text Plain Format

This example transforms URL Encoded input into the Text Plain format and MIME type.

#### Source

The DataWeave script reads the URL Encoded data and concatenates values of the selected keys.

```dataweave
%dw 2.0
var myData  read('key=value&key+1=%40here&key=other+value&key+2%25', 'application/x-www-form-urlencoded')
output text/plain
---
myData.*key[0] ++ myData.'key 1'
```

#### Output

The output is in Text Plain format.

```text
value@here
```

## Configuration Properties

DataWeave supports the following configuration properties for the URL Encoded format.

### Reader Properties (for URL Encoded Data)

There are no reader properties for URL encoded data.

### Writer (for URL Encoded Data)

The URL Encoded format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the writer buffer.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>When set to <code>true</code>, DataWeave generates the output as a data stream, and the script’s execution is deferred until it is consumed. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Encoding for the writer to use.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

The URL Encoded format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>application/x-www-form-urlencoded</code></p></td></tr></tbody></table>

<!-- document id=da9cdca08af5c74218649ddf94088f13e40581d57bb62194889953e47b0cbda3 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-formats-urlencoded.md -->

---
product: DataWeave
version: 2.4
keywords: format, urlencoded, application/x-www-form-urlencoded, application/x-www-form-urlencoded
---

# URL Encoded Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/x-www-form-urlencoded`

ID: `urlencoded`

URL encoded data represents a collection of key-value pairs. DataWeave represents these values as an
object in which each value is a string.

## Examples

The following examples show uses of the URL Encoded format:

- [Example: Represent URL Encoded Data in the DataWeave (dw) Format](#example1)

- [Example: Generate URL Encoded Data from a JSON Object](#example2)

- [Example: Generate URL Encoded Data from a Collection of Key-Value Pairs](#example3)

- [Example: Transform URL Encoded Data to the Text Plain Format](#example4)

### Example: Represent URL Encoded Data in the DataWeave (dw) Format

This example shows how DataWeave represents simple URL encoded data.

#### Input

The URL encoded data serves as input payload to the DataWeave source.

```form-urlencoded
name=Mariano&lastName=de+Achaval
```

#### Source

The DataWeave script transforms the URL encoded input payload to the DataWeave (dw) format and MIME
type.

```dataweave
%dw 2.0
output application/dw
---
payload
```

#### Output

The output is a DataWeave object that contains a collection of key-value pairs from the input.

```dataweave
{
    "name": "Mariano",
    "lastName": "de Achaval"
}
```

### Example: Generate URL Encoded Data from a JSON Object

This example shows how to generate URL Encoded data.

### Input

The JSON object serves as the input payload to the DataWeave source.

```json
{
  "name": "Mariano"
}
```

#### Source

The DataWeave script selects the value of the `name` key in the input payload and transforms all
values of the object in the body of the script to the `urlencoded` format.

```dataweave
%dw 2.0
output urlencoded
---
{
    name: payload.name,
    age: 37
}
```

#### Output

The output is URL encoded data that is constructed from the key-value pairs in the body of the
DataWeave script.

```form-urlencoded
name=Mariano&age=37
```

### Example: Generate URL Encoded Data from a Collection of Key-Value Pairs

This DataWeave script produces the URL encoded output.

#### Source

The DataWeave script transforms the format of the JSON input found within the body of the script
into the URL Encoded format.

```dataweave
%dw 2.0
output application/x-www-form-urlencoded
---
{
  "key" : "value",
  "key 1": "@here",
  "key" : "other value",
  "key 2%": null
}
```

#### Output

The output shows the input data in the URL Encoded format.

```text
key=value&key+1=%40here&key=other+value&key+2%25
```

### Example: Transform URL Encoded Data to the Text Plain Format

This example transforms URL Encoded input into the Text Plain format and MIME type.

#### Source

The DataWeave script reads the URL Encoded data and concatenates values of the selected keys.

```dataweave
%dw 2.0
var myData  read('key=value&key+1=%40here&key=other+value&key+2%25', 'application/x-www-form-urlencoded')
output text/plain
---
myData.*key[0] ++ myData.'key 1'
```

#### Output

The output is in Text Plain format.

```text
value@here
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

There are no reader properties for this format.

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The character set to use for the output, such as UTF-8.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>application/x-www-form-urlencoded</code></p></td></tr></tbody></table>

<!-- document id=df5d6cf2e53dcc29f06e7bda18f4e8da0d71a753640e78b9897b8f8a41501d84 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-formats-urlencoded.md -->

---
product: DataWeave
version: 2.6
keywords: format, urlencoded, application/x-www-form-urlencoded, application/x-www-form-urlencoded
---

# URL Encoded Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/x-www-form-urlencoded`

ID: `urlencoded`

URL encoded data represents a collection of key-value pairs. DataWeave represents these values as an
object in which each value is a string.

## Examples

The following examples show uses of the URL Encoded format:

- [Example: Represent URL Encoded Data in the DataWeave (dw) Format](#example1)

- [Example: Generate URL Encoded Data from a JSON Object](#example2)

- [Example: Generate URL Encoded Data from a Collection of Key-Value Pairs](#example3)

- [Example: Transform URL Encoded Data to the Text Plain Format](#example4)

### Example: Represent URL Encoded Data in the DataWeave (dw) Format

This example shows how DataWeave represents simple URL encoded data.

#### Input

The URL encoded data serves as input payload to the DataWeave source.

```form-urlencoded
name=Mariano&lastName=de+Achaval
```

#### Source

The DataWeave script transforms the URL encoded input payload to the DataWeave (dw) format and MIME
type.

```dataweave
%dw 2.0
output application/dw
---
payload
```

#### Output

The output is a DataWeave object that contains a collection of key-value pairs from the input.

```dataweave
{
    "name": "Mariano",
    "lastName": "de Achaval"
}
```

### Example: Generate URL Encoded Data from a JSON Object

This example shows how to generate URL Encoded data.

#### Input

The JSON object serves as the input payload to the DataWeave source.

```json
{
  "name": "Mariano"
}
```

#### Source

The DataWeave script selects the value of the `name` key in the input payload and transforms all
values of the object in the body of the script to the `urlencoded` format.

```dataweave
%dw 2.0
output urlencoded
---
{
    name: payload.name,
    age: 37
}
```

#### Output

The output is URL encoded data that is constructed from the key-value pairs in the body of the
DataWeave script.

```form-urlencoded
name=Mariano&age=37
```

### Example: Generate URL Encoded Data from a Collection of Key-Value Pairs

This DataWeave script produces the URL encoded output.

#### Source

The DataWeave script transforms the format of the JSON input found within the body of the script
into the URL Encoded format.

```dataweave
%dw 2.0
output application/x-www-form-urlencoded
---
{
  "key" : "value",
  "key 1": "@here",
  "key" : "other value",
  "key 2%": null
}
```

#### Output

The output shows the input data in the URL Encoded format.

```text
key=value&key+1=%40here&key=other+value&key+2%25
```

### Example: Transform URL Encoded Data to the Text Plain Format

This example transforms URL Encoded input into the Text Plain format and MIME type.

#### Source

The DataWeave script reads the URL Encoded data and concatenates values of the selected keys.

```dataweave
%dw 2.0
var myData  read('key=value&key+1=%40here&key=other+value&key+2%25', 'application/x-www-form-urlencoded')
output text/plain
---
myData.*key[0] ++ myData.'key 1'
```

#### Output

The output is in Text Plain format.

```text
value@here
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

There are no reader properties for this format.

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>application/x-www-form-urlencoded</code></p></td></tr></tbody></table>

<!-- document id=1ea5bf3dea18453f6257f749ae74df8f7eed5fa38b569753177fea71b65f6f9e url=/mulesoft/current/en-us/dataweave/2.9/dataweave-formats-urlencoded.md -->

---
product: DataWeave
version: 2.9
keywords: format, urlencoded, application/x-www-form-urlencoded, application/x-www-form-urlencoded
---

# URL Encoded Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/x-www-form-urlencoded`

ID: `urlencoded`

URL encoded data represents a collection of key-value pairs. DataWeave represents these values as an
object in which each value is a string.

## Examples

The following examples show uses of the URL Encoded format:

- [Example: Represent URL Encoded Data in the DataWeave (dw) Format](#example1)

- [Example: Generate URL Encoded Data from a JSON Object](#example2)

- [Example: Generate URL Encoded Data from a Collection of Key-Value Pairs](#example3)

- [Example: Transform URL Encoded Data to the Text Plain Format](#example4)

### Example: Represent URL Encoded Data in the DataWeave (dw) Format

This example shows how DataWeave represents simple URL encoded data.

#### Input

The URL encoded data serves as input payload to the DataWeave source.

```form-urlencoded
name=Mariano&lastName=de+Achaval
```

#### Source

The DataWeave script transforms the URL encoded input payload to the DataWeave (dw) format and MIME
type.

```dataweave
%dw 2.0
output application/dw
---
payload
```

#### Output

The output is a DataWeave object that contains a collection of key-value pairs from the input.

```dataweave
{
    "name": "Mariano",
    "lastName": "de Achaval"
}
```

### Example: Generate URL Encoded Data from a JSON Object

This example shows how to generate URL Encoded data.

#### Input

The JSON object serves as the input payload to the DataWeave source.

```json
{
  "name": "Mariano"
}
```

#### Source

The DataWeave script selects the value of the `name` key in the input payload and transforms all
values of the object in the body of the script to the `urlencoded` format.

```dataweave
%dw 2.0
output urlencoded
---
{
    name: payload.name,
    age: 37
}
```

#### Output

The output is URL encoded data that is constructed from the key-value pairs in the body of the
DataWeave script.

```form-urlencoded
name=Mariano&age=37
```

### Example: Generate URL Encoded Data from a Collection of Key-Value Pairs

This DataWeave script produces the URL encoded output.

#### Source

The DataWeave script transforms the format of the JSON input found within the body of the script
into the URL Encoded format.

```dataweave
%dw 2.0
output application/x-www-form-urlencoded
---
{
  "key" : "value",
  "key 1": "@here",
  "key" : "other value",
  "key 2%": null
}
```

#### Output

The output shows the input data in the URL Encoded format.

```text
key=value&key+1=%40here&key=other+value&key+2%25
```

### Example: Transform URL Encoded Data to the Text Plain Format

This example transforms URL Encoded input into the Text Plain format and MIME type.

#### Source

The DataWeave script reads the URL Encoded data and concatenates values of the selected keys.

```dataweave
%dw 2.0
var myData  read('key=value&key+1=%40here&key=other+value&key+2%25', 'application/x-www-form-urlencoded')
output text/plain
---
myData.*key[0] ++ myData.'key 1'
```

#### Output

The output is in Text Plain format.

```text
value@here
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

There are no reader properties for this format.

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>application/x-www-form-urlencoded</code></p></td></tr></tbody></table>

<!-- document id=a733b3e950cc2973d7eaee04fac2b27280c8acb9572e6cc240d2260ccd680953 url=/mulesoft/current/en-us/dataweave/latest/dataweave-formats-urlencoded.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: format, urlencoded, application/x-www-form-urlencoded, application/x-www-form-urlencoded
---

# URL Encoded Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/x-www-form-urlencoded`

ID: `urlencoded`

URL encoded data represents a collection of key-value pairs. DataWeave represents these values as an
object in which each value is a string.

## Examples

The following examples show uses of the URL Encoded format:

- [Example: Represent URL Encoded Data in the DataWeave (dw) Format](#example1)

- [Example: Generate URL Encoded Data from a JSON Object](#example2)

- [Example: Generate URL Encoded Data from a Collection of Key-Value Pairs](#example3)

- [Example: Transform URL Encoded Data to the Text Plain Format](#example4)

### Example: Represent URL Encoded Data in the DataWeave (dw) Format

This example shows how DataWeave represents simple URL encoded data.

#### Input

The URL encoded data serves as input payload to the DataWeave source.

```form-urlencoded
name=Mariano&lastName=de+Achaval
```

#### Source

The DataWeave script transforms the URL encoded input payload to the DataWeave (dw) format and MIME
type.

```dataweave
%dw 2.0
output application/dw
---
payload
```

#### Output

The output is a DataWeave object that contains a collection of key-value pairs from the input.

```dataweave
{
    "name": "Mariano",
    "lastName": "de Achaval"
}
```

### Example: Generate URL Encoded Data from a JSON Object

This example shows how to generate URL Encoded data.

#### Input

The JSON object serves as the input payload to the DataWeave source.

```json
{
  "name": "Mariano"
}
```

#### Source

The DataWeave script selects the value of the `name` key in the input payload and transforms all
values of the object in the body of the script to the `urlencoded` format.

```dataweave
%dw 2.0
output urlencoded
---
{
    name: payload.name,
    age: 37
}
```

#### Output

The output is URL encoded data that is constructed from the key-value pairs in the body of the
DataWeave script.

```form-urlencoded
name=Mariano&age=37
```

### Example: Generate URL Encoded Data from a Collection of Key-Value Pairs

This DataWeave script produces the URL encoded output.

#### Source

The DataWeave script transforms the format of the JSON input found within the body of the script
into the URL Encoded format.

```dataweave
%dw 2.0
output application/x-www-form-urlencoded
---
{
  "key" : "value",
  "key 1": "@here",
  "key" : "other value",
  "key 2%": null
}
```

#### Output

The output shows the input data in the URL Encoded format.

```text
key=value&key+1=%40here&key=other+value&key+2%25
```

### Example: Transform URL Encoded Data to the Text Plain Format

This example transforms URL Encoded input into the Text Plain format and MIME type.

#### Source

The DataWeave script reads the URL Encoded data and concatenates values of the selected keys.

```dataweave
%dw 2.0
var myData  read('key=value&key+1=%40here&key=other+value&key+2%25', 'application/x-www-form-urlencoded')
output text/plain
---
myData.*key[0] ++ myData.'key 1'
```

#### Output

The output is in Text Plain format.

```text
value@here
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

There are no reader properties for this format.

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>application/x-www-form-urlencoded</code></p></td></tr></tbody></table>

<!-- document id=485826500b2f1cde1b4b60dca131cf7b0874791d91cb3591ebebcb0ff6897a82 url=/mulesoft/current/en-us/dataweave/2.11/dw-url-types.md -->

---
product: DataWeave
version: 2.11
---

# URL Types (dw::core::URL)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>URI</p></td><td><div><div><p><code>type URI = { isValid: Boolean, host?: String, authority?: String, fragment?: String, path?: String, port?: Number, query?: String, scheme?: String, user?: String, isAbsolute?: Boolean, isOpaque?: Boolean }</code></p></div></div></td><td><div><div><p>Describes the URI type. For descriptions of the fields, see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-types#dw_type_url">URL Types (dw::core::URL)</a>.</p></div></div></td></tr></tbody></table>

<!-- document id=ea4a16baf1d301959502072965f97d078e95c48e0ba2247e5059fc12d589a93a url=/mulesoft/current/en-us/dataweave/2.12/dw-url-types.md -->

---
product: DataWeave
version: 2.12
---

# URL Types (dw::core::URL)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>URI</p></td><td><div><div><p><code>type URI = { isValid: Boolean, host?: String, authority?: String, fragment?: String, path?: String, port?: Number, query?: String, scheme?: String, user?: String, isAbsolute?: Boolean, isOpaque?: Boolean }</code></p></div></div></td><td><div><div><p>Describes the URI type. For descriptions of the fields, see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-types#dw_type_url">URL Types (dw::core::URL)</a>.</p></div></div></td></tr></tbody></table>

<!-- document id=c2f6c89db886cb750068aaeffc991d6997287f83e058ae0906324d5154141ec2 url=/mulesoft/current/en-us/dataweave/2.3/dw-url-types.md -->

---
product: DataWeave
version: 2.3
---

# URL Types (dw::core::URL)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>URI</p></td><td><p><code>type URI = { isValid: Boolean, host?: String, authority?: String, fragment?: String, path?: String, port?: Number, query?: String, scheme?: String, user?: String, isAbsolute?: Boolean, isOpaque?: Boolean }</code></p></td><td><p>Describes the URI type. For descriptions of the fields, see <a href="https://docs.mulesoft.com/dataweave/2.3/dataweave-types#dw_type_url">URL Types (dw::core::URL)</a>.</p></td></tr></tbody></table>

<!-- document id=7206dc7f397ca53a680a2fa684b0b73417f45d8476eede0bc184292135f344ab url=/mulesoft/current/en-us/dataweave/2.4/dw-url-types.md -->

---
product: DataWeave
version: 2.4
---

# URL Types (dw::core::URL)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>URI</p></td><td><div><div><p><code>type URI = { isValid: Boolean, host?: String, authority?: String, fragment?: String, path?: String, port?: Number, query?: String, scheme?: String, user?: String, isAbsolute?: Boolean, isOpaque?: Boolean }</code></p></div></div></td><td><div><div><p>Describes the URI type. For descriptions of the fields, see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-types#dw_type_url">URL Types (dw::core::URL)</a>.</p></div></div></td></tr></tbody></table>

<!-- document id=056409437918a298f03e8451bf7c914657cdb9ad59b72e7d46ed4a0145b1e244 url=/mulesoft/current/en-us/dataweave/2.6/dw-url-types.md -->

---
product: DataWeave
version: 2.6
---

# URL Types (dw::core::URL)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>URI</p></td><td><div><div><p><code>type URI = { isValid: Boolean, host?: String, authority?: String, fragment?: String, path?: String, port?: Number, query?: String, scheme?: String, user?: String, isAbsolute?: Boolean, isOpaque?: Boolean }</code></p></div></div></td><td><div><div><p>Describes the URI type. For descriptions of the fields, see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-types#dw_type_url">URL Types (dw::core::URL)</a>.</p></div></div></td></tr></tbody></table>

<!-- document id=fdcf011e8ac296027a06d2d82819376790479743591ddd823e1c99818ae31475 url=/mulesoft/current/en-us/dataweave/2.9/dw-url-types.md -->

---
product: DataWeave
version: 2.9
---

# URL Types (dw::core::URL)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>URI</p></td><td><div><div><p><code>type URI = { isValid: Boolean, host?: String, authority?: String, fragment?: String, path?: String, port?: Number, query?: String, scheme?: String, user?: String, isAbsolute?: Boolean, isOpaque?: Boolean }</code></p></div></div></td><td><div><div><p>Describes the URI type. For descriptions of the fields, see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-types#dw_type_url">URL Types (dw::core::URL)</a>.</p></div></div></td></tr></tbody></table>

<!-- document id=54e826798faaf740b67d666bcecef8f90c2187384c460e3f55827e9a1c38ac96 url=/mulesoft/current/en-us/dataweave/latest/dw-url-types.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# URL Types (dw::core::URL)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>URI</p></td><td><div><div><p><code>type URI = { isValid: Boolean, host?: String, authority?: String, fragment?: String, path?: String, port?: Number, query?: String, scheme?: String, user?: String, isAbsolute?: Boolean, isOpaque?: Boolean }</code></p></div></div></td><td><div><div><p>Describes the URI type. For descriptions of the fields, see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-types#dw_type_url">URL Types (dw::core::URL)</a>.</p></div></div></td></tr></tbody></table>

<!-- document id=cce120f541fff933e44fa8a84dde2c584d57634bfd838ea43a64050520cfc144 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook-reader-prop-connector.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, transform, transformer, format, dataweave, data weave, output structure, mime type, mime
---

# Use a Reader Property through a Connector Operation

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Connector operations that read input data provide an `outpuMimeType` field that you can use to
identify the _input_ MIME type. This field also accepts one or more reader properties, which is
useful for helping DataWeave read the input correctly.

By default, the DataWeave reader treats a comma (`,`) as a separator. However, assume that a CSV
input is separated by the pipe (`|`) but that the content also contains commas. You can set a CSV
reader property to recognize the pipe as the separator.

Pipe-separated CSV Input

```csv
id | name | role
1234 | Shokida,Mr. | dev
2345 | Achaval,Mr. | arch
3456 | Felisatti,Ms. | mngr
4567 | Chibana,Mr. | dev
```

The following example uses the Read operation in the File connector to read the pipe-separated (`|`)
CSV input, and it uses a DataWeave script in the Transform Message component to output a row of the
input in comma-separated format.

Mule Flow:

```xml
<flow name="ex-use-csv-reader-props" >
	<scheduler doc:name="Scheduler" >
		<scheduling-strategy >
			<fixed-frequency frequency="90" timeUnit="SECONDS"/>
		</scheduling-strategy>
	</scheduler>
	<file:read doc:name="Read" config-ref="File_Config" path="staff.csv"
	           outputMimeType='application/csv; separator=|; header=true'/>
	<ee:transform doc:name="Transform Message" >
		<ee:message>
			<ee:set-payload><![CDATA[%dw 2.0
output application/csv header = false
---
payload[1]]]></ee:set-payload>
		</ee:message>
	</ee:transform>
	<logger level="INFO" doc:name="Logger" message="#[payload]"/>
</flow>
```

The Scheduler component (`<scheduler/>`) in the example generates a Mule event each time it triggers
the flow.

The Read operation (`<file:read/>`) uses
`outputMimeType='application/csv; separator=|; header=true'` to identify the input MIME type
(`application/csv`), the CSV separator (`|`), and the header setting (`true`).

The script in the Transform Message component (`<ee:transform-message/>`) returns the second row
from the input CSV (`2345 , Achaval\,Mr. , arch`). The script uses `payload[1]` to select that row
because DataWeave treats each row in the CSV as an index of an array. The output is comma-separated
because the default CSV separator is a comma. The script omits the CSV header from the output by
using the `output` directive (`output application/csv header = false`).

The Logger component (`<logger/>`), which is set to `payload`, writes the comma-separated output as
INFO in its `LoggerMessageProcessor` message: `2345 , Achaval\,Mr. , arch`. To avoid treating the
comma before "Mr." as a separator, the CSV output escapes the comma with a backslash
(`Achaval\,Mr.`).

The following examples pass reader properties through the `outputMimeType` field:

- [CSV example](https://docs.mulesoft.com/dataweave/2.11/dataweave-formats-csv#example2) that uses `streaming=true; header=true`

- [JSON example](https://docs.mulesoft.com/dataweave/2.11/dataweave-formats-json#example3) that uses `streaming=true`

## See Also

- [DataWeave Formats](https://docs.mulesoft.com/dataweave/2.11/dataweave-formats)

- [Core Components](https://docs.mulesoft.com/mule-runtime/latest/about-components)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook)

<!-- document id=2f08ce12ca3eb8360048ab99c8a781277904780d3afec263a8093dad48960ddf url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook-reader-prop-connector.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, transform, transformer, format, dataweave, data weave, output structure, mime type, mime
---

# Use a Reader Property through a Connector Operation

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Connector operations that read input data provide an `outpuMimeType` field that you can use to
identify the _input_ MIME type. This field also accepts one or more reader properties, which is
useful for helping DataWeave read the input correctly.

By default, the DataWeave reader treats a comma (`,`) as a separator. However, assume that a CSV
input is separated by the pipe (`|`) but that the content also contains commas. You can set a CSV
reader property to recognize the pipe as the separator.

Pipe-separated CSV Input

```csv
id | name | role
1234 | Shokida,Mr. | dev
2345 | Achaval,Mr. | arch
3456 | Felisatti,Ms. | mngr
4567 | Chibana,Mr. | dev
```

The following example uses the Read operation in the File connector to read the pipe-separated (`|`)
CSV input, and it uses a DataWeave script in the Transform Message component to output a row of the
input in comma-separated format.

Mule Flow:

```xml
<flow name="ex-use-csv-reader-props" >
	<scheduler doc:name="Scheduler" >
		<scheduling-strategy >
			<fixed-frequency frequency="90" timeUnit="SECONDS"/>
		</scheduling-strategy>
	</scheduler>
	<file:read doc:name="Read" config-ref="File_Config" path="staff.csv"
	           outputMimeType='application/csv; separator=|; header=true'/>
	<ee:transform doc:name="Transform Message" >
		<ee:message>
			<ee:set-payload><![CDATA[%dw 2.0
output application/csv header = false
---
payload[1]]]></ee:set-payload>
		</ee:message>
	</ee:transform>
	<logger level="INFO" doc:name="Logger" message="#[payload]"/>
</flow>
```

The Scheduler component (`<scheduler/>`) in the example generates a Mule event each time it triggers
the flow.

The Read operation (`<file:read/>`) uses
`outputMimeType='application/csv; separator=|; header=true'` to identify the input MIME type
(`application/csv`), the CSV separator (`|`), and the header setting (`true`).

The script in the Transform Message component (`<ee:transform-message/>`) returns the second row
from the input CSV (`2345 , Achaval\,Mr. , arch`). The script uses `payload[1]` to select that row
because DataWeave treats each row in the CSV as an index of an array. The output is comma-separated
because the default CSV separator is a comma. The script omits the CSV header from the output by
using the `output` directive (`output application/csv header = false`).

The Logger component (`<logger/>`), which is set to `payload`, writes the comma-separated output as
INFO in its `LoggerMessageProcessor` message: `2345 , Achaval\,Mr. , arch`. To avoid treating the
comma before "Mr." as a separator, the CSV output escapes the comma with a backslash
(`Achaval\,Mr.`).

The following examples pass reader properties through the `outputMimeType` field:

- [CSV example](https://docs.mulesoft.com/dataweave/2.12/dataweave-formats-csv#example2) that uses `streaming=true; header=true`

- [JSON example](https://docs.mulesoft.com/dataweave/2.12/dataweave-formats-json#example3) that uses `streaming=true`

## See Also

- [DataWeave Formats](https://docs.mulesoft.com/dataweave/2.12/dataweave-formats)

- [Core Components](https://docs.mulesoft.com/mule-runtime/latest/about-components)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook)

<!-- document id=ab736e7106ed7c8778b2c7452cc53246484cd8742dc49e8a7378edfd9f6c5765 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook-reader-prop-connector.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, transform, transformer, format, dataweave, data weave, output structure, mime type, mime
---

# Use a Reader Property through a Connector Operation

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Connector operations that read input data provide an `outpuMimeType` field that you can use to
identify the _input_ MIME type. This field also accepts one or more reader properties, which is
useful for helping DataWeave read the input correctly.

By default, the DataWeave reader treats a comma (`,`) as a separator. However, assume that a CSV
input is separated by the pipe (`|`) but that the content also contains commas. You can set a CSV
reader property to recognize the pipe as the separator.

Pipe-separated CSV Input

```csv
id | name | role
1234 | Shokida,Mr. | dev
2345 | Achaval,Mr. | arch
3456 | Felisatti,Ms. | mngr
4567 | Chibana,Mr. | dev
```

The following example uses the Read operation in the File connector to read the pipe-separated (`|`)
CSV input, and it uses a DataWeave script in the Transform Message component to output a row of the
input in comma-separated format.

Mule Flow:

```xml
<flow name="ex-use-csv-reader-props" >
	<scheduler doc:name="Scheduler" >
		<scheduling-strategy >
			<fixed-frequency frequency="90" timeUnit="SECONDS"/>
		</scheduling-strategy>
	</scheduler>
	<file:read doc:name="Read" config-ref="File_Config" path="staff.csv"
	           outputMimeType='application/csv; separator=|; header=true'/>
	<ee:transform doc:name="Transform Message" >
		<ee:message>
			<ee:set-payload><![CDATA[%dw 2.0
output application/csv header = false
---
payload[1]]]></ee:set-payload>
		</ee:message>
	</ee:transform>
	<logger level="INFO" doc:name="Logger" message="#[payload]"/>
</flow>
```

The Scheduler component (`<scheduler/>`) in the example generates a Mule event each time it triggers
the flow.

The Read operation (`<file:read/>`) uses
`outputMimeType='application/csv; separator=|; header=true'` to identify the input MIME type
(`application/csv`), the CSV separator (`|`), and the header setting (`true`).

The script in the Transform Message component (`<ee:transform-message/>`) returns the second row
from the input CSV (`2345 , Achaval\,Mr. , arch`). The script uses `payload[1]` to select that row
because DataWeave treats each row in the CSV as an index of an array. The output is comma-separated
because the default CSV separator is a comma. The script omits the CSV header from the output by
using the `output` directive (`output application/csv header = false`).

The Logger component (`<logger/>`), which is set to `payload`, writes the comma-separated output as
INFO in its `LoggerMessageProcessor` message: `2345 , Achaval\,Mr. , arch`. To avoid treating the
comma before "Mr." as a separator, the CSV output escapes the comma with a backslash
(`Achaval\,Mr.`).

The following examples pass reader properties through the `outputMimeType` field:

- [CSV example](https://docs.mulesoft.com/dataweave/2.4/dataweave-formats-csv#example2) that uses `streaming=true; header=true`

- [JSON example](https://docs.mulesoft.com/dataweave/2.4/dataweave-formats-json#example3) that uses `streaming=true`

## See Also

- [DataWeave Formats](https://docs.mulesoft.com/dataweave/2.4/dataweave-formats)

- [Core Components](https://docs.mulesoft.com/mule-runtime/latest/about-components)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook)

<!-- document id=e488de0d881c5753c7633174a8c71af2cc52de48dbc11a40f2a933f354627d39 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook-reader-prop-connector.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, transform, transformer, format, dataweave, data weave, output structure, mime type, mime
---

# Use a Reader Property through a Connector Operation

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Connector operations that read input data provide an `outpuMimeType` field that you can use to
identify the _input_ MIME type. This field also accepts one or more reader properties, which is
useful for helping DataWeave read the input correctly.

By default, the DataWeave reader treats a comma (`,`) as a separator. However, assume that a CSV
input is separated by the pipe (`|`) but that the content also contains commas. You can set a CSV
reader property to recognize the pipe as the separator.

Pipe-separated CSV Input

```csv
id | name | role
1234 | Shokida,Mr. | dev
2345 | Achaval,Mr. | arch
3456 | Felisatti,Ms. | mngr
4567 | Chibana,Mr. | dev
```

The following example uses the Read operation in the File connector to read the pipe-separated (`|`)
CSV input, and it uses a DataWeave script in the Transform Message component to output a row of the
input in comma-separated format.

Mule Flow:

```xml
<flow name="ex-use-csv-reader-props" >
	<scheduler doc:name="Scheduler" >
		<scheduling-strategy >
			<fixed-frequency frequency="90" timeUnit="SECONDS"/>
		</scheduling-strategy>
	</scheduler>
	<file:read doc:name="Read" config-ref="File_Config" path="staff.csv"
	           outputMimeType='application/csv; separator=|; header=true'/>
	<ee:transform doc:name="Transform Message" >
		<ee:message>
			<ee:set-payload><![CDATA[%dw 2.0
output application/csv header = false
---
payload[1]]]></ee:set-payload>
		</ee:message>
	</ee:transform>
	<logger level="INFO" doc:name="Logger" message="#[payload]"/>
</flow>
```

The Scheduler component (`<scheduler/>`) in the example generates a Mule event each time it triggers
the flow.

The Read operation (`<file:read/>`) uses
`outputMimeType='application/csv; separator=|; header=true'` to identify the input MIME type
(`application/csv`), the CSV separator (`|`), and the header setting (`true`).

The script in the Transform Message component (`<ee:transform-message/>`) returns the second row
from the input CSV (`2345 , Achaval\,Mr. , arch`). The script uses `payload[1]` to select that row
because DataWeave treats each row in the CSV as an index of an array. The output is comma-separated
because the default CSV separator is a comma. The script omits the CSV header from the output by
using the `output` directive (`output application/csv header = false`).

The Logger component (`<logger/>`), which is set to `payload`, writes the comma-separated output as
INFO in its `LoggerMessageProcessor` message: `2345 , Achaval\,Mr. , arch`. To avoid treating the
comma before "Mr." as a separator, the CSV output escapes the comma with a backslash
(`Achaval\,Mr.`).

The following examples pass reader properties through the `outputMimeType` field:

- [CSV example](https://docs.mulesoft.com/dataweave/2.6/dataweave-formats-csv#example2) that uses `streaming=true; header=true`

- [JSON example](https://docs.mulesoft.com/dataweave/2.6/dataweave-formats-json#example3) that uses `streaming=true`

## See Also

- [DataWeave Formats](https://docs.mulesoft.com/dataweave/2.6/dataweave-formats)

- [Core Components](https://docs.mulesoft.com/mule-runtime/latest/about-components)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook)

<!-- document id=48cab64e770027f3e1928bd9cf157575857eb1a5b1587144a657d4f04f025717 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook-reader-prop-connector.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, transform, transformer, format, dataweave, data weave, output structure, mime type, mime
---

# Use a Reader Property through a Connector Operation

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Connector operations that read input data provide an `outpuMimeType` field that you can use to
identify the _input_ MIME type. This field also accepts one or more reader properties, which is
useful for helping DataWeave read the input correctly.

By default, the DataWeave reader treats a comma (`,`) as a separator. However, assume that a CSV
input is separated by the pipe (`|`) but that the content also contains commas. You can set a CSV
reader property to recognize the pipe as the separator.

Pipe-separated CSV Input

```csv
id | name | role
1234 | Shokida,Mr. | dev
2345 | Achaval,Mr. | arch
3456 | Felisatti,Ms. | mngr
4567 | Chibana,Mr. | dev
```

The following example uses the Read operation in the File connector to read the pipe-separated (`|`)
CSV input, and it uses a DataWeave script in the Transform Message component to output a row of the
input in comma-separated format.

Mule Flow:

```xml
<flow name="ex-use-csv-reader-props" >
	<scheduler doc:name="Scheduler" >
		<scheduling-strategy >
			<fixed-frequency frequency="90" timeUnit="SECONDS"/>
		</scheduling-strategy>
	</scheduler>
	<file:read doc:name="Read" config-ref="File_Config" path="staff.csv"
	           outputMimeType='application/csv; separator=|; header=true'/>
	<ee:transform doc:name="Transform Message" >
		<ee:message>
			<ee:set-payload><![CDATA[%dw 2.0
output application/csv header = false
---
payload[1]]]></ee:set-payload>
		</ee:message>
	</ee:transform>
	<logger level="INFO" doc:name="Logger" message="#[payload]"/>
</flow>
```

The Scheduler component (`<scheduler/>`) in the example generates a Mule event each time it triggers
the flow.

The Read operation (`<file:read/>`) uses
`outputMimeType='application/csv; separator=|; header=true'` to identify the input MIME type
(`application/csv`), the CSV separator (`|`), and the header setting (`true`).

The script in the Transform Message component (`<ee:transform-message/>`) returns the second row
from the input CSV (`2345 , Achaval\,Mr. , arch`). The script uses `payload[1]` to select that row
because DataWeave treats each row in the CSV as an index of an array. The output is comma-separated
because the default CSV separator is a comma. The script omits the CSV header from the output by
using the `output` directive (`output application/csv header = false`).

The Logger component (`<logger/>`), which is set to `payload`, writes the comma-separated output as
INFO in its `LoggerMessageProcessor` message: `2345 , Achaval\,Mr. , arch`. To avoid treating the
comma before "Mr." as a separator, the CSV output escapes the comma with a backslash
(`Achaval\,Mr.`).

The following examples pass reader properties through the `outputMimeType` field:

- [CSV example](https://docs.mulesoft.com/dataweave/2.9/dataweave-formats-csv#example2) that uses `streaming=true; header=true`

- [JSON example](https://docs.mulesoft.com/dataweave/2.9/dataweave-formats-json#example3) that uses `streaming=true`

## See Also

- [DataWeave Formats](https://docs.mulesoft.com/dataweave/2.9/dataweave-formats)

- [Core Components](https://docs.mulesoft.com/mule-runtime/latest/about-components)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook)

<!-- document id=8cbbc4e4a52a83e96af2fbd3b95d27af6a5bde666b1ae32ef15600f7d3183621 url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook-reader-prop-connector.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, transform, transformer, format, dataweave, data weave, output structure, mime type, mime
---

# Use a Reader Property through a Connector Operation

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Connector operations that read input data provide an `outpuMimeType` field that you can use to
identify the _input_ MIME type. This field also accepts one or more reader properties, which is
useful for helping DataWeave read the input correctly.

By default, the DataWeave reader treats a comma (`,`) as a separator. However, assume that a CSV
input is separated by the pipe (`|`) but that the content also contains commas. You can set a CSV
reader property to recognize the pipe as the separator.

Pipe-separated CSV Input

```csv
id | name | role
1234 | Shokida,Mr. | dev
2345 | Achaval,Mr. | arch
3456 | Felisatti,Ms. | mngr
4567 | Chibana,Mr. | dev
```

The following example uses the Read operation in the File connector to read the pipe-separated (`|`)
CSV input, and it uses a DataWeave script in the Transform Message component to output a row of the
input in comma-separated format.

Mule Flow:

```xml
<flow name="ex-use-csv-reader-props" >
	<scheduler doc:name="Scheduler" >
		<scheduling-strategy >
			<fixed-frequency frequency="90" timeUnit="SECONDS"/>
		</scheduling-strategy>
	</scheduler>
	<file:read doc:name="Read" config-ref="File_Config" path="staff.csv"
	           outputMimeType='application/csv; separator=|; header=true'/>
	<ee:transform doc:name="Transform Message" >
		<ee:message>
			<ee:set-payload><![CDATA[%dw 2.0
output application/csv header = false
---
payload[1]]]></ee:set-payload>
		</ee:message>
	</ee:transform>
	<logger level="INFO" doc:name="Logger" message="#[payload]"/>
</flow>
```

The Scheduler component (`<scheduler/>`) in the example generates a Mule event each time it triggers
the flow.

The Read operation (`<file:read/>`) uses
`outputMimeType='application/csv; separator=|; header=true'` to identify the input MIME type
(`application/csv`), the CSV separator (`|`), and the header setting (`true`).

The script in the Transform Message component (`<ee:transform-message/>`) returns the second row
from the input CSV (`2345 , Achaval\,Mr. , arch`). The script uses `payload[1]` to select that row
because DataWeave treats each row in the CSV as an index of an array. The output is comma-separated
because the default CSV separator is a comma. The script omits the CSV header from the output by
using the `output` directive (`output application/csv header = false`).

The Logger component (`<logger/>`), which is set to `payload`, writes the comma-separated output as
INFO in its `LoggerMessageProcessor` message: `2345 , Achaval\,Mr. , arch`. To avoid treating the
comma before "Mr." as a separator, the CSV output escapes the comma with a backslash
(`Achaval\,Mr.`).

The following examples pass reader properties through the `outputMimeType` field:

- [CSV example](https://docs.mulesoft.com/dataweave/latest/dataweave-formats-csv#example2) that uses `streaming=true; header=true`

- [JSON example](https://docs.mulesoft.com/dataweave/latest/dataweave-formats-json#example3) that uses `streaming=true`

## See Also

- [DataWeave Formats](https://docs.mulesoft.com/dataweave/latest/dataweave-formats)

- [Core Components](https://docs.mulesoft.com/mule-runtime/latest/about-components)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook)

<!-- document id=4535bd7b3cccc67312ae1e0fe61f5d1ca2ad34fec6a6ca48449bbede2d573b49 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook-use-constant-directives.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, concatenate,
---

# Use Constant Directives

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example builds URLs from constants that are defined as variables (`var`) in the
DataWeave header. It also conditionally outputs fields if they are present in the input.

The example uses these functions:

- `++` (concatenate) to build constant directives into URLs.

- `map` to go through the fields in the input.

- `if` to output `summary` and `brand` fields.

DataWeave Script:

```dataweave
%dw 2.0
var baseUrl = "http://alainn-cosmetics.cloudhub.io/api/v1.0"
var urlPage = "http://alainn-cosmetics.cloudhub.io/api/v1.0/items"
var fullUrl = "http://alainn-cosmetics.cloudhub.io/api/v1.0/items"
var pageIndex = 0
var requestedPageSize = 4
output application/json
---
using (pageSize = payload.getItemsResponse.PageInfo.pageSize) {
     links: [
        {
            href: fullUrl,
            rel : "self"
        },
        {
            href: urlPage ++ "?pageIndex=" ++ (pageIndex + pageSize) ++ "&pageSize=" ++ requestedPageSize,
            rel: "next"
        },
        ({
            href: urlPage ++ "?pageIndex=" ++ (pageIndex - pageSize) ++ "&pageSize=" ++ requestedPageSize,
            rel: "prev"
        }) if(pageIndex > 0)
     ],
     collection: {
        size: pageSize,
        items: payload.getItemsResponse.*Item map (item) -> {
            id: item.id,
            'type': item.'type',
            name: item.name,
            (summary: item.summary) if(item.summary?),
            (brand: item.brand) if(item.brand?),
            links: (item.images.*image map (image) -> {
                href: trim(image),
                rel: image.@'type'
            }) + {
                href: baseUrl ++ "/" ++ item.id,
                rel: "self"
            }
        }
     }
}
```

Input XML Payload:

```xml
<ns0:getItemsResponse xmlns:ns0="http://www.alainn.com/SOA/message/1.0">
    <ns0:PageInfo>
        <pageIndex>0</pageIndex>
        <pageSize>5</pageSize>
    </ns0:PageInfo>
    <ns1:Item xmlns:ns1="http://www.alainn.com/SOA/model/1.0">
        <id>B0015BYNRO</id>
        <type>Oils</type>
        <name>Now Foods LANOLIN PURE</name>
        <images>
            <image type="SwatchImage">http://ecx.images-amazon.com/images/I/11Qoe774Q4L._SL30_.jpg
            </image>
        </images>
    </ns1:Item>
    <ns1:Item xmlns:ns1="http://www.alainn.com/SOA/model/1.0">
        <id>B002K8AD02</id>
        <type>Bubble Bath</type>
        <name>Deep Steep Honey Bubble Bath</name>
        <summary>Disclaimer: This website is for informational purposes only.
            Always check the actual product label in your possession for the most
            accurate ingredient information due to product changes or upgrades
            that may not yet be reflected on our web site. These statements made
            in this website have not been evaluated by the Food and Drug
            Administration. The products offered are not intended to diagnose,
            treat
        </summary>
        <images>
            <image type="SwatchImage">http://ecx.images-amazon.com/images/I/216ytnMOeXL._SL30_.jpg
            </image>
        </images>
    </ns1:Item>
    <ns1:Item xmlns:ns1="http://www.alainn.com/SOA/model/1.0">
        <id>B000I206JK</id>
        <type>Oils</type>
        <name>Now Foods Castor Oil</name>
        <summary>One of the finest natural skin emollients available</summary>
        <images>
            <image type="SwatchImage">http://ecx.images-amazon.com/images/I/21Yz8q-yQoL._SL30_.jpg
            </image>
        </images>
    </ns1:Item>
    <ns1:Item xmlns:ns1="http://www.alainn.com/SOA/model/1.0">
        <id>B003Y5XF2S</id>
        <type>Chemical Hair Dyes</type>
        <name>Manic Panic Semi-Permanent Color Cream</name>
        <summary>Ready to use, no mixing required</summary>
        <images>
            <image type="SwatchImage">http://ecx.images-amazon.com/images/I/51A2FuX27dL._SL30_.jpg
            </image>
        </images>
    </ns1:Item>
    <ns1:Item xmlns:ns1="http://www.alainn.com/SOA/model/1.0">
        <id>B0016BELU2</id>
        <type>Chemical Hair Dyes</type>
        <name>Herbatint Herbatint Permanent Chestnut (4n)</name>
        <images>
            <image type="SwatchImage">http://ecx.images-amazon.com/images/I/21woUiM0BdL._SL30_.jpg
            </image>
        </images>
    </ns1:Item>
</ns0:getItemsResponse>
```

Output JSON:

```json
{
  "links": [
    {
      "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/items",
      "rel": "self"
    },
    {
      "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/items?pageIndex=5&pageSize=4",
      "rel": "next"
    }
  ],
  "collection": {
    "size": "5",
    "items": [
      {
        "id": "B0015BYNRO",
        "type": "Oils",
        "name": "Now Foods LANOLIN PURE",
        "links": [
          {
            "href": "http://ecx.images-amazon.com/images/I/11Qoe774Q4L._SL30_.jpg",
            "rel": "SwatchImage"
          },
          {
            "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/B0015BYNRO",
            "rel": "self"
          }
        ]
      },
      {
        "id": "B002K8AD02",
        "type": "Bubble Bath",
        "name": "Deep Steep Honey Bubble Bath",
        "summary": "Disclaimer: This website is for informational purposes only.\n            Always check the actual product label in your possession for the most\n            accurate ingredient information due to product changes or upgrades\n            that may not yet be reflected on our web site. These statements made\n            in this website have not been evaluated by the Food and Drug\n            Administration. The products offered are not intended to diagnose,\n            treat\n        ",
        "links": [
          {
            "href": "http://ecx.images-amazon.com/images/I/216ytnMOeXL._SL30_.jpg",
            "rel": "SwatchImage"
          },
          {
            "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/B002K8AD02",
            "rel": "self"
          }
        ]
      },
      {
        "id": "B000I206JK",
        "type": "Oils",
        "name": "Now Foods Castor Oil",
        "summary": "One of the finest natural skin emollients available",
        "links": [
          {
            "href": "http://ecx.images-amazon.com/images/I/21Yz8q-yQoL._SL30_.jpg",
            "rel": "SwatchImage"
          },
          {
            "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/B000I206JK",
            "rel": "self"
          }
        ]
      },
      {
        "id": "B003Y5XF2S",
        "type": "Chemical Hair Dyes",
        "name": "Manic Panic Semi-Permanent Color Cream",
        "summary": "Ready to use, no mixing required",
        "links": [
          {
            "href": "http://ecx.images-amazon.com/images/I/51A2FuX27dL._SL30_.jpg",
            "rel": "SwatchImage"
          },
          {
            "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/B003Y5XF2S",
            "rel": "self"
          }
        ]
      },
      {
        "id": "B0016BELU2",
        "type": "Chemical Hair Dyes",
        "name": "Herbatint Herbatint Permanent Chestnut (4n)",
        "links": [
          {
            "href": "http://ecx.images-amazon.com/images/I/21woUiM0BdL._SL30_.jpg",
            "rel": "SwatchImage"
          },
          {
            "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/B0016BELU2",
            "rel": "self"
          }
        ]
      }
    ]
  }
}
```

## Related Examples

- [Define a Custom Addition Function](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-define-a-custom-addition-function)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-conditional-list-reduction-via-function)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.11/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook)

<!-- document id=99bde76258d358fe7ed18a6f3273c92cce02ada498cf9497909771f1cc4abe39 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook-use-constant-directives.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, concatenate,
---

# Use Constant Directives

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example builds URLs from constants that are defined as variables (`var`) in the
DataWeave header. It also conditionally outputs fields if they are present in the input.

The example uses these functions:

- `++` (concatenate) to build constant directives into URLs.

- `map` to go through the fields in the input.

- `if` to output `summary` and `brand` fields.

DataWeave Script:

```dataweave
%dw 2.0
var baseUrl = "http://alainn-cosmetics.cloudhub.io/api/v1.0"
var urlPage = "http://alainn-cosmetics.cloudhub.io/api/v1.0/items"
var fullUrl = "http://alainn-cosmetics.cloudhub.io/api/v1.0/items"
var pageIndex = 0
var requestedPageSize = 4
output application/json
---
using (pageSize = payload.getItemsResponse.PageInfo.pageSize) {
     links: [
        {
            href: fullUrl,
            rel : "self"
        },
        {
            href: urlPage ++ "?pageIndex=" ++ (pageIndex + pageSize) ++ "&pageSize=" ++ requestedPageSize,
            rel: "next"
        },
        ({
            href: urlPage ++ "?pageIndex=" ++ (pageIndex - pageSize) ++ "&pageSize=" ++ requestedPageSize,
            rel: "prev"
        }) if(pageIndex > 0)
     ],
     collection: {
        size: pageSize,
        items: payload.getItemsResponse.*Item map (item) -> {
            id: item.id,
            'type': item.'type',
            name: item.name,
            (summary: item.summary) if(item.summary?),
            (brand: item.brand) if(item.brand?),
            links: (item.images.*image map (image) -> {
                href: trim(image),
                rel: image.@'type'
            }) + {
                href: baseUrl ++ "/" ++ item.id,
                rel: "self"
            }
        }
     }
}
```

Input XML Payload:

```xml
<ns0:getItemsResponse xmlns:ns0="http://www.alainn.com/SOA/message/1.0">
    <ns0:PageInfo>
        <pageIndex>0</pageIndex>
        <pageSize>5</pageSize>
    </ns0:PageInfo>
    <ns1:Item xmlns:ns1="http://www.alainn.com/SOA/model/1.0">
        <id>B0015BYNRO</id>
        <type>Oils</type>
        <name>Now Foods LANOLIN PURE</name>
        <images>
            <image type="SwatchImage">http://ecx.images-amazon.com/images/I/11Qoe774Q4L._SL30_.jpg
            </image>
        </images>
    </ns1:Item>
    <ns1:Item xmlns:ns1="http://www.alainn.com/SOA/model/1.0">
        <id>B002K8AD02</id>
        <type>Bubble Bath</type>
        <name>Deep Steep Honey Bubble Bath</name>
        <summary>Disclaimer: This website is for informational purposes only.
            Always check the actual product label in your possession for the most
            accurate ingredient information due to product changes or upgrades
            that may not yet be reflected on our web site. These statements made
            in this website have not been evaluated by the Food and Drug
            Administration. The products offered are not intended to diagnose,
            treat
        </summary>
        <images>
            <image type="SwatchImage">http://ecx.images-amazon.com/images/I/216ytnMOeXL._SL30_.jpg
            </image>
        </images>
    </ns1:Item>
    <ns1:Item xmlns:ns1="http://www.alainn.com/SOA/model/1.0">
        <id>B000I206JK</id>
        <type>Oils</type>
        <name>Now Foods Castor Oil</name>
        <summary>One of the finest natural skin emollients available</summary>
        <images>
            <image type="SwatchImage">http://ecx.images-amazon.com/images/I/21Yz8q-yQoL._SL30_.jpg
            </image>
        </images>
    </ns1:Item>
    <ns1:Item xmlns:ns1="http://www.alainn.com/SOA/model/1.0">
        <id>B003Y5XF2S</id>
        <type>Chemical Hair Dyes</type>
        <name>Manic Panic Semi-Permanent Color Cream</name>
        <summary>Ready to use, no mixing required</summary>
        <images>
            <image type="SwatchImage">http://ecx.images-amazon.com/images/I/51A2FuX27dL._SL30_.jpg
            </image>
        </images>
    </ns1:Item>
    <ns1:Item xmlns:ns1="http://www.alainn.com/SOA/model/1.0">
        <id>B0016BELU2</id>
        <type>Chemical Hair Dyes</type>
        <name>Herbatint Herbatint Permanent Chestnut (4n)</name>
        <images>
            <image type="SwatchImage">http://ecx.images-amazon.com/images/I/21woUiM0BdL._SL30_.jpg
            </image>
        </images>
    </ns1:Item>
</ns0:getItemsResponse>
```

Output JSON:

```json
{
  "links": [
    {
      "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/items",
      "rel": "self"
    },
    {
      "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/items?pageIndex=5&pageSize=4",
      "rel": "next"
    }
  ],
  "collection": {
    "size": "5",
    "items": [
      {
        "id": "B0015BYNRO",
        "type": "Oils",
        "name": "Now Foods LANOLIN PURE",
        "links": [
          {
            "href": "http://ecx.images-amazon.com/images/I/11Qoe774Q4L._SL30_.jpg",
            "rel": "SwatchImage"
          },
          {
            "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/B0015BYNRO",
            "rel": "self"
          }
        ]
      },
      {
        "id": "B002K8AD02",
        "type": "Bubble Bath",
        "name": "Deep Steep Honey Bubble Bath",
        "summary": "Disclaimer: This website is for informational purposes only.\n            Always check the actual product label in your possession for the most\n            accurate ingredient information due to product changes or upgrades\n            that may not yet be reflected on our web site. These statements made\n            in this website have not been evaluated by the Food and Drug\n            Administration. The products offered are not intended to diagnose,\n            treat\n        ",
        "links": [
          {
            "href": "http://ecx.images-amazon.com/images/I/216ytnMOeXL._SL30_.jpg",
            "rel": "SwatchImage"
          },
          {
            "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/B002K8AD02",
            "rel": "self"
          }
        ]
      },
      {
        "id": "B000I206JK",
        "type": "Oils",
        "name": "Now Foods Castor Oil",
        "summary": "One of the finest natural skin emollients available",
        "links": [
          {
            "href": "http://ecx.images-amazon.com/images/I/21Yz8q-yQoL._SL30_.jpg",
            "rel": "SwatchImage"
          },
          {
            "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/B000I206JK",
            "rel": "self"
          }
        ]
      },
      {
        "id": "B003Y5XF2S",
        "type": "Chemical Hair Dyes",
        "name": "Manic Panic Semi-Permanent Color Cream",
        "summary": "Ready to use, no mixing required",
        "links": [
          {
            "href": "http://ecx.images-amazon.com/images/I/51A2FuX27dL._SL30_.jpg",
            "rel": "SwatchImage"
          },
          {
            "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/B003Y5XF2S",
            "rel": "self"
          }
        ]
      },
      {
        "id": "B0016BELU2",
        "type": "Chemical Hair Dyes",
        "name": "Herbatint Herbatint Permanent Chestnut (4n)",
        "links": [
          {
            "href": "http://ecx.images-amazon.com/images/I/21woUiM0BdL._SL30_.jpg",
            "rel": "SwatchImage"
          },
          {
            "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/B0016BELU2",
            "rel": "self"
          }
        ]
      }
    ]
  }
}
```

## Related Examples

- [Define a Custom Addition Function](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-define-a-custom-addition-function)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-conditional-list-reduction-via-function)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.12/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook)

<!-- document id=4599a1c68fe06720afea56f78ab4068edd0c5709d0d9c86491db6e559bcef055 url=/mulesoft/current/en-us/dataweave/2.3/dataweave-cookbook-use-constant-directives.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, concatenate,
---

# Use Constant Directives

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example builds URLs from constants that are defined as variables (`var`) in the
DataWeave header. It also conditionally outputs fields if they are present in the input.

The example uses these functions:

- `++` (concatenate) to build constant directives into URLs.

- `map` to go through the fields in the input.

- `if` to output `summary` and `brand` fields.

DataWeave Script:

```dataweave
%dw 2.0
var baseUrl = "http://alainn-cosmetics.cloudhub.io/api/v1.0"
var urlPage = "http://alainn-cosmetics.cloudhub.io/api/v1.0/items"
var fullUrl = "http://alainn-cosmetics.cloudhub.io/api/v1.0/items"
var pageIndex = 0
var requestedPageSize = 4
output application/json
---
using (pageSize = payload.getItemsResponse.PageInfo.pageSize) {
     links: [
        {
            href: fullUrl,
            rel : "self"
        },
        {
            href: urlPage ++ "?pageIndex=" ++ (pageIndex + pageSize) ++ "&pageSize=" ++ requestedPageSize,
            rel: "next"
        },
        ({
            href: urlPage ++ "?pageIndex=" ++ (pageIndex - pageSize) ++ "&pageSize=" ++ requestedPageSize,
            rel: "prev"
        }) if(pageIndex > 0)
     ],
     collection: {
        size: pageSize,
        items: payload.getItemsResponse.*Item map (item) -> {
            id: item.id,
            'type': item.'type',
            name: item.name,
            (summary: item.summary) if(item.summary?),
            (brand: item.brand) if(item.brand?),
            links: (item.images.*image map (image) -> {
                href: trim(image),
                rel: image.@'type'
            }) + {
                href: baseUrl ++ "/" ++ item.id,
                rel: "self"
            }
        }
     }
}
```

Input XML Payload:

```xml
<ns0:getItemsResponse xmlns:ns0="http://www.alainn.com/SOA/message/1.0">
    <ns0:PageInfo>
        <pageIndex>0</pageIndex>
        <pageSize>5</pageSize>
    </ns0:PageInfo>
    <ns1:Item xmlns:ns1="http://www.alainn.com/SOA/model/1.0">
        <id>B0015BYNRO</id>
        <type>Oils</type>
        <name>Now Foods LANOLIN PURE</name>
        <images>
            <image type="SwatchImage">http://ecx.images-amazon.com/images/I/11Qoe774Q4L._SL30_.jpg
            </image>
        </images>
    </ns1:Item>
    <ns1:Item xmlns:ns1="http://www.alainn.com/SOA/model/1.0">
        <id>B002K8AD02</id>
        <type>Bubble Bath</type>
        <name>Deep Steep Honey Bubble Bath</name>
        <summary>Disclaimer: This website is for informational purposes only.
            Always check the actual product label in your possession for the most
            accurate ingredient information due to product changes or upgrades
            that may not yet be reflected on our web site. These statements made
            in this website have not been evaluated by the Food and Drug
            Administration. The products offered are not intended to diagnose,
            treat
        </summary>
        <images>
            <image type="SwatchImage">http://ecx.images-amazon.com/images/I/216ytnMOeXL._SL30_.jpg
            </image>
        </images>
    </ns1:Item>
    <ns1:Item xmlns:ns1="http://www.alainn.com/SOA/model/1.0">
        <id>B000I206JK</id>
        <type>Oils</type>
        <name>Now Foods Castor Oil</name>
        <summary>One of the finest natural skin emollients available</summary>
        <images>
            <image type="SwatchImage">http://ecx.images-amazon.com/images/I/21Yz8q-yQoL._SL30_.jpg
            </image>
        </images>
    </ns1:Item>
    <ns1:Item xmlns:ns1="http://www.alainn.com/SOA/model/1.0">
        <id>B003Y5XF2S</id>
        <type>Chemical Hair Dyes</type>
        <name>Manic Panic Semi-Permanent Color Cream</name>
        <summary>Ready to use, no mixing required</summary>
        <images>
            <image type="SwatchImage">http://ecx.images-amazon.com/images/I/51A2FuX27dL._SL30_.jpg
            </image>
        </images>
    </ns1:Item>
    <ns1:Item xmlns:ns1="http://www.alainn.com/SOA/model/1.0">
        <id>B0016BELU2</id>
        <type>Chemical Hair Dyes</type>
        <name>Herbatint Herbatint Permanent Chestnut (4n)</name>
        <images>
            <image type="SwatchImage">http://ecx.images-amazon.com/images/I/21woUiM0BdL._SL30_.jpg
            </image>
        </images>
    </ns1:Item>
</ns0:getItemsResponse>
```

Output JSON:

```json
{
  "links": [
    {
      "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/items",
      "rel": "self"
    },
    {
      "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/items?pageIndex=5&pageSize=4",
      "rel": "next"
    }
  ],
  "collection": {
    "size": "5",
    "items": [
      {
        "id": "B0015BYNRO",
        "type": "Oils",
        "name": "Now Foods LANOLIN PURE",
        "links": [
          {
            "href": "http://ecx.images-amazon.com/images/I/11Qoe774Q4L._SL30_.jpg",
            "rel": "SwatchImage"
          },
          {
            "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/B0015BYNRO",
            "rel": "self"
          }
        ]
      },
      {
        "id": "B002K8AD02",
        "type": "Bubble Bath",
        "name": "Deep Steep Honey Bubble Bath",
        "summary": "Disclaimer: This website is for informational purposes only.\n            Always check the actual product label in your possession for the most\n            accurate ingredient information due to product changes or upgrades\n            that may not yet be reflected on our web site. These statements made\n            in this website have not been evaluated by the Food and Drug\n            Administration. The products offered are not intended to diagnose,\n            treat\n        ",
        "links": [
          {
            "href": "http://ecx.images-amazon.com/images/I/216ytnMOeXL._SL30_.jpg",
            "rel": "SwatchImage"
          },
          {
            "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/B002K8AD02",
            "rel": "self"
          }
        ]
      },
      {
        "id": "B000I206JK",
        "type": "Oils",
        "name": "Now Foods Castor Oil",
        "summary": "One of the finest natural skin emollients available",
        "links": [
          {
            "href": "http://ecx.images-amazon.com/images/I/21Yz8q-yQoL._SL30_.jpg",
            "rel": "SwatchImage"
          },
          {
            "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/B000I206JK",
            "rel": "self"
          }
        ]
      },
      {
        "id": "B003Y5XF2S",
        "type": "Chemical Hair Dyes",
        "name": "Manic Panic Semi-Permanent Color Cream",
        "summary": "Ready to use, no mixing required",
        "links": [
          {
            "href": "http://ecx.images-amazon.com/images/I/51A2FuX27dL._SL30_.jpg",
            "rel": "SwatchImage"
          },
          {
            "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/B003Y5XF2S",
            "rel": "self"
          }
        ]
      },
      {
        "id": "B0016BELU2",
        "type": "Chemical Hair Dyes",
        "name": "Herbatint Herbatint Permanent Chestnut (4n)",
        "links": [
          {
            "href": "http://ecx.images-amazon.com/images/I/21woUiM0BdL._SL30_.jpg",
            "rel": "SwatchImage"
          },
          {
            "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/B0016BELU2",
            "rel": "self"
          }
        ]
      }
    ]
  }
}
```

## Related Examples

- [Define a Custom Addition Function](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-define-a-custom-addition-function)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-conditional-list-reduction-via-function)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.3/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook)

<!-- document id=2f4100347e18868148b40f580a93cde2b7e7cddd77ae75ce4b0b8e077cc90045 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook-use-constant-directives.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, concatenate,
---

# Use Constant Directives

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example builds URLs from constants that are defined as variables (`var`) in the
DataWeave header. It also conditionally outputs fields if they are present in the input.

The example uses these functions:

- `++` (concatenate) to build constant directives into URLs.

- `map` to go through the fields in the input.

- `if` to output `summary` and `brand` fields.

DataWeave Script:

```dataweave
%dw 2.0
var baseUrl = "http://alainn-cosmetics.cloudhub.io/api/v1.0"
var urlPage = "http://alainn-cosmetics.cloudhub.io/api/v1.0/items"
var fullUrl = "http://alainn-cosmetics.cloudhub.io/api/v1.0/items"
var pageIndex = 0
var requestedPageSize = 4
output application/json
---
using (pageSize = payload.getItemsResponse.PageInfo.pageSize) {
     links: [
        {
            href: fullUrl,
            rel : "self"
        },
        {
            href: urlPage ++ "?pageIndex=" ++ (pageIndex + pageSize) ++ "&pageSize=" ++ requestedPageSize,
            rel: "next"
        },
        ({
            href: urlPage ++ "?pageIndex=" ++ (pageIndex - pageSize) ++ "&pageSize=" ++ requestedPageSize,
            rel: "prev"
        }) if(pageIndex > 0)
     ],
     collection: {
        size: pageSize,
        items: payload.getItemsResponse.*Item map (item) -> {
            id: item.id,
            'type': item.'type',
            name: item.name,
            (summary: item.summary) if(item.summary?),
            (brand: item.brand) if(item.brand?),
            links: (item.images.*image map (image) -> {
                href: trim(image),
                rel: image.@'type'
            }) + {
                href: baseUrl ++ "/" ++ item.id,
                rel: "self"
            }
        }
     }
}
```

Input XML Payload:

```xml
<ns0:getItemsResponse xmlns:ns0="http://www.alainn.com/SOA/message/1.0">
    <ns0:PageInfo>
        <pageIndex>0</pageIndex>
        <pageSize>5</pageSize>
    </ns0:PageInfo>
    <ns1:Item xmlns:ns1="http://www.alainn.com/SOA/model/1.0">
        <id>B0015BYNRO</id>
        <type>Oils</type>
        <name>Now Foods LANOLIN PURE</name>
        <images>
            <image type="SwatchImage">http://ecx.images-amazon.com/images/I/11Qoe774Q4L._SL30_.jpg
            </image>
        </images>
    </ns1:Item>
    <ns1:Item xmlns:ns1="http://www.alainn.com/SOA/model/1.0">
        <id>B002K8AD02</id>
        <type>Bubble Bath</type>
        <name>Deep Steep Honey Bubble Bath</name>
        <summary>Disclaimer: This website is for informational purposes only.
            Always check the actual product label in your possession for the most
            accurate ingredient information due to product changes or upgrades
            that may not yet be reflected on our web site. These statements made
            in this website have not been evaluated by the Food and Drug
            Administration. The products offered are not intended to diagnose,
            treat
        </summary>
        <images>
            <image type="SwatchImage">http://ecx.images-amazon.com/images/I/216ytnMOeXL._SL30_.jpg
            </image>
        </images>
    </ns1:Item>
    <ns1:Item xmlns:ns1="http://www.alainn.com/SOA/model/1.0">
        <id>B000I206JK</id>
        <type>Oils</type>
        <name>Now Foods Castor Oil</name>
        <summary>One of the finest natural skin emollients available</summary>
        <images>
            <image type="SwatchImage">http://ecx.images-amazon.com/images/I/21Yz8q-yQoL._SL30_.jpg
            </image>
        </images>
    </ns1:Item>
    <ns1:Item xmlns:ns1="http://www.alainn.com/SOA/model/1.0">
        <id>B003Y5XF2S</id>
        <type>Chemical Hair Dyes</type>
        <name>Manic Panic Semi-Permanent Color Cream</name>
        <summary>Ready to use, no mixing required</summary>
        <images>
            <image type="SwatchImage">http://ecx.images-amazon.com/images/I/51A2FuX27dL._SL30_.jpg
            </image>
        </images>
    </ns1:Item>
    <ns1:Item xmlns:ns1="http://www.alainn.com/SOA/model/1.0">
        <id>B0016BELU2</id>
        <type>Chemical Hair Dyes</type>
        <name>Herbatint Herbatint Permanent Chestnut (4n)</name>
        <images>
            <image type="SwatchImage">http://ecx.images-amazon.com/images/I/21woUiM0BdL._SL30_.jpg
            </image>
        </images>
    </ns1:Item>
</ns0:getItemsResponse>
```

Output JSON:

```json
{
  "links": [
    {
      "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/items",
      "rel": "self"
    },
    {
      "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/items?pageIndex=5&pageSize=4",
      "rel": "next"
    }
  ],
  "collection": {
    "size": "5",
    "items": [
      {
        "id": "B0015BYNRO",
        "type": "Oils",
        "name": "Now Foods LANOLIN PURE",
        "links": [
          {
            "href": "http://ecx.images-amazon.com/images/I/11Qoe774Q4L._SL30_.jpg",
            "rel": "SwatchImage"
          },
          {
            "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/B0015BYNRO",
            "rel": "self"
          }
        ]
      },
      {
        "id": "B002K8AD02",
        "type": "Bubble Bath",
        "name": "Deep Steep Honey Bubble Bath",
        "summary": "Disclaimer: This website is for informational purposes only.\n            Always check the actual product label in your possession for the most\n            accurate ingredient information due to product changes or upgrades\n            that may not yet be reflected on our web site. These statements made\n            in this website have not been evaluated by the Food and Drug\n            Administration. The products offered are not intended to diagnose,\n            treat\n        ",
        "links": [
          {
            "href": "http://ecx.images-amazon.com/images/I/216ytnMOeXL._SL30_.jpg",
            "rel": "SwatchImage"
          },
          {
            "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/B002K8AD02",
            "rel": "self"
          }
        ]
      },
      {
        "id": "B000I206JK",
        "type": "Oils",
        "name": "Now Foods Castor Oil",
        "summary": "One of the finest natural skin emollients available",
        "links": [
          {
            "href": "http://ecx.images-amazon.com/images/I/21Yz8q-yQoL._SL30_.jpg",
            "rel": "SwatchImage"
          },
          {
            "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/B000I206JK",
            "rel": "self"
          }
        ]
      },
      {
        "id": "B003Y5XF2S",
        "type": "Chemical Hair Dyes",
        "name": "Manic Panic Semi-Permanent Color Cream",
        "summary": "Ready to use, no mixing required",
        "links": [
          {
            "href": "http://ecx.images-amazon.com/images/I/51A2FuX27dL._SL30_.jpg",
            "rel": "SwatchImage"
          },
          {
            "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/B003Y5XF2S",
            "rel": "self"
          }
        ]
      },
      {
        "id": "B0016BELU2",
        "type": "Chemical Hair Dyes",
        "name": "Herbatint Herbatint Permanent Chestnut (4n)",
        "links": [
          {
            "href": "http://ecx.images-amazon.com/images/I/21woUiM0BdL._SL30_.jpg",
            "rel": "SwatchImage"
          },
          {
            "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/B0016BELU2",
            "rel": "self"
          }
        ]
      }
    ]
  }
}
```

## Related Examples

- [Define a Custom Addition Function](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-define-a-custom-addition-function)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-conditional-list-reduction-via-function)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.4/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook)

<!-- document id=2fb7b2686271f0459bd823d9c822939b8b0100445085da246492a735c0ef5262 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook-use-constant-directives.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, concatenate,
---

# Use Constant Directives

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example builds URLs from constants that are defined as variables (`var`) in the
DataWeave header. It also conditionally outputs fields if they are present in the input.

The example uses these functions:

- `++` (concatenate) to build constant directives into URLs.

- `map` to go through the fields in the input.

- `if` to output `summary` and `brand` fields.

DataWeave Script:

```dataweave
%dw 2.0
var baseUrl = "http://alainn-cosmetics.cloudhub.io/api/v1.0"
var urlPage = "http://alainn-cosmetics.cloudhub.io/api/v1.0/items"
var fullUrl = "http://alainn-cosmetics.cloudhub.io/api/v1.0/items"
var pageIndex = 0
var requestedPageSize = 4
output application/json
---
using (pageSize = payload.getItemsResponse.PageInfo.pageSize) {
     links: [
        {
            href: fullUrl,
            rel : "self"
        },
        {
            href: urlPage ++ "?pageIndex=" ++ (pageIndex + pageSize) ++ "&pageSize=" ++ requestedPageSize,
            rel: "next"
        },
        ({
            href: urlPage ++ "?pageIndex=" ++ (pageIndex - pageSize) ++ "&pageSize=" ++ requestedPageSize,
            rel: "prev"
        }) if(pageIndex > 0)
     ],
     collection: {
        size: pageSize,
        items: payload.getItemsResponse.*Item map (item) -> {
            id: item.id,
            'type': item.'type',
            name: item.name,
            (summary: item.summary) if(item.summary?),
            (brand: item.brand) if(item.brand?),
            links: (item.images.*image map (image) -> {
                href: trim(image),
                rel: image.@'type'
            }) + {
                href: baseUrl ++ "/" ++ item.id,
                rel: "self"
            }
        }
     }
}
```

Input XML Payload:

```xml
<ns0:getItemsResponse xmlns:ns0="http://www.alainn.com/SOA/message/1.0">
    <ns0:PageInfo>
        <pageIndex>0</pageIndex>
        <pageSize>5</pageSize>
    </ns0:PageInfo>
    <ns1:Item xmlns:ns1="http://www.alainn.com/SOA/model/1.0">
        <id>B0015BYNRO</id>
        <type>Oils</type>
        <name>Now Foods LANOLIN PURE</name>
        <images>
            <image type="SwatchImage">http://ecx.images-amazon.com/images/I/11Qoe774Q4L._SL30_.jpg
            </image>
        </images>
    </ns1:Item>
    <ns1:Item xmlns:ns1="http://www.alainn.com/SOA/model/1.0">
        <id>B002K8AD02</id>
        <type>Bubble Bath</type>
        <name>Deep Steep Honey Bubble Bath</name>
        <summary>Disclaimer: This website is for informational purposes only.
            Always check the actual product label in your possession for the most
            accurate ingredient information due to product changes or upgrades
            that may not yet be reflected on our web site. These statements made
            in this website have not been evaluated by the Food and Drug
            Administration. The products offered are not intended to diagnose,
            treat
        </summary>
        <images>
            <image type="SwatchImage">http://ecx.images-amazon.com/images/I/216ytnMOeXL._SL30_.jpg
            </image>
        </images>
    </ns1:Item>
    <ns1:Item xmlns:ns1="http://www.alainn.com/SOA/model/1.0">
        <id>B000I206JK</id>
        <type>Oils</type>
        <name>Now Foods Castor Oil</name>
        <summary>One of the finest natural skin emollients available</summary>
        <images>
            <image type="SwatchImage">http://ecx.images-amazon.com/images/I/21Yz8q-yQoL._SL30_.jpg
            </image>
        </images>
    </ns1:Item>
    <ns1:Item xmlns:ns1="http://www.alainn.com/SOA/model/1.0">
        <id>B003Y5XF2S</id>
        <type>Chemical Hair Dyes</type>
        <name>Manic Panic Semi-Permanent Color Cream</name>
        <summary>Ready to use, no mixing required</summary>
        <images>
            <image type="SwatchImage">http://ecx.images-amazon.com/images/I/51A2FuX27dL._SL30_.jpg
            </image>
        </images>
    </ns1:Item>
    <ns1:Item xmlns:ns1="http://www.alainn.com/SOA/model/1.0">
        <id>B0016BELU2</id>
        <type>Chemical Hair Dyes</type>
        <name>Herbatint Herbatint Permanent Chestnut (4n)</name>
        <images>
            <image type="SwatchImage">http://ecx.images-amazon.com/images/I/21woUiM0BdL._SL30_.jpg
            </image>
        </images>
    </ns1:Item>
</ns0:getItemsResponse>
```

Output JSON:

```json
{
  "links": [
    {
      "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/items",
      "rel": "self"
    },
    {
      "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/items?pageIndex=5&pageSize=4",
      "rel": "next"
    }
  ],
  "collection": {
    "size": "5",
    "items": [
      {
        "id": "B0015BYNRO",
        "type": "Oils",
        "name": "Now Foods LANOLIN PURE",
        "links": [
          {
            "href": "http://ecx.images-amazon.com/images/I/11Qoe774Q4L._SL30_.jpg",
            "rel": "SwatchImage"
          },
          {
            "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/B0015BYNRO",
            "rel": "self"
          }
        ]
      },
      {
        "id": "B002K8AD02",
        "type": "Bubble Bath",
        "name": "Deep Steep Honey Bubble Bath",
        "summary": "Disclaimer: This website is for informational purposes only.\n            Always check the actual product label in your possession for the most\n            accurate ingredient information due to product changes or upgrades\n            that may not yet be reflected on our web site. These statements made\n            in this website have not been evaluated by the Food and Drug\n            Administration. The products offered are not intended to diagnose,\n            treat\n        ",
        "links": [
          {
            "href": "http://ecx.images-amazon.com/images/I/216ytnMOeXL._SL30_.jpg",
            "rel": "SwatchImage"
          },
          {
            "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/B002K8AD02",
            "rel": "self"
          }
        ]
      },
      {
        "id": "B000I206JK",
        "type": "Oils",
        "name": "Now Foods Castor Oil",
        "summary": "One of the finest natural skin emollients available",
        "links": [
          {
            "href": "http://ecx.images-amazon.com/images/I/21Yz8q-yQoL._SL30_.jpg",
            "rel": "SwatchImage"
          },
          {
            "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/B000I206JK",
            "rel": "self"
          }
        ]
      },
      {
        "id": "B003Y5XF2S",
        "type": "Chemical Hair Dyes",
        "name": "Manic Panic Semi-Permanent Color Cream",
        "summary": "Ready to use, no mixing required",
        "links": [
          {
            "href": "http://ecx.images-amazon.com/images/I/51A2FuX27dL._SL30_.jpg",
            "rel": "SwatchImage"
          },
          {
            "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/B003Y5XF2S",
            "rel": "self"
          }
        ]
      },
      {
        "id": "B0016BELU2",
        "type": "Chemical Hair Dyes",
        "name": "Herbatint Herbatint Permanent Chestnut (4n)",
        "links": [
          {
            "href": "http://ecx.images-amazon.com/images/I/21woUiM0BdL._SL30_.jpg",
            "rel": "SwatchImage"
          },
          {
            "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/B0016BELU2",
            "rel": "self"
          }
        ]
      }
    ]
  }
}
```

## Related Examples

- [Define a Custom Addition Function](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-define-a-custom-addition-function)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-conditional-list-reduction-via-function)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.6/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook)

<!-- document id=00aa53e88e8b2f9dc2f80a384d7733e26613e0bd89ffffbf43458698a4bd4a98 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook-use-constant-directives.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, concatenate,
---

# Use Constant Directives

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example builds URLs from constants that are defined as variables (`var`) in the
DataWeave header. It also conditionally outputs fields if they are present in the input.

The example uses these functions:

- `++` (concatenate) to build constant directives into URLs.

- `map` to go through the fields in the input.

- `if` to output `summary` and `brand` fields.

DataWeave Script:

```dataweave
%dw 2.0
var baseUrl = "http://alainn-cosmetics.cloudhub.io/api/v1.0"
var urlPage = "http://alainn-cosmetics.cloudhub.io/api/v1.0/items"
var fullUrl = "http://alainn-cosmetics.cloudhub.io/api/v1.0/items"
var pageIndex = 0
var requestedPageSize = 4
output application/json
---
using (pageSize = payload.getItemsResponse.PageInfo.pageSize) {
     links: [
        {
            href: fullUrl,
            rel : "self"
        },
        {
            href: urlPage ++ "?pageIndex=" ++ (pageIndex + pageSize) ++ "&pageSize=" ++ requestedPageSize,
            rel: "next"
        },
        ({
            href: urlPage ++ "?pageIndex=" ++ (pageIndex - pageSize) ++ "&pageSize=" ++ requestedPageSize,
            rel: "prev"
        }) if(pageIndex > 0)
     ],
     collection: {
        size: pageSize,
        items: payload.getItemsResponse.*Item map (item) -> {
            id: item.id,
            'type': item.'type',
            name: item.name,
            (summary: item.summary) if(item.summary?),
            (brand: item.brand) if(item.brand?),
            links: (item.images.*image map (image) -> {
                href: trim(image),
                rel: image.@'type'
            }) + {
                href: baseUrl ++ "/" ++ item.id,
                rel: "self"
            }
        }
     }
}
```

Input XML Payload:

```xml
<ns0:getItemsResponse xmlns:ns0="http://www.alainn.com/SOA/message/1.0">
    <ns0:PageInfo>
        <pageIndex>0</pageIndex>
        <pageSize>5</pageSize>
    </ns0:PageInfo>
    <ns1:Item xmlns:ns1="http://www.alainn.com/SOA/model/1.0">
        <id>B0015BYNRO</id>
        <type>Oils</type>
        <name>Now Foods LANOLIN PURE</name>
        <images>
            <image type="SwatchImage">http://ecx.images-amazon.com/images/I/11Qoe774Q4L._SL30_.jpg
            </image>
        </images>
    </ns1:Item>
    <ns1:Item xmlns:ns1="http://www.alainn.com/SOA/model/1.0">
        <id>B002K8AD02</id>
        <type>Bubble Bath</type>
        <name>Deep Steep Honey Bubble Bath</name>
        <summary>Disclaimer: This website is for informational purposes only.
            Always check the actual product label in your possession for the most
            accurate ingredient information due to product changes or upgrades
            that may not yet be reflected on our web site. These statements made
            in this website have not been evaluated by the Food and Drug
            Administration. The products offered are not intended to diagnose,
            treat
        </summary>
        <images>
            <image type="SwatchImage">http://ecx.images-amazon.com/images/I/216ytnMOeXL._SL30_.jpg
            </image>
        </images>
    </ns1:Item>
    <ns1:Item xmlns:ns1="http://www.alainn.com/SOA/model/1.0">
        <id>B000I206JK</id>
        <type>Oils</type>
        <name>Now Foods Castor Oil</name>
        <summary>One of the finest natural skin emollients available</summary>
        <images>
            <image type="SwatchImage">http://ecx.images-amazon.com/images/I/21Yz8q-yQoL._SL30_.jpg
            </image>
        </images>
    </ns1:Item>
    <ns1:Item xmlns:ns1="http://www.alainn.com/SOA/model/1.0">
        <id>B003Y5XF2S</id>
        <type>Chemical Hair Dyes</type>
        <name>Manic Panic Semi-Permanent Color Cream</name>
        <summary>Ready to use, no mixing required</summary>
        <images>
            <image type="SwatchImage">http://ecx.images-amazon.com/images/I/51A2FuX27dL._SL30_.jpg
            </image>
        </images>
    </ns1:Item>
    <ns1:Item xmlns:ns1="http://www.alainn.com/SOA/model/1.0">
        <id>B0016BELU2</id>
        <type>Chemical Hair Dyes</type>
        <name>Herbatint Herbatint Permanent Chestnut (4n)</name>
        <images>
            <image type="SwatchImage">http://ecx.images-amazon.com/images/I/21woUiM0BdL._SL30_.jpg
            </image>
        </images>
    </ns1:Item>
</ns0:getItemsResponse>
```

Output JSON:

```json
{
  "links": [
    {
      "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/items",
      "rel": "self"
    },
    {
      "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/items?pageIndex=5&pageSize=4",
      "rel": "next"
    }
  ],
  "collection": {
    "size": "5",
    "items": [
      {
        "id": "B0015BYNRO",
        "type": "Oils",
        "name": "Now Foods LANOLIN PURE",
        "links": [
          {
            "href": "http://ecx.images-amazon.com/images/I/11Qoe774Q4L._SL30_.jpg",
            "rel": "SwatchImage"
          },
          {
            "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/B0015BYNRO",
            "rel": "self"
          }
        ]
      },
      {
        "id": "B002K8AD02",
        "type": "Bubble Bath",
        "name": "Deep Steep Honey Bubble Bath",
        "summary": "Disclaimer: This website is for informational purposes only.\n            Always check the actual product label in your possession for the most\n            accurate ingredient information due to product changes or upgrades\n            that may not yet be reflected on our web site. These statements made\n            in this website have not been evaluated by the Food and Drug\n            Administration. The products offered are not intended to diagnose,\n            treat\n        ",
        "links": [
          {
            "href": "http://ecx.images-amazon.com/images/I/216ytnMOeXL._SL30_.jpg",
            "rel": "SwatchImage"
          },
          {
            "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/B002K8AD02",
            "rel": "self"
          }
        ]
      },
      {
        "id": "B000I206JK",
        "type": "Oils",
        "name": "Now Foods Castor Oil",
        "summary": "One of the finest natural skin emollients available",
        "links": [
          {
            "href": "http://ecx.images-amazon.com/images/I/21Yz8q-yQoL._SL30_.jpg",
            "rel": "SwatchImage"
          },
          {
            "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/B000I206JK",
            "rel": "self"
          }
        ]
      },
      {
        "id": "B003Y5XF2S",
        "type": "Chemical Hair Dyes",
        "name": "Manic Panic Semi-Permanent Color Cream",
        "summary": "Ready to use, no mixing required",
        "links": [
          {
            "href": "http://ecx.images-amazon.com/images/I/51A2FuX27dL._SL30_.jpg",
            "rel": "SwatchImage"
          },
          {
            "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/B003Y5XF2S",
            "rel": "self"
          }
        ]
      },
      {
        "id": "B0016BELU2",
        "type": "Chemical Hair Dyes",
        "name": "Herbatint Herbatint Permanent Chestnut (4n)",
        "links": [
          {
            "href": "http://ecx.images-amazon.com/images/I/21woUiM0BdL._SL30_.jpg",
            "rel": "SwatchImage"
          },
          {
            "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/B0016BELU2",
            "rel": "self"
          }
        ]
      }
    ]
  }
}
```

## Related Examples

- [Define a Custom Addition Function](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-define-a-custom-addition-function)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-conditional-list-reduction-via-function)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.9/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook)

<!-- document id=555fa13d5abacc182be60587f812485933eb7db97dfe191298bf7a182cea722a url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook-use-constant-directives.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, xml, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, concatenate,
---

# Use Constant Directives

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example builds URLs from constants that are defined as variables (`var`) in the
DataWeave header. It also conditionally outputs fields if they are present in the input.

The example uses these functions:

- `++` (concatenate) to build constant directives into URLs.

- `map` to go through the fields in the input.

- `if` to output `summary` and `brand` fields.

DataWeave Script:

```dataweave
%dw 2.0
var baseUrl = "http://alainn-cosmetics.cloudhub.io/api/v1.0"
var urlPage = "http://alainn-cosmetics.cloudhub.io/api/v1.0/items"
var fullUrl = "http://alainn-cosmetics.cloudhub.io/api/v1.0/items"
var pageIndex = 0
var requestedPageSize = 4
output application/json
---
using (pageSize = payload.getItemsResponse.PageInfo.pageSize) {
     links: [
        {
            href: fullUrl,
            rel : "self"
        },
        {
            href: urlPage ++ "?pageIndex=" ++ (pageIndex + pageSize) ++ "&pageSize=" ++ requestedPageSize,
            rel: "next"
        },
        ({
            href: urlPage ++ "?pageIndex=" ++ (pageIndex - pageSize) ++ "&pageSize=" ++ requestedPageSize,
            rel: "prev"
        }) if(pageIndex > 0)
     ],
     collection: {
        size: pageSize,
        items: payload.getItemsResponse.*Item map (item) -> {
            id: item.id,
            'type': item.'type',
            name: item.name,
            (summary: item.summary) if(item.summary?),
            (brand: item.brand) if(item.brand?),
            links: (item.images.*image map (image) -> {
                href: trim(image),
                rel: image.@'type'
            }) + {
                href: baseUrl ++ "/" ++ item.id,
                rel: "self"
            }
        }
     }
}
```

Input XML Payload:

```xml
<ns0:getItemsResponse xmlns:ns0="http://www.alainn.com/SOA/message/1.0">
    <ns0:PageInfo>
        <pageIndex>0</pageIndex>
        <pageSize>5</pageSize>
    </ns0:PageInfo>
    <ns1:Item xmlns:ns1="http://www.alainn.com/SOA/model/1.0">
        <id>B0015BYNRO</id>
        <type>Oils</type>
        <name>Now Foods LANOLIN PURE</name>
        <images>
            <image type="SwatchImage">http://ecx.images-amazon.com/images/I/11Qoe774Q4L._SL30_.jpg
            </image>
        </images>
    </ns1:Item>
    <ns1:Item xmlns:ns1="http://www.alainn.com/SOA/model/1.0">
        <id>B002K8AD02</id>
        <type>Bubble Bath</type>
        <name>Deep Steep Honey Bubble Bath</name>
        <summary>Disclaimer: This website is for informational purposes only.
            Always check the actual product label in your possession for the most
            accurate ingredient information due to product changes or upgrades
            that may not yet be reflected on our web site. These statements made
            in this website have not been evaluated by the Food and Drug
            Administration. The products offered are not intended to diagnose,
            treat
        </summary>
        <images>
            <image type="SwatchImage">http://ecx.images-amazon.com/images/I/216ytnMOeXL._SL30_.jpg
            </image>
        </images>
    </ns1:Item>
    <ns1:Item xmlns:ns1="http://www.alainn.com/SOA/model/1.0">
        <id>B000I206JK</id>
        <type>Oils</type>
        <name>Now Foods Castor Oil</name>
        <summary>One of the finest natural skin emollients available</summary>
        <images>
            <image type="SwatchImage">http://ecx.images-amazon.com/images/I/21Yz8q-yQoL._SL30_.jpg
            </image>
        </images>
    </ns1:Item>
    <ns1:Item xmlns:ns1="http://www.alainn.com/SOA/model/1.0">
        <id>B003Y5XF2S</id>
        <type>Chemical Hair Dyes</type>
        <name>Manic Panic Semi-Permanent Color Cream</name>
        <summary>Ready to use, no mixing required</summary>
        <images>
            <image type="SwatchImage">http://ecx.images-amazon.com/images/I/51A2FuX27dL._SL30_.jpg
            </image>
        </images>
    </ns1:Item>
    <ns1:Item xmlns:ns1="http://www.alainn.com/SOA/model/1.0">
        <id>B0016BELU2</id>
        <type>Chemical Hair Dyes</type>
        <name>Herbatint Herbatint Permanent Chestnut (4n)</name>
        <images>
            <image type="SwatchImage">http://ecx.images-amazon.com/images/I/21woUiM0BdL._SL30_.jpg
            </image>
        </images>
    </ns1:Item>
</ns0:getItemsResponse>
```

Output JSON:

```json
{
  "links": [
    {
      "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/items",
      "rel": "self"
    },
    {
      "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/items?pageIndex=5&pageSize=4",
      "rel": "next"
    }
  ],
  "collection": {
    "size": "5",
    "items": [
      {
        "id": "B0015BYNRO",
        "type": "Oils",
        "name": "Now Foods LANOLIN PURE",
        "links": [
          {
            "href": "http://ecx.images-amazon.com/images/I/11Qoe774Q4L._SL30_.jpg",
            "rel": "SwatchImage"
          },
          {
            "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/B0015BYNRO",
            "rel": "self"
          }
        ]
      },
      {
        "id": "B002K8AD02",
        "type": "Bubble Bath",
        "name": "Deep Steep Honey Bubble Bath",
        "summary": "Disclaimer: This website is for informational purposes only.\n            Always check the actual product label in your possession for the most\n            accurate ingredient information due to product changes or upgrades\n            that may not yet be reflected on our web site. These statements made\n            in this website have not been evaluated by the Food and Drug\n            Administration. The products offered are not intended to diagnose,\n            treat\n        ",
        "links": [
          {
            "href": "http://ecx.images-amazon.com/images/I/216ytnMOeXL._SL30_.jpg",
            "rel": "SwatchImage"
          },
          {
            "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/B002K8AD02",
            "rel": "self"
          }
        ]
      },
      {
        "id": "B000I206JK",
        "type": "Oils",
        "name": "Now Foods Castor Oil",
        "summary": "One of the finest natural skin emollients available",
        "links": [
          {
            "href": "http://ecx.images-amazon.com/images/I/21Yz8q-yQoL._SL30_.jpg",
            "rel": "SwatchImage"
          },
          {
            "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/B000I206JK",
            "rel": "self"
          }
        ]
      },
      {
        "id": "B003Y5XF2S",
        "type": "Chemical Hair Dyes",
        "name": "Manic Panic Semi-Permanent Color Cream",
        "summary": "Ready to use, no mixing required",
        "links": [
          {
            "href": "http://ecx.images-amazon.com/images/I/51A2FuX27dL._SL30_.jpg",
            "rel": "SwatchImage"
          },
          {
            "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/B003Y5XF2S",
            "rel": "self"
          }
        ]
      },
      {
        "id": "B0016BELU2",
        "type": "Chemical Hair Dyes",
        "name": "Herbatint Herbatint Permanent Chestnut (4n)",
        "links": [
          {
            "href": "http://ecx.images-amazon.com/images/I/21woUiM0BdL._SL30_.jpg",
            "rel": "SwatchImage"
          },
          {
            "href": "http://alainn-cosmetics.cloudhub.io/api/v1.0/B0016BELU2",
            "rel": "self"
          }
        ]
      }
    ]
  }
}
```

## Related Examples

- [Define a Custom Addition Function](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-define-a-custom-addition-function)

- [Conditionally Reduce a List through a Function](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-conditional-list-reduction-via-function)

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook)

<!-- document id=8fe0646e9af92a2723c9c5cda85090ce2aa934dc26faaa2d12f321d251be91ef url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook-writer-prop-mule.md -->

---
product: DataWeave
version: 2.11
---

# Use Dynamic Writer Properties

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following example shows a Mule flow that transforms comma-separated CSV data into pipe-separated
(`|`) CSV data. Instead of setting a literal value in the script, the example selects the pipe value
from a [Mule variable](https://docs.mulesoft.com/mule-runtime/latest/about-mule-variables), which is part of a Mule
event that travels through data-processing components in the flow. The example uses the DataWeave
writer function in the body of the script to change the comma-separated input to pipe-separated
output.

The Scheduler component (`<scheduler/>`) in the example generates a Mule event each time it triggers
the flow.

The Set Variable component (`<set-variable/>`) creates a Mule variable named `delimiter` with the
value `'|'`. In Studio, the value is created as an **fx** expression (`value="#['|']"`), rather than
a simple string (`value="'|'"`).

The Transform Message component (`<ee:transform-message/>`) contains a DataWeave script that reads
comma-separated CSV input and uses the Mule variable to write pipe-separated CSV output.

The Logger component (`<logger/>`), which is set to `payload`, writes the pipe-separated output as
INFO in its `LoggerMessageProcessor` message: `macaroni | rigatoni | ravioli | spaghetti`.

Mule Flow:

```xml
<flow name="ex-use-mule-var-as-prop-config-val" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="45" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <set-variable value="#['|']" doc:name="Set Variable" variableName="delimiter" />
  <ee:transform doc:name="Transform Message" >
    <ee:message>
      <ee:set-payload><![CDATA[%dw 2.0
var myVar = read("macaroni , rigatoni , ravioli , spaghetti", "application/csv" , {"header":false, separator:','})
output application/csv with binary
---
write(myVar, "application/csv", {"header":false, "separator":vars.delimiter})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
  <logger level="INFO" doc:name="Logger" message="#[payload]"/>
</flow>
```

To provide comma-separated input for the example, the script in the Transform Message component uses
a [read](https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-read) function as a value to a DataWeave variable, `myVar`:

`var myVar = read("macaroni , rigatoni , ravioli , spaghetti", "application/csv" , {"header":false, separator:','})`

To write pipe-separated output, the DataWeave [write](https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-write) function in the body
of the script changes the comma-separated input to pipe-separated output. To select the pipe value
from the Mule variable (`delimiter`), the function passes the writer property configuration
`"separator":vars.delimiter` as an argument:

`write(myVar, "application/csv", {"header":false, "separator":vars.delimiter})`

The script uses the following DataWeave `output` directive in the script’s header:
`output application/csv with binary`. It is necessary to append the `with binary` setting
([introduced in Mule 4.3.0](https://docs.mulesoft.com/dataweave/2.11/dataweave-formats#set_mime_types)) to invoke the binary writer because
the `write` function returned CSV output. Without the setting, DataWeave would attempt to write CSV
again and produce the following issue:
`CSV Structure should be an Array<Object> or Object but got String, while writing CSV.`

Note that if you want to see pipe-separated content from the Tranform Message component’s
**Preview** screen in the Studio UI, you must create sample data for it:

1.  Double-click the Transform Message component from the **Message Flow** area of the Studio app.

2.  Right-click **delimiter: _String_** in the **Context** tab, which is located on the bottom left
    of the configuration UI for the component.

3.  Select **Edit Sample Data** to open a **vars-delimiter** tab.

4.  Replace any content in the **vars-delimiter** with the following sample data for the `delimiter`
    value: `"|"`. You must put the delimiter in quotation marks.

For further guidance with sample data, see
[Previewing the Output of a Transformation](https://docs.mulesoft.com/mule-runtime/latest/transform-preview-transformation-output-studio-task).

## See Also

- [DataWeave Formats](https://docs.mulesoft.com/dataweave/2.11/dataweave-formats)

- [Core Components](https://docs.mulesoft.com/mule-runtime/latest/about-components)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook)

<!-- document id=234ed90806058e59c65f638bc5e928a12b2429b11cc1745ff60791fa53381ecf url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook-writer-prop-mule.md -->

---
product: DataWeave
version: 2.12
---

# Use Dynamic Writer Properties

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following example shows a Mule flow that transforms comma-separated CSV data into pipe-separated
(`|`) CSV data. Instead of setting a literal value in the script, the example selects the pipe value
from a [Mule variable](https://docs.mulesoft.com/mule-runtime/latest/about-mule-variables), which is part of a Mule
event that travels through data-processing components in the flow. The example uses the DataWeave
writer function in the body of the script to change the comma-separated input to pipe-separated
output.

The Scheduler component (`<scheduler/>`) in the example generates a Mule event each time it triggers
the flow.

The Set Variable component (`<set-variable/>`) creates a Mule variable named `delimiter` with the
value `'|'`. In Studio, the value is created as an **fx** expression (`value="#['|']"`), rather than
a simple string (`value="'|'"`).

The Transform Message component (`<ee:transform-message/>`) contains a DataWeave script that reads
comma-separated CSV input and uses the Mule variable to write pipe-separated CSV output.

The Logger component (`<logger/>`), which is set to `payload`, writes the pipe-separated output as
INFO in its `LoggerMessageProcessor` message: `macaroni | rigatoni | ravioli | spaghetti`.

Mule Flow:

```xml
<flow name="ex-use-mule-var-as-prop-config-val" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="45" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <set-variable value="#['|']" doc:name="Set Variable" variableName="delimiter" />
  <ee:transform doc:name="Transform Message" >
    <ee:message>
      <ee:set-payload><![CDATA[%dw 2.0
var myVar = read("macaroni , rigatoni , ravioli , spaghetti", "application/csv" , {"header":false, separator:','})
output application/csv with binary
---
write(myVar, "application/csv", {"header":false, "separator":vars.delimiter})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
  <logger level="INFO" doc:name="Logger" message="#[payload]"/>
</flow>
```

To provide comma-separated input for the example, the script in the Transform Message component uses
a [read](https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-read) function as a value to a DataWeave variable, `myVar`:

`var myVar = read("macaroni , rigatoni , ravioli , spaghetti", "application/csv" , {"header":false, separator:','})`

To write pipe-separated output, the DataWeave [write](https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-write) function in the body
of the script changes the comma-separated input to pipe-separated output. To select the pipe value
from the Mule variable (`delimiter`), the function passes the writer property configuration
`"separator":vars.delimiter` as an argument:

`write(myVar, "application/csv", {"header":false, "separator":vars.delimiter})`

The script uses the following DataWeave `output` directive in the script’s header:
`output application/csv with binary`. It is necessary to append the `with binary` setting
([introduced in Mule 4.3.0](https://docs.mulesoft.com/dataweave/2.12/dataweave-formats#set_mime_types)) to invoke the binary writer because
the `write` function returned CSV output. Without the setting, DataWeave would attempt to write CSV
again and produce the following issue:
`CSV Structure should be an Array<Object> or Object but got String, while writing CSV.`

Note that if you want to see pipe-separated content from the Tranform Message component’s
**Preview** screen in the Studio UI, you must create sample data for it:

1.  Double-click the Transform Message component from the **Message Flow** area of the Studio app.

2.  Right-click **delimiter: _String_** in the **Context** tab, which is located on the bottom left
    of the configuration UI for the component.

3.  Select **Edit Sample Data** to open a **vars-delimiter** tab.

4.  Replace any content in the **vars-delimiter** with the following sample data for the `delimiter`
    value: `"|"`. You must put the delimiter in quotation marks.

For further guidance with sample data, see
[Previewing the Output of a Transformation](https://docs.mulesoft.com/mule-runtime/latest/transform-preview-transformation-output-studio-task).

## See Also

- [DataWeave Formats](https://docs.mulesoft.com/dataweave/2.12/dataweave-formats)

- [Core Components](https://docs.mulesoft.com/mule-runtime/latest/about-components)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook)

<!-- document id=86ca566cf1dbfa101e0c745801c4b5c1d08cc473c7b918568697c49035e308be url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook-writer-prop-mule.md -->

---
product: DataWeave
version: 2.4
---

# Use Dynamic Writer Properties

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following example shows a Mule flow that transforms comma-separated CSV data into pipe-separated
(`|`) CSV data. Instead of setting a literal value in the script, the example selects the pipe value
from a [Mule variable](https://docs.mulesoft.com/mule-runtime/latest/about-mule-variables), which is part of a Mule
event that travels through data-processing components in the flow. The example uses the DataWeave
writer function in the body of the script to change the comma-separated input to pipe-separated
output.

The Scheduler component (`<scheduler/>`) in the example generates a Mule event each time it triggers
the flow.

The Set Variable component (`<set-variable/>`) creates a Mule variable named `delimiter` with the
value `'|'`. In Studio, the value is created as an **fx** expression (`value="#['|']"`), rather than
a simple string (`value="'|'"`).

The Transform Message component (`<ee:transform-message/>`) contains a DataWeave script that reads
comma-separated CSV input and uses the Mule variable to write pipe-separated CSV output.

The Logger component (`<logger/>`), which is set to `payload`, writes the pipe-separated output as
INFO in its `LoggerMessageProcessor` message: `macaroni | rigatoni | ravioli | spaghetti`.

Mule Flow:

```xml
<flow name="ex-use-mule-var-as-prop-config-val" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="45" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <set-variable value="#['|']" doc:name="Set Variable" variableName="delimiter" />
  <ee:transform doc:name="Transform Message" >
    <ee:message>
      <ee:set-payload><![CDATA[%dw 2.0
var myVar = read("macaroni , rigatoni , ravioli , spaghetti", "application/csv" , {"header":false, separator:','})
output application/csv with binary
---
write(myVar, "application/csv", {"header":false, "separator":vars.delimiter})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
  <logger level="INFO" doc:name="Logger" message="#[payload]"/>
</flow>
```

To provide comma-separated input for the example, the script in the Transform Message component uses
a [read](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-read) function as a value to a DataWeave variable, `myVar`:

`var myVar = read("macaroni , rigatoni , ravioli , spaghetti", "application/csv" , {"header":false, separator:','})`

To write pipe-separated output, the DataWeave [write](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-write) function in the body
of the script changes the comma-separated input to pipe-separated output. To select the pipe value
from the Mule variable (`delimiter`), the function passes the writer property configuration
`"separator":vars.delimiter` as an argument:

`write(myVar, "application/csv", {"header":false, "separator":vars.delimiter})`

The script uses the following DataWeave `output` directive in the script’s header:
`output application/csv with binary`. It is necessary to append the `with binary` setting
([introduced in Mule 4.3.0](https://docs.mulesoft.com/dataweave/2.4/dataweave-formats#set_mime_types)) to invoke the binary writer because
the `write` function returned CSV output. Without the setting, DataWeave would attempt to write CSV
again and produce the following issue:
`CSV Structure should be an Array<Object> or Object but got String, while writing CSV.`

Note that if you want to see pipe-separated content from the Tranform Message component’s
**Preview** screen in the Studio UI, you must create sample data for it:

1.  Double-click the Transform Message component from the **Message Flow** area of the Studio app.

2.  Right-click **delimiter: _String_** in the **Context** tab, which is located on the bottom left
    of the configuration UI for the component.

3.  Select **Edit Sample Data** to open a **vars-delimiter** tab.

4.  Replace any content in the **vars-delimiter** with the following sample data for the `delimiter`
    value: `"|"`. You must put the delimiter in quotation marks.

For further guidance with sample data, see
[Previewing the Output of a Transformation](https://docs.mulesoft.com/mule-runtime/latest/transform-preview-transformation-output-studio-task).

## See Also

- [DataWeave Formats](https://docs.mulesoft.com/dataweave/2.4/dataweave-formats)

- [Core Components](https://docs.mulesoft.com/mule-runtime/latest/about-components)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook)

<!-- document id=bd076456ea17d715833db8b27f40bf5e46e140e93e36604ba9df6eac6c96cb35 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook-writer-prop-mule.md -->

---
product: DataWeave
version: 2.6
---

# Use Dynamic Writer Properties

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following example shows a Mule flow that transforms comma-separated CSV data into pipe-separated
(`|`) CSV data. Instead of setting a literal value in the script, the example selects the pipe value
from a [Mule variable](https://docs.mulesoft.com/mule-runtime/latest/about-mule-variables), which is part of a Mule
event that travels through data-processing components in the flow. The example uses the DataWeave
writer function in the body of the script to change the comma-separated input to pipe-separated
output.

The Scheduler component (`<scheduler/>`) in the example generates a Mule event each time it triggers
the flow.

The Set Variable component (`<set-variable/>`) creates a Mule variable named `delimiter` with the
value `'|'`. In Studio, the value is created as an **fx** expression (`value="#['|']"`), rather than
a simple string (`value="'|'"`).

The Transform Message component (`<ee:transform-message/>`) contains a DataWeave script that reads
comma-separated CSV input and uses the Mule variable to write pipe-separated CSV output.

The Logger component (`<logger/>`), which is set to `payload`, writes the pipe-separated output as
INFO in its `LoggerMessageProcessor` message: `macaroni | rigatoni | ravioli | spaghetti`.

Mule Flow:

```xml
<flow name="ex-use-mule-var-as-prop-config-val" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="45" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <set-variable value="#['|']" doc:name="Set Variable" variableName="delimiter" />
  <ee:transform doc:name="Transform Message" >
    <ee:message>
      <ee:set-payload><![CDATA[%dw 2.0
var myVar = read("macaroni , rigatoni , ravioli , spaghetti", "application/csv" , {"header":false, separator:','})
output application/csv with binary
---
write(myVar, "application/csv", {"header":false, "separator":vars.delimiter})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
  <logger level="INFO" doc:name="Logger" message="#[payload]"/>
</flow>
```

To provide comma-separated input for the example, the script in the Transform Message component uses
a [read](https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-read) function as a value to a DataWeave variable, `myVar`:

`var myVar = read("macaroni , rigatoni , ravioli , spaghetti", "application/csv" , {"header":false, separator:','})`

To write pipe-separated output, the DataWeave [write](https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-write) function in the body
of the script changes the comma-separated input to pipe-separated output. To select the pipe value
from the Mule variable (`delimiter`), the function passes the writer property configuration
`"separator":vars.delimiter` as an argument:

`write(myVar, "application/csv", {"header":false, "separator":vars.delimiter})`

The script uses the following DataWeave `output` directive in the script’s header:
`output application/csv with binary`. It is necessary to append the `with binary` setting
([introduced in Mule 4.3.0](https://docs.mulesoft.com/dataweave/2.6/dataweave-formats#set_mime_types)) to invoke the binary writer because
the `write` function returned CSV output. Without the setting, DataWeave would attempt to write CSV
again and produce the following issue:
`CSV Structure should be an Array<Object> or Object but got String, while writing CSV.`

Note that if you want to see pipe-separated content from the Tranform Message component’s
**Preview** screen in the Studio UI, you must create sample data for it:

1.  Double-click the Transform Message component from the **Message Flow** area of the Studio app.

2.  Right-click **delimiter: _String_** in the **Context** tab, which is located on the bottom left
    of the configuration UI for the component.

3.  Select **Edit Sample Data** to open a **vars-delimiter** tab.

4.  Replace any content in the **vars-delimiter** with the following sample data for the `delimiter`
    value: `"|"`. You must put the delimiter in quotation marks.

For further guidance with sample data, see
[Previewing the Output of a Transformation](https://docs.mulesoft.com/mule-runtime/latest/transform-preview-transformation-output-studio-task).

## See Also

- [DataWeave Formats](https://docs.mulesoft.com/dataweave/2.6/dataweave-formats)

- [Core Components](https://docs.mulesoft.com/mule-runtime/latest/about-components)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook)

<!-- document id=0c3327a80d31ade4607f9d2743877b55ff9e03c2e34fa75068cc518215f915a5 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook-writer-prop-mule.md -->

---
product: DataWeave
version: 2.9
---

# Use Dynamic Writer Properties

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following example shows a Mule flow that transforms comma-separated CSV data into pipe-separated
(`|`) CSV data. Instead of setting a literal value in the script, the example selects the pipe value
from a [Mule variable](https://docs.mulesoft.com/mule-runtime/latest/about-mule-variables), which is part of a Mule
event that travels through data-processing components in the flow. The example uses the DataWeave
writer function in the body of the script to change the comma-separated input to pipe-separated
output.

The Scheduler component (`<scheduler/>`) in the example generates a Mule event each time it triggers
the flow.

The Set Variable component (`<set-variable/>`) creates a Mule variable named `delimiter` with the
value `'|'`. In Studio, the value is created as an **fx** expression (`value="#['|']"`), rather than
a simple string (`value="'|'"`).

The Transform Message component (`<ee:transform-message/>`) contains a DataWeave script that reads
comma-separated CSV input and uses the Mule variable to write pipe-separated CSV output.

The Logger component (`<logger/>`), which is set to `payload`, writes the pipe-separated output as
INFO in its `LoggerMessageProcessor` message: `macaroni | rigatoni | ravioli | spaghetti`.

Mule Flow:

```xml
<flow name="ex-use-mule-var-as-prop-config-val" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="45" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <set-variable value="#['|']" doc:name="Set Variable" variableName="delimiter" />
  <ee:transform doc:name="Transform Message" >
    <ee:message>
      <ee:set-payload><![CDATA[%dw 2.0
var myVar = read("macaroni , rigatoni , ravioli , spaghetti", "application/csv" , {"header":false, separator:','})
output application/csv with binary
---
write(myVar, "application/csv", {"header":false, "separator":vars.delimiter})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
  <logger level="INFO" doc:name="Logger" message="#[payload]"/>
</flow>
```

To provide comma-separated input for the example, the script in the Transform Message component uses
a [read](https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-read) function as a value to a DataWeave variable, `myVar`:

`var myVar = read("macaroni , rigatoni , ravioli , spaghetti", "application/csv" , {"header":false, separator:','})`

To write pipe-separated output, the DataWeave [write](https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-write) function in the body
of the script changes the comma-separated input to pipe-separated output. To select the pipe value
from the Mule variable (`delimiter`), the function passes the writer property configuration
`"separator":vars.delimiter` as an argument:

`write(myVar, "application/csv", {"header":false, "separator":vars.delimiter})`

The script uses the following DataWeave `output` directive in the script’s header:
`output application/csv with binary`. It is necessary to append the `with binary` setting
([introduced in Mule 4.3.0](https://docs.mulesoft.com/dataweave/2.9/dataweave-formats#set_mime_types)) to invoke the binary writer because
the `write` function returned CSV output. Without the setting, DataWeave would attempt to write CSV
again and produce the following issue:
`CSV Structure should be an Array<Object> or Object but got String, while writing CSV.`

Note that if you want to see pipe-separated content from the Tranform Message component’s
**Preview** screen in the Studio UI, you must create sample data for it:

1.  Double-click the Transform Message component from the **Message Flow** area of the Studio app.

2.  Right-click **delimiter: _String_** in the **Context** tab, which is located on the bottom left
    of the configuration UI for the component.

3.  Select **Edit Sample Data** to open a **vars-delimiter** tab.

4.  Replace any content in the **vars-delimiter** with the following sample data for the `delimiter`
    value: `"|"`. You must put the delimiter in quotation marks.

For further guidance with sample data, see
[Previewing the Output of a Transformation](https://docs.mulesoft.com/mule-runtime/latest/transform-preview-transformation-output-studio-task).

## See Also

- [DataWeave Formats](https://docs.mulesoft.com/dataweave/2.9/dataweave-formats)

- [Core Components](https://docs.mulesoft.com/mule-runtime/latest/about-components)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook)

<!-- document id=578ac6daa944c5dbcdfb1955ddd35c7c5982c8ce0e9813e1184a7803f5264946 url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook-writer-prop-mule.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Use Dynamic Writer Properties

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following example shows a Mule flow that transforms comma-separated CSV data into pipe-separated
(`|`) CSV data. Instead of setting a literal value in the script, the example selects the pipe value
from a [Mule variable](https://docs.mulesoft.com/mule-runtime/latest/about-mule-variables), which is part of a Mule
event that travels through data-processing components in the flow. The example uses the DataWeave
writer function in the body of the script to change the comma-separated input to pipe-separated
output.

The Scheduler component (`<scheduler/>`) in the example generates a Mule event each time it triggers
the flow.

The Set Variable component (`<set-variable/>`) creates a Mule variable named `delimiter` with the
value `'|'`. In Studio, the value is created as an **fx** expression (`value="#['|']"`), rather than
a simple string (`value="'|'"`).

The Transform Message component (`<ee:transform-message/>`) contains a DataWeave script that reads
comma-separated CSV input and uses the Mule variable to write pipe-separated CSV output.

The Logger component (`<logger/>`), which is set to `payload`, writes the pipe-separated output as
INFO in its `LoggerMessageProcessor` message: `macaroni | rigatoni | ravioli | spaghetti`.

Mule Flow:

```xml
<flow name="ex-use-mule-var-as-prop-config-val" >
  <scheduler doc:name="Scheduler" >
    <scheduling-strategy >
      <fixed-frequency frequency="45" timeUnit="SECONDS"/>
    </scheduling-strategy>
  </scheduler>
  <set-variable value="#['|']" doc:name="Set Variable" variableName="delimiter" />
  <ee:transform doc:name="Transform Message" >
    <ee:message>
      <ee:set-payload><![CDATA[%dw 2.0
var myVar = read("macaroni , rigatoni , ravioli , spaghetti", "application/csv" , {"header":false, separator:','})
output application/csv with binary
---
write(myVar, "application/csv", {"header":false, "separator":vars.delimiter})]]></ee:set-payload>
    </ee:message>
  </ee:transform>
  <logger level="INFO" doc:name="Logger" message="#[payload]"/>
</flow>
```

To provide comma-separated input for the example, the script in the Transform Message component uses
a [read](https://docs.mulesoft.com/dataweave/latest/dw-core-functions-read) function as a value to a DataWeave variable, `myVar`:

`var myVar = read("macaroni , rigatoni , ravioli , spaghetti", "application/csv" , {"header":false, separator:','})`

To write pipe-separated output, the DataWeave [write](https://docs.mulesoft.com/dataweave/latest/dw-core-functions-write) function in the body
of the script changes the comma-separated input to pipe-separated output. To select the pipe value
from the Mule variable (`delimiter`), the function passes the writer property configuration
`"separator":vars.delimiter` as an argument:

`write(myVar, "application/csv", {"header":false, "separator":vars.delimiter})`

The script uses the following DataWeave `output` directive in the script’s header:
`output application/csv with binary`. It is necessary to append the `with binary` setting
([introduced in Mule 4.3.0](https://docs.mulesoft.com/dataweave/latest/dataweave-formats#set_mime_types)) to invoke the binary writer because
the `write` function returned CSV output. Without the setting, DataWeave would attempt to write CSV
again and produce the following issue:
`CSV Structure should be an Array<Object> or Object but got String, while writing CSV.`

Note that if you want to see pipe-separated content from the Tranform Message component’s
**Preview** screen in the Studio UI, you must create sample data for it:

1.  Double-click the Transform Message component from the **Message Flow** area of the Studio app.

2.  Right-click **delimiter: _String_** in the **Context** tab, which is located on the bottom left
    of the configuration UI for the component.

3.  Select **Edit Sample Data** to open a **vars-delimiter** tab.

4.  Replace any content in the **vars-delimiter** with the following sample data for the `delimiter`
    value: `"|"`. You must put the delimiter in quotation marks.

For further guidance with sample data, see
[Previewing the Output of a Transformation](https://docs.mulesoft.com/mule-runtime/latest/transform-preview-transformation-output-studio-task).

## See Also

- [DataWeave Formats](https://docs.mulesoft.com/dataweave/latest/dataweave-formats)

- [Core Components](https://docs.mulesoft.com/mule-runtime/latest/about-components)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook)

<!-- document id=e46f8c600ea92d4649cb8342bcd4647c3029760fe2875d0879ff654767ac5c6c url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook-use-regex.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, as
---

# Use Regular Expressions in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Several DataWeave functions accept regular expressions as arguments, which you can use to return or
check for matches. You can also construct regular expressions that incorporate DataWeave expressions
that include functions and variables.

## Return Matches from a String

This example uses regular expressions in a number of DataWeave functions to return matches to an
input variable "mycompany.com".

- `contains` returns `true` based on a regular expression that matches part of the input string.

- `find` returns an array of indices that specify the matching locations in the input string. This
  function treats the input string as a string array.

- `match` returns an array of substrings that match the regular expression.

- `matches` returns `true` because the regular expression matches the input string exactly.

- `replace` returns a URL that changes `.com` in the input string to `.net`, based on the regular
  expression `\..*m`.

- `scan` returns a subarray of comma-separated substrings that the regular expression matches.

- `splitBy` splits an input string into an array of substrings based on the `.` in the input.

DataWeave Script:

```dataweave
%dw 2.0
var myString = "mycompany.com"
output application/json
---
{
	"contains" : myString contains(/c.m/),
	"find" : myString find(/[m|n].|m$/),
	"match" : myString match(/([a-z]*).[a-z]*/),
	"matches" : myString matches(/([a-z]*).[a-z]*/),
	"replaceWith" : myString replace /\..*m/ with ".net",
	"scan" : myString scan(/([a-z]*).(com)/),
	"splitBy" : myString splitBy(/[.\/]/)
}
```

Output JSON:

```json
{
  "contains": true,
  "find": [[0], [4], [7], [12]],
  "match": ["mycompany.com", "mycompany"],
  "matches": true,
  "replaceWith": "mycompany.net",
  "scan": [["mycompany.com", "mycompany", "com"]],
  "splitBy": ["mycompany", "com"]
}
```

For function documentation, see:

- [contains](https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-contains)

- [find](https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-find)

- [match](https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-match)

- [matches](https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-matches)

- [replace](https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-replace)

- [scan](https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-scan)

- [splitby](https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-splitby)

## Use DataWeave Variables and Functions in a Regular Expression

This example constructs a regular expression by using the DataWeave concatenate function (`++`) to
incorporate a DataWeave variable into a regular expression. The regular expression matches
"somebiz". The example uses `replace` and `with` to replace "somebiz" with "abcd".

DataWeave Script:

```dataweave
%dw 2.0
var myCompany = { "name" : "biz" }
var myInputA = "somebiz-98765"
output application/json
---
{
  example: myInputA replace (("(^s.*e)" ++ myCompany.name) as Regex) with ("abcd")
}
```

Output JSON:

```json
{
  "example": "abcd-98765"
}
```

## See Also

- [Regex (dw::Core Type)](https://docs.mulesoft.com/dataweave/2.11/dataweave-types#dw_type_regex)

- [Core Types (dw::Core)](https://docs.mulesoft.com/dataweave/2.11/dw-core-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.11/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook)

<!-- document id=65d7a264ed1fadc43986821c077e2e9c3684fc4b86003c90e1ebbd667f0ad4d1 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook-use-regex.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, as
---

# Use Regular Expressions in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Several DataWeave functions accept regular expressions as arguments, which you can use to return or
check for matches. You can also construct regular expressions that incorporate DataWeave expressions
that include functions and variables.

## Return Matches from a String

This example uses regular expressions in a number of DataWeave functions to return matches to an
input variable "mycompany.com".

- `contains` returns `true` based on a regular expression that matches part of the input string.

- `find` returns an array of indices that specify the matching locations in the input string. This
  function treats the input string as a string array.

- `match` returns an array of substrings that match the regular expression.

- `matches` returns `true` because the regular expression matches the input string exactly.

- `replace` returns a URL that changes `.com` in the input string to `.net`, based on the regular
  expression `\..*m`.

- `scan` returns a subarray of comma-separated substrings that the regular expression matches.

- `splitBy` splits an input string into an array of substrings based on the `.` in the input.

DataWeave Script:

```dataweave
%dw 2.0
var myString = "mycompany.com"
output application/json
---
{
	"contains" : myString contains(/c.m/),
	"find" : myString find(/[m|n].|m$/),
	"match" : myString match(/([a-z]*).[a-z]*/),
	"matches" : myString matches(/([a-z]*).[a-z]*/),
	"replaceWith" : myString replace /\..*m/ with ".net",
	"scan" : myString scan(/([a-z]*).(com)/),
	"splitBy" : myString splitBy(/[.\/]/)
}
```

Output JSON:

```json
{
  "contains": true,
  "find": [[0], [4], [7], [12]],
  "match": ["mycompany.com", "mycompany"],
  "matches": true,
  "replaceWith": "mycompany.net",
  "scan": [["mycompany.com", "mycompany", "com"]],
  "splitBy": ["mycompany", "com"]
}
```

For function documentation, see:

- [contains](https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-contains)

- [find](https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-find)

- [match](https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-match)

- [matches](https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-matches)

- [replace](https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-replace)

- [scan](https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-scan)

- [splitby](https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-splitby)

## Use DataWeave Variables and Functions in a Regular Expression

This example constructs a regular expression by using the DataWeave concatenate function (`++`) to
incorporate a DataWeave variable into a regular expression. The regular expression matches
"somebiz". The example uses `replace` and `with` to replace "somebiz" with "abcd".

DataWeave Script:

```dataweave
%dw 2.0
var myCompany = { "name" : "biz" }
var myInputA = "somebiz-98765"
output application/json
---
{
  example: myInputA replace (("(^s.*e)" ++ myCompany.name) as Regex) with ("abcd")
}
```

Output JSON:

```json
{
  "example": "abcd-98765"
}
```

## See Also

- [Regex (dw::Core Type)](https://docs.mulesoft.com/dataweave/2.12/dataweave-types#dw_type_regex)

- [Core Types (dw::Core)](https://docs.mulesoft.com/dataweave/2.12/dw-core-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.12/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook)

<!-- document id=1786bd369c4c3b4dd37bfc9795a85def7476c25db698791b30921fb8780fae56 url=/mulesoft/current/en-us/dataweave/2.3/dataweave-cookbook-use-regex.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, as
---

# Use Regular Expressions in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Several DataWeave functions accept regular expressions as arguments, which you can use to return or
check for matches. You can also construct regular expressions that incorporate DataWeave expressions
that include functions and variables.

## Return Matches from a String

This example uses regular expressions in a number of DataWeave functions to return matches to an
input variable "mycompany.com".

- `contains` returns `true` based on a regular expression that matches part of the input string.

- `find` returns an array of indices that specify the matching locations in the input string. This
  function treats the input string as a string array.

- `match` returns an array of substrings that match the regular expression.

- `matches` returns `true` because the regular expression matches the input string exactly.

- `replace` returns a URL that changes `.com` in the input string to `.net`, based on the regular
  expression `\..*m`.

- `scan` returns a subarray of comma-separated substrings that the regular expression matches.

- `splitBy` splits an input string into an array of substrings based on the `.` in the input.

DataWeave Script:

```dataweave
%dw 2.0
var myString = "mycompany.com"
output application/json
---
{
	"contains" : myString contains(/c.m/),
	"find" : myString find(/[m|n].|m$/),
	"match" : myString match(/([a-z]*).[a-z]*/),
	"matches" : myString matches(/([a-z]*).[a-z]*/),
	"replaceWith" : myString replace /\..*m/ with ".net",
	"scan" : myString scan(/([a-z]*).(com)/),
	"splitBy" : myString splitBy(/[.\/]/)
}
```

Output JSON:

```json
{
  "contains": true,
  "find": [[0], [4], [7], [12]],
  "match": ["mycompany.com", "mycompany"],
  "matches": true,
  "replaceWith": "mycompany.net",
  "scan": [["mycompany.com", "mycompany", "com"]],
  "splitBy": ["mycompany", "com"]
}
```

For function documentation, see:

- [contains](https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-contains)

- [find](https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-find)

- [match](https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-match)

- [matches](https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-matches)

- [replace](https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-replace)

- [scan](https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-scan)

- [splitby](https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-splitby)

## Use DataWeave Variables and Functions in a Regular Expression

This example constructs a regular expression by using the DataWeave concatenate function (`++`) to
incorporate a DataWeave variable into a regular expression. The regular expression matches
"somebiz". The example uses `replace` and `with` to replace "somebiz" with "abcd".

DataWeave Script:

```dataweave
%dw 2.0
var myCompany = { "name" : "biz" }
var myInputA = "somebiz-98765"
output application/json
---
{
  example: myInputA replace (("(^s.*e)" ++ myCompany.name) as Regex) with ("abcd")
}
```

Output JSON:

```json
{
  "example": "abcd-98765"
}
```

## See Also

- [Regex (dw::Core Type)](https://docs.mulesoft.com/dataweave/2.3/dataweave-types#dw_type_regex)

- [Core Types (dw::Core)](https://docs.mulesoft.com/dataweave/2.3/dw-core-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.3/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook)

<!-- document id=015b42aad2a39f4c36f0760c2e38ac6faad7987bd4473fddc0f9bf21f04ad6fe url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook-use-regex.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, as
---

# Use Regular Expressions in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Several DataWeave functions accept regular expressions as arguments, which you can use to return or
check for matches. You can also construct regular expressions that incorporate DataWeave expressions
that include functions and variables.

## Return Matches from a String

This example uses regular expressions in a number of DataWeave functions to return matches to an
input variable "mycompany.com".

- `contains` returns `true` based on a regular expression that matches part of the input string.

- `find` returns an array of indices that specify the matching locations in the input string. This
  function treats the input string as a string array.

- `match` returns an array of substrings that match the regular expression.

- `matches` returns `true` because the regular expression matches the input string exactly.

- `replace` returns a URL that changes `.com` in the input string to `.net`, based on the regular
  expression `\..*m`.

- `scan` returns a subarray of comma-separated substrings that the regular expression matches.

- `splitBy` splits an input string into an array of substrings based on the `.` in the input.

DataWeave Script:

```dataweave
%dw 2.0
var myString = "mycompany.com"
output application/json
---
{
	"contains" : myString contains(/c.m/),
	"find" : myString find(/[m|n].|m$/),
	"match" : myString match(/([a-z]*).[a-z]*/),
	"matches" : myString matches(/([a-z]*).[a-z]*/),
	"replaceWith" : myString replace /\..*m/ with ".net",
	"scan" : myString scan(/([a-z]*).(com)/),
	"splitBy" : myString splitBy(/[.\/]/)
}
```

Output JSON:

```json
{
  "contains": true,
  "find": [[0], [4], [7], [12]],
  "match": ["mycompany.com", "mycompany"],
  "matches": true,
  "replaceWith": "mycompany.net",
  "scan": [["mycompany.com", "mycompany", "com"]],
  "splitBy": ["mycompany", "com"]
}
```

For function documentation, see:

- [contains](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-contains)

- [find](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-find)

- [match](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-match)

- [matches](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-matches)

- [replace](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-replace)

- [scan](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-scan)

- [splitby](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-splitby)

## Use DataWeave Variables and Functions in a Regular Expression

This example constructs a regular expression by using the DataWeave concatenate function (`++`) to
incorporate a DataWeave variable into a regular expression. The regular expression matches
"somebiz". The example uses `replace` and `with` to replace "somebiz" with "abcd".

DataWeave Script:

```dataweave
%dw 2.0
var myCompany = { "name" : "biz" }
var myInputA = "somebiz-98765"
output application/json
---
{
  example: myInputA replace (("(^s.*e)" ++ myCompany.name) as Regex) with ("abcd")
}
```

Output JSON:

```json
{
  "example": "abcd-98765"
}
```

## See Also

- [Regex (dw::Core Type)](https://docs.mulesoft.com/dataweave/2.4/dataweave-types#dw_type_regex)

- [Core Types (dw::Core)](https://docs.mulesoft.com/dataweave/2.4/dw-core-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.4/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook)

<!-- document id=3e69409c0b4df0623a1568489a416a17523aa3bc4290730aa0cc6951b5dc8f7f url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook-use-regex.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, as
---

# Use Regular Expressions in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Several DataWeave functions accept regular expressions as arguments, which you can use to return or
check for matches. You can also construct regular expressions that incorporate DataWeave expressions
that include functions and variables.

## Return Matches from a String

This example uses regular expressions in a number of DataWeave functions to return matches to an
input variable "mycompany.com".

- `contains` returns `true` based on a regular expression that matches part of the input string.

- `find` returns an array of indices that specify the matching locations in the input string. This
  function treats the input string as a string array.

- `match` returns an array of substrings that match the regular expression.

- `matches` returns `true` because the regular expression matches the input string exactly.

- `replace` returns a URL that changes `.com` in the input string to `.net`, based on the regular
  expression `\..*m`.

- `scan` returns a subarray of comma-separated substrings that the regular expression matches.

- `splitBy` splits an input string into an array of substrings based on the `.` in the input.

DataWeave Script:

```dataweave
%dw 2.0
var myString = "mycompany.com"
output application/json
---
{
	"contains" : myString contains(/c.m/),
	"find" : myString find(/[m|n].|m$/),
	"match" : myString match(/([a-z]*).[a-z]*/),
	"matches" : myString matches(/([a-z]*).[a-z]*/),
	"replaceWith" : myString replace /\..*m/ with ".net",
	"scan" : myString scan(/([a-z]*).(com)/),
	"splitBy" : myString splitBy(/[.\/]/)
}
```

Output JSON:

```json
{
  "contains": true,
  "find": [[0], [4], [7], [12]],
  "match": ["mycompany.com", "mycompany"],
  "matches": true,
  "replaceWith": "mycompany.net",
  "scan": [["mycompany.com", "mycompany", "com"]],
  "splitBy": ["mycompany", "com"]
}
```

For function documentation, see:

- [contains](https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-contains)

- [find](https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-find)

- [match](https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-match)

- [matches](https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-matches)

- [replace](https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-replace)

- [scan](https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-scan)

- [splitby](https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-splitby)

## Use DataWeave Variables and Functions in a Regular Expression

This example constructs a regular expression by using the DataWeave concatenate function (`++`) to
incorporate a DataWeave variable into a regular expression. The regular expression matches
"somebiz". The example uses `replace` and `with` to replace "somebiz" with "abcd".

DataWeave Script:

```dataweave
%dw 2.0
var myCompany = { "name" : "biz" }
var myInputA = "somebiz-98765"
output application/json
---
{
  example: myInputA replace (("(^s.*e)" ++ myCompany.name) as Regex) with ("abcd")
}
```

Output JSON:

```json
{
  "example": "abcd-98765"
}
```

## See Also

- [Regex (dw::Core Type)](https://docs.mulesoft.com/dataweave/2.6/dataweave-types#dw_type_regex)

- [Core Types (dw::Core)](https://docs.mulesoft.com/dataweave/2.6/dw-core-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.6/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook)

<!-- document id=659aee2c7a67e5f660b293aab2a335005b747e920fa105a4d179a85355c03b9a url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook-use-regex.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, as
---

# Use Regular Expressions in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Several DataWeave functions accept regular expressions as arguments, which you can use to return or
check for matches. You can also construct regular expressions that incorporate DataWeave expressions
that include functions and variables.

## Return Matches from a String

This example uses regular expressions in a number of DataWeave functions to return matches to an
input variable "mycompany.com".

- `contains` returns `true` based on a regular expression that matches part of the input string.

- `find` returns an array of indices that specify the matching locations in the input string. This
  function treats the input string as a string array.

- `match` returns an array of substrings that match the regular expression.

- `matches` returns `true` because the regular expression matches the input string exactly.

- `replace` returns a URL that changes `.com` in the input string to `.net`, based on the regular
  expression `\..*m`.

- `scan` returns a subarray of comma-separated substrings that the regular expression matches.

- `splitBy` splits an input string into an array of substrings based on the `.` in the input.

DataWeave Script:

```dataweave
%dw 2.0
var myString = "mycompany.com"
output application/json
---
{
	"contains" : myString contains(/c.m/),
	"find" : myString find(/[m|n].|m$/),
	"match" : myString match(/([a-z]*).[a-z]*/),
	"matches" : myString matches(/([a-z]*).[a-z]*/),
	"replaceWith" : myString replace /\..*m/ with ".net",
	"scan" : myString scan(/([a-z]*).(com)/),
	"splitBy" : myString splitBy(/[.\/]/)
}
```

Output JSON:

```json
{
  "contains": true,
  "find": [[0], [4], [7], [12]],
  "match": ["mycompany.com", "mycompany"],
  "matches": true,
  "replaceWith": "mycompany.net",
  "scan": [["mycompany.com", "mycompany", "com"]],
  "splitBy": ["mycompany", "com"]
}
```

For function documentation, see:

- [contains](https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-contains)

- [find](https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-find)

- [match](https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-match)

- [matches](https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-matches)

- [replace](https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-replace)

- [scan](https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-scan)

- [splitby](https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-splitby)

## Use DataWeave Variables and Functions in a Regular Expression

This example constructs a regular expression by using the DataWeave concatenate function (`++`) to
incorporate a DataWeave variable into a regular expression. The regular expression matches
"somebiz". The example uses `replace` and `with` to replace "somebiz" with "abcd".

DataWeave Script:

```dataweave
%dw 2.0
var myCompany = { "name" : "biz" }
var myInputA = "somebiz-98765"
output application/json
---
{
  example: myInputA replace (("(^s.*e)" ++ myCompany.name) as Regex) with ("abcd")
}
```

Output JSON:

```json
{
  "example": "abcd-98765"
}
```

## See Also

- [Regex (dw::Core Type)](https://docs.mulesoft.com/dataweave/2.9/dataweave-types#dw_type_regex)

- [Core Types (dw::Core)](https://docs.mulesoft.com/dataweave/2.9/dw-core-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.9/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook)

<!-- document id=455b7d0935749b3b4463498902a727b9750411300a7a7a6e482d0cca140bc0cd url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook-use-regex.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, as
---

# Use Regular Expressions in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Several DataWeave functions accept regular expressions as arguments, which you can use to return or
check for matches. You can also construct regular expressions that incorporate DataWeave expressions
that include functions and variables.

## Return Matches from a String

This example uses regular expressions in a number of DataWeave functions to return matches to an
input variable "mycompany.com".

- `contains` returns `true` based on a regular expression that matches part of the input string.

- `find` returns an array of indices that specify the matching locations in the input string. This
  function treats the input string as a string array.

- `match` returns an array of substrings that match the regular expression.

- `matches` returns `true` because the regular expression matches the input string exactly.

- `replace` returns a URL that changes `.com` in the input string to `.net`, based on the regular
  expression `\..*m`.

- `scan` returns a subarray of comma-separated substrings that the regular expression matches.

- `splitBy` splits an input string into an array of substrings based on the `.` in the input.

DataWeave Script:

```dataweave
%dw 2.0
var myString = "mycompany.com"
output application/json
---
{
	"contains" : myString contains(/c.m/),
	"find" : myString find(/[m|n].|m$/),
	"match" : myString match(/([a-z]*).[a-z]*/),
	"matches" : myString matches(/([a-z]*).[a-z]*/),
	"replaceWith" : myString replace /\..*m/ with ".net",
	"scan" : myString scan(/([a-z]*).(com)/),
	"splitBy" : myString splitBy(/[.\/]/)
}
```

Output JSON:

```json
{
  "contains": true,
  "find": [[0], [4], [7], [12]],
  "match": ["mycompany.com", "mycompany"],
  "matches": true,
  "replaceWith": "mycompany.net",
  "scan": [["mycompany.com", "mycompany", "com"]],
  "splitBy": ["mycompany", "com"]
}
```

For function documentation, see:

- [contains](https://docs.mulesoft.com/dataweave/latest/dw-core-functions-contains)

- [find](https://docs.mulesoft.com/dataweave/latest/dw-core-functions-find)

- [match](https://docs.mulesoft.com/dataweave/latest/dw-core-functions-match)

- [matches](https://docs.mulesoft.com/dataweave/latest/dw-core-functions-matches)

- [replace](https://docs.mulesoft.com/dataweave/latest/dw-core-functions-replace)

- [scan](https://docs.mulesoft.com/dataweave/latest/dw-core-functions-scan)

- [splitby](https://docs.mulesoft.com/dataweave/latest/dw-core-functions-splitby)

## Use DataWeave Variables and Functions in a Regular Expression

This example constructs a regular expression by using the DataWeave concatenate function (`++`) to
incorporate a DataWeave variable into a regular expression. The regular expression matches
"somebiz". The example uses `replace` and `with` to replace "somebiz" with "abcd".

DataWeave Script:

```dataweave
%dw 2.0
var myCompany = { "name" : "biz" }
var myInputA = "somebiz-98765"
output application/json
---
{
  example: myInputA replace (("(^s.*e)" ++ myCompany.name) as Regex) with ("abcd")
}
```

Output JSON:

```json
{
  "example": "abcd-98765"
}
```

## See Also

- [Regex (dw::Core Type)](https://docs.mulesoft.com/dataweave/latest/dataweave-types#dw_type_regex)

- [Core Types (dw::Core)](https://docs.mulesoft.com/dataweave/latest/dw-core-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook)

<!-- document id=af1786771e6faadc0efb2df9513839c0c93fa9143b68be313f307c228c7d4cca url=/mulesoft/current/en-us/dataweave/latest/dw-utils.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Utils (dw::util::jwt::Utils)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This module provides internal helper functions for the JWT signing modules.

_Introduced in DataWeave version 2.6.0._

<!-- document id=15398ade47fb07ba0d876eb92169de741c710890ef4488c50e66ae5b1f1424e4 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-uuid.md -->

---
product: DataWeave
version: 2.11
---

# uuid

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## uuid(): String

Returns a v4 UUID using random numbers as the source.

### Example

This example generates a random v4 UUID.

#### Source

```DataWeave
%dw 2.0
output application/json
---
uuid()
```

#### Output

```JSON
"7cc64d24-f2ad-4d43-8893-fa24a0789a99"
```

<!-- document id=3c2cc540987686eceb3ef9422f74af0b4efa88a8ebc87cf5d5ff3a1aad7ea349 url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-uuid.md -->

---
product: DataWeave
version: 2.12
---

# uuid

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## uuid(): String

Returns a v4 UUID using random numbers as the source.

### Example

This example generates a random v4 UUID.

#### Source

```DataWeave
%dw 2.0
output application/json
---
uuid()
```

#### Output

```JSON
"7cc64d24-f2ad-4d43-8893-fa24a0789a99"
```

<!-- document id=e5b45a6ba097b887df936cb36b554fcab202eb4e2888d6bd54dbfd6474d0c69f url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-uuid.md -->

---
product: DataWeave
version: 2.3
---

# uuid

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## uuid(): String

Returns a v4 UUID using random numbers as the source.

### Example

This example generates a random v4 UUID.

#### Source

%dw 2.0 output application/json
---

uuid()

#### Output

```JSON
"7cc64d24-f2ad-4d43-8893-fa24a0789a99"
```

<!-- document id=e5d815c60896687411a1a4b400b41cd86740f9557679c849687349ae34204c8c url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-uuid.md -->

---
product: DataWeave
version: 2.4
---

# uuid

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## uuid(): String

Returns a v4 UUID using random numbers as the source.

### Example

This example generates a random v4 UUID.

#### Source

```DataWeave
%dw 2.0
output application/json
---
uuid()
```

#### Output

```JSON
"7cc64d24-f2ad-4d43-8893-fa24a0789a99"
```

<!-- document id=d15e0f7daf311f883697f8ff367cf70825d06c77c1a18ba3febd89bf35e84c71 url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-uuid.md -->

---
product: DataWeave
version: 2.6
---

# uuid

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## uuid(): String

Returns a v4 UUID using random numbers as the source.

### Example

This example generates a random v4 UUID.

#### Source

```DataWeave
%dw 2.0
output application/json
---
uuid()
```

#### Output

```JSON
"7cc64d24-f2ad-4d43-8893-fa24a0789a99"
```

<!-- document id=efc97e11fb572e3fa427568b6b1aff9805d05e678e12be931e7dde817c8ca581 url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-uuid.md -->

---
product: DataWeave
version: 2.9
---

# uuid

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## uuid(): String

Returns a v4 UUID using random numbers as the source.

### Example

This example generates a random v4 UUID.

#### Source

```DataWeave
%dw 2.0
output application/json
---
uuid()
```

#### Output

```JSON
"7cc64d24-f2ad-4d43-8893-fa24a0789a99"
```

<!-- document id=0b6473bef7e77dfd66fc50d992ce68d31c307b4ab87eacb5ffb1fa7d9351296c url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-uuid.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# uuid

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## uuid(): String

Returns a v4 UUID using random numbers as the source.

### Example

This example generates a random v4 UUID.

#### Source

```DataWeave
%dw 2.0
output application/json
---
uuid()
```

#### Output

```JSON
"7cc64d24-f2ad-4d43-8893-fa24a0789a99"
```

<!-- document id=fc14ed9f82abbd4862d722f2fd20e72bbe0600d6c554036cd634508d38c3ba7a url=/mulesoft/current/en-us/dataweave/2.11/dataweave-types.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Value Constructs for Types

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave represents data using values, each of which has a data type associated with it. There are
many types, such as strings, arrays, Booleans, numbers, objects, dates, times, and others. Each type
supports several ways of creating its values. This topic explores many of the ways you can create
them.

The types that DataWeave provide are bundled into modules that also contain the related functions.

Types in the `dw::Core` module (Core types) are available without having to import the Core module.
Other modules need to be imported for their functions and types to be available.

It is important for you to know the values that are possible for each DataWeave type, how to create
those values, and the common patterns used:

- Conditional elements that use `if` expressions for [arrays](#conditional_elements_array) and
  [objects](#conditional_elements_object).

- [String Interpolation](#string_interpolation)

- [Date Decomposition](#date_decomposition) for accessing different parts of a date

- [Date and Time Formats](#date_format)

- [Dynamic Keys](#dynamic_keys) and [Dynamic Elements](#dynamic_elements), which allow you to access
  parts of an object dynamically

- Use of [Regex (dw::Core Type)](#dw_type_regex) expressions

## Array (dw::Core Type)

An array can hold elements of any supported type. Here is an example of an array:

Example: DataWeave Array

```dataweave
%dw 2.0
output application/json
var x = "words"
---
[ "My", "three", x ]
```

### Conditional Elements

Arrays can define elements that appear (or not) based on a condition.

Conditional elements take the form `(value) if condition`, for example:

Example: if Condition

```dataweave
%dw 2.0
output application/json
---
[(1) if true, (2) if false]
```

Output

```json
[1]
```

## Boolean (dw::Core Type)

A `Boolean` is defined by the keywords `true` and `false`.

## CData (dw::Core Type)

XML defines a custom type named `CData`, which inherits from and extends `String`. It is used to
identify a CDATA XML block. It can be used to tell the writer to wrap the content inside CDATA or to
check if the input string arrives inside a CDATA block.

Transform

```dataweave
%dw 2.0
output application/xml encoding="UTF-8"
---
{
  users:
  {
    user : "Mariano" as CData,
    age : 31 as CData
  }
}
```

Output

```xml
<?xml version="1.0" encoding="UTF-8"?>
<users>
  <user><![CDATA[Mariano]]></user>
  <age><![CDATA[31]]></age>
</users>
```

## Date and Time (dw::Core Types)

Dates in DataWeave follow the
[ISO-8601 standard](https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html)
and literals are defined between `|` characters.

The language has the following native date types:

- `Date`

- `DateTime`

- `LocalDateTime`

- `LocalTime`

- `Period`

- `Time`

- `TimeZone`

### Date

A `Date` represented by `Year`, `Month`, and `Day`, specified as `|uuuu-MM-dd|`. The `Date` type has
no time component.

Example

```dataweave
|2003-10-01|
```

### DateTime

A Date and Time within a TimeZone. It is the conjunction of `Date` + `Time` + `TimeZone`.

Example

```dataweave
|2003-10-01T23:57:59-03:00|
```

### LocalDateTime

A `DateTime` in the current `TimeZone`.

Example

```dataweave
|2003-10-01T23:57:59|
```

### LocalTime

A `Time` in the current `TimeZone`.

### Period

`Period` represents an amount of time. The type takes the following form:

- `P[n]Y[n]M[n]DT[n]H[n]M[n]S`

- `` P<date>T<time>` ``

Where the \[n\] is replaced by the value for each of the date and time elements that follow the
\[n\].

`Period` has two subcategories:

- `DatePeriod`  
  A date-based amount of time, for example, 1 year, 2 months, 3 days. Because these expressions are
  date-based, they cannot be converted to milliseconds. For example, a month does not specify
  whether it is a month of 31 days or not, nor does a year specify whether it is a leap year. The
  data expresses just an amount of date. In DataWeave, the syntax is `|P1Y|`.

- `Duration`  
  A time-based amount of time, for example, 1 second, 2 hours, or 2 days, each of which can be
  represented in seconds or milliseconds. In DataWeave, the syntax is `|PT1H|`.

`P` is the duration designator placed at the start of the duration representation.

- `Y` is the year designator (e.g. `|P1Y|`)

- `M` is the month designator (e.g. `|P1M|`)

- `D` is the day designator (e.g. `|P1D|`)

`T` is the time designator that precedes the time components of the representation.

- `H` is the hour designator (e.g. `|PT1H|`)

- `M` is the minute designator (e.g. `|PT1M|`)

- `S` is the second designator (e.g. `|PT1S|`)

`DatePeriod` is useful for date manipulation, such as addition or subtraction.  
The following example shows how to subtract one year from a date using `DatePeriod`. The return type
is a new `Date` value:

Source

```dataweave
output application/dw
---
|2003-10-01| - |P1Y|
```

Output

```dataweave
|2002-10-01|
```

`Duration` is useful as a result of a `Date` to `Date` subtraction so the amount of time between
those two dates can be inferred.  
The following example shows how subtracting one `Date` value from another returns a `Duration`
value:

Source

```dataweave
output application/dw
---
|2003-11-01| - |2003-10-01|
```

Output

```dataweave
|PT744H|
```

#### Period Coercion

Because a `DatePeriod` value is date-based, it can be coerced to `Number` date-based units, such as
`years` or `months`.  
The following example shows how to coerce a `DatePeriod` value to a `Number` value by using
different units:

Source

```dataweave
output application/json
---
{
 years:  |P1Y12M| as Number {unit: "years"},
 months: |P8Y12M| as Number {unit: "months"}
}
```

Output

```json
{
  "years": 2,
  "months": 108
}
```

#### Duration Coercion

Because `Duration` is time-based, this type can be coerced to a `Number` with different time-based
units, such as `nanos`, `milliseconds`, `seconds`, `hours`, and `days`.

The following example shows how to coerce a `Duration` to a `Number` by using different units:

Source

```dataweave
output application/json
var period = (|2010-12-10T12:10:12| - |2010-09-09T10:02:10|)
---
{
 nanos: period as Number {unit: "nanos"},
 millis: period as Number {unit: "milliseconds"},
 seconds: period as Number {unit: "seconds"},
 hours: period as Number {unit: "hours"},
 days: period as Number {unit: "days"}
}
```

Output

```json
{
  "nanos": 7956482000000000,
  "millis": 7956482000,
  "seconds": 7956482,
  "hours": 2210,
  "days": 92
}
```

#### Deconstruct

A `Duration` can be deconstructed into `hours`, `minutes` and `secs`.

The following example shows how to deconstruct a `Duration` value:

Source

```dataweave
%dw 2.0
output application/json
var period = (|2010-12-10T12:10:12| - |2010-12-10T10:02:10|)
---
{
   hours:  period.hours,
   minutes:  period.minutes,
   secs:  period.secs,
}
```

Output

```json
{
  "hours": 2,
  "minutes": 8,
  "secs": 2
}
```

### Time

A time in a specific `TimeZone`, specified as `|HH:mm:ss.SSS|`.

Example

```dataweave
|23:59:56|
```

### TimeZone

The `Time` relative to Greenwich Mean Time (GMT). A `TimeZone` must include a `+` or a `-`. For
example, `|03:00|` is a time, while `|+03:00|` is a `TimeZone`.

Example

```dataweave
|-08:00|
```

### Date Decomposition

To access the different parts of the date, special selectors must be used.

Transform

```dataweave
%dw 2.0
output application/json
var myDate = |2003-10-01T23:57:59.700-03:00|
---
{
  year: myDate.year,
  month: myDate.month,
  day: myDate.day,
  hour: myDate.hour,
  minutes: myDate.minutes,
  seconds: myDate.seconds,
  milliseconds: myDate.milliseconds,
  nanoseconds: myDate.nanoseconds,
  quarter: myDate.quarter,
  dayOfWeek: myDate.dayOfWeek,
  dayOfYear: myDate.dayOfYear,
  offsetSeconds: myDate.offsetSeconds
}
```

Output

```json
{
  "year": 2003,
  "month": 10,
  "day": 1,
  "hour": 23,
  "minutes": 57,
  "seconds": 59,
  "milliseconds": 700,
  "nanoseconds": 700000000,
  "quarter": 4,
  "dayOfWeek": 3,
  "dayOfYear": 274,
  "offsetSeconds": -10800
}
```

### Date and Time Formats

To enable you to format dates and times, DataWeave supports formatting characters, such as the `u`
(for the year), `M`, and `d` in the date format `uuuu-MM-dd`. These characters are based on the Java
8 `java.time.format` package.

For examples, see [Format Dates and Times](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-format-dates).

### Timezone IDs

In addition to accepting time zone values, such as `-07:00`, DataWeave also accepts IDs such as
`America/Buenos_Aires`, `America/Los_Angeles`, `Asia/Tokyo`, and `GMT`.

For examples and a list of supported IDs, see
[Time Zone IDs](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-change-time-zone#timezone-ids) and
[Change a Time Zone](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-format-dates).

## Enum (dw::Core Type)

This type is based on the
[Enum Java class](https://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html). It must always be
used with the `class` property, specifying the full Java class name of the class, as shown in this
example.

Transform

```dataweave
%dw 2.0
output application/java
---
"Male" as Enum {class: "com.acme.GenderEnum"}
```

## Iterator (dw::Core Type)

The `Iterator` type is based on the
[Iterator Java class](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html), that
iterates through arrays. `Iterator` contains a collection and includes methods to iterate through
and filter it.

Note that like the Java class, the iterator is designed to be consumed only once. For example, if a
logger consumes the value, the value is no longer readable by subsequent elements in the flow.

## Null (dw::Core Type)

DataWeave defines a `Null` data type for `null` values. It is important to note that `null` is the
value, while `Null` is the type. DataWeave functions do not recognize `Null` as a `null` value.

You can determine whether a DataWeave function accepts `null` values by looking in the DataWeave
reference documentation for a function signature that accepts a Null type. For example, the
[flatten](https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-flatten#flatten2) function has two function signatures, one of which is
`flatten(Null): Null`. The signature indicates that `flatten` can accept `null` values. The
[++](https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-plusplus) (concatenate) function, which lacks a signature for handling value
so the `Null` type, does not accept `null`.

- `flatten([[1],2,[null],null])` returns `[1,2,null,null]`

- `"a" ++ null` returns the error ``Unable to call `++` with (`String`, `Null`)``.

## Number (dw::Core Type)

There is only one Number type that supports both floating point and integer numbers. There is no
loss of precision in any operation, the engine always stores the data in the most performant way
that does not compromise precision.

DataWeave provides a mechanism for formatting numeric values and for coercing dates and strings to
numbers. The language also provides operators that act on numeric values and includes many functions
that take numeric values as arguments.

- [Type Coercion with DataWeave](https://docs.mulesoft.com/dataweave/2.11/dataweave-types-coercion##defining-dataweave-types-for-type-coercion)
  shows how to format a number.

- [mapObject](https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-mapobject) provides an example that coerces a string to a number and
  formats the number.

- [Period Coercion](#period_coercion) and [Duration Coercion](#duration_coercion) include date
  coercion examples.

- [Operators](https://docs.mulesoft.com/dataweave/2.11/dw-operators) describes operators that act on numeric values.

- [avg](https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-avg) is one of many DataWeave functions that accepts a numeric value. The
  `Number` type appears in its function signature, `avg(Array<Number>): Number`, which indicates
  that the function accepts an array of numeric values and returns a numeric value.

- The [Numbers](https://docs.mulesoft.com/dataweave/2.11/dw-numbers) module provides helper functions that work on numbers.

## Object (dw::Core Type)

Represents any object as a collection of `Key:value` pairs, where a `Key` is composed of a `Name`
and `Attributes`.

The `Name` type is composed of a `String` as the local name and the `Namespace`. `Attributes` is
composed of an Array of `Name:value` pairs. Note that the `Key` is not a `String`, so it is not
possible to compare keys. However, you can get the local name by performing an `as String` type
coercion on any value of type `Key`.

Example

```dataweave
%dw 2.0
output application/json
---
{
  name: "Annie"
}
```

### Single Value Objects

If an object has only one `key:value` pair, the enclosing curly braces `{ }` are not required:

Example

```dataweave
%dw 2.0
output application/json
---
name: "Annie"
```

### Conditional Elements

Objects can define conditional key-value pairs based on a conditional expression. Conditional
elements have the form `(key:value) if` condition.

```dataweave
%dw 2.0
output application/xml encoding="UTF-8"
---
file: {
  name: "transform",
  (extension: "zip") if payload.fileSystem?
}
```

This example outputs an additional field called "extension" only when the fileSystem property is
present in payload (this field may contain any value, not just `true`).

```xml
<?xml version="1.0" encoding="UTF-8"?>
<file>
  <name>transform</name>
  <extension>zip</extension>
</file>
```

If absent:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<file>
  <name>transform</name>
</file>
```

### Dynamic Keys

To specify a key through an expression, you need to wrap the expression in parentheses.

Transform

```dataweave
%dw 2.0
output application/json
var dynamicKey = "language"
---
{
  (dynamicKey): "Data Weave"
}
```

Output

```json
{
  "language": "Data Weave"
}
```

### Dynamic Elements

Dynamic elements allow you to add the result of an expression as `key:value` pairs of an object.
That expression must be either an `object` or an `array of objects`.

Transform

```dataweave
%dw 2.0
output application/json
var x = [
  {b: "b"},
  {c: "c", d: "d"}
]
var y = {e: "e"}
---
{
  a: "a",
  (x),
  (y)
}
```

The _evaluation parentheses_ around the variables in the body of the script above (`(x)` and `(y)`)
enable the object constructor curly braces (`{ }`) surrounding the body of the script to act on the
values of the variables. Specifically, the object constructor curly braces extract the key-value
pairs from the values of `x` and `y` and convert them into a collection of key-value pairs within an
object. Without the parentheses (for example, if you use `x` instead of `(x)`), the script returns
an error.

The object constructor curly braces require a data construct that contains one or more key-value
pairs, specifically an object, such as `{ "a":"one", "b":"two"}`, or an array of objects, such as
`[{"a":"one"},{"b":"two"}]` so that it can produce a valid object. Because the first element within
the object constructor curly braces is the key-value pair `a: "a"`, the object constructor curly
braces leave the pair as the first element in the output object, without any modifications. However,
the object constructor curly braces extract the outer-level key-value pairs in the evaluated
expressions `(x)` and `(y)` and append those key-value pairs to the output object.

Output

```json
{
  "a": "a",
  "b": "b",
  "c": "c",
  "d": "d",
  "e": "e"
}
```

### Conditional XML Attributes

You might want your output to only include certain XML attributes based on a condition. Conditional
elements have the form `(key:value) if condition`

Transform

```dataweave
%dw 2.0
output application/xml
---
{
  name @(
    (company: "Acme") if false,
    (transform: "Anything") if true
  ): "DataWeave"
}
```

Output

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<name transform="Anything">DataWeave</name>
```

### Dynamic XML Attributes

You might want to include a changing set of key:value pairs in a specific location as XML
attributes.

Input

```json
{
  "company": "Mule",
  "product": "DataWeave"
}
```

Transform

```dataweave
%dw 2.0
output application/xml
---
transformation @((payload)): "Transform from anything to anything"
```

Output

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<transformation company="Mule" product="DataWeave">Transform from anything to anything</transformation>
```

## Regex (dw::Core Type)

Regular Expressions are defined between `/`. For example `/\d+/` represents multiple numerical
digits from 0-9. These may be used as arguments in certain operations that act upon strings, like
Matches or Replace, or on operations that act upon objects and arrays, such as filters.

## String (dw::Core Type)

A string can be defined by the use of double quotes or single quotes.

```dataweave
{
  doubleQuoted: "Hello",
  singleQuoted: 'Hello',
}
```

### Escaping Special Characters

Use the backslash (`\`) to escape special characters in an input string:

- `$`: You need to escape any use of `$` in a string. Otherwise, DataWeave treats the `$` as an
  unnamed parameter for a function and returns the error `Unable to resolve reference of $.`.

- `"`: For a string that is surrounded by double quotes, you need to escape any double quote that is
  part of the string, for example, `"a\"bcdef"`. Here, the second double-quote is part of the string
  that starts with an `a` and ends with `f`.

- `'` For a string that is surrounded by single quotes, you need to escape any single quote that is
  part of the string: for example, `'abcd\'e"f'`. In this example, the second single quote is part
  of the string that starts with an `a` and ends with `f`. Notice that you do not need to escape the
  double quote in this case.

- `` ` ``: For a string that is surrounded by backticks, you must escape any backtick that is part
  of the string: for example, `` `abc\`def` ``.

- `\`: Because the backslash is the character you use to escape other special characters, you need
  to escape it with a separate backslash to use it in a string, for example,`\\`.

- `\n`: For inserting a new line.

- `\t`: For inserting a tab.

- `\u`: For inserting a unicode character, such as `\u25c4`.

### String Interpolation

String interpolation allows you to embed variables or expressions directly in a string. The
expression need to be enclosed (`$( <expression> )`), and it should always return String type or
something that is coercible to String.

```dataweave
%dw 2.0
output application/json
var name = "Shoki"
---
{
    Greeting: "Hi, my name is $name",
    Sum: "1 + 1 = $(1 + 1)"
}
```

Output

```json
{
  "Greeting": "Hi, my name is Shoki",
  "Sum": "1 + 1 = 2"
}
```

## TryResult (dw::Runtime Type)

Evaluates the delegate and returns an object with the result or an error message. See the `try`
example. A successful `TryResult` contains the `result` field and a `success` value of `true`. An
unsuccessful `TryResult` contains the `error` field and a `success` value of `false`.

Definition

```dataweave
{
  success: Boolean,
  result?: T,
  error?: {
    kind: String,
    message: String,
    stack?: Array<String>,
    location?: String
  }
}
```

## URI Types (dw::core::URL)

Functions in the URI function module can return a URI data type.

Definition:

```dataweave
{
  isValid: Boolean,
  host?: String,
  authority?: String,
  fragment?: String,
  path?: String,
  port?: Number,
  query?: String,
  scheme?: String,
  user?: String,
  isAbsolute?: Boolean,
  isOpaque?: Boolean
}
```

The URI type consists of the following fields:

- `isValid`: Boolean that indicates whether the URI is valid. Invalid characters include `<`, `>`,
  and blank spaces.

- `host`: String representing the host name (for example, `my.company.com` from
  `http://my.company.com:8080/hello`)

- `authority`: String representing the authority, which includes the host and port (for example,
  `my.company.com:8080` from `http://my.company.com:8080/hello`). Returns the port only if it is
  explicitly specified in the URI.

- `fragment`: String representing the subordinate resource after the `#` in the URI (for example,
  `footer` in the URI `"https://en.wikipedia.org/wiki/Uniform_Resource_Identifier#footer"`).

- `path`: String representing a path following the host or authority (for example, `/hello` in
  `http://my.company.com:8080/hello`) .

- `port`: Number representing an explicit port in the URI (for example, `8080` in
  `http://my.company.com:8080/hello`). If no port is specified (for example,
  `http://my.company.com/hello`), the value of the `port` field is `null`.

- `query`: String identifying a query portion of a URI (for example, `field=value` in
  'http://my.company.com:1234/hello/?field=value').

- `scheme`: String identifying the URI scheme, such as `https` or `http`, which appears before a
  colon (`:`).

- `user`: String representing user information in a URI (for example, the `myname` in
  `http://myname@www.mycompany.com`).

- `isAbsolute`: Boolean value of `true` if the URI contains a scheme, `false` if the URI does not
  (for example, a relative URI such as `/path/to/somewhere`).

- `isOpaque`: Boolean value of `true` if the URI lacks a scheme followed by forward slashes (`/`).
  `mailto:somebody@somewhere.com` returns `true`.

The following DataWeave script uses the `parseURI` function to return and access values to fields
from a URI type. Note that fields with `null` values (for example, the URI defined by
`uriDataTypeEx`) are not returned unless you explicitly select them.

DataWeave Script

```dataweave
%dw 2.0
import * from dw::core::URL
var uriDataTypeEx = "https://en.wikipedia.org/wiki/Uniform_Resource_Identifier#footer"
var queryStringsEx = 'http://my.company.com:1234/hello/?field=value'
output application/json
---
{
    'myUriDataTypeEx': parseURI(uriDataTypeEx),
    // queryStringsEx has a query string:
    'myQueryStringsEx': parseURI(queryStringsEx).query,
    // uriDataTypeEx lacks a query string:
    'myQueryStringNullEx': parseURI(uriDataTypeEx).query,
    // The URI includes the port number:
    'myAuthorityEx': parseURI('http://localhost:8080/test').authority
}
```

Output

```JSON
{
  "myUriDataTypeEx": {
    "isValid": true,
    "raw": "https://en.wikipedia.org/wiki/Uniform_Resource_Identifier#footer",
    "host": "en.wikipedia.org",
    "authority": "en.wikipedia.org",
    "fragment": "footer",
    "path": "/wiki/Uniform_Resource_Identifier",
    "scheme": "https",
    "isAbsolute": true,
    "isOpaque": false
  },
  "myQueryStringsEx": "field=value",
  "myQueryStringNullEx": null,
  "myAuthorityEx": "localhost:8080"
}
```

## DataWeave Type References

You can find more data type documentation in the reference pages for the DataWeave function modules:

- [Core Types (dw::Core)](https://docs.mulesoft.com/dataweave/2.11/dw-core-types)

- [Coercions Types (dw::util::Coercions)](https://docs.mulesoft.com/dataweave/2.11/dw-coercions-types)

- [DataFormat Types (dw::extension::DataFormat)](https://docs.mulesoft.com/dataweave/2.11/dw-dataformat-types)

- [Dates Types (dw::core::Dates)](https://docs.mulesoft.com/dataweave/2.11/dw-dates-types)

- [Diff Types (dw::core::Diff)](https://docs.mulesoft.com/dataweave/2.11/dw-diff-types)

- [Mule Types (Mule)](https://docs.mulesoft.com/dataweave/2.11/dw-mule-types)

- [Multipart Types (dw::module::Multipart)](https://docs.mulesoft.com/dataweave/2.11/dw-multipart-types)

- [Runtime Types (dw::Runtime)](https://docs.mulesoft.com/dataweave/2.11/dw-runtime-types)

- [Timer Types (dw::core::Timer)](https://docs.mulesoft.com/dataweave/2.11/dw-timer-types)

- [Tree Types (dw::util::Tree)](https://docs.mulesoft.com/dataweave/2.11/dw-tree-types)

- [Types Types (dw::core::Types)](https://docs.mulesoft.com/dataweave/2.11/dw-types-types)

- [URL Types (dw::core::URL)](https://docs.mulesoft.com/dataweave/2.11/dw-url-types)

- [Values Types (dw::util::Values)](https://docs.mulesoft.com/dataweave/2.11/dw-values-types)

## See Also

- [DataWeave Scripts](https://docs.mulesoft.com/dataweave/2.11/dataweave-language-introduction)

- [Anypoint Exchange (List of Projects that use DataWeave)](https://anypoint.mulesoft.com/exchange/?search=dataweave)

<!-- document id=7bda459960dbde673ec8ee2dc5eb86c4c5247a7e3e37e9835012ab5aef074696 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-types.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Value Constructs for Types

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave represents data using values, each of which has a data type associated with it. There are
many types, such as strings, arrays, Booleans, numbers, objects, dates, times, and others. Each type
supports several ways of creating its values. This topic explores many of the ways you can create
them.

The types that DataWeave provide are bundled into modules that also contain the related functions.

Types in the `dw::Core` module (Core types) are available without having to import the Core module.
Other modules need to be imported for their functions and types to be available.

It is important for you to know the values that are possible for each DataWeave type, how to create
those values, and the common patterns used:

- Conditional elements that use `if` expressions for [arrays](#conditional_elements_array) and
  [objects](#conditional_elements_object).

- [String Interpolation](#string_interpolation)

- [Date Decomposition](#date_decomposition) for accessing different parts of a date

- [Date and Time Formats](#date_format)

- [Dynamic Keys](#dynamic_keys) and [Dynamic Elements](#dynamic_elements), which allow you to access
  parts of an object dynamically

- Use of [Regex (dw::Core Type)](#dw_type_regex) expressions

## Array (dw::Core Type)

An array can hold elements of any supported type. Here is an example of an array:

Example: DataWeave Array

```dataweave
%dw 2.0
output application/json
var x = "words"
---
[ "My", "three", x ]
```

### Conditional Elements

Arrays can define elements that appear (or not) based on a condition.

Conditional elements take the form `(value) if condition`, for example:

Example: if Condition

```dataweave
%dw 2.0
output application/json
---
[(1) if true, (2) if false]
```

Output

```json
[1]
```

## Boolean (dw::Core Type)

A `Boolean` is defined by the keywords `true` and `false`.

## CData (dw::Core Type)

XML defines a custom type named `CData`, which inherits from and extends `String`. It is used to
identify a CDATA XML block. It can be used to tell the writer to wrap the content inside CDATA or to
check if the input string arrives inside a CDATA block.

Transform

```dataweave
%dw 2.0
output application/xml encoding="UTF-8"
---
{
  users:
  {
    user : "Mariano" as CData,
    age : 31 as CData
  }
}
```

Output

```xml
<?xml version="1.0" encoding="UTF-8"?>
<users>
  <user><![CDATA[Mariano]]></user>
  <age><![CDATA[31]]></age>
</users>
```

## Date and Time (dw::Core Types)

Dates in DataWeave follow the
[ISO-8601 standard](https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html)
and literals are defined between `|` characters.

The language has the following native date types:

- `Date`

- `DateTime`

- `LocalDateTime`

- `LocalTime`

- `Period`

- `Time`

- `TimeZone`

### Date

A `Date` represented by `Year`, `Month`, and `Day`, specified as `|uuuu-MM-dd|`. The `Date` type has
no time component.

Example

```dataweave
|2003-10-01|
```

### DateTime

A Date and Time within a TimeZone. It is the conjunction of `Date` + `Time` + `TimeZone`.

Example

```dataweave
|2003-10-01T23:57:59-03:00|
```

### LocalDateTime

A `DateTime` in the current `TimeZone`.

Example

```dataweave
|2003-10-01T23:57:59|
```

### LocalTime

A `Time` in the current `TimeZone`.

### Period

`Period` represents an amount of time. The type takes the following form:

- `P[n]Y[n]M[n]DT[n]H[n]M[n]S`

- `` P<date>T<time>` ``

Where the \[n\] is replaced by the value for each of the date and time elements that follow the
\[n\].

`Period` has two subcategories:

- `DatePeriod`  
  A date-based amount of time, for example, 1 year, 2 months, 3 days. Because these expressions are
  date-based, they cannot be converted to milliseconds. For example, a month does not specify
  whether it is a month of 31 days or not, nor does a year specify whether it is a leap year. The
  data expresses just an amount of date. In DataWeave, the syntax is `|P1Y|`.

- `Duration`  
  A time-based amount of time, for example, 1 second, 2 hours, or 2 days, each of which can be
  represented in seconds or milliseconds. In DataWeave, the syntax is `|PT1H|`.

`P` is the duration designator placed at the start of the duration representation.

- `Y` is the year designator (e.g. `|P1Y|`)

- `M` is the month designator (e.g. `|P1M|`)

- `D` is the day designator (e.g. `|P1D|`)

`T` is the time designator that precedes the time components of the representation.

- `H` is the hour designator (e.g. `|PT1H|`)

- `M` is the minute designator (e.g. `|PT1M|`)

- `S` is the second designator (e.g. `|PT1S|`)

`DatePeriod` is useful for date manipulation, such as addition or subtraction.  
The following example shows how to subtract one year from a date using `DatePeriod`. The return type
is a new `Date` value:

Source

```dataweave
output application/dw
---
|2003-10-01| - |P1Y|
```

Output

```dataweave
|2002-10-01|
```

`Duration` is useful as a result of a `Date` to `Date` subtraction so the amount of time between
those two dates can be inferred.  
The following example shows how subtracting one `Date` value from another returns a `Duration`
value:

Source

```dataweave
output application/dw
---
|2003-11-01| - |2003-10-01|
```

Output

```dataweave
|PT744H|
```

#### Period Coercion

Because a `DatePeriod` value is date-based, it can be coerced to `Number` date-based units, such as
`years` or `months`.  
The following example shows how to coerce a `DatePeriod` value to a `Number` value by using
different units:

Source

```dataweave
output application/json
---
{
 years:  |P1Y12M| as Number {unit: "years"},
 months: |P8Y12M| as Number {unit: "months"}
}
```

Output

```json
{
  "years": 2,
  "months": 108
}
```

#### Duration Coercion

Because `Duration` is time-based, this type can be coerced to a `Number` with different time-based
units, such as `nanos`, `milliseconds`, `seconds`, `hours`, and `days`.

The following example shows how to coerce a `Duration` to a `Number` by using different units:

Source

```dataweave
output application/json
var period = (|2010-12-10T12:10:12| - |2010-09-09T10:02:10|)
---
{
 nanos: period as Number {unit: "nanos"},
 millis: period as Number {unit: "milliseconds"},
 seconds: period as Number {unit: "seconds"},
 hours: period as Number {unit: "hours"},
 days: period as Number {unit: "days"}
}
```

Output

```json
{
  "nanos": 7956482000000000,
  "millis": 7956482000,
  "seconds": 7956482,
  "hours": 2210,
  "days": 92
}
```

#### Deconstruct

A `Duration` can be deconstructed into `hours`, `minutes` and `secs`.

The following example shows how to deconstruct a `Duration` value:

Source

```dataweave
%dw 2.0
output application/json
var period = (|2010-12-10T12:10:12| - |2010-12-10T10:02:10|)
---
{
   hours:  period.hours,
   minutes:  period.minutes,
   secs:  period.secs,
}
```

Output

```json
{
  "hours": 2,
  "minutes": 8,
  "secs": 2
}
```

### Time

A time in a specific `TimeZone`, specified as `|HH:mm:ss.SSS|`.

Example

```dataweave
|23:59:56|
```

### TimeZone

The `Time` relative to Greenwich Mean Time (GMT). A `TimeZone` must include a `+` or a `-`. For
example, `|03:00|` is a time, while `|+03:00|` is a `TimeZone`.

Example

```dataweave
|-08:00|
```

### Date Decomposition

To access the different parts of the date, special selectors must be used.

Transform

```dataweave
%dw 2.0
output application/json
var myDate = |2003-10-01T23:57:59.700-03:00|
---
{
  year: myDate.year,
  month: myDate.month,
  day: myDate.day,
  hour: myDate.hour,
  minutes: myDate.minutes,
  seconds: myDate.seconds,
  milliseconds: myDate.milliseconds,
  nanoseconds: myDate.nanoseconds,
  quarter: myDate.quarter,
  dayOfWeek: myDate.dayOfWeek,
  dayOfYear: myDate.dayOfYear,
  offsetSeconds: myDate.offsetSeconds
}
```

Output

```json
{
  "year": 2003,
  "month": 10,
  "day": 1,
  "hour": 23,
  "minutes": 57,
  "seconds": 59,
  "milliseconds": 700,
  "nanoseconds": 700000000,
  "quarter": 4,
  "dayOfWeek": 3,
  "dayOfYear": 274,
  "offsetSeconds": -10800
}
```

### Date and Time Formats

To enable you to format dates and times, DataWeave supports formatting characters, such as the `u`
(for the year), `M`, and `d` in the date format `uuuu-MM-dd`. These characters are based on the Java
8 `java.time.format` package.

For examples, see [Format Dates and Times](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-format-dates).

### Timezone IDs

In addition to accepting time zone values, such as `-07:00`, DataWeave also accepts IDs such as
`America/Buenos_Aires`, `America/Los_Angeles`, `Asia/Tokyo`, and `GMT`.

For examples and a list of supported IDs, see
[Time Zone IDs](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-change-time-zone#timezone-ids) and
[Change a Time Zone](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-format-dates).

## Enum (dw::Core Type)

This type is based on the
[Enum Java class](https://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html). It must always be
used with the `class` property, specifying the full Java class name of the class, as shown in this
example.

Transform

```dataweave
%dw 2.0
output application/java
---
"Male" as Enum {class: "com.acme.GenderEnum"}
```

## Iterator (dw::Core Type)

The `Iterator` type is based on the
[Iterator Java class](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html), that
iterates through arrays. `Iterator` contains a collection and includes methods to iterate through
and filter it.

Note that like the Java class, the iterator is designed to be consumed only once. For example, if a
logger consumes the value, the value is no longer readable by subsequent elements in the flow.

## Null (dw::Core Type)

DataWeave defines a `Null` data type for `null` values. It is important to note that `null` is the
value, while `Null` is the type. DataWeave functions do not recognize `Null` as a `null` value.

You can determine whether a DataWeave function accepts `null` values by looking in the DataWeave
reference documentation for a function signature that accepts a Null type. For example, the
[flatten](https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-flatten#flatten2) function has two function signatures, one of which is
`flatten(Null): Null`. The signature indicates that `flatten` can accept `null` values. The
[++](https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-plusplus) (concatenate) function, which lacks a signature for handling value
so the `Null` type, does not accept `null`.

- `flatten([[1],2,[null],null])` returns `[1,2,null,null]`

- `"a" ++ null` returns the error ``Unable to call `++` with (`String`, `Null`)``.

## Number (dw::Core Type)

There is only one Number type that supports both floating point and integer numbers. There is no
loss of precision in any operation, the engine always stores the data in the most performant way
that does not compromise precision.

DataWeave provides a mechanism for formatting numeric values and for coercing dates and strings to
numbers. The language also provides operators that act on numeric values and includes many functions
that take numeric values as arguments.

- [Type Coercion with DataWeave](https://docs.mulesoft.com/dataweave/2.12/dataweave-types-coercion##defining-dataweave-types-for-type-coercion)
  shows how to format a number.

- [mapObject](https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-mapobject) provides an example that coerces a string to a number and
  formats the number.

- [Period Coercion](#period_coercion) and [Duration Coercion](#duration_coercion) include date
  coercion examples.

- [Operators](https://docs.mulesoft.com/dataweave/2.12/dw-operators) describes operators that act on numeric values.

- [avg](https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-avg) is one of many DataWeave functions that accepts a numeric value. The
  `Number` type appears in its function signature, `avg(Array<Number>): Number`, which indicates
  that the function accepts an array of numeric values and returns a numeric value.

- The [Numbers](https://docs.mulesoft.com/dataweave/2.12/dw-numbers) module provides helper functions that work on numbers.

## Object (dw::Core Type)

Represents any object as a collection of `Key:value` pairs, where a `Key` is composed of a `Name`
and `Attributes`.

The `Name` type is composed of a `String` as the local name and the `Namespace`. `Attributes` is
composed of an Array of `Name:value` pairs. Note that the `Key` is not a `String`, so it is not
possible to compare keys. However, you can get the local name by performing an `as String` type
coercion on any value of type `Key`.

Example

```dataweave
%dw 2.0
output application/json
---
{
  name: "Annie"
}
```

### Single Value Objects

If an object has only one `key:value` pair, the enclosing curly braces `{ }` are not required:

Example

```dataweave
%dw 2.0
output application/json
---
name: "Annie"
```

### Conditional Elements

Objects can define conditional key-value pairs based on a conditional expression. Conditional
elements have the form `(key:value) if` condition.

```dataweave
%dw 2.0
output application/xml encoding="UTF-8"
---
file: {
  name: "transform",
  (extension: "zip") if payload.fileSystem?
}
```

This example outputs an additional field called "extension" only when the fileSystem property is
present in payload (this field may contain any value, not just `true`).

```xml
<?xml version="1.0" encoding="UTF-8"?>
<file>
  <name>transform</name>
  <extension>zip</extension>
</file>
```

If absent:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<file>
  <name>transform</name>
</file>
```

### Dynamic Keys

To specify a key through an expression, you need to wrap the expression in parentheses.

Transform

```dataweave
%dw 2.0
output application/json
var dynamicKey = "language"
---
{
  (dynamicKey): "Data Weave"
}
```

Output

```json
{
  "language": "Data Weave"
}
```

### Dynamic Elements

Dynamic elements allow you to add the result of an expression as `key:value` pairs of an object.
That expression must be either an `object` or an `array of objects`.

Transform

```dataweave
%dw 2.0
output application/json
var x = [
  {b: "b"},
  {c: "c", d: "d"}
]
var y = {e: "e"}
---
{
  a: "a",
  (x),
  (y)
}
```

The _evaluation parentheses_ around the variables in the body of the script above (`(x)` and `(y)`)
enable the object constructor curly braces (`{ }`) surrounding the body of the script to act on the
values of the variables. Specifically, the object constructor curly braces extract the key-value
pairs from the values of `x` and `y` and convert them into a collection of key-value pairs within an
object. Without the parentheses (for example, if you use `x` instead of `(x)`), the script returns
an error.

The object constructor curly braces require a data construct that contains one or more key-value
pairs, specifically an object, such as `{ "a":"one", "b":"two"}`, or an array of objects, such as
`[{"a":"one"},{"b":"two"}]` so that it can produce a valid object. Because the first element within
the object constructor curly braces is the key-value pair `a: "a"`, the object constructor curly
braces leave the pair as the first element in the output object, without any modifications. However,
the object constructor curly braces extract the outer-level key-value pairs in the evaluated
expressions `(x)` and `(y)` and append those key-value pairs to the output object.

Output

```json
{
  "a": "a",
  "b": "b",
  "c": "c",
  "d": "d",
  "e": "e"
}
```

### Conditional XML Attributes

You might want your output to only include certain XML attributes based on a condition. Conditional
elements have the form `(key:value) if condition`

Transform

```dataweave
%dw 2.0
output application/xml
---
{
  name @(
    (company: "Acme") if false,
    (transform: "Anything") if true
  ): "DataWeave"
}
```

Output

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<name transform="Anything">DataWeave</name>
```

### Dynamic XML Attributes

You might want to include a changing set of key:value pairs in a specific location as XML
attributes.

Input

```json
{
  "company": "Mule",
  "product": "DataWeave"
}
```

Transform

```dataweave
%dw 2.0
output application/xml
---
transformation @((payload)): "Transform from anything to anything"
```

Output

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<transformation company="Mule" product="DataWeave">Transform from anything to anything</transformation>
```

## Regex (dw::Core Type)

Regular Expressions are defined between `/`. For example `/\d+/` represents multiple numerical
digits from 0-9. These may be used as arguments in certain operations that act upon strings, like
Matches or Replace, or on operations that act upon objects and arrays, such as filters.

## String (dw::Core Type)

A string can be defined by the use of double quotes or single quotes.

```dataweave
{
  doubleQuoted: "Hello",
  singleQuoted: 'Hello',
}
```

### Escaping Special Characters

Use the backslash (`\`) to escape special characters in an input string:

- `$`: You need to escape any use of `$` in a string. Otherwise, DataWeave treats the `$` as an
  unnamed parameter for a function and returns the error `Unable to resolve reference of $.`.

- `"`: For a string that is surrounded by double quotes, you need to escape any double quote that is
  part of the string, for example, `"a\"bcdef"`. Here, the second double-quote is part of the string
  that starts with an `a` and ends with `f`.

- `'` For a string that is surrounded by single quotes, you need to escape any single quote that is
  part of the string: for example, `'abcd\'e"f'`. In this example, the second single quote is part
  of the string that starts with an `a` and ends with `f`. Notice that you do not need to escape the
  double quote in this case.

- `` ` ``: For a string that is surrounded by backticks, you must escape any backtick that is part
  of the string: for example, `` `abc\`def` ``.

- `\`: Because the backslash is the character you use to escape other special characters, you need
  to escape it with a separate backslash to use it in a string, for example,`\\`.

- `\n`: For inserting a new line.

- `\t`: For inserting a tab.

- `\u`: For inserting a unicode character, such as `\u25c4`.

### String Interpolation

String interpolation allows you to embed variables or expressions directly in a string. The
expression need to be enclosed (`$( <expression> )`), and it should always return String type or
something that is coercible to String.

```dataweave
%dw 2.0
output application/json
var name = "Shoki"
---
{
    Greeting: "Hi, my name is $name",
    Sum: "1 + 1 = $(1 + 1)"
}
```

Output

```json
{
  "Greeting": "Hi, my name is Shoki",
  "Sum": "1 + 1 = 2"
}
```

## TryResult (dw::Runtime Type)

Evaluates the delegate and returns an object with the result or an error message. See the `try`
example. A successful `TryResult` contains the `result` field and a `success` value of `true`. An
unsuccessful `TryResult` contains the `error` field and a `success` value of `false`.

Definition

```dataweave
{
  success: Boolean,
  result?: T,
  error?: {
    kind: String,
    message: String,
    stack?: Array<String>,
    location?: String
  }
}
```

## URI Types (dw::core::URL)

Functions in the URI function module can return a URI data type.

Definition:

```dataweave
{
  isValid: Boolean,
  host?: String,
  authority?: String,
  fragment?: String,
  path?: String,
  port?: Number,
  query?: String,
  scheme?: String,
  user?: String,
  isAbsolute?: Boolean,
  isOpaque?: Boolean
}
```

The URI type consists of the following fields:

- `isValid`: Boolean that indicates whether the URI is valid. Invalid characters include `<`, `>`,
  and blank spaces.

- `host`: String representing the host name (for example, `my.company.com` from
  `http://my.company.com:8080/hello`)

- `authority`: String representing the authority, which includes the host and port (for example,
  `my.company.com:8080` from `http://my.company.com:8080/hello`). Returns the port only if it is
  explicitly specified in the URI.

- `fragment`: String representing the subordinate resource after the `#` in the URI (for example,
  `footer` in the URI `"https://en.wikipedia.org/wiki/Uniform_Resource_Identifier#footer"`).

- `path`: String representing a path following the host or authority (for example, `/hello` in
  `http://my.company.com:8080/hello`) .

- `port`: Number representing an explicit port in the URI (for example, `8080` in
  `http://my.company.com:8080/hello`). If no port is specified (for example,
  `http://my.company.com/hello`), the value of the `port` field is `null`.

- `query`: String identifying a query portion of a URI (for example, `field=value` in
  'http://my.company.com:1234/hello/?field=value').

- `scheme`: String identifying the URI scheme, such as `https` or `http`, which appears before a
  colon (`:`).

- `user`: String representing user information in a URI (for example, the `myname` in
  `http://myname@www.mycompany.com`).

- `isAbsolute`: Boolean value of `true` if the URI contains a scheme, `false` if the URI does not
  (for example, a relative URI such as `/path/to/somewhere`).

- `isOpaque`: Boolean value of `true` if the URI lacks a scheme followed by forward slashes (`/`).
  `mailto:somebody@somewhere.com` returns `true`.

The following DataWeave script uses the `parseURI` function to return and access values to fields
from a URI type. Note that fields with `null` values (for example, the URI defined by
`uriDataTypeEx`) are not returned unless you explicitly select them.

DataWeave Script

```dataweave
%dw 2.0
import * from dw::core::URL
var uriDataTypeEx = "https://en.wikipedia.org/wiki/Uniform_Resource_Identifier#footer"
var queryStringsEx = 'http://my.company.com:1234/hello/?field=value'
output application/json
---
{
    'myUriDataTypeEx': parseURI(uriDataTypeEx),
    // queryStringsEx has a query string:
    'myQueryStringsEx': parseURI(queryStringsEx).query,
    // uriDataTypeEx lacks a query string:
    'myQueryStringNullEx': parseURI(uriDataTypeEx).query,
    // The URI includes the port number:
    'myAuthorityEx': parseURI('http://localhost:8080/test').authority
}
```

Output

```JSON
{
  "myUriDataTypeEx": {
    "isValid": true,
    "raw": "https://en.wikipedia.org/wiki/Uniform_Resource_Identifier#footer",
    "host": "en.wikipedia.org",
    "authority": "en.wikipedia.org",
    "fragment": "footer",
    "path": "/wiki/Uniform_Resource_Identifier",
    "scheme": "https",
    "isAbsolute": true,
    "isOpaque": false
  },
  "myQueryStringsEx": "field=value",
  "myQueryStringNullEx": null,
  "myAuthorityEx": "localhost:8080"
}
```

## DataWeave Type References

You can find more data type documentation in the reference pages for the DataWeave function modules:

- [Core Types (dw::Core)](https://docs.mulesoft.com/dataweave/2.12/dw-core-types)

- [Coercions Types (dw::util::Coercions)](https://docs.mulesoft.com/dataweave/2.12/dw-coercions-types)

- [DataFormat Types (dw::extension::DataFormat)](https://docs.mulesoft.com/dataweave/2.12/dw-dataformat-types)

- [Dates Types (dw::core::Dates)](https://docs.mulesoft.com/dataweave/2.12/dw-dates-types)

- [Diff Types (dw::core::Diff)](https://docs.mulesoft.com/dataweave/2.12/dw-diff-types)

- [Mule Types (Mule)](https://docs.mulesoft.com/dataweave/2.12/dw-mule-types)

- [Multipart Types (dw::module::Multipart)](https://docs.mulesoft.com/dataweave/2.12/dw-multipart-types)

- [Runtime Types (dw::Runtime)](https://docs.mulesoft.com/dataweave/2.12/dw-runtime-types)

- [Timer Types (dw::core::Timer)](https://docs.mulesoft.com/dataweave/2.12/dw-timer-types)

- [Tree Types (dw::util::Tree)](https://docs.mulesoft.com/dataweave/2.12/dw-tree-types)

- [Types Types (dw::core::Types)](https://docs.mulesoft.com/dataweave/2.12/dw-types-types)

- [URL Types (dw::core::URL)](https://docs.mulesoft.com/dataweave/2.12/dw-url-types)

- [Values Types (dw::util::Values)](https://docs.mulesoft.com/dataweave/2.12/dw-values-types)

## See Also

- [DataWeave Scripts](https://docs.mulesoft.com/dataweave/2.12/dataweave-language-introduction)

- [Anypoint Exchange (List of Projects that use DataWeave)](https://anypoint.mulesoft.com/exchange/?search=dataweave)

<!-- document id=67b5c744f0d1f228a1d792892d047cdef082131609817408fe01a7a9b550d3ed url=/mulesoft/current/en-us/dataweave/2.3/dataweave-types.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Value Constructs for Types

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave represents data using values, each of which has a data type associated with it. There are
many types, such as strings, arrays, Booleans, numbers, objects, dates, times, and others. Each type
supports several ways of creating its values. This topic explores many of the ways you can create
them.

The types that DataWeave provide are bundled into modules that also contain the related functions.

Types in the `dw::Core` module (Core types) are available without having to import the Core module.
Other modules need to be imported for their functions and types to be available.

It is important for you to know the values that are possible for each DataWeave type, how to create
those values, and the common patterns used:

- Conditional elements that use `if` expressions for [arrays](#conditional_elements_array) and
  [objects](#conditional_elements_object).

- [String Interpolation](#string_interpolation)

- [Date Decomposition](#date_decomposition) for accessing different parts of a date

- [Date and Time Formats](#date_format)

- [Dynamic Keys](#dynamic_keys) and [Dynamic Elements](#dynamic_elements), which allow you to access
  parts of an object dynamically

- Use of [Regex (dw::Core Type)](#dw_type_regex) expressions

## Array (dw::Core Type)

An array can hold elements of any supported type. Here is an example of an array:

Example: DataWeave Array

```dataweave
%dw 2.0
output application/json
var x = "words"
---
[ "My", "three", x ]
```

### Conditional Elements

Arrays can define elements that appear (or not) based on a condition.

Conditional elements take the form `(value) if condition`, for example:

Example: if Condition

```dataweave
%dw 2.0
output application/json
---
[(1) if true, (2) if false]
```

Output

```json
[1]
```

## Boolean (dw::Core Type)

A `Boolean` is defined by the keywords `true` and `false`.

## CData (dw::Core Type)

XML defines a custom type named `CData`, which inherits from and extends `String`. It is used to
identify a CDATA XML block. It can be used to tell the writer to wrap the content inside CDATA or to
check if the input string arrives inside a CDATA block.

Transform

```dataweave
%dw 2.0
output application/xml encoding="UTF-8"
---
{
  users:
  {
    user : "Mariano" as CData,
    age : 31 as CData
  }
}
```

Output

```xml
<?xml version="1.0" encoding="UTF-8"?>
<users>
  <user><![CDATA[Mariano]]></user>
  <age><![CDATA[31]]></age>
</users>
```

## Date and Time (dw::Core Types)

Dates in DataWeave follow the
[ISO-8601 standard](https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html)
and literals are defined between `|` characters.

The language has the following native date types:

- `Date`

- `DateTime`

- `LocalDateTime`

- `LocalTime`

- `Period`

- `Time`

- `TimeZone`

### Date

A `Date` represented by `Year`, `Month`, and `Day`, specified as `|uuuu-MM-dd|`. The `Date` type has
no time component.

Example

```dataweave
|2003-10-01|
```

### DateTime

A Date and Time within a TimeZone. It is the conjunction of `Date` + `Time` + `TimeZone`.

Example

```dataweave
|2003-10-01T23:57:59-03:00|
```

### LocalDateTime

A `DateTime` in the current `TimeZone`.

Example

```dataweave
|2003-10-01T23:57:59|
```

### LocalTime

A `Time` in the current `TimeZone`.

### Period

`Period` represents an amount of time. The type takes the following form:

- `P[n]Y[n]M[n]DT[n]H[n]M[n]S`

- `` P<date>T<time>` ``

Where the \[n\] is replaced by the value for each of the date and time elements that follow the
\[n\].

`Period` has two subcategories:

- `DatePeriod`  
  A date-based amount of time, for example, 1 year, 2 months, 3 days. Because these expressions are
  date-based, they cannot be converted to milliseconds. For example, a month does not specify
  whether it is a month of 31 days or not, nor does a year specify whether it is a leap year. The
  data expresses just an amount of date. In DataWeave, the syntax is `|P1Y|`.

- `Duration`  
  A time-based amount of time, for example, 1 second, 2 hours, or 2 days, each of which can be
  represented in seconds or milliseconds. In DataWeave, the syntax is `|PT1H|`.

`P` is the duration designator placed at the start of the duration representation.

- `Y` is the year designator (e.g. `|P1Y|`)

- `M` is the month designator (e.g. `|P1M|`)

- `D` is the day designator (e.g. `|P1D|`)

`T` is the time designator that precedes the time components of the representation.

- `H` is the hour designator (e.g. `|PT1H|`)

- `M` is the minute designator (e.g. `|PT1M|`)

- `S` is the second designator (e.g. `|PT1S|`)

`DatePeriod` is useful for date manipulation, such as addition or subtraction.  
The following example shows how to subtract one year from a date using `DatePeriod`. The return type
is a new `Date` value:

Source

```dataweave
output application/dw
---
|2003-10-01| - |P1Y|
```

Output

```dataweave
|2002-10-01|
```

`Duration` is useful as a result of a `Date` to `Date` subtraction so the amount of time between
those two dates can be inferred.  
The following example shows how subtracting one `Date` value from another returns a `Duration`
value:

Source

```dataweave
output application/dw
---
|2003-11-01| - |2003-10-01|
```

Output

```dataweave
|PT744H|
```

#### Period Coercion

Because a `DatePeriod` value is date-based, it can be coerced to `Number` date-based units, such as
`years` or `months`.  
The following example shows how to coerce a `DatePeriod` value to a `Number` value by using
different units:

Source

```dataweave
output application/json
---
{
 years:  |P1Y12M| as Number {unit: "years"},
 months: |P8Y12M| as Number {unit: "months"}
}
```

Output

```json
{
  "years": 2,
  "months": 108
}
```

#### Duration Coercion

Because `Duration` is time-based, this type can be coerced to a `Number` with different time-based
units, such as `nanos`, `milliseconds`, `seconds`, `hours`, and `days`.

The following example shows how to coerce a `Duration` to a `Number` by using different units:

Source

```dataweave
output application/json
var period = (|2010-12-10T12:10:12| - |2010-09-09T10:02:10|)
---
{
 nanos: period as Number {unit: "nanos"},
 millis: period as Number {unit: "milliseconds"},
 seconds: period as Number {unit: "seconds"},
 hours: period as Number {unit: "hours"},
 days: period as Number {unit: "days"}
}
```

Output

```json
{
  "nanos": 7956482000000000,
  "millis": 7956482000,
  "seconds": 7956482,
  "hours": 2210,
  "days": 92
}
```

#### Deconstruct

A `Duration` can be deconstructed into `hours`, `minutes` and `secs`.

The following example shows how to deconstruct a `Duration` value:

Source

```dataweave
%dw 2.0
output application/json
var period = (|2010-12-10T12:10:12| - |2010-12-10T10:02:10|)
---
{
   hours:  period.hours,
   minutes:  period.minutes,
   secs:  period.secs,
}
```

Output

```json
{
  "hours": 2,
  "minutes": 8,
  "secs": 2
}
```

### Time

A time in a specific `TimeZone`, specified as `|HH:mm:ss.SSS|`.

Example

```dataweave
|23:59:56|
```

### TimeZone

The `Time` relative to Greenwich Mean Time (GMT). A `TimeZone` must include a `+` or a `-`. For
example, `|03:00|` is a time, while `|+03:00|` is a `TimeZone`.

Example

```dataweave
|-08:00|
```

### Date Decomposition

To access the different parts of the date, special selectors must be used.

Transform

```dataweave
%dw 2.0
output application/json
var myDate = |2003-10-01T23:57:59.700-03:00|
---
{
  year: myDate.year,
  month: myDate.month,
  day: myDate.day,
  hour: myDate.hour,
  minutes: myDate.minutes,
  seconds: myDate.seconds,
  milliseconds: myDate.milliseconds,
  nanoseconds: myDate.nanoseconds,
  quarter: myDate.quarter,
  dayOfWeek: myDate.dayOfWeek,
  dayOfYear: myDate.dayOfYear,
  offsetSeconds: myDate.offsetSeconds
}
```

Output

```json
{
  "year": 2003,
  "month": 10,
  "day": 1,
  "hour": 23,
  "minutes": 57,
  "seconds": 59,
  "milliseconds": 700,
  "nanoseconds": 700000000,
  "quarter": 4,
  "dayOfWeek": 3,
  "dayOfYear": 274,
  "offsetSeconds": -10800
}
```

### Date and Time Formats

To enable you to format dates and times, DataWeave supports formatting characters, such as the `u`
(for the year), `M`, and `d` in the date format `uuuu-MM-dd`. These characters are based on the Java
8 `java.time.format` package.

For examples, see [Format Dates and Times](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-format-dates).

### Timezone IDs

In addition to accepting time zone values, such as `-07:00`, DataWeave also accepts IDs such as
`America/Buenos_Aires`, `America/Los_Angeles`, `Asia/Tokyo`, and `GMT`.

For examples and a list of supported IDs, see
[Time Zone IDs](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-change-time-zone#timezone-ids) and
[Change a Time Zone](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-format-dates).

## Enum (dw::Core Type)

This type is based on the
[Enum Java class](https://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html). It must always be
used with the `class` property, specifying the full Java class name of the class, as shown in this
example.

Transform

```dataweave
%dw 2.0
output application/java
---
"Male" as Enum {class: "com.acme.GenderEnum"}
```

## Iterator (dw::Core Type)

The `Iterator` type is based on the
[Iterator Java class](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html), that
iterates through arrays. `Iterator` contains a collection and includes methods to iterate through
and filter it.

Note that like the Java class, the iterator is designed to be consumed only once. For example, if a
logger consumes the value, the value is no longer readable by subsequent elements in the flow.

## Null (dw::Core Type)

DataWeave defines a `Null` data type for `null` values. It is important to note that `null` is the
value, while `Null` is the type. DataWeave functions do not recognize `Null` as a `null` value.

You can determine whether a DataWeave function accepts `null` values by looking in the DataWeave
reference documentation for a function signature that accepts a Null type. For example, the
[flatten](https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-flatten#flatten2) function has two function signatures, one of which is
`flatten(Null): Null`. The signature indicates that `flatten` can accept `null` values. The
[++](https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-plusplus) (concatenate) function, which lacks a signature for handling value
so the `Null` type, does not accept `null`.

- `flatten([[1],2,[null],null])` returns `[1,2,null,null]`

- `"a" ++ null` returns the error ``Unable to call `++` with (`String`, `Null`)``.

## Number (dw::Core Type)

There is only one Number type that supports both floating point and integer numbers. There is no
loss of precision in any operation, the engine always stores the data in the most performant way
that does not compromise precision.

DataWeave provides a mechanism for formatting numeric values and for coercing dates and strings to
numbers. The language also provides operators that act on numeric values and includes many functions
that take numeric values as arguments.

- [Type Coercion with DataWeave](https://docs.mulesoft.com/dataweave/2.3/dataweave-types-coercion##defining-dataweave-types-for-type-coercion)
  shows how to format a number.

- [mapObject](https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-mapobject) provides an example that coerces a string to a number and
  formats the number.

- [Period Coercion](#period_coercion) and [Duration Coercion](#duration_coercion) include date
  coercion examples.

- [Operators](https://docs.mulesoft.com/dataweave/2.3/dw-operators) describes operators that act on numeric values.

- [avg](https://docs.mulesoft.com/dataweave/2.3/dw-core-functions-avg) is one of many DataWeave functions that accepts a numeric value. The
  `Number` type appears in its function signature, `avg(Array<Number>): Number`, which indicates
  that the function accepts an array of numeric values and returns a numeric value.

- The [Numbers](https://docs.mulesoft.com/dataweave/2.3/dw-numbers) module provides helper functions that work on numbers.

## Object (dw::Core Type)

Represents any object as a collection of `Key:value` pairs, where a `Key` is composed of a `Name`
and `Attributes`.

The `Name` type is composed of a `String` as the local name and the `Namespace`. `Attributes` is
composed of an Array of `Name:value` pairs. Note that the `Key` is not a `String`, so it is not
possible to compare keys. However, you can get the local name by performing an `as String` type
coercion on any value of type `Key`.

Example

```dataweave
%dw 2.0
output application/json
---
{
  name: "Annie"
}
```

### Single Value Objects

If an object has only one `key:value` pair, the enclosing curly braces `{ }` are not required:

Example

```dataweave
%dw 2.0
output application/json
---
name: "Annie"
```

### Conditional Elements

Objects can define conditional key-value pairs based on a conditional expression. Conditional
elements have the form `(key:value) if` condition.

```dataweave
%dw 2.0
output application/xml encoding="UTF-8"
---
file: {
  name: "transform",
  (extension: "zip") if payload.fileSystem?
}
```

This example outputs an additional field called "extension" only when the fileSystem property is
present in payload (this field may contain any value, not just `true`).

```xml
<?xml version="1.0" encoding="UTF-8"?>
<file>
  <name>transform</name>
  <extension>zip</extension>
</file>
```

If absent:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<file>
  <name>transform</name>
</file>
```

### Dynamic Keys

To specify a key through an expression, you need to wrap the expression in parentheses.

Transform

```dataweave
%dw 2.0
output application/json
var dynamicKey = "language"
---
{
  (dynamicKey): "Data Weave"
}
```

Output

```json
{
  "language": "Data Weave"
}
```

### Dynamic Elements

Dynamic elements allow you to add the result of an expression as `key:value` pairs of an object.
That expression must be either an `object` or an `array of objects`.

Transform

```dataweave
%dw 2.0
output application/json
var x = [
  {b: "b"},
  {c: "c", d: "d"}
]
var y = {e: "e"}
---
{
  a: "a",
  (x),
  (y)
}
```

The _evaluation parentheses_ around the variables in the body of the script above (`(x)` and `(y)`)
enable the object constructor curly braces (`{ }`) surrounding the body of the script to act on the
values of the variables. Specifically, the object constructor curly braces extract the key-value
pairs from the values of `x` and `y` and convert them into a collection of key-value pairs within an
object. Without the parentheses (for example, if you use `x` instead of `(x)`), the script returns
an error.

The object constructor curly braces require a data construct that contains one or more key-value
pairs, specifically an object, such as `{ "a":"one", "b":"two"}`, or an array of objects, such as
`[{"a":"one"},{"b":"two"}]` so that it can produce a valid object. Because the first element within
the object constructor curly braces is the key-value pair `a: "a"`, the object constructor curly
braces leave the pair as the first element in the output object, without any modifications. However,
the object constructor curly braces extract the outer-level key-value pairs in the evaluated
expressions `(x)` and `(y)` and append those key-value pairs to the output object.

Output

```json
{
  "a": "a",
  "b": "b",
  "c": "c",
  "d": "d",
  "e": "e"
}
```

### Conditional XML Attributes

You might want your output to only include certain XML attributes based on a condition. Conditional
elements have the form `(key:value) if condition`

Transform

```dataweave
%dw 2.0
output application/xml
---
{
  name @(
    (company: "Acme") if false,
    (transform: "Anything") if true
  ): "DataWeave"
}
```

Output

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<name transform="Anything">DataWeave</name>
```

### Dynamic XML Attributes

You might want to include a changing set of key:value pairs in a specific location as XML
attributes.

Input

```json
{
  "company": "Mule",
  "product": "DataWeave"
}
```

Transform

```dataweave
%dw 2.0
output application/xml
---
transformation @((payload)): "Transform from anything to anything"
```

Output

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<transformation company="Mule" product="DataWeave">Transform from anything to anything</transformation>
```

## Regex (dw::Core Type)

Regular Expressions are defined between `/`. For example `/\d+/` represents multiple numerical
digits from 0-9. These may be used as arguments in certain operations that act upon strings, like
Matches or Replace, or on operations that act upon objects and arrays, such as filters.

## String (dw::Core Type)

A string can be defined by the use of double quotes or single quotes.

```dataweave
{
  doubleQuoted: "Hello",
  singleQuoted: 'Hello',
}
```

### Escaping Special Characters

Use the backslash (`\`) to escape special characters in an input string:

- `$`: You need to escape any use of of `$` in a string. Otherwise, DataWeave treats the `$` as an
  unnamed parameter for a function and returns the error `Unable to resolve reference of $.`.

- `"`: For a string that is surrounded by double quotes, you need to escape any double quote that is
  part of the string, for example, `"a\"bcdef"`. Here, the second double-quote is part of the string
  that starts with an `a` and ends with `f`.

- `'` For a string that is surrounded by single quotes, you need to escape any single quote that is
  part of the string: for example, `'abcd\'e"f'`. In this example, the second single quote is part
  of the string that starts with an `a` and ends with `f`. Notice that you do not need to escape the
  double quote in this case.

- `` ` ``: For a string that is surrounded by backticks (supported in DataWeave version 2), you must
  escape any backtick that is part of the string: for example, `` `abc\`def` ``.

- `\`: Because the backslash is the character you use to escape other special characters, you need
  to escape it with a separate backslash to use it in a string, for example,`\\`.

- `\n`: For inserting a new line.

- `\t`: For inserting a tab.

- `\u`: For inserting a unicode character, such as `\u25c4`.

### String Interpolation

String interpolation allows you to embed variables or expressions directly in a string. The
expression need to be enclosed (`$( <expression> )`), and it should always return String type or
something that is coercible to String.

```dataweave
%dw 2.0
output application/json
var name = "Shoki"
---
{
    Greeting: "Hi, my name is $name",
    Sum: "1 + 1 = $(1 + 1)"
}
```

Output

```json
{
  "Greeting": "Hi, my name is Shoki",
  "Sum": "1 + 1 = 2"
}
```

## TryResult (dw::Runtime Type)

Evaluates the delegate and returns an object with the result or an error message. See the `try`
example. A successful `TryResult` contains the `result` field and a `success` value of `true`. An
unsuccessful `TryResult` contains the `error` field and a `success` value of `false`.

Definition

```dataweave
{
  success: Boolean,
  result?: T,
  error?: {
    kind: String,
    message: String,
    stack?: Array<String>,
    location?: String
  }
}
```

## URI Types (dw::core::URL)

Functions in the URI function module can return a URI data type.

Definition:

```dataweave
{
  isValid: Boolean,
  host?: String,
  authority?: String,
  fragment?: String,
  path?: String,
  port?: Number,
  query?: String,
  scheme?: String,
  user?: String,
  isAbsolute?: Boolean,
  isOpaque?: Boolean
}
```

The URI type consists of the following fields:

- `isValid`: Boolean that indicates whether the URI is valid. Invalid characters include `<`, `>`,
  and blank spaces.

- `host`: String representing the host name (for example, `my.company.com` from
  `http://my.company.com:8080/hello`)

- `authority`: String representing the authority, which includes the host and port (for example,
  `my.company.com:8080` from `http://my.company.com:8080/hello`). Returns the port only if it is
  explicitly specified in the URI.

- `fragment`: String representing the subordinate resource after the `#` in the URI (for example,
  `footer` in the URI `"https://en.wikipedia.org/wiki/Uniform_Resource_Identifier#footer"`).

- `path`: String representing a path following the host or authority (for example, `/hello` in
  `http://my.company.com:8080/hello`) .

- `port`: Number representing an explicit port in the URI (for example, `8080` in
  `http://my.company.com:8080/hello`). If no port is specified (for example,
  `http://my.company.com/hello`), the value of the `port` field is `null`.

- `query`: String identifying a query portion of a URI (for example, `field=value` in
  'http://my.company.com:1234/hello/?field=value').

- `scheme`: String identifying the URI scheme, such as `https` or `http`, which appears before a
  colon (`:`).

- `user`: String representing user information in a URI (for example, the `myname` in
  `http://myname@www.mycompany.com`).

- `isAbsolute`: Boolean value of `true` if the URI contains a scheme, `false` if the URI does not
  (for example, a relative URI such as `/path/to/somewhere`).

- `isOpaque`: Boolean value of `true` if the URI lacks a scheme followed by forward slashes (`/`).
  `mailto:somebody@somewhere.com` returns `true`.

The following DataWeave script uses the `parseURI` function to return and access values to fields
from a URI type. Note that fields with `null` values (for example, the URI defined by
`uriDataTypeEx`) are not returned unless you explicitly select them.

DataWeave Script

```dataweave
%dw 2.0
import * from dw::core::URL
var uriDataTypeEx = "https://en.wikipedia.org/wiki/Uniform_Resource_Identifier#footer"
var queryStringsEx = 'http://my.company.com:1234/hello/?field=value'
output application/json
---
{
    'myUriDataTypeEx': parseURI(uriDataTypeEx),
    // queryStringsEx has a query string:
    'myQueryStringsEx': parseURI(queryStringsEx).query,
    // uriDataTypeEx lacks a query string:
    'myQueryStringNullEx': parseURI(uriDataTypeEx).query,
    // The URI includes the port number:
    'myAuthorityEx': parseURI('http://localhost:8080/test').authority
}
```

Output

```JSON
{
  "myUriDataTypeEx": {
    "isValid": true,
    "raw": "https://en.wikipedia.org/wiki/Uniform_Resource_Identifier#footer",
    "host": "en.wikipedia.org",
    "authority": "en.wikipedia.org",
    "fragment": "footer",
    "path": "/wiki/Uniform_Resource_Identifier",
    "scheme": "https",
    "isAbsolute": true,
    "isOpaque": false
  },
  "myQueryStringsEx": "field=value",
  "myQueryStringNullEx": null,
  "myAuthorityEx": "localhost:8080"
}
```

## DataWeave Type References

You can find more data type documentation in the reference pages for the DataWeave function modules:

- [Core Types (dw::Core)](https://docs.mulesoft.com/dataweave/2.3/dw-core-types)

- [DataFormat Types (dw::extension::DataFormat)](https://docs.mulesoft.com/dataweave/2.3/dw-dataformat-types)

- [Diff Types (dw::core::Diff)](https://docs.mulesoft.com/dataweave/2.3/dw-diff-types)

- [Mule Types (Mule)](https://docs.mulesoft.com/dataweave/2.3/dw-mule-types)

- [Multipart Types (dw::module::Multipart)](https://docs.mulesoft.com/dataweave/2.3/dw-multipart-types)

- [Runtime Types (dw::Runtime)](https://docs.mulesoft.com/dataweave/2.3/dw-runtime-types)

- [Timer Types (dw::core::Timer)](https://docs.mulesoft.com/dataweave/2.3/dw-timer-types)

- [Tree Types (dw::util::Tree)](https://docs.mulesoft.com/dataweave/2.3/dw-tree-types)

- [Types Types (dw::core::Types)](https://docs.mulesoft.com/dataweave/2.3/dw-types-types)

- [URL Types (dw::core::URL)](https://docs.mulesoft.com/dataweave/2.3/dw-url-types)

## See Also

- [DataWeave Scripts](https://docs.mulesoft.com/dataweave/2.3/dataweave-language-introduction)

- [Anypoint Exchange (List of Projects that use DataWeave)](https://anypoint.mulesoft.com/exchange/?search=dataweave)

<!-- document id=4241ecf7a7f2ddf4877adefa5e14096147e8ad9fa8e569bcd720b4b0fbdee152 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-types.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Value Constructs for Types

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave represents data using values, each of which has a data type associated with it. There are
many types, such as strings, arrays, Booleans, numbers, objects, dates, times, and others. Each type
supports several ways of creating its values. This topic explores many of the ways you can create
them.

The types that DataWeave provide are bundled into modules that also contain the related functions.

Types in the `dw::Core` module (Core types) are available without having to import the Core module.
Other modules need to be imported for their functions and types to be available.

It is important for you to know the values that are possible for each DataWeave type, how to create
those values, and the common patterns used:

- Conditional elements that use `if` expressions for [arrays](#conditional_elements_array) and
  [objects](#conditional_elements_object).

- [String Interpolation](#string_interpolation)

- [Date Decomposition](#date_decomposition) for accessing different parts of a date

- [Date and Time Formats](#date_format)

- [Dynamic Keys](#dynamic_keys) and [Dynamic Elements](#dynamic_elements), which allow you to access
  parts of an object dynamically

- Use of [Regex (dw::Core Type)](#dw_type_regex) expressions

## Array (dw::Core Type)

An array can hold elements of any supported type. Here is an example of an array:

Example: DataWeave Array

```dataweave
%dw 2.0
output application/json
var x = "words"
---
[ "My", "three", x ]
```

### Conditional Elements

Arrays can define elements that appear (or not) based on a condition.

Conditional elements take the form `(value) if condition`, for example:

Example: if Condition

```dataweave
%dw 2.0
output application/json
---
[(1) if true, (2) if false]
```

Output

```json
[1]
```

## Boolean (dw::Core Type)

A `Boolean` is defined by the keywords `true` and `false`.

## CData (dw::Core Type)

XML defines a custom type named `CData`, which inherits from and extends `String`. It is used to
identify a CDATA XML block. It can be used to tell the writer to wrap the content inside CDATA or to
check if the input string arrives inside a CDATA block.

Transform

```dataweave
%dw 2.0
output application/xml encoding="UTF-8"
---
{
  users:
  {
    user : "Mariano" as CData,
    age : 31 as CData
  }
}
```

Output

```xml
<?xml version="1.0" encoding="UTF-8"?>
<users>
  <user><![CDATA[Mariano]]></user>
  <age><![CDATA[31]]></age>
</users>
```

## Date and Time (dw::Core Types)

Dates in DataWeave follow the
[ISO-8601 standard](https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html)
and literals are defined between `|` characters.

The language has the following native date types:

- `Date`

- `DateTime`

- `LocalDateTime`

- `LocalTime`

- `Period`

- `Time`

- `TimeZone`

### Date

A `Date` represented by `Year`, `Month`, and `Day`, specified as `|uuuu-MM-dd|`. The `Date` type has
no time component.

Example

```dataweave
|2003-10-01|
```

### DateTime

A Date and Time within a TimeZone. It is the conjunction of `Date` + `Time` + `TimeZone`.

Example

```dataweave
|2003-10-01T23:57:59-03:00|
```

### LocalDateTime

A `DateTime` in the current `TimeZone`.

Example

```dataweave
|2003-10-01T23:57:59|
```

### LocalTime

A `Time` in the current `TimeZone`.

### Period

`Period` represents an amount of time. The type takes the following form:

- `P[n]Y[n]M[n]DT[n]H[n]M[n]S`

- `` P<date>T<time>` ``

Where the \[n\] is replaced by the value for each of the date and time elements that follow the
\[n\].

`Period` has two subcategories:

- `DatePeriod`  
  A date-based amount of time, for example, 1 year, 2 months, 3 days. Because these expressions are
  date-based, they cannot be converted to milliseconds. For example, a month does not specify
  whether it is a month of 31 days or not, nor does a year specify whether it is a leap year. The
  data expresses just an amount of date. In DataWeave, the syntax is `|P1Y|`.

- `Duration`  
  A time-based amount of time, for example, 1 second, 2 hours, or 2 days, each of which can be
  represented in seconds or milliseconds. In DataWeave, the syntax is `|PT1H|`.

`P` is the duration designator placed at the start of the duration representation.

- `Y` is the year designator (e.g. `|P1Y|`)

- `M` is the month designator (e.g. `|P1M|`)

- `D` is the day designator (e.g. `|P1D|`)

`T` is the time designator that precedes the time components of the representation.

- `H` is the hour designator (e.g. `|PT1H|`)

- `M` is the minute designator (e.g. `|PT1M|`)

- `S` is the second designator (e.g. `|PT1S|`)

`DatePeriod` is useful for date manipulation, such as addition or subtraction.  
The following example shows how to subtract one year from a date using `DatePeriod`. The return type
is a new `Date` value:

Source

```dataweave
output application/dw
---
|2003-10-01| - |P1Y|
```

Output

```dataweave
|2002-10-01|
```

`Duration` is useful as a result of a `Date` to `Date` subtraction so the amount of time between
those two dates can be inferred.  
The following example shows how subtracting one `Date` value from another returns a `Duration`
value:

Source

```dataweave
output application/dw
---
|2003-11-01| - |2003-10-01|
```

Output

```dataweave
|PT744H|
```

#### Period Coercion

Because a `DatePeriod` value is date-based, it can be coerced to `Number` date-based units, such as
`years` or `months`.  
The following example shows how to coerce a `DatePeriod` value to a `Number` value by using
different units:

Source

```dataweave
output application/json
---
{
 years:  |P1Y12M| as Number {unit: "years"},
 months: |P8Y12M| as Number {unit: "months"}
}
```

Output

```json
{
  "years": 2,
  "months": 108
}
```

#### Duration Coercion

Because `Duration` is time-based, this type can be coerced to a `Number` with different time-based
units, such as `nanos`, `milliseconds`, `seconds`, `hours`, and `days`.

The following example shows how to coerce a `Duration` to a `Number` by using different units:

Source

```dataweave
output application/json
var period = (|2010-12-10T12:10:12| - |2010-09-09T10:02:10|)
---
{
 nanos: period as Number {unit: "nanos"},
 millis: period as Number {unit: "milliseconds"},
 seconds: period as Number {unit: "seconds"},
 hours: period as Number {unit: "hours"},
 days: period as Number {unit: "days"}
}
```

Output

```json
{
  "nanos": 7956482000000000,
  "millis": 7956482000,
  "seconds": 7956482,
  "hours": 2210,
  "days": 92
}
```

#### Deconstruct

A `Duration` can be deconstructed into `hours`, `minutes` and `secs`.

The following example shows how to deconstruct a `Duration` value:

Source

```dataweave
%dw 2.0
output application/json
var period = (|2010-12-10T12:10:12| - |2010-12-10T10:02:10|)
---
{
   hours:  period.hours,
   minutes:  period.minutes,
   secs:  period.secs,
}
```

Output

```json
{
  "hours": 2,
  "minutes": 8,
  "secs": 2
}
```

### Time

A time in a specific `TimeZone`, specified as `|HH:mm:ss.SSS|`.

Example

```dataweave
|23:59:56|
```

### TimeZone

The `Time` relative to Greenwich Mean Time (GMT). A `TimeZone` must include a `+` or a `-`. For
example, `|03:00|` is a time, while `|+03:00|` is a `TimeZone`.

Example

```dataweave
|-08:00|
```

### Date Decomposition

To access the different parts of the date, special selectors must be used.

Transform

```dataweave
%dw 2.0
output application/json
var myDate = |2003-10-01T23:57:59.700-03:00|
---
{
  year: myDate.year,
  month: myDate.month,
  day: myDate.day,
  hour: myDate.hour,
  minutes: myDate.minutes,
  seconds: myDate.seconds,
  milliseconds: myDate.milliseconds,
  nanoseconds: myDate.nanoseconds,
  quarter: myDate.quarter,
  dayOfWeek: myDate.dayOfWeek,
  dayOfYear: myDate.dayOfYear,
  offsetSeconds: myDate.offsetSeconds
}
```

Output

```json
{
  "year": 2003,
  "month": 10,
  "day": 1,
  "hour": 23,
  "minutes": 57,
  "seconds": 59,
  "milliseconds": 700,
  "nanoseconds": 700000000,
  "quarter": 4,
  "dayOfWeek": 3,
  "dayOfYear": 274,
  "offsetSeconds": -10800
}
```

### Date and Time Formats

To enable you to format dates and times, DataWeave supports formatting characters, such as the `u`
(for the year), `M`, and `d` in the date format `uuuu-MM-dd`. These characters are based on the Java
8 `java.time.format` package.

For examples, see [Format Dates and Times](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-format-dates).

### Timezone IDs

In addition to accepting time zone values, such as `-07:00`, DataWeave also accepts IDs such as
`America/Buenos_Aires`, `America/Los_Angeles`, `Asia/Tokyo`, and `GMT`.

For examples and a list of supported IDs, see
[Time Zone IDs](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-change-time-zone#timezone-ids) and
[Change a Time Zone](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-format-dates).

## Enum (dw::Core Type)

This type is based on the
[Enum Java class](https://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html). It must always be
used with the `class` property, specifying the full Java class name of the class, as shown in this
example.

Transform

```dataweave
%dw 2.0
output application/java
---
"Male" as Enum {class: "com.acme.GenderEnum"}
```

## Iterator (dw::Core Type)

The `Iterator` type is based on the
[Iterator Java class](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html), that
iterates through arrays. `Iterator` contains a collection and includes methods to iterate through
and filter it.

Note that like the Java class, the iterator is designed to be consumed only once. For example, if a
logger consumes the value, the value is no longer readable by subsequent elements in the flow.

## Null (dw::Core Type)

DataWeave defines a `Null` data type for `null` values. It is important to note that `null` is the
value, while `Null` is the type. DataWeave functions do not recognize `Null` as a `null` value.

You can determine whether a DataWeave function accepts `null` values by looking in the DataWeave
reference documentation for a function signature that accepts a Null type. For example, the
[flatten](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-flatten#flatten2) function has two function signatures, one of which is
`flatten(Null): Null`. The signature indicates that `flatten` can accept `null` values. The
[++](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-plusplus) (concatenate) function, which lacks a signature for handling value
so the `Null` type, does not accept `null`.

- `flatten([[1],2,[null],null])` returns `[1,2,null,null]`

- `"a" ++ null` returns the error ``Unable to call `++` with (`String`, `Null`)``.

## Number (dw::Core Type)

There is only one Number type that supports both floating point and integer numbers. There is no
loss of precision in any operation, the engine always stores the data in the most performant way
that does not compromise precision.

DataWeave provides a mechanism for formatting numeric values and for coercing dates and strings to
numbers. The language also provides operators that act on numeric values and includes many functions
that take numeric values as arguments.

- [Type Coercion with DataWeave](https://docs.mulesoft.com/dataweave/2.4/dataweave-types-coercion##defining-dataweave-types-for-type-coercion)
  shows how to format a number.

- [mapObject](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-mapobject) provides an example that coerces a string to a number and
  formats the number.

- [Period Coercion](#period_coercion) and [Duration Coercion](#duration_coercion) include date
  coercion examples.

- [Operators](https://docs.mulesoft.com/dataweave/2.4/dw-operators) describes operators that act on numeric values.

- [avg](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-avg) is one of many DataWeave functions that accepts a numeric value. The
  `Number` type appears in its function signature, `avg(Array<Number>): Number`, which indicates
  that the function accepts an array of numeric values and returns a numeric value.

- The [Numbers](https://docs.mulesoft.com/dataweave/2.4/dw-numbers) module provides helper functions that work on numbers.

## Object (dw::Core Type)

Represents any object as a collection of `Key:value` pairs, where a `Key` is composed of a `Name`
and `Attributes`.

The `Name` type is composed of a `String` as the local name and the `Namespace`. `Attributes` is
composed of an Array of `Name:value` pairs. Note that the `Key` is not a `String`, so it is not
possible to compare keys. However, you can get the local name by performing an `as String` type
coercion on any value of type `Key`.

Example

```dataweave
%dw 2.0
output application/json
---
{
  name: "Annie"
}
```

### Single Value Objects

If an object has only one `key:value` pair, the enclosing curly braces `{ }` are not required:

Example

```dataweave
%dw 2.0
output application/json
---
name: "Annie"
```

### Conditional Elements

Objects can define conditional key-value pairs based on a conditional expression. Conditional
elements have the form `(key:value) if` condition.

```dataweave
%dw 2.0
output application/xml encoding="UTF-8"
---
file: {
  name: "transform",
  (extension: "zip") if payload.fileSystem?
}
```

This example outputs an additional field called "extension" only when the fileSystem property is
present in payload (this field may contain any value, not just `true`).

```xml
<?xml version="1.0" encoding="UTF-8"?>
<file>
  <name>transform</name>
  <extension>zip</extension>
</file>
```

If absent:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<file>
  <name>transform</name>
</file>
```

### Dynamic Keys

To specify a key through an expression, you need to wrap the expression in parentheses.

Transform

```dataweave
%dw 2.0
output application/json
var dynamicKey = "language"
---
{
  (dynamicKey): "Data Weave"
}
```

Output

```json
{
  "language": "Data Weave"
}
```

### Dynamic Elements

Dynamic elements allow you to add the result of an expression as `key:value` pairs of an object.
That expression must be either an `object` or an `array of objects`.

Transform

```dataweave
%dw 2.0
output application/json
var x = [
  {b: "b"},
  {c: "c", d: "d"}
]
var y = {e: "e"}
---
{
  a: "a",
  (x),
  (y)
}
```

The _evaluation parentheses_ around the variables in the body of the script above (`(x)` and `(y)`)
enable the object constructor curly braces (`{ }`) surrounding the body of the script to act on the
values of the variables. Specifically, the object constructor curly braces extract the key-value
pairs from the values of `x` and `y` and convert them into a collection of key-value pairs within an
object. Without the parentheses (for example, if you use `x` instead of `(x)`), the script returns
an error.

The object constructor curly braces require a data construct that contains one or more key-value
pairs, specifically an object, such as `{ "a":"one", "b":"two"}`, or an array of objects, such as
`[{"a":"one"},{"b":"two"}]` so that it can produce a valid object. Because the first element within
the object constructor curly braces is the key-value pair `a: "a"`, the object constructor curly
braces leave the pair as the first element in the output object, without any modifications. However,
the object constructor curly braces extract the outer-level key-value pairs in the evaluated
expressions `(x)` and `(y)` and append those key-value pairs to the output object.

Output

```json
{
  "a": "a",
  "b": "b",
  "c": "c",
  "d": "d",
  "e": "e"
}
```

### Conditional XML Attributes

You might want your output to only include certain XML attributes based on a condition. Conditional
elements have the form `(key:value) if condition`

Transform

```dataweave
%dw 2.0
output application/xml
---
{
  name @(
    (company: "Acme") if false,
    (transform: "Anything") if true
  ): "DataWeave"
}
```

Output

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<name transform="Anything">DataWeave</name>
```

### Dynamic XML Attributes

You might want to include a changing set of key:value pairs in a specific location as XML
attributes.

Input

```json
{
  "company": "Mule",
  "product": "DataWeave"
}
```

Transform

```dataweave
%dw 2.0
output application/xml
---
transformation @((payload)): "Transform from anything to anything"
```

Output

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<transformation company="Mule" product="DataWeave">Transform from anything to anything</transformation>
```

## Regex (dw::Core Type)

Regular Expressions are defined between `/`. For example `/\d+/` represents multiple numerical
digits from 0-9. These may be used as arguments in certain operations that act upon strings, like
Matches or Replace, or on operations that act upon objects and arrays, such as filters.

## String (dw::Core Type)

A string can be defined by the use of double quotes or single quotes.

```dataweave
{
  doubleQuoted: "Hello",
  singleQuoted: 'Hello',
}
```

### Escaping Special Characters

Use the backslash (`\`) to escape special characters in an input string:

- `$`: You need to escape any use of of `$` in a string. Otherwise, DataWeave treats the `$` as an
  unnamed parameter for a function and returns the error `Unable to resolve reference of $.`.

- `"`: For a string that is surrounded by double quotes, you need to escape any double quote that is
  part of the string, for example, `"a\"bcdef"`. Here, the second double-quote is part of the string
  that starts with an `a` and ends with `f`.

- `'` For a string that is surrounded by single quotes, you need to escape any single quote that is
  part of the string: for example, `'abcd\'e"f'`. In this example, the second single quote is part
  of the string that starts with an `a` and ends with `f`. Notice that you do not need to escape the
  double quote in this case.

- `` ` ``: For a string that is surrounded by backticks, you must escape any backtick that is part
  of the string: for example, `` `abc\`def` ``.

- `\`: Because the backslash is the character you use to escape other special characters, you need
  to escape it with a separate backslash to use it in a string, for example,`\\`.

- `\n`: For inserting a new line.

- `\t`: For inserting a tab.

- `\u`: For inserting a unicode character, such as `\u25c4`.

### String Interpolation

String interpolation allows you to embed variables or expressions directly in a string. The
expression need to be enclosed (`$( <expression> )`), and it should always return String type or
something that is coercible to String.

```dataweave
%dw 2.0
output application/json
var name = "Shoki"
---
{
    Greeting: "Hi, my name is $name",
    Sum: "1 + 1 = $(1 + 1)"
}
```

Output

```json
{
  "Greeting": "Hi, my name is Shoki",
  "Sum": "1 + 1 = 2"
}
```

## TryResult (dw::Runtime Type)

Evaluates the delegate and returns an object with the result or an error message. See the `try`
example. A successful `TryResult` contains the `result` field and a `success` value of `true`. An
unsuccessful `TryResult` contains the `error` field and a `success` value of `false`.

Definition

```dataweave
{
  success: Boolean,
  result?: T,
  error?: {
    kind: String,
    message: String,
    stack?: Array<String>,
    location?: String
  }
}
```

## URI Types (dw::core::URL)

Functions in the URI function module can return a URI data type.

Definition:

```dataweave
{
  isValid: Boolean,
  host?: String,
  authority?: String,
  fragment?: String,
  path?: String,
  port?: Number,
  query?: String,
  scheme?: String,
  user?: String,
  isAbsolute?: Boolean,
  isOpaque?: Boolean
}
```

The URI type consists of the following fields:

- `isValid`: Boolean that indicates whether the URI is valid. Invalid characters include `<`, `>`,
  and blank spaces.

- `host`: String representing the host name (for example, `my.company.com` from
  `http://my.company.com:8080/hello`)

- `authority`: String representing the authority, which includes the host and port (for example,
  `my.company.com:8080` from `http://my.company.com:8080/hello`). Returns the port only if it is
  explicitly specified in the URI.

- `fragment`: String representing the subordinate resource after the `#` in the URI (for example,
  `footer` in the URI `"https://en.wikipedia.org/wiki/Uniform_Resource_Identifier#footer"`).

- `path`: String representing a path following the host or authority (for example, `/hello` in
  `http://my.company.com:8080/hello`) .

- `port`: Number representing an explicit port in the URI (for example, `8080` in
  `http://my.company.com:8080/hello`). If no port is specified (for example,
  `http://my.company.com/hello`), the value of the `port` field is `null`.

- `query`: String identifying a query portion of a URI (for example, `field=value` in
  'http://my.company.com:1234/hello/?field=value').

- `scheme`: String identifying the URI scheme, such as `https` or `http`, which appears before a
  colon (`:`).

- `user`: String representing user information in a URI (for example, the `myname` in
  `http://myname@www.mycompany.com`).

- `isAbsolute`: Boolean value of `true` if the URI contains a scheme, `false` if the URI does not
  (for example, a relative URI such as `/path/to/somewhere`).

- `isOpaque`: Boolean value of `true` if the URI lacks a scheme followed by forward slashes (`/`).
  `mailto:somebody@somewhere.com` returns `true`.

The following DataWeave script uses the `parseURI` function to return and access values to fields
from a URI type. Note that fields with `null` values (for example, the URI defined by
`uriDataTypeEx`) are not returned unless you explicitly select them.

DataWeave Script

```dataweave
%dw 2.0
import * from dw::core::URL
var uriDataTypeEx = "https://en.wikipedia.org/wiki/Uniform_Resource_Identifier#footer"
var queryStringsEx = 'http://my.company.com:1234/hello/?field=value'
output application/json
---
{
    'myUriDataTypeEx': parseURI(uriDataTypeEx),
    // queryStringsEx has a query string:
    'myQueryStringsEx': parseURI(queryStringsEx).query,
    // uriDataTypeEx lacks a query string:
    'myQueryStringNullEx': parseURI(uriDataTypeEx).query,
    // The URI includes the port number:
    'myAuthorityEx': parseURI('http://localhost:8080/test').authority
}
```

Output

```JSON
{
  "myUriDataTypeEx": {
    "isValid": true,
    "raw": "https://en.wikipedia.org/wiki/Uniform_Resource_Identifier#footer",
    "host": "en.wikipedia.org",
    "authority": "en.wikipedia.org",
    "fragment": "footer",
    "path": "/wiki/Uniform_Resource_Identifier",
    "scheme": "https",
    "isAbsolute": true,
    "isOpaque": false
  },
  "myQueryStringsEx": "field=value",
  "myQueryStringNullEx": null,
  "myAuthorityEx": "localhost:8080"
}
```

## DataWeave Type References

You can find more data type documentation in the reference pages for the DataWeave function modules:

- [Core Types (dw::Core)](https://docs.mulesoft.com/dataweave/2.4/dw-core-types)

- [Coercions Types (dw::util::Coercions)](https://docs.mulesoft.com/dataweave/2.4/dw-coercions-types)

- [DataFormat Types (dw::extension::DataFormat)](https://docs.mulesoft.com/dataweave/2.4/dw-dataformat-types)

- [Dates Types (dw::core::Dates)](https://docs.mulesoft.com/dataweave/2.4/dw-dates-types)

- [Diff Types (dw::core::Diff)](https://docs.mulesoft.com/dataweave/2.4/dw-diff-types)

- [Mule Types (Mule)](https://docs.mulesoft.com/dataweave/2.4/dw-mule-types)

- [Multipart Types (dw::module::Multipart)](https://docs.mulesoft.com/dataweave/2.4/dw-multipart-types)

- [Runtime Types (dw::Runtime)](https://docs.mulesoft.com/dataweave/2.4/dw-runtime-types)

- [Timer Types (dw::core::Timer)](https://docs.mulesoft.com/dataweave/2.4/dw-timer-types)

- [Tree Types (dw::util::Tree)](https://docs.mulesoft.com/dataweave/2.4/dw-tree-types)

- [Types Types (dw::core::Types)](https://docs.mulesoft.com/dataweave/2.4/dw-types-types)

- [URL Types (dw::core::URL)](https://docs.mulesoft.com/dataweave/2.4/dw-url-types)

- [Values Types (dw::util::Values)](https://docs.mulesoft.com/dataweave/2.4/dw-values-types)

## See Also

- [DataWeave Scripts](https://docs.mulesoft.com/dataweave/2.4/dataweave-language-introduction)

- [Anypoint Exchange (List of Projects that use DataWeave)](https://anypoint.mulesoft.com/exchange/?search=dataweave)

<!-- document id=23f65dc288984f2ee9996001ce722a3d34c8195843b2b3c39e60e8c2561b48ad url=/mulesoft/current/en-us/dataweave/2.6/dataweave-types.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Value Constructs for Types

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave represents data using values, each of which has a data type associated with it. There are
many types, such as strings, arrays, Booleans, numbers, objects, dates, times, and others. Each type
supports several ways of creating its values. This topic explores many of the ways you can create
them.

The types that DataWeave provide are bundled into modules that also contain the related functions.

Types in the `dw::Core` module (Core types) are available without having to import the Core module.
Other modules need to be imported for their functions and types to be available.

It is important for you to know the values that are possible for each DataWeave type, how to create
those values, and the common patterns used:

- Conditional elements that use `if` expressions for [arrays](#conditional_elements_array) and
  [objects](#conditional_elements_object).

- [String Interpolation](#string_interpolation)

- [Date Decomposition](#date_decomposition) for accessing different parts of a date

- [Date and Time Formats](#date_format)

- [Dynamic Keys](#dynamic_keys) and [Dynamic Elements](#dynamic_elements), which allow you to access
  parts of an object dynamically

- Use of [Regex (dw::Core Type)](#dw_type_regex) expressions

## Array (dw::Core Type)

An array can hold elements of any supported type. Here is an example of an array:

Example: DataWeave Array

```dataweave
%dw 2.0
output application/json
var x = "words"
---
[ "My", "three", x ]
```

### Conditional Elements

Arrays can define elements that appear (or not) based on a condition.

Conditional elements take the form `(value) if condition`, for example:

Example: if Condition

```dataweave
%dw 2.0
output application/json
---
[(1) if true, (2) if false]
```

Output

```json
[1]
```

## Boolean (dw::Core Type)

A `Boolean` is defined by the keywords `true` and `false`.

## CData (dw::Core Type)

XML defines a custom type named `CData`, which inherits from and extends `String`. It is used to
identify a CDATA XML block. It can be used to tell the writer to wrap the content inside CDATA or to
check if the input string arrives inside a CDATA block.

Transform

```dataweave
%dw 2.0
output application/xml encoding="UTF-8"
---
{
  users:
  {
    user : "Mariano" as CData,
    age : 31 as CData
  }
}
```

Output

```xml
<?xml version="1.0" encoding="UTF-8"?>
<users>
  <user><![CDATA[Mariano]]></user>
  <age><![CDATA[31]]></age>
</users>
```

## Date and Time (dw::Core Types)

Dates in DataWeave follow the
[ISO-8601 standard](https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html)
and literals are defined between `|` characters.

The language has the following native date types:

- `Date`

- `DateTime`

- `LocalDateTime`

- `LocalTime`

- `Period`

- `Time`

- `TimeZone`

### Date

A `Date` represented by `Year`, `Month`, and `Day`, specified as `|uuuu-MM-dd|`. The `Date` type has
no time component.

Example

```dataweave
|2003-10-01|
```

### DateTime

A Date and Time within a TimeZone. It is the conjunction of `Date` + `Time` + `TimeZone`.

Example

```dataweave
|2003-10-01T23:57:59-03:00|
```

### LocalDateTime

A `DateTime` in the current `TimeZone`.

Example

```dataweave
|2003-10-01T23:57:59|
```

### LocalTime

A `Time` in the current `TimeZone`.

### Period

`Period` represents an amount of time. The type takes the following form:

- `P[n]Y[n]M[n]DT[n]H[n]M[n]S`

- `` P<date>T<time>` ``

Where the \[n\] is replaced by the value for each of the date and time elements that follow the
\[n\].

`Period` has two subcategories:

- `DatePeriod`  
  A date-based amount of time, for example, 1 year, 2 months, 3 days. Because these expressions are
  date-based, they cannot be converted to milliseconds. For example, a month does not specify
  whether it is a month of 31 days or not, nor does a year specify whether it is a leap year. The
  data expresses just an amount of date. In DataWeave, the syntax is `|P1Y|`.

- `Duration`  
  A time-based amount of time, for example, 1 second, 2 hours, or 2 days, each of which can be
  represented in seconds or milliseconds. In DataWeave, the syntax is `|PT1H|`.

`P` is the duration designator placed at the start of the duration representation.

- `Y` is the year designator (e.g. `|P1Y|`)

- `M` is the month designator (e.g. `|P1M|`)

- `D` is the day designator (e.g. `|P1D|`)

`T` is the time designator that precedes the time components of the representation.

- `H` is the hour designator (e.g. `|PT1H|`)

- `M` is the minute designator (e.g. `|PT1M|`)

- `S` is the second designator (e.g. `|PT1S|`)

`DatePeriod` is useful for date manipulation, such as addition or subtraction.  
The following example shows how to subtract one year from a date using `DatePeriod`. The return type
is a new `Date` value:

Source

```dataweave
output application/dw
---
|2003-10-01| - |P1Y|
```

Output

```dataweave
|2002-10-01|
```

`Duration` is useful as a result of a `Date` to `Date` subtraction so the amount of time between
those two dates can be inferred.  
The following example shows how subtracting one `Date` value from another returns a `Duration`
value:

Source

```dataweave
output application/dw
---
|2003-11-01| - |2003-10-01|
```

Output

```dataweave
|PT744H|
```

#### Period Coercion

Because a `DatePeriod` value is date-based, it can be coerced to `Number` date-based units, such as
`years` or `months`.  
The following example shows how to coerce a `DatePeriod` value to a `Number` value by using
different units:

Source

```dataweave
output application/json
---
{
 years:  |P1Y12M| as Number {unit: "years"},
 months: |P8Y12M| as Number {unit: "months"}
}
```

Output

```json
{
  "years": 2,
  "months": 108
}
```

#### Duration Coercion

Because `Duration` is time-based, this type can be coerced to a `Number` with different time-based
units, such as `nanos`, `milliseconds`, `seconds`, `hours`, and `days`.

The following example shows how to coerce a `Duration` to a `Number` by using different units:

Source

```dataweave
output application/json
var period = (|2010-12-10T12:10:12| - |2010-09-09T10:02:10|)
---
{
 nanos: period as Number {unit: "nanos"},
 millis: period as Number {unit: "milliseconds"},
 seconds: period as Number {unit: "seconds"},
 hours: period as Number {unit: "hours"},
 days: period as Number {unit: "days"}
}
```

Output

```json
{
  "nanos": 7956482000000000,
  "millis": 7956482000,
  "seconds": 7956482,
  "hours": 2210,
  "days": 92
}
```

#### Deconstruct

A `Duration` can be deconstructed into `hours`, `minutes` and `secs`.

The following example shows how to deconstruct a `Duration` value:

Source

```dataweave
%dw 2.0
output application/json
var period = (|2010-12-10T12:10:12| - |2010-12-10T10:02:10|)
---
{
   hours:  period.hours,
   minutes:  period.minutes,
   secs:  period.secs,
}
```

Output

```json
{
  "hours": 2,
  "minutes": 8,
  "secs": 2
}
```

### Time

A time in a specific `TimeZone`, specified as `|HH:mm:ss.SSS|`.

Example

```dataweave
|23:59:56|
```

### TimeZone

The `Time` relative to Greenwich Mean Time (GMT). A `TimeZone` must include a `+` or a `-`. For
example, `|03:00|` is a time, while `|+03:00|` is a `TimeZone`.

Example

```dataweave
|-08:00|
```

### Date Decomposition

To access the different parts of the date, special selectors must be used.

Transform

```dataweave
%dw 2.0
output application/json
var myDate = |2003-10-01T23:57:59.700-03:00|
---
{
  year: myDate.year,
  month: myDate.month,
  day: myDate.day,
  hour: myDate.hour,
  minutes: myDate.minutes,
  seconds: myDate.seconds,
  milliseconds: myDate.milliseconds,
  nanoseconds: myDate.nanoseconds,
  quarter: myDate.quarter,
  dayOfWeek: myDate.dayOfWeek,
  dayOfYear: myDate.dayOfYear,
  offsetSeconds: myDate.offsetSeconds
}
```

Output

```json
{
  "year": 2003,
  "month": 10,
  "day": 1,
  "hour": 23,
  "minutes": 57,
  "seconds": 59,
  "milliseconds": 700,
  "nanoseconds": 700000000,
  "quarter": 4,
  "dayOfWeek": 3,
  "dayOfYear": 274,
  "offsetSeconds": -10800
}
```

### Date and Time Formats

To enable you to format dates and times, DataWeave supports formatting characters, such as the `u`
(for the year), `M`, and `d` in the date format `uuuu-MM-dd`. These characters are based on the Java
8 `java.time.format` package.

For examples, see [Format Dates and Times](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-format-dates).

### Timezone IDs

In addition to accepting time zone values, such as `-07:00`, DataWeave also accepts IDs such as
`America/Buenos_Aires`, `America/Los_Angeles`, `Asia/Tokyo`, and `GMT`.

For examples and a list of supported IDs, see
[Time Zone IDs](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-change-time-zone#timezone-ids) and
[Change a Time Zone](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-format-dates).

## Enum (dw::Core Type)

This type is based on the
[Enum Java class](https://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html). It must always be
used with the `class` property, specifying the full Java class name of the class, as shown in this
example.

Transform

```dataweave
%dw 2.0
output application/java
---
"Male" as Enum {class: "com.acme.GenderEnum"}
```

## Iterator (dw::Core Type)

The `Iterator` type is based on the
[Iterator Java class](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html), that
iterates through arrays. `Iterator` contains a collection and includes methods to iterate through
and filter it.

Note that like the Java class, the iterator is designed to be consumed only once. For example, if a
logger consumes the value, the value is no longer readable by subsequent elements in the flow.

## Null (dw::Core Type)

DataWeave defines a `Null` data type for `null` values. It is important to note that `null` is the
value, while `Null` is the type. DataWeave functions do not recognize `Null` as a `null` value.

You can determine whether a DataWeave function accepts `null` values by looking in the DataWeave
reference documentation for a function signature that accepts a Null type. For example, the
[flatten](https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-flatten#flatten2) function has two function signatures, one of which is
`flatten(Null): Null`. The signature indicates that `flatten` can accept `null` values. The
[++](https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-plusplus) (concatenate) function, which lacks a signature for handling value
so the `Null` type, does not accept `null`.

- `flatten([[1],2,[null],null])` returns `[1,2,null,null]`

- `"a" ++ null` returns the error ``Unable to call `++` with (`String`, `Null`)``.

## Number (dw::Core Type)

There is only one Number type that supports both floating point and integer numbers. There is no
loss of precision in any operation, the engine always stores the data in the most performant way
that does not compromise precision.

DataWeave provides a mechanism for formatting numeric values and for coercing dates and strings to
numbers. The language also provides operators that act on numeric values and includes many functions
that take numeric values as arguments.

- [Type Coercion with DataWeave](https://docs.mulesoft.com/dataweave/2.6/dataweave-types-coercion##defining-dataweave-types-for-type-coercion)
  shows how to format a number.

- [mapObject](https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-mapobject) provides an example that coerces a string to a number and
  formats the number.

- [Period Coercion](#period_coercion) and [Duration Coercion](#duration_coercion) include date
  coercion examples.

- [Operators](https://docs.mulesoft.com/dataweave/2.6/dw-operators) describes operators that act on numeric values.

- [avg](https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-avg) is one of many DataWeave functions that accepts a numeric value. The
  `Number` type appears in its function signature, `avg(Array<Number>): Number`, which indicates
  that the function accepts an array of numeric values and returns a numeric value.

- The [Numbers](https://docs.mulesoft.com/dataweave/2.6/dw-numbers) module provides helper functions that work on numbers.

## Object (dw::Core Type)

Represents any object as a collection of `Key:value` pairs, where a `Key` is composed of a `Name`
and `Attributes`.

The `Name` type is composed of a `String` as the local name and the `Namespace`. `Attributes` is
composed of an Array of `Name:value` pairs. Note that the `Key` is not a `String`, so it is not
possible to compare keys. However, you can get the local name by performing an `as String` type
coercion on any value of type `Key`.

Example

```dataweave
%dw 2.0
output application/json
---
{
  name: "Annie"
}
```

### Single Value Objects

If an object has only one `key:value` pair, the enclosing curly braces `{ }` are not required:

Example

```dataweave
%dw 2.0
output application/json
---
name: "Annie"
```

### Conditional Elements

Objects can define conditional key-value pairs based on a conditional expression. Conditional
elements have the form `(key:value) if` condition.

```dataweave
%dw 2.0
output application/xml encoding="UTF-8"
---
file: {
  name: "transform",
  (extension: "zip") if payload.fileSystem?
}
```

This example outputs an additional field called "extension" only when the fileSystem property is
present in payload (this field may contain any value, not just `true`).

```xml
<?xml version="1.0" encoding="UTF-8"?>
<file>
  <name>transform</name>
  <extension>zip</extension>
</file>
```

If absent:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<file>
  <name>transform</name>
</file>
```

### Dynamic Keys

To specify a key through an expression, you need to wrap the expression in parentheses.

Transform

```dataweave
%dw 2.0
output application/json
var dynamicKey = "language"
---
{
  (dynamicKey): "Data Weave"
}
```

Output

```json
{
  "language": "Data Weave"
}
```

### Dynamic Elements

Dynamic elements allow you to add the result of an expression as `key:value` pairs of an object.
That expression must be either an `object` or an `array of objects`.

Transform

```dataweave
%dw 2.0
output application/json
var x = [
  {b: "b"},
  {c: "c", d: "d"}
]
var y = {e: "e"}
---
{
  a: "a",
  (x),
  (y)
}
```

The _evaluation parentheses_ around the variables in the body of the script above (`(x)` and `(y)`)
enable the object constructor curly braces (`{ }`) surrounding the body of the script to act on the
values of the variables. Specifically, the object constructor curly braces extract the key-value
pairs from the values of `x` and `y` and convert them into a collection of key-value pairs within an
object. Without the parentheses (for example, if you use `x` instead of `(x)`), the script returns
an error.

The object constructor curly braces require a data construct that contains one or more key-value
pairs, specifically an object, such as `{ "a":"one", "b":"two"}`, or an array of objects, such as
`[{"a":"one"},{"b":"two"}]` so that it can produce a valid object. Because the first element within
the object constructor curly braces is the key-value pair `a: "a"`, the object constructor curly
braces leave the pair as the first element in the output object, without any modifications. However,
the object constructor curly braces extract the outer-level key-value pairs in the evaluated
expressions `(x)` and `(y)` and append those key-value pairs to the output object.

Output

```json
{
  "a": "a",
  "b": "b",
  "c": "c",
  "d": "d",
  "e": "e"
}
```

### Conditional XML Attributes

You might want your output to only include certain XML attributes based on a condition. Conditional
elements have the form `(key:value) if condition`

Transform

```dataweave
%dw 2.0
output application/xml
---
{
  name @(
    (company: "Acme") if false,
    (transform: "Anything") if true
  ): "DataWeave"
}
```

Output

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<name transform="Anything">DataWeave</name>
```

### Dynamic XML Attributes

You might want to include a changing set of key:value pairs in a specific location as XML
attributes.

Input

```json
{
  "company": "Mule",
  "product": "DataWeave"
}
```

Transform

```dataweave
%dw 2.0
output application/xml
---
transformation @((payload)): "Transform from anything to anything"
```

Output

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<transformation company="Mule" product="DataWeave">Transform from anything to anything</transformation>
```

## Regex (dw::Core Type)

Regular Expressions are defined between `/`. For example `/\d+/` represents multiple numerical
digits from 0-9. These may be used as arguments in certain operations that act upon strings, like
Matches or Replace, or on operations that act upon objects and arrays, such as filters.

## String (dw::Core Type)

A string can be defined by the use of double quotes or single quotes.

```dataweave
{
  doubleQuoted: "Hello",
  singleQuoted: 'Hello',
}
```

### Escaping Special Characters

Use the backslash (`\`) to escape special characters in an input string:

- `$`: You need to escape any use of of `$` in a string. Otherwise, DataWeave treats the `$` as an
  unnamed parameter for a function and returns the error `Unable to resolve reference of $.`.

- `"`: For a string that is surrounded by double quotes, you need to escape any double quote that is
  part of the string, for example, `"a\"bcdef"`. Here, the second double-quote is part of the string
  that starts with an `a` and ends with `f`.

- `'` For a string that is surrounded by single quotes, you need to escape any single quote that is
  part of the string: for example, `'abcd\'e"f'`. In this example, the second single quote is part
  of the string that starts with an `a` and ends with `f`. Notice that you do not need to escape the
  double quote in this case.

- `` ` ``: For a string that is surrounded by backticks, you must escape any backtick that is part
  of the string: for example, `` `abc\`def` ``.

- `\`: Because the backslash is the character you use to escape other special characters, you need
  to escape it with a separate backslash to use it in a string, for example,`\\`.

- `\n`: For inserting a new line.

- `\t`: For inserting a tab.

- `\u`: For inserting a unicode character, such as `\u25c4`.

### String Interpolation

String interpolation allows you to embed variables or expressions directly in a string. The
expression need to be enclosed (`$( <expression> )`), and it should always return String type or
something that is coercible to String.

```dataweave
%dw 2.0
output application/json
var name = "Shoki"
---
{
    Greeting: "Hi, my name is $name",
    Sum: "1 + 1 = $(1 + 1)"
}
```

Output

```json
{
  "Greeting": "Hi, my name is Shoki",
  "Sum": "1 + 1 = 2"
}
```

## TryResult (dw::Runtime Type)

Evaluates the delegate and returns an object with the result or an error message. See the `try`
example. A successful `TryResult` contains the `result` field and a `success` value of `true`. An
unsuccessful `TryResult` contains the `error` field and a `success` value of `false`.

Definition

```dataweave
{
  success: Boolean,
  result?: T,
  error?: {
    kind: String,
    message: String,
    stack?: Array<String>,
    location?: String
  }
}
```

## URI Types (dw::core::URL)

Functions in the URI function module can return a URI data type.

Definition:

```dataweave
{
  isValid: Boolean,
  host?: String,
  authority?: String,
  fragment?: String,
  path?: String,
  port?: Number,
  query?: String,
  scheme?: String,
  user?: String,
  isAbsolute?: Boolean,
  isOpaque?: Boolean
}
```

The URI type consists of the following fields:

- `isValid`: Boolean that indicates whether the URI is valid. Invalid characters include `<`, `>`,
  and blank spaces.

- `host`: String representing the host name (for example, `my.company.com` from
  `http://my.company.com:8080/hello`)

- `authority`: String representing the authority, which includes the host and port (for example,
  `my.company.com:8080` from `http://my.company.com:8080/hello`). Returns the port only if it is
  explicitly specified in the URI.

- `fragment`: String representing the subordinate resource after the `#` in the URI (for example,
  `footer` in the URI `"https://en.wikipedia.org/wiki/Uniform_Resource_Identifier#footer"`).

- `path`: String representing a path following the host or authority (for example, `/hello` in
  `http://my.company.com:8080/hello`) .

- `port`: Number representing an explicit port in the URI (for example, `8080` in
  `http://my.company.com:8080/hello`). If no port is specified (for example,
  `http://my.company.com/hello`), the value of the `port` field is `null`.

- `query`: String identifying a query portion of a URI (for example, `field=value` in
  'http://my.company.com:1234/hello/?field=value').

- `scheme`: String identifying the URI scheme, such as `https` or `http`, which appears before a
  colon (`:`).

- `user`: String representing user information in a URI (for example, the `myname` in
  `http://myname@www.mycompany.com`).

- `isAbsolute`: Boolean value of `true` if the URI contains a scheme, `false` if the URI does not
  (for example, a relative URI such as `/path/to/somewhere`).

- `isOpaque`: Boolean value of `true` if the URI lacks a scheme followed by forward slashes (`/`).
  `mailto:somebody@somewhere.com` returns `true`.

The following DataWeave script uses the `parseURI` function to return and access values to fields
from a URI type. Note that fields with `null` values (for example, the URI defined by
`uriDataTypeEx`) are not returned unless you explicitly select them.

DataWeave Script

```dataweave
%dw 2.0
import * from dw::core::URL
var uriDataTypeEx = "https://en.wikipedia.org/wiki/Uniform_Resource_Identifier#footer"
var queryStringsEx = 'http://my.company.com:1234/hello/?field=value'
output application/json
---
{
    'myUriDataTypeEx': parseURI(uriDataTypeEx),
    // queryStringsEx has a query string:
    'myQueryStringsEx': parseURI(queryStringsEx).query,
    // uriDataTypeEx lacks a query string:
    'myQueryStringNullEx': parseURI(uriDataTypeEx).query,
    // The URI includes the port number:
    'myAuthorityEx': parseURI('http://localhost:8080/test').authority
}
```

Output

```JSON
{
  "myUriDataTypeEx": {
    "isValid": true,
    "raw": "https://en.wikipedia.org/wiki/Uniform_Resource_Identifier#footer",
    "host": "en.wikipedia.org",
    "authority": "en.wikipedia.org",
    "fragment": "footer",
    "path": "/wiki/Uniform_Resource_Identifier",
    "scheme": "https",
    "isAbsolute": true,
    "isOpaque": false
  },
  "myQueryStringsEx": "field=value",
  "myQueryStringNullEx": null,
  "myAuthorityEx": "localhost:8080"
}
```

## DataWeave Type References

You can find more data type documentation in the reference pages for the DataWeave function modules:

- [Core Types (dw::Core)](https://docs.mulesoft.com/dataweave/2.6/dw-core-types)

- [Coercions Types (dw::util::Coercions)](https://docs.mulesoft.com/dataweave/2.6/dw-coercions-types)

- [DataFormat Types (dw::extension::DataFormat)](https://docs.mulesoft.com/dataweave/2.6/dw-dataformat-types)

- [Dates Types (dw::core::Dates)](https://docs.mulesoft.com/dataweave/2.6/dw-dates-types)

- [Diff Types (dw::core::Diff)](https://docs.mulesoft.com/dataweave/2.6/dw-diff-types)

- [Mule Types (Mule)](https://docs.mulesoft.com/dataweave/2.6/dw-mule-types)

- [Multipart Types (dw::module::Multipart)](https://docs.mulesoft.com/dataweave/2.6/dw-multipart-types)

- [Runtime Types (dw::Runtime)](https://docs.mulesoft.com/dataweave/2.6/dw-runtime-types)

- [Timer Types (dw::core::Timer)](https://docs.mulesoft.com/dataweave/2.6/dw-timer-types)

- [Tree Types (dw::util::Tree)](https://docs.mulesoft.com/dataweave/2.6/dw-tree-types)

- [Types Types (dw::core::Types)](https://docs.mulesoft.com/dataweave/2.6/dw-types-types)

- [URL Types (dw::core::URL)](https://docs.mulesoft.com/dataweave/2.6/dw-url-types)

- [Values Types (dw::util::Values)](https://docs.mulesoft.com/dataweave/2.6/dw-values-types)

## See Also

- [DataWeave Scripts](https://docs.mulesoft.com/dataweave/2.6/dataweave-language-introduction)

- [Anypoint Exchange (List of Projects that use DataWeave)](https://anypoint.mulesoft.com/exchange/?search=dataweave)

<!-- document id=dece4fdd747782aeeebe8514dc9e206fc8370b40b49a504558d4d25ecf1adac8 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-types.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Value Constructs for Types

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave represents data using values, each of which has a data type associated with it. There are
many types, such as strings, arrays, Booleans, numbers, objects, dates, times, and others. Each type
supports several ways of creating its values. This topic explores many of the ways you can create
them.

The types that DataWeave provide are bundled into modules that also contain the related functions.

Types in the `dw::Core` module (Core types) are available without having to import the Core module.
Other modules need to be imported for their functions and types to be available.

It is important for you to know the values that are possible for each DataWeave type, how to create
those values, and the common patterns used:

- Conditional elements that use `if` expressions for [arrays](#conditional_elements_array) and
  [objects](#conditional_elements_object).

- [String Interpolation](#string_interpolation)

- [Date Decomposition](#date_decomposition) for accessing different parts of a date

- [Date and Time Formats](#date_format)

- [Dynamic Keys](#dynamic_keys) and [Dynamic Elements](#dynamic_elements), which allow you to access
  parts of an object dynamically

- Use of [Regex (dw::Core Type)](#dw_type_regex) expressions

## Array (dw::Core Type)

An array can hold elements of any supported type. Here is an example of an array:

Example: DataWeave Array

```dataweave
%dw 2.0
output application/json
var x = "words"
---
[ "My", "three", x ]
```

### Conditional Elements

Arrays can define elements that appear (or not) based on a condition.

Conditional elements take the form `(value) if condition`, for example:

Example: if Condition

```dataweave
%dw 2.0
output application/json
---
[(1) if true, (2) if false]
```

Output

```json
[1]
```

## Boolean (dw::Core Type)

A `Boolean` is defined by the keywords `true` and `false`.

## CData (dw::Core Type)

XML defines a custom type named `CData`, which inherits from and extends `String`. It is used to
identify a CDATA XML block. It can be used to tell the writer to wrap the content inside CDATA or to
check if the input string arrives inside a CDATA block.

Transform

```dataweave
%dw 2.0
output application/xml encoding="UTF-8"
---
{
  users:
  {
    user : "Mariano" as CData,
    age : 31 as CData
  }
}
```

Output

```xml
<?xml version="1.0" encoding="UTF-8"?>
<users>
  <user><![CDATA[Mariano]]></user>
  <age><![CDATA[31]]></age>
</users>
```

## Date and Time (dw::Core Types)

Dates in DataWeave follow the
[ISO-8601 standard](https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html)
and literals are defined between `|` characters.

The language has the following native date types:

- `Date`

- `DateTime`

- `LocalDateTime`

- `LocalTime`

- `Period`

- `Time`

- `TimeZone`

### Date

A `Date` represented by `Year`, `Month`, and `Day`, specified as `|uuuu-MM-dd|`. The `Date` type has
no time component.

Example

```dataweave
|2003-10-01|
```

### DateTime

A Date and Time within a TimeZone. It is the conjunction of `Date` + `Time` + `TimeZone`.

Example

```dataweave
|2003-10-01T23:57:59-03:00|
```

### LocalDateTime

A `DateTime` in the current `TimeZone`.

Example

```dataweave
|2003-10-01T23:57:59|
```

### LocalTime

A `Time` in the current `TimeZone`.

### Period

`Period` represents an amount of time. The type takes the following form:

- `P[n]Y[n]M[n]DT[n]H[n]M[n]S`

- `` P<date>T<time>` ``

Where the \[n\] is replaced by the value for each of the date and time elements that follow the
\[n\].

`Period` has two subcategories:

- `DatePeriod`  
  A date-based amount of time, for example, 1 year, 2 months, 3 days. Because these expressions are
  date-based, they cannot be converted to milliseconds. For example, a month does not specify
  whether it is a month of 31 days or not, nor does a year specify whether it is a leap year. The
  data expresses just an amount of date. In DataWeave, the syntax is `|P1Y|`.

- `Duration`  
  A time-based amount of time, for example, 1 second, 2 hours, or 2 days, each of which can be
  represented in seconds or milliseconds. In DataWeave, the syntax is `|PT1H|`.

`P` is the duration designator placed at the start of the duration representation.

- `Y` is the year designator (e.g. `|P1Y|`)

- `M` is the month designator (e.g. `|P1M|`)

- `D` is the day designator (e.g. `|P1D|`)

`T` is the time designator that precedes the time components of the representation.

- `H` is the hour designator (e.g. `|PT1H|`)

- `M` is the minute designator (e.g. `|PT1M|`)

- `S` is the second designator (e.g. `|PT1S|`)

`DatePeriod` is useful for date manipulation, such as addition or subtraction.  
The following example shows how to subtract one year from a date using `DatePeriod`. The return type
is a new `Date` value:

Source

```dataweave
output application/dw
---
|2003-10-01| - |P1Y|
```

Output

```dataweave
|2002-10-01|
```

`Duration` is useful as a result of a `Date` to `Date` subtraction so the amount of time between
those two dates can be inferred.  
The following example shows how subtracting one `Date` value from another returns a `Duration`
value:

Source

```dataweave
output application/dw
---
|2003-11-01| - |2003-10-01|
```

Output

```dataweave
|PT744H|
```

#### Period Coercion

Because a `DatePeriod` value is date-based, it can be coerced to `Number` date-based units, such as
`years` or `months`.  
The following example shows how to coerce a `DatePeriod` value to a `Number` value by using
different units:

Source

```dataweave
output application/json
---
{
 years:  |P1Y12M| as Number {unit: "years"},
 months: |P8Y12M| as Number {unit: "months"}
}
```

Output

```json
{
  "years": 2,
  "months": 108
}
```

#### Duration Coercion

Because `Duration` is time-based, this type can be coerced to a `Number` with different time-based
units, such as `nanos`, `milliseconds`, `seconds`, `hours`, and `days`.

The following example shows how to coerce a `Duration` to a `Number` by using different units:

Source

```dataweave
output application/json
var period = (|2010-12-10T12:10:12| - |2010-09-09T10:02:10|)
---
{
 nanos: period as Number {unit: "nanos"},
 millis: period as Number {unit: "milliseconds"},
 seconds: period as Number {unit: "seconds"},
 hours: period as Number {unit: "hours"},
 days: period as Number {unit: "days"}
}
```

Output

```json
{
  "nanos": 7956482000000000,
  "millis": 7956482000,
  "seconds": 7956482,
  "hours": 2210,
  "days": 92
}
```

#### Deconstruct

A `Duration` can be deconstructed into `hours`, `minutes` and `secs`.

The following example shows how to deconstruct a `Duration` value:

Source

```dataweave
%dw 2.0
output application/json
var period = (|2010-12-10T12:10:12| - |2010-12-10T10:02:10|)
---
{
   hours:  period.hours,
   minutes:  period.minutes,
   secs:  period.secs,
}
```

Output

```json
{
  "hours": 2,
  "minutes": 8,
  "secs": 2
}
```

### Time

A time in a specific `TimeZone`, specified as `|HH:mm:ss.SSS|`.

Example

```dataweave
|23:59:56|
```

### TimeZone

The `Time` relative to Greenwich Mean Time (GMT). A `TimeZone` must include a `+` or a `-`. For
example, `|03:00|` is a time, while `|+03:00|` is a `TimeZone`.

Example

```dataweave
|-08:00|
```

### Date Decomposition

To access the different parts of the date, special selectors must be used.

Transform

```dataweave
%dw 2.0
output application/json
var myDate = |2003-10-01T23:57:59.700-03:00|
---
{
  year: myDate.year,
  month: myDate.month,
  day: myDate.day,
  hour: myDate.hour,
  minutes: myDate.minutes,
  seconds: myDate.seconds,
  milliseconds: myDate.milliseconds,
  nanoseconds: myDate.nanoseconds,
  quarter: myDate.quarter,
  dayOfWeek: myDate.dayOfWeek,
  dayOfYear: myDate.dayOfYear,
  offsetSeconds: myDate.offsetSeconds
}
```

Output

```json
{
  "year": 2003,
  "month": 10,
  "day": 1,
  "hour": 23,
  "minutes": 57,
  "seconds": 59,
  "milliseconds": 700,
  "nanoseconds": 700000000,
  "quarter": 4,
  "dayOfWeek": 3,
  "dayOfYear": 274,
  "offsetSeconds": -10800
}
```

### Date and Time Formats

To enable you to format dates and times, DataWeave supports formatting characters, such as the `u`
(for the year), `M`, and `d` in the date format `uuuu-MM-dd`. These characters are based on the Java
8 `java.time.format` package.

For examples, see [Format Dates and Times](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-format-dates).

### Timezone IDs

In addition to accepting time zone values, such as `-07:00`, DataWeave also accepts IDs such as
`America/Buenos_Aires`, `America/Los_Angeles`, `Asia/Tokyo`, and `GMT`.

For examples and a list of supported IDs, see
[Time Zone IDs](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-change-time-zone#timezone-ids) and
[Change a Time Zone](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-format-dates).

## Enum (dw::Core Type)

This type is based on the
[Enum Java class](https://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html). It must always be
used with the `class` property, specifying the full Java class name of the class, as shown in this
example.

Transform

```dataweave
%dw 2.0
output application/java
---
"Male" as Enum {class: "com.acme.GenderEnum"}
```

## Iterator (dw::Core Type)

The `Iterator` type is based on the
[Iterator Java class](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html), that
iterates through arrays. `Iterator` contains a collection and includes methods to iterate through
and filter it.

Note that like the Java class, the iterator is designed to be consumed only once. For example, if a
logger consumes the value, the value is no longer readable by subsequent elements in the flow.

## Null (dw::Core Type)

DataWeave defines a `Null` data type for `null` values. It is important to note that `null` is the
value, while `Null` is the type. DataWeave functions do not recognize `Null` as a `null` value.

You can determine whether a DataWeave function accepts `null` values by looking in the DataWeave
reference documentation for a function signature that accepts a Null type. For example, the
[flatten](https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-flatten#flatten2) function has two function signatures, one of which is
`flatten(Null): Null`. The signature indicates that `flatten` can accept `null` values. The
[++](https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-plusplus) (concatenate) function, which lacks a signature for handling value
so the `Null` type, does not accept `null`.

- `flatten([[1],2,[null],null])` returns `[1,2,null,null]`

- `"a" ++ null` returns the error ``Unable to call `++` with (`String`, `Null`)``.

## Number (dw::Core Type)

There is only one Number type that supports both floating point and integer numbers. There is no
loss of precision in any operation, the engine always stores the data in the most performant way
that does not compromise precision.

DataWeave provides a mechanism for formatting numeric values and for coercing dates and strings to
numbers. The language also provides operators that act on numeric values and includes many functions
that take numeric values as arguments.

- [Type Coercion with DataWeave](https://docs.mulesoft.com/dataweave/2.9/dataweave-types-coercion##defining-dataweave-types-for-type-coercion)
  shows how to format a number.

- [mapObject](https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-mapobject) provides an example that coerces a string to a number and
  formats the number.

- [Period Coercion](#period_coercion) and [Duration Coercion](#duration_coercion) include date
  coercion examples.

- [Operators](https://docs.mulesoft.com/dataweave/2.9/dw-operators) describes operators that act on numeric values.

- [avg](https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-avg) is one of many DataWeave functions that accepts a numeric value. The
  `Number` type appears in its function signature, `avg(Array<Number>): Number`, which indicates
  that the function accepts an array of numeric values and returns a numeric value.

- The [Numbers](https://docs.mulesoft.com/dataweave/2.9/dw-numbers) module provides helper functions that work on numbers.

## Object (dw::Core Type)

Represents any object as a collection of `Key:value` pairs, where a `Key` is composed of a `Name`
and `Attributes`.

The `Name` type is composed of a `String` as the local name and the `Namespace`. `Attributes` is
composed of an Array of `Name:value` pairs. Note that the `Key` is not a `String`, so it is not
possible to compare keys. However, you can get the local name by performing an `as String` type
coercion on any value of type `Key`.

Example

```dataweave
%dw 2.0
output application/json
---
{
  name: "Annie"
}
```

### Single Value Objects

If an object has only one `key:value` pair, the enclosing curly braces `{ }` are not required:

Example

```dataweave
%dw 2.0
output application/json
---
name: "Annie"
```

### Conditional Elements

Objects can define conditional key-value pairs based on a conditional expression. Conditional
elements have the form `(key:value) if` condition.

```dataweave
%dw 2.0
output application/xml encoding="UTF-8"
---
file: {
  name: "transform",
  (extension: "zip") if payload.fileSystem?
}
```

This example outputs an additional field called "extension" only when the fileSystem property is
present in payload (this field may contain any value, not just `true`).

```xml
<?xml version="1.0" encoding="UTF-8"?>
<file>
  <name>transform</name>
  <extension>zip</extension>
</file>
```

If absent:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<file>
  <name>transform</name>
</file>
```

### Dynamic Keys

To specify a key through an expression, you need to wrap the expression in parentheses.

Transform

```dataweave
%dw 2.0
output application/json
var dynamicKey = "language"
---
{
  (dynamicKey): "Data Weave"
}
```

Output

```json
{
  "language": "Data Weave"
}
```

### Dynamic Elements

Dynamic elements allow you to add the result of an expression as `key:value` pairs of an object.
That expression must be either an `object` or an `array of objects`.

Transform

```dataweave
%dw 2.0
output application/json
var x = [
  {b: "b"},
  {c: "c", d: "d"}
]
var y = {e: "e"}
---
{
  a: "a",
  (x),
  (y)
}
```

The _evaluation parentheses_ around the variables in the body of the script above (`(x)` and `(y)`)
enable the object constructor curly braces (`{ }`) surrounding the body of the script to act on the
values of the variables. Specifically, the object constructor curly braces extract the key-value
pairs from the values of `x` and `y` and convert them into a collection of key-value pairs within an
object. Without the parentheses (for example, if you use `x` instead of `(x)`), the script returns
an error.

The object constructor curly braces require a data construct that contains one or more key-value
pairs, specifically an object, such as `{ "a":"one", "b":"two"}`, or an array of objects, such as
`[{"a":"one"},{"b":"two"}]` so that it can produce a valid object. Because the first element within
the object constructor curly braces is the key-value pair `a: "a"`, the object constructor curly
braces leave the pair as the first element in the output object, without any modifications. However,
the object constructor curly braces extract the outer-level key-value pairs in the evaluated
expressions `(x)` and `(y)` and append those key-value pairs to the output object.

Output

```json
{
  "a": "a",
  "b": "b",
  "c": "c",
  "d": "d",
  "e": "e"
}
```

### Conditional XML Attributes

You might want your output to only include certain XML attributes based on a condition. Conditional
elements have the form `(key:value) if condition`

Transform

```dataweave
%dw 2.0
output application/xml
---
{
  name @(
    (company: "Acme") if false,
    (transform: "Anything") if true
  ): "DataWeave"
}
```

Output

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<name transform="Anything">DataWeave</name>
```

### Dynamic XML Attributes

You might want to include a changing set of key:value pairs in a specific location as XML
attributes.

Input

```json
{
  "company": "Mule",
  "product": "DataWeave"
}
```

Transform

```dataweave
%dw 2.0
output application/xml
---
transformation @((payload)): "Transform from anything to anything"
```

Output

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<transformation company="Mule" product="DataWeave">Transform from anything to anything</transformation>
```

## Regex (dw::Core Type)

Regular Expressions are defined between `/`. For example `/\d+/` represents multiple numerical
digits from 0-9. These may be used as arguments in certain operations that act upon strings, like
Matches or Replace, or on operations that act upon objects and arrays, such as filters.

## String (dw::Core Type)

A string can be defined by the use of double quotes or single quotes.

```dataweave
{
  doubleQuoted: "Hello",
  singleQuoted: 'Hello',
}
```

### Escaping Special Characters

Use the backslash (`\`) to escape special characters in an input string:

- `$`: You need to escape any use of `$` in a string. Otherwise, DataWeave treats the `$` as an
  unnamed parameter for a function and returns the error `Unable to resolve reference of $.`.

- `"`: For a string that is surrounded by double quotes, you need to escape any double quote that is
  part of the string, for example, `"a\"bcdef"`. Here, the second double-quote is part of the string
  that starts with an `a` and ends with `f`.

- `'` For a string that is surrounded by single quotes, you need to escape any single quote that is
  part of the string: for example, `'abcd\'e"f'`. In this example, the second single quote is part
  of the string that starts with an `a` and ends with `f`. Notice that you do not need to escape the
  double quote in this case.

- `` ` ``: For a string that is surrounded by backticks, you must escape any backtick that is part
  of the string: for example, `` `abc\`def` ``.

- `\`: Because the backslash is the character you use to escape other special characters, you need
  to escape it with a separate backslash to use it in a string, for example,`\\`.

- `\n`: For inserting a new line.

- `\t`: For inserting a tab.

- `\u`: For inserting a unicode character, such as `\u25c4`.

### String Interpolation

String interpolation allows you to embed variables or expressions directly in a string. The
expression need to be enclosed (`$( <expression> )`), and it should always return String type or
something that is coercible to String.

```dataweave
%dw 2.0
output application/json
var name = "Shoki"
---
{
    Greeting: "Hi, my name is $name",
    Sum: "1 + 1 = $(1 + 1)"
}
```

Output

```json
{
  "Greeting": "Hi, my name is Shoki",
  "Sum": "1 + 1 = 2"
}
```

## TryResult (dw::Runtime Type)

Evaluates the delegate and returns an object with the result or an error message. See the `try`
example. A successful `TryResult` contains the `result` field and a `success` value of `true`. An
unsuccessful `TryResult` contains the `error` field and a `success` value of `false`.

Definition

```dataweave
{
  success: Boolean,
  result?: T,
  error?: {
    kind: String,
    message: String,
    stack?: Array<String>,
    location?: String
  }
}
```

## URI Types (dw::core::URL)

Functions in the URI function module can return a URI data type.

Definition:

```dataweave
{
  isValid: Boolean,
  host?: String,
  authority?: String,
  fragment?: String,
  path?: String,
  port?: Number,
  query?: String,
  scheme?: String,
  user?: String,
  isAbsolute?: Boolean,
  isOpaque?: Boolean
}
```

The URI type consists of the following fields:

- `isValid`: Boolean that indicates whether the URI is valid. Invalid characters include `<`, `>`,
  and blank spaces.

- `host`: String representing the host name (for example, `my.company.com` from
  `http://my.company.com:8080/hello`)

- `authority`: String representing the authority, which includes the host and port (for example,
  `my.company.com:8080` from `http://my.company.com:8080/hello`). Returns the port only if it is
  explicitly specified in the URI.

- `fragment`: String representing the subordinate resource after the `#` in the URI (for example,
  `footer` in the URI `"https://en.wikipedia.org/wiki/Uniform_Resource_Identifier#footer"`).

- `path`: String representing a path following the host or authority (for example, `/hello` in
  `http://my.company.com:8080/hello`) .

- `port`: Number representing an explicit port in the URI (for example, `8080` in
  `http://my.company.com:8080/hello`). If no port is specified (for example,
  `http://my.company.com/hello`), the value of the `port` field is `null`.

- `query`: String identifying a query portion of a URI (for example, `field=value` in
  'http://my.company.com:1234/hello/?field=value').

- `scheme`: String identifying the URI scheme, such as `https` or `http`, which appears before a
  colon (`:`).

- `user`: String representing user information in a URI (for example, the `myname` in
  `http://myname@www.mycompany.com`).

- `isAbsolute`: Boolean value of `true` if the URI contains a scheme, `false` if the URI does not
  (for example, a relative URI such as `/path/to/somewhere`).

- `isOpaque`: Boolean value of `true` if the URI lacks a scheme followed by forward slashes (`/`).
  `mailto:somebody@somewhere.com` returns `true`.

The following DataWeave script uses the `parseURI` function to return and access values to fields
from a URI type. Note that fields with `null` values (for example, the URI defined by
`uriDataTypeEx`) are not returned unless you explicitly select them.

DataWeave Script

```dataweave
%dw 2.0
import * from dw::core::URL
var uriDataTypeEx = "https://en.wikipedia.org/wiki/Uniform_Resource_Identifier#footer"
var queryStringsEx = 'http://my.company.com:1234/hello/?field=value'
output application/json
---
{
    'myUriDataTypeEx': parseURI(uriDataTypeEx),
    // queryStringsEx has a query string:
    'myQueryStringsEx': parseURI(queryStringsEx).query,
    // uriDataTypeEx lacks a query string:
    'myQueryStringNullEx': parseURI(uriDataTypeEx).query,
    // The URI includes the port number:
    'myAuthorityEx': parseURI('http://localhost:8080/test').authority
}
```

Output

```JSON
{
  "myUriDataTypeEx": {
    "isValid": true,
    "raw": "https://en.wikipedia.org/wiki/Uniform_Resource_Identifier#footer",
    "host": "en.wikipedia.org",
    "authority": "en.wikipedia.org",
    "fragment": "footer",
    "path": "/wiki/Uniform_Resource_Identifier",
    "scheme": "https",
    "isAbsolute": true,
    "isOpaque": false
  },
  "myQueryStringsEx": "field=value",
  "myQueryStringNullEx": null,
  "myAuthorityEx": "localhost:8080"
}
```

## DataWeave Type References

You can find more data type documentation in the reference pages for the DataWeave function modules:

- [Core Types (dw::Core)](https://docs.mulesoft.com/dataweave/2.9/dw-core-types)

- [Coercions Types (dw::util::Coercions)](https://docs.mulesoft.com/dataweave/2.9/dw-coercions-types)

- [DataFormat Types (dw::extension::DataFormat)](https://docs.mulesoft.com/dataweave/2.9/dw-dataformat-types)

- [Dates Types (dw::core::Dates)](https://docs.mulesoft.com/dataweave/2.9/dw-dates-types)

- [Diff Types (dw::core::Diff)](https://docs.mulesoft.com/dataweave/2.9/dw-diff-types)

- [Mule Types (Mule)](https://docs.mulesoft.com/dataweave/2.9/dw-mule-types)

- [Multipart Types (dw::module::Multipart)](https://docs.mulesoft.com/dataweave/2.9/dw-multipart-types)

- [Runtime Types (dw::Runtime)](https://docs.mulesoft.com/dataweave/2.9/dw-runtime-types)

- [Timer Types (dw::core::Timer)](https://docs.mulesoft.com/dataweave/2.9/dw-timer-types)

- [Tree Types (dw::util::Tree)](https://docs.mulesoft.com/dataweave/2.9/dw-tree-types)

- [Types Types (dw::core::Types)](https://docs.mulesoft.com/dataweave/2.9/dw-types-types)

- [URL Types (dw::core::URL)](https://docs.mulesoft.com/dataweave/2.9/dw-url-types)

- [Values Types (dw::util::Values)](https://docs.mulesoft.com/dataweave/2.9/dw-values-types)

## See Also

- [DataWeave Scripts](https://docs.mulesoft.com/dataweave/2.9/dataweave-language-introduction)

- [Anypoint Exchange (List of Projects that use DataWeave)](https://anypoint.mulesoft.com/exchange/?search=dataweave)

<!-- document id=436e4575caf16bcee85314800e42eb96b9fc4f73b36127182a941e8d664811df url=/mulesoft/current/en-us/dataweave/latest/dataweave-types.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Value Constructs for Types

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave represents data using values, each of which has a data type associated with it. There are
many types, such as strings, arrays, Booleans, numbers, objects, dates, times, and others. Each type
supports several ways of creating its values. This topic explores many of the ways you can create
them.

The types that DataWeave provide are bundled into modules that also contain the related functions.

Types in the `dw::Core` module (Core types) are available without having to import the Core module.
Other modules need to be imported for their functions and types to be available.

It is important for you to know the values that are possible for each DataWeave type, how to create
those values, and the common patterns used:

- Conditional elements that use `if` expressions for [arrays](#conditional_elements_array) and
  [objects](#conditional_elements_object).

- [String Interpolation](#string_interpolation)

- [Date Decomposition](#date_decomposition) for accessing different parts of a date

- [Date and Time Formats](#date_format)

- [Dynamic Keys](#dynamic_keys) and [Dynamic Elements](#dynamic_elements), which allow you to access
  parts of an object dynamically

- Use of [Regex (dw::Core Type)](#dw_type_regex) expressions

## Array (dw::Core Type)

An array can hold elements of any supported type. Here is an example of an array:

Example: DataWeave Array

```dataweave
%dw 2.0
output application/json
var x = "words"
---
[ "My", "three", x ]
```

### Conditional Elements

Arrays can define elements that appear (or not) based on a condition.

Conditional elements take the form `(value) if condition`, for example:

Example: if Condition

```dataweave
%dw 2.0
output application/json
---
[(1) if true, (2) if false]
```

Output

```json
[1]
```

## Boolean (dw::Core Type)

A `Boolean` is defined by the keywords `true` and `false`.

## CData (dw::Core Type)

XML defines a custom type named `CData`, which inherits from and extends `String`. It is used to
identify a CDATA XML block. It can be used to tell the writer to wrap the content inside CDATA or to
check if the input string arrives inside a CDATA block.

Transform

```dataweave
%dw 2.0
output application/xml encoding="UTF-8"
---
{
  users:
  {
    user : "Mariano" as CData,
    age : 31 as CData
  }
}
```

Output

```xml
<?xml version="1.0" encoding="UTF-8"?>
<users>
  <user><![CDATA[Mariano]]></user>
  <age><![CDATA[31]]></age>
</users>
```

## Date and Time (dw::Core Types)

Dates in DataWeave follow the
[ISO-8601 standard](https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html)
and literals are defined between `|` characters.

The language has the following native date types:

- `Date`

- `DateTime`

- `LocalDateTime`

- `LocalTime`

- `Period`

- `Time`

- `TimeZone`

### Date

A `Date` represented by `Year`, `Month`, and `Day`, specified as `|uuuu-MM-dd|`. The `Date` type has
no time component.

Example

```dataweave
|2003-10-01|
```

### DateTime

A Date and Time within a TimeZone. It is the conjunction of `Date` + `Time` + `TimeZone`.

Example

```dataweave
|2003-10-01T23:57:59-03:00|
```

### LocalDateTime

A `DateTime` in the current `TimeZone`.

Example

```dataweave
|2003-10-01T23:57:59|
```

### LocalTime

A `Time` in the current `TimeZone`.

### Period

`Period` represents an amount of time. The type takes the following form:

- `P[n]Y[n]M[n]DT[n]H[n]M[n]S`

- `` P<date>T<time>` ``

Where the \[n\] is replaced by the value for each of the date and time elements that follow the
\[n\].

`Period` has two subcategories:

- `DatePeriod`  
  A date-based amount of time, for example, 1 year, 2 months, 3 days. Because these expressions are
  date-based, they cannot be converted to milliseconds. For example, a month does not specify
  whether it is a month of 31 days or not, nor does a year specify whether it is a leap year. The
  data expresses just an amount of date. In DataWeave, the syntax is `|P1Y|`.

- `Duration`  
  A time-based amount of time, for example, 1 second, 2 hours, or 2 days, each of which can be
  represented in seconds or milliseconds. In DataWeave, the syntax is `|PT1H|`.

`P` is the duration designator placed at the start of the duration representation.

- `Y` is the year designator (e.g. `|P1Y|`)

- `M` is the month designator (e.g. `|P1M|`)

- `D` is the day designator (e.g. `|P1D|`)

`T` is the time designator that precedes the time components of the representation.

- `H` is the hour designator (e.g. `|PT1H|`)

- `M` is the minute designator (e.g. `|PT1M|`)

- `S` is the second designator (e.g. `|PT1S|`)

`DatePeriod` is useful for date manipulation, such as addition or subtraction.  
The following example shows how to subtract one year from a date using `DatePeriod`. The return type
is a new `Date` value:

Source

```dataweave
output application/dw
---
|2003-10-01| - |P1Y|
```

Output

```dataweave
|2002-10-01|
```

`Duration` is useful as a result of a `Date` to `Date` subtraction so the amount of time between
those two dates can be inferred.  
The following example shows how subtracting one `Date` value from another returns a `Duration`
value:

Source

```dataweave
output application/dw
---
|2003-11-01| - |2003-10-01|
```

Output

```dataweave
|PT744H|
```

#### Period Coercion

Because a `DatePeriod` value is date-based, it can be coerced to `Number` date-based units, such as
`years` or `months`.  
The following example shows how to coerce a `DatePeriod` value to a `Number` value by using
different units:

Source

```dataweave
output application/json
---
{
 years:  |P1Y12M| as Number {unit: "years"},
 months: |P8Y12M| as Number {unit: "months"}
}
```

Output

```json
{
  "years": 2,
  "months": 108
}
```

#### Duration Coercion

Because `Duration` is time-based, this type can be coerced to a `Number` with different time-based
units, such as `nanos`, `milliseconds`, `seconds`, `hours`, and `days`.

The following example shows how to coerce a `Duration` to a `Number` by using different units:

Source

```dataweave
output application/json
var period = (|2010-12-10T12:10:12| - |2010-09-09T10:02:10|)
---
{
 nanos: period as Number {unit: "nanos"},
 millis: period as Number {unit: "milliseconds"},
 seconds: period as Number {unit: "seconds"},
 hours: period as Number {unit: "hours"},
 days: period as Number {unit: "days"}
}
```

Output

```json
{
  "nanos": 7956482000000000,
  "millis": 7956482000,
  "seconds": 7956482,
  "hours": 2210,
  "days": 92
}
```

#### Deconstruct

A `Duration` can be deconstructed into `hours`, `minutes` and `secs`.

The following example shows how to deconstruct a `Duration` value:

Source

```dataweave
%dw 2.0
output application/json
var period = (|2010-12-10T12:10:12| - |2010-12-10T10:02:10|)
---
{
   hours:  period.hours,
   minutes:  period.minutes,
   secs:  period.secs,
}
```

Output

```json
{
  "hours": 2,
  "minutes": 8,
  "secs": 2
}
```

### Time

A time in a specific `TimeZone`, specified as `|HH:mm:ss.SSS|`.

Example

```dataweave
|23:59:56|
```

### TimeZone

The `Time` relative to Greenwich Mean Time (GMT). A `TimeZone` must include a `+` or a `-`. For
example, `|03:00|` is a time, while `|+03:00|` is a `TimeZone`.

Example

```dataweave
|-08:00|
```

### Date Decomposition

To access the different parts of the date, special selectors must be used.

Transform

```dataweave
%dw 2.0
output application/json
var myDate = |2003-10-01T23:57:59.700-03:00|
---
{
  year: myDate.year,
  month: myDate.month,
  day: myDate.day,
  hour: myDate.hour,
  minutes: myDate.minutes,
  seconds: myDate.seconds,
  milliseconds: myDate.milliseconds,
  nanoseconds: myDate.nanoseconds,
  quarter: myDate.quarter,
  dayOfWeek: myDate.dayOfWeek,
  dayOfYear: myDate.dayOfYear,
  offsetSeconds: myDate.offsetSeconds
}
```

Output

```json
{
  "year": 2003,
  "month": 10,
  "day": 1,
  "hour": 23,
  "minutes": 57,
  "seconds": 59,
  "milliseconds": 700,
  "nanoseconds": 700000000,
  "quarter": 4,
  "dayOfWeek": 3,
  "dayOfYear": 274,
  "offsetSeconds": -10800
}
```

### Date and Time Formats

To enable you to format dates and times, DataWeave supports formatting characters, such as the `u`
(for the year), `M`, and `d` in the date format `uuuu-MM-dd`. These characters are based on the Java
8 `java.time.format` package.

For examples, see [Format Dates and Times](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-format-dates).

### Timezone IDs

In addition to accepting time zone values, such as `-07:00`, DataWeave also accepts IDs such as
`America/Buenos_Aires`, `America/Los_Angeles`, `Asia/Tokyo`, and `GMT`.

For examples and a list of supported IDs, see
[Time Zone IDs](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-change-time-zone#timezone-ids) and
[Change a Time Zone](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-format-dates).

## Enum (dw::Core Type)

This type is based on the
[Enum Java class](https://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html). It must always be
used with the `class` property, specifying the full Java class name of the class, as shown in this
example.

Transform

```dataweave
%dw 2.0
output application/java
---
"Male" as Enum {class: "com.acme.GenderEnum"}
```

## Iterator (dw::Core Type)

The `Iterator` type is based on the
[Iterator Java class](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html), that
iterates through arrays. `Iterator` contains a collection and includes methods to iterate through
and filter it.

Note that like the Java class, the iterator is designed to be consumed only once. For example, if a
logger consumes the value, the value is no longer readable by subsequent elements in the flow.

## Null (dw::Core Type)

DataWeave defines a `Null` data type for `null` values. It is important to note that `null` is the
value, while `Null` is the type. DataWeave functions do not recognize `Null` as a `null` value.

You can determine whether a DataWeave function accepts `null` values by looking in the DataWeave
reference documentation for a function signature that accepts a Null type. For example, the
[flatten](https://docs.mulesoft.com/dataweave/latest/dw-core-functions-flatten#flatten2) function has two function signatures, one of which is
`flatten(Null): Null`. The signature indicates that `flatten` can accept `null` values. The
[++](https://docs.mulesoft.com/dataweave/latest/dw-core-functions-plusplus) (concatenate) function, which lacks a signature for handling value
so the `Null` type, does not accept `null`.

- `flatten([[1],2,[null],null])` returns `[1,2,null,null]`

- `"a" ++ null` returns the error ``Unable to call `++` with (`String`, `Null`)``.

## Number (dw::Core Type)

There is only one Number type that supports both floating point and integer numbers. There is no
loss of precision in any operation, the engine always stores the data in the most performant way
that does not compromise precision.

DataWeave provides a mechanism for formatting numeric values and for coercing dates and strings to
numbers. The language also provides operators that act on numeric values and includes many functions
that take numeric values as arguments.

- [Type Coercion with DataWeave](https://docs.mulesoft.com/dataweave/latest/dataweave-types-coercion##defining-dataweave-types-for-type-coercion)
  shows how to format a number.

- [mapObject](https://docs.mulesoft.com/dataweave/latest/dw-core-functions-mapobject) provides an example that coerces a string to a number and
  formats the number.

- [Period Coercion](#period_coercion) and [Duration Coercion](#duration_coercion) include date
  coercion examples.

- [Operators](https://docs.mulesoft.com/dataweave/latest/dw-operators) describes operators that act on numeric values.

- [avg](https://docs.mulesoft.com/dataweave/latest/dw-core-functions-avg) is one of many DataWeave functions that accepts a numeric value. The
  `Number` type appears in its function signature, `avg(Array<Number>): Number`, which indicates
  that the function accepts an array of numeric values and returns a numeric value.

- The [Numbers](https://docs.mulesoft.com/dataweave/latest/dw-numbers) module provides helper functions that work on numbers.

## Object (dw::Core Type)

Represents any object as a collection of `Key:value` pairs, where a `Key` is composed of a `Name`
and `Attributes`.

The `Name` type is composed of a `String` as the local name and the `Namespace`. `Attributes` is
composed of an Array of `Name:value` pairs. Note that the `Key` is not a `String`, so it is not
possible to compare keys. However, you can get the local name by performing an `as String` type
coercion on any value of type `Key`.

Example

```dataweave
%dw 2.0
output application/json
---
{
  name: "Annie"
}
```

### Single Value Objects

If an object has only one `key:value` pair, the enclosing curly braces `{ }` are not required:

Example

```dataweave
%dw 2.0
output application/json
---
name: "Annie"
```

### Conditional Elements

Objects can define conditional key-value pairs based on a conditional expression. Conditional
elements have the form `(key:value) if` condition.

```dataweave
%dw 2.0
output application/xml encoding="UTF-8"
---
file: {
  name: "transform",
  (extension: "zip") if payload.fileSystem?
}
```

This example outputs an additional field called "extension" only when the fileSystem property is
present in payload (this field may contain any value, not just `true`).

```xml
<?xml version="1.0" encoding="UTF-8"?>
<file>
  <name>transform</name>
  <extension>zip</extension>
</file>
```

If absent:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<file>
  <name>transform</name>
</file>
```

### Dynamic Keys

To specify a key through an expression, you need to wrap the expression in parentheses.

Transform

```dataweave
%dw 2.0
output application/json
var dynamicKey = "language"
---
{
  (dynamicKey): "Data Weave"
}
```

Output

```json
{
  "language": "Data Weave"
}
```

### Dynamic Elements

Dynamic elements allow you to add the result of an expression as `key:value` pairs of an object.
That expression must be either an `object` or an `array of objects`.

Transform

```dataweave
%dw 2.0
output application/json
var x = [
  {b: "b"},
  {c: "c", d: "d"}
]
var y = {e: "e"}
---
{
  a: "a",
  (x),
  (y)
}
```

The _evaluation parentheses_ around the variables in the body of the script above (`(x)` and `(y)`)
enable the object constructor curly braces (`{ }`) surrounding the body of the script to act on the
values of the variables. Specifically, the object constructor curly braces extract the key-value
pairs from the values of `x` and `y` and convert them into a collection of key-value pairs within an
object. Without the parentheses (for example, if you use `x` instead of `(x)`), the script returns
an error.

The object constructor curly braces require a data construct that contains one or more key-value
pairs, specifically an object, such as `{ "a":"one", "b":"two"}`, or an array of objects, such as
`[{"a":"one"},{"b":"two"}]` so that it can produce a valid object. Because the first element within
the object constructor curly braces is the key-value pair `a: "a"`, the object constructor curly
braces leave the pair as the first element in the output object, without any modifications. However,
the object constructor curly braces extract the outer-level key-value pairs in the evaluated
expressions `(x)` and `(y)` and append those key-value pairs to the output object.

Output

```json
{
  "a": "a",
  "b": "b",
  "c": "c",
  "d": "d",
  "e": "e"
}
```

### Conditional XML Attributes

You might want your output to only include certain XML attributes based on a condition. Conditional
elements have the form `(key:value) if condition`

Transform

```dataweave
%dw 2.0
output application/xml
---
{
  name @(
    (company: "Acme") if false,
    (transform: "Anything") if true
  ): "DataWeave"
}
```

Output

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<name transform="Anything">DataWeave</name>
```

### Dynamic XML Attributes

You might want to include a changing set of key:value pairs in a specific location as XML
attributes.

Input

```json
{
  "company": "Mule",
  "product": "DataWeave"
}
```

Transform

```dataweave
%dw 2.0
output application/xml
---
transformation @((payload)): "Transform from anything to anything"
```

Output

```xml
<?xml version='1.0' encoding='US-ASCII'?>
<transformation company="Mule" product="DataWeave">Transform from anything to anything</transformation>
```

## Regex (dw::Core Type)

Regular Expressions are defined between `/`. For example `/\d+/` represents multiple numerical
digits from 0-9. These may be used as arguments in certain operations that act upon strings, like
Matches or Replace, or on operations that act upon objects and arrays, such as filters.

## String (dw::Core Type)

A string can be defined by the use of double quotes or single quotes.

```dataweave
{
  doubleQuoted: "Hello",
  singleQuoted: 'Hello',
}
```

### Escaping Special Characters

Use the backslash (`\`) to escape special characters in an input string:

- `$`: You need to escape any use of `$` in a string. Otherwise, DataWeave treats the `$` as an
  unnamed parameter for a function and returns the error `Unable to resolve reference of $.`.

- `"`: For a string that is surrounded by double quotes, you need to escape any double quote that is
  part of the string, for example, `"a\"bcdef"`. Here, the second double-quote is part of the string
  that starts with an `a` and ends with `f`.

- `'` For a string that is surrounded by single quotes, you need to escape any single quote that is
  part of the string: for example, `'abcd\'e"f'`. In this example, the second single quote is part
  of the string that starts with an `a` and ends with `f`. Notice that you do not need to escape the
  double quote in this case.

- `` ` ``: For a string that is surrounded by backticks, you must escape any backtick that is part
  of the string: for example, `` `abc\`def` ``.

- `\`: Because the backslash is the character you use to escape other special characters, you need
  to escape it with a separate backslash to use it in a string, for example,`\\`.

- `\n`: For inserting a new line.

- `\t`: For inserting a tab.

- `\u`: For inserting a unicode character, such as `\u25c4`.

### String Interpolation

String interpolation allows you to embed variables or expressions directly in a string. The
expression need to be enclosed (`$( <expression> )`), and it should always return String type or
something that is coercible to String.

```dataweave
%dw 2.0
output application/json
var name = "Shoki"
---
{
    Greeting: "Hi, my name is $name",
    Sum: "1 + 1 = $(1 + 1)"
}
```

Output

```json
{
  "Greeting": "Hi, my name is Shoki",
  "Sum": "1 + 1 = 2"
}
```

## TryResult (dw::Runtime Type)

Evaluates the delegate and returns an object with the result or an error message. See the `try`
example. A successful `TryResult` contains the `result` field and a `success` value of `true`. An
unsuccessful `TryResult` contains the `error` field and a `success` value of `false`.

Definition

```dataweave
{
  success: Boolean,
  result?: T,
  error?: {
    kind: String,
    message: String,
    stack?: Array<String>,
    location?: String
  }
}
```

## URI Types (dw::core::URL)

Functions in the URI function module can return a URI data type.

Definition:

```dataweave
{
  isValid: Boolean,
  host?: String,
  authority?: String,
  fragment?: String,
  path?: String,
  port?: Number,
  query?: String,
  scheme?: String,
  user?: String,
  isAbsolute?: Boolean,
  isOpaque?: Boolean
}
```

The URI type consists of the following fields:

- `isValid`: Boolean that indicates whether the URI is valid. Invalid characters include `<`, `>`,
  and blank spaces.

- `host`: String representing the host name (for example, `my.company.com` from
  `http://my.company.com:8080/hello`)

- `authority`: String representing the authority, which includes the host and port (for example,
  `my.company.com:8080` from `http://my.company.com:8080/hello`). Returns the port only if it is
  explicitly specified in the URI.

- `fragment`: String representing the subordinate resource after the `#` in the URI (for example,
  `footer` in the URI `"https://en.wikipedia.org/wiki/Uniform_Resource_Identifier#footer"`).

- `path`: String representing a path following the host or authority (for example, `/hello` in
  `http://my.company.com:8080/hello`) .

- `port`: Number representing an explicit port in the URI (for example, `8080` in
  `http://my.company.com:8080/hello`). If no port is specified (for example,
  `http://my.company.com/hello`), the value of the `port` field is `null`.

- `query`: String identifying a query portion of a URI (for example, `field=value` in
  'http://my.company.com:1234/hello/?field=value').

- `scheme`: String identifying the URI scheme, such as `https` or `http`, which appears before a
  colon (`:`).

- `user`: String representing user information in a URI (for example, the `myname` in
  `http://myname@www.mycompany.com`).

- `isAbsolute`: Boolean value of `true` if the URI contains a scheme, `false` if the URI does not
  (for example, a relative URI such as `/path/to/somewhere`).

- `isOpaque`: Boolean value of `true` if the URI lacks a scheme followed by forward slashes (`/`).
  `mailto:somebody@somewhere.com` returns `true`.

The following DataWeave script uses the `parseURI` function to return and access values to fields
from a URI type. Note that fields with `null` values (for example, the URI defined by
`uriDataTypeEx`) are not returned unless you explicitly select them.

DataWeave Script

```dataweave
%dw 2.0
import * from dw::core::URL
var uriDataTypeEx = "https://en.wikipedia.org/wiki/Uniform_Resource_Identifier#footer"
var queryStringsEx = 'http://my.company.com:1234/hello/?field=value'
output application/json
---
{
    'myUriDataTypeEx': parseURI(uriDataTypeEx),
    // queryStringsEx has a query string:
    'myQueryStringsEx': parseURI(queryStringsEx).query,
    // uriDataTypeEx lacks a query string:
    'myQueryStringNullEx': parseURI(uriDataTypeEx).query,
    // The URI includes the port number:
    'myAuthorityEx': parseURI('http://localhost:8080/test').authority
}
```

Output

```JSON
{
  "myUriDataTypeEx": {
    "isValid": true,
    "raw": "https://en.wikipedia.org/wiki/Uniform_Resource_Identifier#footer",
    "host": "en.wikipedia.org",
    "authority": "en.wikipedia.org",
    "fragment": "footer",
    "path": "/wiki/Uniform_Resource_Identifier",
    "scheme": "https",
    "isAbsolute": true,
    "isOpaque": false
  },
  "myQueryStringsEx": "field=value",
  "myQueryStringNullEx": null,
  "myAuthorityEx": "localhost:8080"
}
```

## DataWeave Type References

You can find more data type documentation in the reference pages for the DataWeave function modules:

- [Core Types (dw::Core)](https://docs.mulesoft.com/dataweave/latest/dw-core-types)

- [Coercions Types (dw::util::Coercions)](https://docs.mulesoft.com/dataweave/latest/dw-coercions-types)

- [DataFormat Types (dw::extension::DataFormat)](https://docs.mulesoft.com/dataweave/latest/dw-dataformat-types)

- [Dates Types (dw::core::Dates)](https://docs.mulesoft.com/dataweave/latest/dw-dates-types)

- [Diff Types (dw::core::Diff)](https://docs.mulesoft.com/dataweave/latest/dw-diff-types)

- [Mule Types (Mule)](https://docs.mulesoft.com/dataweave/latest/dw-mule-types)

- [Multipart Types (dw::module::Multipart)](https://docs.mulesoft.com/dataweave/latest/dw-multipart-types)

- [Runtime Types (dw::Runtime)](https://docs.mulesoft.com/dataweave/latest/dw-runtime-types)

- [Timer Types (dw::core::Timer)](https://docs.mulesoft.com/dataweave/latest/dw-timer-types)

- [Tree Types (dw::util::Tree)](https://docs.mulesoft.com/dataweave/latest/dw-tree-types)

- [Types Types (dw::core::Types)](https://docs.mulesoft.com/dataweave/latest/dw-types-types)

- [URL Types (dw::core::URL)](https://docs.mulesoft.com/dataweave/latest/dw-url-types)

- [Values Types (dw::util::Values)](https://docs.mulesoft.com/dataweave/latest/dw-values-types)

## See Also

- [DataWeave Scripts](https://docs.mulesoft.com/dataweave/latest/dataweave-language-introduction)

- [Anypoint Exchange (List of Projects that use DataWeave)](https://anypoint.mulesoft.com/exchange/?search=dataweave)

<!-- document id=739e0813852d8f0e571f043ede6160e49ff1c706f0b891fbc4a5a8f07e1341e7 url=/mulesoft/current/en-us/dataweave/2.11/dw-values.md -->

---
product: DataWeave
version: 2.11
---

# Values (dw::util::Values)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This utility module simplifies changes to values.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::util::Values` to the header of your DataWeave script.

_Introduced in DataWeave version 2.2.2._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-values-functions-attr">attr</a></p></td><td><p>This function creates a <code>PathElement</code> to use for selecting an XML attribute and populates the type’s <code>selector</code> field with the given string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-values-functions-field">field</a></p></td><td><p>This function creates a <code>PathElement</code> data type to use for selecting an <em>object field</em> and populates the type’s <code>selector</code> field with the given string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-values-functions-index">index</a></p></td><td><p>This function creates a <code>PathElement</code> data type to use for selecting an <em>array element</em> and populates the type’s <code>selector</code> field with the specified index.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-values-functions-mask">mask</a></p></td><td><p>This <code>mask</code> function replaces all <em>simple</em> elements that match the specified criteria.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.11/dw-values-functions-update">update</a></p></td><td><p>This <code>update</code> function updates a field in an object with the specified string value.</p></td></tr></tbody></table>

## Types

- [Values Types](https://docs.mulesoft.com/dataweave/2.11/dw-values-types)

<!-- document id=29cea9defaee9466809bb4fdc7d1c162e46fe89328e1b3342329c9ecded74256 url=/mulesoft/current/en-us/dataweave/2.12/dw-values.md -->

---
product: DataWeave
version: 2.12
---

# Values (dw::util::Values)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This utility module simplifies changes to values.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::util::Values` to the header of your DataWeave script.

_Introduced in DataWeave version 2.2.2._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-values-functions-attr">attr</a></p></td><td><p>This function creates a <code>PathElement</code> to use for selecting an XML attribute and populates the type’s <code>selector</code> field with the given string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-values-functions-field">field</a></p></td><td><p>This function creates a <code>PathElement</code> data type to use for selecting an <em>object field</em> and populates the type’s <code>selector</code> field with the given string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-values-functions-index">index</a></p></td><td><p>This function creates a <code>PathElement</code> data type to use for selecting an <em>array element</em> and populates the type’s <code>selector</code> field with the specified index.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-values-functions-mask">mask</a></p></td><td><p>This <code>mask</code> function replaces all <em>simple</em> elements that match the specified criteria.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.12/dw-values-functions-update">update</a></p></td><td><p>This <code>update</code> function updates a field in an object with the specified string value.</p></td></tr></tbody></table>

## Types

- [Values Types](https://docs.mulesoft.com/dataweave/2.12/dw-values-types)

<!-- document id=a6d7796c62d018cc163b6cab0648031ebd627f5018168521d409d6bd7ad70ec1 url=/mulesoft/current/en-us/dataweave/2.3/dw-values.md -->

---
product: DataWeave
version: 2.3
---

# Values (dw::util::Values)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This utility module simplifies changes to values.

The module is included with Mule runtime. To use it, you must import it into your DataWeave code,
for example, by adding the line `import * from dw::util::Values` to the header of your script.

_Introduced in DataWeave 2.2.2. Supported by Mule 4.2.2 and later._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-values-functions-attr">attr</a></p></td><td><p>This function creates a <code>PathElement</code> to use for selecting an XML attribute and populates the type’s <code>selector</code> field with the given string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-values-functions-field">field</a></p></td><td><p>This function creates a <code>PathElement</code> data type to use for selecting an <em>object field</em> and populates the type’s <code>selector</code> field with the given string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-values-functions-index">index</a></p></td><td><p>This function creates a <code>PathElement</code> data type to use for selecting an <em>array element</em> and populates the type’s <code>selector</code> field with the specified index.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-values-functions-mask">mask</a></p></td><td><p>This <code>mask</code> function replaces all <em>simple</em> elements that match the specified criteria.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.3/dw-values-functions-update">update</a></p></td><td><p>This <code>update</code> function updates a field in an object with the specified string value.</p></td></tr></tbody></table>

<!-- document id=bfba088474dbe7dcafbeb69c47e20209fc4329394dffcb89432a4280dad75860 url=/mulesoft/current/en-us/dataweave/2.4/dw-values.md -->

---
product: DataWeave
version: 2.4
---

# Values (dw::util::Values)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This utility module simplifies changes to values.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::util::Values` to the header of your DataWeave script.

_Introduced in DataWeave version 2.2.2._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-values-functions-attr">attr</a></p></td><td><p>This function creates a <code>PathElement</code> to use for selecting an XML attribute and populates the type’s <code>selector</code> field with the given string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-values-functions-field">field</a></p></td><td><p>This function creates a <code>PathElement</code> data type to use for selecting an <em>object field</em> and populates the type’s <code>selector</code> field with the given string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-values-functions-index">index</a></p></td><td><p>This function creates a <code>PathElement</code> data type to use for selecting an <em>array element</em> and populates the type’s <code>selector</code> field with the specified index.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-values-functions-mask">mask</a></p></td><td><p>This <code>mask</code> function replaces all <em>simple</em> elements that match the specified criteria.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.4/dw-values-functions-update">update</a></p></td><td><p>This <code>update</code> function updates a field in an object with the specified string value.</p></td></tr></tbody></table>

## Types

- [Values Types](https://docs.mulesoft.com/dataweave/2.4/dw-values-types)

<!-- document id=12d0fc2e46762e475adefd78e80d859ae2f6ccf484291385406a2a5a364c47a7 url=/mulesoft/current/en-us/dataweave/2.6/dw-values.md -->

---
product: DataWeave
version: 2.6
---

# Values (dw::util::Values)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This utility module simplifies changes to values.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::util::Values` to the header of your DataWeave script.

_Introduced in DataWeave version 2.2.2._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-values-functions-attr">attr</a></p></td><td><p>This function creates a <code>PathElement</code> to use for selecting an XML attribute and populates the type’s <code>selector</code> field with the given string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-values-functions-field">field</a></p></td><td><p>This function creates a <code>PathElement</code> data type to use for selecting an <em>object field</em> and populates the type’s <code>selector</code> field with the given string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-values-functions-index">index</a></p></td><td><p>This function creates a <code>PathElement</code> data type to use for selecting an <em>array element</em> and populates the type’s <code>selector</code> field with the specified index.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-values-functions-mask">mask</a></p></td><td><p>This <code>mask</code> function replaces all <em>simple</em> elements that match the specified criteria.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.6/dw-values-functions-update">update</a></p></td><td><p>This <code>update</code> function updates a field in an object with the specified string value.</p></td></tr></tbody></table>

## Types

- [Values Types](https://docs.mulesoft.com/dataweave/2.6/dw-values-types)

<!-- document id=20232a30c4fb91794d5c131527bd9f3cb432524827263014d5d5c755565271ee url=/mulesoft/current/en-us/dataweave/2.9/dw-values.md -->

---
product: DataWeave
version: 2.9
---

# Values (dw::util::Values)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This utility module simplifies changes to values.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::util::Values` to the header of your DataWeave script.

_Introduced in DataWeave version 2.2.2._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-values-functions-attr">attr</a></p></td><td><p>This function creates a <code>PathElement</code> to use for selecting an XML attribute and populates the type’s <code>selector</code> field with the given string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-values-functions-field">field</a></p></td><td><p>This function creates a <code>PathElement</code> data type to use for selecting an <em>object field</em> and populates the type’s <code>selector</code> field with the given string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-values-functions-index">index</a></p></td><td><p>This function creates a <code>PathElement</code> data type to use for selecting an <em>array element</em> and populates the type’s <code>selector</code> field with the specified index.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-values-functions-mask">mask</a></p></td><td><p>This <code>mask</code> function replaces all <em>simple</em> elements that match the specified criteria.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/2.9/dw-values-functions-update">update</a></p></td><td><p>This <code>update</code> function updates a field in an object with the specified string value.</p></td></tr></tbody></table>

## Types

- [Values Types](https://docs.mulesoft.com/dataweave/2.9/dw-values-types)

<!-- document id=c9ce35c936a216286efc58bc7a324cd625be0af987259c9a41f31bc18942fe10 url=/mulesoft/current/en-us/dataweave/latest/dw-values.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Values (dw::util::Values)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This utility module simplifies changes to values.

To use this module, you must import it to your DataWeave code, for example, by adding the line
`import * from dw::util::Values` to the header of your DataWeave script.

_Introduced in DataWeave version 2.2.2._

## Functions

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-values-functions-attr">attr</a></p></td><td><p>This function creates a <code>PathElement</code> to use for selecting an XML attribute and populates the type’s <code>selector</code> field with the given string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-values-functions-field">field</a></p></td><td><p>This function creates a <code>PathElement</code> data type to use for selecting an <em>object field</em> and populates the type’s <code>selector</code> field with the given string.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-values-functions-index">index</a></p></td><td><p>This function creates a <code>PathElement</code> data type to use for selecting an <em>array element</em> and populates the type’s <code>selector</code> field with the specified index.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-values-functions-mask">mask</a></p></td><td><p>This <code>mask</code> function replaces all <em>simple</em> elements that match the specified criteria.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/dataweave/latest/dw-values-functions-update">update</a></p></td><td><p>This <code>update</code> function updates a field in an object with the specified string value.</p></td></tr></tbody></table>

## Types

- [Values Types](https://docs.mulesoft.com/dataweave/latest/dw-values-types)

<!-- document id=47d21de80a4124caa2931f847ae651bc5c2bc36d00fd127676209da49bac16d1 url=/mulesoft/current/en-us/dataweave/2.11/dw-values-types.md -->

---
product: DataWeave
version: 2.11
---

# Values Types (dw::util::Values)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>UpdaterValueProvider</p></td><td><div><div><p><code>type UpdaterValueProvider = (newValueProvider: (oldValue: Any, index: Number) -&gt; Any) -&gt; ReturnType</code></p></div></div></td><td><div><div><p>Type that represents the output type of the update function.</p></div><div><p><em>Introduced in DataWeave version 2.4.0.</em></p></div></div></td></tr></tbody></table>

<!-- document id=e6cdf4b0195566180aaacc9070caea09d0be022fac2689dc727b661445805164 url=/mulesoft/current/en-us/dataweave/2.12/dw-values-types.md -->

---
product: DataWeave
version: 2.12
---

# Values Types (dw::util::Values)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>UpdaterValueProvider</p></td><td><div><div><p><code>type UpdaterValueProvider = (newValueProvider: (oldValue: Any, index: Number) -&gt; Any) -&gt; ReturnType</code></p></div></div></td><td><div><div><p>Type that represents the output type of the update function.</p></div><div><p><em>Introduced in DataWeave version 2.4.0.</em></p></div></div></td></tr></tbody></table>

<!-- document id=a6cc0b33d58f6cdedc4a939f7c0e4468fa6afa8b465a618bf5097799296006c0 url=/mulesoft/current/en-us/dataweave/2.4/dw-values-types.md -->

---
product: DataWeave
version: 2.4
---

# Values Types (dw::util::Values)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>UpdaterValueProvider</p></td><td><div><div><p><code>type UpdaterValueProvider = (newValueProvider: (oldValue: Any, index: Number) -&gt; Any) -&gt; ReturnType</code></p></div></div></td><td><div><div><p>Type that represents the output type of the update function.</p></div><div><p><em>Introduced in DataWeave version 2.4.0.</em></p></div></div></td></tr></tbody></table>

<!-- document id=5af8d5194e5e2473a47a07d9a967f3f1f770d60992c107b59a3de02dc44c18b5 url=/mulesoft/current/en-us/dataweave/2.6/dw-values-types.md -->

---
product: DataWeave
version: 2.6
---

# Values Types (dw::util::Values)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>UpdaterValueProvider</p></td><td><div><div><p><code>type UpdaterValueProvider = (newValueProvider: (oldValue: Any, index: Number) -&gt; Any) -&gt; ReturnType</code></p></div></div></td><td><div><div><p>Type that represents the output type of the update function.</p></div><div><p><em>Introduced in DataWeave version 2.4.0.</em></p></div></div></td></tr></tbody></table>

<!-- document id=bee79c9b5ee50de373bf1818da5621db5779287f0a86db9da653c4f31bf36a78 url=/mulesoft/current/en-us/dataweave/2.9/dw-values-types.md -->

---
product: DataWeave
version: 2.9
---

# Values Types (dw::util::Values)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>UpdaterValueProvider</p></td><td><div><div><p><code>type UpdaterValueProvider = (newValueProvider: (oldValue: Any, index: Number) -&gt; Any) -&gt; ReturnType</code></p></div></div></td><td><div><div><p>Type that represents the output type of the update function.</p></div><div><p><em>Introduced in DataWeave version 2.4.0.</em></p></div></div></td></tr></tbody></table>

<!-- document id=b10b943b4574420e6f5057fcc38e818dbbe9748e43b033b802cc1be7273783d2 url=/mulesoft/current/en-us/dataweave/latest/dw-values-types.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Values Types (dw::util::Values)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Type</th><th>Definition</th><th>Description</th></tr></thead><tbody><tr><td><p>UpdaterValueProvider</p></td><td><div><div><p><code>type UpdaterValueProvider = (newValueProvider: (oldValue: Any, index: Number) -&gt; Any) -&gt; ReturnType</code></p></div></div></td><td><div><div><p>Type that represents the output type of the update function.</p></div><div><p><em>Introduced in DataWeave version 2.4.0.</em></p></div></div></td></tr></tbody></table>

<!-- document id=24fa5a9febce7abf4135688f8a9bf6af1793e3bb6d4df51474071e6e380d3341 url=/mulesoft/current/en-us/dataweave/2.11/dw-objects-functions-valueset.md -->

---
product: DataWeave
version: 2.11
---

# valueSet

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## valueSet<K, V>(obj: { (K)?: V }): Array<V>

Returns an array of the values from key-value pairs in an object.

_This function is **Deprecated**. Use [dw::Core::valuesOf](https://docs.mulesoft.com/dataweave/2.11/dw-core-functions-valuesof), instead._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the values from the input object.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Objects
output application/json
---
{ "valueSet" : valueSet({a: true, b: 1}) }
```

#### Output

```JSON
{ "valueSet" : [true,1] }
```

<!-- document id=6c1a85f08661794b22de3d9831562772a828ec74de1349d60f8c70e61babf6c1 url=/mulesoft/current/en-us/dataweave/2.12/dw-objects-functions-valueset.md -->

---
product: DataWeave
version: 2.12
---

# valueSet

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## valueSet<K, V>(obj: { (K)?: V }): Array<V>

Returns an array of the values from key-value pairs in an object.

_This function is **Deprecated**. Use [dw::Core::valuesOf](https://docs.mulesoft.com/dataweave/2.12/dw-core-functions-valuesof), instead._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the values from the input object.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Objects
output application/json
---
{ "valueSet" : valueSet({a: true, b: 1}) }
```

#### Output

```JSON
{ "valueSet" : [true,1] }
```

<!-- document id=a928910b6170177cd62ff853600a492d7438a55fcaafc46370b6017a6c0a38ae url=/mulesoft/current/en-us/dataweave/2.3/dw-objects-functions-valueset.md -->

---
product: DataWeave
version: 2.3
---

# valueSet

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## valueSet({ (K)?: V }): Array<V>

Returns an array of the values from key-value pairs in an object.

This method is **Deprecated**. Use `valuesOf` from Core module, instead.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the values from the input object.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Objects
output application/json
---
{ "valueSet" : valueSet({a: true, b: 1}) }
```

#### Output

```JSON
{ "valueSet" : [true,1] }
```

<!-- document id=16b2441a9b29b7884841b2fd17497715c5ab4c7d5fbcbf57cbe9a0c2011372ec url=/mulesoft/current/en-us/dataweave/2.4/dw-objects-functions-valueset.md -->

---
product: DataWeave
version: 2.4
---

# valueSet

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## valueSet<K, V>(obj: { (K)?: V }): Array<V>

Returns an array of the values from key-value pairs in an object.

_This function is **Deprecated**. Use [dw::Core::valuesOf](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-valuesof), instead._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the values from the input object.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Objects
output application/json
---
{ "valueSet" : valueSet({a: true, b: 1}) }
```

#### Output

```JSON
{ "valueSet" : [true,1] }
```

<!-- document id=678d5e72ce42a2304490f6a7c123282c593cc5728b1e491896641f28c97f41cf url=/mulesoft/current/en-us/dataweave/2.6/dw-objects-functions-valueset.md -->

---
product: DataWeave
version: 2.6
---

# valueSet

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## valueSet<K, V>(obj: { (K)?: V }): Array<V>

Returns an array of the values from key-value pairs in an object.

_This function is **Deprecated**. Use [dw::Core::valuesOf](https://docs.mulesoft.com/dataweave/2.6/dw-core-functions-valuesof), instead._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the values from the input object.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Objects
output application/json
---
{ "valueSet" : valueSet({a: true, b: 1}) }
```

#### Output

```JSON
{ "valueSet" : [true,1] }
```

<!-- document id=e2a8d6a2fe237bb0b1eec77c55051edf5b5d604614c495badf3f6d478d53d567 url=/mulesoft/current/en-us/dataweave/2.9/dw-objects-functions-valueset.md -->

---
product: DataWeave
version: 2.9
---

# valueSet

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## valueSet<K, V>(obj: { (K)?: V }): Array<V>

Returns an array of the values from key-value pairs in an object.

_This function is **Deprecated**. Use [dw::Core::valuesOf](https://docs.mulesoft.com/dataweave/2.9/dw-core-functions-valuesof), instead._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the values from the input object.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Objects
output application/json
---
{ "valueSet" : valueSet({a: true, b: 1}) }
```

#### Output

```JSON
{ "valueSet" : [true,1] }
```

<!-- document id=edda9639ad53114d66ae4fee60ecbf40503168c50c2b87ed9488af99ec562293 url=/mulesoft/current/en-us/dataweave/latest/dw-objects-functions-valueset.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# valueSet

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## valueSet<K, V>(obj: { (K)?: V }): Array<V>

Returns an array of the values from key-value pairs in an object.

_This function is **Deprecated**. Use [dw::Core::valuesOf](https://docs.mulesoft.com/dataweave/latest/dw-core-functions-valuesof), instead._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the values from the input object.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Objects
output application/json
---
{ "valueSet" : valueSet({a: true, b: 1}) }
```

#### Output

```JSON
{ "valueSet" : [true,1] }
```

<!-- document id=eccaec551dd7e959f9295dbd083081f2ba8d5745d7c3b7b9f28102d67a472194 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-valuesof.md -->

---
product: DataWeave
version: 2.11
---

# valuesOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## valuesOf<K, V>(obj: { (K)?: V }): Array<V>

Returns an array of the values from key-value pairs in an object.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the values of key-value pairs within the input object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "valuesOf" : valuesOf({a: true, b: 1}) }
```

#### Output

```JSON
{ "valuesOf" : [true,1] }
```

## valuesOf(obj: Null): Null

Helper function that enables `valuesOf` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=a0271a1ded3d37a0de8ea000c50b303958f7c5f56c75ce1ca2f4b9b3b7e21deb url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-valuesof.md -->

---
product: DataWeave
version: 2.12
---

# valuesOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## valuesOf<K, V>(obj: { (K)?: V }): Array<V>

Returns an array of the values from key-value pairs in an object.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the values of key-value pairs within the input object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "valuesOf" : valuesOf({a: true, b: 1}) }
```

#### Output

```JSON
{ "valuesOf" : [true,1] }
```

## valuesOf(obj: Null): Null

Helper function that enables `valuesOf` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=01260f800c09abb2ebf500a480a5aac7412814b1c8c168397c1856453dfedb5f url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-valuesof.md -->

---
product: DataWeave
version: 2.3
---

# valuesOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## valuesOf({ (K)?: V }): Array<V>

Returns an array of the values from key-value pairs in an object.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the values of key-value pairs within the input object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "valuesOf" : valuesOf({a: true, b: 1}) }
```

#### Output

```JSON
{ "valuesOf" : [true,1] }
```

<!-- document id=113b6551ee6f8eec1bc2aafb892b7de5d7690ec69a20db0ea6ebdde1020f5d4e url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-valuesof.md -->

---
product: DataWeave
version: 2.4
---

# valuesOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## valuesOf<K, V>(obj: { (K)?: V }): Array<V>

Returns an array of the values from key-value pairs in an object.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the values of key-value pairs within the input object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "valuesOf" : valuesOf({a: true, b: 1}) }
```

#### Output

```JSON
{ "valuesOf" : [true,1] }
```

## valuesOf(obj: Null): Null

Helper function that enables `valuesOf` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=3332c23bc95fa2334d65ab8142ae7176ab4a7c19fb7c229511f97194151370ce url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-valuesof.md -->

---
product: DataWeave
version: 2.6
---

# valuesOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## valuesOf<K, V>(obj: { (K)?: V }): Array<V>

Returns an array of the values from key-value pairs in an object.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the values of key-value pairs within the input object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "valuesOf" : valuesOf({a: true, b: 1}) }
```

#### Output

```JSON
{ "valuesOf" : [true,1] }
```

## valuesOf(obj: Null): Null

Helper function that enables `valuesOf` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=d92e02f550b4a84350c514f93a19a7574471e3933f9bb06a095fc8d83e51832e url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-valuesof.md -->

---
product: DataWeave
version: 2.9
---

# valuesOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## valuesOf<K, V>(obj: { (K)?: V }): Array<V>

Returns an array of the values from key-value pairs in an object.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the values of key-value pairs within the input object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "valuesOf" : valuesOf({a: true, b: 1}) }
```

#### Output

```JSON
{ "valuesOf" : [true,1] }
```

## valuesOf(obj: Null): Null

Helper function that enables `valuesOf` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=b2a8d3d0eb6d34aa5f010814f6eb51870645d22232b353c3b1d4620191090fc7 url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-valuesof.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# valuesOf

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## valuesOf<K, V>(obj: { (K)?: V }): Array<V>

Returns an array of the values from key-value pairs in an object.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>obj</code></p></td><td><p>The object to evaluate.</p></td></tr></tbody></table>

### Example

This example returns the values of key-value pairs within the input object.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "valuesOf" : valuesOf({a: true, b: 1}) }
```

#### Output

```JSON
{ "valuesOf" : [true,1] }
```

## valuesOf(obj: Null): Null

Helper function that enables `valuesOf` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=3cee073ff6989307b400dd722ef041ee9dd7ce5a8e6943e0caaab1566d721a64 url=/mulesoft/current/en-us/dataweave/2.11/dw-runtime-functions-version.md -->

---
product: DataWeave
version: 2.11
---

# version

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## version(): String

Returns the DataWeave version that is currently running.

_Introduced in DataWeave version 2.5.0._

### Example

This example returns the DataWeave version.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
output application/json
---
version()
```

#### Output

```Json
"2.5"
```

<!-- document id=4ad8ea5805ac1b328864fe8f68be149c965963a0b96ec9b171d7cb3093b6f2ac url=/mulesoft/current/en-us/dataweave/2.12/dw-runtime-functions-version.md -->

---
product: DataWeave
version: 2.12
---

# version

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## version(): String

Returns the DataWeave version that is currently running.

_Introduced in DataWeave version 2.5.0._

### Example

This example returns the DataWeave version.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
output application/json
---
version()
```

#### Output

```Json
"2.5"
```

<!-- document id=bf91d9fd544bfd91e043b797d4cabdcfcb70ad2a5ab333ef874449a020599584 url=/mulesoft/current/en-us/dataweave/2.6/dw-runtime-functions-version.md -->

---
product: DataWeave
version: 2.6
---

# version

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## version(): String

Returns the DataWeave version that is currently running.

_Introduced in DataWeave version 2.5.0._

### Example

This example returns the DataWeave version.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
output application/json
---
version()
```

#### Output

```Json
"2.5"
```

<!-- document id=b1a08e2cc11478cc5b83a3edd59f0d3c1e8ca090d450e161c066e20ac9dbfefc url=/mulesoft/current/en-us/dataweave/2.9/dw-runtime-functions-version.md -->

---
product: DataWeave
version: 2.9
---

# version

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## version(): String

Returns the DataWeave version that is currently running.

_Introduced in DataWeave version 2.5.0._

### Example

This example returns the DataWeave version.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
output application/json
---
version()
```

#### Output

```Json
"2.5"
```

<!-- document id=8d2f55b459d72b23fb1157e31571937cf070b7441aece2b5be28a3ce0e6fc131 url=/mulesoft/current/en-us/dataweave/latest/dw-runtime-functions-version.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# version

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## version(): String

Returns the DataWeave version that is currently running.

_Introduced in DataWeave version 2.5.0._

### Example

This example returns the DataWeave version.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
output application/json
---
version()
```

#### Output

```Json
"2.5"
```

<!-- document id=ec4fcc343219169a34031b9c90a305c1f926f9505b4d7d1596a1295d316d1e98 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-versioning-behavior.md -->

---
product: DataWeave
version: 2.11
---

# Versioning Behavior in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

New minor versions of DataWeave can introduce changes that modify the way the language behaves. You
can use DataWeave system properties that behave as _compatibility flags_ to continue using existing
scripts that depend on the previous behavior. However, each flag defines a deletion version, which
identifies the version in which the flag is no longer available and the behavior that it controls
defaults to the changed behavior.

Specifying a DataWeave language level indicates to the DataWeave runtime what compatibility flags
are available. To upgrade and maintain backward compatibility, you can set the language level of a
previous version so that the flags available on that version remain visible even if they expire in
the DataWeave version to which you upgrade. The language level defaults to the running DataWeave
version and has to be at most the same as the runtime version.

For Mule applications, the language level is determined by the application’s `minMuleVersion`
setting (see
[Feature Flags Reference](https://docs.mulesoft.com/mule-runtime/latest/feature-flagging#feature-flags-reference) in the
Mule documentation). Given the `minMuleVersion`, the language level is computed by subtracting two
major versions, as this table shows:

<table><colgroup><col> <col></colgroup><thead><tr><th>minMuleVersion</th><th>Language Level</th></tr></thead><tbody><tr><td><div><div><p>4.11</p></div></div></td><td><div><div><p>2.11</p></div></div></td></tr><tr><td><div><div><p>4.10</p></div></div></td><td><div><div><p>2.10</p></div></div></td></tr><tr><td><div><div><p>4.9</p></div></div></td><td><div><div><p>2.9</p></div></div></td></tr><tr><td><div><div><p>4.8</p></div></div></td><td><div><div><p>2.8</p></div></div></td></tr><tr><td><div><div><p>4.7</p></div></div></td><td><div><div><p>2.7</p></div></div></td></tr><tr><td><div><div><p>4.6</p></div></div></td><td><div><div><p>2.6</p></div></div></td></tr><tr><td><div><div><p>4.5</p></div></div></td><td><div><div><p>2.5</p></div></div></td></tr><tr><td><div><div><p>4.4</p></div></div></td><td><div><div><p>2.4</p></div></div></td></tr><tr><td><div><div><p>4.3</p></div></div></td><td><div><div><p>2.3</p></div></div></td></tr></tbody></table>

Setting the Mule version configures the application to use the corresponding DataWeave language
level. This setting is independent of the DataWeave syntax version, which is set through a DataWeave
script’s `%dw` directive. For details, see
[DataWeave Header](https://docs.mulesoft.com/dataweave/2.11/dataweave-language-introduction#dw_header). For example, the
`com.mulesoft.dw.xml_reader.honourMixedContentStructure` system property is a compatibility flag for
language level 2.4, when it was introduced, and it is removed in DataWeave 2.6. In DataWeave 2.6,
the property is _visible only if_ you set the language level to 2.4 or 2.5. If you choose language
level 2.4 it defaults to the old behavior, if you choose language level 2.5 it defaults to the new
behavior.

<!-- document id=0290f168fa465ea9bf58f8b661a3281a9d03c99885fb7c169f96f9827da9766b url=/mulesoft/current/en-us/dataweave/2.12/dataweave-versioning-behavior.md -->

---
product: DataWeave
version: 2.12
---

# Versioning Behavior in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

New minor versions of DataWeave can introduce changes that modify the way the language behaves. You
can use DataWeave system properties that behave as _compatibility flags_ to continue using existing
scripts that depend on the previous behavior. However, each flag defines a deletion version, which
identifies the version in which the flag is no longer available and the behavior that it controls
defaults to the changed behavior.

Specifying a DataWeave language level indicates to the DataWeave runtime what compatibility flags
are available. To upgrade and maintain backward compatibility, you can set the language level of a
previous version so that the flags available on that version remain visible even if they expire in
the DataWeave version to which you upgrade. The language level defaults to the running DataWeave
version and has to be at most the same as the runtime version.

For Mule applications, the language level is determined by the application’s `minMuleVersion`
setting (see
[Feature Flags Reference](https://docs.mulesoft.com/mule-runtime/latest/feature-flagging#feature-flags-reference) in the
Mule documentation). Given the `minMuleVersion`, the language level is computed by subtracting two
major versions, as this table shows:

<table><colgroup><col> <col></colgroup><thead><tr><th>minMuleVersion</th><th>Language Level</th></tr></thead><tbody><tr><td><div><div><p>4.12</p></div></div></td><td><div><div><p>2.12</p></div></div></td></tr><tr><td><div><div><p>4.11</p></div></div></td><td><div><div><p>2.11</p></div></div></td></tr><tr><td><div><div><p>4.10</p></div></div></td><td><div><div><p>2.10</p></div></div></td></tr><tr><td><div><div><p>4.9</p></div></div></td><td><div><div><p>2.9</p></div></div></td></tr><tr><td><div><div><p>4.8</p></div></div></td><td><div><div><p>2.8</p></div></div></td></tr><tr><td><div><div><p>4.7</p></div></div></td><td><div><div><p>2.7</p></div></div></td></tr><tr><td><div><div><p>4.6</p></div></div></td><td><div><div><p>2.6</p></div></div></td></tr><tr><td><div><div><p>4.5</p></div></div></td><td><div><div><p>2.5</p></div></div></td></tr><tr><td><div><div><p>4.4</p></div></div></td><td><div><div><p>2.4</p></div></div></td></tr><tr><td><div><div><p>4.3</p></div></div></td><td><div><div><p>2.3</p></div></div></td></tr></tbody></table>

Setting the Mule version configures the application to use the corresponding DataWeave language
level. This setting is independent of the DataWeave syntax version, which is set through a DataWeave
script’s `%dw` directive. For details, see
[DataWeave Header](https://docs.mulesoft.com/dataweave/2.12/dataweave-language-introduction#dw_header). For example, the
`com.mulesoft.dw.xml_reader.honourMixedContentStructure` system property is a compatibility flag for
language level 2.4, when it was introduced, and it is removed in DataWeave 2.6. In DataWeave 2.6,
the property is _visible only if_ you set the language level to 2.4 or 2.5. If you choose language
level 2.4 it defaults to the old behavior, if you choose language level 2.5 it defaults to the new
behavior.

<!-- document id=1ad9077ce9eb77629218e2a81ff2a6774125ee1f5dfc92661412f4b7b5988cde url=/mulesoft/current/en-us/dataweave/2.6/dataweave-versioning-behavior.md -->

---
product: DataWeave
version: 2.6
---

# Versioning Behavior in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

New minor versions of DataWeave can introduce changes that modify the way the language behaves. You
can use DataWeave system properties that behave as _compatibility flags_ to continue using existing
scripts that depend on the previous behavior. However, each flag defines a deletion version, which
identifies the version in which the flag is no longer available and the behavior that it controls
defaults to the changed behavior.

Specifying a DataWeave language level indicates to the DataWeave runtime what compatibility flags
are available. To upgrade and maintain backward compatibility, you can set the language level of a
previous version so that the flags available on that version remain visible even if they expire in
the DataWeave version to which you upgrade. The language level defaults to the running DataWeave
version and has to be at most the same as the runtime version.

For Mule applications, the language level is determined by the application’s `minMuleVersion`
setting (see
[Feature Flags Reference](https://docs.mulesoft.com/mule-runtime/latest/feature-flagging#feature-flags-reference) in the
Mule documentation). Given the `minMuleVersion`, the language level is computed by subtracting two
major versions, as the following table shows:

<table><colgroup><col> <col></colgroup><thead><tr><th>minMuleVersion</th><th>Language Level</th></tr></thead><tbody><tr><td><div><div><p>4.6</p></div></div></td><td><div><div><p>2.6</p></div></div></td></tr><tr><td><div><div><p>4.5</p></div></div></td><td><div><div><p>2.5</p></div></div></td></tr><tr><td><div><div><p>4.4</p></div></div></td><td><div><div><p>2.4</p></div></div></td></tr><tr><td><div><div><p>4.3</p></div></div></td><td><div><div><p>2.3</p></div></div></td></tr></tbody></table>

Setting the Mule version configures the application to use the corresponding DataWeave language
level. This setting is independent of the DataWeave syntax version, which is set through a DataWeave
script’s `%dw` directive. For details, see
[DataWeave Header](https://docs.mulesoft.com/dataweave/2.6/dataweave-language-introduction#dw_header). For example, the
`com.mulesoft.dw.xml_reader.honourMixedContentStructure` system property is a compatibility flag for
language level 2.4, when it was introduced, and it is removed in DataWeave 2.6. In DataWeave 2.6,
the property is _visible only if_ you set the language level to 2.4 or 2.5. If you choose language
level 2.4 it defaults to the old behavior, if you choose language level 2.5 it defaults to the new
behavior.

<!-- document id=0a2270e55ab732496c710f82ad0d800c782676d590041860d2bff5d78ace9e30 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-versioning-behavior.md -->

---
product: DataWeave
version: 2.9
---

# Versioning Behavior in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

New minor versions of DataWeave can introduce changes that modify the way the language behaves. You
can use DataWeave system properties that behave as _compatibility flags_ to continue using existing
scripts that depend on the previous behavior. However, each flag defines a deletion version, which
identifies the version in which the flag is no longer available and the behavior that it controls
defaults to the changed behavior.

Specifying a DataWeave language level indicates to the DataWeave runtime what compatibility flags
are available. To upgrade and maintain backward compatibility, you can set the language level of a
previous version so that the flags available on that version remain visible even if they expire in
the DataWeave version to which you upgrade. The language level defaults to the running DataWeave
version and has to be at most the same as the runtime version.

For Mule applications, the language level is determined by the application’s `minMuleVersion`
setting (see
[Feature Flags Reference](https://docs.mulesoft.com/mule-runtime/latest/feature-flagging#feature-flags-reference) in the
Mule documentation). Given the `minMuleVersion`, the language level is computed by subtracting two
major versions, as the following table shows:

<table><colgroup><col> <col></colgroup><thead><tr><th>minMuleVersion</th><th>Language Level</th></tr></thead><tbody><tr><td><div><div><p>4.9</p></div></div></td><td><div><div><p>2.9</p></div></div></td></tr><tr><td><div><div><p>4.8</p></div></div></td><td><div><div><p>2.8</p></div></div></td></tr><tr><td><div><div><p>4.7</p></div></div></td><td><div><div><p>2.7</p></div></div></td></tr><tr><td><div><div><p>4.6</p></div></div></td><td><div><div><p>2.6</p></div></div></td></tr><tr><td><div><div><p>4.5</p></div></div></td><td><div><div><p>2.5</p></div></div></td></tr><tr><td><div><div><p>4.4</p></div></div></td><td><div><div><p>2.4</p></div></div></td></tr><tr><td><div><div><p>4.3</p></div></div></td><td><div><div><p>2.3</p></div></div></td></tr></tbody></table>

Setting the Mule version configures the application to use the corresponding DataWeave language
level. This setting is independent of the DataWeave syntax version, which is set through a DataWeave
script’s `%dw` directive. For details, see
[DataWeave Header](https://docs.mulesoft.com/dataweave/2.9/dataweave-language-introduction#dw_header). For example, the
`com.mulesoft.dw.xml_reader.honourMixedContentStructure` system property is a compatibility flag for
language level 2.4, when it was introduced, and it is removed in DataWeave 2.6. In DataWeave 2.6,
the property is _visible only if_ you set the language level to 2.4 or 2.5. If you choose language
level 2.4 it defaults to the old behavior, if you choose language level 2.5 it defaults to the new
behavior.

<!-- document id=c8478c0ce79ccd7819912da66798cb798826233ff47082767d0027ac915430c2 url=/mulesoft/current/en-us/dataweave/latest/dataweave-versioning-behavior.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# Versioning Behavior in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

New minor versions of DataWeave can introduce changes that modify the way the language behaves. You
can use DataWeave system properties that behave as _compatibility flags_ to continue using existing
scripts that depend on the previous behavior. However, each flag defines a deletion version, which
identifies the version in which the flag is no longer available and the behavior that it controls
defaults to the changed behavior.

Specifying a DataWeave language level indicates to the DataWeave runtime what compatibility flags
are available. To upgrade and maintain backward compatibility, you can set the language level of a
previous version so that the flags available on that version remain visible even if they expire in
the DataWeave version to which you upgrade. The language level defaults to the running DataWeave
version and has to be at most the same as the runtime version.

For Mule applications, the language level is determined by the application’s `minMuleVersion`
setting (see
[Feature Flags Reference](https://docs.mulesoft.com/mule-runtime/latest/feature-flagging#feature-flags-reference) in the
Mule documentation). Given the `minMuleVersion`, the language level is computed by subtracting two
major versions, as this table shows:

<table><colgroup><col> <col></colgroup><thead><tr><th>minMuleVersion</th><th>Language Level</th></tr></thead><tbody><tr><td><div><div><p>4.13</p></div></div></td><td><div><div><p>2.13</p></div></div></td></tr><tr><td><div><div><p>4.12</p></div></div></td><td><div><div><p>2.12</p></div></div></td></tr><tr><td><div><div><p>4.11</p></div></div></td><td><div><div><p>2.11</p></div></div></td></tr><tr><td><div><div><p>4.10</p></div></div></td><td><div><div><p>2.10</p></div></div></td></tr><tr><td><div><div><p>4.9</p></div></div></td><td><div><div><p>2.9</p></div></div></td></tr><tr><td><div><div><p>4.8</p></div></div></td><td><div><div><p>2.8</p></div></div></td></tr><tr><td><div><div><p>4.7</p></div></div></td><td><div><div><p>2.7</p></div></div></td></tr><tr><td><div><div><p>4.6</p></div></div></td><td><div><div><p>2.6</p></div></div></td></tr><tr><td><div><div><p>4.5</p></div></div></td><td><div><div><p>2.5</p></div></div></td></tr><tr><td><div><div><p>4.4</p></div></div></td><td><div><div><p>2.4</p></div></div></td></tr><tr><td><div><div><p>4.3</p></div></div></td><td><div><div><p>2.3</p></div></div></td></tr></tbody></table>

Setting the Mule version configures the application to use the corresponding DataWeave language
level. This setting is independent of the DataWeave syntax version, which is set through a DataWeave
script’s `%dw` directive. For details, see
[DataWeave Header](https://docs.mulesoft.com/dataweave/latest/dataweave-language-introduction#dw_header). For example, the
`com.mulesoft.dw.xml_reader.honourMixedContentStructure` system property is a compatibility flag for
language level 2.4, when it was introduced, and it is removed in DataWeave 2.6. In DataWeave 2.6,
the property is _visible only if_ you set the language level to 2.4 or 2.5. If you choose language
level 2.4 it defaults to the old behavior, if you choose language level 2.5 it defaults to the new
behavior.

<!-- document id=3f234bcea17554361f624ced7b389757b103495e32fc810a8b7db1c886174751 url=/mulesoft/current/en-us/dataweave/2.11/dw-runtime-functions-wait.md -->

---
product: DataWeave
version: 2.11
---

# wait

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## wait<T>(value: T, timeout: Number): T

Stops the execution for the specified timeout period (in milliseconds).

> [!WARNING] Stopping the execution blocks the thread, potentially causing slowness, low performance
> and potentially freezing of the entire runtime. This operation is intended for limited functional
> testing purposes. Do not use this function in a production application, performance testing, or
> with multiple applications deployed.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>Input of any type.</p></td></tr><tr><td><p><code>timeout</code></p></td><td><p>The number of milliseconds to wait.</p></td></tr></tbody></table>

### Example

This example waits 2000 milliseconds (2 seconds) to execute.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
output application/json
---
{ "user" : 1 } wait 2000
```

#### Output

```JSON
{ "user": 1 }
```

<!-- document id=8887cfbc565f668d47a70ae8cb4012b5a9a935b5a9a0f12ffc11681ce2c67612 url=/mulesoft/current/en-us/dataweave/2.12/dw-runtime-functions-wait.md -->

---
product: DataWeave
version: 2.12
---

# wait

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## wait<T>(value: T, timeout: Number): T

Stops the execution for the specified timeout period (in milliseconds).

> [!WARNING] Stopping the execution blocks the thread, potentially causing slowness, low performance
> and potentially freezing of the entire runtime. This operation is intended for limited functional
> testing purposes. Do not use this function in a production application, performance testing, or
> with multiple applications deployed.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>Input of any type.</p></td></tr><tr><td><p><code>timeout</code></p></td><td><p>The number of milliseconds to wait.</p></td></tr></tbody></table>

### Example

This example waits 2000 milliseconds (2 seconds) to execute.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
output application/json
---
{ "user" : 1 } wait 2000
```

#### Output

```JSON
{ "user": 1 }
```

<!-- document id=be9f80feb4c92d670257bb34943b27ac15f2839203edd24eb2956dbf0fbcd876 url=/mulesoft/current/en-us/dataweave/2.3/dw-runtime-functions-wait.md -->

---
product: DataWeave
version: 2.3
---

# wait

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## wait(T, Number): T

Stops the execution for the specified timeout (in milliseconds).

> [!WARNING] Stopping the execution will block the thread used, potentially causing slowness, low
> performance and potentially freezes of the entire runtime. This operation is intented for limited
> functional testing purposes and should not be used in production application, performance testing
> or with multiple applications deployed.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>Input of any type.</p></td></tr><tr><td><p><code>timeout</code></p></td><td><p>The number of milliseconds to wait.</p></td></tr></tbody></table>

### Example

This example waits 2000 milliseconds (2 seconds) to execute.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
output application/json
---
{ "user" : 1 } wait 2000
```

#### Output

```JSON
{ "user": 1 }
```

<!-- document id=859736d46bd366296b4bf7e5c446e339e521af67757a519b700550c7e25ef18c url=/mulesoft/current/en-us/dataweave/2.4/dw-runtime-functions-wait.md -->

---
product: DataWeave
version: 2.4
---

# wait

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## wait<T>(value: T, timeout: Number): T

Stops the execution for the specified timeout period (in milliseconds).

> [!WARNING] Stopping the execution blocks the thread, potentially causing slowness, low performance
> and potentially freezing of the entire runtime. This operation is intended for limited functional
> testing purposes. Do not use this function in a production application, performance testing, or
> with multiple applications deployed.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>Input of any type.</p></td></tr><tr><td><p><code>timeout</code></p></td><td><p>The number of milliseconds to wait.</p></td></tr></tbody></table>

### Example

This example waits 2000 milliseconds (2 seconds) to execute.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
output application/json
---
{ "user" : 1 } wait 2000
```

#### Output

```JSON
{ "user": 1 }
```

<!-- document id=6d2d31fe9b19e2b1810b61a3df0260bdfe690a31deb592edd51f55f85f0ecfa9 url=/mulesoft/current/en-us/dataweave/2.6/dw-runtime-functions-wait.md -->

---
product: DataWeave
version: 2.6
---

# wait

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## wait<T>(value: T, timeout: Number): T

Stops the execution for the specified timeout period (in milliseconds).

> [!WARNING] Stopping the execution blocks the thread, potentially causing slowness, low performance
> and potentially freezing of the entire runtime. This operation is intended for limited functional
> testing purposes. Do not use this function in a production application, performance testing, or
> with multiple applications deployed.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>Input of any type.</p></td></tr><tr><td><p><code>timeout</code></p></td><td><p>The number of milliseconds to wait.</p></td></tr></tbody></table>

### Example

This example waits 2000 milliseconds (2 seconds) to execute.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
output application/json
---
{ "user" : 1 } wait 2000
```

#### Output

```JSON
{ "user": 1 }
```

<!-- document id=8c4f38be255ecda84b800a7e727364691dcb9c6d2c0c9609d0f0ae825fe87fae url=/mulesoft/current/en-us/dataweave/2.9/dw-runtime-functions-wait.md -->

---
product: DataWeave
version: 2.9
---

# wait

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## wait<T>(value: T, timeout: Number): T

Stops the execution for the specified timeout period (in milliseconds).

> [!WARNING] Stopping the execution blocks the thread, potentially causing slowness, low performance
> and potentially freezing of the entire runtime. This operation is intended for limited functional
> testing purposes. Do not use this function in a production application, performance testing, or
> with multiple applications deployed.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>Input of any type.</p></td></tr><tr><td><p><code>timeout</code></p></td><td><p>The number of milliseconds to wait.</p></td></tr></tbody></table>

### Example

This example waits 2000 milliseconds (2 seconds) to execute.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
output application/json
---
{ "user" : 1 } wait 2000
```

#### Output

```JSON
{ "user": 1 }
```

<!-- document id=d10f4f44af046ff55735b355e2b48022adf7a5333262c7ec19383b5c91f42405 url=/mulesoft/current/en-us/dataweave/latest/dw-runtime-functions-wait.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# wait

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## wait<T>(value: T, timeout: Number): T

Stops the execution for the specified timeout period (in milliseconds).

> [!WARNING] Stopping the execution blocks the thread, potentially causing slowness, low performance
> and potentially freezing of the entire runtime. This operation is intended for limited functional
> testing purposes. Do not use this function in a production application, performance testing, or
> with multiple applications deployed.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>Input of any type.</p></td></tr><tr><td><p><code>timeout</code></p></td><td><p>The number of milliseconds to wait.</p></td></tr></tbody></table>

### Example

This example waits 2000 milliseconds (2 seconds) to execute.

#### Source

```DataWeave
%dw 2.0
import * from dw::Runtime
output application/json
---
{ "user" : 1 } wait 2000
```

#### Output

```JSON
{ "user": 1 }
```

<!-- document id=8e69d363ca5e9409d7974100fe0a2a147fad0a6cbacb3b805178ac85479084cc url=/mulesoft/current/en-us/dataweave/2.4/whats-new-in-dw.md -->

---
product: DataWeave
version: 2.4
---

# What’s New in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

DataWeave 2.4 is bundled with Mule 4.4. The 2.4 version of DataWeave introduces the following
features:

- Ability to read larger-than-memory strings automatically. When you are using the indexed reader
  strategy and processing a String with a size larger than 1.5 MB, DataWeave automatically splits
  the value in chunks to avoid out-of-memory issues. Related reader properties are
  `com.mulesoft.dw.max_memory_allocation` and `com.mulesoft.dw.buffered_char_sequence.enabled`.
  Refer to [Indexed Readers in DataWeave](https://docs.mulesoft.com/dataweave/2.4/dataweave-indexed-readers#large-strings-management).

- New reader and writer properties for working with data formats. For example, the XML writer now
  enables you to define namespaces at the root level.

- Many new modules, functions, types, annotations, and variables. Some are experimental and subject
  to change in future releases.

- A number of functions are overloaded to introduce new helper functions for handling `null` values.

Changes to the documentation include more detailed function signatures and organization of the
functions by their module names, such as `dw::Core`, `dw::core::Strings`, and `dw::util::Math`.

DataWeave 2.4 is bundled with Mule 4.4. For information about the Mule 4.4 release, refer to
[What’s New in Mule 4.4](https://docs.mulesoft.com/mule-runtime/4.4/whats-new-in-mule).

## New Properties for Data Formats

DataWeave introduces the following reader and writer properties:

- DataWeave (dw) reader property: `privileges` enables you to provide a comma-separated list of
  privileges to use in the format, such as `'Resources,Properties'`.

- Excel (XLSX) reader property: `tableLimit` enables you to set position of the last column in each
  row.

- YAML writer property: `writeDeclaration` enables you to write the header declaration.

- XML writer properties: `defaultNamespace` specifies the default namespaces of the output XML , and
  `writeDeclaredNamespaces` marks the namespaces to declare in the root element of the XML.

## New DataWeave Function Modules and Features

New DataWeave modules and features:

- [dw::Core](https://docs.mulesoft.com/dataweave/2.4/dw-core) introduces new functions and annotations:

  - [indexOf](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-indexof)

  - [lastIndexOf](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-lastindexof)

  - [onNull](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-onnull)

  - [then](https://docs.mulesoft.com/dataweave/2.4/dw-core-functions-then)

  - [Core Annotations](https://docs.mulesoft.com/dataweave/2.4/dw-core-annotations) introduces a number of new annotations.

- [dw::core::Dates](https://docs.mulesoft.com/dataweave/2.4/dw-dates) is a new module with functions and types to create and manipulate Date
  types, for example, the function `today`.

- [dw::core::Strings](https://docs.mulesoft.com/dataweave/2.4/dw-strings) introduces new functions:

  - [collapse](https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-collapse)

  - [countCharactersBy](https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-countcharactersby)

  - [countMatches](https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-countmatches)

  - [everyCharacter](https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-everycharacter)

  - [first](https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-first)

  - [hammingDistance](https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-hammingdistance)

  - [last](https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-last)

  - [levenshteinDistance](https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-levenshteindistance)

  - [lines](https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-lines)

  - [mapString](https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-mapstring)

  - [remove](https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-remove)

  - [replaceAll](https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-replaceall)

  - [reverse](https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-reverse)

  - [someCharacter](https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-somecharacter)

  - [substring](https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-substring)

  - [substringBy](https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-substringby)

  - [substringEvery](https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-substringevery)

  - [words](https://docs.mulesoft.com/dataweave/2.4/dw-strings-functions-words)

- [dw::util::Coercions](https://docs.mulesoft.com/dataweave/2.4/dw-coercions) is a new DataWeave module with functions and types to simplify
  data type transformations, for example, the function `toString`.

- [dw::util::Math](https://docs.mulesoft.com/dataweave/2.4/dw-math) is a new DataWeave module with functions and variables that provides
  mathematical functions, for example, the function `sin`.

- [dw::util::Periods](https://docs.mulesoft.com/dataweave/2.4/dw-periods) is a new DataWeave module with functions and types to simplify the
  creation of Periods, for example, the function `days`.

- [dw::util::Tree](https://docs.mulesoft.com/dataweave/2.4/dw-tree) introduces new functions:

  - [filterArrayLeafs](https://docs.mulesoft.com/dataweave/2.4/dw-tree-functions-filterarrayleafs)

  - [filterObjectLeafs](https://docs.mulesoft.com/dataweave/2.4/dw-tree-functions-filterobjectleafs)

  - [filterTree](https://docs.mulesoft.com/dataweave/2.4/dw-tree-functions-filtertree)

  - [isArrayType](https://docs.mulesoft.com/dataweave/2.4/dw-tree-functions-isarraytype)

  - [isAttributeType](https://docs.mulesoft.com/dataweave/2.4/dw-tree-functions-isattributetype)

  - [isObjectType](https://docs.mulesoft.com/dataweave/2.4/dw-tree-functions-isobjecttype)

- [dw::util::Values](https://docs.mulesoft.com/dataweave/2.4/dw-values-types) provides a new type `UpdaterValueProvider`.

<!-- document id=d8a5187abf4598551e2c1e0264cd4093be4f398310cc7847b6196403f998ae70 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-with.md -->

---
product: DataWeave
version: 2.11
---

# with

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## with<V, U, R, X>(toBeReplaced: ((V, U) -> R) -> X, replacer: (V, U) -> R): X

Helper function that specifies a replacement element. This function is used with `replace`, `update`
or `mask` to perform data substitutions.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>toBeReplaced</code></p></td><td><p>The value to be replaced.</p></td></tr><tr><td><p><code>replacer</code></p></td><td><p>The replacement value for the input value.</p></td></tr></tbody></table>

### Example

This example replaces all numbers in a string with "x" characters. The `replace` function specifies
the base string and a regex to select the characters to replace, and `with` provides the replacement
string to use.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "ssn" : "987-65-4321" replace /[0-9]/ with("x") }
```

#### Output

```JSON
{ "ssn": "xxx-xx-xxxx" }
```

<!-- document id=4c5d3b8912e59ef8890ac6ea8f5424d928038c33f3ec00d32ccb55af374b5b1f url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-with.md -->

---
product: DataWeave
version: 2.12
---

# with

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## with<V, U, R, X>(toBeReplaced: ((V, U) -> R) -> X, replacer: (V, U) -> R): X

Helper function that specifies a replacement element. This function is used with `replace`, `update`
or `mask` to perform data substitutions.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>toBeReplaced</code></p></td><td><p>The value to be replaced.</p></td></tr><tr><td><p><code>replacer</code></p></td><td><p>The replacement value for the input value.</p></td></tr></tbody></table>

### Example

This example replaces all numbers in a string with "x" characters. The `replace` function specifies
the base string and a regex to select the characters to replace, and `with` provides the replacement
string to use.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "ssn" : "987-65-4321" replace /[0-9]/ with("x") }
```

#### Output

```JSON
{ "ssn": "xxx-xx-xxxx" }
```

<!-- document id=56bde5419a73d736d24618d0c7241efde027cd71f0840fdfccd4b4fcbcba0ac9 url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-with.md -->

---
product: DataWeave
version: 2.3
---

# with

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## with(((V, U) -> R) -> X, (V, U) -> R): X

Helper function that specifies a replacement element. This function is used with `replace`, `update`
or `mask` to perform data substitutions.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>toBeReplaced</code></p></td><td><p>The value to be replaced.</p></td></tr><tr><td><p><code>replacer</code></p></td><td><p>The replacement value for the input value.</p></td></tr></tbody></table>

### Example

This example replaces all numbers in a string with "x" characters. The `replace` function specifies
the base string and a regex to select the characters to replace, and `with` provides the replacement
string to use.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "ssn" : "987-65-4321" replace /[0-9]/ with("x") }
```

#### Output

```JSON
{ "ssn": "xxx-xx-xxxx" }
```

<!-- document id=24c83ec60fa781e81b21b25cfb15a2f672304227ca380696457611232f94083a url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-with.md -->

---
product: DataWeave
version: 2.4
---

# with

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## with<V, U, R, X>(toBeReplaced: ((V, U) -> R) -> X, replacer: (V, U) -> R): X

Helper function that specifies a replacement element. This function is used with `replace`, `update`
or `mask` to perform data substitutions.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>toBeReplaced</code></p></td><td><p>The value to be replaced.</p></td></tr><tr><td><p><code>replacer</code></p></td><td><p>The replacement value for the input value.</p></td></tr></tbody></table>

### Example

This example replaces all numbers in a string with "x" characters. The `replace` function specifies
the base string and a regex to select the characters to replace, and `with` provides the replacement
string to use.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "ssn" : "987-65-4321" replace /[0-9]/ with("x") }
```

#### Output

```JSON
{ "ssn": "xxx-xx-xxxx" }
```

<!-- document id=571043a3eefc79fe907c243317c55a49bb2aad4c7e174767777baabfbc393711 url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-with.md -->

---
product: DataWeave
version: 2.6
---

# with

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## with<V, U, R, X>(toBeReplaced: ((V, U) -> R) -> X, replacer: (V, U) -> R): X

Helper function that specifies a replacement element. This function is used with `replace`, `update`
or `mask` to perform data substitutions.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>toBeReplaced</code></p></td><td><p>The value to be replaced.</p></td></tr><tr><td><p><code>replacer</code></p></td><td><p>The replacement value for the input value.</p></td></tr></tbody></table>

### Example

This example replaces all numbers in a string with "x" characters. The `replace` function specifies
the base string and a regex to select the characters to replace, and `with` provides the replacement
string to use.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "ssn" : "987-65-4321" replace /[0-9]/ with("x") }
```

#### Output

```JSON
{ "ssn": "xxx-xx-xxxx" }
```

<!-- document id=38bdccb3d36e4471182cc6c70e27492be79fd435ff48bcda7001c928aea85abb url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-with.md -->

---
product: DataWeave
version: 2.9
---

# with

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## with<V, U, R, X>(toBeReplaced: ((V, U) -> R) -> X, replacer: (V, U) -> R): X

Helper function that specifies a replacement element. This function is used with `replace`, `update`
or `mask` to perform data substitutions.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>toBeReplaced</code></p></td><td><p>The value to be replaced.</p></td></tr><tr><td><p><code>replacer</code></p></td><td><p>The replacement value for the input value.</p></td></tr></tbody></table>

### Example

This example replaces all numbers in a string with "x" characters. The `replace` function specifies
the base string and a regex to select the characters to replace, and `with` provides the replacement
string to use.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "ssn" : "987-65-4321" replace /[0-9]/ with("x") }
```

#### Output

```JSON
{ "ssn": "xxx-xx-xxxx" }
```

<!-- document id=39d2890a0fe0a8b1a8de1f2e00bf4a42d571a07481e29452ea1f462941dca571 url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-with.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# with

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## with<V, U, R, X>(toBeReplaced: ((V, U) -> R) -> X, replacer: (V, U) -> R): X

Helper function that specifies a replacement element. This function is used with `replace`, `update`
or `mask` to perform data substitutions.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>toBeReplaced</code></p></td><td><p>The value to be replaced.</p></td></tr><tr><td><p><code>replacer</code></p></td><td><p>The replacement value for the input value.</p></td></tr></tbody></table>

### Example

This example replaces all numbers in a string with "x" characters. The `replace` function specifies
the base string and a regex to select the characters to replace, and `with` provides the replacement
string to use.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ "ssn" : "987-65-4321" replace /[0-9]/ with("x") }
```

#### Output

```JSON
{ "ssn": "xxx-xx-xxxx" }
```

<!-- document id=0092780e716fd9a99ec59fe50e130236d3e48c80d2d1d21c7240bb0c1f5c5ffd url=/mulesoft/current/en-us/dataweave/2.11/dw-strings-functions-withmaxsize.md -->

---
product: DataWeave
version: 2.11
---

# withMaxSize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## withMaxSize(text: String, maxLength: Number): String

Checks that the string length isn’t greater than the specified `maxLength`. If the string is longer,
the function returns a substring that starts at the beginning of the string and is `maxLength`
characters long.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>maxLength</code></p></td><td><p>The maximum length of the string.</p></td></tr></tbody></table>

### Example

This example shows how `withMaxSize` behaves with different `maxLength` values for the same string.
Note that if `withMaxSize` is 0, the function returns an unmodified string. If the input is `null`,
the output is always `null`.

#### Source

```DataWeave
%dw 2.0
import withMaxSize from dw::core::Strings
output application/json
---
{
   a: "123" withMaxSize 10,
   b: "123" withMaxSize 3,
   c: "123" withMaxSize 2,
   d: "123" withMaxSize 0,
   e: null withMaxSize 23,
}
```

#### Output

```JSON
{
  "a": "123",
  "b": "123",
  "c": "12",
  "d": "123",
  "e": null
}
```

## withMaxSize(text: Null, maxLength: Number): Null

Helper function that enables `withMaxSize` to work with a `null` value.

_Introduced in DataWeave version 2.3.0._

<!-- document id=9fc47eca64abd3d2aabe8bf7db575efc3f9c67f5c53b3c2050d4caaa036298bf url=/mulesoft/current/en-us/dataweave/2.12/dw-strings-functions-withmaxsize.md -->

---
product: DataWeave
version: 2.12
---

# withMaxSize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## withMaxSize(text: String, maxLength: Number): String

Checks that the string length isn’t greater than the specified `maxLength`. If the string is longer,
the function returns a substring that starts at the beginning of the string and is `maxLength`
characters long.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>maxLength</code></p></td><td><p>The maximum length of the string.</p></td></tr></tbody></table>

### Example

This example shows how `withMaxSize` behaves with different `maxLength` values for the same string.
Note that if `withMaxSize` is 0, the function returns an unmodified string. If the input is `null`,
the output is always `null`.

#### Source

```DataWeave
%dw 2.0
import withMaxSize from dw::core::Strings
output application/json
---
{
   a: "123" withMaxSize 10,
   b: "123" withMaxSize 3,
   c: "123" withMaxSize 2,
   d: "123" withMaxSize 0,
   e: null withMaxSize 23,
}
```

#### Output

```JSON
{
  "a": "123",
  "b": "123",
  "c": "12",
  "d": "123",
  "e": null
}
```

## withMaxSize(text: Null, maxLength: Number): Null

Helper function that enables `withMaxSize` to work with a `null` value.

_Introduced in DataWeave version 2.3.0._

<!-- document id=f70889717c7224156db3efb38fee0a480ce98df2d9fcfeef1fa93c9e0f0c0e8a url=/mulesoft/current/en-us/dataweave/2.3/dw-strings-functions-withmaxsize.md -->

---
product: DataWeave
version: 2.3
---

# withMaxSize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## withMaxSize(String, Number): String

Checks that the string length isn’t greater than the specified `maxLength`. If the string is longer,
the function returns a substring that starts at the beginning of the string and is `maxLength`
characters long.

_Introduced in DataWeave 2.3.0. Supported by Mule 4.3 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>maxLength</code></p></td><td><p>The maximum length of the string.</p></td></tr></tbody></table>

### Example

This example shows how `withMaxSize` behaves with different inputs and sizes. Note that if
`withMaxSize` is 0, the function returns an empty string. If the input is `null`, the output is
always `null`.

#### Source

```DataWeave
%dw 2.0
import withMaxSize from dw::core::Strings
output application/json
---
{
   a: "123" withMaxSize 10,
   b: "123" withMaxSize 3,
   c: "123" withMaxSize 2,
   d: "" withMaxSize 0,
   e: null withMaxSize 23,
}
```

#### Output

```JSON
{
  "a": "123",
  "b": "123",
  "c": "12",
  "d": "",
  "e": null
}
```

## withMaxSize(Null, Number): Null

Helper function that enables `withMaxSize` to work with a `null` value.

<!-- document id=dddd78a0d4656c1698b98c1ee9ad6085feea4a2ad1cde14c3bb115d7fb996326 url=/mulesoft/current/en-us/dataweave/2.4/dw-strings-functions-withmaxsize.md -->

---
product: DataWeave
version: 2.4
---

# withMaxSize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## withMaxSize(text: String, maxLength: Number): String

Checks that the string length isn’t greater than the specified `maxLength`. If the string is longer,
the function returns a substring that starts at the beginning of the string and is `maxLength`
characters long.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>maxLength</code></p></td><td><p>The maximum length of the string.</p></td></tr></tbody></table>

### Example

This example shows how `withMaxSize` behaves with different inputs and sizes. Note that if
`withMaxSize` is 0, the function returns an empty string. If the input is `null`, the output is
always `null`.

#### Source

```DataWeave
%dw 2.0
import withMaxSize from dw::core::Strings
output application/json
---
{
   a: "123" withMaxSize 10,
   b: "123" withMaxSize 3,
   c: "123" withMaxSize 2,
   d: "" withMaxSize 0,
   e: null withMaxSize 23,
}
```

#### Output

```JSON
{
  "a": "123",
  "b": "123",
  "c": "12",
  "d": "",
  "e": null
}
```

## withMaxSize(text: Null, maxLength: Number): Null

Helper function that enables `withMaxSize` to work with a `null` value.

_Introduced in DataWeave version 2.3.0._

<!-- document id=760c45ab85c2108689c753aefb7cd35a1a32ba953e8a93d2cd96256c0e4bc55d url=/mulesoft/current/en-us/dataweave/2.6/dw-strings-functions-withmaxsize.md -->

---
product: DataWeave
version: 2.6
---

# withMaxSize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## withMaxSize(text: String, maxLength: Number): String

Checks that the string length isn’t greater than the specified `maxLength`. If the string is longer,
the function returns a substring that starts at the beginning of the string and is `maxLength`
characters long.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>maxLength</code></p></td><td><p>The maximum length of the string.</p></td></tr></tbody></table>

### Example

This example shows how `withMaxSize` behaves with different `maxLength` values for the same string.
Note that if `withMaxSize` is 0, the function returns an unmodified string. If the input is `null`,
the output is always `null`.

#### Source

```DataWeave
%dw 2.0
import withMaxSize from dw::core::Strings
output application/json
---
{
   a: "123" withMaxSize 10,
   b: "123" withMaxSize 3,
   c: "123" withMaxSize 2,
   d: "123" withMaxSize 0,
   e: null withMaxSize 23,
}
```

#### Output

```JSON
{
  "a": "123",
  "b": "123",
  "c": "12",
  "d": "123",
  "e": null
}
```

## withMaxSize(text: Null, maxLength: Number): Null

Helper function that enables `withMaxSize` to work with a `null` value.

_Introduced in DataWeave version 2.3.0._

<!-- document id=49c1fea2dbf68484fb36e41ead769e8b88347014917e65a06836b3b7eb94c8bf url=/mulesoft/current/en-us/dataweave/2.9/dw-strings-functions-withmaxsize.md -->

---
product: DataWeave
version: 2.9
---

# withMaxSize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## withMaxSize(text: String, maxLength: Number): String

Checks that the string length isn’t greater than the specified `maxLength`. If the string is longer,
the function returns a substring that starts at the beginning of the string and is `maxLength`
characters long.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>maxLength</code></p></td><td><p>The maximum length of the string.</p></td></tr></tbody></table>

### Example

This example shows how `withMaxSize` behaves with different `maxLength` values for the same string.
Note that if `withMaxSize` is 0, the function returns an unmodified string. If the input is `null`,
the output is always `null`.

#### Source

```DataWeave
%dw 2.0
import withMaxSize from dw::core::Strings
output application/json
---
{
   a: "123" withMaxSize 10,
   b: "123" withMaxSize 3,
   c: "123" withMaxSize 2,
   d: "123" withMaxSize 0,
   e: null withMaxSize 23,
}
```

#### Output

```JSON
{
  "a": "123",
  "b": "123",
  "c": "12",
  "d": "123",
  "e": null
}
```

## withMaxSize(text: Null, maxLength: Number): Null

Helper function that enables `withMaxSize` to work with a `null` value.

_Introduced in DataWeave version 2.3.0._

<!-- document id=3c8954c073a42830aabb1139c4f4461b2ba347aca4507a67ffa6724527572d27 url=/mulesoft/current/en-us/dataweave/latest/dw-strings-functions-withmaxsize.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# withMaxSize

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## withMaxSize(text: String, maxLength: Number): String

Checks that the string length isn’t greater than the specified `maxLength`. If the string is longer,
the function returns a substring that starts at the beginning of the string and is `maxLength`
characters long.

_Introduced in DataWeave version 2.3.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>maxLength</code></p></td><td><p>The maximum length of the string.</p></td></tr></tbody></table>

### Example

This example shows how `withMaxSize` behaves with different `maxLength` values for the same string.
Note that if `withMaxSize` is 0, the function returns an unmodified string. If the input is `null`,
the output is always `null`.

#### Source

```DataWeave
%dw 2.0
import withMaxSize from dw::core::Strings
output application/json
---
{
   a: "123" withMaxSize 10,
   b: "123" withMaxSize 3,
   c: "123" withMaxSize 2,
   d: "123" withMaxSize 0,
   e: null withMaxSize 23,
}
```

#### Output

```JSON
{
  "a": "123",
  "b": "123",
  "c": "12",
  "d": "123",
  "e": null
}
```

## withMaxSize(text: Null, maxLength: Number): Null

Helper function that enables `withMaxSize` to work with a `null` value.

_Introduced in DataWeave version 2.3.0._

<!-- document id=81a7ade9057890a659533dda8cb6a2bde17a1f91a5da3cad3846cb102e97a8ab url=/mulesoft/current/en-us/dataweave/2.11/dw-strings-functions-words.md -->

---
product: DataWeave
version: 2.11
---

# words

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## words(text: String): Array<String>

Returns an array of words from a string.

Separators between words include blank spaces, new lines, and tabs.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to split into words.</p></td></tr></tbody></table>

### Example

This example divides a string by the `words` it contains. An `\n` represents a line break, and `\t`
represents a tab.

#### Source

```DataWeave
%dw 2.0
import words from dw::core::Strings
output application/json
---
words("hello world\nhere\t\t\tdata-weave")
```

#### Output

```Json
["hello", "world", "here", "data-weave"]
```

## words(text: Null): Null

Helper function that enables `words` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=e064fd7f2473ecc085f9fb06c60b606577ed546ee334f03486c3d0b51ec65c75 url=/mulesoft/current/en-us/dataweave/2.12/dw-strings-functions-words.md -->

---
product: DataWeave
version: 2.12
---

# words

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## words(text: String): Array<String>

Returns an array of words from a string.

Separators between words include blank spaces, new lines, and tabs.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to split into words.</p></td></tr></tbody></table>

### Example

This example divides a string by the `words` it contains. An `\n` represents a line break, and `\t`
represents a tab.

#### Source

```DataWeave
%dw 2.0
import words from dw::core::Strings
output application/json
---
words("hello world\nhere\t\t\tdata-weave")
```

#### Output

```Json
["hello", "world", "here", "data-weave"]
```

## words(text: Null): Null

Helper function that enables `words` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=a9e760a8516246d7714d1883573b4ec09b734a7a48676b573545ae0f5ed150a4 url=/mulesoft/current/en-us/dataweave/2.4/dw-strings-functions-words.md -->

---
product: DataWeave
version: 2.4
---

# words

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## words(text: String): Array<String>

Returns an array of words from a string.

Separators between words include blank spaces, new lines, and tabs.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to split into words.</p></td></tr></tbody></table>

### Example

This example divides a string by the `words` it contains. An `\n` represents a line break, and `\t`
represents a tab.

#### Source

```DataWeave
%dw 2.0
import words from dw::core::Strings
output application/json
---
words("hello world\nhere\t\t\tdata-weave")
```

#### Output

```Json
["hello", "world", "here", "data-weave"]
```

## words(text: Null): Null

Helper function that enables `words` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=9357f3674dbd4eae422a577156c9b9622b10510d06ab6adce4a8d467c2c57caf url=/mulesoft/current/en-us/dataweave/2.6/dw-strings-functions-words.md -->

---
product: DataWeave
version: 2.6
---

# words

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## words(text: String): Array<String>

Returns an array of words from a string.

Separators between words include blank spaces, new lines, and tabs.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to split into words.</p></td></tr></tbody></table>

### Example

This example divides a string by the `words` it contains. An `\n` represents a line break, and `\t`
represents a tab.

#### Source

```DataWeave
%dw 2.0
import words from dw::core::Strings
output application/json
---
words("hello world\nhere\t\t\tdata-weave")
```

#### Output

```Json
["hello", "world", "here", "data-weave"]
```

## words(text: Null): Null

Helper function that enables `words` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=3dd064534ed9973b76e6f0388a9d3ed97314278c2984e57939c14530362343a6 url=/mulesoft/current/en-us/dataweave/2.9/dw-strings-functions-words.md -->

---
product: DataWeave
version: 2.9
---

# words

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## words(text: String): Array<String>

Returns an array of words from a string.

Separators between words include blank spaces, new lines, and tabs.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to split into words.</p></td></tr></tbody></table>

### Example

This example divides a string by the `words` it contains. An `\n` represents a line break, and `\t`
represents a tab.

#### Source

```DataWeave
%dw 2.0
import words from dw::core::Strings
output application/json
---
words("hello world\nhere\t\t\tdata-weave")
```

#### Output

```Json
["hello", "world", "here", "data-weave"]
```

## words(text: Null): Null

Helper function that enables `words` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=8582c104f1384c1f8e29d72456c764222fc045ff0f2162be39a1edcb73ef7b92 url=/mulesoft/current/en-us/dataweave/latest/dw-strings-functions-words.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# words

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## words(text: String): Array<String>

Returns an array of words from a string.

Separators between words include blank spaces, new lines, and tabs.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The string to split into words.</p></td></tr></tbody></table>

### Example

This example divides a string by the `words` it contains. An `\n` represents a line break, and `\t`
represents a tab.

#### Source

```DataWeave
%dw 2.0
import words from dw::core::Strings
output application/json
---
words("hello world\nhere\t\t\tdata-weave")
```

#### Output

```Json
["hello", "world", "here", "data-weave"]
```

## words(text: Null): Null

Helper function that enables `words` to work with a `null` value.

_Introduced in DataWeave version 2.4.0._

<!-- document id=2bc1fc19926519ef5f44b278a52d97dab27549bd406831d426c0946321fff3d4 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-functions-lambdas.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Work with Functions and Lambdas in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

In DataWeave, functions and lambdas (anonymous functions) can be passed as values or be assigned to
variables.

When using lambdas within the body of a DataWeave file in conjunction with an function such as
`map`, its attributes can either be explicitly named or left anonymous, in which case they can be
referenced as `$`, `$$`, etc.

## Declare and Invoke a Function

You can declare a function in the header or body of a DataWeave script by using the `fun` keyword.
Then you can invoke the function at any point in the body of the script.

You refer to functions using this form: `functionName()` or `functionName(arg1, arg2, argN)`

You can pass an expression in between the parentheses for each argument. Each expression between the
parentheses is evaluated, and the result is passed as an argument used in the execution of the
function body.

Input

```json
{
  "field1": "Annie",
  "field2": "Point",
  "field3": "Stuff"
}
```

Transform

```dataweave
%dw 2.0
output application/json
fun toUser(obj) = {
  firstName: obj.field1,
  lastName: obj.field2
}
---
{
  "user" : toUser(payload)
}
```

Output

```json
{
  "user": {
    "firstName": "Annie",
    "lastName": "Point"
  }
}
```

## Specify Type Parameters

Starting in DataWeave syntax version 2.5, you can specify the type parameters of a function at the
call site.

Input

```json
{
  "measures": [1, 2, 4, 1, 5, 2, 3, 3]
}
```

Transform

```dataweave
%dw 2.5
output application/json

fun max<T>(elems: Array<T>): T = elems reduce ((candidate: T, currentMax = elems[0]) -> if (candidate > currentMax) candidate else currentMax)
---
{
  max: max<Number>(measures)
}
```

Output

```linenums
{
  "max": 5
}
```

## Assign a Lambda to a Var

You can define a function as a variable with a constant directive through `var`

Input

```json
{
  "field1": "Annie",
  "field2": "Point",
  "field3": "Stuff"
}
```

Transform

```dataweave
%dw 2.0
output application/json
var toUser = (user) -> {
  firstName: user.field1,
  lastName: user.field2
}
---
{
  "user" : toUser(payload)
}
```

Output

```json
{
  "user": {
    "firstName": "Annie",
    "lastName": "Point"
  }
}
```

## Use Named Parameters in a Lambda

This example uses a lambda with an attribute that is explicitly named as `name`.

Input

```dataweave
%dw 2.0
output application/json
var names = ["john", "peter", "matt"]
---
users: names map((name) -> upper(name))
```

Transform

```json
{
  "users": ["JOHN", "PETER", "MATT"]
}
```

## Use Anonymous Parameters in a Lambda

This example uses a lambda with an attribute that’s not explicitly named, and so is referred to by
default as `$`.

Transform

```dataweave
%dw 2.0
output application/json
var names = ["john", "peter", "matt"]
---
users: names map upper($)
```

Output

```json
{
  "users": ["JOHN", "PETER", "MATT"]
}
```

## See Also

[Supported Data Formats](https://docs.mulesoft.com/dataweave/2.11/dataweave-formats)

[DataWeave Scripts](https://docs.mulesoft.com/dataweave/2.11/dataweave-language-introduction)

<!-- document id=8916cbbc69ad66c6b4beb0853fc8381158bee9df8b65e65023637fb88ed6e557 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-functions-lambdas.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Work with Functions and Lambdas in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

In DataWeave, functions and lambdas (anonymous functions) can be passed as values or be assigned to
variables.

When using lambdas within the body of a DataWeave file in conjunction with an function such as
`map`, its attributes can either be explicitly named or left anonymous, in which case they can be
referenced as `$`, `$$`, etc.

## Declare and Invoke a Function

You can declare a function in the header or body of a DataWeave script by using the `fun` keyword.
Then you can invoke the function at any point in the body of the script.

You refer to functions using this form: `functionName()` or `functionName(arg1, arg2, argN)`

You can pass an expression in between the parentheses for each argument. Each expression between the
parentheses is evaluated, and the result is passed as an argument used in the execution of the
function body.

Input

```json
{
  "field1": "Annie",
  "field2": "Point",
  "field3": "Stuff"
}
```

Transform

```dataweave
%dw 2.0
output application/json
fun toUser(obj) = {
  firstName: obj.field1,
  lastName: obj.field2
}
---
{
  "user" : toUser(payload)
}
```

Output

```json
{
  "user": {
    "firstName": "Annie",
    "lastName": "Point"
  }
}
```

## Specify Type Parameters

Starting in DataWeave syntax version 2.5, you can specify the type parameters of a function at the
call site.

Input

```json
{
  "measures": [1, 2, 4, 1, 5, 2, 3, 3]
}
```

Transform

```dataweave
%dw 2.5
output application/json

fun max<T>(elems: Array<T>): T = elems reduce ((candidate: T, currentMax = elems[0]) -> if (candidate > currentMax) candidate else currentMax)
---
{
  max: max<Number>(measures)
}
```

Output

```linenums
{
  "max": 5
}
```

## Assign a Lambda to a Var

You can define a function as a variable with a constant directive through `var`

Input

```json
{
  "field1": "Annie",
  "field2": "Point",
  "field3": "Stuff"
}
```

Transform

```dataweave
%dw 2.0
output application/json
var toUser = (user) -> {
  firstName: user.field1,
  lastName: user.field2
}
---
{
  "user" : toUser(payload)
}
```

Output

```json
{
  "user": {
    "firstName": "Annie",
    "lastName": "Point"
  }
}
```

## Use Named Parameters in a Lambda

This example uses a lambda with an attribute that is explicitly named as `name`.

Input

```dataweave
%dw 2.0
output application/json
var names = ["john", "peter", "matt"]
---
users: names map((name) -> upper(name))
```

Transform

```json
{
  "users": ["JOHN", "PETER", "MATT"]
}
```

## Use Anonymous Parameters in a Lambda

This example uses a lambda with an attribute that’s not explicitly named, and so is referred to by
default as `$`.

Transform

```dataweave
%dw 2.0
output application/json
var names = ["john", "peter", "matt"]
---
users: names map upper($)
```

Output

```json
{
  "users": ["JOHN", "PETER", "MATT"]
}
```

## See Also

[Supported Data Formats](https://docs.mulesoft.com/dataweave/2.12/dataweave-formats)

[DataWeave Scripts](https://docs.mulesoft.com/dataweave/2.12/dataweave-language-introduction)

<!-- document id=57b26f9a20ca128b3d9bff4f8d906b7b3e20584f8162a1b350a87a4af88e2809 url=/mulesoft/current/en-us/dataweave/2.3/dataweave-functions-lambdas.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Work with Functions and Lambdas in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

In DataWeave, functions and lambdas (anonymous functions) can be passed as values or be assigned to
variables.

When using lambdas within the body of a DataWeave file in conjunction with an function such as
`map`, its attributes can either be explicitly named or left anonymous, in which case they can be
referenced as `$`, `$$`, etc.

## Declare and Invoke a Function

You can declare a function in the header or body of a DataWeave script by using the `fun` keyword.
Then you can invoke the function at any point in the body of the script.

You refer to functions using this form: `functionName()` or `functionName(arg1, arg2, argN)`

You can pass an expression in between the parentheses for each argument. Each expression between the
parentheses is evaluated, and the result is passed as an argument used in the execution of the
function body.

Input

```json
{
  "field1": "Annie",
  "field2": "Point",
  "field3": "Stuff"
}
```

Transform

```dataweave
%dw 2.0
output application/json
fun toUser(obj) = {
  firstName: obj.field1,
  lastName: obj.field2
}
---
{
  "user" : toUser(payload)
}
```

Output

```json
{
  "user": {
    "firstName": "Annie",
    "lastName": "Point"
  }
}
```

## Assign a Lambda to a Var

You can define a function as a variable with a constant directive through `var`

Input

```json
{
  "field1": "Annie",
  "field2": "Point",
  "field3": "Stuff"
}
```

Transform

```dataweave
%dw 2.0
output application/json
var toUser = (user) -> {
  firstName: user.field1,
  lastName: user.field2
}
---
{
  "user" : toUser(payload)
}
```

Output

```json
{
  "user": {
    "firstName": "Annie",
    "lastName": "Point"
  }
}
```

## Use Named Parameters in a Lambda

This example uses a lambda with an attribute that is explicitly named as `name`.

Input

```dataweave
%dw 2.0
output application/json
var names = ["john", "peter", "matt"]
---
users: names map((name) -> upper(name))
```

Transform

```json
{
  "users": ["JOHN", "PETER", "MATT"]
}
```

## Use Anonymous Parameters in a Lambda

This example uses a lambda with an attribute that’s not explicitly named, and so is referred to by
default as `$`.

Transform

```dataweave
%dw 2.0
output application/json
var names = ["john", "peter", "matt"]
---
users: names map upper($)
```

Output

```json
{
  "users": ["JOHN", "PETER", "MATT"]
}
```

## See Also

[Supported Data Formats](https://docs.mulesoft.com/dataweave/2.3/dataweave-formats)

[DataWeave Scripts](https://docs.mulesoft.com/dataweave/2.3/dataweave-language-introduction)

<!-- document id=d93ec5d19580204825081dfd05bdf4d0eeb1667c6afc49017b9f0ce0f5c82eee url=/mulesoft/current/en-us/dataweave/2.4/dataweave-functions-lambdas.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Work with Functions and Lambdas in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

In DataWeave, functions and lambdas (anonymous functions) can be passed as values or be assigned to
variables.

When using lambdas within the body of a DataWeave file in conjunction with an function such as
`map`, its attributes can either be explicitly named or left anonymous, in which case they can be
referenced as `$`, `$$`, etc.

## Declare and Invoke a Function

You can declare a function in the header or body of a DataWeave script by using the `fun` keyword.
Then you can invoke the function at any point in the body of the script.

You refer to functions using this form: `functionName()` or `functionName(arg1, arg2, argN)`

You can pass an expression in between the parentheses for each argument. Each expression between the
parentheses is evaluated, and the result is passed as an argument used in the execution of the
function body.

Input

```json
{
  "field1": "Annie",
  "field2": "Point",
  "field3": "Stuff"
}
```

Transform

```dataweave
%dw 2.0
output application/json
fun toUser(obj) = {
  firstName: obj.field1,
  lastName: obj.field2
}
---
{
  "user" : toUser(payload)
}
```

Output

```json
{
  "user": {
    "firstName": "Annie",
    "lastName": "Point"
  }
}
```

## Assign a Lambda to a Var

You can define a function as a variable with a constant directive through `var`

Input

```json
{
  "field1": "Annie",
  "field2": "Point",
  "field3": "Stuff"
}
```

Transform

```dataweave
%dw 2.0
output application/json
var toUser = (user) -> {
  firstName: user.field1,
  lastName: user.field2
}
---
{
  "user" : toUser(payload)
}
```

Output

```json
{
  "user": {
    "firstName": "Annie",
    "lastName": "Point"
  }
}
```

## Use Named Parameters in a Lambda

This example uses a lambda with an attribute that is explicitly named as `name`.

Input

```dataweave
%dw 2.0
output application/json
var names = ["john", "peter", "matt"]
---
users: names map((name) -> upper(name))
```

Transform

```json
{
  "users": ["JOHN", "PETER", "MATT"]
}
```

## Use Anonymous Parameters in a Lambda

This example uses a lambda with an attribute that’s not explicitly named, and so is referred to by
default as `$`.

Transform

```dataweave
%dw 2.0
output application/json
var names = ["john", "peter", "matt"]
---
users: names map upper($)
```

Output

```json
{
  "users": ["JOHN", "PETER", "MATT"]
}
```

## See Also

[Supported Data Formats](https://docs.mulesoft.com/dataweave/2.4/dataweave-formats)

[DataWeave Scripts](https://docs.mulesoft.com/dataweave/2.4/dataweave-language-introduction)

<!-- document id=729216a321e16d70fe12eaf11d68d285e426c29ea2bd92c2434ea577a2386c9a url=/mulesoft/current/en-us/dataweave/2.6/dataweave-functions-lambdas.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Work with Functions and Lambdas in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

In DataWeave, functions and lambdas (anonymous functions) can be passed as values or be assigned to
variables.

When using lambdas within the body of a DataWeave file in conjunction with an function such as
`map`, its attributes can either be explicitly named or left anonymous, in which case they can be
referenced as `$`, `$$`, etc.

## Declare and Invoke a Function

You can declare a function in the header or body of a DataWeave script by using the `fun` keyword.
Then you can invoke the function at any point in the body of the script.

You refer to functions using this form: `functionName()` or `functionName(arg1, arg2, argN)`

You can pass an expression in between the parentheses for each argument. Each expression between the
parentheses is evaluated, and the result is passed as an argument used in the execution of the
function body.

Input

```json
{
  "field1": "Annie",
  "field2": "Point",
  "field3": "Stuff"
}
```

Transform

```dataweave
%dw 2.0
output application/json
fun toUser(obj) = {
  firstName: obj.field1,
  lastName: obj.field2
}
---
{
  "user" : toUser(payload)
}
```

Output

```json
{
  "user": {
    "firstName": "Annie",
    "lastName": "Point"
  }
}
```

## Specify Type Parameters

Starting in DataWeave syntax version 2.5, you can specify the type parameters of a function at the
call site.

Input

```json
{
  "measures": [1, 2, 4, 1, 5, 2, 3, 3]
}
```

Transform

```dataweave
%dw 2.5
output application/json

fun max<T>(elems: Array<T>): T = elems reduce ((candidate: T, currentMax = elems[0]) -> if (candidate > currentMax) candidate else currentMax)
---
{
  max: max<Number>(measures)
}
```

Output

```linenums
{
  "max": 5
}
```

## Assign a Lambda to a Var

You can define a function as a variable with a constant directive through `var`

Input

```json
{
  "field1": "Annie",
  "field2": "Point",
  "field3": "Stuff"
}
```

Transform

```dataweave
%dw 2.0
output application/json
var toUser = (user) -> {
  firstName: user.field1,
  lastName: user.field2
}
---
{
  "user" : toUser(payload)
}
```

Output

```json
{
  "user": {
    "firstName": "Annie",
    "lastName": "Point"
  }
}
```

## Use Named Parameters in a Lambda

This example uses a lambda with an attribute that is explicitly named as `name`.

Input

```dataweave
%dw 2.0
output application/json
var names = ["john", "peter", "matt"]
---
users: names map((name) -> upper(name))
```

Transform

```json
{
  "users": ["JOHN", "PETER", "MATT"]
}
```

## Use Anonymous Parameters in a Lambda

This example uses a lambda with an attribute that’s not explicitly named, and so is referred to by
default as `$`.

Transform

```dataweave
%dw 2.0
output application/json
var names = ["john", "peter", "matt"]
---
users: names map upper($)
```

Output

```json
{
  "users": ["JOHN", "PETER", "MATT"]
}
```

## See Also

[Supported Data Formats](https://docs.mulesoft.com/dataweave/2.6/dataweave-formats)

[DataWeave Scripts](https://docs.mulesoft.com/dataweave/2.6/dataweave-language-introduction)

<!-- document id=37a11ce39b7572ef87475fb6f5861817f71c56daae59780c973cd41b1e4955f8 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-functions-lambdas.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Work with Functions and Lambdas in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

In DataWeave, functions and lambdas (anonymous functions) can be passed as values or be assigned to
variables.

When using lambdas within the body of a DataWeave file in conjunction with an function such as
`map`, its attributes can either be explicitly named or left anonymous, in which case they can be
referenced as `$`, `$$`, etc.

## Declare and Invoke a Function

You can declare a function in the header or body of a DataWeave script by using the `fun` keyword.
Then you can invoke the function at any point in the body of the script.

You refer to functions using this form: `functionName()` or `functionName(arg1, arg2, argN)`

You can pass an expression in between the parentheses for each argument. Each expression between the
parentheses is evaluated, and the result is passed as an argument used in the execution of the
function body.

Input

```json
{
  "field1": "Annie",
  "field2": "Point",
  "field3": "Stuff"
}
```

Transform

```dataweave
%dw 2.0
output application/json
fun toUser(obj) = {
  firstName: obj.field1,
  lastName: obj.field2
}
---
{
  "user" : toUser(payload)
}
```

Output

```json
{
  "user": {
    "firstName": "Annie",
    "lastName": "Point"
  }
}
```

## Specify Type Parameters

Starting in DataWeave syntax version 2.5, you can specify the type parameters of a function at the
call site.

Input

```json
{
  "measures": [1, 2, 4, 1, 5, 2, 3, 3]
}
```

Transform

```dataweave
%dw 2.5
output application/json

fun max<T>(elems: Array<T>): T = elems reduce ((candidate: T, currentMax = elems[0]) -> if (candidate > currentMax) candidate else currentMax)
---
{
  max: max<Number>(measures)
}
```

Output

```linenums
{
  "max": 5
}
```

## Assign a Lambda to a Var

You can define a function as a variable with a constant directive through `var`

Input

```json
{
  "field1": "Annie",
  "field2": "Point",
  "field3": "Stuff"
}
```

Transform

```dataweave
%dw 2.0
output application/json
var toUser = (user) -> {
  firstName: user.field1,
  lastName: user.field2
}
---
{
  "user" : toUser(payload)
}
```

Output

```json
{
  "user": {
    "firstName": "Annie",
    "lastName": "Point"
  }
}
```

## Use Named Parameters in a Lambda

This example uses a lambda with an attribute that is explicitly named as `name`.

Input

```dataweave
%dw 2.0
output application/json
var names = ["john", "peter", "matt"]
---
users: names map((name) -> upper(name))
```

Transform

```json
{
  "users": ["JOHN", "PETER", "MATT"]
}
```

## Use Anonymous Parameters in a Lambda

This example uses a lambda with an attribute that’s not explicitly named, and so is referred to by
default as `$`.

Transform

```dataweave
%dw 2.0
output application/json
var names = ["john", "peter", "matt"]
---
users: names map upper($)
```

Output

```json
{
  "users": ["JOHN", "PETER", "MATT"]
}
```

## See Also

[Supported Data Formats](https://docs.mulesoft.com/dataweave/2.9/dataweave-formats)

[DataWeave Scripts](https://docs.mulesoft.com/dataweave/2.9/dataweave-language-introduction)

<!-- document id=2298712a02b3d6b564d9e0947aa1608aaaf7519fdc03ebe0bd93981951ce1cd6 url=/mulesoft/current/en-us/dataweave/latest/dataweave-functions-lambdas.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, esb, transform, transformer, format, aggregate, rename, split, filter convert, xml, json, csv, pojo, java object, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping
---

# Work with Functions and Lambdas in DataWeave

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

In DataWeave, functions and lambdas (anonymous functions) can be passed as values or be assigned to
variables.

When using lambdas within the body of a DataWeave file in conjunction with an function such as
`map`, its attributes can either be explicitly named or left anonymous, in which case they can be
referenced as `$`, `$$`, etc.

## Declare and Invoke a Function

You can declare a function in the header or body of a DataWeave script by using the `fun` keyword.
Then you can invoke the function at any point in the body of the script.

You refer to functions using this form: `functionName()` or `functionName(arg1, arg2, argN)`

You can pass an expression in between the parentheses for each argument. Each expression between the
parentheses is evaluated, and the result is passed as an argument used in the execution of the
function body.

Input

```json
{
  "field1": "Annie",
  "field2": "Point",
  "field3": "Stuff"
}
```

Transform

```dataweave
%dw 2.0
output application/json
fun toUser(obj) = {
  firstName: obj.field1,
  lastName: obj.field2
}
---
{
  "user" : toUser(payload)
}
```

Output

```json
{
  "user": {
    "firstName": "Annie",
    "lastName": "Point"
  }
}
```

## Specify Type Parameters

Starting in DataWeave syntax version 2.5, you can specify the type parameters of a function at the
call site.

Input

```json
{
  "measures": [1, 2, 4, 1, 5, 2, 3, 3]
}
```

Transform

```dataweave
%dw 2.5
output application/json

fun max<T>(elems: Array<T>): T = elems reduce ((candidate: T, currentMax = elems[0]) -> if (candidate > currentMax) candidate else currentMax)
---
{
  max: max<Number>(measures)
}
```

Output

```linenums
{
  "max": 5
}
```

## Assign a Lambda to a Var

You can define a function as a variable with a constant directive through `var`

Input

```json
{
  "field1": "Annie",
  "field2": "Point",
  "field3": "Stuff"
}
```

Transform

```dataweave
%dw 2.0
output application/json
var toUser = (user) -> {
  firstName: user.field1,
  lastName: user.field2
}
---
{
  "user" : toUser(payload)
}
```

Output

```json
{
  "user": {
    "firstName": "Annie",
    "lastName": "Point"
  }
}
```

## Use Named Parameters in a Lambda

This example uses a lambda with an attribute that is explicitly named as `name`.

Input

```dataweave
%dw 2.0
output application/json
var names = ["john", "peter", "matt"]
---
users: names map((name) -> upper(name))
```

Transform

```json
{
  "users": ["JOHN", "PETER", "MATT"]
}
```

## Use Anonymous Parameters in a Lambda

This example uses a lambda with an attribute that’s not explicitly named, and so is referred to by
default as `$`.

Transform

```dataweave
%dw 2.0
output application/json
var names = ["john", "peter", "matt"]
---
users: names map upper($)
```

Output

```json
{
  "users": ["JOHN", "PETER", "MATT"]
}
```

## See Also

[Supported Data Formats](https://docs.mulesoft.com/dataweave/latest/dataweave-formats)

[DataWeave Scripts](https://docs.mulesoft.com/dataweave/latest/dataweave-language-introduction)

<!-- document id=eb29ab9da749bdf9b862f25b3ec5ad0c07676bf2f3cc719b768b9ffdf5a5f6ad url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook-work-with-multipart-data.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, date, time
---

# Work with Multipart Data

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following example iterates over a multipart payload and extracts data from each part.

The example uses the following functions:

- `read` (in the script’s header) reads the multipart content from a `multi` variable that sets the
  boundary to `34b21`.

- `mapObject` iterates over the parts in the multipart data returned by `read` and returns the index
  and `name` key of each part within a JSON object.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
var multi = '--34b21
Content-Disposition: form-data; name="text"
Content-Type: text/plain

Book
--34b21
Content-Disposition: form-data; name="file1"; filename="a.json"
Content-Type: application/json

{
  "title": "Java 8 in Action",
  "author": "Mario Fusco",
  "year": 2014
}
--34b21
Content-Disposition: form-data; name="file2"; filename="a.html"
Content-Type: text/html

<!DOCTYPE html>
<title>
  Available for download!
</title>
--34b21--'
var parsed = read(multi, "multipart/form-data", {boundary:'34b21'})
---
parsed.parts mapObject ((value, key, index) -> {(index): key})
```

Output:

```json
{
  "0": "text",
  "1": "file1",
  "2": "file2"
}
```

For additional examples, see [Multipart Format (Form Data)](https://docs.mulesoft.com/dataweave/2.11/dataweave-formats-multipart#examples)
examples and functions referenced in [Multipart (dw::module::Multipart)](https://docs.mulesoft.com/dataweave/2.11/dw-multipart).

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.11/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook)

<!-- document id=ef48b728f6f53410f43f8b25399ac8dfa7c6515601782b60e6cb5c58b13dde84 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook-work-with-multipart-data.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, date, time
---

# Work with Multipart Data

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following example iterates over a multipart payload and extracts data from each part.

The example uses the following functions:

- `read` (in the script’s header) reads the multipart content from a `multi` variable that sets the
  boundary to `34b21`.

- `mapObject` iterates over the parts in the multipart data returned by `read` and returns the index
  and `name` key of each part within a JSON object.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
var multi = '--34b21
Content-Disposition: form-data; name="text"
Content-Type: text/plain

Book
--34b21
Content-Disposition: form-data; name="file1"; filename="a.json"
Content-Type: application/json

{
  "title": "Java 8 in Action",
  "author": "Mario Fusco",
  "year": 2014
}
--34b21
Content-Disposition: form-data; name="file2"; filename="a.html"
Content-Type: text/html

<!DOCTYPE html>
<title>
  Available for download!
</title>
--34b21--'
var parsed = read(multi, "multipart/form-data", {boundary:'34b21'})
---
parsed.parts mapObject ((value, key, index) -> {(index): key})
```

Output:

```json
{
  "0": "text",
  "1": "file1",
  "2": "file2"
}
```

For additional examples, see [Multipart Format (Form Data)](https://docs.mulesoft.com/dataweave/2.12/dataweave-formats-multipart#examples)
examples and functions referenced in [Multipart (dw::module::Multipart)](https://docs.mulesoft.com/dataweave/2.12/dw-multipart).

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.12/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook)

<!-- document id=4a896a501839559ca436b081417b3518b1875b48652de8c4e01b38c1a0c06b41 url=/mulesoft/current/en-us/dataweave/2.3/dataweave-cookbook-work-with-multipart-data.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, date, time
---

# Work with Multipart Data

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following example iterates over a multipart payload and extracts data from each part.

The example uses the following functions:

- `read` (in the script’s header) reads the multipart content from a `multi` variable that sets the
  boundary to `34b21`.

- `mapObject` iterates over the parts in the multipart data returned by `read` and returns the index
  and `name` key of each part within a JSON object.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
var multi = '--34b21
Content-Disposition: form-data; name="text"
Content-Type: text/plain

Book
--34b21
Content-Disposition: form-data; name="file1"; filename="a.json"
Content-Type: application/json

{
  "title": "Java 8 in Action",
  "author": "Mario Fusco",
  "year": 2014
}
--34b21
Content-Disposition: form-data; name="file2"; filename="a.html"
Content-Type: text/html

<!DOCTYPE html>
<title>
  Available for download!
</title>
--34b21--'
var parsed = read(multi, "multipart/form-data", {boundary:'34b21'})
---
parsed.parts mapObject ((value, key, index) -> {(index): key})
```

Output:

```xml
{
  "0": "text",
  "1": "file1",
  "2": "file2"
}
```

For additional examples, see [Multipart Format (Form Data)](https://docs.mulesoft.com/dataweave/2.3/dataweave-formats-multipart#examples)
examples and functions referenced in [Multipart (dw::module::Multipart)](https://docs.mulesoft.com/dataweave/2.3/dw-multipart).

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.3/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook)

<!-- document id=22767c73dcc528a54a4c388098d1f712bab6cb59066359804b81b0913a165cb8 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook-work-with-multipart-data.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, date, time
---

# Work with Multipart Data

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following example iterates over a multipart payload and extracts data from each part.

The example uses the following functions:

- `read` (in the script’s header) reads the multipart content from a `multi` variable that sets the
  boundary to `34b21`.

- `mapObject` iterates over the parts in the multipart data returned by `read` and returns the index
  and `name` key of each part within a JSON object.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
var multi = '--34b21
Content-Disposition: form-data; name="text"
Content-Type: text/plain

Book
--34b21
Content-Disposition: form-data; name="file1"; filename="a.json"
Content-Type: application/json

{
  "title": "Java 8 in Action",
  "author": "Mario Fusco",
  "year": 2014
}
--34b21
Content-Disposition: form-data; name="file2"; filename="a.html"
Content-Type: text/html

<!DOCTYPE html>
<title>
  Available for download!
</title>
--34b21--'
var parsed = read(multi, "multipart/form-data", {boundary:'34b21'})
---
parsed.parts mapObject ((value, key, index) -> {(index): key})
```

Output:

```json
{
  "0": "text",
  "1": "file1",
  "2": "file2"
}
```

For additional examples, see [Multipart Format (Form Data)](https://docs.mulesoft.com/dataweave/2.4/dataweave-formats-multipart#examples)
examples and functions referenced in [Multipart (dw::module::Multipart)](https://docs.mulesoft.com/dataweave/2.4/dw-multipart).

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.4/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook)

<!-- document id=b83502a5472669a8e967be052fd666cdd1e5baf9abb16bfdb5fee4547e0aa731 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook-work-with-multipart-data.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, date, time
---

# Work with Multipart Data

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following example iterates over a multipart payload and extracts data from each part.

The example uses the following functions:

- `read` (in the script’s header) reads the multipart content from a `multi` variable that sets the
  boundary to `34b21`.

- `mapObject` iterates over the parts in the multipart data returned by `read` and returns the index
  and `name` key of each part within a JSON object.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
var multi = '--34b21
Content-Disposition: form-data; name="text"
Content-Type: text/plain

Book
--34b21
Content-Disposition: form-data; name="file1"; filename="a.json"
Content-Type: application/json

{
  "title": "Java 8 in Action",
  "author": "Mario Fusco",
  "year": 2014
}
--34b21
Content-Disposition: form-data; name="file2"; filename="a.html"
Content-Type: text/html

<!DOCTYPE html>
<title>
  Available for download!
</title>
--34b21--'
var parsed = read(multi, "multipart/form-data", {boundary:'34b21'})
---
parsed.parts mapObject ((value, key, index) -> {(index): key})
```

Output:

```json
{
  "0": "text",
  "1": "file1",
  "2": "file2"
}
```

For additional examples, see [Multipart Format (Form Data)](https://docs.mulesoft.com/dataweave/2.6/dataweave-formats-multipart#examples)
examples and functions referenced in [Multipart (dw::module::Multipart)](https://docs.mulesoft.com/dataweave/2.6/dw-multipart).

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.6/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook)

<!-- document id=df35568e7d64ae4542b4e9be6edbb2500b1e7f2d3d10278498683caa5db5c06b url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook-work-with-multipart-data.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, date, time
---

# Work with Multipart Data

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following example iterates over a multipart payload and extracts data from each part.

The example uses the following functions:

- `read` (in the script’s header) reads the multipart content from a `multi` variable that sets the
  boundary to `34b21`.

- `mapObject` iterates over the parts in the multipart data returned by `read` and returns the index
  and `name` key of each part within a JSON object.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
var multi = '--34b21
Content-Disposition: form-data; name="text"
Content-Type: text/plain

Book
--34b21
Content-Disposition: form-data; name="file1"; filename="a.json"
Content-Type: application/json

{
  "title": "Java 8 in Action",
  "author": "Mario Fusco",
  "year": 2014
}
--34b21
Content-Disposition: form-data; name="file2"; filename="a.html"
Content-Type: text/html

<!DOCTYPE html>
<title>
  Available for download!
</title>
--34b21--'
var parsed = read(multi, "multipart/form-data", {boundary:'34b21'})
---
parsed.parts mapObject ((value, key, index) -> {(index): key})
```

Output:

```json
{
  "0": "text",
  "1": "file1",
  "2": "file2"
}
```

For additional examples, see [Multipart Format (Form Data)](https://docs.mulesoft.com/dataweave/2.9/dataweave-formats-multipart#examples)
examples and functions referenced in [Multipart (dw::module::Multipart)](https://docs.mulesoft.com/dataweave/2.9/dw-multipart).

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.9/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook)

<!-- document id=68667715dc29a959d7dd536b8934921507d3915dcbdb7889dc8d894547019c1b url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook-work-with-multipart-data.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, transform, transformer, format, xml, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, date, time
---

# Work with Multipart Data

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following example iterates over a multipart payload and extracts data from each part.

The example uses the following functions:

- `read` (in the script’s header) reads the multipart content from a `multi` variable that sets the
  boundary to `34b21`.

- `mapObject` iterates over the parts in the multipart data returned by `read` and returns the index
  and `name` key of each part within a JSON object.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
var multi = '--34b21
Content-Disposition: form-data; name="text"
Content-Type: text/plain

Book
--34b21
Content-Disposition: form-data; name="file1"; filename="a.json"
Content-Type: application/json

{
  "title": "Java 8 in Action",
  "author": "Mario Fusco",
  "year": 2014
}
--34b21
Content-Disposition: form-data; name="file2"; filename="a.html"
Content-Type: text/html

<!DOCTYPE html>
<title>
  Available for download!
</title>
--34b21--'
var parsed = read(multi, "multipart/form-data", {boundary:'34b21'})
---
parsed.parts mapObject ((value, key, index) -> {(index): key})
```

Output:

```json
{
  "0": "text",
  "1": "file1",
  "2": "file2"
}
```

For additional examples, see [Multipart Format (Form Data)](https://docs.mulesoft.com/dataweave/latest/dataweave-formats-multipart#examples)
examples and functions referenced in [Multipart (dw::module::Multipart)](https://docs.mulesoft.com/dataweave/latest/dw-multipart).

## See Also

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook)

<!-- document id=84bf009fbc6681abcc8b4f4ff776b16e159f9be119d87e142e573e221a333ae0 url=/mulesoft/current/en-us/dataweave/2.11/dw-strings-functions-wrapifmissing.md -->

---
product: DataWeave
version: 2.11
---

# wrapIfMissing

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## wrapIfMissing(text: String, wrapper: String): String

Wraps `text` with `wrapper` if that `wrapper` is missing from the start or end of the given string.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>wrapper</code></p></td><td><p>The content used to wrap.</p></td></tr></tbody></table>

### Example

This example shows how `wrapIfMissing` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
 {
   "a": wrapIfMissing(null, "'"),
   "b": wrapIfMissing("", "'"),
   "c": wrapIfMissing("ab", "x"),
   "d": wrapIfMissing("'ab'", "'"),
   "e": wrapIfMissing("/", '/'),
   "f": wrapIfMissing("a/b/c", '/'),
   "g": wrapIfMissing("/a/b/c", '/'),
   "h": wrapIfMissing("a/b/c/", '/')
 }
```

#### Output

```JSON
{
   "a": null,
   "b": "'",
   "c": "xabx",
   "d": "'ab'",
   "e": "/",
   "f": "/a/b/c/",
   "g": "/a/b/c/",
   "h": "/a/b/c/"
 }
```

## wrapIfMissing(text: Null, wrapper: String): Null

Helper function that enables `wrapIfMissing` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=effe65d7d9ec08edd0b5e64695025d8afa861632307356b14e1a8720f04759b6 url=/mulesoft/current/en-us/dataweave/2.12/dw-strings-functions-wrapifmissing.md -->

---
product: DataWeave
version: 2.12
---

# wrapIfMissing

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## wrapIfMissing(text: String, wrapper: String): String

Wraps `text` with `wrapper` if that `wrapper` is missing from the start or end of the given string.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>wrapper</code></p></td><td><p>The content used to wrap.</p></td></tr></tbody></table>

### Example

This example shows how `wrapIfMissing` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
 {
   "a": wrapIfMissing(null, "'"),
   "b": wrapIfMissing("", "'"),
   "c": wrapIfMissing("ab", "x"),
   "d": wrapIfMissing("'ab'", "'"),
   "e": wrapIfMissing("/", '/'),
   "f": wrapIfMissing("a/b/c", '/'),
   "g": wrapIfMissing("/a/b/c", '/'),
   "h": wrapIfMissing("a/b/c/", '/')
 }
```

#### Output

```JSON
{
   "a": null,
   "b": "'",
   "c": "xabx",
   "d": "'ab'",
   "e": "/",
   "f": "/a/b/c/",
   "g": "/a/b/c/",
   "h": "/a/b/c/"
 }
```

## wrapIfMissing(text: Null, wrapper: String): Null

Helper function that enables `wrapIfMissing` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=7f2780880f852ccefdf5d371c96ff3a854a5c1bdd2e3ec69133b2d8fe679b8fe url=/mulesoft/current/en-us/dataweave/2.3/dw-strings-functions-wrapifmissing.md -->

---
product: DataWeave
version: 2.3
---

# wrapIfMissing

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## wrapIfMissing(String, String): String

Wraps `text` with `wrapper` if that `wrapper` is missing from the start or end of the given string.

_Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>wrapper</code></p></td><td><p>The content used to wrap.</p></td></tr></tbody></table>

### Example

This example shows how `wrapIfMissing` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
 {
   "a": wrapIfMissing(null, "'"),
   "b": wrapIfMissing("", "'"),
   "c": wrapIfMissing("ab", "x"),
   "d": wrapIfMissing("'ab'", "'"),
   "e": wrapIfMissing("/", '/'),
   "f": wrapIfMissing("a/b/c", '/'),
   "g": wrapIfMissing("/a/b/c", '/'),
   "h": wrapIfMissing("a/b/c/", '/')
 }
```

#### Output

```JSON
{
   "a": null,
   "b": "'",
   "c": "xabx",
   "d": "'ab'",
   "e": "/",
   "f": "/a/b/c/",
   "g": "/a/b/c/",
   "h": "/a/b/c/"
 }
```

## wrapIfMissing(Null, String): Null

Helper function that enables `wrapIfMissing` to work with a `null` value.

<!-- document id=b20ce5d0bc8b256147534eadd34e55989a739f56294c94cb0d2ee79d6c29ee88 url=/mulesoft/current/en-us/dataweave/2.4/dw-strings-functions-wrapifmissing.md -->

---
product: DataWeave
version: 2.4
---

# wrapIfMissing

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## wrapIfMissing(text: String, wrapper: String): String

Wraps `text` with `wrapper` if that `wrapper` is missing from the start or end of the given string.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>wrapper</code></p></td><td><p>The content used to wrap.</p></td></tr></tbody></table>

### Example

This example shows how `wrapIfMissing` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
 {
   "a": wrapIfMissing(null, "'"),
   "b": wrapIfMissing("", "'"),
   "c": wrapIfMissing("ab", "x"),
   "d": wrapIfMissing("'ab'", "'"),
   "e": wrapIfMissing("/", '/'),
   "f": wrapIfMissing("a/b/c", '/'),
   "g": wrapIfMissing("/a/b/c", '/'),
   "h": wrapIfMissing("a/b/c/", '/')
 }
```

#### Output

```JSON
{
   "a": null,
   "b": "'",
   "c": "xabx",
   "d": "'ab'",
   "e": "/",
   "f": "/a/b/c/",
   "g": "/a/b/c/",
   "h": "/a/b/c/"
 }
```

## wrapIfMissing(text: Null, wrapper: String): Null

Helper function that enables `wrapIfMissing` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=038035a04c33e5c52699ce59a4a75fb70ced9d4390d2af0b23e4dc19dcef979f url=/mulesoft/current/en-us/dataweave/2.6/dw-strings-functions-wrapifmissing.md -->

---
product: DataWeave
version: 2.6
---

# wrapIfMissing

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## wrapIfMissing(text: String, wrapper: String): String

Wraps `text` with `wrapper` if that `wrapper` is missing from the start or end of the given string.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>wrapper</code></p></td><td><p>The content used to wrap.</p></td></tr></tbody></table>

### Example

This example shows how `wrapIfMissing` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
 {
   "a": wrapIfMissing(null, "'"),
   "b": wrapIfMissing("", "'"),
   "c": wrapIfMissing("ab", "x"),
   "d": wrapIfMissing("'ab'", "'"),
   "e": wrapIfMissing("/", '/'),
   "f": wrapIfMissing("a/b/c", '/'),
   "g": wrapIfMissing("/a/b/c", '/'),
   "h": wrapIfMissing("a/b/c/", '/')
 }
```

#### Output

```JSON
{
   "a": null,
   "b": "'",
   "c": "xabx",
   "d": "'ab'",
   "e": "/",
   "f": "/a/b/c/",
   "g": "/a/b/c/",
   "h": "/a/b/c/"
 }
```

## wrapIfMissing(text: Null, wrapper: String): Null

Helper function that enables `wrapIfMissing` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=b245ad4323e099bddac8a5e3b23fa9d8ec592bd1df13dbd0a94a610710830bcd url=/mulesoft/current/en-us/dataweave/2.9/dw-strings-functions-wrapifmissing.md -->

---
product: DataWeave
version: 2.9
---

# wrapIfMissing

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## wrapIfMissing(text: String, wrapper: String): String

Wraps `text` with `wrapper` if that `wrapper` is missing from the start or end of the given string.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>wrapper</code></p></td><td><p>The content used to wrap.</p></td></tr></tbody></table>

### Example

This example shows how `wrapIfMissing` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
 {
   "a": wrapIfMissing(null, "'"),
   "b": wrapIfMissing("", "'"),
   "c": wrapIfMissing("ab", "x"),
   "d": wrapIfMissing("'ab'", "'"),
   "e": wrapIfMissing("/", '/'),
   "f": wrapIfMissing("a/b/c", '/'),
   "g": wrapIfMissing("/a/b/c", '/'),
   "h": wrapIfMissing("a/b/c/", '/')
 }
```

#### Output

```JSON
{
   "a": null,
   "b": "'",
   "c": "xabx",
   "d": "'ab'",
   "e": "/",
   "f": "/a/b/c/",
   "g": "/a/b/c/",
   "h": "/a/b/c/"
 }
```

## wrapIfMissing(text: Null, wrapper: String): Null

Helper function that enables `wrapIfMissing` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=6366d14b7b0ddb6419115ea0c28fda2236dc936d894954782d8d6df4229ed8f3 url=/mulesoft/current/en-us/dataweave/latest/dw-strings-functions-wrapifmissing.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# wrapIfMissing

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## wrapIfMissing(text: String, wrapper: String): String

Wraps `text` with `wrapper` if that `wrapper` is missing from the start or end of the given string.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>wrapper</code></p></td><td><p>The content used to wrap.</p></td></tr></tbody></table>

### Example

This example shows how `wrapIfMissing` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
 {
   "a": wrapIfMissing(null, "'"),
   "b": wrapIfMissing("", "'"),
   "c": wrapIfMissing("ab", "x"),
   "d": wrapIfMissing("'ab'", "'"),
   "e": wrapIfMissing("/", '/'),
   "f": wrapIfMissing("a/b/c", '/'),
   "g": wrapIfMissing("/a/b/c", '/'),
   "h": wrapIfMissing("a/b/c/", '/')
 }
```

#### Output

```JSON
{
   "a": null,
   "b": "'",
   "c": "xabx",
   "d": "'ab'",
   "e": "/",
   "f": "/a/b/c/",
   "g": "/a/b/c/",
   "h": "/a/b/c/"
 }
```

## wrapIfMissing(text: Null, wrapper: String): Null

Helper function that enables `wrapIfMissing` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=60ed8a14a39c594f40747585c0113cf14dfdcd438c99a75d3608c31451065d55 url=/mulesoft/current/en-us/dataweave/2.11/dw-strings-functions-wrapwith.md -->

---
product: DataWeave
version: 2.11
---

# wrapWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## wrapWith(text: String, wrapper: String): String

Wraps the specified `text` with the given `wrapper`.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>wrapper</code></p></td><td><p>The content used to wrap.</p></td></tr></tbody></table>

### Example

This example shows how `wrapWith` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": wrapWith(null, "'"),
  "b": wrapWith("", "'"),
  "c": wrapWith("ab", "x"),
  "d": wrapWith("'ab'", "'"),
  "e": wrapWith("ab", "'")
}
```

#### Output

```JSON
{
  "a": null,
  "b": "''",
  "c": "xabx",
  "d": "''ab''",
  "e": "'ab'"
}
```

## wrapWith(text: Null, wrapper: Any): Null

Helper function that enables `wrapWith` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=7959f2000e8e3bc08b411aea96979c916b1de150a2c1c7553300354d6f41c89e url=/mulesoft/current/en-us/dataweave/2.12/dw-strings-functions-wrapwith.md -->

---
product: DataWeave
version: 2.12
---

# wrapWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## wrapWith(text: String, wrapper: String): String

Wraps the specified `text` with the given `wrapper`.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>wrapper</code></p></td><td><p>The content used to wrap.</p></td></tr></tbody></table>

### Example

This example shows how `wrapWith` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": wrapWith(null, "'"),
  "b": wrapWith("", "'"),
  "c": wrapWith("ab", "x"),
  "d": wrapWith("'ab'", "'"),
  "e": wrapWith("ab", "'")
}
```

#### Output

```JSON
{
  "a": null,
  "b": "''",
  "c": "xabx",
  "d": "''ab''",
  "e": "'ab'"
}
```

## wrapWith(text: Null, wrapper: Any): Null

Helper function that enables `wrapWith` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=f7f87873700110a098f56b3bc7bd4bf5aca9a21ce39cb9fea3785f2ac1e8d37c url=/mulesoft/current/en-us/dataweave/2.3/dw-strings-functions-wrapwith.md -->

---
product: DataWeave
version: 2.3
---

# wrapWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## wrapWith(String, String): String

Wraps the specified `text` with the given `wrapper`.

_Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>wrapper</code></p></td><td><p>The content used to wrap.</p></td></tr></tbody></table>

### Example

This example shows how `wrapWith` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": wrapWith(null, "'"),
  "b": wrapWith("", "'"),
  "c": wrapWith("ab", "x"),
  "d": wrapWith("'ab'", "'"),
  "e": wrapWith("ab", "'")
}
```

#### Output

```JSON
{
  "a": null,
  "b": "''",
  "c": "xabx",
  "d": "''ab''",
  "e": "'ab'"
}
```

## wrapWith(Null, String): Null

Helper function that enables `wrapWith` to work with a `null` value.

<!-- document id=836495ae6ec9a513caf0a95eb836dca035833353758672428e3653197237ce87 url=/mulesoft/current/en-us/dataweave/2.4/dw-strings-functions-wrapwith.md -->

---
product: DataWeave
version: 2.4
---

# wrapWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## wrapWith(text: String, wrapper: String): String

Wraps the specified `text` with the given `wrapper`.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>wrapper</code></p></td><td><p>The content used to wrap.</p></td></tr></tbody></table>

### Example

This example shows how `wrapWith` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": wrapWith(null, "'"),
  "b": wrapWith("", "'"),
  "c": wrapWith("ab", "x"),
  "d": wrapWith("'ab'", "'"),
  "e": wrapWith("ab", "'")
}
```

#### Output

```JSON
{
  "a": null,
  "b": "''",
  "c": "xabx",
  "d": "''ab''",
  "e": "'ab'"
}
```

## wrapWith(text: Null, wrapper: Any): Null

Helper function that enables `wrapWith` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=c3c7b683ac412088defa207663f298ef82b5acb449811d562257fd716654b0d9 url=/mulesoft/current/en-us/dataweave/2.6/dw-strings-functions-wrapwith.md -->

---
product: DataWeave
version: 2.6
---

# wrapWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## wrapWith(text: String, wrapper: String): String

Wraps the specified `text` with the given `wrapper`.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>wrapper</code></p></td><td><p>The content used to wrap.</p></td></tr></tbody></table>

### Example

This example shows how `wrapWith` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": wrapWith(null, "'"),
  "b": wrapWith("", "'"),
  "c": wrapWith("ab", "x"),
  "d": wrapWith("'ab'", "'"),
  "e": wrapWith("ab", "'")
}
```

#### Output

```JSON
{
  "a": null,
  "b": "''",
  "c": "xabx",
  "d": "''ab''",
  "e": "'ab'"
}
```

## wrapWith(text: Null, wrapper: Any): Null

Helper function that enables `wrapWith` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=5eb6c8ac7ef2edf245f836bd548137a44c93e86f87883763e5604e2fd204f65b url=/mulesoft/current/en-us/dataweave/2.9/dw-strings-functions-wrapwith.md -->

---
product: DataWeave
version: 2.9
---

# wrapWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## wrapWith(text: String, wrapper: String): String

Wraps the specified `text` with the given `wrapper`.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>wrapper</code></p></td><td><p>The content used to wrap.</p></td></tr></tbody></table>

### Example

This example shows how `wrapWith` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": wrapWith(null, "'"),
  "b": wrapWith("", "'"),
  "c": wrapWith("ab", "x"),
  "d": wrapWith("'ab'", "'"),
  "e": wrapWith("ab", "'")
}
```

#### Output

```JSON
{
  "a": null,
  "b": "''",
  "c": "xabx",
  "d": "''ab''",
  "e": "'ab'"
}
```

## wrapWith(text: Null, wrapper: Any): Null

Helper function that enables `wrapWith` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=9ca6386c4db40ce2d30b56fb1670a571b0318fddf6cce7d867cc4032e52702b2 url=/mulesoft/current/en-us/dataweave/latest/dw-strings-functions-wrapwith.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# wrapWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## wrapWith(text: String, wrapper: String): String

Wraps the specified `text` with the given `wrapper`.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>text</code></p></td><td><p>The input string.</p></td></tr><tr><td><p><code>wrapper</code></p></td><td><p>The content used to wrap.</p></td></tr></tbody></table>

### Example

This example shows how `wrapWith` behaves with different inputs and sizes.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Strings
output application/json
---
{
  "a": wrapWith(null, "'"),
  "b": wrapWith("", "'"),
  "c": wrapWith("ab", "x"),
  "d": wrapWith("'ab'", "'"),
  "e": wrapWith("ab", "'")
}
```

#### Output

```JSON
{
  "a": null,
  "b": "''",
  "c": "xabx",
  "d": "''ab''",
  "e": "'ab'"
}
```

## wrapWith(text: Null, wrapper: Any): Null

Helper function that enables `wrapWith` to work with a `null` value.

_Introduced in DataWeave version 2.2.0._

<!-- document id=84873a96185ac3fe4ac55a15b1cf09cb85afe026b972336d9aa8468059635d88 url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-write.md -->

---
product: DataWeave
version: 2.11
---

# write

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## write(value: Any, contentType: String = "application/dw", writerProperties: Object = {}): String | Binary

Writes a value as a string or binary in a supported format.

Returns a String or Binary with the serialized representation of the value in the specified format
(MIME type). This function can write to a different format than the input. Note that the data must
validate in that new format, or an error will occur. For example, `application/xml` content is not
valid within an `application/json` format, but `text/plain` can be valid. It returns a `String`
value for all text-based data formats (such as XML, JSON , CSV) and a `Binary` value for all the
binary formats (such as Excel, MultiPart, OctetStream).

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The value to write. The value can be of any supported data type.</p></td></tr><tr><td><p><code>contentType</code></p></td><td><p>A supported format (or MIME type) to write. Default: <code>application/dw</code>.</p></td></tr><tr><td><p><code>writerProperties</code></p></td><td><p>Optional: Sets writer configuration properties. For writer configuration properties (and other supported MIME types), see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats">Supported Data Formats</a>.</p></td></tr></tbody></table>

### Example

This example writes the string `world` in plain text (`text/plain"`). It outputs that string as the
value of a JSON object with the key `hello`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ hello : write("world", "text/plain") }
```

#### Output

```JSON
{ "hello": "world" }
```

### Example

This example takes JSON input and writes the payload to a CSV format that uses a pipe (`|`)
separator and includes the header (matching keys in the JSON objects). Note that if you instead use
`"header":false` in your script, the output will lack the `Name|Email|Id|Title` header in the
output.

#### Source

```DataWeave
%dw 2.0
output application/xml
---
{ "output" : write(payload, "application/csv", {"header":true, "separator" : "|"}) }
```

#### Input

```JSON
[
  {
    "Name": "Mr White",
    "Email": "white@mulesoft.com",
    "Id": "1234",
    "Title": "Chief Java Prophet"
  },
  {
    "Name": "Mr Orange",
    "Email": "orange@mulesoft.com",
    "Id": "4567",
    "Title": "Integration Ninja"
  }
]
```

#### Output

```XML
<?xml version="1.0" encoding="US-ASCII"?>
<output>Name|Email|Id|Title
Mr White|white@mulesoft.com|1234|Chief Java Prophet
Mr Orange|orange@mulesoft.com|4567|Integration Ninja
</output>
```

<!-- document id=a80b10a9851d27309ddfe131a9f34cc9b6308dafc038c7f9c9a3ccf032b1a1e4 url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-write.md -->

---
product: DataWeave
version: 2.12
---

# write

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## write(value: Any, contentType: String = "application/dw", writerProperties: Object = {}): String | Binary

Writes a value as a string or binary in a supported format.

Returns a String or Binary with the serialized representation of the value in the specified format
(MIME type). This function can write to a different format than the input. Note that the data must
validate in that new format, or an error will occur. For example, `application/xml` content is not
valid within an `application/json` format, but `text/plain` can be valid. It returns a `String`
value for all text-based data formats (such as XML, JSON , CSV) and a `Binary` value for all the
binary formats (such as Excel, MultiPart, OctetStream).

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The value to write. The value can be of any supported data type.</p></td></tr><tr><td><p><code>contentType</code></p></td><td><p>A supported format (or MIME type) to write. Default: <code>application/dw</code>.</p></td></tr><tr><td><p><code>writerProperties</code></p></td><td><p>Optional: Sets writer configuration properties. For writer configuration properties (and other supported MIME types), see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats">Supported Data Formats</a>.</p></td></tr></tbody></table>

### Example

This example writes the string `world` in plain text (`text/plain"`). It outputs that string as the
value of a JSON object with the key `hello`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ hello : write("world", "text/plain") }
```

#### Output

```JSON
{ "hello": "world" }
```

### Example

This example takes JSON input and writes the payload to a CSV format that uses a pipe (`|`)
separator and includes the header (matching keys in the JSON objects). Note that if you instead use
`"header":false` in your script, the output will lack the `Name|Email|Id|Title` header in the
output.

#### Source

```DataWeave
%dw 2.0
output application/xml
---
{ "output" : write(payload, "application/csv", {"header":true, "separator" : "|"}) }
```

#### Input

```JSON
[
  {
    "Name": "Mr White",
    "Email": "white@mulesoft.com",
    "Id": "1234",
    "Title": "Chief Java Prophet"
  },
  {
    "Name": "Mr Orange",
    "Email": "orange@mulesoft.com",
    "Id": "4567",
    "Title": "Integration Ninja"
  }
]
```

#### Output

```XML
<?xml version="1.0" encoding="US-ASCII"?>
<output>Name|Email|Id|Title
Mr White|white@mulesoft.com|1234|Chief Java Prophet
Mr Orange|orange@mulesoft.com|4567|Integration Ninja
</output>
```

<!-- document id=08362048f16656b818ba11fa28e9f6b5d2d1dbebe6c8e1edf991db67030f311a url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-write.md -->

---
product: DataWeave
version: 2.3
---

# write

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## write(Any, String, Object): String | Binary

Writes a value as a string or binary in a supported format.

Returns a string or binary with the serialized representation of the value in the specified format
(MIME type). This function can write to a different format than the input. Note that the data must
validate in that new format, or an error will occur. For example, `application/xml` content is not
valid within an `application/json` format, but `text/plain` can be valid.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The value to write. The value can be of any supported data type.</p></td></tr><tr><td><p><code>contentType</code></p></td><td><p>A supported format (or MIME type) to write. Default: <code>application/dw</code>.</p></td></tr><tr><td><p><code>writerProperties</code></p></td><td><p>Optional: Sets writer configuration properties. For writer configuration properties (and other supported MIME types), see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats">Supported Data Formats</a>.</p></td></tr></tbody></table>

### Example

This example writes the string `world` in plain text (`text/plain"`). It outputs that string as the
value of a JSON object with the key `hello`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ hello : write("world", "text/plain") }
```

#### Output

```JSON
{ "hello": "world" }
```

### Example

This example takes JSON input and writes the payload to a CSV format that uses a pipe (`|`)
separator and includes the header (matching keys in the JSON objects). Note that if you instead use
`"header":false` in your script, the output will lack the `Name|Email|Id|Title` header in the
output.

#### Source

```DataWeave
%dw 2.0
output application/xml
---
{ "output" : write(payload, "application/csv", {"header":true, "separator" : "|"}) }
```

#### Input

```JSON
[
  {
    "Name": "Mr White",
    "Email": "white@mulesoft.com",
    "Id": "1234",
    "Title": "Chief Java Prophet"
  },
  {
    "Name": "Mr Orange",
    "Email": "orange@mulesoft.com",
    "Id": "4567",
    "Title": "Integration Ninja"
  }
]
```

#### Output

```XML
<?xml version="1.0" encoding="US-ASCII"?>
<output>Name|Email|Id|Title
Mr White|white@mulesoft.com|1234|Chief Java Prophet
Mr Orange|orange@mulesoft.com|4567|Integration Ninja
</output>
```

<!-- document id=b7c2e695a05610329e00de4ca54cca582a073265a07bfbb90822c6ae507a2b0a url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-write.md -->

---
product: DataWeave
version: 2.4
---

# write

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## write(value: Any, contentType: String = "application/dw", writerProperties: Object = {}): String | Binary

Writes a value as a string or binary in a supported format.

Returns a String or Binary with the serialized representation of the value in the specified format
(MIME type). This function can write to a different format than the input. Note that the data must
validate in that new format, or an error will occur. For example, `application/xml` content is not
valid within an `application/json` format, but `text/plain` can be valid. It returns a `String`
value for all text-based data formats (such as XML, JSON , CSV) and a `Binary` value for all the
binary formats (such as Excel, MultiPart, OctetStream).

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The value to write. The value can be of any supported data type.</p></td></tr><tr><td><p><code>contentType</code></p></td><td><p>A supported format (or MIME type) to write. Default: <code>application/dw</code>.</p></td></tr><tr><td><p><code>writerProperties</code></p></td><td><p>Optional: Sets writer configuration properties. For writer configuration properties (and other supported MIME types), see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats">Supported Data Formats</a>.</p></td></tr></tbody></table>

### Example

This example writes the string `world` in plain text (`text/plain"`). It outputs that string as the
value of a JSON object with the key `hello`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ hello : write("world", "text/plain") }
```

#### Output

```JSON
{ "hello": "world" }
```

### Example

This example takes JSON input and writes the payload to a CSV format that uses a pipe (`|`)
separator and includes the header (matching keys in the JSON objects). Note that if you instead use
`"header":false` in your script, the output will lack the `Name|Email|Id|Title` header in the
output.

#### Source

```DataWeave
%dw 2.0
output application/xml
---
{ "output" : write(payload, "application/csv", {"header":true, "separator" : "|"}) }
```

#### Input

```JSON
[
  {
    "Name": "Mr White",
    "Email": "white@mulesoft.com",
    "Id": "1234",
    "Title": "Chief Java Prophet"
  },
  {
    "Name": "Mr Orange",
    "Email": "orange@mulesoft.com",
    "Id": "4567",
    "Title": "Integration Ninja"
  }
]
```

#### Output

```XML
<?xml version="1.0" encoding="US-ASCII"?>
<output>Name|Email|Id|Title
Mr White|white@mulesoft.com|1234|Chief Java Prophet
Mr Orange|orange@mulesoft.com|4567|Integration Ninja
</output>
```

<!-- document id=5b4d4d5fceb86d383311c102e5d2b05e38eb8e5b2f4c9004ce6439fdb3ecb819 url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-write.md -->

---
product: DataWeave
version: 2.6
---

# write

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## write(value: Any, contentType: String = "application/dw", writerProperties: Object = {}): String | Binary

Writes a value as a string or binary in a supported format.

Returns a String or Binary with the serialized representation of the value in the specified format
(MIME type). This function can write to a different format than the input. Note that the data must
validate in that new format, or an error will occur. For example, `application/xml` content is not
valid within an `application/json` format, but `text/plain` can be valid. It returns a `String`
value for all text-based data formats (such as XML, JSON , CSV) and a `Binary` value for all the
binary formats (such as Excel, MultiPart, OctetStream).

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The value to write. The value can be of any supported data type.</p></td></tr><tr><td><p><code>contentType</code></p></td><td><p>A supported format (or MIME type) to write. Default: <code>application/dw</code>.</p></td></tr><tr><td><p><code>writerProperties</code></p></td><td><p>Optional: Sets writer configuration properties. For writer configuration properties (and other supported MIME types), see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats">Supported Data Formats</a>.</p></td></tr></tbody></table>

### Example

This example writes the string `world` in plain text (`text/plain"`). It outputs that string as the
value of a JSON object with the key `hello`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ hello : write("world", "text/plain") }
```

#### Output

```JSON
{ "hello": "world" }
```

### Example

This example takes JSON input and writes the payload to a CSV format that uses a pipe (`|`)
separator and includes the header (matching keys in the JSON objects). Note that if you instead use
`"header":false` in your script, the output will lack the `Name|Email|Id|Title` header in the
output.

#### Source

```DataWeave
%dw 2.0
output application/xml
---
{ "output" : write(payload, "application/csv", {"header":true, "separator" : "|"}) }
```

#### Input

```JSON
[
  {
    "Name": "Mr White",
    "Email": "white@mulesoft.com",
    "Id": "1234",
    "Title": "Chief Java Prophet"
  },
  {
    "Name": "Mr Orange",
    "Email": "orange@mulesoft.com",
    "Id": "4567",
    "Title": "Integration Ninja"
  }
]
```

#### Output

```XML
<?xml version="1.0" encoding="US-ASCII"?>
<output>Name|Email|Id|Title
Mr White|white@mulesoft.com|1234|Chief Java Prophet
Mr Orange|orange@mulesoft.com|4567|Integration Ninja
</output>
```

<!-- document id=2a2c577e3c73dfc8e34ea1c00d73376d99f547b716fd53d562f774d419107a14 url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-write.md -->

---
product: DataWeave
version: 2.9
---

# write

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## write(value: Any, contentType: String = "application/dw", writerProperties: Object = {}): String | Binary

Writes a value as a string or binary in a supported format.

Returns a String or Binary with the serialized representation of the value in the specified format
(MIME type). This function can write to a different format than the input. Note that the data must
validate in that new format, or an error will occur. For example, `application/xml` content is not
valid within an `application/json` format, but `text/plain` can be valid. It returns a `String`
value for all text-based data formats (such as XML, JSON , CSV) and a `Binary` value for all the
binary formats (such as Excel, MultiPart, OctetStream).

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The value to write. The value can be of any supported data type.</p></td></tr><tr><td><p><code>contentType</code></p></td><td><p>A supported format (or MIME type) to write. Default: <code>application/dw</code>.</p></td></tr><tr><td><p><code>writerProperties</code></p></td><td><p>Optional: Sets writer configuration properties. For writer configuration properties (and other supported MIME types), see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats">Supported Data Formats</a>.</p></td></tr></tbody></table>

### Example

This example writes the string `world` in plain text (`text/plain"`). It outputs that string as the
value of a JSON object with the key `hello`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ hello : write("world", "text/plain") }
```

#### Output

```JSON
{ "hello": "world" }
```

### Example

This example takes JSON input and writes the payload to a CSV format that uses a pipe (`|`)
separator and includes the header (matching keys in the JSON objects). Note that if you instead use
`"header":false` in your script, the output will lack the `Name|Email|Id|Title` header in the
output.

#### Source

```DataWeave
%dw 2.0
output application/xml
---
{ "output" : write(payload, "application/csv", {"header":true, "separator" : "|"}) }
```

#### Input

```JSON
[
  {
    "Name": "Mr White",
    "Email": "white@mulesoft.com",
    "Id": "1234",
    "Title": "Chief Java Prophet"
  },
  {
    "Name": "Mr Orange",
    "Email": "orange@mulesoft.com",
    "Id": "4567",
    "Title": "Integration Ninja"
  }
]
```

#### Output

```XML
<?xml version="1.0" encoding="US-ASCII"?>
<output>Name|Email|Id|Title
Mr White|white@mulesoft.com|1234|Chief Java Prophet
Mr Orange|orange@mulesoft.com|4567|Integration Ninja
</output>
```

<!-- document id=0cc16cda49a21a6585057cbbdbbc25eb7109b08bc1bc568db390b5cf9bf7c088 url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-write.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# write

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## write(value: Any, contentType: String = "application/dw", writerProperties: Object = {}): String | Binary

Writes a value as a string or binary in a supported format.

Returns a String or Binary with the serialized representation of the value in the specified format
(MIME type). This function can write to a different format than the input. Note that the data must
validate in that new format, or an error will occur. For example, `application/xml` content is not
valid within an `application/json` format, but `text/plain` can be valid. It returns a `String`
value for all text-based data formats (such as XML, JSON , CSV) and a `Binary` value for all the
binary formats (such as Excel, MultiPart, OctetStream).

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>value</code></p></td><td><p>The value to write. The value can be of any supported data type.</p></td></tr><tr><td><p><code>contentType</code></p></td><td><p>A supported format (or MIME type) to write. Default: <code>application/dw</code>.</p></td></tr><tr><td><p><code>writerProperties</code></p></td><td><p>Optional: Sets writer configuration properties. For writer configuration properties (and other supported MIME types), see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats">Supported Data Formats</a>.</p></td></tr></tbody></table>

### Example

This example writes the string `world` in plain text (`text/plain"`). It outputs that string as the
value of a JSON object with the key `hello`.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{ hello : write("world", "text/plain") }
```

#### Output

```JSON
{ "hello": "world" }
```

### Example

This example takes JSON input and writes the payload to a CSV format that uses a pipe (`|`)
separator and includes the header (matching keys in the JSON objects). Note that if you instead use
`"header":false` in your script, the output will lack the `Name|Email|Id|Title` header in the
output.

#### Source

```DataWeave
%dw 2.0
output application/xml
---
{ "output" : write(payload, "application/csv", {"header":true, "separator" : "|"}) }
```

#### Input

```JSON
[
  {
    "Name": "Mr White",
    "Email": "white@mulesoft.com",
    "Id": "1234",
    "Title": "Chief Java Prophet"
  },
  {
    "Name": "Mr Orange",
    "Email": "orange@mulesoft.com",
    "Id": "4567",
    "Title": "Integration Ninja"
  }
]
```

#### Output

```XML
<?xml version="1.0" encoding="US-ASCII"?>
<output>Name|Email|Id|Title
Mr White|white@mulesoft.com|1234|Chief Java Prophet
Mr Orange|orange@mulesoft.com|4567|Integration Ninja
</output>
```

<!-- document id=51cbe1173396386dd1497442c768e0a34e8193fd7031a5445e0af0c86039a7ed url=/mulesoft/current/en-us/dataweave/2.11/dw-binaries-functions-writelineswith.md -->

---
product: DataWeave
version: 2.11
---

# writeLinesWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## writeLinesWith(content: Array<String>, charset: String): Binary

Writes the specified lines and returns the binary content.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>Array of items to write.</p></td></tr><tr><td><p><code>charset</code></p></td><td><p>String representing the encoding to use when writing.</p></td></tr></tbody></table>

### Example

This example inserts a new line (`\n`) after each iteration. Specifically, it uses `map` to iterate
over the result of `to(1, 10)`, `[1,2,3,4,5]`, then writes the specified content ("Line
$"), which includes the unnamed variable `$` for each number in the array.

Note that without `writeLinesWith "UTF-8"`, the expression `{ lines: to(1, 10) map "Line $" }`
simply returns an array of line numbers as the value of an object:
`{ "lines": [ "line 1", "line 2", "line 3", "line 4", "line 5" ] }`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Binaries
output application/json
---
{ lines: to(1, 10) map "Line $" writeLinesWith  "UTF-8" }
```

#### Output

```JSON
{
  "lines": "Line 1\nLine 2\nLine 3\nLine 4\nLine 5\n"
}
```

<!-- document id=6889a5b99f8c409f194997bac36e37b8337fddc57196ee3843f277379490d150 url=/mulesoft/current/en-us/dataweave/2.12/dw-binaries-functions-writelineswith.md -->

---
product: DataWeave
version: 2.12
---

# writeLinesWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## writeLinesWith(content: Array<String>, charset: String): Binary

Writes the specified lines and returns the binary content.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>Array of items to write.</p></td></tr><tr><td><p><code>charset</code></p></td><td><p>String representing the encoding to use when writing.</p></td></tr></tbody></table>

### Example

This example inserts a new line (`\n`) after each iteration. Specifically, it uses `map` to iterate
over the result of `to(1, 10)`, `[1,2,3,4,5]`, then writes the specified content ("Line
$"), which includes the unnamed variable `$` for each number in the array.

Note that without `writeLinesWith "UTF-8"`, the expression `{ lines: to(1, 10) map "Line $" }`
simply returns an array of line numbers as the value of an object:
`{ "lines": [ "line 1", "line 2", "line 3", "line 4", "line 5" ] }`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Binaries
output application/json
---
{ lines: to(1, 10) map "Line $" writeLinesWith  "UTF-8" }
```

#### Output

```JSON
{
  "lines": "Line 1\nLine 2\nLine 3\nLine 4\nLine 5\n"
}
```

<!-- document id=20f7c497b55c5799524b092a0695832f005651a279f736cdd67d5c1e492bf2af url=/mulesoft/current/en-us/dataweave/2.3/dw-binaries-functions-writelineswith.md -->

---
product: DataWeave
version: 2.3
---

# writeLinesWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## writeLinesWith(Array<String>, String): Binary

Writes the specified lines and returns the binary content.

_Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>Array of items to write.</p></td></tr><tr><td><p><code>charset</code></p></td><td><p>String representing the encoding to use when writing.</p></td></tr></tbody></table>

### Example

This example inserts a new line (`\n`) after each iteration. Specifically, it uses `map` to iterate
over the result of `to(1, 10)`, `[1,2,3,4,5]`, then writes the specified content ("Line
$"), which includes the unnamed variable `$` for each number in the array.

Note that without `writeLinesWith "UTF-8"`, the expression `{ lines: to(1, 10) map "Line $" }`
simply returns an array of line numbers as the value of an object:
`{ "lines": [ "line 1", "line 2", "line 3", "line 4", "line 5" ] }`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Binaries
output application/json
---
{ lines: to(1, 10) map "Line $" writeLinesWith  "UTF-8" }
```

#### Output

```JSON
{
  "lines": "Line 1\nLine 2\nLine 3\nLine 4\nLine 5\n"
}
```

<!-- document id=b2c331bb5365232047402a50f9305294650c090af54d818e902d6aed5bd3e078 url=/mulesoft/current/en-us/dataweave/2.4/dw-binaries-functions-writelineswith.md -->

---
product: DataWeave
version: 2.4
---

# writeLinesWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## writeLinesWith(content: Array<String>, charset: String): Binary

Writes the specified lines and returns the binary content.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>Array of items to write.</p></td></tr><tr><td><p><code>charset</code></p></td><td><p>String representing the encoding to use when writing.</p></td></tr></tbody></table>

### Example

This example inserts a new line (`\n`) after each iteration. Specifically, it uses `map` to iterate
over the result of `to(1, 10)`, `[1,2,3,4,5]`, then writes the specified content ("Line
$"), which includes the unnamed variable `$` for each number in the array.

Note that without `writeLinesWith "UTF-8"`, the expression `{ lines: to(1, 10) map "Line $" }`
simply returns an array of line numbers as the value of an object:
`{ "lines": [ "line 1", "line 2", "line 3", "line 4", "line 5" ] }`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Binaries
output application/json
---
{ lines: to(1, 10) map "Line $" writeLinesWith  "UTF-8" }
```

#### Output

```JSON
{
  "lines": "Line 1\nLine 2\nLine 3\nLine 4\nLine 5\n"
}
```

<!-- document id=f7a717ec4f973c7ee8bdfb0b42d01dba171909d5417ab97ebed0c463b3d924bd url=/mulesoft/current/en-us/dataweave/2.6/dw-binaries-functions-writelineswith.md -->

---
product: DataWeave
version: 2.6
---

# writeLinesWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## writeLinesWith(content: Array<String>, charset: String): Binary

Writes the specified lines and returns the binary content.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>Array of items to write.</p></td></tr><tr><td><p><code>charset</code></p></td><td><p>String representing the encoding to use when writing.</p></td></tr></tbody></table>

### Example

This example inserts a new line (`\n`) after each iteration. Specifically, it uses `map` to iterate
over the result of `to(1, 10)`, `[1,2,3,4,5]`, then writes the specified content ("Line
$"), which includes the unnamed variable `$` for each number in the array.

Note that without `writeLinesWith "UTF-8"`, the expression `{ lines: to(1, 10) map "Line $" }`
simply returns an array of line numbers as the value of an object:
`{ "lines": [ "line 1", "line 2", "line 3", "line 4", "line 5" ] }`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Binaries
output application/json
---
{ lines: to(1, 10) map "Line $" writeLinesWith  "UTF-8" }
```

#### Output

```JSON
{
  "lines": "Line 1\nLine 2\nLine 3\nLine 4\nLine 5\n"
}
```

<!-- document id=c35ab0de145fc9dcbee09f43745fb53665f5793ba45889e1b2e537a19f6e651f url=/mulesoft/current/en-us/dataweave/2.9/dw-binaries-functions-writelineswith.md -->

---
product: DataWeave
version: 2.9
---

# writeLinesWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## writeLinesWith(content: Array<String>, charset: String): Binary

Writes the specified lines and returns the binary content.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>Array of items to write.</p></td></tr><tr><td><p><code>charset</code></p></td><td><p>String representing the encoding to use when writing.</p></td></tr></tbody></table>

### Example

This example inserts a new line (`\n`) after each iteration. Specifically, it uses `map` to iterate
over the result of `to(1, 10)`, `[1,2,3,4,5]`, then writes the specified content ("Line
$"), which includes the unnamed variable `$` for each number in the array.

Note that without `writeLinesWith "UTF-8"`, the expression `{ lines: to(1, 10) map "Line $" }`
simply returns an array of line numbers as the value of an object:
`{ "lines": [ "line 1", "line 2", "line 3", "line 4", "line 5" ] }`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Binaries
output application/json
---
{ lines: to(1, 10) map "Line $" writeLinesWith  "UTF-8" }
```

#### Output

```JSON
{
  "lines": "Line 1\nLine 2\nLine 3\nLine 4\nLine 5\n"
}
```

<!-- document id=021c716d2b1e079a84984674457ba80b9b2294c542bc4a4698c1fd4e3dc28bf2 url=/mulesoft/current/en-us/dataweave/latest/dw-binaries-functions-writelineswith.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# writeLinesWith

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## writeLinesWith(content: Array<String>, charset: String): Binary

Writes the specified lines and returns the binary content.

_Introduced in DataWeave version 2.2.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>content</code></p></td><td><p>Array of items to write.</p></td></tr><tr><td><p><code>charset</code></p></td><td><p>String representing the encoding to use when writing.</p></td></tr></tbody></table>

### Example

This example inserts a new line (`\n`) after each iteration. Specifically, it uses `map` to iterate
over the result of `to(1, 10)`, `[1,2,3,4,5]`, then writes the specified content ("Line
$"), which includes the unnamed variable `$` for each number in the array.

Note that without `writeLinesWith "UTF-8"`, the expression `{ lines: to(1, 10) map "Line $" }`
simply returns an array of line numbers as the value of an object:
`{ "lines": [ "line 1", "line 2", "line 3", "line 4", "line 5" ] }`.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Binaries
output application/json
---
{ lines: to(1, 10) map "Line $" writeLinesWith  "UTF-8" }
```

#### Output

```JSON
{
  "lines": "Line 1\nLine 2\nLine 3\nLine 4\nLine 5\n"
}
```

<!-- document id=9e4e91c672a1034cd4755f5876353117bc368df4522ae5f8788de06799315046 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-formats-xml.md -->

---
product: DataWeave
version: 2.11
keywords: format, xml, */xml, */*+xml, application/xml
---

# XML Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/xml`

ID: `xml`

The XML data structure is mapped to DataWeave objects that can contain other objects, strings, or
`null` values. XML uses unbounded elements to represent collections, which are mapped to repeated
keys in DataWeave objects. In addition, DataWeave natively supports `namespaces`, `CData` an
`xsi:types`.

The DataWeave reader for XML input supports the following parsing strategies:

- Indexed

- In-Memory

- Streaming

To understand the parsing strategies that DataWeave readers and writers can apply to this format,
see [DataWeave Parsing Strategies](https://docs.mulesoft.com/dataweave/2.11/dataweave-formats#dw_readers_writers).

## `CData` Custom Type

`CData` is a custom DataWeave data type for XML that is used to identify a character data (CDATA)
block. The `CData` type makes the XML writer wrap content inside a `CDATA` block or to check for an
input string inside a `CDATA` block. In DataWeave, `CData` inherits from the type `String`.

## `DocType` Custom Type

`DocType` is a custom DataWeave data type for XML that is used to identify a doctype declaration
(DTD).

## Read and Write DTDs

_Introduced in DataWeave 2.5.0. Supported by Mule 4.5.0 and later._

DataWeave can read and write doctype declarations in XML files.

During the reading phase, DataWeave parses the doctype declarations and stores the content as
metadata of the root element. The `DocType` value is stored in the `docType` variable. You can use
the [metadata selector](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors) (`^`) to
extract the value of that variable with an expression like this one:

- `payload.^docType`

  See examples [Example: Read DTD value](#example12), [Example: Write a DTD Value](#example13), and
  [Example: Transform DTD Value to a String Representation](#example14).

  NOTE

  DTDs are disabled by default even if their declarations are read or written. For details, see XML
  reader property `supportDtd` in [Reader Properties](#reader_properties).

## Examples

The following examples show uses of the XML format.

- [Example: Stream Input XML Data](#example1)

- [Example: Null or Empty String in XML](#example2)

- [Example: Output `null` Values for Missing XML Values](#example3)

- [Example: Output `null` Values for Missing XML Values](#example4)

- [Example: Represent XML Attributes in the DataWeave (dw) Format](#example5)

- [Example: Represent XML Namespaces in the DataWeave (dw) Format](#example6)

- [Example: Create a CDATA Element](#example7)

- [Example: Check for CDATA in a `String`](#example8)

- [Example: Use the `inlineCloseOn` Writer Property](#example9)

- [Example: Transforms Repeated JSON Keys to Repeated XML Elements](#example10)

- [Example: Transform XML Elements to JSON and Replace Characters](#example11)

- [Example: Read DTD value](#example12)

- [Example: Write a DTD Value](#example13)

- [Example: Transform DTD Value to a String Representation](#example14)

Refer to [DataWeave Formats](https://docs.mulesoft.com/dataweave/2.11/dataweave-formats) for more detail on available reader and writer
properties for various data formats.

### Example: Stream Input XML Data

This example shows how to set up XML streaming, which requires you to specify the following reader
properties:

- `streaming=true`

- `collectionPath="root.repeated"`

The `collectionPath` setting selects the elements to stream.

When streaming, the XML parser can start processing content without having all the XML content.

#### Input

The following XML serves as the input payload to the DataWeave source. Assume that it is the content
of an XML file `myXML.xml`.

myXML.xml

```xml
<root>
    <text>
        Text
    </text>
    <repeated>
        <user>
            <name>Mariano</name>
            <lastName>de Achaval</lastName>
            <age>36</age>
        </user>
        <user>
            <lastName>Shokida</lastName>
            <name>Leandro</name>
            <age>30</age>
        </user>
        <user>
            <age>29</age>
            <name>Ana</name>
            <lastName>Felissati</lastName>

        </user>
        <user>
            <age>29</age>
            <lastName>Chibana</lastName>
            <name>Christian</name>
        </user>

    </repeated>
</root>
```

#### Source

The reader property settings in the DataWeave script tell the XML reader to stream the input and
process the repeated keys. The script uses the DataWeave `map` function to iterate over the repeated
keys.

```dataweave
%dw 2.0
var myInput  readUrl('classpath://myXML.xml', 'application/xml', {streaming:true, collectionPath: "root.repeated"})
output application/dw
---
myInput.root.repeated.*user map {
    n: $.name,
    l: $.lastName,
    a: $.age
}
```

#### Output

The script transforms the mapped input XML to the DataWeave (dw) format and MIME type.

```json
[
  {
    "n": "Mariano",
    "l": "de Achaval",
    "a": "36"
  },
  {
    "n": "Leandro",
    "l": "Shokida",
    "a": "30"
  },
  {
    "n": "Ana",
    "l": "Felissati",
    "a": "29"
  },
  {
    "n": "Christian",
    "l": "Chibana",
    "a": "29"
  }
]
```

### Example: Null or Empty String in XML

Because there is no standard way to represent a `null` value in XML, the reader maps the value to
`null` when the `nil` attribute is set to `true`.

#### Input

The following XML serves as the input payload to the DataWeave source. Notice the `nil` setting in
`<xsi:nil="true"`/>.

```xml
<book xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <author xsi:nil="true"/>
</book>
```

#### Source

The DataWeave script transforms the input XML to the JSON format and MIME type.

```dataweave
%dw 2.0
output application/json
---
payload
```

#### Output

The output is in the JSON format. Notice that the `nil` value in the input is transformed to `null`.

```json
{
  "book": {
    "author": null
  }
}
```

### Example: Output `null` Values for Missing XML Values

The XML reader property `nullValueOn` accepts the value `blank` (the default) or `empty`.

This example uses the `nullValueOn` default, so it maps the values of the `title` and `author`
elements to `null`.

#### Input

The following XML serves as input to the DataWeave source. Notice that the `title` and `author`
elements lack values.

Assume that this input is content within the file, `myInput.xml`.

myXML.xml content:

```xml
<book>
    <author></author>
    <title>

</title>
</book>
```

#### Source

The DataWeave script transforms the XML input to JSON. Note that it explicitly sets the
`nullValueOn` default, `blank`, for demonstration purposes.

```dataweave
%dw 2.0
var myInput readUrl('classpath://myXML.xml', 'application/xml', {nullValueOn: "blank"})
output application/json
---
myInput
```

#### Output

The `title` and `author` keys in the JSON output are assigned `null` values.

```json
{
  "book": {
    "author": null,
    "title": null
  }
}
```

### Example: Output `null` Values for Missing XML Values

The XML reader property `nullValueOn` accepts the value `blank` (the default) or `empty`.

The example maps the value of the `title` element to a `String` and value of the `author` element to
`null` because the XML reader property `nullValueOn` is set to `empty`.

#### Input

The following XML serves as input to the DataWeave source. Notice that the `title` and `author`
elements lack values. The difference between the two elements is the space between the starting and
ending tags. The tags of the `title` element are separated by line breaks (the hidden characters,
`\n`), while the tags of the `author` element are not separated by any characters.

Assume that this input is content within the file, `myInput.xml`.

myXML.xml content:

```xml
<book>
    <author></author>
    <title>

</title>
</book>
```

#### Source

The DataWeave script uses a DataWeave variable to input the content of `myXML.xml` and applies the
`nullValueOn: "empty"` to it. The script transforms the XML input to JSON.

```dataweave
%dw 2.0
var myInput readUrl('classpath://myXML.xml', 'application/xml', {nullValueOn: "empty"})
output application/json
---
myInput
```

#### Output

The JSON output maps the value of the `author` element to `null` and value of the `title` element to
the `String` value `"\n\n"`, which is for the new line characters.

```json
{
  "book": {
    "author": null,
    "title": "\n\n"
  }
}
```

### Example: Represent XML Attributes in the DataWeave (dw) Format

This example maps XML attributes to a canonical DataWeave representation, the `application/dw`
format and MIME type.

#### Input

The XML serves as the input payload to the DataWeave source. Notice that the input contains XML
attributes.

```xml
<users>
  <company>MuleSoft</company>
  <user name="Leandro" lastName="Shokida"/>
  <user name="Mariano" lastName="Achaval"/>
</users>
```

#### Source

The DataWeave script transforms the XML input payload to the DataWeave (dw) format and MIME type.

```dataweave
%dw 2.0
output application/dw
---
payload
```

#### Output

The output shows how the DataWeave (dw) format represents the XML input. Notice how the attributes
from the XML input and the empty values are represented.

```dataweave
{
  users: {
    company: "MuleSoft",
    user @(name: "Leandro",lastName: "Shokida"): "",
    user @(name: "Mariano",lastName: "Achaval"): ""
  }
}
```

### Example: Represent XML Namespaces in the DataWeave (dw) Format

This example maps XML namespaces to a canonical DataWeave representation, the `application/dw`
format and MIME type.

#### Input

The XML serves as the input payload to the DataWeave source. Notice that the input contains XML
namespaces.

```xml
<root>
    <h:table xmlns:h="http://www.w3.org/TR/html4/">
      <h:tr>
        <h:td>Apples</h:td>
        <h:td>Bananas</h:td>
      </h:tr>
    </h:table>

    <f:table xmlns:f="https://www.w3schools.com/furniture">
      <f:name>African Coffee Table</f:name>
      <f:width>80</f:width>
      <f:length>120</f:length>
    </f:table>
</root>
```

#### Source

The DataWeave script transforms the XML input payload to the DataWeave (dw) format and MIME type.

```dataweave
%dw 2.0
output application/dw
---
payload
```

#### Output

The output shows how the DataWeave (dw) format represents the XML input. Notice how the namespaces
from the XML are represented.

```dataweave
ns h http://www.w3.org/TR/html4/
ns f https://www.w3schools.com/furniture
---
{
  root: {
      h#table: {
        h#tr: {
          h#td: "Apples",
          h#td: "Bananas"
        }
      },
      f#table: {
        f#name: "African Coffee Table",
        f#width: "80",
        f#length: "120"
      }
  }
}
```

### Example: Create a CDATA Element

This example shows how to use the `CData` type to create a CDATA element in the XML output.

#### Source

The body of the DataWeave script coerces the `String` value to the `CData` type.

```dataweave
%dw 2.0
output application/xml
---
{
    test: "A text <a>" as CData
}
```

#### Output

The output encloses the input `String` value in a CDATA block, which contains the special
characters, `<` and `>`, from the input.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<test><![CDATA[A text <a>]]></test>
```

### Example: Check for CDATA in a `String`

This example indicates whether a given `String` value is CDATA.

#### Input

The XML serves as the input payload to the DataWeave source. Notice that the `test` element contains
a CDATA block.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<test><![CDATA[A text <a>]]></test>
```

#### Source

The DataWeave script uses the `is CData` expression to determine whether the `String` value is
CDATA.

```dataweave
%dw 2.0
output application/json
---
{
    test: payload.test is CDATA
}
```

#### Output

The JSON output contains the value `true`, which indicates tha the input `String` value is CDATA.

```json
{
  "test": true
}
```

### Example: Use the `inlineCloseOn` Writer Property

This example uses the `inlineCloseOn` writer property with the value `none` to act on the key-value
pairs from the input.

#### Source

The DataWeave script transforms the body content to XML. Notice that values of the `emptyElement`
keys are `null`.

```dataweave
%dw 2.0
output application/xml inlineCloseOn="none"
---
{
  someXml: {
    parentElement: {
      emptyElement1: null,
      emptyElement2: null,
      emptyElement3: null
    }
  }
}
```

#### Output

The `emptyElement` elements are empty. They do not contain the value `null`.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<someXml>
  <parentElement>
    <emptyElement1></emptyElement1>
    <emptyElement2></emptyElement2>
    <emptyElement3></emptyElement3>
  </parentElement>
</someXml>
```

### Example: Transforms Repeated JSON Keys to Repeated XML Elements

XML encodes collections using repeated (unbounded) elements. DataWeave represents unbounded elements
by repeating the same key.

This example shows how to convert the repeated keys in a JSON array of objects into repeated XML
elements.

#### Input

The JSON input serves as the payload to the DataWeave source. Notice that the `name` keys in the
array are repeated.

```json
{
  "friends": [{ "name": "Mariano" }, { "name": "Shoki" }, { "name": "Tomo" }, { "name": "Ana" }]
}
```

#### Source

The DataWeave script selects the value of the `friends` key.

```dataweave
%dw 2.0
output application/xml
---
friends: {
    (payload.friends)
}
```

#### Output

The output represents the `name` keys as XML elements.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<friends>
  <name>Mariano</name>
  <name>Shoki</name>
  <name>Tomo</name>
  <name>Ana</name>
</friends>
```

See also,
[Example: Outputting Self-closing XML Tags](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-output-self-closing-xml-tags).

### Example: Transform XML Elements to JSON and Replace Characters

This example iterates over an XML file that contains details of employees, such as the `Id`, `Name`,
and `Address`, and converts the file into JSON format. The DataWeave script uses the `replace`
function to iterate over each `Address` element and replace the characters `-` and `/` with blank
space.

#### Input

The XML input serves as the payload to the DataWeave source. Notice that the `Address` element
contains `-` and `/` characters.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<root>
  <employees>
    <Id>1</Id>
    <Name>Mule</Name>
    <Address>MuleSoft Avenue - 123</Address>
  </employees>
  <employees>
    <Id>2</Id>
    <Name>Max</Name>
    <Address>MuleSoft Avenue-456/5/e</Address>
  </employees>
</root>
```

#### Source

The following DataWeave script iterates over the payload elements and performs a mapping to an
object. The instruction `payload01.Address replace /([\-\,\/])/ with " "` replaces the `-` and `/`
characters with blank spaces.

```dataweave
%dw 2.0
output application/json
---
payload.root.*employees map ((payload01 , indexOfPayload01) ->
  {
     Id: payload01.Id as String,
     Name: payload01.Name as String,
     Address: payload01.Address replace /([\-\,\/])/ with " "
  }
)
```

#### Output

The output represents the transformed XML elements into JSON.

```JSON
[
  {
    "Id": "1",
    "Name": "Mule",
    "Address": "MuleSoft Avenue   123"
  },
  {
    "Id": "2",
    "Name": "Max",
    "Address": "MuleSoft Avenue 456 5 e"
  }
]
```

### Example: Read DTD value

The following DataWeave script transforms the XML input payload that contains a `DocType` value into
JSON. Notice that extracts the value of that doctype directive using the expression
`payload.^docType`.

#### Input

```xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE cXML SYSTEM "http://xml.cxml.org/schemas/cXML/1.2.014/cXML.dtd">
<cXML xml:lang="en-US" payloadID="1615232861.000506@prd327utl1.int.coupahost.com" timestamp="2021-03-08T11:47:42-08:00">
    <Header>
        <From>
            <Credential domain="NetworkID">
                <Identity>TestIdentity</Identity>
            </Credential>
        </From>
        <To>
            <Credential domain="TEST">
                <Identity>Identity</Identity>
            </Credential>
        </To>
    </Header>
</cXML>
```

#### Source

```dataweave
%dw 2.0
output application/json
---
{
    header: {
        senderId: payload.cXML.Header.From.Credential.Identity,
        receiverId: payload.cXML.Header.To.Credential.Identity,
        docType: payload.^docType
    }
}
```

#### Output

```json
{
  "header": {
    "senderId": "Identity",
    "receiverId": "TestIdentity",
    "docType": {
      "rootName": "cXML",
      "systemId": "http://xml.cxml.org/schemas/cXML/1.2.014/cXML.dtd"
    }
  }
}
```

### Example: Write a DTD Value

This example shows how to use the `docType` metadata to create a `DocType` value in the XML output.

#### Source

```dataweave
%dw 2.0
output application/xml
ns xml http://www.w3.org/XML/1998/namespace

var cXmlObj = {
  cXML @(payloadID: "9949494", xml#lang: "en-US", timestamp: "2002-02-04T18:39:09-08:00"): {
      Header: {
        From: {
          Credential @(domain: "NetworkId"): {
            Identity: "Identity"
          }
        }
    }
  }
} as Object {
    docType: { rootName: "cXML", systemId: "http://xml.cXML.org/schemas/cXML/1.2.014/cXML.dtd" }
}
---
cXmlObj
```

#### Output

```xml
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE cXML SYSTEM "http://xml.cXML.org/schemas/cXML/1.2.014/cXML.dtd">
<cXML payloadID="9949494" xml:lang="en-US" timestamp="2002-02-04T18:39:09-08:00">
  <Header>
    <From>
      <Credential domain="NetworkId">
        <Identity>Identity</Identity>
      </Credential>
    </From>
  </Header>
</cXML>
```

### Example: Transform DTD Value to a String Representation

This example uses [Dtd Module (dw::xml::Dtd)](https://docs.mulesoft.com/dataweave/2.11/dw-dtd) to transform a `DocType` value that includes a
`systemId` to a string representation.

#### Input

```xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE cXML SYSTEM "http://xml.cxml.org/schemas/cXML/1.2.014/cXML.dtd">
<cXML xml:lang="en-US" payloadID="1615232861.000506@prd327utl1.int.coupahost.com" timestamp="2021-03-08T11:47:42-08:00">
    <Header>
        <From>
            <Credential domain="NetworkID">
                <Identity>Identity</Identity>
            </Credential>
        </From>
        <To>
            <Credential domain="TEST">
                <Identity>Identity</Identity>
            </Credential>
        </To>
    </Header>
</cXML>
```

#### Source

```dataweave
%dw 2.0
output application/json
import * from dw::xml::Dtd
---
docTypeAsString(payload.^docType)
```

#### Output

```JSON
"cXML SYSTEM http://xml.cxml.org/schemas/cXML/1.2.014/cXML.dtd"
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>collectionPath</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Sets the path to the location in the document where the collection is located. Accepts a path expression that identifies the location of the elements to stream.</p></div></div></td></tr><tr><td><p><code>externalEntities</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Indicates whether to process external entities. Disabled by default to avoid XML External Entity (XXE) attacks.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>indexedReader</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Uses the indexed reader by default when reaching the threshold. Supports US-ASCII, UTF-8 and ISO-8859-1 encodings only. For other encodings, DataWeave uses the in-memory reader.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>maxAttributeSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>-1</code></p></td><td><div><div><p>Sets the maximum number of characters accepted in an XML attribute. <em>Available since Mule 4.2.1.</em></p></div></div></td></tr><tr><td><p><code>maxEntityCount</code></p></td><td><p><code>Number</code></p></td><td><p><code>1</code></p></td><td><div><div><p>Sets the maximum number of entity expansions. The limit helps avoid Billion Laughs attacks.</p></div></div></td></tr><tr><td><p><code>nullValueOn</code></p></td><td><p><code>String</code></p></td><td><p><code>'blank'</code></p></td><td><div><div><p>Indicates whether to read an element with empty or blank text as a <code>null</code> value.</p></div><div><p>Valid values are <code>empty</code> or <code>none</code> or <code>blank</code>.</p></div></div></td></tr><tr><td><p><code>optimizeFor</code></p></td><td><p><code>String</code></p></td><td><p><code>'speed'</code></p></td><td><div><div><p>Configures the type of optimization for the XML parser to use.</p></div><div><p>Valid values are <code>speed</code> or <code>memory</code>.</p></div></div></td></tr><tr><td><p><code>streaming</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Streams input when set to <code>true</code>. Use only if entries are accessed sequentially. The input must be a top-level array. See the <a href="#example2">streaming example</a>, and see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats#dw_readers_writers">DataWeave Readers</a>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>supportDtd</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Enable or disable DTD support. Disabling skips (and does not process) internal and external subsets. You can also enable this property by setting the Mule system property <code>com.mulesoft.dw.xml.supportDTD</code>. Note that the default for this property changed from <code>true</code> to <code>false</code> in Mule version 4.3.0-20210601, which includes the June 2021 patch of DataWeave version 2.3.0.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>defaultNamespace</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Specifies the default namespaces of the output XML.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>doubleQuoteInDeclaration</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Escapes double quotes in the XML declaration when set to <code>true</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr><tr><td><p><code>escapeCR</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Escapes <code>CR</code> characters when set to <code>true</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>escapeGT</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Escapes '&gt;' characters when set to <code>true</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>indent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Write indented output for better readability by default, or compress output into a single line when set to <code>false</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>inlineCloseOn</code></p></td><td><p><code>String</code></p></td><td><p><code>'empty'</code></p></td><td><div><div><p>Write an inline close tag, or explicitly open and close tags when the value is <code>null</code>.</p></div><div><p>Valid values are <code>empty</code> or <code>none</code>.</p></div></div></td></tr><tr><td><p><code>onInvalidChar</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Valid values are <code>base64</code> or <code>ignore</code> or <code>none</code>.</p></div></div></td></tr><tr><td><p><code>skipNullOn</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Skips <code>null</code> values in the specified data structure. By default, DataWeave does not skip the values.</p></div><div><ul><li><p><code>elements</code> + Ignore and omit <code>null</code> elements inside XML output, for example, with <code>output application/xml skipNullOn="arrays"</code>.</p></li><li><p><code>attributes ` + Ignore and omit `null</code> attributes inside XML, for example, with <code>output application/xml skipNullOn="objects"</code>.</p></li><li><p><code>everywhere</code> + Apply <code>skipNullOn</code> to elements and attributes, for example, <code>output application/xml skipNullOn="everywhere"</code>.</p></li></ul></div><div><p>Valid values are <code>elements</code> or <code>attributes</code> or <code>everywhere</code>.</p></div></div></td></tr><tr><td><p><code>writeDeclaration</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Writes the XML header declaration when set to <code>true</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>writeDeclaredNamespaces</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Marks the namespaces to declare in the root element of the XML:</p></div><div><ul><li><p><code>All</code>: Write all declared namespaces in the root element.</p></li><li><p><code>ids:&lt;comma separated namespace id&gt;</code>: Write only the specified namespaces.</p></li><li><p><code>regex:&lt;regex&gt;</code>: Write only the matching namespaces.</p></li></ul></div></div></td></tr><tr><td><p><code>writeNilOnNull</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Writes the <code>nil</code> attribute for a <code>null</code> value when this property is set to <code>true</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/xml</code></p></td></tr><tr><td><p><code><strong>/</strong>+xml</code></p></td></tr></tbody></table>

<!-- document id=d3f7cf38363445a8c2511d8bed9f10049251485fa9d9f553b38c1d44318de969 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-formats-xml.md -->

---
product: DataWeave
version: 2.12
keywords: format, xml, */xml, */*+xml, application/xml
---

# XML Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/xml`

ID: `xml`

The XML data structure is mapped to DataWeave objects that can contain other objects, strings, or
`null` values. XML uses unbounded elements to represent collections, which are mapped to repeated
keys in DataWeave objects. In addition, DataWeave natively supports `namespaces`, `CData` an
`xsi:types`.

The DataWeave reader for XML input supports the following parsing strategies:

- Indexed

- In-Memory

- Streaming

To understand the parsing strategies that DataWeave readers and writers can apply to this format,
see [DataWeave Parsing Strategies](https://docs.mulesoft.com/dataweave/2.12/dataweave-formats#dw_readers_writers).

## `CData` Custom Type

`CData` is a custom DataWeave data type for XML that is used to identify a character data (CDATA)
block. The `CData` type makes the XML writer wrap content inside a `CDATA` block or to check for an
input string inside a `CDATA` block. In DataWeave, `CData` inherits from the type `String`.

## `DocType` Custom Type

`DocType` is a custom DataWeave data type for XML that is used to identify a doctype declaration
(DTD).

## Read and Write DTDs

_Introduced in DataWeave 2.5.0. Supported by Mule 4.5.0 and later._

DataWeave can read and write doctype declarations in XML files.

During the reading phase, DataWeave parses the doctype declarations and stores the content as
metadata of the root element. The `DocType` value is stored in the `docType` variable. You can use
the [metadata selector](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors) (`^`) to
extract the value of that variable with an expression like this one:

- `payload.^docType`

  See examples [Example: Read DTD value](#example12), [Example: Write a DTD Value](#example13), and
  [Example: Transform DTD Value to a String Representation](#example14).

  NOTE

  DTDs are disabled by default even if their declarations are read or written. For details, see XML
  reader property `supportDtd` in [Reader Properties](#reader_properties).

## Examples

The following examples show uses of the XML format.

- [Example: Stream Input XML Data](#example1)

- [Example: Null or Empty String in XML](#example2)

- [Example: Output `null` Values for Missing XML Values](#example3)

- [Example: Output `null` Values for Missing XML Values](#example4)

- [Example: Represent XML Attributes in the DataWeave (dw) Format](#example5)

- [Example: Represent XML Namespaces in the DataWeave (dw) Format](#example6)

- [Example: Create a CDATA Element](#example7)

- [Example: Check for CDATA in a `String`](#example8)

- [Example: Use the `inlineCloseOn` Writer Property](#example9)

- [Example: Transforms Repeated JSON Keys to Repeated XML Elements](#example10)

- [Example: Transform XML Elements to JSON and Replace Characters](#example11)

- [Example: Read DTD value](#example12)

- [Example: Write a DTD Value](#example13)

- [Example: Transform DTD Value to a String Representation](#example14)

Refer to [DataWeave Formats](https://docs.mulesoft.com/dataweave/2.12/dataweave-formats) for more detail on available reader and writer
properties for various data formats.

### Example: Stream Input XML Data

This example shows how to set up XML streaming, which requires you to specify the following reader
properties:

- `streaming=true`

- `collectionPath="root.repeated"`

The `collectionPath` setting selects the elements to stream.

When streaming, the XML parser can start processing content without having all the XML content.

#### Input

The following XML serves as the input payload to the DataWeave source. Assume that it is the content
of an XML file `myXML.xml`.

myXML.xml

```xml
<root>
    <text>
        Text
    </text>
    <repeated>
        <user>
            <name>Mariano</name>
            <lastName>de Achaval</lastName>
            <age>36</age>
        </user>
        <user>
            <lastName>Shokida</lastName>
            <name>Leandro</name>
            <age>30</age>
        </user>
        <user>
            <age>29</age>
            <name>Ana</name>
            <lastName>Felissati</lastName>

        </user>
        <user>
            <age>29</age>
            <lastName>Chibana</lastName>
            <name>Christian</name>
        </user>

    </repeated>
</root>
```

#### Source

The reader property settings in the DataWeave script tell the XML reader to stream the input and
process the repeated keys. The script uses the DataWeave `map` function to iterate over the repeated
keys.

```dataweave
%dw 2.0
var myInput  readUrl('classpath://myXML.xml', 'application/xml', {streaming:true, collectionPath: "root.repeated"})
output application/dw
---
myInput.root.repeated.*user map {
    n: $.name,
    l: $.lastName,
    a: $.age
}
```

#### Output

The script transforms the mapped input XML to the DataWeave (dw) format and MIME type.

```json
[
  {
    "n": "Mariano",
    "l": "de Achaval",
    "a": "36"
  },
  {
    "n": "Leandro",
    "l": "Shokida",
    "a": "30"
  },
  {
    "n": "Ana",
    "l": "Felissati",
    "a": "29"
  },
  {
    "n": "Christian",
    "l": "Chibana",
    "a": "29"
  }
]
```

### Example: Null or Empty String in XML

Because there is no standard way to represent a `null` value in XML, the reader maps the value to
`null` when the `nil` attribute is set to `true`.

#### Input

The following XML serves as the input payload to the DataWeave source. Notice the `nil` setting in
`<xsi:nil="true"`/>.

```xml
<book xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <author xsi:nil="true"/>
</book>
```

#### Source

The DataWeave script transforms the input XML to the JSON format and MIME type.

```dataweave
%dw 2.0
output application/json
---
payload
```

#### Output

The output is in the JSON format. Notice that the `nil` value in the input is transformed to `null`.

```json
{
  "book": {
    "author": null
  }
}
```

### Example: Output `null` Values for Missing XML Values

The XML reader property `nullValueOn` accepts the value `blank` (the default) or `empty`.

This example uses the `nullValueOn` default, so it maps the values of the `title` and `author`
elements to `null`.

#### Input

The following XML serves as input to the DataWeave source. Notice that the `title` and `author`
elements lack values.

Assume that this input is content within the file, `myInput.xml`.

myXML.xml content:

```xml
<book>
    <author></author>
    <title>

</title>
</book>
```

#### Source

The DataWeave script transforms the XML input to JSON. Note that it explicitly sets the
`nullValueOn` default, `blank`, for demonstration purposes.

```dataweave
%dw 2.0
var myInput readUrl('classpath://myXML.xml', 'application/xml', {nullValueOn: "blank"})
output application/json
---
myInput
```

#### Output

The `title` and `author` keys in the JSON output are assigned `null` values.

```json
{
  "book": {
    "author": null,
    "title": null
  }
}
```

### Example: Output `null` Values for Missing XML Values

The XML reader property `nullValueOn` accepts the value `blank` (the default) or `empty`.

The example maps the value of the `title` element to a `String` and value of the `author` element to
`null` because the XML reader property `nullValueOn` is set to `empty`.

#### Input

The following XML serves as input to the DataWeave source. Notice that the `title` and `author`
elements lack values. The difference between the two elements is the space between the starting and
ending tags. The tags of the `title` element are separated by line breaks (the hidden characters,
`\n`), while the tags of the `author` element are not separated by any characters.

Assume that this input is content within the file, `myInput.xml`.

myXML.xml content:

```xml
<book>
    <author></author>
    <title>

</title>
</book>
```

#### Source

The DataWeave script uses a DataWeave variable to input the content of `myXML.xml` and applies the
`nullValueOn: "empty"` to it. The script transforms the XML input to JSON.

```dataweave
%dw 2.0
var myInput readUrl('classpath://myXML.xml', 'application/xml', {nullValueOn: "empty"})
output application/json
---
myInput
```

#### Output

The JSON output maps the value of the `author` element to `null` and value of the `title` element to
the `String` value `"\n\n"`, which is for the new line characters.

```json
{
  "book": {
    "author": null,
    "title": "\n\n"
  }
}
```

### Example: Represent XML Attributes in the DataWeave (dw) Format

This example maps XML attributes to a canonical DataWeave representation, the `application/dw`
format and MIME type.

#### Input

The XML serves as the input payload to the DataWeave source. Notice that the input contains XML
attributes.

```xml
<users>
  <company>MuleSoft</company>
  <user name="Leandro" lastName="Shokida"/>
  <user name="Mariano" lastName="Achaval"/>
</users>
```

#### Source

The DataWeave script transforms the XML input payload to the DataWeave (dw) format and MIME type.

```dataweave
%dw 2.0
output application/dw
---
payload
```

#### Output

The output shows how the DataWeave (dw) format represents the XML input. Notice how the attributes
from the XML input and the empty values are represented.

```dataweave
{
  users: {
    company: "MuleSoft",
    user @(name: "Leandro",lastName: "Shokida"): "",
    user @(name: "Mariano",lastName: "Achaval"): ""
  }
}
```

### Example: Represent XML Namespaces in the DataWeave (dw) Format

This example maps XML namespaces to a canonical DataWeave representation, the `application/dw`
format and MIME type.

#### Input

The XML serves as the input payload to the DataWeave source. Notice that the input contains XML
namespaces.

```xml
<root>
    <h:table xmlns:h="http://www.w3.org/TR/html4/">
      <h:tr>
        <h:td>Apples</h:td>
        <h:td>Bananas</h:td>
      </h:tr>
    </h:table>

    <f:table xmlns:f="https://www.w3schools.com/furniture">
      <f:name>African Coffee Table</f:name>
      <f:width>80</f:width>
      <f:length>120</f:length>
    </f:table>
</root>
```

#### Source

The DataWeave script transforms the XML input payload to the DataWeave (dw) format and MIME type.

```dataweave
%dw 2.0
output application/dw
---
payload
```

#### Output

The output shows how the DataWeave (dw) format represents the XML input. Notice how the namespaces
from the XML are represented.

```dataweave
ns h http://www.w3.org/TR/html4/
ns f https://www.w3schools.com/furniture
---
{
  root: {
      h#table: {
        h#tr: {
          h#td: "Apples",
          h#td: "Bananas"
        }
      },
      f#table: {
        f#name: "African Coffee Table",
        f#width: "80",
        f#length: "120"
      }
  }
}
```

### Example: Create a CDATA Element

This example shows how to use the `CData` type to create a CDATA element in the XML output.

#### Source

The body of the DataWeave script coerces the `String` value to the `CData` type.

```dataweave
%dw 2.0
output application/xml
---
{
    test: "A text <a>" as CData
}
```

#### Output

The output encloses the input `String` value in a CDATA block, which contains the special
characters, `<` and `>`, from the input.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<test><![CDATA[A text <a>]]></test>
```

### Example: Check for CDATA in a `String`

This example indicates whether a given `String` value is CDATA.

#### Input

The XML serves as the input payload to the DataWeave source. Notice that the `test` element contains
a CDATA block.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<test><![CDATA[A text <a>]]></test>
```

#### Source

The DataWeave script uses the `is CData` expression to determine whether the `String` value is
CDATA.

```dataweave
%dw 2.0
output application/json
---
{
    test: payload.test is CDATA
}
```

#### Output

The JSON output contains the value `true`, which indicates tha the input `String` value is CDATA.

```json
{
  "test": true
}
```

### Example: Use the `inlineCloseOn` Writer Property

This example uses the `inlineCloseOn` writer property with the value `none` to act on the key-value
pairs from the input.

#### Source

The DataWeave script transforms the body content to XML. Notice that values of the `emptyElement`
keys are `null`.

```dataweave
%dw 2.0
output application/xml inlineCloseOn="none"
---
{
  someXml: {
    parentElement: {
      emptyElement1: null,
      emptyElement2: null,
      emptyElement3: null
    }
  }
}
```

#### Output

The `emptyElement` elements are empty. They do not contain the value `null`.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<someXml>
  <parentElement>
    <emptyElement1></emptyElement1>
    <emptyElement2></emptyElement2>
    <emptyElement3></emptyElement3>
  </parentElement>
</someXml>
```

### Example: Transforms Repeated JSON Keys to Repeated XML Elements

XML encodes collections using repeated (unbounded) elements. DataWeave represents unbounded elements
by repeating the same key.

This example shows how to convert the repeated keys in a JSON array of objects into repeated XML
elements.

#### Input

The JSON input serves as the payload to the DataWeave source. Notice that the `name` keys in the
array are repeated.

```json
{
  "friends": [{ "name": "Mariano" }, { "name": "Shoki" }, { "name": "Tomo" }, { "name": "Ana" }]
}
```

#### Source

The DataWeave script selects the value of the `friends` key.

```dataweave
%dw 2.0
output application/xml
---
friends: {
    (payload.friends)
}
```

#### Output

The output represents the `name` keys as XML elements.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<friends>
  <name>Mariano</name>
  <name>Shoki</name>
  <name>Tomo</name>
  <name>Ana</name>
</friends>
```

See also,
[Example: Outputting Self-closing XML Tags](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-output-self-closing-xml-tags).

### Example: Transform XML Elements to JSON and Replace Characters

This example iterates over an XML file that contains details of employees, such as the `Id`, `Name`,
and `Address`, and converts the file into JSON format. The DataWeave script uses the `replace`
function to iterate over each `Address` element and replace the characters `-` and `/` with blank
space.

#### Input

The XML input serves as the payload to the DataWeave source. Notice that the `Address` element
contains `-` and `/` characters.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<root>
  <employees>
    <Id>1</Id>
    <Name>Mule</Name>
    <Address>MuleSoft Avenue - 123</Address>
  </employees>
  <employees>
    <Id>2</Id>
    <Name>Max</Name>
    <Address>MuleSoft Avenue-456/5/e</Address>
  </employees>
</root>
```

#### Source

The following DataWeave script iterates over the payload elements and performs a mapping to an
object. The instruction `payload01.Address replace /([\-\,\/])/ with " "` replaces the `-` and `/`
characters with blank spaces.

```dataweave
%dw 2.0
output application/json
---
payload.root.*employees map ((payload01 , indexOfPayload01) ->
  {
     Id: payload01.Id as String,
     Name: payload01.Name as String,
     Address: payload01.Address replace /([\-\,\/])/ with " "
  }
)
```

#### Output

The output represents the transformed XML elements into JSON.

```JSON
[
  {
    "Id": "1",
    "Name": "Mule",
    "Address": "MuleSoft Avenue   123"
  },
  {
    "Id": "2",
    "Name": "Max",
    "Address": "MuleSoft Avenue 456 5 e"
  }
]
```

### Example: Read DTD value

The following DataWeave script transforms the XML input payload that contains a `DocType` value into
JSON. Notice that extracts the value of that doctype directive using the expression
`payload.^docType`.

#### Input

```xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE cXML SYSTEM "http://xml.cxml.org/schemas/cXML/1.2.014/cXML.dtd">
<cXML xml:lang="en-US" payloadID="1615232861.000506@prd327utl1.int.coupahost.com" timestamp="2021-03-08T11:47:42-08:00">
    <Header>
        <From>
            <Credential domain="NetworkID">
                <Identity>TestIdentity</Identity>
            </Credential>
        </From>
        <To>
            <Credential domain="TEST">
                <Identity>Identity</Identity>
            </Credential>
        </To>
    </Header>
</cXML>
```

#### Source

```dataweave
%dw 2.0
output application/json
---
{
    header: {
        senderId: payload.cXML.Header.From.Credential.Identity,
        receiverId: payload.cXML.Header.To.Credential.Identity,
        docType: payload.^docType
    }
}
```

#### Output

```json
{
  "header": {
    "senderId": "Identity",
    "receiverId": "TestIdentity",
    "docType": {
      "rootName": "cXML",
      "systemId": "http://xml.cxml.org/schemas/cXML/1.2.014/cXML.dtd"
    }
  }
}
```

### Example: Write a DTD Value

This example shows how to use the `docType` metadata to create a `DocType` value in the XML output.

#### Source

```dataweave
%dw 2.0
output application/xml
ns xml http://www.w3.org/XML/1998/namespace

var cXmlObj = {
  cXML @(payloadID: "9949494", xml#lang: "en-US", timestamp: "2002-02-04T18:39:09-08:00"): {
      Header: {
        From: {
          Credential @(domain: "NetworkId"): {
            Identity: "Identity"
          }
        }
    }
  }
} as Object {
    docType: { rootName: "cXML", systemId: "http://xml.cXML.org/schemas/cXML/1.2.014/cXML.dtd" }
}
---
cXmlObj
```

#### Output

```xml
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE cXML SYSTEM "http://xml.cXML.org/schemas/cXML/1.2.014/cXML.dtd">
<cXML payloadID="9949494" xml:lang="en-US" timestamp="2002-02-04T18:39:09-08:00">
  <Header>
    <From>
      <Credential domain="NetworkId">
        <Identity>Identity</Identity>
      </Credential>
    </From>
  </Header>
</cXML>
```

### Example: Transform DTD Value to a String Representation

This example uses [Dtd Module (dw::xml::Dtd)](https://docs.mulesoft.com/dataweave/2.12/dw-dtd) to transform a `DocType` value that includes a
`systemId` to a string representation.

#### Input

```xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE cXML SYSTEM "http://xml.cxml.org/schemas/cXML/1.2.014/cXML.dtd">
<cXML xml:lang="en-US" payloadID="1615232861.000506@prd327utl1.int.coupahost.com" timestamp="2021-03-08T11:47:42-08:00">
    <Header>
        <From>
            <Credential domain="NetworkID">
                <Identity>Identity</Identity>
            </Credential>
        </From>
        <To>
            <Credential domain="TEST">
                <Identity>Identity</Identity>
            </Credential>
        </To>
    </Header>
</cXML>
```

#### Source

```dataweave
%dw 2.0
output application/json
import * from dw::xml::Dtd
---
docTypeAsString(payload.^docType)
```

#### Output

```JSON
"cXML SYSTEM http://xml.cxml.org/schemas/cXML/1.2.014/cXML.dtd"
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>collectionPath</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Sets the path to the location in the document where the collection is located. Accepts a path expression that identifies the location of the elements to stream.</p></div></div></td></tr><tr><td><p><code>externalEntities</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Indicates whether to process external entities. Disabled by default to avoid XML External Entity (XXE) attacks.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>indexedReader</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Uses the indexed reader by default when reaching the threshold. Supports US-ASCII, UTF-8 and ISO-8859-1 encodings only. For other encodings, DataWeave uses the in-memory reader.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>maxAttributeSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>-1</code></p></td><td><div><div><p>Sets the maximum number of characters accepted in an XML attribute. <em>Available since Mule 4.2.1.</em></p></div></div></td></tr><tr><td><p><code>maxEntityCount</code></p></td><td><p><code>Number</code></p></td><td><p><code>1</code></p></td><td><div><div><p>Sets the maximum number of entity expansions. The limit helps avoid Billion Laughs attacks.</p></div></div></td></tr><tr><td><p><code>nullValueOn</code></p></td><td><p><code>String</code></p></td><td><p><code>'blank'</code></p></td><td><div><div><p>Indicates whether to read an element with empty or blank text as a <code>null</code> value.</p></div><div><p>Valid values are <code>empty</code> or <code>none</code> or <code>blank</code>.</p></div></div></td></tr><tr><td><p><code>optimizeFor</code></p></td><td><p><code>String</code></p></td><td><p><code>'speed'</code></p></td><td><div><div><p>Configures the type of optimization for the XML parser to use.</p></div><div><p>Valid values are <code>speed</code> or <code>memory</code>.</p></div></div></td></tr><tr><td><p><code>streaming</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Streams input when set to <code>true</code>. Use only if entries are accessed sequentially. The input must be a top-level array. See the <a href="#example2">streaming example</a>, and see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats#dw_readers_writers">DataWeave Readers</a>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>supportDtd</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Enable or disable DTD support. Disabling skips (and does not process) internal and external subsets. You can also enable this property by setting the Mule system property <code>com.mulesoft.dw.xml.supportDTD</code>. Note that the default for this property changed from <code>true</code> to <code>false</code> in Mule version 4.3.0-20210601, which includes the June 2021 patch of DataWeave version 2.3.0.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>defaultNamespace</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Specifies the default namespaces of the output XML.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>doubleQuoteInDeclaration</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Escapes double quotes in the XML declaration when set to <code>true</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr><tr><td><p><code>escapeCR</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Escapes <code>CR</code> characters when set to <code>true</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>escapeGT</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Escapes '&gt;' characters when set to <code>true</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>indent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Write indented output for better readability by default, or compress output into a single line when set to <code>false</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>inlineCloseOn</code></p></td><td><p><code>String</code></p></td><td><p><code>'empty'</code></p></td><td><div><div><p>Write an inline close tag, or explicitly open and close tags when the value is <code>null</code>.</p></div><div><p>Valid values are <code>empty</code> or <code>none</code>.</p></div></div></td></tr><tr><td><p><code>onInvalidChar</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Valid values are <code>base64</code> or <code>ignore</code> or <code>none</code>.</p></div></div></td></tr><tr><td><p><code>skipNullOn</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Skips <code>null</code> values in the specified data structure. By default, DataWeave does not skip the values.</p></div><div><ul><li><p><code>elements</code> + Ignore and omit <code>null</code> elements inside XML output, for example, with <code>output application/xml skipNullOn="arrays"</code>.</p></li><li><p><code>attributes ` + Ignore and omit `null</code> attributes inside XML, for example, with <code>output application/xml skipNullOn="objects"</code>.</p></li><li><p><code>everywhere</code> + Apply <code>skipNullOn</code> to elements and attributes, for example, <code>output application/xml skipNullOn="everywhere"</code>.</p></li></ul></div><div><p>Valid values are <code>elements</code> or <code>attributes</code> or <code>everywhere</code>.</p></div></div></td></tr><tr><td><p><code>writeDeclaration</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Writes the XML header declaration when set to <code>true</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>writeDeclaredNamespaces</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Marks the namespaces to declare in the root element of the XML:</p></div><div><ul><li><p><code>All</code>: Write all declared namespaces in the root element.</p></li><li><p><code>ids:&lt;comma separated namespace id&gt;</code>: Write only the specified namespaces.</p></li><li><p><code>regex:&lt;regex&gt;</code>: Write only the matching namespaces.</p></li></ul></div></div></td></tr><tr><td><p><code>writeNilOnNull</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Writes the <code>nil</code> attribute for a <code>null</code> value when this property is set to <code>true</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/xml</code></p></td></tr><tr><td><p><code><strong>/</strong>+xml</code></p></td></tr></tbody></table>

<!-- document id=46081f427fbdfdc93415d7106a564a9c0dbc04daa761db137ae24be81dadfe3e url=/mulesoft/current/en-us/dataweave/2.3/dataweave-formats-xml.md -->

---
product: DataWeave
version: 2.3
---

# XML Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME Type: `application/xml`

ID: `xml`

The XML data structure is mapped to DataWeave objects that can contain other objects, strings, or
`null` values. XML uses unbounded elements to represent collections, which are mapped to repeated
keys in DataWeave objects. In addition, DataWeave natively supports `namespaces`, `CData` an
`xsi:types`.

The DataWeave reader for XML input supports the following parsing strategies:

- Indexed

- In-Memory

- Streaming

To understand the parsing strategies that DataWeave readers and writers can apply to this format,
see [DataWeave Parsing Strategies](https://docs.mulesoft.com/dataweave/2.3/dataweave-formats#dw_readers_writers).

## CData Custom Type

`CData` is a custom DataWeave data type for XML that is used to identify a Character DATA (CDATA)
block. The `CData` type tells the XML writer to wrap content inside a `CDATA` block or to check for
an input string inside a `CDATA` block. In DataWeave, `CData` inherits from the type `String`.

## Examples

The following examples show uses of the XML format.

- [Example: Stream Input XML Data](#example1)

- [Example: Null or Empty String in XML](#example2)

- [Example: Output `null` Values for Missing XML Values](#example3)

- [Example: Output `null` Values for Missing XML Values](#example4)

- [Example: Represent XML Attributes in the DataWeave (dw) Format](#example5)

- [Example: Represent XML Namespaces in the DataWeave (dw) Format](#example6)

- [Example: Create a CDATA Element](#example7)

- [Example: Check for CDATA in a `String`](#example8)

- [Example: Use the `inlineCloseOn` Writer Property](#example9)

- [Example: Transforms Repeated JSON Keys to Repeated XML Elements](#example10)

- [Example: Transform XML elements into JSON format and replace characters](#example11)

### Example: Stream Input XML Data

This example shows how to set up XML streaming, which requires you to specify the following reader
properties:

- `streaming=true`

- `collectionPath="root.repeated"`

The `collectionPath` setting selects the elements to stream.

When streaming, the XML parser can start processing content without having all the XML content.

#### Input

The following XML serves as the input payload to the DataWeave source. Assume that it is the content
of an XML file `myXML.xml`.

myXML.xml

```xml
<root>
    <text>
        Text
    </text>
    <repeated>
        <user>
            <name>Mariano</name>
            <lastName>de Achaval</lastName>
            <age>36</age>
        </user>
        <user>
            <lastName>Shokida</lastName>
            <name>Leandro</name>
            <age>30</age>
        </user>
        <user>
            <age>29</age>
            <name>Ana</name>
            <lastName>Felissati</lastName>

        </user>
        <user>
            <age>29</age>
            <lastName>Chibana</lastName>
            <name>Christian</name>
        </user>

    </repeated>
</root>
```

#### Source

The reader property settings in the DataWeave script tell the XML reader to stream the input and
process the repeated keys. The script uses the DataWeave `map` function to iterate over the repeated
keys.

```dataweave
%dw 2.0
var myInput  readUrl('classpath://myXML.xml', 'application/xml', {streaming:true, collectionPath: "root.repeated"})
output application/dw
---
myInput.root.repeated.*user map {
    n: $.name,
    l: $.lastName,
    a: $.age
}
```

#### Output

The script transforms the mapped input XML to the DataWeave (dw) format and MIME type.

```json
[
  {
    "n": "Mariano",
    "l": "de Achaval",
    "a": "36"
  },
  {
    "n": "Leandro",
    "l": "Shokida",
    "a": "30"
  },
  {
    "n": "Ana",
    "l": "Felissati",
    "a": "29"
  },
  {
    "n": "Christian",
    "l": "Chibana",
    "a": "29"
  }
]
```

### Example: Null or Empty String in XML

Because there is no standard way to represent a `null` value in XML, the reader maps the value to
`null` when the `nil` attribute is set to `true`.

#### Input

The following XML serves as the input payload to the DataWeave source. Notice the `nil` setting in
`<xsi:nil="true"`/>.

```xml
<book xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <author xsi:nil="true"/>
</book>
```

#### Source

The DataWeave script transforms the input XML to the JSON format and MIME type.

```dataweave
%dw 2.0
output application/json
---
payload
```

#### Output

The output is in the JSON format. Notice that the `nil` value in the input is transformed to `null`.

```json
{
  "book": {
    "author": null
  }
}
```

### Example: Output `null` Values for Missing XML Values

The XML reader property `nullValueOn` accepts the value `blank` (the default) or `empty`.

This example uses the `nullValueOn` default, so it maps the values of the `title` and `author`
elements to `null`.

#### Input

The following XML serves as input to the DataWeave source. Notice that the `title` and `author`
elements lack values.

Assume that this input is content within the file, `myInput.xml`.

myXML.xml content:

```xml
<book>
    <author></author>
    <title>

</title>
</book>
```

#### Source

The DataWeave script transforms the XML input to JSON. Note that it explicitly sets the
`nullValueOn` default, `blank`, for demonstration purposes.

```dataweave
%dw 2.0
var myInput readUrl('classpath://myXML.xml', 'application/xml', {nullValueOn: "blank"})
output application/json
---
myInput
```

#### Output

The `title` and `author` keys in the JSON output are assigned `null` values.

```json
{
  "book": {
    "author": null,
    "title": null
  }
}
```

### Example: Output `null` Values for Missing XML Values

The XML reader property `nullValueOn` accepts the value `blank` (the default) or `empty`.

The example maps the value of the `title` element to a `String` and value of the `author` element to
`null` because the XML reader property `nullValueOn` is set to `empty`.

#### Input

The following XML serves as input to the DataWeave source. Notice that the `title` and `author`
elements lack values. The difference between the two elements is the space between the starting and
ending tags. The tags of the `title` element are separated by line breaks (the hidden characters,
`\n`), while the tags of the `author` element are not separated by any characters.

Assume that this input is content within the file, `myInput.xml`.

myXML.xml content:

```xml
<book>
    <author></author>
    <title>

</title>
</book>
```

#### Source

The DataWeave script uses a DataWeave variable to input the content of `myXML.xml` and applies the
`nullValueOn: "empty"` to it. The script transforms the XML input to JSON.

```dataweave
%dw 2.0
var myInput readUrl('classpath://myXML.xml', 'application/xml', {nullValueOn: "empty"})
output application/json
---
myInput
```

#### Output

The JSON output maps the value of the `author` element to `null` and value of the `title` element to
the `String` value `"\n\n"`, which is for the new line characters.

```json
{
  "book": {
    "author": null,
    "title": "\n\n"
  }
}
```

### Example: Represent XML Attributes in the DataWeave (dw) Format

This example maps XML attributes to a canonical DataWeave representation, the `application/dw`
format and MIME type.

#### Input

The XML serves as the input payload to the DataWeave source. Notice that the input contains XML
attributes.

```xml
<users>
  <company>MuleSoft</company>
  <user name="Leandro" lastName="Shokida"/>
  <user name="Mariano" lastName="Achaval"/>
</users>
```

#### Source

The DataWeave script transforms the XML input payload to the DataWeave (dw) format and MIME type.

```dataweave
%dw 2.0
output application/dw
---
payload
```

#### Output

The output shows how the DataWeave (dw) format represents the XML input. Notice how the attributes
from the XML input and the empty values are represented.

```dataweave
{
  users: {
    company: "MuleSoft",
    user @(name: "Leandro",lastName: "Shokida"): "",
    user @(name: "Mariano",lastName: "Achaval"): ""
  }
}
```

### Example: Represent XML Namespaces in the DataWeave (dw) Format

This example maps XML namespaces to a canonical DataWeave representation, the `application/dw`
format and MIME type.

#### Input

The XML serves as the input payload to the DataWeave source. Notice that the input contains XML
namespaces.

```xml
<root>
    <h:table xmlns:h="http://www.w3.org/TR/html4/">
      <h:tr>
        <h:td>Apples</h:td>
        <h:td>Bananas</h:td>
      </h:tr>
    </h:table>

    <f:table xmlns:f="https://www.w3schools.com/furniture">
      <f:name>African Coffee Table</f:name>
      <f:width>80</f:width>
      <f:length>120</f:length>
    </f:table>
</root>
```

#### Source

The DataWeave script transforms the XML input payload to the DataWeave (dw) format and MIME type.

```dataweave
%dw 2.0
output application/dw
---
payload
```

#### Output

The output shows how the DataWeave (dw) format represents the XML input. Notice how the namespaces
from the XML are represented.

```dataweave
ns h http://www.w3.org/TR/html4/
ns f https://www.w3schools.com/furniture
---
{
  root: {
      h#table: {
        h#tr: {
          h#td: "Apples",
          h#td: "Bananas"
        }
      },
      f#table: {
        f#name: "African Coffee Table",
        f#width: "80",
        f#length: "120"
      }
  }
}
```

### Example: Create a CDATA Element

This example shows how to use the `CData` type to create a CDATA element in the XML output.

#### Source

The body of the DataWeave script coerces the `String` value to the `CData` type.

```dataweave
%dw 2.0
output application/xml
---
{
    test: "A text <a>" as CData
}
```

#### Output

The output encloses the input `String` value in a CDATA block, which contains the special
characters, `<` and `>`, from the input.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<test><![CDATA[A text <a>]]></test>
```

### Example: Check for CDATA in a `String`

This example indicates whether a given `String` value is CDATA.

#### Input

The XML serves as the input payload to the DataWeave source. Notice that the `test` element contains
a CDATA block.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<test><![CDATA[A text <a>]]></test>
```

#### Source

The DataWeave script uses the `is CData` expression to determine whether the `String` value is
CDATA.

```dataweave
%dw 2.0
output application/json
---
{
    test: payload.test is CDATA
}
```

#### Output

The JSON output contains the value `true`, which indicates tha the input `String` value is CDATA.

```json
{
  "test": true
}
```

### Example: Use the `inlineCloseOn` Writer Property

This example uses the `inlineCloseOn` writer property with the value `none` to act on the key-value
pairs from the input.

#### Source

The DataWeave script transforms the body content to XML. Notice that values of the `emptyElement`
keys are `null`.

```dataweave
%dw 2.0s
output application/xml inlineCloseOn="none"
---
{
  someXml: {
    parentElement: {
      emptyElement1: null,
      emptyElement2: null,
      emptyElement3: null
    }
  }
}
```

#### Output

The `emptyElement` elements are empty. They do not contain the value `null`.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<someXml>
  <parentElement>
    <emptyElement1></emptyElement1>
    <emptyElement2></emptyElement2>
    <emptyElement3></emptyElement3>
  </parentElement>
</someXml>
```

### Example: Transforms Repeated JSON Keys to Repeated XML Elements

XML encodes collections using repeated (unbounded) elements. DataWeave represents unbounded elements
by repeating the same key.

This example shows how to convert the repeated keys in a JSON array of objects into repeated XML
elements.

#### Input

The JSON input serves as the payload to the DataWeave source. Notice that the `name` keys in the
array are repeated.

```json
{
  "friends": [{ "name": "Mariano" }, { "name": "Shoki" }, { "name": "Tomo" }, { "name": "Ana" }]
}
```

#### Source

The DataWeave script selects the value of the `friends` key.

```dataweave
%dw 2.0
output application/xml
---
friends: {
    (payload.friends)
}
```

#### Output

The output represents the `name` keys as XML elements.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<friends>
  <name>Mariano</name>
  <name>Shoki</name>
  <name>Tomo</name>
  <name>Ana</name>
</friends>
```

See also,
[Example: Outputting Self-closing XML Tags](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-output-self-closing-xml-tags).

### Example: Transform XML elements into JSON format and replace characters

This example iterates over an XML file that contains details of employees such as the `Id`, `Name`,
and `Address`, and converts the file into JSON format. The DataWeave script uses the `replace`
function to iterate over each `Address` element and replace the characters `-` and `/` with blank
space.

#### Input

The XML input serves as the payload to the DataWeave source. Notice that the `Address` element
contains `-` and `/` characters.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<root>
<employees>
<Id>1</Id>
<Name>Mule</Name>
<Address>MuleSoft Avenue - 123</Address>
</employees>
<employees>
<Id>2</Id>
<Name>Max</Name>
<Address>MuleSoft Avenue-456/5/e</Address>
</employees>
</root>
```

#### Source

The following DataWeave script iterates over the payload elements and performs a mapping to an
object. The instruction `payload01.Address replace /([\-\,\/])/ with " "` replaces the `-` and `/`
characters with blank spaces.

```dataweave
%dw 2.0
output application/json
---
payload.root.*employees map ((payload01 , indexOfPayload01) ->
{ Id: payload01.Id as String, Name: payload01.Name as String, Address: payload01.Address replace /([\-\,\/])/ with " " }
)
```

#### Output

The output represents the transformed XML elements into JSON.

```JSON
[
  {
    "Id": "1",
    "Name": "Mule",
    "Address": "MuleSoft Avenue   123"
  },
  {
    "Id": "2",
    "Name": "Max",
    "Address": "MuleSoft Avenue 456 5 e"
  }
]
```

## Configuration Properties

DataWeave supports the following configuration properties for the XML format.

### Reader Properties

The XML format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>collectionPath</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Path to the document where the collection is located. It specifies a path expression that identifies the location of the elements to stream. See <a href="#example1">Example: Stream Input XML Data</a>.</p></div></div></td></tr><tr><td><p><code>externalEntities</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Indicates whether external entities should be processed or not. By default this is disabled to avoid XXE attacks. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>indexedReader</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>DataWeave uses the indexed reader by default when reaching the threshold. Supports US-ASCII, UTF-8 and ISO-8859-1 encodings only. For other encodings and when set to <code>false</code>, DataWeave uses the in-memory reader. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>maxAttributeSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>-1</code></p></td><td><div><div><p>Sets the maximum number of characters accepted in an XML attribute. Available since Mule 4.2.1.</p></div></div></td></tr><tr><td><p><code>maxEntityCount</code></p></td><td><p><code>Number</code></p></td><td><p><code>1</code></p></td><td><div><div><p>The maximum number of entity expansions. The limit is in place to avoid Billion Laughs attacks.</p></div></div></td></tr><tr><td><p><code>nullValueOn</code></p></td><td><p><code>String</code></p></td><td><p><code>blank</code></p></td><td><div><div><p>Indicates whether to read an element with empty or blank text as a <code>null</code> value. Valid values are <code>empty</code>, <code>none</code>, or <code>blank</code>. See <a href="#example3">Example: Output <code>null</code> Values for Missing XML Values</a> and <a href="#example4">Example: Output <code>null</code> Values for Missing XML Values</a>.</p></div></div></td></tr><tr><td><p><code>optimizeFor</code></p></td><td><p><code>String</code></p></td><td><p><code>'speed'</code></p></td><td><div><div><p>Indicates how to configure the XML parser. Valid values are <code>speed</code> and <code>memory</code>.</p></div></div></td></tr><tr><td><p><code>streaming</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Indicates whether to stream input (use only if entries are accessed sequentially). Valid Options are <code>true</code> or <code>false</code>. See <a href="#example1">Example: Stream Input XML Data</a>.</p></div></div></td></tr><tr><td><p><code>supportDtd</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Enable or disable DTD support. Disabling skips (and does not process) internal and external subsets. Valid values are <code>true</code> or <code>false</code>. You can also enable this property by setting the Mule system property <code>com.mulesoft.dw.xml.supportDTD</code>. Note that the default for this property changed from <code>true</code> to <code>false</code> in Mule version 4.3.0-20210601, which includes the June 2021 patch of DataWeave version 2.3.0.</p></div></div></td></tr></tbody></table>

### Writer Properties

The XML format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Encoding for the writer to use.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>When set to <code>true</code>, DataWeave generates the output as a data stream, and the script’s execution is deferred until it is consumed. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>escapeCR</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Whether to escape a carriage return (CR). Valid values are <code>true</code> or <code>false</code>. Available since Mule 4.2.1.</p></div></div></td></tr><tr><td><p><code>indent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether to indent the code for better readability or to compress it into a single line. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>inlineCloseOn</code></p></td><td><p><code>String</code></p></td><td><p><code>empty</code></p></td><td><div><div><p>Indicates when the writer uses inline close tag or use open close tags. Valid values are <code>empty</code> or <code>none</code>.</p></div></div></td></tr><tr><td><p><code>onInvalidChar</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Valid values are <code>base64</code>, <code>ignore</code>, or <code>none</code>.</p></div></div></td></tr><tr><td><p><code>skipNullOn</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Skips <code>null</code> values in the specified data structure. By default, the writer does not skip them. Valid values are <code>elements</code>, <code>attributes</code>, or <code>everywhere</code>.</p></div></div></td></tr><tr><td><p><code>writeDeclaration</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether to write the XML header declaration. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>writeNilOnNull</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Indicates whether to write a nil attribute when the value is <code>null</code>. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

The XML format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/xml</code></p></td></tr><tr><td><p><code><strong>/</strong>+xml</code></p></td></tr></tbody></table>

<!-- document id=db4d2dbe29f32aaca66558604daf80b714e01bccf5ffacf93001dd7d81a7d7e0 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-formats-xml.md -->

---
product: DataWeave
version: 2.4
keywords: format, xml, */xml, */*+xml, application/xml
---

# XML Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/xml`

ID: `xml`

The XML data structure is mapped to DataWeave objects that can contain other objects, strings, or
`null` values. XML uses unbounded elements to represent collections, which are mapped to repeated
keys in DataWeave objects. In addition, DataWeave natively supports `namespaces`, `CData` an
`xsi:types`.

The DataWeave reader for XML input supports the following parsing strategies:

- Indexed

- In-Memory

- Streaming

To understand the parsing strategies that DataWeave readers and writers can apply to this format,
see [DataWeave Parsing Strategies](https://docs.mulesoft.com/dataweave/2.4/dataweave-formats#dw_readers_writers).

## CData Custom Type

`CData` is a custom DataWeave data type for XML that is used to identify a Character DATA (CData)
block. The `CData` type tells the XML writer to wrap content inside a `CData` block or to check for
an input string inside a `CData` block. In DataWeave, `CData` inherits from the type `String`.

## Examples

The following examples show uses of the XML format.

- [Example: Stream Input XML Data](#example1)

- [Example: Null or Empty String in XML](#example2)

- [Example: Output `null` Values for Missing XML Values](#example3)

- [Example: Output `null` Values for Missing XML Values](#example4)

- [Example: Represent XML Attributes in the DataWeave (dw) Format](#example5)

- [Example: Represent XML Namespaces in the DataWeave (dw) Format](#example6)

- [Example: Create a CData Element](#example7)

- [Example: Check for CData in a `String`](#example8)

- [Example: Use the `inlineCloseOn` Writer Property](#example9)

- [Example: Transforms Repeated JSON Keys to Repeated XML Elements](#example10)

- [Example: Transform XML elements into JSON format and replace characters](#example11)

Refer to [DataWeave Formats](https://docs.mulesoft.com/dataweave/2.4/dataweave-formats) for more details on available reader and writer
properties for various data formats.

### Example: Stream Input XML Data

This example shows how to set up XML streaming, which requires you to specify the following reader
properties:

- `streaming=true`

- `collectionPath="root.repeated"`

The `collectionPath` setting selects the elements to stream.

When streaming, the XML parser can start processing content without having all the XML content.

#### Input

The following XML serves as the input payload to the DataWeave source. Assume that it is the content
of an XML file `myXML.xml`.

myXML.xml

```xml
<root>
    <text>
        Text
    </text>
    <repeated>
        <user>
            <name>Mariano</name>
            <lastName>de Achaval</lastName>
            <age>36</age>
        </user>
        <user>
            <lastName>Shokida</lastName>
            <name>Leandro</name>
            <age>30</age>
        </user>
        <user>
            <age>29</age>
            <name>Ana</name>
            <lastName>Felissati</lastName>

        </user>
        <user>
            <age>29</age>
            <lastName>Chibana</lastName>
            <name>Christian</name>
        </user>

    </repeated>
</root>
```

#### Source

The reader property settings in the DataWeave script tell the XML reader to stream the input and
process the repeated keys. The script uses the DataWeave `map` function to iterate over the repeated
keys.

```dataweave
%dw 2.0
var myInput  readUrl('classpath://myXML.xml', 'application/xml', {streaming:true, collectionPath: "root.repeated"})
output application/dw
---
myInput.root.repeated.*user map {
    n: $.name,
    l: $.lastName,
    a: $.age
}
```

#### Output

The script transforms the mapped input XML to the DataWeave (dw) format and MIME type.

```json
[
  {
    "n": "Mariano",
    "l": "de Achaval",
    "a": "36"
  },
  {
    "n": "Leandro",
    "l": "Shokida",
    "a": "30"
  },
  {
    "n": "Ana",
    "l": "Felissati",
    "a": "29"
  },
  {
    "n": "Christian",
    "l": "Chibana",
    "a": "29"
  }
]
```

### Example: Null or Empty String in XML

Because there is no standard way to represent a `null` value in XML, the reader maps the value to
`null` when the `nil` attribute is set to `true`.

#### Input

The following XML serves as the input payload to the DataWeave source. Notice the `nil` setting in
`<xsi:nil="true"`/>.

```xml
<book xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <author xsi:nil="true"/>
</book>
```

#### Source

The DataWeave script transforms the input XML to the JSON format and MIME type.

```dataweave
%dw 2.0
output application/json
---
payload
```

#### Output

The output is in the JSON format. Notice that the `nil` value in the input is transformed to `null`.

```json
{
  "book": {
    "author": null
  }
}
```

### Example: Output `null` Values for Missing XML Values

The XML reader property `nullValueOn` accepts the value `blank` (the default) or `empty`.

This example uses the `nullValueOn` default, so it maps the values of the `title` and `author`
elements to `null`.

#### Input

The following XML serves as input to the DataWeave source. Notice that the `title` and `author`
elements lack values.

Assume that this input is content within the file, `myInput.xml`.

myXML.xml content:

```xml
<book>
    <author></author>
    <title>

</title>
</book>
```

#### Source

The DataWeave script transforms the XML input to JSON. Note that it explicitly sets the
`nullValueOn` default, `blank`, for demonstration purposes.

```dataweave
%dw 2.0
var myInput readUrl('classpath://myXML.xml', 'application/xml', {nullValueOn: "blank"})
output application/json
---
myInput
```

#### Output

The `title` and `author` keys in the JSON output are assigned `null` values.

```json
{
  "book": {
    "author": null,
    "title": null
  }
}
```

### Example: Output `null` Values for Missing XML Values

The XML reader property `nullValueOn` accepts the value `blank` (the default) or `empty`.

The example maps the value of the `title` element to a `String` and value of the `author` element to
`null` because the XML reader property `nullValueOn` is set to `empty`.

#### Input

The following XML serves as input to the DataWeave source. Notice that the `title` and `author`
elements lack values. The difference between the two elements is the space between the starting and
ending tags. The tags of the `title` element are separated by line breaks (the hidden characters,
`\n`), while the tags of the `author` element are not separated by any characters.

Assume that this input is content within the file, `myInput.xml`.

myXML.xml content:

```xml
<book>
    <author></author>
    <title>

</title>
</book>
```

#### Source

The DataWeave script uses a DataWeave variable to input the content of `myXML.xml` and applies the
`nullValueOn: "empty"` to it. The script transforms the XML input to JSON.

```dataweave
%dw 2.0
var myInput readUrl('classpath://myXML.xml', 'application/xml', {nullValueOn: "empty"})
output application/json
---
myInput
```

#### Output

The JSON output maps the value of the `author` element to `null` and value of the `title` element to
the `String` value `"\n\n"`, which is for the new line characters.

```json
{
  "book": {
    "author": null,
    "title": "\n\n"
  }
}
```

### Example: Represent XML Attributes in the DataWeave (dw) Format

This example maps XML attributes to a canonical DataWeave representation, the `application/dw`
format and MIME type.

#### Input

The XML serves as the input payload to the DataWeave source. Notice that the input contains XML
attributes.

```xml
<users>
  <company>MuleSoft</company>
  <user name="Leandro" lastName="Shokida"/>
  <user name="Mariano" lastName="Achaval"/>
</users>
```

#### Source

The DataWeave script transforms the XML input payload to the DataWeave (dw) format and MIME type.

```dataweave
%dw 2.0
output application/dw
---
payload
```

#### Output

The output shows how the DataWeave (dw) format represents the XML input. Notice how the attributes
from the XML input and the empty values are represented.

```dataweave
{
  users: {
    company: "MuleSoft",
    user @(name: "Leandro",lastName: "Shokida"): "",
    user @(name: "Mariano",lastName: "Achaval"): ""
  }
}
```

### Example: Represent XML Namespaces in the DataWeave (dw) Format

This example maps XML namespaces to a canonical DataWeave representation, the `application/dw`
format and MIME type.

#### Input

The XML serves as the input payload to the DataWeave source. Notice that the input contains XML
namespaces.

```xml
<root>
    <h:table xmlns:h="http://www.w3.org/TR/html4/">
      <h:tr>
        <h:td>Apples</h:td>
        <h:td>Bananas</h:td>
      </h:tr>
    </h:table>

    <f:table xmlns:f="https://www.w3schools.com/furniture">
      <f:name>African Coffee Table</f:name>
      <f:width>80</f:width>
      <f:length>120</f:length>
    </f:table>
</root>
```

#### Source

The DataWeave script transforms the XML input payload to the DataWeave (dw) format and MIME type.

```dataweave
%dw 2.0
output application/dw
---
payload
```

#### Output

The output shows how the DataWeave (dw) format represents the XML input. Notice how the namespaces
from the XML are represented.

```dataweave
ns h http://www.w3.org/TR/html4/
ns f https://www.w3schools.com/furniture
---
{
  root: {
      h#table: {
        h#tr: {
          h#td: "Apples",
          h#td: "Bananas"
        }
      },
      f#table: {
        f#name: "African Coffee Table",
        f#width: "80",
        f#length: "120"
      }
  }
}
```

### Example: Create a CData Element

This example shows how to use the `CData` type to create a CData element in the XML output.

#### Source

The body of the DataWeave script coerces the `String` value to the `CData` type.

```dataweave
%dw 2.0
output application/xml
---
{
    test: "A text <a>" as CData
}
```

#### Output

The output encloses the input `String` value in a CData block, which contains the special
characters, `<` and `>`, from the input.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<test><![CDATA[A text <a>]]></test>
```

### Example: Check for CData in a `String`

This example indicates whether a given `String` value is CData.

#### Input

The XML serves as the input payload to the DataWeave source. Notice that the `test` element contains
a CData block.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<test><![CDATA[A text <a>]]></test>
```

#### Source

The DataWeave script uses the `is CData` expression to determine whether the `String` value is
CData.

```dataweave
%dw 2.0
output application/json
---
{
    test: payload.test is CData
}
```

#### Output

The JSON output contains the value `true`, which indicates tha the input `String` value is CData.

```json
{
  "test": true
}
```

### Example: Use the `inlineCloseOn` Writer Property

This example uses the `inlineCloseOn` writer property with the value `none` to act on the key-value
pairs from the input.

#### Source

The DataWeave script transforms the body content to XML. Notice that values of the `emptyElement`
keys are `null`.

```dataweave
%dw 2.0
output application/xml inlineCloseOn="none"
---
{
  someXml: {
    parentElement: {
      emptyElement1: null,
      emptyElement2: null,
      emptyElement3: null
    }
  }
}
```

#### Output

The `emptyElement` elements are empty. They do not contain the value `null`.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<someXml>
  <parentElement>
    <emptyElement1></emptyElement1>
    <emptyElement2></emptyElement2>
    <emptyElement3></emptyElement3>
  </parentElement>
</someXml>
```

### Example: Transforms Repeated JSON Keys to Repeated XML Elements

XML encodes collections using repeated (unbounded) elements. DataWeave represents unbounded elements
by repeating the same key.

This example shows how to convert the repeated keys in a JSON array of objects into repeated XML
elements.

#### Input

The JSON input serves as the payload to the DataWeave source. Notice that the `name` keys in the
array are repeated.

```json
{
  "friends": [{ "name": "Mariano" }, { "name": "Shoki" }, { "name": "Tomo" }, { "name": "Ana" }]
}
```

#### Source

The DataWeave script selects the value of the `friends` key.

```dataweave
%dw 2.0
output application/xml
---
friends: {
    (payload.friends)
}
```

#### Output

The output represents the `name` keys as XML elements.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<friends>
  <name>Mariano</name>
  <name>Shoki</name>
  <name>Tomo</name>
  <name>Ana</name>
</friends>
```

See also,
[Example: Outputting Self-closing XML Tags](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-output-self-closing-xml-tags).

### Example: Transform XML elements into JSON format and replace characters

This example iterates over an XML file that contains details of employees such as the `Id`, `Name`,
and `Address`, and converts the file into JSON format. The DataWeave script uses the `replace`
function to iterate over each `Address` element and replace the characters `-` and `/` with blank
space.

#### Input

The XML input serves as the payload to the DataWeave source. Notice that the `Address` element
contains `-` and `/` characters.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<root>
<employees>
<Id>1</Id>
<Name>Mule</Name>
<Address>MuleSoft Avenue - 123</Address>
</employees>
<employees>
<Id>2</Id>
<Name>Max</Name>
<Address>MuleSoft Avenue-456/5/e</Address>
</employees>
</root>
```

#### Source

The following DataWeave script iterates over the payload elements and performs a mapping to an
object. The instruction `payload01.Address replace /([\-\,\/])/ with " "` replaces the `-` and `/`
characters with blank spaces.

```dataweave
%dw 2.0
output application/json
---
payload.root.*employees map ((payload01 , indexOfPayload01) ->
{ Id: payload01.Id as String, Name: payload01.Name as String, Address: payload01.Address replace /([\-\,\/])/ with " " }
)
```

#### Output

The output represents the transformed XML elements into JSON.

```JSON
[
  {
    "Id": "1",
    "Name": "Mule",
    "Address": "MuleSoft Avenue   123"
  },
  {
    "Id": "2",
    "Name": "Max",
    "Address": "MuleSoft Avenue 456 5 e"
  }
]
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>collectionPath</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Sets the path to the location in the document where the collection is located. Accepts a path expression that identifies the location of the elements to stream.</p></div></div></td></tr><tr><td><p><code>externalEntities</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Indicates whether to process external entities. Disabled by default to avoid XML External Entity (XXE) attacks.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>indexedReader</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Uses the indexed reader by default when reaching the threshold. Supports US-ASCII, UTF-8 and ISO-8859-1 encodings only. For other encodings, DataWeave uses the in-memory reader.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>maxAttributeSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>-1</code></p></td><td><div><div><p>Sets the maximum number of characters accepted in an XML attribute. <em>Available since Mule 4.2.1.</em></p></div></div></td></tr><tr><td><p><code>maxEntityCount</code></p></td><td><p><code>Number</code></p></td><td><p><code>1</code></p></td><td><div><div><p>Sets the maximum number of entity expansions. The limit helps avoid Billion Laughs attacks.</p></div></div></td></tr><tr><td><p><code>nullValueOn</code></p></td><td><p><code>String</code></p></td><td><p><code>'blank'</code></p></td><td><div><div><p>Indicates whether to read an element with empty or blank text as a <code>null</code> value.</p></div><div><p>Valid values are <code>empty</code> or <code>none</code> or <code>blank</code>.</p></div></div></td></tr><tr><td><p><code>optimizeFor</code></p></td><td><p><code>String</code></p></td><td><p><code>'speed'</code></p></td><td><div><div><p>Configures the type of optimization for the XML parser to use.</p></div><div><p>Valid values are <code>speed</code> or <code>memory</code>.</p></div></div></td></tr><tr><td><p><code>streaming</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Streams input when set to <code>true</code>. Use only if entries are accessed sequentially. The input must be a top-level array.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>supportDtd</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Enable or disable DTD support. Disabling skips (and does not process) internal and external subsets. You can also enable this property by setting the Mule system property <code>com.mulesoft.dw.xml.supportDTD</code>. Note that the default for this property changed from <code>true</code> to <code>false</code> in Mule version 4.3.0-20210601, which includes the June 2021 patch of DataWeave version 2.3.0.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer.</p></div></div></td></tr><tr><td><p><code>defaultNamespace</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Specifies the default namespaces of the output XML.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>doubleQuoteInDeclaration</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Escapes double quotes in the XML declaration when set to <code>true</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The character set to use for the output, such as UTF-8.</p></div></div></td></tr><tr><td><p><code>escapeCR</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Escapes <code>CR</code> characters when set to <code>true</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>escapeGT</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Escapes '&gt;' characters when set to <code>true</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>indent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Write indented output for better readability by default, or compress output into a single line when set to <code>false</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>inlineCloseOn</code></p></td><td><p><code>String</code></p></td><td><p><code>'empty'</code></p></td><td><div><div><p>Write an inline close tag, or explicitly open and close tags when the value is <code>null</code>.</p></div><div><p>Valid values are <code>empty</code> or <code>none</code>.</p></div></div></td></tr><tr><td><p><code>onInvalidChar</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Valid values are <code>base64</code> or <code>ignore</code> or <code>none</code>.</p></div></div></td></tr><tr><td><p><code>skipNullOn</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Skips <code>null</code> values in the specified data structure. By default, DataWeave does not skip the values.</p></div><div><ul><li><p><code>elements</code> + Ignore and omit <code>null</code> elements inside XML output, for example, with <code>output application/xml skipNullOn="arrays"</code>.</p></li><li><p><code>attributes ` + Ignore and omit `null</code> attributes inside XML, for example, with <code>output application/xml skipNullOn="objects"</code>.</p></li><li><p><code>everywhere</code> + Apply <code>skipNullOn</code> to elements and attributes, for example, <code>output application/xml skipNullOn="everywhere"</code>.</p></li></ul></div><div><p>Valid values are <code>elements</code> or <code>attributes</code> or <code>everywhere</code>.</p></div></div></td></tr><tr><td><p><code>writeDeclaration</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Writes the XML header declaration when set to <code>true</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>writeDeclaredNamespaces</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Marks the namespaces to declare in the root element of the XML:</p></div><div><ul><li><p><code>All</code>: Write all declared namespaces in the root element.</p></li><li><p><code>ids:&lt;comma separated namespace id&gt;</code>: Write only the specified namespaces.</p></li><li><p><code>regex:&lt;regex&gt;</code>: Write only the matching namespaces.</p></li></ul></div></div></td></tr><tr><td><p><code>writeNilOnNull</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Writes the <code>nil</code> attribute for a <code>null</code> value when this property is set to <code>true</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/xml</code></p></td></tr><tr><td><p><code><strong>/</strong>+xml</code></p></td></tr></tbody></table>

<!-- document id=899ea719667a1c398ddba00a54b7711ba626eba531619d0ad51a4d9118513c2c url=/mulesoft/current/en-us/dataweave/2.6/dataweave-formats-xml.md -->

---
product: DataWeave
version: 2.6
keywords: format, xml, */xml, */*+xml, application/xml
---

# XML Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/xml`

ID: `xml`

The XML data structure is mapped to DataWeave objects that can contain other objects, strings, or
`null` values. XML uses unbounded elements to represent collections, which are mapped to repeated
keys in DataWeave objects. In addition, DataWeave natively supports `namespaces`, `CData` an
`xsi:types`.

The DataWeave reader for XML input supports the following parsing strategies:

- Indexed

- In-Memory

- Streaming

To understand the parsing strategies that DataWeave readers and writers can apply to this format,
see [DataWeave Parsing Strategies](https://docs.mulesoft.com/dataweave/2.6/dataweave-formats#dw_readers_writers).

## `CData` Custom Type

`CData` is a custom DataWeave data type for XML that is used to identify a character data (CDATA)
block. The `CData` type makes the XML writer wrap content inside a `CDATA` block or to check for an
input string inside a `CDATA` block. In DataWeave, `CData` inherits from the type `String`.

## `DocType` Custom Type

`DocType` is a custom DataWeave data type for XML that is used to identify a doctype declaration
(DTD).

## Read and Write DTDs

_Introduced in DataWeave 2.5.0. Supported by Mule 4.5.0 and later._

DataWeave can read and write doctype declarations in XML files.

During the reading phase, DataWeave parses the doctype declarations and stores the content as
metadata of the root element. The `DocType` value is stored in the `docType` variable. You can use
the [metadata selector](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors) (`^`) to
extract the value of that variable with an expression like this one:

- `payload.^docType`

  See examples [Example: Read DTD value](#example12), [Example: Write a DTD Value](#example13), and
  [Example: Transform DTD Value to a String Representation](#example14).

You can use the [metadata selector](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors)
to access it.

NOTE

DTDs are disabled by default even if their declarations are read or written. For details, see XML
reader property `supportDtd` in [Reader Properties](#reader_properties).

## Examples

The following examples show uses of the XML format.

- [Example: Stream Input XML Data](#example1)

- [Example: Null or Empty String in XML](#example2)

- [Example: Output `null` Values for Missing XML Values](#example3)

- [Example: Output `null` Values for Missing XML Values](#example4)

- [Example: Represent XML Attributes in the DataWeave (dw) Format](#example5)

- [Example: Represent XML Namespaces in the DataWeave (dw) Format](#example6)

- [Example: Create a CDATA Element](#example7)

- [Example: Check for CDATA in a `String`](#example8)

- [Example: Use the `inlineCloseOn` Writer Property](#example9)

- [Example: Transforms Repeated JSON Keys to Repeated XML Elements](#example10)

- [Example: Transform XML Elements to JSON and Replace Characters](#example11)

- [Example: Read DTD value](#example12)

- [Example: Write a DTD Value](#example13)

- [Example: Transform DTD Value to a String Representation](#example14)

Refer to [DataWeave Formats](https://docs.mulesoft.com/dataweave/2.6/dataweave-formats) for more detail on available reader and writer
properties for various data formats.

### Example: Stream Input XML Data

This example shows how to set up XML streaming, which requires you to specify the following reader
properties:

- `streaming=true`

- `collectionPath="root.repeated"`

The `collectionPath` setting selects the elements to stream.

When streaming, the XML parser can start processing content without having all the XML content.

#### Input

The following XML serves as the input payload to the DataWeave source. Assume that it is the content
of an XML file `myXML.xml`.

myXML.xml

```xml
<root>
    <text>
        Text
    </text>
    <repeated>
        <user>
            <name>Mariano</name>
            <lastName>de Achaval</lastName>
            <age>36</age>
        </user>
        <user>
            <lastName>Shokida</lastName>
            <name>Leandro</name>
            <age>30</age>
        </user>
        <user>
            <age>29</age>
            <name>Ana</name>
            <lastName>Felissati</lastName>

        </user>
        <user>
            <age>29</age>
            <lastName>Chibana</lastName>
            <name>Christian</name>
        </user>

    </repeated>
</root>
```

#### Source

The reader property settings in the DataWeave script tell the XML reader to stream the input and
process the repeated keys. The script uses the DataWeave `map` function to iterate over the repeated
keys.

```dataweave
%dw 2.0
var myInput  readUrl('classpath://myXML.xml', 'application/xml', {streaming:true, collectionPath: "root.repeated"})
output application/dw
---
myInput.root.repeated.*user map {
    n: $.name,
    l: $.lastName,
    a: $.age
}
```

#### Output

The script transforms the mapped input XML to the DataWeave (dw) format and MIME type.

```json
[
  {
    "n": "Mariano",
    "l": "de Achaval",
    "a": "36"
  },
  {
    "n": "Leandro",
    "l": "Shokida",
    "a": "30"
  },
  {
    "n": "Ana",
    "l": "Felissati",
    "a": "29"
  },
  {
    "n": "Christian",
    "l": "Chibana",
    "a": "29"
  }
]
```

### Example: Null or Empty String in XML

Because there is no standard way to represent a `null` value in XML, the reader maps the value to
`null` when the `nil` attribute is set to `true`.

#### Input

The following XML serves as the input payload to the DataWeave source. Notice the `nil` setting in
`<xsi:nil="true"`/>.

```xml
<book xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <author xsi:nil="true"/>
</book>
```

#### Source

The DataWeave script transforms the input XML to the JSON format and MIME type.

```dataweave
%dw 2.0
output application/json
---
payload
```

#### Output

The output is in the JSON format. Notice that the `nil` value in the input is transformed to `null`.

```json
{
  "book": {
    "author": null
  }
}
```

### Example: Output `null` Values for Missing XML Values

The XML reader property `nullValueOn` accepts the value `blank` (the default) or `empty`.

This example uses the `nullValueOn` default, so it maps the values of the `title` and `author`
elements to `null`.

#### Input

The following XML serves as input to the DataWeave source. Notice that the `title` and `author`
elements lack values.

Assume that this input is content within the file, `myInput.xml`.

myXML.xml content:

```xml
<book>
    <author></author>
    <title>

</title>
</book>
```

#### Source

The DataWeave script transforms the XML input to JSON. Note that it explicitly sets the
`nullValueOn` default, `blank`, for demonstration purposes.

```dataweave
%dw 2.0
var myInput readUrl('classpath://myXML.xml', 'application/xml', {nullValueOn: "blank"})
output application/json
---
myInput
```

#### Output

The `title` and `author` keys in the JSON output are assigned `null` values.

```json
{
  "book": {
    "author": null,
    "title": null
  }
}
```

### Example: Output `null` Values for Missing XML Values

The XML reader property `nullValueOn` accepts the value `blank` (the default) or `empty`.

The example maps the value of the `title` element to a `String` and value of the `author` element to
`null` because the XML reader property `nullValueOn` is set to `empty`.

#### Input

The following XML serves as input to the DataWeave source. Notice that the `title` and `author`
elements lack values. The difference between the two elements is the space between the starting and
ending tags. The tags of the `title` element are separated by line breaks (the hidden characters,
`\n`), while the tags of the `author` element are not separated by any characters.

Assume that this input is content within the file, `myInput.xml`.

myXML.xml content:

```xml
<book>
    <author></author>
    <title>

</title>
</book>
```

#### Source

The DataWeave script uses a DataWeave variable to input the content of `myXML.xml` and applies the
`nullValueOn: "empty"` to it. The script transforms the XML input to JSON.

```dataweave
%dw 2.0
var myInput readUrl('classpath://myXML.xml', 'application/xml', {nullValueOn: "empty"})
output application/json
---
myInput
```

#### Output

The JSON output maps the value of the `author` element to `null` and value of the `title` element to
the `String` value `"\n\n"`, which is for the new line characters.

```json
{
  "book": {
    "author": null,
    "title": "\n\n"
  }
}
```

### Example: Represent XML Attributes in the DataWeave (dw) Format

This example maps XML attributes to a canonical DataWeave representation, the `application/dw`
format and MIME type.

#### Input

The XML serves as the input payload to the DataWeave source. Notice that the input contains XML
attributes.

```xml
<users>
  <company>MuleSoft</company>
  <user name="Leandro" lastName="Shokida"/>
  <user name="Mariano" lastName="Achaval"/>
</users>
```

#### Source

The DataWeave script transforms the XML input payload to the DataWeave (dw) format and MIME type.

```dataweave
%dw 2.0
output application/dw
---
payload
```

#### Output

The output shows how the DataWeave (dw) format represents the XML input. Notice how the attributes
from the XML input and the empty values are represented.

```dataweave
{
  users: {
    company: "MuleSoft",
    user @(name: "Leandro",lastName: "Shokida"): "",
    user @(name: "Mariano",lastName: "Achaval"): ""
  }
}
```

### Example: Represent XML Namespaces in the DataWeave (dw) Format

This example maps XML namespaces to a canonical DataWeave representation, the `application/dw`
format and MIME type.

#### Input

The XML serves as the input payload to the DataWeave source. Notice that the input contains XML
namespaces.

```xml
<root>
    <h:table xmlns:h="http://www.w3.org/TR/html4/">
      <h:tr>
        <h:td>Apples</h:td>
        <h:td>Bananas</h:td>
      </h:tr>
    </h:table>

    <f:table xmlns:f="https://www.w3schools.com/furniture">
      <f:name>African Coffee Table</f:name>
      <f:width>80</f:width>
      <f:length>120</f:length>
    </f:table>
</root>
```

#### Source

The DataWeave script transforms the XML input payload to the DataWeave (dw) format and MIME type.

```dataweave
%dw 2.0
output application/dw
---
payload
```

#### Output

The output shows how the DataWeave (dw) format represents the XML input. Notice how the namespaces
from the XML are represented.

```dataweave
ns h http://www.w3.org/TR/html4/
ns f https://www.w3schools.com/furniture
---
{
  root: {
      h#table: {
        h#tr: {
          h#td: "Apples",
          h#td: "Bananas"
        }
      },
      f#table: {
        f#name: "African Coffee Table",
        f#width: "80",
        f#length: "120"
      }
  }
}
```

### Example: Create a CDATA Element

This example shows how to use the `CData` type to create a CDATA element in the XML output.

#### Source

The body of the DataWeave script coerces the `String` value to the `CData` type.

```dataweave
%dw 2.0
output application/xml
---
{
    test: "A text <a>" as CData
}
```

#### Output

The output encloses the input `String` value in a CDATA block, which contains the special
characters, `<` and `>`, from the input.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<test><![CDATA[A text <a>]]></test>
```

### Example: Check for CDATA in a `String`

This example indicates whether a given `String` value is CDATA.

#### Input

The XML serves as the input payload to the DataWeave source. Notice that the `test` element contains
a CDATA block.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<test><![CDATA[A text <a>]]></test>
```

#### Source

The DataWeave script uses the `is CData` expression to determine whether the `String` value is
CDATA.

```dataweave
%dw 2.0
output application/json
---
{
    test: payload.test is CDATA
}
```

#### Output

The JSON output contains the value `true`, which indicates tha the input `String` value is CDATA.

```json
{
  "test": true
}
```

### Example: Use the `inlineCloseOn` Writer Property

This example uses the `inlineCloseOn` writer property with the value `none` to act on the key-value
pairs from the input.

#### Source

The DataWeave script transforms the body content to XML. Notice that values of the `emptyElement`
keys are `null`.

```dataweave
%dw 2.0
output application/xml inlineCloseOn="none"
---
{
  someXml: {
    parentElement: {
      emptyElement1: null,
      emptyElement2: null,
      emptyElement3: null
    }
  }
}
```

#### Output

The `emptyElement` elements are empty. They do not contain the value `null`.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<someXml>
  <parentElement>
    <emptyElement1></emptyElement1>
    <emptyElement2></emptyElement2>
    <emptyElement3></emptyElement3>
  </parentElement>
</someXml>
```

### Example: Transforms Repeated JSON Keys to Repeated XML Elements

XML encodes collections using repeated (unbounded) elements. DataWeave represents unbounded elements
by repeating the same key.

This example shows how to convert the repeated keys in a JSON array of objects into repeated XML
elements.

#### Input

The JSON input serves as the payload to the DataWeave source. Notice that the `name` keys in the
array are repeated.

```json
{
  "friends": [{ "name": "Mariano" }, { "name": "Shoki" }, { "name": "Tomo" }, { "name": "Ana" }]
}
```

#### Source

The DataWeave script selects the value of the `friends` key.

```dataweave
%dw 2.0
output application/xml
---
friends: {
    (payload.friends)
}
```

#### Output

The output represents the `name` keys as XML elements.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<friends>
  <name>Mariano</name>
  <name>Shoki</name>
  <name>Tomo</name>
  <name>Ana</name>
</friends>
```

See also,
[Example: Outputting Self-closing XML Tags](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-output-self-closing-xml-tags).

### Example: Transform XML Elements to JSON and Replace Characters

This example iterates over an XML file that contains details of employees, such as the `Id`, `Name`,
and `Address`, and converts the file into JSON format. The DataWeave script uses the `replace`
function to iterate over each `Address` element and replace the characters `-` and `/` with blank
space.

#### Input

The XML input serves as the payload to the DataWeave source. Notice that the `Address` element
contains `-` and `/` characters.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<root>
  <employees>
    <Id>1</Id>
    <Name>Mule</Name>
    <Address>MuleSoft Avenue - 123</Address>
  </employees>
  <employees>
    <Id>2</Id>
    <Name>Max</Name>
    <Address>MuleSoft Avenue-456/5/e</Address>
  </employees>
</root>
```

#### Source

The following DataWeave script iterates over the payload elements and performs a mapping to an
object. The instruction `payload01.Address replace /([\-\,\/])/ with " "` replaces the `-` and `/`
characters with blank spaces.

```dataweave
%dw 2.0
output application/json
---
payload.root.*employees map ((payload01 , indexOfPayload01) ->
  {
     Id: payload01.Id as String,
     Name: payload01.Name as String,
     Address: payload01.Address replace /([\-\,\/])/ with " "
  }
)
```

#### Output

The output represents the transformed XML elements into JSON.

```JSON
[
  {
    "Id": "1",
    "Name": "Mule",
    "Address": "MuleSoft Avenue   123"
  },
  {
    "Id": "2",
    "Name": "Max",
    "Address": "MuleSoft Avenue 456 5 e"
  }
]
```

### Example: Read DTD value

The following DataWeave script transforms the XML input payload that contains a `DocType` value into
JSON. Notice that extracts the value of that doctype directive using the expression
`payload.^docType`.

#### Input

```xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE cXML SYSTEM "http://xml.cxml.org/schemas/cXML/1.2.014/cXML.dtd">
<cXML xml:lang="en-US" payloadID="1615232861.000506@prd327utl1.int.coupahost.com" timestamp="2021-03-08T11:47:42-08:00">
    <Header>
        <From>
            <Credential domain="NetworkID">
                <Identity>TestIdentity</Identity>
            </Credential>
        </From>
        <To>
            <Credential domain="TEST">
                <Identity>Identity</Identity>
            </Credential>
        </To>
    </Header>
</cXML>
```

#### Source

```dataweave
%dw 2.0
output application/json
---
{
    header: {
        senderId: payload.cXML.Header.From.Credential.Identity,
        receiverId: payload.cXML.Header.To.Credential.Identity,
        docType: payload.^docType
    }
}
```

#### Output

```json
{
  "header": {
    "senderId": "Identity",
    "receiverId": "TestIdentity",
    "docType": {
      "rootName": "cXML",
      "systemId": "http://xml.cxml.org/schemas/cXML/1.2.014/cXML.dtd"
    }
  }
}
```

### Example: Write a DTD Value

This example shows how to use the `docType` metadata to create a `DocType` value in the XML output.

#### Source

```dataweave
%dw 2.0
output application/xml
ns xml http://www.w3.org/XML/1998/namespace

var cXmlObj = {
  cXML @(payloadID: "9949494", xml#lang: "en-US", timestamp: "2002-02-04T18:39:09-08:00"): {
      Header: {
        From: {
          Credential @(domain: "NetworkId"): {
            Identity: "Identity"
          }
        }
    }
  }
} as Object {
    docType: { rootName: "cXML", systemId: "http://xml.cXML.org/schemas/cXML/1.2.014/cXML.dtd" }
}
---
cXmlObj
```

#### Output

```xml
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE cXML SYSTEM "http://xml.cXML.org/schemas/cXML/1.2.014/cXML.dtd">
<cXML payloadID="9949494" xml:lang="en-US" timestamp="2002-02-04T18:39:09-08:00">
  <Header>
    <From>
      <Credential domain="NetworkId">
        <Identity>Identity</Identity>
      </Credential>
    </From>
  </Header>
</cXML>
```

### Example: Transform DTD Value to a String Representation

This example uses [Dtd Module (dw::xml::Dtd)](https://docs.mulesoft.com/dataweave/2.6/dw-dtd) to transform a `DocType` value that includes a
`systemId` to a string representation.

#### Input

```xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE cXML SYSTEM "http://xml.cxml.org/schemas/cXML/1.2.014/cXML.dtd">
<cXML xml:lang="en-US" payloadID="1615232861.000506@prd327utl1.int.coupahost.com" timestamp="2021-03-08T11:47:42-08:00">
    <Header>
        <From>
            <Credential domain="NetworkID">
                <Identity>Identity</Identity>
            </Credential>
        </From>
        <To>
            <Credential domain="TEST">
                <Identity>Identity</Identity>
            </Credential>
        </To>
    </Header>
</cXML>
```

#### Source

```dataweave
%dw 2.0
output application/json
import * from dw::xml::Dtd
---
docTypeAsString(payload.^docType)
```

#### Output

```JSON
"cXML SYSTEM http://xml.cxml.org/schemas/cXML/1.2.014/cXML.dtd"
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>collectionPath</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Sets the path to the location in the document where the collection is located. Accepts a path expression that identifies the location of the elements to stream.</p></div></div></td></tr><tr><td><p><code>externalEntities</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Indicates whether to process external entities. Disabled by default to avoid XML External Entity (XXE) attacks.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>indexedReader</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Uses the indexed reader by default when reaching the threshold. Supports US-ASCII, UTF-8 and ISO-8859-1 encodings only. For other encodings, DataWeave uses the in-memory reader.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>maxAttributeSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>-1</code></p></td><td><div><div><p>Sets the maximum number of characters accepted in an XML attribute. <em>Available since Mule 4.2.1.</em></p></div></div></td></tr><tr><td><p><code>maxEntityCount</code></p></td><td><p><code>Number</code></p></td><td><p><code>1</code></p></td><td><div><div><p>Sets the maximum number of entity expansions. The limit helps avoid Billion Laughs attacks.</p></div></div></td></tr><tr><td><p><code>nullValueOn</code></p></td><td><p><code>String</code></p></td><td><p><code>'blank'</code></p></td><td><div><div><p>Indicates whether to read an element with empty or blank text as a <code>null</code> value.</p></div><div><p>Valid values are <code>empty</code> or <code>none</code> or <code>blank</code>.</p></div></div></td></tr><tr><td><p><code>optimizeFor</code></p></td><td><p><code>String</code></p></td><td><p><code>'speed'</code></p></td><td><div><div><p>Configures the type of optimization for the XML parser to use.</p></div><div><p>Valid values are <code>speed</code> or <code>memory</code>.</p></div></div></td></tr><tr><td><p><code>streaming</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Streams input when set to <code>true</code>. Use only if entries are accessed sequentially. The input must be a top-level array. See the <a href="#example2">streaming example</a>, and see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats#dw_readers_writers">DataWeave Readers</a>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>supportDtd</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Enable or disable DTD support. Disabling skips (and does not process) internal and external subsets. You can also enable this property by setting the Mule system property <code>com.mulesoft.dw.xml.supportDTD</code>. Note that the default for this property changed from <code>true</code> to <code>false</code> in Mule version 4.3.0-20210601, which includes the June 2021 patch of DataWeave version 2.3.0.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>defaultNamespace</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Specifies the default namespaces of the output XML.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>doubleQuoteInDeclaration</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Escapes double quotes in the XML declaration when set to <code>true</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr><tr><td><p><code>escapeCR</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Escapes <code>CR</code> characters when set to <code>true</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>escapeGT</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Escapes '&gt;' characters when set to <code>true</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>indent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Write indented output for better readability by default, or compress output into a single line when set to <code>false</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>inlineCloseOn</code></p></td><td><p><code>String</code></p></td><td><p><code>'empty'</code></p></td><td><div><div><p>Write an inline close tag, or explicitly open and close tags when the value is <code>null</code>.</p></div><div><p>Valid values are <code>empty</code> or <code>none</code>.</p></div></div></td></tr><tr><td><p><code>onInvalidChar</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Valid values are <code>base64</code> or <code>ignore</code> or <code>none</code>.</p></div></div></td></tr><tr><td><p><code>skipNullOn</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Skips <code>null</code> values in the specified data structure. By default, DataWeave does not skip the values.</p></div><div><ul><li><p><code>elements</code> + Ignore and omit <code>null</code> elements inside XML output, for example, with <code>output application/xml skipNullOn="arrays"</code>.</p></li><li><p><code>attributes ` + Ignore and omit `null</code> attributes inside XML, for example, with <code>output application/xml skipNullOn="objects"</code>.</p></li><li><p><code>everywhere</code> + Apply <code>skipNullOn</code> to elements and attributes, for example, <code>output application/xml skipNullOn="everywhere"</code>.</p></li></ul></div><div><p>Valid values are <code>elements</code> or <code>attributes</code> or <code>everywhere</code>.</p></div></div></td></tr><tr><td><p><code>writeDeclaration</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Writes the XML header declaration when set to <code>true</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>writeDeclaredNamespaces</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Marks the namespaces to declare in the root element of the XML:</p></div><div><ul><li><p><code>All</code>: Write all declared namespaces in the root element.</p></li><li><p><code>ids:&lt;comma separated namespace id&gt;</code>: Write only the specified namespaces.</p></li><li><p><code>regex:&lt;regex&gt;</code>: Write only the matching namespaces.</p></li></ul></div></div></td></tr><tr><td><p><code>writeNilOnNull</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Writes the <code>nil</code> attribute for a <code>null</code> value when this property is set to <code>true</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/xml</code></p></td></tr><tr><td><p><code><strong>/</strong>+xml</code></p></td></tr></tbody></table>

<!-- document id=c31e8bf710c16708f43d9c565e9729743494f6d152838da1178d6ce8362b5a2b url=/mulesoft/current/en-us/dataweave/2.9/dataweave-formats-xml.md -->

---
product: DataWeave
version: 2.9
keywords: format, xml, */xml, */*+xml, application/xml
---

# XML Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/xml`

ID: `xml`

The XML data structure is mapped to DataWeave objects that can contain other objects, strings, or
`null` values. XML uses unbounded elements to represent collections, which are mapped to repeated
keys in DataWeave objects. In addition, DataWeave natively supports `namespaces`, `CData` an
`xsi:types`.

The DataWeave reader for XML input supports the following parsing strategies:

- Indexed

- In-Memory

- Streaming

To understand the parsing strategies that DataWeave readers and writers can apply to this format,
see [DataWeave Parsing Strategies](https://docs.mulesoft.com/dataweave/2.9/dataweave-formats#dw_readers_writers).

## `CData` Custom Type

`CData` is a custom DataWeave data type for XML that is used to identify a character data (CDATA)
block. The `CData` type makes the XML writer wrap content inside a `CDATA` block or to check for an
input string inside a `CDATA` block. In DataWeave, `CData` inherits from the type `String`.

## `DocType` Custom Type

`DocType` is a custom DataWeave data type for XML that is used to identify a doctype declaration
(DTD).

## Read and Write DTDs

_Introduced in DataWeave 2.5.0. Supported by Mule 4.5.0 and later._

DataWeave can read and write doctype declarations in XML files.

During the reading phase, DataWeave parses the doctype declarations and stores the content as
metadata of the root element. The `DocType` value is stored in the `docType` variable. You can use
the [metadata selector](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors) (`^`) to
extract the value of that variable with an expression like this one:

- `payload.^docType`

  See examples [Example: Read DTD value](#example12), [Example: Write a DTD Value](#example13), and
  [Example: Transform DTD Value to a String Representation](#example14).

  NOTE

  DTDs are disabled by default even if their declarations are read or written. For details, see XML
  reader property `supportDtd` in [Reader Properties](#reader_properties).

## Examples

The following examples show uses of the XML format.

- [Example: Stream Input XML Data](#example1)

- [Example: Null or Empty String in XML](#example2)

- [Example: Output `null` Values for Missing XML Values](#example3)

- [Example: Output `null` Values for Missing XML Values](#example4)

- [Example: Represent XML Attributes in the DataWeave (dw) Format](#example5)

- [Example: Represent XML Namespaces in the DataWeave (dw) Format](#example6)

- [Example: Create a CDATA Element](#example7)

- [Example: Check for CDATA in a `String`](#example8)

- [Example: Use the `inlineCloseOn` Writer Property](#example9)

- [Example: Transforms Repeated JSON Keys to Repeated XML Elements](#example10)

- [Example: Transform XML Elements to JSON and Replace Characters](#example11)

- [Example: Read DTD value](#example12)

- [Example: Write a DTD Value](#example13)

- [Example: Transform DTD Value to a String Representation](#example14)

Refer to [DataWeave Formats](https://docs.mulesoft.com/dataweave/2.9/dataweave-formats) for more detail on available reader and writer
properties for various data formats.

### Example: Stream Input XML Data

This example shows how to set up XML streaming, which requires you to specify the following reader
properties:

- `streaming=true`

- `collectionPath="root.repeated"`

The `collectionPath` setting selects the elements to stream.

When streaming, the XML parser can start processing content without having all the XML content.

#### Input

The following XML serves as the input payload to the DataWeave source. Assume that it is the content
of an XML file `myXML.xml`.

myXML.xml

```xml
<root>
    <text>
        Text
    </text>
    <repeated>
        <user>
            <name>Mariano</name>
            <lastName>de Achaval</lastName>
            <age>36</age>
        </user>
        <user>
            <lastName>Shokida</lastName>
            <name>Leandro</name>
            <age>30</age>
        </user>
        <user>
            <age>29</age>
            <name>Ana</name>
            <lastName>Felissati</lastName>

        </user>
        <user>
            <age>29</age>
            <lastName>Chibana</lastName>
            <name>Christian</name>
        </user>

    </repeated>
</root>
```

#### Source

The reader property settings in the DataWeave script tell the XML reader to stream the input and
process the repeated keys. The script uses the DataWeave `map` function to iterate over the repeated
keys.

```dataweave
%dw 2.0
var myInput  readUrl('classpath://myXML.xml', 'application/xml', {streaming:true, collectionPath: "root.repeated"})
output application/dw
---
myInput.root.repeated.*user map {
    n: $.name,
    l: $.lastName,
    a: $.age
}
```

#### Output

The script transforms the mapped input XML to the DataWeave (dw) format and MIME type.

```json
[
  {
    "n": "Mariano",
    "l": "de Achaval",
    "a": "36"
  },
  {
    "n": "Leandro",
    "l": "Shokida",
    "a": "30"
  },
  {
    "n": "Ana",
    "l": "Felissati",
    "a": "29"
  },
  {
    "n": "Christian",
    "l": "Chibana",
    "a": "29"
  }
]
```

### Example: Null or Empty String in XML

Because there is no standard way to represent a `null` value in XML, the reader maps the value to
`null` when the `nil` attribute is set to `true`.

#### Input

The following XML serves as the input payload to the DataWeave source. Notice the `nil` setting in
`<xsi:nil="true"`/>.

```xml
<book xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <author xsi:nil="true"/>
</book>
```

#### Source

The DataWeave script transforms the input XML to the JSON format and MIME type.

```dataweave
%dw 2.0
output application/json
---
payload
```

#### Output

The output is in the JSON format. Notice that the `nil` value in the input is transformed to `null`.

```json
{
  "book": {
    "author": null
  }
}
```

### Example: Output `null` Values for Missing XML Values

The XML reader property `nullValueOn` accepts the value `blank` (the default) or `empty`.

This example uses the `nullValueOn` default, so it maps the values of the `title` and `author`
elements to `null`.

#### Input

The following XML serves as input to the DataWeave source. Notice that the `title` and `author`
elements lack values.

Assume that this input is content within the file, `myInput.xml`.

myXML.xml content:

```xml
<book>
    <author></author>
    <title>

</title>
</book>
```

#### Source

The DataWeave script transforms the XML input to JSON. Note that it explicitly sets the
`nullValueOn` default, `blank`, for demonstration purposes.

```dataweave
%dw 2.0
var myInput readUrl('classpath://myXML.xml', 'application/xml', {nullValueOn: "blank"})
output application/json
---
myInput
```

#### Output

The `title` and `author` keys in the JSON output are assigned `null` values.

```json
{
  "book": {
    "author": null,
    "title": null
  }
}
```

### Example: Output `null` Values for Missing XML Values

The XML reader property `nullValueOn` accepts the value `blank` (the default) or `empty`.

The example maps the value of the `title` element to a `String` and value of the `author` element to
`null` because the XML reader property `nullValueOn` is set to `empty`.

#### Input

The following XML serves as input to the DataWeave source. Notice that the `title` and `author`
elements lack values. The difference between the two elements is the space between the starting and
ending tags. The tags of the `title` element are separated by line breaks (the hidden characters,
`\n`), while the tags of the `author` element are not separated by any characters.

Assume that this input is content within the file, `myInput.xml`.

myXML.xml content:

```xml
<book>
    <author></author>
    <title>

</title>
</book>
```

#### Source

The DataWeave script uses a DataWeave variable to input the content of `myXML.xml` and applies the
`nullValueOn: "empty"` to it. The script transforms the XML input to JSON.

```dataweave
%dw 2.0
var myInput readUrl('classpath://myXML.xml', 'application/xml', {nullValueOn: "empty"})
output application/json
---
myInput
```

#### Output

The JSON output maps the value of the `author` element to `null` and value of the `title` element to
the `String` value `"\n\n"`, which is for the new line characters.

```json
{
  "book": {
    "author": null,
    "title": "\n\n"
  }
}
```

### Example: Represent XML Attributes in the DataWeave (dw) Format

This example maps XML attributes to a canonical DataWeave representation, the `application/dw`
format and MIME type.

#### Input

The XML serves as the input payload to the DataWeave source. Notice that the input contains XML
attributes.

```xml
<users>
  <company>MuleSoft</company>
  <user name="Leandro" lastName="Shokida"/>
  <user name="Mariano" lastName="Achaval"/>
</users>
```

#### Source

The DataWeave script transforms the XML input payload to the DataWeave (dw) format and MIME type.

```dataweave
%dw 2.0
output application/dw
---
payload
```

#### Output

The output shows how the DataWeave (dw) format represents the XML input. Notice how the attributes
from the XML input and the empty values are represented.

```dataweave
{
  users: {
    company: "MuleSoft",
    user @(name: "Leandro",lastName: "Shokida"): "",
    user @(name: "Mariano",lastName: "Achaval"): ""
  }
}
```

### Example: Represent XML Namespaces in the DataWeave (dw) Format

This example maps XML namespaces to a canonical DataWeave representation, the `application/dw`
format and MIME type.

#### Input

The XML serves as the input payload to the DataWeave source. Notice that the input contains XML
namespaces.

```xml
<root>
    <h:table xmlns:h="http://www.w3.org/TR/html4/">
      <h:tr>
        <h:td>Apples</h:td>
        <h:td>Bananas</h:td>
      </h:tr>
    </h:table>

    <f:table xmlns:f="https://www.w3schools.com/furniture">
      <f:name>African Coffee Table</f:name>
      <f:width>80</f:width>
      <f:length>120</f:length>
    </f:table>
</root>
```

#### Source

The DataWeave script transforms the XML input payload to the DataWeave (dw) format and MIME type.

```dataweave
%dw 2.0
output application/dw
---
payload
```

#### Output

The output shows how the DataWeave (dw) format represents the XML input. Notice how the namespaces
from the XML are represented.

```dataweave
ns h http://www.w3.org/TR/html4/
ns f https://www.w3schools.com/furniture
---
{
  root: {
      h#table: {
        h#tr: {
          h#td: "Apples",
          h#td: "Bananas"
        }
      },
      f#table: {
        f#name: "African Coffee Table",
        f#width: "80",
        f#length: "120"
      }
  }
}
```

### Example: Create a CDATA Element

This example shows how to use the `CData` type to create a CDATA element in the XML output.

#### Source

The body of the DataWeave script coerces the `String` value to the `CData` type.

```dataweave
%dw 2.0
output application/xml
---
{
    test: "A text <a>" as CData
}
```

#### Output

The output encloses the input `String` value in a CDATA block, which contains the special
characters, `<` and `>`, from the input.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<test><![CDATA[A text <a>]]></test>
```

### Example: Check for CDATA in a `String`

This example indicates whether a given `String` value is CDATA.

#### Input

The XML serves as the input payload to the DataWeave source. Notice that the `test` element contains
a CDATA block.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<test><![CDATA[A text <a>]]></test>
```

#### Source

The DataWeave script uses the `is CData` expression to determine whether the `String` value is
CDATA.

```dataweave
%dw 2.0
output application/json
---
{
    test: payload.test is CDATA
}
```

#### Output

The JSON output contains the value `true`, which indicates tha the input `String` value is CDATA.

```json
{
  "test": true
}
```

### Example: Use the `inlineCloseOn` Writer Property

This example uses the `inlineCloseOn` writer property with the value `none` to act on the key-value
pairs from the input.

#### Source

The DataWeave script transforms the body content to XML. Notice that values of the `emptyElement`
keys are `null`.

```dataweave
%dw 2.0
output application/xml inlineCloseOn="none"
---
{
  someXml: {
    parentElement: {
      emptyElement1: null,
      emptyElement2: null,
      emptyElement3: null
    }
  }
}
```

#### Output

The `emptyElement` elements are empty. They do not contain the value `null`.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<someXml>
  <parentElement>
    <emptyElement1></emptyElement1>
    <emptyElement2></emptyElement2>
    <emptyElement3></emptyElement3>
  </parentElement>
</someXml>
```

### Example: Transforms Repeated JSON Keys to Repeated XML Elements

XML encodes collections using repeated (unbounded) elements. DataWeave represents unbounded elements
by repeating the same key.

This example shows how to convert the repeated keys in a JSON array of objects into repeated XML
elements.

#### Input

The JSON input serves as the payload to the DataWeave source. Notice that the `name` keys in the
array are repeated.

```json
{
  "friends": [{ "name": "Mariano" }, { "name": "Shoki" }, { "name": "Tomo" }, { "name": "Ana" }]
}
```

#### Source

The DataWeave script selects the value of the `friends` key.

```dataweave
%dw 2.0
output application/xml
---
friends: {
    (payload.friends)
}
```

#### Output

The output represents the `name` keys as XML elements.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<friends>
  <name>Mariano</name>
  <name>Shoki</name>
  <name>Tomo</name>
  <name>Ana</name>
</friends>
```

See also,
[Example: Outputting Self-closing XML Tags](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-output-self-closing-xml-tags).

### Example: Transform XML Elements to JSON and Replace Characters

This example iterates over an XML file that contains details of employees, such as the `Id`, `Name`,
and `Address`, and converts the file into JSON format. The DataWeave script uses the `replace`
function to iterate over each `Address` element and replace the characters `-` and `/` with blank
space.

#### Input

The XML input serves as the payload to the DataWeave source. Notice that the `Address` element
contains `-` and `/` characters.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<root>
  <employees>
    <Id>1</Id>
    <Name>Mule</Name>
    <Address>MuleSoft Avenue - 123</Address>
  </employees>
  <employees>
    <Id>2</Id>
    <Name>Max</Name>
    <Address>MuleSoft Avenue-456/5/e</Address>
  </employees>
</root>
```

#### Source

The following DataWeave script iterates over the payload elements and performs a mapping to an
object. The instruction `payload01.Address replace /([\-\,\/])/ with " "` replaces the `-` and `/`
characters with blank spaces.

```dataweave
%dw 2.0
output application/json
---
payload.root.*employees map ((payload01 , indexOfPayload01) ->
  {
     Id: payload01.Id as String,
     Name: payload01.Name as String,
     Address: payload01.Address replace /([\-\,\/])/ with " "
  }
)
```

#### Output

The output represents the transformed XML elements into JSON.

```JSON
[
  {
    "Id": "1",
    "Name": "Mule",
    "Address": "MuleSoft Avenue   123"
  },
  {
    "Id": "2",
    "Name": "Max",
    "Address": "MuleSoft Avenue 456 5 e"
  }
]
```

### Example: Read DTD value

The following DataWeave script transforms the XML input payload that contains a `DocType` value into
JSON. Notice that extracts the value of that doctype directive using the expression
`payload.^docType`.

#### Input

```xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE cXML SYSTEM "http://xml.cxml.org/schemas/cXML/1.2.014/cXML.dtd">
<cXML xml:lang="en-US" payloadID="1615232861.000506@prd327utl1.int.coupahost.com" timestamp="2021-03-08T11:47:42-08:00">
    <Header>
        <From>
            <Credential domain="NetworkID">
                <Identity>TestIdentity</Identity>
            </Credential>
        </From>
        <To>
            <Credential domain="TEST">
                <Identity>Identity</Identity>
            </Credential>
        </To>
    </Header>
</cXML>
```

#### Source

```dataweave
%dw 2.0
output application/json
---
{
    header: {
        senderId: payload.cXML.Header.From.Credential.Identity,
        receiverId: payload.cXML.Header.To.Credential.Identity,
        docType: payload.^docType
    }
}
```

#### Output

```json
{
  "header": {
    "senderId": "Identity",
    "receiverId": "TestIdentity",
    "docType": {
      "rootName": "cXML",
      "systemId": "http://xml.cxml.org/schemas/cXML/1.2.014/cXML.dtd"
    }
  }
}
```

### Example: Write a DTD Value

This example shows how to use the `docType` metadata to create a `DocType` value in the XML output.

#### Source

```dataweave
%dw 2.0
output application/xml
ns xml http://www.w3.org/XML/1998/namespace

var cXmlObj = {
  cXML @(payloadID: "9949494", xml#lang: "en-US", timestamp: "2002-02-04T18:39:09-08:00"): {
      Header: {
        From: {
          Credential @(domain: "NetworkId"): {
            Identity: "Identity"
          }
        }
    }
  }
} as Object {
    docType: { rootName: "cXML", systemId: "http://xml.cXML.org/schemas/cXML/1.2.014/cXML.dtd" }
}
---
cXmlObj
```

#### Output

```xml
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE cXML SYSTEM "http://xml.cXML.org/schemas/cXML/1.2.014/cXML.dtd">
<cXML payloadID="9949494" xml:lang="en-US" timestamp="2002-02-04T18:39:09-08:00">
  <Header>
    <From>
      <Credential domain="NetworkId">
        <Identity>Identity</Identity>
      </Credential>
    </From>
  </Header>
</cXML>
```

### Example: Transform DTD Value to a String Representation

This example uses [Dtd Module (dw::xml::Dtd)](https://docs.mulesoft.com/dataweave/2.9/dw-dtd) to transform a `DocType` value that includes a
`systemId` to a string representation.

#### Input

```xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE cXML SYSTEM "http://xml.cxml.org/schemas/cXML/1.2.014/cXML.dtd">
<cXML xml:lang="en-US" payloadID="1615232861.000506@prd327utl1.int.coupahost.com" timestamp="2021-03-08T11:47:42-08:00">
    <Header>
        <From>
            <Credential domain="NetworkID">
                <Identity>Identity</Identity>
            </Credential>
        </From>
        <To>
            <Credential domain="TEST">
                <Identity>Identity</Identity>
            </Credential>
        </To>
    </Header>
</cXML>
```

#### Source

```dataweave
%dw 2.0
output application/json
import * from dw::xml::Dtd
---
docTypeAsString(payload.^docType)
```

#### Output

```JSON
"cXML SYSTEM http://xml.cxml.org/schemas/cXML/1.2.014/cXML.dtd"
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>collectionPath</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Sets the path to the location in the document where the collection is located. Accepts a path expression that identifies the location of the elements to stream.</p></div></div></td></tr><tr><td><p><code>externalEntities</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Indicates whether to process external entities. Disabled by default to avoid XML External Entity (XXE) attacks.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>indexedReader</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Uses the indexed reader by default when reaching the threshold. Supports US-ASCII, UTF-8 and ISO-8859-1 encodings only. For other encodings, DataWeave uses the in-memory reader.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>maxAttributeSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>-1</code></p></td><td><div><div><p>Sets the maximum number of characters accepted in an XML attribute. <em>Available since Mule 4.2.1.</em></p></div></div></td></tr><tr><td><p><code>maxEntityCount</code></p></td><td><p><code>Number</code></p></td><td><p><code>1</code></p></td><td><div><div><p>Sets the maximum number of entity expansions. The limit helps avoid Billion Laughs attacks.</p></div></div></td></tr><tr><td><p><code>nullValueOn</code></p></td><td><p><code>String</code></p></td><td><p><code>'blank'</code></p></td><td><div><div><p>Indicates whether to read an element with empty or blank text as a <code>null</code> value.</p></div><div><p>Valid values are <code>empty</code> or <code>none</code> or <code>blank</code>.</p></div></div></td></tr><tr><td><p><code>optimizeFor</code></p></td><td><p><code>String</code></p></td><td><p><code>'speed'</code></p></td><td><div><div><p>Configures the type of optimization for the XML parser to use.</p></div><div><p>Valid values are <code>speed</code> or <code>memory</code>.</p></div></div></td></tr><tr><td><p><code>streaming</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Streams input when set to <code>true</code>. Use only if entries are accessed sequentially. The input must be a top-level array. See the <a href="#example2">streaming example</a>, and see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats#dw_readers_writers">DataWeave Readers</a>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>supportDtd</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Enable or disable DTD support. Disabling skips (and does not process) internal and external subsets. You can also enable this property by setting the Mule system property <code>com.mulesoft.dw.xml.supportDTD</code>. Note that the default for this property changed from <code>true</code> to <code>false</code> in Mule version 4.3.0-20210601, which includes the June 2021 patch of DataWeave version 2.3.0.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>defaultNamespace</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Specifies the default namespaces of the output XML.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>doubleQuoteInDeclaration</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Escapes double quotes in the XML declaration when set to <code>true</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr><tr><td><p><code>escapeCR</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Escapes <code>CR</code> characters when set to <code>true</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>escapeGT</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Escapes '&gt;' characters when set to <code>true</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>indent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Write indented output for better readability by default, or compress output into a single line when set to <code>false</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>inlineCloseOn</code></p></td><td><p><code>String</code></p></td><td><p><code>'empty'</code></p></td><td><div><div><p>Write an inline close tag, or explicitly open and close tags when the value is <code>null</code>.</p></div><div><p>Valid values are <code>empty</code> or <code>none</code>.</p></div></div></td></tr><tr><td><p><code>onInvalidChar</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Valid values are <code>base64</code> or <code>ignore</code> or <code>none</code>.</p></div></div></td></tr><tr><td><p><code>skipNullOn</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Skips <code>null</code> values in the specified data structure. By default, DataWeave does not skip the values.</p></div><div><ul><li><p><code>elements</code> + Ignore and omit <code>null</code> elements inside XML output, for example, with <code>output application/xml skipNullOn="arrays"</code>.</p></li><li><p><code>attributes ` + Ignore and omit `null</code> attributes inside XML, for example, with <code>output application/xml skipNullOn="objects"</code>.</p></li><li><p><code>everywhere</code> + Apply <code>skipNullOn</code> to elements and attributes, for example, <code>output application/xml skipNullOn="everywhere"</code>.</p></li></ul></div><div><p>Valid values are <code>elements</code> or <code>attributes</code> or <code>everywhere</code>.</p></div></div></td></tr><tr><td><p><code>writeDeclaration</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Writes the XML header declaration when set to <code>true</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>writeDeclaredNamespaces</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Marks the namespaces to declare in the root element of the XML:</p></div><div><ul><li><p><code>All</code>: Write all declared namespaces in the root element.</p></li><li><p><code>ids:&lt;comma separated namespace id&gt;</code>: Write only the specified namespaces.</p></li><li><p><code>regex:&lt;regex&gt;</code>: Write only the matching namespaces.</p></li></ul></div></div></td></tr><tr><td><p><code>writeNilOnNull</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Writes the <code>nil</code> attribute for a <code>null</code> value when this property is set to <code>true</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/xml</code></p></td></tr><tr><td><p><code><strong>/</strong>+xml</code></p></td></tr></tbody></table>

<!-- document id=d8b833ef480ef5fe0faea52ced81c4ee05f49633f6e9253d726c4fb687a85202 url=/mulesoft/current/en-us/dataweave/latest/dataweave-formats-xml.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: format, xml, */xml, */*+xml, application/xml
---

# XML Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/xml`

ID: `xml`

The XML data structure is mapped to DataWeave objects that can contain other objects, strings, or
`null` values. XML uses unbounded elements to represent collections, which are mapped to repeated
keys in DataWeave objects. In addition, DataWeave natively supports `namespaces`, `CData` an
`xsi:types`.

The DataWeave reader for XML input supports the following parsing strategies:

- Indexed

- In-Memory

- Streaming

To understand the parsing strategies that DataWeave readers and writers can apply to this format,
see [DataWeave Parsing Strategies](https://docs.mulesoft.com/dataweave/latest/dataweave-formats#dw_readers_writers).

## `CData` Custom Type

`CData` is a custom DataWeave data type for XML that is used to identify a character data (CDATA)
block. The `CData` type makes the XML writer wrap content inside a `CDATA` block or to check for an
input string inside a `CDATA` block. In DataWeave, `CData` inherits from the type `String`.

## `DocType` Custom Type

`DocType` is a custom DataWeave data type for XML that is used to identify a doctype declaration
(DTD).

## Read and Write DTDs

_Introduced in DataWeave 2.5.0. Supported by Mule 4.5.0 and later._

DataWeave can read and write doctype declarations in XML files.

During the reading phase, DataWeave parses the doctype declarations and stores the content as
metadata of the root element. The `DocType` value is stored in the `docType` variable. You can use
the [metadata selector](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors) (`^`) to
extract the value of that variable with an expression like this one:

- `payload.^docType`

  See examples [Example: Read DTD value](#example12), [Example: Write a DTD Value](#example13), and
  [Example: Transform DTD Value to a String Representation](#example14).

  NOTE

  DTDs are disabled by default even if their declarations are read or written. For details, see XML
  reader property `supportDtd` in [Reader Properties](#reader_properties).

## Examples

The following examples show uses of the XML format.

- [Example: Stream Input XML Data](#example1)

- [Example: Null or Empty String in XML](#example2)

- [Example: Output `null` Values for Missing XML Values](#example3)

- [Example: Output `null` Values for Missing XML Values](#example4)

- [Example: Represent XML Attributes in the DataWeave (dw) Format](#example5)

- [Example: Represent XML Namespaces in the DataWeave (dw) Format](#example6)

- [Example: Create a CDATA Element](#example7)

- [Example: Check for CDATA in a `String`](#example8)

- [Example: Use the `inlineCloseOn` Writer Property](#example9)

- [Example: Transforms Repeated JSON Keys to Repeated XML Elements](#example10)

- [Example: Transform XML Elements to JSON and Replace Characters](#example11)

- [Example: Read DTD value](#example12)

- [Example: Write a DTD Value](#example13)

- [Example: Transform DTD Value to a String Representation](#example14)

Refer to [DataWeave Formats](https://docs.mulesoft.com/dataweave/latest/dataweave-formats) for more detail on available reader and writer
properties for various data formats.

### Example: Stream Input XML Data

This example shows how to set up XML streaming, which requires you to specify the following reader
properties:

- `streaming=true`

- `collectionPath="root.repeated"`

The `collectionPath` setting selects the elements to stream.

When streaming, the XML parser can start processing content without having all the XML content.

#### Input

The following XML serves as the input payload to the DataWeave source. Assume that it is the content
of an XML file `myXML.xml`.

myXML.xml

```xml
<root>
    <text>
        Text
    </text>
    <repeated>
        <user>
            <name>Mariano</name>
            <lastName>de Achaval</lastName>
            <age>36</age>
        </user>
        <user>
            <lastName>Shokida</lastName>
            <name>Leandro</name>
            <age>30</age>
        </user>
        <user>
            <age>29</age>
            <name>Ana</name>
            <lastName>Felissati</lastName>

        </user>
        <user>
            <age>29</age>
            <lastName>Chibana</lastName>
            <name>Christian</name>
        </user>

    </repeated>
</root>
```

#### Source

The reader property settings in the DataWeave script tell the XML reader to stream the input and
process the repeated keys. The script uses the DataWeave `map` function to iterate over the repeated
keys.

```dataweave
%dw 2.0
var myInput  readUrl('classpath://myXML.xml', 'application/xml', {streaming:true, collectionPath: "root.repeated"})
output application/dw
---
myInput.root.repeated.*user map {
    n: $.name,
    l: $.lastName,
    a: $.age
}
```

#### Output

The script transforms the mapped input XML to the DataWeave (dw) format and MIME type.

```json
[
  {
    "n": "Mariano",
    "l": "de Achaval",
    "a": "36"
  },
  {
    "n": "Leandro",
    "l": "Shokida",
    "a": "30"
  },
  {
    "n": "Ana",
    "l": "Felissati",
    "a": "29"
  },
  {
    "n": "Christian",
    "l": "Chibana",
    "a": "29"
  }
]
```

### Example: Null or Empty String in XML

Because there is no standard way to represent a `null` value in XML, the reader maps the value to
`null` when the `nil` attribute is set to `true`.

#### Input

The following XML serves as the input payload to the DataWeave source. Notice the `nil` setting in
`<xsi:nil="true"`/>.

```xml
<book xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <author xsi:nil="true"/>
</book>
```

#### Source

The DataWeave script transforms the input XML to the JSON format and MIME type.

```dataweave
%dw 2.0
output application/json
---
payload
```

#### Output

The output is in the JSON format. Notice that the `nil` value in the input is transformed to `null`.

```json
{
  "book": {
    "author": null
  }
}
```

### Example: Output `null` Values for Missing XML Values

The XML reader property `nullValueOn` accepts the value `blank` (the default) or `empty`.

This example uses the `nullValueOn` default, so it maps the values of the `title` and `author`
elements to `null`.

#### Input

The following XML serves as input to the DataWeave source. Notice that the `title` and `author`
elements lack values.

Assume that this input is content within the file, `myInput.xml`.

myXML.xml content:

```xml
<book>
    <author></author>
    <title>

</title>
</book>
```

#### Source

The DataWeave script transforms the XML input to JSON. Note that it explicitly sets the
`nullValueOn` default, `blank`, for demonstration purposes.

```dataweave
%dw 2.0
var myInput readUrl('classpath://myXML.xml', 'application/xml', {nullValueOn: "blank"})
output application/json
---
myInput
```

#### Output

The `title` and `author` keys in the JSON output are assigned `null` values.

```json
{
  "book": {
    "author": null,
    "title": null
  }
}
```

### Example: Output `null` Values for Missing XML Values

The XML reader property `nullValueOn` accepts the value `blank` (the default) or `empty`.

The example maps the value of the `title` element to a `String` and value of the `author` element to
`null` because the XML reader property `nullValueOn` is set to `empty`.

#### Input

The following XML serves as input to the DataWeave source. Notice that the `title` and `author`
elements lack values. The difference between the two elements is the space between the starting and
ending tags. The tags of the `title` element are separated by line breaks (the hidden characters,
`\n`), while the tags of the `author` element are not separated by any characters.

Assume that this input is content within the file, `myInput.xml`.

myXML.xml content:

```xml
<book>
    <author></author>
    <title>

</title>
</book>
```

#### Source

The DataWeave script uses a DataWeave variable to input the content of `myXML.xml` and applies the
`nullValueOn: "empty"` to it. The script transforms the XML input to JSON.

```dataweave
%dw 2.0
var myInput readUrl('classpath://myXML.xml', 'application/xml', {nullValueOn: "empty"})
output application/json
---
myInput
```

#### Output

The JSON output maps the value of the `author` element to `null` and value of the `title` element to
the `String` value `"\n\n"`, which is for the new line characters.

```json
{
  "book": {
    "author": null,
    "title": "\n\n"
  }
}
```

### Example: Represent XML Attributes in the DataWeave (dw) Format

This example maps XML attributes to a canonical DataWeave representation, the `application/dw`
format and MIME type.

#### Input

The XML serves as the input payload to the DataWeave source. Notice that the input contains XML
attributes.

```xml
<users>
  <company>MuleSoft</company>
  <user name="Leandro" lastName="Shokida"/>
  <user name="Mariano" lastName="Achaval"/>
</users>
```

#### Source

The DataWeave script transforms the XML input payload to the DataWeave (dw) format and MIME type.

```dataweave
%dw 2.0
output application/dw
---
payload
```

#### Output

The output shows how the DataWeave (dw) format represents the XML input. Notice how the attributes
from the XML input and the empty values are represented.

```dataweave
{
  users: {
    company: "MuleSoft",
    user @(name: "Leandro",lastName: "Shokida"): "",
    user @(name: "Mariano",lastName: "Achaval"): ""
  }
}
```

### Example: Represent XML Namespaces in the DataWeave (dw) Format

This example maps XML namespaces to a canonical DataWeave representation, the `application/dw`
format and MIME type.

#### Input

The XML serves as the input payload to the DataWeave source. Notice that the input contains XML
namespaces.

```xml
<root>
    <h:table xmlns:h="http://www.w3.org/TR/html4/">
      <h:tr>
        <h:td>Apples</h:td>
        <h:td>Bananas</h:td>
      </h:tr>
    </h:table>

    <f:table xmlns:f="https://www.w3schools.com/furniture">
      <f:name>African Coffee Table</f:name>
      <f:width>80</f:width>
      <f:length>120</f:length>
    </f:table>
</root>
```

#### Source

The DataWeave script transforms the XML input payload to the DataWeave (dw) format and MIME type.

```dataweave
%dw 2.0
output application/dw
---
payload
```

#### Output

The output shows how the DataWeave (dw) format represents the XML input. Notice how the namespaces
from the XML are represented.

```dataweave
ns h http://www.w3.org/TR/html4/
ns f https://www.w3schools.com/furniture
---
{
  root: {
      h#table: {
        h#tr: {
          h#td: "Apples",
          h#td: "Bananas"
        }
      },
      f#table: {
        f#name: "African Coffee Table",
        f#width: "80",
        f#length: "120"
      }
  }
}
```

### Example: Create a CDATA Element

This example shows how to use the `CData` type to create a CDATA element in the XML output.

#### Source

The body of the DataWeave script coerces the `String` value to the `CData` type.

```dataweave
%dw 2.0
output application/xml
---
{
    test: "A text <a>" as CData
}
```

#### Output

The output encloses the input `String` value in a CDATA block, which contains the special
characters, `<` and `>`, from the input.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<test><![CDATA[A text <a>]]></test>
```

### Example: Check for CDATA in a `String`

This example indicates whether a given `String` value is CDATA.

#### Input

The XML serves as the input payload to the DataWeave source. Notice that the `test` element contains
a CDATA block.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<test><![CDATA[A text <a>]]></test>
```

#### Source

The DataWeave script uses the `is CData` expression to determine whether the `String` value is
CDATA.

```dataweave
%dw 2.0
output application/json
---
{
    test: payload.test is CDATA
}
```

#### Output

The JSON output contains the value `true`, which indicates tha the input `String` value is CDATA.

```json
{
  "test": true
}
```

### Example: Use the `inlineCloseOn` Writer Property

This example uses the `inlineCloseOn` writer property with the value `none` to act on the key-value
pairs from the input.

#### Source

The DataWeave script transforms the body content to XML. Notice that values of the `emptyElement`
keys are `null`.

```dataweave
%dw 2.0
output application/xml inlineCloseOn="none"
---
{
  someXml: {
    parentElement: {
      emptyElement1: null,
      emptyElement2: null,
      emptyElement3: null
    }
  }
}
```

#### Output

The `emptyElement` elements are empty. They do not contain the value `null`.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<someXml>
  <parentElement>
    <emptyElement1></emptyElement1>
    <emptyElement2></emptyElement2>
    <emptyElement3></emptyElement3>
  </parentElement>
</someXml>
```

### Example: Transforms Repeated JSON Keys to Repeated XML Elements

XML encodes collections using repeated (unbounded) elements. DataWeave represents unbounded elements
by repeating the same key.

This example shows how to convert the repeated keys in a JSON array of objects into repeated XML
elements.

#### Input

The JSON input serves as the payload to the DataWeave source. Notice that the `name` keys in the
array are repeated.

```json
{
  "friends": [{ "name": "Mariano" }, { "name": "Shoki" }, { "name": "Tomo" }, { "name": "Ana" }]
}
```

#### Source

The DataWeave script selects the value of the `friends` key.

```dataweave
%dw 2.0
output application/xml
---
friends: {
    (payload.friends)
}
```

#### Output

The output represents the `name` keys as XML elements.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<friends>
  <name>Mariano</name>
  <name>Shoki</name>
  <name>Tomo</name>
  <name>Ana</name>
</friends>
```

See also,
[Example: Outputting Self-closing XML Tags](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-output-self-closing-xml-tags).

### Example: Transform XML Elements to JSON and Replace Characters

This example iterates over an XML file that contains details of employees, such as the `Id`, `Name`,
and `Address`, and converts the file into JSON format. The DataWeave script uses the `replace`
function to iterate over each `Address` element and replace the characters `-` and `/` with blank
space.

#### Input

The XML input serves as the payload to the DataWeave source. Notice that the `Address` element
contains `-` and `/` characters.

```xml
<?xml version='1.0' encoding='UTF-8'?>
<root>
  <employees>
    <Id>1</Id>
    <Name>Mule</Name>
    <Address>MuleSoft Avenue - 123</Address>
  </employees>
  <employees>
    <Id>2</Id>
    <Name>Max</Name>
    <Address>MuleSoft Avenue-456/5/e</Address>
  </employees>
</root>
```

#### Source

The following DataWeave script iterates over the payload elements and performs a mapping to an
object. The instruction `payload01.Address replace /([\-\,\/])/ with " "` replaces the `-` and `/`
characters with blank spaces.

```dataweave
%dw 2.0
output application/json
---
payload.root.*employees map ((payload01 , indexOfPayload01) ->
  {
     Id: payload01.Id as String,
     Name: payload01.Name as String,
     Address: payload01.Address replace /([\-\,\/])/ with " "
  }
)
```

#### Output

The output represents the transformed XML elements into JSON.

```JSON
[
  {
    "Id": "1",
    "Name": "Mule",
    "Address": "MuleSoft Avenue   123"
  },
  {
    "Id": "2",
    "Name": "Max",
    "Address": "MuleSoft Avenue 456 5 e"
  }
]
```

### Example: Read DTD value

The following DataWeave script transforms the XML input payload that contains a `DocType` value into
JSON. Notice that extracts the value of that doctype directive using the expression
`payload.^docType`.

#### Input

```xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE cXML SYSTEM "http://xml.cxml.org/schemas/cXML/1.2.014/cXML.dtd">
<cXML xml:lang="en-US" payloadID="1615232861.000506@prd327utl1.int.coupahost.com" timestamp="2021-03-08T11:47:42-08:00">
    <Header>
        <From>
            <Credential domain="NetworkID">
                <Identity>TestIdentity</Identity>
            </Credential>
        </From>
        <To>
            <Credential domain="TEST">
                <Identity>Identity</Identity>
            </Credential>
        </To>
    </Header>
</cXML>
```

#### Source

```dataweave
%dw 2.0
output application/json
---
{
    header: {
        senderId: payload.cXML.Header.From.Credential.Identity,
        receiverId: payload.cXML.Header.To.Credential.Identity,
        docType: payload.^docType
    }
}
```

#### Output

```json
{
  "header": {
    "senderId": "Identity",
    "receiverId": "TestIdentity",
    "docType": {
      "rootName": "cXML",
      "systemId": "http://xml.cxml.org/schemas/cXML/1.2.014/cXML.dtd"
    }
  }
}
```

### Example: Write a DTD Value

This example shows how to use the `docType` metadata to create a `DocType` value in the XML output.

#### Source

```dataweave
%dw 2.0
output application/xml
ns xml http://www.w3.org/XML/1998/namespace

var cXmlObj = {
  cXML @(payloadID: "9949494", xml#lang: "en-US", timestamp: "2002-02-04T18:39:09-08:00"): {
      Header: {
        From: {
          Credential @(domain: "NetworkId"): {
            Identity: "Identity"
          }
        }
    }
  }
} as Object {
    docType: { rootName: "cXML", systemId: "http://xml.cXML.org/schemas/cXML/1.2.014/cXML.dtd" }
}
---
cXmlObj
```

#### Output

```xml
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE cXML SYSTEM "http://xml.cXML.org/schemas/cXML/1.2.014/cXML.dtd">
<cXML payloadID="9949494" xml:lang="en-US" timestamp="2002-02-04T18:39:09-08:00">
  <Header>
    <From>
      <Credential domain="NetworkId">
        <Identity>Identity</Identity>
      </Credential>
    </From>
  </Header>
</cXML>
```

### Example: Transform DTD Value to a String Representation

This example uses [Dtd Module (dw::xml::Dtd)](https://docs.mulesoft.com/dataweave/latest/dw-dtd) to transform a `DocType` value that includes a
`systemId` to a string representation.

#### Input

```xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE cXML SYSTEM "http://xml.cxml.org/schemas/cXML/1.2.014/cXML.dtd">
<cXML xml:lang="en-US" payloadID="1615232861.000506@prd327utl1.int.coupahost.com" timestamp="2021-03-08T11:47:42-08:00">
    <Header>
        <From>
            <Credential domain="NetworkID">
                <Identity>Identity</Identity>
            </Credential>
        </From>
        <To>
            <Credential domain="TEST">
                <Identity>Identity</Identity>
            </Credential>
        </To>
    </Header>
</cXML>
```

#### Source

```dataweave
%dw 2.0
output application/json
import * from dw::xml::Dtd
---
docTypeAsString(payload.^docType)
```

#### Output

```JSON
"cXML SYSTEM http://xml.cxml.org/schemas/cXML/1.2.014/cXML.dtd"
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>collectionPath</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Sets the path to the location in the document where the collection is located. Accepts a path expression that identifies the location of the elements to stream.</p></div></div></td></tr><tr><td><p><code>externalEntities</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Indicates whether to process external entities. Disabled by default to avoid XML External Entity (XXE) attacks.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>indexedReader</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Uses the indexed reader by default when reaching the threshold. Supports US-ASCII, UTF-8 and ISO-8859-1 encodings only. For other encodings, DataWeave uses the in-memory reader.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>maxAttributeSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>-1</code></p></td><td><div><div><p>Sets the maximum number of characters accepted in an XML attribute. <em>Available since Mule 4.2.1.</em></p></div></div></td></tr><tr><td><p><code>maxEntityCount</code></p></td><td><p><code>Number</code></p></td><td><p><code>1</code></p></td><td><div><div><p>Sets the maximum number of entity expansions. The limit helps avoid Billion Laughs attacks.</p></div></div></td></tr><tr><td><p><code>nullValueOn</code></p></td><td><p><code>String</code></p></td><td><p><code>'blank'</code></p></td><td><div><div><p>Indicates whether to read an element with empty or blank text as a <code>null</code> value.</p></div><div><p>Valid values are <code>empty</code> or <code>none</code> or <code>blank</code>.</p></div></div></td></tr><tr><td><p><code>optimizeFor</code></p></td><td><p><code>String</code></p></td><td><p><code>'speed'</code></p></td><td><div><div><p>Configures the type of optimization for the XML parser to use.</p></div><div><p>Valid values are <code>speed</code> or <code>memory</code>.</p></div></div></td></tr><tr><td><p><code>streaming</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Streams input when set to <code>true</code>. Use only if entries are accessed sequentially. The input must be a top-level array. See the <a href="#example2">streaming example</a>, and see <a href="https://docs.mulesoft.com/dataweave/latest/dataweave-formats#dw_readers_writers">DataWeave Readers</a>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>supportDtd</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Enable or disable DTD support. Disabling skips (and does not process) internal and external subsets. You can also enable this property by setting the Mule system property <code>com.mulesoft.dw.xml.supportDTD</code>. Note that the default for this property changed from <code>true</code> to <code>false</code> in Mule version 4.3.0-20210601, which includes the June 2021 patch of DataWeave version 2.3.0.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>defaultNamespace</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Specifies the default namespaces of the output XML.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>doubleQuoteInDeclaration</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Escapes double quotes in the XML declaration when set to <code>true</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr><tr><td><p><code>escapeCR</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Escapes <code>CR</code> characters when set to <code>true</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>escapeGT</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Escapes '&gt;' characters when set to <code>true</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>indent</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Write indented output for better readability by default, or compress output into a single line when set to <code>false</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>inlineCloseOn</code></p></td><td><p><code>String</code></p></td><td><p><code>'empty'</code></p></td><td><div><div><p>Write an inline close tag, or explicitly open and close tags when the value is <code>null</code>.</p></div><div><p>Valid values are <code>empty</code> or <code>none</code>.</p></div></div></td></tr><tr><td><p><code>onInvalidChar</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Valid values are <code>base64</code> or <code>ignore</code> or <code>none</code>.</p></div></div></td></tr><tr><td><p><code>skipNullOn</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Skips <code>null</code> values in the specified data structure. By default, DataWeave does not skip the values.</p></div><div><ul><li><p><code>elements</code> + Ignore and omit <code>null</code> elements inside XML output, for example, with <code>output application/xml skipNullOn="arrays"</code>.</p></li><li><p><code>attributes ` + Ignore and omit `null</code> attributes inside XML, for example, with <code>output application/xml skipNullOn="objects"</code>.</p></li><li><p><code>everywhere</code> + Apply <code>skipNullOn</code> to elements and attributes, for example, <code>output application/xml skipNullOn="everywhere"</code>.</p></li></ul></div><div><p>Valid values are <code>elements</code> or <code>attributes</code> or <code>everywhere</code>.</p></div></div></td></tr><tr><td><p><code>writeDeclaration</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Writes the XML header declaration when set to <code>true</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>writeDeclaredNamespaces</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Marks the namespaces to declare in the root element of the XML:</p></div><div><ul><li><p><code>All</code>: Write all declared namespaces in the root element.</p></li><li><p><code>ids:&lt;comma separated namespace id&gt;</code>: Write only the specified namespaces.</p></li><li><p><code>regex:&lt;regex&gt;</code>: Write only the matching namespaces.</p></li></ul></div></div></td></tr><tr><td><p><code>writeNilOnNull</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Writes the <code>nil</code> attribute for a <code>null</code> value when this property is set to <code>true</code>.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>*/xml</code></p></td></tr><tr><td><p><code><strong>/</strong>+xml</code></p></td></tr></tbody></table>

<!-- document id=e0c4b261f7372e8c845ea98f09b2ec1bd5e926b7a299a3c2975feea6c49feabd url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-xsitype.md -->

---
product: DataWeave
version: 2.11
---

# xsiType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## xsiType(name: String, namespace: Namespace)

Creates a `xsi:type` type attribute. This method returns an object, so it must be used with dynamic
attributes.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>name</code></p></td><td><p>The name of the schema <code>type</code> that is referenced without the prefix.</p></td></tr><tr><td><p><code>namespace</code></p></td><td><p>The namespace of that type.</p></td></tr></tbody></table>

### Example

This example shows how the `xsiType` behaves under different inputs.

#### Source

```DataWeave
%dw 2.0
output application/xml
ns acme http://acme.com
---
  {
      user @((xsiType("user", acme))): {
          name: "Peter",
          lastName: "Parker"
      }
  }
```

#### Output

```Xml
<?xml version='1.0' encoding='UTF-8'?>
 <user xsi:type="acme:user" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:acme="http://acme.com">
     <name>Peter</name>
     <lastName>Parker</lastName>
 </user>
```

<!-- document id=7121e4af05fc26247db6bbdebade9f5835495853b06758b2f70bed4ef713e53e url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-xsitype.md -->

---
product: DataWeave
version: 2.12
---

# xsiType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## xsiType(name: String, namespace: Namespace)

Creates a `xsi:type` type attribute. This method returns an object, so it must be used with dynamic
attributes.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>name</code></p></td><td><p>The name of the schema <code>type</code> that is referenced without the prefix.</p></td></tr><tr><td><p><code>namespace</code></p></td><td><p>The namespace of that type.</p></td></tr></tbody></table>

### Example

This example shows how the `xsiType` behaves under different inputs.

#### Source

```DataWeave
%dw 2.0
output application/xml
ns acme http://acme.com
---
  {
      user @((xsiType("user", acme))): {
          name: "Peter",
          lastName: "Parker"
      }
  }
```

#### Output

```Xml
<?xml version='1.0' encoding='UTF-8'?>
 <user xsi:type="acme:user" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:acme="http://acme.com">
     <name>Peter</name>
     <lastName>Parker</lastName>
 </user>
```

<!-- document id=d615ad6b0de15477c70db4863b1a43b5787c123c10810a23e6f8a79bbdef254e url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-xsitype.md -->

---
product: DataWeave
version: 2.3
---

# xsiType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## xsiType(String, Namespace)

Creates a `xsi:type` type attribute. This method returns an object, so it must be used with dynamic
attributes.

_Introduced in DataWeave 2.2.2. Supported by Mule 4.2.2 and later._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>name</code></p></td><td><p>The name of the schema <code>type</code> that is referenced without the prefix.</p></td></tr><tr><td><p><code>namespace</code></p></td><td><p>The namespace of that type.</p></td></tr></tbody></table>

### Example

This example shows how the `xsiType` behaves under different inputs.

#### Source

```DataWeave
%dw 2.0
output application/xml
ns acme http://acme.com
---
  {
      user @((xsiType("user", acme))): {
          name: "Peter",
          lastName: "Parker"
      }
  }
```

#### Output

```Xml
<?xml version='1.0' encoding='UTF-8'?>
 <user xsi:type="acme:user" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:acme="http://acme.com">
     <name>Peter</name>
     <lastName>Parker</lastName>
 </user>
```

<!-- document id=9599597ac420c4e28ee87bc8e2c90059865459d0952c26da55860b3c6010d99f url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-xsitype.md -->

---
product: DataWeave
version: 2.4
---

# xsiType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## xsiType(name: String, namespace: Namespace)

Creates a `xsi:type` type attribute. This method returns an object, so it must be used with dynamic
attributes.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>name</code></p></td><td><p>The name of the schema <code>type</code> that is referenced without the prefix.</p></td></tr><tr><td><p><code>namespace</code></p></td><td><p>The namespace of that type.</p></td></tr></tbody></table>

### Example

This example shows how the `xsiType` behaves under different inputs.

#### Source

```DataWeave
%dw 2.0
output application/xml
ns acme http://acme.com
---
  {
      user @((xsiType("user", acme))): {
          name: "Peter",
          lastName: "Parker"
      }
  }
```

#### Output

```Xml
<?xml version='1.0' encoding='UTF-8'?>
 <user xsi:type="acme:user" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:acme="http://acme.com">
     <name>Peter</name>
     <lastName>Parker</lastName>
 </user>
```

<!-- document id=fb12a603031213d4601d5631d6dbc8bdc5e6537b93e5534ec18b5511ecdcb347 url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-xsitype.md -->

---
product: DataWeave
version: 2.6
---

# xsiType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## xsiType(name: String, namespace: Namespace)

Creates a `xsi:type` type attribute. This method returns an object, so it must be used with dynamic
attributes.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>name</code></p></td><td><p>The name of the schema <code>type</code> that is referenced without the prefix.</p></td></tr><tr><td><p><code>namespace</code></p></td><td><p>The namespace of that type.</p></td></tr></tbody></table>

### Example

This example shows how the `xsiType` behaves under different inputs.

#### Source

```DataWeave
%dw 2.0
output application/xml
ns acme http://acme.com
---
  {
      user @((xsiType("user", acme))): {
          name: "Peter",
          lastName: "Parker"
      }
  }
```

#### Output

```Xml
<?xml version='1.0' encoding='UTF-8'?>
 <user xsi:type="acme:user" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:acme="http://acme.com">
     <name>Peter</name>
     <lastName>Parker</lastName>
 </user>
```

<!-- document id=fa210786b654f8df0b69c9a753638f0fe884900286df9bffbb774ebccb932680 url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-xsitype.md -->

---
product: DataWeave
version: 2.9
---

# xsiType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## xsiType(name: String, namespace: Namespace)

Creates a `xsi:type` type attribute. This method returns an object, so it must be used with dynamic
attributes.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>name</code></p></td><td><p>The name of the schema <code>type</code> that is referenced without the prefix.</p></td></tr><tr><td><p><code>namespace</code></p></td><td><p>The namespace of that type.</p></td></tr></tbody></table>

### Example

This example shows how the `xsiType` behaves under different inputs.

#### Source

```DataWeave
%dw 2.0
output application/xml
ns acme http://acme.com
---
  {
      user @((xsiType("user", acme))): {
          name: "Peter",
          lastName: "Parker"
      }
  }
```

#### Output

```Xml
<?xml version='1.0' encoding='UTF-8'?>
 <user xsi:type="acme:user" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:acme="http://acme.com">
     <name>Peter</name>
     <lastName>Parker</lastName>
 </user>
```

<!-- document id=b62364a54f19a2b9c57c57de09f956d52fefa2bc6bcbdbbbc21ff5b595edc490 url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-xsitype.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# xsiType

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## xsiType(name: String, namespace: Namespace)

Creates a `xsi:type` type attribute. This method returns an object, so it must be used with dynamic
attributes.

_Introduced in DataWeave version 2.2.2._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>name</code></p></td><td><p>The name of the schema <code>type</code> that is referenced without the prefix.</p></td></tr><tr><td><p><code>namespace</code></p></td><td><p>The namespace of that type.</p></td></tr></tbody></table>

### Example

This example shows how the `xsiType` behaves under different inputs.

#### Source

```DataWeave
%dw 2.0
output application/xml
ns acme http://acme.com
---
  {
      user @((xsiType("user", acme))): {
          name: "Peter",
          lastName: "Parker"
      }
  }
```

#### Output

```Xml
<?xml version='1.0' encoding='UTF-8'?>
 <user xsi:type="acme:user" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:acme="http://acme.com">
     <name>Peter</name>
     <lastName>Parker</lastName>
 </user>
```

<!-- document id=8c0aa56b59e75d1c8beb8421423f5e98a56a89baa2165f66f02899b03a4f68e2 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-formats-yaml.md -->

---
product: DataWeave
version: 2.11
keywords: format, yaml, application/yaml, text/yaml, application/x-yaml, text/x-yaml, application/yaml
---

# YAML Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/yaml`

ID: `yaml`

Values in the YAML data format map one-to-one with DataWeave values. DataWeave natively supports all
of the following YAML types:

- `String`

- `Boolean`

- `Number`

- `Nil`

- `Mapping`

- `Sequences`

## Example: Represent YAML in the DataWeave Format (dw)

This example shows how DataWeave represents YAML values.

### Input

The following YAML snippet serves as the input payload for the DataWeave source in this example.

```yaml
american:
  - Boston Red Sox
  - Detroit Tigers
  - New York Yankees
national:
  - New York Mets
  - Chicago Cubs
  - Atlanta Braves
```

### Source

The DataWeave script transforms the YAML encoded input payload to the DataWeave (dw) format and MIME
type.

```dataweave
%dw 2.0
output application/dw
---
payload
```

### Output

The following output shows how the YAML input is represented in the DataWeave (`dw`) format.

```dataweave
{
  "american": [
    "Boston Red Sox",
    "Detroit Tigers",
    "New York Yankees"
  ],
  "national": [
    "New York Mets",
    "Chicago Cubs",
    "Atlanta Braves"
  ]
}
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>maxEntityCount</code></p></td><td><p><code>Number</code></p></td><td><p><code>1</code></p></td><td><div><div><p>Sets the maximum number of entity expansions. The limit helps avoid Billion Laughs attacks.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>'UTF-8'</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr><tr><td><p><code>skipNullOn</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Skips <code>null</code> values in the specified data structure. By default, DataWeave does not skip the values.</p></div><div><ul><li><p><code>arrays</code> + Ignore and omit <code>null</code> values inside arrays from the YAML output, for example, with <code>output application/yaml skipNullOn="arrays"</code>.</p></li><li><p><code>objects</code> + Ignore key-value pairs that have <code>null</code> as the value, for example, with <code>output application/yaml skipNullOn="objects"</code>.</p></li><li><p><code>everywhere</code> + Apply <code>skipNullOn</code> to arrays and objects, for example, <code>output application/yaml skipNullOn="everywhere"</code>.</p></li></ul></div><div><p>Valid values are <code>arrays</code> or <code>objects</code> or <code>everywhere</code>.</p></div></div></td></tr><tr><td><p><code>writeDeclaration</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether to write the header declaration or not.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>application/yaml</code></p></td></tr><tr><td><p><code>text/yaml</code></p></td></tr><tr><td><p><code>application/x-yaml</code></p></td></tr><tr><td><p><code>text/x-yaml</code></p></td></tr></tbody></table>

<!-- document id=ff8d2f5dfd72cbeecaef8eb3a0ccfa31d8209524d6be59f5e4e04f5786222512 url=/mulesoft/current/en-us/dataweave/2.12/dataweave-formats-yaml.md -->

---
product: DataWeave
version: 2.12
keywords: format, yaml, application/yaml, text/yaml, application/x-yaml, text/x-yaml, application/yaml
---

# YAML Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/yaml`

ID: `yaml`

Values in the YAML data format map one-to-one with DataWeave values. DataWeave natively supports all
of the following YAML types:

- `String`

- `Boolean`

- `Number`

- `Nil`

- `Mapping`

- `Sequences`

## Example: Represent YAML in the DataWeave Format (dw)

This example shows how DataWeave represents YAML values.

### Input

The following YAML snippet serves as the input payload for the DataWeave source in this example.

```yaml
american:
  - Boston Red Sox
  - Detroit Tigers
  - New York Yankees
national:
  - New York Mets
  - Chicago Cubs
  - Atlanta Braves
```

### Source

The DataWeave script transforms the YAML encoded input payload to the DataWeave (dw) format and MIME
type.

```dataweave
%dw 2.0
output application/dw
---
payload
```

### Output

The following output shows how the YAML input is represented in the DataWeave (`dw`) format.

```dataweave
{
  "american": [
    "Boston Red Sox",
    "Detroit Tigers",
    "New York Yankees"
  ],
  "national": [
    "New York Mets",
    "Chicago Cubs",
    "Atlanta Braves"
  ]
}
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>maxEntityCount</code></p></td><td><p><code>Number</code></p></td><td><p><code>1</code></p></td><td><div><div><p>Sets the maximum number of entity expansions. The limit helps avoid Billion Laughs attacks.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>'UTF-8'</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr><tr><td><p><code>skipNullOn</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Skips <code>null</code> values in the specified data structure. By default, DataWeave does not skip the values.</p></div><div><ul><li><p><code>arrays</code> + Ignore and omit <code>null</code> values inside arrays from the YAML output, for example, with <code>output application/yaml skipNullOn="arrays"</code>.</p></li><li><p><code>objects</code> + Ignore key-value pairs that have <code>null</code> as the value, for example, with <code>output application/yaml skipNullOn="objects"</code>.</p></li><li><p><code>everywhere</code> + Apply <code>skipNullOn</code> to arrays and objects, for example, <code>output application/yaml skipNullOn="everywhere"</code>.</p></li></ul></div><div><p>Valid values are <code>arrays</code> or <code>objects</code> or <code>everywhere</code>.</p></div></div></td></tr><tr><td><p><code>writeDeclaration</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether to write the header declaration or not.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>application/yaml</code></p></td></tr><tr><td><p><code>text/yaml</code></p></td></tr><tr><td><p><code>application/x-yaml</code></p></td></tr><tr><td><p><code>text/x-yaml</code></p></td></tr></tbody></table>

<!-- document id=4fc6832cb2e9e5b01f9a1962fa13a436afa6a6a7fe726d247f1e5247ea52e906 url=/mulesoft/current/en-us/dataweave/2.3/dataweave-formats-yaml.md -->

---
product: DataWeave
version: 2.3
---

# YAML Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME Type: `application/yaml`

ID: `yaml`

Values in the YAML data format map one-to-one with DataWeave values. DataWeave natively supports all
of the following YAML types:

- `String`

- `Boolean`

- `Number`

- `Nil`

- `Mapping`

- `Sequences`

## Example: Represent YAML in the DataWeave Format (dw)

This example shows how DataWeave represents YAML values.

### Input

The following YAML snippet serves as the input payload for the DataWeave source in this example.

```yaml
american:
  - Boston Red Sox
  - Detroit Tigers
  - New York Yankees
national:
  - New York Mets
  - Chicago Cubs
  - Atlanta Braves
```

### Source

The DataWeave script transforms the YAML encoded input payload to the DataWeave (dw) format and MIME
type.

```dataweave
%dw 2.0
output application/dw
---
payload
```

### Output

The following output shows how the YAML input is represented in the DataWeave (`dw`) format.

```dataweave
{
  "american": [
    "Boston Red Sox",
    "Detroit Tigers",
    "New York Yankees"
  ],
  "national": [
    "New York Mets",
    "Chicago Cubs",
    "Atlanta Braves"
  ]
}
```

## Configuration Properties

DataWeave supports the following configuration properties for the YAML format.

### Reader Properties

The YAML format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>maxEntityCount</code></p></td><td><p><code>Number</code></p></td><td><p><code>1</code></p></td><td><div><div><p>The maximum number of entity expansions. The limit is provided to avoid the billion laughs attack, a denial-of-service attack.</p></div></div></td></tr></tbody></table>

### Writer Properties

The YAML format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the writer buffer.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>When set to <code>true</code>, DataWeave generates the output as a data stream, and the script’s execution is deferred until it is consumed. Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>UTF-8</code></p></td><td><div><div><p>Encoding for the writer to use.</p></div></div></td></tr><tr><td><p><code>skipNullOn</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Skips <code>null</code> values in the specified data structure. Valid values are <code>arrays</code>, <code>objects</code>, or <code>everywhere</code>. The writer does not skip such values unless you set the property.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

The YAML format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>application/yaml</code></p></td></tr><tr><td><p><code>text/yaml</code></p></td></tr><tr><td><p><code>application/x-yaml</code></p></td></tr><tr><td><p><code>text/x-yaml</code></p></td></tr></tbody></table>

<!-- document id=0eb4ea2dbe2a4fd3f1f8972d30b1091cd826f907ef55b9860b67e88f4a4c47c6 url=/mulesoft/current/en-us/dataweave/2.4/dataweave-formats-yaml.md -->

---
product: DataWeave
version: 2.4
keywords: format, yaml, application/yaml, text/yaml, application/x-yaml, text/x-yaml, application/yaml
---

# YAML Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/yaml`

ID: `yaml`

Values in the YAML data format map one-to-one with DataWeave values. DataWeave natively supports all
of the following YAML types:

- `String`

- `Boolean`

- `Number`

- `Nil`

- `Mapping`

- `Sequences`

## Example: Represent YAML in the DataWeave Format (dw)

This example shows how DataWeave represents YAML values.

### Input

The following YAML snippet serves as the input payload for the DataWeave source in this example.

```yaml
american:
  - Boston Red Sox
  - Detroit Tigers
  - New York Yankees
national:
  - New York Mets
  - Chicago Cubs
  - Atlanta Braves
```

### Source

The DataWeave script transforms the YAML encoded input payload to the DataWeave (dw) format and MIME
type.

```dataweave
%dw 2.0
output application/dw
---
payload
```

### Output

The following output shows how the YAML input is represented in the DataWeave (`dw`) format.

```dataweave
{
  "american": [
    "Boston Red Sox",
    "Detroit Tigers",
    "New York Yankees"
  ],
  "national": [
    "New York Mets",
    "Chicago Cubs",
    "Atlanta Braves"
  ]
}
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>maxEntityCount</code></p></td><td><p><code>Number</code></p></td><td><p><code>1</code></p></td><td><div><div><p>Sets the maximum number of entity expansions. The limit helps avoid Billion Laughs attacks.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>'UTF-8'</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr><tr><td><p><code>skipNullOn</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Skips <code>null</code> values in the specified data structure. By default, DataWeave does not skip the values.</p></div><div><ul><li><p><code>arrays</code> + Ignore and omit <code>null</code> values inside arrays from the YAML output, for example, with <code>output application/yaml skipNullOn="arrays"</code>.</p></li><li><p><code>objects</code> + Ignore key-value pairs that have <code>null</code> as the value, for example, with <code>output application/yaml skipNullOn="objects"</code>.</p></li><li><p><code>everywhere</code> + Apply <code>skipNullOn</code> to arrays and objects, for example, <code>output application/yaml skipNullOn="everywhere"</code>.</p></li></ul></div><div><p>Valid values are <code>arrays</code> or <code>objects</code> or <code>everywhere</code>.</p></div></div></td></tr><tr><td><p><code>writeDeclaration</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether to write the header declaration or not.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>application/yaml</code></p></td></tr><tr><td><p><code>text/yaml</code></p></td></tr><tr><td><p><code>application/x-yaml</code></p></td></tr><tr><td><p><code>text/x-yaml</code></p></td></tr></tbody></table>

<!-- document id=e95df666529085642582a14a4767ed10b6741781c52a3b81e8a94e3287fc0cdd url=/mulesoft/current/en-us/dataweave/2.6/dataweave-formats-yaml.md -->

---
product: DataWeave
version: 2.6
keywords: format, yaml, application/yaml, text/yaml, application/x-yaml, text/x-yaml, application/yaml
---

# YAML Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/yaml`

ID: `yaml`

Values in the YAML data format map one-to-one with DataWeave values. DataWeave natively supports all
of the following YAML types:

- `String`

- `Boolean`

- `Number`

- `Nil`

- `Mapping`

- `Sequences`

## Example: Represent YAML in the DataWeave Format (dw)

This example shows how DataWeave represents YAML values.

### Input

The following YAML snippet serves as the input payload for the DataWeave source in this example.

```yaml
american:
  - Boston Red Sox
  - Detroit Tigers
  - New York Yankees
national:
  - New York Mets
  - Chicago Cubs
  - Atlanta Braves
```

### Source

The DataWeave script transforms the YAML encoded input payload to the DataWeave (dw) format and MIME
type.

```dataweave
%dw 2.0
output application/dw
---
payload
```

### Output

The following output shows how the YAML input is represented in the DataWeave (`dw`) format.

```dataweave
{
  "american": [
    "Boston Red Sox",
    "Detroit Tigers",
    "New York Yankees"
  ],
  "national": [
    "New York Mets",
    "Chicago Cubs",
    "Atlanta Braves"
  ]
}
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>maxEntityCount</code></p></td><td><p><code>Number</code></p></td><td><p><code>1</code></p></td><td><div><div><p>Sets the maximum number of entity expansions. The limit helps avoid Billion Laughs attacks.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>'UTF-8'</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr><tr><td><p><code>skipNullOn</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Skips <code>null</code> values in the specified data structure. By default, DataWeave does not skip the values.</p></div><div><ul><li><p><code>arrays</code> + Ignore and omit <code>null</code> values inside arrays from the YAML output, for example, with <code>output application/yaml skipNullOn="arrays"</code>.</p></li><li><p><code>objects</code> + Ignore key-value pairs that have <code>null</code> as the value, for example, with <code>output application/yaml skipNullOn="objects"</code>.</p></li><li><p><code>everywhere</code> + Apply <code>skipNullOn</code> to arrays and objects, for example, <code>output application/yaml skipNullOn="everywhere"</code>.</p></li></ul></div><div><p>Valid values are <code>arrays</code> or <code>objects</code> or <code>everywhere</code>.</p></div></div></td></tr><tr><td><p><code>writeDeclaration</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether to write the header declaration or not.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>application/yaml</code></p></td></tr><tr><td><p><code>text/yaml</code></p></td></tr><tr><td><p><code>application/x-yaml</code></p></td></tr><tr><td><p><code>text/x-yaml</code></p></td></tr></tbody></table>

<!-- document id=5edb316dc822d68344f023c75b2abb257fed19d770121cbf2a1116930bd90eb8 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-formats-yaml.md -->

---
product: DataWeave
version: 2.9
keywords: format, yaml, application/yaml, text/yaml, application/x-yaml, text/x-yaml, application/yaml
---

# YAML Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/yaml`

ID: `yaml`

Values in the YAML data format map one-to-one with DataWeave values. DataWeave natively supports all
of the following YAML types:

- `String`

- `Boolean`

- `Number`

- `Nil`

- `Mapping`

- `Sequences`

## Example: Represent YAML in the DataWeave Format (dw)

This example shows how DataWeave represents YAML values.

### Input

The following YAML snippet serves as the input payload for the DataWeave source in this example.

```yaml
american:
  - Boston Red Sox
  - Detroit Tigers
  - New York Yankees
national:
  - New York Mets
  - Chicago Cubs
  - Atlanta Braves
```

### Source

The DataWeave script transforms the YAML encoded input payload to the DataWeave (dw) format and MIME
type.

```dataweave
%dw 2.0
output application/dw
---
payload
```

### Output

The following output shows how the YAML input is represented in the DataWeave (`dw`) format.

```dataweave
{
  "american": [
    "Boston Red Sox",
    "Detroit Tigers",
    "New York Yankees"
  ],
  "national": [
    "New York Mets",
    "Chicago Cubs",
    "Atlanta Braves"
  ]
}
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>maxEntityCount</code></p></td><td><p><code>Number</code></p></td><td><p><code>1</code></p></td><td><div><div><p>Sets the maximum number of entity expansions. The limit helps avoid Billion Laughs attacks.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>'UTF-8'</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr><tr><td><p><code>skipNullOn</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Skips <code>null</code> values in the specified data structure. By default, DataWeave does not skip the values.</p></div><div><ul><li><p><code>arrays</code> + Ignore and omit <code>null</code> values inside arrays from the YAML output, for example, with <code>output application/yaml skipNullOn="arrays"</code>.</p></li><li><p><code>objects</code> + Ignore key-value pairs that have <code>null</code> as the value, for example, with <code>output application/yaml skipNullOn="objects"</code>.</p></li><li><p><code>everywhere</code> + Apply <code>skipNullOn</code> to arrays and objects, for example, <code>output application/yaml skipNullOn="everywhere"</code>.</p></li></ul></div><div><p>Valid values are <code>arrays</code> or <code>objects</code> or <code>everywhere</code>.</p></div></div></td></tr><tr><td><p><code>writeDeclaration</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether to write the header declaration or not.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>application/yaml</code></p></td></tr><tr><td><p><code>text/yaml</code></p></td></tr><tr><td><p><code>application/x-yaml</code></p></td></tr><tr><td><p><code>text/x-yaml</code></p></td></tr></tbody></table>

<!-- document id=ca8181a09f3483a286b6f9439bc7926761fb3f8e832e37e1fbc87009d91e4434 url=/mulesoft/current/en-us/dataweave/latest/dataweave-formats-yaml.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: format, yaml, application/yaml, text/yaml, application/x-yaml, text/x-yaml, application/yaml
---

# YAML Format

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MIME type: `application/yaml`

ID: `yaml`

Values in the YAML data format map one-to-one with DataWeave values. DataWeave natively supports all
of the following YAML types:

- `String`

- `Boolean`

- `Number`

- `Nil`

- `Mapping`

- `Sequences`

## Example: Represent YAML in the DataWeave Format (dw)

This example shows how DataWeave represents YAML values.

### Input

The following YAML snippet serves as the input payload for the DataWeave source in this example.

```yaml
american:
  - Boston Red Sox
  - Detroit Tigers
  - New York Yankees
national:
  - New York Mets
  - Chicago Cubs
  - Atlanta Braves
```

### Source

The DataWeave script transforms the YAML encoded input payload to the DataWeave (dw) format and MIME
type.

```dataweave
%dw 2.0
output application/dw
---
payload
```

### Output

The following output shows how the YAML input is represented in the DataWeave (`dw`) format.

```dataweave
{
  "american": [
    "Boston Red Sox",
    "Detroit Tigers",
    "New York Yankees"
  ],
  "national": [
    "New York Mets",
    "Chicago Cubs",
    "Atlanta Braves"
  ]
}
```

## Configuration Properties

DataWeave supports the following configuration properties for this format.

### Reader Properties

This format accepts properties that provide instructions for reading input data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>maxEntityCount</code></p></td><td><p><code>Number</code></p></td><td><p><code>1</code></p></td><td><div><div><p>Sets the maximum number of entity expansions. The limit helps avoid Billion Laughs attacks.</p></div></div></td></tr></tbody></table>

### Writer Properties

This format accepts properties that provide instructions for writing output data.

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>bufferSize</code></p></td><td><p><code>Number</code></p></td><td><p><code>8192</code></p></td><td><div><div><p>Size of the buffer writer, in bytes. The value must be greater than <code>8</code>.</p></div></div></td></tr><tr><td><p><code>deferred</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>false</code></p></td><td><div><div><p>Generates the output as a data stream when set to <code>true</code>, and defers the script’s execution until the generated content is consumed.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><p><code>encoding</code></p></td><td><p><code>String</code></p></td><td><p><code>'UTF-8'</code></p></td><td><div><div><p>The encoding to use for the output, such as UTF-8.</p></div></div></td></tr><tr><td><p><code>skipNullOn</code></p></td><td><p><code>String</code></p></td><td><p><code>null</code></p></td><td><div><div><p>Skips <code>null</code> values in the specified data structure. By default, DataWeave does not skip the values.</p></div><div><ul><li><p><code>arrays</code> + Ignore and omit <code>null</code> values inside arrays from the YAML output, for example, with <code>output application/yaml skipNullOn="arrays"</code>.</p></li><li><p><code>objects</code> + Ignore key-value pairs that have <code>null</code> as the value, for example, with <code>output application/yaml skipNullOn="objects"</code>.</p></li><li><p><code>everywhere</code> + Apply <code>skipNullOn</code> to arrays and objects, for example, <code>output application/yaml skipNullOn="everywhere"</code>.</p></li></ul></div><div><p>Valid values are <code>arrays</code> or <code>objects</code> or <code>everywhere</code>.</p></div></div></td></tr><tr><td><p><code>writeDeclaration</code></p></td><td><p><code>Boolean</code></p></td><td><p><code>true</code></p></td><td><div><div><p>Indicates whether to write the header declaration or not.</p></div><div><p>Valid values are <code>true</code> or <code>false</code>.</p></div></div></td></tr></tbody></table>

## Supported MIME Types

This format supports the following MIME types.

<table><colgroup><col></colgroup><thead><tr><th>MIME Type</th></tr></thead><tbody><tr><td><p><code>application/yaml</code></p></td></tr><tr><td><p><code>text/yaml</code></p></td></tr><tr><td><p><code>application/x-yaml</code></p></td></tr><tr><td><p><code>text/x-yaml</code></p></td></tr></tbody></table>

<!-- document id=1e4845da0770a814210de04b65e860342429de5f2cd42b8424688868ec95d2f1 url=/mulesoft/current/en-us/dataweave/2.11/dw-periods-functions-years.md -->

---
product: DataWeave
version: 2.11
---

# years

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## years(nYears: Number): Period

Creates a Period value from the provided number of years.

The function applies the `period` function to the input value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>nYears</code></p></td><td><p>A whole number for the number of years. A positive or negative number is valid.</p></td></tr></tbody></table>

### Example

This example shows how `years` behaves with different inputs. It adds a year to a DateTime value,
and it converts the whole number 4 into a number of years in the Period format (`P4Y`). Notice that
`years(-1) + years(2)` returns the number of months.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Periods
output application/json
---
{
  nextYear: |2020-10-05T20:22:34.385Z| + years(1),
  fourYearPeriod: years(4),
  addNegativeValue: years(-1) + years(2)
}
```

#### Output

```Json
{
   "nextYear": "2021-10-05T20:22:34.385Z",
   "fourYearPeriod": "P4Y",
   "addNegativeValue": 12
}
```

<!-- document id=7cbc77dd7ffe002c8a77a8229c1d6ef222243d02f6b1ea1ed0ca334a327665a5 url=/mulesoft/current/en-us/dataweave/2.12/dw-periods-functions-years.md -->

---
product: DataWeave
version: 2.12
---

# years

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## years(nYears: Number): Period

Creates a Period value from the provided number of years.

The function applies the `period` function to the input value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>nYears</code></p></td><td><p>A whole number for the number of years. A positive or negative number is valid.</p></td></tr></tbody></table>

### Example

This example shows how `years` behaves with different inputs. It adds a year to a DateTime value,
and it converts the whole number 4 into a number of years in the Period format (`P4Y`). Notice that
`years(-1) + years(2)` returns the number of months.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Periods
output application/json
---
{
  nextYear: |2020-10-05T20:22:34.385Z| + years(1),
  fourYearPeriod: years(4),
  addNegativeValue: years(-1) + years(2)
}
```

#### Output

```Json
{
   "nextYear": "2021-10-05T20:22:34.385Z",
   "fourYearPeriod": "P4Y",
   "addNegativeValue": 12
}
```

<!-- document id=34ce8bdf5e57d82416a88ebe873d650dd43b9dc8bcb3a153ba3687398c1796e0 url=/mulesoft/current/en-us/dataweave/2.4/dw-periods-functions-years.md -->

---
product: DataWeave
version: 2.4
---

# years

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## years(nYears: Number): Period

Creates a Period value from the provided number of years.

The function applies the `period` function to the input value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>nYears</code></p></td><td><p>A whole number for the number of years. A positive or negative number is valid.</p></td></tr></tbody></table>

### Example

This example shows how `years` behaves with different inputs. It adds a year to a DateTime value,
and it converts the whole number 4 into a number of years in the Period format (`P4Y`). Notice that
`years(-1) + years(2)` returns the number of months.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Periods
output application/json
---
{
  nextYear: |2020-10-05T20:22:34.385Z| + years(1),
  fourYearPeriod: years(4),
  addNegativeValue: years(-1) + years(2)
}
```

#### Output

```Json
{
   "nextYear": "2021-10-05T20:22:34.385Z",
   "fourYearPeriod": "P4Y",
   "addNegativeValue": 12
}
```

<!-- document id=58cc10f17971c195564f5843382e891900986f4280de120e8fe8a9d64e3b88e6 url=/mulesoft/current/en-us/dataweave/2.6/dw-periods-functions-years.md -->

---
product: DataWeave
version: 2.6
---

# years

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## years(nYears: Number): Period

Creates a Period value from the provided number of years.

The function applies the `period` function to the input value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>nYears</code></p></td><td><p>A whole number for the number of years. A positive or negative number is valid.</p></td></tr></tbody></table>

### Example

This example shows how `years` behaves with different inputs. It adds a year to a DateTime value,
and it converts the whole number 4 into a number of years in the Period format (`P4Y`). Notice that
`years(-1) + years(2)` returns the number of months.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Periods
output application/json
---
{
  nextYear: |2020-10-05T20:22:34.385Z| + years(1),
  fourYearPeriod: years(4),
  addNegativeValue: years(-1) + years(2)
}
```

#### Output

```Json
{
   "nextYear": "2021-10-05T20:22:34.385Z",
   "fourYearPeriod": "P4Y",
   "addNegativeValue": 12
}
```

<!-- document id=f312f7d81a42d9410169c2de92d74950f0653e4c0d576b716674146e73c29ffe url=/mulesoft/current/en-us/dataweave/2.9/dw-periods-functions-years.md -->

---
product: DataWeave
version: 2.9
---

# years

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## years(nYears: Number): Period

Creates a Period value from the provided number of years.

The function applies the `period` function to the input value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>nYears</code></p></td><td><p>A whole number for the number of years. A positive or negative number is valid.</p></td></tr></tbody></table>

### Example

This example shows how `years` behaves with different inputs. It adds a year to a DateTime value,
and it converts the whole number 4 into a number of years in the Period format (`P4Y`). Notice that
`years(-1) + years(2)` returns the number of months.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Periods
output application/json
---
{
  nextYear: |2020-10-05T20:22:34.385Z| + years(1),
  fourYearPeriod: years(4),
  addNegativeValue: years(-1) + years(2)
}
```

#### Output

```Json
{
   "nextYear": "2021-10-05T20:22:34.385Z",
   "fourYearPeriod": "P4Y",
   "addNegativeValue": 12
}
```

<!-- document id=d7672469793e1a7482e1e6b4f372269880449be156c6d1390b9792fb1a655ae6 url=/mulesoft/current/en-us/dataweave/latest/dw-periods-functions-years.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# years

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## years(nYears: Number): Period

Creates a Period value from the provided number of years.

The function applies the `period` function to the input value.

_Introduced in DataWeave version 2.4.0._

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>nYears</code></p></td><td><p>A whole number for the number of years. A positive or negative number is valid.</p></td></tr></tbody></table>

### Example

This example shows how `years` behaves with different inputs. It adds a year to a DateTime value,
and it converts the whole number 4 into a number of years in the Period format (`P4Y`). Notice that
`years(-1) + years(2)` returns the number of months.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Periods
output application/json
---
{
  nextYear: |2020-10-05T20:22:34.385Z| + years(1),
  fourYearPeriod: years(4),
  addNegativeValue: years(-1) + years(2)
}
```

#### Output

```Json
{
   "nextYear": "2021-10-05T20:22:34.385Z",
   "fourYearPeriod": "P4Y",
   "addNegativeValue": 12
}
```

<!-- document id=f8f65537d1026989957fff282fefbc259663edcad2741a14cd2cc04ec8c180cb url=/mulesoft/current/en-us/dataweave/2.11/dw-dates-functions-yesterday.md -->

---
product: DataWeave
version: 2.11
---

# yesterday

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## yesterday(): Date

Returns the date for yesterday as a `Date` type.

_Introduced in DataWeave version 2.4.0._

### Example

This example shows the output of `yesterday` function.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
yesterday()
```

#### Output

```Json
"2021-05-14"
```

<!-- document id=e54f21e311e57916aa7f720d79f396c3583872eee613660c30cae03457c90e76 url=/mulesoft/current/en-us/dataweave/2.12/dw-dates-functions-yesterday.md -->

---
product: DataWeave
version: 2.12
---

# yesterday

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## yesterday(): Date

Returns the date for yesterday as a `Date` type.

_Introduced in DataWeave version 2.4.0._

### Example

This example shows the output of `yesterday` function.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
yesterday()
```

#### Output

```Json
"2021-05-14"
```

<!-- document id=c2efbd2254235e046190a3440aa778f91982723f2f0040f09d568342ffcd3a32 url=/mulesoft/current/en-us/dataweave/2.4/dw-dates-functions-yesterday.md -->

---
product: DataWeave
version: 2.4
---

# yesterday

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## yesterday(): Date

Returns the date for yesterday as a `Date` type.

_Introduced in DataWeave version 2.4.0._

### Example

This example shows the output of `yesterday` function.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
yesterday()
```

#### Output

```Json
"2021-05-14"
```

<!-- document id=53ff39946bd891a00303307a3e16534752ca5d095fc852b66580de8fa8c2fa8b url=/mulesoft/current/en-us/dataweave/2.6/dw-dates-functions-yesterday.md -->

---
product: DataWeave
version: 2.6
---

# yesterday

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## yesterday(): Date

Returns the date for yesterday as a `Date` type.

_Introduced in DataWeave version 2.4.0._

### Example

This example shows the output of `yesterday` function.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
yesterday()
```

#### Output

```Json
"2021-05-14"
```

<!-- document id=7bd8916aa719691ead7659c5a6f00c36136b42e8c57d43ab5ca7ed07a430c134 url=/mulesoft/current/en-us/dataweave/2.9/dw-dates-functions-yesterday.md -->

---
product: DataWeave
version: 2.9
---

# yesterday

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## yesterday(): Date

Returns the date for yesterday as a `Date` type.

_Introduced in DataWeave version 2.4.0._

### Example

This example shows the output of `yesterday` function.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
yesterday()
```

#### Output

```Json
"2021-05-14"
```

<!-- document id=e42ba72b0db52a177c206fe4d41da592b170d96678e3727534317172b60c9df3 url=/mulesoft/current/en-us/dataweave/latest/dw-dates-functions-yesterday.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# yesterday

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## yesterday(): Date

Returns the date for yesterday as a `Date` type.

_Introduced in DataWeave version 2.4.0._

### Example

This example shows the output of `yesterday` function.

#### Source

```DataWeave
%dw 2.0
import * from dw::core::Dates
output application/json
---
yesterday()
```

#### Output

```Json
"2021-05-14"
```

<!-- document id=53ffec22e8338eec50bb213f46df17dc80bd722c4a6887fbfecb397b309ebc9c url=/mulesoft/current/en-us/dataweave/2.11/dw-core-functions-zip.md -->

---
product: DataWeave
version: 2.11
---

# zip

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## zip<T, R>(left: Array<T>, right: Array<R>): Array<Array<T | R>>

Merges elements from two arrays into an array of arrays.

The first sub-array in the output array contains the first indices of the input sub-arrays. The
second index contains the second indices of the inputs, the third contains the third indices, and so
on for every case where there are the same number of indices in the arrays.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>left</code></p></td><td><p>The array on the left-hand side of the function.</p></td></tr><tr><td><p><code>right</code></p></td><td><p>The array on the right-hand side of the function.</p></td></tr></tbody></table>

### Example

This example zips the arrays located to the left and right of `zip`. Notice that it returns an array
of arrays where the first index, (`[0,1]`) contains the first indices of the specified arrays. The
second index of the output array (`[1,"b"]`) contains the second indices of the specified arrays.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[0,1] zip ["a","b"]
```

#### Output

```JSON
[ [0,"a"], [1,"b"] ]
```

### Example

This example zips elements of the left-hand and right-hand arrays. Notice that only elements with
counterparts at the same index are returned in the array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  "a" : [0, 1, 2, 3] zip ["a", "b", "c", "d"],
  "b" : [0, 1, 2, 3] zip ["a"],
  "c" : [0, 1, 2, 3] zip ["a", "b"],
  "d" : [0, 1, 2] zip ["a", "b", "c", "d"]
}
```

#### Output

```JSON
{
  "a": [
    [0,"a"],
    [1,"b"],
    [2,"c"],
    [3,"d"]
    ],
  "b": [
    [0,"a"]
  ],
  "c": [
    [0,"a"],
    [1,"b"]
  ],
  "d": [
    [0,"a"],
    [1,"b"],
    [2,"c"]
  ]
}
```

### Example

This example zips more than two arrays. Notice that items from `["aA", "bB"]` in `list4` are not in
the output because the other input arrays only have two indices.

#### Source

```DataWeave
%dw 2.0
output application/json
var myvar = {
   "list1": ["a", "b"],
   "list2": [1, 2, 3],
   "list3": ["aa", "bb"],
   "list4": [["A", "B", "C"], [11, 12], ["aA", "bB"]]
}
---
((myvar.list1 zip myvar.list2) zip myvar.list3) zip myvar.list4
```

#### Output

```JSON
[
  [
    [ [ "a", 1 ], "aa" ], [ "A", "B", "C" ]
  ],
  [
    [ [ "b", 2 ], "bb" ], [ 11, 12 ]
  ]
]
```

<!-- document id=591f04e337aa16f766a2733e5f8b64dc3e50fed70a920e6bb91cd42b7973c1a3 url=/mulesoft/current/en-us/dataweave/2.12/dw-core-functions-zip.md -->

---
product: DataWeave
version: 2.12
---

# zip

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## zip<T, R>(left: Array<T>, right: Array<R>): Array<Array<T | R>>

Merges elements from two arrays into an array of arrays.

The first sub-array in the output array contains the first indices of the input sub-arrays. The
second index contains the second indices of the inputs, the third contains the third indices, and so
on for every case where there are the same number of indices in the arrays.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>left</code></p></td><td><p>The array on the left-hand side of the function.</p></td></tr><tr><td><p><code>right</code></p></td><td><p>The array on the right-hand side of the function.</p></td></tr></tbody></table>

### Example

This example zips the arrays located to the left and right of `zip`. Notice that it returns an array
of arrays where the first index, (`[0,1]`) contains the first indices of the specified arrays. The
second index of the output array (`[1,"b"]`) contains the second indices of the specified arrays.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[0,1] zip ["a","b"]
```

#### Output

```JSON
[ [0,"a"], [1,"b"] ]
```

### Example

This example zips elements of the left-hand and right-hand arrays. Notice that only elements with
counterparts at the same index are returned in the array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  "a" : [0, 1, 2, 3] zip ["a", "b", "c", "d"],
  "b" : [0, 1, 2, 3] zip ["a"],
  "c" : [0, 1, 2, 3] zip ["a", "b"],
  "d" : [0, 1, 2] zip ["a", "b", "c", "d"]
}
```

#### Output

```JSON
{
  "a": [
    [0,"a"],
    [1,"b"],
    [2,"c"],
    [3,"d"]
    ],
  "b": [
    [0,"a"]
  ],
  "c": [
    [0,"a"],
    [1,"b"]
  ],
  "d": [
    [0,"a"],
    [1,"b"],
    [2,"c"]
  ]
}
```

### Example

This example zips more than two arrays. Notice that items from `["aA", "bB"]` in `list4` are not in
the output because the other input arrays only have two indices.

#### Source

```DataWeave
%dw 2.0
output application/json
var myvar = {
   "list1": ["a", "b"],
   "list2": [1, 2, 3],
   "list3": ["aa", "bb"],
   "list4": [["A", "B", "C"], [11, 12], ["aA", "bB"]]
}
---
((myvar.list1 zip myvar.list2) zip myvar.list3) zip myvar.list4
```

#### Output

```JSON
[
  [
    [ [ "a", 1 ], "aa" ], [ "A", "B", "C" ]
  ],
  [
    [ [ "b", 2 ], "bb" ], [ 11, 12 ]
  ]
]
```

<!-- document id=fb4952a31bb05460399f15fee5fb2867ebbafed0159d8d38460cf59c6fe76a11 url=/mulesoft/current/en-us/dataweave/2.3/dw-core-functions-zip.md -->

---
product: DataWeave
version: 2.3
---

# zip

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## zip(Array<T>, Array<R>): Array<Array<T | R>>

Merges elements from two arrays into an array of arrays.

The first sub-array in the output array contains the first indices of the input sub-arrays. The
second index contains the second indices of the inputs, the third contains the third indices, and so
on for every case where there are the same number of indices in the arrays.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>left</code></p></td><td><p>The array on the left-hand side of the function.</p></td></tr><tr><td><p><code>right</code></p></td><td><p>The array on the right-hand side of the function.</p></td></tr></tbody></table>

### Example

This example zips the arrays located to the left and right of `zip`. Notice that it returns an array
of arrays where the first index, (`[0,1]`) contains the first indices of the specified arrays. The
second index of the output array (`[1,"b"]`) contains the second indices of the specified arrays.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[0,1] zip ["a","b"]
```

#### Output

```JSON
[ [0,"a"], [1,"b"] ]
```

### Example

This example zips elements of the left-hand and right-hand arrays. Notice that only elements with
counterparts at the same index are returned in the array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  "a" : [0, 1, 2, 3] zip ["a", "b", "c", "d"],
  "b" : [0, 1, 2, 3] zip ["a"],
  "c" : [0, 1, 2, 3] zip ["a", "b"],
  "d" : [0, 1, 2] zip ["a", "b", "c", "d"]
}
```

#### Output

```JSON
{
  "a": [
    [0,"a"],
    [1,"b"],
    [2,"c"],
    [3,"d"]
    ],
  "b": [
    [0,"a"]
  ],
  "c": [
    [0,"a"],
    [1,"b"]
  ],
  "d": [
    [0,"a"],
    [1,"b"],
    [2,"c"]
  ]
}
```

### Example

This example zips more than two arrays. Notice that items from `["aA", "bB"]` in `list4` are not in
the output because the other input arrays only have two indices.

#### Source

```DataWeave
%dw 2.0
output application/json
var myvar = {
   "list1": ["a", "b"],
   "list2": [1, 2, 3],
   "list3": ["aa", "bb"],
   "list4": [["A", "B", "C"], [11, 12], ["aA", "bB"]]
}
---
((myvar.list1 zip myvar.list2) zip myvar.list3) zip myvar.list4
```

#### Output

```JSON
[
  [
    [ [ "a", 1 ], "aa" ], [ "A", "B", "C" ]
  ],
  [
    [ [ "b", 2 ], "bb" ], [ 11, 12 ]
  ]
]
```

<!-- document id=ab5b366379513470f7ba9a53cbd3af29fd0b7720f98333dd44373a88b0f577ac url=/mulesoft/current/en-us/dataweave/2.4/dw-core-functions-zip.md -->

---
product: DataWeave
version: 2.4
---

# zip

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## zip<T, R>(left: Array<T>, right: Array<R>): Array<Array<T | R>>

Merges elements from two arrays into an array of arrays.

The first sub-array in the output array contains the first indices of the input sub-arrays. The
second index contains the second indices of the inputs, the third contains the third indices, and so
on for every case where there are the same number of indices in the arrays.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>left</code></p></td><td><p>The array on the left-hand side of the function.</p></td></tr><tr><td><p><code>right</code></p></td><td><p>The array on the right-hand side of the function.</p></td></tr></tbody></table>

### Example

This example zips the arrays located to the left and right of `zip`. Notice that it returns an array
of arrays where the first index, (`[0,1]`) contains the first indices of the specified arrays. The
second index of the output array (`[1,"b"]`) contains the second indices of the specified arrays.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[0,1] zip ["a","b"]
```

#### Output

```JSON
[ [0,"a"], [1,"b"] ]
```

### Example

This example zips elements of the left-hand and right-hand arrays. Notice that only elements with
counterparts at the same index are returned in the array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  "a" : [0, 1, 2, 3] zip ["a", "b", "c", "d"],
  "b" : [0, 1, 2, 3] zip ["a"],
  "c" : [0, 1, 2, 3] zip ["a", "b"],
  "d" : [0, 1, 2] zip ["a", "b", "c", "d"]
}
```

#### Output

```JSON
{
  "a": [
    [0,"a"],
    [1,"b"],
    [2,"c"],
    [3,"d"]
    ],
  "b": [
    [0,"a"]
  ],
  "c": [
    [0,"a"],
    [1,"b"]
  ],
  "d": [
    [0,"a"],
    [1,"b"],
    [2,"c"]
  ]
}
```

### Example

This example zips more than two arrays. Notice that items from `["aA", "bB"]` in `list4` are not in
the output because the other input arrays only have two indices.

#### Source

```DataWeave
%dw 2.0
output application/json
var myvar = {
   "list1": ["a", "b"],
   "list2": [1, 2, 3],
   "list3": ["aa", "bb"],
   "list4": [["A", "B", "C"], [11, 12], ["aA", "bB"]]
}
---
((myvar.list1 zip myvar.list2) zip myvar.list3) zip myvar.list4
```

#### Output

```JSON
[
  [
    [ [ "a", 1 ], "aa" ], [ "A", "B", "C" ]
  ],
  [
    [ [ "b", 2 ], "bb" ], [ 11, 12 ]
  ]
]
```

<!-- document id=d8c06bae432fec9b39a958370576f957be0dd49e666221b465dce638d04d06a4 url=/mulesoft/current/en-us/dataweave/2.6/dw-core-functions-zip.md -->

---
product: DataWeave
version: 2.6
---

# zip

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## zip<T, R>(left: Array<T>, right: Array<R>): Array<Array<T | R>>

Merges elements from two arrays into an array of arrays.

The first sub-array in the output array contains the first indices of the input sub-arrays. The
second index contains the second indices of the inputs, the third contains the third indices, and so
on for every case where there are the same number of indices in the arrays.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>left</code></p></td><td><p>The array on the left-hand side of the function.</p></td></tr><tr><td><p><code>right</code></p></td><td><p>The array on the right-hand side of the function.</p></td></tr></tbody></table>

### Example

This example zips the arrays located to the left and right of `zip`. Notice that it returns an array
of arrays where the first index, (`[0,1]`) contains the first indices of the specified arrays. The
second index of the output array (`[1,"b"]`) contains the second indices of the specified arrays.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[0,1] zip ["a","b"]
```

#### Output

```JSON
[ [0,"a"], [1,"b"] ]
```

### Example

This example zips elements of the left-hand and right-hand arrays. Notice that only elements with
counterparts at the same index are returned in the array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  "a" : [0, 1, 2, 3] zip ["a", "b", "c", "d"],
  "b" : [0, 1, 2, 3] zip ["a"],
  "c" : [0, 1, 2, 3] zip ["a", "b"],
  "d" : [0, 1, 2] zip ["a", "b", "c", "d"]
}
```

#### Output

```JSON
{
  "a": [
    [0,"a"],
    [1,"b"],
    [2,"c"],
    [3,"d"]
    ],
  "b": [
    [0,"a"]
  ],
  "c": [
    [0,"a"],
    [1,"b"]
  ],
  "d": [
    [0,"a"],
    [1,"b"],
    [2,"c"]
  ]
}
```

### Example

This example zips more than two arrays. Notice that items from `["aA", "bB"]` in `list4` are not in
the output because the other input arrays only have two indices.

#### Source

```DataWeave
%dw 2.0
output application/json
var myvar = {
   "list1": ["a", "b"],
   "list2": [1, 2, 3],
   "list3": ["aa", "bb"],
   "list4": [["A", "B", "C"], [11, 12], ["aA", "bB"]]
}
---
((myvar.list1 zip myvar.list2) zip myvar.list3) zip myvar.list4
```

#### Output

```JSON
[
  [
    [ [ "a", 1 ], "aa" ], [ "A", "B", "C" ]
  ],
  [
    [ [ "b", 2 ], "bb" ], [ 11, 12 ]
  ]
]
```

<!-- document id=205c9829cfdcbe4989dfd3e4ed780eec3f0204875cf3090bf619f7c45af84e53 url=/mulesoft/current/en-us/dataweave/2.9/dw-core-functions-zip.md -->

---
product: DataWeave
version: 2.9
---

# zip

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## zip<T, R>(left: Array<T>, right: Array<R>): Array<Array<T | R>>

Merges elements from two arrays into an array of arrays.

The first sub-array in the output array contains the first indices of the input sub-arrays. The
second index contains the second indices of the inputs, the third contains the third indices, and so
on for every case where there are the same number of indices in the arrays.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>left</code></p></td><td><p>The array on the left-hand side of the function.</p></td></tr><tr><td><p><code>right</code></p></td><td><p>The array on the right-hand side of the function.</p></td></tr></tbody></table>

### Example

This example zips the arrays located to the left and right of `zip`. Notice that it returns an array
of arrays where the first index, (`[0,1]`) contains the first indices of the specified arrays. The
second index of the output array (`[1,"b"]`) contains the second indices of the specified arrays.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[0,1] zip ["a","b"]
```

#### Output

```JSON
[ [0,"a"], [1,"b"] ]
```

### Example

This example zips elements of the left-hand and right-hand arrays. Notice that only elements with
counterparts at the same index are returned in the array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  "a" : [0, 1, 2, 3] zip ["a", "b", "c", "d"],
  "b" : [0, 1, 2, 3] zip ["a"],
  "c" : [0, 1, 2, 3] zip ["a", "b"],
  "d" : [0, 1, 2] zip ["a", "b", "c", "d"]
}
```

#### Output

```JSON
{
  "a": [
    [0,"a"],
    [1,"b"],
    [2,"c"],
    [3,"d"]
    ],
  "b": [
    [0,"a"]
  ],
  "c": [
    [0,"a"],
    [1,"b"]
  ],
  "d": [
    [0,"a"],
    [1,"b"],
    [2,"c"]
  ]
}
```

### Example

This example zips more than two arrays. Notice that items from `["aA", "bB"]` in `list4` are not in
the output because the other input arrays only have two indices.

#### Source

```DataWeave
%dw 2.0
output application/json
var myvar = {
   "list1": ["a", "b"],
   "list2": [1, 2, 3],
   "list3": ["aa", "bb"],
   "list4": [["A", "B", "C"], [11, 12], ["aA", "bB"]]
}
---
((myvar.list1 zip myvar.list2) zip myvar.list3) zip myvar.list4
```

#### Output

```JSON
[
  [
    [ [ "a", 1 ], "aa" ], [ "A", "B", "C" ]
  ],
  [
    [ [ "b", 2 ], "bb" ], [ 11, 12 ]
  ]
]
```

<!-- document id=2ef6b6c17a98797ab81226268f31eeaf2ddd0b4c4cc324f347a6b7eececce717 url=/mulesoft/current/en-us/dataweave/latest/dw-core-functions-zip.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
---

# zip

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## zip<T, R>(left: Array<T>, right: Array<R>): Array<Array<T | R>>

Merges elements from two arrays into an array of arrays.

The first sub-array in the output array contains the first indices of the input sub-arrays. The
second index contains the second indices of the inputs, the third contains the third indices, and so
on for every case where there are the same number of indices in the arrays.

### Parameters

<table><colgroup><col> <col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><p><code>left</code></p></td><td><p>The array on the left-hand side of the function.</p></td></tr><tr><td><p><code>right</code></p></td><td><p>The array on the right-hand side of the function.</p></td></tr></tbody></table>

### Example

This example zips the arrays located to the left and right of `zip`. Notice that it returns an array
of arrays where the first index, (`[0,1]`) contains the first indices of the specified arrays. The
second index of the output array (`[1,"b"]`) contains the second indices of the specified arrays.

#### Source

```DataWeave
%dw 2.0
output application/json
---
[0,1] zip ["a","b"]
```

#### Output

```JSON
[ [0,"a"], [1,"b"] ]
```

### Example

This example zips elements of the left-hand and right-hand arrays. Notice that only elements with
counterparts at the same index are returned in the array.

#### Source

```DataWeave
%dw 2.0
output application/json
---
{
  "a" : [0, 1, 2, 3] zip ["a", "b", "c", "d"],
  "b" : [0, 1, 2, 3] zip ["a"],
  "c" : [0, 1, 2, 3] zip ["a", "b"],
  "d" : [0, 1, 2] zip ["a", "b", "c", "d"]
}
```

#### Output

```JSON
{
  "a": [
    [0,"a"],
    [1,"b"],
    [2,"c"],
    [3,"d"]
    ],
  "b": [
    [0,"a"]
  ],
  "c": [
    [0,"a"],
    [1,"b"]
  ],
  "d": [
    [0,"a"],
    [1,"b"],
    [2,"c"]
  ]
}
```

### Example

This example zips more than two arrays. Notice that items from `["aA", "bB"]` in `list4` are not in
the output because the other input arrays only have two indices.

#### Source

```DataWeave
%dw 2.0
output application/json
var myvar = {
   "list1": ["a", "b"],
   "list2": [1, 2, 3],
   "list3": ["aa", "bb"],
   "list4": [["A", "B", "C"], [11, 12], ["aA", "bB"]]
}
---
((myvar.list1 zip myvar.list2) zip myvar.list3) zip myvar.list4
```

#### Output

```JSON
[
  [
    [ [ "a", 1 ], "aa" ], [ "A", "B", "C" ]
  ],
  [
    [ [ "b", 2 ], "bb" ], [ 11, 12 ]
  ]
]
```

<!-- document id=934b68b3d5f3880148551beafb3cd55a2a9b251fa2b46d3885229f5318f29a54 url=/mulesoft/current/en-us/dataweave/2.11/dataweave-cookbook-zip-arrays-together.md -->

---
product: DataWeave
version: 2.11
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, as
---

# Zip Arrays Together

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example restructures bills of materials for Ikea-style furniture. The input contains
the measurements and amounts of screws in two separate arrays that run in parallel, the
transformation reorders them so that the "screws" array is made up of tuples, each with a
measurement and its corresponding amount. The same is applied to wooden boards: the input contains
two arrays with the x and the y measurements of each; the transformation rearranges them into a
series of tuples, one for each board.

It uses these DataWeave functions:

- `map` to go through the elements in the main array.

- `zip` to rearrange pairs of long arrays, so that they’re grouped by index into multiple
  two-element arrays.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
payload map (item, index) ->
{
    name: item.name,
    id: item.itemID,
    screws: zip(item.screws.size, item.screws.quantity),
    measurements: zip(item.measurements.x,item.measurements.y )
}
```

Input JSON Payload:

```json
[
  {
    "name": "wooden-chair",
    "itemID": "23665",
    "screws": {
      "size": [4, 6, 10],
      "quantity": [15, 8, 28]
    },
    "measurements": { "x": [25, 46, 46, 16, 150, 5, 100, 100, 8], "y": [15, 4, 4, 80, 3, 4, 4, 15] }
  },
  {
    "name": "coffee-table",
    "itemID": "14398",
    "screws": {
      "size": [3, 8, 10],
      "quantity": [8, 12, 20]
    },
    "measurements": {
      "x": [55, 48, 48, 48, 48, 30, 30, 30, 30],
      "y": [55, 40, 40, 40, 50, 4, 4, 4, 4]
    }
  }
]
```

Output JSON:

```json
[
  {
    "name": "wooden-chair",
    "id": "23665",
    "screws": [
      [4, 15],
      [6, 8],
      [10, 28]
    ],
    "measurements": [
      [25, 15],
      [46, 4],
      [46, 4],
      [16, 80],
      [150, 3],
      [5, 4],
      [100, 4],
      [100, 15]
    ]
  },
  {
    "name": "coffee-table",
    "id": "14398",
    "screws": [
      [3, 8],
      [8, 12],
      [10, 20]
    ],
    "measurements": [
      [55, 55],
      [48, 40],
      [48, 40],
      [48, 40],
      [48, 50],
      [30, 4],
      [30, 4],
      [30, 4],
      [30, 4]
    ]
  }
]
```

## Related Examples

- [Regroup Fields](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-regroup-fields)

- [Transform XML to JSON](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-perform-basic-transformation)

- [Define a Custom Addition Function](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-define-a-custom-addition-function)

- [Pick Top Elements](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook-pick-top-elements)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.11/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.11/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.11/dataweave-cookbook)

<!-- document id=0083926bd2440fd85cc9a40e889b82ca24768fddf32a3ec1c638a2e496b25edf url=/mulesoft/current/en-us/dataweave/2.12/dataweave-cookbook-zip-arrays-together.md -->

---
product: DataWeave
version: 2.12
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, as
---

# Zip Arrays Together

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example restructures bills of materials for Ikea-style furniture. The input contains
the measurements and amounts of screws in two separate arrays that run in parallel, the
transformation reorders them so that the "screws" array is made up of tuples, each with a
measurement and its corresponding amount. The same is applied to wooden boards: the input contains
two arrays with the x and the y measurements of each; the transformation rearranges them into a
series of tuples, one for each board.

It uses these DataWeave functions:

- `map` to go through the elements in the main array.

- `zip` to rearrange pairs of long arrays, so that they’re grouped by index into multiple
  two-element arrays.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
payload map (item, index) ->
{
    name: item.name,
    id: item.itemID,
    screws: zip(item.screws.size, item.screws.quantity),
    measurements: zip(item.measurements.x,item.measurements.y )
}
```

Input JSON Payload:

```json
[
  {
    "name": "wooden-chair",
    "itemID": "23665",
    "screws": {
      "size": [4, 6, 10],
      "quantity": [15, 8, 28]
    },
    "measurements": { "x": [25, 46, 46, 16, 150, 5, 100, 100, 8], "y": [15, 4, 4, 80, 3, 4, 4, 15] }
  },
  {
    "name": "coffee-table",
    "itemID": "14398",
    "screws": {
      "size": [3, 8, 10],
      "quantity": [8, 12, 20]
    },
    "measurements": {
      "x": [55, 48, 48, 48, 48, 30, 30, 30, 30],
      "y": [55, 40, 40, 40, 50, 4, 4, 4, 4]
    }
  }
]
```

Output JSON:

```json
[
  {
    "name": "wooden-chair",
    "id": "23665",
    "screws": [
      [4, 15],
      [6, 8],
      [10, 28]
    ],
    "measurements": [
      [25, 15],
      [46, 4],
      [46, 4],
      [16, 80],
      [150, 3],
      [5, 4],
      [100, 4],
      [100, 15]
    ]
  },
  {
    "name": "coffee-table",
    "id": "14398",
    "screws": [
      [3, 8],
      [8, 12],
      [10, 20]
    ],
    "measurements": [
      [55, 55],
      [48, 40],
      [48, 40],
      [48, 40],
      [48, 50],
      [30, 4],
      [30, 4],
      [30, 4],
      [30, 4]
    ]
  }
]
```

## Related Examples

- [Regroup Fields](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-regroup-fields)

- [Transform XML to JSON](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-perform-basic-transformation)

- [Define a Custom Addition Function](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-define-a-custom-addition-function)

- [Pick Top Elements](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook-pick-top-elements)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.12/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.12/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.12/dataweave-cookbook)

<!-- document id=cd0f3633442a137aa36a118e3dd29093953d8ac4b4b467673b733b26053b878d url=/mulesoft/current/en-us/dataweave/2.3/dataweave-cookbook-zip-arrays-together.md -->

---
product: DataWeave
version: 2.3
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, as
---

# Zip Arrays Together

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example restructures bills of materials for Ikea-style furniture. The input contains
the measurements and amounts of screws in two separate arrays that run in parallel, the
transformation reorders them so that the "screws" array is made up of tuples, each with a
measurement and its corresponding amount. The same is applied to wooden boards: the input contains
two arrays with the x and the y measurements of each; the transformation rearranges them into a
series of tuples, one for each board.

It uses these DataWeave functions:

- `map` to go through the elements in the main array.

- `zip` to rearrange pairs of long arrays, so that they’re grouped by index into multiple
  two-element arrays.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
payload map (item, index) ->
{
    name: item.name,
    id: item.itemID,
    screws: zip(item.screws.size, item.screws.quantity),
    measurements: zip(item.measurements.x,item.measurements.y )
}
```

Input JSON Payload:

```json
[
  {
    "name": "wooden-chair",
    "itemID": "23665",
    "screws": {
      "size": [4, 6, 10],
      "quantity": [15, 8, 28]
    },
    "measurements": { "x": [25, 46, 46, 16, 150, 5, 100, 100, 8], "y": [15, 4, 4, 80, 3, 4, 4, 15] }
  },
  {
    "name": "cofee-table",
    "itemID": "14398",
    "screws": {
      "size": [3, 8, 10],
      "quantity": [8, 12, 20]
    },
    "measurements": {
      "x": [55, 48, 48, 48, 48, 30, 30, 30, 30],
      "y": [55, 40, 40, 40, 50, 4, 4, 4, 4]
    }
  }
]
```

Output JSON:

```json
[
  {
    "name": "wooden-chair",
    "id": "23665",
    "screws": [
      [4, 15],
      [6, 8],
      [10, 28]
    ],
    "measurements": [
      [25, 15],
      [46, 4],
      [46, 4],
      [16, 80],
      [150, 3],
      [5, 4],
      [100, 4],
      [100, 15]
    ]
  },
  {
    "name": "cofee-table",
    "id": "14398",
    "screws": [
      [3, 8],
      [8, 12],
      [10, 20]
    ],
    "measurements": [
      [55, 55],
      [48, 40],
      [48, 40],
      [48, 40],
      [48, 50],
      [30, 4],
      [30, 4],
      [30, 4],
      [30, 4]
    ]
  }
]
```

## Related Examples

- [Regroup Fields](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-regroup-fields)

- [Transform XML to JSON](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-perform-basic-transformation)

- [Define a Custom Addition Function](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-define-a-custom-addition-function)

- [Pick Top Elements](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook-pick-top-elements)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.3/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.3/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.3/dataweave-cookbook)

<!-- document id=b9e9beb67ea2e7851297157e6cda5a3fa40df60450a7340cc8fd0140eb2880bd url=/mulesoft/current/en-us/dataweave/2.4/dataweave-cookbook-zip-arrays-together.md -->

---
product: DataWeave
version: 2.4
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, as
---

# Zip Arrays Together

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example restructures bills of materials for Ikea-style furniture. The input contains
the measurements and amounts of screws in two separate arrays that run in parallel, the
transformation reorders them so that the "screws" array is made up of tuples, each with a
measurement and its corresponding amount. The same is applied to wooden boards: the input contains
two arrays with the x and the y measurements of each; the transformation rearranges them into a
series of tuples, one for each board.

It uses these DataWeave functions:

- `map` to go through the elements in the main array.

- `zip` to rearrange pairs of long arrays, so that they’re grouped by index into multiple
  two-element arrays.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
payload map (item, index) ->
{
    name: item.name,
    id: item.itemID,
    screws: zip(item.screws.size, item.screws.quantity),
    measurements: zip(item.measurements.x,item.measurements.y )
}
```

Input JSON Payload:

```json
[
  {
    "name": "wooden-chair",
    "itemID": "23665",
    "screws": {
      "size": [4, 6, 10],
      "quantity": [15, 8, 28]
    },
    "measurements": { "x": [25, 46, 46, 16, 150, 5, 100, 100, 8], "y": [15, 4, 4, 80, 3, 4, 4, 15] }
  },
  {
    "name": "coffee-table",
    "itemID": "14398",
    "screws": {
      "size": [3, 8, 10],
      "quantity": [8, 12, 20]
    },
    "measurements": {
      "x": [55, 48, 48, 48, 48, 30, 30, 30, 30],
      "y": [55, 40, 40, 40, 50, 4, 4, 4, 4]
    }
  }
]
```

Output JSON:

```json
[
  {
    "name": "wooden-chair",
    "id": "23665",
    "screws": [
      [4, 15],
      [6, 8],
      [10, 28]
    ],
    "measurements": [
      [25, 15],
      [46, 4],
      [46, 4],
      [16, 80],
      [150, 3],
      [5, 4],
      [100, 4],
      [100, 15]
    ]
  },
  {
    "name": "coffee-table",
    "id": "14398",
    "screws": [
      [3, 8],
      [8, 12],
      [10, 20]
    ],
    "measurements": [
      [55, 55],
      [48, 40],
      [48, 40],
      [48, 40],
      [48, 50],
      [30, 4],
      [30, 4],
      [30, 4],
      [30, 4]
    ]
  }
]
```

## Related Examples

- [Regroup Fields](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-regroup-fields)

- [Transform XML to JSON](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-perform-basic-transformation)

- [Define a Custom Addition Function](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-define-a-custom-addition-function)

- [Pick Top Elements](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook-pick-top-elements)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.4/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.4/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.4/dataweave-cookbook)

<!-- document id=c6fecd4cc5ac5d7ef88e75028b84f820e0e3c47ad79b4431e9fc8f61d8863ce2 url=/mulesoft/current/en-us/dataweave/2.6/dataweave-cookbook-zip-arrays-together.md -->

---
product: DataWeave
version: 2.6
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, as
---

# Zip Arrays Together

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example restructures bills of materials for Ikea-style furniture. The input contains
the measurements and amounts of screws in two separate arrays that run in parallel, the
transformation reorders them so that the "screws" array is made up of tuples, each with a
measurement and its corresponding amount. The same is applied to wooden boards: the input contains
two arrays with the x and the y measurements of each; the transformation rearranges them into a
series of tuples, one for each board.

It uses these DataWeave functions:

- `map` to go through the elements in the main array.

- `zip` to rearrange pairs of long arrays, so that they’re grouped by index into multiple
  two-element arrays.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
payload map (item, index) ->
{
    name: item.name,
    id: item.itemID,
    screws: zip(item.screws.size, item.screws.quantity),
    measurements: zip(item.measurements.x,item.measurements.y )
}
```

Input JSON Payload:

```json
[
  {
    "name": "wooden-chair",
    "itemID": "23665",
    "screws": {
      "size": [4, 6, 10],
      "quantity": [15, 8, 28]
    },
    "measurements": { "x": [25, 46, 46, 16, 150, 5, 100, 100, 8], "y": [15, 4, 4, 80, 3, 4, 4, 15] }
  },
  {
    "name": "coffee-table",
    "itemID": "14398",
    "screws": {
      "size": [3, 8, 10],
      "quantity": [8, 12, 20]
    },
    "measurements": {
      "x": [55, 48, 48, 48, 48, 30, 30, 30, 30],
      "y": [55, 40, 40, 40, 50, 4, 4, 4, 4]
    }
  }
]
```

Output JSON:

```json
[
  {
    "name": "wooden-chair",
    "id": "23665",
    "screws": [
      [4, 15],
      [6, 8],
      [10, 28]
    ],
    "measurements": [
      [25, 15],
      [46, 4],
      [46, 4],
      [16, 80],
      [150, 3],
      [5, 4],
      [100, 4],
      [100, 15]
    ]
  },
  {
    "name": "coffee-table",
    "id": "14398",
    "screws": [
      [3, 8],
      [8, 12],
      [10, 20]
    ],
    "measurements": [
      [55, 55],
      [48, 40],
      [48, 40],
      [48, 40],
      [48, 50],
      [30, 4],
      [30, 4],
      [30, 4],
      [30, 4]
    ]
  }
]
```

## Related Examples

- [Regroup Fields](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-regroup-fields)

- [Transform XML to JSON](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-perform-basic-transformation)

- [Define a Custom Addition Function](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-define-a-custom-addition-function)

- [Pick Top Elements](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook-pick-top-elements)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.6/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.6/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.6/dataweave-cookbook)

<!-- document id=c6dd195a01b955e7eaa7e546cd6444a0896a481c454a09268cc87fc6da51c428 url=/mulesoft/current/en-us/dataweave/2.9/dataweave-cookbook-zip-arrays-together.md -->

---
product: DataWeave
version: 2.9
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, as
---

# Zip Arrays Together

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example restructures bills of materials for Ikea-style furniture. The input contains
the measurements and amounts of screws in two separate arrays that run in parallel, the
transformation reorders them so that the "screws" array is made up of tuples, each with a
measurement and its corresponding amount. The same is applied to wooden boards: the input contains
two arrays with the x and the y measurements of each; the transformation rearranges them into a
series of tuples, one for each board.

It uses these DataWeave functions:

- `map` to go through the elements in the main array.

- `zip` to rearrange pairs of long arrays, so that they’re grouped by index into multiple
  two-element arrays.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
payload map (item, index) ->
{
    name: item.name,
    id: item.itemID,
    screws: zip(item.screws.size, item.screws.quantity),
    measurements: zip(item.measurements.x,item.measurements.y )
}
```

Input JSON Payload:

```json
[
  {
    "name": "wooden-chair",
    "itemID": "23665",
    "screws": {
      "size": [4, 6, 10],
      "quantity": [15, 8, 28]
    },
    "measurements": { "x": [25, 46, 46, 16, 150, 5, 100, 100, 8], "y": [15, 4, 4, 80, 3, 4, 4, 15] }
  },
  {
    "name": "coffee-table",
    "itemID": "14398",
    "screws": {
      "size": [3, 8, 10],
      "quantity": [8, 12, 20]
    },
    "measurements": {
      "x": [55, 48, 48, 48, 48, 30, 30, 30, 30],
      "y": [55, 40, 40, 40, 50, 4, 4, 4, 4]
    }
  }
]
```

Output JSON:

```json
[
  {
    "name": "wooden-chair",
    "id": "23665",
    "screws": [
      [4, 15],
      [6, 8],
      [10, 28]
    ],
    "measurements": [
      [25, 15],
      [46, 4],
      [46, 4],
      [16, 80],
      [150, 3],
      [5, 4],
      [100, 4],
      [100, 15]
    ]
  },
  {
    "name": "coffee-table",
    "id": "14398",
    "screws": [
      [3, 8],
      [8, 12],
      [10, 20]
    ],
    "measurements": [
      [55, 55],
      [48, 40],
      [48, 40],
      [48, 40],
      [48, 50],
      [30, 4],
      [30, 4],
      [30, 4],
      [30, 4]
    ]
  }
]
```

## Related Examples

- [Regroup Fields](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-regroup-fields)

- [Transform XML to JSON](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-perform-basic-transformation)

- [Define a Custom Addition Function](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-define-a-custom-addition-function)

- [Pick Top Elements](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook-pick-top-elements)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/2.9/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/2.9/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/2.9/dataweave-cookbook)

<!-- document id=55d250b0a4357c44d52ed78a6cce559b6d912eb5ac09a70450140620c9f47f6b url=/mulesoft/current/en-us/dataweave/latest/dataweave-cookbook-zip-arrays-together.md -->

---
product: DataWeave
version: 2.13
is-latest-version: true
keywords: studio, anypoint, transform, transformer, format, aggregate, rename, split, filter convert, json, metadata, dataweave, data weave, datamapper, dwl, dfl, dw, output structure, input structure, map, mapping, as
---

# Zip Arrays Together

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This DataWeave example restructures bills of materials for Ikea-style furniture. The input contains
the measurements and amounts of screws in two separate arrays that run in parallel, the
transformation reorders them so that the "screws" array is made up of tuples, each with a
measurement and its corresponding amount. The same is applied to wooden boards: the input contains
two arrays with the x and the y measurements of each; the transformation rearranges them into a
series of tuples, one for each board.

It uses these DataWeave functions:

- `map` to go through the elements in the main array.

- `zip` to rearrange pairs of long arrays, so that they’re grouped by index into multiple
  two-element arrays.

DataWeave Script:

```dataweave
%dw 2.0
output application/json
---
payload map (item, index) ->
{
    name: item.name,
    id: item.itemID,
    screws: zip(item.screws.size, item.screws.quantity),
    measurements: zip(item.measurements.x,item.measurements.y )
}
```

Input JSON Payload:

```json
[
  {
    "name": "wooden-chair",
    "itemID": "23665",
    "screws": {
      "size": [4, 6, 10],
      "quantity": [15, 8, 28]
    },
    "measurements": { "x": [25, 46, 46, 16, 150, 5, 100, 100, 8], "y": [15, 4, 4, 80, 3, 4, 4, 15] }
  },
  {
    "name": "coffee-table",
    "itemID": "14398",
    "screws": {
      "size": [3, 8, 10],
      "quantity": [8, 12, 20]
    },
    "measurements": {
      "x": [55, 48, 48, 48, 48, 30, 30, 30, 30],
      "y": [55, 40, 40, 40, 50, 4, 4, 4, 4]
    }
  }
]
```

Output JSON:

```json
[
  {
    "name": "wooden-chair",
    "id": "23665",
    "screws": [
      [4, 15],
      [6, 8],
      [10, 28]
    ],
    "measurements": [
      [25, 15],
      [46, 4],
      [46, 4],
      [16, 80],
      [150, 3],
      [5, 4],
      [100, 4],
      [100, 15]
    ]
  },
  {
    "name": "coffee-table",
    "id": "14398",
    "screws": [
      [3, 8],
      [8, 12],
      [10, 20]
    ],
    "measurements": [
      [55, 55],
      [48, 40],
      [48, 40],
      [48, 40],
      [48, 50],
      [30, 4],
      [30, 4],
      [30, 4],
      [30, 4]
    ]
  }
]
```

## Related Examples

- [Regroup Fields](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-regroup-fields)

- [Transform XML to JSON](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-perform-basic-transformation)

- [Define a Custom Addition Function](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-define-a-custom-addition-function)

- [Pick Top Elements](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook-pick-top-elements)

## See Also

- [DataWeave Types](https://docs.mulesoft.com/dataweave/latest/dataweave-types)

- [DataWeave Selectors](https://docs.mulesoft.com/dataweave/latest/dataweave-selectors)

- [DataWeave Cookbook](https://docs.mulesoft.com/dataweave/latest/dataweave-cookbook)